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