interfacemanager/interfacemanager-impl/src/main/java/org/opendaylight/genius/interfacemanager/listeners/InterfaceInventoryStateListener.java

   1 /*
   2  * Copyright (c) 2016, 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.genius.interfacemanager.listeners;
   9
  10 import com.google.common.util.concurrent.ListenableFuture;
  11
  12 import java.math.BigInteger;
  13 import java.util.ArrayList;
  14 import java.util.List;
  15 import java.util.Objects;
  16 import java.util.concurrent.Callable;
  17 import javax.inject.Inject;
  18 import javax.inject.Singleton;
  19 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  20 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  21 import org.opendaylight.genius.datastoreutils.AsyncClusteredDataTreeChangeListenerBase;
  22 import org.opendaylight.genius.datastoreutils.DataStoreJobCoordinator;
  23 import org.opendaylight.genius.interfacemanager.IfmConstants;
  24 import org.opendaylight.genius.interfacemanager.IfmUtil;
  25 import org.opendaylight.genius.interfacemanager.commons.InterfaceManagerCommonUtils;
  26 import org.opendaylight.genius.interfacemanager.commons.InterfaceMetaUtils;
  27 import org.opendaylight.genius.interfacemanager.renderer.ovs.statehelpers.OvsInterfaceStateAddHelper;
  28 import org.opendaylight.genius.interfacemanager.renderer.ovs.statehelpers.OvsInterfaceStateRemoveHelper;
  29 import org.opendaylight.genius.interfacemanager.renderer.ovs.statehelpers.OvsInterfaceStateUpdateHelper;
  30 import org.opendaylight.genius.interfacemanager.renderer.ovs.utilities.IfmClusterUtils;
  31 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.PortReason;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.AlivenessMonitorService;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._interface.child.info.InterfaceParentEntry;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._interface.child.info._interface.parent.entry.InterfaceChildEntry;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  42 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  43 import org.slf4j.Logger;
  44 import org.slf4j.LoggerFactory;
  45
  46 /**
  47  * This Class is a Data Change Listener for FlowCapableNodeConnector updates.
  48  * This creates an entry in the interface-state OperDS for every node-connector
  49  * used.
  50  *
  51  * <p>
  52  * NOTE: This class just creates an ifstate entry whose interface-name will be
  53  * the same as the node-connector portname. If PortName is not unique across
  54  * DPNs, this implementation can have problems.
  55  */
  56 @Singleton
  57 public class InterfaceInventoryStateListener
  58         extends AsyncClusteredDataTreeChangeListenerBase<FlowCapableNodeConnector, InterfaceInventoryStateListener> {
  59     private static final Logger LOG = LoggerFactory.getLogger(InterfaceInventoryStateListener.class);
  60     private final DataBroker dataBroker;
  61     private final IdManagerService idManager;
  62     private final IMdsalApiManager mdsalApiManager;
  63     private final AlivenessMonitorService alivenessMonitorService;
  64
  65     @Inject
  66     public InterfaceInventoryStateListener(final DataBroker dataBroker, final IdManagerService idManagerService,
  67             final IMdsalApiManager mdsalApiManager, final AlivenessMonitorService alivenessMonitorService) {
  68         super(FlowCapableNodeConnector.class, InterfaceInventoryStateListener.class);
  69         this.dataBroker = dataBroker;
  70         this.idManager = idManagerService;
  71         this.mdsalApiManager = mdsalApiManager;
  72         this.alivenessMonitorService = alivenessMonitorService;
  73         this.registerListener(LogicalDatastoreType.OPERATIONAL, dataBroker);
  74     }
  75
  76     @Override
  77     protected InstanceIdentifier<FlowCapableNodeConnector> getWildCardPath() {
  78         return InstanceIdentifier.create(Nodes.class).child(Node.class).child(NodeConnector.class)
  79                 .augmentation(FlowCapableNodeConnector.class);
  80     }
  81
  82     @Override
  83     protected InterfaceInventoryStateListener getDataTreeChangeListener() {
  84         return InterfaceInventoryStateListener.this;
  85     }
  86
  87     @Override
  88     protected void remove(InstanceIdentifier<FlowCapableNodeConnector> key,
  89             FlowCapableNodeConnector flowCapableNodeConnectorOld) {
  90         if (!IfmClusterUtils.isEntityOwner(IfmClusterUtils.INTERFACE_CONFIG_ENTITY)) {
  91             return;
  92         }
  93
  94         LOG.debug("Received NodeConnector Remove Event: {}, {}", key, flowCapableNodeConnectorOld);
  95         NodeConnectorId nodeConnectorId = InstanceIdentifier.keyOf(key.firstIdentifierOf(NodeConnector.class))
  96             .getId();
  97         String portName = InterfaceManagerCommonUtils.getPortNameForInterface(nodeConnectorId,
  98             flowCapableNodeConnectorOld.getName());
  99
 100         remove(nodeConnectorId, null, flowCapableNodeConnectorOld, portName, true);
 101     }
 102
 103     private void remove(NodeConnectorId nodeConnectorIdNew, NodeConnectorId nodeConnectorIdOld,
 104             FlowCapableNodeConnector fcNodeConnectorNew, String portName, boolean isNetworkEvent) {
 105         boolean isNodePresent = InterfaceManagerCommonUtils.isNodePresent(dataBroker, nodeConnectorIdNew);
 106         DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
 107         InterfaceStateRemoveWorker portStateRemoveWorker = new InterfaceStateRemoveWorker(idManager, nodeConnectorIdNew,
 108                 nodeConnectorIdOld, fcNodeConnectorNew, portName, portName, isNodePresent, isNetworkEvent, true);
 109         coordinator.enqueueJob(portName, portStateRemoveWorker, IfmConstants.JOB_MAX_RETRIES);
 110     }
 111
 112     @Override
 113     protected void update(InstanceIdentifier<FlowCapableNodeConnector> key, FlowCapableNodeConnector fcNodeConnectorOld,
 114             FlowCapableNodeConnector fcNodeConnectorNew) {
 115         if (!IfmClusterUtils.isEntityOwner(IfmClusterUtils.INTERFACE_CONFIG_ENTITY)) {
 116             return;
 117         }
 118
 119         LOG.debug("Received NodeConnector Update Event: {}, {}, {}", key, fcNodeConnectorOld, fcNodeConnectorNew);
 120         NodeConnectorId nodeConnectorId = InstanceIdentifier.keyOf(key.firstIdentifierOf(NodeConnector.class))
 121             .getId();
 122         String portName = InterfaceManagerCommonUtils.getPortNameForInterface(nodeConnectorId,
 123             fcNodeConnectorNew.getName());
 124         DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
 125
 126         InterfaceStateUpdateWorker portStateUpdateWorker = new InterfaceStateUpdateWorker(key, fcNodeConnectorOld,
 127             fcNodeConnectorNew, portName);
 128         coordinator.enqueueJob(portName, portStateUpdateWorker, IfmConstants.JOB_MAX_RETRIES);
 129     }
 130
 131     @Override
 132     protected void add(InstanceIdentifier<FlowCapableNodeConnector> key, FlowCapableNodeConnector fcNodeConnectorNew) {
 133         if (!IfmClusterUtils.isEntityOwner(IfmClusterUtils.INTERFACE_CONFIG_ENTITY)) {
 134             return;
 135         }
 136
 137         LOG.debug("Received NodeConnector Add Event: {}, {}", key, fcNodeConnectorNew);
 138         NodeConnectorId nodeConnectorId = InstanceIdentifier.keyOf(key.firstIdentifierOf(NodeConnector.class))
 139             .getId();
 140         String portName = InterfaceManagerCommonUtils.getPortNameForInterface(nodeConnectorId,
 141             fcNodeConnectorNew.getName());
 142
 143         if (InterfaceManagerCommonUtils.isNovaPort(portName)) {
 144             NodeConnectorId nodeConnectorIdOld = IfmUtil.getNodeConnectorIdFromInterface(portName, dataBroker);
 145             if (nodeConnectorIdOld != null && !nodeConnectorId.equals(nodeConnectorIdOld)) {
 146                 BigInteger dpnIdOld = IfmUtil.getDpnFromNodeConnectorId(nodeConnectorIdOld);
 147                 BigInteger dpnIdNew = IfmUtil.getDpnFromNodeConnectorId(nodeConnectorId);
 148                 if (!Objects.equals(dpnIdOld, dpnIdNew)) {
 149                     if (fcNodeConnectorNew.getReason() != PortReason.Add) {
 150                         LOG.error("Dropping Port update event for {}, as DPN id is changed from {} to {}",
 151                             fcNodeConnectorNew.getName(), dpnIdOld, dpnIdNew);
 152                         return;
 153                     }
 154                 } else {
 155                     LOG.warn("Port number update detected for {}", fcNodeConnectorNew.getName());
 156                 }
 157                 //VM Migration or Port Number Update: Delete existing interface entry for older DPN
 158                 LOG.debug("Triggering NodeConnector Remove Event for the interface: {}, {}, {}", portName,
 159                     nodeConnectorId, nodeConnectorIdOld);
 160                 remove(nodeConnectorId, nodeConnectorIdOld, fcNodeConnectorNew, portName, false);
 161                 // Adding a delay of 10sec for VM migration, so applications will have sufficient time
 162                 // for processing remove before add
 163                 try {
 164                     Thread.sleep(IfmConstants.DELAY_TIME_IN_MILLISECOND);
 165                 } catch (InterruptedException e) {
 166                     LOG.error("Error while waiting for the vm migration remove events to get processed");
 167                 }
 168             }
 169         }
 170         DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
 171         InterfaceStateAddWorker ifStateAddWorker = new InterfaceStateAddWorker(idManager, nodeConnectorId,
 172             fcNodeConnectorNew, portName);
 173         coordinator.enqueueJob(portName, ifStateAddWorker, IfmConstants.JOB_MAX_RETRIES);
 174     }
 175
 176
 177     private class InterfaceStateAddWorker implements Callable {
 178         private final NodeConnectorId nodeConnectorId;
 179         private final FlowCapableNodeConnector fcNodeConnectorNew;
 180         private final String interfaceName;
 181         private final IdManagerService idManager;
 182
 183         InterfaceStateAddWorker(IdManagerService idManager, NodeConnectorId nodeConnectorId,
 184                 FlowCapableNodeConnector fcNodeConnectorNew, String portName) {
 185             this.nodeConnectorId = nodeConnectorId;
 186             this.fcNodeConnectorNew = fcNodeConnectorNew;
 187             this.interfaceName = portName;
 188             this.idManager = idManager;
 189         }
 190
 191         @Override
 192         public Object call() {
 193             List<ListenableFuture<Void>> futures = OvsInterfaceStateAddHelper.addState(dataBroker, idManager,
 194                     mdsalApiManager, alivenessMonitorService, nodeConnectorId, interfaceName, fcNodeConnectorNew);
 195             List<InterfaceChildEntry> interfaceChildEntries = getInterfaceChildEntries(dataBroker, interfaceName);
 196             for (InterfaceChildEntry interfaceChildEntry : interfaceChildEntries) {
 197                 InterfaceStateAddWorker interfaceStateAddWorker = new InterfaceStateAddWorker(idManager,
 198                         nodeConnectorId, fcNodeConnectorNew, interfaceChildEntry.getChildInterface());
 199                 DataStoreJobCoordinator.getInstance().enqueueJob(interfaceName, interfaceStateAddWorker);
 200             }
 201             return futures;
 202         }
 203
 204         @Override
 205         public String toString() {
 206             return "InterfaceStateAddWorker{" + "nodeConnectorId=" + nodeConnectorId + ", fcNodeConnectorNew="
 207                     + fcNodeConnectorNew + ", interfaceName='" + interfaceName + '\'' + '}';
 208         }
 209     }
 210
 211     private class InterfaceStateUpdateWorker implements Callable {
 212         private final InstanceIdentifier<FlowCapableNodeConnector> key;
 213         private final FlowCapableNodeConnector fcNodeConnectorOld;
 214         private final FlowCapableNodeConnector fcNodeConnectorNew;
 215         private final String interfaceName;
 216
 217         InterfaceStateUpdateWorker(InstanceIdentifier<FlowCapableNodeConnector> key,
 218                 FlowCapableNodeConnector fcNodeConnectorOld, FlowCapableNodeConnector fcNodeConnectorNew,
 219                 String portName) {
 220             this.key = key;
 221             this.fcNodeConnectorOld = fcNodeConnectorOld;
 222             this.fcNodeConnectorNew = fcNodeConnectorNew;
 223             this.interfaceName = portName;
 224         }
 225
 226         @Override
 227         public Object call() {
 228             List<ListenableFuture<Void>> futures = OvsInterfaceStateUpdateHelper.updateState(key,
 229                     alivenessMonitorService, dataBroker, interfaceName, fcNodeConnectorNew, fcNodeConnectorOld);
 230             List<InterfaceChildEntry> interfaceChildEntries = getInterfaceChildEntries(dataBroker, interfaceName);
 231             for (InterfaceChildEntry interfaceChildEntry : interfaceChildEntries) {
 232                 InterfaceStateUpdateWorker interfaceStateUpdateWorker = new InterfaceStateUpdateWorker(key,
 233                         fcNodeConnectorOld, fcNodeConnectorNew, interfaceChildEntry.getChildInterface());
 234                 DataStoreJobCoordinator.getInstance().enqueueJob(interfaceName, interfaceStateUpdateWorker);
 235             }
 236             return futures;
 237         }
 238
 239         @Override
 240         public String toString() {
 241             return "InterfaceStateUpdateWorker{" + "key=" + key + ", fcNodeConnectorOld=" + fcNodeConnectorOld
 242                     + ", fcNodeConnectorNew=" + fcNodeConnectorNew + ", interfaceName='" + interfaceName + '\'' + '}';
 243         }
 244     }
 245
 246     private class InterfaceStateRemoveWorker implements Callable {
 247         private final NodeConnectorId nodeConnectorIdNew;
 248         private NodeConnectorId nodeConnectorIdOld;
 249         FlowCapableNodeConnector fcNodeConnectorOld;
 250         private final String interfaceName;
 251         private final String parentInterface;
 252         private final IdManagerService idManager;
 253         private final boolean isNodePresent;
 254         private final boolean isNetworkEvent;
 255         private final boolean isParentInterface;
 256
 257         InterfaceStateRemoveWorker(IdManagerService idManager, NodeConnectorId nodeConnectorIdNew,
 258                 NodeConnectorId nodeConnectorIdOld, FlowCapableNodeConnector fcNodeConnectorOld, String interfaceName,
 259                 String parentInterface, boolean isNodePresent, boolean isNetworkEvent, boolean isParentInterface) {
 260             this.nodeConnectorIdNew = nodeConnectorIdNew;
 261             this.nodeConnectorIdOld = nodeConnectorIdOld;
 262             this.fcNodeConnectorOld = fcNodeConnectorOld;
 263             this.interfaceName = interfaceName;
 264             this.parentInterface = parentInterface;
 265             this.idManager = idManager;
 266             this.isNodePresent = isNodePresent;
 267             this.isNetworkEvent = isNetworkEvent;
 268             this.isParentInterface = isParentInterface;
 269         }
 270
 271         @Override
 272         public Object call() {
 273             List<ListenableFuture<Void>> futures = null;
 274             // VM Migration: Skip OFPPR_DELETE event received after OFPPR_ADD
 275             // for same interface from Older DPN
 276             if (isParentInterface && isNetworkEvent) {
 277                 nodeConnectorIdOld = IfmUtil.getNodeConnectorIdFromInterface(interfaceName, dataBroker);
 278                 if (nodeConnectorIdOld != null && !nodeConnectorIdNew.equals(nodeConnectorIdOld)) {
 279                     LOG.debug("Dropping the NodeConnector Remove Event for the interface: {}, {}, {}", interfaceName,
 280                             nodeConnectorIdNew, nodeConnectorIdOld);
 281                     return futures;
 282                 }
 283             }
 284
 285             futures = OvsInterfaceStateRemoveHelper.removeInterfaceStateConfiguration(idManager, mdsalApiManager,
 286                     alivenessMonitorService, nodeConnectorIdNew, nodeConnectorIdOld, dataBroker, interfaceName,
 287                     fcNodeConnectorOld, isNodePresent, parentInterface);
 288
 289             List<InterfaceChildEntry> interfaceChildEntries = getInterfaceChildEntries(dataBroker, interfaceName);
 290             for (InterfaceChildEntry interfaceChildEntry : interfaceChildEntries) {
 291                 // Fetch all interfaces on this port and trigger remove worker
 292                 // for each of them
 293                 InterfaceStateRemoveWorker interfaceStateRemoveWorker = new InterfaceStateRemoveWorker(idManager,
 294                         nodeConnectorIdNew, nodeConnectorIdOld, fcNodeConnectorOld,
 295                         interfaceChildEntry.getChildInterface(), interfaceName, isNodePresent, isNetworkEvent, false);
 296                 DataStoreJobCoordinator.getInstance().enqueueJob(interfaceName, interfaceStateRemoveWorker);
 297             }
 298             return futures;
 299         }
 300
 301         @Override
 302         public String toString() {
 303             return "InterfaceStateRemoveWorker{" + "nodeConnectorIdNew=" + nodeConnectorIdNew + ", nodeConnectorIdOld="
 304                     + nodeConnectorIdOld + ", fcNodeConnectorOld=" + fcNodeConnectorOld + ", interfaceName='"
 305                     + interfaceName + '\'' + '}';
 306         }
 307     }
 308
 309     public static List<InterfaceChildEntry> getInterfaceChildEntries(DataBroker dataBroker, String interfaceName) {
 310         InterfaceParentEntry interfaceParentEntry = InterfaceMetaUtils
 311                 .getInterfaceParentEntryFromConfigDS(interfaceName, dataBroker);
 312         if (interfaceParentEntry != null && interfaceParentEntry.getInterfaceChildEntry() != null) {
 313             return interfaceParentEntry.getInterfaceChildEntry();
 314         }
 315         return new ArrayList<>();
 316     }
 317 }