File: BundleTest.java

package info (click to toggle)
openjdk-21 21.0.8%2B9-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 823,976 kB
  • sloc: java: 5,613,338; xml: 1,643,607; cpp: 1,296,296; ansic: 420,291; asm: 404,850; objc: 20,994; sh: 15,271; javascript: 11,245; python: 6,895; makefile: 2,362; perl: 357; awk: 351; sed: 172; jsp: 24; csh: 3
file content (167 lines) | stat: -rw-r--r-- 6,738 bytes parent folder | download | duplicates (11)
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
159
160
161
162
163
164
165
166
167
/*
 * Copyright (c) 2020, 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.
 */

import java.io.IOException;
import java.lang.ref.PhantomReference;
import java.lang.ref.Reference;
import java.lang.ref.ReferenceQueue;
import java.net.URL;
import java.net.URLClassLoader;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.StandardCopyOption;
import java.util.ArrayList;
import java.util.List;
import java.util.ResourceBundle;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.logging.Handler;
import java.util.logging.LogRecord;
import java.util.logging.Logger;

/**
 * @test
 * @bug 8239013
 * @summary This test verifies that the Logger cache does
 * not keep a strong reference on dynamically loaded resource
 * bundles
 * @build BundleTest MyBundle LoggingApp
 * @run main/othervm -Xmx64M -Djava.util.logging.config.file=logging.properties BundleTest
 */
public class BundleTest {

    // My handler is used to get at the published LogRecords
    public static class MyHandler extends Handler {
        final List<LogRecord> records = new CopyOnWriteArrayList<>();
        @Override
        public void publish(LogRecord record) {
            records.add(record);
        }
        @Override
        public void flush() { }
        @Override
        public void close() throws SecurityException { }
    }

    public static void main(String[] args) throws Exception {
        // copy classes and resource files
        List<URL> classes = setUp();

        // create an URL class loader that contains a copy of
        // LoggingApp and MyBundle classes
        URLClassLoader loader = new URLClassLoader(classes.toArray(new URL[0]), null);
        Class<?> appClass = Class.forName(LoggingApp.class.getName(), true, loader);
        Class<?> bundleClass = Class.forName(MyBundle.class.getName(), true, loader);
        if (bundleClass.getClassLoader() != loader) {
            throw new AssertionError("bundleClass not loaded by URL loader");
        }

        // Invoke LoggingApp.logger() which will create a logger
        // that uses a "MyBundle" bundle, and then log a message
        // to force the logger to load up an instance of the
        // MyBundle class in its catalog cache.
        Logger logger;
        ReferenceQueue<Object> queue = new ReferenceQueue<>();
        Reference<Object> loaderRef = new PhantomReference<>(loader, queue);
        MyHandler handler = new MyHandler();
        Thread currentThread = Thread.currentThread();
        ClassLoader context = currentThread.getContextClassLoader();
        currentThread.setContextClassLoader(loader);
        try {
            logger = (Logger) appClass.getMethod("logger").invoke(null);
            logger.addHandler(handler);
            logger.fine("foo");
            ResourceBundle rb = handler.records.get(0).getResourceBundle();
            // verify that the class of the resource bundle is the
            // class loaded earlier by 'loader'
            if (rb.getClass() != bundleClass) {
                throw new AssertionError("unexpected loader for: " + rb.getClass());
            }
            // At this point the logger has a reference to an instance
            // of the MyBundle class loaded by 'loader' in its catalog cache.
            // This is demonstrated by the presence of that bundle in the
            // LogRecord.
        } finally {
            currentThread.setContextClassLoader(context);
        }

        // cleanup all things that might reference 'loader'
        appClass = bundleClass = null;
        loader = null;
        handler.records.clear();

        // now try to trigger a full GC to force the cleanup
        // of soft caches. If the logger has a strong reference
        // to MyBundle, this will eventually cause an
        // OutOfMemoryError, and the test will fail.
        Reference<?> ref;
        System.gc();
        List<byte[]> memory = new ArrayList<>();
        boolean stop = false;
        System.out.println("Waiting for URL loader to be GC'ed");
        long timeout = 100;
        while ((ref = queue.remove(timeout)) == null) {
            if (stop) break;
            try {
                // eat memory to trigger cleaning of SoftReference
                memory.add(new byte[1024*1024]);
                System.out.printf("Total memory added: %s Mb%n", memory.size());
            } catch (OutOfMemoryError oome) {
                stop = true;
                memory = null;
                timeout = 1000; // give more time for the last GC
            }
            System.gc();
        }
        memory = null;
        if (stop) {
            System.out.println("no more memory...");
        }

        // Verify that loader was GC'ed
        if (ref != loaderRef) {
            throw new AssertionError("Loader was not GC'ed");
        }
        System.out.println("Loader was GC'ed");
        Reference.reachabilityFence(logger);
    }


    static String file(Class<?> type) {
        return type.getSimpleName() + ".class";
    }

    public static List<URL> setUp() throws IOException {
        String classes = System.getProperty("test.classes", "build");
        String cwd = System.getProperty("user.dir", ".");
        String sources = System.getProperty("test.src", "src");
        for (var type : List.of(LoggingApp.class, MyBundle.class)) {
            var from = Path.of(classes, file(type));
            var to = Path.of(cwd, file(type));
            Files.copy(from, to, StandardCopyOption.REPLACE_EXISTING);
        }
        Files.copy(Path.of(sources, "logging.properties"),
                   Path.of(cwd, "logging.properties"),
                   StandardCopyOption.REPLACE_EXISTING);
        return List.of(Path.of(cwd).toUri().toURL());
    }
}