vpnmanager/impl/src/main/java/org/opendaylight/netvirt/vpnmanager/VpnInstanceListener.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 org.opendaylight.controller.md.sal.binding.api.WriteTransaction.CREATE_MISSING_PARENTS;
  11 import static org.opendaylight.genius.infra.Datastore.CONFIGURATION;
  12 import static org.opendaylight.genius.infra.Datastore.OPERATIONAL;
  13
  14 import com.google.common.base.Optional;
  15 import com.google.common.util.concurrent.FutureCallback;
  16 import com.google.common.util.concurrent.Futures;
  17 import com.google.common.util.concurrent.ListenableFuture;
  18 import com.google.common.util.concurrent.MoreExecutors;
  19 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  20 import java.util.ArrayList;
  21 import java.util.Arrays;
  22 import java.util.Collections;
  23 import java.util.List;
  24 import java.util.concurrent.Callable;
  25 import java.util.concurrent.locks.ReentrantLock;
  26 import javax.annotation.PostConstruct;
  27 import javax.inject.Inject;
  28 import javax.inject.Singleton;
  29 import org.eclipse.jdt.annotation.Nullable;
  30 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  31 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  32 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  33 import org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase;
  34 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
  35 import org.opendaylight.genius.infra.Datastore.Configuration;
  36 import org.opendaylight.genius.infra.Datastore.Operational;
  37 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
  38 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
  39 import org.opendaylight.genius.infra.TypedWriteTransaction;
  40 import org.opendaylight.genius.mdsalutil.FlowEntity;
  41 import org.opendaylight.genius.mdsalutil.InstructionInfo;
  42 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  43 import org.opendaylight.genius.mdsalutil.MatchInfo;
  44 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
  45 import org.opendaylight.genius.mdsalutil.NWUtil;
  46 import org.opendaylight.genius.mdsalutil.NwConstants;
  47 import org.opendaylight.genius.mdsalutil.instructions.InstructionGotoTable;
  48 import org.opendaylight.genius.mdsalutil.instructions.InstructionWriteMetadata;
  49 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  50 import org.opendaylight.genius.mdsalutil.matches.MatchTunnelId;
  51 import org.opendaylight.genius.utils.JvmGlobalLocks;
  52 import org.opendaylight.genius.utils.SystemPropertyReader;
  53 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
  54 import org.opendaylight.infrautils.utils.concurrent.ListenableFutures;
  55 import org.opendaylight.netvirt.fibmanager.api.IFibManager;
  56 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnAfConfig;
  57 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
  58 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.VpnTargets;
  59 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.vpntargets.VpnTarget;
  60 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.ExternalTunnelList;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnel;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.DcGatewayIpList;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.dc.gateway.ip.list.DcGatewayIp;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnTargetsBuilder;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpntargets.VpnTargetBuilder;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpntargets.VpnTargetKey;
  72 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  73 import org.opendaylight.yangtools.yang.common.Uint32;
  74 import org.opendaylight.yangtools.yang.common.Uint64;
  75 import org.slf4j.Logger;
  76 import org.slf4j.LoggerFactory;
  77
  78 @Singleton
  79 public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInstance, VpnInstanceListener> {
  80     private static final Logger LOG = LoggerFactory.getLogger(VpnInstanceListener.class);
  81     private static final String LOGGING_PREFIX_ADD = "VPN-ADD:";
  82     private static final String LOGGING_PREFIX_UPDATE = "VPN-UPDATE:";
  83     private static final String LOGGING_PREFIX_DELETE = "VPN-REMOVE:";
  84     private final DataBroker dataBroker;
  85     private final ManagedNewTransactionRunner txRunner;
  86     private final IdManagerService idManager;
  87     private final VpnInterfaceManager vpnInterfaceManager;
  88     private final IFibManager fibManager;
  89     private final VpnOpDataSyncer vpnOpDataNotifier;
  90     private final IMdsalApiManager mdsalManager;
  91     private final JobCoordinator jobCoordinator;
  92     private final VpnUtil vpnUtil;
  93
  94     @Inject
  95     public VpnInstanceListener(final DataBroker dataBroker, final IdManagerService idManager,
  96             final VpnInterfaceManager vpnInterfaceManager, final IFibManager fibManager,
  97             final VpnOpDataSyncer vpnOpDataSyncer, final IMdsalApiManager mdsalManager,
  98             final JobCoordinator jobCoordinator, VpnUtil vpnUtil) {
  99         super(VpnInstance.class, VpnInstanceListener.class);
 100         this.dataBroker = dataBroker;
 101         this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
 102         this.idManager = idManager;
 103         this.vpnInterfaceManager = vpnInterfaceManager;
 104         this.fibManager = fibManager;
 105         this.vpnOpDataNotifier = vpnOpDataSyncer;
 106         this.mdsalManager = mdsalManager;
 107         this.jobCoordinator = jobCoordinator;
 108         this.vpnUtil = vpnUtil;
 109     }
 110
 111     @PostConstruct
 112     public void start() {
 113         LOG.info("{} start", getClass().getSimpleName());
 114         registerListener(LogicalDatastoreType.CONFIGURATION, dataBroker);
 115     }
 116
 117     @Override
 118     protected InstanceIdentifier<VpnInstance> getWildCardPath() {
 119         return InstanceIdentifier.create(VpnInstances.class).child(VpnInstance.class);
 120     }
 121
 122     @Override
 123     protected VpnInstanceListener getDataTreeChangeListener() {
 124         return VpnInstanceListener.this;
 125     }
 126
 127     @Override
 128     protected void remove(InstanceIdentifier<VpnInstance> identifier, VpnInstance del) {
 129         LOG.trace("{} : VPN event key: {}, value: {}", LOGGING_PREFIX_DELETE, identifier, del);
 130         final String vpnName = del.getVpnInstanceName();
 131         Optional<VpnInstanceOpDataEntry> vpnOpValue;
 132         String primaryRd = vpnUtil.getVpnRd(vpnName);
 133         if (primaryRd == null) {
 134             LOG.error("{}, failed to remove VPN: primaryRd is null for vpn {}", LOGGING_PREFIX_DELETE, vpnName);
 135             return;
 136         }
 137
 138         //TODO(vpnteam): Entire code would need refactoring to listen only on the parent object - VPNInstance
 139         try {
 140             vpnOpValue = SingleTransactionDataBroker.syncReadOptional(dataBroker, LogicalDatastoreType.OPERATIONAL,
 141                     VpnUtil.getVpnInstanceOpDataIdentifier(primaryRd));
 142         } catch (ReadFailedException e) {
 143             LOG.error("{}, failed to remove VPN: Exception while retrieving VpnInstanceOpDataEntry for VPN {}. ",
 144                     LOGGING_PREFIX_DELETE,  vpnName, e);
 145             return;
 146         }
 147
 148         if (!vpnOpValue.isPresent()) {
 149             LOG.error("{}, failed to remove VPN: Unable to retrieve VpnInstanceOpDataEntry for VPN {}. ",
 150                 LOGGING_PREFIX_DELETE, vpnName);
 151             return;
 152         } else {
 153             jobCoordinator.enqueueJob("VPN-" + vpnName, () ->
 154                 Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx -> {
 155                     VpnInstanceOpDataEntryBuilder builder = null;
 156                     InstanceIdentifier<VpnInstanceOpDataEntry> id = null;
 157                     if (primaryRd != null) {
 158                         builder = new VpnInstanceOpDataEntryBuilder().setVrfId(primaryRd)
 159                                 .setVpnState(VpnInstanceOpDataEntry.VpnState.PendingDelete);
 160                         id = VpnUtil.getVpnInstanceOpDataIdentifier(primaryRd);
 161                     } else {
 162                         builder = new VpnInstanceOpDataEntryBuilder().setVrfId(vpnName)
 163                                 .setVpnState(VpnInstanceOpDataEntry.VpnState.PendingDelete);
 164                         id = VpnUtil.getVpnInstanceOpDataIdentifier(vpnName);
 165                     }
 166                     tx.merge(id, builder.build());
 167
 168                     LOG.info("{} call: Operational status set to PENDING_DELETE for vpn {} with rd {}",
 169                             LOGGING_PREFIX_DELETE, vpnName, primaryRd);
 170                 })), SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
 171         }
 172     }
 173
 174     @Override
 175     protected void update(InstanceIdentifier<VpnInstance> identifier,
 176         VpnInstance original, VpnInstance update) {
 177         LOG.trace("VPN-UPDATE: update: VPN event key: {}, value: {}.", identifier, update);
 178         String vpnName = update.getVpnInstanceName();
 179         if (original.getIpv4Family() != null && update.getIpv4Family() != null
 180                 && original.getIpv4Family().getRouteDistinguisher() != null
 181                 && update.getIpv4Family().getRouteDistinguisher() != null
 182                 && original.getIpv4Family().getRouteDistinguisher().size()
 183                 !=  update.getIpv4Family().getRouteDistinguisher().size()) {
 184             LOG.debug("VPN-UPDATE: VpnInstance:{} updated with new RDs: {} from old RDs: {}", vpnName,
 185                     update.getIpv4Family().getRouteDistinguisher(),  original.getIpv4Family().getRouteDistinguisher());
 186             vpnUtil.updateVpnInstanceWithRdList(vpnName, update.getIpv4Family().getRouteDistinguisher());
 187         }
 188         vpnInterfaceManager.updateVpnInterfacesForUnProcessAdjancencies(vpnName);
 189     }
 190
 191     @Override
 192     protected void add(final InstanceIdentifier<VpnInstance> identifier, final VpnInstance value) {
 193         LOG.trace("{} add: Add VPN event key: {}, value: {}", LOGGING_PREFIX_ADD, identifier, value);
 194         final String vpnName = value.getVpnInstanceName();
 195         jobCoordinator.enqueueJob("VPN-" + vpnName, new AddVpnInstanceWorker(dataBroker, value),
 196                 SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
 197     }
 198
 199     private class AddVpnInstanceWorker implements Callable<List<ListenableFuture<Void>>> {
 200         private final Logger log = LoggerFactory.getLogger(AddVpnInstanceWorker.class);
 201         VpnInstance vpnInstance;
 202         DataBroker broker;
 203
 204         AddVpnInstanceWorker(DataBroker broker,
 205                 VpnInstance value) {
 206             this.broker = broker;
 207             this.vpnInstance = value;
 208         }
 209
 210         @Override
 211         public List<ListenableFuture<Void>> call() {
 212             // If another renderer(for eg : CSS) needs to be supported, check can be performed here
 213             // to call the respective helpers.
 214             List<ListenableFuture<Void>> futures = new ArrayList<>(2);
 215             futures.add(txRunner.callWithNewWriteOnlyTransactionAndSubmit(CONFIGURATION, confTx -> {
 216                 ListenableFuture<Void> future = txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, operTx ->
 217                         addVpnInstance(vpnInstance, confTx, operTx));
 218                 ListenableFutures.addErrorLogging(future, LOG, "{} call: error creating VPN {} rd {}",
 219                         LOGGING_PREFIX_ADD, vpnInstance.getVpnInstanceName(),
 220                         vpnInstance.getIpv4Family().getRouteDistinguisher());
 221                 futures.add(future);
 222             }));
 223             Futures.addCallback(Futures.allAsList(futures),
 224                                 new PostAddVpnInstanceWorker(vpnInstance , vpnInstance.getVpnInstanceName()),
 225                                 MoreExecutors.directExecutor());
 226             return futures;
 227         }
 228     }
 229
 230     // TODO Clean up the exception handling
 231     @SuppressWarnings("checkstyle:IllegalCatch")
 232     private void addVpnInstance(VpnInstance value, TypedWriteTransaction<Configuration> writeConfigTxn,
 233             TypedWriteTransaction<Operational> writeOperTxn) {
 234         if (writeConfigTxn == null) {
 235             ListenableFutures.addErrorLogging(txRunner.callWithNewWriteOnlyTransactionAndSubmit(CONFIGURATION, tx ->
 236                 addVpnInstance(value, tx, writeOperTxn)), LOG, "Error adding VPN instance {}", value);
 237             return;
 238         }
 239         if (writeOperTxn == null) {
 240             ListenableFutures.addErrorLogging(txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx ->
 241                 addVpnInstance(value, writeConfigTxn, tx)), LOG, "Error adding VPN instance {}", value);
 242             return;
 243         }
 244         VpnAfConfig config = value.getIpv4Family();
 245         String vpnInstanceName = value.getVpnInstanceName();
 246
 247         Uint32 vpnId = vpnUtil.getUniqueId(VpnConstants.VPN_IDPOOL_NAME, vpnInstanceName);
 248         if (vpnId.longValue() == 0) {
 249             LOG.error("{} addVpnInstance: Unable to fetch label from Id Manager. Bailing out of adding operational"
 250                     + " data for Vpn Instance {}", LOGGING_PREFIX_ADD, value.getVpnInstanceName());
 251             return;
 252         }
 253         LOG.info("{} addVpnInstance: VPN Id {} generated for VpnInstanceName {}", LOGGING_PREFIX_ADD, vpnId,
 254                 vpnInstanceName);
 255         String primaryRd = VpnUtil.getPrimaryRd(value);
 256         org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance
 257             vpnInstanceToVpnId = VpnUtil.getVpnInstanceToVpnId(vpnInstanceName, vpnId, primaryRd);
 258
 259         writeConfigTxn.put(VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnInstanceName),
 260             vpnInstanceToVpnId, CREATE_MISSING_PARENTS);
 261
 262         VpnIds vpnIdToVpnInstance = VpnUtil.getVpnIdToVpnInstance(vpnId, value.getVpnInstanceName(),
 263             primaryRd, VpnUtil.isBgpVpn(vpnInstanceName, primaryRd));
 264
 265         writeConfigTxn.put(VpnUtil.getVpnIdToVpnInstanceIdentifier(vpnId), vpnIdToVpnInstance, CREATE_MISSING_PARENTS);
 266
 267         try {
 268             String cachedTransType = fibManager.getConfTransType();
 269             if (cachedTransType.equals("Invalid")) {
 270                 try {
 271                     fibManager.setConfTransType("L3VPN", "VXLAN");
 272                 } catch (Exception e) {
 273                     LOG.error("{} addVpnInstance: Exception caught setting the L3VPN tunnel transportType for vpn {}",
 274                             LOGGING_PREFIX_ADD, vpnInstanceName, e);
 275                 }
 276             } else {
 277                 LOG.debug("{} addVpnInstance: Configured tunnel transport type for L3VPN {} as {}", LOGGING_PREFIX_ADD,
 278                         vpnInstanceName, cachedTransType);
 279             }
 280         } catch (Exception e) {
 281             LOG.error("{} addVpnInstance: Error when trying to retrieve tunnel transport type for L3VPN {}",
 282                     LOGGING_PREFIX_ADD, vpnInstanceName, e);
 283         }
 284
 285         VpnInstanceOpDataEntryBuilder builder =
 286                 new VpnInstanceOpDataEntryBuilder().setVrfId(primaryRd).setVpnId(vpnId)
 287                         .setVpnInstanceName(vpnInstanceName)
 288                         .setVpnState(VpnInstanceOpDataEntry.VpnState.Created);
 289         if (VpnUtil.isBgpVpn(vpnInstanceName, primaryRd)) {
 290             List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn
 291                 .instance.op.data.entry.vpntargets.VpnTarget> opVpnTargetList = new ArrayList<>();
 292             builder.setBgpvpnType(VpnInstanceOpDataEntry.BgpvpnType.BGPVPNExternal);
 293             if (value.getL3vni() != null) {
 294                 builder.setL3vni(value.getL3vni());
 295             }
 296             if (value.getType() == VpnInstance.Type.L2) {
 297                 builder.setType(VpnInstanceOpDataEntry.Type.L2);
 298             }
 299             VpnTargets vpnTargets = config.getVpnTargets();
 300             if (vpnTargets != null) {
 301                 List<VpnTarget> vpnTargetList = vpnTargets.getVpnTarget();
 302                 if (vpnTargetList != null) {
 303                     for (VpnTarget vpnTarget : vpnTargetList) {
 304                         VpnTargetBuilder vpnTargetBuilder =
 305                             new VpnTargetBuilder().withKey(new VpnTargetKey(vpnTarget.key().getVrfRTValue()))
 306                                 .setVrfRTType(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
 307                                     .instance.op.data.vpn.instance.op.data.entry.vpntargets.VpnTarget.VrfRTType
 308                                     .forValue(vpnTarget.getVrfRTType().getIntValue())).setVrfRTValue(
 309                                 vpnTarget.getVrfRTValue());
 310                         opVpnTargetList.add(vpnTargetBuilder.build());
 311                     }
 312                 }
 313             }
 314             VpnTargetsBuilder vpnTargetsBuilder = new VpnTargetsBuilder().setVpnTarget(opVpnTargetList);
 315             builder.setVpnTargets(vpnTargetsBuilder.build());
 316
 317             List<String> rds = config.getRouteDistinguisher();
 318             builder.setRd(rds);
 319         } else {
 320             builder.setBgpvpnType(VpnInstanceOpDataEntry.BgpvpnType.VPN);
 321         }
 322         writeOperTxn.merge(VpnUtil.getVpnInstanceOpDataIdentifier(primaryRd), builder.build(), CREATE_MISSING_PARENTS);
 323         LOG.info("{} addVpnInstance: VpnInstanceOpData populated successfully for vpn {} rd {}", LOGGING_PREFIX_ADD,
 324                 vpnInstanceName, primaryRd);
 325     }
 326
 327     private class PostAddVpnInstanceWorker implements FutureCallback<List<Void>> {
 328         private final Logger log = LoggerFactory.getLogger(PostAddVpnInstanceWorker.class);
 329         VpnInstance vpnInstance;
 330         String vpnName;
 331
 332         PostAddVpnInstanceWorker(VpnInstance vpnInstance, String vpnName) {
 333             this.vpnInstance = vpnInstance;
 334             this.vpnName = vpnName;
 335         }
 336
 337         /**
 338          * This implies that all the future instances have returned success. -- TODO: Confirm this
 339          */
 340         @Override
 341         public void onSuccess(List<Void> voids) {
 342             /*
 343             if rd is null, then its either a router vpn instance (or) a vlan external network vpn instance.
 344             if rd is non-null, then it is a bgpvpn instance
 345              */
 346             VpnAfConfig config = vpnInstance.getIpv4Family();
 347             List<String> rd = config.getRouteDistinguisher();
 348             if (rd == null || addBgpVrf()) {
 349                 notifyTask();
 350                 vpnInterfaceManager.vpnInstanceIsReady(vpnName);
 351             }
 352             log.info("{} onSuccess: Vpn Instance Op Data addition for {} successful.", LOGGING_PREFIX_ADD, vpnName);
 353             VpnInstanceOpDataEntry vpnInstanceOpDataEntry = vpnUtil.getVpnInstanceOpData(
 354                     VpnUtil.getPrimaryRd(vpnInstance));
 355
 356             // bind service on each tunnel interface
 357             //TODO (KIRAN): Add a new listener to handle creation of new DC-GW binding and deletion of existing DC-GW.
 358             if (VpnUtil.isL3VpnOverVxLan(vpnInstance.getL3vni())) { //Handled for L3VPN Over VxLAN
 359                 for (String tunnelInterfaceName: getDcGatewayTunnelInterfaceNameList()) {
 360                     vpnUtil.bindService(vpnInstance.getVpnInstanceName(), tunnelInterfaceName,
 361                             true/*isTunnelInterface*/);
 362                 }
 363
 364                 // install flow
 365                 List<MatchInfo> mkMatches = new ArrayList<>();
 366                 mkMatches.add(new MatchTunnelId(Uint64.valueOf(vpnInstance.getL3vni())));
 367
 368                 List<InstructionInfo> instructions =
 369                         Arrays.asList(new InstructionWriteMetadata(MetaDataUtil.getVpnIdMetadata(vpnInstanceOpDataEntry
 370                                 .getVpnId().toJava()), MetaDataUtil.METADATA_MASK_VRFID),
 371                                 new InstructionGotoTable(NwConstants.L3_GW_MAC_TABLE));
 372
 373                 for (Uint64 dpnId: NWUtil.getOperativeDPNs(dataBroker)) {
 374                     String flowRef = getFibFlowRef(dpnId, NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE,
 375                             vpnName, VpnConstants.DEFAULT_FLOW_PRIORITY);
 376                     FlowEntity flowEntity = MDSALUtil.buildFlowEntity(dpnId,
 377                             NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, flowRef, VpnConstants.DEFAULT_FLOW_PRIORITY,
 378                             "VxLAN VPN Tunnel Bind Service", 0, 0, NwConstants.COOKIE_VM_FIB_TABLE,
 379                             mkMatches, instructions);
 380                     mdsalManager.installFlow(dpnId, flowEntity);
 381                 }
 382
 383                 ///////////////////////
 384             }
 385         }
 386
 387         // TODO Clean up the exception handling
 388         @SuppressWarnings("checkstyle:IllegalCatch")
 389         private boolean addBgpVrf() {
 390             VpnAfConfig config = vpnInstance.getIpv4Family();
 391             String primaryRd = vpnUtil.getPrimaryRd(vpnName);
 392             List<VpnTarget> vpnTargetList = config.getVpnTargets().getVpnTarget();
 393
 394             if (vpnTargetList == null) {
 395                 log.error("{} addBgpVrf: vpn target list is empty for vpn {} RD {}", LOGGING_PREFIX_ADD,
 396                         this.vpnName, primaryRd);
 397                 return false;
 398             }
 399             // FIXME: separate out to somehow?
 400             final ReentrantLock lock = JvmGlobalLocks.getLockForString(vpnName);
 401             lock.lock();
 402             try {
 403                 fibManager.addVrfTable(primaryRd, null);
 404             } finally {
 405                 lock.unlock();
 406             }
 407             vpnInterfaceManager.handleVpnsExportingRoutes(this.vpnName, primaryRd);
 408             return true;
 409         }
 410
 411         private void notifyTask() {
 412             vpnOpDataNotifier.notifyVpnOpDataReady(VpnOpDataSyncer.VpnOpDataType.vpnInstanceToId, vpnName);
 413             vpnOpDataNotifier.notifyVpnOpDataReady(VpnOpDataSyncer.VpnOpDataType.vpnOpData, vpnName);
 414         }
 415
 416         /**
 417          * This method is used to handle failure callbacks.
 418          * If more retry needed, the retrycount is decremented and mainworker is executed again.
 419          * After retries completed, rollbackworker is executed.
 420          * If rollbackworker fails, this is a double-fault. Double fault is logged and ignored.
 421          */
 422
 423         @Override
 424         public void onFailure(Throwable throwable) {
 425             log.error("{} onFailure: Job for vpnInstance: {} failed with exception:", LOGGING_PREFIX_ADD, vpnName,
 426                     throwable);
 427             vpnInterfaceManager.vpnInstanceFailed(vpnName);
 428         }
 429     }
 430
 431     @Nullable
 432     protected VpnInstanceOpDataEntry getVpnInstanceOpData(String rd) {
 433         InstanceIdentifier<VpnInstanceOpDataEntry> id = VpnUtil.getVpnInstanceOpDataIdentifier(rd);
 434         try {
 435             return SingleTransactionDataBroker.syncReadOptional(dataBroker, LogicalDatastoreType.OPERATIONAL,
 436                     id).orNull();
 437         } catch (ReadFailedException e) {
 438             throw new RuntimeException("Error reading VPN instance data for " + rd, e);
 439         }
 440     }
 441
 442     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
 443             justification = "https://github.com/spotbugs/spotbugs/issues/811")
 444     private List<String> getDcGatewayTunnelInterfaceNameList() {
 445         List<String> tunnelInterfaceNameList = new ArrayList<>();
 446         try {
 447             InstanceIdentifier<DcGatewayIpList> dcGatewayIpListInstanceIdentifier = InstanceIdentifier
 448                     .create(DcGatewayIpList.class);
 449             Optional<DcGatewayIpList> dcGatewayIpListOptional = SingleTransactionDataBroker.syncReadOptional(
 450                     dataBroker, LogicalDatastoreType.CONFIGURATION, dcGatewayIpListInstanceIdentifier);
 451             if (!dcGatewayIpListOptional.isPresent()) {
 452                 LOG.info("No DC gateways configured.");
 453                 return tunnelInterfaceNameList;
 454             }
 455             List<DcGatewayIp> dcGatewayIps = dcGatewayIpListOptional.get().nonnullDcGatewayIp();
 456             InstanceIdentifier<ExternalTunnelList> externalTunnelListId = InstanceIdentifier
 457                     .create(ExternalTunnelList.class);
 458             Optional<ExternalTunnelList> externalTunnelListOptional = SingleTransactionDataBroker.syncReadOptional(
 459                     dataBroker, LogicalDatastoreType.OPERATIONAL, externalTunnelListId);
 460             if (externalTunnelListOptional.isPresent()) {
 461                 List<ExternalTunnel> externalTunnels = externalTunnelListOptional.get().nonnullExternalTunnel();
 462                 List<String> externalTunnelIpList = new ArrayList<>();
 463                 for (ExternalTunnel externalTunnel: externalTunnels) {
 464                     externalTunnelIpList.add(externalTunnel.getDestinationDevice());
 465                 }
 466                 List<String> dcGatewayIpList = new ArrayList<>();
 467                 for (DcGatewayIp dcGatewayIp: dcGatewayIps) {
 468                     dcGatewayIpList.add(dcGatewayIp.getIpAddress().getIpv4Address().toString());
 469                 }
 470                 // Find all externalTunnelIps present in dcGateWayIpList
 471                 List<String> externalTunnelIpsInDcGatewayIpList = new ArrayList<>();
 472                 for (String externalTunnelIp: externalTunnelIpList) {
 473                     for (String dcGateWayIp: dcGatewayIpList) {
 474                         if (externalTunnelIp.contentEquals(dcGateWayIp)) {
 475                             externalTunnelIpsInDcGatewayIpList.add(externalTunnelIp);
 476                         }
 477                     }
 478                 }
 479                 for (String externalTunnelIpsInDcGatewayIp: externalTunnelIpsInDcGatewayIpList) {
 480                     for (ExternalTunnel externalTunnel: externalTunnels) {
 481                         if (externalTunnel.getDestinationDevice().contentEquals(externalTunnelIpsInDcGatewayIp)) {
 482                             tunnelInterfaceNameList.add(externalTunnel.getTunnelInterfaceName());
 483                         }
 484                     }
 485                 }
 486
 487             }
 488         } catch (ReadFailedException e) {
 489             LOG.error("getDcGatewayTunnelInterfaceNameList: Failed to read data store");
 490         }
 491         return tunnelInterfaceNameList;
 492     }
 493
 494     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
 495             justification = "https://github.com/spotbugs/spotbugs/issues/811")
 496     private String getFibFlowRef(Uint64 dpnId, short tableId, String vpnName, int priority) {
 497         return VpnConstants.FLOWID_PREFIX + dpnId + NwConstants.FLOWID_SEPARATOR + tableId
 498                 + NwConstants.FLOWID_SEPARATOR + vpnName + NwConstants.FLOWID_SEPARATOR + priority;
 499     }
 500 }