Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
Madan Jampani | f4c8850 | 2016-01-21 12:35:36 -0800 | [diff] [blame] | 17 | package org.onosproject.store.primitives.impl; |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 18 | |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 19 | import java.util.List; |
| 20 | import java.util.Map; |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 21 | import java.util.Set; |
Madan Jampani | 74da78b | 2016-02-09 21:18:36 -0800 | [diff] [blame] | 22 | import java.util.concurrent.CompletableFuture; |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 23 | |
| 24 | import org.onlab.util.HexString; |
Madan Jampani | 74da78b | 2016-02-09 21:18:36 -0800 | [diff] [blame] | 25 | import org.onosproject.store.primitives.MapUpdate; |
| 26 | import org.onosproject.store.service.AsyncConsistentMap; |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 27 | import org.onosproject.store.service.ConsistentMap; |
Madan Jampani | 74da78b | 2016-02-09 21:18:36 -0800 | [diff] [blame] | 28 | import org.onosproject.store.service.MapTransaction; |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 29 | import org.onosproject.store.service.Serializer; |
| 30 | import org.onosproject.store.service.TransactionContext; |
| 31 | import org.onosproject.store.service.TransactionalMap; |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 32 | import org.onosproject.store.service.Versioned; |
| 33 | |
| 34 | import static com.google.common.base.Preconditions.*; |
| 35 | |
HIGUCHI Yuta | dc4394c | 2016-01-29 15:35:10 -0800 | [diff] [blame] | 36 | import com.google.common.base.MoreObjects; |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 37 | import com.google.common.base.Objects; |
| 38 | import com.google.common.cache.CacheBuilder; |
| 39 | import com.google.common.cache.CacheLoader; |
| 40 | import com.google.common.cache.LoadingCache; |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 41 | import com.google.common.collect.Lists; |
| 42 | import com.google.common.collect.Maps; |
| 43 | import com.google.common.collect.Sets; |
| 44 | |
| 45 | /** |
| 46 | * Default Transactional Map implementation that provides a repeatable reads |
| 47 | * transaction isolation level. |
| 48 | * |
| 49 | * @param <K> key type |
| 50 | * @param <V> value type. |
| 51 | */ |
Madan Jampani | 74da78b | 2016-02-09 21:18:36 -0800 | [diff] [blame] | 52 | public class DefaultTransactionalMap<K, V> implements TransactionalMap<K, V>, TransactionParticipant { |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 53 | |
| 54 | private final TransactionContext txContext; |
| 55 | private static final String TX_CLOSED_ERROR = "Transaction is closed"; |
Madan Jampani | 74da78b | 2016-02-09 21:18:36 -0800 | [diff] [blame] | 56 | private final AsyncConsistentMap<K, V> backingMap; |
| 57 | private final ConsistentMap<K, V> backingConsitentMap; |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 58 | private final String name; |
| 59 | private final Serializer serializer; |
| 60 | private final Map<K, Versioned<V>> readCache = Maps.newConcurrentMap(); |
| 61 | private final Map<K, V> writeCache = Maps.newConcurrentMap(); |
| 62 | private final Set<K> deleteSet = Sets.newConcurrentHashSet(); |
| 63 | |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 64 | private static final String ERROR_NULL_VALUE = "Null values are not allowed"; |
| 65 | private static final String ERROR_NULL_KEY = "Null key is not allowed"; |
| 66 | |
| 67 | private final LoadingCache<K, String> keyCache = CacheBuilder.newBuilder() |
| 68 | .softValues() |
| 69 | .build(new CacheLoader<K, String>() { |
| 70 | |
| 71 | @Override |
| 72 | public String load(K key) { |
| 73 | return HexString.toHexString(serializer.encode(key)); |
| 74 | } |
| 75 | }); |
| 76 | |
| 77 | protected K dK(String key) { |
| 78 | return serializer.decode(HexString.fromHexString(key)); |
| 79 | } |
| 80 | |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 81 | public DefaultTransactionalMap( |
| 82 | String name, |
Madan Jampani | 74da78b | 2016-02-09 21:18:36 -0800 | [diff] [blame] | 83 | AsyncConsistentMap<K, V> backingMap, |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 84 | TransactionContext txContext, |
| 85 | Serializer serializer) { |
| 86 | this.name = name; |
| 87 | this.backingMap = backingMap; |
Madan Jampani | 74da78b | 2016-02-09 21:18:36 -0800 | [diff] [blame] | 88 | this.backingConsitentMap = backingMap.asConsistentMap(); |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 89 | this.txContext = txContext; |
| 90 | this.serializer = serializer; |
| 91 | } |
| 92 | |
| 93 | @Override |
| 94 | public V get(K key) { |
| 95 | checkState(txContext.isOpen(), TX_CLOSED_ERROR); |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 96 | checkNotNull(key, ERROR_NULL_KEY); |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 97 | if (deleteSet.contains(key)) { |
| 98 | return null; |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 99 | } |
| 100 | V latest = writeCache.get(key); |
| 101 | if (latest != null) { |
| 102 | return latest; |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 103 | } else { |
Madan Jampani | 74da78b | 2016-02-09 21:18:36 -0800 | [diff] [blame] | 104 | Versioned<V> v = readCache.computeIfAbsent(key, k -> backingConsitentMap.get(k)); |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 105 | return v != null ? v.value() : null; |
| 106 | } |
| 107 | } |
| 108 | |
| 109 | @Override |
| 110 | public V put(K key, V value) { |
| 111 | checkState(txContext.isOpen(), TX_CLOSED_ERROR); |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 112 | checkNotNull(value, ERROR_NULL_VALUE); |
| 113 | |
| 114 | V latest = get(key); |
| 115 | writeCache.put(key, value); |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 116 | deleteSet.remove(key); |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 117 | return latest; |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 118 | } |
| 119 | |
| 120 | @Override |
| 121 | public V remove(K key) { |
| 122 | checkState(txContext.isOpen(), TX_CLOSED_ERROR); |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 123 | V latest = get(key); |
| 124 | if (latest != null) { |
| 125 | writeCache.remove(key); |
| 126 | deleteSet.add(key); |
| 127 | } |
| 128 | return latest; |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 129 | } |
| 130 | |
| 131 | @Override |
| 132 | public boolean remove(K key, V value) { |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 133 | checkState(txContext.isOpen(), TX_CLOSED_ERROR); |
| 134 | checkNotNull(value, ERROR_NULL_VALUE); |
| 135 | V latest = get(key); |
| 136 | if (Objects.equal(value, latest)) { |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 137 | remove(key); |
| 138 | return true; |
| 139 | } |
| 140 | return false; |
| 141 | } |
| 142 | |
| 143 | @Override |
| 144 | public boolean replace(K key, V oldValue, V newValue) { |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 145 | checkState(txContext.isOpen(), TX_CLOSED_ERROR); |
| 146 | checkNotNull(oldValue, ERROR_NULL_VALUE); |
| 147 | checkNotNull(newValue, ERROR_NULL_VALUE); |
| 148 | V latest = get(key); |
| 149 | if (Objects.equal(oldValue, latest)) { |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 150 | put(key, newValue); |
| 151 | return true; |
| 152 | } |
| 153 | return false; |
| 154 | } |
| 155 | |
| 156 | @Override |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 157 | public V putIfAbsent(K key, V value) { |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 158 | checkState(txContext.isOpen(), TX_CLOSED_ERROR); |
| 159 | checkNotNull(value, ERROR_NULL_VALUE); |
| 160 | V latest = get(key); |
| 161 | if (latest == null) { |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 162 | put(key, value); |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 163 | } |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 164 | return latest; |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 165 | } |
| 166 | |
Madan Jampani | 74da78b | 2016-02-09 21:18:36 -0800 | [diff] [blame] | 167 | @Override |
| 168 | public CompletableFuture<Boolean> prepare() { |
| 169 | return backingMap.prepare(new MapTransaction<>(txContext.transactionId(), updates())); |
| 170 | } |
| 171 | |
| 172 | @Override |
| 173 | public CompletableFuture<Void> commit() { |
| 174 | return backingMap.commit(txContext.transactionId()); |
| 175 | } |
| 176 | |
| 177 | @Override |
| 178 | public CompletableFuture<Void> rollback() { |
| 179 | return backingMap.rollback(txContext.transactionId()); |
| 180 | } |
| 181 | |
| 182 | @Override |
| 183 | public boolean hasPendingUpdates() { |
| 184 | return updates().size() > 0; |
| 185 | } |
| 186 | |
| 187 | protected List<MapUpdate<K, V>> updates() { |
| 188 | List<MapUpdate<K, V>> updates = Lists.newLinkedList(); |
| 189 | deleteSet.forEach(key -> { |
| 190 | Versioned<V> original = readCache.get(key); |
| 191 | if (original != null) { |
| 192 | updates.add(MapUpdate.<K, V>newBuilder() |
| 193 | .withMapName(name) |
| 194 | .withType(MapUpdate.Type.REMOVE_IF_VERSION_MATCH) |
| 195 | .withKey(key) |
| 196 | .withCurrentVersion(original.version()) |
| 197 | .build()); |
| 198 | } |
| 199 | }); |
| 200 | writeCache.forEach((key, value) -> { |
| 201 | Versioned<V> original = readCache.get(key); |
| 202 | if (original == null) { |
| 203 | updates.add(MapUpdate.<K, V>newBuilder() |
| 204 | .withMapName(name) |
| 205 | .withType(MapUpdate.Type.PUT_IF_ABSENT) |
| 206 | .withKey(key) |
| 207 | .withValue(value) |
| 208 | .build()); |
| 209 | } else { |
| 210 | updates.add(MapUpdate.<K, V>newBuilder() |
| 211 | .withMapName(name) |
| 212 | .withType(MapUpdate.Type.PUT_IF_VERSION_MATCH) |
| 213 | .withKey(key) |
| 214 | .withCurrentVersion(original.version()) |
| 215 | .withValue(value) |
| 216 | .build()); |
| 217 | } |
| 218 | }); |
| 219 | return updates; |
| 220 | } |
| 221 | |
| 222 | |
Madan Jampani | cadd70b | 2016-02-08 13:45:43 -0800 | [diff] [blame] | 223 | protected List<MapUpdate<String, byte[]>> toMapUpdates() { |
| 224 | List<MapUpdate<String, byte[]>> updates = Lists.newLinkedList(); |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 225 | deleteSet.forEach(key -> { |
| 226 | Versioned<V> original = readCache.get(key); |
| 227 | if (original != null) { |
Madan Jampani | cadd70b | 2016-02-08 13:45:43 -0800 | [diff] [blame] | 228 | updates.add(MapUpdate.<String, byte[]>newBuilder() |
Madan Jampani | 7804c99 | 2015-07-20 13:20:19 -0700 | [diff] [blame] | 229 | .withMapName(name) |
Madan Jampani | cadd70b | 2016-02-08 13:45:43 -0800 | [diff] [blame] | 230 | .withType(MapUpdate.Type.REMOVE_IF_VERSION_MATCH) |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 231 | .withKey(keyCache.getUnchecked(key)) |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 232 | .withCurrentVersion(original.version()) |
| 233 | .build()); |
| 234 | } |
| 235 | }); |
| 236 | writeCache.forEach((key, value) -> { |
| 237 | Versioned<V> original = readCache.get(key); |
| 238 | if (original == null) { |
Madan Jampani | cadd70b | 2016-02-08 13:45:43 -0800 | [diff] [blame] | 239 | updates.add(MapUpdate.<String, byte[]>newBuilder() |
Madan Jampani | 7804c99 | 2015-07-20 13:20:19 -0700 | [diff] [blame] | 240 | .withMapName(name) |
Madan Jampani | cadd70b | 2016-02-08 13:45:43 -0800 | [diff] [blame] | 241 | .withType(MapUpdate.Type.PUT_IF_ABSENT) |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 242 | .withKey(keyCache.getUnchecked(key)) |
| 243 | .withValue(serializer.encode(value)) |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 244 | .build()); |
| 245 | } else { |
Madan Jampani | cadd70b | 2016-02-08 13:45:43 -0800 | [diff] [blame] | 246 | updates.add(MapUpdate.<String, byte[]>newBuilder() |
Madan Jampani | 7804c99 | 2015-07-20 13:20:19 -0700 | [diff] [blame] | 247 | .withMapName(name) |
Madan Jampani | cadd70b | 2016-02-08 13:45:43 -0800 | [diff] [blame] | 248 | .withType(MapUpdate.Type.PUT_IF_VERSION_MATCH) |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 249 | .withKey(keyCache.getUnchecked(key)) |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 250 | .withCurrentVersion(original.version()) |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 251 | .withValue(serializer.encode(value)) |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 252 | .build()); |
| 253 | } |
| 254 | }); |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 255 | return updates; |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 256 | } |
| 257 | |
HIGUCHI Yuta | dc4394c | 2016-01-29 15:35:10 -0800 | [diff] [blame] | 258 | @Override |
| 259 | public String toString() { |
| 260 | return MoreObjects.toStringHelper(this) |
| 261 | .add("backingMap", backingMap) |
Madan Jampani | 74da78b | 2016-02-09 21:18:36 -0800 | [diff] [blame] | 262 | .add("updates", updates()) |
HIGUCHI Yuta | dc4394c | 2016-01-29 15:35:10 -0800 | [diff] [blame] | 263 | .toString(); |
| 264 | } |
| 265 | |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 266 | /** |
| 267 | * Discards all changes made to this transactional map. |
| 268 | */ |
Madan Jampani | 74da78b | 2016-02-09 21:18:36 -0800 | [diff] [blame] | 269 | protected void abort() { |
Madan Jampani | 6468955 | 2015-02-17 10:00:27 -0800 | [diff] [blame] | 270 | readCache.clear(); |
| 271 | writeCache.clear(); |
| 272 | deleteSet.clear(); |
| 273 | } |
| 274 | } |