itm/itm-impl/src/main/java/org/opendaylight/genius/itm/itmdirecttunnels/renderer/ovs/utilities/DirectTunnelUtils.java

   1 /*
   2  * Copyright (c) 2018 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.itm.itmdirecttunnels.renderer.ovs.utilities;
   9
  10 import com.google.common.collect.ImmutableMap;
  11 import com.google.common.collect.ImmutableMap.Builder;
  12 import com.google.common.util.concurrent.ListenableFuture;
  13 import edu.umd.cs.findbugs.annotations.CheckReturnValue;
  14 import java.nio.charset.StandardCharsets;
  15 import java.util.ArrayList;
  16 import java.util.Collections;
  17 import java.util.List;
  18 import java.util.Map;
  19 import java.util.Optional;
  20 import java.util.UUID;
  21 import java.util.concurrent.ExecutionException;
  22 import java.util.function.Predicate;
  23 import java.util.regex.Pattern;
  24 import javax.inject.Inject;
  25 import javax.inject.Singleton;
  26 import org.eclipse.jdt.annotation.NonNull;
  27 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
  28 import org.opendaylight.genius.interfacemanager.globals.IfmConstants;
  29 import org.opendaylight.genius.itm.globals.ITMConstants;
  30 import org.opendaylight.genius.itm.impl.ITMBatchingUtils;
  31 import org.opendaylight.genius.itm.impl.ItmUtils;
  32 import org.opendaylight.genius.mdsalutil.ActionInfo;
  33 import org.opendaylight.genius.mdsalutil.FlowEntity;
  34 import org.opendaylight.genius.mdsalutil.InstructionInfo;
  35 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  36 import org.opendaylight.genius.mdsalutil.MatchInfoBase;
  37 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
  38 import org.opendaylight.genius.mdsalutil.NwConstants;
  39 import org.opendaylight.genius.mdsalutil.actions.ActionOutput;
  40 import org.opendaylight.genius.mdsalutil.actions.ActionSetTunnelDestinationIp;
  41 import org.opendaylight.genius.mdsalutil.instructions.InstructionGotoTable;
  42 import org.opendaylight.genius.mdsalutil.instructions.InstructionWriteMetadata;
  43 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  44 import org.opendaylight.genius.mdsalutil.matches.MatchInPort;
  45 import org.opendaylight.genius.mdsalutil.nxmatches.NxMatchRegister;
  46 import org.opendaylight.genius.mdsalutil.nxmatches.NxMatchTunnelSourceIp;
  47 import org.opendaylight.genius.utils.clustering.EntityOwnershipUtils;
  48 import org.opendaylight.infrautils.utils.concurrent.NamedLocks;
  49 import org.opendaylight.infrautils.utils.concurrent.NamedSimpleReentrantLock.Acquired;
  50 import org.opendaylight.mdsal.binding.api.DataBroker;
  51 import org.opendaylight.mdsal.binding.util.Datastore.Configuration;
  52 import org.opendaylight.mdsal.binding.util.TypedReadWriteTransaction;
  53 import org.opendaylight.mdsal.binding.util.TypedWriteTransaction;
  54 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  55 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
  56 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInput;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInputBuilder;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutput;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdOutput;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfTunnel;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelMonitoringTypeBfd;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeBase;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeGre;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeVxlan;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeVxlanGpe;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.ItmConfig;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.meta.rev171210.BridgeTunnelInfo;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.meta.rev171210.IfIndexesTunnelMap;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.meta.rev171210.OvsBridgeRefInfo;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.meta.rev171210._if.indexes.tunnel.map.IfIndexTunnel;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.meta.rev171210._if.indexes.tunnel.map.IfIndexTunnelKey;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.meta.rev171210.bridge.tunnel.info.OvsBridgeEntry;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.meta.rev171210.bridge.tunnel.info.OvsBridgeEntryKey;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.meta.rev171210.bridge.tunnel.info.ovs.bridge.entry.OvsBridgeTunnelEntry;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.meta.rev171210.bridge.tunnel.info.ovs.bridge.entry.OvsBridgeTunnelEntryBuilder;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.meta.rev171210.bridge.tunnel.info.ovs.bridge.entry.OvsBridgeTunnelEntryKey;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.meta.rev171210.ovs.bridge.ref.info.OvsBridgeRefEntry;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.meta.rev171210.ovs.bridge.ref.info.OvsBridgeRefEntryKey;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.DpnTepConfig;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.DpnTepsState;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.TunnelOperStatus;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.tep.config.OfDpnTep;
  93 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.tep.config.OfDpnTepKey;
  94 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.teps.state.DpnsTeps;
  95 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.teps.state.DpnsTepsKey;
  96 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.teps.state.dpns.teps.RemoteDpns;
  97 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.of.teps.state.OfTep;
  98 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.of.teps.state.OfTepKey;
  99 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnels_state.StateTunnelList;
 100 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnels_state.StateTunnelListKey;
 101 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
 102 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
 103 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.NxmNxReg6;
 104 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathId;
 105 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeBase;
 106 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeGre;
 107 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeVxlan;
 108 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
 109 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbPortInterfaceAttributes;
 110 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
 111 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentationBuilder;
 112 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfd;
 113 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfdBuilder;
 114 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfdKey;
 115 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.Options;
 116 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.OptionsBuilder;
 117 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.OptionsKey;
 118 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
 119 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
 120 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId;
 121 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
 122 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
 123 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
 124 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointBuilder;
 125 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointKey;
 126 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 127 import org.opendaylight.yangtools.yang.common.OperationFailedException;
 128 import org.opendaylight.yangtools.yang.common.RpcError;
 129 import org.opendaylight.yangtools.yang.common.RpcResult;
 130 import org.opendaylight.yangtools.yang.common.Uint64;
 131 import org.slf4j.Logger;
 132 import org.slf4j.LoggerFactory;
 133
 134 @Singleton
 135 public final class DirectTunnelUtils {
 136
 137     private static final Logger LOG = LoggerFactory.getLogger(DirectTunnelUtils.class);
 138
 139     private static final String BFD_PARAM_ENABLE = "enable";
 140     private static final String BFD_PARAM_MIN_TX = "min_tx";
 141     private static final String BFD_PARAM_FORWARDING_IF_RX = "forwarding_if_rx";
 142     private static final String BFD_PARAM_REMOTE_DST_MAC = "bfd_remote_dst_mac";
 143     private static final String BFD_PARAM_LOCAL_SRC_MAC = "bfd_local_src_mac";
 144     private static final String BFD_PARAM_LOCAL_DST_MAC = "bfd_local_dst_mac";
 145     // BFD parameters
 146     private static final String BFD_ENABLE_KEY = "enable";
 147     private static final String BFD_ENABLE_VALUE = "true";
 148     public static final String BFD_OP_STATE = "state";
 149     public static final String BFD_STATE_UP = "up";
 150     private static final String BFD_MIN_TX_VAL = "100";
 151     private static final String BFD_FORWARDING_IF_RX_VAL = "true";
 152     private static final String BFD_REMOTE_DST_MAC_VAL = "de:ad:be:ef:00:00";
 153     private static final String BFD_LOCAL_SRC_MAC_VAL = "de:ad:be:ef:00:01";
 154     private static final String BFD_LOCAL_DST_MAC_VAL = "de:ad:be:ef:00:00";
 155
 156     // Tunnel options
 157     public static final String TUNNEL_OPTIONS_KEY = "key";
 158     public static final String TUNNEL_OPTIONS_LOCAL_IP = "local_ip";
 159     public static final String TUNNEL_OPTIONS_REMOTE_IP = "remote_ip";
 160     public static final String TUNNEL_OPTIONS_DESTINATION_PORT = "dst_port";
 161     public static final String TUNNEL_OPTIONS_TOS = "tos";
 162
 163     // Option values for VxLAN-GPE + NSH tunnels
 164     public static final String TUNNEL_OPTIONS_EXTS = "exts";
 165     public static final String TUNNEL_OPTIONS_NSI = "nsi";
 166     public static final String TUNNEL_OPTIONS_NSP = "nsp";
 167     public static final String TUNNEL_OPTIONS_NSHC1 = "nshc1";
 168     public static final String TUNNEL_OPTIONS_NSHC2 = "nshc2";
 169     public static final String TUNNEL_OPTIONS_NSHC3 = "nshc3";
 170     public static final String TUNNEL_OPTIONS_NSHC4 = "nshc4";
 171
 172     // Option values for VxLAN-GPE + NSH tunnels
 173     public static final String TUNNEL_OPTIONS_VALUE_FLOW = "flow";
 174     public static final String TUNNEL_OPTIONS_VALUE_GPE = "gpe";
 175     // UDP port for VxLAN-GPE Tunnels
 176     public static final String TUNNEL_OPTIONS_VALUE_GPE_DESTINATION_PORT = "4880";
 177
 178     //tos option value for tunnels
 179     public static final String TUNNEL_OPTIONS_TOS_VALUE_INHERIT = "inherit";
 180
 181     private static final TopologyId OVSDB_TOPOLOGY_ID = new TopologyId(new Uri("ovsdb:1"));
 182
 183     private static final long INVALID_ID = 0;
 184     private final NamedLocks<String> tunnelLocks = new NamedLocks<>();
 185
 186     // To keep the mapping between Tunnel Types and Tunnel Interfaces
 187
 188     public static final ImmutableMap<Class<? extends TunnelTypeBase>,
 189             Class<? extends InterfaceTypeBase>> TUNNEL_TYPE_MAP = new ImmutableMap
 190             .Builder<Class<? extends TunnelTypeBase>, Class<? extends InterfaceTypeBase>>()
 191             .put(TunnelTypeGre.class, InterfaceTypeGre.class)
 192             .put(TunnelTypeVxlan.class, InterfaceTypeVxlan.class)
 193             .put(TunnelTypeVxlanGpe.class, InterfaceTypeVxlan.class).build();
 194
 195     private static final String TUNNEL_PORT_REGEX = "tun[0-9a-f]{11}";
 196     private static final Pattern TUNNEL_PORT_PATTERN = Pattern.compile(TUNNEL_PORT_REGEX);
 197     public  static final Predicate<String> TUNNEL_PORT_PREDICATE =
 198         portName -> TUNNEL_PORT_PATTERN.matcher(portName).matches();
 199
 200     private final IdManagerService idManagerService;
 201     private final IMdsalApiManager mdsalApiManager;
 202     private final EntityOwnershipUtils entityOwnershipUtils;
 203     private final ItmConfig itmConfig;
 204
 205     @Inject
 206     public DirectTunnelUtils(final IdManagerService idManagerService, final IMdsalApiManager mdsalApiManager,
 207                              final EntityOwnershipUtils entityOwnershipUtils, final ItmConfig itmConfig) {
 208         this.idManagerService = idManagerService;
 209         this.mdsalApiManager = mdsalApiManager;
 210         this.entityOwnershipUtils = entityOwnershipUtils;
 211         this.itmConfig = itmConfig;
 212     }
 213
 214     @CheckReturnValue
 215     public @NonNull Acquired lockTunnel(String tunnelName) {
 216         return tunnelLocks.acquire(tunnelName);
 217     }
 218
 219     public Uint64 getDpnId(DatapathId datapathId) {
 220         if (datapathId != null) {
 221             String dpIdStr = datapathId.getValue().replace(":", "");
 222             return Uint64.valueOf(dpIdStr, 16);
 223         }
 224         return null;
 225     }
 226
 227     public static Uint64 getDpnFromNodeConnectorId(NodeConnectorId portId) {
 228         /*
 229          * NodeConnectorId is of form 'openflow:dpnid:portnum'
 230          */
 231         return Uint64.valueOf(portId.getValue().split(ITMConstants.OF_URI_SEPARATOR)[1]);
 232     }
 233
 234     public static long getPortNumberFromNodeConnectorId(NodeConnectorId portId) {
 235         String portNo = getPortNoFromNodeConnectorId(portId);
 236         try {
 237             return Long.parseLong(portNo);
 238         } catch (NumberFormatException ex) {
 239             LOG.error("Unable to retrieve port number from nodeconnector id for {} ", portId, ex);
 240             return ITMConstants.INVALID_PORT_NO;
 241         }
 242     }
 243
 244     private static String getPortNoFromNodeConnectorId(NodeConnectorId portId) {
 245         /*
 246          * NodeConnectorId is of form 'openflow:dpnid:portnum'
 247          */
 248         return portId.getValue().split(ITMConstants.OF_URI_SEPARATOR)[2];
 249     }
 250
 251     // Convert Interface Oper State to Tunnel Oper state
 252     public static TunnelOperStatus convertInterfaceToTunnelOperState(Interface.OperStatus opState) {
 253
 254         java.util.Optional<TunnelOperStatus> tunnelOperStatus = TunnelOperStatus.forName(opState.getName());
 255         if (tunnelOperStatus.isPresent()) {
 256             return tunnelOperStatus.get();
 257         }
 258         return TunnelOperStatus.Ignore;
 259     }
 260
 261     public static InstanceIdentifier<OvsBridgeTunnelEntry> getBridgeTunnelEntryIdentifier(
 262             OvsBridgeEntryKey bridgeEntryKey, OvsBridgeTunnelEntryKey bridgeInterfaceEntryKey) {
 263         return InstanceIdentifier.builder(BridgeTunnelInfo.class)
 264                 .child(OvsBridgeEntry.class, bridgeEntryKey)
 265                 .child(OvsBridgeTunnelEntry.class, bridgeInterfaceEntryKey).build();
 266
 267     }
 268
 269     public static InstanceIdentifier<OvsBridgeRefEntry>
 270         getOvsBridgeRefEntryIdentifier(OvsBridgeRefEntryKey bridgeRefEntryKey) {
 271         return InstanceIdentifier.builder(OvsBridgeRefInfo.class)
 272                 .child(OvsBridgeRefEntry.class, bridgeRefEntryKey).build();
 273     }
 274
 275     public static InstanceIdentifier<DpnsTeps> createDpnTepsInstanceIdentifier(Uint64 sourceDpnId) {
 276         return InstanceIdentifier.builder(DpnTepsState.class).child(DpnsTeps.class,
 277             new DpnsTepsKey(sourceDpnId)).build();
 278     }
 279
 280     public static InstanceIdentifier<OvsBridgeEntry> getOvsBridgeEntryIdentifier(OvsBridgeEntryKey bridgeEntryKey) {
 281         return InstanceIdentifier.builder(BridgeTunnelInfo.class).child(OvsBridgeEntry.class, bridgeEntryKey).build();
 282     }
 283
 284     public static InstanceIdentifier<TerminationPoint> createTerminationPointInstanceIdentifier(
 285             org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021
 286                     .network.topology.topology.NodeKey nodekey, String portName) {
 287         InstanceIdentifier<TerminationPoint> terminationPointPath = InstanceIdentifier.create(NetworkTopology.class)
 288                 .child(Topology.class, new TopologyKey(OVSDB_TOPOLOGY_ID))
 289                 .child(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021
 290                         .network.topology.topology.Node.class, nodekey)
 291                 .child(TerminationPoint.class, new TerminationPointKey(new TpId(portName)));
 292
 293         LOG.debug("Termination point InstanceIdentifier generated : {}", terminationPointPath);
 294         return terminationPointPath;
 295     }
 296
 297     public static List<InterfaceBfd> getBfdParams(IfTunnel ifTunnel) {
 298         List<InterfaceBfd> bfdParams = new ArrayList<>();
 299         bfdParams.add(getIfBfdObj(BFD_PARAM_ENABLE,ifTunnel != null ? ifTunnel.isMonitorEnabled().toString()
 300                 : "false"));
 301         bfdParams.add(getIfBfdObj(BFD_PARAM_MIN_TX, ifTunnel != null &&  ifTunnel.getMonitorInterval() != null
 302                 ? ifTunnel.getMonitorInterval().toString() : BFD_MIN_TX_VAL));
 303         bfdParams.add(getIfBfdObj(BFD_PARAM_FORWARDING_IF_RX, BFD_FORWARDING_IF_RX_VAL));
 304         bfdParams.add(getIfBfdObj(BFD_PARAM_REMOTE_DST_MAC, BFD_REMOTE_DST_MAC_VAL));
 305         bfdParams.add(getIfBfdObj(BFD_PARAM_LOCAL_SRC_MAC, BFD_LOCAL_SRC_MAC_VAL));
 306         bfdParams.add(getIfBfdObj(BFD_PARAM_LOCAL_DST_MAC, BFD_LOCAL_DST_MAC_VAL));
 307         LOG.debug("getBfdParams {}", bfdParams);
 308         return bfdParams;
 309     }
 310
 311     public List<InterfaceBfd> getBfdParams(RemoteDpns remoteDpn) {
 312         List<InterfaceBfd> bfdParams = new ArrayList<>();
 313         bfdParams.add(getIfBfdObj(BFD_PARAM_ENABLE, remoteDpn != null ? remoteDpn.isMonitoringEnabled().toString()
 314             : "false"));
 315         bfdParams.add(getIfBfdObj(BFD_PARAM_MIN_TX, remoteDpn != null && remoteDpn.getMonitoringInterval() != null
 316             ? remoteDpn.getMonitoringInterval().toString() : BFD_MIN_TX_VAL));
 317         bfdParams.add(getIfBfdObj(BFD_PARAM_FORWARDING_IF_RX, BFD_FORWARDING_IF_RX_VAL));
 318         bfdParams.add(getIfBfdObj(BFD_PARAM_REMOTE_DST_MAC, BFD_REMOTE_DST_MAC_VAL));
 319         bfdParams.add(getIfBfdObj(BFD_PARAM_LOCAL_SRC_MAC, BFD_LOCAL_SRC_MAC_VAL));
 320         bfdParams.add(getIfBfdObj(BFD_PARAM_LOCAL_DST_MAC, BFD_LOCAL_DST_MAC_VAL));
 321         LOG.debug("getBfdParams {}", bfdParams);
 322         LOG.debug("getBfdParams {}", bfdParams);
 323         return bfdParams;
 324     }
 325
 326     private static InterfaceBfd getIfBfdObj(String key, String value) {
 327         InterfaceBfdBuilder bfdBuilder = new InterfaceBfdBuilder();
 328         bfdBuilder.setBfdKey(key).withKey(new InterfaceBfdKey(key)).setBfdValue(value);
 329         return bfdBuilder.build();
 330     }
 331
 332     public static boolean bfdMonitoringEnabled(Map<InterfaceBfdKey, InterfaceBfd> interfaceBfds) {
 333         if (interfaceBfds != null && !interfaceBfds.isEmpty()) {
 334             for (InterfaceBfd interfaceBfd : interfaceBfds.values()) {
 335                 if (BFD_ENABLE_KEY.equalsIgnoreCase(interfaceBfd.getBfdKey())) {
 336                     return BFD_ENABLE_VALUE.equalsIgnoreCase(interfaceBfd.getBfdValue());
 337                 }
 338             }
 339         }
 340         return false;
 341     }
 342
 343     public static boolean changeInBfdMonitoringDetected(OvsdbTerminationPointAugmentation tpOld,
 344                                                         OvsdbTerminationPointAugmentation tpNew) {
 345         return tpOld != null
 346                 && bfdMonitoringEnabled(tpNew.getInterfaceBfd()) != bfdMonitoringEnabled(tpOld.getInterfaceBfd());
 347     }
 348
 349     public static boolean ifBfdStatusNotEqual(OvsdbTerminationPointAugmentation tpOld,
 350                                               OvsdbTerminationPointAugmentation tpNew) {
 351         return tpNew.getInterfaceBfdStatus() != null
 352                 && (tpOld == null || !tpNew.getInterfaceBfdStatus().equals(tpOld.getInterfaceBfdStatus()));
 353     }
 354
 355     public int allocateId(String poolName, String idKey)
 356             throws InterruptedException, ExecutionException , OperationFailedException {
 357         AllocateIdInput getIdInput = new AllocateIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
 358         RpcResult<AllocateIdOutput> rpcResult = idManagerService.allocateId(getIdInput).get();
 359         if (rpcResult.isSuccessful()) {
 360             return rpcResult.getResult().getIdValue().intValue();
 361         } else {
 362             Optional<RpcError> rpcError = rpcResult.getErrors().stream().findFirst();
 363             String msg = String.format("RPC Call to Get Unique Id returned with Errors for the key %s", idKey);
 364             if (rpcError.isPresent()) {
 365                 throw new OperationFailedException(msg, rpcError.get());
 366             }
 367             else {
 368                 throw new OperationFailedException(msg);
 369             }
 370         }
 371     }
 372
 373     public static void createBridgeTunnelEntryInConfigDS(Uint64 dpId, String childInterface) {
 374         OvsBridgeEntryKey bridgeEntryKey = new OvsBridgeEntryKey(dpId);
 375         OvsBridgeTunnelEntryKey bridgeTunnelEntryKey = new OvsBridgeTunnelEntryKey(childInterface);
 376         InstanceIdentifier<OvsBridgeTunnelEntry> bridgeTunnelEntryIid =
 377                 getBridgeTunnelEntryIdentifier(bridgeEntryKey, bridgeTunnelEntryKey);
 378         OvsBridgeTunnelEntryBuilder entryBuilder = new OvsBridgeTunnelEntryBuilder().withKey(bridgeTunnelEntryKey)
 379                 .setTunnelName(childInterface);
 380         ITMBatchingUtils.write(bridgeTunnelEntryIid, entryBuilder.build(), ITMBatchingUtils.EntityType.DEFAULT_CONFIG);
 381     }
 382
 383     public void addTunnelIngressFlow(TypedWriteTransaction<Configuration> tx, Uint64 dpnId, long portNo,
 384                                      String interfaceName, int ifIndex, Ipv4Address ipAddress) {
 385         LOG.debug("Adding tunnel ingress flow for {}", interfaceName);
 386         List<MatchInfoBase> matches = new ArrayList<>();
 387
 388         List<InstructionInfo> mkInstructions = new ArrayList<>();
 389         matches.add(new MatchInPort(dpnId, portNo));
 390         if (itmConfig.isUseOfTunnels()) {
 391             matches.add(new NxMatchTunnelSourceIp(ipAddress));
 392         }
 393         mkInstructions.add(new InstructionWriteMetadata(
 394             Uint64.fromLongBits(MetaDataUtil.getLportTagMetaData(ifIndex).longValue() | 1L),
 395             MetaDataUtil.METADATA_MASK_LPORT_TAG_SH_FLAG));
 396         short tableId = NwConstants.INTERNAL_TUNNEL_TABLE;
 397         mkInstructions.add(new InstructionGotoTable(tableId));
 398
 399         String flowRef =
 400             getTunnelInterfaceFlowRef(dpnId, NwConstants.VLAN_INTERFACE_INGRESS_TABLE, interfaceName);
 401
 402         FlowEntity flowEntity = MDSALUtil.buildFlowEntity(dpnId, NwConstants.VLAN_INTERFACE_INGRESS_TABLE, flowRef,
 403             ITMConstants.DEFAULT_FLOW_PRIORITY, interfaceName, 0, 0, NwConstants.COOKIE_VM_INGRESS_TABLE, matches,
 404             mkInstructions);
 405         mdsalApiManager.addFlow(tx, flowEntity);
 406     }
 407
 408     public void removeTunnelIngressFlow(TypedReadWriteTransaction<Configuration> tx, Uint64 dpnId,
 409         String interfaceName) throws ExecutionException, InterruptedException {
 410         LOG.debug("Removing tunnel ingress flow for {}", interfaceName);
 411         String flowRef =
 412             getTunnelInterfaceFlowRef(dpnId, NwConstants.VLAN_INTERFACE_INGRESS_TABLE, interfaceName);
 413
 414         mdsalApiManager.removeFlow(tx, dpnId, flowRef, NwConstants.VLAN_INTERFACE_INGRESS_TABLE);
 415     }
 416
 417     public void addTunnelEgressFlow(TypedWriteTransaction<Configuration> tx, Uint64 dpnId, String portNo,
 418                                     int dstId, String interfaceName, IpAddress dstIp) {
 419         LOG.debug("add tunnel egress flow for {}", interfaceName);
 420         List<MatchInfoBase> matches = new ArrayList<>();
 421         List<ActionInfo> actions = new ArrayList<>();
 422         matches.add(new NxMatchRegister(NxmNxReg6.class, MetaDataUtil.getRemoteDpnMetadatForEgressTunnelTable(dstId)));
 423         if (itmConfig.isUseOfTunnels()) {
 424             actions.add(new ActionSetTunnelDestinationIp(0, dstIp));
 425             actions.add(new ActionOutput(1, new Uri(portNo)));
 426         } else {
 427             actions.add(new ActionOutput(0, new Uri(portNo)));
 428         }
 429         String flowRef = getTunnelInterfaceFlowRef(dpnId, NwConstants.EGRESS_TUNNEL_TABLE, interfaceName);
 430         Instruction instruction = MDSALUtil.buildApplyActionsInstruction(MDSALUtil.buildActions(actions));
 431         Flow egressFlow = MDSALUtil.buildFlowNew(NwConstants.EGRESS_TUNNEL_TABLE, flowRef, 5, flowRef,
 432                 0, 0, NwConstants.COOKIE_ITM_EGRESS_TUNNEL_TABLE, matches,
 433                 Collections.singletonMap(instruction.key(),instruction));
 434         mdsalApiManager.addFlow(tx, dpnId, egressFlow);
 435     }
 436
 437     public void removeTunnelEgressFlow(TypedReadWriteTransaction<Configuration> tx, Uint64 dpnId,
 438                                        String interfaceName) throws ExecutionException, InterruptedException {
 439         LOG.debug("remove tunnel egress flow for {}", interfaceName);
 440         String flowRef =
 441                 getTunnelInterfaceFlowRef(dpnId, NwConstants.EGRESS_TUNNEL_TABLE, interfaceName);
 442         mdsalApiManager.removeFlow(tx, dpnId, flowRef, NwConstants.EGRESS_TUNNEL_TABLE);
 443     }
 444
 445     private String getTunnelInterfaceFlowRef(Uint64 dpnId, short tableId, String ifName) {
 446         return String.valueOf(dpnId) + tableId + ifName;
 447     }
 448
 449     public void addTunnelPortToBridge(IfTunnel ifTunnel, InstanceIdentifier<?> bridgeIid,
 450                                       org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf
 451                                               .interfaces.rev140508.interfaces.Interface iface, String portName) {
 452         LOG.debug("adding tunnel port {} to bridge {}", portName, bridgeIid);
 453
 454         Class<? extends InterfaceTypeBase> type =
 455                 DirectTunnelUtils.TUNNEL_TYPE_MAP.get(ifTunnel.getTunnelInterfaceType());
 456         if (type == null) {
 457             LOG.warn("Unknown Tunnel Type obtained while creating interface: {}", iface);
 458             return;
 459         }
 460
 461         int vlanId = 0;
 462         IfL2vlan ifL2vlan = iface.augmentation(IfL2vlan.class);
 463         if (ifL2vlan != null && ifL2vlan.getVlanId() != null) {
 464             vlanId = ifL2vlan.getVlanId().getValue().toJava();
 465         }
 466
 467         Builder<String, String> options = new ImmutableMap.Builder<>();
 468
 469         // Options common to any kind of tunnel
 470         options.put(TUNNEL_OPTIONS_KEY, TUNNEL_OPTIONS_VALUE_FLOW);
 471         IpAddress localIp = ifTunnel.getTunnelSource();
 472         options.put(DirectTunnelUtils.TUNNEL_OPTIONS_LOCAL_IP, localIp.getIpv4Address().getValue());
 473
 474         if (itmConfig.isUseOfTunnels()) {
 475             options.put(TUNNEL_OPTIONS_REMOTE_IP, TUNNEL_OPTIONS_VALUE_FLOW);
 476         } else {
 477             IpAddress remoteIp = ifTunnel.getTunnelDestination();
 478             options.put(DirectTunnelUtils.TUNNEL_OPTIONS_REMOTE_IP, remoteIp.getIpv4Address().getValue());
 479         }
 480
 481         options.put(DirectTunnelUtils.TUNNEL_OPTIONS_TOS, DirectTunnelUtils.TUNNEL_OPTIONS_TOS_VALUE_INHERIT);
 482
 483         // Specific options for each type of tunnel
 484         if (TunnelTypeVxlanGpe.class.equals(ifTunnel.getTunnelInterfaceType())) {
 485             options.put(DirectTunnelUtils.TUNNEL_OPTIONS_EXTS, DirectTunnelUtils.TUNNEL_OPTIONS_VALUE_GPE);
 486             options.put(DirectTunnelUtils.TUNNEL_OPTIONS_NSI, DirectTunnelUtils.TUNNEL_OPTIONS_VALUE_FLOW);
 487             options.put(DirectTunnelUtils.TUNNEL_OPTIONS_NSP, DirectTunnelUtils.TUNNEL_OPTIONS_VALUE_FLOW);
 488             options.put(DirectTunnelUtils.TUNNEL_OPTIONS_NSHC1, DirectTunnelUtils.TUNNEL_OPTIONS_VALUE_FLOW);
 489             options.put(DirectTunnelUtils.TUNNEL_OPTIONS_NSHC2, DirectTunnelUtils.TUNNEL_OPTIONS_VALUE_FLOW);
 490             options.put(DirectTunnelUtils.TUNNEL_OPTIONS_NSHC3, DirectTunnelUtils.TUNNEL_OPTIONS_VALUE_FLOW);
 491             options.put(DirectTunnelUtils.TUNNEL_OPTIONS_NSHC4, DirectTunnelUtils.TUNNEL_OPTIONS_VALUE_FLOW);
 492             // VxLAN-GPE interfaces will not use the default UDP port to avoid problems with other meshes
 493             options.put(DirectTunnelUtils.TUNNEL_OPTIONS_DESTINATION_PORT,
 494                     DirectTunnelUtils.TUNNEL_OPTIONS_VALUE_GPE_DESTINATION_PORT);
 495         }
 496         addTerminationPoint(bridgeIid, portName, vlanId, type, options.build(), ifTunnel);
 497     }
 498
 499     private void addTerminationPoint(InstanceIdentifier<?> bridgeIid, String portName, int vlanId,
 500                                      Class<? extends InterfaceTypeBase> type, Map<String, String> options,
 501                                      IfTunnel ifTunnel) {
 502         final InstanceIdentifier<TerminationPoint> tpIid = DirectTunnelUtils.createTerminationPointInstanceIdentifier(
 503                 InstanceIdentifier.keyOf(bridgeIid.firstIdentifierOf(
 504                         org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang
 505                                 .network.topology.rev131021.network.topology.topology.Node.class)), portName);
 506         OvsdbTerminationPointAugmentationBuilder tpAugmentationBuilder = new OvsdbTerminationPointAugmentationBuilder();
 507
 508         tpAugmentationBuilder.setName(portName);
 509
 510         if (type != null) {
 511             tpAugmentationBuilder.setInterfaceType(type);
 512         }
 513
 514         if (options != null) {
 515             List<Options> optionsList = new ArrayList<>();
 516             for (Map.Entry<String, String> entry : options.entrySet()) {
 517                 OptionsBuilder optionsBuilder = new OptionsBuilder();
 518                 optionsBuilder.withKey(new OptionsKey(entry.getKey()));
 519                 optionsBuilder.setOption(entry.getKey());
 520                 optionsBuilder.setValue(entry.getValue());
 521                 optionsList.add(optionsBuilder.build());
 522             }
 523             tpAugmentationBuilder.setOptions(optionsList);
 524         }
 525
 526         if (vlanId != 0) {
 527             tpAugmentationBuilder.setVlanMode(OvsdbPortInterfaceAttributes.VlanMode.Access);
 528             tpAugmentationBuilder.setVlanTag(new VlanId(vlanId));
 529         }
 530
 531         if (itmConfig.isUseOfTunnels()) {
 532             LOG.warn("BFD Monitoring not supported for OFTunnels");
 533         } else if (ifTunnel.isMonitorEnabled()
 534                 && TunnelMonitoringTypeBfd.class.isAssignableFrom(ifTunnel.getMonitorProtocol())) { //checkBfdMonEnabled
 535             List<InterfaceBfd> bfdParams = DirectTunnelUtils.getBfdParams(ifTunnel);
 536             tpAugmentationBuilder.setInterfaceBfd(bfdParams);
 537         }
 538
 539         TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
 540         tpBuilder.withKey(InstanceIdentifier.keyOf(tpIid));
 541         tpBuilder.addAugmentation(tpAugmentationBuilder.build());
 542
 543         ITMBatchingUtils.write(tpIid, tpBuilder.build(), ITMBatchingUtils.EntityType.TOPOLOGY_CONFIG);
 544     }
 545
 546     public void removeLportTagInterfaceMap(String infName)
 547             throws ExecutionException, InterruptedException, OperationFailedException {
 548         // workaround to get the id to remove from lport tag interface map
 549         Integer ifIndex = allocateId(IfmConstants.IFM_IDPOOL_NAME, infName);
 550         releaseId(IfmConstants.IFM_IDPOOL_NAME, infName);
 551         LOG.debug("removing lport tag to interface map for {}", infName);
 552         InstanceIdentifier<IfIndexTunnel> id = InstanceIdentifier.builder(IfIndexesTunnelMap.class)
 553                 .child(IfIndexTunnel.class, new IfIndexTunnelKey(ifIndex)).build();
 554         ITMBatchingUtils.delete(id, ITMBatchingUtils.EntityType.DEFAULT_OPERATIONAL);
 555     }
 556
 557     private void releaseId(String poolName, String idKey) throws InterruptedException, ExecutionException,
 558             OperationFailedException {
 559         ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
 560         ListenableFuture<RpcResult<ReleaseIdOutput>> result = idManagerService.releaseId(idInput);
 561         RpcResult<ReleaseIdOutput> rpcResult = result.get();
 562         if (!rpcResult.isSuccessful()) {
 563             LOG.error("RPC Call to release Id with Key {} returned with Errors {}", idKey, rpcResult.getErrors());
 564             Optional<RpcError> rpcError = rpcResult.getErrors().stream().findFirst();
 565             String msg = String.format("RPC Call to release Id returned with Errors for the key %s", idKey);
 566             if (rpcError.isPresent()) {
 567                 throw new OperationFailedException(msg, rpcError.get());
 568             }
 569             else {
 570                 throw new OperationFailedException(msg);
 571             }
 572         }
 573     }
 574
 575     public void deleteTunnelStateEntry(String interfaceName) {
 576         LOG.debug(" deleteTunnelStateEntry tunnels state for {}", interfaceName);
 577         InstanceIdentifier<StateTunnelList> stateTnlId =
 578                 ItmUtils.buildStateTunnelListId(new StateTunnelListKey(interfaceName));
 579         ITMBatchingUtils.delete(stateTnlId, ITMBatchingUtils.EntityType.DEFAULT_OPERATIONAL);
 580     }
 581
 582     public void updateBfdConfiguration(Uint64 srcDpnId, RemoteDpns remoteDpn,
 583                                        Optional<OvsBridgeRefEntry> ovsBridgeRefEntry) {
 584         if (ovsBridgeRefEntry.isPresent()) {
 585             LOG.debug("creating bridge interface on dpn {}", srcDpnId);
 586             InstanceIdentifier<OvsdbBridgeAugmentation> bridgeIid =
 587                 (InstanceIdentifier<OvsdbBridgeAugmentation>) ovsBridgeRefEntry.get()
 588                     .getOvsBridgeReference().getValue();
 589             updateBfdParamtersForTerminationPoint(bridgeIid, remoteDpn);
 590         }
 591     }
 592
 593     public void updateBfdParamtersForTerminationPoint(InstanceIdentifier<?> bridgeIid, RemoteDpns remoteDpn) {
 594         final InstanceIdentifier<TerminationPoint> tpIid = createTerminationPointInstanceIdentifier(
 595             InstanceIdentifier.keyOf(bridgeIid.firstIdentifierOf(
 596                 org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang
 597                     .network.topology.rev131021.network.topology.topology.Node.class)), remoteDpn.getTunnelName());
 598         OvsdbTerminationPointAugmentationBuilder tpAugmentationBuilder = new OvsdbTerminationPointAugmentationBuilder();
 599         List<InterfaceBfd> bfdParams = getBfdParams(remoteDpn);
 600         tpAugmentationBuilder.setInterfaceBfd(bfdParams);
 601         LOG.debug("OvsdbTerminationPointAugmentation: {}", tpAugmentationBuilder);
 602         TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
 603         tpBuilder.withKey(InstanceIdentifier.keyOf(tpIid));
 604         tpBuilder.addAugmentation(tpAugmentationBuilder.build());
 605         ITMBatchingUtils.update(tpIid, tpBuilder.build(), ITMBatchingUtils.EntityType.TOPOLOGY_CONFIG);
 606     }
 607
 608     public boolean isEntityOwner() {
 609         return entityOwnershipUtils.isEntityOwner(ITMConstants.ITM_CONFIG_ENTITY, ITMConstants.ITM_CONFIG_ENTITY);
 610     }
 611
 612     public static String generateOfPortName(Uint64 dpId, String tunnelType) {
 613         String trunkInterfaceName = dpId + ":" + tunnelType;
 614         return "of" + UUID.nameUUIDFromBytes(trunkInterfaceName.getBytes(StandardCharsets.UTF_8)).toString()
 615                 .substring(0, 12).replace("-", "");
 616     }
 617
 618     public void deleteOfTepStateEntry(String ofTepName) {
 619         LOG.debug("deleteOfTepStateEntry ofTeps state for {}", ofTepName);
 620         InstanceIdentifier<OfTep> ofTeplId =
 621                 ItmUtils.buildStateOfTepListId(new OfTepKey(ofTepName));
 622         ITMBatchingUtils.delete(ofTeplId, ITMBatchingUtils.EntityType.DEFAULT_OPERATIONAL);
 623     }
 624
 625     public static void removeOfTepFromDpnsTepConfigDS(DataBroker dataBroker, Uint64 srcDpnId)
 626             throws TransactionCommitFailedException {
 627         // The source DPn id is the one to be removed
 628         InstanceIdentifier<OfDpnTep> dpntepII = buildDpnTepInstanceIdentifier(srcDpnId);
 629         SingleTransactionDataBroker.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, dpntepII);
 630     }
 631
 632     private static InstanceIdentifier<OfDpnTep> buildDpnTepInstanceIdentifier(Uint64 srcDpnId) {
 633         return InstanceIdentifier.builder(DpnTepConfig.class).child(OfDpnTep.class, new OfDpnTepKey(srcDpnId)).build();
 634     }
 635 }