blob: 4f706294ad1b4c5d9d7ccd88eaed8a52dd8c388a [file] [log] [blame]
Jonathan Hartdb3af892015-01-26 13:19:07 -08001/*
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 */
Madan Jampanif4c88502016-01-21 12:35:36 -080016package org.onosproject.store.primitives.impl;
Jonathan Hartdb3af892015-01-26 13:19:07 -080017
Madan Jampanif4c88502016-01-21 12:35:36 -080018import static com.google.common.base.Preconditions.checkNotNull;
19import static com.google.common.base.Preconditions.checkState;
20import static java.util.concurrent.Executors.newSingleThreadScheduledExecutor;
21import static org.onlab.util.BoundedThreadPool.newFixedThreadPool;
22import static org.onlab.util.Tools.groupedThreads;
23import static org.onosproject.store.service.EventuallyConsistentMapEvent.Type.PUT;
24import static org.onosproject.store.service.EventuallyConsistentMapEvent.Type.REMOVE;
Jonathan Hartdb3af892015-01-26 13:19:07 -080025
Jonathan Hartdb3af892015-01-26 13:19:07 -080026import java.util.Collection;
Madan Jampani3d76c942015-06-29 23:37:10 -070027import java.util.Collections;
Jonathan Hartdb3af892015-01-26 13:19:07 -080028import java.util.List;
29import java.util.Map;
Madan Jampanid13f3b82015-07-01 17:37:50 -070030import java.util.Objects;
Madan Jampani43e9c9c2015-06-26 14:16:46 -070031import java.util.Optional;
Jonathan Hartdb3af892015-01-26 13:19:07 -080032import java.util.Set;
Brian O'Connoreeaea2c2015-03-05 16:24:34 -080033import java.util.Timer;
Madan Jampanifa242182016-01-22 13:42:54 -080034import java.util.concurrent.CompletableFuture;
Jonathan Hartdb3af892015-01-26 13:19:07 -080035import java.util.concurrent.ExecutorService;
36import java.util.concurrent.Executors;
37import java.util.concurrent.ScheduledExecutorService;
Thomas Vachuskaa132e3a2015-02-21 01:53:14 -080038import java.util.concurrent.TimeUnit;
Madan Jampani3d76c942015-06-29 23:37:10 -070039import java.util.concurrent.atomic.AtomicBoolean;
Madan Jampani43e9c9c2015-06-26 14:16:46 -070040import java.util.concurrent.atomic.AtomicReference;
Brian O'Connor5eb77c82015-03-02 18:09:39 -080041import java.util.function.BiFunction;
Jonathan Hartdb3af892015-01-26 13:19:07 -080042import java.util.stream.Collectors;
43
Madan Jampanif4c88502016-01-21 12:35:36 -080044import org.apache.commons.lang3.tuple.Pair;
45import org.onlab.util.AbstractAccumulator;
46import org.onlab.util.KryoNamespace;
47import org.onlab.util.SlidingWindowCounter;
48import org.onosproject.cluster.ClusterService;
49import org.onosproject.cluster.ControllerNode;
50import org.onosproject.cluster.NodeId;
51import org.onosproject.persistence.PersistenceService;
52import org.onosproject.store.LogicalTimestamp;
53import org.onosproject.store.Timestamp;
54import org.onosproject.store.cluster.messaging.ClusterCommunicationService;
55import org.onosproject.store.cluster.messaging.MessageSubject;
56import org.onosproject.store.serializers.KryoNamespaces;
57import org.onosproject.store.serializers.KryoSerializer;
58import org.onosproject.store.service.EventuallyConsistentMap;
59import org.onosproject.store.service.EventuallyConsistentMapEvent;
60import org.onosproject.store.service.EventuallyConsistentMapListener;
61import org.onosproject.store.service.Serializer;
62import org.onosproject.store.service.WallClockTimestamp;
63import org.slf4j.Logger;
64import org.slf4j.LoggerFactory;
65
66import com.google.common.collect.Collections2;
67import com.google.common.collect.ImmutableList;
68import com.google.common.collect.ImmutableMap;
69import com.google.common.collect.Lists;
70import com.google.common.collect.Maps;
71import com.google.common.collect.Sets;
Jonathan Hartdb3af892015-01-26 13:19:07 -080072
73/**
74 * Distributed Map implementation which uses optimistic replication and gossip
75 * based techniques to provide an eventually consistent data store.
76 */
77public class EventuallyConsistentMapImpl<K, V>
78 implements EventuallyConsistentMap<K, V> {
79
80 private static final Logger log = LoggerFactory.getLogger(EventuallyConsistentMapImpl.class);
81
Madan Jampani3d76c942015-06-29 23:37:10 -070082 private final Map<K, MapValue<V>> items;
Jonathan Hartdb3af892015-01-26 13:19:07 -080083
Jonathan Hartdb3af892015-01-26 13:19:07 -080084 private final ClusterService clusterService;
85 private final ClusterCommunicationService clusterCommunicator;
86 private final KryoSerializer serializer;
Madan Jampani3d76c942015-06-29 23:37:10 -070087 private final NodeId localNodeId;
Aaron Kruglikov66cf0b92015-10-26 15:46:54 -070088 private final PersistenceService persistenceService;
Jonathan Hartdb3af892015-01-26 13:19:07 -080089
Madan Jampanibcf1a482015-06-24 19:05:56 -070090 private final BiFunction<K, V, Timestamp> timestampProvider;
Jonathan Hartdb3af892015-01-26 13:19:07 -080091
92 private final MessageSubject updateMessageSubject;
Jonathan Hartaaa56572015-01-28 21:56:35 -080093 private final MessageSubject antiEntropyAdvertisementSubject;
Jonathan Hartdb3af892015-01-26 13:19:07 -080094
Jonathan Hartaaa56572015-01-28 21:56:35 -080095 private final Set<EventuallyConsistentMapListener<K, V>> listeners
Madan Jampani3d76c942015-06-29 23:37:10 -070096 = Sets.newCopyOnWriteArraySet();
Jonathan Hartdb3af892015-01-26 13:19:07 -080097
98 private final ExecutorService executor;
Jonathan Hartdb3af892015-01-26 13:19:07 -080099 private final ScheduledExecutorService backgroundExecutor;
Brian O'Connoreeaea2c2015-03-05 16:24:34 -0800100 private final BiFunction<K, V, Collection<NodeId>> peerUpdateFunction;
Jonathan Hartdb3af892015-01-26 13:19:07 -0800101
Jonathan Hart6ec029a2015-03-24 17:12:35 -0700102 private final ExecutorService communicationExecutor;
103 private final Map<NodeId, EventAccumulator> senderPending;
Madan Jampani28726282015-02-19 11:40:23 -0800104
Madan Jampani4f1f4cd2015-07-08 23:05:35 -0700105 private final String mapName;
106
Jonathan Hartdb3af892015-01-26 13:19:07 -0800107 private volatile boolean destroyed = false;
Jonathan Hart539a6462015-01-27 17:05:43 -0800108 private static final String ERROR_DESTROYED = " map is already destroyed";
Thomas Vachuskaa132e3a2015-02-21 01:53:14 -0800109 private final String destroyedMessage;
Jonathan Hartdb3af892015-01-26 13:19:07 -0800110
Jonathan Hart4f397e82015-02-04 09:10:41 -0800111 private static final String ERROR_NULL_KEY = "Key cannot be null";
112 private static final String ERROR_NULL_VALUE = "Null values are not allowed";
113
Jonathan Hart6ec029a2015-03-24 17:12:35 -0700114 private final long initialDelaySec = 5;
115 private final boolean lightweightAntiEntropy;
116 private final boolean tombstonesDisabled;
Jonathan Hartdb3af892015-01-26 13:19:07 -0800117
Jonathan Hart233a18a2015-03-02 17:24:58 -0800118 private static final int WINDOW_SIZE = 5;
119 private static final int HIGH_LOAD_THRESHOLD = 0;
120 private static final int LOAD_WINDOW = 2;
Jonathan Hart6ec029a2015-03-24 17:12:35 -0700121 private SlidingWindowCounter counter = new SlidingWindowCounter(WINDOW_SIZE);
Jonathan Hart233a18a2015-03-02 17:24:58 -0800122
Jonathan Hartca335e92015-03-05 10:34:32 -0800123 private final boolean persistent;
Aaron Kruglikov66cf0b92015-10-26 15:46:54 -0700124
125 private static final String PERSISTENT_LOCAL_MAP_NAME = "itemsMap";
126
Jonathan Hartca335e92015-03-05 10:34:32 -0800127
Jonathan Hartdb3af892015-01-26 13:19:07 -0800128 /**
129 * Creates a new eventually consistent map shared amongst multiple instances.
Thomas Vachuskaa132e3a2015-02-21 01:53:14 -0800130 * <p>
Jonathan Hart6ec029a2015-03-24 17:12:35 -0700131 * See {@link org.onosproject.store.service.EventuallyConsistentMapBuilder}
132 * for more description of the parameters expected by the map.
Thomas Vachuskaa132e3a2015-02-21 01:53:14 -0800133 * </p>
Jonathan Hartdb3af892015-01-26 13:19:07 -0800134 *
Jonathan Hart6ec029a2015-03-24 17:12:35 -0700135 * @param mapName a String identifier for the map.
136 * @param clusterService the cluster service
137 * @param clusterCommunicator the cluster communications service
138 * @param serializerBuilder a Kryo namespace builder that can serialize
139 * both K and V
Madan Jampanibcf1a482015-06-24 19:05:56 -0700140 * @param timestampProvider provider of timestamps for K and V
Jonathan Hart6ec029a2015-03-24 17:12:35 -0700141 * @param peerUpdateFunction function that provides a set of nodes to immediately
142 * update to when there writes to the map
143 * @param eventExecutor executor to use for processing incoming
144 * events from peers
145 * @param communicationExecutor executor to use for sending events to peers
146 * @param backgroundExecutor executor to use for background anti-entropy
147 * tasks
148 * @param tombstonesDisabled true if this map should not maintain
149 * tombstones
150 * @param antiEntropyPeriod period that the anti-entropy task should run
Jonathan Hartca335e92015-03-05 10:34:32 -0800151 * @param antiEntropyTimeUnit time unit for anti-entropy period
Jonathan Hart6ec029a2015-03-24 17:12:35 -0700152 * @param convergeFaster make anti-entropy try to converge faster
Jonathan Hartca335e92015-03-05 10:34:32 -0800153 * @param persistent persist data to disk
Jian Lidfba7392016-01-22 16:46:58 -0800154 * @param persistenceService persistence service
Jonathan Hartdb3af892015-01-26 13:19:07 -0800155 */
Jonathan Hart6ec029a2015-03-24 17:12:35 -0700156 EventuallyConsistentMapImpl(String mapName,
157 ClusterService clusterService,
158 ClusterCommunicationService clusterCommunicator,
159 KryoNamespace.Builder serializerBuilder,
Madan Jampanibcf1a482015-06-24 19:05:56 -0700160 BiFunction<K, V, Timestamp> timestampProvider,
Jonathan Hart6ec029a2015-03-24 17:12:35 -0700161 BiFunction<K, V, Collection<NodeId>> peerUpdateFunction,
162 ExecutorService eventExecutor,
163 ExecutorService communicationExecutor,
164 ScheduledExecutorService backgroundExecutor,
165 boolean tombstonesDisabled,
166 long antiEntropyPeriod,
167 TimeUnit antiEntropyTimeUnit,
Jonathan Hartca335e92015-03-05 10:34:32 -0800168 boolean convergeFaster,
Aaron Kruglikov66cf0b92015-10-26 15:46:54 -0700169 boolean persistent,
170 PersistenceService persistenceService) {
Madan Jampani4f1f4cd2015-07-08 23:05:35 -0700171 this.mapName = mapName;
Aaron Kruglikov66cf0b92015-10-26 15:46:54 -0700172 this.serializer = createSerializer(serializerBuilder);
173 this.persistenceService = persistenceService;
174 this.persistent =
175 persistent;
176 if (persistent) {
177 items = this.persistenceService.<K, MapValue<V>>persistentMapBuilder()
178 .withName(PERSISTENT_LOCAL_MAP_NAME)
179 .withSerializer(new Serializer() {
180
181 @Override
182 public <T> byte[] encode(T object) {
183 return EventuallyConsistentMapImpl.this.serializer.encode(object);
184 }
185
186 @Override
187 public <T> T decode(byte[] bytes) {
188 return EventuallyConsistentMapImpl.this.serializer.decode(bytes);
189 }
190 })
191 .build();
192 } else {
193 items = Maps.newConcurrentMap();
194 }
Brian O'Connoreeaea2c2015-03-05 16:24:34 -0800195 senderPending = Maps.newConcurrentMap();
Jonathan Hart6ec029a2015-03-24 17:12:35 -0700196 destroyedMessage = mapName + ERROR_DESTROYED;
Madan Jampani28726282015-02-19 11:40:23 -0800197
Jonathan Hart6ec029a2015-03-24 17:12:35 -0700198 this.clusterService = clusterService;
199 this.clusterCommunicator = clusterCommunicator;
Madan Jampani3d76c942015-06-29 23:37:10 -0700200 this.localNodeId = clusterService.getLocalNode().id();
Jonathan Hart6ec029a2015-03-24 17:12:35 -0700201
Madan Jampanibcf1a482015-06-24 19:05:56 -0700202 this.timestampProvider = timestampProvider;
Jonathan Hart6ec029a2015-03-24 17:12:35 -0700203
204 if (peerUpdateFunction != null) {
205 this.peerUpdateFunction = peerUpdateFunction;
206 } else {
207 this.peerUpdateFunction = (key, value) -> clusterService.getNodes().stream()
208 .map(ControllerNode::id)
Madan Jampani3d76c942015-06-29 23:37:10 -0700209 .filter(nodeId -> !nodeId.equals(localNodeId))
Jonathan Hart6ec029a2015-03-24 17:12:35 -0700210 .collect(Collectors.toList());
211 }
212
213 if (eventExecutor != null) {
214 this.executor = eventExecutor;
215 } else {
216 // should be a normal executor; it's used for receiving messages
217 this.executor =
218 Executors.newFixedThreadPool(8, groupedThreads("onos/ecm", mapName + "-fg-%d"));
219 }
220
221 if (communicationExecutor != null) {
222 this.communicationExecutor = communicationExecutor;
223 } else {
224 // sending executor; should be capped
225 //TODO this probably doesn't need to be bounded anymore
226 this.communicationExecutor =
227 newFixedThreadPool(8, groupedThreads("onos/ecm", mapName + "-publish-%d"));
228 }
229
Jonathan Hartca335e92015-03-05 10:34:32 -0800230
Jonathan Hart6ec029a2015-03-24 17:12:35 -0700231 if (backgroundExecutor != null) {
232 this.backgroundExecutor = backgroundExecutor;
233 } else {
234 this.backgroundExecutor =
235 newSingleThreadScheduledExecutor(groupedThreads("onos/ecm", mapName + "-bg-%d"));
236 }
Jonathan Hartdb3af892015-01-26 13:19:07 -0800237
Jonathan Hartaaa56572015-01-28 21:56:35 -0800238 // start anti-entropy thread
Madan Jampani3d76c942015-06-29 23:37:10 -0700239 this.backgroundExecutor.scheduleAtFixedRate(this::sendAdvertisement,
Jonathan Hart6ec029a2015-03-24 17:12:35 -0700240 initialDelaySec, antiEntropyPeriod,
241 antiEntropyTimeUnit);
Jonathan Hartaaa56572015-01-28 21:56:35 -0800242
Jonathan Hartdb3af892015-01-26 13:19:07 -0800243 updateMessageSubject = new MessageSubject("ecm-" + mapName + "-update");
244 clusterCommunicator.addSubscriber(updateMessageSubject,
Madan Jampani3d76c942015-06-29 23:37:10 -0700245 serializer::decode,
246 this::processUpdates,
247 this.executor);
Brian O'Connoreeaea2c2015-03-05 16:24:34 -0800248
Jonathan Hartaaa56572015-01-28 21:56:35 -0800249 antiEntropyAdvertisementSubject = new MessageSubject("ecm-" + mapName + "-anti-entropy");
250 clusterCommunicator.addSubscriber(antiEntropyAdvertisementSubject,
Madan Jampani3d76c942015-06-29 23:37:10 -0700251 serializer::decode,
252 this::handleAntiEntropyAdvertisement,
253 this.backgroundExecutor);
Jonathan Hartdb3af892015-01-26 13:19:07 -0800254
Jonathan Hart6ec029a2015-03-24 17:12:35 -0700255 this.tombstonesDisabled = tombstonesDisabled;
256 this.lightweightAntiEntropy = !convergeFaster;
Madan Jampanie1356282015-03-10 19:05:36 -0700257 }
258
Jonathan Hartdb3af892015-01-26 13:19:07 -0800259 private KryoSerializer createSerializer(KryoNamespace.Builder builder) {
260 return new KryoSerializer() {
261 @Override
262 protected void setupKryoPool() {
263 // Add the map's internal helper classes to the user-supplied serializer
264 serializerPool = builder
Madan Jampani3d76c942015-06-29 23:37:10 -0700265 .register(KryoNamespaces.BASIC)
Madan Jampanidb5d06a2015-06-30 11:16:48 -0700266 .nextId(KryoNamespaces.BEGIN_USER_CUSTOM_ID)
Madan Jampani3e033bd2015-04-08 13:03:49 -0700267 .register(LogicalTimestamp.class)
Jonathan Hartdb3af892015-01-26 13:19:07 -0800268 .register(WallClockTimestamp.class)
Jonathan Hartaaa56572015-01-28 21:56:35 -0800269 .register(AntiEntropyAdvertisement.class)
Madan Jampani3d76c942015-06-29 23:37:10 -0700270 .register(UpdateEntry.class)
271 .register(MapValue.class)
272 .register(MapValue.Digest.class)
Jonathan Hartdb3af892015-01-26 13:19:07 -0800273 .build();
Jonathan Hartdb3af892015-01-26 13:19:07 -0800274 }
275 };
276 }
277
278 @Override
Madan Jampania090a112016-01-18 16:38:17 -0800279 public String name() {
280 return mapName;
281 }
282
283 @Override
Jonathan Hartdb3af892015-01-26 13:19:07 -0800284 public int size() {
Thomas Vachuskaa132e3a2015-02-21 01:53:14 -0800285 checkState(!destroyed, destroyedMessage);
Madan Jampani3d76c942015-06-29 23:37:10 -0700286 // TODO: Maintain a separate counter for tracking live elements in map.
287 return Maps.filterValues(items, MapValue::isAlive).size();
Jonathan Hartdb3af892015-01-26 13:19:07 -0800288 }
289
290 @Override
291 public boolean isEmpty() {
Thomas Vachuskaa132e3a2015-02-21 01:53:14 -0800292 checkState(!destroyed, destroyedMessage);
Madan Jampani3d76c942015-06-29 23:37:10 -0700293 return size() == 0;
Jonathan Hartdb3af892015-01-26 13:19:07 -0800294 }
295
296 @Override
297 public boolean containsKey(K key) {
Thomas Vachuskaa132e3a2015-02-21 01:53:14 -0800298 checkState(!destroyed, destroyedMessage);
Jonathan Hart4f397e82015-02-04 09:10:41 -0800299 checkNotNull(key, ERROR_NULL_KEY);
Madan Jampani3d76c942015-06-29 23:37:10 -0700300 return get(key) != null;
Jonathan Hartdb3af892015-01-26 13:19:07 -0800301 }
302
303 @Override
304 public boolean containsValue(V value) {
Thomas Vachuskaa132e3a2015-02-21 01:53:14 -0800305 checkState(!destroyed, destroyedMessage);
Jonathan Hart4f397e82015-02-04 09:10:41 -0800306 checkNotNull(value, ERROR_NULL_VALUE);
Madan Jampani3d76c942015-06-29 23:37:10 -0700307 return items.values()
308 .stream()
309 .filter(MapValue::isAlive)
Madan Jampani4f1f4cd2015-07-08 23:05:35 -0700310 .anyMatch(v -> value.equals(v.get()));
Jonathan Hartdb3af892015-01-26 13:19:07 -0800311 }
312
313 @Override
314 public V get(K key) {
Thomas Vachuskaa132e3a2015-02-21 01:53:14 -0800315 checkState(!destroyed, destroyedMessage);
Jonathan Hart4f397e82015-02-04 09:10:41 -0800316 checkNotNull(key, ERROR_NULL_KEY);
Jonathan Hartdb3af892015-01-26 13:19:07 -0800317
Madan Jampani3d76c942015-06-29 23:37:10 -0700318 MapValue<V> value = items.get(key);
319 return (value == null || value.isTombstone()) ? null : value.get();
Jonathan Hartdb3af892015-01-26 13:19:07 -0800320 }
321
322 @Override
323 public void put(K key, V value) {
Thomas Vachuskaa132e3a2015-02-21 01:53:14 -0800324 checkState(!destroyed, destroyedMessage);
Jonathan Hart4f397e82015-02-04 09:10:41 -0800325 checkNotNull(key, ERROR_NULL_KEY);
326 checkNotNull(value, ERROR_NULL_VALUE);
Jonathan Hartdb3af892015-01-26 13:19:07 -0800327
Madan Jampani3d76c942015-06-29 23:37:10 -0700328 MapValue<V> newValue = new MapValue<>(value, timestampProvider.apply(key, value));
Madan Jampani4f1f4cd2015-07-08 23:05:35 -0700329 if (putInternal(key, newValue)) {
Madan Jampani3d76c942015-06-29 23:37:10 -0700330 notifyPeers(new UpdateEntry<>(key, newValue), peerUpdateFunction.apply(key, value));
Madan Jampanicab114c2015-07-23 00:14:19 -0700331 notifyListeners(new EventuallyConsistentMapEvent<>(mapName, PUT, key, value));
Jonathan Hartdb3af892015-01-26 13:19:07 -0800332 }
333 }
334
Jonathan Hartdb3af892015-01-26 13:19:07 -0800335 @Override
Madan Jampani43e9c9c2015-06-26 14:16:46 -0700336 public V remove(K key) {
Thomas Vachuskaa132e3a2015-02-21 01:53:14 -0800337 checkState(!destroyed, destroyedMessage);
Jonathan Hart4f397e82015-02-04 09:10:41 -0800338 checkNotNull(key, ERROR_NULL_KEY);
Madan Jampani4f1f4cd2015-07-08 23:05:35 -0700339 return removeAndNotify(key, null);
340 }
341
342 @Override
343 public void remove(K key, V value) {
344 checkState(!destroyed, destroyedMessage);
345 checkNotNull(key, ERROR_NULL_KEY);
346 checkNotNull(value, ERROR_NULL_VALUE);
347 removeAndNotify(key, value);
348 }
349
350 private V removeAndNotify(K key, V value) {
Madan Jampani483d0a22015-08-19 17:33:00 -0700351 Timestamp timestamp = timestampProvider.apply(key, value);
352 Optional<MapValue<V>> tombstone = tombstonesDisabled || timestamp == null
353 ? Optional.empty() : Optional.of(MapValue.tombstone(timestamp));
Madan Jampani4f1f4cd2015-07-08 23:05:35 -0700354 MapValue<V> previousValue = removeInternal(key, Optional.ofNullable(value), tombstone);
Madan Jampania0ac4872015-07-02 11:23:49 -0700355 if (previousValue != null) {
Madan Jampani483d0a22015-08-19 17:33:00 -0700356 notifyPeers(new UpdateEntry<>(key, tombstone.orElse(null)),
357 peerUpdateFunction.apply(key, previousValue.get()));
Madan Jampania0ac4872015-07-02 11:23:49 -0700358 if (previousValue.isAlive()) {
Madan Jampanicab114c2015-07-23 00:14:19 -0700359 notifyListeners(new EventuallyConsistentMapEvent<>(mapName, REMOVE, key, previousValue.get()));
Madan Jampania0ac4872015-07-02 11:23:49 -0700360 }
361 }
Madan Jampanid13f3b82015-07-01 17:37:50 -0700362 return previousValue != null ? previousValue.get() : null;
Jonathan Hartdb3af892015-01-26 13:19:07 -0800363 }
364
Madan Jampani483d0a22015-08-19 17:33:00 -0700365 private MapValue<V> removeInternal(K key, Optional<V> value, Optional<MapValue<V>> tombstone) {
Madan Jampani3d76c942015-06-29 23:37:10 -0700366 checkState(!destroyed, destroyedMessage);
367 checkNotNull(key, ERROR_NULL_KEY);
368 checkNotNull(value, ERROR_NULL_VALUE);
Madan Jampani483d0a22015-08-19 17:33:00 -0700369 tombstone.ifPresent(v -> checkState(v.isTombstone()));
Madan Jampani4f1f4cd2015-07-08 23:05:35 -0700370
371 counter.incrementCount();
Madan Jampani3d76c942015-06-29 23:37:10 -0700372 AtomicBoolean updated = new AtomicBoolean(false);
Madan Jampanid13f3b82015-07-01 17:37:50 -0700373 AtomicReference<MapValue<V>> previousValue = new AtomicReference<>();
Madan Jampani3d76c942015-06-29 23:37:10 -0700374 items.compute(key, (k, existing) -> {
Madan Jampanid13f3b82015-07-01 17:37:50 -0700375 boolean valueMatches = true;
376 if (value.isPresent() && existing != null && existing.isAlive()) {
377 valueMatches = Objects.equals(value.get(), existing.get());
Madan Jampani3d76c942015-06-29 23:37:10 -0700378 }
Brian O'Connor6325dad2015-07-07 15:36:29 -0700379 if (existing == null) {
Jonathan Hart4a29c592015-09-23 17:55:07 -0700380 log.trace("ECMap Remove: Existing value for key {} is already null", k);
Brian O'Connor6325dad2015-07-07 15:36:29 -0700381 }
Madan Jampani483d0a22015-08-19 17:33:00 -0700382 if (valueMatches) {
383 if (existing == null) {
384 updated.set(tombstone.isPresent());
385 } else {
386 updated.set(!tombstone.isPresent() || tombstone.get().isNewerThan(existing));
387 }
Madan Jampanid13f3b82015-07-01 17:37:50 -0700388 }
Madan Jampani4f1f4cd2015-07-08 23:05:35 -0700389 if (updated.get()) {
Madan Jampani483d0a22015-08-19 17:33:00 -0700390 previousValue.set(existing);
391 return tombstone.orElse(null);
Madan Jampani4f1f4cd2015-07-08 23:05:35 -0700392 } else {
393 return existing;
394 }
Madan Jampani3d76c942015-06-29 23:37:10 -0700395 });
Madan Jampanid13f3b82015-07-01 17:37:50 -0700396 return previousValue.get();
Jonathan Hart5ec32ba2015-02-05 13:33:58 -0800397 }
398
399 @Override
Madan Jampani4727a112015-07-16 12:12:58 -0700400 public V compute(K key, BiFunction<K, V, V> recomputeFunction) {
401 checkState(!destroyed, destroyedMessage);
402 checkNotNull(key, ERROR_NULL_KEY);
403 checkNotNull(recomputeFunction, "Recompute function cannot be null");
404
405 AtomicBoolean updated = new AtomicBoolean(false);
406 AtomicReference<MapValue<V>> previousValue = new AtomicReference<>();
407 MapValue<V> computedValue = items.compute(key, (k, mv) -> {
408 previousValue.set(mv);
409 V newRawValue = recomputeFunction.apply(key, mv == null ? null : mv.get());
410 MapValue<V> newValue = new MapValue<>(newRawValue, timestampProvider.apply(key, newRawValue));
411 if (mv == null || newValue.isNewerThan(mv)) {
412 updated.set(true);
413 return newValue;
414 } else {
415 return mv;
416 }
417 });
418 if (updated.get()) {
419 notifyPeers(new UpdateEntry<>(key, computedValue), peerUpdateFunction.apply(key, computedValue.get()));
420 EventuallyConsistentMapEvent.Type updateType = computedValue.isTombstone() ? REMOVE : PUT;
421 V value = computedValue.isTombstone()
422 ? previousValue.get() == null ? null : previousValue.get().get()
423 : computedValue.get();
424 if (value != null) {
Madan Jampanicab114c2015-07-23 00:14:19 -0700425 notifyListeners(new EventuallyConsistentMapEvent<>(mapName, updateType, key, value));
Madan Jampani4727a112015-07-16 12:12:58 -0700426 }
427 }
428 return computedValue.get();
429 }
430
431 @Override
Jonathan Hartdb3af892015-01-26 13:19:07 -0800432 public void putAll(Map<? extends K, ? extends V> m) {
Thomas Vachuskaa132e3a2015-02-21 01:53:14 -0800433 checkState(!destroyed, destroyedMessage);
Brian O'Connoreeaea2c2015-03-05 16:24:34 -0800434 m.forEach(this::put);
Jonathan Hartdb3af892015-01-26 13:19:07 -0800435 }
436
437 @Override
438 public void clear() {
Thomas Vachuskaa132e3a2015-02-21 01:53:14 -0800439 checkState(!destroyed, destroyedMessage);
Madan Jampani3d76c942015-06-29 23:37:10 -0700440 Maps.filterValues(items, MapValue::isAlive)
441 .forEach((k, v) -> remove(k));
Jonathan Hartdb3af892015-01-26 13:19:07 -0800442 }
443
444 @Override
445 public Set<K> keySet() {
Thomas Vachuskaa132e3a2015-02-21 01:53:14 -0800446 checkState(!destroyed, destroyedMessage);
Madan Jampani3d76c942015-06-29 23:37:10 -0700447 return Maps.filterValues(items, MapValue::isAlive)
448 .keySet();
Jonathan Hartdb3af892015-01-26 13:19:07 -0800449 }
450
451 @Override
452 public Collection<V> values() {
Thomas Vachuskaa132e3a2015-02-21 01:53:14 -0800453 checkState(!destroyed, destroyedMessage);
Madan Jampani4f1f4cd2015-07-08 23:05:35 -0700454 return Collections2.transform(Maps.filterValues(items, MapValue::isAlive).values(), MapValue::get);
Jonathan Hartdb3af892015-01-26 13:19:07 -0800455 }
456
457 @Override
458 public Set<Map.Entry<K, V>> entrySet() {
Thomas Vachuskaa132e3a2015-02-21 01:53:14 -0800459 checkState(!destroyed, destroyedMessage);
Madan Jampani3d76c942015-06-29 23:37:10 -0700460 return Maps.filterValues(items, MapValue::isAlive)
461 .entrySet()
462 .stream()
463 .map(e -> Pair.of(e.getKey(), e.getValue().get()))
464 .collect(Collectors.toSet());
465 }
Jonathan Hartdb3af892015-01-26 13:19:07 -0800466
Madan Jampani3d76c942015-06-29 23:37:10 -0700467 /**
468 * Returns true if newValue was accepted i.e. map is updated.
Aaron Kruglikov66cf0b92015-10-26 15:46:54 -0700469 *
Madan Jampani3d76c942015-06-29 23:37:10 -0700470 * @param key key
471 * @param newValue proposed new value
472 * @return true if update happened; false if map already contains a more recent value for the key
473 */
Madan Jampani4f1f4cd2015-07-08 23:05:35 -0700474 private boolean putInternal(K key, MapValue<V> newValue) {
475 checkState(!destroyed, destroyedMessage);
476 checkNotNull(key, ERROR_NULL_KEY);
477 checkNotNull(newValue, ERROR_NULL_VALUE);
478 checkState(newValue.isAlive());
479 counter.incrementCount();
Madan Jampani3d76c942015-06-29 23:37:10 -0700480 AtomicBoolean updated = new AtomicBoolean(false);
481 items.compute(key, (k, existing) -> {
482 if (existing == null || newValue.isNewerThan(existing)) {
483 updated.set(true);
Madan Jampani3d76c942015-06-29 23:37:10 -0700484 return newValue;
485 }
486 return existing;
487 });
Madan Jampani3d76c942015-06-29 23:37:10 -0700488 return updated.get();
Jonathan Hartdb3af892015-01-26 13:19:07 -0800489 }
490
491 @Override
Jonathan Hart539a6462015-01-27 17:05:43 -0800492 public void addListener(EventuallyConsistentMapListener<K, V> listener) {
Thomas Vachuskaa132e3a2015-02-21 01:53:14 -0800493 checkState(!destroyed, destroyedMessage);
Jonathan Hartdb3af892015-01-26 13:19:07 -0800494
495 listeners.add(checkNotNull(listener));
496 }
497
498 @Override
Jonathan Hart539a6462015-01-27 17:05:43 -0800499 public void removeListener(EventuallyConsistentMapListener<K, V> listener) {
Thomas Vachuskaa132e3a2015-02-21 01:53:14 -0800500 checkState(!destroyed, destroyedMessage);
Jonathan Hartdb3af892015-01-26 13:19:07 -0800501
502 listeners.remove(checkNotNull(listener));
503 }
504
505 @Override
Madan Jampanifa242182016-01-22 13:42:54 -0800506 public CompletableFuture<Void> destroy() {
Jonathan Hartdb3af892015-01-26 13:19:07 -0800507 destroyed = true;
508
509 executor.shutdown();
510 backgroundExecutor.shutdown();
Brian O'Connoreeaea2c2015-03-05 16:24:34 -0800511 communicationExecutor.shutdown();
Jonathan Hartdb3af892015-01-26 13:19:07 -0800512
Jonathan Hart584d2f32015-01-27 19:46:14 -0800513 listeners.clear();
514
Jonathan Hartdb3af892015-01-26 13:19:07 -0800515 clusterCommunicator.removeSubscriber(updateMessageSubject);
Jonathan Hart584d2f32015-01-27 19:46:14 -0800516 clusterCommunicator.removeSubscriber(antiEntropyAdvertisementSubject);
Madan Jampanifa242182016-01-22 13:42:54 -0800517 return CompletableFuture.completedFuture(null);
Jonathan Hartdb3af892015-01-26 13:19:07 -0800518 }
519
Jonathan Hartaaa56572015-01-28 21:56:35 -0800520 private void notifyListeners(EventuallyConsistentMapEvent<K, V> event) {
Madan Jampani3d76c942015-06-29 23:37:10 -0700521 listeners.forEach(listener -> listener.event(event));
Jonathan Hartdb3af892015-01-26 13:19:07 -0800522 }
523
Madan Jampani3d76c942015-06-29 23:37:10 -0700524 private void notifyPeers(UpdateEntry<K, V> event, Collection<NodeId> peers) {
Brian O'Connoreeaea2c2015-03-05 16:24:34 -0800525 queueUpdate(event, peers);
Jonathan Hartdb3af892015-01-26 13:19:07 -0800526 }
527
Madan Jampani3d76c942015-06-29 23:37:10 -0700528 private void queueUpdate(UpdateEntry<K, V> event, Collection<NodeId> peers) {
Brian O'Connoreeaea2c2015-03-05 16:24:34 -0800529 if (peers == null) {
530 // we have no friends :(
531 return;
532 }
533 peers.forEach(node ->
Jonathan Hart9a426f82015-09-03 15:43:13 +0200534 senderPending.computeIfAbsent(node, unusedKey -> new EventAccumulator(node)).add(event)
Brian O'Connoreeaea2c2015-03-05 16:24:34 -0800535 );
536 }
537
Jonathan Hart233a18a2015-03-02 17:24:58 -0800538 private boolean underHighLoad() {
539 return counter.get(LOAD_WINDOW) > HIGH_LOAD_THRESHOLD;
540 }
541
Madan Jampani3d76c942015-06-29 23:37:10 -0700542 private void sendAdvertisement() {
543 try {
Thomas Vachuska152f9fd2015-04-02 16:28:13 -0700544 if (underHighLoad() || destroyed) {
Jonathan Hart233a18a2015-03-02 17:24:58 -0800545 return;
546 }
Madan Jampani3d76c942015-06-29 23:37:10 -0700547 pickRandomActivePeer().ifPresent(this::sendAdvertisementToPeer);
548 } catch (Exception e) {
549 // Catch all exceptions to avoid scheduled task being suppressed.
550 log.error("Exception thrown while sending advertisement", e);
Jonathan Hartaaa56572015-01-28 21:56:35 -0800551 }
552 }
553
Madan Jampani3d76c942015-06-29 23:37:10 -0700554 private Optional<NodeId> pickRandomActivePeer() {
555 List<NodeId> activePeers = clusterService.getNodes()
556 .stream()
Madan Jampani4f1f4cd2015-07-08 23:05:35 -0700557 .map(ControllerNode::id)
558 .filter(id -> !localNodeId.equals(id))
Thomas Vachuska7a8de842016-03-07 20:56:35 -0800559 .filter(id -> clusterService.getState(id).isActive())
Madan Jampani3d76c942015-06-29 23:37:10 -0700560 .collect(Collectors.toList());
561 Collections.shuffle(activePeers);
562 return activePeers.isEmpty() ? Optional.empty() : Optional.of(activePeers.get(0));
563 }
564
565 private void sendAdvertisementToPeer(NodeId peer) {
566 clusterCommunicator.unicast(createAdvertisement(),
567 antiEntropyAdvertisementSubject,
568 serializer::encode,
569 peer)
570 .whenComplete((result, error) -> {
571 if (error != null) {
Madan Jampania0ac4872015-07-02 11:23:49 -0700572 log.debug("Failed to send anti-entropy advertisement to {}", peer, error);
Madan Jampani3d76c942015-06-29 23:37:10 -0700573 }
574 });
575 }
576
Jonathan Hartaaa56572015-01-28 21:56:35 -0800577 private AntiEntropyAdvertisement<K> createAdvertisement() {
Madan Jampani4f1f4cd2015-07-08 23:05:35 -0700578 return new AntiEntropyAdvertisement<K>(localNodeId,
579 ImmutableMap.copyOf(Maps.transformValues(items, MapValue::digest)));
Jonathan Hartaaa56572015-01-28 21:56:35 -0800580 }
581
582 private void handleAntiEntropyAdvertisement(AntiEntropyAdvertisement<K> ad) {
Madan Jampani3d76c942015-06-29 23:37:10 -0700583 if (destroyed || underHighLoad()) {
584 return;
585 }
586 try {
Jonathan Hart9a426f82015-09-03 15:43:13 +0200587 if (log.isTraceEnabled()) {
588 log.trace("Received anti-entropy advertisement from {} for {} with {} entries in it",
589 mapName, ad.sender(), ad.digest().size());
590 }
Madan Jampani3d76c942015-06-29 23:37:10 -0700591 antiEntropyCheckLocalItems(ad).forEach(this::notifyListeners);
Jonathan Hartaaa56572015-01-28 21:56:35 -0800592
Madan Jampani3d76c942015-06-29 23:37:10 -0700593 if (!lightweightAntiEntropy) {
Madan Jampani4f1f4cd2015-07-08 23:05:35 -0700594 // if remote ad has any entries that the local copy is missing, actively sync
595 // TODO: Missing keys is not the way local copy can be behind.
596 if (Sets.difference(ad.digest().keySet(), items.keySet()).size() > 0) {
Madan Jampani3d76c942015-06-29 23:37:10 -0700597 // TODO: Send ad for missing keys and for entries that are stale
598 sendAdvertisementToPeer(ad.sender());
Jonathan Hartf893be82015-02-24 17:35:51 -0800599 }
Jonathan Hartaaa56572015-01-28 21:56:35 -0800600 }
Madan Jampani3d76c942015-06-29 23:37:10 -0700601 } catch (Exception e) {
602 log.warn("Error handling anti-entropy advertisement", e);
HIGUCHI Yuta00c3f572015-02-25 07:33:50 -0800603 }
Jonathan Hartaaa56572015-01-28 21:56:35 -0800604 }
605
606 /**
Madan Jampani3d76c942015-06-29 23:37:10 -0700607 * Processes anti-entropy ad from peer by taking following actions:
608 * 1. If peer has an old entry, updates peer.
609 * 2. If peer indicates an entry is removed and has a more recent
610 * timestamp than the local entry, update local state.
Jonathan Hartaaa56572015-01-28 21:56:35 -0800611 */
Jonathan Hartaaa56572015-01-28 21:56:35 -0800612 private List<EventuallyConsistentMapEvent<K, V>> antiEntropyCheckLocalItems(
613 AntiEntropyAdvertisement<K> ad) {
Madan Jampani3d76c942015-06-29 23:37:10 -0700614 final List<EventuallyConsistentMapEvent<K, V>> externalEvents = Lists.newLinkedList();
Jonathan Hartaaa56572015-01-28 21:56:35 -0800615 final NodeId sender = ad.sender();
Madan Jampani3d76c942015-06-29 23:37:10 -0700616 items.forEach((key, localValue) -> {
617 MapValue.Digest remoteValueDigest = ad.digest().get(key);
618 if (remoteValueDigest == null || localValue.isNewerThan(remoteValueDigest.timestamp())) {
Jonathan Hartaaa56572015-01-28 21:56:35 -0800619 // local value is more recent, push to sender
Madan Jampani3d76c942015-06-29 23:37:10 -0700620 queueUpdate(new UpdateEntry<>(key, localValue), ImmutableList.of(sender));
Madan Jampanid13f3b82015-07-01 17:37:50 -0700621 }
Madan Jampani4f1f4cd2015-07-08 23:05:35 -0700622 if (remoteValueDigest != null
623 && remoteValueDigest.isNewerThan(localValue.digest())
624 && remoteValueDigest.isTombstone()) {
Madan Jampani483d0a22015-08-19 17:33:00 -0700625 MapValue<V> tombstone = MapValue.tombstone(remoteValueDigest.timestamp());
Madan Jampanid13f3b82015-07-01 17:37:50 -0700626 MapValue<V> previousValue = removeInternal(key,
627 Optional.empty(),
Madan Jampani483d0a22015-08-19 17:33:00 -0700628 Optional.of(tombstone));
Madan Jampanid13f3b82015-07-01 17:37:50 -0700629 if (previousValue != null && previousValue.isAlive()) {
Madan Jampanicab114c2015-07-23 00:14:19 -0700630 externalEvents.add(new EventuallyConsistentMapEvent<>(mapName, REMOVE, key, previousValue.get()));
Jonathan Hartaaa56572015-01-28 21:56:35 -0800631 }
632 }
Madan Jampani3d76c942015-06-29 23:37:10 -0700633 });
Jonathan Hartaaa56572015-01-28 21:56:35 -0800634 return externalEvents;
635 }
636
Madan Jampani3d76c942015-06-29 23:37:10 -0700637 private void processUpdates(Collection<UpdateEntry<K, V>> updates) {
638 if (destroyed) {
639 return;
Jonathan Hartaaa56572015-01-28 21:56:35 -0800640 }
Madan Jampani3d76c942015-06-29 23:37:10 -0700641 updates.forEach(update -> {
642 final K key = update.key();
643 final MapValue<V> value = update.value();
Madan Jampani483d0a22015-08-19 17:33:00 -0700644 if (value == null || value.isTombstone()) {
645 MapValue<V> previousValue = removeInternal(key, Optional.empty(), Optional.ofNullable(value));
Madan Jampani4f1f4cd2015-07-08 23:05:35 -0700646 if (previousValue != null && previousValue.isAlive()) {
Madan Jampanicab114c2015-07-23 00:14:19 -0700647 notifyListeners(new EventuallyConsistentMapEvent<>(mapName, REMOVE, key, previousValue.get()));
Madan Jampanid13f3b82015-07-01 17:37:50 -0700648 }
Madan Jampani4f1f4cd2015-07-08 23:05:35 -0700649 } else if (putInternal(key, value)) {
Madan Jampanicab114c2015-07-23 00:14:19 -0700650 notifyListeners(new EventuallyConsistentMapEvent<>(mapName, PUT, key, value.get()));
Jonathan Hartaaa56572015-01-28 21:56:35 -0800651 }
Madan Jampani3d76c942015-06-29 23:37:10 -0700652 });
Jonathan Hartdb3af892015-01-26 13:19:07 -0800653 }
654
Brian O'Connoreeaea2c2015-03-05 16:24:34 -0800655 // TODO pull this into the class if this gets pulled out...
656 private static final int DEFAULT_MAX_EVENTS = 1000;
657 private static final int DEFAULT_MAX_IDLE_MS = 10;
658 private static final int DEFAULT_MAX_BATCH_MS = 50;
659 private static final Timer TIMER = new Timer("onos-ecm-sender-events");
Jonathan Hartdb3af892015-01-26 13:19:07 -0800660
Madan Jampani3d76c942015-06-29 23:37:10 -0700661 private final class EventAccumulator extends AbstractAccumulator<UpdateEntry<K, V>> {
Brian O'Connoreeaea2c2015-03-05 16:24:34 -0800662
663 private final NodeId peer;
664
665 private EventAccumulator(NodeId peer) {
666 super(TIMER, DEFAULT_MAX_EVENTS, DEFAULT_MAX_BATCH_MS, DEFAULT_MAX_IDLE_MS);
667 this.peer = peer;
668 }
669
670 @Override
Madan Jampani3d76c942015-06-29 23:37:10 -0700671 public void processItems(List<UpdateEntry<K, V>> items) {
672 Map<K, UpdateEntry<K, V>> map = Maps.newHashMap();
673 items.forEach(item -> map.compute(item.key(), (key, existing) ->
Madan Jampani92c64eb2015-07-23 15:37:07 -0700674 item.isNewerThan(existing) ? item : existing));
Brian O'Connoreeaea2c2015-03-05 16:24:34 -0800675 communicationExecutor.submit(() -> {
Madan Jampani3d76c942015-06-29 23:37:10 -0700676 clusterCommunicator.unicast(ImmutableList.copyOf(map.values()),
Madan Jampani175e8fd2015-05-20 14:10:45 -0700677 updateMessageSubject,
678 serializer::encode,
679 peer)
680 .whenComplete((result, error) -> {
681 if (error != null) {
Madan Jampani3d76c942015-06-29 23:37:10 -0700682 log.debug("Failed to send to {}", peer, error);
Madan Jampani175e8fd2015-05-20 14:10:45 -0700683 }
684 });
Brian O'Connoreeaea2c2015-03-05 16:24:34 -0800685 });
Jonathan Hartdb3af892015-01-26 13:19:07 -0800686 }
687 }
Jonathan Hart4a29c592015-09-23 17:55:07 -0700688}