1 /* src/vm/builtin.h - prototypes of builtin functions
3 Copyright (C) 1996-2005 R. Grafl, A. Krall, C. Kruegel, C. Oates,
4 R. Obermaisser, M. Platter, M. Probst, S. Ring, E. Steiner,
5 C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich, J. Wenninger,
6 Institut f. Computersprachen - TU Wien
8 This file is part of CACAO.
10 This program is free software; you can redistribute it and/or
11 modify it under the terms of the GNU General Public License as
12 published by the Free Software Foundation; either version 2, or (at
13 your option) any later version.
15 This program is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
25 Contact: cacao@complang.tuwien.ac.at
27 Authors: Reinhard Grafl
29 Changes: Edwin Steiner
32 $Id: builtin.h 2365 2005-04-25 10:00:09Z twisti $
42 #include "toolbox/logging.h"
44 #if defined(USE_THREADS)
45 # if defined(NATIVE_THREADS)
46 # include "threads/native/threads.h"
48 # include "threads/green/threads.h"
52 #include "vm/jit/stacktrace.h"
55 /* define infinity for floating point numbers */
57 #define FLT_NAN 0x7fc00000
58 #define FLT_POSINF 0x7f800000
59 #define FLT_NEGINF 0xff800000
61 /* define infinity for double floating point numbers */
63 #define DBL_NAN 0x7ff8000000000000LL
64 #define DBL_POSINF 0x7ff0000000000000LL
65 #define DBL_NEGINF 0xfff0000000000000LL
68 /* float versions are not defined in gnu classpath's fdlibm */
70 #define copysignf copysign
71 #define finitef finite
76 /**********************************************************************/
77 /* BUILTIN FUNCTIONS TABLE */
78 /**********************************************************************/
81 * For each builtin function which is used in a BUILTIN* opcode there
82 * must be an entry in the builtin_desc table in jit/jit.c.
85 typedef struct builtin_descriptor builtin_descriptor;
87 /* There is a builtin_descriptor in builtin_desc for every builtin
88 * function used in BUILTIN* opcodes.
90 struct builtin_descriptor {
91 int opcode; /* opcode which is replaced by this builtin */
92 /* (255 means no automatic replacement, */
93 /* 0 means end of list.) */
94 functionptr builtin; /* the builtin function (specify BUILTIN_...*/
96 int icmd; /* the BUILTIN* opcode to use (# of args) */
97 u1 type_s1; /* type of 1st argument */
98 u1 type_s2; /* type of 2nd argument, or TYPE_VOID */
99 u1 type_s3; /* type of 3rd argument, or TYPE_VOID */
100 u1 type_d; /* type of result (may be TYPE_VOID) */
101 bool supported;/* is <opcode> supported without builtin? */
102 bool isfloat; /* is this a floating point operation? */
103 char *name; /* display name of the builtin function */
106 extern builtin_descriptor builtin_desc[];
108 /**********************************************************************/
109 /* GLOBAL VARIABLES */
110 /**********************************************************************/
112 #if defined(USEBUILTINTABLE)
113 void sort_builtintable(void);
114 builtin_descriptor *find_builtin(int opcode);
115 #endif /* defined(USEBUILTINTABLE) */
118 /**********************************************************************/
119 /* BUILTIN FUNCTIONS */
120 /**********************************************************************/
122 /* NOTE: Builtin functions which are used in the BUILTIN* opcodes must
123 * have a BUILTIN_... macro defined as seen below. In code dealing
124 * with the BUILTIN* opcodes the functions may only be addressed by
125 * these macros, never by their actual name! (This helps to make this
126 * code more portable.)
128 * C and assembler code which does not deal with the BUILTIN* opcodes,
129 * can use the builtin functions normally (like all other functions).
132 * For each builtin function which is used in a BUILTIN* opcode there
133 * must be an entry in the builtin_desc table in jit/jit.c.
135 * Below each prototype is either the BUILTIN_ macro definition or a
136 * comment specifiying that this function is not used in BUILTIN*
139 * (The BUILTIN* opcodes are ICMD_BUILTIN1, ICMD_BUILTIN2 and
143 s4 builtin_instanceof(java_objectheader *obj, classinfo *class);
144 #define BUILTIN_instanceof (functionptr) builtin_instanceof
145 s4 builtin_isanysubclass (classinfo *sub, classinfo *super);
147 s4 builtin_isanysubclass_vftbl (vftbl_t *sub, vftbl_t *super);
149 s4 builtin_checkcast(java_objectheader *obj, classinfo *class);
151 s4 builtin_arrayinstanceof(java_objectheader *obj, vftbl_t *target);
152 #define BUILTIN_arrayinstanceof (functionptr) builtin_arrayinstanceof
154 #if defined(__I386__)
155 s4 asm_builtin_arrayinstanceof(java_objectheader *obj, classinfo *class); /* XXX ? */
156 #undef BUILTIN_arrayinstanceof
157 #define BUILTIN_arrayinstanceof (functionptr) asm_builtin_arrayinstanceof
160 s4 builtin_checkarraycast(java_objectheader *o, vftbl_t *target);
162 s4 asm_builtin_checkarraycast(java_objectheader *o, vftbl_t *target);
163 #define BUILTIN_checkarraycast (functionptr) asm_builtin_checkarraycast
165 java_objectheader *builtin_throw_exception(java_objectheader *exception);
167 java_objectheader *builtin_trace_exception(java_objectheader *xptr,
174 java_objectheader *builtin_new(classinfo *c);
175 /* #if defined(__I386__) */
176 /* java_objectheader *asm_builtin_new(classinfo *c); */
177 /* #define BUILTIN_new (functionptr) asm_builtin_new */
179 #define BUILTIN_new (functionptr) builtin_new
182 java_arrayheader *builtin_newarray(s4 size, vftbl_t *arrayvftbl);
183 #define BUILTIN_newarray (functionptr) builtin_newarray
185 java_objectarray *builtin_anewarray(s4 size, classinfo *component);
186 #define BUILTIN_anewarray (functionptr) builtin_anewarray
188 #if defined(__I386__)
189 void asm_builtin_newarray(s4 size, vftbl_t *arrayvftbl);
190 #undef BUILTIN_newarray
191 #define BUILTIN_newarray (functionptr) asm_builtin_newarray
194 java_booleanarray *builtin_newarray_boolean(s4 size);
195 #define BUILTIN_newarray_boolean (functionptr) builtin_newarray_boolean
196 java_chararray *builtin_newarray_char(s4 size);
197 #define BUILTIN_newarray_char (functionptr) builtin_newarray_char
198 java_floatarray *builtin_newarray_float(s4 size);
199 #define BUILTIN_newarray_float (functionptr) builtin_newarray_float
200 java_doublearray *builtin_newarray_double(s4 size);
201 #define BUILTIN_newarray_double (functionptr) builtin_newarray_double
202 java_bytearray *builtin_newarray_byte(s4 size);
203 #define BUILTIN_newarray_byte (functionptr) builtin_newarray_byte
204 java_shortarray *builtin_newarray_short(s4 size);
205 #define BUILTIN_newarray_short (functionptr) builtin_newarray_short
206 java_intarray *builtin_newarray_int(s4 size);
207 #define BUILTIN_newarray_int (functionptr) builtin_newarray_int
208 java_longarray *builtin_newarray_long(s4 size);
209 #define BUILTIN_newarray_long (functionptr) builtin_newarray_long
210 java_arrayheader *builtin_multianewarray(int n, vftbl_t *arrayvftbl, long *dims);
211 #define BUILTIN_multianewarray (functionptr) builtin_multianewarray
213 s4 builtin_canstore(java_objectarray *a, java_objectheader *o);
215 void asm_builtin_aastore(java_objectarray *a, s4 index, java_objectheader *o);
216 #define BUILTIN_aastore (functionptr) asm_builtin_aastore
218 #if defined(TRACE_ARGS_NUM)
219 void builtin_trace_args(s8 a0, s8 a1, s8 a2, s8 a3,
220 #if TRACE_ARGS_NUM >= 6
222 #endif /* TRACE_ARGS_NUM >= 6 */
223 #if TRACE_ARGS_NUM == 8
225 #endif /* TRACE_ARGS_NUM == 8 */
228 #endif /* defined(TRACE_ARGS_NUM) */
229 void builtin_displaymethodstart(methodinfo *m);
231 void builtin_displaymethodstop(methodinfo *m, s8 l, double d, float f);
234 #if defined(USE_THREADS)
235 void builtin_monitorenter(java_objectheader *o);
236 #define BUILTIN_monitorenter (functionptr) builtin_monitorenter
237 void builtin_staticmonitorenter(classinfo *c);
238 #define BUILTIN_staticmonitorenter (functionptr) builtin_staticmonitorenter
239 void builtin_monitorexit(java_objectheader *o);
240 #define BUILTIN_monitorexit (functionptr) builtin_monitorexit
243 s4 builtin_idiv(s4 a, s4 b);
245 s4 asm_builtin_idiv(s4 a, s4 b);
246 #define BUILTIN_idiv (functionptr) asm_builtin_idiv
247 s4 builtin_irem(s4 a, s4 b);
249 s4 asm_builtin_irem(s4 a, s4 b);
250 #define BUILTIN_irem (functionptr) asm_builtin_irem
252 s8 builtin_ladd(s8 a, s8 b);
253 #define BUILTIN_ladd (functionptr) builtin_ladd
254 s8 builtin_lsub(s8 a, s8 b);
255 #define BUILTIN_lsub (functionptr) builtin_lsub
256 s8 builtin_lmul(s8 a, s8 b);
257 #define BUILTIN_lmul (functionptr) builtin_lmul
258 s8 builtin_ldiv(s8 a, s8 b);
260 s8 asm_builtin_ldiv(s8 a, s8 b);
261 #define BUILTIN_ldiv (functionptr) asm_builtin_ldiv
262 s8 builtin_lrem(s8 a, s8 b);
264 s8 asm_builtin_lrem(s8 a, s8 b);
265 #define BUILTIN_lrem (functionptr) asm_builtin_lrem
266 s8 builtin_lshl(s8 a, s4 b);
267 #define BUILTIN_lshl (functionptr) builtin_lshl
268 s8 builtin_lshr(s8 a, s4 b);
269 #define BUILTIN_lshr (functionptr) builtin_lshr
270 s8 builtin_lushr(s8 a, s4 b);
271 #define BUILTIN_lushr (functionptr) builtin_lushr
272 s8 builtin_land(s8 a, s8 b);
273 #define BUILTIN_land (functionptr) builtin_land
274 s8 builtin_lor(s8 a, s8 b);
275 #define BUILTIN_lor (functionptr) builtin_lor
276 s8 builtin_lxor(s8 a, s8 b);
277 #define BUILTIN_lxor (functionptr) builtin_lxor
278 s8 builtin_lneg(s8 a);
279 #define BUILTIN_lneg (functionptr) builtin_lneg
280 s4 builtin_lcmp(s8 a, s8 b);
281 #define BUILTIN_lcmp (functionptr) builtin_lcmp
283 float builtin_fadd(float a, float b);
284 #define BUILTIN_fadd (functionptr) builtin_fadd
285 float builtin_fsub(float a, float b);
286 #define BUILTIN_fsub (functionptr) builtin_fsub
287 float builtin_fmul(float a, float b);
288 #define BUILTIN_fmul (functionptr) builtin_fmul
289 float builtin_fdiv(float a, float b);
290 #define BUILTIN_fdiv (functionptr) builtin_fdiv
291 float builtin_fneg(float a);
292 #define BUILTIN_fneg (functionptr) builtin_fneg
293 s4 builtin_fcmpl(float a, float b);
294 #define BUILTIN_fcmpl (functionptr) builtin_fcmpl
295 s4 builtin_fcmpg(float a, float b);
296 #define BUILTIN_fcmpg (functionptr) builtin_fcmpg
297 float builtin_frem(float a, float b);
298 #define BUILTIN_frem (functionptr) builtin_frem
300 double builtin_dadd(double a, double b);
301 #define BUILTIN_dadd (functionptr) builtin_dadd
302 double builtin_dsub(double a, double b);
303 #define BUILTIN_dsub (functionptr) builtin_dsub
304 double builtin_dmul(double a, double b);
305 #define BUILTIN_dmul (functionptr) builtin_dmul
306 double builtin_ddiv(double a, double b);
307 #define BUILTIN_ddiv (functionptr) builtin_ddiv
308 double builtin_dneg(double a);
309 #define BUILTIN_dneg (functionptr) builtin_dneg
310 s4 builtin_dcmpl(double a, double b);
311 #define BUILTIN_dcmpl (functionptr) builtin_dcmpl
312 s4 builtin_dcmpg(double a, double b);
313 #define BUILTIN_dcmpg (functionptr) builtin_dcmpg
314 double builtin_drem(double a, double b);
315 #define BUILTIN_drem (functionptr) builtin_drem
317 s8 builtin_i2l(s4 i);
319 float builtin_i2f(s4 i);
320 #define BUILTIN_i2f (functionptr) builtin_i2f
321 double builtin_i2d(s4 i);
322 #define BUILTIN_i2d (functionptr) builtin_i2d
323 s4 builtin_l2i(s8 l);
325 float builtin_l2f(s8 l);
326 #define BUILTIN_l2f (functionptr) builtin_l2f
327 double builtin_l2d(s8 l);
328 #define BUILTIN_l2d (functionptr) builtin_l2d
330 s4 builtin_f2i(float a);
331 #define BUILTIN_f2i (functionptr) builtin_f2i
332 s4 asm_builtin_f2i(float a);
334 s8 builtin_f2l(float a);
335 #define BUILTIN_f2l (functionptr) builtin_f2l
336 s8 asm_builtin_f2l(float a);
339 double builtin_f2d(float a);
340 #define BUILTIN_f2d (functionptr) builtin_f2d
342 s4 builtin_d2i(double a);
343 #define BUILTIN_d2i (functionptr) builtin_d2i
344 s4 asm_builtin_d2i(double a);
346 s8 builtin_d2l(double a);
347 #define BUILTIN_d2l (functionptr) builtin_d2l
348 s8 asm_builtin_d2l(double a);
351 float builtin_d2f(double a);
352 #define BUILTIN_d2f (functionptr) builtin_d2f
354 java_arrayheader *builtin_clone_array(void *env, java_arrayheader *o);
357 /* builtin_dummy just panics if it is executed. */
358 s4 builtin_dummy(void);
361 /* conversion helper functions */
362 inline float intBitsToFloat(s4 i);
363 inline float longBitsToDouble(s8 l);
365 /* this is a wrapper for calls from asmpart */
366 java_objectheader **builtin_asm_get_exceptionptrptr(void);
368 #if defined(USE_THREADS) && defined(NATIVE_THREADS)
369 static inline java_objectheader **builtin_get_exceptionptrptr(void);
370 static inline u1 *builtin_get_dontfillinexceptionstacktrace(void);
372 static inline methodinfo **builtin_get_threadrootmethod(void);
375 inline java_objectheader **builtin_get_exceptionptrptr(void)
377 return &THREADINFO->_exceptionptr;
380 inline u1 *builtin_get_dontfillinexceptionstacktrace(void)
382 return &THREADINFO->_dontfillinexceptionstacktrace;
385 inline methodinfo **builtin_get_threadrootmethod(void)
387 return &THREADINFO->_threadrootmethod;
392 /* returns the root method of a thread. this is used in asmpart.S and delivers the abort condition
393 for the stack unwinding for getClassContext and getClassLoader. For the main thread this is the main function.
394 Otherwhise it is the thread's run method (at least that's how I see it) (jowenn) */
395 methodinfo *builtin_asm_get_threadrootmethod(void);
397 /* returns the current top element of the stack frame info list (needed for unwinding across native functions) */
398 /* on i386 this is a pointer to a structure
399 ------------------------------------------------
400 | return adress out of native stub |
401 | pointer to method info | either i have to save an arbitrary adress within this native stub or the pointer to the method info, both are equaly costly, I have chosen the method info (JOWENN)
402 | pointer to thread specific top of this list |<----stack frame begin
403 points here---->| previous element in list |
404 ------------------------------------------------
406 void *builtin_asm_get_stackframeinfo(void);
407 stacktraceelement *builtin_stacktrace_copy(stacktraceelement **,stacktraceelement *begin, stacktraceelement *end);
408 #endif /* _BUILTIN_H */
412 * These are local overrides for various environment variables in Emacs.
413 * Please do not remove this and leave it at the end of the file, where
414 * Emacs will automagically detect them.
415 * ---------------------------------------------------------------------
418 * indent-tabs-mode: t