1 /*
2 * Copyright (c) 1998, 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_VERIFIER_HPP
26 #define SHARE_VM_CLASSFILE_VERIFIER_HPP
27
28 #include "classfile/verificationType.hpp"
29 #include "memory/gcLocker.hpp"
30 #include "oops/klass.hpp"
31 #include "oops/methodOop.hpp"
32 #include "runtime/handles.hpp"
33 #include "utilities/exceptions.hpp"
34
35 // The verifier class
36 class Verifier : AllStatic {
37 public:
38 enum {
39 STACKMAP_ATTRIBUTE_MAJOR_VERSION = 50,
40 INVOKEDYNAMIC_MAJOR_VERSION = 51
41 };
42 typedef enum { ThrowException, NoException } Mode;
43
44 /**
45 * Verify the bytecodes for a class. If 'throw_exception' is true
46 * then the appropriate VerifyError or ClassFormatError will be thrown.
47 * Otherwise, no exception is thrown and the return indicates the
48 * error.
49 */
50 static bool verify(instanceKlassHandle klass, Mode mode, bool should_verify_class, TRAPS);
51
52 // Return false if the class is loaded by the bootstrap loader,
53 // or if defineClass was called requesting skipping verification
54 // -Xverify:all/none override this value
55 static bool should_verify_for(oop class_loader, bool should_verify_class);
56
57 // Relax certain verifier checks to enable some broken 1.1 apps to run on 1.2.
58 static bool relax_verify_for(oop class_loader);
59
60 private:
61 static bool is_eligible_for_verification(instanceKlassHandle klass, bool should_verify_class);
62 static symbolHandle inference_verify(
63 instanceKlassHandle klass, char* msg, size_t msg_len, TRAPS);
64 };
65
66 class RawBytecodeStream;
67 class StackMapFrame;
68 class StackMapTable;
69
70 // Summary of verifier's memory usage:
71 // StackMapTable is stack allocated.
72 // StackMapFrame are resource allocated. There is one ResourceMark
73 // for each method.
74 // There is one mutable StackMapFrame (current_frame) which is updated
75 // by abstract bytecode interpretation. frame_in_exception_handler() returns
76 // a frame that has a mutable one-item stack (ready for pushing the
77 // catch type exception object). All the other StackMapFrame's
78 // are immutable (including their locals and stack arrays) after
79 // their constructions.
80 // locals/stack arrays in StackMapFrame are resource allocated.
81 // locals/stack arrays can be shared between StackMapFrame's, except
82 // the mutable StackMapFrame (current_frame).
83 // Care needs to be taken to make sure resource objects don't outlive
84 // the lifetime of their ResourceMark.
85
86 // These macros are used similarly to CHECK macros but also check
87 // the status of the verifier and return if that has an error.
88 #define CHECK_VERIFY(verifier) \
89 CHECK); if ((verifier)->has_error()) return; (0
90 #define CHECK_VERIFY_(verifier, result) \
91 CHECK_(result)); if ((verifier)->has_error()) return (result); (0
92
93 // A new instance of this class is created for each class being verified
94 class ClassVerifier : public StackObj {
95 private:
96 Thread* _thread;
97 symbolHandle _exception_type;
98 char* _message;
99 size_t _message_buffer_len;
100
101 void verify_method(methodHandle method, TRAPS);
102 char* generate_code_data(methodHandle m, u4 code_length, TRAPS);
103 void verify_exception_handler_table(u4 code_length, char* code_data, int& min, int& max, TRAPS);
104 void verify_local_variable_table(u4 code_length, char* code_data, TRAPS);
105
106 VerificationType cp_ref_index_to_type(
107 int index, constantPoolHandle cp, TRAPS) {
108 return cp_index_to_type(cp->klass_ref_index_at(index), cp, THREAD);
109 }
110
111 bool is_protected_access(
112 instanceKlassHandle this_class, klassOop target_class,
113 symbolOop field_name, symbolOop field_sig, bool is_method);
114
115 void verify_cp_index(constantPoolHandle cp, int index, TRAPS);
116 void verify_cp_type(
117 int index, constantPoolHandle cp, unsigned int types, TRAPS);
118 void verify_cp_class_type(int index, constantPoolHandle cp, TRAPS);
119
120 u2 verify_stackmap_table(
121 u2 stackmap_index, u2 bci, StackMapFrame* current_frame,
122 StackMapTable* stackmap_table, bool no_control_flow, TRAPS);
123
124 void verify_exception_handler_targets(
125 u2 bci, bool this_uninit, StackMapFrame* current_frame,
126 StackMapTable* stackmap_table, TRAPS);
127
128 void verify_ldc(
129 int opcode, u2 index, StackMapFrame *current_frame,
130 constantPoolHandle cp, u2 bci, TRAPS);
131
132 void verify_switch(
133 RawBytecodeStream* bcs, u4 code_length, char* code_data,
134 StackMapFrame* current_frame, StackMapTable* stackmap_table, TRAPS);
135
136 void verify_field_instructions(
137 RawBytecodeStream* bcs, StackMapFrame* current_frame,
138 constantPoolHandle cp, TRAPS);
139
140 void verify_invoke_init(
141 RawBytecodeStream* bcs, VerificationType ref_class_type,
142 StackMapFrame* current_frame, u4 code_length, bool* this_uninit,
143 constantPoolHandle cp, TRAPS);
144
145 void verify_invoke_instructions(
146 RawBytecodeStream* bcs, u4 code_length, StackMapFrame* current_frame,
147 bool* this_uninit, VerificationType return_type,
148 constantPoolHandle cp, TRAPS);
149
150 VerificationType get_newarray_type(u2 index, u2 bci, TRAPS);
151 void verify_anewarray(
152 u2 index, constantPoolHandle cp, StackMapFrame* current_frame, TRAPS);
153 void verify_return_value(
154 VerificationType return_type, VerificationType type, u2 offset, TRAPS);
155
156 void verify_iload (u2 index, StackMapFrame* current_frame, TRAPS);
157 void verify_lload (u2 index, StackMapFrame* current_frame, TRAPS);
158 void verify_fload (u2 index, StackMapFrame* current_frame, TRAPS);
159 void verify_dload (u2 index, StackMapFrame* current_frame, TRAPS);
160 void verify_aload (u2 index, StackMapFrame* current_frame, TRAPS);
161 void verify_istore(u2 index, StackMapFrame* current_frame, TRAPS);
162 void verify_lstore(u2 index, StackMapFrame* current_frame, TRAPS);
163 void verify_fstore(u2 index, StackMapFrame* current_frame, TRAPS);
164 void verify_dstore(u2 index, StackMapFrame* current_frame, TRAPS);
165 void verify_astore(u2 index, StackMapFrame* current_frame, TRAPS);
166 void verify_iinc (u2 index, StackMapFrame* current_frame, TRAPS);
167
168 bool name_in_supers(symbolOop ref_name, instanceKlassHandle current);
169
170 VerificationType object_type() const;
171
172 instanceKlassHandle _klass; // the class being verified
173 methodHandle _method; // current method being verified
174 VerificationType _this_type; // the verification type of the current class
175
176 // Some recursive calls from the verifier to the name resolver
177 // can cause the current class to be re-verified and rewritten.
178 // If this happens, the original verification should not continue,
179 // because constant pool indexes will have changed.
180 // The rewriter is preceded by the verifier. If the verifier throws
181 // an error, rewriting is prevented. Also, rewriting always precedes
182 // bytecode execution or compilation. Thus, is_rewritten implies
183 // that a class has been verified and prepared for execution.
184 bool was_recursively_verified() { return _klass->is_rewritten(); }
185
186 public:
187 enum {
188 BYTECODE_OFFSET = 1,
189 NEW_OFFSET = 2
190 };
191
192 // constructor
193 ClassVerifier(instanceKlassHandle klass, char* msg, size_t msg_len, TRAPS);
194
195 // destructor
196 ~ClassVerifier();
197
198 Thread* thread() { return _thread; }
199 methodHandle method() { return _method; }
200 instanceKlassHandle current_class() const { return _klass; }
201 VerificationType current_type() const { return _this_type; }
202
203 // Verifies the class. If a verify or class file format error occurs,
204 // the '_exception_name' symbols will set to the exception name and
205 // the message_buffer will be filled in with the exception message.
206 void verify_class(TRAPS);
207
208 // Return status modes
209 symbolHandle result() const { return _exception_type; }
210 bool has_error() const { return !(result().is_null()); }
211
212 // Called when verify or class format errors are encountered.
213 // May throw an exception based upon the mode.
214 void verify_error(u2 offset, const char* fmt, ...);
215 void verify_error(const char* fmt, ...);
216 void class_format_error(const char* fmt, ...);
217 void format_error_message(const char* fmt, int offset, va_list args);
218
219 klassOop load_class(symbolHandle name, TRAPS);
220
221 int change_sig_to_verificationType(
222 SignatureStream* sig_type, VerificationType* inference_type, TRAPS);
223
224 VerificationType cp_index_to_type(int index, constantPoolHandle cp, TRAPS) {
225 return VerificationType::reference_type(
226 symbolHandle(THREAD, cp->klass_name_at(index)));
227 }
228
229 static bool _verify_verbose; // for debugging
230 };
231
232 inline int ClassVerifier::change_sig_to_verificationType(
233 SignatureStream* sig_type, VerificationType* inference_type, TRAPS) {
234 BasicType bt = sig_type->type();
235 switch (bt) {
236 case T_OBJECT:
237 case T_ARRAY:
238 {
239 symbolOop name = sig_type->as_symbol(CHECK_0);
240 *inference_type =
241 VerificationType::reference_type(symbolHandle(THREAD, name));
242 return 1;
243 }
244 case T_LONG:
245 *inference_type = VerificationType::long_type();
246 *++inference_type = VerificationType::long2_type();
247 return 2;
248 case T_DOUBLE:
249 *inference_type = VerificationType::double_type();
250 *++inference_type = VerificationType::double2_type();
251 return 2;
252 case T_INT:
253 case T_BOOLEAN:
254 case T_BYTE:
255 case T_CHAR:
256 case T_SHORT:
257 *inference_type = VerificationType::integer_type();
258 return 1;
259 case T_FLOAT:
260 *inference_type = VerificationType::float_type();
261 return 1;
262 default:
263 ShouldNotReachHere();
264 return 1;
265 }
266 }
267
268 #endif // SHARE_VM_CLASSFILE_VERIFIER_HPP