ConcurrentLinkedQueue.java 29.9 KB
Newer Older
D
duke 已提交
1 2 3 4 5
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
6
 * published by the Free Software Foundation.  Oracle designates this
D
duke 已提交
7
 * particular file as subject to the "Classpath" exception as provided
8
 * by Oracle in the LICENSE file that accompanied this code.
D
duke 已提交
9 10 11 12 13 14 15 16 17 18 19
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
20 21 22
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
D
duke 已提交
23 24 25 26 27 28 29 30
 */

/*
 * This file is available under and governed by the GNU General Public
 * License version 2 only, as published by the Free Software Foundation.
 * However, the following notice accompanied the original version of this
 * file:
 *
D
dl 已提交
31 32 33
 * Written by Doug Lea and Martin Buchholz with assistance from members of
 * JCP JSR-166 Expert Group and released to the public domain, as explained
 * at http://creativecommons.org/licenses/publicdomain
D
duke 已提交
34 35 36 37
 */

package java.util.concurrent;

38 39 40 41 42 43
import java.util.AbstractQueue;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.NoSuchElementException;
import java.util.Queue;
D
duke 已提交
44 45 46 47 48 49 50 51 52 53

/**
 * An unbounded thread-safe {@linkplain Queue queue} based on linked nodes.
 * This queue orders elements FIFO (first-in-first-out).
 * The <em>head</em> of the queue is that element that has been on the
 * queue the longest time.
 * The <em>tail</em> of the queue is that element that has been on the
 * queue the shortest time. New elements
 * are inserted at the tail of the queue, and the queue retrieval
 * operations obtain elements at the head of the queue.
54
 * A {@code ConcurrentLinkedQueue} is an appropriate choice when
D
duke 已提交
55
 * many threads will share access to a common collection.
D
dl 已提交
56 57
 * Like most other concurrent collection implementations, this class
 * does not permit the use of {@code null} elements.
D
duke 已提交
58 59 60 61 62 63 64
 *
 * <p>This implementation employs an efficient &quot;wait-free&quot;
 * algorithm based on one described in <a
 * href="http://www.cs.rochester.edu/u/michael/PODC96.html"> Simple,
 * Fast, and Practical Non-Blocking and Blocking Concurrent Queue
 * Algorithms</a> by Maged M. Michael and Michael L. Scott.
 *
D
dl 已提交
65 66 67 68 69 70 71
 * <p>Iterators are <i>weakly consistent</i>, returning elements
 * reflecting the state of the queue at some point at or since the
 * creation of the iterator.  They do <em>not</em> throw {@link
 * ConcurrentModificationException}, and may proceed concurrently with
 * other operations.  Elements contained in the queue since the creation
 * of the iterator will be returned exactly once.
 *
72
 * <p>Beware that, unlike in most collections, the {@code size} method
D
duke 已提交
73 74 75 76
 * is <em>NOT</em> a constant-time operation. Because of the
 * asynchronous nature of these queues, determining the current number
 * of elements requires a traversal of the elements.
 *
D
dl 已提交
77 78
 * <p>This class and its iterator implement all of the <em>optional</em>
 * methods of the {@link Queue} and {@link Iterator} interfaces.
D
duke 已提交
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
 *
 * <p>Memory consistency effects: As with other concurrent
 * collections, actions in a thread prior to placing an object into a
 * {@code ConcurrentLinkedQueue}
 * <a href="package-summary.html#MemoryVisibility"><i>happen-before</i></a>
 * actions subsequent to the access or removal of that element from
 * the {@code ConcurrentLinkedQueue} in another thread.
 *
 * <p>This class is a member of the
 * <a href="{@docRoot}/../technotes/guides/collections/index.html">
 * Java Collections Framework</a>.
 *
 * @since 1.5
 * @author Doug Lea
 * @param <E> the type of elements held in this collection
 *
 */
public class ConcurrentLinkedQueue<E> extends AbstractQueue<E>
        implements Queue<E>, java.io.Serializable {
    private static final long serialVersionUID = 196745693267521676L;

    /*
101 102 103 104
     * This is a modification of the Michael & Scott algorithm,
     * adapted for a garbage-collected environment, with support for
     * interior node deletion (to support remove(Object)).  For
     * explanation, read the paper.
D
duke 已提交
105
     *
106 107
     * Note that like most non-blocking algorithms in this package,
     * this implementation relies on the fact that in garbage
D
duke 已提交
108 109 110 111
     * collected systems, there is no possibility of ABA problems due
     * to recycled nodes, so there is no need to use "counted
     * pointers" or related techniques seen in versions used in
     * non-GC'ed settings.
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
     *
     * The fundamental invariants are:
     * - There is exactly one (last) Node with a null next reference,
     *   which is CASed when enqueueing.  This last Node can be
     *   reached in O(1) time from tail, but tail is merely an
     *   optimization - it can always be reached in O(N) time from
     *   head as well.
     * - The elements contained in the queue are the non-null items in
     *   Nodes that are reachable from head.  CASing the item
     *   reference of a Node to null atomically removes it from the
     *   queue.  Reachability of all elements from head must remain
     *   true even in the case of concurrent modifications that cause
     *   head to advance.  A dequeued Node may remain in use
     *   indefinitely due to creation of an Iterator or simply a
     *   poll() that has lost its time slice.
     *
     * The above might appear to imply that all Nodes are GC-reachable
     * from a predecessor dequeued Node.  That would cause two problems:
     * - allow a rogue Iterator to cause unbounded memory retention
     * - cause cross-generational linking of old Nodes to new Nodes if
     *   a Node was tenured while live, which generational GCs have a
     *   hard time dealing with, causing repeated major collections.
     * However, only non-deleted Nodes need to be reachable from
     * dequeued Nodes, and reachability does not necessarily have to
     * be of the kind understood by the GC.  We use the trick of
     * linking a Node that has just been dequeued to itself.  Such a
     * self-link implicitly means to advance to head.
     *
     * Both head and tail are permitted to lag.  In fact, failing to
     * update them every time one could is a significant optimization
D
dl 已提交
142 143 144 145
     * (fewer CASes). As with LinkedTransferQueue (see the internal
     * documentation for that class), we use a slack threshold of two;
     * that is, we update head/tail when the current pointer appears
     * to be two or more steps away from the first/last node.
146 147 148 149 150 151 152 153 154 155 156 157 158
     *
     * Since head and tail are updated concurrently and independently,
     * it is possible for tail to lag behind head (why not)?
     *
     * CASing a Node's item reference to null atomically removes the
     * element from the queue.  Iterators skip over Nodes with null
     * items.  Prior implementations of this class had a race between
     * poll() and remove(Object) where the same element would appear
     * to be successfully removed by two concurrent operations.  The
     * method remove(Object) also lazily unlinks deleted Nodes, but
     * this is merely an optimization.
     *
     * When constructing a Node (before enqueuing it) we avoid paying
D
dl 已提交
159 160
     * for a volatile write to item by using Unsafe.putObject instead
     * of a normal write.  This allows the cost of enqueue to be
161 162 163 164 165 166 167 168
     * "one-and-a-half" CASes.
     *
     * Both head and tail may or may not point to a Node with a
     * non-null item.  If the queue is empty, all items must of course
     * be null.  Upon creation, both head and tail refer to a dummy
     * Node with null item.  Both head and tail are only updated using
     * CAS, so they never regress, although again this is merely an
     * optimization.
D
duke 已提交
169 170 171
     */

    private static class Node<E> {
D
dl 已提交
172 173
        volatile E item;
        volatile Node<E> next;
D
duke 已提交
174

D
dl 已提交
175 176 177 178
        /**
         * Constructs a new node.  Uses relaxed write because item can
         * only be seen after publication via casNext.
         */
179
        Node(E item) {
D
dl 已提交
180
            UNSAFE.putObject(this, itemOffset, item);
D
duke 已提交
181 182 183
        }

        boolean casItem(E cmp, E val) {
184
            return UNSAFE.compareAndSwapObject(this, itemOffset, cmp, val);
D
duke 已提交
185 186
        }

187 188
        void lazySetNext(Node<E> val) {
            UNSAFE.putOrderedObject(this, nextOffset, val);
D
duke 已提交
189 190
        }

191 192 193
        boolean casNext(Node<E> cmp, Node<E> val) {
            return UNSAFE.compareAndSwapObject(this, nextOffset, cmp, val);
        }
D
duke 已提交
194

195
        // Unsafe mechanics
D
duke 已提交
196

197 198 199 200 201 202
        private static final sun.misc.Unsafe UNSAFE =
            sun.misc.Unsafe.getUnsafe();
        private static final long nextOffset =
            objectFieldOffset(UNSAFE, "next", Node.class);
        private static final long itemOffset =
            objectFieldOffset(UNSAFE, "item", Node.class);
D
duke 已提交
203 204 205
    }

    /**
206 207 208 209 210 211 212 213 214 215
     * A node from which the first live (non-deleted) node (if any)
     * can be reached in O(1) time.
     * Invariants:
     * - all live nodes are reachable from head via succ()
     * - head != null
     * - (tmp = head).next != tmp || tmp != head
     * Non-invariants:
     * - head.item may or may not be null.
     * - it is permitted for tail to lag behind head, that is, for tail
     *   to not be reachable from head!
D
duke 已提交
216
     */
D
dl 已提交
217
    private transient volatile Node<E> head;
D
duke 已提交
218

219 220 221 222 223 224 225 226 227 228 229 230
    /**
     * A node from which the last node on list (that is, the unique
     * node with node.next == null) can be reached in O(1) time.
     * Invariants:
     * - the last node is always reachable from tail via succ()
     * - tail != null
     * Non-invariants:
     * - tail.item may or may not be null.
     * - it is permitted for tail to lag behind head, that is, for tail
     *   to not be reachable from head!
     * - tail.next may or may not be self-pointing to tail.
     */
D
dl 已提交
231
    private transient volatile Node<E> tail;
D
duke 已提交
232 233 234


    /**
235
     * Creates a {@code ConcurrentLinkedQueue} that is initially empty.
D
duke 已提交
236
     */
D
dl 已提交
237 238 239
    public ConcurrentLinkedQueue() {
        head = tail = new Node<E>(null);
    }
D
duke 已提交
240 241

    /**
242
     * Creates a {@code ConcurrentLinkedQueue}
D
duke 已提交
243 244
     * initially containing the elements of the given collection,
     * added in traversal order of the collection's iterator.
D
dl 已提交
245
     *
D
duke 已提交
246 247 248 249 250
     * @param c the collection of elements to initially contain
     * @throws NullPointerException if the specified collection or any
     *         of its elements are null
     */
    public ConcurrentLinkedQueue(Collection<? extends E> c) {
D
dl 已提交
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
        Node<E> h = null, t = null;
        for (E e : c) {
            checkNotNull(e);
            Node<E> newNode = new Node<E>(e);
            if (h == null)
                h = t = newNode;
            else {
                t.lazySetNext(newNode);
                t = newNode;
            }
        }
        if (h == null)
            h = t = new Node<E>(null);
        head = h;
        tail = t;
D
duke 已提交
266 267 268 269 270 271 272
    }

    // Have to override just to update the javadoc

    /**
     * Inserts the specified element at the tail of this queue.
     *
273
     * @return {@code true} (as specified by {@link Collection#add})
D
duke 已提交
274 275 276 277 278 279
     * @throws NullPointerException if the specified element is null
     */
    public boolean add(E e) {
        return offer(e);
    }

280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
    /**
     * Try to CAS head to p. If successful, repoint old head to itself
     * as sentinel for succ(), below.
     */
    final void updateHead(Node<E> h, Node<E> p) {
        if (h != p && casHead(h, p))
            h.lazySetNext(h);
    }

    /**
     * Returns the successor of p, or the head node if p.next has been
     * linked to self, which will only be true if traversing with a
     * stale pointer that is now off the list.
     */
    final Node<E> succ(Node<E> p) {
D
dl 已提交
295
        Node<E> next = p.next;
296 297 298
        return (p == next) ? head : next;
    }

D
duke 已提交
299 300 301
    /**
     * Inserts the specified element at the tail of this queue.
     *
302
     * @return {@code true} (as specified by {@link Queue#offer})
D
duke 已提交
303 304 305
     * @throws NullPointerException if the specified element is null
     */
    public boolean offer(E e) {
D
dl 已提交
306 307 308 309 310 311 312 313 314 315 316 317 318
        checkNotNull(e);
        final Node<E> newNode = new Node<E>(e);

        for (Node<E> t = tail, p = t;;) {
            Node<E> q = p.next;
            if (q == null) {
                // p is last node
                if (p.casNext(null, newNode)) {
                    // Successful CAS is the linearization point
                    // for e to become an element of this queue,
                    // and for newNode to become "live".
                    if (p != t) // hop two nodes at a time
                        casTail(t, newNode);  // Failure is OK.
319
                    return true;
D
duke 已提交
320
                }
D
dl 已提交
321
                // Lost CAS race to another thread; re-read next
D
duke 已提交
322
            }
D
dl 已提交
323 324 325 326 327 328 329 330 331
            else if (p == q)
                // We have fallen off list.  If tail is unchanged, it
                // will also be off-list, in which case we need to
                // jump to head, from which all live nodes are always
                // reachable.  Else the new tail is a better bet.
                p = (t != (t = tail)) ? t : head;
            else
                // Check for tail updates after two hops.
                p = (p != t && t != (t = tail)) ? t : q;
D
duke 已提交
332 333 334 335
        }
    }

    public E poll() {
D
dl 已提交
336 337 338 339 340 341 342 343 344 345 346
        restartFromHead:
        for (;;) {
            for (Node<E> h = head, p = h, q;;) {
                E item = p.item;

                if (item != null && p.casItem(item, null)) {
                    // Successful CAS is the linearization point
                    // for item to be removed from this queue.
                    if (p != h) // hop two nodes at a time
                        updateHead(h, ((q = p.next) != null) ? q : p);
                    return item;
D
duke 已提交
347
                }
D
dl 已提交
348 349 350 351 352 353 354 355
                else if ((q = p.next) == null) {
                    updateHead(h, p);
                    return null;
                }
                else if (p == q)
                    continue restartFromHead;
                else
                    p = q;
D
duke 已提交
356 357 358 359
            }
        }
    }

360
    public E peek() {
D
dl 已提交
361
        restartFromHead:
D
duke 已提交
362
        for (;;) {
D
dl 已提交
363 364 365 366 367 368 369 370 371 372
            for (Node<E> h = head, p = h, q;;) {
                E item = p.item;
                if (item != null || (q = p.next) == null) {
                    updateHead(h, p);
                    return item;
                }
                else if (p == q)
                    continue restartFromHead;
                else
                    p = q;
D
duke 已提交
373 374 375 376 377
            }
        }
    }

    /**
378 379 380 381 382 383
     * Returns the first live (non-deleted) node on list, or null if none.
     * This is yet another variant of poll/peek; here returning the
     * first node, not element.  We could make peek() a wrapper around
     * first(), but that would cost an extra volatile read of item,
     * and the need to add a retry loop to deal with the possibility
     * of losing a race to a concurrent poll().
D
duke 已提交
384 385
     */
    Node<E> first() {
D
dl 已提交
386
        restartFromHead:
D
duke 已提交
387
        for (;;) {
D
dl 已提交
388 389 390 391 392 393 394 395 396 397
            for (Node<E> h = head, p = h, q;;) {
                boolean hasItem = (p.item != null);
                if (hasItem || (q = p.next) == null) {
                    updateHead(h, p);
                    return hasItem ? p : null;
                }
                else if (p == q)
                    continue restartFromHead;
                else
                    p = q;
D
duke 已提交
398 399 400 401 402
            }
        }
    }

    /**
403
     * Returns {@code true} if this queue contains no elements.
D
duke 已提交
404
     *
405
     * @return {@code true} if this queue contains no elements
D
duke 已提交
406 407 408 409 410 411 412
     */
    public boolean isEmpty() {
        return first() == null;
    }

    /**
     * Returns the number of elements in this queue.  If this queue
413 414
     * contains more than {@code Integer.MAX_VALUE} elements, returns
     * {@code Integer.MAX_VALUE}.
D
duke 已提交
415 416 417 418 419
     *
     * <p>Beware that, unlike in most collections, this method is
     * <em>NOT</em> a constant-time operation. Because of the
     * asynchronous nature of these queues, determining the current
     * number of elements requires an O(n) traversal.
D
dl 已提交
420 421 422 423
     * Additionally, if elements are added or removed during execution
     * of this method, the returned result may be inaccurate.  Thus,
     * this method is typically not very useful in concurrent
     * applications.
D
duke 已提交
424 425 426 427 428
     *
     * @return the number of elements in this queue
     */
    public int size() {
        int count = 0;
D
dl 已提交
429 430 431
        for (Node<E> p = first(); p != null; p = succ(p))
            if (p.item != null)
                // Collection.size() spec says to max out
D
duke 已提交
432 433 434 435 436 437
                if (++count == Integer.MAX_VALUE)
                    break;
        return count;
    }

    /**
438 439 440
     * Returns {@code true} if this queue contains the specified element.
     * More formally, returns {@code true} if and only if this queue contains
     * at least one element {@code e} such that {@code o.equals(e)}.
D
duke 已提交
441 442
     *
     * @param o object to be checked for containment in this queue
443
     * @return {@code true} if this queue contains the specified element
D
duke 已提交
444 445 446
     */
    public boolean contains(Object o) {
        if (o == null) return false;
447
        for (Node<E> p = first(); p != null; p = succ(p)) {
D
dl 已提交
448 449
            E item = p.item;
            if (item != null && o.equals(item))
D
duke 已提交
450 451 452 453 454 455 456
                return true;
        }
        return false;
    }

    /**
     * Removes a single instance of the specified element from this queue,
457 458
     * if it is present.  More formally, removes an element {@code e} such
     * that {@code o.equals(e)}, if this queue contains one or more such
D
duke 已提交
459
     * elements.
460
     * Returns {@code true} if this queue contained the specified element
D
duke 已提交
461 462 463
     * (or equivalently, if this queue changed as a result of the call).
     *
     * @param o element to be removed from this queue, if present
464
     * @return {@code true} if this queue changed as a result of the call
D
duke 已提交
465 466 467
     */
    public boolean remove(Object o) {
        if (o == null) return false;
468 469
        Node<E> pred = null;
        for (Node<E> p = first(); p != null; p = succ(p)) {
D
dl 已提交
470
            E item = p.item;
D
duke 已提交
471 472
            if (item != null &&
                o.equals(item) &&
473 474 475 476
                p.casItem(item, null)) {
                Node<E> next = succ(p);
                if (pred != null && next != null)
                    pred.casNext(p, next);
D
duke 已提交
477
                return true;
478 479
            }
            pred = p;
D
duke 已提交
480 481 482 483
        }
        return false;
    }

D
dl 已提交
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
    /**
     * Appends all of the elements in the specified collection to the end of
     * this queue, in the order that they are returned by the specified
     * collection's iterator.  Attempts to {@code addAll} of a queue to
     * itself result in {@code IllegalArgumentException}.
     *
     * @param c the elements to be inserted into this queue
     * @return {@code true} if this queue changed as a result of the call
     * @throws NullPointerException if the specified collection or any
     *         of its elements are null
     * @throws IllegalArgumentException if the collection is this queue
     */
    public boolean addAll(Collection<? extends E> c) {
        if (c == this)
            // As historically specified in AbstractQueue#addAll
            throw new IllegalArgumentException();

        // Copy c into a private chain of Nodes
        Node<E> beginningOfTheEnd = null, last = null;
        for (E e : c) {
            checkNotNull(e);
            Node<E> newNode = new Node<E>(e);
            if (beginningOfTheEnd == null)
                beginningOfTheEnd = last = newNode;
            else {
                last.lazySetNext(newNode);
                last = newNode;
            }
        }
        if (beginningOfTheEnd == null)
            return false;

        // Atomically append the chain at the tail of this collection
        for (Node<E> t = tail, p = t;;) {
            Node<E> q = p.next;
            if (q == null) {
                // p is last node
                if (p.casNext(null, beginningOfTheEnd)) {
                    // Successful CAS is the linearization point
                    // for all elements to be added to this queue.
                    if (!casTail(t, last)) {
                        // Try a little harder to update tail,
                        // since we may be adding many elements.
                        t = tail;
                        if (last.next == null)
                            casTail(t, last);
                    }
                    return true;
                }
                // Lost CAS race to another thread; re-read next
            }
            else if (p == q)
                // We have fallen off list.  If tail is unchanged, it
                // will also be off-list, in which case we need to
                // jump to head, from which all live nodes are always
                // reachable.  Else the new tail is a better bet.
                p = (t != (t = tail)) ? t : head;
            else
                // Check for tail updates after two hops.
                p = (p != t && t != (t = tail)) ? t : q;
        }
    }

D
duke 已提交
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
    /**
     * Returns an array containing all of the elements in this queue, in
     * proper sequence.
     *
     * <p>The returned array will be "safe" in that no references to it are
     * maintained by this queue.  (In other words, this method must allocate
     * a new array).  The caller is thus free to modify the returned array.
     *
     * <p>This method acts as bridge between array-based and collection-based
     * APIs.
     *
     * @return an array containing all of the elements in this queue
     */
    public Object[] toArray() {
        // Use ArrayList to deal with resizing.
        ArrayList<E> al = new ArrayList<E>();
563
        for (Node<E> p = first(); p != null; p = succ(p)) {
D
dl 已提交
564
            E item = p.item;
D
duke 已提交
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
            if (item != null)
                al.add(item);
        }
        return al.toArray();
    }

    /**
     * Returns an array containing all of the elements in this queue, in
     * proper sequence; the runtime type of the returned array is that of
     * the specified array.  If the queue fits in the specified array, it
     * is returned therein.  Otherwise, a new array is allocated with the
     * runtime type of the specified array and the size of this queue.
     *
     * <p>If this queue fits in the specified array with room to spare
     * (i.e., the array has more elements than this queue), the element in
     * the array immediately following the end of the queue is set to
581
     * {@code null}.
D
duke 已提交
582 583 584 585 586 587
     *
     * <p>Like the {@link #toArray()} method, this method acts as bridge between
     * array-based and collection-based APIs.  Further, this method allows
     * precise control over the runtime type of the output array, and may,
     * under certain circumstances, be used to save allocation costs.
     *
588
     * <p>Suppose {@code x} is a queue known to contain only strings.
D
duke 已提交
589
     * The following code can be used to dump the queue into a newly
590
     * allocated array of {@code String}:
D
duke 已提交
591 592 593 594
     *
     * <pre>
     *     String[] y = x.toArray(new String[0]);</pre>
     *
595 596
     * Note that {@code toArray(new Object[0])} is identical in function to
     * {@code toArray()}.
D
duke 已提交
597 598 599 600 601 602 603 604 605 606
     *
     * @param a the array into which the elements of the queue are to
     *          be stored, if it is big enough; otherwise, a new array of the
     *          same runtime type is allocated for this purpose
     * @return an array containing all of the elements in this queue
     * @throws ArrayStoreException if the runtime type of the specified array
     *         is not a supertype of the runtime type of every element in
     *         this queue
     * @throws NullPointerException if the specified array is null
     */
607
    @SuppressWarnings("unchecked")
D
duke 已提交
608 609 610 611
    public <T> T[] toArray(T[] a) {
        // try to use sent-in array
        int k = 0;
        Node<E> p;
612
        for (p = first(); p != null && k < a.length; p = succ(p)) {
D
dl 已提交
613
            E item = p.item;
D
duke 已提交
614 615 616 617 618 619 620 621 622 623 624
            if (item != null)
                a[k++] = (T)item;
        }
        if (p == null) {
            if (k < a.length)
                a[k] = null;
            return a;
        }

        // If won't fit, use ArrayList version
        ArrayList<E> al = new ArrayList<E>();
625
        for (Node<E> q = first(); q != null; q = succ(q)) {
D
dl 已提交
626
            E item = q.item;
D
duke 已提交
627 628 629 630 631 632 633 634
            if (item != null)
                al.add(item);
        }
        return al.toArray(a);
    }

    /**
     * Returns an iterator over the elements in this queue in proper sequence.
D
dl 已提交
635 636 637
     * The elements will be returned in order from first (head) to last (tail).
     *
     * <p>The returned {@code Iterator} is a "weakly consistent" iterator that
M
martin 已提交
638 639
     * will never throw {@link java.util.ConcurrentModificationException
     * ConcurrentModificationException},
D
duke 已提交
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
     * and guarantees to traverse elements as they existed upon
     * construction of the iterator, and may (but is not guaranteed to)
     * reflect any modifications subsequent to construction.
     *
     * @return an iterator over the elements in this queue in proper sequence
     */
    public Iterator<E> iterator() {
        return new Itr();
    }

    private class Itr implements Iterator<E> {
        /**
         * Next node to return item for.
         */
        private Node<E> nextNode;

        /**
         * nextItem holds on to item fields because once we claim
         * that an element exists in hasNext(), we must return it in
         * the following next() call even if it was in the process of
         * being removed when hasNext() was called.
         */
        private E nextItem;

        /**
         * Node of the last returned item, to support remove.
         */
        private Node<E> lastRet;

        Itr() {
            advance();
        }

        /**
         * Moves to next valid node and returns item to return for
         * next(), or null if no such.
         */
        private E advance() {
            lastRet = nextNode;
            E x = nextItem;

681 682 683 684 685 686 687 688 689
            Node<E> pred, p;
            if (nextNode == null) {
                p = first();
                pred = null;
            } else {
                pred = nextNode;
                p = succ(nextNode);
            }

D
duke 已提交
690 691 692 693 694 695
            for (;;) {
                if (p == null) {
                    nextNode = null;
                    nextItem = null;
                    return x;
                }
D
dl 已提交
696
                E item = p.item;
D
duke 已提交
697 698 699 700
                if (item != null) {
                    nextNode = p;
                    nextItem = item;
                    return x;
701 702 703 704 705 706 707
                } else {
                    // skip over nulls
                    Node<E> next = succ(p);
                    if (pred != null && next != null)
                        pred.casNext(p, next);
                    p = next;
                }
D
duke 已提交
708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
            }
        }

        public boolean hasNext() {
            return nextNode != null;
        }

        public E next() {
            if (nextNode == null) throw new NoSuchElementException();
            return advance();
        }

        public void remove() {
            Node<E> l = lastRet;
            if (l == null) throw new IllegalStateException();
            // rely on a future traversal to relink.
D
dl 已提交
724
            l.item = null;
D
duke 已提交
725 726 727 728 729
            lastRet = null;
        }
    }

    /**
D
dl 已提交
730
     * Saves the state to a stream (that is, serializes it).
D
duke 已提交
731
     *
732
     * @serialData All of the elements (each an {@code E}) in
D
duke 已提交
733 734 735 736 737 738 739 740 741 742
     * the proper order, followed by a null
     * @param s the stream
     */
    private void writeObject(java.io.ObjectOutputStream s)
        throws java.io.IOException {

        // Write out any hidden stuff
        s.defaultWriteObject();

        // Write out all elements in the proper order.
743
        for (Node<E> p = first(); p != null; p = succ(p)) {
D
dl 已提交
744
            Object item = p.item;
D
duke 已提交
745 746 747 748 749 750 751 752 753
            if (item != null)
                s.writeObject(item);
        }

        // Use trailing null as sentinel
        s.writeObject(null);
    }

    /**
D
dl 已提交
754
     * Reconstitutes the instance from a stream (that is, deserializes it).
D
duke 已提交
755 756 757 758 759
     * @param s the stream
     */
    private void readObject(java.io.ObjectInputStream s)
        throws java.io.IOException, ClassNotFoundException {
        s.defaultReadObject();
D
dl 已提交
760 761 762 763 764

        // Read in elements until trailing null sentinel found
        Node<E> h = null, t = null;
        Object item;
        while ((item = s.readObject()) != null) {
765
            @SuppressWarnings("unchecked")
D
dl 已提交
766 767 768 769 770 771 772
            Node<E> newNode = new Node<E>((E) item);
            if (h == null)
                h = t = newNode;
            else {
                t.lazySetNext(newNode);
                t = newNode;
            }
D
duke 已提交
773
        }
D
dl 已提交
774 775 776 777 778 779 780 781 782 783 784 785 786 787
        if (h == null)
            h = t = new Node<E>(null);
        head = h;
        tail = t;
    }

    /**
     * Throws NullPointerException if argument is null.
     *
     * @param v the element
     */
    private static void checkNotNull(Object v) {
        if (v == null)
            throw new NullPointerException();
D
duke 已提交
788 789
    }

790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
    // Unsafe mechanics

    private static final sun.misc.Unsafe UNSAFE = sun.misc.Unsafe.getUnsafe();
    private static final long headOffset =
        objectFieldOffset(UNSAFE, "head", ConcurrentLinkedQueue.class);
    private static final long tailOffset =
        objectFieldOffset(UNSAFE, "tail", ConcurrentLinkedQueue.class);

    private boolean casTail(Node<E> cmp, Node<E> val) {
        return UNSAFE.compareAndSwapObject(this, tailOffset, cmp, val);
    }

    private boolean casHead(Node<E> cmp, Node<E> val) {
        return UNSAFE.compareAndSwapObject(this, headOffset, cmp, val);
    }

    static long objectFieldOffset(sun.misc.Unsafe UNSAFE,
                                  String field, Class<?> klazz) {
        try {
            return UNSAFE.objectFieldOffset(klazz.getDeclaredField(field));
        } catch (NoSuchFieldException e) {
            // Convert Exception to corresponding Error
            NoSuchFieldError error = new NoSuchFieldError(field);
            error.initCause(e);
            throw error;
        }
    }
D
duke 已提交
817
}