opendaylight/md-sal/statistics-manager/src/main/java/org/opendaylight/controller/md/statistics/manager/AbstractStatsTracker.java

   1 /*
   2  * Copyright IBM Corporation, 2013.  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 package org.opendaylight.controller.md.statistics.manager;
   9
  10 import java.util.HashMap;
  11 import java.util.Iterator;
  12 import java.util.List;
  13 import java.util.Map;
  14 import java.util.Map.Entry;
  15 import java.util.concurrent.Future;
  16
  17 import org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev131103.TransactionAware;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev131103.TransactionId;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  22 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  23 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
  24 import org.opendaylight.yangtools.yang.common.RpcResult;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28 import com.google.common.base.Preconditions;
  29 import com.google.common.util.concurrent.FutureCallback;
  30 import com.google.common.util.concurrent.Futures;
  31 import com.google.common.util.concurrent.JdkFutureAdapters;
  32
  33 abstract class AbstractStatsTracker<I, K> {
  34     private static final Logger logger = LoggerFactory.getLogger(AbstractStatsTracker.class);
  35     private final FutureCallback<RpcResult<? extends TransactionAware>> callback =
  36             new FutureCallback<RpcResult<? extends TransactionAware>>() {
  37         @Override
  38         public void onSuccess(RpcResult<? extends TransactionAware> result) {
  39             if (result.isSuccessful()) {
  40                 final TransactionId id = result.getResult().getTransactionId();
  41                 if (id == null) {
  42                     final Throwable t = new UnsupportedOperationException("No protocol support");
  43                     t.fillInStackTrace();
  44                     onFailure(t);
  45                 } else {
  46                     context.registerTransaction(id);
  47                 }
  48             } else {
  49                 logger.debug("Statistics request failed: {}", result.getErrors());
  50
  51                 final Throwable t = new RPCFailedException("Failed to send statistics request", result.getErrors());
  52                 t.fillInStackTrace();
  53                 onFailure(t);
  54             }
  55         }
  56
  57         @Override
  58         public void onFailure(Throwable t) {
  59             logger.debug("Failed to send statistics request", t);
  60         }
  61     };
  62
  63     private final Map<K, Long> trackedItems = new HashMap<>();
  64     private final FlowCapableContext context;
  65     private final long lifetimeNanos;
  66
  67     protected AbstractStatsTracker(final FlowCapableContext context, final long lifetimeNanos) {
  68         this.context = Preconditions.checkNotNull(context);
  69         this.lifetimeNanos = lifetimeNanos;
  70     }
  71
  72     protected final InstanceIdentifierBuilder<Node> getNodeIdentifierBuilder() {
  73         return InstanceIdentifier.builder(getNodeIdentifier());
  74     }
  75
  76     protected final NodeRef getNodeRef() {
  77         return context.getNodeRef();
  78     }
  79
  80     protected final InstanceIdentifier<Node> getNodeIdentifier() {
  81         return context.getNodeIdentifier();
  82     }
  83
  84     protected final <T extends TransactionAware> void requestHelper(Future<RpcResult<T>> future) {
  85         Futures.addCallback(JdkFutureAdapters.listenInPoolThread(future), callback);
  86     }
  87
  88     protected final DataModificationTransaction startTransaction() {
  89         return context.startDataModification();
  90     }
  91
  92     protected abstract void cleanupSingleStat(DataModificationTransaction trans, K item);
  93     protected abstract K updateSingleStat(DataModificationTransaction trans, I item);
  94
  95     public final synchronized void updateStats(List<I> list) {
  96         final Long expiryTime = System.nanoTime() + lifetimeNanos;
  97         final DataModificationTransaction trans = startTransaction();
  98
  99         for (final I item : list) {
 100             trackedItems.put(updateSingleStat(trans, item), expiryTime);
 101         }
 102
 103         trans.commit();
 104     }
 105
 106     public final synchronized void cleanup(final DataModificationTransaction trans, long now) {
 107         for (Iterator<Entry<K, Long>> it = trackedItems.entrySet().iterator();it.hasNext();){
 108             Entry<K, Long> e = it.next();
 109             if (now > e.getValue()) {
 110                 cleanupSingleStat(trans, e.getKey());
 111                 it.remove();
 112             }
 113         }
 114     }
 115 }