test/jdk/java/lang/ClassLoader/nativeLibrary/NativeLibraryTest.java
author mchung
Mon, 06 Nov 2017 17:48:00 -0800
changeset 47707 67aa34b019e1
child 48302 50181ff45d46
permissions -rw-r--r--
8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library Reviewed-by: alanb, bchristi, kbarrett, dholmes, plevart
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
47707
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
     1
/*
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
     2
 * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
     4
 *
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
     7
 * published by the Free Software Foundation.
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
     8
 *
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    13
 * accompanied this code).
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    14
 *
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    18
 *
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    21
 * questions.
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    22
 */
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    23
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    24
/*
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    25
 * @test
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    26
 * @bug 8164512
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    27
 * @summary verify if the native library is unloaded when the class loader is GC'ed
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    28
 * @build p.Test
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    29
 * @run main/othervm/native -Xcheck:jni NativeLibraryTest
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    30
 */
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    31
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    32
import java.io.IOException;
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    33
import java.net.MalformedURLException;
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    34
import java.net.URL;
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    35
import java.net.URLClassLoader;
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    36
import java.nio.file.Files;
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    37
import java.nio.file.Path;
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    38
import java.nio.file.Paths;
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    39
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    40
public class NativeLibraryTest {
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    41
    static final Path CLASSES = Paths.get("classes");
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    42
    static int unloadedCount = 0;
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    43
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    44
    /*
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    45
     * Called by JNI_OnUnload when the native library is unloaded
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    46
     */
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    47
    static void nativeLibraryUnloaded() {
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    48
        unloadedCount++;
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    49
    }
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    50
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    51
    public static void main(String... args) throws Exception {
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    52
        setup();
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    53
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    54
        for (int count=1; count <= 5; count++) {
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    55
            // create a class loader and load a native library
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    56
            runTest();
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    57
            // unloading the class loader and native library
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    58
            System.gc();
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    59
            // give Cleaner thread a chance to unload the native library
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    60
            Thread.sleep(100);
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    61
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    62
            // unloadedCount is incremented when the native library is unloaded
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    63
            if (count != unloadedCount) {
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    64
                throw new RuntimeException("Expected unloaded=" + count +
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    65
                    " but got=" + unloadedCount);
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    66
            }
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    67
        }
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    68
    }
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    69
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    70
    /*
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    71
     * Loads p.Test class with a new class loader and its static initializer
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    72
     * will load a native library.
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    73
     *
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    74
     * The class loader becomes unreachable when this method returns and
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    75
     * the native library should be unloaded at some point after the class
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    76
     * loader is garbage collected.
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    77
     */
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    78
    static void runTest() throws Exception {
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    79
        // invoke p.Test.run() that loads the native library
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    80
        Runnable r = newTestRunnable();
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    81
        r.run();
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    82
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    83
        // reload the native library by the same class loader
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    84
        r.run();
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    85
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    86
        // load the native library by another class loader
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    87
        Runnable r1 = newTestRunnable();
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    88
        try {
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    89
            r1.run();
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    90
            throw new RuntimeException("should fail to load the native library" +
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    91
                    " by another class loader");
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    92
        } catch (UnsatisfiedLinkError e) {}
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    93
    }
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    94
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    95
    /*
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    96
     * Loads p.Test class with a new class loader and returns
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    97
     * a Runnable instance.
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    98
     */
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
    99
    static Runnable newTestRunnable() throws Exception {
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   100
        TestLoader loader = new TestLoader();
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   101
        Class<?> c = Class.forName("p.Test", true, loader);
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   102
        return (Runnable) c.newInstance();
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   103
    }
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   104
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   105
    static class TestLoader extends URLClassLoader {
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   106
        static URL[] toURLs() {
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   107
            try {
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   108
                return new URL[] { CLASSES.toUri().toURL() };
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   109
            } catch (MalformedURLException e) {
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   110
                throw new Error(e);
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   111
            }
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   112
        }
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   113
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   114
        TestLoader() {
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   115
            super("testloader", toURLs(), ClassLoader.getSystemClassLoader());
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   116
        }
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   117
    }
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   118
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   119
    /*
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   120
     * move p/Test.class out from classpath to the scratch directory
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   121
     */
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   122
    static void setup() throws IOException {
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   123
        String dir = System.getProperty("test.classes", ".");
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   124
        Path file = Paths.get("p", "Test.class");
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   125
        Files.createDirectories(CLASSES.resolve("p"));
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   126
        Files.move(Paths.get(dir).resolve(file),
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   127
                   CLASSES.resolve("p").resolve("Test.class"));
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   128
    }
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents:
diff changeset
   129
}