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 */
  26
  27
  28 #ifndef _CLASS_H
  29 #define _CLASS_H
  30
  31 /* forward typedefs ***********************************************************/
  32
  33 typedef struct classinfo      classinfo;
  34 typedef struct innerclassinfo innerclassinfo;
  35 typedef struct extra_classref extra_classref;
  36 typedef struct castinfo       castinfo;
  37
  38
  39 #include "config.h"
  40
  41 #include <stdint.h>
  42
  43 #include "vm/types.h"
  44
  45 #include "toolbox/list.h"
  46
  47 #include "vm/global.h"
  48
  49 #if defined(ENABLE_JAVASE)
  50 # include "vmcore/annotation.h"
  51 #endif
  52
  53 #include "vmcore/field.h"
  54 #include "vmcore/linker.h"
  55 #include "vmcore/loader.h"
  56 #include "vmcore/method.h"
  57 #include "vmcore/references.h"
  58 #include "vmcore/utf8.h"
  59
  60
  61 /* class state defines ********************************************************/
  62
  63 #define CLASS_LOADING         0x0001
  64 #define CLASS_LOADED          0x0002
  65 #define CLASS_LINKING         0x0004
  66 #define CLASS_LINKED          0x0008
  67 #define CLASS_INITIALIZING    0x0010
  68 #define CLASS_INITIALIZED     0x0020
  69 #define CLASS_ERROR           0x0040
  70
  71
  72 /* some macros ****************************************************************/
  73
  74 #define CLASS_IS_OR_ALMOST_INITIALIZED(c) \
  75     (((c)->state & CLASS_INITIALIZING) || ((c)->state & CLASS_INITIALIZED))
  76
  77
  78 /* classinfo ******************************************************************/
  79
  80 /* We define this dummy structure of java_lang_Class so we can
  81    bootstrap cacaoh without needing a java_lang_Class.h file.  Whether
  82    the size of the dummy structure is big enough is checked during
  83    runtime in vm_create. */
  84
  85 typedef struct {
  86         java_object_t      header;
  87 #if defined(WITH_CLASSPATH_GNU)
  88         intptr_t           padding[4];
  89 #elif defined(WITH_CLASSPATH_SUN)
  90         intptr_t           padding[19];
  91 #elif defined(WITH_CLASSPATH_CLDC1_1)
  92         intptr_t           padding[3];
  93 #else
  94 # error unknown classpath configuration
  95 #endif
  96 } dummy_java_lang_Class;
  97
  98 struct classinfo {                /* class structure                          */
  99         dummy_java_lang_Class object;
 100
 101         s4          flags;            /* ACC flags                                */
 102         utf        *name;             /* class name                               */
 103
 104         s4          cpcount;          /* number of entries in constant pool       */
 105         u1         *cptags;           /* constant pool tags                       */
 106         voidptr    *cpinfos;          /* pointer to constant pool info structures */
 107
 108         s4          classrefcount;    /* number of symbolic class references      */
 109         constant_classref *classrefs; /* table of symbolic class references       */
 110         extra_classref *extclassrefs; /* additional classrefs                     */
 111         s4          parseddescsize;   /* size of the parsed descriptors block     */
 112         u1         *parseddescs;      /* parsed descriptors                       */
 113
 114         classinfo  *super;            /* super class                              */
 115         classinfo  *sub;              /* sub class pointer                        */
 116         classinfo  *nextsub;          /* pointer to next class in sub class list  */
 117
 118         int32_t     interfacescount;  /* number of interfaces                     */
 119         classinfo **interfaces;       /* super interfaces                         */
 120
 121         int32_t     fieldscount;      /* number of fields                         */
 122         fieldinfo  *fields;           /* field table                              */
 123
 124         int32_t     methodscount;     /* number of methods                        */
 125         methodinfo *methods;          /* method table                             */
 126
 127         s4          state;            /* current class state                      */
 128         s4          index;            /* hierarchy depth (classes) or index       */
 129                                       /* (interfaces)                             */
 130         s4          instancesize;     /* size of an instance of this class        */
 131
 132         vftbl_t    *vftbl;            /* pointer to virtual function table        */
 133
 134         methodinfo *finalizer;        /* finalizer method                         */
 135
 136         u2          innerclasscount;  /* number of inner classes                  */
 137         innerclassinfo *innerclass;
 138
 139         classref_or_classinfo  declaringclass;
 140         classref_or_classinfo  enclosingclass;  /* enclosing class                */
 141         constant_nameandtype  *enclosingmethod; /* enclosing method               */
 142
 143         utf        *packagename;      /* full name of the package                 */
 144         utf        *sourcefile;       /* SourceFile attribute                     */
 145 #if defined(ENABLE_JAVASE)
 146         utf        *signature;        /* Signature attribute                      */
 147 #if defined(ENABLE_ANNOTATIONS)
 148         /* All the annotation attributes are NULL (and not a zero length array)   */
 149         /* if there is nothing.                                                   */
 150         java_object_t *annotations;   /* annotations of this class                */
 151
 152         java_object_t *method_annotations; /* array of annotations of the methods */
 153         java_object_t *method_parameterannotations; /* array of parameter         */
 154                                       /* annotations of the methods               */
 155         java_object_t *method_annotationdefaults; /* array of annotation default  */
 156                                       /* values of the methods                    */
 157
 158         java_object_t *field_annotations; /* array of annotations of the fields   */
 159
 160 #endif
 161 #endif
 162         classloader *classloader;       /* NULL for bootstrap classloader         */
 163
 164 #if defined(ENABLE_JAVASE)
 165 # if defined(WITH_CLASSPATH_SUN)
 166         java_object_t      *protectiondomain;
 167         java_objectarray_t *signers;
 168 # endif
 169 #endif
 170 };
 171
 172
 173 /* innerclassinfo *************************************************************/
 174
 175 struct innerclassinfo {
 176         classref_or_classinfo inner_class; /* inner class pointer                 */
 177         classref_or_classinfo outer_class; /* outer class pointer                 */
 178         utf                  *name;        /* innerclass name                     */
 179         s4                    flags;       /* ACC flags                           */
 180 };
 181
 182
 183 /* extra_classref **************************************************************
 184
 185    for classrefs not occurring within descriptors
 186
 187 *******************************************************************************/
 188
 189 struct extra_classref {
 190         extra_classref    *next;
 191         constant_classref  classref;
 192 };
 193
 194
 195 /* castinfo *******************************************************************/
 196
 197 struct castinfo {
 198         s4 super_baseval;
 199         s4 super_diffval;
 200         s4 sub_baseval;
 201 };
 202
 203
 204 /* global variables ***********************************************************/
 205
 206 /* frequently used classes ****************************************************/
 207
 208 /* important system classes */
 209
 210 extern classinfo *class_java_lang_Object;
 211 extern classinfo *class_java_lang_Class;
 212 extern classinfo *class_java_lang_ClassLoader;
 213 extern classinfo *class_java_lang_Cloneable;
 214 extern classinfo *class_java_lang_SecurityManager;
 215 extern classinfo *class_java_lang_String;
 216 extern classinfo *class_java_lang_System;
 217 extern classinfo *class_java_lang_Thread;
 218 extern classinfo *class_java_lang_ThreadGroup;
 219 extern classinfo *class_java_lang_Throwable;
 220 extern classinfo *class_java_io_Serializable;
 221
 222 #if defined(WITH_CLASSPATH_GNU)
 223 extern classinfo *class_java_lang_VMSystem;
 224 extern classinfo *class_java_lang_VMThread;
 225 extern classinfo *class_java_lang_VMThrowable;
 226 #endif
 227
 228 #if defined(WITH_CLASSPATH_SUN)
 229 extern classinfo *class_sun_reflect_MagicAccessorImpl;
 230 #endif
 231
 232 #if defined(ENABLE_JAVASE)
 233 extern classinfo *class_java_lang_Void;
 234 #endif
 235
 236 extern classinfo *class_java_lang_Boolean;
 237 extern classinfo *class_java_lang_Byte;
 238 extern classinfo *class_java_lang_Character;
 239 extern classinfo *class_java_lang_Short;
 240 extern classinfo *class_java_lang_Integer;
 241 extern classinfo *class_java_lang_Long;
 242 extern classinfo *class_java_lang_Float;
 243 extern classinfo *class_java_lang_Double;
 244
 245 /* some classes which may be used more often */
 246
 247 #if defined(ENABLE_JAVASE)
 248 extern classinfo *class_java_lang_StackTraceElement;
 249 extern classinfo *class_java_lang_reflect_Constructor;
 250 extern classinfo *class_java_lang_reflect_Field;
 251 extern classinfo *class_java_lang_reflect_Method;
 252 extern classinfo *class_java_security_PrivilegedAction;
 253 extern classinfo *class_java_util_Vector;
 254
 255 extern classinfo *arrayclass_java_lang_Object;
 256
 257 # if defined(ENABLE_ANNOTATIONS)
 258 extern classinfo *class_sun_reflect_ConstantPool;
 259 #  if defined(WITH_CLASSPATH_GNU)
 260 extern classinfo *class_sun_reflect_annotation_AnnotationParser;
 261 #  endif
 262 # endif
 263 #endif
 264
 265
 266 /* pseudo classes for the type checker ****************************************/
 267
 268 /*
 269  * pseudo_class_Arraystub
 270  *     (extends Object implements Cloneable, java.io.Serializable)
 271  *
 272  *     If two arrays of incompatible component types are merged,
 273  *     the resulting reference has no accessible components.
 274  *     The result does, however, implement the interfaces Cloneable
 275  *     and java.io.Serializable. This pseudo class is used internally
 276  *     to represent such results. (They are *not* considered arrays!)
 277  *
 278  * pseudo_class_Null
 279  *
 280  *     This pseudo class is used internally to represent the
 281  *     null type.
 282  *
 283  * pseudo_class_New
 284  *
 285  *     This pseudo class is used internally to represent the
 286  *     the 'uninitialized object' type.
 287  */
 288
 289 extern classinfo *pseudo_class_Arraystub;
 290 extern classinfo *pseudo_class_Null;
 291 extern classinfo *pseudo_class_New;
 292
 293
 294 /* inline functions ***********************************************************/
 295
 296 /* class_is_primitive **********************************************************
 297
 298    Checks if the given class is a primitive class.
 299
 300 *******************************************************************************/
 301
 302 static inline bool class_is_primitive(classinfo *c)
 303 {
 304         if (c->flags & ACC_CLASS_PRIMITIVE)
 305                 return true;
 306
 307         return false;
 308 }
 309
 310
 311 /* class_is_anonymousclass *****************************************************
 312
 313    Checks if the given class is an anonymous class.
 314
 315 *******************************************************************************/
 316
 317 static inline bool class_is_anonymousclass(classinfo *c)
 318 {
 319         if (c->flags & ACC_CLASS_ANONYMOUS)
 320                 return true;
 321
 322         return false;
 323 }
 324
 325
 326 /* class_is_array **************************************************************
 327
 328    Checks if the given class is an array class.
 329
 330 *******************************************************************************/
 331
 332 static inline bool class_is_array(classinfo *c)
 333 {
 334         if (!(c->state & CLASS_LINKED))
 335                 if (!link_class(c))
 336                         return false;
 337
 338         return (c->vftbl->arraydesc != NULL);
 339 }
 340
 341
 342 /* class_is_interface **********************************************************
 343
 344    Checks if the given class is an interface.
 345
 346 *******************************************************************************/
 347
 348 static inline bool class_is_interface(classinfo *c)
 349 {
 350         if (c->flags & ACC_INTERFACE)
 351                 return true;
 352
 353         return false;
 354 }
 355
 356
 357 /* class_is_localclass *********************************************************
 358
 359    Checks if the given class is a local class.
 360
 361 *******************************************************************************/
 362
 363 static inline bool class_is_localclass(classinfo *c)
 364 {
 365         if ((c->enclosingmethod != NULL) && !class_is_anonymousclass(c))
 366                 return true;
 367
 368         return false;
 369 }
 370
 371
 372 /* class_is_memberclass ********************************************************
 373
 374    Checks if the given class is a member class.
 375
 376 *******************************************************************************/
 377
 378 static inline bool class_is_memberclass(classinfo *c)
 379 {
 380         if (c->flags & ACC_CLASS_MEMBER)
 381                 return true;
 382
 383         return false;
 384 }
 385
 386
 387 /* class_get_classloader *******************************************************
 388
 389    Return the classloader of the given class.
 390
 391 *******************************************************************************/
 392
 393 static inline classloader *class_get_classloader(classinfo *c)
 394 {
 395         classloader *cl;
 396
 397         cl = c->classloader;
 398
 399         /* The classloader may be NULL. */
 400
 401         return cl;
 402 }
 403
 404
 405 /* class_get_superclass ********************************************************
 406
 407    Return the super class of the given class.
 408
 409 *******************************************************************************/
 410
 411 static inline classinfo *class_get_superclass(classinfo *c)
 412 {
 413         /* For interfaces we return NULL. */
 414
 415         if (c->flags & ACC_INTERFACE)
 416                 return NULL;
 417
 418         /* For java/lang/Object, primitive-type and Void classes c->super
 419            is NULL and we return NULL. */
 420
 421         return c->super;
 422 }
 423
 424
 425 /* function prototypes ********************************************************/
 426
 427 classinfo *class_create_classinfo(utf *u);
 428 void       class_postset_header_vftbl(void);
 429 classinfo *class_define(utf *name, classloader *cl, int32_t length, const uint8_t *data, java_handle_t *pd);
 430 void       class_set_packagename(classinfo *c);
 431
 432 bool       class_load_attributes(classbuffer *cb);
 433
 434 /* retrieve constantpool element */
 435 voidptr class_getconstant(classinfo *class, u4 pos, u4 ctype);
 436 voidptr innerclass_getconstant(classinfo *c, u4 pos, u4 ctype);
 437
 438 /* frees all resources used by the class */
 439 void class_free(classinfo *);
 440
 441 /* return an array class with the given component class */
 442 classinfo *class_array_of(classinfo *component,bool link);
 443
 444 /* return an array class with the given dimension and element class */
 445 classinfo *class_multiarray_of(s4 dim, classinfo *element,bool link);
 446
 447 /* return a classref for the given class name */
 448 /* (does a linear search!)                    */
 449 constant_classref *class_lookup_classref(classinfo *cls,utf *name);
 450
 451 /* return a classref for the given class name */
 452 /* (does a linear search!)                    */
 453 constant_classref *class_get_classref(classinfo *cls,utf *name);
 454
 455 /* return a classref to the class itself */
 456 /* (does a linear search!)                    */
 457 constant_classref *class_get_self_classref(classinfo *cls);
 458
 459 /* return a classref for an array with the given dimension of with the */
 460 /* given component type */
 461 constant_classref *class_get_classref_multiarray_of(s4 dim,constant_classref *ref);
 462
 463 /* return a classref for the component type of the given array type */
 464 constant_classref *class_get_classref_component_of(constant_classref *ref);
 465
 466 /* get a class' field by name and descriptor */
 467 fieldinfo *class_findfield(classinfo *c, utf *name, utf *desc);
 468
 469 /* search 'classinfo'-structure for a field with the specified name */
 470 fieldinfo *class_findfield_by_name(classinfo *c, utf *name);
 471 s4 class_findfield_index_by_name(classinfo *c, utf *name);
 472
 473 /* search class for a field */
 474 fieldinfo *class_resolvefield(classinfo *c, utf *name, utf *desc, classinfo *referer, bool throwexception);
 475
 476 /* search for a method with a specified name and descriptor */
 477 methodinfo *class_findmethod(classinfo *c, utf *name, utf *desc);
 478 methodinfo *class_resolvemethod(classinfo *c, utf *name, utf *dest);
 479 methodinfo *class_resolveclassmethod(classinfo *c, utf *name, utf *dest, classinfo *referer, bool throwexception);
 480 methodinfo *class_resolveinterfacemethod(classinfo *c, utf *name, utf *dest, classinfo *referer, bool throwexception);
 481
 482 bool class_issubclass(classinfo *sub, classinfo *super);
 483 bool class_isanysubclass(classinfo *sub, classinfo *super);
 484
 485 bool                       class_is_primitive(classinfo *c);
 486 bool                       class_is_anonymousclass(classinfo *c);
 487 bool                       class_is_array(classinfo *c);
 488 bool                       class_is_interface(classinfo *c);
 489 bool                       class_is_localclass(classinfo *c);
 490 bool                       class_is_memberclass(classinfo *c);
 491
 492 classloader               *class_get_classloader(classinfo *c);
 493 classinfo                 *class_get_superclass(classinfo *c);
 494 classinfo                 *class_get_componenttype(classinfo *c);
 495 java_handle_objectarray_t *class_get_declaredclasses(classinfo *c, bool publicOnly);
 496 classinfo                 *class_get_declaringclass(classinfo *c);
 497 classinfo                 *class_get_enclosingclass(classinfo *c);
 498 java_handle_objectarray_t *class_get_interfaces(classinfo *c);
 499 java_handle_bytearray_t   *class_get_annotations(classinfo *c);
 500 int32_t                    class_get_modifiers(classinfo *c, bool ignoreInnerClassesAttrib);
 501
 502 #if defined(ENABLE_JAVASE)
 503 utf                       *class_get_signature(classinfo *c);
 504 #endif
 505
 506 /* some debugging functions */
 507
 508 #if !defined(NDEBUG)
 509 void class_printflags(classinfo *c);
 510 void class_print(classinfo *c);
 511 void class_println(classinfo *c);
 512 void class_classref_print(constant_classref *cr);
 513 void class_classref_println(constant_classref *cr);
 514 void class_classref_or_classinfo_print(classref_or_classinfo c);
 515 void class_classref_or_classinfo_println(classref_or_classinfo c);
 516 #endif
 517
 518 /* debug purposes */
 519 void class_showmethods(classinfo *c);
 520 void class_showconstantpool(classinfo *c);
 521
 522 #endif /* _CLASS_H */
 523
 524
 525 /*
 526  * These are local overrides for various environment variables in Emacs.
 527  * Please do not remove this and leave it at the end of the file, where
 528  * Emacs will automagically detect them.
 529  * ---------------------------------------------------------------------
 530  * Local variables:
 531  * mode: c
 532  * indent-tabs-mode: t
 533  * c-basic-offset: 4
 534  * tab-width: 4
 535  * End:
 536  */