* src/vm/resolve.h (vm/field.h): Added.
[cacao.git] / src / vm / resolve.h
1 /* src/vm/resolve.h - resolving classes/interfaces/fields/methods
2
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
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    Contact: cacao@cacaojvm.org
26
27    Authors: Edwin Steiner
28
29    Changes:
30
31    $Id: resolve.h 6083 2006-11-29 17:00:02Z twisti $
32
33 */
34
35
36 #ifndef _RESOLVE_H
37 #define _RESOLVE_H
38
39 /* forward declarations *******************************************************/
40
41 typedef struct unresolved_class unresolved_class;
42 typedef struct unresolved_field unresolved_field;
43 typedef struct unresolved_method unresolved_method;
44 typedef struct unresolved_subtype_set unresolved_subtype_set;
45
46
47 #include "config.h"
48 #include "vm/types.h"
49
50 #include "vm/field.h"
51 #include "vm/global.h"
52 #include "vm/references.h"
53 #include "vm/jit/jit.h"
54 #include "vm/jit/reg.h"
55 #include "vm/jit/verify/typeinfo.h"
56
57
58 /* constants ******************************************************************/
59
60 #define RESOLVE_STATIC    0x0001  /* ref to static fields/methods             */
61 #define RESOLVE_PUTFIELD  0x0002  /* field ref inside a PUT{FIELD,STATIC}...  */
62 #define RESOLVE_SPECIAL   0x0004  /* method ref inside INVOKESPECIAL          */
63
64
65 /* enums **********************************************************************/
66
67 typedef enum {
68         resolveLazy,
69         resolveEager
70 } resolve_mode_t;
71
72 typedef enum {
73         resolveLinkageError,
74         resolveIllegalAccessError
75 } resolve_err_t;
76
77 typedef enum {
78         resolveFailed = false,  /* this must be a false value */
79         resolveDeferred = true, /* this must be a true value  */
80         resolveSucceeded
81 } resolve_result_t;
82
83 /* structs ********************************************************************/
84
85 struct unresolved_subtype_set {
86         classref_or_classinfo *subtyperefs;     /* NULL terminated list */
87 };
88
89 struct unresolved_class {
90         constant_classref      *classref;
91         methodinfo                     *referermethod;
92         unresolved_subtype_set  subtypeconstraints;
93 };
94
95 /* XXX unify heads of unresolved_field and unresolved_method? */
96
97 struct unresolved_field {
98         constant_FMIref *fieldref;
99         methodinfo      *referermethod;
100         s4               flags;
101         
102         unresolved_subtype_set  instancetypes;
103         unresolved_subtype_set  valueconstraints;
104 };
105
106 struct unresolved_method {
107         constant_FMIref *methodref;
108         methodinfo      *referermethod;
109         s4               flags;
110         
111         unresolved_subtype_set  instancetypes;
112         unresolved_subtype_set *paramconstraints;
113 };
114
115 #define SUBTYPESET_IS_EMPTY(stset) \
116         ((stset).subtyperefs == NULL)
117
118 #define UNRESOLVED_SUBTYPE_SET_EMTPY(stset) \
119         do { (stset).subtyperefs = NULL; } while(0)
120
121 /* function prototypes ********************************************************/
122
123 bool resolve_class_from_name(classinfo* referer,methodinfo *refmethod,
124                                                 utf *classname,
125                                                 resolve_mode_t mode,
126                                                 bool checkaccess,
127                                                 bool link,
128                                                 classinfo **result);
129
130 bool resolve_classref(methodinfo *refmethod,
131                                  constant_classref *ref,
132                                  resolve_mode_t mode,
133                                  bool checkaccess,
134                              bool link,
135                                  classinfo **result);
136
137 bool resolve_classref_or_classinfo(methodinfo *refmethod,
138                                                           classref_or_classinfo cls,
139                                                           resolve_mode_t mode,
140                                                           bool checkaccess,
141                                                           bool link,
142                                                           classinfo **result);
143
144 bool resolve_class_from_typedesc(typedesc *d,bool checkaccess,bool link,classinfo **result);
145
146 #ifdef ENABLE_VERIFIER
147 bool resolve_class(unresolved_class *ref,
148                           resolve_mode_t mode,
149                           bool checkaccess,
150                           classinfo **result);
151
152 classinfo * resolve_class_eager(unresolved_class *ref);
153 #endif /* ENABLE_VERIFIER */
154
155 bool resolve_field(unresolved_field *ref,
156                           resolve_mode_t mode,
157                           fieldinfo **result);
158
159 bool resolve_method(unresolved_method *ref,
160                           resolve_mode_t mode,
161                            methodinfo **result);
162
163 classinfo * resolve_classref_eager(constant_classref *ref);
164 classinfo * resolve_classref_eager_nonabstract(constant_classref *ref);
165 fieldinfo * resolve_field_eager(unresolved_field *ref);
166 methodinfo * resolve_method_eager(unresolved_method *ref);
167
168 #ifdef ENABLE_VERIFIER
169 unresolved_class * create_unresolved_class(methodinfo *refmethod,
170                                                 constant_classref *classref,
171                                                 typeinfo *valuetype);
172 #endif
173
174 unresolved_field *resolve_create_unresolved_field(classinfo *referer,
175                                                                                           methodinfo *refmethod,
176                                                                                           instruction *iptr);
177
178 unresolved_method * resolve_create_unresolved_method(classinfo *referer,
179                                                                                                          methodinfo *refmethod,
180                                                                                                          constant_FMIref *methodref,
181                                                                                                          bool invokestatic,
182                                                                                                          bool invokespecial);
183
184 void unresolved_class_free(unresolved_class *ref);
185 void unresolved_field_free(unresolved_field *ref);
186 void unresolved_method_free(unresolved_method *ref);
187
188 resolve_result_t resolve_method_lazy(methodinfo *refmethod,
189                                                                          constant_FMIref *methodref,
190                                                                          bool invokespecial);
191
192 resolve_result_t resolve_field_lazy(methodinfo *refmethod,
193                                                                         constant_FMIref *fieldref);
194
195 #if defined(ENABLE_VERIFIER)
196 resolve_result_t resolve_field_verifier_checks(methodinfo *refmethod,
197                                                                                            constant_FMIref *fieldref,
198                                                                                            classinfo *container,
199                                                                                            fieldinfo *fi,
200                                                                                            typeinfo *instanceti,
201                                                                                            typeinfo *valueti,
202                                                                                            bool isstatic,
203                                                                                            bool isput);
204
205 bool resolve_constrain_unresolved_field(unresolved_field *ref,
206                                                                                 classinfo *referer, 
207                                                                                 methodinfo *refmethod,
208                                                                             typeinfo *instanceti,
209                                                                             typeinfo *valueti);
210
211 resolve_result_t resolve_method_verifier_checks(methodinfo *refmethod,
212                                                                                                 constant_FMIref *methodref,
213                                                                                                 methodinfo *mi,
214                                                                                                 bool invokestatic);
215
216 resolve_result_t resolve_method_instance_type_checks(methodinfo *refmethod,
217                                                                                                          methodinfo *mi,
218                                                                                                          typeinfo *instanceti,
219                                                                                                          bool invokespecial);
220
221 resolve_result_t resolve_method_param_type_checks(jitdata *jd, 
222                                                                                                   methodinfo *refmethod,
223                                                                                                   instruction *iptr, 
224                                                                                                   methodinfo *mi,
225                                                                                                   bool invokestatic);
226
227 resolve_result_t resolve_method_param_type_checks_stackbased(
228                 methodinfo *refmethod, 
229                 methodinfo *mi,
230                 bool invokestatic, 
231                 typedescriptor *stack);
232
233 bool resolve_method_loading_constraints(classinfo *referer,
234                                                                                 methodinfo *mi);
235
236 bool resolve_constrain_unresolved_method_instance(unresolved_method *ref,
237                                                                                                   methodinfo *refmethod,
238                                                                                                   typeinfo *instanceti,
239                                                                                                   bool invokespecial);
240
241 bool resolve_constrain_unresolved_method_params(jitdata *jd,
242                                                                                                 unresolved_method *ref,
243                                                                                                 methodinfo *refmethod,
244                                                                                                 instruction *iptr);
245
246 bool resolve_constrain_unresolved_method_params_stackbased(
247                 unresolved_method *ref,
248                 methodinfo *refmethod,
249                 typedescriptor *stack);
250
251 #endif /* defined(ENABLE_VERIFIER) */
252
253 #ifndef NDEBUG
254 void unresolved_class_debug_dump(unresolved_class *ref,FILE *file);
255 void unresolved_field_debug_dump(unresolved_field *ref,FILE *file);
256 void unresolved_method_debug_dump(unresolved_method *ref,FILE *file);
257 void unresolved_subtype_set_debug_dump(unresolved_subtype_set *stset,FILE *file);
258 #endif
259         
260 #endif /* _RESOLVE_H */
261
262 /*
263  * These are local overrides for various environment variables in Emacs.
264  * Please do not remove this and leave it at the end of the file, where
265  * Emacs will automagically detect them.
266  * ---------------------------------------------------------------------
267  * Local variables:
268  * mode: c
269  * indent-tabs-mode: t
270  * c-basic-offset: 4
271  * tab-width: 4
272  * End:
273  * vim:noexpandtab:sw=4:ts=4:
274  */
275