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                 if (!InterfaceManagerCommonUtils.isNovaOrTunnelPort(portName)) {
  90                     portName = getDpnPrefixedPortName(nodeConnectorId, portName);
  91                 }
  92                 remove(nodeConnectorId, null, flowCapableNodeConnectorOld, portName, true);
  93             }
  94         });
  95     }
  96
  97     @Override
  98     protected void update(InstanceIdentifier<FlowCapableNodeConnector> key, FlowCapableNodeConnector fcNodeConnectorOld,
  99                           FlowCapableNodeConnector fcNodeConnectorNew) {
 100         IfmClusterUtils.runOnlyInLeaderNode(new Runnable() {
 101             @Override
 102             public void run() {
 103                 LOG.debug("Received NodeConnector Update Event: {}, {}, {}", key, fcNodeConnectorOld, fcNodeConnectorNew);
 104                 String portName = fcNodeConnectorNew.getName();
 105                 DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
 106
 107                 InterfaceStateUpdateWorker portStateUpdateWorker = new InterfaceStateUpdateWorker(key, fcNodeConnectorOld,
 108                         fcNodeConnectorNew, portName);
 109                 coordinator.enqueueJob(portName, portStateUpdateWorker, IfmConstants.JOB_MAX_RETRIES);
 110             }
 111         });
 112     }
 113
 114     @Override
 115     protected void add(InstanceIdentifier<FlowCapableNodeConnector> key, FlowCapableNodeConnector fcNodeConnectorNew) {
 116         IfmClusterUtils.runOnlyInLeaderNode(new Runnable() {
 117             @Override
 118             public void run() {
 119                 LOG.debug("Received NodeConnector Add Event: {}, {}", key, fcNodeConnectorNew);
 120                 String portName = fcNodeConnectorNew.getName();
 121                 NodeConnectorId nodeConnectorId = InstanceIdentifier.keyOf(key.firstIdentifierOf(NodeConnector.class)).getId();
 122
 123                 //VM Migration: Delete existing interface entry for older DPN
 124                 if (InterfaceManagerCommonUtils.isNovaOrTunnelPort(portName)) {
 125                     NodeConnectorId nodeConnectorIdOld = IfmUtil.getNodeConnectorIdFromInterface(portName, dataBroker);
 126                     if (nodeConnectorIdOld != null && !nodeConnectorId.equals(nodeConnectorIdOld)) {
 127                         LOG.debug("Triggering NodeConnector Remove Event for the interface: {}, {}, {}", portName, nodeConnectorId, nodeConnectorIdOld);
 128                         remove(nodeConnectorId, nodeConnectorIdOld, fcNodeConnectorNew, portName, false);
 129                         //Adding a delay of 10sec for VM migration, so applications can process remove and add events
 130                         try {
 131                             Thread.sleep(IfmConstants.DELAY_TIME_IN_MILLISECOND);
 132                         } catch (InterruptedException e) {
 133                             LOG.error("Error while waiting for the vm migration remove events to get processed");
 134                         }
 135                     }
 136                 } else {
 137                     portName = getDpnPrefixedPortName(nodeConnectorId, portName);
 138                 }
 139                 DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
 140                 InterfaceStateAddWorker ifStateAddWorker = new InterfaceStateAddWorker(idManager, nodeConnectorId,
 141                         fcNodeConnectorNew, portName);
 142                 coordinator.enqueueJob(portName, ifStateAddWorker, IfmConstants.JOB_MAX_RETRIES);
 143             }
 144         });
 145     }
 146
 147     private void remove(NodeConnectorId nodeConnectorIdNew, NodeConnectorId nodeConnectorIdOld,
 148                         FlowCapableNodeConnector fcNodeConnectorNew, String portName, boolean isNetworkEvent) {
 149         boolean isNodePresent = InterfaceManagerCommonUtils.isNodePresent(dataBroker, nodeConnectorIdNew);
 150         DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
 151         InterfaceStateRemoveWorker portStateRemoveWorker = new InterfaceStateRemoveWorker(idManager, nodeConnectorIdNew,
 152                 nodeConnectorIdOld, fcNodeConnectorNew, portName, isNodePresent, isNetworkEvent, true);
 153         coordinator.enqueueJob(portName, portStateRemoveWorker, IfmConstants.JOB_MAX_RETRIES);
 154     }
 155
 156     private String getDpnPrefixedPortName(NodeConnectorId nodeConnectorId, String portName) {
 157         portName = new StringBuilder(
 158                 (IfmUtil.getDpnFromNodeConnectorId(nodeConnectorId)).toString())
 159                         .append(IfmConstants.OF_URI_SEPARATOR)
 160                         .append(portName).toString();
 161         return portName;
 162     }
 163     private class InterfaceStateAddWorker implements Callable {
 164         private final NodeConnectorId nodeConnectorId;
 165         private final FlowCapableNodeConnector fcNodeConnectorNew;
 166         private final String interfaceName;
 167         private final IdManagerService idManager;
 168
 169         public InterfaceStateAddWorker(IdManagerService idManager, NodeConnectorId nodeConnectorId,
 170                                        FlowCapableNodeConnector fcNodeConnectorNew,
 171                                        String portName) {
 172             this.nodeConnectorId = nodeConnectorId;
 173             this.fcNodeConnectorNew = fcNodeConnectorNew;
 174             this.interfaceName = portName;
 175             this.idManager = idManager;
 176         }
 177
 178         @Override
 179         public Object call() throws Exception {
 180             // If another renderer(for eg : CSS) needs to be supported, check can be performed here
 181             // to call the respective helpers.
 182             List<ListenableFuture<Void>> futures = OvsInterfaceStateAddHelper.addState(dataBroker, idManager, mdsalApiManager, alivenessMonitorService, nodeConnectorId,
 183                     interfaceName, fcNodeConnectorNew);
 184             List<InterfaceChildEntry> interfaceChildEntries = getInterfaceChildEntries(dataBroker, interfaceName);
 185             for (InterfaceChildEntry interfaceChildEntry : interfaceChildEntries) {
 186                 InterfaceStateAddWorker interfaceStateAddWorker = new InterfaceStateAddWorker(idManager, nodeConnectorId,
 187                         fcNodeConnectorNew, interfaceChildEntry.getChildInterface());
 188                 DataStoreJobCoordinator.getInstance().enqueueJob(interfaceName, interfaceStateAddWorker);
 189             }
 190             return futures;
 191         }
 192
 193         @Override
 194         public String toString() {
 195             return "InterfaceStateAddWorker{" +
 196                     "nodeConnectorId=" + nodeConnectorId +
 197                     ", fcNodeConnectorNew=" + fcNodeConnectorNew +
 198                     ", interfaceName='" + interfaceName + '\'' +
 199                     '}';
 200         }
 201     }
 202
 203     private class InterfaceStateUpdateWorker implements Callable {
 204         private InstanceIdentifier<FlowCapableNodeConnector> key;
 205         private final FlowCapableNodeConnector fcNodeConnectorOld;
 206         private final FlowCapableNodeConnector fcNodeConnectorNew;
 207         private String interfaceName;
 208
 209
 210         public InterfaceStateUpdateWorker(InstanceIdentifier<FlowCapableNodeConnector> key,
 211                                           FlowCapableNodeConnector fcNodeConnectorOld,
 212                                           FlowCapableNodeConnector fcNodeConnectorNew,
 213                                           String portName) {
 214             this.key = key;
 215             this.fcNodeConnectorOld = fcNodeConnectorOld;
 216             this.fcNodeConnectorNew = fcNodeConnectorNew;
 217             this.interfaceName = portName;
 218         }
 219
 220         @Override
 221         public Object call() throws Exception {
 222             // If another renderer(for eg : CSS) needs to be supported, check can be performed here
 223             // to call the respective helpers.
 224             List<ListenableFuture<Void>> futures = OvsInterfaceStateUpdateHelper.updateState(key, alivenessMonitorService, dataBroker, interfaceName,
 225                     fcNodeConnectorNew, fcNodeConnectorOld);
 226             List<InterfaceChildEntry> interfaceChildEntries = getInterfaceChildEntries(dataBroker, interfaceName);
 227             for (InterfaceChildEntry interfaceChildEntry : interfaceChildEntries) {
 228                 InterfaceStateUpdateWorker interfaceStateUpdateWorker = new InterfaceStateUpdateWorker(key, fcNodeConnectorOld,
 229                         fcNodeConnectorNew, interfaceChildEntry.getChildInterface());
 230                 DataStoreJobCoordinator.getInstance().enqueueJob(interfaceName, interfaceStateUpdateWorker);
 231             }
 232             return futures;
 233         }
 234
 235         @Override
 236         public String toString() {
 237             return "InterfaceStateUpdateWorker{" +
 238                     "key=" + key +
 239                     ", fcNodeConnectorOld=" + fcNodeConnectorOld +
 240                     ", fcNodeConnectorNew=" + fcNodeConnectorNew +
 241                     ", interfaceName='" + interfaceName + '\'' +
 242                     '}';
 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 IdManagerService idManager;
 252         private final boolean isNodePresent;
 253         private final boolean isNetworkEvent;
 254         private final boolean isParentInterface;
 255
 256         public InterfaceStateRemoveWorker(IdManagerService idManager, NodeConnectorId nodeConnectorIdNew,
 257                                           NodeConnectorId nodeConnectorIdOld,
 258                                           FlowCapableNodeConnector fcNodeConnectorOld,
 259                                           String portName,
 260                                           boolean isNodePresent,
 261                                           boolean isNetworkEvent,
 262                                           boolean isParentInterface) {
 263             this.nodeConnectorIdNew = nodeConnectorIdNew;
 264             this.nodeConnectorIdOld = nodeConnectorIdOld;
 265             this.fcNodeConnectorOld = fcNodeConnectorOld;
 266             this.interfaceName = portName;
 267             this.idManager = idManager;
 268             this.isNodePresent = isNodePresent;
 269             this.isNetworkEvent = isNetworkEvent;
 270             this.isParentInterface = isParentInterface;
 271         }
 272
 273         @Override
 274         public Object call() throws Exception {
 275             // If another renderer(for eg : CSS) needs to be supported, check can be performed here
 276             // to call the respective helpers.
 277
 278             List<ListenableFuture<Void>> futures = null;
 279             //VM Migration: Skip OFPPR_DELETE event received after OFPPR_ADD for same interface from Older DPN
 280             if (isParentInterface && isNetworkEvent) {
 281                 nodeConnectorIdOld = IfmUtil.getNodeConnectorIdFromInterface(interfaceName, dataBroker);
 282                 if(nodeConnectorIdOld != null && !nodeConnectorIdNew.equals(nodeConnectorIdOld)) {
 283                     LOG.debug("Dropping the NodeConnector Remove Event for the interface: {}, {}, {}", interfaceName, nodeConnectorIdNew, nodeConnectorIdOld);
 284                     return futures;
 285                 }
 286             }
 287
 288             futures = OvsInterfaceStateRemoveHelper.removeInterfaceStateConfiguration(idManager, mdsalApiManager, alivenessMonitorService,
 289                     nodeConnectorIdNew, nodeConnectorIdOld, dataBroker, interfaceName, fcNodeConnectorOld, isNodePresent);
 290
 291             List<InterfaceChildEntry> interfaceChildEntries = getInterfaceChildEntries(dataBroker, interfaceName);
 292             for (InterfaceChildEntry interfaceChildEntry : interfaceChildEntries) {
 293                 // Fetch all interfaces on this port and trigger remove worker for each of them
 294                 InterfaceStateRemoveWorker interfaceStateRemoveWorker = new InterfaceStateRemoveWorker(idManager, nodeConnectorIdNew,
 295                         nodeConnectorIdOld, fcNodeConnectorOld, interfaceChildEntry.getChildInterface(), isNodePresent, isNetworkEvent, false);
 296                 DataStoreJobCoordinator.getInstance().enqueueJob(interfaceName, interfaceStateRemoveWorker);
 297             }
 298             return futures;
 299         }
 300
 301         @Override
 302         public String toString() {
 303             return "InterfaceStateRemoveWorker{" +
 304                     "nodeConnectorIdNew=" + nodeConnectorIdNew +
 305                     ", nodeConnectorIdOld=" + nodeConnectorIdOld +
 306                     ", fcNodeConnectorOld=" + fcNodeConnectorOld +
 307                     ", interfaceName='" + interfaceName + '\'' +
 308                     '}';
 309         }
 310     }
 311
 312     public static List<InterfaceChildEntry> getInterfaceChildEntries(DataBroker dataBroker, String interfaceName) {
 313         InterfaceParentEntry interfaceParentEntry =
 314                 InterfaceMetaUtils.getInterfaceParentEntryFromConfigDS(interfaceName, dataBroker);
 315         if (interfaceParentEntry != null && interfaceParentEntry.getInterfaceChildEntry() != null) {
 316             return interfaceParentEntry.getInterfaceChildEntry();
 317         }
 318         return new ArrayList<>();
 319     }
 320 }