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