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
|
/**
* Copyright 2023 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.gluegen;
import java.io.IOException;
import java.util.List;
/**
* C code unit (a generated C source file),
* covering multiple {@link FunctionEmitter} allowing to unify output, decoration and dynamic helper code injection per unit.
**/
public class CCodeUnit extends CodeUnit {
/** base c-unit name with suffix. */
public final String cUnitName;
/**
* @param filename the class's full filename to open w/ write access
* @param cUnitName the base c-unit name, i.e. c-file basename with suffix
* @param generator informal optional object that is creating this unit, used to be mentioned in a warning message if not null.
* @throws IOException
*/
public CCodeUnit(final String filename, final String cUnitName, final Object generator) throws IOException {
super(filename, generator);
this.cUnitName = cUnitName;
CodeGenUtils.emitAutogeneratedWarning(output, generator, "C-Unit: "+cUnitName+", "+filename);
}
public void emitHeader(final String libraryBasename, final String packageName, final String className, final List<String> customCode) {
emitln("#include <jni.h>");
emitln("#include <stdlib.h>");
emitln("#include <string.h>");
emitln("#include <assert.h>");
emitln("#include <stddef.h>");
emitln();
if( null != libraryBasename && libraryBasename.length() > 0 ) {
emitJNIOnLoadJNIEnvDecl(libraryBasename);
}
emitln("static jobject JVMUtil_NewDirectByteBufferCopy(JNIEnv *env, jclass clazzBuffers, void * source_address, size_t capacity); /* forward decl. */");
emitln();
boolean addNewDirectByteBufferCopyUnitCode = false;
for (final String code : customCode) {
emitln(code);
addNewDirectByteBufferCopyUnitCode = addNewDirectByteBufferCopyUnitCode || code.contains("JVMUtil_NewDirectByteBufferCopy");
}
emitln();
if( addNewDirectByteBufferCopyUnitCode ) {
addTailCode(NewDirectByteBufferCopyUnitCode); // potentially used...
}
}
/** Emits {@link #getJNIOnLoadJNIEnvDecl(String)}. */
public void emitJNIOnLoadJNIEnvDecl(final String libraryBasename) {
emitln( getJNIOnLoadJNIEnvDecl(libraryBasename) );
}
/** Emits {@link #getJNIOnLoadJNIEnvCode(String)}. */
public void emitJNIOnLoadJNIEnvCode(final String libraryBasename) {
emitln( getJNIOnLoadJNIEnvCode(libraryBasename) );
}
/** Emits {@link #JavaCallbackGlueDataDecl}. */
public void emitJavaCallbackGlueDataDecl() {
emitln( JavaCallbackGlueDataDecl );
}
@Override
public String toString() { return "CCodeUnit[unit "+cUnitName+", file "+filename+"]"; }
public static final String NewDirectByteBufferCopyUnitCode =
"static const char * nameCopyNativeToDirectByteBuffer = \"copyNativeToDirectByteBuffer\";\n"+
"static const char * nameCopyNativeToDirectByteBufferSignature = \"(JJ)Ljava/nio/ByteBuffer;\";\n"+
"\n"+
"static jobject JVMUtil_NewDirectByteBufferCopy(JNIEnv *env, jclass clazzBuffers, void * source_address, size_t capacity) {\n"+
" jmethodID cstrBuffersNew = (*env)->GetStaticMethodID(env, clazzBuffers, nameCopyNativeToDirectByteBuffer, nameCopyNativeToDirectByteBufferSignature);\n"+
" if(NULL==cstrBuffersNew) {\n"+
" fprintf(stderr, \"Can't get method Buffers.%s(%s)\\n\", nameCopyNativeToDirectByteBuffer, nameCopyNativeToDirectByteBufferSignature);\n"+
" (*env)->FatalError(env, nameCopyNativeToDirectByteBuffer);\n"+
" return JNI_FALSE;\n"+
" }\n"+
" jobject jbyteBuffer = (*env)->CallStaticObjectMethod(env, clazzBuffers, cstrBuffersNew, (jlong)(intptr_t)source_address, (jlong)capacity);\n"+
" if( (*env)->ExceptionCheck(env) ) {\n"+
" (*env)->ExceptionDescribe(env);\n"+
" (*env)->ExceptionClear(env);\n"+
" (*env)->FatalError(env, \"Exception occurred\");\n"+
" return NULL;\n"+
" }\n"+
" return jbyteBuffer;\n"+
"}\n";
/** JavaCallback Glue Data typedef struct */
public static final String JavaCallbackGlueDataDecl =
"typedef struct {\n"+
" jobject lockObj;\n"+
" jobject cbFunc;\n"+
" jmethodID cbMethodID;\n"+
" jobject userParam;\n"+
"} T_JavaCallbackGlueData;\n"+
"\n";
/**
* Returns native JNI declarations for `JavaVM* {libraryBasename}_jvmHandle`
* and `JVMUtil_GetJNIEnv(..)`.
* <p>
* See {@link #getJNIOnLoadJNIEnvCode(String)} for details.
* </p>
* @param libraryBasename library basename to generate the `JNI_OnLoad_{libraryBasename}(..)` variant for statically linked libraries.
* @return the code
* @see #getJNIOnLoadJNIEnvCode(String)
*/
public static final String getJNIOnLoadJNIEnvDecl(final String libraryBasename) {
return "extern JavaVM *"+libraryBasename+"_jvmHandle;\n"+
"JNIEnv* JVMUtil_GetJNIEnv();\n"+
"\n";
}
/**
* Returns native JNI code `JNI_OnLoad(..)` used for dynamic libraries,
* `JNI_OnLoad_{libraryBasename}(..)` used for static libraries,
* `JVMUtil_GetJNIEnv(..)` and the instance of `JavaVM* {libraryBasename}_jvmHandle`.
* <p>
* The `JNI_OnLoad*(..)` methods set the `JavaVM* {libraryBasename}_jvmHandle`,
* which in turn is utilized by `JVMUtil_GetJNIEnv(..)`
* to attach a new thread to the `JavaVM*` generating a new `JNIEnv*`in daemon mode -
* or just to retrieve the thread's `JNIEnv*`, if already attached to the `JavaVM*`.
* </p>
* @param libraryBasename library basename to generate the `JNI_OnLoad_{libraryBasename}(..)` variant for statically linked libraries.
* @return the code
* @see #getJNIOnLoadJNIEnvDecl(String)
*/
public static final String getJNIOnLoadJNIEnvCode(final String libraryBasename) {
final String jvmHandleName = libraryBasename+"_jvmHandle";
final StringBuilder sb = new StringBuilder();
sb.append("JavaVM *").append(jvmHandleName).append(" = NULL;\n");
sb.append("JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM *initVM, void *reserved) {\n");
sb.append(" (void)reserved;\n");
sb.append(" ").append(jvmHandleName).append(" = initVM;\n");
sb.append(" fprintf(stderr, \"ON_LOAD_0\\n\");\n");
sb.append(" return JNI_VERSION_1_8;\n");
sb.append("}\n");
sb.append("JNIEXPORT jint JNICALL JNI_OnLoad_").append(libraryBasename).append("(JavaVM *initVM, void *reserved) {\n");
sb.append(" (void)reserved;\n");
sb.append(" ").append(jvmHandleName).append(" = initVM;\n");
sb.append(" fprintf(stderr, \"ON_LOAD_1\\n\");\n");
sb.append(" return JNI_VERSION_1_8;\n");
sb.append("}\n");
sb.append("\n");
sb.append("JNIEXPORT void JNICALL JNI_OnUnload(JavaVM *vm, void *reserved) {\n");
sb.append(" (void)vm;\n");
sb.append(" (void)reserved;\n");
sb.append(" fprintf(stderr, \"ON_UNLOAD_0\\n\");\n");
sb.append("}\n");
sb.append("\n");
sb.append("JNIEXPORT void JNICALL JNI_OnUnload_").append(libraryBasename).append("(JavaVM *vm, void *reserved) {\n");
sb.append(" (void)vm;\n");
sb.append(" (void)reserved;\n");
sb.append(" fprintf(stderr, \"ON_UNLOAD_1\\n\");\n");
sb.append("}\n");
sb.append("\n");
sb.append("JNIEnv* JVMUtil_GetJNIEnv() {\n");
sb.append(" JNIEnv* curEnv = NULL;\n");
sb.append(" JNIEnv* newEnv = NULL;\n");
sb.append(" int envRes;\n");
sb.append("\n");
sb.append(" if(NULL==").append(jvmHandleName).append(") {\n");
sb.append(" fprintf(stderr, \"JVMUtil_GetJNIEnv(").append(libraryBasename).append("): No JavaVM handle registered.\");\n");
sb.append(" return NULL;\n");
sb.append(" }\n");
sb.append("\n");
sb.append(" // retrieve this thread's JNIEnv curEnv - or detect it's detached\n");
sb.append(" envRes = (*").append(jvmHandleName).append(")->GetEnv(").append(jvmHandleName).append(", (void **) &curEnv, JNI_VERSION_1_8) ;\n");
sb.append(" if( JNI_EDETACHED == envRes ) {\n");
sb.append(" // detached thread - attach to JVM as daemon, w/o need to be detached!\n");
sb.append(" envRes = (*").append(jvmHandleName).append(")->AttachCurrentThreadAsDaemon(").append(jvmHandleName).append(", (void**) &newEnv, NULL);\n");
sb.append(" if( JNI_OK != envRes ) {\n");
sb.append(" fprintf(stderr, \"JVMUtil_GetJNIEnv(").append(libraryBasename).append("): Can't attach thread: %d\\n\", envRes);\n");
sb.append(" return NULL;\n");
sb.append(" }\n");
sb.append(" curEnv = newEnv;\n");
sb.append(" } else if( JNI_OK != envRes ) {\n");
sb.append(" // oops ..\n");
sb.append(" fprintf(stderr, \"JVMUtil_GetJNIEnv(").append(libraryBasename).append("): Can't GetEnv: %d\\n\", envRes);\n");
sb.append(" return NULL;\n");
sb.append(" }\n");
sb.append(" if (curEnv==NULL) {\n");
sb.append(" fprintf(stderr, \"JVMUtil_GetJNIEnv(").append(libraryBasename).append("): env is NULL\\n\");\n");
sb.append(" return NULL;\n");
sb.append(" }\n");
sb.append(" return curEnv;\n");
sb.append("}\n");
sb.append("\n");
return sb.toString();
}
}
|
