src/vm/builtin.h

   1 /* builtin.h - prototypes of builtin functions
   2
   3    Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
   4    R. Grafl, A. Krall, C. Kruegel, C. Oates, R. Obermaisser,
   5    M. Probst, S. Ring, E. Steiner, C. Thalinger, D. Thuernbeck,
   6    P. Tomsich, J. Wenninger
   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
  31    $Id: builtin.h 1356 2004-07-28 10:05:07Z twisti $
  32
  33 */
  34
  35
  36 #ifndef _BUILTIN_H
  37 #define _BUILTIN_H
  38
  39 #include "config.h"
  40 #include "toolbox/logging.h"
  41 #include "threads/thread.h"
  42
  43
  44 /* define infinity for floating point numbers */
  45
  46 #define FLT_NAN     0x7fc00000
  47 #define FLT_POSINF  0x7f800000
  48 #define FLT_NEGINF  0xff800000
  49
  50 /* define infinity for double floating point numbers */
  51
  52 #define DBL_NAN     0x7ff8000000000000LL
  53 #define DBL_POSINF  0x7ff0000000000000LL
  54 #define DBL_NEGINF  0xfff0000000000000LL
  55
  56
  57 /* float versions are not defined in gnu classpath's fdlibm */
  58
  59 #define copysignf    copysign
  60 #define finitef      finite
  61 #define fmodf        fmod
  62 #define isnanf       isnan
  63
  64
  65 /**********************************************************************/
  66 /* BUILTIN FUNCTIONS TABLE                                            */
  67 /**********************************************************************/
  68
  69 /* IMPORTANT:
  70  * For each builtin function which is used in a BUILTIN* opcode there
  71  * must be an entry in the builtin_desc table in jit/jit.c.
  72  */
  73
  74 typedef struct builtin_descriptor builtin_descriptor;
  75
  76 /* There is a builtin_descriptor in builtin_desc for every builtin
  77  * function used in BUILTIN* opcodes.
  78  */
  79 struct builtin_descriptor {
  80         int         opcode;   /* opcode which is replaced by this builtin */
  81                               /* (255 means no automatic replacement,     */
  82                               /*    0 means end of list.)                 */
  83         functionptr builtin;  /* the builtin function (specify BUILTIN_...*/
  84                               /* macro)                                   */
  85         int         icmd;     /* the BUILTIN* opcode to use (# of args)   */
  86         u1          type_s1;  /* type of 1st argument                     */
  87         u1          type_s2;  /* type of 2nd argument, or TYPE_VOID       */
  88         u1          type_s3;  /* type of 3rd argument, or TYPE_VOID       */
  89         u1          type_d;   /* type of result (may be TYPE_VOID)        */
  90         bool        supported;/* is <opcode> supported without builtin?   */
  91         bool        isfloat;  /* is this a floating point operation?      */
  92         char        *name;    /* display name of the builtin function     */
  93 };
  94
  95 extern builtin_descriptor builtin_desc[];
  96
  97 /**********************************************************************/
  98 /* GLOBAL VARIABLES                                                   */
  99 /**********************************************************************/
 100
 101 #define THREADSPECIFIC
 102 #define exceptionptr (&_exceptionptr)
 103 #define threadrootmethod (&_threadrootmethod)
 104
 105 #if defined(USE_THREADS) && defined(NATIVE_THREADS)
 106 #ifdef HAVE___THREAD
 107
 108 #undef THREADSPECIFIC
 109 #define THREADSPECIFIC __thread
 110
 111 #endif
 112
 113 #undef exceptionptr
 114 #undef threadrootmethod
 115 #define exceptionptr builtin_get_exceptionptrptr()
 116 #define threadrootmethod  builtin_get_threadrootmethod()
 117 #endif
 118
 119 #if !defined(USE_THREADS) || !defined(NATIVE_THREADS)
 120 extern java_objectheader *_exceptionptr;
 121 extern methodinfo* _threadrootmethod;
 122 #endif
 123
 124
 125 /**********************************************************************/
 126 /* BUILTIN FUNCTIONS                                                  */
 127 /**********************************************************************/
 128
 129 /* NOTE: Builtin functions which are used in the BUILTIN* opcodes must
 130  * have a BUILTIN_... macro defined as seen below. In code dealing
 131  * with the BUILTIN* opcodes the functions may only be addressed by
 132  * these macros, never by their actual name! (This helps to make this
 133  * code more portable.)
 134  *
 135  * C and assembler code which does not deal with the BUILTIN* opcodes,
 136  * can use the builtin functions normally (like all other functions).
 137  *
 138  * IMPORTANT:
 139  * For each builtin function which is used in a BUILTIN* opcode there
 140  * must be an entry in the builtin_desc table in jit/jit.c.
 141  *
 142  * Below each prototype is either the BUILTIN_ macro definition or a
 143  * comment specifiying that this function is not used in BUILTIN*
 144  * opcodes.
 145  *
 146  * (The BUILTIN* opcodes are ICMD_BUILTIN1, ICMD_BUILTIN2 and
 147  * ICMD_BUILTIN3.)
 148  */
 149
 150 s4 builtin_instanceof(java_objectheader *obj, classinfo *class);
 151 #define BUILTIN_instanceof (functionptr) builtin_instanceof
 152 s4 builtin_isanysubclass (classinfo *sub, classinfo *super);
 153 /* NOT AN OP */
 154 s4 builtin_isanysubclass_vftbl (vftbl_t *sub, vftbl_t *super);
 155 /* NOT AN OP */
 156 s4 builtin_checkcast(java_objectheader *obj, classinfo *class);
 157 /* NOT AN OP */
 158 s4 builtin_arrayinstanceof(java_objectheader *obj, vftbl_t *target);
 159 #define BUILTIN_arrayinstanceof (functionptr) builtin_arrayinstanceof
 160
 161 #if defined(__I386__)
 162 s4 asm_builtin_arrayinstanceof(java_objectheader *obj, classinfo *class); /* XXX ? */
 163 #undef  BUILTIN_arrayinstanceof
 164 #define BUILTIN_arrayinstanceof (functionptr) asm_builtin_arrayinstanceof
 165 #endif
 166
 167 s4 builtin_checkarraycast(java_objectheader *obj, vftbl_t *target);
 168 /* NOT AN OP */
 169 s4 asm_builtin_checkarraycast(java_objectheader *obj, vftbl_t *target);
 170 #define BUILTIN_checkarraycast (functionptr) asm_builtin_checkarraycast
 171
 172 java_objectheader *builtin_throw_exception(java_objectheader *exception);
 173 /* NOT AN OP */
 174 java_objectheader *builtin_trace_exception(java_objectheader *xptr,
 175                                                                                    methodinfo *m,
 176                                                                                    void *pos,
 177                                                                                    s4 line,
 178                                                                                    s4 noindent);
 179 /* NOT AN OP */
 180
 181 java_objectheader *builtin_new(classinfo *c);
 182 #ifdef __I386__
 183 java_objectheader *asm_builtin_new(classinfo *c);
 184 #define BUILTIN_new (functionptr) asm_builtin_new
 185 #else
 186 #define BUILTIN_new (functionptr) builtin_new
 187 #endif
 188
 189 java_arrayheader *builtin_newarray(s4 size, vftbl_t *arrayvftbl);
 190 #define BUILTIN_newarray (functionptr) builtin_newarray
 191 java_objectarray *builtin_anewarray(s4 size, classinfo *component);
 192 /* NOT AN OP */
 193
 194 #if defined(__I386__)
 195 void asm_builtin_newarray(s4 size, vftbl_t *arrayvftbl);
 196 #undef  BUILTIN_newarray
 197 #define BUILTIN_newarray (functionptr) asm_builtin_newarray
 198 #endif
 199
 200 java_booleanarray *builtin_newarray_boolean(s4 size);
 201 #define BUILTIN_newarray_boolean (functionptr) builtin_newarray_boolean
 202 java_chararray *builtin_newarray_char(s4 size);
 203 #define BUILTIN_newarray_char (functionptr) builtin_newarray_char
 204 java_floatarray *builtin_newarray_float(s4 size);
 205 #define BUILTIN_newarray_float (functionptr) builtin_newarray_float
 206 java_doublearray *builtin_newarray_double(s4 size);
 207 #define BUILTIN_newarray_double (functionptr) builtin_newarray_double
 208 java_bytearray *builtin_newarray_byte(s4 size);
 209 #define BUILTIN_newarray_byte (functionptr) builtin_newarray_byte
 210 java_shortarray *builtin_newarray_short(s4 size);
 211 #define BUILTIN_newarray_short (functionptr) builtin_newarray_short
 212 java_intarray *builtin_newarray_int(s4 size);
 213 #define BUILTIN_newarray_int (functionptr) builtin_newarray_int
 214 java_longarray *builtin_newarray_long(s4 size);
 215 #define BUILTIN_newarray_long (functionptr) builtin_newarray_long
 216 java_arrayheader *builtin_nmultianewarray(int n, vftbl_t *arrayvftbl, long *dims);
 217 /*  java_arrayheader *builtin_nmultianewarray(int n, classinfo *arrayclass, long *dims); */
 218 /* NOT AN OP */
 219
 220 s4 builtin_canstore(java_objectarray *a, java_objectheader *o);
 221 /* NOT AN OP */
 222 void asm_builtin_aastore(java_objectarray *a, s4 index, java_objectheader *o);
 223 #define BUILTIN_aastore (functionptr) asm_builtin_aastore
 224
 225 #ifdef TRACE_ARGS_NUM
 226 #if TRACE_ARGS_NUM == 6
 227 void builtin_trace_args(s8 a0, s8 a1, s8 a2, s8 a3, s8 a4, s8 a5, methodinfo *m);
 228 /* NOT AN OP */
 229 #else
 230 void builtin_trace_args(s8 a0, s8 a1, s8 a2, s8 a3, s8 a4, s8 a5, s8 a6, s8 a7, methodinfo *m);
 231 /* NOT AN OP */
 232 #endif
 233 #endif
 234 void builtin_displaymethodstart(methodinfo *m);
 235 /* NOT AN OP */
 236 void builtin_displaymethodstop(methodinfo *m, s8 l, double d, float f);
 237 /* NOT AN OP */
 238
 239 void builtin_monitorenter(java_objectheader *o);
 240 /* NOT AN OP */
 241 void builtin_staticmonitorenter(classinfo *c);
 242 /* NOT AN OP */
 243 void asm_builtin_monitorenter(java_objectheader *o);
 244 #define BUILTIN_monitorenter (functionptr) asm_builtin_monitorenter
 245 void builtin_monitorexit(java_objectheader *o);
 246 /* NOT AN OP */
 247 void asm_builtin_monitorexit(java_objectheader *o);
 248 #define BUILTIN_monitorexit (functionptr) asm_builtin_monitorexit
 249
 250 s4 builtin_idiv(s4 a, s4 b);
 251 /* NOT AN OP */
 252 s4 asm_builtin_idiv(s4 a, s4 b);
 253 #define BUILTIN_idiv (functionptr) asm_builtin_idiv
 254 s4 builtin_irem(s4 a, s4 b);
 255 /* NOT AN OP */
 256 s4 asm_builtin_irem(s4 a, s4 b);
 257 #define BUILTIN_irem (functionptr) asm_builtin_irem
 258
 259 s8 builtin_ladd(s8 a, s8 b);
 260 #define BUILTIN_ladd (functionptr) builtin_ladd
 261 s8 builtin_lsub(s8 a, s8 b);
 262 #define BUILTIN_lsub (functionptr) builtin_lsub
 263 s8 builtin_lmul(s8 a, s8 b);
 264 #define BUILTIN_lmul (functionptr) builtin_lmul
 265 s8 builtin_ldiv(s8 a, s8 b);
 266 /* NOT AN OP */
 267 s8 asm_builtin_ldiv(s8 a, s8 b);
 268 #define BUILTIN_ldiv (functionptr) asm_builtin_ldiv
 269 s8 builtin_lrem(s8 a, s8 b);
 270 /* NOT AN OP */
 271 s8 asm_builtin_lrem(s8 a, s8 b);
 272 #define BUILTIN_lrem (functionptr) asm_builtin_lrem
 273 s8 builtin_lshl(s8 a, s4 b);
 274 #define BUILTIN_lshl (functionptr) builtin_lshl
 275 s8 builtin_lshr(s8 a, s4 b);
 276 #define BUILTIN_lshr (functionptr) builtin_lshr
 277 s8 builtin_lushr(s8 a, s4 b);
 278 #define BUILTIN_lushr (functionptr) builtin_lushr
 279 s8 builtin_land(s8 a, s8 b);
 280 #define BUILTIN_land (functionptr) builtin_land
 281 s8 builtin_lor(s8 a, s8 b);
 282 #define BUILTIN_lor (functionptr) builtin_lor
 283 s8 builtin_lxor(s8 a, s8 b);
 284 #define BUILTIN_lxor (functionptr) builtin_lxor
 285 s8 builtin_lneg(s8 a);
 286 #define BUILTIN_lneg (functionptr) builtin_lneg
 287 s4 builtin_lcmp(s8 a, s8 b);
 288 #define BUILTIN_lcmp (functionptr) builtin_lcmp
 289
 290 float builtin_fadd(float a, float b);
 291 /* NOT AN OP */
 292 float builtin_fsub(float a, float b);
 293 /* NOT AN OP */
 294 float builtin_fmul(float a, float b);
 295 /* NOT AN OP */
 296 float builtin_fdiv(float a, float b);
 297 /* NOT AN OP */
 298 float builtin_fneg(float a);
 299 /* NOT AN OP */
 300 s4 builtin_fcmpl(float a, float b);
 301 /* NOT AN OP */
 302 s4 builtin_fcmpg(float a, float b);
 303 /* NOT AN OP */
 304 float builtin_frem(float a, float b);
 305 #define BUILTIN_frem (functionptr) builtin_frem
 306
 307 double builtin_dadd(double a, double b);
 308 /* NOT AN OP */
 309 double builtin_dsub(double a, double b);
 310 /* NOT AN OP */
 311 double builtin_dmul(double a, double b);
 312 /* NOT AN OP */
 313 double builtin_ddiv(double a, double b);
 314 /* NOT AN OP */
 315 double builtin_dneg(double a);
 316 /* NOT AN OP */
 317 s4 builtin_dcmpl(double a, double b);
 318 /* NOT AN OP */
 319 s4 builtin_dcmpg(double a, double b);
 320 /* NOT AN OP */
 321 double builtin_drem(double a, double b);
 322 #define BUILTIN_drem (functionptr) builtin_drem
 323
 324 s8       builtin_i2l(s4 i);
 325 /* NOT AN OP */
 326 float    builtin_i2f(s4 i);
 327 #define BUILTIN_i2f (functionptr) builtin_i2f
 328 double   builtin_i2d(s4 i);
 329 #define BUILTIN_i2d (functionptr) builtin_i2d
 330 s4       builtin_l2i(s8 l);
 331 /* NOT AN OP */
 332 float    builtin_l2f(s8 l);
 333 #define BUILTIN_l2f (functionptr) builtin_l2f
 334 double   builtin_l2d(s8 l);
 335 #define BUILTIN_l2d (functionptr) builtin_l2d
 336
 337 s4       builtin_f2i(float a);
 338 #define BUILTIN_f2i (functionptr) builtin_f2i
 339 s4       asm_builtin_f2i(float a);
 340 /* NOT AN OP */
 341 s8       builtin_f2l(float a);
 342 #define BUILTIN_f2l (functionptr) builtin_f2l
 343 s8       asm_builtin_f2l(float a);
 344 /* NOT AN OP */
 345
 346 double   builtin_f2d(float a);
 347 /* NOT AN OP */
 348
 349 s4       builtin_d2i(double a);
 350 #define BUILTIN_d2i (functionptr) builtin_d2i
 351 s4       asm_builtin_d2i(double a);
 352 /* NOT AN OP */
 353 s8       builtin_d2l(double a);
 354 #define BUILTIN_d2l (functionptr) builtin_d2l
 355 s8       asm_builtin_d2l(double a);
 356 /* NOT AN OP */
 357
 358 float    builtin_d2f(double a);
 359 /* NOT AN OP */
 360
 361 java_arrayheader *builtin_clone_array(void *env, java_arrayheader *o);
 362 /* NOT AN OP */
 363
 364 /* builtin_dummy just panics if it is executed. */
 365 s4 builtin_dummy();
 366 /* NOT AN OP */
 367
 368 /* conversion helper functions */
 369 inline float intBitsToFloat(s4 i);
 370 inline float longBitsToDouble(s8 l);
 371
 372 /* this is a wrapper for calls from asmpart */
 373 java_objectheader **builtin_asm_get_exceptionptrptr();
 374
 375 #if defined(USE_THREADS) && defined(NATIVE_THREADS)
 376 static inline java_objectheader **builtin_get_exceptionptrptr();
 377 /* NOT AN OP */
 378 static inline methodinfo **builtin_get_threadrootmethod();
 379 /* NOT AN OP */
 380
 381 inline java_objectheader **builtin_get_exceptionptrptr()
 382 {
 383         return &THREADINFO->_exceptionptr;
 384 }
 385
 386 inline methodinfo **builtin_get_threadrootmethod()
 387 {
 388         return &THREADINFO->_threadrootmethod;
 389 }
 390 #endif
 391
 392
 393 /* returns the root method of a thread. this is used in asmpart.S and delivers the abort condition
 394    for the stack unwinding for getClassContext and getClassLoader. For the main thread this is the main function.
 395    Otherwhise it is the thread's run method (at least that's how I see it) (jowenn) */
 396 methodinfo *builtin_asm_get_threadrootmethod();
 397
 398 /* returns the current top element of the stack frame info list (needed for unwinding across native functions) */
 399 /* on i386 this is a pointer to a structure
 400                 ------------------------------------------------
 401                 | return adress out of native stub              |
 402                 | 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)
 403                 | pointer to thread specific top of this list   |<----stack frame begin
 404 points here---->| previous element in list                      |
 405                 ------------------------------------------------
 406 */
 407 void *builtin_asm_get_stackframeinfo();
 408 stacktraceelement *builtin_stacktrace_copy(stacktraceelement **,stacktraceelement *begin, stacktraceelement *end);
 409 #endif /* _BUILTIN_H */
 410
 411
 412 /*
 413  * These are local overrides for various environment variables in Emacs.
 414  * Please do not remove this and leave it at the end of the file, where
 415  * Emacs will automagically detect them.
 416  * ---------------------------------------------------------------------
 417  * Local variables:
 418  * mode: c
 419  * indent-tabs-mode: t
 420  * c-basic-offset: 4
 421  * tab-width: 4
 422  * End:
 423  */