1 /*
2 * Copyright (c) 1997, 2015, 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 */
24
25 #ifndef SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP
26 #define SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP
27
28 #include "classfile/classFileStream.hpp"
29 #include "classfile/symbolTable.hpp"
30 #include "oops/annotations.hpp"
31 #include "oops/constantPool.hpp"
32 #include "oops/typeArrayOop.hpp"
33 #include "utilities/accessFlags.hpp"
34
35 class CompressedLineNumberWriteStream;
36 class FieldAllocationCount;
37 class FieldInfo;
38 class FieldLayoutInfo;
39
40
41 // Parser for for .class files
42 //
43 // The bytes describing the class file structure is read from a Stream object
44
45 class ClassFileParser VALUE_OBJ_CLASS_SPEC {
46 private:
47 bool _need_verify;
48 bool _relax_verify;
49 u2 _major_version;
50 u2 _minor_version;
51 Symbol* _class_name;
52 ClassLoaderData* _loader_data;
53 KlassHandle _host_klass;
54 GrowableArray<Handle>* _cp_patches; // overrides for CP entries
55
56 // precomputed flags
57 bool _has_finalizer;
58 bool _has_empty_finalizer;
59 bool _has_vanilla_constructor;
60 int _max_bootstrap_specifier_index; // detects BSS values
61
62 // class attributes parsed before the instance klass is created:
63 bool _synthetic_flag;
64 int _sde_length;
65 char* _sde_buffer;
66 u2 _sourcefile_index;
67 u2 _generic_signature_index;
68
69 // Metadata created before the instance klass is created. Must be deallocated
70 // if not transferred to the InstanceKlass upon successful class loading
71 // in which case these pointers have been set to NULL.
72 instanceKlassHandle _super_klass;
73 ConstantPool* _cp;
74 Array<u2>* _fields;
75 Array<Method*>* _methods;
76 Array<u2>* _inner_classes;
77 Array<Klass*>* _local_interfaces;
78 Array<Klass*>* _transitive_interfaces;
79 Annotations* _combined_annotations;
80 AnnotationArray* _annotations;
81 AnnotationArray* _type_annotations;
82 Array<AnnotationArray*>* _fields_annotations;
83 Array<AnnotationArray*>* _fields_type_annotations;
84 InstanceKlass* _klass; // InstanceKlass once created.
85
86 void set_class_synthetic_flag(bool x) { _synthetic_flag = x; }
87 void set_class_sourcefile_index(u2 x) { _sourcefile_index = x; }
88 void set_class_generic_signature_index(u2 x) { _generic_signature_index = x; }
89 void set_class_sde_buffer(char* x, int len) { _sde_buffer = x; _sde_length = len; }
90
91 void create_combined_annotations(TRAPS);
92
93 void init_parsed_class_attributes(ClassLoaderData* loader_data) {
94 _loader_data = loader_data;
95 _synthetic_flag = false;
96 _sourcefile_index = 0;
97 _generic_signature_index = 0;
98 _sde_buffer = NULL;
99 _sde_length = 0;
100 // initialize the other flags too:
101 _has_finalizer = _has_empty_finalizer = _has_vanilla_constructor = false;
102 _max_bootstrap_specifier_index = -1;
103 clear_class_metadata();
104 _klass = NULL;
105 }
106 void apply_parsed_class_attributes(instanceKlassHandle k); // update k
107 void apply_parsed_class_metadata(instanceKlassHandle k, int fields_count, TRAPS);
108 void clear_class_metadata() {
109 // metadata created before the instance klass is created. Must be
110 // deallocated if classfile parsing returns an error.
111 _cp = NULL;
112 _fields = NULL;
113 _methods = NULL;
114 _inner_classes = NULL;
115 _local_interfaces = NULL;
116 _transitive_interfaces = NULL;
117 _combined_annotations = NULL;
118 _annotations = _type_annotations = NULL;
119 _fields_annotations = _fields_type_annotations = NULL;
120 }
121
122 class AnnotationCollector {
123 public:
124 enum Location { _in_field, _in_method, _in_class };
125 enum ID {
126 _unknown = 0,
127 _method_CallerSensitive,
128 _method_ForceInline,
129 _method_DontInline,
130 _method_InjectedProfile,
131 _method_LambdaForm_Compiled,
132 _method_LambdaForm_Hidden,
133 _sun_misc_Contended,
134 _field_Stable,
135 _annotation_LIMIT
136 };
137 const Location _location;
138 int _annotations_present;
139 u2 _contended_group;
140
141 AnnotationCollector(Location location)
142 : _location(location), _annotations_present(0)
143 {
144 assert((int)_annotation_LIMIT <= (int)sizeof(_annotations_present) * BitsPerByte, "");
145 }
146 // If this annotation name has an ID, report it (or _none).
147 ID annotation_index(ClassLoaderData* loader_data, Symbol* name);
148 // Set the annotation name:
149 void set_annotation(ID id) {
150 assert((int)id >= 0 && (int)id < (int)_annotation_LIMIT, "oob");
151 _annotations_present |= nth_bit((int)id);
152 }
153
154 void remove_annotation(ID id) {
155 assert((int)id >= 0 && (int)id < (int)_annotation_LIMIT, "oob");
156 _annotations_present &= ~nth_bit((int)id);
157 }
158
159 // Report if the annotation is present.
160 bool has_any_annotations() const { return _annotations_present != 0; }
161 bool has_annotation(ID id) const { return (nth_bit((int)id) & _annotations_present) != 0; }
162
163 void set_contended_group(u2 group) { _contended_group = group; }
164 u2 contended_group() const { return _contended_group; }
165
166 bool is_contended() const { return has_annotation(_sun_misc_Contended); }
167
168 void set_stable(bool stable) { set_annotation(_field_Stable); }
169 bool is_stable() const { return has_annotation(_field_Stable); }
170 };
171
172 // This class also doubles as a holder for metadata cleanup.
173 class FieldAnnotationCollector: public AnnotationCollector {
174 ClassLoaderData* _loader_data;
175 AnnotationArray* _field_annotations;
176 AnnotationArray* _field_type_annotations;
177 public:
178 FieldAnnotationCollector(ClassLoaderData* loader_data) :
179 AnnotationCollector(_in_field),
180 _loader_data(loader_data),
181 _field_annotations(NULL),
182 _field_type_annotations(NULL) {}
183 void apply_to(FieldInfo* f);
184 ~FieldAnnotationCollector();
185 AnnotationArray* field_annotations() { return _field_annotations; }
186 AnnotationArray* field_type_annotations() { return _field_type_annotations; }
187
188 void set_field_annotations(AnnotationArray* a) { _field_annotations = a; }
189 void set_field_type_annotations(AnnotationArray* a) { _field_type_annotations = a; }
190 };
191
192 class MethodAnnotationCollector: public AnnotationCollector {
193 public:
194 MethodAnnotationCollector() : AnnotationCollector(_in_method) { }
195 void apply_to(methodHandle m);
196 };
197 class ClassAnnotationCollector: public AnnotationCollector {
198 public:
199 ClassAnnotationCollector() : AnnotationCollector(_in_class) { }
200 void apply_to(instanceKlassHandle k);
201 };
202
203 enum { fixed_buffer_size = 128 };
204 u_char linenumbertable_buffer[fixed_buffer_size];
205
206 ClassFileStream* _stream; // Actual input stream
207
208 enum { LegalClass, LegalField, LegalMethod }; // used to verify unqualified names
209
210 // Accessors
211 ClassFileStream* stream() { return _stream; }
212 void set_stream(ClassFileStream* st) { _stream = st; }
213
214 // Constant pool parsing
215 void parse_constant_pool_entries(int length, TRAPS);
216
217 constantPoolHandle parse_constant_pool(TRAPS);
218
219 // Interface parsing
220 Array<Klass*>* parse_interfaces(int length,
221 Handle protection_domain,
222 Symbol* class_name,
223 bool* has_default_methods,
224 TRAPS);
225 void record_defined_class_dependencies(instanceKlassHandle defined_klass, TRAPS);
226
227 instanceKlassHandle parse_super_class(int super_class_index, TRAPS);
228 // Field parsing
229 void parse_field_attributes(u2 attributes_count,
230 bool is_static, u2 signature_index,
231 u2* constantvalue_index_addr,
232 bool* is_synthetic_addr,
233 u2* generic_signature_index_addr,
234 FieldAnnotationCollector* parsed_annotations,
235 TRAPS);
236 Array<u2>* parse_fields(Symbol* class_name,
237 bool is_interface,
238 FieldAllocationCount *fac,
239 u2* java_fields_count_ptr, TRAPS);
240
241 void print_field_layout(Symbol* name,
242 Array<u2>* fields,
243 constantPoolHandle cp,
244 int instance_size,
245 int instance_fields_start,
246 int instance_fields_end,
247 int static_fields_end);
248
249 // Method parsing
250 methodHandle parse_method(bool is_interface,
251 AccessFlags* promoted_flags,
252 TRAPS);
253 Array<Method*>* parse_methods(bool is_interface,
254 AccessFlags* promoted_flags,
255 bool* has_final_method,
256 bool* declares_default_methods,
257 TRAPS);
258 intArray* sort_methods(Array<Method*>* methods);
259
260 u2* parse_exception_table(u4 code_length, u4 exception_table_length,
261 TRAPS);
262 void parse_linenumber_table(
263 u4 code_attribute_length, u4 code_length,
264 CompressedLineNumberWriteStream** write_stream, TRAPS);
265 u2* parse_localvariable_table(u4 code_length, u2 max_locals, u4 code_attribute_length,
266 u2* localvariable_table_length,
267 bool isLVTT, TRAPS);
268 u2* parse_checked_exceptions(u2* checked_exceptions_length, u4 method_attribute_length,
269 TRAPS);
270 void parse_type_array(u2 array_length, u4 code_length, u4* u1_index, u4* u2_index,
271 u1* u1_array, u2* u2_array, TRAPS);
272 u1* parse_stackmap_table(u4 code_attribute_length, TRAPS);
273
274 // Classfile attribute parsing
275 u2 parse_generic_signature_attribute(TRAPS);
276 void parse_classfile_sourcefile_attribute(TRAPS);
277 void parse_classfile_source_debug_extension_attribute(int length, TRAPS);
278 u2 parse_classfile_inner_classes_attribute(u1* inner_classes_attribute_start,
279 bool parsed_enclosingmethod_attribute,
280 u2 enclosing_method_class_index,
281 u2 enclosing_method_method_index,
282 TRAPS);
283 void parse_classfile_attributes(ClassAnnotationCollector* parsed_annotations,
284 TRAPS);
285 void parse_classfile_synthetic_attribute(TRAPS);
286 void parse_classfile_signature_attribute(TRAPS);
287 void parse_classfile_bootstrap_methods_attribute(u4 attribute_length, TRAPS);
288
289 // Annotations handling
290 AnnotationArray* assemble_annotations(u1* runtime_visible_annotations,
291 int runtime_visible_annotations_length,
292 u1* runtime_invisible_annotations,
293 int runtime_invisible_annotations_length, TRAPS);
294 int skip_annotation(u1* buffer, int limit, int index);
295 int skip_annotation_value(u1* buffer, int limit, int index);
296 void parse_annotations(u1* buffer, int limit,
297 /* Results (currently, only one result is supported): */
298 AnnotationCollector* result,
299 TRAPS);
300
301 // Final setup
302 unsigned int compute_oop_map_count(instanceKlassHandle super,
303 unsigned int nonstatic_oop_count,
304 int first_nonstatic_oop_offset);
305 void fill_oop_maps(instanceKlassHandle k,
306 unsigned int nonstatic_oop_map_count,
307 int* nonstatic_oop_offsets,
308 unsigned int* nonstatic_oop_counts);
309 void set_precomputed_flags(instanceKlassHandle k);
310 Array<Klass*>* compute_transitive_interfaces(instanceKlassHandle super,
311 Array<Klass*>* local_ifs, TRAPS);
312
313 // Format checker methods
314 void classfile_parse_error(const char* msg, TRAPS);
315 void classfile_parse_error(const char* msg, int index, TRAPS);
316 void classfile_parse_error(const char* msg, const char *name, TRAPS);
317 void classfile_parse_error(const char* msg, int index, const char *name, TRAPS);
318 inline void guarantee_property(bool b, const char* msg, TRAPS) {
319 if (!b) { classfile_parse_error(msg, CHECK); }
320 }
321
322 void report_assert_property_failure(const char* msg, TRAPS);
323 void report_assert_property_failure(const char* msg, int index, TRAPS);
324
325 inline void assert_property(bool b, const char* msg, TRAPS) {
326 #ifdef ASSERT
327 if (!b) {
328 report_assert_property_failure(msg, THREAD);
329 }
330 #endif
331 }
332
333 inline void assert_property(bool b, const char* msg, int index, TRAPS) {
334 #ifdef ASSERT
335 if (!b) {
336 report_assert_property_failure(msg, index, THREAD);
337 }
338 #endif
339 }
340
341 inline void check_property(bool property, const char* msg, int index, TRAPS) {
342 if (_need_verify) {
343 guarantee_property(property, msg, index, CHECK);
344 } else {
345 assert_property(property, msg, index, CHECK);
346 }
347 }
348
349 inline void check_property(bool property, const char* msg, TRAPS) {
350 if (_need_verify) {
351 guarantee_property(property, msg, CHECK);
352 } else {
353 assert_property(property, msg, CHECK);
354 }
355 }
356
357 inline void guarantee_property(bool b, const char* msg, int index, TRAPS) {
358 if (!b) { classfile_parse_error(msg, index, CHECK); }
359 }
360 inline void guarantee_property(bool b, const char* msg, const char *name, TRAPS) {
361 if (!b) { classfile_parse_error(msg, name, CHECK); }
362 }
363 inline void guarantee_property(bool b, const char* msg, int index, const char *name, TRAPS) {
364 if (!b) { classfile_parse_error(msg, index, name, CHECK); }
365 }
366
367 void throwIllegalSignature(
368 const char* type, Symbol* name, Symbol* sig, TRAPS);
369
370 bool is_supported_version(u2 major, u2 minor);
371 bool has_illegal_visibility(jint flags);
372
373 void verify_constantvalue(int constantvalue_index, int signature_index, TRAPS);
374 void verify_legal_utf8(const unsigned char* buffer, int length, TRAPS);
375 void verify_legal_class_name(Symbol* name, TRAPS);
376 void verify_legal_field_name(Symbol* name, TRAPS);
377 void verify_legal_method_name(Symbol* name, TRAPS);
378 void verify_legal_field_signature(Symbol* fieldname, Symbol* signature, TRAPS);
379 int verify_legal_method_signature(Symbol* methodname, Symbol* signature, TRAPS);
380 void verify_legal_class_modifiers(jint flags, TRAPS);
381 void verify_legal_field_modifiers(jint flags, bool is_interface, TRAPS);
382 void verify_legal_method_modifiers(jint flags, bool is_interface, Symbol* name, TRAPS);
383 bool verify_unqualified_name(char* name, unsigned int length, int type);
384 char* skip_over_field_name(char* name, bool slash_ok, unsigned int length);
385 char* skip_over_field_signature(char* signature, bool void_ok, unsigned int length, TRAPS);
386
387 bool is_anonymous() {
388 return _host_klass.not_null();
389 }
390 bool has_cp_patch_at(int index) {
391 assert(index >= 0, "oob");
392 return (_cp_patches != NULL
393 && index < _cp_patches->length()
394 && _cp_patches->adr_at(index)->not_null());
395 }
396 Handle cp_patch_at(int index) {
397 assert(has_cp_patch_at(index), "oob");
398 return _cp_patches->at(index);
399 }
400 Handle clear_cp_patch_at(int index) {
401 Handle patch = cp_patch_at(index);
402 _cp_patches->at_put(index, Handle());
403 assert(!has_cp_patch_at(index), "");
404 return patch;
405 }
406 void patch_constant_pool(constantPoolHandle cp, int index, Handle patch, TRAPS);
407
408 // Wrapper for constantTag.is_klass_[or_]reference.
409 // In older versions of the VM, Klass*s cannot sneak into early phases of
410 // constant pool construction, but in later versions they can.
411 // %%% Let's phase out the old is_klass_reference.
412 bool valid_klass_reference_at(int index) {
413 return _cp->is_within_bounds(index) && _cp->tag_at(index).is_klass_or_reference();
414 }
415
416 // Checks that the cpool index is in range and is a utf8
417 bool valid_symbol_at(int cpool_index) {
418 return (_cp->is_within_bounds(cpool_index) &&
419 _cp->tag_at(cpool_index).is_utf8());
420 }
421
422 void copy_localvariable_table(ConstMethod* cm, int lvt_cnt,
423 u2* localvariable_table_length,
424 u2** localvariable_table_start,
425 int lvtt_cnt,
426 u2* localvariable_type_table_length,
427 u2** localvariable_type_table_start,
428 TRAPS);
429
430 void copy_method_annotations(ConstMethod* cm,
431 u1* runtime_visible_annotations,
432 int runtime_visible_annotations_length,
433 u1* runtime_invisible_annotations,
434 int runtime_invisible_annotations_length,
435 u1* runtime_visible_parameter_annotations,
436 int runtime_visible_parameter_annotations_length,
437 u1* runtime_invisible_parameter_annotations,
438 int runtime_invisible_parameter_annotations_length,
439 u1* runtime_visible_type_annotations,
440 int runtime_visible_type_annotations_length,
441 u1* runtime_invisible_type_annotations,
442 int runtime_invisible_type_annotations_length,
443 u1* annotation_default,
444 int annotation_default_length,
445 TRAPS);
446
447 // lays out fields in class and returns the total oopmap count
448 void layout_fields(Handle class_loader, FieldAllocationCount* fac,
449 ClassAnnotationCollector* parsed_annotations,
450 FieldLayoutInfo* info, TRAPS);
451
452 public:
453 // Constructor
454 ClassFileParser(ClassFileStream* st) { set_stream(st); }
455 ~ClassFileParser();
456
457 // Parse .class file and return new Klass*. The Klass* is not hooked up
458 // to the system dictionary or any other structures, so a .class file can
459 // be loaded several times if desired.
460 // The system dictionary hookup is done by the caller.
461 //
462 // "parsed_name" is updated by this method, and is the name found
463 // while parsing the stream.
464 instanceKlassHandle parseClassFile(Symbol* name,
465 ClassLoaderData* loader_data,
466 Handle protection_domain,
467 TempNewSymbol& parsed_name,
468 bool verify,
469 TRAPS) {
470 KlassHandle no_host_klass;
471 return parseClassFile(name, loader_data, protection_domain, no_host_klass, NULL, parsed_name, verify, THREAD);
472 }
473 instanceKlassHandle parseClassFile(Symbol* name,
474 ClassLoaderData* loader_data,
475 Handle protection_domain,
476 KlassHandle host_klass,
477 GrowableArray<Handle>* cp_patches,
478 TempNewSymbol& parsed_name,
479 bool verify,
480 TRAPS);
481
482 // Verifier checks
483 static void check_super_class_access(instanceKlassHandle this_klass, TRAPS);
484 static void check_super_interface_access(instanceKlassHandle this_klass, TRAPS);
485 static void check_final_method_override(instanceKlassHandle this_klass, TRAPS);
486 static void check_illegal_static_method(instanceKlassHandle this_klass, TRAPS);
487 };
488
489 #endif // SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP