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