NETVIRT-1630 migrate to md-sal APIs
[netvirt.git] / natservice / impl / src / main / java / org / opendaylight / netvirt / natservice / internal / RouterDpnChangeListener.java
index 76b064b7984e69d91d5e09e052136022cb24aba0..d14dd3ef8b2433a3f281b7998f65e0aaa44af9aa 100644 (file)
@@ -9,38 +9,28 @@ package org.opendaylight.netvirt.natservice.internal;
 
 import static org.opendaylight.genius.infra.Datastore.CONFIGURATION;
 
-import com.google.common.base.Optional;
-import java.math.BigInteger;
 import java.util.Collection;
 import java.util.Collections;
-import java.util.List;
-import java.util.Map;
-import java.util.concurrent.ExecutionException;
-import javax.annotation.PostConstruct;
+import java.util.Optional;
+import javax.annotation.PreDestroy;
 import javax.inject.Inject;
 import javax.inject.Singleton;
-import org.opendaylight.controller.md.sal.binding.api.DataBroker;
-import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
-import org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase;
 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
-import org.opendaylight.genius.infra.Datastore.Configuration;
 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
-import org.opendaylight.genius.infra.TypedReadWriteTransaction;
-import org.opendaylight.genius.mdsalutil.BucketInfo;
-import org.opendaylight.genius.mdsalutil.FlowEntity;
-import org.opendaylight.genius.mdsalutil.GroupEntity;
-import org.opendaylight.genius.mdsalutil.MDSALUtil;
 import org.opendaylight.genius.mdsalutil.NwConstants;
 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
+import org.opendaylight.infrautils.utils.concurrent.Executors;
 import org.opendaylight.infrautils.utils.concurrent.ListenableFutures;
+import org.opendaylight.mdsal.binding.api.DataBroker;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
 import org.opendaylight.netvirt.natservice.api.SnatServiceManager;
 import org.opendaylight.netvirt.neutronvpn.interfaces.INeutronVpnManager;
+import org.opendaylight.serviceutils.tools.listener.AbstractAsyncDataTreeChangeListener;
 import org.opendaylight.serviceutils.upgrade.UpgradeState;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupTypes;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.NeutronRouterDpns;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnList;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.router.dpn.list.DpnVpninterfacesList;
@@ -49,12 +39,13 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.config.r
 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ProviderTypes;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.Routers;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.common.Uint32;
+import org.opendaylight.yangtools.yang.common.Uint64;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 @Singleton
-public class RouterDpnChangeListener
-        extends AsyncDataTreeChangeListenerBase<DpnVpninterfacesList, RouterDpnChangeListener> {
+public class RouterDpnChangeListener extends AbstractAsyncDataTreeChangeListener<DpnVpninterfacesList> {
 
     private static final Logger LOG = LoggerFactory.getLogger(RouterDpnChangeListener.class);
     private final DataBroker dataBroker;
@@ -81,7 +72,9 @@ public class RouterDpnChangeListener
                                    final NatserviceConfig config,
                                    final JobCoordinator coordinator,
                                    final UpgradeState upgradeState) {
-        super(DpnVpninterfacesList.class, RouterDpnChangeListener.class);
+        super(dataBroker, LogicalDatastoreType.OPERATIONAL, InstanceIdentifier.create(NeutronRouterDpns.class)
+                .child(RouterDpnList.class).child(DpnVpninterfacesList.class),
+                Executors.newListeningSingleThreadExecutor("RouterDpnChangeListener", LOG));
         this.dataBroker = dataBroker;
         this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
         this.mdsalManager = mdsalManager;
@@ -96,29 +89,22 @@ public class RouterDpnChangeListener
         this.upgradeState = upgradeState;
     }
 
-    @Override
-    @PostConstruct
     public void init() {
         LOG.info("{} init", getClass().getSimpleName());
-        registerListener(LogicalDatastoreType.OPERATIONAL, dataBroker);
     }
 
     @Override
-    protected RouterDpnChangeListener getDataTreeChangeListener() {
-        return RouterDpnChangeListener.this;
+    @PreDestroy
+    public void close() {
+        super.close();
+        Executors.shutdownAndAwaitTermination(getExecutorService());
     }
 
     @Override
-    protected InstanceIdentifier<DpnVpninterfacesList> getWildCardPath() {
-        return InstanceIdentifier.create(NeutronRouterDpns.class).child(RouterDpnList.class)
-            .child(DpnVpninterfacesList.class);
-    }
-
-    @Override
-    protected void add(final InstanceIdentifier<DpnVpninterfacesList> identifier, final DpnVpninterfacesList dpnInfo) {
+    public void add(final InstanceIdentifier<DpnVpninterfacesList> identifier, final DpnVpninterfacesList dpnInfo) {
         LOG.trace("add : key: {}, value: {}", dpnInfo.key(), dpnInfo);
         final String routerUuid = identifier.firstKeyOf(RouterDpnList.class).getRouterId();
-        BigInteger dpnId = dpnInfo.getDpnId();
+        Uint64 dpnId = dpnInfo.getDpnId();
         //check router is associated to external network
         InstanceIdentifier<Routers> id = NatUtil.buildRouterIdentifier(routerUuid);
         Optional<Routers> routerData =
@@ -129,8 +115,8 @@ public class RouterDpnChangeListener
             Uuid networkId = router.getNetworkId();
             if (networkId != null) {
                 if (natMode == NatMode.Conntrack) {
-                    BigInteger naptSwitch = NatUtil.getPrimaryNaptfromRouterName(dataBroker, router.getRouterName());
-                    if (naptSwitch == null || naptSwitch.equals(BigInteger.ZERO)) {
+                    Uint64 naptSwitch = NatUtil.getPrimaryNaptfromRouterName(dataBroker, router.getRouterName());
+                    if (naptSwitch == null || naptSwitch.equals(Uint64.ZERO)) {
                         LOG.warn("add : NAPT switch is not selected.");
                         return;
                     }
@@ -149,7 +135,7 @@ public class RouterDpnChangeListener
                             }
                         }), LOG, "Error notifying NAT service manager");
                 } else {
-                    Long routerId = NatUtil.getVpnId(dataBroker, routerUuid);
+                    Uint32 routerId = NatUtil.getVpnId(dataBroker, routerUuid);
                     if (routerId == NatConstants.INVALID_ID) {
                         LOG.error("add : Invalid routerId returned for routerName {}", routerUuid);
                         return;
@@ -169,7 +155,7 @@ public class RouterDpnChangeListener
                         Uuid vpnName = NatUtil.getVpnForRouter(dataBroker, routerUuid);
                         return Collections.singletonList(
                             txRunner.callWithNewReadWriteTransactionAndSubmit(CONFIGURATION, confTx -> {
-                                Long vpnId;
+                                Uint32 vpnId;
                                 if (vpnName == null) {
                                     LOG.debug("add : Internal vpn associated to router {}", routerUuid);
                                     vpnId = routerId;
@@ -207,7 +193,8 @@ public class RouterDpnChangeListener
                                         LOG.error("add : External Network Provider Type missing");
                                         return;
                                     }
-                                    handleSNATForDPN(dpnId, routerUuid, routerId, vpnId, confTx);
+                                    NatUtil.handleSNATForDPN(dataBroker, mdsalManager, idManager, naptSwitchHA,
+                                        dpnId, router, routerId, vpnId, confTx, extNwProvType, upgradeState);
                                 } else {
                                     LOG.info("add : SNAT is not enabled for router {} to handle addDPN event {}",
                                         routerUuid, dpnId);
@@ -222,15 +209,15 @@ public class RouterDpnChangeListener
     }
 
     @Override
-    protected void remove(InstanceIdentifier<DpnVpninterfacesList> identifier, DpnVpninterfacesList dpnInfo) {
+    public void remove(InstanceIdentifier<DpnVpninterfacesList> identifier, DpnVpninterfacesList dpnInfo) {
         LOG.trace("remove : key: {}, value: {}", dpnInfo.key(), dpnInfo);
         final String routerUuid = identifier.firstKeyOf(RouterDpnList.class).getRouterId();
-        Long routerId = NatUtil.getVpnId(dataBroker, routerUuid);
+        Uint32 routerId = NatUtil.getVpnId(dataBroker, routerUuid);
         if (routerId == NatConstants.INVALID_ID) {
             LOG.error("REMOVE: Invalid routId returned for routerName {}",routerUuid);
             return;
         }
-        BigInteger dpnId = dpnInfo.getDpnId();
+        Uint64 dpnId = dpnInfo.getDpnId();
         //check router is associated to external network
         InstanceIdentifier<Routers> id = NatUtil.buildRouterIdentifier(routerUuid);
         Optional<Routers> routerData =
@@ -241,8 +228,8 @@ public class RouterDpnChangeListener
             Uuid networkId = router.getNetworkId();
             if (networkId != null) {
                 if (natMode == NatMode.Conntrack) {
-                    BigInteger naptSwitch = NatUtil.getPrimaryNaptfromRouterName(dataBroker, router.getRouterName());
-                    if (naptSwitch == null || naptSwitch.equals(BigInteger.ZERO)) {
+                    Uint64 naptSwitch = NatUtil.getPrimaryNaptfromRouterName(dataBroker, router.getRouterName());
+                    if (naptSwitch == null || naptSwitch.equals(Uint64.ZERO)) {
                         LOG.warn("remove : NAPT switch is not selected.");
                         return;
                     }
@@ -266,7 +253,7 @@ public class RouterDpnChangeListener
                         Uuid vpnName = NatUtil.getVpnForRouter(dataBroker, routerUuid);
                         return Collections.singletonList(
                             txRunner.callWithNewReadWriteTransactionAndSubmit(CONFIGURATION, confTx -> {
-                                Long vpnId;
+                                Uint32 vpnId;
                                 if (vpnName == null) {
                                     LOG.debug("remove : Internal vpn associated to router {}", routerUuid);
                                     vpnId = routerId;
@@ -297,8 +284,16 @@ public class RouterDpnChangeListener
                                 nvpnManager.programV6InternetFallbackFlow(new Uuid(routerUuid),
                                         NatUtil.getVpnIdfromNetworkId(dataBroker, networkId), NwConstants.DEL_FLOW);
                                 if (router.isEnableSnat()) {
+                                    ProviderTypes extNwProvType = NatEvpnUtil.getExtNwProvTypeFromRouterName(dataBroker,
+                                        routerUuid, networkId);
+                                    if (extNwProvType == null) {
+                                        return;
+                                    }
                                     LOG.info("remove : SNAT enabled for router {}", routerUuid);
-                                    removeSNATFromDPN(dpnId, routerUuid, routerId, vpnId, networkId, confTx);
+                                    String externalVpnName = NatUtil.getAssociatedVPN(dataBroker,
+                                        routerData.get().getNetworkId());
+                                    NatUtil.removeSNATFromDPN(dataBroker, mdsalManager, idManager, naptSwitchHA, dpnId,
+                                        router, routerId, vpnId, externalVpnName, extNwProvType, confTx);
                                 } else {
                                     LOG.info("remove : SNAT is not enabled for router {} to handle removeDPN event {}",
                                         routerUuid, dpnId);
@@ -311,207 +306,19 @@ public class RouterDpnChangeListener
     }
 
     @Override
-    protected void update(InstanceIdentifier<DpnVpninterfacesList> identifier, DpnVpninterfacesList original,
+    public void update(InstanceIdentifier<DpnVpninterfacesList> identifier, DpnVpninterfacesList original,
                           DpnVpninterfacesList update) {
         LOG.trace("Update key: {}, original: {}, update: {}", update.key(), original, update);
     }
 
-    void handleSNATForDPN(BigInteger dpnId, String routerName, long routerId, Long routerVpnId,
-        TypedReadWriteTransaction<Configuration> confTx) {
-       //Check if primary and secondary switch are selected, If not select the role
-        //Install select group to NAPT switch
-        //Install default miss entry to NAPT switch
-        BigInteger naptSwitch;
-        try {
-            BigInteger naptId = NatUtil.getPrimaryNaptfromRouterName(dataBroker, routerName);
-            if (naptId == null || naptId.equals(BigInteger.ZERO)
-                    || !NatUtil.getSwitchStatus(dataBroker, naptId) && !upgradeState.isUpgradeInProgress()) {
-                LOG.debug("handleSNATForDPN : NaptSwitch is down or not selected for router {},naptId {}",
-                        routerName, naptId);
-                naptSwitch = dpnId;
-                boolean naptstatus = naptSwitchHA.updateNaptSwitch(routerName, naptSwitch);
-                if (!naptstatus) {
-                    LOG.error("handleSNATForDPN : Failed to update newNaptSwitch {} for routername {}",
-                            naptSwitch, routerName);
-                    return;
-                }
-                LOG.debug("handleSNATForDPN : Switch {} is elected as NaptSwitch for router {}", dpnId, routerName);
-                Routers extRouters = NatUtil.getRoutersFromConfigDS(dataBroker, routerName);
-                if (extRouters != null) {
-                    NatUtil.createRouterIdsConfigDS(dataBroker, routerId, routerName);
-                    naptSwitchHA.subnetRegisterMapping(extRouters, routerId);
-                }
-
-                naptSwitchHA.installSnatFlows(routerName, routerId, naptSwitch, routerVpnId, confTx);
-
-                // Install miss entry (table 26) pointing to table 46
-                FlowEntity flowEntity = naptSwitchHA.buildSnatFlowEntityForNaptSwitch(dpnId, routerName,
-                        routerVpnId, NatConstants.ADD_FLOW);
-                if (flowEntity == null) {
-                    LOG.error("handleSNATForDPN : Failed to populate flowentity for router {} with dpnId {}",
-                            routerName, dpnId);
-                    return;
-                }
-                LOG.debug("handleSNATForDPN : Successfully installed flow for dpnId {} router {}", dpnId, routerName);
-                mdsalManager.addFlow(confTx, flowEntity);
-                //Removing primary flows from old napt switch
-                if (naptId != null && !naptId.equals(BigInteger.ZERO)) {
-                    LOG.debug("handleSNATForDPN : Removing primary flows from old napt switch {} for router {}",
-                            naptId, routerName);
-                    naptSwitchHA.removeSnatFlowsInOldNaptSwitch(routerName, routerId, naptId, null, confTx);
-                }
-            } else if (naptId.equals(dpnId)) {
-                LOG.debug("handleSNATForDPN : NaptSwitch {} gone down during cluster reboot came alive", naptId);
-            } else {
-                naptSwitch = naptId;
-                LOG.debug("handleSNATForDPN : Napt switch with Id {} is already elected for router {}",
-                        naptId, routerName);
-
-                //installing group
-                List<BucketInfo> bucketInfo = naptSwitchHA.handleGroupInNeighborSwitches(dpnId,
-                        routerName, routerId, naptSwitch);
-                naptSwitchHA.installSnatGroupEntry(dpnId, bucketInfo, routerName);
-
-                // Install miss entry (table 26) pointing to group
-                long groupId = NatUtil.getUniqueId(idManager, NatConstants.SNAT_IDPOOL_NAME,
-                    NatUtil.getGroupIdKey(routerName));
-                if (groupId != NatConstants.INVALID_ID) {
-                    FlowEntity flowEntity =
-                        naptSwitchHA.buildSnatFlowEntity(dpnId, routerName, groupId,
-                            routerVpnId, NatConstants.ADD_FLOW);
-                    if (flowEntity == null) {
-                        LOG.error(
-                            "handleSNATForDPN : Failed to populate flowentity for router {} with dpnId {} groupId {}",
-                            routerName, dpnId, groupId);
-                        return;
-                    }
-                    LOG.debug(
-                        "handleSNATForDPN : Successfully installed flow for dpnId {} router {} group {}",
-                        dpnId, routerName, groupId);
-                    mdsalManager.addFlow(confTx, flowEntity);
-                } else {
-                    LOG.error("handleSNATForDPN : Failed to Obtain groupId  for router {}", routerName);
-                }
-            }
-        } catch (InterruptedException | ExecutionException e) {
-            LOG.error("handleSNATForDPN : Exception in handleSNATForDPN", e);
-        }
-    }
-
-    // TODO Clean up the exception handling
-    @SuppressWarnings("checkstyle:IllegalCatch")
-    void removeSNATFromDPN(BigInteger dpnId, String routerName, long routerId, long routerVpnId,
-            Uuid extNetworkId, TypedReadWriteTransaction<Configuration> confTx) {
-        //irrespective of naptswitch or non-naptswitch, SNAT default miss entry need to be removed
-        //remove miss entry to NAPT switch
-        //if naptswitch elect new switch and install Snat flows and remove those flows in oldnaptswitch
-
-        Collection<String> externalIpCache = NatUtil.getExternalIpsForRouter(dataBroker, routerId);
-        ProviderTypes extNwProvType = NatEvpnUtil.getExtNwProvTypeFromRouterName(dataBroker, routerName, extNetworkId);
-        if (extNwProvType == null) {
-            return;
-        }
-        //Get the external IP labels other than VXLAN provider type. Since label is not applicable for VXLAN
-        Map<String, Long> externalIpLabel;
-        if (extNwProvType == ProviderTypes.VXLAN) {
-            externalIpLabel = null;
-        } else {
-            externalIpLabel = NatUtil.getExternalIpsLabelForRouter(dataBroker, routerId);
-        }
-        BigInteger naptSwitch = NatUtil.getPrimaryNaptfromRouterName(dataBroker, routerName);
-        if (naptSwitch == null || naptSwitch.equals(BigInteger.ZERO)) {
-            LOG.error("removeSNATFromDPN : No naptSwitch is selected for router {}", routerName);
-            return;
-        }
-        try {
-            boolean naptStatus =
-                naptSwitchHA.isNaptSwitchDown(routerName, routerId, dpnId, naptSwitch, routerVpnId,
-                        externalIpCache, confTx);
-            if (!naptStatus) {
-                LOG.debug("removeSNATFromDPN: Switch with DpnId {} is not naptSwitch for router {}",
-                    dpnId, routerName);
-                FlowEntity flowEntity = null;
-                long groupId = NatUtil.getUniqueId(idManager, NatConstants.SNAT_IDPOOL_NAME,
-                    NatUtil.getGroupIdKey(routerName));
-                try {
-
-                    if (groupId != NatConstants.INVALID_ID) {
-                        flowEntity = naptSwitchHA
-                            .buildSnatFlowEntity(dpnId, routerName, groupId, routerVpnId,
-                                NatConstants.DEL_FLOW);
-                        if (flowEntity == null) {
-                            LOG.error("removeSNATFromDPN : Failed to populate flowentity for router:{} "
-                                + "with dpnId:{} groupId:{}", routerName, dpnId, groupId);
-                            return;
-                        }
-                        LOG.debug("removeSNATFromDPN : Removing default SNAT miss entry flow entity {}",
-                            flowEntity);
-                        mdsalManager.removeFlow(confTx, flowEntity);
-                    } else {
-                        LOG.error("removeSNATFromDPN : Failed to Obtained Groupid for Router {}", routerName);
-                    }
-                } catch (Exception ex) {
-                    LOG.error("removeSNATFromDPN : Failed to remove default SNAT miss entry flow entity {}",
-                        flowEntity, ex);
-                    return;
-                }
-                LOG.debug("removeSNATFromDPN : Removed default SNAT miss entry flow for dpnID {} with routername {}",
-                    dpnId, routerName);
-
-                //remove group
-                GroupEntity groupEntity = null;
-                try {
-                    groupEntity = MDSALUtil.buildGroupEntity(dpnId, groupId, routerName,
-                        GroupTypes.GroupAll, Collections.emptyList() /*listBucketInfo*/);
-                    LOG.info("removeSNATFromDPN : Removing NAPT GroupEntity:{}", groupEntity);
-                    mdsalManager.removeGroup(groupEntity);
-                } catch (Exception ex) {
-                    LOG.error("removeSNATFromDPN : Failed to remove group entity {}", groupEntity, ex);
-                    return;
-                }
-                LOG.debug("removeSNATFromDPN : Removed default SNAT miss entry flow for dpnID {} with routerName {}",
-                    dpnId, routerName);
-            } else {
-                naptSwitchHA.removeSnatFlowsInOldNaptSwitch(routerName, routerId, naptSwitch,
-                        externalIpLabel, confTx);
-                //remove table 26 flow ppointing to table46
-                FlowEntity flowEntity = null;
-                try {
-                    flowEntity = naptSwitchHA.buildSnatFlowEntityForNaptSwitch(dpnId, routerName, routerVpnId,
-                        NatConstants.DEL_FLOW);
-                    if (flowEntity == null) {
-                        LOG.error("removeSNATFromDPN : Failed to populate flowentity for router {} with dpnId {}",
-                                routerName, dpnId);
-                        return;
-                    }
-                    LOG.debug("removeSNATFromDPN : Removing default SNAT miss entry flow entity for router {} with "
-                        + "dpnId {} in napt switch {}", routerName, dpnId, naptSwitch);
-                    mdsalManager.removeFlow(confTx, flowEntity);
-
-                } catch (Exception ex) {
-                    LOG.error("removeSNATFromDPN : Failed to remove default SNAT miss entry flow entity {}",
-                        flowEntity, ex);
-                    return;
-                }
-                LOG.debug("removeSNATFromDPN : Removed default SNAT miss entry flow for dpnID {} with routername {}",
-                    dpnId, routerName);
-
-                //best effort to check IntExt model
-                naptSwitchHA.bestEffortDeletion(routerId, routerName, externalIpLabel, confTx);
-            }
-        } catch (InterruptedException | ExecutionException e) {
-            LOG.error("removeSNATFromDPN : Exception while handling naptSwitch down for router {}", routerName, e);
-        }
-    }
-
-    private void installDefaultNatRouteForRouterExternalSubnets(BigInteger dpnId, Collection<Uuid> externalSubnetIds) {
+    private void installDefaultNatRouteForRouterExternalSubnets(Uint64 dpnId, Collection<Uuid> externalSubnetIds) {
         if (externalSubnetIds == null) {
             LOG.error("installDefaultNatRouteForRouterExternalSubnets : No external subnets for router");
             return;
         }
 
         for (Uuid subnetId : externalSubnetIds) {
-            long vpnIdForSubnet = NatUtil.getExternalSubnetVpnId(dataBroker, subnetId);
+            Uint32 vpnIdForSubnet = NatUtil.getExternalSubnetVpnId(dataBroker, subnetId);
             if (vpnIdForSubnet != NatConstants.INVALID_ID) {
                 LOG.info("installDefaultNatRouteForRouterExternalSubnets : Installing default routes in FIB on dpn {} "
                         + "for subnetId {} with vpnId {}", dpnId, subnetId, vpnIdForSubnet);