* Removed all Id tags.
[cacao.git] / src / vm / builtin.h
index 111b8cc7c966f4106fcf6fab7858651022c564b7..677f7313445a57364e37bd31e04c423855e57d2e 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.
-
-   Contact: cacao@complang.tuwien.ac.at
-
-   Authors: Reinhard Grafl
-
-   Changes: Edwin Steiner
-
-   $Id: builtin.h 1067 2004-05-18 10:25:51Z stefan $
+   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+   02110-1301, USA.
 
 */
 
 #define _BUILTIN_H
 
 #include "config.h"
+#include "vm/types.h"
+
+#include "arch.h"
+#include "md-abi.h"
+
 #include "toolbox/logging.h"
-#include "threads/thread.h"
+
+#include "vmcore/utf8.h"
 
 
 /* define infinity for floating point numbers */
@@ -54,7 +52,7 @@
 #define DBL_NEGINF  0xfff0000000000000LL
 
 
-/* float versions are not defined in gnu classpath's fdlibm */
+/* float versions are not defined in GNU classpath's fdlibm */
 
 #define copysignf    copysign
 #define finitef      finite
 #define isnanf       isnan
 
 
-/**********************************************************************/
-/* BUILTIN FUNCTIONS TABLE                                            */
-/**********************************************************************/
+/* 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.
- */
-typedef struct builtin_descriptor builtin_descriptor;
+typedef struct builtintable_entry builtintable_entry;
 
-/* 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     */
+struct builtintable_entry {
+       s4           opcode;                /* opcode which is replaced           */
+       functionptr  fp;                    /* function pointer of builtin        */
+       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         */
+       bool         checkexception;        /* check for exception after return   */
+       methoddesc  *md;
 };
 
-extern builtin_descriptor builtin_desc[];
 
-/**********************************************************************/
-/* GLOBAL VARIABLES                                                   */
-/**********************************************************************/
-
-#define THREADSPECIFIC
-#define exceptionptr (&_exceptionptr)
-#define threadrootmethod (&_threadrootmethod)
+/* function prototypes ********************************************************/
 
-#if defined(USE_THREADS) && defined(NATIVE_THREADS)
-#ifdef HAVE___THREAD
+bool builtin_init(void);
 
-#undef THREADSPECIFIC
-#define THREADSPECIFIC __thread
+builtintable_entry *builtintable_get_internal(functionptr fp);
+builtintable_entry *builtintable_get_automatic(s4 opcode);
 
-#endif
-
-#undef exceptionptr
-#undef threadrootmethod
-#define exceptionptr builtin_get_exceptionptrptr()
-#define threadrootmethod  builtin_get_threadrootmethod()
-#endif
-
-#if !defined(USE_THREADS) || !defined(NATIVE_THREADS)
-extern java_objectheader *_exceptionptr;
-extern methodinfo* _threadrootmethod;
-#endif
+bool builtintable_replace_function(void *iptr);
 
 
 /**********************************************************************/
@@ -147,115 +113,78 @@ extern methodinfo* _threadrootmethod;
  * ICMD_BUILTIN3.)
  */
 
-s4 builtin_instanceof(java_objectheader *obj, classinfo *class);
+s4 builtin_instanceof(java_handle_t *obj, classinfo *class);
 #define BUILTIN_instanceof (functionptr) builtin_instanceof
-s4 builtin_isanysubclass (classinfo *sub, classinfo *super);
-/* NOT AN OP */
-s4 builtin_isanysubclass_vftbl (vftbl *sub, vftbl *super);
-/* NOT AN OP */
-s4 builtin_checkcast(java_objectheader *obj, classinfo *class);
+s4 builtin_checkcast(java_handle_t *obj, classinfo *class);
 /* NOT AN OP */
-s4 builtin_arrayinstanceof(java_objectheader *obj, vftbl *target);
+s4 builtin_arrayinstanceof(java_handle_t *o, classinfo *targetclass);
 #define BUILTIN_arrayinstanceof (functionptr) builtin_arrayinstanceof
+s4 builtin_arraycheckcast(java_handle_t *o, classinfo *targetclass);
+#define BUILTIN_arraycheckcast (functionptr) builtin_arraycheckcast
 
-#if defined(__I386__)
-s4 asm_builtin_arrayinstanceof(java_objectheader *obj, classinfo *class); /* XXX ? */
-#undef  BUILTIN_arrayinstanceof
-#define BUILTIN_arrayinstanceof (functionptr) asm_builtin_arrayinstanceof
-#endif
-
-s4 builtin_checkarraycast(java_objectheader *obj, vftbl *target);
-/* NOT AN OP */
-s4 asm_builtin_checkarraycast(java_objectheader *obj, vftbl *target);
-#define BUILTIN_checkarraycast (functionptr) asm_builtin_checkarraycast
-
-java_objectheader *builtin_throw_exception(java_objectheader *exception);
+void *builtin_throw_exception(java_handle_t *exception);
 /* NOT AN OP */
-java_objectheader *builtin_trace_exception(java_objectheader *_exceptionptr,
-                                                                                  methodinfo *method, 
-                                                                                  int *pos, int line, int noindent);
+java_handle_t *builtin_trace_exception(java_handle_t *xptr,
+                                                                                  methodinfo *m,
+                                                                                  void *pos,
+                                                                                  s4 indent);
 /* NOT AN OP */
 
-static inline java_objectheader **builtin_get_exceptionptrptr();
-/* NOT AN OP */
-static inline methodinfo **builtin_get_threadrootmethod();
-/* NOT AN OP */
-
-java_objectheader *builtin_new(classinfo *c);
-#ifdef __I386__
-java_objectheader *asm_builtin_new(classinfo *c);
-#define BUILTIN_new (functionptr) asm_builtin_new
-#else
+java_handle_t *builtin_new(classinfo *c);
 #define BUILTIN_new (functionptr) builtin_new
-#endif
 
-java_arrayheader *builtin_newarray(s4 size, vftbl *arrayvftbl);
+java_handle_t *builtin_newarray(s4 size, classinfo *arrayclass);
 #define BUILTIN_newarray (functionptr) builtin_newarray
-java_objectarray *builtin_anewarray(s4 size, classinfo *component);
-/* NOT AN OP */
 
-#if defined(__I386__)
-void asm_builtin_newarray(s4 size, vftbl *arrayvftbl);
-#undef  BUILTIN_newarray
-#define BUILTIN_newarray (functionptr) asm_builtin_newarray
-#endif
+java_handle_objectarray_t *builtin_anewarray(s4 size, classinfo *componentclass);
+#define BUILTIN_anewarray (functionptr) builtin_anewarray
 
-java_booleanarray *builtin_newarray_boolean(s4 size);
+java_handle_booleanarray_t *builtin_newarray_boolean(s4 size);
 #define BUILTIN_newarray_boolean (functionptr) builtin_newarray_boolean
-java_chararray *builtin_newarray_char(s4 size);
+java_handle_chararray_t *builtin_newarray_char(s4 size);
 #define BUILTIN_newarray_char (functionptr) builtin_newarray_char
-java_floatarray *builtin_newarray_float(s4 size);
+java_handle_floatarray_t *builtin_newarray_float(s4 size);
 #define BUILTIN_newarray_float (functionptr) builtin_newarray_float
-java_doublearray *builtin_newarray_double(s4 size);
+java_handle_doublearray_t *builtin_newarray_double(s4 size);
 #define BUILTIN_newarray_double (functionptr) builtin_newarray_double
-java_bytearray *builtin_newarray_byte(s4 size);
+java_handle_bytearray_t *builtin_newarray_byte(s4 size);
 #define BUILTIN_newarray_byte (functionptr) builtin_newarray_byte
-java_shortarray *builtin_newarray_short(s4 size);
+java_handle_shortarray_t *builtin_newarray_short(s4 size);
 #define BUILTIN_newarray_short (functionptr) builtin_newarray_short
-java_intarray *builtin_newarray_int(s4 size);
+java_handle_intarray_t *builtin_newarray_int(s4 size);
 #define BUILTIN_newarray_int (functionptr) builtin_newarray_int
-java_longarray *builtin_newarray_long(s4 size);
+java_handle_longarray_t *builtin_newarray_long(s4 size);
 #define BUILTIN_newarray_long (functionptr) builtin_newarray_long
-java_arrayheader *builtin_nmultianewarray(int n, vftbl *arrayvftbl, long *dims);
-/*  java_arrayheader *builtin_nmultianewarray(int n, classinfo *arrayclass, 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, classinfo *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);
-/* NOT AN OP */
-void builtin_displaymethodstop(methodinfo *method, s8 l, double d, float f);
-/* NOT AN OP */
+s4 builtin_canstore(java_handle_objectarray_t *oa, java_handle_t *o);
+#define BUILTIN_canstore (functionptr) builtin_canstore
 
-void builtin_monitorenter(java_objectheader *o);
+#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 */
-void asm_builtin_monitorenter(java_objectheader *o);
-#define BUILTIN_monitorenter (functionptr) asm_builtin_monitorenter
-void builtin_monitorexit(java_objectheader *o);
+#endif /* defined(TRACE_ARGS_NUM) */
+
+void builtin_verbosecall_exit(s8 l, double d, float f, methodinfo *m);
 /* 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
@@ -263,14 +192,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);
@@ -289,36 +216,36 @@ s4 builtin_lcmp(s8 a, s8 b);
 #define BUILTIN_lcmp (functionptr) builtin_lcmp
 
 float builtin_fadd(float a, float b);
-/* NOT AN OP */
+#define BUILTIN_fadd (functionptr) builtin_fadd
 float builtin_fsub(float a, float b);
-/* NOT AN OP */
+#define BUILTIN_fsub (functionptr) builtin_fsub
 float builtin_fmul(float a, float b);
-/* NOT AN OP */
+#define BUILTIN_fmul (functionptr) builtin_fmul
 float builtin_fdiv(float a, float b);
-/* NOT AN OP */
+#define BUILTIN_fdiv (functionptr) builtin_fdiv
 float builtin_fneg(float a);         
-/* NOT AN OP */
+#define BUILTIN_fneg (functionptr) builtin_fneg
 s4 builtin_fcmpl(float a, float b);  
-/* NOT AN OP */
+#define BUILTIN_fcmpl (functionptr) builtin_fcmpl
 s4 builtin_fcmpg(float a, float b);  
-/* NOT AN OP */
+#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);
-/* NOT AN OP */
+#define BUILTIN_dadd (functionptr) builtin_dadd
 double builtin_dsub(double a, double b);
-/* NOT AN OP */
+#define BUILTIN_dsub (functionptr) builtin_dsub
 double builtin_dmul(double a, double b);
-/* NOT AN OP */
+#define BUILTIN_dmul (functionptr) builtin_dmul
 double builtin_ddiv(double a, double b);
-/* NOT AN OP */
+#define BUILTIN_ddiv (functionptr) builtin_ddiv
 double builtin_dneg(double a);          
-/* NOT AN OP */
+#define BUILTIN_dneg (functionptr) builtin_dneg
 s4 builtin_dcmpl(double a, double b);   
-/* NOT AN OP */
+#define BUILTIN_dcmpl (functionptr) builtin_dcmpl
 s4 builtin_dcmpg(double a, double b);   
-/* NOT AN OP */
+#define BUILTIN_dcmpg (functionptr) builtin_dcmpg
 double builtin_drem(double a, double b);
 #define BUILTIN_drem (functionptr) builtin_drem
 
@@ -345,7 +272,7 @@ s8       asm_builtin_f2l(float a);
 /* NOT AN OP */
 
 double   builtin_f2d(float a);
-/* NOT AN OP */
+#define BUILTIN_f2d (functionptr) builtin_f2d
 
 s4       builtin_d2i(double a);
 #define BUILTIN_d2i (functionptr) builtin_d2i
@@ -357,58 +284,23 @@ s8       asm_builtin_d2l(double a);
 /* NOT AN OP */
 
 float    builtin_d2f(double a);
-/* NOT AN OP */
-
-java_arrayheader *builtin_clone_array(void *env, java_arrayheader *o);
-/* NOT AN OP */
+#define BUILTIN_d2f (functionptr) builtin_d2f
 
-/* builtin_dummy just panics if it is executed. */
-s4 builtin_dummy();
-/* NOT AN OP */
+java_handle_t *builtin_clone(void *env, java_handle_t *o);
+#define BUILTIN_clone (functionptr) builtin_clone
 
-/* conversion helper functions */
-inline float intBitsToFloat(s4 i);
-inline float longBitsToDouble(s8 l);
+bool builtin_arraycopy(java_handle_t *src, s4 srcStart,
+                                          java_handle_t *dest, s4 destStart, s4 len);
+#define BUILTIN_arraycopy (functionptr) builtin_arraycopy
 
-/* this is a wrapper for calls from asmpart */
-java_objectheader **builtin_asm_get_exceptionptrptr();
+s8 builtin_nanotime(void);
+s8 builtin_currenttimemillis(void);
+#define BUILTIN_currenttimemillis (functionptr) builtin_currenttimemillis
 
-inline java_objectheader **builtin_get_exceptionptrptr()
-{
-#if defined(USE_THREADS) && defined(NATIVE_THREADS)
-       return &THREADINFO->_exceptionptr;
-#else
-    panic("builtin_get_exceptionptrptr should not be used in this configuration");
-    return NULL;
-#endif
-}
-
-inline methodinfo **builtin_get_threadrootmethod()
-{
-#if defined(USE_THREADS) && defined(NATIVE_THREADS)
-       return &THREADINFO->_threadrootmethod;
-#else
-    panic("builting_get_threadrootmethod should not be used in this configuration");
-    return NULL;
+#if defined(ENABLE_CYCLES_STATS)
+void builtin_print_cycles_stats(FILE *file);
 #endif
-}
-
-/* returns the root method of a thread. this is used in asmpart.S and delivers the abort condition
-   for the stack unwinding for getClassContext and getClassLoader. For the main thread this is the main function.
-   Otherwhise it is the thread's run method (at least that's how I see it) (jowenn) */
-methodinfo *builtin_asm_get_threadrootmethod();
-
-/* returns the current top element of the stack frame info list (needed for unwinding across native functions) */
-/* on i386 this is a pointer to a structure 
-               ------------------------------------------------
-               | return adress out of native stub              |
-               | pointer to method info                        | either i have to save an arbitrary adress within this native stub or the pointer to the method info, both are equaly costly, I have chosen the method  info (JOWENN)
-               | pointer to thread specific top of this list   |<----stack frame begin
-points here---->| previous element in list                     |
-               ------------------------------------------------
-*/
-void *builtin_asm_get_stackframeinfo();
-stacktraceelement *builtin_stacktrace_copy(stacktraceelement **,stacktraceelement *begin, stacktraceelement *end);
+
 #endif /* _BUILTIN_H */