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