implement unimgr api to netvirt dhcp allocation pool service
[unimgr.git] / netvirt / src / main / java / org / opendaylight / unimgr / mef / netvirt / NetvirtUtils.java
1 /*
2  * Copyright (c) 2016 Hewlett Packard Enterprise, Co. 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.unimgr.mef.netvirt;
10
11 import java.math.BigInteger;
12 import java.util.List;
13 import java.util.concurrent.ExecutionException;
14 import java.util.concurrent.Future;
15
16 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
17 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
18 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
19 import org.opendaylight.yang.gen.v1.http.metroethernetforum.org.ns.yang.mef.services.rev150526.EvcElan;
20 import org.opendaylight.yang.gen.v1.http.metroethernetforum.org.ns.yang.mef.services.rev150526.IpvcVpn;
21 import org.opendaylight.yang.gen.v1.http.metroethernetforum.org.ns.yang.mef.services.rev150526.mef.services.MefService;
22 import org.opendaylight.yang.gen.v1.http.metroethernetforum.org.ns.yang.mef.services.rev150526.mef.services.mef.service.mef.service.choice.EvcChoice;
23 import org.opendaylight.yang.gen.v1.http.metroethernetforum.org.ns.yang.mef.services.rev150526.mef.services.mef.service.mef.service.choice.IpvcChoice;
24 import org.opendaylight.yang.gen.v1.http.metroethernetforum.org.ns.yang.mef.services.rev150526.mef.services.mef.service.mef.service.choice.ipvc.choice.ipvc.VpnElans;
25 import org.opendaylight.yang.gen.v1.http.metroethernetforum.org.ns.yang.mef.types.rev150526.RetailSvcIdType;
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.ietf.inet.types.rev130715.IpPrefix;
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.interfaces.Interface;
30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceBuilder;
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.genius.interfacemanager.rev160406.IfL2vlan;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlanBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.ParentRefs;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.ParentRefsBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.SplitHorizon;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.SplitHorizonBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetDpidFromInterfaceInput;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetDpidFromInterfaceInputBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetDpidFromInterfaceOutput;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.OdlInterfaceRpcService;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.dhcp_allocation_pool.rev161214.DhcpAllocationPool;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.dhcp_allocation_pool.rev161214.dhcp_allocation_pool.Network;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.dhcp_allocation_pool.rev161214.dhcp_allocation_pool.NetworkKey;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.dhcp_allocation_pool.rev161214.dhcp_allocation_pool.network.AllocationPool;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.dhcp_allocation_pool.rev161214.dhcp_allocation_pool.network.AllocationPoolBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.dhcp_allocation_pool.rev161214.dhcp_allocation_pool.network.AllocationPoolKey;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInstance;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInstanceBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInterface;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInterface.EtreeInterfaceType;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInterfaceBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInstances;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInterfaces;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceKey;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterface;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterfaceBuilder;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterfaceKey;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.unimgr.unimgr.dhcp.rev161214.unimgr.dhcp.unimgr.services.network.UnimgrAllocationPool;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVxlan;
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;
69
70 import com.google.common.base.Optional;
71
72 public class NetvirtUtils {
73
74     private static final Logger logger = LoggerFactory.getLogger(NetvirtUtils.class);
75     private static final long DEFAULT_MAC_TIMEOUT = 300;
76
77     public static void createElanInstance(DataBroker dataBroker, String instanceName, boolean isEtree,
78             Long segmentationId) {
79         createElanInstance(dataBroker, instanceName, isEtree, segmentationId, DEFAULT_MAC_TIMEOUT);
80     }
81
82     public static void createElanInstance(DataBroker dataBroker, String instanceName, boolean isEtree,
83             Long segmentationId, Long macTimeout) {
84         ElanInstanceBuilder einstBuilder = createElanInstanceBuilder(instanceName, segmentationId, macTimeout);
85
86         if (isEtree) {
87             EtreeInstance etreeInstance = new EtreeInstanceBuilder().build();
88             einstBuilder.addAugmentation(EtreeInstance.class, etreeInstance).build();
89         }
90
91         MdsalUtils.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION,
92                 getElanInstanceInstanceIdentifier(instanceName), einstBuilder.build());
93     }
94
95     public static void updateElanInstance(DataBroker dataBroker, String instanceName) {
96         WriteTransaction tx = MdsalUtils.createTransaction(dataBroker);
97         updateElanInstance(instanceName, tx);
98         MdsalUtils.commitTransaction(tx);
99     }
100
101     public static void updateElanInstance(String instanceName, WriteTransaction tx) {
102         ElanInstanceBuilder einstBuilder = createElanInstanceBuilder(instanceName);
103         saveElanInstance(instanceName, tx, einstBuilder);
104     }
105
106     public static void updateElanInstance(String instanceName, WriteTransaction tx, Long segmentationId) {
107         ElanInstanceBuilder einstBuilder = createElanInstanceBuilder(instanceName, segmentationId);
108         saveElanInstance(instanceName, tx, einstBuilder);
109     }
110
111     public static void updateElanInstance(String instanceName, WriteTransaction tx, Long segmentationId,
112             Long macTimeout) {
113         ElanInstanceBuilder einstBuilder = createElanInstanceBuilder(instanceName, segmentationId, macTimeout);
114         saveElanInstance(instanceName, tx, einstBuilder);
115     }
116
117     private static void saveElanInstance(String instanceName, WriteTransaction tx, ElanInstanceBuilder einstBuilder) {
118         tx.merge(LogicalDatastoreType.CONFIGURATION, getElanInstanceInstanceIdentifier(instanceName),
119                 einstBuilder.build());
120     }
121
122     public static void updateElanInterface(DataBroker dataBroker, String instanceName, String interfaceName) {
123         ElanInterfaceBuilder einterfaceBuilder = createElanInterface(instanceName, interfaceName);
124
125         MdsalUtils.syncUpdate(dataBroker, LogicalDatastoreType.CONFIGURATION,
126                 getElanInterfaceInstanceIdentifier(interfaceName), einterfaceBuilder.build());
127     }
128
129     public static void deleteElanInstance(DataBroker dataBroker, String instanceName) {
130         MdsalUtils.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION,
131                 getElanInstanceInstanceIdentifier(instanceName));
132     }
133
134     public static void deleteElanInstance(String instanceName, WriteTransaction tx) {
135         tx.delete(LogicalDatastoreType.CONFIGURATION, getElanInstanceInstanceIdentifier(instanceName));
136     }
137
138     public static void deleteElanInterface(DataBroker dataBroker, String interfaceName) {
139         WriteTransaction tx = MdsalUtils.createTransaction(dataBroker);
140         deleteElanInterface(interfaceName, tx);
141         MdsalUtils.commitTransaction(tx);
142     }
143
144     public static void deleteElanInterface(String interfaceName, WriteTransaction tx) {
145         tx.delete(LogicalDatastoreType.CONFIGURATION, getElanInterfaceInstanceIdentifier(interfaceName));
146     }
147
148     public static Interface createTrunkInterface(String interfaceName, String parentIfaceName) {
149         IfL2vlanBuilder ifL2vlanBuilder = new IfL2vlanBuilder();
150         ifL2vlanBuilder.setL2vlanMode(IfL2vlan.L2vlanMode.Trunk);
151         return createInterface(interfaceName, parentIfaceName, ifL2vlanBuilder.build());
152     }
153
154     public static Interface createTrunkMemberInterface(String interfaceName, String parentIfaceName, int vlanId) {
155         IfL2vlanBuilder ifL2vlanBuilder = new IfL2vlanBuilder();
156         ifL2vlanBuilder.setL2vlanMode(IfL2vlan.L2vlanMode.TrunkMember).setVlanId(new VlanId(vlanId));
157         return createInterface(interfaceName, parentIfaceName, ifL2vlanBuilder.build());
158     }
159
160     private static Interface createInterface(String interfaceName, String parentIfaceName, IfL2vlan ifL2vlan) {
161         InterfaceBuilder interfaceBuilder = new InterfaceBuilder();
162         SplitHorizon sh = new SplitHorizonBuilder().setOverrideSplitHorizonProtection(true).build();
163         ParentRefsBuilder parentRefsBuilder = new ParentRefsBuilder().setParentInterface(parentIfaceName);
164         interfaceBuilder.setEnabled(true).setName(interfaceName).setType(L2vlan.class)
165                 .addAugmentation(SplitHorizon.class, sh).addAugmentation(IfL2vlan.class, ifL2vlan)
166                 .addAugmentation(ParentRefs.class, parentRefsBuilder.build());
167         return interfaceBuilder.build();
168     }
169
170     private static ElanInstanceBuilder createElanInstanceBuilder(String instanceName) {
171         return createElanInstanceBuilder(instanceName, Long.valueOf(Math.abs((short) instanceName.hashCode())));
172     }
173
174     private static ElanInstanceBuilder createElanInstanceBuilder(String instanceName, Long segmentationId) {
175         return createElanInstanceBuilder(instanceName, segmentationId, DEFAULT_MAC_TIMEOUT);
176     }
177
178     private static ElanInstanceBuilder createElanInstanceBuilder(String instanceName, Long segmentationId,
179             Long macTimeout) {
180         if (segmentationId == null) {
181             segmentationId = Long.valueOf(Math.abs((short) instanceName.hashCode()));
182         }
183         ElanInstanceBuilder einstBuilder = new ElanInstanceBuilder();
184         einstBuilder.setElanInstanceName(instanceName);
185         einstBuilder.setKey(new ElanInstanceKey(instanceName));
186         einstBuilder.setMacTimeout(macTimeout);
187         einstBuilder.setSegmentationId(segmentationId);
188         einstBuilder.setSegmentType(SegmentTypeVxlan.class);
189         return einstBuilder;
190     }
191
192     private static ElanInterfaceBuilder createElanInterface(String instanceName, String interfaceName) {
193         ElanInterfaceBuilder einterfaceBuilder = new ElanInterfaceBuilder();
194         einterfaceBuilder.setElanInstanceName(instanceName);
195         einterfaceBuilder.setName(interfaceName);
196         return einterfaceBuilder;
197     }
198
199     private static ElanInterfaceBuilder createEtreeInterface(String instanceName, String interfaceName,
200             EtreeInterfaceType interfaceType) {
201         ElanInterfaceBuilder einterfaceBuilder = new ElanInterfaceBuilder();
202         einterfaceBuilder.setElanInstanceName(instanceName);
203         einterfaceBuilder.setName(interfaceName);
204         EtreeInterface etreeInterface = new EtreeInterfaceBuilder().setEtreeInterfaceType(interfaceType).build();
205         einterfaceBuilder.addAugmentation(EtreeInterface.class, etreeInterface);
206         return einterfaceBuilder;
207     }
208
209     public static InstanceIdentifier<ElanInstance> getElanInstanceInstanceIdentifier() {
210         return InstanceIdentifier.builder(ElanInstances.class).child(ElanInstance.class).build();
211     }
212
213     public static InstanceIdentifier<ElanInterfaces> getElanInterfacesInstanceIdentifier() {
214         return InstanceIdentifier.builder(ElanInterfaces.class).build();
215     }
216
217     public static InstanceIdentifier<ElanInstance> getElanInstanceInstanceIdentifier(String instanceName) {
218         return InstanceIdentifier.builder(ElanInstances.class)
219                 .child(ElanInstance.class, new ElanInstanceKey(instanceName)).build();
220     }
221
222     private static InstanceIdentifier<ElanInterface> getElanInterfaceInstanceIdentifier(String interfaceName) {
223         return InstanceIdentifier.builder(ElanInterfaces.class)
224                 .child(ElanInterface.class, new ElanInterfaceKey(interfaceName)).build();
225     }
226
227     public static InstanceIdentifier<Interface> getInterfaceIdentifier(String interfaceName) {
228         InstanceIdentifierBuilder<Interface> idBuilder = InstanceIdentifier.builder(Interfaces.class)
229                 .child(Interface.class, new InterfaceKey(interfaceName));
230         InstanceIdentifier<Interface> id = idBuilder.build();
231         return id;
232     }
233
234     public static Optional<Interface> getIetfInterface(DataBroker dataBroker, String interfaceName) {
235         return MdsalUtils.read(dataBroker, LogicalDatastoreType.CONFIGURATION, getInterfaceIdentifier(interfaceName));
236     }
237
238     public static void writeInterface(Interface iface, WriteTransaction tx) {
239         String interfaceName = iface.getName();
240         InstanceIdentifier<Interface> interfaceIdentifier = createInterfaceIdentifier(interfaceName);
241         tx.put(LogicalDatastoreType.CONFIGURATION, interfaceIdentifier, iface, true);
242     }
243
244     public static void deleteInterface(String interfaceName, WriteTransaction tx) {
245         InstanceIdentifier<Interface> interfaceIdentifier = createInterfaceIdentifier(interfaceName);
246         tx.delete(LogicalDatastoreType.CONFIGURATION, interfaceIdentifier);
247     }
248
249     private static InstanceIdentifier<Interface> createInterfaceIdentifier(String interfaceName) {
250         return InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new InterfaceKey(interfaceName))
251                 .build();
252     }
253
254     public static void createElanInterface(DataBroker dataBroker, String instanceName, String interfaceName,
255             EtreeInterfaceType etreeInterfaceType, boolean isEtree) {
256         WriteTransaction tx = MdsalUtils.createTransaction(dataBroker);
257         createElanInterface(instanceName, interfaceName, etreeInterfaceType, isEtree, tx);
258         MdsalUtils.commitTransaction(tx);
259     }
260
261     public static void createElanInterface(String instanceName, String interfaceName,
262             EtreeInterfaceType etreeInterfaceType, boolean isEtree, WriteTransaction tx) {
263         logger.info("Adding {} interface: {}", isEtree ? "etree" : "elan", interfaceName);
264
265         if (isEtree) {
266             NetvirtUtils.createEtreeInterface(instanceName, interfaceName, etreeInterfaceType, tx);
267         } else {
268             NetvirtUtils.createElanInterface(instanceName, interfaceName, tx);
269         }
270     }
271
272     private static void createEtreeInterface(String instanceName, String interfaceName, EtreeInterfaceType type,
273             WriteTransaction tx) {
274         ElanInterfaceBuilder einterfaceBuilder = createEtreeInterface(instanceName, interfaceName, type);
275
276         tx.put(LogicalDatastoreType.CONFIGURATION, getElanInterfaceInstanceIdentifier(interfaceName),
277                 einterfaceBuilder.build());
278     }
279
280     private static void createElanInterface(String instanceName, String interfaceName, WriteTransaction tx) {
281         ElanInterfaceBuilder einterfaceBuilder = createElanInterface(instanceName, interfaceName);
282
283         tx.put(LogicalDatastoreType.CONFIGURATION, getElanInterfaceInstanceIdentifier(interfaceName),
284                 einterfaceBuilder.build());
285     }
286
287     public static BigInteger getDpnForInterface(OdlInterfaceRpcService interfaceManagerRpcService, String ifName) {
288         BigInteger nodeId = BigInteger.ZERO;
289         try {
290             GetDpidFromInterfaceInput dpIdInput = new GetDpidFromInterfaceInputBuilder().setIntfName(ifName).build();
291             Future<RpcResult<GetDpidFromInterfaceOutput>> dpIdOutput = interfaceManagerRpcService
292                     .getDpidFromInterface(dpIdInput);
293             RpcResult<GetDpidFromInterfaceOutput> dpIdResult = dpIdOutput.get();
294             if (dpIdResult.isSuccessful()) {
295                 nodeId = dpIdResult.getResult().getDpid();
296             } else {
297                 logger.error("Could not retrieve DPN Id for interface {}", ifName);
298             }
299         } catch (NullPointerException | InterruptedException | ExecutionException e) {
300             logger.error("Exception when getting dpn for interface {}", ifName, e);
301         }
302         return nodeId;
303     }
304
305     public static void safeSleep() {
306         try {
307             Thread.yield();
308             Thread.sleep(1000);
309         } catch (InterruptedException e) {
310         }
311     }
312
313     public static void safeSleep(short sec) {
314         try {
315             Thread.yield();
316             Thread.sleep(1000 * sec);
317         } catch (InterruptedException e) {
318         }
319     }
320
321     public static void createDhcpAllocationPool(DataBroker dataBroker, UnimgrAllocationPool unimgrAllocationPool,
322             String unimgrNetworkId, RetailSvcIdType svcId) {
323         String networkId = convertNetworkToNetvirtNetwork(dataBroker, unimgrNetworkId, svcId);
324         if (networkId != null) {
325             // add allocation pool to netvirt
326             MdsalUtils.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION,
327                     createDhcpAllocationPoolInstanceIdentifier(networkId, unimgrAllocationPool.getKey().getSubnet()),
328                     buildDhcpAllocationPool(unimgrAllocationPool));
329         } else {
330             logger.warn("no network found for svc-id {}", svcId);
331         }
332     }
333
334     public static void removeDhcpAllocationPool(DataBroker dataBroker, String unimgrNetworkId, RetailSvcIdType svcId,
335             IpPrefix subnet) {
336         String networkId = convertNetworkToNetvirtNetwork(dataBroker, unimgrNetworkId, svcId);
337         if (networkId != null) {
338             // remove allocation pool from netvirt
339             MdsalUtils.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION,
340                     createDhcpAllocationPoolInstanceIdentifier(networkId, subnet));
341         } else {
342             logger.warn("no network found for svc-id {}", svcId);
343         }
344     }
345
346     private static String convertNetworkToNetvirtNetwork(DataBroker dataBroker, String unimgrNetworkId,
347             RetailSvcIdType svcId) {
348         Optional<MefService> optionalOpMefService = MefServicesUtils.getOpMefServiceBySvcId(dataBroker, svcId);
349         if (!optionalOpMefService.isPresent()) {
350             logger.warn("no mef-service found for svc-id {}", svcId);
351             return null;
352         }
353         MefService opMefService = optionalOpMefService.get();
354         return MefServicesUtils.getNetworkIdFromOpMefService(opMefService, unimgrNetworkId);
355     }
356
357     private static InstanceIdentifier<AllocationPool> createDhcpAllocationPoolInstanceIdentifier(String networkId,
358             IpPrefix subnet) {
359         return InstanceIdentifier.builder(DhcpAllocationPool.class).child(Network.class, new NetworkKey(networkId))
360                 .child(AllocationPool.class, new AllocationPoolKey(subnet)).build();
361     }
362
363     private static AllocationPool buildDhcpAllocationPool(UnimgrAllocationPool unimgrAllocationPool) {
364         AllocationPool allocationPool = new AllocationPoolBuilder()
365                 .setKey(new AllocationPoolKey(unimgrAllocationPool.getSubnet()))
366                 .setSubnet(unimgrAllocationPool.getSubnet()).setAllocateFrom(unimgrAllocationPool.getAllocateFrom())
367                 .setAllocateTo(unimgrAllocationPool.getAllocateTo()).setDnsServers(unimgrAllocationPool.getDnsServers())
368                 .setGateway(unimgrAllocationPool.getGateway()).build();
369         return allocationPool;
370     }
371
372 }