src/bindings/java/org/simgrid/NativeLib.java

   1 /* Copyright (c) 2014. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 package org.simgrid;
   8
   9 import java.io.FileOutputStream;
  10 import java.io.InputStream;
  11 import java.io.OutputStream;
  12 import java.io.File;
  13 import java.nio.file.Files;
  14 import java.nio.file.Path;
  15
  16 public final class NativeLib {
  17         /* Statically load the library which contains all native functions used in here */
  18         static private boolean isNativeInited = false;
  19         public static void nativeInit() {
  20                 if (isNativeInited)
  21                         return;
  22
  23                 if (System.getProperty("os.name").toLowerCase().startsWith("win"))
  24                         NativeLib.nativeInit("winpthread-1");
  25
  26                 try {
  27                         NativeLib.nativeInit("boost_context");
  28                 } catch (Exception e) {/* Dont care */}
  29                 NativeLib.nativeInit("simgrid");
  30                 NativeLib.nativeInit("surf-java");
  31                 NativeLib.nativeInit("simgrid-java");
  32                 isNativeInited = true;
  33         }
  34
  35         public static void nativeInit(String name) {
  36                 try {
  37                         /* Prefer the version of the library bundled into the jar file and use it */
  38                         loadLib(name);
  39                 } catch (SimGridLibNotFoundException e) {
  40                         /* If not found, try to see if we can find a version on disk */
  41                         try {
  42                                 System.loadLibrary(name);
  43                         } catch (UnsatisfiedLinkError e2) {
  44                                 System.err.println("Cannot load the bindings to the "+name+" library in path "+getPath());
  45                                 e.printStackTrace();
  46                                 System.err.println("This jar file does not seem to fit your system, and I cannot find an installation of SimGrid.");
  47                                 System.exit(1);
  48                         }
  49                 }
  50         }
  51
  52         public static String getPath() {
  53                 // Inspiration: https://github.com/xerial/snappy-java/blob/develop/src/main/java/org/xerial/snappy/OSInfo.java
  54                 String prefix = "NATIVE";
  55                 String os = System.getProperty("os.name");
  56                 String arch = System.getProperty("os.arch");
  57
  58                 if (arch.matches("^i[3-6]86$"))
  59                         arch = "x86";
  60                 else if (arch.equalsIgnoreCase("x86_64"))
  61                         arch = "amd64";
  62                 else if (arch.equalsIgnoreCase("AMD64"))
  63                         arch = "amd64";
  64
  65                 if (os.toLowerCase().startsWith("win")){
  66                         os = "Windows";
  67                 } else if (os.contains("OS X"))
  68                         os = "Darwin";
  69
  70                 os = os.replace(' ', '_');
  71                 arch = arch.replace(' ', '_');
  72
  73                 return prefix + "/" + os + "/" + arch + "/";
  74         }
  75         static Path tempDir = null;
  76         private static void loadLib (String name) throws SimGridLibNotFoundException {
  77                 String Path = NativeLib.getPath();
  78
  79                 String filename=name;
  80                 InputStream in = NativeLib.class.getClassLoader().getResourceAsStream(Path+filename);
  81
  82                 if (in == null) {
  83                         filename = "lib"+name+".so";
  84                         in = NativeLib.class.getClassLoader().getResourceAsStream(Path+filename);
  85                 }
  86                 if (in == null) {
  87                         filename = name+".dll";
  88                         in =  NativeLib.class.getClassLoader().getResourceAsStream(Path+filename);
  89                 }
  90                 if (in == null) {
  91                         filename = "lib"+name+".dll";
  92                         in =  NativeLib.class.getClassLoader().getResourceAsStream(Path+filename);
  93                 }
  94                 if (in == null) {
  95                         filename = "lib"+name+".dylib";
  96                         in =  NativeLib.class.getClassLoader().getResourceAsStream(Path+filename);
  97                 }
  98                 if (in == null) {
  99                         throw new SimGridLibNotFoundException("Cannot find library "+name+" in path "+Path+". Sorry, but this jar does not seem to be usable on your machine.");
 100                 }
 101                 try {
 102                         // We must write the lib onto the disk before loading it -- stupid operating systems
 103                         if (tempDir == null) {
 104                                 tempDir = Files.createTempDirectory("simgrid-java");
 105                                 // don't leak the files on disk, but remove it on JVM shutdown
 106                                 Runtime.getRuntime().addShutdownHook(new Thread(new FileCleaner(tempDir.toFile())));
 107                         }
 108                         File fileOut = new File(tempDir.toFile().getAbsolutePath() + File.separator + filename);
 109
 110                         /* copy the library in position */
 111                         OutputStream out = new FileOutputStream(fileOut);
 112                         byte[] buffer = new byte[4096];
 113                         int bytes_read;
 114                         while ((bytes_read = in.read(buffer)) != -1)     // Read until EOF
 115                                 out.write(buffer, 0, bytes_read);
 116
 117                         /* close all file descriptors, and load that shit */
 118                         in.close();
 119                         out.close();
 120                         System.load(fileOut.getAbsolutePath());
 121                 } catch (Exception e) {
 122                         System.err.println("Error while extracting the native library from the jar: ");
 123                         e.printStackTrace();
 124                         throw new SimGridLibNotFoundException("Cannot load the bindings to the "+name+" library in path "+getPath(),   e);
 125                 }
 126         }
 127
 128         /* A hackish mechanism used to remove the file containing our library when the JVM shuts down */
 129         private static class FileCleaner implements Runnable {
 130                 private File dir;
 131                 public FileCleaner(File dir) {
 132                         this.dir = dir;
 133                 }
 134                 public void run() {
 135                         try {
 136                             for (File f : dir.listFiles())
 137                                 f.delete();
 138                                 dir.delete();
 139                         } catch(Exception e) {
 140                                 System.out.println("Unable to clean temporary file "+dir.getAbsolutePath()+" during shutdown.");
 141                                 e.printStackTrace();
 142                         }
 143                 }
 144         }
 145
 146
 147         public static void main(String[] args) {
 148                 System.out.println("This jarfile searches the native code under: " +getPath());
 149         }
 150 }
 151
 152 class SimGridLibNotFoundException extends Exception {
 153         private static final long serialVersionUID = 1L;
 154         public SimGridLibNotFoundException(String msg) {
 155                 super(msg);
 156         }
 157
 158         public SimGridLibNotFoundException(String msg, Exception e) {
 159                 super(msg,e);
 160         }
 161 }