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