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 org.opendaylight.controller.md.sal.binding.api.DataBroker;
16 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
17 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
18 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
19 import org.opendaylight.controller.sal.binding.api.NotificationProviderService;
20 import org.opendaylight.openflowplugin.applications.statistics.manager.StatPermCollector.StatCapabTypes;
21 import org.opendaylight.openflowplugin.applications.statistics.manager.StatRpcMsgManager.TransactionCacheContainer;
22 import org.opendaylight.openflowplugin.applications.statistics.manager.StatisticsManager;
23 import org.opendaylight.openflowplugin.applications.statistics.manager.StatisticsManager.StatDataStoreOperation;
24 import org.opendaylight.openflowplugin.applications.statistics.manager.StatisticsManager.StatDataStoreOperation.StatsManagerOperationType;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionAware;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GroupDescStatsUpdated;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GroupFeaturesUpdated;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GroupStatisticsUpdated;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.NodeGroupDescStats;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.NodeGroupDescStatsBuilder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.NodeGroupFeatures;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.NodeGroupFeaturesBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.NodeGroupStatistics;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.NodeGroupStatisticsBuilder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.OpendaylightGroupStatisticsListener;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.group.desc.GroupDescBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.group.features.GroupFeatures;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.group.features.GroupFeaturesBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.group.statistics.GroupStatistics;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.group.statistics.GroupStatisticsBuilder;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.desc.stats.reply.GroupDescStats;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.statistics.reply.GroupStats;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupBuilder;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupKey;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
52 import org.opendaylight.yangtools.yang.binding.DataObject;
53 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
54 import org.slf4j.Logger;
55 import org.slf4j.LoggerFactory;
57 import com.google.common.base.Optional;
58 import com.google.common.base.Preconditions;
62 * org.opendaylight.openflowplugin.applications.statistics.manager.impl
64 * StatListenCommitGroup
65 * Class is a NotifyListener for GroupStatistics and DataChangeListener for Config/DataStore for Group node.
66 * All expected (registered) GroupStatistics will be builded and commit to Operational/DataStore.
67 * DataChangeEven should call create/delete Group in Operational/DS
69 * @author <a href="mailto:vdemcak@cisco.com">Vaclav Demcak</a>
72 public class StatListenCommitGroup extends StatAbstractListenCommit<Group, OpendaylightGroupStatisticsListener>
73 implements OpendaylightGroupStatisticsListener {
75 private static final Logger LOG = LoggerFactory.getLogger(StatListenCommitMeter.class);
77 public StatListenCommitGroup(final StatisticsManager manager, final DataBroker db,
78 final NotificationProviderService nps) {
79 super(manager, db, nps, Group.class);
83 protected OpendaylightGroupStatisticsListener getStatNotificationListener() {
88 protected InstanceIdentifier<Group> getWildCardedRegistrationPath() {
89 return InstanceIdentifier.create(Nodes.class).child(Node.class)
90 .augmentation(FlowCapableNode.class).child(Group.class);
94 public void onGroupDescStatsUpdated(final GroupDescStatsUpdated notification) {
95 final TransactionId transId = notification.getTransactionId();
96 final NodeId nodeId = notification.getId();
97 if ( ! isExpectedStatistics(transId, nodeId)) {
98 LOG.debug("Unregistred notification detect TransactionId {}", transId);
101 manager.getRpcMsgManager().addNotification(notification, nodeId);
102 if (notification.isMoreReplies()) {
106 /* Don't block RPC Notification thread */
107 manager.enqueue(new StatDataStoreOperation(StatsManagerOperationType.DATA_COMMIT_OPER_DS,nodeId) {
109 public void applyOperation(final ReadWriteTransaction tx) {
110 final InstanceIdentifier<Node> nodeIdent = InstanceIdentifier
111 .create(Nodes.class).child(Node.class, new NodeKey(nodeId));
112 /* Validate exist FlowCapableNode */
113 final InstanceIdentifier<FlowCapableNode> fNodeIdent = nodeIdent.augmentation(FlowCapableNode.class);
114 Optional<FlowCapableNode> fNode = Optional.absent();
116 fNode = tx.read(LogicalDatastoreType.OPERATIONAL,fNodeIdent).checkedGet();
118 catch (final ReadFailedException e) {
119 LOG.debug("Read Operational/DS for FlowCapableNode fail! {}", fNodeIdent, e);
121 if ( ! fNode.isPresent()) {
124 /* Get and Validate TransactionCacheContainer */
125 final Optional<TransactionCacheContainer<?>> txContainer = getTransactionCacheContainer(transId, nodeId);
126 if ( ! isTransactionCacheContainerValid(txContainer)) {
129 /* Prepare List actual Groups and not updated Groups will be removed */
130 final List<Group> existGroups = fNode.get().getGroup() != null
131 ? fNode.get().getGroup() : Collections.<Group> emptyList();
132 final List<GroupKey> existGroupKeys = new ArrayList<>();
133 for (final Group group : existGroups) {
134 existGroupKeys.add(group.getKey());
136 /* GroupDesc processing */
137 statGroupDescCommit(txContainer, tx, fNodeIdent, existGroupKeys);
138 /* Delete all not presented Group Nodes */
139 deleteAllNotPresentNode(fNodeIdent, tx, Collections.unmodifiableList(existGroupKeys));
140 /* Notification for continue collecting statistics */
141 notifyToCollectNextStatistics(nodeIdent, transId);
147 public void onGroupFeaturesUpdated(final GroupFeaturesUpdated notification) {
148 Preconditions.checkNotNull(notification);
149 final TransactionId transId = notification.getTransactionId();
150 final NodeId nodeId = notification.getId();
151 if ( ! isExpectedStatistics(transId, nodeId)) {
152 LOG.debug("Unregistred notification detect TransactionId {}", transId);
155 manager.getRpcMsgManager().addNotification(notification, nodeId);
156 if (notification.isMoreReplies()) {
160 /* Don't block RPC Notification thread */
161 manager.enqueue(new StatDataStoreOperation(StatsManagerOperationType.DATA_COMMIT_OPER_DS,nodeId) {
163 public void applyOperation(final ReadWriteTransaction tx) {
164 /* Get and Validate TransactionCacheContainer */
165 final Optional<TransactionCacheContainer<?>> txContainer = getTransactionCacheContainer(transId, nodeId);
166 if ( ! isTransactionCacheContainerValid(txContainer)) {
170 final InstanceIdentifier<Node> nodeIdent = InstanceIdentifier
171 .create(Nodes.class).child(Node.class, new NodeKey(nodeId));
173 final List<? extends TransactionAware> cacheNotifs = txContainer.get().getNotifications();
174 for (final TransactionAware notif : cacheNotifs) {
175 if ( ! (notif instanceof GroupFeaturesUpdated)) {
178 final GroupFeatures stats = new GroupFeaturesBuilder((GroupFeaturesUpdated)notif).build();
179 final InstanceIdentifier<NodeGroupFeatures> nodeGroupFeatureIdent =
180 nodeIdent.augmentation(NodeGroupFeatures.class);
181 final InstanceIdentifier<GroupFeatures> groupFeatureIdent = nodeGroupFeatureIdent
182 .child(GroupFeatures.class);
183 Optional<Node> node = Optional.absent();
185 node = tx.read(LogicalDatastoreType.OPERATIONAL, nodeIdent).checkedGet();
187 catch (final ReadFailedException e) {
188 LOG.debug("Read Operational/DS for Node fail! {}", nodeIdent, e);
190 if (node.isPresent()) {
191 tx.merge(LogicalDatastoreType.OPERATIONAL, nodeGroupFeatureIdent, new NodeGroupFeaturesBuilder().build(), true);
192 tx.put(LogicalDatastoreType.OPERATIONAL, groupFeatureIdent, stats);
193 manager.registerAdditionalNodeFeature(nodeIdent, StatCapabTypes.GROUP_STATS);
201 public void onGroupStatisticsUpdated(final GroupStatisticsUpdated notification) {
202 Preconditions.checkNotNull(notification);
203 final TransactionId transId = notification.getTransactionId();
204 final NodeId nodeId = notification.getId();
205 if ( ! isExpectedStatistics(transId, nodeId)) {
206 LOG.debug("STAT-MANAGER - GroupStatisticsUpdated: unregistred notification detect TransactionId {}", transId);
209 manager.getRpcMsgManager().addNotification(notification, nodeId);
210 if (notification.isMoreReplies()) {
214 /* Don't block RPC Notification thread */
215 manager.enqueue(new StatDataStoreOperation(StatsManagerOperationType.DATA_COMMIT_OPER_DS,nodeId) {
217 public void applyOperation(final ReadWriteTransaction tx) {
219 final InstanceIdentifier<Node> nodeIdent = InstanceIdentifier
220 .create(Nodes.class).child(Node.class, new NodeKey(nodeId));
221 /* Node exist check */
222 Optional<Node> node = Optional.absent();
224 node = tx.read(LogicalDatastoreType.OPERATIONAL, nodeIdent).checkedGet();
226 catch (final ReadFailedException e) {
227 LOG.debug("Read Operational/DS for Node fail! {}", nodeIdent, e);
229 if ( ! node.isPresent()) {
233 /* Get and Validate TransactionCacheContainer */
234 final Optional<TransactionCacheContainer<?>> txContainer = getTransactionCacheContainer(transId, nodeId);
235 if ( ! isTransactionCacheContainerValid(txContainer)) {
238 final List<? extends TransactionAware> cacheNotifs = txContainer.get().getNotifications();
240 Optional<Group> notifGroup = Optional.absent();
241 final Optional<? extends DataObject> inputObj = txContainer.get().getConfInput();
242 if (inputObj.isPresent() && inputObj.get() instanceof Group) {
243 notifGroup = Optional.<Group> of((Group)inputObj.get());
245 for (final TransactionAware notif : cacheNotifs) {
246 if ( ! (notif instanceof GroupStatisticsUpdated)) {
249 statGroupCommit(((GroupStatisticsUpdated) notif).getGroupStats(), nodeIdent, tx);
251 if ( ! notifGroup.isPresent()) {
252 notifyToCollectNextStatistics(nodeIdent, transId);
258 private void statGroupCommit(final List<GroupStats> groupStats, final InstanceIdentifier<Node> nodeIdent,
259 final ReadWriteTransaction tx) {
261 Preconditions.checkNotNull(groupStats);
262 Preconditions.checkNotNull(nodeIdent);
263 Preconditions.checkNotNull(tx);
265 final InstanceIdentifier<FlowCapableNode> fNodeIdent = nodeIdent.augmentation(FlowCapableNode.class);
267 for (final GroupStats gStat : groupStats) {
268 final GroupStatistics stats = new GroupStatisticsBuilder(gStat).build();
270 final InstanceIdentifier<Group> groupIdent = fNodeIdent.child(Group.class, new GroupKey(gStat.getGroupId()));
271 final InstanceIdentifier<NodeGroupStatistics> nGroupStatIdent =groupIdent
272 .augmentation(NodeGroupStatistics.class);
273 final InstanceIdentifier<GroupStatistics> gsIdent = nGroupStatIdent.child(GroupStatistics.class);
274 /* Statistics Writing */
275 Optional<Group> group = Optional.absent();
277 group = tx.read(LogicalDatastoreType.OPERATIONAL, groupIdent).checkedGet();
279 catch (final ReadFailedException e) {
280 LOG.debug("Read Operational/DS for Group node fail! {}", groupIdent, e);
282 if (group.isPresent()) {
283 tx.merge(LogicalDatastoreType.OPERATIONAL, nGroupStatIdent, new NodeGroupStatisticsBuilder().build(), true);
284 tx.put(LogicalDatastoreType.OPERATIONAL, gsIdent, stats);
289 private void statGroupDescCommit(final Optional<TransactionCacheContainer<?>> txContainer, final ReadWriteTransaction tx,
290 final InstanceIdentifier<FlowCapableNode> fNodeIdent, final List<GroupKey> existGroupKeys) {
292 Preconditions.checkNotNull(existGroupKeys);
293 Preconditions.checkNotNull(txContainer);
294 Preconditions.checkNotNull(fNodeIdent);
295 Preconditions.checkNotNull(tx);
297 final List<? extends TransactionAware> cacheNotifs = txContainer.get().getNotifications();
298 for (final TransactionAware notif : cacheNotifs) {
299 if ( ! (notif instanceof GroupDescStatsUpdated)) {
302 final List<GroupDescStats> groupStats = ((GroupDescStatsUpdated) notif).getGroupDescStats();
303 if (groupStats == null) {
306 for (final GroupDescStats group : groupStats) {
307 if (group.getGroupId() != null) {
308 final GroupBuilder groupBuilder = new GroupBuilder(group);
309 final GroupKey groupKey = new GroupKey(group.getGroupId());
310 final InstanceIdentifier<Group> groupRef = fNodeIdent.child(Group.class,groupKey);
312 final NodeGroupDescStatsBuilder groupDesc= new NodeGroupDescStatsBuilder();
313 groupDesc.setGroupDesc(new GroupDescBuilder(group).build());
314 //Update augmented data
315 groupBuilder.addAugmentation(NodeGroupDescStats.class, groupDesc.build());
316 existGroupKeys.remove(groupKey);
317 tx.put(LogicalDatastoreType.OPERATIONAL, groupRef, groupBuilder.build());
323 private void deleteAllNotPresentNode(final InstanceIdentifier<FlowCapableNode> fNodeIdent,
324 final ReadWriteTransaction trans, final List<GroupKey> deviceGroupKeys) {
326 Preconditions.checkNotNull(fNodeIdent);
327 Preconditions.checkNotNull(trans);
329 if (deviceGroupKeys == null) {
333 for (final GroupKey key : deviceGroupKeys) {
334 final InstanceIdentifier<Group> delGroupIdent = fNodeIdent.child(Group.class, key);
335 LOG.trace("Group {} has to removed.", key);
336 Optional<Group> delGroup = Optional.absent();
338 delGroup = trans.read(LogicalDatastoreType.OPERATIONAL, delGroupIdent).checkedGet();
340 catch (final ReadFailedException e) {
341 // NOOP - probably another transaction delete that node
342 LOG.debug("Group {} was probably deleted via other transaction. Exception {}", delGroupIdent, e);
344 if (delGroup.isPresent()) {
345 trans.delete(LogicalDatastoreType.OPERATIONAL, delGroupIdent);