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