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 2195 2005-04-03 16:53:16Z 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 /* classcache_init *************************************************************
 121
 122    Initialize the loaded class cache
 123
 124 *******************************************************************************/
 125
 126 void classcache_init();
 127
 128 /* classcache_free *************************************************************
 129
 130    Free the memory used by the class cache
 131
 132    NOTE:
 133        The class cache may not be used any more after this call, except
 134            when it is reinitialized with classcache_init.
 135
 136 *******************************************************************************/
 137
 138 void classcache_free();
 139
 140 /* classcache_lookup ***********************************************************
 141
 142    Lookup a possibly loaded class
 143
 144    IN:
 145        initloader.......initiating loader for resolving the class name
 146        classname........class name to look up
 147
 148    RETURN VALUE:
 149        The return value is a pointer to the cached class object,
 150        or NULL, if the class is not in the cache.
 151
 152 *******************************************************************************/
 153
 154 classinfo * classcache_lookup(classloader *initloader,utf *classname);
 155
 156 /* classcache_lookup_defined ***************************************************
 157
 158    Lookup a class with the given name and defining loader
 159
 160    IN:
 161        defloader........defining loader
 162        classname........class name
 163
 164    RETURN VALUE:
 165        The return value is a pointer to the cached class object,
 166        or NULL, if the class is not in the cache.
 167
 168 *******************************************************************************/
 169
 170 classinfo * classcache_lookup_defined(classloader *defloader,utf *classname);
 171
 172 /* classcache_store ************************************************************
 173
 174    Store a loaded class
 175
 176    IN:
 177        initloader.......initiating loader used to load the class
 178        cls..............class object to cache
 179
 180    RETURN VALUE:
 181        true.............everything ok, the class was stored in
 182                         the cache if necessary,
 183        false............an exception has been thrown.
 184
 185 *******************************************************************************/
 186
 187 bool classcache_store(classloader *initloader,classinfo *cls);
 188
 189 /* classcache_add_constraint ***************************************************
 190
 191    Add a loading constraint
 192
 193    IN:
 194        a................first initiating loader
 195        b................second initiating loader
 196        classname........class name
 197
 198    RETURN VALUE:
 199        true.............everything ok, the constraint has been added,
 200        false............an exception has been thrown.
 201
 202 *******************************************************************************/
 203
 204 bool classcache_add_constraint(classloader *a,classloader *b,utf *classname);
 205
 206 /* classcache_debug_dump *******************************************************
 207
 208    Print the contents of the loaded class cache to a stream
 209
 210    IN:
 211        file.............output stream
 212
 213 *******************************************************************************/
 214
 215 void classcache_debug_dump(FILE *file);
 216
 217 #endif /* _CLASSCACHE_H */
 218
 219 /*
 220  * These are local overrides for various environment variables in Emacs.
 221  * Please do not remove this and leave it at the end of the file, where
 222  * Emacs will automagically detect them.
 223  * ---------------------------------------------------------------------
 224  * Local variables:
 225  * mode: c
 226  * indent-tabs-mode: t
 227  * c-basic-offset: 4
 228  * tab-width: 4
 229  * End:
 230  * vim:noexpandtab:sw=4:ts=4:
 231  */
 232