1 /*
   2  * Copyright (c) 2016, 2019, 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 #include "aot/aotCodeHeap.hpp"
  26 #include "aot/aotLoader.inline.hpp"
  27 #include "classfile/javaClasses.hpp"
  28 #include "jvm.h"
  29 #include "memory/allocation.inline.hpp"
  30 #include "memory/resourceArea.hpp"
  31 #include "oops/compressedOops.hpp"
  32 #include "oops/method.hpp"
  33 #include "runtime/frame.inline.hpp"
  34 #include "runtime/handles.inline.hpp"
  35 #include "runtime/os.inline.hpp"
  36 #include "runtime/timerTrace.hpp"
  37 
  38 GrowableArray<AOTCodeHeap*>* AOTLoader::_heaps = new(ResourceObj::C_HEAP, mtCode) GrowableArray<AOTCodeHeap*> (2, true);
  39 GrowableArray<AOTLib*>* AOTLoader::_libraries = new(ResourceObj::C_HEAP, mtCode) GrowableArray<AOTLib*> (2, true);
  40 
  41 // Iterate over all AOT CodeHeaps
  42 #define FOR_ALL_AOT_HEAPS(heap) for (GrowableArrayIterator<AOTCodeHeap*> heap = heaps()->begin(); heap != heaps()->end(); ++heap)
  43 // Iterate over all AOT Libraries
  44 #define FOR_ALL_AOT_LIBRARIES(lib) for (GrowableArrayIterator<AOTLib*> lib = libraries()->begin(); lib != libraries()->end(); ++lib)
  45 
  46 void AOTLoader::load_for_klass(InstanceKlass* ik, Thread* thread) {
  47   if (ik->is_unsafe_anonymous()) {
  48     // don't even bother
  49     return;
  50   }
  51   if (UseAOT) {
  52     // We allow hotswap to be enabled after the onload phase, but not breakpoints
  53     assert(!JvmtiExport::can_post_breakpoint(), "AOT should have been disabled.");
  54     FOR_ALL_AOT_HEAPS(heap) {
  55       (*heap)->load_klass_data(ik, thread);
  56     }
  57   }
  58 }
  59 
  60 uint64_t AOTLoader::get_saved_fingerprint(InstanceKlass* ik) {
  61   assert(UseAOT, "called only when AOT is enabled");
  62   if (ik->is_unsafe_anonymous()) {
  63     // don't even bother
  64     return 0;
  65   }
  66   FOR_ALL_AOT_HEAPS(heap) {
  67     AOTKlassData* klass_data = (*heap)->find_klass(ik);
  68     if (klass_data != NULL) {
  69       return klass_data->_fingerprint;
  70     }
  71   }
  72   return 0;
  73 }
  74 
  75 void AOTLoader::oops_do(OopClosure* f) {
  76   if (UseAOT) {
  77     FOR_ALL_AOT_HEAPS(heap) {
  78       (*heap)->oops_do(f);
  79     }
  80   }
  81 }
  82 
  83 void AOTLoader::metadata_do(MetadataClosure* f) {
  84   if (UseAOT) {
  85     FOR_ALL_AOT_HEAPS(heap) {
  86       (*heap)->metadata_do(f);
  87     }
  88   }
  89 }
  90 
  91 void AOTLoader::mark_evol_dependent_methods(InstanceKlass* dependee) {
  92   if (UseAOT) {
  93     FOR_ALL_AOT_HEAPS(heap) {
  94       (*heap)->mark_evol_dependent_methods(dependee);
  95     }
  96   }
  97 }
  98 
  99 /**
 100  * List of core modules for which we search for shared libraries.
 101  */
 102 static const char* modules[] = {
 103   "java.base",
 104   "java.logging",
 105   "jdk.compiler",
 106   "jdk.scripting.nashorn",
 107   "jdk.internal.vm.ci",
 108   "jdk.internal.vm.compiler"
 109 };
 110 
 111 void AOTLoader::initialize() {
 112   TraceTime timer("AOT initialization", TRACETIME_LOG(Info, aot, startuptime));
 113 
 114   if (FLAG_IS_DEFAULT(UseAOT) && AOTLibrary != NULL) {
 115     // Don't need to set UseAOT on command line when AOTLibrary is specified
 116     FLAG_SET_DEFAULT(UseAOT, true);
 117   }
 118   if (UseAOT) {
 119     // EagerInitialization is not compatible with AOT
 120     if (EagerInitialization) {
 121       if (PrintAOT) {
 122         warning("EagerInitialization is not compatible with AOT (switching AOT off)");
 123       }
 124       FLAG_SET_DEFAULT(UseAOT, false);
 125       return;
 126     }
 127 
 128     if (JvmtiExport::can_post_breakpoint()) {
 129       if (PrintAOT) {
 130         warning("JVMTI capability to post breakpoint is not compatible with AOT (switching AOT off)");
 131       }
 132       FLAG_SET_DEFAULT(UseAOT, false);
 133       return;
 134     }
 135 
 136     // -Xint is not compatible with AOT
 137     if (Arguments::is_interpreter_only()) {
 138       if (PrintAOT) {
 139         warning("-Xint is not compatible with AOT (switching AOT off)");
 140       }
 141       FLAG_SET_DEFAULT(UseAOT, false);
 142       return;
 143     }
 144 
 145 #ifdef _WINDOWS
 146     const char pathSep = ';';
 147 #else
 148     const char pathSep = ':';
 149 #endif
 150 
 151     // Scan the AOTLibrary option.
 152     if (AOTLibrary != NULL) {
 153       const int len = (int)strlen(AOTLibrary);
 154       char* cp  = NEW_C_HEAP_ARRAY(char, len+1, mtCode);
 155       if (cp != NULL) { // No memory?
 156         memcpy(cp, AOTLibrary, len);
 157         cp[len] = '\0';
 158         char* end = cp + len;
 159         while (cp < end) {
 160           const char* name = cp;
 161           while ((*cp) != '\0' && (*cp) != '\n' && (*cp) != ',' && (*cp) != pathSep) cp++;
 162           cp[0] = '\0';  // Terminate name
 163           cp++;
 164           load_library(name, true);
 165         }
 166       }
 167     }
 168 
 169     // Load well-know AOT libraries from Java installation directory.
 170     const char* home = Arguments::get_java_home();
 171     const char* file_separator = os::file_separator();
 172 
 173     for (int i = 0; i < (int) (sizeof(modules) / sizeof(const char*)); i++) {
 174       char library[JVM_MAXPATHLEN];
 175       jio_snprintf(library, sizeof(library), "%s%slib%slib%s%s%s%s", home, file_separator, file_separator, modules[i], UseCompressedOops ? "-coop" : "", UseG1GC ? "" : "-nong1", os::dll_file_extension());
 176       load_library(library, false);
 177     }
 178   }
 179 }
 180 
 181 void AOTLoader::universe_init() {
 182   if (UseAOT && libraries_count() > 0) {
 183     // Shifts are static values which initialized by 0 until java heap initialization.
 184     // AOT libs are loaded before heap initialized so shift values are not set.
 185     // It is okay since ObjectAlignmentInBytes flag which defines shifts value is set before AOT libs are loaded.
 186     // AOT sets shift values during heap and metaspace initialization.
 187     // Check shifts value to make sure thay did not change.
 188     if (UseCompressedOops && AOTLib::narrow_oop_shift_initialized()) {
 189       int oop_shift = CompressedOops::shift();
 190       FOR_ALL_AOT_LIBRARIES(lib) {
 191         (*lib)->verify_flag((*lib)->config()->_narrowOopShift, oop_shift, "CompressedOops::shift");
 192       }
 193       if (UseCompressedClassPointers) { // It is set only if UseCompressedOops is set
 194         int klass_shift = CompressedKlassPointers::shift();
 195         FOR_ALL_AOT_LIBRARIES(lib) {
 196           (*lib)->verify_flag((*lib)->config()->_narrowKlassShift, klass_shift, "CompressedKlassPointers::shift");
 197         }
 198       }
 199     }
 200     // Create heaps for all valid libraries
 201     FOR_ALL_AOT_LIBRARIES(lib) {
 202       if ((*lib)->is_valid()) {
 203         AOTCodeHeap* heap = new AOTCodeHeap(*lib);
 204         {
 205           MutexLocker mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
 206           add_heap(heap);
 207           CodeCache::add_heap(heap);
 208         }
 209       } else {
 210         // Unload invalid libraries
 211         os::dll_unload((*lib)->dl_handle());
 212       }
 213     }
 214   }
 215   if (heaps_count() == 0) {
 216     if (FLAG_IS_DEFAULT(UseAOT)) {
 217       FLAG_SET_DEFAULT(UseAOT, false);
 218     }
 219   }
 220 }
 221 
 222 // Set shift value for compressed oops and classes based on first AOT library config.
 223 // AOTLoader::universe_init(), which is called later, will check the shift value again to make sure nobody change it.
 224 // This code is not executed during CDS dump because it runs in Interpreter mode and AOT is disabled in this mode.
 225 
 226 void AOTLoader::set_narrow_oop_shift() {
 227   // This method is called from Universe::initialize_heap().
 228   if (UseAOT && libraries_count() > 0 &&
 229       UseCompressedOops && AOTLib::narrow_oop_shift_initialized()) {
 230     if (CompressedOops::shift() == 0) {
 231       // 0 is valid shift value for small heap but we can safely increase it
 232       // at this point when nobody used it yet.
 233       CompressedOops::set_shift(AOTLib::narrow_oop_shift());
 234     }
 235   }
 236 }
 237 
 238 void AOTLoader::set_narrow_klass_shift() {
 239   // This method is called from Metaspace::set_narrow_klass_base_and_shift().
 240   if (UseAOT && libraries_count() > 0 &&
 241       UseCompressedOops && AOTLib::narrow_oop_shift_initialized() &&
 242       UseCompressedClassPointers) {
 243     if (CompressedKlassPointers::shift() == 0) {
 244       CompressedKlassPointers::set_shift(AOTLib::narrow_klass_shift());
 245     }
 246   }
 247 }
 248 
 249 void AOTLoader::load_library(const char* name, bool exit_on_error) {
 250   // Skip library if a library with the same name is already loaded.
 251   const int file_separator = *os::file_separator();
 252   const char* start = strrchr(name, file_separator);
 253   const char* new_name = (start == NULL) ? name : (start + 1);
 254   FOR_ALL_AOT_LIBRARIES(lib) {
 255     const char* lib_name = (*lib)->name();
 256     start = strrchr(lib_name, file_separator);
 257     const char* old_name = (start == NULL) ? lib_name : (start + 1);
 258     if (strcmp(old_name, new_name) == 0) {
 259       if (PrintAOT) {
 260         warning("AOT library %s is already loaded as %s.", name, lib_name);
 261       }
 262       return;
 263     }
 264   }
 265   char ebuf[1024];
 266   void* handle = os::dll_load(name, ebuf, sizeof ebuf);
 267   if (handle == NULL) {
 268     if (exit_on_error) {
 269       tty->print_cr("error opening file: %s", ebuf);
 270       vm_exit(1);
 271     }
 272     return;
 273   }
 274   const int dso_id = libraries_count() + 1;
 275   AOTLib* lib = new AOTLib(handle, name, dso_id);
 276   if (!lib->is_valid()) {
 277     delete lib;
 278     os::dll_unload(handle);
 279     return;
 280   }
 281   add_library(lib);
 282 }
 283 
 284 #ifndef PRODUCT
 285 void AOTLoader::print_statistics() {
 286   { ttyLocker ttyl;
 287     tty->print_cr("--- AOT Statistics ---");
 288     tty->print_cr("AOT libraries loaded: %d", heaps_count());
 289     AOTCodeHeap::print_statistics();
 290   }
 291 }
 292 #endif
 293 
 294 
 295 bool AOTLoader::reconcile_dynamic_invoke(InstanceKlass* holder, int index, Method* adapter_method, Klass* appendix_klass) {
 296   if (!UseAOT) {
 297     return true;
 298   }
 299   JavaThread* thread = JavaThread::current();
 300   ResourceMark rm(thread);
 301   RegisterMap map(thread, false);
 302   frame caller_frame = thread->last_frame().sender(&map); // Skip stub
 303   CodeBlob* caller_cb = caller_frame.cb();
 304   guarantee(caller_cb != NULL && caller_cb->is_compiled(), "must be called from compiled method");
 305   CompiledMethod* cm = caller_cb->as_compiled_method();
 306 
 307   if (!cm->is_aot()) {
 308     return true;
 309   }
 310   AOTCompiledMethod* aot = (AOTCompiledMethod*)cm;
 311 
 312   AOTCodeHeap* caller_heap = NULL;
 313   FOR_ALL_AOT_HEAPS(heap) {
 314     if ((*heap)->contains_blob(aot)) {
 315       caller_heap = *heap;
 316       break;
 317     }
 318   }
 319   guarantee(caller_heap != NULL, "CodeHeap not found");
 320   bool success = caller_heap->reconcile_dynamic_invoke(aot, holder, index, adapter_method, appendix_klass);
 321   vmassert(success || thread->last_frame().sender(&map).is_deoptimized_frame(), "caller not deoptimized on failure");
 322   return success;
 323 }
 324 
 325 
 326 // This should be called very early during startup before any of the AOTed methods that use boxes can deoptimize.
 327 // Deoptimization machinery expects the caches to be present and populated.
 328 void AOTLoader::initialize_box_caches(TRAPS) {
 329   if (!UseAOT || libraries_count() == 0) {
 330     return;
 331   }
 332   TraceTime timer("AOT initialization of box caches", TRACETIME_LOG(Info, aot, startuptime));
 333   Symbol* box_classes[] = { java_lang_Boolean::symbol(), java_lang_Byte_ByteCache::symbol(),
 334     java_lang_Short_ShortCache::symbol(), java_lang_Character_CharacterCache::symbol(),
 335     java_lang_Integer_IntegerCache::symbol(), java_lang_Long_LongCache::symbol() };
 336 
 337   for (unsigned i = 0; i < sizeof(box_classes) / sizeof(Symbol*); i++) {
 338     Klass* k = SystemDictionary::resolve_or_fail(box_classes[i], true, CHECK);
 339     InstanceKlass* ik = InstanceKlass::cast(k);
 340     if (ik->is_not_initialized()) {
 341       ik->initialize(CHECK);
 342     }
 343   }
 344 }