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