common/util/src/main/java/org/opendaylight/yangtools/util/concurrent/TrackingLinkedBlockingQueue.java

   1 /*
   2  * Copyright (c) 2014 Brocade Communications 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.yangtools.util.concurrent;
  10
  11 import com.google.common.annotations.Beta;
  12 import java.util.Collection;
  13 import java.util.concurrent.LinkedBlockingQueue;
  14 import java.util.concurrent.TimeUnit;
  15 import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
  16 import javax.annotation.Nonnull;
  17
  18 /**
  19  * A {@link LinkedBlockingQueue} that tracks the largest queue size for debugging.
  20  *
  21  * @author Thomas Pantelis
  22  *
  23  * @param <E> the element t.ype
  24  */
  25 public class TrackingLinkedBlockingQueue<E> extends LinkedBlockingQueue<E> {
  26     private static final long serialVersionUID = 1L;
  27
  28     @SuppressWarnings("rawtypes")
  29     private static final AtomicIntegerFieldUpdater<TrackingLinkedBlockingQueue> LARGEST_QUEUE_SIZE_UPDATER
  30         = AtomicIntegerFieldUpdater.newUpdater(TrackingLinkedBlockingQueue.class, "largestQueueSize");
  31
  32     /**
  33      * Holds largestQueueSize, this long field should be only accessed
  34      * using {@link #LARGEST_QUEUE_SIZE_UPDATER}.
  35      */
  36     private volatile int largestQueueSize = 0;
  37
  38     /**
  39      * See {@link LinkedBlockingQueue#LinkedBlockingQueue()}.
  40      */
  41     public TrackingLinkedBlockingQueue() {
  42     }
  43
  44     /**
  45      * See {@link LinkedBlockingQueue#LinkedBlockingQueue(Collection)}.
  46      */
  47     @SuppressWarnings("checkstyle:parameterName")
  48     public TrackingLinkedBlockingQueue(final Collection<? extends E> c) {
  49         super(c);
  50     }
  51
  52     /**
  53      * See {@link LinkedBlockingQueue#LinkedBlockingQueue(int)}.
  54      */
  55     public TrackingLinkedBlockingQueue(final int capacity) {
  56         super(capacity);
  57     }
  58
  59     /**
  60      * Returns the largest queue size.
  61      *
  62      * <p>FIXME: the this return will be changed to int in a future release.
  63      */
  64     @Beta
  65     public long getLargestQueueSize() {
  66         return largestQueueSize;
  67     }
  68
  69     @Override
  70     @SuppressWarnings("checkstyle:parameterName")
  71     public boolean offer(final E e, final long timeout, final TimeUnit unit) throws InterruptedException {
  72         if (super.offer(e, timeout, unit)) {
  73             updateLargestQueueSize();
  74             return true;
  75         }
  76
  77         return false;
  78     }
  79
  80     @Override
  81     @SuppressWarnings("checkstyle:parameterName")
  82     public boolean offer(@Nonnull final E e) {
  83         if (super.offer(e)) {
  84             updateLargestQueueSize();
  85             return true;
  86         }
  87
  88         return false;
  89     }
  90
  91     @Override
  92     @SuppressWarnings("checkstyle:parameterName")
  93     public void put(final E e) throws InterruptedException {
  94         super.put(e);
  95         updateLargestQueueSize();
  96     }
  97
  98     @Override
  99     @SuppressWarnings("checkstyle:parameterName")
 100     public boolean add(final E e) {
 101         boolean result = super.add(e);
 102         updateLargestQueueSize();
 103         return result;
 104     }
 105
 106     @Override
 107     @SuppressWarnings("checkstyle:parameterName")
 108     public boolean addAll(final Collection<? extends E> c) {
 109         try {
 110             return super.addAll(c);
 111         } finally {
 112             updateLargestQueueSize();
 113         }
 114     }
 115
 116     private void updateLargestQueueSize() {
 117         final int size = size();
 118
 119         int largest;
 120         do {
 121             largest = largestQueueSize;
 122         } while (size > largest && !LARGEST_QUEUE_SIZE_UPDATER.weakCompareAndSet(this, largest, size));
 123     }
 124 }