1 /*
2 * Copyright 1997-2007 Sun Microsystems, Inc. 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
20 * CA 95054 USA or visit www.sun.com if you need additional information or
21 * have any questions.
22 *
23 */
24
25 // Parser for for .class files
26 //
27 // The bytes describing the class file structure is read from a Stream object
28
29 class ClassFileParser VALUE_OBJ_CLASS_SPEC {
30 private:
31 bool _need_verify;
32 bool _relax_verify;
33 u2 _major_version;
34 u2 _minor_version;
35 symbolHandle _class_name;
36
37 bool _has_finalizer;
38 bool _has_empty_finalizer;
39 bool _has_vanilla_constructor;
40
41 enum { fixed_buffer_size = 128 };
42 u_char linenumbertable_buffer[fixed_buffer_size];
43
44 ClassFileStream* _stream; // Actual input stream
45
46 enum { LegalClass, LegalField, LegalMethod }; // used to verify unqualified names
47
48 // Accessors
49 ClassFileStream* stream() { return _stream; }
50 void set_stream(ClassFileStream* st) { _stream = st; }
51
52 // Constant pool parsing
53 void parse_constant_pool_entries(constantPoolHandle cp, int length, TRAPS);
54
55 constantPoolHandle parse_constant_pool(TRAPS);
56
57 // Interface parsing
58 objArrayHandle parse_interfaces(constantPoolHandle cp,
59 int length,
60 Handle class_loader,
61 Handle protection_domain,
62 PerfTraceTime* vmtimer,
63 symbolHandle class_name,
64 TRAPS);
65
66 // Field parsing
67 void parse_field_attributes(constantPoolHandle cp, u2 attributes_count,
68 bool is_static, u2 signature_index,
69 u2* constantvalue_index_addr,
70 bool* is_synthetic_addr,
71 u2* generic_signature_index_addr,
72 typeArrayHandle* field_annotations, TRAPS);
73 typeArrayHandle parse_fields(constantPoolHandle cp, bool is_interface,
74 struct FieldAllocationCount *fac,
75 objArrayHandle* fields_annotations, TRAPS);
76
77 // Method parsing
78 methodHandle parse_method(constantPoolHandle cp, bool is_interface,
79 AccessFlags* promoted_flags,
80 typeArrayHandle* method_annotations,
81 typeArrayHandle* method_parameter_annotations,
82 typeArrayHandle* method_default_annotations,
83 TRAPS);
84 objArrayHandle parse_methods (constantPoolHandle cp, bool is_interface,
85 AccessFlags* promoted_flags,
86 bool* has_final_method,
87 objArrayOop* methods_annotations_oop,
88 objArrayOop* methods_parameter_annotations_oop,
89 objArrayOop* methods_default_annotations_oop,
90 TRAPS);
91 typeArrayHandle sort_methods (objArrayHandle methods,
92 objArrayHandle methods_annotations,
93 objArrayHandle methods_parameter_annotations,
94 objArrayHandle methods_default_annotations,
95 TRAPS);
96 typeArrayHandle parse_exception_table(u4 code_length, u4 exception_table_length,
97 constantPoolHandle cp, TRAPS);
98 void parse_linenumber_table(
99 u4 code_attribute_length, u4 code_length,
100 CompressedLineNumberWriteStream** write_stream, TRAPS);
101 u2* parse_localvariable_table(u4 code_length, u2 max_locals, u4 code_attribute_length,
102 constantPoolHandle cp, u2* localvariable_table_length,
103 bool isLVTT, TRAPS);
104 u2* parse_checked_exceptions(u2* checked_exceptions_length, u4 method_attribute_length,
105 constantPoolHandle cp, TRAPS);
106 void parse_type_array(u2 array_length, u4 code_length, u4* u1_index, u4* u2_index,
107 u1* u1_array, u2* u2_array, constantPoolHandle cp, TRAPS);
108 typeArrayOop parse_stackmap_table(u4 code_attribute_length, TRAPS);
109
110 // Classfile attribute parsing
111 void parse_classfile_sourcefile_attribute(constantPoolHandle cp, instanceKlassHandle k, TRAPS);
112 void parse_classfile_source_debug_extension_attribute(constantPoolHandle cp,
113 instanceKlassHandle k, int length, TRAPS);
114 u2 parse_classfile_inner_classes_attribute(constantPoolHandle cp,
115 instanceKlassHandle k, TRAPS);
116 void parse_classfile_attributes(constantPoolHandle cp, instanceKlassHandle k, TRAPS);
117 void parse_classfile_synthetic_attribute(constantPoolHandle cp, instanceKlassHandle k, TRAPS);
118 void parse_classfile_signature_attribute(constantPoolHandle cp, instanceKlassHandle k, TRAPS);
119
120 // Annotations handling
121 typeArrayHandle assemble_annotations(u1* runtime_visible_annotations,
122 int runtime_visible_annotations_length,
123 u1* runtime_invisible_annotations,
124 int runtime_invisible_annotations_length, TRAPS);
125
126 // Final setup
127 int compute_oop_map_size(instanceKlassHandle super, int nonstatic_oop_count,
128 int first_nonstatic_oop_offset);
129 void fill_oop_maps(instanceKlassHandle k, int nonstatic_oop_map_count,
130 u2* nonstatic_oop_offsets, u2* nonstatic_oop_length);
131 void set_precomputed_flags(instanceKlassHandle k);
132 objArrayHandle compute_transitive_interfaces(instanceKlassHandle super,
133 objArrayHandle local_ifs, TRAPS);
134
135 // Special handling for certain classes.
136 // Add the "discovered" field to java.lang.ref.Reference if
137 // it does not exist.
138 void java_lang_ref_Reference_fix_pre(typeArrayHandle* fields_ptr,
139 constantPoolHandle cp, FieldAllocationCount *fac_ptr, TRAPS);
140 // Adjust the field allocation counts for java.lang.Class to add
141 // fake fields.
142 void java_lang_Class_fix_pre(objArrayHandle* methods_ptr,
143 FieldAllocationCount *fac_ptr, TRAPS);
144 // Adjust the next_nonstatic_oop_offset to place the fake fields
145 // before any Java fields.
146 void java_lang_Class_fix_post(int* next_nonstatic_oop_offset);
147
148 // Format checker methods
149 void classfile_parse_error(const char* msg, TRAPS);
150 void classfile_parse_error(const char* msg, int index, TRAPS);
151 void classfile_parse_error(const char* msg, const char *name, TRAPS);
152 void classfile_parse_error(const char* msg, int index, const char *name, TRAPS);
153 inline void guarantee_property(bool b, const char* msg, TRAPS) {
154 if (!b) { classfile_parse_error(msg, CHECK); }
155 }
156
157 inline void assert_property(bool b, const char* msg, TRAPS) {
158 #ifdef ASSERT
159 if (!b) { fatal(msg); }
160 #endif
161 }
162
163 inline void check_property(bool property, const char* msg, int index, TRAPS) {
164 if (_need_verify) {
165 guarantee_property(property, msg, index, CHECK);
166 } else {
167 assert_property(property, msg, CHECK);
168 }
169 }
170
171 inline void check_property(bool property, const char* msg, TRAPS) {
172 if (_need_verify) {
173 guarantee_property(property, msg, CHECK);
174 } else {
175 assert_property(property, msg, CHECK);
176 }
177 }
178
179 inline void guarantee_property(bool b, const char* msg, int index, TRAPS) {
180 if (!b) { classfile_parse_error(msg, index, CHECK); }
181 }
182 inline void guarantee_property(bool b, const char* msg, const char *name, TRAPS) {
183 if (!b) { classfile_parse_error(msg, name, CHECK); }
184 }
185 inline void guarantee_property(bool b, const char* msg, int index, const char *name, TRAPS) {
186 if (!b) { classfile_parse_error(msg, index, name, CHECK); }
187 }
188
189 bool is_supported_version(u2 major, u2 minor);
190 bool has_illegal_visibility(jint flags);
191
192 void verify_constantvalue(int constantvalue_index, int signature_index, constantPoolHandle cp, TRAPS);
193 void verify_legal_utf8(const unsigned char* buffer, int length, TRAPS);
194 void verify_legal_class_name(symbolHandle name, TRAPS);
195 void verify_legal_field_name(symbolHandle name, TRAPS);
196 void verify_legal_method_name(symbolHandle name, TRAPS);
197 void verify_legal_field_signature(symbolHandle fieldname, symbolHandle signature, TRAPS);
198 int verify_legal_method_signature(symbolHandle methodname, symbolHandle signature, TRAPS);
199 void verify_legal_class_modifiers(jint flags, TRAPS);
200 void verify_legal_field_modifiers(jint flags, bool is_interface, TRAPS);
201 void verify_legal_method_modifiers(jint flags, bool is_interface, symbolHandle name, TRAPS);
202 bool verify_unqualified_name(char* name, unsigned int length, int type);
203 char* skip_over_field_name(char* name, bool slash_ok, unsigned int length);
204 char* skip_over_field_signature(char* signature, bool void_ok, unsigned int length, TRAPS);
205
206 public:
207 // Constructor
208 ClassFileParser(ClassFileStream* st) { set_stream(st); }
209
210 // Parse .class file and return new klassOop. The klassOop is not hooked up
211 // to the system dictionary or any other structures, so a .class file can
212 // be loaded several times if desired.
213 // The system dictionary hookup is done by the caller.
214 //
215 // "parsed_name" is updated by this method, and is the name found
216 // while parsing the stream.
217 instanceKlassHandle parseClassFile(symbolHandle name,
218 Handle class_loader,
219 Handle protection_domain,
220 symbolHandle& parsed_name,
221 TRAPS);
222
223 // Verifier checks
224 static void check_super_class_access(instanceKlassHandle this_klass, TRAPS);
225 static void check_super_interface_access(instanceKlassHandle this_klass, TRAPS);
226 static void check_final_method_override(instanceKlassHandle this_klass, TRAPS);
227 static void check_illegal_static_method(instanceKlassHandle this_klass, TRAPS);
228 };