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