2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.controller.forwardingrulesmanager.internal;
11 import java.io.FileNotFoundException;
12 import java.io.IOException;
13 import java.io.ObjectInputStream;
14 import java.net.InetAddress;
15 import java.net.UnknownHostException;
16 import java.util.ArrayList;
17 import java.util.Collections;
18 import java.util.EnumSet;
19 import java.util.HashSet;
20 import java.util.List;
22 import java.util.Map.Entry;
24 import java.util.concurrent.BlockingQueue;
25 import java.util.concurrent.Callable;
26 import java.util.concurrent.ConcurrentHashMap;
27 import java.util.concurrent.ConcurrentMap;
28 import java.util.concurrent.ExecutionException;
29 import java.util.concurrent.ExecutorService;
30 import java.util.concurrent.Executors;
31 import java.util.concurrent.LinkedBlockingQueue;
33 import org.eclipse.osgi.framework.console.CommandInterpreter;
34 import org.eclipse.osgi.framework.console.CommandProvider;
35 import org.opendaylight.controller.clustering.services.CacheConfigException;
36 import org.opendaylight.controller.clustering.services.CacheExistException;
37 import org.opendaylight.controller.clustering.services.ICacheUpdateAware;
38 import org.opendaylight.controller.clustering.services.IClusterContainerServices;
39 import org.opendaylight.controller.clustering.services.IClusterServices;
40 import org.opendaylight.controller.configuration.IConfigurationContainerAware;
41 import org.opendaylight.controller.connectionmanager.IConnectionManager;
42 import org.opendaylight.controller.forwardingrulesmanager.FlowConfig;
43 import org.opendaylight.controller.forwardingrulesmanager.FlowEntry;
44 import org.opendaylight.controller.forwardingrulesmanager.FlowEntryInstall;
45 import org.opendaylight.controller.forwardingrulesmanager.IForwardingRulesManager;
46 import org.opendaylight.controller.forwardingrulesmanager.IForwardingRulesManagerAware;
47 import org.opendaylight.controller.forwardingrulesmanager.PortGroup;
48 import org.opendaylight.controller.forwardingrulesmanager.PortGroupChangeListener;
49 import org.opendaylight.controller.forwardingrulesmanager.PortGroupConfig;
50 import org.opendaylight.controller.forwardingrulesmanager.PortGroupProvider;
51 import org.opendaylight.controller.forwardingrulesmanager.implementation.data.FlowEntryDistributionOrder;
52 import org.opendaylight.controller.sal.action.Action;
53 import org.opendaylight.controller.sal.action.ActionType;
54 import org.opendaylight.controller.sal.action.Controller;
55 import org.opendaylight.controller.sal.action.Flood;
56 import org.opendaylight.controller.sal.action.Output;
57 import org.opendaylight.controller.sal.action.PopVlan;
58 import org.opendaylight.controller.sal.connection.ConnectionLocality;
59 import org.opendaylight.controller.sal.core.Config;
60 import org.opendaylight.controller.sal.core.ContainerFlow;
61 import org.opendaylight.controller.sal.core.IContainer;
62 import org.opendaylight.controller.sal.core.IContainerLocalListener;
63 import org.opendaylight.controller.sal.core.Node;
64 import org.opendaylight.controller.sal.core.NodeConnector;
65 import org.opendaylight.controller.sal.core.Property;
66 import org.opendaylight.controller.sal.core.UpdateType;
67 import org.opendaylight.controller.sal.flowprogrammer.Flow;
68 import org.opendaylight.controller.sal.flowprogrammer.IFlowProgrammerListener;
69 import org.opendaylight.controller.sal.flowprogrammer.IFlowProgrammerService;
70 import org.opendaylight.controller.sal.match.Match;
71 import org.opendaylight.controller.sal.match.MatchType;
72 import org.opendaylight.controller.sal.utils.EtherTypes;
73 import org.opendaylight.controller.sal.utils.GlobalConstants;
74 import org.opendaylight.controller.sal.utils.HexEncode;
75 import org.opendaylight.controller.sal.utils.IObjectReader;
76 import org.opendaylight.controller.sal.utils.IPProtocols;
77 import org.opendaylight.controller.sal.utils.NodeConnectorCreator;
78 import org.opendaylight.controller.sal.utils.NodeCreator;
79 import org.opendaylight.controller.sal.utils.ObjectReader;
80 import org.opendaylight.controller.sal.utils.ObjectWriter;
81 import org.opendaylight.controller.sal.utils.Status;
82 import org.opendaylight.controller.sal.utils.StatusCode;
83 import org.opendaylight.controller.switchmanager.IInventoryListener;
84 import org.opendaylight.controller.switchmanager.ISwitchManager;
85 import org.opendaylight.controller.switchmanager.ISwitchManagerAware;
86 import org.opendaylight.controller.switchmanager.Subnet;
87 import org.osgi.framework.BundleContext;
88 import org.osgi.framework.FrameworkUtil;
89 import org.slf4j.Logger;
90 import org.slf4j.LoggerFactory;
93 * Class that manages forwarding rule installation and removal per container of
94 * the network. It also maintains the central repository of all the forwarding
95 * rules installed on the network nodes.
97 public class ForwardingRulesManager implements
98 IForwardingRulesManager,
99 PortGroupChangeListener,
100 IContainerLocalListener,
102 IConfigurationContainerAware,
105 ICacheUpdateAware<Object,Object>,
107 IFlowProgrammerListener {
108 private static final String NODEDOWN = "Node is Down";
109 private static final String SUCCESS = StatusCode.SUCCESS.toString();
110 private static final Logger log = LoggerFactory.getLogger(ForwardingRulesManager.class);
111 private static final String PORTREMOVED = "Port removed";
112 private static final Logger logsync = LoggerFactory.getLogger("FRMsync");
113 private String frmFileName;
114 private String portGroupFileName;
115 private ConcurrentMap<Integer, FlowConfig> staticFlows;
116 private ConcurrentMap<Integer, Integer> staticFlowsOrdinal;
117 private ConcurrentMap<String, PortGroupConfig> portGroupConfigs;
118 private ConcurrentMap<PortGroupConfig, Map<Node, PortGroup>> portGroupData;
119 private ConcurrentMap<String, Object> TSPolicies;
120 private boolean inContainerMode; // being used by global instance only
121 protected boolean stopping;
124 * Flow database. It's the software view of what was requested to install
125 * and what is installed on the switch. It is indexed by the entry itself.
126 * The entry's hashcode resumes the network node index, the flow's priority
127 * and the flow's match. The value element is a class which contains the
128 * flow entry pushed by the applications modules and the respective
129 * container flow merged version. In absence of container flows, the two
130 * flow entries are the same.
132 private ConcurrentMap<FlowEntry, FlowEntry> originalSwView;
133 private ConcurrentMap<FlowEntryInstall, FlowEntryInstall> installedSwView;
135 * Per node and per group indexing
137 private ConcurrentMap<Node, List<FlowEntryInstall>> nodeFlows;
138 private ConcurrentMap<String, List<FlowEntryInstall>> groupFlows;
141 * Inactive flow list. This is for the global instance of FRM It will
142 * contain all the flow entries which were installed on the global container
143 * when the first container is created.
145 private ConcurrentMap<FlowEntry, FlowEntry> inactiveFlows;
147 private IContainer container;
148 private Set<IForwardingRulesManagerAware> frmAware =
149 Collections.synchronizedSet(new HashSet<IForwardingRulesManagerAware>());
150 private PortGroupProvider portGroupProvider;
151 private IFlowProgrammerService programmer;
152 private IClusterContainerServices clusterContainerService = null;
153 private ISwitchManager switchManager;
154 private Thread frmEventHandler;
155 protected BlockingQueue<FRMEvent> pendingEvents;
157 // Distributes FRM programming in the cluster
158 private IConnectionManager connectionManager;
161 * Name clustered caches used to support FRM entry distribution these are by
162 * necessity non-transactional as long as need to be able to synchronize
163 * states also while a transaction is in progress
165 static final String WORKORDERCACHE = "frm.workOrder";
166 static final String WORKSTATUSCACHE = "frm.workStatus";
169 * Data structure responsible for distributing the FlowEntryInstall requests
170 * in the cluster. The key value is entry that is being either Installed or
171 * Updated or Delete. The value field is the same of the key value in case
172 * of Installation or Deletion, it's the new entry in case of Modification,
173 * this because the clustering caches don't allow null values.
175 * The logic behind this data structure is that the controller that initiate
176 * the request will place the order here, someone will pick it and then will
177 * remove from this data structure because is being served.
179 * TODO: We need to have a way to cleanup this data structure if entries are
180 * not picked by anyone, which is always a case can happen especially on
181 * Node disconnect cases.
183 protected ConcurrentMap<FlowEntryDistributionOrder, FlowEntryInstall> workOrder;
186 * Data structure responsible for retrieving the results of the workOrder
187 * submitted to the cluster.
189 * The logic behind this data structure is that the controller that has
190 * executed the order will then place the result in workStatus signaling
191 * that there was a success or a failure.
193 * TODO: The workStatus entries need to have a lifetime associated in case
194 * of requestor controller leaving the cluster.
196 protected ConcurrentMap<FlowEntryDistributionOrder, Status> workStatus;
199 * Local Map used to hold the Future which a caller can use to monitor for
202 private ConcurrentMap<FlowEntryDistributionOrder, FlowEntryDistributionOrderFutureTask> workMonitor =
203 new ConcurrentHashMap<FlowEntryDistributionOrder, FlowEntryDistributionOrderFutureTask>();
207 * Entry being installed/updated/removed
209 * New entry will be placed after the update operation. Valid
210 * only for UpdateType.CHANGED, null for all the other cases
213 * @return a Future object for monitoring the progress of the result, or
214 * null in case the processing should take place locally
216 private FlowEntryDistributionOrderFutureTask distributeWorkOrder(FlowEntryInstall e, FlowEntryInstall u,
218 // A null entry it's an unexpected condition, anyway it's safe to keep
219 // the handling local
224 Node n = e.getNode();
225 if (connectionManager.getLocalityStatus(n) == ConnectionLocality.NOT_LOCAL) {
226 // Create the work order and distribute it
227 FlowEntryDistributionOrder fe =
228 new FlowEntryDistributionOrder(e, t, clusterContainerService.getMyAddress());
229 // First create the monitor job
230 FlowEntryDistributionOrderFutureTask ret = new FlowEntryDistributionOrderFutureTask(fe);
231 logsync.trace("Node {} not local so sending fe {}", n, fe);
232 workMonitor.put(fe, ret);
233 if (t.equals(UpdateType.CHANGED)) {
234 // Then distribute the work
235 workOrder.put(fe, u);
237 // Then distribute the work
238 workOrder.put(fe, e);
240 logsync.trace("WorkOrder requested");
241 // Now create an Handle to monitor the execution of the operation
245 logsync.trace("Node {} could be local. so processing Entry:{} UpdateType:{}", n, e, t);
250 * Adds a flow entry onto the network node It runs various validity checks
251 * and derive the final container flows merged entries that will be
252 * attempted to be installed
255 * the original flow entry application requested to add
257 * the flag indicating if this is a asynchronous request
258 * @return the status of this request. In case of asynchronous call, it will
259 * contain the unique id assigned to this request
261 private Status addEntry(FlowEntry flowEntry, boolean async) {
264 if (flowEntry == null || flowEntry.getNode() == null) {
265 String msg = "Invalid FlowEntry";
266 String logMsg = msg + ": {}";
267 log.warn(logMsg, flowEntry);
268 return new Status(StatusCode.NOTACCEPTABLE, msg);
272 * Derive the container flow merged entries to install In presence of N
273 * container flows, we may end up with N different entries to install...
275 List<FlowEntryInstall> toInstallList = deriveInstallEntries(flowEntry.clone(), container.getContainerFlows());
277 // Container Flow conflict Check
278 if (toInstallList.isEmpty()) {
279 String msg = "Flow Entry conflicts with all Container Flows";
280 String logMsg = msg + ": {}";
281 log.warn(logMsg, flowEntry);
282 return new Status(StatusCode.CONFLICT, msg);
285 // Derive the list of entries good to be installed
286 List<FlowEntryInstall> toInstallSafe = new ArrayList<FlowEntryInstall>();
287 for (FlowEntryInstall entry : toInstallList) {
288 // Conflict Check: Verify new entry would not overwrite existing
290 if (this.installedSwView.containsKey(entry)) {
291 log.warn("Operation Rejected: A flow with same match and priority exists on the target node");
292 log.trace("Aborting to install {}", entry);
295 toInstallSafe.add(entry);
298 // Declare failure if all the container flow merged entries clash with
300 if (toInstallSafe.size() == 0) {
301 String msg = "A flow with same match and priority exists on the target node";
302 String logMsg = msg + ": {}";
303 log.warn(logMsg, flowEntry);
304 return new Status(StatusCode.CONFLICT, msg);
307 // Try to install an entry at the time
308 Status error = new Status(null, null);
309 Status succeded = null;
310 boolean oneSucceded = false;
311 for (FlowEntryInstall installEntry : toInstallSafe) {
313 // Install and update database
314 Status ret = addEntriesInternal(installEntry, async);
316 if (ret.isSuccess()) {
319 * The first successful status response will be returned For the
320 * asynchronous call, we can discard the container flow
321 * complication for now and assume we will always deal with one
322 * flow only per request
327 log.warn("Failed to install the entry: {}. The failure is: {}", installEntry, ret.getDescription());
331 return (oneSucceded) ? succeded : error;
335 * Given a flow entry and the list of container flows, it returns the list
336 * of container flow merged flow entries good to be installed on this
337 * container. If the list of container flows is null or empty, the install
338 * entry list will contain only one entry, the original flow entry. If the
339 * flow entry is congruent with all the N container flows, then the output
340 * install entry list will contain N entries. If the output list is empty,
341 * it means the passed flow entry conflicts with all the container flows.
344 * The list of container flows
345 * @return the list of container flow merged entries good to be installed on
348 private List<FlowEntryInstall> deriveInstallEntries(FlowEntry request, List<ContainerFlow> cFlowList) {
349 List<FlowEntryInstall> toInstallList = new ArrayList<FlowEntryInstall>(1);
351 if (container.getContainerFlows() == null || container.getContainerFlows().isEmpty()) {
352 // No container flows => entry good to be installed unchanged
353 toInstallList.add(new FlowEntryInstall(request.clone(), null));
355 // Create the list of entries to be installed. If the flow entry is
356 // not congruent with any container flow, no install entries will be
358 for (ContainerFlow cFlow : container.getContainerFlows()) {
359 if (cFlow.allowsFlow(request.getFlow())) {
360 toInstallList.add(new FlowEntryInstall(request.clone(), cFlow));
364 return toInstallList;
368 * Modify a flow entry with a new one It runs various validity check and
369 * derive the final container flows merged flow entries to work with
371 * @param currentFlowEntry
372 * @param newFlowEntry
374 * the flag indicating if this is a asynchronous request
375 * @return the status of this request. In case of asynchronous call, it will
376 * contain the unique id assigned to this request
378 private Status modifyEntry(FlowEntry currentFlowEntry, FlowEntry newFlowEntry, boolean async) {
382 if (currentFlowEntry == null || currentFlowEntry.getNode() == null || newFlowEntry == null
383 || newFlowEntry.getNode() == null) {
384 String msg = "Modify: Invalid FlowEntry";
385 String logMsg = msg + ": {} or {}";
386 log.warn(logMsg, currentFlowEntry, newFlowEntry);
387 return new Status(StatusCode.NOTACCEPTABLE, msg);
389 if (!currentFlowEntry.getNode().equals(newFlowEntry.getNode())
390 || !currentFlowEntry.getFlowName().equals(newFlowEntry.getFlowName())) {
391 String msg = "Modify: Incompatible Flow Entries";
392 String logMsg = msg + ": {} and {}";
393 log.warn(logMsg, currentFlowEntry, newFlowEntry);
394 return new Status(StatusCode.NOTACCEPTABLE, msg);
398 if (currentFlowEntry.getFlow().equals(newFlowEntry.getFlow())) {
399 String msg = "Modify skipped as flows are the same";
400 String logMsg = msg + ": {} and {}";
401 log.debug(logMsg, currentFlowEntry, newFlowEntry);
402 return new Status(StatusCode.SUCCESS, msg);
406 * Conflict Check: Verify the new entry would not conflict with an
407 * existing one. This is a loose check on the previous original flow
408 * entry requests. No check on the container flow merged flow entries
411 FlowEntry sameMatchOriginalEntry = originalSwView.get(newFlowEntry);
412 if (sameMatchOriginalEntry != null && !sameMatchOriginalEntry.equals(currentFlowEntry)) {
413 String msg = "Operation Rejected: Another flow with same match and priority exists on the target node";
414 String logMsg = msg + ": {}";
415 log.warn(logMsg, currentFlowEntry);
416 return new Status(StatusCode.CONFLICT, msg);
419 // Derive the installed and toInstall entries
420 List<FlowEntryInstall> installedList = deriveInstallEntries(currentFlowEntry.clone(),
421 container.getContainerFlows());
422 List<FlowEntryInstall> toInstallList = deriveInstallEntries(newFlowEntry.clone(), container.getContainerFlows());
424 if (toInstallList.isEmpty()) {
425 String msg = "Modify Operation Rejected: The new entry conflicts with all the container flows";
426 String logMsg = msg + ": {}";
427 log.warn(logMsg, newFlowEntry);
429 return new Status(StatusCode.CONFLICT, msg);
433 * If the two list sizes differ, it means the new flow entry does not
434 * satisfy the same number of container flows the current entry does.
435 * This is only possible when the new entry and current entry have
436 * different match. In this scenario the modification would ultimately
437 * be handled as a remove and add operations in the protocol plugin.
439 * Also, if any of the new flow entries would clash with an existing
440 * one, we cannot proceed with the modify operation, because it would
441 * fail for some entries and leave stale entries on the network node.
442 * Modify path can be taken only if it can be performed completely, for
445 * So, for the above two cases, to simplify, let's decouple the modify
446 * in: 1) remove current entries 2) install new entries
448 Status succeeded = null;
449 boolean decouple = false;
450 if (installedList.size() != toInstallList.size()) {
451 log.info("Modify: New flow entry does not satisfy the same "
452 + "number of container flows as the original entry does");
455 List<FlowEntryInstall> toInstallSafe = new ArrayList<FlowEntryInstall>();
456 for (FlowEntryInstall installEntry : toInstallList) {
458 * Conflict Check: Verify the new entry would not overwrite another
461 FlowEntryInstall sameMatchEntry = installedSwView.get(installEntry);
462 if (sameMatchEntry != null && !sameMatchEntry.getOriginal().equals(currentFlowEntry)) {
463 log.info("Modify: new container flow merged flow entry clashes with existing flow");
466 toInstallSafe.add(installEntry);
471 // Remove current entries
472 for (FlowEntryInstall currEntry : installedList) {
473 this.removeEntryInternal(currEntry, async);
475 // Install new entries
476 for (FlowEntryInstall newEntry : toInstallSafe) {
477 succeeded = this.addEntriesInternal(newEntry, async);
481 * The two list have the same size and the entries to install do not
482 * clash with any existing flow on the network node. We assume here
483 * (and might be wrong) that the same container flows that were
484 * satisfied by the current entries are the same that are satisfied
485 * by the new entries. Let's take the risk for now.
487 * Note: modification has to be complete. If any entry modification
488 * fails, we need to stop, restore the already modified entries, and
491 Status retModify = null;
493 int size = toInstallList.size();
495 // Modify and update database
496 retModify = modifyEntryInternal(installedList.get(i), toInstallList.get(i), async);
497 if (retModify.isSuccess()) {
503 // Check if uncompleted modify
505 log.warn("Unable to perform a complete modify for all the container flows merged entries");
506 // Restore original entries
509 log.info("Attempting to restore initial entries");
510 retExt = modifyEntryInternal(toInstallList.get(i), installedList.get(i), async);
511 if (retExt.isSuccess()) {
517 // Fatal error, recovery failed
519 String msg = "Flow recovery failed ! Unrecoverable Error";
521 return new Status(StatusCode.INTERNALERROR, msg);
524 succeeded = retModify;
527 * The first successful status response will be returned. For the
528 * asynchronous call, we can discard the container flow complication for
529 * now and assume we will always deal with one flow only per request
535 * This is the function that modifies the final container flows merged
536 * entries on the network node and update the database. It expects that all
537 * the validity checks are passed
539 * @param currentEntries
542 * the flag indicating if this is a asynchronous request
543 * @return the status of this request. In case of asynchronous call, it will
544 * contain the unique id assigned to this request
546 private Status modifyEntryInternal(FlowEntryInstall currentEntries, FlowEntryInstall newEntries, boolean async) {
547 FlowEntryDistributionOrderFutureTask futureStatus =
548 distributeWorkOrder(currentEntries, newEntries, UpdateType.CHANGED);
549 if (futureStatus != null) {
550 Status retStatus = new Status(StatusCode.UNDEFINED);
552 retStatus = futureStatus.get();
553 if (retStatus.getCode()
554 .equals(StatusCode.TIMEOUT)) {
555 // A timeout happened, lets cleanup the workMonitor
556 workMonitor.remove(futureStatus.getOrder());
558 } catch (InterruptedException e) {
560 } catch (ExecutionException e) {
565 // Modify the flow on the network node
566 Status status = async ? programmer.modifyFlowAsync(currentEntries.getNode(), currentEntries.getInstall()
567 .getFlow(), newEntries.getInstall()
568 .getFlow()) : programmer.modifyFlow(currentEntries.getNode(), currentEntries.getInstall()
569 .getFlow(), newEntries.getInstall()
572 if (!status.isSuccess()) {
573 log.warn("SDN Plugin failed to program the flow: {}. The failure is: {}", newEntries.getInstall(),
574 status.getDescription());
578 log.trace("Modified {} => {}", currentEntries.getInstall(), newEntries.getInstall());
581 newEntries.setRequestId(status.getRequestId());
582 updateLocalDatabase(currentEntries, false);
583 updateLocalDatabase(newEntries, true);
590 * Remove a flow entry. If the entry is not present in the software view
591 * (entry or node not present), it return successfully
594 * the flow entry to remove
596 * the flag indicating if this is a asynchronous request
597 * @return the status of this request. In case of asynchronous call, it will
598 * contain the unique id assigned to this request
600 private Status removeEntry(FlowEntry flowEntry, boolean async) {
601 Status error = new Status(null, null);
604 if (flowEntry == null || flowEntry.getNode() == null) {
605 String msg = "Invalid FlowEntry";
606 String logMsg = msg + ": {}";
607 log.warn(logMsg, flowEntry);
608 return new Status(StatusCode.NOTACCEPTABLE, msg);
611 // Derive the container flows merged installed entries
612 List<FlowEntryInstall> installedList = deriveInstallEntries(flowEntry.clone(), container.getContainerFlows());
614 Status succeeded = null;
615 boolean atLeastOneRemoved = false;
616 for (FlowEntryInstall entry : installedList) {
617 if (!installedSwView.containsKey(entry)) {
618 String logMsg = "Removal skipped (not present in software view) for flow entry: {}";
619 log.debug(logMsg, flowEntry);
620 if (installedList.size() == 1) {
621 // If we had only one entry to remove, we are done
622 return new Status(StatusCode.SUCCESS);
628 // Remove and update DB
629 Status ret = removeEntryInternal(entry, async);
631 if (!ret.isSuccess()) {
633 log.warn("Failed to remove the entry: {}. The failure is: {}", entry.getInstall(), ret.getDescription());
634 if (installedList.size() == 1) {
635 // If we had only one entry to remove, this is fatal failure
640 atLeastOneRemoved = true;
645 * No worries if full removal failed. Consistency checker will take care
646 * of removing the stale entries later, or adjusting the software
647 * database if not in sync with hardware
649 return (atLeastOneRemoved) ? succeeded : error;
653 * This is the function that removes the final container flows merged entry
654 * from the network node and update the database. It expects that all the
655 * validity checks are passed
658 * the flow entry to remove
660 * the flag indicating if this is a asynchronous request
661 * @return the status of this request. In case of asynchronous call, it will
662 * contain the unique id assigned to this request
664 private Status removeEntryInternal(FlowEntryInstall entry, boolean async) {
665 FlowEntryDistributionOrderFutureTask futureStatus = distributeWorkOrder(entry, null, UpdateType.REMOVED);
666 if (futureStatus != null) {
667 Status retStatus = new Status(StatusCode.UNDEFINED);
669 retStatus = futureStatus.get();
670 if (retStatus.getCode()
671 .equals(StatusCode.TIMEOUT)) {
672 // A timeout happened, lets cleanup the workMonitor
673 workMonitor.remove(futureStatus.getOrder());
675 } catch (InterruptedException e) {
677 } catch (ExecutionException e) {
682 // Mark the entry to be deleted (for CC just in case we fail)
686 Status status = async ? programmer.removeFlowAsync(entry.getNode(), entry.getInstall()
687 .getFlow()) : programmer.removeFlow(entry.getNode(), entry.getInstall()
690 if (!status.isSuccess()) {
691 log.warn("SDN Plugin failed to program the flow: {}. The failure is: {}", entry.getInstall(),
692 status.getDescription());
695 log.trace("Removed {}", entry.getInstall());
698 updateLocalDatabase(entry, false);
705 * This is the function that installs the final container flow merged entry
706 * on the network node and updates the database. It expects that all the
707 * validity and conflict checks are passed. That means it does not check
708 * whether this flow would conflict or overwrite an existing one.
711 * the flow entry to install
713 * the flag indicating if this is a asynchronous request
714 * @return the status of this request. In case of asynchronous call, it will
715 * contain the unique id assigned to this request
717 private Status addEntriesInternal(FlowEntryInstall entry, boolean async) {
718 FlowEntryDistributionOrderFutureTask futureStatus = distributeWorkOrder(entry, null, UpdateType.ADDED);
719 if (futureStatus != null) {
720 Status retStatus = new Status(StatusCode.UNDEFINED);
722 retStatus = futureStatus.get();
723 if (retStatus.getCode()
724 .equals(StatusCode.TIMEOUT)) {
725 // A timeout happened, lets cleanup the workMonitor
726 workMonitor.remove(futureStatus.getOrder());
728 } catch (InterruptedException e) {
730 } catch (ExecutionException e) {
735 // Install the flow on the network node
736 Status status = async ? programmer.addFlowAsync(entry.getNode(), entry.getInstall()
737 .getFlow()) : programmer.addFlow(entry.getNode(), entry.getInstall()
740 if (!status.isSuccess()) {
741 log.warn("SDN Plugin failed to program the flow: {}. The failure is: {}", entry.getInstall(),
742 status.getDescription());
746 log.trace("Added {}", entry.getInstall());
749 entry.setRequestId(status.getRequestId());
750 updateLocalDatabase(entry, true);
757 * Returns true if the flow conflicts with all the container's flows. This
758 * means that if the function returns true, the passed flow entry is
759 * congruent with at least one container flow, hence it is good to be
760 * installed on this container.
763 * @return true if flow conflicts with all the container flows, false
766 private boolean entryConflictsWithContainerFlows(FlowEntry flowEntry) {
767 List<ContainerFlow> cFlowList = container.getContainerFlows();
769 // Validity check and avoid unnecessary computation
770 // Also takes care of default container where no container flows are
772 if (cFlowList == null || cFlowList.isEmpty()) {
776 for (ContainerFlow cFlow : cFlowList) {
777 if (cFlow.allowsFlow(flowEntry.getFlow())) {
778 // Entry is allowed by at least one container flow: good to go
785 private ConcurrentMap.Entry<Integer, FlowConfig> getStaticFlowEntry(String name, Node node) {
786 for (ConcurrentMap.Entry<Integer, FlowConfig> flowEntry : staticFlows.entrySet()) {
787 FlowConfig flowConfig = flowEntry.getValue();
788 if (flowConfig.isByNameAndNodeIdEqual(name, node)) {
795 private void updateLocalDatabase(FlowEntryInstall entry, boolean add) {
796 // Update the software view
797 updateSwViewes(entry, add);
799 // Update node indexed flow database
800 updateNodeFlowsDB(entry, add);
802 // Update group indexed flow database
803 updateGroupFlowsDB(entry, add);
807 * Update the node mapped flows database
809 private void updateSwViewes(FlowEntryInstall flowEntries, boolean add) {
811 originalSwView.put(flowEntries.getOriginal(), flowEntries.getOriginal());
812 installedSwView.put(flowEntries, flowEntries);
814 originalSwView.remove(flowEntries.getOriginal());
815 installedSwView.remove(flowEntries);
820 * Update the node mapped flows database
822 private void updateNodeFlowsDB(FlowEntryInstall flowEntries, boolean add) {
823 Node node = flowEntries.getNode();
825 List<FlowEntryInstall> nodeIndeces = this.nodeFlows.get(node);
826 if (nodeIndeces == null) {
830 nodeIndeces = new ArrayList<FlowEntryInstall>();
835 nodeIndeces.add(flowEntries);
837 nodeIndeces.remove(flowEntries);
840 // Update cache across cluster
841 if (nodeIndeces.isEmpty()) {
842 this.nodeFlows.remove(node);
844 this.nodeFlows.put(node, nodeIndeces);
849 * Update the group name mapped flows database
851 private void updateGroupFlowsDB(FlowEntryInstall flowEntries, boolean add) {
852 String groupName = flowEntries.getGroupName();
854 // Flow may not be part of a group
855 if (groupName == null) {
859 List<FlowEntryInstall> indices = this.groupFlows.get(groupName);
860 if (indices == null) {
864 indices = new ArrayList<FlowEntryInstall>();
869 indices.add(flowEntries);
871 indices.remove(flowEntries);
874 // Update cache across cluster
875 if (indices.isEmpty()) {
876 this.groupFlows.remove(groupName);
878 this.groupFlows.put(groupName, indices);
883 * Remove a flow entry that has been added previously First checks if the
884 * entry is effectively present in the local database
886 @SuppressWarnings("unused")
887 private Status removeEntry(Node node, String flowName) {
888 FlowEntryInstall target = null;
891 for (FlowEntryInstall entry : installedSwView.values()) {
892 if (entry.equalsByNodeAndName(node, flowName)) {
898 // If it is not there, stop any further processing
899 if (target == null) {
900 return new Status(StatusCode.SUCCESS, "Entry is not present");
904 Status status = programmer.removeFlow(target.getNode(), target.getInstall().getFlow());
907 if (status.isSuccess()) {
908 updateLocalDatabase(target, false);
911 log.warn("SDN Plugin failed to remove the flow: {}. The failure is: {}", target.getInstall(),
912 status.getDescription());
919 public Status installFlowEntry(FlowEntry flowEntry) {
921 if (isContainerModeAllowed(flowEntry)) {
922 status = addEntry(flowEntry, false);
924 String msg = "Controller in container mode: Install Refused";
925 String logMsg = msg + ": {}";
926 status = new Status(StatusCode.NOTACCEPTABLE, msg);
927 log.warn(logMsg, flowEntry);
933 public Status installFlowEntryAsync(FlowEntry flowEntry) {
935 if (isContainerModeAllowed(flowEntry)) {
936 status = addEntry(flowEntry, true);
938 String msg = "Controller in container mode: Install Refused";
939 status = new Status(StatusCode.NOTACCEPTABLE, msg);
946 public Status uninstallFlowEntry(FlowEntry flowEntry) {
948 if (isContainerModeAllowed(flowEntry)) {
949 status = removeEntry(flowEntry, false);
951 String msg = "Controller in container mode: Uninstall Refused";
952 String logMsg = msg + ": {}";
953 status = new Status(StatusCode.NOTACCEPTABLE, msg);
954 log.warn(logMsg, flowEntry);
960 public Status uninstallFlowEntryAsync(FlowEntry flowEntry) {
962 if (isContainerModeAllowed(flowEntry)) {
963 status = removeEntry(flowEntry, true);
965 String msg = "Controller in container mode: Uninstall Refused";
966 status = new Status(StatusCode.NOTACCEPTABLE, msg);
973 public Status modifyFlowEntry(FlowEntry currentFlowEntry, FlowEntry newFlowEntry) {
974 Status status = null;
975 if (isContainerModeAllowed(currentFlowEntry)) {
976 status = modifyEntry(currentFlowEntry, newFlowEntry, false);
978 String msg = "Controller in container mode: Modify Refused";
979 String logMsg = msg + ": {}";
980 status = new Status(StatusCode.NOTACCEPTABLE, msg);
981 log.warn(logMsg, newFlowEntry);
987 public Status modifyFlowEntryAsync(FlowEntry currentFlowEntry, FlowEntry newFlowEntry) {
988 Status status = null;
989 if (isContainerModeAllowed(currentFlowEntry)) {
990 status = modifyEntry(currentFlowEntry, newFlowEntry, true);
992 String msg = "Controller in container mode: Modify Refused";
993 status = new Status(StatusCode.NOTACCEPTABLE, msg);
1000 * Returns whether the specified flow entry is allowed to be
1001 * installed/removed/modified based on the current container mode status.
1002 * This call always returns true in the container instance of forwarding
1003 * rules manager. It is meant for the global instance only (default
1004 * container) of forwarding rules manager. Idea is that for assuring
1005 * container isolation of traffic, flow installation in default container is
1006 * blocked when in container mode (containers are present). The only flows
1007 * that are allowed in container mode in the default container are the
1008 * proactive flows, the ones automatically installed on the network node
1009 * which forwarding mode has been configured to "proactive". These flows are
1010 * needed by controller to discover the nodes topology and to discover the
1011 * attached hosts for some SDN switches.
1014 * The flow entry to be installed/removed/modified
1015 * @return true if not in container mode or if flowEntry is internally
1018 private boolean isContainerModeAllowed(FlowEntry flowEntry) {
1019 return (!inContainerMode) ? true : flowEntry.isInternal();
1023 public Status modifyOrAddFlowEntry(FlowEntry newFlowEntry) {
1025 * Run a check on the original entries to decide whether to go with a
1026 * add or modify method. A loose check means only check against the
1027 * original flow entry requests and not against the installed flow
1028 * entries which are the result of the original entry merged with the
1029 * container flow(s) (if any). The modifyFlowEntry method in presence of
1030 * conflicts with the Container flows (if any) would revert back to a
1031 * delete + add pattern
1033 FlowEntry currentFlowEntry = originalSwView.get(newFlowEntry);
1035 if (currentFlowEntry != null) {
1036 return modifyFlowEntry(currentFlowEntry, newFlowEntry);
1038 return installFlowEntry(newFlowEntry);
1043 public Status modifyOrAddFlowEntryAsync(FlowEntry newFlowEntry) {
1045 * Run a check on the original entries to decide whether to go with a
1046 * add or modify method. A loose check means only check against the
1047 * original flow entry requests and not against the installed flow
1048 * entries which are the result of the original entry merged with the
1049 * container flow(s) (if any). The modifyFlowEntry method in presence of
1050 * conflicts with the Container flows (if any) would revert back to a
1051 * delete + add pattern
1053 FlowEntry currentFlowEntry = originalSwView.get(newFlowEntry);
1055 if (currentFlowEntry != null) {
1056 return modifyFlowEntryAsync(currentFlowEntry, newFlowEntry);
1058 return installFlowEntryAsync(newFlowEntry);
1063 public Status uninstallFlowEntryGroup(String groupName) {
1064 if (groupName == null || groupName.isEmpty()) {
1065 return new Status(StatusCode.BADREQUEST, "Invalid group name");
1067 if (groupName.equals(FlowConfig.INTERNALSTATICFLOWGROUP)) {
1068 return new Status(StatusCode.BADREQUEST, "Internal static flows group cannot be deleted through this api");
1070 if (inContainerMode) {
1071 String msg = "Controller in container mode: Group Uninstall Refused";
1072 String logMsg = msg + ": {}";
1073 log.warn(logMsg, groupName);
1074 return new Status(StatusCode.NOTACCEPTABLE, msg);
1076 int toBeRemoved = 0;
1078 if (groupFlows.containsKey(groupName)) {
1079 List<FlowEntryInstall> list = new ArrayList<FlowEntryInstall>(groupFlows.get(groupName));
1080 toBeRemoved = list.size();
1081 for (FlowEntryInstall entry : list) {
1082 Status status = this.removeEntry(entry.getOriginal(), false);
1083 if (status.isSuccess()) {
1086 error = status.getDescription();
1090 return (toBeRemoved == 0) ? new Status(StatusCode.SUCCESS) : new Status(StatusCode.INTERNALERROR,
1091 "Not all the flows were removed: " + error);
1095 public Status uninstallFlowEntryGroupAsync(String groupName) {
1096 if (groupName == null || groupName.isEmpty()) {
1097 return new Status(StatusCode.BADREQUEST, "Invalid group name");
1099 if (groupName.equals(FlowConfig.INTERNALSTATICFLOWGROUP)) {
1100 return new Status(StatusCode.BADREQUEST, "Static flows group cannot be deleted through this api");
1102 if (inContainerMode) {
1103 String msg = "Controller in container mode: Group Uninstall Refused";
1104 String logMsg = msg + ": {}";
1105 log.warn(logMsg, groupName);
1106 return new Status(StatusCode.NOTACCEPTABLE, msg);
1108 if (groupFlows.containsKey(groupName)) {
1109 List<FlowEntryInstall> list = new ArrayList<FlowEntryInstall>(groupFlows.get(groupName));
1110 for (FlowEntryInstall entry : list) {
1111 this.removeEntry(entry.getOriginal(), true);
1114 return new Status(StatusCode.SUCCESS);
1118 public boolean checkFlowEntryConflict(FlowEntry flowEntry) {
1119 return entryConflictsWithContainerFlows(flowEntry);
1123 * Updates all installed flows because the container flow got updated This
1124 * is obtained in two phases on per node basis: 1) Uninstall of all flows 2)
1125 * Reinstall of all flows This is needed because a new container flows
1126 * merged flow may conflict with an existing old container flows merged flow
1127 * on the network node
1129 protected void updateFlowsContainerFlow() {
1130 Set<FlowEntry> toReInstall = new HashSet<FlowEntry>();
1131 // First remove all installed entries
1132 for (ConcurrentMap.Entry<FlowEntryInstall, FlowEntryInstall> entry : installedSwView.entrySet()) {
1133 FlowEntryInstall current = entry.getValue();
1134 // Store the original entry
1135 toReInstall.add(current.getOriginal());
1136 // Remove the old couples. No validity checks to be run, use the
1138 this.removeEntryInternal(current, false);
1140 // Then reinstall the original entries
1141 for (FlowEntry entry : toReInstall) {
1142 // Reinstall the original flow entries, via the regular path: new
1143 // cFlow merge + validations
1144 this.installFlowEntry(entry);
1148 private void nonClusterObjectCreate() {
1149 originalSwView = new ConcurrentHashMap<FlowEntry, FlowEntry>();
1150 installedSwView = new ConcurrentHashMap<FlowEntryInstall, FlowEntryInstall>();
1151 nodeFlows = new ConcurrentHashMap<Node, List<FlowEntryInstall>>();
1152 groupFlows = new ConcurrentHashMap<String, List<FlowEntryInstall>>();
1153 TSPolicies = new ConcurrentHashMap<String, Object>();
1154 staticFlowsOrdinal = new ConcurrentHashMap<Integer, Integer>();
1155 portGroupConfigs = new ConcurrentHashMap<String, PortGroupConfig>();
1156 portGroupData = new ConcurrentHashMap<PortGroupConfig, Map<Node, PortGroup>>();
1157 staticFlows = new ConcurrentHashMap<Integer, FlowConfig>();
1158 inactiveFlows = new ConcurrentHashMap<FlowEntry, FlowEntry>();
1161 private void registerWithOSGIConsole() {
1162 BundleContext bundleContext = FrameworkUtil.getBundle(this.getClass()).getBundleContext();
1163 bundleContext.registerService(CommandProvider.class.getName(), this, null);
1167 public void setTSPolicyData(String policyname, Object o, boolean add) {
1170 /* Check if this policy already exists */
1171 if (!(TSPolicies.containsKey(policyname))) {
1172 TSPolicies.put(policyname, o);
1175 TSPolicies.remove(policyname);
1177 if (frmAware != null) {
1178 synchronized (frmAware) {
1179 for (IForwardingRulesManagerAware frma : frmAware) {
1181 frma.policyUpdate(policyname, add);
1182 } catch (Exception e) {
1183 log.warn("Exception on callback", e);
1191 public Map<String, Object> getTSPolicyData() {
1196 public Object getTSPolicyData(String policyName) {
1197 if (TSPolicies.containsKey(policyName)) {
1198 return TSPolicies.get(policyName);
1205 public List<FlowEntry> getFlowEntriesForGroup(String policyName) {
1206 List<FlowEntry> list = new ArrayList<FlowEntry>();
1207 if (policyName != null && !policyName.trim().isEmpty()) {
1208 for (Map.Entry<FlowEntry, FlowEntry> entry : this.originalSwView.entrySet()) {
1209 if (policyName.equals(entry.getKey().getGroupName())) {
1210 list.add(entry.getKey().clone());
1218 public List<FlowEntry> getInstalledFlowEntriesForGroup(String policyName) {
1219 List<FlowEntry> list = new ArrayList<FlowEntry>();
1220 if (policyName != null && !policyName.trim().isEmpty()) {
1221 for (Map.Entry<FlowEntryInstall, FlowEntryInstall> entry : this.installedSwView.entrySet()) {
1222 if (policyName.equals(entry.getKey().getGroupName())) {
1223 list.add(entry.getKey().getInstall().clone());
1231 public void addOutputPort(Node node, String flowName, List<NodeConnector> portList) {
1233 for (FlowEntryInstall flow : this.nodeFlows.get(node)) {
1234 if (flow.getFlowName().equals(flowName)) {
1235 FlowEntry currentFlowEntry = flow.getOriginal();
1236 FlowEntry newFlowEntry = currentFlowEntry.clone();
1237 for (NodeConnector dstPort : portList) {
1238 newFlowEntry.getFlow().addAction(new Output(dstPort));
1240 Status error = modifyEntry(currentFlowEntry, newFlowEntry, false);
1241 if (error.isSuccess()) {
1242 log.info("Ports {} added to FlowEntry {}", portList, flowName);
1244 log.warn("Failed to add ports {} to Flow entry {}. The failure is: {}", portList,
1245 currentFlowEntry.toString(), error.getDescription());
1250 log.warn("Failed to add ports to Flow {} on Node {}: Entry Not Found", flowName, node);
1254 public void removeOutputPort(Node node, String flowName, List<NodeConnector> portList) {
1255 for (FlowEntryInstall index : this.nodeFlows.get(node)) {
1256 FlowEntryInstall flow = this.installedSwView.get(index);
1257 if (flow.getFlowName().equals(flowName)) {
1258 FlowEntry currentFlowEntry = flow.getOriginal();
1259 FlowEntry newFlowEntry = currentFlowEntry.clone();
1260 for (NodeConnector dstPort : portList) {
1261 Action action = new Output(dstPort);
1262 newFlowEntry.getFlow().removeAction(action);
1264 Status status = modifyEntry(currentFlowEntry, newFlowEntry, false);
1265 if (status.isSuccess()) {
1266 log.info("Ports {} removed from FlowEntry {}", portList, flowName);
1268 log.warn("Failed to remove ports {} from Flow entry {}. The failure is: {}", portList,
1269 currentFlowEntry.toString(), status.getDescription());
1274 log.warn("Failed to remove ports from Flow {} on Node {}: Entry Not Found", flowName, node);
1278 * This function assumes the target flow has only one output port
1281 public void replaceOutputPort(Node node, String flowName, NodeConnector outPort) {
1282 FlowEntry currentFlowEntry = null;
1283 FlowEntry newFlowEntry = null;
1286 for (FlowEntryInstall index : this.nodeFlows.get(node)) {
1287 FlowEntryInstall flow = this.installedSwView.get(index);
1288 if (flow.getFlowName().equals(flowName)) {
1289 currentFlowEntry = flow.getOriginal();
1293 if (currentFlowEntry == null) {
1294 log.warn("Failed to replace output port for flow {} on node {}: Entry Not Found", flowName, node);
1298 // Create a flow copy with the new output port
1299 newFlowEntry = currentFlowEntry.clone();
1300 Action target = null;
1301 for (Action action : newFlowEntry.getFlow().getActions()) {
1302 if (action.getType() == ActionType.OUTPUT) {
1307 newFlowEntry.getFlow().removeAction(target);
1308 newFlowEntry.getFlow().addAction(new Output(outPort));
1310 // Modify on network node
1311 Status status = modifyEntry(currentFlowEntry, newFlowEntry, false);
1313 if (status.isSuccess()) {
1314 log.info("Output port replaced with {} for flow {} on node {}", outPort, flowName, node);
1316 log.warn("Failed to replace output port for flow {} on node {}. The failure is: {}", flowName, node,
1317 status.getDescription());
1323 public NodeConnector getOutputPort(Node node, String flowName) {
1324 for (FlowEntryInstall index : this.nodeFlows.get(node)) {
1325 FlowEntryInstall flow = this.installedSwView.get(index);
1326 if (flow.getFlowName().equals(flowName)) {
1327 for (Action action : flow.getOriginal().getFlow().getActions()) {
1328 if (action.getType() == ActionType.OUTPUT) {
1329 return ((Output) action).getPort();
1337 private void cacheStartup() {
1342 private void allocateCaches() {
1343 if (this.clusterContainerService == null) {
1344 log.warn("Un-initialized clusterContainerService, can't create cache");
1348 log.debug("Allocating caches for Container {}", container.getName());
1351 clusterContainerService.createCache("frm.originalSwView",
1352 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1354 clusterContainerService.createCache("frm.installedSwView",
1355 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1357 clusterContainerService.createCache("frm.inactiveFlows",
1358 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1360 clusterContainerService.createCache("frm.nodeFlows",
1361 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1363 clusterContainerService.createCache("frm.groupFlows",
1364 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1366 clusterContainerService.createCache("frm.staticFlows",
1367 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1369 clusterContainerService.createCache("frm.staticFlowsOrdinal",
1370 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1372 clusterContainerService.createCache("frm.portGroupConfigs",
1373 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1375 clusterContainerService.createCache("frm.portGroupData",
1376 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1378 clusterContainerService.createCache("frm.TSPolicies",
1379 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1381 clusterContainerService.createCache(WORKSTATUSCACHE,
1382 EnumSet.of(IClusterServices.cacheMode.NON_TRANSACTIONAL, IClusterServices.cacheMode.ASYNC));
1384 clusterContainerService.createCache(WORKORDERCACHE,
1385 EnumSet.of(IClusterServices.cacheMode.NON_TRANSACTIONAL, IClusterServices.cacheMode.ASYNC));
1387 } catch (CacheConfigException cce) {
1388 log.error("CacheConfigException");
1389 } catch (CacheExistException cce) {
1390 log.error("CacheExistException");
1394 @SuppressWarnings({ "unchecked" })
1395 private void retrieveCaches() {
1396 ConcurrentMap<?, ?> map;
1398 if (this.clusterContainerService == null) {
1399 log.warn("un-initialized clusterContainerService, can't retrieve cache");
1400 nonClusterObjectCreate();
1404 log.debug("Retrieving Caches for Container {}", container.getName());
1406 map = clusterContainerService.getCache("frm.originalSwView");
1408 originalSwView = (ConcurrentMap<FlowEntry, FlowEntry>) map;
1410 log.error("Retrieval of frm.originalSwView cache failed for Container {}", container.getName());
1413 map = clusterContainerService.getCache("frm.installedSwView");
1415 installedSwView = (ConcurrentMap<FlowEntryInstall, FlowEntryInstall>) map;
1417 log.error("Retrieval of frm.installedSwView cache failed for Container {}", container.getName());
1420 map = clusterContainerService.getCache("frm.inactiveFlows");
1422 inactiveFlows = (ConcurrentMap<FlowEntry, FlowEntry>) map;
1424 log.error("Retrieval of frm.inactiveFlows cache failed for Container {}", container.getName());
1427 map = clusterContainerService.getCache("frm.nodeFlows");
1429 nodeFlows = (ConcurrentMap<Node, List<FlowEntryInstall>>) map;
1431 log.error("Retrieval of cache failed for Container {}", container.getName());
1434 map = clusterContainerService.getCache("frm.groupFlows");
1436 groupFlows = (ConcurrentMap<String, List<FlowEntryInstall>>) map;
1438 log.error("Retrieval of frm.groupFlows cache failed for Container {}", container.getName());
1441 map = clusterContainerService.getCache("frm.staticFlows");
1443 staticFlows = (ConcurrentMap<Integer, FlowConfig>) map;
1445 log.error("Retrieval of frm.staticFlows cache failed for Container {}", container.getName());
1448 map = clusterContainerService.getCache("frm.staticFlowsOrdinal");
1450 staticFlowsOrdinal = (ConcurrentMap<Integer, Integer>) map;
1452 log.error("Retrieval of frm.staticFlowsOrdinal cache failed for Container {}", container.getName());
1455 map = clusterContainerService.getCache("frm.portGroupConfigs");
1457 portGroupConfigs = (ConcurrentMap<String, PortGroupConfig>) map;
1459 log.error("Retrieval of frm.portGroupConfigs cache failed for Container {}", container.getName());
1462 map = clusterContainerService.getCache("frm.portGroupData");
1464 portGroupData = (ConcurrentMap<PortGroupConfig, Map<Node, PortGroup>>) map;
1466 log.error("Retrieval of frm.portGroupData allocation failed for Container {}", container.getName());
1469 map = clusterContainerService.getCache("frm.TSPolicies");
1471 TSPolicies = (ConcurrentMap<String, Object>) map;
1473 log.error("Retrieval of frm.TSPolicies cache failed for Container {}", container.getName());
1476 map = clusterContainerService.getCache(WORKORDERCACHE);
1478 workOrder = (ConcurrentMap<FlowEntryDistributionOrder, FlowEntryInstall>) map;
1480 log.error("Retrieval of " + WORKORDERCACHE + " cache failed for Container {}", container.getName());
1483 map = clusterContainerService.getCache(WORKSTATUSCACHE);
1485 workStatus = (ConcurrentMap<FlowEntryDistributionOrder, Status>) map;
1487 log.error("Retrieval of " + WORKSTATUSCACHE + " cache failed for Container {}", container.getName());
1491 private boolean flowConfigExists(FlowConfig config) {
1492 // Flow name has to be unique on per node id basis
1493 for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1494 if (entry.getValue().isByNameAndNodeIdEqual(config)) {
1502 public Status addStaticFlow(FlowConfig config) {
1503 // Configuration object validation
1504 Status status = config.validate(container);
1505 if (!status.isSuccess()) {
1506 log.warn("Invalid Configuration for flow {}. The failure is {}", config, status.getDescription());
1507 String error = "Invalid Configuration (" + status.getDescription() + ")";
1508 config.setStatus(error);
1509 return new Status(StatusCode.BADREQUEST, error);
1511 return addStaticFlowInternal(config, false);
1515 * Private method to add a static flow configuration which does not run any
1516 * validation on the passed FlowConfig object. If restore is set to true,
1517 * configuration is stored in configuration database regardless the
1518 * installation on the network node was successful. This is useful at boot
1519 * when static flows are present in startup configuration and are read
1520 * before the switches connects.
1523 * The static flow configuration
1525 * if true, the configuration is stored regardless the
1526 * installation on the network node was successful
1527 * @return The status of this request
1529 private Status addStaticFlowInternal(FlowConfig config, boolean restore) {
1530 boolean multipleFlowPush = false;
1533 config.setStatus(SUCCESS);
1536 if (flowConfigExists(config)) {
1537 error = "Entry with this name on specified switch already exists";
1538 log.warn("Entry with this name on specified switch already exists: {}", config);
1539 config.setStatus(error);
1540 return new Status(StatusCode.CONFLICT, error);
1543 if ((config.getIngressPort() == null) && config.getPortGroup() != null) {
1544 for (String portGroupName : portGroupConfigs.keySet()) {
1545 if (portGroupName.equalsIgnoreCase(config.getPortGroup())) {
1546 multipleFlowPush = true;
1550 if (!multipleFlowPush) {
1551 log.warn("Invalid Configuration(Invalid PortGroup Name) for flow {}", config);
1552 error = "Invalid Configuration (Invalid PortGroup Name)";
1553 config.setStatus(error);
1554 return new Status(StatusCode.BADREQUEST, error);
1559 * If requested program the entry in hardware first before updating the
1562 if (!multipleFlowPush) {
1564 if (config.installInHw()) {
1565 FlowEntry entry = config.getFlowEntry();
1566 status = this.installFlowEntry(entry);
1567 if (!status.isSuccess()) {
1568 config.setStatus(status.getDescription());
1577 * When the control reaches this point, either of the following
1578 * conditions is true 1. This is a single entry configuration (non
1579 * PortGroup) and the hardware installation is successful 2. This is a
1580 * multiple entry configuration (PortGroup) and hardware installation is
1581 * NOT done directly on this event. 3. The User prefers to retain the
1582 * configuration in Controller and skip hardware installation.
1584 * Hence it is safe to update the StaticFlow DB at this point.
1586 * Note : For the case of PortGrouping, it is essential to have this DB
1587 * populated before the PortGroupListeners can query for the DB
1588 * triggered using portGroupChanged event...
1590 Integer ordinal = staticFlowsOrdinal.get(0);
1591 staticFlowsOrdinal.put(0, ++ordinal);
1592 staticFlows.put(ordinal, config);
1594 if (multipleFlowPush) {
1595 PortGroupConfig pgconfig = portGroupConfigs.get(config.getPortGroup());
1596 Map<Node, PortGroup> existingData = portGroupData.get(pgconfig);
1597 if (existingData != null) {
1598 portGroupChanged(pgconfig, existingData, true);
1601 return new Status(StatusCode.SUCCESS);
1604 private void addStaticFlowsToSwitch(Node node) {
1605 for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1606 FlowConfig config = entry.getValue();
1607 if (config.isPortGroupEnabled()) {
1610 if (config.getNode().equals(node)) {
1611 if (config.installInHw() && !config.getStatus().equals(SUCCESS)) {
1612 Status status = this.installFlowEntryAsync(config.getFlowEntry());
1613 config.setStatus(status.getDescription());
1617 // Update cluster cache
1618 refreshClusterStaticFlowsStatus(node);
1621 private void updateStaticFlowConfigsOnNodeDown(Node node) {
1622 log.trace("Updating Static Flow configs on node down: {}", node);
1624 List<Integer> toRemove = new ArrayList<Integer>();
1625 for (Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1627 FlowConfig config = entry.getValue();
1629 if (config.isPortGroupEnabled()) {
1633 if (config.installInHw() && config.getNode().equals(node)) {
1634 if (config.isInternalFlow()) {
1635 // Take note of this controller generated static flow
1636 toRemove.add(entry.getKey());
1638 config.setStatus(NODEDOWN);
1642 // Remove controller generated static flows for this node
1643 for (Integer index : toRemove) {
1644 staticFlows.remove(index);
1646 // Update cluster cache
1647 refreshClusterStaticFlowsStatus(node);
1651 private void updateStaticFlowConfigsOnContainerModeChange(UpdateType update) {
1652 log.trace("Updating Static Flow configs on container mode change: {}", update);
1654 for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1655 FlowConfig config = entry.getValue();
1656 if (config.isPortGroupEnabled()) {
1659 if (config.installInHw() && !config.isInternalFlow()) {
1662 config.setStatus("Removed from node because in container mode");
1665 config.setStatus(SUCCESS);
1671 // Update cluster cache
1672 refreshClusterStaticFlowsStatus(null);
1676 public Status removeStaticFlow(FlowConfig config) {
1678 * No config.isInternal() check as NB does not take this path and GUI
1679 * cannot issue a delete on an internal generated flow. We need this
1680 * path to be accessible when switch mode is changed from proactive to
1681 * reactive, so that we can remove the internal generated LLDP and ARP
1685 // Look for the target configuration entry
1687 FlowConfig target = null;
1688 for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1689 if (entry.getValue().isByNameAndNodeIdEqual(config)) {
1690 key = entry.getKey();
1691 target = entry.getValue();
1695 if (target == null) {
1696 return new Status(StatusCode.NOTFOUND, "Entry Not Present");
1699 // Program the network node
1700 Status status = this.uninstallFlowEntry(config.getFlowEntry());
1702 // Update configuration database if programming was successful
1703 if (status.isSuccess()) {
1704 staticFlows.remove(key);
1711 public Status removeStaticFlow(String name, Node node) {
1712 // Look for the target configuration entry
1714 FlowConfig target = null;
1715 for (ConcurrentMap.Entry<Integer, FlowConfig> mapEntry : staticFlows.entrySet()) {
1716 if (mapEntry.getValue().isByNameAndNodeIdEqual(name, node)) {
1717 key = mapEntry.getKey();
1718 target = mapEntry.getValue();
1722 if (target == null) {
1723 return new Status(StatusCode.NOTFOUND, "Entry Not Present");
1726 // Validity check for api3 entry point
1727 if (target.isInternalFlow()) {
1728 String msg = "Invalid operation: Controller generated flow cannot be deleted";
1729 String logMsg = msg + ": {}";
1730 log.warn(logMsg, name);
1731 return new Status(StatusCode.NOTACCEPTABLE, msg);
1734 if (target.isPortGroupEnabled()) {
1735 String msg = "Invalid operation: Port Group flows cannot be deleted through this API";
1736 String logMsg = msg + ": {}";
1737 log.warn(logMsg, name);
1738 return new Status(StatusCode.NOTACCEPTABLE, msg);
1741 // Program the network node
1742 Status status = this.removeEntry(target.getFlowEntry(), false);
1744 // Update configuration database if programming was successful
1745 if (status.isSuccess()) {
1746 staticFlows.remove(key);
1753 public Status modifyStaticFlow(FlowConfig newFlowConfig) {
1754 // Validity check for api3 entry point
1755 if (newFlowConfig.isInternalFlow()) {
1756 String msg = "Invalid operation: Controller generated flow cannot be modified";
1757 String logMsg = msg + ": {}";
1758 log.warn(logMsg, newFlowConfig);
1759 return new Status(StatusCode.NOTACCEPTABLE, msg);
1763 Status status = newFlowConfig.validate(container);
1764 if (!status.isSuccess()) {
1765 String msg = "Invalid Configuration (" + status.getDescription() + ")";
1766 newFlowConfig.setStatus(msg);
1767 log.warn("Invalid Configuration for flow {}. The failure is {}", newFlowConfig, status.getDescription());
1768 return new Status(StatusCode.BADREQUEST, msg);
1771 FlowConfig oldFlowConfig = null;
1772 Integer index = null;
1773 for (ConcurrentMap.Entry<Integer, FlowConfig> mapEntry : staticFlows.entrySet()) {
1774 FlowConfig entry = mapEntry.getValue();
1775 if (entry.isByNameAndNodeIdEqual(newFlowConfig.getName(), newFlowConfig.getNode())) {
1776 oldFlowConfig = entry;
1777 index = mapEntry.getKey();
1782 if (oldFlowConfig == null) {
1783 String msg = "Attempt to modify a non existing static flow";
1784 String logMsg = msg + ": {}";
1785 log.warn(logMsg, newFlowConfig);
1786 return new Status(StatusCode.NOTFOUND, msg);
1789 // Do not attempt to reinstall the flow, warn user
1790 if (newFlowConfig.equals(oldFlowConfig)) {
1791 String msg = "No modification detected";
1792 log.info("Static flow modification skipped. New flow and old flow are the same: {}", newFlowConfig);
1793 return new Status(StatusCode.SUCCESS, msg);
1796 // If flow is installed, program the network node
1797 status = new Status(StatusCode.SUCCESS, "Saved in config");
1798 if (oldFlowConfig.installInHw()) {
1799 status = this.modifyFlowEntry(oldFlowConfig.getFlowEntry(), newFlowConfig.getFlowEntry());
1802 // Update configuration database if programming was successful
1803 if (status.isSuccess()) {
1804 newFlowConfig.setStatus(status.getDescription());
1805 staticFlows.put(index, newFlowConfig);
1812 public Status toggleStaticFlowStatus(String name, Node node) {
1813 return toggleStaticFlowStatus(getStaticFlow(name, node));
1817 public Status toggleStaticFlowStatus(FlowConfig config) {
1818 if (config == null) {
1819 String msg = "Invalid request: null flow config";
1821 return new Status(StatusCode.BADREQUEST, msg);
1823 // Validity check for api3 entry point
1824 if (config.isInternalFlow()) {
1825 String msg = "Invalid operation: Controller generated flow cannot be modified";
1826 String logMsg = msg + ": {}";
1827 log.warn(logMsg, config);
1828 return new Status(StatusCode.NOTACCEPTABLE, msg);
1831 // Find the config entry
1833 FlowConfig target = null;
1834 for (Map.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1835 FlowConfig conf = entry.getValue();
1836 if (conf.isByNameAndNodeIdEqual(config)) {
1837 key = entry.getKey();
1842 if (target != null) {
1843 Status status = target.validate(container);
1844 if (!status.isSuccess()) {
1845 log.warn(status.getDescription());
1848 status = (target.installInHw()) ? this.uninstallFlowEntry(target.getFlowEntry()) : this
1849 .installFlowEntry(target.getFlowEntry());
1850 if (status.isSuccess()) {
1851 // Update Configuration database
1852 target.setStatus(SUCCESS);
1853 target.toggleInstallation();
1854 staticFlows.put(key, target);
1859 return new Status(StatusCode.NOTFOUND, "Unable to locate the entry. Failed to toggle status");
1863 * Reinsert all static flows entries in the cache to force cache updates in
1864 * the cluster. This is useful when only some parameters were changed in the
1865 * entries, like the status.
1868 * The node for which the static flow configurations have to be
1869 * refreshed. If null, all nodes static flows will be refreshed.
1871 private void refreshClusterStaticFlowsStatus(Node node) {
1872 // Refresh cluster cache
1873 for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1874 if (node == null || entry.getValue().getNode().equals(node)) {
1875 staticFlows.put(entry.getKey(), entry.getValue());
1881 * Uninstall all the non-internal Flow Entries present in the software view.
1882 * If requested, a copy of each original flow entry will be stored in the
1883 * inactive list so that it can be re-applied when needed (This is typically
1884 * the case when running in the default container and controller moved to
1885 * container mode) NOTE WELL: The routine as long as does a bulk change will
1886 * operate only on the entries for nodes locally attached so to avoid
1887 * redundant operations initiated by multiple nodes
1889 * @param preserveFlowEntries
1890 * if true, a copy of each original entry is stored in the
1893 private void uninstallAllFlowEntries(boolean preserveFlowEntries) {
1894 log.info("Uninstalling all non-internal flows");
1896 List<FlowEntryInstall> toRemove = new ArrayList<FlowEntryInstall>();
1898 // Store entries / create target list
1899 for (ConcurrentMap.Entry<FlowEntryInstall, FlowEntryInstall> mapEntry : installedSwView.entrySet()) {
1900 FlowEntryInstall flowEntries = mapEntry.getValue();
1901 // Skip internal generated static flows
1902 if (!flowEntries.isInternal()) {
1903 toRemove.add(flowEntries);
1904 // Store the original entries if requested
1905 if (preserveFlowEntries) {
1906 inactiveFlows.put(flowEntries.getOriginal(), flowEntries.getOriginal());
1911 // Now remove the entries
1912 for (FlowEntryInstall flowEntryHw : toRemove) {
1913 Node n = flowEntryHw.getNode();
1914 if (n != null && connectionManager.getLocalityStatus(n) == ConnectionLocality.LOCAL) {
1915 Status status = this.removeEntryInternal(flowEntryHw, false);
1916 if (!status.isSuccess()) {
1917 log.warn("Failed to remove entry: {}. The failure is: {}", flowEntryHw, status.getDescription());
1920 log.debug("Not removing entry {} because not connected locally, the remote guy will do it's job",
1927 * Re-install all the Flow Entries present in the inactive list The inactive
1928 * list will be empty at the end of this call This function is called on the
1929 * default container instance of FRM only when the last container is deleted
1931 private void reinstallAllFlowEntries() {
1932 log.info("Reinstalling all inactive flows");
1934 for (FlowEntry flowEntry : this.inactiveFlows.keySet()) {
1935 this.addEntry(flowEntry, false);
1938 // Empty inactive list in any case
1939 inactiveFlows.clear();
1943 public List<FlowConfig> getStaticFlows() {
1944 return getStaticFlowsOrderedList(staticFlows, staticFlowsOrdinal.get(0).intValue());
1947 // TODO: need to come out with a better algorithm for maintaining the order
1948 // of the configuration entries
1949 // with actual one, index associated to deleted entries cannot be reused and
1951 private List<FlowConfig> getStaticFlowsOrderedList(ConcurrentMap<Integer, FlowConfig> flowMap, int maxKey) {
1952 List<FlowConfig> orderedList = new ArrayList<FlowConfig>();
1953 for (int i = 0; i <= maxKey; i++) {
1954 FlowConfig entry = flowMap.get(i);
1955 if (entry != null) {
1956 orderedList.add(entry);
1963 public FlowConfig getStaticFlow(String name, Node node) {
1964 ConcurrentMap.Entry<Integer, FlowConfig> entry = getStaticFlowEntry(name, node);
1966 return entry.getValue();
1972 public List<FlowConfig> getStaticFlows(Node node) {
1973 List<FlowConfig> list = new ArrayList<FlowConfig>();
1974 for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1975 if (entry.getValue().onNode(node)) {
1976 list.add(entry.getValue());
1983 public List<String> getStaticFlowNamesForNode(Node node) {
1984 List<String> list = new ArrayList<String>();
1985 for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1986 if (entry.getValue().onNode(node)) {
1987 list.add(entry.getValue().getName());
1994 public List<Node> getListNodeWithConfiguredFlows() {
1995 Set<Node> set = new HashSet<Node>();
1996 for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1997 set.add(entry.getValue().getNode());
1999 return new ArrayList<Node>(set);
2002 @SuppressWarnings("unchecked")
2003 private void loadFlowConfiguration() {
2004 ObjectReader objReader = new ObjectReader();
2005 ConcurrentMap<Integer, FlowConfig> confList = (ConcurrentMap<Integer, FlowConfig>) objReader.read(this,
2008 ConcurrentMap<String, PortGroupConfig> pgConfig = (ConcurrentMap<String, PortGroupConfig>) objReader.read(this,
2011 if (pgConfig != null) {
2012 for (ConcurrentMap.Entry<String, PortGroupConfig> entry : pgConfig.entrySet()) {
2013 addPortGroupConfig(entry.getKey(), entry.getValue().getMatchString(), true);
2017 if (confList == null) {
2022 for (Integer key : confList.keySet()) {
2023 if (key.intValue() > maxKey) {
2024 maxKey = key.intValue();
2028 for (FlowConfig conf : getStaticFlowsOrderedList(confList, maxKey)) {
2029 addStaticFlowInternal(conf, true);
2034 public Object readObject(ObjectInputStream ois) throws FileNotFoundException, IOException, ClassNotFoundException {
2035 return ois.readObject();
2039 public Status saveConfig() {
2040 return saveConfigInternal();
2043 private Status saveConfigInternal() {
2044 ObjectWriter objWriter = new ObjectWriter();
2045 ConcurrentMap<Integer, FlowConfig> nonDynamicFlows = new ConcurrentHashMap<Integer, FlowConfig>();
2046 for (Integer ordinal : staticFlows.keySet()) {
2047 FlowConfig config = staticFlows.get(ordinal);
2048 // Do not save dynamic and controller generated static flows
2049 if (config.isDynamic() || config.isInternalFlow()) {
2052 nonDynamicFlows.put(ordinal, config);
2054 objWriter.write(nonDynamicFlows, frmFileName);
2055 objWriter.write(new ConcurrentHashMap<String, PortGroupConfig>(portGroupConfigs), portGroupFileName);
2056 return new Status(StatusCode.SUCCESS, null);
2060 public void subnetNotify(Subnet sub, boolean add) {
2063 private void installImplicitARPReplyPunt(Node node) {
2069 List<String> puntAction = new ArrayList<String>();
2070 puntAction.add(ActionType.CONTROLLER.toString());
2072 FlowConfig allowARP = new FlowConfig();
2073 allowARP.setInstallInHw(true);
2074 allowARP.setName(FlowConfig.INTERNALSTATICFLOWBEGIN + "Punt ARP Reply" + FlowConfig.INTERNALSTATICFLOWEND);
2075 allowARP.setPriority("500");
2076 allowARP.setNode(node);
2077 allowARP.setEtherType("0x" + Integer.toHexString(EtherTypes.ARP.intValue()).toUpperCase());
2078 allowARP.setDstMac(HexEncode.bytesToHexString(switchManager.getControllerMAC()));
2079 allowARP.setActions(puntAction);
2080 addStaticFlowInternal(allowARP, true); // skip validation on internal static flow name
2086 * @see org.opendaylight.controller.switchmanager.ISwitchManagerAware#modeChangeNotify(org.opendaylight.controller.sal.core.Node,
2089 * This method can be called from within the OSGi framework context,
2090 * given the programming operation can take sometime, it not good
2091 * pratice to have in it's context operations that can take time,
2092 * hence moving off to a different thread for async processing.
2094 private ExecutorService executor;
2096 public void modeChangeNotify(final Node node, final boolean proactive) {
2097 Callable<Status> modeChangeCallable = new Callable<Status>() {
2099 public Status call() throws Exception {
2100 List<FlowConfig> defaultConfigs = new ArrayList<FlowConfig>();
2102 List<String> puntAction = new ArrayList<String>();
2103 puntAction.add(ActionType.CONTROLLER.toString());
2105 FlowConfig allowARP = new FlowConfig();
2106 allowARP.setInstallInHw(true);
2107 allowARP.setName(FlowConfig.INTERNALSTATICFLOWBEGIN + "Punt ARP" + FlowConfig.INTERNALSTATICFLOWEND);
2108 allowARP.setPriority("1");
2109 allowARP.setNode(node);
2110 allowARP.setEtherType("0x" + Integer.toHexString(EtherTypes.ARP.intValue())
2112 allowARP.setActions(puntAction);
2113 defaultConfigs.add(allowARP);
2115 FlowConfig allowLLDP = new FlowConfig();
2116 allowLLDP.setInstallInHw(true);
2117 allowLLDP.setName(FlowConfig.INTERNALSTATICFLOWBEGIN + "Punt LLDP" + FlowConfig.INTERNALSTATICFLOWEND);
2118 allowLLDP.setPriority("1");
2119 allowLLDP.setNode(node);
2120 allowLLDP.setEtherType("0x" + Integer.toHexString(EtherTypes.LLDP.intValue())
2122 allowLLDP.setActions(puntAction);
2123 defaultConfigs.add(allowLLDP);
2125 List<String> dropAction = new ArrayList<String>();
2126 dropAction.add(ActionType.DROP.toString());
2128 FlowConfig dropAllConfig = new FlowConfig();
2129 dropAllConfig.setInstallInHw(true);
2130 dropAllConfig.setName(FlowConfig.INTERNALSTATICFLOWBEGIN + "Catch-All Drop"
2131 + FlowConfig.INTERNALSTATICFLOWEND);
2132 dropAllConfig.setPriority("0");
2133 dropAllConfig.setNode(node);
2134 dropAllConfig.setActions(dropAction);
2135 defaultConfigs.add(dropAllConfig);
2137 log.info("Forwarding mode for node {} set to {}", node, (proactive ? "proactive" : "reactive"));
2138 for (FlowConfig fc : defaultConfigs) {
2139 Status status = (proactive) ? addStaticFlowInternal(fc, false) : removeStaticFlow(fc);
2140 if (status.isSuccess()) {
2141 log.info("{} Proactive Static flow: {}", (proactive ? "Installed" : "Removed"), fc.getName());
2143 log.warn("Failed to {} Proactive Static flow: {}", (proactive ? "install" : "remove"),
2147 return new Status(StatusCode.SUCCESS);
2152 * Execute the work outside the caller context, this could be an
2153 * expensive operation and we don't want to block the caller for it.
2155 this.executor.submit(modeChangeCallable);
2159 * Remove from the databases all the flows installed on the node
2163 private void cleanDatabaseForNode(Node node) {
2164 log.info("Cleaning Flow database for Node {}", node);
2165 if (nodeFlows.containsKey(node)) {
2166 List<FlowEntryInstall> toRemove = new ArrayList<FlowEntryInstall>(nodeFlows.get(node));
2168 for (FlowEntryInstall entry : toRemove) {
2169 updateLocalDatabase(entry, false);
2174 private boolean doesFlowContainNodeConnector(Flow flow, NodeConnector nc) {
2179 Match match = flow.getMatch();
2180 if (match.isPresent(MatchType.IN_PORT)) {
2181 NodeConnector matchPort = (NodeConnector) match.getField(MatchType.IN_PORT).getValue();
2182 if (matchPort.equals(nc)) {
2186 List<Action> actionsList = flow.getActions();
2187 if (actionsList != null) {
2188 for (Action action : actionsList) {
2189 if (action instanceof Output) {
2190 NodeConnector actionPort = ((Output) action).getPort();
2191 if (actionPort.equals(nc)) {
2201 public void notifyNode(Node node, UpdateType type, Map<String, Property> propMap) {
2202 this.pendingEvents.offer(new NodeUpdateEvent(type, node));
2206 public void notifyNodeConnector(NodeConnector nodeConnector, UpdateType type, Map<String, Property> propMap) {
2207 boolean updateStaticFlowCluster = false;
2213 Config config = (propMap == null) ? null : (Config) propMap.get(Config.ConfigPropName);
2214 if (config != null) {
2215 switch (config.getValue()) {
2216 case Config.ADMIN_DOWN:
2217 log.trace("Port {} is administratively down: uninstalling interested flows", nodeConnector);
2218 updateStaticFlowCluster = removeFlowsOnNodeConnectorDown(nodeConnector);
2220 case Config.ADMIN_UP:
2221 log.trace("Port {} is administratively up: installing interested flows", nodeConnector);
2222 updateStaticFlowCluster = installFlowsOnNodeConnectorUp(nodeConnector);
2224 case Config.ADMIN_UNDEF:
2231 // This is the case where a switch port is removed from the SDN agent space
2232 log.trace("Port {} was removed from our control: uninstalling interested flows", nodeConnector);
2233 updateStaticFlowCluster = removeFlowsOnNodeConnectorDown(nodeConnector);
2239 if (updateStaticFlowCluster) {
2240 refreshClusterStaticFlowsStatus(nodeConnector.getNode());
2245 * It goes through the static flows configuration, it identifies the ones
2246 * which have the specified node connector as input or output port and
2247 * install them on the network node if they are marked to be installed in
2248 * hardware and their status shows they were not installed yet
2250 private boolean installFlowsOnNodeConnectorUp(NodeConnector nodeConnector) {
2251 boolean updated = false;
2252 List<FlowConfig> flowConfigForNode = getStaticFlows(nodeConnector.getNode());
2253 for (FlowConfig flowConfig : flowConfigForNode) {
2254 if (doesFlowContainNodeConnector(flowConfig.getFlow(), nodeConnector)) {
2255 if (flowConfig.installInHw() && !flowConfig.getStatus().equals(SUCCESS)) {
2256 Status status = this.installFlowEntry(flowConfig.getFlowEntry());
2257 if (!status.isSuccess()) {
2258 flowConfig.setStatus(status.getDescription());
2260 flowConfig.setStatus(SUCCESS);
2270 * Remove from the network node all the flows which have the specified node
2271 * connector as input or output port. If any of the flow entry is a static
2272 * flow, it updates the correspondent configuration.
2274 private boolean removeFlowsOnNodeConnectorDown(NodeConnector nodeConnector) {
2275 boolean updated = false;
2276 List<FlowEntryInstall> nodeFlowEntries = nodeFlows.get(nodeConnector.getNode());
2277 if (nodeFlowEntries == null) {
2280 for (FlowEntryInstall fei : new ArrayList<FlowEntryInstall>(nodeFlowEntries)) {
2281 if (doesFlowContainNodeConnector(fei.getInstall().getFlow(), nodeConnector)) {
2282 Status status = this.removeEntryInternal(fei, true);
2283 if (!status.isSuccess()) {
2287 * If the flow entry is a static flow, then update its
2290 if (fei.getGroupName().equals(FlowConfig.STATICFLOWGROUP)) {
2291 FlowConfig flowConfig = getStaticFlow(fei.getFlowName(), fei.getNode());
2292 if (flowConfig != null) {
2293 flowConfig.setStatus(PORTREMOVED);
2302 private FlowConfig getDerivedFlowConfig(FlowConfig original, String configName, Short port) {
2303 FlowConfig derivedFlow = new FlowConfig(original);
2304 derivedFlow.setDynamic(true);
2305 derivedFlow.setPortGroup(null);
2306 derivedFlow.setName(original.getName() + "_" + configName + "_" + port);
2307 derivedFlow.setIngressPort(port + "");
2311 private void addPortGroupFlows(PortGroupConfig config, Node node, PortGroup data) {
2312 for (FlowConfig staticFlow : staticFlows.values()) {
2313 if (staticFlow.getPortGroup() == null) {
2316 if ((staticFlow.getNode().equals(node)) && (staticFlow.getPortGroup().equals(config.getName()))) {
2317 for (Short port : data.getPorts()) {
2318 FlowConfig derivedFlow = getDerivedFlowConfig(staticFlow, config.getName(), port);
2319 addStaticFlowInternal(derivedFlow, false);
2325 private void removePortGroupFlows(PortGroupConfig config, Node node, PortGroup data) {
2326 for (FlowConfig staticFlow : staticFlows.values()) {
2327 if (staticFlow.getPortGroup() == null) {
2330 if (staticFlow.getNode().equals(node) && staticFlow.getPortGroup().equals(config.getName())) {
2331 for (Short port : data.getPorts()) {
2332 FlowConfig derivedFlow = getDerivedFlowConfig(staticFlow, config.getName(), port);
2333 removeStaticFlow(derivedFlow);
2340 public void portGroupChanged(PortGroupConfig config, Map<Node, PortGroup> data, boolean add) {
2341 log.info("PortGroup Changed for: {} Data: {}", config, portGroupData);
2342 Map<Node, PortGroup> existingData = portGroupData.get(config);
2343 if (existingData != null) {
2344 for (Map.Entry<Node, PortGroup> entry : data.entrySet()) {
2345 PortGroup existingPortGroup = existingData.get(entry.getKey());
2346 if (existingPortGroup == null) {
2348 existingData.put(entry.getKey(), entry.getValue());
2349 addPortGroupFlows(config, entry.getKey(), entry.getValue());
2353 existingPortGroup.getPorts().addAll(entry.getValue().getPorts());
2354 addPortGroupFlows(config, entry.getKey(), entry.getValue());
2356 existingPortGroup.getPorts().removeAll(entry.getValue().getPorts());
2357 removePortGroupFlows(config, entry.getKey(), entry.getValue());
2363 portGroupData.put(config, data);
2364 for (Node swid : data.keySet()) {
2365 addPortGroupFlows(config, swid, data.get(swid));
2372 public boolean addPortGroupConfig(String name, String regex, boolean restore) {
2373 PortGroupConfig config = portGroupConfigs.get(name);
2374 if (config != null) {
2378 if ((portGroupProvider == null) && !restore) {
2381 if ((portGroupProvider != null) && (!portGroupProvider.isMatchCriteriaSupported(regex))) {
2385 config = new PortGroupConfig(name, regex);
2386 portGroupConfigs.put(name, config);
2387 if (portGroupProvider != null) {
2388 portGroupProvider.createPortGroupConfig(config);
2394 public boolean delPortGroupConfig(String name) {
2395 PortGroupConfig config = portGroupConfigs.get(name);
2396 if (config == null) {
2400 if (portGroupProvider != null) {
2401 portGroupProvider.deletePortGroupConfig(config);
2403 portGroupConfigs.remove(name);
2407 private void usePortGroupConfig(String name) {
2408 PortGroupConfig config = portGroupConfigs.get(name);
2409 if (config == null) {
2412 if (portGroupProvider != null) {
2413 Map<Node, PortGroup> data = portGroupProvider.getPortGroupData(config);
2414 portGroupData.put(config, data);
2419 public Map<String, PortGroupConfig> getPortGroupConfigs() {
2420 return portGroupConfigs;
2423 public boolean isPortGroupSupported() {
2424 if (portGroupProvider == null) {
2430 public void setIContainer(IContainer s) {
2434 public void unsetIContainer(IContainer s) {
2435 if (this.container == s) {
2436 this.container = null;
2441 public PortGroupProvider getPortGroupProvider() {
2442 return portGroupProvider;
2445 public void unsetPortGroupProvider(PortGroupProvider portGroupProvider) {
2446 this.portGroupProvider = null;
2449 public void setPortGroupProvider(PortGroupProvider portGroupProvider) {
2450 this.portGroupProvider = portGroupProvider;
2451 portGroupProvider.registerPortGroupChange(this);
2452 for (PortGroupConfig config : portGroupConfigs.values()) {
2453 portGroupProvider.createPortGroupConfig(config);
2457 public void setFrmAware(IForwardingRulesManagerAware obj) {
2458 this.frmAware.add(obj);
2461 public void unsetFrmAware(IForwardingRulesManagerAware obj) {
2462 this.frmAware.remove(obj);
2465 void setClusterContainerService(IClusterContainerServices s) {
2466 log.debug("Cluster Service set");
2467 this.clusterContainerService = s;
2470 void unsetClusterContainerService(IClusterContainerServices s) {
2471 if (this.clusterContainerService == s) {
2472 log.debug("Cluster Service removed!");
2473 this.clusterContainerService = null;
2477 private String getContainerName() {
2478 if (container == null) {
2479 return GlobalConstants.DEFAULT.toString();
2481 return container.getName();
2485 * Function called by the dependency manager when all the required
2486 * dependencies are satisfied
2490 frmFileName = GlobalConstants.STARTUPHOME.toString() + "frm_staticflows_" + this.getContainerName() + ".conf";
2491 portGroupFileName = GlobalConstants.STARTUPHOME.toString() + "portgroup_" + this.getContainerName() + ".conf";
2493 inContainerMode = false;
2495 if (portGroupProvider != null) {
2496 portGroupProvider.registerPortGroupChange(this);
2501 registerWithOSGIConsole();
2504 * If we are not the first cluster node to come up, do not initialize
2505 * the static flow entries ordinal
2507 if (staticFlowsOrdinal.size() == 0) {
2508 staticFlowsOrdinal.put(0, Integer.valueOf(0));
2511 pendingEvents = new LinkedBlockingQueue<FRMEvent>();
2513 // Initialize the event handler thread
2514 frmEventHandler = new Thread(new Runnable() {
2519 FRMEvent event = pendingEvents.take();
2520 if (event == null) {
2521 log.warn("Dequeued null event");
2524 log.trace("Dequeued {} event", event.getClass().getSimpleName());
2525 if (event instanceof NodeUpdateEvent) {
2526 NodeUpdateEvent update = (NodeUpdateEvent) event;
2527 Node node = update.getNode();
2528 switch (update.getUpdateType()) {
2530 addStaticFlowsToSwitch(node);
2533 cleanDatabaseForNode(node);
2534 updateStaticFlowConfigsOnNodeDown(node);
2538 } else if (event instanceof ErrorReportedEvent) {
2539 ErrorReportedEvent errEvent = (ErrorReportedEvent) event;
2540 processErrorEvent(errEvent);
2541 } else if (event instanceof WorkOrderEvent) {
2543 * Take care of handling the remote Work request
2545 WorkOrderEvent work = (WorkOrderEvent) event;
2546 FlowEntryDistributionOrder fe = work.getFe();
2548 logsync.trace("Executing the workOrder {}", fe);
2549 Status gotStatus = null;
2550 FlowEntryInstall feiCurrent = fe.getEntry();
2551 FlowEntryInstall feiNew = workOrder.get(fe);
2552 switch (fe.getUpType()) {
2555 * TODO: Not still sure how to handle the
2558 gotStatus = addEntriesInternal(feiCurrent, true);
2561 gotStatus = modifyEntryInternal(feiCurrent, feiNew, true);
2564 gotStatus = removeEntryInternal(feiCurrent, true);
2568 workOrder.remove(fe);
2570 "The workOrder has been executed and now the status is being returned {}", fe);
2572 workStatus.put(fe, gotStatus);
2574 log.warn("Not expected null WorkOrder", work);
2576 } else if (event instanceof WorkStatusCleanup) {
2578 * Take care of handling the remote Work request
2580 WorkStatusCleanup work = (WorkStatusCleanup) event;
2581 FlowEntryDistributionOrder fe = work.getFe();
2583 logsync.trace("The workStatus {} is being removed", fe);
2584 workStatus.remove(fe);
2586 log.warn("Not expected null WorkStatus", work);
2588 } else if (event instanceof ContainerFlowChangeEvent) {
2590 * Whether it is an addition or removal, we have to
2591 * recompute the merged flows entries taking into
2592 * account all the current container flows because
2593 * flow merging is not an injective function
2595 updateFlowsContainerFlow();
2597 log.warn("Dequeued unknown event {}", event.getClass()
2600 } catch (InterruptedException e) {
2601 // clear pending events
2602 pendingEvents.clear();
2606 }, "FRM EventHandler Collector");
2610 * Function called by the dependency manager when at least one dependency
2611 * become unsatisfied or when the component is shutting down because for
2612 * example bundle is being stopped.
2616 // Interrupt the thread
2617 frmEventHandler.interrupt();
2618 // Clear the pendingEvents queue
2619 pendingEvents.clear();
2621 workMonitor.clear();
2625 * Function called by dependency manager after "init ()" is called and after
2626 * the services provided by the class are registered in the service registry
2630 // Initialize graceful stop flag
2633 // Allocate the executor service
2634 this.executor = Executors.newSingleThreadExecutor();
2636 // Start event handler thread
2637 frmEventHandler.start();
2640 * Read startup and build database if we have not already gotten the
2641 * configurations synced from another node
2643 if (staticFlows.isEmpty()) {
2644 loadFlowConfiguration();
2649 * Function called by the dependency manager before the services exported by
2650 * the component are unregistered, this will be followed by a "destroy ()"
2655 uninstallAllFlowEntries(false);
2656 // Shutdown executor
2657 this.executor.shutdownNow();
2658 // Now walk all the workMonitor and wake up the one sleeping because
2659 // destruction is happening
2660 for (FlowEntryDistributionOrder fe : workMonitor.keySet()) {
2661 FlowEntryDistributionOrderFutureTask task = workMonitor.get(fe);
2666 public void setFlowProgrammerService(IFlowProgrammerService service) {
2667 this.programmer = service;
2670 public void unsetFlowProgrammerService(IFlowProgrammerService service) {
2671 if (this.programmer == service) {
2672 this.programmer = null;
2676 public void setSwitchManager(ISwitchManager switchManager) {
2677 this.switchManager = switchManager;
2680 public void unsetSwitchManager(ISwitchManager switchManager) {
2681 if (this.switchManager == switchManager) {
2682 this.switchManager = null;
2687 public void tagUpdated(String containerName, Node n, short oldTag, short newTag, UpdateType t) {
2688 if (!container.getName().equals(containerName)) {
2694 public void containerFlowUpdated(String containerName, ContainerFlow previous, ContainerFlow current, UpdateType t) {
2695 if (!container.getName().equals(containerName)) {
2698 log.trace("Container {}: Updating installed flows because of container flow change: {} {}",
2699 container.getName(), t, current);
2700 ContainerFlowChangeEvent ev = new ContainerFlowChangeEvent(previous, current, t);
2701 pendingEvents.offer(ev);
2705 public void nodeConnectorUpdated(String containerName, NodeConnector nc, UpdateType t) {
2706 if (!container.getName().equals(containerName)) {
2710 boolean updateStaticFlowCluster = false;
2714 log.trace("Port {} was removed from container: uninstalling interested flows", nc);
2715 updateStaticFlowCluster = removeFlowsOnNodeConnectorDown(nc);
2718 log.trace("Port {} was added to container: reinstall interested flows", nc);
2719 updateStaticFlowCluster = installFlowsOnNodeConnectorUp(nc);
2727 if (updateStaticFlowCluster) {
2728 refreshClusterStaticFlowsStatus(nc.getNode());
2733 public void containerModeUpdated(UpdateType update) {
2734 // Only default container instance reacts on this event
2735 if (!container.getName().equals(GlobalConstants.DEFAULT.toString())) {
2741 * Controller is moving to container mode. We are in the default
2742 * container context, we need to remove all our non-internal flows
2743 * to prevent any container isolation breakage. We also need to
2744 * preserve our flow so that they can be re-installed if we move
2745 * back to non container mode (no containers).
2747 this.inContainerMode = true;
2748 this.uninstallAllFlowEntries(true);
2751 this.inContainerMode = false;
2752 this.reinstallAllFlowEntries();
2757 // Update our configuration DB
2758 updateStaticFlowConfigsOnContainerModeChange(update);
2761 protected abstract class FRMEvent {
2765 private class NodeUpdateEvent extends FRMEvent {
2766 private final Node node;
2767 private final UpdateType update;
2769 public NodeUpdateEvent(UpdateType update, Node node) {
2770 this.update = update;
2774 public UpdateType getUpdateType() {
2778 public Node getNode() {
2783 private class ErrorReportedEvent extends FRMEvent {
2784 private final long rid;
2785 private final Node node;
2786 private final Object error;
2788 public ErrorReportedEvent(long rid, Node node, Object error) {
2794 public long getRequestId() {
2798 public Object getError() {
2802 public Node getNode() {
2807 private class WorkOrderEvent extends FRMEvent {
2808 private FlowEntryDistributionOrder fe;
2809 private FlowEntryInstall newEntry;
2815 WorkOrderEvent(FlowEntryDistributionOrder fe, FlowEntryInstall newEntry) {
2817 this.newEntry = newEntry;
2823 public FlowEntryDistributionOrder getFe() {
2828 * @return the newEntry
2830 public FlowEntryInstall getNewEntry() {
2834 private class ContainerFlowChangeEvent extends FRMEvent {
2835 private final ContainerFlow previous;
2836 private final ContainerFlow current;
2837 private final UpdateType type;
2839 public ContainerFlowChangeEvent(ContainerFlow previous, ContainerFlow current, UpdateType type) {
2840 this.previous = previous;
2841 this.current = current;
2845 public ContainerFlow getPrevious() {
2846 return this.previous;
2849 public ContainerFlow getCurrent() {
2850 return this.current;
2853 public UpdateType getType() {
2859 private class WorkStatusCleanup extends FRMEvent {
2860 private FlowEntryDistributionOrder fe;
2865 WorkStatusCleanup(FlowEntryDistributionOrder fe) {
2872 public FlowEntryDistributionOrder getFe() {
2881 public String getHelp() {
2882 StringBuffer help = new StringBuffer();
2883 help.append("---FRM Matrix Application---\n");
2884 help.append("\t printMatrixData - Prints the Matrix Configs\n");
2885 help.append("\t addMatrixConfig <name> <regex>\n");
2886 help.append("\t delMatrixConfig <name>\n");
2887 help.append("\t useMatrixConfig <name>\n");
2888 return help.toString();
2891 public void _printMatrixData(CommandInterpreter ci) {
2892 ci.println("Configs : ");
2893 ci.println("---------");
2894 ci.println(portGroupConfigs);
2896 ci.println("Data : ");
2897 ci.println("------");
2898 ci.println(portGroupData);
2901 public void _addMatrixConfig(CommandInterpreter ci) {
2902 String name = ci.nextArgument();
2903 String regex = ci.nextArgument();
2904 addPortGroupConfig(name, regex, false);
2907 public void _delMatrixConfig(CommandInterpreter ci) {
2908 String name = ci.nextArgument();
2909 delPortGroupConfig(name);
2912 public void _useMatrixConfig(CommandInterpreter ci) {
2913 String name = ci.nextArgument();
2914 usePortGroupConfig(name);
2917 public void _arpPunt(CommandInterpreter ci) {
2918 String switchId = ci.nextArgument();
2919 long swid = HexEncode.stringToLong(switchId);
2920 Node node = NodeCreator.createOFNode(swid);
2921 installImplicitARPReplyPunt(node);
2924 public void _frmaddflow(CommandInterpreter ci) throws UnknownHostException {
2926 String nodeId = ci.nextArgument();
2927 if (nodeId == null) {
2928 ci.print("Node id not specified");
2932 node = NodeCreator.createOFNode(Long.valueOf(nodeId));
2933 } catch (NumberFormatException e) {
2934 ci.print("Node id not a number");
2937 ci.println(this.programmer.addFlow(node, getSampleFlow(node)));
2940 public void _frmremoveflow(CommandInterpreter ci) throws UnknownHostException {
2942 String nodeId = ci.nextArgument();
2943 if (nodeId == null) {
2944 ci.print("Node id not specified");
2948 node = NodeCreator.createOFNode(Long.valueOf(nodeId));
2949 } catch (NumberFormatException e) {
2950 ci.print("Node id not a number");
2953 ci.println(this.programmer.removeFlow(node, getSampleFlow(node)));
2956 private Flow getSampleFlow(Node node) throws UnknownHostException {
2957 NodeConnector port = NodeConnectorCreator.createOFNodeConnector((short) 24, node);
2958 NodeConnector oport = NodeConnectorCreator.createOFNodeConnector((short) 30, node);
2959 byte srcMac[] = { (byte) 0x12, (byte) 0x34, (byte) 0x56, (byte) 0x78, (byte) 0x9a, (byte) 0xbc };
2960 byte dstMac[] = { (byte) 0x1a, (byte) 0x2b, (byte) 0x3c, (byte) 0x4d, (byte) 0x5e, (byte) 0x6f };
2961 InetAddress srcIP = InetAddress.getByName("172.28.30.50");
2962 InetAddress dstIP = InetAddress.getByName("171.71.9.52");
2963 InetAddress ipMask = InetAddress.getByName("255.255.255.0");
2964 InetAddress ipMask2 = InetAddress.getByName("255.0.0.0");
2965 short ethertype = EtherTypes.IPv4.shortValue();
2966 short vlan = (short) 27;
2969 byte proto = IPProtocols.TCP.byteValue();
2970 short src = (short) 55000;
2974 * Create a SAL Flow aFlow
2976 Match match = new Match();
2977 match.setField(MatchType.IN_PORT, port);
2978 match.setField(MatchType.DL_SRC, srcMac);
2979 match.setField(MatchType.DL_DST, dstMac);
2980 match.setField(MatchType.DL_TYPE, ethertype);
2981 match.setField(MatchType.DL_VLAN, vlan);
2982 match.setField(MatchType.DL_VLAN_PR, vlanPr);
2983 match.setField(MatchType.NW_SRC, srcIP, ipMask);
2984 match.setField(MatchType.NW_DST, dstIP, ipMask2);
2985 match.setField(MatchType.NW_TOS, tos);
2986 match.setField(MatchType.NW_PROTO, proto);
2987 match.setField(MatchType.TP_SRC, src);
2988 match.setField(MatchType.TP_DST, dst);
2990 List<Action> actions = new ArrayList<Action>();
2991 actions.add(new Output(oport));
2992 actions.add(new PopVlan());
2993 actions.add(new Flood());
2994 actions.add(new Controller());
2995 return new Flow(match, actions);
2999 public Status saveConfiguration() {
3000 return saveConfig();
3003 public void _frmNodeFlows(CommandInterpreter ci) {
3004 String nodeId = ci.nextArgument();
3005 Node node = Node.fromString(nodeId);
3007 ci.println("frmNodeFlows <node> [verbose]");
3010 boolean verbose = false;
3011 String verboseCheck = ci.nextArgument();
3012 if (verboseCheck != null) {
3013 verbose = verboseCheck.equals("true");
3016 if (!nodeFlows.containsKey(node)) {
3019 // Dump per node database
3020 for (FlowEntryInstall entry : nodeFlows.get(node)) {
3022 ci.println(node + " " + installedSwView.get(entry).getFlowName());
3024 ci.println(node + " " + installedSwView.get(entry).toString());
3029 public void _frmGroupFlows(CommandInterpreter ci) {
3030 String group = ci.nextArgument();
3031 if (group == null) {
3032 ci.println("frmGroupFlows <group> [verbose]");
3035 boolean verbose = false;
3036 String verboseCheck = ci.nextArgument();
3037 if (verboseCheck != null) {
3038 verbose = verboseCheck.equalsIgnoreCase("true");
3041 if (!groupFlows.containsKey(group)) {
3044 // Dump per node database
3045 ci.println("Group " + group + ":\n");
3046 for (FlowEntryInstall flowEntry : groupFlows.get(group)) {
3048 ci.println(flowEntry.getNode() + " " + flowEntry.getFlowName());
3050 ci.println(flowEntry.getNode() + " " + flowEntry.toString());
3055 public void _frmProcessErrorEvent(CommandInterpreter ci) throws UnknownHostException {
3058 String nodeId = ci.nextArgument();
3059 if (nodeId == null) {
3060 ci.print("Node id not specified");
3063 String requestId = ci.nextArgument();
3064 if (requestId == null) {
3065 ci.print("Request id not specified");
3069 node = NodeCreator.createOFNode(Long.valueOf(nodeId));
3070 } catch (NumberFormatException e) {
3071 ci.print("Node id not a number");
3075 reqId = Long.parseLong(requestId);
3076 } catch (NumberFormatException e) {
3077 ci.print("Request id not a number");
3080 // null for error object is good enough for now
3081 ErrorReportedEvent event = new ErrorReportedEvent(reqId, node, null);
3082 this.processErrorEvent(event);
3086 public void flowRemoved(Node node, Flow flow) {
3087 log.trace("Received flow removed notification on {} for {}", node, flow);
3089 // For flow entry identification, only node, match and priority matter
3090 FlowEntryInstall test = new FlowEntryInstall(new FlowEntry("", "", flow, node), null);
3091 FlowEntryInstall installedEntry = this.installedSwView.get(test);
3092 if (installedEntry == null) {
3093 log.trace("Entry is not known to us");
3097 // Update Static flow status
3099 FlowConfig target = null;
3100 for (Map.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
3101 FlowConfig conf = entry.getValue();
3102 if (conf.isByNameAndNodeIdEqual(installedEntry.getFlowName(), node)) {
3103 key = entry.getKey();
3108 if (target != null) {
3109 // Update Configuration database
3110 target.toggleInstallation();
3111 target.setStatus(SUCCESS);
3112 staticFlows.put(key, target);
3115 // Update software views
3116 this.updateLocalDatabase(installedEntry, false);
3120 public void flowErrorReported(Node node, long rid, Object err) {
3121 log.trace("Got error {} for message rid {} from node {}", new Object[] { err, rid, node });
3122 pendingEvents.offer(new ErrorReportedEvent(rid, node, err));
3125 private void processErrorEvent(ErrorReportedEvent event) {
3126 Node node = event.getNode();
3127 long rid = event.getRequestId();
3128 Object error = event.getError();
3129 String errorString = (error == null) ? "Not provided" : error.toString();
3131 * If this was for a flow install, remove the corresponding entry from
3132 * the software view. If it was a Looking for the rid going through the
3133 * software database. TODO: A more efficient rid <-> FlowEntryInstall
3134 * mapping will have to be added in future
3136 FlowEntryInstall target = null;
3137 List<FlowEntryInstall> flowEntryInstallList = nodeFlows.get(node);
3138 // flowEntryInstallList could be null.
3140 if(flowEntryInstallList != null) {
3141 for (FlowEntryInstall index : flowEntryInstallList) {
3142 FlowEntryInstall entry = installedSwView.get(index);
3144 if (entry.getRequestId() == rid) {
3151 if (target != null) {
3152 // This was a flow install, update database
3153 this.updateLocalDatabase(target, false);
3154 // also update the config
3155 if(FlowConfig.STATICFLOWGROUP.equals(target.getGroupName())) {
3156 ConcurrentMap.Entry<Integer, FlowConfig> staticFlowEntry = getStaticFlowEntry(target.getFlowName(),target.getNode());
3157 // staticFlowEntry should never be null.
3158 // the null check is just an extra defensive check.
3159 if(staticFlowEntry != null) {
3160 staticFlows.remove(staticFlowEntry.getKey());
3166 if (frmAware != null) {
3167 synchronized (frmAware) {
3168 for (IForwardingRulesManagerAware frma : frmAware) {
3170 frma.requestFailed(rid, errorString);
3171 } catch (Exception e) {
3172 log.warn("Failed to notify {}", frma);
3180 public Status solicitStatusResponse(Node node, boolean blocking) {
3181 Status rv = new Status(StatusCode.INTERNALERROR);
3183 if (this.programmer != null) {
3185 rv = programmer.syncSendBarrierMessage(node);
3187 rv = programmer.asyncSendBarrierMessage(node);
3194 public void unsetIConnectionManager(IConnectionManager s) {
3195 if (s == this.connectionManager) {
3196 this.connectionManager = null;
3200 public void setIConnectionManager(IConnectionManager s) {
3201 this.connectionManager = s;
3205 public void entryCreated(Object key, String cacheName, boolean originLocal) {
3212 public void entryUpdated(Object key, Object new_value, String cacheName, boolean originLocal) {
3215 * Local updates are of no interest
3219 if (cacheName.equals(WORKORDERCACHE)) {
3220 logsync.trace("Got a WorkOrderCacheUpdate for {}", key);
3222 * This is the case of one workOrder becoming available, so we need
3223 * to dispatch the work to the appropriate handler
3225 FlowEntryDistributionOrder fe = (FlowEntryDistributionOrder) key;
3226 FlowEntryInstall fei = fe.getEntry();
3230 Node n = fei.getNode();
3231 if (connectionManager.getLocalityStatus(n) == ConnectionLocality.LOCAL) {
3232 logsync.trace("workOrder for fe {} processed locally", fe);
3233 // I'm the controller in charge for the request, queue it for
3235 pendingEvents.offer(new WorkOrderEvent(fe, (FlowEntryInstall) new_value));
3237 } else if (cacheName.equals(WORKSTATUSCACHE)) {
3238 logsync.trace("Got a WorkStatusCacheUpdate for {}", key);
3240 * This is the case of one workOrder being completed and a status
3243 FlowEntryDistributionOrder fe = (FlowEntryDistributionOrder) key;
3245 * Check if the order was initiated by this controller in that case
3246 * we need to actually look at the status returned
3248 if (fe.getRequestorController()
3249 .equals(clusterContainerService.getMyAddress())) {
3250 FlowEntryDistributionOrderFutureTask fet = workMonitor.remove(fe);
3252 logsync.trace("workStatus response is for us {}", fe);
3253 // Signal we got the status
3254 fet.gotStatus(fe, workStatus.get(fe));
3255 pendingEvents.offer(new WorkStatusCleanup(fe));
3262 public void entryDeleted(Object key, String cacheName, boolean originLocal) {