interfacemanager/interfacemanager-impl/src/main/java/org/opendaylight/genius/interfacemanager/renderer/ovs/confighelpers/OvsInterfaceConfigRemoveHelper.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 package org.opendaylight.genius.interfacemanager.renderer.ovs.confighelpers;
   9
  10 import com.google.common.util.concurrent.ListenableFuture;
  11 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  12 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  13 import org.opendaylight.genius.datastoreutils.DataStoreJobCoordinator;
  14 import org.opendaylight.genius.interfacemanager.IfmConstants;
  15 import org.opendaylight.genius.interfacemanager.IfmUtil;
  16 import org.opendaylight.genius.interfacemanager.commons.AlivenessMonitorUtils;
  17 import org.opendaylight.genius.interfacemanager.commons.InterfaceManagerCommonUtils;
  18 import org.opendaylight.genius.interfacemanager.commons.InterfaceMetaUtils;
  19 import org.opendaylight.genius.interfacemanager.renderer.ovs.utilities.SouthboundUtils;
  20 import org.opendaylight.genius.interfacemanager.servicebindings.flowbased.utilities.FlowBasedServicesUtils;
  21 import org.opendaylight.genius.mdsalutil.NwConstants;
  22 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.AlivenessMonitorService;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._interface.child.info.InterfaceParentEntry;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._interface.child.info._interface.parent.entry.InterfaceChildEntry;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.BridgeEntry;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.BridgeEntryKey;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.bridge.entry.BridgeInterfaceEntry;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfTunnel;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.ParentRefs;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeRef;
  36 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39
  40 import java.math.BigInteger;
  41 import java.util.ArrayList;
  42 import java.util.List;
  43 import java.util.concurrent.Callable;
  44
  45 public class OvsInterfaceConfigRemoveHelper {
  46     private static final Logger LOG = LoggerFactory.getLogger(OvsInterfaceConfigRemoveHelper.class);
  47
  48     public static List<ListenableFuture<Void>> removeConfiguration(DataBroker dataBroker, AlivenessMonitorService alivenessMonitorService,
  49                                                                    Interface interfaceOld,
  50                                                                    IdManagerService idManager,
  51                                                                    IMdsalApiManager mdsalApiManager,
  52                                                                    ParentRefs parentRefs) {
  53         List<ListenableFuture<Void>> futures = new ArrayList<>();
  54         WriteTransaction defaultOperationalShardTransaction = dataBroker.newWriteOnlyTransaction();
  55         WriteTransaction defaultConfigShardTransaction = dataBroker.newWriteOnlyTransaction();
  56
  57         IfTunnel ifTunnel = interfaceOld.getAugmentation(IfTunnel.class);
  58         if (ifTunnel != null) {
  59             removeTunnelConfiguration(alivenessMonitorService, parentRefs, dataBroker, interfaceOld.getName(), ifTunnel,
  60                     idManager, mdsalApiManager, defaultOperationalShardTransaction, defaultConfigShardTransaction, futures);
  61         }else {
  62             removeVlanConfiguration(dataBroker, parentRefs, interfaceOld.getName(),
  63                     interfaceOld.getAugmentation(IfL2vlan.class), defaultOperationalShardTransaction, defaultConfigShardTransaction,
  64                     futures, idManager);
  65         }
  66         futures.add(defaultConfigShardTransaction.submit());
  67         futures.add(defaultOperationalShardTransaction.submit());
  68         return futures;
  69     }
  70
  71     private static void removeVlanConfiguration(DataBroker dataBroker, ParentRefs parentRefs, String interfaceName,
  72                                                 IfL2vlan ifL2vlan, WriteTransaction defaultOperationalShardTransaction,
  73                                                 WriteTransaction defaultConfigShardTransaction,
  74                                                 List<ListenableFuture<Void>> futures, IdManagerService idManagerService) {
  75         if (parentRefs == null || ifL2vlan == null ||
  76                 (IfL2vlan.L2vlanMode.Trunk != ifL2vlan.getL2vlanMode() &&
  77                         IfL2vlan.L2vlanMode.Transparent != ifL2vlan.getL2vlanMode())) {
  78             return;
  79         }
  80         LOG.debug("removing vlan configuration for {}", interfaceName);
  81         InterfaceManagerCommonUtils.deleteInterfaceStateInformation(interfaceName, defaultOperationalShardTransaction, idManagerService);
  82
  83         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface ifState =
  84                 InterfaceManagerCommonUtils.getInterfaceStateFromOperDS(interfaceName, dataBroker);
  85
  86         if (ifState == null) {
  87             LOG.debug("could not fetch interface state corresponding to {}", interfaceName);
  88         }
  89
  90         cleanUpInterfaceWithUnknownState(interfaceName, parentRefs, null, dataBroker, defaultOperationalShardTransaction, idManagerService);
  91         BigInteger dpId = IfmUtil.getDpnFromInterface(ifState);
  92         FlowBasedServicesUtils.removeIngressFlow(interfaceName, dpId, dataBroker, futures);
  93         InterfaceManagerCommonUtils.deleteParentInterfaceEntry(defaultConfigShardTransaction, parentRefs.getParentInterface());
  94         // For Vlan-Trunk Interface, remove the trunk-member operstates as well...
  95
  96         InterfaceParentEntry interfaceParentEntry =
  97                 InterfaceMetaUtils.getInterfaceParentEntryFromConfigDS(interfaceName, dataBroker);
  98         if (interfaceParentEntry == null || interfaceParentEntry.getInterfaceChildEntry() == null) {
  99             return;
 100         }
 101
 102         DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
 103         VlanMemberStateRemoveWorker vlanMemberStateRemoveWorker = new VlanMemberStateRemoveWorker(dataBroker,
 104                 idManagerService, dpId, interfaceName, interfaceParentEntry);
 105         coordinator.enqueueJob(interfaceName, vlanMemberStateRemoveWorker, IfmConstants.JOB_MAX_RETRIES);
 106
 107     }
 108
 109     private static void removeTunnelConfiguration(AlivenessMonitorService alivenessMonitorService, ParentRefs parentRefs,
 110                                                   DataBroker dataBroker, String interfaceName, IfTunnel ifTunnel,
 111                                                   IdManagerService idManager, IMdsalApiManager mdsalApiManager,
 112                                                   WriteTransaction defaultOperationalShardTransaction,
 113                                                   WriteTransaction defaultConfigShardTransaction,
 114                                                   List<ListenableFuture<Void>> futures) {
 115         LOG.debug("removing tunnel configuration for {}",interfaceName);
 116         WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
 117         BigInteger dpId = null;
 118         if (parentRefs != null) {
 119             dpId = parentRefs.getDatapathNodeIdentifier();
 120         }
 121
 122         if (dpId == null) {
 123             return;
 124         }
 125
 126         OvsdbBridgeRef ovsdbBridgeRef =
 127                 InterfaceMetaUtils.getBridgeRefEntryFromOperDS(dpId, dataBroker);
 128         if (ovsdbBridgeRef != null) {
 129             SouthboundUtils.removeTerminationEndPoint(futures, dataBroker, ovsdbBridgeRef.getValue(), interfaceName);
 130         }
 131
 132         // delete tunnel ingress flow
 133         removeTunnelIngressFlow(futures, dataBroker, interfaceName, ifTunnel, mdsalApiManager, dpId);
 134
 135         // delete bridge to tunnel interface mappings
 136         BridgeEntryKey bridgeEntryKey = new BridgeEntryKey(dpId);
 137         InstanceIdentifier<BridgeEntry> bridgeEntryIid = InterfaceMetaUtils.getBridgeEntryIdentifier(bridgeEntryKey);
 138         BridgeEntry bridgeEntry = InterfaceMetaUtils.getBridgeEntryFromConfigDS(bridgeEntryIid, dataBroker);
 139         if (bridgeEntry == null) {
 140             LOG.debug("Bridge Entry not present for dpn: {}", dpId);
 141             return;
 142         }
 143
 144         List<BridgeInterfaceEntry> bridgeInterfaceEntries = bridgeEntry.getBridgeInterfaceEntry();
 145         if (bridgeInterfaceEntries == null) {
 146             LOG.debug("Bridge Interface Entries not present for dpn : {}", dpId);
 147             return;
 148         }
 149
 150         InterfaceMetaUtils.deleteBridgeInterfaceEntry(bridgeEntryKey, bridgeInterfaceEntries, bridgeEntryIid, defaultConfigShardTransaction, interfaceName);
 151         InterfaceMetaUtils.removeLportTagInterfaceMap(idManager, defaultOperationalShardTransaction, interfaceName);
 152         cleanUpInterfaceWithUnknownState(interfaceName, parentRefs, ifTunnel, dataBroker, defaultOperationalShardTransaction, idManager);
 153         // stop LLDP monitoring for the tunnel interface
 154         AlivenessMonitorUtils.stopLLDPMonitoring(alivenessMonitorService, dataBroker, ifTunnel, interfaceName);
 155     }
 156
 157     public static void removeTunnelIngressFlow(List<ListenableFuture<Void>> futures,
 158                                                DataBroker dataBroker, String interfaceName, IfTunnel ifTunnel,
 159                                                IMdsalApiManager mdsalApiManager, BigInteger dpId){
 160         NodeConnectorId ncId = IfmUtil.getNodeConnectorIdFromInterface(interfaceName, dataBroker);
 161         if(ncId == null){
 162             LOG.debug("Node Connector Id is null. Skipping remove tunnel ingress flow.");
 163         }else{
 164             long portNo = Long.valueOf(IfmUtil.getPortNoFromNodeConnectorId(ncId));
 165             InterfaceManagerCommonUtils.makeTunnelIngressFlow(futures, mdsalApiManager,
 166                     ifTunnel,
 167                     dpId, portNo,interfaceName , -1,
 168                     NwConstants.DEL_FLOW);
 169         }
 170     }
 171
 172     // if the node is shutdown, there will be stale interface state entries,
 173     // with unknown op-state, clear them.
 174     public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface
 175     cleanUpInterfaceWithUnknownState(String interfaceName, ParentRefs parentRefs, IfTunnel ifTunnel, DataBroker dataBroker,
 176                                      WriteTransaction transaction, IdManagerService idManagerService){
 177         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface ifState =
 178                 InterfaceManagerCommonUtils.getInterfaceStateFromOperDS(interfaceName, dataBroker);
 179         if (ifState != null && ifState.getOperStatus() ==
 180                 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.OperStatus.Unknown) {
 181             String staleInterface = ifTunnel != null ? interfaceName : parentRefs.getParentInterface();
 182             LOG.debug("cleaning up parent-interface for {}, since the oper-status is UNKNOWN", interfaceName);
 183             InterfaceManagerCommonUtils.deleteInterfaceStateInformation(staleInterface, transaction, idManagerService);
 184         }
 185         return ifState;
 186     }
 187
 188     private static class VlanMemberStateRemoveWorker implements Callable<List<ListenableFuture<Void>>> {
 189
 190         private DataBroker dataBroker;
 191         private IdManagerService idManager;
 192         private BigInteger dpId;
 193         private String interfaceName;
 194         private InterfaceParentEntry interfaceParentEntry;
 195
 196         public VlanMemberStateRemoveWorker(DataBroker dataBroker, IdManagerService idManager, BigInteger dpId,
 197                 String interfaceName, InterfaceParentEntry interfaceParentEntry) {
 198             super();
 199             this.dataBroker = dataBroker;
 200             this.idManager = idManager;
 201             this.dpId = dpId;
 202             this.interfaceName = interfaceName;
 203             this.interfaceParentEntry = interfaceParentEntry;
 204         }
 205
 206         @Override
 207         public List<ListenableFuture<Void>> call() throws Exception {
 208             List<ListenableFuture<Void>> futures = new ArrayList<>();
 209             WriteTransaction operShardTransaction = dataBroker.newWriteOnlyTransaction();
 210             // FIXME: If the no. of child entries exceeds 100, perform txn
 211             // updates in batches of 100.
 212             for (InterfaceChildEntry interfaceChildEntry : interfaceParentEntry.getInterfaceChildEntry()) {
 213                 LOG.debug("removing interface state for vlan trunk member {}", interfaceChildEntry.getChildInterface());
 214                 InterfaceManagerCommonUtils.deleteInterfaceStateInformation(interfaceChildEntry.getChildInterface(),
 215                         operShardTransaction, idManager);
 216                 FlowBasedServicesUtils.removeIngressFlow(interfaceChildEntry.getChildInterface(), dpId, dataBroker,
 217                         futures);
 218                 FlowBasedServicesUtils.unbindDefaultEgressDispatcherService(dataBroker, interfaceName,
 219                         interfaceParentEntry.getParentInterface());
 220             }
 221
 222             futures.add(operShardTransaction.submit());
 223             return futures;
 224         }
 225
 226         @Override
 227         public String toString() {
 228             return "VlanMemberStateRemoveWorker [dpId=" + dpId + ", interfaceName=" + interfaceName
 229                     + ", interfaceParentEntry=" + interfaceParentEntry + "]";
 230         }
 231     }
 232 }