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