File: RuntimeThreadInheritanceLeak.java

package info (click to toggle)
openjdk-11 11.0.4%2B11-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 757,028 kB
  • sloc: java: 5,016,041; xml: 1,191,974; cpp: 934,731; ansic: 555,697; sh: 24,299; objc: 12,703; python: 3,602; asm: 3,415; makefile: 2,772; awk: 351; sed: 172; perl: 114; jsp: 24; csh: 3
file content (158 lines) | stat: -rw-r--r-- 6,635 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/*
 * Copyright (c) 2001, 2012, Oracle and/or its affiliates. All rights reserved.
 * 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
 * published by the Free Software Foundation.
 *
 * 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.
 *
 * 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.
 */

/* @test
 * @bug 4404702
 * @summary When the RMI runtime (lazily) spawns system threads that could
 * outlive the application context in which they were (happened to be)
 * created, such threads should not inherit (thread local) data specific to
 * such an application context for various isolation reasons (see 4219095).
 * While there is not yet a practical means for a general solution to this
 * problem, the particular problem documented in 4404702-- the inheritance
 * of the parent thread's context class loader, preventing that loader from
 * being garbage collected in the future-- can be easily fixed.  This test
 * verifies that the context class loader in effect when the first remote
 * object is exported (and thus when some long-lived RMI daemon threads are
 * created) can be garbage collected after the remote object has been
 * unexported.  [Note that this test is somewhat at the mercy of other J2SE
 * subsystems also not holding on to the loader in their daemon threads.]
 * @author Peter Jones
 *
 * @build RuntimeThreadInheritanceLeak_Stub
 * @run main/othervm RuntimeThreadInheritanceLeak
 */

import java.lang.ref.Reference;
import java.lang.ref.ReferenceQueue;
import java.lang.ref.WeakReference;
import java.net.URL;
import java.net.URLClassLoader;
import java.rmi.Remote;
import java.rmi.RemoteException;
import java.rmi.server.UnicastRemoteObject;
import java.util.Iterator;
import java.util.Map;

public class RuntimeThreadInheritanceLeak implements Remote {

    private static final int TIMEOUT = 20000;

    public static void main(String[] args) {

        System.err.println("\nRegression test for bug 4404702\n");

        /*
         * HACK: Work around the fact that java.util.logging.LogManager's
         * (singleton) construction also has this bug-- it will register a
         * "shutdown hook", i.e. a thread, which will inherit and pin the
         * current thread's context class loader for the lifetime of the VM--
         * by causing the LogManager to be initialized now, instead of by
         * RMI when our special context class loader is set.
         */
        java.util.logging.LogManager.getLogManager();

        /*
         * HACK: Work around the fact that the non-native, thread-based
         * SecureRandom seed generator (ThreadedSeedGenerator) seems to
         * have this bug too (which had been causing this test to fail
         * when run with jtreg on Windows XP-- see 4910382).
         */
        (new java.security.SecureRandom()).nextInt();

        RuntimeThreadInheritanceLeak obj = new RuntimeThreadInheritanceLeak();

        try {
            ClassLoader loader = URLClassLoader.newInstance(new URL[0]);
            ReferenceQueue refQueue = new ReferenceQueue();
            Reference loaderRef = new WeakReference(loader, refQueue);
            System.err.println("created loader: " + loader);

            Thread.currentThread().setContextClassLoader(loader);
            UnicastRemoteObject.exportObject(obj);
            Thread.currentThread().setContextClassLoader(
                ClassLoader.getSystemClassLoader());
            System.err.println(
                "exported remote object with loader as context class loader");

            loader = null;
            System.err.println("nulled strong reference to loader");

            UnicastRemoteObject.unexportObject(obj, true);
            System.err.println("unexported remote object");

            /*
             * HACK: Work around the fact that the sun.misc.GC daemon thread
             * also has this bug-- it will have inherited our loader as its
             * context class loader-- by giving it a chance to pass away.
             */
            Thread.sleep(2000);
            System.gc();

            System.err.println(
                "waiting to be notified of loader being weakly reachable...");
            Reference dequeued = refQueue.remove(TIMEOUT);
            if (dequeued == null) {
                System.err.println(
                    "TEST FAILED: loader not deteced weakly reachable");
                dumpThreads();
                throw new RuntimeException(
                    "TEST FAILED: loader not detected weakly reachable");
            }

            System.err.println(
                "TEST PASSED: loader detected weakly reachable");
            dumpThreads();

        } catch (RuntimeException e) {
            throw e;
        } catch (Exception e) {
            throw new RuntimeException("TEST FAILED: unexpected exception", e);
        } finally {
            try {
                UnicastRemoteObject.unexportObject(obj, true);
            } catch (RemoteException e) {
            }
        }
    }

    /**
     * Dumps information about all live threads to System.err,
     * including their context class loaders.
     **/
    private static void dumpThreads() {
        System.err.println(
            "current live threads and their context class loaders:");
        Map threads = Thread.getAllStackTraces();
        for (Iterator iter = threads.entrySet().iterator(); iter.hasNext();) {
            Map.Entry e = (Map.Entry) iter.next();
            Thread t = (Thread) e.getKey();
            System.err.println("  thread: " + t);
            System.err.println("  context class loader: " +
                               t.getContextClassLoader());
            StackTraceElement[] trace = (StackTraceElement[]) e.getValue();
            for (int i = 0; i < trace.length; i++) {
                System.err.println("    " + trace[i]);
            }
        }
    }
}