f9a541fc075e3f0faa0a09bc78c7ecfffea072c1
[vpnservice.git] / vpnmanager / vpnmanager-impl / src / main / java / org / opendaylight / vpnservice / VpnUtil.java
1 /*
2  * Copyright (c) 2015 - 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
9 package org.opendaylight.vpnservice;
10
11 import java.math.BigInteger;
12 import java.net.InetAddress;
13 import java.util.concurrent.ExecutionException;
14 import java.util.concurrent.Future;
15 import java.util.List;
16
17 import com.google.common.base.Optional;
18 import com.google.common.primitives.Ints;
19 import com.google.common.util.concurrent.CheckedFuture;
20 import com.google.common.util.concurrent.FutureCallback;
21 import com.google.common.util.concurrent.Futures;
22
23 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
24 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
25 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
26 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
27 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
28 import org.opendaylight.vpnservice.mdsalutil.NwConstants;
29 import org.opendaylight.vpnservice.mdsalutil.packet.ARP;
30 import org.opendaylight.vpnservice.mdsalutil.packet.Ethernet;
31 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnAfConfig;
32 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
33 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
34 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
35 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstanceKey;
36 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
37 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
38 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceBuilder;
39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.*;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.adjacency.list.Adjacency;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.Adjacencies;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.AdjacenciesBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.prefix.to._interface.VpnIds;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.prefix.to._interface.VpnIdsKey;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.prefix.to._interface.vpn.ids.Prefixes;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesKey;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnList;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnListKey;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.to.extraroute.Vpn;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.to.extraroute.VpnKey;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.to.extraroute.vpn.Extraroute;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.to.extraroute.vpn.ExtrarouteBuilder;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.to.extraroute.vpn.ExtrarouteKey;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.ElanDpnInterfaces;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesList;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesListKey;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfaces;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.fibmanager.rev150330.FibEntries;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.fibmanager.rev150330.fibentries.VrfTables;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.fibmanager.rev150330.fibentries.VrfTablesKey;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.IdPools;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.id.pools.IdPool;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.id.pools.IdPoolKey;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdInput;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdInputBuilder;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdOutput;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.ReleaseIdInput;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.ReleaseIdInputBuilder;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.IdManagerService;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.IfIndexesInterfaceMap;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._if.indexes._interface.map.IfIndexInterface;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._if.indexes._interface.map.IfIndexInterfaceKey;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.l3nexthop.rev150409.L3nexthop;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.l3nexthop.rev150409.l3nexthop.VpnNexthops;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.l3nexthop.rev150409.l3nexthop.VpnNexthopsKey;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.NeutronPortData;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.neutron.port.data.PortFixedipToPortName;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.neutron.port.data.PortFixedipToPortNameKey;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.tag.name.map.ElanTagName;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.ElanTagNameMap;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.tag.name.map.ElanTagNameKey;
89 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
90 import org.opendaylight.yangtools.yang.common.RpcResult;
91 import org.opendaylight.yangtools.yang.binding.DataObject;
92 import org.slf4j.Logger;
93 import org.slf4j.LoggerFactory;
94
95 public class VpnUtil {
96     private static final Logger LOG = LoggerFactory.getLogger(VpnUtil.class);
97     private static final int DEFAULT_PREFIX_LENGTH = 32;
98     private static final String PREFIX_SEPARATOR = "/";
99
100     static InstanceIdentifier<VpnInterface> getVpnInterfaceIdentifier(String vpnInterfaceName) {
101         return InstanceIdentifier.builder(VpnInterfaces.class)
102                 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName)).build();
103     }
104
105     static InstanceIdentifier<VpnInstance> getVpnInstanceIdentifier(String vpnName) {
106         return InstanceIdentifier.builder(VpnInstances.class)
107                 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
108     }
109
110     static VpnInterface getVpnInterface(String intfName, String vpnName, Adjacencies aug) {
111         return new VpnInterfaceBuilder().setKey(new VpnInterfaceKey(intfName)).setVpnInstanceName(vpnName)
112                 .addAugmentation(Adjacencies.class, aug)
113                 .build();
114     }
115
116     static InstanceIdentifier<Prefixes> getPrefixToInterfaceIdentifier(long vpnId, String ipPrefix) {
117         return InstanceIdentifier.builder(PrefixToInterface.class)
118             .child(VpnIds.class, new VpnIdsKey(vpnId)).child(Prefixes.class,
119                                                              new PrefixesKey(ipPrefix)).build();
120     }
121
122     static Prefixes getPrefixToInterface(BigInteger dpId, String vpnInterfaceName, String ipPrefix) {
123         return new PrefixesBuilder().setDpnId(dpId).setVpnInterfaceName(
124             vpnInterfaceName).setIpAddress(ipPrefix).build();
125     }
126
127     static InstanceIdentifier<Extraroute> getVpnToExtrarouteIdentifier(String vrfId, String ipPrefix) {
128         return InstanceIdentifier.builder(VpnToExtraroute.class)
129                 .child(Vpn.class, new VpnKey(vrfId)).child(Extraroute.class,
130                  new ExtrarouteKey(ipPrefix)).build();
131     }
132
133     static Extraroute getVpnToExtraroute(String ipPrefix, String nextHop) {
134         return new ExtrarouteBuilder().setPrefix(ipPrefix).setNexthopIp(nextHop).build();
135     }
136
137     static Adjacencies
138     getVpnInterfaceAugmentation(List<Adjacency> nextHops) {
139         return new AdjacenciesBuilder().setAdjacency(nextHops).build();
140     }
141
142     public static InstanceIdentifier<IdPool> getPoolId(String poolName){
143         InstanceIdentifier.InstanceIdentifierBuilder<IdPool> idBuilder =
144                         InstanceIdentifier.builder(IdPools.class).child(IdPool.class, new IdPoolKey(poolName));
145         InstanceIdentifier<IdPool> id = idBuilder.build();
146         return id;
147     }
148
149     static InstanceIdentifier<VpnInterfaces> getVpnInterfacesIdentifier() {
150         return InstanceIdentifier.builder(VpnInterfaces.class).build();
151     }
152
153     static InstanceIdentifier<Interface> getInterfaceIdentifier(String interfaceName) {
154         return InstanceIdentifier.builder(Interfaces.class)
155                 .child(Interface.class, new InterfaceKey(interfaceName)).build();
156     }
157
158     static InstanceIdentifier<VpnToDpnList> getVpnToDpnListIdentifier(String rd, BigInteger dpnId) {
159         return InstanceIdentifier.builder(VpnInstanceOpData.class)
160             .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd))
161             .child(VpnToDpnList.class, new VpnToDpnListKey(dpnId)).build();
162     }
163
164     public static BigInteger getCookieArpFlow(int interfaceTag) {
165         return VpnConstants.COOKIE_L3_BASE.add(new BigInteger("0110000", 16)).add(
166             BigInteger.valueOf(interfaceTag));
167     }
168
169     public static String getFlowRef(BigInteger dpnId, short tableId, int ethType, int lPortTag, int arpType) {
170             return new StringBuffer().append(VpnConstants.FLOWID_PREFIX).append(dpnId).append(NwConstants.FLOWID_SEPARATOR)
171                     .append(tableId).append(NwConstants.FLOWID_SEPARATOR).append(ethType).append(lPortTag)
172                     .append(NwConstants.FLOWID_SEPARATOR).append(arpType).toString();
173     }
174
175     public static int getUniqueId(IdManagerService idManager, String poolName,String idKey) {
176         AllocateIdInput getIdInput = new AllocateIdInputBuilder()
177                                            .setPoolName(poolName)
178                                            .setIdKey(idKey).build();
179
180         try {
181             Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
182             RpcResult<AllocateIdOutput> rpcResult = result.get();
183             if(rpcResult.isSuccessful()) {
184                 return rpcResult.getResult().getIdValue().intValue();
185             } else {
186                 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
187             }
188         } catch (InterruptedException | ExecutionException e) {
189             LOG.warn("Exception when getting Unique Id",e);
190         }
191         return 0;
192     }
193
194     public static void releaseId(IdManagerService idManager, String poolName, String idKey) {
195         ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
196         try {
197             Future<RpcResult<Void>> result = idManager.releaseId(idInput);
198             RpcResult<Void> rpcResult = result.get();
199             if(!rpcResult.isSuccessful()) {
200                 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
201             }
202         } catch (InterruptedException | ExecutionException e) {
203             LOG.warn("Exception when getting Unique Id for key {}", idKey, e);
204         }
205     }
206
207     public static String getNextHopLabelKey(String rd, String prefix){
208         String key = rd + VpnConstants.SEPARATOR + prefix;
209         return key;
210     }
211
212     public static long getVpnId(DataBroker broker, String vpnName) {
213
214         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance> id
215             = getVpnInstanceToVpnIdIdentifier(vpnName);
216         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance> vpnInstance
217             = read(broker, LogicalDatastoreType.CONFIGURATION, id);
218
219         long vpnId = VpnConstants.INVALID_ID;
220         if(vpnInstance.isPresent()) {
221             vpnId = vpnInstance.get().getVpnId();
222         }
223         return vpnId;
224     }
225
226     public static String getVpnRd(DataBroker broker, String vpnName) {
227
228         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance> id
229                 = getVpnInstanceToVpnIdIdentifier(vpnName);
230         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance> vpnInstance
231                 = read(broker, LogicalDatastoreType.CONFIGURATION, id);
232
233         String rd = null;
234         if(vpnInstance.isPresent()) {
235             rd = vpnInstance.get().getVrfId();
236         }
237         return rd;
238     }
239
240     static String getVpnRdFromVpnInstanceConfig(DataBroker broker, String vpnName) {
241         InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class)
242                 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
243         Optional<VpnInstance> vpnInstance = VpnUtil.read(broker, LogicalDatastoreType.CONFIGURATION, id);
244         String rd = null;
245         if(vpnInstance.isPresent()) {
246             VpnInstance instance = vpnInstance.get();
247             VpnAfConfig config = instance.getIpv4Family();
248             rd = config.getRouteDistinguisher();
249         }
250         return rd;
251     }
252
253     static org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance
254            getVpnInstanceToVpnId(String vpnName, long vpnId, String rd) {
255         return new org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceBuilder()
256             .setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).build();
257
258     }
259
260     static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance>
261            getVpnInstanceToVpnIdIdentifier(String vpnName) {
262         return InstanceIdentifier.builder(VpnInstanceToVpnId.class)
263             .child(org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance.class,
264                    new org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceKey(vpnName)).build();
265     }
266
267     static InstanceIdentifier<VpnInstanceOpDataEntry> getVpnInstanceOpDataIdentifier(String rd) {
268         return InstanceIdentifier.builder(VpnInstanceOpData.class)
269             .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd)).build();
270     }
271
272     static VpnInstanceOpDataEntry getVpnInstanceOpDataBuilder(String rd, long vpnId) {
273         return new VpnInstanceOpDataEntryBuilder().setVrfId(rd).setVpnId(vpnId).build();
274     }
275
276     static VpnInstanceOpDataEntry updateIntfCntInVpnInstOpData(Long count, String vrfId) {
277         return new VpnInstanceOpDataEntryBuilder().setVpnInterfaceCount(count).setVrfId(vrfId).build();
278     }
279
280     static VpnInstanceOpDataEntry getVpnInstanceOpData(DataBroker broker, String rd) {
281         InstanceIdentifier<VpnInstanceOpDataEntry> id = VpnUtil.getVpnInstanceOpDataIdentifier(rd);
282         Optional<VpnInstanceOpDataEntry> vpnInstanceOpData = read(broker, LogicalDatastoreType.OPERATIONAL, id);
283         if(vpnInstanceOpData.isPresent()) {
284             return vpnInstanceOpData.get();
285         }
286         return null;
287     }
288
289     static VpnInterface getConfiguredVpnInterface(DataBroker broker, String interfaceName) {
290         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
291         Optional<VpnInterface> configuredVpnInterface = read(broker, LogicalDatastoreType.CONFIGURATION, interfaceId);
292
293         if (configuredVpnInterface.isPresent()) {
294             return configuredVpnInterface.get();
295         }
296         return null;
297     }
298
299     static VpnInterface getOperationalVpnInterface(DataBroker broker, String interfaceName) {
300         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
301         Optional<VpnInterface> operationalVpnInterface = read(broker, LogicalDatastoreType.OPERATIONAL, interfaceId);
302
303         if (operationalVpnInterface.isPresent()) {
304             return operationalVpnInterface.get();
305         }
306         return null;
307     }
308
309     static boolean isVpnInterfaceConfigured(DataBroker broker, String interfaceName)
310     {
311         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
312         Optional<VpnInterface> configuredVpnInterface = read(broker, LogicalDatastoreType.CONFIGURATION, interfaceId);
313
314         if (configuredVpnInterface.isPresent()) {
315             return true;
316         }
317         return false;
318     }
319
320     static String getIpPrefix(String prefix) {
321         String prefixValues[] = prefix.split("/");
322         if (prefixValues.length == 1) {
323             prefix = prefix + PREFIX_SEPARATOR + DEFAULT_PREFIX_LENGTH ;
324         }
325         return prefix;
326     }
327
328     static final FutureCallback<Void> DEFAULT_CALLBACK =
329             new FutureCallback<Void>() {
330                 public void onSuccess(Void result) {
331                     LOG.debug("Success in Datastore operation");
332                 }
333
334                 public void onFailure(Throwable error) {
335                     LOG.error("Error in Datastore operation", error);
336                 };
337             };
338
339     public static <T extends DataObject> Optional<T> read(DataBroker broker, LogicalDatastoreType datastoreType,
340                                                     InstanceIdentifier<T> path) {
341
342         ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
343
344         Optional<T> result = Optional.absent();
345         try {
346             result = tx.read(datastoreType, path).get();
347         } catch (Exception e) {
348             throw new RuntimeException(e);
349         } finally {
350             tx.close();
351         }
352
353         return result;
354     }
355
356     static <T extends DataObject> void asyncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
357                                                       InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
358         WriteTransaction tx = broker.newWriteOnlyTransaction();
359         tx.merge(datastoreType, path, data, true);
360         Futures.addCallback(tx.submit(), callback);
361     }
362
363     static <T extends DataObject> void asyncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
364                                                    InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
365         WriteTransaction tx = broker.newWriteOnlyTransaction();
366         tx.put(datastoreType, path, data, true);
367         Futures.addCallback(tx.submit(), callback);
368     }
369
370     static <T extends DataObject> void delete(DataBroker broker, LogicalDatastoreType datastoreType,
371                                                InstanceIdentifier<T> path, FutureCallback<Void> callback) {
372         WriteTransaction tx = broker.newWriteOnlyTransaction();
373         tx.delete(datastoreType, path);
374         Futures.addCallback(tx.submit(), callback);
375     }
376
377     public static <T extends DataObject> void syncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
378                     InstanceIdentifier<T> path, T data) {
379         WriteTransaction tx = broker.newWriteOnlyTransaction();
380         tx.put(datastoreType, path, data, true);
381         CheckedFuture<Void, TransactionCommitFailedException> futures = tx.submit();
382         try {
383             futures.get();
384         } catch (InterruptedException | ExecutionException e) {
385             LOG.error("Error writing to datastore (path, data) : ({}, {})", path, data);
386             throw new RuntimeException(e.getMessage());
387         }
388     }
389
390     public static <T extends DataObject> void syncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
391                     InstanceIdentifier<T> path, T data) {
392         WriteTransaction tx = broker.newWriteOnlyTransaction();
393         tx.merge(datastoreType, path, data, true);
394         CheckedFuture<Void, TransactionCommitFailedException> futures = tx.submit();
395         try {
396             futures.get();
397         } catch (InterruptedException | ExecutionException e) {
398             LOG.error("Error writing to datastore (path, data) : ({}, {})", path, data);
399             throw new RuntimeException(e.getMessage());
400         }
401     }
402
403     public static long getRemoteBCGroup(long elanTag) {
404         return VpnConstants.ELAN_GID_MIN + ((elanTag % VpnConstants.ELAN_GID_MIN) *2);
405     }
406
407     // interface-index-tag operational container
408     public static IfIndexInterface getInterfaceInfoByInterfaceTag(DataBroker broker, long interfaceTag) {
409         InstanceIdentifier<IfIndexInterface> interfaceId = getInterfaceInfoEntriesOperationalDataPath(interfaceTag);
410         Optional<IfIndexInterface> existingInterfaceInfo = VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, interfaceId);
411         if(existingInterfaceInfo.isPresent()) {
412             return existingInterfaceInfo.get();
413         }
414         return null;
415     }
416
417     private static InstanceIdentifier<IfIndexInterface> getInterfaceInfoEntriesOperationalDataPath(long interfaceTag) {
418         return InstanceIdentifier.builder(IfIndexesInterfaceMap.class).child(IfIndexInterface.class,
419                 new IfIndexInterfaceKey((int) interfaceTag)).build();
420     }
421
422     public static String getNeutronPortNamefromPortFixedIp(DataBroker broker, String fixedIp) {
423         InstanceIdentifier id = buildFixedIpToPortNameIdentifier(fixedIp);
424         Optional<PortFixedipToPortName> portFixedipToPortNameData = read(broker, LogicalDatastoreType.CONFIGURATION,
425                 id);
426         if (portFixedipToPortNameData.isPresent()) {
427             return portFixedipToPortNameData.get().getPortName();
428         }
429         return null;
430     }
431
432     private static InstanceIdentifier<PortFixedipToPortName> buildFixedIpToPortNameIdentifier(String fixedIp) {
433         InstanceIdentifier<PortFixedipToPortName> id = InstanceIdentifier.builder(NeutronPortData.class).child
434                 (PortFixedipToPortName.class, new PortFixedipToPortNameKey(fixedIp)).build();
435         return id;
436     }
437
438     public static ElanTagName getElanInfoByElanTag(DataBroker broker,long elanTag) {
439         InstanceIdentifier<ElanTagName> elanId = getElanInfoEntriesOperationalDataPath(elanTag);
440         Optional<ElanTagName> existingElanInfo = VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, elanId);
441         if(existingElanInfo.isPresent()) {
442             return existingElanInfo.get();
443         }
444         return null;
445     }
446
447     private static InstanceIdentifier<ElanTagName> getElanInfoEntriesOperationalDataPath(long elanTag) {
448         return InstanceIdentifier.builder(ElanTagNameMap.class).child(ElanTagName.class,
449                 new ElanTagNameKey(elanTag)).build();
450     }
451
452
453     public static boolean isIpInSubnet(int ipAddress, String subnetCidr) {
454         String[] subSplit = subnetCidr.split("/");
455         if (subSplit.length < 2) {
456             return false;
457         }
458
459         String subnetStr = subSplit[0];
460         int subnet = 0;
461         try {
462             InetAddress subnetAddress = InetAddress.getByName(subnetStr);
463             subnet = Ints.fromByteArray(subnetAddress.getAddress());
464         } catch (Exception ex) {
465             LOG.error("Passed in Subnet IP string not convertible to InetAdddress " + subnetStr);
466             return false;
467         }
468         int prefixLength = Integer.valueOf(subSplit[1]);
469         int mask = -1 << (32 - prefixLength);
470         if ((subnet & mask) == (ipAddress & mask)) {
471             return true;
472         }
473         return false;
474     }
475
476     public static void removePrefixToInterfaceForVpnId(DataBroker broker, long vpnId) {
477         try {
478             // Clean up PrefixToInterface Operational DS
479             delete(broker, LogicalDatastoreType.OPERATIONAL,
480                     InstanceIdentifier.builder(PrefixToInterface.class).child(VpnIds.class, new VpnIdsKey(vpnId)).build(),
481                     DEFAULT_CALLBACK);
482         } catch (Exception e) {
483             LOG.error("Exception during cleanup of PrefixToInterface for VPN ID {}", vpnId, e);
484         }
485     }
486
487     public static void removeVpnExtraRouteForVpn(DataBroker broker, String vpnName) {
488         try {
489             // Clean up VPNExtraRoutes Operational DS
490             delete(broker, LogicalDatastoreType.OPERATIONAL,
491                     InstanceIdentifier.builder(VpnToExtraroute.class).child(Vpn.class, new VpnKey(vpnName)).build(),
492                     DEFAULT_CALLBACK);
493         } catch (Exception e) {
494             LOG.error("Exception during cleanup of VPNToExtraRoute for VPN {}", vpnName, e);
495         }
496     }
497
498     public static void removeVpnOpInstance(DataBroker broker, String vpnName) {
499         try {
500             // Clean up VPNInstanceOpDataEntry
501             delete(broker, LogicalDatastoreType.OPERATIONAL, getVpnInstanceOpDataIdentifier(vpnName),
502                     DEFAULT_CALLBACK);
503         } catch (Exception e) {
504             LOG.error("Exception during cleanup of VPNInstanceOpDataEntry for VPN {}", vpnName, e);
505         }
506     }
507
508     public static void removeVpnInstanceToVpnId(DataBroker broker, String vpnName) {
509         try {
510             delete(broker, LogicalDatastoreType.CONFIGURATION, getVpnInstanceToVpnIdIdentifier(vpnName),
511                     DEFAULT_CALLBACK);
512         } catch (Exception e) {
513             LOG.error("Exception during clean up of VpnInstanceToVpnId for VPN {}", vpnName, e);
514         }
515     }
516
517     public static void removeVrfTableForVpn(DataBroker broker, String vpnName) {
518         // Clean up FIB Entries Config DS
519         try {
520             delete(broker, LogicalDatastoreType.CONFIGURATION,
521                     InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(vpnName)).build(),
522                     DEFAULT_CALLBACK);
523         } catch (Exception e) {
524             LOG.error("Exception during clean up of VrfTable from FIB for VPN {}", vpnName, e);
525         }
526     }
527
528     public static void removeL3nexthopForVpnId(DataBroker broker, long vpnId) {
529         try {
530             // Clean up L3NextHop Operational DS
531             delete(broker, LogicalDatastoreType.OPERATIONAL,
532                     InstanceIdentifier.builder(L3nexthop.class).child(VpnNexthops.class, new VpnNexthopsKey(vpnId)).build(),
533                     DEFAULT_CALLBACK);
534         } catch (Exception e) {
535             LOG.error("Exception during cleanup of L3NextHop for VPN ID {}", vpnId, e);
536         }
537     }
538 }