1 /*
   2  * Copyright (c) 1997, 2010, 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_VM_RUNTIME_REFLECTION_HPP
  26 #define SHARE_VM_RUNTIME_REFLECTION_HPP
  27 
  28 #include "oops/oop.hpp"
  29 #include "runtime/fieldDescriptor.hpp"
  30 #include "runtime/reflectionCompat.hpp"
  31 #include "utilities/accessFlags.hpp"
  32 #include "utilities/growableArray.hpp"
  33 
  34 // Class Reflection contains utility methods needed for implementing the
  35 // reflection api.
  36 //
  37 // Used by functions in the JVM interface.
  38 //
  39 // NOTE that in JDK 1.4 most of reflection is now implemented in Java
  40 // using dynamic bytecode generation. The Array class has not yet been
  41 // rewritten using bytecodes; if it were, most of the rest of this
  42 // class could go away, as well as a few more entry points in jvm.cpp.
  43 
  44 class FieldStream;
  45 
  46 class Reflection: public AllStatic {
  47  private:
  48   // Access checking
  49   static bool reflect_check_access(klassOop field_class, AccessFlags acc, klassOop target_class, bool is_method_invoke, TRAPS);
  50 
  51   // Conversion
  52   static klassOop basic_type_mirror_to_arrayklass(oop basic_type_mirror, TRAPS);
  53   static oop      basic_type_arrayklass_to_mirror(klassOop basic_type_arrayklass, TRAPS);
  54 
  55   static objArrayHandle get_parameter_types(methodHandle method, int parameter_count, oop* return_type, TRAPS);
  56   static objArrayHandle get_exception_types(methodHandle method, TRAPS);
  57   // Creating new java.lang.reflect.xxx wrappers
  58   static Handle new_type(symbolHandle signature, KlassHandle k, TRAPS);
  59 
  60  public:
  61   // Constants defined by java reflection api classes
  62   enum SomeConstants {
  63     PUBLIC            = 0,
  64     DECLARED          = 1,
  65     MEMBER_PUBLIC     = 0,
  66     MEMBER_DECLARED   = 1,
  67     MAX_DIM           = 255
  68   };
  69 
  70   // Boxing. Returns boxed value of appropriate type. Throws IllegalArgumentException.
  71   static oop box(jvalue* v, BasicType type, TRAPS);
  72   // Unboxing. Returns type code and sets value.
  73   static BasicType unbox_for_primitive(oop boxed_value, jvalue* value, TRAPS);
  74   static BasicType unbox_for_regular_object(oop boxed_value, jvalue* value);
  75 
  76   // Widening of basic types. Throws IllegalArgumentException.
  77   static void widen(jvalue* value, BasicType current_type, BasicType wide_type, TRAPS);
  78 
  79   // Reflective array access. Returns type code. Throws ArrayIndexOutOfBoundsException.
  80   static BasicType array_get(jvalue* value, arrayOop a, int index, TRAPS);
  81   static void      array_set(jvalue* value, arrayOop a, int index, BasicType value_type, TRAPS);
  82   // Returns mirror on array element type (NULL for basic type arrays and non-arrays).
  83   static oop       array_component_type(oop mirror, TRAPS);
  84 
  85   // Object creation
  86   static arrayOop reflect_new_array(oop element_mirror, jint length, TRAPS);
  87   static arrayOop reflect_new_multi_array(oop element_mirror, typeArrayOop dimensions, TRAPS);
  88 
  89   // Verification
  90   static bool     verify_class_access(klassOop current_class, klassOop new_class, bool classloader_only);
  91 
  92   static bool     verify_field_access(klassOop current_class,
  93                                       klassOop resolved_class,
  94                                       klassOop field_class,
  95                                       AccessFlags access,
  96                                       bool classloader_only,
  97                                       bool protected_restriction = false);
  98   static bool     is_same_class_package(klassOop class1, klassOop class2);
  99   static bool     is_same_package_member(klassOop class1, klassOop class2, TRAPS);
 100 
 101   static bool can_relax_access_check_for(
 102     klassOop accessor, klassOop accesee, bool classloader_only);
 103 
 104   // inner class reflection
 105   // raise an ICCE unless the required relationship can be proven to hold
 106   // If inner_is_member, require the inner to be a member of the outer.
 107   // If !inner_is_member, require the inner to be anonymous (a non-member).
 108   // Caller is responsible for figuring out in advance which case must be true.
 109   static void check_for_inner_class(instanceKlassHandle outer, instanceKlassHandle inner,
 110                                     bool inner_is_member, TRAPS);
 111 
 112   //
 113   // Support for reflection based on dynamic bytecode generation (JDK 1.4)
 114   //
 115 
 116   // Create a java.lang.reflect.Method object based on a method
 117   static oop new_method(methodHandle method, bool intern_name, bool for_constant_pool_access, TRAPS);
 118   // Create a java.lang.reflect.Constructor object based on a method
 119   static oop new_constructor(methodHandle method, TRAPS);
 120   // Create a java.lang.reflect.Field object based on a field descriptor
 121   static oop new_field(fieldDescriptor* fd, bool intern_name, TRAPS);
 122 
 123   //---------------------------------------------------------------------------
 124   //
 125   // Support for old native code-based reflection (pre-JDK 1.4)
 126   //
 127   // NOTE: the method and constructor invocation code is still used
 128   // for startup time reasons; see reflectionCompat.hpp.
 129   //
 130   //---------------------------------------------------------------------------
 131 
 132 #ifdef SUPPORT_OLD_REFLECTION
 133 private:
 134   // method resolution for invoke
 135   static methodHandle resolve_interface_call(instanceKlassHandle klass, methodHandle method, KlassHandle recv_klass, Handle receiver, TRAPS);
 136   // Method call (shared by invoke_method and invoke_constructor)
 137   static oop  invoke(instanceKlassHandle klass, methodHandle method, Handle receiver, bool override, objArrayHandle ptypes, BasicType rtype, objArrayHandle args, bool is_method_invoke, TRAPS);
 138 
 139   // Narrowing of basic types. Used to create correct jvalues for
 140   // boolean, byte, char and short return return values from interpreter
 141   // which are returned as ints. Throws IllegalArgumentException.
 142   static void narrow(jvalue* value, BasicType narrow_type, TRAPS);
 143 
 144   // Conversion
 145   static BasicType basic_type_mirror_to_basic_type(oop basic_type_mirror, TRAPS);
 146 
 147   static bool match_parameter_types(methodHandle method, objArrayHandle types, int parameter_count, TRAPS);
 148   // Creating new java.lang.reflect.xxx wrappers
 149   static oop new_field(FieldStream* st, TRAPS);
 150 
 151 public:
 152   // Field lookup and verification.
 153   static bool      resolve_field(Handle field_mirror, Handle& receiver, fieldDescriptor* fd, bool check_final, TRAPS);
 154 
 155   // Reflective field access. Returns type code. Throws IllegalArgumentException.
 156   static BasicType field_get(jvalue* value, fieldDescriptor* fd, Handle receiver);
 157   static void      field_set(jvalue* value, fieldDescriptor* fd, Handle receiver, BasicType value_type, TRAPS);
 158 
 159   // Reflective lookup of fields. Returns java.lang.reflect.Field instances.
 160   static oop         reflect_field(oop mirror, symbolOop field_name, jint which, TRAPS);
 161   static objArrayOop reflect_fields(oop mirror, jint which, TRAPS);
 162 
 163   // Reflective lookup of methods. Returns java.lang.reflect.Method instances.
 164   static oop         reflect_method(oop mirror, symbolHandle method_name, objArrayHandle types, jint which, TRAPS);
 165   static objArrayOop reflect_methods(oop mirror, jint which, TRAPS);
 166 
 167   // Reflective lookup of constructors. Returns java.lang.reflect.Constructor instances.
 168   static oop         reflect_constructor(oop mirror, objArrayHandle types, jint which, TRAPS);
 169   static objArrayOop reflect_constructors(oop mirror, jint which, TRAPS);
 170 
 171   // Method invokation through java.lang.reflect.Method
 172   static oop      invoke_method(oop method_mirror, Handle receiver, objArrayHandle args, TRAPS);
 173   // Method invokation through java.lang.reflect.Constructor
 174   static oop      invoke_constructor(oop method_mirror, objArrayHandle args, TRAPS);
 175 #endif /* SUPPORT_OLD_REFLECTION */
 176 
 177 };
 178 
 179 #endif // SHARE_VM_RUNTIME_REFLECTION_HPP