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 LinkedBlockingQueue#LinkedBlockingQueue
  40      */
  41     public TrackingLinkedBlockingQueue() {
  42         super();
  43     }
  44
  45     /**
  46      * @see LinkedBlockingQueue#LinkedBlockingQueue(Collection)
  47      */
  48     public TrackingLinkedBlockingQueue( final Collection<? extends E> c ) {
  49         super(c);
  50     }
  51
  52     /**
  53      * @see 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     public boolean offer(final E e, final long timeout, final TimeUnit unit) throws InterruptedException {
  71         if (super.offer( e, timeout, unit ) ) {
  72             updateLargestQueueSize();
  73             return true;
  74         }
  75
  76         return false;
  77     }
  78
  79     @Override
  80     public boolean offer(@Nonnull final E e) {
  81         if (super.offer( e ) ) {
  82             updateLargestQueueSize();
  83             return true;
  84         }
  85
  86         return false;
  87     }
  88
  89     @Override
  90     public void put( final E e ) throws InterruptedException {
  91         super.put( e );
  92         updateLargestQueueSize();
  93     }
  94
  95     @Override
  96     public boolean add(final E e) {
  97         boolean result = super.add( e );
  98         updateLargestQueueSize();
  99         return result;
 100     }
 101
 102     @Override
 103     public boolean addAll(final Collection<? extends E> c) {
 104         try {
 105             return super.addAll( c );
 106         } finally {
 107             updateLargestQueueSize();
 108         }
 109     }
 110
 111     private void updateLargestQueueSize() {
 112         final int size = size();
 113
 114         int largest;
 115         do {
 116             largest = largestQueueSize;
 117         } while (size > largest && !LARGEST_QUEUE_SIZE_UPDATER.weakCompareAndSet(this, largest, size));
 118     }
 119 }