src/vm/builtin.h

   1 /* src/vm/builtin.h - prototypes of builtin functions
   2
   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
   7
   8    This file is part of CACAO.
   9
  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.
  14
  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.
  19
  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
  23    02111-1307, USA.
  24
  25    Contact: cacao@complang.tuwien.ac.at
  26
  27    Authors: Reinhard Grafl
  28
  29    Changes: Edwin Steiner
  30             Christian Thalinger
  31
  32    $Id: builtin.h 2357 2005-04-22 17:37:57Z christian $
  33
  34 */
  35
  36
  37 #ifndef _BUILTIN_H
  38 #define _BUILTIN_H
  39
  40 #include "arch.h"
  41 #include "config.h"
  42 #include "toolbox/logging.h"
  43
  44 #if defined(USE_THREADS)
  45 # if defined(NATIVE_THREADS)
  46 #  include "threads/native/threads.h"
  47 # else
  48 #  include "threads/green/threads.h"
  49 # endif
  50 #endif
  51
  52 #include "vm/jit/stacktrace.h"
  53
  54
  55 /* define infinity for floating point numbers */
  56
  57 #define FLT_NAN     0x7fc00000
  58 #define FLT_POSINF  0x7f800000
  59 #define FLT_NEGINF  0xff800000
  60
  61 /* define infinity for double floating point numbers */
  62
  63 #define DBL_NAN     0x7ff8000000000000LL
  64 #define DBL_POSINF  0x7ff0000000000000LL
  65 #define DBL_NEGINF  0xfff0000000000000LL
  66
  67
  68 /* float versions are not defined in gnu classpath's fdlibm */
  69
  70 #define copysignf    copysign
  71 #define finitef      finite
  72 #define fmodf        fmod
  73 #define isnanf       isnan
  74
  75
  76 /**********************************************************************/
  77 /* BUILTIN FUNCTIONS TABLE                                            */
  78 /**********************************************************************/
  79
  80 /* IMPORTANT:
  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.
  83  */
  84
  85 typedef struct builtin_descriptor builtin_descriptor;
  86
  87 /* There is a builtin_descriptor in builtin_desc for every builtin
  88  * function used in BUILTIN* opcodes.
  89  */
  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_...*/
  95                               /* macro)                                   */
  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     */
 104 };
 105
 106 extern builtin_descriptor builtin_desc[];
 107
 108 /**********************************************************************/
 109 /* GLOBAL VARIABLES                                                   */
 110 /**********************************************************************/
 111
 112 #if defined(USEBUILTINTABLE)
 113 void sort_builtintable(void);
 114 builtin_descriptor *find_builtin(int opcode);
 115 #endif /* defined(USEBUILTINTABLE) */
 116
 117
 118 /**********************************************************************/
 119 /* BUILTIN FUNCTIONS                                                  */
 120 /**********************************************************************/
 121
 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.)
 127  *
 128  * C and assembler code which does not deal with the BUILTIN* opcodes,
 129  * can use the builtin functions normally (like all other functions).
 130  *
 131  * IMPORTANT:
 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.
 134  *
 135  * Below each prototype is either the BUILTIN_ macro definition or a
 136  * comment specifiying that this function is not used in BUILTIN*
 137  * opcodes.
 138  *
 139  * (The BUILTIN* opcodes are ICMD_BUILTIN1, ICMD_BUILTIN2 and
 140  * ICMD_BUILTIN3.)
 141  */
 142
 143 s4 builtin_instanceof(java_objectheader *obj, classinfo *class);
 144 #define BUILTIN_instanceof (functionptr) builtin_instanceof
 145 s4 builtin_isanysubclass (classinfo *sub, classinfo *super);
 146 /* NOT AN OP */
 147 s4 builtin_isanysubclass_vftbl (vftbl_t *sub, vftbl_t *super);
 148 /* NOT AN OP */
 149 s4 builtin_checkcast(java_objectheader *obj, classinfo *class);
 150 /* NOT AN OP */
 151 s4 builtin_arrayinstanceof(java_objectheader *obj, vftbl_t *target);
 152 #define BUILTIN_arrayinstanceof (functionptr) builtin_arrayinstanceof
 153
 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
 158 #endif
 159
 160 s4 builtin_checkarraycast(java_objectheader *obj, vftbl_t *target);
 161 /* NOT AN OP */
 162 s4 asm_builtin_checkarraycast(java_objectheader *obj, vftbl_t *target);
 163 #define BUILTIN_checkarraycast (functionptr) asm_builtin_checkarraycast
 164
 165 java_objectheader *builtin_throw_exception(java_objectheader *exception);
 166 /* NOT AN OP */
 167 java_objectheader *builtin_trace_exception(java_objectheader *xptr,
 168                                                                                    methodinfo *m,
 169                                                                                    void *pos,
 170                                                                                    s4 line,
 171                                                                                    s4 noindent);
 172 /* NOT AN OP */
 173
 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 */
 178 /*  #else */
 179 #define BUILTIN_new (functionptr) builtin_new
 180 /*  #endif */
 181
 182 java_arrayheader *builtin_newarray(s4 size, vftbl_t *arrayvftbl);
 183 #define BUILTIN_newarray (functionptr) builtin_newarray
 184
 185 java_objectarray *builtin_anewarray(s4 size, classinfo *component);
 186 #define BUILTIN_anewarray (functionptr) builtin_anewarray
 187
 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
 192 #endif
 193
 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
 212
 213 s4 builtin_canstore(java_objectarray *a, java_objectheader *o);
 214 /* NOT AN OP */
 215 void asm_builtin_aastore(java_objectarray *a, s4 index, java_objectheader *o);
 216 #define BUILTIN_aastore (functionptr) asm_builtin_aastore
 217
 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
 221                                                 s8 a4, s8 a5,
 222 #endif /* TRACE_ARGS_NUM >= 6 */
 223 #if TRACE_ARGS_NUM == 8
 224                                                 s8 a6, s8 a7,
 225 #endif /* TRACE_ARGS_NUM == 8 */
 226                                                 methodinfo *m);
 227 /* NOT AN OP */
 228 #endif /* defined(TRACE_ARGS_NUM) */
 229 void builtin_displaymethodstart(methodinfo *m);
 230 /* NOT AN OP */
 231 void builtin_displaymethodstop(methodinfo *m, s8 l, double d, float f);
 232 /* NOT AN OP */
 233
 234 #if defined(USE_THREADS)
 235 void builtin_monitorenter(java_objectheader *o);
 236 /* NOT AN OP */
 237 void builtin_staticmonitorenter(classinfo *c);
 238 /* NOT AN OP */
 239 void asm_builtin_monitorenter(java_objectheader *o);
 240 #define BUILTIN_monitorenter (functionptr) asm_builtin_monitorenter
 241 void *builtin_monitorexit(java_objectheader *o);
 242 /* NOT AN OP */
 243 void *asm_builtin_monitorexit(java_objectheader *o);
 244 #define BUILTIN_monitorexit (functionptr) asm_builtin_monitorexit
 245 #endif
 246
 247 s4 builtin_idiv(s4 a, s4 b);
 248 /* NOT AN OP */
 249 s4 asm_builtin_idiv(s4 a, s4 b);
 250 #define BUILTIN_idiv (functionptr) asm_builtin_idiv
 251 s4 builtin_irem(s4 a, s4 b);
 252 /* NOT AN OP */
 253 s4 asm_builtin_irem(s4 a, s4 b);
 254 #define BUILTIN_irem (functionptr) asm_builtin_irem
 255
 256 s8 builtin_ladd(s8 a, s8 b);
 257 #define BUILTIN_ladd (functionptr) builtin_ladd
 258 s8 builtin_lsub(s8 a, s8 b);
 259 #define BUILTIN_lsub (functionptr) builtin_lsub
 260 s8 builtin_lmul(s8 a, s8 b);
 261 #define BUILTIN_lmul (functionptr) builtin_lmul
 262 s8 builtin_ldiv(s8 a, s8 b);
 263 /* NOT AN OP */
 264 s8 asm_builtin_ldiv(s8 a, s8 b);
 265 #define BUILTIN_ldiv (functionptr) asm_builtin_ldiv
 266 s8 builtin_lrem(s8 a, s8 b);
 267 /* NOT AN OP */
 268 s8 asm_builtin_lrem(s8 a, s8 b);
 269 #define BUILTIN_lrem (functionptr) asm_builtin_lrem
 270 s8 builtin_lshl(s8 a, s4 b);
 271 #define BUILTIN_lshl (functionptr) builtin_lshl
 272 s8 builtin_lshr(s8 a, s4 b);
 273 #define BUILTIN_lshr (functionptr) builtin_lshr
 274 s8 builtin_lushr(s8 a, s4 b);
 275 #define BUILTIN_lushr (functionptr) builtin_lushr
 276 s8 builtin_land(s8 a, s8 b);
 277 #define BUILTIN_land (functionptr) builtin_land
 278 s8 builtin_lor(s8 a, s8 b);
 279 #define BUILTIN_lor (functionptr) builtin_lor
 280 s8 builtin_lxor(s8 a, s8 b);
 281 #define BUILTIN_lxor (functionptr) builtin_lxor
 282 s8 builtin_lneg(s8 a);
 283 #define BUILTIN_lneg (functionptr) builtin_lneg
 284 s4 builtin_lcmp(s8 a, s8 b);
 285 #define BUILTIN_lcmp (functionptr) builtin_lcmp
 286
 287 float builtin_fadd(float a, float b);
 288 #define BUILTIN_fadd (functionptr) builtin_fadd
 289 float builtin_fsub(float a, float b);
 290 #define BUILTIN_fsub (functionptr) builtin_fsub
 291 float builtin_fmul(float a, float b);
 292 #define BUILTIN_fmul (functionptr) builtin_fmul
 293 float builtin_fdiv(float a, float b);
 294 #define BUILTIN_fdiv (functionptr) builtin_fdiv
 295 float builtin_fneg(float a);
 296 #define BUILTIN_fneg (functionptr) builtin_fneg
 297 s4 builtin_fcmpl(float a, float b);
 298 #define BUILTIN_fcmpl (functionptr) builtin_fcmpl
 299 s4 builtin_fcmpg(float a, float b);
 300 #define BUILTIN_fcmpg (functionptr) builtin_fcmpg
 301 float builtin_frem(float a, float b);
 302 #define BUILTIN_frem (functionptr) builtin_frem
 303
 304 double builtin_dadd(double a, double b);
 305 #define BUILTIN_dadd (functionptr) builtin_dadd
 306 double builtin_dsub(double a, double b);
 307 #define BUILTIN_dsub (functionptr) builtin_dsub
 308 double builtin_dmul(double a, double b);
 309 #define BUILTIN_dmul (functionptr) builtin_dmul
 310 double builtin_ddiv(double a, double b);
 311 #define BUILTIN_ddiv (functionptr) builtin_ddiv
 312 double builtin_dneg(double a);
 313 #define BUILTIN_dneg (functionptr) builtin_dneg
 314 s4 builtin_dcmpl(double a, double b);
 315 #define BUILTIN_dcmpl (functionptr) builtin_dcmpl
 316 s4 builtin_dcmpg(double a, double b);
 317 #define BUILTIN_dcmpg (functionptr) builtin_dcmpg
 318 double builtin_drem(double a, double b);
 319 #define BUILTIN_drem (functionptr) builtin_drem
 320
 321 s8       builtin_i2l(s4 i);
 322 /* NOT AN OP */
 323 float    builtin_i2f(s4 i);
 324 #define BUILTIN_i2f (functionptr) builtin_i2f
 325 double   builtin_i2d(s4 i);
 326 #define BUILTIN_i2d (functionptr) builtin_i2d
 327 s4       builtin_l2i(s8 l);
 328 /* NOT AN OP */
 329 float    builtin_l2f(s8 l);
 330 #define BUILTIN_l2f (functionptr) builtin_l2f
 331 double   builtin_l2d(s8 l);
 332 #define BUILTIN_l2d (functionptr) builtin_l2d
 333
 334 s4       builtin_f2i(float a);
 335 #define BUILTIN_f2i (functionptr) builtin_f2i
 336 s4       asm_builtin_f2i(float a);
 337 /* NOT AN OP */
 338 s8       builtin_f2l(float a);
 339 #define BUILTIN_f2l (functionptr) builtin_f2l
 340 s8       asm_builtin_f2l(float a);
 341 /* NOT AN OP */
 342
 343 double   builtin_f2d(float a);
 344 #define BUILTIN_f2d (functionptr) builtin_f2d
 345
 346 s4       builtin_d2i(double a);
 347 #define BUILTIN_d2i (functionptr) builtin_d2i
 348 s4       asm_builtin_d2i(double a);
 349 /* NOT AN OP */
 350 s8       builtin_d2l(double a);
 351 #define BUILTIN_d2l (functionptr) builtin_d2l
 352 s8       asm_builtin_d2l(double a);
 353 /* NOT AN OP */
 354
 355 float    builtin_d2f(double a);
 356 #define BUILTIN_d2f (functionptr) builtin_d2f
 357
 358 java_arrayheader *builtin_clone_array(void *env, java_arrayheader *o);
 359 /* NOT AN OP */
 360
 361 /* builtin_dummy just panics if it is executed. */
 362 s4 builtin_dummy(void);
 363 /* NOT AN OP */
 364
 365 /* conversion helper functions */
 366 inline float intBitsToFloat(s4 i);
 367 inline float longBitsToDouble(s8 l);
 368
 369 /* this is a wrapper for calls from asmpart */
 370 java_objectheader **builtin_asm_get_exceptionptrptr(void);
 371
 372 #if defined(USE_THREADS) && defined(NATIVE_THREADS)
 373 static inline java_objectheader **builtin_get_exceptionptrptr(void);
 374 /* NOT AN OP */
 375 static inline methodinfo **builtin_get_threadrootmethod(void);
 376 /* NOT AN OP */
 377
 378 inline java_objectheader **builtin_get_exceptionptrptr(void)
 379 {
 380         return &THREADINFO->_exceptionptr;
 381 }
 382
 383 inline methodinfo **builtin_get_threadrootmethod(void)
 384 {
 385         return &THREADINFO->_threadrootmethod;
 386 }
 387 #endif
 388
 389
 390 /* returns the root method of a thread. this is used in asmpart.S and delivers the abort condition
 391    for the stack unwinding for getClassContext and getClassLoader. For the main thread this is the main function.
 392    Otherwhise it is the thread's run method (at least that's how I see it) (jowenn) */
 393 methodinfo *builtin_asm_get_threadrootmethod(void);
 394
 395 /* returns the current top element of the stack frame info list (needed for unwinding across native functions) */
 396 /* on i386 this is a pointer to a structure
 397                 ------------------------------------------------
 398                 | return adress out of native stub              |
 399                 | 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)
 400                 | pointer to thread specific top of this list   |<----stack frame begin
 401 points here---->| previous element in list                      |
 402                 ------------------------------------------------
 403 */
 404 void *builtin_asm_get_stackframeinfo(void);
 405 stacktraceelement *builtin_stacktrace_copy(stacktraceelement **,stacktraceelement *begin, stacktraceelement *end);
 406 #endif /* _BUILTIN_H */
 407
 408
 409 /*
 410  * These are local overrides for various environment variables in Emacs.
 411  * Please do not remove this and leave it at the end of the file, where
 412  * Emacs will automagically detect them.
 413  * ---------------------------------------------------------------------
 414  * Local variables:
 415  * mode: c
 416  * indent-tabs-mode: t
 417  * c-basic-offset: 4
 418  * tab-width: 4
 419  * End:
 420  */