blob: d984f45253801639abd17bfa3320f3020a11bdbe [file] [log] [blame]
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001/*
2 * Copyright 2014 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#include "jit.h"
18
19#include <dlfcn.h>
20
Mathieu Chartiere401d142015-04-22 13:56:20 -070021#include "art_method-inl.h"
Andreas Gampe542451c2016-07-26 09:02:02 -070022#include "base/enums.h"
Andreas Gampe2a5c4682015-08-14 08:22:54 -070023#include "debugger.h"
Mathieu Chartiere5f13e52015-02-24 09:37:21 -080024#include "entrypoints/runtime_asm_entrypoints.h"
25#include "interpreter/interpreter.h"
26#include "jit_code_cache.h"
Calin Juravle31f2c152015-10-23 17:56:15 +010027#include "oat_file_manager.h"
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +000028#include "oat_quick_method_header.h"
Calin Juravle31f2c152015-10-23 17:56:15 +010029#include "offline_profiling_info.h"
Calin Juravle4d77b6a2015-12-01 18:38:09 +000030#include "profile_saver.h"
Mathieu Chartiere5f13e52015-02-24 09:37:21 -080031#include "runtime.h"
32#include "runtime_options.h"
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +000033#include "stack_map.h"
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +010034#include "thread_list.h"
Mathieu Chartiere5f13e52015-02-24 09:37:21 -080035#include "utils.h"
36
37namespace art {
38namespace jit {
39
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +000040static constexpr bool kEnableOnStackReplacement = true;
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +010041// At what priority to schedule jit threads. 9 is the lowest foreground priority on device.
42static constexpr int kJitPoolThreadPthreadPriority = 9;
Nicolas Geoffraye8662132016-02-15 10:00:42 +000043
Mathieu Chartier72918ea2016-03-24 11:07:06 -070044// JIT compiler
45void* Jit::jit_library_handle_= nullptr;
46void* Jit::jit_compiler_handle_ = nullptr;
47void* (*Jit::jit_load_)(bool*) = nullptr;
48void (*Jit::jit_unload_)(void*) = nullptr;
49bool (*Jit::jit_compile_method_)(void*, ArtMethod*, Thread*, bool) = nullptr;
50void (*Jit::jit_types_loaded_)(void*, mirror::Class**, size_t count) = nullptr;
51bool Jit::generate_debug_info_ = false;
52
Mathieu Chartiere5f13e52015-02-24 09:37:21 -080053JitOptions* JitOptions::CreateFromRuntimeArguments(const RuntimeArgumentMap& options) {
Mathieu Chartiere5f13e52015-02-24 09:37:21 -080054 auto* jit_options = new JitOptions;
Calin Juravleffc87072016-04-20 14:22:09 +010055 jit_options->use_jit_compilation_ = options.GetOrDefault(RuntimeArgumentMap::UseJitCompilation);
Nicolas Geoffray83f080a2016-03-08 16:50:21 +000056
Nicolas Geoffray0a3be162015-11-18 11:15:22 +000057 jit_options->code_cache_initial_capacity_ =
58 options.GetOrDefault(RuntimeArgumentMap::JITCodeCacheInitialCapacity);
59 jit_options->code_cache_max_capacity_ =
60 options.GetOrDefault(RuntimeArgumentMap::JITCodeCacheMaxCapacity);
Mathieu Chartiera4885cb2015-03-09 15:38:54 -070061 jit_options->dump_info_on_shutdown_ =
62 options.Exists(RuntimeArgumentMap::DumpJITInfoOnShutdown);
Calin Juravle138dbff2016-06-28 19:36:58 +010063 jit_options->profile_saver_options_ =
64 options.GetOrDefault(RuntimeArgumentMap::ProfileSaverOpts);
Nicolas Geoffray83f080a2016-03-08 16:50:21 +000065
66 jit_options->compile_threshold_ = options.GetOrDefault(RuntimeArgumentMap::JITCompileThreshold);
67 if (jit_options->compile_threshold_ > std::numeric_limits<uint16_t>::max()) {
68 LOG(FATAL) << "Method compilation threshold is above its internal limit.";
69 }
70
71 if (options.Exists(RuntimeArgumentMap::JITWarmupThreshold)) {
72 jit_options->warmup_threshold_ = *options.Get(RuntimeArgumentMap::JITWarmupThreshold);
73 if (jit_options->warmup_threshold_ > std::numeric_limits<uint16_t>::max()) {
74 LOG(FATAL) << "Method warmup threshold is above its internal limit.";
75 }
76 } else {
77 jit_options->warmup_threshold_ = jit_options->compile_threshold_ / 2;
78 }
79
80 if (options.Exists(RuntimeArgumentMap::JITOsrThreshold)) {
81 jit_options->osr_threshold_ = *options.Get(RuntimeArgumentMap::JITOsrThreshold);
82 if (jit_options->osr_threshold_ > std::numeric_limits<uint16_t>::max()) {
83 LOG(FATAL) << "Method on stack replacement threshold is above its internal limit.";
84 }
85 } else {
86 jit_options->osr_threshold_ = jit_options->compile_threshold_ * 2;
87 if (jit_options->osr_threshold_ > std::numeric_limits<uint16_t>::max()) {
88 jit_options->osr_threshold_ = std::numeric_limits<uint16_t>::max();
89 }
90 }
91
Calin Juravleb2771b42016-04-07 17:09:25 +010092 if (options.Exists(RuntimeArgumentMap::JITPriorityThreadWeight)) {
93 jit_options->priority_thread_weight_ =
94 *options.Get(RuntimeArgumentMap::JITPriorityThreadWeight);
95 if (jit_options->priority_thread_weight_ > jit_options->warmup_threshold_) {
96 LOG(FATAL) << "Priority thread weight is above the warmup threshold.";
97 } else if (jit_options->priority_thread_weight_ == 0) {
98 LOG(FATAL) << "Priority thread weight cannot be 0.";
99 }
100 } else {
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100101 jit_options->priority_thread_weight_ = std::max(
102 jit_options->warmup_threshold_ / Jit::kDefaultPriorityThreadWeightRatio,
103 static_cast<size_t>(1));
Calin Juravleb2771b42016-04-07 17:09:25 +0100104 }
105
Calin Juravle155ff3d2016-04-27 14:14:58 +0100106 if (options.Exists(RuntimeArgumentMap::JITInvokeTransitionWeight)) {
Nicolas Geoffray7c9f3ba2016-05-06 16:52:36 +0100107 jit_options->invoke_transition_weight_ =
108 *options.Get(RuntimeArgumentMap::JITInvokeTransitionWeight);
Calin Juravle155ff3d2016-04-27 14:14:58 +0100109 if (jit_options->invoke_transition_weight_ > jit_options->warmup_threshold_) {
110 LOG(FATAL) << "Invoke transition weight is above the warmup threshold.";
111 } else if (jit_options->invoke_transition_weight_ == 0) {
Nicolas Geoffray7c9f3ba2016-05-06 16:52:36 +0100112 LOG(FATAL) << "Invoke transition weight cannot be 0.";
Calin Juravle155ff3d2016-04-27 14:14:58 +0100113 }
Calin Juravle155ff3d2016-04-27 14:14:58 +0100114 } else {
115 jit_options->invoke_transition_weight_ = std::max(
116 jit_options->warmup_threshold_ / Jit::kDefaultInvokeTransitionWeightRatio,
117 static_cast<size_t>(1));;
118 }
119
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800120 return jit_options;
121}
122
Calin Juravleb2771b42016-04-07 17:09:25 +0100123bool Jit::ShouldUsePriorityThreadWeight() {
Calin Juravle97cbc922016-04-15 16:16:35 +0100124 return Runtime::Current()->InJankPerceptibleProcessState()
125 && Thread::Current()->IsJitSensitiveThread();
Calin Juravleb2771b42016-04-07 17:09:25 +0100126}
127
Mathieu Chartiera4885cb2015-03-09 15:38:54 -0700128void Jit::DumpInfo(std::ostream& os) {
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +0000129 code_cache_->Dump(os);
Mathieu Chartiera4885cb2015-03-09 15:38:54 -0700130 cumulative_timings_.Dump(os);
Nicolas Geoffraya4f81542016-03-08 16:57:48 +0000131 MutexLock mu(Thread::Current(), lock_);
132 memory_use_.PrintMemoryUse(os);
Mathieu Chartiera4885cb2015-03-09 15:38:54 -0700133}
134
Calin Juravleb8e69992016-03-09 15:37:48 +0000135void Jit::DumpForSigQuit(std::ostream& os) {
136 DumpInfo(os);
137 ProfileSaver::DumpInstanceInfo(os);
138}
139
Mathieu Chartiera4885cb2015-03-09 15:38:54 -0700140void Jit::AddTimingLogger(const TimingLogger& logger) {
141 cumulative_timings_.AddLogger(logger);
142}
143
Mathieu Chartier72918ea2016-03-24 11:07:06 -0700144Jit::Jit() : dump_info_on_shutdown_(false),
Nicolas Geoffraya25dce92016-01-12 16:41:10 +0000145 cumulative_timings_("JIT timings"),
Nicolas Geoffraya4f81542016-03-08 16:57:48 +0000146 memory_use_("Memory used for compilation", 16),
147 lock_("JIT memory use lock"),
Calin Juravle138dbff2016-06-28 19:36:58 +0100148 use_jit_compilation_(true) {}
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800149
150Jit* Jit::Create(JitOptions* options, std::string* error_msg) {
Calin Juravle138dbff2016-06-28 19:36:58 +0100151 DCHECK(options->UseJitCompilation() || options->GetProfileSaverOptions().IsEnabled());
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800152 std::unique_ptr<Jit> jit(new Jit);
Mathieu Chartiera4885cb2015-03-09 15:38:54 -0700153 jit->dump_info_on_shutdown_ = options->DumpJitInfoOnShutdown();
Mathieu Chartier72918ea2016-03-24 11:07:06 -0700154 if (jit_compiler_handle_ == nullptr && !LoadCompiler(error_msg)) {
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800155 return nullptr;
156 }
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000157 jit->code_cache_.reset(JitCodeCache::Create(
Nicolas Geoffraya25dce92016-01-12 16:41:10 +0000158 options->GetCodeCacheInitialCapacity(),
159 options->GetCodeCacheMaxCapacity(),
160 jit->generate_debug_info_,
161 error_msg));
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800162 if (jit->GetCodeCache() == nullptr) {
163 return nullptr;
164 }
Calin Juravleffc87072016-04-20 14:22:09 +0100165 jit->use_jit_compilation_ = options->UseJitCompilation();
Calin Juravle138dbff2016-06-28 19:36:58 +0100166 jit->profile_saver_options_ = options->GetProfileSaverOptions();
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +0000167 VLOG(jit) << "JIT created with initial_capacity="
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000168 << PrettySize(options->GetCodeCacheInitialCapacity())
169 << ", max_capacity=" << PrettySize(options->GetCodeCacheMaxCapacity())
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000170 << ", compile_threshold=" << options->GetCompileThreshold()
Calin Juravle138dbff2016-06-28 19:36:58 +0100171 << ", profile_saver_options=" << options->GetProfileSaverOptions();
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100172
173
174 jit->hot_method_threshold_ = options->GetCompileThreshold();
175 jit->warm_method_threshold_ = options->GetWarmupThreshold();
176 jit->osr_method_threshold_ = options->GetOsrThreshold();
Nicolas Geoffrayba6aae02016-04-14 14:17:29 +0100177 jit->priority_thread_weight_ = options->GetPriorityThreadWeight();
Calin Juravle155ff3d2016-04-27 14:14:58 +0100178 jit->invoke_transition_weight_ = options->GetInvokeTransitionWeight();
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100179
180 jit->CreateThreadPool();
181
182 // Notify native debugger about the classes already loaded before the creation of the jit.
183 jit->DumpTypeInfoForLoadedTypes(Runtime::Current()->GetClassLinker());
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800184 return jit.release();
185}
186
Mathieu Chartierc1bc4152016-03-24 17:22:52 -0700187bool Jit::LoadCompilerLibrary(std::string* error_msg) {
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800188 jit_library_handle_ = dlopen(
189 kIsDebugBuild ? "libartd-compiler.so" : "libart-compiler.so", RTLD_NOW);
190 if (jit_library_handle_ == nullptr) {
191 std::ostringstream oss;
192 oss << "JIT could not load libart-compiler.so: " << dlerror();
193 *error_msg = oss.str();
194 return false;
195 }
Nicolas Geoffray5b82d332016-02-18 14:22:32 +0000196 jit_load_ = reinterpret_cast<void* (*)(bool*)>(dlsym(jit_library_handle_, "jit_load"));
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800197 if (jit_load_ == nullptr) {
198 dlclose(jit_library_handle_);
199 *error_msg = "JIT couldn't find jit_load entry point";
200 return false;
201 }
202 jit_unload_ = reinterpret_cast<void (*)(void*)>(
203 dlsym(jit_library_handle_, "jit_unload"));
204 if (jit_unload_ == nullptr) {
205 dlclose(jit_library_handle_);
206 *error_msg = "JIT couldn't find jit_unload entry point";
207 return false;
208 }
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000209 jit_compile_method_ = reinterpret_cast<bool (*)(void*, ArtMethod*, Thread*, bool)>(
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800210 dlsym(jit_library_handle_, "jit_compile_method"));
211 if (jit_compile_method_ == nullptr) {
212 dlclose(jit_library_handle_);
213 *error_msg = "JIT couldn't find jit_compile_method entry point";
214 return false;
215 }
Tamas Berghammerfffbee42016-01-15 13:09:34 +0000216 jit_types_loaded_ = reinterpret_cast<void (*)(void*, mirror::Class**, size_t)>(
217 dlsym(jit_library_handle_, "jit_types_loaded"));
218 if (jit_types_loaded_ == nullptr) {
Tamas Berghammer160e6df2016-01-05 14:29:02 +0000219 dlclose(jit_library_handle_);
Tamas Berghammerfffbee42016-01-15 13:09:34 +0000220 *error_msg = "JIT couldn't find jit_types_loaded entry point";
Tamas Berghammer160e6df2016-01-05 14:29:02 +0000221 return false;
222 }
Mathieu Chartierc1bc4152016-03-24 17:22:52 -0700223 return true;
224}
225
226bool Jit::LoadCompiler(std::string* error_msg) {
227 if (jit_library_handle_ == nullptr && !LoadCompilerLibrary(error_msg)) {
228 return false;
229 }
Nicolas Geoffraya25dce92016-01-12 16:41:10 +0000230 bool will_generate_debug_symbols = false;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800231 VLOG(jit) << "Calling JitLoad interpreter_only="
232 << Runtime::Current()->GetInstrumentation()->InterpretOnly();
Nicolas Geoffray5b82d332016-02-18 14:22:32 +0000233 jit_compiler_handle_ = (jit_load_)(&will_generate_debug_symbols);
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800234 if (jit_compiler_handle_ == nullptr) {
235 dlclose(jit_library_handle_);
236 *error_msg = "JIT couldn't load compiler";
237 return false;
238 }
Nicolas Geoffraya25dce92016-01-12 16:41:10 +0000239 generate_debug_info_ = will_generate_debug_symbols;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800240 return true;
241}
242
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000243bool Jit::CompileMethod(ArtMethod* method, Thread* self, bool osr) {
Calin Juravleffc87072016-04-20 14:22:09 +0100244 DCHECK(Runtime::Current()->UseJitCompilation());
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800245 DCHECK(!method->IsRuntimeMethod());
Nicolas Geoffrayd9994f02016-02-11 17:35:55 +0000246
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100247 // Don't compile the method if it has breakpoints.
Mathieu Chartierd8565452015-03-26 09:41:50 -0700248 if (Dbg::IsDebuggerActive() && Dbg::MethodHasAnyBreakpoints(method)) {
249 VLOG(jit) << "JIT not compiling " << PrettyMethod(method) << " due to breakpoint";
250 return false;
251 }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100252
253 // Don't compile the method if we are supposed to be deoptimized.
254 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
255 if (instrumentation->AreAllMethodsDeoptimized() || instrumentation->IsDeoptimized(method)) {
Nicolas Geoffraya42363f2015-12-17 14:57:09 +0000256 VLOG(jit) << "JIT not compiling " << PrettyMethod(method) << " due to deoptimization";
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100257 return false;
258 }
259
Nicolas Geoffrayd9994f02016-02-11 17:35:55 +0000260 // If we get a request to compile a proxy method, we pass the actual Java method
261 // of that proxy method, as the compiler does not expect a proxy method.
Andreas Gampe542451c2016-07-26 09:02:02 -0700262 ArtMethod* method_to_compile = method->GetInterfaceMethodIfProxy(kRuntimePointerSize);
Nicolas Geoffrayd9994f02016-02-11 17:35:55 +0000263 if (!code_cache_->NotifyCompilationOf(method_to_compile, self, osr)) {
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100264 return false;
265 }
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100266
267 VLOG(jit) << "Compiling method "
268 << PrettyMethod(method_to_compile)
269 << " osr=" << std::boolalpha << osr;
Nicolas Geoffrayd9994f02016-02-11 17:35:55 +0000270 bool success = jit_compile_method_(jit_compiler_handle_, method_to_compile, self, osr);
buzbee454b3b62016-04-07 14:42:47 -0700271 code_cache_->DoneCompiling(method_to_compile, self, osr);
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100272 if (!success) {
273 VLOG(jit) << "Failed to compile method "
274 << PrettyMethod(method_to_compile)
275 << " osr=" << std::boolalpha << osr;
276 }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100277 return success;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800278}
279
280void Jit::CreateThreadPool() {
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100281 // There is a DCHECK in the 'AddSamples' method to ensure the tread pool
282 // is not null when we instrument.
283 thread_pool_.reset(new ThreadPool("Jit thread pool", 1));
284 thread_pool_->SetPthreadPriority(kJitPoolThreadPthreadPriority);
285 thread_pool_->StartWorkers(Thread::Current());
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800286}
287
288void Jit::DeleteThreadPool() {
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100289 Thread* self = Thread::Current();
290 DCHECK(Runtime::Current()->IsShuttingDown(self));
291 if (thread_pool_ != nullptr) {
292 ThreadPool* cache = nullptr;
293 {
294 ScopedSuspendAll ssa(__FUNCTION__);
295 // Clear thread_pool_ field while the threads are suspended.
296 // A mutator in the 'AddSamples' method will check against it.
297 cache = thread_pool_.release();
298 }
299 cache->StopWorkers(self);
300 cache->RemoveAllTasks(self);
301 // We could just suspend all threads, but we know those threads
302 // will finish in a short period, so it's not worth adding a suspend logic
303 // here. Besides, this is only done for shutdown.
304 cache->Wait(self, false, false);
305 delete cache;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800306 }
307}
308
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000309void Jit::StartProfileSaver(const std::string& filename,
Calin Juravlec90bc922016-02-24 10:13:09 +0000310 const std::vector<std::string>& code_paths,
311 const std::string& foreign_dex_profile_path,
312 const std::string& app_dir) {
Calin Juravle138dbff2016-06-28 19:36:58 +0100313 if (profile_saver_options_.IsEnabled()) {
314 ProfileSaver::Start(profile_saver_options_,
315 filename,
316 code_cache_.get(),
317 code_paths,
318 foreign_dex_profile_path,
319 app_dir);
Calin Juravle31f2c152015-10-23 17:56:15 +0100320 }
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000321}
322
323void Jit::StopProfileSaver() {
Calin Juravle138dbff2016-06-28 19:36:58 +0100324 if (profile_saver_options_.IsEnabled() && ProfileSaver::IsStarted()) {
Calin Juravleb8e69992016-03-09 15:37:48 +0000325 ProfileSaver::Stop(dump_info_on_shutdown_);
Calin Juravle31f2c152015-10-23 17:56:15 +0100326 }
327}
328
Siva Chandra05d24152016-01-05 17:43:17 -0800329bool Jit::JitAtFirstUse() {
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100330 return HotMethodThreshold() == 0;
Siva Chandra05d24152016-01-05 17:43:17 -0800331}
332
Nicolas Geoffray35122442016-03-02 12:05:30 +0000333bool Jit::CanInvokeCompiledCode(ArtMethod* method) {
334 return code_cache_->ContainsPc(method->GetEntryPointFromQuickCompiledCode());
335}
336
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800337Jit::~Jit() {
Calin Juravle138dbff2016-06-28 19:36:58 +0100338 DCHECK(!profile_saver_options_.IsEnabled() || !ProfileSaver::IsStarted());
Mathieu Chartiera4885cb2015-03-09 15:38:54 -0700339 if (dump_info_on_shutdown_) {
340 DumpInfo(LOG(INFO));
341 }
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800342 DeleteThreadPool();
343 if (jit_compiler_handle_ != nullptr) {
344 jit_unload_(jit_compiler_handle_);
Mathieu Chartier72918ea2016-03-24 11:07:06 -0700345 jit_compiler_handle_ = nullptr;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800346 }
347 if (jit_library_handle_ != nullptr) {
348 dlclose(jit_library_handle_);
Mathieu Chartier72918ea2016-03-24 11:07:06 -0700349 jit_library_handle_ = nullptr;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800350 }
351}
352
Tamas Berghammer160e6df2016-01-05 14:29:02 +0000353void Jit::NewTypeLoadedIfUsingJit(mirror::Class* type) {
Calin Juravleffc87072016-04-20 14:22:09 +0100354 if (!Runtime::Current()->UseJitCompilation()) {
355 // No need to notify if we only use the JIT to save profiles.
356 return;
357 }
Tamas Berghammer160e6df2016-01-05 14:29:02 +0000358 jit::Jit* jit = Runtime::Current()->GetJit();
Calin Juravleffc87072016-04-20 14:22:09 +0100359 if (jit->generate_debug_info_) {
Tamas Berghammerfffbee42016-01-15 13:09:34 +0000360 DCHECK(jit->jit_types_loaded_ != nullptr);
361 jit->jit_types_loaded_(jit->jit_compiler_handle_, &type, 1);
362 }
363}
364
365void Jit::DumpTypeInfoForLoadedTypes(ClassLinker* linker) {
366 struct CollectClasses : public ClassVisitor {
Mathieu Chartier1aa8ec22016-02-01 10:34:47 -0800367 bool operator()(mirror::Class* klass) override {
Tamas Berghammerfffbee42016-01-15 13:09:34 +0000368 classes_.push_back(klass);
369 return true;
370 }
Mathieu Chartier9b1c9b72016-02-02 10:09:58 -0800371 std::vector<mirror::Class*> classes_;
Tamas Berghammerfffbee42016-01-15 13:09:34 +0000372 };
373
374 if (generate_debug_info_) {
375 ScopedObjectAccess so(Thread::Current());
376
377 CollectClasses visitor;
378 linker->VisitClasses(&visitor);
379 jit_types_loaded_(jit_compiler_handle_, visitor.classes_.data(), visitor.classes_.size());
Tamas Berghammer160e6df2016-01-05 14:29:02 +0000380 }
381}
382
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000383extern "C" void art_quick_osr_stub(void** stack,
384 uint32_t stack_size_in_bytes,
385 const uint8_t* native_pc,
386 JValue* result,
387 const char* shorty,
388 Thread* self);
389
390bool Jit::MaybeDoOnStackReplacement(Thread* thread,
391 ArtMethod* method,
392 uint32_t dex_pc,
393 int32_t dex_pc_offset,
394 JValue* result) {
Nicolas Geoffraye8662132016-02-15 10:00:42 +0000395 if (!kEnableOnStackReplacement) {
396 return false;
397 }
398
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000399 Jit* jit = Runtime::Current()->GetJit();
400 if (jit == nullptr) {
401 return false;
402 }
403
Nicolas Geoffrayb88d59e2016-02-17 11:31:49 +0000404 if (UNLIKELY(__builtin_frame_address(0) < thread->GetStackEnd())) {
405 // Don't attempt to do an OSR if we are close to the stack limit. Since
406 // the interpreter frames are still on stack, OSR has the potential
407 // to stack overflow even for a simple loop.
408 // b/27094810.
409 return false;
410 }
411
Nicolas Geoffrayd9bc4332016-02-05 23:32:25 +0000412 // Get the actual Java method if this method is from a proxy class. The compiler
413 // and the JIT code cache do not expect methods from proxy classes.
Andreas Gampe542451c2016-07-26 09:02:02 -0700414 method = method->GetInterfaceMethodIfProxy(kRuntimePointerSize);
Nicolas Geoffrayd9bc4332016-02-05 23:32:25 +0000415
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000416 // Cheap check if the method has been compiled already. That's an indicator that we should
417 // osr into it.
418 if (!jit->GetCodeCache()->ContainsPc(method->GetEntryPointFromQuickCompiledCode())) {
419 return false;
420 }
421
Nicolas Geoffrayc0b27962016-02-16 12:06:05 +0000422 // Fetch some data before looking up for an OSR method. We don't want thread
423 // suspension once we hold an OSR method, as the JIT code cache could delete the OSR
424 // method while we are being suspended.
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000425 const size_t number_of_vregs = method->GetCodeItem()->registers_size_;
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000426 const char* shorty = method->GetShorty();
427 std::string method_name(VLOG_IS_ON(jit) ? PrettyMethod(method) : "");
428 void** memory = nullptr;
429 size_t frame_size = 0;
430 ShadowFrame* shadow_frame = nullptr;
431 const uint8_t* native_pc = nullptr;
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000432
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000433 {
Mathieu Chartier268764d2016-09-13 12:09:38 -0700434 ScopedAssertNoThreadSuspension sts("Holding OSR method");
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000435 const OatQuickMethodHeader* osr_method = jit->GetCodeCache()->LookupOsrMethodHeader(method);
436 if (osr_method == nullptr) {
437 // No osr method yet, just return to the interpreter.
438 return false;
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000439 }
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000440
441 CodeInfo code_info = osr_method->GetOptimizedCodeInfo();
David Srbecky09ed0982016-02-12 21:58:43 +0000442 CodeInfoEncoding encoding = code_info.ExtractEncoding();
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000443
444 // Find stack map starting at the target dex_pc.
445 StackMap stack_map = code_info.GetOsrStackMapForDexPc(dex_pc + dex_pc_offset, encoding);
446 if (!stack_map.IsValid()) {
447 // There is no OSR stack map for this dex pc offset. Just return to the interpreter in the
448 // hope that the next branch has one.
449 return false;
450 }
451
Aart Bik29bdaee2016-05-18 15:44:07 -0700452 // Before allowing the jump, make sure the debugger is not active to avoid jumping from
453 // interpreter to OSR while e.g. single stepping. Note that we could selectively disable
454 // OSR when single stepping, but that's currently hard to know at this point.
455 if (Dbg::IsDebuggerActive()) {
456 return false;
457 }
458
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000459 // We found a stack map, now fill the frame with dex register values from the interpreter's
460 // shadow frame.
461 DexRegisterMap vreg_map =
462 code_info.GetDexRegisterMapOf(stack_map, encoding, number_of_vregs);
463
464 frame_size = osr_method->GetFrameSizeInBytes();
465
466 // Allocate memory to put shadow frame values. The osr stub will copy that memory to
467 // stack.
468 // Note that we could pass the shadow frame to the stub, and let it copy the values there,
469 // but that is engineering complexity not worth the effort for something like OSR.
470 memory = reinterpret_cast<void**>(malloc(frame_size));
471 CHECK(memory != nullptr);
472 memset(memory, 0, frame_size);
473
474 // Art ABI: ArtMethod is at the bottom of the stack.
475 memory[0] = method;
476
477 shadow_frame = thread->PopShadowFrame();
478 if (!vreg_map.IsValid()) {
479 // If we don't have a dex register map, then there are no live dex registers at
480 // this dex pc.
481 } else {
482 for (uint16_t vreg = 0; vreg < number_of_vregs; ++vreg) {
483 DexRegisterLocation::Kind location =
484 vreg_map.GetLocationKind(vreg, number_of_vregs, code_info, encoding);
485 if (location == DexRegisterLocation::Kind::kNone) {
Nicolas Geoffrayc0b27962016-02-16 12:06:05 +0000486 // Dex register is dead or uninitialized.
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000487 continue;
488 }
489
490 if (location == DexRegisterLocation::Kind::kConstant) {
491 // We skip constants because the compiled code knows how to handle them.
492 continue;
493 }
494
David Srbecky7dc11782016-02-25 13:23:56 +0000495 DCHECK_EQ(location, DexRegisterLocation::Kind::kInStack);
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000496
497 int32_t vreg_value = shadow_frame->GetVReg(vreg);
498 int32_t slot_offset = vreg_map.GetStackOffsetInBytes(vreg,
499 number_of_vregs,
500 code_info,
501 encoding);
502 DCHECK_LT(slot_offset, static_cast<int32_t>(frame_size));
503 DCHECK_GT(slot_offset, 0);
504 (reinterpret_cast<int32_t*>(memory))[slot_offset / sizeof(int32_t)] = vreg_value;
505 }
506 }
507
David Srbecky09ed0982016-02-12 21:58:43 +0000508 native_pc = stack_map.GetNativePcOffset(encoding.stack_map_encoding) +
509 osr_method->GetEntryPoint();
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000510 VLOG(jit) << "Jumping to "
511 << method_name
512 << "@"
513 << std::hex << reinterpret_cast<uintptr_t>(native_pc);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000514 }
515
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000516 {
517 ManagedStack fragment;
518 thread->PushManagedStackFragment(&fragment);
519 (*art_quick_osr_stub)(memory,
520 frame_size,
521 native_pc,
522 result,
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000523 shorty,
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000524 thread);
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000525
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000526 if (UNLIKELY(thread->GetException() == Thread::GetDeoptimizationException())) {
527 thread->DeoptimizeWithDeoptimizationException(result);
528 }
529 thread->PopManagedStackFragment(fragment);
530 }
531 free(memory);
532 thread->PushShadowFrame(shadow_frame);
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000533 VLOG(jit) << "Done running OSR code for " << method_name;
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000534 return true;
535}
536
Nicolas Geoffraya4f81542016-03-08 16:57:48 +0000537void Jit::AddMemoryUsage(ArtMethod* method, size_t bytes) {
538 if (bytes > 4 * MB) {
539 LOG(INFO) << "Compiler allocated "
540 << PrettySize(bytes)
541 << " to compile "
542 << PrettyMethod(method);
543 }
544 MutexLock mu(Thread::Current(), lock_);
545 memory_use_.AddValue(bytes);
546}
547
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100548class JitCompileTask FINAL : public Task {
549 public:
550 enum TaskKind {
551 kAllocateProfile,
552 kCompile,
553 kCompileOsr
554 };
555
556 JitCompileTask(ArtMethod* method, TaskKind kind) : method_(method), kind_(kind) {
557 ScopedObjectAccess soa(Thread::Current());
558 // Add a global ref to the class to prevent class unloading until compilation is done.
559 klass_ = soa.Vm()->AddGlobalRef(soa.Self(), method_->GetDeclaringClass());
560 CHECK(klass_ != nullptr);
561 }
562
563 ~JitCompileTask() {
564 ScopedObjectAccess soa(Thread::Current());
565 soa.Vm()->DeleteGlobalRef(soa.Self(), klass_);
566 }
567
568 void Run(Thread* self) OVERRIDE {
569 ScopedObjectAccess soa(self);
570 if (kind_ == kCompile) {
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100571 Runtime::Current()->GetJit()->CompileMethod(method_, self, /* osr */ false);
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100572 } else if (kind_ == kCompileOsr) {
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100573 Runtime::Current()->GetJit()->CompileMethod(method_, self, /* osr */ true);
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100574 } else {
575 DCHECK(kind_ == kAllocateProfile);
576 if (ProfilingInfo::Create(self, method_, /* retry_allocation */ true)) {
577 VLOG(jit) << "Start profiling " << PrettyMethod(method_);
578 }
579 }
Calin Juravlea2638922016-04-29 16:44:11 +0100580 ProfileSaver::NotifyJitActivity();
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100581 }
582
583 void Finalize() OVERRIDE {
584 delete this;
585 }
586
587 private:
588 ArtMethod* const method_;
589 const TaskKind kind_;
590 jobject klass_;
591
592 DISALLOW_IMPLICIT_CONSTRUCTORS(JitCompileTask);
593};
594
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100595void Jit::AddSamples(Thread* self, ArtMethod* method, uint16_t count, bool with_backedges) {
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100596 if (thread_pool_ == nullptr) {
597 // Should only see this when shutting down.
598 DCHECK(Runtime::Current()->IsShuttingDown(self));
599 return;
600 }
601
Nicolas Geoffray250a3782016-04-20 16:27:53 +0100602 if (method->IsClassInitializer() || method->IsNative() || !method->IsCompilable()) {
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100603 // We do not want to compile such methods.
604 return;
605 }
606 DCHECK(thread_pool_ != nullptr);
607 DCHECK_GT(warm_method_threshold_, 0);
608 DCHECK_GT(hot_method_threshold_, warm_method_threshold_);
609 DCHECK_GT(osr_method_threshold_, hot_method_threshold_);
610 DCHECK_GE(priority_thread_weight_, 1);
611 DCHECK_LE(priority_thread_weight_, hot_method_threshold_);
612
613 int32_t starting_count = method->GetCounter();
614 if (Jit::ShouldUsePriorityThreadWeight()) {
615 count *= priority_thread_weight_;
616 }
617 int32_t new_count = starting_count + count; // int32 here to avoid wrap-around;
618 if (starting_count < warm_method_threshold_) {
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100619 if ((new_count >= warm_method_threshold_) &&
Andreas Gampe542451c2016-07-26 09:02:02 -0700620 (method->GetProfilingInfo(kRuntimePointerSize) == nullptr)) {
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100621 bool success = ProfilingInfo::Create(self, method, /* retry_allocation */ false);
622 if (success) {
623 VLOG(jit) << "Start profiling " << PrettyMethod(method);
624 }
625
626 if (thread_pool_ == nullptr) {
627 // Calling ProfilingInfo::Create might put us in a suspended state, which could
628 // lead to the thread pool being deleted when we are shutting down.
629 DCHECK(Runtime::Current()->IsShuttingDown(self));
630 return;
631 }
632
633 if (!success) {
634 // We failed allocating. Instead of doing the collection on the Java thread, we push
635 // an allocation to a compiler thread, that will do the collection.
636 thread_pool_->AddTask(self, new JitCompileTask(method, JitCompileTask::kAllocateProfile));
637 }
638 }
639 // Avoid jumping more than one state at a time.
640 new_count = std::min(new_count, hot_method_threshold_ - 1);
Calin Juravleffc87072016-04-20 14:22:09 +0100641 } else if (use_jit_compilation_) {
642 if (starting_count < hot_method_threshold_) {
643 if ((new_count >= hot_method_threshold_) &&
644 !code_cache_->ContainsPc(method->GetEntryPointFromQuickCompiledCode())) {
645 DCHECK(thread_pool_ != nullptr);
646 thread_pool_->AddTask(self, new JitCompileTask(method, JitCompileTask::kCompile));
647 }
648 // Avoid jumping more than one state at a time.
649 new_count = std::min(new_count, osr_method_threshold_ - 1);
650 } else if (starting_count < osr_method_threshold_) {
651 if (!with_backedges) {
652 // If the samples don't contain any back edge, we don't increment the hotness.
653 return;
654 }
655 if ((new_count >= osr_method_threshold_) && !code_cache_->IsOsrCompiled(method)) {
656 DCHECK(thread_pool_ != nullptr);
657 thread_pool_->AddTask(self, new JitCompileTask(method, JitCompileTask::kCompileOsr));
658 }
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100659 }
660 }
661 // Update hotness counter
662 method->SetCounter(new_count);
663}
664
665void Jit::MethodEntered(Thread* thread, ArtMethod* method) {
Calin Juravleffc87072016-04-20 14:22:09 +0100666 Runtime* runtime = Runtime::Current();
667 if (UNLIKELY(runtime->UseJitCompilation() && runtime->GetJit()->JitAtFirstUse())) {
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100668 // The compiler requires a ProfilingInfo object.
669 ProfilingInfo::Create(thread, method, /* retry_allocation */ true);
670 JitCompileTask compile_task(method, JitCompileTask::kCompile);
671 compile_task.Run(thread);
672 return;
673 }
674
Andreas Gampe542451c2016-07-26 09:02:02 -0700675 ProfilingInfo* profiling_info = method->GetProfilingInfo(kRuntimePointerSize);
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100676 // Update the entrypoint if the ProfilingInfo has one. The interpreter will call it
677 // instead of interpreting the method.
Nicolas Geoffray480d5102016-04-18 12:09:30 +0100678 if ((profiling_info != nullptr) && (profiling_info->GetSavedEntryPoint() != nullptr)) {
679 Runtime::Current()->GetInstrumentation()->UpdateMethodsCode(
680 method, profiling_info->GetSavedEntryPoint());
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100681 } else {
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100682 AddSamples(thread, method, 1, /* with_backedges */false);
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100683 }
684}
685
Mathieu Chartier268764d2016-09-13 12:09:38 -0700686void Jit::InvokeVirtualOrInterface(mirror::Object* this_object,
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100687 ArtMethod* caller,
688 uint32_t dex_pc,
689 ArtMethod* callee ATTRIBUTE_UNUSED) {
Mathieu Chartier268764d2016-09-13 12:09:38 -0700690 ScopedAssertNoThreadSuspension ants(__FUNCTION__);
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100691 DCHECK(this_object != nullptr);
Andreas Gampe542451c2016-07-26 09:02:02 -0700692 ProfilingInfo* info = caller->GetProfilingInfo(kRuntimePointerSize);
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100693 if (info != nullptr) {
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100694 info->AddInvokeInfo(dex_pc, this_object->GetClass());
695 }
696}
697
698void Jit::WaitForCompilationToFinish(Thread* self) {
699 if (thread_pool_ != nullptr) {
700 thread_pool_->Wait(self, false, false);
701 }
702}
703
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800704} // namespace jit
705} // namespace art