/*
* Copyright (c) 2016, 2017 Ericsson India Global Services Pvt Ltd. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.genius.interfacemanager.listeners;
import com.google.common.util.concurrent.ListenableFuture;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Callable;
import javax.inject.Inject;
import javax.inject.Singleton;
import org.opendaylight.controller.md.sal.binding.api.DataBroker;
import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
import org.opendaylight.genius.datastoreutils.AsyncClusteredDataTreeChangeListenerBase;
import org.opendaylight.genius.datastoreutils.DataStoreJobCoordinator;
import org.opendaylight.genius.interfacemanager.IfmConstants;
import org.opendaylight.genius.interfacemanager.IfmUtil;
import org.opendaylight.genius.interfacemanager.commons.InterfaceManagerCommonUtils;
import org.opendaylight.genius.interfacemanager.commons.InterfaceMetaUtils;
import org.opendaylight.genius.interfacemanager.renderer.ovs.statehelpers.OvsInterfaceStateAddHelper;
import org.opendaylight.genius.interfacemanager.renderer.ovs.statehelpers.OvsInterfaceStateRemoveHelper;
import org.opendaylight.genius.interfacemanager.renderer.ovs.statehelpers.OvsInterfaceStateUpdateHelper;
import org.opendaylight.genius.interfacemanager.renderer.ovs.utilities.IfmClusterUtils;
import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.AlivenessMonitorService;
import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._interface.child.info.InterfaceParentEntry;
import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._interface.child.info._interface.parent.entry.InterfaceChildEntry;
import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* This Class is a Data Change Listener for FlowCapableNodeConnector updates.
* This creates an entry in the interface-state OperDS for every node-connector
* used.
*
*
* NOTE: This class just creates an ifstate entry whose interface-name will be
* the same as the node-connector portname. If PortName is not unique across
* DPNs, this implementation can have problems.
*/
@Singleton
public class InterfaceInventoryStateListener
extends AsyncClusteredDataTreeChangeListenerBase {
private static final Logger LOG = LoggerFactory.getLogger(InterfaceInventoryStateListener.class);
private final DataBroker dataBroker;
private final IdManagerService idManager;
private final IMdsalApiManager mdsalApiManager;
private final AlivenessMonitorService alivenessMonitorService;
@Inject
public InterfaceInventoryStateListener(final DataBroker dataBroker, final IdManagerService idManagerService,
final IMdsalApiManager mdsalApiManager, final AlivenessMonitorService alivenessMonitorService) {
super(FlowCapableNodeConnector.class, InterfaceInventoryStateListener.class);
this.dataBroker = dataBroker;
this.idManager = idManagerService;
this.mdsalApiManager = mdsalApiManager;
this.alivenessMonitorService = alivenessMonitorService;
this.registerListener(LogicalDatastoreType.OPERATIONAL, dataBroker);
}
@Override
protected InstanceIdentifier getWildCardPath() {
return InstanceIdentifier.create(Nodes.class).child(Node.class).child(NodeConnector.class)
.augmentation(FlowCapableNodeConnector.class);
}
@Override
protected InterfaceInventoryStateListener getDataTreeChangeListener() {
return InterfaceInventoryStateListener.this;
}
@Override
protected void remove(InstanceIdentifier key,
FlowCapableNodeConnector flowCapableNodeConnectorOld) {
if (!IfmClusterUtils.isEntityOwner(IfmClusterUtils.INTERFACE_CONFIG_ENTITY)) {
return;
}
LOG.debug("Received NodeConnector Remove Event: {}, {}", key, flowCapableNodeConnectorOld);
NodeConnectorId nodeConnectorId = InstanceIdentifier.keyOf(key.firstIdentifierOf(NodeConnector.class))
.getId();
String portName = InterfaceManagerCommonUtils.getPortNameForInterface(nodeConnectorId,
flowCapableNodeConnectorOld.getName());
remove(nodeConnectorId, null, flowCapableNodeConnectorOld, portName, true);
}
private void remove(NodeConnectorId nodeConnectorIdNew, NodeConnectorId nodeConnectorIdOld,
FlowCapableNodeConnector fcNodeConnectorNew, String portName, boolean isNetworkEvent) {
boolean isNodePresent = InterfaceManagerCommonUtils.isNodePresent(dataBroker, nodeConnectorIdNew);
DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
InterfaceStateRemoveWorker portStateRemoveWorker = new InterfaceStateRemoveWorker(idManager, nodeConnectorIdNew,
nodeConnectorIdOld, fcNodeConnectorNew, portName, portName, isNodePresent, isNetworkEvent, true);
coordinator.enqueueJob(portName, portStateRemoveWorker, IfmConstants.JOB_MAX_RETRIES);
}
@Override
protected void update(InstanceIdentifier key, FlowCapableNodeConnector fcNodeConnectorOld,
FlowCapableNodeConnector fcNodeConnectorNew) {
if (!IfmClusterUtils.isEntityOwner(IfmClusterUtils.INTERFACE_CONFIG_ENTITY)) {
return;
}
LOG.debug("Received NodeConnector Update Event: {}, {}, {}", key, fcNodeConnectorOld, fcNodeConnectorNew);
NodeConnectorId nodeConnectorId = InstanceIdentifier.keyOf(key.firstIdentifierOf(NodeConnector.class))
.getId();
String portName = InterfaceManagerCommonUtils.getPortNameForInterface(nodeConnectorId,
fcNodeConnectorNew.getName());
DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
InterfaceStateUpdateWorker portStateUpdateWorker = new InterfaceStateUpdateWorker(key, fcNodeConnectorOld,
fcNodeConnectorNew, portName);
coordinator.enqueueJob(portName, portStateUpdateWorker, IfmConstants.JOB_MAX_RETRIES);
}
@Override
protected void add(InstanceIdentifier key, FlowCapableNodeConnector fcNodeConnectorNew) {
if (!IfmClusterUtils.isEntityOwner(IfmClusterUtils.INTERFACE_CONFIG_ENTITY)) {
return;
}
LOG.debug("Received NodeConnector Add Event: {}, {}", key, fcNodeConnectorNew);
NodeConnectorId nodeConnectorId = InstanceIdentifier.keyOf(key.firstIdentifierOf(NodeConnector.class))
.getId();
String portName = InterfaceManagerCommonUtils.getPortNameForInterface(nodeConnectorId,
fcNodeConnectorNew.getName());
// VM Migration: Delete existing interface entry for older DPN
if (InterfaceManagerCommonUtils.isNovaPort(portName)) {
NodeConnectorId nodeConnectorIdOld = IfmUtil.getNodeConnectorIdFromInterface(portName, dataBroker);
if (nodeConnectorIdOld != null && !nodeConnectorId.equals(nodeConnectorIdOld)) {
LOG.debug("Triggering NodeConnector Remove Event for the interface: {}, {}, {}", portName,
nodeConnectorId, nodeConnectorIdOld);
remove(nodeConnectorId, nodeConnectorIdOld, fcNodeConnectorNew, portName, false);
// Adding a delay of 10sec for VM migration, so applications
// can process remove and add events
try {
Thread.sleep(IfmConstants.DELAY_TIME_IN_MILLISECOND);
} catch (InterruptedException e) {
LOG.error("Error while waiting for the vm migration remove events to get processed");
}
}
}
DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
InterfaceStateAddWorker ifStateAddWorker = new InterfaceStateAddWorker(idManager, nodeConnectorId,
fcNodeConnectorNew, portName);
coordinator.enqueueJob(portName, ifStateAddWorker, IfmConstants.JOB_MAX_RETRIES);
}
private class InterfaceStateAddWorker implements Callable {
private final NodeConnectorId nodeConnectorId;
private final FlowCapableNodeConnector fcNodeConnectorNew;
private final String interfaceName;
private final IdManagerService idManager;
InterfaceStateAddWorker(IdManagerService idManager, NodeConnectorId nodeConnectorId,
FlowCapableNodeConnector fcNodeConnectorNew, String portName) {
this.nodeConnectorId = nodeConnectorId;
this.fcNodeConnectorNew = fcNodeConnectorNew;
this.interfaceName = portName;
this.idManager = idManager;
}
@Override
public Object call() {
List> futures = OvsInterfaceStateAddHelper.addState(dataBroker, idManager,
mdsalApiManager, alivenessMonitorService, nodeConnectorId, interfaceName, fcNodeConnectorNew);
List interfaceChildEntries = getInterfaceChildEntries(dataBroker, interfaceName);
for (InterfaceChildEntry interfaceChildEntry : interfaceChildEntries) {
InterfaceStateAddWorker interfaceStateAddWorker = new InterfaceStateAddWorker(idManager,
nodeConnectorId, fcNodeConnectorNew, interfaceChildEntry.getChildInterface());
DataStoreJobCoordinator.getInstance().enqueueJob(interfaceName, interfaceStateAddWorker);
}
return futures;
}
@Override
public String toString() {
return "InterfaceStateAddWorker{" + "nodeConnectorId=" + nodeConnectorId + ", fcNodeConnectorNew="
+ fcNodeConnectorNew + ", interfaceName='" + interfaceName + '\'' + '}';
}
}
private class InterfaceStateUpdateWorker implements Callable {
private final InstanceIdentifier key;
private final FlowCapableNodeConnector fcNodeConnectorOld;
private final FlowCapableNodeConnector fcNodeConnectorNew;
private final String interfaceName;
InterfaceStateUpdateWorker(InstanceIdentifier key,
FlowCapableNodeConnector fcNodeConnectorOld, FlowCapableNodeConnector fcNodeConnectorNew,
String portName) {
this.key = key;
this.fcNodeConnectorOld = fcNodeConnectorOld;
this.fcNodeConnectorNew = fcNodeConnectorNew;
this.interfaceName = portName;
}
@Override
public Object call() {
List> futures = OvsInterfaceStateUpdateHelper.updateState(key,
alivenessMonitorService, dataBroker, interfaceName, fcNodeConnectorNew, fcNodeConnectorOld);
List interfaceChildEntries = getInterfaceChildEntries(dataBroker, interfaceName);
for (InterfaceChildEntry interfaceChildEntry : interfaceChildEntries) {
InterfaceStateUpdateWorker interfaceStateUpdateWorker = new InterfaceStateUpdateWorker(key,
fcNodeConnectorOld, fcNodeConnectorNew, interfaceChildEntry.getChildInterface());
DataStoreJobCoordinator.getInstance().enqueueJob(interfaceName, interfaceStateUpdateWorker);
}
return futures;
}
@Override
public String toString() {
return "InterfaceStateUpdateWorker{" + "key=" + key + ", fcNodeConnectorOld=" + fcNodeConnectorOld
+ ", fcNodeConnectorNew=" + fcNodeConnectorNew + ", interfaceName='" + interfaceName + '\'' + '}';
}
}
private class InterfaceStateRemoveWorker implements Callable {
private final NodeConnectorId nodeConnectorIdNew;
private NodeConnectorId nodeConnectorIdOld;
FlowCapableNodeConnector fcNodeConnectorOld;
private final String interfaceName;
private final String parentInterface;
private final IdManagerService idManager;
private final boolean isNodePresent;
private final boolean isNetworkEvent;
private final boolean isParentInterface;
InterfaceStateRemoveWorker(IdManagerService idManager, NodeConnectorId nodeConnectorIdNew,
NodeConnectorId nodeConnectorIdOld, FlowCapableNodeConnector fcNodeConnectorOld, String interfaceName,
String parentInterface, boolean isNodePresent, boolean isNetworkEvent, boolean isParentInterface) {
this.nodeConnectorIdNew = nodeConnectorIdNew;
this.nodeConnectorIdOld = nodeConnectorIdOld;
this.fcNodeConnectorOld = fcNodeConnectorOld;
this.interfaceName = interfaceName;
this.parentInterface = parentInterface;
this.idManager = idManager;
this.isNodePresent = isNodePresent;
this.isNetworkEvent = isNetworkEvent;
this.isParentInterface = isParentInterface;
}
@Override
public Object call() {
List> futures = null;
// VM Migration: Skip OFPPR_DELETE event received after OFPPR_ADD
// for same interface from Older DPN
if (isParentInterface && isNetworkEvent) {
nodeConnectorIdOld = IfmUtil.getNodeConnectorIdFromInterface(interfaceName, dataBroker);
if (nodeConnectorIdOld != null && !nodeConnectorIdNew.equals(nodeConnectorIdOld)) {
LOG.debug("Dropping the NodeConnector Remove Event for the interface: {}, {}, {}", interfaceName,
nodeConnectorIdNew, nodeConnectorIdOld);
return futures;
}
}
futures = OvsInterfaceStateRemoveHelper.removeInterfaceStateConfiguration(idManager, mdsalApiManager,
alivenessMonitorService, nodeConnectorIdNew, nodeConnectorIdOld, dataBroker, interfaceName,
fcNodeConnectorOld, isNodePresent, parentInterface);
List interfaceChildEntries = getInterfaceChildEntries(dataBroker, interfaceName);
for (InterfaceChildEntry interfaceChildEntry : interfaceChildEntries) {
// Fetch all interfaces on this port and trigger remove worker
// for each of them
InterfaceStateRemoveWorker interfaceStateRemoveWorker = new InterfaceStateRemoveWorker(idManager,
nodeConnectorIdNew, nodeConnectorIdOld, fcNodeConnectorOld,
interfaceChildEntry.getChildInterface(), interfaceName, isNodePresent, isNetworkEvent, false);
DataStoreJobCoordinator.getInstance().enqueueJob(interfaceName, interfaceStateRemoveWorker);
}
return futures;
}
@Override
public String toString() {
return "InterfaceStateRemoveWorker{" + "nodeConnectorIdNew=" + nodeConnectorIdNew + ", nodeConnectorIdOld="
+ nodeConnectorIdOld + ", fcNodeConnectorOld=" + fcNodeConnectorOld + ", interfaceName='"
+ interfaceName + '\'' + '}';
}
}
public static List getInterfaceChildEntries(DataBroker dataBroker, String interfaceName) {
InterfaceParentEntry interfaceParentEntry = InterfaceMetaUtils
.getInterfaceParentEntryFromConfigDS(interfaceName, dataBroker);
if (interfaceParentEntry != null && interfaceParentEntry.getInterfaceChildEntry() != null) {
return interfaceParentEntry.getInterfaceChildEntry();
}
return new ArrayList<>();
}
}