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