1 /*
  2  * Copyright (c) 1997, 2018, 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 "code/codeBehaviours.hpp"
 28 #include "code/codeCache.hpp"
 29 #include "code/compiledIC.hpp"
 30 #include "code/icBuffer.hpp"
 31 #include "code/nmethod.hpp"
 32 #include "code/vtableStubs.hpp"
 33 #include "interpreter/interpreter.hpp"
 34 #include "interpreter/linkResolver.hpp"
 35 #include "memory/metadataFactory.hpp"
 36 #include "memory/oopFactory.hpp"
 37 #include "memory/resourceArea.hpp"
 38 #include "oops/method.inline.hpp"
 39 #include "oops/oop.inline.hpp"
 40 #include "oops/symbol.hpp"
 41 #include "runtime/handles.inline.hpp"
 42 #include "runtime/icache.hpp"
 43 #include "runtime/sharedRuntime.hpp"
 44 #include "runtime/stubRoutines.hpp"
 45 #include "utilities/events.hpp"
 46 
 47 
 48 // Every time a compiled IC is changed or its type is being accessed,
 49 // either the CompiledIC_lock must be set or we must be at a safe point.
 50 
 51 CompiledICLocker::CompiledICLocker(CompiledMethod* method)
 52   : _method(method),
 53     _behaviour(CompiledICProtectionBehaviour::current()),
 54     _locked(_behaviour->lock(_method)){
 55 }
 56 
 57 CompiledICLocker::~CompiledICLocker() {
 58   if (_locked) {
 59     _behaviour->unlock(_method);
 60   }
 61 }
 62 
 63 bool CompiledICLocker::is_safe(CompiledMethod* method) {
 64   return CompiledICProtectionBehaviour::current()->is_safe(method);
 65 }
 66 
 67 bool CompiledICLocker::is_safe(address code) {
 68   CodeBlob* cb = CodeCache::find_blob_unsafe(code);
 69   assert(cb != NULL && cb->is_compiled(), "must be compiled");
 70   CompiledMethod* cm = cb->as_compiled_method();
 71   return CompiledICProtectionBehaviour::current()->is_safe(cm);
 72 }
 73 
 74 //-----------------------------------------------------------------------------
 75 // Low-level access to an inline cache. Private, since they might not be
 76 // MT-safe to use.
 77 
 78 void* CompiledIC::cached_value() const {
 79   assert(CompiledICLocker::is_safe(_method), "mt unsafe call");
 80   assert (!is_optimized(), "an optimized virtual call does not have a cached metadata");
 81 
 82   if (!is_in_transition_state()) {
 83     void* data = get_data();
 84     // If we let the metadata value here be initialized to zero...
 85     assert(data != NULL || Universe::non_oop_word() == NULL,
 86            "no raw nulls in CompiledIC metadatas, because of patching races");
 87     return (data == (void*)Universe::non_oop_word()) ? NULL : data;
 88   } else {
 89     return InlineCacheBuffer::cached_value_for((CompiledIC *)this);
 90   }
 91 }
 92 
 93 
 94 void CompiledIC::internal_set_ic_destination(address entry_point, bool is_icstub, void* cache, bool is_icholder) {
 95   assert(entry_point != NULL, "must set legal entry point");
 96   assert(CompiledICLocker::is_safe(_method), "mt unsafe call");
 97   assert (!is_optimized() || cache == NULL, "an optimized virtual call does not have a cached metadata");
 98   assert (cache == NULL || cache != (Metadata*)badOopVal, "invalid metadata");
 99 
100   assert(!is_icholder || is_icholder_entry(entry_point), "must be");
101 
102   // Don't use ic_destination for this test since that forwards
103   // through ICBuffer instead of returning the actual current state of
104   // the CompiledIC.
105   if (is_icholder_entry(_call->destination())) {
106     // When patching for the ICStub case the cached value isn't
107     // overwritten until the ICStub copied into the CompiledIC during
108     // the next safepoint.  Make sure that the CompiledICHolder* is
109     // marked for release at this point since it won't be identifiable
110     // once the entry point is overwritten.
111     InlineCacheBuffer::queue_for_release((CompiledICHolder*)get_data());
112   }
113 
114   if (TraceCompiledIC) {
115     tty->print("  ");
116     print_compiled_ic();
117     tty->print(" changing destination to " INTPTR_FORMAT, p2i(entry_point));
118     if (!is_optimized()) {
119       tty->print(" changing cached %s to " INTPTR_FORMAT, is_icholder ? "icholder" : "metadata", p2i((address)cache));
120     }
121     if (is_icstub) {
122       tty->print(" (icstub)");
123     }
124     tty->cr();
125   }
126 
127   {
128     CodeBlob* cb = CodeCache::find_blob_unsafe(_call->instruction_address());
129     MutexLockerEx pl(CompiledICLocker::is_safe(cb->as_compiled_method()) ? NULL : Patching_lock, Mutex::_no_safepoint_check_flag);
130     assert(cb != NULL && cb->is_compiled(), "must be compiled");
131     _call->set_destination_mt_safe(entry_point);
132   }
133 
134   if (is_optimized() || is_icstub) {
135     // Optimized call sites don't have a cache value and ICStub call
136     // sites only change the entry point.  Changing the value in that
137     // case could lead to MT safety issues.
138     assert(cache == NULL, "must be null");
139     return;
140   }
141 
142   if (cache == NULL)  cache = (void*)Universe::non_oop_word();
143 
144   set_data((intptr_t)cache);
145 }
146 
147 
148 void CompiledIC::set_ic_destination(ICStub* stub) {
149   internal_set_ic_destination(stub->code_begin(), true, NULL, false);
150 }
151 
152 
153 
154 address CompiledIC::ic_destination() const {
155   assert(CompiledICLocker::is_safe(_method), "mt unsafe call");
156   if (!is_in_transition_state()) {
157     return _call->destination();
158   } else {
159     return InlineCacheBuffer::ic_destination_for((CompiledIC *)this);
160   }
161 }
162 
163 
164 bool CompiledIC::is_in_transition_state() const {
165   assert(CompiledICLocker::is_safe(_method), "mt unsafe call");
166   return InlineCacheBuffer::contains(_call->destination());;
167 }
168 
169 
170 bool CompiledIC::is_icholder_call() const {
171   assert(CompiledICLocker::is_safe(_method), "mt unsafe call");
172   return !_is_optimized && is_icholder_entry(ic_destination());
173 }
174 
175 // Returns native address of 'call' instruction in inline-cache. Used by
176 // the InlineCacheBuffer when it needs to find the stub.
177 address CompiledIC::stub_address() const {
178   assert(is_in_transition_state(), "should only be called when we are in a transition state");
179   return _call->destination();
180 }
181 
182 // Clears the IC stub if the compiled IC is in transition state
183 void CompiledIC::clear_ic_stub() {
184   if (is_in_transition_state()) {
185     ICStub* stub = ICStub_from_destination_address(stub_address());
186     stub->clear();
187   }
188 }
189 
190 //-----------------------------------------------------------------------------
191 // High-level access to an inline cache. Guaranteed to be MT-safe.
192 
193 void CompiledIC::initialize_from_iter(RelocIterator* iter) {
194   assert(iter->addr() == _call->instruction_address(), "must find ic_call");
195 
196   if (iter->type() == relocInfo::virtual_call_type) {
197     virtual_call_Relocation* r = iter->virtual_call_reloc();
198     _is_optimized = false;
199     _value = _call->get_load_instruction(r);
200   } else {
201     assert(iter->type() == relocInfo::opt_virtual_call_type, "must be a virtual call");
202     _is_optimized = true;
203     _value = NULL;
204   }
205 }
206 
207 CompiledIC::CompiledIC(CompiledMethod* cm, NativeCall* call)
208   : _method(cm)
209 {
210   _call = _method->call_wrapper_at((address) call);
211   address ic_call = _call->instruction_address();
212 
213   assert(ic_call != NULL, "ic_call address must be set");
214   assert(cm != NULL, "must pass compiled method");
215   assert(cm->contains(ic_call), "must be in compiled method");
216 
217   // Search for the ic_call at the given address.
218   RelocIterator iter(cm, ic_call, ic_call+1);
219   bool ret = iter.next();
220   assert(ret == true, "relocInfo must exist at this address");
221   assert(iter.addr() == ic_call, "must find ic_call");
222 
223   initialize_from_iter(&iter);
224 }
225 
226 CompiledIC::CompiledIC(RelocIterator* iter)
227   : _method(iter->code())
228 {
229   _call = _method->call_wrapper_at(iter->addr());
230   address ic_call = _call->instruction_address();
231 
232   CompiledMethod* nm = iter->code();
233   assert(ic_call != NULL, "ic_call address must be set");
234   assert(nm != NULL, "must pass compiled method");
235   assert(nm->contains(ic_call), "must be in compiled method");
236 
237   initialize_from_iter(iter);
238 }
239 
240 bool CompiledIC::set_to_megamorphic(CallInfo* call_info, Bytecodes::Code bytecode, TRAPS) {
241   assert(CompiledICLocker::is_safe(_method), "mt unsafe call");
242   assert(!is_optimized(), "cannot set an optimized virtual call to megamorphic");
243   assert(is_call_to_compiled() || is_call_to_interpreted(), "going directly to megamorphic?");
244 
245   address entry;
246   if (call_info->call_kind() == CallInfo::itable_call) {
247     assert(bytecode == Bytecodes::_invokeinterface, "");
248     int itable_index = call_info->itable_index();
249     entry = VtableStubs::find_itable_stub(itable_index);
250     if (entry == NULL) {
251       return false;
252     }
253 #ifdef ASSERT
254     int index = call_info->resolved_method()->itable_index();
255     assert(index == itable_index, "CallInfo pre-computes this");
256     InstanceKlass* k = call_info->resolved_method()->method_holder();
257     assert(k->verify_itable_index(itable_index), "sanity check");
258 #endif //ASSERT
259     CompiledICHolder* holder = new CompiledICHolder(call_info->resolved_method()->method_holder(),
260                                                     call_info->resolved_klass(), false);
261     holder->claim();
262     InlineCacheBuffer::create_transition_stub(this, holder, entry);
263   } else {
264     assert(call_info->call_kind() == CallInfo::vtable_call, "either itable or vtable");
265     // Can be different than selected_method->vtable_index(), due to package-private etc.
266     int vtable_index = call_info->vtable_index();
267     assert(call_info->resolved_klass()->verify_vtable_index(vtable_index), "sanity check");
268     entry = VtableStubs::find_vtable_stub(vtable_index);
269     if (entry == NULL) {
270       return false;
271     }
272     InlineCacheBuffer::create_transition_stub(this, NULL, entry);
273   }
274 
275   if (TraceICs) {
276     ResourceMark rm;
277     assert(!call_info->selected_method().is_null(), "Unexpected null selected method");
278     tty->print_cr ("IC@" INTPTR_FORMAT ": to megamorphic %s entry: " INTPTR_FORMAT,
279                    p2i(instruction_address()), call_info->selected_method()->print_value_string(), p2i(entry));
280   }
281 
282   // We can't check this anymore. With lazy deopt we could have already
283   // cleaned this IC entry before we even return. This is possible if
284   // we ran out of space in the inline cache buffer trying to do the
285   // set_next and we safepointed to free up space. This is a benign
286   // race because the IC entry was complete when we safepointed so
287   // cleaning it immediately is harmless.
288   // assert(is_megamorphic(), "sanity check");
289   return true;
290 }
291 
292 
293 // true if destination is megamorphic stub
294 bool CompiledIC::is_megamorphic() const {
295   assert(CompiledICLocker::is_safe(_method), "mt unsafe call");
296   assert(!is_optimized(), "an optimized call cannot be megamorphic");
297 
298   // Cannot rely on cached_value. It is either an interface or a method.
299   return VtableStubs::entry_point(ic_destination()) != NULL;
300 }
301 
302 bool CompiledIC::is_call_to_compiled() const {
303   assert(CompiledICLocker::is_safe(_method), "mt unsafe call");
304 
305   // Use unsafe, since an inline cache might point to a zombie method. However, the zombie
306   // method is guaranteed to still exist, since we only remove methods after all inline caches
307   // has been cleaned up
308   CodeBlob* cb = CodeCache::find_blob_unsafe(ic_destination());
309   bool is_monomorphic = (cb != NULL && cb->is_compiled());
310   // Check that the cached_value is a klass for non-optimized monomorphic calls
311   // This assertion is invalid for compiler1: a call that does not look optimized (no static stub) can be used
312   // for calling directly to vep without using the inline cache (i.e., cached_value == NULL).
313   // For JVMCI this occurs because CHA is only used to improve inlining so call sites which could be optimized
314   // virtuals because there are no currently loaded subclasses of a type are left as virtual call sites.
315 #ifdef ASSERT
316   CodeBlob* caller = CodeCache::find_blob_unsafe(instruction_address());
317   bool is_c1_or_jvmci_method = caller->is_compiled_by_c1() || caller->is_compiled_by_jvmci();
318   assert( is_c1_or_jvmci_method ||
319          !is_monomorphic ||
320          is_optimized() ||
321          !caller->is_alive() ||
322          (cached_metadata() != NULL && cached_metadata()->is_klass()), "sanity check");
323 #endif // ASSERT
324   return is_monomorphic;
325 }
326 
327 
328 bool CompiledIC::is_call_to_interpreted() const {
329   assert(CompiledICLocker::is_safe(_method), "mt unsafe call");
330   // Call to interpreter if destination is either calling to a stub (if it
331   // is optimized), or calling to an I2C blob
332   bool is_call_to_interpreted = false;
333   if (!is_optimized()) {
334     // must use unsafe because the destination can be a zombie (and we're cleaning)
335     // and the print_compiled_ic code wants to know if site (in the non-zombie)
336     // is to the interpreter.
337     CodeBlob* cb = CodeCache::find_blob_unsafe(ic_destination());
338     is_call_to_interpreted = (cb != NULL && cb->is_adapter_blob());
339     assert(!is_call_to_interpreted || (is_icholder_call() && cached_icholder() != NULL), "sanity check");
340   } else {
341     // Check if we are calling into our own codeblob (i.e., to a stub)
342     address dest = ic_destination();
343 #ifdef ASSERT
344     {
345       _call->verify_resolve_call(dest);
346     }
347 #endif /* ASSERT */
348     is_call_to_interpreted = _call->is_call_to_interpreted(dest);
349   }
350   return is_call_to_interpreted;
351 }
352 
353 void CompiledIC::set_to_clean(bool in_use) {
354   assert(CompiledICLocker::is_safe(_method), "mt unsafe call");
355   if (TraceInlineCacheClearing || TraceICs) {
356     tty->print_cr("IC@" INTPTR_FORMAT ": set to clean", p2i(instruction_address()));
357     print();
358   }
359 
360   address entry = _call->get_resolve_call_stub(is_optimized());
361 
362   // A zombie transition will always be safe, since the metadata has already been set to NULL, so
363   // we only need to patch the destination
364   bool safe_transition = _call->is_safe_for_patching() || !in_use || is_optimized() || CompiledICLocker::is_safe(_method);
365 
366   if (safe_transition) {
367     // Kill any leftover stub we might have too
368     clear_ic_stub();
369     if (is_optimized()) {
370       set_ic_destination(entry);
371     } else {
372       set_ic_destination_and_value(entry, (void*)NULL);
373     }
374   } else {
375     // Unsafe transition - create stub.
376     InlineCacheBuffer::create_transition_stub(this, NULL, entry);
377   }
378   // We can't check this anymore. With lazy deopt we could have already
379   // cleaned this IC entry before we even return. This is possible if
380   // we ran out of space in the inline cache buffer trying to do the
381   // set_next and we safepointed to free up space. This is a benign
382   // race because the IC entry was complete when we safepointed so
383   // cleaning it immediately is harmless.
384   // assert(is_clean(), "sanity check");
385 }
386 
387 bool CompiledIC::is_clean() const {
388   assert(CompiledICLocker::is_safe(_method), "mt unsafe call");
389   bool is_clean = false;
390   address dest = ic_destination();
391   is_clean = dest == _call->get_resolve_call_stub(is_optimized());
392   assert(!is_clean || is_optimized() || cached_value() == NULL, "sanity check");
393   return is_clean;
394 }
395 
396 void CompiledIC::set_to_monomorphic(CompiledICInfo& info) {
397   assert(CompiledICLocker::is_safe(_method), "mt unsafe call");
398   // Updating a cache to the wrong entry can cause bugs that are very hard
399   // to track down - if cache entry gets invalid - we just clean it. In
400   // this way it is always the same code path that is responsible for
401   // updating and resolving an inline cache
402   //
403   // The above is no longer true. SharedRuntime::fixup_callers_callsite will change optimized
404   // callsites. In addition ic_miss code will update a site to monomorphic if it determines
405   // that an monomorphic call to the interpreter can now be monomorphic to compiled code.
406   //
407   // In both of these cases the only thing being modifed is the jump/call target and these
408   // transitions are mt_safe
409 
410   Thread *thread = Thread::current();
411   if (info.to_interpreter() || info.to_aot()) {
412     // Call to interpreter
413     if (info.is_optimized() && is_optimized()) {
414        assert(is_clean(), "unsafe IC path");
415        MutexLockerEx pl(Patching_lock, Mutex::_no_safepoint_check_flag);
416       // the call analysis (callee structure) specifies that the call is optimized
417       // (either because of CHA or the static target is final)
418       // At code generation time, this call has been emitted as static call
419       // Call via stub
420       assert(info.cached_metadata() != NULL && info.cached_metadata()->is_method(), "sanity check");
421       methodHandle method (thread, (Method*)info.cached_metadata());
422       _call->set_to_interpreted(method, info);
423 
424       if (TraceICs) {
425          ResourceMark rm(thread);
426          tty->print_cr ("IC@" INTPTR_FORMAT ": monomorphic to %s: %s",
427            p2i(instruction_address()),
428            (info.to_aot() ? "aot" : "interpreter"),
429            method->print_value_string());
430       }
431     } else {
432       // Call via method-klass-holder
433       InlineCacheBuffer::create_transition_stub(this, info.claim_cached_icholder(), info.entry());
434       if (TraceICs) {
435          ResourceMark rm(thread);
436          tty->print_cr ("IC@" INTPTR_FORMAT ": monomorphic to interpreter via icholder ", p2i(instruction_address()));
437       }
438     }
439   } else {
440     // Call to compiled code
441     bool static_bound = info.is_optimized() || (info.cached_metadata() == NULL);
442 #ifdef ASSERT
443     CodeBlob* cb = CodeCache::find_blob_unsafe(info.entry());
444     assert (cb != NULL && cb->is_compiled(), "must be compiled!");
445 #endif /* ASSERT */
446 
447     // This is MT safe if we come from a clean-cache and go through a
448     // non-verified entry point
449     bool safe = SafepointSynchronize::is_at_safepoint() ||
450                 (!is_in_transition_state() && (info.is_optimized() || static_bound || is_clean()));
451 
452     if (!safe) {
453       InlineCacheBuffer::create_transition_stub(this, info.cached_metadata(), info.entry());
454     } else {
455       if (is_optimized()) {
456         set_ic_destination(info.entry());
457       } else {
458         set_ic_destination_and_value(info.entry(), info.cached_metadata());
459       }
460     }
461 
462     if (TraceICs) {
463       ResourceMark rm(thread);
464       assert(info.cached_metadata() == NULL || info.cached_metadata()->is_klass(), "must be");
465       tty->print_cr ("IC@" INTPTR_FORMAT ": monomorphic to compiled (rcvr klass) %s: %s",
466         p2i(instruction_address()),
467         ((Klass*)info.cached_metadata())->print_value_string(),
468         (safe) ? "" : "via stub");
469     }
470   }
471   // We can't check this anymore. With lazy deopt we could have already
472   // cleaned this IC entry before we even return. This is possible if
473   // we ran out of space in the inline cache buffer trying to do the
474   // set_next and we safepointed to free up space. This is a benign
475   // race because the IC entry was complete when we safepointed so
476   // cleaning it immediately is harmless.
477   // assert(is_call_to_compiled() || is_call_to_interpreted(), "sanity check");
478 }
479 
480 
481 // is_optimized: Compiler has generated an optimized call (i.e. fixed, no inline cache)
482 // static_bound: The call can be static bound. If it isn't also optimized, the property
483 // wasn't provable at time of compilation. An optimized call will have any necessary
484 // null check, while a static_bound won't. A static_bound (but not optimized) must
485 // therefore use the unverified entry point.
486 void CompiledIC::compute_monomorphic_entry(const methodHandle& method,
487                                            Klass* receiver_klass,
488                                            bool is_optimized,
489                                            bool static_bound,
490                                            bool caller_is_nmethod,
491                                            CompiledICInfo& info,
492                                            TRAPS) {
493   CompiledMethod* method_code = method->code();
494 
495   address entry = NULL;
496   if (method_code != NULL && method_code->is_in_use()) {
497     assert(method_code->is_compiled(), "must be compiled");
498     // Call to compiled code
499     //
500     // Note: the following problem exists with Compiler1:
501     //   - at compile time we may or may not know if the destination is final
502     //   - if we know that the destination is final (is_optimized), we will emit
503     //     an optimized virtual call (no inline cache), and need a Method* to make
504     //     a call to the interpreter
505     //   - if we don't know if the destination is final, we emit a standard
506     //     virtual call, and use CompiledICHolder to call interpreted code
507     //     (no static call stub has been generated)
508     //   - In the case that we here notice the call is static bound we
509     //     convert the call into what looks to be an optimized virtual call,
510     //     but we must use the unverified entry point (since there will be no
511     //     null check on a call when the target isn't loaded).
512     //     This causes problems when verifying the IC because
513     //     it looks vanilla but is optimized. Code in is_call_to_interpreted
514     //     is aware of this and weakens its asserts.
515     if (is_optimized) {
516       entry      = method_code->verified_entry_point();
517     } else {
518       entry      = method_code->entry_point();
519     }
520   }
521   bool far_c2a = entry != NULL && caller_is_nmethod && method_code->is_far_code();
522   if (entry != NULL && !far_c2a) {
523     // Call to near compiled code (nmethod or aot).
524     info.set_compiled_entry(entry, is_optimized ? NULL : receiver_klass, is_optimized);
525   } else {
526     if (is_optimized) {
527       if (far_c2a) {
528         // Call to aot code from nmethod.
529         info.set_aot_entry(entry, method());
530       } else {
531         // Use stub entry
532         info.set_interpreter_entry(method()->get_c2i_entry(), method());
533       }
534     } else {
535       // Use icholder entry
536       assert(method_code == NULL || method_code->is_compiled(), "must be compiled");
537       CompiledICHolder* holder = new CompiledICHolder(method(), receiver_klass);
538       info.set_icholder_entry(method()->get_c2i_unverified_entry(), holder);
539     }
540   }
541   assert(info.is_optimized() == is_optimized, "must agree");
542 }
543 
544 
545 bool CompiledIC::is_icholder_entry(address entry) {
546   CodeBlob* cb = CodeCache::find_blob_unsafe(entry);
547   if (cb != NULL && cb->is_adapter_blob()) {
548     return true;
549   }
550   // itable stubs also use CompiledICHolder
551   if (cb != NULL && cb->is_vtable_blob()) {
552     VtableStub* s = VtableStubs::entry_point(entry);
553     return (s != NULL) && s->is_itable_stub();
554   }
555 
556   return false;
557 }
558 
559 bool CompiledIC::is_icholder_call_site(virtual_call_Relocation* call_site, const CompiledMethod* cm) {
560   // This call site might have become stale so inspect it carefully.
561   address dest = cm->call_wrapper_at(call_site->addr())->destination();
562   return is_icholder_entry(dest);
563 }
564 
565 // Release the CompiledICHolder* associated with this call site is there is one.
566 void CompiledIC::cleanup_call_site(virtual_call_Relocation* call_site, const CompiledMethod* cm) {
567   assert(cm->is_nmethod(), "must be nmethod");
568   // This call site might have become stale so inspect it carefully.
569   NativeCall* call = nativeCall_at(call_site->addr());
570   if (is_icholder_entry(call->destination())) {
571     NativeMovConstReg* value = nativeMovConstReg_at(call_site->cached_value());
572     InlineCacheBuffer::queue_for_release((CompiledICHolder*)value->data());
573   }
574 }
575 
576 // ----------------------------------------------------------------------------
577 
578 void CompiledStaticCall::set_to_clean(bool in_use) {
579   // in_use is unused but needed to match template function in CompiledMethod
580   assert(CompiledICLocker::is_safe(instruction_address()), "mt unsafe call");
581   // Reset call site
582   MutexLockerEx pl(SafepointSynchronize::is_at_safepoint() ? NULL : Patching_lock, Mutex::_no_safepoint_check_flag);
583   set_destination_mt_safe(resolve_call_stub());
584 
585   // Do not reset stub here:  It is too expensive to call find_stub.
586   // Instead, rely on caller (nmethod::clear_inline_caches) to clear
587   // both the call and its stub.
588 }
589 
590 bool CompiledStaticCall::is_clean() const {
591   return destination() == resolve_call_stub();
592 }
593 
594 bool CompiledStaticCall::is_call_to_compiled() const {
595   return CodeCache::contains(destination());
596 }
597 
598 bool CompiledDirectStaticCall::is_call_to_interpreted() const {
599   // It is a call to interpreted, if it calls to a stub. Hence, the destination
600   // must be in the stub part of the nmethod that contains the call
601   CompiledMethod* cm = CodeCache::find_compiled(instruction_address());
602   return cm->stub_contains(destination());
603 }
604 
605 bool CompiledDirectStaticCall::is_call_to_far() const {
606   // It is a call to aot method, if it calls to a stub. Hence, the destination
607   // must be in the stub part of the nmethod that contains the call
608   CodeBlob* desc = CodeCache::find_blob(instruction_address());
609   return desc->as_compiled_method()->stub_contains(destination());
610 }
611 
612 void CompiledStaticCall::set_to_compiled(address entry) {
613   if (TraceICs) {
614     ResourceMark rm;
615     tty->print_cr("%s@" INTPTR_FORMAT ": set_to_compiled " INTPTR_FORMAT,
616         name(),
617         p2i(instruction_address()),
618         p2i(entry));
619   }
620   // Call to compiled code
621   assert(CodeCache::contains(entry), "wrong entry point");
622   set_destination_mt_safe(entry);
623 }
624 
625 void CompiledStaticCall::set(const StaticCallInfo& info) {
626   assert(CompiledICLocker::is_safe(instruction_address()), "mt unsafe call");
627   MutexLockerEx pl(Patching_lock, Mutex::_no_safepoint_check_flag);
628   // Updating a cache to the wrong entry can cause bugs that are very hard
629   // to track down - if cache entry gets invalid - we just clean it. In
630   // this way it is always the same code path that is responsible for
631   // updating and resolving an inline cache
632   assert(is_clean(), "do not update a call entry - use clean");
633 
634   if (info._to_interpreter) {
635     // Call to interpreted code
636     set_to_interpreted(info.callee(), info.entry());
637 #if INCLUDE_AOT
638   } else if (info._to_aot) {
639     // Call to far code
640     set_to_far(info.callee(), info.entry());
641 #endif
642   } else {
643     set_to_compiled(info.entry());
644   }
645 }
646 
647 // Compute settings for a CompiledStaticCall. Since we might have to set
648 // the stub when calling to the interpreter, we need to return arguments.
649 void CompiledStaticCall::compute_entry(const methodHandle& m, bool caller_is_nmethod, StaticCallInfo& info) {
650   CompiledMethod* m_code = m->code();
651   info._callee = m;
652   if (m_code != NULL && m_code->is_in_use()) {
653     if (caller_is_nmethod && m_code->is_far_code()) {
654       // Call to far aot code from nmethod.
655       info._to_aot = true;
656     } else {
657       info._to_aot = false;
658     }
659     info._to_interpreter = false;
660     info._entry  = m_code->verified_entry_point();
661   } else {
662     // Callee is interpreted code.  In any case entering the interpreter
663     // puts a converter-frame on the stack to save arguments.
664     assert(!m->is_method_handle_intrinsic(), "Compiled code should never call interpreter MH intrinsics");
665     info._to_interpreter = true;
666     info._entry      = m()->get_c2i_entry();
667   }
668 }
669 
670 address CompiledDirectStaticCall::find_stub_for(address instruction, bool is_aot) {
671   // Find reloc. information containing this call-site
672   RelocIterator iter((nmethod*)NULL, instruction);
673   while (iter.next()) {
674     if (iter.addr() == instruction) {
675       switch(iter.type()) {
676         case relocInfo::static_call_type:
677           return iter.static_call_reloc()->static_stub(is_aot);
678         // We check here for opt_virtual_call_type, since we reuse the code
679         // from the CompiledIC implementation
680         case relocInfo::opt_virtual_call_type:
681           return iter.opt_virtual_call_reloc()->static_stub(is_aot);
682         case relocInfo::poll_type:
683         case relocInfo::poll_return_type: // A safepoint can't overlap a call.
684         default:
685           ShouldNotReachHere();
686       }
687     }
688   }
689   return NULL;
690 }
691 
692 address CompiledDirectStaticCall::find_stub(bool is_aot) {
693   return CompiledDirectStaticCall::find_stub_for(instruction_address(), is_aot);
694 }
695 
696 address CompiledDirectStaticCall::resolve_call_stub() const {
697   return SharedRuntime::get_resolve_static_call_stub();
698 }
699 
700 //-----------------------------------------------------------------------------
701 // Non-product mode code
702 #ifndef PRODUCT
703 
704 void CompiledIC::verify() {
705   _call->verify();
706   assert(is_clean() || is_call_to_compiled() || is_call_to_interpreted()
707           || is_optimized() || is_megamorphic(), "sanity check");
708 }
709 
710 void CompiledIC::print() {
711   print_compiled_ic();
712   tty->cr();
713 }
714 
715 void CompiledIC::print_compiled_ic() {
716   tty->print("Inline cache at " INTPTR_FORMAT ", calling %s " INTPTR_FORMAT " cached_value " INTPTR_FORMAT,
717              p2i(instruction_address()), is_call_to_interpreted() ? "interpreted " : "", p2i(ic_destination()), p2i(is_optimized() ? NULL : cached_value()));
718 }
719 
720 void CompiledDirectStaticCall::print() {
721   tty->print("static call at " INTPTR_FORMAT " -> ", p2i(instruction_address()));
722   if (is_clean()) {
723     tty->print("clean");
724   } else if (is_call_to_compiled()) {
725     tty->print("compiled");
726   } else if (is_call_to_far()) {
727     tty->print("far");
728   } else if (is_call_to_interpreted()) {
729     tty->print("interpreted");
730   }
731   tty->cr();
732 }
733 
734 #endif // !PRODUCT