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