Mercurial > jdk8-mips64-public > hotspot / file revision
src/share/vm/classfile/classFileParser.hpp@35431a769282
src/share/vm/classfile/classFileParser.hpp
Thu, 20 Dec 2012 10:22:19 +0100
- author
- stefank
- date
- Thu, 20 Dec 2012 10:22:19 +0100
- changeset 4393
- 35431a769282
- parent 4304
- 90273fc0a981
- child 4430
- 4a916f2ce331
- permissions
- -rw-r--r--
8004823: Add VM support for type annotation reflection
Reviewed-by: dholmes, coleenp
Contributed-by: joel.franck@oracle.com
1 /*
2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
25 #ifndef SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP
26 #define SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP
28 #include "classfile/classFileStream.hpp"
29 #include "memory/resourceArea.hpp"
30 #include "oops/oop.inline.hpp"
31 #include "oops/typeArrayOop.hpp"
32 #include "runtime/handles.inline.hpp"
33 #include "utilities/accessFlags.hpp"
34 #include "classfile/symbolTable.hpp"
36 class FieldAllocationCount;
39 // Parser for for .class files
40 //
41 // The bytes describing the class file structure is read from a Stream object
43 class ClassFileParser VALUE_OBJ_CLASS_SPEC {
44 private:
45 bool _need_verify;
46 bool _relax_verify;
47 u2 _major_version;
48 u2 _minor_version;
49 Symbol* _class_name;
50 KlassHandle _host_klass;
51 GrowableArray<Handle>* _cp_patches; // overrides for CP entries
53 // precomputed flags
54 bool _has_finalizer;
55 bool _has_empty_finalizer;
56 bool _has_vanilla_constructor;
57 int _max_bootstrap_specifier_index; // detects BSS values
59 // class attributes parsed before the instance klass is created:
60 bool _synthetic_flag;
61 Symbol* _sourcefile;
62 Symbol* _generic_signature;
63 char* _sde_buffer;
64 int _sde_length;
65 Array<u2>* _inner_classes;
66 AnnotationArray* _annotations;
67 AnnotationArray* _type_annotations;
69 void set_class_synthetic_flag(bool x) { _synthetic_flag = x; }
70 void set_class_sourcefile(Symbol* x) { _sourcefile = x; }
71 void set_class_generic_signature(Symbol* x) { _generic_signature = x; }
72 void set_class_sde_buffer(char* x, int len) { _sde_buffer = x; _sde_length = len; }
73 void set_class_inner_classes(Array<u2>* x) { _inner_classes = x; }
74 void set_class_annotations(AnnotationArray* x) { _annotations = x; }
75 void set_class_type_annotations(AnnotationArray* x) { _type_annotations = x; }
76 void init_parsed_class_attributes() {
77 _synthetic_flag = false;
78 _sourcefile = NULL;
79 _generic_signature = NULL;
80 _sde_buffer = NULL;
81 _sde_length = 0;
82 _annotations = _type_annotations = NULL;
83 // initialize the other flags too:
84 _has_finalizer = _has_empty_finalizer = _has_vanilla_constructor = false;
85 _max_bootstrap_specifier_index = -1;
86 }
87 void apply_parsed_class_attributes(instanceKlassHandle k); // update k
89 class AnnotationCollector {
90 public:
91 enum Location { _in_field, _in_method, _in_class };
92 enum ID {
93 _unknown = 0,
94 _method_ForceInline,
95 _method_DontInline,
96 _method_LambdaForm_Compiled,
97 _method_LambdaForm_Hidden,
98 _annotation_LIMIT
99 };
100 const Location _location;
101 int _annotations_present;
102 AnnotationCollector(Location location)
103 : _location(location), _annotations_present(0)
104 {
105 assert((int)_annotation_LIMIT <= (int)sizeof(_annotations_present) * BitsPerByte, "");
106 }
107 // If this annotation name has an ID, report it (or _none).
108 ID annotation_index(Symbol* name);
109 // Set the annotation name:
110 void set_annotation(ID id) {
111 assert((int)id >= 0 && (int)id < (int)_annotation_LIMIT, "oob");
112 _annotations_present |= nth_bit((int)id);
113 }
114 // Report if the annotation is present.
115 bool has_any_annotations() { return _annotations_present != 0; }
116 bool has_annotation(ID id) { return (nth_bit((int)id) & _annotations_present) != 0; }
117 };
118 class FieldAnnotationCollector: public AnnotationCollector {
119 public:
120 FieldAnnotationCollector() : AnnotationCollector(_in_field) { }
121 void apply_to(FieldInfo* f);
122 };
123 class MethodAnnotationCollector: public AnnotationCollector {
124 public:
125 MethodAnnotationCollector() : AnnotationCollector(_in_method) { }
126 void apply_to(methodHandle m);
127 };
128 class ClassAnnotationCollector: public AnnotationCollector {
129 public:
130 ClassAnnotationCollector() : AnnotationCollector(_in_class) { }
131 void apply_to(instanceKlassHandle k);
132 };
134 enum { fixed_buffer_size = 128 };
135 u_char linenumbertable_buffer[fixed_buffer_size];
137 ClassFileStream* _stream; // Actual input stream
139 enum { LegalClass, LegalField, LegalMethod }; // used to verify unqualified names
141 // Accessors
142 ClassFileStream* stream() { return _stream; }
143 void set_stream(ClassFileStream* st) { _stream = st; }
145 // Constant pool parsing
146 void parse_constant_pool_entries(ClassLoaderData* loader_data,
147 constantPoolHandle cp, int length, TRAPS);
149 constantPoolHandle parse_constant_pool(ClassLoaderData* loader_data, TRAPS);
151 // Interface parsing
152 Array<Klass*>* parse_interfaces(constantPoolHandle cp,
153 int length,
154 ClassLoaderData* loader_data,
155 Handle protection_domain,
156 Symbol* class_name,
157 bool* has_default_methods,
158 TRAPS);
159 void record_defined_class_dependencies(instanceKlassHandle defined_klass, TRAPS);
161 // Field parsing
162 void parse_field_attributes(ClassLoaderData* loader_data,
163 constantPoolHandle cp, u2 attributes_count,
164 bool is_static, u2 signature_index,
165 u2* constantvalue_index_addr,
166 bool* is_synthetic_addr,
167 u2* generic_signature_index_addr,
168 AnnotationArray** field_annotations,
169 AnnotationArray** field_type_annotations,
170 FieldAnnotationCollector* parsed_annotations,
171 TRAPS);
172 Array<u2>* parse_fields(ClassLoaderData* loader_data,
173 Symbol* class_name,
174 constantPoolHandle cp, bool is_interface,
175 FieldAllocationCount *fac,
176 Array<AnnotationArray*>** fields_annotations,
177 Array<AnnotationArray*>** fields_type_annotations,
178 u2* java_fields_count_ptr, TRAPS);
180 // Method parsing
181 methodHandle parse_method(ClassLoaderData* loader_data,
182 constantPoolHandle cp,
183 bool is_interface,
184 AccessFlags* promoted_flags,
185 AnnotationArray** method_annotations,
186 AnnotationArray** method_parameter_annotations,
187 AnnotationArray** method_default_annotations,
188 AnnotationArray** method_type_annotations,
189 TRAPS);
190 Array<Method*>* parse_methods(ClassLoaderData* loader_data,
191 constantPoolHandle cp,
192 bool is_interface,
193 AccessFlags* promoted_flags,
194 bool* has_final_method,
195 Array<AnnotationArray*>** methods_annotations,
196 Array<AnnotationArray*>** methods_parameter_annotations,
197 Array<AnnotationArray*>** methods_default_annotations,
198 Array<AnnotationArray*>** methods_type_annotations,
199 bool* has_default_method,
200 TRAPS);
201 Array<int>* sort_methods(ClassLoaderData* loader_data,
202 Array<Method*>* methods,
203 Array<AnnotationArray*>* methods_annotations,
204 Array<AnnotationArray*>* methods_parameter_annotations,
205 Array<AnnotationArray*>* methods_default_annotations,
206 Array<AnnotationArray*>* methods_type_annotations,
207 TRAPS);
208 u2* parse_exception_table(ClassLoaderData* loader_data,
209 u4 code_length, u4 exception_table_length,
210 constantPoolHandle cp, TRAPS);
211 void parse_linenumber_table(
212 u4 code_attribute_length, u4 code_length,
213 CompressedLineNumberWriteStream** write_stream, TRAPS);
214 u2* parse_localvariable_table(u4 code_length, u2 max_locals, u4 code_attribute_length,
215 constantPoolHandle cp, u2* localvariable_table_length,
216 bool isLVTT, TRAPS);
217 u2* parse_checked_exceptions(u2* checked_exceptions_length, u4 method_attribute_length,
218 constantPoolHandle cp, TRAPS);
219 void parse_type_array(u2 array_length, u4 code_length, u4* u1_index, u4* u2_index,
220 u1* u1_array, u2* u2_array, constantPoolHandle cp, TRAPS);
221 Array<u1>* parse_stackmap_table(ClassLoaderData* loader_data, u4 code_attribute_length, TRAPS);
223 // Classfile attribute parsing
224 void parse_classfile_sourcefile_attribute(constantPoolHandle cp, TRAPS);
225 void parse_classfile_source_debug_extension_attribute(constantPoolHandle cp,
226 int length, TRAPS);
227 u2 parse_classfile_inner_classes_attribute(ClassLoaderData* loader_data,
228 u1* inner_classes_attribute_start,
229 bool parsed_enclosingmethod_attribute,
230 u2 enclosing_method_class_index,
231 u2 enclosing_method_method_index,
232 constantPoolHandle cp,
233 TRAPS);
234 void parse_classfile_attributes(ClassLoaderData* loader_data,
235 constantPoolHandle cp,
236 ClassAnnotationCollector* parsed_annotations,
237 TRAPS);
238 void parse_classfile_synthetic_attribute(constantPoolHandle cp, TRAPS);
239 void parse_classfile_signature_attribute(constantPoolHandle cp, TRAPS);
240 void parse_classfile_bootstrap_methods_attribute(ClassLoaderData* loader_data, constantPoolHandle cp, u4 attribute_length, TRAPS);
242 // Annotations handling
243 AnnotationArray* assemble_annotations(ClassLoaderData* loader_data,
244 u1* runtime_visible_annotations,
245 int runtime_visible_annotations_length,
246 u1* runtime_invisible_annotations,
247 int runtime_invisible_annotations_length, TRAPS);
248 int skip_annotation(u1* buffer, int limit, int index);
249 int skip_annotation_value(u1* buffer, int limit, int index);
250 void parse_annotations(u1* buffer, int limit, constantPoolHandle cp,
251 /* Results (currently, only one result is supported): */
252 AnnotationCollector* result,
253 TRAPS);
255 // Final setup
256 unsigned int compute_oop_map_count(instanceKlassHandle super,
257 unsigned int nonstatic_oop_count,
258 int first_nonstatic_oop_offset);
259 void fill_oop_maps(instanceKlassHandle k,
260 unsigned int nonstatic_oop_map_count,
261 int* nonstatic_oop_offsets,
262 unsigned int* nonstatic_oop_counts);
263 void set_precomputed_flags(instanceKlassHandle k);
264 Array<Klass*>* compute_transitive_interfaces(ClassLoaderData* loader_data,
265 instanceKlassHandle super,
266 Array<Klass*>* local_ifs, TRAPS);
268 // Format checker methods
269 void classfile_parse_error(const char* msg, TRAPS);
270 void classfile_parse_error(const char* msg, int index, TRAPS);
271 void classfile_parse_error(const char* msg, const char *name, TRAPS);
272 void classfile_parse_error(const char* msg, int index, const char *name, TRAPS);
273 inline void guarantee_property(bool b, const char* msg, TRAPS) {
274 if (!b) { classfile_parse_error(msg, CHECK); }
275 }
277 inline void assert_property(bool b, const char* msg, TRAPS) {
278 #ifdef ASSERT
279 if (!b) { fatal(msg); }
280 #endif
281 }
283 inline void check_property(bool property, const char* msg, int index, TRAPS) {
284 if (_need_verify) {
285 guarantee_property(property, msg, index, CHECK);
286 } else {
287 assert_property(property, msg, CHECK);
288 }
289 }
291 inline void check_property(bool property, const char* msg, TRAPS) {
292 if (_need_verify) {
293 guarantee_property(property, msg, CHECK);
294 } else {
295 assert_property(property, msg, CHECK);
296 }
297 }
299 inline void guarantee_property(bool b, const char* msg, int index, TRAPS) {
300 if (!b) { classfile_parse_error(msg, index, CHECK); }
301 }
302 inline void guarantee_property(bool b, const char* msg, const char *name, TRAPS) {
303 if (!b) { classfile_parse_error(msg, name, CHECK); }
304 }
305 inline void guarantee_property(bool b, const char* msg, int index, const char *name, TRAPS) {
306 if (!b) { classfile_parse_error(msg, index, name, CHECK); }
307 }
309 void throwIllegalSignature(
310 const char* type, Symbol* name, Symbol* sig, TRAPS);
312 bool is_supported_version(u2 major, u2 minor);
313 bool has_illegal_visibility(jint flags);
315 void verify_constantvalue(int constantvalue_index, int signature_index, constantPoolHandle cp, TRAPS);
316 void verify_legal_utf8(const unsigned char* buffer, int length, TRAPS);
317 void verify_legal_class_name(Symbol* name, TRAPS);
318 void verify_legal_field_name(Symbol* name, TRAPS);
319 void verify_legal_method_name(Symbol* name, TRAPS);
320 void verify_legal_field_signature(Symbol* fieldname, Symbol* signature, TRAPS);
321 int verify_legal_method_signature(Symbol* methodname, Symbol* signature, TRAPS);
322 void verify_legal_class_modifiers(jint flags, TRAPS);
323 void verify_legal_field_modifiers(jint flags, bool is_interface, TRAPS);
324 void verify_legal_method_modifiers(jint flags, bool is_interface, Symbol* name, TRAPS);
325 bool verify_unqualified_name(char* name, unsigned int length, int type);
326 char* skip_over_field_name(char* name, bool slash_ok, unsigned int length);
327 char* skip_over_field_signature(char* signature, bool void_ok, unsigned int length, TRAPS);
329 bool is_anonymous() {
330 assert(EnableInvokeDynamic || _host_klass.is_null(), "");
331 return _host_klass.not_null();
332 }
333 bool has_cp_patch_at(int index) {
334 assert(EnableInvokeDynamic, "");
335 assert(index >= 0, "oob");
336 return (_cp_patches != NULL
337 && index < _cp_patches->length()
338 && _cp_patches->adr_at(index)->not_null());
339 }
340 Handle cp_patch_at(int index) {
341 assert(has_cp_patch_at(index), "oob");
342 return _cp_patches->at(index);
343 }
344 Handle clear_cp_patch_at(int index) {
345 Handle patch = cp_patch_at(index);
346 _cp_patches->at_put(index, Handle());
347 assert(!has_cp_patch_at(index), "");
348 return patch;
349 }
350 void patch_constant_pool(constantPoolHandle cp, int index, Handle patch, TRAPS);
352 // Wrapper for constantTag.is_klass_[or_]reference.
353 // In older versions of the VM, Klass*s cannot sneak into early phases of
354 // constant pool construction, but in later versions they can.
355 // %%% Let's phase out the old is_klass_reference.
356 bool is_klass_reference(constantPoolHandle cp, int index) {
357 return (EnableInvokeDynamic
358 ? cp->tag_at(index).is_klass_or_reference()
359 : cp->tag_at(index).is_klass_reference());
360 }
362 public:
363 // Constructor
364 ClassFileParser(ClassFileStream* st) { set_stream(st); }
366 // Parse .class file and return new Klass*. The Klass* is not hooked up
367 // to the system dictionary or any other structures, so a .class file can
368 // be loaded several times if desired.
369 // The system dictionary hookup is done by the caller.
370 //
371 // "parsed_name" is updated by this method, and is the name found
372 // while parsing the stream.
373 instanceKlassHandle parseClassFile(Symbol* name,
374 ClassLoaderData* loader_data,
375 Handle protection_domain,
376 TempNewSymbol& parsed_name,
377 bool verify,
378 TRAPS) {
379 KlassHandle no_host_klass;
380 return parseClassFile(name, loader_data, protection_domain, no_host_klass, NULL, parsed_name, verify, THREAD);
381 }
382 instanceKlassHandle parseClassFile(Symbol* name,
383 ClassLoaderData* loader_data,
384 Handle protection_domain,
385 KlassHandle host_klass,
386 GrowableArray<Handle>* cp_patches,
387 TempNewSymbol& parsed_name,
388 bool verify,
389 TRAPS);
391 // Verifier checks
392 static void check_super_class_access(instanceKlassHandle this_klass, TRAPS);
393 static void check_super_interface_access(instanceKlassHandle this_klass, TRAPS);
394 static void check_final_method_override(instanceKlassHandle this_klass, TRAPS);
395 static void check_illegal_static_method(instanceKlassHandle this_klass, TRAPS);
396 };
398 #endif // SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP
