vpnservice/vpnmanager/vpnmanager-impl/src/main/java/org/opendaylight/netvirt/vpnmanager/SubnetmapChangeListener.java

   1 /*
   2  * Copyright (c) 2016, 2017 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
   9 package org.opendaylight.netvirt.vpnmanager;
  10
  11 import com.google.common.base.Optional;
  12 import java.util.ArrayList;
  13 import java.util.List;
  14 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  15 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  16 import org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase;
  17 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInstances;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceKey;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
  24 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28
  29 public class SubnetmapChangeListener extends AsyncDataTreeChangeListenerBase<Subnetmap, SubnetmapChangeListener> {
  30     private static final Logger LOG = LoggerFactory.getLogger(SubnetmapChangeListener.class);
  31     private final DataBroker dataBroker;
  32     private final VpnSubnetRouteHandler vpnSubnetRouteHandler;
  33
  34     public SubnetmapChangeListener(final DataBroker dataBroker, final VpnSubnetRouteHandler vpnSubnetRouteHandler) {
  35         super(Subnetmap.class, SubnetmapChangeListener.class);
  36         this.dataBroker = dataBroker;
  37         this.vpnSubnetRouteHandler = vpnSubnetRouteHandler;
  38     }
  39
  40     public void start() {
  41         LOG.info("{} start", getClass().getSimpleName());
  42         registerListener(dataBroker);
  43     }
  44
  45     @Override
  46     protected InstanceIdentifier<Subnetmap> getWildCardPath() {
  47         return InstanceIdentifier.create(Subnetmaps.class).child(Subnetmap.class);
  48     }
  49
  50     // TODO Clean up the exception handling
  51     @SuppressWarnings("checkstyle:IllegalCatch")
  52     private void registerListener(final DataBroker db) {
  53         try {
  54             registerListener(LogicalDatastoreType.CONFIGURATION, db);
  55         } catch (final Exception e) {
  56             LOG.error("VPNManager subnetMap config DataChange listener registration fail!", e);
  57             throw new IllegalStateException("VPNManager subnetMap config DataChange listener registration failed.", e);
  58         }
  59     }
  60
  61     @Override
  62     protected void add(InstanceIdentifier<Subnetmap> identifier, Subnetmap subnetmap) {
  63         LOG.trace("add:SubnetmapChangeListener add subnetmap method - key {}, value={}",identifier, subnetmap);
  64         Uuid subnetId = subnetmap.getId();
  65         Uuid vpnId = subnetmap.getVpnId();
  66         if (subnetmap.getVpnId() != null) {
  67             // SubnetRoute for ExternalSubnets is handled in ExternalSubnetVpnInstanceListener.
  68             // Here we must handle only InternalVpnSubnetRoute and BGPVPNBasedSubnetRoute
  69             Network network = VpnUtil.getNeutronNetwork(dataBroker, subnetmap.getNetworkId());
  70             if (VpnUtil.getIsExternal(network)) {
  71                 return;
  72             }
  73             boolean isBgpVpn = !vpnId.equals(subnetmap.getRouterId());
  74             String elanInstanceName = subnetmap.getNetworkId().getValue();
  75             Long elanTag = getElanTag(elanInstanceName);
  76             if (elanTag.equals(0L)) {
  77                 LOG.error("add:Unable to fetch elantag from ElanInstance {} and hence not proceeding with "
  78                         + "subnetmapListener add for subnet {}", elanInstanceName, subnetId.getValue());
  79                 return;
  80             }
  81             // subnet added to VPN case upon config DS replay after reboot
  82             // ports added to subnet upon config DS replay after reboot are handled implicitly by subnetAddedToVpn
  83             // in SubnetRouteHandler
  84             vpnSubnetRouteHandler.onSubnetAddedToVpn(subnetmap, isBgpVpn , elanTag);
  85         }
  86     }
  87
  88     @Override
  89     protected void remove(InstanceIdentifier<Subnetmap> identifier, Subnetmap subnetmap) {
  90         LOG.trace("remove:SubnetmapChangeListener remove subnetmap method - key: {}  value {}", identifier, subnetmap);
  91     }
  92
  93     @Override
  94     // TODO Clean up the exception handling
  95     @SuppressWarnings("checkstyle:IllegalCatch")
  96     protected void update(InstanceIdentifier<Subnetmap> identifier, Subnetmap subnetmapOriginal, Subnetmap
  97             subnetmapUpdate) {
  98         LOG.trace("update:SubnetmapListener update subnetmap method - key: {}, original: {}, update: {}",
  99                     identifier, subnetmapOriginal, subnetmapUpdate);
 100         Uuid vpnIdNew = subnetmapUpdate.getVpnId();
 101         Uuid vpnIdOld = subnetmapOriginal.getVpnId();
 102         Uuid subnetId = subnetmapUpdate.getId();
 103         String elanInstanceName = subnetmapUpdate.getNetworkId().getValue();
 104         // SubnetRoute for ExternalSubnets is handled in ExternalSubnetVpnInstanceListener.
 105         // Here we must handle only InternalVpnSubnetRoute and BGPVPNBasedSubnetRoute
 106         Network network = VpnUtil.getNeutronNetwork(dataBroker, subnetmapUpdate.getNetworkId());
 107         if (VpnUtil.getIsExternal(network)) {
 108             return;
 109         }
 110         Long elanTag = getElanTag(elanInstanceName);
 111         if (elanTag.equals(0L)) {
 112             LOG.error("update:Unable to fetch elantag from ElanInstance {} and hence not proceeding with "
 113                 + "subnetmapListener update for subnet {}", elanInstanceName, subnetId.getValue());
 114             return;
 115         }
 116         // subnet added to VPN case
 117         if (vpnIdNew != null && vpnIdOld == null) {
 118             boolean isBgpVpn = !vpnIdNew.equals(subnetmapUpdate.getRouterId());
 119             if (!isBgpVpn) {
 120                 return;
 121             }
 122             vpnSubnetRouteHandler.onSubnetAddedToVpn(subnetmapUpdate, true, elanTag);
 123             return;
 124         }
 125         // subnet removed from VPN case
 126         if (vpnIdOld != null && vpnIdNew == null) {
 127             Boolean isBgpVpn = vpnIdOld.equals(subnetmapOriginal.getRouterId()) ? false : true;
 128             if (!isBgpVpn) {
 129                 return;
 130             }
 131             vpnSubnetRouteHandler.onSubnetDeletedFromVpn(subnetmapOriginal, true);
 132             return;
 133         }
 134         // subnet updated in VPN case
 135         if (vpnIdOld != null && vpnIdNew != null && (!vpnIdNew.equals(vpnIdOld))) {
 136             vpnSubnetRouteHandler.onSubnetUpdatedInVpn(subnetmapUpdate, elanTag);
 137             return;
 138         }
 139         // port added/removed to/from subnet case
 140         List<Uuid> oldPortList;
 141         List<Uuid> newPortList;
 142         newPortList = subnetmapUpdate.getPortList() != null ? subnetmapUpdate.getPortList() : new ArrayList<>();
 143         oldPortList = subnetmapOriginal.getPortList() != null ? subnetmapOriginal.getPortList() : new ArrayList<>();
 144         if (newPortList.size() == oldPortList.size()) {
 145             return;
 146         }
 147         if (newPortList.size() > oldPortList.size()) {
 148             for (Uuid portId : newPortList) {
 149                 if (! oldPortList.contains(portId)) {
 150                     vpnSubnetRouteHandler.onPortAddedToSubnet(subnetmapUpdate, portId);
 151                     return;
 152                 }
 153             }
 154         } else {
 155             for (Uuid portId : oldPortList) {
 156                 if (! newPortList.contains(portId)) {
 157                     vpnSubnetRouteHandler.onPortRemovedFromSubnet(subnetmapUpdate, portId);
 158                     return;
 159                 }
 160             }
 161         }
 162     }
 163
 164     @Override
 165     protected SubnetmapChangeListener getDataTreeChangeListener() {
 166         return this;
 167     }
 168
 169     // TODO Clean up the exception handling
 170     @SuppressWarnings("checkstyle:IllegalCatch")
 171     protected long getElanTag(String elanInstanceName) {
 172         InstanceIdentifier<ElanInstance> elanIdentifierId = InstanceIdentifier.builder(ElanInstances.class)
 173                 .child(ElanInstance.class, new ElanInstanceKey(elanInstanceName)).build();
 174         long elanTag = 0L;
 175         try {
 176             Optional<ElanInstance> elanInstance = VpnUtil.read(dataBroker, LogicalDatastoreType
 177                     .CONFIGURATION, elanIdentifierId);
 178             if (elanInstance.isPresent()) {
 179                 elanTag = elanInstance.get().getElanTag();
 180             } else {
 181                 LOG.error("Notification failed because of failure in reading ELANInstance {}", elanInstanceName);
 182             }
 183         } catch (Exception e) {
 184             LOG.error("Notification failed because of failure in fetching elanTag from ElanInstance {} config DS",
 185                 elanInstanceName, e);
 186         }
 187         return elanTag;
 188     }
 189 }