8275703: System.loadLibrary fails on Big Sur for libraries hidden from filesystem

Reviewed-by: dholmes, alanb, mcimadamore
This commit is contained in:
Mandy Chung 2021-10-28 15:27:26 +00:00
parent abe52aea23
commit 309acbf0e8
10 changed files with 199 additions and 32 deletions
make/test
src
hotspot/share
include
prims
java.base
macosx/classes/jdk/internal/loader
share
classes/jdk/internal/loader
native/libjava
unix/classes/jdk/internal/loader
windows/classes/jdk/internal/loader
test/jdk/java/lang/RuntimeTests/loadLibrary/exeLibraryCache

@ -87,8 +87,9 @@ ifeq ($(call isTargetOs, macosx), true)
-framework Cocoa -framework SystemConfiguration
else
BUILD_JDK_JTREG_EXCLUDE += libTestMainKeyWindow.m
BUILD_JDK_JTREG_EXCLUDE += exeJniInvocationTest.c
BUILD_JDK_JTREG_EXCLUDE += libTestDynamicStore.m
BUILD_JDK_JTREG_EXCLUDE += exeJniInvocationTest.c
BUILD_JDK_JTREG_EXCLUDE += exeLibraryCache.c
endif
ifeq ($(call isTargetOs, linux), true)

@ -151,7 +151,7 @@ JNIEXPORT jboolean JNICALL
JVM_IsUseContainerSupport(void);
JNIEXPORT void * JNICALL
JVM_LoadLibrary(const char *name);
JVM_LoadLibrary(const char *name, jboolean throwException);
JNIEXPORT void JNICALL
JVM_UnloadLibrary(void * handle);

@ -3369,7 +3369,7 @@ JVM_END
// Library support ///////////////////////////////////////////////////////////////////////////
JVM_ENTRY_NO_ENV(void*, JVM_LoadLibrary(const char* name))
JVM_ENTRY_NO_ENV(void*, JVM_LoadLibrary(const char* name, jboolean throwException))
//%note jvm_ct
char ebuf[1024];
void *load_result;
@ -3378,18 +3378,23 @@ JVM_ENTRY_NO_ENV(void*, JVM_LoadLibrary(const char* name))
load_result = os::dll_load(name, ebuf, sizeof ebuf);
}
if (load_result == NULL) {
char msg[1024];
jio_snprintf(msg, sizeof msg, "%s: %s", name, ebuf);
// Since 'ebuf' may contain a string encoded using
// platform encoding scheme, we need to pass
// Exceptions::unsafe_to_utf8 to the new_exception method
// as the last argument. See bug 6367357.
Handle h_exception =
Exceptions::new_exception(thread,
vmSymbols::java_lang_UnsatisfiedLinkError(),
msg, Exceptions::unsafe_to_utf8);
if (throwException) {
char msg[1024];
jio_snprintf(msg, sizeof msg, "%s: %s", name, ebuf);
// Since 'ebuf' may contain a string encoded using
// platform encoding scheme, we need to pass
// Exceptions::unsafe_to_utf8 to the new_exception method
// as the last argument. See bug 6367357.
Handle h_exception =
Exceptions::new_exception(thread,
vmSymbols::java_lang_UnsatisfiedLinkError(),
msg, Exceptions::unsafe_to_utf8);
THROW_HANDLE_0(h_exception);
THROW_HANDLE_0(h_exception);
} else {
log_info(library)("Failed to load library %s", name);
return load_result;
}
}
log_info(library)("Loaded library %s, handle " INTPTR_FORMAT, name, p2i(load_result));
return load_result;

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2021, 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
@ -27,11 +27,37 @@ package jdk.internal.loader;
import java.io.File;
import java.util.ArrayList;
import sun.security.action.GetPropertyAction;
class ClassLoaderHelper {
private static final boolean hasDynamicLoaderCache;
static {
String osVersion = GetPropertyAction.privilegedGetProperty("os.version");
// dynamic linker cache support on os.version >= 11.x
int major = 11;
int i = osVersion.indexOf('.');
try {
major = Integer.parseInt(i < 0 ? osVersion : osVersion.substring(0, i));
} catch (NumberFormatException e) {}
hasDynamicLoaderCache = major >= 11;
}
private ClassLoaderHelper() {}
/**
* Returns true if loading a native library only if
* it's present on the file system.
*
* @implNote
* On macOS 11.x or later which supports dynamic linker cache,
* the dynamic library is not present on the filesystem. The
* library cannot determine if a dynamic library exists on a
* given path or not and so this method returns false.
*/
static boolean loadLibraryOnlyIfPresent() {
return !hasDynamicLoaderCache;
}
/**
* Returns an alternate path name for the given file
* such that if the original pathname did not exist, then the

@ -36,7 +36,6 @@ import java.util.ArrayDeque;
import java.util.Deque;
import java.util.function.BiFunction;
import java.util.function.Function;
import java.util.HashSet;
import java.util.Objects;
import java.util.Map;
import java.util.Set;
@ -56,7 +55,7 @@ import java.util.concurrent.locks.ReentrantLock;
* will fail.
*/
public final class NativeLibraries {
private static final boolean loadLibraryOnlyIfPresent = ClassLoaderHelper.loadLibraryOnlyIfPresent();
private final Map<String, NativeLibraryImpl> libraries = new ConcurrentHashMap<>();
private final ClassLoader loader;
// caller, if non-null, is the fromClass parameter for NativeLibraries::loadLibrary
@ -145,7 +144,8 @@ public final class NativeLibraries {
}
/*
* Load a native library from the given file. Returns null if file does not exist.
* Load a native library from the given file. Returns null if the given
* library is determined to be non-loadable, which is system-dependent.
*
* @param fromClass the caller class calling System::loadLibrary
* @param file the path of the native library
@ -158,14 +158,17 @@ public final class NativeLibraries {
boolean isBuiltin = (name != null);
if (!isBuiltin) {
name = AccessController.doPrivileged(new PrivilegedAction<>() {
public String run() {
try {
return file.exists() ? file.getCanonicalPath() : null;
} catch (IOException e) {
return null;
public String run() {
try {
if (loadLibraryOnlyIfPresent && !file.exists()) {
return null;
}
return file.getCanonicalPath();
} catch (IOException e) {
return null;
}
}
}
});
});
if (name == null) {
return null;
}
@ -389,7 +392,7 @@ public final class NativeLibraries {
throw new InternalError("Native library " + name + " has been loaded");
}
return load(this, name, isBuiltin, isJNI);
return load(this, name, isBuiltin, isJNI, loadLibraryOnlyIfPresent);
}
}
@ -575,7 +578,9 @@ public final class NativeLibraries {
// JNI FindClass expects the caller class if invoked from JNI_OnLoad
// and JNI_OnUnload is NativeLibrary class
private static native boolean load(NativeLibraryImpl impl, String name, boolean isBuiltin, boolean isJNI);
private static native boolean load(NativeLibraryImpl impl, String name,
boolean isBuiltin, boolean isJNI,
boolean throwExceptionIfFail);
private static native void unload(String name, boolean isBuiltin, boolean isJNI, long handle);
private static native String findBuiltinLib(String name);
private static native long findEntry0(NativeLibraryImpl lib, String name);

@ -1,5 +1,5 @@
/*
* Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2020, 2021, 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
@ -113,7 +113,8 @@ static void *findJniFunction(JNIEnv *env, void *handle,
*/
JNIEXPORT jboolean JNICALL
Java_jdk_internal_loader_NativeLibraries_load
(JNIEnv *env, jobject this, jobject lib, jstring name, jboolean isBuiltin, jboolean isJNI)
(JNIEnv *env, jobject this, jobject lib, jstring name,
jboolean isBuiltin, jboolean isJNI, jboolean throwExceptionIfFail)
{
const char *cname;
jint jniVersion;
@ -127,7 +128,7 @@ Java_jdk_internal_loader_NativeLibraries_load
cname = JNU_GetStringPlatformChars(env, name, 0);
if (cname == 0)
return JNI_FALSE;
handle = isBuiltin ? procHandle : JVM_LoadLibrary(cname);
handle = isBuiltin ? procHandle : JVM_LoadLibrary(cname, throwExceptionIfFail);
if (isJNI) {
if (handle) {
JNI_OnLoad_t JNI_OnLoad;

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2021, 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
@ -32,6 +32,14 @@ class ClassLoaderHelper {
private ClassLoaderHelper() {}
/**
* Returns true if loading a native library only if
* it's present on the file system.
*/
static boolean loadLibraryOnlyIfPresent() {
return true;
}
/**
* Returns an alternate path name for the given file
* such that if the original pathname did not exist, then the

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2021, 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
@ -31,6 +31,14 @@ class ClassLoaderHelper {
private ClassLoaderHelper() {}
/**
* Returns true if loading a native library only if
* it's present on the file system.
*/
static boolean loadLibraryOnlyIfPresent() {
return true;
}
/**
* Returns an alternate path name for the given file
* such that if the original pathname did not exist, then the

@ -0,0 +1,64 @@
/*
* Copyright (c) 2021, 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 8275703
* @library /test/lib
* @requires os.family == "mac"
* @run main/native/othervm -Djava.library.path=/usr/lib LibraryFromCache blas
* @run main/native/othervm -Djava.library.path=/usr/lib LibraryFromCache BLAS
* @summary Test System::loadLibrary to be able to load a library even
* if it's not present on the filesystem on macOS which supports
* dynamic library cache
*/
import jdk.test.lib.process.OutputAnalyzer;
import java.io.IOException;
import java.nio.file.Path;
import java.nio.file.Paths;
public class LibraryFromCache {
public static void main(String[] args) throws IOException {
String libname = args[0];
if (!systemHasLibrary(libname)) {
System.out.println("Test skipped. Library " + libname + " not found");
return;
}
System.loadLibrary(libname);
}
/*
* Returns true if dlopen successfully loads the specified library
*/
private static boolean systemHasLibrary(String libname) throws IOException {
Path launcher = Paths.get(System.getProperty("test.nativepath"), "LibraryCache");
ProcessBuilder pb = new ProcessBuilder(launcher.toString(), "lib" + libname + ".dylib");
OutputAnalyzer outputAnalyzer = new OutputAnalyzer(pb.start());
System.out.println(outputAnalyzer.getOutput());
return outputAnalyzer.getExitValue() == 0;
}
}

@ -0,0 +1,49 @@
/*
* Copyright (c) 2021, 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.
*/
#include <stdio.h>
#include <stdlib.h>
#include <dlfcn.h>
int main(int argc, char** argv)
{
void *handle;
if (argc != 2) {
fprintf(stderr, "Usage: %s <lib_filename_or_full_path>\n", argv[0]);
return EXIT_FAILURE;
}
printf("Attempting to load library '%s'...\n", argv[1]);
handle = dlopen(argv[1], RTLD_LAZY);
if (handle == NULL) {
fprintf(stderr, "Unable to load library!\n");
return EXIT_FAILURE;
}
printf("Library successfully loaded!\n");
return dlclose(handle);
}