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