duke@435: /* minqi@5097: * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. duke@435: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. duke@435: * duke@435: * This code is free software; you can redistribute it and/or modify it duke@435: * under the terms of the GNU General Public License version 2 only, as duke@435: * published by the Free Software Foundation. duke@435: * duke@435: * This code is distributed in the hope that it will be useful, but WITHOUT duke@435: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or duke@435: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License duke@435: * version 2 for more details (a copy is included in the LICENSE file that duke@435: * accompanied this code). duke@435: * duke@435: * You should have received a copy of the GNU General Public License version duke@435: * 2 along with this work; if not, write to the Free Software Foundation, duke@435: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. duke@435: * trims@1907: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA trims@1907: * or visit www.oracle.com if you need additional information or have any trims@1907: * questions. duke@435: * duke@435: */ duke@435: stefank@2314: #ifndef SHARE_VM_CLASSFILE_VERIFIER_HPP stefank@2314: #define SHARE_VM_CLASSFILE_VERIFIER_HPP stefank@2314: stefank@2314: #include "classfile/verificationType.hpp" stefank@2314: #include "memory/gcLocker.hpp" stefank@2314: #include "oops/klass.hpp" coleenp@4037: #include "oops/method.hpp" stefank@2314: #include "runtime/handles.hpp" stefank@2314: #include "utilities/exceptions.hpp" stefank@2314: duke@435: // The verifier class duke@435: class Verifier : AllStatic { duke@435: public: jrose@1957: enum { hseigel@5213: STRICTER_ACCESS_CTRL_CHECK_VERSION = 49, jrose@1957: STACKMAP_ATTRIBUTE_MAJOR_VERSION = 50, hseigel@5213: INVOKEDYNAMIC_MAJOR_VERSION = 51, hseigel@5213: NO_RELAX_ACCESS_CTRL_CHECK_VERSION = 52 jrose@1957: }; duke@435: typedef enum { ThrowException, NoException } Mode; duke@435: duke@435: /** duke@435: * Verify the bytecodes for a class. If 'throw_exception' is true duke@435: * then the appropriate VerifyError or ClassFormatError will be thrown. duke@435: * Otherwise, no exception is thrown and the return indicates the duke@435: * error. duke@435: */ acorn@1408: static bool verify(instanceKlassHandle klass, Mode mode, bool should_verify_class, TRAPS); duke@435: acorn@1408: // Return false if the class is loaded by the bootstrap loader, acorn@1408: // or if defineClass was called requesting skipping verification acorn@1408: // -Xverify:all/none override this value acorn@1408: static bool should_verify_for(oop class_loader, bool should_verify_class); duke@435: duke@435: // Relax certain verifier checks to enable some broken 1.1 apps to run on 1.2. duke@435: static bool relax_verify_for(oop class_loader); duke@435: duke@435: private: acorn@1408: static bool is_eligible_for_verification(instanceKlassHandle klass, bool should_verify_class); coleenp@2497: static Symbol* inference_verify( duke@435: instanceKlassHandle klass, char* msg, size_t msg_len, TRAPS); duke@435: }; duke@435: duke@435: class RawBytecodeStream; duke@435: class StackMapFrame; duke@435: class StackMapTable; duke@435: duke@435: // Summary of verifier's memory usage: duke@435: // StackMapTable is stack allocated. coleenp@2497: // StackMapFrame are resource allocated. There is only one ResourceMark coleenp@2497: // for each class verification, which is created at the top level. duke@435: // There is one mutable StackMapFrame (current_frame) which is updated duke@435: // by abstract bytecode interpretation. frame_in_exception_handler() returns duke@435: // a frame that has a mutable one-item stack (ready for pushing the duke@435: // catch type exception object). All the other StackMapFrame's duke@435: // are immutable (including their locals and stack arrays) after duke@435: // their constructions. duke@435: // locals/stack arrays in StackMapFrame are resource allocated. duke@435: // locals/stack arrays can be shared between StackMapFrame's, except duke@435: // the mutable StackMapFrame (current_frame). duke@435: duke@435: // These macros are used similarly to CHECK macros but also check duke@435: // the status of the verifier and return if that has an error. duke@435: #define CHECK_VERIFY(verifier) \ duke@435: CHECK); if ((verifier)->has_error()) return; (0 duke@435: #define CHECK_VERIFY_(verifier, result) \ duke@435: CHECK_(result)); if ((verifier)->has_error()) return (result); (0 duke@435: kamg@3992: class TypeOrigin VALUE_OBJ_CLASS_SPEC { kamg@3992: private: kamg@3992: typedef enum { kamg@3992: CF_LOCALS, // Comes from the current frame locals kamg@3992: CF_STACK, // Comes from the current frame expression stack kamg@3992: SM_LOCALS, // Comes from stackmap locals kamg@3992: SM_STACK, // Comes from stackmap expression stack kamg@3992: CONST_POOL, // Comes from the constant pool kamg@3992: SIG, // Comes from method signature kamg@3992: IMPLICIT, // Comes implicitly from code or context kamg@3992: BAD_INDEX, // No type, but the index is bad kamg@3992: FRAME_ONLY, // No type, context just contains the frame kamg@3992: NONE kamg@3992: } Origin; kamg@3992: kamg@3992: Origin _origin; kamg@3992: u2 _index; // local, stack, or constant pool index kamg@3992: StackMapFrame* _frame; // source frame if CF or SM kamg@3992: VerificationType _type; // The actual type kamg@3992: kamg@3992: TypeOrigin( kamg@3992: Origin origin, u2 index, StackMapFrame* frame, VerificationType type) kamg@3992: : _origin(origin), _index(index), _frame(frame), _type(type) {} kamg@3992: kamg@3992: public: kamg@3992: TypeOrigin() : _origin(NONE), _index(0), _frame(NULL) {} kamg@3992: kamg@3992: static TypeOrigin null(); kamg@3992: static TypeOrigin local(u2 index, StackMapFrame* frame); kamg@3992: static TypeOrigin stack(u2 index, StackMapFrame* frame); kamg@3992: static TypeOrigin sm_local(u2 index, StackMapFrame* frame); kamg@3992: static TypeOrigin sm_stack(u2 index, StackMapFrame* frame); kamg@3992: static TypeOrigin cp(u2 index, VerificationType vt); kamg@3992: static TypeOrigin signature(VerificationType vt); kamg@3992: static TypeOrigin bad_index(u2 index); kamg@3992: static TypeOrigin implicit(VerificationType t); kamg@3992: static TypeOrigin frame(StackMapFrame* frame); kamg@3992: kamg@3992: void reset_frame(); kamg@3992: void details(outputStream* ss) const; kamg@3992: void print_frame(outputStream* ss) const; kamg@3992: const StackMapFrame* frame() const { return _frame; } kamg@3992: bool is_valid() const { return _origin != NONE; } kamg@3992: u2 index() const { return _index; } kamg@3992: kamg@3992: #ifdef ASSERT kamg@3992: void print_on(outputStream* str) const; kamg@3992: #endif kamg@3992: }; kamg@3992: kamg@3992: class ErrorContext VALUE_OBJ_CLASS_SPEC { kamg@3992: private: kamg@3992: typedef enum { kamg@3992: INVALID_BYTECODE, // There was a problem with the bytecode kamg@3992: WRONG_TYPE, // Type value was not as expected kamg@3992: FLAGS_MISMATCH, // Frame flags are not assignable kamg@3992: BAD_CP_INDEX, // Invalid constant pool index kamg@3992: BAD_LOCAL_INDEX, // Invalid local index kamg@3992: LOCALS_SIZE_MISMATCH, // Frames have differing local counts kamg@3992: STACK_SIZE_MISMATCH, // Frames have different stack sizes kamg@3992: STACK_OVERFLOW, // Attempt to push onto a full expression stack kamg@3992: STACK_UNDERFLOW, // Attempt to pop and empty expression stack kamg@3992: MISSING_STACKMAP, // No stackmap for this location and there should be kamg@3992: BAD_STACKMAP, // Format error in stackmap kamg@3992: NO_FAULT, // No error kamg@3992: UNKNOWN kamg@3992: } FaultType; kamg@3992: kamg@3992: int _bci; kamg@3992: FaultType _fault; kamg@3992: TypeOrigin _type; kamg@3992: TypeOrigin _expected; kamg@3992: kamg@3992: ErrorContext(int bci, FaultType fault) : kamg@3992: _bci(bci), _fault(fault) {} kamg@3992: ErrorContext(int bci, FaultType fault, TypeOrigin type) : kamg@3992: _bci(bci), _fault(fault), _type(type) {} kamg@3992: ErrorContext(int bci, FaultType fault, TypeOrigin type, TypeOrigin exp) : kamg@3992: _bci(bci), _fault(fault), _type(type), _expected(exp) {} kamg@3992: kamg@3992: public: kamg@3992: ErrorContext() : _bci(-1), _fault(NO_FAULT) {} kamg@3992: kamg@3992: static ErrorContext bad_code(u2 bci) { kamg@3992: return ErrorContext(bci, INVALID_BYTECODE); kamg@3992: } kamg@3992: static ErrorContext bad_type(u2 bci, TypeOrigin type) { kamg@3992: return ErrorContext(bci, WRONG_TYPE, type); kamg@3992: } kamg@3992: static ErrorContext bad_type(u2 bci, TypeOrigin type, TypeOrigin exp) { kamg@3992: return ErrorContext(bci, WRONG_TYPE, type, exp); kamg@3992: } kamg@3992: static ErrorContext bad_flags(u2 bci, StackMapFrame* frame) { kamg@3992: return ErrorContext(bci, FLAGS_MISMATCH, TypeOrigin::frame(frame)); kamg@3992: } kamg@3992: static ErrorContext bad_flags(u2 bci, StackMapFrame* cur, StackMapFrame* sm) { kamg@3992: return ErrorContext(bci, FLAGS_MISMATCH, kamg@3992: TypeOrigin::frame(cur), TypeOrigin::frame(sm)); kamg@3992: } kamg@3992: static ErrorContext bad_cp_index(u2 bci, u2 index) { kamg@3992: return ErrorContext(bci, BAD_CP_INDEX, TypeOrigin::bad_index(index)); kamg@3992: } kamg@3992: static ErrorContext bad_local_index(u2 bci, u2 index) { kamg@3992: return ErrorContext(bci, BAD_LOCAL_INDEX, TypeOrigin::bad_index(index)); kamg@3992: } kamg@3992: static ErrorContext locals_size_mismatch( kamg@3992: u2 bci, StackMapFrame* frame0, StackMapFrame* frame1) { kamg@3992: return ErrorContext(bci, LOCALS_SIZE_MISMATCH, kamg@3992: TypeOrigin::frame(frame0), TypeOrigin::frame(frame1)); kamg@3992: } kamg@3992: static ErrorContext stack_size_mismatch( kamg@3992: u2 bci, StackMapFrame* frame0, StackMapFrame* frame1) { kamg@3992: return ErrorContext(bci, STACK_SIZE_MISMATCH, kamg@3992: TypeOrigin::frame(frame0), TypeOrigin::frame(frame1)); kamg@3992: } kamg@3992: static ErrorContext stack_overflow(u2 bci, StackMapFrame* frame) { kamg@3992: return ErrorContext(bci, STACK_OVERFLOW, TypeOrigin::frame(frame)); kamg@3992: } kamg@3992: static ErrorContext stack_underflow(u2 bci, StackMapFrame* frame) { kamg@3992: return ErrorContext(bci, STACK_UNDERFLOW, TypeOrigin::frame(frame)); kamg@3992: } kamg@3992: static ErrorContext missing_stackmap(u2 bci) { kamg@3992: return ErrorContext(bci, MISSING_STACKMAP); kamg@3992: } kamg@3992: static ErrorContext bad_stackmap(int index, StackMapFrame* frame) { kamg@3992: return ErrorContext(0, BAD_STACKMAP, TypeOrigin::frame(frame)); kamg@3992: } kamg@3992: kamg@3992: bool is_valid() const { return _fault != NO_FAULT; } kamg@3992: int bci() const { return _bci; } kamg@3992: kamg@3992: void reset_frames() { kamg@3992: _type.reset_frame(); kamg@3992: _expected.reset_frame(); kamg@3992: } kamg@3992: minqi@5097: void details(outputStream* ss, const Method* method) const; kamg@3992: kamg@3992: #ifdef ASSERT kamg@3992: void print_on(outputStream* str) const { kamg@3992: str->print("error_context(%d, %d,", _bci, _fault); kamg@3992: _type.print_on(str); kamg@3992: str->print(","); kamg@3992: _expected.print_on(str); kamg@3992: str->print(")"); kamg@3992: } kamg@3992: #endif kamg@3992: kamg@3992: private: minqi@5097: void location_details(outputStream* ss, const Method* method) const; kamg@3992: void reason_details(outputStream* ss) const; kamg@3992: void frame_details(outputStream* ss) const; minqi@5097: void bytecode_details(outputStream* ss, const Method* method) const; minqi@5097: void handler_details(outputStream* ss, const Method* method) const; minqi@5097: void stackmap_details(outputStream* ss, const Method* method) const; kamg@3992: }; kamg@3992: duke@435: // A new instance of this class is created for each class being verified duke@435: class ClassVerifier : public StackObj { duke@435: private: duke@435: Thread* _thread; kamg@3992: GrowableArray* _symbols; // keep a list of symbols created kamg@3992: coleenp@2497: Symbol* _exception_type; duke@435: char* _message; kamg@3992: kamg@3992: ErrorContext _error_context; // contains information about an error duke@435: duke@435: void verify_method(methodHandle method, TRAPS); duke@435: char* generate_code_data(methodHandle m, u4 code_length, TRAPS); kamg@3992: void verify_exception_handler_table(u4 code_length, char* code_data, kamg@3992: int& min, int& max, TRAPS); duke@435: void verify_local_variable_table(u4 code_length, char* code_data, TRAPS); duke@435: duke@435: VerificationType cp_ref_index_to_type( duke@435: int index, constantPoolHandle cp, TRAPS) { duke@435: return cp_index_to_type(cp->klass_ref_index_at(index), cp, THREAD); duke@435: } duke@435: duke@435: bool is_protected_access( coleenp@4037: instanceKlassHandle this_class, Klass* target_class, coleenp@2497: Symbol* field_name, Symbol* field_sig, bool is_method); duke@435: kamg@3992: void verify_cp_index(u2 bci, constantPoolHandle cp, int index, TRAPS); kamg@3992: void verify_cp_type(u2 bci, int index, constantPoolHandle cp, kamg@3992: unsigned int types, TRAPS); kamg@3992: void verify_cp_class_type(u2 bci, int index, constantPoolHandle cp, TRAPS); duke@435: duke@435: u2 verify_stackmap_table( duke@435: u2 stackmap_index, u2 bci, StackMapFrame* current_frame, duke@435: StackMapTable* stackmap_table, bool no_control_flow, TRAPS); duke@435: duke@435: void verify_exception_handler_targets( duke@435: u2 bci, bool this_uninit, StackMapFrame* current_frame, duke@435: StackMapTable* stackmap_table, TRAPS); duke@435: duke@435: void verify_ldc( duke@435: int opcode, u2 index, StackMapFrame *current_frame, duke@435: constantPoolHandle cp, u2 bci, TRAPS); duke@435: duke@435: void verify_switch( duke@435: RawBytecodeStream* bcs, u4 code_length, char* code_data, duke@435: StackMapFrame* current_frame, StackMapTable* stackmap_table, TRAPS); duke@435: duke@435: void verify_field_instructions( duke@435: RawBytecodeStream* bcs, StackMapFrame* current_frame, duke@435: constantPoolHandle cp, TRAPS); duke@435: duke@435: void verify_invoke_init( kamg@3992: RawBytecodeStream* bcs, u2 ref_index, VerificationType ref_class_type, duke@435: StackMapFrame* current_frame, u4 code_length, bool* this_uninit, duke@435: constantPoolHandle cp, TRAPS); duke@435: duke@435: void verify_invoke_instructions( duke@435: RawBytecodeStream* bcs, u4 code_length, StackMapFrame* current_frame, duke@435: bool* this_uninit, VerificationType return_type, duke@435: constantPoolHandle cp, TRAPS); duke@435: duke@435: VerificationType get_newarray_type(u2 index, u2 bci, TRAPS); kamg@3992: void verify_anewarray(u2 bci, u2 index, constantPoolHandle cp, kamg@3992: StackMapFrame* current_frame, TRAPS); duke@435: void verify_return_value( kamg@3992: VerificationType return_type, VerificationType type, u2 offset, kamg@3992: StackMapFrame* current_frame, TRAPS); duke@435: duke@435: void verify_iload (u2 index, StackMapFrame* current_frame, TRAPS); duke@435: void verify_lload (u2 index, StackMapFrame* current_frame, TRAPS); duke@435: void verify_fload (u2 index, StackMapFrame* current_frame, TRAPS); duke@435: void verify_dload (u2 index, StackMapFrame* current_frame, TRAPS); duke@435: void verify_aload (u2 index, StackMapFrame* current_frame, TRAPS); duke@435: void verify_istore(u2 index, StackMapFrame* current_frame, TRAPS); duke@435: void verify_lstore(u2 index, StackMapFrame* current_frame, TRAPS); duke@435: void verify_fstore(u2 index, StackMapFrame* current_frame, TRAPS); duke@435: void verify_dstore(u2 index, StackMapFrame* current_frame, TRAPS); duke@435: void verify_astore(u2 index, StackMapFrame* current_frame, TRAPS); duke@435: void verify_iinc (u2 index, StackMapFrame* current_frame, TRAPS); duke@435: coleenp@2497: bool name_in_supers(Symbol* ref_name, instanceKlassHandle current); duke@435: kamg@2297: VerificationType object_type() const; kamg@2297: duke@435: instanceKlassHandle _klass; // the class being verified duke@435: methodHandle _method; // current method being verified duke@435: VerificationType _this_type; // the verification type of the current class duke@435: jrose@1925: // Some recursive calls from the verifier to the name resolver jrose@1925: // can cause the current class to be re-verified and rewritten. jrose@1925: // If this happens, the original verification should not continue, jrose@1925: // because constant pool indexes will have changed. jrose@1925: // The rewriter is preceded by the verifier. If the verifier throws jrose@1925: // an error, rewriting is prevented. Also, rewriting always precedes jrose@1925: // bytecode execution or compilation. Thus, is_rewritten implies jrose@1925: // that a class has been verified and prepared for execution. jrose@1925: bool was_recursively_verified() { return _klass->is_rewritten(); } jrose@1925: duke@435: public: duke@435: enum { duke@435: BYTECODE_OFFSET = 1, duke@435: NEW_OFFSET = 2 duke@435: }; duke@435: duke@435: // constructor kamg@3992: ClassVerifier(instanceKlassHandle klass, TRAPS); duke@435: duke@435: // destructor duke@435: ~ClassVerifier(); duke@435: duke@435: Thread* thread() { return _thread; } duke@435: methodHandle method() { return _method; } duke@435: instanceKlassHandle current_class() const { return _klass; } duke@435: VerificationType current_type() const { return _this_type; } duke@435: duke@435: // Verifies the class. If a verify or class file format error occurs, duke@435: // the '_exception_name' symbols will set to the exception name and duke@435: // the message_buffer will be filled in with the exception message. duke@435: void verify_class(TRAPS); duke@435: duke@435: // Return status modes coleenp@2497: Symbol* result() const { return _exception_type; } coleenp@2497: bool has_error() const { return result() != NULL; } kamg@3992: char* exception_message() { kamg@3992: stringStream ss; kamg@3992: ss.print(_message); kamg@3992: _error_context.details(&ss, _method()); kamg@3992: return ss.as_string(); kamg@3992: } duke@435: duke@435: // Called when verify or class format errors are encountered. duke@435: // May throw an exception based upon the mode. kamg@3992: void verify_error(ErrorContext ctx, const char* fmt, ...); duke@435: void class_format_error(const char* fmt, ...); duke@435: coleenp@4037: Klass* load_class(Symbol* name, TRAPS); duke@435: duke@435: int change_sig_to_verificationType( duke@435: SignatureStream* sig_type, VerificationType* inference_type, TRAPS); duke@435: duke@435: VerificationType cp_index_to_type(int index, constantPoolHandle cp, TRAPS) { coleenp@2497: return VerificationType::reference_type(cp->klass_name_at(index)); duke@435: } duke@435: coleenp@2497: // Keep a list of temporary symbols created during verification because coleenp@2497: // their reference counts need to be decrememented when the verifier object coleenp@2497: // goes out of scope. Since these symbols escape the scope in which they're coleenp@2497: // created, we can't use a TempNewSymbol. kamg@3992: Symbol* create_temporary_symbol( kamg@3992: const Symbol* s, int begin, int end, TRAPS); coleenp@2497: Symbol* create_temporary_symbol(const char *s, int length, TRAPS); coleenp@2497: kamg@3992: TypeOrigin ref_ctx(const char* str, TRAPS); duke@435: }; duke@435: duke@435: inline int ClassVerifier::change_sig_to_verificationType( duke@435: SignatureStream* sig_type, VerificationType* inference_type, TRAPS) { duke@435: BasicType bt = sig_type->type(); duke@435: switch (bt) { duke@435: case T_OBJECT: duke@435: case T_ARRAY: duke@435: { coleenp@2497: Symbol* name = sig_type->as_symbol(CHECK_0); coleenp@2497: // Create another symbol to save as signature stream unreferences coleenp@2497: // this symbol. coleenp@2497: Symbol* name_copy = coleenp@2497: create_temporary_symbol(name, 0, name->utf8_length(), CHECK_0); coleenp@2497: assert(name_copy == name, "symbols don't match"); duke@435: *inference_type = coleenp@2497: VerificationType::reference_type(name_copy); duke@435: return 1; duke@435: } duke@435: case T_LONG: duke@435: *inference_type = VerificationType::long_type(); duke@435: *++inference_type = VerificationType::long2_type(); duke@435: return 2; duke@435: case T_DOUBLE: duke@435: *inference_type = VerificationType::double_type(); duke@435: *++inference_type = VerificationType::double2_type(); duke@435: return 2; duke@435: case T_INT: duke@435: case T_BOOLEAN: duke@435: case T_BYTE: duke@435: case T_CHAR: duke@435: case T_SHORT: duke@435: *inference_type = VerificationType::integer_type(); duke@435: return 1; duke@435: case T_FLOAT: duke@435: *inference_type = VerificationType::float_type(); duke@435: return 1; duke@435: default: duke@435: ShouldNotReachHere(); duke@435: return 1; duke@435: } duke@435: } stefank@2314: stefank@2314: #endif // SHARE_VM_CLASSFILE_VERIFIER_HPP