opendaylight/protocol_plugins/openflow/src/main/java/org/opendaylight/controller/protocol_plugin/openflow/internal/DataPacketMuxDemux.java

   1
   2 /*
   3  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   4  *
   5  * This program and the accompanying materials are made available under the
   6  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   7  * and is available at http://www.eclipse.org/legal/epl-v10.html
   8  */
   9
  10 package org.opendaylight.controller.protocol_plugin.openflow.internal;
  11
  12 import java.util.Collections;
  13 import java.util.List;
  14 import java.util.Map;
  15 import java.util.Set;
  16 import java.util.concurrent.ConcurrentHashMap;
  17 import java.util.concurrent.ConcurrentMap;
  18 import java.util.concurrent.CopyOnWriteArrayList;
  19
  20 import org.opendaylight.controller.protocol_plugin.openflow.IDataPacketListen;
  21 import org.opendaylight.controller.protocol_plugin.openflow.IDataPacketMux;
  22 import org.opendaylight.controller.protocol_plugin.openflow.IInventoryShimExternalListener;
  23 import org.opendaylight.controller.protocol_plugin.openflow.core.IController;
  24 import org.opendaylight.controller.protocol_plugin.openflow.core.IMessageListener;
  25 import org.opendaylight.controller.protocol_plugin.openflow.core.ISwitch;
  26 import org.openflow.protocol.OFMessage;
  27 import org.openflow.protocol.OFPacketIn;
  28 import org.openflow.protocol.OFPacketOut;
  29 import org.openflow.protocol.OFPort;
  30 import org.openflow.protocol.OFType;
  31 import org.openflow.protocol.action.OFAction;
  32 import org.openflow.protocol.action.OFActionOutput;
  33 import org.slf4j.Logger;
  34 import org.slf4j.LoggerFactory;
  35
  36 import org.opendaylight.controller.sal.core.ConstructionException;
  37 import org.opendaylight.controller.sal.core.ContainerFlow;
  38 import org.opendaylight.controller.sal.core.IContainerListener;
  39 import org.opendaylight.controller.sal.core.Node;
  40 import org.opendaylight.controller.sal.core.NodeConnector;
  41 import org.opendaylight.controller.sal.core.Property;
  42 import org.opendaylight.controller.sal.core.UpdateType;
  43 import org.opendaylight.controller.sal.packet.IPluginOutDataPacketService;
  44 import org.opendaylight.controller.sal.packet.PacketResult;
  45 import org.opendaylight.controller.sal.packet.RawPacket;
  46 import org.opendaylight.controller.sal.utils.GlobalConstants;
  47
  48 public class DataPacketMuxDemux implements IContainerListener,
  49         IMessageListener, IDataPacketMux, IInventoryShimExternalListener {
  50     protected static final Logger logger = LoggerFactory
  51             .getLogger(DataPacketMuxDemux.class);
  52     private IController controller = null;
  53     private ConcurrentMap<Long, ISwitch> swID2ISwitch = new ConcurrentHashMap<Long, ISwitch>();
  54     // Gives a map between a Container and all the DataPacket listeners on SAL
  55     private ConcurrentMap<String, IPluginOutDataPacketService> pluginOutDataPacketServices = new ConcurrentHashMap<String, IPluginOutDataPacketService>();
  56     // Gives a map between a NodeConnector and the containers to which it belongs
  57     private ConcurrentMap<NodeConnector, List<String>> nc2Container = new ConcurrentHashMap<NodeConnector, List<String>>();
  58     // Gives a map between a Container and the FlowSpecs on it
  59     private ConcurrentMap<String, List<ContainerFlow>> container2FlowSpecs = new ConcurrentHashMap<String, List<ContainerFlow>>();
  60     // Track local data packet listener
  61     private List<IDataPacketListen> iDataPacketListen = new CopyOnWriteArrayList<IDataPacketListen>();
  62
  63     void setIDataPacketListen(IDataPacketListen s) {
  64         if (this.iDataPacketListen != null) {
  65             if (!this.iDataPacketListen.contains(s)) {
  66                 logger.debug("Added new IDataPacketListen");
  67                 this.iDataPacketListen.add(s);
  68             }
  69         }
  70     }
  71
  72     void unsetIDataPacketListen(IDataPacketListen s) {
  73         if (this.iDataPacketListen != null) {
  74             if (this.iDataPacketListen.contains(s)) {
  75                 logger.debug("Removed IDataPacketListen");
  76                 this.iDataPacketListen.remove(s);
  77             }
  78         }
  79     }
  80
  81     void setPluginOutDataPacketService(Map<String, Object> props,
  82             IPluginOutDataPacketService s) {
  83         if (props == null) {
  84             logger.error("Didn't receive the service properties");
  85             return;
  86         }
  87         String containerName = (String) props.get("containerName");
  88         if (containerName == null) {
  89             logger.error("containerName not supplied");
  90             return;
  91         }
  92         if (this.pluginOutDataPacketServices != null) {
  93             // It's expected only one SAL per container as long as the
  94             // replication is done in the SAL implementation toward
  95             // the different APPS
  96             this.pluginOutDataPacketServices.put(containerName, s);
  97             logger.debug("New outService for container: {}", containerName);
  98         }
  99     }
 100
 101     void unsetPluginOutDataPacketService(Map<String, Object> props,
 102             IPluginOutDataPacketService s) {
 103         if (props == null) {
 104             logger.error("Didn't receive the service properties");
 105             return;
 106         }
 107         String containerName = (String) props.get("containerName");
 108         if (containerName == null) {
 109             logger.error("containerName not supplied");
 110             return;
 111         }
 112         if (this.pluginOutDataPacketServices != null) {
 113             this.pluginOutDataPacketServices.remove(containerName);
 114             logger.debug("Removed outService for container: {}", containerName);
 115         }
 116     }
 117
 118     void setController(IController s) {
 119         logger.debug("Controller provider set in DATAPACKET SERVICES");
 120         this.controller = s;
 121     }
 122
 123     void unsetController(IController s) {
 124         if (this.controller == s) {
 125             logger.debug("Controller provider UNset in DATAPACKET SERVICES");
 126             this.controller = null;
 127         }
 128     }
 129
 130     /**
 131      * Function called by the dependency manager when all the required
 132      * dependencies are satisfied
 133      *
 134      */
 135     void init() {
 136         this.controller.addMessageListener(OFType.PACKET_IN, this);
 137     }
 138
 139     /**
 140      * Function called by the dependency manager when at least one
 141      * dependency become unsatisfied or when the component is shutting
 142      * down because for example bundle is being stopped.
 143      *
 144      */
 145     void destroy() {
 146         this.controller.removeMessageListener(OFType.PACKET_IN, this);
 147
 148         // Clear state that may need to be reused on component restart
 149         this.pluginOutDataPacketServices.clear();
 150         this.nc2Container.clear();
 151         this.container2FlowSpecs.clear();
 152         this.controller = null;
 153         this.swID2ISwitch.clear();
 154     }
 155
 156     @Override
 157     public void receive(ISwitch sw, OFMessage msg) {
 158         if (sw == null || msg == null
 159                 || this.pluginOutDataPacketServices == null) {
 160             // Something fishy, we cannot do anything
 161                 logger.debug("sw: {} and/or msg: {} and/or pluginOutDataPacketServices: {} is null!",
 162                                         new Object[]{sw, msg, this.pluginOutDataPacketServices});
 163             return;
 164         }
 165         if (msg instanceof OFPacketIn) {
 166             OFPacketIn ofPacket = (OFPacketIn) msg;
 167             Long ofSwitchID = Long.valueOf(sw.getId());
 168             Short ofPortID = Short.valueOf(ofPacket.getInPort());
 169
 170             try {
 171                 Node n = new Node(Node.NodeIDType.OPENFLOW, ofSwitchID);
 172                 NodeConnector p = PortConverter.toNodeConnector(ofPortID, n);
 173                 RawPacket dataPacket = new RawPacket(ofPacket.getPacketData());
 174                 dataPacket.setIncomingNodeConnector(p);
 175
 176                 // Try to dispatch the packet locally, in here we will
 177                 // pass the parsed packet simply because once the
 178                 // packet infra is settled all the packets will passed
 179                 // around as parsed and read-only
 180                 for (int i = 0; i < this.iDataPacketListen.size(); i++) {
 181                     IDataPacketListen s = this.iDataPacketListen.get(i);
 182                     if (s.receiveDataPacket(dataPacket).equals(
 183                             PacketResult.CONSUME)) {
 184                         logger.trace("Consumed locally data packet");
 185                         return;
 186                     }
 187                 }
 188
 189                 // Now dispatch the packet toward SAL at least for
 190                 // default container, we need to revisit this in a general
 191                 // slicing architecture refresh
 192                 IPluginOutDataPacketService defaultOutService = this.pluginOutDataPacketServices
 193                         .get(GlobalConstants.DEFAULT.toString());
 194                 if (defaultOutService != null) {
 195                     defaultOutService.receiveDataPacket(dataPacket);
 196                     logger.trace("Dispatched to apps a frame of size: {} on container: {}",
 197                             ofPacket.getPacketData().length, GlobalConstants.DEFAULT.toString());
 198                 }
 199                 // Now check the mapping between nodeConnector and
 200                 // Container and later on optinally filter based on
 201                 // flowSpec
 202                 List<String> containersRX = this.nc2Container.get(p);
 203                 if (containersRX != null) {
 204                     for (int i = 0; i < containersRX.size(); i++) {
 205                         String container = containersRX.get(i);
 206                         IPluginOutDataPacketService s = this.pluginOutDataPacketServices
 207                                 .get(container);
 208                         if (s != null) {
 209                             // TODO add filtering on a per-flowSpec base
 210                             s.receiveDataPacket(dataPacket);
 211                             logger.trace("Dispatched to apps a frame of size: {} on container: {}",
 212                                     ofPacket.getPacketData().length, GlobalConstants.DEFAULT.toString());
 213
 214                         }
 215                     }
 216                 }
 217
 218                 // This is supposed to be the catch all for all the
 219                 // DataPacket hence we will assume it has been handled
 220                 return;
 221             } catch (ConstructionException cex) {
 222             }
 223
 224             // If we reach this point something went wrong.
 225             return;
 226         } else {
 227             // We don't care about non-data packets
 228             return;
 229         }
 230     }
 231
 232     @Override
 233     public void transmitDataPacket(RawPacket outPkt) {
 234         // Sanity check area
 235         if (outPkt == null) {
 236                 logger.debug("outPkt is null!");
 237             return;
 238         }
 239
 240         NodeConnector outPort = outPkt.getOutgoingNodeConnector();
 241         if (outPort == null) {
 242                 logger.debug("outPort is null! outPkt: {}", outPkt);
 243             return;
 244         }
 245
 246         if (!outPort.getType().equals(
 247                 NodeConnector.NodeConnectorIDType.OPENFLOW)) {
 248             // The output Port is not of type OpenFlow
 249                 logger.debug("outPort is not OF Type! outPort: {}", outPort);
 250             return;
 251         }
 252
 253         Short port = (Short) outPort.getID();
 254         Long swID = (Long) outPort.getNode().getID();
 255         ISwitch sw = this.swID2ISwitch.get(swID);
 256
 257         if (sw == null) {
 258             // If we cannot get the controller descriptor we cannot even
 259             // send out the frame
 260                 logger.debug("swID: {} - sw is null!", swID);
 261             return;
 262         }
 263
 264         byte[] data = outPkt.getPacketData();
 265         // build action
 266         OFActionOutput action = new OFActionOutput().setPort(port);
 267         // build packet out
 268         OFPacketOut po = new OFPacketOut().setBufferId(
 269                 OFPacketOut.BUFFER_ID_NONE).setInPort(OFPort.OFPP_NONE)
 270                 .setActions(Collections.singletonList((OFAction) action))
 271                 .setActionsLength((short) OFActionOutput.MINIMUM_LENGTH);
 272
 273         po.setLengthU(OFPacketOut.MINIMUM_LENGTH + po.getActionsLength()
 274                 + data.length);
 275         po.setPacketData(data);
 276
 277         sw.asyncSend(po);
 278         logger.trace("Transmitted a frame of size: {}", data.length);
 279     }
 280
 281     public void addNode(Node node, Set<Property> props) {
 282         if (node == null) {
 283                 logger.debug("node is null!");
 284             return;
 285         }
 286
 287         long sid = (Long) node.getID();
 288         ISwitch sw = controller.getSwitches().get(sid);
 289         if (sw == null) {
 290                 logger.debug("sid: {} - sw is null!", sid);
 291                 return;
 292         }
 293         this.swID2ISwitch.put(sw.getId(), sw);
 294     }
 295
 296     public void removeNode(Node node) {
 297         if (node == null) {
 298                 logger.debug("node is null!");
 299             return;
 300         }
 301
 302         long sid = (Long) node.getID();
 303         ISwitch sw = controller.getSwitches().get(sid);
 304         if (sw == null) {
 305                 logger.debug("sid: {} - sw is null!", sid);
 306                 return;
 307         }
 308         this.swID2ISwitch.remove(sw.getId());
 309     }
 310
 311     @Override
 312     public void tagUpdated(String containerName, Node n, short oldTag,
 313             short newTag, UpdateType t) {
 314         // Do nothing
 315     }
 316
 317     @Override
 318     public void containerFlowUpdated(String containerName,
 319             ContainerFlow previousFlow, ContainerFlow currentFlow, UpdateType t) {
 320         if (this.container2FlowSpecs == null) {
 321             logger.error("container2FlowSpecs is NULL");
 322             return;
 323         }
 324         List<ContainerFlow> fSpecs = this.container2FlowSpecs
 325                 .get(containerName);
 326         if (fSpecs == null) {
 327             fSpecs = new CopyOnWriteArrayList<ContainerFlow>();
 328         }
 329         switch (t) {
 330         case ADDED:
 331             if (!fSpecs.contains(previousFlow)) {
 332                 fSpecs.add(previousFlow);
 333             }
 334             break;
 335         case REMOVED:
 336             if (fSpecs.contains(previousFlow)) {
 337                 fSpecs.remove(previousFlow);
 338             }
 339             break;
 340         case CHANGED:
 341             break;
 342         }
 343     }
 344
 345     @Override
 346     public void nodeConnectorUpdated(String containerName, NodeConnector p,
 347             UpdateType t) {
 348         if (this.nc2Container == null) {
 349             logger.error("nc2Container is NULL");
 350             return;
 351         }
 352         List<String> containers = this.nc2Container.get(p);
 353         if (containers == null) {
 354             containers = new CopyOnWriteArrayList<String>();
 355         }
 356         boolean updateMap = false;
 357         switch (t) {
 358         case ADDED:
 359             if (!containers.contains(containerName)) {
 360                 containers.add(containerName);
 361                 updateMap = true;
 362             }
 363             break;
 364         case REMOVED:
 365             if (containers.contains(containerName)) {
 366                 containers.remove(containerName);
 367                 updateMap = true;
 368             }
 369             break;
 370         case CHANGED:
 371             break;
 372         }
 373         if (updateMap) {
 374             if (containers.isEmpty()) {
 375                 // Do cleanup to reduce memory footprint if no
 376                 // elements to be tracked
 377                 this.nc2Container.remove(p);
 378             } else {
 379                 this.nc2Container.put(p, containers);
 380             }
 381         }
 382     }
 383
 384     @Override
 385     public void containerModeUpdated(UpdateType t) {
 386         // do nothing
 387     }
 388
 389     @Override
 390     public void updateNode(Node node, UpdateType type, Set<Property> props) {
 391         switch (type) {
 392         case ADDED:
 393             addNode(node, props);
 394             break;
 395         case REMOVED:
 396             removeNode(node);
 397             break;
 398         default:
 399             break;
 400         }
 401     }
 402
 403     @Override
 404     public void updateNodeConnector(NodeConnector nodeConnector,
 405             UpdateType type, Set<Property> props) {
 406         // do nothing
 407     }
 408 }