src/vm/classcache.h

   1 /* src/vm/classcache.h - loaded class cache and loading constraints
   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: Edwin Steiner
  28
  29    Changes:
  30
  31    $Id: classcache.h 3810 2005-11-27 14:11:44Z edwin $
  32
  33 */
  34
  35
  36 #ifndef _CLASSCACHE_H
  37 #define _CLASSCACHE_H
  38
  39 #include <stdio.h>  /* for FILE */
  40
  41 #include "vm/references.h"
  42 #include "vm/tables.h"
  43
  44
  45 /* forward declarations *******************************************************/
  46
  47 typedef struct classcache_name_entry classcache_name_entry;
  48 typedef struct classcache_class_entry classcache_class_entry;
  49 typedef struct classcache_loader_entry classcache_loader_entry;
  50
  51 typedef java_objectheader classloader;
  52
  53 /* global variables ***********************************************************/
  54
  55 extern hashtable classcache_hash;
  56
  57 /* structs ********************************************************************/
  58
  59
  60 /*----------------------------------------------------------------------------*/
  61 /* The Loaded Class Cache                                                     */
  62 /*                                                                            */
  63 /* The loaded class cache is implemented as a two-level data structure.       */
  64 /*                                                                            */
  65 /* The first level is a hash table indexed by class names. For each class     */
  66 /* name in the cache there is a classcache_name_entry, which collects all     */
  67 /* information about classes with this class name.                            */
  68 /*                                                                            */
  69 /* Second level: For each classcache_name_entry there is a list of            */
  70 /* classcache_class_entry:s representing the possible different resolutions   */
  71 /* of the class name.                                                         */
  72 /*                                                                            */
  73 /* A classcache_class_entry records the following:                            */
  74 /*                                                                            */
  75 /* - the loaded class object, if this entry has been resolved, otherwise NULL */
  76 /* - the list of initiating loaders which have resolved the class name to     */
  77 /*   this class object                                                        */
  78 /* - the list of initiating loaders which are constrained to resolve this     */
  79 /*   class name to this class object in the future                            */
  80 /*                                                                            */
  81 /* The classcache_class_entry:s approximate the equivalence classes created   */
  82 /* by the loading constraints and (XXX?) the equivalence of loaded classes.   */
  83 /*                                                                            */
  84 /* When a loading constraint (loaderA,loaderB,NAME) is added, then the        */
  85 /* classcache_class_entry:s for NAME containing loaderA and loaderB resp.     */
  86 /* must be merged into one entry. If this is impossible, because the entries  */
  87 /* have already been resolved to different class objects, then the constraint */
  88 /* is violated and an expception must be thrown.                              */
  89 /*----------------------------------------------------------------------------*/
  90
  91
  92 /* classcache_name_entry
  93  *
  94  * For each classname a classcache_name_entry struct is created.
  95  */
  96
  97 struct classcache_name_entry
  98 {
  99         utf                     *name;        /* class name                       */
 100         classcache_name_entry   *hashlink;    /* link for external chaining       */
 101         classcache_class_entry  *classes;     /* equivalence classes for this name*/
 102 };
 103
 104 struct classcache_class_entry
 105 {
 106         classinfo               *classobj;    /* the loaded class object, or NULL */
 107         classcache_loader_entry *loaders;
 108         classcache_loader_entry *constraints;
 109         classcache_class_entry  *next;        /* next class entry for same name   */
 110 };
 111
 112 struct classcache_loader_entry
 113 {
 114         classloader              *loader;     /* class loader object              */
 115         classcache_loader_entry  *next;       /* next loader entry in the list    */
 116 };
 117
 118 /* function prototypes ********************************************************/
 119
 120 /* initialize the loaded class cache */
 121 bool classcache_init(void);
 122 void classcache_free(void);
 123
 124 classinfo * classcache_lookup(classloader *initloader,utf *classname);
 125 classinfo * classcache_lookup_defined(classloader *defloader,utf *classname);
 126 classinfo * classcache_lookup_defined_or_initiated(classloader *loader,utf *classname);
 127
 128 bool classcache_store_unique(classinfo *cls);
 129 classinfo * classcache_store(classloader *initloader,classinfo *cls,bool mayfree);
 130 classinfo * classcache_store_defined(classinfo *cls);
 131
 132 bool classcache_add_constraint(classloader *a,classloader *b,utf *classname);
 133
 134 void classcache_debug_dump(FILE *file);
 135
 136 #endif /* _CLASSCACHE_H */
 137
 138 /*
 139  * These are local overrides for various environment variables in Emacs.
 140  * Please do not remove this and leave it at the end of the file, where
 141  * Emacs will automagically detect them.
 142  * ---------------------------------------------------------------------
 143  * Local variables:
 144  * mode: c
 145  * indent-tabs-mode: t
 146  * c-basic-offset: 4
 147  * tab-width: 4
 148  * End:
 149  * vim:noexpandtab:sw=4:ts=4:
 150  */
 151