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