1 /*
2 * Copyright (c) 1997, 2014, 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 #include "precompiled.hpp"
26 #include "classfile/systemDictionary.hpp"
27 #include "classfile/vmSymbols.hpp"
28 #include "code/nmethod.hpp"
29 #include "compiler/compileBroker.hpp"
30 #include "interpreter/interpreter.hpp"
31 #include "interpreter/linkResolver.hpp"
32 #include "memory/universe.inline.hpp"
33 #include "oops/oop.inline.hpp"
34 #include "prims/jniCheck.hpp"
35 #include "runtime/compilationPolicy.hpp"
36 #include "runtime/handles.inline.hpp"
37 #include "runtime/interfaceSupport.hpp"
38 #include "runtime/javaCalls.hpp"
39 #include "runtime/mutexLocker.hpp"
40 #include "runtime/os.inline.hpp"
41 #include "runtime/signature.hpp"
42 #include "runtime/stubRoutines.hpp"
43 #include "runtime/thread.inline.hpp"
44
45 // -----------------------------------------------------
46 // Implementation of JavaCallWrapper
47
48 JavaCallWrapper::JavaCallWrapper(methodHandle callee_method, Handle receiver, JavaValue* result, TRAPS) {
49 JavaThread* thread = (JavaThread *)THREAD;
50 bool clear_pending_exception = true;
51
52 guarantee(thread->is_Java_thread(), "crucial check - the VM thread cannot and must not escape to Java code");
53 assert(!thread->owns_locks(), "must release all locks when leaving VM");
54 guarantee(!thread->is_Compiler_thread(), "cannot make java calls from the compiler");
55 _result = result;
56
57 // Allocate handle block for Java code. This must be done before we change thread_state to _thread_in_Java_or_stub,
58 // since it can potentially block.
59 JNIHandleBlock* new_handles = JNIHandleBlock::allocate_block(thread);
60
61 // After this, we are official in JavaCode. This needs to be done before we change any of the thread local
62 // info, since we cannot find oops before the new information is set up completely.
63 ThreadStateTransition::transition(thread, _thread_in_vm, _thread_in_Java);
64
65 // Make sure that we handle asynchronous stops and suspends _before_ we clear all thread state
66 // in JavaCallWrapper::JavaCallWrapper(). This way, we can decide if we need to do any pd actions
67 // to prepare for stop/suspend (flush register windows on sparcs, cache sp, or other state).
68 if (thread->has_special_runtime_exit_condition()) {
69 thread->handle_special_runtime_exit_condition();
70 if (HAS_PENDING_EXCEPTION) {
71 clear_pending_exception = false;
72 }
73 }
74
75
76 // Make sure to set the oop's after the thread transition - since we can block there. No one is GC'ing
77 // the JavaCallWrapper before the entry frame is on the stack.
78 _callee_method = callee_method();
79 _receiver = receiver();
80
81 #ifdef CHECK_UNHANDLED_OOPS
82 THREAD->allow_unhandled_oop(&_receiver);
83 #endif // CHECK_UNHANDLED_OOPS
84
85 _thread = (JavaThread *)thread;
86 _handles = _thread->active_handles(); // save previous handle block & Java frame linkage
87
88 // For the profiler, the last_Java_frame information in thread must always be in
89 // legal state. We have no last Java frame if last_Java_sp == NULL so
90 // the valid transition is to clear _last_Java_sp and then reset the rest of
91 // the (platform specific) state.
92
93 _anchor.copy(_thread->frame_anchor());
94 _thread->frame_anchor()->clear();
95
96 debug_only(_thread->inc_java_call_counter());
97 _thread->set_active_handles(new_handles); // install new handle block and reset Java frame linkage
98
99 assert (_thread->thread_state() != _thread_in_native, "cannot set native pc to NULL");
100
101 // clear any pending exception in thread (native calls start with no exception pending)
102 if(clear_pending_exception) {
103 _thread->clear_pending_exception();
104 }
105
106 if (_anchor.last_Java_sp() == NULL) {
107 _thread->record_base_of_stack_pointer();
108 }
109 }
110
111
112 JavaCallWrapper::~JavaCallWrapper() {
113 assert(_thread == JavaThread::current(), "must still be the same thread");
114
115 // restore previous handle block & Java frame linkage
116 JNIHandleBlock *_old_handles = _thread->active_handles();
117 _thread->set_active_handles(_handles);
118
119 _thread->frame_anchor()->zap();
120
121 debug_only(_thread->dec_java_call_counter());
122
123 if (_anchor.last_Java_sp() == NULL) {
124 _thread->set_base_of_stack_pointer(NULL);
125 }
126
127
128 // Old thread-local info. has been restored. We are not back in the VM.
129 ThreadStateTransition::transition_from_java(_thread, _thread_in_vm);
130
131 // State has been restored now make the anchor frame visible for the profiler.
132 // Do this after the transition because this allows us to put an assert
133 // the Java->vm transition which checks to see that stack is not walkable
134 // on sparc/ia64 which will catch violations of the reseting of last_Java_frame
135 // invariants (i.e. _flags always cleared on return to Java)
136
137 _thread->frame_anchor()->copy(&_anchor);
138
139 // Release handles after we are marked as being inside the VM again, since this
140 // operation might block
141 JNIHandleBlock::release_block(_old_handles, _thread);
142 }
143
144
145 void JavaCallWrapper::oops_do(OopClosure* f) {
146 f->do_oop((oop*)&_receiver);
147 handles()->oops_do(f);
148 }
149
150
151 // Helper methods
152 static BasicType runtime_type_from(JavaValue* result) {
153 switch (result->get_type()) {
154 case T_BOOLEAN: // fall through
155 case T_CHAR : // fall through
156 case T_SHORT : // fall through
157 case T_INT : // fall through
158 #ifndef _LP64
159 case T_OBJECT : // fall through
160 case T_ARRAY : // fall through
161 #endif
162 case T_BYTE : // fall through
163 case T_VOID : return T_INT;
164 case T_LONG : return T_LONG;
165 case T_FLOAT : return T_FLOAT;
166 case T_DOUBLE : return T_DOUBLE;
167 #ifdef _LP64
168 case T_ARRAY : // fall through
169 case T_OBJECT: return T_OBJECT;
170 #endif
171 }
172 ShouldNotReachHere();
173 return T_ILLEGAL;
174 }
175
176 // ===== object constructor calls =====
177
178 void JavaCalls::call_default_constructor(JavaThread* thread, methodHandle method, Handle receiver, TRAPS) {
179 assert(method->name() == vmSymbols::object_initializer_name(), "Should only be called for default constructor");
180 assert(method->signature() == vmSymbols::void_method_signature(), "Should only be called for default constructor");
181
182 InstanceKlass* ik = method->method_holder();
183 if (ik->is_initialized() && ik->has_vanilla_constructor()) {
184 // safe to skip constructor call
185 } else {
186 static JavaValue result(T_VOID);
187 JavaCallArguments args(receiver);
188 call(&result, method, &args, CHECK);
189 }
190 }
191
192 // ============ Virtual calls ============
193
194 void JavaCalls::call_virtual(JavaValue* result, KlassHandle spec_klass, Symbol* name, Symbol* signature, JavaCallArguments* args, TRAPS) {
195 CallInfo callinfo;
196 Handle receiver = args->receiver();
197 KlassHandle recvrKlass(THREAD, receiver.is_null() ? (Klass*)NULL : receiver->klass());
198 LinkResolver::resolve_virtual_call(
199 callinfo, receiver, recvrKlass, spec_klass, name, signature,
200 KlassHandle(), false, true, CHECK);
201 methodHandle method = callinfo.selected_method();
202 assert(method.not_null(), "should have thrown exception");
203
204 // Invoke the method
205 JavaCalls::call(result, method, args, CHECK);
206 }
207
208
209 void JavaCalls::call_virtual(JavaValue* result, Handle receiver, KlassHandle spec_klass, Symbol* name, Symbol* signature, TRAPS) {
210 JavaCallArguments args(receiver); // One oop argument
211 call_virtual(result, spec_klass, name, signature, &args, CHECK);
212 }
213
214
215 void JavaCalls::call_virtual(JavaValue* result, Handle receiver, KlassHandle spec_klass, Symbol* name, Symbol* signature, Handle arg1, TRAPS) {
216 JavaCallArguments args(receiver); // One oop argument
217 args.push_oop(arg1);
218 call_virtual(result, spec_klass, name, signature, &args, CHECK);
219 }
220
221
222
223 void JavaCalls::call_virtual(JavaValue* result, Handle receiver, KlassHandle spec_klass, Symbol* name, Symbol* signature, Handle arg1, Handle arg2, TRAPS) {
224 JavaCallArguments args(receiver); // One oop argument
225 args.push_oop(arg1);
226 args.push_oop(arg2);
227 call_virtual(result, spec_klass, name, signature, &args, CHECK);
228 }
229
230
231 // ============ Special calls ============
232
233 void JavaCalls::call_special(JavaValue* result, KlassHandle klass, Symbol* name, Symbol* signature, JavaCallArguments* args, TRAPS) {
234 CallInfo callinfo;
235 LinkResolver::resolve_special_call(callinfo, klass, name, signature, KlassHandle(), false, CHECK);
236 methodHandle method = callinfo.selected_method();
237 assert(method.not_null(), "should have thrown exception");
238
239 // Invoke the method
240 JavaCalls::call(result, method, args, CHECK);
241 }
242
243
244 void JavaCalls::call_special(JavaValue* result, Handle receiver, KlassHandle klass, Symbol* name, Symbol* signature, TRAPS) {
245 JavaCallArguments args(receiver); // One oop argument
246 call_special(result, klass, name, signature, &args, CHECK);
247 }
248
249
250 void JavaCalls::call_special(JavaValue* result, Handle receiver, KlassHandle klass, Symbol* name, Symbol* signature, Handle arg1, TRAPS) {
251 JavaCallArguments args(receiver); // One oop argument
252 args.push_oop(arg1);
253 call_special(result, klass, name, signature, &args, CHECK);
254 }
255
256
257 void JavaCalls::call_special(JavaValue* result, Handle receiver, KlassHandle klass, Symbol* name, Symbol* signature, Handle arg1, Handle arg2, TRAPS) {
258 JavaCallArguments args(receiver); // One oop argument
259 args.push_oop(arg1);
260 args.push_oop(arg2);
261 call_special(result, klass, name, signature, &args, CHECK);
262 }
263
264
265 // ============ Static calls ============
266
267 void JavaCalls::call_static(JavaValue* result, KlassHandle klass, Symbol* name, Symbol* signature, JavaCallArguments* args, TRAPS) {
268 CallInfo callinfo;
269 LinkResolver::resolve_static_call(callinfo, klass, name, signature, KlassHandle(), false, true, CHECK);
270 methodHandle method = callinfo.selected_method();
271 assert(method.not_null(), "should have thrown exception");
272
273 // Invoke the method
274 JavaCalls::call(result, method, args, CHECK);
275 }
276
277
278 void JavaCalls::call_static(JavaValue* result, KlassHandle klass, Symbol* name, Symbol* signature, TRAPS) {
279 JavaCallArguments args; // No argument
280 call_static(result, klass, name, signature, &args, CHECK);
281 }
282
283
284 void JavaCalls::call_static(JavaValue* result, KlassHandle klass, Symbol* name, Symbol* signature, Handle arg1, TRAPS) {
285 JavaCallArguments args(arg1); // One oop argument
286 call_static(result, klass, name, signature, &args, CHECK);
287 }
288
289
290 void JavaCalls::call_static(JavaValue* result, KlassHandle klass, Symbol* name, Symbol* signature, Handle arg1, Handle arg2, TRAPS) {
291 JavaCallArguments args; // One oop argument
292 args.push_oop(arg1);
293 args.push_oop(arg2);
294 call_static(result, klass, name, signature, &args, CHECK);
295 }
296
297
298 // -------------------------------------------------
299 // Implementation of JavaCalls (low level)
300
301
302 void JavaCalls::call(JavaValue* result, methodHandle method, JavaCallArguments* args, TRAPS) {
303 // Check if we need to wrap a potential OS exception handler around thread
304 // This is used for e.g. Win32 structured exception handlers
305 assert(THREAD->is_Java_thread(), "only JavaThreads can make JavaCalls");
306 // Need to wrap each and every time, since there might be native code down the
307 // stack that has installed its own exception handlers
308 os::os_exception_wrapper(call_helper, result, &method, args, THREAD);
309 }
310
311 void JavaCalls::call_helper(JavaValue* result, methodHandle* m, JavaCallArguments* args, TRAPS) {
312 methodHandle method = *m;
313 JavaThread* thread = (JavaThread*)THREAD;
314 assert(thread->is_Java_thread(), "must be called by a java thread");
315 assert(method.not_null(), "must have a method to call");
316 assert(!SafepointSynchronize::is_at_safepoint(), "call to Java code during VM operation");
317 assert(!thread->handle_area()->no_handle_mark_active(), "cannot call out to Java here");
318
319
320 CHECK_UNHANDLED_OOPS_ONLY(thread->clear_unhandled_oops();)
321
322 // Verify the arguments
323
324 if (CheckJNICalls) {
325 args->verify(method, result->get_type(), thread);
326 }
327 else debug_only(args->verify(method, result->get_type(), thread));
328
329 // Ignore call if method is empty
330 if (method->is_empty_method()) {
331 assert(result->get_type() == T_VOID, "an empty method must return a void value");
332 return;
333 }
334
335
336 #ifdef ASSERT
337 { InstanceKlass* holder = method->method_holder();
338 // A klass might not be initialized since JavaCall's might be used during the executing of
339 // the <clinit>. For example, a Thread.start might start executing on an object that is
340 // not fully initialized! (bad Java programming style)
341 assert(holder->is_linked(), "rewriting must have taken place");
342 }
343 #endif
344
345
346 assert(!thread->is_Compiler_thread(), "cannot compile from the compiler");
347 if (CompilationPolicy::must_be_compiled(method)) {
348 CompileBroker::compile_method(method, InvocationEntryBci,
349 CompilationPolicy::policy()->initial_compile_level(),
350 methodHandle(), 0, "must_be_compiled", CHECK);
351 }
352
353 // Since the call stub sets up like the interpreter we call the from_interpreted_entry
354 // so we can go compiled via a i2c. Otherwise initial entry method will always
355 // run interpreted.
356 address entry_point = method->from_interpreted_entry();
357 if (JvmtiExport::can_post_interpreter_events() && thread->is_interp_only_mode()) {
358 entry_point = method->interpreter_entry();
359 }
360
361 // Figure out if the result value is an oop or not (Note: This is a different value
362 // than result_type. result_type will be T_INT of oops. (it is about size)
363 BasicType result_type = runtime_type_from(result);
364 bool oop_result_flag = (result->get_type() == T_OBJECT || result->get_type() == T_ARRAY);
365
366 // NOTE: if we move the computation of the result_val_address inside
367 // the call to call_stub, the optimizer produces wrong code.
368 intptr_t* result_val_address = (intptr_t*)(result->get_value_addr());
369
370 // Find receiver
371 Handle receiver = (!method->is_static()) ? args->receiver() : Handle();
372
373 // When we reenter Java, we need to reenable the yellow zone which
374 // might already be disabled when we are in VM.
375 if (thread->stack_yellow_zone_disabled()) {
376 thread->reguard_stack();
377 }
378
379 // Check that there are shadow pages available before changing thread state
380 // to Java
381 if (!os::stack_shadow_pages_available(THREAD, method)) {
382 // Throw stack overflow exception with preinitialized exception.
383 Exceptions::throw_stack_overflow_exception(THREAD, __FILE__, __LINE__, method);
384 return;
385 } else {
386 // Touch pages checked if the OS needs them to be touched to be mapped.
387 os::bang_stack_shadow_pages();
388 }
389
390 // do call
391 { JavaCallWrapper link(method, receiver, result, CHECK);
392 { HandleMark hm(thread); // HandleMark used by HandleMarkCleaner
393
394 StubRoutines::call_stub()(
395 (address)&link,
396 // (intptr_t*)&(result->_value), // see NOTE above (compiler problem)
397 result_val_address, // see NOTE above (compiler problem)
398 result_type,
399 method(),
400 entry_point,
401 args->parameters(),
402 args->size_of_parameters(),
403 CHECK
404 );
405
406 result = link.result(); // circumvent MS C++ 5.0 compiler bug (result is clobbered across call)
407 // Preserve oop return value across possible gc points
408 if (oop_result_flag) {
409 thread->set_vm_result((oop) result->get_jobject());
410 }
411 }
412 } // Exit JavaCallWrapper (can block - potential return oop must be preserved)
413
414 // Check if a thread stop or suspend should be executed
415 // The following assert was not realistic. Thread.stop can set that bit at any moment.
416 //assert(!thread->has_special_runtime_exit_condition(), "no async. exceptions should be installed");
417
418 // Restore possible oop return
419 if (oop_result_flag) {
420 result->set_jobject((jobject)thread->vm_result());
421 thread->set_vm_result(NULL);
422 }
423 }
424
425
426 //--------------------------------------------------------------------------------------
427 // Implementation of JavaCallArguments
428
429 intptr_t* JavaCallArguments::parameters() {
430 // First convert all handles to oops
431 for(int i = 0; i < _size; i++) {
432 if (_is_oop[i]) {
433 // Handle conversion
434 _value[i] = cast_from_oop<intptr_t>(Handle::raw_resolve((oop *)_value[i]));
435 }
436 }
437 // Return argument vector
438 return _value;
439 }
440
441
442 class SignatureChekker : public SignatureIterator {
443 private:
444 bool *_is_oop;
445 int _pos;
446 BasicType _return_type;
447 intptr_t* _value;
448 Thread* _thread;
449
450 public:
451 bool _is_return;
452
453 SignatureChekker(Symbol* signature, BasicType return_type, bool is_static, bool* is_oop, intptr_t* value, Thread* thread) : SignatureIterator(signature) {
454 _is_oop = is_oop;
455 _is_return = false;
456 _return_type = return_type;
457 _pos = 0;
458 _value = value;
459 _thread = thread;
460
461 if (!is_static) {
462 check_value(true); // Receiver must be an oop
463 }
464 }
465
466 void check_value(bool type) {
467 guarantee(_is_oop[_pos++] == type, "signature does not match pushed arguments");
468 }
469
470 void check_doing_return(bool state) { _is_return = state; }
471
472 void check_return_type(BasicType t) {
473 guarantee(_is_return && t == _return_type, "return type does not match");
474 }
475
476 void check_int(BasicType t) {
477 if (_is_return) {
478 check_return_type(t);
479 return;
480 }
481 check_value(false);
482 }
483
484 void check_double(BasicType t) { check_long(t); }
485
486 void check_long(BasicType t) {
487 if (_is_return) {
488 check_return_type(t);
489 return;
490 }
491
492 check_value(false);
493 check_value(false);
494 }
495
496 void check_obj(BasicType t) {
497 if (_is_return) {
498 check_return_type(t);
499 return;
500 }
501
502 // verify handle and the oop pointed to by handle
503 int p = _pos;
504 bool bad = false;
505 // If argument is oop
506 if (_is_oop[p]) {
507 intptr_t v = _value[p];
508 if (v != 0 ) {
509 size_t t = (size_t)v;
510 bad = (t < (size_t)os::vm_page_size() ) || !Handle::raw_resolve((oop *)v)->is_oop_or_null(true);
511 if (CheckJNICalls && bad) {
512 ReportJNIFatalError((JavaThread*)_thread, "Bad JNI oop argument");
513 }
514 }
515 // for the regular debug case.
516 assert(!bad, "Bad JNI oop argument");
517 }
518
519 check_value(true);
520 }
521
522 void do_bool() { check_int(T_BOOLEAN); }
523 void do_char() { check_int(T_CHAR); }
524 void do_float() { check_int(T_FLOAT); }
525 void do_double() { check_double(T_DOUBLE); }
526 void do_byte() { check_int(T_BYTE); }
527 void do_short() { check_int(T_SHORT); }
528 void do_int() { check_int(T_INT); }
529 void do_long() { check_long(T_LONG); }
530 void do_void() { check_return_type(T_VOID); }
531 void do_object(int begin, int end) { check_obj(T_OBJECT); }
532 void do_array(int begin, int end) { check_obj(T_OBJECT); }
533 };
534
535
536 void JavaCallArguments::verify(methodHandle method, BasicType return_type,
537 Thread *thread) {
538 guarantee(method->size_of_parameters() == size_of_parameters(), "wrong no. of arguments pushed");
539
540 // Treat T_OBJECT and T_ARRAY as the same
541 if (return_type == T_ARRAY) return_type = T_OBJECT;
542
543 // Check that oop information is correct
544 Symbol* signature = method->signature();
545
546 SignatureChekker sc(signature, return_type, method->is_static(),_is_oop, _value, thread);
547 sc.iterate_parameters();
548 sc.check_doing_return(true);
549 sc.iterate_returntype();
550 }