src/vmcore/class.h

   1 /* src/vmcore/class.h - class related functions header
   2
   3    Copyright (C) 1996-2005, 2006, 2007 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    $Id: class.h 8321 2007-08-16 11:37:25Z michi $
  26
  27 */
  28
  29
  30 #ifndef _CLASS_H
  31 #define _CLASS_H
  32
  33 /* forward typedefs ***********************************************************/
  34
  35 typedef struct classinfo      classinfo;
  36 typedef struct innerclassinfo innerclassinfo;
  37 typedef struct extra_classref extra_classref;
  38 typedef struct castinfo       castinfo;
  39
  40
  41 #include "config.h"
  42
  43 #include <stdint.h>
  44
  45 #include "vm/types.h"
  46
  47 #include "toolbox/list.h"
  48
  49 #include "vm/global.h"
  50
  51 #if defined(ENABLE_JAVASE)
  52 # include "vmcore/annotation.h"
  53 #endif
  54
  55 #include "vmcore/field.h"
  56 #include "vmcore/linker.h"
  57 #include "vmcore/loader.h"
  58 #include "vmcore/method.h"
  59 #include "vmcore/references.h"
  60 #include "vmcore/utf8.h"
  61
  62
  63 /* class state defines ********************************************************/
  64
  65 #define CLASS_LOADING         0x0001
  66 #define CLASS_LOADED          0x0002
  67 #define CLASS_LINKING         0x0004
  68 #define CLASS_LINKED          0x0008
  69 #define CLASS_INITIALIZING    0x0010
  70 #define CLASS_INITIALIZED     0x0020
  71 #define CLASS_ERROR           0x0040
  72
  73
  74 /* some macros ****************************************************************/
  75
  76 #define CLASS_IS_OR_ALMOST_INITIALIZED(c) \
  77     (((c)->state & CLASS_INITIALIZING) || ((c)->state & CLASS_INITIALIZED))
  78
  79
  80 /* classinfo ******************************************************************/
  81
  82 /* We define this dummy structure of java_lang_Class so we can
  83    bootstrap cacaoh without needing a java_lang_Class.h file.  Whether
  84    the size of the dummy structure is big enough is checked during
  85    runtime in vm_create. */
  86
  87 typedef struct {
  88         java_object_t      header;
  89 #if defined(WITH_CLASSPATH_GNU)
  90         intptr_t           padding[4];
  91 #elif defined(WITH_CLASSPATH_SUN)
  92         intptr_t           padding[19];
  93 #elif defined(WITH_CLASSPATH_CLDC1_1)
  94         intptr_t           padding[3];
  95 #else
  96 # error unknown classpath configuration
  97 #endif
  98 } dummy_java_lang_Class;
  99
 100 struct classinfo {                /* class structure                          */
 101         dummy_java_lang_Class object;
 102
 103         s4          flags;            /* ACC flags                                */
 104         utf        *name;             /* class name                               */
 105
 106         s4          cpcount;          /* number of entries in constant pool       */
 107         u1         *cptags;           /* constant pool tags                       */
 108         voidptr    *cpinfos;          /* pointer to constant pool info structures */
 109
 110         s4          classrefcount;    /* number of symbolic class references      */
 111         constant_classref *classrefs; /* table of symbolic class references       */
 112         extra_classref *extclassrefs; /* additional classrefs                     */
 113         s4          parseddescsize;   /* size of the parsed descriptors block     */
 114         u1         *parseddescs;      /* parsed descriptors                       */
 115
 116         classref_or_classinfo super;  /* super class                              */
 117         classinfo  *sub;              /* sub class pointer                        */
 118         classinfo  *nextsub;          /* pointer to next class in sub class list  */
 119
 120         s4          interfacescount;  /* number of interfaces                     */
 121         classref_or_classinfo *interfaces; /* superinterfaces                     */
 122
 123         s4          fieldscount;      /* number of fields                         */
 124         fieldinfo  *fields;           /* field table                              */
 125
 126         s4          methodscount;     /* number of methods                        */
 127         methodinfo *methods;          /* method table                             */
 128
 129         s4          state;            /* current class state                      */
 130         s4          index;            /* hierarchy depth (classes) or index       */
 131                                       /* (interfaces)                             */
 132         s4          instancesize;     /* size of an instance of this class        */
 133
 134         vftbl_t    *vftbl;            /* pointer to virtual function table        */
 135
 136         methodinfo *finalizer;        /* finalizer method                         */
 137
 138         u2          innerclasscount;  /* number of inner classes                  */
 139         innerclassinfo *innerclass;
 140
 141 #if defined(ENABLE_JAVASE)
 142         classref_or_classinfo  enclosingclass;  /* enclosing class                */
 143         constant_nameandtype  *enclosingmethod; /* enclosing method               */
 144 #endif
 145
 146         utf        *packagename;      /* full name of the package                 */
 147         utf        *sourcefile;       /* SourceFile attribute                     */
 148 #if defined(ENABLE_JAVASE)
 149         utf        *signature;        /* Signature attribute                      */
 150 #if defined(ENABLE_ANNOTATIONS)
 151         annotation_bytearray_t  *annotations;
 152
 153         annotation_bytearrays_t *method_annotations;
 154         annotation_bytearrays_t *method_parameterannotations;
 155         annotation_bytearrays_t *method_annotationdefaults;
 156
 157         annotation_bytearrays_t *field_annotations;
 158 #endif
 159         classloader *classloader;     /* NULL for bootstrap classloader           */
 160 };
 161
 162
 163 /* innerclassinfo *************************************************************/
 164
 165 struct innerclassinfo {
 166         classref_or_classinfo inner_class; /* inner class pointer                 */
 167         classref_or_classinfo outer_class; /* outer class pointer                 */
 168         utf                  *name;        /* innerclass name                     */
 169         s4                    flags;       /* ACC flags                           */
 170 };
 171
 172
 173 /* extra_classref **************************************************************
 174
 175    for classrefs not occurring within descriptors
 176
 177 *******************************************************************************/
 178
 179 struct extra_classref {
 180         extra_classref    *next;
 181         constant_classref  classref;
 182 };
 183
 184
 185 /* castinfo *******************************************************************/
 186
 187 struct castinfo {
 188         s4 super_baseval;
 189         s4 super_diffval;
 190         s4 sub_baseval;
 191 };
 192
 193
 194 /* global variables ***********************************************************/
 195
 196 /* frequently used classes ****************************************************/
 197
 198 /* important system classes */
 199
 200 extern classinfo *class_java_lang_Object;
 201 extern classinfo *class_java_lang_Class;
 202 extern classinfo *class_java_lang_ClassLoader;
 203 extern classinfo *class_java_lang_Cloneable;
 204 extern classinfo *class_java_lang_SecurityManager;
 205 extern classinfo *class_java_lang_String;
 206 extern classinfo *class_java_lang_System;
 207 extern classinfo *class_java_lang_Thread;
 208 extern classinfo *class_java_lang_ThreadGroup;
 209 extern classinfo *class_java_lang_VMSystem;
 210 extern classinfo *class_java_lang_VMThread;
 211 extern classinfo *class_java_io_Serializable;
 212
 213 #if defined(WITH_CLASSPATH_SUN)
 214 extern classinfo *class_sun_reflect_MagicAccessorImpl;
 215 #endif
 216
 217 /* system exception classes required in cacao */
 218
 219 extern classinfo *class_java_lang_Throwable;
 220 extern classinfo *class_java_lang_Error;
 221 extern classinfo *class_java_lang_LinkageError;
 222 extern classinfo *class_java_lang_NoClassDefFoundError;
 223 extern classinfo *class_java_lang_OutOfMemoryError;
 224 extern classinfo *class_java_lang_VirtualMachineError;
 225
 226 #if defined(WITH_CLASSPATH_GNU)
 227 extern classinfo *class_java_lang_VMThrowable;
 228 #endif
 229
 230 extern classinfo *class_java_lang_Exception;
 231 extern classinfo *class_java_lang_ClassCastException;
 232 extern classinfo *class_java_lang_ClassNotFoundException;
 233
 234 #if defined(ENABLE_JAVASE)
 235 extern classinfo *class_java_lang_Void;
 236
 237 #if defined(ENABLE_ANNOTATIONS)
 238 extern classinfo *class_sun_reflect_ConstantPool;
 239 #if defined(WITH_CLASSPATH_GNU)
 240 extern classinfo *class_sun_reflect_annotation_AnnotationParser;
 241 #endif
 242 #endif
 243 #endif
 244
 245 extern classinfo *class_java_lang_Boolean;
 246 extern classinfo *class_java_lang_Byte;
 247 extern classinfo *class_java_lang_Character;
 248 extern classinfo *class_java_lang_Short;
 249 extern classinfo *class_java_lang_Integer;
 250 extern classinfo *class_java_lang_Long;
 251 extern classinfo *class_java_lang_Float;
 252 extern classinfo *class_java_lang_Double;
 253
 254
 255 /* some runtime exception */
 256
 257 extern classinfo *class_java_lang_NullPointerException;
 258
 259
 260 /* some classes which may be used more often */
 261
 262 #if defined(ENABLE_JAVASE)
 263 extern classinfo *class_java_lang_StackTraceElement;
 264 extern classinfo *class_java_lang_reflect_Constructor;
 265 extern classinfo *class_java_lang_reflect_Field;
 266 extern classinfo *class_java_lang_reflect_Method;
 267 extern classinfo *class_java_security_PrivilegedAction;
 268 extern classinfo *class_java_util_Vector;
 269
 270 extern classinfo *arrayclass_java_lang_Object;
 271 #endif
 272
 273
 274 /* pseudo classes for the type checker ****************************************/
 275
 276 /*
 277  * pseudo_class_Arraystub
 278  *     (extends Object implements Cloneable, java.io.Serializable)
 279  *
 280  *     If two arrays of incompatible component types are merged,
 281  *     the resulting reference has no accessible components.
 282  *     The result does, however, implement the interfaces Cloneable
 283  *     and java.io.Serializable. This pseudo class is used internally
 284  *     to represent such results. (They are *not* considered arrays!)
 285  *
 286  * pseudo_class_Null
 287  *
 288  *     This pseudo class is used internally to represent the
 289  *     null type.
 290  *
 291  * pseudo_class_New
 292  *
 293  *     This pseudo class is used internally to represent the
 294  *     the 'uninitialized object' type.
 295  */
 296
 297 extern classinfo *pseudo_class_Arraystub;
 298 extern classinfo *pseudo_class_Null;
 299 extern classinfo *pseudo_class_New;
 300
 301
 302 /* function prototypes ********************************************************/
 303
 304 classinfo *class_create_classinfo(utf *u);
 305 void       class_postset_header_vftbl(void);
 306 classinfo *class_define(utf *name, classloader *cl, int32_t length, const uint8_t *data);
 307 void       class_set_packagename(classinfo *c);
 308
 309 bool       class_load_attributes(classbuffer *cb);
 310
 311 /* retrieve constantpool element */
 312 voidptr class_getconstant(classinfo *class, u4 pos, u4 ctype);
 313 voidptr innerclass_getconstant(classinfo *c, u4 pos, u4 ctype);
 314
 315 /* frees all resources used by the class */
 316 void class_free(classinfo *);
 317
 318 /* return an array class with the given component class */
 319 classinfo *class_array_of(classinfo *component,bool link);
 320
 321 /* return an array class with the given dimension and element class */
 322 classinfo *class_multiarray_of(s4 dim, classinfo *element,bool link);
 323
 324 /* return a classref for the given class name */
 325 /* (does a linear search!)                    */
 326 constant_classref *class_lookup_classref(classinfo *cls,utf *name);
 327
 328 /* return a classref for the given class name */
 329 /* (does a linear search!)                    */
 330 constant_classref *class_get_classref(classinfo *cls,utf *name);
 331
 332 /* return a classref to the class itself */
 333 /* (does a linear search!)                    */
 334 constant_classref *class_get_self_classref(classinfo *cls);
 335
 336 /* return a classref for an array with the given dimension of with the */
 337 /* given component type */
 338 constant_classref *class_get_classref_multiarray_of(s4 dim,constant_classref *ref);
 339
 340 /* return a classref for the component type of the given array type */
 341 constant_classref *class_get_classref_component_of(constant_classref *ref);
 342
 343 /* get a class' field by name and descriptor */
 344 fieldinfo *class_findfield(classinfo *c, utf *name, utf *desc);
 345
 346 /* search 'classinfo'-structure for a field with the specified name */
 347 fieldinfo *class_findfield_by_name(classinfo *c, utf *name);
 348 s4 class_findfield_index_by_name(classinfo *c, utf *name);
 349
 350 /* search class for a field */
 351 fieldinfo *class_resolvefield(classinfo *c, utf *name, utf *desc, classinfo *referer, bool throwexception);
 352
 353 /* search for a method with a specified name and descriptor */
 354 methodinfo *class_findmethod(classinfo *c, utf *name, utf *desc);
 355 methodinfo *class_resolvemethod(classinfo *c, utf *name, utf *dest);
 356 methodinfo *class_resolveclassmethod(classinfo *c, utf *name, utf *dest, classinfo *referer, bool throwexception);
 357 methodinfo *class_resolveinterfacemethod(classinfo *c, utf *name, utf *dest, classinfo *referer, bool throwexception);
 358
 359 bool              class_issubclass(classinfo *sub, classinfo *super);
 360 bool              class_isanysubclass(classinfo *sub, classinfo *super);
 361 bool              class_is_primitive(classinfo *c);
 362 bool              class_is_array(classinfo *c);
 363 bool              class_is_interface(classinfo *c);
 364
 365 classinfo                 *class_get_superclass(classinfo *c);
 366 java_handle_objectarray_t *class_get_declaredclasses(classinfo *c, bool publicOnly);
 367 classinfo                 *class_get_declaringclass(classinfo *c);
 368 java_handle_objectarray_t *class_get_interfaces(classinfo *c);
 369
 370 #if defined(ENABLE_JAVASE)
 371 utf              *class_get_signature(classinfo *c);
 372 #endif
 373
 374 /* some debugging functions */
 375
 376 #if !defined(NDEBUG)
 377 void class_printflags(classinfo *c);
 378 void class_print(classinfo *c);
 379 void class_println(classinfo *c);
 380 void class_classref_print(constant_classref *cr);
 381 void class_classref_println(constant_classref *cr);
 382 void class_classref_or_classinfo_print(classref_or_classinfo c);
 383 void class_classref_or_classinfo_println(classref_or_classinfo c);
 384 #endif
 385
 386 /* debug purposes */
 387 void class_showmethods(classinfo *c);
 388 void class_showconstantpool(classinfo *c);
 389
 390 #endif /* _CLASS_H */
 391
 392
 393 /*
 394  * These are local overrides for various environment variables in Emacs.
 395  * Please do not remove this and leave it at the end of the file, where
 396  * Emacs will automagically detect them.
 397  * ---------------------------------------------------------------------
 398  * Local variables:
 399  * mode: c
 400  * indent-tabs-mode: t
 401  * c-basic-offset: 4
 402  * tab-width: 4
 403  * End:
 404  */