1 /*
2 * Copyright (c) 2008, 2015, 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_PRIMS_METHODHANDLES_HPP
26 #define SHARE_VM_PRIMS_METHODHANDLES_HPP
27
28 #include "classfile/javaClasses.hpp"
29 #include "classfile/vmSymbols.hpp"
30 #include "runtime/frame.inline.hpp"
31 #include "runtime/globals.hpp"
32 #include "runtime/interfaceSupport.hpp"
33
34 class MacroAssembler;
35 class Label;
36
37 class MethodHandles: AllStatic {
38 // JVM support for MethodHandle, MethodType, and related types
39 // in java.lang.invoke and sun.invoke.
40 // See also javaClasses for layouts java_lang_invoke_Method{Handle,Type,Type::Form}.
41 public:
42 public:
43 static bool enabled() { return _enabled; }
44 static void set_enabled(bool z);
45
46 private:
47 static bool _enabled;
48
49 // Adapters.
50 static MethodHandlesAdapterBlob* _adapter_code;
51
52 // utility functions for reifying names and types
53 static oop field_name_or_null(Symbol* s);
54 static oop field_signature_type_or_null(Symbol* s);
55
56 public:
57 // working with member names
58 static Handle resolve_MemberName(Handle mname, KlassHandle caller, TRAPS); // compute vmtarget/vmindex from name/type
59 static void expand_MemberName(Handle mname, int suppress, TRAPS); // expand defc/name/type if missing
60 static Handle new_MemberName(TRAPS); // must be followed by init_MemberName
61 static oop init_MemberName(Handle mname_h, Handle target_h); // compute vmtarget/vmindex from target
62 static oop init_field_MemberName(Handle mname_h, fieldDescriptor& fd, bool is_setter = false);
63 static oop init_method_MemberName(Handle mname_h, CallInfo& info);
64 static int method_ref_kind(Method* m, bool do_dispatch_if_possible = true);
65 static int find_MemberNames(KlassHandle k, Symbol* name, Symbol* sig,
66 int mflags, KlassHandle caller,
67 int skip, objArrayHandle results);
68 // bit values for suppress argument to expand_MemberName:
69 enum { _suppress_defc = 1, _suppress_name = 2, _suppress_type = 4 };
70
71 // CallSite support
72 static void add_dependent_nmethod(oop call_site, nmethod* nm);
73 static void remove_dependent_nmethod(oop call_site, nmethod* nm);
74
75 static void flush_dependent_nmethods(Handle call_site, Handle target);
76
77 // Generate MethodHandles adapters.
78 static bool generate_adapters();
79
80 // Called from MethodHandlesAdapterGenerator.
81 static address generate_method_handle_interpreter_entry(MacroAssembler* _masm, vmIntrinsics::ID iid);
82 static void generate_method_handle_dispatch(MacroAssembler* _masm,
83 vmIntrinsics::ID iid,
84 Register receiver_reg,
85 Register member_reg,
86 bool for_compiler_entry);
87
88 // Queries
89 static bool is_signature_polymorphic(vmIntrinsics::ID iid) {
90 return (iid >= vmIntrinsics::FIRST_MH_SIG_POLY &&
91 iid <= vmIntrinsics::LAST_MH_SIG_POLY);
92 }
93
94 static bool is_signature_polymorphic_intrinsic(vmIntrinsics::ID iid) {
95 assert(is_signature_polymorphic(iid), "");
96 // Most sig-poly methods are intrinsics which do not require an
97 // appeal to Java for adapter code.
98 return (iid != vmIntrinsics::_invokeGeneric);
99 }
100
101 static bool is_signature_polymorphic_static(vmIntrinsics::ID iid) {
102 assert(is_signature_polymorphic(iid), "");
103 return (iid >= vmIntrinsics::FIRST_MH_STATIC &&
104 iid <= vmIntrinsics::LAST_MH_SIG_POLY);
105 }
106
107 static bool has_member_arg(vmIntrinsics::ID iid) {
108 assert(is_signature_polymorphic(iid), "");
109 return (iid >= vmIntrinsics::_linkToVirtual &&
110 iid <= vmIntrinsics::_linkToInterface);
111 }
112 static bool has_member_arg(Symbol* klass, Symbol* name) {
113 if ((klass == vmSymbols::java_lang_invoke_MethodHandle()) &&
114 is_signature_polymorphic_name(name)) {
115 vmIntrinsics::ID iid = signature_polymorphic_name_id(name);
116 return has_member_arg(iid);
117 }
118 return false;
119 }
120
121 static Symbol* signature_polymorphic_intrinsic_name(vmIntrinsics::ID iid);
122 static int signature_polymorphic_intrinsic_ref_kind(vmIntrinsics::ID iid);
123
124 static vmIntrinsics::ID signature_polymorphic_name_id(Klass* klass, Symbol* name);
125 static vmIntrinsics::ID signature_polymorphic_name_id(Symbol* name);
126 static bool is_signature_polymorphic_name(Symbol* name) {
127 return signature_polymorphic_name_id(name) != vmIntrinsics::_none;
128 }
129 static bool is_method_handle_invoke_name(Klass* klass, Symbol* name);
130 static bool is_signature_polymorphic_name(Klass* klass, Symbol* name) {
131 return signature_polymorphic_name_id(klass, name) != vmIntrinsics::_none;
132 }
133
134 static int get_named_constant(int which, Handle name_box, TRAPS);
135
136 public:
137 static Symbol* lookup_signature(oop type_str, bool polymorphic, TRAPS); // use TempNewSymbol
138 static Symbol* lookup_basic_type_signature(Symbol* sig, bool keep_last_arg, TRAPS); // use TempNewSymbol
139 static Symbol* lookup_basic_type_signature(Symbol* sig, TRAPS) {
140 return lookup_basic_type_signature(sig, false, THREAD);
141 }
142 static bool is_basic_type_signature(Symbol* sig);
143
144 static Symbol* lookup_method_type(Symbol* msig, Handle mtype, TRAPS);
145
146 static void print_as_method_type_on(outputStream* st, Symbol* sig) {
147 print_as_basic_type_signature_on(st, sig, true, true);
148 }
149 static void print_as_basic_type_signature_on(outputStream* st, Symbol* sig, bool keep_arrays = false, bool keep_basic_names = false);
150
151 // decoding CONSTANT_MethodHandle constants
152 enum { JVM_REF_MIN = JVM_REF_getField, JVM_REF_MAX = JVM_REF_invokeInterface };
153 static bool ref_kind_is_valid(int ref_kind) {
154 return (ref_kind >= JVM_REF_MIN && ref_kind <= JVM_REF_MAX);
155 }
156 static bool ref_kind_is_field(int ref_kind) {
157 assert(ref_kind_is_valid(ref_kind), "");
158 return (ref_kind <= JVM_REF_putStatic);
159 }
160 static bool ref_kind_is_getter(int ref_kind) {
161 assert(ref_kind_is_valid(ref_kind), "");
162 return (ref_kind <= JVM_REF_getStatic);
163 }
164 static bool ref_kind_is_setter(int ref_kind) {
165 return ref_kind_is_field(ref_kind) && !ref_kind_is_getter(ref_kind);
166 }
167 static bool ref_kind_is_method(int ref_kind) {
168 return !ref_kind_is_field(ref_kind) && (ref_kind != JVM_REF_newInvokeSpecial);
169 }
170 static bool ref_kind_has_receiver(int ref_kind) {
171 assert(ref_kind_is_valid(ref_kind), "");
172 return (ref_kind & 1) != 0;
173 }
174 static bool ref_kind_is_static(int ref_kind) {
175 return !ref_kind_has_receiver(ref_kind) && (ref_kind != JVM_REF_newInvokeSpecial);
176 }
177 static bool ref_kind_does_dispatch(int ref_kind) {
178 return (ref_kind == JVM_REF_invokeVirtual ||
179 ref_kind == JVM_REF_invokeInterface);
180 }
181
182
183 #ifdef TARGET_ARCH_x86
184 # include "methodHandles_x86.hpp"
185 #endif
186 #ifdef TARGET_ARCH_sparc
187 # include "methodHandles_sparc.hpp"
188 #endif
189 #ifdef TARGET_ARCH_zero
190 # include "methodHandles_zero.hpp"
191 #endif
192 #ifdef TARGET_ARCH_arm
193 # include "methodHandles_arm.hpp"
194 #endif
195 #ifdef TARGET_ARCH_ppc
196 # include "methodHandles_ppc.hpp"
197 #endif
198 #ifdef TARGET_ARCH_aarch64
199 # include "methodHandles_aarch64.hpp"
200 #endif
201
202 // Tracing
203 static void trace_method_handle(MacroAssembler* _masm, const char* adaptername) PRODUCT_RETURN;
204 static void trace_method_handle_interpreter_entry(MacroAssembler* _masm, vmIntrinsics::ID iid) {
205 if (TraceMethodHandles) {
206 const char* name = vmIntrinsics::name_at(iid);
207 if (*name == '_') name += 1;
208 const size_t len = strlen(name) + 50;
209 char* qname = NEW_C_HEAP_ARRAY(char, len, mtInternal);
210 const char* suffix = "";
211 if (is_signature_polymorphic(iid)) {
212 if (is_signature_polymorphic_static(iid))
213 suffix = "/static";
214 else
215 suffix = "/private";
216 }
217 jio_snprintf(qname, len, "MethodHandle::interpreter_entry::%s%s", name, suffix);
218 trace_method_handle(_masm, qname);
219 // Note: Don't free the allocated char array because it's used
220 // during runtime.
221 }
222 }
223 };
224
225 //------------------------------------------------------------------------------
226 // MethodHandlesAdapterGenerator
227 //
228 class MethodHandlesAdapterGenerator : public StubCodeGenerator {
229 public:
230 MethodHandlesAdapterGenerator(CodeBuffer* code) : StubCodeGenerator(code, PrintMethodHandleStubs) {}
231
232 void generate();
233 };
234
235 //------------------------------------------------------------------------------
236 // MemberNameTable
237 //
238
239 class MemberNameTable : public GrowableArray<jweak> {
240 public:
241 MemberNameTable(int methods_cnt);
242 ~MemberNameTable();
243 void add_member_name(jweak mem_name_ref);
244
245 #if INCLUDE_JVMTI
246 // RedefineClasses() API support:
247 // If a MemberName refers to old_method then update it to refer to new_method.
248 void adjust_method_entries(InstanceKlass* holder, bool * trace_name_printed);
249 #endif // INCLUDE_JVMTI
250 };
251
252 #endif // SHARE_VM_PRIMS_METHODHANDLES_HPP