Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [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 | |
| 17 | package org.onosproject.store.consistent.impl; |
| 18 | |
| 19 | import static com.google.common.base.Preconditions.*; |
| 20 | |
| 21 | import java.util.Collection; |
| 22 | import java.util.Map; |
| 23 | import java.util.Map.Entry; |
| 24 | import java.util.concurrent.CompletableFuture; |
| 25 | import java.util.stream.Collectors; |
| 26 | import java.util.Set; |
| 27 | |
| 28 | import org.apache.commons.lang3.tuple.Pair; |
| 29 | import org.onlab.util.HexString; |
| 30 | import org.onosproject.store.service.AsyncConsistentMap; |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 31 | import org.onosproject.store.service.ConsistentMapException; |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 32 | import org.onosproject.store.service.Serializer; |
| 33 | import org.onosproject.store.service.Versioned; |
| 34 | |
| 35 | import com.google.common.cache.CacheBuilder; |
| 36 | import com.google.common.cache.CacheLoader; |
| 37 | import com.google.common.cache.LoadingCache; |
| 38 | |
| 39 | /** |
| 40 | * AsyncConsistentMap implementation that is backed by a Raft consensus |
| 41 | * based database. |
| 42 | * |
| 43 | * @param <K> type of key. |
| 44 | * @param <V> type of value. |
| 45 | */ |
| 46 | public class DefaultAsyncConsistentMap<K, V> implements AsyncConsistentMap<K, V> { |
| 47 | |
| 48 | private final String name; |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 49 | private final Database database; |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 50 | private final Serializer serializer; |
Madan Jampani | 02b7fb8 | 2015-05-01 13:01:20 -0700 | [diff] [blame] | 51 | private final boolean readOnly; |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 52 | |
| 53 | private static final String ERROR_NULL_KEY = "Key cannot be null"; |
| 54 | private static final String ERROR_NULL_VALUE = "Null values are not allowed"; |
| 55 | |
| 56 | private final LoadingCache<K, String> keyCache = CacheBuilder.newBuilder() |
| 57 | .softValues() |
| 58 | .build(new CacheLoader<K, String>() { |
| 59 | |
| 60 | @Override |
| 61 | public String load(K key) { |
| 62 | return HexString.toHexString(serializer.encode(key)); |
| 63 | } |
| 64 | }); |
| 65 | |
| 66 | protected K dK(String key) { |
| 67 | return serializer.decode(HexString.fromHexString(key)); |
| 68 | } |
| 69 | |
| 70 | public DefaultAsyncConsistentMap(String name, |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 71 | Database database, |
Madan Jampani | 02b7fb8 | 2015-05-01 13:01:20 -0700 | [diff] [blame] | 72 | Serializer serializer, |
| 73 | boolean readOnly) { |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 74 | this.name = checkNotNull(name, "map name cannot be null"); |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 75 | this.database = checkNotNull(database, "database cannot be null"); |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 76 | this.serializer = checkNotNull(serializer, "serializer cannot be null"); |
Madan Jampani | 02b7fb8 | 2015-05-01 13:01:20 -0700 | [diff] [blame] | 77 | this.readOnly = readOnly; |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 78 | } |
| 79 | |
| 80 | @Override |
| 81 | public CompletableFuture<Integer> size() { |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 82 | return database.size(name); |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 83 | } |
| 84 | |
| 85 | @Override |
| 86 | public CompletableFuture<Boolean> isEmpty() { |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 87 | return database.isEmpty(name); |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 88 | } |
| 89 | |
| 90 | @Override |
| 91 | public CompletableFuture<Boolean> containsKey(K key) { |
| 92 | checkNotNull(key, ERROR_NULL_KEY); |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 93 | return database.containsKey(name, keyCache.getUnchecked(key)); |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 94 | } |
| 95 | |
| 96 | @Override |
| 97 | public CompletableFuture<Boolean> containsValue(V value) { |
| 98 | checkNotNull(value, ERROR_NULL_VALUE); |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 99 | return database.containsValue(name, serializer.encode(value)); |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 100 | } |
| 101 | |
| 102 | @Override |
| 103 | public CompletableFuture<Versioned<V>> get(K key) { |
| 104 | checkNotNull(key, ERROR_NULL_KEY); |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 105 | return database.get(name, keyCache.getUnchecked(key)) |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 106 | .thenApply(v -> v != null |
| 107 | ? new Versioned<>(serializer.decode(v.value()), v.version(), v.creationTime()) : null); |
| 108 | } |
| 109 | |
| 110 | @Override |
| 111 | public CompletableFuture<Versioned<V>> put(K key, V value) { |
| 112 | checkNotNull(key, ERROR_NULL_KEY); |
| 113 | checkNotNull(value, ERROR_NULL_VALUE); |
Madan Jampani | 02b7fb8 | 2015-05-01 13:01:20 -0700 | [diff] [blame] | 114 | checkIfUnmodifiable(); |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 115 | return database.put(name, keyCache.getUnchecked(key), serializer.encode(value)) |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 116 | .thenApply(this::unwrapResult) |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 117 | .thenApply(v -> v != null |
| 118 | ? new Versioned<>(serializer.decode(v.value()), v.version(), v.creationTime()) : null); |
| 119 | } |
| 120 | |
| 121 | @Override |
| 122 | public CompletableFuture<Versioned<V>> remove(K key) { |
| 123 | checkNotNull(key, ERROR_NULL_KEY); |
Madan Jampani | 02b7fb8 | 2015-05-01 13:01:20 -0700 | [diff] [blame] | 124 | checkIfUnmodifiable(); |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 125 | return database.remove(name, keyCache.getUnchecked(key)) |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 126 | .thenApply(this::unwrapResult) |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 127 | .thenApply(v -> v != null |
| 128 | ? new Versioned<>(serializer.decode(v.value()), v.version(), v.creationTime()) : null); |
| 129 | } |
| 130 | |
| 131 | @Override |
| 132 | public CompletableFuture<Void> clear() { |
Madan Jampani | 02b7fb8 | 2015-05-01 13:01:20 -0700 | [diff] [blame] | 133 | checkIfUnmodifiable(); |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 134 | return database.clear(name).thenApply(this::unwrapResult); |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 135 | } |
| 136 | |
| 137 | @Override |
| 138 | public CompletableFuture<Set<K>> keySet() { |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 139 | return database.keySet(name) |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 140 | .thenApply(s -> s |
| 141 | .stream() |
| 142 | .map(this::dK) |
| 143 | .collect(Collectors.toSet())); |
| 144 | } |
| 145 | |
| 146 | @Override |
| 147 | public CompletableFuture<Collection<Versioned<V>>> values() { |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 148 | return database.values(name).thenApply(c -> c |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 149 | .stream() |
| 150 | .map(v -> new Versioned<V>(serializer.decode(v.value()), v.version(), v.creationTime())) |
| 151 | .collect(Collectors.toList())); |
| 152 | } |
| 153 | |
| 154 | @Override |
| 155 | public CompletableFuture<Set<Entry<K, Versioned<V>>>> entrySet() { |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 156 | return database.entrySet(name).thenApply(s -> s |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 157 | .stream() |
| 158 | .map(this::fromRawEntry) |
| 159 | .collect(Collectors.toSet())); |
| 160 | } |
| 161 | |
| 162 | @Override |
| 163 | public CompletableFuture<Versioned<V>> putIfAbsent(K key, V value) { |
| 164 | checkNotNull(key, ERROR_NULL_KEY); |
| 165 | checkNotNull(value, ERROR_NULL_VALUE); |
Madan Jampani | 02b7fb8 | 2015-05-01 13:01:20 -0700 | [diff] [blame] | 166 | checkIfUnmodifiable(); |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 167 | return database.putIfAbsent(name, |
| 168 | keyCache.getUnchecked(key), |
| 169 | serializer.encode(value)) |
| 170 | .thenApply(this::unwrapResult) |
| 171 | .thenApply(v -> v != null ? |
| 172 | new Versioned<>(serializer.decode(v.value()), v.version(), v.creationTime()) : null); |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 173 | } |
| 174 | |
| 175 | @Override |
| 176 | public CompletableFuture<Boolean> remove(K key, V value) { |
| 177 | checkNotNull(key, ERROR_NULL_KEY); |
| 178 | checkNotNull(value, ERROR_NULL_VALUE); |
Madan Jampani | 02b7fb8 | 2015-05-01 13:01:20 -0700 | [diff] [blame] | 179 | checkIfUnmodifiable(); |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 180 | return database.remove(name, keyCache.getUnchecked(key), serializer.encode(value)) |
| 181 | .thenApply(this::unwrapResult); |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 182 | } |
| 183 | |
| 184 | @Override |
| 185 | public CompletableFuture<Boolean> remove(K key, long version) { |
| 186 | checkNotNull(key, ERROR_NULL_KEY); |
Madan Jampani | 02b7fb8 | 2015-05-01 13:01:20 -0700 | [diff] [blame] | 187 | checkIfUnmodifiable(); |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 188 | return database.remove(name, keyCache.getUnchecked(key), version) |
| 189 | .thenApply(this::unwrapResult); |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 190 | |
| 191 | } |
| 192 | |
| 193 | @Override |
| 194 | public CompletableFuture<Boolean> replace(K key, V oldValue, V newValue) { |
| 195 | checkNotNull(key, ERROR_NULL_KEY); |
| 196 | checkNotNull(newValue, ERROR_NULL_VALUE); |
Madan Jampani | 02b7fb8 | 2015-05-01 13:01:20 -0700 | [diff] [blame] | 197 | checkIfUnmodifiable(); |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 198 | byte[] existing = oldValue != null ? serializer.encode(oldValue) : null; |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 199 | return database.replace(name, keyCache.getUnchecked(key), existing, serializer.encode(newValue)) |
| 200 | .thenApply(this::unwrapResult); |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 201 | } |
| 202 | |
| 203 | @Override |
| 204 | public CompletableFuture<Boolean> replace(K key, long oldVersion, V newValue) { |
| 205 | checkNotNull(key, ERROR_NULL_KEY); |
| 206 | checkNotNull(newValue, ERROR_NULL_VALUE); |
Madan Jampani | 02b7fb8 | 2015-05-01 13:01:20 -0700 | [diff] [blame] | 207 | checkIfUnmodifiable(); |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 208 | return database.replace(name, keyCache.getUnchecked(key), oldVersion, serializer.encode(newValue)) |
| 209 | .thenApply(this::unwrapResult); |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 210 | } |
| 211 | |
| 212 | private Map.Entry<K, Versioned<V>> fromRawEntry(Map.Entry<String, Versioned<byte[]>> e) { |
| 213 | return Pair.of( |
| 214 | dK(e.getKey()), |
| 215 | new Versioned<>( |
| 216 | serializer.decode(e.getValue().value()), |
| 217 | e.getValue().version(), |
| 218 | e.getValue().creationTime())); |
| 219 | } |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 220 | |
| 221 | private <T> T unwrapResult(Result<T> result) { |
| 222 | if (result.status() == Result.Status.LOCKED) { |
| 223 | throw new ConsistentMapException.ConcurrentModification(); |
| 224 | } else if (result.success()) { |
| 225 | return result.value(); |
| 226 | } else { |
| 227 | throw new IllegalStateException("Must not be here"); |
| 228 | } |
| 229 | } |
Madan Jampani | 02b7fb8 | 2015-05-01 13:01:20 -0700 | [diff] [blame] | 230 | |
| 231 | private void checkIfUnmodifiable() { |
| 232 | if (readOnly) { |
| 233 | throw new UnsupportedOperationException(); |
| 234 | } |
| 235 | } |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 236 | } |