jdk/src/java.base/share/classes/sun/misc/InnocuousThread.java
author chegar
Fri, 18 Dec 2015 16:06:24 +0000
changeset 34716 7477a052aecc
parent 33674 566777f73c32
permissions -rw-r--r--
8056152: API to create Threads that do not inherit inheritable thread-local initial values Reviewed-by: alanb, dholmes, mchung, mr, rriggs
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
23894
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
     1
/*
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
     2
 * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
     4
 *
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
23932
0c547f072113 8038178: Fix corrupt license header
chegar
parents: 23894
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
23894
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    10
 *
23932
0c547f072113 8038178: Fix corrupt license header
chegar
parents: 23894
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
23894
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
23932
0c547f072113 8038178: Fix corrupt license header
chegar
parents: 23894
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
23894
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    15
 * accompanied this code).
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    16
 *
23932
0c547f072113 8038178: Fix corrupt license header
chegar
parents: 23894
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
23894
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
23932
0c547f072113 8038178: Fix corrupt license header
chegar
parents: 23894
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
23894
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    20
 *
23932
0c547f072113 8038178: Fix corrupt license header
chegar
parents: 23894
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
23894
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    23
 * questions.
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    24
 */
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    25
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    26
package sun.misc;
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    27
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    28
import java.security.AccessControlContext;
29903
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
    29
import java.security.AccessController;
23894
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    30
import java.security.ProtectionDomain;
29903
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
    31
import java.security.PrivilegedAction;
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
    32
import java.util.concurrent.atomic.AtomicInteger;
23894
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    33
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    34
/**
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    35
 * A thread that has no permissions, is not a member of any user-defined
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    36
 * ThreadGroup and supports the ability to erase ThreadLocals.
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    37
 */
34716
7477a052aecc 8056152: API to create Threads that do not inherit inheritable thread-local initial values
chegar
parents: 33674
diff changeset
    38
public final class InnocuousThread extends Thread {
33674
566777f73c32 8140606: Update library code to use internal Unsafe
chegar
parents: 29904
diff changeset
    39
    private static final jdk.internal.misc.Unsafe UNSAFE;
34716
7477a052aecc 8056152: API to create Threads that do not inherit inheritable thread-local initial values
chegar
parents: 33674
diff changeset
    40
    private static final long THREAD_LOCALS;
7477a052aecc 8056152: API to create Threads that do not inherit inheritable thread-local initial values
chegar
parents: 33674
diff changeset
    41
    private static final long INHERITABLE_THREAD_LOCALS;
29903
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
    42
    private static final ThreadGroup INNOCUOUSTHREADGROUP;
23894
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    43
    private static final AccessControlContext ACC;
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    44
    private static final long INHERITEDACCESSCONTROLCONTEXT;
29904
d5f909aa26bc 8048210: More Enhancements to InnocuousThread and friends
chegar
parents: 29903
diff changeset
    45
    private static final long CONTEXTCLASSLOADER;
23894
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    46
29903
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
    47
    private static final AtomicInteger threadNumber = new AtomicInteger(1);
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
    48
23894
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    49
    public InnocuousThread(Runnable target) {
29903
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
    50
        this(INNOCUOUSTHREADGROUP, target,
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
    51
             "InnocuousThread-" + threadNumber.getAndIncrement());
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
    52
    }
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
    53
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
    54
    public InnocuousThread(Runnable target, String name) {
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
    55
        this(INNOCUOUSTHREADGROUP, target, name);
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
    56
    }
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
    57
29904
d5f909aa26bc 8048210: More Enhancements to InnocuousThread and friends
chegar
parents: 29903
diff changeset
    58
    public InnocuousThread(ThreadGroup group, Runnable target, String name) {
34716
7477a052aecc 8056152: API to create Threads that do not inherit inheritable thread-local initial values
chegar
parents: 33674
diff changeset
    59
        super(group, target, name, 0L, false);
23894
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    60
        UNSAFE.putOrderedObject(this, INHERITEDACCESSCONTROLCONTEXT, ACC);
29904
d5f909aa26bc 8048210: More Enhancements to InnocuousThread and friends
chegar
parents: 29903
diff changeset
    61
        UNSAFE.putOrderedObject(this, CONTEXTCLASSLOADER, ClassLoader.getSystemClassLoader());
23894
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    62
    }
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    63
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    64
    @Override
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    65
    public void setUncaughtExceptionHandler(UncaughtExceptionHandler x) {
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    66
        // silently fail
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    67
    }
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    68
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    69
    @Override
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    70
    public void setContextClassLoader(ClassLoader cl) {
29904
d5f909aa26bc 8048210: More Enhancements to InnocuousThread and friends
chegar
parents: 29903
diff changeset
    71
        // Allow clearing of the TCCL to remove the reference to the system classloader.
29903
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
    72
        if (cl == null)
29904
d5f909aa26bc 8048210: More Enhancements to InnocuousThread and friends
chegar
parents: 29903
diff changeset
    73
            super.setContextClassLoader(null);
29903
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
    74
        else
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
    75
            throw new SecurityException("setContextClassLoader");
23894
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    76
    }
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    77
34716
7477a052aecc 8056152: API to create Threads that do not inherit inheritable thread-local initial values
chegar
parents: 33674
diff changeset
    78
    /**
7477a052aecc 8056152: API to create Threads that do not inherit inheritable thread-local initial values
chegar
parents: 33674
diff changeset
    79
     * Drops all thread locals (and inherited thread locals).
7477a052aecc 8056152: API to create Threads that do not inherit inheritable thread-local initial values
chegar
parents: 33674
diff changeset
    80
     */
7477a052aecc 8056152: API to create Threads that do not inherit inheritable thread-local initial values
chegar
parents: 33674
diff changeset
    81
    public final void eraseThreadLocals() {
7477a052aecc 8056152: API to create Threads that do not inherit inheritable thread-local initial values
chegar
parents: 33674
diff changeset
    82
        UNSAFE.putObject(this, THREAD_LOCALS, null);
7477a052aecc 8056152: API to create Threads that do not inherit inheritable thread-local initial values
chegar
parents: 33674
diff changeset
    83
        UNSAFE.putObject(this, INHERITABLE_THREAD_LOCALS, null);
7477a052aecc 8056152: API to create Threads that do not inherit inheritable thread-local initial values
chegar
parents: 33674
diff changeset
    84
    }
7477a052aecc 8056152: API to create Threads that do not inherit inheritable thread-local initial values
chegar
parents: 33674
diff changeset
    85
23894
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    86
    // ensure run method is run only once
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    87
    private volatile boolean hasRun;
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    88
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    89
    @Override
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    90
    public void run() {
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    91
        if (Thread.currentThread() == this && !hasRun) {
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    92
            hasRun = true;
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    93
            super.run();
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    94
        }
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    95
    }
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    96
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    97
    // Use Unsafe to access Thread group and ThreadGroup parent fields
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    98
    static {
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
    99
        try {
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   100
            ACC = new AccessControlContext(new ProtectionDomain[] {
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   101
                new ProtectionDomain(null, null)
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   102
            });
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   103
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   104
            // Find and use topmost ThreadGroup as parent of new group
33674
566777f73c32 8140606: Update library code to use internal Unsafe
chegar
parents: 29904
diff changeset
   105
            UNSAFE = jdk.internal.misc.Unsafe.getUnsafe();
23894
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   106
            Class<?> tk = Thread.class;
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   107
            Class<?> gk = ThreadGroup.class;
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   108
34716
7477a052aecc 8056152: API to create Threads that do not inherit inheritable thread-local initial values
chegar
parents: 33674
diff changeset
   109
            THREAD_LOCALS = UNSAFE.objectFieldOffset
7477a052aecc 8056152: API to create Threads that do not inherit inheritable thread-local initial values
chegar
parents: 33674
diff changeset
   110
                    (tk.getDeclaredField("threadLocals"));
7477a052aecc 8056152: API to create Threads that do not inherit inheritable thread-local initial values
chegar
parents: 33674
diff changeset
   111
            INHERITABLE_THREAD_LOCALS = UNSAFE.objectFieldOffset
7477a052aecc 8056152: API to create Threads that do not inherit inheritable thread-local initial values
chegar
parents: 33674
diff changeset
   112
                    (tk.getDeclaredField("inheritableThreadLocals"));
23894
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   113
            INHERITEDACCESSCONTROLCONTEXT = UNSAFE.objectFieldOffset
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   114
                (tk.getDeclaredField("inheritedAccessControlContext"));
29904
d5f909aa26bc 8048210: More Enhancements to InnocuousThread and friends
chegar
parents: 29903
diff changeset
   115
            CONTEXTCLASSLOADER = UNSAFE.objectFieldOffset
d5f909aa26bc 8048210: More Enhancements to InnocuousThread and friends
chegar
parents: 29903
diff changeset
   116
                (tk.getDeclaredField("contextClassLoader"));
23894
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   117
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   118
            long tg = UNSAFE.objectFieldOffset(tk.getDeclaredField("group"));
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   119
            long gp = UNSAFE.objectFieldOffset(gk.getDeclaredField("parent"));
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   120
            ThreadGroup group = (ThreadGroup)
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   121
                UNSAFE.getObject(Thread.currentThread(), tg);
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   122
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   123
            while (group != null) {
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   124
                ThreadGroup parent = (ThreadGroup)UNSAFE.getObject(group, gp);
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   125
                if (parent == null)
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   126
                    break;
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   127
                group = parent;
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   128
            }
29903
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
   129
            final ThreadGroup root = group;
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
   130
            INNOCUOUSTHREADGROUP = AccessController.doPrivileged(
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
   131
                (PrivilegedAction<ThreadGroup>) () ->
b21ed6c8bc3f 8044187: Enhancements to InnocuousThread
chegar
parents: 25859
diff changeset
   132
                    { return new ThreadGroup(root, "InnocuousThreadGroup"); });
23894
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   133
        } catch (Exception e) {
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   134
            throw new Error(e);
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   135
        }
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   136
    }
7500e0f62a4a 8026716: (aio) Enhance asynchronous channel handling
alanb
parents:
diff changeset
   137
}