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