2 * Copyright (c) 2015 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;
17 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
18 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
19 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteMetadataCase;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.write.metadata._case.WriteMetadata;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdInput;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdInputBuilder;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdOutput;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.IdManagerService;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.IdPools;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.ReleaseIdInput;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.ReleaseIdInputBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.id.pools.IdPool;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.id.pools.IdPoolKey;
38 import org.opendaylight.yangtools.yang.binding.DataObject;
39 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
40 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
41 import org.opendaylight.yangtools.yang.common.RpcResult;
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
45 public class IfmUtil {
46 private static final Logger LOG = LoggerFactory.getLogger(IfmUtil.class);
47 private static final int INVALID_ID = 0;
48 public static String getDpnFromNodeConnectorId(NodeConnectorId portId) {
50 * NodeConnectorId is of form 'openflow:dpnid:portnum'
52 String[] split = portId.getValue().split(IfmConstants.OF_URI_SEPARATOR);
56 public static String getPortNoFromNodeConnectorId(NodeConnectorId portId) {
58 * NodeConnectorId is of form 'openflow:dpnid:portnum'
60 String[] split = portId.getValue().split(IfmConstants.OF_URI_SEPARATOR);
64 public static NodeId buildDpnNodeId(BigInteger dpnId) {
65 return new NodeId(IfmConstants.OF_URI_PREFIX + dpnId);
68 public static InstanceIdentifier<Interface> buildId(String interfaceName) {
69 //TODO Make this generic and move to AbstractDataChangeListener or Utils.
70 InstanceIdentifierBuilder<Interface> idBuilder =
71 InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new InterfaceKey(interfaceName));
72 InstanceIdentifier<Interface> id = idBuilder.build();
76 public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> buildStateInterfaceId(String interfaceName) {
77 InstanceIdentifierBuilder<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> idBuilder =
78 InstanceIdentifier.builder(InterfacesState.class)
79 .child(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.class,
80 new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey(interfaceName));
81 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> id = idBuilder.build();
85 public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey getStateInterfaceKeyFromName(
87 return new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey(name);
90 public static InstanceIdentifier<IdPool> getPoolId(String poolName){
91 InstanceIdentifier.InstanceIdentifierBuilder<IdPool> idBuilder =
92 InstanceIdentifier.builder(IdPools.class).child(IdPool.class, new IdPoolKey(poolName));
93 InstanceIdentifier<IdPool> id = idBuilder.build();
97 public static List<String> getPortNameAndSuffixFromInterfaceName(String intfName) {
98 List<String> strList = new ArrayList<>(2);
99 int index = intfName.indexOf(":");
101 strList.add(0, intfName.substring(0, index));
102 strList.add(1, intfName.substring(index));
107 public static List<String> getDpIdPortNameAndSuffixFromInterfaceName(String intfName) {
108 List<String> strList = new ArrayList<>(3);
109 int index1 = intfName.indexOf(":");
111 int index2 = intfName.indexOf(":", index1 + 1 );
112 strList.add(0, intfName.substring(0, index1));
114 strList.add(1, intfName.substring(index1, index2));
115 strList.add(2, intfName.substring(index2));
117 strList.add(1, intfName.substring(index1));
124 public static <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType,
125 InstanceIdentifier<T> path, DataBroker broker) {
127 ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
129 Optional<T> result = Optional.absent();
131 result = tx.read(datastoreType, path).get();
132 } catch (Exception e) {
133 throw new RuntimeException(e);
139 public static NodeId getNodeIdFromNodeConnectorId(NodeConnectorId ncId) {
140 return new NodeId(ncId.getValue().substring(0,ncId.getValue().lastIndexOf(":")));
143 public static BigInteger[] mergeOpenflowMetadataWriteInstructions(List<Instruction> instructions) {
144 BigInteger metadata = new BigInteger("0", 16);
145 BigInteger metadataMask = new BigInteger("0", 16);
146 if (instructions != null && !instructions.isEmpty()) {
147 // check if metadata write instruction is present
148 for (Instruction instruction : instructions) {
149 org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.Instruction actualInstruction = instruction.getInstruction();
150 if (actualInstruction instanceof WriteMetadataCase) {
151 WriteMetadataCase writeMetaDataInstruction = (WriteMetadataCase) actualInstruction ;
152 WriteMetadata availableMetaData = writeMetaDataInstruction.getWriteMetadata();
153 metadata = metadata.or(availableMetaData.getMetadata());
154 metadataMask = metadataMask.or(availableMetaData.getMetadataMask());
158 return new BigInteger[] { metadata, metadataMask };
161 public static Integer allocateId(IdManagerService idManager, String poolName, String idKey) {
162 AllocateIdInput getIdInput = new AllocateIdInputBuilder()
163 .setPoolName(poolName)
164 .setIdKey(idKey).build();
166 Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
167 RpcResult<AllocateIdOutput> rpcResult = result.get();
168 if(rpcResult.isSuccessful()) {
169 return rpcResult.getResult().getIdValue().intValue();
171 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
173 } catch (InterruptedException | ExecutionException e) {
174 LOG.warn("Exception when getting Unique Id",e);
179 public static void releaseId(IdManagerService idManager, String poolName, String idKey) {
180 ReleaseIdInput idInput = new ReleaseIdInputBuilder()
181 .setPoolName(poolName)
182 .setIdKey(idKey).build();
184 Future<RpcResult<Void>> result = idManager.releaseId(idInput);
185 RpcResult<Void> rpcResult = result.get();
186 if(!rpcResult.isSuccessful()) {
187 LOG.warn("RPC Call to release Id {} with Key {} returned with Errors {}",
188 idKey, rpcResult.getErrors());
190 } catch (InterruptedException | ExecutionException e) {
191 LOG.warn("Exception when releasing Id for key {}", idKey, e);