Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -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 | */ |
| 16 | package org.onosproject.store.intent.impl; |
| 17 | |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 18 | import com.google.common.collect.ImmutableList; |
Brian O'Connor | 4964d3d | 2015-03-12 20:38:10 -0700 | [diff] [blame] | 19 | import org.apache.commons.lang.math.RandomUtils; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 20 | import org.apache.felix.scr.annotations.Activate; |
| 21 | import org.apache.felix.scr.annotations.Component; |
| 22 | import org.apache.felix.scr.annotations.Deactivate; |
Aaron Kruglikov | 3721041 | 2016-12-06 12:55:57 -0800 | [diff] [blame] | 23 | import org.apache.felix.scr.annotations.Modified; |
| 24 | import org.apache.felix.scr.annotations.Property; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 25 | import org.apache.felix.scr.annotations.Reference; |
| 26 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 27 | import org.apache.felix.scr.annotations.Service; |
Yuta HIGUCHI | 4f8a377 | 2017-05-16 20:23:49 -0700 | [diff] [blame] | 28 | import org.onlab.util.Backtrace; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 29 | import org.onlab.util.KryoNamespace; |
Aaron Kruglikov | 3721041 | 2016-12-06 12:55:57 -0800 | [diff] [blame] | 30 | import org.onosproject.cfg.ComponentConfigService; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 31 | import org.onosproject.cluster.ClusterService; |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 32 | import org.onosproject.cluster.ControllerNode; |
| 33 | import org.onosproject.cluster.NodeId; |
Brian Stanke | 11f6d53 | 2016-07-05 16:17:59 -0400 | [diff] [blame] | 34 | import org.onosproject.incubator.net.virtual.NetworkId; |
| 35 | import org.onosproject.incubator.net.virtual.VirtualNetworkIntent; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 36 | import org.onosproject.net.intent.Intent; |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 37 | import org.onosproject.net.intent.IntentData; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 38 | import org.onosproject.net.intent.IntentEvent; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 39 | import org.onosproject.net.intent.IntentState; |
| 40 | import org.onosproject.net.intent.IntentStore; |
| 41 | import org.onosproject.net.intent.IntentStoreDelegate; |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 42 | import org.onosproject.net.intent.Key; |
Pier Ventre | 6582808 | 2017-01-04 10:15:00 -0800 | [diff] [blame] | 43 | import org.onosproject.net.intent.WorkPartitionService; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 44 | import org.onosproject.store.AbstractStore; |
Yuta HIGUCHI | 4f8a377 | 2017-05-16 20:23:49 -0700 | [diff] [blame] | 45 | import org.onosproject.store.Timestamp; |
Jonathan Hart | 539a646 | 2015-01-27 17:05:43 -0800 | [diff] [blame] | 46 | import org.onosproject.store.serializers.KryoNamespaces; |
Jonathan Hart | 6ec029a | 2015-03-24 17:12:35 -0700 | [diff] [blame] | 47 | import org.onosproject.store.service.EventuallyConsistentMap; |
Aaron Kruglikov | 3721041 | 2016-12-06 12:55:57 -0800 | [diff] [blame] | 48 | import org.onosproject.store.service.EventuallyConsistentMapBuilder; |
Jonathan Hart | 6ec029a | 2015-03-24 17:12:35 -0700 | [diff] [blame] | 49 | import org.onosproject.store.service.EventuallyConsistentMapEvent; |
| 50 | import org.onosproject.store.service.EventuallyConsistentMapListener; |
Brian Stanke | 2617dac | 2016-05-03 16:15:44 -0400 | [diff] [blame] | 51 | import org.onosproject.store.service.MultiValuedTimestamp; |
Jonathan Hart | 6ec029a | 2015-03-24 17:12:35 -0700 | [diff] [blame] | 52 | import org.onosproject.store.service.StorageService; |
Brian Stanke | 2617dac | 2016-05-03 16:15:44 -0400 | [diff] [blame] | 53 | import org.onosproject.store.service.WallClockTimestamp; |
Aaron Kruglikov | 3721041 | 2016-12-06 12:55:57 -0800 | [diff] [blame] | 54 | import org.osgi.service.component.ComponentContext; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 55 | import org.slf4j.Logger; |
| 56 | |
Brian O'Connor | 9081c90 | 2015-03-05 16:26:25 -0800 | [diff] [blame] | 57 | import java.util.Collection; |
Aaron Kruglikov | 3721041 | 2016-12-06 12:55:57 -0800 | [diff] [blame] | 58 | import java.util.Dictionary; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 59 | import java.util.List; |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 60 | import java.util.Objects; |
Yuta HIGUCHI | 4f8a377 | 2017-05-16 20:23:49 -0700 | [diff] [blame] | 61 | import java.util.Optional; |
Aaron Kruglikov | 3721041 | 2016-12-06 12:55:57 -0800 | [diff] [blame] | 62 | import java.util.Properties; |
Madan Jampani | bcf1a48 | 2015-06-24 19:05:56 -0700 | [diff] [blame] | 63 | import java.util.concurrent.atomic.AtomicLong; |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 64 | import java.util.stream.Collectors; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 65 | |
Jonathan Hart | 0d18df3 | 2015-03-21 08:42:59 -0700 | [diff] [blame] | 66 | import static com.google.common.base.Preconditions.checkNotNull; |
Aaron Kruglikov | 3721041 | 2016-12-06 12:55:57 -0800 | [diff] [blame] | 67 | import static com.google.common.base.Strings.isNullOrEmpty; |
| 68 | import static org.onlab.util.Tools.get; |
Jonathan Hart | 6ec029a | 2015-03-24 17:12:35 -0700 | [diff] [blame] | 69 | import static org.onosproject.net.intent.IntentState.PURGE_REQ; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 70 | import static org.slf4j.LoggerFactory.getLogger; |
| 71 | |
| 72 | /** |
| 73 | * Manages inventory of Intents in a distributed data store that uses optimistic |
| 74 | * replication and gossip based techniques. |
| 75 | */ |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 76 | //FIXME we should listen for leadership changes. if the local instance has just |
| 77 | // ... become a leader, scan the pending map and process those |
Sho SHIMIZU | 5c396e3 | 2016-08-12 15:19:12 -0700 | [diff] [blame] | 78 | @Component(immediate = true) |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 79 | @Service |
| 80 | public class GossipIntentStore |
| 81 | extends AbstractStore<IntentEvent, IntentStoreDelegate> |
| 82 | implements IntentStore { |
| 83 | |
| 84 | private final Logger log = getLogger(getClass()); |
| 85 | |
Aaron Kruglikov | 3721041 | 2016-12-06 12:55:57 -0800 | [diff] [blame] | 86 | private static final boolean PERSIST = false; |
| 87 | |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 88 | // Map of intent key => current intent state |
Brian O'Connor | 645bf20 | 2015-02-24 12:00:58 -0800 | [diff] [blame] | 89 | private EventuallyConsistentMap<Key, IntentData> currentMap; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 90 | |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 91 | // Map of intent key => pending intent operation |
Brian O'Connor | 645bf20 | 2015-02-24 12:00:58 -0800 | [diff] [blame] | 92 | private EventuallyConsistentMap<Key, IntentData> pendingMap; |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 93 | |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 94 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Aaron Kruglikov | 3721041 | 2016-12-06 12:55:57 -0800 | [diff] [blame] | 95 | protected ComponentConfigService configService; |
| 96 | |
| 97 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jonathan Hart | 6ec029a | 2015-03-24 17:12:35 -0700 | [diff] [blame] | 98 | protected ClusterService clusterService; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 99 | |
| 100 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jonathan Hart | 6ec029a | 2015-03-24 17:12:35 -0700 | [diff] [blame] | 101 | protected StorageService storageService; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 102 | |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 103 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Madan Jampani | 3b8101a | 2016-09-15 13:22:01 -0700 | [diff] [blame] | 104 | protected WorkPartitionService partitionService; |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 105 | |
Madan Jampani | bcf1a48 | 2015-06-24 19:05:56 -0700 | [diff] [blame] | 106 | private final AtomicLong sequenceNumber = new AtomicLong(0); |
| 107 | |
Frank Wang | e0eb5ce | 2016-07-01 18:21:25 +0800 | [diff] [blame] | 108 | private EventuallyConsistentMapListener<Key, IntentData> |
| 109 | mapCurrentListener = new InternalCurrentListener(); |
| 110 | |
| 111 | private EventuallyConsistentMapListener<Key, IntentData> |
| 112 | mapPendingListener = new InternalPendingListener(); |
| 113 | |
Aaron Kruglikov | 3721041 | 2016-12-06 12:55:57 -0800 | [diff] [blame] | 114 | //Denotes the initial persistence value for this structure |
| 115 | private boolean initiallyPersistent = false; |
| 116 | |
| 117 | //TODO this is currently an experimental feature used for performance |
| 118 | // evalutaion, enabling persistence with persist the intents but they will |
| 119 | // not be reinstalled and network state will not be consistent with the |
| 120 | // intents on cluster restart |
| 121 | @Property(name = "persistenceEnabled", boolValue = PERSIST, |
| 122 | label = "EXPERIMENTAL: Enable intent persistence") |
| 123 | private boolean persistenceEnabled; |
| 124 | |
| 125 | |
Yuta HIGUCHI | 4f8a377 | 2017-05-16 20:23:49 -0700 | [diff] [blame] | 126 | /** |
| 127 | * TimestampProvieder for currentMap. |
| 128 | * |
| 129 | * @param key Intent key |
| 130 | * @param data Intent data |
| 131 | * @return generated time stamp |
| 132 | */ |
| 133 | private Timestamp currentTimestampProvider(Key key, IntentData data) { |
| 134 | // vector timestamp consisting from 3 components |
| 135 | // (request timestamp, internal state, sequence #) |
| 136 | |
| 137 | // 2nd component required to avoid compilation result overwriting installation state |
| 138 | // note: above is likely to be a sign of design issue in transition to installation phase |
| 139 | // 3rd component required for generating new timestamp for removal.. |
| 140 | return new MultiValuedTimestamp<>( |
| 141 | Optional.ofNullable(data.version()).orElseGet(WallClockTimestamp::new), |
| 142 | new MultiValuedTimestamp<>(data.internalStateVersion(), |
| 143 | sequenceNumber.incrementAndGet())); |
| 144 | } |
| 145 | |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 146 | @Activate |
Aaron Kruglikov | 3721041 | 2016-12-06 12:55:57 -0800 | [diff] [blame] | 147 | public void activate(ComponentContext context) { |
| 148 | configService.registerProperties(getClass()); |
| 149 | modified(context); |
| 150 | //TODO persistent intents must be reevaluated and the appropriate |
| 151 | //processing done here, current implementation is not functional |
| 152 | //and is for performance evaluation only |
| 153 | initiallyPersistent = persistenceEnabled; |
Jonathan Hart | 539a646 | 2015-01-27 17:05:43 -0800 | [diff] [blame] | 154 | KryoNamespace.Builder intentSerializer = KryoNamespace.newBuilder() |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame] | 155 | .register(KryoNamespaces.API) |
| 156 | .register(IntentData.class) |
Brian Stanke | 11f6d53 | 2016-07-05 16:17:59 -0400 | [diff] [blame] | 157 | .register(VirtualNetworkIntent.class) |
| 158 | .register(NetworkId.class) |
HIGUCHI Yuta | 03666a3 | 2016-05-18 11:49:09 -0700 | [diff] [blame] | 159 | .register(MultiValuedTimestamp.class); |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 160 | |
Aaron Kruglikov | 3721041 | 2016-12-06 12:55:57 -0800 | [diff] [blame] | 161 | EventuallyConsistentMapBuilder currentECMapBuilder = |
| 162 | storageService.<Key, IntentData>eventuallyConsistentMapBuilder() |
Jonathan Hart | 6ec029a | 2015-03-24 17:12:35 -0700 | [diff] [blame] | 163 | .withName("intent-current") |
| 164 | .withSerializer(intentSerializer) |
Yuta HIGUCHI | 4f8a377 | 2017-05-16 20:23:49 -0700 | [diff] [blame] | 165 | .withTimestampProvider(this::currentTimestampProvider) |
Aaron Kruglikov | 3721041 | 2016-12-06 12:55:57 -0800 | [diff] [blame] | 166 | .withPeerUpdateFunction((key, intentData) -> getPeerNodes(key, intentData)); |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 167 | |
Aaron Kruglikov | 3721041 | 2016-12-06 12:55:57 -0800 | [diff] [blame] | 168 | EventuallyConsistentMapBuilder pendingECMapBuilder = |
| 169 | storageService.<Key, IntentData>eventuallyConsistentMapBuilder() |
Jonathan Hart | 6ec029a | 2015-03-24 17:12:35 -0700 | [diff] [blame] | 170 | .withName("intent-pending") |
| 171 | .withSerializer(intentSerializer) |
Brian O'Connor | c590ebb | 2016-12-08 18:16:41 -0800 | [diff] [blame] | 172 | .withTimestampProvider((key, intentData) -> |
| 173 | /* |
| 174 | We always want to accept new values in the pending map, |
| 175 | so we should use a high performance logical clock. |
| 176 | */ |
| 177 | /* |
| 178 | TODO We use the wall clock for the time being, but |
| 179 | this could result in issues if there is clock skew |
| 180 | across instances. |
| 181 | */ |
| 182 | new MultiValuedTimestamp<>(new WallClockTimestamp(), System.nanoTime())) |
Aaron Kruglikov | 3721041 | 2016-12-06 12:55:57 -0800 | [diff] [blame] | 183 | .withPeerUpdateFunction((key, intentData) -> getPeerNodes(key, intentData)); |
| 184 | if (initiallyPersistent) { |
| 185 | currentECMapBuilder = currentECMapBuilder.withPersistence(); |
| 186 | pendingECMapBuilder = pendingECMapBuilder.withPersistence(); |
| 187 | } |
| 188 | currentMap = currentECMapBuilder.build(); |
| 189 | pendingMap = pendingECMapBuilder.build(); |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 190 | |
Frank Wang | e0eb5ce | 2016-07-01 18:21:25 +0800 | [diff] [blame] | 191 | currentMap.addListener(mapCurrentListener); |
| 192 | pendingMap.addListener(mapPendingListener); |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 193 | |
| 194 | log.info("Started"); |
| 195 | } |
| 196 | |
| 197 | @Deactivate |
| 198 | public void deactivate() { |
Aaron Kruglikov | 3721041 | 2016-12-06 12:55:57 -0800 | [diff] [blame] | 199 | if (initiallyPersistent && !persistenceEnabled) { |
| 200 | pendingMap.clear(); |
| 201 | currentMap.clear(); |
| 202 | log.debug("Persistent state has been purged"); |
| 203 | } |
Frank Wang | e0eb5ce | 2016-07-01 18:21:25 +0800 | [diff] [blame] | 204 | currentMap.removeListener(mapCurrentListener); |
| 205 | pendingMap.removeListener(mapPendingListener); |
Brian O'Connor | 645bf20 | 2015-02-24 12:00:58 -0800 | [diff] [blame] | 206 | currentMap.destroy(); |
| 207 | pendingMap.destroy(); |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 208 | |
| 209 | log.info("Stopped"); |
| 210 | } |
| 211 | |
Aaron Kruglikov | 3721041 | 2016-12-06 12:55:57 -0800 | [diff] [blame] | 212 | @Modified |
| 213 | public void modified(ComponentContext context) { |
| 214 | Dictionary<?, ?> properties = context != null ? context.getProperties() |
| 215 | : new Properties(); |
| 216 | try { |
| 217 | String s = get(properties, "persistenceEnabled"); |
| 218 | persistenceEnabled = isNullOrEmpty(s) ? PERSIST : |
| 219 | Boolean.parseBoolean(s.trim()); |
| 220 | } catch (Exception e) { |
| 221 | persistenceEnabled = initiallyPersistent; |
| 222 | log.error("Failed to retrieve the property value for persist," + |
| 223 | "defaulting to the initial setting of \"{}\"" + |
| 224 | "any persistent state will not be purged, if " + |
| 225 | "this occurred at startup changes made in this" + |
| 226 | "session will not be persisted to disk", |
| 227 | initiallyPersistent); |
| 228 | } |
| 229 | if (persistenceEnabled) { |
| 230 | //FIXME persistence is an experimental feature, warnings can be removed |
| 231 | //when the feature is completed |
| 232 | log.warn("Persistence is an experimental feature, it is not fully " + |
| 233 | "functional and is intended only for " + |
| 234 | "performance evaluation"); |
| 235 | } |
| 236 | if (!initiallyPersistent && !persistenceEnabled) { |
| 237 | log.info("Persistence is set to \"false\", this was the initial" + |
| 238 | " setting so no state will be purged or " + |
| 239 | "persisted"); |
| 240 | } else if (!initiallyPersistent && persistenceEnabled) { |
| 241 | log.info("Persistence is set to \"true\", entries will be begin " + |
| 242 | "to be persisted after restart"); |
| 243 | } else if (initiallyPersistent && !persistenceEnabled) { |
| 244 | log.info("Persistence is set to \"false\", all persistent state " + |
| 245 | "will be purged on next shutdown"); |
| 246 | } else { |
| 247 | log.info("Persistence is set to \"true\", entries from this and" + |
| 248 | " subsequent sessions will be persisted"); |
| 249 | } |
| 250 | |
| 251 | |
| 252 | } |
| 253 | |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 254 | @Override |
| 255 | public long getIntentCount() { |
Brian O'Connor | 645bf20 | 2015-02-24 12:00:58 -0800 | [diff] [blame] | 256 | return currentMap.size(); |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 257 | } |
| 258 | |
| 259 | @Override |
| 260 | public Iterable<Intent> getIntents() { |
Brian O'Connor | 645bf20 | 2015-02-24 12:00:58 -0800 | [diff] [blame] | 261 | return currentMap.values().stream() |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 262 | .map(IntentData::intent) |
| 263 | .collect(Collectors.toList()); |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 264 | } |
| 265 | |
| 266 | @Override |
Brian O'Connor | a6c9b5c | 2015-04-29 22:38:29 -0700 | [diff] [blame] | 267 | public Iterable<IntentData> getIntentData(boolean localOnly, long olderThan) { |
| 268 | if (localOnly || olderThan > 0) { |
| 269 | long now = System.currentTimeMillis(); |
| 270 | final WallClockTimestamp time = new WallClockTimestamp(now - olderThan); |
Brian O'Connor | 3c58e96 | 2015-04-28 23:21:51 -0700 | [diff] [blame] | 271 | return currentMap.values().stream() |
Brian O'Connor | a6c9b5c | 2015-04-29 22:38:29 -0700 | [diff] [blame] | 272 | .filter(data -> data.version().isOlderThan(time) && |
| 273 | (!localOnly || isMaster(data.key()))) |
Brian O'Connor | 3c58e96 | 2015-04-28 23:21:51 -0700 | [diff] [blame] | 274 | .collect(Collectors.toList()); |
| 275 | } |
| 276 | return currentMap.values(); |
| 277 | } |
| 278 | |
| 279 | @Override |
Ray Milkey | f9af43c | 2015-02-09 16:45:48 -0800 | [diff] [blame] | 280 | public IntentState getIntentState(Key intentKey) { |
Brian O'Connor | 645bf20 | 2015-02-24 12:00:58 -0800 | [diff] [blame] | 281 | IntentData data = currentMap.get(intentKey); |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame] | 282 | if (data != null) { |
| 283 | return data.state(); |
| 284 | } |
| 285 | return null; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 286 | } |
| 287 | |
| 288 | @Override |
Ray Milkey | f9af43c | 2015-02-09 16:45:48 -0800 | [diff] [blame] | 289 | public List<Intent> getInstallableIntents(Key intentKey) { |
Brian O'Connor | 645bf20 | 2015-02-24 12:00:58 -0800 | [diff] [blame] | 290 | IntentData data = currentMap.get(intentKey); |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame] | 291 | if (data != null) { |
| 292 | return data.installables(); |
| 293 | } |
Sho SHIMIZU | 9fa6b8b | 2016-01-15 16:45:57 -0800 | [diff] [blame] | 294 | return ImmutableList.of(); |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 295 | } |
| 296 | |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 297 | @Override |
| 298 | public void write(IntentData newData) { |
Jonathan Hart | 0d18df3 | 2015-03-21 08:42:59 -0700 | [diff] [blame] | 299 | checkNotNull(newData); |
| 300 | |
Brian O'Connor | 645bf20 | 2015-02-24 12:00:58 -0800 | [diff] [blame] | 301 | IntentData currentData = currentMap.get(newData.key()); |
Jonathan Hart | 72175c2 | 2015-03-24 18:55:58 -0700 | [diff] [blame] | 302 | if (IntentData.isUpdateAcceptable(currentData, newData)) { |
Jonathan Hart | 07e58be | 2015-02-12 09:57:16 -0800 | [diff] [blame] | 303 | // Only the master is modifying the current state. Therefore assume |
| 304 | // this always succeeds |
Thomas Vachuska | 7d61ab2 | 2016-06-13 19:41:52 -0700 | [diff] [blame] | 305 | if (newData.state() == PURGE_REQ) { |
| 306 | if (currentData != null) { |
Yuta HIGUCHI | 4f8a377 | 2017-05-16 20:23:49 -0700 | [diff] [blame] | 307 | if (log.isTraceEnabled()) { |
| 308 | log.trace("Purging {} in currentMap. {}@{}", |
| 309 | newData.key(), newData.state(), newData.version(), |
| 310 | new Backtrace()); |
| 311 | } |
Thomas Vachuska | 7d61ab2 | 2016-06-13 19:41:52 -0700 | [diff] [blame] | 312 | currentMap.remove(newData.key(), currentData); |
| 313 | } else { |
| 314 | log.info("Gratuitous purge request for intent: {}", newData.key()); |
| 315 | } |
Ray Milkey | 8c6d00e | 2015-03-13 14:14:34 -0700 | [diff] [blame] | 316 | } else { |
Yuta HIGUCHI | 4f8a377 | 2017-05-16 20:23:49 -0700 | [diff] [blame] | 317 | if (log.isTraceEnabled()) { |
| 318 | log.trace("Putting {} in currentMap. {}@{}", |
| 319 | newData.key(), newData.state(), newData.version(), |
| 320 | new Backtrace()); |
| 321 | } |
| 322 | currentMap.put(newData.key(), IntentData.copy(newData)); |
Ray Milkey | 8c6d00e | 2015-03-13 14:14:34 -0700 | [diff] [blame] | 323 | } |
Yuta HIGUCHI | f76f6d5 | 2017-05-15 18:02:09 -0700 | [diff] [blame] | 324 | } else { |
Yuta HIGUCHI | 4f8a377 | 2017-05-16 20:23:49 -0700 | [diff] [blame] | 325 | log.debug("Update for {} not acceptable from:\n{}\nto:\n{}", |
| 326 | newData.key(), currentData, newData); |
Jonathan Hart | 07e58be | 2015-02-12 09:57:16 -0800 | [diff] [blame] | 327 | } |
Pier Luigi | 13b287f | 2017-01-10 15:07:52 -0800 | [diff] [blame] | 328 | // Remove the intent data from the pending map if the newData is more |
| 329 | // recent or equal to the existing entry. No matter if it is an acceptable |
| 330 | // update or not |
Yi Tseng | 5bd294e | 2017-05-04 11:00:03 -0700 | [diff] [blame] | 331 | Key key = newData.key(); |
| 332 | IntentData existingValue = pendingMap.get(key); |
| 333 | |
| 334 | if (existingValue == null) { |
| 335 | return; |
| 336 | } |
| 337 | |
| 338 | if (!existingValue.version().isNewerThan(newData.version())) { |
| 339 | pendingMap.remove(key, existingValue); |
Yuta HIGUCHI | f76f6d5 | 2017-05-15 18:02:09 -0700 | [diff] [blame] | 340 | } else { |
| 341 | log.debug("{} in pending map was newer, leaving it there", key); |
Yi Tseng | 5bd294e | 2017-05-04 11:00:03 -0700 | [diff] [blame] | 342 | } |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 343 | } |
| 344 | |
Brian O'Connor | 9081c90 | 2015-03-05 16:26:25 -0800 | [diff] [blame] | 345 | private Collection<NodeId> getPeerNodes(Key key, IntentData data) { |
Madan Jampani | 3b8101a | 2016-09-15 13:22:01 -0700 | [diff] [blame] | 346 | NodeId master = partitionService.getLeader(key, Key::hash); |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 347 | NodeId origin = (data != null) ? data.origin() : null; |
Jonathan Hart | 4a29c59 | 2015-09-23 17:55:07 -0700 | [diff] [blame] | 348 | if (data != null && (master == null || origin == null)) { |
Brian O'Connor | 6325dad | 2015-07-07 15:36:29 -0700 | [diff] [blame] | 349 | log.debug("Intent {} missing master and/or origin; master = {}, origin = {}", |
| 350 | key, master, origin); |
Brian O'Connor | 4964d3d | 2015-03-12 20:38:10 -0700 | [diff] [blame] | 351 | } |
| 352 | |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 353 | NodeId me = clusterService.getLocalNode().id(); |
| 354 | boolean isMaster = Objects.equals(master, me); |
| 355 | boolean isOrigin = Objects.equals(origin, me); |
| 356 | if (isMaster && isOrigin) { |
Brian O'Connor | 4964d3d | 2015-03-12 20:38:10 -0700 | [diff] [blame] | 357 | return getRandomNode(); |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 358 | } else if (isMaster) { |
Brian O'Connor | 4964d3d | 2015-03-12 20:38:10 -0700 | [diff] [blame] | 359 | return origin != null ? ImmutableList.of(origin) : getRandomNode(); |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 360 | } else if (isOrigin) { |
Brian O'Connor | 4964d3d | 2015-03-12 20:38:10 -0700 | [diff] [blame] | 361 | return master != null ? ImmutableList.of(master) : getRandomNode(); |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 362 | } else { |
Brian O'Connor | 6325dad | 2015-07-07 15:36:29 -0700 | [diff] [blame] | 363 | log.warn("No master or origin for intent {}", key); |
Brian O'Connor | 148ba2f | 2015-07-06 11:38:44 -0700 | [diff] [blame] | 364 | return master != null ? ImmutableList.of(master) : getRandomNode(); |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 365 | } |
| 366 | } |
| 367 | |
Brian O'Connor | 4964d3d | 2015-03-12 20:38:10 -0700 | [diff] [blame] | 368 | private List<NodeId> getRandomNode() { |
| 369 | NodeId me = clusterService.getLocalNode().id(); |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 370 | List<NodeId> nodes = clusterService.getNodes().stream() |
Brian O'Connor | 4964d3d | 2015-03-12 20:38:10 -0700 | [diff] [blame] | 371 | .map(ControllerNode::id) |
| 372 | .filter(node -> !Objects.equals(node, me)) |
| 373 | .collect(Collectors.toList()); |
Sho SHIMIZU | 27e1b92 | 2016-01-15 22:47:44 -0800 | [diff] [blame] | 374 | if (nodes.isEmpty()) { |
| 375 | return ImmutableList.of(); |
Brian O'Connor | 4964d3d | 2015-03-12 20:38:10 -0700 | [diff] [blame] | 376 | } |
| 377 | return ImmutableList.of(nodes.get(RandomUtils.nextInt(nodes.size()))); |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 378 | } |
| 379 | |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 380 | @Override |
| 381 | public void batchWrite(Iterable<IntentData> updates) { |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 382 | updates.forEach(this::write); |
| 383 | } |
| 384 | |
| 385 | @Override |
| 386 | public Intent getIntent(Key key) { |
Brian O'Connor | 645bf20 | 2015-02-24 12:00:58 -0800 | [diff] [blame] | 387 | IntentData data = currentMap.get(key); |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 388 | if (data != null) { |
| 389 | return data.intent(); |
| 390 | } |
| 391 | return null; |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 392 | } |
| 393 | |
| 394 | @Override |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 395 | public IntentData getIntentData(Key key) { |
Jonathan Hart | 0d18df3 | 2015-03-21 08:42:59 -0700 | [diff] [blame] | 396 | IntentData current = currentMap.get(key); |
| 397 | if (current == null) { |
| 398 | return null; |
| 399 | } |
Yuta HIGUCHI | 4f8a377 | 2017-05-16 20:23:49 -0700 | [diff] [blame] | 400 | return IntentData.copy(current); |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 401 | } |
| 402 | |
| 403 | @Override |
| 404 | public void addPending(IntentData data) { |
Jonathan Hart | 0d18df3 | 2015-03-21 08:42:59 -0700 | [diff] [blame] | 405 | checkNotNull(data); |
Pier Ventre | 6582808 | 2017-01-04 10:15:00 -0800 | [diff] [blame] | 406 | if (data.version() == null) { |
Pier Luigi | e6caf68 | 2017-01-26 15:25:09 -0800 | [diff] [blame] | 407 | // Copy IntentData including request state in this way we can |
| 408 | // avoid the creation of Intents with state == request, which can |
| 409 | // be problematic if the Intent state is different from *REQ |
| 410 | // {INSTALL_, WITHDRAW_ and PURGE_}. |
Yuta HIGUCHI | 4f8a377 | 2017-05-16 20:23:49 -0700 | [diff] [blame] | 411 | pendingMap.put(data.key(), IntentData.assign(data, |
| 412 | new WallClockTimestamp(), |
| 413 | clusterService.getLocalNode().id())); |
Pier Ventre | 6582808 | 2017-01-04 10:15:00 -0800 | [diff] [blame] | 414 | } else { |
| 415 | pendingMap.compute(data.key(), (key, existingValue) -> { |
| 416 | if (existingValue == null || existingValue.version().isOlderThan(data.version())) { |
Yuta HIGUCHI | 4f8a377 | 2017-05-16 20:23:49 -0700 | [diff] [blame] | 417 | return IntentData.assign(data, data.version(), clusterService.getLocalNode().id()); |
Pier Ventre | 6582808 | 2017-01-04 10:15:00 -0800 | [diff] [blame] | 418 | } else { |
| 419 | return existingValue; |
| 420 | } |
| 421 | }); |
| 422 | } |
Jonathan Hart | 0d18df3 | 2015-03-21 08:42:59 -0700 | [diff] [blame] | 423 | |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 424 | } |
| 425 | |
| 426 | @Override |
Brian O'Connor | be28a87 | 2015-02-19 21:44:37 -0800 | [diff] [blame] | 427 | public boolean isMaster(Key intentKey) { |
Madan Jampani | 3b8101a | 2016-09-15 13:22:01 -0700 | [diff] [blame] | 428 | return partitionService.isMine(intentKey, Key::hash); |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 429 | } |
| 430 | |
Jonathan Hart | 34f1e38 | 2015-02-24 16:52:23 -0800 | [diff] [blame] | 431 | @Override |
| 432 | public Iterable<Intent> getPending() { |
Brian O'Connor | 645bf20 | 2015-02-24 12:00:58 -0800 | [diff] [blame] | 433 | return pendingMap.values().stream() |
Jonathan Hart | 34f1e38 | 2015-02-24 16:52:23 -0800 | [diff] [blame] | 434 | .map(IntentData::intent) |
| 435 | .collect(Collectors.toList()); |
| 436 | } |
| 437 | |
Brian O'Connor | a6c9b5c | 2015-04-29 22:38:29 -0700 | [diff] [blame] | 438 | @Override |
| 439 | public Iterable<IntentData> getPendingData() { |
| 440 | return pendingMap.values(); |
| 441 | } |
| 442 | |
| 443 | @Override |
Brian O'Connor | c590ebb | 2016-12-08 18:16:41 -0800 | [diff] [blame] | 444 | public IntentData getPendingData(Key intentKey) { |
| 445 | return pendingMap.get(intentKey); |
| 446 | } |
| 447 | |
| 448 | @Override |
Brian O'Connor | a6c9b5c | 2015-04-29 22:38:29 -0700 | [diff] [blame] | 449 | public Iterable<IntentData> getPendingData(boolean localOnly, long olderThan) { |
| 450 | long now = System.currentTimeMillis(); |
| 451 | final WallClockTimestamp time = new WallClockTimestamp(now - olderThan); |
| 452 | return pendingMap.values().stream() |
| 453 | .filter(data -> data.version().isOlderThan(time) && |
Brian Stanke | 2617dac | 2016-05-03 16:15:44 -0400 | [diff] [blame] | 454 | (!localOnly || isMaster(data.key()))) |
Brian O'Connor | a6c9b5c | 2015-04-29 22:38:29 -0700 | [diff] [blame] | 455 | .collect(Collectors.toList()); |
| 456 | } |
| 457 | |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 458 | private final class InternalCurrentListener implements |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 459 | EventuallyConsistentMapListener<Key, IntentData> { |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 460 | @Override |
Thomas Vachuska | c46af20 | 2015-06-03 16:43:27 -0700 | [diff] [blame] | 461 | public void event(EventuallyConsistentMapEvent<Key, IntentData> event) { |
| 462 | IntentData intentData = event.value(); |
Thomas Vachuska | c46af20 | 2015-06-03 16:43:27 -0700 | [diff] [blame] | 463 | if (event.type() == EventuallyConsistentMapEvent.Type.PUT) { |
| 464 | // The current intents map has been updated. If we are master for |
| 465 | // this intent's partition, notify the Manager that it should |
| 466 | // emit notifications about updated tracked resources. |
| 467 | if (delegate != null && isMaster(event.value().intent().key())) { |
Yuta HIGUCHI | 4f8a377 | 2017-05-16 20:23:49 -0700 | [diff] [blame] | 468 | delegate.onUpdate(IntentData.copy(intentData)); // copy for safety, likely unnecessary |
Thomas Vachuska | c46af20 | 2015-06-03 16:43:27 -0700 | [diff] [blame] | 469 | } |
Sho SHIMIZU | 96b39e2 | 2016-01-15 17:35:04 -0800 | [diff] [blame] | 470 | IntentEvent.getEvent(intentData).ifPresent(e -> notifyDelegate(e)); |
Jonathan Hart | 539a646 | 2015-01-27 17:05:43 -0800 | [diff] [blame] | 471 | } |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 472 | } |
| 473 | } |
| 474 | |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 475 | private final class InternalPendingListener implements |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 476 | EventuallyConsistentMapListener<Key, IntentData> { |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 477 | @Override |
| 478 | public void event( |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 479 | EventuallyConsistentMapEvent<Key, IntentData> event) { |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 480 | if (event.type() == EventuallyConsistentMapEvent.Type.PUT) { |
| 481 | // The pending intents map has been updated. If we are master for |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 482 | // this intent's partition, notify the Manager that it should do |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 483 | // some work. |
Brian O'Connor | be28a87 | 2015-02-19 21:44:37 -0800 | [diff] [blame] | 484 | if (isMaster(event.value().intent().key())) { |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 485 | if (delegate != null) { |
Yuta HIGUCHI | 4f8a377 | 2017-05-16 20:23:49 -0700 | [diff] [blame] | 486 | delegate.process(IntentData.copy(event.value())); |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 487 | } |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 488 | } |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame] | 489 | |
Sho SHIMIZU | 96b39e2 | 2016-01-15 17:35:04 -0800 | [diff] [blame] | 490 | IntentEvent.getEvent(event.value()).ifPresent(e -> notifyDelegate(e)); |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 491 | } |
| 492 | } |
| 493 | } |
| 494 | |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 495 | } |
| 496 | |