blob: a8692a070241c607b015f812e9ac9a87895c25a7 [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_code_cache.h"
18
19#include <sstream>
20
Andreas Gampe5629d2d2017-05-15 16:28:13 -070021#include "arch/context.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070022#include "art_method-inl.h"
Andreas Gampe542451c2016-07-26 09:02:02 -070023#include "base/enums.h"
Andreas Gampef0f3c592018-06-26 13:28:00 -070024#include "base/histogram-inl.h"
Andreas Gampe170331f2017-12-07 18:41:03 -080025#include "base/logging.h" // For VLOG.
David Sehr79e26072018-04-06 17:58:50 -070026#include "base/mem_map.h"
David Sehrc431b9d2018-03-02 12:01:51 -080027#include "base/quasi_atomic.h"
Calin Juravle66f55232015-12-08 15:09:10 +000028#include "base/stl_util.h"
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -080029#include "base/systrace.h"
Calin Juravle31f2c152015-10-23 17:56:15 +010030#include "base/time_utils.h"
Mingyao Yang063fc772016-08-02 11:02:54 -070031#include "cha.h"
David Srbecky5cc349f2015-12-18 15:04:48 +000032#include "debugger_interface.h"
David Sehr9e734c72018-01-04 17:56:19 -080033#include "dex/dex_file_loader.h"
Andreas Gampef0f3c592018-06-26 13:28:00 -070034#include "dex/method_reference.h"
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +010035#include "entrypoints/runtime_asm_entrypoints.h"
36#include "gc/accounting/bitmap-inl.h"
Nicolas Geoffraycf48fa02016-07-30 22:49:11 +010037#include "gc/scoped_gc_critical_section.h"
Vladimir Markob0b68cf2017-11-14 18:11:50 +000038#include "handle.h"
Andreas Gampef0f3c592018-06-26 13:28:00 -070039#include "instrumentation.h"
Andreas Gampeb2d18fa2017-06-06 20:46:10 -070040#include "intern_table.h"
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +000041#include "jit/jit.h"
Nicolas Geoffray26705e22015-10-28 12:50:11 +000042#include "jit/profiling_info.h"
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +010043#include "linear_alloc.h"
Mathieu Chartiere5f13e52015-02-24 09:37:21 -080044#include "oat_file-inl.h"
Andreas Gampe513061a2017-06-01 09:17:34 -070045#include "oat_quick_method_header.h"
Andreas Gampe5d08fcc2017-06-05 17:56:46 -070046#include "object_callbacks.h"
David Sehr82d046e2018-04-23 08:14:19 -070047#include "profile/profile_compilation_info.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070048#include "scoped_thread_state_change-inl.h"
Andreas Gampe513061a2017-06-01 09:17:34 -070049#include "stack.h"
Vladimir Markob0b68cf2017-11-14 18:11:50 +000050#include "thread-current-inl.h"
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +010051#include "thread_list.h"
Mathieu Chartiere5f13e52015-02-24 09:37:21 -080052
53namespace art {
54namespace jit {
55
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +010056static constexpr int kProtData = PROT_READ | PROT_WRITE;
57static constexpr int kProtCode = PROT_READ | PROT_EXEC;
58
Nicolas Geoffray933330a2016-03-16 14:20:06 +000059static constexpr size_t kCodeSizeLogThreshold = 50 * KB;
60static constexpr size_t kStackMapSizeLogThreshold = 50 * KB;
61
Vladimir Marko2196c652017-11-30 16:16:07 +000062class JitCodeCache::JniStubKey {
63 public:
64 explicit JniStubKey(ArtMethod* method) REQUIRES_SHARED(Locks::mutator_lock_)
65 : shorty_(method->GetShorty()),
66 is_static_(method->IsStatic()),
67 is_fast_native_(method->IsFastNative()),
68 is_critical_native_(method->IsCriticalNative()),
69 is_synchronized_(method->IsSynchronized()) {
70 DCHECK(!(is_fast_native_ && is_critical_native_));
71 }
72
73 bool operator<(const JniStubKey& rhs) const {
74 if (is_static_ != rhs.is_static_) {
75 return rhs.is_static_;
76 }
77 if (is_synchronized_ != rhs.is_synchronized_) {
78 return rhs.is_synchronized_;
79 }
80 if (is_fast_native_ != rhs.is_fast_native_) {
81 return rhs.is_fast_native_;
82 }
83 if (is_critical_native_ != rhs.is_critical_native_) {
84 return rhs.is_critical_native_;
85 }
86 return strcmp(shorty_, rhs.shorty_) < 0;
87 }
88
89 // Update the shorty to point to another method's shorty. Call this function when removing
90 // the method that references the old shorty from JniCodeData and not removing the entire
91 // JniCodeData; the old shorty may become a dangling pointer when that method is unloaded.
92 void UpdateShorty(ArtMethod* method) const REQUIRES_SHARED(Locks::mutator_lock_) {
93 const char* shorty = method->GetShorty();
94 DCHECK_STREQ(shorty_, shorty);
95 shorty_ = shorty;
96 }
97
98 private:
99 // The shorty points to a DexFile data and may need to change
100 // to point to the same shorty in a different DexFile.
101 mutable const char* shorty_;
102
103 const bool is_static_;
104 const bool is_fast_native_;
105 const bool is_critical_native_;
106 const bool is_synchronized_;
107};
108
109class JitCodeCache::JniStubData {
110 public:
111 JniStubData() : code_(nullptr), methods_() {}
112
113 void SetCode(const void* code) {
114 DCHECK(code != nullptr);
115 code_ = code;
116 }
117
118 const void* GetCode() const {
119 return code_;
120 }
121
122 bool IsCompiled() const {
123 return GetCode() != nullptr;
124 }
125
126 void AddMethod(ArtMethod* method) {
127 if (!ContainsElement(methods_, method)) {
128 methods_.push_back(method);
129 }
130 }
131
132 const std::vector<ArtMethod*>& GetMethods() const {
133 return methods_;
134 }
135
136 void RemoveMethodsIn(const LinearAlloc& alloc) {
137 auto kept_end = std::remove_if(
138 methods_.begin(),
139 methods_.end(),
140 [&alloc](ArtMethod* method) { return alloc.ContainsUnsafe(method); });
141 methods_.erase(kept_end, methods_.end());
142 }
143
144 bool RemoveMethod(ArtMethod* method) {
145 auto it = std::find(methods_.begin(), methods_.end(), method);
146 if (it != methods_.end()) {
147 methods_.erase(it);
148 return true;
149 } else {
150 return false;
151 }
152 }
153
154 void MoveObsoleteMethod(ArtMethod* old_method, ArtMethod* new_method) {
155 std::replace(methods_.begin(), methods_.end(), old_method, new_method);
156 }
157
158 private:
159 const void* code_;
160 std::vector<ArtMethod*> methods_;
161};
162
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000163JitCodeCache* JitCodeCache::Create(size_t initial_capacity,
164 size_t max_capacity,
Nicolas Geoffraya25dce92016-01-12 16:41:10 +0000165 bool generate_debug_info,
Calin Juravle016fcbe22018-05-03 19:47:35 -0700166 bool used_only_for_profile_data,
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000167 std::string* error_msg) {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800168 ScopedTrace trace(__PRETTY_FUNCTION__);
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100169 CHECK_GE(max_capacity, initial_capacity);
Nicolas Geoffraya25dce92016-01-12 16:41:10 +0000170
David Sehrd1dbb742017-07-17 11:20:38 -0700171 // Generating debug information is for using the Linux perf tool on
172 // host which does not work with ashmem.
Steve Austin882ed6b2018-06-08 11:40:38 -0700173 // Also, targets linux and fuchsia do not support ashmem.
174 bool use_ashmem = !generate_debug_info && !kIsTargetLinux && !kIsTargetFuchsia;
David Sehrd1dbb742017-07-17 11:20:38 -0700175
Nicolas Geoffraya25dce92016-01-12 16:41:10 +0000176 // With 'perf', we want a 1-1 mapping between an address and a method.
Alex Light2d441b12018-06-08 15:33:21 -0700177 // We aren't able to keep method pointers live during the instrumentation method entry trampoline
178 // so we will just disable jit-gc if we are doing that.
179 bool garbage_collect_code = !generate_debug_info &&
180 !Runtime::Current()->GetInstrumentation()->AreExitStubsInstalled();
Nicolas Geoffraya25dce92016-01-12 16:41:10 +0000181
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000182 // We need to have 32 bit offsets from method headers in code cache which point to things
183 // in the data cache. If the maps are more than 4G apart, having multiple maps wouldn't work.
184 // Ensure we're below 1 GB to be safe.
185 if (max_capacity > 1 * GB) {
186 std::ostringstream oss;
187 oss << "Maxium code cache capacity is limited to 1 GB, "
188 << PrettySize(max_capacity) << " is too big";
189 *error_msg = oss.str();
190 return nullptr;
191 }
192
Calin Juravle016fcbe22018-05-03 19:47:35 -0700193 // Decide how we should map the code and data sections.
194 // If we use the code cache just for profiling we do not need to map the code section as
195 // executable.
196 // NOTE 1: this is yet another workaround to bypass strict SElinux policies in order to be able
197 // to profile system server.
198 // NOTE 2: We could just not create the code section at all but we will need to
199 // special case too many cases.
200 int memmap_flags_prot_code = used_only_for_profile_data ? (kProtCode & ~PROT_EXEC) : kProtCode;
201
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800202 std::string error_str;
203 // Map name specific for android_os_Debug.cpp accounting.
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000204 // Map in low 4gb to simplify accessing root tables for x86_64.
205 // We could do PC-relative addressing to avoid this problem, but that
206 // would require reserving code and data area before submitting, which
207 // means more windows for the code memory to be RWX.
Andreas Gampee4deaf32017-06-09 15:27:15 -0700208 std::unique_ptr<MemMap> data_map(MemMap::MapAnonymous(
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000209 "data-code-cache", nullptr,
210 max_capacity,
Andreas Gampee4deaf32017-06-09 15:27:15 -0700211 kProtData,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000212 /* low_4gb */ true,
213 /* reuse */ false,
214 &error_str,
Andreas Gampee4deaf32017-06-09 15:27:15 -0700215 use_ashmem));
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100216 if (data_map == nullptr) {
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800217 std::ostringstream oss;
Andreas Gampee4deaf32017-06-09 15:27:15 -0700218 oss << "Failed to create read write cache: " << error_str << " size=" << max_capacity;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800219 *error_msg = oss.str();
220 return nullptr;
221 }
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100222
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100223 // Align both capacities to page size, as that's the unit mspaces use.
224 initial_capacity = RoundDown(initial_capacity, 2 * kPageSize);
225 max_capacity = RoundDown(max_capacity, 2 * kPageSize);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100226
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100227 // Data cache is 1 / 2 of the map.
228 // TODO: Make this variable?
229 size_t data_size = max_capacity / 2;
230 size_t code_size = max_capacity - data_size;
231 DCHECK_EQ(code_size + data_size, max_capacity);
232 uint8_t* divider = data_map->Begin() + data_size;
David Sehrd1dbb742017-07-17 11:20:38 -0700233
Calin Juravle016fcbe22018-05-03 19:47:35 -0700234 MemMap* code_map = data_map->RemapAtEnd(
235 divider,
236 "jit-code-cache",
237 memmap_flags_prot_code | PROT_WRITE,
238 &error_str, use_ashmem);
David Sehrd1dbb742017-07-17 11:20:38 -0700239 if (code_map == nullptr) {
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100240 std::ostringstream oss;
241 oss << "Failed to create read write execute cache: " << error_str << " size=" << max_capacity;
242 *error_msg = oss.str();
David Sehrd1dbb742017-07-17 11:20:38 -0700243 return nullptr;
244 }
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100245 DCHECK_EQ(code_map->Begin(), divider);
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000246 data_size = initial_capacity / 2;
247 code_size = initial_capacity - data_size;
248 DCHECK_EQ(code_size + data_size, initial_capacity);
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100249 return new JitCodeCache(
Calin Juravle016fcbe22018-05-03 19:47:35 -0700250 code_map,
251 data_map.release(),
252 code_size,
253 data_size,
254 max_capacity,
255 garbage_collect_code,
256 memmap_flags_prot_code);
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800257}
258
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100259JitCodeCache::JitCodeCache(MemMap* code_map,
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000260 MemMap* data_map,
261 size_t initial_code_capacity,
262 size_t initial_data_capacity,
Nicolas Geoffraya25dce92016-01-12 16:41:10 +0000263 size_t max_capacity,
Calin Juravle016fcbe22018-05-03 19:47:35 -0700264 bool garbage_collect_code,
265 int memmap_flags_prot_code)
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100266 : lock_("Jit code cache", kJitCodeCacheLock),
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000267 lock_cond_("Jit code cache condition variable", lock_),
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100268 collection_in_progress_(false),
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100269 code_map_(code_map),
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000270 data_map_(data_map),
271 max_capacity_(max_capacity),
272 current_capacity_(initial_code_capacity + initial_data_capacity),
273 code_end_(initial_code_capacity),
274 data_end_(initial_data_capacity),
Nicolas Geoffray35122442016-03-02 12:05:30 +0000275 last_collection_increased_code_cache_(false),
Nicolas Geoffray0a522232016-01-19 09:34:58 +0000276 garbage_collect_code_(garbage_collect_code),
Nicolas Geoffrayb0d22082016-02-24 17:18:25 +0000277 used_memory_for_data_(0),
278 used_memory_for_code_(0),
Nicolas Geoffrayfcdd7292016-02-25 13:27:47 +0000279 number_of_compilations_(0),
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +0000280 number_of_osr_compilations_(0),
Nicolas Geoffray933330a2016-03-16 14:20:06 +0000281 number_of_collections_(0),
282 histogram_stack_map_memory_use_("Memory used for stack maps", 16),
283 histogram_code_memory_use_("Memory used for compiled code", 16),
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000284 histogram_profiling_info_memory_use_("Memory used for profiling info", 16),
285 is_weak_access_enabled_(true),
Calin Juravle016fcbe22018-05-03 19:47:35 -0700286 inline_cache_cond_("Jit inline cache condition variable", lock_),
287 memmap_flags_prot_code_(memmap_flags_prot_code) {
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100288
Nicolas Geoffrayc3fec4c2016-01-14 16:16:35 +0000289 DCHECK_GE(max_capacity, initial_code_capacity + initial_data_capacity);
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100290 code_mspace_ = create_mspace_with_base(code_map_->Begin(), code_end_, false /*locked*/);
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000291 data_mspace_ = create_mspace_with_base(data_map_->Begin(), data_end_, false /*locked*/);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100292
293 if (code_mspace_ == nullptr || data_mspace_ == nullptr) {
294 PLOG(FATAL) << "create_mspace_with_base failed";
295 }
296
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000297 SetFootprintLimit(current_capacity_);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100298
Mathieu Chartier8d8de0c2017-10-04 09:35:30 -0700299 CheckedCall(mprotect,
300 "mprotect jit code cache",
301 code_map_->Begin(),
302 code_map_->Size(),
Calin Juravle016fcbe22018-05-03 19:47:35 -0700303 memmap_flags_prot_code_);
Mathieu Chartier8d8de0c2017-10-04 09:35:30 -0700304 CheckedCall(mprotect,
305 "mprotect jit data cache",
306 data_map_->Begin(),
307 data_map_->Size(),
308 kProtData);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100309
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000310 VLOG(jit) << "Created jit code cache: initial data size="
311 << PrettySize(initial_data_capacity)
312 << ", initial code size="
313 << PrettySize(initial_code_capacity);
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800314}
315
Vladimir Markob0b68cf2017-11-14 18:11:50 +0000316JitCodeCache::~JitCodeCache() {}
317
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100318bool JitCodeCache::ContainsPc(const void* ptr) const {
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100319 return code_map_->Begin() <= ptr && ptr < code_map_->End();
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800320}
321
Alex Light2d441b12018-06-08 15:33:21 -0700322bool JitCodeCache::WillExecuteJitCode(ArtMethod* method) {
323 ScopedObjectAccess soa(art::Thread::Current());
324 ScopedAssertNoThreadSuspension sants(__FUNCTION__);
325 if (ContainsPc(method->GetEntryPointFromQuickCompiledCode())) {
326 return true;
327 } else if (method->GetEntryPointFromQuickCompiledCode() == GetQuickInstrumentationEntryPoint()) {
328 return FindCompiledCodeForInstrumentation(method) != nullptr;
329 }
330 return false;
331}
332
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000333bool JitCodeCache::ContainsMethod(ArtMethod* method) {
334 MutexLock mu(Thread::Current(), lock_);
Vladimir Marko2196c652017-11-30 16:16:07 +0000335 if (UNLIKELY(method->IsNative())) {
336 auto it = jni_stubs_map_.find(JniStubKey(method));
337 if (it != jni_stubs_map_.end() &&
338 it->second.IsCompiled() &&
339 ContainsElement(it->second.GetMethods(), method)) {
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000340 return true;
341 }
Vladimir Marko2196c652017-11-30 16:16:07 +0000342 } else {
343 for (const auto& it : method_code_map_) {
344 if (it.second == method) {
345 return true;
346 }
347 }
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000348 }
349 return false;
350}
351
Vladimir Marko2196c652017-11-30 16:16:07 +0000352const void* JitCodeCache::GetJniStubCode(ArtMethod* method) {
353 DCHECK(method->IsNative());
354 MutexLock mu(Thread::Current(), lock_);
355 auto it = jni_stubs_map_.find(JniStubKey(method));
356 if (it != jni_stubs_map_.end()) {
357 JniStubData& data = it->second;
358 if (data.IsCompiled() && ContainsElement(data.GetMethods(), method)) {
359 return data.GetCode();
360 }
361 }
362 return nullptr;
363}
364
Alex Light2d441b12018-06-08 15:33:21 -0700365const void* JitCodeCache::FindCompiledCodeForInstrumentation(ArtMethod* method) {
Alex Light839f53a2018-07-10 15:46:14 -0700366 // If jit-gc is still on we use the SavedEntryPoint field for doing that and so cannot use it to
367 // find the instrumentation entrypoint.
368 if (LIKELY(GetGarbageCollectCode())) {
Alex Light2d441b12018-06-08 15:33:21 -0700369 return nullptr;
370 }
371 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
372 if (info == nullptr) {
373 return nullptr;
374 }
375 // When GC is disabled for trampoline tracing we will use SavedEntrypoint to hold the actual
376 // jit-compiled version of the method. If jit-gc is disabled for other reasons this will just be
377 // nullptr.
378 return info->GetSavedEntryPoint();
379}
380
Mathieu Chartier33fbf372016-03-07 13:48:08 -0800381class ScopedCodeCacheWrite : ScopedTrace {
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100382 public:
Calin Juravle016fcbe22018-05-03 19:47:35 -0700383 explicit ScopedCodeCacheWrite(const JitCodeCache* const code_cache)
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100384 : ScopedTrace("ScopedCodeCacheWrite"),
Calin Juravle016fcbe22018-05-03 19:47:35 -0700385 code_cache_(code_cache) {
Mathieu Chartier33fbf372016-03-07 13:48:08 -0800386 ScopedTrace trace("mprotect all");
Calin Juravle016fcbe22018-05-03 19:47:35 -0700387 CheckedCall(
388 mprotect,
389 "make code writable",
390 code_cache_->code_map_->Begin(),
391 code_cache_->code_map_->Size(),
392 code_cache_->memmap_flags_prot_code_ | PROT_WRITE);
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800393 }
Calin Juravle016fcbe22018-05-03 19:47:35 -0700394
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100395 ~ScopedCodeCacheWrite() {
Mathieu Chartier33fbf372016-03-07 13:48:08 -0800396 ScopedTrace trace("mprotect code");
Calin Juravle016fcbe22018-05-03 19:47:35 -0700397 CheckedCall(
398 mprotect,
399 "make code protected",
400 code_cache_->code_map_->Begin(),
401 code_cache_->code_map_->Size(),
402 code_cache_->memmap_flags_prot_code_);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100403 }
Mathieu Chartier8d8de0c2017-10-04 09:35:30 -0700404
David Sehrd1dbb742017-07-17 11:20:38 -0700405 private:
Calin Juravle016fcbe22018-05-03 19:47:35 -0700406 const JitCodeCache* const code_cache_;
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100407
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100408 DISALLOW_COPY_AND_ASSIGN(ScopedCodeCacheWrite);
409};
410
411uint8_t* JitCodeCache::CommitCode(Thread* self,
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100412 ArtMethod* method,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000413 uint8_t* stack_map,
414 uint8_t* roots_data,
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100415 const uint8_t* code,
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000416 size_t code_size,
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100417 size_t data_size,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000418 bool osr,
Mingyao Yang063fc772016-08-02 11:02:54 -0700419 Handle<mirror::ObjectArray<mirror::Object>> roots,
420 bool has_should_deoptimize_flag,
421 const ArenaSet<ArtMethod*>& cha_single_implementation_list) {
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100422 uint8_t* result = CommitCodeInternal(self,
423 method,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000424 stack_map,
425 roots_data,
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100426 code,
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000427 code_size,
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100428 data_size,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000429 osr,
Mingyao Yang063fc772016-08-02 11:02:54 -0700430 roots,
431 has_should_deoptimize_flag,
432 cha_single_implementation_list);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100433 if (result == nullptr) {
434 // Retry.
435 GarbageCollectCache(self);
436 result = CommitCodeInternal(self,
437 method,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000438 stack_map,
439 roots_data,
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100440 code,
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000441 code_size,
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100442 data_size,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000443 osr,
Mingyao Yang063fc772016-08-02 11:02:54 -0700444 roots,
445 has_should_deoptimize_flag,
446 cha_single_implementation_list);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100447 }
448 return result;
449}
450
451bool JitCodeCache::WaitForPotentialCollectionToComplete(Thread* self) {
452 bool in_collection = false;
453 while (collection_in_progress_) {
454 in_collection = true;
455 lock_cond_.Wait(self);
456 }
457 return in_collection;
458}
459
460static uintptr_t FromCodeToAllocation(const void* code) {
461 size_t alignment = GetInstructionSetAlignment(kRuntimeISA);
462 return reinterpret_cast<uintptr_t>(code) - RoundUp(sizeof(OatQuickMethodHeader), alignment);
463}
464
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000465static uint32_t ComputeRootTableSize(uint32_t number_of_roots) {
466 return sizeof(uint32_t) + number_of_roots * sizeof(GcRoot<mirror::Object>);
467}
468
469static uint32_t GetNumberOfRoots(const uint8_t* stack_map) {
470 // The length of the table is stored just before the stack map (and therefore at the end of
471 // the table itself), in order to be able to fetch it from a `stack_map` pointer.
472 return reinterpret_cast<const uint32_t*>(stack_map)[-1];
473}
474
Mathieu Chartier7a704be2016-11-22 13:24:40 -0800475static void FillRootTableLength(uint8_t* roots_data, uint32_t length) {
476 // Store the length of the table at the end. This will allow fetching it from a `stack_map`
477 // pointer.
478 reinterpret_cast<uint32_t*>(roots_data)[length] = length;
479}
480
Nicolas Geoffrayf4b94422016-12-05 00:10:09 +0000481static const uint8_t* FromStackMapToRoots(const uint8_t* stack_map_data) {
482 return stack_map_data - ComputeRootTableSize(GetNumberOfRoots(stack_map_data));
483}
484
Alex Light3e36a9c2018-06-19 09:45:05 -0700485static void DCheckRootsAreValid(Handle<mirror::ObjectArray<mirror::Object>> roots)
486 REQUIRES(!Locks::intern_table_lock_) REQUIRES_SHARED(Locks::mutator_lock_) {
487 if (!kIsDebugBuild) {
488 return;
489 }
490 const uint32_t length = roots->GetLength();
491 // Put all roots in `roots_data`.
492 for (uint32_t i = 0; i < length; ++i) {
493 ObjPtr<mirror::Object> object = roots->Get(i);
494 // Ensure the string is strongly interned. b/32995596
495 if (object->IsString()) {
496 ObjPtr<mirror::String> str = ObjPtr<mirror::String>::DownCast(object);
497 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
498 CHECK(class_linker->GetInternTable()->LookupStrong(Thread::Current(), str) != nullptr);
499 }
500 }
501}
502
503void JitCodeCache::FillRootTable(uint8_t* roots_data,
504 Handle<mirror::ObjectArray<mirror::Object>> roots) {
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000505 GcRoot<mirror::Object>* gc_roots = reinterpret_cast<GcRoot<mirror::Object>*>(roots_data);
Mathieu Chartier7a704be2016-11-22 13:24:40 -0800506 const uint32_t length = roots->GetLength();
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000507 // Put all roots in `roots_data`.
508 for (uint32_t i = 0; i < length; ++i) {
509 ObjPtr<mirror::Object> object = roots->Get(i);
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000510 gc_roots[i] = GcRoot<mirror::Object>(object);
511 }
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000512}
513
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100514static uint8_t* GetRootTable(const void* code_ptr, uint32_t* number_of_roots = nullptr) {
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000515 OatQuickMethodHeader* method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
516 uint8_t* data = method_header->GetOptimizedCodeInfoPtr();
517 uint32_t roots = GetNumberOfRoots(data);
518 if (number_of_roots != nullptr) {
519 *number_of_roots = roots;
520 }
521 return data - ComputeRootTableSize(roots);
522}
523
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100524// Use a sentinel for marking entries in the JIT table that have been cleared.
525// This helps diagnosing in case the compiled code tries to wrongly access such
526// entries.
Andreas Gampe5629d2d2017-05-15 16:28:13 -0700527static mirror::Class* const weak_sentinel =
528 reinterpret_cast<mirror::Class*>(Context::kBadGprBase + 0xff);
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100529
Nicolas Geoffray22384ae2016-12-12 22:33:36 +0000530// Helper for the GC to process a weak class in a JIT root table.
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100531static inline void ProcessWeakClass(GcRoot<mirror::Class>* root_ptr,
532 IsMarkedVisitor* visitor,
533 mirror::Class* update)
Nicolas Geoffray22384ae2016-12-12 22:33:36 +0000534 REQUIRES_SHARED(Locks::mutator_lock_) {
535 // This does not need a read barrier because this is called by GC.
536 mirror::Class* cls = root_ptr->Read<kWithoutReadBarrier>();
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100537 if (cls != nullptr && cls != weak_sentinel) {
Nicolas Geoffray22384ae2016-12-12 22:33:36 +0000538 DCHECK((cls->IsClass<kDefaultVerifyFlags, kWithoutReadBarrier>()));
539 // Look at the classloader of the class to know if it has been unloaded.
540 // This does not need a read barrier because this is called by GC.
541 mirror::Object* class_loader =
542 cls->GetClassLoader<kDefaultVerifyFlags, kWithoutReadBarrier>();
543 if (class_loader == nullptr || visitor->IsMarked(class_loader) != nullptr) {
544 // The class loader is live, update the entry if the class has moved.
545 mirror::Class* new_cls = down_cast<mirror::Class*>(visitor->IsMarked(cls));
546 // Note that new_object can be null for CMS and newly allocated objects.
547 if (new_cls != nullptr && new_cls != cls) {
548 *root_ptr = GcRoot<mirror::Class>(new_cls);
549 }
550 } else {
551 // The class loader is not live, clear the entry.
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100552 *root_ptr = GcRoot<mirror::Class>(update);
Nicolas Geoffray22384ae2016-12-12 22:33:36 +0000553 }
554 }
555}
556
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000557void JitCodeCache::SweepRootTables(IsMarkedVisitor* visitor) {
558 MutexLock mu(Thread::Current(), lock_);
559 for (const auto& entry : method_code_map_) {
560 uint32_t number_of_roots = 0;
561 uint8_t* roots_data = GetRootTable(entry.first, &number_of_roots);
562 GcRoot<mirror::Object>* roots = reinterpret_cast<GcRoot<mirror::Object>*>(roots_data);
563 for (uint32_t i = 0; i < number_of_roots; ++i) {
564 // This does not need a read barrier because this is called by GC.
565 mirror::Object* object = roots[i].Read<kWithoutReadBarrier>();
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100566 if (object == nullptr || object == weak_sentinel) {
Nicolas Geoffray22384ae2016-12-12 22:33:36 +0000567 // entry got deleted in a previous sweep.
568 } else if (object->IsString<kDefaultVerifyFlags, kWithoutReadBarrier>()) {
569 mirror::Object* new_object = visitor->IsMarked(object);
570 // We know the string is marked because it's a strongly-interned string that
571 // is always alive. The IsMarked implementation of the CMS collector returns
572 // null for newly allocated objects, but we know those haven't moved. Therefore,
573 // only update the entry if we get a different non-null string.
574 // TODO: Do not use IsMarked for j.l.Class, and adjust once we move this method
575 // out of the weak access/creation pause. b/32167580
576 if (new_object != nullptr && new_object != object) {
577 DCHECK(new_object->IsString());
578 roots[i] = GcRoot<mirror::Object>(new_object);
579 }
580 } else {
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100581 ProcessWeakClass(
582 reinterpret_cast<GcRoot<mirror::Class>*>(&roots[i]), visitor, weak_sentinel);
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000583 }
584 }
585 }
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000586 // Walk over inline caches to clear entries containing unloaded classes.
587 for (ProfilingInfo* info : profiling_infos_) {
588 for (size_t i = 0; i < info->number_of_inline_caches_; ++i) {
589 InlineCache* cache = &info->cache_[i];
590 for (size_t j = 0; j < InlineCache::kIndividualCacheSize; ++j) {
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100591 ProcessWeakClass(&cache->classes_[j], visitor, nullptr);
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000592 }
593 }
594 }
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000595}
596
Orion Hodson607624f2018-05-11 10:10:46 +0100597void JitCodeCache::FreeCodeAndData(const void* code_ptr) {
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100598 uintptr_t allocation = FromCodeToAllocation(code_ptr);
David Srbecky5cc349f2015-12-18 15:04:48 +0000599 // Notify native debugger that we are about to remove the code.
600 // It does nothing if we are not using native debugger.
David Srbeckyfb3de3d2018-01-29 16:11:49 +0000601 MutexLock mu(Thread::Current(), *Locks::native_debug_interface_lock_);
David Srbecky440a9b32018-02-15 17:47:29 +0000602 RemoveNativeDebugInfoForJit(code_ptr);
Vladimir Marko2196c652017-11-30 16:16:07 +0000603 if (OatQuickMethodHeader::FromCodePointer(code_ptr)->IsOptimized()) {
604 FreeData(GetRootTable(code_ptr));
605 } // else this is a JNI stub without any data.
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100606 FreeCode(reinterpret_cast<uint8_t*>(allocation));
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100607}
608
Mingyao Yang063fc772016-08-02 11:02:54 -0700609void JitCodeCache::FreeAllMethodHeaders(
610 const std::unordered_set<OatQuickMethodHeader*>& method_headers) {
Mingyao Yang063fc772016-08-02 11:02:54 -0700611 // We need to remove entries in method_headers from CHA dependencies
612 // first since once we do FreeCode() below, the memory can be reused
613 // so it's possible for the same method_header to start representing
614 // different compile code.
615 MutexLock mu(Thread::Current(), lock_);
Alex Light33b7b5d2018-08-07 19:13:51 +0000616 {
617 MutexLock mu2(Thread::Current(), *Locks::cha_lock_);
618 Runtime::Current()->GetClassLinker()->GetClassHierarchyAnalysis()
619 ->RemoveDependentsWithMethodHeaders(method_headers);
620 }
621
Calin Juravle016fcbe22018-05-03 19:47:35 -0700622 ScopedCodeCacheWrite scc(this);
Mingyao Yang063fc772016-08-02 11:02:54 -0700623 for (const OatQuickMethodHeader* method_header : method_headers) {
Orion Hodson607624f2018-05-11 10:10:46 +0100624 FreeCodeAndData(method_header->GetCode());
Mingyao Yang063fc772016-08-02 11:02:54 -0700625 }
626}
627
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100628void JitCodeCache::RemoveMethodsIn(Thread* self, const LinearAlloc& alloc) {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800629 ScopedTrace trace(__PRETTY_FUNCTION__);
Mingyao Yang063fc772016-08-02 11:02:54 -0700630 // We use a set to first collect all method_headers whose code need to be
631 // removed. We need to free the underlying code after we remove CHA dependencies
632 // for entries in this set. And it's more efficient to iterate through
633 // the CHA dependency map just once with an unordered_set.
634 std::unordered_set<OatQuickMethodHeader*> method_headers;
Nicolas Geoffray26705e22015-10-28 12:50:11 +0000635 {
Mingyao Yang063fc772016-08-02 11:02:54 -0700636 MutexLock mu(self, lock_);
637 // We do not check if a code cache GC is in progress, as this method comes
638 // with the classlinker_classes_lock_ held, and suspending ourselves could
639 // lead to a deadlock.
640 {
Calin Juravle016fcbe22018-05-03 19:47:35 -0700641 ScopedCodeCacheWrite scc(this);
Vladimir Marko2196c652017-11-30 16:16:07 +0000642 for (auto it = jni_stubs_map_.begin(); it != jni_stubs_map_.end();) {
643 it->second.RemoveMethodsIn(alloc);
644 if (it->second.GetMethods().empty()) {
645 method_headers.insert(OatQuickMethodHeader::FromCodePointer(it->second.GetCode()));
646 it = jni_stubs_map_.erase(it);
647 } else {
648 it->first.UpdateShorty(it->second.GetMethods().front());
649 ++it;
650 }
651 }
Mingyao Yang063fc772016-08-02 11:02:54 -0700652 for (auto it = method_code_map_.begin(); it != method_code_map_.end();) {
653 if (alloc.ContainsUnsafe(it->second)) {
654 method_headers.insert(OatQuickMethodHeader::FromCodePointer(it->first));
655 it = method_code_map_.erase(it);
656 } else {
657 ++it;
658 }
659 }
660 }
661 for (auto it = osr_code_map_.begin(); it != osr_code_map_.end();) {
662 if (alloc.ContainsUnsafe(it->first)) {
663 // Note that the code has already been pushed to method_headers in the loop
664 // above and is going to be removed in FreeCode() below.
665 it = osr_code_map_.erase(it);
666 } else {
667 ++it;
668 }
669 }
670 for (auto it = profiling_infos_.begin(); it != profiling_infos_.end();) {
671 ProfilingInfo* info = *it;
672 if (alloc.ContainsUnsafe(info->GetMethod())) {
673 info->GetMethod()->SetProfilingInfo(nullptr);
674 FreeData(reinterpret_cast<uint8_t*>(info));
675 it = profiling_infos_.erase(it);
Nicolas Geoffray26705e22015-10-28 12:50:11 +0000676 } else {
677 ++it;
678 }
679 }
680 }
Mingyao Yang063fc772016-08-02 11:02:54 -0700681 FreeAllMethodHeaders(method_headers);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100682}
683
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000684bool JitCodeCache::IsWeakAccessEnabled(Thread* self) const {
685 return kUseReadBarrier
686 ? self->GetWeakRefAccessEnabled()
Orion Hodson88591fe2018-03-06 13:35:43 +0000687 : is_weak_access_enabled_.load(std::memory_order_seq_cst);
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000688}
689
690void JitCodeCache::WaitUntilInlineCacheAccessible(Thread* self) {
691 if (IsWeakAccessEnabled(self)) {
692 return;
693 }
694 ScopedThreadSuspension sts(self, kWaitingWeakGcRootRead);
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +0000695 MutexLock mu(self, lock_);
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000696 while (!IsWeakAccessEnabled(self)) {
697 inline_cache_cond_.Wait(self);
698 }
699}
700
701void JitCodeCache::BroadcastForInlineCacheAccess() {
702 Thread* self = Thread::Current();
703 MutexLock mu(self, lock_);
704 inline_cache_cond_.Broadcast(self);
705}
706
707void JitCodeCache::AllowInlineCacheAccess() {
708 DCHECK(!kUseReadBarrier);
Orion Hodson88591fe2018-03-06 13:35:43 +0000709 is_weak_access_enabled_.store(true, std::memory_order_seq_cst);
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000710 BroadcastForInlineCacheAccess();
711}
712
713void JitCodeCache::DisallowInlineCacheAccess() {
714 DCHECK(!kUseReadBarrier);
Orion Hodson88591fe2018-03-06 13:35:43 +0000715 is_weak_access_enabled_.store(false, std::memory_order_seq_cst);
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000716}
717
718void JitCodeCache::CopyInlineCacheInto(const InlineCache& ic,
719 Handle<mirror::ObjectArray<mirror::Class>> array) {
720 WaitUntilInlineCacheAccessible(Thread::Current());
721 // Note that we don't need to lock `lock_` here, the compiler calling
722 // this method has already ensured the inline cache will not be deleted.
723 for (size_t in_cache = 0, in_array = 0;
724 in_cache < InlineCache::kIndividualCacheSize;
725 ++in_cache) {
726 mirror::Class* object = ic.classes_[in_cache].Read();
727 if (object != nullptr) {
728 array->Set(in_array++, object);
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +0000729 }
730 }
731}
732
Mathieu Chartierf044c222017-05-31 15:27:54 -0700733static void ClearMethodCounter(ArtMethod* method, bool was_warm) {
734 if (was_warm) {
Vladimir Markoc945e0d2018-07-18 17:26:45 +0100735 method->SetPreviouslyWarm();
Mathieu Chartierf044c222017-05-31 15:27:54 -0700736 }
737 // We reset the counter to 1 so that the profile knows that the method was executed at least once.
738 // This is required for layout purposes.
Nicolas Geoffray88f50b12017-06-09 16:08:47 +0100739 // We also need to make sure we'll pass the warmup threshold again, so we set to 0 if
740 // the warmup threshold is 1.
741 uint16_t jit_warmup_threshold = Runtime::Current()->GetJITOptions()->GetWarmupThreshold();
742 method->SetCounter(std::min(jit_warmup_threshold - 1, 1));
Mathieu Chartierf044c222017-05-31 15:27:54 -0700743}
744
Alex Light33b7b5d2018-08-07 19:13:51 +0000745void JitCodeCache::WaitForPotentialCollectionToCompleteRunnable(Thread* self) {
746 while (collection_in_progress_) {
747 lock_.Unlock(self);
748 {
749 ScopedThreadSuspension sts(self, kSuspended);
750 MutexLock mu(self, lock_);
751 WaitForPotentialCollectionToComplete(self);
752 }
753 lock_.Lock(self);
754 }
755}
756
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100757uint8_t* JitCodeCache::CommitCodeInternal(Thread* self,
758 ArtMethod* method,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000759 uint8_t* stack_map,
760 uint8_t* roots_data,
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100761 const uint8_t* code,
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000762 size_t code_size,
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100763 size_t data_size,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000764 bool osr,
Mingyao Yang063fc772016-08-02 11:02:54 -0700765 Handle<mirror::ObjectArray<mirror::Object>> roots,
766 bool has_should_deoptimize_flag,
767 const ArenaSet<ArtMethod*>&
768 cha_single_implementation_list) {
Vladimir Marko2196c652017-11-30 16:16:07 +0000769 DCHECK(!method->IsNative() || !osr);
Alex Light33b7b5d2018-08-07 19:13:51 +0000770
771 if (!method->IsNative()) {
772 // We need to do this before grabbing the lock_ because it needs to be able to see the string
773 // InternTable. Native methods do not have roots.
774 DCheckRootsAreValid(roots);
775 }
776
Nicolas Geoffray1e7de6c2015-10-21 12:07:31 +0100777 size_t alignment = GetInstructionSetAlignment(kRuntimeISA);
778 // Ensure the header ends up at expected instruction alignment.
779 size_t header_size = RoundUp(sizeof(OatQuickMethodHeader), alignment);
780 size_t total_size = header_size + code_size;
781
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100782 OatQuickMethodHeader* method_header = nullptr;
Nicolas Geoffray1e7de6c2015-10-21 12:07:31 +0100783 uint8_t* code_ptr = nullptr;
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +0000784 uint8_t* memory = nullptr;
Alex Light33b7b5d2018-08-07 19:13:51 +0000785 MutexLock mu(self, lock_);
786 // We need to make sure that there will be no jit-gcs going on and wait for any ongoing one to
787 // finish.
788 WaitForPotentialCollectionToCompleteRunnable(self);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100789 {
Alex Light33b7b5d2018-08-07 19:13:51 +0000790 ScopedCodeCacheWrite scc(this);
791 memory = AllocateCode(total_size);
792 if (memory == nullptr) {
793 return nullptr;
794 }
795 code_ptr = memory + header_size;
Nicolas Geoffrayd28b9692015-11-04 14:36:55 +0000796
Alex Light33b7b5d2018-08-07 19:13:51 +0000797 std::copy(code, code + code_size, code_ptr);
798 method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
799 new (method_header) OatQuickMethodHeader(
800 (stack_map != nullptr) ? code_ptr - stack_map : 0u,
801 code_size);
802 // Flush caches before we remove write permission because some ARMv8 Qualcomm kernels may
803 // trigger a segfault if a page fault occurs when requesting a cache maintenance operation.
804 // This is a kernel bug that we need to work around until affected devices (e.g. Nexus 5X and
805 // 6P) stop being supported or their kernels are fixed.
806 //
807 // For reference, this behavior is caused by this commit:
808 // https://android.googlesource.com/kernel/msm/+/3fbe6bc28a6b9939d0650f2f17eb5216c719950c
809 FlushInstructionCache(reinterpret_cast<char*>(code_ptr),
810 reinterpret_cast<char*>(code_ptr + code_size));
811 DCHECK(!Runtime::Current()->IsAotCompiler());
812 if (has_should_deoptimize_flag) {
813 method_header->SetHasShouldDeoptimizeFlag();
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100814 }
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100815
Nicolas Geoffray0a522232016-01-19 09:34:58 +0000816 number_of_compilations_++;
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100817 }
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000818 // We need to update the entry point in the runnable state for the instrumentation.
819 {
Alex Light33b7b5d2018-08-07 19:13:51 +0000820 // The following needs to be guarded by cha_lock_ also. Otherwise it's possible that the
821 // compiled code is considered invalidated by some class linking, but below we still make the
822 // compiled code valid for the method. Need cha_lock_ for checking all single-implementation
823 // flags and register dependencies.
Mingyao Yang063fc772016-08-02 11:02:54 -0700824 MutexLock cha_mu(self, *Locks::cha_lock_);
825 bool single_impl_still_valid = true;
826 for (ArtMethod* single_impl : cha_single_implementation_list) {
827 if (!single_impl->HasSingleImplementation()) {
Jeff Hao00286db2017-05-30 16:53:07 -0700828 // Simply discard the compiled code. Clear the counter so that it may be recompiled later.
829 // Hopefully the class hierarchy will be more stable when compilation is retried.
Mingyao Yang063fc772016-08-02 11:02:54 -0700830 single_impl_still_valid = false;
Mathieu Chartierf044c222017-05-31 15:27:54 -0700831 ClearMethodCounter(method, /*was_warm*/ false);
Mingyao Yang063fc772016-08-02 11:02:54 -0700832 break;
833 }
834 }
835
836 // Discard the code if any single-implementation assumptions are now invalid.
837 if (!single_impl_still_valid) {
838 VLOG(jit) << "JIT discarded jitted code due to invalid single-implementation assumptions.";
839 return nullptr;
840 }
Nicolas Geoffray433b79a2017-01-30 20:54:45 +0000841 DCHECK(cha_single_implementation_list.empty() || !Runtime::Current()->IsJavaDebuggable())
Alex Lightdba61482016-12-21 08:20:29 -0800842 << "Should not be using cha on debuggable apps/runs!";
843
Mingyao Yang063fc772016-08-02 11:02:54 -0700844 for (ArtMethod* single_impl : cha_single_implementation_list) {
Andreas Gampec1ac9ee2017-07-24 22:35:49 -0700845 Runtime::Current()->GetClassLinker()->GetClassHierarchyAnalysis()->AddDependency(
Mingyao Yang063fc772016-08-02 11:02:54 -0700846 single_impl, method, method_header);
847 }
848
Vladimir Marko2196c652017-11-30 16:16:07 +0000849 if (UNLIKELY(method->IsNative())) {
Vladimir Marko2196c652017-11-30 16:16:07 +0000850 auto it = jni_stubs_map_.find(JniStubKey(method));
851 DCHECK(it != jni_stubs_map_.end())
852 << "Entry inserted in NotifyCompilationOf() should be alive.";
853 JniStubData* data = &it->second;
854 DCHECK(ContainsElement(data->GetMethods(), method))
855 << "Entry inserted in NotifyCompilationOf() should contain this method.";
856 data->SetCode(code_ptr);
857 instrumentation::Instrumentation* instrum = Runtime::Current()->GetInstrumentation();
858 for (ArtMethod* m : data->GetMethods()) {
859 instrum->UpdateMethodsCode(m, method_header->GetEntryPoint());
860 }
Nicolas Geoffray480d5102016-04-18 12:09:30 +0100861 } else {
Vladimir Marko2196c652017-11-30 16:16:07 +0000862 // Fill the root table before updating the entry point.
863 DCHECK_EQ(FromStackMapToRoots(stack_map), roots_data);
864 DCHECK_LE(roots_data, stack_map);
865 FillRootTable(roots_data, roots);
866 {
867 // Flush data cache, as compiled code references literals in it.
Vladimir Marko2196c652017-11-30 16:16:07 +0000868 FlushDataCache(reinterpret_cast<char*>(roots_data),
869 reinterpret_cast<char*>(roots_data + data_size));
870 }
871 method_code_map_.Put(code_ptr, method);
872 if (osr) {
873 number_of_osr_compilations_++;
874 osr_code_map_.Put(method, code_ptr);
875 } else {
876 Runtime::Current()->GetInstrumentation()->UpdateMethodsCode(
877 method, method_header->GetEntryPoint());
878 }
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000879 }
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000880 VLOG(jit)
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100881 << "JIT added (osr=" << std::boolalpha << osr << std::noboolalpha << ") "
David Sehr709b0702016-10-13 09:12:37 -0700882 << ArtMethod::PrettyMethod(method) << "@" << method
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000883 << " ccache_size=" << PrettySize(CodeCacheSizeLocked()) << ": "
884 << " dcache_size=" << PrettySize(DataCacheSizeLocked()) << ": "
885 << reinterpret_cast<const void*>(method_header->GetEntryPoint()) << ","
Mingyao Yang063fc772016-08-02 11:02:54 -0700886 << reinterpret_cast<const void*>(method_header->GetEntryPoint() +
887 method_header->GetCodeSize());
Nicolas Geoffray933330a2016-03-16 14:20:06 +0000888 histogram_code_memory_use_.AddValue(code_size);
889 if (code_size > kCodeSizeLogThreshold) {
890 LOG(INFO) << "JIT allocated "
891 << PrettySize(code_size)
892 << " for compiled code of "
David Sehr709b0702016-10-13 09:12:37 -0700893 << ArtMethod::PrettyMethod(method);
Nicolas Geoffray933330a2016-03-16 14:20:06 +0000894 }
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000895 }
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100896
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100897 return reinterpret_cast<uint8_t*>(method_header);
898}
899
900size_t JitCodeCache::CodeCacheSize() {
901 MutexLock mu(Thread::Current(), lock_);
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000902 return CodeCacheSizeLocked();
903}
904
Orion Hodsoneced6922017-06-01 10:54:28 +0100905bool JitCodeCache::RemoveMethod(ArtMethod* method, bool release_memory) {
Vladimir Marko2196c652017-11-30 16:16:07 +0000906 // This function is used only for testing and only with non-native methods.
907 CHECK(!method->IsNative());
908
Orion Hodsoneced6922017-06-01 10:54:28 +0100909 MutexLock mu(Thread::Current(), lock_);
Orion Hodsoneced6922017-06-01 10:54:28 +0100910
Vladimir Marko2196c652017-11-30 16:16:07 +0000911 bool osr = osr_code_map_.find(method) != osr_code_map_.end();
912 bool in_cache = RemoveMethodLocked(method, release_memory);
Orion Hodsoneced6922017-06-01 10:54:28 +0100913
914 if (!in_cache) {
915 return false;
916 }
917
Orion Hodsoneced6922017-06-01 10:54:28 +0100918 method->ClearCounter();
919 Runtime::Current()->GetInstrumentation()->UpdateMethodsCode(
920 method, GetQuickToInterpreterBridge());
921 VLOG(jit)
922 << "JIT removed (osr=" << std::boolalpha << osr << std::noboolalpha << ") "
923 << ArtMethod::PrettyMethod(method) << "@" << method
924 << " ccache_size=" << PrettySize(CodeCacheSizeLocked()) << ": "
925 << " dcache_size=" << PrettySize(DataCacheSizeLocked());
926 return true;
927}
928
Vladimir Marko2196c652017-11-30 16:16:07 +0000929bool JitCodeCache::RemoveMethodLocked(ArtMethod* method, bool release_memory) {
930 if (LIKELY(!method->IsNative())) {
931 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
932 if (info != nullptr) {
933 RemoveElement(profiling_infos_, info);
934 }
935 method->SetProfilingInfo(nullptr);
936 }
937
938 bool in_cache = false;
Calin Juravle016fcbe22018-05-03 19:47:35 -0700939 ScopedCodeCacheWrite ccw(this);
Vladimir Marko2196c652017-11-30 16:16:07 +0000940 if (UNLIKELY(method->IsNative())) {
941 auto it = jni_stubs_map_.find(JniStubKey(method));
942 if (it != jni_stubs_map_.end() && it->second.RemoveMethod(method)) {
943 in_cache = true;
944 if (it->second.GetMethods().empty()) {
945 if (release_memory) {
Orion Hodson607624f2018-05-11 10:10:46 +0100946 FreeCodeAndData(it->second.GetCode());
Vladimir Marko2196c652017-11-30 16:16:07 +0000947 }
948 jni_stubs_map_.erase(it);
949 } else {
950 it->first.UpdateShorty(it->second.GetMethods().front());
951 }
952 }
953 } else {
954 for (auto it = method_code_map_.begin(); it != method_code_map_.end();) {
955 if (it->second == method) {
956 in_cache = true;
957 if (release_memory) {
Orion Hodson607624f2018-05-11 10:10:46 +0100958 FreeCodeAndData(it->first);
Vladimir Marko2196c652017-11-30 16:16:07 +0000959 }
960 it = method_code_map_.erase(it);
961 } else {
962 ++it;
963 }
964 }
965
966 auto osr_it = osr_code_map_.find(method);
967 if (osr_it != osr_code_map_.end()) {
968 osr_code_map_.erase(osr_it);
969 }
970 }
971
972 return in_cache;
973}
974
Alex Lightdba61482016-12-21 08:20:29 -0800975// This notifies the code cache that the given method has been redefined and that it should remove
976// any cached information it has on the method. All threads must be suspended before calling this
977// method. The compiled code for the method (if there is any) must not be in any threads call stack.
978void JitCodeCache::NotifyMethodRedefined(ArtMethod* method) {
979 MutexLock mu(Thread::Current(), lock_);
Vladimir Marko2196c652017-11-30 16:16:07 +0000980 RemoveMethodLocked(method, /* release_memory */ true);
Alex Lightdba61482016-12-21 08:20:29 -0800981}
982
983// This invalidates old_method. Once this function returns one can no longer use old_method to
984// execute code unless it is fixed up. This fixup will happen later in the process of installing a
985// class redefinition.
986// TODO We should add some info to ArtMethod to note that 'old_method' has been invalidated and
987// shouldn't be used since it is no longer logically in the jit code cache.
988// TODO We should add DCHECKS that validate that the JIT is paused when this method is entered.
989void JitCodeCache::MoveObsoleteMethod(ArtMethod* old_method, ArtMethod* new_method) {
Vladimir Marko2196c652017-11-30 16:16:07 +0000990 MutexLock mu(Thread::Current(), lock_);
Alex Lighteee0bd42017-02-14 15:31:45 +0000991 if (old_method->IsNative()) {
Vladimir Marko2196c652017-11-30 16:16:07 +0000992 // Update methods in jni_stubs_map_.
993 for (auto& entry : jni_stubs_map_) {
994 JniStubData& data = entry.second;
995 data.MoveObsoleteMethod(old_method, new_method);
996 }
Alex Lighteee0bd42017-02-14 15:31:45 +0000997 return;
998 }
Alex Lightdba61482016-12-21 08:20:29 -0800999 // Update ProfilingInfo to the new one and remove it from the old_method.
1000 if (old_method->GetProfilingInfo(kRuntimePointerSize) != nullptr) {
1001 DCHECK_EQ(old_method->GetProfilingInfo(kRuntimePointerSize)->GetMethod(), old_method);
1002 ProfilingInfo* info = old_method->GetProfilingInfo(kRuntimePointerSize);
1003 old_method->SetProfilingInfo(nullptr);
1004 // Since the JIT should be paused and all threads suspended by the time this is called these
1005 // checks should always pass.
1006 DCHECK(!info->IsInUseByCompiler());
1007 new_method->SetProfilingInfo(info);
Alex Light2d441b12018-06-08 15:33:21 -07001008 // Get rid of the old saved entrypoint if it is there.
1009 info->SetSavedEntryPoint(nullptr);
Alex Lightdba61482016-12-21 08:20:29 -08001010 info->method_ = new_method;
1011 }
1012 // Update method_code_map_ to point to the new method.
1013 for (auto& it : method_code_map_) {
1014 if (it.second == old_method) {
1015 it.second = new_method;
1016 }
1017 }
1018 // Update osr_code_map_ to point to the new method.
1019 auto code_map = osr_code_map_.find(old_method);
1020 if (code_map != osr_code_map_.end()) {
1021 osr_code_map_.Put(new_method, code_map->second);
1022 osr_code_map_.erase(old_method);
1023 }
1024}
1025
Nicolas Geoffraya5891e82015-11-06 14:18:27 +00001026size_t JitCodeCache::CodeCacheSizeLocked() {
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001027 return used_memory_for_code_;
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +01001028}
1029
1030size_t JitCodeCache::DataCacheSize() {
1031 MutexLock mu(Thread::Current(), lock_);
Nicolas Geoffraya5891e82015-11-06 14:18:27 +00001032 return DataCacheSizeLocked();
1033}
1034
1035size_t JitCodeCache::DataCacheSizeLocked() {
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001036 return used_memory_for_data_;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001037}
1038
Nicolas Geoffrayf46501c2016-11-22 13:45:36 +00001039void JitCodeCache::ClearData(Thread* self,
1040 uint8_t* stack_map_data,
1041 uint8_t* roots_data) {
1042 DCHECK_EQ(FromStackMapToRoots(stack_map_data), roots_data);
Nicolas Geoffrayd28b9692015-11-04 14:36:55 +00001043 MutexLock mu(self, lock_);
Nicolas Geoffrayf46501c2016-11-22 13:45:36 +00001044 FreeData(reinterpret_cast<uint8_t*>(roots_data));
Nicolas Geoffrayd28b9692015-11-04 14:36:55 +00001045}
1046
Nicolas Geoffrayed015ac2016-12-15 17:58:48 +00001047size_t JitCodeCache::ReserveData(Thread* self,
1048 size_t stack_map_size,
1049 size_t number_of_roots,
1050 ArtMethod* method,
1051 uint8_t** stack_map_data,
1052 uint8_t** roots_data) {
Nicolas Geoffray132d8362016-11-16 09:19:42 +00001053 size_t table_size = ComputeRootTableSize(number_of_roots);
David Srbecky8cd54542018-07-15 23:58:44 +01001054 size_t size = RoundUp(stack_map_size + table_size, sizeof(void*));
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001055 uint8_t* result = nullptr;
1056
1057 {
1058 ScopedThreadSuspension sts(self, kSuspended);
1059 MutexLock mu(self, lock_);
1060 WaitForPotentialCollectionToComplete(self);
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001061 result = AllocateData(size);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001062 }
1063
1064 if (result == nullptr) {
1065 // Retry.
1066 GarbageCollectCache(self);
1067 ScopedThreadSuspension sts(self, kSuspended);
1068 MutexLock mu(self, lock_);
1069 WaitForPotentialCollectionToComplete(self);
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001070 result = AllocateData(size);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001071 }
1072
Nicolas Geoffray933330a2016-03-16 14:20:06 +00001073 MutexLock mu(self, lock_);
1074 histogram_stack_map_memory_use_.AddValue(size);
1075 if (size > kStackMapSizeLogThreshold) {
1076 LOG(INFO) << "JIT allocated "
1077 << PrettySize(size)
1078 << " for stack maps of "
David Sehr709b0702016-10-13 09:12:37 -07001079 << ArtMethod::PrettyMethod(method);
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001080 }
Nicolas Geoffrayf4b94422016-12-05 00:10:09 +00001081 if (result != nullptr) {
1082 *roots_data = result;
1083 *stack_map_data = result + table_size;
1084 FillRootTableLength(*roots_data, number_of_roots);
Nicolas Geoffrayed015ac2016-12-15 17:58:48 +00001085 return size;
Nicolas Geoffrayf4b94422016-12-05 00:10:09 +00001086 } else {
1087 *roots_data = nullptr;
1088 *stack_map_data = nullptr;
Nicolas Geoffrayed015ac2016-12-15 17:58:48 +00001089 return 0;
Nicolas Geoffrayf4b94422016-12-05 00:10:09 +00001090 }
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001091}
1092
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001093class MarkCodeVisitor FINAL : public StackVisitor {
1094 public:
1095 MarkCodeVisitor(Thread* thread_in, JitCodeCache* code_cache_in)
1096 : StackVisitor(thread_in, nullptr, StackVisitor::StackWalkKind::kSkipInlinedFrames),
1097 code_cache_(code_cache_in),
1098 bitmap_(code_cache_->GetLiveBitmap()) {}
1099
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001100 bool VisitFrame() OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001101 const OatQuickMethodHeader* method_header = GetCurrentOatQuickMethodHeader();
1102 if (method_header == nullptr) {
1103 return true;
1104 }
1105 const void* code = method_header->GetCode();
1106 if (code_cache_->ContainsPc(code)) {
1107 // Use the atomic set version, as multiple threads are executing this code.
1108 bitmap_->AtomicTestAndSet(FromCodeToAllocation(code));
1109 }
1110 return true;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001111 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001112
1113 private:
1114 JitCodeCache* const code_cache_;
1115 CodeCacheBitmap* const bitmap_;
1116};
1117
1118class MarkCodeClosure FINAL : public Closure {
1119 public:
1120 MarkCodeClosure(JitCodeCache* code_cache, Barrier* barrier)
1121 : code_cache_(code_cache), barrier_(barrier) {}
1122
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001123 void Run(Thread* thread) OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001124 ScopedTrace trace(__PRETTY_FUNCTION__);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001125 DCHECK(thread == Thread::Current() || thread->IsSuspended());
1126 MarkCodeVisitor visitor(thread, code_cache_);
1127 visitor.WalkStack();
Nicolas Geoffray5a23d2e2015-11-03 18:58:57 +00001128 if (kIsDebugBuild) {
1129 // The stack walking code queries the side instrumentation stack if it
1130 // sees an instrumentation exit pc, so the JIT code of methods in that stack
1131 // must have been seen. We sanity check this below.
1132 for (const instrumentation::InstrumentationStackFrame& frame
1133 : *thread->GetInstrumentationStack()) {
1134 // The 'method_' in InstrumentationStackFrame is the one that has return_pc_ in
1135 // its stack frame, it is not the method owning return_pc_. We just pass null to
1136 // LookupMethodHeader: the method is only checked against in debug builds.
1137 OatQuickMethodHeader* method_header =
Vladimir Marko2196c652017-11-30 16:16:07 +00001138 code_cache_->LookupMethodHeader(frame.return_pc_, /* method */ nullptr);
Nicolas Geoffray5a23d2e2015-11-03 18:58:57 +00001139 if (method_header != nullptr) {
1140 const void* code = method_header->GetCode();
1141 CHECK(code_cache_->GetLiveBitmap()->Test(FromCodeToAllocation(code)));
1142 }
1143 }
1144 }
Mathieu Chartier10d25082015-10-28 18:36:09 -07001145 barrier_->Pass(Thread::Current());
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001146 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001147
1148 private:
1149 JitCodeCache* const code_cache_;
1150 Barrier* const barrier_;
1151};
1152
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001153void JitCodeCache::NotifyCollectionDone(Thread* self) {
1154 collection_in_progress_ = false;
1155 lock_cond_.Broadcast(self);
1156}
1157
1158void JitCodeCache::SetFootprintLimit(size_t new_footprint) {
1159 size_t per_space_footprint = new_footprint / 2;
Orion Hodsondbd05fe2017-08-10 11:41:35 +01001160 DCHECK(IsAlignedParam(per_space_footprint, kPageSize));
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001161 DCHECK_EQ(per_space_footprint * 2, new_footprint);
1162 mspace_set_footprint_limit(data_mspace_, per_space_footprint);
1163 {
Calin Juravle016fcbe22018-05-03 19:47:35 -07001164 ScopedCodeCacheWrite scc(this);
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001165 mspace_set_footprint_limit(code_mspace_, per_space_footprint);
1166 }
1167}
1168
1169bool JitCodeCache::IncreaseCodeCacheCapacity() {
1170 if (current_capacity_ == max_capacity_) {
1171 return false;
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001172 }
1173
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001174 // Double the capacity if we're below 1MB, or increase it by 1MB if
1175 // we're above.
1176 if (current_capacity_ < 1 * MB) {
1177 current_capacity_ *= 2;
1178 } else {
1179 current_capacity_ += 1 * MB;
1180 }
1181 if (current_capacity_ > max_capacity_) {
1182 current_capacity_ = max_capacity_;
1183 }
1184
Nicolas Geoffray646d6382017-08-09 10:50:00 +01001185 VLOG(jit) << "Increasing code cache capacity to " << PrettySize(current_capacity_);
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001186
1187 SetFootprintLimit(current_capacity_);
1188
1189 return true;
1190}
1191
Nicolas Geoffray8d372502016-02-23 13:56:43 +00001192void JitCodeCache::MarkCompiledCodeOnThreadStacks(Thread* self) {
1193 Barrier barrier(0);
1194 size_t threads_running_checkpoint = 0;
1195 MarkCodeClosure closure(this, &barrier);
1196 threads_running_checkpoint = Runtime::Current()->GetThreadList()->RunCheckpoint(&closure);
1197 // Now that we have run our checkpoint, move to a suspended state and wait
1198 // for other threads to run the checkpoint.
1199 ScopedThreadSuspension sts(self, kSuspended);
1200 if (threads_running_checkpoint != 0) {
1201 barrier.Increment(self, threads_running_checkpoint);
1202 }
1203}
1204
Nicolas Geoffray35122442016-03-02 12:05:30 +00001205bool JitCodeCache::ShouldDoFullCollection() {
1206 if (current_capacity_ == max_capacity_) {
1207 // Always do a full collection when the code cache is full.
1208 return true;
1209 } else if (current_capacity_ < kReservedCapacity) {
1210 // Always do partial collection when the code cache size is below the reserved
1211 // capacity.
1212 return false;
1213 } else if (last_collection_increased_code_cache_) {
1214 // This time do a full collection.
1215 return true;
1216 } else {
1217 // This time do a partial collection.
1218 return false;
Nicolas Geoffray8d372502016-02-23 13:56:43 +00001219 }
1220}
1221
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001222void JitCodeCache::GarbageCollectCache(Thread* self) {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001223 ScopedTrace trace(__FUNCTION__);
Nicolas Geoffray8d372502016-02-23 13:56:43 +00001224 if (!garbage_collect_code_) {
1225 MutexLock mu(self, lock_);
1226 IncreaseCodeCacheCapacity();
1227 return;
1228 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001229
Nicolas Geoffraya5891e82015-11-06 14:18:27 +00001230 // Wait for an existing collection, or let everyone know we are starting one.
1231 {
1232 ScopedThreadSuspension sts(self, kSuspended);
1233 MutexLock mu(self, lock_);
1234 if (WaitForPotentialCollectionToComplete(self)) {
1235 return;
1236 } else {
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001237 number_of_collections_++;
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001238 live_bitmap_.reset(CodeCacheBitmap::Create(
1239 "code-cache-bitmap",
Orion Hodsondbd05fe2017-08-10 11:41:35 +01001240 reinterpret_cast<uintptr_t>(code_map_->Begin()),
1241 reinterpret_cast<uintptr_t>(code_map_->Begin() + current_capacity_ / 2)));
Nicolas Geoffray8d372502016-02-23 13:56:43 +00001242 collection_in_progress_ = true;
1243 }
1244 }
1245
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001246 TimingLogger logger("JIT code cache timing logger", true, VLOG_IS_ON(jit));
Nicolas Geoffray8d372502016-02-23 13:56:43 +00001247 {
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001248 TimingLogger::ScopedTiming st("Code cache collection", &logger);
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001249
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001250 bool do_full_collection = false;
1251 {
1252 MutexLock mu(self, lock_);
1253 do_full_collection = ShouldDoFullCollection();
Nicolas Geoffraya96917a2016-03-01 22:18:02 +00001254 }
1255
Nicolas Geoffray646d6382017-08-09 10:50:00 +01001256 VLOG(jit) << "Do "
1257 << (do_full_collection ? "full" : "partial")
1258 << " code cache collection, code="
1259 << PrettySize(CodeCacheSize())
1260 << ", data=" << PrettySize(DataCacheSize());
Nicolas Geoffray35122442016-03-02 12:05:30 +00001261
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001262 DoCollection(self, /* collect_profiling_info */ do_full_collection);
1263
Nicolas Geoffray646d6382017-08-09 10:50:00 +01001264 VLOG(jit) << "After code cache collection, code="
1265 << PrettySize(CodeCacheSize())
1266 << ", data=" << PrettySize(DataCacheSize());
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001267
1268 {
1269 MutexLock mu(self, lock_);
1270
1271 // Increase the code cache only when we do partial collections.
1272 // TODO: base this strategy on how full the code cache is?
1273 if (do_full_collection) {
1274 last_collection_increased_code_cache_ = false;
1275 } else {
1276 last_collection_increased_code_cache_ = true;
1277 IncreaseCodeCacheCapacity();
Nicolas Geoffray35122442016-03-02 12:05:30 +00001278 }
1279
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001280 bool next_collection_will_be_full = ShouldDoFullCollection();
1281
1282 // Start polling the liveness of compiled code to prepare for the next full collection.
Nicolas Geoffray480d5102016-04-18 12:09:30 +01001283 if (next_collection_will_be_full) {
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001284 // Save the entry point of methods we have compiled, and update the entry
1285 // point of those methods to the interpreter. If the method is invoked, the
1286 // interpreter will update its entry point to the compiled code and call it.
1287 for (ProfilingInfo* info : profiling_infos_) {
1288 const void* entry_point = info->GetMethod()->GetEntryPointFromQuickCompiledCode();
1289 if (ContainsPc(entry_point)) {
1290 info->SetSavedEntryPoint(entry_point);
Vladimir Marko2196c652017-11-30 16:16:07 +00001291 // Don't call Instrumentation::UpdateMethodsCode(), as it can check the declaring
Nicolas Geoffray3b1a7f42017-02-22 10:21:00 +00001292 // class of the method. We may be concurrently running a GC which makes accessing
1293 // the class unsafe. We know it is OK to bypass the instrumentation as we've just
1294 // checked that the current entry point is JIT compiled code.
1295 info->GetMethod()->SetEntryPointFromQuickCompiledCode(GetQuickToInterpreterBridge());
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001296 }
1297 }
1298
1299 DCHECK(CheckLiveCompiledCodeHasProfilingInfo());
Vladimir Marko2196c652017-11-30 16:16:07 +00001300
1301 // Change entry points of native methods back to the GenericJNI entrypoint.
1302 for (const auto& entry : jni_stubs_map_) {
1303 const JniStubData& data = entry.second;
1304 if (!data.IsCompiled()) {
1305 continue;
1306 }
1307 // Make sure a single invocation of the GenericJNI trampoline tries to recompile.
1308 uint16_t new_counter = Runtime::Current()->GetJit()->HotMethodThreshold() - 1u;
1309 const OatQuickMethodHeader* method_header =
1310 OatQuickMethodHeader::FromCodePointer(data.GetCode());
1311 for (ArtMethod* method : data.GetMethods()) {
1312 if (method->GetEntryPointFromQuickCompiledCode() == method_header->GetEntryPoint()) {
1313 // Don't call Instrumentation::UpdateMethodsCode(), same as for normal methods above.
1314 method->SetCounter(new_counter);
1315 method->SetEntryPointFromQuickCompiledCode(GetQuickGenericJniStub());
1316 }
1317 }
1318 }
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001319 }
1320 live_bitmap_.reset(nullptr);
1321 NotifyCollectionDone(self);
Nicolas Geoffray35122442016-03-02 12:05:30 +00001322 }
Nicolas Geoffray35122442016-03-02 12:05:30 +00001323 }
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001324 Runtime::Current()->GetJit()->AddTimingLogger(logger);
Nicolas Geoffray35122442016-03-02 12:05:30 +00001325}
1326
Nicolas Geoffray9abb2972016-03-04 14:32:59 +00001327void JitCodeCache::RemoveUnmarkedCode(Thread* self) {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001328 ScopedTrace trace(__FUNCTION__);
Mingyao Yang063fc772016-08-02 11:02:54 -07001329 std::unordered_set<OatQuickMethodHeader*> method_headers;
1330 {
1331 MutexLock mu(self, lock_);
Calin Juravle016fcbe22018-05-03 19:47:35 -07001332 ScopedCodeCacheWrite scc(this);
Mingyao Yang063fc772016-08-02 11:02:54 -07001333 // Iterate over all compiled code and remove entries that are not marked.
Vladimir Marko2196c652017-11-30 16:16:07 +00001334 for (auto it = jni_stubs_map_.begin(); it != jni_stubs_map_.end();) {
1335 JniStubData* data = &it->second;
1336 if (!data->IsCompiled() || GetLiveBitmap()->Test(FromCodeToAllocation(data->GetCode()))) {
1337 ++it;
1338 } else {
1339 method_headers.insert(OatQuickMethodHeader::FromCodePointer(data->GetCode()));
1340 it = jni_stubs_map_.erase(it);
1341 }
1342 }
Mingyao Yang063fc772016-08-02 11:02:54 -07001343 for (auto it = method_code_map_.begin(); it != method_code_map_.end();) {
1344 const void* code_ptr = it->first;
1345 uintptr_t allocation = FromCodeToAllocation(code_ptr);
1346 if (GetLiveBitmap()->Test(allocation)) {
1347 ++it;
1348 } else {
Alex Light2d441b12018-06-08 15:33:21 -07001349 OatQuickMethodHeader* header = OatQuickMethodHeader::FromCodePointer(code_ptr);
1350 method_headers.insert(header);
Mingyao Yang063fc772016-08-02 11:02:54 -07001351 it = method_code_map_.erase(it);
1352 }
Nicolas Geoffray35122442016-03-02 12:05:30 +00001353 }
1354 }
Mingyao Yang063fc772016-08-02 11:02:54 -07001355 FreeAllMethodHeaders(method_headers);
Nicolas Geoffray35122442016-03-02 12:05:30 +00001356}
1357
1358void JitCodeCache::DoCollection(Thread* self, bool collect_profiling_info) {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001359 ScopedTrace trace(__FUNCTION__);
Nicolas Geoffray35122442016-03-02 12:05:30 +00001360 {
1361 MutexLock mu(self, lock_);
1362 if (collect_profiling_info) {
1363 // Clear the profiling info of methods that do not have compiled code as entrypoint.
1364 // Also remove the saved entry point from the ProfilingInfo objects.
1365 for (ProfilingInfo* info : profiling_infos_) {
1366 const void* ptr = info->GetMethod()->GetEntryPointFromQuickCompiledCode();
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001367 if (!ContainsPc(ptr) && !info->IsInUseByCompiler()) {
Nicolas Geoffray35122442016-03-02 12:05:30 +00001368 info->GetMethod()->SetProfilingInfo(nullptr);
1369 }
Nicolas Geoffrayb9a639d2016-03-22 11:25:20 +00001370
1371 if (info->GetSavedEntryPoint() != nullptr) {
1372 info->SetSavedEntryPoint(nullptr);
1373 // We are going to move this method back to interpreter. Clear the counter now to
Mathieu Chartierf044c222017-05-31 15:27:54 -07001374 // give it a chance to be hot again.
1375 ClearMethodCounter(info->GetMethod(), /*was_warm*/ true);
Nicolas Geoffrayb9a639d2016-03-22 11:25:20 +00001376 }
Nicolas Geoffray35122442016-03-02 12:05:30 +00001377 }
1378 } else if (kIsDebugBuild) {
1379 // Sanity check that the profiling infos do not have a dangling entry point.
1380 for (ProfilingInfo* info : profiling_infos_) {
1381 DCHECK(info->GetSavedEntryPoint() == nullptr);
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001382 }
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001383 }
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00001384
Nicolas Geoffray9abb2972016-03-04 14:32:59 +00001385 // Mark compiled code that are entrypoints of ArtMethods. Compiled code that is not
1386 // an entry point is either:
1387 // - an osr compiled code, that will be removed if not in a thread call stack.
1388 // - discarded compiled code, that will be removed if not in a thread call stack.
Vladimir Marko2196c652017-11-30 16:16:07 +00001389 for (const auto& entry : jni_stubs_map_) {
1390 const JniStubData& data = entry.second;
1391 const void* code_ptr = data.GetCode();
1392 const OatQuickMethodHeader* method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
1393 for (ArtMethod* method : data.GetMethods()) {
1394 if (method_header->GetEntryPoint() == method->GetEntryPointFromQuickCompiledCode()) {
1395 GetLiveBitmap()->AtomicTestAndSet(FromCodeToAllocation(code_ptr));
1396 break;
1397 }
1398 }
1399 }
Nicolas Geoffray9abb2972016-03-04 14:32:59 +00001400 for (const auto& it : method_code_map_) {
1401 ArtMethod* method = it.second;
1402 const void* code_ptr = it.first;
1403 const OatQuickMethodHeader* method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
1404 if (method_header->GetEntryPoint() == method->GetEntryPointFromQuickCompiledCode()) {
1405 GetLiveBitmap()->AtomicTestAndSet(FromCodeToAllocation(code_ptr));
1406 }
1407 }
1408
Nicolas Geoffrayd9994f02016-02-11 17:35:55 +00001409 // Empty osr method map, as osr compiled code will be deleted (except the ones
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00001410 // on thread stacks).
1411 osr_code_map_.clear();
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001412 }
1413
1414 // Run a checkpoint on all threads to mark the JIT compiled code they are running.
Nicolas Geoffray8d372502016-02-23 13:56:43 +00001415 MarkCompiledCodeOnThreadStacks(self);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001416
Nicolas Geoffray9abb2972016-03-04 14:32:59 +00001417 // At this point, mutator threads are still running, and entrypoints of methods can
1418 // change. We do know they cannot change to a code cache entry that is not marked,
1419 // therefore we can safely remove those entries.
1420 RemoveUnmarkedCode(self);
Nicolas Geoffraya96917a2016-03-01 22:18:02 +00001421
Nicolas Geoffray35122442016-03-02 12:05:30 +00001422 if (collect_profiling_info) {
1423 MutexLock mu(self, lock_);
1424 // Free all profiling infos of methods not compiled nor being compiled.
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001425 auto profiling_kept_end = std::remove_if(profiling_infos_.begin(), profiling_infos_.end(),
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001426 [this] (ProfilingInfo* info) NO_THREAD_SAFETY_ANALYSIS {
Nicolas Geoffray35122442016-03-02 12:05:30 +00001427 const void* ptr = info->GetMethod()->GetEntryPointFromQuickCompiledCode();
Nicolas Geoffray511e41b2016-03-02 17:09:35 +00001428 // We have previously cleared the ProfilingInfo pointer in the ArtMethod in the hope
1429 // that the compiled code would not get revived. As mutator threads run concurrently,
1430 // they may have revived the compiled code, and now we are in the situation where
1431 // a method has compiled code but no ProfilingInfo.
1432 // We make sure compiled methods have a ProfilingInfo object. It is needed for
1433 // code cache collection.
Andreas Gampe542451c2016-07-26 09:02:02 -07001434 if (ContainsPc(ptr) &&
1435 info->GetMethod()->GetProfilingInfo(kRuntimePointerSize) == nullptr) {
Nicolas Geoffray35122442016-03-02 12:05:30 +00001436 info->GetMethod()->SetProfilingInfo(info);
Andreas Gampe542451c2016-07-26 09:02:02 -07001437 } else if (info->GetMethod()->GetProfilingInfo(kRuntimePointerSize) != info) {
Nicolas Geoffray35122442016-03-02 12:05:30 +00001438 // No need for this ProfilingInfo object anymore.
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001439 FreeData(reinterpret_cast<uint8_t*>(info));
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001440 return true;
1441 }
1442 return false;
1443 });
1444 profiling_infos_.erase(profiling_kept_end, profiling_infos_.end());
Nicolas Geoffray35122442016-03-02 12:05:30 +00001445 DCHECK(CheckLiveCompiledCodeHasProfilingInfo());
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001446 }
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001447}
1448
Nicolas Geoffray35122442016-03-02 12:05:30 +00001449bool JitCodeCache::CheckLiveCompiledCodeHasProfilingInfo() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001450 ScopedTrace trace(__FUNCTION__);
Nicolas Geoffray35122442016-03-02 12:05:30 +00001451 // Check that methods we have compiled do have a ProfilingInfo object. We would
1452 // have memory leaks of compiled code otherwise.
1453 for (const auto& it : method_code_map_) {
1454 ArtMethod* method = it.second;
Andreas Gampe542451c2016-07-26 09:02:02 -07001455 if (method->GetProfilingInfo(kRuntimePointerSize) == nullptr) {
Nicolas Geoffray35122442016-03-02 12:05:30 +00001456 const void* code_ptr = it.first;
1457 const OatQuickMethodHeader* method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
1458 if (method_header->GetEntryPoint() == method->GetEntryPointFromQuickCompiledCode()) {
1459 // If the code is not dead, then we have a problem. Note that this can even
1460 // happen just after a collection, as mutator threads are running in parallel
1461 // and could deoptimize an existing compiled code.
1462 return false;
1463 }
1464 }
1465 }
1466 return true;
1467}
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001468
1469OatQuickMethodHeader* JitCodeCache::LookupMethodHeader(uintptr_t pc, ArtMethod* method) {
Vladimir Marko33bff252017-11-01 14:35:42 +00001470 static_assert(kRuntimeISA != InstructionSet::kThumb2, "kThumb2 cannot be a runtime ISA");
1471 if (kRuntimeISA == InstructionSet::kArm) {
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001472 // On Thumb-2, the pc is offset by one.
1473 --pc;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001474 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001475 if (!ContainsPc(reinterpret_cast<const void*>(pc))) {
1476 return nullptr;
1477 }
1478
Vladimir Marko2196c652017-11-30 16:16:07 +00001479 if (!kIsDebugBuild) {
1480 // Called with null `method` only from MarkCodeClosure::Run() in debug build.
1481 CHECK(method != nullptr);
Vladimir Marko47d31852017-11-28 18:36:12 +00001482 }
Vladimir Markoe7441632017-11-29 13:00:56 +00001483
Vladimir Marko2196c652017-11-30 16:16:07 +00001484 MutexLock mu(Thread::Current(), lock_);
1485 OatQuickMethodHeader* method_header = nullptr;
1486 ArtMethod* found_method = nullptr; // Only for DCHECK(), not for JNI stubs.
1487 if (method != nullptr && UNLIKELY(method->IsNative())) {
1488 auto it = jni_stubs_map_.find(JniStubKey(method));
1489 if (it == jni_stubs_map_.end() || !ContainsElement(it->second.GetMethods(), method)) {
1490 return nullptr;
1491 }
1492 const void* code_ptr = it->second.GetCode();
1493 method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
1494 if (!method_header->Contains(pc)) {
1495 return nullptr;
1496 }
1497 } else {
1498 auto it = method_code_map_.lower_bound(reinterpret_cast<const void*>(pc));
1499 if (it != method_code_map_.begin()) {
1500 --it;
1501 const void* code_ptr = it->first;
1502 if (OatQuickMethodHeader::FromCodePointer(code_ptr)->Contains(pc)) {
1503 method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
1504 found_method = it->second;
1505 }
1506 }
1507 if (method_header == nullptr && method == nullptr) {
1508 // Scan all compiled JNI stubs as well. This slow search is used only
1509 // for checks in debug build, for release builds the `method` is not null.
1510 for (auto&& entry : jni_stubs_map_) {
1511 const JniStubData& data = entry.second;
1512 if (data.IsCompiled() &&
1513 OatQuickMethodHeader::FromCodePointer(data.GetCode())->Contains(pc)) {
1514 method_header = OatQuickMethodHeader::FromCodePointer(data.GetCode());
1515 }
1516 }
1517 }
1518 if (method_header == nullptr) {
1519 return nullptr;
1520 }
Nicolas Geoffray056d7752017-11-30 09:12:13 +00001521 }
Vladimir Marko2196c652017-11-30 16:16:07 +00001522
1523 if (kIsDebugBuild && method != nullptr && !method->IsNative()) {
Alex Light1ebe4fe2017-01-30 14:57:11 -08001524 // When we are walking the stack to redefine classes and creating obsolete methods it is
1525 // possible that we might have updated the method_code_map by making this method obsolete in a
1526 // previous frame. Therefore we should just check that the non-obsolete version of this method
1527 // is the one we expect. We change to the non-obsolete versions in the error message since the
1528 // obsolete version of the method might not be fully initialized yet. This situation can only
1529 // occur when we are in the process of allocating and setting up obsolete methods. Otherwise
Andreas Gampe06c42a52017-07-26 14:17:14 -07001530 // method and it->second should be identical. (See openjdkjvmti/ti_redefine.cc for more
Alex Light1ebe4fe2017-01-30 14:57:11 -08001531 // information.)
Vladimir Marko2196c652017-11-30 16:16:07 +00001532 DCHECK_EQ(found_method->GetNonObsoleteMethod(), method->GetNonObsoleteMethod())
Alex Light1ebe4fe2017-01-30 14:57:11 -08001533 << ArtMethod::PrettyMethod(method->GetNonObsoleteMethod()) << " "
Vladimir Marko2196c652017-11-30 16:16:07 +00001534 << ArtMethod::PrettyMethod(found_method->GetNonObsoleteMethod()) << " "
David Sehr709b0702016-10-13 09:12:37 -07001535 << std::hex << pc;
Nicolas Geoffray5a23d2e2015-11-03 18:58:57 +00001536 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001537 return method_header;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001538}
1539
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00001540OatQuickMethodHeader* JitCodeCache::LookupOsrMethodHeader(ArtMethod* method) {
1541 MutexLock mu(Thread::Current(), lock_);
1542 auto it = osr_code_map_.find(method);
1543 if (it == osr_code_map_.end()) {
1544 return nullptr;
1545 }
1546 return OatQuickMethodHeader::FromCodePointer(it->second);
1547}
1548
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001549ProfilingInfo* JitCodeCache::AddProfilingInfo(Thread* self,
1550 ArtMethod* method,
1551 const std::vector<uint32_t>& entries,
Nicolas Geoffray1e7da9b2016-03-01 14:11:40 +00001552 bool retry_allocation)
1553 // No thread safety analysis as we are using TryLock/Unlock explicitly.
1554 NO_THREAD_SAFETY_ANALYSIS {
1555 ProfilingInfo* info = nullptr;
1556 if (!retry_allocation) {
1557 // If we are allocating for the interpreter, just try to lock, to avoid
1558 // lock contention with the JIT.
1559 if (lock_.ExclusiveTryLock(self)) {
1560 info = AddProfilingInfoInternal(self, method, entries);
1561 lock_.ExclusiveUnlock(self);
1562 }
1563 } else {
1564 {
1565 MutexLock mu(self, lock_);
1566 info = AddProfilingInfoInternal(self, method, entries);
1567 }
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001568
Nicolas Geoffray1e7da9b2016-03-01 14:11:40 +00001569 if (info == nullptr) {
1570 GarbageCollectCache(self);
1571 MutexLock mu(self, lock_);
1572 info = AddProfilingInfoInternal(self, method, entries);
1573 }
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001574 }
1575 return info;
1576}
1577
Nicolas Geoffray1e7da9b2016-03-01 14:11:40 +00001578ProfilingInfo* JitCodeCache::AddProfilingInfoInternal(Thread* self ATTRIBUTE_UNUSED,
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001579 ArtMethod* method,
1580 const std::vector<uint32_t>& entries) {
1581 size_t profile_info_size = RoundUp(
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001582 sizeof(ProfilingInfo) + sizeof(InlineCache) * entries.size(),
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001583 sizeof(void*));
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001584
1585 // Check whether some other thread has concurrently created it.
Andreas Gampe542451c2016-07-26 09:02:02 -07001586 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001587 if (info != nullptr) {
1588 return info;
1589 }
1590
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001591 uint8_t* data = AllocateData(profile_info_size);
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001592 if (data == nullptr) {
1593 return nullptr;
1594 }
1595 info = new (data) ProfilingInfo(method, entries);
Nicolas Geoffray07f35642016-01-04 16:06:51 +00001596
1597 // Make sure other threads see the data in the profiling info object before the
1598 // store in the ArtMethod's ProfilingInfo pointer.
Orion Hodson27b96762018-03-13 16:06:57 +00001599 std::atomic_thread_fence(std::memory_order_release);
Nicolas Geoffray07f35642016-01-04 16:06:51 +00001600
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001601 method->SetProfilingInfo(info);
1602 profiling_infos_.push_back(info);
Nicolas Geoffray933330a2016-03-16 14:20:06 +00001603 histogram_profiling_info_memory_use_.AddValue(profile_info_size);
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001604 return info;
1605}
1606
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001607// NO_THREAD_SAFETY_ANALYSIS as this is called from mspace code, at which point the lock
1608// is already held.
1609void* JitCodeCache::MoreCore(const void* mspace, intptr_t increment) NO_THREAD_SAFETY_ANALYSIS {
1610 if (code_mspace_ == mspace) {
1611 size_t result = code_end_;
1612 code_end_ += increment;
Orion Hodsondbd05fe2017-08-10 11:41:35 +01001613 return reinterpret_cast<void*>(result + code_map_->Begin());
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001614 } else {
1615 DCHECK_EQ(data_mspace_, mspace);
1616 size_t result = data_end_;
1617 data_end_ += increment;
1618 return reinterpret_cast<void*>(result + data_map_->Begin());
1619 }
1620}
1621
Calin Juravle99629622016-04-19 16:33:46 +01001622void JitCodeCache::GetProfiledMethods(const std::set<std::string>& dex_base_locations,
Calin Juravle940eb0c2017-01-30 19:30:44 -08001623 std::vector<ProfileMethodInfo>& methods) {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001624 ScopedTrace trace(__FUNCTION__);
Calin Juravle31f2c152015-10-23 17:56:15 +01001625 MutexLock mu(Thread::Current(), lock_);
Calin Juravlea39fd982017-05-18 10:15:52 -07001626 uint16_t jit_compile_threshold = Runtime::Current()->GetJITOptions()->GetCompileThreshold();
Calin Juravle99629622016-04-19 16:33:46 +01001627 for (const ProfilingInfo* info : profiling_infos_) {
1628 ArtMethod* method = info->GetMethod();
1629 const DexFile* dex_file = method->GetDexFile();
Mathieu Chartier79c87da2017-10-10 11:54:29 -07001630 const std::string base_location = DexFileLoader::GetBaseLocation(dex_file->GetLocation());
1631 if (!ContainsElement(dex_base_locations, base_location)) {
Calin Juravle940eb0c2017-01-30 19:30:44 -08001632 // Skip dex files which are not profiled.
1633 continue;
Calin Juravle31f2c152015-10-23 17:56:15 +01001634 }
Calin Juravle940eb0c2017-01-30 19:30:44 -08001635 std::vector<ProfileMethodInfo::ProfileInlineCache> inline_caches;
Calin Juravlea39fd982017-05-18 10:15:52 -07001636
1637 // If the method didn't reach the compilation threshold don't save the inline caches.
1638 // They might be incomplete and cause unnecessary deoptimizations.
1639 // If the inline cache is empty the compiler will generate a regular invoke virtual/interface.
1640 if (method->GetCounter() < jit_compile_threshold) {
1641 methods.emplace_back(/*ProfileMethodInfo*/
Mathieu Chartierbbe3a5e2017-06-13 16:36:17 -07001642 MethodReference(dex_file, method->GetDexMethodIndex()), inline_caches);
Calin Juravlea39fd982017-05-18 10:15:52 -07001643 continue;
1644 }
1645
Calin Juravle940eb0c2017-01-30 19:30:44 -08001646 for (size_t i = 0; i < info->number_of_inline_caches_; ++i) {
Mathieu Chartierdbddc222017-05-24 12:04:13 -07001647 std::vector<TypeReference> profile_classes;
Calin Juravle940eb0c2017-01-30 19:30:44 -08001648 const InlineCache& cache = info->cache_[i];
Calin Juravle13439f02017-02-21 01:17:21 -08001649 ArtMethod* caller = info->GetMethod();
Calin Juravle589e71e2017-03-03 16:05:05 -08001650 bool is_missing_types = false;
Calin Juravle940eb0c2017-01-30 19:30:44 -08001651 for (size_t k = 0; k < InlineCache::kIndividualCacheSize; k++) {
1652 mirror::Class* cls = cache.classes_[k].Read();
1653 if (cls == nullptr) {
1654 break;
1655 }
Calin Juravle4ca70a32017-02-21 16:22:24 -08001656
Calin Juravle13439f02017-02-21 01:17:21 -08001657 // Check if the receiver is in the boot class path or if it's in the
1658 // same class loader as the caller. If not, skip it, as there is not
1659 // much we can do during AOT.
1660 if (!cls->IsBootStrapClassLoaded() &&
1661 caller->GetClassLoader() != cls->GetClassLoader()) {
1662 is_missing_types = true;
1663 continue;
1664 }
1665
Calin Juravle4ca70a32017-02-21 16:22:24 -08001666 const DexFile* class_dex_file = nullptr;
1667 dex::TypeIndex type_index;
1668
1669 if (cls->GetDexCache() == nullptr) {
1670 DCHECK(cls->IsArrayClass()) << cls->PrettyClass();
Calin Juravlee21806f2017-02-22 11:49:43 -08001671 // Make a best effort to find the type index in the method's dex file.
1672 // We could search all open dex files but that might turn expensive
1673 // and probably not worth it.
Calin Juravle4ca70a32017-02-21 16:22:24 -08001674 class_dex_file = dex_file;
1675 type_index = cls->FindTypeIndexInOtherDexFile(*dex_file);
1676 } else {
1677 class_dex_file = &(cls->GetDexFile());
1678 type_index = cls->GetDexTypeIndex();
1679 }
1680 if (!type_index.IsValid()) {
1681 // Could be a proxy class or an array for which we couldn't find the type index.
Calin Juravle589e71e2017-03-03 16:05:05 -08001682 is_missing_types = true;
Calin Juravle4ca70a32017-02-21 16:22:24 -08001683 continue;
1684 }
Mathieu Chartier79c87da2017-10-10 11:54:29 -07001685 if (ContainsElement(dex_base_locations,
1686 DexFileLoader::GetBaseLocation(class_dex_file->GetLocation()))) {
Calin Juravle940eb0c2017-01-30 19:30:44 -08001687 // Only consider classes from the same apk (including multidex).
1688 profile_classes.emplace_back(/*ProfileMethodInfo::ProfileClassReference*/
Calin Juravle4ca70a32017-02-21 16:22:24 -08001689 class_dex_file, type_index);
Calin Juravle589e71e2017-03-03 16:05:05 -08001690 } else {
1691 is_missing_types = true;
Calin Juravle940eb0c2017-01-30 19:30:44 -08001692 }
1693 }
1694 if (!profile_classes.empty()) {
1695 inline_caches.emplace_back(/*ProfileMethodInfo::ProfileInlineCache*/
Calin Juravle589e71e2017-03-03 16:05:05 -08001696 cache.dex_pc_, is_missing_types, profile_classes);
Calin Juravle940eb0c2017-01-30 19:30:44 -08001697 }
1698 }
1699 methods.emplace_back(/*ProfileMethodInfo*/
Mathieu Chartierbbe3a5e2017-06-13 16:36:17 -07001700 MethodReference(dex_file, method->GetDexMethodIndex()), inline_caches);
Calin Juravle31f2c152015-10-23 17:56:15 +01001701 }
1702}
1703
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +01001704bool JitCodeCache::IsOsrCompiled(ArtMethod* method) {
1705 MutexLock mu(Thread::Current(), lock_);
1706 return osr_code_map_.find(method) != osr_code_map_.end();
1707}
1708
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00001709bool JitCodeCache::NotifyCompilationOf(ArtMethod* method, Thread* self, bool osr) {
1710 if (!osr && ContainsPc(method->GetEntryPointFromQuickCompiledCode())) {
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001711 return false;
1712 }
Nicolas Geoffraya42363f2015-12-17 14:57:09 +00001713
Nicolas Geoffraya42363f2015-12-17 14:57:09 +00001714 MutexLock mu(self, lock_);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00001715 if (osr && (osr_code_map_.find(method) != osr_code_map_.end())) {
1716 return false;
1717 }
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001718
Vladimir Marko2196c652017-11-30 16:16:07 +00001719 if (UNLIKELY(method->IsNative())) {
1720 JniStubKey key(method);
1721 auto it = jni_stubs_map_.find(key);
1722 bool new_compilation = false;
1723 if (it == jni_stubs_map_.end()) {
1724 // Create a new entry to mark the stub as being compiled.
1725 it = jni_stubs_map_.Put(key, JniStubData{});
1726 new_compilation = true;
1727 }
1728 JniStubData* data = &it->second;
1729 data->AddMethod(method);
1730 if (data->IsCompiled()) {
1731 OatQuickMethodHeader* method_header = OatQuickMethodHeader::FromCodePointer(data->GetCode());
1732 const void* entrypoint = method_header->GetEntryPoint();
1733 // Update also entrypoints of other methods held by the JniStubData.
1734 // We could simply update the entrypoint of `method` but if the last JIT GC has
1735 // changed these entrypoints to GenericJNI in preparation for a full GC, we may
1736 // as well change them back as this stub shall not be collected anyway and this
1737 // can avoid a few expensive GenericJNI calls.
1738 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
1739 for (ArtMethod* m : data->GetMethods()) {
Nicolas Geoffraya6e0e7d2018-01-26 13:16:50 +00001740 // Call the dedicated method instead of the more generic UpdateMethodsCode, because
1741 // `m` might be in the process of being deleted.
1742 instrumentation->UpdateNativeMethodsCodeToJitCode(m, entrypoint);
Vladimir Marko2196c652017-11-30 16:16:07 +00001743 }
1744 if (collection_in_progress_) {
1745 GetLiveBitmap()->AtomicTestAndSet(FromCodeToAllocation(data->GetCode()));
1746 }
1747 }
1748 return new_compilation;
1749 } else {
1750 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
1751 if (info == nullptr) {
1752 VLOG(jit) << method->PrettyMethod() << " needs a ProfilingInfo to be compiled";
1753 // Because the counter is not atomic, there are some rare cases where we may not hit the
1754 // threshold for creating the ProfilingInfo. Reset the counter now to "correct" this.
1755 ClearMethodCounter(method, /*was_warm*/ false);
1756 return false;
1757 }
Nicolas Geoffray056d7752017-11-30 09:12:13 +00001758
Vladimir Marko2196c652017-11-30 16:16:07 +00001759 if (info->IsMethodBeingCompiled(osr)) {
1760 return false;
1761 }
Nicolas Geoffray056d7752017-11-30 09:12:13 +00001762
Vladimir Marko2196c652017-11-30 16:16:07 +00001763 info->SetIsMethodBeingCompiled(true, osr);
1764 return true;
1765 }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001766}
1767
Nicolas Geoffray07e3ca92016-03-11 09:57:57 +00001768ProfilingInfo* JitCodeCache::NotifyCompilerUse(ArtMethod* method, Thread* self) {
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001769 MutexLock mu(self, lock_);
Andreas Gampe542451c2016-07-26 09:02:02 -07001770 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001771 if (info != nullptr) {
Nicolas Geoffrayf6d46682017-02-28 17:41:45 +00001772 if (!info->IncrementInlineUse()) {
1773 // Overflow of inlining uses, just bail.
1774 return nullptr;
1775 }
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001776 }
Nicolas Geoffray07e3ca92016-03-11 09:57:57 +00001777 return info;
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001778}
1779
Nicolas Geoffray07e3ca92016-03-11 09:57:57 +00001780void JitCodeCache::DoneCompilerUse(ArtMethod* method, Thread* self) {
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001781 MutexLock mu(self, lock_);
Andreas Gampe542451c2016-07-26 09:02:02 -07001782 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
Nicolas Geoffray07e3ca92016-03-11 09:57:57 +00001783 DCHECK(info != nullptr);
1784 info->DecrementInlineUse();
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001785}
1786
Vladimir Marko2196c652017-11-30 16:16:07 +00001787void JitCodeCache::DoneCompiling(ArtMethod* method, Thread* self, bool osr) {
1788 DCHECK_EQ(Thread::Current(), self);
1789 MutexLock mu(self, lock_);
1790 if (UNLIKELY(method->IsNative())) {
1791 auto it = jni_stubs_map_.find(JniStubKey(method));
1792 DCHECK(it != jni_stubs_map_.end());
1793 JniStubData* data = &it->second;
1794 DCHECK(ContainsElement(data->GetMethods(), method));
1795 if (UNLIKELY(!data->IsCompiled())) {
1796 // Failed to compile; the JNI compiler never fails, but the cache may be full.
1797 jni_stubs_map_.erase(it); // Remove the entry added in NotifyCompilationOf().
1798 } // else CommitCodeInternal() updated entrypoints of all methods in the JniStubData.
1799 } else {
1800 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
1801 DCHECK(info->IsMethodBeingCompiled(osr));
1802 info->SetIsMethodBeingCompiled(false, osr);
1803 }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001804}
1805
Nicolas Geoffraya25dce92016-01-12 16:41:10 +00001806size_t JitCodeCache::GetMemorySizeOfCodePointer(const void* ptr) {
1807 MutexLock mu(Thread::Current(), lock_);
1808 return mspace_usable_size(reinterpret_cast<const void*>(FromCodeToAllocation(ptr)));
1809}
1810
Nicolas Geoffrayb88d59e2016-02-17 11:31:49 +00001811void JitCodeCache::InvalidateCompiledCodeFor(ArtMethod* method,
1812 const OatQuickMethodHeader* header) {
Vladimir Marko2196c652017-11-30 16:16:07 +00001813 DCHECK(!method->IsNative());
Andreas Gampe542451c2016-07-26 09:02:02 -07001814 ProfilingInfo* profiling_info = method->GetProfilingInfo(kRuntimePointerSize);
Alex Light2d441b12018-06-08 15:33:21 -07001815 const void* method_entrypoint = method->GetEntryPointFromQuickCompiledCode();
Nicolas Geoffray35122442016-03-02 12:05:30 +00001816 if ((profiling_info != nullptr) &&
1817 (profiling_info->GetSavedEntryPoint() == header->GetEntryPoint())) {
Alex Light2d441b12018-06-08 15:33:21 -07001818 // When instrumentation is set, the actual entrypoint is the one in the profiling info.
1819 method_entrypoint = profiling_info->GetSavedEntryPoint();
Nicolas Geoffray35122442016-03-02 12:05:30 +00001820 // Prevent future uses of the compiled code.
1821 profiling_info->SetSavedEntryPoint(nullptr);
1822 }
1823
Alex Light2d441b12018-06-08 15:33:21 -07001824 // Clear the method counter if we are running jitted code since we might want to jit this again in
1825 // the future.
1826 if (method_entrypoint == header->GetEntryPoint()) {
Jeff Hao00286db2017-05-30 16:53:07 -07001827 // The entrypoint is the one to invalidate, so we just update it to the interpreter entry point
Mathieu Chartierf044c222017-05-31 15:27:54 -07001828 // and clear the counter to get the method Jitted again.
Nicolas Geoffrayb88d59e2016-02-17 11:31:49 +00001829 Runtime::Current()->GetInstrumentation()->UpdateMethodsCode(
1830 method, GetQuickToInterpreterBridge());
Mathieu Chartierf044c222017-05-31 15:27:54 -07001831 ClearMethodCounter(method, /*was_warm*/ profiling_info != nullptr);
Nicolas Geoffrayb88d59e2016-02-17 11:31:49 +00001832 } else {
1833 MutexLock mu(Thread::Current(), lock_);
1834 auto it = osr_code_map_.find(method);
1835 if (it != osr_code_map_.end() && OatQuickMethodHeader::FromCodePointer(it->second) == header) {
1836 // Remove the OSR method, to avoid using it again.
1837 osr_code_map_.erase(it);
1838 }
1839 }
1840}
1841
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001842uint8_t* JitCodeCache::AllocateCode(size_t code_size) {
1843 size_t alignment = GetInstructionSetAlignment(kRuntimeISA);
1844 uint8_t* result = reinterpret_cast<uint8_t*>(
1845 mspace_memalign(code_mspace_, alignment, code_size));
1846 size_t header_size = RoundUp(sizeof(OatQuickMethodHeader), alignment);
1847 // Ensure the header ends up at expected instruction alignment.
1848 DCHECK_ALIGNED_PARAM(reinterpret_cast<uintptr_t>(result + header_size), alignment);
1849 used_memory_for_code_ += mspace_usable_size(result);
1850 return result;
1851}
1852
Orion Hodsondbd05fe2017-08-10 11:41:35 +01001853void JitCodeCache::FreeCode(uint8_t* code) {
1854 used_memory_for_code_ -= mspace_usable_size(code);
1855 mspace_free(code_mspace_, code);
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001856}
1857
1858uint8_t* JitCodeCache::AllocateData(size_t data_size) {
1859 void* result = mspace_malloc(data_mspace_, data_size);
1860 used_memory_for_data_ += mspace_usable_size(result);
1861 return reinterpret_cast<uint8_t*>(result);
1862}
1863
1864void JitCodeCache::FreeData(uint8_t* data) {
1865 used_memory_for_data_ -= mspace_usable_size(data);
1866 mspace_free(data_mspace_, data);
1867}
1868
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001869void JitCodeCache::Dump(std::ostream& os) {
1870 MutexLock mu(Thread::Current(), lock_);
David Srbeckyfb3de3d2018-01-29 16:11:49 +00001871 MutexLock mu2(Thread::Current(), *Locks::native_debug_interface_lock_);
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001872 os << "Current JIT code cache size: " << PrettySize(used_memory_for_code_) << "\n"
1873 << "Current JIT data cache size: " << PrettySize(used_memory_for_data_) << "\n"
David Srbecky440a9b32018-02-15 17:47:29 +00001874 << "Current JIT mini-debug-info size: " << PrettySize(GetJitNativeDebugInfoMemUsage()) << "\n"
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001875 << "Current JIT capacity: " << PrettySize(current_capacity_) << "\n"
Vladimir Marko2196c652017-11-30 16:16:07 +00001876 << "Current number of JIT JNI stub entries: " << jni_stubs_map_.size() << "\n"
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001877 << "Current number of JIT code cache entries: " << method_code_map_.size() << "\n"
1878 << "Total number of JIT compilations: " << number_of_compilations_ << "\n"
1879 << "Total number of JIT compilations for on stack replacement: "
1880 << number_of_osr_compilations_ << "\n"
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001881 << "Total number of JIT code cache collections: " << number_of_collections_ << std::endl;
Nicolas Geoffray933330a2016-03-16 14:20:06 +00001882 histogram_stack_map_memory_use_.PrintMemoryUse(os);
1883 histogram_code_memory_use_.PrintMemoryUse(os);
1884 histogram_profiling_info_memory_use_.PrintMemoryUse(os);
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001885}
1886
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001887} // namespace jit
1888} // namespace art