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