1 /*
   2  * Copyright (c) 2016, 2017, 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.hpp"
  39 #include "runtime/java.hpp"
  40 #include "runtime/os.hpp"
  41 #include "runtime/sharedRuntime.hpp"
  42 #include "utilities/array.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 void AOTCompiledMethod::oops_do(OopClosure* f) {
  74   if (_oop != NULL) {
  75     f->do_oop(&_oop);
  76   }
  77 #if 0
  78   metadata_oops_do(metadata_begin(), metadata_end(), f);
  79 #endif
  80 }
  81 
  82 bool AOTCompiledMethod::do_unloading_oops(address low_boundary, BoolObjectClosure* is_alive, bool unloading_occurred) {
  83   return false;
  84 }
  85 
  86 oop AOTCompiledMethod::oop_at(int index) const {
  87   if (index == 0) { // 0 is reserved
  88     return NULL;
  89   }
  90   Metadata** entry = _metadata_got + (index - 1);
  91   intptr_t meta = (intptr_t)*entry;
  92   if ((meta & 1) == 1) {
  93     // already resolved
  94     Klass* k = (Klass*)(meta & ~1);
  95     return k->java_mirror();
  96   }
  97   // The entry is string which we need to resolve.
  98   const char* meta_name = _heap->get_name_at((int)meta);
  99   int klass_len = build_u2_from((address)meta_name);
 100   const char* klass_name = meta_name + 2;
 101   // Quick check the current method's holder.
 102   Klass* k = _method->method_holder();
 103 
 104   ResourceMark rm; // for signature_name()
 105   if (strncmp(k->signature_name(), klass_name, klass_len) != 0) { // Does not match?
 106     // Search klass in got cells in DSO which have this compiled method.
 107     k = _heap->get_klass_from_got(klass_name, klass_len, _method);
 108   }
 109   int method_name_len = build_u2_from((address)klass_name + klass_len);
 110   guarantee(method_name_len == 0, "only klass is expected here");
 111   meta = ((intptr_t)k) | 1;
 112   *entry = (Metadata*)meta; // Should be atomic on x64
 113   return k->java_mirror();
 114 }
 115 
 116 Metadata* AOTCompiledMethod::metadata_at(int index) const {
 117   if (index == 0) { // 0 is reserved
 118     return NULL;
 119   }
 120   assert(index - 1 < _metadata_size, "");
 121   {
 122     Metadata** entry = _metadata_got + (index - 1);
 123     intptr_t meta = (intptr_t)*entry;
 124     if ((meta & 1) == 1) {
 125       // already resolved
 126       Metadata *m = (Metadata*)(meta & ~1);
 127       return m;
 128     }
 129     // The entry is string which we need to resolve.
 130     const char* meta_name = _heap->get_name_at((int)meta);
 131     int klass_len = build_u2_from((address)meta_name);
 132     const char* klass_name = meta_name + 2;
 133     // Quick check the current method's holder.
 134     Klass* k = _method->method_holder();
 135     bool klass_matched = true;
 136 
 137     ResourceMark rm; // for signature_name() and find_method()
 138     if (strncmp(k->signature_name(), klass_name, klass_len) != 0) { // Does not match?
 139       // Search klass in got cells in DSO which have this compiled method.
 140       k = _heap->get_klass_from_got(klass_name, klass_len, _method);
 141       klass_matched = false;
 142     }
 143     int method_name_len = build_u2_from((address)klass_name + klass_len);
 144     if (method_name_len == 0) { // Array or Klass name only?
 145       meta = ((intptr_t)k) | 1;
 146       *entry = (Metadata*)meta; // Should be atomic on x64
 147       return (Metadata*)k;
 148     } else { // Method
 149       // Quick check the current method's name.
 150       Method* m = _method;
 151       int signature_len = build_u2_from((address)klass_name + klass_len + 2 + method_name_len);
 152       int full_len = 2 + klass_len + 2 + method_name_len + 2 + signature_len;
 153       if (!klass_matched || memcmp(_name, meta_name, full_len) != 0) { // Does not match?
 154         Thread* thread = Thread::current();
 155         KlassHandle klass = KlassHandle(thread, k);
 156         const char* method_name = klass_name + klass_len;
 157         m = AOTCodeHeap::find_method(klass, thread, method_name);
 158       }
 159       meta = ((intptr_t)m) | 1;
 160       *entry = (Metadata*)meta; // Should be atomic on x64
 161       return (Metadata*)m;
 162     }
 163     // need to resolve it here..., patching of GOT need to be CAS or atomic operation.
 164     // FIXIT: need methods for debuginfo.
 165     // return _method;
 166   }
 167   ShouldNotReachHere(); return NULL;
 168 }
 169 
 170 bool AOTCompiledMethod::make_not_entrant_helper(int new_state) {
 171   // Make sure the method is not flushed in case of a safepoint in code below.
 172   methodHandle the_method(method());
 173   NoSafepointVerifier nsv;
 174 
 175   {
 176     // Enter critical section.  Does not block for safepoint.
 177     MutexLockerEx pl(Patching_lock, Mutex::_no_safepoint_check_flag);
 178 
 179     if (*_state_adr == new_state) {
 180       // another thread already performed this transition so nothing
 181       // to do, but return false to indicate this.
 182       return false;
 183     }
 184 
 185     // Change state
 186     OrderAccess::storestore();
 187     *_state_adr = new_state;
 188 
 189     // Log the transition once
 190     log_state_change();
 191 
 192 #ifdef TIERED
 193     // Remain non-entrant forever
 194     if (new_state == not_entrant && method() != NULL) {
 195         method()->set_aot_code(NULL);
 196     }
 197 #endif
 198 
 199     // Remove AOTCompiledMethod from method.
 200     if (method() != NULL && (method()->code() == this ||
 201                              method()->from_compiled_entry() == verified_entry_point())) {
 202       HandleMark hm;
 203       method()->clear_code(false /* already owns Patching_lock */);
 204     }
 205   } // leave critical region under Patching_lock
 206 
 207 
 208   if (TraceCreateZombies) {
 209     ResourceMark m;
 210     const char *new_state_str = (new_state == not_entrant) ? "not entrant" : "not used";
 211     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);
 212   }
 213 
 214   return true;
 215 }
 216 
 217 bool AOTCompiledMethod::make_entrant() {
 218   assert(!method()->is_old(), "reviving evolved method!");
 219   assert(*_state_adr != not_entrant, "%s", method()->has_aot_code() ? "has_aot_code() not cleared" : "caller didn't check has_aot_code()");
 220 
 221   // Make sure the method is not flushed in case of a safepoint in code below.
 222   methodHandle the_method(method());
 223   NoSafepointVerifier nsv;
 224 
 225   {
 226     // Enter critical section.  Does not block for safepoint.
 227     MutexLockerEx pl(Patching_lock, Mutex::_no_safepoint_check_flag);
 228 
 229     if (*_state_adr == in_use) {
 230       // another thread already performed this transition so nothing
 231       // to do, but return false to indicate this.
 232       return false;
 233     }
 234 
 235     // Change state
 236     OrderAccess::storestore();
 237     *_state_adr = in_use;
 238 
 239     // Log the transition once
 240     log_state_change();
 241   } // leave critical region under Patching_lock
 242 
 243 
 244   if (TraceCreateZombies) {
 245     ResourceMark m;
 246     tty->print_cr("aot method <" INTPTR_FORMAT "> %s code made entrant", p2i(this), this->method() ? this->method()->name_and_sig_as_C_string() : "null");
 247   }
 248 
 249   return true;
 250 }
 251 
 252 // We don't have full dependencies for AOT methods, so flushing is
 253 // more conservative than for nmethods.
 254 void AOTCompiledMethod::flush_evol_dependents_on(instanceKlassHandle dependee) {
 255   if (is_java_method()) {
 256     cleanup_inline_caches();
 257     mark_for_deoptimization();
 258     make_not_entrant();
 259   }
 260 }
 261 
 262 // Iterate over metadata calling this function.   Used by RedefineClasses
 263 // Copied from nmethod::metadata_do
 264 void AOTCompiledMethod::metadata_do(void f(Metadata*)) {
 265   address low_boundary = verified_entry_point();
 266   {
 267     // Visit all immediate references that are embedded in the instruction stream.
 268     RelocIterator iter(this, low_boundary);
 269     while (iter.next()) {
 270       if (iter.type() == relocInfo::metadata_type ) {
 271         metadata_Relocation* r = iter.metadata_reloc();
 272         // In this metadata, we must only follow those metadatas directly embedded in
 273         // the code.  Other metadatas (oop_index>0) are seen as part of
 274         // the metadata section below.
 275         assert(1 == (r->metadata_is_immediate()) +
 276                (r->metadata_addr() >= metadata_begin() && r->metadata_addr() < metadata_end()),
 277                "metadata must be found in exactly one place");
 278         if (r->metadata_is_immediate() && r->metadata_value() != NULL) {
 279           Metadata* md = r->metadata_value();
 280           if (md != _method) f(md);
 281         }
 282       } else if (iter.type() == relocInfo::virtual_call_type) {
 283         // Check compiledIC holders associated with this nmethod
 284         CompiledIC *ic = CompiledIC_at(&iter);
 285         if (ic->is_icholder_call()) {
 286           CompiledICHolder* cichk = ic->cached_icholder();
 287           f(cichk->holder_method());
 288           f(cichk->holder_klass());
 289         } else {
 290           Metadata* ic_oop = ic->cached_metadata();
 291           if (ic_oop != NULL) {
 292             f(ic_oop);
 293           }
 294         }
 295       }
 296     }
 297   }
 298 
 299   // Visit the metadata section
 300   for (Metadata** p = metadata_begin(); p < metadata_end(); p++) {
 301     Metadata* m = *p;
 302 
 303     intptr_t meta = (intptr_t)m;
 304     if ((meta & 1) == 1) {
 305       // already resolved
 306       m = (Metadata*)(meta & ~1);
 307     } else {
 308       continue;
 309     }
 310     assert(Metaspace::contains(m), "");
 311     f(m);
 312   }
 313 
 314   // Visit metadata not embedded in the other places.
 315   if (_method != NULL) f(_method);
 316 }
 317 
 318 void AOTCompiledMethod::print() const {
 319   print_on(tty, "AOTCompiledMethod");
 320 }
 321 
 322 void AOTCompiledMethod::print_on(outputStream* st) const {
 323   print_on(st, "AOTCompiledMethod");
 324 }
 325 
 326 // Print out more verbose output usually for a newly created aot method.
 327 void AOTCompiledMethod::print_on(outputStream* st, const char* msg) const {
 328   if (st != NULL) {
 329     ttyLocker ttyl;
 330     st->print("%7d ", (int) st->time_stamp().milliseconds());
 331     st->print("%4d ", _aot_id);    // print compilation number
 332     st->print("    aot[%2d]", _heap->dso_id());
 333     // Stubs have _method == NULL
 334     st->print("   %s", (_method == NULL ? _name : _method->name_and_sig_as_C_string()));
 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 }
 452