duke@435: /*
mikael@6198:  * Copyright (c) 1997, 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: #include "precompiled.hpp"
stefank@2314: #include "classfile/symbolTable.hpp"
stefank@2314: #include "classfile/systemDictionary.hpp"
stefank@2314: #include "memory/oopFactory.hpp"
stefank@2314: #include "oops/instanceKlass.hpp"
stefank@2314: #include "oops/oop.inline.hpp"
coleenp@2497: #include "oops/symbol.hpp"
stefank@2314: #include "oops/typeArrayKlass.hpp"
stefank@2314: #include "runtime/signature.hpp"
duke@435: 
duke@435: 
duke@435: // Implementation of SignatureIterator
duke@435: 
duke@435: // Signature syntax:
duke@435: //
duke@435: // Signature  = "(" {Parameter} ")" ReturnType.
duke@435: // Parameter  = FieldType.
duke@435: // ReturnType = FieldType | "V".
duke@435: // FieldType  = "B" | "C" | "D" | "F" | "I" | "J" | "S" | "Z" | "L" ClassName ";" | "[" FieldType.
duke@435: // ClassName  = string.
duke@435: 
duke@435: 
coleenp@2497: SignatureIterator::SignatureIterator(Symbol* signature) {
duke@435:   _signature       = signature;
duke@435:   _parameter_index = 0;
duke@435: }
duke@435: 
duke@435: void SignatureIterator::expect(char c) {
jcoomes@1845:   if (_signature->byte_at(_index) != c) fatal(err_msg("expecting %c", c));
duke@435:   _index++;
duke@435: }
duke@435: 
duke@435: 
duke@435: void SignatureIterator::skip_optional_size() {
coleenp@2497:   Symbol* sig = _signature;
duke@435:   char c = sig->byte_at(_index);
duke@435:   while ('0' <= c && c <= '9') c = sig->byte_at(++_index);
duke@435: }
duke@435: 
duke@435: 
duke@435: int SignatureIterator::parse_type() {
duke@435:   // Note: This function could be simplified by using "return T_XXX_size;"
duke@435:   //       instead of the assignment and the break statements. However, it
duke@435:   //       seems that the product build for win32_i486 with MS VC++ 6.0 doesn't
duke@435:   //       work (stack underflow for some tests) - this seems to be a VC++ 6.0
duke@435:   //       compiler bug (was problem - gri 4/27/2000).
duke@435:   int size = -1;
duke@435:   switch(_signature->byte_at(_index)) {
duke@435:     case 'B': do_byte  (); if (_parameter_index < 0 ) _return_type = T_BYTE;
duke@435:               _index++; size = T_BYTE_size   ; break;
duke@435:     case 'C': do_char  (); if (_parameter_index < 0 ) _return_type = T_CHAR;
duke@435:               _index++; size = T_CHAR_size   ; break;
duke@435:     case 'D': do_double(); if (_parameter_index < 0 ) _return_type = T_DOUBLE;
duke@435:               _index++; size = T_DOUBLE_size ; break;
duke@435:     case 'F': do_float (); if (_parameter_index < 0 ) _return_type = T_FLOAT;
duke@435:               _index++; size = T_FLOAT_size  ; break;
duke@435:     case 'I': do_int   (); if (_parameter_index < 0 ) _return_type = T_INT;
duke@435:               _index++; size = T_INT_size    ; break;
duke@435:     case 'J': do_long  (); if (_parameter_index < 0 ) _return_type = T_LONG;
duke@435:               _index++; size = T_LONG_size   ; break;
duke@435:     case 'S': do_short (); if (_parameter_index < 0 ) _return_type = T_SHORT;
duke@435:               _index++; size = T_SHORT_size  ; break;
duke@435:     case 'Z': do_bool  (); if (_parameter_index < 0 ) _return_type = T_BOOLEAN;
duke@435:               _index++; size = T_BOOLEAN_size; break;
duke@435:     case 'V': do_void  (); if (_parameter_index < 0 ) _return_type = T_VOID;
duke@435:               _index++; size = T_VOID_size;  ; break;
duke@435:     case 'L':
duke@435:       { int begin = ++_index;
coleenp@2497:         Symbol* sig = _signature;
duke@435:         while (sig->byte_at(_index++) != ';') ;
duke@435:         do_object(begin, _index);
duke@435:       }
duke@435:       if (_parameter_index < 0 ) _return_type = T_OBJECT;
duke@435:       size = T_OBJECT_size;
duke@435:       break;
duke@435:     case '[':
duke@435:       { int begin = ++_index;
duke@435:         skip_optional_size();
coleenp@2497:         Symbol* sig = _signature;
duke@435:         while (sig->byte_at(_index) == '[') {
duke@435:           _index++;
duke@435:           skip_optional_size();
duke@435:         }
duke@435:         if (sig->byte_at(_index) == 'L') {
duke@435:           while (sig->byte_at(_index++) != ';') ;
duke@435:         } else {
duke@435:           _index++;
duke@435:         }
duke@435:         do_array(begin, _index);
duke@435:        if (_parameter_index < 0 ) _return_type = T_ARRAY;
duke@435:       }
duke@435:       size = T_ARRAY_size;
duke@435:       break;
duke@435:     default:
duke@435:       ShouldNotReachHere();
duke@435:       break;
duke@435:   }
duke@435:   assert(size >= 0, "size must be set");
duke@435:   return size;
duke@435: }
duke@435: 
duke@435: 
duke@435: void SignatureIterator::check_signature_end() {
duke@435:   if (_index < _signature->utf8_length()) {
duke@435:     tty->print_cr("too many chars in signature");
duke@435:     _signature->print_value_on(tty);
duke@435:     tty->print_cr(" @ %d", _index);
duke@435:   }
duke@435: }
duke@435: 
duke@435: 
duke@435: void SignatureIterator::dispatch_field() {
duke@435:   // no '(', just one (field) type
duke@435:   _index = 0;
duke@435:   _parameter_index = 0;
duke@435:   parse_type();
duke@435:   check_signature_end();
duke@435: }
duke@435: 
duke@435: 
duke@435: void SignatureIterator::iterate_parameters() {
duke@435:   // Parse parameters
duke@435:   _index = 0;
duke@435:   _parameter_index = 0;
duke@435:   expect('(');
duke@435:   while (_signature->byte_at(_index) != ')') _parameter_index += parse_type();
duke@435:   expect(')');
duke@435:   _parameter_index = 0;
duke@435: }
duke@435: 
duke@435: // Optimized version of iterat_parameters when fingerprint is known
duke@435: void SignatureIterator::iterate_parameters( uint64_t fingerprint ) {
duke@435:   uint64_t saved_fingerprint = fingerprint;
duke@435: 
duke@435:   // Check for too many arguments
duke@435:   if ( fingerprint == UCONST64(-1) ) {
duke@435:     SignatureIterator::iterate_parameters();
duke@435:     return;
duke@435:   }
duke@435: 
duke@435:   assert(fingerprint, "Fingerprint should not be 0");
duke@435: 
duke@435:   _parameter_index = 0;
duke@435:   fingerprint = fingerprint >> (static_feature_size + result_feature_size);
duke@435:   while ( 1 ) {
duke@435:     switch ( fingerprint & parameter_feature_mask ) {
duke@435:       case bool_parm:
duke@435:         do_bool();
duke@435:         _parameter_index += T_BOOLEAN_size;
duke@435:         break;
duke@435:       case byte_parm:
duke@435:         do_byte();
duke@435:         _parameter_index += T_BYTE_size;
duke@435:         break;
duke@435:       case char_parm:
duke@435:         do_char();
duke@435:         _parameter_index += T_CHAR_size;
duke@435:         break;
duke@435:       case short_parm:
duke@435:         do_short();
duke@435:         _parameter_index += T_SHORT_size;
duke@435:         break;
duke@435:       case int_parm:
duke@435:         do_int();
duke@435:         _parameter_index += T_INT_size;
duke@435:         break;
duke@435:       case obj_parm:
duke@435:         do_object(0, 0);
duke@435:         _parameter_index += T_OBJECT_size;
duke@435:         break;
duke@435:       case long_parm:
duke@435:         do_long();
duke@435:         _parameter_index += T_LONG_size;
duke@435:         break;
duke@435:       case float_parm:
duke@435:         do_float();
duke@435:         _parameter_index += T_FLOAT_size;
duke@435:         break;
duke@435:       case double_parm:
duke@435:         do_double();
duke@435:         _parameter_index += T_DOUBLE_size;
duke@435:         break;
duke@435:       case done_parm:
duke@435:         return;
duke@435:         break;
duke@435:       default:
duke@435:         tty->print_cr("*** parameter is %d", fingerprint & parameter_feature_mask);
duke@435:         tty->print_cr("*** fingerprint is " PTR64_FORMAT, saved_fingerprint);
duke@435:         ShouldNotReachHere();
duke@435:         break;
duke@435:     }
duke@435:     fingerprint >>= parameter_feature_size;
duke@435:   }
duke@435:   _parameter_index = 0;
duke@435: }
duke@435: 
duke@435: 
duke@435: void SignatureIterator::iterate_returntype() {
duke@435:   // Ignore parameters
duke@435:   _index = 0;
duke@435:   expect('(');
coleenp@2497:   Symbol* sig = _signature;
duke@435:   while (sig->byte_at(_index) != ')') _index++;
duke@435:   expect(')');
duke@435:   // Parse return type
duke@435:   _parameter_index = -1;
duke@435:   parse_type();
duke@435:   check_signature_end();
duke@435:   _parameter_index = 0;
duke@435: }
duke@435: 
duke@435: 
duke@435: void SignatureIterator::iterate() {
duke@435:   // Parse parameters
duke@435:   _parameter_index = 0;
duke@435:   _index = 0;
duke@435:   expect('(');
duke@435:   while (_signature->byte_at(_index) != ')') _parameter_index += parse_type();
duke@435:   expect(')');
duke@435:   // Parse return type
duke@435:   _parameter_index = -1;
duke@435:   parse_type();
duke@435:   check_signature_end();
duke@435:   _parameter_index = 0;
duke@435: }
duke@435: 
duke@435: 
duke@435: // Implementation of SignatureStream
coleenp@2497: SignatureStream::SignatureStream(Symbol* signature, bool is_method) :
coleenp@2497:                    _signature(signature), _at_return_type(false) {
coleenp@2497:   _begin = _end = (is_method ? 1 : 0);  // skip first '(' in method signatures
coleenp@2497:   _names = new GrowableArray<Symbol*>(10);
coleenp@2497:   next();
coleenp@2497: }
coleenp@2497: 
coleenp@2497: SignatureStream::~SignatureStream() {
coleenp@2497:   // decrement refcount for names created during signature parsing
coleenp@2497:   for (int i = 0; i < _names->length(); i++) {
coleenp@2497:     _names->at(i)->decrement_refcount();
coleenp@2497:   }
coleenp@2497: }
duke@435: 
duke@435: bool SignatureStream::is_done() const {
coleenp@2497:   return _end > _signature->utf8_length();
duke@435: }
duke@435: 
duke@435: 
duke@435: void SignatureStream::next_non_primitive(int t) {
duke@435:   switch (t) {
duke@435:     case 'L': {
duke@435:       _type = T_OBJECT;
coleenp@2497:       Symbol* sig = _signature;
duke@435:       while (sig->byte_at(_end++) != ';');
duke@435:       break;
duke@435:     }
duke@435:     case '[': {
duke@435:       _type = T_ARRAY;
coleenp@2497:       Symbol* sig = _signature;
duke@435:       char c = sig->byte_at(_end);
duke@435:       while ('0' <= c && c <= '9') c = sig->byte_at(_end++);
duke@435:       while (sig->byte_at(_end) == '[') {
duke@435:         _end++;
duke@435:         c = sig->byte_at(_end);
duke@435:         while ('0' <= c && c <= '9') c = sig->byte_at(_end++);
duke@435:       }
duke@435:       switch(sig->byte_at(_end)) {
duke@435:         case 'B':
duke@435:         case 'C':
duke@435:         case 'D':
duke@435:         case 'F':
duke@435:         case 'I':
duke@435:         case 'J':
duke@435:         case 'S':
duke@435:         case 'Z':_end++; break;
duke@435:         default: {
duke@435:           while (sig->byte_at(_end++) != ';');
duke@435:           break;
duke@435:         }
duke@435:       }
duke@435:       break;
duke@435:     }
duke@435:     case ')': _end++; next(); _at_return_type = true; break;
duke@435:     default : ShouldNotReachHere();
duke@435:   }
duke@435: }
duke@435: 
duke@435: 
duke@435: bool SignatureStream::is_object() const {
duke@435:   return _type == T_OBJECT
duke@435:       || _type == T_ARRAY;
duke@435: }
duke@435: 
duke@435: bool SignatureStream::is_array() const {
duke@435:   return _type == T_ARRAY;
duke@435: }
duke@435: 
coleenp@2497: Symbol* SignatureStream::as_symbol(TRAPS) {
duke@435:   // Create a symbol from for string _begin _end
duke@435:   int begin = _begin;
duke@435:   int end   = _end;
duke@435: 
coleenp@2497:   if (   _signature->byte_at(_begin) == 'L'
coleenp@2497:       && _signature->byte_at(_end-1) == ';') {
duke@435:     begin++;
duke@435:     end--;
duke@435:   }
duke@435: 
coleenp@2497:   // Save names for cleaning up reference count at the end of
coleenp@2497:   // SignatureStream scope.
coleenp@2497:   Symbol* name = SymbolTable::new_symbol(_signature, begin, end, CHECK_NULL);
coleenp@2497:   _names->push(name);  // save new symbol for decrementing later
coleenp@2497:   return name;
duke@435: }
duke@435: 
coleenp@4037: Klass* SignatureStream::as_klass(Handle class_loader, Handle protection_domain,
jrose@1863:                                    FailureMode failure_mode, TRAPS) {
jrose@1863:   if (!is_object())  return NULL;
coleenp@2497:   Symbol* name = as_symbol(CHECK_NULL);
jrose@1863:   if (failure_mode == ReturnNull) {
jrose@1863:     return SystemDictionary::resolve_or_null(name, class_loader, protection_domain, THREAD);
jrose@1863:   } else {
jrose@1863:     bool throw_error = (failure_mode == NCDFError);
jrose@1863:     return SystemDictionary::resolve_or_fail(name, class_loader, protection_domain, throw_error, THREAD);
jrose@1863:   }
jrose@1863: }
jrose@1863: 
jrose@1863: oop SignatureStream::as_java_mirror(Handle class_loader, Handle protection_domain,
jrose@1863:                                     FailureMode failure_mode, TRAPS) {
jrose@1863:   if (!is_object())
jrose@1863:     return Universe::java_mirror(type());
coleenp@4037:   Klass* klass = as_klass(class_loader, protection_domain, failure_mode, CHECK_NULL);
jrose@1863:   if (klass == NULL)  return NULL;
hseigel@4278:   return klass->java_mirror();
jrose@1863: }
duke@435: 
coleenp@2497: Symbol* SignatureStream::as_symbol_or_null() {
duke@435:   // Create a symbol from for string _begin _end
duke@435:   ResourceMark rm;
duke@435: 
duke@435:   int begin = _begin;
duke@435:   int end   = _end;
duke@435: 
coleenp@2497:   if (   _signature->byte_at(_begin) == 'L'
coleenp@2497:       && _signature->byte_at(_end-1) == ';') {
duke@435:     begin++;
duke@435:     end--;
duke@435:   }
duke@435: 
duke@435:   char* buffer = NEW_RESOURCE_ARRAY(char, end - begin);
duke@435:   for (int index = begin; index < end; index++) {
coleenp@2497:     buffer[index - begin] = _signature->byte_at(index);
duke@435:   }
coleenp@2497:   Symbol* result = SymbolTable::probe(buffer, end - begin);
duke@435:   return result;
duke@435: }
duke@435: 
roland@5914: int SignatureStream::reference_parameter_count() {
roland@5914:   int args_count = 0;
roland@5914:   for ( ; !at_return_type(); next()) {
roland@5914:     if (is_object()) {
roland@5914:       args_count++;
roland@5914:     }
roland@5914:   }
roland@5914:   return args_count;
roland@5914: }
roland@5914: 
coleenp@2497: bool SignatureVerifier::is_valid_signature(Symbol* sig) {
duke@435:   const char* signature = (const char*)sig->bytes();
duke@435:   ssize_t len = sig->utf8_length();
duke@435:   if (signature == NULL || signature[0] == '\0' || len < 1) {
duke@435:     return false;
duke@435:   } else if (signature[0] == '(') {
duke@435:     return is_valid_method_signature(sig);
duke@435:   } else {
duke@435:     return is_valid_type_signature(sig);
duke@435:   }
duke@435: }
duke@435: 
coleenp@2497: bool SignatureVerifier::is_valid_method_signature(Symbol* sig) {
duke@435:   const char* method_sig = (const char*)sig->bytes();
duke@435:   ssize_t len = sig->utf8_length();
duke@435:   ssize_t index = 0;
duke@435:   if (method_sig != NULL && len > 1 && method_sig[index] == '(') {
duke@435:     ++index;
duke@435:     while (index < len && method_sig[index] != ')') {
duke@435:       ssize_t res = is_valid_type(&method_sig[index], len - index);
duke@435:       if (res == -1) {
duke@435:         return false;
duke@435:       } else {
duke@435:         index += res;
duke@435:       }
duke@435:     }
duke@435:     if (index < len && method_sig[index] == ')') {
duke@435:       // check the return type
duke@435:       ++index;
duke@435:       return (is_valid_type(&method_sig[index], len - index) == (len - index));
duke@435:     }
duke@435:   }
duke@435:   return false;
duke@435: }
duke@435: 
coleenp@2497: bool SignatureVerifier::is_valid_type_signature(Symbol* sig) {
duke@435:   const char* type_sig = (const char*)sig->bytes();
duke@435:   ssize_t len = sig->utf8_length();
duke@435:   return (type_sig != NULL && len >= 1 &&
duke@435:           (is_valid_type(type_sig, len) == len));
duke@435: }
duke@435: 
duke@435: // Checks to see if the type (not to go beyond 'limit') refers to a valid type.
duke@435: // Returns -1 if it is not, or the index of the next character that is not part
duke@435: // of the type.  The type encoding may end before 'limit' and that's ok.
duke@435: ssize_t SignatureVerifier::is_valid_type(const char* type, ssize_t limit) {
duke@435:   ssize_t index = 0;
duke@435: 
duke@435:   // Iterate over any number of array dimensions
duke@435:   while (index < limit && type[index] == '[') ++index;
duke@435:   if (index >= limit) {
duke@435:     return -1;
duke@435:   }
duke@435:   switch (type[index]) {
duke@435:     case 'B': case 'C': case 'D': case 'F': case 'I':
duke@435:     case 'J': case 'S': case 'Z': case 'V':
duke@435:       return index + 1;
duke@435:     case 'L':
duke@435:       for (index = index + 1; index < limit; ++index) {
duke@435:         char c = type[index];
duke@435:         if (c == ';') {
duke@435:           return index + 1;
duke@435:         }
duke@435:         if (invalid_name_char(c)) {
duke@435:           return -1;
duke@435:         }
duke@435:       }
duke@435:       // fall through
duke@435:     default: ; // fall through
duke@435:   }
duke@435:   return -1;
duke@435: }
duke@435: 
duke@435: bool SignatureVerifier::invalid_name_char(char c) {
duke@435:   switch (c) {
duke@435:     case '\0': case '.': case ';': case '[':
duke@435:       return true;
duke@435:     default:
duke@435:       return false;
duke@435:   }
duke@435: }