interfacemgr/interfacemgr-impl/src/main/java/org/opendaylight/vpnservice/interfacemgr/renderer/ovs/confighelpers/OvsInterfaceConfigAddHelper.java

   1 /*
   2  * Copyright (c) 2015 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 package org.opendaylight.vpnservice.interfacemgr.renderer.ovs.confighelpers;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.util.concurrent.ListenableFuture;
  12 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  13 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  14 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  15 import org.opendaylight.idmanager.IdManager;
  16 import org.opendaylight.vpnservice.interfacemgr.IfmUtil;
  17 import org.opendaylight.vpnservice.interfacemgr.commons.InterfaceManagerCommonUtils;
  18 import org.opendaylight.vpnservice.interfacemgr.commons.InterfaceMetaUtils;
  19 import org.opendaylight.vpnservice.interfacemgr.renderer.ovs.utilities.SouthboundUtils;
  20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.OperStatus;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.AdminStatus;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._interface.child.info.InterfaceParentEntry;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._interface.child.info.InterfaceParentEntryKey;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._interface.child.info._interface.parent.entry.InterfaceChildEntry;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.bridge._interface.info.BridgeEntry;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.bridge._interface.info.BridgeEntryBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.bridge._interface.info.BridgeEntryKey;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.bridge._interface.info.bridge.entry.BridgeInterfaceEntryKey;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.bridge.ref.info.BridgeRefEntry;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.bridge.ref.info.BridgeRefEntryKey;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.IfL2vlan;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.IfTunnel;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.ParentRefs;
  40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  42 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  43 import org.slf4j.Logger;
  44 import org.slf4j.LoggerFactory;
  45
  46 import java.math.BigInteger;
  47 import java.util.ArrayList;
  48 import java.util.List;
  49
  50 public class OvsInterfaceConfigAddHelper {
  51     private static final Logger LOG = LoggerFactory.getLogger(OvsInterfaceConfigAddHelper.class);
  52
  53     public static List<ListenableFuture<Void>> addConfiguration(DataBroker dataBroker, ParentRefs parentRefs,
  54                                                                 Interface interfaceNew, IdManager idManager) {
  55         List<ListenableFuture<Void>> futures = new ArrayList<>();
  56         WriteTransaction t = dataBroker.newWriteOnlyTransaction();
  57
  58         IfTunnel ifTunnel = interfaceNew.getAugmentation(IfTunnel.class);
  59         if (ifTunnel != null) {
  60             addTunnelConfiguration(dataBroker, parentRefs, interfaceNew, idManager, t);
  61             futures.add(t.submit());
  62             return futures;
  63         }
  64
  65         addVlanConfiguration(interfaceNew, t, dataBroker);
  66         futures.add(t.submit());
  67         return futures;
  68     }
  69
  70     private static void addVlanConfiguration(Interface interfaceNew, WriteTransaction t, DataBroker dataBroker) {
  71         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface ifState =
  72                 InterfaceManagerCommonUtils.getInterfaceStateFromOperDS(interfaceNew.getName(), dataBroker);
  73         if (ifState == null) {
  74             return;
  75         }
  76         updateStateEntry(interfaceNew, t, ifState);
  77
  78         IfL2vlan ifL2vlan = interfaceNew.getAugmentation(IfL2vlan.class);
  79         if (ifL2vlan == null || ifL2vlan.getL2vlanMode() != IfL2vlan.L2vlanMode.Trunk) {
  80             return;
  81         }
  82
  83         InterfaceParentEntryKey interfaceParentEntryKey = new InterfaceParentEntryKey(interfaceNew.getName());
  84         InterfaceParentEntry interfaceParentEntry =
  85                 InterfaceMetaUtils.getInterfaceParentEntryFromConfigDS(interfaceParentEntryKey, dataBroker);
  86         if (interfaceParentEntry == null) {
  87             return;
  88         }
  89
  90         List<InterfaceChildEntry> interfaceChildEntries = interfaceParentEntry.getInterfaceChildEntry();
  91         if (interfaceChildEntries == null) {
  92             return;
  93         }
  94
  95         OperStatus operStatus = ifState.getOperStatus();
  96         PhysAddress physAddress = ifState.getPhysAddress();
  97         AdminStatus adminStatus = ifState.getAdminStatus();
  98         NodeConnectorId nodeConnectorId = new NodeConnectorId(ifState.getLowerLayerIf().get(0));
  99
 100         //FIXME: If the no. of child entries exceeds 100, perform txn updates in batches of 100.
 101         for (InterfaceChildEntry interfaceChildEntry : interfaceChildEntries) {
 102             InterfaceKey childIfKey = new InterfaceKey(interfaceChildEntry.getChildInterface());
 103             org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface ifaceChild =
 104                     InterfaceManagerCommonUtils.getInterfaceFromConfigDS(childIfKey, dataBroker);
 105
 106             if (!ifaceChild.isEnabled()) {
 107                 operStatus = OperStatus.Down;
 108             }
 109
 110             InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> ifChildStateId =
 111                     IfmUtil.buildStateInterfaceId(ifaceChild.getName());
 112             List<String> childLowerLayerIfList = new ArrayList<>();
 113             childLowerLayerIfList.add(0, nodeConnectorId.getValue());
 114             childLowerLayerIfList.add(1, interfaceNew.getName());
 115             InterfaceBuilder childIfaceBuilder = new InterfaceBuilder().setAdminStatus(adminStatus)
 116                     .setOperStatus(operStatus).setPhysAddress(physAddress).setLowerLayerIf(childLowerLayerIfList);
 117             childIfaceBuilder.setKey(IfmUtil.getStateInterfaceKeyFromName(ifaceChild.getName()));
 118             t.put(LogicalDatastoreType.OPERATIONAL, ifChildStateId, childIfaceBuilder.build(), true);
 119         }
 120     }
 121
 122     private static void addTunnelConfiguration(DataBroker dataBroker, ParentRefs parentRefs,
 123                                               Interface interfaceNew, IdManager idManager,
 124                                               WriteTransaction t) {
 125         if (parentRefs == null) {
 126             LOG.warn("ParentRefs for interface: {} Not Found. " +
 127                     "Creation of Tunnel OF-Port not supported when dpid not provided.", interfaceNew.getName());
 128             return;
 129         }
 130
 131         BigInteger dpId = parentRefs.getDatapathNodeIdentifier();
 132         if (dpId == null) {
 133             LOG.warn("dpid for interface: {} Not Found. No DPID provided. " +
 134                     "Creation of OF-Port not supported.", interfaceNew.getName());
 135             return;
 136         }
 137
 138         createBridgeEntryIfNotPresent(dpId, dataBroker, t);
 139
 140         BridgeRefEntryKey BridgeRefEntryKey = new BridgeRefEntryKey(dpId);
 141         InstanceIdentifier<BridgeRefEntry> dpnBridgeEntryIid =
 142                 InterfaceMetaUtils.getBridgeRefEntryIdentifier(BridgeRefEntryKey);
 143         BridgeRefEntry bridgeRefEntry =
 144                 InterfaceMetaUtils.getBridgeRefEntryFromOperDS(dpnBridgeEntryIid, dataBroker);
 145         BridgeEntryKey bridgeEntryKey = new BridgeEntryKey(dpId);
 146         BridgeInterfaceEntryKey bridgeInterfaceEntryKey = new BridgeInterfaceEntryKey(interfaceNew.getName());
 147         if (bridgeRefEntry == null) {
 148             InterfaceMetaUtils.createBridgeInterfaceEntryInConfigDS(bridgeEntryKey, bridgeInterfaceEntryKey,
 149                     interfaceNew.getName(), t);
 150             return;
 151         }
 152
 153         InstanceIdentifier<OvsdbBridgeAugmentation> bridgeIid =
 154                 (InstanceIdentifier<OvsdbBridgeAugmentation>)bridgeRefEntry.getBridgeReference().getValue();
 155         Optional<OvsdbBridgeAugmentation> bridgeNodeOptional =
 156                 IfmUtil.read(LogicalDatastoreType.OPERATIONAL, bridgeIid, dataBroker);
 157         if (bridgeNodeOptional.isPresent()) {
 158             OvsdbBridgeAugmentation ovsdbBridgeAugmentation = bridgeNodeOptional.get();
 159             String bridgeName = ovsdbBridgeAugmentation.getBridgeName().getValue();
 160             SouthboundUtils.addPortToBridge(bridgeIid, interfaceNew,
 161                     ovsdbBridgeAugmentation, bridgeName, interfaceNew.getName(), dataBroker, t);
 162         }
 163
 164         InstanceIdentifier<TerminationPoint> tpIid = SouthboundUtils.createTerminationPointInstanceIdentifier(
 165             InstanceIdentifier.keyOf(bridgeIid.firstIdentifierOf(Node.class)), interfaceNew.getName());
 166         InterfaceMetaUtils.createBridgeInterfaceEntryInConfigDS(bridgeEntryKey, bridgeInterfaceEntryKey,
 167                 interfaceNew.getName(), tpIid, t);
 168     }
 169
 170     private static void updateStateEntry(Interface interfaceNew, WriteTransaction t,
 171                                          org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface ifState) {
 172         OperStatus operStatus;
 173         if (!interfaceNew.isEnabled() && ifState.getOperStatus() != OperStatus.Down) {
 174             operStatus = OperStatus.Down;
 175             InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> ifStateId =
 176                     IfmUtil.buildStateInterfaceId(interfaceNew.getName());
 177             InterfaceBuilder ifaceBuilder = new InterfaceBuilder();
 178             ifaceBuilder.setOperStatus(operStatus);
 179             ifaceBuilder.setKey(IfmUtil.getStateInterfaceKeyFromName(interfaceNew.getName()));
 180             t.merge(LogicalDatastoreType.OPERATIONAL, ifStateId, ifaceBuilder.build());
 181         }
 182     }
 183
 184     private static void createBridgeEntryIfNotPresent(BigInteger dpId,
 185                                                       DataBroker dataBroker, WriteTransaction t) {
 186         BridgeEntryKey bridgeEntryKey = new BridgeEntryKey(dpId);
 187         InstanceIdentifier<BridgeEntry> bridgeEntryInstanceIdentifier =
 188                 InterfaceMetaUtils.getBridgeEntryIdentifier(bridgeEntryKey);
 189         BridgeEntry bridgeEntry =
 190                 InterfaceMetaUtils.getBridgeEntryFromConfigDS(bridgeEntryInstanceIdentifier,
 191                         dataBroker);
 192         if (bridgeEntry == null) {
 193             BridgeEntryBuilder bridgeEntryBuilder = new BridgeEntryBuilder().setKey(bridgeEntryKey)
 194                     .setDpid(dpId);
 195             t.put(LogicalDatastoreType.CONFIGURATION, bridgeEntryInstanceIdentifier, bridgeEntryBuilder.build(), true);
 196         }
 197     }
 198 }