summaryrefslogtreecommitdiffstats
path: root/src/java/com/jogamp/common/jvm/JNILibLoaderBase.java
blob: c4f1d7e08b049eb599571a15fe01f270121fd7df (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
/*
 * Copyright (c) 2003 Sun Microsystems, Inc. All Rights Reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 * - Redistribution of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * 
 * - Redistribution in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of Sun Microsystems, Inc. or the names of
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * This software is provided "AS IS," without a warranty of any kind. ALL
 * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
 * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
 * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
 * MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
 * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
 * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
 * ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
 * DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
 * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
 * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
 * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 * 
 * You acknowledge that this software is not designed or intended for use
 * in the design, construction, operation or maintenance of any nuclear
 * facility.
 * 
 * Sun gratefully acknowledges that this software was originally authored
 * and developed by Kenneth Bradley Russell and Christopher John Kline.
 */

package com.jogamp.nativewindow.impl;

// FIXME: refactor Java SE dependencies
//import java.awt.Toolkit;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.HashSet;

public class NativeLibLoaderBase {
  public static final boolean DEBUG = Debug.debug("NativeLibLoader");

  public interface LoaderAction {
    /**
     * Loads the library specified by libname. Optionally preloads the libraries specified by
     * preload. The implementation should ignore, if the preload-libraries have already been
     * loaded.
     * @param libname the library to load
     * @param preload the libraries to load before loading the main library if not null
     * @param preloadIgnoreError true, if errors during loading the preload-libraries should be ignored 
     */
    void loadLibrary(String libname, String[] preload, 
        boolean preloadIgnoreError);
  }
  
  private static class DefaultAction implements LoaderAction {
    public void loadLibrary(String libname, String[] preload, boolean preloadIgnoreError) {
      if (null!=preload) {
        for (int i=0; i<preload.length; i++) {
          if(!isLoaded(preload[i])) {
              try {
                loadLibraryInternal(preload[i]);
                addLoaded(preload[i]);
                if(DEBUG) {
                    System.err.println("NativeLibLoaderBase preloaded "+preload[i]);
                }
              } catch (UnsatisfiedLinkError e) {
                if(DEBUG) {
                    e.printStackTrace();
                }
                if (!preloadIgnoreError && e.getMessage().indexOf("already loaded") < 0) {
                  throw e;
                }
              }
          }
        }
      }
      loadLibraryInternal(libname);
      addLoaded(libname);
      if(DEBUG) {
          System.err.println("NativeLibLoaderBase    loaded "+libname);
      }
    }
  }

  private static final HashSet loaded = new HashSet();
  private static LoaderAction loaderAction = new DefaultAction();

  public static boolean isLoaded(String libName) {
    return loaded.contains(libName);
  }

  public static void addLoaded(String libName) {
    loaded.add(libName);
    if(DEBUG) {
        System.err.println("NativeLibLoaderBase Loaded Native Library: "+libName);
    }
  }

  public static void disableLoading() {
    setLoadingAction(null);
  }

  public static void enableLoading() {
    setLoadingAction(new DefaultAction());
  }
  
  public static synchronized void setLoadingAction(LoaderAction action) {
    loaderAction = action;
  }

  protected static synchronized void loadLibrary(String libname, String[] preload, 
      boolean preloadIgnoreError) {
    if (loaderAction != null && !isLoaded(libname))
    {
      loaderAction.loadLibrary(libname, preload, preloadIgnoreError);    
    }
  }
  
  public static void loadNativeWindow(final String ossuffix) {
    AccessController.doPrivileged(new PrivilegedAction() {
      public Object run() {
        loadLibrary("nativewindow_"+ossuffix, null, false);
        return null;
      }
    });
  }


  private static final Class  customLauncherClass;
  private static final Method customLoadLibraryMethod;

  // FIXME centralize logging
  static {
    Class launcherClass = null;
    Method loadLibraryMethod = null;

    if ( Debug.getBooleanProperty("sun.jnlp.applet.launcher", false) ) {
        try {
            launcherClass = Class.forName("org.jdesktop.applet.util.JNLPAppletLauncher");
            loadLibraryMethod = launcherClass.getDeclaredMethod("loadLibrary", new Class[] { String.class });
        } catch (ClassNotFoundException ex) {
            if(DEBUG) {
                ex.printStackTrace();
            }
        } catch (NoSuchMethodException ex) {
            if(DEBUG) {
                ex.printStackTrace();
            }
            launcherClass = null;
        }
    }

    if(null==launcherClass) {
        String launcherClassName = Debug.getProperty("jnlp.launcher.class", false);
        if(null!=launcherClassName) {
            try {
                launcherClass = Class.forName(launcherClassName);
                loadLibraryMethod = launcherClass.getDeclaredMethod("loadLibrary", new Class[] { String.class });
            } catch (ClassNotFoundException ex) {
                if(DEBUG) {
                    ex.printStackTrace();
                }
            } catch (NoSuchMethodException ex) {
                if(DEBUG) {
                    ex.printStackTrace();
                }
                launcherClass = null;
            }
        }
    }

    customLauncherClass = launcherClass;
    customLoadLibraryMethod = loadLibraryMethod;
  }

  private static void loadLibraryInternal(String libraryName) {
    // Note: special-casing JAWT which is built in to the JDK
    if (null!=customLoadLibraryMethod && !libraryName.equals("jawt")) {
        try {
          customLoadLibraryMethod.invoke(null, new Object[] { libraryName });
        } catch (Exception e) {
          Throwable t = e;
          if (t instanceof InvocationTargetException) {
            t = ((InvocationTargetException) t).getTargetException();
          }
          if (t instanceof Error)
            throw (Error) t;
          if (t instanceof RuntimeException) {
            throw (RuntimeException) t;
          }
          // Throw UnsatisfiedLinkError for best compatibility with System.loadLibrary()
          throw (UnsatisfiedLinkError)new UnsatisfiedLinkError("can not load library "+libraryName).initCause(e);
        }
    } else {
      // System.out.println("sun.boot.library.path=" + Debug.getProperty("sun.boot.library.path", false));
      System.loadLibrary(libraryName);
    }
  }
}