1 /* vm/descriptor.h - checking and parsing of field / method descriptors
3 Copyright (C) 1996-2005, 2006 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
8 This file is part of CACAO.
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.
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.
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
25 Contact: cacao@cacaojvm.org
27 Authors: Edwin Steiner
31 $Id: descriptor.h 5828 2006-10-26 10:09:11Z twisti $
39 /* forward typedefs ***********************************************************/
41 typedef struct descriptor_pool descriptor_pool;
42 typedef struct paramdesc paramdesc;
45 #include "vm/global.h"
46 #include "vm/hashtable.h"
47 #include "vm/method.h"
48 #include "vm/references.h"
51 /* data structures ************************************************************/
53 /*----------------------------------------------------------------------------*/
54 /* Descriptor Pools */
56 /* A descriptor_pool is a temporary data structure used during loading of */
57 /* a class. The descriptor_pool is used to allocate the table of */
58 /* constant_classrefs the class uses, and for parsing the field and method */
59 /* descriptors which occurr within the class. The inner workings of */
60 /* descriptor_pool are not important for outside code. */
62 /* You use a descriptor_pool as follows: */
64 /* 1. create one with descriptor_pool_new */
65 /* 2. add all explicit class references with descriptor_pool_add_class */
66 /* 3. add all field/method descriptors with descriptor_pool_add */
67 /* 4. call descriptor_pool_create_classrefs */
68 /* You can now lookup classrefs with descriptor_pool_lookup_classref */
69 /* 5. call descriptor_pool_alloc_parsed_descriptors */
70 /* 6. for each field descriptor call descriptor_pool_parse_field_descriptor */
71 /* for each method descriptor call descriptor_pool_parse_method_descriptor */
72 /* 7. call descriptor_pool_get_parsed_descriptors */
74 /* IMPORTANT: The descriptor_pool functions use DNEW and DMNEW for allocating */
75 /* memory which can be thrown away when the steps above have been */
77 /*----------------------------------------------------------------------------*/
79 struct descriptor_pool {
87 hashtable descriptorhash;
88 constant_classref *classrefs;
89 hashtable classrefhash;
90 u1 *descriptor_kind; /* useful for debugging */
91 u1 *descriptor_kind_next; /* useful for debugging */
95 /* data structures for parsed field/method descriptors ************************/
98 constant_classref *classref; /* class reference for TYPE_ADR types */
99 u1 type; /* TYPE_??? constant [1] */
100 u1 decltype; /* (PRIMITIVE)TYPE_??? constant [2] */
101 u1 arraydim; /* array dimension (0 if no array) */
104 /* [1]...the type field contains the basic type used within the VM. So ints, */
105 /* shorts, chars, bytes, booleans all have TYPE_INT. */
106 /* [2]...the decltype field contains the declared type. */
107 /* So short is PRIMITIVETYPE_SHORT, char is PRIMITIVETYPE_CHAR. */
108 /* For non-primitive types decltype is TYPE_ADR. */
111 #if defined(__MIPS__)
112 u1 type; /* TYPE_??? of the register allocated */
114 bool inmemory; /* argument in register or on stack */
115 s4 regoff; /* register index or stack offset */
119 s2 paramcount; /* number of parameters */
120 s2 paramslots; /* like above but LONG,DOUBLE count twice */
121 s4 argintreguse; /* number of used integer argument registers */
122 s4 argfltreguse; /* number of used float argument registers */
123 s4 memuse; /* number of stack slots used */
124 paramdesc *params; /* allocated parameter descriptions [3] */
125 typedesc returntype; /* parsed descriptor of the return type */
126 typedesc paramtypes[1]; /* parameter types, variable length! */
129 /* [3]...If params is NULL, the parameter descriptions have not yet been */
130 /* allocated. In this case ___the possible 'this' pointer of the method */
131 /* is NOT counted in paramcount/paramslots and it is NOT included in */
132 /* the paramtypes array___. */
133 /* If params != NULL, the parameter descriptions have been */
134 /* allocated, and the 'this' pointer of the method, if any, IS included.*/
135 /* In case the method has no parameters at all, the special value */
136 /* METHODDESC_NO_PARAMS is used (see below). */
138 /* METHODDESC_NO_PARAMS is a special value for the methoddesc.params field */
139 /* indicating that the method is a static method without any parameters. */
140 /* This special value must be != NULL and it may only be set if */
141 /* md->paramcount == 0. */
143 #define METHODDESC_NOPARAMS ((paramdesc*)1)
145 /* function prototypes ********************************************************/
147 descriptor_pool * descriptor_pool_new(classinfo *referer);
149 bool descriptor_pool_add_class(descriptor_pool *pool,utf *name);
150 bool descriptor_pool_add(descriptor_pool *pool,utf *desc,int *paramslots);
152 u2 descriptor_to_basic_type(utf *desc);
153 u2 descriptor_typesize(typedesc *td);
155 constant_classref * descriptor_pool_create_classrefs(descriptor_pool *pool,
157 constant_classref * descriptor_pool_lookup_classref(descriptor_pool *pool,utf *classname);
159 void descriptor_pool_alloc_parsed_descriptors(descriptor_pool *pool);
161 typedesc *descriptor_pool_parse_field_descriptor(descriptor_pool *pool, utf *desc);
162 methoddesc *descriptor_pool_parse_method_descriptor(descriptor_pool *pool, utf *desc, s4 mflags,
163 constant_classref *thisclass);
165 bool descriptor_params_from_paramtypes(methoddesc *md, s4 mflags);
167 void *descriptor_pool_get_parsed_descriptors(descriptor_pool *pool, s4 *size);
168 void descriptor_pool_get_sizes(descriptor_pool *pool, u4 *classrefsize,
172 void descriptor_debug_print_typedesc(FILE *file,typedesc *d);
173 void descriptor_debug_print_methoddesc(FILE *file,methoddesc *d);
174 void descriptor_debug_print_paramdesc(FILE *file,paramdesc *d);
175 void descriptor_pool_debug_dump(descriptor_pool *pool, FILE *file);
176 #endif /* !defined(NDEBUG) */
178 /* machine dependent descriptor function */
179 void md_param_alloc(methoddesc *md);
181 #endif /* _DESCRIPTOR_H */
185 * These are local overrides for various environment variables in Emacs.
186 * Please do not remove this and leave it at the end of the file, where
187 * Emacs will automagically detect them.
188 * ---------------------------------------------------------------------
191 * indent-tabs-mode: t
195 * vim:noexpandtab:sw=4:ts=4: