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