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 java.util.Objects;
  15 import java.util.Set;
  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.controller.md.sal.common.api.data.ReadFailedException;
  22 import org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase;
  23 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
  24 import org.opendaylight.netvirt.vpnmanager.api.IVpnManager;
  25 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.vpntargets.VpnTarget;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInstances;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceKey;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkAttributes.NetworkType;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
  34 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37
  38 @Singleton
  39 public class SubnetmapChangeListener extends AsyncDataTreeChangeListenerBase<Subnetmap, SubnetmapChangeListener> {
  40     private static final Logger LOG = LoggerFactory.getLogger(SubnetmapChangeListener.class);
  41     private final DataBroker dataBroker;
  42     private final VpnSubnetRouteHandler vpnSubnetRouteHandler;
  43     private final VpnUtil vpnUtil;
  44     private final IVpnManager vpnManager;
  45
  46     @Inject
  47     public SubnetmapChangeListener(final DataBroker dataBroker, final VpnSubnetRouteHandler vpnSubnetRouteHandler,
  48                                    VpnUtil vpnUtil, IVpnManager vpnManager) {
  49         super(Subnetmap.class, SubnetmapChangeListener.class);
  50         this.dataBroker = dataBroker;
  51         this.vpnSubnetRouteHandler = vpnSubnetRouteHandler;
  52         this.vpnUtil = vpnUtil;
  53         this.vpnManager = vpnManager;
  54     }
  55
  56     @PostConstruct
  57     public void start() {
  58         LOG.info("{} start", getClass().getSimpleName());
  59         registerListener(dataBroker);
  60     }
  61
  62     @Override
  63     protected InstanceIdentifier<Subnetmap> getWildCardPath() {
  64         return InstanceIdentifier.create(Subnetmaps.class).child(Subnetmap.class);
  65     }
  66
  67     // TODO Clean up the exception handling
  68     @SuppressWarnings("checkstyle:IllegalCatch")
  69     private void registerListener(final DataBroker db) {
  70         try {
  71             registerListener(LogicalDatastoreType.CONFIGURATION, db);
  72         } catch (final Exception e) {
  73             LOG.error("VPNManager subnetMap config DataChange listener registration fail!", e);
  74             throw new IllegalStateException("VPNManager subnetMap config DataChange listener registration failed.", e);
  75         }
  76     }
  77
  78     @Override
  79     protected void add(InstanceIdentifier<Subnetmap> identifier, Subnetmap subnetmap) {
  80         LOG.debug("SubnetmapChangeListener add subnetmap method - key: {}, value: {}", identifier, subnetmap);
  81         Uuid subnetId = subnetmap.getId();
  82         Network network = vpnUtil.getNeutronNetwork(subnetmap.getNetworkId());
  83         if (network == null) {
  84             LOG.error("SubnetMapChangeListener:add: network was not found for subnetId {}", subnetId.getValue());
  85             return;
  86         }
  87         if (subnetmap.getVpnId() != null) {
  88             if (NetworkType.VLAN.equals(subnetmap.getNetworkType())) {
  89                 vpnUtil.addRouterPortToElanDpnListForVlaninAllDpn(subnetmap.getVpnId().getValue());
  90             }
  91         }
  92         if (VpnUtil.getIsExternal(network)) {
  93             LOG.debug("SubnetmapListener:add: provider subnetwork {} is handling in "
  94                       + "ExternalSubnetVpnInstanceListener", subnetId.getValue());
  95             return;
  96         }
  97         String elanInstanceName = subnetmap.getNetworkId().getValue();
  98         long elanTag = getElanTag(elanInstanceName);
  99         if (elanTag == 0L) {
 100             LOG.error("SubnetMapChangeListener:add: unable to fetch elantag from ElanInstance {} for subnet {}",
 101                       elanInstanceName, subnetId.getValue());
 102             return;
 103         }
 104         Uuid vpnId = subnetmap.getVpnId();
 105         if (vpnId != null) {
 106             boolean isBgpVpn = !vpnId.equals(subnetmap.getRouterId());
 107             LOG.info("SubnetMapChangeListener:add: subnetmap {} with elanTag {} to VPN {}", subnetmap, elanTag,
 108                      vpnId);
 109             vpnSubnetRouteHandler.onSubnetAddedToVpn(subnetmap, isBgpVpn, elanTag);
 110             if (isBgpVpn && subnetmap.getRouterId() == null) {
 111                 Set<VpnTarget> routeTargets = vpnManager.getRtListForVpn(vpnId.getValue());
 112                 if (!routeTargets.isEmpty()) {
 113                     synchronized (subnetmap.getSubnetIp().intern()) {
 114                         vpnManager.updateRouteTargetsToSubnetAssociation(routeTargets, subnetmap.getSubnetIp(),
 115                                 vpnId.getValue());
 116                     }
 117                 }
 118             }
 119         }
 120     }
 121
 122     @Override
 123     protected void remove(InstanceIdentifier<Subnetmap> identifier, Subnetmap subnetmap) {
 124         LOG.trace("SubnetmapListener:remove: subnetmap method - key: {}, value: {}", identifier, subnetmap);
 125     }
 126
 127     @Override
 128     // TODO Clean up the exception handling
 129     @SuppressWarnings("checkstyle:IllegalCatch")
 130     protected void update(InstanceIdentifier<Subnetmap> identifier, Subnetmap subnetmapOriginal, Subnetmap
 131             subnetmapUpdate) {
 132         LOG.debug("SubnetMapChangeListener update method - key {}, original {}, update {}", identifier,
 133                   subnetmapOriginal, subnetmapUpdate);
 134         Uuid subnetId = subnetmapUpdate.getId();
 135         Network network = vpnUtil.getNeutronNetwork(subnetmapUpdate.getNetworkId());
 136         if (network == null) {
 137             LOG.error("SubnetMapChangeListener:update: network was not found for subnetId {}", subnetId.getValue());
 138             return;
 139         }
 140         String elanInstanceName = subnetmapUpdate.getNetworkId().getValue();
 141         long elanTag = getElanTag(elanInstanceName);
 142         if (elanTag == 0L) {
 143             LOG.error("SubnetMapChangeListener:update: unable to fetch elantag from ElanInstance {} for subnetId {}",
 144                       elanInstanceName, subnetId);
 145             return;
 146         }
 147         updateVlanDataEntry(subnetmapOriginal.getVpnId(), subnetmapUpdate.getVpnId(), subnetmapUpdate,
 148                 subnetmapOriginal, elanInstanceName);
 149         if (VpnUtil.getIsExternal(network)) {
 150             LOG.debug("SubnetMapChangeListener:update: provider subnetwork {} is handling in "
 151                       + "ExternalSubnetVpnInstanceListener", subnetId.getValue());
 152             return;
 153         }
 154         // update on BGPVPN or InternalVPN change
 155         Uuid vpnIdOld = subnetmapOriginal.getVpnId();
 156         Uuid vpnIdNew = subnetmapUpdate.getVpnId();
 157         if (!Objects.equals(vpnIdOld, vpnIdNew)) {
 158             LOG.info("SubnetMapChangeListener:update: update subnetOpDataEntry for subnet {} imported in VPN",
 159                      subnetmapUpdate.getId().getValue());
 160             updateSubnetmapOpDataEntry(subnetmapOriginal.getVpnId(), subnetmapUpdate.getVpnId(), subnetmapUpdate,
 161                                        subnetmapOriginal, elanTag);
 162         }
 163         // update on Internet VPN Id change
 164         Uuid inetVpnIdOld = subnetmapOriginal.getInternetVpnId();
 165         Uuid inetVpnIdNew = subnetmapUpdate.getInternetVpnId();
 166         if (!Objects.equals(inetVpnIdOld, inetVpnIdNew)) {
 167             LOG.info("SubnetMapChangeListener:update: update subnetOpDataEntry for subnet {} imported in InternetVPN",
 168                      subnetmapUpdate.getId().getValue());
 169             updateSubnetmapOpDataEntry(inetVpnIdOld, inetVpnIdNew, subnetmapUpdate, subnetmapOriginal, elanTag);
 170         }
 171         // update on PortList change
 172         List<Uuid> oldPortList;
 173         List<Uuid> newPortList;
 174         newPortList = subnetmapUpdate.getPortList() != null ? subnetmapUpdate.getPortList() : new ArrayList<>();
 175         oldPortList = subnetmapOriginal.getPortList() != null ? subnetmapOriginal.getPortList() : new ArrayList<>();
 176         if (newPortList.size() == oldPortList.size()) {
 177             return;
 178         }
 179         LOG.info("SubnetMapChangeListener:update: update port list for subnet {}", subnetmapUpdate.getId().getValue());
 180         if (newPortList.size() > oldPortList.size()) {
 181             for (Uuid portId : newPortList) {
 182                 if (! oldPortList.contains(portId)) {
 183                     vpnSubnetRouteHandler.onPortAddedToSubnet(subnetmapUpdate, portId);
 184                     return;
 185                 }
 186             }
 187         } else {
 188             for (Uuid portId : oldPortList) {
 189                 if (! newPortList.contains(portId)) {
 190                     vpnSubnetRouteHandler.onPortRemovedFromSubnet(subnetmapUpdate, portId);
 191                     return;
 192                 }
 193             }
 194         }
 195     }
 196
 197     private void updateSubnetmapOpDataEntry(Uuid vpnIdOld, Uuid vpnIdNew, Subnetmap subnetmapUpdate,
 198                                     Subnetmap subnetmapOriginal, Long elanTag) {
 199
 200         // subnet added to VPN
 201         if (vpnIdNew != null && vpnIdOld == null) {
 202             if (vpnIdNew.equals(subnetmapUpdate.getRouterId())) {
 203                 return;
 204             }
 205             vpnSubnetRouteHandler.onSubnetAddedToVpn(subnetmapUpdate, true, elanTag);
 206         }
 207         // subnet removed from VPN
 208         if (vpnIdOld != null && vpnIdNew == null) {
 209             if (vpnIdOld.equals(subnetmapOriginal.getRouterId())) {
 210                 return;
 211             }
 212             vpnSubnetRouteHandler.onSubnetDeletedFromVpn(subnetmapOriginal, true);
 213         }
 214         // subnet updated in VPN
 215         if (vpnIdOld != null && vpnIdNew != null && (!vpnIdNew.equals(vpnIdOld))) {
 216             vpnSubnetRouteHandler.onSubnetUpdatedInVpn(subnetmapUpdate, elanTag);
 217         }
 218     }
 219
 220     private void updateVlanDataEntry(Uuid vpnIdOld, Uuid vpnIdNew, Subnetmap subnetmapUpdate,
 221             Subnetmap subnetmapOriginal, String elanInstanceName) {
 222         if (vpnIdNew != null && vpnIdOld == null) {
 223             if (elanInstanceName != null && NetworkType.VLAN.equals(subnetmapUpdate.getNetworkType())) {
 224                 vpnUtil.addRouterPortToElanDpnListForVlaninAllDpn(vpnIdNew.getValue());
 225             }
 226         }
 227         if (vpnIdOld != null && vpnIdNew == null) {
 228             if (NetworkType.VLAN.equals(subnetmapOriginal.getNetworkType())) {
 229                 vpnUtil.removeRouterPortFromElanDpnListForVlanInAllDpn(elanInstanceName, subnetmapOriginal
 230                         .getRouterInterfacePortId().getValue(), vpnIdOld.getValue());
 231             }
 232         }
 233     }
 234
 235     @Override
 236     protected SubnetmapChangeListener getDataTreeChangeListener() {
 237         return this;
 238     }
 239
 240     protected long getElanTag(String elanInstanceName) {
 241         InstanceIdentifier<ElanInstance> elanIdentifierId = InstanceIdentifier.builder(ElanInstances.class)
 242                 .child(ElanInstance.class, new ElanInstanceKey(elanInstanceName)).build();
 243         long elanTag = 0L;
 244         try {
 245             Optional<ElanInstance> elanInstance = SingleTransactionDataBroker.syncReadOptional(dataBroker,
 246                     LogicalDatastoreType.CONFIGURATION, elanIdentifierId);
 247             if (elanInstance.isPresent()) {
 248                 if (elanInstance.get().getElanTag() != null) {
 249                     elanTag = elanInstance.get().getElanTag();
 250                 } else {
 251                     LOG.error("Notification failed because of failure in fetching elanTag for ElanInstance {}",
 252                             elanInstanceName);
 253                 }
 254             } else {
 255                 LOG.error("Notification failed because of failure in reading ELANInstance {}", elanInstanceName);
 256             }
 257         } catch (ReadFailedException e) {
 258             LOG.error("Notification failed because of failure in fetching elanTag for ElanInstance {}",
 259                 elanInstanceName, e);
 260         }
 261         return elanTag;
 262     }
 263 }