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