Tue, 16 Mar 2010 11:52:17 +0100
6934494: JSR 292 MethodHandles adapters should be generated into their own CodeBlob
Summary: Passing a null pointer to an InvokeDynamic function call should lead to a NullPointerException.
Reviewed-by: kvn, never
1 /*
2 * Copyright 2008-2009 Sun Microsystems, Inc. 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
20 * CA 95054 USA or visit www.sun.com if you need additional information or
21 * have any questions.
22 *
23 */
25 class MacroAssembler;
26 class Label;
27 class MethodHandleEntry;
29 class MethodHandles: AllStatic {
30 // JVM support for MethodHandle, MethodType, and related types
31 // in java.dyn and java.dyn.hotspot.
32 // See also javaClasses for layouts java_dyn_Method{Handle,Type,Type::Form}.
33 public:
34 enum EntryKind {
35 _raise_exception, // stub for error generation from other stubs
36 _invokestatic_mh, // how a MH emulates invokestatic
37 _invokespecial_mh, // ditto for the other invokes...
38 _invokevirtual_mh,
39 _invokeinterface_mh,
40 _bound_ref_mh, // reference argument is bound
41 _bound_int_mh, // int argument is bound (via an Integer or Float)
42 _bound_long_mh, // long argument is bound (via a Long or Double)
43 _bound_ref_direct_mh, // same as above, with direct linkage to methodOop
44 _bound_int_direct_mh,
45 _bound_long_direct_mh,
47 _adapter_mh_first, // adapter sequence goes here...
48 _adapter_retype_only = _adapter_mh_first + sun_dyn_AdapterMethodHandle::OP_RETYPE_ONLY,
49 _adapter_retype_raw = _adapter_mh_first + sun_dyn_AdapterMethodHandle::OP_RETYPE_RAW,
50 _adapter_check_cast = _adapter_mh_first + sun_dyn_AdapterMethodHandle::OP_CHECK_CAST,
51 _adapter_prim_to_prim = _adapter_mh_first + sun_dyn_AdapterMethodHandle::OP_PRIM_TO_PRIM,
52 _adapter_ref_to_prim = _adapter_mh_first + sun_dyn_AdapterMethodHandle::OP_REF_TO_PRIM,
53 _adapter_prim_to_ref = _adapter_mh_first + sun_dyn_AdapterMethodHandle::OP_PRIM_TO_REF,
54 _adapter_swap_args = _adapter_mh_first + sun_dyn_AdapterMethodHandle::OP_SWAP_ARGS,
55 _adapter_rot_args = _adapter_mh_first + sun_dyn_AdapterMethodHandle::OP_ROT_ARGS,
56 _adapter_dup_args = _adapter_mh_first + sun_dyn_AdapterMethodHandle::OP_DUP_ARGS,
57 _adapter_drop_args = _adapter_mh_first + sun_dyn_AdapterMethodHandle::OP_DROP_ARGS,
58 _adapter_collect_args = _adapter_mh_first + sun_dyn_AdapterMethodHandle::OP_COLLECT_ARGS,
59 _adapter_spread_args = _adapter_mh_first + sun_dyn_AdapterMethodHandle::OP_SPREAD_ARGS,
60 _adapter_flyby = _adapter_mh_first + sun_dyn_AdapterMethodHandle::OP_FLYBY,
61 _adapter_ricochet = _adapter_mh_first + sun_dyn_AdapterMethodHandle::OP_RICOCHET,
62 _adapter_mh_last = _adapter_mh_first + sun_dyn_AdapterMethodHandle::CONV_OP_LIMIT - 1,
64 // Optimized adapter types
66 // argument list reordering
67 _adapter_opt_swap_1,
68 _adapter_opt_swap_2,
69 _adapter_opt_rot_1_up,
70 _adapter_opt_rot_1_down,
71 _adapter_opt_rot_2_up,
72 _adapter_opt_rot_2_down,
73 // primitive single to single:
74 _adapter_opt_i2i, // i2c, i2z, i2b, i2s
75 // primitive double to single:
76 _adapter_opt_l2i,
77 _adapter_opt_d2f,
78 // primitive single to double:
79 _adapter_opt_i2l,
80 _adapter_opt_f2d,
81 // conversion between floating point and integer type is handled by Java
83 // reference to primitive:
84 _adapter_opt_unboxi,
85 _adapter_opt_unboxl,
87 // spreading (array length cases 0, 1, >=2)
88 _adapter_opt_spread_0,
89 _adapter_opt_spread_1,
90 _adapter_opt_spread_more,
92 _EK_LIMIT,
93 _EK_FIRST = 0
94 };
96 public:
97 static bool enabled() { return _enabled; }
98 static void set_enabled(bool z);
100 private:
101 enum { // import sun_dyn_AdapterMethodHandle::CONV_OP_*
102 CONV_OP_LIMIT = sun_dyn_AdapterMethodHandle::CONV_OP_LIMIT,
103 CONV_OP_MASK = sun_dyn_AdapterMethodHandle::CONV_OP_MASK,
104 CONV_VMINFO_MASK = sun_dyn_AdapterMethodHandle::CONV_VMINFO_MASK,
105 CONV_VMINFO_SHIFT = sun_dyn_AdapterMethodHandle::CONV_VMINFO_SHIFT,
106 CONV_OP_SHIFT = sun_dyn_AdapterMethodHandle::CONV_OP_SHIFT,
107 CONV_DEST_TYPE_SHIFT = sun_dyn_AdapterMethodHandle::CONV_DEST_TYPE_SHIFT,
108 CONV_SRC_TYPE_SHIFT = sun_dyn_AdapterMethodHandle::CONV_SRC_TYPE_SHIFT,
109 CONV_STACK_MOVE_SHIFT = sun_dyn_AdapterMethodHandle::CONV_STACK_MOVE_SHIFT,
110 CONV_STACK_MOVE_MASK = sun_dyn_AdapterMethodHandle::CONV_STACK_MOVE_MASK
111 };
113 static bool _enabled;
114 static MethodHandleEntry* _entries[_EK_LIMIT];
115 static const char* _entry_names[_EK_LIMIT+1];
116 static jobject _raise_exception_method;
118 // Adapters.
119 static MethodHandlesAdapterBlob* _adapter_code;
120 static int _adapter_code_size;
122 static bool ek_valid(EntryKind ek) { return (uint)ek < (uint)_EK_LIMIT; }
123 static bool conv_op_valid(int op) { return (uint)op < (uint)CONV_OP_LIMIT; }
125 public:
126 static bool have_entry(EntryKind ek) { return ek_valid(ek) && _entries[ek] != NULL; }
127 static MethodHandleEntry* entry(EntryKind ek) { assert(ek_valid(ek), "initialized");
128 return _entries[ek]; }
129 static const char* entry_name(EntryKind ek) { assert(ek_valid(ek), "oob");
130 return _entry_names[ek]; }
131 static EntryKind adapter_entry_kind(int op) { assert(conv_op_valid(op), "oob");
132 return EntryKind(_adapter_mh_first + op); }
134 static void init_entry(EntryKind ek, MethodHandleEntry* me) {
135 assert(ek_valid(ek), "oob");
136 assert(_entries[ek] == NULL, "no double initialization");
137 _entries[ek] = me;
138 }
140 static methodOop raise_exception_method() {
141 oop rem = JNIHandles::resolve(_raise_exception_method);
142 assert(rem == NULL || rem->is_method(), "");
143 return (methodOop) rem;
144 }
145 static void set_raise_exception_method(methodOop rem) {
146 assert(_raise_exception_method == NULL, "");
147 _raise_exception_method = JNIHandles::make_global(Handle(rem));
148 }
150 static jint adapter_conversion(int conv_op, BasicType src, BasicType dest,
151 int stack_move = 0, int vminfo = 0) {
152 assert(conv_op_valid(conv_op), "oob");
153 jint conv = ((conv_op << CONV_OP_SHIFT)
154 | (src << CONV_SRC_TYPE_SHIFT)
155 | (dest << CONV_DEST_TYPE_SHIFT)
156 | (stack_move << CONV_STACK_MOVE_SHIFT)
157 | (vminfo << CONV_VMINFO_SHIFT)
158 );
159 assert(adapter_conversion_op(conv) == conv_op, "decode conv_op");
160 assert(adapter_conversion_src_type(conv) == src, "decode src");
161 assert(adapter_conversion_dest_type(conv) == dest, "decode dest");
162 assert(adapter_conversion_stack_move(conv) == stack_move, "decode stack_move");
163 assert(adapter_conversion_vminfo(conv) == vminfo, "decode vminfo");
164 return conv;
165 }
166 static int adapter_conversion_op(jint conv) {
167 return ((conv >> CONV_OP_SHIFT) & 0xF);
168 }
169 static BasicType adapter_conversion_src_type(jint conv) {
170 return (BasicType)((conv >> CONV_SRC_TYPE_SHIFT) & 0xF);
171 }
172 static BasicType adapter_conversion_dest_type(jint conv) {
173 return (BasicType)((conv >> CONV_DEST_TYPE_SHIFT) & 0xF);
174 }
175 static int adapter_conversion_stack_move(jint conv) {
176 return (conv >> CONV_STACK_MOVE_SHIFT);
177 }
178 static int adapter_conversion_vminfo(jint conv) {
179 return (conv >> CONV_VMINFO_SHIFT) & CONV_VMINFO_MASK;
180 }
182 // Offset in words that the interpreter stack pointer moves when an argument is pushed.
183 // The stack_move value must always be a multiple of this.
184 static int stack_move_unit() {
185 return frame::interpreter_frame_expression_stack_direction() * Interpreter::stackElementWords();
186 }
188 enum { CONV_VMINFO_SIGN_FLAG = 0x80 };
189 static int adapter_subword_vminfo(BasicType dest) {
190 if (dest == T_BOOLEAN) return (BitsPerInt - 1);
191 if (dest == T_CHAR) return (BitsPerInt - 16);
192 if (dest == T_BYTE) return (BitsPerInt - 8) | CONV_VMINFO_SIGN_FLAG;
193 if (dest == T_SHORT) return (BitsPerInt - 16) | CONV_VMINFO_SIGN_FLAG;
194 return 0; // case T_INT
195 }
196 // Here is the transformation the i2i adapter must perform:
197 static int truncate_subword_from_vminfo(jint value, int vminfo) {
198 jint tem = value << vminfo;
199 if ((vminfo & CONV_VMINFO_SIGN_FLAG) != 0) {
200 return (jint)tem >> vminfo;
201 } else {
202 return (juint)tem >> vminfo;
203 }
204 }
206 static inline address from_compiled_entry(EntryKind ek);
207 static inline address from_interpreted_entry(EntryKind ek);
209 // helpers for decode_method.
210 static methodOop decode_methodOop(methodOop m, int& decode_flags_result);
211 static methodOop decode_vmtarget(oop vmtarget, int vmindex, oop mtype, klassOop& receiver_limit_result, int& decode_flags_result);
212 static methodOop decode_MemberName(oop mname, klassOop& receiver_limit_result, int& decode_flags_result);
213 static methodOop decode_MethodHandle(oop mh, klassOop& receiver_limit_result, int& decode_flags_result);
214 static methodOop decode_DirectMethodHandle(oop mh, klassOop& receiver_limit_result, int& decode_flags_result);
215 static methodOop decode_BoundMethodHandle(oop mh, klassOop& receiver_limit_result, int& decode_flags_result);
216 static methodOop decode_AdapterMethodHandle(oop mh, klassOop& receiver_limit_result, int& decode_flags_result);
218 // Find out how many stack slots an mh pushes or pops.
219 // The result is *not* reported as a multiple of stack_move_unit();
220 // It is a signed net number of pushes (a difference in vmslots).
221 // To compare with a stack_move value, first multiply by stack_move_unit().
222 static int decode_MethodHandle_stack_pushes(oop mh);
224 public:
225 // working with member names
226 static void resolve_MemberName(Handle mname, TRAPS); // compute vmtarget/vmindex from name/type
227 static void expand_MemberName(Handle mname, int suppress, TRAPS); // expand defc/name/type if missing
228 static void init_MemberName(oop mname_oop, oop target); // compute vmtarget/vmindex from target
229 static void init_MemberName(oop mname_oop, methodOop m, bool do_dispatch);
230 static void init_MemberName(oop mname_oop, klassOop field_holder, AccessFlags mods, int offset);
231 static int find_MemberNames(klassOop k, symbolOop name, symbolOop sig,
232 int mflags, klassOop caller,
233 int skip, objArrayOop results);
234 // bit values for suppress argument to expand_MemberName:
235 enum { _suppress_defc = 1, _suppress_name = 2, _suppress_type = 4 };
237 // Generate MethodHandles adapters.
238 static void generate_adapters();
240 // Called from InterpreterGenerator and MethodHandlesAdapterGenerator.
241 static address generate_method_handle_interpreter_entry(MacroAssembler* _masm);
242 static void generate_method_handle_stub(MacroAssembler* _masm, EntryKind ek);
244 // argument list parsing
245 static int argument_slot(oop method_type, int arg);
246 static int argument_slot_count(oop method_type) { return argument_slot(method_type, -1); }
247 static int argument_slot_to_argnum(oop method_type, int argslot);
249 // Runtime support
250 enum { // bit-encoded flags from decode_method or decode_vmref
251 _dmf_has_receiver = 0x01, // target method has leading reference argument
252 _dmf_does_dispatch = 0x02, // method handle performs virtual or interface dispatch
253 _dmf_from_interface = 0x04, // peforms interface dispatch
254 _DMF_DIRECT_MASK = (_dmf_from_interface*2 - _dmf_has_receiver),
255 _dmf_binds_method = 0x08,
256 _dmf_binds_argument = 0x10,
257 _DMF_BOUND_MASK = (_dmf_binds_argument*2 - _dmf_binds_method),
258 _dmf_adapter_lsb = 0x20,
259 _DMF_ADAPTER_MASK = (_dmf_adapter_lsb << CONV_OP_LIMIT) - _dmf_adapter_lsb
260 };
261 static methodOop decode_method(oop x, klassOop& receiver_limit_result, int& decode_flags_result);
262 enum {
263 // format of query to getConstant:
264 GC_JVM_PUSH_LIMIT = 0,
265 GC_JVM_STACK_MOVE_UNIT = 1,
267 // format of result from getTarget / encode_target:
268 ETF_HANDLE_OR_METHOD_NAME = 0, // all available data (immediate MH or method)
269 ETF_DIRECT_HANDLE = 1, // ultimate method handle (will be a DMH, may be self)
270 ETF_METHOD_NAME = 2, // ultimate method as MemberName
271 ETF_REFLECT_METHOD = 3 // ultimate method as java.lang.reflect object (sans refClass)
272 };
273 static int get_named_constant(int which, Handle name_box, TRAPS);
274 static oop encode_target(Handle mh, int format, TRAPS); // report vmtarget (to Java code)
275 static bool class_cast_needed(klassOop src, klassOop dst);
277 private:
278 // These checkers operate on a pair of whole MethodTypes:
279 static const char* check_method_type_change(oop src_mtype, int src_beg, int src_end,
280 int insert_argnum, oop insert_type,
281 int change_argnum, oop change_type,
282 int delete_argnum,
283 oop dst_mtype, int dst_beg, int dst_end,
284 bool raw = false);
285 static const char* check_method_type_insertion(oop src_mtype,
286 int insert_argnum, oop insert_type,
287 oop dst_mtype) {
288 oop no_ref = NULL;
289 return check_method_type_change(src_mtype, 0, -1,
290 insert_argnum, insert_type,
291 -1, no_ref, -1, dst_mtype, 0, -1);
292 }
293 static const char* check_method_type_conversion(oop src_mtype,
294 int change_argnum, oop change_type,
295 oop dst_mtype) {
296 oop no_ref = NULL;
297 return check_method_type_change(src_mtype, 0, -1, -1, no_ref,
298 change_argnum, change_type,
299 -1, dst_mtype, 0, -1);
300 }
301 static const char* check_method_type_passthrough(oop src_mtype, oop dst_mtype, bool raw) {
302 oop no_ref = NULL;
303 return check_method_type_change(src_mtype, 0, -1,
304 -1, no_ref, -1, no_ref, -1,
305 dst_mtype, 0, -1, raw);
306 }
308 // These checkers operate on pairs of argument or return types:
309 static const char* check_argument_type_change(BasicType src_type, klassOop src_klass,
310 BasicType dst_type, klassOop dst_klass,
311 int argnum, bool raw = false);
313 static const char* check_argument_type_change(oop src_type, oop dst_type,
314 int argnum, bool raw = false) {
315 klassOop src_klass = NULL, dst_klass = NULL;
316 BasicType src_bt = java_lang_Class::as_BasicType(src_type, &src_klass);
317 BasicType dst_bt = java_lang_Class::as_BasicType(dst_type, &dst_klass);
318 return check_argument_type_change(src_bt, src_klass,
319 dst_bt, dst_klass, argnum, raw);
320 }
322 static const char* check_return_type_change(oop src_type, oop dst_type, bool raw = false) {
323 return check_argument_type_change(src_type, dst_type, -1, raw);
324 }
326 static const char* check_return_type_change(BasicType src_type, klassOop src_klass,
327 BasicType dst_type, klassOop dst_klass) {
328 return check_argument_type_change(src_type, src_klass, dst_type, dst_klass, -1);
329 }
331 static const char* check_method_receiver(methodOop m, klassOop passed_recv_type);
333 // These verifiers can block, and will throw an error if the checking fails:
334 static void verify_vmslots(Handle mh, TRAPS);
335 static void verify_vmargslot(Handle mh, int argnum, int argslot, TRAPS);
337 static void verify_method_type(methodHandle m, Handle mtype,
338 bool has_bound_oop,
339 KlassHandle bound_oop_type,
340 TRAPS);
342 static void verify_method_signature(methodHandle m, Handle mtype,
343 int first_ptype_pos,
344 KlassHandle insert_ptype, TRAPS);
346 static void verify_DirectMethodHandle(Handle mh, methodHandle m, TRAPS);
347 static void verify_BoundMethodHandle(Handle mh, Handle target, int argnum,
348 bool direct_to_method, TRAPS);
349 static void verify_BoundMethodHandle_with_receiver(Handle mh, methodHandle m, TRAPS);
350 static void verify_AdapterMethodHandle(Handle mh, int argnum, TRAPS);
352 public:
354 // Fill in the fields of a DirectMethodHandle mh. (MH.type must be pre-filled.)
355 static void init_DirectMethodHandle(Handle mh, methodHandle method, bool do_dispatch, TRAPS);
357 // Fill in the fields of a BoundMethodHandle mh. (MH.type, BMH.argument must be pre-filled.)
358 static void init_BoundMethodHandle(Handle mh, Handle target, int argnum, TRAPS);
359 static void init_BoundMethodHandle_with_receiver(Handle mh,
360 methodHandle original_m,
361 KlassHandle receiver_limit,
362 int decode_flags,
363 TRAPS);
365 // Fill in the fields of an AdapterMethodHandle mh. (MH.type must be pre-filled.)
366 static void init_AdapterMethodHandle(Handle mh, Handle target, int argnum, TRAPS);
368 #ifdef ASSERT
369 static bool spot_check_entry_names();
370 #endif
372 private:
373 static methodHandle dispatch_decoded_method(methodHandle m,
374 KlassHandle receiver_limit,
375 int decode_flags,
376 KlassHandle receiver_klass,
377 TRAPS);
379 static bool same_basic_type_for_arguments(BasicType src, BasicType dst,
380 bool raw = false,
381 bool for_return = false);
382 static bool same_basic_type_for_returns(BasicType src, BasicType dst, bool raw = false) {
383 return same_basic_type_for_arguments(src, dst, raw, true);
384 }
386 enum { // arg_mask values
387 _INSERT_NO_MASK = -1,
388 _INSERT_REF_MASK = 0,
389 _INSERT_INT_MASK = 1,
390 _INSERT_LONG_MASK = 3
391 };
392 static void insert_arg_slots(MacroAssembler* _masm,
393 RegisterOrConstant arg_slots,
394 int arg_mask,
395 Register rax_argslot,
396 Register rbx_temp, Register rdx_temp);
398 static void remove_arg_slots(MacroAssembler* _masm,
399 RegisterOrConstant arg_slots,
400 Register rax_argslot,
401 Register rbx_temp, Register rdx_temp);
402 };
405 // Access methods for the "entry" field of a java.dyn.MethodHandle.
406 // The field is primarily a jump target for compiled calls.
407 // However, we squirrel away some nice pointers for other uses,
408 // just before the jump target.
409 // Aspects of a method handle entry:
410 // - from_compiled_entry - stub used when compiled code calls the MH
411 // - from_interpreted_entry - stub used when the interpreter calls the MH
412 // - type_checking_entry - stub for runtime casting between MHForm siblings (NYI)
413 class MethodHandleEntry {
414 public:
415 class Data {
416 friend class MethodHandleEntry;
417 size_t _total_size; // size including Data and code stub
418 MethodHandleEntry* _type_checking_entry;
419 address _from_interpreted_entry;
420 MethodHandleEntry* method_entry() { return (MethodHandleEntry*)(this + 1); }
421 };
423 Data* data() { return (Data*)this - 1; }
425 address start_address() { return (address) data(); }
426 address end_address() { return start_address() + data()->_total_size; }
428 address from_compiled_entry() { return (address) this; }
430 address from_interpreted_entry() { return data()->_from_interpreted_entry; }
431 void set_from_interpreted_entry(address e) { data()->_from_interpreted_entry = e; }
433 MethodHandleEntry* type_checking_entry() { return data()->_type_checking_entry; }
434 void set_type_checking_entry(MethodHandleEntry* e) { data()->_type_checking_entry = e; }
436 void set_end_address(address end_addr) {
437 size_t total_size = end_addr - start_address();
438 assert(total_size > 0 && total_size < 0x1000, "reasonable end address");
439 data()->_total_size = total_size;
440 }
442 // Compiler support:
443 static int from_interpreted_entry_offset_in_bytes() {
444 return (int)( offset_of(Data, _from_interpreted_entry) - sizeof(Data) );
445 }
446 static int type_checking_entry_offset_in_bytes() {
447 return (int)( offset_of(Data, _from_interpreted_entry) - sizeof(Data) );
448 }
450 static address start_compiled_entry(MacroAssembler* _masm,
451 address interpreted_entry = NULL);
452 static MethodHandleEntry* finish_compiled_entry(MacroAssembler* masm, address start_addr);
453 };
455 address MethodHandles::from_compiled_entry(EntryKind ek) { return entry(ek)->from_compiled_entry(); }
456 address MethodHandles::from_interpreted_entry(EntryKind ek) { return entry(ek)->from_interpreted_entry(); }
459 //------------------------------------------------------------------------------
460 // MethodHandlesAdapterGenerator
461 //
462 class MethodHandlesAdapterGenerator : public StubCodeGenerator {
463 public:
464 MethodHandlesAdapterGenerator(CodeBuffer* code) : StubCodeGenerator(code) {}
466 void generate();
467 };