--- jsr166/src/jsr166y/LinkedTransferQueue.java 2007/07/23 17:39:11 1.2
+++ jsr166/src/jsr166y/LinkedTransferQueue.java 2009/07/21 00:15:14 1.19
@@ -10,6 +10,8 @@ import java.util.concurrent.locks.*;
import java.util.concurrent.atomic.*;
import java.util.*;
import java.io.*;
+import sun.misc.Unsafe;
+import java.lang.reflect.*;
/**
* An unbounded {@linkplain TransferQueue} based on linked nodes.
@@ -19,7 +21,7 @@ import java.io.*;
* producer. The tail of the queue is that element that has
* been on the queue the shortest time for some producer.
*
- * Beware that, unlike in most collections, the size
+ *
Beware that, unlike in most collections, the {@code size}
* method is NOT a constant-time operation. Because of the
* asynchronous nature of these queues, determining the current number
* of elements requires a traversal of the elements.
@@ -39,7 +41,7 @@ import java.io.*;
*
* Java Collections Framework .
*
- * @since 1.5
+ * @since 1.7
* @author Doug Lea
* @param the type of elements held in this collection
*
@@ -49,19 +51,19 @@ public class LinkedTransferQueue exte
private static final long serialVersionUID = -3223113410248163686L;
/*
- * This is still a work in prgress...
- *
* This class extends the approach used in FIFO-mode
* SynchronousQueues. See the internal documentation, as well as
* the PPoPP 2006 paper "Scalable Synchronous Queues" by Scherer,
* Lea & Scott
* (http://www.cs.rice.edu/~wns1/papers/2006-PPoPP-SQ.pdf)
*
- * The main extension is to provide different Wait modes
- * for the main "xfer" method that puts or takes items.
- * These don't impact the basic dual-queue logic, but instead
- * control whether or how threads block upon insertion
- * of request or data nodes into the dual queue.
+ * The main extension is to provide different Wait modes for the
+ * main "xfer" method that puts or takes items. These don't
+ * impact the basic dual-queue logic, but instead control whether
+ * or how threads block upon insertion of request or data nodes
+ * into the dual queue. It also uses slightly different
+ * conventions for tracking whether nodes are off-list or
+ * cancelled.
*/
// Wait modes for xfer method
@@ -79,7 +81,7 @@ public class LinkedTransferQueue exte
* seems not to vary with number of CPUs (beyond 2) so is just
* a constant.
*/
- static final int maxTimedSpins = (NCPUS < 2)? 0 : 32;
+ static final int maxTimedSpins = (NCPUS < 2)? 0 : 32;
/**
* The number of times to spin before blocking in untimed waits.
@@ -94,12 +96,12 @@ public class LinkedTransferQueue exte
*/
static final long spinForTimeoutThreshold = 1000L;
- /**
- * Node class for LinkedTransferQueue. Opportunistically subclasses from
- * AtomicReference to represent item. Uses Object, not E, to allow
- * setting item to "this" after use, to avoid garbage
- * retention. Similarly, setting the next field to this is used as
- * sentinel that node is off list.
+ /**
+ * Node class for LinkedTransferQueue. Opportunistically
+ * subclasses from AtomicReference to represent item. Uses Object,
+ * not E, to allow setting item to "this" after use, to avoid
+ * garbage retention. Similarly, setting the next field to this is
+ * used as sentinel that node is off list.
*/
static final class QNode extends AtomicReference {
volatile QNode next;
@@ -114,9 +116,14 @@ public class LinkedTransferQueue exte
nextUpdater = AtomicReferenceFieldUpdater.newUpdater
(QNode.class, QNode.class, "next");
- boolean casNext(QNode cmp, QNode val) {
+ final boolean casNext(QNode cmp, QNode val) {
return nextUpdater.compareAndSet(this, cmp, val);
}
+
+ final void clearNext() {
+ nextUpdater.lazySet(this, this);
+ }
+
}
/**
@@ -131,19 +138,17 @@ public class LinkedTransferQueue exte
}
- private final QNode dummy = new QNode(null, false);
- private final PaddedAtomicReference head =
- new PaddedAtomicReference(dummy);
- private final PaddedAtomicReference tail =
- new PaddedAtomicReference(dummy);
+ /** head of the queue */
+ private transient final PaddedAtomicReference head;
+ /** tail of the queue */
+ private transient final PaddedAtomicReference tail;
/**
* Reference to a cancelled node that might not yet have been
* unlinked from queue because it was the last inserted node
* when it cancelled.
*/
- private final PaddedAtomicReference cleanMe =
- new PaddedAtomicReference(null);
+ private transient final PaddedAtomicReference cleanMe;
/**
* Tries to cas nh as new head; if successful, unlink
@@ -151,16 +156,18 @@ public class LinkedTransferQueue exte
*/
private boolean advanceHead(QNode h, QNode nh) {
if (h == head.get() && head.compareAndSet(h, nh)) {
- h.next = h; // forget old next
+ h.clearNext(); // forget old next
return true;
}
return false;
}
-
+
/**
* Puts or takes an item. Used for most queue operations (except
- * poll() and tryTransfer())
- * @param e the item or if null, signfies that this is a take
+ * poll() and tryTransfer()). See the similar code in
+ * SynchronousQueue for detailed explanation.
+ *
+ * @param e the item or if null, signifies that this is a take
* @param mode the wait mode: NOWAIT, TIMEOUT, WAIT
* @param nanos timeout in nanosecs, used only if mode is TIMEOUT
* @return an item, or null on failure
@@ -188,10 +195,10 @@ public class LinkedTransferQueue exte
return awaitFulfill(t, s, e, mode, nanos);
}
}
-
+
else if (h != null) {
QNode first = h.next;
- if (t == tail.get() && first != null &&
+ if (t == tail.get() && first != null &&
advanceHead(h, first)) {
Object x = first.get();
if (x != first && first.compareAndSet(x, e)) {
@@ -206,7 +213,7 @@ public class LinkedTransferQueue exte
/**
* Version of xfer for poll() and tryTransfer, which
- * simpifies control paths both here and in xfer
+ * simplifies control paths both here and in xfer.
*/
private Object fulfill(Object e) {
boolean isData = (e != null);
@@ -228,7 +235,7 @@ public class LinkedTransferQueue exte
}
else if (h != null) {
QNode first = h.next;
- if (t == tail.get() &&
+ if (t == tail.get() &&
first != null &&
advanceHead(h, first)) {
Object x = first.get();
@@ -252,7 +259,7 @@ public class LinkedTransferQueue exte
* @param nanos timeout value
* @return matched item, or s if cancelled
*/
- private Object awaitFulfill(QNode pred, QNode s, Object e,
+ private Object awaitFulfill(QNode pred, QNode s, Object e,
int mode, long nanos) {
if (mode == NOWAIT)
return null;
@@ -266,16 +273,17 @@ public class LinkedTransferQueue exte
Object x = s.get();
if (x != e) { // Node was matched or cancelled
advanceHead(pred, s); // unlink if head
- if (x == s) // was cancelled
- return clean(pred, s);
- else if (x != null) {
+ if (x == s) { // was cancelled
+ clean(pred, s);
+ return null;
+ }
+ else if (x != null) {
s.set(s); // avoid garbage retention
return x;
}
else
return e;
}
-
if (mode == TIMEOUT) {
long now = System.nanoTime();
nanos -= now - lastTime;
@@ -288,7 +296,7 @@ public class LinkedTransferQueue exte
if (spins < 0) {
QNode h = head.get(); // only spin if at head
spins = ((h != null && h.next == s) ?
- (mode == TIMEOUT?
+ (mode == TIMEOUT?
maxTimedSpins : maxUntimedSpins) : 0);
}
if (spins > 0)
@@ -296,14 +304,12 @@ public class LinkedTransferQueue exte
else if (s.waiter == null)
s.waiter = w;
else if (mode != TIMEOUT) {
- // LockSupport.park(this);
- LockSupport.park(); // allows run on java5
+ LockSupport.park(this);
s.waiter = null;
spins = -1;
}
else if (nanos > spinForTimeoutThreshold) {
- // LockSupport.parkNanos(this, nanos);
- LockSupport.parkNanos(nanos);
+ LockSupport.parkNanos(this, nanos);
s.waiter = null;
spins = -1;
}
@@ -311,76 +317,121 @@ public class LinkedTransferQueue exte
}
/**
+ * Returns validated tail for use in cleaning methods.
+ */
+ private QNode getValidatedTail() {
+ for (;;) {
+ QNode h = head.get();
+ QNode first = h.next;
+ if (first != null && first.next == first) { // help advance
+ advanceHead(h, first);
+ continue;
+ }
+ QNode t = tail.get();
+ QNode last = t.next;
+ if (t == tail.get()) {
+ if (last != null)
+ tail.compareAndSet(t, last); // help advance
+ else
+ return t;
+ }
+ }
+ }
+
+ /**
* Gets rid of cancelled node s with original predecessor pred.
- * @return null (to simplify use by callers)
+ *
+ * @param pred predecessor of cancelled node
+ * @param s the cancelled node
*/
- private Object clean(QNode pred, QNode s) {
+ private void clean(QNode pred, QNode s) {
Thread w = s.waiter;
if (w != null) { // Wake up thread
s.waiter = null;
if (w != Thread.currentThread())
LockSupport.unpark(w);
}
-
- for (;;) {
- if (pred.next != s) // already cleaned
- return null;
- QNode h = head.get();
- QNode hn = h.next; // Absorb cancelled first node as head
- if (hn != null && hn.next == hn) {
- advanceHead(h, hn);
- continue;
- }
- QNode t = tail.get(); // Ensure consistent read for tail
- if (t == h)
- return null;
- QNode tn = t.next;
- if (t != tail.get())
- continue;
- if (tn != null) { // Help advance tail
- tail.compareAndSet(t, tn);
- continue;
- }
- if (s != t) { // If not tail, try to unsplice
- QNode sn = s.next;
+
+ if (pred == null)
+ return;
+
+ /*
+ * At any given time, exactly one node on list cannot be
+ * deleted -- the last inserted node. To accommodate this, if
+ * we cannot delete s, we save its predecessor as "cleanMe",
+ * processing the previously saved version first. At least one
+ * of node s or the node previously saved can always be
+ * processed, so this always terminates.
+ */
+ while (pred.next == s) {
+ QNode oldpred = reclean(); // First, help get rid of cleanMe
+ QNode t = getValidatedTail();
+ if (s != t) { // If not tail, try to unsplice
+ QNode sn = s.next; // s.next == s means s already off list
if (sn == s || pred.casNext(s, sn))
- return null;
+ break;
}
- QNode dp = cleanMe.get();
- if (dp != null) { // Try unlinking previous cancelled node
- QNode d = dp.next;
- QNode dn;
- if (d == null || // d is gone or
- d == dp || // d is off list or
- d.get() != d || // d not cancelled or
- (d != t && // d not tail and
- (dn = d.next) != null && // has successor
- dn != d && // that is on list
- dp.casNext(d, dn))) // d unspliced
- cleanMe.compareAndSet(dp, null);
- if (dp == pred)
- return null; // s is already saved node
- }
- else if (cleanMe.compareAndSet(null, pred))
- return null; // Postpone cleaning s
+ else if (oldpred == pred || // Already saved
+ (oldpred == null && cleanMe.compareAndSet(null, pred)))
+ break; // Postpone cleaning
}
}
-
+
/**
- * Creates an initially empty LinkedTransferQueue .
+ * Tries to unsplice the cancelled node held in cleanMe that was
+ * previously uncleanable because it was at tail.
+ *
+ * @return current cleanMe node (or null)
+ */
+ private QNode reclean() {
+ /*
+ * cleanMe is, or at one time was, predecessor of cancelled
+ * node s that was the tail so could not be unspliced. If s
+ * is no longer the tail, try to unsplice if necessary and
+ * make cleanMe slot available. This differs from similar
+ * code in clean() because we must check that pred still
+ * points to a cancelled node that must be unspliced -- if
+ * not, we can (must) clear cleanMe without unsplicing.
+ * This can loop only due to contention on casNext or
+ * clearing cleanMe.
+ */
+ QNode pred;
+ while ((pred = cleanMe.get()) != null) {
+ QNode t = getValidatedTail();
+ QNode s = pred.next;
+ if (s != t) {
+ QNode sn;
+ if (s == null || s == pred || s.get() != s ||
+ (sn = s.next) == s || pred.casNext(s, sn))
+ cleanMe.compareAndSet(pred, null);
+ }
+ else // s is still tail; cannot clean
+ break;
+ }
+ return pred;
+ }
+
+ /**
+ * Creates an initially empty {@code LinkedTransferQueue}.
*/
public LinkedTransferQueue() {
+ QNode dummy = new QNode(null, false);
+ head = new PaddedAtomicReference(dummy);
+ tail = new PaddedAtomicReference(dummy);
+ cleanMe = new PaddedAtomicReference(null);
}
/**
- * Creates a LinkedTransferQueue
+ * Creates a {@code LinkedTransferQueue}
* initially containing the elements of the given collection,
* added in traversal order of the collection's iterator.
+ *
* @param c the collection of elements to initially contain
* @throws NullPointerException if the specified collection or any
* of its elements are null
*/
public LinkedTransferQueue(Collection c) {
+ this();
addAll(c);
}
@@ -390,7 +441,7 @@ public class LinkedTransferQueue exte
xfer(e, NOWAIT, 0);
}
- public boolean offer(E e, long timeout, TimeUnit unit)
+ public boolean offer(E e, long timeout, TimeUnit unit)
throws InterruptedException {
if (e == null) throw new NullPointerException();
if (Thread.interrupted()) throw new InterruptedException();
@@ -404,12 +455,18 @@ public class LinkedTransferQueue exte
return true;
}
+ public boolean add(E e) {
+ if (e == null) throw new NullPointerException();
+ xfer(e, NOWAIT, 0);
+ return true;
+ }
+
public void transfer(E e) throws InterruptedException {
if (e == null) throw new NullPointerException();
if (xfer(e, WAIT, 0) == null) {
- Thread.interrupted();
+ Thread.interrupted();
throw new InterruptedException();
- }
+ }
}
public boolean tryTransfer(E e, long timeout, TimeUnit unit)
@@ -431,7 +488,7 @@ public class LinkedTransferQueue exte
Object e = xfer(null, WAIT, 0);
if (e != null)
return (E)e;
- Thread.interrupted();
+ Thread.interrupted();
throw new InterruptedException();
}
@@ -477,7 +534,7 @@ public class LinkedTransferQueue exte
// Traversal-based methods
/**
- * Return head after performing any outstanding helping steps
+ * Returns head after performing any outstanding helping steps.
*/
private QNode traversalHead() {
for (;;) {
@@ -487,12 +544,12 @@ public class LinkedTransferQueue exte
QNode last = t.next;
QNode first = h.next;
if (t == tail.get()) {
- if (last != null)
+ if (last != null)
tail.compareAndSet(t, last);
else if (first != null) {
Object x = first.get();
- if (x == first)
- advanceHead(h, first);
+ if (x == first)
+ advanceHead(h, first);
else
return h;
}
@@ -500,6 +557,7 @@ public class LinkedTransferQueue exte
return h;
}
}
+ reclean();
}
}
@@ -509,63 +567,75 @@ public class LinkedTransferQueue exte
}
/**
- * Iterators. Basic strategy os to travers list, treating
+ * Iterators. Basic strategy is to traverse list, treating
* non-data (i.e., request) nodes as terminating list.
* Once a valid data node is found, the item is cached
* so that the next call to next() will return it even
* if subsequently removed.
*/
class Itr implements Iterator {
- QNode nextNode; // Next node to return next
- QNode currentNode; // last returned node, for remove()
- QNode prevNode; // predecessor of last returned node
- E nextItem; // Cache of next item, once commited to in next
-
+ QNode next; // node to return next
+ QNode pnext; // predecessor of next
+ QNode snext; // successor of next
+ QNode curr; // last returned node, for remove()
+ QNode pcurr; // predecessor of curr, for remove()
+ E nextItem; // Cache of next item, once committed to in next
+
Itr() {
- nextNode = traversalHead();
- advance();
+ findNext();
}
-
- E advance() {
- prevNode = currentNode;
- currentNode = nextNode;
- E x = nextItem;
-
- QNode p = nextNode.next;
+
+ /**
+ * Ensures next points to next valid node, or null if none.
+ */
+ void findNext() {
for (;;) {
- if (p == null || !p.isData) {
- nextNode = null;
- nextItem = null;
- return x;
+ QNode pred = pnext;
+ QNode q = next;
+ if (pred == null || pred == q) {
+ pred = traversalHead();
+ q = pred.next;
}
- Object item = p.get();
- if (item != p && item != null) {
- nextNode = p;
- nextItem = (E)item;
- return x;
- }
- prevNode = p;
- p = p.next;
+ if (q == null || !q.isData) {
+ next = null;
+ return;
+ }
+ Object x = q.get();
+ QNode s = q.next;
+ if (x != null && q != x && q != s) {
+ nextItem = (E)x;
+ snext = s;
+ pnext = pred;
+ next = q;
+ return;
+ }
+ pnext = q;
+ next = s;
}
}
-
+
public boolean hasNext() {
- return nextNode != null;
+ return next != null;
}
-
+
public E next() {
- if (nextNode == null) throw new NoSuchElementException();
- return advance();
+ if (next == null) throw new NoSuchElementException();
+ pcurr = pnext;
+ curr = next;
+ pnext = next;
+ next = snext;
+ E x = nextItem;
+ findNext();
+ return x;
}
-
+
public void remove() {
- QNode p = currentNode;
- QNode prev = prevNode;
- if (prev == null || p == null)
+ QNode p = curr;
+ if (p == null)
throw new IllegalStateException();
Object x = p.get();
if (x != null && x != p && p.compareAndSet(x, p))
- clean(prev, p);
+ clean(pcurr, p);
}
}
@@ -608,15 +678,15 @@ public class LinkedTransferQueue exte
if (p == null)
return false;
Object x = p.get();
- if (p != x)
+ if (p != x)
return !p.isData;
}
}
-
+
/**
* Returns the number of elements in this queue. If this queue
- * contains more than Integer.MAX_VALUE elements, returns
- * Integer.MAX_VALUE .
+ * contains more than {@code Integer.MAX_VALUE} elements, returns
+ * {@code Integer.MAX_VALUE}.
*
* Beware that, unlike in most collections, this method is
* NOT a constant-time operation. Because of the
@@ -630,7 +700,7 @@ public class LinkedTransferQueue exte
QNode h = traversalHead();
for (QNode p = h.next; p != null && p.isData; p = p.next) {
Object x = p.get();
- if (x != null && x != p) {
+ if (x != null && x != p) {
if (++count == Integer.MAX_VALUE) // saturated
break;
}
@@ -654,18 +724,40 @@ public class LinkedTransferQueue exte
return Integer.MAX_VALUE;
}
+ public boolean remove(Object o) {
+ if (o == null)
+ return false;
+ for (;;) {
+ QNode pred = traversalHead();
+ for (;;) {
+ QNode q = pred.next;
+ if (q == null || !q.isData)
+ return false;
+ if (q == pred) // restart
+ break;
+ Object x = q.get();
+ if (x != null && x != q && o.equals(x) &&
+ q.compareAndSet(x, q)) {
+ clean(pred, q);
+ return true;
+ }
+ pred = q;
+ }
+ }
+ }
+
/**
* Save the state to a stream (that is, serialize it).
*
- * @serialData All of the elements (each an E ) in
+ * @serialData All of the elements (each an {@code E}) in
* the proper order, followed by a null
* @param s the stream
*/
private void writeObject(java.io.ObjectOutputStream s)
throws java.io.IOException {
s.defaultWriteObject();
- for (Iterator it = iterator(); it.hasNext(); )
- s.writeObject(it.next());
+ for (E e : this)
+ s.writeObject(e);
// Use trailing null as sentinel
s.writeObject(null);
}
@@ -673,11 +765,13 @@ public class LinkedTransferQueue exte
/**
* Reconstitute the Queue instance from a stream (that is,
* deserialize it).
+ *
* @param s the stream
*/
private void readObject(java.io.ObjectInputStream s)
throws java.io.IOException, ClassNotFoundException {
s.defaultReadObject();
+ resetHeadAndTail();
for (;;) {
E item = (E)s.readObject();
if (item == null)
@@ -686,4 +780,62 @@ public class LinkedTransferQueue exte
offer(item);
}
}
+
+
+ // Support for resetting head/tail while deserializing
+ private void resetHeadAndTail() {
+ QNode dummy = new QNode(null, false);
+ _unsafe.putObjectVolatile(this, headOffset,
+ new PaddedAtomicReference(dummy));
+ _unsafe.putObjectVolatile(this, tailOffset,
+ new PaddedAtomicReference(dummy));
+ _unsafe.putObjectVolatile(this, cleanMeOffset,
+ new PaddedAtomicReference(null));
+ }
+
+ // Temporary Unsafe mechanics for preliminary release
+ private static Unsafe getUnsafe() throws Throwable {
+ try {
+ return Unsafe.getUnsafe();
+ } catch (SecurityException se) {
+ try {
+ return java.security.AccessController.doPrivileged
+ (new java.security.PrivilegedExceptionAction() {
+ public Unsafe run() throws Exception {
+ return getUnsafePrivileged();
+ }});
+ } catch (java.security.PrivilegedActionException e) {
+ throw e.getCause();
+ }
+ }
+ }
+
+ private static Unsafe getUnsafePrivileged()
+ throws NoSuchFieldException, IllegalAccessException {
+ Field f = Unsafe.class.getDeclaredField("theUnsafe");
+ f.setAccessible(true);
+ return (Unsafe) f.get(null);
+ }
+
+ private static long fieldOffset(String fieldName)
+ throws NoSuchFieldException {
+ return _unsafe.objectFieldOffset
+ (LinkedTransferQueue.class.getDeclaredField(fieldName));
+ }
+
+ private static final Unsafe _unsafe;
+ private static final long headOffset;
+ private static final long tailOffset;
+ private static final long cleanMeOffset;
+ static {
+ try {
+ _unsafe = getUnsafe();
+ headOffset = fieldOffset("head");
+ tailOffset = fieldOffset("tail");
+ cleanMeOffset = fieldOffset("cleanMe");
+ } catch (Throwable e) {
+ throw new RuntimeException("Could not initialize intrinsics", e);
+ }
+ }
+
}