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