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