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