duke@435: /* coleenp@4037: * Copyright (c) 1997, 2012, 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_RUNTIME_SIGNATURE_HPP stefank@2314: #define SHARE_VM_RUNTIME_SIGNATURE_HPP stefank@2314: stefank@2314: #include "memory/allocation.hpp" coleenp@4037: #include "oops/method.hpp" stefank@2314: #include "utilities/top.hpp" stefank@2314: duke@435: // SignatureIterators iterate over a Java signature (or parts of it). duke@435: // (Syntax according to: "The Java Virtual Machine Specification" by duke@435: // Tim Lindholm & Frank Yellin; section 4.3 Descriptors; p. 89ff.) duke@435: // duke@435: // Example: Iterating over ([Lfoo;D)I using duke@435: // 0123456789 duke@435: // duke@435: // iterate_parameters() calls: do_array(2, 7); do_double(); duke@435: // iterate_returntype() calls: do_int(); duke@435: // iterate() calls: do_array(2, 7); do_double(); do_int(); duke@435: // duke@435: // is_return_type() is: false ; false ; true duke@435: // duke@435: // NOTE: The new optimizer has an alternate, for-loop based signature duke@435: // iterator implemented in opto/type.cpp, TypeTuple::make(). duke@435: duke@435: class SignatureIterator: public ResourceObj { duke@435: protected: coleenp@2497: Symbol* _signature; // the signature to iterate over duke@435: int _index; // the current character index (only valid during iteration) duke@435: int _parameter_index; // the current parameter index (0 outside iteration phase) duke@435: BasicType _return_type; duke@435: duke@435: void expect(char c); duke@435: void skip_optional_size(); duke@435: int parse_type(); // returns the parameter size in words (0 for void) duke@435: void check_signature_end(); duke@435: duke@435: public: duke@435: // Definitions used in generating and iterating the duke@435: // bit field form of the signature generated by the duke@435: // Fingerprinter. duke@435: enum { duke@435: static_feature_size = 1, duke@435: result_feature_size = 4, duke@435: result_feature_mask = 0xF, duke@435: parameter_feature_size = 4, duke@435: parameter_feature_mask = 0xF, duke@435: duke@435: bool_parm = 1, duke@435: byte_parm = 2, duke@435: char_parm = 3, duke@435: short_parm = 4, duke@435: int_parm = 5, duke@435: long_parm = 6, duke@435: float_parm = 7, duke@435: double_parm = 8, duke@435: obj_parm = 9, duke@435: done_parm = 10, // marker for end of parameters duke@435: duke@435: // max parameters is wordsize minus duke@435: // The sign bit, termination field, the result and static bit fields duke@435: max_size_of_parameters = (BitsPerLong-1 - duke@435: result_feature_size - parameter_feature_size - duke@435: static_feature_size) / parameter_feature_size duke@435: }; duke@435: duke@435: // Constructors coleenp@2497: SignatureIterator(Symbol* signature); duke@435: duke@435: // Iteration duke@435: void dispatch_field(); // dispatches once for field signatures duke@435: void iterate_parameters(); // iterates over parameters only duke@435: void iterate_parameters( uint64_t fingerprint ); duke@435: void iterate_returntype(); // iterates over returntype only duke@435: void iterate(); // iterates over whole signature duke@435: // Returns the word index of the current parameter; duke@435: int parameter_index() const { return _parameter_index; } duke@435: bool is_return_type() const { return parameter_index() < 0; } duke@435: BasicType get_ret_type() const { return _return_type; } duke@435: duke@435: // Basic types duke@435: virtual void do_bool () = 0; duke@435: virtual void do_char () = 0; duke@435: virtual void do_float () = 0; duke@435: virtual void do_double() = 0; duke@435: virtual void do_byte () = 0; duke@435: virtual void do_short () = 0; duke@435: virtual void do_int () = 0; duke@435: virtual void do_long () = 0; duke@435: virtual void do_void () = 0; duke@435: duke@435: // Object types (begin indexes the first character of the entry, end indexes the first character after the entry) duke@435: virtual void do_object(int begin, int end) = 0; duke@435: virtual void do_array (int begin, int end) = 0; duke@435: }; duke@435: duke@435: duke@435: // Specialized SignatureIterators: Used to compute signature specific values. duke@435: duke@435: class SignatureTypeNames : public SignatureIterator { duke@435: protected: duke@435: virtual void type_name(const char* name) = 0; duke@435: duke@435: void do_bool() { type_name("jboolean"); } duke@435: void do_char() { type_name("jchar" ); } duke@435: void do_float() { type_name("jfloat" ); } duke@435: void do_double() { type_name("jdouble" ); } duke@435: void do_byte() { type_name("jbyte" ); } duke@435: void do_short() { type_name("jshort" ); } duke@435: void do_int() { type_name("jint" ); } duke@435: void do_long() { type_name("jlong" ); } duke@435: void do_void() { type_name("void" ); } duke@435: void do_object(int begin, int end) { type_name("jobject" ); } duke@435: void do_array (int begin, int end) { type_name("jobject" ); } duke@435: duke@435: public: coleenp@2497: SignatureTypeNames(Symbol* signature) : SignatureIterator(signature) {} duke@435: }; duke@435: duke@435: duke@435: class SignatureInfo: public SignatureIterator { duke@435: protected: duke@435: bool _has_iterated; // need this because iterate cannot be called in constructor (set is virtual!) duke@435: bool _has_iterated_return; duke@435: int _size; duke@435: duke@435: void lazy_iterate_parameters() { if (!_has_iterated) { iterate_parameters(); _has_iterated = true; } } duke@435: void lazy_iterate_return() { if (!_has_iterated_return) { iterate_returntype(); _has_iterated_return = true; } } duke@435: duke@435: virtual void set(int size, BasicType type) = 0; duke@435: duke@435: void do_bool () { set(T_BOOLEAN_size, T_BOOLEAN); } duke@435: void do_char () { set(T_CHAR_size , T_CHAR ); } duke@435: void do_float () { set(T_FLOAT_size , T_FLOAT ); } duke@435: void do_double() { set(T_DOUBLE_size , T_DOUBLE ); } duke@435: void do_byte () { set(T_BYTE_size , T_BYTE ); } duke@435: void do_short () { set(T_SHORT_size , T_SHORT ); } duke@435: void do_int () { set(T_INT_size , T_INT ); } duke@435: void do_long () { set(T_LONG_size , T_LONG ); } duke@435: void do_void () { set(T_VOID_size , T_VOID ); } duke@435: void do_object(int begin, int end) { set(T_OBJECT_size , T_OBJECT ); } duke@435: void do_array (int begin, int end) { set(T_ARRAY_size , T_ARRAY ); } duke@435: duke@435: public: coleenp@2497: SignatureInfo(Symbol* signature) : SignatureIterator(signature) { duke@435: _has_iterated = _has_iterated_return = false; duke@435: _size = 0; duke@435: _return_type = T_ILLEGAL; duke@435: } duke@435: duke@435: }; duke@435: duke@435: duke@435: // Specialized SignatureIterator: Used to compute the argument size. duke@435: duke@435: class ArgumentSizeComputer: public SignatureInfo { duke@435: private: duke@435: void set(int size, BasicType type) { _size += size; } duke@435: public: coleenp@2497: ArgumentSizeComputer(Symbol* signature) : SignatureInfo(signature) {} duke@435: duke@435: int size() { lazy_iterate_parameters(); return _size; } duke@435: }; duke@435: duke@435: duke@435: class ArgumentCount: public SignatureInfo { duke@435: private: duke@435: void set(int size, BasicType type) { _size ++; } duke@435: public: coleenp@2497: ArgumentCount(Symbol* signature) : SignatureInfo(signature) {} duke@435: duke@435: int size() { lazy_iterate_parameters(); return _size; } duke@435: }; duke@435: duke@435: duke@435: // Specialized SignatureIterator: Used to compute the result type. duke@435: duke@435: class ResultTypeFinder: public SignatureInfo { duke@435: private: duke@435: void set(int size, BasicType type) { _return_type = type; } duke@435: public: duke@435: BasicType type() { lazy_iterate_return(); return _return_type; } duke@435: coleenp@2497: ResultTypeFinder(Symbol* signature) : SignatureInfo(signature) {} duke@435: }; duke@435: duke@435: duke@435: // Fingerprinter computes a unique ID for a given method. The ID duke@435: // is a bitvector characterizing the methods signature (incl. the receiver). duke@435: class Fingerprinter: public SignatureIterator { duke@435: private: duke@435: uint64_t _fingerprint; duke@435: int _shift_count; duke@435: methodHandle mh; duke@435: duke@435: public: duke@435: duke@435: void do_bool() { _fingerprint |= (((uint64_t)bool_parm) << _shift_count); _shift_count += parameter_feature_size; } duke@435: void do_char() { _fingerprint |= (((uint64_t)char_parm) << _shift_count); _shift_count += parameter_feature_size; } duke@435: void do_byte() { _fingerprint |= (((uint64_t)byte_parm) << _shift_count); _shift_count += parameter_feature_size; } duke@435: void do_short() { _fingerprint |= (((uint64_t)short_parm) << _shift_count); _shift_count += parameter_feature_size; } duke@435: void do_int() { _fingerprint |= (((uint64_t)int_parm) << _shift_count); _shift_count += parameter_feature_size; } duke@435: void do_long() { _fingerprint |= (((uint64_t)long_parm) << _shift_count); _shift_count += parameter_feature_size; } duke@435: void do_float() { _fingerprint |= (((uint64_t)float_parm) << _shift_count); _shift_count += parameter_feature_size; } duke@435: void do_double() { _fingerprint |= (((uint64_t)double_parm) << _shift_count); _shift_count += parameter_feature_size; } duke@435: duke@435: void do_object(int begin, int end) { _fingerprint |= (((uint64_t)obj_parm) << _shift_count); _shift_count += parameter_feature_size; } duke@435: void do_array (int begin, int end) { _fingerprint |= (((uint64_t)obj_parm) << _shift_count); _shift_count += parameter_feature_size; } duke@435: duke@435: void do_void() { ShouldNotReachHere(); } duke@435: duke@435: Fingerprinter(methodHandle method) : SignatureIterator(method->signature()) { duke@435: mh = method; duke@435: _fingerprint = 0; duke@435: } duke@435: duke@435: uint64_t fingerprint() { duke@435: // See if we fingerprinted this method already duke@435: if (mh->constMethod()->fingerprint() != CONST64(0)) { duke@435: return mh->constMethod()->fingerprint(); duke@435: } duke@435: duke@435: if (mh->size_of_parameters() > max_size_of_parameters ) { duke@435: _fingerprint = UCONST64(-1); duke@435: mh->constMethod()->set_fingerprint(_fingerprint); duke@435: return _fingerprint; duke@435: } duke@435: duke@435: assert( (int)mh->result_type() <= (int)result_feature_mask, "bad result type"); duke@435: _fingerprint = mh->result_type(); duke@435: _fingerprint <<= static_feature_size; duke@435: if (mh->is_static()) _fingerprint |= 1; duke@435: _shift_count = result_feature_size + static_feature_size; duke@435: iterate_parameters(); duke@435: _fingerprint |= ((uint64_t)done_parm) << _shift_count;// mark end of sig duke@435: mh->constMethod()->set_fingerprint(_fingerprint); duke@435: return _fingerprint; duke@435: } duke@435: }; duke@435: duke@435: duke@435: // Specialized SignatureIterator: Used for native call purposes duke@435: duke@435: class NativeSignatureIterator: public SignatureIterator { duke@435: private: duke@435: methodHandle _method; twisti@1040: // We need separate JNI and Java offset values because in 64 bit mode, duke@435: // the argument offsets are not in sync with the Java stack. duke@435: // For example a long takes up 1 "C" stack entry but 2 Java stack entries. duke@435: int _offset; // The java stack offset duke@435: int _prepended; // number of prepended JNI parameters (1 JNIEnv, plus 1 mirror if static) duke@435: int _jni_offset; // the current parameter offset, starting with 0 duke@435: duke@435: void do_bool () { pass_int(); _jni_offset++; _offset++; } duke@435: void do_char () { pass_int(); _jni_offset++; _offset++; } never@1445: void do_float () { pass_float(); _jni_offset++; _offset++; } duke@435: #ifdef _LP64 duke@435: void do_double() { pass_double(); _jni_offset++; _offset += 2; } duke@435: #else duke@435: void do_double() { pass_double(); _jni_offset += 2; _offset += 2; } duke@435: #endif duke@435: void do_byte () { pass_int(); _jni_offset++; _offset++; } duke@435: void do_short () { pass_int(); _jni_offset++; _offset++; } duke@435: void do_int () { pass_int(); _jni_offset++; _offset++; } duke@435: #ifdef _LP64 duke@435: void do_long () { pass_long(); _jni_offset++; _offset += 2; } duke@435: #else duke@435: void do_long () { pass_long(); _jni_offset += 2; _offset += 2; } duke@435: #endif duke@435: void do_void () { ShouldNotReachHere(); } duke@435: void do_object(int begin, int end) { pass_object(); _jni_offset++; _offset++; } duke@435: void do_array (int begin, int end) { pass_object(); _jni_offset++; _offset++; } duke@435: duke@435: public: duke@435: methodHandle method() const { return _method; } duke@435: int offset() const { return _offset; } duke@435: int jni_offset() const { return _jni_offset + _prepended; } duke@435: // int java_offset() const { return method()->size_of_parameters() - _offset - 1; } duke@435: bool is_static() const { return method()->is_static(); } duke@435: virtual void pass_int() = 0; duke@435: virtual void pass_long() = 0; duke@435: virtual void pass_object() = 0; never@1445: virtual void pass_float() = 0; duke@435: #ifdef _LP64 duke@435: virtual void pass_double() = 0; duke@435: #else duke@435: virtual void pass_double() { pass_long(); } // may be same as long duke@435: #endif duke@435: duke@435: NativeSignatureIterator(methodHandle method) : SignatureIterator(method->signature()) { duke@435: _method = method; duke@435: _offset = 0; duke@435: _jni_offset = 0; duke@435: duke@435: const int JNIEnv_words = 1; duke@435: const int mirror_words = 1; duke@435: _prepended = !is_static() ? JNIEnv_words : JNIEnv_words + mirror_words; duke@435: } duke@435: duke@435: // iterate() calles the 2 virtual methods according to the following invocation syntax: duke@435: // duke@435: // {pass_int | pass_long | pass_object} duke@435: // duke@435: // Arguments are handled from left to right (receiver first, if any). duke@435: // The offset() values refer to the Java stack offsets but are 0 based and increasing. duke@435: // The java_offset() values count down to 0, and refer to the Java TOS. duke@435: // The jni_offset() values increase from 1 or 2, and refer to C arguments. duke@435: duke@435: void iterate() { iterate(Fingerprinter(method()).fingerprint()); duke@435: } duke@435: duke@435: duke@435: // Optimized path if we have the bitvector form of signature duke@435: void iterate( uint64_t fingerprint ) { duke@435: duke@435: if (!is_static()) { duke@435: // handle receiver (not handled by iterate because not in signature) duke@435: pass_object(); _jni_offset++; _offset++; duke@435: } duke@435: duke@435: SignatureIterator::iterate_parameters( fingerprint ); duke@435: } duke@435: }; duke@435: duke@435: duke@435: // Handy stream for iterating over signature duke@435: duke@435: class SignatureStream : public StackObj { duke@435: private: coleenp@2497: Symbol* _signature; duke@435: int _begin; duke@435: int _end; duke@435: BasicType _type; duke@435: bool _at_return_type; coleenp@2497: GrowableArray* _names; // symbols created while parsing signature duke@435: duke@435: public: duke@435: bool at_return_type() const { return _at_return_type; } duke@435: bool is_done() const; duke@435: void next_non_primitive(int t); duke@435: void next() { coleenp@2497: Symbol* sig = _signature; duke@435: int len = sig->utf8_length(); duke@435: if (_end >= len) { duke@435: _end = len + 1; duke@435: return; duke@435: } duke@435: duke@435: _begin = _end; duke@435: int t = sig->byte_at(_begin); duke@435: switch (t) { duke@435: case 'B': _type = T_BYTE; break; duke@435: case 'C': _type = T_CHAR; break; duke@435: case 'D': _type = T_DOUBLE; break; duke@435: case 'F': _type = T_FLOAT; break; duke@435: case 'I': _type = T_INT; break; duke@435: case 'J': _type = T_LONG; break; duke@435: case 'S': _type = T_SHORT; break; duke@435: case 'Z': _type = T_BOOLEAN; break; duke@435: case 'V': _type = T_VOID; break; duke@435: default : next_non_primitive(t); duke@435: return; duke@435: } duke@435: _end++; duke@435: } duke@435: coleenp@2497: SignatureStream(Symbol* signature, bool is_method = true); coleenp@2497: ~SignatureStream(); duke@435: duke@435: bool is_object() const; // True if this argument is an object duke@435: bool is_array() const; // True if this argument is an array duke@435: BasicType type() const { return _type; } coleenp@2497: Symbol* as_symbol(TRAPS); jrose@1863: enum FailureMode { ReturnNull, CNFException, NCDFError }; coleenp@4037: Klass* as_klass(Handle class_loader, Handle protection_domain, FailureMode failure_mode, TRAPS); jrose@1863: oop as_java_mirror(Handle class_loader, Handle protection_domain, FailureMode failure_mode, TRAPS); twisti@3969: const jbyte* raw_bytes() { return _signature->bytes() + _begin; } twisti@3969: int raw_length() { return _end - _begin; } duke@435: duke@435: // return same as_symbol except allocation of new symbols is avoided. coleenp@2497: Symbol* as_symbol_or_null(); duke@435: }; duke@435: duke@435: class SignatureVerifier : public StackObj { duke@435: public: duke@435: // Returns true if the symbol is valid method or type signature coleenp@2497: static bool is_valid_signature(Symbol* sig); duke@435: coleenp@2497: static bool is_valid_method_signature(Symbol* sig); coleenp@2497: static bool is_valid_type_signature(Symbol* sig); duke@435: private: duke@435: duke@435: static ssize_t is_valid_type(const char*, ssize_t); duke@435: static bool invalid_name_char(char); duke@435: }; stefank@2314: stefank@2314: #endif // SHARE_VM_RUNTIME_SIGNATURE_HPP