* merged with tip (040f180a056b)
[cacao.git] / src / vm / builtin.h
index 7af6d09d4a8a43738bfa308927726268e6e20c2f..8856520a17b60a132f6a3ba62cd981a3342d8d34 100644 (file)
@@ -1,9 +1,7 @@
-/* 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, 2008
+   CACAOVM - Verein zur Foerderung der freien virtuellen Maschine CACAO
 
    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
 
-   Changes: Edwin Steiner
+#ifndef _BUILTIN_H
+#define _BUILTIN_H
 
-   $Id: builtin.h 728 2003-12-11 11:11:05Z edwin $
+#ifdef __cplusplus
+extern "C" {
+#endif
 
-*/
+/* forward typedefs ***********************************************************/
 
+typedef struct builtintable_entry builtintable_entry;
 
-#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 "vm/descriptor.h"
+#include "vm/utf8.h"
 
 
 /* define infinity for floating point numbers */
 #define DBL_POSINF  0x7ff0000000000000LL
 #define DBL_NEGINF  0xfff0000000000000LL
 
-/**********************************************************************/
-/* BUILTIN FUNCTIONS TABLE                                            */
-/**********************************************************************/
 
-/* 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.
- */
-/* XXX delete */
-#if 0
-typedef struct builtin_descriptor {
-       functionptr bptr;
-       char        *name;
-       } builtin_descriptor;
-#endif
+/* float versions are not defined in GNU classpath's fdlibm */
 
-typedef struct builtin_descriptor builtin_descriptor;
+#define copysignf    copysign
+#define finitef      finite
+#define fmodf        fmod
+#define isnanf       isnan
 
-/* There is a builtin_descriptor in builtin_desc for every builtin
- * function used in BUILTIN* opcodes.
- */
-struct builtin_descriptor {
-       int         opcode;   /* opcode which is replaced by this builtin */
-                             /* (255 means no automatic replacement,     */
-                             /*    0 means end of list.)                 */
-       functionptr builtin;  /* the builtin function (specify BUILTIN_...*/
-                             /* macro)                                   */
-       int         icmd;     /* the BUILTIN* opcode to use (# of args)   */
-       u1          type_s1;  /* type of 1st argument                     */
-       u1          type_s2;  /* type of 2nd argument, or TYPE_VOID       */
-       u1          type_s3;  /* type of 3rd argument, or TYPE_VOID       */
-       u1          type_d;   /* type of result (may be TYPE_VOID)        */
-       bool        supported;/* is <opcode> supported without builtin?   */
-       bool        isfloat;  /* is this a floating point operation?      */
-       char        *name;    /* display name of the builtin function     */
+
+/* builtin functions table ****************************************************/
+
+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;
 };
 
-extern builtin_descriptor builtin_desc[];
 
-/**********************************************************************/
-/* GLOBAL VARIABLES                                                   */
-/**********************************************************************/
+/* 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 ********************************************************/
 
-extern java_objectheader* exceptionptr;
+bool builtin_init(void);
+
+s4                                     builtintable_get_key(builtintable_entry *);
+builtintable_entry *builtintable_get_by_key(s4 key);
+builtintable_entry *builtintable_get_internal(functionptr fp);
+builtintable_entry *builtintable_get_automatic(s4 opcode);
+
+bool builtintable_replace_function(void *iptr);
 
 
 /**********************************************************************/
@@ -111,7 +117,7 @@ extern java_objectheader* exceptionptr;
  *
  * 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.
+ * must be an entry in the tables in vm/builtintable.inc.
  *
  * Below each prototype is either the BUILTIN_ macro definition or a
  * comment specifiying that this function is not used in BUILTIN*
@@ -121,108 +127,97 @@ extern java_objectheader* exceptionptr;
  * ICMD_BUILTIN3.)
  */
 
-s4 builtin_instanceof(java_objectheader *obj, classinfo *class);
-#define BUILTIN_instanceof (functionptr) builtin_instanceof
-s4 builtin_isanysubclass (classinfo *sub, classinfo *super);
+bool builtin_instanceof(java_handle_t *obj, classinfo *c);
 /* NOT AN OP */
-s4 builtin_isanysubclass_vftbl (vftbl *sub, vftbl *super);
+bool builtin_checkcast(java_handle_t *obj, classinfo *c);
 /* NOT AN OP */
-s4 builtin_checkcast(java_objectheader *obj, classinfo *class);
+bool builtin_arrayinstanceof(java_handle_t *h, classinfo *targetclass);
 /* NOT AN OP */
-s4 builtin_arrayinstanceof(java_objectheader *obj, vftbl *target);
-#define BUILTIN_arrayinstanceof (functionptr) builtin_arrayinstanceof
-
-#if defined(__I386__)
-s4 asm_builtin_arrayinstanceof(java_objectheader *obj, classinfo *class); /* XXX ? */
-#undef  BUILTIN_arrayinstanceof
-#define BUILTIN_arrayinstanceof (functionptr) asm_builtin_arrayinstanceof
-#endif
+bool builtin_fast_arrayinstanceof(java_object_t *o, classinfo *targetclass);
+#define BUILTIN_arrayinstanceof (functionptr) builtin_fast_arrayinstanceof
+bool builtin_fast_arraycheckcast(java_object_t *o, classinfo *targetclass);
+#define BUILTIN_arraycheckcast (functionptr) builtin_fast_arraycheckcast
 
-s4 builtin_checkarraycast(java_objectheader *obj, vftbl *target);
+bool builtin_canstore(java_handle_objectarray_t *oa, java_handle_t *o);
 /* NOT AN OP */
-s4 asm_builtin_checkarraycast(java_objectheader *obj, vftbl *target);
-#define BUILTIN_checkarraycast (functionptr) asm_builtin_checkarraycast
+bool builtin_fast_canstore(java_objectarray_t *oa, java_object_t *o);
+#define BUILTIN_FAST_canstore (functionptr) builtin_fast_canstore
 
-java_objectheader *builtin_throw_exception(java_objectheader *exception);
+void *builtin_throw_exception(java_object_t *exception);
 /* NOT AN OP */
-java_objectheader *builtin_trace_exception(java_objectheader *exceptionptr,
-                                                                                  methodinfo *method, 
-                                                                                  int *pos, int noindent);
+java_object_t *builtin_retrieve_exception(void);
 /* NOT AN OP */
 
-java_objectheader *builtin_new(classinfo *c);
-#define BUILTIN_new (functionptr) builtin_new
-
-java_arrayheader *builtin_newarray(s4 size, vftbl *arrayvftbl);
-#define BUILTIN_newarray (functionptr) builtin_newarray
-java_objectarray *builtin_anewarray(s4 size, classinfo *component);
+java_handle_t *builtin_new(classinfo *c);
 /* NOT AN OP */
+java_handle_t *builtin_java_new(java_handle_t *c);
+#define BUILTIN_new (functionptr) builtin_java_new
+
+#if defined(ENABLE_TLH)
+#define BUILTIN_tlh_new (functionptr) builtin_tlh_new
+java_handle_t *builtin_tlh_new(classinfo *c);
+#endif
 
-#if defined(__I386__)
-void asm_builtin_newarray(s4 size, vftbl *arrayvftbl);
-#undef  BUILTIN_newarray
-#define BUILTIN_newarray (functionptr) asm_builtin_newarray
+#if defined(ENABLE_ESCAPE_REASON)
+#define BUILTIN_escape_reason_new (functionptr)builtin_escape_reason_new
+java_handle_t *builtin_escape_reason_new(classinfo *c);
 #endif
 
-java_booleanarray *builtin_newarray_boolean(s4 size);
+java_object_t *builtin_fast_new(classinfo *c);
+#define BUILTIN_FAST_new (functionptr) builtin_fast_new
+
+java_handle_t *builtin_newarray(int32_t size, classinfo *arrayclass);
+/* NOT AN OP */
+java_handle_t *builtin_java_newarray(int32_t size, java_handle_t *arrayclass);
+#define BUILTIN_newarray (functionptr) builtin_java_newarray
+
+java_handle_objectarray_t *builtin_anewarray(int32_t size, classinfo *componentclass);
+/* NOT AN OP */
+
+java_handle_booleanarray_t *builtin_newarray_boolean(int32_t size);
 #define BUILTIN_newarray_boolean (functionptr) builtin_newarray_boolean
-java_chararray *builtin_newarray_char(s4 size);
+java_handle_chararray_t *builtin_newarray_char(int32_t size);
 #define BUILTIN_newarray_char (functionptr) builtin_newarray_char
-java_floatarray *builtin_newarray_float(s4 size);
+java_handle_floatarray_t *builtin_newarray_float(int32_t size);
 #define BUILTIN_newarray_float (functionptr) builtin_newarray_float
-java_doublearray *builtin_newarray_double(s4 size);
+java_handle_doublearray_t *builtin_newarray_double(int32_t size);
 #define BUILTIN_newarray_double (functionptr) builtin_newarray_double
-java_bytearray *builtin_newarray_byte(s4 size);
+java_handle_bytearray_t *builtin_newarray_byte(int32_t size);
 #define BUILTIN_newarray_byte (functionptr) builtin_newarray_byte
-java_shortarray *builtin_newarray_short(s4 size);
+java_handle_shortarray_t *builtin_newarray_short(int32_t size);
 #define BUILTIN_newarray_short (functionptr) builtin_newarray_short
-java_intarray *builtin_newarray_int(s4 size);
+java_handle_intarray_t *builtin_newarray_int(int32_t size);
 #define BUILTIN_newarray_int (functionptr) builtin_newarray_int
-java_longarray *builtin_newarray_long(s4 size);
+java_handle_longarray_t *builtin_newarray_long(int32_t size);
 #define BUILTIN_newarray_long (functionptr) builtin_newarray_long
-java_arrayheader *builtin_nmultianewarray(int n,
-                                          vftbl *arrayvftbl, long *dims);
-/* NOT AN OP */
 
-s4 builtin_canstore(java_objectarray *a, java_objectheader *o);
-/* NOT AN OP */
-void asm_builtin_aastore(java_objectarray *a, s4 index, java_objectheader *o);
-#define BUILTIN_aastore (functionptr) asm_builtin_aastore
+java_handle_objectarray_t *builtin_multianewarray(int n,
+                                                                                                 java_handle_t *arrayclass,
+                                                                                                 long *dims);
+#define BUILTIN_multianewarray (functionptr) builtin_multianewarray
 
-#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);
-/* NOT AN OP */
-#else
-void builtin_trace_args(s8 a0, s8 a1, s8 a2, s8 a3, s8 a4, s8 a5, s8 a6, s8 a7, methodinfo *method);
-/* NOT AN OP */
-#endif
-#endif
-void builtin_displaymethodstart(methodinfo *method); /* XXX? */
-/* NOT AN OP */
-void builtin_displaymethodstop(methodinfo *method, s8 l, double d, float f);
-/* NOT AN OP */
-/* void builtin_displaymethodstop(methodinfo *method); */ /* XXX? */
-void builtin_displaymethodexception(methodinfo *method); /* XXX? */
+#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_monitorenter(java_objectheader *o);
+void builtin_verbosecall_exit(s8 l, double d, float f, methodinfo *m);
 /* NOT AN OP */
-void asm_builtin_monitorenter(java_objectheader *o);
-#define BUILTIN_monitorenter (functionptr) asm_builtin_monitorenter
-void builtin_monitorexit(java_objectheader *o);
-/* NOT AN OP */
-void asm_builtin_monitorexit(java_objectheader *o);
-#define BUILTIN_monitorexit (functionptr) asm_builtin_monitorexit
 
 s4 builtin_idiv(s4 a, s4 b);
-/* NOT AN OP */
-s4 asm_builtin_idiv(s4 a, s4 b);
-#define BUILTIN_idiv (functionptr) asm_builtin_idiv
+#define BUILTIN_idiv (functionptr) builtin_idiv
 s4 builtin_irem(s4 a, s4 b);
-/* NOT AN OP */
-s4 asm_builtin_irem(s4 a, s4 b);
-#define BUILTIN_irem (functionptr) asm_builtin_irem
+#define BUILTIN_irem (functionptr) builtin_irem
 
 s8 builtin_ladd(s8 a, s8 b);
 #define BUILTIN_ladd (functionptr) builtin_ladd
@@ -230,14 +225,12 @@ 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);
-/* NOT AN OP */
-s8 asm_builtin_ldiv(s8 a, s8 b);
-#define BUILTIN_ldiv (functionptr) asm_builtin_ldiv
+#define BUILTIN_ldiv (functionptr) builtin_ldiv
 s8 builtin_lrem(s8 a, s8 b);
-/* NOT AN OP */
-s8 asm_builtin_lrem(s8 a, s8 b);
-#define BUILTIN_lrem (functionptr) asm_builtin_lrem
+#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);
@@ -255,37 +248,37 @@ s8 builtin_lneg(s8 a);
 s4 builtin_lcmp(s8 a, s8 b);
 #define BUILTIN_lcmp (functionptr) builtin_lcmp
 
-float builtin_fadd(float a, float b); /* XXX? */
-/* NOT AN OP */
-float builtin_fsub(float a, float b); /* XXX? */
-/* NOT AN OP */
-float builtin_fmul(float a, float b); /* XXX? */
-/* NOT AN OP */
-float builtin_fdiv(float a, float b); /* XXX? */
-/* NOT AN OP */
-float builtin_fneg(float a);          /* XXX? */
-/* NOT AN OP */
-s4 builtin_fcmpl(float a, float b);   /* XXX? */
-/* NOT AN OP */
-s4 builtin_fcmpg(float a, float b);   /* XXX? */
-/* NOT AN OP */
+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);
 #define BUILTIN_frem (functionptr) builtin_frem
 
-double builtin_dadd(double a, double b); /* XXX? */
-/* NOT AN OP */
-double builtin_dsub(double a, double b); /* XXX? */
-/* NOT AN OP */
-double builtin_dmul(double a, double b); /* XXX? */
-/* NOT AN OP */
-double builtin_ddiv(double a, double b); /* XXX? */
-/* NOT AN OP */
-double builtin_dneg(double a);           /* XXX? */ 
-/* NOT AN OP */
-s4 builtin_dcmpl(double a, double b);    /* XXX? */
-/* NOT AN OP */
-s4 builtin_dcmpg(double a, double b);    /* XXX? */
-/* NOT AN OP */
+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);
 #define BUILTIN_drem (functionptr) builtin_drem
 
@@ -311,8 +304,8 @@ s8       builtin_f2l(float a);
 s8       asm_builtin_f2l(float a);
 /* NOT AN OP */
 
-double   builtin_f2d(float a);     /* XXX? */
-/* 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
@@ -323,16 +316,27 @@ s8       builtin_d2l(double a);
 s8       asm_builtin_d2l(double a);
 /* NOT AN OP */
 
-float    builtin_d2f(double a);    /* XXX? */
-/* NOT AN OP */
+float    builtin_d2f(double a);
+#define BUILTIN_d2f (functionptr) builtin_d2f
 
-java_arrayheader *builtin_clone_array(void *env, java_arrayheader *o);
-/* NOT AN OP */
+java_handle_t *builtin_clone(void *env, java_handle_t *o);
+#define BUILTIN_clone (functionptr) builtin_clone
 
-/* conversion helper functions */
+void builtin_arraycopy(java_handle_t *src, s4 srcStart,
+                                          java_handle_t *dest, s4 destStart, s4 len);
+#define BUILTIN_arraycopy (functionptr) builtin_arraycopy
 
-inline float intBitsToFloat(s4 i);
-inline float longBitsToDouble(s8 l);
+s8 builtin_nanotime(void);
+s8 builtin_currenttimemillis(void);
+#define BUILTIN_currenttimemillis (functionptr) builtin_currenttimemillis
+
+#if defined(ENABLE_CYCLES_STATS)
+void builtin_print_cycles_stats(FILE *file);
+#endif
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif /* _BUILTIN_H */
 
@@ -348,4 +352,5 @@ inline float longBitsToDouble(s8 l);
  * c-basic-offset: 4
  * tab-width: 4
  * End:
+ * vim:noexpandtab:sw=4:ts=4:
  */