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