Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 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 | */ |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 16 | package org.onosproject.store.primitives.impl; |
| 17 | |
Madan Jampani | 1d3b617 | 2016-04-28 13:22:57 -0700 | [diff] [blame] | 18 | import static org.slf4j.LoggerFactory.getLogger; |
| 19 | |
Jordan Halterman | 74d76b1 | 2018-06-27 13:38:09 -0700 | [diff] [blame] | 20 | import java.util.Map; |
Jordan Halterman | 5ecdb34 | 2017-07-22 12:33:14 -0700 | [diff] [blame] | 21 | import java.util.Objects; |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 22 | import java.util.concurrent.CompletableFuture; |
Jordan Halterman | 74d76b1 | 2018-06-27 13:38:09 -0700 | [diff] [blame] | 23 | import java.util.concurrent.ConcurrentHashMap; |
| 24 | import java.util.concurrent.Executor; |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 25 | import java.util.function.BiFunction; |
Madan Jampani | 1d3b617 | 2016-04-28 13:22:57 -0700 | [diff] [blame] | 26 | import java.util.function.Consumer; |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 27 | import java.util.function.Predicate; |
| 28 | |
Jordan Halterman | 74d76b1 | 2018-06-27 13:38:09 -0700 | [diff] [blame] | 29 | import com.google.common.util.concurrent.MoreExecutors; |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 30 | import org.onosproject.store.service.AsyncConsistentMap; |
Madan Jampani | 62f1533 | 2016-02-01 13:18:39 -0800 | [diff] [blame] | 31 | import org.onosproject.store.service.MapEventListener; |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 32 | import org.onosproject.store.service.Versioned; |
Madan Jampani | 1d3b617 | 2016-04-28 13:22:57 -0700 | [diff] [blame] | 33 | import org.slf4j.Logger; |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 34 | |
| 35 | import com.google.common.cache.CacheBuilder; |
| 36 | import com.google.common.cache.CacheLoader; |
| 37 | import com.google.common.cache.LoadingCache; |
| 38 | |
Madan Jampani | 1d3b617 | 2016-04-28 13:22:57 -0700 | [diff] [blame] | 39 | import static org.onosproject.store.service.DistributedPrimitive.Status.INACTIVE; |
| 40 | import static org.onosproject.store.service.DistributedPrimitive.Status.SUSPENDED; |
| 41 | |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 42 | /** |
| 43 | * {@code AsyncConsistentMap} that caches entries on read. |
| 44 | * <p> |
| 45 | * The cache entries are automatically invalidated when updates are detected either locally or |
| 46 | * remotely. |
| 47 | * <p> This implementation only attempts to serve cached entries for {@link AsyncConsistentMap#get get} |
Jordan Halterman | 5ecdb34 | 2017-07-22 12:33:14 -0700 | [diff] [blame] | 48 | * {@link AsyncConsistentMap#getOrDefault(Object, Object) getOrDefault}, and |
| 49 | * {@link AsyncConsistentMap#containsKey(Object) containsKey} calls. All other calls skip the cache |
| 50 | * and directly go the backing map. |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 51 | * |
| 52 | * @param <K> key type |
| 53 | * @param <V> value type |
| 54 | */ |
| 55 | public class CachingAsyncConsistentMap<K, V> extends DelegatingAsyncConsistentMap<K, V> { |
Madan Jampani | 1d3b617 | 2016-04-28 13:22:57 -0700 | [diff] [blame] | 56 | private static final int DEFAULT_CACHE_SIZE = 10000; |
| 57 | private final Logger log = getLogger(getClass()); |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 58 | |
Jordan Halterman | 74d76b1 | 2018-06-27 13:38:09 -0700 | [diff] [blame] | 59 | private final Map<MapEventListener<K, V>, Executor> mapEventListeners = new ConcurrentHashMap<>(); |
Madan Jampani | 1d3b617 | 2016-04-28 13:22:57 -0700 | [diff] [blame] | 60 | private final LoadingCache<K, CompletableFuture<Versioned<V>>> cache; |
Jordan Halterman | b224307 | 2017-05-09 12:04:04 -0700 | [diff] [blame] | 61 | private final AsyncConsistentMap<K, V> backingMap; |
Madan Jampani | e88086f | 2016-06-16 16:48:14 -0700 | [diff] [blame] | 62 | private final MapEventListener<K, V> cacheUpdater; |
Madan Jampani | 1d3b617 | 2016-04-28 13:22:57 -0700 | [diff] [blame] | 63 | private final Consumer<Status> statusListener; |
Madan Jampani | 62f1533 | 2016-02-01 13:18:39 -0800 | [diff] [blame] | 64 | |
sangyun-han | cce07c5 | 2016-04-06 11:07:59 +0900 | [diff] [blame] | 65 | /** |
| 66 | * Default constructor. |
| 67 | * |
| 68 | * @param backingMap a distributed, strongly consistent map for backing |
| 69 | */ |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 70 | public CachingAsyncConsistentMap(AsyncConsistentMap<K, V> backingMap) { |
Madan Jampani | 1d3b617 | 2016-04-28 13:22:57 -0700 | [diff] [blame] | 71 | this(backingMap, DEFAULT_CACHE_SIZE); |
Madan Jampani | 62f1533 | 2016-02-01 13:18:39 -0800 | [diff] [blame] | 72 | } |
| 73 | |
sangyun-han | cce07c5 | 2016-04-06 11:07:59 +0900 | [diff] [blame] | 74 | /** |
Madan Jampani | 1d3b617 | 2016-04-28 13:22:57 -0700 | [diff] [blame] | 75 | * Constructor to configure cache size. |
sangyun-han | cce07c5 | 2016-04-06 11:07:59 +0900 | [diff] [blame] | 76 | * |
| 77 | * @param backingMap a distributed, strongly consistent map for backing |
| 78 | * @param cacheSize the maximum size of the cache |
| 79 | */ |
| 80 | public CachingAsyncConsistentMap(AsyncConsistentMap<K, V> backingMap, int cacheSize) { |
| 81 | super(backingMap); |
Jordan Halterman | b224307 | 2017-05-09 12:04:04 -0700 | [diff] [blame] | 82 | this.backingMap = backingMap; |
Madan Jampani | 1d3b617 | 2016-04-28 13:22:57 -0700 | [diff] [blame] | 83 | cache = CacheBuilder.newBuilder() |
| 84 | .maximumSize(cacheSize) |
| 85 | .build(CacheLoader.from(CachingAsyncConsistentMap.super::get)); |
Madan Jampani | e88086f | 2016-06-16 16:48:14 -0700 | [diff] [blame] | 86 | cacheUpdater = event -> { |
| 87 | Versioned<V> newValue = event.newValue(); |
| 88 | if (newValue == null) { |
| 89 | cache.invalidate(event.key()); |
| 90 | } else { |
| 91 | cache.put(event.key(), CompletableFuture.completedFuture(newValue)); |
| 92 | } |
Jordan Halterman | 74d76b1 | 2018-06-27 13:38:09 -0700 | [diff] [blame] | 93 | mapEventListeners.forEach((listener, executor) -> executor.execute(() -> listener.event(event))); |
Madan Jampani | e88086f | 2016-06-16 16:48:14 -0700 | [diff] [blame] | 94 | }; |
Madan Jampani | 1d3b617 | 2016-04-28 13:22:57 -0700 | [diff] [blame] | 95 | statusListener = status -> { |
| 96 | log.debug("{} status changed to {}", this.name(), status); |
| 97 | // If the status of the underlying map is SUSPENDED or INACTIVE |
| 98 | // we can no longer guarantee that the cache will be in sync. |
| 99 | if (status == SUSPENDED || status == INACTIVE) { |
| 100 | cache.invalidateAll(); |
| 101 | } |
| 102 | }; |
Jordan Halterman | 74d76b1 | 2018-06-27 13:38:09 -0700 | [diff] [blame] | 103 | super.addListener(cacheUpdater, MoreExecutors.directExecutor()); |
Madan Jampani | 1d3b617 | 2016-04-28 13:22:57 -0700 | [diff] [blame] | 104 | super.addStatusChangeListener(statusListener); |
sangyun-han | cce07c5 | 2016-04-06 11:07:59 +0900 | [diff] [blame] | 105 | } |
| 106 | |
Madan Jampani | 62f1533 | 2016-02-01 13:18:39 -0800 | [diff] [blame] | 107 | @Override |
| 108 | public CompletableFuture<Void> destroy() { |
Madan Jampani | 1d3b617 | 2016-04-28 13:22:57 -0700 | [diff] [blame] | 109 | super.removeStatusChangeListener(statusListener); |
Madan Jampani | e88086f | 2016-06-16 16:48:14 -0700 | [diff] [blame] | 110 | return super.destroy().thenCompose(v -> removeListener(cacheUpdater)); |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 111 | } |
| 112 | |
| 113 | @Override |
| 114 | public CompletableFuture<Versioned<V>> get(K key) { |
Madan Jampani | 7701244 | 2016-06-02 07:47:42 -0700 | [diff] [blame] | 115 | return cache.getUnchecked(key) |
| 116 | .whenComplete((r, e) -> { |
| 117 | if (e != null) { |
| 118 | cache.invalidate(key); |
| 119 | } |
| 120 | }); |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 121 | } |
| 122 | |
| 123 | @Override |
Jordan Halterman | b224307 | 2017-05-09 12:04:04 -0700 | [diff] [blame] | 124 | public CompletableFuture<Versioned<V>> getOrDefault(K key, V defaultValue) { |
| 125 | return cache.getUnchecked(key).thenCompose(r -> { |
| 126 | if (r == null) { |
| 127 | CompletableFuture<Versioned<V>> versioned = backingMap.getOrDefault(key, defaultValue); |
| 128 | cache.put(key, versioned); |
| 129 | return versioned; |
| 130 | } else { |
| 131 | return CompletableFuture.completedFuture(r); |
| 132 | } |
| 133 | }).whenComplete((r, e) -> { |
| 134 | if (e != null) { |
| 135 | cache.invalidate(key); |
| 136 | } |
| 137 | }); |
| 138 | } |
| 139 | |
| 140 | @Override |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 141 | public CompletableFuture<Versioned<V>> computeIf(K key, |
| 142 | Predicate<? super V> condition, |
| 143 | BiFunction<? super K, ? super V, ? extends V> remappingFunction) { |
| 144 | return super.computeIf(key, condition, remappingFunction) |
sangyun-han | cce07c5 | 2016-04-06 11:07:59 +0900 | [diff] [blame] | 145 | .whenComplete((r, e) -> cache.invalidate(key)); |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 146 | } |
| 147 | |
| 148 | @Override |
| 149 | public CompletableFuture<Versioned<V>> put(K key, V value) { |
| 150 | return super.put(key, value) |
sangyun-han | cce07c5 | 2016-04-06 11:07:59 +0900 | [diff] [blame] | 151 | .whenComplete((r, e) -> cache.invalidate(key)); |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 152 | } |
| 153 | |
| 154 | @Override |
| 155 | public CompletableFuture<Versioned<V>> putAndGet(K key, V value) { |
Simon Hunt | 5829c34 | 2016-03-07 17:01:43 -0800 | [diff] [blame] | 156 | return super.putAndGet(key, value) |
sangyun-han | cce07c5 | 2016-04-06 11:07:59 +0900 | [diff] [blame] | 157 | .whenComplete((r, e) -> cache.invalidate(key)); |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 158 | } |
| 159 | |
| 160 | @Override |
Jordan Halterman | 5ecdb34 | 2017-07-22 12:33:14 -0700 | [diff] [blame] | 161 | public CompletableFuture<Versioned<V>> putIfAbsent(K key, V value) { |
| 162 | return super.putIfAbsent(key, value) |
| 163 | .whenComplete((r, e) -> cache.invalidate(key)); |
| 164 | } |
| 165 | |
| 166 | @Override |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 167 | public CompletableFuture<Versioned<V>> remove(K key) { |
| 168 | return super.remove(key) |
sangyun-han | cce07c5 | 2016-04-06 11:07:59 +0900 | [diff] [blame] | 169 | .whenComplete((r, e) -> cache.invalidate(key)); |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 170 | } |
| 171 | |
| 172 | @Override |
Jordan Halterman | 5ecdb34 | 2017-07-22 12:33:14 -0700 | [diff] [blame] | 173 | public CompletableFuture<Boolean> containsKey(K key) { |
| 174 | return cache.getUnchecked(key).thenApply(Objects::nonNull) |
| 175 | .whenComplete((r, e) -> { |
| 176 | if (e != null) { |
| 177 | cache.invalidate(key); |
| 178 | } |
| 179 | }); |
| 180 | } |
| 181 | |
| 182 | @Override |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 183 | public CompletableFuture<Void> clear() { |
| 184 | return super.clear() |
sangyun-han | cce07c5 | 2016-04-06 11:07:59 +0900 | [diff] [blame] | 185 | .whenComplete((r, e) -> cache.invalidateAll()); |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 186 | } |
| 187 | |
| 188 | @Override |
| 189 | public CompletableFuture<Boolean> remove(K key, V value) { |
| 190 | return super.remove(key, value) |
Madan Jampani | 7701244 | 2016-06-02 07:47:42 -0700 | [diff] [blame] | 191 | .whenComplete((r, e) -> { |
| 192 | if (r) { |
| 193 | cache.invalidate(key); |
| 194 | } |
| 195 | }); |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 196 | } |
| 197 | |
| 198 | @Override |
| 199 | public CompletableFuture<Boolean> remove(K key, long version) { |
| 200 | return super.remove(key, version) |
| 201 | .whenComplete((r, e) -> { |
| 202 | if (r) { |
| 203 | cache.invalidate(key); |
| 204 | } |
| 205 | }); |
| 206 | } |
| 207 | |
| 208 | @Override |
| 209 | public CompletableFuture<Versioned<V>> replace(K key, V value) { |
| 210 | return super.replace(key, value) |
Madan Jampani | 7701244 | 2016-06-02 07:47:42 -0700 | [diff] [blame] | 211 | .whenComplete((r, e) -> cache.invalidate(key)); |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 212 | } |
| 213 | |
| 214 | @Override |
| 215 | public CompletableFuture<Boolean> replace(K key, V oldValue, V newValue) { |
| 216 | return super.replace(key, oldValue, newValue) |
| 217 | .whenComplete((r, e) -> { |
| 218 | if (r) { |
| 219 | cache.invalidate(key); |
| 220 | } |
| 221 | }); |
| 222 | } |
| 223 | |
| 224 | @Override |
| 225 | public CompletableFuture<Boolean> replace(K key, long oldVersion, V newValue) { |
| 226 | return super.replace(key, oldVersion, newValue) |
| 227 | .whenComplete((r, e) -> { |
| 228 | if (r) { |
| 229 | cache.invalidate(key); |
| 230 | } |
| 231 | }); |
| 232 | } |
Jordan Halterman | 74d76b1 | 2018-06-27 13:38:09 -0700 | [diff] [blame] | 233 | |
| 234 | @Override |
| 235 | public CompletableFuture<Void> addListener(MapEventListener<K, V> listener, Executor executor) { |
| 236 | mapEventListeners.put(listener, executor); |
| 237 | return CompletableFuture.completedFuture(null); |
| 238 | } |
| 239 | |
| 240 | @Override |
| 241 | public CompletableFuture<Void> removeListener(MapEventListener<K, V> listener) { |
| 242 | mapEventListeners.remove(listener); |
| 243 | return CompletableFuture.completedFuture(null); |
| 244 | } |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 245 | } |