Merge "Bug 6765 : Overriding in_port in table0 with Zero value"
[genius.git] / interfacemanager / interfacemanager-impl / src / main / java / org / opendaylight / genius / interfacemanager / IfmUtil.java
1 /*
2  * Copyright (c) 2016 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.genius.interfacemanager;
9
10 import com.google.common.base.Optional;
11 import com.google.common.collect.ImmutableMap;
12 import java.math.BigInteger;
13 import java.util.ArrayList;
14 import java.util.List;
15 import java.util.concurrent.ExecutionException;
16 import java.util.concurrent.Future;
17 import com.google.common.util.concurrent.ListenableFuture;
18 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
19 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
20 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
21 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
22 import org.opendaylight.genius.datastoreutils.DataStoreJobCoordinator;
23 import org.opendaylight.genius.interfacemanager.commons.InterfaceManagerCommonUtils;
24 import org.opendaylight.genius.interfacemanager.globals.InterfaceInfo;
25 import org.opendaylight.genius.interfacemanager.globals.VlanInterfaceInfo;
26 import org.opendaylight.genius.interfacemanager.servicebindings.flowbased.utilities.FlowBasedServicesUtils;
27 import org.opendaylight.genius.mdsalutil.ActionType;
28 import org.opendaylight.genius.mdsalutil.ActionInfo;
29 import org.opendaylight.genius.mdsalutil.MDSALUtil;
30 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
31 import org.opendaylight.genius.mdsalutil.NwConstants;
32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.L2vlan;
33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.Tunnel;
34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteMetadataCase;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.write.metadata._case.WriteMetadata;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInput;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInputBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutput;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdPools;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.IdPool;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.IdPoolKey;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan.L2vlanMode;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfTunnel;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.ParentRefs;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeBase;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeGre;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeMplsOverGre;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeVxlan;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeVxlanGpe;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceBindings;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.ServicesInfo;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.ServicesInfoKey;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServicesKey;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathId;
75 import org.opendaylight.yangtools.yang.binding.DataObject;
76 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
77 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
78 import org.opendaylight.yangtools.yang.common.RpcResult;
79 import org.slf4j.Logger;
80 import org.slf4j.LoggerFactory;
81
82 import static org.opendaylight.genius.interfacemanager.globals.InterfaceInfo.InterfaceType.VLAN_INTERFACE;
83
84 public class IfmUtil {
85     private static final Logger LOG = LoggerFactory.getLogger(IfmUtil.class);
86     private static final int INVALID_ID = 0;
87
88     private static final ImmutableMap<Class<? extends TunnelTypeBase>, InterfaceInfo.InterfaceType> TUNNEL_TYPE_MAP =
89             new ImmutableMap.Builder<Class<? extends TunnelTypeBase>, InterfaceInfo.InterfaceType>()
90                     .put(TunnelTypeGre.class, InterfaceInfo.InterfaceType.GRE_TRUNK_INTERFACE)
91                     .put(TunnelTypeMplsOverGre.class, InterfaceInfo.InterfaceType.MPLS_OVER_GRE)
92                     .put(TunnelTypeVxlan.class, InterfaceInfo.InterfaceType.VXLAN_TRUNK_INTERFACE)
93                     .put(TunnelTypeVxlanGpe.class, InterfaceInfo.InterfaceType.VXLAN_TRUNK_INTERFACE)
94                     .build();
95
96     public static String getDpnFromNodeConnectorId(NodeConnectorId portId) {
97         /*
98          * NodeConnectorId is of form 'openflow:dpnid:portnum'
99          */
100         String[] split = portId.getValue().split(IfmConstants.OF_URI_SEPARATOR);
101         return split[1];
102     }
103
104     public static BigInteger getDpnFromInterface(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface ifState){
105         NodeConnectorId ncId = getNodeConnectorIdFromInterface(ifState);
106         if(ncId != null){
107             return new BigInteger(getDpnFromNodeConnectorId(ncId));
108         }
109         return null;
110     }
111     public static String getPortNoFromInterfaceName(String ifaceName, DataBroker broker) {
112         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface ifState =
113                 InterfaceManagerCommonUtils.getInterfaceStateFromOperDS(ifaceName, broker);
114
115         if(ifState == null){
116             throw new NullPointerException("Interface information not present in oper DS for " +ifaceName);
117         }
118         String lowerLayerIf = ifState.getLowerLayerIf().get(0);
119         NodeConnectorId nodeConnectorId = new NodeConnectorId(lowerLayerIf);
120         String portNo = IfmUtil.getPortNoFromNodeConnectorId(nodeConnectorId);
121
122         return portNo;
123     }
124
125     public static String getPortNoFromNodeConnectorId(NodeConnectorId portId) {
126         /*
127          * NodeConnectorId is of form 'openflow:dpnid:portnum'
128          */
129         String[] split = portId.getValue().split(IfmConstants.OF_URI_SEPARATOR);
130         return split[2];
131     }
132
133     public static NodeId buildDpnNodeId(BigInteger dpnId) {
134         return new NodeId(IfmConstants.OF_URI_PREFIX + dpnId);
135     }
136
137     public static InstanceIdentifier<Interface> buildId(String interfaceName) {
138         //TODO Make this generic and move to AbstractDataChangeListener or Utils.
139         InstanceIdentifierBuilder<Interface> idBuilder =
140                 InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new InterfaceKey(interfaceName));
141         InstanceIdentifier<Interface> id = idBuilder.build();
142         return id;
143     }
144
145     public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> buildStateInterfaceId(String interfaceName) {
146         InstanceIdentifierBuilder<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> idBuilder =
147                 InstanceIdentifier.builder(InterfacesState.class)
148                         .child(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.class,
149                                 new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey(interfaceName));
150         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> id = idBuilder.build();
151         return id;
152     }
153
154     public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey getStateInterfaceKeyFromName(
155             String name) {
156         return new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey(name);
157     }
158
159     public static InstanceIdentifier<IdPool> getPoolId(String poolName){
160         InstanceIdentifier.InstanceIdentifierBuilder<IdPool> idBuilder =
161                 InstanceIdentifier.builder(IdPools.class).child(IdPool.class, new IdPoolKey(poolName));
162         InstanceIdentifier<IdPool> id = idBuilder.build();
163         return id;
164     }
165
166     public static List<String> getPortNameAndSuffixFromInterfaceName(String intfName) {
167         List<String> strList = new ArrayList<>(2);
168         int index = intfName.indexOf(":");
169         if (index != -1) {
170             strList.add(0, intfName.substring(0, index));
171             strList.add(1, intfName.substring(index));
172         }
173         return strList;
174     }
175
176     public static long getGroupId(long ifIndex, InterfaceInfo.InterfaceType infType) {
177         if (infType == InterfaceInfo.InterfaceType.LOGICAL_GROUP_INTERFACE) {
178             return ifIndex + IfmConstants.LOGICAL_GROUP_START;
179         }
180         else if (infType == VLAN_INTERFACE) {
181             return ifIndex + IfmConstants.VLAN_GROUP_START;
182         } else {
183             return ifIndex + IfmConstants.TRUNK_GROUP_START;
184         }
185     }
186
187     public static List<String> getDpIdPortNameAndSuffixFromInterfaceName(String intfName) {
188         List<String> strList = new ArrayList<>(3);
189         int index1 = intfName.indexOf(":");
190         if (index1 != -1) {
191             int index2 = intfName.indexOf(":", index1 + 1 );
192             strList.add(0, intfName.substring(0, index1));
193             if (index2 != -1) {
194                 strList.add(1, intfName.substring(index1, index2));
195                 strList.add(2, intfName.substring(index2));
196             } else {
197                 strList.add(1, intfName.substring(index1));
198                 strList.add(2, "");
199             }
200         }
201         return strList;
202     }
203
204     public static <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType,
205                                                           InstanceIdentifier<T> path, DataBroker broker) {
206
207         ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
208
209         Optional<T> result = Optional.absent();
210         try {
211             result = tx.read(datastoreType, path).get();
212         } catch (Exception e) {
213             throw new RuntimeException(e);
214         }
215
216         return result;
217     }
218
219     public static List<Action> getEgressActionsForInterface(String interfaceName, Long tunnelKey,
220                                                             DataBroker dataBroker, Boolean isDefaultEgress) {
221         List<ActionInfo> listActionInfo = getEgressActionInfosForInterface(interfaceName, tunnelKey, 0, dataBroker, isDefaultEgress);
222         List<Action> actionsList = new ArrayList<>();
223         for (ActionInfo actionInfo : listActionInfo) {
224             actionsList.add(actionInfo.buildAction());
225         }
226         return actionsList;
227     }
228
229     public static List<Instruction> getEgressInstructionsForInterface(String interfaceName, Long tunnelKey,
230                                                                       DataBroker dataBroker, Boolean isDefaultEgress) {
231         List<Instruction> instructions = new ArrayList<>();
232         List<Action> actionList = MDSALUtil.buildActions(getEgressActionInfosForInterface(
233                 interfaceName, tunnelKey, 0, dataBroker, isDefaultEgress));
234         instructions.add(MDSALUtil.buildWriteActionsInstruction(actionList));
235         return  instructions;
236     }
237
238     public static List<Instruction> getEgressInstructionsForInterface(Interface interfaceInfo, String portNo,
239                                                                       Long tunnelKey, boolean isDefaultEgress, int ifIndex) {
240         List<Instruction> instructions = new ArrayList<>();
241         InterfaceInfo.InterfaceType ifaceType = getInterfaceType(interfaceInfo);
242         List<Action> actionList = MDSALUtil.buildActions(
243                 getEgressActionInfosForInterface(interfaceInfo, portNo, ifaceType, tunnelKey, 0, isDefaultEgress, ifIndex));
244         instructions.add(MDSALUtil.buildApplyActionsInstruction(actionList));
245         return  instructions;
246     }
247
248
249     public static List<ActionInfo> getEgressActionInfosForInterface(String     interfaceName,
250                                                                     int        actionKeyStart,
251                                                                     DataBroker dataBroker,
252                                                                     Boolean isDefaultEgress) {
253         return getEgressActionInfosForInterface(interfaceName, null, actionKeyStart, dataBroker, isDefaultEgress);
254     }
255
256     /**
257      * Returns a list of Actions to be taken when sending a packet over an interface
258      *
259      * @param interfaceName
260      * @param tunnelKey Optional.
261      * @param actionKeyStart
262      * @param dataBroker
263      * @return
264      */
265     public static List<ActionInfo> getEgressActionInfosForInterface(String     interfaceName,
266                                                                     Long       tunnelKey,
267                                                                     int        actionKeyStart,
268                                                                     DataBroker dataBroker,
269                                                                     Boolean isDefaultEgress) {
270         Interface interfaceInfo = InterfaceManagerCommonUtils.getInterfaceFromConfigDS(new InterfaceKey(interfaceName),
271                 dataBroker);
272         if(interfaceInfo == null){
273             throw new NullPointerException("Interface information not present in config DS for " +interfaceName);
274         }
275         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface ifState =
276                 InterfaceManagerCommonUtils.getInterfaceStateFromOperDS(interfaceName, dataBroker);
277         if(ifState == null){
278             throw new NullPointerException("Interface information not present in oper DS for " +interfaceName);
279         }
280         String lowerLayerIf = ifState.getLowerLayerIf().get(0);
281         NodeConnectorId nodeConnectorId = new NodeConnectorId(lowerLayerIf);
282         String portNo = IfmUtil.getPortNoFromNodeConnectorId(nodeConnectorId);
283
284         InterfaceInfo.InterfaceType ifaceType = getInterfaceType(interfaceInfo);
285         return getEgressActionInfosForInterface(interfaceInfo, portNo, ifaceType, tunnelKey, actionKeyStart,
286                 isDefaultEgress, ifState.getIfIndex());
287     }
288
289
290     public static List<ActionInfo> getEgressActionInfosForInterface(Interface interfaceInfo,
291                                                                     String portNo,
292                                                                     InterfaceInfo.InterfaceType ifaceType,
293                                                                     Long       tunnelKey,
294                                                                     int        actionKeyStart,
295                                                                     boolean isDefaultEgress,
296                                                                     int ifIndex) {
297         List<ActionInfo> result = new ArrayList<>();
298         switch (ifaceType) {
299             case VLAN_INTERFACE:
300                 if(isDefaultEgress) {
301                     IfL2vlan vlanIface = interfaceInfo.getAugmentation(IfL2vlan.class);
302                     LOG.trace("L2Vlan: {}", vlanIface);
303                     boolean isVlanTransparent = false;
304                     long vlanVid = 0;
305                     if (vlanIface != null) {
306                         vlanVid = vlanIface.getVlanId() == null ? 0 : vlanIface.getVlanId().getValue();
307                         isVlanTransparent = vlanIface.getL2vlanMode() == IfL2vlan.L2vlanMode.Transparent;
308                     }
309                     if (vlanVid != 0 && !isVlanTransparent) {
310                         result.add(new ActionInfo(ActionType.push_vlan, new String[]{}, actionKeyStart++));
311                         result.add(new ActionInfo(ActionType.set_field_vlan_vid,
312                                 new String[]{Long.toString(vlanVid)}, actionKeyStart++));
313                     }
314                     result.add(new ActionInfo(ActionType.output, new String[]{portNo}, actionKeyStart++));
315                 }else{
316                     long regValue = MetaDataUtil.getReg6ValueForLPortDispatcher(ifIndex, NwConstants.DEFAULT_SERVICE_INDEX);
317                     result.add(new ActionInfo(ActionType.nx_load_reg_6,
318                             new String[]{Integer.toString(IfmConstants.REG6_START_INDEX), Integer.toString(IfmConstants.REG6_END_INDEX),
319                                     Long.toString(regValue)}, actionKeyStart++));
320                     result.add(new ActionInfo(ActionType.nx_resubmit,
321                             new String[]{Short.toString(NwConstants.EGRESS_LPORT_DISPATCHER_TABLE)}, actionKeyStart++));
322                 }
323                 break;
324             case MPLS_OVER_GRE:
325             case VXLAN_TRUNK_INTERFACE:
326             case GRE_TRUNK_INTERFACE:
327                 if (tunnelKey != null) {
328                     result.add(new ActionInfo(ActionType.set_field_tunnel_id,
329                             new BigInteger[]{BigInteger.valueOf(tunnelKey.longValue())},
330                             actionKeyStart++));
331                 }
332
333                 result.add(new ActionInfo(ActionType.output, new String[]{portNo}, actionKeyStart++));
334                 break;
335
336             default:
337                 LOG.warn("Interface Type {} not handled yet", ifaceType);
338                 break;
339         }
340         return result;
341     }
342
343     public static NodeId getNodeIdFromNodeConnectorId(NodeConnectorId ncId) {
344         return new NodeId(ncId.getValue().substring(0,ncId.getValue().lastIndexOf(":")));
345     }
346
347     public static BigInteger[] mergeOpenflowMetadataWriteInstructions(List<Instruction> instructions) {
348         BigInteger metadata = new BigInteger("0", 16);
349         BigInteger metadataMask = new BigInteger("0", 16);
350         if (instructions != null && !instructions.isEmpty()) {
351             // check if metadata write instruction is present
352             for (Instruction instruction : instructions) {
353                 org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.Instruction actualInstruction = instruction.getInstruction();
354                 if (actualInstruction instanceof WriteMetadataCase) {
355                     WriteMetadataCase writeMetaDataInstruction = (WriteMetadataCase) actualInstruction ;
356                     WriteMetadata availableMetaData = writeMetaDataInstruction.getWriteMetadata();
357                     metadata = metadata.or(availableMetaData.getMetadata());
358                     metadataMask = metadataMask.or(availableMetaData.getMetadataMask());
359                 }
360             }
361         }
362         return new BigInteger[] { metadata, metadataMask };
363     }
364
365     public static Integer allocateId(IdManagerService idManager, String poolName, String idKey) {
366         AllocateIdInput getIdInput = new AllocateIdInputBuilder()
367                 .setPoolName(poolName)
368                 .setIdKey(idKey).build();
369         try {
370             Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
371             RpcResult<AllocateIdOutput> rpcResult = result.get();
372             if(rpcResult.isSuccessful()) {
373                 return rpcResult.getResult().getIdValue().intValue();
374             } else {
375                 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
376             }
377         } catch (InterruptedException | ExecutionException e) {
378             LOG.warn("Exception when getting Unique Id",e);
379         }
380         return INVALID_ID;
381     }
382
383     public static void releaseId(IdManagerService idManager, String poolName, String idKey) {
384         ReleaseIdInput idInput = new ReleaseIdInputBuilder()
385                 .setPoolName(poolName)
386                 .setIdKey(idKey).build();
387         try {
388             Future<RpcResult<Void>> result = idManager.releaseId(idInput);
389             RpcResult<Void> rpcResult = result.get();
390             if(!rpcResult.isSuccessful()) {
391                 LOG.warn("RPC Call to release Id {} with Key {} returned with Errors {}",
392                         idKey, rpcResult.getErrors());
393             }
394         } catch (InterruptedException | ExecutionException e) {
395             LOG.warn("Exception when releasing Id for key {}", idKey, e);
396         }
397     }
398
399     public static BigInteger getDpnId(DatapathId datapathId){
400         if (datapathId != null) {
401             // Adding logs for a random issue spotted during datapath id conversion
402             String dpIdStr = datapathId.getValue().replace(":", "");
403             BigInteger dpnId =  new BigInteger(dpIdStr, 16);
404             return dpnId;
405         }
406         return null;
407     }
408
409     public static NodeConnectorId getNodeConnectorIdFromInterface(String interfaceName, DataBroker dataBroker) {
410         return FlowBasedServicesUtils.getNodeConnectorIdFromInterface(interfaceName, dataBroker);
411     }
412
413     public static String getPortName(DataBroker dataBroker, NodeConnectorId ncId){
414         InstanceIdentifier<NodeConnector> ncIdentifier =
415                 InstanceIdentifier.builder(Nodes.class)
416                         .child(Node.class, new NodeKey(getNodeIdFromNodeConnectorId(ncId)))
417                         .child(NodeConnector.class, new NodeConnectorKey(ncId)).build();
418         Optional<NodeConnector> optNc = read(LogicalDatastoreType.OPERATIONAL, ncIdentifier, dataBroker);
419         if(optNc.isPresent()) {
420             NodeConnector nc = optNc.get();
421             FlowCapableNodeConnector fcnc = nc.getAugmentation(FlowCapableNodeConnector.class);
422             return fcnc.getName();
423         }
424         return null;
425     }
426
427     public static NodeConnectorId getNodeConnectorIdFromInterface(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface ifState){
428         if(ifState != null) {
429             List<String> ofportIds = ifState.getLowerLayerIf();
430             return new NodeConnectorId(ofportIds.get(0));
431         }
432         return null;
433     }
434
435     public static InterfaceInfo.InterfaceType getInterfaceType(Interface iface) {
436         InterfaceInfo.InterfaceType interfaceType = org.opendaylight.genius.interfacemanager.globals.InterfaceInfo.InterfaceType.UNKNOWN_INTERFACE;
437         Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType> ifType = iface
438                 .getType();
439
440         if (ifType.isAssignableFrom(L2vlan.class)) {
441             interfaceType = VLAN_INTERFACE;
442         } else if (ifType.isAssignableFrom(Tunnel.class)) {
443             IfTunnel ifTunnel = iface.getAugmentation(IfTunnel.class);
444             Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeBase> tunnelType = ifTunnel
445                     .getTunnelInterfaceType();
446             interfaceType = TUNNEL_TYPE_MAP.get(tunnelType);
447         }
448         return interfaceType;
449     }
450
451     public static VlanInterfaceInfo getVlanInterfaceInfo(String interfaceName, Interface iface, BigInteger dpId) {
452
453         short vlanId = 0;
454         String portName = null;
455         IfL2vlan vlanIface = iface.getAugmentation(IfL2vlan.class);
456         ParentRefs parentRefs = iface.getAugmentation(ParentRefs.class);
457         if (parentRefs != null && parentRefs.getParentInterface() != null) {
458             portName = parentRefs.getParentInterface();
459         }else {
460             LOG.warn("Portname set to null since parentRef is Null");
461         }
462         VlanInterfaceInfo vlanInterfaceInfo = new VlanInterfaceInfo(dpId, portName, vlanId);
463
464         if (vlanIface != null) {
465             vlanId = vlanIface.getVlanId() == null ? 0 : vlanIface.getVlanId().getValue().shortValue();
466             L2vlanMode l2VlanMode = vlanIface.getL2vlanMode();
467
468             if (l2VlanMode == L2vlanMode.Transparent) {
469                 vlanInterfaceInfo.setVlanTransparent(true);
470             }
471             if (l2VlanMode == L2vlanMode.NativeUntagged) {
472                 vlanInterfaceInfo.setUntaggedVlan(true);
473             }
474             vlanInterfaceInfo.setVlanId(vlanId);
475
476         }
477         return vlanInterfaceInfo;
478     }
479
480     public static void bindService(WriteTransaction t, String interfaceName, BoundServices serviceInfo,
481                                    Class<? extends ServiceModeBase> serviceMode){
482         LOG.info("Binding Service {} for : {}", serviceInfo.getServiceName(), interfaceName);
483         InstanceIdentifier<BoundServices> boundServicesInstanceIdentifier = InstanceIdentifier.builder(ServiceBindings.class)
484                 .child(ServicesInfo.class, new ServicesInfoKey(interfaceName, serviceMode))
485                 .child(BoundServices.class, new BoundServicesKey(serviceInfo.getServicePriority())).build();
486         t.put(LogicalDatastoreType.CONFIGURATION, boundServicesInstanceIdentifier, serviceInfo, true);
487     }
488
489     public static void unbindService(DataBroker dataBroker, String interfaceName, InstanceIdentifier<BoundServices>
490             boundServicesInstanceIdentifier, Class<? extends ServiceModeBase> serviceMode){
491         LOG.info("Unbinding Service from : {}", interfaceName);
492         DataStoreJobCoordinator dataStoreJobCoordinator = DataStoreJobCoordinator.getInstance();
493         dataStoreJobCoordinator.enqueueJob(interfaceName,
494                 () -> {
495                     WriteTransaction t = dataBroker.newWriteOnlyTransaction();
496                     t.delete(LogicalDatastoreType.CONFIGURATION, boundServicesInstanceIdentifier);
497                     List<ListenableFuture<Void>> futures = new ArrayList<>();
498                     futures.add(t.submit());
499                     return futures;
500                 }
501         );
502     }
503 }