src/vm/builtin.h

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