1 /*
  2  * Copyright (c) 2016, 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 #include "precompiled.hpp"
 25 
 26 #include "aot/aotCodeHeap.hpp"
 27 #include "aot/aotLoader.hpp"
 28 #include "aot/compiledIC_aot.hpp"
 29 #include "code/codeCache.hpp"
 30 #include "code/compiledIC.hpp"
 31 #include "code/nativeInst.hpp"
 32 #include "compiler/compilerOracle.hpp"
 33 #include "gc/shared/cardTableModRefBS.hpp"
 34 #include "gc/shared/collectedHeap.hpp"
 35 #include "gc/shared/gcLocker.hpp"
 36 #include "jvmci/compilerRuntime.hpp"
 37 #include "jvmci/jvmciRuntime.hpp"
 38 #include "oops/method.inline.hpp"
 39 #include "runtime/handles.inline.hpp"
 40 #include "runtime/java.hpp"
 41 #include "runtime/os.hpp"
 42 #include "runtime/sharedRuntime.hpp"
 43 #include "utilities/xmlstream.hpp"
 44 
 45 #include <stdio.h>
 46 
 47 #if 0
 48 static void metadata_oops_do(Metadata** metadata_begin, Metadata **metadata_end, OopClosure* f) {
 49   // Visit the metadata/oops section
 50   for (Metadata** p = metadata_begin; p < metadata_end; p++) {
 51     Metadata* m = *p;
 52 
 53     intptr_t meta = (intptr_t)m;
 54     if ((meta & 1) == 1) {
 55       // already resolved
 56       m = (Metadata*)(meta & ~1);
 57     } else {
 58       continue;
 59     }
 60     assert(Metaspace::contains(m), "");
 61     if (m->is_method()) {
 62       m = ((Method*)m)->method_holder();
 63     }
 64     assert(m->is_klass(), "must be");
 65     oop o = ((Klass*)m)->klass_holder();
 66     if (o != NULL) {
 67       f->do_oop(&o);
 68     }
 69   }
 70 }
 71 #endif
 72 
 73 bool AOTCompiledMethod::do_unloading_oops(address low_boundary, BoolObjectClosure* is_alive, bool unloading_occurred) {
 74   return false;
 75 }
 76 
 77 oop AOTCompiledMethod::oop_at(int index) const {
 78   if (index == 0) { // 0 is reserved
 79     return NULL;
 80   }
 81   Metadata** entry = _metadata_got + (index - 1);
 82   intptr_t meta = (intptr_t)*entry;
 83   if ((meta & 1) == 1) {
 84     // already resolved
 85     Klass* k = (Klass*)(meta & ~1);
 86     return k->java_mirror();
 87   }
 88   // The entry is string which we need to resolve.
 89   const char* meta_name = _heap->get_name_at((int)meta);
 90   int klass_len = build_u2_from((address)meta_name);
 91   const char* klass_name = meta_name + 2;
 92   // Quick check the current method's holder.
 93   Klass* k = _method->method_holder();
 94 
 95   ResourceMark rm; // for signature_name()
 96   if (strncmp(k->signature_name(), klass_name, klass_len) != 0) { // Does not match?
 97     // Search klass in got cells in DSO which have this compiled method.
 98     k = _heap->get_klass_from_got(klass_name, klass_len, _method);
 99   }
100   int method_name_len = build_u2_from((address)klass_name + klass_len);
101   guarantee(method_name_len == 0, "only klass is expected here");
102   meta = ((intptr_t)k) | 1;
103   *entry = (Metadata*)meta; // Should be atomic on x64
104   return k->java_mirror();
105 }
106 
107 Metadata* AOTCompiledMethod::metadata_at(int index) const {
108   if (index == 0) { // 0 is reserved
109     return NULL;
110   }
111   assert(index - 1 < _metadata_size, "");
112   {
113     Metadata** entry = _metadata_got + (index - 1);
114     intptr_t meta = (intptr_t)*entry;
115     if ((meta & 1) == 1) {
116       // already resolved
117       Metadata *m = (Metadata*)(meta & ~1);
118       return m;
119     }
120     // The entry is string which we need to resolve.
121     const char* meta_name = _heap->get_name_at((int)meta);
122     int klass_len = build_u2_from((address)meta_name);
123     const char* klass_name = meta_name + 2;
124     // Quick check the current method's holder.
125     Klass* k = _method->method_holder();
126     bool klass_matched = true;
127 
128     ResourceMark rm; // for signature_name() and find_method()
129     if (strncmp(k->signature_name(), klass_name, klass_len) != 0) { // Does not match?
130       // Search klass in got cells in DSO which have this compiled method.
131       k = _heap->get_klass_from_got(klass_name, klass_len, _method);
132       klass_matched = false;
133     }
134     int method_name_len = build_u2_from((address)klass_name + klass_len);
135     if (method_name_len == 0) { // Array or Klass name only?
136       meta = ((intptr_t)k) | 1;
137       *entry = (Metadata*)meta; // Should be atomic on x64
138       return (Metadata*)k;
139     } else { // Method
140       // Quick check the current method's name.
141       Method* m = _method;
142       int signature_len = build_u2_from((address)klass_name + klass_len + 2 + method_name_len);
143       int full_len = 2 + klass_len + 2 + method_name_len + 2 + signature_len;
144       if (!klass_matched || memcmp(_name, meta_name, full_len) != 0) { // Does not match?
145         Thread* thread = Thread::current();
146         const char* method_name = klass_name + klass_len;
147         m = AOTCodeHeap::find_method(k, thread, method_name);
148       }
149       meta = ((intptr_t)m) | 1;
150       *entry = (Metadata*)meta; // Should be atomic on x64
151       return (Metadata*)m;
152     }
153   }
154   ShouldNotReachHere(); return NULL;
155 }
156 
157 bool AOTCompiledMethod::make_not_entrant_helper(int new_state) {
158   // Make sure the method is not flushed in case of a safepoint in code below.
159   methodHandle the_method(method());
160   NoSafepointVerifier nsv;
161 
162   {
163     // Enter critical section.  Does not block for safepoint.
164     MutexLockerEx pl(Patching_lock, Mutex::_no_safepoint_check_flag);
165 
166     if (*_state_adr == new_state) {
167       // another thread already performed this transition so nothing
168       // to do, but return false to indicate this.
169       return false;
170     }
171 
172     // Change state
173     OrderAccess::storestore();
174     *_state_adr = new_state;
175 
176     // Log the transition once
177     log_state_change();
178 
179 #ifdef TIERED
180     // Remain non-entrant forever
181     if (new_state == not_entrant && method() != NULL) {
182         method()->set_aot_code(NULL);
183     }
184 #endif
185 
186     // Remove AOTCompiledMethod from method.
187     if (method() != NULL && (method()->code() == this ||
188                              method()->from_compiled_entry() == verified_entry_point())) {
189       HandleMark hm;
190       method()->clear_code(false /* already owns Patching_lock */);
191     }
192   } // leave critical region under Patching_lock
193 
194 
195   if (TraceCreateZombies) {
196     ResourceMark m;
197     const char *new_state_str = (new_state == not_entrant) ? "not entrant" : "not used";
198     tty->print_cr("aot method <" INTPTR_FORMAT "> %s code made %s", p2i(this), this->method() ? this->method()->name_and_sig_as_C_string() : "null", new_state_str);
199   }
200 
201   return true;
202 }
203 
204 bool AOTCompiledMethod::make_entrant() {
205   assert(!method()->is_old(), "reviving evolved method!");
206   assert(*_state_adr != not_entrant, "%s", method()->has_aot_code() ? "has_aot_code() not cleared" : "caller didn't check has_aot_code()");
207 
208   // Make sure the method is not flushed in case of a safepoint in code below.
209   methodHandle the_method(method());
210   NoSafepointVerifier nsv;
211 
212   {
213     // Enter critical section.  Does not block for safepoint.
214     MutexLockerEx pl(Patching_lock, Mutex::_no_safepoint_check_flag);
215 
216     if (*_state_adr == in_use) {
217       // another thread already performed this transition so nothing
218       // to do, but return false to indicate this.
219       return false;
220     }
221 
222     // Change state
223     OrderAccess::storestore();
224     *_state_adr = in_use;
225 
226     // Log the transition once
227     log_state_change();
228   } // leave critical region under Patching_lock
229 
230 
231   if (TraceCreateZombies) {
232     ResourceMark m;
233     tty->print_cr("aot method <" INTPTR_FORMAT "> %s code made entrant", p2i(this), this->method() ? this->method()->name_and_sig_as_C_string() : "null");
234   }
235 
236   return true;
237 }
238 
239 // We don't have full dependencies for AOT methods, so flushing is
240 // more conservative than for nmethods.
241 void AOTCompiledMethod::flush_evol_dependents_on(InstanceKlass* dependee) {
242   if (is_java_method()) {
243     cleanup_inline_caches();
244     mark_for_deoptimization();
245     make_not_entrant();
246   }
247 }
248 
249 // Iterate over metadata calling this function.   Used by RedefineClasses
250 // Copied from nmethod::metadata_do
251 void AOTCompiledMethod::metadata_do(void f(Metadata*)) {
252   address low_boundary = verified_entry_point();
253   {
254     // Visit all immediate references that are embedded in the instruction stream.
255     RelocIterator iter(this, low_boundary);
256     while (iter.next()) {
257       if (iter.type() == relocInfo::metadata_type ) {
258         metadata_Relocation* r = iter.metadata_reloc();
259         // In this metadata, we must only follow those metadatas directly embedded in
260         // the code.  Other metadatas (oop_index>0) are seen as part of
261         // the metadata section below.
262         assert(1 == (r->metadata_is_immediate()) +
263                (r->metadata_addr() >= metadata_begin() && r->metadata_addr() < metadata_end()),
264                "metadata must be found in exactly one place");
265         if (r->metadata_is_immediate() && r->metadata_value() != NULL) {
266           Metadata* md = r->metadata_value();
267           if (md != _method) f(md);
268         }
269       } else if (iter.type() == relocInfo::virtual_call_type) {
270         // Check compiledIC holders associated with this nmethod
271         CompiledIC *ic = CompiledIC_at(&iter);
272         if (ic->is_icholder_call()) {
273           CompiledICHolder* cichk = ic->cached_icholder();
274           f(cichk->holder_metadata());
275           f(cichk->holder_klass());
276         } else {
277           // Get Klass* or NULL (if value is -1) from GOT cell of virtual call PLT stub.
278           Metadata* ic_oop = ic->cached_metadata();
279           if (ic_oop != NULL) {
280             f(ic_oop);
281           }
282         }
283       } else if (iter.type() == relocInfo::static_call_type ||
284                  iter.type() == relocInfo::opt_virtual_call_type){
285         // Check Method* in AOT c2i stub for other calls.
286         Metadata* meta = (Metadata*)nativeLoadGot_at(nativePltCall_at(iter.addr())->plt_c2i_stub())->data();
287         if (meta != NULL) {
288           f(meta);
289         }
290       }
291     }
292   }
293 
294   // Visit the metadata section
295   for (Metadata** p = metadata_begin(); p < metadata_end(); p++) {
296     Metadata* m = *p;
297 
298     intptr_t meta = (intptr_t)m;
299     if ((meta & 1) == 1) {
300       // already resolved
301       m = (Metadata*)(meta & ~1);
302     } else {
303       continue;
304     }
305     assert(Metaspace::contains(m), "");
306     f(m);
307   }
308 
309   // Visit metadata not embedded in the other places.
310   if (_method != NULL) f(_method);
311 }
312 
313 void AOTCompiledMethod::print() const {
314   print_on(tty, "AOTCompiledMethod");
315 }
316 
317 void AOTCompiledMethod::print_on(outputStream* st) const {
318   print_on(st, "AOTCompiledMethod");
319 }
320 
321 // Print out more verbose output usually for a newly created aot method.
322 void AOTCompiledMethod::print_on(outputStream* st, const char* msg) const {
323   if (st != NULL) {
324     ttyLocker ttyl;
325     st->print("%7d ", (int) st->time_stamp().milliseconds());
326     st->print("%4d ", _aot_id);    // print compilation number
327     st->print("    aot[%2d]", _heap->dso_id());
328     // Stubs have _method == NULL
329     if (_method == NULL) {
330       st->print("   %s", _name);
331     } else {
332       ResourceMark m;
333       st->print("   %s", _method->name_and_sig_as_C_string());
334     }
335     if (Verbose) {
336       st->print(" entry at " INTPTR_FORMAT, p2i(_code));
337     }
338     if (msg != NULL) {
339       st->print("   %s", msg);
340     }
341     st->cr();
342   }
343 }
344 
345 void AOTCompiledMethod::print_value_on(outputStream* st) const {
346   st->print("AOTCompiledMethod ");
347   print_on(st, NULL);
348 }
349 
350 // Print a short set of xml attributes to identify this aot method.  The
351 // output should be embedded in some other element.
352 void AOTCompiledMethod::log_identity(xmlStream* log) const {
353   log->print(" aot_id='%d'", _aot_id);
354   log->print(" aot='%2d'", _heap->dso_id());
355 }
356 
357 void AOTCompiledMethod::log_state_change() const {
358   if (LogCompilation) {
359     ResourceMark m;
360     if (xtty != NULL) {
361       ttyLocker ttyl;  // keep the following output all in one block
362       if (*_state_adr == not_entrant) {
363         xtty->begin_elem("make_not_entrant thread='" UINTX_FORMAT "'",
364                          os::current_thread_id());
365       } else if (*_state_adr == not_used) {
366         xtty->begin_elem("make_not_used thread='" UINTX_FORMAT "'",
367                          os::current_thread_id());
368       } else if (*_state_adr == in_use) {
369         xtty->begin_elem("make_entrant thread='" UINTX_FORMAT "'",
370                          os::current_thread_id());
371       }
372       log_identity(xtty);
373       xtty->stamp();
374       xtty->end_elem();
375     }
376   }
377   if (PrintCompilation) {
378     ResourceMark m;
379     if (*_state_adr == not_entrant) {
380       print_on(tty, "made not entrant");
381     } else if (*_state_adr == not_used) {
382       print_on(tty, "made not used");
383     } else if (*_state_adr == in_use) {
384       print_on(tty, "made entrant");
385     }
386   }
387 }
388 
389 
390 NativeInstruction* PltNativeCallWrapper::get_load_instruction(virtual_call_Relocation* r) const {
391   return nativeLoadGot_at(_call->plt_load_got());
392 }
393 
394 void PltNativeCallWrapper::verify_resolve_call(address dest) const {
395   CodeBlob* db = CodeCache::find_blob_unsafe(dest);
396   if (db == NULL) {
397     assert(dest == _call->plt_resolve_call(), "sanity");
398   }
399 }
400 
401 void PltNativeCallWrapper::set_to_interpreted(const methodHandle& method, CompiledICInfo& info) {
402   assert(!info.to_aot(), "only for nmethod");
403   CompiledPltStaticCall* csc = CompiledPltStaticCall::at(instruction_address());
404   csc->set_to_interpreted(method, info.entry());
405 }
406 
407 NativeCallWrapper* AOTCompiledMethod::call_wrapper_at(address call) const {
408   return new PltNativeCallWrapper((NativePltCall*) call);
409 }
410 
411 NativeCallWrapper* AOTCompiledMethod::call_wrapper_before(address return_pc) const {
412   return new PltNativeCallWrapper(nativePltCall_before(return_pc));
413 }
414 
415 CompiledStaticCall* AOTCompiledMethod::compiledStaticCall_at(Relocation* call_site) const {
416   return CompiledPltStaticCall::at(call_site);
417 }
418 
419 CompiledStaticCall* AOTCompiledMethod::compiledStaticCall_at(address call_site) const {
420   return CompiledPltStaticCall::at(call_site);
421 }
422 
423 CompiledStaticCall* AOTCompiledMethod::compiledStaticCall_before(address return_addr) const {
424   return CompiledPltStaticCall::before(return_addr);
425 }
426 
427 address AOTCompiledMethod::call_instruction_address(address pc) const {
428   NativePltCall* pltcall = nativePltCall_before(pc);
429   return pltcall->instruction_address();
430 }
431 
432 bool AOTCompiledMethod::is_evol_dependent_on(Klass* dependee) {
433   return !is_aot_runtime_stub() && _heap->is_dependent_method(dependee, this);
434 }
435 
436 void AOTCompiledMethod::clear_inline_caches() {
437   assert(SafepointSynchronize::is_at_safepoint(), "cleaning of IC's only allowed at safepoint");
438   if (is_zombie()) {
439     return;
440   }
441 
442   RelocIterator iter(this);
443   while (iter.next()) {
444     iter.reloc()->clear_inline_cache();
445     if (iter.type() == relocInfo::opt_virtual_call_type) {
446       CompiledIC* cic = CompiledIC_at(&iter);
447       assert(cic->is_clean(), "!");
448       nativePltCall_at(iter.addr())->set_stub_to_clean();
449     }
450   }
451 }