/*
* Copyright (c) 2014 Cisco Systems, Inc. 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.openflowplugin.applications.topology.lldp;
import com.google.common.annotations.VisibleForTesting;
import java.util.Collection;
import java.util.Date;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Timer;
import java.util.TimerTask;
import java.util.concurrent.ConcurrentHashMap;
import javax.annotation.PreDestroy;
import javax.inject.Inject;
import javax.inject.Singleton;
import org.apache.aries.blueprint.annotation.service.Reference;
import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.mdsal.binding.api.ClusteredDataTreeChangeListener;
import org.opendaylight.mdsal.binding.api.DataBroker;
import org.opendaylight.mdsal.binding.api.DataObjectModification;
import org.opendaylight.mdsal.binding.api.DataTreeChangeListener;
import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
import org.opendaylight.mdsal.binding.api.DataTreeModification;
import org.opendaylight.mdsal.binding.api.NotificationPublishService;
import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipService;
import org.opendaylight.openflowplugin.api.openflow.configuration.ConfigurationListener;
import org.opendaylight.openflowplugin.api.openflow.configuration.ConfigurationService;
import org.opendaylight.openflowplugin.applications.topology.lldp.utils.LLDPDiscoveryUtils;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.topology.discovery.rev130819.LinkDiscovered;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.topology.discovery.rev130819.LinkRemoved;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.topology.discovery.rev130819.LinkRemovedBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.lldp.discovery.config.rev160511.TopologyLldpDiscoveryConfig;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Link;
import org.opendaylight.yangtools.concepts.ListenerRegistration;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@Singleton
public class LLDPLinkAger implements ConfigurationListener, ClusteredDataTreeChangeListener, AutoCloseable {
private static final Logger LOG = LoggerFactory.getLogger(LLDPLinkAger.class);
static final String TOPOLOGY_ID = "flow:1";
static final InstanceIdentifier II_TO_LINK = InstanceIdentifier.create(NetworkTopology.class)
.child(Topology.class, new TopologyKey(new TopologyId(TOPOLOGY_ID))).child(Link.class);
private final long linkExpirationTime;
private final Map linkToDate;
private final Timer timer;
private final NotificationPublishService notificationService;
private final AutoCloseable configurationServiceRegistration;
private final EntityOwnershipService eos;
private ListenerRegistration listenerRegistration;
/**
* default ctor - start timer.
*/
@Inject
@SuppressWarnings("checkstyle:IllegalCatch")
public LLDPLinkAger(final TopologyLldpDiscoveryConfig topologyLldpDiscoveryConfig,
@Reference final NotificationPublishService notificationService,
@Reference final ConfigurationService configurationService,
@Reference final EntityOwnershipService entityOwnershipService,
@Reference final DataBroker dataBroker) {
this.linkExpirationTime = topologyLldpDiscoveryConfig.getTopologyLldpExpirationInterval().getValue().toJava();
this.notificationService = notificationService;
this.configurationServiceRegistration = configurationService.registerListener(this);
this.eos = entityOwnershipService;
linkToDate = new ConcurrentHashMap<>();
timer = new Timer();
final DataTreeIdentifier dtiToNodeConnector = DataTreeIdentifier.create(LogicalDatastoreType.OPERATIONAL,
II_TO_LINK);
try {
listenerRegistration = dataBroker.registerDataTreeChangeListener(dtiToNodeConnector, LLDPLinkAger.this);
} catch (Exception e) {
LOG.error("DataTreeChangeListeners registration failed:", e);
throw new IllegalStateException("LLDPLinkAger startup failed!", e);
}
timer.schedule(new LLDPAgingTask(), 0,
topologyLldpDiscoveryConfig.getTopologyLldpInterval().getValue().toJava());
}
public void put(LinkDiscovered link) {
Date expires = new Date();
expires.setTime(expires.getTime() + linkExpirationTime);
linkToDate.put(link, expires);
}
@Override
@PreDestroy
public void close() throws Exception {
if (listenerRegistration != null) {
listenerRegistration.close();
listenerRegistration = null;
}
timer.cancel();
linkToDate.clear();
configurationServiceRegistration.close();
}
@Override
public void onDataTreeChanged(@NonNull Collection> changes) {
for (DataTreeModification modification : changes) {
switch (modification.getRootNode().getModificationType()) {
case WRITE:
break;
case SUBTREE_MODIFIED:
// NOOP
break;
case DELETE:
processLinkDeleted(modification.getRootNode());
break;
default:
LOG.error("Unhandled modification type: {}", modification.getRootNode().getModificationType());
}
}
}
@VisibleForTesting
public boolean isLinkToDateEmpty() {
return linkToDate.isEmpty();
}
@Override
public void onPropertyChanged(@NonNull final String propertyName, @NonNull final String propertyValue) {
final TopologyLLDPDiscoveryProperty lldpDiscoveryProperty = TopologyLLDPDiscoveryProperty.forValue(
propertyName);
if (lldpDiscoveryProperty != null) {
switch (lldpDiscoveryProperty) {
case LLDP_SECURE_KEY:
case TOPOLOGY_LLDP_INTERVAL:
case TOPOLOGY_LLDP_EXPIRATION_INTERVAL:
LOG.warn("Runtime update not supported for property {}", lldpDiscoveryProperty);
break;
default:
LOG.warn("No topology lldp discovery property found.");
break;
}
}
}
protected boolean isLinkPresent(final LinkDiscovered linkDiscovered) {
return linkToDate.containsKey(linkDiscovered);
}
private void processLinkDeleted(DataObjectModification rootNode) {
Link link = (Link) rootNode.getDataBefore();
LOG.trace("Removing link {} from linkToDate cache", link);
LinkDiscovered linkDiscovered = LLDPDiscoveryUtils.toLLDPLinkDiscovered(link);
linkToDate.remove(linkDiscovered);
}
private class LLDPAgingTask extends TimerTask {
@Override
public void run() {
for (Entry entry : linkToDate.entrySet()) {
LinkDiscovered link = entry.getKey();
Date expires = entry.getValue();
Date now = new Date();
if (now.after(expires)) {
if (notificationService != null) {
LinkRemovedBuilder lrb = new LinkRemovedBuilder(link);
NodeKey nodeKey = link.getDestination().getValue().firstKeyOf(Node.class);
LOG.info("No update received for link {} from last {} milliseconds. Removing link from cache.",
link, linkExpirationTime);
linkToDate.remove(link);
if (nodeKey != null && LLDPDiscoveryUtils.isEntityOwned(eos, nodeKey.getId().getValue())) {
LOG.info("Publish Link Remove event for the link {}", link);
final LinkRemoved lr = lrb.build();
try {
notificationService.putNotification(lr);
} catch (InterruptedException e) {
LOG.warn("Interrupted while publishing notification {}", lr, e);
}
} else {
LOG.trace("Skip publishing Link Remove event for the link {} because link destination "
+ "node is not owned by the controller", link);
}
}
}
}
}
}
}