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