Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2018-present Open Networking Foundation |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.onosproject.net.flowobjective.impl; |
| 18 | |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 19 | import com.google.common.cache.Cache; |
| 20 | import com.google.common.cache.CacheBuilder; |
Charles Chan | a724c513 | 2018-11-27 21:33:33 +0800 | [diff] [blame] | 21 | import com.google.common.cache.RemovalListener; |
| 22 | import com.google.common.cache.RemovalListeners; |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 23 | import com.google.common.collect.ArrayListMultimap; |
| 24 | import com.google.common.collect.ListMultimap; |
| 25 | import com.google.common.collect.Multimaps; |
Charles Chan | c09ad6d | 2018-04-04 16:31:23 -0700 | [diff] [blame] | 26 | import org.onlab.util.Tools; |
| 27 | import org.onlab.util.Tools.LogLevel; |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 28 | import org.onosproject.net.DeviceId; |
Charles Chan | 33f4a91 | 2018-04-19 23:35:30 -0700 | [diff] [blame] | 29 | import org.onosproject.net.flowobjective.FilteringObjQueueKey; |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 30 | import org.onosproject.net.flowobjective.FilteringObjective; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 31 | import org.onosproject.net.flowobjective.FlowObjectiveService; |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 32 | import org.onosproject.net.flowobjective.FlowObjectiveStoreDelegate; |
Charles Chan | 33f4a91 | 2018-04-19 23:35:30 -0700 | [diff] [blame] | 33 | import org.onosproject.net.flowobjective.ForwardingObjQueueKey; |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 34 | import org.onosproject.net.flowobjective.ForwardingObjective; |
Charles Chan | 33f4a91 | 2018-04-19 23:35:30 -0700 | [diff] [blame] | 35 | import org.onosproject.net.flowobjective.NextObjQueueKey; |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 36 | import org.onosproject.net.flowobjective.NextObjective; |
| 37 | import org.onosproject.net.flowobjective.Objective; |
| 38 | import org.onosproject.net.flowobjective.ObjectiveContext; |
| 39 | import org.onosproject.net.flowobjective.ObjectiveError; |
| 40 | import org.onosproject.net.flowobjective.ObjectiveEvent; |
Charles Chan | a724c513 | 2018-11-27 21:33:33 +0800 | [diff] [blame] | 41 | import org.onosproject.net.flowobjective.ObjectiveQueueKey; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 42 | import org.osgi.service.component.annotations.Activate; |
| 43 | import org.osgi.service.component.annotations.Component; |
| 44 | import org.osgi.service.component.annotations.Deactivate; |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 45 | import org.slf4j.Logger; |
| 46 | import org.slf4j.LoggerFactory; |
| 47 | |
| 48 | import java.util.List; |
Charles Chan | 33f4a91 | 2018-04-19 23:35:30 -0700 | [diff] [blame] | 49 | import java.util.Map; |
Charles Chan | a724c513 | 2018-11-27 21:33:33 +0800 | [diff] [blame] | 50 | import java.util.Objects; |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 51 | import java.util.Optional; |
| 52 | import java.util.Set; |
Charles Chan | a724c513 | 2018-11-27 21:33:33 +0800 | [diff] [blame] | 53 | import java.util.concurrent.ExecutorService; |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 54 | import java.util.concurrent.ScheduledExecutorService; |
| 55 | import java.util.concurrent.TimeUnit; |
Charles Chan | c51852e | 2019-01-07 19:59:10 -0800 | [diff] [blame^] | 56 | import java.util.concurrent.atomic.AtomicBoolean; |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 57 | |
Charles Chan | a724c513 | 2018-11-27 21:33:33 +0800 | [diff] [blame] | 58 | import static java.util.concurrent.Executors.newSingleThreadExecutor; |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 59 | import static java.util.concurrent.Executors.newSingleThreadScheduledExecutor; |
| 60 | import static org.onlab.util.Tools.groupedThreads; |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 61 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 62 | @Component(immediate = true, service = FlowObjectiveService.class) |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 63 | public class InOrderFlowObjectiveManager extends FlowObjectiveManager { |
| 64 | private final Logger log = LoggerFactory.getLogger(getClass()); |
| 65 | |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 66 | // TODO Make queue timeout configurable |
Charles Chan | b4f4fdb | 2018-12-21 13:55:29 -0800 | [diff] [blame] | 67 | static final int DEFAULT_OBJ_TIMEOUT = 15000; |
| 68 | int objTimeoutMs = DEFAULT_OBJ_TIMEOUT; |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 69 | |
Charles Chan | 33f4a91 | 2018-04-19 23:35:30 -0700 | [diff] [blame] | 70 | private Cache<FilteringObjQueueKey, Objective> filtObjQueueHead; |
| 71 | private Cache<ForwardingObjQueueKey, Objective> fwdObjQueueHead; |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 72 | private Cache<NextObjQueueKey, Objective> nextObjQueueHead; |
| 73 | private ScheduledExecutorService cacheCleaner; |
Charles Chan | a724c513 | 2018-11-27 21:33:33 +0800 | [diff] [blame] | 74 | private ExecutorService filtCacheEventExecutor; |
| 75 | private ExecutorService fwdCacheEventExecutor; |
| 76 | private ExecutorService nextCacheEventExecutor; |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 77 | |
Charles Chan | 33f4a91 | 2018-04-19 23:35:30 -0700 | [diff] [blame] | 78 | private ListMultimap<FilteringObjQueueKey, Objective> filtObjQueue = |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 79 | Multimaps.synchronizedListMultimap(ArrayListMultimap.create()); |
Charles Chan | 33f4a91 | 2018-04-19 23:35:30 -0700 | [diff] [blame] | 80 | private ListMultimap<ForwardingObjQueueKey, Objective> fwdObjQueue = |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 81 | Multimaps.synchronizedListMultimap(ArrayListMultimap.create()); |
| 82 | private ListMultimap<NextObjQueueKey, Objective> nextObjQueue = |
| 83 | Multimaps.synchronizedListMultimap(ArrayListMultimap.create()); |
| 84 | |
| 85 | final FlowObjectiveStoreDelegate delegate = new InternalStoreDelegate(); |
| 86 | |
| 87 | @Activate |
| 88 | protected void activate() { |
| 89 | super.activate(); |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 90 | |
Charles Chan | a724c513 | 2018-11-27 21:33:33 +0800 | [diff] [blame] | 91 | filtCacheEventExecutor = newSingleThreadExecutor(groupedThreads("onos/flowobj", "cache-event-filt", log)); |
| 92 | fwdCacheEventExecutor = newSingleThreadExecutor(groupedThreads("onos/flowobj", "cache-event-fwd", log)); |
| 93 | nextCacheEventExecutor = newSingleThreadExecutor(groupedThreads("onos/flowobj", "cache-event-next", log)); |
| 94 | |
| 95 | RemovalListener<ObjectiveQueueKey, Objective> removalListener = notification -> { |
| 96 | Objective obj = notification.getValue(); |
| 97 | switch (notification.getCause()) { |
| 98 | case EXPIRED: |
| 99 | case COLLECTED: |
| 100 | case SIZE: |
| 101 | obj.context().ifPresent(c -> c.onError(obj, ObjectiveError.INSTALLATIONTIMEOUT)); |
| 102 | break; |
| 103 | case EXPLICIT: // No action when the objective completes correctly |
| 104 | case REPLACED: // No action when a pending forward or next objective gets executed |
| 105 | default: |
| 106 | break; |
| 107 | } |
| 108 | }; |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 109 | filtObjQueueHead = CacheBuilder.newBuilder() |
Charles Chan | 1491b9b | 2018-11-27 21:33:33 +0800 | [diff] [blame] | 110 | .expireAfterWrite(objTimeoutMs, TimeUnit.MILLISECONDS) |
Charles Chan | a724c513 | 2018-11-27 21:33:33 +0800 | [diff] [blame] | 111 | .removalListener(RemovalListeners.asynchronous(removalListener, filtCacheEventExecutor)) |
| 112 | .build(); |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 113 | fwdObjQueueHead = CacheBuilder.newBuilder() |
Charles Chan | 1491b9b | 2018-11-27 21:33:33 +0800 | [diff] [blame] | 114 | .expireAfterWrite(objTimeoutMs, TimeUnit.MILLISECONDS) |
Charles Chan | a724c513 | 2018-11-27 21:33:33 +0800 | [diff] [blame] | 115 | .removalListener(RemovalListeners.asynchronous(removalListener, fwdCacheEventExecutor)) |
| 116 | .build(); |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 117 | nextObjQueueHead = CacheBuilder.newBuilder() |
Charles Chan | 1491b9b | 2018-11-27 21:33:33 +0800 | [diff] [blame] | 118 | .expireAfterWrite(objTimeoutMs, TimeUnit.MILLISECONDS) |
Charles Chan | a724c513 | 2018-11-27 21:33:33 +0800 | [diff] [blame] | 119 | .removalListener(RemovalListeners.asynchronous(removalListener, nextCacheEventExecutor)) |
| 120 | .build(); |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 121 | |
| 122 | cacheCleaner = newSingleThreadScheduledExecutor(groupedThreads("onos/flowobj", "cache-cleaner", log)); |
| 123 | cacheCleaner.scheduleAtFixedRate(() -> { |
| 124 | filtObjQueueHead.cleanUp(); |
| 125 | fwdObjQueueHead.cleanUp(); |
| 126 | nextObjQueueHead.cleanUp(); |
Charles Chan | 1491b9b | 2018-11-27 21:33:33 +0800 | [diff] [blame] | 127 | }, 0, objTimeoutMs, TimeUnit.MILLISECONDS); |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 128 | |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 129 | // Replace store delegate to make sure pendingForward and pendingNext are resubmitted to |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 130 | // execute() |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 131 | flowObjectiveStore.unsetDelegate(super.delegate); |
| 132 | flowObjectiveStore.setDelegate(delegate); |
| 133 | } |
| 134 | |
| 135 | @Deactivate |
| 136 | protected void deactivate() { |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 137 | cacheCleaner.shutdown(); |
Charles Chan | 33f4a91 | 2018-04-19 23:35:30 -0700 | [diff] [blame] | 138 | clearQueue(); |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 139 | |
Charles Chan | a724c513 | 2018-11-27 21:33:33 +0800 | [diff] [blame] | 140 | filtCacheEventExecutor.shutdown(); |
| 141 | fwdCacheEventExecutor.shutdown(); |
| 142 | nextCacheEventExecutor.shutdown(); |
| 143 | |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 144 | super.deactivate(); |
| 145 | } |
| 146 | |
| 147 | /** |
| 148 | * Processes given objective on given device. |
| 149 | * Objectives submitted through this method are guaranteed to be executed in order. |
| 150 | * |
| 151 | * @param deviceId Device ID |
| 152 | * @param originalObjective Flow objective to be executed |
| 153 | */ |
| 154 | private void process(DeviceId deviceId, Objective originalObjective) { |
| 155 | // Inject ObjectiveContext such that we can get notified when it is completed |
| 156 | Objective.Builder objBuilder = originalObjective.copy(); |
| 157 | Optional<ObjectiveContext> originalContext = originalObjective.context(); |
Charles Chan | c51852e | 2019-01-07 19:59:10 -0800 | [diff] [blame^] | 158 | ObjectiveContext context = new InOrderObjectiveContext(deviceId, originalContext.orElse(null)); |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 159 | |
| 160 | // Preserve Objective.Operation |
| 161 | Objective objective; |
| 162 | switch (originalObjective.op()) { |
| 163 | case ADD: |
| 164 | objective = objBuilder.add(context); |
| 165 | break; |
| 166 | case ADD_TO_EXISTING: |
| 167 | objective = ((NextObjective.Builder) objBuilder).addToExisting(context); |
| 168 | break; |
| 169 | case REMOVE: |
| 170 | objective = objBuilder.remove(context); |
| 171 | break; |
| 172 | case REMOVE_FROM_EXISTING: |
| 173 | objective = ((NextObjective.Builder) objBuilder).removeFromExisting(context); |
| 174 | break; |
| 175 | case MODIFY: |
| 176 | objective = ((NextObjective.Builder) objBuilder).modify(context); |
| 177 | break; |
| 178 | case VERIFY: |
| 179 | objective = ((NextObjective.Builder) objBuilder).verify(context); |
| 180 | break; |
| 181 | default: |
| 182 | log.error("Unknown flow objecitve operation {}", originalObjective.op()); |
| 183 | return; |
| 184 | } |
| 185 | |
| 186 | enqueue(deviceId, objective); |
| 187 | } |
| 188 | |
| 189 | @Override |
| 190 | public void filter(DeviceId deviceId, FilteringObjective filteringObjective) { |
| 191 | process(deviceId, filteringObjective); |
| 192 | } |
| 193 | |
| 194 | @Override |
| 195 | public void forward(DeviceId deviceId, ForwardingObjective forwardingObjective) { |
| 196 | process(deviceId, forwardingObjective); |
| 197 | } |
| 198 | |
| 199 | @Override |
| 200 | public void next(DeviceId deviceId, NextObjective nextObjective) { |
| 201 | process(deviceId, nextObjective); |
| 202 | } |
| 203 | |
Charles Chan | 33f4a91 | 2018-04-19 23:35:30 -0700 | [diff] [blame] | 204 | @Override |
| 205 | public ListMultimap<FilteringObjQueueKey, Objective> getFilteringObjQueue() { |
| 206 | return filtObjQueue; |
| 207 | } |
| 208 | |
| 209 | @Override |
| 210 | public ListMultimap<ForwardingObjQueueKey, Objective> getForwardingObjQueue() { |
| 211 | return fwdObjQueue; |
| 212 | } |
| 213 | |
| 214 | @Override |
| 215 | public ListMultimap<NextObjQueueKey, Objective> getNextObjQueue() { |
| 216 | return nextObjQueue; |
| 217 | } |
| 218 | |
| 219 | @Override |
| 220 | public Map<FilteringObjQueueKey, Objective> getFilteringObjQueueHead() { |
| 221 | return filtObjQueueHead.asMap(); |
| 222 | } |
| 223 | |
| 224 | @Override |
| 225 | public Map<ForwardingObjQueueKey, Objective> getForwardingObjQueueHead() { |
| 226 | return fwdObjQueueHead.asMap(); |
| 227 | } |
| 228 | |
| 229 | @Override |
| 230 | public Map<NextObjQueueKey, Objective> getNextObjQueueHead() { |
| 231 | return nextObjQueueHead.asMap(); |
| 232 | } |
| 233 | |
| 234 | @Override |
| 235 | public void clearQueue() { |
| 236 | filtObjQueueHead.invalidateAll(); |
| 237 | fwdObjQueueHead.invalidateAll(); |
| 238 | nextObjQueueHead.invalidateAll(); |
| 239 | |
| 240 | filtObjQueueHead.cleanUp(); |
| 241 | fwdObjQueueHead.cleanUp(); |
| 242 | nextObjQueueHead.cleanUp(); |
| 243 | |
| 244 | filtObjQueue.clear(); |
| 245 | fwdObjQueue.clear(); |
| 246 | nextObjQueue.clear(); |
| 247 | } |
| 248 | |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 249 | /** |
| 250 | * Enqueue flow objective. Execute the flow objective if there is no pending objective ahead. |
| 251 | * |
| 252 | * @param deviceId Device ID |
| 253 | * @param obj Flow objective |
| 254 | */ |
| 255 | private synchronized void enqueue(DeviceId deviceId, Objective obj) { |
| 256 | int queueSize; |
| 257 | int priority = obj.priority(); |
| 258 | |
Charles Chan | c09ad6d | 2018-04-04 16:31:23 -0700 | [diff] [blame] | 259 | LogLevel logLevel = (obj.op() == Objective.Operation.VERIFY) ? LogLevel.TRACE : LogLevel.DEBUG; |
| 260 | Tools.log(log, logLevel, "Enqueue {}", obj); |
| 261 | |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 262 | if (obj instanceof FilteringObjective) { |
Charles Chan | 33f4a91 | 2018-04-19 23:35:30 -0700 | [diff] [blame] | 263 | FilteringObjQueueKey k = new FilteringObjQueueKey(deviceId, priority, ((FilteringObjective) obj).key()); |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 264 | filtObjQueue.put(k, obj); |
| 265 | queueSize = filtObjQueue.get(k).size(); |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 266 | } else if (obj instanceof ForwardingObjective) { |
Charles Chan | 33f4a91 | 2018-04-19 23:35:30 -0700 | [diff] [blame] | 267 | ForwardingObjQueueKey k = |
| 268 | new ForwardingObjQueueKey(deviceId, priority, ((ForwardingObjective) obj).selector()); |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 269 | fwdObjQueue.put(k, obj); |
| 270 | queueSize = fwdObjQueue.get(k).size(); |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 271 | } else if (obj instanceof NextObjective) { |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 272 | NextObjQueueKey k = new NextObjQueueKey(deviceId, obj.id()); |
| 273 | nextObjQueue.put(k, obj); |
| 274 | queueSize = nextObjQueue.get(k).size(); |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 275 | } else { |
| 276 | log.error("Unknown flow objective instance: {}", obj.getClass().getName()); |
| 277 | return; |
| 278 | } |
Charles Chan | c09ad6d | 2018-04-04 16:31:23 -0700 | [diff] [blame] | 279 | log.trace("{} queue size {}", obj.getClass().getSimpleName(), queueSize); |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 280 | |
| 281 | // Execute immediately if there is no pending obj ahead |
| 282 | if (queueSize == 1) { |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 283 | execute(deviceId, obj); |
| 284 | } |
| 285 | } |
| 286 | |
| 287 | /** |
| 288 | * Dequeue flow objective. Execute the next flow objective in the queue, if any. |
| 289 | * |
| 290 | * @param deviceId Device ID |
| 291 | * @param obj Flow objective |
Charles Chan | 35b589c | 2018-04-26 16:00:23 -0400 | [diff] [blame] | 292 | * @param error ObjectiveError that triggers this dequeue. Null if this is not triggered by an error. |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 293 | */ |
Charles Chan | 35b589c | 2018-04-26 16:00:23 -0400 | [diff] [blame] | 294 | private synchronized void dequeue(DeviceId deviceId, Objective obj, ObjectiveError error) { |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 295 | List<Objective> remaining; |
| 296 | int priority = obj.priority(); |
| 297 | |
Charles Chan | c09ad6d | 2018-04-04 16:31:23 -0700 | [diff] [blame] | 298 | LogLevel logLevel = (obj.op() == Objective.Operation.VERIFY) ? LogLevel.TRACE : LogLevel.DEBUG; |
| 299 | Tools.log(log, logLevel, "Dequeue {}", obj); |
| 300 | |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 301 | if (obj instanceof FilteringObjective) { |
Charles Chan | 33f4a91 | 2018-04-19 23:35:30 -0700 | [diff] [blame] | 302 | FilteringObjQueueKey k = new FilteringObjQueueKey(deviceId, priority, ((FilteringObjective) obj).key()); |
Charles Chan | a724c513 | 2018-11-27 21:33:33 +0800 | [diff] [blame] | 303 | if (!Objects.equals(ObjectiveError.INSTALLATIONTIMEOUT, error)) { |
Charles Chan | 5cf77f5 | 2018-11-07 15:05:59 -0800 | [diff] [blame] | 304 | filtObjQueueHead.invalidate(k); |
| 305 | } |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 306 | filtObjQueue.remove(k, obj); |
| 307 | remaining = filtObjQueue.get(k); |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 308 | } else if (obj instanceof ForwardingObjective) { |
Charles Chan | 33f4a91 | 2018-04-19 23:35:30 -0700 | [diff] [blame] | 309 | ForwardingObjQueueKey k = |
| 310 | new ForwardingObjQueueKey(deviceId, priority, ((ForwardingObjective) obj).selector()); |
Charles Chan | a724c513 | 2018-11-27 21:33:33 +0800 | [diff] [blame] | 311 | if (!Objects.equals(ObjectiveError.INSTALLATIONTIMEOUT, error)) { |
Charles Chan | 5cf77f5 | 2018-11-07 15:05:59 -0800 | [diff] [blame] | 312 | fwdObjQueueHead.invalidate(k); |
| 313 | } |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 314 | fwdObjQueue.remove(k, obj); |
| 315 | remaining = fwdObjQueue.get(k); |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 316 | } else if (obj instanceof NextObjective) { |
Charles Chan | 35b589c | 2018-04-26 16:00:23 -0400 | [diff] [blame] | 317 | if (error != null) { |
| 318 | // Remove pendingForwards and pendingNexts if next objective failed |
| 319 | Set<PendingFlowObjective> removedForwards = pendingForwards.remove(obj.id()); |
| 320 | List<PendingFlowObjective> removedNexts = pendingNexts.remove(obj.id()); |
| 321 | |
| 322 | if (removedForwards != null) { |
| 323 | removedForwards.stream().map(PendingFlowObjective::flowObjective) |
| 324 | .forEach(pendingObj -> pendingObj.context().ifPresent(c -> |
| 325 | c.onError(pendingObj, error))); |
| 326 | } |
| 327 | if (removedNexts != null) { |
| 328 | removedNexts.stream().map(PendingFlowObjective::flowObjective) |
| 329 | .forEach(pendingObj -> pendingObj.context().ifPresent(c -> |
| 330 | c.onError(pendingObj, error))); |
| 331 | } |
| 332 | } |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 333 | NextObjQueueKey k = new NextObjQueueKey(deviceId, obj.id()); |
Charles Chan | a724c513 | 2018-11-27 21:33:33 +0800 | [diff] [blame] | 334 | if (!Objects.equals(ObjectiveError.INSTALLATIONTIMEOUT, error)) { |
Charles Chan | 5cf77f5 | 2018-11-07 15:05:59 -0800 | [diff] [blame] | 335 | nextObjQueueHead.invalidate(k); |
| 336 | } |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 337 | nextObjQueue.remove(k, obj); |
| 338 | remaining = nextObjQueue.get(k); |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 339 | } else { |
| 340 | log.error("Unknown flow objective instance: {}", obj.getClass().getName()); |
| 341 | return; |
| 342 | } |
Charles Chan | c09ad6d | 2018-04-04 16:31:23 -0700 | [diff] [blame] | 343 | log.trace("{} queue size {}", obj.getClass().getSimpleName(), remaining.size()); |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 344 | |
| 345 | // Submit the next one in the queue, if any |
| 346 | if (remaining.size() > 0) { |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 347 | execute(deviceId, remaining.get(0)); |
| 348 | } |
| 349 | } |
| 350 | |
| 351 | /** |
| 352 | * Submit the flow objective. Starting from this point on, the execution order is not guaranteed. |
| 353 | * Therefore we must be certain that this method is called in-order. |
| 354 | * |
| 355 | * @param deviceId Device ID |
| 356 | * @param obj Flow objective |
| 357 | */ |
| 358 | private void execute(DeviceId deviceId, Objective obj) { |
Charles Chan | c09ad6d | 2018-04-04 16:31:23 -0700 | [diff] [blame] | 359 | LogLevel logLevel = (obj.op() == Objective.Operation.VERIFY) ? LogLevel.TRACE : LogLevel.DEBUG; |
| 360 | Tools.log(log, logLevel, "Submit objective installer, deviceId {}, obj {}", deviceId, obj); |
| 361 | |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 362 | int priority = obj.priority(); |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 363 | if (obj instanceof FilteringObjective) { |
Charles Chan | 33f4a91 | 2018-04-19 23:35:30 -0700 | [diff] [blame] | 364 | FilteringObjQueueKey k = new FilteringObjQueueKey(deviceId, priority, ((FilteringObjective) obj).key()); |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 365 | filtObjQueueHead.put(k, obj); |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 366 | super.filter(deviceId, (FilteringObjective) obj); |
| 367 | } else if (obj instanceof ForwardingObjective) { |
Charles Chan | 33f4a91 | 2018-04-19 23:35:30 -0700 | [diff] [blame] | 368 | ForwardingObjQueueKey k = |
| 369 | new ForwardingObjQueueKey(deviceId, priority, ((ForwardingObjective) obj).selector()); |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 370 | fwdObjQueueHead.put(k, obj); |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 371 | super.forward(deviceId, (ForwardingObjective) obj); |
| 372 | } else if (obj instanceof NextObjective) { |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 373 | NextObjQueueKey k = new NextObjQueueKey(deviceId, obj.id()); |
| 374 | nextObjQueueHead.put(k, obj); |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 375 | super.next(deviceId, (NextObjective) obj); |
| 376 | } else { |
| 377 | log.error("Unknown flow objective instance: {}", obj.getClass().getName()); |
| 378 | } |
| 379 | } |
| 380 | |
| 381 | private class InternalStoreDelegate implements FlowObjectiveStoreDelegate { |
| 382 | @Override |
| 383 | public void notify(ObjectiveEvent event) { |
| 384 | if (event.type() == ObjectiveEvent.Type.ADD) { |
| 385 | log.debug("Received notification of obj event {}", event); |
| 386 | Set<PendingFlowObjective> pending; |
| 387 | |
| 388 | // first send all pending flows |
| 389 | synchronized (pendingForwards) { |
| 390 | // needs to be synchronized for queueObjective lookup |
| 391 | pending = pendingForwards.remove(event.subject()); |
| 392 | } |
| 393 | if (pending == null) { |
Charles Chan | c09ad6d | 2018-04-04 16:31:23 -0700 | [diff] [blame] | 394 | log.debug("No forwarding objectives pending for this obj event {}", event); |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 395 | } else { |
| 396 | log.debug("Processing {} pending forwarding objectives for nextId {}", |
| 397 | pending.size(), event.subject()); |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 398 | // execute pending forwards one by one |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 399 | pending.forEach(p -> execute(p.deviceId(), p.flowObjective())); |
| 400 | } |
| 401 | |
| 402 | // now check for pending next-objectives |
| 403 | // Note: This is still necessary despite the existence of in-order execution. |
| 404 | // Since the in-order execution does not handle the case of |
| 405 | // ADD_TO_EXISTING coming before ADD |
| 406 | List<PendingFlowObjective> pendNexts; |
| 407 | synchronized (pendingNexts) { |
| 408 | // needs to be synchronized for queueObjective lookup |
| 409 | pendNexts = pendingNexts.remove(event.subject()); |
| 410 | } |
| 411 | if (pendNexts == null) { |
Charles Chan | c09ad6d | 2018-04-04 16:31:23 -0700 | [diff] [blame] | 412 | log.debug("No next objectives pending for this obj event {}", event); |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 413 | } else { |
| 414 | log.debug("Processing {} pending next objectives for nextId {}", |
| 415 | pendNexts.size(), event.subject()); |
Charles Chan | 45c19d7 | 2018-04-19 21:38:40 -0700 | [diff] [blame] | 416 | // execute pending nexts one by one |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 417 | pendNexts.forEach(p -> execute(p.deviceId(), p.flowObjective())); |
| 418 | } |
| 419 | } |
| 420 | } |
| 421 | } |
Charles Chan | c51852e | 2019-01-07 19:59:10 -0800 | [diff] [blame^] | 422 | |
| 423 | final class InOrderObjectiveContext implements ObjectiveContext { |
| 424 | private final DeviceId deviceId; |
| 425 | private final ObjectiveContext originalContext; |
| 426 | // Prevent context from being executed multiple times. |
| 427 | // E.g. when the context actually succeed after the cache timeout |
| 428 | private final AtomicBoolean done; |
| 429 | |
| 430 | InOrderObjectiveContext(DeviceId deviceId, ObjectiveContext originalContext) { |
| 431 | this.deviceId = deviceId; |
| 432 | this.originalContext = originalContext; |
| 433 | this.done = new AtomicBoolean(false); |
| 434 | } |
| 435 | |
| 436 | @Override |
| 437 | public void onSuccess(Objective objective) { |
| 438 | log.trace("Flow objective onSuccess {}", objective); |
| 439 | |
| 440 | if (!done.getAndSet(true)) { |
| 441 | dequeue(deviceId, objective, null); |
| 442 | if (originalContext != null) { |
| 443 | originalContext.onSuccess(objective); |
| 444 | } |
| 445 | } |
| 446 | |
| 447 | } |
| 448 | @Override |
| 449 | public void onError(Objective objective, ObjectiveError error) { |
| 450 | log.warn("Flow objective onError {}. Reason = {}", objective, error); |
| 451 | |
| 452 | if (!done.getAndSet(true)) { |
| 453 | dequeue(deviceId, objective, error); |
| 454 | if (originalContext != null) { |
| 455 | originalContext.onError(objective, error); |
| 456 | } |
| 457 | } |
| 458 | } |
| 459 | } |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 460 | } |