src/vm/jit/builtin.hpp

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