interfacemanager/interfacemanager-impl/src/main/java/org/opendaylight/genius/interfacemanager/renderer/ovs/utilities/SouthboundUtils.java

   1 /*
   2  * Copyright (c) 2016, 2017 Ericsson India Global Services Pvt Ltd. 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.genius.interfacemanager.renderer.ovs.utilities;
   9
  10 import com.google.common.collect.ImmutableMap;
  11 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  12 import java.util.ArrayList;
  13 import java.util.HashMap;
  14 import java.util.List;
  15 import java.util.Locale;
  16 import java.util.Map;
  17 import java.util.UUID;
  18 import javax.inject.Inject;
  19 import javax.inject.Singleton;
  20 import org.apache.aries.blueprint.annotation.service.Reference;
  21 import org.apache.commons.lang3.BooleanUtils;
  22 import org.eclipse.jdt.annotation.Nullable;
  23 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
  24 import org.opendaylight.genius.interfacemanager.InterfacemgrProvider;
  25 import org.opendaylight.genius.interfacemanager.commons.InterfaceManagerCommonUtils;
  26 import org.opendaylight.genius.interfacemanager.globals.IfmConstants;
  27 import org.opendaylight.infrautils.caches.Cache;
  28 import org.opendaylight.infrautils.caches.CacheConfigBuilder;
  29 import org.opendaylight.infrautils.caches.CachePolicyBuilder;
  30 import org.opendaylight.infrautils.caches.CacheProvider;
  31 import org.opendaylight.mdsal.binding.api.DataBroker;
  32 import org.opendaylight.mdsal.binding.util.Datastore.Configuration;
  33 import org.opendaylight.mdsal.binding.util.TypedWriteTransaction;
  34 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  35 import org.opendaylight.mdsal.common.api.ReadFailedException;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.BridgeEntry;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.bridge.entry.BridgeInterfaceEntry;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.bridge.entry.BridgeInterfaceEntryKey;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfTunnel;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelMonitoringTypeBfd;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeBase;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeGre;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeMplsOverGre;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeVxlan;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeVxlanGpe;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.tunnel.optional.params.TunnelOptions;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeBase;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeGre;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeVxlan;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbPortInterfaceAttributes;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentationBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfd;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfdBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfdKey;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.Options;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.OptionsBuilder;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.OptionsKey;
  66 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  67 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  68 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId;
  69 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  70 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  71 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  72 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  73 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  74 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointBuilder;
  75 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointKey;
  76 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  77 import org.opendaylight.yangtools.yang.common.Uint64;
  78 import org.slf4j.Logger;
  79 import org.slf4j.LoggerFactory;
  80
  81 @Singleton
  82 public class SouthboundUtils {
  83     private static final Logger LOG = LoggerFactory.getLogger(SouthboundUtils.class);
  84     private static final Logger EVENT_LOGGER = LoggerFactory.getLogger("GeniusEventLogger");
  85
  86     private static final String BFD_PARAM_ENABLE = "enable";
  87     private static final String BFD_PARAM_MIN_TX = "min_tx";
  88     private static final String BFD_PARAM_FORWARDING_IF_RX = "forwarding_if_rx";
  89
  90     // BFD parameters
  91     public static final String BFD_ENABLE_KEY = "enable";
  92     public static final String BFD_ENABLE_VALUE = "true";
  93     public static final String BFD_OP_STATE = "state";
  94     public static final String BFD_STATE_UP = "up";
  95     private static final String BFD_MIN_TX_VAL = "100";
  96     private static final String BFD_FORWARDING_IF_RX_VAL = "true";
  97
  98     // Tunnel options
  99     private static final String TUNNEL_OPTIONS_KEY = "key";
 100     private static final String TUNNEL_OPTIONS_LOCAL_IP = "local_ip";
 101     private static final String TUNNEL_OPTIONS_REMOTE_IP = "remote_ip";
 102     private static final String TUNNEL_OPTIONS_DESTINATION_PORT = "dst_port";
 103
 104     // Option values for VxLAN-GPE + NSH tunnels
 105     private static final String TUNNEL_OPTIONS_EXTS = "exts";
 106     private static final String TUNNEL_OPTIONS_NSI = "nsi";
 107     private static final String TUNNEL_OPTIONS_NSP = "nsp";
 108     private static final String TUNNEL_OPTIONS_NSHC1 = "nshc1";
 109     private static final String TUNNEL_OPTIONS_NSHC2 = "nshc2";
 110     private static final String TUNNEL_OPTIONS_NSHC3 = "nshc3";
 111     private static final String TUNNEL_OPTIONS_NSHC4 = "nshc4";
 112
 113     // Tunnel options for MPLS-GRE tunnels [requires OVS 2.8+)
 114     private static final String TUNNEL_OPTIONS_PKT_TYPE = "packet_type";
 115
 116     // Option values for VxLAN-GPE + NSH tunnels
 117     private static final String TUNNEL_OPTIONS_VALUE_FLOW = "flow";
 118     private static final String TUNNEL_OPTIONS_VALUE_GPE = "gpe";
 119     // UDP port for VxLAN-GPE Tunnels
 120     private static final String TUNNEL_OPTIONS_VALUE_GPE_DESTINATION_PORT = "4880";
 121
 122     // Tunnel option values for MPLS-GRE tunnels [requires OVS 2.8+)
 123     private static final String TUNNEL_OPTIONS_VALUE_LEGACY_L3 = "legacy_l3";
 124
 125     // To keep the mapping between Tunnel Types and Tunnel Interfaces
 126     private static final Map<Class<? extends TunnelTypeBase>, Class<? extends InterfaceTypeBase>> TUNNEL_TYPE_MAP =
 127             ImmutableMap.of(
 128                     TunnelTypeGre.class, InterfaceTypeGre.class,
 129                     TunnelTypeMplsOverGre.class, InterfaceTypeGre.class,
 130                     TunnelTypeVxlan.class, InterfaceTypeVxlan.class,
 131                     TunnelTypeVxlanGpe.class, InterfaceTypeVxlan.class);
 132
 133     // OVS Detection statics
 134     private static final String DEFAULT_OVS_VERSION = "2.8.0";
 135     private static final String MIN_GRE_VERSION = "2.8.0";
 136     private static final long MAX_CACHE_SIZE = 1024;
 137
 138     private final SingleTransactionDataBroker singleTxDB;
 139
 140     private final BatchingUtils batchingUtils;
 141     private final InterfacemgrProvider interfacemgrProvider;
 142     private final Cache<String, String> ovsVersionCache;
 143
 144     @Inject
 145     public SouthboundUtils(@Reference final DataBroker dataBroker,
 146                            final BatchingUtils batchingUtils, InterfacemgrProvider interfacemgrProvider,
 147                            @Reference final CacheProvider cacheProvider) {
 148         this.batchingUtils = batchingUtils;
 149         this.interfacemgrProvider = interfacemgrProvider;
 150         this.singleTxDB = new SingleTransactionDataBroker(dataBroker);
 151         ovsVersionCache = cacheProvider.newCache(
 152                 new CacheConfigBuilder<String, String>()
 153                         .anchor(this)
 154                         .id("ovsVersionCache")
 155                         .cacheFunction(this::getVersionForBridgeNodeId)
 156                         .description("BridgeNodeId to OVS Version cache")
 157                         .build(),
 158                 new CachePolicyBuilder().maxEntries(MAX_CACHE_SIZE).build());
 159     }
 160
 161     public void addPortToBridge(InstanceIdentifier<?> bridgeIid, Interface iface, String portName) {
 162         IfTunnel ifTunnel = iface.augmentation(IfTunnel.class);
 163         if (ifTunnel != null) {
 164             addTunnelPortToBridge(ifTunnel, bridgeIid, iface, portName);
 165         }
 166     }
 167
 168     /*
 169      * Add all tunnels ports corresponding to the bridge to the topology config DS.
 170      */
 171     public void addAllPortsToBridge(BridgeEntry bridgeEntry, InterfaceManagerCommonUtils interfaceManagerCommonUtils,
 172                                     InstanceIdentifier<OvsdbBridgeAugmentation> bridgeIid,
 173                                     OvsdbBridgeAugmentation bridgeNew) {
 174         String bridgeName = bridgeNew.getBridgeName().getValue();
 175         LOG.debug("adding all ports to bridge: {}", bridgeName);
 176         @Nullable Map<BridgeInterfaceEntryKey, BridgeInterfaceEntry> bridgeInterfaceEntries =
 177                 bridgeEntry.getBridgeInterfaceEntry();
 178         if (bridgeInterfaceEntries != null) {
 179             for (BridgeInterfaceEntry bridgeInterfaceEntry : bridgeInterfaceEntries.values()) {
 180                 String portName = bridgeInterfaceEntry.getInterfaceName();
 181                 InterfaceKey interfaceKey = new InterfaceKey(portName);
 182                 Interface iface = interfaceManagerCommonUtils.getInterfaceFromConfigDS(interfaceKey);
 183                 if (iface != null) {
 184                     IfTunnel ifTunnel = iface.augmentation(IfTunnel.class);
 185                     if (ifTunnel != null) {
 186                         if (!interfacemgrProvider.isItmDirectTunnelsEnabled() || !ifTunnel.isInternal()) {
 187                             addTunnelPortToBridge(ifTunnel, bridgeIid, iface, portName);
 188                         }
 189                         if (isOfTunnel(ifTunnel)) {
 190                             LOG.debug("Using OFTunnel. Only one tunnel port will be added");
 191                             return;
 192                         }
 193                     }
 194                 } else {
 195                     LOG.debug("Interface {} not found in config DS", portName);
 196                 }
 197             }
 198         }
 199     }
 200
 201     private void addTunnelPortToBridge(IfTunnel ifTunnel, InstanceIdentifier<?> bridgeIid, Interface iface,
 202             String portName) {
 203         LOG.debug("adding tunnel port {} to bridge {}", portName, bridgeIid);
 204         EVENT_LOGGER.debug("IFM-OvsInterfaceConfig,ADD Tunnelport {} Bridgeid {}", portName, bridgeIid);
 205         Class<? extends InterfaceTypeBase> type = TUNNEL_TYPE_MAP.get(ifTunnel.getTunnelInterfaceType());
 206
 207         if (type == null) {
 208             LOG.warn("Unknown Tunnel Type obtained while creating interface: {}", iface);
 209             return;
 210         }
 211
 212         int vlanId = 0;
 213         IfL2vlan ifL2vlan = iface.augmentation(IfL2vlan.class);
 214         if (ifL2vlan != null && ifL2vlan.getVlanId() != null) {
 215             vlanId = ifL2vlan.getVlanId().getValue().toJava();
 216         }
 217
 218         Map<String, String> options = new HashMap<>();
 219
 220         // Options common to any kind of tunnel
 221         if (BooleanUtils.isTrue(ifTunnel.isTunnelSourceIpFlow())) {
 222             options.put(TUNNEL_OPTIONS_LOCAL_IP, TUNNEL_OPTIONS_VALUE_FLOW);
 223         } else {
 224             IpAddress localIp = ifTunnel.getTunnelSource();
 225             options.put(TUNNEL_OPTIONS_LOCAL_IP, localIp.stringValue());
 226         }
 227         if (BooleanUtils.isTrue(ifTunnel.isTunnelRemoteIpFlow())) {
 228             options.put(TUNNEL_OPTIONS_REMOTE_IP, TUNNEL_OPTIONS_VALUE_FLOW);
 229         } else {
 230             IpAddress remoteIp = ifTunnel.getTunnelDestination();
 231             options.put(TUNNEL_OPTIONS_REMOTE_IP, remoteIp.stringValue());
 232         }
 233         // Specific options for each type of tunnel
 234         if (TunnelTypeMplsOverGre.class.equals(ifTunnel.getTunnelInterfaceType())) {
 235             String switchVersion = getSwitchVersion((InstanceIdentifier<Node>) bridgeIid);
 236             LOG.debug("Switch OVS Version: {}", switchVersion);
 237             if (org.opendaylight.ovsdb.utils.southbound.utils.SouthboundUtils.compareDbVersionToMinVersion(
 238                     switchVersion, MIN_GRE_VERSION)) {
 239                 options.put(TUNNEL_OPTIONS_PKT_TYPE, TUNNEL_OPTIONS_VALUE_LEGACY_L3);
 240             } else {
 241                 LOG.warn("{} OVS version {} less than {} required for MplsOverGre",
 242                         bridgeIid.firstKeyOf(Node.class).getNodeId().getValue(),
 243                         switchVersion, MIN_GRE_VERSION);
 244                 return;
 245             }
 246         } else {
 247             options.put(TUNNEL_OPTIONS_KEY, TUNNEL_OPTIONS_VALUE_FLOW);
 248         }
 249         if (ifTunnel.getTunnelInterfaceType().equals(TunnelTypeVxlanGpe.class)) {
 250             options.put(TUNNEL_OPTIONS_EXTS, TUNNEL_OPTIONS_VALUE_GPE);
 251             options.put(TUNNEL_OPTIONS_NSI, TUNNEL_OPTIONS_VALUE_FLOW);
 252             options.put(TUNNEL_OPTIONS_NSP, TUNNEL_OPTIONS_VALUE_FLOW);
 253             options.put(TUNNEL_OPTIONS_NSHC1, TUNNEL_OPTIONS_VALUE_FLOW);
 254             options.put(TUNNEL_OPTIONS_NSHC2, TUNNEL_OPTIONS_VALUE_FLOW);
 255             options.put(TUNNEL_OPTIONS_NSHC3, TUNNEL_OPTIONS_VALUE_FLOW);
 256             options.put(TUNNEL_OPTIONS_NSHC4, TUNNEL_OPTIONS_VALUE_FLOW);
 257             // VxLAN-GPE interfaces will not use the default UDP port to avoid
 258             // problems with other meshes
 259             options.put(TUNNEL_OPTIONS_DESTINATION_PORT, TUNNEL_OPTIONS_VALUE_GPE_DESTINATION_PORT);
 260         }
 261
 262         if (ifTunnel.getTunnelOptions() != null) {
 263             for (TunnelOptions tunOpt : ifTunnel.getTunnelOptions().values()) {
 264                 options.putIfAbsent(tunOpt.getTunnelOption(), tunOpt.getValue());
 265             }
 266         }
 267
 268         addTerminationPoint(bridgeIid, portName, vlanId, type, options, ifTunnel);
 269     }
 270
 271     // Update is allowed only for tunnel monitoring attributes
 272     public static void updateBfdParamtersForTerminationPoint(InstanceIdentifier<?> bridgeIid, IfTunnel ifTunnel,
 273             String portName, TypedWriteTransaction<Configuration> transaction) {
 274         InstanceIdentifier<TerminationPoint> tpIid = createTerminationPointInstanceIdentifier(
 275                 InstanceIdentifier.keyOf(bridgeIid.firstIdentifierOf(Node.class)), portName);
 276         if (isOfTunnel(ifTunnel)) {
 277             LOG.warn("BFD monitoring not supported for OFTunnels. Skipping BFD parameters for {}", portName);
 278             return;
 279         }
 280         LOG.debug("update bfd parameters for interface {}", tpIid);
 281         OvsdbTerminationPointAugmentationBuilder tpAugmentationBuilder = new OvsdbTerminationPointAugmentationBuilder();
 282         tpAugmentationBuilder.setInterfaceBfd(getBfdParams(ifTunnel));
 283
 284         TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
 285         tpBuilder.withKey(InstanceIdentifier.keyOf(tpIid));
 286         tpBuilder.addAugmentation(tpAugmentationBuilder.build());
 287
 288         transaction.mergeParentStructureMerge(tpIid, tpBuilder.build());
 289     }
 290
 291     private void addTerminationPoint(InstanceIdentifier<?> bridgeIid, String portName, int vlanId,
 292             Class<? extends InterfaceTypeBase> type, Map<String, String> options, IfTunnel ifTunnel) {
 293         OvsdbTerminationPointAugmentationBuilder tpAugmentationBuilder = new OvsdbTerminationPointAugmentationBuilder();
 294
 295         tpAugmentationBuilder.setName(portName);
 296
 297         if (type != null) {
 298             tpAugmentationBuilder.setInterfaceType(type);
 299         }
 300
 301         if (options != null) {
 302             List<Options> optionsList = new ArrayList<>();
 303             for (Map.Entry<String, String> entry : options.entrySet()) {
 304                 OptionsBuilder optionsBuilder = new OptionsBuilder();
 305                 optionsBuilder.withKey(new OptionsKey(entry.getKey()));
 306                 optionsBuilder.setOption(entry.getKey());
 307                 optionsBuilder.setValue(entry.getValue());
 308                 optionsList.add(optionsBuilder.build());
 309             }
 310             tpAugmentationBuilder.setOptions(optionsList);
 311         }
 312
 313         if (vlanId != 0) {
 314             tpAugmentationBuilder.setVlanMode(OvsdbPortInterfaceAttributes.VlanMode.Access);
 315             tpAugmentationBuilder.setVlanTag(new VlanId(vlanId));
 316         }
 317         if (isOfTunnel(ifTunnel)) {
 318             LOG.warn("BFD Monitoring not supported for OFTunnels");
 319         } else {
 320             tpAugmentationBuilder.setInterfaceBfd(getBfdParams(ifTunnel));
 321         }
 322         TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
 323         InstanceIdentifier<TerminationPoint> tpIid = createTerminationPointInstanceIdentifier(
 324                 InstanceIdentifier.keyOf(bridgeIid.firstIdentifierOf(Node.class)), portName);
 325         tpBuilder.withKey(InstanceIdentifier.keyOf(tpIid));
 326         tpBuilder.addAugmentation(tpAugmentationBuilder.build());
 327
 328         batchingUtils.write(tpIid, tpBuilder.build(), BatchingUtils.EntityType.TOPOLOGY_CONFIG);
 329     }
 330
 331     private static List<InterfaceBfd> getBfdParams(IfTunnel ifTunnel) {
 332         List<InterfaceBfd> bfdParams = new ArrayList<>();
 333         bfdParams.add(
 334                 getIfBfdObj(BFD_PARAM_ENABLE, ifTunnel != null ? ifTunnel.isMonitorEnabled().toString() : "false"));
 335         bfdParams.add(getIfBfdObj(BFD_PARAM_MIN_TX,
 336                 ifTunnel != null && ifTunnel.getMonitorInterval() != null ? ifTunnel.getMonitorInterval().toString()
 337                         : BFD_MIN_TX_VAL));
 338         bfdParams.add(getIfBfdObj(BFD_PARAM_FORWARDING_IF_RX, BFD_FORWARDING_IF_RX_VAL));
 339         return bfdParams;
 340     }
 341
 342     private static InterfaceBfd getIfBfdObj(String key, String value) {
 343         InterfaceBfdBuilder bfdBuilder = new InterfaceBfdBuilder();
 344         bfdBuilder.setBfdKey(key).withKey(new InterfaceBfdKey(key)).setBfdValue(value);
 345         return bfdBuilder.build();
 346     }
 347
 348     private String getSwitchVersion(InstanceIdentifier<Node> bridgeIid) {
 349         String ovsNodeId = bridgeIid.firstKeyOf(Node.class).getNodeId().getValue().split("/bridge")[0];
 350         return ovsVersionCache.get(ovsNodeId);
 351     }
 352
 353     private String getVersionForBridgeNodeId(String ovsNodeId) {
 354         InstanceIdentifier<Node> ovsNodeIid = InstanceIdentifier.create(NetworkTopology.class)
 355                 .child(Topology.class, new TopologyKey(IfmConstants.OVSDB_TOPOLOGY_ID))
 356                 .child(Node.class, new NodeKey(new NodeId(ovsNodeId)));
 357         String ovsVersion = DEFAULT_OVS_VERSION;
 358         try {
 359             Node ovsNode = singleTxDB.syncRead(LogicalDatastoreType.OPERATIONAL, ovsNodeIid);
 360             ovsVersion = ovsNode.augmentation(OvsdbNodeAugmentation.class).getOvsVersion()
 361                     .toLowerCase(Locale.ROOT);
 362         } catch (ReadFailedException e) {
 363             LOG.error("OVS Node {} not present", ovsNodeId);
 364         }
 365         return ovsVersion;
 366     }
 367
 368     public static InstanceIdentifier<TerminationPoint> createTerminationPointInstanceIdentifier(NodeKey nodekey,
 369             String portName) {
 370         InstanceIdentifier<TerminationPoint> terminationPointPath = InstanceIdentifier.create(NetworkTopology.class)
 371                 .child(Topology.class, new TopologyKey(IfmConstants.OVSDB_TOPOLOGY_ID)).child(Node.class, nodekey)
 372                 .child(TerminationPoint.class, new TerminationPointKey(new TpId(portName)));
 373
 374         LOG.debug("Termination point InstanceIdentifier generated : {}", terminationPointPath);
 375         return terminationPointPath;
 376     }
 377
 378     public void removeTerminationEndPoint(InstanceIdentifier<?> bridgeIid, String interfaceName) {
 379         LOG.debug("removing termination point for {}", interfaceName);
 380         InstanceIdentifier<TerminationPoint> tpIid = SouthboundUtils.createTerminationPointInstanceIdentifier(
 381                 InstanceIdentifier.keyOf(bridgeIid.firstIdentifierOf(Node.class)), interfaceName);
 382         batchingUtils.delete(tpIid, BatchingUtils.EntityType.TOPOLOGY_CONFIG);
 383     }
 384
 385     public static boolean ifBfdStatusNotEqual(OvsdbTerminationPointAugmentation tpOld,
 386                                            OvsdbTerminationPointAugmentation tpNew) {
 387         return tpNew.getInterfaceBfdStatus() != null
 388                 && (tpOld == null || !tpNew.getInterfaceBfdStatus().equals(tpOld.getInterfaceBfdStatus()));
 389     }
 390
 391     public static boolean changeInBfdMonitoringDetected(OvsdbTerminationPointAugmentation tpOld,
 392                                                         OvsdbTerminationPointAugmentation tpNew) {
 393         if (tpOld != null) {
 394             return org.opendaylight.genius.interfacemanager.renderer.ovs.utilities.SouthboundUtils
 395                     .bfdMonitoringEnabled(tpNew.getInterfaceBfd())
 396                     != org.opendaylight.genius.interfacemanager.renderer.ovs.utilities.SouthboundUtils
 397                     .bfdMonitoringEnabled(tpOld.getInterfaceBfd());
 398         }
 399         return false;
 400     }
 401
 402     public static boolean bfdMonitoringEnabled(IfTunnel ifTunnel) {
 403         return ifTunnel.isMonitorEnabled()
 404                 && TunnelMonitoringTypeBfd.class.isAssignableFrom(ifTunnel.getMonitorProtocol());
 405     }
 406
 407     public static boolean bfdMonitoringEnabled(Map<InterfaceBfdKey, InterfaceBfd> interfaceBfds) {
 408         if (interfaceBfds == null) {
 409             return false;
 410         }
 411         for (InterfaceBfd interfaceBfd : interfaceBfds.values()) {
 412             if (SouthboundUtils.BFD_ENABLE_KEY.equalsIgnoreCase(interfaceBfd.getBfdKey())) {
 413                 return SouthboundUtils.BFD_ENABLE_VALUE.equalsIgnoreCase(interfaceBfd.getBfdValue());//checkBfdEnabled
 414             }
 415         }
 416         return false;
 417     }
 418
 419     public static boolean isMonitorProtocolBfd(IfTunnel ifTunnel) {
 420         return TunnelMonitoringTypeBfd.class.isAssignableFrom(ifTunnel.getMonitorProtocol());
 421     }
 422
 423     @SuppressFBWarnings("DM_DEFAULT_ENCODING")
 424     public static String generateOfTunnelName(Uint64 dpId, IfTunnel ifTunnel) {
 425         final String sourceKey;
 426         if (ifTunnel.isTunnelSourceIpFlow() != null) {
 427             sourceKey = "flow";
 428         } else {
 429             sourceKey = ifTunnel.getTunnelSource().stringValue();
 430         }
 431         final String remoteKey;
 432         if (ifTunnel.isTunnelRemoteIpFlow() != null) {
 433             remoteKey = "flow";
 434         } else {
 435             remoteKey = ifTunnel.getTunnelDestination().stringValue();
 436         }
 437         String tunnelNameKey = dpId.toString() + sourceKey + remoteKey;
 438         String uuidStr = UUID.nameUUIDFromBytes(tunnelNameKey.getBytes()).toString().substring(0, 12).replace("-", "");
 439         return "tun" + uuidStr;
 440     }
 441
 442     public static boolean isOfTunnel(IfTunnel ifTunnel) {
 443         return Boolean.TRUE.equals(ifTunnel.isTunnelRemoteIpFlow())
 444                 || Boolean.TRUE.equals(ifTunnel.isTunnelSourceIpFlow());
 445     }
 446
 447     public static boolean isInterfaceTypeTunnel(Class<? extends InterfaceTypeBase> interfaceType) {
 448         return InterfaceTypeGre.class.equals(interfaceType) || InterfaceTypeVxlan.class.equals(interfaceType);
 449     }
 450
 451 }