Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016 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.primitives.impl; |
| 18 | |
| 19 | import java.util.concurrent.CompletableFuture; |
| 20 | import java.util.function.BiFunction; |
| 21 | import java.util.function.Predicate; |
| 22 | |
| 23 | import org.onosproject.store.service.AsyncConsistentMap; |
Madan Jampani | 62f1533 | 2016-02-01 13:18:39 -0800 | [diff] [blame] | 24 | import org.onosproject.store.service.MapEventListener; |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 25 | import org.onosproject.store.service.Versioned; |
| 26 | |
| 27 | import com.google.common.cache.CacheBuilder; |
| 28 | import com.google.common.cache.CacheLoader; |
| 29 | import com.google.common.cache.LoadingCache; |
| 30 | |
| 31 | /** |
| 32 | * {@code AsyncConsistentMap} that caches entries on read. |
| 33 | * <p> |
| 34 | * The cache entries are automatically invalidated when updates are detected either locally or |
| 35 | * remotely. |
| 36 | * <p> This implementation only attempts to serve cached entries for {@link AsyncConsistentMap#get get} |
| 37 | * calls. All other calls skip the cache and directly go the backing map. |
| 38 | * |
| 39 | * @param <K> key type |
| 40 | * @param <V> value type |
| 41 | */ |
| 42 | public class CachingAsyncConsistentMap<K, V> extends DelegatingAsyncConsistentMap<K, V> { |
| 43 | |
| 44 | private final LoadingCache<K, CompletableFuture<Versioned<V>>> cache = |
| 45 | CacheBuilder.newBuilder() |
| 46 | .maximumSize(10000) // TODO: make configurable |
| 47 | .build(new CacheLoader<K, CompletableFuture<Versioned<V>>>() { |
| 48 | @Override |
| 49 | public CompletableFuture<Versioned<V>> load(K key) |
| 50 | throws Exception { |
| 51 | return CachingAsyncConsistentMap.super.get(key); |
| 52 | } |
| 53 | }); |
| 54 | |
Madan Jampani | 62f1533 | 2016-02-01 13:18:39 -0800 | [diff] [blame] | 55 | private final MapEventListener<K, V> cacheInvalidator = event -> cache.invalidate(event.key()); |
| 56 | |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 57 | public CachingAsyncConsistentMap(AsyncConsistentMap<K, V> backingMap) { |
| 58 | super(backingMap); |
Madan Jampani | 62f1533 | 2016-02-01 13:18:39 -0800 | [diff] [blame] | 59 | super.addListener(cacheInvalidator); |
| 60 | } |
| 61 | |
| 62 | @Override |
| 63 | public CompletableFuture<Void> destroy() { |
| 64 | return super.destroy().thenCompose(v -> removeListener(cacheInvalidator)); |
Madan Jampani | 1007367 | 2016-01-21 19:13:59 -0800 | [diff] [blame] | 65 | } |
| 66 | |
| 67 | @Override |
| 68 | public CompletableFuture<Versioned<V>> get(K key) { |
| 69 | return cache.getUnchecked(key); |
| 70 | } |
| 71 | |
| 72 | @Override |
| 73 | public CompletableFuture<Versioned<V>> computeIf(K key, |
| 74 | Predicate<? super V> condition, |
| 75 | BiFunction<? super K, ? super V, ? extends V> remappingFunction) { |
| 76 | return super.computeIf(key, condition, remappingFunction) |
| 77 | .whenComplete((r, e) -> cache.invalidate(key)); |
| 78 | } |
| 79 | |
| 80 | @Override |
| 81 | public CompletableFuture<Versioned<V>> put(K key, V value) { |
| 82 | return super.put(key, value) |
| 83 | .whenComplete((r, e) -> cache.invalidate(key)); |
| 84 | } |
| 85 | |
| 86 | @Override |
| 87 | public CompletableFuture<Versioned<V>> putAndGet(K key, V value) { |
| 88 | return super.put(key, value) |
| 89 | .whenComplete((r, e) -> cache.invalidate(key)); |
| 90 | } |
| 91 | |
| 92 | @Override |
| 93 | public CompletableFuture<Versioned<V>> remove(K key) { |
| 94 | return super.remove(key) |
| 95 | .whenComplete((r, e) -> cache.invalidate(key)); |
| 96 | } |
| 97 | |
| 98 | @Override |
| 99 | public CompletableFuture<Void> clear() { |
| 100 | return super.clear() |
| 101 | .whenComplete((r, e) -> cache.invalidateAll()); |
| 102 | } |
| 103 | |
| 104 | @Override |
| 105 | public CompletableFuture<Boolean> remove(K key, V value) { |
| 106 | return super.remove(key, value) |
| 107 | .whenComplete((r, e) -> { |
| 108 | if (r) { |
| 109 | cache.invalidate(key); |
| 110 | } |
| 111 | }); |
| 112 | } |
| 113 | |
| 114 | @Override |
| 115 | public CompletableFuture<Boolean> remove(K key, long version) { |
| 116 | return super.remove(key, version) |
| 117 | .whenComplete((r, e) -> { |
| 118 | if (r) { |
| 119 | cache.invalidate(key); |
| 120 | } |
| 121 | }); |
| 122 | } |
| 123 | |
| 124 | @Override |
| 125 | public CompletableFuture<Versioned<V>> replace(K key, V value) { |
| 126 | return super.replace(key, value) |
| 127 | .whenComplete((r, e) -> cache.invalidate(key)); |
| 128 | } |
| 129 | |
| 130 | @Override |
| 131 | public CompletableFuture<Boolean> replace(K key, V oldValue, V newValue) { |
| 132 | return super.replace(key, oldValue, newValue) |
| 133 | .whenComplete((r, e) -> { |
| 134 | if (r) { |
| 135 | cache.invalidate(key); |
| 136 | } |
| 137 | }); |
| 138 | } |
| 139 | |
| 140 | @Override |
| 141 | public CompletableFuture<Boolean> replace(K key, long oldVersion, V newValue) { |
| 142 | return super.replace(key, oldVersion, newValue) |
| 143 | .whenComplete((r, e) -> { |
| 144 | if (r) { |
| 145 | cache.invalidate(key); |
| 146 | } |
| 147 | }); |
| 148 | } |
| 149 | } |