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 879 2004-01-12 13:31:56Z twisti $
  32
  33 */
  34
  35
  36 #ifndef _BUILTIN_H
  37 #define _BUILTIN_H
  38
  39 #include "config.h"
  40 #include "toolbox/loging.h"
  41
  42
  43 /* define infinity for floating point numbers */
  44
  45 #define FLT_NAN     0x7fc00000
  46 #define FLT_POSINF  0x7f800000
  47 #define FLT_NEGINF  0xff800000
  48
  49 /* define infinity for double floating point numbers */
  50
  51 #define DBL_NAN     0x7ff8000000000000LL
  52 #define DBL_POSINF  0x7ff0000000000000LL
  53 #define DBL_NEGINF  0xfff0000000000000LL
  54
  55
  56 /* float versions are not defined in gnu classpath's fdlibm */
  57
  58 #define copysignf    copysign
  59 #define finitef      finite
  60 #define fmodf        fmod
  61 #define isnanf       isnan
  62
  63
  64 /**********************************************************************/
  65 /* BUILTIN FUNCTIONS TABLE                                            */
  66 /**********************************************************************/
  67
  68 /* IMPORTANT:
  69  * For each builtin function which is used in a BUILTIN* opcode there
  70  * must be an entry in the builtin_desc table in jit/jit.c.
  71  */
  72
  73 /* XXX delete */
  74 #if 0
  75 typedef struct builtin_descriptor {
  76         functionptr bptr;
  77         char        *name;
  78         } builtin_descriptor;
  79 #endif
  80
  81 typedef struct builtin_descriptor builtin_descriptor;
  82
  83 /* There is a builtin_descriptor in builtin_desc for every builtin
  84  * function used in BUILTIN* opcodes.
  85  */
  86 struct builtin_descriptor {
  87         int         opcode;   /* opcode which is replaced by this builtin */
  88                               /* (255 means no automatic replacement,     */
  89                               /*    0 means end of list.)                 */
  90         functionptr builtin;  /* the builtin function (specify BUILTIN_...*/
  91                               /* macro)                                   */
  92         int         icmd;     /* the BUILTIN* opcode to use (# of args)   */
  93         u1          type_s1;  /* type of 1st argument                     */
  94         u1          type_s2;  /* type of 2nd argument, or TYPE_VOID       */
  95         u1          type_s3;  /* type of 3rd argument, or TYPE_VOID       */
  96         u1          type_d;   /* type of result (may be TYPE_VOID)        */
  97         bool        supported;/* is <opcode> supported without builtin?   */
  98         bool        isfloat;  /* is this a floating point operation?      */
  99         char        *name;    /* display name of the builtin function     */
 100 };
 101
 102 extern builtin_descriptor builtin_desc[];
 103
 104 /**********************************************************************/
 105 /* GLOBAL VARIABLES                                                   */
 106 /**********************************************************************/
 107
 108 #define THREADSPECIFIC
 109 #define exceptionptr (&_exceptionptr)
 110
 111 #if defined(USE_THREADS) && defined(NATIVE_THREADS)
 112 #ifdef HAVE___THREAD
 113
 114 #undef THREADSPECIFIC
 115 #define THREADSPECIFIC __thread
 116
 117 #else
 118
 119 #undef exceptionptr
 120 #define exceptionptr builtin_get_exceptionptrptr()
 121
 122 #endif
 123 #endif
 124
 125 extern THREADSPECIFIC java_objectheader* _exceptionptr;
 126
 127
 128 /**********************************************************************/
 129 /* BUILTIN FUNCTIONS                                                  */
 130 /**********************************************************************/
 131
 132 /* NOTE: Builtin functions which are used in the BUILTIN* opcodes must
 133  * have a BUILTIN_... macro defined as seen below. In code dealing
 134  * with the BUILTIN* opcodes the functions may only be addressed by
 135  * these macros, never by their actual name! (This helps to make this
 136  * code more portable.)
 137  *
 138  * C and assembler code which does not deal with the BUILTIN* opcodes,
 139  * can use the builtin functions normally (like all other functions).
 140  *
 141  * IMPORTANT:
 142  * For each builtin function which is used in a BUILTIN* opcode there
 143  * must be an entry in the builtin_desc table in jit/jit.c.
 144  *
 145  * Below each prototype is either the BUILTIN_ macro definition or a
 146  * comment specifiying that this function is not used in BUILTIN*
 147  * opcodes.
 148  *
 149  * (The BUILTIN* opcodes are ICMD_BUILTIN1, ICMD_BUILTIN2 and
 150  * ICMD_BUILTIN3.)
 151  */
 152
 153 s4 builtin_instanceof(java_objectheader *obj, classinfo *class);
 154 #define BUILTIN_instanceof (functionptr) builtin_instanceof
 155 s4 builtin_isanysubclass (classinfo *sub, classinfo *super);
 156 /* NOT AN OP */
 157 s4 builtin_isanysubclass_vftbl (vftbl *sub, vftbl *super);
 158 /* NOT AN OP */
 159 s4 builtin_checkcast(java_objectheader *obj, classinfo *class);
 160 /* NOT AN OP */
 161 s4 builtin_arrayinstanceof(java_objectheader *obj, vftbl *target);
 162 #define BUILTIN_arrayinstanceof (functionptr) builtin_arrayinstanceof
 163
 164 #if defined(__I386__)
 165 s4 asm_builtin_arrayinstanceof(java_objectheader *obj, classinfo *class); /* XXX ? */
 166 #undef  BUILTIN_arrayinstanceof
 167 #define BUILTIN_arrayinstanceof (functionptr) asm_builtin_arrayinstanceof
 168 #endif
 169
 170 s4 builtin_checkarraycast(java_objectheader *obj, vftbl *target);
 171 /* NOT AN OP */
 172 s4 asm_builtin_checkarraycast(java_objectheader *obj, vftbl *target);
 173 #define BUILTIN_checkarraycast (functionptr) asm_builtin_checkarraycast
 174
 175 java_objectheader *builtin_throw_exception(java_objectheader *exception);
 176 /* NOT AN OP */
 177 java_objectheader *builtin_trace_exception(java_objectheader *_exceptionptr,
 178                                                                                    methodinfo *method,
 179                                                                                    int *pos, int noindent);
 180 /* NOT AN OP */
 181
 182 static inline java_objectheader **builtin_get_exceptionptrptr();
 183 /* NOT AN OP */
 184 void builtin_reset_exceptionptr();
 185 /* NOT AN OP */
 186
 187 java_objectheader *builtin_new(classinfo *c);
 188 #define BUILTIN_new (functionptr) builtin_new
 189
 190 java_arrayheader *builtin_newarray(s4 size, vftbl *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 *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,
 218                                           vftbl *arrayvftbl, 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 *method);
 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 *method);
 232 /* NOT AN OP */
 233 #endif
 234 #endif
 235 void builtin_displaymethodstart(methodinfo *method); /* XXX? */
 236 /* NOT AN OP */
 237 void builtin_displaymethodstop(methodinfo *method, s8 l, double d, float f);
 238 /* NOT AN OP */
 239 /* void builtin_displaymethodstop(methodinfo *method); */ /* XXX? */
 240 void builtin_displaymethodexception(methodinfo *method); /* XXX? */
 241 /* NOT AN OP */
 242
 243 void builtin_monitorenter(java_objectheader *o);
 244 /* NOT AN OP */
 245 void asm_builtin_monitorenter(java_objectheader *o);
 246 #define BUILTIN_monitorenter (functionptr) asm_builtin_monitorenter
 247 void builtin_monitorexit(java_objectheader *o);
 248 /* NOT AN OP */
 249 void asm_builtin_monitorexit(java_objectheader *o);
 250 #define BUILTIN_monitorexit (functionptr) asm_builtin_monitorexit
 251
 252 s4 builtin_idiv(s4 a, s4 b);
 253 /* NOT AN OP */
 254 s4 asm_builtin_idiv(s4 a, s4 b);
 255 #define BUILTIN_idiv (functionptr) asm_builtin_idiv
 256 s4 builtin_irem(s4 a, s4 b);
 257 /* NOT AN OP */
 258 s4 asm_builtin_irem(s4 a, s4 b);
 259 #define BUILTIN_irem (functionptr) asm_builtin_irem
 260
 261 s8 builtin_ladd(s8 a, s8 b);
 262 #define BUILTIN_ladd (functionptr) builtin_ladd
 263 s8 builtin_lsub(s8 a, s8 b);
 264 #define BUILTIN_lsub (functionptr) builtin_lsub
 265 s8 builtin_lmul(s8 a, s8 b);
 266 #define BUILTIN_lmul (functionptr) builtin_lmul
 267 s8 builtin_ldiv(s8 a, s8 b);
 268 /* NOT AN OP */
 269 s8 asm_builtin_ldiv(s8 a, s8 b);
 270 #define BUILTIN_ldiv (functionptr) asm_builtin_ldiv
 271 s8 builtin_lrem(s8 a, s8 b);
 272 /* NOT AN OP */
 273 s8 asm_builtin_lrem(s8 a, s8 b);
 274 #define BUILTIN_lrem (functionptr) asm_builtin_lrem
 275 s8 builtin_lshl(s8 a, s4 b);
 276 #define BUILTIN_lshl (functionptr) builtin_lshl
 277 s8 builtin_lshr(s8 a, s4 b);
 278 #define BUILTIN_lshr (functionptr) builtin_lshr
 279 s8 builtin_lushr(s8 a, s4 b);
 280 #define BUILTIN_lushr (functionptr) builtin_lushr
 281 s8 builtin_land(s8 a, s8 b);
 282 #define BUILTIN_land (functionptr) builtin_land
 283 s8 builtin_lor(s8 a, s8 b);
 284 #define BUILTIN_lor (functionptr) builtin_lor
 285 s8 builtin_lxor(s8 a, s8 b);
 286 #define BUILTIN_lxor (functionptr) builtin_lxor
 287 s8 builtin_lneg(s8 a);
 288 #define BUILTIN_lneg (functionptr) builtin_lneg
 289 s4 builtin_lcmp(s8 a, s8 b);
 290 #define BUILTIN_lcmp (functionptr) builtin_lcmp
 291
 292 float builtin_fadd(float a, float b); /* XXX? */
 293 /* NOT AN OP */
 294 float builtin_fsub(float a, float b); /* XXX? */
 295 /* NOT AN OP */
 296 float builtin_fmul(float a, float b); /* XXX? */
 297 /* NOT AN OP */
 298 float builtin_fdiv(float a, float b); /* XXX? */
 299 /* NOT AN OP */
 300 float builtin_fneg(float a);          /* XXX? */
 301 /* NOT AN OP */
 302 s4 builtin_fcmpl(float a, float b);   /* XXX? */
 303 /* NOT AN OP */
 304 s4 builtin_fcmpg(float a, float b);   /* XXX? */
 305 /* NOT AN OP */
 306 float builtin_frem(float a, float b);
 307 #define BUILTIN_frem (functionptr) builtin_frem
 308
 309 double builtin_dadd(double a, double b); /* XXX? */
 310 /* NOT AN OP */
 311 double builtin_dsub(double a, double b); /* XXX? */
 312 /* NOT AN OP */
 313 double builtin_dmul(double a, double b); /* XXX? */
 314 /* NOT AN OP */
 315 double builtin_ddiv(double a, double b); /* XXX? */
 316 /* NOT AN OP */
 317 double builtin_dneg(double a);           /* XXX? */
 318 /* NOT AN OP */
 319 s4 builtin_dcmpl(double a, double b);    /* XXX? */
 320 /* NOT AN OP */
 321 s4 builtin_dcmpg(double a, double b);    /* XXX? */
 322 /* NOT AN OP */
 323 double builtin_drem(double a, double b);
 324 #define BUILTIN_drem (functionptr) builtin_drem
 325
 326 s8       builtin_i2l(s4 i);
 327 /* NOT AN OP */
 328 float    builtin_i2f(s4 i);
 329 #define BUILTIN_i2f (functionptr) builtin_i2f
 330 double   builtin_i2d(s4 i);
 331 #define BUILTIN_i2d (functionptr) builtin_i2d
 332 s4       builtin_l2i(s8 l);
 333 /* NOT AN OP */
 334 float    builtin_l2f(s8 l);
 335 #define BUILTIN_l2f (functionptr) builtin_l2f
 336 double   builtin_l2d(s8 l);
 337 #define BUILTIN_l2d (functionptr) builtin_l2d
 338
 339 s4       builtin_f2i(float a);
 340 #define BUILTIN_f2i (functionptr) builtin_f2i
 341 s4       asm_builtin_f2i(float a);
 342 /* NOT AN OP */
 343 s8       builtin_f2l(float a);
 344 #define BUILTIN_f2l (functionptr) builtin_f2l
 345 s8       asm_builtin_f2l(float a);
 346 /* NOT AN OP */
 347
 348 double   builtin_f2d(float a);     /* XXX? */
 349 /* NOT AN OP */
 350
 351 s4       builtin_d2i(double a);
 352 #define BUILTIN_d2i (functionptr) builtin_d2i
 353 s4       asm_builtin_d2i(double a);
 354 /* NOT AN OP */
 355 s8       builtin_d2l(double a);
 356 #define BUILTIN_d2l (functionptr) builtin_d2l
 357 s8       asm_builtin_d2l(double a);
 358 /* NOT AN OP */
 359
 360 float    builtin_d2f(double a);    /* XXX? */
 361 /* NOT AN OP */
 362
 363 java_arrayheader *builtin_clone_array(void *env, java_arrayheader *o);
 364 /* NOT AN OP */
 365
 366 /* builtin_dummy just panics if it is executed. */
 367 s4 builtin_dummy();
 368 /* NOT AN OP */
 369
 370 /* conversion helper functions */
 371
 372 inline float intBitsToFloat(s4 i);
 373 inline float longBitsToDouble(s8 l);
 374
 375
 376 static inline java_objectheader **builtin_get_exceptionptrptr()
 377 {
 378 #if defined(USE_THREADS) && defined(NATIVE_THREADS)
 379 #ifdef HAVE___THREAD
 380     return &_exceptionptr;
 381 #else
 382     return &((nativethread*) pthread_getspecific(tkey_exceptionptr))->_exceptionptr;
 383 #endif
 384 #else
 385     panic("builtin_get_exceptionptrptr should not be used in this configuration");
 386     return NULL;
 387 #endif
 388 }
 389
 390 #endif /* _BUILTIN_H */
 391
 392
 393 /*
 394  * These are local overrides for various environment variables in Emacs.
 395  * Please do not remove this and leave it at the end of the file, where
 396  * Emacs will automagically detect them.
 397  * ---------------------------------------------------------------------
 398  * Local variables:
 399  * mode: c
 400  * indent-tabs-mode: t
 401  * c-basic-offset: 4
 402  * tab-width: 4
 403  * End:
 404  */