southbound/southbound-impl/src/main/java/org/opendaylight/ovsdb/southbound/SouthboundMapper.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 package org.opendaylight.ovsdb.southbound;
   9
  10 import static java.util.Objects.requireNonNull;
  11 import static org.opendaylight.ovsdb.southbound.SouthboundUtil.schemaMismatchLog;
  12
  13 import com.google.common.annotations.VisibleForTesting;
  14 import com.google.common.base.Joiner;
  15 import com.google.common.base.Preconditions;
  16 import com.google.common.base.Splitter;
  17 import com.google.common.collect.ImmutableBiMap;
  18 import com.google.common.net.InetAddresses;
  19 import java.net.Inet4Address;
  20 import java.net.Inet6Address;
  21 import java.net.InetAddress;
  22 import java.net.UnknownHostException;
  23 import java.util.ArrayList;
  24 import java.util.HashMap;
  25 import java.util.HashSet;
  26 import java.util.List;
  27 import java.util.Map;
  28 import java.util.Set;
  29 import org.opendaylight.ovsdb.lib.OvsdbClient;
  30 import org.opendaylight.ovsdb.lib.error.SchemaVersionMismatchException;
  31 import org.opendaylight.ovsdb.lib.notation.UUID;
  32 import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
  33 import org.opendaylight.ovsdb.lib.schema.typed.TypedDatabaseSchema;
  34 import org.opendaylight.ovsdb.schema.openvswitch.Bridge;
  35 import org.opendaylight.ovsdb.schema.openvswitch.Controller;
  36 import org.opendaylight.ovsdb.schema.openvswitch.Manager;
  37 import org.opendaylight.ovsdb.schema.openvswitch.OpenVSwitch;
  38 import org.opendaylight.ovsdb.schema.openvswitch.Qos;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IetfInetUtil;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathId;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathTypeBase;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathTypeNetdev;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathTypeSystem;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeBase;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeDpdk;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeDpdkr;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeDpdkvhost;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeDpdkvhostuser;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeDpdkvhostuserclient;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeGeneve;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeGre;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeGre64;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeInternal;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeIpsecGre;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeIpsecGre64;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeLisp;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypePatch;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeStt;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeSystem;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeTap;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeVxlan;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeVxlanGpe;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolBase;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeBase;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeEgressPolicer;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeLinuxCodel;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeLinuxFqCodel;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeLinuxHfsc;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeLinuxHtb;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeLinuxSfq;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntry;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntryBuilder;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntryKey;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntry;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntryBuilder;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntryKey;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ConnectionInfo;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ConnectionInfoBuilder;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagerEntry;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagerEntryBuilder;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagerEntryKey;
  89 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  90 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  91 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  92 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  93 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  94 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  95 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  96 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointKey;
  97 import org.opendaylight.yangtools.yang.binding.DataObject;
  98 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  99 import org.opendaylight.yangtools.yang.common.Uint16;
 100 import org.opendaylight.yangtools.yang.common.Uint32;
 101 import org.slf4j.Logger;
 102 import org.slf4j.LoggerFactory;
 103
 104 public final class SouthboundMapper {
 105     private static final Logger LOG = LoggerFactory.getLogger(SouthboundMapper.class);
 106     private static final String N_CONNECTIONS_STR = "n_connections";
 107
 108     @VisibleForTesting
 109     public static final ImmutableBiMap<Class<? extends DatapathTypeBase>, String> DATAPATH_TYPE_MAP =
 110         ImmutableBiMap.of(
 111             DatapathTypeSystem.class, "system",
 112             DatapathTypeNetdev.class, "netdev");
 113     @VisibleForTesting
 114     public static final ImmutableBiMap<String, Class<? extends InterfaceTypeBase>> OVSDB_INTERFACE_TYPE_MAP =
 115         ImmutableBiMap.<String, Class<? extends InterfaceTypeBase>>builder()
 116             .put("internal", InterfaceTypeInternal.class)
 117             .put("vxlan", InterfaceTypeVxlan.class)
 118             .put("vxlan-gpe", InterfaceTypeVxlanGpe.class)
 119             .put("patch", InterfaceTypePatch.class)
 120             .put("system", InterfaceTypeSystem.class)
 121             .put("tap", InterfaceTypeTap.class)
 122             .put("geneve", InterfaceTypeGeneve.class)
 123             .put("gre", InterfaceTypeGre.class)
 124             .put("ipsec_gre", InterfaceTypeIpsecGre.class)
 125             .put("gre64", InterfaceTypeGre64.class)
 126             .put("ipsec_gre64", InterfaceTypeIpsecGre64.class)
 127             .put("lisp", InterfaceTypeLisp.class)
 128             .put("dpdk", InterfaceTypeDpdk.class)
 129             .put("dpdkr", InterfaceTypeDpdkr.class)
 130             .put("dpdkvhost", InterfaceTypeDpdkvhost.class)
 131             .put("dpdkvhostuser", InterfaceTypeDpdkvhostuser.class)
 132             .put("dpdkvhostuserclient", InterfaceTypeDpdkvhostuserclient.class)
 133             .put("stt", InterfaceTypeStt.class)
 134             .build();
 135     private static final ImmutableBiMap<Class<? extends QosTypeBase>, String> QOS_TYPE_MAP =
 136         ImmutableBiMap.<Class<? extends QosTypeBase>, String>builder()
 137             .put(QosTypeLinuxHtb.class, SouthboundConstants.QOS_LINUX_HTB)
 138             .put(QosTypeLinuxHfsc.class, SouthboundConstants.QOS_LINUX_HFSC)
 139             .put(QosTypeLinuxSfq.class, SouthboundConstants.QOS_LINUX_SFQ)
 140             .put(QosTypeLinuxCodel.class, SouthboundConstants.QOS_LINUX_CODEL)
 141             .put(QosTypeLinuxFqCodel.class, SouthboundConstants.QOS_LINUX_FQ_CODEL)
 142             .put(QosTypeEgressPolicer.class, SouthboundConstants.QOS_EGRESS_POLICER)
 143             .build();
 144
 145     private SouthboundMapper() {
 146
 147     }
 148
 149     public static IpAddress createIpAddress(final InetAddress address) {
 150         IpAddress ip = null;
 151         if (address instanceof Inet4Address) {
 152             ip = createIpAddress((Inet4Address)address);
 153         } else if (address instanceof Inet6Address) {
 154             ip = createIpAddress((Inet6Address)address);
 155         }
 156         return ip;
 157     }
 158
 159     public static IpAddress createIpAddress(final Inet4Address address) {
 160         return IetfInetUtil.INSTANCE.ipAddressFor(address);
 161     }
 162
 163     public static IpAddress createIpAddress(final Inet6Address address) {
 164         Ipv6Address ipv6 = new Ipv6Address(address.getHostAddress());
 165         return new IpAddress(ipv6);
 166     }
 167
 168     public static InstanceIdentifier<Topology> createTopologyInstanceIdentifier() {
 169         return InstanceIdentifier
 170                 .create(NetworkTopology.class)
 171                 .child(Topology.class, new TopologyKey(SouthboundConstants.OVSDB_TOPOLOGY_ID));
 172     }
 173
 174     public static InstanceIdentifier<Node> createInstanceIdentifier(final NodeId nodeId) {
 175         return createTopologyInstanceIdentifier()
 176                 .child(Node.class,new NodeKey(nodeId));
 177     }
 178
 179     @SuppressWarnings("unchecked")
 180     public static InstanceIdentifier<Node> createInstanceIdentifier(
 181             final InstanceIdentifierCodec instanceIdentifierCodec, final OvsdbConnectionInstance client,
 182             final Bridge bridge) {
 183         InstanceIdentifier<Node> iid;
 184         if (bridge.getExternalIdsColumn() != null
 185                 && bridge.getExternalIdsColumn().getData() != null
 186                 && bridge.getExternalIdsColumn().getData().containsKey(SouthboundConstants.IID_EXTERNAL_ID_KEY)) {
 187             String iidString = bridge.getExternalIdsColumn().getData().get(SouthboundConstants.IID_EXTERNAL_ID_KEY);
 188             iid = (InstanceIdentifier<Node>) instanceIdentifierCodec.bindingDeserializerOrNull(iidString);
 189         } else {
 190             iid = createInstanceIdentifier(client, bridge.getName());
 191         }
 192         return iid;
 193     }
 194
 195     @SuppressWarnings("unchecked")
 196     public static InstanceIdentifier<Node> createInstanceIdentifier(
 197             final InstanceIdentifierCodec instanceIdentifierCodec, final OvsdbConnectionInstance client,
 198             final Controller controller, final String bridgeName) {
 199         InstanceIdentifier<Node> iid;
 200         if (controller.getExternalIdsColumn() != null
 201                 && controller.getExternalIdsColumn().getData() != null
 202                 && controller.getExternalIdsColumn().getData().containsKey(SouthboundConstants.IID_EXTERNAL_ID_KEY)) {
 203             String iidString = controller.getExternalIdsColumn().getData().get(SouthboundConstants.IID_EXTERNAL_ID_KEY);
 204             iid = (InstanceIdentifier<Node>) instanceIdentifierCodec.bindingDeserializerOrNull(iidString);
 205         } else {
 206             iid = createInstanceIdentifier(client, bridgeName);
 207         }
 208         return iid;
 209     }
 210
 211     public static InstanceIdentifier<Node> createInstanceIdentifier(
 212             final OvsdbConnectionInstance client, final String bridgeName) {
 213         String nodeString = client.getNodeKey().getNodeId().getValue()
 214                 + "/bridge/" + bridgeName;
 215         NodeId nodeId = new NodeId(new Uri(nodeString));
 216         return createInstanceIdentifier(nodeId);
 217
 218     }
 219
 220     public static NodeId createManagedNodeId(final InstanceIdentifier<Node> iid) {
 221         NodeKey nodeKey = iid.firstKeyOf(Node.class);
 222         return nodeKey.getNodeId();
 223     }
 224
 225     public static InetAddress createInetAddress(final IpAddress ip) throws UnknownHostException {
 226         if (ip.getIpv4Address() != null) {
 227             return InetAddresses.forString(ip.getIpv4Address().getValue());
 228         } else if (ip.getIpv6Address() != null) {
 229             return InetAddress.getByName(ip.getIpv6Address().getValue());
 230         } else {
 231             throw new UnknownHostException("IP Address has no value");
 232         }
 233     }
 234
 235     public static DatapathId createDatapathId(final Bridge bridge) {
 236         requireNonNull(bridge);
 237         if (bridge.getDatapathIdColumn() == null) {
 238             return null;
 239         } else {
 240             return createDatapathId(bridge.getDatapathIdColumn().getData());
 241         }
 242     }
 243
 244     public static DatapathId createDatapathId(final Set<String> dpids) {
 245         requireNonNull(dpids);
 246         if (dpids.isEmpty()) {
 247             return null;
 248         } else {
 249             String[] dpidArray = new String[dpids.size()];
 250             dpids.toArray(dpidArray);
 251             return createDatapathId(dpidArray[0]);
 252         }
 253     }
 254
 255     public static DatapathId createDatapathId(final String dpid) {
 256         requireNonNull(dpid);
 257         DatapathId datapath;
 258         if (dpid.matches("^[0-9a-fA-F]{16}")) {
 259             Splitter splitter = Splitter.fixedLength(2);
 260             Joiner joiner = Joiner.on(":");
 261             datapath = new DatapathId(joiner.join(splitter.split(dpid)));
 262         } else {
 263             datapath = new DatapathId(dpid);
 264         }
 265         return datapath;
 266     }
 267
 268     public static String createDatapathType(final OvsdbBridgeAugmentation mdsalbridge) {
 269         String datapathtype = DATAPATH_TYPE_MAP.get(DatapathTypeSystem.class);
 270
 271         if (mdsalbridge.getDatapathType() != null && !mdsalbridge.getDatapathType().equals(DatapathTypeBase.class)) {
 272             datapathtype = DATAPATH_TYPE_MAP.get(mdsalbridge.getDatapathType());
 273             if (datapathtype == null) {
 274                 throw new IllegalArgumentException("Unknown datapath type " + mdsalbridge.getDatapathType().getName());
 275             }
 276         }
 277         return datapathtype;
 278     }
 279
 280     public static Class<? extends DatapathTypeBase> createDatapathType(final String type) {
 281         if (type.isEmpty()) {
 282             return DatapathTypeSystem.class;
 283         }
 284         return DATAPATH_TYPE_MAP.inverse().get(type);
 285     }
 286
 287     public static Set<String> createOvsdbBridgeProtocols(final OvsdbBridgeAugmentation ovsdbBridgeNode) {
 288         Set<String> protocols = new HashSet<>();
 289         Map<ProtocolEntryKey, ProtocolEntry> entries = ovsdbBridgeNode.getProtocolEntry();
 290         if (entries != null) {
 291             for (ProtocolEntry protocol : entries.values()) {
 292                 Class<? extends OvsdbBridgeProtocolBase> lookup = protocol.getProtocol();
 293                 final String toAdd = SouthboundConstants.OVSDB_PROTOCOL_MAP.get(protocol.getProtocol());
 294                 Preconditions.checkArgument(toAdd != null, "Unknown protocol %s", lookup);
 295                 protocols.add(toAdd);
 296             }
 297         }
 298         return protocols;
 299     }
 300
 301     public static  Class<? extends InterfaceTypeBase> createInterfaceType(final String type) {
 302         return OVSDB_INTERFACE_TYPE_MAP.get(requireNonNull(type));
 303     }
 304
 305     public static String createOvsdbInterfaceType(final Class<? extends InterfaceTypeBase> mdsaltype) {
 306         return OVSDB_INTERFACE_TYPE_MAP.inverse().get(requireNonNull(mdsaltype));
 307     }
 308
 309     public static List<ProtocolEntry> createMdsalProtocols(final Bridge bridge) {
 310         Set<String> protocols = null;
 311         try {
 312             protocols = bridge.getProtocolsColumn().getData();
 313         } catch (SchemaVersionMismatchException e) {
 314             schemaMismatchLog("protocols", "Bridge", e);
 315         }
 316         List<ProtocolEntry> protocolList = new ArrayList<>();
 317         if (protocols != null && !protocols.isEmpty()) {
 318             ImmutableBiMap<String, Class<? extends OvsdbBridgeProtocolBase>> mapper =
 319                     SouthboundConstants.OVSDB_PROTOCOL_MAP.inverse();
 320             for (String protocol : protocols) {
 321                 if (protocol != null) {
 322                     final Class<? extends OvsdbBridgeProtocolBase> mapped = mapper.get(protocol);
 323                     if (mapped != null) {
 324                         protocolList.add(new ProtocolEntryBuilder().setProtocol(mapped).build());
 325                     }
 326                 }
 327             }
 328         }
 329         return protocolList;
 330     }
 331
 332     /**
 333      * Create the {@link ControllerEntry} list given an OVSDB {@link Bridge}
 334      * and {@link Controller} rows.
 335      *
 336      * @param bridge the {@link Bridge} to update
 337      * @param updatedControllerRows the list of {@link Controller} controllers with updates
 338      * @return list of {@link ControllerEntry} entries
 339      */
 340     public static List<ControllerEntry> createControllerEntries(final Bridge bridge,
 341                                                                 final Map<UUID, Controller> updatedControllerRows) {
 342
 343         LOG.debug("createControllerEntries Bridge: {}\n, updatedControllerRows: {}",
 344                 bridge, updatedControllerRows);
 345         final Set<UUID> controllerUuids = bridge.getControllerColumn().getData();
 346         final List<ControllerEntry> controllerEntries = new ArrayList<>();
 347         for (UUID controllerUuid : controllerUuids) {
 348             final Controller controller = updatedControllerRows.get(controllerUuid);
 349             addControllerEntries(controllerEntries, controller);
 350         }
 351         LOG.debug("controllerEntries: {}", controllerEntries);
 352         return controllerEntries;
 353     }
 354
 355     /**
 356      * Create the {@link ControllerEntry} list given an MDSAL {@link Node} bridge
 357      * and {@link Controller} rows.
 358      *
 359      * @param bridgeNode the {@link Node} to update
 360      * @param updatedControllerRows the list of {@link Controller} controllers with updates
 361      * @return list of {@link ControllerEntry} entries
 362      */
 363     public static List<ControllerEntry> createControllerEntries(final Node bridgeNode,
 364                                                                 final Map<UUID, Controller> updatedControllerRows) {
 365
 366         LOG.debug("createControllerEntries Bridge 2: {}\n, updatedControllerRows: {}",
 367                 bridgeNode, updatedControllerRows);
 368         final List<ControllerEntry> controllerEntriesCreated = new ArrayList<>();
 369         final OvsdbBridgeAugmentation ovsdbBridgeAugmentation =
 370                 bridgeNode.augmentation(OvsdbBridgeAugmentation.class);
 371         if (ovsdbBridgeAugmentation == null) {
 372             return controllerEntriesCreated;
 373         }
 374
 375         final Map<ControllerEntryKey, ControllerEntry> controllerEntries = ovsdbBridgeAugmentation.getControllerEntry();
 376         if (controllerEntries != null) {
 377             for (ControllerEntry controllerEntry : controllerEntries.values()) {
 378                 final Controller controller = updatedControllerRows.get(
 379                         new UUID(controllerEntry.getControllerUuid().getValue()));
 380                 addControllerEntries(controllerEntriesCreated, controller);
 381             }
 382         }
 383         LOG.debug("controllerEntries: {}", controllerEntriesCreated);
 384         return controllerEntriesCreated;
 385     }
 386
 387     /**
 388      * Add the OVSDB {@link Controller} updates to the MDSAL {@link ControllerEntry} list.
 389      *
 390      * @param controllerEntries the list of {@link ControllerEntry} to update
 391      * @param controller the updated OVSDB {@link Controller}
 392      */
 393     public static void addControllerEntries(final List<ControllerEntry> controllerEntries,
 394                                             final Controller controller) {
 395
 396         if (controller != null && controller.getTargetColumn() != null) {
 397             final String targetString = controller.getTargetColumn().getData();
 398             final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid uuid =
 399                     new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
 400                             .ietf.yang.types.rev130715.Uuid(controller.getUuid().toString());
 401             ControllerEntryBuilder builder = new ControllerEntryBuilder();
 402
 403             if (controller.getMaxBackoffColumn() != null && controller.getMaxBackoffColumn().getData() != null
 404                     && !controller.getMaxBackoffColumn().getData().isEmpty()) {
 405                 builder.setMaxBackoff(Uint32.valueOf(controller.getMaxBackoffColumn().getData().iterator().next()));
 406             }
 407             if (controller.getInactivityProbeColumn() != null && controller.getInactivityProbeColumn().getData() != null
 408                     && !controller.getInactivityProbeColumn().getData().isEmpty()) {
 409                 builder.setInactivityProbe(
 410                     Uint32.valueOf(controller.getInactivityProbeColumn().getData().iterator().next()));
 411             }
 412             controllerEntries.add(builder
 413                     .setTarget(new Uri(targetString))
 414                     .setIsConnected(controller.getIsConnectedColumn().getData())
 415                     .setControllerUuid(uuid).build());
 416         }
 417     }
 418
 419     // This is not called from anywhere but test. Do we need this?
 420     public static Map<UUID, Controller> createOvsdbController(final OvsdbBridgeAugmentation omn,
 421             final DatabaseSchema dbSchema) {
 422         Map<ControllerEntryKey, ControllerEntry> controllerEntries = omn.getControllerEntry();
 423         Map<UUID,Controller> controllerMap = new HashMap<>();
 424         if (controllerEntries != null && !controllerEntries.isEmpty()) {
 425             for (ControllerEntry controllerEntry : controllerEntries.values()) {
 426                 String controllerNamedUuid = "Controller_" + getRandomUuid();
 427                 Controller controller = TypedDatabaseSchema.of(dbSchema).getTypedRowWrapper(Controller.class);
 428                 controller.setTarget(controllerEntry.getTarget().getValue());
 429                 controllerMap.put(new UUID(controllerNamedUuid), controller);
 430             }
 431         }
 432         return controllerMap;
 433     }
 434
 435     public static String getRandomUuid() {
 436         return "Random_" + java.util.UUID.randomUUID().toString().replace("-", "");
 437     }
 438
 439     public static ConnectionInfo createConnectionInfo(final OvsdbClient client) {
 440         ConnectionInfoBuilder connectionInfoBuilder = new ConnectionInfoBuilder();
 441         connectionInfoBuilder.setRemoteIp(createIpAddress(client.getConnectionInfo().getRemoteAddress()));
 442         connectionInfoBuilder.setRemotePort(new PortNumber(Uint16.valueOf(client.getConnectionInfo().getRemotePort())));
 443         connectionInfoBuilder.setLocalIp(createIpAddress(client.getConnectionInfo().getLocalAddress()));
 444         connectionInfoBuilder.setLocalPort(new PortNumber(Uint16.valueOf(client.getConnectionInfo().getLocalPort())));
 445         return connectionInfoBuilder.build();
 446     }
 447
 448     public static ConnectionInfo suppressLocalIpPort(final ConnectionInfo connectionInfo) {
 449         ConnectionInfoBuilder connectionInfoBuilder = new ConnectionInfoBuilder();
 450         connectionInfoBuilder.setRemoteIp(connectionInfo.getRemoteIp());
 451         connectionInfoBuilder.setRemotePort(connectionInfo.getRemotePort());
 452         return connectionInfoBuilder.build();
 453     }
 454
 455     /**
 456      * Create the {@link ManagerEntry} list given an OVSDB {@link OpenVSwitch}
 457      * and {@link Manager} rows.
 458      *
 459      * @param ovsdbNode the {@link OpenVSwitch} to update
 460      * @param updatedManagerRows the list of {@link Manager} managers with updates
 461      * @return list of {@link ManagerEntry} entries
 462      */
 463     public static List<ManagerEntry> createManagerEntries(final OpenVSwitch ovsdbNode,
 464                                                                 final Map<UUID, Manager> updatedManagerRows) {
 465
 466         LOG.debug("createManagerEntries OpenVSwitch: {}\n, updatedManagerRows: {}",
 467                 ovsdbNode, updatedManagerRows);
 468         final Set<UUID> managerUuids = ovsdbNode.getManagerOptionsColumn().getData();
 469         final List<ManagerEntry> managerEntries = new ArrayList<>();
 470         for (UUID managerUuid : managerUuids) {
 471             final Manager manager = updatedManagerRows.get(managerUuid);
 472             addManagerEntries(managerEntries, manager);
 473         }
 474         LOG.debug("managerEntries: {}", managerEntries);
 475         return managerEntries;
 476     }
 477
 478     /**
 479      * Create the {@link ManagerEntry} list given an MDSAL {@link Node} ovsdbNode
 480      * and {@link Manager} rows.
 481      *
 482      * @param ovsdbNode the {@link Node} to update
 483      * @param updatedManagerRows the list of {@link Manager} managers with updates
 484      * @return list of {@link ManagerEntry} entries
 485      */
 486     public static List<ManagerEntry> createManagerEntries(final Node ovsdbNode,
 487                                                                 final Map<Uri, Manager> updatedManagerRows) {
 488
 489         LOG.debug("createManagerEntries based on OVSDB Node: {}\n, updatedManagerRows: {}",
 490                 ovsdbNode, updatedManagerRows);
 491         final List<ManagerEntry> managerEntriesCreated = new ArrayList<>();
 492         final OvsdbNodeAugmentation ovsdbNodeAugmentation =
 493                 ovsdbNode.augmentation(OvsdbNodeAugmentation.class);
 494         if (ovsdbNodeAugmentation == null) {
 495             return managerEntriesCreated;
 496         }
 497
 498         final Map<ManagerEntryKey, ManagerEntry> managerEntries = ovsdbNodeAugmentation.getManagerEntry();
 499         if (managerEntries != null) {
 500             for (ManagerEntry managerEntry : managerEntries.values()) {
 501                 final Manager manager = updatedManagerRows.get(managerEntry.getTarget());
 502                 addManagerEntries(managerEntriesCreated, manager);
 503             }
 504         }
 505         LOG.debug("managerEntries: {}", managerEntriesCreated);
 506         return managerEntriesCreated;
 507     }
 508
 509     /**
 510      * Add the OVSDB {@link Manager} updates to the MDSAL {@link ManagerEntry} list.
 511      *
 512      * @param managerEntries the list of {@link ManagerEntry} to update
 513      * @param manager the updated OVSDB {@link Manager}
 514      */
 515     public static void addManagerEntries(final List<ManagerEntry> managerEntries,
 516                                             final Manager manager) {
 517
 518         if (manager != null && manager.getTargetColumn() != null) {
 519             Uint32 numberOfConnections = Uint32.ZERO;
 520             final String targetString = manager.getTargetColumn().getData();
 521
 522             final Map<String, String> statusAttributeMap =
 523                             manager.getStatusColumn() == null ? null : manager.getStatusColumn().getData();
 524             if (statusAttributeMap != null && statusAttributeMap.containsKey(N_CONNECTIONS_STR)) {
 525                 String numberOfConnectionValueStr = statusAttributeMap.get(N_CONNECTIONS_STR);
 526                 numberOfConnections = Uint32.valueOf(numberOfConnectionValueStr);
 527             } else {
 528                 final boolean isConnected = manager.getIsConnectedColumn().getData();
 529                 if (isConnected) {
 530                     numberOfConnections = Uint32.ONE;
 531                 }
 532             }
 533             managerEntries.add(new ManagerEntryBuilder()
 534                     .setTarget(new Uri(targetString))
 535                     .setNumberOfConnections(numberOfConnections)
 536                     .setConnected(manager.getIsConnectedColumn().getData()).build());
 537         }
 538     }
 539
 540     /**
 541      * Return the MD-SAL QoS type class corresponding to the QoS type {@link Qos}.
 542      *
 543      * @param type the QoS type to match {@link String}
 544      * @return class matching the input QoS type {@link QosTypeBase}
 545      */
 546     public static  Class<? extends QosTypeBase> createQosType(final String type) {
 547         requireNonNull(type);
 548         if (type.isEmpty()) {
 549             LOG.info("QoS type not supplied");
 550             return QosTypeBase.class;
 551         } else {
 552             ImmutableBiMap<String, Class<? extends QosTypeBase>> mapper = QOS_TYPE_MAP.inverse();
 553             if (mapper.get(type) == null) {
 554                 LOG.info("QoS type not found in model: {}", type);
 555                 return QosTypeBase.class;
 556             } else {
 557                 return mapper.get(type);
 558             }
 559         }
 560     }
 561
 562     public static String createQosType(final Class<? extends QosTypeBase> qosTypeClass) {
 563         String qosType = QOS_TYPE_MAP.get(QosTypeBase.class);
 564
 565         if (qosTypeClass != null && !qosTypeClass.equals(QosTypeBase.class)) {
 566             qosType = QOS_TYPE_MAP.get(qosTypeClass);
 567             if (qosType == null) {
 568                 throw new IllegalArgumentException("Unknown QoS type" + qosTypeClass.getName());
 569             }
 570         }
 571         return qosType;
 572     }
 573
 574
 575     public static InstanceIdentifier<Node> getInstanceIdentifier(final InstanceIdentifierCodec instanceIdentifierCodec,
 576             final OpenVSwitch ovs) {
 577         if (ovs.getExternalIdsColumn() != null
 578                 && ovs.getExternalIdsColumn().getData() != null
 579                 && ovs.getExternalIdsColumn().getData().containsKey(SouthboundConstants.IID_EXTERNAL_ID_KEY)) {
 580             String iidString = ovs.getExternalIdsColumn().getData().get(SouthboundConstants.IID_EXTERNAL_ID_KEY);
 581             return (InstanceIdentifier<Node>) instanceIdentifierCodec.bindingDeserializerOrNull(iidString);
 582         } else {
 583             String nodeString = SouthboundConstants.OVSDB_URI_PREFIX + "://" + SouthboundConstants.UUID + "/"
 584                     + ovs.getUuid().toString();
 585             NodeId nodeId = new NodeId(new Uri(nodeString));
 586             NodeKey nodeKey = new NodeKey(nodeId);
 587             return InstanceIdentifier.builder(NetworkTopology.class)
 588                     .child(Topology.class,new TopologyKey(SouthboundConstants.OVSDB_TOPOLOGY_ID))
 589                     .child(Node.class,nodeKey)
 590                     .build();
 591         }
 592     }
 593
 594     public static Map<InstanceIdentifier<?>, DataObject> extractTerminationPointConfigurationChanges(
 595             final Node bridgeNode) {
 596         Map<InstanceIdentifier<?>, DataObject> changes = new HashMap<>();
 597         final InstanceIdentifier<Node> bridgeNodeIid =
 598                 SouthboundMapper.createInstanceIdentifier(bridgeNode.getNodeId());
 599         changes.put(bridgeNodeIid, bridgeNode);
 600
 601         Map<TerminationPointKey, TerminationPoint> terminationPoints = bridgeNode.getTerminationPoint();
 602         if (terminationPoints != null) {
 603             for (TerminationPoint tp : terminationPoints.values()) {
 604                 OvsdbTerminationPointAugmentation ovsdbTerminationPointAugmentation =
 605                         tp.augmentation(OvsdbTerminationPointAugmentation.class);
 606                 if (ovsdbTerminationPointAugmentation != null) {
 607                     final InstanceIdentifier<OvsdbTerminationPointAugmentation> tpIid =
 608                             bridgeNodeIid
 609                                     .child(TerminationPoint.class, new TerminationPointKey(tp.getTpId()))
 610                                     .builder()
 611                                     .augmentation(OvsdbTerminationPointAugmentation.class)
 612                                     .build();
 613                     changes.put(tpIid, ovsdbTerminationPointAugmentation);
 614                 }
 615             }
 616         }
 617         return changes;
 618     }
 619 }