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