src/vm/builtin.h

   1 /* src/vm/builtin.h - prototypes of builtin functions
   2
   3    Copyright (C) 1996-2005, 2006, 2007, 2008
   4    CACAOVM - Verein zur Foerderung der freien virtuellen Maschine CACAO
   5
   6    This file is part of CACAO.
   7
   8    This program is free software; you can redistribute it and/or
   9    modify it under the terms of the GNU General Public License as
  10    published by the Free Software Foundation; either version 2, or (at
  11    your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23 */
  24
  25
  26 #ifndef _BUILTIN_H
  27 #define _BUILTIN_H
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /* forward typedefs ***********************************************************/
  34
  35 typedef struct builtintable_entry builtintable_entry;
  36
  37 #include "config.h"
  38 #include "vm/types.h"
  39
  40 #include "arch.h"
  41 #include "md-abi.h"
  42
  43 #include "toolbox/logging.h"
  44
  45 #include "vmcore/utf8.h"
  46
  47
  48 /* define infinity for floating point numbers */
  49
  50 #define FLT_NAN     0x7fc00000
  51 #define FLT_POSINF  0x7f800000
  52 #define FLT_NEGINF  0xff800000
  53
  54 /* define infinity for double floating point numbers */
  55
  56 #define DBL_NAN     0x7ff8000000000000LL
  57 #define DBL_POSINF  0x7ff0000000000000LL
  58 #define DBL_NEGINF  0xfff0000000000000LL
  59
  60
  61 /* float versions are not defined in GNU classpath's fdlibm */
  62
  63 #define copysignf    copysign
  64 #define finitef      finite
  65 #define fmodf        fmod
  66 #define isnanf       isnan
  67
  68
  69 /* builtin functions table ****************************************************/
  70
  71 struct builtintable_entry {
  72         s4           opcode;                /* opcode which is replaced           */
  73         u4           flags;                 /* e.g. check for exception           */
  74         functionptr  fp;                    /* function pointer of builtin        */
  75         u1          *stub;                  /* pointer to builtin stub code       */
  76         char        *cclassname;            /* char name of the class             */
  77         char        *cname;                 /* char name of the function          */
  78         char        *cdescriptor;           /* char name of the descriptor        */
  79         utf         *classname;             /* class of the function              */
  80         utf         *name;                  /* name of the function               */
  81         utf         *descriptor;            /* descriptor of the function         */
  82         methoddesc  *md;
  83 };
  84
  85
  86 /* builtin table flag defines *************************************************/
  87
  88 #define BUILTINTABLE_FLAG_STUB         0x0001 /* builtin needs a stub         */
  89 #define BUILTINTABLE_FLAG_EXCEPTION    0x0002 /* check for excepion on return */
  90
  91
  92 /* function prototypes ********************************************************/
  93
  94 bool builtin_init(void);
  95
  96 builtintable_entry *builtintable_get_internal(functionptr fp);
  97 builtintable_entry *builtintable_get_automatic(s4 opcode);
  98
  99 bool builtintable_replace_function(void *iptr);
 100
 101
 102 /**********************************************************************/
 103 /* BUILTIN FUNCTIONS                                                  */
 104 /**********************************************************************/
 105
 106 /* NOTE: Builtin functions which are used in the BUILTIN* opcodes must
 107  * have a BUILTIN_... macro defined as seen below. In code dealing
 108  * with the BUILTIN* opcodes the functions may only be addressed by
 109  * these macros, never by their actual name! (This helps to make this
 110  * code more portable.)
 111  *
 112  * C and assembler code which does not deal with the BUILTIN* opcodes,
 113  * can use the builtin functions normally (like all other functions).
 114  *
 115  * IMPORTANT:
 116  * For each builtin function which is used in a BUILTIN* opcode there
 117  * must be an entry in the builtin_desc table in jit/jit.c.
 118  *
 119  * Below each prototype is either the BUILTIN_ macro definition or a
 120  * comment specifiying that this function is not used in BUILTIN*
 121  * opcodes.
 122  *
 123  * (The BUILTIN* opcodes are ICMD_BUILTIN1, ICMD_BUILTIN2 and
 124  * ICMD_BUILTIN3.)
 125  */
 126
 127 bool builtin_instanceof(java_handle_t *obj, classinfo *c);
 128 /* NOT AN OP */
 129 bool builtin_checkcast(java_handle_t *obj, classinfo *c);
 130 /* NOT AN OP */
 131 bool builtin_arrayinstanceof(java_handle_t *h, classinfo *targetclass);
 132 /* NOT AN OP */
 133 bool builtin_fast_arrayinstanceof(java_object_t *o, classinfo *targetclass);
 134 #define BUILTIN_arrayinstanceof (functionptr) builtin_fast_arrayinstanceof
 135 bool builtin_fast_arraycheckcast(java_object_t *o, classinfo *targetclass);
 136 #define BUILTIN_arraycheckcast (functionptr) builtin_fast_arraycheckcast
 137
 138 bool builtin_canstore(java_handle_objectarray_t *oa, java_handle_t *o);
 139 /* NOT AN OP */
 140 bool builtin_fast_canstore(java_objectarray_t *oa, java_object_t *o);
 141 #define BUILTIN_FAST_canstore (functionptr) builtin_fast_canstore
 142
 143 void *builtin_throw_exception(java_object_t *exception);
 144 /* NOT AN OP */
 145 java_object_t *builtin_retrieve_exception(void);
 146 /* NOT AN OP */
 147
 148 java_handle_t *builtin_new(classinfo *c);
 149 /* NOT AN OP */
 150 java_handle_t *builtin_java_new(java_handle_t *c);
 151 #define BUILTIN_new (functionptr) builtin_java_new
 152
 153 #if defined(ENABLE_TLH)
 154 #define BUILTIN_tlh_new (functionptr) builtin_tlh_new
 155 java_handle_t *builtin_tlh_new(classinfo *c);
 156 #endif
 157
 158 #if defined(ENABLE_ESCAPE_REASON)
 159 #define BUILTIN_escape_reason_new (functionptr)builtin_escape_reason_new
 160 java_handle_t *builtin_escape_reason_new(classinfo *c);
 161 #endif
 162
 163 java_object_t *builtin_fast_new(classinfo *c);
 164 #define BUILTIN_FAST_new (functionptr) builtin_fast_new
 165
 166 java_handle_t *builtin_newarray(int32_t size, classinfo *arrayclass);
 167 /* NOT AN OP */
 168 java_handle_t *builtin_java_newarray(int32_t size, java_handle_t *arrayclass);
 169 #define BUILTIN_newarray (functionptr) builtin_java_newarray
 170
 171 java_handle_objectarray_t *builtin_anewarray(int32_t size, classinfo *componentclass);
 172 /* NOT AN OP */
 173
 174 java_handle_booleanarray_t *builtin_newarray_boolean(int32_t size);
 175 #define BUILTIN_newarray_boolean (functionptr) builtin_newarray_boolean
 176 java_handle_chararray_t *builtin_newarray_char(int32_t size);
 177 #define BUILTIN_newarray_char (functionptr) builtin_newarray_char
 178 java_handle_floatarray_t *builtin_newarray_float(int32_t size);
 179 #define BUILTIN_newarray_float (functionptr) builtin_newarray_float
 180 java_handle_doublearray_t *builtin_newarray_double(int32_t size);
 181 #define BUILTIN_newarray_double (functionptr) builtin_newarray_double
 182 java_handle_bytearray_t *builtin_newarray_byte(int32_t size);
 183 #define BUILTIN_newarray_byte (functionptr) builtin_newarray_byte
 184 java_handle_shortarray_t *builtin_newarray_short(int32_t size);
 185 #define BUILTIN_newarray_short (functionptr) builtin_newarray_short
 186 java_handle_intarray_t *builtin_newarray_int(int32_t size);
 187 #define BUILTIN_newarray_int (functionptr) builtin_newarray_int
 188 java_handle_longarray_t *builtin_newarray_long(int32_t size);
 189 #define BUILTIN_newarray_long (functionptr) builtin_newarray_long
 190
 191 java_handle_objectarray_t *builtin_multianewarray(int n,
 192                                                                                                   java_handle_t *arrayclass,
 193                                                                                                   long *dims);
 194 #define BUILTIN_multianewarray (functionptr) builtin_multianewarray
 195
 196 #if defined(TRACE_ARGS_NUM)
 197 void builtin_verbosecall_enter(s8 a0, s8 a1,
 198 # if TRACE_ARGS_NUM >= 4
 199                                                            s8 a2, s8 a3,
 200 # endif
 201 # if TRACE_ARGS_NUM >= 6
 202                                                            s8 a4, s8 a5,
 203 # endif
 204 # if TRACE_ARGS_NUM == 8
 205                                                            s8 a6, s8 a7,
 206 # endif
 207                                                            methodinfo *m);
 208 /* NOT AN OP */
 209 #endif /* defined(TRACE_ARGS_NUM) */
 210
 211 void builtin_verbosecall_exit(s8 l, double d, float f, methodinfo *m);
 212 /* NOT AN OP */
 213
 214 s4 builtin_idiv(s4 a, s4 b);
 215 #define BUILTIN_idiv (functionptr) builtin_idiv
 216 s4 builtin_irem(s4 a, s4 b);
 217 #define BUILTIN_irem (functionptr) builtin_irem
 218
 219 s8 builtin_ladd(s8 a, s8 b);
 220 #define BUILTIN_ladd (functionptr) builtin_ladd
 221 s8 builtin_lsub(s8 a, s8 b);
 222 #define BUILTIN_lsub (functionptr) builtin_lsub
 223 s8 builtin_lmul(s8 a, s8 b);
 224 #define BUILTIN_lmul (functionptr) builtin_lmul
 225
 226 s8 builtin_ldiv(s8 a, s8 b);
 227 #define BUILTIN_ldiv (functionptr) builtin_ldiv
 228 s8 builtin_lrem(s8 a, s8 b);
 229 #define BUILTIN_lrem (functionptr) builtin_lrem
 230
 231 s8 builtin_lshl(s8 a, s4 b);
 232 #define BUILTIN_lshl (functionptr) builtin_lshl
 233 s8 builtin_lshr(s8 a, s4 b);
 234 #define BUILTIN_lshr (functionptr) builtin_lshr
 235 s8 builtin_lushr(s8 a, s4 b);
 236 #define BUILTIN_lushr (functionptr) builtin_lushr
 237 s8 builtin_land(s8 a, s8 b);
 238 #define BUILTIN_land (functionptr) builtin_land
 239 s8 builtin_lor(s8 a, s8 b);
 240 #define BUILTIN_lor (functionptr) builtin_lor
 241 s8 builtin_lxor(s8 a, s8 b);
 242 #define BUILTIN_lxor (functionptr) builtin_lxor
 243 s8 builtin_lneg(s8 a);
 244 #define BUILTIN_lneg (functionptr) builtin_lneg
 245 s4 builtin_lcmp(s8 a, s8 b);
 246 #define BUILTIN_lcmp (functionptr) builtin_lcmp
 247
 248 float builtin_fadd(float a, float b);
 249 #define BUILTIN_fadd (functionptr) builtin_fadd
 250 float builtin_fsub(float a, float b);
 251 #define BUILTIN_fsub (functionptr) builtin_fsub
 252 float builtin_fmul(float a, float b);
 253 #define BUILTIN_fmul (functionptr) builtin_fmul
 254 float builtin_fdiv(float a, float b);
 255 #define BUILTIN_fdiv (functionptr) builtin_fdiv
 256 float builtin_fneg(float a);
 257 #define BUILTIN_fneg (functionptr) builtin_fneg
 258 s4 builtin_fcmpl(float a, float b);
 259 #define BUILTIN_fcmpl (functionptr) builtin_fcmpl
 260 s4 builtin_fcmpg(float a, float b);
 261 #define BUILTIN_fcmpg (functionptr) builtin_fcmpg
 262 float builtin_frem(float a, float b);
 263 #define BUILTIN_frem (functionptr) builtin_frem
 264
 265 double builtin_dadd(double a, double b);
 266 #define BUILTIN_dadd (functionptr) builtin_dadd
 267 double builtin_dsub(double a, double b);
 268 #define BUILTIN_dsub (functionptr) builtin_dsub
 269 double builtin_dmul(double a, double b);
 270 #define BUILTIN_dmul (functionptr) builtin_dmul
 271 double builtin_ddiv(double a, double b);
 272 #define BUILTIN_ddiv (functionptr) builtin_ddiv
 273 double builtin_dneg(double a);
 274 #define BUILTIN_dneg (functionptr) builtin_dneg
 275 s4 builtin_dcmpl(double a, double b);
 276 #define BUILTIN_dcmpl (functionptr) builtin_dcmpl
 277 s4 builtin_dcmpg(double a, double b);
 278 #define BUILTIN_dcmpg (functionptr) builtin_dcmpg
 279 double builtin_drem(double a, double b);
 280 #define BUILTIN_drem (functionptr) builtin_drem
 281
 282 s8       builtin_i2l(s4 i);
 283 /* NOT AN OP */
 284 float    builtin_i2f(s4 i);
 285 #define BUILTIN_i2f (functionptr) builtin_i2f
 286 double   builtin_i2d(s4 i);
 287 #define BUILTIN_i2d (functionptr) builtin_i2d
 288 s4       builtin_l2i(s8 l);
 289 /* NOT AN OP */
 290 float    builtin_l2f(s8 l);
 291 #define BUILTIN_l2f (functionptr) builtin_l2f
 292 double   builtin_l2d(s8 l);
 293 #define BUILTIN_l2d (functionptr) builtin_l2d
 294
 295 s4       builtin_f2i(float a);
 296 #define BUILTIN_f2i (functionptr) builtin_f2i
 297 s4       asm_builtin_f2i(float a);
 298 /* NOT AN OP */
 299 s8       builtin_f2l(float a);
 300 #define BUILTIN_f2l (functionptr) builtin_f2l
 301 s8       asm_builtin_f2l(float a);
 302 /* NOT AN OP */
 303
 304 double   builtin_f2d(float a);
 305 #define BUILTIN_f2d (functionptr) builtin_f2d
 306
 307 s4       builtin_d2i(double a);
 308 #define BUILTIN_d2i (functionptr) builtin_d2i
 309 s4       asm_builtin_d2i(double a);
 310 /* NOT AN OP */
 311 s8       builtin_d2l(double a);
 312 #define BUILTIN_d2l (functionptr) builtin_d2l
 313 s8       asm_builtin_d2l(double a);
 314 /* NOT AN OP */
 315
 316 float    builtin_d2f(double a);
 317 #define BUILTIN_d2f (functionptr) builtin_d2f
 318
 319 java_handle_t *builtin_clone(void *env, java_handle_t *o);
 320 #define BUILTIN_clone (functionptr) builtin_clone
 321
 322 void builtin_arraycopy(java_handle_t *src, s4 srcStart,
 323                                            java_handle_t *dest, s4 destStart, s4 len);
 324 #define BUILTIN_arraycopy (functionptr) builtin_arraycopy
 325
 326 s8 builtin_nanotime(void);
 327 s8 builtin_currenttimemillis(void);
 328 #define BUILTIN_currenttimemillis (functionptr) builtin_currenttimemillis
 329
 330 #if defined(ENABLE_CYCLES_STATS)
 331 void builtin_print_cycles_stats(FILE *file);
 332 #endif
 333
 334 #ifdef __cplusplus
 335 }
 336 #endif
 337
 338 #endif /* _BUILTIN_H */
 339
 340
 341 /*
 342  * These are local overrides for various environment variables in Emacs.
 343  * Please do not remove this and leave it at the end of the file, where
 344  * Emacs will automagically detect them.
 345  * ---------------------------------------------------------------------
 346  * Local variables:
 347  * mode: c
 348  * indent-tabs-mode: t
 349  * c-basic-offset: 4
 350  * tab-width: 4
 351  * End:
 352  * vim:noexpandtab:sw=4:ts=4:
 353  */