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