openstack/net-virt/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/MdsalUtils.java

   1 /*
   2  * Copyright (c) 2015 Red Hat, 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 package org.opendaylight.ovsdb.openstack.netvirt;
   9
  10 import java.math.BigInteger;
  11 import java.security.InvalidParameterException;
  12 import java.util.ArrayList;
  13 import java.util.HashMap;
  14 import java.util.List;
  15 import java.util.Map;
  16
  17 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  18 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  19 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  20 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  21 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  22 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  23 import org.opendaylight.ovsdb.openstack.netvirt.api.Constants;
  24 import org.opendaylight.ovsdb.openstack.netvirt.api.OvsdbTables;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Uri;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeInternal;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentationBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeName;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolBase;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeRef;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentationBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeExternalIds;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeOtherConfigs;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntry;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntryBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntry;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntryBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ConnectionInfo;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagedNodeEntry;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.OpenvswitchExternalIds;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.OpenvswitchOtherConfigs;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceExternalIds;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.Options;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.OptionsBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.OptionsKey;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.PortExternalIds;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.PortOtherConfigs;
  53 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  54 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  55 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId;
  56 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  57 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  58 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  59 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  61 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointKey;
  63 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  64 import org.slf4j.Logger;
  65 import org.slf4j.LoggerFactory;
  66
  67 import com.google.common.base.Optional;
  68 import com.google.common.collect.ImmutableBiMap;
  69 import com.google.common.util.concurrent.CheckedFuture;
  70
  71 /**
  72  * Utility class to wrap mdsal transactions.
  73  *
  74  * @author Sam Hague (shague@redhat.com)
  75  */
  76 public class MdsalUtils {
  77     private static final Logger LOG = LoggerFactory.getLogger(MdsalUtils.class);
  78     private static DataBroker databroker = null;
  79     private static final int OVSDB_UPDATE_TIMEOUT = 500;
  80     private static final String PATCH_PORT_TYPE = "patch";
  81
  82     /**
  83      * Class constructor setting the data broker.
  84      *
  85      * @param dataBroker the {@link org.opendaylight.controller.md.sal.binding.api.DataBroker}
  86      */
  87     public MdsalUtils(DataBroker dataBroker) {
  88         this.databroker = dataBroker;
  89     }
  90
  91     /**
  92      * Executes delete as a blocking transaction.
  93      *
  94      * @param store {@link LogicalDatastoreType} which should be modified
  95      * @param path {@link InstanceIdentifier} to read from
  96      * @param <D> the data object type
  97      * @return the result of the request
  98      */
  99     public static <D extends org.opendaylight.yangtools.yang.binding.DataObject> boolean delete(
 100             final LogicalDatastoreType store, final InstanceIdentifier<D> path)  {
 101         boolean result = false;
 102         final WriteTransaction transaction = databroker.newWriteOnlyTransaction();
 103         transaction.delete(store, path);
 104         CheckedFuture<Void, TransactionCommitFailedException> future = transaction.submit();
 105         try {
 106             future.checkedGet();
 107             result = true;
 108         } catch (TransactionCommitFailedException e) {
 109             LOG.warn("Failed to delete {} ", path, e);
 110         }
 111         return result;
 112     }
 113
 114     /**
 115      * Executes merge as a blocking transaction.
 116      *
 117      * @param logicalDatastoreType {@link LogicalDatastoreType} which should be modified
 118      * @param path {@link InstanceIdentifier} for path to read
 119      * @param <D> the data object type
 120      * @return the result of the request
 121      */
 122     public static <D extends org.opendaylight.yangtools.yang.binding.DataObject> boolean merge(
 123             final LogicalDatastoreType logicalDatastoreType, final InstanceIdentifier<D> path, D data)  {
 124         boolean result = false;
 125         final WriteTransaction transaction = databroker.newWriteOnlyTransaction();
 126         transaction.merge(logicalDatastoreType, path, data, true);
 127         CheckedFuture<Void, TransactionCommitFailedException> future = transaction.submit();
 128         try {
 129             future.checkedGet();
 130             result = true;
 131         } catch (TransactionCommitFailedException e) {
 132             LOG.warn("Failed to merge {} ", path, e);
 133         }
 134         return result;
 135     }
 136
 137     /**
 138      * Executes put as a blocking transaction.
 139      *
 140      * @param logicalDatastoreType {@link LogicalDatastoreType} which should be modified
 141      * @param path {@link InstanceIdentifier} for path to read
 142      * @param <D> the data object type
 143      * @return the result of the request
 144      */
 145     public static <D extends org.opendaylight.yangtools.yang.binding.DataObject> boolean put(
 146             final LogicalDatastoreType logicalDatastoreType, final InstanceIdentifier<D> path, D data)  {
 147         boolean result = false;
 148         final WriteTransaction transaction = databroker.newWriteOnlyTransaction();
 149         transaction.put(logicalDatastoreType, path, data, true);
 150         CheckedFuture<Void, TransactionCommitFailedException> future = transaction.submit();
 151         try {
 152             future.checkedGet();
 153             result = true;
 154         } catch (TransactionCommitFailedException e) {
 155             LOG.warn("Failed to put {} ", path, e);
 156         }
 157         return result;
 158     }
 159
 160     /**
 161      * Executes read as a blocking transaction.
 162      *
 163      * @param store {@link LogicalDatastoreType} to read
 164      * @param path {@link InstanceIdentifier} for path to read
 165      * @param <D> the data object type
 166      * @return the result as the data object requested
 167      */
 168     public static <D extends org.opendaylight.yangtools.yang.binding.DataObject> D read(
 169             final LogicalDatastoreType store, final InstanceIdentifier<D> path)  {
 170         D result = null;
 171         final ReadOnlyTransaction transaction = databroker.newReadOnlyTransaction();
 172         Optional<D> optionalDataObject;
 173         CheckedFuture<Optional<D>, ReadFailedException> future = transaction.read(store, path);
 174         try {
 175             optionalDataObject = future.checkedGet();
 176             if (optionalDataObject.isPresent()) {
 177                 result = optionalDataObject.get();
 178             } else {
 179                 LOG.debug("{}: Failed to read {}",
 180                         Thread.currentThread().getStackTrace()[1], path);
 181             }
 182         } catch (ReadFailedException e) {
 183             LOG.warn("Failed to read {} ", path, e);
 184         }
 185         transaction.close();
 186         return result;
 187     }
 188
 189     public static ConnectionInfo getConnectionInfo(Node node) {
 190         ConnectionInfo connectionInfo = null;
 191         OvsdbNodeAugmentation ovsdbNodeAugmentation = node.getAugmentation(OvsdbNodeAugmentation.class);
 192         if (ovsdbNodeAugmentation != null) {
 193             connectionInfo = ovsdbNodeAugmentation.getConnectionInfo();
 194         }
 195         return connectionInfo;
 196     }
 197
 198     public static OvsdbNodeAugmentation extractOvsdbNode(Node node) {
 199         return node.getAugmentation(OvsdbNodeAugmentation.class);
 200     }
 201
 202     public static NodeId extractBridgeOvsdbNodeId(Node bridgeNode) {
 203         NodeId ovsdbNodeId = null;
 204         OvsdbBridgeAugmentation bridgeAugmentation = extractBridgeAugmentation(bridgeNode);
 205         if (bridgeAugmentation != null) {
 206             @SuppressWarnings("unchecked")
 207             InstanceIdentifier<Node> ovsdbNodeIid =
 208                     (InstanceIdentifier<Node>) (bridgeAugmentation.getManagedBy().getValue());
 209             ovsdbNodeId = InstanceIdentifier.keyOf(ovsdbNodeIid).getNodeId();
 210         }
 211         return ovsdbNodeId;
 212     }
 213
 214     public static OvsdbNodeAugmentation readOvsdbNode(Node bridgeNode) {
 215         OvsdbNodeAugmentation nodeAugmentation = null;
 216         OvsdbBridgeAugmentation bridgeAugmentation = extractBridgeAugmentation(bridgeNode);
 217         if(bridgeAugmentation != null){
 218             InstanceIdentifier<Node> ovsdbNodeIid = (InstanceIdentifier<Node>) bridgeAugmentation.getManagedBy().getValue();
 219             Node node = read(LogicalDatastoreType.OPERATIONAL, ovsdbNodeIid);
 220             if (node != null){
 221                 nodeAugmentation = node.getAugmentation(OvsdbNodeAugmentation.class);
 222                 LOG.debug("Ovsdb node {} found that manages bridge {}", nodeAugmentation != null?nodeAugmentation:"not",bridgeAugmentation);
 223             }else {
 224                 LOG.debug ("Ovsdb node that manages bridge {} not found. ",bridgeAugmentation);
 225             }
 226
 227         }else{
 228             LOG.debug("Provided node is not a bridge node : {}",bridgeNode);
 229         }
 230         return nodeAugmentation;
 231     }
 232
 233     public static String getOvsdbNodeUUID(Node node) {
 234         String nodeUUID = null;
 235         OvsdbNodeAugmentation ovsdbNodeAugmentation = node.getAugmentation(OvsdbNodeAugmentation.class);
 236         if (ovsdbNodeAugmentation != null) {
 237             // TODO replace with proper uuid and not the system-id
 238             nodeUUID = getOsdbNodeExternalIdsValue(ovsdbNodeAugmentation, "system-id");
 239         }
 240         return nodeUUID;
 241     }
 242
 243     public static String getOsdbNodeExternalIdsValue(OvsdbNodeAugmentation ovsdbNodeAugmentation, String key) {
 244         String value = null;
 245         List<OpenvswitchExternalIds> pairs = ovsdbNodeAugmentation.getOpenvswitchExternalIds();
 246         if (pairs != null && !pairs.isEmpty()) {
 247             for (OpenvswitchExternalIds pair : pairs) {
 248                 if (pair.getExternalIdKey().equals(key)) {
 249                     value = pair.getExternalIdValue();
 250                     break;
 251                 }
 252             }
 253         }
 254         return value;
 255     }
 256
 257     public static boolean addBridge(Node ovsdbNode, String bridgeName, String target)
 258             throws InterruptedException, InvalidParameterException {
 259         boolean result = false;
 260
 261         LOG.info("Add Bridge: node: {}, bridgeName: {}, target: {}", ovsdbNode, bridgeName, target);
 262         ConnectionInfo connectionInfo = getConnectionInfo(ovsdbNode);
 263         if (connectionInfo != null) {
 264             NodeBuilder bridgeNodeBuilder = new NodeBuilder();
 265             InstanceIdentifier<Node> bridgeIid =
 266                     MdsalHelper.createInstanceIdentifier(connectionInfo, new OvsdbBridgeName(bridgeName));
 267             NodeId bridgeNodeId = MdsalHelper.createManagedNodeId(bridgeIid);
 268             bridgeNodeBuilder.setNodeId(bridgeNodeId);
 269             OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder = new OvsdbBridgeAugmentationBuilder();
 270             ovsdbBridgeAugmentationBuilder.setControllerEntry(createControllerEntries(target));
 271             ovsdbBridgeAugmentationBuilder.setBridgeName(new OvsdbBridgeName(bridgeName));
 272             ovsdbBridgeAugmentationBuilder.setProtocolEntry(createMdsalProtocols());
 273             ovsdbBridgeAugmentationBuilder.setFailMode(
 274                     MdsalHelper.OVSDB_FAIL_MODE_MAP.inverse().get("secure"));
 275             setManagedByForBridge(ovsdbBridgeAugmentationBuilder, connectionInfo);
 276             bridgeNodeBuilder.addAugmentation(OvsdbBridgeAugmentation.class, ovsdbBridgeAugmentationBuilder.build());
 277
 278             result = put(LogicalDatastoreType.CONFIGURATION, bridgeIid, bridgeNodeBuilder.build());
 279             LOG.info("addBridge: result: {}", result);
 280         } else {
 281             throw new InvalidParameterException("Could not find ConnectionInfo");
 282         }
 283         return result;
 284     }
 285
 286     public static boolean deleteBridge(Node ovsdbNode) {
 287         boolean result = false;
 288         InstanceIdentifier<Node> bridgeIid =
 289                 MdsalHelper.createInstanceIdentifier(ovsdbNode.getNodeId());
 290
 291         result = delete(LogicalDatastoreType.CONFIGURATION, bridgeIid);
 292         LOG.info("Delete bridge node: {}, bridgeName: {} result : {}", ovsdbNode, ovsdbNode.getNodeId(),result);
 293         return result;
 294     }
 295
 296     public static OvsdbBridgeAugmentation readBridge(Node node, String name) {
 297         OvsdbBridgeAugmentation ovsdbBridgeAugmentation = null;
 298         ConnectionInfo connectionInfo = getConnectionInfo(node);
 299         if (connectionInfo != null) {
 300             InstanceIdentifier<Node> bridgeIid =
 301                     MdsalHelper.createInstanceIdentifier(connectionInfo, new OvsdbBridgeName(name));
 302             Node bridgeNode = read(LogicalDatastoreType.OPERATIONAL, bridgeIid);
 303             if (bridgeNode != null) {
 304                 ovsdbBridgeAugmentation = bridgeNode.getAugmentation(OvsdbBridgeAugmentation.class);
 305             }
 306         }
 307         return ovsdbBridgeAugmentation;
 308     }
 309
 310     public static Node readBridgeNode(Node node, String name) {
 311         Node bridgeNode = null;
 312         ConnectionInfo connectionInfo = getConnectionInfo(node);
 313         if (connectionInfo != null) {
 314             InstanceIdentifier<Node> bridgeIid =
 315                     MdsalHelper.createInstanceIdentifier(connectionInfo, new OvsdbBridgeName(name));
 316             bridgeNode = read(LogicalDatastoreType.OPERATIONAL, bridgeIid);
 317         }
 318         return bridgeNode;
 319     }
 320
 321     public static Node getBridgeNode(Node node, String bridgeName) {
 322         Node bridgeNode = null;
 323         OvsdbBridgeAugmentation bridge = extractBridgeAugmentation(node);
 324         if (bridge != null) {
 325             if (bridge.getBridgeName().getValue().equals(bridgeName)) {
 326                 bridgeNode = node;
 327             }
 328         } else {
 329             bridgeNode = readBridgeNode(node, bridgeName);
 330         }
 331
 332         return bridgeNode;
 333     }
 334
 335     public static Uuid getBridgeUuid(Node node, String name) {
 336         Uuid uuid = null;
 337         OvsdbBridgeAugmentation ovsdbBridgeAugmentation = readBridge(node, name);
 338         if (ovsdbBridgeAugmentation != null) {
 339             uuid = ovsdbBridgeAugmentation.getBridgeUuid();
 340         }
 341         return uuid;
 342     }
 343
 344     private static void setManagedByForBridge(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder,
 345                                      ConnectionInfo connectionInfo) {
 346         InstanceIdentifier<Node> connectionNodePath = MdsalHelper.createInstanceIdentifier(connectionInfo);
 347         ovsdbBridgeAugmentationBuilder.setManagedBy(new OvsdbNodeRef(connectionNodePath));
 348     }
 349
 350     private static void setControllerForBridge(Node ovsdbNode, String bridgeName, String targetString) {
 351         ConnectionInfo connectionInfo = getConnectionInfo(ovsdbNode);
 352         if (connectionInfo != null) {
 353             for (ControllerEntry controllerEntry: createControllerEntries(targetString)) {
 354                 InstanceIdentifier<ControllerEntry> iid =
 355                         MdsalHelper.createInstanceIdentifier(connectionInfo, new OvsdbBridgeName(bridgeName))
 356                                 .augmentation(OvsdbBridgeAugmentation.class)
 357                                 .child(ControllerEntry.class, controllerEntry.getKey());
 358
 359                 boolean result = put(LogicalDatastoreType.CONFIGURATION, iid, controllerEntry);
 360                 LOG.info("addController: result: {}", result);
 361             }
 362         }
 363     }
 364
 365     private static List<ControllerEntry> createControllerEntries(String targetString) {
 366         List<ControllerEntry> controllerEntries = new ArrayList<ControllerEntry>();
 367         ControllerEntryBuilder controllerEntryBuilder = new ControllerEntryBuilder();
 368         controllerEntryBuilder.setTarget(new Uri(targetString));
 369         controllerEntries.add(controllerEntryBuilder.build());
 370         return controllerEntries;
 371     }
 372
 373     private static List<ProtocolEntry> createMdsalProtocols() {
 374         List<ProtocolEntry> protocolList = new ArrayList<ProtocolEntry>();
 375         ImmutableBiMap<String, Class<? extends OvsdbBridgeProtocolBase>> mapper =
 376                 MdsalHelper.OVSDB_PROTOCOL_MAP.inverse();
 377         protocolList.add(new ProtocolEntryBuilder().
 378                 setProtocol((Class<? extends OvsdbBridgeProtocolBase>) mapper.get("OpenFlow13")).build());
 379         return protocolList;
 380     }
 381
 382     public static long getDataPathId(Node node) {
 383         long dpid = 0L;
 384         String datapathId = getDatapathId(node);
 385         if (datapathId != null) {
 386             dpid = new BigInteger(datapathId.replaceAll(":", ""), 16).longValue();
 387         }
 388         return dpid;
 389     }
 390
 391     public static String getDatapathId(Node node) {
 392         String datapathId = null;
 393         OvsdbBridgeAugmentation ovsdbBridgeAugmentation = node.getAugmentation(OvsdbBridgeAugmentation.class);
 394         if (ovsdbBridgeAugmentation != null && ovsdbBridgeAugmentation.getDatapathId() != null) {
 395             datapathId = node.getAugmentation(OvsdbBridgeAugmentation.class).getDatapathId().getValue();
 396         }
 397         return datapathId;
 398     }
 399
 400     public static String getDatapathId(OvsdbBridgeAugmentation ovsdbBridgeAugmentation) {
 401         String datapathId = null;
 402         if (ovsdbBridgeAugmentation != null && ovsdbBridgeAugmentation.getDatapathId() != null) {
 403             datapathId = ovsdbBridgeAugmentation.getDatapathId().getValue();
 404         }
 405         return datapathId;
 406     }
 407
 408     public static OvsdbBridgeAugmentation getBridge(Node node, String name) {
 409         OvsdbBridgeAugmentation bridge = node.getAugmentation(OvsdbBridgeAugmentation.class);
 410         if (bridge != null) {
 411             if (!bridge.getBridgeName().getValue().equals(name)) {
 412                 bridge = null;
 413             }
 414         }
 415         return bridge;
 416     }
 417
 418     public static OvsdbBridgeAugmentation getBridge(Node node) {
 419         OvsdbBridgeAugmentation bridge = node.getAugmentation(OvsdbBridgeAugmentation.class);
 420         return bridge;
 421     }
 422
 423     public static String getBridgeName(Node node) {
 424         String bridgeName = null;
 425         OvsdbBridgeAugmentation bridge = getBridge(node);
 426         if (bridge != null) {
 427             bridgeName = bridge.getBridgeName().getValue();
 428         }
 429         return bridgeName;
 430     }
 431
 432     public static String extractBridgeName(Node node) {
 433         return (node.getAugmentation(OvsdbBridgeAugmentation.class).getBridgeName().getValue());
 434     }
 435
 436     public static OvsdbBridgeAugmentation extractBridgeAugmentation(Node node) {
 437         return node.getAugmentation(OvsdbBridgeAugmentation.class);
 438     }
 439
 440     public static List<Node> getAllBridgesOnOvsdbNode(Node node) {
 441         List<Node> nodes = new ArrayList<Node>();
 442         List<ManagedNodeEntry> managedNodes = node.getAugmentation(OvsdbNodeAugmentation.class).getManagedNodeEntry();
 443         for (ManagedNodeEntry managedNode : managedNodes) {
 444             InstanceIdentifier<?> bridgeIid = managedNode.getBridgeRef().getValue();
 445             Node bridgeNode = (Node) read(LogicalDatastoreType.OPERATIONAL, bridgeIid);
 446             if (bridgeNode != null) {
 447                 nodes.add(bridgeNode);
 448             }
 449         }
 450         return nodes;
 451     }
 452
 453     public static OvsdbNodeAugmentation extractNodeAugmentation(Node node) {
 454         return node.getAugmentation(OvsdbNodeAugmentation.class);
 455     }
 456
 457     /**
 458      * Method read ports from bridge node. Method will check if the provided node
 459      * has the ports details, if not, it will read from Operational data store.
 460      * @param node
 461      * @return
 462      */
 463     public static List<OvsdbTerminationPointAugmentation> getTerminationPointsOfBridge(Node node) {
 464         List<OvsdbTerminationPointAugmentation> tpAugmentations = extractTerminationPointAugmentations(node);
 465         if(tpAugmentations.isEmpty()){
 466             tpAugmentations = readTerminationPointAugmentationFromDataStore(node);
 467         }
 468         return tpAugmentations;
 469     }
 470
 471     public static OvsdbTerminationPointAugmentation extractTerminationPointAugmentation(Node bridgeNode, String portName) {
 472         OvsdbBridgeAugmentation ovsdbBridgeAugmentation = bridgeNode.getAugmentation(OvsdbBridgeAugmentation.class);
 473         if (ovsdbBridgeAugmentation != null) {
 474             List<TerminationPoint> terminationPoints = bridgeNode.getTerminationPoint();
 475             for(TerminationPoint terminationPoint : terminationPoints) {
 476                 OvsdbTerminationPointAugmentation ovsdbTerminationPointAugmentation =
 477                         terminationPoint.getAugmentation( OvsdbTerminationPointAugmentation.class);
 478                 if (ovsdbTerminationPointAugmentation != null
 479                         && ovsdbTerminationPointAugmentation.getName().equals(portName)) {
 480                     return ovsdbTerminationPointAugmentation;
 481                 }
 482             }
 483         }
 484         return null;
 485     }
 486
 487     public static List<TerminationPoint> extractTerminationPoints(Node node) {
 488         List<TerminationPoint> terminationPoints = new ArrayList<TerminationPoint>();
 489         OvsdbBridgeAugmentation ovsdbBridgeAugmentation = node.getAugmentation(OvsdbBridgeAugmentation.class);
 490         if (ovsdbBridgeAugmentation != null) {
 491             terminationPoints.addAll(node.getTerminationPoint());
 492         }
 493         return terminationPoints;
 494     }
 495
 496     public static List<OvsdbTerminationPointAugmentation> extractTerminationPointAugmentations( Node node ) {
 497         List<OvsdbTerminationPointAugmentation> tpAugmentations = new ArrayList<OvsdbTerminationPointAugmentation>();
 498         List<TerminationPoint> terminationPoints = node.getTerminationPoint();
 499         if(terminationPoints != null && !terminationPoints.isEmpty()){
 500             for(TerminationPoint tp : terminationPoints){
 501                 tpAugmentations.add(tp.getAugmentation(OvsdbTerminationPointAugmentation.class));
 502             }
 503         }
 504         return tpAugmentations;
 505     }
 506
 507     public static List<OvsdbTerminationPointAugmentation> readTerminationPointAugmentationFromDataStore( Node node ) {
 508         InstanceIdentifier<Node> bridgeNodeIid = MdsalHelper.createInstanceIdentifier(node.getNodeId());
 509         Node operNode = read(LogicalDatastoreType.OPERATIONAL, bridgeNodeIid);
 510         if(operNode != null){
 511             return extractTerminationPointAugmentations(operNode);
 512         }
 513         return new ArrayList<OvsdbTerminationPointAugmentation>();
 514     }
 515
 516     public static String getInterfaceExternalIdsValue(
 517             OvsdbTerminationPointAugmentation terminationPointAugmentation, String key) {
 518         String value = null;
 519         List<InterfaceExternalIds> pairs = terminationPointAugmentation.getInterfaceExternalIds();
 520         if (pairs != null && !pairs.isEmpty()) {
 521             for (InterfaceExternalIds pair : pairs) {
 522                 if (pair.getExternalIdKey().equals(key)) {
 523                     value = pair.getExternalIdValue();
 524                     break;
 525                 }
 526             }
 527         }
 528         return value;
 529     }
 530
 531     public static Boolean addTerminationPoint(Node bridgeNode, String bridgeName, String portName, String type) {
 532         InstanceIdentifier<TerminationPoint> tpIid =
 533                 MdsalHelper.createTerminationPointInstanceIdentifier(bridgeNode, portName);
 534         OvsdbTerminationPointAugmentationBuilder tpAugmentationBuilder =
 535                 new OvsdbTerminationPointAugmentationBuilder();
 536
 537         tpAugmentationBuilder.setName(portName);
 538         if (type != null) {
 539             tpAugmentationBuilder.setInterfaceType(MdsalHelper.OVSDB_INTERFACE_TYPE_MAP.get(type));
 540         }
 541         TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
 542         tpBuilder.setKey(InstanceIdentifier.keyOf(tpIid));
 543         tpBuilder.addAugmentation(OvsdbTerminationPointAugmentation.class, tpAugmentationBuilder.build());
 544         return put(LogicalDatastoreType.CONFIGURATION, tpIid, tpBuilder.build());
 545     }
 546
 547     public static Boolean deleteTerminationPoint(Node bridgeNode, String portName) {
 548         InstanceIdentifier<TerminationPoint> tpIid =
 549                 MdsalHelper.createTerminationPointInstanceIdentifier(bridgeNode, portName);
 550         return delete(LogicalDatastoreType.CONFIGURATION, tpIid);
 551     }
 552
 553     public static Boolean addTerminationPoint(Node bridgeNode, String bridgeName, String portName,
 554             String type, Map<String, String> options) {
 555         InstanceIdentifier<TerminationPoint> tpIid = MdsalHelper.createTerminationPointInstanceIdentifier(
 556                 bridgeNode, portName);
 557         OvsdbTerminationPointAugmentationBuilder tpAugmentationBuilder = new OvsdbTerminationPointAugmentationBuilder();
 558
 559         tpAugmentationBuilder.setName(portName);
 560         if (type != null) {
 561             tpAugmentationBuilder.setInterfaceType(MdsalHelper.OVSDB_INTERFACE_TYPE_MAP.get(type));
 562         }
 563
 564         List<Options> optionsList = new ArrayList<Options>();
 565         for (Map.Entry<String, String> entry : options.entrySet()) {
 566             OptionsBuilder optionsBuilder = new OptionsBuilder();
 567             optionsBuilder.setKey(new OptionsKey(entry.getKey()));
 568             optionsBuilder.setOption(entry.getKey());
 569             optionsBuilder.setValue(entry.getValue());
 570             optionsList.add(optionsBuilder.build());
 571         }
 572         tpAugmentationBuilder.setOptions(optionsList);
 573
 574         TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
 575         tpBuilder.setKey(InstanceIdentifier.keyOf(tpIid));
 576         tpBuilder.addAugmentation(OvsdbTerminationPointAugmentation.class, tpAugmentationBuilder.build());
 577         /* TODO SB_MIGRATION should this be merge or put */
 578         return put(LogicalDatastoreType.CONFIGURATION, tpIid, tpBuilder.build());
 579     }
 580
 581     public static Boolean readTerminationPoint(Node bridgeNode, String bridgeName, String portName) {
 582         InstanceIdentifier<TerminationPoint> tpIid = MdsalHelper.createTerminationPointInstanceIdentifier(
 583                 bridgeNode, portName);
 584         return read(LogicalDatastoreType.OPERATIONAL, tpIid) != null;
 585     }
 586
 587     public static Boolean addTunnelTerminationPoint(Node bridgeNode, String bridgeName, String portName, String type,
 588                                         Map<String, String> options) {
 589         return addTerminationPoint(bridgeNode, bridgeName, portName, type, options);
 590     }
 591
 592     public static Boolean isTunnelTerminationPointExist(Node bridgeNode, String bridgeName, String portName){
 593         return readTerminationPoint(bridgeNode, bridgeName, portName);
 594     }
 595     public static Boolean addPatchTerminationPoint(Node node, String bridgeName, String portName, String peerPortName) {
 596         Map<String, String> option = new HashMap<String, String>();
 597         option.put("peer", peerPortName);
 598         return addTerminationPoint(node, bridgeName, portName, PATCH_PORT_TYPE, option);
 599     }
 600
 601     public static String getExternalId(Node node, OvsdbTables table, String key) {
 602         switch (table) {
 603         case BRIDGE:
 604             OvsdbBridgeAugmentation bridge = extractBridgeAugmentation(node);
 605             if (bridge != null) {
 606                 for (BridgeExternalIds bridgeExternaIds :bridge.getBridgeExternalIds()) {
 607                 if (bridgeExternaIds.getBridgeExternalIdKey().equals(key)) {
 608                         return bridgeExternaIds.getBridgeExternalIdValue();
 609                     }
 610                 }
 611             }
 612             break;
 613         case CONTROLLER:
 614             LOG.debug("There is no external_id for OvsdbTables: ", table);
 615             return null;
 616         case OPENVSWITCH:
 617             OvsdbNodeAugmentation ovsdbNode = extractNodeAugmentation(node);
 618             if (ovsdbNode != null) {
 619                 for ( OpenvswitchExternalIds openvswitchExternalIds :ovsdbNode.getOpenvswitchExternalIds()) {
 620                     if (openvswitchExternalIds.getExternalIdKey().equals(key)) {
 621                         return openvswitchExternalIds.getExternalIdValue();
 622                     }
 623                 }
 624             }
 625             break;
 626         case PORT:
 627             List <OvsdbTerminationPointAugmentation> ports = extractTerminationPointAugmentations(node);
 628             for (OvsdbTerminationPointAugmentation port : ports) {
 629                 if (port != null && port.getPortExternalIds() != null) {
 630                     for (PortExternalIds portExternalIds :port.getPortExternalIds()) {
 631                         if (portExternalIds.getExternalIdKey().equals(key)) {
 632                             return portExternalIds.getExternalIdValue();
 633                         }
 634                     }
 635                 }
 636             }
 637             break;
 638         default:
 639             LOG.debug("Couldn't find the specified OvsdbTables: ", table);
 640             return null;
 641         }
 642         return null;
 643     }
 644
 645     public static String getOtherConfig(Node node, OvsdbTables table, String key) {
 646         switch (table) {
 647             case BRIDGE:
 648                 OvsdbBridgeAugmentation bridge = extractBridgeAugmentation(node);
 649                 if (bridge != null) {
 650                     for (BridgeOtherConfigs bridgeOtherConfigs : bridge.getBridgeOtherConfigs()) {
 651                         if (bridgeOtherConfigs.getBridgeOtherConfigKey().equals(key)) {
 652                             return bridgeOtherConfigs.getBridgeOtherConfigValue();
 653                         }
 654                     }
 655                 }
 656                 break;
 657             case CONTROLLER:
 658                 LOG.debug("There is no other_config for OvsdbTables: ", table);
 659                 return null;
 660
 661             case OPENVSWITCH:
 662                 OvsdbNodeAugmentation ovsdbNode = extractNodeAugmentation(node);
 663                 if (ovsdbNode == null){
 664                     ovsdbNode = readOvsdbNode(node);
 665                 }
 666                 if (ovsdbNode != null) {
 667                     for (OpenvswitchOtherConfigs openvswitchOtherConfigs :ovsdbNode.getOpenvswitchOtherConfigs()){
 668                         if (openvswitchOtherConfigs.getOtherConfigKey().equals(key)) {
 669                             return openvswitchOtherConfigs.getOtherConfigValue();
 670                         }
 671                     }
 672                 }
 673                 break;
 674             case PORT:
 675                 List <OvsdbTerminationPointAugmentation> ports = extractTerminationPointAugmentations(node);
 676                 for (OvsdbTerminationPointAugmentation port : ports) {
 677                     if (port != null && port.getPortOtherConfigs() != null) {
 678                         for (PortOtherConfigs portOtherConfigs : port.getPortOtherConfigs()) {
 679                             if (portOtherConfigs.getOtherConfigKey().equals(key)) {
 680                                 return portOtherConfigs.getOtherConfigValue();
 681                             }
 682                         }
 683                     }
 684                 }
 685                 break;
 686             default:
 687                 LOG.debug("Couldn't find the specified OvsdbTables: ", table);
 688                 return null;
 689         }
 690         return null;
 691     }
 692
 693     public static boolean addVlanToTp(long vlan) {
 694         return false;
 695     }
 696
 697     public static boolean isTunnel(OvsdbTerminationPointAugmentation port) {
 698         return MdsalHelper.createOvsdbInterfaceType(
 699                 port.getInterfaceType()).equals(NetworkHandler.NETWORK_TYPE_VXLAN)
 700                 || MdsalHelper.createOvsdbInterfaceType(
 701                 port.getInterfaceType()).equals(NetworkHandler.NETWORK_TYPE_GRE);
 702     }
 703
 704     public static String getOptionsValue(List<Options> options, String key) {
 705         String value = null;
 706         for (Options option : options) {
 707             if (option.getKey().equals(key)) {
 708                 value = option.getValue();
 709             }
 710         }
 711         return value;
 712     }
 713
 714     private static Topology getOvsdbTopology() {
 715         InstanceIdentifier<Topology> path = InstanceIdentifier
 716                 .create(NetworkTopology.class)
 717                 .child(Topology.class, new TopologyKey(MdsalHelper.OVSDB_TOPOLOGY_ID));
 718
 719         Topology topology = read(LogicalDatastoreType.OPERATIONAL, path);
 720         return topology;
 721     }
 722
 723     public static Long getOFPort(OvsdbTerminationPointAugmentation port) {
 724         Long ofPort = 0L;
 725         if (port.getOfport() != null) {
 726             ofPort = port.getOfport();
 727         }
 728         return ofPort;
 729     }
 730 }