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.openflowplugin.applications.statistics.manager.impl;
11 import java.util.ArrayList;
12 import java.util.Collections;
13 import java.util.List;
15 import java.util.UUID;
16 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
17 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
18 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
19 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
20 import org.opendaylight.controller.sal.binding.api.NotificationProviderService;
21 import org.opendaylight.openflowplugin.applications.statistics.manager.StatNodeRegistration;
22 import org.opendaylight.openflowplugin.applications.statistics.manager.StatPermCollector.StatCapabTypes;
23 import org.opendaylight.openflowplugin.applications.statistics.manager.StatRpcMsgManager.TransactionCacheContainer;
24 import org.opendaylight.openflowplugin.applications.statistics.manager.StatisticsManager;
25 import org.opendaylight.openflowplugin.applications.statistics.manager.StatisticsManager.StatDataStoreOperation;
26 import org.opendaylight.openflowplugin.applications.statistics.manager.StatisticsManager.StatDataStoreOperation.StatsManagerOperationType;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.Meter;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.MeterBuilder;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.MeterKey;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionAware;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.MeterConfigStatsUpdated;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.MeterFeaturesUpdated;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.MeterStatisticsUpdated;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.NodeMeterConfigStats;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.NodeMeterConfigStatsBuilder;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.NodeMeterFeatures;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.NodeMeterFeaturesBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.NodeMeterStatistics;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.NodeMeterStatisticsBuilder;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.OpendaylightMeterStatisticsListener;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.nodes.node.MeterFeatures;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.nodes.node.MeterFeaturesBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.nodes.node.meter.MeterConfigStatsBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.nodes.node.meter.MeterStatistics;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.nodes.node.meter.MeterStatisticsBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.config.stats.reply.MeterConfigStats;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.statistics.reply.MeterStats;
55 import org.opendaylight.yangtools.yang.binding.DataObject;
56 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
57 import org.slf4j.Logger;
58 import org.slf4j.LoggerFactory;
60 import com.google.common.base.Optional;
61 import com.google.common.base.Preconditions;
65 * org.opendaylight.openflowplugin.applications.statistics.manager.impl
67 * StatListenCommitMeter
68 * Class is a NotifyListener for MeterStatistics and DataChangeListener for Config/DataStore for Meter node.
69 * All expected (registered) MeterStatistics will be builded and commit to Operational/DataStore.
70 * DataChangeEven should call create/delete Meter in Operational/DS
73 public class StatListenCommitMeter extends StatAbstractListenCommit<Meter, OpendaylightMeterStatisticsListener>
74 implements OpendaylightMeterStatisticsListener {
76 private static final Logger LOG = LoggerFactory.getLogger(StatListenCommitMeter.class);
78 public StatListenCommitMeter(final StatisticsManager manager, final DataBroker db,
79 final NotificationProviderService nps,
80 final StatNodeRegistration nrm) {
81 super(manager, db, nps, Meter.class,nrm);
85 protected InstanceIdentifier<Meter> getWildCardedRegistrationPath() {
86 return InstanceIdentifier.create(Nodes.class).child(Node.class)
87 .augmentation(FlowCapableNode.class).child(Meter.class);
91 protected OpendaylightMeterStatisticsListener getStatNotificationListener() {
96 public void onMeterConfigStatsUpdated(final MeterConfigStatsUpdated notification) {
97 final TransactionId transId = notification.getTransactionId();
98 final NodeId nodeId = notification.getId();
99 if ( ! isExpectedStatistics(transId, nodeId)) {
100 LOG.debug("STAT-MANAGER - MeterConfigStatsUpdated: unregistred notification detect TransactionId {}", transId);
103 manager.getRpcMsgManager().addNotification(notification, nodeId);
104 if (notification.isMoreReplies()) {
108 /* Don't block RPC Notification thread */
109 manager.enqueue(new StatDataStoreOperation(StatsManagerOperationType.DATA_COMMIT_OPER_DS,nodeId) {
111 public void applyOperation(final ReadWriteTransaction tx) {
113 final InstanceIdentifier<Node> nodeIdent = InstanceIdentifier
114 .create(Nodes.class).child(Node.class, new NodeKey(nodeId));
116 /* Validate exist FlowCapableNode */
117 final InstanceIdentifier<FlowCapableNode> fNodeIdent = nodeIdent.augmentation(FlowCapableNode.class);
118 Optional<FlowCapableNode> fNode = Optional.absent();
120 fNode = tx.read(LogicalDatastoreType.OPERATIONAL,fNodeIdent).checkedGet();
122 catch (final ReadFailedException e) {
123 LOG.debug("Read Operational/DS for FlowCapableNode fail! {}", fNodeIdent, e);
125 if ( ! fNode.isPresent()) {
128 /* Get and Validate TransactionCacheContainer */
129 final Optional<TransactionCacheContainer<?>> txContainer = getTransactionCacheContainer(transId, nodeId);
130 if ( ! isTransactionCacheContainerValid(txContainer)) {
134 if(!nodeRegistrationManager.isFlowCapableNodeOwner(nodeId)) { return; }
135 /* Prepare List actual Meters and not updated Meters will be removed */
136 final List<Meter> existMeters = fNode.get().getMeter() != null
137 ? fNode.get().getMeter() : Collections.<Meter> emptyList();
138 final List<MeterKey> existMeterKeys = new ArrayList<>();
139 for (final Meter meter : existMeters) {
140 existMeterKeys.add(meter.getKey());
142 /* MeterConfig processing */
143 comitConfMeterStats(txContainer, tx, fNodeIdent, existMeterKeys);
144 /* Delete all not presented Meter Nodes */
145 deleteAllNotPresentedNodes(fNodeIdent, tx, Collections.unmodifiableList(existMeterKeys));
146 /* Notification for continue collecting statistics */
147 notifyToCollectNextStatistics(nodeIdent, transId);
150 public UUID generatedUUIDForNode() {
151 return manager.getGeneratedUUIDForNode(getNodeIdentifier());
157 public void onMeterFeaturesUpdated(final MeterFeaturesUpdated notification) {
158 Preconditions.checkNotNull(notification);
159 final TransactionId transId = notification.getTransactionId();
160 final NodeId nodeId = notification.getId();
161 if ( ! isExpectedStatistics(transId, nodeId)) {
162 LOG.debug("STAT-MANAGER - MeterFeaturesUpdated: unregistred notification detect TransactionId {}", transId);
165 manager.getRpcMsgManager().addNotification(notification, nodeId);
166 if (notification.isMoreReplies()) {
170 /* Don't block RPC Notification thread */
171 manager.enqueue(new StatDataStoreOperation(StatsManagerOperationType.DATA_COMMIT_OPER_DS,nodeId) {
173 public void applyOperation(final ReadWriteTransaction tx) {
174 /* Get and Validate TransactionCacheContainer */
175 final Optional<TransactionCacheContainer<?>> txContainer = getTransactionCacheContainer(transId, nodeId);
176 if ( ! isTransactionCacheContainerValid(txContainer)) {
180 final InstanceIdentifier<Node> nodeIdent = InstanceIdentifier
181 .create(Nodes.class).child(Node.class, new NodeKey(nodeId));
183 //Register meter feature irrespective of whether this instance is
184 //master instance of the device or not. In cluster mode, all instances
185 // should have knowledge if meter is supported by the device.
186 manager.registerAdditionalNodeFeature(nodeIdent, StatCapabTypes.METER_STATS);
188 if(!nodeRegistrationManager.isFlowCapableNodeOwner(nodeId)) { return; }
190 final List<? extends TransactionAware> cacheNotifs = txContainer.get().getNotifications();
191 for (final TransactionAware notif : cacheNotifs) {
192 if ( ! (notif instanceof MeterFeaturesUpdated)) {
195 final MeterFeatures stats = new MeterFeaturesBuilder((MeterFeaturesUpdated)notif).build();
196 final InstanceIdentifier<NodeMeterFeatures> nodeMeterFeatureIdent =
197 nodeIdent.augmentation(NodeMeterFeatures.class);
198 final InstanceIdentifier<MeterFeatures> meterFeatureIdent = nodeMeterFeatureIdent
199 .child(MeterFeatures.class);
200 Optional<Node> node = Optional.absent();
202 node = tx.read(LogicalDatastoreType.OPERATIONAL, nodeIdent).checkedGet();
204 catch (final ReadFailedException e) {
205 LOG.debug("Read Operational/DS for Node fail! {}", nodeIdent, e);
207 if (node.isPresent()) {
208 tx.merge(LogicalDatastoreType.OPERATIONAL, nodeMeterFeatureIdent, new NodeMeterFeaturesBuilder().build(), true);
209 tx.put(LogicalDatastoreType.OPERATIONAL, meterFeatureIdent, stats);
210 manager.unregisterNodeStats(nodeIdent, StatCapabTypes.METER_FEATURE_STATS);
212 LOG.debug("Node {} is NOT present in the operational data store",nodeId);
218 public UUID generatedUUIDForNode() {
219 return manager.getGeneratedUUIDForNode(getNodeIdentifier());
225 public void onMeterStatisticsUpdated(final MeterStatisticsUpdated notification) {
226 Preconditions.checkNotNull(notification);
227 final TransactionId transId = notification.getTransactionId();
228 final NodeId nodeId = notification.getId();
229 if ( ! isExpectedStatistics(transId, nodeId)) {
230 LOG.debug("STAT-MANAGER - MeterStatisticsUpdated: unregistred notification detect TransactionId {}", transId);
233 manager.getRpcMsgManager().addNotification(notification, nodeId);
234 if (notification.isMoreReplies()) {
238 /* Don't block RPC Notification thread */
239 manager.enqueue(new StatDataStoreOperation(StatsManagerOperationType.DATA_COMMIT_OPER_DS,nodeId) {
241 public void applyOperation(final ReadWriteTransaction tx) {
243 final InstanceIdentifier<Node> nodeIdent = InstanceIdentifier
244 .create(Nodes.class).child(Node.class, new NodeKey(nodeId));
245 /* Node exist check */
246 Optional<Node> node = Optional.absent();
248 node = tx.read(LogicalDatastoreType.OPERATIONAL, nodeIdent).checkedGet();
250 catch (final ReadFailedException e) {
251 LOG.debug("Read Operational/DS for Node fail! {}", nodeIdent, e);
253 if ( ! node.isPresent()) {
257 /* Get and Validate TransactionCacheContainer */
258 final Optional<TransactionCacheContainer<?>> txContainer = getTransactionCacheContainer(transId, nodeId);
259 if ( ! isTransactionCacheContainerValid(txContainer)) {
262 if(!nodeRegistrationManager.isFlowCapableNodeOwner(nodeId)) { return; }
264 final List<? extends TransactionAware> cacheNotifs = txContainer.get().getNotifications();
266 Optional<Meter> notifMeter = Optional.absent();
267 final Optional<? extends DataObject> inputObj = txContainer.get().getConfInput();
268 if (inputObj.isPresent() && inputObj.get() instanceof Meter) {
269 notifMeter = Optional.<Meter> of((Meter)inputObj.get());
271 for (final TransactionAware notif : cacheNotifs) {
272 if ( ! (notif instanceof MeterStatisticsUpdated)) {
275 statMeterCommit(((MeterStatisticsUpdated) notif).getMeterStats(), nodeIdent, tx);
277 if ( ! notifMeter.isPresent()) {
278 notifyToCollectNextStatistics(nodeIdent, transId);
283 public UUID generatedUUIDForNode() {
284 return manager.getGeneratedUUIDForNode(getNodeIdentifier());
289 private void statMeterCommit(final List<MeterStats> meterStats,
290 final InstanceIdentifier<Node> nodeIdent, final ReadWriteTransaction tx) {
292 Preconditions.checkNotNull(meterStats);
293 Preconditions.checkNotNull(nodeIdent);
294 Preconditions.checkNotNull(tx);
296 final InstanceIdentifier<FlowCapableNode> fNodeIdent = nodeIdent.augmentation(FlowCapableNode.class);
298 for (final MeterStats mStat : meterStats) {
299 final MeterStatistics stats = new MeterStatisticsBuilder(mStat).build();
301 final InstanceIdentifier<Meter> meterIdent = fNodeIdent.child(Meter.class, new MeterKey(mStat.getMeterId()));
302 final InstanceIdentifier<NodeMeterStatistics> nodeMeterStatIdent = meterIdent
303 .augmentation(NodeMeterStatistics.class);
304 final InstanceIdentifier<MeterStatistics> msIdent = nodeMeterStatIdent.child(MeterStatistics.class);
305 /* Meter Statistics commit */
306 Optional<Meter> meter = Optional.absent();
308 meter = tx.read(LogicalDatastoreType.OPERATIONAL, meterIdent).checkedGet();
310 catch (final ReadFailedException e) {
311 LOG.debug("Read Operational/DS for FlowCapableNode fail! {}", fNodeIdent, e);
313 if (meter.isPresent()) {
314 tx.merge(LogicalDatastoreType.OPERATIONAL, nodeMeterStatIdent, new NodeMeterStatisticsBuilder().build(), true);
315 tx.put(LogicalDatastoreType.OPERATIONAL, msIdent, stats);
320 private void comitConfMeterStats(final Optional<TransactionCacheContainer<?>> txContainer, final ReadWriteTransaction tx,
321 final InstanceIdentifier<FlowCapableNode> fNodeIdent, final List<MeterKey> existMeterKeys) {
323 Preconditions.checkNotNull(existMeterKeys);
324 Preconditions.checkNotNull(txContainer);
325 Preconditions.checkNotNull(fNodeIdent);
326 Preconditions.checkNotNull(tx);
328 final List<? extends TransactionAware> cacheNotifs = txContainer.get().getNotifications();
329 for (final TransactionAware notif : cacheNotifs) {
330 if ( ! (notif instanceof MeterConfigStatsUpdated)) {
333 final List<MeterConfigStats> meterStats = ((MeterConfigStatsUpdated) notif).getMeterConfigStats();
334 if (meterStats == null) {
337 for (final MeterConfigStats meterStat : meterStats) {
338 if (meterStat.getMeterId() != null) {
339 final MeterBuilder meterBuilder = new MeterBuilder(meterStat);
340 final MeterKey meterKey = new MeterKey(meterStat.getMeterId());
341 final InstanceIdentifier<Meter> meterRef = fNodeIdent.child(Meter.class, meterKey);
343 final NodeMeterConfigStatsBuilder meterConfig = new NodeMeterConfigStatsBuilder();
344 meterConfig.setMeterConfigStats(new MeterConfigStatsBuilder(meterStat).build());
345 //Update augmented data
346 meterBuilder.addAugmentation(NodeMeterConfigStats.class, meterConfig.build());
347 existMeterKeys.remove(meterKey);
348 tx.put(LogicalDatastoreType.OPERATIONAL, meterRef, meterBuilder.build());
354 private void deleteAllNotPresentedNodes(final InstanceIdentifier<FlowCapableNode> fNodeIdent,
355 final ReadWriteTransaction tx, final List<MeterKey> deviceMeterKeys) {
357 Preconditions.checkNotNull(fNodeIdent);
358 Preconditions.checkNotNull(tx);
360 if (deviceMeterKeys == null) {
364 for (final MeterKey key : deviceMeterKeys) {
365 final InstanceIdentifier<Meter> delMeterIdent = fNodeIdent.child(Meter.class, key);
366 LOG.trace("Meter {} has to removed.", key);
367 Optional<Meter> delMeter = Optional.absent();
369 delMeter = tx.read(LogicalDatastoreType.OPERATIONAL, delMeterIdent).checkedGet();
371 catch (final ReadFailedException e) {
372 // NOOP - probably another transaction delete that node
373 LOG.debug("Meter {} was probably deleted via other transaction. Exception {}", delMeterIdent, e);
375 if (delMeter.isPresent()) {
376 tx.delete(LogicalDatastoreType.OPERATIONAL, delMeterIdent);