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