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 8309 2007-08-15 16:42:52Z twisti $
  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 #endif
 160         classloader *classloader;       /* NULL for bootstrap classloader         */
 161 };
 162
 163
 164 /* innerclassinfo *************************************************************/
 165
 166 struct innerclassinfo {
 167         classref_or_classinfo inner_class; /* inner class pointer                 */
 168         classref_or_classinfo outer_class; /* outer class pointer                 */
 169         utf                  *name;        /* innerclass name                     */
 170         s4                    flags;       /* ACC flags                           */
 171 };
 172
 173
 174 /* extra_classref **************************************************************
 175
 176    for classrefs not occurring within descriptors
 177
 178 *******************************************************************************/
 179
 180 struct extra_classref {
 181         extra_classref    *next;
 182         constant_classref  classref;
 183 };
 184
 185
 186 /* castinfo *******************************************************************/
 187
 188 struct castinfo {
 189         s4 super_baseval;
 190         s4 super_diffval;
 191         s4 sub_baseval;
 192 };
 193
 194
 195 /* global variables ***********************************************************/
 196
 197 /* frequently used classes ****************************************************/
 198
 199 /* important system classes */
 200
 201 extern classinfo *class_java_lang_Object;
 202 extern classinfo *class_java_lang_Class;
 203 extern classinfo *class_java_lang_ClassLoader;
 204 extern classinfo *class_java_lang_Cloneable;
 205 extern classinfo *class_java_lang_SecurityManager;
 206 extern classinfo *class_java_lang_String;
 207 extern classinfo *class_java_lang_System;
 208 extern classinfo *class_java_lang_Thread;
 209 extern classinfo *class_java_lang_ThreadGroup;
 210 extern classinfo *class_java_lang_VMSystem;
 211 extern classinfo *class_java_lang_VMThread;
 212 extern classinfo *class_java_io_Serializable;
 213
 214 #if defined(WITH_CLASSPATH_SUN)
 215 extern classinfo *class_sun_reflect_MagicAccessorImpl;
 216 #endif
 217
 218 /* system exception classes required in cacao */
 219
 220 extern classinfo *class_java_lang_Throwable;
 221 extern classinfo *class_java_lang_Error;
 222 extern classinfo *class_java_lang_LinkageError;
 223 extern classinfo *class_java_lang_NoClassDefFoundError;
 224 extern classinfo *class_java_lang_OutOfMemoryError;
 225 extern classinfo *class_java_lang_VirtualMachineError;
 226
 227 #if defined(WITH_CLASSPATH_GNU)
 228 extern classinfo *class_java_lang_VMThrowable;
 229 #endif
 230
 231 extern classinfo *class_java_lang_Exception;
 232 extern classinfo *class_java_lang_ClassCastException;
 233 extern classinfo *class_java_lang_ClassNotFoundException;
 234
 235 #if defined(ENABLE_JAVASE)
 236 extern classinfo *class_java_lang_Void;
 237
 238 #if defined(ENABLE_ANNOTATIONS)
 239 extern classinfo *class_sun_reflect_ConstantPool;
 240 #if defined(WITH_CLASSPATH_GNU)
 241 extern classinfo *class_sun_reflect_annotation_AnnotationParser;
 242 #endif
 243 #endif
 244 #endif
 245
 246 extern classinfo *class_java_lang_Boolean;
 247 extern classinfo *class_java_lang_Byte;
 248 extern classinfo *class_java_lang_Character;
 249 extern classinfo *class_java_lang_Short;
 250 extern classinfo *class_java_lang_Integer;
 251 extern classinfo *class_java_lang_Long;
 252 extern classinfo *class_java_lang_Float;
 253 extern classinfo *class_java_lang_Double;
 254
 255
 256 /* some runtime exception */
 257
 258 extern classinfo *class_java_lang_NullPointerException;
 259
 260
 261 /* some classes which may be used more often */
 262
 263 #if defined(ENABLE_JAVASE)
 264 extern classinfo *class_java_lang_StackTraceElement;
 265 extern classinfo *class_java_lang_reflect_Constructor;
 266 extern classinfo *class_java_lang_reflect_Field;
 267 extern classinfo *class_java_lang_reflect_Method;
 268 extern classinfo *class_java_security_PrivilegedAction;
 269 extern classinfo *class_java_util_Vector;
 270
 271 extern classinfo *arrayclass_java_lang_Object;
 272 #endif
 273
 274
 275 /* pseudo classes for the type checker ****************************************/
 276
 277 /*
 278  * pseudo_class_Arraystub
 279  *     (extends Object implements Cloneable, java.io.Serializable)
 280  *
 281  *     If two arrays of incompatible component types are merged,
 282  *     the resulting reference has no accessible components.
 283  *     The result does, however, implement the interfaces Cloneable
 284  *     and java.io.Serializable. This pseudo class is used internally
 285  *     to represent such results. (They are *not* considered arrays!)
 286  *
 287  * pseudo_class_Null
 288  *
 289  *     This pseudo class is used internally to represent the
 290  *     null type.
 291  *
 292  * pseudo_class_New
 293  *
 294  *     This pseudo class is used internally to represent the
 295  *     the 'uninitialized object' type.
 296  */
 297
 298 extern classinfo *pseudo_class_Arraystub;
 299 extern classinfo *pseudo_class_Null;
 300 extern classinfo *pseudo_class_New;
 301
 302
 303 /* function prototypes ********************************************************/
 304
 305 classinfo *class_create_classinfo(utf *u);
 306 void       class_postset_header_vftbl(void);
 307 classinfo *class_define(utf *name, classloader *cl, int32_t length, const uint8_t *data);
 308 void       class_set_packagename(classinfo *c);
 309
 310 bool       class_load_attributes(classbuffer *cb);
 311
 312 /* retrieve constantpool element */
 313 voidptr class_getconstant(classinfo *class, u4 pos, u4 ctype);
 314 voidptr innerclass_getconstant(classinfo *c, u4 pos, u4 ctype);
 315
 316 /* frees all resources used by the class */
 317 void class_free(classinfo *);
 318
 319 /* return an array class with the given component class */
 320 classinfo *class_array_of(classinfo *component,bool link);
 321
 322 /* return an array class with the given dimension and element class */
 323 classinfo *class_multiarray_of(s4 dim, classinfo *element,bool link);
 324
 325 /* return a classref for the given class name */
 326 /* (does a linear search!)                    */
 327 constant_classref *class_lookup_classref(classinfo *cls,utf *name);
 328
 329 /* return a classref for the given class name */
 330 /* (does a linear search!)                    */
 331 constant_classref *class_get_classref(classinfo *cls,utf *name);
 332
 333 /* return a classref to the class itself */
 334 /* (does a linear search!)                    */
 335 constant_classref *class_get_self_classref(classinfo *cls);
 336
 337 /* return a classref for an array with the given dimension of with the */
 338 /* given component type */
 339 constant_classref *class_get_classref_multiarray_of(s4 dim,constant_classref *ref);
 340
 341 /* return a classref for the component type of the given array type */
 342 constant_classref *class_get_classref_component_of(constant_classref *ref);
 343
 344 /* get a class' field by name and descriptor */
 345 fieldinfo *class_findfield(classinfo *c, utf *name, utf *desc);
 346
 347 /* search 'classinfo'-structure for a field with the specified name */
 348 fieldinfo *class_findfield_by_name(classinfo *c, utf *name);
 349 s4 class_findfield_index_by_name(classinfo *c, utf *name);
 350
 351 /* search class for a field */
 352 fieldinfo *class_resolvefield(classinfo *c, utf *name, utf *desc, classinfo *referer, bool throwexception);
 353
 354 /* search for a method with a specified name and descriptor */
 355 methodinfo *class_findmethod(classinfo *c, utf *name, utf *desc);
 356 methodinfo *class_resolvemethod(classinfo *c, utf *name, utf *dest);
 357 methodinfo *class_resolveclassmethod(classinfo *c, utf *name, utf *dest, classinfo *referer, bool throwexception);
 358 methodinfo *class_resolveinterfacemethod(classinfo *c, utf *name, utf *dest, classinfo *referer, bool throwexception);
 359
 360 bool              class_issubclass(classinfo *sub, classinfo *super);
 361 bool              class_isanysubclass(classinfo *sub, classinfo *super);
 362 bool              class_is_primitive(classinfo *c);
 363 bool              class_is_array(classinfo *c);
 364 bool              class_is_interface(classinfo *c);
 365
 366 classinfo        *class_get_superclass(classinfo *c);
 367 java_objectarray *class_get_declaredclasses(classinfo *c, bool publicOnly);
 368 classinfo        *class_get_declaringclass(classinfo *c);
 369 java_objectarray *class_get_interfaces(classinfo *c);
 370
 371 #if defined(ENABLE_JAVASE)
 372 utf              *class_get_signature(classinfo *c);
 373 #endif
 374
 375 /* some debugging functions */
 376
 377 #if !defined(NDEBUG)
 378 void class_printflags(classinfo *c);
 379 void class_print(classinfo *c);
 380 void class_println(classinfo *c);
 381 void class_classref_print(constant_classref *cr);
 382 void class_classref_println(constant_classref *cr);
 383 void class_classref_or_classinfo_print(classref_or_classinfo c);
 384 void class_classref_or_classinfo_println(classref_or_classinfo c);
 385 #endif
 386
 387 /* debug purposes */
 388 void class_showmethods(classinfo *c);
 389 void class_showconstantpool(classinfo *c);
 390
 391 #endif /* _CLASS_H */
 392
 393
 394 /*
 395  * These are local overrides for various environment variables in Emacs.
 396  * Please do not remove this and leave it at the end of the file, where
 397  * Emacs will automagically detect them.
 398  * ---------------------------------------------------------------------
 399  * Local variables:
 400  * mode: c
 401  * indent-tabs-mode: t
 402  * c-basic-offset: 4
 403  * tab-width: 4
 404  * End:
 405  */