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 4529 2006-02-20 23:35:08Z twisti $
  37
  38 */
  39
  40
  41 #ifndef _GLOBAL_H
  42 #define _GLOBAL_H
  43
  44 #include "config.h"
  45 #include "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 int   bool;                     /* boolean data type                  */
  55
  56 #define true  1
  57 #define false 0
  58
  59
  60 /* immediate data union */
  61
  62 typedef union {
  63         s4          i;
  64         s8          l;
  65         float       f;
  66         double      d;
  67         void       *a;
  68         functionptr fp;
  69         u1          b[8];
  70 } imm_union;
  71
  72
  73 /* forward typedefs ***********************************************************/
  74
  75 typedef struct java_objectheader java_objectheader;
  76 typedef struct java_objectarray java_objectarray;
  77
  78
  79 /* define some CACAO paths ****************************************************/
  80
  81 #if defined(ENABLE_ZLIB)
  82 # define CACAO_VM_ZIP_PATH          CACAO_PREFIX "/share/cacao/" VM_ZIP_STRING
  83 #else
  84 # define CACAO_VM_ZIP_PATH          CACAO_PREFIX "/share/cacao/"
  85 #endif
  86
  87 #define CLASSPATH_GLIBJ_ZIP_PATH    CLASSPATH_PREFIX "/share/classpath/" GLIBJ_ZIP_STRING
  88 #define CLASSPATH_LIBRARY_PATH      CLASSPATH_LIBDIR "/classpath"
  89
  90
  91 /*
  92  * ENABLE_VERIFIER activates bytecode verification and other checks
  93  */
  94 #define ENABLE_VERIFIER
  95
  96 /*
  97  * TYPECHECK_STACK_COMPCAT activates full checking of computational
  98  * categories for stack manipulations (POP,POP2,SWAP,DUP,DUP2,DUP_X1,
  99  * DUP2_X1,DUP_X2,DUP2_X2).
 100  */
 101 #define TYPECHECK_STACK_COMPCAT
 102
 103 /* if we have threads disabled this one is not defined ************************/
 104
 105 #if !defined(USE_THREADS)
 106 #define THREADSPECIFIC
 107 #endif
 108
 109
 110 #define MAX_ALIGN 8             /* most generic alignment for JavaVM values   */
 111
 112
 113 /* basic data types ***********************************************************/
 114
 115 /* CAUTION: jit/jit.h relies on these numerical values! */
 116 #define TYPE_INT      0         /* the JavaVM types must numbered in the      */
 117 #define TYPE_LONG     1         /* same order as the ICMD_Ixxx to ICMD_Axxx   */
 118 #define TYPE_FLOAT    2         /* instructions (LOAD and STORE)              */
 119 #define TYPE_DOUBLE   3         /* integer, long, float, double, address      */
 120 #define TYPE_ADDRESS  4         /* all other types can be numbered arbitrarly */
 121
 122 #define TYPE_VOID    10
 123
 124 /* primitive data types *******************************************************/
 125
 126 /* These values are used in parsed descriptors and in some other places       */
 127 /* were the different types handled internally as TYPE_INT have to be         */
 128 /* 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_LONG
 137 #define PRIMITIVETYPE_FLOAT   TYPE_FLOAT
 138 #define PRIMITIVETYPE_DOUBLE  TYPE_DOUBLE
 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
 201
 202 /* data structure for calls from c code to java methods */
 203
 204 struct jni_callblock {
 205         u8 itemtype;
 206         u8 item;
 207 };
 208
 209 typedef struct jni_callblock jni_callblock;
 210
 211
 212 /* data structures of the runtime system **************************************/
 213
 214 /* java_objectheader ***********************************************************
 215
 216    All objects (and arrays) which resides on the heap need the
 217    following header at the beginning of the data structure.
 218
 219 *******************************************************************************/
 220
 221 struct java_objectheader {              /* header for all objects             */
 222         struct _vftbl *vftbl;               /* pointer to virtual function table  */
 223 #if defined(USE_THREADS) && defined(NATIVE_THREADS)
 224         void          *monitorPtr;
 225 #endif
 226 };
 227
 228
 229 /* arrays **********************************************************************
 230
 231         All arrays are objects (they need the object header with a pointer
 232         to a vftbl (array class table). There is one class for each array
 233         type. The array type is described by an arraydescriptor struct
 234         which is referenced by the vftbl.
 235 */
 236
 237 /* CAUTION: Don't change the numerical values! These constants (with
 238  * the exception of ARRAYTYPE_OBJECT) are used as indices in the
 239  * primitive type table.
 240  */
 241 #define ARRAYTYPE_INT      PRIMITIVETYPE_INT
 242 #define ARRAYTYPE_LONG     PRIMITIVETYPE_LONG
 243 #define ARRAYTYPE_FLOAT    PRIMITIVETYPE_FLOAT
 244 #define ARRAYTYPE_DOUBLE   PRIMITIVETYPE_DOUBLE
 245 #define ARRAYTYPE_BYTE     PRIMITIVETYPE_BYTE
 246 #define ARRAYTYPE_CHAR     PRIMITIVETYPE_CHAR
 247 #define ARRAYTYPE_SHORT    PRIMITIVETYPE_SHORT
 248 #define ARRAYTYPE_BOOLEAN  PRIMITIVETYPE_BOOLEAN
 249 #define ARRAYTYPE_OBJECT   PRIMITIVETYPE_VOID     /* don't use as index! */
 250
 251 typedef struct java_arrayheader {       /* header for all arrays              */
 252         java_objectheader objheader;        /* object header                      */
 253         s4 size;                            /* array size                         */
 254 } java_arrayheader;
 255
 256
 257
 258 /* structs for all kinds of arrays ********************************************/
 259
 260 /*  booleanarray and bytearray need identical memory layout (access methods
 261     use the same machine code */
 262
 263 typedef struct java_booleanarray {
 264         java_arrayheader header;
 265         u1 data[1];
 266 } java_booleanarray;
 267
 268 typedef struct java_bytearray {
 269         java_arrayheader header;
 270         s1 data[1];
 271 } java_bytearray;
 272
 273 typedef struct java_chararray {
 274         java_arrayheader header;
 275         u2 data[1];
 276 } java_chararray;
 277
 278 typedef struct java_shortarray {
 279         java_arrayheader header;
 280         s2 data[1];
 281 } java_shortarray;
 282
 283 typedef struct java_intarray {
 284         java_arrayheader header;
 285         s4 data[1];
 286 } java_intarray;
 287
 288 typedef struct java_longarray {
 289         java_arrayheader header;
 290         s8 data[1];
 291 } java_longarray;
 292
 293 typedef struct java_floatarray {
 294         java_arrayheader header;
 295         float data[1];
 296 } java_floatarray;
 297
 298 typedef struct java_doublearray {
 299         java_arrayheader header;
 300         double data[1];
 301 } java_doublearray;
 302
 303 /*  objectarray and arrayarray need identical memory layout (access methods
 304     use the same machine code */
 305
 306 struct java_objectarray {
 307         java_arrayheader   header;
 308         java_objectheader *data[1];
 309 };
 310
 311
 312 #define VFTBLINTERFACETABLE(v,i)       (v)->interfacetable[-i]
 313
 314
 315 /* flag variables *************************************************************/
 316
 317 extern bool cacao_initializing;
 318
 319
 320 /* Synchronization ************************************************************/
 321
 322 #if defined(USE_THREADS) && defined(NATIVE_THREADS)
 323 void cast_lock();
 324 void cast_unlock();
 325 void compiler_lock();
 326 void compiler_unlock();
 327 #endif
 328
 329
 330 /**** Methods: called directly by cacao, which defines the callpath ***/
 331 #define MAINCLASS mainstring
 332 #define MAINMETH "main"
 333 #define MAINDESC "([Ljava/lang/String;)V"
 334
 335 #define EXITCLASS "java/lang/System"
 336 #define EXITMETH  "exit"
 337 #define EXITDESC  "(I)V"
 338
 339 #if defined(USE_THREADS)
 340  #define THREADCLASS "java/lang/Thread"
 341  #define THREADMETH  "<init>"
 342  #define THREADDESC  "(Ljava/lang/VMThread;Ljava/lang/String;IZ)V"
 343
 344  #define THREADGROUPCLASS "java/lang/ThreadGroup"
 345  #define THREADGROUPMETH  "addThread"
 346  #define THREADGROUPDESC  "(Ljava/lang/Thread;)V"
 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  */