2 * Copyright (c) 2015 - 2016 Ericsson India Global Services Pvt Ltd. and others. All rights reserved.
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
8 package org.opendaylight.vpnservice.interfacemgr;
10 import java.math.BigInteger;
11 import java.util.ArrayList;
12 import java.util.List;
13 import java.util.concurrent.ExecutionException;
14 import java.util.concurrent.Future;
16 import com.google.common.base.Optional;
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.common.api.data.LogicalDatastoreType;
21 import org.opendaylight.vpnservice.interfacemgr.commons.InterfaceManagerCommonUtils;
22 import org.opendaylight.vpnservice.interfacemgr.globals.InterfaceInfo;
23 import org.opendaylight.vpnservice.interfacemgr.globals.VlanInterfaceInfo;
24 import org.opendaylight.vpnservice.interfacemgr.servicebindings.flowbased.utilities.FlowBasedServicesUtils;
25 import org.opendaylight.vpnservice.mdsalutil.MDSALUtil;
26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.L2vlan;
27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.Tunnel;
28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteMetadataCase;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.write.metadata._case.WriteMetadata;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.overlay.rev150105.TunnelTypeBase;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.overlay.rev150105.TunnelTypeGre;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.overlay.rev150105.TunnelTypeVxlan;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathId;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.alivenessmonitor.rev150629.*;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.alivenessmonitor.rev150629.monitor.profile.create.input.ProfileBuilder;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdInput;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdInputBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdOutput;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.IdManagerService;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.IdPools;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.ReleaseIdInput;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.ReleaseIdInputBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.id.pools.IdPool;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.id.pools.IdPoolKey;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.InterfaceMonitorIdMap;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.MonitorIdInterfaceMap;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._interface.monitor.id.map.InterfaceMonitorId;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._interface.monitor.id.map.InterfaceMonitorIdBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._interface.monitor.id.map.InterfaceMonitorIdKey;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.monitor.id._interface.map.MonitorIdInterface;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.monitor.id._interface.map.MonitorIdInterfaceBuilder;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.monitor.id._interface.map.MonitorIdInterfaceKey;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.IfL2vlan.L2vlanMode;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.IfTunnel;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.IfL2vlan;
63 import org.opendaylight.yangtools.yang.binding.DataObject;
64 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
65 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
66 import org.opendaylight.yangtools.yang.common.RpcResult;
67 import org.slf4j.Logger;
68 import org.slf4j.LoggerFactory;
70 public class IfmUtil {
71 private static final Logger LOG = LoggerFactory.getLogger(IfmUtil.class);
72 private static final int INVALID_ID = 0;
73 public static String getDpnFromNodeConnectorId(NodeConnectorId portId) {
75 * NodeConnectorId is of form 'openflow:dpnid:portnum'
77 String[] split = portId.getValue().split(IfmConstants.OF_URI_SEPARATOR);
81 public static String getPortNoFromNodeConnectorId(NodeConnectorId portId) {
83 * NodeConnectorId is of form 'openflow:dpnid:portnum'
85 String[] split = portId.getValue().split(IfmConstants.OF_URI_SEPARATOR);
89 public static NodeId buildDpnNodeId(BigInteger dpnId) {
90 return new NodeId(IfmConstants.OF_URI_PREFIX + dpnId);
93 public static InstanceIdentifier<Interface> buildId(String interfaceName) {
94 //TODO Make this generic and move to AbstractDataChangeListener or Utils.
95 InstanceIdentifierBuilder<Interface> idBuilder =
96 InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new InterfaceKey(interfaceName));
97 InstanceIdentifier<Interface> id = idBuilder.build();
101 public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> buildStateInterfaceId(String interfaceName) {
102 InstanceIdentifierBuilder<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> idBuilder =
103 InstanceIdentifier.builder(InterfacesState.class)
104 .child(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.class,
105 new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey(interfaceName));
106 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> id = idBuilder.build();
110 public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey getStateInterfaceKeyFromName(
112 return new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey(name);
115 public static InstanceIdentifier<IdPool> getPoolId(String poolName){
116 InstanceIdentifier.InstanceIdentifierBuilder<IdPool> idBuilder =
117 InstanceIdentifier.builder(IdPools.class).child(IdPool.class, new IdPoolKey(poolName));
118 InstanceIdentifier<IdPool> id = idBuilder.build();
122 public static List<String> getPortNameAndSuffixFromInterfaceName(String intfName) {
123 List<String> strList = new ArrayList<>(2);
124 int index = intfName.indexOf(":");
126 strList.add(0, intfName.substring(0, index));
127 strList.add(1, intfName.substring(index));
132 public static long getGroupId(long ifIndex, InterfaceInfo.InterfaceType infType) {
133 if (infType == InterfaceInfo.InterfaceType.LOGICAL_GROUP_INTERFACE) {
134 return ifIndex + IfmConstants.LOGICAL_GROUP_START;
136 else if (infType == InterfaceInfo.InterfaceType.VLAN_INTERFACE) {
137 return ifIndex + IfmConstants.VLAN_GROUP_START;
139 return ifIndex + IfmConstants.TRUNK_GROUP_START;
143 public static List<String> getDpIdPortNameAndSuffixFromInterfaceName(String intfName) {
144 List<String> strList = new ArrayList<>(3);
145 int index1 = intfName.indexOf(":");
147 int index2 = intfName.indexOf(":", index1 + 1 );
148 strList.add(0, intfName.substring(0, index1));
150 strList.add(1, intfName.substring(index1, index2));
151 strList.add(2, intfName.substring(index2));
153 strList.add(1, intfName.substring(index1));
160 public static <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType,
161 InstanceIdentifier<T> path, DataBroker broker) {
163 ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
165 Optional<T> result = Optional.absent();
167 result = tx.read(datastoreType, path).get();
168 } catch (Exception e) {
169 throw new RuntimeException(e);
175 public static NodeId getNodeIdFromNodeConnectorId(NodeConnectorId ncId) {
176 return new NodeId(ncId.getValue().substring(0,ncId.getValue().lastIndexOf(":")));
179 public static BigInteger[] mergeOpenflowMetadataWriteInstructions(List<Instruction> instructions) {
180 BigInteger metadata = new BigInteger("0", 16);
181 BigInteger metadataMask = new BigInteger("0", 16);
182 if (instructions != null && !instructions.isEmpty()) {
183 // check if metadata write instruction is present
184 for (Instruction instruction : instructions) {
185 org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.Instruction actualInstruction = instruction.getInstruction();
186 if (actualInstruction instanceof WriteMetadataCase) {
187 WriteMetadataCase writeMetaDataInstruction = (WriteMetadataCase) actualInstruction ;
188 WriteMetadata availableMetaData = writeMetaDataInstruction.getWriteMetadata();
189 metadata = metadata.or(availableMetaData.getMetadata());
190 metadataMask = metadataMask.or(availableMetaData.getMetadataMask());
194 return new BigInteger[] { metadata, metadataMask };
197 public static Integer allocateId(IdManagerService idManager, String poolName, String idKey) {
198 AllocateIdInput getIdInput = new AllocateIdInputBuilder()
199 .setPoolName(poolName)
200 .setIdKey(idKey).build();
202 Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
203 RpcResult<AllocateIdOutput> rpcResult = result.get();
204 if(rpcResult.isSuccessful()) {
205 return rpcResult.getResult().getIdValue().intValue();
207 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
209 } catch (InterruptedException | ExecutionException e) {
210 LOG.warn("Exception when getting Unique Id",e);
215 public static void releaseId(IdManagerService idManager, String poolName, String idKey) {
216 ReleaseIdInput idInput = new ReleaseIdInputBuilder()
217 .setPoolName(poolName)
218 .setIdKey(idKey).build();
220 Future<RpcResult<Void>> result = idManager.releaseId(idInput);
221 RpcResult<Void> rpcResult = result.get();
222 if(!rpcResult.isSuccessful()) {
223 LOG.warn("RPC Call to release Id {} with Key {} returned with Errors {}",
224 idKey, rpcResult.getErrors());
226 } catch (InterruptedException | ExecutionException e) {
227 LOG.warn("Exception when releasing Id for key {}", idKey, e);
231 public static BigInteger getDpnId(DatapathId datapathId){
232 if (datapathId != null) {
233 // Adding logs for a random issue spotted during datapath id conversion
234 LOG.info("Received datapathId {}",datapathId.getValue());
235 String dpIdStr = datapathId.getValue().replace(":", "");
236 LOG.info("Received datapathId {}",dpIdStr);
237 BigInteger dpnId = new BigInteger(dpIdStr, 16);
238 LOG.info("After conversion datapathId {}",dpnId);
244 public static NodeConnectorId getNodeConnectorIdFromInterface(Interface iface, DataBroker dataBroker) {
245 return FlowBasedServicesUtils.getNodeConnectorIdFromInterface(iface, dataBroker);
248 public static NodeConnectorId getNodeConnectorIdFromInterface(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface ifState){
249 if(ifState != null) {
250 List<String> ofportIds = ifState.getLowerLayerIf();
251 return new NodeConnectorId(ofportIds.get(0));
256 public static InterfaceInfo.InterfaceType getInterfaceType(Interface iface) {
257 InterfaceInfo.InterfaceType interfaceType =
258 org.opendaylight.vpnservice.interfacemgr.globals.InterfaceInfo.InterfaceType.UNKNOWN_INTERFACE;
259 Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType> ifType = iface.getType();
261 if (ifType.isAssignableFrom(L2vlan.class)) {
262 interfaceType = org.opendaylight.vpnservice.interfacemgr.globals.InterfaceInfo.InterfaceType.VLAN_INTERFACE;
263 } else if (ifType.isAssignableFrom(Tunnel.class)) {
264 IfTunnel ifTunnel = iface.getAugmentation(IfTunnel.class);
265 Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.TunnelTypeBase> tunnelType = ifTunnel.getTunnelInterfaceType();
266 if (tunnelType.isAssignableFrom(TunnelTypeVxlan.class)) {
267 interfaceType = InterfaceInfo.InterfaceType.VXLAN_TRUNK_INTERFACE;
268 } else if (tunnelType.isAssignableFrom(TunnelTypeGre.class)) {
269 interfaceType = InterfaceInfo.InterfaceType.GRE_TRUNK_INTERFACE;
272 // TODO: Check if the below condition is still needed/valid
273 //else if (ifType.isAssignableFrom(InterfaceGroup.class)) {
274 // interfaceType = org.opendaylight.vpnservice.interfacemgr.globals.InterfaceInfo.InterfaceType.LOGICAL_GROUP_INTERFACE;
276 return interfaceType;
279 public static VlanInterfaceInfo getVlanInterfaceInfo(String interfaceName, Interface iface, BigInteger dpId){
280 IfL2vlan vlanIface = iface.getAugmentation(IfL2vlan.class);
283 //FIXME :Use this below thing properly
284 VlanInterfaceInfo vlanInterfaceInfo = new VlanInterfaceInfo(dpId, "someString", vlanId);
286 if (vlanIface != null) {
287 vlanId = vlanIface.getVlanId() == null ? 0 : vlanIface.getVlanId().getValue().shortValue();
288 L2vlanMode l2VlanMode = vlanIface.getL2vlanMode();
290 if (l2VlanMode == L2vlanMode.Transparent) {
291 vlanInterfaceInfo.setVlanTransparent(true);
293 if (l2VlanMode == L2vlanMode.NativeUntagged) {
294 vlanInterfaceInfo.setUntaggedVlan(true);
296 vlanInterfaceInfo.setVlanId(vlanId);
299 return vlanInterfaceInfo;