src/vm/builtin.h

   1 /* src/vm/builtin.h - prototypes of builtin functions
   2
   3    Copyright (C) 1996-2005, 2006 R. Grafl, A. Krall, C. Kruegel,
   4    C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
   5    E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
   6    J. Wenninger, Institut f. Computersprachen - TU Wien
   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., 51 Franklin Street, Fifth Floor, Boston, MA
  23    02110-1301, USA.
  24
  25    Contact: cacao@cacaojvm.org
  26
  27    Authors: Reinhard Grafl
  28
  29    Changes: Edwin Steiner
  30             Christian Thalinger
  31
  32    $Id: builtin.h 5308 2006-09-05 11:16:06Z edwin $
  33
  34 */
  35
  36
  37 #ifndef _BUILTIN_H
  38 #define _BUILTIN_H
  39
  40 #include "config.h"
  41
  42 #include "arch.h"
  43 #include "toolbox/logging.h"
  44
  45 #if defined(ENABLE_THREADS)
  46 # include "threads/native/threads.h"
  47 #endif
  48
  49 #include "vm/jit/stacktrace.h"
  50
  51
  52 /* define infinity for floating point numbers */
  53
  54 #define FLT_NAN     0x7fc00000
  55 #define FLT_POSINF  0x7f800000
  56 #define FLT_NEGINF  0xff800000
  57
  58 /* define infinity for double floating point numbers */
  59
  60 #define DBL_NAN     0x7ff8000000000000LL
  61 #define DBL_POSINF  0x7ff0000000000000LL
  62 #define DBL_NEGINF  0xfff0000000000000LL
  63
  64
  65 /* float versions are not defined in GNU classpath's fdlibm */
  66
  67 #define copysignf    copysign
  68 #define finitef      finite
  69 #define fmodf        fmod
  70 #define isnanf       isnan
  71
  72
  73 /* builtin functions table ****************************************************/
  74
  75 typedef struct builtintable_entry builtintable_entry;
  76
  77 struct builtintable_entry {
  78         s4           opcode;                /* opcode which is replaced           */
  79         functionptr  fp;                    /* function pointer of builtin        */
  80         char        *cclassname;            /* char name of the class             */
  81         char        *cname;                 /* char name of the function          */
  82         char        *cdescriptor;           /* char name of the descriptor        */
  83         utf         *classname;             /* class of the function              */
  84         utf         *name;                  /* name of the function               */
  85         utf         *descriptor;            /* descriptor of the function         */
  86         bool         checkexception;        /* check for exception after return   */
  87         methoddesc  *md;
  88 };
  89
  90
  91 /* function prototypes ********************************************************/
  92
  93 bool builtin_init(void);
  94
  95 builtintable_entry *builtintable_get_internal(functionptr fp);
  96 builtintable_entry *builtintable_get_automatic(s4 opcode);
  97
  98 bool builtintable_replace_function(new_instruction *iptr);
  99
 100
 101 /**********************************************************************/
 102 /* BUILTIN FUNCTIONS                                                  */
 103 /**********************************************************************/
 104
 105 /* NOTE: Builtin functions which are used in the BUILTIN* opcodes must
 106  * have a BUILTIN_... macro defined as seen below. In code dealing
 107  * with the BUILTIN* opcodes the functions may only be addressed by
 108  * these macros, never by their actual name! (This helps to make this
 109  * code more portable.)
 110  *
 111  * C and assembler code which does not deal with the BUILTIN* opcodes,
 112  * can use the builtin functions normally (like all other functions).
 113  *
 114  * IMPORTANT:
 115  * For each builtin function which is used in a BUILTIN* opcode there
 116  * must be an entry in the builtin_desc table in jit/jit.c.
 117  *
 118  * Below each prototype is either the BUILTIN_ macro definition or a
 119  * comment specifiying that this function is not used in BUILTIN*
 120  * opcodes.
 121  *
 122  * (The BUILTIN* opcodes are ICMD_BUILTIN1, ICMD_BUILTIN2 and
 123  * ICMD_BUILTIN3.)
 124  */
 125
 126 s4 builtin_instanceof(java_objectheader *obj, classinfo *class);
 127 #define BUILTIN_instanceof (functionptr) builtin_instanceof
 128 s4 builtin_isanysubclass (classinfo *sub, classinfo *super);
 129 /* NOT AN OP */
 130 s4 builtin_isanysubclass_vftbl (vftbl_t *sub, vftbl_t *super);
 131 /* NOT AN OP */
 132 s4 builtin_checkcast(java_objectheader *obj, classinfo *class);
 133 /* NOT AN OP */
 134 s4 builtin_arrayinstanceof(java_objectheader *o, classinfo *targetclass);
 135 #define BUILTIN_arrayinstanceof (functionptr) builtin_arrayinstanceof
 136 s4 builtin_arraycheckcast(java_objectheader *o, classinfo *targetclass);
 137 #define BUILTIN_arraycheckcast (functionptr) builtin_arraycheckcast
 138
 139 void *builtin_throw_exception(java_objectheader *exception);
 140 /* NOT AN OP */
 141 java_objectheader *builtin_trace_exception(java_objectheader *xptr,
 142                                                                                    methodinfo *m,
 143                                                                                    void *pos,
 144                                                                                    s4 indent);
 145 /* NOT AN OP */
 146
 147 java_objectheader *builtin_new(classinfo *c);
 148 #define BUILTIN_new (functionptr) builtin_new
 149
 150 java_arrayheader *builtin_newarray(s4 size, classinfo *arrayclass);
 151 #define BUILTIN_newarray (functionptr) builtin_newarray
 152
 153 java_objectarray *builtin_anewarray(s4 size, classinfo *componentclass);
 154 #define BUILTIN_anewarray (functionptr) builtin_anewarray
 155
 156 java_booleanarray *builtin_newarray_boolean(s4 size);
 157 #define BUILTIN_newarray_boolean (functionptr) builtin_newarray_boolean
 158 java_chararray *builtin_newarray_char(s4 size);
 159 #define BUILTIN_newarray_char (functionptr) builtin_newarray_char
 160 java_floatarray *builtin_newarray_float(s4 size);
 161 #define BUILTIN_newarray_float (functionptr) builtin_newarray_float
 162 java_doublearray *builtin_newarray_double(s4 size);
 163 #define BUILTIN_newarray_double (functionptr) builtin_newarray_double
 164 java_bytearray *builtin_newarray_byte(s4 size);
 165 #define BUILTIN_newarray_byte (functionptr) builtin_newarray_byte
 166 java_shortarray *builtin_newarray_short(s4 size);
 167 #define BUILTIN_newarray_short (functionptr) builtin_newarray_short
 168 java_intarray *builtin_newarray_int(s4 size);
 169 #define BUILTIN_newarray_int (functionptr) builtin_newarray_int
 170 java_longarray *builtin_newarray_long(s4 size);
 171 #define BUILTIN_newarray_long (functionptr) builtin_newarray_long
 172
 173 java_arrayheader *builtin_multianewarray(int n, classinfo *arrayclass,
 174                                                                                  long *dims);
 175 #define BUILTIN_multianewarray (functionptr) builtin_multianewarray
 176
 177 s4 builtin_canstore(java_objectarray *oa, java_objectheader *o);
 178 #define BUILTIN_canstore (functionptr) builtin_canstore
 179
 180 #if defined(TRACE_ARGS_NUM)
 181 void builtin_trace_args(s8 a0, s8 a1,
 182 #if TRACE_ARGS_NUM >= 4
 183                                                 s8 a2, s8 a3,
 184 #endif /* TRACE_ARGS_NUM >= 4 */
 185 #if TRACE_ARGS_NUM >= 6
 186                                                 s8 a4, s8 a5,
 187 #endif /* TRACE_ARGS_NUM >= 6 */
 188 #if TRACE_ARGS_NUM == 8
 189                                                 s8 a6, s8 a7,
 190 #endif /* TRACE_ARGS_NUM == 8 */
 191                                                 methodinfo *m);
 192 /* NOT AN OP */
 193 #endif /* defined(TRACE_ARGS_NUM) */
 194
 195 void builtin_displaymethodstop(methodinfo *m, s8 l, double d, float f);
 196 /* NOT AN OP */
 197
 198 s4 builtin_idiv(s4 a, s4 b);
 199 #define BUILTIN_idiv (functionptr) builtin_idiv
 200 s4 builtin_irem(s4 a, s4 b);
 201 #define BUILTIN_irem (functionptr) builtin_irem
 202
 203 s8 builtin_ladd(s8 a, s8 b);
 204 #define BUILTIN_ladd (functionptr) builtin_ladd
 205 s8 builtin_lsub(s8 a, s8 b);
 206 #define BUILTIN_lsub (functionptr) builtin_lsub
 207 s8 builtin_lmul(s8 a, s8 b);
 208 #define BUILTIN_lmul (functionptr) builtin_lmul
 209
 210 s8 builtin_ldiv(s8 a, s8 b);
 211 #define BUILTIN_ldiv (functionptr) builtin_ldiv
 212 s8 builtin_lrem(s8 a, s8 b);
 213 #define BUILTIN_lrem (functionptr) builtin_lrem
 214
 215 s8 builtin_lshl(s8 a, s4 b);
 216 #define BUILTIN_lshl (functionptr) builtin_lshl
 217 s8 builtin_lshr(s8 a, s4 b);
 218 #define BUILTIN_lshr (functionptr) builtin_lshr
 219 s8 builtin_lushr(s8 a, s4 b);
 220 #define BUILTIN_lushr (functionptr) builtin_lushr
 221 s8 builtin_land(s8 a, s8 b);
 222 #define BUILTIN_land (functionptr) builtin_land
 223 s8 builtin_lor(s8 a, s8 b);
 224 #define BUILTIN_lor (functionptr) builtin_lor
 225 s8 builtin_lxor(s8 a, s8 b);
 226 #define BUILTIN_lxor (functionptr) builtin_lxor
 227 s8 builtin_lneg(s8 a);
 228 #define BUILTIN_lneg (functionptr) builtin_lneg
 229 s4 builtin_lcmp(s8 a, s8 b);
 230 #define BUILTIN_lcmp (functionptr) builtin_lcmp
 231
 232 float builtin_fadd(float a, float b);
 233 #define BUILTIN_fadd (functionptr) builtin_fadd
 234 float builtin_fsub(float a, float b);
 235 #define BUILTIN_fsub (functionptr) builtin_fsub
 236 float builtin_fmul(float a, float b);
 237 #define BUILTIN_fmul (functionptr) builtin_fmul
 238 float builtin_fdiv(float a, float b);
 239 #define BUILTIN_fdiv (functionptr) builtin_fdiv
 240 float builtin_fneg(float a);
 241 #define BUILTIN_fneg (functionptr) builtin_fneg
 242 s4 builtin_fcmpl(float a, float b);
 243 #define BUILTIN_fcmpl (functionptr) builtin_fcmpl
 244 s4 builtin_fcmpg(float a, float b);
 245 #define BUILTIN_fcmpg (functionptr) builtin_fcmpg
 246 float builtin_frem(float a, float b);
 247 #define BUILTIN_frem (functionptr) builtin_frem
 248
 249 double builtin_dadd(double a, double b);
 250 #define BUILTIN_dadd (functionptr) builtin_dadd
 251 double builtin_dsub(double a, double b);
 252 #define BUILTIN_dsub (functionptr) builtin_dsub
 253 double builtin_dmul(double a, double b);
 254 #define BUILTIN_dmul (functionptr) builtin_dmul
 255 double builtin_ddiv(double a, double b);
 256 #define BUILTIN_ddiv (functionptr) builtin_ddiv
 257 double builtin_dneg(double a);
 258 #define BUILTIN_dneg (functionptr) builtin_dneg
 259 s4 builtin_dcmpl(double a, double b);
 260 #define BUILTIN_dcmpl (functionptr) builtin_dcmpl
 261 s4 builtin_dcmpg(double a, double b);
 262 #define BUILTIN_dcmpg (functionptr) builtin_dcmpg
 263 double builtin_drem(double a, double b);
 264 #define BUILTIN_drem (functionptr) builtin_drem
 265
 266 s8       builtin_i2l(s4 i);
 267 /* NOT AN OP */
 268 float    builtin_i2f(s4 i);
 269 #define BUILTIN_i2f (functionptr) builtin_i2f
 270 double   builtin_i2d(s4 i);
 271 #define BUILTIN_i2d (functionptr) builtin_i2d
 272 s4       builtin_l2i(s8 l);
 273 /* NOT AN OP */
 274 float    builtin_l2f(s8 l);
 275 #define BUILTIN_l2f (functionptr) builtin_l2f
 276 double   builtin_l2d(s8 l);
 277 #define BUILTIN_l2d (functionptr) builtin_l2d
 278
 279 s4       builtin_f2i(float a);
 280 #define BUILTIN_f2i (functionptr) builtin_f2i
 281 s4       asm_builtin_f2i(float a);
 282 /* NOT AN OP */
 283 s8       builtin_f2l(float a);
 284 #define BUILTIN_f2l (functionptr) builtin_f2l
 285 s8       asm_builtin_f2l(float a);
 286 /* NOT AN OP */
 287
 288 double   builtin_f2d(float a);
 289 #define BUILTIN_f2d (functionptr) builtin_f2d
 290
 291 s4       builtin_d2i(double a);
 292 #define BUILTIN_d2i (functionptr) builtin_d2i
 293 s4       asm_builtin_d2i(double a);
 294 /* NOT AN OP */
 295 s8       builtin_d2l(double a);
 296 #define BUILTIN_d2l (functionptr) builtin_d2l
 297 s8       asm_builtin_d2l(double a);
 298 /* NOT AN OP */
 299
 300 float    builtin_d2f(double a);
 301 #define BUILTIN_d2f (functionptr) builtin_d2f
 302
 303 java_arrayheader *builtin_clone_array(void *env, java_arrayheader *o);
 304 /* NOT AN OP */
 305
 306 bool builtin_arraycopy(java_arrayheader *src, s4 srcStart,
 307                                            java_arrayheader *dest, s4 destStart, s4 len);
 308 #define BUILTIN_arraycopy (functionptr) builtin_arraycopy
 309
 310 s8 builtin_currenttimemillis(void);
 311 #define BUILTIN_currenttimemillis (functionptr) builtin_currenttimemillis
 312
 313 #if defined(ENABLE_CYCLES_STATS)
 314 void builtin_print_cycles_stats(FILE *file);
 315 #endif
 316
 317 #endif /* _BUILTIN_H */
 318
 319
 320 /*
 321  * These are local overrides for various environment variables in Emacs.
 322  * Please do not remove this and leave it at the end of the file, where
 323  * Emacs will automagically detect them.
 324  * ---------------------------------------------------------------------
 325  * Local variables:
 326  * mode: c
 327  * indent-tabs-mode: t
 328  * c-basic-offset: 4
 329  * tab-width: 4
 330  * End:
 331  */