applications/statistics-manager/src/main/java/org/opendaylight/openflowplugin/applications/statistics/manager/impl/StatListenCommitGroup.java

   1 /**
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.openflowplugin.applications.statistics.manager.impl;
  10
  11 import java.util.ArrayList;
  12 import java.util.Collections;
  13 import java.util.List;
  14
  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.transaction.rev150304.TransactionAware;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GroupDescStatsUpdated;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GroupFeaturesUpdated;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GroupStatisticsUpdated;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.NodeGroupDescStats;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.NodeGroupDescStatsBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.NodeGroupFeatures;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.NodeGroupFeaturesBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.NodeGroupStatistics;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.NodeGroupStatisticsBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.OpendaylightGroupStatisticsListener;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.group.desc.GroupDescBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.group.features.GroupFeatures;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.group.features.GroupFeaturesBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.group.statistics.GroupStatistics;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.group.statistics.GroupStatisticsBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.desc.stats.reply.GroupDescStats;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.statistics.reply.GroupStats;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupKey;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  54 import org.opendaylight.yangtools.yang.binding.DataObject;
  55 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  56 import org.slf4j.Logger;
  57 import org.slf4j.LoggerFactory;
  58
  59 import com.google.common.base.Optional;
  60 import com.google.common.base.Preconditions;
  61
  62 /**
  63  * statistics-manager
  64  * org.opendaylight.openflowplugin.applications.statistics.manager.impl
  65  *
  66  * StatListenCommitGroup
  67  * Class is a NotifyListener for GroupStatistics and DataTreeChangeListener for Config/DataStore for Group node.
  68  * All expected (registered) GroupStatistics will be builded and commit to Operational/DataStore.
  69  * DataTreeModification should call create/delete Group in Operational/DS
  70  */
  71 public class StatListenCommitGroup extends StatAbstractListenCommit<Group, OpendaylightGroupStatisticsListener>
  72                                                     implements OpendaylightGroupStatisticsListener {
  73
  74     private static final Logger LOG = LoggerFactory.getLogger(StatListenCommitGroup.class);
  75
  76     public StatListenCommitGroup(final StatisticsManager manager,  final DataBroker db,
  77             final NotificationProviderService nps,
  78                                  final StatNodeRegistration nrm) {
  79         super(manager, db, nps, Group.class,nrm);
  80     }
  81
  82     @Override
  83     protected OpendaylightGroupStatisticsListener getStatNotificationListener() {
  84         return this;
  85     }
  86
  87     @Override
  88     protected InstanceIdentifier<Group> getWildCardedRegistrationPath() {
  89         return InstanceIdentifier.create(Nodes.class).child(Node.class)
  90                 .augmentation(FlowCapableNode.class).child(Group.class);
  91     }
  92
  93     @Override
  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);
  99             return;
 100         }
 101         manager.getRpcMsgManager().addNotification(notification, nodeId);
 102         if (notification.isMoreReplies()) {
 103             return;
 104         }
 105
 106         /* Don't block RPC Notification thread */
 107         manager.enqueue(new StatDataStoreOperation(StatsManagerOperationType.DATA_COMMIT_OPER_DS,nodeId) {
 108             @Override
 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();
 115                 try {
 116                     fNode = tx.read(LogicalDatastoreType.OPERATIONAL,fNodeIdent).checkedGet();
 117                 }
 118                 catch (final ReadFailedException e) {
 119                     LOG.debug("Read Operational/DS for FlowCapableNode fail! {}", fNodeIdent, e);
 120                 }
 121                 if ( ! fNode.isPresent()) {
 122                     return;
 123                 }
 124                 /* Get and Validate TransactionCacheContainer */
 125                 final Optional<TransactionCacheContainer<?>> txContainer = getTransactionCacheContainer(transId, nodeId);
 126                 if ( ! isTransactionCacheContainerValid(txContainer)) {
 127                     return;
 128                 }
 129
 130                 if(!nodeRegistrationManager.isFlowCapableNodeOwner(nodeId)) { return; }
 131
 132                 /* Prepare List actual Groups and not updated Groups will be removed */
 133                 final List<Group> existGroups = fNode.get().getGroup() != null
 134                         ? fNode.get().getGroup() : Collections.<Group> emptyList();
 135                 final List<GroupKey> existGroupKeys = new ArrayList<>();
 136                 for (final Group group : existGroups) {
 137                     existGroupKeys.add(group.getKey());
 138                 }
 139                 /* GroupDesc processing */
 140                 statGroupDescCommit(txContainer, tx, fNodeIdent, existGroupKeys);
 141                 /* Delete all not presented Group Nodes */
 142                 deleteAllNotPresentNode(fNodeIdent, tx, Collections.unmodifiableList(existGroupKeys));
 143                 /* Notification for continue collecting statistics */
 144                 notifyToCollectNextStatistics(nodeIdent, transId);
 145             }
 146
 147             @Override
 148             public UUID generatedUUIDForNode() {
 149                 return manager.getGeneratedUUIDForNode(getNodeIdentifier());
 150             }
 151         });
 152     }
 153
 154     @Override
 155     public void onGroupFeaturesUpdated(final GroupFeaturesUpdated notification) {
 156         Preconditions.checkNotNull(notification);
 157         final TransactionId transId = notification.getTransactionId();
 158         final NodeId nodeId = notification.getId();
 159         if ( ! isExpectedStatistics(transId, nodeId)) {
 160             LOG.debug("Unregistred notification detect TransactionId {}", transId);
 161             return;
 162         }
 163         manager.getRpcMsgManager().addNotification(notification, nodeId);
 164         if (notification.isMoreReplies()) {
 165             return;
 166         }
 167
 168         /* Don't block RPC Notification thread */
 169         manager.enqueue(new StatDataStoreOperation(StatsManagerOperationType.DATA_COMMIT_OPER_DS,nodeId) {
 170             @Override
 171             public void applyOperation(final ReadWriteTransaction tx) {
 172                 /* Get and Validate TransactionCacheContainer */
 173                 final Optional<TransactionCacheContainer<?>> txContainer = getTransactionCacheContainer(transId, nodeId);
 174                 if ( ! isTransactionCacheContainerValid(txContainer)) {
 175                     return;
 176                 }
 177
 178                 final InstanceIdentifier<Node> nodeIdent = InstanceIdentifier
 179                         .create(Nodes.class).child(Node.class, new NodeKey(nodeId));
 180
 181                 manager.registerAdditionalNodeFeature(nodeIdent, StatCapabTypes.GROUP_STATS);
 182
 183                 if(!nodeRegistrationManager.isFlowCapableNodeOwner(nodeId)) { return; }
 184
 185                 final List<? extends TransactionAware> cacheNotifs = txContainer.get().getNotifications();
 186                 for (final TransactionAware notif : cacheNotifs) {
 187                     if ( ! (notif instanceof GroupFeaturesUpdated)) {
 188                         break;
 189                     }
 190                     final GroupFeatures stats = new GroupFeaturesBuilder((GroupFeaturesUpdated)notif).build();
 191                     final InstanceIdentifier<NodeGroupFeatures> nodeGroupFeatureIdent =
 192                             nodeIdent.augmentation(NodeGroupFeatures.class);
 193                     final InstanceIdentifier<GroupFeatures> groupFeatureIdent = nodeGroupFeatureIdent
 194                             .child(GroupFeatures.class);
 195                     Optional<Node> node = Optional.absent();
 196                     try {
 197                         node = tx.read(LogicalDatastoreType.OPERATIONAL, nodeIdent).checkedGet();
 198                     }
 199                     catch (final ReadFailedException e) {
 200                         LOG.debug("Read Operational/DS for Node fail! {}", nodeIdent, e);
 201                     }
 202                     if (node.isPresent()) {
 203                         tx.merge(LogicalDatastoreType.OPERATIONAL, nodeGroupFeatureIdent, new NodeGroupFeaturesBuilder().build(), true);
 204                         tx.put(LogicalDatastoreType.OPERATIONAL, groupFeatureIdent, stats);
 205                         manager.unregisterNodeStats(nodeIdent, StatCapabTypes.GROUP_FEATURE_STATS);
 206                     } else {
 207                         LOG.debug("Node {} is NOT present in the operational data store",nodeId);
 208                     }
 209                 }
 210             }
 211
 212             @Override
 213             public UUID generatedUUIDForNode() {
 214                 return manager.getGeneratedUUIDForNode(getNodeIdentifier());
 215             }
 216         });
 217     }
 218
 219     @Override
 220     public void onGroupStatisticsUpdated(final GroupStatisticsUpdated notification) {
 221         Preconditions.checkNotNull(notification);
 222         final TransactionId transId = notification.getTransactionId();
 223         final NodeId nodeId = notification.getId();
 224         if ( ! isExpectedStatistics(transId, nodeId)) {
 225             LOG.debug("STAT-MANAGER - GroupStatisticsUpdated: unregistred notification detect TransactionId {}", transId);
 226             return;
 227         }
 228         manager.getRpcMsgManager().addNotification(notification, nodeId);
 229         if (notification.isMoreReplies()) {
 230             return;
 231         }
 232
 233         /* Don't block RPC Notification thread */
 234         manager.enqueue(new StatDataStoreOperation(StatsManagerOperationType.DATA_COMMIT_OPER_DS,nodeId) {
 235             @Override
 236             public void applyOperation(final ReadWriteTransaction tx) {
 237
 238                 final InstanceIdentifier<Node> nodeIdent = InstanceIdentifier
 239                         .create(Nodes.class).child(Node.class, new NodeKey(nodeId));
 240                 /* Node exist check */
 241                 Optional<Node> node = Optional.absent();
 242                 try {
 243                     node = tx.read(LogicalDatastoreType.OPERATIONAL, nodeIdent).checkedGet();
 244                 }
 245                 catch (final ReadFailedException e) {
 246                     LOG.debug("Read Operational/DS for Node fail! {}", nodeIdent, e);
 247                 }
 248                 if ( ! node.isPresent()) {
 249                     return;
 250                 }
 251
 252                 /* Get and Validate TransactionCacheContainer */
 253                 final Optional<TransactionCacheContainer<?>> txContainer = getTransactionCacheContainer(transId, nodeId);
 254                 if ( ! isTransactionCacheContainerValid(txContainer)) {
 255                     return;
 256                 }
 257
 258                 if(!nodeRegistrationManager.isFlowCapableNodeOwner(nodeId)) { return; }
 259
 260                 final List<? extends TransactionAware> cacheNotifs = txContainer.get().getNotifications();
 261
 262                 Optional<Group> notifGroup = Optional.absent();
 263                 final Optional<? extends DataObject> inputObj = txContainer.get().getConfInput();
 264                 if (inputObj.isPresent() && inputObj.get() instanceof Group) {
 265                     notifGroup = Optional.<Group> of((Group)inputObj.get());
 266                 }
 267                 for (final TransactionAware notif : cacheNotifs) {
 268                     if ( ! (notif instanceof GroupStatisticsUpdated)) {
 269                         break;
 270                     }
 271                     statGroupCommit(((GroupStatisticsUpdated) notif).getGroupStats(), nodeIdent, tx);
 272                 }
 273                 if ( ! notifGroup.isPresent()) {
 274                     notifyToCollectNextStatistics(nodeIdent, transId);
 275                 }
 276             }
 277
 278             public UUID generatedUUIDForNode() {
 279                 return manager.getGeneratedUUIDForNode(getNodeIdentifier());
 280             }
 281         });
 282     }
 283
 284     private void statGroupCommit(final List<GroupStats> groupStats, final InstanceIdentifier<Node> nodeIdent,
 285             final ReadWriteTransaction tx) {
 286
 287         Preconditions.checkNotNull(groupStats);
 288         Preconditions.checkNotNull(nodeIdent);
 289         Preconditions.checkNotNull(tx);
 290
 291         final InstanceIdentifier<FlowCapableNode> fNodeIdent = nodeIdent.augmentation(FlowCapableNode.class);
 292
 293         for (final GroupStats gStat : groupStats) {
 294             final GroupStatistics stats = new GroupStatisticsBuilder(gStat).build();
 295
 296             final InstanceIdentifier<Group> groupIdent = fNodeIdent.child(Group.class, new GroupKey(gStat.getGroupId()));
 297             final InstanceIdentifier<NodeGroupStatistics> nGroupStatIdent =groupIdent
 298                     .augmentation(NodeGroupStatistics.class);
 299             final InstanceIdentifier<GroupStatistics> gsIdent = nGroupStatIdent.child(GroupStatistics.class);
 300             /* Statistics Writing */
 301             Optional<Group> group = Optional.absent();
 302             try {
 303                 group = tx.read(LogicalDatastoreType.OPERATIONAL, groupIdent).checkedGet();
 304             }
 305             catch (final ReadFailedException e) {
 306                 LOG.debug("Read Operational/DS for Group node fail! {}", groupIdent, e);
 307             }
 308             if (group.isPresent()) {
 309                 tx.merge(LogicalDatastoreType.OPERATIONAL, nGroupStatIdent, new NodeGroupStatisticsBuilder().build(), true);
 310                 tx.put(LogicalDatastoreType.OPERATIONAL, gsIdent, stats);
 311             }
 312         }
 313     }
 314
 315     private void statGroupDescCommit(final Optional<TransactionCacheContainer<?>> txContainer, final ReadWriteTransaction tx,
 316             final InstanceIdentifier<FlowCapableNode> fNodeIdent, final List<GroupKey> existGroupKeys) {
 317
 318         Preconditions.checkNotNull(existGroupKeys);
 319         Preconditions.checkNotNull(txContainer);
 320         Preconditions.checkNotNull(fNodeIdent);
 321         Preconditions.checkNotNull(tx);
 322
 323         final List<? extends TransactionAware> cacheNotifs = txContainer.get().getNotifications();
 324         for (final TransactionAware notif : cacheNotifs) {
 325             if ( ! (notif instanceof GroupDescStatsUpdated)) {
 326                 break;
 327             }
 328             final List<GroupDescStats> groupStats = ((GroupDescStatsUpdated) notif).getGroupDescStats();
 329             if (groupStats == null) {
 330                 break;
 331             }
 332             for (final GroupDescStats group : groupStats) {
 333                 if (group.getGroupId() != null) {
 334                     final GroupBuilder groupBuilder = new GroupBuilder(group);
 335                     final GroupKey groupKey = new GroupKey(group.getGroupId());
 336                     final InstanceIdentifier<Group> groupRef = fNodeIdent.child(Group.class,groupKey);
 337
 338                     final NodeGroupDescStatsBuilder groupDesc= new NodeGroupDescStatsBuilder();
 339                     groupDesc.setGroupDesc(new GroupDescBuilder(group).build());
 340                     //Update augmented data
 341                     groupBuilder.addAugmentation(NodeGroupDescStats.class, groupDesc.build());
 342                     existGroupKeys.remove(groupKey);
 343                     tx.put(LogicalDatastoreType.OPERATIONAL, groupRef, groupBuilder.build());
 344                 }
 345             }
 346         }
 347     }
 348
 349     private void deleteAllNotPresentNode(final InstanceIdentifier<FlowCapableNode> fNodeIdent,
 350             final ReadWriteTransaction trans, final List<GroupKey> deviceGroupKeys) {
 351
 352         Preconditions.checkNotNull(fNodeIdent);
 353         Preconditions.checkNotNull(trans);
 354
 355         if (deviceGroupKeys == null) {
 356             return;
 357         }
 358
 359         for (final GroupKey key : deviceGroupKeys) {
 360             final InstanceIdentifier<Group> delGroupIdent = fNodeIdent.child(Group.class, key);
 361             LOG.trace("Group {} has to removed.", key);
 362             Optional<Group> delGroup = Optional.absent();
 363             try {
 364                 delGroup = trans.read(LogicalDatastoreType.OPERATIONAL, delGroupIdent).checkedGet();
 365             }
 366             catch (final ReadFailedException e) {
 367                 // NOOP - probably another transaction delete that node
 368                 LOG.debug("Group {} was probably deleted via other transaction. Exception {}", delGroupIdent, e);
 369             }
 370             if (delGroup.isPresent()) {
 371                 trans.delete(LogicalDatastoreType.OPERATIONAL, delGroupIdent);
 372             }
 373         }
 374     }
 375 }
 376