jdk/src/share/classes/java/util/concurrent/ThreadLocalRandom.java
author dl
Wed, 16 Jan 2013 10:14:09 +0000
changeset 15266 379788c73130
parent 9242 ef138d47df58
child 16043 0c9424895efb
permissions -rw-r--r--
8005926: Merge ThreadLocalRandom state into java.lang.Thread Reviewed-by: shade, chegar
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4110
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
     1
/*
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
     2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
     3
 *
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
     4
 * This code is free software; you can redistribute it and/or modify it
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
     5
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4110
diff changeset
     6
 * published by the Free Software Foundation.  Oracle designates this
4110
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
     7
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4110
diff changeset
     8
 * by Oracle in the LICENSE file that accompanied this code.
4110
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
     9
 *
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    10
 * This code is distributed in the hope that it will be useful, but WITHOUT
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    11
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    12
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    13
 * version 2 for more details (a copy is included in the LICENSE file that
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    14
 * accompanied this code).
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    15
 *
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    16
 * You should have received a copy of the GNU General Public License version
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    17
 * 2 along with this work; if not, write to the Free Software Foundation,
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    18
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    19
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4110
diff changeset
    20
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4110
diff changeset
    21
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4110
diff changeset
    22
 * questions.
4110
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    23
 */
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    24
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    25
/*
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    26
 * This file is available under and governed by the GNU General Public
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    27
 * License version 2 only, as published by the Free Software Foundation.
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    28
 * However, the following notice accompanied the original version of this
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    29
 * file:
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    30
 *
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    31
 * Written by Doug Lea with assistance from members of JCP JSR-166
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    32
 * Expert Group and released to the public domain, as explained at
9242
ef138d47df58 7034657: Update Creative Commons license URL in legal notices
dl
parents: 7518
diff changeset
    33
 * http://creativecommons.org/publicdomain/zero/1.0/
4110
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    34
 */
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    35
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    36
package java.util.concurrent;
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    37
15266
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    38
import java.io.ObjectStreamField;
4110
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    39
import java.util.Random;
15266
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    40
import java.util.concurrent.atomic.AtomicInteger;
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    41
import java.util.concurrent.atomic.AtomicLong;
4110
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    42
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    43
/**
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    44
 * A random number generator isolated to the current thread.  Like the
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    45
 * global {@link java.util.Random} generator used by the {@link
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    46
 * java.lang.Math} class, a {@code ThreadLocalRandom} is initialized
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    47
 * with an internally generated seed that may not otherwise be
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    48
 * modified. When applicable, use of {@code ThreadLocalRandom} rather
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    49
 * than shared {@code Random} objects in concurrent programs will
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    50
 * typically encounter much less overhead and contention.  Use of
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    51
 * {@code ThreadLocalRandom} is particularly appropriate when multiple
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    52
 * tasks (for example, each a {@link ForkJoinTask}) use random numbers
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    53
 * in parallel in thread pools.
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    54
 *
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    55
 * <p>Usages of this class should typically be of the form:
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    56
 * {@code ThreadLocalRandom.current().nextX(...)} (where
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    57
 * {@code X} is {@code Int}, {@code Long}, etc).
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    58
 * When all usages are of this form, it is never possible to
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    59
 * accidently share a {@code ThreadLocalRandom} across multiple threads.
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    60
 *
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    61
 * <p>This class also provides additional commonly used bounded random
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    62
 * generation methods.
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    63
 *
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    64
 * @since 1.7
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    65
 * @author Doug Lea
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    66
 */
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
    67
public class ThreadLocalRandom extends Random {
15266
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    68
    /*
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    69
     * This class implements the java.util.Random API (and subclasses
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    70
     * Random) using a single static instance that accesses random
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    71
     * number state held in class Thread (primarily, field
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    72
     * threadLocalRandomSeed). In doing so, it also provides a home
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    73
     * for managing package-private utilities that rely on exactly the
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    74
     * same state as needed to maintain the ThreadLocalRandom
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    75
     * instances. We leverage the need for an initialization flag
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    76
     * field to also use it as a "probe" -- a self-adjusting thread
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    77
     * hash used for contention avoidance, as well as a secondary
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    78
     * simpler (xorShift) random seed that is conservatively used to
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    79
     * avoid otherwise surprising users by hijacking the
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    80
     * ThreadLocalRandom sequence.  The dual use is a marriage of
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    81
     * convenience, but is a simple and efficient way of reducing
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    82
     * application-level overhead and footprint of most concurrent
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    83
     * programs.
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    84
     *
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    85
     * Because this class is in a different package than class Thread,
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    86
     * field access methods must use Unsafe to bypass access control
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    87
     * rules.  The base functionality of Random methods is
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    88
     * conveniently isolated in method next(bits), that just reads and
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    89
     * writes the Thread field rather than its own field. However, to
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    90
     * conform to the requirements of the Random constructor, during
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    91
     * construction, the common static ThreadLocalRandom must maintain
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    92
     * initialization and value fields, mainly for the sake of
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    93
     * disabling user calls to setSeed while still allowing a call
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    94
     * from constructor.  For serialization compatibility, these
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    95
     * fields are left with the same declarations as used in the
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    96
     * previous ThreadLocal-based version of this class, that used
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    97
     * them differently. Note that serialization is completely
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    98
     * unnecessary because there is only a static singleton. But these
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
    99
     * mechanics still ensure compatibility across versions.
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   100
     *
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   101
     * Per-instance initialization is similar to that in the no-arg
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   102
     * Random constructor, but we avoid correlation among not only
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   103
     * initial seeds of those created in different threads, but also
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   104
     * those created using class Random itself; while at the same time
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   105
     * not changing any statistical properties.  So we use the same
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   106
     * underlying multiplicative sequence, but start the sequence far
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   107
     * away from the base version, and then merge (xor) current time
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   108
     * and per-thread probe bits to generate initial values.
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   109
     *
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   110
     * The nextLocalGaussian ThreadLocal supports the very rarely used
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   111
     * nextGaussian method by providing a holder for the second of a
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   112
     * pair of them. As is true for the base class version of this
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   113
     * method, this time/space tradeoff is probably never worthwhile,
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   114
     * but we provide identical statistical properties.
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   115
     */
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   116
4110
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   117
    // same constants as Random, but must be redeclared because private
7518
0282db800fe1 7003745: Code style cleanups (sync from Dougs CVS)
dl
parents: 5773
diff changeset
   118
    private static final long multiplier = 0x5DEECE66DL;
0282db800fe1 7003745: Code style cleanups (sync from Dougs CVS)
dl
parents: 5773
diff changeset
   119
    private static final long addend = 0xBL;
0282db800fe1 7003745: Code style cleanups (sync from Dougs CVS)
dl
parents: 5773
diff changeset
   120
    private static final long mask = (1L << 48) - 1;
15266
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   121
    private static final int PROBE_INCREMENT = 0x61c88647;
4110
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   122
15266
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   123
    /** Generates the basis for per-thread initial seed values */
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   124
    private static final AtomicLong seedGenerator =
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   125
        new AtomicLong(1269533684904616924L);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   126
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   127
    /** Generates per-thread initialization/probe field */
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   128
    private static final AtomicInteger probeGenerator =
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   129
        new AtomicInteger(0xe80f8647);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   130
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   131
    /** Rarely-used holder for the second of a pair of Gaussians */
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   132
    private static final ThreadLocal<Double> nextLocalGaussian =
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   133
        new ThreadLocal<Double>();
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   134
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   135
    /*
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   136
     * Field used only during singleton initialization
4110
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   137
     */
15266
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   138
    boolean initialized; // true when constructor completes
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   139
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   140
    /** Constructor used only for static singleton */
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   141
    private ThreadLocalRandom() {
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   142
        initialized = true; // false during super() call
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   143
    }
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   144
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   145
    /** The common ThreadLocalRandom */
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   146
    static final ThreadLocalRandom instance = new ThreadLocalRandom();
4110
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   147
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   148
    /**
15266
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   149
     * Initialize Thread fields for the current thread.  Called only
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   150
     * when Thread.threadLocalRandomProbe is zero, indicating that a
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   151
     * thread local seed value needs to be generated. Note that even
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   152
     * though the initialization is purely thread-local, we need to
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   153
     * rely on (static) atomic generators to initialize the values.
4110
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   154
     */
15266
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   155
    static final void localInit() {
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   156
        int p = probeGenerator.getAndAdd(PROBE_INCREMENT);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   157
        int probe = (p == 0) ? 1 : p; // skip 0
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   158
        long current, next;
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   159
        do { // same sequence as j.u.Random but different initial value
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   160
            current = seedGenerator.get();
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   161
            next = current * 181783497276652981L;
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   162
        } while (!seedGenerator.compareAndSet(current, next));
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   163
        long r = next ^ ((long)probe << 32) ^ System.nanoTime();
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   164
        Thread t = Thread.currentThread();
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   165
        UNSAFE.putLong(t, SEED, r);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   166
        UNSAFE.putInt(t, PROBE, probe);
4110
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   167
    }
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   168
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   169
    /**
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   170
     * Returns the current thread's {@code ThreadLocalRandom}.
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   171
     *
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   172
     * @return the current thread's {@code ThreadLocalRandom}
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   173
     */
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   174
    public static ThreadLocalRandom current() {
15266
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   175
        if (UNSAFE.getInt(Thread.currentThread(), PROBE) == 0)
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   176
            localInit();
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   177
        return instance;
4110
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   178
    }
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   179
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   180
    /**
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   181
     * Throws {@code UnsupportedOperationException}.  Setting seeds in
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   182
     * this generator is not supported.
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   183
     *
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   184
     * @throws UnsupportedOperationException always
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   185
     */
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   186
    public void setSeed(long seed) {
15266
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   187
        if (initialized) // allow call from super() constructor
4110
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   188
            throw new UnsupportedOperationException();
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   189
    }
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   190
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   191
    protected int next(int bits) {
15266
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   192
        Thread t; long r; // read and update per-thread seed
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   193
        UNSAFE.putLong
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   194
            (t = Thread.currentThread(), SEED,
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   195
             r = (UNSAFE.getLong(t, SEED) * multiplier + addend) & mask);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   196
        return (int) (r >>> (48-bits));
4110
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   197
    }
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   198
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   199
    /**
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   200
     * Returns a pseudorandom, uniformly distributed value between the
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   201
     * given least value (inclusive) and bound (exclusive).
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   202
     *
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   203
     * @param least the least value returned
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   204
     * @param bound the upper bound (exclusive)
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   205
     * @throws IllegalArgumentException if least greater than or equal
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   206
     * to bound
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   207
     * @return the next value
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   208
     */
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   209
    public int nextInt(int least, int bound) {
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   210
        if (least >= bound)
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   211
            throw new IllegalArgumentException();
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   212
        return nextInt(bound - least) + least;
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   213
    }
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   214
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   215
    /**
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   216
     * Returns a pseudorandom, uniformly distributed value
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   217
     * between 0 (inclusive) and the specified value (exclusive).
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   218
     *
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   219
     * @param n the bound on the random number to be returned.  Must be
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   220
     *        positive.
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   221
     * @return the next value
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   222
     * @throws IllegalArgumentException if n is not positive
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   223
     */
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   224
    public long nextLong(long n) {
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   225
        if (n <= 0)
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   226
            throw new IllegalArgumentException("n must be positive");
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   227
        // Divide n by two until small enough for nextInt. On each
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   228
        // iteration (at most 31 of them but usually much less),
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   229
        // randomly choose both whether to include high bit in result
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   230
        // (offset) and whether to continue with the lower vs upper
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   231
        // half (which makes a difference only if odd).
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   232
        long offset = 0;
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   233
        while (n >= Integer.MAX_VALUE) {
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   234
            int bits = next(2);
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   235
            long half = n >>> 1;
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   236
            long nextn = ((bits & 2) == 0) ? half : n - half;
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   237
            if ((bits & 1) == 0)
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   238
                offset += n - nextn;
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   239
            n = nextn;
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   240
        }
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   241
        return offset + nextInt((int) n);
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   242
    }
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   243
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   244
    /**
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   245
     * Returns a pseudorandom, uniformly distributed value between the
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   246
     * given least value (inclusive) and bound (exclusive).
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   247
     *
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   248
     * @param least the least value returned
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   249
     * @param bound the upper bound (exclusive)
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   250
     * @return the next value
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   251
     * @throws IllegalArgumentException if least greater than or equal
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   252
     * to bound
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   253
     */
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   254
    public long nextLong(long least, long bound) {
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   255
        if (least >= bound)
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   256
            throw new IllegalArgumentException();
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   257
        return nextLong(bound - least) + least;
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   258
    }
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   259
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   260
    /**
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   261
     * Returns a pseudorandom, uniformly distributed {@code double} value
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   262
     * between 0 (inclusive) and the specified value (exclusive).
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   263
     *
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   264
     * @param n the bound on the random number to be returned.  Must be
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   265
     *        positive.
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   266
     * @return the next value
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   267
     * @throws IllegalArgumentException if n is not positive
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   268
     */
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   269
    public double nextDouble(double n) {
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   270
        if (n <= 0)
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   271
            throw new IllegalArgumentException("n must be positive");
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   272
        return nextDouble() * n;
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   273
    }
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   274
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   275
    /**
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   276
     * Returns a pseudorandom, uniformly distributed value between the
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   277
     * given least value (inclusive) and bound (exclusive).
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   278
     *
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   279
     * @param least the least value returned
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   280
     * @param bound the upper bound (exclusive)
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   281
     * @return the next value
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   282
     * @throws IllegalArgumentException if least greater than or equal
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   283
     * to bound
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   284
     */
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   285
    public double nextDouble(double least, double bound) {
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   286
        if (least >= bound)
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   287
            throw new IllegalArgumentException();
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   288
        return nextDouble() * (bound - least) + least;
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   289
    }
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   290
15266
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   291
    public double nextGaussian() {
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   292
        // Use nextLocalGaussian instead of nextGaussian field
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   293
        Double d = nextLocalGaussian.get();
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   294
        if (d != null) {
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   295
            nextLocalGaussian.set(null);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   296
            return d.doubleValue();
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   297
        }
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   298
        double v1, v2, s;
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   299
        do {
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   300
            v1 = 2 * nextDouble() - 1; // between -1 and 1
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   301
            v2 = 2 * nextDouble() - 1; // between -1 and 1
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   302
            s = v1 * v1 + v2 * v2;
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   303
        } while (s >= 1 || s == 0);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   304
        double multiplier = StrictMath.sqrt(-2 * StrictMath.log(s)/s);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   305
        nextLocalGaussian.set(new Double(v2 * multiplier));
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   306
        return v1 * multiplier;
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   307
    }
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   308
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   309
    // Within-package utilities
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   310
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   311
    /*
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   312
     * Descriptions of the usages of the methods below can be found in
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   313
     * the classes that use them. Briefly, a thread's "probe" value is
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   314
     * a non-zero hash code that (probably) does not collide with
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   315
     * other existing threads with respect to any power of two
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   316
     * collision space. When it does collide, it is pseudo-randomly
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   317
     * adjusted (using a Marsaglia XorShift). The nextSecondarySeed
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   318
     * method is used in the same contexts as ThreadLocalRandom, but
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   319
     * only for transient usages such as random adaptive spin/block
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   320
     * sequences for which a cheap RNG suffices and for which it could
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   321
     * in principle disrupt user-visible statistical properties of the
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   322
     * main ThreadLocalRandom if we were to use it.
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   323
     *
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   324
     * Note: Because of package-protection issues, versions of some
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   325
     * these methods also appear in some subpackage classes.
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   326
     */
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   327
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   328
    /**
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   329
     * Returns the probe value for the current thread without forcing
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   330
     * initialization. Note that invoking ThreadLocalRandom.current()
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   331
     * can be used to force initialization on zero return.
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   332
     */
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   333
    static final int getProbe() {
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   334
        return UNSAFE.getInt(Thread.currentThread(), PROBE);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   335
    }
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   336
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   337
    /**
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   338
     * Pseudo-randomly advances and records the given probe value for the
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   339
     * given thread.
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   340
     */
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   341
    static final int advanceProbe(int probe) {
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   342
        probe ^= probe << 13;   // xorshift
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   343
        probe ^= probe >>> 17;
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   344
        probe ^= probe << 5;
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   345
        UNSAFE.putInt(Thread.currentThread(), PROBE, probe);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   346
        return probe;
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   347
    }
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   348
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   349
    /**
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   350
     * Returns the pseudo-randomly initialized or updated secondary seed.
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   351
     */
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   352
    static final int nextSecondarySeed() {
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   353
        int r;
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   354
        Thread t = Thread.currentThread();
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   355
        if ((r = UNSAFE.getInt(t, SECONDARY)) != 0) {
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   356
            r ^= r << 13;   // xorshift
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   357
            r ^= r >>> 17;
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   358
            r ^= r << 5;
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   359
        }
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   360
        else if ((r = (int)UNSAFE.getLong(t, SEED)) == 0)
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   361
            r = 1; // avoid zero
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   362
        UNSAFE.putInt(t, SECONDARY, r);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   363
        return r;
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   364
    }
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   365
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   366
    // Serialization support, maintains original persistent form.
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   367
4110
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   368
    private static final long serialVersionUID = -5851777807851030925L;
15266
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   369
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   370
    /**
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   371
     * @serialField rnd long
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   372
     * @serialField initialized boolean
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   373
     * @serialField pad0 long
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   374
     * @serialField pad1 long
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   375
     * @serialField pad2 long
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   376
     * @serialField pad3 long
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   377
     * @serialField pad4 long
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   378
     * @serialField pad5 long
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   379
     * @serialField pad6 long
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   380
     * @serialField pad7 long
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   381
     */
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   382
    private static final ObjectStreamField[] serialPersistentFields = {
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   383
            new ObjectStreamField("rnd", long.class),
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   384
            new ObjectStreamField("initialized", boolean.class),
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   385
            new ObjectStreamField("pad0", long.class),
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   386
            new ObjectStreamField("pad1", long.class),
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   387
            new ObjectStreamField("pad2", long.class),
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   388
            new ObjectStreamField("pad3", long.class),
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   389
            new ObjectStreamField("pad4", long.class),
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   390
            new ObjectStreamField("pad5", long.class),
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   391
            new ObjectStreamField("pad6", long.class),
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   392
            new ObjectStreamField("pad7", long.class) };
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   393
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   394
    /**
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   395
     * Saves the {@code ThreadLocalRandom} to a stream (that is, serializes it).
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   396
     */
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   397
    private void writeObject(java.io.ObjectOutputStream out)
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   398
        throws java.io.IOException {
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   399
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   400
        java.io.ObjectOutputStream.PutField fields = out.putFields();
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   401
        fields.put("rnd", 0L);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   402
        fields.put("initialized", true);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   403
        fields.put("pad0", 0L);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   404
        fields.put("pad1", 0L);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   405
        fields.put("pad2", 0L);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   406
        fields.put("pad3", 0L);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   407
        fields.put("pad4", 0L);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   408
        fields.put("pad5", 0L);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   409
        fields.put("pad6", 0L);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   410
        fields.put("pad7", 0L);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   411
        out.writeFields();
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   412
    }
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   413
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   414
    /**
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   415
     * Returns the {@link #current() current} thread's {@code ThreadLocalRandom}.
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   416
     */
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   417
    private Object readResolve() {
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   418
        return current();
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   419
    }
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   420
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   421
    // Unsafe mechanics
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   422
    private static final sun.misc.Unsafe UNSAFE;
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   423
    private static final long SEED;
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   424
    private static final long PROBE;
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   425
    private static final long SECONDARY;
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   426
    static {
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   427
        try {
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   428
            UNSAFE = sun.misc.Unsafe.getUnsafe();
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   429
            Class<?> tk = Thread.class;
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   430
            SEED = UNSAFE.objectFieldOffset
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   431
                (tk.getDeclaredField("threadLocalRandomSeed"));
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   432
            PROBE = UNSAFE.objectFieldOffset
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   433
                (tk.getDeclaredField("threadLocalRandomProbe"));
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   434
            SECONDARY = UNSAFE.objectFieldOffset
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   435
                (tk.getDeclaredField("threadLocalRandomSecondarySeed"));
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   436
        } catch (Exception e) {
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   437
            throw new Error(e);
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   438
        }
379788c73130 8005926: Merge ThreadLocalRandom state into java.lang.Thread
dl
parents: 9242
diff changeset
   439
    }
4110
ac033ba6ede4 6865582: jsr166y - jsr166 maintenance update
dl
parents:
diff changeset
   440
}