itm/itm-impl/src/main/java/org/opendaylight/genius/itm/listeners/TransportZoneListener.java

   1 /*
   2  * Copyright (c) 2016 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.genius.itm.listeners;
  10
  11 import com.google.common.base.Optional;
  12 import com.google.common.util.concurrent.CheckedFuture;
  13 import java.math.BigInteger;
  14 import java.util.ArrayList;
  15 import java.util.Collections;
  16 import java.util.List;
  17 import java.util.Map;
  18 import java.util.Set;
  19 import java.util.concurrent.ConcurrentHashMap;
  20 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  21 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  22 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  23 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  24 import org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase;
  25 import org.opendaylight.genius.datastoreutils.DataStoreJobCoordinator;
  26 import org.opendaylight.genius.itm.confighelpers.HwVtep;
  27 import org.opendaylight.genius.itm.confighelpers.ItmTepAddWorker;
  28 import org.opendaylight.genius.itm.confighelpers.ItmTepRemoveWorker;
  29 import org.opendaylight.genius.itm.impl.ITMManager;
  30 import org.opendaylight.genius.itm.impl.ItmUtils;
  31 import org.opendaylight.genius.itm.validator.TransportZoneNameAllowed;
  32 import org.opendaylight.genius.itm.validator.TransportZoneValidator;
  33 import org.opendaylight.genius.itm.validator.ValidatorErrorCode;
  34 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeBase;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.DPNTEPsInfo;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.TunnelEndPoints;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.TransportZones;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.TransportZonesBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZone;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.Subnets;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.subnets.DeviceVteps;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.subnets.Vteps;
  47 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50
  51 /**
  52  * This class listens for interface creation/removal/update in Configuration DS.
  53  * This is used to handle interfaces for base of-ports.
  54  */
  55 public class TransportZoneListener extends AsyncDataTreeChangeListenerBase<TransportZone, TransportZoneListener>
  56         implements AutoCloseable {
  57     private static final Logger LOG = LoggerFactory.getLogger(TransportZoneListener.class);
  58     private final DataBroker dataBroker;
  59     private final IdManagerService idManagerService;
  60     private IMdsalApiManager mdsalManager;
  61     private ITMManager itmManager;
  62
  63     public TransportZoneListener(final DataBroker dataBroker, final IdManagerService idManagerService) {
  64         super(TransportZone.class, TransportZoneListener.class);
  65         this.dataBroker = dataBroker;
  66         this.idManagerService = idManagerService;
  67         initializeTZNode(dataBroker);
  68     }
  69
  70     public void setItmManager(ITMManager itmManager) {
  71         this.itmManager = itmManager;
  72     }
  73
  74     public void setMdsalManager(IMdsalApiManager mdsalManager) {
  75         this.mdsalManager = mdsalManager;
  76     }
  77
  78     private void initializeTZNode(DataBroker db) {
  79         ReadWriteTransaction transaction = db.newReadWriteTransaction();
  80         InstanceIdentifier<TransportZones> path = InstanceIdentifier.create(TransportZones.class);
  81         CheckedFuture<Optional<TransportZones>, ReadFailedException> tzones = transaction
  82                 .read(LogicalDatastoreType.CONFIGURATION, path);
  83         try {
  84             if (!tzones.get().isPresent()) {
  85                 TransportZonesBuilder tzb = new TransportZonesBuilder();
  86                 transaction.put(LogicalDatastoreType.CONFIGURATION, path, tzb.build());
  87                 transaction.submit();
  88             } else {
  89                 transaction.cancel();
  90             }
  91         } catch (Exception e) {
  92             LOG.error("Error initializing TransportZones {}", e);
  93         }
  94     }
  95
  96     @Override
  97     public void close() throws Exception {
  98         LOG.info("tzChangeListener Closed");
  99     }
 100
 101     @Override
 102     protected InstanceIdentifier<TransportZone> getWildCardPath() {
 103         return InstanceIdentifier.create(TransportZones.class).child(TransportZone.class);
 104     }
 105
 106     @Override
 107     protected TransportZoneListener getDataTreeChangeListener() {
 108         return TransportZoneListener.this;
 109     }
 110
 111     @Override
 112     protected void remove(InstanceIdentifier<TransportZone> key, TransportZone tzOld) {
 113         LOG.debug("Received Transport Zone Remove Event: {}, {}", key, tzOld);
 114         if(validateTransportZoneParam(tzOld)){
 115             //TODO : DPList code can be refactor with new specific class
 116             // which implement TransportZoneValidator
 117             List<DPNTEPsInfo> opDpnList = createDPNTepInfo(tzOld);
 118             List<HwVtep> hwVtepList = createhWVteps(tzOld);
 119             LOG.trace("Delete: Invoking deleteTunnels in ItmManager with DpnList {}", opDpnList);
 120             if(!opDpnList.isEmpty() || !hwVtepList.isEmpty()) {
 121                 LOG.trace("Delete: Invoking ItmManager with hwVtep List {} " , hwVtepList);
 122                 DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
 123                 ItmTepRemoveWorker removeWorker =
 124                         new ItmTepRemoveWorker(opDpnList, hwVtepList, tzOld, dataBroker, idManagerService, mdsalManager);
 125                 coordinator.enqueueJob(tzOld.getZoneName(), removeWorker);
 126             }
 127         }
 128     }
 129
 130     @Override
 131     protected void update(InstanceIdentifier<TransportZone> key, TransportZone tzOld, TransportZone tzNew) {
 132         LOG.debug("Received Transport Zone Update Event: Key - {}, Old - {}, Updated - {}", key, tzOld, tzNew);
 133         List<DPNTEPsInfo> oldDpnTepsList = createDPNTepInfo(tzOld);
 134         List<DPNTEPsInfo> newDpnTepsList = createDPNTepInfo(tzNew);
 135         List<DPNTEPsInfo> oldDpnTepsListcopy = new ArrayList<>();
 136         oldDpnTepsListcopy.addAll(oldDpnTepsList);
 137         LOG.trace("oldcopy0" + oldDpnTepsListcopy);
 138         List<DPNTEPsInfo> newDpnTepsListcopy = new ArrayList<>();
 139         newDpnTepsListcopy.addAll(newDpnTepsList);
 140         LOG.trace("newcopy0" + newDpnTepsListcopy);
 141         DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
 142
 143         oldDpnTepsList.removeAll(newDpnTepsListcopy);
 144         newDpnTepsList.removeAll(oldDpnTepsListcopy);
 145
 146         LOG.trace("oldDpnTepsList" + oldDpnTepsList);
 147         LOG.trace("newDpnTepsList" + newDpnTepsList);
 148         LOG.trace("oldcopy" + oldDpnTepsListcopy);
 149         LOG.trace("newcopy" + newDpnTepsListcopy);
 150         LOG.trace("oldcopy Size " + oldDpnTepsList.size());
 151         LOG.trace("newcopy Size " + newDpnTepsList.size());
 152         if (!newDpnTepsList.isEmpty()) {
 153             LOG.trace("Adding TEPs ");
 154             ItmTepAddWorker addWorker = new ItmTepAddWorker(newDpnTepsList, Collections.<HwVtep>emptyList(), dataBroker,
 155                     idManagerService, mdsalManager);
 156             coordinator.enqueueJob(tzNew.getZoneName(), addWorker);
 157         }
 158         if (!oldDpnTepsList.isEmpty()) {
 159             LOG.trace("Removing TEPs ");
 160             ItmTepRemoveWorker removeWorker = new ItmTepRemoveWorker(oldDpnTepsList, Collections.<HwVtep>emptyList(),
 161                     tzOld, dataBroker, idManagerService, mdsalManager);
 162             coordinator.enqueueJob(tzNew.getZoneName(), removeWorker);
 163         }
 164         List<HwVtep> oldHwList = createhWVteps(tzOld);
 165         List<HwVtep> newHwList = createhWVteps(tzNew);
 166         List<HwVtep> oldHwListcopy = new ArrayList<>();
 167         oldHwListcopy.addAll(oldHwList);
 168         LOG.trace("oldHwListcopy0" + oldHwListcopy);
 169         List<HwVtep> newHwListcopy = new ArrayList<>();
 170         newHwListcopy.addAll(newHwList);
 171         LOG.trace("newHwListcopy0" + newHwListcopy);
 172
 173         oldHwList.removeAll(newHwListcopy);
 174         newHwList.removeAll(oldHwListcopy);
 175         LOG.trace("oldHwList" + oldHwList);
 176         LOG.trace("newHwList" + newHwList);
 177         LOG.trace("oldHwListcopy" + oldHwListcopy);
 178         LOG.trace("newHwListcopy" + newHwListcopy);
 179         if (!newHwList.isEmpty()) {
 180             LOG.trace("Adding HW TEPs ");
 181             ItmTepAddWorker addWorker = new ItmTepAddWorker(Collections.<DPNTEPsInfo>emptyList(), newHwList, dataBroker,
 182                     idManagerService, mdsalManager);
 183             coordinator.enqueueJob(tzNew.getZoneName(), addWorker);
 184         }
 185         if (!oldHwList.isEmpty()) {
 186             LOG.trace("Removing HW TEPs ");
 187             ItmTepRemoveWorker removeWorker = new ItmTepRemoveWorker(Collections.<DPNTEPsInfo>emptyList(), oldHwList,
 188                     tzOld, dataBroker, idManagerService, mdsalManager);
 189             coordinator.enqueueJob(tzNew.getZoneName(), removeWorker);
 190         }
 191     }
 192
 193     @Override
 194     protected void add(InstanceIdentifier<TransportZone> key, TransportZone tzNew) {
 195         LOG.debug("Received Transport Zone Add Event: {}, {}", key, tzNew);
 196         List<DPNTEPsInfo> opDpnList = createDPNTepInfo(tzNew);
 197         List<HwVtep> hwVtepList = createhWVteps(tzNew);
 198         LOG.trace("Add: Operational dpnTepInfo - Before invoking ItmManager {}", opDpnList);
 199         if (!opDpnList.isEmpty() || !hwVtepList.isEmpty()) {
 200             LOG.trace("Add: Invoking ItmManager with DPN List {} ", opDpnList);
 201             LOG.trace("Add: Invoking ItmManager with hwVtep List {} ", hwVtepList);
 202             DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
 203             ItmTepAddWorker addWorker = new ItmTepAddWorker(opDpnList, hwVtepList, dataBroker, idManagerService,
 204                     mdsalManager);
 205             coordinator.enqueueJob(tzNew.getZoneName(), addWorker);
 206         }
 207     }
 208
 209     private List<DPNTEPsInfo> createDPNTepInfo(TransportZone transportZone) {
 210         Map<BigInteger, List<TunnelEndPoints>> mapDPNToTunnelEndpt = new ConcurrentHashMap<>();
 211         List<DPNTEPsInfo> dpnTepInfo = new ArrayList<>();
 212         String zoneName = transportZone.getZoneName();
 213         Class<? extends TunnelTypeBase> tunnelType = transportZone.getTunnelType();
 214         LOG.trace("Transport Zone_name: {}", zoneName);
 215         List<Subnets> subnetsList = transportZone.getSubnets();
 216         if (subnetsList != null) {
 217             for (Subnets subnet : subnetsList) {
 218                 IpPrefix ipPrefix = subnet.getPrefix();
 219                 IpAddress gatewayIP = subnet.getGatewayIp();
 220                 int vlanID = subnet.getVlanId();
 221                 LOG.trace("IpPrefix: {}, gatewayIP: {}, vlanID: {} ", ipPrefix, gatewayIP, vlanID);
 222                 List<Vteps> vtepsList = subnet.getVteps();
 223                 if (vtepsList != null && !vtepsList.isEmpty()) {
 224                     for (Vteps vteps : vtepsList) {
 225                         BigInteger dpnID = vteps.getDpnId();
 226                         String port = vteps.getPortname();
 227                         IpAddress ipAddress = vteps.getIpAddress();
 228                         LOG.trace("DpnID: {}, port: {}, ipAddress: {}", dpnID, port, ipAddress);
 229                         TunnelEndPoints tunnelEndPoints = ItmUtils.createTunnelEndPoints(dpnID, ipAddress, port, vlanID,
 230                                 ipPrefix, gatewayIP, zoneName, tunnelType);
 231                         List<TunnelEndPoints> tunnelEndPointsList = mapDPNToTunnelEndpt.get(dpnID);
 232                         if (tunnelEndPointsList != null) {
 233                             LOG.trace("Existing DPN info list in the Map: {} ", dpnID);
 234                             tunnelEndPointsList.add(tunnelEndPoints);
 235                         } else {
 236                             LOG.trace("Adding new DPN info list to the Map: {} ", dpnID);
 237                             tunnelEndPointsList = new ArrayList<>();
 238                             tunnelEndPointsList.add(tunnelEndPoints);
 239                             mapDPNToTunnelEndpt.put(dpnID, tunnelEndPointsList);
 240                         }
 241                     }
 242                 }
 243             }
 244         }
 245
 246         if (!mapDPNToTunnelEndpt.isEmpty()) {
 247             Set<BigInteger> keys = mapDPNToTunnelEndpt.keySet();
 248             LOG.trace("List of dpns in the Map: {} ", keys);
 249             for (BigInteger key : keys) {
 250                 DPNTEPsInfo newDpnTepsInfo = ItmUtils.createDPNTepInfo(key, mapDPNToTunnelEndpt.get(key));
 251                 dpnTepInfo.add(newDpnTepsInfo);
 252             }
 253         }
 254         return dpnTepInfo;
 255     }
 256
 257     private List<HwVtep> createhWVteps(TransportZone transportZone) {
 258         List<HwVtep> hwVtepsList = new ArrayList<>();
 259
 260         String zoneName = transportZone.getZoneName();
 261         Class<? extends TunnelTypeBase> tunnelType = transportZone.getTunnelType();
 262         LOG.trace("Transport Zone_name: {}", zoneName);
 263         List<Subnets> subnetsList = transportZone.getSubnets();
 264         if (subnetsList != null) {
 265             for (Subnets subnet : subnetsList) {
 266                 IpPrefix ipPrefix = subnet.getPrefix();
 267                 IpAddress gatewayIP = subnet.getGatewayIp();
 268                 int vlanID = subnet.getVlanId();
 269                 LOG.trace("IpPrefix: {}, gatewayIP: {}, vlanID: {} ", ipPrefix, gatewayIP, vlanID);
 270                 List<DeviceVteps> deviceVtepsList = subnet.getDeviceVteps();
 271                 if (deviceVtepsList != null) {
 272                     for (DeviceVteps vteps : deviceVtepsList) {
 273                         String topologyId = vteps.getTopologyId();
 274                         String nodeId = vteps.getNodeId();
 275                         IpAddress ipAddress = vteps.getIpAddress();
 276                         LOG.trace("topo-id: {}, node-id: {}, ipAddress: {}", topologyId, nodeId, ipAddress);
 277                         HwVtep hwVtep = ItmUtils.createHwVtepObject(topologyId, nodeId, ipAddress, ipPrefix, gatewayIP,
 278                                 vlanID, tunnelType, transportZone);
 279
 280                         if (hwVtepsList != null) {
 281                             LOG.trace("Existing hwVteps");
 282                             hwVtepsList.add(hwVtep);
 283                         } else {
 284                             LOG.trace("Adding new HwVtep {} info ", hwVtep.getHwIp());
 285                             hwVtepsList.add(hwVtep);
 286                         }
 287                     }
 288                 }
 289             }
 290         }
 291         LOG.trace("returning hwvteplist {}", hwVtepsList);
 292         return hwVtepsList;
 293     }
 294
 295     private boolean validateTransportZoneParam(TransportZone transportZone) {
 296         boolean validateParam = true;
 297         ArrayList<TransportZoneValidator> tzValidatorList = new ArrayList<>();
 298         tzValidatorList.add(new TransportZoneNameAllowed());
 299         for(TransportZoneValidator tzValidator :tzValidatorList){
 300             if(tzValidator.validate(transportZone) == ValidatorErrorCode.ERROR){
 301                 validateParam = false;
 302                 break;
 303             }
 304         }
 305         return validateParam;
 306     }
 307 }