Merged revisions 7766-7796 via svnmerge from
[cacao.git] / src / vm / builtin.h
index b08ee34528ced2bf887a64b1f1c28a78582318c2..e77ef882b0332c795a227b3bdc8d8707a867337c 100644 (file)
@@ -1,9 +1,9 @@
-/* builtin.h - prototypes of builtin functions
+/* src/vm/builtin.h - prototypes of builtin functions
 
-   Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
-   R. Grafl, A. Krall, C. Kruegel, C. Oates, R. Obermaisser,
-   M. Probst, S. Ring, E. Steiner, C. Thalinger, D. Thuernbeck,
-   P. Tomsich, J. Wenninger
+   Copyright (C) 1996-2005, 2006, 2007 R. Grafl, A. Krall, C. Kruegel,
+   C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
+   E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
+   J. Wenninger, Institut f. Computersprachen - TU Wien
 
    This file is part of CACAO.
 
 
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
-   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
-   02111-1307, USA.
+   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+   02110-1301, USA.
 
-   Contact: cacao@complang.tuwien.ac.at
-
-   Authors: Reinhard Grafl
-
-   $Id: builtin.h 716 2003-12-07 21:59:12Z twisti $
+   $Id: builtin.h 7797 2007-04-23 20:12:39Z michi $
 
 */
 
 #ifndef _BUILTIN_H
 #define _BUILTIN_H
 
+#include "config.h"
+#include "vm/types.h"
+
+#include "arch.h"
+#include "md-abi.h"
+
+#include "toolbox/logging.h"
+
+#include "vmcore/utf8.h"
+
 
 /* define infinity for floating point numbers */
 
 #define DBL_NEGINF  0xfff0000000000000LL
 
 
-typedef struct builtin_descriptor {
-       functionptr bptr;
-       char        *name;
-       } builtin_descriptor;
+/* float versions are not defined in GNU classpath's fdlibm */
 
-extern builtin_descriptor builtin_desc[];
-extern java_objectheader* exceptionptr;
+#define copysignf    copysign
+#define finitef      finite
+#define fmodf        fmod
+#define isnanf       isnan
 
 
-/* function prototypes */
+/* builtin functions table ****************************************************/
 
-s4 builtin_instanceof(java_objectheader *obj, classinfo *class);
-s4 builtin_isanysubclass (classinfo *sub, classinfo *super);
-s4 builtin_isanysubclass_vftbl (vftbl *sub, vftbl *super);
-s4 builtin_checkcast(java_objectheader *obj, classinfo *class);
-s4 asm_builtin_checkcast(java_objectheader *obj, classinfo *class);
+typedef struct builtintable_entry builtintable_entry;
 
-s4 builtin_arrayinstanceof(java_objectheader *obj, vftbl *target);
-#if defined(__I386__)
-s4 asm_builtin_arrayinstanceof(java_objectheader *obj, classinfo *class); /* XXX ? */
-#endif
-s4 builtin_checkarraycast(java_objectheader *obj, vftbl *target);
-s4 asm_builtin_checkarraycast(java_objectheader *obj, vftbl *target);
+struct builtintable_entry {
+       s4           opcode;                /* opcode which is replaced           */
+       u4           flags;                 /* e.g. check for exception           */
+       functionptr  fp;                    /* function pointer of builtin        */
+       u1          *stub;                  /* pointer to builtin stub code       */
+       char        *cclassname;            /* char name of the class             */
+       char        *cname;                 /* char name of the function          */
+       char        *cdescriptor;           /* char name of the descriptor        */
+       utf         *classname;             /* class of the function              */
+       utf         *name;                  /* name of the function               */
+       utf         *descriptor;            /* descriptor of the function         */
+       methoddesc  *md;
+};
+
+
+/* builtin table flag defines *************************************************/
+
+#define BUILTINTABLE_FLAG_STUB         0x0001 /* builtin needs a stub         */
+#define BUILTINTABLE_FLAG_EXCEPTION    0x0002 /* check for excepion on return */
+
+
+/* function prototypes ********************************************************/
+
+bool builtin_init(void);
+
+builtintable_entry *builtintable_get_internal(functionptr fp);
+builtintable_entry *builtintable_get_automatic(s4 opcode);
 
-java_objectheader *builtin_throw_exception(java_objectheader *exception);
-java_objectheader *builtin_trace_exception(java_objectheader *exceptionptr,
-                                                                                  methodinfo *method, 
-                                                                                  int *pos, int noindent);
+bool builtintable_replace_function(void *iptr);
+
+
+/**********************************************************************/
+/* BUILTIN FUNCTIONS                                                  */
+/**********************************************************************/
+
+/* NOTE: Builtin functions which are used in the BUILTIN* opcodes must
+ * have a BUILTIN_... macro defined as seen below. In code dealing
+ * with the BUILTIN* opcodes the functions may only be addressed by
+ * these macros, never by their actual name! (This helps to make this
+ * code more portable.)
+ *
+ * C and assembler code which does not deal with the BUILTIN* opcodes,
+ * can use the builtin functions normally (like all other functions).
+ *
+ * IMPORTANT:
+ * For each builtin function which is used in a BUILTIN* opcode there
+ * must be an entry in the builtin_desc table in jit/jit.c.
+ *
+ * Below each prototype is either the BUILTIN_ macro definition or a
+ * comment specifiying that this function is not used in BUILTIN*
+ * opcodes.
+ *
+ * (The BUILTIN* opcodes are ICMD_BUILTIN1, ICMD_BUILTIN2 and
+ * ICMD_BUILTIN3.)
+ */
+
+s4 builtin_instanceof(java_objectheader *obj, classinfo *class);
+#define BUILTIN_instanceof (functionptr) builtin_instanceof
+s4 builtin_checkcast(java_objectheader *obj, classinfo *class);
+/* NOT AN OP */
+s4 builtin_arrayinstanceof(java_objectheader *o, classinfo *targetclass);
+#define BUILTIN_arrayinstanceof (functionptr) builtin_arrayinstanceof
+s4 builtin_arraycheckcast(java_objectheader *o, classinfo *targetclass);
+#define BUILTIN_arraycheckcast (functionptr) builtin_arraycheckcast
+
+void *builtin_throw_exception(java_objectheader *exception);
+/* NOT AN OP */
+java_objectheader *builtin_trace_exception(java_objectheader *xptr,
+                                                                                  methodinfo *m,
+                                                                                  void *pos,
+                                                                                  s4 indent);
+/* NOT AN OP */
 
 java_objectheader *builtin_new(classinfo *c);
+#define BUILTIN_new (functionptr) builtin_new
+java_objectheader *builtin_fast_new(classinfo *c);
+#define BUILTIN_FAST_new (functionptr) builtin_fast_new
 
+java_arrayheader *builtin_newarray(s4 size, classinfo *arrayclass);
+#define BUILTIN_newarray (functionptr) builtin_newarray
+
+java_objectarray *builtin_anewarray(s4 size, classinfo *componentclass);
+#define BUILTIN_anewarray (functionptr) builtin_anewarray
 
-java_arrayheader *builtin_newarray(s4 size, vftbl *arrayvftbl);
-java_objectarray *builtin_anewarray(s4 size, classinfo *component);
-#if defined(__I386__)
-void asm_builtin_newarray(s4 size, vftbl *arrayvftbl);
-#endif
 java_booleanarray *builtin_newarray_boolean(s4 size);
+#define BUILTIN_newarray_boolean (functionptr) builtin_newarray_boolean
 java_chararray *builtin_newarray_char(s4 size);
+#define BUILTIN_newarray_char (functionptr) builtin_newarray_char
 java_floatarray *builtin_newarray_float(s4 size);
+#define BUILTIN_newarray_float (functionptr) builtin_newarray_float
 java_doublearray *builtin_newarray_double(s4 size);
+#define BUILTIN_newarray_double (functionptr) builtin_newarray_double
 java_bytearray *builtin_newarray_byte(s4 size);
+#define BUILTIN_newarray_byte (functionptr) builtin_newarray_byte
 java_shortarray *builtin_newarray_short(s4 size);
+#define BUILTIN_newarray_short (functionptr) builtin_newarray_short
 java_intarray *builtin_newarray_int(s4 size);
+#define BUILTIN_newarray_int (functionptr) builtin_newarray_int
 java_longarray *builtin_newarray_long(s4 size);
-java_arrayheader *builtin_nmultianewarray(int n,
-                                          vftbl *arrayvftbl, long *dims);
-
-s4 builtin_canstore(java_objectarray *a, java_objectheader *o);
-void asm_builtin_aastore(java_objectarray *a, s4 index, java_objectheader *o);
-
-#ifdef TRACE_ARGS_NUM
-#if TRACE_ARGS_NUM == 6
-void builtin_trace_args(s8 a0, s8 a1, s8 a2, s8 a3, s8 a4, s8 a5, methodinfo *method);
-#else
-void builtin_trace_args(s8 a0, s8 a1, s8 a2, s8 a3, s8 a4, s8 a5, s8 a6, s8 a7, methodinfo *method);
-#endif
-#endif
-void builtin_displaymethodstart(methodinfo *method);
-void builtin_displaymethodstop(methodinfo *method, s8 l, double d, float f);
-/* void builtin_displaymethodstop(methodinfo *method); */
-void builtin_displaymethodexception(methodinfo *method);
-
-void builtin_monitorenter(java_objectheader *o);
-void asm_builtin_monitorenter(java_objectheader *o);
-void builtin_monitorexit(java_objectheader *o);
-void asm_builtin_monitorexit(java_objectheader *o);
-
-s4 builtin_idiv(s4 a, s4 b); 
-s4 asm_builtin_idiv(s4 a, s4 b); 
+#define BUILTIN_newarray_long (functionptr) builtin_newarray_long
+
+java_arrayheader *builtin_multianewarray(int n, classinfo *arrayclass,
+                                                                                long *dims);
+#define BUILTIN_multianewarray (functionptr) builtin_multianewarray
+
+s4 builtin_canstore(java_objectarray *oa, java_objectheader *o);
+#define BUILTIN_canstore (functionptr) builtin_canstore
+
+#if defined(TRACE_ARGS_NUM)
+void builtin_verbosecall_enter(s8 a0, s8 a1,
+# if TRACE_ARGS_NUM >= 4
+                                                          s8 a2, s8 a3,
+# endif
+# if TRACE_ARGS_NUM >= 6
+                                                          s8 a4, s8 a5,
+# endif
+# if TRACE_ARGS_NUM == 8
+                                                          s8 a6, s8 a7,
+# endif
+                                                          methodinfo *m);
+/* NOT AN OP */
+#endif /* defined(TRACE_ARGS_NUM) */
+
+void builtin_verbosecall_exit(s8 l, double d, float f, methodinfo *m);
+/* NOT AN OP */
+
+s4 builtin_idiv(s4 a, s4 b);
+#define BUILTIN_idiv (functionptr) builtin_idiv
 s4 builtin_irem(s4 a, s4 b);
-s4 asm_builtin_irem(s4 a, s4 b);
+#define BUILTIN_irem (functionptr) builtin_irem
 
 s8 builtin_ladd(s8 a, s8 b);
+#define BUILTIN_ladd (functionptr) builtin_ladd
 s8 builtin_lsub(s8 a, s8 b);
+#define BUILTIN_lsub (functionptr) builtin_lsub
 s8 builtin_lmul(s8 a, s8 b);
+#define BUILTIN_lmul (functionptr) builtin_lmul
+
 s8 builtin_ldiv(s8 a, s8 b);
-s8 asm_builtin_ldiv(s8 a, s8 b);
+#define BUILTIN_ldiv (functionptr) builtin_ldiv
 s8 builtin_lrem(s8 a, s8 b);
-s8 asm_builtin_lrem(s8 a, s8 b);
+#define BUILTIN_lrem (functionptr) builtin_lrem
+
 s8 builtin_lshl(s8 a, s4 b);
+#define BUILTIN_lshl (functionptr) builtin_lshl
 s8 builtin_lshr(s8 a, s4 b);
+#define BUILTIN_lshr (functionptr) builtin_lshr
 s8 builtin_lushr(s8 a, s4 b);
+#define BUILTIN_lushr (functionptr) builtin_lushr
 s8 builtin_land(s8 a, s8 b);
+#define BUILTIN_land (functionptr) builtin_land
 s8 builtin_lor(s8 a, s8 b);
+#define BUILTIN_lor (functionptr) builtin_lor
 s8 builtin_lxor(s8 a, s8 b);
+#define BUILTIN_lxor (functionptr) builtin_lxor
 s8 builtin_lneg(s8 a);
+#define BUILTIN_lneg (functionptr) builtin_lneg
 s4 builtin_lcmp(s8 a, s8 b);
+#define BUILTIN_lcmp (functionptr) builtin_lcmp
 
 float builtin_fadd(float a, float b);
+#define BUILTIN_fadd (functionptr) builtin_fadd
 float builtin_fsub(float a, float b);
+#define BUILTIN_fsub (functionptr) builtin_fsub
 float builtin_fmul(float a, float b);
+#define BUILTIN_fmul (functionptr) builtin_fmul
 float builtin_fdiv(float a, float b);
+#define BUILTIN_fdiv (functionptr) builtin_fdiv
+float builtin_fneg(float a);         
+#define BUILTIN_fneg (functionptr) builtin_fneg
+s4 builtin_fcmpl(float a, float b);  
+#define BUILTIN_fcmpl (functionptr) builtin_fcmpl
+s4 builtin_fcmpg(float a, float b);  
+#define BUILTIN_fcmpg (functionptr) builtin_fcmpg
 float builtin_frem(float a, float b);
-float builtin_fneg(float a);
-s4 builtin_fcmpl(float a, float b);
-s4 builtin_fcmpg(float a, float b);
+#define BUILTIN_frem (functionptr) builtin_frem
 
 double builtin_dadd(double a, double b);
+#define BUILTIN_dadd (functionptr) builtin_dadd
 double builtin_dsub(double a, double b);
+#define BUILTIN_dsub (functionptr) builtin_dsub
 double builtin_dmul(double a, double b);
+#define BUILTIN_dmul (functionptr) builtin_dmul
 double builtin_ddiv(double a, double b);
+#define BUILTIN_ddiv (functionptr) builtin_ddiv
+double builtin_dneg(double a);          
+#define BUILTIN_dneg (functionptr) builtin_dneg
+s4 builtin_dcmpl(double a, double b);   
+#define BUILTIN_dcmpl (functionptr) builtin_dcmpl
+s4 builtin_dcmpg(double a, double b);   
+#define BUILTIN_dcmpg (functionptr) builtin_dcmpg
 double builtin_drem(double a, double b);
-double builtin_dneg(double a);
-s4 builtin_dcmpl(double a, double b);
-s4 builtin_dcmpg(double a, double b);
+#define BUILTIN_drem (functionptr) builtin_drem
 
 s8       builtin_i2l(s4 i);
+/* NOT AN OP */
 float    builtin_i2f(s4 i);
+#define BUILTIN_i2f (functionptr) builtin_i2f
 double   builtin_i2d(s4 i);
+#define BUILTIN_i2d (functionptr) builtin_i2d
 s4       builtin_l2i(s8 l);
+/* NOT AN OP */
 float    builtin_l2f(s8 l);
+#define BUILTIN_l2f (functionptr) builtin_l2f
 double   builtin_l2d(s8 l);
+#define BUILTIN_l2d (functionptr) builtin_l2d
 
 s4       builtin_f2i(float a);
+#define BUILTIN_f2i (functionptr) builtin_f2i
 s4       asm_builtin_f2i(float a);
+/* NOT AN OP */
 s8       builtin_f2l(float a);
+#define BUILTIN_f2l (functionptr) builtin_f2l
 s8       asm_builtin_f2l(float a);
+/* NOT AN OP */
 
 double   builtin_f2d(float a);
+#define BUILTIN_f2d (functionptr) builtin_f2d
 
 s4       builtin_d2i(double a);
+#define BUILTIN_d2i (functionptr) builtin_d2i
 s4       asm_builtin_d2i(double a);
+/* NOT AN OP */
 s8       builtin_d2l(double a);
+#define BUILTIN_d2l (functionptr) builtin_d2l
 s8       asm_builtin_d2l(double a);
+/* NOT AN OP */
 
 float    builtin_d2f(double a);
+#define BUILTIN_d2f (functionptr) builtin_d2f
 
+java_objectheader *builtin_clone(void *env, java_objectheader *o);
+#define BUILTIN_clone (functionptr) builtin_clone
 
-/* conversion helper functions */
+bool builtin_arraycopy(java_arrayheader *src, s4 srcStart,
+                                          java_arrayheader *dest, s4 destStart, s4 len);
+#define BUILTIN_arraycopy (functionptr) builtin_arraycopy
 
-inline float intBitsToFloat(s4 i);
-inline float longBitsToDouble(s8 l);
+s8 builtin_currenttimemillis(void);
+#define BUILTIN_currenttimemillis (functionptr) builtin_currenttimemillis
 
-java_arrayheader *builtin_clone_array(void *env, java_arrayheader *o);
+#if defined(ENABLE_CYCLES_STATS)
+void builtin_print_cycles_stats(FILE *file);
+#endif
 
 #endif /* _BUILTIN_H */