-/* Copyright (c) 2014. The SimGrid Team.
- * All rights reserved. */
+/* Copyright (c) 2014-2021. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
package org.simgrid;
-import java.io.FileOutputStream;
import java.io.InputStream;
-import java.io.OutputStream;
+import java.io.IOException;
import java.io.File;
-
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.stream.Stream;
+
+/** Helper class loading the native functions of SimGrid that we use for downcalls
+ *
+ * Almost all org.simgrid.msg.* classes contain a static block (thus executed when the class is loaded)
+ * containing a call to this.
+ */
public final class NativeLib {
+ private static final boolean WINDOWS_OS = System.getProperty("os.name").toLowerCase().startsWith("win");
+ private static boolean isNativeInited = false;
+ private static Path tempDir = null; // where the embeeded libraries are unpacked before loading them
- public static String getPath() {
- String prefix = "NATIVE";
- String os = System.getProperty("os.name");
- String arch = System.getProperty("os.arch");
+ /** A static-only "class" don't need no constructor */
+ private NativeLib() {
+ throw new IllegalAccessError("Utility class");
+ }
- if (arch.matches("^i[3-6]86$"))
- arch = "x86";
- else if (arch.equalsIgnoreCase("amd64"))
- arch = "x86_64";
+ /** Hidden debug main() function
+ *
+ * It is not the Main-Class defined in src/bindings/java/MANIFEST.in (org.simgrid.msg.Msg is),
+ * so it won't get executed by default. But that's helpful to debug linkage errors, if you
+ * know that it exists. It's used by cmake during the configure, to inform the user.
+ */
+ public static void main(String[] args) {
+ System.out.println("This jarfile searches the native code under: " +getPath());
+ }
- if (os.toLowerCase().startsWith("win")){
- os = "Windows";
- arch = "x86";
- }else if (os.contains("OS X"))
- os = "Darwin";
+ /** Main function loading all the native classes that we need */
+ public static void nativeInit() {
+ if (isNativeInited)
+ return;
- os = os.replace(' ', '_');
- arch = arch.replace(' ', '_');
+ if (WINDOWS_OS)
+ NativeLib.nativeInit("winpthread-1");
- return prefix + "/" + os + "/" + arch + "/";
+ NativeLib.nativeInit("simgrid");
+ NativeLib.nativeInit("simgrid-java");
+ isNativeInited = true;
}
+
+ /** Helper function trying to load one requested library */
public static void nativeInit(String name) {
+ Throwable cause = null;
try {
/* Prefer the version of the library bundled into the jar file and use it */
- loadLib(name);
- } catch (SimGridLibNotFoundException e) {
- /* If not found, try to see if we can find a version on disk */
- try {
- System.loadLibrary(name);
- } catch (UnsatisfiedLinkError e2) {
- System.err.println("Cannot load the bindings to the "+name+" library in path "+getPath());
- e.printStackTrace();
- System.err.println("This jar file does not seem to fit your system, and I cannot find an installation of SimGrid.");
- System.exit(1);
- }
+ if (loadLibAsStream(name))
+ return;
+ } catch (UnsatisfiedLinkError|SecurityException|IOException e) {
+ cause = e;
}
- }
- private static void loadLib (String name) throws SimGridLibNotFoundException {
- String Path = NativeLib.getPath();
-
- String filename=name;
- InputStream in = NativeLib.class.getClassLoader().getResourceAsStream(Path+filename);
-
- if (in == null) {
- filename = "lib"+name+".so";
- in = NativeLib.class.getClassLoader().getResourceAsStream(Path+filename);
- }
- if (in == null) {
- filename = name+".dll";
- in = NativeLib.class.getClassLoader().getResourceAsStream(Path+filename);
- }
- if (in == null) {
- filename = "lib"+name+".dll";
- in = NativeLib.class.getClassLoader().getResourceAsStream(Path+filename);
- }
- if (in == null) {
- filename = "lib"+name+".dylib";
- in = NativeLib.class.getClassLoader().getResourceAsStream(Path+filename);
- }
- if (in == null) {
- throw new SimGridLibNotFoundException("Cannot find library "+name+" in path "+Path+". Sorry, but this jar does not seem to be usable on your machine.");
- }
+ /* If not found, try to see if we can find a version on disk */
try {
- // We must write the lib onto the disk before loading it -- stupid operating systems
- File fileOut = new File(filename);
- fileOut = File.createTempFile(name+"-", ".tmp");
- // don't leak the file on disk, but remove it on JVM shutdown
- Runtime.getRuntime().addShutdownHook(new Thread(new FileCleaner(fileOut.getAbsolutePath())));
- OutputStream out = new FileOutputStream(fileOut);
-
- /* copy the library in position */
- byte[] buffer = new byte[4096];
- int bytes_read;
- while ((bytes_read = in.read(buffer)) != -1) // Read until EOF
- out.write(buffer, 0, bytes_read);
-
- /* close all file descriptors, and load that shit */
- in.close();
- out.close();
- System.load(fileOut.getAbsolutePath());
-
- } catch (Exception e) {
- throw new SimGridLibNotFoundException("Cannot load the bindings to the "+name+" library in path "+getPath(), e);
+ System.loadLibrary(name);
+ return;
+ } catch (UnsatisfiedLinkError systemException) { /* don't care */ }
+
+ System.err.println("\nCannot load the bindings to the "+name+" library in path "+getPath()+" and no usable SimGrid installation found on disk.");
+ if (cause != null) {
+ if (cause.getMessage().contains("libcgraph.so"))
+ System.err.println("HINT: Try to install the libcgraph package (sudo apt-get install libcgraph).");
+ else if (cause.getMessage().contains("libboost_context.so"))
+ System.err.println("HINT: Try to install the boost-context package (sudo apt-get install libboost-context-dev).");
+ else
+ System.err.println("Try to install the missing dependencies, if any. Read carefully the following error message.");
+
+ System.err.println();
+ cause.printStackTrace();
+ } else {
+ System.err.println("This jar file does not seem to fit your system, and no usable SimGrid installation found on disk for "+name+".");
}
+ System.exit(1);
}
- /* A hackish mechanism used to remove the file containing our library when the JVM shuts down */
- private static class FileCleaner implements Runnable {
- private String target;
- public FileCleaner(String name) {
- target = name;
+ /** Try to extract the library from the jarfile before loading it */
+ private static boolean loadLibAsStream (String name) throws IOException, UnsatisfiedLinkError {
+ String path = NativeLib.getPath();
+
+ // We must write the lib onto the disk before loading it -- stupid operating systems
+ if (tempDir == null) {
+ final String tempPrefix = "simgrid-java-";
+
+ if (WINDOWS_OS) {
+ // The cleanup at exit fails on Windows where it is impossible to delete files which are still in
+ // use. Try to remove stale temporary files from previous executions, and limit disk usage.
+ Path tmpdir = (new File(System.getProperty("java.io.tmpdir"))).toPath();
+ try (Stream<Path> paths = Files.find(tmpdir, 1,
+ (Path p, java.nio.file.attribute.BasicFileAttributes a) ->
+ a.isDirectory() && !p.equals(tmpdir) &&
+ p.getFileName().toString().startsWith(tempPrefix))) {
+ paths.map(Path::toFile)
+ .map(FileCleaner::new)
+ .forEach(FileCleaner::run);
+
+ }
+ }
+
+ tempDir = Files.createTempDirectory(tempPrefix);
+ // don't leak the files on disk, but remove it on JVM shutdown
+ Runtime.getRuntime().addShutdownHook(new Thread(new FileCleaner(tempDir.toFile())));
}
- public void run() {
- try {
- new File(target).delete();
- } catch(Exception e) {
- System.out.println("Unable to clean temporary file "+target+" during shutdown.");
- e.printStackTrace();
+
+ /* For each possible filename of the given library on all possible OSes, try it */
+ for (String filename : new String[]
+ { name,
+ "lib"+name+".so", /* linux */
+ name+".dll", "lib"+name+".dll", /* windows (pure and mingw) */
+ "lib"+name+".dylib" /* macOS */}) {
+
+ File fileOut = new File(tempDir.toFile(), filename);
+ try ( // Try-with-resources. These stream will be autoclosed when needed.
+ InputStream in = NativeLib.class.getClassLoader().getResourceAsStream(path+filename);
+ ) {
+ if (in != null) {
+ /* copy the library in position */
+ Files.copy(in, fileOut.toPath());
+
+ /* load that library */
+ System.load(fileOut.getAbsolutePath());
+
+ /* It loaded! we're good */
+ return true;
+ }
}
- }
+ }
+
+ /* No suitable name found */
+ return false;
}
+ /** Find where to search for the library in the jar -- keep it aligned with where cmake puts it! */
+ private static String getPath() {
+ // Inspiration: https://github.com/xerial/snappy-java/blob/develop/src/main/java/org/xerial/snappy/OSInfo.java
+ String prefix = "NATIVE";
+ String os = System.getProperty("os.name");
+ String arch = System.getProperty("os.arch");
- public static void main(String[] args) {
- if (args.length >= 1 && args[0].equals("--quiet"))
- /* be careful, this execution path is used in tools/cmake/Scripts/java_bundle.sh to determine where to put the libs */
- System.out.println(getPath());
- else
- System.out.println("This java library will try to load the native code under the following name:\n" +getPath());
- }
-}
+ if (arch.matches("^i[3-6]86$"))
+ arch = "x86";
+ else if ("x86_64".equalsIgnoreCase(arch) || "AMD64".equalsIgnoreCase(arch))
+ arch = "amd64";
-class SimGridLibNotFoundException extends Exception {
- private static final long serialVersionUID = 1L;
- public SimGridLibNotFoundException(String msg) {
- super(msg);
+ if (os.toLowerCase().startsWith("win")) {
+ os = "Windows";
+ } else if (os.contains("OS X")) {
+ os = "Darwin";
+ }
+ os = os.replace(' ', '_');
+ arch = arch.replace(' ', '_');
+
+ return prefix + "/" + os + "/" + arch + "/";
}
- public SimGridLibNotFoundException(String msg, Exception e) {
- super(msg,e);
+ /** A hackish mechanism used to remove the file containing our library when the JVM shuts down */
+ private static class FileCleaner implements Runnable {
+ private File dir;
+ public FileCleaner(File dir) {
+ this.dir = dir;
+ }
+ @Override
+ public void run() {
+ try (Stream<Path> paths = Files.walk(dir.toPath())) {
+ paths.sorted(java.util.Comparator.reverseOrder())
+ .map(java.nio.file.Path::toFile)
+ //.peek(System.err::println) // Prints what gets removed
+ .forEach(java.io.File::delete);
+ } catch(Exception e) {
+ System.err.println("Error while cleaning temporary file " + dir.getAbsolutePath() +
+ ": " + e.getCause());
+ e.printStackTrace();
+ }
+ }
}
-}
\ No newline at end of file
+}
