/* * Copyright IBM Corporation, 2013. 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.controller.md.statistics.manager; import java.util.Collection; import java.util.Timer; import java.util.TimerTask; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentMap; import java.util.concurrent.TimeUnit; import org.opendaylight.controller.sal.binding.api.NotificationProviderService; import org.opendaylight.controller.sal.binding.api.RpcConsumerRegistry; import org.opendaylight.controller.sal.binding.api.data.DataBrokerService; import org.opendaylight.controller.sal.binding.api.data.DataChangeListener; import org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction; import org.opendaylight.controller.sal.binding.api.data.DataProviderService; import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode; import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector; import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.Meter; import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table; import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow; import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.OpendaylightFlowStatisticsService; import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.OpendaylightFlowTableStatisticsService; import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.queues.Queue; import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.queue.rev130925.QueueId; import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.OpendaylightGroupStatisticsService; import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group; import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId; import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId; 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.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey; import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.OpendaylightMeterStatisticsService; import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.OpendaylightPortStatisticsService; import org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.OpendaylightQueueStatisticsService; import org.opendaylight.yangtools.concepts.ListenerRegistration; import org.opendaylight.yangtools.concepts.Registration; import org.opendaylight.yangtools.yang.binding.DataObject; import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; import org.opendaylight.yangtools.yang.binding.NotificationListener; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import com.google.common.base.Preconditions; /** * Following are main responsibilities of the class: * 1) Invoke statistics request thread to send periodic statistics request to all the * flow capable switch connected to the controller. It sends statistics request for * Group,Meter,Table,Flow,Queue,Aggregate stats. * * 2) Invoke statistics ager thread, to clean up all the stale statistics data from * operational data store. * * @author avishnoi@in.ibm.com * */ public class StatisticsProvider implements AutoCloseable { public static final long STATS_COLLECTION_MILLIS = TimeUnit.SECONDS.toMillis(15); private static final Logger spLogger = LoggerFactory.getLogger(StatisticsProvider.class); private final ConcurrentMap handlers = new ConcurrentHashMap<>(); private final Timer timer = new Timer("statistics-manager", true); private final DataProviderService dps; private OpendaylightGroupStatisticsService groupStatsService; private OpendaylightMeterStatisticsService meterStatsService; private OpendaylightFlowStatisticsService flowStatsService; private OpendaylightPortStatisticsService portStatsService; private OpendaylightFlowTableStatisticsService flowTableStatsService; private OpendaylightQueueStatisticsService queueStatsService; private StatisticsUpdateHandler statsUpdateHandler; public StatisticsProvider(final DataProviderService dataService) { this.dps = Preconditions.checkNotNull(dataService); } private final StatisticsListener updateCommiter = new StatisticsListener(StatisticsProvider.this); private Registration listenerRegistration; private ListenerRegistration flowCapableTrackerRegistration; public void start(final DataBrokerService dbs, final NotificationProviderService nps, final RpcConsumerRegistry rpcRegistry) { // Get Group/Meter statistics service instances groupStatsService = rpcRegistry.getRpcService(OpendaylightGroupStatisticsService.class); meterStatsService = rpcRegistry.getRpcService(OpendaylightMeterStatisticsService.class); flowStatsService = rpcRegistry.getRpcService(OpendaylightFlowStatisticsService.class); portStatsService = rpcRegistry.getRpcService(OpendaylightPortStatisticsService.class); flowTableStatsService = rpcRegistry.getRpcService(OpendaylightFlowTableStatisticsService.class); queueStatsService = rpcRegistry.getRpcService(OpendaylightQueueStatisticsService.class); // Start receiving notifications this.listenerRegistration = nps.registerNotificationListener(this.updateCommiter); // Register for switch connect/disconnect notifications final InstanceIdentifier fcnId = InstanceIdentifier.builder(Nodes.class) .child(Node.class).augmentation(FlowCapableNode.class).build(); spLogger.debug("Registering FlowCapable tracker to {}", fcnId); this.flowCapableTrackerRegistration = dbs.registerDataChangeListener(fcnId, new FlowCapableTracker(this, fcnId)); statsUpdateHandler = new StatisticsUpdateHandler(StatisticsProvider.this); registerDataStoreUpdateListener(dbs); timer.schedule(new TimerTask() { @Override public void run() { try { // Send stats requests for (NodeStatisticsHandler h : handlers.values()) { h.requestPeriodicStatistics(); } // Perform cleanup for(NodeStatisticsHandler nodeStatisticsAger : handlers.values()){ nodeStatisticsAger.cleanStaleStatistics(); } } catch (RuntimeException e) { spLogger.warn("Failed to request statistics", e); } } }, 0, STATS_COLLECTION_MILLIS); spLogger.debug("Statistics timer task with timer interval : {}ms", STATS_COLLECTION_MILLIS); spLogger.info("Statistics Provider started."); } private void registerDataStoreUpdateListener(DataBrokerService dbs) { // FIXME: the below should be broken out into StatisticsUpdateHandler //Register for flow updates InstanceIdentifier pathFlow = InstanceIdentifier.builder(Nodes.class).child(Node.class) .augmentation(FlowCapableNode.class) .child(Table.class) .child(Flow.class).toInstance(); dbs.registerDataChangeListener(pathFlow, statsUpdateHandler); //Register for meter updates InstanceIdentifier pathMeter = InstanceIdentifier.builder(Nodes.class).child(Node.class) .augmentation(FlowCapableNode.class) .child(Meter.class).toInstance(); dbs.registerDataChangeListener(pathMeter, statsUpdateHandler); //Register for group updates InstanceIdentifier pathGroup = InstanceIdentifier.builder(Nodes.class).child(Node.class) .augmentation(FlowCapableNode.class) .child(Group.class).toInstance(); dbs.registerDataChangeListener(pathGroup, statsUpdateHandler); //Register for queue updates InstanceIdentifier pathQueue = InstanceIdentifier.builder(Nodes.class).child(Node.class) .child(NodeConnector.class) .augmentation(FlowCapableNodeConnector.class) .child(Queue.class).toInstance(); dbs.registerDataChangeListener(pathQueue, statsUpdateHandler); } protected DataModificationTransaction startChange() { return dps.beginTransaction(); } public void sendFlowStatsFromTableRequest(NodeKey node, Flow flow) { final NodeStatisticsHandler h = getStatisticsHandler(node.getId()); if (h != null) { h.sendFlowStatsFromTableRequest(flow); } } public void sendGroupDescriptionRequest(NodeKey node) { final NodeStatisticsHandler h = getStatisticsHandler(node.getId()); if (h != null) { h.sendGroupDescriptionRequest(); } } public void sendMeterConfigStatisticsRequest(NodeKey node) { final NodeStatisticsHandler h = getStatisticsHandler(node.getId()); if (h != null) { h.sendMeterConfigStatisticsRequest(); } } public void sendQueueStatsFromGivenNodeConnector(NodeKey node,NodeConnectorId nodeConnectorId, QueueId queueId) { final NodeStatisticsHandler h = getStatisticsHandler(node.getId()); if (h != null) { h.sendQueueStatsFromGivenNodeConnector(nodeConnectorId, queueId); } } /** * Get the handler for a particular node. * * @param nodeId source node * @return Node statistics handler for that node. Null if the statistics should * not handled. */ public final NodeStatisticsHandler getStatisticsHandler(final NodeId nodeId) { Preconditions.checkNotNull(nodeId); NodeStatisticsHandler handler = handlers.get(nodeId); if (handler == null) { spLogger.info("Attempted to get non-existing handler for {}", nodeId); } return handler; } @Override public void close() { try { if (this.listenerRegistration != null) { this.listenerRegistration.close(); this.listenerRegistration = null; } if (this.flowCapableTrackerRegistration != null) { this.flowCapableTrackerRegistration.close(); this.flowCapableTrackerRegistration = null; } timer.cancel(); } catch (Exception e) { spLogger.warn("Failed to stop Statistics Provider completely", e); } finally { spLogger.info("Statistics Provider stopped."); } } void startNodeHandlers(final Collection addedNodes) { for (NodeKey key : addedNodes) { if (handlers.containsKey(key.getId())) { spLogger.warn("Attempted to start already-existing handler for {}, very strange", key.getId()); continue; } final NodeStatisticsHandler h = new NodeStatisticsHandler(dps, key, flowStatsService, flowTableStatsService, groupStatsService, meterStatsService, portStatsService, queueStatsService); final NodeStatisticsHandler old = handlers.putIfAbsent(key.getId(), h); if (old == null) { spLogger.debug("Started node handler for {}", key.getId()); h.start(); } else { spLogger.debug("Prevented race on handler for {}", key.getId()); } } } void stopNodeHandlers(final Collection removedNodes) { for (NodeKey key : removedNodes) { final NodeStatisticsHandler s = handlers.remove(key.getId()); if (s != null) { spLogger.debug("Stopping node handler for {}", key.getId()); s.close(); } else { spLogger.warn("Attempted to remove non-existing handler for {}, very strange", key.getId()); } } } }