LinkedTransferQueue.java revision a807b4d808d2591894daf13aab179b2e9c46a2f5
1a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson/* 2a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Written by Doug Lea with assistance from members of JCP JSR-166 3a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Expert Group and released to the public domain, as explained at 4a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * http://creativecommons.org/publicdomain/zero/1.0/ 5a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 6a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 7a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilsonpackage java.util.concurrent; 8a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 9a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilsonimport java.util.AbstractQueue; 10a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilsonimport java.util.Collection; 11a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilsonimport java.util.Iterator; 12a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilsonimport java.util.NoSuchElementException; 13a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilsonimport java.util.Queue; 14a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilsonimport java.util.concurrent.TimeUnit; 15a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilsonimport java.util.concurrent.locks.LockSupport; 16a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 17a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson// BEGIN android-note 18a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson// removed link to collections framework docs 19a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson// END android-note 20a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 21a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson/** 22a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * An unbounded {@link TransferQueue} based on linked nodes. 23a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * This queue orders elements FIFO (first-in-first-out) with respect 24a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * to any given producer. The <em>head</em> of the queue is that 25a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * element that has been on the queue the longest time for some 26a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * producer. The <em>tail</em> of the queue is that element that has 27a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * been on the queue the shortest time for some producer. 28a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 29a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * <p>Beware that, unlike in most collections, the {@code size} method 30a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * is <em>NOT</em> a constant-time operation. Because of the 31a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * asynchronous nature of these queues, determining the current number 32a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * of elements requires a traversal of the elements, and so may report 33a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * inaccurate results if this collection is modified during traversal. 34a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Additionally, the bulk operations {@code addAll}, 35a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * {@code removeAll}, {@code retainAll}, {@code containsAll}, 36a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * {@code equals}, and {@code toArray} are <em>not</em> guaranteed 37a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * to be performed atomically. For example, an iterator operating 38a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * concurrently with an {@code addAll} operation might view only some 39a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * of the added elements. 40a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 41a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * <p>This class and its iterator implement all of the 42a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * <em>optional</em> methods of the {@link Collection} and {@link 43a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Iterator} interfaces. 44a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 45a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * <p>Memory consistency effects: As with other concurrent 46a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * collections, actions in a thread prior to placing an object into a 47a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * {@code LinkedTransferQueue} 48a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * <a href="package-summary.html#MemoryVisibility"><i>happen-before</i></a> 49a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * actions subsequent to the access or removal of that element from 50a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * the {@code LinkedTransferQueue} in another thread. 51a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 52a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @since 1.7 53a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @hide 54a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @author Doug Lea 55a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @param <E> the type of elements held in this collection 56a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 57a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilsonpublic class LinkedTransferQueue<E> extends AbstractQueue<E> 58a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson implements TransferQueue<E>, java.io.Serializable { 59a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private static final long serialVersionUID = -3223113410248163686L; 60a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 61a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /* 62a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * *** Overview of Dual Queues with Slack *** 63a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 64a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Dual Queues, introduced by Scherer and Scott 65a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * (http://www.cs.rice.edu/~wns1/papers/2004-DISC-DDS.pdf) are 66a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * (linked) queues in which nodes may represent either data or 67a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * requests. When a thread tries to enqueue a data node, but 68a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * encounters a request node, it instead "matches" and removes it; 69a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * and vice versa for enqueuing requests. Blocking Dual Queues 70a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * arrange that threads enqueuing unmatched requests block until 71a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * other threads provide the match. Dual Synchronous Queues (see 72a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Scherer, Lea, & Scott 73a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * http://www.cs.rochester.edu/u/scott/papers/2009_Scherer_CACM_SSQ.pdf) 74a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * additionally arrange that threads enqueuing unmatched data also 75a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * block. Dual Transfer Queues support all of these modes, as 76a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * dictated by callers. 77a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 78a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * A FIFO dual queue may be implemented using a variation of the 79a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Michael & Scott (M&S) lock-free queue algorithm 80a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * (http://www.cs.rochester.edu/u/scott/papers/1996_PODC_queues.pdf). 81a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * It maintains two pointer fields, "head", pointing to a 82a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * (matched) node that in turn points to the first actual 83a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * (unmatched) queue node (or null if empty); and "tail" that 84a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * points to the last node on the queue (or again null if 85a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * empty). For example, here is a possible queue with four data 86a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * elements: 87a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 88a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * head tail 89a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * | | 90a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * v v 91a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * M -> U -> U -> U -> U 92a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 93a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * The M&S queue algorithm is known to be prone to scalability and 94a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * overhead limitations when maintaining (via CAS) these head and 95a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * tail pointers. This has led to the development of 96a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * contention-reducing variants such as elimination arrays (see 97a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Moir et al http://portal.acm.org/citation.cfm?id=1074013) and 98a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * optimistic back pointers (see Ladan-Mozes & Shavit 99a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * http://people.csail.mit.edu/edya/publications/OptimisticFIFOQueue-journal.pdf). 100a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * However, the nature of dual queues enables a simpler tactic for 101a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * improving M&S-style implementations when dual-ness is needed. 102a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 103a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * In a dual queue, each node must atomically maintain its match 104a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * status. While there are other possible variants, we implement 105a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * this here as: for a data-mode node, matching entails CASing an 106a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * "item" field from a non-null data value to null upon match, and 107a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * vice-versa for request nodes, CASing from null to a data 108a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * value. (Note that the linearization properties of this style of 109a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * queue are easy to verify -- elements are made available by 110a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * linking, and unavailable by matching.) Compared to plain M&S 111a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * queues, this property of dual queues requires one additional 112a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * successful atomic operation per enq/deq pair. But it also 113a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * enables lower cost variants of queue maintenance mechanics. (A 114a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * variation of this idea applies even for non-dual queues that 115a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * support deletion of interior elements, such as 116a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * j.u.c.ConcurrentLinkedQueue.) 117a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 118a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Once a node is matched, its match status can never again 119a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * change. We may thus arrange that the linked list of them 120a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * contain a prefix of zero or more matched nodes, followed by a 121a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * suffix of zero or more unmatched nodes. (Note that we allow 122a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * both the prefix and suffix to be zero length, which in turn 123a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * means that we do not use a dummy header.) If we were not 124a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * concerned with either time or space efficiency, we could 125a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * correctly perform enqueue and dequeue operations by traversing 126a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * from a pointer to the initial node; CASing the item of the 127a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * first unmatched node on match and CASing the next field of the 128a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * trailing node on appends. (Plus some special-casing when 129a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * initially empty). While this would be a terrible idea in 130a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * itself, it does have the benefit of not requiring ANY atomic 131a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * updates on head/tail fields. 132a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 133a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * We introduce here an approach that lies between the extremes of 134a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * never versus always updating queue (head and tail) pointers. 135a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * This offers a tradeoff between sometimes requiring extra 136a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * traversal steps to locate the first and/or last unmatched 137a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * nodes, versus the reduced overhead and contention of fewer 138a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * updates to queue pointers. For example, a possible snapshot of 139a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * a queue is: 140a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 141a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * head tail 142a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * | | 143a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * v v 144a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * M -> M -> U -> U -> U -> U 145a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 146a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * The best value for this "slack" (the targeted maximum distance 147a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * between the value of "head" and the first unmatched node, and 148a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * similarly for "tail") is an empirical matter. We have found 149a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * that using very small constants in the range of 1-3 work best 150a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * over a range of platforms. Larger values introduce increasing 151a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * costs of cache misses and risks of long traversal chains, while 152a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * smaller values increase CAS contention and overhead. 153a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 154a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Dual queues with slack differ from plain M&S dual queues by 155a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * virtue of only sometimes updating head or tail pointers when 156a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * matching, appending, or even traversing nodes; in order to 157a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * maintain a targeted slack. The idea of "sometimes" may be 158a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * operationalized in several ways. The simplest is to use a 159a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * per-operation counter incremented on each traversal step, and 160a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * to try (via CAS) to update the associated queue pointer 161a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * whenever the count exceeds a threshold. Another, that requires 162a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * more overhead, is to use random number generators to update 163a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * with a given probability per traversal step. 164a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 165a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * In any strategy along these lines, because CASes updating 166a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * fields may fail, the actual slack may exceed targeted 167a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * slack. However, they may be retried at any time to maintain 168a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * targets. Even when using very small slack values, this 169a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * approach works well for dual queues because it allows all 170a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * operations up to the point of matching or appending an item 171a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * (hence potentially allowing progress by another thread) to be 172a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * read-only, thus not introducing any further contention. As 173a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * described below, we implement this by performing slack 174a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * maintenance retries only after these points. 175a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 176a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * As an accompaniment to such techniques, traversal overhead can 177a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * be further reduced without increasing contention of head 178a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * pointer updates: Threads may sometimes shortcut the "next" link 179a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * path from the current "head" node to be closer to the currently 180a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * known first unmatched node, and similarly for tail. Again, this 181a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * may be triggered with using thresholds or randomization. 182a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 183a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * These ideas must be further extended to avoid unbounded amounts 184a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * of costly-to-reclaim garbage caused by the sequential "next" 185a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * links of nodes starting at old forgotten head nodes: As first 186a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * described in detail by Boehm 187a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * (http://portal.acm.org/citation.cfm?doid=503272.503282) if a GC 188a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * delays noticing that any arbitrarily old node has become 189a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * garbage, all newer dead nodes will also be unreclaimed. 190a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * (Similar issues arise in non-GC environments.) To cope with 191a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * this in our implementation, upon CASing to advance the head 192a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * pointer, we set the "next" link of the previous head to point 193a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * only to itself; thus limiting the length of connected dead lists. 194a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * (We also take similar care to wipe out possibly garbage 195a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * retaining values held in other Node fields.) However, doing so 196a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * adds some further complexity to traversal: If any "next" 197a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * pointer links to itself, it indicates that the current thread 198a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * has lagged behind a head-update, and so the traversal must 199a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * continue from the "head". Traversals trying to find the 200a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * current tail starting from "tail" may also encounter 201a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * self-links, in which case they also continue at "head". 202a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 203a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * It is tempting in slack-based scheme to not even use CAS for 204a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * updates (similarly to Ladan-Mozes & Shavit). However, this 205a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * cannot be done for head updates under the above link-forgetting 206a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * mechanics because an update may leave head at a detached node. 207a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * And while direct writes are possible for tail updates, they 208a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * increase the risk of long retraversals, and hence long garbage 209a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * chains, which can be much more costly than is worthwhile 210a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * considering that the cost difference of performing a CAS vs 211a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * write is smaller when they are not triggered on each operation 212a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * (especially considering that writes and CASes equally require 213a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * additional GC bookkeeping ("write barriers") that are sometimes 214a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * more costly than the writes themselves because of contention). 215a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 216a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * *** Overview of implementation *** 217a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 218a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * We use a threshold-based approach to updates, with a slack 219a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * threshold of two -- that is, we update head/tail when the 220a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * current pointer appears to be two or more steps away from the 221a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * first/last node. The slack value is hard-wired: a path greater 222a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * than one is naturally implemented by checking equality of 223a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * traversal pointers except when the list has only one element, 224a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * in which case we keep slack threshold at one. Avoiding tracking 225a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * explicit counts across method calls slightly simplifies an 226a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * already-messy implementation. Using randomization would 227a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * probably work better if there were a low-quality dirt-cheap 228a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * per-thread one available, but even ThreadLocalRandom is too 229a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * heavy for these purposes. 230a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 231a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * With such a small slack threshold value, it is not worthwhile 232a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * to augment this with path short-circuiting (i.e., unsplicing 233a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * interior nodes) except in the case of cancellation/removal (see 234a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * below). 235a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 236a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * We allow both the head and tail fields to be null before any 237a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * nodes are enqueued; initializing upon first append. This 238a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * simplifies some other logic, as well as providing more 239a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * efficient explicit control paths instead of letting JVMs insert 240a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * implicit NullPointerExceptions when they are null. While not 241a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * currently fully implemented, we also leave open the possibility 242a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * of re-nulling these fields when empty (which is complicated to 243a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * arrange, for little benefit.) 244a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 245a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * All enqueue/dequeue operations are handled by the single method 246a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * "xfer" with parameters indicating whether to act as some form 247a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * of offer, put, poll, take, or transfer (each possibly with 248a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * timeout). The relative complexity of using one monolithic 249a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * method outweighs the code bulk and maintenance problems of 250a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * using separate methods for each case. 251a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 252a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Operation consists of up to three phases. The first is 253a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * implemented within method xfer, the second in tryAppend, and 254a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * the third in method awaitMatch. 255a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 256a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1. Try to match an existing node 257a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 258a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Starting at head, skip already-matched nodes until finding 259a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * an unmatched node of opposite mode, if one exists, in which 260a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * case matching it and returning, also if necessary updating 261a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * head to one past the matched node (or the node itself if the 262a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * list has no other unmatched nodes). If the CAS misses, then 263a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * a loop retries advancing head by two steps until either 264a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * success or the slack is at most two. By requiring that each 265a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * attempt advances head by two (if applicable), we ensure that 266a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * the slack does not grow without bound. Traversals also check 267a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * if the initial head is now off-list, in which case they 268a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * start at the new head. 269a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 270a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * If no candidates are found and the call was untimed 271a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * poll/offer, (argument "how" is NOW) return. 272a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 273a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 2. Try to append a new node (method tryAppend) 274a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 275a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Starting at current tail pointer, find the actual last node 276a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * and try to append a new node (or if head was null, establish 277a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * the first node). Nodes can be appended only if their 278a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * predecessors are either already matched or are of the same 279a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * mode. If we detect otherwise, then a new node with opposite 280a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * mode must have been appended during traversal, so we must 281a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * restart at phase 1. The traversal and update steps are 282a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * otherwise similar to phase 1: Retrying upon CAS misses and 283a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * checking for staleness. In particular, if a self-link is 284a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * encountered, then we can safely jump to a node on the list 285a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * by continuing the traversal at current head. 286a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 287a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * On successful append, if the call was ASYNC, return. 288a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 289a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 3. Await match or cancellation (method awaitMatch) 290a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 291a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Wait for another thread to match node; instead cancelling if 292a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * the current thread was interrupted or the wait timed out. On 293a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * multiprocessors, we use front-of-queue spinning: If a node 294a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * appears to be the first unmatched node in the queue, it 295a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * spins a bit before blocking. In either case, before blocking 296a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * it tries to unsplice any nodes between the current "head" 297a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * and the first unmatched node. 298a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 299a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Front-of-queue spinning vastly improves performance of 300a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * heavily contended queues. And so long as it is relatively 301a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * brief and "quiet", spinning does not much impact performance 302a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * of less-contended queues. During spins threads check their 303a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * interrupt status and generate a thread-local random number 304a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * to decide to occasionally perform a Thread.yield. While 305a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * yield has underdefined specs, we assume that it might help, 306a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * and will not hurt, in limiting impact of spinning on busy 307a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * systems. We also use smaller (1/2) spins for nodes that are 308a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * not known to be front but whose predecessors have not 309a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * blocked -- these "chained" spins avoid artifacts of 310a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * front-of-queue rules which otherwise lead to alternating 311a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * nodes spinning vs blocking. Further, front threads that 312a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * represent phase changes (from data to request node or vice 313a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * versa) compared to their predecessors receive additional 314a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * chained spins, reflecting longer paths typically required to 315a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * unblock threads during phase changes. 316a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 317a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 318a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * ** Unlinking removed interior nodes ** 319a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 320a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * In addition to minimizing garbage retention via self-linking 321a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * described above, we also unlink removed interior nodes. These 322a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * may arise due to timed out or interrupted waits, or calls to 323a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * remove(x) or Iterator.remove. Normally, given a node that was 324a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * at one time known to be the predecessor of some node s that is 325a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * to be removed, we can unsplice s by CASing the next field of 326a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * its predecessor if it still points to s (otherwise s must 327a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * already have been removed or is now offlist). But there are two 328a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * situations in which we cannot guarantee to make node s 329a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * unreachable in this way: (1) If s is the trailing node of list 330a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * (i.e., with null next), then it is pinned as the target node 331a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * for appends, so can only be removed later after other nodes are 332a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * appended. (2) We cannot necessarily unlink s given a 333a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * predecessor node that is matched (including the case of being 334a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * cancelled): the predecessor may already be unspliced, in which 335a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * case some previous reachable node may still point to s. 336a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * (For further explanation see Herlihy & Shavit "The Art of 337a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Multiprocessor Programming" chapter 9). Although, in both 338a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * cases, we can rule out the need for further action if either s 339a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * or its predecessor are (or can be made to be) at, or fall off 340a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * from, the head of list. 341a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 342a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Without taking these into account, it would be possible for an 343a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * unbounded number of supposedly removed nodes to remain 344a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * reachable. Situations leading to such buildup are uncommon but 345a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * can occur in practice; for example when a series of short timed 346a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * calls to poll repeatedly time out but never otherwise fall off 347a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * the list because of an untimed call to take at the front of the 348a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * queue. 349a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 350a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * When these cases arise, rather than always retraversing the 351a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * entire list to find an actual predecessor to unlink (which 352a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * won't help for case (1) anyway), we record a conservative 353a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * estimate of possible unsplice failures (in "sweepVotes"). 354a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * We trigger a full sweep when the estimate exceeds a threshold 355a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * ("SWEEP_THRESHOLD") indicating the maximum number of estimated 356a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * removal failures to tolerate before sweeping through, unlinking 357a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * cancelled nodes that were not unlinked upon initial removal. 358a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * We perform sweeps by the thread hitting threshold (rather than 359a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * background threads or by spreading work to other threads) 360a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * because in the main contexts in which removal occurs, the 361a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * caller is already timed-out, cancelled, or performing a 362a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * potentially O(n) operation (e.g. remove(x)), none of which are 363a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * time-critical enough to warrant the overhead that alternatives 364a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * would impose on other threads. 365a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 366a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Because the sweepVotes estimate is conservative, and because 367a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * nodes become unlinked "naturally" as they fall off the head of 368a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * the queue, and because we allow votes to accumulate even while 369a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * sweeps are in progress, there are typically significantly fewer 370a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * such nodes than estimated. Choice of a threshold value 371a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * balances the likelihood of wasted effort and contention, versus 372a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * providing a worst-case bound on retention of interior nodes in 373a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * quiescent queues. The value defined below was chosen 374a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * empirically to balance these under various timeout scenarios. 375a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 376a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Note that we cannot self-link unlinked interior nodes during 377a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * sweeps. However, the associated garbage chains terminate when 378a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * some successor ultimately falls off the head of the list and is 379a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * self-linked. 380a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 381a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 382a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** True if on multiprocessor */ 383a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private static final boolean MP = 384a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Runtime.getRuntime().availableProcessors() > 1; 385a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 386a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 387a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * The number of times to spin (with randomly interspersed calls 388a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * to Thread.yield) on multiprocessor before blocking when a node 389a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * is apparently the first waiter in the queue. See above for 390a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * explanation. Must be a power of two. The value is empirically 391a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * derived -- it works pretty well across a variety of processors, 392a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * numbers of CPUs, and OSes. 393a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 394a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private static final int FRONT_SPINS = 1 << 7; 395a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 396a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 397a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * The number of times to spin before blocking when a node is 398a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * preceded by another node that is apparently spinning. Also 399a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * serves as an increment to FRONT_SPINS on phase changes, and as 400a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * base average frequency for yielding during spins. Must be a 401a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * power of two. 402a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 403a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private static final int CHAINED_SPINS = FRONT_SPINS >>> 1; 404a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 405a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 406a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * The maximum number of estimated removal failures (sweepVotes) 407a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * to tolerate before sweeping through the queue unlinking 408a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * cancelled nodes that were not unlinked upon initial 409a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * removal. See above for explanation. The value must be at least 410a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * two to avoid useless sweeps when removing trailing nodes. 411a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 412a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson static final int SWEEP_THRESHOLD = 32; 413a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 414a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 415a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Queue nodes. Uses Object, not E, for items to allow forgetting 416a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * them after use. Relies heavily on Unsafe mechanics to minimize 417a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * unnecessary ordering constraints: Writes that are intrinsically 418a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * ordered wrt other accesses or CASes use simple relaxed forms. 419a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 420a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson static final class Node { 421a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson final boolean isData; // false if this is a request node 422a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson volatile Object item; // initially non-null if isData; CASed to match 423a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson volatile Node next; 424a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson volatile Thread waiter; // null until waiting 425a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 426a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson // CAS methods for fields 427a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson final boolean casNext(Node cmp, Node val) { 428a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return UNSAFE.compareAndSwapObject(this, nextOffset, cmp, val); 429a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 430a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 431a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson final boolean casItem(Object cmp, Object val) { 432a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson // assert cmp == null || cmp.getClass() != Node.class; 433a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return UNSAFE.compareAndSwapObject(this, itemOffset, cmp, val); 434a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 435a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 436a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 437a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Constructs a new node. Uses relaxed write because item can 438a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * only be seen after publication via casNext. 439a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 440a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Node(Object item, boolean isData) { 441a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson UNSAFE.putObject(this, itemOffset, item); // relaxed write 442a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson this.isData = isData; 443a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 444a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 445a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 446a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Links node to itself to avoid garbage retention. Called 447a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * only after CASing head field, so uses relaxed write. 448a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 449a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson final void forgetNext() { 450a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson UNSAFE.putObject(this, nextOffset, this); 451a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 452a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 453a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 454a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Sets item to self and waiter to null, to avoid garbage 455a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * retention after matching or cancelling. Uses relaxed writes 456a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * because order is already constrained in the only calling 457a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * contexts: item is forgotten only after volatile/atomic 458a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * mechanics that extract items. Similarly, clearing waiter 459a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * follows either CAS or return from park (if ever parked; 460a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * else we don't care). 461a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 462a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson final void forgetContents() { 463a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson UNSAFE.putObject(this, itemOffset, this); 464a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson UNSAFE.putObject(this, waiterOffset, null); 465a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 466a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 467a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 468a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Returns true if this node has been matched, including the 469a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * case of artificial matches due to cancellation. 470a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 471a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson final boolean isMatched() { 472a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Object x = item; 473a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return (x == this) || ((x == null) == isData); 474a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 475a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 476a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 477a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Returns true if this is an unmatched request node. 478a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 479a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson final boolean isUnmatchedRequest() { 480a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return !isData && item == null; 481a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 482a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 483a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 484a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Returns true if a node with the given mode cannot be 485a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * appended to this node because this node is unmatched and 486a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * has opposite data mode. 487a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 488a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson final boolean cannotPrecede(boolean haveData) { 489a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson boolean d = isData; 490a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Object x; 491a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return d != haveData && (x = item) != this && (x != null) == d; 492a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 493a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 494a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 495a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Tries to artificially match a data node -- used by remove. 496a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 497a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson final boolean tryMatchData() { 498a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson // assert isData; 499a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Object x = item; 500a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (x != null && x != this && casItem(x, null)) { 501a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson LockSupport.unpark(waiter); 502a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return true; 503a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 504a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return false; 505a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 506a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 507a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private static final long serialVersionUID = -3375979862319811754L; 508a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 509a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson // Unsafe mechanics 510a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private static final sun.misc.Unsafe UNSAFE; 511a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private static final long itemOffset; 512a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private static final long nextOffset; 513a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private static final long waiterOffset; 514a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson static { 515a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson try { 516a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson UNSAFE = sun.misc.Unsafe.getUnsafe(); 517a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Class<?> k = Node.class; 518a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson itemOffset = UNSAFE.objectFieldOffset 519a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson (k.getDeclaredField("item")); 520a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson nextOffset = UNSAFE.objectFieldOffset 521a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson (k.getDeclaredField("next")); 522a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson waiterOffset = UNSAFE.objectFieldOffset 523a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson (k.getDeclaredField("waiter")); 524a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } catch (Exception e) { 525a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson throw new Error(e); 526a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 527a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 528a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 529a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 530a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** head of the queue; null until first enqueue */ 531a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson transient volatile Node head; 532a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 533a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** tail of the queue; null until first append */ 534a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private transient volatile Node tail; 535a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 536a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** The number of apparent failures to unsplice removed nodes */ 537a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private transient volatile int sweepVotes; 538a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 539a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson // CAS methods for fields 540a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private boolean casTail(Node cmp, Node val) { 541a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return UNSAFE.compareAndSwapObject(this, tailOffset, cmp, val); 542a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 543a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 544a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private boolean casHead(Node cmp, Node val) { 545a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return UNSAFE.compareAndSwapObject(this, headOffset, cmp, val); 546a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 547a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 548a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private boolean casSweepVotes(int cmp, int val) { 549a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return UNSAFE.compareAndSwapInt(this, sweepVotesOffset, cmp, val); 550a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 551a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 552a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /* 553a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Possible values for "how" argument in xfer method. 554a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 555a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private static final int NOW = 0; // for untimed poll, tryTransfer 556a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private static final int ASYNC = 1; // for offer, put, add 557a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private static final int SYNC = 2; // for transfer, take 558a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private static final int TIMED = 3; // for timed poll, tryTransfer 559a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 560a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson @SuppressWarnings("unchecked") 561a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson static <E> E cast(Object item) { 562a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson // assert item == null || item.getClass() != Node.class; 563a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return (E) item; 564a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 565a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 566a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 567a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Implements all queuing methods. See above for explanation. 568a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 569a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @param e the item or null for take 570a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @param haveData true if this is a put, else a take 571a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @param how NOW, ASYNC, SYNC, or TIMED 572a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @param nanos timeout in nanosecs, used only if mode is TIMED 573a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @return an item if matched, else e 574a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @throws NullPointerException if haveData mode but e is null 575a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 576a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private E xfer(E e, boolean haveData, int how, long nanos) { 577a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (haveData && (e == null)) 578a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson throw new NullPointerException(); 579a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Node s = null; // the node to append, if needed 580a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 581a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson retry: 582a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson for (;;) { // restart on append race 583a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 584a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson for (Node h = head, p = h; p != null;) { // find & match first node 585a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson boolean isData = p.isData; 586a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Object item = p.item; 587a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (item != p && (item != null) == isData) { // unmatched 588a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (isData == haveData) // can't match 589a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson break; 590a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (p.casItem(item, e)) { // match 591a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson for (Node q = p; q != h;) { 592a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Node n = q.next; // update by 2 unless singleton 593a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (head == h && casHead(h, n == null ? q : n)) { 594a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson h.forgetNext(); 595a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson break; 596a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } // advance and retry 597a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if ((h = head) == null || 598a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson (q = h.next) == null || !q.isMatched()) 599a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson break; // unless slack < 2 600a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 601a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson LockSupport.unpark(p.waiter); 602a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return LinkedTransferQueue.<E>cast(item); 603a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 604a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 605a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Node n = p.next; 606a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson p = (p != n) ? n : (h = head); // Use head if p offlist 607a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 608a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 609a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (how != NOW) { // No matches available 610a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (s == null) 611a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson s = new Node(e, haveData); 612a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Node pred = tryAppend(s, haveData); 613a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (pred == null) 614a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson continue retry; // lost race vs opposite mode 615a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (how != ASYNC) 616a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return awaitMatch(s, pred, e, (how == TIMED), nanos); 617a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 618a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return e; // not waiting 619a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 620a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 621a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 622a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 623a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Tries to append node s as tail. 624a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 625a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @param s the node to append 626a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @param haveData true if appending in data mode 627a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @return null on failure due to losing race with append in 628a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * different mode, else s's predecessor, or s itself if no 629a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * predecessor 630a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 631a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private Node tryAppend(Node s, boolean haveData) { 632a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson for (Node t = tail, p = t;;) { // move p to last node and append 633a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Node n, u; // temps for reads of next & tail 634a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (p == null && (p = head) == null) { 635a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (casHead(null, s)) 636a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return s; // initialize 637a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 638a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else if (p.cannotPrecede(haveData)) 639a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return null; // lost race vs opposite mode 640a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else if ((n = p.next) != null) // not last; keep traversing 641a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson p = p != t && t != (u = tail) ? (t = u) : // stale tail 642a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson (p != n) ? n : null; // restart if off list 643a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else if (!p.casNext(null, s)) 644a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson p = p.next; // re-read on CAS failure 645a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else { 646a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (p != t) { // update if slack now >= 2 647a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson while ((tail != t || !casTail(t, s)) && 648a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson (t = tail) != null && 649a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson (s = t.next) != null && // advance and retry 650a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson (s = s.next) != null && s != t); 651a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 652a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return p; 653a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 654a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 655a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 656a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 657a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 658a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Spins/yields/blocks until node s is matched or caller gives up. 659a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 660a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @param s the waiting node 661a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @param pred the predecessor of s, or s itself if it has no 662a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * predecessor, or null if unknown (the null case does not occur 663a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * in any current calls but may in possible future extensions) 664a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @param e the comparison value for checking match 665a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @param timed if true, wait only until timeout elapses 666a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @param nanos timeout in nanosecs, used only if timed is true 667a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @return matched item, or e if unmatched on interrupt or timeout 668a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 669a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private E awaitMatch(Node s, Node pred, E e, boolean timed, long nanos) { 670a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson long lastTime = timed ? System.nanoTime() : 0L; 671a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Thread w = Thread.currentThread(); 672a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson int spins = -1; // initialized after first item and cancel checks 673a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson ThreadLocalRandom randomYields = null; // bound if needed 674a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 675a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson for (;;) { 676a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Object item = s.item; 677a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (item != e) { // matched 678a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson // assert item != s; 679a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson s.forgetContents(); // avoid garbage 680a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return LinkedTransferQueue.<E>cast(item); 681a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 682a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if ((w.isInterrupted() || (timed && nanos <= 0)) && 683a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson s.casItem(e, s)) { // cancel 684a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson unsplice(pred, s); 685a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return e; 686a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 687a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 688a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (spins < 0) { // establish spins at/near front 689a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if ((spins = spinsFor(pred, s.isData)) > 0) 690a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson randomYields = ThreadLocalRandom.current(); 691a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 692a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else if (spins > 0) { // spin 693a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson --spins; 694a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (randomYields.nextInt(CHAINED_SPINS) == 0) 695a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Thread.yield(); // occasionally yield 696a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 697a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else if (s.waiter == null) { 698a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson s.waiter = w; // request unpark then recheck 699a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 700a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else if (timed) { 701a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson long now = System.nanoTime(); 702a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if ((nanos -= now - lastTime) > 0) 703a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson LockSupport.parkNanos(this, nanos); 704a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson lastTime = now; 705a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 706a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else { 707a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson LockSupport.park(this); 708a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 709a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 710a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 711a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 712a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 713a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Returns spin/yield value for a node with given predecessor and 714a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * data mode. See above for explanation. 715a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 716a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private static int spinsFor(Node pred, boolean haveData) { 717a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (MP && pred != null) { 718a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (pred.isData != haveData) // phase change 719a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return FRONT_SPINS + CHAINED_SPINS; 720a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (pred.isMatched()) // probably at front 721a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return FRONT_SPINS; 722a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (pred.waiter == null) // pred apparently spinning 723a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return CHAINED_SPINS; 724a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 725a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return 0; 726a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 727a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 728a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /* -------------- Traversal methods -------------- */ 729a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 730a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 731a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Returns the successor of p, or the head node if p.next has been 732a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * linked to self, which will only be true if traversing with a 733a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * stale pointer that is now off the list. 734a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 735a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson final Node succ(Node p) { 736a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Node next = p.next; 737a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return (p == next) ? head : next; 738a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 739a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 740a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 741a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Returns the first unmatched node of the given mode, or null if 742a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * none. Used by methods isEmpty, hasWaitingConsumer. 743a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 744a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private Node firstOfMode(boolean isData) { 745a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson for (Node p = head; p != null; p = succ(p)) { 746a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (!p.isMatched()) 747a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return (p.isData == isData) ? p : null; 748a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 749a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return null; 750a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 751a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 752a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 753a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Returns the item in the first unmatched node with isData; or 754a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * null if none. Used by peek. 755a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 756a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private E firstDataItem() { 757a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson for (Node p = head; p != null; p = succ(p)) { 758a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Object item = p.item; 759a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (p.isData) { 760a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (item != null && item != p) 761a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return LinkedTransferQueue.<E>cast(item); 762a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 763a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else if (item == null) 764a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return null; 765a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 766a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return null; 767a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 768a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 769a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 770a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Traverses and counts unmatched nodes of the given mode. 771a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Used by methods size and getWaitingConsumerCount. 772a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 773a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private int countOfMode(boolean data) { 774a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson int count = 0; 775a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson for (Node p = head; p != null; ) { 776a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (!p.isMatched()) { 777a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (p.isData != data) 778a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return 0; 779a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (++count == Integer.MAX_VALUE) // saturated 780a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson break; 781a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 782a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Node n = p.next; 783a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (n != p) 784a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson p = n; 785a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else { 786a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson count = 0; 787a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson p = head; 788a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 789a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 790a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return count; 791a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 792a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 793a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson final class Itr implements Iterator<E> { 794a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private Node nextNode; // next node to return item for 795a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private E nextItem; // the corresponding item 796a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private Node lastRet; // last returned node, to support remove 797a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private Node lastPred; // predecessor to unlink lastRet 798a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 799a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 800a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Moves to next node after prev, or first node if prev null. 801a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 802a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private void advance(Node prev) { 803a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /* 804a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * To track and avoid buildup of deleted nodes in the face 805a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * of calls to both Queue.remove and Itr.remove, we must 806a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * include variants of unsplice and sweep upon each 807a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * advance: Upon Itr.remove, we may need to catch up links 808a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * from lastPred, and upon other removes, we might need to 809a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * skip ahead from stale nodes and unsplice deleted ones 810a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * found while advancing. 811a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 812a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 813a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Node r, b; // reset lastPred upon possible deletion of lastRet 814a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if ((r = lastRet) != null && !r.isMatched()) 815a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson lastPred = r; // next lastPred is old lastRet 816a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else if ((b = lastPred) == null || b.isMatched()) 817a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson lastPred = null; // at start of list 818a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else { 819a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Node s, n; // help with removal of lastPred.next 820a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson while ((s = b.next) != null && 821a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson s != b && s.isMatched() && 822a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson (n = s.next) != null && n != s) 823a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson b.casNext(s, n); 824a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 825a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 826a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson this.lastRet = prev; 827a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 828a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson for (Node p = prev, s, n;;) { 829a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson s = (p == null) ? head : p.next; 830a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (s == null) 831a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson break; 832a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else if (s == p) { 833a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson p = null; 834a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson continue; 835a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 836a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Object item = s.item; 837a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (s.isData) { 838a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (item != null && item != s) { 839a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson nextItem = LinkedTransferQueue.<E>cast(item); 840a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson nextNode = s; 841a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return; 842a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 843a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 844a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else if (item == null) 845a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson break; 846a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson // assert s.isMatched(); 847a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (p == null) 848a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson p = s; 849a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else if ((n = s.next) == null) 850a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson break; 851a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else if (s == n) 852a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson p = null; 853a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else 854a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson p.casNext(s, n); 855a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 856a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson nextNode = null; 857a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson nextItem = null; 858a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 859a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 860a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Itr() { 861a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson advance(null); 862a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 863a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 864a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public final boolean hasNext() { 865a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return nextNode != null; 866a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 867a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 868a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public final E next() { 869a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Node p = nextNode; 870a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (p == null) throw new NoSuchElementException(); 871a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson E e = nextItem; 872a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson advance(p); 873a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return e; 874a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 875a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 876a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public final void remove() { 877a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson final Node lastRet = this.lastRet; 878a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (lastRet == null) 879a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson throw new IllegalStateException(); 880a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson this.lastRet = null; 881a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (lastRet.tryMatchData()) 882a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson unsplice(lastPred, lastRet); 883a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 884a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 885a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 886a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /* -------------- Removal methods -------------- */ 887a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 888a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 889a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Unsplices (now or later) the given deleted/cancelled node with 890a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * the given predecessor. 891a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 892a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @param pred a node that was at one time known to be the 893a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * predecessor of s, or null or s itself if s is/was at head 894a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @param s the node to be unspliced 895a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 896a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson final void unsplice(Node pred, Node s) { 897a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson s.forgetContents(); // forget unneeded fields 898a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /* 899a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * See above for rationale. Briefly: if pred still points to 900a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * s, try to unlink s. If s cannot be unlinked, because it is 901a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * trailing node or pred might be unlinked, and neither pred 902a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * nor s are head or offlist, add to sweepVotes, and if enough 903a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * votes have accumulated, sweep. 904a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 905a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (pred != null && pred != s && pred.next == s) { 906a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Node n = s.next; 907a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (n == null || 908a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson (n != s && pred.casNext(s, n) && pred.isMatched())) { 909a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson for (;;) { // check if at, or could be, head 910a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Node h = head; 911a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (h == pred || h == s || h == null) 912a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return; // at head or list empty 913a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (!h.isMatched()) 914a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson break; 915a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Node hn = h.next; 916a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (hn == null) 917a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return; // now empty 918a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (hn != h && casHead(h, hn)) 919a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson h.forgetNext(); // advance head 920a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 921a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (pred.next != pred && s.next != s) { // recheck if offlist 922a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson for (;;) { // sweep now if enough votes 923a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson int v = sweepVotes; 924a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (v < SWEEP_THRESHOLD) { 925a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (casSweepVotes(v, v + 1)) 926a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson break; 927a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 928a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else if (casSweepVotes(v, 0)) { 929a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson sweep(); 930a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson break; 931a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 932a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 933a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 934a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 935a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 936a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 937a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 938a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 939a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Unlinks matched (typically cancelled) nodes encountered in a 940a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * traversal from head. 941a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 942a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private void sweep() { 943a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson for (Node p = head, s, n; p != null && (s = p.next) != null; ) { 944a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (!s.isMatched()) 945a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson // Unmatched nodes are never self-linked 946a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson p = s; 947a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else if ((n = s.next) == null) // trailing node is pinned 948a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson break; 949a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else if (s == n) // stale 950a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson // No need to also check for p == s, since that implies s == n 951a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson p = head; 952a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else 953a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson p.casNext(s, n); 954a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 955a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 956a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 957a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 958a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Main implementation of remove(Object) 959a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 960a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private boolean findAndRemove(Object e) { 961a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (e != null) { 962a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson for (Node pred = null, p = head; p != null; ) { 963a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Object item = p.item; 964a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (p.isData) { 965a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (item != null && item != p && e.equals(item) && 966a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson p.tryMatchData()) { 967a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson unsplice(pred, p); 968a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return true; 969a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 970a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 971a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else if (item == null) 972a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson break; 973a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson pred = p; 974a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if ((p = p.next) == pred) { // stale 975a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson pred = null; 976a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson p = head; 977a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 978a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 979a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 980a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return false; 981a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 982a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 983a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 984a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 985a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Creates an initially empty {@code LinkedTransferQueue}. 986a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 987a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public LinkedTransferQueue() { 988a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 989a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 990a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 991a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Creates a {@code LinkedTransferQueue} 992a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * initially containing the elements of the given collection, 993a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * added in traversal order of the collection's iterator. 994a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 995a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @param c the collection of elements to initially contain 996a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @throws NullPointerException if the specified collection or any 997a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * of its elements are null 998a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 999a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public LinkedTransferQueue(Collection<? extends E> c) { 1000a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson this(); 1001a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson addAll(c); 1002a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1003a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1004a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 1005a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Inserts the specified element at the tail of this queue. 1006a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * As the queue is unbounded, this method will never block. 1007a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1008a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @throws NullPointerException if the specified element is null 1009a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 1010a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public void put(E e) { 1011a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson xfer(e, true, ASYNC, 0); 1012a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1013a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1014a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 1015a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Inserts the specified element at the tail of this queue. 1016a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * As the queue is unbounded, this method will never block or 1017a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * return {@code false}. 1018a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1019a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @return {@code true} (as specified by 1020a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * {@link java.util.concurrent.BlockingQueue#offer(Object,long,TimeUnit) 1021a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * BlockingQueue.offer}) 1022a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @throws NullPointerException if the specified element is null 1023a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 1024a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public boolean offer(E e, long timeout, TimeUnit unit) { 1025a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson xfer(e, true, ASYNC, 0); 1026a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return true; 1027a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1028a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1029a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 1030a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Inserts the specified element at the tail of this queue. 1031a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * As the queue is unbounded, this method will never return {@code false}. 1032a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1033a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @return {@code true} (as specified by {@link Queue#offer}) 1034a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @throws NullPointerException if the specified element is null 1035a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 1036a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public boolean offer(E e) { 1037a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson xfer(e, true, ASYNC, 0); 1038a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return true; 1039a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1040a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1041a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 1042a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Inserts the specified element at the tail of this queue. 1043a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * As the queue is unbounded, this method will never throw 1044a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * {@link IllegalStateException} or return {@code false}. 1045a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1046a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @return {@code true} (as specified by {@link Collection#add}) 1047a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @throws NullPointerException if the specified element is null 1048a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 1049a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public boolean add(E e) { 1050a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson xfer(e, true, ASYNC, 0); 1051a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return true; 1052a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1053a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1054a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 1055a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Transfers the element to a waiting consumer immediately, if possible. 1056a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1057a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * <p>More precisely, transfers the specified element immediately 1058a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * if there exists a consumer already waiting to receive it (in 1059a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * {@link #take} or timed {@link #poll(long,TimeUnit) poll}), 1060a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * otherwise returning {@code false} without enqueuing the element. 1061a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1062a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @throws NullPointerException if the specified element is null 1063a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 1064a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public boolean tryTransfer(E e) { 1065a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return xfer(e, true, NOW, 0) == null; 1066a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1067a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1068a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 1069a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Transfers the element to a consumer, waiting if necessary to do so. 1070a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1071a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * <p>More precisely, transfers the specified element immediately 1072a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * if there exists a consumer already waiting to receive it (in 1073a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * {@link #take} or timed {@link #poll(long,TimeUnit) poll}), 1074a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * else inserts the specified element at the tail of this queue 1075a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * and waits until the element is received by a consumer. 1076a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1077a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @throws NullPointerException if the specified element is null 1078a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 1079a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public void transfer(E e) throws InterruptedException { 1080a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (xfer(e, true, SYNC, 0) != null) { 1081a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Thread.interrupted(); // failure possible only due to interrupt 1082a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson throw new InterruptedException(); 1083a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1084a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1085a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1086a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 1087a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Transfers the element to a consumer if it is possible to do so 1088a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * before the timeout elapses. 1089a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1090a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * <p>More precisely, transfers the specified element immediately 1091a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * if there exists a consumer already waiting to receive it (in 1092a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * {@link #take} or timed {@link #poll(long,TimeUnit) poll}), 1093a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * else inserts the specified element at the tail of this queue 1094a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * and waits until the element is received by a consumer, 1095a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * returning {@code false} if the specified wait time elapses 1096a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * before the element can be transferred. 1097a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1098a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @throws NullPointerException if the specified element is null 1099a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 1100a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public boolean tryTransfer(E e, long timeout, TimeUnit unit) 1101a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson throws InterruptedException { 1102a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (xfer(e, true, TIMED, unit.toNanos(timeout)) == null) 1103a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return true; 1104a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (!Thread.interrupted()) 1105a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return false; 1106a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson throw new InterruptedException(); 1107a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1108a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1109a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public E take() throws InterruptedException { 1110a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson E e = xfer(null, false, SYNC, 0); 1111a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (e != null) 1112a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return e; 1113a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Thread.interrupted(); 1114a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson throw new InterruptedException(); 1115a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1116a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1117a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public E poll(long timeout, TimeUnit unit) throws InterruptedException { 1118a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson E e = xfer(null, false, TIMED, unit.toNanos(timeout)); 1119a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (e != null || !Thread.interrupted()) 1120a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return e; 1121a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson throw new InterruptedException(); 1122a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1123a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1124a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public E poll() { 1125a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return xfer(null, false, NOW, 0); 1126a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1127a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1128a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 1129a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @throws NullPointerException {@inheritDoc} 1130a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @throws IllegalArgumentException {@inheritDoc} 1131a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 1132a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public int drainTo(Collection<? super E> c) { 1133a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (c == null) 1134a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson throw new NullPointerException(); 1135a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (c == this) 1136a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson throw new IllegalArgumentException(); 1137a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson int n = 0; 1138a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson for (E e; (e = poll()) != null;) { 1139a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson c.add(e); 1140a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson ++n; 1141a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1142a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return n; 1143a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1144a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1145a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 1146a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @throws NullPointerException {@inheritDoc} 1147a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @throws IllegalArgumentException {@inheritDoc} 1148a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 1149a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public int drainTo(Collection<? super E> c, int maxElements) { 1150a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (c == null) 1151a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson throw new NullPointerException(); 1152a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (c == this) 1153a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson throw new IllegalArgumentException(); 1154a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson int n = 0; 1155a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson for (E e; n < maxElements && (e = poll()) != null;) { 1156a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson c.add(e); 1157a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson ++n; 1158a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1159a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return n; 1160a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1161a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1162a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 1163a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Returns an iterator over the elements in this queue in proper sequence. 1164a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * The elements will be returned in order from first (head) to last (tail). 1165a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1166a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * <p>The returned iterator is a "weakly consistent" iterator that 1167a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * will never throw {@link java.util.ConcurrentModificationException 1168a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * ConcurrentModificationException}, and guarantees to traverse 1169a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * elements as they existed upon construction of the iterator, and 1170a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * may (but is not guaranteed to) reflect any modifications 1171a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * subsequent to construction. 1172a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1173a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @return an iterator over the elements in this queue in proper sequence 1174a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 1175a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public Iterator<E> iterator() { 1176a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return new Itr(); 1177a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1178a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1179a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public E peek() { 1180a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return firstDataItem(); 1181a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1182a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1183a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 1184a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Returns {@code true} if this queue contains no elements. 1185a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1186a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @return {@code true} if this queue contains no elements 1187a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 1188a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public boolean isEmpty() { 1189a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson for (Node p = head; p != null; p = succ(p)) { 1190a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (!p.isMatched()) 1191a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return !p.isData; 1192a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1193a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return true; 1194a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1195a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1196a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public boolean hasWaitingConsumer() { 1197a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return firstOfMode(false) != null; 1198a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1199a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1200a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 1201a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Returns the number of elements in this queue. If this queue 1202a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * contains more than {@code Integer.MAX_VALUE} elements, returns 1203a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * {@code Integer.MAX_VALUE}. 1204a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1205a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * <p>Beware that, unlike in most collections, this method is 1206a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * <em>NOT</em> a constant-time operation. Because of the 1207a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * asynchronous nature of these queues, determining the current 1208a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * number of elements requires an O(n) traversal. 1209a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1210a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @return the number of elements in this queue 1211a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 1212a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public int size() { 1213a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return countOfMode(true); 1214a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1215a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1216a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public int getWaitingConsumerCount() { 1217a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return countOfMode(false); 1218a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1219a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1220a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 1221a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Removes a single instance of the specified element from this queue, 1222a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * if it is present. More formally, removes an element {@code e} such 1223a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * that {@code o.equals(e)}, if this queue contains one or more such 1224a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * elements. 1225a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Returns {@code true} if this queue contained the specified element 1226a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * (or equivalently, if this queue changed as a result of the call). 1227a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1228a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @param o element to be removed from this queue, if present 1229a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @return {@code true} if this queue changed as a result of the call 1230a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 1231a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public boolean remove(Object o) { 1232a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return findAndRemove(o); 1233a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1234a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1235a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 1236a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Returns {@code true} if this queue contains the specified element. 1237a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * More formally, returns {@code true} if and only if this queue contains 1238a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * at least one element {@code e} such that {@code o.equals(e)}. 1239a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1240a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @param o object to be checked for containment in this queue 1241a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @return {@code true} if this queue contains the specified element 1242a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 1243a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public boolean contains(Object o) { 1244a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (o == null) return false; 1245a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson for (Node p = head; p != null; p = succ(p)) { 1246a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Object item = p.item; 1247a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (p.isData) { 1248a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (item != null && item != p && o.equals(item)) 1249a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return true; 1250a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1251a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else if (item == null) 1252a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson break; 1253a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1254a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return false; 1255a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1256a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1257a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 1258a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Always returns {@code Integer.MAX_VALUE} because a 1259a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * {@code LinkedTransferQueue} is not capacity constrained. 1260a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1261a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @return {@code Integer.MAX_VALUE} (as specified by 1262a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * {@link java.util.concurrent.BlockingQueue#remainingCapacity() 1263a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * BlockingQueue.remainingCapacity}) 1264a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 1265a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson public int remainingCapacity() { 1266a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson return Integer.MAX_VALUE; 1267a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1268a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1269a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 1270a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Saves the state to a stream (that is, serializes it). 1271a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1272a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @serialData All of the elements (each an {@code E}) in 1273a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * the proper order, followed by a null 1274a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @param s the stream 1275a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 1276a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private void writeObject(java.io.ObjectOutputStream s) 1277a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson throws java.io.IOException { 1278a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson s.defaultWriteObject(); 1279a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson for (E e : this) 1280a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson s.writeObject(e); 1281a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson // Use trailing null as sentinel 1282a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson s.writeObject(null); 1283a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1284a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1285a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson /** 1286a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * Reconstitutes the Queue instance from a stream (that is, 1287a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * deserializes it). 1288a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * 1289a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson * @param s the stream 1290a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson */ 1291a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private void readObject(java.io.ObjectInputStream s) 1292a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson throws java.io.IOException, ClassNotFoundException { 1293a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson s.defaultReadObject(); 1294a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson for (;;) { 1295a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson @SuppressWarnings("unchecked") E item = (E) s.readObject(); 1296a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson if (item == null) 1297a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson break; 1298a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson else 1299a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson offer(item); 1300a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1301a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1302a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1303a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson // Unsafe mechanics 1304a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson 1305a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private static final sun.misc.Unsafe UNSAFE; 1306a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private static final long headOffset; 1307a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private static final long tailOffset; 1308a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson private static final long sweepVotesOffset; 1309a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson static { 1310a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson try { 1311a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson UNSAFE = sun.misc.Unsafe.getUnsafe(); 1312a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson Class<?> k = LinkedTransferQueue.class; 1313a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson headOffset = UNSAFE.objectFieldOffset 1314a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson (k.getDeclaredField("head")); 1315a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson tailOffset = UNSAFE.objectFieldOffset 1316a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson (k.getDeclaredField("tail")); 1317a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson sweepVotesOffset = UNSAFE.objectFieldOffset 1318a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson (k.getDeclaredField("sweepVotes")); 1319a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } catch (Exception e) { 1320a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson throw new Error(e); 1321a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1322a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson } 1323a807b4d808d2591894daf13aab179b2e9c46a2f5Jesse Wilson} 1324