* renamed CACAO_TYPECHECK to ENABLE_VERIFIER
[cacao.git] / src / vm / loader.h
index 56341ea76fa8afc9f74cb4096d09a0817b1a080b..1bd005f6f4202717d9f451e974a366fb4d6ec44a 100644 (file)
@@ -1,9 +1,9 @@
-/* loader.h - class loader header
+/* src/vm/loader.h - class loader header
 
-   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 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.
 
@@ -26,7 +26,7 @@
 
    Authors: Reinhard Grafl
 
-   $Id: loader.h 1557 2004-11-22 12:01:16Z carolyn $
+   $Id: loader.h 3501 2005-10-26 20:27:15Z twisti $
 */
 
 
 
 #include <stdio.h>
 
-#ifdef USE_ZLIB
-#include "unzip.h"
+
+/* forward typedefs ***********************************************************/
+
+typedef struct classbuffer classbuffer;
+typedef struct classpath_info classpath_info;
+
+
+#include "vm/global.h"
+#include "vm/utf8.h"
+#include "vm/references.h"
+#include "vm/descriptor.h"
+#include "vm/method.h"
+
+#if defined(USE_ZLIB)
+# include "vm/unzip.h"
 #endif
 
 
-/* datastruture from a classfile */
+/* signed suck defines ********************************************************/
 
-typedef struct classbuffer {
-       classinfo *class;                   /* pointer to classinfo structure     */
-       u1 *data;                           /* pointer to byte code               */
-       s4 size;                            /* size of the byte code              */
-       u1 *pos;                            /* current read position              */
-} classbuffer;
+#define suck_s8(a)    (s8) suck_u8((a))
+#define suck_s2(a)    (s2) suck_u2((a))
+#define suck_s4(a)    (s4) suck_u4((a))
+#define suck_s1(a)    (s1) suck_u1((a))
 
 
-/* export variables */
+/* constant pool entries *******************************************************
 
-#ifdef USE_THREADS
-extern int blockInts;
-#endif
+       All constant pool entries need a data structure which contain the entrys
+       value. In some cases this structure exist already, in the remaining cases
+       this structure must be generated:
 
+               kind                      structure                     generated?
+       ----------------------------------------------------------------------
+    CONSTANT_Class               classinfo                           no   XXX this will change
+    CONSTANT_Fieldref            constant_FMIref                    yes
+    CONSTANT_Methodref           constant_FMIref                    yes
+    CONSTANT_InterfaceMethodref  constant_FMIref                    yes
+    CONSTANT_String              unicode                             no
+    CONSTANT_Integer             constant_integer                   yes
+    CONSTANT_Float               constant_float                     yes
+    CONSTANT_Long                constant_long                      yes
+    CONSTANT_Double              constant_double                    yes
+    CONSTANT_NameAndType         constant_nameandtype               yes
+    CONSTANT_Utf8                unicode                             no
+    CONSTANT_UNUSED              -
 
-/* references to some system classes ******************************************/
+*******************************************************************************/
 
-extern classinfo *class_java_lang_Object;
-extern classinfo *class_java_lang_String;
-extern classinfo *class_java_lang_Cloneable;
-extern classinfo *class_java_io_Serializable;
-extern utf *utf_fillInStackTrace_name;
-extern utf *utf_fillInStackTrace_desc;
+typedef struct {            /* Integer                                        */
+       s4 value;
+} constant_integer;
 
-/* pseudo classes for the type checker ****************************************/
+       
+typedef struct {            /* Float                                          */
+       float value;
+} constant_float;
 
-/*
- * pseudo_class_Arraystub
- *     (extends Object implements Cloneable, java.io.Serializable)
- *
- *     If two arrays of incompatible component types are merged,
- *     the resulting reference has no accessible components.
- *     The result does, however, implement the interfaces Cloneable
- *     and java.io.Serializable. This pseudo class is used internally
- *     to represent such results. (They are *not* considered arrays!)
- *
- * pseudo_class_Null
- *
- *     This pseudo class is used internally to represent the
- *     null type.
- *
- * pseudo_class_New
- *
- *     This pseudo class is used internally to represent the
- *     the 'uninitialized object' type.
- */
 
-extern classinfo *pseudo_class_Arraystub;
-extern classinfo *pseudo_class_Null;
-extern classinfo *pseudo_class_New;
-extern vftbl_t *pseudo_class_Arraystub_vftbl;
+typedef struct {            /* Long                                           */
+       s8 value;
+} constant_long;
+       
 
-extern utf *array_packagename;
+typedef struct {            /* Double                                         */
+       double value;
+} constant_double;
 
 
-/************************ prototypes ******************************************/
+typedef struct {            /* NameAndType (Field or Method)                  */
+       utf *name;              /* field/method name                              */
+       utf *descriptor;        /* field/method type descriptor string            */
+} constant_nameandtype;
 
-/* initialize laoder, load important systemclasses */
-void loader_init();
 
-void suck_init(char *cpath);
-void create_all_classes();
-void suck_stop(classbuffer *cb);
+/* classbuffer ****************************************************************/
+
+struct classbuffer {
+       classinfo *class;                   /* pointer to classinfo structure     */
+       u1        *data;                    /* pointer to byte code               */
+       s4         size;                    /* size of the byte code              */
+       u1        *pos;                     /* current read position              */
+       char      *path;                    /* path to file (for debugging)       */
+};
 
-/* free resources */
-void loader_close();
 
-void loader_compute_subclasses();
+/* classpath_info *************************************************************/
 
-/* retrieve constantpool element */
-voidptr class_getconstant(classinfo *class, u4 pos, u4 ctype);
+#define CLASSPATH_PATH       0
+#define CLASSPATH_ARCHIVE    1
 
-/* determine type of a constantpool element */
-u4 class_constanttype(classinfo *class, u4 pos);
+struct classpath_info {
+#if defined(USE_THREADS)
+       /* Required for monitor locking on zip/jar files. */
+       java_objectheader  header;
+#endif
+       s4                 type;
+       char              *path;
+       s4                 pathlen;
+#if defined(USE_ZLIB)
+       unzFile            uf;
+#endif
+       classpath_info    *next;
+};
+
+
+/* export variables ***********************************************************/
+
+#if defined(USE_THREADS)
+extern int blockInts;
+#endif
 
-s4 class_findmethodIndex(classinfo *c, utf *name, utf *desc);
+extern classpath_info *classpath_entries;
 
-/* search class for a field */
-fieldinfo *class_findfield(classinfo *c, utf *name, utf *desc);
-fieldinfo *class_resolvefield(classinfo *c, utf *name, utf *desc, classinfo *referer, bool except);
 
-/* search for a method with a specified name and descriptor */
-methodinfo *class_findmethod(classinfo *c, utf *name, utf *desc);
-methodinfo *class_fetchmethod(classinfo *c, utf *name, utf *desc);
-methodinfo *class_findmethod_w(classinfo *c, utf *name, utf *desc, char*);
-methodinfo *class_resolvemethod(classinfo *c, utf *name, utf *dest);
-methodinfo *class_resolveclassmethod(classinfo *c, utf *name, utf *dest, classinfo *referer, bool except);
-methodinfo *class_resolveinterfacemethod(classinfo *c, utf *name, utf *dest, classinfo *referer, bool except);
+/* function prototypes ********************************************************/
 
-/* search for a method with specified name and arguments (returntype ignored) */
-methodinfo *class_findmethod_approx(classinfo *c, utf *name, utf *desc);
-methodinfo *class_resolvemethod_approx(classinfo *c, utf *name, utf *dest);
+/* initialize loader, load important systemclasses */
+bool loader_init(u1 *stackbottom);
 
-bool class_issubclass(classinfo *sub, classinfo *super);
+void suck_init(char *cpath);
+void loader_load_all_classes(void);
+void suck_stop(classbuffer *cb);
+
+inline bool check_classbuffer_size(classbuffer *cb, s4 len);
+
+inline u1 suck_u1(classbuffer *cb);
+inline u2 suck_u2(classbuffer *cb);
+inline u4 suck_u4(classbuffer *cb);
 
-/* call initializer of class */
-classinfo *class_init(classinfo *c);
+/* free resources */
+void loader_close(void);
 
-void class_showconstanti(classinfo *c, int ii);
+/* class loading functions */
+classinfo *load_class_from_sysloader(utf *name);
+classinfo *load_class_from_classloader(utf *name, java_objectheader *cl);
+classinfo *load_class_bootstrap(utf *name);
 
-/* debug purposes */
-void class_showmethods(classinfo *c);
-void class_showconstantpool(classinfo *c);
-void print_arraydescriptor(FILE *file, arraydescriptor *desc);
+/* (don't use the following directly) */
+classinfo *load_class_from_classbuffer(classbuffer *cb);
+classinfo *load_newly_created_array(classinfo *c,java_objectheader *loader);
 
 /* return the primitive class inidicated by the given signature character */
 classinfo *class_primitive_from_sig(char sig);
 
-
-/* return the class indicated by the given descriptor */
-/* (see loader.c for documentation) */
-#define CLASSLOAD_NEW           0      /* default */
-#define CLASSLOAD_LOAD          0x0001
-#define CLASSLOAD_SKIP          0x0002
-#define CLASSLOAD_PANIC         0      /* default */
-#define CLASSLOAD_NOPANIC       0x0010
-#define CLASSLOAD_PRIMITIVE     0      /* default */
-#define CLASSLOAD_NULLPRIMITIVE 0x0020
-#define CLASSLOAD_VOID          0      /* default */
-#define CLASSLOAD_NOVOID        0x0040
-#define CLASSLOAD_NOCHECKEND    0      /* default */
-#define CLASSLOAD_CHECKEND      0x1000
-
-classinfo *class_from_descriptor(char *utf_ptr,char *end_ptr,char **next,int mode);
-int type_from_descriptor(classinfo **cls,char *utf_ptr,char *end_ptr,char **next,int mode);
-
-/* (used by class_new, don't use directly) */
-void class_new_array(classinfo *c);
-
-#define LAZYLOADING(class) { \
-        if (!class->loaded) \
-            if (!class_load(class)) \
-                return 0; \
-        if (!class->linked) \
-            if (!class_link(class)) \
-                return 0; }
-
-
-classinfo *class_load(classinfo *c);
-classinfo *class_load_intern(classbuffer *cb);
-classinfo *class_link(classinfo *c);
-void class_free(classinfo *c);
-
-void field_display(fieldinfo *f);
-
-void method_display(methodinfo *m);
-void method_display_w_class(methodinfo *m);
-
-utf* clinit_desc();
-utf* clinit_name();
-
-
-/******************************** CLASSPATH handling *******************/
-#define CLASSPATH_MAXFILENAME 1000                /* maximum length of a filename           */
-#define CLASSPATH_PATH 0
-#define CLASSPATH_ARCHIVE 1
-
-typedef union classpath_info {
-       struct {
-               s4                    type;
-               union classpath_info *next;
-               char                 *path;
-               s4                    pathlen;
-       } filepath;
-#if defined(USE_ZLIB)
-       struct {
-               s4                    type;
-               union classpath_info *next;
-               unzFile               uf;
-       } archive;
-#endif 
-} classpath_info;
+/* debug helpers */
+void fprintflags(FILE *fp, u2 f);
+void printflags(u2 f);
 
 #endif /* _LOADER_H */
 
-
 /*
  * These are local overrides for various environment variables in Emacs.
  * Please do not remove this and leave it at the end of the file, where