neutronvpn/impl/src/main/java/org/opendaylight/netvirt/neutronvpn/NeutronTrunkChangeListener.java

   1 /*
   2  * Copyright (c) 2017, 2018 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.netvirt.neutronvpn;
   9
  10 import static org.opendaylight.genius.infra.Datastore.CONFIGURATION;
  11
  12 import com.google.common.base.Preconditions;
  13 import java.util.ArrayList;
  14 import java.util.Collections;
  15 import java.util.List;
  16 import javax.annotation.PostConstruct;
  17 import javax.inject.Inject;
  18 import javax.inject.Singleton;
  19 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  20 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  21 import org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase;
  22 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
  23 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
  24 import org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager;
  25 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev170119.L2vlan;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceBuilder;
  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.genius.interfacemanager.rev160406.SplitHorizon;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.SplitHorizonBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVlan;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.trunks.rev170118.trunk.attributes.SubPorts;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.trunks.rev170118.trunks.attributes.Trunks;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.trunks.rev170118.trunks.attributes.trunks.Trunk;
  41 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  42 import org.slf4j.Logger;
  43 import org.slf4j.LoggerFactory;
  44
  45 @Singleton
  46 public class NeutronTrunkChangeListener extends AsyncDataTreeChangeListenerBase<Trunk, NeutronTrunkChangeListener> {
  47     private static final Logger LOG = LoggerFactory.getLogger(NeutronTrunkChangeListener.class);
  48
  49     private final DataBroker dataBroker;
  50     private final ManagedNewTransactionRunner txRunner;
  51     private final IInterfaceManager ifMgr;
  52     private final JobCoordinator jobCoordinator;
  53
  54     @Inject
  55     public NeutronTrunkChangeListener(final DataBroker dataBroker, final IInterfaceManager ifMgr,
  56             final JobCoordinator jobCoordinator) {
  57         this.dataBroker = dataBroker;
  58         this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
  59         this.ifMgr = ifMgr;
  60         this.jobCoordinator = jobCoordinator;
  61     }
  62
  63     @Override
  64     @PostConstruct
  65     public void init() {
  66         LOG.info("{} init", getClass().getSimpleName());
  67         registerListener(LogicalDatastoreType.CONFIGURATION, dataBroker);
  68     }
  69
  70     @Override
  71     protected InstanceIdentifier<Trunk> getWildCardPath() {
  72         return InstanceIdentifier.create(Neutron.class).child(Trunks.class).child(Trunk.class);
  73     }
  74
  75     @Override
  76     protected NeutronTrunkChangeListener getDataTreeChangeListener() {
  77         return NeutronTrunkChangeListener.this;
  78     }
  79
  80     @Override
  81     protected void add(InstanceIdentifier<Trunk> identifier, Trunk input) {
  82         Preconditions.checkNotNull(input.getPortId());
  83         LOG.trace("Adding Trunk : key: {}, value={}", identifier, input);
  84         List<SubPorts> subPorts = input.getSubPorts();
  85         if (subPorts != null) {
  86             subPorts.forEach(subPort -> createSubPortInterface(input, subPort));
  87         }
  88     }
  89
  90     @Override
  91     protected void remove(InstanceIdentifier<Trunk> identifier, Trunk input) {
  92         Preconditions.checkNotNull(input.getPortId());
  93         LOG.trace("Removing Trunk : key: {}, value={}", identifier, input);
  94         List<SubPorts> subPorts = input.getSubPorts();
  95         if (subPorts != null) {
  96             subPorts.forEach(this::deleteSubPortInterface);
  97         }
  98     }
  99
 100     @Override
 101     protected void update(InstanceIdentifier<Trunk> identifier, Trunk original, Trunk update) {
 102         List<SubPorts> updatedSubPorts = update.getSubPorts();
 103         if (updatedSubPorts == null) {
 104             updatedSubPorts = Collections.emptyList();
 105         }
 106         List<SubPorts> originalSubPorts = original.getSubPorts();
 107         if (originalSubPorts == null) {
 108             originalSubPorts = Collections.emptyList();
 109         }
 110         List<SubPorts> added = new ArrayList<>(updatedSubPorts);
 111         added.removeAll(originalSubPorts);
 112         List<SubPorts> deleted = new ArrayList<>(originalSubPorts);
 113         deleted.removeAll(updatedSubPorts);
 114
 115         LOG.trace("Updating Trunk : key: {}. subPortsAdded={}, subPortsDeleted={}", identifier, added, deleted);
 116         deleted.forEach(this::deleteSubPortInterface);
 117         added.forEach(subPort -> createSubPortInterface(update, subPort));
 118     }
 119
 120     private void createSubPortInterface(Trunk trunk, SubPorts subPort) {
 121         if (!NetworkTypeVlan.class.equals(subPort.getSegmentationType())) {
 122             LOG.warn("SegmentationType other than VLAN not supported for Trunk:SubPorts");
 123             return;
 124         }
 125         String portName = subPort.getPortId().getValue();
 126         String parentName = trunk.getPortId().getValue();
 127         InstanceIdentifier<Interface> interfaceIdentifier = NeutronvpnUtils.buildVlanInterfaceIdentifier(portName);
 128
 129         // Should we use parentName?
 130         jobCoordinator.enqueueJob("PORT- " + portName, () -> {
 131             Interface iface = ifMgr.getInterfaceInfoFromConfigDataStore(portName);
 132             if (iface == null) {
 133                 /*
 134                  * Trunk creation requires NeutronPort to be present, by this time interface
 135                  * should've been created. In controller restart use case Interface would already be present.
 136                  * Clustering consideration:
 137                  *      This being same shard as NeutronPort, interface creation will be triggered on the same
 138                  *      node as this one. Use of DSJC helps ensure the order.
 139                  */
 140                 LOG.warn("Interface not present for Trunk SubPort: {}", subPort);
 141                 return Collections.emptyList();
 142             }
 143             InterfaceBuilder interfaceBuilder = new InterfaceBuilder();
 144             IfL2vlan ifL2vlan = new IfL2vlanBuilder().setL2vlanMode(IfL2vlan.L2vlanMode.TrunkMember)
 145                 .setVlanId(new VlanId(subPort.getSegmentationId().intValue())).build();
 146             ParentRefs parentRefs = new ParentRefsBuilder().setParentInterface(parentName).build();
 147             SplitHorizon splitHorizon = new SplitHorizonBuilder().setOverrideSplitHorizonProtection(true).build();
 148             interfaceBuilder.setName(portName).setType(L2vlan.class).addAugmentation(IfL2vlan.class, ifL2vlan)
 149                 .addAugmentation(ParentRefs.class, parentRefs).addAugmentation(SplitHorizon.class, splitHorizon);
 150             Interface newIface = interfaceBuilder.build();
 151             /*
 152              * Interface is already created for parent NeutronPort. We're updating parent refs
 153              * and VLAN Information
 154              */
 155             return Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
 156                 CONFIGURATION, tx -> {
 157                     tx.merge(interfaceIdentifier, newIface);
 158                     LOG.trace("Creating trunk member interface {}", newIface);
 159                 }));
 160         });
 161     }
 162
 163     private void deleteSubPortInterface(SubPorts subPort) {
 164         String portName = subPort.getPortId().getValue();
 165         InstanceIdentifier<Interface> interfaceIdentifier =
 166                         NeutronvpnUtils.buildVlanInterfaceIdentifier(subPort.getPortId().getValue());
 167         jobCoordinator.enqueueJob("PORT- " + portName, () -> {
 168             Interface iface = ifMgr.getInterfaceInfoFromConfigDataStore(portName);
 169             if (iface == null) {
 170                 LOG.warn("Interface not present for SubPort {}", subPort);
 171                 return Collections.emptyList();
 172             }
 173             /*
 174              * We'll reset interface back to way it was? Can IFM handle parentRef delete?
 175              */
 176             InterfaceBuilder interfaceBuilder = new InterfaceBuilder(iface);
 177             // Reset augmentations
 178             interfaceBuilder.removeAugmentation(IfL2vlan.class).removeAugmentation(ParentRefs.class)
 179                 .removeAugmentation(SplitHorizon.class);
 180             IfL2vlan ifL2vlan = new IfL2vlanBuilder().setL2vlanMode(IfL2vlan.L2vlanMode.Trunk).build();
 181             interfaceBuilder.addAugmentation(IfL2vlan.class, ifL2vlan);
 182             Interface newIface = interfaceBuilder.build();
 183             /*
 184              * There is no means to do an update to remove elements from a node.
 185              * Our solution is to get existing iface, remove parentRef and VlanId,
 186              * and do a put to replace existing entry. This works out better as put
 187              * has better performance than merge.
 188              * Only drawback is any in-flight changes might be lost, but that is a corner case
 189              * and this being subport delete path, don't expect any significant changes to
 190              * corresponding Neutron Port. Deletion of NeutronPort should follow soon enough.
 191              */
 192             return Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
 193                 CONFIGURATION, tx -> {
 194                     tx.put(interfaceIdentifier, newIface);
 195                     LOG.trace("Resetting trunk member interface {}", newIface);
 196                 }));
 197         });
 198
 199     }
 200 }