1 /*
2 * Copyright (c) 1997, 2010, 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
35 class TempNewSymbol;
36 // Parser for for .class files
37 //
38 // The bytes describing the class file structure is read from a Stream object
39
40 class ClassFileParser VALUE_OBJ_CLASS_SPEC {
41 private:
42 bool _need_verify;
43 bool _relax_verify;
44 u2 _major_version;
45 u2 _minor_version;
46 Symbol* _class_name;
47 KlassHandle _host_klass;
48 GrowableArray<Handle>* _cp_patches; // overrides for CP entries
49
50 bool _has_finalizer;
51 bool _has_empty_finalizer;
52 bool _has_vanilla_constructor;
53
54 int _max_bootstrap_specifier_index;
55
56 enum { fixed_buffer_size = 128 };
57 u_char linenumbertable_buffer[fixed_buffer_size];
58
59 ClassFileStream* _stream; // Actual input stream
60
61 enum { LegalClass, LegalField, LegalMethod }; // used to verify unqualified names
62
63 // Accessors
64 ClassFileStream* stream() { return _stream; }
65 void set_stream(ClassFileStream* st) { _stream = st; }
66
67 // Constant pool parsing
68 void parse_constant_pool_entries(constantPoolHandle cp, int length, TRAPS);
69
70 constantPoolHandle parse_constant_pool(TRAPS);
71
72 // Interface parsing
73 objArrayHandle parse_interfaces(constantPoolHandle cp,
74 int length,
75 Handle class_loader,
76 Handle protection_domain,
77 Symbol* class_name,
78 TRAPS);
79
80 // Field parsing
81 void parse_field_attributes(constantPoolHandle cp, u2 attributes_count,
82 bool is_static, u2 signature_index,
83 u2* constantvalue_index_addr,
84 bool* is_synthetic_addr,
85 u2* generic_signature_index_addr,
86 typeArrayHandle* field_annotations, TRAPS);
87 typeArrayHandle parse_fields(constantPoolHandle cp, bool is_interface,
88 struct FieldAllocationCount *fac,
89 objArrayHandle* fields_annotations, TRAPS);
90
91 // Method parsing
92 methodHandle parse_method(constantPoolHandle cp, bool is_interface,
93 AccessFlags* promoted_flags,
94 typeArrayHandle* method_annotations,
95 typeArrayHandle* method_parameter_annotations,
96 typeArrayHandle* method_default_annotations,
97 TRAPS);
98 objArrayHandle parse_methods (constantPoolHandle cp, bool is_interface,
99 AccessFlags* promoted_flags,
100 bool* has_final_method,
101 objArrayOop* methods_annotations_oop,
102 objArrayOop* methods_parameter_annotations_oop,
103 objArrayOop* methods_default_annotations_oop,
104 TRAPS);
105 typeArrayHandle sort_methods (objArrayHandle methods,
106 objArrayHandle methods_annotations,
107 objArrayHandle methods_parameter_annotations,
108 objArrayHandle methods_default_annotations,
109 TRAPS);
110 typeArrayHandle parse_exception_table(u4 code_length, u4 exception_table_length,
111 constantPoolHandle cp, TRAPS);
112 void parse_linenumber_table(
113 u4 code_attribute_length, u4 code_length,
114 CompressedLineNumberWriteStream** write_stream, TRAPS);
115 u2* parse_localvariable_table(u4 code_length, u2 max_locals, u4 code_attribute_length,
116 constantPoolHandle cp, u2* localvariable_table_length,
117 bool isLVTT, TRAPS);
118 u2* parse_checked_exceptions(u2* checked_exceptions_length, u4 method_attribute_length,
119 constantPoolHandle cp, TRAPS);
120 void parse_type_array(u2 array_length, u4 code_length, u4* u1_index, u4* u2_index,
121 u1* u1_array, u2* u2_array, constantPoolHandle cp, TRAPS);
122 typeArrayOop parse_stackmap_table(u4 code_attribute_length, TRAPS);
123
124 // Classfile attribute parsing
125 void parse_classfile_sourcefile_attribute(constantPoolHandle cp, instanceKlassHandle k, TRAPS);
126 void parse_classfile_source_debug_extension_attribute(constantPoolHandle cp,
127 instanceKlassHandle k, int length, TRAPS);
128 u2 parse_classfile_inner_classes_attribute(constantPoolHandle cp,
129 instanceKlassHandle k, TRAPS);
130 void parse_classfile_attributes(constantPoolHandle cp, instanceKlassHandle k, TRAPS);
131 void parse_classfile_synthetic_attribute(constantPoolHandle cp, instanceKlassHandle k, TRAPS);
132 void parse_classfile_signature_attribute(constantPoolHandle cp, instanceKlassHandle k, TRAPS);
133 void parse_classfile_bootstrap_methods_attribute(constantPoolHandle cp, instanceKlassHandle k, u4 attribute_length, TRAPS);
134
135 // Annotations handling
136 typeArrayHandle assemble_annotations(u1* runtime_visible_annotations,
137 int runtime_visible_annotations_length,
138 u1* runtime_invisible_annotations,
139 int runtime_invisible_annotations_length, TRAPS);
140
141 // Final setup
142 unsigned int compute_oop_map_count(instanceKlassHandle super,
143 unsigned int nonstatic_oop_count,
144 int first_nonstatic_oop_offset);
145 void fill_oop_maps(instanceKlassHandle k,
146 unsigned int nonstatic_oop_map_count,
147 int* nonstatic_oop_offsets,
148 unsigned int* nonstatic_oop_counts);
149 void set_precomputed_flags(instanceKlassHandle k);
150 objArrayHandle compute_transitive_interfaces(instanceKlassHandle super,
151 objArrayHandle local_ifs, TRAPS);
152
153 // Special handling for certain classes.
154 // Add the "discovered" field to java.lang.ref.Reference if
155 // it does not exist.
156 void java_lang_ref_Reference_fix_pre(typeArrayHandle* fields_ptr,
157 constantPoolHandle cp, FieldAllocationCount *fac_ptr, TRAPS);
158 // Adjust the field allocation counts for java.lang.Class to add
159 // fake fields.
160 void java_lang_Class_fix_pre(objArrayHandle* methods_ptr,
161 FieldAllocationCount *fac_ptr, TRAPS);
162 // Adjust the next_nonstatic_oop_offset to place the fake fields
163 // before any Java fields.
164 void java_lang_Class_fix_post(int* next_nonstatic_oop_offset);
165 // Adjust the field allocation counts for java.dyn.MethodHandle to add
166 // a fake address (void*) field.
167 void java_dyn_MethodHandle_fix_pre(constantPoolHandle cp,
168 typeArrayHandle fields,
169 FieldAllocationCount *fac_ptr, TRAPS);
170
171 // Format checker methods
172 void classfile_parse_error(const char* msg, TRAPS);
173 void classfile_parse_error(const char* msg, int index, TRAPS);
174 void classfile_parse_error(const char* msg, const char *name, TRAPS);
175 void classfile_parse_error(const char* msg, int index, const char *name, TRAPS);
176 inline void guarantee_property(bool b, const char* msg, TRAPS) {
177 if (!b) { classfile_parse_error(msg, CHECK); }
178 }
179
180 inline void assert_property(bool b, const char* msg, TRAPS) {
181 #ifdef ASSERT
182 if (!b) { fatal(msg); }
183 #endif
184 }
185
186 inline void check_property(bool property, const char* msg, int index, TRAPS) {
187 if (_need_verify) {
188 guarantee_property(property, msg, index, CHECK);
189 } else {
190 assert_property(property, msg, CHECK);
191 }
192 }
193
194 inline void check_property(bool property, const char* msg, TRAPS) {
195 if (_need_verify) {
196 guarantee_property(property, msg, CHECK);
197 } else {
198 assert_property(property, msg, CHECK);
199 }
200 }
201
202 inline void guarantee_property(bool b, const char* msg, int index, TRAPS) {
203 if (!b) { classfile_parse_error(msg, index, CHECK); }
204 }
205 inline void guarantee_property(bool b, const char* msg, const char *name, TRAPS) {
206 if (!b) { classfile_parse_error(msg, name, CHECK); }
207 }
208 inline void guarantee_property(bool b, const char* msg, int index, const char *name, TRAPS) {
209 if (!b) { classfile_parse_error(msg, index, name, CHECK); }
210 }
211
212 void throwIllegalSignature(
213 const char* type, Symbol* name, Symbol* sig, TRAPS);
214
215 bool is_supported_version(u2 major, u2 minor);
216 bool has_illegal_visibility(jint flags);
217
218 void verify_constantvalue(int constantvalue_index, int signature_index, constantPoolHandle cp, TRAPS);
219 void verify_legal_utf8(const unsigned char* buffer, int length, TRAPS);
220 void verify_legal_class_name(Symbol* name, TRAPS);
221 void verify_legal_field_name(Symbol* name, TRAPS);
222 void verify_legal_method_name(Symbol* name, TRAPS);
223 void verify_legal_field_signature(Symbol* fieldname, Symbol* signature, TRAPS);
224 int verify_legal_method_signature(Symbol* methodname, Symbol* signature, TRAPS);
225 void verify_legal_class_modifiers(jint flags, TRAPS);
226 void verify_legal_field_modifiers(jint flags, bool is_interface, TRAPS);
227 void verify_legal_method_modifiers(jint flags, bool is_interface, Symbol* name, TRAPS);
228 bool verify_unqualified_name(char* name, unsigned int length, int type);
229 char* skip_over_field_name(char* name, bool slash_ok, unsigned int length);
230 char* skip_over_field_signature(char* signature, bool void_ok, unsigned int length, TRAPS);
231
232 bool is_anonymous() {
233 assert(AnonymousClasses || _host_klass.is_null(), "");
234 return _host_klass.not_null();
235 }
236 bool has_cp_patch_at(int index) {
237 assert(AnonymousClasses, "");
238 assert(index >= 0, "oob");
239 return (_cp_patches != NULL
240 && index < _cp_patches->length()
241 && _cp_patches->adr_at(index)->not_null());
242 }
243 Handle cp_patch_at(int index) {
244 assert(has_cp_patch_at(index), "oob");
245 return _cp_patches->at(index);
246 }
247 Handle clear_cp_patch_at(int index) {
248 Handle patch = cp_patch_at(index);
249 _cp_patches->at_put(index, Handle());
250 assert(!has_cp_patch_at(index), "");
251 return patch;
252 }
253 void patch_constant_pool(constantPoolHandle cp, int index, Handle patch, TRAPS);
254
255 // Wrapper for constantTag.is_klass_[or_]reference.
256 // In older versions of the VM, klassOops cannot sneak into early phases of
257 // constant pool construction, but in later versions they can.
258 // %%% Let's phase out the old is_klass_reference.
259 bool is_klass_reference(constantPoolHandle cp, int index) {
260 return ((LinkWellKnownClasses || AnonymousClasses)
261 ? cp->tag_at(index).is_klass_or_reference()
262 : cp->tag_at(index).is_klass_reference());
263 }
264
265 public:
266 // Constructor
267 ClassFileParser(ClassFileStream* st) { set_stream(st); }
268
269 // Parse .class file and return new klassOop. The klassOop is not hooked up
270 // to the system dictionary or any other structures, so a .class file can
271 // be loaded several times if desired.
272 // The system dictionary hookup is done by the caller.
273 //
274 // "parsed_name" is updated by this method, and is the name found
275 // while parsing the stream.
276 instanceKlassHandle parseClassFile(Symbol* name,
277 Handle class_loader,
278 Handle protection_domain,
279 TempNewSymbol& parsed_name,
280 bool verify,
281 TRAPS) {
282 KlassHandle no_host_klass;
283 return parseClassFile(name, class_loader, protection_domain, no_host_klass, NULL, parsed_name, verify, THREAD);
284 }
285 instanceKlassHandle parseClassFile(Symbol* name,
286 Handle class_loader,
287 Handle protection_domain,
288 KlassHandle host_klass,
289 GrowableArray<Handle>* cp_patches,
290 TempNewSymbol& parsed_name,
291 bool verify,
292 TRAPS);
293
294 // Verifier checks
295 static void check_super_class_access(instanceKlassHandle this_klass, TRAPS);
296 static void check_super_interface_access(instanceKlassHandle this_klass, TRAPS);
297 static void check_final_method_override(instanceKlassHandle this_klass, TRAPS);
298 static void check_illegal_static_method(instanceKlassHandle this_klass, TRAPS);
299 };
300
301 #endif // SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP