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