blob: b6b7eb1841059fadc64b48591d3a28d8b70db2d5 [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 Gampe2a5c4682015-08-14 08:22:54 -070022#include "debugger.h"
Mathieu Chartiere5f13e52015-02-24 09:37:21 -080023#include "entrypoints/runtime_asm_entrypoints.h"
24#include "interpreter/interpreter.h"
25#include "jit_code_cache.h"
Calin Juravle31f2c152015-10-23 17:56:15 +010026#include "oat_file_manager.h"
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +000027#include "oat_quick_method_header.h"
Calin Juravle31f2c152015-10-23 17:56:15 +010028#include "offline_profiling_info.h"
Calin Juravle4d77b6a2015-12-01 18:38:09 +000029#include "profile_saver.h"
Mathieu Chartiere5f13e52015-02-24 09:37:21 -080030#include "runtime.h"
31#include "runtime_options.h"
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +000032#include "stack_map.h"
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +010033#include "thread_list.h"
Mathieu Chartiere5f13e52015-02-24 09:37:21 -080034#include "utils.h"
35
36namespace art {
37namespace jit {
38
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +000039static constexpr bool kEnableOnStackReplacement = true;
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +010040// At what priority to schedule jit threads. 9 is the lowest foreground priority on device.
41static constexpr int kJitPoolThreadPthreadPriority = 9;
Nicolas Geoffraye8662132016-02-15 10:00:42 +000042
Mathieu Chartier72918ea2016-03-24 11:07:06 -070043// JIT compiler
44void* Jit::jit_library_handle_= nullptr;
45void* Jit::jit_compiler_handle_ = nullptr;
46void* (*Jit::jit_load_)(bool*) = nullptr;
47void (*Jit::jit_unload_)(void*) = nullptr;
48bool (*Jit::jit_compile_method_)(void*, ArtMethod*, Thread*, bool) = nullptr;
49void (*Jit::jit_types_loaded_)(void*, mirror::Class**, size_t count) = nullptr;
50bool Jit::generate_debug_info_ = false;
51
Mathieu Chartiere5f13e52015-02-24 09:37:21 -080052JitOptions* JitOptions::CreateFromRuntimeArguments(const RuntimeArgumentMap& options) {
Mathieu Chartiere5f13e52015-02-24 09:37:21 -080053 auto* jit_options = new JitOptions;
Calin Juravleffc87072016-04-20 14:22:09 +010054 jit_options->use_jit_compilation_ = options.GetOrDefault(RuntimeArgumentMap::UseJitCompilation);
Nicolas Geoffray83f080a2016-03-08 16:50:21 +000055
Nicolas Geoffray0a3be162015-11-18 11:15:22 +000056 jit_options->code_cache_initial_capacity_ =
57 options.GetOrDefault(RuntimeArgumentMap::JITCodeCacheInitialCapacity);
58 jit_options->code_cache_max_capacity_ =
59 options.GetOrDefault(RuntimeArgumentMap::JITCodeCacheMaxCapacity);
Mathieu Chartiera4885cb2015-03-09 15:38:54 -070060 jit_options->dump_info_on_shutdown_ =
61 options.Exists(RuntimeArgumentMap::DumpJITInfoOnShutdown);
Calin Juravle31f2c152015-10-23 17:56:15 +010062 jit_options->save_profiling_info_ =
Nicolas Geoffray83f080a2016-03-08 16:50:21 +000063 options.GetOrDefault(RuntimeArgumentMap::JITSaveProfilingInfo);
64
65 jit_options->compile_threshold_ = options.GetOrDefault(RuntimeArgumentMap::JITCompileThreshold);
66 if (jit_options->compile_threshold_ > std::numeric_limits<uint16_t>::max()) {
67 LOG(FATAL) << "Method compilation threshold is above its internal limit.";
68 }
69
70 if (options.Exists(RuntimeArgumentMap::JITWarmupThreshold)) {
71 jit_options->warmup_threshold_ = *options.Get(RuntimeArgumentMap::JITWarmupThreshold);
72 if (jit_options->warmup_threshold_ > std::numeric_limits<uint16_t>::max()) {
73 LOG(FATAL) << "Method warmup threshold is above its internal limit.";
74 }
75 } else {
76 jit_options->warmup_threshold_ = jit_options->compile_threshold_ / 2;
77 }
78
79 if (options.Exists(RuntimeArgumentMap::JITOsrThreshold)) {
80 jit_options->osr_threshold_ = *options.Get(RuntimeArgumentMap::JITOsrThreshold);
81 if (jit_options->osr_threshold_ > std::numeric_limits<uint16_t>::max()) {
82 LOG(FATAL) << "Method on stack replacement threshold is above its internal limit.";
83 }
84 } else {
85 jit_options->osr_threshold_ = jit_options->compile_threshold_ * 2;
86 if (jit_options->osr_threshold_ > std::numeric_limits<uint16_t>::max()) {
87 jit_options->osr_threshold_ = std::numeric_limits<uint16_t>::max();
88 }
89 }
90
Calin Juravleb2771b42016-04-07 17:09:25 +010091 if (options.Exists(RuntimeArgumentMap::JITPriorityThreadWeight)) {
92 jit_options->priority_thread_weight_ =
93 *options.Get(RuntimeArgumentMap::JITPriorityThreadWeight);
94 if (jit_options->priority_thread_weight_ > jit_options->warmup_threshold_) {
95 LOG(FATAL) << "Priority thread weight is above the warmup threshold.";
96 } else if (jit_options->priority_thread_weight_ == 0) {
97 LOG(FATAL) << "Priority thread weight cannot be 0.";
98 }
99 } else {
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100100 jit_options->priority_thread_weight_ = std::max(
101 jit_options->warmup_threshold_ / Jit::kDefaultPriorityThreadWeightRatio,
102 static_cast<size_t>(1));
Calin Juravleb2771b42016-04-07 17:09:25 +0100103 }
104
Calin Juravle155ff3d2016-04-27 14:14:58 +0100105 if (options.Exists(RuntimeArgumentMap::JITInvokeTransitionWeight)) {
Nicolas Geoffray7c9f3ba2016-05-06 16:52:36 +0100106 jit_options->invoke_transition_weight_ =
107 *options.Get(RuntimeArgumentMap::JITInvokeTransitionWeight);
Calin Juravle155ff3d2016-04-27 14:14:58 +0100108 if (jit_options->invoke_transition_weight_ > jit_options->warmup_threshold_) {
109 LOG(FATAL) << "Invoke transition weight is above the warmup threshold.";
110 } else if (jit_options->invoke_transition_weight_ == 0) {
Nicolas Geoffray7c9f3ba2016-05-06 16:52:36 +0100111 LOG(FATAL) << "Invoke transition weight cannot be 0.";
Calin Juravle155ff3d2016-04-27 14:14:58 +0100112 }
Calin Juravle155ff3d2016-04-27 14:14:58 +0100113 } else {
114 jit_options->invoke_transition_weight_ = std::max(
115 jit_options->warmup_threshold_ / Jit::kDefaultInvokeTransitionWeightRatio,
116 static_cast<size_t>(1));;
117 }
118
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800119 return jit_options;
120}
121
Calin Juravleb2771b42016-04-07 17:09:25 +0100122bool Jit::ShouldUsePriorityThreadWeight() {
Calin Juravle97cbc922016-04-15 16:16:35 +0100123 return Runtime::Current()->InJankPerceptibleProcessState()
124 && Thread::Current()->IsJitSensitiveThread();
Calin Juravleb2771b42016-04-07 17:09:25 +0100125}
126
Mathieu Chartiera4885cb2015-03-09 15:38:54 -0700127void Jit::DumpInfo(std::ostream& os) {
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +0000128 code_cache_->Dump(os);
Mathieu Chartiera4885cb2015-03-09 15:38:54 -0700129 cumulative_timings_.Dump(os);
Nicolas Geoffraya4f81542016-03-08 16:57:48 +0000130 MutexLock mu(Thread::Current(), lock_);
131 memory_use_.PrintMemoryUse(os);
Mathieu Chartiera4885cb2015-03-09 15:38:54 -0700132}
133
Calin Juravleb8e69992016-03-09 15:37:48 +0000134void Jit::DumpForSigQuit(std::ostream& os) {
135 DumpInfo(os);
136 ProfileSaver::DumpInstanceInfo(os);
137}
138
Mathieu Chartiera4885cb2015-03-09 15:38:54 -0700139void Jit::AddTimingLogger(const TimingLogger& logger) {
140 cumulative_timings_.AddLogger(logger);
141}
142
Mathieu Chartier72918ea2016-03-24 11:07:06 -0700143Jit::Jit() : dump_info_on_shutdown_(false),
Nicolas Geoffraya25dce92016-01-12 16:41:10 +0000144 cumulative_timings_("JIT timings"),
Nicolas Geoffraya4f81542016-03-08 16:57:48 +0000145 memory_use_("Memory used for compilation", 16),
146 lock_("JIT memory use lock"),
Calin Juravleffc87072016-04-20 14:22:09 +0100147 use_jit_compilation_(true),
Mathieu Chartier72918ea2016-03-24 11:07:06 -0700148 save_profiling_info_(false) {}
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800149
150Jit* Jit::Create(JitOptions* options, std::string* error_msg) {
Calin Juravleffc87072016-04-20 14:22:09 +0100151 DCHECK(options->UseJitCompilation() || options->GetSaveProfilingInfo());
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 Juravle4d77b6a2015-12-01 18:38:09 +0000166 jit->save_profiling_info_ = options->GetSaveProfilingInfo();
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()
171 << ", save_profiling_info=" << options->GetSaveProfilingInfo();
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.
262 ArtMethod* method_to_compile = method->GetInterfaceMethodIfProxy(sizeof(void*));
263 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 Juravle4d77b6a2015-12-01 18:38:09 +0000313 if (save_profiling_info_) {
Calin Juravlec90bc922016-02-24 10:13:09 +0000314 ProfileSaver::Start(filename, code_cache_.get(), code_paths, foreign_dex_profile_path, app_dir);
Calin Juravle31f2c152015-10-23 17:56:15 +0100315 }
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000316}
317
318void Jit::StopProfileSaver() {
319 if (save_profiling_info_ && ProfileSaver::IsStarted()) {
Calin Juravleb8e69992016-03-09 15:37:48 +0000320 ProfileSaver::Stop(dump_info_on_shutdown_);
Calin Juravle31f2c152015-10-23 17:56:15 +0100321 }
322}
323
Siva Chandra05d24152016-01-05 17:43:17 -0800324bool Jit::JitAtFirstUse() {
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100325 return HotMethodThreshold() == 0;
Siva Chandra05d24152016-01-05 17:43:17 -0800326}
327
Nicolas Geoffray35122442016-03-02 12:05:30 +0000328bool Jit::CanInvokeCompiledCode(ArtMethod* method) {
329 return code_cache_->ContainsPc(method->GetEntryPointFromQuickCompiledCode());
330}
331
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800332Jit::~Jit() {
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000333 DCHECK(!save_profiling_info_ || !ProfileSaver::IsStarted());
Mathieu Chartiera4885cb2015-03-09 15:38:54 -0700334 if (dump_info_on_shutdown_) {
335 DumpInfo(LOG(INFO));
336 }
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800337 DeleteThreadPool();
338 if (jit_compiler_handle_ != nullptr) {
339 jit_unload_(jit_compiler_handle_);
Mathieu Chartier72918ea2016-03-24 11:07:06 -0700340 jit_compiler_handle_ = nullptr;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800341 }
342 if (jit_library_handle_ != nullptr) {
343 dlclose(jit_library_handle_);
Mathieu Chartier72918ea2016-03-24 11:07:06 -0700344 jit_library_handle_ = nullptr;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800345 }
346}
347
Tamas Berghammer160e6df2016-01-05 14:29:02 +0000348void Jit::NewTypeLoadedIfUsingJit(mirror::Class* type) {
Calin Juravleffc87072016-04-20 14:22:09 +0100349 if (!Runtime::Current()->UseJitCompilation()) {
350 // No need to notify if we only use the JIT to save profiles.
351 return;
352 }
Tamas Berghammer160e6df2016-01-05 14:29:02 +0000353 jit::Jit* jit = Runtime::Current()->GetJit();
Calin Juravleffc87072016-04-20 14:22:09 +0100354 if (jit->generate_debug_info_) {
Tamas Berghammerfffbee42016-01-15 13:09:34 +0000355 DCHECK(jit->jit_types_loaded_ != nullptr);
356 jit->jit_types_loaded_(jit->jit_compiler_handle_, &type, 1);
357 }
358}
359
360void Jit::DumpTypeInfoForLoadedTypes(ClassLinker* linker) {
361 struct CollectClasses : public ClassVisitor {
Mathieu Chartier1aa8ec22016-02-01 10:34:47 -0800362 bool operator()(mirror::Class* klass) override {
Tamas Berghammerfffbee42016-01-15 13:09:34 +0000363 classes_.push_back(klass);
364 return true;
365 }
Mathieu Chartier9b1c9b72016-02-02 10:09:58 -0800366 std::vector<mirror::Class*> classes_;
Tamas Berghammerfffbee42016-01-15 13:09:34 +0000367 };
368
369 if (generate_debug_info_) {
370 ScopedObjectAccess so(Thread::Current());
371
372 CollectClasses visitor;
373 linker->VisitClasses(&visitor);
374 jit_types_loaded_(jit_compiler_handle_, visitor.classes_.data(), visitor.classes_.size());
Tamas Berghammer160e6df2016-01-05 14:29:02 +0000375 }
376}
377
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000378extern "C" void art_quick_osr_stub(void** stack,
379 uint32_t stack_size_in_bytes,
380 const uint8_t* native_pc,
381 JValue* result,
382 const char* shorty,
383 Thread* self);
384
385bool Jit::MaybeDoOnStackReplacement(Thread* thread,
386 ArtMethod* method,
387 uint32_t dex_pc,
388 int32_t dex_pc_offset,
389 JValue* result) {
Nicolas Geoffraye8662132016-02-15 10:00:42 +0000390 if (!kEnableOnStackReplacement) {
391 return false;
392 }
393
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000394 Jit* jit = Runtime::Current()->GetJit();
395 if (jit == nullptr) {
396 return false;
397 }
398
Nicolas Geoffrayb88d59e2016-02-17 11:31:49 +0000399 if (UNLIKELY(__builtin_frame_address(0) < thread->GetStackEnd())) {
400 // Don't attempt to do an OSR if we are close to the stack limit. Since
401 // the interpreter frames are still on stack, OSR has the potential
402 // to stack overflow even for a simple loop.
403 // b/27094810.
404 return false;
405 }
406
Nicolas Geoffrayd9bc4332016-02-05 23:32:25 +0000407 // Get the actual Java method if this method is from a proxy class. The compiler
408 // and the JIT code cache do not expect methods from proxy classes.
409 method = method->GetInterfaceMethodIfProxy(sizeof(void*));
410
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000411 // Cheap check if the method has been compiled already. That's an indicator that we should
412 // osr into it.
413 if (!jit->GetCodeCache()->ContainsPc(method->GetEntryPointFromQuickCompiledCode())) {
414 return false;
415 }
416
Nicolas Geoffrayc0b27962016-02-16 12:06:05 +0000417 // Fetch some data before looking up for an OSR method. We don't want thread
418 // suspension once we hold an OSR method, as the JIT code cache could delete the OSR
419 // method while we are being suspended.
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000420 const size_t number_of_vregs = method->GetCodeItem()->registers_size_;
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000421 const char* shorty = method->GetShorty();
422 std::string method_name(VLOG_IS_ON(jit) ? PrettyMethod(method) : "");
423 void** memory = nullptr;
424 size_t frame_size = 0;
425 ShadowFrame* shadow_frame = nullptr;
426 const uint8_t* native_pc = nullptr;
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000427
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000428 {
429 ScopedAssertNoThreadSuspension sts(thread, "Holding OSR method");
430 const OatQuickMethodHeader* osr_method = jit->GetCodeCache()->LookupOsrMethodHeader(method);
431 if (osr_method == nullptr) {
432 // No osr method yet, just return to the interpreter.
433 return false;
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000434 }
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000435
436 CodeInfo code_info = osr_method->GetOptimizedCodeInfo();
David Srbecky09ed0982016-02-12 21:58:43 +0000437 CodeInfoEncoding encoding = code_info.ExtractEncoding();
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000438
439 // Find stack map starting at the target dex_pc.
440 StackMap stack_map = code_info.GetOsrStackMapForDexPc(dex_pc + dex_pc_offset, encoding);
441 if (!stack_map.IsValid()) {
442 // There is no OSR stack map for this dex pc offset. Just return to the interpreter in the
443 // hope that the next branch has one.
444 return false;
445 }
446
447 // We found a stack map, now fill the frame with dex register values from the interpreter's
448 // shadow frame.
449 DexRegisterMap vreg_map =
450 code_info.GetDexRegisterMapOf(stack_map, encoding, number_of_vregs);
451
452 frame_size = osr_method->GetFrameSizeInBytes();
453
454 // Allocate memory to put shadow frame values. The osr stub will copy that memory to
455 // stack.
456 // Note that we could pass the shadow frame to the stub, and let it copy the values there,
457 // but that is engineering complexity not worth the effort for something like OSR.
458 memory = reinterpret_cast<void**>(malloc(frame_size));
459 CHECK(memory != nullptr);
460 memset(memory, 0, frame_size);
461
462 // Art ABI: ArtMethod is at the bottom of the stack.
463 memory[0] = method;
464
465 shadow_frame = thread->PopShadowFrame();
466 if (!vreg_map.IsValid()) {
467 // If we don't have a dex register map, then there are no live dex registers at
468 // this dex pc.
469 } else {
470 for (uint16_t vreg = 0; vreg < number_of_vregs; ++vreg) {
471 DexRegisterLocation::Kind location =
472 vreg_map.GetLocationKind(vreg, number_of_vregs, code_info, encoding);
473 if (location == DexRegisterLocation::Kind::kNone) {
Nicolas Geoffrayc0b27962016-02-16 12:06:05 +0000474 // Dex register is dead or uninitialized.
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000475 continue;
476 }
477
478 if (location == DexRegisterLocation::Kind::kConstant) {
479 // We skip constants because the compiled code knows how to handle them.
480 continue;
481 }
482
David Srbecky7dc11782016-02-25 13:23:56 +0000483 DCHECK_EQ(location, DexRegisterLocation::Kind::kInStack);
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000484
485 int32_t vreg_value = shadow_frame->GetVReg(vreg);
486 int32_t slot_offset = vreg_map.GetStackOffsetInBytes(vreg,
487 number_of_vregs,
488 code_info,
489 encoding);
490 DCHECK_LT(slot_offset, static_cast<int32_t>(frame_size));
491 DCHECK_GT(slot_offset, 0);
492 (reinterpret_cast<int32_t*>(memory))[slot_offset / sizeof(int32_t)] = vreg_value;
493 }
494 }
495
David Srbecky09ed0982016-02-12 21:58:43 +0000496 native_pc = stack_map.GetNativePcOffset(encoding.stack_map_encoding) +
497 osr_method->GetEntryPoint();
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000498 VLOG(jit) << "Jumping to "
499 << method_name
500 << "@"
501 << std::hex << reinterpret_cast<uintptr_t>(native_pc);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000502 }
503
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000504 {
505 ManagedStack fragment;
506 thread->PushManagedStackFragment(&fragment);
507 (*art_quick_osr_stub)(memory,
508 frame_size,
509 native_pc,
510 result,
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000511 shorty,
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000512 thread);
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000513
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000514 if (UNLIKELY(thread->GetException() == Thread::GetDeoptimizationException())) {
515 thread->DeoptimizeWithDeoptimizationException(result);
516 }
517 thread->PopManagedStackFragment(fragment);
518 }
519 free(memory);
520 thread->PushShadowFrame(shadow_frame);
Nicolas Geoffrayd186dd82016-02-16 10:03:44 +0000521 VLOG(jit) << "Done running OSR code for " << method_name;
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000522 return true;
523}
524
Nicolas Geoffraya4f81542016-03-08 16:57:48 +0000525void Jit::AddMemoryUsage(ArtMethod* method, size_t bytes) {
526 if (bytes > 4 * MB) {
527 LOG(INFO) << "Compiler allocated "
528 << PrettySize(bytes)
529 << " to compile "
530 << PrettyMethod(method);
531 }
532 MutexLock mu(Thread::Current(), lock_);
533 memory_use_.AddValue(bytes);
534}
535
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100536class JitCompileTask FINAL : public Task {
537 public:
538 enum TaskKind {
539 kAllocateProfile,
540 kCompile,
541 kCompileOsr
542 };
543
544 JitCompileTask(ArtMethod* method, TaskKind kind) : method_(method), kind_(kind) {
545 ScopedObjectAccess soa(Thread::Current());
546 // Add a global ref to the class to prevent class unloading until compilation is done.
547 klass_ = soa.Vm()->AddGlobalRef(soa.Self(), method_->GetDeclaringClass());
548 CHECK(klass_ != nullptr);
549 }
550
551 ~JitCompileTask() {
552 ScopedObjectAccess soa(Thread::Current());
553 soa.Vm()->DeleteGlobalRef(soa.Self(), klass_);
554 }
555
556 void Run(Thread* self) OVERRIDE {
557 ScopedObjectAccess soa(self);
558 if (kind_ == kCompile) {
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100559 Runtime::Current()->GetJit()->CompileMethod(method_, self, /* osr */ false);
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100560 } else if (kind_ == kCompileOsr) {
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100561 Runtime::Current()->GetJit()->CompileMethod(method_, self, /* osr */ true);
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100562 } else {
563 DCHECK(kind_ == kAllocateProfile);
564 if (ProfilingInfo::Create(self, method_, /* retry_allocation */ true)) {
565 VLOG(jit) << "Start profiling " << PrettyMethod(method_);
566 }
567 }
Calin Juravlea2638922016-04-29 16:44:11 +0100568 ProfileSaver::NotifyJitActivity();
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100569 }
570
571 void Finalize() OVERRIDE {
572 delete this;
573 }
574
575 private:
576 ArtMethod* const method_;
577 const TaskKind kind_;
578 jobject klass_;
579
580 DISALLOW_IMPLICIT_CONSTRUCTORS(JitCompileTask);
581};
582
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100583void Jit::AddSamples(Thread* self, ArtMethod* method, uint16_t count, bool with_backedges) {
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100584 if (thread_pool_ == nullptr) {
585 // Should only see this when shutting down.
586 DCHECK(Runtime::Current()->IsShuttingDown(self));
587 return;
588 }
589
Nicolas Geoffray250a3782016-04-20 16:27:53 +0100590 if (method->IsClassInitializer() || method->IsNative() || !method->IsCompilable()) {
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100591 // We do not want to compile such methods.
592 return;
593 }
594 DCHECK(thread_pool_ != nullptr);
595 DCHECK_GT(warm_method_threshold_, 0);
596 DCHECK_GT(hot_method_threshold_, warm_method_threshold_);
597 DCHECK_GT(osr_method_threshold_, hot_method_threshold_);
598 DCHECK_GE(priority_thread_weight_, 1);
599 DCHECK_LE(priority_thread_weight_, hot_method_threshold_);
600
601 int32_t starting_count = method->GetCounter();
602 if (Jit::ShouldUsePriorityThreadWeight()) {
603 count *= priority_thread_weight_;
604 }
605 int32_t new_count = starting_count + count; // int32 here to avoid wrap-around;
606 if (starting_count < warm_method_threshold_) {
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100607 if ((new_count >= warm_method_threshold_) &&
608 (method->GetProfilingInfo(sizeof(void*)) == nullptr)) {
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100609 bool success = ProfilingInfo::Create(self, method, /* retry_allocation */ false);
610 if (success) {
611 VLOG(jit) << "Start profiling " << PrettyMethod(method);
612 }
613
614 if (thread_pool_ == nullptr) {
615 // Calling ProfilingInfo::Create might put us in a suspended state, which could
616 // lead to the thread pool being deleted when we are shutting down.
617 DCHECK(Runtime::Current()->IsShuttingDown(self));
618 return;
619 }
620
621 if (!success) {
622 // We failed allocating. Instead of doing the collection on the Java thread, we push
623 // an allocation to a compiler thread, that will do the collection.
624 thread_pool_->AddTask(self, new JitCompileTask(method, JitCompileTask::kAllocateProfile));
625 }
626 }
627 // Avoid jumping more than one state at a time.
628 new_count = std::min(new_count, hot_method_threshold_ - 1);
Calin Juravleffc87072016-04-20 14:22:09 +0100629 } else if (use_jit_compilation_) {
630 if (starting_count < hot_method_threshold_) {
631 if ((new_count >= hot_method_threshold_) &&
632 !code_cache_->ContainsPc(method->GetEntryPointFromQuickCompiledCode())) {
633 DCHECK(thread_pool_ != nullptr);
634 thread_pool_->AddTask(self, new JitCompileTask(method, JitCompileTask::kCompile));
635 }
636 // Avoid jumping more than one state at a time.
637 new_count = std::min(new_count, osr_method_threshold_ - 1);
638 } else if (starting_count < osr_method_threshold_) {
639 if (!with_backedges) {
640 // If the samples don't contain any back edge, we don't increment the hotness.
641 return;
642 }
643 if ((new_count >= osr_method_threshold_) && !code_cache_->IsOsrCompiled(method)) {
644 DCHECK(thread_pool_ != nullptr);
645 thread_pool_->AddTask(self, new JitCompileTask(method, JitCompileTask::kCompileOsr));
646 }
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100647 }
648 }
649 // Update hotness counter
650 method->SetCounter(new_count);
651}
652
653void Jit::MethodEntered(Thread* thread, ArtMethod* method) {
Calin Juravleffc87072016-04-20 14:22:09 +0100654 Runtime* runtime = Runtime::Current();
655 if (UNLIKELY(runtime->UseJitCompilation() && runtime->GetJit()->JitAtFirstUse())) {
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100656 // The compiler requires a ProfilingInfo object.
657 ProfilingInfo::Create(thread, method, /* retry_allocation */ true);
658 JitCompileTask compile_task(method, JitCompileTask::kCompile);
659 compile_task.Run(thread);
660 return;
661 }
662
663 ProfilingInfo* profiling_info = method->GetProfilingInfo(sizeof(void*));
664 // Update the entrypoint if the ProfilingInfo has one. The interpreter will call it
665 // instead of interpreting the method.
Nicolas Geoffray480d5102016-04-18 12:09:30 +0100666 if ((profiling_info != nullptr) && (profiling_info->GetSavedEntryPoint() != nullptr)) {
667 Runtime::Current()->GetInstrumentation()->UpdateMethodsCode(
668 method, profiling_info->GetSavedEntryPoint());
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100669 } else {
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100670 AddSamples(thread, method, 1, /* with_backedges */false);
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100671 }
672}
673
674void Jit::InvokeVirtualOrInterface(Thread* thread,
675 mirror::Object* this_object,
676 ArtMethod* caller,
677 uint32_t dex_pc,
678 ArtMethod* callee ATTRIBUTE_UNUSED) {
679 ScopedAssertNoThreadSuspension ants(thread, __FUNCTION__);
680 DCHECK(this_object != nullptr);
681 ProfilingInfo* info = caller->GetProfilingInfo(sizeof(void*));
682 if (info != nullptr) {
683 // Since the instrumentation is marked from the declaring class we need to mark the card so
684 // that mod-union tables and card rescanning know about the update.
685 Runtime::Current()->GetHeap()->WriteBarrierEveryFieldOf(caller->GetDeclaringClass());
686 info->AddInvokeInfo(dex_pc, this_object->GetClass());
687 }
688}
689
690void Jit::WaitForCompilationToFinish(Thread* self) {
691 if (thread_pool_ != nullptr) {
692 thread_pool_->Wait(self, false, false);
693 }
694}
695
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800696} // namespace jit
697} // namespace art