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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
|
/**
* Copyright 2010 JogAmp Community. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions 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.
*
* THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are those of the
* authors and should not be interpreted as representing official policies, either expressed
* or implied, of JogAmp Community.
*/
package com.jogamp.common.os;
import java.util.*;
import com.jogamp.common.jvm.JNILibLoaderBase;
/**
* Provides bundling of:<br>
* <ul>
* <li>The to-be-glued native library, eg OpenGL32.dll. From hereon this is referred as the Tool.</li>
* <li>The JNI glue-code native library, eg jogl_desktop.dll. From heron this is referred as the Glue</li>
* </ul><br>
* An instance provides a complete {@link com.jogamp.common.os.DynamicLookupHelper}
* to {@link com.jogamp.gluegen.runtime.ProcAddressTable#reset(com.jogamp.common.os.DynamicLookupHelper) reset}
* the {@link com.jogamp.gluegen.runtime.ProcAddressTable}.<br>
* At construction, it:
* <ul>
* <li> loads the Tool native library via
* {@link com.jogamp.common.os.NativeLibrary#open(java.lang.String, java.lang.ClassLoader, boolean) NativeLibrary's open method}</li>
* <li> loads the {@link com.jogamp.common.jvm.JNILibLoaderBase#loadLibrary(java.lang.String, java.lang.String[], boolean) Glue native library}</li>
* <li> resolves the Tool's {@link com.jogamp.common.os.DynamicLibraryBundleInfo#getToolGetProcAddressFuncNameList() GetProcAddress}. (optional)</li>
* </ul>
*/
public class DynamicLibraryBundle implements DynamicLookupHelper {
protected static final boolean DEBUG = NativeLibrary.DEBUG;
protected static final boolean DEBUG_LOOKUP = NativeLibrary.DEBUG_LOOKUP;
private DynamicLibraryBundleInfo info;
private List/*<List<String>>*/ toolLibNames;
private boolean[] toolLibLoaded;
private int toolLibLoadedNumber;
protected List/*<NativeLibrary>*/ nativeLibraries;
private List/*<String>*/ glueLibNames;
private boolean[] glueLibLoaded;
private int glueLibLoadedNumber;
private long toolGetProcAddressHandle;
private HashSet toolGetProcAddressFuncNameSet;
private List toolGetProcAddressFuncNameList;
public DynamicLibraryBundle(DynamicLibraryBundleInfo info) {
if(null==info) {
throw new RuntimeException("Null DynamicLibraryBundleInfo");
}
this.info = info;
if(DEBUG) {
System.err.println(Thread.currentThread().getName()+" - DynamicLibraryBundle.init start with: "+info.getClass().getName());
Thread.dumpStack();
}
nativeLibraries = new ArrayList();
toolLibNames = info.getToolLibNames();
glueLibNames = info.getGlueLibNames();
loadLibraries();
toolGetProcAddressFuncNameList = info.getToolGetProcAddressFuncNameList();
if(null!=toolGetProcAddressFuncNameList) {
toolGetProcAddressFuncNameSet = new HashSet(toolGetProcAddressFuncNameList);
toolGetProcAddressHandle = getToolGetProcAddressHandle();
} else {
toolGetProcAddressFuncNameSet = new HashSet();
toolGetProcAddressHandle = 0;
}
if(DEBUG) {
System.err.println("DynamicLibraryBundle.init Summary: "+info.getClass().getName());
System.err.println(" toolGetProcAddressFuncNameList: "+toolGetProcAddressFuncNameList);
System.err.println(" Tool Lib Names : "+toolLibNames);
System.err.println(" Tool Lib Loaded: "+getToolLibLoadedNumber()+"/"+getToolLibNumber()+" "+Arrays.toString(toolLibLoaded)+", complete "+isToolLibComplete());
System.err.println(" Glue Lib Names : "+glueLibNames);
System.err.println(" Glue Lib Loaded: "+getGlueLibLoadedNumber()+"/"+getGlueLibNumber()+" "+Arrays.toString(glueLibLoaded)+", complete "+isGlueLibComplete());
System.err.println(" All Complete: "+isLibComplete());
}
}
public final boolean isLibComplete() {
return isToolLibComplete() && isGlueLibComplete() ;
}
public final int getToolLibNumber() {
return toolLibNames.size();
}
public final int getToolLibLoadedNumber() {
return toolLibLoadedNumber;
}
/**
* @return true if all tool libraries are loaded,
* otherwise false.
*
* @see DynamicLibraryBundleInfo#getToolLibNames()
*/
public final boolean isToolLibComplete() {
return getToolLibNumber() == getToolLibLoadedNumber();
}
public final boolean isToolLibLoaded() {
return 0 < toolLibLoadedNumber;
}
public final boolean isToolLibLoaded(int i) {
if(0 <= i && i < toolLibLoaded.length) {
return toolLibLoaded[i];
}
return false;
}
public final int getGlueLibNumber() {
return glueLibNames.size();
}
public final int getGlueLibLoadedNumber() {
return glueLibLoadedNumber;
}
/**
* @return true if the last entry has been loaded,
* while ignoring the preload dependencies.
* Otherwise false.
*
* @see DynamicLibraryBundleInfo#getGlueLibNames()
*/
public final boolean isGlueLibComplete() {
return isGlueLibLoaded(getGlueLibNumber() - 1);
}
public final boolean isGlueLibLoaded(int i) {
if(0 <= i && i < glueLibLoaded.length) {
return glueLibLoaded[i];
}
return false;
}
public final DynamicLibraryBundleInfo getBundleInfo() { return info; }
protected long getToolGetProcAddressHandle() {
if(!isToolLibLoaded()) {
return 0;
}
long aptr = 0;
for(Iterator iter=toolGetProcAddressFuncNameList.iterator(); 0==aptr && iter.hasNext(); ) {
String name = (String) iter.next();
aptr = dynamicLookupFunctionOnLibs(name);
if(DEBUG) {
System.err.println("getToolGetProcAddressHandle: "+name+" -> 0x"+Long.toHexString(aptr));
}
}
return aptr;
}
protected NativeLibrary loadFirstAvailable(List/*<String>*/ libNames, ClassLoader loader, boolean global) {
for (Iterator iter = libNames.iterator(); iter.hasNext(); ) {
NativeLibrary lib = NativeLibrary.open((String) iter.next(), loader, global);
if (lib != null) {
return lib;
}
}
return null;
}
private void loadLibraries() {
if( null == toolLibNames || toolLibNames.size() == 0) {
if(DEBUG) {
System.err.println("No Tool native library names given");
}
return;
}
if( null == glueLibNames || glueLibNames.size() == 0 ) {
if(DEBUG) {
System.err.println("No Glue native library names given");
}
return;
}
toolLibLoadedNumber = 0;
int i;
toolLibLoaded = new boolean[toolLibNames.size()];
for(i=0; i<toolLibNames.size(); i++) {
toolLibLoaded[i] = false;
}
glueLibLoaded = new boolean[glueLibNames.size()];
for(i=0; i<glueLibNames.size(); i++) {
glueLibLoaded[i] = false;
}
ClassLoader loader = getClass().getClassLoader();
NativeLibrary lib = null;
i=0;
for(Iterator iter = toolLibNames.iterator(); iter.hasNext(); i++) {
Object listObj = iter.next();
List/*<String>*/ libNames = null;
if(listObj instanceof List) {
libNames = (List) listObj;
} else if(listObj instanceof String) {
libNames = new ArrayList();
libNames.add((String)listObj);
} else {
throw new RuntimeException("List element "+i+" must be either a List or String: "+toolLibNames);
}
if( null != libNames && libNames.size() > 0 ) {
lib = loadFirstAvailable(libNames, loader, info.shallLinkGlobal());
if ( null == lib ) {
if(DEBUG) {
System.err.println("Unable to load any Tool library of: "+libNames);
}
} else {
nativeLibraries.add(lib);
toolLibLoaded[i]=true;
toolLibLoadedNumber++;
if(DEBUG) {
System.err.println("Loaded Tool library: "+lib);
}
}
}
}
if( !isToolLibLoaded() ) {
if(DEBUG) {
System.err.println("No Tool libraries loaded");
}
return;
}
glueLibLoadedNumber = 0;
i=0;
for(Iterator iter = glueLibNames.iterator(); iter.hasNext(); i++) {
String libName = (String) iter.next();
boolean ignoreError = true;
boolean res;
try {
res = GlueJNILibLoaderBase.loadLibrary(libName, ignoreError);
if(DEBUG && !res) {
System.err.println("Info: Could not load JNI/Glue library: "+libName);
}
} catch (UnsatisfiedLinkError e) {
res = false;
if(DEBUG) {
System.err.println("Unable to load JNI/Glue library: "+libName);
e.printStackTrace();
}
}
glueLibLoaded[i] = res;
if(res) {
glueLibLoadedNumber++;
}
}
}
private long dynamicLookupFunctionOnLibs(String funcName) {
if(!isToolLibLoaded() || null==funcName) {
if(DEBUG_LOOKUP && !isToolLibLoaded()) {
System.err.println("Lookup-Native: <" + funcName + "> ** FAILED ** Tool native library not loaded");
}
return 0;
}
long addr = 0;
NativeLibrary lib = null;
if(info.shallLookupGlobal()) {
// Try a global symbol lookup first ..
addr = NativeLibrary.dynamicLookupFunctionGlobal(funcName);
}
// Look up this function name in all known libraries
for (Iterator iter = nativeLibraries.iterator(); 0==addr && iter.hasNext(); ) {
lib = (NativeLibrary) iter.next();
addr = lib.dynamicLookupFunction(funcName);
}
if(DEBUG_LOOKUP) {
String libName = ( null == lib ) ? "GLOBAL" : lib.toString();
if(0!=addr) {
System.err.println("Lookup-Native: <" + funcName + "> 0x" + Long.toHexString(addr) + " in lib " + libName );
} else {
System.err.println("Lookup-Native: <" + funcName + "> ** FAILED ** in libs " + nativeLibraries);
}
}
return addr;
}
public long dynamicLookupFunction(String funcName) {
if(!isToolLibLoaded() || null==funcName) {
if(DEBUG_LOOKUP && !isToolLibLoaded()) {
System.err.println("Lookup: <" + funcName + "> ** FAILED ** Tool native library not loaded");
}
return 0;
}
if(toolGetProcAddressFuncNameSet.contains(funcName)) {
return toolGetProcAddressHandle;
}
long addr = 0;
if(0 != toolGetProcAddressHandle) {
addr = info.toolDynamicLookupFunction(toolGetProcAddressHandle, funcName);
if(DEBUG_LOOKUP) {
if(0!=addr) {
System.err.println("Lookup-Tool: <"+funcName+"> 0x"+Long.toHexString(addr));
}
}
}
if(0==addr) {
addr = dynamicLookupFunctionOnLibs(funcName);
}
return addr;
}
/** Inherit access */
static class GlueJNILibLoaderBase extends JNILibLoaderBase {
protected static synchronized boolean loadLibrary(String libname, boolean ignoreError) {
return JNILibLoaderBase.loadLibrary(libname, ignoreError);
}
}
}
|