neutron-ovsdb/src/main/java/org/opendaylight/groupbasedpolicy/neutron/ovsdb/NodeDataChangeListener.java

   1 /*
   2  * Copyright (c) 2015 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.groupbasedpolicy.neutron.ovsdb;
  10
  11 import static com.google.common.base.Preconditions.checkNotNull;
  12 import static org.opendaylight.groupbasedpolicy.neutron.ovsdb.util.InventoryHelper.addOfOverlayExternalPort;
  13 import static org.opendaylight.groupbasedpolicy.neutron.ovsdb.util.InventoryHelper.getLongFromDpid;
  14 import static org.opendaylight.groupbasedpolicy.neutron.ovsdb.util.NeutronOvsdbIidFactory.ovsdbNodeAugmentationIid;
  15 import static org.opendaylight.groupbasedpolicy.neutron.ovsdb.util.OvsdbHelper.getNodeFromBridgeRef;
  16
  17 import java.util.List;
  18 import java.util.Map.Entry;
  19
  20 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  21 import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
  22 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
  23 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
  24 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  25 import org.opendaylight.ovsdb.southbound.SouthboundConstants;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagedNodeEntry;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.OpenvswitchOtherConfigs;
  32 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  33 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  34 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  35 import org.opendaylight.yangtools.yang.binding.DataObject;
  36 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39
  40 public class NodeDataChangeListener implements DataChangeListener, AutoCloseable {
  41
  42     private static final Logger LOG = LoggerFactory.getLogger(NodeDataChangeListener.class);
  43     private static final String NEUTRON_PROVIDER_MAPPINGS_KEY = "provider_mappings";
  44     private static final String INVENTORY_PREFIX = "openflow:";
  45     private final ListenerRegistration<DataChangeListener> registration;
  46     private static DataBroker dataBroker;
  47
  48     public NodeDataChangeListener(DataBroker dataBroker) {
  49         this.dataBroker = checkNotNull(dataBroker);
  50         registration = dataBroker.registerDataChangeListener(LogicalDatastoreType.OPERATIONAL, ovsdbNodeAugmentationIid(SouthboundConstants.OVSDB_TOPOLOGY_ID), this,
  51                 DataChangeScope.ONE);
  52         LOG.trace("NodeDataChangeListener started");
  53     }
  54
  55     @Override
  56     public void onDataChanged(AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> change) {
  57
  58         /*
  59          * TerminationPoint notifications with OVSDB augmentations
  60          * vSwitch ports. Iterate through the list of new ports.
  61          */
  62         for (Entry<InstanceIdentifier<?>, DataObject> entry : change.getCreatedData().entrySet()) {
  63             if (entry.getValue() instanceof OvsdbNodeAugmentation) {
  64                 OvsdbNodeAugmentation ovsdbNode = (OvsdbNodeAugmentation) entry.getValue();
  65                 processNodeNotification(ovsdbNode);
  66             }
  67         }
  68
  69         /*
  70          * Updates
  71          */
  72         for (Entry<InstanceIdentifier<?>, DataObject> entry : change.getUpdatedData().entrySet()) {
  73             if (entry.getValue() instanceof OvsdbNodeAugmentation) {
  74                 OvsdbNodeAugmentation ovsdbNode = (OvsdbNodeAugmentation) entry.getValue();
  75                 processNodeNotification(ovsdbNode);
  76             }
  77         }
  78
  79         /*
  80          * Deletions
  81          */
  82         for (InstanceIdentifier<?> iid : change.getRemovedPaths()) {
  83             if (iid instanceof OvsdbTerminationPointAugmentation) {
  84                 /*
  85                  * Remove the state from OfOverlay?
  86                  */
  87             }
  88         }
  89     }
  90
  91     @Override
  92     public void close() throws Exception {
  93         registration.close();
  94     }
  95
  96
  97     public static void processNodeNotification(OvsdbNodeAugmentation ovsdbNode) {
  98         LOG.trace("Search for provider mapping on node {}", ovsdbNode);
  99         String providerPortName = getProviderMapping(ovsdbNode);
 100         if (providerPortName != null) {
 101             LOG.trace("Found provider mapping, creating Inventory NodeId");
 102             String nodeConnectorIdString = getInventoryNodeId(ovsdbNode, providerPortName);
 103             if (nodeConnectorIdString != null) {
 104                 LOG.trace("Adding OfOverlay External port for {}", nodeConnectorIdString);
 105                 String[] elements = nodeConnectorIdString.split(":");
 106                 String nodeIdString = elements[0] + ":" + elements[1];
 107                 NodeConnectorId ncid = getNodeConnectorId(nodeConnectorIdString);
 108                 addOfOverlayExternalPort(nodeIdString, ncid, dataBroker);
 109             }
 110         }
 111     }
 112
 113     private static NodeConnectorId getNodeConnectorId(String nodeConnectorIdString) {
 114         return new NodeConnectorId(nodeConnectorIdString);
 115     }
 116
 117     public static String getProviderMapping(OvsdbNodeAugmentation ovsdbNode) {
 118         if (ovsdbNode.getOpenvswitchOtherConfigs() != null) {
 119             for (OpenvswitchOtherConfigs config : ovsdbNode.getOpenvswitchOtherConfigs()) {
 120                 if (config.getOtherConfigKey() == null || config.getOtherConfigValue() == null) {
 121                     continue;
 122                 }
 123                 if (config.getOtherConfigKey().equals(NEUTRON_PROVIDER_MAPPINGS_KEY)) {
 124                     String otherConfig = config.getOtherConfigValue();
 125                     if (otherConfig != null) {
 126                         String[] elements = otherConfig.split(":");
 127                         if (elements.length == 2) {
 128                             return elements[1];
 129                         }
 130                     }
 131                 }
 132             }
 133         }
 134         return null;
 135     }
 136
 137     /**
 138      * Get the DPID and OpenFlow port of the bridge that owns the {@link TerminationPoint} in the
 139      * provider mapping
 140      *
 141      * @return
 142      */
 143     private static String getInventoryNodeId(OvsdbNodeAugmentation ovsdbNode, String externalPortName) {
 144         List<ManagedNodeEntry> ovsdbNodes = ovsdbNode.getManagedNodeEntry();
 145         if (ovsdbNodes == null) {
 146             return null;
 147         }
 148         for (ManagedNodeEntry managedNode : ovsdbNodes) {
 149             if (managedNode.getBridgeRef() != null) {
 150                 /*
 151                  * Get the Node, then see if it has any TerminationPoint
 152                  * augmentations. If it does, check each TerminationPoint
 153                  * augmentation to see if it is the matching provider_mapping
 154                  */
 155                 Node node = getNodeFromBridgeRef(managedNode.getBridgeRef(), dataBroker);
 156                 if (node == null) {
 157                     LOG.error("Couldn't get Topology Node for {}", managedNode.getBridgeRef());
 158                     return null;
 159                 }
 160                 OvsdbBridgeAugmentation ovsdbBridge = node.getAugmentation(OvsdbBridgeAugmentation.class);
 161                 if (ovsdbBridge == null) {
 162                     continue;
 163                 }
 164                 for (TerminationPoint tp : node.getTerminationPoint()) {
 165                     OvsdbTerminationPointAugmentation tpAug = tp.getAugmentation(OvsdbTerminationPointAugmentation.class);
 166                     if ((tpAug == null) || (tpAug.getName() == null) || (tpAug.getOfport() == null)) {
 167                         continue;
 168                     }
 169                     if (tpAug.getName().equals(externalPortName)) {
 170                         return buildInventoryNcid(ovsdbBridge, tpAug);
 171                     }
 172                 }
 173             }
 174         }
 175         return null;
 176     }
 177
 178     private static String buildInventoryNcid(OvsdbBridgeAugmentation ovsdbBridge,
 179             OvsdbTerminationPointAugmentation terminationPoint) {
 180         Long macLong = getLongFromDpid(ovsdbBridge.getDatapathId().getValue());
 181         return INVENTORY_PREFIX + String.valueOf(macLong) + ":" + String.valueOf(terminationPoint.getOfport());
 182     }
 183 }