Ignore null tunnel id in getEgressActionInfosForInterface for VxLAN tunnels
[genius.git] / interfacemanager / interfacemanager-impl / src / main / java / org / opendaylight / genius / interfacemanager / IfmUtil.java
index 1907e6e9aa4a409b43c6017a740da9c3c78e6e4b..6e3b28ab9848ddd533d2353b8dffe411555ea29b 100755 (executable)
@@ -7,14 +7,20 @@
  */
 package org.opendaylight.genius.interfacemanager;
 
+import static org.opendaylight.genius.interfacemanager.globals.InterfaceInfo.InterfaceType.GRE_TRUNK_INTERFACE;
+import static org.opendaylight.genius.interfacemanager.globals.InterfaceInfo.InterfaceType.MPLS_OVER_GRE;
+import static org.opendaylight.genius.interfacemanager.globals.InterfaceInfo.InterfaceType.VLAN_INTERFACE;
+import static org.opendaylight.genius.interfacemanager.globals.InterfaceInfo.InterfaceType.VXLAN_TRUNK_INTERFACE;
+
 import com.google.common.base.Optional;
 import com.google.common.collect.ImmutableMap;
+import com.google.common.util.concurrent.ListenableFuture;
 import java.math.BigInteger;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.Future;
-import com.google.common.util.concurrent.ListenableFuture;
+import org.apache.commons.lang3.BooleanUtils;
 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
@@ -24,17 +30,27 @@ import org.opendaylight.genius.interfacemanager.commons.InterfaceManagerCommonUt
 import org.opendaylight.genius.interfacemanager.globals.InterfaceInfo;
 import org.opendaylight.genius.interfacemanager.globals.VlanInterfaceInfo;
 import org.opendaylight.genius.interfacemanager.servicebindings.flowbased.utilities.FlowBasedServicesUtils;
-import org.opendaylight.genius.mdsalutil.ActionType;
 import org.opendaylight.genius.mdsalutil.ActionInfo;
 import org.opendaylight.genius.mdsalutil.MDSALUtil;
 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
 import org.opendaylight.genius.mdsalutil.NwConstants;
+import org.opendaylight.genius.mdsalutil.actions.ActionNxResubmit;
+import org.opendaylight.genius.mdsalutil.actions.ActionOutput;
+import org.opendaylight.genius.mdsalutil.actions.ActionPushVlan;
+import org.opendaylight.genius.mdsalutil.actions.ActionRegLoad;
+import org.opendaylight.genius.mdsalutil.actions.ActionSetFieldTunnelId;
+import org.opendaylight.genius.mdsalutil.actions.ActionSetFieldVlanVid;
+import org.opendaylight.genius.mdsalutil.actions.ActionSetTunnelDestinationIp;
+import org.opendaylight.genius.mdsalutil.actions.ActionSetTunnelSourceIp;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.L2vlan;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.Tunnel;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceBuilder;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteMetadataCase;
@@ -53,6 +69,7 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan.L2vlanMode;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfTunnel;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.ParentRefs;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.ParentRefsBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeBase;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeGre;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeMplsOverGre;
@@ -71,6 +88,7 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.No
 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.NxmNxReg6;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathId;
 import org.opendaylight.yangtools.yang.binding.DataObject;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
@@ -79,32 +97,30 @@ import org.opendaylight.yangtools.yang.common.RpcResult;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import static org.opendaylight.genius.interfacemanager.globals.InterfaceInfo.InterfaceType.VLAN_INTERFACE;
-
 public class IfmUtil {
     private static final Logger LOG = LoggerFactory.getLogger(IfmUtil.class);
     private static final int INVALID_ID = 0;
 
     private static final ImmutableMap<Class<? extends TunnelTypeBase>, InterfaceInfo.InterfaceType> TUNNEL_TYPE_MAP =
             new ImmutableMap.Builder<Class<? extends TunnelTypeBase>, InterfaceInfo.InterfaceType>()
-                    .put(TunnelTypeGre.class, InterfaceInfo.InterfaceType.GRE_TRUNK_INTERFACE)
-                    .put(TunnelTypeMplsOverGre.class, InterfaceInfo.InterfaceType.MPLS_OVER_GRE)
-                    .put(TunnelTypeVxlan.class, InterfaceInfo.InterfaceType.VXLAN_TRUNK_INTERFACE)
-                    .put(TunnelTypeVxlanGpe.class, InterfaceInfo.InterfaceType.VXLAN_TRUNK_INTERFACE)
+                    .put(TunnelTypeGre.class, GRE_TRUNK_INTERFACE)
+                    .put(TunnelTypeMplsOverGre.class, MPLS_OVER_GRE)
+                    .put(TunnelTypeVxlan.class, VXLAN_TRUNK_INTERFACE)
+                    .put(TunnelTypeVxlanGpe.class, VXLAN_TRUNK_INTERFACE)
                     .build();
 
-    public static String getDpnFromNodeConnectorId(NodeConnectorId portId) {
+    public static BigInteger getDpnFromNodeConnectorId(NodeConnectorId portId) {
         /*
          * NodeConnectorId is of form 'openflow:dpnid:portnum'
          */
         String[] split = portId.getValue().split(IfmConstants.OF_URI_SEPARATOR);
-        return split[1];
+        return new BigInteger(split[1]);
     }
 
     public static BigInteger getDpnFromInterface(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface ifState){
         NodeConnectorId ncId = getNodeConnectorIdFromInterface(ifState);
         if(ncId != null){
-            return new BigInteger(getDpnFromNodeConnectorId(ncId));
+            return getDpnFromNodeConnectorId(ncId);
         }
         return null;
     }
@@ -130,6 +146,16 @@ public class IfmUtil {
         return split[2];
     }
 
+    public static Long getPortNumberFromNodeConnectorId(NodeConnectorId portId) {
+        String portNo = getPortNoFromNodeConnectorId(portId);
+        try{
+            return Long.valueOf(portNo);
+        }catch(NumberFormatException ex){
+            LOG.trace("Unable to retrieve port number from nodeconnector id for {}", portId);
+        }
+        return IfmConstants.INVALID_PORT_NO;
+    }
+
     public static NodeId buildDpnNodeId(BigInteger dpnId) {
         return new NodeId(IfmConstants.OF_URI_PREFIX + dpnId);
     }
@@ -203,22 +229,16 @@ public class IfmUtil {
 
     public static <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType,
                                                           InstanceIdentifier<T> path, DataBroker broker) {
-
-        ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
-
-        Optional<T> result = Optional.absent();
-        try {
-            result = tx.read(datastoreType, path).get();
+        try (ReadOnlyTransaction tx = broker.newReadOnlyTransaction()) {
+            return tx.read(datastoreType, path).get();
         } catch (Exception e) {
             throw new RuntimeException(e);
         }
-
-        return result;
     }
 
-    public static List<Action> getEgressActionsForInterface(String interfaceName, Long tunnelKey,
+    public static List<Action> getEgressActionsForInterface(String interfaceName, Long tunnelKey, Integer actionKey,
                                                             DataBroker dataBroker, Boolean isDefaultEgress) {
-        List<ActionInfo> listActionInfo = getEgressActionInfosForInterface(interfaceName, tunnelKey, 0, dataBroker, isDefaultEgress);
+        List<ActionInfo> listActionInfo = getEgressActionInfosForInterface(interfaceName, tunnelKey, actionKey==null?0:actionKey, dataBroker, isDefaultEgress);
         List<Action> actionsList = new ArrayList<>();
         for (ActionInfo actionInfo : listActionInfo) {
             actionsList.add(actionInfo.buildAction());
@@ -231,7 +251,7 @@ public class IfmUtil {
         List<Instruction> instructions = new ArrayList<>();
         List<Action> actionList = MDSALUtil.buildActions(getEgressActionInfosForInterface(
                 interfaceName, tunnelKey, 0, dataBroker, isDefaultEgress));
-        instructions.add(MDSALUtil.buildWriteActionsInstruction(actionList));
+        instructions.add(MDSALUtil.buildApplyActionsInstruction(actionList));
         return  instructions;
     }
 
@@ -296,43 +316,51 @@ public class IfmUtil {
                                                                     int ifIndex) {
         List<ActionInfo> result = new ArrayList<>();
         switch (ifaceType) {
+            case MPLS_OVER_GRE:
+            case GRE_TRUNK_INTERFACE:
+                if(!isDefaultEgress) {
+                    //TODO tunnel_id to encode GRE key, once it is supported
+                    // Until then, tunnel_id should be "cleaned", otherwise it stores the value coming from a VXLAN tunnel
+                    if (tunnelKey == null) {
+                        tunnelKey = 0L;
+                    }
+                }
+            case VXLAN_TRUNK_INTERFACE:
+                if(!isDefaultEgress) {
+                    if (tunnelKey != null) {
+                        result.add(new ActionSetFieldTunnelId(actionKeyStart++, BigInteger.valueOf(tunnelKey)));
+                    }
+
+                    IfTunnel ifTunnel = interfaceInfo.getAugmentation(IfTunnel.class);
+                    if (BooleanUtils.isTrue(ifTunnel.isTunnelRemoteIpFlow())) {
+                        result.add(new ActionSetTunnelDestinationIp(actionKeyStart++, ifTunnel.getTunnelDestination()));
+                    }
+                    if (BooleanUtils.isTrue(ifTunnel.isTunnelSourceIpFlow())) {
+                        result.add(new ActionSetTunnelSourceIp(actionKeyStart++, ifTunnel.getTunnelSource()));
+                    }
+                }
             case VLAN_INTERFACE:
                 if(isDefaultEgress) {
                     IfL2vlan vlanIface = interfaceInfo.getAugmentation(IfL2vlan.class);
                     LOG.trace("L2Vlan: {}", vlanIface);
                     boolean isVlanTransparent = false;
-                    long vlanVid = 0;
+                    int vlanVid = 0;
                     if (vlanIface != null) {
                         vlanVid = vlanIface.getVlanId() == null ? 0 : vlanIface.getVlanId().getValue();
                         isVlanTransparent = vlanIface.getL2vlanMode() == IfL2vlan.L2vlanMode.Transparent;
                     }
                     if (vlanVid != 0 && !isVlanTransparent) {
-                        result.add(new ActionInfo(ActionType.push_vlan, new String[]{}, actionKeyStart++));
-                        result.add(new ActionInfo(ActionType.set_field_vlan_vid,
-                                new String[]{Long.toString(vlanVid)}, actionKeyStart++));
+                        result.add(new ActionPushVlan(actionKeyStart++));
+                        result.add(new ActionSetFieldVlanVid(actionKeyStart++, vlanVid));
                     }
-                    result.add(new ActionInfo(ActionType.output, new String[]{portNo}, actionKeyStart++));
+                    result.add(new ActionOutput(actionKeyStart++, new Uri(portNo)));
                 }else{
                     long regValue = MetaDataUtil.getReg6ValueForLPortDispatcher(ifIndex, NwConstants.DEFAULT_SERVICE_INDEX);
-                    result.add(new ActionInfo(ActionType.nx_load_reg_6,
-                            new String[]{Integer.toString(IfmConstants.REG6_START_INDEX), Integer.toString(IfmConstants.REG6_END_INDEX),
-                                    Long.toString(regValue)}, actionKeyStart++));
-                    result.add(new ActionInfo(ActionType.nx_resubmit,
-                            new String[]{Short.toString(NwConstants.EGRESS_LPORT_DISPATCHER_TABLE)}, actionKeyStart++));
-                }
-                break;
-            case MPLS_OVER_GRE:
-            case VXLAN_TRUNK_INTERFACE:
-            case GRE_TRUNK_INTERFACE:
-                if (tunnelKey != null) {
-                    result.add(new ActionInfo(ActionType.set_field_tunnel_id,
-                            new BigInteger[]{BigInteger.valueOf(tunnelKey.longValue())},
-                            actionKeyStart++));
+                    result.add(new ActionRegLoad(actionKeyStart++, NxmNxReg6.class, IfmConstants.REG6_START_INDEX,
+                            IfmConstants.REG6_END_INDEX, regValue));
+                    result.add(new ActionNxResubmit(actionKeyStart++, NwConstants.EGRESS_LPORT_DISPATCHER_TABLE));
                 }
-
-                result.add(new ActionInfo(ActionType.output, new String[]{portNo}, actionKeyStart++));
                 break;
-
             default:
                 LOG.warn("Interface Type {} not handled yet", ifaceType);
                 break;
@@ -415,13 +443,8 @@ public class IfmUtil {
                 InstanceIdentifier.builder(Nodes.class)
                         .child(Node.class, new NodeKey(getNodeIdFromNodeConnectorId(ncId)))
                         .child(NodeConnector.class, new NodeConnectorKey(ncId)).build();
-        Optional<NodeConnector> optNc = read(LogicalDatastoreType.OPERATIONAL, ncIdentifier, dataBroker);
-        if(optNc.isPresent()) {
-            NodeConnector nc = optNc.get();
-            FlowCapableNodeConnector fcnc = nc.getAugmentation(FlowCapableNodeConnector.class);
-            return fcnc.getName();
-        }
-        return null;
+        return read(LogicalDatastoreType.OPERATIONAL, ncIdentifier, dataBroker).transform(
+                nc -> nc.getAugmentation(FlowCapableNodeConnector.class).getName()).orNull();
     }
 
     public static NodeConnectorId getNodeConnectorIdFromInterface(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface ifState){
@@ -477,17 +500,56 @@ public class IfmUtil {
         return vlanInterfaceInfo;
     }
 
+    public static BigInteger getDeadBeefBytesForMac() {
+        return new BigInteger("FFFFFFFF", 16).and(new BigInteger(IfmConstants.DEAD_BEEF_MAC_PREFIX, 16)).shiftLeft(16);
+    }
+
+    public static BigInteger fillPortNumberToMac(long portNumber) {
+        return new BigInteger("FFFF", 16).and(BigInteger.valueOf(portNumber));
+    }
+
+    public static String generateMacAddress(long portNo){
+        String unformattedMAC = getDeadBeefBytesForMac().or(fillPortNumberToMac(portNo)).toString(16);
+        return unformattedMAC.replaceAll("(.{2})", "$1"+IfmConstants.MAC_SEPARATOR).
+                substring(0, IfmConstants.MAC_STRING_LENGTH);
+    }
+
+    public static PhysAddress getPhyAddress(long portNo, FlowCapableNodeConnector flowCapableNodeConnector){
+        String southboundMacAddress = flowCapableNodeConnector.getHardwareAddress().getValue();
+        if(IfmConstants.INVALID_MAC.equals(southboundMacAddress)){
+            LOG.debug("Invalid MAC Address received for {}, generating MAC Address", flowCapableNodeConnector.getName());
+            southboundMacAddress = generateMacAddress(portNo);
+        }
+        return new PhysAddress(southboundMacAddress);
+    }
+
+    public static void updateInterfaceParentRef(WriteTransaction t, String interfaceName, String parentInterface) {
+        InstanceIdentifier<ParentRefs> parentRefIdentifier = InstanceIdentifier.builder(Interfaces.class)
+                .child(Interface.class, new InterfaceKey(interfaceName)).augmentation(ParentRefs.class).build();
+        ParentRefs parentRefs = new ParentRefsBuilder().setParentInterface(parentInterface).build();
+        t.merge(LogicalDatastoreType.CONFIGURATION, parentRefIdentifier, parentRefs);
+        LOG.debug("Updating parentRefInterface for interfaceName {}. interfaceKey {}, with parentRef augmentation pointing to {}",
+                interfaceName, new InterfaceKey(interfaceName), parentInterface);
+    }
+
+    public static InstanceIdentifier<BoundServices> buildBoundServicesIId(short servicePriority, String interfaceName,
+                                                                          Class<? extends ServiceModeBase> serviceMode) {
+        return InstanceIdentifier.builder(ServiceBindings.class)
+                                 .child(ServicesInfo.class, new ServicesInfoKey(interfaceName, serviceMode))
+                                 .child(BoundServices.class, new BoundServicesKey(servicePriority))
+                                 .build();
+    }
+
     public static void bindService(WriteTransaction t, String interfaceName, BoundServices serviceInfo,
-                                   Class<? extends ServiceModeBase> serviceMode){
+                                   Class<? extends ServiceModeBase> serviceMode) {
         LOG.info("Binding Service {} for : {}", serviceInfo.getServiceName(), interfaceName);
-        InstanceIdentifier<BoundServices> boundServicesInstanceIdentifier = InstanceIdentifier.builder(ServiceBindings.class)
-                .child(ServicesInfo.class, new ServicesInfoKey(interfaceName, serviceMode))
-                .child(BoundServices.class, new BoundServicesKey(serviceInfo.getServicePriority())).build();
+        InstanceIdentifier<BoundServices> boundServicesInstanceIdentifier =
+            buildBoundServicesIId(serviceInfo.getServicePriority(), interfaceName, serviceMode);
         t.put(LogicalDatastoreType.CONFIGURATION, boundServicesInstanceIdentifier, serviceInfo, true);
     }
 
     public static void unbindService(DataBroker dataBroker, String interfaceName, InstanceIdentifier<BoundServices>
-            boundServicesInstanceIdentifier, Class<? extends ServiceModeBase> serviceMode){
+            boundServicesInstanceIdentifier){
         LOG.info("Unbinding Service from : {}", interfaceName);
         DataStoreJobCoordinator dataStoreJobCoordinator = DataStoreJobCoordinator.getInstance();
         dataStoreJobCoordinator.enqueueJob(interfaceName,