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 org.opendaylight.controller.md.sal.binding.api.DataBroker;
  12 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  13 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  14 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.L2vlan;
  15 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  16 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  17 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceBuilder;
  18 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlanBuilder;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.ParentRefs;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.ParentRefsBuilder;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.SplitHorizon;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.SplitHorizonBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInstance;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInstanceBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInterface;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInterface.EtreeInterfaceType;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInterfaceBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInstances;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInterfaces;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceKey;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterface;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterfaceBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterfaceKey;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVxlan;
  40 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  41 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
  42 import org.slf4j.Logger;
  43 import org.slf4j.LoggerFactory;
  44
  45 import com.google.common.base.Optional;
  46
  47 public class NetvirtUtils {
  48
  49     private static final Logger logger = LoggerFactory.getLogger(NetvirtUtils.class);
  50     private static final long DEFAULT_MAC_TIMEOUT = 300;
  51
  52     public static void createElanInstance(DataBroker dataBroker, String instanceName, boolean isEtree, Long segmentationId) {
  53         createElanInstance(dataBroker, instanceName, isEtree, segmentationId, DEFAULT_MAC_TIMEOUT);
  54     }
  55
  56     public static void createElanInstance(DataBroker dataBroker, String instanceName, boolean isEtree, Long segmentationId, Long macTimeout) {
  57         ElanInstanceBuilder einstBuilder = createElanInstanceBuilder(instanceName, segmentationId, macTimeout);
  58
  59         if (isEtree) {
  60             EtreeInstance etreeInstance = new EtreeInstanceBuilder().build();
  61             einstBuilder.addAugmentation(EtreeInstance.class, etreeInstance).build();
  62         }
  63
  64         MdsalUtils.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION,
  65                 getElanInstanceInstanceIdentifier(instanceName), einstBuilder.build());
  66     }
  67
  68     public static void updateElanInstance(DataBroker dataBroker, String instanceName) {
  69         WriteTransaction tx = MdsalUtils.createTransaction(dataBroker);
  70         updateElanInstance(instanceName, tx);
  71         MdsalUtils.commitTransaction(tx);
  72     }
  73
  74     public static void updateElanInstance(String instanceName, WriteTransaction tx) {
  75         ElanInstanceBuilder einstBuilder = createElanInstanceBuilder(instanceName);
  76         saveElanInstance(instanceName, tx, einstBuilder);
  77     }
  78
  79     public static void updateElanInstance(String instanceName, WriteTransaction tx, Long segmentationId) {
  80         ElanInstanceBuilder einstBuilder = createElanInstanceBuilder(instanceName, segmentationId);
  81         saveElanInstance(instanceName, tx, einstBuilder);
  82     }
  83
  84     public static void updateElanInstance(String instanceName, WriteTransaction tx, Long segmentationId, Long macTimeout) {
  85         ElanInstanceBuilder einstBuilder = createElanInstanceBuilder(instanceName, segmentationId, macTimeout);
  86         saveElanInstance(instanceName, tx, einstBuilder);
  87     }
  88
  89     private static void saveElanInstance(String instanceName, WriteTransaction tx, ElanInstanceBuilder einstBuilder) {
  90         tx.merge(LogicalDatastoreType.CONFIGURATION, getElanInstanceInstanceIdentifier(instanceName),
  91                 einstBuilder.build());
  92     }
  93
  94     public static void updateElanInterface(DataBroker dataBroker, String instanceName, String interfaceName) {
  95         ElanInterfaceBuilder einterfaceBuilder = createElanInterface(instanceName, interfaceName);
  96
  97         MdsalUtils.syncUpdate(dataBroker, LogicalDatastoreType.CONFIGURATION,
  98                 getElanInterfaceInstanceIdentifier(interfaceName), einterfaceBuilder.build());
  99     }
 100
 101     public static void deleteElanInstance(DataBroker dataBroker, String instanceName) {
 102         MdsalUtils.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION,
 103                 getElanInstanceInstanceIdentifier(instanceName));
 104     }
 105
 106     public static void deleteElanInstance(String instanceName, WriteTransaction tx) {
 107         tx.delete(LogicalDatastoreType.CONFIGURATION, getElanInstanceInstanceIdentifier(instanceName));
 108     }
 109
 110     public static void deleteElanInterface(DataBroker dataBroker, String interfaceName) {
 111         WriteTransaction tx = MdsalUtils.createTransaction(dataBroker);
 112         deleteElanInterface(interfaceName, tx);
 113         MdsalUtils.commitTransaction(tx);
 114     }
 115
 116     public static void deleteElanInterface(String interfaceName, WriteTransaction tx) {
 117         tx.delete(LogicalDatastoreType.CONFIGURATION, getElanInterfaceInstanceIdentifier(interfaceName));
 118     }
 119
 120     public static Interface createTrunkInterface(String interfaceName, String parentIfaceName) {
 121         IfL2vlanBuilder ifL2vlanBuilder = new IfL2vlanBuilder();
 122         ifL2vlanBuilder.setL2vlanMode(IfL2vlan.L2vlanMode.Trunk);
 123         return createInterface(interfaceName, parentIfaceName, ifL2vlanBuilder.build());
 124     }
 125
 126     public static Interface createTrunkMemberInterface(String interfaceName, String parentIfaceName, int vlanId) {
 127         IfL2vlanBuilder ifL2vlanBuilder = new IfL2vlanBuilder();
 128         ifL2vlanBuilder.setL2vlanMode(IfL2vlan.L2vlanMode.TrunkMember).setVlanId(new VlanId(vlanId));
 129         return createInterface(interfaceName, parentIfaceName, ifL2vlanBuilder.build());
 130     }
 131
 132     private static Interface createInterface(String interfaceName, String parentIfaceName, IfL2vlan ifL2vlan) {
 133         InterfaceBuilder interfaceBuilder = new InterfaceBuilder();
 134         SplitHorizon sh = new SplitHorizonBuilder().setOverrideSplitHorizonProtection(true).build();
 135         ParentRefsBuilder parentRefsBuilder = new ParentRefsBuilder().setParentInterface(parentIfaceName);
 136         interfaceBuilder.setEnabled(true).setName(interfaceName).setType(L2vlan.class)
 137                 .addAugmentation(SplitHorizon.class, sh)
 138                 .addAugmentation(IfL2vlan.class, ifL2vlan).addAugmentation(ParentRefs.class, parentRefsBuilder.build());
 139         return interfaceBuilder.build();
 140     }
 141
 142     private static ElanInstanceBuilder createElanInstanceBuilder(String instanceName) {
 143         return createElanInstanceBuilder(instanceName, Long.valueOf(Math.abs((short) instanceName.hashCode())));
 144     }
 145
 146     private static ElanInstanceBuilder createElanInstanceBuilder(String instanceName, Long segmentationId) {
 147         return createElanInstanceBuilder(instanceName, segmentationId, DEFAULT_MAC_TIMEOUT);
 148     }
 149
 150     private static ElanInstanceBuilder createElanInstanceBuilder(String instanceName, Long segmentationId, Long macTimeout) {
 151         if (segmentationId == null) {
 152             segmentationId = Long.valueOf(Math.abs((short) instanceName.hashCode()));
 153         }
 154         ElanInstanceBuilder einstBuilder = new ElanInstanceBuilder();
 155         einstBuilder.setElanInstanceName(instanceName);
 156         einstBuilder.setKey(new ElanInstanceKey(instanceName));
 157         einstBuilder.setMacTimeout(macTimeout);
 158         einstBuilder.setSegmentationId(segmentationId);
 159         einstBuilder.setSegmentType(SegmentTypeVxlan.class);
 160         return einstBuilder;
 161     }
 162
 163     private static ElanInterfaceBuilder createElanInterface(String instanceName, String interfaceName) {
 164         ElanInterfaceBuilder einterfaceBuilder = new ElanInterfaceBuilder();
 165         einterfaceBuilder.setElanInstanceName(instanceName);
 166         einterfaceBuilder.setName(interfaceName);
 167         return einterfaceBuilder;
 168     }
 169
 170     private static ElanInterfaceBuilder createEtreeInterface(String instanceName, String interfaceName,
 171             EtreeInterfaceType interfaceType) {
 172         ElanInterfaceBuilder einterfaceBuilder = new ElanInterfaceBuilder();
 173         einterfaceBuilder.setElanInstanceName(instanceName);
 174         einterfaceBuilder.setName(interfaceName);
 175         EtreeInterface etreeInterface = new EtreeInterfaceBuilder().setEtreeInterfaceType(interfaceType).build();
 176         einterfaceBuilder.addAugmentation(EtreeInterface.class, etreeInterface);
 177         return einterfaceBuilder;
 178     }
 179
 180     public static InstanceIdentifier<ElanInstance> getElanInstanceInstanceIdentifier() {
 181         return InstanceIdentifier.builder(ElanInstances.class).child(ElanInstance.class).build();
 182     }
 183
 184     public static InstanceIdentifier<ElanInterfaces> getElanInterfacesInstanceIdentifier() {
 185         return InstanceIdentifier.builder(ElanInterfaces.class).build();
 186     }
 187
 188     public static InstanceIdentifier<ElanInstance> getElanInstanceInstanceIdentifier(String instanceName) {
 189         return InstanceIdentifier.builder(ElanInstances.class)
 190                 .child(ElanInstance.class, new ElanInstanceKey(instanceName)).build();
 191     }
 192
 193     private static InstanceIdentifier<ElanInterface> getElanInterfaceInstanceIdentifier(String interfaceName) {
 194         return InstanceIdentifier.builder(ElanInterfaces.class)
 195                 .child(ElanInterface.class, new ElanInterfaceKey(interfaceName)).build();
 196     }
 197
 198     public static InstanceIdentifier<Interface> getInterfaceIdentifier(String interfaceName) {
 199         InstanceIdentifierBuilder<Interface> idBuilder = InstanceIdentifier.builder(Interfaces.class)
 200                 .child(Interface.class, new InterfaceKey(interfaceName));
 201         InstanceIdentifier<Interface> id = idBuilder.build();
 202         return id;
 203     }
 204
 205     public static Optional<Interface> getIetfInterface(DataBroker dataBroker, String interfaceName) {
 206         return MdsalUtils.read(dataBroker, LogicalDatastoreType.CONFIGURATION, getInterfaceIdentifier(interfaceName));
 207     }
 208
 209     public static void writeInterface(Interface iface, WriteTransaction tx) {
 210         String interfaceName = iface.getName();
 211         InstanceIdentifier<Interface> interfaceIdentifier = createInterfaceIdentifier(interfaceName);
 212         tx.put(LogicalDatastoreType.CONFIGURATION, interfaceIdentifier, iface, true);
 213     }
 214
 215     public static void deleteInterface(String interfaceName, WriteTransaction tx) {
 216         InstanceIdentifier<Interface> interfaceIdentifier = createInterfaceIdentifier(interfaceName);
 217         tx.delete(LogicalDatastoreType.CONFIGURATION, interfaceIdentifier);
 218     }
 219
 220     private static InstanceIdentifier<Interface> createInterfaceIdentifier(String interfaceName) {
 221         return InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new InterfaceKey(interfaceName))
 222                 .build();
 223     }
 224
 225     public static void createElanInterface(DataBroker dataBroker, String instanceName, String interfaceName,
 226             EtreeInterfaceType etreeInterfaceType, boolean isEtree) {
 227         WriteTransaction tx = MdsalUtils.createTransaction(dataBroker);
 228         createElanInterface(instanceName, interfaceName, etreeInterfaceType, isEtree, tx);
 229         MdsalUtils.commitTransaction(tx);
 230     }
 231
 232     public static void createElanInterface(String instanceName, String interfaceName,
 233             EtreeInterfaceType etreeInterfaceType, boolean isEtree, WriteTransaction tx) {
 234         logger.info("Adding {} interface: {}", isEtree ? "etree" : "elan", interfaceName);
 235
 236         if (isEtree) {
 237             NetvirtUtils.createEtreeInterface(instanceName, interfaceName, etreeInterfaceType, tx);
 238         } else {
 239             NetvirtUtils.createElanInterface(instanceName, interfaceName, tx);
 240         }
 241     }
 242
 243     private static void createEtreeInterface(String instanceName, String interfaceName, EtreeInterfaceType type,
 244             WriteTransaction tx) {
 245         ElanInterfaceBuilder einterfaceBuilder = createEtreeInterface(instanceName, interfaceName, type);
 246
 247         tx.put(LogicalDatastoreType.CONFIGURATION, getElanInterfaceInstanceIdentifier(interfaceName),
 248                 einterfaceBuilder.build());
 249     }
 250
 251     private static void createElanInterface(String instanceName, String interfaceName, WriteTransaction tx) {
 252         ElanInterfaceBuilder einterfaceBuilder = createElanInterface(instanceName, interfaceName);
 253
 254         tx.put(LogicalDatastoreType.CONFIGURATION, getElanInterfaceInstanceIdentifier(interfaceName),
 255                 einterfaceBuilder.build());
 256     }
 257
 258     public static void safeSleep() {
 259         try {
 260             Thread.yield();
 261             Thread.sleep(1000);
 262         } catch (InterruptedException e) {
 263         }
 264     }
 265     public static void safeSleep(short sec) {
 266         try {
 267             Thread.yield();
 268             Thread.sleep(1000*sec);
 269         } catch (InterruptedException e) {
 270         }
 271     }
 272
 273
 274 }