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