blob: d9c79005779948fb6c78e3d9cb9cf537c7622d09 [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.
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100208 MemMap data_map = MemMap::MapAnonymous(
209 "data-code-cache",
210 /* addr */ nullptr,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000211 max_capacity,
Andreas Gampee4deaf32017-06-09 15:27:15 -0700212 kProtData,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000213 /* low_4gb */ true,
214 /* reuse */ false,
215 &error_str,
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100216 use_ashmem);
217 if (!data_map.IsValid()) {
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800218 std::ostringstream oss;
Andreas Gampee4deaf32017-06-09 15:27:15 -0700219 oss << "Failed to create read write cache: " << error_str << " size=" << max_capacity;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800220 *error_msg = oss.str();
221 return nullptr;
222 }
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100223
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100224 // Align both capacities to page size, as that's the unit mspaces use.
225 initial_capacity = RoundDown(initial_capacity, 2 * kPageSize);
226 max_capacity = RoundDown(max_capacity, 2 * kPageSize);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100227
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100228 // Data cache is 1 / 2 of the map.
229 // TODO: Make this variable?
230 size_t data_size = max_capacity / 2;
231 size_t code_size = max_capacity - data_size;
232 DCHECK_EQ(code_size + data_size, max_capacity);
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100233 uint8_t* divider = data_map.Begin() + data_size;
David Sehrd1dbb742017-07-17 11:20:38 -0700234
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100235 MemMap code_map = data_map.RemapAtEnd(
236 divider, "jit-code-cache", memmap_flags_prot_code | PROT_WRITE, &error_str, use_ashmem);
237 if (!code_map.IsValid()) {
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100238 std::ostringstream oss;
239 oss << "Failed to create read write execute cache: " << error_str << " size=" << max_capacity;
240 *error_msg = oss.str();
David Sehrd1dbb742017-07-17 11:20:38 -0700241 return nullptr;
242 }
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100243 DCHECK_EQ(code_map.Begin(), divider);
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000244 data_size = initial_capacity / 2;
245 code_size = initial_capacity - data_size;
246 DCHECK_EQ(code_size + data_size, initial_capacity);
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100247 return new JitCodeCache(
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100248 std::move(code_map),
249 std::move(data_map),
Calin Juravle016fcbe22018-05-03 19:47:35 -0700250 code_size,
251 data_size,
252 max_capacity,
253 garbage_collect_code,
254 memmap_flags_prot_code);
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800255}
256
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100257JitCodeCache::JitCodeCache(MemMap&& code_map,
258 MemMap&& data_map,
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000259 size_t initial_code_capacity,
260 size_t initial_data_capacity,
Nicolas Geoffraya25dce92016-01-12 16:41:10 +0000261 size_t max_capacity,
Calin Juravle016fcbe22018-05-03 19:47:35 -0700262 bool garbage_collect_code,
263 int memmap_flags_prot_code)
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100264 : lock_("Jit code cache", kJitCodeCacheLock),
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000265 lock_cond_("Jit code cache condition variable", lock_),
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100266 collection_in_progress_(false),
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100267 code_map_(std::move(code_map)),
268 data_map_(std::move(data_map)),
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000269 max_capacity_(max_capacity),
270 current_capacity_(initial_code_capacity + initial_data_capacity),
271 code_end_(initial_code_capacity),
272 data_end_(initial_data_capacity),
Nicolas Geoffray35122442016-03-02 12:05:30 +0000273 last_collection_increased_code_cache_(false),
Nicolas Geoffray0a522232016-01-19 09:34:58 +0000274 garbage_collect_code_(garbage_collect_code),
Nicolas Geoffrayb0d22082016-02-24 17:18:25 +0000275 used_memory_for_data_(0),
276 used_memory_for_code_(0),
Nicolas Geoffrayfcdd7292016-02-25 13:27:47 +0000277 number_of_compilations_(0),
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +0000278 number_of_osr_compilations_(0),
Nicolas Geoffray933330a2016-03-16 14:20:06 +0000279 number_of_collections_(0),
280 histogram_stack_map_memory_use_("Memory used for stack maps", 16),
281 histogram_code_memory_use_("Memory used for compiled code", 16),
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000282 histogram_profiling_info_memory_use_("Memory used for profiling info", 16),
283 is_weak_access_enabled_(true),
Calin Juravle016fcbe22018-05-03 19:47:35 -0700284 inline_cache_cond_("Jit inline cache condition variable", lock_),
285 memmap_flags_prot_code_(memmap_flags_prot_code) {
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100286
Nicolas Geoffrayc3fec4c2016-01-14 16:16:35 +0000287 DCHECK_GE(max_capacity, initial_code_capacity + initial_data_capacity);
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100288 code_mspace_ = create_mspace_with_base(code_map_.Begin(), code_end_, false /*locked*/);
289 data_mspace_ = create_mspace_with_base(data_map_.Begin(), data_end_, false /*locked*/);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100290
291 if (code_mspace_ == nullptr || data_mspace_ == nullptr) {
292 PLOG(FATAL) << "create_mspace_with_base failed";
293 }
294
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000295 SetFootprintLimit(current_capacity_);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100296
Mathieu Chartier8d8de0c2017-10-04 09:35:30 -0700297 CheckedCall(mprotect,
298 "mprotect jit code cache",
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100299 code_map_.Begin(),
300 code_map_.Size(),
Calin Juravle016fcbe22018-05-03 19:47:35 -0700301 memmap_flags_prot_code_);
Mathieu Chartier8d8de0c2017-10-04 09:35:30 -0700302 CheckedCall(mprotect,
303 "mprotect jit data cache",
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100304 data_map_.Begin(),
305 data_map_.Size(),
Mathieu Chartier8d8de0c2017-10-04 09:35:30 -0700306 kProtData);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100307
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000308 VLOG(jit) << "Created jit code cache: initial data size="
309 << PrettySize(initial_data_capacity)
310 << ", initial code size="
311 << PrettySize(initial_code_capacity);
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800312}
313
Vladimir Markob0b68cf2017-11-14 18:11:50 +0000314JitCodeCache::~JitCodeCache() {}
315
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100316bool JitCodeCache::ContainsPc(const void* ptr) const {
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100317 return code_map_.Begin() <= ptr && ptr < code_map_.End();
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800318}
319
Alex Light2d441b12018-06-08 15:33:21 -0700320bool JitCodeCache::WillExecuteJitCode(ArtMethod* method) {
321 ScopedObjectAccess soa(art::Thread::Current());
322 ScopedAssertNoThreadSuspension sants(__FUNCTION__);
323 if (ContainsPc(method->GetEntryPointFromQuickCompiledCode())) {
324 return true;
325 } else if (method->GetEntryPointFromQuickCompiledCode() == GetQuickInstrumentationEntryPoint()) {
326 return FindCompiledCodeForInstrumentation(method) != nullptr;
327 }
328 return false;
329}
330
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000331bool JitCodeCache::ContainsMethod(ArtMethod* method) {
332 MutexLock mu(Thread::Current(), lock_);
Vladimir Marko2196c652017-11-30 16:16:07 +0000333 if (UNLIKELY(method->IsNative())) {
334 auto it = jni_stubs_map_.find(JniStubKey(method));
335 if (it != jni_stubs_map_.end() &&
336 it->second.IsCompiled() &&
337 ContainsElement(it->second.GetMethods(), method)) {
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000338 return true;
339 }
Vladimir Marko2196c652017-11-30 16:16:07 +0000340 } else {
341 for (const auto& it : method_code_map_) {
342 if (it.second == method) {
343 return true;
344 }
345 }
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000346 }
347 return false;
348}
349
Vladimir Marko2196c652017-11-30 16:16:07 +0000350const void* JitCodeCache::GetJniStubCode(ArtMethod* method) {
351 DCHECK(method->IsNative());
352 MutexLock mu(Thread::Current(), lock_);
353 auto it = jni_stubs_map_.find(JniStubKey(method));
354 if (it != jni_stubs_map_.end()) {
355 JniStubData& data = it->second;
356 if (data.IsCompiled() && ContainsElement(data.GetMethods(), method)) {
357 return data.GetCode();
358 }
359 }
360 return nullptr;
361}
362
Alex Light2d441b12018-06-08 15:33:21 -0700363const void* JitCodeCache::FindCompiledCodeForInstrumentation(ArtMethod* method) {
Alex Light839f53a2018-07-10 15:46:14 -0700364 // If jit-gc is still on we use the SavedEntryPoint field for doing that and so cannot use it to
365 // find the instrumentation entrypoint.
366 if (LIKELY(GetGarbageCollectCode())) {
Alex Light2d441b12018-06-08 15:33:21 -0700367 return nullptr;
368 }
369 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
370 if (info == nullptr) {
371 return nullptr;
372 }
373 // When GC is disabled for trampoline tracing we will use SavedEntrypoint to hold the actual
374 // jit-compiled version of the method. If jit-gc is disabled for other reasons this will just be
375 // nullptr.
376 return info->GetSavedEntryPoint();
377}
378
Mathieu Chartier33fbf372016-03-07 13:48:08 -0800379class ScopedCodeCacheWrite : ScopedTrace {
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100380 public:
Calin Juravle016fcbe22018-05-03 19:47:35 -0700381 explicit ScopedCodeCacheWrite(const JitCodeCache* const code_cache)
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100382 : ScopedTrace("ScopedCodeCacheWrite"),
Calin Juravle016fcbe22018-05-03 19:47:35 -0700383 code_cache_(code_cache) {
Mathieu Chartier33fbf372016-03-07 13:48:08 -0800384 ScopedTrace trace("mprotect all");
Calin Juravle016fcbe22018-05-03 19:47:35 -0700385 CheckedCall(
386 mprotect,
387 "make code writable",
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100388 code_cache_->code_map_.Begin(),
389 code_cache_->code_map_.Size(),
Calin Juravle016fcbe22018-05-03 19:47:35 -0700390 code_cache_->memmap_flags_prot_code_ | PROT_WRITE);
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800391 }
Calin Juravle016fcbe22018-05-03 19:47:35 -0700392
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100393 ~ScopedCodeCacheWrite() {
Mathieu Chartier33fbf372016-03-07 13:48:08 -0800394 ScopedTrace trace("mprotect code");
Calin Juravle016fcbe22018-05-03 19:47:35 -0700395 CheckedCall(
396 mprotect,
397 "make code protected",
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100398 code_cache_->code_map_.Begin(),
399 code_cache_->code_map_.Size(),
Calin Juravle016fcbe22018-05-03 19:47:35 -0700400 code_cache_->memmap_flags_prot_code_);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100401 }
Mathieu Chartier8d8de0c2017-10-04 09:35:30 -0700402
David Sehrd1dbb742017-07-17 11:20:38 -0700403 private:
Calin Juravle016fcbe22018-05-03 19:47:35 -0700404 const JitCodeCache* const code_cache_;
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100405
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100406 DISALLOW_COPY_AND_ASSIGN(ScopedCodeCacheWrite);
407};
408
409uint8_t* JitCodeCache::CommitCode(Thread* self,
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100410 ArtMethod* method,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000411 uint8_t* stack_map,
412 uint8_t* roots_data,
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100413 const uint8_t* code,
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000414 size_t code_size,
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100415 size_t data_size,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000416 bool osr,
Mingyao Yang063fc772016-08-02 11:02:54 -0700417 Handle<mirror::ObjectArray<mirror::Object>> roots,
418 bool has_should_deoptimize_flag,
419 const ArenaSet<ArtMethod*>& cha_single_implementation_list) {
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100420 uint8_t* result = CommitCodeInternal(self,
421 method,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000422 stack_map,
423 roots_data,
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100424 code,
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000425 code_size,
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100426 data_size,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000427 osr,
Mingyao Yang063fc772016-08-02 11:02:54 -0700428 roots,
429 has_should_deoptimize_flag,
430 cha_single_implementation_list);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100431 if (result == nullptr) {
432 // Retry.
433 GarbageCollectCache(self);
434 result = CommitCodeInternal(self,
435 method,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000436 stack_map,
437 roots_data,
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100438 code,
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000439 code_size,
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100440 data_size,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000441 osr,
Mingyao Yang063fc772016-08-02 11:02:54 -0700442 roots,
443 has_should_deoptimize_flag,
444 cha_single_implementation_list);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100445 }
446 return result;
447}
448
449bool JitCodeCache::WaitForPotentialCollectionToComplete(Thread* self) {
450 bool in_collection = false;
451 while (collection_in_progress_) {
452 in_collection = true;
453 lock_cond_.Wait(self);
454 }
455 return in_collection;
456}
457
458static uintptr_t FromCodeToAllocation(const void* code) {
459 size_t alignment = GetInstructionSetAlignment(kRuntimeISA);
460 return reinterpret_cast<uintptr_t>(code) - RoundUp(sizeof(OatQuickMethodHeader), alignment);
461}
462
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000463static uint32_t ComputeRootTableSize(uint32_t number_of_roots) {
464 return sizeof(uint32_t) + number_of_roots * sizeof(GcRoot<mirror::Object>);
465}
466
467static uint32_t GetNumberOfRoots(const uint8_t* stack_map) {
468 // The length of the table is stored just before the stack map (and therefore at the end of
469 // the table itself), in order to be able to fetch it from a `stack_map` pointer.
470 return reinterpret_cast<const uint32_t*>(stack_map)[-1];
471}
472
Mathieu Chartier7a704be2016-11-22 13:24:40 -0800473static void FillRootTableLength(uint8_t* roots_data, uint32_t length) {
474 // Store the length of the table at the end. This will allow fetching it from a `stack_map`
475 // pointer.
476 reinterpret_cast<uint32_t*>(roots_data)[length] = length;
477}
478
Nicolas Geoffrayf4b94422016-12-05 00:10:09 +0000479static const uint8_t* FromStackMapToRoots(const uint8_t* stack_map_data) {
480 return stack_map_data - ComputeRootTableSize(GetNumberOfRoots(stack_map_data));
481}
482
Alex Light3e36a9c2018-06-19 09:45:05 -0700483static void DCheckRootsAreValid(Handle<mirror::ObjectArray<mirror::Object>> roots)
484 REQUIRES(!Locks::intern_table_lock_) REQUIRES_SHARED(Locks::mutator_lock_) {
485 if (!kIsDebugBuild) {
486 return;
487 }
488 const uint32_t length = roots->GetLength();
489 // Put all roots in `roots_data`.
490 for (uint32_t i = 0; i < length; ++i) {
491 ObjPtr<mirror::Object> object = roots->Get(i);
492 // Ensure the string is strongly interned. b/32995596
493 if (object->IsString()) {
494 ObjPtr<mirror::String> str = ObjPtr<mirror::String>::DownCast(object);
495 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
496 CHECK(class_linker->GetInternTable()->LookupStrong(Thread::Current(), str) != nullptr);
497 }
498 }
499}
500
501void JitCodeCache::FillRootTable(uint8_t* roots_data,
502 Handle<mirror::ObjectArray<mirror::Object>> roots) {
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000503 GcRoot<mirror::Object>* gc_roots = reinterpret_cast<GcRoot<mirror::Object>*>(roots_data);
Mathieu Chartier7a704be2016-11-22 13:24:40 -0800504 const uint32_t length = roots->GetLength();
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000505 // Put all roots in `roots_data`.
506 for (uint32_t i = 0; i < length; ++i) {
507 ObjPtr<mirror::Object> object = roots->Get(i);
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000508 gc_roots[i] = GcRoot<mirror::Object>(object);
509 }
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000510}
511
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100512static uint8_t* GetRootTable(const void* code_ptr, uint32_t* number_of_roots = nullptr) {
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000513 OatQuickMethodHeader* method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
514 uint8_t* data = method_header->GetOptimizedCodeInfoPtr();
515 uint32_t roots = GetNumberOfRoots(data);
516 if (number_of_roots != nullptr) {
517 *number_of_roots = roots;
518 }
519 return data - ComputeRootTableSize(roots);
520}
521
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100522// Use a sentinel for marking entries in the JIT table that have been cleared.
523// This helps diagnosing in case the compiled code tries to wrongly access such
524// entries.
Andreas Gampe5629d2d2017-05-15 16:28:13 -0700525static mirror::Class* const weak_sentinel =
526 reinterpret_cast<mirror::Class*>(Context::kBadGprBase + 0xff);
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100527
Nicolas Geoffray22384ae2016-12-12 22:33:36 +0000528// Helper for the GC to process a weak class in a JIT root table.
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100529static inline void ProcessWeakClass(GcRoot<mirror::Class>* root_ptr,
530 IsMarkedVisitor* visitor,
531 mirror::Class* update)
Nicolas Geoffray22384ae2016-12-12 22:33:36 +0000532 REQUIRES_SHARED(Locks::mutator_lock_) {
533 // This does not need a read barrier because this is called by GC.
534 mirror::Class* cls = root_ptr->Read<kWithoutReadBarrier>();
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100535 if (cls != nullptr && cls != weak_sentinel) {
Nicolas Geoffray22384ae2016-12-12 22:33:36 +0000536 DCHECK((cls->IsClass<kDefaultVerifyFlags, kWithoutReadBarrier>()));
537 // Look at the classloader of the class to know if it has been unloaded.
538 // This does not need a read barrier because this is called by GC.
539 mirror::Object* class_loader =
540 cls->GetClassLoader<kDefaultVerifyFlags, kWithoutReadBarrier>();
541 if (class_loader == nullptr || visitor->IsMarked(class_loader) != nullptr) {
542 // The class loader is live, update the entry if the class has moved.
543 mirror::Class* new_cls = down_cast<mirror::Class*>(visitor->IsMarked(cls));
544 // Note that new_object can be null for CMS and newly allocated objects.
545 if (new_cls != nullptr && new_cls != cls) {
546 *root_ptr = GcRoot<mirror::Class>(new_cls);
547 }
548 } else {
549 // The class loader is not live, clear the entry.
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100550 *root_ptr = GcRoot<mirror::Class>(update);
Nicolas Geoffray22384ae2016-12-12 22:33:36 +0000551 }
552 }
553}
554
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000555void JitCodeCache::SweepRootTables(IsMarkedVisitor* visitor) {
556 MutexLock mu(Thread::Current(), lock_);
557 for (const auto& entry : method_code_map_) {
558 uint32_t number_of_roots = 0;
559 uint8_t* roots_data = GetRootTable(entry.first, &number_of_roots);
560 GcRoot<mirror::Object>* roots = reinterpret_cast<GcRoot<mirror::Object>*>(roots_data);
561 for (uint32_t i = 0; i < number_of_roots; ++i) {
562 // This does not need a read barrier because this is called by GC.
563 mirror::Object* object = roots[i].Read<kWithoutReadBarrier>();
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100564 if (object == nullptr || object == weak_sentinel) {
Nicolas Geoffray22384ae2016-12-12 22:33:36 +0000565 // entry got deleted in a previous sweep.
566 } else if (object->IsString<kDefaultVerifyFlags, kWithoutReadBarrier>()) {
567 mirror::Object* new_object = visitor->IsMarked(object);
568 // We know the string is marked because it's a strongly-interned string that
569 // is always alive. The IsMarked implementation of the CMS collector returns
570 // null for newly allocated objects, but we know those haven't moved. Therefore,
571 // only update the entry if we get a different non-null string.
572 // TODO: Do not use IsMarked for j.l.Class, and adjust once we move this method
573 // out of the weak access/creation pause. b/32167580
574 if (new_object != nullptr && new_object != object) {
575 DCHECK(new_object->IsString());
576 roots[i] = GcRoot<mirror::Object>(new_object);
577 }
578 } else {
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100579 ProcessWeakClass(
580 reinterpret_cast<GcRoot<mirror::Class>*>(&roots[i]), visitor, weak_sentinel);
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000581 }
582 }
583 }
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000584 // Walk over inline caches to clear entries containing unloaded classes.
585 for (ProfilingInfo* info : profiling_infos_) {
586 for (size_t i = 0; i < info->number_of_inline_caches_; ++i) {
587 InlineCache* cache = &info->cache_[i];
588 for (size_t j = 0; j < InlineCache::kIndividualCacheSize; ++j) {
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100589 ProcessWeakClass(&cache->classes_[j], visitor, nullptr);
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000590 }
591 }
592 }
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000593}
594
Orion Hodson607624f2018-05-11 10:10:46 +0100595void JitCodeCache::FreeCodeAndData(const void* code_ptr) {
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100596 uintptr_t allocation = FromCodeToAllocation(code_ptr);
David Srbecky5cc349f2015-12-18 15:04:48 +0000597 // Notify native debugger that we are about to remove the code.
598 // It does nothing if we are not using native debugger.
David Srbeckyfb3de3d2018-01-29 16:11:49 +0000599 MutexLock mu(Thread::Current(), *Locks::native_debug_interface_lock_);
David Srbecky440a9b32018-02-15 17:47:29 +0000600 RemoveNativeDebugInfoForJit(code_ptr);
Vladimir Marko2196c652017-11-30 16:16:07 +0000601 if (OatQuickMethodHeader::FromCodePointer(code_ptr)->IsOptimized()) {
602 FreeData(GetRootTable(code_ptr));
603 } // else this is a JNI stub without any data.
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100604 FreeCode(reinterpret_cast<uint8_t*>(allocation));
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100605}
606
Mingyao Yang063fc772016-08-02 11:02:54 -0700607void JitCodeCache::FreeAllMethodHeaders(
608 const std::unordered_set<OatQuickMethodHeader*>& method_headers) {
Mingyao Yang063fc772016-08-02 11:02:54 -0700609 // We need to remove entries in method_headers from CHA dependencies
610 // first since once we do FreeCode() below, the memory can be reused
611 // so it's possible for the same method_header to start representing
612 // different compile code.
613 MutexLock mu(Thread::Current(), lock_);
Alex Light33b7b5d2018-08-07 19:13:51 +0000614 {
615 MutexLock mu2(Thread::Current(), *Locks::cha_lock_);
616 Runtime::Current()->GetClassLinker()->GetClassHierarchyAnalysis()
617 ->RemoveDependentsWithMethodHeaders(method_headers);
618 }
619
Calin Juravle016fcbe22018-05-03 19:47:35 -0700620 ScopedCodeCacheWrite scc(this);
Mingyao Yang063fc772016-08-02 11:02:54 -0700621 for (const OatQuickMethodHeader* method_header : method_headers) {
Orion Hodson607624f2018-05-11 10:10:46 +0100622 FreeCodeAndData(method_header->GetCode());
Mingyao Yang063fc772016-08-02 11:02:54 -0700623 }
624}
625
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100626void JitCodeCache::RemoveMethodsIn(Thread* self, const LinearAlloc& alloc) {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800627 ScopedTrace trace(__PRETTY_FUNCTION__);
Mingyao Yang063fc772016-08-02 11:02:54 -0700628 // We use a set to first collect all method_headers whose code need to be
629 // removed. We need to free the underlying code after we remove CHA dependencies
630 // for entries in this set. And it's more efficient to iterate through
631 // the CHA dependency map just once with an unordered_set.
632 std::unordered_set<OatQuickMethodHeader*> method_headers;
Nicolas Geoffray26705e22015-10-28 12:50:11 +0000633 {
Mingyao Yang063fc772016-08-02 11:02:54 -0700634 MutexLock mu(self, lock_);
635 // We do not check if a code cache GC is in progress, as this method comes
636 // with the classlinker_classes_lock_ held, and suspending ourselves could
637 // lead to a deadlock.
638 {
Calin Juravle016fcbe22018-05-03 19:47:35 -0700639 ScopedCodeCacheWrite scc(this);
Vladimir Marko2196c652017-11-30 16:16:07 +0000640 for (auto it = jni_stubs_map_.begin(); it != jni_stubs_map_.end();) {
641 it->second.RemoveMethodsIn(alloc);
642 if (it->second.GetMethods().empty()) {
643 method_headers.insert(OatQuickMethodHeader::FromCodePointer(it->second.GetCode()));
644 it = jni_stubs_map_.erase(it);
645 } else {
646 it->first.UpdateShorty(it->second.GetMethods().front());
647 ++it;
648 }
649 }
Mingyao Yang063fc772016-08-02 11:02:54 -0700650 for (auto it = method_code_map_.begin(); it != method_code_map_.end();) {
651 if (alloc.ContainsUnsafe(it->second)) {
652 method_headers.insert(OatQuickMethodHeader::FromCodePointer(it->first));
653 it = method_code_map_.erase(it);
654 } else {
655 ++it;
656 }
657 }
658 }
659 for (auto it = osr_code_map_.begin(); it != osr_code_map_.end();) {
660 if (alloc.ContainsUnsafe(it->first)) {
661 // Note that the code has already been pushed to method_headers in the loop
662 // above and is going to be removed in FreeCode() below.
663 it = osr_code_map_.erase(it);
664 } else {
665 ++it;
666 }
667 }
668 for (auto it = profiling_infos_.begin(); it != profiling_infos_.end();) {
669 ProfilingInfo* info = *it;
670 if (alloc.ContainsUnsafe(info->GetMethod())) {
671 info->GetMethod()->SetProfilingInfo(nullptr);
672 FreeData(reinterpret_cast<uint8_t*>(info));
673 it = profiling_infos_.erase(it);
Nicolas Geoffray26705e22015-10-28 12:50:11 +0000674 } else {
675 ++it;
676 }
677 }
678 }
Mingyao Yang063fc772016-08-02 11:02:54 -0700679 FreeAllMethodHeaders(method_headers);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100680}
681
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000682bool JitCodeCache::IsWeakAccessEnabled(Thread* self) const {
683 return kUseReadBarrier
684 ? self->GetWeakRefAccessEnabled()
Orion Hodson88591fe2018-03-06 13:35:43 +0000685 : is_weak_access_enabled_.load(std::memory_order_seq_cst);
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000686}
687
688void JitCodeCache::WaitUntilInlineCacheAccessible(Thread* self) {
689 if (IsWeakAccessEnabled(self)) {
690 return;
691 }
692 ScopedThreadSuspension sts(self, kWaitingWeakGcRootRead);
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +0000693 MutexLock mu(self, lock_);
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000694 while (!IsWeakAccessEnabled(self)) {
695 inline_cache_cond_.Wait(self);
696 }
697}
698
699void JitCodeCache::BroadcastForInlineCacheAccess() {
700 Thread* self = Thread::Current();
701 MutexLock mu(self, lock_);
702 inline_cache_cond_.Broadcast(self);
703}
704
705void JitCodeCache::AllowInlineCacheAccess() {
706 DCHECK(!kUseReadBarrier);
Orion Hodson88591fe2018-03-06 13:35:43 +0000707 is_weak_access_enabled_.store(true, std::memory_order_seq_cst);
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000708 BroadcastForInlineCacheAccess();
709}
710
711void JitCodeCache::DisallowInlineCacheAccess() {
712 DCHECK(!kUseReadBarrier);
Orion Hodson88591fe2018-03-06 13:35:43 +0000713 is_weak_access_enabled_.store(false, std::memory_order_seq_cst);
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000714}
715
716void JitCodeCache::CopyInlineCacheInto(const InlineCache& ic,
717 Handle<mirror::ObjectArray<mirror::Class>> array) {
718 WaitUntilInlineCacheAccessible(Thread::Current());
719 // Note that we don't need to lock `lock_` here, the compiler calling
720 // this method has already ensured the inline cache will not be deleted.
721 for (size_t in_cache = 0, in_array = 0;
722 in_cache < InlineCache::kIndividualCacheSize;
723 ++in_cache) {
724 mirror::Class* object = ic.classes_[in_cache].Read();
725 if (object != nullptr) {
726 array->Set(in_array++, object);
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +0000727 }
728 }
729}
730
Mathieu Chartierf044c222017-05-31 15:27:54 -0700731static void ClearMethodCounter(ArtMethod* method, bool was_warm) {
732 if (was_warm) {
Vladimir Markoc945e0d2018-07-18 17:26:45 +0100733 method->SetPreviouslyWarm();
Mathieu Chartierf044c222017-05-31 15:27:54 -0700734 }
735 // We reset the counter to 1 so that the profile knows that the method was executed at least once.
736 // This is required for layout purposes.
Nicolas Geoffray88f50b12017-06-09 16:08:47 +0100737 // We also need to make sure we'll pass the warmup threshold again, so we set to 0 if
738 // the warmup threshold is 1.
739 uint16_t jit_warmup_threshold = Runtime::Current()->GetJITOptions()->GetWarmupThreshold();
740 method->SetCounter(std::min(jit_warmup_threshold - 1, 1));
Mathieu Chartierf044c222017-05-31 15:27:54 -0700741}
742
Alex Light33b7b5d2018-08-07 19:13:51 +0000743void JitCodeCache::WaitForPotentialCollectionToCompleteRunnable(Thread* self) {
744 while (collection_in_progress_) {
745 lock_.Unlock(self);
746 {
747 ScopedThreadSuspension sts(self, kSuspended);
748 MutexLock mu(self, lock_);
749 WaitForPotentialCollectionToComplete(self);
750 }
751 lock_.Lock(self);
752 }
753}
754
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100755uint8_t* JitCodeCache::CommitCodeInternal(Thread* self,
756 ArtMethod* method,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000757 uint8_t* stack_map,
758 uint8_t* roots_data,
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100759 const uint8_t* code,
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000760 size_t code_size,
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100761 size_t data_size,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000762 bool osr,
Mingyao Yang063fc772016-08-02 11:02:54 -0700763 Handle<mirror::ObjectArray<mirror::Object>> roots,
764 bool has_should_deoptimize_flag,
765 const ArenaSet<ArtMethod*>&
766 cha_single_implementation_list) {
Vladimir Marko2196c652017-11-30 16:16:07 +0000767 DCHECK(!method->IsNative() || !osr);
Alex Light33b7b5d2018-08-07 19:13:51 +0000768
769 if (!method->IsNative()) {
770 // We need to do this before grabbing the lock_ because it needs to be able to see the string
771 // InternTable. Native methods do not have roots.
772 DCheckRootsAreValid(roots);
773 }
774
Nicolas Geoffray1e7de6c2015-10-21 12:07:31 +0100775 size_t alignment = GetInstructionSetAlignment(kRuntimeISA);
776 // Ensure the header ends up at expected instruction alignment.
777 size_t header_size = RoundUp(sizeof(OatQuickMethodHeader), alignment);
778 size_t total_size = header_size + code_size;
779
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100780 OatQuickMethodHeader* method_header = nullptr;
Nicolas Geoffray1e7de6c2015-10-21 12:07:31 +0100781 uint8_t* code_ptr = nullptr;
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +0000782 uint8_t* memory = nullptr;
Alex Light33b7b5d2018-08-07 19:13:51 +0000783 MutexLock mu(self, lock_);
784 // We need to make sure that there will be no jit-gcs going on and wait for any ongoing one to
785 // finish.
786 WaitForPotentialCollectionToCompleteRunnable(self);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100787 {
Alex Light33b7b5d2018-08-07 19:13:51 +0000788 ScopedCodeCacheWrite scc(this);
789 memory = AllocateCode(total_size);
790 if (memory == nullptr) {
791 return nullptr;
792 }
793 code_ptr = memory + header_size;
Nicolas Geoffrayd28b9692015-11-04 14:36:55 +0000794
Alex Light33b7b5d2018-08-07 19:13:51 +0000795 std::copy(code, code + code_size, code_ptr);
796 method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
797 new (method_header) OatQuickMethodHeader(
798 (stack_map != nullptr) ? code_ptr - stack_map : 0u,
799 code_size);
800 // Flush caches before we remove write permission because some ARMv8 Qualcomm kernels may
801 // trigger a segfault if a page fault occurs when requesting a cache maintenance operation.
802 // This is a kernel bug that we need to work around until affected devices (e.g. Nexus 5X and
803 // 6P) stop being supported or their kernels are fixed.
804 //
805 // For reference, this behavior is caused by this commit:
806 // https://android.googlesource.com/kernel/msm/+/3fbe6bc28a6b9939d0650f2f17eb5216c719950c
807 FlushInstructionCache(reinterpret_cast<char*>(code_ptr),
808 reinterpret_cast<char*>(code_ptr + code_size));
809 DCHECK(!Runtime::Current()->IsAotCompiler());
810 if (has_should_deoptimize_flag) {
811 method_header->SetHasShouldDeoptimizeFlag();
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100812 }
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100813
Nicolas Geoffray0a522232016-01-19 09:34:58 +0000814 number_of_compilations_++;
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100815 }
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000816 // We need to update the entry point in the runnable state for the instrumentation.
817 {
Alex Light33b7b5d2018-08-07 19:13:51 +0000818 // The following needs to be guarded by cha_lock_ also. Otherwise it's possible that the
819 // compiled code is considered invalidated by some class linking, but below we still make the
820 // compiled code valid for the method. Need cha_lock_ for checking all single-implementation
821 // flags and register dependencies.
Mingyao Yang063fc772016-08-02 11:02:54 -0700822 MutexLock cha_mu(self, *Locks::cha_lock_);
823 bool single_impl_still_valid = true;
824 for (ArtMethod* single_impl : cha_single_implementation_list) {
825 if (!single_impl->HasSingleImplementation()) {
Jeff Hao00286db2017-05-30 16:53:07 -0700826 // Simply discard the compiled code. Clear the counter so that it may be recompiled later.
827 // Hopefully the class hierarchy will be more stable when compilation is retried.
Mingyao Yang063fc772016-08-02 11:02:54 -0700828 single_impl_still_valid = false;
Mathieu Chartierf044c222017-05-31 15:27:54 -0700829 ClearMethodCounter(method, /*was_warm*/ false);
Mingyao Yang063fc772016-08-02 11:02:54 -0700830 break;
831 }
832 }
833
834 // Discard the code if any single-implementation assumptions are now invalid.
835 if (!single_impl_still_valid) {
836 VLOG(jit) << "JIT discarded jitted code due to invalid single-implementation assumptions.";
837 return nullptr;
838 }
Nicolas Geoffray433b79a2017-01-30 20:54:45 +0000839 DCHECK(cha_single_implementation_list.empty() || !Runtime::Current()->IsJavaDebuggable())
Alex Lightdba61482016-12-21 08:20:29 -0800840 << "Should not be using cha on debuggable apps/runs!";
841
Mingyao Yang063fc772016-08-02 11:02:54 -0700842 for (ArtMethod* single_impl : cha_single_implementation_list) {
Andreas Gampec1ac9ee2017-07-24 22:35:49 -0700843 Runtime::Current()->GetClassLinker()->GetClassHierarchyAnalysis()->AddDependency(
Mingyao Yang063fc772016-08-02 11:02:54 -0700844 single_impl, method, method_header);
845 }
846
Vladimir Marko2196c652017-11-30 16:16:07 +0000847 if (UNLIKELY(method->IsNative())) {
Vladimir Marko2196c652017-11-30 16:16:07 +0000848 auto it = jni_stubs_map_.find(JniStubKey(method));
849 DCHECK(it != jni_stubs_map_.end())
850 << "Entry inserted in NotifyCompilationOf() should be alive.";
851 JniStubData* data = &it->second;
852 DCHECK(ContainsElement(data->GetMethods(), method))
853 << "Entry inserted in NotifyCompilationOf() should contain this method.";
854 data->SetCode(code_ptr);
855 instrumentation::Instrumentation* instrum = Runtime::Current()->GetInstrumentation();
856 for (ArtMethod* m : data->GetMethods()) {
857 instrum->UpdateMethodsCode(m, method_header->GetEntryPoint());
858 }
Nicolas Geoffray480d5102016-04-18 12:09:30 +0100859 } else {
Vladimir Marko2196c652017-11-30 16:16:07 +0000860 // Fill the root table before updating the entry point.
861 DCHECK_EQ(FromStackMapToRoots(stack_map), roots_data);
862 DCHECK_LE(roots_data, stack_map);
863 FillRootTable(roots_data, roots);
864 {
865 // Flush data cache, as compiled code references literals in it.
Vladimir Marko2196c652017-11-30 16:16:07 +0000866 FlushDataCache(reinterpret_cast<char*>(roots_data),
867 reinterpret_cast<char*>(roots_data + data_size));
868 }
869 method_code_map_.Put(code_ptr, method);
870 if (osr) {
871 number_of_osr_compilations_++;
872 osr_code_map_.Put(method, code_ptr);
873 } else {
874 Runtime::Current()->GetInstrumentation()->UpdateMethodsCode(
875 method, method_header->GetEntryPoint());
876 }
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000877 }
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000878 VLOG(jit)
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100879 << "JIT added (osr=" << std::boolalpha << osr << std::noboolalpha << ") "
David Sehr709b0702016-10-13 09:12:37 -0700880 << ArtMethod::PrettyMethod(method) << "@" << method
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000881 << " ccache_size=" << PrettySize(CodeCacheSizeLocked()) << ": "
882 << " dcache_size=" << PrettySize(DataCacheSizeLocked()) << ": "
883 << reinterpret_cast<const void*>(method_header->GetEntryPoint()) << ","
Mingyao Yang063fc772016-08-02 11:02:54 -0700884 << reinterpret_cast<const void*>(method_header->GetEntryPoint() +
885 method_header->GetCodeSize());
Nicolas Geoffray933330a2016-03-16 14:20:06 +0000886 histogram_code_memory_use_.AddValue(code_size);
887 if (code_size > kCodeSizeLogThreshold) {
888 LOG(INFO) << "JIT allocated "
889 << PrettySize(code_size)
890 << " for compiled code of "
David Sehr709b0702016-10-13 09:12:37 -0700891 << ArtMethod::PrettyMethod(method);
Nicolas Geoffray933330a2016-03-16 14:20:06 +0000892 }
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000893 }
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100894
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100895 return reinterpret_cast<uint8_t*>(method_header);
896}
897
898size_t JitCodeCache::CodeCacheSize() {
899 MutexLock mu(Thread::Current(), lock_);
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000900 return CodeCacheSizeLocked();
901}
902
Orion Hodsoneced6922017-06-01 10:54:28 +0100903bool JitCodeCache::RemoveMethod(ArtMethod* method, bool release_memory) {
Vladimir Marko2196c652017-11-30 16:16:07 +0000904 // This function is used only for testing and only with non-native methods.
905 CHECK(!method->IsNative());
906
Orion Hodsoneced6922017-06-01 10:54:28 +0100907 MutexLock mu(Thread::Current(), lock_);
Orion Hodsoneced6922017-06-01 10:54:28 +0100908
Vladimir Marko2196c652017-11-30 16:16:07 +0000909 bool osr = osr_code_map_.find(method) != osr_code_map_.end();
910 bool in_cache = RemoveMethodLocked(method, release_memory);
Orion Hodsoneced6922017-06-01 10:54:28 +0100911
912 if (!in_cache) {
913 return false;
914 }
915
Orion Hodsoneced6922017-06-01 10:54:28 +0100916 method->ClearCounter();
917 Runtime::Current()->GetInstrumentation()->UpdateMethodsCode(
918 method, GetQuickToInterpreterBridge());
919 VLOG(jit)
920 << "JIT removed (osr=" << std::boolalpha << osr << std::noboolalpha << ") "
921 << ArtMethod::PrettyMethod(method) << "@" << method
922 << " ccache_size=" << PrettySize(CodeCacheSizeLocked()) << ": "
923 << " dcache_size=" << PrettySize(DataCacheSizeLocked());
924 return true;
925}
926
Vladimir Marko2196c652017-11-30 16:16:07 +0000927bool JitCodeCache::RemoveMethodLocked(ArtMethod* method, bool release_memory) {
928 if (LIKELY(!method->IsNative())) {
929 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
930 if (info != nullptr) {
931 RemoveElement(profiling_infos_, info);
932 }
933 method->SetProfilingInfo(nullptr);
934 }
935
936 bool in_cache = false;
Calin Juravle016fcbe22018-05-03 19:47:35 -0700937 ScopedCodeCacheWrite ccw(this);
Vladimir Marko2196c652017-11-30 16:16:07 +0000938 if (UNLIKELY(method->IsNative())) {
939 auto it = jni_stubs_map_.find(JniStubKey(method));
940 if (it != jni_stubs_map_.end() && it->second.RemoveMethod(method)) {
941 in_cache = true;
942 if (it->second.GetMethods().empty()) {
943 if (release_memory) {
Orion Hodson607624f2018-05-11 10:10:46 +0100944 FreeCodeAndData(it->second.GetCode());
Vladimir Marko2196c652017-11-30 16:16:07 +0000945 }
946 jni_stubs_map_.erase(it);
947 } else {
948 it->first.UpdateShorty(it->second.GetMethods().front());
949 }
950 }
951 } else {
952 for (auto it = method_code_map_.begin(); it != method_code_map_.end();) {
953 if (it->second == method) {
954 in_cache = true;
955 if (release_memory) {
Orion Hodson607624f2018-05-11 10:10:46 +0100956 FreeCodeAndData(it->first);
Vladimir Marko2196c652017-11-30 16:16:07 +0000957 }
958 it = method_code_map_.erase(it);
959 } else {
960 ++it;
961 }
962 }
963
964 auto osr_it = osr_code_map_.find(method);
965 if (osr_it != osr_code_map_.end()) {
966 osr_code_map_.erase(osr_it);
967 }
968 }
969
970 return in_cache;
971}
972
Alex Lightdba61482016-12-21 08:20:29 -0800973// This notifies the code cache that the given method has been redefined and that it should remove
974// any cached information it has on the method. All threads must be suspended before calling this
975// method. The compiled code for the method (if there is any) must not be in any threads call stack.
976void JitCodeCache::NotifyMethodRedefined(ArtMethod* method) {
977 MutexLock mu(Thread::Current(), lock_);
Vladimir Marko2196c652017-11-30 16:16:07 +0000978 RemoveMethodLocked(method, /* release_memory */ true);
Alex Lightdba61482016-12-21 08:20:29 -0800979}
980
981// This invalidates old_method. Once this function returns one can no longer use old_method to
982// execute code unless it is fixed up. This fixup will happen later in the process of installing a
983// class redefinition.
984// TODO We should add some info to ArtMethod to note that 'old_method' has been invalidated and
985// shouldn't be used since it is no longer logically in the jit code cache.
986// TODO We should add DCHECKS that validate that the JIT is paused when this method is entered.
987void JitCodeCache::MoveObsoleteMethod(ArtMethod* old_method, ArtMethod* new_method) {
Vladimir Marko2196c652017-11-30 16:16:07 +0000988 MutexLock mu(Thread::Current(), lock_);
Alex Lighteee0bd42017-02-14 15:31:45 +0000989 if (old_method->IsNative()) {
Vladimir Marko2196c652017-11-30 16:16:07 +0000990 // Update methods in jni_stubs_map_.
991 for (auto& entry : jni_stubs_map_) {
992 JniStubData& data = entry.second;
993 data.MoveObsoleteMethod(old_method, new_method);
994 }
Alex Lighteee0bd42017-02-14 15:31:45 +0000995 return;
996 }
Alex Lightdba61482016-12-21 08:20:29 -0800997 // Update ProfilingInfo to the new one and remove it from the old_method.
998 if (old_method->GetProfilingInfo(kRuntimePointerSize) != nullptr) {
999 DCHECK_EQ(old_method->GetProfilingInfo(kRuntimePointerSize)->GetMethod(), old_method);
1000 ProfilingInfo* info = old_method->GetProfilingInfo(kRuntimePointerSize);
1001 old_method->SetProfilingInfo(nullptr);
1002 // Since the JIT should be paused and all threads suspended by the time this is called these
1003 // checks should always pass.
1004 DCHECK(!info->IsInUseByCompiler());
1005 new_method->SetProfilingInfo(info);
Alex Light2d441b12018-06-08 15:33:21 -07001006 // Get rid of the old saved entrypoint if it is there.
1007 info->SetSavedEntryPoint(nullptr);
Alex Lightdba61482016-12-21 08:20:29 -08001008 info->method_ = new_method;
1009 }
1010 // Update method_code_map_ to point to the new method.
1011 for (auto& it : method_code_map_) {
1012 if (it.second == old_method) {
1013 it.second = new_method;
1014 }
1015 }
1016 // Update osr_code_map_ to point to the new method.
1017 auto code_map = osr_code_map_.find(old_method);
1018 if (code_map != osr_code_map_.end()) {
1019 osr_code_map_.Put(new_method, code_map->second);
1020 osr_code_map_.erase(old_method);
1021 }
1022}
1023
Nicolas Geoffraya5891e82015-11-06 14:18:27 +00001024size_t JitCodeCache::CodeCacheSizeLocked() {
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001025 return used_memory_for_code_;
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +01001026}
1027
1028size_t JitCodeCache::DataCacheSize() {
1029 MutexLock mu(Thread::Current(), lock_);
Nicolas Geoffraya5891e82015-11-06 14:18:27 +00001030 return DataCacheSizeLocked();
1031}
1032
1033size_t JitCodeCache::DataCacheSizeLocked() {
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001034 return used_memory_for_data_;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001035}
1036
Nicolas Geoffrayf46501c2016-11-22 13:45:36 +00001037void JitCodeCache::ClearData(Thread* self,
1038 uint8_t* stack_map_data,
1039 uint8_t* roots_data) {
1040 DCHECK_EQ(FromStackMapToRoots(stack_map_data), roots_data);
Nicolas Geoffrayd28b9692015-11-04 14:36:55 +00001041 MutexLock mu(self, lock_);
Nicolas Geoffrayf46501c2016-11-22 13:45:36 +00001042 FreeData(reinterpret_cast<uint8_t*>(roots_data));
Nicolas Geoffrayd28b9692015-11-04 14:36:55 +00001043}
1044
Nicolas Geoffrayed015ac2016-12-15 17:58:48 +00001045size_t JitCodeCache::ReserveData(Thread* self,
1046 size_t stack_map_size,
1047 size_t number_of_roots,
1048 ArtMethod* method,
1049 uint8_t** stack_map_data,
1050 uint8_t** roots_data) {
Nicolas Geoffray132d8362016-11-16 09:19:42 +00001051 size_t table_size = ComputeRootTableSize(number_of_roots);
David Srbecky8cd54542018-07-15 23:58:44 +01001052 size_t size = RoundUp(stack_map_size + table_size, sizeof(void*));
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001053 uint8_t* result = nullptr;
1054
1055 {
1056 ScopedThreadSuspension sts(self, kSuspended);
1057 MutexLock mu(self, lock_);
1058 WaitForPotentialCollectionToComplete(self);
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001059 result = AllocateData(size);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001060 }
1061
1062 if (result == nullptr) {
1063 // Retry.
1064 GarbageCollectCache(self);
1065 ScopedThreadSuspension sts(self, kSuspended);
1066 MutexLock mu(self, lock_);
1067 WaitForPotentialCollectionToComplete(self);
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001068 result = AllocateData(size);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001069 }
1070
Nicolas Geoffray933330a2016-03-16 14:20:06 +00001071 MutexLock mu(self, lock_);
1072 histogram_stack_map_memory_use_.AddValue(size);
1073 if (size > kStackMapSizeLogThreshold) {
1074 LOG(INFO) << "JIT allocated "
1075 << PrettySize(size)
1076 << " for stack maps of "
David Sehr709b0702016-10-13 09:12:37 -07001077 << ArtMethod::PrettyMethod(method);
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001078 }
Nicolas Geoffrayf4b94422016-12-05 00:10:09 +00001079 if (result != nullptr) {
1080 *roots_data = result;
1081 *stack_map_data = result + table_size;
1082 FillRootTableLength(*roots_data, number_of_roots);
Nicolas Geoffrayed015ac2016-12-15 17:58:48 +00001083 return size;
Nicolas Geoffrayf4b94422016-12-05 00:10:09 +00001084 } else {
1085 *roots_data = nullptr;
1086 *stack_map_data = nullptr;
Nicolas Geoffrayed015ac2016-12-15 17:58:48 +00001087 return 0;
Nicolas Geoffrayf4b94422016-12-05 00:10:09 +00001088 }
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001089}
1090
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001091class MarkCodeVisitor FINAL : public StackVisitor {
1092 public:
1093 MarkCodeVisitor(Thread* thread_in, JitCodeCache* code_cache_in)
1094 : StackVisitor(thread_in, nullptr, StackVisitor::StackWalkKind::kSkipInlinedFrames),
1095 code_cache_(code_cache_in),
1096 bitmap_(code_cache_->GetLiveBitmap()) {}
1097
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001098 bool VisitFrame() OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001099 const OatQuickMethodHeader* method_header = GetCurrentOatQuickMethodHeader();
1100 if (method_header == nullptr) {
1101 return true;
1102 }
1103 const void* code = method_header->GetCode();
1104 if (code_cache_->ContainsPc(code)) {
1105 // Use the atomic set version, as multiple threads are executing this code.
1106 bitmap_->AtomicTestAndSet(FromCodeToAllocation(code));
1107 }
1108 return true;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001109 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001110
1111 private:
1112 JitCodeCache* const code_cache_;
1113 CodeCacheBitmap* const bitmap_;
1114};
1115
1116class MarkCodeClosure FINAL : public Closure {
1117 public:
1118 MarkCodeClosure(JitCodeCache* code_cache, Barrier* barrier)
1119 : code_cache_(code_cache), barrier_(barrier) {}
1120
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001121 void Run(Thread* thread) OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001122 ScopedTrace trace(__PRETTY_FUNCTION__);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001123 DCHECK(thread == Thread::Current() || thread->IsSuspended());
1124 MarkCodeVisitor visitor(thread, code_cache_);
1125 visitor.WalkStack();
Nicolas Geoffray5a23d2e2015-11-03 18:58:57 +00001126 if (kIsDebugBuild) {
1127 // The stack walking code queries the side instrumentation stack if it
1128 // sees an instrumentation exit pc, so the JIT code of methods in that stack
1129 // must have been seen. We sanity check this below.
1130 for (const instrumentation::InstrumentationStackFrame& frame
1131 : *thread->GetInstrumentationStack()) {
1132 // The 'method_' in InstrumentationStackFrame is the one that has return_pc_ in
1133 // its stack frame, it is not the method owning return_pc_. We just pass null to
1134 // LookupMethodHeader: the method is only checked against in debug builds.
1135 OatQuickMethodHeader* method_header =
Vladimir Marko2196c652017-11-30 16:16:07 +00001136 code_cache_->LookupMethodHeader(frame.return_pc_, /* method */ nullptr);
Nicolas Geoffray5a23d2e2015-11-03 18:58:57 +00001137 if (method_header != nullptr) {
1138 const void* code = method_header->GetCode();
1139 CHECK(code_cache_->GetLiveBitmap()->Test(FromCodeToAllocation(code)));
1140 }
1141 }
1142 }
Mathieu Chartier10d25082015-10-28 18:36:09 -07001143 barrier_->Pass(Thread::Current());
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001144 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001145
1146 private:
1147 JitCodeCache* const code_cache_;
1148 Barrier* const barrier_;
1149};
1150
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001151void JitCodeCache::NotifyCollectionDone(Thread* self) {
1152 collection_in_progress_ = false;
1153 lock_cond_.Broadcast(self);
1154}
1155
1156void JitCodeCache::SetFootprintLimit(size_t new_footprint) {
1157 size_t per_space_footprint = new_footprint / 2;
Orion Hodsondbd05fe2017-08-10 11:41:35 +01001158 DCHECK(IsAlignedParam(per_space_footprint, kPageSize));
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001159 DCHECK_EQ(per_space_footprint * 2, new_footprint);
1160 mspace_set_footprint_limit(data_mspace_, per_space_footprint);
1161 {
Calin Juravle016fcbe22018-05-03 19:47:35 -07001162 ScopedCodeCacheWrite scc(this);
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001163 mspace_set_footprint_limit(code_mspace_, per_space_footprint);
1164 }
1165}
1166
1167bool JitCodeCache::IncreaseCodeCacheCapacity() {
1168 if (current_capacity_ == max_capacity_) {
1169 return false;
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001170 }
1171
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001172 // Double the capacity if we're below 1MB, or increase it by 1MB if
1173 // we're above.
1174 if (current_capacity_ < 1 * MB) {
1175 current_capacity_ *= 2;
1176 } else {
1177 current_capacity_ += 1 * MB;
1178 }
1179 if (current_capacity_ > max_capacity_) {
1180 current_capacity_ = max_capacity_;
1181 }
1182
Nicolas Geoffray646d6382017-08-09 10:50:00 +01001183 VLOG(jit) << "Increasing code cache capacity to " << PrettySize(current_capacity_);
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001184
1185 SetFootprintLimit(current_capacity_);
1186
1187 return true;
1188}
1189
Nicolas Geoffray8d372502016-02-23 13:56:43 +00001190void JitCodeCache::MarkCompiledCodeOnThreadStacks(Thread* self) {
1191 Barrier barrier(0);
1192 size_t threads_running_checkpoint = 0;
1193 MarkCodeClosure closure(this, &barrier);
1194 threads_running_checkpoint = Runtime::Current()->GetThreadList()->RunCheckpoint(&closure);
1195 // Now that we have run our checkpoint, move to a suspended state and wait
1196 // for other threads to run the checkpoint.
1197 ScopedThreadSuspension sts(self, kSuspended);
1198 if (threads_running_checkpoint != 0) {
1199 barrier.Increment(self, threads_running_checkpoint);
1200 }
1201}
1202
Nicolas Geoffray35122442016-03-02 12:05:30 +00001203bool JitCodeCache::ShouldDoFullCollection() {
1204 if (current_capacity_ == max_capacity_) {
1205 // Always do a full collection when the code cache is full.
1206 return true;
1207 } else if (current_capacity_ < kReservedCapacity) {
1208 // Always do partial collection when the code cache size is below the reserved
1209 // capacity.
1210 return false;
1211 } else if (last_collection_increased_code_cache_) {
1212 // This time do a full collection.
1213 return true;
1214 } else {
1215 // This time do a partial collection.
1216 return false;
Nicolas Geoffray8d372502016-02-23 13:56:43 +00001217 }
1218}
1219
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001220void JitCodeCache::GarbageCollectCache(Thread* self) {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001221 ScopedTrace trace(__FUNCTION__);
Nicolas Geoffray8d372502016-02-23 13:56:43 +00001222 if (!garbage_collect_code_) {
1223 MutexLock mu(self, lock_);
1224 IncreaseCodeCacheCapacity();
1225 return;
1226 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001227
Nicolas Geoffraya5891e82015-11-06 14:18:27 +00001228 // Wait for an existing collection, or let everyone know we are starting one.
1229 {
1230 ScopedThreadSuspension sts(self, kSuspended);
1231 MutexLock mu(self, lock_);
1232 if (WaitForPotentialCollectionToComplete(self)) {
1233 return;
1234 } else {
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001235 number_of_collections_++;
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001236 live_bitmap_.reset(CodeCacheBitmap::Create(
1237 "code-cache-bitmap",
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001238 reinterpret_cast<uintptr_t>(code_map_.Begin()),
1239 reinterpret_cast<uintptr_t>(code_map_.Begin() + current_capacity_ / 2)));
Nicolas Geoffray8d372502016-02-23 13:56:43 +00001240 collection_in_progress_ = true;
1241 }
1242 }
1243
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001244 TimingLogger logger("JIT code cache timing logger", true, VLOG_IS_ON(jit));
Nicolas Geoffray8d372502016-02-23 13:56:43 +00001245 {
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001246 TimingLogger::ScopedTiming st("Code cache collection", &logger);
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001247
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001248 bool do_full_collection = false;
1249 {
1250 MutexLock mu(self, lock_);
1251 do_full_collection = ShouldDoFullCollection();
Nicolas Geoffraya96917a2016-03-01 22:18:02 +00001252 }
1253
Nicolas Geoffray646d6382017-08-09 10:50:00 +01001254 VLOG(jit) << "Do "
1255 << (do_full_collection ? "full" : "partial")
1256 << " code cache collection, code="
1257 << PrettySize(CodeCacheSize())
1258 << ", data=" << PrettySize(DataCacheSize());
Nicolas Geoffray35122442016-03-02 12:05:30 +00001259
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001260 DoCollection(self, /* collect_profiling_info */ do_full_collection);
1261
Nicolas Geoffray646d6382017-08-09 10:50:00 +01001262 VLOG(jit) << "After code cache collection, code="
1263 << PrettySize(CodeCacheSize())
1264 << ", data=" << PrettySize(DataCacheSize());
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001265
1266 {
1267 MutexLock mu(self, lock_);
1268
1269 // Increase the code cache only when we do partial collections.
1270 // TODO: base this strategy on how full the code cache is?
1271 if (do_full_collection) {
1272 last_collection_increased_code_cache_ = false;
1273 } else {
1274 last_collection_increased_code_cache_ = true;
1275 IncreaseCodeCacheCapacity();
Nicolas Geoffray35122442016-03-02 12:05:30 +00001276 }
1277
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001278 bool next_collection_will_be_full = ShouldDoFullCollection();
1279
1280 // Start polling the liveness of compiled code to prepare for the next full collection.
Nicolas Geoffray480d5102016-04-18 12:09:30 +01001281 if (next_collection_will_be_full) {
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001282 // Save the entry point of methods we have compiled, and update the entry
1283 // point of those methods to the interpreter. If the method is invoked, the
1284 // interpreter will update its entry point to the compiled code and call it.
1285 for (ProfilingInfo* info : profiling_infos_) {
1286 const void* entry_point = info->GetMethod()->GetEntryPointFromQuickCompiledCode();
1287 if (ContainsPc(entry_point)) {
1288 info->SetSavedEntryPoint(entry_point);
Vladimir Marko2196c652017-11-30 16:16:07 +00001289 // Don't call Instrumentation::UpdateMethodsCode(), as it can check the declaring
Nicolas Geoffray3b1a7f42017-02-22 10:21:00 +00001290 // class of the method. We may be concurrently running a GC which makes accessing
1291 // the class unsafe. We know it is OK to bypass the instrumentation as we've just
1292 // checked that the current entry point is JIT compiled code.
1293 info->GetMethod()->SetEntryPointFromQuickCompiledCode(GetQuickToInterpreterBridge());
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001294 }
1295 }
1296
1297 DCHECK(CheckLiveCompiledCodeHasProfilingInfo());
Vladimir Marko2196c652017-11-30 16:16:07 +00001298
1299 // Change entry points of native methods back to the GenericJNI entrypoint.
1300 for (const auto& entry : jni_stubs_map_) {
1301 const JniStubData& data = entry.second;
1302 if (!data.IsCompiled()) {
1303 continue;
1304 }
1305 // Make sure a single invocation of the GenericJNI trampoline tries to recompile.
1306 uint16_t new_counter = Runtime::Current()->GetJit()->HotMethodThreshold() - 1u;
1307 const OatQuickMethodHeader* method_header =
1308 OatQuickMethodHeader::FromCodePointer(data.GetCode());
1309 for (ArtMethod* method : data.GetMethods()) {
1310 if (method->GetEntryPointFromQuickCompiledCode() == method_header->GetEntryPoint()) {
1311 // Don't call Instrumentation::UpdateMethodsCode(), same as for normal methods above.
1312 method->SetCounter(new_counter);
1313 method->SetEntryPointFromQuickCompiledCode(GetQuickGenericJniStub());
1314 }
1315 }
1316 }
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001317 }
1318 live_bitmap_.reset(nullptr);
1319 NotifyCollectionDone(self);
Nicolas Geoffray35122442016-03-02 12:05:30 +00001320 }
Nicolas Geoffray35122442016-03-02 12:05:30 +00001321 }
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001322 Runtime::Current()->GetJit()->AddTimingLogger(logger);
Nicolas Geoffray35122442016-03-02 12:05:30 +00001323}
1324
Nicolas Geoffray9abb2972016-03-04 14:32:59 +00001325void JitCodeCache::RemoveUnmarkedCode(Thread* self) {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001326 ScopedTrace trace(__FUNCTION__);
Mingyao Yang063fc772016-08-02 11:02:54 -07001327 std::unordered_set<OatQuickMethodHeader*> method_headers;
1328 {
1329 MutexLock mu(self, lock_);
Calin Juravle016fcbe22018-05-03 19:47:35 -07001330 ScopedCodeCacheWrite scc(this);
Mingyao Yang063fc772016-08-02 11:02:54 -07001331 // Iterate over all compiled code and remove entries that are not marked.
Vladimir Marko2196c652017-11-30 16:16:07 +00001332 for (auto it = jni_stubs_map_.begin(); it != jni_stubs_map_.end();) {
1333 JniStubData* data = &it->second;
1334 if (!data->IsCompiled() || GetLiveBitmap()->Test(FromCodeToAllocation(data->GetCode()))) {
1335 ++it;
1336 } else {
1337 method_headers.insert(OatQuickMethodHeader::FromCodePointer(data->GetCode()));
1338 it = jni_stubs_map_.erase(it);
1339 }
1340 }
Mingyao Yang063fc772016-08-02 11:02:54 -07001341 for (auto it = method_code_map_.begin(); it != method_code_map_.end();) {
1342 const void* code_ptr = it->first;
1343 uintptr_t allocation = FromCodeToAllocation(code_ptr);
1344 if (GetLiveBitmap()->Test(allocation)) {
1345 ++it;
1346 } else {
Alex Light2d441b12018-06-08 15:33:21 -07001347 OatQuickMethodHeader* header = OatQuickMethodHeader::FromCodePointer(code_ptr);
1348 method_headers.insert(header);
Mingyao Yang063fc772016-08-02 11:02:54 -07001349 it = method_code_map_.erase(it);
1350 }
Nicolas Geoffray35122442016-03-02 12:05:30 +00001351 }
1352 }
Mingyao Yang063fc772016-08-02 11:02:54 -07001353 FreeAllMethodHeaders(method_headers);
Nicolas Geoffray35122442016-03-02 12:05:30 +00001354}
1355
1356void JitCodeCache::DoCollection(Thread* self, bool collect_profiling_info) {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001357 ScopedTrace trace(__FUNCTION__);
Nicolas Geoffray35122442016-03-02 12:05:30 +00001358 {
1359 MutexLock mu(self, lock_);
1360 if (collect_profiling_info) {
1361 // Clear the profiling info of methods that do not have compiled code as entrypoint.
1362 // Also remove the saved entry point from the ProfilingInfo objects.
1363 for (ProfilingInfo* info : profiling_infos_) {
1364 const void* ptr = info->GetMethod()->GetEntryPointFromQuickCompiledCode();
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001365 if (!ContainsPc(ptr) && !info->IsInUseByCompiler()) {
Nicolas Geoffray35122442016-03-02 12:05:30 +00001366 info->GetMethod()->SetProfilingInfo(nullptr);
1367 }
Nicolas Geoffrayb9a639d2016-03-22 11:25:20 +00001368
1369 if (info->GetSavedEntryPoint() != nullptr) {
1370 info->SetSavedEntryPoint(nullptr);
1371 // We are going to move this method back to interpreter. Clear the counter now to
Mathieu Chartierf044c222017-05-31 15:27:54 -07001372 // give it a chance to be hot again.
1373 ClearMethodCounter(info->GetMethod(), /*was_warm*/ true);
Nicolas Geoffrayb9a639d2016-03-22 11:25:20 +00001374 }
Nicolas Geoffray35122442016-03-02 12:05:30 +00001375 }
1376 } else if (kIsDebugBuild) {
1377 // Sanity check that the profiling infos do not have a dangling entry point.
1378 for (ProfilingInfo* info : profiling_infos_) {
1379 DCHECK(info->GetSavedEntryPoint() == nullptr);
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001380 }
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001381 }
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00001382
Nicolas Geoffray9abb2972016-03-04 14:32:59 +00001383 // Mark compiled code that are entrypoints of ArtMethods. Compiled code that is not
1384 // an entry point is either:
1385 // - an osr compiled code, that will be removed if not in a thread call stack.
1386 // - discarded compiled code, that will be removed if not in a thread call stack.
Vladimir Marko2196c652017-11-30 16:16:07 +00001387 for (const auto& entry : jni_stubs_map_) {
1388 const JniStubData& data = entry.second;
1389 const void* code_ptr = data.GetCode();
1390 const OatQuickMethodHeader* method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
1391 for (ArtMethod* method : data.GetMethods()) {
1392 if (method_header->GetEntryPoint() == method->GetEntryPointFromQuickCompiledCode()) {
1393 GetLiveBitmap()->AtomicTestAndSet(FromCodeToAllocation(code_ptr));
1394 break;
1395 }
1396 }
1397 }
Nicolas Geoffray9abb2972016-03-04 14:32:59 +00001398 for (const auto& it : method_code_map_) {
1399 ArtMethod* method = it.second;
1400 const void* code_ptr = it.first;
1401 const OatQuickMethodHeader* method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
1402 if (method_header->GetEntryPoint() == method->GetEntryPointFromQuickCompiledCode()) {
1403 GetLiveBitmap()->AtomicTestAndSet(FromCodeToAllocation(code_ptr));
1404 }
1405 }
1406
Nicolas Geoffrayd9994f02016-02-11 17:35:55 +00001407 // Empty osr method map, as osr compiled code will be deleted (except the ones
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00001408 // on thread stacks).
1409 osr_code_map_.clear();
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001410 }
1411
1412 // Run a checkpoint on all threads to mark the JIT compiled code they are running.
Nicolas Geoffray8d372502016-02-23 13:56:43 +00001413 MarkCompiledCodeOnThreadStacks(self);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001414
Nicolas Geoffray9abb2972016-03-04 14:32:59 +00001415 // At this point, mutator threads are still running, and entrypoints of methods can
1416 // change. We do know they cannot change to a code cache entry that is not marked,
1417 // therefore we can safely remove those entries.
1418 RemoveUnmarkedCode(self);
Nicolas Geoffraya96917a2016-03-01 22:18:02 +00001419
Nicolas Geoffray35122442016-03-02 12:05:30 +00001420 if (collect_profiling_info) {
1421 MutexLock mu(self, lock_);
1422 // Free all profiling infos of methods not compiled nor being compiled.
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001423 auto profiling_kept_end = std::remove_if(profiling_infos_.begin(), profiling_infos_.end(),
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001424 [this] (ProfilingInfo* info) NO_THREAD_SAFETY_ANALYSIS {
Nicolas Geoffray35122442016-03-02 12:05:30 +00001425 const void* ptr = info->GetMethod()->GetEntryPointFromQuickCompiledCode();
Nicolas Geoffray511e41b2016-03-02 17:09:35 +00001426 // We have previously cleared the ProfilingInfo pointer in the ArtMethod in the hope
1427 // that the compiled code would not get revived. As mutator threads run concurrently,
1428 // they may have revived the compiled code, and now we are in the situation where
1429 // a method has compiled code but no ProfilingInfo.
1430 // We make sure compiled methods have a ProfilingInfo object. It is needed for
1431 // code cache collection.
Andreas Gampe542451c2016-07-26 09:02:02 -07001432 if (ContainsPc(ptr) &&
1433 info->GetMethod()->GetProfilingInfo(kRuntimePointerSize) == nullptr) {
Nicolas Geoffray35122442016-03-02 12:05:30 +00001434 info->GetMethod()->SetProfilingInfo(info);
Andreas Gampe542451c2016-07-26 09:02:02 -07001435 } else if (info->GetMethod()->GetProfilingInfo(kRuntimePointerSize) != info) {
Nicolas Geoffray35122442016-03-02 12:05:30 +00001436 // No need for this ProfilingInfo object anymore.
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001437 FreeData(reinterpret_cast<uint8_t*>(info));
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001438 return true;
1439 }
1440 return false;
1441 });
1442 profiling_infos_.erase(profiling_kept_end, profiling_infos_.end());
Nicolas Geoffray35122442016-03-02 12:05:30 +00001443 DCHECK(CheckLiveCompiledCodeHasProfilingInfo());
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001444 }
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001445}
1446
Nicolas Geoffray35122442016-03-02 12:05:30 +00001447bool JitCodeCache::CheckLiveCompiledCodeHasProfilingInfo() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001448 ScopedTrace trace(__FUNCTION__);
Nicolas Geoffray35122442016-03-02 12:05:30 +00001449 // Check that methods we have compiled do have a ProfilingInfo object. We would
1450 // have memory leaks of compiled code otherwise.
1451 for (const auto& it : method_code_map_) {
1452 ArtMethod* method = it.second;
Andreas Gampe542451c2016-07-26 09:02:02 -07001453 if (method->GetProfilingInfo(kRuntimePointerSize) == nullptr) {
Nicolas Geoffray35122442016-03-02 12:05:30 +00001454 const void* code_ptr = it.first;
1455 const OatQuickMethodHeader* method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
1456 if (method_header->GetEntryPoint() == method->GetEntryPointFromQuickCompiledCode()) {
1457 // If the code is not dead, then we have a problem. Note that this can even
1458 // happen just after a collection, as mutator threads are running in parallel
1459 // and could deoptimize an existing compiled code.
1460 return false;
1461 }
1462 }
1463 }
1464 return true;
1465}
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001466
1467OatQuickMethodHeader* JitCodeCache::LookupMethodHeader(uintptr_t pc, ArtMethod* method) {
Vladimir Marko33bff252017-11-01 14:35:42 +00001468 static_assert(kRuntimeISA != InstructionSet::kThumb2, "kThumb2 cannot be a runtime ISA");
1469 if (kRuntimeISA == InstructionSet::kArm) {
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001470 // On Thumb-2, the pc is offset by one.
1471 --pc;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001472 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001473 if (!ContainsPc(reinterpret_cast<const void*>(pc))) {
1474 return nullptr;
1475 }
1476
Vladimir Marko2196c652017-11-30 16:16:07 +00001477 if (!kIsDebugBuild) {
1478 // Called with null `method` only from MarkCodeClosure::Run() in debug build.
1479 CHECK(method != nullptr);
Vladimir Marko47d31852017-11-28 18:36:12 +00001480 }
Vladimir Markoe7441632017-11-29 13:00:56 +00001481
Vladimir Marko2196c652017-11-30 16:16:07 +00001482 MutexLock mu(Thread::Current(), lock_);
1483 OatQuickMethodHeader* method_header = nullptr;
1484 ArtMethod* found_method = nullptr; // Only for DCHECK(), not for JNI stubs.
1485 if (method != nullptr && UNLIKELY(method->IsNative())) {
1486 auto it = jni_stubs_map_.find(JniStubKey(method));
1487 if (it == jni_stubs_map_.end() || !ContainsElement(it->second.GetMethods(), method)) {
1488 return nullptr;
1489 }
1490 const void* code_ptr = it->second.GetCode();
1491 method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
1492 if (!method_header->Contains(pc)) {
1493 return nullptr;
1494 }
1495 } else {
1496 auto it = method_code_map_.lower_bound(reinterpret_cast<const void*>(pc));
1497 if (it != method_code_map_.begin()) {
1498 --it;
1499 const void* code_ptr = it->first;
1500 if (OatQuickMethodHeader::FromCodePointer(code_ptr)->Contains(pc)) {
1501 method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
1502 found_method = it->second;
1503 }
1504 }
1505 if (method_header == nullptr && method == nullptr) {
1506 // Scan all compiled JNI stubs as well. This slow search is used only
1507 // for checks in debug build, for release builds the `method` is not null.
1508 for (auto&& entry : jni_stubs_map_) {
1509 const JniStubData& data = entry.second;
1510 if (data.IsCompiled() &&
1511 OatQuickMethodHeader::FromCodePointer(data.GetCode())->Contains(pc)) {
1512 method_header = OatQuickMethodHeader::FromCodePointer(data.GetCode());
1513 }
1514 }
1515 }
1516 if (method_header == nullptr) {
1517 return nullptr;
1518 }
Nicolas Geoffray056d7752017-11-30 09:12:13 +00001519 }
Vladimir Marko2196c652017-11-30 16:16:07 +00001520
1521 if (kIsDebugBuild && method != nullptr && !method->IsNative()) {
Alex Light1ebe4fe2017-01-30 14:57:11 -08001522 // When we are walking the stack to redefine classes and creating obsolete methods it is
1523 // possible that we might have updated the method_code_map by making this method obsolete in a
1524 // previous frame. Therefore we should just check that the non-obsolete version of this method
1525 // is the one we expect. We change to the non-obsolete versions in the error message since the
1526 // obsolete version of the method might not be fully initialized yet. This situation can only
1527 // occur when we are in the process of allocating and setting up obsolete methods. Otherwise
Andreas Gampe06c42a52017-07-26 14:17:14 -07001528 // method and it->second should be identical. (See openjdkjvmti/ti_redefine.cc for more
Alex Light1ebe4fe2017-01-30 14:57:11 -08001529 // information.)
Vladimir Marko2196c652017-11-30 16:16:07 +00001530 DCHECK_EQ(found_method->GetNonObsoleteMethod(), method->GetNonObsoleteMethod())
Alex Light1ebe4fe2017-01-30 14:57:11 -08001531 << ArtMethod::PrettyMethod(method->GetNonObsoleteMethod()) << " "
Vladimir Marko2196c652017-11-30 16:16:07 +00001532 << ArtMethod::PrettyMethod(found_method->GetNonObsoleteMethod()) << " "
David Sehr709b0702016-10-13 09:12:37 -07001533 << std::hex << pc;
Nicolas Geoffray5a23d2e2015-11-03 18:58:57 +00001534 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001535 return method_header;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001536}
1537
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00001538OatQuickMethodHeader* JitCodeCache::LookupOsrMethodHeader(ArtMethod* method) {
1539 MutexLock mu(Thread::Current(), lock_);
1540 auto it = osr_code_map_.find(method);
1541 if (it == osr_code_map_.end()) {
1542 return nullptr;
1543 }
1544 return OatQuickMethodHeader::FromCodePointer(it->second);
1545}
1546
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001547ProfilingInfo* JitCodeCache::AddProfilingInfo(Thread* self,
1548 ArtMethod* method,
1549 const std::vector<uint32_t>& entries,
Nicolas Geoffray1e7da9b2016-03-01 14:11:40 +00001550 bool retry_allocation)
1551 // No thread safety analysis as we are using TryLock/Unlock explicitly.
1552 NO_THREAD_SAFETY_ANALYSIS {
1553 ProfilingInfo* info = nullptr;
1554 if (!retry_allocation) {
1555 // If we are allocating for the interpreter, just try to lock, to avoid
1556 // lock contention with the JIT.
1557 if (lock_.ExclusiveTryLock(self)) {
1558 info = AddProfilingInfoInternal(self, method, entries);
1559 lock_.ExclusiveUnlock(self);
1560 }
1561 } else {
1562 {
1563 MutexLock mu(self, lock_);
1564 info = AddProfilingInfoInternal(self, method, entries);
1565 }
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001566
Nicolas Geoffray1e7da9b2016-03-01 14:11:40 +00001567 if (info == nullptr) {
1568 GarbageCollectCache(self);
1569 MutexLock mu(self, lock_);
1570 info = AddProfilingInfoInternal(self, method, entries);
1571 }
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001572 }
1573 return info;
1574}
1575
Nicolas Geoffray1e7da9b2016-03-01 14:11:40 +00001576ProfilingInfo* JitCodeCache::AddProfilingInfoInternal(Thread* self ATTRIBUTE_UNUSED,
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001577 ArtMethod* method,
1578 const std::vector<uint32_t>& entries) {
1579 size_t profile_info_size = RoundUp(
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001580 sizeof(ProfilingInfo) + sizeof(InlineCache) * entries.size(),
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001581 sizeof(void*));
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001582
1583 // Check whether some other thread has concurrently created it.
Andreas Gampe542451c2016-07-26 09:02:02 -07001584 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001585 if (info != nullptr) {
1586 return info;
1587 }
1588
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001589 uint8_t* data = AllocateData(profile_info_size);
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001590 if (data == nullptr) {
1591 return nullptr;
1592 }
1593 info = new (data) ProfilingInfo(method, entries);
Nicolas Geoffray07f35642016-01-04 16:06:51 +00001594
1595 // Make sure other threads see the data in the profiling info object before the
1596 // store in the ArtMethod's ProfilingInfo pointer.
Orion Hodson27b96762018-03-13 16:06:57 +00001597 std::atomic_thread_fence(std::memory_order_release);
Nicolas Geoffray07f35642016-01-04 16:06:51 +00001598
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001599 method->SetProfilingInfo(info);
1600 profiling_infos_.push_back(info);
Nicolas Geoffray933330a2016-03-16 14:20:06 +00001601 histogram_profiling_info_memory_use_.AddValue(profile_info_size);
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001602 return info;
1603}
1604
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001605// NO_THREAD_SAFETY_ANALYSIS as this is called from mspace code, at which point the lock
1606// is already held.
1607void* JitCodeCache::MoreCore(const void* mspace, intptr_t increment) NO_THREAD_SAFETY_ANALYSIS {
1608 if (code_mspace_ == mspace) {
1609 size_t result = code_end_;
1610 code_end_ += increment;
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001611 return reinterpret_cast<void*>(result + code_map_.Begin());
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001612 } else {
1613 DCHECK_EQ(data_mspace_, mspace);
1614 size_t result = data_end_;
1615 data_end_ += increment;
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001616 return reinterpret_cast<void*>(result + data_map_.Begin());
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001617 }
1618}
1619
Calin Juravle99629622016-04-19 16:33:46 +01001620void JitCodeCache::GetProfiledMethods(const std::set<std::string>& dex_base_locations,
Calin Juravle940eb0c2017-01-30 19:30:44 -08001621 std::vector<ProfileMethodInfo>& methods) {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001622 ScopedTrace trace(__FUNCTION__);
Calin Juravle31f2c152015-10-23 17:56:15 +01001623 MutexLock mu(Thread::Current(), lock_);
Calin Juravlea39fd982017-05-18 10:15:52 -07001624 uint16_t jit_compile_threshold = Runtime::Current()->GetJITOptions()->GetCompileThreshold();
Calin Juravle99629622016-04-19 16:33:46 +01001625 for (const ProfilingInfo* info : profiling_infos_) {
1626 ArtMethod* method = info->GetMethod();
1627 const DexFile* dex_file = method->GetDexFile();
Mathieu Chartier79c87da2017-10-10 11:54:29 -07001628 const std::string base_location = DexFileLoader::GetBaseLocation(dex_file->GetLocation());
1629 if (!ContainsElement(dex_base_locations, base_location)) {
Calin Juravle940eb0c2017-01-30 19:30:44 -08001630 // Skip dex files which are not profiled.
1631 continue;
Calin Juravle31f2c152015-10-23 17:56:15 +01001632 }
Calin Juravle940eb0c2017-01-30 19:30:44 -08001633 std::vector<ProfileMethodInfo::ProfileInlineCache> inline_caches;
Calin Juravlea39fd982017-05-18 10:15:52 -07001634
1635 // If the method didn't reach the compilation threshold don't save the inline caches.
1636 // They might be incomplete and cause unnecessary deoptimizations.
1637 // If the inline cache is empty the compiler will generate a regular invoke virtual/interface.
1638 if (method->GetCounter() < jit_compile_threshold) {
1639 methods.emplace_back(/*ProfileMethodInfo*/
Mathieu Chartierbbe3a5e2017-06-13 16:36:17 -07001640 MethodReference(dex_file, method->GetDexMethodIndex()), inline_caches);
Calin Juravlea39fd982017-05-18 10:15:52 -07001641 continue;
1642 }
1643
Calin Juravle940eb0c2017-01-30 19:30:44 -08001644 for (size_t i = 0; i < info->number_of_inline_caches_; ++i) {
Mathieu Chartierdbddc222017-05-24 12:04:13 -07001645 std::vector<TypeReference> profile_classes;
Calin Juravle940eb0c2017-01-30 19:30:44 -08001646 const InlineCache& cache = info->cache_[i];
Calin Juravle13439f02017-02-21 01:17:21 -08001647 ArtMethod* caller = info->GetMethod();
Calin Juravle589e71e2017-03-03 16:05:05 -08001648 bool is_missing_types = false;
Calin Juravle940eb0c2017-01-30 19:30:44 -08001649 for (size_t k = 0; k < InlineCache::kIndividualCacheSize; k++) {
1650 mirror::Class* cls = cache.classes_[k].Read();
1651 if (cls == nullptr) {
1652 break;
1653 }
Calin Juravle4ca70a32017-02-21 16:22:24 -08001654
Calin Juravle13439f02017-02-21 01:17:21 -08001655 // Check if the receiver is in the boot class path or if it's in the
1656 // same class loader as the caller. If not, skip it, as there is not
1657 // much we can do during AOT.
1658 if (!cls->IsBootStrapClassLoaded() &&
1659 caller->GetClassLoader() != cls->GetClassLoader()) {
1660 is_missing_types = true;
1661 continue;
1662 }
1663
Calin Juravle4ca70a32017-02-21 16:22:24 -08001664 const DexFile* class_dex_file = nullptr;
1665 dex::TypeIndex type_index;
1666
1667 if (cls->GetDexCache() == nullptr) {
1668 DCHECK(cls->IsArrayClass()) << cls->PrettyClass();
Calin Juravlee21806f2017-02-22 11:49:43 -08001669 // Make a best effort to find the type index in the method's dex file.
1670 // We could search all open dex files but that might turn expensive
1671 // and probably not worth it.
Calin Juravle4ca70a32017-02-21 16:22:24 -08001672 class_dex_file = dex_file;
1673 type_index = cls->FindTypeIndexInOtherDexFile(*dex_file);
1674 } else {
1675 class_dex_file = &(cls->GetDexFile());
1676 type_index = cls->GetDexTypeIndex();
1677 }
1678 if (!type_index.IsValid()) {
1679 // Could be a proxy class or an array for which we couldn't find the type index.
Calin Juravle589e71e2017-03-03 16:05:05 -08001680 is_missing_types = true;
Calin Juravle4ca70a32017-02-21 16:22:24 -08001681 continue;
1682 }
Mathieu Chartier79c87da2017-10-10 11:54:29 -07001683 if (ContainsElement(dex_base_locations,
1684 DexFileLoader::GetBaseLocation(class_dex_file->GetLocation()))) {
Calin Juravle940eb0c2017-01-30 19:30:44 -08001685 // Only consider classes from the same apk (including multidex).
1686 profile_classes.emplace_back(/*ProfileMethodInfo::ProfileClassReference*/
Calin Juravle4ca70a32017-02-21 16:22:24 -08001687 class_dex_file, type_index);
Calin Juravle589e71e2017-03-03 16:05:05 -08001688 } else {
1689 is_missing_types = true;
Calin Juravle940eb0c2017-01-30 19:30:44 -08001690 }
1691 }
1692 if (!profile_classes.empty()) {
1693 inline_caches.emplace_back(/*ProfileMethodInfo::ProfileInlineCache*/
Calin Juravle589e71e2017-03-03 16:05:05 -08001694 cache.dex_pc_, is_missing_types, profile_classes);
Calin Juravle940eb0c2017-01-30 19:30:44 -08001695 }
1696 }
1697 methods.emplace_back(/*ProfileMethodInfo*/
Mathieu Chartierbbe3a5e2017-06-13 16:36:17 -07001698 MethodReference(dex_file, method->GetDexMethodIndex()), inline_caches);
Calin Juravle31f2c152015-10-23 17:56:15 +01001699 }
1700}
1701
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +01001702bool JitCodeCache::IsOsrCompiled(ArtMethod* method) {
1703 MutexLock mu(Thread::Current(), lock_);
1704 return osr_code_map_.find(method) != osr_code_map_.end();
1705}
1706
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00001707bool JitCodeCache::NotifyCompilationOf(ArtMethod* method, Thread* self, bool osr) {
1708 if (!osr && ContainsPc(method->GetEntryPointFromQuickCompiledCode())) {
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001709 return false;
1710 }
Nicolas Geoffraya42363f2015-12-17 14:57:09 +00001711
Nicolas Geoffraya42363f2015-12-17 14:57:09 +00001712 MutexLock mu(self, lock_);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00001713 if (osr && (osr_code_map_.find(method) != osr_code_map_.end())) {
1714 return false;
1715 }
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001716
Vladimir Marko2196c652017-11-30 16:16:07 +00001717 if (UNLIKELY(method->IsNative())) {
1718 JniStubKey key(method);
1719 auto it = jni_stubs_map_.find(key);
1720 bool new_compilation = false;
1721 if (it == jni_stubs_map_.end()) {
1722 // Create a new entry to mark the stub as being compiled.
1723 it = jni_stubs_map_.Put(key, JniStubData{});
1724 new_compilation = true;
1725 }
1726 JniStubData* data = &it->second;
1727 data->AddMethod(method);
1728 if (data->IsCompiled()) {
1729 OatQuickMethodHeader* method_header = OatQuickMethodHeader::FromCodePointer(data->GetCode());
1730 const void* entrypoint = method_header->GetEntryPoint();
1731 // Update also entrypoints of other methods held by the JniStubData.
1732 // We could simply update the entrypoint of `method` but if the last JIT GC has
1733 // changed these entrypoints to GenericJNI in preparation for a full GC, we may
1734 // as well change them back as this stub shall not be collected anyway and this
1735 // can avoid a few expensive GenericJNI calls.
1736 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
1737 for (ArtMethod* m : data->GetMethods()) {
Nicolas Geoffraya6e0e7d2018-01-26 13:16:50 +00001738 // Call the dedicated method instead of the more generic UpdateMethodsCode, because
1739 // `m` might be in the process of being deleted.
1740 instrumentation->UpdateNativeMethodsCodeToJitCode(m, entrypoint);
Vladimir Marko2196c652017-11-30 16:16:07 +00001741 }
1742 if (collection_in_progress_) {
1743 GetLiveBitmap()->AtomicTestAndSet(FromCodeToAllocation(data->GetCode()));
1744 }
1745 }
1746 return new_compilation;
1747 } else {
1748 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
1749 if (info == nullptr) {
1750 VLOG(jit) << method->PrettyMethod() << " needs a ProfilingInfo to be compiled";
1751 // Because the counter is not atomic, there are some rare cases where we may not hit the
1752 // threshold for creating the ProfilingInfo. Reset the counter now to "correct" this.
1753 ClearMethodCounter(method, /*was_warm*/ false);
1754 return false;
1755 }
Nicolas Geoffray056d7752017-11-30 09:12:13 +00001756
Vladimir Marko2196c652017-11-30 16:16:07 +00001757 if (info->IsMethodBeingCompiled(osr)) {
1758 return false;
1759 }
Nicolas Geoffray056d7752017-11-30 09:12:13 +00001760
Vladimir Marko2196c652017-11-30 16:16:07 +00001761 info->SetIsMethodBeingCompiled(true, osr);
1762 return true;
1763 }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001764}
1765
Nicolas Geoffray07e3ca92016-03-11 09:57:57 +00001766ProfilingInfo* JitCodeCache::NotifyCompilerUse(ArtMethod* method, Thread* self) {
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001767 MutexLock mu(self, lock_);
Andreas Gampe542451c2016-07-26 09:02:02 -07001768 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001769 if (info != nullptr) {
Nicolas Geoffrayf6d46682017-02-28 17:41:45 +00001770 if (!info->IncrementInlineUse()) {
1771 // Overflow of inlining uses, just bail.
1772 return nullptr;
1773 }
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001774 }
Nicolas Geoffray07e3ca92016-03-11 09:57:57 +00001775 return info;
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001776}
1777
Nicolas Geoffray07e3ca92016-03-11 09:57:57 +00001778void JitCodeCache::DoneCompilerUse(ArtMethod* method, Thread* self) {
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001779 MutexLock mu(self, lock_);
Andreas Gampe542451c2016-07-26 09:02:02 -07001780 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
Nicolas Geoffray07e3ca92016-03-11 09:57:57 +00001781 DCHECK(info != nullptr);
1782 info->DecrementInlineUse();
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001783}
1784
Vladimir Marko2196c652017-11-30 16:16:07 +00001785void JitCodeCache::DoneCompiling(ArtMethod* method, Thread* self, bool osr) {
1786 DCHECK_EQ(Thread::Current(), self);
1787 MutexLock mu(self, lock_);
1788 if (UNLIKELY(method->IsNative())) {
1789 auto it = jni_stubs_map_.find(JniStubKey(method));
1790 DCHECK(it != jni_stubs_map_.end());
1791 JniStubData* data = &it->second;
1792 DCHECK(ContainsElement(data->GetMethods(), method));
1793 if (UNLIKELY(!data->IsCompiled())) {
1794 // Failed to compile; the JNI compiler never fails, but the cache may be full.
1795 jni_stubs_map_.erase(it); // Remove the entry added in NotifyCompilationOf().
1796 } // else CommitCodeInternal() updated entrypoints of all methods in the JniStubData.
1797 } else {
1798 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
1799 DCHECK(info->IsMethodBeingCompiled(osr));
1800 info->SetIsMethodBeingCompiled(false, osr);
1801 }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001802}
1803
Nicolas Geoffraya25dce92016-01-12 16:41:10 +00001804size_t JitCodeCache::GetMemorySizeOfCodePointer(const void* ptr) {
1805 MutexLock mu(Thread::Current(), lock_);
1806 return mspace_usable_size(reinterpret_cast<const void*>(FromCodeToAllocation(ptr)));
1807}
1808
Nicolas Geoffrayb88d59e2016-02-17 11:31:49 +00001809void JitCodeCache::InvalidateCompiledCodeFor(ArtMethod* method,
1810 const OatQuickMethodHeader* header) {
Vladimir Marko2196c652017-11-30 16:16:07 +00001811 DCHECK(!method->IsNative());
Andreas Gampe542451c2016-07-26 09:02:02 -07001812 ProfilingInfo* profiling_info = method->GetProfilingInfo(kRuntimePointerSize);
Alex Light2d441b12018-06-08 15:33:21 -07001813 const void* method_entrypoint = method->GetEntryPointFromQuickCompiledCode();
Nicolas Geoffray35122442016-03-02 12:05:30 +00001814 if ((profiling_info != nullptr) &&
1815 (profiling_info->GetSavedEntryPoint() == header->GetEntryPoint())) {
Alex Light2d441b12018-06-08 15:33:21 -07001816 // When instrumentation is set, the actual entrypoint is the one in the profiling info.
1817 method_entrypoint = profiling_info->GetSavedEntryPoint();
Nicolas Geoffray35122442016-03-02 12:05:30 +00001818 // Prevent future uses of the compiled code.
1819 profiling_info->SetSavedEntryPoint(nullptr);
1820 }
1821
Alex Light2d441b12018-06-08 15:33:21 -07001822 // Clear the method counter if we are running jitted code since we might want to jit this again in
1823 // the future.
1824 if (method_entrypoint == header->GetEntryPoint()) {
Jeff Hao00286db2017-05-30 16:53:07 -07001825 // The entrypoint is the one to invalidate, so we just update it to the interpreter entry point
Mathieu Chartierf044c222017-05-31 15:27:54 -07001826 // and clear the counter to get the method Jitted again.
Nicolas Geoffrayb88d59e2016-02-17 11:31:49 +00001827 Runtime::Current()->GetInstrumentation()->UpdateMethodsCode(
1828 method, GetQuickToInterpreterBridge());
Mathieu Chartierf044c222017-05-31 15:27:54 -07001829 ClearMethodCounter(method, /*was_warm*/ profiling_info != nullptr);
Nicolas Geoffrayb88d59e2016-02-17 11:31:49 +00001830 } else {
1831 MutexLock mu(Thread::Current(), lock_);
1832 auto it = osr_code_map_.find(method);
1833 if (it != osr_code_map_.end() && OatQuickMethodHeader::FromCodePointer(it->second) == header) {
1834 // Remove the OSR method, to avoid using it again.
1835 osr_code_map_.erase(it);
1836 }
1837 }
1838}
1839
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001840uint8_t* JitCodeCache::AllocateCode(size_t code_size) {
1841 size_t alignment = GetInstructionSetAlignment(kRuntimeISA);
1842 uint8_t* result = reinterpret_cast<uint8_t*>(
1843 mspace_memalign(code_mspace_, alignment, code_size));
1844 size_t header_size = RoundUp(sizeof(OatQuickMethodHeader), alignment);
1845 // Ensure the header ends up at expected instruction alignment.
1846 DCHECK_ALIGNED_PARAM(reinterpret_cast<uintptr_t>(result + header_size), alignment);
1847 used_memory_for_code_ += mspace_usable_size(result);
1848 return result;
1849}
1850
Orion Hodsondbd05fe2017-08-10 11:41:35 +01001851void JitCodeCache::FreeCode(uint8_t* code) {
1852 used_memory_for_code_ -= mspace_usable_size(code);
1853 mspace_free(code_mspace_, code);
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001854}
1855
1856uint8_t* JitCodeCache::AllocateData(size_t data_size) {
1857 void* result = mspace_malloc(data_mspace_, data_size);
1858 used_memory_for_data_ += mspace_usable_size(result);
1859 return reinterpret_cast<uint8_t*>(result);
1860}
1861
1862void JitCodeCache::FreeData(uint8_t* data) {
1863 used_memory_for_data_ -= mspace_usable_size(data);
1864 mspace_free(data_mspace_, data);
1865}
1866
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001867void JitCodeCache::Dump(std::ostream& os) {
1868 MutexLock mu(Thread::Current(), lock_);
David Srbeckyfb3de3d2018-01-29 16:11:49 +00001869 MutexLock mu2(Thread::Current(), *Locks::native_debug_interface_lock_);
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001870 os << "Current JIT code cache size: " << PrettySize(used_memory_for_code_) << "\n"
1871 << "Current JIT data cache size: " << PrettySize(used_memory_for_data_) << "\n"
David Srbecky440a9b32018-02-15 17:47:29 +00001872 << "Current JIT mini-debug-info size: " << PrettySize(GetJitNativeDebugInfoMemUsage()) << "\n"
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001873 << "Current JIT capacity: " << PrettySize(current_capacity_) << "\n"
Vladimir Marko2196c652017-11-30 16:16:07 +00001874 << "Current number of JIT JNI stub entries: " << jni_stubs_map_.size() << "\n"
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001875 << "Current number of JIT code cache entries: " << method_code_map_.size() << "\n"
1876 << "Total number of JIT compilations: " << number_of_compilations_ << "\n"
1877 << "Total number of JIT compilations for on stack replacement: "
1878 << number_of_osr_compilations_ << "\n"
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001879 << "Total number of JIT code cache collections: " << number_of_collections_ << std::endl;
Nicolas Geoffray933330a2016-03-16 14:20:06 +00001880 histogram_stack_map_memory_use_.PrintMemoryUse(os);
1881 histogram_code_memory_use_.PrintMemoryUse(os);
1882 histogram_profiling_info_memory_use_.PrintMemoryUse(os);
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001883}
1884
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001885} // namespace jit
1886} // namespace art