src/vm/global.h

   1 /* src/vm/global.h - global definitions
   2
   3    Copyright (C) 1996-2005, 2006 R. Grafl, A. Krall, C. Kruegel,
   4    C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
   5    E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
   6    J. Wenninger, Institut f. Computersprachen - TU Wien
   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., 51 Franklin Street, Fifth Floor, Boston, MA
  23    02110-1301, USA.
  24
  25    Contact: cacao@cacaojvm.org
  26
  27    Authors: Reinhard Grafl
  28             Andreas Krall
  29             Mark Probst
  30             Philipp Tomsich
  31             Edwin Steiner
  32             Joseph Wenninger
  33             Christian Thalinger
  34
  35    $Id: global.h 7413 2007-02-27 21:51:17Z twisti $
  36
  37 */
  38
  39
  40 #ifndef _GLOBAL_H
  41 #define _GLOBAL_H
  42
  43 #include "config.h"
  44 #include "vm/types.h"
  45
  46
  47 /* additional data types ******************************************************/
  48
  49 typedef void *voidptr;                  /* generic pointer                    */
  50 typedef void (*functionptr) (void);     /* generic function pointer           */
  51 typedef u1* methodptr;
  52
  53 typedef unsigned int bool;              /* boolean data type                  */
  54
  55 #define true         1
  56 #define false        0
  57
  58
  59 #if defined(ENABLE_SSA)
  60 /* immediate to get an addidional target Local Var Index */
  61 /* for IINC in Combination with SSA */
  62 struct imm {
  63         s4 i;
  64         s4 op1_t;
  65 };
  66 #endif
  67
  68 /* immediate data union */
  69
  70 typedef union {
  71         s4          i;
  72         s8          l;
  73         float       f;
  74         double      d;
  75         void       *a;
  76         functionptr fp;
  77         u1          b[8];
  78 #if defined(ENABLE_SSA)
  79         struct imm  _i;
  80 #endif
  81 } imm_union;
  82
  83
  84 /* forward typedefs ***********************************************************/
  85
  86 typedef struct java_objectheader java_objectheader;
  87 typedef struct java_objectarray java_objectarray;
  88
  89
  90 #define MAX_ALIGN 8             /* most generic alignment for JavaVM values   */
  91
  92
  93 /* basic data types ***********************************************************/
  94
  95 /* The JavaVM types must numbered in the same order as the ICMD_Ixxx
  96    to ICMD_Axxx instructions (LOAD and STORE).  All other types can be
  97    numbered arbitrarily. */
  98
  99 #define TYPE_INT     0
 100 #define TYPE_LNG     1
 101 #define TYPE_FLT     2
 102 #define TYPE_DBL     3
 103 #define TYPE_ADR     4
 104
 105 #define TYPE_RET     8   /* must not share bits with TYPE_FLT or TYPE_LNG */
 106
 107 #define TYPE_VOID    10
 108
 109
 110 #define IS_INT_LNG_TYPE(a)      (!((a) & TYPE_FLT))
 111 #define IS_FLT_DBL_TYPE(a)      ((a) & TYPE_FLT)
 112 #define IS_2_WORD_TYPE(a)       ((a) & TYPE_LNG)
 113
 114 #define IS_INT_TYPE(a)          ((a) == TYPE_INT)
 115 #define IS_LNG_TYPE(a)          ((a) == TYPE_LNG)
 116 #define IS_FLT_TYPE(a)          ((a) == TYPE_FLT)
 117 #define IS_DBL_TYPE(a)          ((a) == TYPE_DBL)
 118 #define IS_ADR_TYPE(a)          ((a) == TYPE_ADR)
 119
 120 #define IS_VOID_TYPE(a)         ((a) == TYPE_VOID)
 121
 122
 123 /* primitive data types *******************************************************/
 124
 125 /* These values are used in parsed descriptors and in some other
 126    places were the different types handled internally as TYPE_INT have
 127    to be distinguished. */
 128
 129 #define PRIMITIVETYPE_COUNT  11  /* number of primitive types (+ dummies)     */
 130
 131 /* CAUTION: Don't change the numerical values! These constants are
 132    used as indices into the primitive type table. */
 133
 134 #define PRIMITIVETYPE_INT     TYPE_INT
 135 #define PRIMITIVETYPE_LONG    TYPE_LNG
 136 #define PRIMITIVETYPE_FLOAT   TYPE_FLT
 137 #define PRIMITIVETYPE_DOUBLE  TYPE_DBL
 138 #define PRIMITIVETYPE_DUMMY1  TYPE_ADR     /* not used! */
 139 #define PRIMITIVETYPE_BYTE    5
 140 #define PRIMITIVETYPE_CHAR    6
 141 #define PRIMITIVETYPE_SHORT   7
 142 #define PRIMITIVETYPE_BOOLEAN 8
 143 #define PRIMITIVETYPE_DUMMY2  9            /* not used! */
 144 #define PRIMITIVETYPE_VOID    TYPE_VOID
 145
 146 /* some Java related defines **************************************************/
 147
 148 #define JAVA_VERSION    "1.5.0"         /* this version is supported by CACAO */
 149 #define CLASS_VERSION   "50.0"
 150
 151
 152 /* Java class file constants **************************************************/
 153
 154 #define MAGIC             0xCAFEBABE
 155 #define MAJOR_VERSION     50
 156 #define MINOR_VERSION     0
 157
 158
 159 /* Constant pool tags *********************************************************/
 160
 161 #define CONSTANT_Class                 7
 162 #define CONSTANT_Fieldref              9
 163 #define CONSTANT_Methodref            10
 164 #define CONSTANT_InterfaceMethodref   11
 165 #define CONSTANT_String                8
 166 #define CONSTANT_Integer               3
 167 #define CONSTANT_Float                 4
 168 #define CONSTANT_Long                  5
 169 #define CONSTANT_Double                6
 170 #define CONSTANT_NameAndType          12
 171 #define CONSTANT_Utf8                  1
 172
 173 #define CONSTANT_UNUSED                0
 174
 175
 176 /* Class/Field/Method access and property flags *******************************/
 177
 178 #define ACC_UNDEF               -1      /* used internally                    */
 179 #define ACC_NONE                 0      /* used internally                    */
 180
 181 #define ACC_PUBLIC          0x0001
 182 #define ACC_PRIVATE         0x0002
 183 #define ACC_PROTECTED       0x0004
 184 #define ACC_STATIC          0x0008
 185 #define ACC_FINAL           0x0010
 186 #define ACC_SUPER           0x0020
 187 #define ACC_SYNCHRONIZED    0x0020
 188 #define ACC_VOLATILE        0x0040
 189 #define ACC_BRIDGE          0x0040
 190 #define ACC_TRANSIENT       0x0080
 191 #define ACC_VARARGS         0x0080
 192 #define ACC_NATIVE          0x0100
 193 #define ACC_INTERFACE       0x0200
 194 #define ACC_ABSTRACT        0x0400
 195 #define ACC_STRICT          0x0800
 196 #define ACC_SYNTHETIC       0x1000
 197 #define ACC_ANNOTATION      0x2000
 198 #define ACC_ENUM            0x4000
 199 #define ACC_MIRANDA         0x8000
 200
 201 /* special flags used in classinfo ********************************************/
 202
 203 #define ACC_CLASS_REFLECT_MASK      0x0000ffff/* flags reported by reflection */
 204
 205 #define ACC_CLASS_HAS_POINTERS      0x00010000/* instance contains pointers   */
 206 #define ACC_CLASS_SOFT_REFERENCE    0x00020000
 207 #define ACC_CLASS_WEAK_REFERENCE    0x00040000
 208 #define ACC_CLASS_PHANTOM_REFERENCE 0x00080000
 209
 210
 211 /* special flags used in methodinfo *******************************************/
 212
 213 #define ACC_METHOD_IMPLEMENTED 0x00010000     /* there is an implementation   */
 214 #define ACC_METHOD_MONOMORPHIC 0x00020000     /* currently monomorphic method */
 215
 216
 217 /* data structures of the runtime system **************************************/
 218
 219 /* java_objectheader ***********************************************************
 220
 221    All objects (and arrays) which resides on the heap need the
 222    following header at the beginning of the data structure.
 223
 224    TODO: Include detailed description from the Wiki (ObjectHeader) here.
 225
 226 *******************************************************************************/
 227
 228 #define HDRFLAG_FLC 0x01
 229
 230 struct java_objectheader {             /* header for all objects              */
 231         struct _vftbl            *vftbl;   /* pointer to virtual function table   */
 232 #if defined(ENABLE_THREADS)
 233         struct lock_record_t *monitorPtr;
 234 #endif
 235 #if defined(ENABLE_THREADS) || defined(ENABLE_GC_CACAO)
 236         ptrint                hdrflags;    /* word containing the FLC and GC bits */
 237 #endif
 238 };
 239
 240
 241 /* arrays **********************************************************************
 242
 243         All arrays are objects (they need the object header with a pointer
 244         to a vftbl (array class table). There is one class for each array
 245         type. The array type is described by an arraydescriptor struct
 246         which is referenced by the vftbl.
 247 */
 248
 249 /* CAUTION: Don't change the numerical values! These constants (with
 250  * the exception of ARRAYTYPE_OBJECT) are used as indices in the
 251  * primitive type table.
 252  */
 253 #define ARRAYTYPE_INT      PRIMITIVETYPE_INT
 254 #define ARRAYTYPE_LONG     PRIMITIVETYPE_LONG
 255 #define ARRAYTYPE_FLOAT    PRIMITIVETYPE_FLOAT
 256 #define ARRAYTYPE_DOUBLE   PRIMITIVETYPE_DOUBLE
 257 #define ARRAYTYPE_BYTE     PRIMITIVETYPE_BYTE
 258 #define ARRAYTYPE_CHAR     PRIMITIVETYPE_CHAR
 259 #define ARRAYTYPE_SHORT    PRIMITIVETYPE_SHORT
 260 #define ARRAYTYPE_BOOLEAN  PRIMITIVETYPE_BOOLEAN
 261 #define ARRAYTYPE_OBJECT   PRIMITIVETYPE_VOID     /* don't use as index! */
 262
 263 typedef struct java_arrayheader {       /* header for all arrays              */
 264         java_objectheader objheader;        /* object header                      */
 265         s4 size;                            /* array size                         */
 266 } java_arrayheader;
 267
 268
 269
 270 /* structs for all kinds of arrays ********************************************/
 271
 272 /*  booleanarray and bytearray need identical memory layout (access methods
 273     use the same machine code */
 274
 275 typedef struct java_booleanarray {
 276         java_arrayheader header;
 277         u1 data[1];
 278 } java_booleanarray;
 279
 280 typedef struct java_bytearray {
 281         java_arrayheader header;
 282         s1 data[1];
 283 } java_bytearray;
 284
 285 typedef struct java_chararray {
 286         java_arrayheader header;
 287         u2 data[1];
 288 } java_chararray;
 289
 290 typedef struct java_shortarray {
 291         java_arrayheader header;
 292         s2 data[1];
 293 } java_shortarray;
 294
 295 typedef struct java_intarray {
 296         java_arrayheader header;
 297         s4 data[1];
 298 } java_intarray;
 299
 300 typedef struct java_longarray {
 301         java_arrayheader header;
 302         s8 data[1];
 303 } java_longarray;
 304
 305 typedef struct java_floatarray {
 306         java_arrayheader header;
 307         float data[1];
 308 } java_floatarray;
 309
 310 typedef struct java_doublearray {
 311         java_arrayheader header;
 312         double data[1];
 313 } java_doublearray;
 314
 315 /*  objectarray and arrayarray need identical memory layout (access methods
 316     use the same machine code */
 317
 318 struct java_objectarray {
 319         java_arrayheader   header;
 320         java_objectheader *data[1];
 321 };
 322
 323
 324 /* Synchronization ************************************************************/
 325
 326 #if defined(ENABLE_THREADS)
 327 void compiler_lock();
 328 void compiler_unlock();
 329 #endif
 330
 331
 332 /* global constants related to the verifier ***********************************/
 333
 334 /* The verifier needs additional variables in the variable array. Since these */
 335 /* must be reserved and set by parse.c and stack.c, we define these numbers   */
 336 /* here to avoid mysterious hard-coded constants.                             */
 337 /* stack.c needs an extra variable if the verifier is disabled.               */
 338
 339 #if defined(ENABLE_VERIFIER)
 340 #    define VERIFIER_EXTRA_LOCALS  1
 341 #    define VERIFIER_EXTRA_VARS    1
 342 #    define STACK_EXTRA_VARS       0
 343 #else
 344 #    define VERIFIER_EXTRA_LOCALS  0
 345 #    define VERIFIER_EXTRA_VARS    0
 346 #    define STACK_EXTRA_VARS       1
 347 #endif
 348
 349 #endif /* _GLOBAL_H */
 350
 351
 352 /*
 353  * These are local overrides for various environment variables in Emacs.
 354  * Please do not remove this and leave it at the end of the file, where
 355  * Emacs will automagically detect them.
 356  * ---------------------------------------------------------------------
 357  * Local variables:
 358  * mode: c
 359  * indent-tabs-mode: t
 360  * c-basic-offset: 4
 361  * tab-width: 4
 362  * End:
 363  * vim:noexpandtab:sw=4:ts=4:
 364  */