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 #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);
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 bool 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_intrinsic(vmIntrinsics::ID iid) {
101 assert(is_signature_polymorphic(iid), "");
102 // Most sig-poly methods are intrinsics which do not require an
103 // appeal to Java for adapter code.
104 return (iid != vmIntrinsics::_invokeGeneric);
105 }
106
107 static bool is_signature_polymorphic_static(vmIntrinsics::ID iid) {
108 assert(is_signature_polymorphic(iid), "");
109 return (iid >= vmIntrinsics::FIRST_MH_STATIC &&
110 iid <= vmIntrinsics::LAST_MH_SIG_POLY);
111 }
112
113 static bool has_member_arg(vmIntrinsics::ID iid) {
114 assert(is_signature_polymorphic(iid), "");
115 return (iid >= vmIntrinsics::_linkToVirtual &&
116 iid <= vmIntrinsics::_linkToInterface);
117 }
118 static bool has_member_arg(Symbol* klass, Symbol* name) {
119 if ((klass == vmSymbols::java_lang_invoke_MethodHandle()) &&
120 is_signature_polymorphic_name(name)) {
121 vmIntrinsics::ID iid = signature_polymorphic_name_id(name);
122 return has_member_arg(iid);
123 }
124 return false;
125 }
126
127 static Symbol* signature_polymorphic_intrinsic_name(vmIntrinsics::ID iid);
128 static int signature_polymorphic_intrinsic_ref_kind(vmIntrinsics::ID iid);
129
130 static vmIntrinsics::ID signature_polymorphic_name_id(Klass* klass, Symbol* name);
131 static vmIntrinsics::ID signature_polymorphic_name_id(Symbol* name);
132 static bool is_signature_polymorphic_name(Symbol* name) {
133 return signature_polymorphic_name_id(name) != vmIntrinsics::_none;
134 }
135 static bool is_method_handle_invoke_name(Klass* klass, Symbol* name);
136 static bool is_signature_polymorphic_name(Klass* klass, Symbol* name) {
137 return signature_polymorphic_name_id(klass, name) != vmIntrinsics::_none;
138 }
139
140 static int get_named_constant(int which, Handle name_box, TRAPS);
141
142 public:
143 static Symbol* lookup_signature(oop type_str, bool polymorphic, TRAPS); // use TempNewSymbol
144 static Symbol* lookup_basic_type_signature(Symbol* sig, bool keep_last_arg, TRAPS); // use TempNewSymbol
145 static Symbol* lookup_basic_type_signature(Symbol* sig, TRAPS) {
146 return lookup_basic_type_signature(sig, false, THREAD);
147 }
148 static bool is_basic_type_signature(Symbol* sig);
149
150 static Symbol* lookup_method_type(Symbol* msig, Handle mtype, TRAPS);
151
152 static void print_as_method_type_on(outputStream* st, Symbol* sig) {
153 print_as_basic_type_signature_on(st, sig, true, true);
154 }
155 static void print_as_basic_type_signature_on(outputStream* st, Symbol* sig, bool keep_arrays = false, bool keep_basic_names = false);
156
157 // decoding CONSTANT_MethodHandle constants
158 enum { JVM_REF_MIN = JVM_REF_getField, JVM_REF_MAX = JVM_REF_invokeInterface };
159 static bool ref_kind_is_valid(int ref_kind) {
160 return (ref_kind >= JVM_REF_MIN && ref_kind <= JVM_REF_MAX);
161 }
162 static bool ref_kind_is_field(int ref_kind) {
163 assert(ref_kind_is_valid(ref_kind), "");
164 return (ref_kind <= JVM_REF_putStatic);
165 }
166 static bool ref_kind_is_getter(int ref_kind) {
167 assert(ref_kind_is_valid(ref_kind), "");
168 return (ref_kind <= JVM_REF_getStatic);
169 }
170 static bool ref_kind_is_setter(int ref_kind) {
171 return ref_kind_is_field(ref_kind) && !ref_kind_is_getter(ref_kind);
172 }
173 static bool ref_kind_is_method(int ref_kind) {
174 return !ref_kind_is_field(ref_kind) && (ref_kind != JVM_REF_newInvokeSpecial);
175 }
176 static bool ref_kind_has_receiver(int ref_kind) {
177 assert(ref_kind_is_valid(ref_kind), "");
178 return (ref_kind & 1) != 0;
179 }
180 static bool ref_kind_is_static(int ref_kind) {
181 return !ref_kind_has_receiver(ref_kind) && (ref_kind != JVM_REF_newInvokeSpecial);
182 }
183 static bool ref_kind_does_dispatch(int ref_kind) {
184 return (ref_kind == JVM_REF_invokeVirtual ||
185 ref_kind == JVM_REF_invokeInterface);
186 }
187
188
189 #ifdef TARGET_ARCH_x86
190 # include "methodHandles_x86.hpp"
191 #endif
192 #ifdef TARGET_ARCH_sparc
193 # include "methodHandles_sparc.hpp"
194 #endif
195 #ifdef TARGET_ARCH_zero
196 # include "methodHandles_zero.hpp"
197 #endif
198 #ifdef TARGET_ARCH_arm
199 # include "methodHandles_arm.hpp"
200 #endif
201 #ifdef TARGET_ARCH_ppc
202 # include "methodHandles_ppc.hpp"
203 #endif
204 #ifdef TARGET_ARCH_aarch64
205 # include "methodHandles_aarch64.hpp"
206 #endif
207
208 // Tracing
209 static void trace_method_handle(MacroAssembler* _masm, const char* adaptername) PRODUCT_RETURN;
210 static void trace_method_handle_interpreter_entry(MacroAssembler* _masm, vmIntrinsics::ID iid) {
211 if (TraceMethodHandles) {
212 const char* name = vmIntrinsics::name_at(iid);
213 if (*name == '_') name += 1;
214 const size_t len = strlen(name) + 50;
215 char* qname = NEW_C_HEAP_ARRAY(char, len, mtInternal);
216 const char* suffix = "";
217 if (is_signature_polymorphic(iid)) {
218 if (is_signature_polymorphic_static(iid))
219 suffix = "/static";
220 else
221 suffix = "/private";
222 }
223 jio_snprintf(qname, len, "MethodHandle::interpreter_entry::%s%s", name, suffix);
224 trace_method_handle(_masm, qname);
225 // Note: Don't free the allocated char array because it's used
226 // during runtime.
227 }
228 }
229 };
230
231 //------------------------------------------------------------------------------
232 // MethodHandlesAdapterGenerator
233 //
234 class MethodHandlesAdapterGenerator : public StubCodeGenerator {
235 public:
236 MethodHandlesAdapterGenerator(CodeBuffer* code) : StubCodeGenerator(code, PrintMethodHandleStubs) {}
237
238 void generate();
239 };
240
241 //------------------------------------------------------------------------------
242 // MemberNameTable
243 //
244
245 class MemberNameTable : public GrowableArray<jweak> {
246 public:
247 MemberNameTable(int methods_cnt);
248 ~MemberNameTable();
249 void add_member_name(jweak mem_name_ref);
250
251 #if INCLUDE_JVMTI
252 // RedefineClasses() API support:
253 // If a MemberName refers to old_method then update it to refer to new_method.
254 void adjust_method_entries(InstanceKlass* holder, bool * trace_name_printed);
255 #endif // INCLUDE_JVMTI
256 };
257
258 #endif // SHARE_VM_PRIMS_METHODHANDLES_HPP