Mercurial > jdk8-mips64-public > hotspot / file revision
src/share/vm/classfile/classFileParser.hpp@4ee06e614636
src/share/vm/classfile/classFileParser.hpp
Mon, 06 Aug 2012 15:54:45 -0400
- author
- kamg
- date
- Mon, 06 Aug 2012 15:54:45 -0400
- changeset 3992
- 4ee06e614636
- parent 3931
- dd785aabe02b
- child 3969
- 1d7922586cf6
- permissions
- -rw-r--r--
7116786: RFE: Detailed information on VerifyErrors
Summary: Provide additional detail in VerifyError messages
Reviewed-by: sspitsyn, acorn
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 typeArrayHandle _inner_classes;
66 typeArrayHandle _annotations;
68 void set_class_synthetic_flag(bool x) { _synthetic_flag = x; }
69 void set_class_sourcefile(Symbol* x) { _sourcefile = x; }
70 void set_class_generic_signature(Symbol* x) { _generic_signature = x; }
71 void set_class_sde_buffer(char* x, int len) { _sde_buffer = x; _sde_length = len; }
72 void set_class_inner_classes(typeArrayHandle x) { _inner_classes = x; }
73 void set_class_annotations(typeArrayHandle x) { _annotations = x; }
74 void init_parsed_class_attributes() {
75 _synthetic_flag = false;
76 _sourcefile = NULL;
77 _generic_signature = NULL;
78 _sde_buffer = NULL;
79 _sde_length = 0;
80 // initialize the other flags too:
81 _has_finalizer = _has_empty_finalizer = _has_vanilla_constructor = false;
82 _max_bootstrap_specifier_index = -1;
83 }
84 void apply_parsed_class_attributes(instanceKlassHandle k); // update k
86 class AnnotationCollector {
87 public:
88 enum Location { _in_field, _in_method, _in_class };
89 enum ID {
90 _unknown = 0,
91 _method_ForceInline,
92 _annotation_LIMIT
93 };
94 const Location _location;
95 int _annotations_present;
96 AnnotationCollector(Location location)
97 : _location(location), _annotations_present(0)
98 {
99 assert((int)_annotation_LIMIT <= (int)sizeof(_annotations_present) * BitsPerByte, "");
100 }
101 // If this annotation name has an ID, report it (or _none).
102 ID annotation_index(Symbol* name);
103 // Set the annotation name:
104 void set_annotation(ID id) {
105 assert((int)id >= 0 && (int)id < (int)_annotation_LIMIT, "oob");
106 _annotations_present |= nth_bit((int)id);
107 }
108 // Report if the annotation is present.
109 bool has_any_annotations() { return _annotations_present != 0; }
110 bool has_annotation(ID id) { return (nth_bit((int)id) & _annotations_present) != 0; }
111 };
112 class FieldAnnotationCollector: public AnnotationCollector {
113 public:
114 FieldAnnotationCollector() : AnnotationCollector(_in_field) { }
115 void apply_to(FieldInfo* f);
116 };
117 class MethodAnnotationCollector: public AnnotationCollector {
118 public:
119 MethodAnnotationCollector() : AnnotationCollector(_in_method) { }
120 void apply_to(methodHandle m);
121 };
122 class ClassAnnotationCollector: public AnnotationCollector {
123 public:
124 ClassAnnotationCollector() : AnnotationCollector(_in_class) { }
125 void apply_to(instanceKlassHandle k);
126 };
128 enum { fixed_buffer_size = 128 };
129 u_char linenumbertable_buffer[fixed_buffer_size];
131 ClassFileStream* _stream; // Actual input stream
133 enum { LegalClass, LegalField, LegalMethod }; // used to verify unqualified names
135 // Accessors
136 ClassFileStream* stream() { return _stream; }
137 void set_stream(ClassFileStream* st) { _stream = st; }
139 // Constant pool parsing
140 void parse_constant_pool_entries(Handle class_loader,
141 constantPoolHandle cp, int length, TRAPS);
143 constantPoolHandle parse_constant_pool(Handle class_loader, TRAPS);
145 // Interface parsing
146 objArrayHandle parse_interfaces(constantPoolHandle cp,
147 int length,
148 Handle class_loader,
149 Handle protection_domain,
150 Symbol* class_name,
151 TRAPS);
153 // Field parsing
154 void parse_field_attributes(constantPoolHandle cp, u2 attributes_count,
155 bool is_static, u2 signature_index,
156 u2* constantvalue_index_addr,
157 bool* is_synthetic_addr,
158 u2* generic_signature_index_addr,
159 typeArrayHandle* field_annotations,
160 FieldAnnotationCollector* parsed_annotations,
161 TRAPS);
162 typeArrayHandle parse_fields(Symbol* class_name,
163 constantPoolHandle cp, bool is_interface,
164 FieldAllocationCount *fac,
165 objArrayHandle* fields_annotations,
166 u2* java_fields_count_ptr, TRAPS);
168 // Method parsing
169 methodHandle parse_method(constantPoolHandle cp, bool is_interface,
170 AccessFlags* promoted_flags,
171 typeArrayHandle* method_annotations,
172 typeArrayHandle* method_parameter_annotations,
173 typeArrayHandle* method_default_annotations,
174 TRAPS);
175 objArrayHandle parse_methods (constantPoolHandle cp, bool is_interface,
176 AccessFlags* promoted_flags,
177 bool* has_final_method,
178 objArrayOop* methods_annotations_oop,
179 objArrayOop* methods_parameter_annotations_oop,
180 objArrayOop* methods_default_annotations_oop,
181 TRAPS);
182 typeArrayHandle sort_methods (objArrayHandle methods,
183 objArrayHandle methods_annotations,
184 objArrayHandle methods_parameter_annotations,
185 objArrayHandle methods_default_annotations,
186 TRAPS);
187 u2* parse_exception_table(u4 code_length, u4 exception_table_length,
188 constantPoolHandle cp, TRAPS);
189 void parse_linenumber_table(
190 u4 code_attribute_length, u4 code_length,
191 CompressedLineNumberWriteStream** write_stream, TRAPS);
192 u2* parse_localvariable_table(u4 code_length, u2 max_locals, u4 code_attribute_length,
193 constantPoolHandle cp, u2* localvariable_table_length,
194 bool isLVTT, TRAPS);
195 u2* parse_checked_exceptions(u2* checked_exceptions_length, u4 method_attribute_length,
196 constantPoolHandle cp, TRAPS);
197 void parse_type_array(u2 array_length, u4 code_length, u4* u1_index, u4* u2_index,
198 u1* u1_array, u2* u2_array, constantPoolHandle cp, TRAPS);
199 typeArrayOop parse_stackmap_table(u4 code_attribute_length, TRAPS);
201 // Classfile attribute parsing
202 void parse_classfile_sourcefile_attribute(constantPoolHandle cp, TRAPS);
203 void parse_classfile_source_debug_extension_attribute(constantPoolHandle cp, int length, TRAPS);
204 u2 parse_classfile_inner_classes_attribute(u1* inner_classes_attribute_start,
205 bool parsed_enclosingmethod_attribute,
206 u2 enclosing_method_class_index,
207 u2 enclosing_method_method_index,
208 constantPoolHandle cp,
209 TRAPS);
210 void parse_classfile_attributes(constantPoolHandle cp,
211 ClassAnnotationCollector* parsed_annotations,
212 TRAPS);
213 void parse_classfile_synthetic_attribute(constantPoolHandle cp, TRAPS);
214 void parse_classfile_signature_attribute(constantPoolHandle cp, TRAPS);
215 void parse_classfile_bootstrap_methods_attribute(constantPoolHandle cp, u4 attribute_length, TRAPS);
217 // Annotations handling
218 typeArrayHandle assemble_annotations(u1* runtime_visible_annotations,
219 int runtime_visible_annotations_length,
220 u1* runtime_invisible_annotations,
221 int runtime_invisible_annotations_length, TRAPS);
222 int skip_annotation(u1* buffer, int limit, int index);
223 int skip_annotation_value(u1* buffer, int limit, int index);
224 void parse_annotations(u1* buffer, int limit, constantPoolHandle cp,
225 /* Results (currently, only one result is supported): */
226 AnnotationCollector* result,
227 TRAPS);
229 // Final setup
230 unsigned int compute_oop_map_count(instanceKlassHandle super,
231 unsigned int nonstatic_oop_count,
232 int first_nonstatic_oop_offset);
233 void fill_oop_maps(instanceKlassHandle k,
234 unsigned int nonstatic_oop_map_count,
235 int* nonstatic_oop_offsets,
236 unsigned int* nonstatic_oop_counts);
237 void set_precomputed_flags(instanceKlassHandle k);
238 objArrayHandle compute_transitive_interfaces(instanceKlassHandle super,
239 objArrayHandle local_ifs, TRAPS);
241 // Format checker methods
242 void classfile_parse_error(const char* msg, TRAPS);
243 void classfile_parse_error(const char* msg, int index, TRAPS);
244 void classfile_parse_error(const char* msg, const char *name, TRAPS);
245 void classfile_parse_error(const char* msg, int index, const char *name, TRAPS);
246 inline void guarantee_property(bool b, const char* msg, TRAPS) {
247 if (!b) { classfile_parse_error(msg, CHECK); }
248 }
250 inline void assert_property(bool b, const char* msg, TRAPS) {
251 #ifdef ASSERT
252 if (!b) { fatal(msg); }
253 #endif
254 }
256 inline void check_property(bool property, const char* msg, int index, TRAPS) {
257 if (_need_verify) {
258 guarantee_property(property, msg, index, CHECK);
259 } else {
260 assert_property(property, msg, CHECK);
261 }
262 }
264 inline void check_property(bool property, const char* msg, TRAPS) {
265 if (_need_verify) {
266 guarantee_property(property, msg, CHECK);
267 } else {
268 assert_property(property, msg, CHECK);
269 }
270 }
272 inline void guarantee_property(bool b, const char* msg, int index, TRAPS) {
273 if (!b) { classfile_parse_error(msg, index, CHECK); }
274 }
275 inline void guarantee_property(bool b, const char* msg, const char *name, TRAPS) {
276 if (!b) { classfile_parse_error(msg, name, CHECK); }
277 }
278 inline void guarantee_property(bool b, const char* msg, int index, const char *name, TRAPS) {
279 if (!b) { classfile_parse_error(msg, index, name, CHECK); }
280 }
282 void throwIllegalSignature(
283 const char* type, Symbol* name, Symbol* sig, TRAPS);
285 bool is_supported_version(u2 major, u2 minor);
286 bool has_illegal_visibility(jint flags);
288 void verify_constantvalue(int constantvalue_index, int signature_index, constantPoolHandle cp, TRAPS);
289 void verify_legal_utf8(const unsigned char* buffer, int length, TRAPS);
290 void verify_legal_class_name(Symbol* name, TRAPS);
291 void verify_legal_field_name(Symbol* name, TRAPS);
292 void verify_legal_method_name(Symbol* name, TRAPS);
293 void verify_legal_field_signature(Symbol* fieldname, Symbol* signature, TRAPS);
294 int verify_legal_method_signature(Symbol* methodname, Symbol* signature, TRAPS);
295 void verify_legal_class_modifiers(jint flags, TRAPS);
296 void verify_legal_field_modifiers(jint flags, bool is_interface, TRAPS);
297 void verify_legal_method_modifiers(jint flags, bool is_interface, Symbol* name, TRAPS);
298 bool verify_unqualified_name(char* name, unsigned int length, int type);
299 char* skip_over_field_name(char* name, bool slash_ok, unsigned int length);
300 char* skip_over_field_signature(char* signature, bool void_ok, unsigned int length, TRAPS);
302 bool is_anonymous() {
303 assert(EnableInvokeDynamic || _host_klass.is_null(), "");
304 return _host_klass.not_null();
305 }
306 bool has_cp_patch_at(int index) {
307 assert(EnableInvokeDynamic, "");
308 assert(index >= 0, "oob");
309 return (_cp_patches != NULL
310 && index < _cp_patches->length()
311 && _cp_patches->adr_at(index)->not_null());
312 }
313 Handle cp_patch_at(int index) {
314 assert(has_cp_patch_at(index), "oob");
315 return _cp_patches->at(index);
316 }
317 Handle clear_cp_patch_at(int index) {
318 Handle patch = cp_patch_at(index);
319 _cp_patches->at_put(index, Handle());
320 assert(!has_cp_patch_at(index), "");
321 return patch;
322 }
323 void patch_constant_pool(constantPoolHandle cp, int index, Handle patch, TRAPS);
325 // Wrapper for constantTag.is_klass_[or_]reference.
326 // In older versions of the VM, klassOops cannot sneak into early phases of
327 // constant pool construction, but in later versions they can.
328 // %%% Let's phase out the old is_klass_reference.
329 bool is_klass_reference(constantPoolHandle cp, int index) {
330 return ((LinkWellKnownClasses || EnableInvokeDynamic)
331 ? cp->tag_at(index).is_klass_or_reference()
332 : cp->tag_at(index).is_klass_reference());
333 }
335 public:
336 // Constructor
337 ClassFileParser(ClassFileStream* st) { set_stream(st); }
339 // Parse .class file and return new klassOop. The klassOop is not hooked up
340 // to the system dictionary or any other structures, so a .class file can
341 // be loaded several times if desired.
342 // The system dictionary hookup is done by the caller.
343 //
344 // "parsed_name" is updated by this method, and is the name found
345 // while parsing the stream.
346 instanceKlassHandle parseClassFile(Symbol* name,
347 Handle class_loader,
348 Handle protection_domain,
349 TempNewSymbol& parsed_name,
350 bool verify,
351 TRAPS) {
352 KlassHandle no_host_klass;
353 return parseClassFile(name, class_loader, protection_domain, no_host_klass, NULL, parsed_name, verify, THREAD);
354 }
355 instanceKlassHandle parseClassFile(Symbol* name,
356 Handle class_loader,
357 Handle protection_domain,
358 KlassHandle host_klass,
359 GrowableArray<Handle>* cp_patches,
360 TempNewSymbol& parsed_name,
361 bool verify,
362 TRAPS);
364 // Verifier checks
365 static void check_super_class_access(instanceKlassHandle this_klass, TRAPS);
366 static void check_super_interface_access(instanceKlassHandle this_klass, TRAPS);
367 static void check_final_method_override(instanceKlassHandle this_klass, TRAPS);
368 static void check_illegal_static_method(instanceKlassHandle this_klass, TRAPS);
369 };
371 #endif // SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP
