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 941 2004-03-06 17:27:56Z 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 *returnFromNative;
 296         void *addrReturnFromNative;
 297         methodinfo *method;
 298         struct native_stackframeinfo *next;
 299         struct native_stackframeinfo *prev;
 300 };
 301
 302 typedef struct native_stackframeinfo native_stackframeinfo;
 303
 304 /* data structure for calls from c code to java methods */
 305
 306 struct jni_callblock {
 307         u1 itemtype;
 308         u8 item;
 309 };
 310
 311 typedef struct jni_callblock jni_callblock;
 312
 313
 314 /* data structure for accessing hashtables ************************************/
 315
 316 typedef struct {
 317         u4 size;
 318         u4 entries;        /* number of entries in the table */
 319         void **ptr;        /* pointer to hashtable */
 320 } hashtable;
 321
 322
 323 /* data structures of remaining constant pool entries *************************/
 324
 325 typedef struct {            /* Fieldref, Methodref and InterfaceMethodref     */
 326         classinfo *class;       /* class containing this field/method/interface   */
 327         utf       *name;        /* field/method/interface name                    */
 328         utf       *descriptor;  /* field/method/interface type descriptor string  */
 329 } constant_FMIref;
 330
 331
 332 typedef struct {            /* Integer                                        */
 333         s4 value;
 334 } constant_integer;
 335
 336
 337 typedef struct {            /* Float                                          */
 338         float value;
 339 } constant_float;
 340
 341
 342 typedef struct {            /* Long                                           */
 343         s8 value;
 344 } constant_long;
 345
 346
 347 typedef struct {            /* Double                                         */
 348         double value;
 349 } constant_double;
 350
 351
 352 typedef struct {            /* NameAndType (Field or Method)                  */
 353         utf *name;              /* field/method name                              */
 354         utf *descriptor;        /* field/method type descriptor string            */
 355 } constant_nameandtype;
 356
 357
 358 /* data structures of the runtime system **************************************/
 359
 360 /* objects *********************************************************************
 361
 362         All objects (and arrays) which resides on the heap need the following
 363         header at the beginning of the data structure.
 364 */
 365
 366 struct java_objectheader {              /* header for all objects             */
 367         vftbl *vftbl;                       /* pointer to virtual function table  */
 368 };
 369
 370
 371
 372 /* arrays **********************************************************************
 373
 374         All arrays are objects (they need the object header with a pointer
 375         to a vftbl (array class table). There is one class for each array
 376         type. The array type is described by an arraydescriptor struct
 377         which is referenced by the vftbl.
 378 */
 379
 380 /* CAUTION: Don't change the numerical values! These constants (with
 381  * the exception of ARRAYTYPE_OBJECT) are used as indices in the
 382  * primitive type table.
 383  */
 384 #define ARRAYTYPE_INT      PRIMITIVETYPE_INT
 385 #define ARRAYTYPE_LONG     PRIMITIVETYPE_LONG
 386 #define ARRAYTYPE_FLOAT    PRIMITIVETYPE_FLOAT
 387 #define ARRAYTYPE_DOUBLE   PRIMITIVETYPE_DOUBLE
 388 #define ARRAYTYPE_BYTE     PRIMITIVETYPE_BYTE
 389 #define ARRAYTYPE_CHAR     PRIMITIVETYPE_CHAR
 390 #define ARRAYTYPE_SHORT    PRIMITIVETYPE_SHORT
 391 #define ARRAYTYPE_BOOLEAN  PRIMITIVETYPE_BOOLEAN
 392 #define ARRAYTYPE_OBJECT   PRIMITIVETYPE_VOID     /* don't use as index! */
 393
 394 typedef struct java_arrayheader {       /* header for all arrays              */
 395         java_objectheader objheader;        /* object header                      */
 396         s4 size;                            /* array size                         */
 397 #ifdef SIZE_FROM_CLASSINFO
 398         s4 alignedsize; /* phil */
 399 #endif
 400 } java_arrayheader;
 401
 402
 403
 404 /* structs for all kinds of arrays ********************************************/
 405
 406 typedef struct java_chararray {
 407         java_arrayheader header;
 408         u2 data[1];
 409 } java_chararray;
 410
 411 typedef struct java_floatheader {
 412         java_arrayheader header;
 413         float data[1];
 414 } java_floatarray;
 415
 416 typedef struct java_doublearray {
 417         java_arrayheader header;
 418         double data[1];
 419 } java_doublearray;
 420
 421 /*  booleanarray and bytearray need identical memory layout (access methods
 422     use the same machine code */
 423
 424 typedef struct java_booleanarray {
 425         java_arrayheader header;
 426         u1 data[1];
 427 } java_booleanarray;
 428
 429 typedef struct java_bytearray {
 430         java_arrayheader header;
 431         s1 data[1];
 432 } java_bytearray;
 433
 434 typedef struct java_shortarray {
 435         java_arrayheader header;
 436         s2 data[1];
 437 } java_shortarray;
 438
 439 typedef struct java_intarray {
 440         java_arrayheader header;
 441         s4 data[1];
 442 } java_intarray;
 443
 444 typedef struct java_longarray {
 445         java_arrayheader header;
 446         s8 data[1];
 447 } java_longarray;
 448
 449 /*  objectarray and arrayarray need identical memory layout (access methods
 450     use the same machine code */
 451
 452 typedef struct java_objectarray {
 453         java_arrayheader header;
 454         java_objectheader *data[1];
 455 } java_objectarray;
 456
 457
 458 /* structure for primitive classes ********************************************/
 459
 460 typedef struct primitivetypeinfo {
 461         classinfo *class_wrap;               /* class for wrapping primitive type */
 462         classinfo *class_primitive;          /* primitive class                   */
 463         char      *wrapname;                 /* name of class for wrapping        */
 464         char      typesig;                   /* one character type signature      */
 465         char      *name;                     /* name of primitive class           */
 466         char      *arrayname;                /* name of primitive array class     */
 467         classinfo *arrayclass;               /* primitive array class             */
 468         vftbl     *arrayvftbl;               /* vftbl of primitive array class    */
 469 } primitivetypeinfo;
 470
 471
 472 /* field, method and class structures *****************************************/
 473
 474 #include "sets.h"
 475 typedef struct xtafldinfo {
 476         bool       fieldChecked;
 477         classinfo *fldClassType;
 478         classSet  *XTAclassSet;          /* field class type set                  */
 479 } xtafldinfo;
 480
 481
 482 /* fieldinfo ******************************************************************/
 483
 484 struct fieldinfo {            /* field of a class                                 */
 485         s4  flags;            /* ACC flags                                        */
 486         s4  type;             /* basic data type                                  */
 487         utf *name;            /* name of field                                    */
 488         utf *descriptor;      /* JavaVM descriptor string of field                */
 489
 490         s4  offset;           /* offset from start of object (instance variables) */
 491
 492         imm_union value;      /* storage for static values (class variables)      */
 493
 494         classinfo *class;     /* needed by typechecker. Could be optimized        */
 495                               /* away by using constant_FMIref instead of         */
 496                               /* fieldinfo throughout the compiler.               */
 497
 498         xtafldinfo *xta;
 499 };
 500
 501 struct basicblock;
 502
 503
 504 /* exceptiontable *************************************************************/
 505
 506 typedef struct xtable { /* exceptiontable entry in a method           */
 507         s4         startpc;         /* start pc of guarded area (inclusive)       */
 508         struct basicblock *start;
 509
 510         s4         endpc;           /* end pc of guarded area (exklusive)         */
 511         struct basicblock *end;
 512
 513         s4         handlerpc;       /* pc of exception handler                    */
 514         struct basicblock *handler;
 515
 516         classinfo *catchtype;       /* catchtype of exception (NULL == catchall)  */
 517         struct xtable *next;        /* used to build a list of exception when     */
 518                                     /* loops are copied */
 519         struct xtable *down;        /* instead of the old array, a list is used   */
 520 } xtable;
 521
 522
 523 typedef struct exceptiontable { /* exceptiontable entry in a method           */
 524         s4         startpc;         /* start pc of guarded area (inclusive)       */
 525         s4         endpc;           /* end pc of guarded area (exklusive)         */
 526         s4         handlerpc;       /* pc of exception handler                    */
 527         classinfo *catchtype;       /* catchtype of exception (NULL == catchall)  */
 528 } exceptiontable;
 529
 530
 531 /* methodinfo  static info ****************************************************/
 532 typedef struct xtainfo {
 533         s4          XTAmethodUsed;     /* XTA if used in callgraph - not used /used */
 534         classSet    *XTAclassSet;      /* method class type set                 */
 535         /*classSet      *PartClassSet */   /* method class type set                 */
 536
 537         classSetNode    *paramClassSet; /* cone set of methods parameters       */
 538
 539         methSet         *calls;            /* methods this method calls                 */
 540         methSet         *calledBy;         /* methods that call this method         */
 541         methSet         *marked;  //not in Dez         /* methods that marked by this method    */
 542         methSet         *markedBy;
 543         fldSet          *fldsUsed;         /* fields used by this method             */
 544         /*methSetNode  *interfaceCalls*/   /* methods this method calls as interface */
 545         bool           chgdSinceLastParse; /* Changed since last parse ?          */
 546 } xtainfo;
 547
 548
 549 /* lineinfo *****************************************************************/
 550 struct lineinfo {
 551         u2 start_pc;
 552         u2 line_number;
 553 };
 554
 555 /* methodinfo *****************************************************************/
 556
 557 struct methodinfo {                 /* method structure                       */
 558         s4             flags;               /* ACC flags                              */
 559         utf       *name;                /* name of method                         */
 560         utf       *descriptor;          /* JavaVM descriptor string of method     */
 561         s4         returntype;          /* only temporary valid, return type      */
 562         classinfo *returnclass;         /* pointer to classinfo for the rtn type  */ /*XTA*/
 563         s4         paramcount;          /* only temporary valid, parameter count  */
 564         u1        *paramtypes;          /* only temporary valid, parameter types  */
 565         classinfo **paramclass;         /* pointer to classinfo for a parameter   */ /*XTA*/
 566
 567         classinfo *class;               /* class, the method belongs to           */
 568         s4         vftblindex;          /* index of method in virtual function table
 569                                            (if it is a virtual method)            */
 570         s4         maxstack;            /* maximum stack depth of method          */
 571         s4         maxlocals;           /* maximum number of local variables      */
 572         s4         jcodelength;         /* length of JavaVM code                  */
 573         u1        *jcode;               /* pointer to JavaVM code                 */
 574
 575         s4         exceptiontablelength;/* exceptiontable length                  */
 576         exceptiontable *exceptiontable; /* the exceptiontable                     */
 577
 578         u2      thrownexceptionscount; /*number of exceptions declared to be thrown by a method*/
 579         classinfo **thrownexceptions;  /*array of classinfos of declared exceptions*/
 580
 581         u2      linenumbercount;        /*number of linenumber attributes*/
 582         lineinfo *linenumbers;          /*array of lineinfo items (start_pc,line_number)*/
 583
 584         u1        *stubroutine;         /* stub for compiling or calling natives  */
 585         s4         mcodelength;         /* legth of generated machine code        */
 586         u1        *mcode;               /* pointer to machine code                */
 587         u1        *entrypoint;          /* entry point in machine code            */
 588
 589         /*rtainfo   rta;*/
 590         xtainfo    *xta;
 591
 592         s4        methodUsed;           /* marked (might be used later) /not used /used */
 593         s4        monoPoly;             /* call is mono or poly or unknown        */ /*RT stats */
 594         /* should # method def'd and used be kept after static parse (will it be used?) */
 595         s4        subRedefs;
 596         s4        subRedefsUsed;
 597 };
 598
 599
 600 /* innerclassinfo *************************************************************/
 601
 602 typedef struct innerclassinfo {
 603         classinfo *inner_class;       /* inner class pointer                      */
 604         classinfo *outer_class;       /* outer class pointer                      */
 605         utf *name;                    /* innerclass name                          */
 606         s4 flags;                     /* ACC flags                                */
 607 } innerclassinfo;
 608
 609
 610 /* classinfo ******************************************************************/
 611
 612 struct classinfo {                /* class structure                          */
 613         java_objectheader header;     /* classes are also objects                 */
 614         java_objectarray* signers;
 615         struct java_security_ProtectionDomain* pd;
 616         struct java_lang_VMClass* vmClass;
 617         struct java_lang_reflect_Constructor* constructor;
 618
 619
 620         s4 initializing_thread;       /* gnu classpath */
 621         s4 erroneous_state;           /* gnu classpath */
 622         struct gnu_classpath_RawData* vmData; /* gnu classpath */
 623
 624         s4          flags;            /* ACC flags                                */
 625         utf        *name;             /* class name                               */
 626
 627         s4          cpcount;          /* number of entries in constant pool       */
 628         u1         *cptags;           /* constant pool tags                       */
 629         voidptr    *cpinfos;          /* pointer to constant pool info structures */
 630
 631         classinfo  *super;            /* super class pointer                      */
 632         classinfo  *sub;              /* sub class pointer                        */
 633         classinfo  *nextsub;          /* pointer to next class in sub class list  */
 634
 635         s4          interfacescount;  /* number of interfaces                     */
 636         classinfo **interfaces;       /* pointer to interfaces                    */
 637
 638         s4          fieldscount;      /* number of fields                         */
 639         fieldinfo  *fields;           /* field table                              */
 640
 641         s4          methodscount;     /* number of methods                        */
 642         methodinfo *methods;          /* method table                             */
 643
 644         listnode    listnode;         /* linkage                                  */
 645
 646         bool        initialized;      /* true, if class already initialised       */
 647         bool        loaded;           /* true, if class already loaded            */
 648         bool        linked;           /* true, if class already linked            */
 649         s4          index;            /* hierarchy depth (classes) or index
 650                                          (interfaces)                             */
 651         s4          instancesize;     /* size of an instance of this class        */
 652 #ifdef SIZE_FROM_CLASSINFO
 653         s4          alignedsize;      /* size of an instance, aligned to the
 654                                                                          allocation size on the heap              */
 655 #endif
 656
 657         vftbl      *vftbl;            /* pointer to virtual function table        */
 658
 659         methodinfo *finalizer;        /* finalizer method                         */
 660
 661     u2             innerclasscount;   /* number of inner classes              */
 662     innerclassinfo *innerclass;
 663
 664     classinfo      *hashlink;         /* link for external hash chain         */
 665         bool        classvftbl;       /* has its own copy of the Class vtbl       */
 666
 667         s4          classUsed;        /* 0= not used 1 = used   CO-RT             */
 668
 669         classSetNode *impldBy;        /* implemented by class set                 */
 670         utf        *packagename;      /* full name of the package                 */
 671         java_objectheader *classloader;       /* 0 for bootstrap classloader */
 672 };
 673
 674 /* check if class is an array class. Only use for linked classes! */
 675 #define CLASS_IS_ARRAY(clsinfo)  ((clsinfo)->vftbl->arraydesc != NULL)
 676
 677
 678 /* virtual function table ******************************************************
 679
 680         The vtbl has a bidirectional layout with open ends at both sides.
 681         interfacetablelength gives the number of entries of the interface table at
 682         the start of the vftbl. The vftbl pointer points to &interfacetable[0].
 683         vftbllength gives the number of entries of table at the end of the vftbl.
 684
 685         runtime type check (checkcast):
 686
 687         Different methods are used for runtime type check depending on the
 688         argument of checkcast/instanceof.
 689
 690         A check against a class is implemented via relative numbering on the class
 691         hierachy tree. The tree is numbered in a depth first traversal setting
 692         the base field and the diff field. The diff field gets the result of
 693         (high - base) so that a range check can be implemented by an unsigned
 694         compare. A sub type test is done by checking the inclusion of base of
 695         the sub class in the range of the superclass.
 696
 697         A check against an interface is implemented via the interfacevftbl. If the
 698         interfacevftbl contains a nonnull value a class is a subclass of this
 699         interface.
 700
 701         interfacetable:
 702
 703         Like standard virtual methods interface methods are called using
 704         virtual function tables. All interfaces are numbered sequentially
 705         (starting with zero). For each class there exist an interface table
 706         of virtual function tables for each implemented interface. The length
 707         of the interface table is determined by the highest number of an
 708         implemented interface.
 709
 710         The following example assumes a class which implements interface 0 and 3:
 711
 712         interfacetablelength = 4
 713
 714                   | ...       |            +----------+
 715                       +-----------+            | method 2 |---> method z
 716                       | class     |            | method 1 |---> method y
 717                       +-----------+            | method 0 |---> method x
 718                       | ivftbl  0 |----------> +----------+
 719         vftblptr ---> +-----------+
 720                   | ivftbl -1 |--> NULL    +----------+
 721                   | ivftbl -2 |--> NULL    | method 1 |---> method x
 722                   | ivftbl -3 |-----+      | method 0 |---> method a
 723                   +-----------+     +----> +----------+
 724
 725                               +---------------+
 726                                   | length 3 = 2  |
 727                                   | length 2 = 0  |
 728                                   | length 1 = 0  |
 729                                   | length 0 = 3  |
 730         interfacevftbllength ---> +---------------+
 731
 732 *******************************************************************************/
 733
 734 struct vftbl {
 735         methodptr   *interfacetable[1];    /* interface table (access via macro)  */
 736
 737         classinfo   *class;                /* class, the vtbl belongs to          */
 738
 739         arraydescriptor *arraydesc;        /* for array classes, otherwise NULL   */
 740
 741         s4           vftbllength;          /* virtual function table length       */
 742         s4           interfacetablelength; /* interface table length              */
 743
 744         s4           baseval;              /* base for runtime type check         */
 745                                            /* (-index for interfaces)             */
 746         s4           diffval;              /* high - base for runtime type check  */
 747
 748         s4          *interfacevftbllength; /* length of interface vftbls          */
 749
 750         methodptr    table[1];             /* class vftbl                         */
 751 };
 752
 753 #define VFTBLINTERFACETABLE(v,i)       (v)->interfacetable[-i]
 754
 755
 756 /* arraydescriptor ************************************************************
 757
 758     For every array class an arraydescriptor is allocated which
 759     describes the array class.
 760         The arraydescriptor is referenced from the vftbl of the array
 761         class.
 762
 763 *******************************************************************************/
 764
 765 struct arraydescriptor {
 766         vftbl *componentvftbl;   /* vftbl of the component type, NULL for primit. */
 767         vftbl *elementvftbl;     /* vftbl of the element type, NULL for primitive */
 768         short  arraytype;        /* ARRAYTYPE_* constant                          */
 769         short  dimension;        /* dimension of the array (always >= 1)          */
 770     s4     dataoffset;       /* offset of the array data from object pointer  */
 771         s4     componentsize;    /* size of a component in bytes                  */
 772         short  elementtype;      /* ARRAYTYPE_* constant                          */
 773 };
 774
 775
 776 /* references to some system classes ******************************************/
 777
 778 extern classinfo *class_java_lang_Object;
 779 extern classinfo *class_java_lang_String;
 780 extern classinfo *class_java_lang_Throwable;
 781 extern classinfo *class_java_lang_Cloneable;
 782 extern classinfo *class_java_io_Serializable;
 783 extern classinfo *class_java_lang_ClassCastException;
 784 extern classinfo *class_java_lang_NullPointerException;
 785 extern classinfo *class_java_lang_ArrayIndexOutOfBoundsException;
 786 extern classinfo *class_java_lang_NegativeArraySizeException;
 787 extern classinfo *class_java_lang_OutOfMemoryError;
 788 extern classinfo *class_java_lang_ArithmeticException;
 789 extern classinfo *class_java_lang_ArrayStoreException;
 790 extern classinfo *class_java_lang_ThreadDeath;
 791
 792 /* pseudo classes for the type checker ****************************************/
 793
 794 /*
 795  * pseudo_class_Arraystub
 796  *     (extends Object implements Cloneable, java.io.Serializable)
 797  *
 798  *     If two arrays of incompatible component types are merged,
 799  *     the resulting reference has no accessible components.
 800  *     The result does, however, implement the interfaces Cloneable
 801  *     and java.io.Serializable. This pseudo class is used internally
 802  *     to represent such results. (They are *not* considered arrays!)
 803  *
 804  * pseudo_class_Null
 805  *
 806  *     This pseudo class is used internally to represent the
 807  *     null type.
 808  *
 809  * pseudo_class_New
 810  *
 811  *     This pseudo class is used internally to represent the
 812  *     the 'uninitialized object' type.
 813  */
 814
 815 extern classinfo *pseudo_class_Arraystub;
 816 extern classinfo *pseudo_class_Null;
 817 extern classinfo *pseudo_class_New;
 818 extern vftbl *pseudo_class_Arraystub_vftbl;
 819
 820 extern utf *array_packagename;
 821
 822
 823 /* instances of some system classes *******************************************/
 824
 825 extern java_objectheader *proto_java_lang_ClassCastException;
 826 extern java_objectheader *proto_java_lang_NullPointerException;
 827 extern java_objectheader *proto_java_lang_ArrayIndexOutOfBoundsException;
 828 extern java_objectheader *proto_java_lang_NegativeArraySizeException;
 829 extern java_objectheader *proto_java_lang_OutOfMemoryError;
 830 extern java_objectheader *proto_java_lang_ArithmeticException;
 831 extern java_objectheader *proto_java_lang_ArrayStoreException;
 832 extern java_objectheader *proto_java_lang_ThreadDeath;
 833
 834
 835 /* flag variables *************************************************************/
 836
 837 extern bool compileall;
 838 extern bool runverbose;
 839 extern bool verbose;
 840 extern bool opt_rt;             /* Rapid Type Analysis for better inlining CO-RT*/
 841 extern bool opt_xta;            /* X Type Analysis for better inlining    CO-XTA*/
 842 extern bool opt_vta;            /* Variable Type Analysis for better inlining    CO-VTA*/
 843 extern bool opt_verify;         /* true if classfiles should be verified      */
 844 #ifdef TYPECHECK_VERBOSE_OPT
 845 extern bool typecheckverbose;
 846 #endif
 847
 848 /*extern int pClassHeir;*/
 849 /*extern int pCallgraph;*/
 850 /*extern int pOpcodes;*/
 851 /*extern int pStats;*/
 852
 853 /*extern void RT_jit_parse(methodinfo *m);*/
 854
 855
 856 /* statistic variables ********************************************************/
 857
 858 extern int count_class_infos;
 859 extern int count_const_pool_len;
 860 extern int count_vftbl_len;
 861 extern int count_utf_len;
 862 extern int count_all_methods;
 863 extern int count_vmcode_len;
 864 extern int count_extable_len;
 865 extern int count_class_loads;
 866 extern int count_class_inits;
 867 extern int count_utf_new;
 868 extern int count_utf_new_found;
 869
 870
 871 /* table of primitive types ***************************************************/
 872
 873 /* This array can be indexed by the PRIMITIVETYPE_ and ARRAYTYPE_
 874  * constants (except ARRAYTYPE_OBJECT).
 875  */
 876 extern primitivetypeinfo primitivetype_table[PRIMITIVETYPE_COUNT];
 877
 878
 879 /* macros for descriptor parsing **********************************************/
 880
 881 /* SKIP_FIELDDESCRIPTOR:
 882  * utf_ptr must point to the first character of a field descriptor.
 883  * After the macro call utf_ptr points to the first character after
 884  * the field descriptor.
 885  *
 886  * CAUTION: This macro does not check for an unexpected end of the
 887  * descriptor. Better use SKIP_FIELDDESCRIPTOR_SAFE.
 888  */
 889 #define SKIP_FIELDDESCRIPTOR(utf_ptr)                                                   \
 890         do { while (*(utf_ptr)=='[') (utf_ptr)++;                                       \
 891                 if (*(utf_ptr)++=='L')                                                                  \
 892                         while(*(utf_ptr)++ != ';') /* skip */; } while(0)
 893
 894 /* SKIP_FIELDDESCRIPTOR_SAFE:
 895  * utf_ptr must point to the first character of a field descriptor.
 896  * After the macro call utf_ptr points to the first character after
 897  * the field descriptor.
 898  *
 899  * Input:
 900  *     utf_ptr....points to first char of descriptor
 901  *     end_ptr....points to first char after the end of the string
 902  *     errorflag..must be initialized (to false) by the caller!
 903  * Output:
 904  *     utf_ptr....points to first char after the descriptor
 905  *     errorflag..set to true if the string ended unexpectedly
 906  */
 907 #define SKIP_FIELDDESCRIPTOR_SAFE(utf_ptr,end_ptr,errorflag)                    \
 908         do { while ((utf_ptr) != (end_ptr) && *(utf_ptr)=='[') (utf_ptr)++;     \
 909                 if ((utf_ptr) == (end_ptr))                                                                             \
 910                         (errorflag) = true;                                                                                     \
 911                 else                                                                                                                    \
 912                         if (*(utf_ptr)++=='L') {                                                                        \
 913                                 while((utf_ptr) != (end_ptr) && *(utf_ptr)++ != ';')    \
 914                                         /* skip */;                                                                                     \
 915                                 if ((utf_ptr)[-1] != ';')                                                               \
 916                                         (errorflag) = true; }} while(0)
 917
 918
 919 /* Synchronization ************************************************************/
 920
 921 #if defined(USE_THREADS) && defined(NATIVE_THREADS)
 922 extern pthread_mutex_t compiler_mutex;
 923 extern int cast_counter;
 924
 925 void cast_lock();
 926 void cast_lock2();
 927 void cast_unlock();
 928 #endif
 929
 930 #endif /* _GLOBAL_H */
 931
 932
 933 /*
 934  * These are local overrides for various environment variables in Emacs.
 935  * Please do not remove this and leave it at the end of the file, where
 936  * Emacs will automagically detect them.
 937  * ---------------------------------------------------------------------
 938  * Local variables:
 939  * mode: c
 940  * indent-tabs-mode: t
 941  * c-basic-offset: 4
 942  * tab-width: 4
 943  * End:
 944  */