src/vm/builtin.h

   1 /* src/vm/builtin.h - prototypes of builtin functions
   2
   3    Copyright (C) 1996-2005, 2006, 2007 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 */
  26
  27
  28 #ifndef _BUILTIN_H
  29 #define _BUILTIN_H
  30
  31 /* forward typedefs ***********************************************************/
  32
  33 typedef struct builtintable_entry builtintable_entry;
  34
  35 #include "config.h"
  36 #include "vm/types.h"
  37
  38 #include "arch.h"
  39 #include "md-abi.h"
  40
  41 #include "toolbox/logging.h"
  42
  43 #include "vmcore/utf8.h"
  44
  45
  46 /* define infinity for floating point numbers */
  47
  48 #define FLT_NAN     0x7fc00000
  49 #define FLT_POSINF  0x7f800000
  50 #define FLT_NEGINF  0xff800000
  51
  52 /* define infinity for double floating point numbers */
  53
  54 #define DBL_NAN     0x7ff8000000000000LL
  55 #define DBL_POSINF  0x7ff0000000000000LL
  56 #define DBL_NEGINF  0xfff0000000000000LL
  57
  58
  59 /* float versions are not defined in GNU classpath's fdlibm */
  60
  61 #define copysignf    copysign
  62 #define finitef      finite
  63 #define fmodf        fmod
  64 #define isnanf       isnan
  65
  66
  67 /* builtin functions table ****************************************************/
  68
  69 struct builtintable_entry {
  70         s4           opcode;                /* opcode which is replaced           */
  71         u4           flags;                 /* e.g. check for exception           */
  72         functionptr  fp;                    /* function pointer of builtin        */
  73         u1          *stub;                  /* pointer to builtin stub code       */
  74         char        *cclassname;            /* char name of the class             */
  75         char        *cname;                 /* char name of the function          */
  76         char        *cdescriptor;           /* char name of the descriptor        */
  77         utf         *classname;             /* class of the function              */
  78         utf         *name;                  /* name of the function               */
  79         utf         *descriptor;            /* descriptor of the function         */
  80         methoddesc  *md;
  81 };
  82
  83
  84 /* builtin table flag defines *************************************************/
  85
  86 #define BUILTINTABLE_FLAG_STUB         0x0001 /* builtin needs a stub         */
  87 #define BUILTINTABLE_FLAG_EXCEPTION    0x0002 /* check for excepion on return */
  88
  89
  90 /* function prototypes ********************************************************/
  91
  92 bool builtin_init(void);
  93
  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 builtin_desc table in jit/jit.c.
 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 s4 builtin_instanceof(java_handle_t *obj, classinfo *class);
 126 /* NOT AN OP */
 127 s4 builtin_checkcast(java_handle_t *obj, classinfo *class);
 128 /* NOT AN OP */
 129 s4 builtin_arrayinstanceof(java_handle_t *h, classinfo *targetclass);
 130 /* NOT AN OP */
 131 s4 builtin_fast_arrayinstanceof(java_object_t *o, classinfo *targetclass);
 132 #define BUILTIN_arrayinstanceof (functionptr) builtin_fast_arrayinstanceof
 133 s4 builtin_fast_arraycheckcast(java_object_t *o, classinfo *targetclass);
 134 #define BUILTIN_arraycheckcast (functionptr) builtin_fast_arraycheckcast
 135
 136 s4 builtin_canstore(java_handle_objectarray_t *oa, java_handle_t *o);
 137 /* NOT AN OP */
 138 s4 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
 144 java_handle_t *builtin_new(classinfo *c);
 145 /* NOT AN OP */
 146 java_handle_t *builtin_java_new(java_handle_t *c);
 147 #define BUILTIN_new (functionptr) builtin_java_new
 148 java_object_t *builtin_fast_new(classinfo *c);
 149 #define BUILTIN_FAST_new (functionptr) builtin_fast_new
 150
 151 java_handle_t *builtin_newarray(s4 size, classinfo *arrayclass);
 152 /* NOT AN OP */
 153 java_handle_t *builtin_java_newarray(s4 size, java_handle_t *arrayclass);
 154 #define BUILTIN_newarray (functionptr) builtin_java_newarray
 155
 156 java_handle_objectarray_t *builtin_anewarray(s4 size, classinfo *componentclass);
 157 /* NOT AN OP */
 158
 159 java_handle_booleanarray_t *builtin_newarray_boolean(s4 size);
 160 #define BUILTIN_newarray_boolean (functionptr) builtin_newarray_boolean
 161 java_handle_chararray_t *builtin_newarray_char(s4 size);
 162 #define BUILTIN_newarray_char (functionptr) builtin_newarray_char
 163 java_handle_floatarray_t *builtin_newarray_float(s4 size);
 164 #define BUILTIN_newarray_float (functionptr) builtin_newarray_float
 165 java_handle_doublearray_t *builtin_newarray_double(s4 size);
 166 #define BUILTIN_newarray_double (functionptr) builtin_newarray_double
 167 java_handle_bytearray_t *builtin_newarray_byte(s4 size);
 168 #define BUILTIN_newarray_byte (functionptr) builtin_newarray_byte
 169 java_handle_shortarray_t *builtin_newarray_short(s4 size);
 170 #define BUILTIN_newarray_short (functionptr) builtin_newarray_short
 171 java_handle_intarray_t *builtin_newarray_int(s4 size);
 172 #define BUILTIN_newarray_int (functionptr) builtin_newarray_int
 173 java_handle_longarray_t *builtin_newarray_long(s4 size);
 174 #define BUILTIN_newarray_long (functionptr) builtin_newarray_long
 175
 176 java_handle_objectarray_t *builtin_multianewarray(int n,
 177                                                                                                   java_handle_t *arrayclass,
 178                                                                                                   long *dims);
 179 #define BUILTIN_multianewarray (functionptr) builtin_multianewarray
 180
 181 #if defined(TRACE_ARGS_NUM)
 182 void builtin_verbosecall_enter(s8 a0, s8 a1,
 183 # if TRACE_ARGS_NUM >= 4
 184                                                            s8 a2, s8 a3,
 185 # endif
 186 # if TRACE_ARGS_NUM >= 6
 187                                                            s8 a4, s8 a5,
 188 # endif
 189 # if TRACE_ARGS_NUM == 8
 190                                                            s8 a6, s8 a7,
 191 # endif
 192                                                            methodinfo *m);
 193 /* NOT AN OP */
 194 #endif /* defined(TRACE_ARGS_NUM) */
 195
 196 void builtin_verbosecall_exit(s8 l, double d, float f, methodinfo *m);
 197 /* NOT AN OP */
 198
 199 s4 builtin_idiv(s4 a, s4 b);
 200 #define BUILTIN_idiv (functionptr) builtin_idiv
 201 s4 builtin_irem(s4 a, s4 b);
 202 #define BUILTIN_irem (functionptr) builtin_irem
 203
 204 s8 builtin_ladd(s8 a, s8 b);
 205 #define BUILTIN_ladd (functionptr) builtin_ladd
 206 s8 builtin_lsub(s8 a, s8 b);
 207 #define BUILTIN_lsub (functionptr) builtin_lsub
 208 s8 builtin_lmul(s8 a, s8 b);
 209 #define BUILTIN_lmul (functionptr) builtin_lmul
 210
 211 s8 builtin_ldiv(s8 a, s8 b);
 212 #define BUILTIN_ldiv (functionptr) builtin_ldiv
 213 s8 builtin_lrem(s8 a, s8 b);
 214 #define BUILTIN_lrem (functionptr) builtin_lrem
 215
 216 s8 builtin_lshl(s8 a, s4 b);
 217 #define BUILTIN_lshl (functionptr) builtin_lshl
 218 s8 builtin_lshr(s8 a, s4 b);
 219 #define BUILTIN_lshr (functionptr) builtin_lshr
 220 s8 builtin_lushr(s8 a, s4 b);
 221 #define BUILTIN_lushr (functionptr) builtin_lushr
 222 s8 builtin_land(s8 a, s8 b);
 223 #define BUILTIN_land (functionptr) builtin_land
 224 s8 builtin_lor(s8 a, s8 b);
 225 #define BUILTIN_lor (functionptr) builtin_lor
 226 s8 builtin_lxor(s8 a, s8 b);
 227 #define BUILTIN_lxor (functionptr) builtin_lxor
 228 s8 builtin_lneg(s8 a);
 229 #define BUILTIN_lneg (functionptr) builtin_lneg
 230 s4 builtin_lcmp(s8 a, s8 b);
 231 #define BUILTIN_lcmp (functionptr) builtin_lcmp
 232
 233 float builtin_fadd(float a, float b);
 234 #define BUILTIN_fadd (functionptr) builtin_fadd
 235 float builtin_fsub(float a, float b);
 236 #define BUILTIN_fsub (functionptr) builtin_fsub
 237 float builtin_fmul(float a, float b);
 238 #define BUILTIN_fmul (functionptr) builtin_fmul
 239 float builtin_fdiv(float a, float b);
 240 #define BUILTIN_fdiv (functionptr) builtin_fdiv
 241 float builtin_fneg(float a);
 242 #define BUILTIN_fneg (functionptr) builtin_fneg
 243 s4 builtin_fcmpl(float a, float b);
 244 #define BUILTIN_fcmpl (functionptr) builtin_fcmpl
 245 s4 builtin_fcmpg(float a, float b);
 246 #define BUILTIN_fcmpg (functionptr) builtin_fcmpg
 247 float builtin_frem(float a, float b);
 248 #define BUILTIN_frem (functionptr) builtin_frem
 249
 250 double builtin_dadd(double a, double b);
 251 #define BUILTIN_dadd (functionptr) builtin_dadd
 252 double builtin_dsub(double a, double b);
 253 #define BUILTIN_dsub (functionptr) builtin_dsub
 254 double builtin_dmul(double a, double b);
 255 #define BUILTIN_dmul (functionptr) builtin_dmul
 256 double builtin_ddiv(double a, double b);
 257 #define BUILTIN_ddiv (functionptr) builtin_ddiv
 258 double builtin_dneg(double a);
 259 #define BUILTIN_dneg (functionptr) builtin_dneg
 260 s4 builtin_dcmpl(double a, double b);
 261 #define BUILTIN_dcmpl (functionptr) builtin_dcmpl
 262 s4 builtin_dcmpg(double a, double b);
 263 #define BUILTIN_dcmpg (functionptr) builtin_dcmpg
 264 double builtin_drem(double a, double b);
 265 #define BUILTIN_drem (functionptr) builtin_drem
 266
 267 s8       builtin_i2l(s4 i);
 268 /* NOT AN OP */
 269 float    builtin_i2f(s4 i);
 270 #define BUILTIN_i2f (functionptr) builtin_i2f
 271 double   builtin_i2d(s4 i);
 272 #define BUILTIN_i2d (functionptr) builtin_i2d
 273 s4       builtin_l2i(s8 l);
 274 /* NOT AN OP */
 275 float    builtin_l2f(s8 l);
 276 #define BUILTIN_l2f (functionptr) builtin_l2f
 277 double   builtin_l2d(s8 l);
 278 #define BUILTIN_l2d (functionptr) builtin_l2d
 279
 280 s4       builtin_f2i(float a);
 281 #define BUILTIN_f2i (functionptr) builtin_f2i
 282 s4       asm_builtin_f2i(float a);
 283 /* NOT AN OP */
 284 s8       builtin_f2l(float a);
 285 #define BUILTIN_f2l (functionptr) builtin_f2l
 286 s8       asm_builtin_f2l(float a);
 287 /* NOT AN OP */
 288
 289 double   builtin_f2d(float a);
 290 #define BUILTIN_f2d (functionptr) builtin_f2d
 291
 292 s4       builtin_d2i(double a);
 293 #define BUILTIN_d2i (functionptr) builtin_d2i
 294 s4       asm_builtin_d2i(double a);
 295 /* NOT AN OP */
 296 s8       builtin_d2l(double a);
 297 #define BUILTIN_d2l (functionptr) builtin_d2l
 298 s8       asm_builtin_d2l(double a);
 299 /* NOT AN OP */
 300
 301 float    builtin_d2f(double a);
 302 #define BUILTIN_d2f (functionptr) builtin_d2f
 303
 304 java_handle_t *builtin_clone(void *env, java_handle_t *o);
 305 #define BUILTIN_clone (functionptr) builtin_clone
 306
 307 void builtin_arraycopy(java_handle_t *src, s4 srcStart,
 308                                            java_handle_t *dest, s4 destStart, s4 len);
 309 #define BUILTIN_arraycopy (functionptr) builtin_arraycopy
 310
 311 s8 builtin_nanotime(void);
 312 s8 builtin_currenttimemillis(void);
 313 #define BUILTIN_currenttimemillis (functionptr) builtin_currenttimemillis
 314
 315 #if defined(ENABLE_CYCLES_STATS)
 316 void builtin_print_cycles_stats(FILE *file);
 317 #endif
 318
 319 #endif /* _BUILTIN_H */
 320
 321
 322 /*
 323  * These are local overrides for various environment variables in Emacs.
 324  * Please do not remove this and leave it at the end of the file, where
 325  * Emacs will automagically detect them.
 326  * ---------------------------------------------------------------------
 327  * Local variables:
 328  * mode: c
 329  * indent-tabs-mode: t
 330  * c-basic-offset: 4
 331  * tab-width: 4
 332  * End:
 333  * vim:noexpandtab:sw=4:ts=4:
 334  */