Rename NodeStatisticsAger and StatisticsUpdateCommiter
[controller.git] / opendaylight / md-sal / statistics-manager / src / main / java / org / opendaylight / controller / md / statistics / manager / StatisticsProvider.java
index 325b342cd88bdb71d6d2138169f2f7ae36c83785..ab5d20a951dd279a26b4abdc8068be958f339c21 100644 (file)
@@ -17,6 +17,7 @@ import java.util.concurrent.Future;
 import org.eclipse.xtext.xbase.lib.Exceptions;
 import org.opendaylight.controller.md.statistics.manager.MultipartMessageManager.StatsRequestType;
 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.DataModificationTransaction;
 import org.opendaylight.controller.sal.binding.api.data.DataProviderService;
@@ -71,117 +72,78 @@ import org.opendaylight.yangtools.yang.common.RpcResult;
 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 
+ * 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 int STATS_THREAD_EXECUTION_TIME= 15000;
 
-    public final static Logger spLogger = LoggerFactory.getLogger(StatisticsProvider.class);
-    
-    private DataProviderService dps;
-    
-    private DataBrokerService dbs;
+    private static final Logger spLogger = LoggerFactory.getLogger(StatisticsProvider.class);
+
+    private final MultipartMessageManager multipartMessageManager = new MultipartMessageManager();
+    private final InstanceIdentifier<Nodes> nodesIdentifier = InstanceIdentifier.builder(Nodes.class).toInstance();
+    private final DataProviderService dps;
+
+    //Local caching of stats
+    private final ConcurrentMap<NodeId,NodeStatisticsHandler> statisticsCache = new ConcurrentHashMap<>();
 
-    private NotificationProviderService nps;
-    
     private OpendaylightGroupStatisticsService groupStatsService;
-    
+
     private OpendaylightMeterStatisticsService meterStatsService;
-    
+
     private OpendaylightFlowStatisticsService flowStatsService;
-    
+
     private OpendaylightPortStatisticsService portStatsService;
 
     private OpendaylightFlowTableStatisticsService flowTableStatsService;
 
     private OpendaylightQueueStatisticsService queueStatsService;
 
-    private final MultipartMessageManager multipartMessageManager = new MultipartMessageManager();
-    
     private StatisticsUpdateHandler statsUpdateHandler;
-    
+
     private Thread statisticsRequesterThread;
-    
+
     private Thread statisticsAgerThread;
 
-    private final  InstanceIdentifier<Nodes> nodesIdentifier = InstanceIdentifier.builder(Nodes.class).toInstance();
-    
-    public static final int STATS_THREAD_EXECUTION_TIME= 15000;
-    //Local caching of stats
-    
-    private final ConcurrentMap<NodeId,NodeStatisticsAger> statisticsCache = 
-            new ConcurrentHashMap<NodeId,NodeStatisticsAger>();
-    
-    public DataProviderService getDataService() {
-      return this.dps;
-    }
-    
-    public void setDataService(final DataProviderService dataService) {
-      this.dps = dataService;
-    }
-    
-    public DataBrokerService getDataBrokerService() {
-        return this.dbs;
-    }
-      
-    public void setDataBrokerService(final DataBrokerService dataBrokerService) {
-        this.dbs = dataBrokerService;
-    }
 
-    public NotificationProviderService getNotificationService() {
-      return this.nps;
-    }
-    
-    public void setNotificationService(final NotificationProviderService notificationService) {
-      this.nps = notificationService;
+    public StatisticsProvider(final DataProviderService dataService) {
+        this.dps = Preconditions.checkNotNull(dataService);
     }
 
     public MultipartMessageManager getMultipartMessageManager() {
         return multipartMessageManager;
     }
 
-    private final StatisticsUpdateCommiter updateCommiter = new StatisticsUpdateCommiter(StatisticsProvider.this);
-    
+    private final StatisticsListener updateCommiter = new StatisticsListener(StatisticsProvider.this);
+
     private Registration<NotificationListener> listenerRegistration;
-    
-    public void start() {
-        
-        NotificationProviderService nps = this.getNotificationService();
-        Registration<NotificationListener> registerNotificationListener = nps.registerNotificationListener(this.updateCommiter);
-        this.listenerRegistration = registerNotificationListener;
-        
+
+    public void start(final DataBrokerService dbs, final NotificationProviderService nps, final RpcConsumerRegistry rpcRegistry) {
+
+        this.listenerRegistration = nps.registerNotificationListener(this.updateCommiter);
+
         statsUpdateHandler = new StatisticsUpdateHandler(StatisticsProvider.this);
-        
-        registerDataStoreUpdateListener(this.getDataBrokerService());
-        
+        registerDataStoreUpdateListener(dbs);
+
         // Get Group/Meter statistics service instance
-        groupStatsService = StatisticsManagerActivator.getProviderContext().
-                getRpcService(OpendaylightGroupStatisticsService.class);
-        
-        meterStatsService = StatisticsManagerActivator.getProviderContext().
-                getRpcService(OpendaylightMeterStatisticsService.class);
-        
-        flowStatsService = StatisticsManagerActivator.getProviderContext().
-                getRpcService(OpendaylightFlowStatisticsService.class);
-
-        portStatsService = StatisticsManagerActivator.getProviderContext().
-                getRpcService(OpendaylightPortStatisticsService.class);
-
-        flowTableStatsService = StatisticsManagerActivator.getProviderContext().
-                getRpcService(OpendaylightFlowTableStatisticsService.class);
-        
-        queueStatsService = StatisticsManagerActivator.getProviderContext().
-                getRpcService(OpendaylightQueueStatisticsService.class);
-        
+        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);
+
         statisticsRequesterThread = new Thread( new Runnable(){
 
             @Override
@@ -189,7 +151,7 @@ public class StatisticsProvider implements AutoCloseable {
                 while(true){
                     try {
                         statsRequestSender();
-                        
+
                         Thread.sleep(STATS_THREAD_EXECUTION_TIME);
                     }catch (Exception e){
                         spLogger.error("Exception occurred while sending stats request : {}",e);
@@ -197,22 +159,22 @@ public class StatisticsProvider implements AutoCloseable {
                 }
             }
         });
-        
+
         spLogger.debug("Statistics requester thread started with timer interval : {}",STATS_THREAD_EXECUTION_TIME);
-        
+
         statisticsRequesterThread.start();
-        
+
         statisticsAgerThread = new Thread( new Runnable(){
 
             @Override
             public void run() {
                 while(true){
                     try {
-                        for(NodeStatisticsAger nodeStatisticsAger : statisticsCache.values()){
+                        for(NodeStatisticsHandler nodeStatisticsAger : statisticsCache.values()){
                             nodeStatisticsAger.cleanStaleStatistics();
                         }
                         multipartMessageManager.cleanStaleTransactionIds();
-                        
+
                         Thread.sleep(STATS_THREAD_EXECUTION_TIME);
                     }catch (Exception e){
                         spLogger.error("Exception occurred while sending stats request : {}",e);
@@ -220,14 +182,14 @@ public class StatisticsProvider implements AutoCloseable {
                 }
             }
         });
-        
+
         spLogger.debug("Statistics ager thread started with timer interval : {}",STATS_THREAD_EXECUTION_TIME);
 
         statisticsAgerThread.start();
-        
+
         spLogger.info("Statistics Provider started.");
     }
-    
+
     private void registerDataStoreUpdateListener(DataBrokerService dbs) {
         //Register for Node updates
         InstanceIdentifier<? extends DataObject> pathNode = InstanceIdentifier.builder(Nodes.class)
@@ -240,15 +202,15 @@ public class StatisticsProvider implements AutoCloseable {
                                                                     .child(Table.class)
                                                                     .child(Flow.class).toInstance();
         dbs.registerDataChangeListener(pathFlow, statsUpdateHandler);
-        
+
         //Register for meter updates
         InstanceIdentifier<? extends DataObject> pathMeter = InstanceIdentifier.builder(Nodes.class).child(Node.class)
                                                     .augmentation(FlowCapableNode.class)
                                                     .child(Meter.class).toInstance();
 
         dbs.registerDataChangeListener(pathMeter, statsUpdateHandler);
-        
-        //Register for group updates 
+
+        //Register for group updates
         InstanceIdentifier<? extends DataObject> pathGroup = InstanceIdentifier.builder(Nodes.class).child(Node.class)
                                                     .augmentation(FlowCapableNode.class)
                                                     .child(Group.class).toInstance();
@@ -263,35 +225,33 @@ public class StatisticsProvider implements AutoCloseable {
     }
 
     protected DataModificationTransaction startChange() {
-        
-        DataProviderService dps = this.getDataService();
         return dps.beginTransaction();
     }
-    
+
     private void statsRequestSender(){
-        
+
         List<Node> targetNodes = getAllConnectedNodes();
-        
+
         if(targetNodes == null)
             return;
-        
+
 
         for (Node targetNode : targetNodes){
-            
+
             if(targetNode.getAugmentation(FlowCapableNode.class) != null){
                 sendStatisticsRequestsToNode(targetNode);
             }
         }
     }
-    
+
     public void sendStatisticsRequestsToNode(Node targetNode){
-        
+
         spLogger.debug("Send requests for statistics collection to node : {})",targetNode.getId());
-        
+
         InstanceIdentifier<Node> targetInstanceId = InstanceIdentifier.builder(Nodes.class).child(Node.class,targetNode.getKey()).toInstance();
-        
+
         NodeRef targetNodeRef = new NodeRef(targetInstanceId);
-    
+
         try{
             if(flowStatsService != null){
                 sendAggregateFlowsStatsFromAllTablesRequest(targetNode.getKey());
@@ -318,15 +278,15 @@ public class StatisticsProvider implements AutoCloseable {
             spLogger.error("Exception occured while sending statistics requests : {}", e);
         }
     }
-    
+
 
     public void sendAllFlowTablesStatisticsRequest(NodeRef targetNodeRef) throws InterruptedException, ExecutionException {
-        final GetFlowTablesStatisticsInputBuilder input = 
+        final GetFlowTablesStatisticsInputBuilder input =
                 new GetFlowTablesStatisticsInputBuilder();
-        
+
         input.setNode(targetNodeRef);
 
-        Future<RpcResult<GetFlowTablesStatisticsOutput>> response = 
+        Future<RpcResult<GetFlowTablesStatisticsOutput>> response =
                 flowTableStatsService.getFlowTablesStatistics(input.build());
 
         this.multipartMessageManager.addTxIdToRequestTypeEntry(getNodeId(targetNodeRef),response.get().getResult().getTransactionId()
@@ -337,69 +297,69 @@ public class StatisticsProvider implements AutoCloseable {
     public void sendAllFlowsStatsFromAllTablesRequest(NodeRef targetNode) throws InterruptedException, ExecutionException{
         final GetAllFlowsStatisticsFromAllFlowTablesInputBuilder input =
                 new GetAllFlowsStatisticsFromAllFlowTablesInputBuilder();
-        
+
         input.setNode(targetNode);
-        
-        Future<RpcResult<GetAllFlowsStatisticsFromAllFlowTablesOutput>> response = 
+
+        Future<RpcResult<GetAllFlowsStatisticsFromAllFlowTablesOutput>> response =
                 flowStatsService.getAllFlowsStatisticsFromAllFlowTables(input.build());
-        
+
         this.multipartMessageManager.addTxIdToRequestTypeEntry(getNodeId(targetNode), response.get().getResult().getTransactionId()
                 , StatsRequestType.ALL_FLOW);
-        
+
     }
-    
+
     public void sendFlowStatsFromTableRequest(NodeRef targetNode,Flow flow) throws InterruptedException, ExecutionException{
         final GetFlowStatisticsFromFlowTableInputBuilder input =
                 new GetFlowStatisticsFromFlowTableInputBuilder();
-        
+
         input.setNode(targetNode);
         input.fieldsFrom(flow);
-        
-        Future<RpcResult<GetFlowStatisticsFromFlowTableOutput>> response = 
+
+        Future<RpcResult<GetFlowStatisticsFromFlowTableOutput>> response =
                 flowStatsService.getFlowStatisticsFromFlowTable(input.build());
-        
+
         this.multipartMessageManager.addTxIdToRequestTypeEntry(getNodeId(targetNode), response.get().getResult().getTransactionId()
                 , StatsRequestType.ALL_FLOW);
-        
+
     }
 
     public void sendAggregateFlowsStatsFromAllTablesRequest(NodeKey targetNodeKey) throws InterruptedException, ExecutionException{
-        
+
         List<Short> tablesId = getTablesFromNode(targetNodeKey);
-        
+
         if(tablesId.size() != 0){
             for(Short id : tablesId){
-                
+
                 sendAggregateFlowsStatsFromTableRequest(targetNodeKey,id);
             }
         }else{
             spLogger.debug("No details found in data store for flow tables associated with Node {}",targetNodeKey);
         }
     }
-    
+
     public void sendAggregateFlowsStatsFromTableRequest(NodeKey targetNodeKey,Short tableId) throws InterruptedException, ExecutionException{
-        
+
         spLogger.debug("Send aggregate stats request for flow table {} to node {}",tableId,targetNodeKey);
-        GetAggregateFlowStatisticsFromFlowTableForAllFlowsInputBuilder input = 
+        GetAggregateFlowStatisticsFromFlowTableForAllFlowsInputBuilder input =
                 new GetAggregateFlowStatisticsFromFlowTableForAllFlowsInputBuilder();
-                
+
         input.setNode(new NodeRef(InstanceIdentifier.builder(Nodes.class).child(Node.class, targetNodeKey).toInstance()));
         input.setTableId(new org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableId(tableId));
-        Future<RpcResult<GetAggregateFlowStatisticsFromFlowTableForAllFlowsOutput>> response = 
+        Future<RpcResult<GetAggregateFlowStatisticsFromFlowTableForAllFlowsOutput>> response =
                 flowStatsService.getAggregateFlowStatisticsFromFlowTableForAllFlows(input.build());
-                
+
         multipartMessageManager.setTxIdAndTableIdMapEntry(targetNodeKey.getId(), response.get().getResult().getTransactionId(), tableId);
         this.multipartMessageManager.addTxIdToRequestTypeEntry(targetNodeKey.getId(), response.get().getResult().getTransactionId()
                 , StatsRequestType.AGGR_FLOW);
     }
 
     public void sendAllNodeConnectorsStatisticsRequest(NodeRef targetNode) throws InterruptedException, ExecutionException{
-        
+
         final GetAllNodeConnectorsStatisticsInputBuilder input = new GetAllNodeConnectorsStatisticsInputBuilder();
-        
+
         input.setNode(targetNode);
 
-        Future<RpcResult<GetAllNodeConnectorsStatisticsOutput>> response = 
+        Future<RpcResult<GetAllNodeConnectorsStatisticsOutput>> response =
                 portStatsService.getAllNodeConnectorsStatistics(input.build());
         this.multipartMessageManager.addTxIdToRequestTypeEntry(getNodeId(targetNode), response.get().getResult().getTransactionId()
                 , StatsRequestType.ALL_PORT);
@@ -407,68 +367,68 @@ public class StatisticsProvider implements AutoCloseable {
     }
 
     public void sendAllGroupStatisticsRequest(NodeRef targetNode) throws InterruptedException, ExecutionException{
-        
+
         final GetAllGroupStatisticsInputBuilder input = new GetAllGroupStatisticsInputBuilder();
-        
+
         input.setNode(targetNode);
 
-        Future<RpcResult<GetAllGroupStatisticsOutput>> response = 
+        Future<RpcResult<GetAllGroupStatisticsOutput>> response =
                 groupStatsService.getAllGroupStatistics(input.build());
-        
+
         this.multipartMessageManager.addTxIdToRequestTypeEntry(getNodeId(targetNode), response.get().getResult().getTransactionId()
                 , StatsRequestType.ALL_GROUP);
 
     }
-    
+
     public void sendGroupDescriptionRequest(NodeRef targetNode) throws InterruptedException, ExecutionException{
         final GetGroupDescriptionInputBuilder input = new GetGroupDescriptionInputBuilder();
-        
+
         input.setNode(targetNode);
 
-        Future<RpcResult<GetGroupDescriptionOutput>> response = 
+        Future<RpcResult<GetGroupDescriptionOutput>> response =
                 groupStatsService.getGroupDescription(input.build());
 
         this.multipartMessageManager.addTxIdToRequestTypeEntry(getNodeId(targetNode), response.get().getResult().getTransactionId()
                 , StatsRequestType.GROUP_DESC);
 
     }
-    
+
     public void sendAllMeterStatisticsRequest(NodeRef targetNode) throws InterruptedException, ExecutionException{
-        
+
         GetAllMeterStatisticsInputBuilder input = new GetAllMeterStatisticsInputBuilder();
-        
+
         input.setNode(targetNode);
 
-        Future<RpcResult<GetAllMeterStatisticsOutput>> response = 
+        Future<RpcResult<GetAllMeterStatisticsOutput>> response =
                 meterStatsService.getAllMeterStatistics(input.build());
-        
+
         this.multipartMessageManager.addTxIdToRequestTypeEntry(getNodeId(targetNode), response.get().getResult().getTransactionId()
                 , StatsRequestType.ALL_METER);;
 
     }
-    
+
     public void sendMeterConfigStatisticsRequest(NodeRef targetNode) throws InterruptedException, ExecutionException{
-        
+
         GetAllMeterConfigStatisticsInputBuilder input = new GetAllMeterConfigStatisticsInputBuilder();
-        
+
         input.setNode(targetNode);
 
-        Future<RpcResult<GetAllMeterConfigStatisticsOutput>> response = 
+        Future<RpcResult<GetAllMeterConfigStatisticsOutput>> response =
                 meterStatsService.getAllMeterConfigStatistics(input.build());
-        
+
         this.multipartMessageManager.addTxIdToRequestTypeEntry(getNodeId(targetNode), response.get().getResult().getTransactionId()
                 , StatsRequestType.METER_CONFIG);;
 
     }
-    
+
     public void sendAllQueueStatsFromAllNodeConnector(NodeRef targetNode) throws InterruptedException, ExecutionException {
         GetAllQueuesStatisticsFromAllPortsInputBuilder input = new GetAllQueuesStatisticsFromAllPortsInputBuilder();
-        
+
         input.setNode(targetNode);
-        
-        Future<RpcResult<GetAllQueuesStatisticsFromAllPortsOutput>> response = 
+
+        Future<RpcResult<GetAllQueuesStatisticsFromAllPortsOutput>> response =
                 queueStatsService.getAllQueuesStatisticsFromAllPorts(input.build());
-        
+
         this.multipartMessageManager.addTxIdToRequestTypeEntry(getNodeId(targetNode), response.get().getResult().getTransactionId()
                 , StatsRequestType.ALL_QUEUE_STATS);;
 
@@ -476,35 +436,48 @@ public class StatisticsProvider implements AutoCloseable {
 
     public void sendQueueStatsFromGivenNodeConnector(NodeRef targetNode,NodeConnectorId nodeConnectorId, QueueId queueId) throws InterruptedException, ExecutionException {
         GetQueueStatisticsFromGivenPortInputBuilder input = new GetQueueStatisticsFromGivenPortInputBuilder();
-        
+
         input.setNode(targetNode);
         input.setNodeConnectorId(nodeConnectorId);
         input.setQueueId(queueId);
-        Future<RpcResult<GetQueueStatisticsFromGivenPortOutput>> response = 
+        Future<RpcResult<GetQueueStatisticsFromGivenPortOutput>> response =
                 queueStatsService.getQueueStatisticsFromGivenPort(input.build());
-        
+
         this.multipartMessageManager.addTxIdToRequestTypeEntry(getNodeId(targetNode), response.get().getResult().getTransactionId()
                 , StatsRequestType.ALL_QUEUE_STATS);;
 
     }
 
-    public ConcurrentMap<NodeId, NodeStatisticsAger> getStatisticsCache() {
-        return statisticsCache;
+    /**
+     * 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 ager = statisticsCache.get(nodeId);
+        if (ager == null) {
+            ager = new NodeStatisticsHandler(this, new NodeKey(nodeId));
+            statisticsCache.put(nodeId, ager);
+        }
+
+        return ager;
     }
-    
+
     private List<Node> getAllConnectedNodes(){
-        
         Nodes nodes = (Nodes) dps.readOperationalData(nodesIdentifier);
         if(nodes == null)
             return null;
-        
+
         spLogger.debug("Number of connected nodes : {}",nodes.getNode().size());
         return nodes.getNode();
     }
-    
+
     private List<Short> getTablesFromNode(NodeKey nodeKey){
         InstanceIdentifier<FlowCapableNode> nodesIdentifier = InstanceIdentifier.builder(Nodes.class).child(Node.class,nodeKey).augmentation(FlowCapableNode.class).toInstance();
-        
+
         FlowCapableNode node = (FlowCapableNode)dps.readOperationalData(nodesIdentifier);
         List<Short> tablesId = new ArrayList<Short>();
         if(node != null && node.getTable()!=null){
@@ -522,21 +495,21 @@ public class StatisticsProvider implements AutoCloseable {
         NodeKey nodeKey = InstanceIdentifier.keyOf(nodeII);
         return nodeKey.getId();
     }
-    
+
     @SuppressWarnings("deprecation")
     @Override
     public void close(){
-        
+
         try {
             spLogger.info("Statistics Provider stopped.");
             if (this.listenerRegistration != null) {
-              
+
                 this.listenerRegistration.close();
-                
+
                 this.statisticsRequesterThread.destroy();
-                
+
                 this.statisticsAgerThread.destroy();
-            
+
             }
           } catch (Throwable e) {
             throw Exceptions.sneakyThrow(e);