neutron-ovsdb/src/main/java/org/opendaylight/groupbasedpolicy/neutron/ovsdb/util/OvsdbHelper.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.util;
  10
  11 import static org.opendaylight.groupbasedpolicy.util.DataStoreHelper.readFromDs;
  12 import static org.opendaylight.groupbasedpolicy.util.DataStoreHelper.submitToDs;
  13
  14 import java.util.ArrayList;
  15 import java.util.List;
  16
  17 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  18 import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
  19 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  20 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  21 import org.opendaylight.groupbasedpolicy.neutron.ovsdb.AbstractTunnelType;
  22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Uri;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeVxlan;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentationBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeRef;
  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.OvsdbNodeRef;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentationBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntry;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntryBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.Options;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.OptionsBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId;
  37 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointBuilder;
  41 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  42 import org.slf4j.Logger;
  43 import org.slf4j.LoggerFactory;
  44
  45 import com.google.common.base.Optional;
  46
  47 public class OvsdbHelper {
  48     private static final Logger LOG = LoggerFactory.getLogger(OvsdbHelper.class);
  49     private static final String OF_PORT = "6653";
  50
  51     /**
  52      * Look up the {@link OvsdbBridgeAugmentation} from the data store
  53      * given a child {@link InstanceIdentifier<OvsdbTerminationPointAugmentation>}
  54      *
  55      * @param tpId The InstanceIdentifier for a child TerminationPoint augmentation
  56      * @return the {@link OvsdbBridgeAugmentation}, null if the augmentation isn't present
  57      */
  58     public static OvsdbBridgeAugmentation getOvsdbBridgeFromTerminationPoint(
  59             InstanceIdentifier<OvsdbTerminationPointAugmentation> tpIid, DataBroker dataBroker) {
  60         InstanceIdentifier<Node> nodeIid = tpIid.firstIdentifierOf(Node.class);
  61         if (nodeIid != null) {
  62             InstanceIdentifier<OvsdbBridgeAugmentation> ovsdbBridgeIid = nodeIid.augmentation(OvsdbBridgeAugmentation.class);
  63             if (ovsdbBridgeIid != null) {
  64                 ReadTransaction transaction = dataBroker.newReadOnlyTransaction();
  65                 Optional<OvsdbBridgeAugmentation> ovsdbBridge =
  66                     readFromDs(LogicalDatastoreType.OPERATIONAL, ovsdbBridgeIid, transaction);
  67                 if (ovsdbBridge.isPresent()) {
  68                     return ovsdbBridge.get();
  69                 }
  70             }
  71         }
  72         return null;
  73     }
  74
  75     public static Node getNodeFromBridgeRef(OvsdbBridgeRef bridgeRef, DataBroker dataBroker) {
  76         InstanceIdentifier<Node> nodeIid = bridgeRef.getValue().firstIdentifierOf(Node.class);
  77         ReadTransaction transaction = dataBroker.newReadOnlyTransaction();
  78         Optional<?> node =
  79                 readFromDs(LogicalDatastoreType.OPERATIONAL, nodeIid, transaction );
  80         if (node.isPresent()) {
  81             if (node.get() instanceof Node) {
  82                 return (Node)node.get();
  83             }
  84         }
  85         return null;
  86     }
  87
  88     public static OvsdbTerminationPointAugmentation getOvsdbTerminationPoint(
  89             InstanceIdentifier<OvsdbTerminationPointAugmentation> tpIid, DataBroker dataBroker) {
  90         ReadTransaction transaction = dataBroker.newReadOnlyTransaction();
  91         Optional<OvsdbTerminationPointAugmentation> ovsdbTp =
  92                 readFromDs(LogicalDatastoreType.OPERATIONAL, tpIid, transaction );
  93         if (ovsdbTp.isPresent()) {
  94             return ovsdbTp.get();
  95         }
  96         return null;
  97     }
  98
  99     public static Node getNode(Node node, List<TerminationPoint> tps,
 100             OvsdbBridgeAugmentation ovsdbBridgeAugmentation) {
 101         NodeBuilder nodeBuilder = new NodeBuilder();
 102         nodeBuilder.setKey(node.getKey());
 103
 104         nodeBuilder.addAugmentation(OvsdbBridgeAugmentation.class,
 105                 ovsdbBridgeAugmentation);
 106
 107         nodeBuilder.setTerminationPoint(tps);
 108         return nodeBuilder.build();
 109     }
 110
 111     public static OvsdbBridgeAugmentation buildOvsdbBridgeAugmentation(OvsdbBridgeAugmentation bridge,
 112             OvsdbNodeAugmentation ovsdbNode) {
 113         OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentation = new OvsdbBridgeAugmentationBuilder();
 114         IpAddress managerIp = getManagerIp(ovsdbNode);
 115         if (managerIp != null) {
 116             List<ControllerEntry> controllerEntries = buildControllerEntries(managerIp);
 117             ovsdbBridgeAugmentation.setControllerEntry(controllerEntries);
 118         }
 119         ovsdbBridgeAugmentation.setBridgeName(bridge.getBridgeName());
 120         ovsdbBridgeAugmentation.setManagedBy(bridge.getManagedBy());
 121         return ovsdbBridgeAugmentation.build();
 122     }
 123
 124     public static List<TerminationPoint> buildTerminationPoints(OvsdbBridgeAugmentation bridge,
 125             OvsdbTerminationPointAugmentation ovsdbTp, AbstractTunnelType tunnelType) {
 126         TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
 127         tpBuilder.setTpId(new TpId(new Uri(generateTpName(bridge, tunnelType))));
 128         tpBuilder.addAugmentation(OvsdbTerminationPointAugmentation.class, ovsdbTp);
 129
 130         List<TerminationPoint> tps = new ArrayList<TerminationPoint>();
 131         tps.add(tpBuilder.build());
 132         return tps;
 133     }
 134
 135     public static String generateTpName(OvsdbBridgeAugmentation bridge, AbstractTunnelType tunnelType) {
 136         return tunnelType.getTunnelPrefix() + bridge.getBridgeName().getValue();
 137     }
 138
 139     public static OvsdbTerminationPointAugmentation buildOvsdbTerminationPointAugmentation(OvsdbBridgeAugmentation bridge,
 140             List<Options> options, AbstractTunnelType tunnelType) {
 141         OvsdbTerminationPointAugmentationBuilder ovsdbTpBuilder = new OvsdbTerminationPointAugmentationBuilder();
 142         ovsdbTpBuilder.setName(generateTpName(bridge, tunnelType));
 143         ovsdbTpBuilder.setOptions(options);
 144         ovsdbTpBuilder.setInterfaceType(InterfaceTypeVxlan.class);
 145         return ovsdbTpBuilder.build();
 146     }
 147
 148     public static void setOption(List<Options> options, String key, String value) {
 149         OptionsBuilder option = new OptionsBuilder();
 150         option.setOption(key);
 151         option.setValue(value);
 152         options.add(option.build());
 153     }
 154
 155     public static IpAddress getManagerIp(OvsdbNodeAugmentation ovsdbNode) {
 156         if (ovsdbNode.getConnectionInfo() != null) {
 157             return ovsdbNode.getConnectionInfo().getLocalIp();
 158         }
 159         return null;
 160     }
 161
 162     public static IpAddress getNodeIp(OvsdbNodeAugmentation ovsdbNode) {
 163         if (ovsdbNode.getConnectionInfo() != null) {
 164             return ovsdbNode.getConnectionInfo().getRemoteIp();
 165         }
 166         return null;
 167     }
 168
 169     public static List<ControllerEntry> buildControllerEntries(IpAddress ip) {
 170         List<ControllerEntry> result = new ArrayList<ControllerEntry>();
 171
 172         if (ip != null) {
 173             ControllerEntryBuilder controllerBuilder = new ControllerEntryBuilder();
 174             String localIp = String.valueOf(ip.getValue());
 175             String targetString = "tcp:" + localIp + ":" + OF_PORT;
 176             controllerBuilder.setTarget(new Uri(targetString));
 177             result.add(controllerBuilder.build());
 178         }
 179
 180         return result;
 181     }
 182
 183     /**
 184      * Get the manager node for this bridge node
 185      *
 186      * @param bridge
 187      * @param dataBroker
 188      * @return The {@link OvsdbBridgeAugmentation} for the manager node, null
 189      *         if not found or if it already is the manager node
 190      */
 191     public static OvsdbNodeAugmentation getManagerNode(OvsdbBridgeAugmentation bridge, DataBroker dataBroker) {
 192         OvsdbNodeRef bareIId = bridge.getManagedBy();
 193         if(bareIId != null) {
 194             if(bareIId.getValue().getTargetType().equals(Node.class)) {
 195                 ReadWriteTransaction transaction = dataBroker.newReadWriteTransaction();
 196                 InstanceIdentifier<Node> iid = (InstanceIdentifier<Node>) bareIId.getValue();
 197                 Optional<Node> nodeOptional = readFromDs(LogicalDatastoreType.OPERATIONAL, iid, transaction);
 198                 if(nodeOptional.isPresent()
 199                         && nodeOptional.get().getAugmentation(OvsdbNodeAugmentation.class) != null) {
 200                     return nodeOptional.get().getAugmentation(OvsdbNodeAugmentation.class);
 201                 } else {
 202                     LOG.warn("Could not find ovsdb-node for connection for {}",bridge);
 203                 }
 204             } else {
 205                 LOG.warn("Bridge 'managedBy' non-ovsdb-node.  bridge {} getManagedBy() {}",bridge,bareIId.getValue());
 206             }
 207         } else {
 208             LOG.debug("Bridge 'managedBy' is null.  bridge {}",bridge);
 209         }
 210         return null;
 211     }
 212
 213     public static Node getTopologyNode(InstanceIdentifier<Node> nodeIid, DataBroker dataBroker) {
 214         ReadTransaction transaction = dataBroker.newReadOnlyTransaction();
 215         Optional<Node> nodeOptional =
 216                 readFromDs(LogicalDatastoreType.OPERATIONAL, nodeIid, transaction );
 217         if (nodeOptional.isPresent()) {
 218             return nodeOptional.get();
 219         }
 220         return null;
 221     }
 222
 223     /**
 224      * Use OVSDB CRUD to create any missing tunnels on a given
 225      * Inventory Node.
 226      *
 227      * @param nodeIid
 228      * @param node
 229      * @param tunnelType
 230      */
 231     public static void createTunnelPort(InstanceIdentifier<Node> nodeIid,
 232             Node node, AbstractTunnelType tunnelType, DataBroker dataBroker) {
 233         ReadWriteTransaction transaction = dataBroker.newReadWriteTransaction();
 234         OvsdbBridgeAugmentation bridge = node.getAugmentation(OvsdbBridgeAugmentation.class);
 235         if (bridge == null) {
 236             LOG.warn("No OvsdbBridgeAugmentationfor Node {}", node);
 237             return;
 238         }
 239
 240         OvsdbNodeAugmentation managerNode = getManagerNode(bridge, dataBroker);
 241         if(managerNode == null) {
 242             LOG.warn("Couldn't create tunnel port for Node {}, no manager", node);
 243             return;
 244         }
 245         List<Options> options = tunnelType.getOptions();
 246         OvsdbTerminationPointAugmentation ovsdbTp =
 247                 buildOvsdbTerminationPointAugmentation(bridge,options, tunnelType);
 248         List<TerminationPoint> tps = buildTerminationPoints(bridge,ovsdbTp, tunnelType);
 249         OvsdbBridgeAugmentation ovsdbBridgeAugmentation =
 250                 buildOvsdbBridgeAugmentation(bridge,managerNode);
 251         Node configNode = getNode(node, tps,ovsdbBridgeAugmentation);
 252         LOG.info("About to write nodeId {} node {}",nodeIid,configNode);
 253         transaction.merge(LogicalDatastoreType.CONFIGURATION, nodeIid, configNode);
 254         submitToDs(transaction);
 255     }
 256
 257
 258 }