1 /*
2 * Copyright (c) 2008, 2017, 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 #include "utilities/macros.hpp"
34
35 #ifdef ZERO
36 # include "entry_zero.hpp"
37 #endif
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, Klass* 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 oop init_MemberName(Handle mname_h, Handle target_h, TRAPS); // compute vmtarget/vmindex from target
67 static oop init_field_MemberName(Handle mname_h, fieldDescriptor& fd, bool is_setter = false);
68 static oop init_method_MemberName(Handle mname_h, CallInfo& info);
69 static int method_ref_kind(Method* m, bool do_dispatch_if_possible = true);
70 static int find_MemberNames(Klass* k, Symbol* name, Symbol* sig,
71 int mflags, Klass* caller,
72 int skip, objArrayHandle results, TRAPS);
73 // bit values for suppress argument to expand_MemberName:
74 enum { _suppress_defc = 1, _suppress_name = 2, _suppress_type = 4 };
75
76 // CallSite support
77 static void add_dependent_nmethod(oop call_site, nmethod* nm);
78 static void remove_dependent_nmethod(oop call_site, nmethod* nm);
79
80 static void flush_dependent_nmethods(Handle call_site, Handle target);
81
82 // Generate MethodHandles adapters.
83 static void generate_adapters();
84
85 // Called from MethodHandlesAdapterGenerator.
86 static address generate_method_handle_interpreter_entry(MacroAssembler* _masm, vmIntrinsics::ID iid);
87 static void generate_method_handle_dispatch(MacroAssembler* _masm,
88 vmIntrinsics::ID iid,
89 Register receiver_reg,
90 Register member_reg,
91 bool for_compiler_entry);
92
93 // Queries
94 static bool is_signature_polymorphic(vmIntrinsics::ID iid) {
95 return (iid >= vmIntrinsics::FIRST_MH_SIG_POLY &&
96 iid <= vmIntrinsics::LAST_MH_SIG_POLY);
97 }
98
99 static bool is_signature_polymorphic_method(Method* m) {
100 return is_signature_polymorphic(m->intrinsic_id());
101 }
102
103 static bool is_signature_polymorphic_intrinsic(vmIntrinsics::ID iid) {
104 assert(is_signature_polymorphic(iid), "");
105 // Most sig-poly methods are intrinsics which do not require an
106 // appeal to Java for adapter code.
107 return (iid != vmIntrinsics::_invokeGeneric);
108 }
109
110 static bool is_signature_polymorphic_static(vmIntrinsics::ID iid) {
111 assert(is_signature_polymorphic(iid), "");
112 return (iid >= vmIntrinsics::FIRST_MH_STATIC &&
113 iid <= vmIntrinsics::LAST_MH_SIG_POLY);
114 }
115
116 static bool has_member_arg(vmIntrinsics::ID iid) {
117 assert(is_signature_polymorphic(iid), "");
118 return (iid >= vmIntrinsics::_linkToVirtual &&
119 iid <= vmIntrinsics::_linkToInterface);
120 }
121 static bool has_member_arg(Symbol* klass, Symbol* name) {
122 if ((klass == vmSymbols::java_lang_invoke_MethodHandle() ||
123 klass == vmSymbols::java_lang_invoke_VarHandle()) &&
124 is_signature_polymorphic_name(name)) {
125 vmIntrinsics::ID iid = signature_polymorphic_name_id(name);
126 return has_member_arg(iid);
127 }
128 return false;
129 }
130
131 static Symbol* signature_polymorphic_intrinsic_name(vmIntrinsics::ID iid);
132 static int signature_polymorphic_intrinsic_ref_kind(vmIntrinsics::ID iid);
133
134 static vmIntrinsics::ID signature_polymorphic_name_id(Klass* klass, Symbol* name);
135 static vmIntrinsics::ID signature_polymorphic_name_id(Symbol* name);
136 static bool is_signature_polymorphic_name(Symbol* name) {
137 return signature_polymorphic_name_id(name) != vmIntrinsics::_none;
138 }
139 static bool is_method_handle_invoke_name(Klass* klass, Symbol* name);
140 static bool is_signature_polymorphic_name(Klass* klass, Symbol* name) {
141 return signature_polymorphic_name_id(klass, name) != vmIntrinsics::_none;
142 }
143
144 static Bytecodes::Code signature_polymorphic_intrinsic_bytecode(vmIntrinsics::ID id);
145
146 static int get_named_constant(int which, Handle name_box, TRAPS);
147
148 public:
149 static Symbol* lookup_signature(oop type_str, bool polymorphic, TRAPS); // use TempNewSymbol
150 static Symbol* lookup_basic_type_signature(Symbol* sig, bool keep_last_arg, TRAPS); // use TempNewSymbol
151 static Symbol* lookup_basic_type_signature(Symbol* sig, TRAPS) {
152 return lookup_basic_type_signature(sig, false, THREAD);
153 }
154 static bool is_basic_type_signature(Symbol* sig);
155
156 static Symbol* lookup_method_type(Symbol* msig, Handle mtype, TRAPS);
157
158 static void print_as_method_type_on(outputStream* st, Symbol* sig) {
159 print_as_basic_type_signature_on(st, sig, true, true);
160 }
161 static void print_as_basic_type_signature_on(outputStream* st, Symbol* sig, bool keep_arrays = false, bool keep_basic_names = false);
162
163 // decoding CONSTANT_MethodHandle constants
164 enum { JVM_REF_MIN = JVM_REF_getField, JVM_REF_MAX = JVM_REF_invokeInterface };
165 static bool ref_kind_is_valid(int ref_kind) {
166 return (ref_kind >= JVM_REF_MIN && ref_kind <= JVM_REF_MAX);
167 }
168 static bool ref_kind_is_field(int ref_kind) {
169 assert(ref_kind_is_valid(ref_kind), "");
170 return (ref_kind <= JVM_REF_putStatic);
171 }
172 static bool ref_kind_is_getter(int ref_kind) {
173 assert(ref_kind_is_valid(ref_kind), "");
174 return (ref_kind <= JVM_REF_getStatic);
175 }
176 static bool ref_kind_is_setter(int ref_kind) {
177 return ref_kind_is_field(ref_kind) && !ref_kind_is_getter(ref_kind);
178 }
179 static bool ref_kind_is_method(int ref_kind) {
180 return !ref_kind_is_field(ref_kind) && (ref_kind != JVM_REF_newInvokeSpecial);
181 }
182 static bool ref_kind_has_receiver(int ref_kind) {
183 assert(ref_kind_is_valid(ref_kind), "");
184 return (ref_kind & 1) != 0;
185 }
186 static bool ref_kind_is_static(int ref_kind) {
187 return !ref_kind_has_receiver(ref_kind) && (ref_kind != JVM_REF_newInvokeSpecial);
188 }
189 static bool ref_kind_does_dispatch(int ref_kind) {
190 return (ref_kind == JVM_REF_invokeVirtual ||
191 ref_kind == JVM_REF_invokeInterface);
192 }
193
194 #include CPU_HEADER(methodHandles)
195
196 // Tracing
197 static void trace_method_handle(MacroAssembler* _masm, const char* adaptername) PRODUCT_RETURN;
198 static void trace_method_handle_interpreter_entry(MacroAssembler* _masm, vmIntrinsics::ID iid) {
199 if (TraceMethodHandles) {
200 const char* name = vmIntrinsics::name_at(iid);
201 if (*name == '_') name += 1;
202 const size_t len = strlen(name) + 50;
203 char* qname = NEW_C_HEAP_ARRAY(char, len, mtInternal);
204 const char* suffix = "";
205 if (is_signature_polymorphic(iid)) {
206 if (is_signature_polymorphic_static(iid))
207 suffix = "/static";
208 else
209 suffix = "/private";
210 }
211 jio_snprintf(qname, len, "MethodHandle::interpreter_entry::%s%s", name, suffix);
212 trace_method_handle(_masm, qname);
213 // Note: Don't free the allocated char array because it's used
214 // during runtime.
215 }
216 }
217 };
218
219 //------------------------------------------------------------------------------
220 // MethodHandlesAdapterGenerator
221 //
222 class MethodHandlesAdapterGenerator : public StubCodeGenerator {
223 public:
224 MethodHandlesAdapterGenerator(CodeBuffer* code) : StubCodeGenerator(code, PrintMethodHandleStubs) {}
225
226 void generate();
227 };
228
229 #endif // SHARE_VM_PRIMS_METHODHANDLES_HPP