src/vm/global.h

   1 /* src/vm/global.h - global definitions
   2
   3    Copyright (C) 1996-2005 R. Grafl, A. Krall, C. Kruegel, C. Oates,
   4    R. Obermaisser, M. Platter, M. Probst, S. Ring, E. Steiner,
   5    C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich, J. Wenninger,
   6    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., 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             Joseph Wenninger
  34             Christian Thalinger
  35
  36    $Id: global.h 3313 2005-09-29 14:31:21Z 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 /* some Java related defines **************************************************/
  80
  81 #define JAVA_VERSION    "1.4.2"         /* this version is supported by CACAO */
  82
  83
  84 /* define some CACAO paths ****************************************************/
  85
  86 #define CACAO_VM_ZIP_PATH           "/share/cacao/vm.zip"
  87 #define CLASSPATH_LIBRARY_PATH      "/lib/classpath"
  88 #define CLASSPATH_GLIBJ_ZIP_PATH    "/share/classpath/glibj.zip"
  89
  90
  91 /*
  92  * CACAO_TYPECHECK activates typechecking (part of bytecode verification)
  93  */
  94 #define CACAO_TYPECHECK
  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 /* Java class file constants **************************************************/
 148
 149 #define MAGIC             0xCAFEBABE
 150 #define MAJOR_VERSION     48
 151 #define MINOR_VERSION     0
 152
 153
 154 /* Constant pool tags *********************************************************/
 155
 156 #define CONSTANT_Class                 7
 157 #define CONSTANT_Fieldref              9
 158 #define CONSTANT_Methodref            10
 159 #define CONSTANT_InterfaceMethodref   11
 160 #define CONSTANT_String                8
 161 #define CONSTANT_Integer               3
 162 #define CONSTANT_Float                 4
 163 #define CONSTANT_Long                  5
 164 #define CONSTANT_Double                6
 165 #define CONSTANT_NameAndType          12
 166 #define CONSTANT_Utf8                  1
 167
 168 #define CONSTANT_UNUSED                0
 169
 170
 171 /* Class/Field/Method access and property flags *******************************/
 172
 173 #define ACC_UNDEF               -1      /* used internally                    */
 174 #define ACC_NONE                 0      /* used internally                    */
 175
 176 #define ACC_PUBLIC          0x0001
 177 #define ACC_PRIVATE         0x0002
 178 #define ACC_PROTECTED       0x0004
 179 #define ACC_STATIC          0x0008
 180 #define ACC_FINAL           0x0010
 181 #define ACC_SUPER           0x0020
 182 #define ACC_SYNCHRONIZED    0x0020
 183 #define ACC_VOLATILE        0x0040
 184 #define ACC_BRIDGE          0x0040
 185 #define ACC_TRANSIENT       0x0080
 186 #define ACC_VARARGS         0x0080
 187 #define ACC_NATIVE          0x0100
 188 #define ACC_INTERFACE       0x0200
 189 #define ACC_ABSTRACT        0x0400
 190 #define ACC_STRICT          0x0800
 191 #define ACC_SYNTHETIC       0x1000
 192 #define ACC_ANNOTATION      0x2000
 193 #define ACC_ENUM            0x4000
 194
 195
 196 /* data structure for calls from c code to java methods */
 197
 198 struct jni_callblock {
 199         u8 itemtype;
 200         u8 item;
 201 };
 202
 203 typedef struct jni_callblock jni_callblock;
 204
 205
 206 /* data structures of the runtime system **************************************/
 207
 208 /* java_objectheader ***********************************************************
 209
 210    All objects (and arrays) which resides on the heap need the
 211    following header at the beginning of the data structure.
 212
 213 *******************************************************************************/
 214
 215 struct java_objectheader {              /* header for all objects             */
 216         struct _vftbl *vftbl;               /* pointer to virtual function table  */
 217 #if defined(USE_THREADS) && defined(NATIVE_THREADS)
 218         void          *monitorPtr;
 219 #endif
 220 };
 221
 222
 223 /* arrays **********************************************************************
 224
 225         All arrays are objects (they need the object header with a pointer
 226         to a vftbl (array class table). There is one class for each array
 227         type. The array type is described by an arraydescriptor struct
 228         which is referenced by the vftbl.
 229 */
 230
 231 /* CAUTION: Don't change the numerical values! These constants (with
 232  * the exception of ARRAYTYPE_OBJECT) are used as indices in the
 233  * primitive type table.
 234  */
 235 #define ARRAYTYPE_INT      PRIMITIVETYPE_INT
 236 #define ARRAYTYPE_LONG     PRIMITIVETYPE_LONG
 237 #define ARRAYTYPE_FLOAT    PRIMITIVETYPE_FLOAT
 238 #define ARRAYTYPE_DOUBLE   PRIMITIVETYPE_DOUBLE
 239 #define ARRAYTYPE_BYTE     PRIMITIVETYPE_BYTE
 240 #define ARRAYTYPE_CHAR     PRIMITIVETYPE_CHAR
 241 #define ARRAYTYPE_SHORT    PRIMITIVETYPE_SHORT
 242 #define ARRAYTYPE_BOOLEAN  PRIMITIVETYPE_BOOLEAN
 243 #define ARRAYTYPE_OBJECT   PRIMITIVETYPE_VOID     /* don't use as index! */
 244
 245 typedef struct java_arrayheader {       /* header for all arrays              */
 246         java_objectheader objheader;        /* object header                      */
 247         s4 size;                            /* array size                         */
 248 } java_arrayheader;
 249
 250
 251
 252 /* structs for all kinds of arrays ********************************************/
 253
 254 typedef struct java_chararray {
 255         java_arrayheader header;
 256         u2 data[1];
 257 } java_chararray;
 258
 259 typedef struct java_floatheader {
 260         java_arrayheader header;
 261         float data[1];
 262 } java_floatarray;
 263
 264 typedef struct java_doublearray {
 265         java_arrayheader header;
 266         double data[1];
 267 } java_doublearray;
 268
 269 /*  booleanarray and bytearray need identical memory layout (access methods
 270     use the same machine code */
 271
 272 typedef struct java_booleanarray {
 273         java_arrayheader header;
 274         u1 data[1];
 275 } java_booleanarray;
 276
 277 typedef struct java_bytearray {
 278         java_arrayheader header;
 279         s1 data[1];
 280 } java_bytearray;
 281
 282 typedef struct java_shortarray {
 283         java_arrayheader header;
 284         s2 data[1];
 285 } java_shortarray;
 286
 287 typedef struct java_intarray {
 288         java_arrayheader header;
 289         s4 data[1];
 290 } java_intarray;
 291
 292 typedef struct java_longarray {
 293         java_arrayheader header;
 294         s8 data[1];
 295 } java_longarray;
 296
 297 /*  objectarray and arrayarray need identical memory layout (access methods
 298     use the same machine code */
 299
 300 struct java_objectarray {
 301         java_arrayheader   header;
 302         java_objectheader *data[1];
 303 };
 304
 305
 306 #define VFTBLINTERFACETABLE(v,i)       (v)->interfacetable[-i]
 307
 308
 309 /* flag variables *************************************************************/
 310
 311 extern bool cacao_initializing;
 312
 313
 314 /* Synchronization ************************************************************/
 315
 316 #if defined(USE_THREADS) && defined(NATIVE_THREADS)
 317 void cast_lock();
 318 void cast_unlock();
 319 void compiler_lock();
 320 void compiler_unlock();
 321 #endif
 322
 323
 324 /**** Methods: called directly by cacao, which defines the callpath ***/
 325 #define MAINCLASS mainstring
 326 #define MAINMETH "main"
 327 #define MAINDESC "([Ljava/lang/String;)V"
 328
 329 #define EXITCLASS "java/lang/System"
 330 #define EXITMETH  "exit"
 331 #define EXITDESC  "(I)V"
 332
 333 #if defined(USE_THREADS)
 334  #define THREADCLASS "java/lang/Thread"
 335  #define THREADMETH  "<init>"
 336  #define THREADDESC  "(Ljava/lang/VMThread;Ljava/lang/String;IZ)V"
 337
 338  #define THREADGROUPCLASS "java/lang/ThreadGroup"
 339  #define THREADGROUPMETH  "addThread"
 340  #define THREADGROUPDESC  "(Ljava/lang/Thread;)V"
 341 #endif
 342
 343 #endif /* _GLOBAL_H */
 344
 345
 346 /*
 347  * These are local overrides for various environment variables in Emacs.
 348  * Please do not remove this and leave it at the end of the file, where
 349  * Emacs will automagically detect them.
 350  * ---------------------------------------------------------------------
 351  * Local variables:
 352  * mode: c
 353  * indent-tabs-mode: t
 354  * c-basic-offset: 4
 355  * tab-width: 4
 356  * End:
 357  */