opendaylight/forwardingrulesmanager/implementation/src/main/java/org/opendaylight/controller/forwardingrulesmanager/internal/ForwardingRulesManager.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.controller.forwardingrulesmanager.internal;
  10
  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;
  21 import java.util.Map;
  22 import java.util.Map.Entry;
  23 import java.util.Set;
  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.Future;
  32 import java.util.concurrent.LinkedBlockingQueue;
  33
  34 import org.eclipse.osgi.framework.console.CommandInterpreter;
  35 import org.eclipse.osgi.framework.console.CommandProvider;
  36 import org.opendaylight.controller.clustering.services.CacheConfigException;
  37 import org.opendaylight.controller.clustering.services.CacheExistException;
  38 import org.opendaylight.controller.clustering.services.ICacheUpdateAware;
  39 import org.opendaylight.controller.clustering.services.IClusterContainerServices;
  40 import org.opendaylight.controller.clustering.services.IClusterServices;
  41 import org.opendaylight.controller.configuration.IConfigurationContainerAware;
  42 import org.opendaylight.controller.connectionmanager.ConnectionLocality;
  43 import org.opendaylight.controller.connectionmanager.IConnectionManager;
  44 import org.opendaylight.controller.forwardingrulesmanager.FlowConfig;
  45 import org.opendaylight.controller.forwardingrulesmanager.FlowEntry;
  46 import org.opendaylight.controller.forwardingrulesmanager.FlowEntryInstall;
  47 import org.opendaylight.controller.forwardingrulesmanager.IForwardingRulesManager;
  48 import org.opendaylight.controller.forwardingrulesmanager.IForwardingRulesManagerAware;
  49 import org.opendaylight.controller.forwardingrulesmanager.PortGroup;
  50 import org.opendaylight.controller.forwardingrulesmanager.PortGroupChangeListener;
  51 import org.opendaylight.controller.forwardingrulesmanager.PortGroupConfig;
  52 import org.opendaylight.controller.forwardingrulesmanager.PortGroupProvider;
  53 import org.opendaylight.controller.forwardingrulesmanager.implementation.data.FlowEntryDistributionOrder;
  54 import org.opendaylight.controller.sal.action.Action;
  55 import org.opendaylight.controller.sal.action.ActionType;
  56 import org.opendaylight.controller.sal.action.Controller;
  57 import org.opendaylight.controller.sal.action.Flood;
  58 import org.opendaylight.controller.sal.action.Output;
  59 import org.opendaylight.controller.sal.action.PopVlan;
  60 import org.opendaylight.controller.sal.core.ContainerFlow;
  61 import org.opendaylight.controller.sal.core.IContainer;
  62 import org.opendaylight.controller.sal.core.IContainerListener;
  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;
  91
  92 /**
  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.
  96  */
  97 public class ForwardingRulesManager implements
  98         IForwardingRulesManager,
  99         PortGroupChangeListener,
 100         IContainerListener,
 101         ISwitchManagerAware,
 102         IConfigurationContainerAware,
 103         IInventoryListener,
 104         IObjectReader,
 105         ICacheUpdateAware,
 106         CommandProvider,
 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     private boolean stopping;
 122
 123     /*
 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.
 131      */
 132     private ConcurrentMap<FlowEntry, FlowEntry> originalSwView;
 133     private ConcurrentMap<FlowEntryInstall, FlowEntryInstall> installedSwView;
 134     /*
 135      * Per node and per group indexing
 136      */
 137     private ConcurrentMap<Node, List<FlowEntryInstall>> nodeFlows;
 138     private ConcurrentMap<String, List<FlowEntryInstall>> groupFlows;
 139
 140     /*
 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.
 144      */
 145     private ConcurrentMap<FlowEntry, FlowEntry> inactiveFlows;
 146
 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;
 156
 157     // Distributes FRM programming in the cluster
 158     private IConnectionManager connectionManager;
 159
 160     /*
 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
 164      */
 165     static final String WORKORDERCACHE = "frm.workOrder";
 166     static final String WORKSTATUSCACHE = "frm.workStatus";
 167
 168     /*
 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.
 174      *
 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.
 178      *
 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.
 182      */
 183     private ConcurrentMap<FlowEntryDistributionOrder, FlowEntryInstall> workOrder;
 184
 185     /*
 186      * Data structure responsible for retrieving the results of the workOrder
 187      * submitted to the cluster.
 188      *
 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.
 192      *
 193      * TODO: The workStatus entries need to have a lifetime associated in case
 194      * of requestor controller leaving the cluster.
 195      */
 196     private ConcurrentMap<FlowEntryDistributionOrder, Status> workStatus;
 197
 198     /*
 199      * Local Map used to hold the Future which a caller can use to monitor for
 200      * completion
 201      */
 202     private ConcurrentMap<FlowEntryDistributionOrder, FlowEntryDistributionOrderFutureTask> workMonitor =
 203             new ConcurrentHashMap<FlowEntryDistributionOrder, FlowEntryDistributionOrderFutureTask>();
 204
 205     /**
 206      * @param e
 207      *            Entry being installed/updated/removed
 208      * @param u
 209      *            New entry will be placed after the update operation. Valid
 210      *            only for UpdateType.CHANGED, null for all the other cases
 211      * @param t
 212      *            Type of update
 213      * @return a Future object for monitoring the progress of the result, or
 214      *         null in case the processing should take place locally
 215      */
 216     private Future<Status> distributeWorkOrder(FlowEntryInstall e, FlowEntryInstall u, UpdateType t) {
 217         // A null entry it's an unexpected condition, anyway it's safe to keep
 218         // the handling local
 219         if (e == null) {
 220             return null;
 221         }
 222
 223         Node n = e.getNode();
 224         if (connectionManager.getLocalityStatus(n) == ConnectionLocality.NOT_LOCAL) {
 225             // Create the work order and distribute it
 226             FlowEntryDistributionOrder fe =
 227                     new FlowEntryDistributionOrder(e, t, clusterContainerService.getMyAddress());
 228             // First create the monitor job
 229             FlowEntryDistributionOrderFutureTask ret = new FlowEntryDistributionOrderFutureTask(fe);
 230             logsync.trace("Node {} not local so sending fe {}", n, fe);
 231             workMonitor.put(fe, ret);
 232             if (t.equals(UpdateType.CHANGED)) {
 233                 // Then distribute the work
 234                 workOrder.put(fe, u);
 235             } else {
 236                 // Then distribute the work
 237                 workOrder.put(fe, e);
 238             }
 239             logsync.trace("WorkOrder requested");
 240             // Now create an Handle to monitor the execution of the operation
 241             return ret;
 242         }
 243
 244         logsync.trace("Node {} could be local. so processing Entry:{} UpdateType:{}", n, e, t);
 245         return null;
 246     }
 247
 248     /**
 249      * Adds a flow entry onto the network node It runs various validity checks
 250      * and derive the final container flows merged entries that will be
 251      * attempted to be installed
 252      *
 253      * @param flowEntry
 254      *            the original flow entry application requested to add
 255      * @param async
 256      *            the flag indicating if this is a asynchronous request
 257      * @return the status of this request. In case of asynchronous call, it will
 258      *         contain the unique id assigned to this request
 259      */
 260     private Status addEntry(FlowEntry flowEntry, boolean async) {
 261
 262         // Sanity Check
 263         if (flowEntry == null || flowEntry.getNode() == null) {
 264             String msg = "Invalid FlowEntry";
 265             String logMsg = msg + ": {}";
 266             log.warn(logMsg, flowEntry);
 267             return new Status(StatusCode.NOTACCEPTABLE, msg);
 268         }
 269
 270         /*
 271          * Derive the container flow merged entries to install In presence of N
 272          * container flows, we may end up with N different entries to install...
 273          */
 274         List<FlowEntryInstall> toInstallList = deriveInstallEntries(flowEntry.clone(), container.getContainerFlows());
 275
 276         // Container Flow conflict Check
 277         if (toInstallList.isEmpty()) {
 278             String msg = "Flow Entry conflicts with all Container Flows";
 279             String logMsg = msg + ": {}";
 280             log.warn(logMsg, flowEntry);
 281             return new Status(StatusCode.CONFLICT, msg);
 282         }
 283
 284         // Derive the list of entries good to be installed
 285         List<FlowEntryInstall> toInstallSafe = new ArrayList<FlowEntryInstall>();
 286         for (FlowEntryInstall entry : toInstallList) {
 287             // Conflict Check: Verify new entry would not overwrite existing
 288             // ones
 289             if (this.installedSwView.containsKey(entry)) {
 290                 log.warn("Operation Rejected: A flow with same match and priority exists on the target node");
 291                 log.trace("Aborting to install {}", entry);
 292                 continue;
 293             }
 294             toInstallSafe.add(entry);
 295         }
 296
 297         // Declare failure if all the container flow merged entries clash with
 298         // existing entries
 299         if (toInstallSafe.size() == 0) {
 300             String msg = "A flow with same match and priority exists on the target node";
 301             String logMsg = msg + ": {}";
 302             log.warn(logMsg, flowEntry);
 303             return new Status(StatusCode.CONFLICT, msg);
 304         }
 305
 306         // Try to install an entry at the time
 307         Status error = new Status(null, null);
 308         Status succeded = null;
 309         boolean oneSucceded = false;
 310         for (FlowEntryInstall installEntry : toInstallSafe) {
 311
 312             // Install and update database
 313             Status ret = addEntriesInternal(installEntry, async);
 314
 315             if (ret.isSuccess()) {
 316                 oneSucceded = true;
 317                 /*
 318                  * The first successful status response will be returned For the
 319                  * asynchronous call, we can discard the container flow
 320                  * complication for now and assume we will always deal with one
 321                  * flow only per request
 322                  */
 323                 succeded = ret;
 324             } else {
 325                 error = ret;
 326                 log.warn("Failed to install the entry: {}. The failure is: {}", installEntry, ret.getDescription());
 327             }
 328         }
 329
 330         return (oneSucceded) ? succeded : error;
 331     }
 332
 333     /**
 334      * Given a flow entry and the list of container flows, it returns the list
 335      * of container flow merged flow entries good to be installed on this
 336      * container. If the list of container flows is null or empty, the install
 337      * entry list will contain only one entry, the original flow entry. If the
 338      * flow entry is congruent with all the N container flows, then the output
 339      * install entry list will contain N entries. If the output list is empty,
 340      * it means the passed flow entry conflicts with all the container flows.
 341      *
 342      * @param cFlowList
 343      *            The list of container flows
 344      * @return the list of container flow merged entries good to be installed on
 345      *         this container
 346      */
 347     private List<FlowEntryInstall> deriveInstallEntries(FlowEntry request, List<ContainerFlow> cFlowList) {
 348         List<FlowEntryInstall> toInstallList = new ArrayList<FlowEntryInstall>(1);
 349
 350         if (container.getContainerFlows() == null || container.getContainerFlows().isEmpty()) {
 351             // No container flows => entry good to be installed unchanged
 352             toInstallList.add(new FlowEntryInstall(request.clone(), null));
 353         } else {
 354             // Create the list of entries to be installed. If the flow entry is
 355             // not congruent with any container flow, no install entries will be
 356             // created
 357             for (ContainerFlow cFlow : container.getContainerFlows()) {
 358                 if (cFlow.allowsFlow(request.getFlow())) {
 359                     toInstallList.add(new FlowEntryInstall(request.clone(), cFlow));
 360                 }
 361             }
 362         }
 363         return toInstallList;
 364     }
 365
 366     /**
 367      * Modify a flow entry with a new one It runs various validity check and
 368      * derive the final container flows merged flow entries to work with
 369      *
 370      * @param currentFlowEntry
 371      * @param newFlowEntry
 372      * @param async
 373      *            the flag indicating if this is a asynchronous request
 374      * @return the status of this request. In case of asynchronous call, it will
 375      *         contain the unique id assigned to this request
 376      */
 377     private Status modifyEntry(FlowEntry currentFlowEntry, FlowEntry newFlowEntry, boolean async) {
 378         Status retExt;
 379
 380         // Sanity checks
 381         if (currentFlowEntry == null || currentFlowEntry.getNode() == null || newFlowEntry == null
 382                 || newFlowEntry.getNode() == null) {
 383             String msg = "Modify: Invalid FlowEntry";
 384             String logMsg = msg + ": {} or {}";
 385             log.warn(logMsg, currentFlowEntry, newFlowEntry);
 386             return new Status(StatusCode.NOTACCEPTABLE, msg);
 387         }
 388         if (!currentFlowEntry.getNode().equals(newFlowEntry.getNode())
 389                 || !currentFlowEntry.getFlowName().equals(newFlowEntry.getFlowName())) {
 390             String msg = "Modify: Incompatible Flow Entries";
 391             String logMsg = msg + ": {} and {}";
 392             log.warn(logMsg, currentFlowEntry, newFlowEntry);
 393             return new Status(StatusCode.NOTACCEPTABLE, msg);
 394         }
 395
 396         // Equality Check
 397         if (currentFlowEntry.getFlow().equals(newFlowEntry.getFlow())) {
 398             String msg = "Modify skipped as flows are the same";
 399             String logMsg = msg + ": {} and {}";
 400             log.debug(logMsg, currentFlowEntry, newFlowEntry);
 401             return new Status(StatusCode.SUCCESS, msg);
 402         }
 403
 404         /*
 405          * Conflict Check: Verify the new entry would not conflict with an
 406          * existing one. This is a loose check on the previous original flow
 407          * entry requests. No check on the container flow merged flow entries
 408          * (if any) yet
 409          */
 410         FlowEntry sameMatchOriginalEntry = originalSwView.get(newFlowEntry);
 411         if (sameMatchOriginalEntry != null && !sameMatchOriginalEntry.equals(currentFlowEntry)) {
 412             String msg = "Operation Rejected: Another flow with same match and priority exists on the target node";
 413             String logMsg = msg + ": {}";
 414             log.warn(logMsg, currentFlowEntry);
 415             return new Status(StatusCode.CONFLICT, msg);
 416         }
 417
 418         // Derive the installed and toInstall entries
 419         List<FlowEntryInstall> installedList = deriveInstallEntries(currentFlowEntry.clone(),
 420                 container.getContainerFlows());
 421         List<FlowEntryInstall> toInstallList = deriveInstallEntries(newFlowEntry.clone(), container.getContainerFlows());
 422
 423         if (toInstallList.isEmpty()) {
 424             String msg = "Modify Operation Rejected: The new entry conflicts with all the container flows";
 425             String logMsg = msg + ": {}";
 426             log.warn(logMsg, newFlowEntry);
 427             log.warn(msg);
 428             return new Status(StatusCode.CONFLICT, msg);
 429         }
 430
 431         /*
 432          * If the two list sizes differ, it means the new flow entry does not
 433          * satisfy the same number of container flows the current entry does.
 434          * This is only possible when the new entry and current entry have
 435          * different match. In this scenario the modification would ultimately
 436          * be handled as a remove and add operations in the protocol plugin.
 437          *
 438          * Also, if any of the new flow entries would clash with an existing
 439          * one, we cannot proceed with the modify operation, because it would
 440          * fail for some entries and leave stale entries on the network node.
 441          * Modify path can be taken only if it can be performed completely, for
 442          * all entries.
 443          *
 444          * So, for the above two cases, to simplify, let's decouple the modify
 445          * in: 1) remove current entries 2) install new entries
 446          */
 447         Status succeeded = null;
 448         boolean decouple = false;
 449         if (installedList.size() != toInstallList.size()) {
 450             log.info("Modify: New flow entry does not satisfy the same "
 451                     + "number of container flows as the original entry does");
 452             decouple = true;
 453         }
 454         List<FlowEntryInstall> toInstallSafe = new ArrayList<FlowEntryInstall>();
 455         for (FlowEntryInstall installEntry : toInstallList) {
 456             /*
 457              * Conflict Check: Verify the new entry would not overwrite another
 458              * existing one
 459              */
 460             FlowEntryInstall sameMatchEntry = installedSwView.get(installEntry);
 461             if (sameMatchEntry != null && !sameMatchEntry.getOriginal().equals(currentFlowEntry)) {
 462                 log.info("Modify: new container flow merged flow entry clashes with existing flow");
 463                 decouple = true;
 464             } else {
 465                 toInstallSafe.add(installEntry);
 466             }
 467         }
 468
 469         if (decouple) {
 470             // Remove current entries
 471             for (FlowEntryInstall currEntry : installedList) {
 472                 this.removeEntryInternal(currEntry, async);
 473             }
 474             // Install new entries
 475             for (FlowEntryInstall newEntry : toInstallSafe) {
 476                 succeeded = this.addEntriesInternal(newEntry, async);
 477             }
 478         } else {
 479             /*
 480              * The two list have the same size and the entries to install do not
 481              * clash with any existing flow on the network node. We assume here
 482              * (and might be wrong) that the same container flows that were
 483              * satisfied by the current entries are the same that are satisfied
 484              * by the new entries. Let's take the risk for now.
 485              *
 486              * Note: modification has to be complete. If any entry modification
 487              * fails, we need to stop, restore the already modified entries, and
 488              * declare failure.
 489              */
 490             Status retModify = null;
 491             int i = 0;
 492             int size = toInstallList.size();
 493             while (i < size) {
 494                 // Modify and update database
 495                 retModify = modifyEntryInternal(installedList.get(i), toInstallList.get(i), async);
 496                 if (retModify.isSuccess()) {
 497                     i++;
 498                 } else {
 499                     break;
 500                 }
 501             }
 502             // Check if uncompleted modify
 503             if (i < size) {
 504                 log.warn("Unable to perform a complete modify for all  the container flows merged entries");
 505                 // Restore original entries
 506                 int j = 0;
 507                 while (j < i) {
 508                     log.info("Attempting to restore initial entries");
 509                     retExt = modifyEntryInternal(toInstallList.get(i), installedList.get(i), async);
 510                     if (retExt.isSuccess()) {
 511                         j++;
 512                     } else {
 513                         break;
 514                     }
 515                 }
 516                 // Fatal error, recovery failed
 517                 if (j < i) {
 518                     String msg = "Flow recovery failed ! Unrecoverable Error";
 519                     log.error(msg);
 520                     return new Status(StatusCode.INTERNALERROR, msg);
 521                 }
 522             }
 523             succeeded = retModify;
 524         }
 525         /*
 526          * The first successful status response will be returned. For the
 527          * asynchronous call, we can discard the container flow complication for
 528          * now and assume we will always deal with one flow only per request
 529          */
 530         return succeeded;
 531     }
 532
 533     /**
 534      * This is the function that modifies the final container flows merged
 535      * entries on the network node and update the database. It expects that all
 536      * the validity checks are passed
 537      *
 538      * @param currentEntries
 539      * @param newEntries
 540      * @param async
 541      *            the flag indicating if this is a asynchronous request
 542      * @return the status of this request. In case of asynchronous call, it will
 543      *         contain the unique id assigned to this request
 544      */
 545     private Status modifyEntryInternal(FlowEntryInstall currentEntries, FlowEntryInstall newEntries, boolean async) {
 546         Future<Status> futureStatus = distributeWorkOrder(currentEntries, newEntries, UpdateType.CHANGED);
 547         if (futureStatus != null) {
 548             Status retStatus = new Status(StatusCode.UNDEFINED);
 549             try {
 550                 retStatus = futureStatus.get();
 551             } catch (InterruptedException e) {
 552                 log.error("", e);
 553             } catch (ExecutionException e) {
 554                 log.error("", e);
 555             }
 556             return retStatus;
 557         } else {
 558             // Modify the flow on the network node
 559             Status status = async ? programmer.modifyFlowAsync(currentEntries.getNode(), currentEntries.getInstall()
 560                     .getFlow(), newEntries.getInstall()
 561                     .getFlow()) : programmer.modifyFlow(currentEntries.getNode(), currentEntries.getInstall()
 562                     .getFlow(), newEntries.getInstall()
 563                     .getFlow());
 564
 565             if (!status.isSuccess()) {
 566                 log.warn("SDN Plugin failed to program the flow: {}. The failure is: {}", newEntries.getInstall(),
 567                         status.getDescription());
 568                 return status;
 569             }
 570
 571             log.trace("Modified {} => {}", currentEntries.getInstall(), newEntries.getInstall());
 572
 573             // Update DB
 574             newEntries.setRequestId(status.getRequestId());
 575             updateLocalDatabase(currentEntries, false);
 576             updateLocalDatabase(newEntries, true);
 577
 578             return status;
 579         }
 580     }
 581
 582     /**
 583      * Remove a flow entry. If the entry is not present in the software view
 584      * (entry or node not present), it return successfully
 585      *
 586      * @param flowEntry
 587      *            the flow entry to remove
 588      * @param async
 589      *            the flag indicating if this is a asynchronous request
 590      * @return the status of this request. In case of asynchronous call, it will
 591      *         contain the unique id assigned to this request
 592      */
 593     private Status removeEntry(FlowEntry flowEntry, boolean async) {
 594         Status error = new Status(null, null);
 595
 596         // Sanity Check
 597         if (flowEntry == null || flowEntry.getNode() == null) {
 598             String msg = "Invalid FlowEntry";
 599             String logMsg = msg + ": {}";
 600             log.warn(logMsg, flowEntry);
 601             return new Status(StatusCode.NOTACCEPTABLE, msg);
 602         }
 603
 604         // Derive the container flows merged installed entries
 605         List<FlowEntryInstall> installedList = deriveInstallEntries(flowEntry.clone(), container.getContainerFlows());
 606
 607         Status succeeded = null;
 608         boolean atLeastOneRemoved = false;
 609         for (FlowEntryInstall entry : installedList) {
 610             if (!installedSwView.containsKey(entry)) {
 611                 String logMsg = "Removal skipped (not present in software view) for flow entry: {}";
 612                 log.debug(logMsg, flowEntry);
 613                 if (installedList.size() == 1) {
 614                     // If we had only one entry to remove, we are done
 615                     return new Status(StatusCode.SUCCESS);
 616                 } else {
 617                     continue;
 618                 }
 619             }
 620
 621             // Remove and update DB
 622             Status ret = removeEntryInternal(entry, async);
 623
 624             if (!ret.isSuccess()) {
 625                 error = ret;
 626                 log.warn("Failed to remove the entry: {}. The failure is: {}", entry.getInstall(), ret.getDescription());
 627                 if (installedList.size() == 1) {
 628                     // If we had only one entry to remove, this is fatal failure
 629                     return error;
 630                 }
 631             } else {
 632                 succeeded = ret;
 633                 atLeastOneRemoved = true;
 634             }
 635         }
 636
 637         /*
 638          * No worries if full removal failed. Consistency checker will take care
 639          * of removing the stale entries later, or adjusting the software
 640          * database if not in sync with hardware
 641          */
 642         return (atLeastOneRemoved) ? succeeded : error;
 643     }
 644
 645     /**
 646      * This is the function that removes the final container flows merged entry
 647      * from the network node and update the database. It expects that all the
 648      * validity checks are passed
 649      *
 650      * @param entry
 651      *            the flow entry to remove
 652      * @param async
 653      *            the flag indicating if this is a asynchronous request
 654      * @return the status of this request. In case of asynchronous call, it will
 655      *         contain the unique id assigned to this request
 656      */
 657     private Status removeEntryInternal(FlowEntryInstall entry, boolean async) {
 658         Future<Status> futureStatus = distributeWorkOrder(entry, null, UpdateType.REMOVED);
 659         if (futureStatus != null) {
 660             Status retStatus = new Status(StatusCode.UNDEFINED);
 661             try {
 662                 retStatus = futureStatus.get();
 663             } catch (InterruptedException e) {
 664                 log.error("", e);
 665             } catch (ExecutionException e) {
 666                 log.error("", e);
 667             }
 668             return retStatus;
 669         } else {
 670             // Mark the entry to be deleted (for CC just in case we fail)
 671             entry.toBeDeleted();
 672
 673             // Remove from node
 674             Status status = async ? programmer.removeFlowAsync(entry.getNode(), entry.getInstall()
 675                     .getFlow()) : programmer.removeFlow(entry.getNode(), entry.getInstall()
 676                     .getFlow());
 677
 678             if (!status.isSuccess()) {
 679                 log.warn("SDN Plugin failed to program the flow: {}. The failure is: {}", entry.getInstall(),
 680                         status.getDescription());
 681                 return status;
 682             }
 683             log.trace("Removed  {}", entry.getInstall());
 684
 685             // Update DB
 686             updateLocalDatabase(entry, false);
 687
 688             return status;
 689         }
 690     }
 691
 692     /**
 693      * This is the function that installs the final container flow merged entry
 694      * on the network node and updates the database. It expects that all the
 695      * validity and conflict checks are passed. That means it does not check
 696      * whether this flow would conflict or overwrite an existing one.
 697      *
 698      * @param entry
 699      *            the flow entry to install
 700      * @param async
 701      *            the flag indicating if this is a asynchronous request
 702      * @return the status of this request. In case of asynchronous call, it will
 703      *         contain the unique id assigned to this request
 704      */
 705     private Status addEntriesInternal(FlowEntryInstall entry, boolean async) {
 706         Future<Status> futureStatus = distributeWorkOrder(entry, null, UpdateType.ADDED);
 707         if (futureStatus != null) {
 708             Status retStatus = new Status(StatusCode.UNDEFINED);
 709             try {
 710                 retStatus = futureStatus.get();
 711             } catch (InterruptedException e) {
 712                 log.error("", e);
 713             } catch (ExecutionException e) {
 714                 log.error("", e);
 715             }
 716             return retStatus;
 717         } else {
 718             // Install the flow on the network node
 719             Status status = async ? programmer.addFlowAsync(entry.getNode(), entry.getInstall()
 720                     .getFlow()) : programmer.addFlow(entry.getNode(), entry.getInstall()
 721                     .getFlow());
 722
 723             if (!status.isSuccess()) {
 724                 log.warn("SDN Plugin failed to program the flow: {}. The failure is: {}", entry.getInstall(),
 725                         status.getDescription());
 726                 return status;
 727             }
 728
 729             log.trace("Added    {}", entry.getInstall());
 730
 731             // Update DB
 732             entry.setRequestId(status.getRequestId());
 733             updateLocalDatabase(entry, true);
 734
 735             return status;
 736         }
 737     }
 738
 739     /**
 740      * Returns true if the flow conflicts with all the container's flows. This
 741      * means that if the function returns true, the passed flow entry is
 742      * congruent with at least one container flow, hence it is good to be
 743      * installed on this container.
 744      *
 745      * @param flowEntry
 746      * @return true if flow conflicts with all the container flows, false
 747      *         otherwise
 748      */
 749     private boolean entryConflictsWithContainerFlows(FlowEntry flowEntry) {
 750         List<ContainerFlow> cFlowList = container.getContainerFlows();
 751
 752         // Validity check and avoid unnecessary computation
 753         // Also takes care of default container where no container flows are
 754         // present
 755         if (cFlowList == null || cFlowList.isEmpty()) {
 756             return false;
 757         }
 758
 759         for (ContainerFlow cFlow : cFlowList) {
 760             if (cFlow.allowsFlow(flowEntry.getFlow())) {
 761                 // Entry is allowed by at least one container flow: good to go
 762                 return false;
 763             }
 764         }
 765         return true;
 766     }
 767
 768     private void updateLocalDatabase(FlowEntryInstall entry, boolean add) {
 769         // Update the software view
 770         updateSwViewes(entry, add);
 771
 772         // Update node indexed flow database
 773         updateNodeFlowsDB(entry, add);
 774
 775         // Update group indexed flow database
 776         updateGroupFlowsDB(entry, add);
 777     }
 778
 779     /*
 780      * Update the node mapped flows database
 781      */
 782     private void updateSwViewes(FlowEntryInstall flowEntries, boolean add) {
 783         if (add) {
 784             originalSwView.put(flowEntries.getOriginal(), flowEntries.getOriginal());
 785             installedSwView.put(flowEntries, flowEntries);
 786         } else {
 787             originalSwView.remove(flowEntries.getOriginal());
 788             installedSwView.remove(flowEntries);
 789         }
 790     }
 791
 792     /*
 793      * Update the node mapped flows database
 794      */
 795     private void updateNodeFlowsDB(FlowEntryInstall flowEntries, boolean add) {
 796         Node node = flowEntries.getNode();
 797
 798         List<FlowEntryInstall> nodeIndeces = this.nodeFlows.get(node);
 799         if (nodeIndeces == null) {
 800             if (!add) {
 801                 return;
 802             } else {
 803                 nodeIndeces = new ArrayList<FlowEntryInstall>();
 804             }
 805         }
 806
 807         if (add) {
 808             nodeIndeces.add(flowEntries);
 809         } else {
 810             nodeIndeces.remove(flowEntries);
 811         }
 812
 813         // Update cache across cluster
 814         if (nodeIndeces.isEmpty()) {
 815             this.nodeFlows.remove(node);
 816         } else {
 817             this.nodeFlows.put(node, nodeIndeces);
 818         }
 819     }
 820
 821     /*
 822      * Update the group name mapped flows database
 823      */
 824     private void updateGroupFlowsDB(FlowEntryInstall flowEntries, boolean add) {
 825         String groupName = flowEntries.getGroupName();
 826
 827         // Flow may not be part of a group
 828         if (groupName == null) {
 829             return;
 830         }
 831
 832         List<FlowEntryInstall> indices = this.groupFlows.get(groupName);
 833         if (indices == null) {
 834             if (!add) {
 835                 return;
 836             } else {
 837                 indices = new ArrayList<FlowEntryInstall>();
 838             }
 839         }
 840
 841         if (add) {
 842             indices.add(flowEntries);
 843         } else {
 844             indices.remove(flowEntries);
 845         }
 846
 847         // Update cache across cluster
 848         if (indices.isEmpty()) {
 849             this.groupFlows.remove(groupName);
 850         } else {
 851             this.groupFlows.put(groupName, indices);
 852         }
 853     }
 854
 855     /**
 856      * Remove a flow entry that has been added previously First checks if the
 857      * entry is effectively present in the local database
 858      */
 859     @SuppressWarnings("unused")
 860     private Status removeEntry(Node node, String flowName) {
 861         FlowEntryInstall target = null;
 862
 863         // Find in database
 864         for (FlowEntryInstall entry : installedSwView.values()) {
 865             if (entry.equalsByNodeAndName(node, flowName)) {
 866                 target = entry;
 867                 break;
 868             }
 869         }
 870
 871         // If it is not there, stop any further processing
 872         if (target == null) {
 873             return new Status(StatusCode.SUCCESS, "Entry is not present");
 874         }
 875
 876         // Remove from node
 877         Status status = programmer.removeFlow(target.getNode(), target.getInstall().getFlow());
 878
 879         // Update DB
 880         if (status.isSuccess()) {
 881             updateLocalDatabase(target, false);
 882         } else {
 883             // log the error
 884             log.warn("SDN Plugin failed to remove the flow: {}. The failure is: {}", target.getInstall(),
 885                     status.getDescription());
 886         }
 887
 888         return status;
 889     }
 890
 891     @Override
 892     public Status installFlowEntry(FlowEntry flowEntry) {
 893         Status status;
 894         if (isContainerModeAllowed(flowEntry)) {
 895             status = addEntry(flowEntry, false);
 896         } else {
 897             String msg = "Controller in container mode: Install Refused";
 898             String logMsg = msg + ": {}";
 899             status = new Status(StatusCode.NOTACCEPTABLE, msg);
 900             log.warn(logMsg, flowEntry);
 901         }
 902         return status;
 903     }
 904
 905     @Override
 906     public Status installFlowEntryAsync(FlowEntry flowEntry) {
 907         Status status;
 908         if (isContainerModeAllowed(flowEntry)) {
 909             status = addEntry(flowEntry, true);
 910         } else {
 911             String msg = "Controller in container mode: Install Refused";
 912             status = new Status(StatusCode.NOTACCEPTABLE, msg);
 913             log.warn(msg);
 914         }
 915         return status;
 916     }
 917
 918     @Override
 919     public Status uninstallFlowEntry(FlowEntry flowEntry) {
 920         Status status;
 921         if (isContainerModeAllowed(flowEntry)) {
 922             status = removeEntry(flowEntry, false);
 923         } else {
 924             String msg = "Controller in container mode: Uninstall Refused";
 925             String logMsg = msg + ": {}";
 926             status = new Status(StatusCode.NOTACCEPTABLE, msg);
 927             log.warn(logMsg, flowEntry);
 928         }
 929         return status;
 930     }
 931
 932     @Override
 933     public Status uninstallFlowEntryAsync(FlowEntry flowEntry) {
 934         Status status;
 935         if (isContainerModeAllowed(flowEntry)) {
 936             status = removeEntry(flowEntry, true);
 937         } else {
 938             String msg = "Controller in container mode: Uninstall Refused";
 939             status = new Status(StatusCode.NOTACCEPTABLE, msg);
 940             log.warn(msg);
 941         }
 942         return status;
 943     }
 944
 945     @Override
 946     public Status modifyFlowEntry(FlowEntry currentFlowEntry, FlowEntry newFlowEntry) {
 947         Status status = null;
 948         if (isContainerModeAllowed(currentFlowEntry)) {
 949             status = modifyEntry(currentFlowEntry, newFlowEntry, false);
 950         } else {
 951             String msg = "Controller in container mode: Modify Refused";
 952             String logMsg = msg + ": {}";
 953             status = new Status(StatusCode.NOTACCEPTABLE, msg);
 954             log.warn(logMsg, newFlowEntry);
 955         }
 956         return status;
 957     }
 958
 959     @Override
 960     public Status modifyFlowEntryAsync(FlowEntry currentFlowEntry, FlowEntry newFlowEntry) {
 961         Status status = null;
 962         if (isContainerModeAllowed(currentFlowEntry)) {
 963             status = modifyEntry(currentFlowEntry, newFlowEntry, true);
 964         } else {
 965             String msg = "Controller in container mode: Modify Refused";
 966             status = new Status(StatusCode.NOTACCEPTABLE, msg);
 967             log.warn(msg);
 968         }
 969         return status;
 970     }
 971
 972     /**
 973      * Returns whether the specified flow entry is allowed to be
 974      * installed/removed/modified based on the current container mode status.
 975      * This call always returns true in the container instance of forwarding
 976      * rules manager. It is meant for the global instance only (default
 977      * container) of forwarding rules manager. Idea is that for assuring
 978      * container isolation of traffic, flow installation in default container is
 979      * blocked when in container mode (containers are present). The only flows
 980      * that are allowed in container mode in the default container are the
 981      * proactive flows, the ones automatically installed on the network node
 982      * which forwarding mode has been configured to "proactive". These flows are
 983      * needed by controller to discover the nodes topology and to discover the
 984      * attached hosts for some SDN switches.
 985      *
 986      * @param flowEntry
 987      *            The flow entry to be installed/removed/modified
 988      * @return true if not in container mode or if flowEntry is internally
 989      *         generated
 990      */
 991     private boolean isContainerModeAllowed(FlowEntry flowEntry) {
 992         return (!inContainerMode) ? true : flowEntry.isInternal();
 993     }
 994
 995     @Override
 996     public Status modifyOrAddFlowEntry(FlowEntry newFlowEntry) {
 997         /*
 998          * Run a check on the original entries to decide whether to go with a
 999          * add or modify method. A loose check means only check against the
1000          * original flow entry requests and not against the installed flow
1001          * entries which are the result of the original entry merged with the
1002          * container flow(s) (if any). The modifyFlowEntry method in presence of
1003          * conflicts with the Container flows (if any) would revert back to a
1004          * delete + add pattern
1005          */
1006         FlowEntry currentFlowEntry = originalSwView.get(newFlowEntry);
1007
1008         if (currentFlowEntry != null) {
1009             return modifyFlowEntry(currentFlowEntry, newFlowEntry);
1010         } else {
1011             return installFlowEntry(newFlowEntry);
1012         }
1013     }
1014
1015     @Override
1016     public Status modifyOrAddFlowEntryAsync(FlowEntry newFlowEntry) {
1017         /*
1018          * Run a check on the original entries to decide whether to go with a
1019          * add or modify method. A loose check means only check against the
1020          * original flow entry requests and not against the installed flow
1021          * entries which are the result of the original entry merged with the
1022          * container flow(s) (if any). The modifyFlowEntry method in presence of
1023          * conflicts with the Container flows (if any) would revert back to a
1024          * delete + add pattern
1025          */
1026         FlowEntry currentFlowEntry = originalSwView.get(newFlowEntry);
1027
1028         if (currentFlowEntry != null) {
1029             return modifyFlowEntryAsync(currentFlowEntry, newFlowEntry);
1030         } else {
1031             return installFlowEntryAsync(newFlowEntry);
1032         }
1033     }
1034
1035     @Override
1036     public Status uninstallFlowEntryGroup(String groupName) {
1037         if (groupName == null || groupName.isEmpty()) {
1038             return new Status(StatusCode.BADREQUEST, "Invalid group name");
1039         }
1040         if (groupName.equals(FlowConfig.INTERNALSTATICFLOWGROUP)) {
1041             return new Status(StatusCode.BADREQUEST, "Internal static flows group cannot be deleted through this api");
1042         }
1043         if (inContainerMode) {
1044             String msg = "Controller in container mode: Group Uninstall Refused";
1045             String logMsg = msg + ": {}";
1046             log.warn(logMsg, groupName);
1047             return new Status(StatusCode.NOTACCEPTABLE, msg);
1048         }
1049         int toBeRemoved = 0;
1050         String error = "";
1051         if (groupFlows.containsKey(groupName)) {
1052             List<FlowEntryInstall> list = new ArrayList<FlowEntryInstall>(groupFlows.get(groupName));
1053             toBeRemoved = list.size();
1054             for (FlowEntryInstall entry : list) {
1055                 Status status = this.removeEntry(entry.getOriginal(), false);
1056                 if (status.isSuccess()) {
1057                     toBeRemoved -= 1;
1058                 } else {
1059                     error = status.getDescription();
1060                 }
1061             }
1062         }
1063         return (toBeRemoved == 0) ? new Status(StatusCode.SUCCESS) : new Status(StatusCode.INTERNALERROR,
1064                 "Not all the flows were removed: " + error);
1065     }
1066
1067     @Override
1068     public Status uninstallFlowEntryGroupAsync(String groupName) {
1069         if (groupName == null || groupName.isEmpty()) {
1070             return new Status(StatusCode.BADREQUEST, "Invalid group name");
1071         }
1072         if (groupName.equals(FlowConfig.INTERNALSTATICFLOWGROUP)) {
1073             return new Status(StatusCode.BADREQUEST, "Static flows group cannot be deleted through this api");
1074         }
1075         if (inContainerMode) {
1076             String msg = "Controller in container mode: Group Uninstall Refused";
1077             String logMsg = msg + ": {}";
1078             log.warn(logMsg, groupName);
1079             return new Status(StatusCode.NOTACCEPTABLE, msg);
1080         }
1081         if (groupFlows.containsKey(groupName)) {
1082             List<FlowEntryInstall> list = new ArrayList<FlowEntryInstall>(groupFlows.get(groupName));
1083             for (FlowEntryInstall entry : list) {
1084                 this.removeEntry(entry.getOriginal(), true);
1085             }
1086         }
1087         return new Status(StatusCode.SUCCESS);
1088     }
1089
1090     @Override
1091     public boolean checkFlowEntryConflict(FlowEntry flowEntry) {
1092         return entryConflictsWithContainerFlows(flowEntry);
1093     }
1094
1095     /**
1096      * Updates all installed flows because the container flow got updated This
1097      * is obtained in two phases on per node basis: 1) Uninstall of all flows 2)
1098      * Reinstall of all flows This is needed because a new container flows
1099      * merged flow may conflict with an existing old container flows merged flow
1100      * on the network node
1101      */
1102     private void updateFlowsContainerFlow() {
1103         Set<FlowEntry> toReInstall = new HashSet<FlowEntry>();
1104         // First remove all installed entries
1105         for (ConcurrentMap.Entry<FlowEntryInstall, FlowEntryInstall> entry : installedSwView.entrySet()) {
1106             FlowEntryInstall current = entry.getValue();
1107             // Store the original entry
1108             toReInstall.add(current.getOriginal());
1109             // Remove the old couples. No validity checks to be run, use the
1110             // internal remove
1111             this.removeEntryInternal(current, false);
1112         }
1113         // Then reinstall the original entries
1114         for (FlowEntry entry : toReInstall) {
1115             // Reinstall the original flow entries, via the regular path: new
1116             // cFlow merge + validations
1117             this.installFlowEntry(entry);
1118         }
1119     }
1120
1121     private void nonClusterObjectCreate() {
1122         originalSwView = new ConcurrentHashMap<FlowEntry, FlowEntry>();
1123         installedSwView = new ConcurrentHashMap<FlowEntryInstall, FlowEntryInstall>();
1124         nodeFlows = new ConcurrentHashMap<Node, List<FlowEntryInstall>>();
1125         groupFlows = new ConcurrentHashMap<String, List<FlowEntryInstall>>();
1126         TSPolicies = new ConcurrentHashMap<String, Object>();
1127         staticFlowsOrdinal = new ConcurrentHashMap<Integer, Integer>();
1128         portGroupConfigs = new ConcurrentHashMap<String, PortGroupConfig>();
1129         portGroupData = new ConcurrentHashMap<PortGroupConfig, Map<Node, PortGroup>>();
1130         staticFlows = new ConcurrentHashMap<Integer, FlowConfig>();
1131         inactiveFlows = new ConcurrentHashMap<FlowEntry, FlowEntry>();
1132     }
1133
1134     private void registerWithOSGIConsole() {
1135         BundleContext bundleContext = FrameworkUtil.getBundle(this.getClass()).getBundleContext();
1136         bundleContext.registerService(CommandProvider.class.getName(), this, null);
1137     }
1138
1139     @Override
1140     public void setTSPolicyData(String policyname, Object o, boolean add) {
1141
1142         if (add) {
1143             /* Check if this policy already exists */
1144             if (!(TSPolicies.containsKey(policyname))) {
1145                 TSPolicies.put(policyname, o);
1146             }
1147         } else {
1148             TSPolicies.remove(policyname);
1149         }
1150         if (frmAware != null) {
1151             synchronized (frmAware) {
1152                 for (IForwardingRulesManagerAware frma : frmAware) {
1153                     try {
1154                         frma.policyUpdate(policyname, add);
1155                     } catch (Exception e) {
1156                         log.warn("Exception on callback", e);
1157                     }
1158                 }
1159             }
1160         }
1161     }
1162
1163     @Override
1164     public Map<String, Object> getTSPolicyData() {
1165         return TSPolicies;
1166     }
1167
1168     @Override
1169     public Object getTSPolicyData(String policyName) {
1170         if (TSPolicies.containsKey(policyName)) {
1171             return TSPolicies.get(policyName);
1172         } else {
1173             return null;
1174         }
1175     }
1176
1177     @Override
1178     public List<FlowEntry> getFlowEntriesForGroup(String policyName) {
1179         List<FlowEntry> list = new ArrayList<FlowEntry>();
1180         if (policyName != null && !policyName.trim().isEmpty()) {
1181             for (Map.Entry<FlowEntry, FlowEntry> entry : this.originalSwView.entrySet()) {
1182                 if (policyName.equals(entry.getKey().getGroupName())) {
1183                     list.add(entry.getKey().clone());
1184                 }
1185             }
1186         }
1187         return list;
1188     }
1189
1190     @Override
1191     public List<FlowEntry> getInstalledFlowEntriesForGroup(String policyName) {
1192         List<FlowEntry> list = new ArrayList<FlowEntry>();
1193         if (policyName != null && !policyName.trim().isEmpty()) {
1194             for (Map.Entry<FlowEntryInstall, FlowEntryInstall> entry : this.installedSwView.entrySet()) {
1195                 if (policyName.equals(entry.getKey().getGroupName())) {
1196                     list.add(entry.getKey().getInstall().clone());
1197                 }
1198             }
1199         }
1200         return list;
1201     }
1202
1203     @Override
1204     public void addOutputPort(Node node, String flowName, List<NodeConnector> portList) {
1205
1206         for (FlowEntryInstall flow : this.nodeFlows.get(node)) {
1207             if (flow.getFlowName().equals(flowName)) {
1208                 FlowEntry currentFlowEntry = flow.getOriginal();
1209                 FlowEntry newFlowEntry = currentFlowEntry.clone();
1210                 for (NodeConnector dstPort : portList) {
1211                     newFlowEntry.getFlow().addAction(new Output(dstPort));
1212                 }
1213                 Status error = modifyEntry(currentFlowEntry, newFlowEntry, false);
1214                 if (error.isSuccess()) {
1215                     log.info("Ports {} added to FlowEntry {}", portList, flowName);
1216                 } else {
1217                     log.warn("Failed to add ports {} to Flow entry {}. The failure is: {}", portList,
1218                             currentFlowEntry.toString(), error.getDescription());
1219                 }
1220                 return;
1221             }
1222         }
1223         log.warn("Failed to add ports to Flow {} on Node {}: Entry Not Found", flowName, node);
1224     }
1225
1226     @Override
1227     public void removeOutputPort(Node node, String flowName, List<NodeConnector> portList) {
1228         for (FlowEntryInstall index : this.nodeFlows.get(node)) {
1229             FlowEntryInstall flow = this.installedSwView.get(index);
1230             if (flow.getFlowName().equals(flowName)) {
1231                 FlowEntry currentFlowEntry = flow.getOriginal();
1232                 FlowEntry newFlowEntry = currentFlowEntry.clone();
1233                 for (NodeConnector dstPort : portList) {
1234                     Action action = new Output(dstPort);
1235                     newFlowEntry.getFlow().removeAction(action);
1236                 }
1237                 Status status = modifyEntry(currentFlowEntry, newFlowEntry, false);
1238                 if (status.isSuccess()) {
1239                     log.info("Ports {} removed from FlowEntry {}", portList, flowName);
1240                 } else {
1241                     log.warn("Failed to remove ports {} from Flow entry {}. The failure is: {}", portList,
1242                             currentFlowEntry.toString(), status.getDescription());
1243                 }
1244                 return;
1245             }
1246         }
1247         log.warn("Failed to remove ports from Flow {} on Node {}: Entry Not Found", flowName, node);
1248     }
1249
1250     /*
1251      * This function assumes the target flow has only one output port
1252      */
1253     @Override
1254     public void replaceOutputPort(Node node, String flowName, NodeConnector outPort) {
1255         FlowEntry currentFlowEntry = null;
1256         FlowEntry newFlowEntry = null;
1257
1258         // Find the flow
1259         for (FlowEntryInstall index : this.nodeFlows.get(node)) {
1260             FlowEntryInstall flow = this.installedSwView.get(index);
1261             if (flow.getFlowName().equals(flowName)) {
1262                 currentFlowEntry = flow.getOriginal();
1263                 break;
1264             }
1265         }
1266         if (currentFlowEntry == null) {
1267             log.warn("Failed to replace output port for flow {} on node {}: Entry Not Found", flowName, node);
1268             return;
1269         }
1270
1271         // Create a flow copy with the new output port
1272         newFlowEntry = currentFlowEntry.clone();
1273         Action target = null;
1274         for (Action action : newFlowEntry.getFlow().getActions()) {
1275             if (action.getType() == ActionType.OUTPUT) {
1276                 target = action;
1277                 break;
1278             }
1279         }
1280         newFlowEntry.getFlow().removeAction(target);
1281         newFlowEntry.getFlow().addAction(new Output(outPort));
1282
1283         // Modify on network node
1284         Status status = modifyEntry(currentFlowEntry, newFlowEntry, false);
1285
1286         if (status.isSuccess()) {
1287             log.info("Output port replaced with {} for flow {} on node {}", outPort, flowName, node);
1288         } else {
1289             log.warn("Failed to replace output port for flow {} on node {}. The failure is: {}", flowName, node,
1290                     status.getDescription());
1291         }
1292         return;
1293     }
1294
1295     @Override
1296     public NodeConnector getOutputPort(Node node, String flowName) {
1297         for (FlowEntryInstall index : this.nodeFlows.get(node)) {
1298             FlowEntryInstall flow = this.installedSwView.get(index);
1299             if (flow.getFlowName().equals(flowName)) {
1300                 for (Action action : flow.getOriginal().getFlow().getActions()) {
1301                     if (action.getType() == ActionType.OUTPUT) {
1302                         return ((Output) action).getPort();
1303                     }
1304                 }
1305             }
1306         }
1307         return null;
1308     }
1309
1310     private void cacheStartup() {
1311         allocateCaches();
1312         retrieveCaches();
1313     }
1314
1315     @SuppressWarnings("deprecation")
1316     private void allocateCaches() {
1317         if (this.clusterContainerService == null) {
1318             log.warn("Un-initialized clusterContainerService, can't create cache");
1319             return;
1320         }
1321
1322         log.debug("Allocating caches for Container {}", container.getName());
1323
1324         try {
1325             clusterContainerService.createCache("frm.originalSwView",
1326                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1327
1328             clusterContainerService.createCache("frm.installedSwView",
1329                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1330
1331             clusterContainerService.createCache("frm.inactiveFlows",
1332                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1333
1334             clusterContainerService.createCache("frm.nodeFlows",
1335                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1336
1337             clusterContainerService.createCache("frm.groupFlows",
1338                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1339
1340             clusterContainerService.createCache("frm.staticFlows",
1341                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1342
1343             clusterContainerService.createCache("frm.flowsSaveEvent",
1344                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1345
1346             clusterContainerService.createCache("frm.staticFlowsOrdinal",
1347                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1348
1349             clusterContainerService.createCache("frm.portGroupConfigs",
1350                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1351
1352             clusterContainerService.createCache("frm.portGroupData",
1353                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1354
1355             clusterContainerService.createCache("frm.TSPolicies",
1356                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1357
1358             clusterContainerService.createCache(WORKSTATUSCACHE,
1359  EnumSet.of(IClusterServices.cacheMode.NON_TRANSACTIONAL));
1360
1361             clusterContainerService.createCache(WORKORDERCACHE,
1362  EnumSet.of(IClusterServices.cacheMode.NON_TRANSACTIONAL));
1363
1364         } catch (CacheConfigException cce) {
1365             log.error("CacheConfigException");
1366         } catch (CacheExistException cce) {
1367             log.error("CacheExistException");
1368         }
1369     }
1370
1371     @SuppressWarnings({ "unchecked", "deprecation" })
1372     private void retrieveCaches() {
1373         ConcurrentMap<?, ?> map;
1374
1375         if (this.clusterContainerService == null) {
1376             log.warn("un-initialized clusterContainerService, can't retrieve cache");
1377             nonClusterObjectCreate();
1378             return;
1379         }
1380
1381         log.debug("Retrieving Caches for Container {}", container.getName());
1382
1383         map = clusterContainerService.getCache("frm.originalSwView");
1384         if (map != null) {
1385             originalSwView = (ConcurrentMap<FlowEntry, FlowEntry>) map;
1386         } else {
1387             log.error("Retrieval of frm.originalSwView cache failed for Container {}", container.getName());
1388         }
1389
1390         map = clusterContainerService.getCache("frm.installedSwView");
1391         if (map != null) {
1392             installedSwView = (ConcurrentMap<FlowEntryInstall, FlowEntryInstall>) map;
1393         } else {
1394             log.error("Retrieval of frm.installedSwView cache failed for Container {}", container.getName());
1395         }
1396
1397         map = clusterContainerService.getCache("frm.inactiveFlows");
1398         if (map != null) {
1399             inactiveFlows = (ConcurrentMap<FlowEntry, FlowEntry>) map;
1400         } else {
1401             log.error("Retrieval of frm.inactiveFlows cache failed for Container {}", container.getName());
1402         }
1403
1404         map = clusterContainerService.getCache("frm.nodeFlows");
1405         if (map != null) {
1406             nodeFlows = (ConcurrentMap<Node, List<FlowEntryInstall>>) map;
1407         } else {
1408             log.error("Retrieval of cache failed for Container {}", container.getName());
1409         }
1410
1411         map = clusterContainerService.getCache("frm.groupFlows");
1412         if (map != null) {
1413             groupFlows = (ConcurrentMap<String, List<FlowEntryInstall>>) map;
1414         } else {
1415             log.error("Retrieval of frm.groupFlows cache failed for Container {}", container.getName());
1416         }
1417
1418         map = clusterContainerService.getCache("frm.staticFlows");
1419         if (map != null) {
1420             staticFlows = (ConcurrentMap<Integer, FlowConfig>) map;
1421         } else {
1422             log.error("Retrieval of frm.staticFlows cache failed for Container {}", container.getName());
1423         }
1424
1425         map = clusterContainerService.getCache("frm.staticFlowsOrdinal");
1426         if (map != null) {
1427             staticFlowsOrdinal = (ConcurrentMap<Integer, Integer>) map;
1428         } else {
1429             log.error("Retrieval of frm.staticFlowsOrdinal cache failed for Container {}", container.getName());
1430         }
1431
1432         map = clusterContainerService.getCache("frm.portGroupConfigs");
1433         if (map != null) {
1434             portGroupConfigs = (ConcurrentMap<String, PortGroupConfig>) map;
1435         } else {
1436             log.error("Retrieval of frm.portGroupConfigs cache failed for Container {}", container.getName());
1437         }
1438
1439         map = clusterContainerService.getCache("frm.portGroupData");
1440         if (map != null) {
1441             portGroupData = (ConcurrentMap<PortGroupConfig, Map<Node, PortGroup>>) map;
1442         } else {
1443             log.error("Retrieval of frm.portGroupData allocation failed for Container {}", container.getName());
1444         }
1445
1446         map = clusterContainerService.getCache("frm.TSPolicies");
1447         if (map != null) {
1448             TSPolicies = (ConcurrentMap<String, Object>) map;
1449         } else {
1450             log.error("Retrieval of frm.TSPolicies cache failed for Container {}", container.getName());
1451         }
1452
1453         map = clusterContainerService.getCache(WORKORDERCACHE);
1454         if (map != null) {
1455             workOrder = (ConcurrentMap<FlowEntryDistributionOrder, FlowEntryInstall>) map;
1456         } else {
1457             log.error("Retrieval of " + WORKORDERCACHE + " cache failed for Container {}", container.getName());
1458         }
1459
1460         map = clusterContainerService.getCache(WORKSTATUSCACHE);
1461         if (map != null) {
1462             workStatus = (ConcurrentMap<FlowEntryDistributionOrder, Status>) map;
1463         } else {
1464             log.error("Retrieval of " + WORKSTATUSCACHE + " cache failed for Container {}", container.getName());
1465         }
1466     }
1467
1468     private boolean flowConfigExists(FlowConfig config) {
1469         // Flow name has to be unique on per node id basis
1470         for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1471             if (entry.getValue().isByNameAndNodeIdEqual(config)) {
1472                 return true;
1473             }
1474         }
1475         return false;
1476     }
1477
1478     @Override
1479     public Status addStaticFlow(FlowConfig config) {
1480         // Configuration object validation
1481         Status status = config.validate(container);
1482         if (!status.isSuccess()) {
1483             log.warn("Invalid Configuration for flow {}. The failure is {}", config, status.getDescription());
1484             String error = "Invalid Configuration (" + status.getDescription() + ")";
1485             config.setStatus(error);
1486             return new Status(StatusCode.BADREQUEST, error);
1487         }
1488         return addStaticFlowInternal(config, false);
1489     }
1490
1491     /**
1492      * Private method to add a static flow configuration which does not run any
1493      * validation on the passed FlowConfig object. If restore is set to true,
1494      * configuration is stored in configuration database regardless the
1495      * installation on the network node was successful. This is useful at boot
1496      * when static flows are present in startup configuration and are read
1497      * before the switches connects.
1498      *
1499      * @param config
1500      *            The static flow configuration
1501      * @param restore
1502      *            if true, the configuration is stored regardless the
1503      *            installation on the network node was successful
1504      * @return The status of this request
1505      */
1506     private Status addStaticFlowInternal(FlowConfig config, boolean restore) {
1507         boolean multipleFlowPush = false;
1508         String error;
1509         Status status;
1510         config.setStatus(SUCCESS);
1511
1512         // Presence check
1513         if (flowConfigExists(config)) {
1514             error = "Entry with this name on specified switch already exists";
1515             log.warn("Entry with this name on specified switch already exists: {}", config);
1516             config.setStatus(error);
1517             return new Status(StatusCode.CONFLICT, error);
1518         }
1519
1520         if ((config.getIngressPort() == null) && config.getPortGroup() != null) {
1521             for (String portGroupName : portGroupConfigs.keySet()) {
1522                 if (portGroupName.equalsIgnoreCase(config.getPortGroup())) {
1523                     multipleFlowPush = true;
1524                     break;
1525                 }
1526             }
1527             if (!multipleFlowPush) {
1528                 log.warn("Invalid Configuration(Invalid PortGroup Name) for flow {}", config);
1529                 error = "Invalid Configuration (Invalid PortGroup Name)";
1530                 config.setStatus(error);
1531                 return new Status(StatusCode.BADREQUEST, error);
1532             }
1533         }
1534
1535         /*
1536          * If requested program the entry in hardware first before updating the
1537          * StaticFlow DB
1538          */
1539         if (!multipleFlowPush) {
1540             // Program hw
1541             if (config.installInHw()) {
1542                 FlowEntry entry = config.getFlowEntry();
1543                 status = this.installFlowEntry(entry);
1544                 if (!status.isSuccess()) {
1545                     config.setStatus(status.getDescription());
1546                     if (!restore) {
1547                         return status;
1548                     }
1549                 }
1550             }
1551         }
1552
1553         /*
1554          * When the control reaches this point, either of the following
1555          * conditions is true 1. This is a single entry configuration (non
1556          * PortGroup) and the hardware installation is successful 2. This is a
1557          * multiple entry configuration (PortGroup) and hardware installation is
1558          * NOT done directly on this event. 3. The User prefers to retain the
1559          * configuration in Controller and skip hardware installation.
1560          *
1561          * Hence it is safe to update the StaticFlow DB at this point.
1562          *
1563          * Note : For the case of PortGrouping, it is essential to have this DB
1564          * populated before the PortGroupListeners can query for the DB
1565          * triggered using portGroupChanged event...
1566          */
1567         Integer ordinal = staticFlowsOrdinal.get(0);
1568         staticFlowsOrdinal.put(0, ++ordinal);
1569         staticFlows.put(ordinal, config);
1570
1571         if (multipleFlowPush) {
1572             PortGroupConfig pgconfig = portGroupConfigs.get(config.getPortGroup());
1573             Map<Node, PortGroup> existingData = portGroupData.get(pgconfig);
1574             if (existingData != null) {
1575                 portGroupChanged(pgconfig, existingData, true);
1576             }
1577         }
1578         return new Status(StatusCode.SUCCESS);
1579     }
1580
1581     private void addStaticFlowsToSwitch(Node node) {
1582         for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1583             FlowConfig config = entry.getValue();
1584             if (config.isPortGroupEnabled()) {
1585                 continue;
1586             }
1587             if (config.getNode().equals(node)) {
1588                 if (config.installInHw() && !config.getStatus().equals(SUCCESS)) {
1589                     Status status = this.installFlowEntryAsync(config.getFlowEntry());
1590                     config.setStatus(status.getDescription());
1591                 }
1592             }
1593         }
1594         // Update cluster cache
1595         refreshClusterStaticFlowsStatus(node);
1596     }
1597
1598     private void updateStaticFlowConfigsOnNodeDown(Node node) {
1599         log.trace("Updating Static Flow configs on node down: {}", node);
1600
1601         List<Integer> toRemove = new ArrayList<Integer>();
1602         for (Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1603
1604             FlowConfig config = entry.getValue();
1605
1606             if (config.isPortGroupEnabled()) {
1607                 continue;
1608             }
1609
1610             if (config.installInHw() && config.getNode().equals(node)) {
1611                 if (config.isInternalFlow()) {
1612                     // Take note of this controller generated static flow
1613                     toRemove.add(entry.getKey());
1614                 } else {
1615                     config.setStatus(NODEDOWN);
1616                 }
1617             }
1618         }
1619         // Remove controller generated static flows for this node
1620         for (Integer index : toRemove) {
1621             staticFlows.remove(index);
1622         }
1623         // Update cluster cache
1624         refreshClusterStaticFlowsStatus(node);
1625
1626     }
1627
1628     private void updateStaticFlowConfigsOnContainerModeChange(UpdateType update) {
1629         log.trace("Updating Static Flow configs on container mode change: {}", update);
1630
1631         for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1632             FlowConfig config = entry.getValue();
1633             if (config.isPortGroupEnabled()) {
1634                 continue;
1635             }
1636             if (config.installInHw() && !config.isInternalFlow()) {
1637                 switch (update) {
1638                 case ADDED:
1639                     config.setStatus("Removed from node because in container mode");
1640                     break;
1641                 case REMOVED:
1642                     config.setStatus(SUCCESS);
1643                     break;
1644                 default:
1645                 }
1646             }
1647         }
1648         // Update cluster cache
1649         refreshClusterStaticFlowsStatus(null);
1650     }
1651
1652     @Override
1653     public Status removeStaticFlow(FlowConfig config) {
1654         /*
1655          * No config.isInternal() check as NB does not take this path and GUI
1656          * cannot issue a delete on an internal generated flow. We need this
1657          * path to be accessible when switch mode is changed from proactive to
1658          * reactive, so that we can remove the internal generated LLDP and ARP
1659          * punt flows
1660          */
1661
1662         // Look for the target configuration entry
1663         Integer key = 0;
1664         FlowConfig target = null;
1665         for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1666             if (entry.getValue().isByNameAndNodeIdEqual(config)) {
1667                 key = entry.getKey();
1668                 target = entry.getValue();
1669                 break;
1670             }
1671         }
1672         if (target == null) {
1673             return new Status(StatusCode.NOTFOUND, "Entry Not Present");
1674         }
1675
1676         // Program the network node
1677         Status status = this.uninstallFlowEntry(config.getFlowEntry());
1678
1679         // Update configuration database if programming was successful
1680         if (status.isSuccess()) {
1681             staticFlows.remove(key);
1682         }
1683
1684         return status;
1685     }
1686
1687     @Override
1688     public Status removeStaticFlow(String name, Node node) {
1689         // Look for the target configuration entry
1690         Integer key = 0;
1691         FlowConfig target = null;
1692         for (ConcurrentMap.Entry<Integer, FlowConfig> mapEntry : staticFlows.entrySet()) {
1693             if (mapEntry.getValue().isByNameAndNodeIdEqual(name, node)) {
1694                 key = mapEntry.getKey();
1695                 target = mapEntry.getValue();
1696                 break;
1697             }
1698         }
1699         if (target == null) {
1700             return new Status(StatusCode.NOTFOUND, "Entry Not Present");
1701         }
1702
1703         // Validity check for api3 entry point
1704         if (target.isInternalFlow()) {
1705             String msg = "Invalid operation: Controller generated flow cannot be deleted";
1706             String logMsg = msg + ": {}";
1707             log.warn(logMsg, name);
1708             return new Status(StatusCode.NOTACCEPTABLE, msg);
1709         }
1710
1711         if (target.isPortGroupEnabled()) {
1712             String msg = "Invalid operation: Port Group flows cannot be deleted through this API";
1713             String logMsg = msg + ": {}";
1714             log.warn(logMsg, name);
1715             return new Status(StatusCode.NOTACCEPTABLE, msg);
1716         }
1717
1718         // Program the network node
1719         Status status = this.removeEntry(target.getFlowEntry(), false);
1720
1721         // Update configuration database if programming was successful
1722         if (status.isSuccess()) {
1723             staticFlows.remove(key);
1724         }
1725
1726         return status;
1727     }
1728
1729     @Override
1730     public Status modifyStaticFlow(FlowConfig newFlowConfig) {
1731         // Validity check for api3 entry point
1732         if (newFlowConfig.isInternalFlow()) {
1733             String msg = "Invalid operation: Controller generated flow cannot be modified";
1734             String logMsg = msg + ": {}";
1735             log.warn(logMsg, newFlowConfig);
1736             return new Status(StatusCode.NOTACCEPTABLE, msg);
1737         }
1738
1739         // Validity Check
1740         Status status = newFlowConfig.validate(container);
1741         if (!status.isSuccess()) {
1742             String msg = "Invalid Configuration (" + status.getDescription() + ")";
1743             newFlowConfig.setStatus(msg);
1744             log.warn("Invalid Configuration for flow {}. The failure is {}", newFlowConfig, status.getDescription());
1745             return new Status(StatusCode.BADREQUEST, msg);
1746         }
1747
1748         FlowConfig oldFlowConfig = null;
1749         Integer index = null;
1750         for (ConcurrentMap.Entry<Integer, FlowConfig> mapEntry : staticFlows.entrySet()) {
1751             FlowConfig entry = mapEntry.getValue();
1752             if (entry.isByNameAndNodeIdEqual(newFlowConfig.getName(), newFlowConfig.getNode())) {
1753                 oldFlowConfig = entry;
1754                 index = mapEntry.getKey();
1755                 break;
1756             }
1757         }
1758
1759         if (oldFlowConfig == null) {
1760             String msg = "Attempt to modify a non existing static flow";
1761             String logMsg = msg + ": {}";
1762             log.warn(logMsg, newFlowConfig);
1763             return new Status(StatusCode.NOTFOUND, msg);
1764         }
1765
1766         // Do not attempt to reinstall the flow, warn user
1767         if (newFlowConfig.equals(oldFlowConfig)) {
1768             String msg = "No modification detected";
1769             log.info("Static flow modification skipped. New flow and old flow are the same: {}", newFlowConfig);
1770             return new Status(StatusCode.SUCCESS, msg);
1771         }
1772
1773         // If flow is installed, program the network node
1774         status = new Status(StatusCode.SUCCESS, "Saved in config");
1775         if (oldFlowConfig.installInHw()) {
1776             status = this.modifyFlowEntry(oldFlowConfig.getFlowEntry(), newFlowConfig.getFlowEntry());
1777         }
1778
1779         // Update configuration database if programming was successful
1780         if (status.isSuccess()) {
1781             newFlowConfig.setStatus(status.getDescription());
1782             staticFlows.put(index, newFlowConfig);
1783         }
1784
1785         return status;
1786     }
1787
1788     @Override
1789     public Status toggleStaticFlowStatus(String name, Node node) {
1790         return toggleStaticFlowStatus(getStaticFlow(name, node));
1791     }
1792
1793     @Override
1794     public Status toggleStaticFlowStatus(FlowConfig config) {
1795         if (config == null) {
1796             String msg = "Invalid request: null flow config";
1797             log.warn(msg);
1798             return new Status(StatusCode.BADREQUEST, msg);
1799         }
1800         // Validity check for api3 entry point
1801         if (config.isInternalFlow()) {
1802             String msg = "Invalid operation: Controller generated flow cannot be modified";
1803             String logMsg = msg + ": {}";
1804             log.warn(logMsg, config);
1805             return new Status(StatusCode.NOTACCEPTABLE, msg);
1806         }
1807
1808         // Find the config entry
1809         Integer key = 0;
1810         FlowConfig target = null;
1811         for (Map.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1812             FlowConfig conf = entry.getValue();
1813             if (conf.isByNameAndNodeIdEqual(config)) {
1814                 key = entry.getKey();
1815                 target = conf;
1816                 break;
1817             }
1818         }
1819         if (target != null) {
1820             Status status = target.validate(container);
1821             if (!status.isSuccess()) {
1822                 log.warn(status.getDescription());
1823                 return status;
1824             }
1825             status = (target.installInHw()) ? this.uninstallFlowEntry(target.getFlowEntry()) : this
1826                                     .installFlowEntry(target.getFlowEntry());
1827             if (status.isSuccess()) {
1828                 // Update Configuration database
1829                 target.setStatus(SUCCESS);
1830                 target.toggleInstallation();
1831                 staticFlows.put(key, target);
1832             }
1833             return status;
1834         }
1835
1836         return new Status(StatusCode.NOTFOUND, "Unable to locate the entry. Failed to toggle status");
1837     }
1838
1839     /**
1840      * Reinsert all static flows entries in the cache to force cache updates in
1841      * the cluster. This is useful when only some parameters were changed in the
1842      * entries, like the status.
1843      *
1844      * @param node
1845      *            The node for which the static flow configurations have to be
1846      *            refreshed. If null, all nodes static flows will be refreshed.
1847      */
1848     private void refreshClusterStaticFlowsStatus(Node node) {
1849         // Refresh cluster cache
1850         for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1851             if (node == null || entry.getValue().getNode().equals(node)) {
1852                 staticFlows.put(entry.getKey(), entry.getValue());
1853             }
1854         }
1855     }
1856
1857     /**
1858      * Uninstall all the non-internal Flow Entries present in the software view.
1859      * If requested, a copy of each original flow entry will be stored in the
1860      * inactive list so that it can be re-applied when needed (This is typically
1861      * the case when running in the default container and controller moved to
1862      * container mode)
1863      *
1864      * @param preserveFlowEntries
1865      *            if true, a copy of each original entry is stored in the
1866      *            inactive list
1867      */
1868     private void uninstallAllFlowEntries(boolean preserveFlowEntries) {
1869         log.info("Uninstalling all non-internal flows");
1870
1871         List<FlowEntryInstall> toRemove = new ArrayList<FlowEntryInstall>();
1872
1873         // Store entries / create target list
1874         for (ConcurrentMap.Entry<FlowEntryInstall, FlowEntryInstall> mapEntry : installedSwView.entrySet()) {
1875             FlowEntryInstall flowEntries = mapEntry.getValue();
1876             // Skip internal generated static flows
1877             if (!flowEntries.isInternal()) {
1878                 toRemove.add(flowEntries);
1879                 // Store the original entries if requested
1880                 if (preserveFlowEntries) {
1881                     inactiveFlows.put(flowEntries.getOriginal(), flowEntries.getOriginal());
1882                 }
1883             }
1884         }
1885
1886         // Now remove the entries
1887         for (FlowEntryInstall flowEntryHw : toRemove) {
1888             Status status = this.removeEntryInternal(flowEntryHw, false);
1889             if (!status.isSuccess()) {
1890                 log.warn("Failed to remove entry: {}. The failure is: {}", flowEntryHw, status.getDescription());
1891             }
1892         }
1893     }
1894
1895     /**
1896      * Re-install all the Flow Entries present in the inactive list The inactive
1897      * list will be empty at the end of this call This function is called on the
1898      * default container instance of FRM only when the last container is deleted
1899      */
1900     private void reinstallAllFlowEntries() {
1901         log.info("Reinstalling all inactive flows");
1902
1903         for (FlowEntry flowEntry : this.inactiveFlows.keySet()) {
1904             this.addEntry(flowEntry, false);
1905         }
1906
1907         // Empty inactive list in any case
1908         inactiveFlows.clear();
1909     }
1910
1911     @Override
1912     public List<FlowConfig> getStaticFlows() {
1913         return getStaticFlowsOrderedList(staticFlows, staticFlowsOrdinal.get(0).intValue());
1914     }
1915
1916     // TODO: need to come out with a better algorithm for maintaining the order
1917     // of the configuration entries
1918     // with actual one, index associated to deleted entries cannot be reused and
1919     // map grows...
1920     private List<FlowConfig> getStaticFlowsOrderedList(ConcurrentMap<Integer, FlowConfig> flowMap, int maxKey) {
1921         List<FlowConfig> orderedList = new ArrayList<FlowConfig>();
1922         for (int i = 0; i <= maxKey; i++) {
1923             FlowConfig entry = flowMap.get(i);
1924             if (entry != null) {
1925                 orderedList.add(entry);
1926             }
1927         }
1928         return orderedList;
1929     }
1930
1931     @Override
1932     public FlowConfig getStaticFlow(String name, Node node) {
1933         for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1934             if (entry.getValue().isByNameAndNodeIdEqual(name, node)) {
1935                 return entry.getValue();
1936             }
1937         }
1938         return null;
1939     }
1940
1941     @Override
1942     public List<FlowConfig> getStaticFlows(Node node) {
1943         List<FlowConfig> list = new ArrayList<FlowConfig>();
1944         for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1945             if (entry.getValue().onNode(node)) {
1946                 list.add(entry.getValue());
1947             }
1948         }
1949         return list;
1950     }
1951
1952     @Override
1953     public List<String> getStaticFlowNamesForNode(Node node) {
1954         List<String> list = new ArrayList<String>();
1955         for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1956             if (entry.getValue().onNode(node)) {
1957                 list.add(entry.getValue().getName());
1958             }
1959         }
1960         return list;
1961     }
1962
1963     @Override
1964     public List<Node> getListNodeWithConfiguredFlows() {
1965         Set<Node> set = new HashSet<Node>();
1966         for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1967             set.add(entry.getValue().getNode());
1968         }
1969         return new ArrayList<Node>(set);
1970     }
1971
1972     @SuppressWarnings("unchecked")
1973     private void loadFlowConfiguration() {
1974         ObjectReader objReader = new ObjectReader();
1975         ConcurrentMap<Integer, FlowConfig> confList = (ConcurrentMap<Integer, FlowConfig>) objReader.read(this,
1976                 frmFileName);
1977
1978         ConcurrentMap<String, PortGroupConfig> pgConfig = (ConcurrentMap<String, PortGroupConfig>) objReader.read(this,
1979                 portGroupFileName);
1980
1981         if (pgConfig != null) {
1982             for (ConcurrentMap.Entry<String, PortGroupConfig> entry : pgConfig.entrySet()) {
1983                 addPortGroupConfig(entry.getKey(), entry.getValue().getMatchString(), true);
1984             }
1985         }
1986
1987         if (confList == null) {
1988             return;
1989         }
1990
1991         int maxKey = 0;
1992         for (Integer key : confList.keySet()) {
1993             if (key.intValue() > maxKey) {
1994                 maxKey = key.intValue();
1995             }
1996         }
1997
1998         for (FlowConfig conf : getStaticFlowsOrderedList(confList, maxKey)) {
1999             addStaticFlowInternal(conf, true);
2000         }
2001     }
2002
2003     @Override
2004     public Object readObject(ObjectInputStream ois) throws FileNotFoundException, IOException, ClassNotFoundException {
2005         return ois.readObject();
2006     }
2007
2008     @Override
2009     public Status saveConfig() {
2010         return saveConfigInternal();
2011     }
2012
2013     private Status saveConfigInternal() {
2014         ObjectWriter objWriter = new ObjectWriter();
2015         ConcurrentMap<Integer, FlowConfig> nonDynamicFlows = new ConcurrentHashMap<Integer, FlowConfig>();
2016         for (Integer ordinal : staticFlows.keySet()) {
2017             FlowConfig config = staticFlows.get(ordinal);
2018             // Do not save dynamic and controller generated static flows
2019             if (config.isDynamic() || config.isInternalFlow()) {
2020                 continue;
2021             }
2022             nonDynamicFlows.put(ordinal, config);
2023         }
2024         objWriter.write(nonDynamicFlows, frmFileName);
2025         objWriter.write(new ConcurrentHashMap<String, PortGroupConfig>(portGroupConfigs), portGroupFileName);
2026         return new Status(StatusCode.SUCCESS, null);
2027     }
2028
2029     @Override
2030     public void subnetNotify(Subnet sub, boolean add) {
2031     }
2032
2033     private void installImplicitARPReplyPunt(Node node) {
2034
2035         if (node == null) {
2036             return;
2037         }
2038
2039         List<String> puntAction = new ArrayList<String>();
2040         puntAction.add(ActionType.CONTROLLER.toString());
2041
2042         FlowConfig allowARP = new FlowConfig();
2043         allowARP.setInstallInHw(true);
2044         allowARP.setName(FlowConfig.INTERNALSTATICFLOWBEGIN + "Punt ARP Reply" + FlowConfig.INTERNALSTATICFLOWEND);
2045         allowARP.setPriority("500");
2046         allowARP.setNode(node);
2047         allowARP.setEtherType("0x" + Integer.toHexString(EtherTypes.ARP.intValue()).toUpperCase());
2048         allowARP.setDstMac(HexEncode.bytesToHexString(switchManager.getControllerMAC()));
2049         allowARP.setActions(puntAction);
2050         addStaticFlowInternal(allowARP, true); // skip validation on internal static flow name
2051     }
2052
2053     /**
2054      * (non-Javadoc)
2055      *
2056      * @see org.opendaylight.controller.switchmanager.ISwitchManagerAware#modeChangeNotify(org.opendaylight.controller.sal.core.Node,
2057      *      boolean)
2058      *
2059      *      This method can be called from within the OSGi framework context,
2060      *      given the programming operation can take sometime, it not good
2061      *      pratice to have in it's context operations that can take time,
2062      *      hence moving off to a different thread for async processing.
2063      */
2064     private ExecutorService executor;
2065     @Override
2066     public void modeChangeNotify(final Node node, final boolean proactive) {
2067         Callable<Status> modeChangeCallable = new Callable<Status>() {
2068             @Override
2069             public Status call() throws Exception {
2070                 List<FlowConfig> defaultConfigs = new ArrayList<FlowConfig>();
2071
2072                 List<String> puntAction = new ArrayList<String>();
2073                 puntAction.add(ActionType.CONTROLLER.toString());
2074
2075                 FlowConfig allowARP = new FlowConfig();
2076                 allowARP.setInstallInHw(true);
2077                 allowARP.setName(FlowConfig.INTERNALSTATICFLOWBEGIN + "Punt ARP" + FlowConfig.INTERNALSTATICFLOWEND);
2078                 allowARP.setPriority("1");
2079                 allowARP.setNode(node);
2080                 allowARP.setEtherType("0x" + Integer.toHexString(EtherTypes.ARP.intValue())
2081                         .toUpperCase());
2082                 allowARP.setActions(puntAction);
2083                 defaultConfigs.add(allowARP);
2084
2085                 FlowConfig allowLLDP = new FlowConfig();
2086                 allowLLDP.setInstallInHw(true);
2087                 allowLLDP.setName(FlowConfig.INTERNALSTATICFLOWBEGIN + "Punt LLDP" + FlowConfig.INTERNALSTATICFLOWEND);
2088                 allowLLDP.setPriority("1");
2089                 allowLLDP.setNode(node);
2090                 allowLLDP.setEtherType("0x" + Integer.toHexString(EtherTypes.LLDP.intValue())
2091                         .toUpperCase());
2092                 allowLLDP.setActions(puntAction);
2093                 defaultConfigs.add(allowLLDP);
2094
2095                 List<String> dropAction = new ArrayList<String>();
2096                 dropAction.add(ActionType.DROP.toString());
2097
2098                 FlowConfig dropAllConfig = new FlowConfig();
2099                 dropAllConfig.setInstallInHw(true);
2100                 dropAllConfig.setName(FlowConfig.INTERNALSTATICFLOWBEGIN + "Catch-All Drop"
2101                         + FlowConfig.INTERNALSTATICFLOWEND);
2102                 dropAllConfig.setPriority("0");
2103                 dropAllConfig.setNode(node);
2104                 dropAllConfig.setActions(dropAction);
2105                 defaultConfigs.add(dropAllConfig);
2106
2107                 log.info("Forwarding mode for node {} set to {}", node, (proactive ? "proactive" : "reactive"));
2108                 for (FlowConfig fc : defaultConfigs) {
2109                     Status status = (proactive) ? addStaticFlowInternal(fc, false) : removeStaticFlow(fc);
2110                     if (status.isSuccess()) {
2111                         log.info("{} Proactive Static flow: {}", (proactive ? "Installed" : "Removed"), fc.getName());
2112                     } else {
2113                         log.warn("Failed to {} Proactive Static flow: {}", (proactive ? "install" : "remove"),
2114                                 fc.getName());
2115                     }
2116                 }
2117                 return new Status(StatusCode.SUCCESS);
2118             }
2119         };
2120
2121         /*
2122          * Execute the work outside the caller context, this could be an
2123          * expensive operation and we don't want to block the caller for it.
2124          */
2125         this.executor.submit(modeChangeCallable);
2126     }
2127
2128     /**
2129      * Remove from the databases all the flows installed on the node
2130      *
2131      * @param node
2132      */
2133     private void cleanDatabaseForNode(Node node) {
2134         log.info("Cleaning Flow database for Node {}", node);
2135         if (nodeFlows.containsKey(node)) {
2136             List<FlowEntryInstall> toRemove = new ArrayList<FlowEntryInstall>(nodeFlows.get(node));
2137
2138             for (FlowEntryInstall entry : toRemove) {
2139                 updateLocalDatabase(entry, false);
2140             }
2141         }
2142     }
2143
2144     private boolean doesFlowContainNodeConnector(Flow flow, NodeConnector nc) {
2145         if (nc == null) {
2146             return false;
2147         }
2148
2149         Match match = flow.getMatch();
2150         if (match.isPresent(MatchType.IN_PORT)) {
2151             NodeConnector matchPort = (NodeConnector) match.getField(MatchType.IN_PORT).getValue();
2152             if (matchPort.equals(nc)) {
2153                 return true;
2154             }
2155         }
2156         List<Action> actionsList = flow.getActions();
2157         if (actionsList != null) {
2158             for (Action action : actionsList) {
2159                 if (action instanceof Output) {
2160                     NodeConnector actionPort = ((Output) action).getPort();
2161                     if (actionPort.equals(nc)) {
2162                         return true;
2163                     }
2164                 }
2165             }
2166         }
2167         return false;
2168     }
2169
2170     @Override
2171     public void notifyNode(Node node, UpdateType type, Map<String, Property> propMap) {
2172         this.pendingEvents.offer(new NodeUpdateEvent(type, node));
2173     }
2174
2175     @Override
2176     public void notifyNodeConnector(NodeConnector nodeConnector, UpdateType type, Map<String, Property> propMap) {
2177
2178     }
2179
2180     private FlowConfig getDerivedFlowConfig(FlowConfig original, String configName, Short port) {
2181         FlowConfig derivedFlow = new FlowConfig(original);
2182         derivedFlow.setDynamic(true);
2183         derivedFlow.setPortGroup(null);
2184         derivedFlow.setName(original.getName() + "_" + configName + "_" + port);
2185         derivedFlow.setIngressPort(port + "");
2186         return derivedFlow;
2187     }
2188
2189     private void addPortGroupFlows(PortGroupConfig config, Node node, PortGroup data) {
2190         for (FlowConfig staticFlow : staticFlows.values()) {
2191             if (staticFlow.getPortGroup() == null) {
2192                 continue;
2193             }
2194             if ((staticFlow.getNode().equals(node)) && (staticFlow.getPortGroup().equals(config.getName()))) {
2195                 for (Short port : data.getPorts()) {
2196                     FlowConfig derivedFlow = getDerivedFlowConfig(staticFlow, config.getName(), port);
2197                     addStaticFlowInternal(derivedFlow, false);
2198                 }
2199             }
2200         }
2201     }
2202
2203     private void removePortGroupFlows(PortGroupConfig config, Node node, PortGroup data) {
2204         for (FlowConfig staticFlow : staticFlows.values()) {
2205             if (staticFlow.getPortGroup() == null) {
2206                 continue;
2207             }
2208             if (staticFlow.getNode().equals(node) && staticFlow.getPortGroup().equals(config.getName())) {
2209                 for (Short port : data.getPorts()) {
2210                     FlowConfig derivedFlow = getDerivedFlowConfig(staticFlow, config.getName(), port);
2211                     removeStaticFlow(derivedFlow);
2212                 }
2213             }
2214         }
2215     }
2216
2217     @Override
2218     public void portGroupChanged(PortGroupConfig config, Map<Node, PortGroup> data, boolean add) {
2219         log.info("PortGroup Changed for: {} Data: {}", config, portGroupData);
2220         Map<Node, PortGroup> existingData = portGroupData.get(config);
2221         if (existingData != null) {
2222             for (Map.Entry<Node, PortGroup> entry : data.entrySet()) {
2223                 PortGroup existingPortGroup = existingData.get(entry.getKey());
2224                 if (existingPortGroup == null) {
2225                     if (add) {
2226                         existingData.put(entry.getKey(), entry.getValue());
2227                         addPortGroupFlows(config, entry.getKey(), entry.getValue());
2228                     }
2229                 } else {
2230                     if (add) {
2231                         existingPortGroup.getPorts().addAll(entry.getValue().getPorts());
2232                         addPortGroupFlows(config, entry.getKey(), entry.getValue());
2233                     } else {
2234                         existingPortGroup.getPorts().removeAll(entry.getValue().getPorts());
2235                         removePortGroupFlows(config, entry.getKey(), entry.getValue());
2236                     }
2237                 }
2238             }
2239         } else {
2240             if (add) {
2241                 portGroupData.put(config, data);
2242                 for (Node swid : data.keySet()) {
2243                     addPortGroupFlows(config, swid, data.get(swid));
2244                 }
2245             }
2246         }
2247     }
2248
2249     @Override
2250     public boolean addPortGroupConfig(String name, String regex, boolean restore) {
2251         PortGroupConfig config = portGroupConfigs.get(name);
2252         if (config != null) {
2253             return false;
2254         }
2255
2256         if ((portGroupProvider == null) && !restore) {
2257             return false;
2258         }
2259         if ((portGroupProvider != null) && (!portGroupProvider.isMatchCriteriaSupported(regex))) {
2260             return false;
2261         }
2262
2263         config = new PortGroupConfig(name, regex);
2264         portGroupConfigs.put(name, config);
2265         if (portGroupProvider != null) {
2266             portGroupProvider.createPortGroupConfig(config);
2267         }
2268         return true;
2269     }
2270
2271     @Override
2272     public boolean delPortGroupConfig(String name) {
2273         PortGroupConfig config = portGroupConfigs.get(name);
2274         if (config == null) {
2275             return false;
2276         }
2277
2278         if (portGroupProvider != null) {
2279             portGroupProvider.deletePortGroupConfig(config);
2280         }
2281         portGroupConfigs.remove(name);
2282         return true;
2283     }
2284
2285     private void usePortGroupConfig(String name) {
2286         PortGroupConfig config = portGroupConfigs.get(name);
2287         if (config == null) {
2288             return;
2289         }
2290         if (portGroupProvider != null) {
2291             Map<Node, PortGroup> data = portGroupProvider.getPortGroupData(config);
2292             portGroupData.put(config, data);
2293         }
2294     }
2295
2296     @Override
2297     public Map<String, PortGroupConfig> getPortGroupConfigs() {
2298         return portGroupConfigs;
2299     }
2300
2301     public boolean isPortGroupSupported() {
2302         if (portGroupProvider == null) {
2303             return false;
2304         }
2305         return true;
2306     }
2307
2308     public void setIContainer(IContainer s) {
2309         this.container = s;
2310     }
2311
2312     public void unsetIContainer(IContainer s) {
2313         if (this.container == s) {
2314             this.container = null;
2315         }
2316     }
2317
2318     @Override
2319     public PortGroupProvider getPortGroupProvider() {
2320         return portGroupProvider;
2321     }
2322
2323     public void unsetPortGroupProvider(PortGroupProvider portGroupProvider) {
2324         this.portGroupProvider = null;
2325     }
2326
2327     public void setPortGroupProvider(PortGroupProvider portGroupProvider) {
2328         this.portGroupProvider = portGroupProvider;
2329         portGroupProvider.registerPortGroupChange(this);
2330         for (PortGroupConfig config : portGroupConfigs.values()) {
2331             portGroupProvider.createPortGroupConfig(config);
2332         }
2333     }
2334
2335     public void setFrmAware(IForwardingRulesManagerAware obj) {
2336         this.frmAware.add(obj);
2337     }
2338
2339     public void unsetFrmAware(IForwardingRulesManagerAware obj) {
2340         this.frmAware.remove(obj);
2341     }
2342
2343     void setClusterContainerService(IClusterContainerServices s) {
2344         log.debug("Cluster Service set");
2345         this.clusterContainerService = s;
2346     }
2347
2348     void unsetClusterContainerService(IClusterContainerServices s) {
2349         if (this.clusterContainerService == s) {
2350             log.debug("Cluster Service removed!");
2351             this.clusterContainerService = null;
2352         }
2353     }
2354
2355     private String getContainerName() {
2356         if (container == null) {
2357             return GlobalConstants.DEFAULT.toString();
2358         }
2359         return container.getName();
2360     }
2361
2362     /**
2363      * Function called by the dependency manager when all the required
2364      * dependencies are satisfied
2365      *
2366      */
2367     void init() {
2368         frmFileName = GlobalConstants.STARTUPHOME.toString() + "frm_staticflows_" + this.getContainerName() + ".conf";
2369         portGroupFileName = GlobalConstants.STARTUPHOME.toString() + "portgroup_" + this.getContainerName() + ".conf";
2370
2371         inContainerMode = false;
2372
2373         if (portGroupProvider != null) {
2374             portGroupProvider.registerPortGroupChange(this);
2375         }
2376
2377         cacheStartup();
2378
2379         registerWithOSGIConsole();
2380
2381         /*
2382          * If we are not the first cluster node to come up, do not initialize
2383          * the static flow entries ordinal
2384          */
2385         if (staticFlowsOrdinal.size() == 0) {
2386             staticFlowsOrdinal.put(0, Integer.valueOf(0));
2387         }
2388
2389         pendingEvents = new LinkedBlockingQueue<FRMEvent>();
2390
2391         // Initialize the event handler thread
2392         frmEventHandler = new Thread(new Runnable() {
2393             @Override
2394             public void run() {
2395                 while (!stopping) {
2396                     try {
2397                         FRMEvent event = pendingEvents.take();
2398                         if (event == null) {
2399                             log.warn("Dequeued null event");
2400                             continue;
2401                         }
2402                         if (event instanceof NodeUpdateEvent) {
2403                             NodeUpdateEvent update = (NodeUpdateEvent) event;
2404                             Node node = update.getNode();
2405                             switch (update.getUpdateType()) {
2406                             case ADDED:
2407                                 addStaticFlowsToSwitch(node);
2408                                 break;
2409                             case REMOVED:
2410                                 cleanDatabaseForNode(node);
2411                                 updateStaticFlowConfigsOnNodeDown(node);
2412                                 break;
2413                             default:
2414                             }
2415                         } else if (event instanceof ErrorReportedEvent) {
2416                             ErrorReportedEvent errEvent = (ErrorReportedEvent) event;
2417                             processErrorEvent(errEvent);
2418                         } else if (event instanceof WorkOrderEvent) {
2419                             /*
2420                              * Take care of handling the remote Work request
2421                              */
2422                             WorkOrderEvent work = (WorkOrderEvent) event;
2423                             FlowEntryDistributionOrder fe = work.getFe();
2424                             if (fe != null) {
2425                                 logsync.trace("Executing the workOrder {}", fe);
2426                                 Status gotStatus = null;
2427                                 FlowEntryInstall feiCurrent = fe.getEntry();
2428                                 FlowEntryInstall feiNew = workOrder.get(fe.getEntry());
2429                                 switch (fe.getUpType()) {
2430                                 case ADDED:
2431                                     /*
2432                                      * TODO: Not still sure how to handle the
2433                                      * sync entries
2434                                      */
2435                                     gotStatus = addEntriesInternal(feiCurrent, true);
2436                                     break;
2437                                 case CHANGED:
2438                                     gotStatus = modifyEntryInternal(feiCurrent, feiNew, true);
2439                                     break;
2440                                 case REMOVED:
2441                                     gotStatus = removeEntryInternal(feiCurrent, true);
2442                                     break;
2443                                 }
2444                                 // Remove the Order
2445                                 workOrder.remove(fe);
2446                                 logsync.trace(
2447                                         "The workOrder has been executed and now the status is being returned {}", fe);
2448                                 // Place the status
2449                                 workStatus.put(fe, gotStatus);
2450                             } else {
2451                                 log.warn("Not expected null WorkOrder", work);
2452                             }
2453                         } else if (event instanceof WorkStatusCleanup) {
2454                             /*
2455                              * Take care of handling the remote Work request
2456                              */
2457                             WorkStatusCleanup work = (WorkStatusCleanup) event;
2458                             FlowEntryDistributionOrder fe = work.getFe();
2459                             if (fe != null) {
2460                                 logsync.trace("The workStatus {} is being removed", fe);
2461                                 workStatus.remove(fe);
2462                             } else {
2463                                 log.warn("Not expected null WorkStatus", work);
2464                             }
2465                         }  else if (event instanceof ContainerFlowChangeEvent) {
2466                             /*
2467                              * Whether it is an addition or removal, we have to
2468                              * recompute the merged flows entries taking into
2469                              * account all the current container flows because
2470                              * flow merging is not an injective function
2471                              */
2472                             updateFlowsContainerFlow();
2473                         } else {
2474                             log.warn("Dequeued unknown event {}", event.getClass()
2475                                     .getSimpleName());
2476                         }
2477                     } catch (InterruptedException e) {
2478                         // clear pending events
2479                         pendingEvents.clear();
2480                     }
2481                 }
2482             }
2483         }, "FRM EventHandler Collector");
2484     }
2485
2486     /**
2487      * Function called by the dependency manager when at least one dependency
2488      * become unsatisfied or when the component is shutting down because for
2489      * example bundle is being stopped.
2490      *
2491      */
2492     void destroy() {
2493         // Interrupt the thread
2494         frmEventHandler.interrupt();
2495         // Clear the pendingEvents queue
2496         pendingEvents.clear();
2497         frmAware.clear();
2498         workMonitor.clear();
2499     }
2500
2501     /**
2502      * Function called by dependency manager after "init ()" is called and after
2503      * the services provided by the class are registered in the service registry
2504      *
2505      */
2506     void start() {
2507         // Initialize graceful stop flag
2508         stopping = false;
2509
2510         // Allocate the executor service
2511         this.executor = Executors.newSingleThreadExecutor();
2512
2513         // Start event handler thread
2514         frmEventHandler.start();
2515
2516         /*
2517          * Read startup and build database if we have not already gotten the
2518          * configurations synced from another node
2519          */
2520         if (staticFlows.isEmpty()) {
2521             loadFlowConfiguration();
2522         }
2523     }
2524
2525     /**
2526      * Function called by the dependency manager before the services exported by
2527      * the component are unregistered, this will be followed by a "destroy ()"
2528      * calls
2529      */
2530     void stop() {
2531         stopping = true;
2532         uninstallAllFlowEntries(false);
2533         // Shutdown executor
2534         this.executor.shutdownNow();
2535     }
2536
2537     public void setFlowProgrammerService(IFlowProgrammerService service) {
2538         this.programmer = service;
2539     }
2540
2541     public void unsetFlowProgrammerService(IFlowProgrammerService service) {
2542         if (this.programmer == service) {
2543             this.programmer = null;
2544         }
2545     }
2546
2547     public void setSwitchManager(ISwitchManager switchManager) {
2548         this.switchManager = switchManager;
2549     }
2550
2551     public void unsetSwitchManager(ISwitchManager switchManager) {
2552         if (this.switchManager == switchManager) {
2553             this.switchManager = null;
2554         }
2555     }
2556
2557     @Override
2558     public void tagUpdated(String containerName, Node n, short oldTag, short newTag, UpdateType t) {
2559         if (!container.getName().equals(containerName)) {
2560             return;
2561         }
2562     }
2563
2564     @Override
2565     public void containerFlowUpdated(String containerName, ContainerFlow previous, ContainerFlow current, UpdateType t) {
2566         if (!container.getName().equals(containerName)) {
2567             return;
2568         }
2569         log.trace("Container {}: Updating installed flows because of container flow change: {} {}",
2570                 container.getName(), t, current);
2571         ContainerFlowChangeEvent ev = new ContainerFlowChangeEvent(previous, current, t);
2572         pendingEvents.offer(ev);
2573     }
2574
2575     @Override
2576     public void nodeConnectorUpdated(String containerName, NodeConnector nc, UpdateType t) {
2577         if (!container.getName().equals(containerName)) {
2578             return;
2579         }
2580
2581         boolean updateStaticFlowCluster = false;
2582
2583         switch (t) {
2584         case REMOVED:
2585
2586             List<FlowEntryInstall> nodeFlowEntries = nodeFlows.get(nc.getNode());
2587             if (nodeFlowEntries == null) {
2588                 return;
2589             }
2590             for (FlowEntryInstall fei : new ArrayList<FlowEntryInstall>(nodeFlowEntries)) {
2591                 if (doesFlowContainNodeConnector(fei.getInstall().getFlow(), nc)) {
2592                     Status status = this.removeEntryInternal(fei, true);
2593                     if (!status.isSuccess()) {
2594                         continue;
2595                     }
2596                     /*
2597                      * If the flow entry is a static flow, then update its
2598                      * configuration
2599                      */
2600                     if (fei.getGroupName().equals(FlowConfig.STATICFLOWGROUP)) {
2601                         FlowConfig flowConfig = getStaticFlow(fei.getFlowName(), fei.getNode());
2602                         if (flowConfig != null) {
2603                             flowConfig.setStatus(PORTREMOVED);
2604                             updateStaticFlowCluster = true;
2605                         }
2606                     }
2607                 }
2608             }
2609             if (updateStaticFlowCluster) {
2610                 refreshClusterStaticFlowsStatus(nc.getNode());
2611             }
2612             break;
2613         case ADDED:
2614             List<FlowConfig> flowConfigForNode = getStaticFlows(nc.getNode());
2615             for (FlowConfig flowConfig : flowConfigForNode) {
2616                 if (doesFlowContainNodeConnector(flowConfig.getFlow(), nc)) {
2617                     if (flowConfig.installInHw()) {
2618                         Status status = this.installFlowEntry(flowConfig.getFlowEntry());
2619                         if (!status.isSuccess()) {
2620                             flowConfig.setStatus(status.getDescription());
2621                         } else {
2622                             flowConfig.setStatus(SUCCESS);
2623                         }
2624                         updateStaticFlowCluster = true;
2625                     }
2626                 }
2627             }
2628             if (updateStaticFlowCluster) {
2629                 refreshClusterStaticFlowsStatus(nc.getNode());
2630             }
2631             break;
2632         case CHANGED:
2633             break;
2634         default:
2635         }
2636     }
2637
2638     @Override
2639     public void containerModeUpdated(UpdateType update) {
2640         // Only default container instance reacts on this event
2641         if (!container.getName().equals(GlobalConstants.DEFAULT.toString())) {
2642             return;
2643         }
2644         switch (update) {
2645         case ADDED:
2646             /*
2647              * Controller is moving to container mode. We are in the default
2648              * container context, we need to remove all our non-internal flows
2649              * to prevent any container isolation breakage. We also need to
2650              * preserve our flow so that they can be re-installed if we move
2651              * back to non container mode (no containers).
2652              */
2653             this.inContainerMode = true;
2654             this.uninstallAllFlowEntries(true);
2655             break;
2656         case REMOVED:
2657             this.inContainerMode = false;
2658             this.reinstallAllFlowEntries();
2659             break;
2660         default:
2661         }
2662
2663         // Update our configuration DB
2664         updateStaticFlowConfigsOnContainerModeChange(update);
2665     }
2666
2667     protected abstract class FRMEvent {
2668
2669     }
2670
2671     private class NodeUpdateEvent extends FRMEvent {
2672         private final Node node;
2673         private final UpdateType update;
2674
2675         public NodeUpdateEvent(UpdateType update, Node node) {
2676             this.update = update;
2677             this.node = node;
2678         }
2679
2680         public UpdateType getUpdateType() {
2681             return update;
2682         }
2683
2684         public Node getNode() {
2685             return node;
2686         }
2687     }
2688
2689     private class ErrorReportedEvent extends FRMEvent {
2690         private final long rid;
2691         private final Node node;
2692         private final Object error;
2693
2694         public ErrorReportedEvent(long rid, Node node, Object error) {
2695             this.rid = rid;
2696             this.node = node;
2697             this.error = error;
2698         }
2699
2700         public long getRequestId() {
2701             return rid;
2702         }
2703
2704         public Object getError() {
2705             return error;
2706         }
2707
2708         public Node getNode() {
2709             return node;
2710         }
2711     }
2712
2713     private class WorkOrderEvent extends FRMEvent {
2714         private FlowEntryDistributionOrder fe;
2715         private FlowEntryInstall newEntry;
2716
2717         /**
2718          * @param fe
2719          * @param newEntry
2720          */
2721         WorkOrderEvent(FlowEntryDistributionOrder fe, FlowEntryInstall newEntry) {
2722             this.fe = fe;
2723             this.newEntry = newEntry;
2724         }
2725
2726         /**
2727          * @return the fe
2728          */
2729         public FlowEntryDistributionOrder getFe() {
2730             return fe;
2731         }
2732
2733         /**
2734          * @return the newEntry
2735          */
2736         public FlowEntryInstall getNewEntry() {
2737             return newEntry;
2738         }
2739     }
2740     private class ContainerFlowChangeEvent extends FRMEvent {
2741         private final ContainerFlow previous;
2742         private final ContainerFlow current;
2743         private final UpdateType type;
2744
2745         public ContainerFlowChangeEvent(ContainerFlow previous, ContainerFlow current, UpdateType type) {
2746             this.previous = previous;
2747             this.current = current;
2748             this.type = type;
2749         }
2750
2751         public ContainerFlow getPrevious() {
2752             return this.previous;
2753         }
2754
2755         public ContainerFlow getCurrent() {
2756             return this.current;
2757         }
2758
2759         public UpdateType getType() {
2760             return this.type;
2761         }
2762     }
2763
2764
2765     private class WorkStatusCleanup extends FRMEvent {
2766         private FlowEntryDistributionOrder fe;
2767
2768         /**
2769          * @param fe
2770          */
2771         WorkStatusCleanup(FlowEntryDistributionOrder fe) {
2772             this.fe = fe;
2773         }
2774
2775         /**
2776          * @return the fe
2777          */
2778         public FlowEntryDistributionOrder getFe() {
2779             return fe;
2780         }
2781     }
2782
2783     /*
2784      * OSGI COMMANDS
2785      */
2786     @Override
2787     public String getHelp() {
2788         StringBuffer help = new StringBuffer();
2789         help.append("---FRM Matrix Application---\n");
2790         help.append("\t printMatrixData        - Prints the Matrix Configs\n");
2791         help.append("\t addMatrixConfig <name> <regex>\n");
2792         help.append("\t delMatrixConfig <name>\n");
2793         help.append("\t useMatrixConfig <name>\n");
2794         return help.toString();
2795     }
2796
2797     public void _printMatrixData(CommandInterpreter ci) {
2798         ci.println("Configs : ");
2799         ci.println("---------");
2800         ci.println(portGroupConfigs);
2801
2802         ci.println("Data : ");
2803         ci.println("------");
2804         ci.println(portGroupData);
2805     }
2806
2807     public void _addMatrixConfig(CommandInterpreter ci) {
2808         String name = ci.nextArgument();
2809         String regex = ci.nextArgument();
2810         addPortGroupConfig(name, regex, false);
2811     }
2812
2813     public void _delMatrixConfig(CommandInterpreter ci) {
2814         String name = ci.nextArgument();
2815         delPortGroupConfig(name);
2816     }
2817
2818     public void _useMatrixConfig(CommandInterpreter ci) {
2819         String name = ci.nextArgument();
2820         usePortGroupConfig(name);
2821     }
2822
2823     public void _arpPunt(CommandInterpreter ci) {
2824         String switchId = ci.nextArgument();
2825         long swid = HexEncode.stringToLong(switchId);
2826         Node node = NodeCreator.createOFNode(swid);
2827         installImplicitARPReplyPunt(node);
2828     }
2829
2830     public void _frmaddflow(CommandInterpreter ci) throws UnknownHostException {
2831         Node node = null;
2832         String nodeId = ci.nextArgument();
2833         if (nodeId == null) {
2834             ci.print("Node id not specified");
2835             return;
2836         }
2837         try {
2838             node = NodeCreator.createOFNode(Long.valueOf(nodeId));
2839         } catch (NumberFormatException e) {
2840             ci.print("Node id not a number");
2841             return;
2842         }
2843         ci.println(this.programmer.addFlow(node, getSampleFlow(node)));
2844     }
2845
2846     public void _frmremoveflow(CommandInterpreter ci) throws UnknownHostException {
2847         Node node = null;
2848         String nodeId = ci.nextArgument();
2849         if (nodeId == null) {
2850             ci.print("Node id not specified");
2851             return;
2852         }
2853         try {
2854             node = NodeCreator.createOFNode(Long.valueOf(nodeId));
2855         } catch (NumberFormatException e) {
2856             ci.print("Node id not a number");
2857             return;
2858         }
2859         ci.println(this.programmer.removeFlow(node, getSampleFlow(node)));
2860     }
2861
2862     private Flow getSampleFlow(Node node) throws UnknownHostException {
2863         NodeConnector port = NodeConnectorCreator.createOFNodeConnector((short) 24, node);
2864         NodeConnector oport = NodeConnectorCreator.createOFNodeConnector((short) 30, node);
2865         byte srcMac[] = { (byte) 0x12, (byte) 0x34, (byte) 0x56, (byte) 0x78, (byte) 0x9a, (byte) 0xbc };
2866         byte dstMac[] = { (byte) 0x1a, (byte) 0x2b, (byte) 0x3c, (byte) 0x4d, (byte) 0x5e, (byte) 0x6f };
2867         InetAddress srcIP = InetAddress.getByName("172.28.30.50");
2868         InetAddress dstIP = InetAddress.getByName("171.71.9.52");
2869         InetAddress ipMask = InetAddress.getByName("255.255.255.0");
2870         InetAddress ipMask2 = InetAddress.getByName("255.0.0.0");
2871         short ethertype = EtherTypes.IPv4.shortValue();
2872         short vlan = (short) 27;
2873         byte vlanPr = 3;
2874         Byte tos = 4;
2875         byte proto = IPProtocols.TCP.byteValue();
2876         short src = (short) 55000;
2877         short dst = 80;
2878
2879         /*
2880          * Create a SAL Flow aFlow
2881          */
2882         Match match = new Match();
2883         match.setField(MatchType.IN_PORT, port);
2884         match.setField(MatchType.DL_SRC, srcMac);
2885         match.setField(MatchType.DL_DST, dstMac);
2886         match.setField(MatchType.DL_TYPE, ethertype);
2887         match.setField(MatchType.DL_VLAN, vlan);
2888         match.setField(MatchType.DL_VLAN_PR, vlanPr);
2889         match.setField(MatchType.NW_SRC, srcIP, ipMask);
2890         match.setField(MatchType.NW_DST, dstIP, ipMask2);
2891         match.setField(MatchType.NW_TOS, tos);
2892         match.setField(MatchType.NW_PROTO, proto);
2893         match.setField(MatchType.TP_SRC, src);
2894         match.setField(MatchType.TP_DST, dst);
2895
2896         List<Action> actions = new ArrayList<Action>();
2897         actions.add(new Output(oport));
2898         actions.add(new PopVlan());
2899         actions.add(new Flood());
2900         actions.add(new Controller());
2901         return new Flow(match, actions);
2902     }
2903
2904     @Override
2905     public Status saveConfiguration() {
2906         return saveConfig();
2907     }
2908
2909     public void _frmNodeFlows(CommandInterpreter ci) {
2910         String nodeId = ci.nextArgument();
2911         Node node = Node.fromString(nodeId);
2912         if (node == null) {
2913             ci.println("frmNodeFlows <node> [verbose]");
2914             return;
2915         }
2916         boolean verbose = false;
2917         String verboseCheck = ci.nextArgument();
2918         if (verboseCheck != null) {
2919             verbose = verboseCheck.equals("true");
2920         }
2921
2922         if (!nodeFlows.containsKey(node)) {
2923             return;
2924         }
2925         // Dump per node database
2926         for (FlowEntryInstall entry : nodeFlows.get(node)) {
2927             if (!verbose) {
2928                 ci.println(node + " " + installedSwView.get(entry).getFlowName());
2929             } else {
2930                 ci.println(node + " " + installedSwView.get(entry).toString());
2931             }
2932         }
2933     }
2934
2935     public void _frmGroupFlows(CommandInterpreter ci) {
2936         String group = ci.nextArgument();
2937         if (group == null) {
2938             ci.println("frmGroupFlows <group> [verbose]");
2939             return;
2940         }
2941         boolean verbose = false;
2942         String verboseCheck = ci.nextArgument();
2943         if (verboseCheck != null) {
2944             verbose = verboseCheck.equalsIgnoreCase("true");
2945         }
2946
2947         if (!groupFlows.containsKey(group)) {
2948             return;
2949         }
2950         // Dump per node database
2951         ci.println("Group " + group + ":\n");
2952         for (FlowEntryInstall flowEntry : groupFlows.get(group)) {
2953             if (!verbose) {
2954                 ci.println(flowEntry.getNode() + " " + flowEntry.getFlowName());
2955             } else {
2956                 ci.println(flowEntry.getNode() + " " + flowEntry.toString());
2957             }
2958         }
2959     }
2960
2961     @Override
2962     public void flowRemoved(Node node, Flow flow) {
2963         log.trace("Received flow removed notification on {} for {}", node, flow);
2964
2965         // For flow entry identification, only node, match and priority matter
2966         FlowEntryInstall test = new FlowEntryInstall(new FlowEntry("", "", flow, node), null);
2967         FlowEntryInstall installedEntry = this.installedSwView.get(test);
2968         if (installedEntry == null) {
2969             log.trace("Entry is not known to us");
2970             return;
2971         }
2972
2973         // Update Static flow status
2974         Integer key = 0;
2975         FlowConfig target = null;
2976         for (Map.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
2977             FlowConfig conf = entry.getValue();
2978             if (conf.isByNameAndNodeIdEqual(installedEntry.getFlowName(), node)) {
2979                 key = entry.getKey();
2980                 target = conf;
2981                 break;
2982             }
2983         }
2984         if (target != null) {
2985             // Update Configuration database
2986             target.toggleInstallation();
2987             target.setStatus(SUCCESS);
2988             staticFlows.put(key, target);
2989         }
2990
2991         // Update software views
2992         this.updateLocalDatabase(installedEntry, false);
2993     }
2994
2995     @Override
2996     public void flowErrorReported(Node node, long rid, Object err) {
2997         log.trace("Got error {} for message rid {} from node {}", new Object[] { err, rid, node });
2998         pendingEvents.offer(new ErrorReportedEvent(rid, node, err));
2999     }
3000
3001     private void processErrorEvent(ErrorReportedEvent event) {
3002         Node node = event.getNode();
3003         long rid = event.getRequestId();
3004         Object error = event.getError();
3005         String errorString = (error == null) ? "Not provided" : error.toString();
3006         /*
3007          * If this was for a flow install, remove the corresponding entry from
3008          * the software view. If it was a Looking for the rid going through the
3009          * software database. TODO: A more efficient rid <-> FlowEntryInstall
3010          * mapping will have to be added in future
3011          */
3012         FlowEntryInstall target = null;
3013         for (FlowEntryInstall index : nodeFlows.get(node)) {
3014             FlowEntryInstall entry = installedSwView.get(index);
3015             if (entry.getRequestId() == rid) {
3016                 target = entry;
3017                 break;
3018             }
3019         }
3020         if (target != null) {
3021             // This was a flow install, update database
3022             this.updateLocalDatabase(target, false);
3023         }
3024
3025         // Notify listeners
3026         if (frmAware != null) {
3027             synchronized (frmAware) {
3028                 for (IForwardingRulesManagerAware frma : frmAware) {
3029                     try {
3030                         frma.requestFailed(rid, errorString);
3031                     } catch (Exception e) {
3032                         log.warn("Failed to notify {}", frma);
3033                     }
3034                 }
3035             }
3036         }
3037     }
3038
3039     @Override
3040     public Status solicitStatusResponse(Node node, boolean blocking) {
3041         Status rv = new Status(StatusCode.INTERNALERROR);
3042
3043         if (this.programmer != null) {
3044             if (blocking) {
3045                 rv = programmer.syncSendBarrierMessage(node);
3046             } else {
3047                 rv = programmer.asyncSendBarrierMessage(node);
3048             }
3049         }
3050
3051         return rv;
3052     }
3053
3054     public void unsetIConnectionManager(IConnectionManager s) {
3055         if (s == this.connectionManager) {
3056             this.connectionManager = null;
3057         }
3058     }
3059
3060     public void setIConnectionManager(IConnectionManager s) {
3061         this.connectionManager = s;
3062     }
3063
3064     @Override
3065     public void entryCreated(Object key, String cacheName, boolean originLocal) {
3066         /*
3067          * Do nothing
3068          */
3069     }
3070
3071     @Override
3072     public void entryUpdated(Object key, Object new_value, String cacheName, boolean originLocal) {
3073         if (originLocal) {
3074             /*
3075              * Local updates are of no interest
3076              */
3077             return;
3078         }
3079         if (cacheName.equals(WORKORDERCACHE)) {
3080             logsync.trace("Got a WorkOrderCacheUpdate for {}", key);
3081             /*
3082              * This is the case of one workOrder becoming available, so we need
3083              * to dispatch the work to the appropriate handler
3084              */
3085             FlowEntryDistributionOrder fe = (FlowEntryDistributionOrder) key;
3086             FlowEntryInstall fei = fe.getEntry();
3087             if (fei == null) {
3088                 return;
3089             }
3090             Node n = fei.getNode();
3091             if (connectionManager.getLocalityStatus(n) == ConnectionLocality.LOCAL) {
3092                 logsync.trace("workOrder for fe {} processed locally", fe);
3093                 // I'm the controller in charge for the request, queue it for
3094                 // processing
3095                 pendingEvents.offer(new WorkOrderEvent(fe, (FlowEntryInstall) new_value));
3096             }
3097         } else if (cacheName.equals(WORKSTATUSCACHE)) {
3098             logsync.trace("Got a WorkStatusCacheUpdate for {}", key);
3099             /*
3100              * This is the case of one workOrder being completed and a status
3101              * returned
3102              */
3103             FlowEntryDistributionOrder fe = (FlowEntryDistributionOrder) key;
3104             /*
3105              * Check if the order was initiated by this controller in that case
3106              * we need to actually look at the status returned
3107              */
3108             if (fe.getRequestorController()
3109                     .equals(clusterContainerService.getMyAddress())) {
3110                 FlowEntryDistributionOrderFutureTask fet = workMonitor.get(fe);
3111                 if (fet != null) {
3112                     logsync.trace("workStatus response is for us {}", fe);
3113                     // Signal we got the status
3114                     fet.gotStatus(fe, workStatus.get(fe));
3115                     pendingEvents.offer(new WorkStatusCleanup(fe));
3116                 }
3117             }
3118         }
3119     }
3120
3121     @Override
3122     public void entryDeleted(Object key, String cacheName, boolean originLocal) {
3123         /*
3124          * Do nothing
3125          */
3126     }
3127 }