aoqi@0: /* aoqi@0: * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. aoqi@0: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. aoqi@0: * aoqi@0: * This code is free software; you can redistribute it and/or modify it aoqi@0: * under the terms of the GNU General Public License version 2 only, as aoqi@0: * published by the Free Software Foundation. aoqi@0: * aoqi@0: * This code is distributed in the hope that it will be useful, but WITHOUT aoqi@0: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or aoqi@0: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License aoqi@0: * version 2 for more details (a copy is included in the LICENSE file that aoqi@0: * accompanied this code). aoqi@0: * aoqi@0: * You should have received a copy of the GNU General Public License version aoqi@0: * 2 along with this work; if not, write to the Free Software Foundation, aoqi@0: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. aoqi@0: * aoqi@0: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA aoqi@0: * or visit www.oracle.com if you need additional information or have any aoqi@0: * questions. aoqi@0: * aoqi@0: */ aoqi@0: aoqi@0: #ifndef SHARE_VM_RUNTIME_SIGNATURE_HPP aoqi@0: #define SHARE_VM_RUNTIME_SIGNATURE_HPP aoqi@0: aoqi@0: #include "memory/allocation.hpp" aoqi@0: #include "oops/method.hpp" aoqi@0: #include "utilities/top.hpp" aoqi@0: aoqi@0: // SignatureIterators iterate over a Java signature (or parts of it). aoqi@0: // (Syntax according to: "The Java Virtual Machine Specification" by aoqi@0: // Tim Lindholm & Frank Yellin; section 4.3 Descriptors; p. 89ff.) aoqi@0: // aoqi@0: // Example: Iterating over ([Lfoo;D)I using aoqi@0: // 0123456789 aoqi@0: // aoqi@0: // iterate_parameters() calls: do_array(2, 7); do_double(); aoqi@0: // iterate_returntype() calls: do_int(); aoqi@0: // iterate() calls: do_array(2, 7); do_double(); do_int(); aoqi@0: // aoqi@0: // is_return_type() is: false ; false ; true aoqi@0: // aoqi@0: // NOTE: The new optimizer has an alternate, for-loop based signature aoqi@0: // iterator implemented in opto/type.cpp, TypeTuple::make(). aoqi@0: aoqi@0: class SignatureIterator: public ResourceObj { aoqi@0: protected: aoqi@0: Symbol* _signature; // the signature to iterate over aoqi@0: int _index; // the current character index (only valid during iteration) aoqi@0: int _parameter_index; // the current parameter index (0 outside iteration phase) aoqi@0: BasicType _return_type; aoqi@0: aoqi@0: void expect(char c); aoqi@0: void skip_optional_size(); aoqi@0: int parse_type(); // returns the parameter size in words (0 for void) aoqi@0: void check_signature_end(); aoqi@0: aoqi@0: public: aoqi@0: // Definitions used in generating and iterating the aoqi@0: // bit field form of the signature generated by the aoqi@0: // Fingerprinter. aoqi@0: enum { aoqi@0: static_feature_size = 1, aoqi@0: result_feature_size = 4, aoqi@0: result_feature_mask = 0xF, aoqi@0: parameter_feature_size = 4, aoqi@0: parameter_feature_mask = 0xF, aoqi@0: aoqi@0: bool_parm = 1, aoqi@0: byte_parm = 2, aoqi@0: char_parm = 3, aoqi@0: short_parm = 4, aoqi@0: int_parm = 5, aoqi@0: long_parm = 6, aoqi@0: float_parm = 7, aoqi@0: double_parm = 8, aoqi@0: obj_parm = 9, aoqi@0: done_parm = 10, // marker for end of parameters aoqi@0: aoqi@0: // max parameters is wordsize minus aoqi@0: // The sign bit, termination field, the result and static bit fields aoqi@0: max_size_of_parameters = (BitsPerLong-1 - aoqi@0: result_feature_size - parameter_feature_size - aoqi@0: static_feature_size) / parameter_feature_size aoqi@0: }; aoqi@0: aoqi@0: // Constructors aoqi@0: SignatureIterator(Symbol* signature); aoqi@0: aoqi@0: // Iteration aoqi@0: void dispatch_field(); // dispatches once for field signatures aoqi@0: void iterate_parameters(); // iterates over parameters only aoqi@0: void iterate_parameters( uint64_t fingerprint ); aoqi@0: void iterate_returntype(); // iterates over returntype only aoqi@0: void iterate(); // iterates over whole signature aoqi@0: // Returns the word index of the current parameter; aoqi@0: int parameter_index() const { return _parameter_index; } aoqi@0: bool is_return_type() const { return parameter_index() < 0; } aoqi@0: BasicType get_ret_type() const { return _return_type; } aoqi@0: aoqi@0: // Basic types aoqi@0: virtual void do_bool () = 0; aoqi@0: virtual void do_char () = 0; aoqi@0: virtual void do_float () = 0; aoqi@0: virtual void do_double() = 0; aoqi@0: virtual void do_byte () = 0; aoqi@0: virtual void do_short () = 0; aoqi@0: virtual void do_int () = 0; aoqi@0: virtual void do_long () = 0; aoqi@0: virtual void do_void () = 0; aoqi@0: aoqi@0: // Object types (begin indexes the first character of the entry, end indexes the first character after the entry) aoqi@0: virtual void do_object(int begin, int end) = 0; aoqi@0: virtual void do_array (int begin, int end) = 0; aoqi@0: }; aoqi@0: aoqi@0: aoqi@0: // Specialized SignatureIterators: Used to compute signature specific values. aoqi@0: aoqi@0: class SignatureTypeNames : public SignatureIterator { aoqi@0: protected: aoqi@0: virtual void type_name(const char* name) = 0; aoqi@0: aoqi@0: void do_bool() { type_name("jboolean"); } aoqi@0: void do_char() { type_name("jchar" ); } aoqi@0: void do_float() { type_name("jfloat" ); } aoqi@0: void do_double() { type_name("jdouble" ); } aoqi@0: void do_byte() { type_name("jbyte" ); } aoqi@0: void do_short() { type_name("jshort" ); } aoqi@0: void do_int() { type_name("jint" ); } aoqi@0: void do_long() { type_name("jlong" ); } aoqi@0: void do_void() { type_name("void" ); } aoqi@0: void do_object(int begin, int end) { type_name("jobject" ); } aoqi@0: void do_array (int begin, int end) { type_name("jobject" ); } aoqi@0: aoqi@0: public: aoqi@0: SignatureTypeNames(Symbol* signature) : SignatureIterator(signature) {} aoqi@0: }; aoqi@0: aoqi@0: aoqi@0: class SignatureInfo: public SignatureIterator { aoqi@0: protected: aoqi@0: bool _has_iterated; // need this because iterate cannot be called in constructor (set is virtual!) aoqi@0: bool _has_iterated_return; aoqi@0: int _size; aoqi@0: aoqi@0: void lazy_iterate_parameters() { if (!_has_iterated) { iterate_parameters(); _has_iterated = true; } } aoqi@0: void lazy_iterate_return() { if (!_has_iterated_return) { iterate_returntype(); _has_iterated_return = true; } } aoqi@0: aoqi@0: virtual void set(int size, BasicType type) = 0; aoqi@0: aoqi@0: void do_bool () { set(T_BOOLEAN_size, T_BOOLEAN); } aoqi@0: void do_char () { set(T_CHAR_size , T_CHAR ); } aoqi@0: void do_float () { set(T_FLOAT_size , T_FLOAT ); } aoqi@0: void do_double() { set(T_DOUBLE_size , T_DOUBLE ); } aoqi@0: void do_byte () { set(T_BYTE_size , T_BYTE ); } aoqi@0: void do_short () { set(T_SHORT_size , T_SHORT ); } aoqi@0: void do_int () { set(T_INT_size , T_INT ); } aoqi@0: void do_long () { set(T_LONG_size , T_LONG ); } aoqi@0: void do_void () { set(T_VOID_size , T_VOID ); } aoqi@0: void do_object(int begin, int end) { set(T_OBJECT_size , T_OBJECT ); } aoqi@0: void do_array (int begin, int end) { set(T_ARRAY_size , T_ARRAY ); } aoqi@0: aoqi@0: public: aoqi@0: SignatureInfo(Symbol* signature) : SignatureIterator(signature) { aoqi@0: _has_iterated = _has_iterated_return = false; aoqi@0: _size = 0; aoqi@0: _return_type = T_ILLEGAL; aoqi@0: } aoqi@0: aoqi@0: }; aoqi@0: aoqi@0: aoqi@0: // Specialized SignatureIterator: Used to compute the argument size. aoqi@0: aoqi@0: class ArgumentSizeComputer: public SignatureInfo { aoqi@0: private: aoqi@0: void set(int size, BasicType type) { _size += size; } aoqi@0: public: aoqi@0: ArgumentSizeComputer(Symbol* signature) : SignatureInfo(signature) {} aoqi@0: aoqi@0: int size() { lazy_iterate_parameters(); return _size; } aoqi@0: }; aoqi@0: aoqi@0: aoqi@0: class ArgumentCount: public SignatureInfo { aoqi@0: private: aoqi@0: void set(int size, BasicType type) { _size ++; } aoqi@0: public: aoqi@0: ArgumentCount(Symbol* signature) : SignatureInfo(signature) {} aoqi@0: aoqi@0: int size() { lazy_iterate_parameters(); return _size; } aoqi@0: }; aoqi@0: aoqi@0: aoqi@0: // Specialized SignatureIterator: Used to compute the result type. aoqi@0: aoqi@0: class ResultTypeFinder: public SignatureInfo { aoqi@0: private: aoqi@0: void set(int size, BasicType type) { _return_type = type; } aoqi@0: public: aoqi@0: BasicType type() { lazy_iterate_return(); return _return_type; } aoqi@0: aoqi@0: ResultTypeFinder(Symbol* signature) : SignatureInfo(signature) {} aoqi@0: }; aoqi@0: aoqi@0: aoqi@0: // Fingerprinter computes a unique ID for a given method. The ID aoqi@0: // is a bitvector characterizing the methods signature (incl. the receiver). aoqi@0: class Fingerprinter: public SignatureIterator { aoqi@0: private: aoqi@0: uint64_t _fingerprint; aoqi@0: int _shift_count; aoqi@0: methodHandle mh; aoqi@0: aoqi@0: public: aoqi@0: aoqi@0: void do_bool() { _fingerprint |= (((uint64_t)bool_parm) << _shift_count); _shift_count += parameter_feature_size; } aoqi@0: void do_char() { _fingerprint |= (((uint64_t)char_parm) << _shift_count); _shift_count += parameter_feature_size; } aoqi@0: void do_byte() { _fingerprint |= (((uint64_t)byte_parm) << _shift_count); _shift_count += parameter_feature_size; } aoqi@0: void do_short() { _fingerprint |= (((uint64_t)short_parm) << _shift_count); _shift_count += parameter_feature_size; } aoqi@0: void do_int() { _fingerprint |= (((uint64_t)int_parm) << _shift_count); _shift_count += parameter_feature_size; } aoqi@0: void do_long() { _fingerprint |= (((uint64_t)long_parm) << _shift_count); _shift_count += parameter_feature_size; } aoqi@0: void do_float() { _fingerprint |= (((uint64_t)float_parm) << _shift_count); _shift_count += parameter_feature_size; } aoqi@0: void do_double() { _fingerprint |= (((uint64_t)double_parm) << _shift_count); _shift_count += parameter_feature_size; } aoqi@0: aoqi@0: void do_object(int begin, int end) { _fingerprint |= (((uint64_t)obj_parm) << _shift_count); _shift_count += parameter_feature_size; } aoqi@0: void do_array (int begin, int end) { _fingerprint |= (((uint64_t)obj_parm) << _shift_count); _shift_count += parameter_feature_size; } aoqi@0: aoqi@0: void do_void() { ShouldNotReachHere(); } aoqi@0: aoqi@0: Fingerprinter(methodHandle method) : SignatureIterator(method->signature()) { aoqi@0: mh = method; aoqi@0: _fingerprint = 0; aoqi@0: } aoqi@0: aoqi@0: uint64_t fingerprint() { aoqi@0: // See if we fingerprinted this method already aoqi@0: if (mh->constMethod()->fingerprint() != CONST64(0)) { aoqi@0: return mh->constMethod()->fingerprint(); aoqi@0: } aoqi@0: aoqi@0: if (mh->size_of_parameters() > max_size_of_parameters ) { aoqi@0: _fingerprint = UCONST64(-1); aoqi@0: mh->constMethod()->set_fingerprint(_fingerprint); aoqi@0: return _fingerprint; aoqi@0: } aoqi@0: aoqi@0: assert( (int)mh->result_type() <= (int)result_feature_mask, "bad result type"); aoqi@0: _fingerprint = mh->result_type(); aoqi@0: _fingerprint <<= static_feature_size; aoqi@0: if (mh->is_static()) _fingerprint |= 1; aoqi@0: _shift_count = result_feature_size + static_feature_size; aoqi@0: iterate_parameters(); aoqi@0: _fingerprint |= ((uint64_t)done_parm) << _shift_count;// mark end of sig aoqi@0: mh->constMethod()->set_fingerprint(_fingerprint); aoqi@0: return _fingerprint; aoqi@0: } aoqi@0: }; aoqi@0: aoqi@0: aoqi@0: // Specialized SignatureIterator: Used for native call purposes aoqi@0: aoqi@0: class NativeSignatureIterator: public SignatureIterator { aoqi@0: private: aoqi@0: methodHandle _method; aoqi@0: // We need separate JNI and Java offset values because in 64 bit mode, aoqi@0: // the argument offsets are not in sync with the Java stack. aoqi@0: // For example a long takes up 1 "C" stack entry but 2 Java stack entries. aoqi@0: int _offset; // The java stack offset aoqi@0: int _prepended; // number of prepended JNI parameters (1 JNIEnv, plus 1 mirror if static) aoqi@0: int _jni_offset; // the current parameter offset, starting with 0 aoqi@0: aoqi@0: void do_bool () { pass_int(); _jni_offset++; _offset++; } aoqi@0: void do_char () { pass_int(); _jni_offset++; _offset++; } aoqi@0: void do_float () { pass_float(); _jni_offset++; _offset++; } aoqi@0: #ifdef _LP64 aoqi@0: void do_double() { pass_double(); _jni_offset++; _offset += 2; } aoqi@0: #else aoqi@0: void do_double() { pass_double(); _jni_offset += 2; _offset += 2; } aoqi@0: #endif aoqi@0: void do_byte () { pass_int(); _jni_offset++; _offset++; } aoqi@0: void do_short () { pass_int(); _jni_offset++; _offset++; } aoqi@0: void do_int () { pass_int(); _jni_offset++; _offset++; } aoqi@0: #ifdef _LP64 aoqi@0: void do_long () { pass_long(); _jni_offset++; _offset += 2; } aoqi@0: #else aoqi@0: void do_long () { pass_long(); _jni_offset += 2; _offset += 2; } aoqi@0: #endif aoqi@0: void do_void () { ShouldNotReachHere(); } aoqi@0: void do_object(int begin, int end) { pass_object(); _jni_offset++; _offset++; } aoqi@0: void do_array (int begin, int end) { pass_object(); _jni_offset++; _offset++; } aoqi@0: aoqi@0: public: aoqi@0: methodHandle method() const { return _method; } aoqi@0: int offset() const { return _offset; } aoqi@0: int jni_offset() const { return _jni_offset + _prepended; } aoqi@0: // int java_offset() const { return method()->size_of_parameters() - _offset - 1; } aoqi@0: bool is_static() const { return method()->is_static(); } aoqi@0: virtual void pass_int() = 0; aoqi@0: virtual void pass_long() = 0; aoqi@0: virtual void pass_object() = 0; aoqi@0: virtual void pass_float() = 0; aoqi@0: #ifdef _LP64 aoqi@0: virtual void pass_double() = 0; aoqi@0: #else aoqi@0: virtual void pass_double() { pass_long(); } // may be same as long aoqi@0: #endif aoqi@0: aoqi@0: NativeSignatureIterator(methodHandle method) : SignatureIterator(method->signature()) { aoqi@0: _method = method; aoqi@0: _offset = 0; aoqi@0: _jni_offset = 0; aoqi@0: aoqi@0: const int JNIEnv_words = 1; aoqi@0: const int mirror_words = 1; aoqi@0: _prepended = !is_static() ? JNIEnv_words : JNIEnv_words + mirror_words; aoqi@0: } aoqi@0: aoqi@0: // iterate() calles the 2 virtual methods according to the following invocation syntax: aoqi@0: // aoqi@0: // {pass_int | pass_long | pass_object} aoqi@0: // aoqi@0: // Arguments are handled from left to right (receiver first, if any). aoqi@0: // The offset() values refer to the Java stack offsets but are 0 based and increasing. aoqi@0: // The java_offset() values count down to 0, and refer to the Java TOS. aoqi@0: // The jni_offset() values increase from 1 or 2, and refer to C arguments. aoqi@0: aoqi@0: void iterate() { iterate(Fingerprinter(method()).fingerprint()); aoqi@0: } aoqi@0: aoqi@0: aoqi@0: // Optimized path if we have the bitvector form of signature aoqi@0: void iterate( uint64_t fingerprint ) { aoqi@0: aoqi@0: if (!is_static()) { aoqi@0: // handle receiver (not handled by iterate because not in signature) aoqi@0: pass_object(); _jni_offset++; _offset++; aoqi@0: } aoqi@0: aoqi@0: SignatureIterator::iterate_parameters( fingerprint ); aoqi@0: } aoqi@0: }; aoqi@0: aoqi@0: aoqi@0: // Handy stream for iterating over signature aoqi@0: aoqi@0: class SignatureStream : public StackObj { aoqi@0: private: aoqi@0: Symbol* _signature; aoqi@0: int _begin; aoqi@0: int _end; aoqi@0: BasicType _type; aoqi@0: bool _at_return_type; aoqi@0: GrowableArray* _names; // symbols created while parsing signature aoqi@0: aoqi@0: public: aoqi@0: bool at_return_type() const { return _at_return_type; } aoqi@0: bool is_done() const; aoqi@0: void next_non_primitive(int t); aoqi@0: void next() { aoqi@0: Symbol* sig = _signature; aoqi@0: int len = sig->utf8_length(); aoqi@0: if (_end >= len) { aoqi@0: _end = len + 1; aoqi@0: return; aoqi@0: } aoqi@0: aoqi@0: _begin = _end; aoqi@0: int t = sig->byte_at(_begin); aoqi@0: switch (t) { aoqi@0: case 'B': _type = T_BYTE; break; aoqi@0: case 'C': _type = T_CHAR; break; aoqi@0: case 'D': _type = T_DOUBLE; break; aoqi@0: case 'F': _type = T_FLOAT; break; aoqi@0: case 'I': _type = T_INT; break; aoqi@0: case 'J': _type = T_LONG; break; aoqi@0: case 'S': _type = T_SHORT; break; aoqi@0: case 'Z': _type = T_BOOLEAN; break; aoqi@0: case 'V': _type = T_VOID; break; aoqi@0: default : next_non_primitive(t); aoqi@0: return; aoqi@0: } aoqi@0: _end++; aoqi@0: } aoqi@0: aoqi@0: SignatureStream(Symbol* signature, bool is_method = true); aoqi@0: ~SignatureStream(); aoqi@0: aoqi@0: bool is_object() const; // True if this argument is an object aoqi@0: bool is_array() const; // True if this argument is an array aoqi@0: BasicType type() const { return _type; } aoqi@0: Symbol* as_symbol(TRAPS); aoqi@0: enum FailureMode { ReturnNull, CNFException, NCDFError }; aoqi@0: Klass* as_klass(Handle class_loader, Handle protection_domain, FailureMode failure_mode, TRAPS); aoqi@0: oop as_java_mirror(Handle class_loader, Handle protection_domain, FailureMode failure_mode, TRAPS); aoqi@0: const jbyte* raw_bytes() { return _signature->bytes() + _begin; } aoqi@0: int raw_length() { return _end - _begin; } aoqi@0: aoqi@0: // return same as_symbol except allocation of new symbols is avoided. aoqi@0: Symbol* as_symbol_or_null(); aoqi@0: aoqi@0: // count the number of references in the signature aoqi@0: int reference_parameter_count(); aoqi@0: }; aoqi@0: aoqi@0: class SignatureVerifier : public StackObj { aoqi@0: public: aoqi@0: // Returns true if the symbol is valid method or type signature aoqi@0: static bool is_valid_signature(Symbol* sig); aoqi@0: aoqi@0: static bool is_valid_method_signature(Symbol* sig); aoqi@0: static bool is_valid_type_signature(Symbol* sig); aoqi@0: private: aoqi@0: aoqi@0: static ssize_t is_valid_type(const char*, ssize_t); aoqi@0: static bool invalid_name_char(char); aoqi@0: }; aoqi@0: aoqi@0: #endif // SHARE_VM_RUNTIME_SIGNATURE_HPP