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.AsyncDataTreeChangeListenerBase;
  13 import org.opendaylight.genius.datastoreutils.DataStoreJobCoordinator;
  14 import org.opendaylight.genius.interfacemanager.IfmUtil;
  15 import org.opendaylight.genius.interfacemanager.commons.InterfaceMetaUtils;
  16 import org.opendaylight.genius.interfacemanager.renderer.ovs.statehelpers.OvsInterfaceStateAddHelper;
  17 import org.opendaylight.genius.interfacemanager.renderer.ovs.statehelpers.OvsInterfaceStateRemoveHelper;
  18 import org.opendaylight.genius.interfacemanager.renderer.ovs.statehelpers.OvsInterfaceStateUpdateHelper;
  19 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.AlivenessMonitorService;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._interface.child.info.InterfaceParentEntry;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._interface.child.info._interface.parent.entry.InterfaceChildEntry;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  29 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32
  33 import java.util.ArrayList;
  34 import java.util.List;
  35 import java.util.concurrent.Callable;
  36
  37 /**
  38  *
  39  * This Class is a Data Change Listener for FlowCapableNodeConnector updates.
  40  * This creates an entry in the interface-state OperDS for every node-connector used.
  41  *
  42  * NOTE: This class just creates an ifstate entry whose interface-name will be the same as the node-connector portname.
  43  * If PortName is not unique across DPNs, this implementation can have problems.
  44  */
  45
  46 public class InterfaceInventoryStateListener extends AsyncDataTreeChangeListenerBase<FlowCapableNodeConnector, InterfaceInventoryStateListener> {
  47     private static final Logger LOG = LoggerFactory.getLogger(InterfaceInventoryStateListener.class);
  48     private DataBroker dataBroker;
  49     private IdManagerService idManager;
  50     private IMdsalApiManager mdsalApiManager;
  51     private AlivenessMonitorService alivenessMonitorService;
  52
  53     public InterfaceInventoryStateListener(final DataBroker dataBroker, final IdManagerService idManager,
  54                                            final IMdsalApiManager mdsalApiManager, final AlivenessMonitorService alivenessMonitorService) {
  55         super(FlowCapableNodeConnector.class, InterfaceInventoryStateListener.class);
  56         this.dataBroker = dataBroker;
  57         this.idManager = idManager;
  58         this.mdsalApiManager = mdsalApiManager;
  59         this.alivenessMonitorService = alivenessMonitorService;
  60     }
  61
  62     @Override
  63     protected InstanceIdentifier<FlowCapableNodeConnector> getWildCardPath() {
  64         return InstanceIdentifier.create(Nodes.class).child(Node.class).child(NodeConnector.class)
  65                 .augmentation(FlowCapableNodeConnector.class);
  66     }
  67
  68     @Override
  69     protected InterfaceInventoryStateListener getDataTreeChangeListener() {
  70         return InterfaceInventoryStateListener.this;
  71     }
  72
  73     @Override
  74     protected void remove(InstanceIdentifier<FlowCapableNodeConnector> key,
  75                           FlowCapableNodeConnector flowCapableNodeConnectorOld) {
  76         LOG.debug("Received NodeConnector Remove Event: {}, {}", key, flowCapableNodeConnectorOld);
  77         remove(key, flowCapableNodeConnectorOld, true);
  78     }
  79
  80     @Override
  81     protected void update(InstanceIdentifier<FlowCapableNodeConnector> key, FlowCapableNodeConnector fcNodeConnectorOld,
  82                           FlowCapableNodeConnector fcNodeConnectorNew) {
  83         LOG.debug("Received NodeConnector Update Event: {}, {}, {}", key, fcNodeConnectorOld, fcNodeConnectorNew);
  84         String portName = fcNodeConnectorNew.getName();
  85         DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
  86
  87         InterfaceStateUpdateWorker portStateUpdateWorker = new InterfaceStateUpdateWorker(key, fcNodeConnectorOld,
  88                 fcNodeConnectorNew, portName);
  89         coordinator.enqueueJob(portName, portStateUpdateWorker);
  90     }
  91
  92     @Override
  93     protected void add(InstanceIdentifier<FlowCapableNodeConnector> key, FlowCapableNodeConnector fcNodeConnectorNew) {
  94         LOG.debug("Received NodeConnector Add Event: {}, {}", key, fcNodeConnectorNew);
  95         //VM Migration: Delete existing interface entry for older DPN
  96         remove(key, fcNodeConnectorNew, false);
  97         String portName = fcNodeConnectorNew.getName();
  98         NodeConnectorId nodeConnectorId = InstanceIdentifier.keyOf(key.firstIdentifierOf(NodeConnector.class)).getId();
  99         DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
 100
 101         InterfaceStateAddWorker ifStateAddWorker = new InterfaceStateAddWorker(idManager, nodeConnectorId,
 102                 fcNodeConnectorNew, portName);
 103         coordinator.enqueueJob(portName, ifStateAddWorker);
 104     }
 105
 106     /**
 107      * VM Migration: VM migrated from DPN1 to DPN2.
 108      * VM booted from new DPN host will preserves its configuration including ID, name and other properties.
 109      * In certain vm migration scenario like nova evacuate, vm reboot
 110      * it is expected to receive the events in a non-sequential manner
 111      * In Nova evacuate scenario, OFPPR_ADD from DPN2 will be received before OFPPR_DELETE from DPN1.
 112      * To cleanup existing entry in OperDS, remove method will be called from add()
 113      *
 114      */
 115     private void remove(InstanceIdentifier<FlowCapableNodeConnector> key,
 116                         FlowCapableNodeConnector flowCapableNodeConnectorOld, boolean isNwTrigger) {
 117         LOG.debug("Received user/network NodeConnector Remove Event: {}, {}", key, flowCapableNodeConnectorOld);
 118         String portName = flowCapableNodeConnectorOld.getName();
 119         NodeConnectorId nodeConnectorIdNew = InstanceIdentifier.keyOf(key.firstIdentifierOf(NodeConnector.class)).getId();
 120
 121         //VM Migration: Skip OFPPR_DELETE event received after OFPPR_ADD for same interface
 122         NodeConnectorId nodeConnectorIdOld = IfmUtil.getNodeConnectorIdFromInterface(portName, dataBroker);
 123         if(nodeConnectorIdOld != null && !nodeConnectorIdNew.equals(nodeConnectorIdOld)) {
 124             if(isNwTrigger) {
 125                 LOG.info("Received NodeConnector Remove Event for the interface exists in another DPN: {}, {}", nodeConnectorIdNew, nodeConnectorIdOld);
 126                 return;
 127             }
 128         }
 129
 130         DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
 131
 132         InterfaceStateRemoveWorker portStateRemoveWorker = new InterfaceStateRemoveWorker(idManager,
 133                 nodeConnectorIdNew, nodeConnectorIdOld, flowCapableNodeConnectorOld, portName);
 134         coordinator.enqueueJob(portName, portStateRemoveWorker);
 135     }
 136
 137     private class InterfaceStateAddWorker implements Callable {
 138         private final NodeConnectorId nodeConnectorId;
 139         private final FlowCapableNodeConnector fcNodeConnectorNew;
 140         private final String interfaceName;
 141         private final IdManagerService idManager;
 142
 143         public InterfaceStateAddWorker(IdManagerService idManager, NodeConnectorId nodeConnectorId,
 144                                        FlowCapableNodeConnector fcNodeConnectorNew,
 145                                        String portName) {
 146             this.nodeConnectorId = nodeConnectorId;
 147             this.fcNodeConnectorNew = fcNodeConnectorNew;
 148             this.interfaceName = portName;
 149             this.idManager = idManager;
 150         }
 151
 152         @Override
 153         public Object call() throws Exception {
 154             // If another renderer(for eg : CSS) needs to be supported, check can be performed here
 155             // to call the respective helpers.
 156             List<ListenableFuture<Void>> futures = OvsInterfaceStateAddHelper.addState(dataBroker, idManager, mdsalApiManager, alivenessMonitorService, nodeConnectorId,
 157                     interfaceName, fcNodeConnectorNew);
 158             List<InterfaceChildEntry> interfaceChildEntries = getInterfaceChildEntries(dataBroker, interfaceName);
 159             for (InterfaceChildEntry interfaceChildEntry : interfaceChildEntries) {
 160                 InterfaceStateAddWorker interfaceStateAddWorker = new InterfaceStateAddWorker(idManager, nodeConnectorId,
 161                         fcNodeConnectorNew, interfaceChildEntry.getChildInterface());
 162                 DataStoreJobCoordinator.getInstance().enqueueJob(interfaceName, interfaceStateAddWorker);
 163             }
 164             return futures;
 165         }
 166
 167         @Override
 168         public String toString() {
 169             return "InterfaceStateAddWorker{" +
 170                     "nodeConnectorId=" + nodeConnectorId +
 171                     ", fcNodeConnectorNew=" + fcNodeConnectorNew +
 172                     ", interfaceName='" + interfaceName + '\'' +
 173                     '}';
 174         }
 175     }
 176
 177     private class InterfaceStateUpdateWorker implements Callable {
 178         private InstanceIdentifier<FlowCapableNodeConnector> key;
 179         private final FlowCapableNodeConnector fcNodeConnectorOld;
 180         private final FlowCapableNodeConnector fcNodeConnectorNew;
 181         private String interfaceName;
 182
 183
 184         public InterfaceStateUpdateWorker(InstanceIdentifier<FlowCapableNodeConnector> key,
 185                                           FlowCapableNodeConnector fcNodeConnectorOld,
 186                                           FlowCapableNodeConnector fcNodeConnectorNew,
 187                                           String portName) {
 188             this.key = key;
 189             this.fcNodeConnectorOld = fcNodeConnectorOld;
 190             this.fcNodeConnectorNew = fcNodeConnectorNew;
 191             this.interfaceName = portName;
 192         }
 193
 194         @Override
 195         public Object call() throws Exception {
 196             // If another renderer(for eg : CSS) needs to be supported, check can be performed here
 197             // to call the respective helpers.
 198             List<ListenableFuture<Void>> futures = OvsInterfaceStateUpdateHelper.updateState(key, alivenessMonitorService, dataBroker, interfaceName,
 199                     fcNodeConnectorNew, fcNodeConnectorOld);
 200             List<InterfaceChildEntry> interfaceChildEntries = getInterfaceChildEntries(dataBroker, interfaceName);
 201             for (InterfaceChildEntry interfaceChildEntry : interfaceChildEntries) {
 202                 InterfaceStateUpdateWorker interfaceStateUpdateWorker = new InterfaceStateUpdateWorker(key, fcNodeConnectorOld,
 203                         fcNodeConnectorNew, interfaceChildEntry.getChildInterface());
 204                 DataStoreJobCoordinator.getInstance().enqueueJob(interfaceName, interfaceStateUpdateWorker);
 205             }
 206             return futures;
 207         }
 208
 209         @Override
 210         public String toString() {
 211             return "InterfaceStateUpdateWorker{" +
 212                     "key=" + key +
 213                     ", fcNodeConnectorOld=" + fcNodeConnectorOld +
 214                     ", fcNodeConnectorNew=" + fcNodeConnectorNew +
 215                     ", interfaceName='" + interfaceName + '\'' +
 216                     '}';
 217         }
 218     }
 219
 220     private class InterfaceStateRemoveWorker implements Callable {
 221         private final NodeConnectorId nodeConnectorIdNew;
 222         private final NodeConnectorId nodeConnectorIdOld;
 223         FlowCapableNodeConnector fcNodeConnectorOld;
 224         private final String interfaceName;
 225         private final IdManagerService idManager;
 226
 227         public InterfaceStateRemoveWorker(IdManagerService idManager, NodeConnectorId nodeConnectorIdNew,
 228                                           NodeConnectorId nodeConnectorIdOld,
 229                                           FlowCapableNodeConnector fcNodeConnectorOld,
 230                                           String portName) {
 231             this.nodeConnectorIdNew = nodeConnectorIdNew;
 232             this.nodeConnectorIdOld = nodeConnectorIdOld;
 233             this.fcNodeConnectorOld = fcNodeConnectorOld;
 234             this.interfaceName = portName;
 235             this.idManager = idManager;
 236         }
 237
 238         @Override
 239         public Object call() throws Exception {
 240             // If another renderer(for eg : CSS) needs to be supported, check can be performed here
 241             // to call the respective helpers.
 242             List<ListenableFuture<Void>> futures = OvsInterfaceStateRemoveHelper.removeInterfaceStateConfiguration(idManager, mdsalApiManager, alivenessMonitorService,
 243                     nodeConnectorIdNew, nodeConnectorIdOld, dataBroker, interfaceName, fcNodeConnectorOld);
 244
 245             List<InterfaceChildEntry> interfaceChildEntries = getInterfaceChildEntries(dataBroker, interfaceName);
 246             for (InterfaceChildEntry interfaceChildEntry : interfaceChildEntries) {
 247                 // Fetch all interfaces on this port and trigger remove worker for each of them
 248                 InterfaceStateRemoveWorker interfaceStateRemoveWorker = new InterfaceStateRemoveWorker(idManager,
 249                         nodeConnectorIdNew, nodeConnectorIdOld, fcNodeConnectorOld, interfaceChildEntry.getChildInterface());
 250                 DataStoreJobCoordinator.getInstance().enqueueJob(interfaceName, interfaceStateRemoveWorker);
 251
 252             }
 253             return futures;
 254         }
 255
 256         @Override
 257         public String toString() {
 258             return "InterfaceStateRemoveWorker{" +
 259                     "nodeConnectorIdNew=" + nodeConnectorIdNew +
 260                     ", nodeConnectorIdOld=" + nodeConnectorIdOld +
 261                     ", fcNodeConnectorOld=" + fcNodeConnectorOld +
 262                     ", interfaceName='" + interfaceName + '\'' +
 263                     '}';
 264         }
 265     }
 266
 267     public static List<InterfaceChildEntry> getInterfaceChildEntries(DataBroker dataBroker, String interfaceName) {
 268         InterfaceParentEntry interfaceParentEntry =
 269                 InterfaceMetaUtils.getInterfaceParentEntryFromConfigDS(interfaceName, dataBroker);
 270         if (interfaceParentEntry != null && interfaceParentEntry.getInterfaceChildEntry() != null) {
 271             return interfaceParentEntry.getInterfaceChildEntry();
 272         }
 273         return new ArrayList<>();
 274     }
 275 }