Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 1 | /* |
| 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 | */ |
| 16 | package org.onosproject.store.intent.impl; |
| 17 | |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 18 | import org.apache.felix.scr.annotations.Activate; |
| 19 | import org.apache.felix.scr.annotations.Component; |
| 20 | import org.apache.felix.scr.annotations.Deactivate; |
| 21 | import org.apache.felix.scr.annotations.Reference; |
| 22 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 23 | import org.apache.felix.scr.annotations.Service; |
| 24 | import org.onlab.util.KryoNamespace; |
| 25 | import org.onosproject.cluster.ClusterService; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 26 | import org.onosproject.net.intent.BatchWrite; |
| 27 | import org.onosproject.net.intent.Intent; |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 28 | import org.onosproject.net.intent.IntentData; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 29 | import org.onosproject.net.intent.IntentEvent; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 30 | import org.onosproject.net.intent.IntentState; |
| 31 | import org.onosproject.net.intent.IntentStore; |
| 32 | import org.onosproject.net.intent.IntentStoreDelegate; |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 33 | import org.onosproject.net.intent.Key; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 34 | import org.onosproject.store.AbstractStore; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 35 | import org.onosproject.store.cluster.messaging.ClusterCommunicationService; |
Jonathan Hart | 539a646 | 2015-01-27 17:05:43 -0800 | [diff] [blame] | 36 | import org.onosproject.store.impl.EventuallyConsistentMap; |
| 37 | import org.onosproject.store.impl.EventuallyConsistentMapEvent; |
| 38 | import org.onosproject.store.impl.EventuallyConsistentMapImpl; |
| 39 | import org.onosproject.store.impl.EventuallyConsistentMapListener; |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame^] | 40 | import org.onosproject.store.impl.MultiValuedTimestamp; |
| 41 | import org.onosproject.store.impl.SystemClockTimestamp; |
Jonathan Hart | 539a646 | 2015-01-27 17:05:43 -0800 | [diff] [blame] | 42 | import org.onosproject.store.serializers.KryoNamespaces; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 43 | import org.slf4j.Logger; |
| 44 | |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 45 | import java.util.List; |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 46 | import java.util.stream.Collectors; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 47 | |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 48 | import static org.slf4j.LoggerFactory.getLogger; |
| 49 | |
| 50 | /** |
| 51 | * Manages inventory of Intents in a distributed data store that uses optimistic |
| 52 | * replication and gossip based techniques. |
| 53 | */ |
Brian O'Connor | b488b19 | 2015-02-06 17:58:58 -0800 | [diff] [blame] | 54 | @Component(immediate = false, enabled = false) |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 55 | @Service |
| 56 | public class GossipIntentStore |
| 57 | extends AbstractStore<IntentEvent, IntentStoreDelegate> |
| 58 | implements IntentStore { |
| 59 | |
| 60 | private final Logger log = getLogger(getClass()); |
| 61 | |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 62 | // Map of intent key => current intent state |
| 63 | private EventuallyConsistentMap<Key, IntentData> currentState; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 64 | |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 65 | // Map of intent key => pending intent operation |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 66 | private EventuallyConsistentMap<Key, IntentData> pending; |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 67 | |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 68 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 69 | protected ClusterCommunicationService clusterCommunicator; |
| 70 | |
| 71 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 72 | protected ClusterService clusterService; |
| 73 | |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 74 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 75 | protected PartitionService partitionService; |
| 76 | |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 77 | @Activate |
| 78 | public void activate() { |
Jonathan Hart | 539a646 | 2015-01-27 17:05:43 -0800 | [diff] [blame] | 79 | KryoNamespace.Builder intentSerializer = KryoNamespace.newBuilder() |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame^] | 80 | .register(KryoNamespaces.API) |
| 81 | .register(IntentData.class) |
| 82 | .register(MultiValuedTimestamp.class) |
| 83 | .register(SystemClockTimestamp.class); |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 84 | |
| 85 | currentState = new EventuallyConsistentMapImpl<>("intent-current", |
| 86 | clusterService, |
| 87 | clusterCommunicator, |
| 88 | intentSerializer, |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame^] | 89 | new IntentDataLogicalClockManager<>()); |
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 | pending = new EventuallyConsistentMapImpl<>("intent-pending", |
| 92 | clusterService, |
| 93 | clusterCommunicator, |
| 94 | intentSerializer, // TODO |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame^] | 95 | new IntentDataClockManager<>()); |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 96 | |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 97 | currentState.addListener(new InternalIntentStatesListener()); |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 98 | pending.addListener(new InternalPendingListener()); |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 99 | |
| 100 | log.info("Started"); |
| 101 | } |
| 102 | |
| 103 | @Deactivate |
| 104 | public void deactivate() { |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 105 | currentState.destroy(); |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 106 | pending.destroy(); |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 107 | |
| 108 | log.info("Stopped"); |
| 109 | } |
| 110 | |
| 111 | @Override |
| 112 | public long getIntentCount() { |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 113 | return currentState.size(); |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 114 | } |
| 115 | |
| 116 | @Override |
| 117 | public Iterable<Intent> getIntents() { |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 118 | return currentState.values().stream() |
| 119 | .map(IntentData::intent) |
| 120 | .collect(Collectors.toList()); |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 121 | } |
| 122 | |
| 123 | @Override |
Ray Milkey | f9af43c | 2015-02-09 16:45:48 -0800 | [diff] [blame] | 124 | public IntentState getIntentState(Key intentKey) { |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame^] | 125 | IntentData data = currentState.get(intentKey); |
| 126 | if (data != null) { |
| 127 | return data.state(); |
| 128 | } |
| 129 | return null; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 130 | } |
| 131 | |
| 132 | @Override |
Ray Milkey | f9af43c | 2015-02-09 16:45:48 -0800 | [diff] [blame] | 133 | public List<Intent> getInstallableIntents(Key intentKey) { |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame^] | 134 | IntentData data = currentState.get(intentKey); |
| 135 | if (data != null) { |
| 136 | return data.installables(); |
| 137 | } |
Ray Milkey | f9af43c | 2015-02-09 16:45:48 -0800 | [diff] [blame] | 138 | return null; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 139 | } |
| 140 | |
| 141 | @Override |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 142 | public List<BatchWrite.Operation> batchWrite(BatchWrite batch) { |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame^] | 143 | // Deprecated |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 144 | return null; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 145 | } |
| 146 | |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 147 | @Override |
| 148 | public void write(IntentData newData) { |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame^] | 149 | log.debug("writing intent {}", newData); |
| 150 | |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 151 | // Only the master is modifying the current state. Therefore assume |
| 152 | // this always succeeds |
| 153 | currentState.put(newData.key(), newData); |
| 154 | |
| 155 | // if current.put succeeded |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame^] | 156 | pending.remove(newData.key(), newData); |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 157 | |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame^] | 158 | /*try { |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 159 | notifyDelegate(IntentEvent.getEvent(newData)); |
| 160 | } catch (IllegalArgumentException e) { |
| 161 | //no-op |
| 162 | log.trace("ignore this exception: {}", e); |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame^] | 163 | }*/ |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 164 | } |
| 165 | |
| 166 | @Override |
| 167 | public void batchWrite(Iterable<IntentData> updates) { |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 168 | updates.forEach(this::write); |
| 169 | } |
| 170 | |
| 171 | @Override |
| 172 | public Intent getIntent(Key key) { |
| 173 | IntentData data = currentState.get(key); |
| 174 | if (data != null) { |
| 175 | return data.intent(); |
| 176 | } |
| 177 | return null; |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 178 | } |
| 179 | |
| 180 | @Override |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 181 | public IntentData getIntentData(Key key) { |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 182 | return currentState.get(key); |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 183 | } |
| 184 | |
| 185 | @Override |
| 186 | public void addPending(IntentData data) { |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame^] | 187 | log.debug("new call to pending {}", data); |
| 188 | if (data.version() == null) { |
| 189 | log.debug("updating timestamp"); |
| 190 | data.setVersion(new SystemClockTimestamp()); |
| 191 | } |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 192 | pending.put(data.key(), data); |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 193 | } |
| 194 | |
| 195 | @Override |
| 196 | public boolean isMaster(Intent intent) { |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame^] | 197 | return partitionService.isMine(intent.key()); |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 198 | } |
| 199 | |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 200 | private void notifyDelegateIfNotNull(IntentEvent event) { |
| 201 | if (event != null) { |
| 202 | notifyDelegate(event); |
| 203 | } |
| 204 | } |
| 205 | |
Jonathan Hart | 539a646 | 2015-01-27 17:05:43 -0800 | [diff] [blame] | 206 | private final class InternalIntentStatesListener implements |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 207 | EventuallyConsistentMapListener<Key, IntentData> { |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 208 | @Override |
Jonathan Hart | 539a646 | 2015-01-27 17:05:43 -0800 | [diff] [blame] | 209 | public void event( |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 210 | EventuallyConsistentMapEvent<Key, IntentData> event) { |
Jonathan Hart | 539a646 | 2015-01-27 17:05:43 -0800 | [diff] [blame] | 211 | if (event.type() == EventuallyConsistentMapEvent.Type.PUT) { |
| 212 | IntentEvent externalEvent; |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame^] | 213 | IntentData intentData = event.value(); |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 214 | |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 215 | try { |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame^] | 216 | externalEvent = IntentEvent.getEvent(intentData.state(), intentData.intent()); |
Jonathan Hart | 539a646 | 2015-01-27 17:05:43 -0800 | [diff] [blame] | 217 | } catch (IllegalArgumentException e) { |
| 218 | externalEvent = null; |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 219 | } |
Jonathan Hart | 539a646 | 2015-01-27 17:05:43 -0800 | [diff] [blame] | 220 | |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame^] | 221 | notifyDelegateIfNotNull(externalEvent); |
Jonathan Hart | 539a646 | 2015-01-27 17:05:43 -0800 | [diff] [blame] | 222 | } |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 223 | } |
| 224 | } |
| 225 | |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 226 | private final class InternalPendingListener implements |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 227 | EventuallyConsistentMapListener<Key, IntentData> { |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 228 | @Override |
| 229 | public void event( |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 230 | EventuallyConsistentMapEvent<Key, IntentData> event) { |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 231 | if (event.type() == EventuallyConsistentMapEvent.Type.PUT) { |
| 232 | // The pending intents map has been updated. If we are master for |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 233 | // this intent's partition, notify the Manager that it should do |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 234 | // some work. |
| 235 | if (isMaster(event.value().intent())) { |
Jonathan Hart | 4fd4ebb | 2015-02-04 17:38:48 -0800 | [diff] [blame] | 236 | if (delegate != null) { |
| 237 | delegate.process(event.value()); |
| 238 | } |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 239 | } |
Jonathan Hart | 5ec32ba | 2015-02-05 13:33:58 -0800 | [diff] [blame^] | 240 | |
| 241 | try { |
| 242 | notifyDelegate(IntentEvent.getEvent(event.value())); |
| 243 | } catch (IllegalArgumentException e) { |
| 244 | //no-op |
| 245 | log.trace("ignore this exception: {}", e); |
| 246 | } |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 247 | } |
| 248 | } |
| 249 | } |
| 250 | |
Jonathan Hart | 5573d32 | 2015-01-21 10:13:25 -0800 | [diff] [blame] | 251 | } |
| 252 | |