2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.controller.md.statistics.manager.impl;
11 import java.util.ArrayList;
12 import java.util.Collections;
13 import java.util.List;
14 import java.util.concurrent.BlockingQueue;
15 import java.util.concurrent.ExecutorService;
16 import java.util.concurrent.Executors;
17 import java.util.concurrent.LinkedBlockingDeque;
18 import java.util.concurrent.ThreadFactory;
20 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
21 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
22 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
23 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
24 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
25 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
26 import org.opendaylight.controller.md.statistics.manager.StatListeningCommiter;
27 import org.opendaylight.controller.md.statistics.manager.StatNodeRegistration;
28 import org.opendaylight.controller.md.statistics.manager.StatNotifyCommiter;
29 import org.opendaylight.controller.md.statistics.manager.StatPermCollector;
30 import org.opendaylight.controller.md.statistics.manager.StatPermCollector.StatCapabTypes;
31 import org.opendaylight.controller.md.statistics.manager.StatRpcMsgManager;
32 import org.opendaylight.controller.md.statistics.manager.StatisticsManager;
33 import org.opendaylight.controller.sal.binding.api.NotificationProviderService;
34 import org.opendaylight.controller.sal.binding.api.RpcConsumerRegistry;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.Meter;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.OpendaylightFlowStatisticsListener;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.OpendaylightFlowTableStatisticsListener;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.queues.Queue;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.OpendaylightGroupStatisticsListener;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.OpendaylightMeterStatisticsListener;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.OpendaylightPortStatisticsListener;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.OpendaylightQueueStatisticsListener;
46 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
47 import org.slf4j.Logger;
48 import org.slf4j.LoggerFactory;
50 import com.google.common.base.Preconditions;
51 import com.google.common.util.concurrent.ThreadFactoryBuilder;
55 * org.opendaylight.controller.md.statistics.manager.impl
57 * StatisticsManagerImpl
58 * It represent a central point for whole module. Implementation
59 * {@link StatisticsManager} registers all Operation/DS {@link StatNotifyCommiter} and
60 * Config/DS {@StatListeningCommiter}, as well as {@link StatPermCollector}
61 * for statistic collecting and {@link StatRpcMsgManager} as Device RPCs provider.
62 * In next, StatisticsManager provides all DS contact Transaction services.
64 * @author avishnoi@in.ibm.com <a href="mailto:vdemcak@cisco.com">Vaclav Demcak</a>
67 public class StatisticsManagerImpl implements StatisticsManager, Runnable {
69 private final static Logger LOG = LoggerFactory.getLogger(StatisticsManagerImpl.class);
71 private static final int QUEUE_DEPTH = 500;
72 private static final int MAX_BATCH = 1;
74 private final BlockingQueue<StatDataStoreOperation> dataStoreOperQueue = new LinkedBlockingDeque<>(QUEUE_DEPTH);
76 private final DataBroker dataBroker;
77 private final int maxNodesForCollectors;
78 private long minReqNetMonitInt;
79 private final ExecutorService statRpcMsgManagerExecutor;
80 private final ExecutorService statDataStoreOperationServ;
81 private StatRpcMsgManager rpcMsgManager;
82 private List<StatPermCollector> statCollectors;
83 private final Object statCollectorLock = new Object();
84 private BindingTransactionChain txChain;
85 private volatile boolean finishing = false;
87 private StatNodeRegistration nodeRegistrator;
88 private StatListeningCommiter<Flow, OpendaylightFlowStatisticsListener> flowListeningCommiter;
89 private StatListeningCommiter<Meter, OpendaylightMeterStatisticsListener> meterListeningCommiter;
90 private StatListeningCommiter<Group, OpendaylightGroupStatisticsListener> groupListeningCommiter;
91 private StatListeningCommiter<Queue, OpendaylightQueueStatisticsListener> queueNotifyCommiter;
92 private StatNotifyCommiter<OpendaylightFlowTableStatisticsListener> tableNotifCommiter;
93 private StatNotifyCommiter<OpendaylightPortStatisticsListener> portNotifyCommiter;
95 public StatisticsManagerImpl (final DataBroker dataBroker, final int maxNodesForCollector) {
96 this.dataBroker = Preconditions.checkNotNull(dataBroker, "DataBroker can not be null!");
97 ThreadFactory threadFact;
98 threadFact = new ThreadFactoryBuilder().setNameFormat("odl-stat-rpc-oper-thread-%d").build();
99 statRpcMsgManagerExecutor = Executors.newSingleThreadExecutor(threadFact);
100 threadFact = new ThreadFactoryBuilder().setNameFormat("odl-stat-ds-oper-thread-%d").build();
101 statDataStoreOperationServ = Executors.newSingleThreadExecutor(threadFact);
102 maxNodesForCollectors = maxNodesForCollector;
103 txChain = dataBroker.createTransactionChain(this);
107 public void start(final NotificationProviderService notifService,
108 final RpcConsumerRegistry rpcRegistry, final long minReqNetMonitInt) {
109 Preconditions.checkArgument(rpcRegistry != null, "RpcConsumerRegistry can not be null !");
110 this.minReqNetMonitInt = minReqNetMonitInt;
111 rpcMsgManager = new StatRpcMsgManagerImpl(this, rpcRegistry, minReqNetMonitInt);
112 statCollectors = Collections.emptyList();
113 nodeRegistrator = new StatNodeRegistrationImpl(this, dataBroker, notifService);
114 flowListeningCommiter = new StatListenCommitFlow(this, dataBroker, notifService);
115 meterListeningCommiter = new StatListenCommitMeter(this, dataBroker, notifService);
116 groupListeningCommiter = new StatListenCommitGroup(this, dataBroker, notifService);
117 tableNotifCommiter = new StatNotifyCommitTable(this, notifService);
118 portNotifyCommiter = new StatNotifyCommitPort(this, notifService);
119 queueNotifyCommiter = new StatListenCommitQueue(this, dataBroker, notifService);
121 statRpcMsgManagerExecutor.execute(rpcMsgManager);
122 statDataStoreOperationServ.execute(this);
123 LOG.info("Statistics Manager started successfully!");
127 public void close() throws Exception {
129 if (nodeRegistrator != null) {
130 nodeRegistrator.close();
131 nodeRegistrator = null;
133 if (flowListeningCommiter != null) {
134 flowListeningCommiter.close();
135 flowListeningCommiter = null;
137 if (meterListeningCommiter != null) {
138 meterListeningCommiter.close();
139 meterListeningCommiter = null;
141 if (groupListeningCommiter != null) {
142 groupListeningCommiter.close();
143 groupListeningCommiter = null;
145 if (tableNotifCommiter != null) {
146 tableNotifCommiter.close();
147 tableNotifCommiter = null;
149 if (portNotifyCommiter != null) {
150 portNotifyCommiter.close();
151 portNotifyCommiter = null;
153 if (queueNotifyCommiter != null) {
154 queueNotifyCommiter.close();
155 queueNotifyCommiter = null;
157 if (statCollectors != null) {
158 for (StatPermCollector collector : statCollectors) {
162 statCollectors = null;
164 if (rpcMsgManager != null) {
165 rpcMsgManager.close();
166 rpcMsgManager = null;
168 statRpcMsgManagerExecutor.shutdown();
169 statDataStoreOperationServ.shutdown();
170 if (txChain != null) {
177 public void enqueue(final StatDataStoreOperation op) {
178 // we don't need to block anything - next statistics come soon
179 final boolean success = dataStoreOperQueue.offer(op);
181 LOG.debug("Stat DS/Operational submiter Queue is full!");
187 /* Neverending cyle - wait for finishing */
188 while ( ! finishing) {
190 StatDataStoreOperation op = dataStoreOperQueue.take();
191 final ReadWriteTransaction tx = txChain.newReadWriteTransaction();
192 LOG.trace("New operations available, starting transaction {}", tx.getIdentifier());
196 op.applyOperation(tx);
199 if (ops < MAX_BATCH) {
200 op = dataStoreOperQueue.poll();
204 } while (op != null);
206 LOG.trace("Processed {} operations, submitting transaction {}", ops, tx.getIdentifier());
209 tx.submit().checkedGet();
210 } catch (final TransactionCommitFailedException e) {
211 LOG.warn("Stat DataStoreOperation unexpected State!", e);
213 txChain = dataBroker.createTransactionChain(StatisticsManagerImpl.this);
214 cleanDataStoreOperQueue();
217 catch (final IllegalStateException e) {
218 LOG.warn("Stat DataStoreOperation unexpected State!", e);
220 catch (final InterruptedException e) {
221 LOG.warn("Stat Manager DS Operation thread interupted!", e);
224 catch (final Exception e) {
225 LOG.warn("Stat DataStore Operation executor fail!", e);
228 // Drain all events, making sure any blocked threads are unblocked
229 cleanDataStoreOperQueue();
232 private void cleanDataStoreOperQueue() {
233 // Drain all events, making sure any blocked threads are unblocked
234 while (! dataStoreOperQueue.isEmpty()) {
235 dataStoreOperQueue.poll();
240 public void onTransactionChainFailed(final TransactionChain<?, ?> chain, final AsyncTransaction<?, ?> transaction,
241 final Throwable cause) {
242 LOG.warn("Failed to export Flow Capable Statistics, Transaction {} failed.",transaction.getIdentifier(),cause);
244 txChain = dataBroker.createTransactionChain(StatisticsManagerImpl.this);
245 cleanDataStoreOperQueue();
249 public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
254 public boolean isProvidedFlowNodeActive(final InstanceIdentifier<Node> nodeIdent) {
255 for (final StatPermCollector collector : statCollectors) {
256 if (collector.isProvidedFlowNodeActive(nodeIdent)) {
264 public void collectNextStatistics(final InstanceIdentifier<Node> nodeIdent) {
265 for (final StatPermCollector collector : statCollectors) {
266 if (collector.isProvidedFlowNodeActive(nodeIdent)) {
267 collector.collectNextStatistics();
273 public void connectedNodeRegistration(final InstanceIdentifier<Node> nodeIdent,
274 final List<StatCapabTypes> statTypes, final Short nrOfSwitchTables) {
275 for (final StatPermCollector collector : statCollectors) {
276 if (collector.connectedNodeRegistration(nodeIdent, statTypes, nrOfSwitchTables)) {
280 synchronized (statCollectorLock) {
281 for (final StatPermCollector collector : statCollectors) {
282 if (collector.connectedNodeRegistration(nodeIdent, statTypes, nrOfSwitchTables)) {
286 final StatPermCollectorImpl newCollector = new StatPermCollectorImpl(this,
287 minReqNetMonitInt, statCollectors.size() + 1, maxNodesForCollectors);
288 final List<StatPermCollector> statCollectorsNew = new ArrayList<>(statCollectors);
289 newCollector.connectedNodeRegistration(nodeIdent, statTypes, nrOfSwitchTables);
290 statCollectorsNew.add(newCollector);
291 statCollectors = Collections.unmodifiableList(statCollectorsNew);
296 public void disconnectedNodeUnregistration(final InstanceIdentifier<Node> nodeIdent) {
297 for (final StatPermCollector collector : statCollectors) {
298 if (collector.disconnectedNodeUnregistration(nodeIdent)) {
299 if ( ! collector.hasActiveNodes()) {
300 synchronized (statCollectorLock) {
301 if (collector.hasActiveNodes()) {
304 final List<StatPermCollector> newStatColl =
305 new ArrayList<>(statCollectors);
306 newStatColl.remove(collector);
307 statCollectors = Collections.unmodifiableList(newStatColl);
313 LOG.debug("Node {} has not removed.", nodeIdent);
316 /* Getter internal Statistic Manager Job Classes */
318 public StatRpcMsgManager getRpcMsgManager() {
319 return rpcMsgManager;
323 public StatNodeRegistration getNodeRegistrator() {
324 return nodeRegistrator;
328 public StatListeningCommiter<Flow, OpendaylightFlowStatisticsListener> getFlowListenComit() {
329 return flowListeningCommiter;
333 public StatListeningCommiter<Meter, OpendaylightMeterStatisticsListener> getMeterListenCommit() {
334 return meterListeningCommiter;
338 public StatListeningCommiter<Group, OpendaylightGroupStatisticsListener> getGroupListenCommit() {
339 return groupListeningCommiter;
343 public StatListeningCommiter<Queue, OpendaylightQueueStatisticsListener> getQueueNotifyCommit() {
344 return queueNotifyCommiter;
349 public StatNotifyCommiter<OpendaylightFlowTableStatisticsListener> getTableNotifCommit() {
350 return tableNotifCommiter;
354 public StatNotifyCommiter<OpendaylightPortStatisticsListener> getPortNotifyCommit() {
355 return portNotifyCommiter;