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.globals.InterfaceInfo;
22 import org.opendaylight.vpnservice.interfacemgr.globals.VlanInterfaceInfo;
23 import org.opendaylight.vpnservice.interfacemgr.servicebindings.flowbased.utilities.FlowBasedServicesUtils;
24 import org.opendaylight.vpnservice.mdsalutil.MDSALUtil;
25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.L2vlan;
26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.Tunnel;
27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteMetadataCase;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.write.metadata._case.WriteMetadata;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.overlay.rev150105.TunnelTypeBase;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.overlay.rev150105.TunnelTypeGre;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.overlay.rev150105.TunnelTypeVxlan;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathId;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.alivenessmonitor.rev150629.*;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.alivenessmonitor.rev150629.monitor.profile.create.input.ProfileBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdInput;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdInputBuilder;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdOutput;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.IdManagerService;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.IdPools;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.ReleaseIdInput;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.ReleaseIdInputBuilder;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.id.pools.IdPool;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.id.pools.IdPoolKey;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.InterfaceMonitorIdMap;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.MonitorIdInterfaceMap;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._interface.monitor.id.map.InterfaceMonitorId;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._interface.monitor.id.map.InterfaceMonitorIdBuilder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._interface.monitor.id.map.InterfaceMonitorIdKey;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.monitor.id._interface.map.MonitorIdInterface;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.monitor.id._interface.map.MonitorIdInterfaceBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.monitor.id._interface.map.MonitorIdInterfaceKey;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.IfL2vlan.L2vlanMode;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.IfTunnel;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.IfL2vlan;
62 import org.opendaylight.yangtools.yang.binding.DataObject;
63 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
64 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
65 import org.opendaylight.yangtools.yang.common.RpcResult;
66 import org.slf4j.Logger;
67 import org.slf4j.LoggerFactory;
69 public class IfmUtil {
70 private static final Logger LOG = LoggerFactory.getLogger(IfmUtil.class);
71 private static final int INVALID_ID = 0;
72 public static String getDpnFromNodeConnectorId(NodeConnectorId portId) {
74 * NodeConnectorId is of form 'openflow:dpnid:portnum'
76 String[] split = portId.getValue().split(IfmConstants.OF_URI_SEPARATOR);
80 public static String getPortNoFromNodeConnectorId(NodeConnectorId portId) {
82 * NodeConnectorId is of form 'openflow:dpnid:portnum'
84 String[] split = portId.getValue().split(IfmConstants.OF_URI_SEPARATOR);
88 public static NodeId buildDpnNodeId(BigInteger dpnId) {
89 return new NodeId(IfmConstants.OF_URI_PREFIX + dpnId);
92 public static InstanceIdentifier<Interface> buildId(String interfaceName) {
93 //TODO Make this generic and move to AbstractDataChangeListener or Utils.
94 InstanceIdentifierBuilder<Interface> idBuilder =
95 InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new InterfaceKey(interfaceName));
96 InstanceIdentifier<Interface> id = idBuilder.build();
100 public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> buildStateInterfaceId(String interfaceName) {
101 InstanceIdentifierBuilder<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> idBuilder =
102 InstanceIdentifier.builder(InterfacesState.class)
103 .child(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.class,
104 new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey(interfaceName));
105 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> id = idBuilder.build();
109 public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey getStateInterfaceKeyFromName(
111 return new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey(name);
114 public static InstanceIdentifier<IdPool> getPoolId(String poolName){
115 InstanceIdentifier.InstanceIdentifierBuilder<IdPool> idBuilder =
116 InstanceIdentifier.builder(IdPools.class).child(IdPool.class, new IdPoolKey(poolName));
117 InstanceIdentifier<IdPool> id = idBuilder.build();
121 public static List<String> getPortNameAndSuffixFromInterfaceName(String intfName) {
122 List<String> strList = new ArrayList<>(2);
123 int index = intfName.indexOf(":");
125 strList.add(0, intfName.substring(0, index));
126 strList.add(1, intfName.substring(index));
131 public static long getGroupId(long ifIndex, InterfaceInfo.InterfaceType infType) {
132 if (infType == InterfaceInfo.InterfaceType.LOGICAL_GROUP_INTERFACE) {
133 return ifIndex + IfmConstants.LOGICAL_GROUP_START;
135 else if (infType == InterfaceInfo.InterfaceType.VLAN_INTERFACE) {
136 return ifIndex + IfmConstants.VLAN_GROUP_START;
138 return ifIndex + IfmConstants.TRUNK_GROUP_START;
142 public static List<String> getDpIdPortNameAndSuffixFromInterfaceName(String intfName) {
143 List<String> strList = new ArrayList<>(3);
144 int index1 = intfName.indexOf(":");
146 int index2 = intfName.indexOf(":", index1 + 1 );
147 strList.add(0, intfName.substring(0, index1));
149 strList.add(1, intfName.substring(index1, index2));
150 strList.add(2, intfName.substring(index2));
152 strList.add(1, intfName.substring(index1));
159 public static <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType,
160 InstanceIdentifier<T> path, DataBroker broker) {
162 ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
164 Optional<T> result = Optional.absent();
166 result = tx.read(datastoreType, path).get();
167 } catch (Exception e) {
168 throw new RuntimeException(e);
174 public static NodeId getNodeIdFromNodeConnectorId(NodeConnectorId ncId) {
175 return new NodeId(ncId.getValue().substring(0,ncId.getValue().lastIndexOf(":")));
178 public static BigInteger[] mergeOpenflowMetadataWriteInstructions(List<Instruction> instructions) {
179 BigInteger metadata = new BigInteger("0", 16);
180 BigInteger metadataMask = new BigInteger("0", 16);
181 if (instructions != null && !instructions.isEmpty()) {
182 // check if metadata write instruction is present
183 for (Instruction instruction : instructions) {
184 org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.Instruction actualInstruction = instruction.getInstruction();
185 if (actualInstruction instanceof WriteMetadataCase) {
186 WriteMetadataCase writeMetaDataInstruction = (WriteMetadataCase) actualInstruction ;
187 WriteMetadata availableMetaData = writeMetaDataInstruction.getWriteMetadata();
188 metadata = metadata.or(availableMetaData.getMetadata());
189 metadataMask = metadataMask.or(availableMetaData.getMetadataMask());
193 return new BigInteger[] { metadata, metadataMask };
196 public static Integer allocateId(IdManagerService idManager, String poolName, String idKey) {
197 AllocateIdInput getIdInput = new AllocateIdInputBuilder()
198 .setPoolName(poolName)
199 .setIdKey(idKey).build();
201 Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
202 RpcResult<AllocateIdOutput> rpcResult = result.get();
203 if(rpcResult.isSuccessful()) {
204 return rpcResult.getResult().getIdValue().intValue();
206 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
208 } catch (InterruptedException | ExecutionException e) {
209 LOG.warn("Exception when getting Unique Id",e);
214 public static void releaseId(IdManagerService idManager, String poolName, String idKey) {
215 ReleaseIdInput idInput = new ReleaseIdInputBuilder()
216 .setPoolName(poolName)
217 .setIdKey(idKey).build();
219 Future<RpcResult<Void>> result = idManager.releaseId(idInput);
220 RpcResult<Void> rpcResult = result.get();
221 if(!rpcResult.isSuccessful()) {
222 LOG.warn("RPC Call to release Id {} with Key {} returned with Errors {}",
223 idKey, rpcResult.getErrors());
225 } catch (InterruptedException | ExecutionException e) {
226 LOG.warn("Exception when releasing Id for key {}", idKey, e);
230 public static BigInteger getDpnId(DatapathId datapathId){
231 if (datapathId != null) {
232 String dpIdStr = datapathId.getValue().replace(":", "");
233 return new BigInteger(dpIdStr, 16);
238 public static NodeConnectorId getNodeConnectorIdFromInterface(Interface iface, DataBroker dataBroker) {
239 return FlowBasedServicesUtils.getNodeConnectorIdFromInterface(iface, dataBroker);
242 public static InterfaceInfo.InterfaceType getInterfaceType(Interface iface) {
243 InterfaceInfo.InterfaceType interfaceType =
244 org.opendaylight.vpnservice.interfacemgr.globals.InterfaceInfo.InterfaceType.UNKNOWN_INTERFACE;
245 Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType> ifType = iface.getType();
247 if (ifType.isAssignableFrom(L2vlan.class)) {
248 interfaceType = org.opendaylight.vpnservice.interfacemgr.globals.InterfaceInfo.InterfaceType.VLAN_INTERFACE;
249 } else if (ifType.isAssignableFrom(Tunnel.class)) {
250 IfTunnel ifTunnel = iface.getAugmentation(IfTunnel.class);
251 Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.TunnelTypeBase> tunnelType = ifTunnel.getTunnelInterfaceType();
252 if (tunnelType.isAssignableFrom(TunnelTypeVxlan.class)) {
253 interfaceType = InterfaceInfo.InterfaceType.VXLAN_TRUNK_INTERFACE;
254 } else if (tunnelType.isAssignableFrom(TunnelTypeGre.class)) {
255 interfaceType = InterfaceInfo.InterfaceType.GRE_TRUNK_INTERFACE;
258 // TODO: Check if the below condition is still needed/valid
259 //else if (ifType.isAssignableFrom(InterfaceGroup.class)) {
260 // interfaceType = org.opendaylight.vpnservice.interfacemgr.globals.InterfaceInfo.InterfaceType.LOGICAL_GROUP_INTERFACE;
262 return interfaceType;
265 public static VlanInterfaceInfo getVlanInterfaceInfo(String interfaceName, Interface iface, BigInteger dpId){
266 IfL2vlan vlanIface = iface.getAugmentation(IfL2vlan.class);
269 //FIXME :Use this below thing properly
270 VlanInterfaceInfo vlanInterfaceInfo = new VlanInterfaceInfo(dpId, "someString", vlanId);
272 if (vlanIface != null) {
273 vlanId = vlanIface.getVlanId() == null ? 0 : vlanIface.getVlanId().getValue().shortValue();
274 L2vlanMode l2VlanMode = vlanIface.getL2vlanMode();
276 if (l2VlanMode == L2vlanMode.Transparent) {
277 vlanInterfaceInfo.setVlanTransparent(true);
279 if (l2VlanMode == L2vlanMode.NativeUntagged) {
280 vlanInterfaceInfo.setUntaggedVlan(true);
282 vlanInterfaceInfo.setVlanId(vlanId);
285 return vlanInterfaceInfo;