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