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