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