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 890 2004-01-19 12:24:13Z edwin $
  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 typedef struct builtin_descriptor builtin_descriptor;
  74
  75 /* There is a builtin_descriptor in builtin_desc for every builtin
  76  * function used in BUILTIN* opcodes.
  77  */
  78 struct builtin_descriptor {
  79         int         opcode;   /* opcode which is replaced by this builtin */
  80                               /* (255 means no automatic replacement,     */
  81                               /*    0 means end of list.)                 */
  82         functionptr builtin;  /* the builtin function (specify BUILTIN_...*/
  83                               /* macro)                                   */
  84         int         icmd;     /* the BUILTIN* opcode to use (# of args)   */
  85         u1          type_s1;  /* type of 1st argument                     */
  86         u1          type_s2;  /* type of 2nd argument, or TYPE_VOID       */
  87         u1          type_s3;  /* type of 3rd argument, or TYPE_VOID       */
  88         u1          type_d;   /* type of result (may be TYPE_VOID)        */
  89         bool        supported;/* is <opcode> supported without builtin?   */
  90         bool        isfloat;  /* is this a floating point operation?      */
  91         char        *name;    /* display name of the builtin function     */
  92 };
  93
  94 extern builtin_descriptor builtin_desc[];
  95
  96 /**********************************************************************/
  97 /* GLOBAL VARIABLES                                                   */
  98 /**********************************************************************/
  99
 100 #define THREADSPECIFIC
 101 #define exceptionptr (&_exceptionptr)
 102
 103 #if defined(USE_THREADS) && defined(NATIVE_THREADS)
 104 #ifdef HAVE___THREAD
 105
 106 #undef THREADSPECIFIC
 107 #define THREADSPECIFIC __thread
 108
 109 #else
 110
 111 #undef exceptionptr
 112 #define exceptionptr builtin_get_exceptionptrptr()
 113
 114 #endif
 115 #endif
 116
 117 extern THREADSPECIFIC java_objectheader* _exceptionptr;
 118
 119
 120 /**********************************************************************/
 121 /* BUILTIN FUNCTIONS                                                  */
 122 /**********************************************************************/
 123
 124 /* NOTE: Builtin functions which are used in the BUILTIN* opcodes must
 125  * have a BUILTIN_... macro defined as seen below. In code dealing
 126  * with the BUILTIN* opcodes the functions may only be addressed by
 127  * these macros, never by their actual name! (This helps to make this
 128  * code more portable.)
 129  *
 130  * C and assembler code which does not deal with the BUILTIN* opcodes,
 131  * can use the builtin functions normally (like all other functions).
 132  *
 133  * IMPORTANT:
 134  * For each builtin function which is used in a BUILTIN* opcode there
 135  * must be an entry in the builtin_desc table in jit/jit.c.
 136  *
 137  * Below each prototype is either the BUILTIN_ macro definition or a
 138  * comment specifiying that this function is not used in BUILTIN*
 139  * opcodes.
 140  *
 141  * (The BUILTIN* opcodes are ICMD_BUILTIN1, ICMD_BUILTIN2 and
 142  * ICMD_BUILTIN3.)
 143  */
 144
 145 s4 builtin_instanceof(java_objectheader *obj, classinfo *class);
 146 #define BUILTIN_instanceof (functionptr) builtin_instanceof
 147 s4 builtin_isanysubclass (classinfo *sub, classinfo *super);
 148 /* NOT AN OP */
 149 s4 builtin_isanysubclass_vftbl (vftbl *sub, vftbl *super);
 150 /* NOT AN OP */
 151 s4 builtin_checkcast(java_objectheader *obj, classinfo *class);
 152 /* NOT AN OP */
 153 s4 builtin_arrayinstanceof(java_objectheader *obj, vftbl *target);
 154 #define BUILTIN_arrayinstanceof (functionptr) builtin_arrayinstanceof
 155
 156 #if defined(__I386__)
 157 s4 asm_builtin_arrayinstanceof(java_objectheader *obj, classinfo *class); /* XXX ? */
 158 #undef  BUILTIN_arrayinstanceof
 159 #define BUILTIN_arrayinstanceof (functionptr) asm_builtin_arrayinstanceof
 160 #endif
 161
 162 s4 builtin_checkarraycast(java_objectheader *obj, vftbl *target);
 163 /* NOT AN OP */
 164 s4 asm_builtin_checkarraycast(java_objectheader *obj, vftbl *target);
 165 #define BUILTIN_checkarraycast (functionptr) asm_builtin_checkarraycast
 166
 167 java_objectheader *builtin_throw_exception(java_objectheader *exception);
 168 /* NOT AN OP */
 169 java_objectheader *builtin_trace_exception(java_objectheader *_exceptionptr,
 170                                                                                    methodinfo *method,
 171                                                                                    int *pos, int noindent);
 172 /* NOT AN OP */
 173
 174 static inline java_objectheader **builtin_get_exceptionptrptr();
 175 /* NOT AN OP */
 176 void builtin_reset_exceptionptr();
 177 /* NOT AN OP */
 178
 179 java_objectheader *builtin_new(classinfo *c);
 180 #define BUILTIN_new (functionptr) builtin_new
 181
 182 java_arrayheader *builtin_newarray(s4 size, vftbl *arrayvftbl);
 183 #define BUILTIN_newarray (functionptr) builtin_newarray
 184 java_objectarray *builtin_anewarray(s4 size, classinfo *component);
 185 /* NOT AN OP */
 186
 187 #if defined(__I386__)
 188 void asm_builtin_newarray(s4 size, vftbl *arrayvftbl);
 189 #undef  BUILTIN_newarray
 190 #define BUILTIN_newarray (functionptr) asm_builtin_newarray
 191 #endif
 192
 193 java_booleanarray *builtin_newarray_boolean(s4 size);
 194 #define BUILTIN_newarray_boolean (functionptr) builtin_newarray_boolean
 195 java_chararray *builtin_newarray_char(s4 size);
 196 #define BUILTIN_newarray_char (functionptr) builtin_newarray_char
 197 java_floatarray *builtin_newarray_float(s4 size);
 198 #define BUILTIN_newarray_float (functionptr) builtin_newarray_float
 199 java_doublearray *builtin_newarray_double(s4 size);
 200 #define BUILTIN_newarray_double (functionptr) builtin_newarray_double
 201 java_bytearray *builtin_newarray_byte(s4 size);
 202 #define BUILTIN_newarray_byte (functionptr) builtin_newarray_byte
 203 java_shortarray *builtin_newarray_short(s4 size);
 204 #define BUILTIN_newarray_short (functionptr) builtin_newarray_short
 205 java_intarray *builtin_newarray_int(s4 size);
 206 #define BUILTIN_newarray_int (functionptr) builtin_newarray_int
 207 java_longarray *builtin_newarray_long(s4 size);
 208 #define BUILTIN_newarray_long (functionptr) builtin_newarray_long
 209 java_arrayheader *builtin_nmultianewarray(int n,
 210                                           vftbl *arrayvftbl, long *dims);
 211 /* NOT AN OP */
 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 #ifdef TRACE_ARGS_NUM
 219 #if TRACE_ARGS_NUM == 6
 220 void builtin_trace_args(s8 a0, s8 a1, s8 a2, s8 a3, s8 a4, s8 a5, methodinfo *method);
 221 /* NOT AN OP */
 222 #else
 223 void builtin_trace_args(s8 a0, s8 a1, s8 a2, s8 a3, s8 a4, s8 a5, s8 a6, s8 a7, methodinfo *method);
 224 /* NOT AN OP */
 225 #endif
 226 #endif
 227 void builtin_displaymethodstart(methodinfo *method);
 228 /* NOT AN OP */
 229 void builtin_displaymethodstop(methodinfo *method, s8 l, double d, float f);
 230 /* NOT AN OP */
 231 /* void builtin_displaymethodstop(methodinfo *method); */
 232 void builtin_displaymethodexception(methodinfo *method);
 233 /* NOT AN OP */
 234
 235 void builtin_monitorenter(java_objectheader *o);
 236 /* NOT AN OP */
 237 void asm_builtin_monitorenter(java_objectheader *o);
 238 #define BUILTIN_monitorenter (functionptr) asm_builtin_monitorenter
 239 void builtin_monitorexit(java_objectheader *o);
 240 /* NOT AN OP */
 241 void asm_builtin_monitorexit(java_objectheader *o);
 242 #define BUILTIN_monitorexit (functionptr) asm_builtin_monitorexit
 243
 244 s4 builtin_idiv(s4 a, s4 b);
 245 /* NOT AN OP */
 246 s4 asm_builtin_idiv(s4 a, s4 b);
 247 #define BUILTIN_idiv (functionptr) asm_builtin_idiv
 248 s4 builtin_irem(s4 a, s4 b);
 249 /* NOT AN OP */
 250 s4 asm_builtin_irem(s4 a, s4 b);
 251 #define BUILTIN_irem (functionptr) asm_builtin_irem
 252
 253 s8 builtin_ladd(s8 a, s8 b);
 254 #define BUILTIN_ladd (functionptr) builtin_ladd
 255 s8 builtin_lsub(s8 a, s8 b);
 256 #define BUILTIN_lsub (functionptr) builtin_lsub
 257 s8 builtin_lmul(s8 a, s8 b);
 258 #define BUILTIN_lmul (functionptr) builtin_lmul
 259 s8 builtin_ldiv(s8 a, s8 b);
 260 /* NOT AN OP */
 261 s8 asm_builtin_ldiv(s8 a, s8 b);
 262 #define BUILTIN_ldiv (functionptr) asm_builtin_ldiv
 263 s8 builtin_lrem(s8 a, s8 b);
 264 /* NOT AN OP */
 265 s8 asm_builtin_lrem(s8 a, s8 b);
 266 #define BUILTIN_lrem (functionptr) asm_builtin_lrem
 267 s8 builtin_lshl(s8 a, s4 b);
 268 #define BUILTIN_lshl (functionptr) builtin_lshl
 269 s8 builtin_lshr(s8 a, s4 b);
 270 #define BUILTIN_lshr (functionptr) builtin_lshr
 271 s8 builtin_lushr(s8 a, s4 b);
 272 #define BUILTIN_lushr (functionptr) builtin_lushr
 273 s8 builtin_land(s8 a, s8 b);
 274 #define BUILTIN_land (functionptr) builtin_land
 275 s8 builtin_lor(s8 a, s8 b);
 276 #define BUILTIN_lor (functionptr) builtin_lor
 277 s8 builtin_lxor(s8 a, s8 b);
 278 #define BUILTIN_lxor (functionptr) builtin_lxor
 279 s8 builtin_lneg(s8 a);
 280 #define BUILTIN_lneg (functionptr) builtin_lneg
 281 s4 builtin_lcmp(s8 a, s8 b);
 282 #define BUILTIN_lcmp (functionptr) builtin_lcmp
 283
 284 float builtin_fadd(float a, float b);
 285 /* NOT AN OP */
 286 float builtin_fsub(float a, float b);
 287 /* NOT AN OP */
 288 float builtin_fmul(float a, float b);
 289 /* NOT AN OP */
 290 float builtin_fdiv(float a, float b);
 291 /* NOT AN OP */
 292 float builtin_fneg(float a);
 293 /* NOT AN OP */
 294 s4 builtin_fcmpl(float a, float b);
 295 /* NOT AN OP */
 296 s4 builtin_fcmpg(float a, float b);
 297 /* NOT AN OP */
 298 float builtin_frem(float a, float b);
 299 #define BUILTIN_frem (functionptr) builtin_frem
 300
 301 double builtin_dadd(double a, double b);
 302 /* NOT AN OP */
 303 double builtin_dsub(double a, double b);
 304 /* NOT AN OP */
 305 double builtin_dmul(double a, double b);
 306 /* NOT AN OP */
 307 double builtin_ddiv(double a, double b);
 308 /* NOT AN OP */
 309 double builtin_dneg(double a);
 310 /* NOT AN OP */
 311 s4 builtin_dcmpl(double a, double b);
 312 /* NOT AN OP */
 313 s4 builtin_dcmpg(double a, double b);
 314 /* NOT AN OP */
 315 double builtin_drem(double a, double b);
 316 #define BUILTIN_drem (functionptr) builtin_drem
 317
 318 s8       builtin_i2l(s4 i);
 319 /* NOT AN OP */
 320 float    builtin_i2f(s4 i);
 321 #define BUILTIN_i2f (functionptr) builtin_i2f
 322 double   builtin_i2d(s4 i);
 323 #define BUILTIN_i2d (functionptr) builtin_i2d
 324 s4       builtin_l2i(s8 l);
 325 /* NOT AN OP */
 326 float    builtin_l2f(s8 l);
 327 #define BUILTIN_l2f (functionptr) builtin_l2f
 328 double   builtin_l2d(s8 l);
 329 #define BUILTIN_l2d (functionptr) builtin_l2d
 330
 331 s4       builtin_f2i(float a);
 332 #define BUILTIN_f2i (functionptr) builtin_f2i
 333 s4       asm_builtin_f2i(float a);
 334 /* NOT AN OP */
 335 s8       builtin_f2l(float a);
 336 #define BUILTIN_f2l (functionptr) builtin_f2l
 337 s8       asm_builtin_f2l(float a);
 338 /* NOT AN OP */
 339
 340 double   builtin_f2d(float a);
 341 /* NOT AN OP */
 342
 343 s4       builtin_d2i(double a);
 344 #define BUILTIN_d2i (functionptr) builtin_d2i
 345 s4       asm_builtin_d2i(double a);
 346 /* NOT AN OP */
 347 s8       builtin_d2l(double a);
 348 #define BUILTIN_d2l (functionptr) builtin_d2l
 349 s8       asm_builtin_d2l(double a);
 350 /* NOT AN OP */
 351
 352 float    builtin_d2f(double a);
 353 /* NOT AN OP */
 354
 355 java_arrayheader *builtin_clone_array(void *env, java_arrayheader *o);
 356 /* NOT AN OP */
 357
 358 /* builtin_dummy just panics if it is executed. */
 359 s4 builtin_dummy();
 360 /* NOT AN OP */
 361
 362 /* conversion helper functions */
 363
 364 inline float intBitsToFloat(s4 i);
 365 inline float longBitsToDouble(s8 l);
 366
 367
 368 static inline java_objectheader **builtin_get_exceptionptrptr()
 369 {
 370 #if defined(USE_THREADS) && defined(NATIVE_THREADS)
 371 #ifdef HAVE___THREAD
 372     return &_exceptionptr;
 373 #else
 374     return &((nativethread*) pthread_getspecific(tkey_exceptionptr))->_exceptionptr;
 375 #endif
 376 #else
 377     panic("builtin_get_exceptionptrptr should not be used in this configuration");
 378     return NULL;
 379 #endif
 380 }
 381
 382 #endif /* _BUILTIN_H */
 383
 384
 385 /*
 386  * These are local overrides for various environment variables in Emacs.
 387  * Please do not remove this and leave it at the end of the file, where
 388  * Emacs will automagically detect them.
 389  * ---------------------------------------------------------------------
 390  * Local variables:
 391  * mode: c
 392  * indent-tabs-mode: t
 393  * c-basic-offset: 4
 394  * tab-width: 4
 395  * End:
 396  */