opendaylight/md-sal/statistics-manager/src/main/java/org/opendaylight/controller/md/statistics/manager/impl/StatListenCommitQueue.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.controller.md.statistics.manager.impl;
  10
  11 import java.util.Collections;
  12 import java.util.HashMap;
  13 import java.util.List;
  14 import java.util.Map;
  15 import java.util.Map.Entry;
  16
  17 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  18 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  19 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  20 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  21 import org.opendaylight.controller.md.statistics.manager.StatRpcMsgManager.TransactionCacheContainer;
  22 import org.opendaylight.controller.md.statistics.manager.StatisticsManager;
  23 import org.opendaylight.controller.md.statistics.manager.StatisticsManager.StatDataStoreOperation;
  24 import org.opendaylight.controller.sal.binding.api.NotificationProviderService;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev131103.TransactionAware;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev131103.TransactionId;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.queues.Queue;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.queues.QueueBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.queues.QueueKey;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.FlowCapableNodeConnectorQueueStatisticsData;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.FlowCapableNodeConnectorQueueStatisticsDataBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.OpendaylightQueueStatisticsListener;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.QueueStatisticsUpdate;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.flow.capable.node.connector.queue.statistics.FlowCapableNodeConnectorQueueStatistics;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.flow.capable.node.connector.queue.statistics.FlowCapableNodeConnectorQueueStatisticsBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.queue.id.and.statistics.map.QueueIdAndStatisticsMap;
  44 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  45 import org.slf4j.Logger;
  46 import org.slf4j.LoggerFactory;
  47
  48 import com.google.common.base.Optional;
  49 import com.google.common.base.Preconditions;
  50
  51 /**
  52  * statistics-manager
  53  * org.opendaylight.controller.md.statistics.manager.impl
  54  *
  55  * StatNotifyCommitQueue
  56  * Class is a NotifyListner for Queues Statistics
  57  * All expected (registered) queueStatistics will be builded and
  58  * commit to Operational/DataStore
  59  *
  60  * @author <a href="mailto:vdemcak@cisco.com">Vaclav Demcak</a>
  61  *
  62  */
  63 public class StatListenCommitQueue extends StatAbstractListenCommit<Queue, OpendaylightQueueStatisticsListener>
  64                                         implements OpendaylightQueueStatisticsListener {
  65
  66     private final static Logger LOG = LoggerFactory.getLogger(StatListenCommitQueue.class);
  67
  68     public StatListenCommitQueue(final StatisticsManager manager, final DataBroker db,
  69             final NotificationProviderService nps) {
  70         super(manager, db, nps, Queue.class);
  71     }
  72
  73     @Override
  74     protected OpendaylightQueueStatisticsListener getStatNotificationListener() {
  75         return this;
  76     }
  77
  78     @Override
  79     protected InstanceIdentifier<Queue> getWildCardedRegistrationPath() {
  80         return InstanceIdentifier.create(Nodes.class).child(Node.class).child(NodeConnector.class)
  81             .augmentation(FlowCapableNodeConnector.class).child(Queue.class);
  82     }
  83
  84     @Override
  85     public void onQueueStatisticsUpdate(final QueueStatisticsUpdate notification) {
  86         final TransactionId transId = notification.getTransactionId();
  87         final NodeId nodeId = notification.getId();
  88         if ( ! isExpectedStatistics(transId, nodeId)) {
  89             LOG.debug("STAT-MANAGER - QueueStatisticsUpdate: unregistred notification detect TransactionId {}", transId);
  90             return;
  91         }
  92         manager.getRpcMsgManager().addNotification(notification, nodeId);
  93         if (notification.isMoreReplies()) {
  94             return;
  95         }
  96
  97         /* Don't block RPC Notification thread */
  98         manager.enqueue(new StatDataStoreOperation() {
  99             @Override
 100             public void applyOperation(final ReadWriteTransaction tx) {
 101
 102                 final InstanceIdentifier<Node> nodeIdent = InstanceIdentifier.create(Nodes.class)
 103                         .child(Node.class, new NodeKey(nodeId));
 104
 105                 /* Validate exist Node */
 106                 Optional<Node> fNode = Optional.absent();
 107                 try {
 108                     fNode = tx.read(LogicalDatastoreType.OPERATIONAL, nodeIdent).checkedGet();
 109                 }
 110                 catch (final ReadFailedException e) {
 111                     LOG.debug("Read Operational/DS for Node fail! {}", nodeIdent, e);
 112                 }
 113                 if ( ! fNode.isPresent()) {
 114                     LOG.trace("Read Operational/DS for Node fail! Node {} doesn't exist.", nodeIdent);
 115                     return;
 116                 }
 117
 118                 /* Get and Validate TransactionCacheContainer */
 119                 final Optional<TransactionCacheContainer<?>> txContainer = getTransactionCacheContainer(transId, nodeId);
 120                 if ( ! isTransactionCacheContainerValid(txContainer)) {
 121                     return;
 122                 }
 123                 /* Prepare List actual Queues and not updated Queues will be removed */
 124                 final List<NodeConnector> existConnectors = fNode.get().getNodeConnector() != null
 125                         ? fNode.get().getNodeConnector() : Collections.<NodeConnector> emptyList();
 126                 final Map<QueueKey, NodeConnectorKey> existQueueKeys = new HashMap<>();
 127                 for (final NodeConnector connect : existConnectors) {
 128                     final List<Queue> listQueues = connect.getAugmentation(FlowCapableNodeConnector.class).getQueue();
 129                     if (listQueues != null) {
 130                         for (final Queue queue : listQueues) {
 131                             existQueueKeys.put(queue.getKey(), connect.getKey());
 132                         }
 133                     }
 134                 }
 135                 /* Queue processing */
 136                 statQueueCommit(txContainer, tx, nodeIdent, existQueueKeys);
 137                 /* Delete all not presented Group Nodes */
 138                 deleteAllNotPresentedNodes(nodeIdent, tx, Collections.unmodifiableMap(existQueueKeys));
 139                 /* Notification for continue collecting statistics */
 140                 notifyToCollectNextStatistics(nodeIdent);
 141             }
 142         });
 143     }
 144
 145     private void statQueueCommit(
 146             final Optional<TransactionCacheContainer<?>> txContainer, final ReadWriteTransaction tx,
 147             final InstanceIdentifier<Node> nodeIdent, final Map<QueueKey, NodeConnectorKey> existQueueKeys) {
 148
 149         Preconditions.checkNotNull(existQueueKeys);
 150         Preconditions.checkNotNull(txContainer);
 151         Preconditions.checkNotNull(nodeIdent);
 152         Preconditions.checkNotNull(tx);
 153
 154         final List<? extends TransactionAware> cacheNotifs = txContainer.get().getNotifications();
 155         for (final TransactionAware notif : cacheNotifs) {
 156             if ( ! (notif instanceof QueueStatisticsUpdate)) {
 157                 break;
 158             }
 159             final List<QueueIdAndStatisticsMap> queueStats = ((QueueStatisticsUpdate) notif).getQueueIdAndStatisticsMap();
 160             if (queueStats == null) {
 161                 break;
 162             }
 163             for (final QueueIdAndStatisticsMap queueStat : queueStats) {
 164                 if (queueStat.getQueueId() != null) {
 165                     final FlowCapableNodeConnectorQueueStatistics statChild =
 166                             new FlowCapableNodeConnectorQueueStatisticsBuilder(queueStat).build();
 167                     final FlowCapableNodeConnectorQueueStatisticsDataBuilder statBuild =
 168                             new FlowCapableNodeConnectorQueueStatisticsDataBuilder();
 169                     statBuild.setFlowCapableNodeConnectorQueueStatistics(statChild);
 170                     final QueueKey qKey = new QueueKey(queueStat.getQueueId());
 171                     final InstanceIdentifier<Queue> queueIdent = nodeIdent
 172                             .child(NodeConnector.class, new NodeConnectorKey(queueStat.getNodeConnectorId()))
 173                             .augmentation(FlowCapableNodeConnector.class)
 174                             .child(Queue.class, qKey);
 175                     final InstanceIdentifier<FlowCapableNodeConnectorQueueStatisticsData> queueStatIdent = queueIdent.augmentation(FlowCapableNodeConnectorQueueStatisticsData.class);
 176                     existQueueKeys.remove(qKey);
 177                     tx.merge(LogicalDatastoreType.OPERATIONAL, queueIdent, new QueueBuilder().setKey(qKey).build());
 178                     tx.put(LogicalDatastoreType.OPERATIONAL, queueStatIdent, statBuild.build());
 179                 }
 180             }
 181         }
 182     }
 183
 184     private void deleteAllNotPresentedNodes(final InstanceIdentifier<Node> nodeIdent,
 185             final ReadWriteTransaction tx, final Map<QueueKey, NodeConnectorKey> existQueueKeys) {
 186
 187         Preconditions.checkNotNull(nodeIdent);
 188         Preconditions.checkNotNull(tx);
 189
 190         if (existQueueKeys == null) {
 191             return;
 192         }
 193
 194         for (final Entry<QueueKey, NodeConnectorKey> entry : existQueueKeys.entrySet()) {
 195             final InstanceIdentifier<Queue> queueIdent = nodeIdent.child(NodeConnector.class, entry.getValue())
 196                     .augmentation(FlowCapableNodeConnector.class).child(Queue.class, entry.getKey());
 197             LOG.trace("Queue {} has to removed.", queueIdent);
 198             Optional<Queue> delQueue = Optional.absent();
 199             try {
 200                 delQueue = tx.read(LogicalDatastoreType.OPERATIONAL, queueIdent).checkedGet();
 201             }
 202             catch (final ReadFailedException e) {
 203                 // NOOP - probably another transaction delete that node
 204             }
 205             if (delQueue.isPresent()) {
 206                 tx.delete(LogicalDatastoreType.OPERATIONAL, queueIdent);
 207             }
 208         }
 209     }
 210 }
 211