src/vm/builtin.h

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