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
9 package org.opendaylight.vpnservice;
11 import java.math.BigInteger;
12 import java.util.concurrent.ExecutionException;
13 import java.util.concurrent.Future;
14 import java.util.List;
16 import com.google.common.base.Optional;
17 import com.google.common.util.concurrent.CheckedFuture;
18 import com.google.common.util.concurrent.FutureCallback;
19 import com.google.common.util.concurrent.Futures;
21 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
22 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
23 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
24 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
25 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
26 import org.opendaylight.vpnservice.mdsalutil.NwConstants;
27 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
28 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
29 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
30 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstanceKey;
31 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
32 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
33 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceBuilder;
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.interfaces.Interface;
36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.*;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.adjacency.list.Adjacency;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.Adjacencies;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.AdjacenciesBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.prefix.to._interface.VpnIds;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.prefix.to._interface.VpnIdsKey;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.prefix.to._interface.vpn.ids.Prefixes;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesKey;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnList;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnListKey;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.to.extraroute.Vpn;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.to.extraroute.VpnKey;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.to.extraroute.vpn.Extraroute;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.to.extraroute.vpn.ExtrarouteBuilder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.to.extraroute.vpn.ExtrarouteKey;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.IdPools;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.id.pools.IdPool;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.id.pools.IdPoolKey;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdInput;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdInputBuilder;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdOutput;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.ReleaseIdInput;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.ReleaseIdInputBuilder;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.IdManagerService;
65 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
66 import org.opendaylight.yangtools.yang.common.RpcResult;
67 import org.opendaylight.yangtools.yang.binding.DataObject;
68 import org.slf4j.Logger;
69 import org.slf4j.LoggerFactory;
71 public class VpnUtil {
72 private static final Logger LOG = LoggerFactory.getLogger(VpnUtil.class);
73 private static final int DEFAULT_PREFIX_LENGTH = 32;
74 private static final String PREFIX_SEPARATOR = "/";
76 static InstanceIdentifier<VpnInterface> getVpnInterfaceIdentifier(String vpnInterfaceName) {
77 return InstanceIdentifier.builder(VpnInterfaces.class)
78 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName)).build();
81 static InstanceIdentifier<VpnInstance> getVpnInstanceIdentifier(String vpnName) {
82 return InstanceIdentifier.builder(VpnInstances.class)
83 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
86 static VpnInterface getVpnInterface(String intfName, String vpnName, Adjacencies aug) {
87 return new VpnInterfaceBuilder().setKey(new VpnInterfaceKey(intfName)).setVpnInstanceName(
89 .addAugmentation(Adjacencies.class, aug).build();
92 static InstanceIdentifier<Prefixes> getPrefixToInterfaceIdentifier(long vpnId, String ipPrefix) {
93 return InstanceIdentifier.builder(PrefixToInterface.class)
94 .child(VpnIds.class, new VpnIdsKey(vpnId)).child(Prefixes.class,
95 new PrefixesKey(ipPrefix)).build();
98 static Prefixes getPrefixToInterface(BigInteger dpId, String vpnInterfaceName, String ipPrefix) {
99 return new PrefixesBuilder().setDpnId(dpId).setVpnInterfaceName(
100 vpnInterfaceName).setIpAddress(ipPrefix).build();
103 static InstanceIdentifier<Extraroute> getVpnToExtrarouteIdentifier(String vrfId, String ipPrefix) {
104 return InstanceIdentifier.builder(VpnToExtraroute.class)
105 .child(Vpn.class, new VpnKey(vrfId)).child(Extraroute.class,
106 new ExtrarouteKey(ipPrefix)).build();
109 static Extraroute getVpnToExtraroute(String ipPrefix, String nextHop) {
110 return new ExtrarouteBuilder().setPrefix(ipPrefix).setNexthopIp(nextHop).build();
114 getVpnInterfaceAugmentation(List<Adjacency> nextHops) {
115 return new AdjacenciesBuilder().setAdjacency(nextHops).build();
118 public static InstanceIdentifier<IdPool> getPoolId(String poolName){
119 InstanceIdentifier.InstanceIdentifierBuilder<IdPool> idBuilder =
120 InstanceIdentifier.builder(IdPools.class).child(IdPool.class, new IdPoolKey(poolName));
121 InstanceIdentifier<IdPool> id = idBuilder.build();
125 static InstanceIdentifier<VpnInterfaces> getVpnInterfacesIdentifier() {
126 return InstanceIdentifier.builder(VpnInterfaces.class).build();
129 static InstanceIdentifier<Interface> getInterfaceIdentifier(String interfaceName) {
130 return InstanceIdentifier.builder(Interfaces.class)
131 .child(Interface.class, new InterfaceKey(interfaceName)).build();
134 static InstanceIdentifier<VpnToDpnList> getVpnToDpnListIdentifier(String rd, BigInteger dpnId) {
135 return InstanceIdentifier.builder(VpnInstanceOpData.class)
136 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd))
137 .child(VpnToDpnList.class, new VpnToDpnListKey(dpnId)).build();
140 public static BigInteger getCookieArpFlow(int interfaceTag) {
141 return VpnConstants.COOKIE_L3_BASE.add(new BigInteger("0110000", 16)).add(
142 BigInteger.valueOf(interfaceTag));
145 public static String getFlowRef(BigInteger dpnId, short tableId, int ethType, int lPortTag, int arpType) {
146 return new StringBuffer().append(VpnConstants.FLOWID_PREFIX).append(dpnId).append(NwConstants.FLOWID_SEPARATOR)
147 .append(tableId).append(NwConstants.FLOWID_SEPARATOR).append(ethType).append(lPortTag)
148 .append(NwConstants.FLOWID_SEPARATOR).append(arpType).toString();
151 public static int getUniqueId(IdManagerService idManager, String poolName,String idKey) {
152 AllocateIdInput getIdInput = new AllocateIdInputBuilder()
153 .setPoolName(poolName)
154 .setIdKey(idKey).build();
157 Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
158 RpcResult<AllocateIdOutput> rpcResult = result.get();
159 if(rpcResult.isSuccessful()) {
160 return rpcResult.getResult().getIdValue().intValue();
162 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
164 } catch (InterruptedException | ExecutionException e) {
165 LOG.warn("Exception when getting Unique Id",e);
170 public static void releaseId(IdManagerService idManager, String poolName, String idKey) {
171 ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
173 Future<RpcResult<Void>> result = idManager.releaseId(idInput);
174 RpcResult<Void> rpcResult = result.get();
175 if(!rpcResult.isSuccessful()) {
176 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
178 } catch (InterruptedException | ExecutionException e) {
179 LOG.warn("Exception when getting Unique Id for key {}", idKey, e);
183 public static String getNextHopLabelKey(String rd, String prefix){
184 String key = rd + VpnConstants.SEPARATOR + prefix;
188 public static long getVpnId(DataBroker broker, String vpnName) {
190 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance> id
191 = getVpnInstanceToVpnIdIdentifier(vpnName);
192 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance> vpnInstance
193 = read(broker, LogicalDatastoreType.CONFIGURATION, id);
195 long vpnId = VpnConstants.INVALID_ID;
196 if(vpnInstance.isPresent()) {
197 vpnId = vpnInstance.get().getVpnId();
202 public static String getVpnRd(DataBroker broker, String vpnName) {
204 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance> id
205 = getVpnInstanceToVpnIdIdentifier(vpnName);
206 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance> vpnInstance
207 = read(broker, LogicalDatastoreType.CONFIGURATION, id);
210 if(vpnInstance.isPresent()) {
211 rd = vpnInstance.get().getVrfId();
216 static org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance
217 getVpnInstanceToVpnId(String vpnName, long vpnId, String rd) {
218 return new org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceBuilder()
219 .setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).build();
223 static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance>
224 getVpnInstanceToVpnIdIdentifier(String vpnName) {
225 return InstanceIdentifier.builder(VpnInstanceToVpnId.class)
226 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance.class,
227 new org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceKey(vpnName)).build();
230 static InstanceIdentifier<VpnInstanceOpDataEntry> getVpnInstanceOpDataIdentifier(String rd) {
231 return InstanceIdentifier.builder(VpnInstanceOpData.class)
232 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd)).build();
235 static VpnInstanceOpDataEntry getVpnInstanceOpDataBuilder(String rd, long vpnId) {
236 return new VpnInstanceOpDataEntryBuilder().setVrfId(rd).setVpnId(vpnId).build();
239 static VpnInstanceOpDataEntry updateIntfCntInVpnInstOpData(Long count, String vrfId) {
240 return new VpnInstanceOpDataEntryBuilder().setVpnInterfaceCount(count).setVrfId(vrfId).build();
243 static VpnInstanceOpDataEntry getVpnInstanceOpData(DataBroker broker, String rd) {
244 InstanceIdentifier<VpnInstanceOpDataEntry> id = VpnUtil.getVpnInstanceOpDataIdentifier(rd);
245 Optional<VpnInstanceOpDataEntry> vpnInstanceOpData = read(broker, LogicalDatastoreType.OPERATIONAL, id);
246 if(vpnInstanceOpData.isPresent()) {
247 return vpnInstanceOpData.get();
252 static VpnInterface getConfiguredVpnInterface(DataBroker broker, String interfaceName) {
253 InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
254 Optional<VpnInterface> configuredVpnInterface = read(broker, LogicalDatastoreType.CONFIGURATION, interfaceId);
256 if (configuredVpnInterface.isPresent()) {
257 return configuredVpnInterface.get();
262 static VpnInterface getOperationalVpnInterface(DataBroker broker, String interfaceName) {
263 InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
264 Optional<VpnInterface> operationalVpnInterface = read(broker, LogicalDatastoreType.OPERATIONAL, interfaceId);
266 if (operationalVpnInterface.isPresent()) {
267 return operationalVpnInterface.get();
272 static boolean isVpnInterfaceConfigured(DataBroker broker, String interfaceName)
274 InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
275 Optional<VpnInterface> configuredVpnInterface = read(broker, LogicalDatastoreType.CONFIGURATION, interfaceId);
277 if (configuredVpnInterface.isPresent()) {
283 static String getIpPrefix(String prefix) {
284 String prefixValues[] = prefix.split("/");
285 if (prefixValues.length == 1) {
286 prefix = prefix + PREFIX_SEPARATOR + DEFAULT_PREFIX_LENGTH ;
291 static final FutureCallback<Void> DEFAULT_CALLBACK =
292 new FutureCallback<Void>() {
293 public void onSuccess(Void result) {
294 LOG.debug("Success in Datastore operation");
297 public void onFailure(Throwable error) {
298 LOG.error("Error in Datastore operation", error);
302 public static <T extends DataObject> Optional<T> read(DataBroker broker, LogicalDatastoreType datastoreType,
303 InstanceIdentifier<T> path) {
305 ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
307 Optional<T> result = Optional.absent();
309 result = tx.read(datastoreType, path).get();
310 } catch (Exception e) {
311 throw new RuntimeException(e);
317 static <T extends DataObject> void asyncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
318 InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
319 WriteTransaction tx = broker.newWriteOnlyTransaction();
320 tx.merge(datastoreType, path, data, true);
321 Futures.addCallback(tx.submit(), callback);
324 static <T extends DataObject> void asyncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
325 InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
326 WriteTransaction tx = broker.newWriteOnlyTransaction();
327 tx.put(datastoreType, path, data, true);
328 Futures.addCallback(tx.submit(), callback);
331 static <T extends DataObject> void delete(DataBroker broker, LogicalDatastoreType datastoreType,
332 InstanceIdentifier<T> path, FutureCallback<Void> callback) {
333 WriteTransaction tx = broker.newWriteOnlyTransaction();
334 tx.delete(datastoreType, path);
335 Futures.addCallback(tx.submit(), callback);
338 public static <T extends DataObject> void syncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
339 InstanceIdentifier<T> path, T data) {
340 WriteTransaction tx = broker.newWriteOnlyTransaction();
341 tx.put(datastoreType, path, data, true);
342 CheckedFuture<Void, TransactionCommitFailedException> futures = tx.submit();
345 } catch (InterruptedException | ExecutionException e) {
346 LOG.error("Error writing to datastore (path, data) : ({}, {})", path, data);
347 throw new RuntimeException(e.getMessage());
351 public static <T extends DataObject> void syncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
352 InstanceIdentifier<T> path, T data) {
353 WriteTransaction tx = broker.newWriteOnlyTransaction();
354 tx.merge(datastoreType, path, data, true);
355 CheckedFuture<Void, TransactionCommitFailedException> futures = tx.submit();
358 } catch (InterruptedException | ExecutionException e) {
359 LOG.error("Error writing to datastore (path, data) : ({}, {})", path, data);
360 throw new RuntimeException(e.getMessage());