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