the cleaner part of the code for stub created exceptions, the rest will follow soon
[cacao.git] / src / vm / global.h
1 /* global.h - global definitions
2
3    Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
4    R. Grafl, A. Krall, C. Kruegel, C. Oates, R. Obermaisser,
5    M. Probst, S. Ring, E. Steiner, C. Thalinger, D. Thuernbeck,
6    P. Tomsich, J. Wenninger
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., 59 Temple Place - Suite 330, Boston, MA
23    02111-1307, USA.
24
25    Contact: cacao@complang.tuwien.ac.at
26
27    Authors: Reinhard Grafl
28             Andreas Krall
29
30    Changes: Mark Probst
31             Philipp Tomsich
32                         Edwin Steiner
33
34    $Id: global.h 1082 2004-05-26 15:04:54Z jowenn $
35
36 */
37
38
39 #ifndef _GLOBAL_H
40 #define _GLOBAL_H
41
42 #define _GNU_SOURCE
43
44 #include "config.h"
45 #include "types.h"
46 #include "toolbox/list.h"
47
48 #if defined(USE_THREADS) && defined(NATIVE_THREADS)
49 #include <pthread.h>
50 #endif
51
52 #define STATISTICS          /* if enabled collects program statistics         */
53
54 /* 
55  * SIZE_FROM_CLASSINFO toggles between the bitmap_based and the new method 
56  * of determining the sizes of objects on the heap.
57  */
58 #define SIZE_FROM_CLASSINFO
59
60 /*
61  * CACAO_TYPECHECK activates typechecking (part of bytecode verification)
62  */
63 #define CACAO_TYPECHECK
64
65 /*
66  * TYPECHECK_STACK_COMPCAT activates full checking of computational
67  * categories for stack manipulations (POP,POP2,SWAP,DUP,DUP2,DUP_X1,
68  * DUP2_X1,DUP_X2,DUP2_X2).
69  */
70 /* #define TYPECHECK_STACK_COMPCAT */
71
72 /*
73  * Macros for configuration of the typechecking code
74  *
75  * TYPECHECK_STATISTICS activates gathering statistical information.
76  * TYPEINFO_DEBUG activates debug checks and debug helpers in typeinfo.c
77  * TYPECHECK_DEBUG activates debug checks in typecheck.c
78  * TYPEINFO_DEBUG_TEST activates the typeinfo test at startup.
79  * TYPECHECK_VERBOSE_IMPORTANT activates important debug messages
80  * TYPECHECK_VERBOSE activates all debug messages
81  */
82 #ifdef CACAO_TYPECHECK
83 /*#define TYPECHECK_STATISTICS*/
84 /*#define TYPEINFO_DEBUG*/
85 /*#define TYPECHECK_DEBUG*/
86 /*#define TYPEINFO_DEBUG_TEST*/
87 /*#define TYPECHECK_VERBOSE*/
88 /*#define TYPECHECK_VERBOSE_IMPORTANT*/
89 #if defined(TYPECHECK_VERBOSE) || defined(TYPECHECK_VERBOSE_IMPORTANT)
90 #define TYPECHECK_VERBOSE_OPT
91 #endif
92 #endif
93
94
95 /* additional data types ******************************************************/
96
97 typedef void *voidptr;          /* generic pointer */
98
99 typedef int   bool;             /* boolean data type */
100
101 #define true  1
102 #define false 0
103
104
105 /* immediate data union */
106
107 typedef union {
108     s4 i;
109     s8 l;
110     float f;
111     double d;
112     void *a;
113     u1 b[8];
114 } imm_union;
115
116
117 #define PRIMITIVETYPE_COUNT  9  /* number of primitive types */
118
119 /* CAUTION: Don't change the numerical values! These constants are
120  * used as indices into the primitive type table.
121  */
122 #define PRIMITIVETYPE_INT     0
123 #define PRIMITIVETYPE_LONG    1
124 #define PRIMITIVETYPE_FLOAT   2
125 #define PRIMITIVETYPE_DOUBLE  3
126 #define PRIMITIVETYPE_BYTE    4
127 #define PRIMITIVETYPE_CHAR    5
128 #define PRIMITIVETYPE_SHORT   6
129 #define PRIMITIVETYPE_BOOLEAN 7
130 #define PRIMITIVETYPE_VOID    8
131
132 typedef void (*functionptr) (); /* generic function pointer */
133
134
135 #define MAX_ALIGN 8             /* most generic alignment for JavaVM values   */
136
137 /* shutdown function **********************************************************/
138
139 void cacao_shutdown(s4 status);
140
141
142 /* basic data types ***********************************************************/
143
144 /* CAUTION: jit/jit.h relies on these numerical values! */
145 #define TYPE_INT      0         /* the JavaVM types must numbered in the      */
146 #define TYPE_LONG     1         /* same order as the ICMD_Ixxx to ICMD_Axxx   */
147 #define TYPE_FLOAT    2         /* instructions (LOAD and STORE)              */
148 #define TYPE_DOUBLE   3         /* integer, long, float, double, address      */
149 #define TYPE_ADDRESS  4         /* all other types can be numbered arbitrarly */
150
151 #define TYPE_VOID    10
152
153
154 /* Java class file constants **************************************************/
155
156 #define MAGIC         0xcafebabe
157 #define MINOR_VERSION 3
158 #define MAJOR_VERSION 45
159
160 #define CONSTANT_Class                 7
161 #define CONSTANT_Fieldref              9
162 #define CONSTANT_Methodref            10
163 #define CONSTANT_InterfaceMethodref   11
164 #define CONSTANT_String                8
165 #define CONSTANT_Integer               3
166 #define CONSTANT_Float                 4
167 #define CONSTANT_Long                  5
168 #define CONSTANT_Double                6
169 #define CONSTANT_NameAndType          12
170 #define CONSTANT_Utf8                  1
171
172 #define CONSTANT_UNUSED                0
173
174 #define ACC_PUBLIC                0x0001
175 #define ACC_PRIVATE               0x0002
176 #define ACC_PROTECTED             0x0004
177 #define ACC_STATIC                0x0008
178 #define ACC_FINAL                 0x0010
179 #define ACC_SUPER                 0x0020
180 #define ACC_SYNCHRONIZED          0x0020
181 #define ACC_VOLATILE              0x0040
182 #define ACC_TRANSIENT             0x0080
183 #define ACC_NATIVE                0x0100
184 #define ACC_INTERFACE             0x0200
185 #define ACC_ABSTRACT              0x0400
186 #define ACC_STRICT                0x0800
187
188 /* resolve typedef cycles *****************************************************/
189
190 typedef struct utf utf;
191 typedef struct literalstring literalstring;
192 typedef struct java_objectheader java_objectheader; 
193 typedef struct classinfo classinfo; 
194 typedef struct vftbl vftbl;
195 typedef u1* methodptr;
196 typedef struct fieldinfo  fieldinfo; 
197 typedef struct methodinfo methodinfo; 
198 typedef struct lineinfo lineinfo; 
199 typedef struct arraydescriptor arraydescriptor;
200
201
202 /* constant pool entries *******************************************************
203
204         All constant pool entries need a data structure which contain the entrys
205         value. In some cases this structure exist already, in the remaining cases
206         this structure must be generated:
207
208                 kind                      structure                     generated?
209         ----------------------------------------------------------------------
210     CONSTANT_Class               classinfo                           no
211     CONSTANT_Fieldref            constant_FMIref                    yes
212     CONSTANT_Methodref           constant_FMIref                    yes
213     CONSTANT_InterfaceMethodref  constant_FMIref                    yes
214     CONSTANT_String              unicode                             no
215     CONSTANT_Integer             constant_integer                   yes
216     CONSTANT_Float               constant_float                     yes
217     CONSTANT_Long                constant_long                      yes
218     CONSTANT_Double              constant_double                    yes
219     CONSTANT_NameAndType         constant_nameandtype               yes
220     CONSTANT_Utf8                unicode                             no
221     CONSTANT_UNUSED              -
222
223 *******************************************************************************/
224
225 /* data structures for hashtables ********************************************
226
227
228         All utf-symbols, javastrings and classes are stored in global hashtables,
229         so every symbol exists only once. Equal symbols have identical pointers.
230         The functions for adding hashtable elements search the table for the 
231         element with the specified name/text and return it on success. Otherwise a 
232         new hashtable element is created.
233
234     The hashtables use external linking for handling collisions. The hashtable 
235         structure contains a pointer <ptr> to the array of hashtable slots. The 
236         number of hashtable slots and therefore the size of this array is specified 
237         by the element <size> of hashtable structure. <entries> contains the number
238         of all hashtable elements stored in the table, including those in the 
239         external chains.
240         The hashtable element structures (utf, literalstring, classinfo) contain
241         both a pointer to the next hashtable element as a link for the external hash 
242         chain and the key of the element. The key is computed from the text of
243         the string or the classname by using up to 8 characters.
244         
245         If the number of entries in the hashtable exceeds twice the size of the 
246         hashtableslot-array it is supposed that the average length of the 
247         external chains has reached a value beyond 2. Therefore the functions for
248         adding hashtable elements (utf_new, class_new, literalstring_new) double
249         the hashtableslot-array. In this restructuring process all elements have
250         to be inserted into the new hashtable and new external chains must be built.
251
252
253 example for the layout of a hashtable:
254
255 hashtable.ptr-->  +-------------------+
256                   |                   |
257                            ...
258                   |                   |
259                   +-------------------+   +-------------------+   +-------------------+
260                   | hashtable element |-->| hashtable element |-->| hashtable element |-->NULL
261                   +-------------------+   +-------------------+   +-------------------+
262                   | hashtable element |
263                   +-------------------+   +-------------------+   
264                   | hashtable element |-->| hashtable element |-->NULL
265                   +-------------------+   +-------------------+   
266                   | hashtable element |-->NULL
267                   +-------------------+
268                   |                   |
269                            ...
270                   |                   |
271                   +-------------------+
272
273 */
274
275
276 /* data structure for utf8 symbols ********************************************/
277
278 struct utf {
279         utf        *hashlink;       /* link for external hash chain               */
280         int         blength;        /* text length in bytes                       */           
281         char       *text;           /* pointer to text                            */
282 };
283
284
285 /* data structure of internal javastrings stored in global hashtable **********/
286
287 struct literalstring {
288         literalstring     *hashlink;     /* link for external hash chain          */
289         java_objectheader *string;  
290 };
291
292
293 /* data structure for storing information needed for a stacktrace across native functions*/
294 struct native_stackframeinfo {
295         void *oldThreadspecificHeadValue;
296         void **addressOfThreadspecificHead;
297         methodinfo *method;
298         void *returnToFromNative;
299
300 #if 0
301         void *returnFromNative;
302         void *addrReturnFromNative;
303         methodinfo *method;
304         struct native_stackframeinfo *next;
305         struct native_stackframeinfo *prev;
306 #endif
307 };
308
309 typedef struct native_stackframeinfo native_stackframeinfo;
310
311 struct stacktraceelement {
312 #if POINTERSIZE == 8
313         u8 linenumber;
314 #else
315         u4 linenumber;
316 #endif
317         methodinfo *method;
318 };
319
320 typedef struct stacktraceelement stacktraceelement;
321
322 /* data structure for calls from c code to java methods */
323
324 struct jni_callblock {
325         u1 itemtype;
326         u8 item;
327 };
328
329 typedef struct jni_callblock jni_callblock;
330
331
332 /* data structure for accessing hashtables ************************************/
333
334 typedef struct {            
335         u4 size;
336         u4 entries;        /* number of entries in the table */
337         void **ptr;        /* pointer to hashtable */
338 } hashtable;
339
340
341 /* data structures of remaining constant pool entries *************************/
342
343 typedef struct {            /* Fieldref, Methodref and InterfaceMethodref     */
344         classinfo *class;       /* class containing this field/method/interface   */
345         utf       *name;        /* field/method/interface name                    */
346         utf       *descriptor;  /* field/method/interface type descriptor string  */
347 } constant_FMIref;
348
349
350 typedef struct {            /* Integer                                        */
351         s4 value;
352 } constant_integer;
353
354         
355 typedef struct {            /* Float                                          */
356         float value;
357 } constant_float;
358
359
360 typedef struct {            /* Long                                           */
361         s8 value;
362 } constant_long;
363         
364
365 typedef struct {            /* Double                                         */
366         double value;
367 } constant_double;
368
369
370 typedef struct {            /* NameAndType (Field or Method)                  */
371         utf *name;              /* field/method name                              */
372         utf *descriptor;        /* field/method type descriptor string            */
373 } constant_nameandtype;
374
375
376 /* data structures of the runtime system **************************************/
377
378 /* objects *********************************************************************
379
380         All objects (and arrays) which resides on the heap need the following
381         header at the beginning of the data structure.
382 */
383
384 struct java_objectheader {              /* header for all objects             */
385         vftbl *vftbl;                       /* pointer to virtual function table  */
386 #if defined(USE_THREADS) && defined(NATIVE_THREADS)
387         long monitorBits;
388 #endif
389 };
390
391
392
393 /* arrays **********************************************************************
394
395         All arrays are objects (they need the object header with a pointer
396         to a vftbl (array class table). There is one class for each array
397         type. The array type is described by an arraydescriptor struct
398         which is referenced by the vftbl.
399 */
400
401 /* CAUTION: Don't change the numerical values! These constants (with
402  * the exception of ARRAYTYPE_OBJECT) are used as indices in the
403  * primitive type table.
404  */
405 #define ARRAYTYPE_INT      PRIMITIVETYPE_INT
406 #define ARRAYTYPE_LONG     PRIMITIVETYPE_LONG
407 #define ARRAYTYPE_FLOAT    PRIMITIVETYPE_FLOAT
408 #define ARRAYTYPE_DOUBLE   PRIMITIVETYPE_DOUBLE
409 #define ARRAYTYPE_BYTE     PRIMITIVETYPE_BYTE
410 #define ARRAYTYPE_CHAR     PRIMITIVETYPE_CHAR
411 #define ARRAYTYPE_SHORT    PRIMITIVETYPE_SHORT
412 #define ARRAYTYPE_BOOLEAN  PRIMITIVETYPE_BOOLEAN
413 #define ARRAYTYPE_OBJECT   PRIMITIVETYPE_VOID     /* don't use as index! */
414
415 typedef struct java_arrayheader {       /* header for all arrays              */
416         java_objectheader objheader;        /* object header                      */
417         s4 size;                            /* array size                         */
418 #ifdef SIZE_FROM_CLASSINFO
419         s4 alignedsize; /* phil */
420 #endif
421 } java_arrayheader;
422
423
424
425 /* structs for all kinds of arrays ********************************************/
426
427 typedef struct java_chararray {
428         java_arrayheader header;
429         u2 data[1];
430 } java_chararray;
431
432 typedef struct java_floatheader {
433         java_arrayheader header;
434         float data[1];
435 } java_floatarray;
436
437 typedef struct java_doublearray {
438         java_arrayheader header;
439         double data[1];
440 } java_doublearray;
441
442 /*  booleanarray and bytearray need identical memory layout (access methods
443     use the same machine code */
444
445 typedef struct java_booleanarray {
446         java_arrayheader header;
447         u1 data[1];
448 } java_booleanarray;
449
450 typedef struct java_bytearray {
451         java_arrayheader header;
452         s1 data[1];
453 } java_bytearray;
454
455 typedef struct java_shortarray {
456         java_arrayheader header;
457         s2 data[1];
458 } java_shortarray;
459
460 typedef struct java_intarray {
461         java_arrayheader header;
462         s4 data[1];
463 } java_intarray;
464
465 typedef struct java_longarray {
466         java_arrayheader header;
467         s8 data[1];
468 } java_longarray;
469
470 /*  objectarray and arrayarray need identical memory layout (access methods
471     use the same machine code */
472
473 typedef struct java_objectarray {
474         java_arrayheader header;
475         java_objectheader *data[1];
476 } java_objectarray;
477
478
479 /* structure for primitive classes ********************************************/
480
481 typedef struct primitivetypeinfo {
482         classinfo *class_wrap;               /* class for wrapping primitive type */
483         classinfo *class_primitive;          /* primitive class                   */
484         char      *wrapname;                 /* name of class for wrapping        */
485         char      typesig;                   /* one character type signature      */
486         char      *name;                     /* name of primitive class           */
487         char      *arrayname;                /* name of primitive array class     */
488         classinfo *arrayclass;               /* primitive array class             */
489         vftbl     *arrayvftbl;               /* vftbl of primitive array class    */
490 } primitivetypeinfo;
491
492
493 /* field, method and class structures *****************************************/
494
495 #include "sets.h"
496 typedef struct xtafldinfo {
497         bool       fieldChecked;                
498         classinfo *fldClassType;
499         classSet  *XTAclassSet;          /* field class type set                  */
500 } xtafldinfo;
501
502
503 /* fieldinfo ******************************************************************/
504
505 struct fieldinfo {            /* field of a class                                 */
506         s4  flags;            /* ACC flags                                        */
507         s4  type;             /* basic data type                                  */
508         utf *name;            /* name of field                                    */
509         utf *descriptor;      /* JavaVM descriptor string of field                */
510         
511         s4  offset;           /* offset from start of object (instance variables) */
512
513         imm_union value;      /* storage for static values (class variables)      */
514
515         classinfo *class;     /* needed by typechecker. Could be optimized        */
516                               /* away by using constant_FMIref instead of         */
517                               /* fieldinfo throughout the compiler.               */
518         
519         xtafldinfo *xta;
520 };
521
522 struct basicblock;
523
524
525 /* exceptiontable *************************************************************/
526
527 typedef struct xtable {         /* exceptiontable entry in a method           */
528         s4         startpc;         /* start pc of guarded area (inclusive)       */
529         struct basicblock *start;
530
531         s4         endpc;           /* end pc of guarded area (exklusive)         */
532         struct basicblock *end;
533
534         s4         handlerpc;       /* pc of exception handler                    */
535         struct basicblock *handler;
536
537         classinfo *catchtype;       /* catchtype of exception (NULL == catchall)  */
538         struct xtable *next;        /* used to build a list of exception when     */
539                                     /* loops are copied */
540         struct xtable *down;        /* instead of the old array, a list is used   */
541 } xtable;
542
543
544 typedef struct exceptiontable { /* exceptiontable entry in a method           */
545         s4         startpc;         /* start pc of guarded area (inclusive)       */
546         s4         endpc;           /* end pc of guarded area (exklusive)         */
547         s4         handlerpc;       /* pc of exception handler                    */
548         classinfo *catchtype;       /* catchtype of exception (NULL == catchall)  */
549 } exceptiontable;
550
551
552 /* methodinfo  static info ****************************************************/
553 typedef struct xtainfo {
554         s4          XTAmethodUsed;     /* XTA if used in callgraph - not used /used */
555         classSet    *XTAclassSet;      /* method class type set                 */ 
556         /*classSet      *PartClassSet */   /* method class type set                 */ 
557
558         classSetNode    *paramClassSet; /* cone set of methods parameters       */
559
560         methSet         *calls;            /* methods this method calls                 */ 
561         methSet         *calledBy;         /* methods that call this method         */ 
562         methSet         *marked;  //not in Dez         /* methods that marked by this method    */ 
563         methSet         *markedBy;
564         fldSet          *fldsUsed;         /* fields used by this method             */ 
565         /*methSetNode  *interfaceCalls*/   /* methods this method calls as interface */ 
566         bool           chgdSinceLastParse; /* Changed since last parse ?          */
567 } xtainfo; 
568
569
570 /* lineinfo *****************************************************************/
571 struct lineinfo {
572         u2 start_pc;
573         u2 line_number;
574 };
575
576 /* methodinfo *****************************************************************/
577
578 struct methodinfo {                 /* method structure                       */
579         s4             flags;               /* ACC flags                              */
580         utf       *name;                /* name of method                         */
581         utf       *descriptor;          /* JavaVM descriptor string of method     */
582         s4         returntype;          /* only temporary valid, return type      */
583         classinfo *returnclass;         /* pointer to classinfo for the rtn type  */ /*XTA*/ 
584         s4         paramcount;          /* only temporary valid, parameter count  */
585         u1        *paramtypes;          /* only temporary valid, parameter types  */
586         classinfo **paramclass;         /* pointer to classinfo for a parameter   */ /*XTA*/
587         
588         classinfo *class;               /* class, the method belongs to           */
589         s4         vftblindex;          /* index of method in virtual function table
590                                            (if it is a virtual method)            */
591         s4         maxstack;            /* maximum stack depth of method          */
592         s4         maxlocals;           /* maximum number of local variables      */
593         s4         jcodelength;         /* length of JavaVM code                  */
594         u1        *jcode;               /* pointer to JavaVM code                 */
595
596         s4         exceptiontablelength;/* exceptiontable length                  */
597         exceptiontable *exceptiontable; /* the exceptiontable                     */
598
599         u2        thrownexceptionscount;/*number of exceptions declared to be thrown by a method*/
600         classinfo **thrownexceptions;   /*array of classinfos of declared exceptions*/
601
602         u2         linenumbercount;     /*number of linenumber attributes*/
603         lineinfo  *linenumbers;         /*array of lineinfo items (start_pc,line_number)*/
604
605         u1        *stubroutine;         /* stub for compiling or calling natives  */    
606         s4         mcodelength;         /* legth of generated machine code        */
607         u1        *mcode;               /* pointer to machine code                */
608         u1        *entrypoint;          /* entry point in machine code            */
609
610         /*rtainfo   rta;*/
611         xtainfo    *xta;
612
613         s4        methodUsed;           /* marked (might be used later) /not used /used */
614         s4        monoPoly;             /* call is mono or poly or unknown        */ /*RT stats */
615         /* should # method def'd and used be kept after static parse (will it be used?) */
616         s4        subRedefs;
617         s4        subRedefsUsed;
618 };
619
620
621 /* innerclassinfo *************************************************************/
622
623 typedef struct innerclassinfo {
624         classinfo *inner_class;       /* inner class pointer                      */
625         classinfo *outer_class;       /* outer class pointer                      */
626         utf *name;                    /* innerclass name                          */ 
627         s4 flags;                     /* ACC flags                                */
628 } innerclassinfo;
629
630
631 /* classinfo ******************************************************************/
632
633 struct classinfo {                /* class structure                          */
634         java_objectheader header;     /* classes are also objects                 */
635         java_objectarray* signers;
636         struct java_security_ProtectionDomain* pd;
637         struct java_lang_VMClass* vmClass;
638         struct java_lang_reflect_Constructor* constructor;
639
640         s4 initializing_thread;       /* gnu classpath                            */
641         s4 erroneous_state;           /* gnu classpath                            */
642         struct gnu_classpath_RawData* vmData; /* gnu classpath                    */
643
644         s4          flags;            /* ACC flags                                */
645         utf        *name;             /* class name                               */
646
647         s4          cpcount;          /* number of entries in constant pool       */
648         u1         *cptags;           /* constant pool tags                       */
649         voidptr    *cpinfos;          /* pointer to constant pool info structures */
650
651         classinfo  *super;            /* super class pointer                      */
652         classinfo  *sub;              /* sub class pointer                        */
653         classinfo  *nextsub;          /* pointer to next class in sub class list  */
654
655         s4          interfacescount;  /* number of interfaces                     */
656         classinfo **interfaces;       /* pointer to interfaces                    */
657
658         s4          fieldscount;      /* number of fields                         */
659         fieldinfo  *fields;           /* field table                              */
660
661         s4          methodscount;     /* number of methods                        */
662         methodinfo *methods;          /* method table                             */
663
664         listnode    listnode;         /* linkage                                  */
665
666         bool        initialized;      /* true, if class already initialised       */
667         bool        loaded;           /* true, if class already loaded            */
668         bool        linked;           /* true, if class already linked            */
669         s4          index;            /* hierarchy depth (classes) or index
670                                          (interfaces)                             */
671         s4          instancesize;     /* size of an instance of this class        */
672 #ifdef SIZE_FROM_CLASSINFO
673         s4          alignedsize;      /* size of an instance, aligned to the 
674                                                                          allocation size on the heap              */
675 #endif
676
677         vftbl      *vftbl;            /* pointer to virtual function table        */
678
679         methodinfo *finalizer;        /* finalizer method                         */
680
681     u2             innerclasscount;   /* number of inner classes              */
682     innerclassinfo *innerclass;
683
684     classinfo      *hashlink;         /* link for external hash chain         */
685         bool        classvftbl;       /* has its own copy of the Class vtbl       */
686
687         s4          classUsed;        /* 0= not used 1 = used   CO-RT             */
688
689         classSetNode *impldBy;        /* implemented by class set                 */
690         utf        *packagename;      /* full name of the package                 */
691         utf        *sourcefile;       /* classfile name containing this class     */
692         java_objectheader *classloader;       /* 0 for bootstrap classloader */
693 };
694
695 /* check if class is an array class. Only use for linked classes! */
696 #define CLASS_IS_ARRAY(clsinfo)  ((clsinfo)->vftbl->arraydesc != NULL)
697
698
699 /* virtual function table ******************************************************
700
701         The vtbl has a bidirectional layout with open ends at both sides.
702         interfacetablelength gives the number of entries of the interface table at
703         the start of the vftbl. The vftbl pointer points to &interfacetable[0].
704         vftbllength gives the number of entries of table at the end of the vftbl.
705
706         runtime type check (checkcast):
707
708         Different methods are used for runtime type check depending on the
709         argument of checkcast/instanceof.
710         
711         A check against a class is implemented via relative numbering on the class
712         hierachy tree. The tree is numbered in a depth first traversal setting
713         the base field and the diff field. The diff field gets the result of
714         (high - base) so that a range check can be implemented by an unsigned
715         compare. A sub type test is done by checking the inclusion of base of
716         the sub class in the range of the superclass.
717
718         A check against an interface is implemented via the interfacevftbl. If the
719         interfacevftbl contains a nonnull value a class is a subclass of this
720         interface.
721
722         interfacetable:
723
724         Like standard virtual methods interface methods are called using
725         virtual function tables. All interfaces are numbered sequentially
726         (starting with zero). For each class there exist an interface table
727         of virtual function tables for each implemented interface. The length
728         of the interface table is determined by the highest number of an
729         implemented interface.
730
731         The following example assumes a class which implements interface 0 and 3:
732
733         interfacetablelength = 4
734
735                   | ...       |            +----------+
736                       +-----------+            | method 2 |---> method z
737                       | class     |            | method 1 |---> method y
738                       +-----------+            | method 0 |---> method x
739                       | ivftbl  0 |----------> +----------+
740         vftblptr ---> +-----------+
741                   | ivftbl -1 |--> NULL    +----------+
742                   | ivftbl -2 |--> NULL    | method 1 |---> method x
743                   | ivftbl -3 |-----+      | method 0 |---> method a
744                   +-----------+     +----> +----------+
745      
746                               +---------------+
747                                   | length 3 = 2  |
748                                   | length 2 = 0  |
749                                   | length 1 = 0  |
750                                   | length 0 = 3  |
751         interfacevftbllength ---> +---------------+
752
753 *******************************************************************************/
754
755 struct vftbl {
756         methodptr   *interfacetable[1];    /* interface table (access via macro)  */
757
758         classinfo   *class;                /* class, the vtbl belongs to          */
759
760         arraydescriptor *arraydesc;        /* for array classes, otherwise NULL   */
761
762         s4           vftbllength;          /* virtual function table length       */
763         s4           interfacetablelength; /* interface table length              */
764
765         s4           baseval;              /* base for runtime type check         */
766                                            /* (-index for interfaces)             */
767         s4           diffval;              /* high - base for runtime type check  */
768
769         s4          *interfacevftbllength; /* length of interface vftbls          */
770         
771         methodptr    table[1];             /* class vftbl                         */
772 };
773
774 #define VFTBLINTERFACETABLE(v,i)       (v)->interfacetable[-i]
775
776
777 /* arraydescriptor ************************************************************
778
779     For every array class an arraydescriptor is allocated which
780     describes the array class.
781         The arraydescriptor is referenced from the vftbl of the array
782         class.
783
784 *******************************************************************************/
785
786 struct arraydescriptor {
787         vftbl *componentvftbl;   /* vftbl of the component type, NULL for primit. */
788         vftbl *elementvftbl;     /* vftbl of the element type, NULL for primitive */
789         short  arraytype;        /* ARRAYTYPE_* constant                          */
790         short  dimension;        /* dimension of the array (always >= 1)          */
791     s4     dataoffset;       /* offset of the array data from object pointer  */
792         s4     componentsize;    /* size of a component in bytes                  */
793         short  elementtype;      /* ARRAYTYPE_* constant                          */
794 };
795
796
797 /* flag variables *************************************************************/
798
799 extern bool compileall;
800 extern bool runverbose;         
801 extern bool verboseexception;         
802 extern bool verbose;         
803 extern bool opt_rt;             /* Rapid Type Analysis for better inlining CO-RT*/
804 extern bool opt_xta;            /* X Type Analysis for better inlining    CO-XTA*/
805 extern bool opt_vta;            /* Variable Type Analysis for better inlining    CO-VTA*/
806 extern bool opt_verify;         /* true if classfiles should be verified      */
807 #ifdef TYPECHECK_VERBOSE_OPT
808 extern bool typecheckverbose;
809 #endif
810
811 /*extern int pClassHeir;*/
812 /*extern int pCallgraph;*/
813 /*extern int pOpcodes;*/
814 /*extern int pStats;*/
815
816 /*extern void RT_jit_parse(methodinfo *m);*/
817
818
819 /* statistic variables ********************************************************/
820
821 extern int count_class_infos;
822 extern int count_const_pool_len;
823 extern int count_vftbl_len;
824 extern int count_utf_len;
825 extern int count_all_methods;
826 extern int count_vmcode_len;
827 extern int count_extable_len;
828 extern int count_class_loads;
829 extern int count_class_inits;
830 extern int count_utf_new;
831 extern int count_utf_new_found;
832
833
834 /* table of primitive types ***************************************************/
835
836 /* This array can be indexed by the PRIMITIVETYPE_ and ARRAYTYPE_
837  * constants (except ARRAYTYPE_OBJECT).
838  */
839 extern primitivetypeinfo primitivetype_table[PRIMITIVETYPE_COUNT];
840
841
842 /* macros for descriptor parsing **********************************************/
843
844 /* SKIP_FIELDDESCRIPTOR:
845  * utf_ptr must point to the first character of a field descriptor.
846  * After the macro call utf_ptr points to the first character after
847  * the field descriptor.
848  *
849  * CAUTION: This macro does not check for an unexpected end of the
850  * descriptor. Better use SKIP_FIELDDESCRIPTOR_SAFE.
851  */
852 #define SKIP_FIELDDESCRIPTOR(utf_ptr)                                                   \
853         do { while (*(utf_ptr)=='[') (utf_ptr)++;                                       \
854                 if (*(utf_ptr)++=='L')                                                                  \
855                         while(*(utf_ptr)++ != ';') /* skip */; } while(0)
856
857 /* SKIP_FIELDDESCRIPTOR_SAFE:
858  * utf_ptr must point to the first character of a field descriptor.
859  * After the macro call utf_ptr points to the first character after
860  * the field descriptor.
861  *
862  * Input:
863  *     utf_ptr....points to first char of descriptor
864  *     end_ptr....points to first char after the end of the string
865  *     errorflag..must be initialized (to false) by the caller!
866  * Output:
867  *     utf_ptr....points to first char after the descriptor
868  *     errorflag..set to true if the string ended unexpectedly
869  */
870 #define SKIP_FIELDDESCRIPTOR_SAFE(utf_ptr,end_ptr,errorflag)                    \
871         do { while ((utf_ptr) != (end_ptr) && *(utf_ptr)=='[') (utf_ptr)++;     \
872                 if ((utf_ptr) == (end_ptr))                                                                             \
873                         (errorflag) = true;                                                                                     \
874                 else                                                                                                                    \
875                         if (*(utf_ptr)++=='L') {                                                                        \
876                                 while((utf_ptr) != (end_ptr) && *(utf_ptr)++ != ';')    \
877                                         /* skip */;                                                                                     \
878                                 if ((utf_ptr)[-1] != ';')                                                               \
879                                         (errorflag) = true; }} while(0)
880
881
882 /* Synchronization ************************************************************/
883
884 #if defined(USE_THREADS) && defined(NATIVE_THREADS)
885 void cast_lock();
886 void cast_unlock();
887 void compiler_lock();
888 void compiler_unlock();
889 #endif
890
891 #endif /* _GLOBAL_H */
892
893
894 /*
895  * These are local overrides for various environment variables in Emacs.
896  * Please do not remove this and leave it at the end of the file, where
897  * Emacs will automagically detect them.
898  * ---------------------------------------------------------------------
899  * Local variables:
900  * mode: c
901  * indent-tabs-mode: t
902  * c-basic-offset: 4
903  * tab-width: 4
904  * End:
905  */