Changed NativeLibrary.open() to accept boolean argument indicating

whether to search the system path first; perhaps useful if
applications ship only a backup version of native libraries associated
with a particular Java binding. In the case of JOAL we plan to ship a
recent OpenAL implementation so we will not need to search the system
path first. Changed ForceProcAddressGen directive to force
call-through-function-pointer semantics for the targeted function.
Changed JOAL to not link directly against the OpenAL library at all,
but instead to look up all entry points using the GlueGen
NativeLibrary class (instead of the custom dlsym code, now removed) in
particular to solve DSO versioning problems on Linux. Updated EAX
binding to work with dynamically loading OpenAL. Tested on Windows so
far; more testing needed on Linux in Java Web Start scenarios.


git-svn-id: file:///usr/local/projects/SUN/JOGL/git-svn/../svn-server-sync/gluegen/trunk@42 a78bb65f-1512-4460-ba86-f6dc96a7bf27

1 files changed, 50 insertions, 11 deletions

diff --git a/src/java/com/sun/gluegen/runtime/NativeLibrary.java b/src/java/com/sun/gluegen/runtime/NativeLibrary.java
index f61afb6..01148b1 100755
--- a/src/java/com/sun/gluegen/runtime/NativeLibrary.java
+++ b/src/java/com/sun/gluegen/runtime/NativeLibrary.java
@@ -61,6 +61,7 @@ public class NativeLibrary {
   private static final int WINDOWS = 1;
   private static final int UNIX    = 2;
   private static final int MACOSX  = 3;
+  private static boolean DEBUG;
   private static int platform;
   private static DynamicLinker dynLink;
   private static String prefix;
@@ -78,6 +79,9 @@ public class NativeLibrary {
           } else {
             platform = UNIX;
           }
+
+          DEBUG = (System.getProperty("gluegen.debug.NativeLibrary") != null);
+
           return null;
         }
       });
@@ -118,35 +122,58 @@ public class NativeLibrary {
   }
 
   /** Opens the given native library, assuming it has the same base
-      name on all platforms, in the context of the specified
-      ClassLoader, which is used to help find the library in the case
-      of e.g. Java Web Start. */
+      name on all platforms, looking first in the system's search
+      path, and in the context of the specified ClassLoader, which is
+      used to help find the library in the case of e.g. Java Web Start. */
   public static NativeLibrary open(String libName, ClassLoader loader) {
-    return open(libName, libName, libName, loader);
+    return open(libName, libName, libName, true, loader);
   }
 
   /** Opens the given native library, assuming it has the given base
       names (no "lib" prefix or ".dll/.so/.dylib" suffix) on the
       Windows, Unix and Mac OS X platforms, respectively, and in the
       context of the specified ClassLoader, which is used to help find
-      the library in the case of e.g. Java Web Start. */
+      the library in the case of e.g. Java Web Start. The
+      searchSystemPathFirst argument changes the behavior to first
+      search the default system path rather than searching it last.
+      Note that we do not currently handle DSO versioning on Unix.
+      Experience with JOAL and OpenAL has shown that it is extremely
+      problematic to rely on a specific .so version (for one thing,
+      ClassLoader.findLibrary on Unix doesn't work with files not
+      ending in .so, for example .so.0), and in general if this
+      dynamic loading facility is used correctly the version number
+      will be irrelevant.
+  */
   public static NativeLibrary open(String windowsLibName,
                                    String unixLibName,
                                    String macOSXLibName,
+                                   boolean searchSystemPathFirst,
                                    ClassLoader loader) {
     List possiblePaths = enumerateLibraryPaths(windowsLibName,
                                                unixLibName,
                                                macOSXLibName,
+                                               searchSystemPathFirst,
                                                loader);
     // Iterate down these and see which one if any we can actually find.
     for (Iterator iter = possiblePaths.iterator(); iter.hasNext(); ) {
       String path = (String) iter.next();
+      if (DEBUG) {
+        System.out.println("Trying to load " + path);
+      }
       ensureNativeLibLoaded();
       long res = dynLink.openLibrary(path);
       if (res != 0) {
+        if (DEBUG) {
+          System.out.println("Successfully loaded " + path + ": res = 0x" + Long.toHexString(res));
+        }
         return new NativeLibrary(res, path);
       }
     }
+
+    if (DEBUG) {
+      System.out.println("Did not succeed in loading (" + windowsLibName + ", " + unixLibName + ", " + macOSXLibName + ")");
+    }
+
     // For now, just return null to indicate the open operation didn't
     // succeed (could also throw an exception if we could tell which
     // of the openLibrary operations actually failed)
@@ -188,18 +215,28 @@ public class NativeLibrary {
   private static List enumerateLibraryPaths(String windowsLibName,
                                             String unixLibName,
                                             String macOSXLibName,
+                                            boolean searchSystemPathFirst,
                                             ClassLoader loader) {
+    List paths = new ArrayList();
     String libName = selectName(windowsLibName, unixLibName, macOSXLibName);
+    if (libName == null)
+      return paths;
     String[] baseNames = buildNames(libName);
 
-    List paths = new ArrayList();
+    if (searchSystemPathFirst) {
+      // Add just the library names to use the OS's search algorithm
+      for (int i = 0; i < baseNames.length; i++) {
+        paths.add(baseNames[i]);
+      }
+    }
 
     // The idea to ask the ClassLoader to find the library is borrowed
     // from the LWJGL library
     String clPath = getPathFromClassLoader(libName, loader);
-    if (clPath != null)
+    if (clPath != null) {
       paths.add(clPath);
-    
+    }
+
     // Add entries from java.library.path
     String javaLibraryPath =
       (String) AccessController.doPrivileged(new PrivilegedAction() {
@@ -223,9 +260,11 @@ public class NativeLibrary {
         });
     addPaths(userDir, baseNames, paths);
 
-    // Add just the library names to use the OS's search algorithm
-    for (int i = 0; i < baseNames.length; i++) {
-      paths.add(baseNames[i]);
+    if (!searchSystemPathFirst) {
+      // Add just the library names to use the OS's search algorithm
+      for (int i = 0; i < baseNames.length; i++) {
+        paths.add(baseNames[i]);
+      }
     }
 
     return paths;