1 /* 2 * Copyright (c) 1998, 2019, 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_CLASSFILE_VERIFIER_HPP 26 #define SHARE_CLASSFILE_VERIFIER_HPP 27 28 #include "classfile/verificationType.hpp" 29 #include "oops/klass.hpp" 30 #include "oops/method.hpp" 31 #include "runtime/handles.hpp" 32 #include "utilities/exceptions.hpp" 33 #include "utilities/growableArray.hpp" 34 #include "utilities/resourceHash.hpp" 35 36 // The verifier class 37 class Verifier : AllStatic { 38 public: 39 enum { 40 STACKMAP_ATTRIBUTE_MAJOR_VERSION = 50, 41 INVOKEDYNAMIC_MAJOR_VERSION = 51, 42 NO_RELAX_ACCESS_CTRL_CHECK_VERSION = 52, 43 DYNAMICCONSTANT_MAJOR_VERSION = 55, 44 }; 45 46 // Verify the bytecodes for a class. 47 static bool verify(InstanceKlass* klass, bool should_verify_class, TRAPS); 48 49 static void log_end_verification(outputStream* st, const char* klassName, Symbol* exception_name, TRAPS); 50 51 // Return false if the class is loaded by the bootstrap loader, 52 // or if defineClass was called requesting skipping verification 53 // -Xverify:all overrides this value 54 static bool should_verify_for(oop class_loader, bool should_verify_class); 55 56 // Relax certain access checks to enable some broken 1.1 apps to run on 1.2. 57 static bool relax_access_for(oop class_loader); 58 59 // Print output for class+resolve 60 static void trace_class_resolution(Klass* resolve_class, InstanceKlass* verify_class); 61 62 private: 63 static bool is_eligible_for_verification(InstanceKlass* klass, bool should_verify_class); 64 static Symbol* inference_verify( 65 InstanceKlass* klass, char* msg, size_t msg_len, TRAPS); 66 }; 67 68 class RawBytecodeStream; 69 class StackMapFrame; 70 class StackMapTable; 71 72 // Summary of verifier's memory usage: 73 // StackMapTable is stack allocated. 74 // StackMapFrame are resource allocated. There is only one ResourceMark 75 // for each class verification, which is created at the top level. 76 // There is one mutable StackMapFrame (current_frame) which is updated 77 // by abstract bytecode interpretation. frame_in_exception_handler() returns 78 // a frame that has a mutable one-item stack (ready for pushing the 79 // catch type exception object). All the other StackMapFrame's 80 // are immutable (including their locals and stack arrays) after 81 // their constructions. 82 // locals/stack arrays in StackMapFrame are resource allocated. 83 // locals/stack arrays can be shared between StackMapFrame's, except 84 // the mutable StackMapFrame (current_frame). 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; ((void)0 90 #define CHECK_VERIFY_(verifier, result) \ 91 CHECK_(result)); if ((verifier)->has_error()) return (result); ((void)0 92 93 class TypeOrigin { 94 private: 95 typedef enum { 96 CF_LOCALS, // Comes from the current frame locals 97 CF_STACK, // Comes from the current frame expression stack 98 SM_LOCALS, // Comes from stackmap locals 99 SM_STACK, // Comes from stackmap expression stack 100 CONST_POOL, // Comes from the constant pool 101 SIG, // Comes from method signature 102 IMPLICIT, // Comes implicitly from code or context 103 BAD_INDEX, // No type, but the index is bad 104 FRAME_ONLY, // No type, context just contains the frame 105 NONE 106 } Origin; 107 108 Origin _origin; 109 u2 _index; // local, stack, or constant pool index 110 StackMapFrame* _frame; // source frame if CF or SM 111 VerificationType _type; // The actual type 112 113 TypeOrigin( 114 Origin origin, u2 index, StackMapFrame* frame, VerificationType type) 115 : _origin(origin), _index(index), _frame(frame), _type(type) {} 116 117 public: 118 TypeOrigin() : _origin(NONE), _index(0), _frame(NULL) {} 119 120 static TypeOrigin null(); 121 static TypeOrigin local(u2 index, StackMapFrame* frame); 122 static TypeOrigin stack(u2 index, StackMapFrame* frame); 123 static TypeOrigin sm_local(u2 index, StackMapFrame* frame); 124 static TypeOrigin sm_stack(u2 index, StackMapFrame* frame); 125 static TypeOrigin cp(u2 index, VerificationType vt); 126 static TypeOrigin signature(VerificationType vt); 127 static TypeOrigin bad_index(u2 index); 128 static TypeOrigin implicit(VerificationType t); 129 static TypeOrigin frame(StackMapFrame* frame); 130 131 void reset_frame(); 132 void details(outputStream* ss) const; 133 void print_frame(outputStream* ss) const; 134 const StackMapFrame* frame() const { return _frame; } 135 bool is_valid() const { return _origin != NONE; } 136 u2 index() const { return _index; } 137 138 #ifdef ASSERT 139 void print_on(outputStream* str) const; 140 #endif 141 }; 142 143 class ErrorContext { 144 private: 145 typedef enum { 146 INVALID_BYTECODE, // There was a problem with the bytecode 147 WRONG_TYPE, // Type value was not as expected 148 FLAGS_MISMATCH, // Frame flags are not assignable 149 BAD_CP_INDEX, // Invalid constant pool index 150 BAD_LOCAL_INDEX, // Invalid local index 151 LOCALS_SIZE_MISMATCH, // Frames have differing local counts 152 STACK_SIZE_MISMATCH, // Frames have different stack sizes 153 STACK_OVERFLOW, // Attempt to push onto a full expression stack 154 STACK_UNDERFLOW, // Attempt to pop and empty expression stack 155 MISSING_STACKMAP, // No stackmap for this location and there should be 156 BAD_STACKMAP, // Format error in stackmap 157 WRONG_VALUE_TYPE, // Mismatched value type 158 NO_FAULT, // No error 159 UNKNOWN 160 } FaultType; 161 162 int _bci; 163 FaultType _fault; 164 TypeOrigin _type; 165 TypeOrigin _expected; 166 167 ErrorContext(int bci, FaultType fault) : 168 _bci(bci), _fault(fault) {} 169 ErrorContext(int bci, FaultType fault, TypeOrigin type) : 170 _bci(bci), _fault(fault), _type(type) {} 171 ErrorContext(int bci, FaultType fault, TypeOrigin type, TypeOrigin exp) : 172 _bci(bci), _fault(fault), _type(type), _expected(exp) {} 173 174 public: 175 ErrorContext() : _bci(-1), _fault(NO_FAULT) {} 176 177 static ErrorContext bad_code(u2 bci) { 178 return ErrorContext(bci, INVALID_BYTECODE); 179 } 180 static ErrorContext bad_type(u2 bci, TypeOrigin type) { 181 return ErrorContext(bci, WRONG_TYPE, type); 182 } 183 static ErrorContext bad_type(u2 bci, TypeOrigin type, TypeOrigin exp) { 184 return ErrorContext(bci, WRONG_TYPE, type, exp); 185 } 186 static ErrorContext bad_flags(u2 bci, StackMapFrame* frame) { 187 return ErrorContext(bci, FLAGS_MISMATCH, TypeOrigin::frame(frame)); 188 } 189 static ErrorContext bad_flags(u2 bci, StackMapFrame* cur, StackMapFrame* sm) { 190 return ErrorContext(bci, FLAGS_MISMATCH, 191 TypeOrigin::frame(cur), TypeOrigin::frame(sm)); 192 } 193 static ErrorContext bad_cp_index(u2 bci, u2 index) { 194 return ErrorContext(bci, BAD_CP_INDEX, TypeOrigin::bad_index(index)); 195 } 196 static ErrorContext bad_local_index(u2 bci, u2 index) { 197 return ErrorContext(bci, BAD_LOCAL_INDEX, TypeOrigin::bad_index(index)); 198 } 199 static ErrorContext locals_size_mismatch( 200 u2 bci, StackMapFrame* frame0, StackMapFrame* frame1) { 201 return ErrorContext(bci, LOCALS_SIZE_MISMATCH, 202 TypeOrigin::frame(frame0), TypeOrigin::frame(frame1)); 203 } 204 static ErrorContext stack_size_mismatch( 205 u2 bci, StackMapFrame* frame0, StackMapFrame* frame1) { 206 return ErrorContext(bci, STACK_SIZE_MISMATCH, 207 TypeOrigin::frame(frame0), TypeOrigin::frame(frame1)); 208 } 209 static ErrorContext stack_overflow(u2 bci, StackMapFrame* frame) { 210 return ErrorContext(bci, STACK_OVERFLOW, TypeOrigin::frame(frame)); 211 } 212 static ErrorContext stack_underflow(u2 bci, StackMapFrame* frame) { 213 return ErrorContext(bci, STACK_UNDERFLOW, TypeOrigin::frame(frame)); 214 } 215 static ErrorContext missing_stackmap(u2 bci) { 216 return ErrorContext(bci, MISSING_STACKMAP); 217 } 218 static ErrorContext bad_stackmap(int index, StackMapFrame* frame) { 219 return ErrorContext(0, BAD_STACKMAP, TypeOrigin::frame(frame)); 220 } 221 static ErrorContext bad_value_type(u2 bci, TypeOrigin type, TypeOrigin exp) { 222 return ErrorContext(bci, WRONG_VALUE_TYPE, type, exp); 223 } 224 225 bool is_valid() const { return _fault != NO_FAULT; } 226 int bci() const { return _bci; } 227 228 void reset_frames() { 229 _type.reset_frame(); 230 _expected.reset_frame(); 231 } 232 233 void details(outputStream* ss, const Method* method) const; 234 235 #ifdef ASSERT 236 void print_on(outputStream* str) const { 237 str->print("error_context(%d, %d,", _bci, _fault); 238 _type.print_on(str); 239 str->print(","); 240 _expected.print_on(str); 241 str->print(")"); 242 } 243 #endif 244 245 private: 246 void location_details(outputStream* ss, const Method* method) const; 247 void reason_details(outputStream* ss) const; 248 void frame_details(outputStream* ss) const; 249 void bytecode_details(outputStream* ss, const Method* method) const; 250 void handler_details(outputStream* ss, const Method* method) const; 251 void stackmap_details(outputStream* ss, const Method* method) const; 252 }; 253 254 class sig_as_verification_types : public ResourceObj { 255 private: 256 int _num_args; // Number of arguments, not including return type. 257 GrowableArray<VerificationType>* _sig_verif_types; 258 259 public: 260 261 sig_as_verification_types(GrowableArray<VerificationType>* sig_verif_types) : 262 _num_args(0), _sig_verif_types(sig_verif_types) { 263 } 264 265 int num_args() const { return _num_args; } 266 void set_num_args(int num_args) { _num_args = num_args; } 267 268 GrowableArray<VerificationType>* sig_verif_types() { return _sig_verif_types; } 269 void set_sig_verif_types(GrowableArray<VerificationType>* sig_verif_types) { 270 _sig_verif_types = sig_verif_types; 271 } 272 273 }; 274 275 // This hashtable is indexed by the Utf8 constant pool indexes pointed to 276 // by constant pool (Interface)Method_refs' NameAndType signature entries. 277 typedef ResourceHashtable<int, sig_as_verification_types*, 278 primitive_hash<int>, primitive_equals<int>, 1007> 279 method_signatures_table_type; 280 281 // A new instance of this class is created for each class being verified 282 class ClassVerifier : public StackObj { 283 private: 284 Thread* _thread; 285 286 Symbol* _previous_symbol; // cache of the previously looked up symbol 287 GrowableArray<Symbol*>* _symbols; // keep a list of symbols created 288 289 Symbol* _exception_type; 290 char* _message; 291 292 method_signatures_table_type* _method_signatures_table; 293 294 ErrorContext _error_context; // contains information about an error 295 296 void verify_method(const methodHandle& method, TRAPS); 297 char* generate_code_data(const methodHandle& m, u4 code_length, TRAPS); 298 void verify_exception_handler_table(u4 code_length, char* code_data, 299 int& min, int& max, TRAPS); 300 void verify_local_variable_table(u4 code_length, char* code_data, TRAPS); 301 302 VerificationType cp_ref_index_to_type( 303 int index, const constantPoolHandle& cp, TRAPS) { 304 return cp_index_to_type(cp->klass_ref_index_at(index), cp, THREAD); 305 } 306 307 bool is_protected_access( 308 InstanceKlass* this_class, Klass* target_class, 309 Symbol* field_name, Symbol* field_sig, bool is_method); 310 311 void verify_cp_index(u2 bci, const constantPoolHandle& cp, int index, TRAPS); 312 void verify_cp_type(u2 bci, int index, const constantPoolHandle& cp, 313 unsigned int types, TRAPS); 314 void verify_cp_class_type(u2 bci, int index, const constantPoolHandle& cp, TRAPS); 315 316 u2 verify_stackmap_table( 317 u2 stackmap_index, u2 bci, StackMapFrame* current_frame, 318 StackMapTable* stackmap_table, bool no_control_flow, TRAPS); 319 320 void verify_exception_handler_targets( 321 u2 bci, bool this_uninit, StackMapFrame* current_frame, 322 StackMapTable* stackmap_table, TRAPS); 323 324 void verify_ldc( 325 int opcode, u2 index, StackMapFrame *current_frame, 326 const constantPoolHandle& cp, u2 bci, TRAPS); 327 328 void verify_switch( 329 RawBytecodeStream* bcs, u4 code_length, char* code_data, 330 StackMapFrame* current_frame, StackMapTable* stackmap_table, TRAPS); 331 332 void verify_field_instructions( 333 RawBytecodeStream* bcs, StackMapFrame* current_frame, 334 const constantPoolHandle& cp, bool allow_arrays, TRAPS); 335 336 void verify_invoke_init( 337 RawBytecodeStream* bcs, u2 ref_index, VerificationType ref_class_type, 338 StackMapFrame* current_frame, u4 code_length, bool in_try_block, 339 bool* this_uninit, const constantPoolHandle& cp, StackMapTable* stackmap_table, 340 TRAPS); 341 342 // Used by ends_in_athrow() to push all handlers that contain bci onto the 343 // handler_stack, if the handler has not already been pushed on the stack. 344 void push_handlers(ExceptionTable* exhandlers, 345 GrowableArray<u4>* handler_list, 346 GrowableArray<u4>* handler_stack, 347 u4 bci); 348 349 // Returns true if all paths starting with start_bc_offset end in athrow 350 // bytecode or loop. 351 bool ends_in_athrow(u4 start_bc_offset); 352 353 void verify_invoke_instructions( 354 RawBytecodeStream* bcs, u4 code_length, StackMapFrame* current_frame, 355 bool in_try_block, bool* this_uninit, 356 const constantPoolHandle& cp, StackMapTable* stackmap_table, TRAPS); 357 358 VerificationType get_newarray_type(u2 index, u2 bci, TRAPS); 359 void verify_anewarray(u2 bci, u2 index, const constantPoolHandle& cp, 360 StackMapFrame* current_frame, TRAPS); 361 void verify_return_value( 362 VerificationType return_type, VerificationType type, u2 offset, 363 StackMapFrame* current_frame, TRAPS); 364 365 void verify_iload (u2 index, StackMapFrame* current_frame, TRAPS); 366 void verify_lload (u2 index, StackMapFrame* current_frame, TRAPS); 367 void verify_fload (u2 index, StackMapFrame* current_frame, TRAPS); 368 void verify_dload (u2 index, StackMapFrame* current_frame, TRAPS); 369 void verify_aload (u2 index, StackMapFrame* current_frame, TRAPS); 370 void verify_istore(u2 index, StackMapFrame* current_frame, TRAPS); 371 void verify_lstore(u2 index, StackMapFrame* current_frame, TRAPS); 372 void verify_fstore(u2 index, StackMapFrame* current_frame, TRAPS); 373 void verify_dstore(u2 index, StackMapFrame* current_frame, TRAPS); 374 void verify_astore(u2 index, StackMapFrame* current_frame, TRAPS); 375 void verify_iinc (u2 index, StackMapFrame* current_frame, TRAPS); 376 377 bool name_in_supers(Symbol* ref_name, InstanceKlass* current); 378 379 VerificationType object_type() const; 380 381 InstanceKlass* _klass; // the class being verified 382 methodHandle _method; // current method being verified 383 VerificationType _this_type; // the verification type of the current class 384 385 // Some recursive calls from the verifier to the name resolver 386 // can cause the current class to be re-verified and rewritten. 387 // If this happens, the original verification should not continue, 388 // because constant pool indexes will have changed. 389 // The rewriter is preceded by the verifier. If the verifier throws 390 // an error, rewriting is prevented. Also, rewriting always precedes 391 // bytecode execution or compilation. Thus, is_rewritten implies 392 // that a class has been verified and prepared for execution. 393 bool was_recursively_verified() { return _klass->is_rewritten(); } 394 395 bool is_same_or_direct_interface(InstanceKlass* klass, 396 VerificationType klass_type, VerificationType ref_class_type); 397 398 public: 399 enum { 400 BYTECODE_OFFSET = 1, 401 NEW_OFFSET = 2 402 }; 403 404 // constructor 405 ClassVerifier(InstanceKlass* klass, TRAPS); 406 407 // destructor 408 ~ClassVerifier(); 409 410 Thread* thread() { return _thread; } 411 const methodHandle& method() { return _method; } 412 InstanceKlass* current_class() const { return _klass; } 413 VerificationType current_type() const { return _this_type; } 414 415 // Verifies the class. If a verify or class file format error occurs, 416 // the '_exception_name' symbols will set to the exception name and 417 // the message_buffer will be filled in with the exception message. 418 void verify_class(TRAPS); 419 420 // Translates method signature entries into verificationTypes and saves them 421 // in the growable array. 422 void translate_signature(Symbol* const method_sig, sig_as_verification_types* sig_verif_types, TRAPS); 423 424 // Initializes a sig_as_verification_types entry and puts it in the hash table. 425 void create_method_sig_entry(sig_as_verification_types* sig_verif_types, int sig_index, TRAPS); 426 427 // Return status modes 428 Symbol* result() const { return _exception_type; } 429 bool has_error() const { return result() != NULL; } 430 char* exception_message() { 431 stringStream ss; 432 ss.print("%s", _message); 433 _error_context.details(&ss, _method()); 434 return ss.as_string(); 435 } 436 437 // Called when verify or class format errors are encountered. 438 // May throw an exception based upon the mode. 439 void verify_error(ErrorContext ctx, const char* fmt, ...) ATTRIBUTE_PRINTF(3, 4); 440 void class_format_error(const char* fmt, ...) ATTRIBUTE_PRINTF(2, 3); 441 442 Klass* load_class(Symbol* name, TRAPS); 443 444 method_signatures_table_type* method_signatures_table() const { 445 return _method_signatures_table; 446 } 447 448 void set_method_signatures_table(method_signatures_table_type* method_signatures_table) { 449 _method_signatures_table = method_signatures_table; 450 } 451 452 int change_sig_to_verificationType( 453 SignatureStream* sig_type, VerificationType* inference_type, TRAPS); 454 455 VerificationType cp_index_to_type(int index, const constantPoolHandle& cp, TRAPS) { 456 Symbol* name = cp->klass_name_at(index); 457 if (name->is_Q_signature()) { 458 // Remove the Q and ; 459 // TBD need error msg if fundamental_name() returns NULL? 460 Symbol* fund_name = name->fundamental_name(CHECK_(VerificationType::bogus_type())); 461 return VerificationType::valuetype_type(fund_name); 462 } 463 return VerificationType::reference_type(name); 464 } 465 466 // Keep a list of temporary symbols created during verification because 467 // their reference counts need to be decremented when the verifier object 468 // goes out of scope. Since these symbols escape the scope in which they're 469 // created, we can't use a TempNewSymbol. 470 Symbol* create_temporary_symbol(const Symbol* s, int begin, int end, TRAPS); 471 Symbol* create_temporary_symbol(const char *s, int length, TRAPS); 472 Symbol* create_temporary_symbol(Symbol* s) { 473 if (s == _previous_symbol) { 474 return s; 475 } 476 if (!s->is_permanent()) { 477 s->increment_refcount(); 478 if (_symbols == NULL) { 479 _symbols = new GrowableArray<Symbol*>(50, 0, NULL); 480 } 481 _symbols->push(s); 482 } 483 _previous_symbol = s; 484 return s; 485 } 486 487 TypeOrigin ref_ctx(const char* str, TRAPS); 488 489 }; 490 491 inline int ClassVerifier::change_sig_to_verificationType( 492 SignatureStream* sig_type, VerificationType* inference_type, TRAPS) { 493 BasicType bt = sig_type->type(); 494 switch (bt) { 495 case T_OBJECT: 496 case T_ARRAY: 497 { 498 Symbol* name = sig_type->as_symbol(CHECK_0); 499 // Create another symbol to save as signature stream unreferences this symbol. 500 Symbol* name_copy = create_temporary_symbol(name); 501 assert(name_copy == name, "symbols don't match"); 502 *inference_type = VerificationType::reference_type(name_copy); 503 return 1; 504 } 505 case T_VALUETYPE: 506 { 507 Symbol* vname = sig_type->as_symbol(CHECK_0); 508 // Create another symbol to save as signature stream unreferences this symbol. 509 Symbol* vname_copy = create_temporary_symbol(vname); 510 assert(vname_copy == vname, "symbols don't match"); 511 *inference_type = VerificationType::valuetype_type(vname_copy); 512 return 1; 513 } 514 case T_LONG: 515 *inference_type = VerificationType::long_type(); 516 *++inference_type = VerificationType::long2_type(); 517 return 2; 518 case T_DOUBLE: 519 *inference_type = VerificationType::double_type(); 520 *++inference_type = VerificationType::double2_type(); 521 return 2; 522 case T_INT: 523 case T_BOOLEAN: 524 case T_BYTE: 525 case T_CHAR: 526 case T_SHORT: 527 *inference_type = VerificationType::integer_type(); 528 return 1; 529 case T_FLOAT: 530 *inference_type = VerificationType::float_type(); 531 return 1; 532 default: 533 ShouldNotReachHere(); 534 return 1; 535 } 536 } 537 538 #endif // SHARE_CLASSFILE_VERIFIER_HPP