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
|
/*
* Copyright (c) 2010-2023 JogAmp Community. All rights reserved.
* Copyright (c) 2003-2005 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.gluegen.procaddress;
import com.jogamp.gluegen.CMethodBindingEmitter;
import com.jogamp.gluegen.JavaType;
import com.jogamp.gluegen.MethodBinding;
import com.jogamp.gluegen.cgram.types.FunctionSymbol;
import com.jogamp.gluegen.cgram.types.PointerType;
import com.jogamp.gluegen.cgram.types.Type;
public class ProcAddressCMethodBindingEmitter extends CMethodBindingEmitter {
private boolean callThroughProcAddress;
private boolean hasProcAddrTypedef;
private String localTypedefCallingConvention;
private static final String procAddressJavaTypeName = JavaType.createForClass(Long.TYPE).jniTypeName();
private ProcAddressEmitter emitter;
public ProcAddressCMethodBindingEmitter(final CMethodBindingEmitter methodToWrap,
final boolean callThroughProcAddress,
final boolean hasProcAddrTypedef,
final String localTypedefCallingConvention,
final ProcAddressEmitter emitter) {
super(
new MethodBinding(methodToWrap.getBinding()) {
@Override
public String getImplName() {
if (callThroughProcAddress) {
return ProcAddressEmitter.WRAP_PREFIX + super.getImplName();
} else {
return super.getImplName();
}
}
},
methodToWrap.getUnit(),
methodToWrap.getJavaPackageName(),
methodToWrap.getJavaClassName(),
methodToWrap.getIsOverloadedBinding(),
methodToWrap.getIsJavaMethodStatic(),
true,
methodToWrap.forIndirectBufferAndArrayImplementation(),
methodToWrap.getMachineDataInfo(),
emitter.getConfig()
);
if (methodToWrap.getReturnValueCapacityExpression() != null) {
setReturnValueCapacityExpression(methodToWrap.getReturnValueCapacityExpression());
}
if (methodToWrap.getReturnValueLengthExpression() != null) {
setReturnValueLengthExpression(methodToWrap.getReturnValueLengthExpression());
}
setTemporaryCVariableDeclarations(methodToWrap.getTemporaryCVariableDeclarations());
setTemporaryCVariableAssignments(methodToWrap.getTemporaryCVariableAssignments());
setCommentEmitter(defaultCommentEmitter);
this.callThroughProcAddress = callThroughProcAddress;
this.hasProcAddrTypedef = hasProcAddrTypedef;
this.localTypedefCallingConvention = localTypedefCallingConvention;
this.emitter = emitter;
}
@Override
protected int appendArguments(final StringBuilder buf) {
int numEmitted = super.appendArguments(buf);
if (callThroughProcAddress) {
if (numEmitted > 0) {
buf.append(", ");
}
buf.append(procAddressJavaTypeName);
buf.append(" procAddress");
++numEmitted;
}
return numEmitted;
}
@Override
protected void emitBodyVariableDeclarations() {
if (callThroughProcAddress) {
// create variable for the function pointer with the right type, and set
// it to the value of the passed-in proc address
final FunctionSymbol cSym = binding.getCSymbol();
// Always emit the local typedef, based on our parsing results.
// In case we do have the public typedef from the original header,
// we use it for the local var and assign our proc-handle to it,
// cast to the local typedef.
// This allows the native C compiler to validate our types!
final String funcPointerTypedefBaseName = emitter.getFunctionPointerTypedefName(cSym);
final String funcPointerTypedefLocalName = "_local_" + funcPointerTypedefBaseName;
final String funcPointerTypedefName;
if (hasProcAddrTypedef) {
funcPointerTypedefName = funcPointerTypedefBaseName;
} else {
funcPointerTypedefName = funcPointerTypedefLocalName;
}
final PointerType funcPtrType = new PointerType(null, cSym.getType(), 0);
unit.emit(" typedef ");
unit.emit(funcPtrType.toString(funcPointerTypedefLocalName, localTypedefCallingConvention));
unit.emitln(";");
unit.emit(" ");
unit.emit(funcPointerTypedefName); // Uses public typedef if available!
unit.emit(" ptr_");
unit.emit(getNativeName());
unit.emitln(";");
}
super.emitBodyVariableDeclarations();
}
@Override
protected void emitBodyVariablePreCallSetup() {
super.emitBodyVariablePreCallSetup();
if (callThroughProcAddress) {
// set the function pointer to the value of the passed-in procAddress
// See above notes in emitBodyVariableDeclarations(..)!
final String funcPointerTypedefBaseName = emitter.getFunctionPointerTypedefName(binding.getCSymbol());
final String funcPointerTypedefLocalName = "_local_" + funcPointerTypedefBaseName;
final String funcPointerTypedefName;
if (hasProcAddrTypedef) {
funcPointerTypedefName = funcPointerTypedefBaseName;
} else {
funcPointerTypedefName = funcPointerTypedefLocalName;
}
final String ptrVarName = "ptr_" + getNativeName();
if (hasProcAddrTypedef) {
unit.emitln(" // implicit type validation of "+funcPointerTypedefLocalName+" -> "+funcPointerTypedefName);
}
unit.emit(" ");
unit.emit(ptrVarName);
unit.emit(" = (");
unit.emit(funcPointerTypedefLocalName);
unit.emitln(") (intptr_t) procAddress;");
unit.emitln(" assert(" + ptrVarName + " != NULL);");
}
}
@Override
protected void emitBodyCallCFunction() {
if (!callThroughProcAddress) {
super.emitBodyCallCFunction();
} else {
// Make the call to the actual C function
unit.emit(" ");
// WARNING: this code assumes that the return type has already been
// typedef-resolved.
final Type cReturnType = binding.getCReturnType();
if (!cReturnType.isVoid()) {
// Note we respect const/volatile in the function return type.
// However, we cannot have it 'const' for our local variable.
// See return type in CMethodBindingEmitter.emitBodyVariableDeclarations(..)!
unit.emit("_res = (");
unit.emit(cReturnType.getCName(false));
unit.emit(") ");
}
final MethodBinding mBinding = getBinding();
if (mBinding.hasContainingType()) {
// FIXME: this can and should be handled and unified with the
// associated code in the CMethodBindingEmitter
throw new IllegalStateException("Cannot call through function pointer because binding has containing type: " + mBinding);
}
// call throught the run-time function pointer
unit.emit("(* ptr_");
unit.emit(getNativeName());
unit.emit(") ");
unit.emit("(");
emitBodyPassCArguments();
unit.emitln(");");
}
}
@Override
protected String jniMangle(final MethodBinding binding) {
final StringBuilder buf = new StringBuilder(super.jniMangle(binding));
if (callThroughProcAddress && 0 <= buf.indexOf("__") ) {
JavaType.appendJNIDescriptor(buf, Long.TYPE, false); // to account for the additional _addr_ parameter
}
return buf.toString();
}
}
|
