Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [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 | 7c52100 | 2015-03-23 12:23:01 -0700 | [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 | */ |
Brian O'Connor | 7cbbbb7 | 2016-04-09 02:13:23 -0700 | [diff] [blame] | 16 | package org.onosproject.store.primitives; |
| 17 | |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 18 | import java.util.Collection; |
Jordan Halterman | dae1160 | 2018-07-03 00:00:47 -0700 | [diff] [blame] | 19 | import java.util.Iterator; |
Madan Jampani | e106522 | 2015-08-17 16:21:51 -0700 | [diff] [blame] | 20 | import java.util.Map; |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 21 | import java.util.Map.Entry; |
Madan Jampani | f6c973a | 2016-01-30 22:20:48 -0800 | [diff] [blame] | 22 | import java.util.Objects; |
Madan Jampani | fa24218 | 2016-01-22 13:42:54 -0800 | [diff] [blame] | 23 | import java.util.Set; |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 24 | import java.util.concurrent.CompletableFuture; |
| 25 | import java.util.concurrent.ExecutionException; |
Madan Jampani | 0463cf9 | 2016-05-04 14:46:08 -0700 | [diff] [blame] | 26 | import java.util.concurrent.Executor; |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 27 | import java.util.concurrent.TimeUnit; |
| 28 | import java.util.concurrent.TimeoutException; |
Madan Jampani | 346d4f5 | 2015-05-04 11:09:39 -0700 | [diff] [blame] | 29 | import java.util.function.BiFunction; |
Madan Jampani | 1d3b617 | 2016-04-28 13:22:57 -0700 | [diff] [blame] | 30 | import java.util.function.Consumer; |
Madan Jampani | 346d4f5 | 2015-05-04 11:09:39 -0700 | [diff] [blame] | 31 | import java.util.function.Function; |
| 32 | import java.util.function.Predicate; |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 33 | |
Madan Jampani | f6c973a | 2016-01-30 22:20:48 -0800 | [diff] [blame] | 34 | import org.onlab.util.Tools; |
Madan Jampani | a090a11 | 2016-01-18 16:38:17 -0800 | [diff] [blame] | 35 | import org.onosproject.store.service.AsyncConsistentMap; |
Jordan Halterman | dae1160 | 2018-07-03 00:00:47 -0700 | [diff] [blame] | 36 | import org.onosproject.store.service.AsyncIterator; |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 37 | import org.onosproject.store.service.ConsistentMap; |
| 38 | import org.onosproject.store.service.ConsistentMapException; |
Madan Jampani | f6c973a | 2016-01-30 22:20:48 -0800 | [diff] [blame] | 39 | import org.onosproject.store.service.ConsistentMapException.ConcurrentModification; |
Madan Jampani | 50589ac | 2015-06-08 11:38:46 -0700 | [diff] [blame] | 40 | import org.onosproject.store.service.MapEventListener; |
Madan Jampani | a090a11 | 2016-01-18 16:38:17 -0800 | [diff] [blame] | 41 | import org.onosproject.store.service.Synchronous; |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 42 | import org.onosproject.store.service.Versioned; |
| 43 | |
Madan Jampani | f6c973a | 2016-01-30 22:20:48 -0800 | [diff] [blame] | 44 | import com.google.common.base.Throwables; |
| 45 | |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 46 | /** |
Madan Jampani | fa24218 | 2016-01-22 13:42:54 -0800 | [diff] [blame] | 47 | * Default implementation of {@code ConsistentMap}. |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 48 | * |
| 49 | * @param <K> type of key. |
| 50 | * @param <V> type of value. |
| 51 | */ |
Madan Jampani | a090a11 | 2016-01-18 16:38:17 -0800 | [diff] [blame] | 52 | public class DefaultConsistentMap<K, V> extends Synchronous<AsyncConsistentMap<K, V>> implements ConsistentMap<K, V> { |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 53 | |
Aaron Kruglikov | 2f2e81e | 2016-12-01 15:39:06 -0800 | [diff] [blame] | 54 | private static final int MAX_DELAY_BETWEEN_RETRY_MILLS = 50; |
Madan Jampani | fa24218 | 2016-01-22 13:42:54 -0800 | [diff] [blame] | 55 | private final AsyncConsistentMap<K, V> asyncMap; |
Madan Jampani | 28b2cd6 | 2016-02-02 10:49:52 -0800 | [diff] [blame] | 56 | private final long operationTimeoutMillis; |
Madan Jampani | e106522 | 2015-08-17 16:21:51 -0700 | [diff] [blame] | 57 | private Map<K, V> javaMap; |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 58 | |
Madan Jampani | 28b2cd6 | 2016-02-02 10:49:52 -0800 | [diff] [blame] | 59 | public DefaultConsistentMap(AsyncConsistentMap<K, V> asyncMap, long operationTimeoutMillis) { |
Madan Jampani | a090a11 | 2016-01-18 16:38:17 -0800 | [diff] [blame] | 60 | super(asyncMap); |
Madan Jampani | 50589ac | 2015-06-08 11:38:46 -0700 | [diff] [blame] | 61 | this.asyncMap = asyncMap; |
Madan Jampani | 28b2cd6 | 2016-02-02 10:49:52 -0800 | [diff] [blame] | 62 | this.operationTimeoutMillis = operationTimeoutMillis; |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 63 | } |
| 64 | |
| 65 | @Override |
| 66 | public int size() { |
| 67 | return complete(asyncMap.size()); |
| 68 | } |
| 69 | |
| 70 | @Override |
| 71 | public boolean isEmpty() { |
| 72 | return complete(asyncMap.isEmpty()); |
| 73 | } |
| 74 | |
| 75 | @Override |
| 76 | public boolean containsKey(K key) { |
| 77 | return complete(asyncMap.containsKey(key)); |
| 78 | } |
| 79 | |
| 80 | @Override |
| 81 | public boolean containsValue(V value) { |
| 82 | return complete(asyncMap.containsValue(value)); |
| 83 | } |
| 84 | |
| 85 | @Override |
| 86 | public Versioned<V> get(K key) { |
| 87 | return complete(asyncMap.get(key)); |
| 88 | } |
| 89 | |
| 90 | @Override |
Jordan Halterman | f627244 | 2017-04-20 02:18:08 -0700 | [diff] [blame] | 91 | public Versioned<V> getOrDefault(K key, V defaultValue) { |
| 92 | return complete(asyncMap.getOrDefault(key, defaultValue)); |
| 93 | } |
| 94 | |
| 95 | @Override |
Madan Jampani | 346d4f5 | 2015-05-04 11:09:39 -0700 | [diff] [blame] | 96 | public Versioned<V> computeIfAbsent(K key, |
| 97 | Function<? super K, ? extends V> mappingFunction) { |
Madan Jampani | f6c973a | 2016-01-30 22:20:48 -0800 | [diff] [blame] | 98 | return computeIf(key, Objects::isNull, (k, v) -> mappingFunction.apply(k)); |
Madan Jampani | 346d4f5 | 2015-05-04 11:09:39 -0700 | [diff] [blame] | 99 | } |
| 100 | |
| 101 | @Override |
| 102 | public Versioned<V> computeIfPresent(K key, |
| 103 | BiFunction<? super K, ? super V, ? extends V> remappingFunction) { |
Madan Jampani | f6c973a | 2016-01-30 22:20:48 -0800 | [diff] [blame] | 104 | return computeIf(key, Objects::nonNull, remappingFunction); |
Madan Jampani | 346d4f5 | 2015-05-04 11:09:39 -0700 | [diff] [blame] | 105 | } |
| 106 | |
| 107 | @Override |
| 108 | public Versioned<V> compute(K key, |
| 109 | BiFunction<? super K, ? super V, ? extends V> remappingFunction) { |
Madan Jampani | f6c973a | 2016-01-30 22:20:48 -0800 | [diff] [blame] | 110 | return computeIf(key, v -> true, remappingFunction); |
Madan Jampani | 346d4f5 | 2015-05-04 11:09:39 -0700 | [diff] [blame] | 111 | } |
| 112 | |
| 113 | @Override |
| 114 | public Versioned<V> computeIf(K key, |
| 115 | Predicate<? super V> condition, |
| 116 | BiFunction<? super K, ? super V, ? extends V> remappingFunction) { |
Madan Jampani | f6c973a | 2016-01-30 22:20:48 -0800 | [diff] [blame] | 117 | return Tools.retryable(() -> complete(asyncMap.computeIf(key, condition, remappingFunction)), |
| 118 | ConcurrentModification.class, |
| 119 | Integer.MAX_VALUE, |
Aaron Kruglikov | 2f2e81e | 2016-12-01 15:39:06 -0800 | [diff] [blame] | 120 | MAX_DELAY_BETWEEN_RETRY_MILLS).get(); |
Madan Jampani | 346d4f5 | 2015-05-04 11:09:39 -0700 | [diff] [blame] | 121 | } |
| 122 | |
| 123 | @Override |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 124 | public Versioned<V> put(K key, V value) { |
| 125 | return complete(asyncMap.put(key, value)); |
| 126 | } |
| 127 | |
| 128 | @Override |
Madan Jampani | 346d4f5 | 2015-05-04 11:09:39 -0700 | [diff] [blame] | 129 | public Versioned<V> putAndGet(K key, V value) { |
| 130 | return complete(asyncMap.putAndGet(key, value)); |
| 131 | } |
| 132 | |
| 133 | @Override |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 134 | public Versioned<V> remove(K key) { |
| 135 | return complete(asyncMap.remove(key)); |
| 136 | } |
| 137 | |
| 138 | @Override |
| 139 | public void clear() { |
| 140 | complete(asyncMap.clear()); |
| 141 | } |
| 142 | |
| 143 | @Override |
| 144 | public Set<K> keySet() { |
| 145 | return complete(asyncMap.keySet()); |
| 146 | } |
| 147 | |
| 148 | @Override |
| 149 | public Collection<Versioned<V>> values() { |
| 150 | return complete(asyncMap.values()); |
| 151 | } |
| 152 | |
| 153 | @Override |
| 154 | public Set<Entry<K, Versioned<V>>> entrySet() { |
| 155 | return complete(asyncMap.entrySet()); |
| 156 | } |
| 157 | |
| 158 | @Override |
| 159 | public Versioned<V> putIfAbsent(K key, V value) { |
| 160 | return complete(asyncMap.putIfAbsent(key, value)); |
| 161 | } |
| 162 | |
| 163 | @Override |
| 164 | public boolean remove(K key, V value) { |
| 165 | return complete(asyncMap.remove(key, value)); |
| 166 | } |
| 167 | |
| 168 | @Override |
| 169 | public boolean remove(K key, long version) { |
| 170 | return complete(asyncMap.remove(key, version)); |
| 171 | } |
| 172 | |
| 173 | @Override |
Jihwan Kim | 9887ad9 | 2015-12-12 00:23:57 +0900 | [diff] [blame] | 174 | public Versioned<V> replace(K key, V value) { |
| 175 | return complete(asyncMap.replace(key, value)); |
| 176 | } |
| 177 | |
| 178 | @Override |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 179 | public boolean replace(K key, V oldValue, V newValue) { |
| 180 | return complete(asyncMap.replace(key, oldValue, newValue)); |
| 181 | } |
| 182 | |
| 183 | @Override |
| 184 | public boolean replace(K key, long oldVersion, V newValue) { |
| 185 | return complete(asyncMap.replace(key, oldVersion, newValue)); |
| 186 | } |
| 187 | |
Madan Jampani | fa24218 | 2016-01-22 13:42:54 -0800 | [diff] [blame] | 188 | @Override |
Jordan Halterman | dae1160 | 2018-07-03 00:00:47 -0700 | [diff] [blame] | 189 | public Iterator<Entry<K, Versioned<V>>> iterator() { |
| 190 | return new DefaultIterator<>(complete(asyncMap.iterator())); |
| 191 | } |
| 192 | |
| 193 | @Override |
Madan Jampani | 0463cf9 | 2016-05-04 14:46:08 -0700 | [diff] [blame] | 194 | public void addListener(MapEventListener<K, V> listener, Executor executor) { |
| 195 | complete(asyncMap.addListener(listener, executor)); |
Madan Jampani | fa24218 | 2016-01-22 13:42:54 -0800 | [diff] [blame] | 196 | } |
| 197 | |
| 198 | @Override |
| 199 | public void removeListener(MapEventListener<K, V> listener) { |
Hyunsun Moon | 65b38cb | 2016-05-06 18:27:37 -0700 | [diff] [blame] | 200 | complete(asyncMap.removeListener(listener)); |
Madan Jampani | fa24218 | 2016-01-22 13:42:54 -0800 | [diff] [blame] | 201 | } |
| 202 | |
| 203 | @Override |
Madan Jampani | 1d3b617 | 2016-04-28 13:22:57 -0700 | [diff] [blame] | 204 | public void addStatusChangeListener(Consumer<Status> listener) { |
| 205 | asyncMap.addStatusChangeListener(listener); |
| 206 | } |
| 207 | |
| 208 | @Override |
| 209 | public void removeStatusChangeListener(Consumer<Status> listener) { |
| 210 | asyncMap.removeStatusChangeListener(listener); |
| 211 | } |
| 212 | |
| 213 | @Override |
| 214 | public Collection<Consumer<Status>> statusChangeListeners() { |
| 215 | return asyncMap.statusChangeListeners(); |
| 216 | } |
| 217 | |
Jordan Halterman | dae1160 | 2018-07-03 00:00:47 -0700 | [diff] [blame] | 218 | private class DefaultIterator<K, V> implements Iterator<Entry<K, Versioned<V>>> { |
| 219 | private final AsyncIterator<Entry<K, Versioned<V>>> iterator; |
| 220 | |
| 221 | public DefaultIterator(AsyncIterator<Map.Entry<K, Versioned<V>>> iterator) { |
| 222 | this.iterator = iterator; |
| 223 | } |
| 224 | |
| 225 | @Override |
| 226 | public boolean hasNext() { |
| 227 | return complete(iterator.hasNext()); |
| 228 | } |
| 229 | |
| 230 | @Override |
| 231 | public Map.Entry<K, Versioned<V>> next() { |
| 232 | return complete(iterator.next()); |
| 233 | } |
| 234 | } |
| 235 | |
Madan Jampani | 1d3b617 | 2016-04-28 13:22:57 -0700 | [diff] [blame] | 236 | @Override |
Madan Jampani | fa24218 | 2016-01-22 13:42:54 -0800 | [diff] [blame] | 237 | public Map<K, V> asJavaMap() { |
| 238 | synchronized (this) { |
| 239 | if (javaMap == null) { |
| 240 | javaMap = new ConsistentMapBackedJavaMap<>(this); |
| 241 | } |
| 242 | } |
| 243 | return javaMap; |
| 244 | } |
| 245 | |
HIGUCHI Yuta | dc4394c | 2016-01-29 15:35:10 -0800 | [diff] [blame] | 246 | @Override |
| 247 | public String toString() { |
| 248 | return asJavaMap().toString(); |
| 249 | } |
| 250 | |
Madan Jampani | 28b2cd6 | 2016-02-02 10:49:52 -0800 | [diff] [blame] | 251 | private <T> T complete(CompletableFuture<T> future) { |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 252 | try { |
Madan Jampani | 28b2cd6 | 2016-02-02 10:49:52 -0800 | [diff] [blame] | 253 | return future.get(operationTimeoutMillis, TimeUnit.MILLISECONDS); |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 254 | } catch (InterruptedException e) { |
| 255 | Thread.currentThread().interrupt(); |
| 256 | throw new ConsistentMapException.Interrupted(); |
| 257 | } catch (TimeoutException e) { |
Madan Jampani | 4275587 | 2016-09-06 19:31:06 -0700 | [diff] [blame] | 258 | throw new ConsistentMapException.Timeout(name()); |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 259 | } catch (ExecutionException e) { |
Ray Milkey | 6a51cb9 | 2018-03-06 09:03:03 -0800 | [diff] [blame] | 260 | Throwables.throwIfUnchecked(e.getCause()); |
Madan Jampani | f6c973a | 2016-01-30 22:20:48 -0800 | [diff] [blame] | 261 | throw new ConsistentMapException(e.getCause()); |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 262 | } |
| 263 | } |
Madan Jampani | 7c52100 | 2015-03-23 12:23:01 -0700 | [diff] [blame] | 264 | } |