vpnmanager/impl/src/main/java/org/opendaylight/netvirt/vpnmanager/VpnOpStatusListener.java

   1 /*
   2  * Copyright (c) 2015 - 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 package org.opendaylight.netvirt.vpnmanager;
   9
  10 import static java.util.Collections.emptyList;
  11
  12 import com.google.common.base.Optional;
  13 import com.google.common.util.concurrent.FutureCallback;
  14 import com.google.common.util.concurrent.Futures;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import com.google.common.util.concurrent.MoreExecutors;
  17 import java.util.ArrayList;
  18 import java.util.Collections;
  19 import java.util.List;
  20 import java.util.concurrent.locks.ReentrantLock;
  21 import javax.annotation.PostConstruct;
  22 import javax.inject.Inject;
  23 import javax.inject.Singleton;
  24 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  25 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  26 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  27 import org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase;
  28 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
  29 import org.opendaylight.genius.infra.Datastore;
  30 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
  31 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
  32 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  33 import org.opendaylight.genius.utils.JvmGlobalLocks;
  34 import org.opendaylight.genius.utils.SystemPropertyReader;
  35 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
  36 import org.opendaylight.netvirt.bgpmanager.api.IBgpManager;
  37 import org.opendaylight.netvirt.fibmanager.api.IFibManager;
  38 import org.opendaylight.netvirt.vpnmanager.api.VpnExtraRouteHelper;
  39 import org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.AddressFamily;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.L3nexthop;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthops;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthopsKey;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIds;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpntargets.VpnTarget;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.Vpn;
  49 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  50 import org.slf4j.Logger;
  51 import org.slf4j.LoggerFactory;
  52
  53 @Singleton
  54 public class VpnOpStatusListener extends AsyncDataTreeChangeListenerBase<VpnInstanceOpDataEntry, VpnOpStatusListener> {
  55     private static final Logger LOG = LoggerFactory.getLogger(VpnOpStatusListener.class);
  56     private final DataBroker dataBroker;
  57     private final ManagedNewTransactionRunner txRunner;
  58     private final IBgpManager bgpManager;
  59     private final IdManagerService idManager;
  60     private final IFibManager fibManager;
  61     private final IMdsalApiManager mdsalManager;
  62     private final VpnFootprintService vpnFootprintService;
  63     private final JobCoordinator jobCoordinator;
  64     private final VpnUtil vpnUtil;
  65
  66     @Inject
  67     public VpnOpStatusListener(final DataBroker dataBroker, final IBgpManager bgpManager,
  68                                final IdManagerService idManager, final IFibManager fibManager,
  69                                final IMdsalApiManager mdsalManager, final VpnFootprintService vpnFootprintService,
  70                                final JobCoordinator jobCoordinator, VpnUtil vpnUtil) {
  71         super(VpnInstanceOpDataEntry.class, VpnOpStatusListener.class);
  72         this.dataBroker = dataBroker;
  73         this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
  74         this.bgpManager = bgpManager;
  75         this.idManager = idManager;
  76         this.fibManager = fibManager;
  77         this.mdsalManager = mdsalManager;
  78         this.vpnFootprintService = vpnFootprintService;
  79         this.jobCoordinator = jobCoordinator;
  80         this.vpnUtil = vpnUtil;
  81     }
  82
  83     @PostConstruct
  84     public void start() {
  85         LOG.info("{} start", getClass().getSimpleName());
  86         registerListener(LogicalDatastoreType.OPERATIONAL, dataBroker);
  87     }
  88
  89     @Override
  90     protected InstanceIdentifier<VpnInstanceOpDataEntry> getWildCardPath() {
  91         return InstanceIdentifier.create(VpnInstanceOpData.class).child(VpnInstanceOpDataEntry.class);
  92     }
  93
  94     @Override
  95     protected VpnOpStatusListener getDataTreeChangeListener() {
  96         return VpnOpStatusListener.this;
  97     }
  98
  99     @Override
 100     protected void remove(InstanceIdentifier<VpnInstanceOpDataEntry> identifier, VpnInstanceOpDataEntry value) {
 101         LOG.info("remove: Ignoring vpn Op {} with rd {}", value.getVpnInstanceName(), value.getVrfId());
 102     }
 103
 104     @Override
 105     @SuppressWarnings("checkstyle:IllegalCatch")
 106     protected void update(InstanceIdentifier<VpnInstanceOpDataEntry> identifier,
 107                           VpnInstanceOpDataEntry original, VpnInstanceOpDataEntry update) {
 108         LOG.info("update: Processing update for vpn {} with rd {}", update.getVpnInstanceName(), update.getVrfId());
 109         if (update.getVpnState() == VpnInstanceOpDataEntry.VpnState.PendingDelete
 110                 && vpnFootprintService.isVpnFootPrintCleared(update)) {
 111             //Cleanup VPN data
 112             final String vpnName = update.getVpnInstanceName();
 113             final List<String> rds = update.getRd();
 114             String primaryRd = update.getVrfId();
 115             final long vpnId = vpnUtil.getVpnId(vpnName);
 116             jobCoordinator.enqueueJob("VPN-" + update.getVpnInstanceName(), () -> {
 117                 // Two transactions are used, one for operational, one for config; we only submit the config
 118                 // transaction if the operational transaction succeeds
 119                 ListenableFuture<Void> operationalFuture = txRunner.callWithNewWriteOnlyTransactionAndSubmit(
 120                                                                                 Datastore.OPERATIONAL, operTx -> {
 121                         // Clean up VPNExtraRoutes Operational DS
 122                         if (rds != null && VpnUtil.isBgpVpn(vpnName, primaryRd)) {
 123                             if (update.getType() == VpnInstanceOpDataEntry.Type.L2) {
 124                                 rds.parallelStream().forEach(rd -> bgpManager.deleteVrf(
 125                                         rd, false, AddressFamily.L2VPN));
 126                             }
 127                             if (update.isIpv4Configured()) {
 128                                 rds.parallelStream().forEach(rd -> bgpManager.deleteVrf(
 129                                         rd, false, AddressFamily.IPV4));
 130                             }
 131                             if (update.isIpv6Configured()) {
 132                                 rds.parallelStream().forEach(rd -> bgpManager.deleteVrf(
 133                                         rd, false, AddressFamily.IPV6));
 134                             }
 135                         }
 136                         InstanceIdentifier<Vpn> vpnToExtraroute =
 137                                 VpnExtraRouteHelper.getVpnToExtrarouteVpnIdentifier(vpnName);
 138                         Optional<Vpn> optVpnToExtraroute = Optional.absent();
 139                         try {
 140                             optVpnToExtraroute = SingleTransactionDataBroker.syncReadOptional(dataBroker,
 141                                     LogicalDatastoreType.OPERATIONAL, vpnToExtraroute);
 142                         } catch (ReadFailedException e) {
 143                             LOG.error("update: Failed to read VpnToExtraRoute for vpn {}", vpnName);
 144                         }
 145                         if (optVpnToExtraroute.isPresent()) {
 146                             VpnUtil.removeVpnExtraRouteForVpn(vpnName, operTx);
 147                         }
 148                         if (VpnUtil.isL3VpnOverVxLan(update.getL3vni())) {
 149                             vpnUtil.removeExternalTunnelDemuxFlows(vpnName);
 150                         }
 151                         // Clean up PrefixToInterface Operational DS
 152                         Optional<VpnIds> optPrefixToIntf = Optional.absent();
 153                         try {
 154                             optPrefixToIntf = SingleTransactionDataBroker.syncReadOptional(dataBroker,
 155                                     LogicalDatastoreType.OPERATIONAL, VpnUtil.getPrefixToInterfaceIdentifier(vpnId));
 156                         } catch (ReadFailedException e) {
 157                             LOG.error("update: Failed to read PrefixToInterface for vpn {}", vpnName);
 158                         }
 159                         if (optPrefixToIntf.isPresent()) {
 160                             VpnUtil.removePrefixToInterfaceForVpnId(vpnId, operTx);
 161                         }
 162                         // Clean up L3NextHop Operational DS
 163                         InstanceIdentifier<VpnNexthops> vpnNextHops = InstanceIdentifier.builder(L3nexthop.class).child(
 164                                 VpnNexthops.class, new VpnNexthopsKey(vpnId)).build();
 165                         Optional<VpnNexthops> optL3nexthopForVpnId = Optional.absent();
 166                         try {
 167                             optL3nexthopForVpnId = SingleTransactionDataBroker.syncReadOptional(dataBroker,
 168                                     LogicalDatastoreType.OPERATIONAL, vpnNextHops);
 169                         } catch (ReadFailedException e) {
 170                             LOG.error("update: Failed to read VpnNextHops for vpn {}", vpnName);
 171                         }
 172                         if (optL3nexthopForVpnId.isPresent()) {
 173                             VpnUtil.removeL3nexthopForVpnId(vpnId, operTx);
 174                         }
 175
 176                         // Clean up VPNInstanceOpDataEntry
 177                         VpnUtil.removeVpnOpInstance(primaryRd, operTx);
 178                     });
 179
 180                 Futures.addCallback(operationalFuture, new FutureCallback<Void>() {
 181                     @Override
 182                     public void onSuccess(Void result) {
 183                         Futures.addCallback(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
 184                                                             Datastore.CONFIGURATION, confTx -> {
 185                                 // Clean up VpnInstanceToVpnId from Config DS
 186                                 VpnUtil.removeVpnIdToVpnInstance(vpnId, confTx);
 187                                 VpnUtil.removeVpnInstanceToVpnId(vpnName, confTx);
 188                                 LOG.trace("Removed vpnIdentifier for  rd{} vpnname {}", primaryRd, vpnName);
 189
 190                                 // Clean up FIB Entries Config DS
 191                                 // FIXME: separate out to somehow?
 192                                 final ReentrantLock lock = JvmGlobalLocks.getLockForString(vpnName);
 193                                 lock.lock();
 194                                 try {
 195                                     fibManager.removeVrfTable(primaryRd, confTx);
 196                                 } finally {
 197                                     lock.unlock();
 198                                 }
 199                             }), new VpnOpStatusListener.PostDeleteVpnInstanceWorker(vpnName),
 200                                 MoreExecutors.directExecutor());
 201                             // Note: Release the of VpnId will happen in PostDeleteVpnInstancWorker only if
 202                             // operationalTxn/Config succeeds.
 203                     }
 204
 205                     @Override
 206                     public void onFailure(Throwable throwable) {
 207                         LOG.error("Error deleting VPN {}", vpnName, throwable);
 208                     }
 209                 }, MoreExecutors.directExecutor());
 210
 211                 LOG.info("Removed vpn data for vpnname {}", vpnName);
 212                 return Collections.singletonList(operationalFuture);
 213             }, SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
 214         } else if (update.getVpnState() == VpnInstanceOpDataEntry.VpnState.Created) {
 215             final String vpnName = update.getVpnInstanceName();
 216             String primaryRd = update.getVrfId();
 217             if (!VpnUtil.isBgpVpn(vpnName, primaryRd)) {
 218                 return;
 219             }
 220             if (original == null) {
 221                 LOG.error("VpnOpStatusListener.update: vpn {} with RD {}. add() handler already called",
 222                        vpnName, primaryRd);
 223                 return;
 224             }
 225             if (update.getVpnTargets() == null) {
 226                 LOG.error("VpnOpStatusListener.update: vpn {} with RD {} vpnTargets not ready",
 227                        vpnName, primaryRd);
 228                 return;
 229             }
 230             List<VpnTarget> vpnTargetList = update.getVpnTargets().getVpnTarget();
 231             List<String> ertList = new ArrayList<>();
 232             List<String> irtList = new ArrayList<>();
 233             if (vpnTargetList != null) {
 234                 for (VpnTarget vpnTarget : vpnTargetList) {
 235                     if (vpnTarget.getVrfRTType() == VpnTarget.VrfRTType.ExportExtcommunity) {
 236                         ertList.add(vpnTarget.getVrfRTValue());
 237                     }
 238                     if (vpnTarget.getVrfRTType() == VpnTarget.VrfRTType.ImportExtcommunity) {
 239                         irtList.add(vpnTarget.getVrfRTValue());
 240                     }
 241                     if (vpnTarget.getVrfRTType() == VpnTarget.VrfRTType.Both) {
 242                         ertList.add(vpnTarget.getVrfRTValue());
 243                         irtList.add(vpnTarget.getVrfRTValue());
 244                     }
 245                 }
 246             } else {
 247                 LOG.error("VpnOpStatusListener.update: vpn target list is empty, cannot add BGP"
 248                       + " VPN {} RD {}", vpnName, primaryRd);
 249                 return;
 250             }
 251             jobCoordinator.enqueueJob("VPN-" + update.getVpnInstanceName(), () -> {
 252                 //RD update case get only updated RD list
 253                 List<String> rds = update.getRd() != null ? new ArrayList<>(update.getRd()) : new ArrayList<>();
 254                 if (original.getRd() != null && original.getRd().size() != rds.size()) {
 255                     rds.removeAll(original.getRd());
 256                 }
 257                 rds.parallelStream().forEach(rd -> {
 258                     try {
 259                         List<String> importRTList = rd.equals(primaryRd) ? irtList : emptyList();
 260                         LOG.info("VpnOpStatusListener.update: updating BGPVPN for vpn {} with RD {}"
 261                                 + " Type is {}, IPv4 is {}, IPv6 is {}, iRT {}", vpnName, primaryRd, update.getType(),
 262                                 update.isIpv4Configured(), update.isIpv6Configured(), importRTList);
 263                         if (update.getType() == VpnInstanceOpDataEntry.Type.L2) {
 264                             bgpManager.addVrf(rd, importRTList, ertList, AddressFamily.L2VPN);
 265                         }
 266                         if (!original.isIpv4Configured() && update.isIpv4Configured()) {
 267                             bgpManager.addVrf(rd, importRTList, ertList, AddressFamily.IPV4);
 268                         } else if (original.isIpv4Configured() && !update.isIpv4Configured()) {
 269                             bgpManager.deleteVrf(rd, false, AddressFamily.IPV4);
 270                         }
 271                         if (!original.isIpv6Configured() && update.isIpv6Configured()) {
 272                             bgpManager.addVrf(rd, importRTList, ertList, AddressFamily.IPV6);
 273                         } else if (original.isIpv6Configured() && !update.isIpv6Configured()) {
 274                             bgpManager.deleteVrf(rd, false, AddressFamily.IPV6);
 275                         }
 276                         /* Update vrf entry with newly added RD list. VPN does not support for
 277                          * deleting existing RDs
 278                          */
 279                         if (original.getRd().size() != update.getRd().size()) {
 280                             if (update.isIpv4Configured()) {
 281                                 bgpManager.addVrf(rd, importRTList, ertList, AddressFamily.IPV4);
 282                             }
 283                             if (update.isIpv6Configured()) {
 284                                 bgpManager.addVrf(rd, importRTList, ertList, AddressFamily.IPV6);
 285                             }
 286                         }
 287                     } catch (RuntimeException e) {
 288                         LOG.error("VpnOpStatusListener.update: Exception when updating VRF to BGP for vpn {} rd {}",
 289                             vpnName, rd, e);
 290                     }
 291                 });
 292                 return emptyList();
 293             });
 294         }
 295     }
 296
 297     @Override
 298     protected void add(final InstanceIdentifier<VpnInstanceOpDataEntry> identifier,
 299                        final VpnInstanceOpDataEntry value) {
 300         LOG.debug("add: Ignoring vpn Op {} with rd {}", value.getVpnInstanceName(), value.getVrfId());
 301     }
 302
 303     private class PostDeleteVpnInstanceWorker implements FutureCallback<Void> {
 304         private final Logger log = LoggerFactory.getLogger(VpnOpStatusListener.PostDeleteVpnInstanceWorker.class);
 305         String vpnName;
 306
 307         PostDeleteVpnInstanceWorker(String vpnName)  {
 308             this.vpnName = vpnName;
 309         }
 310
 311         /**
 312          * This implies that all the future instances have returned success.
 313          * Release the ID used for VPN back to IdManager
 314          */
 315         @Override
 316         public void onSuccess(Void ignored) {
 317             vpnUtil.releaseId(VpnConstants.VPN_IDPOOL_NAME, vpnName);
 318             log.info("onSuccess: VpnId for VpnName {} is released to IdManager successfully.", vpnName);
 319         }
 320
 321         /**
 322          * This method is used to handle failure callbacks.
 323          */
 324         @Override
 325         public void onFailure(Throwable throwable) {
 326             log.error("onFailure: Job for vpnInstance: {} failed with exception:",
 327                       vpnName , throwable);
 328         }
 329     }
 330 }