blob: b743b403306fe8449a0d1f54d7ad3c53b36d5798 [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
Nicolas Geoffraya25dce92016-01-12 16:41:10 +0000171 // With 'perf', we want a 1-1 mapping between an address and a method.
Alex Light2d441b12018-06-08 15:33:21 -0700172 // We aren't able to keep method pointers live during the instrumentation method entry trampoline
173 // so we will just disable jit-gc if we are doing that.
174 bool garbage_collect_code = !generate_debug_info &&
175 !Runtime::Current()->GetInstrumentation()->AreExitStubsInstalled();
Nicolas Geoffraya25dce92016-01-12 16:41:10 +0000176
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000177 // We need to have 32 bit offsets from method headers in code cache which point to things
178 // in the data cache. If the maps are more than 4G apart, having multiple maps wouldn't work.
179 // Ensure we're below 1 GB to be safe.
180 if (max_capacity > 1 * GB) {
181 std::ostringstream oss;
182 oss << "Maxium code cache capacity is limited to 1 GB, "
183 << PrettySize(max_capacity) << " is too big";
184 *error_msg = oss.str();
185 return nullptr;
186 }
187
Calin Juravle016fcbe22018-05-03 19:47:35 -0700188 // Decide how we should map the code and data sections.
189 // If we use the code cache just for profiling we do not need to map the code section as
190 // executable.
191 // NOTE 1: this is yet another workaround to bypass strict SElinux policies in order to be able
192 // to profile system server.
193 // NOTE 2: We could just not create the code section at all but we will need to
194 // special case too many cases.
195 int memmap_flags_prot_code = used_only_for_profile_data ? (kProtCode & ~PROT_EXEC) : kProtCode;
196
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800197 std::string error_str;
198 // Map name specific for android_os_Debug.cpp accounting.
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000199 // Map in low 4gb to simplify accessing root tables for x86_64.
200 // We could do PC-relative addressing to avoid this problem, but that
201 // would require reserving code and data area before submitting, which
202 // means more windows for the code memory to be RWX.
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100203 MemMap data_map = MemMap::MapAnonymous(
204 "data-code-cache",
205 /* addr */ nullptr,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000206 max_capacity,
Andreas Gampee4deaf32017-06-09 15:27:15 -0700207 kProtData,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000208 /* low_4gb */ true,
209 /* reuse */ false,
Joel Fernandes (Google)92597a82018-08-17 16:19:19 -0700210 &error_str);
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100211 if (!data_map.IsValid()) {
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800212 std::ostringstream oss;
Andreas Gampee4deaf32017-06-09 15:27:15 -0700213 oss << "Failed to create read write cache: " << error_str << " size=" << max_capacity;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800214 *error_msg = oss.str();
215 return nullptr;
216 }
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100217
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100218 // Align both capacities to page size, as that's the unit mspaces use.
219 initial_capacity = RoundDown(initial_capacity, 2 * kPageSize);
220 max_capacity = RoundDown(max_capacity, 2 * kPageSize);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100221
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100222 // Data cache is 1 / 2 of the map.
223 // TODO: Make this variable?
224 size_t data_size = max_capacity / 2;
225 size_t code_size = max_capacity - data_size;
226 DCHECK_EQ(code_size + data_size, max_capacity);
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100227 uint8_t* divider = data_map.Begin() + data_size;
David Sehrd1dbb742017-07-17 11:20:38 -0700228
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100229 MemMap code_map = data_map.RemapAtEnd(
Joel Fernandes (Google)92597a82018-08-17 16:19:19 -0700230 divider, "jit-code-cache", memmap_flags_prot_code | PROT_WRITE, &error_str);
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100231 if (!code_map.IsValid()) {
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100232 std::ostringstream oss;
233 oss << "Failed to create read write execute cache: " << error_str << " size=" << max_capacity;
234 *error_msg = oss.str();
David Sehrd1dbb742017-07-17 11:20:38 -0700235 return nullptr;
236 }
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100237 DCHECK_EQ(code_map.Begin(), divider);
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000238 data_size = initial_capacity / 2;
239 code_size = initial_capacity - data_size;
240 DCHECK_EQ(code_size + data_size, initial_capacity);
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100241 return new JitCodeCache(
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100242 std::move(code_map),
243 std::move(data_map),
Calin Juravle016fcbe22018-05-03 19:47:35 -0700244 code_size,
245 data_size,
246 max_capacity,
247 garbage_collect_code,
248 memmap_flags_prot_code);
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800249}
250
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100251JitCodeCache::JitCodeCache(MemMap&& code_map,
252 MemMap&& data_map,
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000253 size_t initial_code_capacity,
254 size_t initial_data_capacity,
Nicolas Geoffraya25dce92016-01-12 16:41:10 +0000255 size_t max_capacity,
Calin Juravle016fcbe22018-05-03 19:47:35 -0700256 bool garbage_collect_code,
257 int memmap_flags_prot_code)
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100258 : lock_("Jit code cache", kJitCodeCacheLock),
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000259 lock_cond_("Jit code cache condition variable", lock_),
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100260 collection_in_progress_(false),
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100261 code_map_(std::move(code_map)),
262 data_map_(std::move(data_map)),
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000263 max_capacity_(max_capacity),
264 current_capacity_(initial_code_capacity + initial_data_capacity),
265 code_end_(initial_code_capacity),
266 data_end_(initial_data_capacity),
Nicolas Geoffray35122442016-03-02 12:05:30 +0000267 last_collection_increased_code_cache_(false),
Nicolas Geoffray0a522232016-01-19 09:34:58 +0000268 garbage_collect_code_(garbage_collect_code),
Nicolas Geoffrayb0d22082016-02-24 17:18:25 +0000269 used_memory_for_data_(0),
270 used_memory_for_code_(0),
Nicolas Geoffrayfcdd7292016-02-25 13:27:47 +0000271 number_of_compilations_(0),
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +0000272 number_of_osr_compilations_(0),
Nicolas Geoffray933330a2016-03-16 14:20:06 +0000273 number_of_collections_(0),
274 histogram_stack_map_memory_use_("Memory used for stack maps", 16),
275 histogram_code_memory_use_("Memory used for compiled code", 16),
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000276 histogram_profiling_info_memory_use_("Memory used for profiling info", 16),
277 is_weak_access_enabled_(true),
Calin Juravle016fcbe22018-05-03 19:47:35 -0700278 inline_cache_cond_("Jit inline cache condition variable", lock_),
279 memmap_flags_prot_code_(memmap_flags_prot_code) {
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100280
Nicolas Geoffrayc3fec4c2016-01-14 16:16:35 +0000281 DCHECK_GE(max_capacity, initial_code_capacity + initial_data_capacity);
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100282 code_mspace_ = create_mspace_with_base(code_map_.Begin(), code_end_, false /*locked*/);
283 data_mspace_ = create_mspace_with_base(data_map_.Begin(), data_end_, false /*locked*/);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100284
285 if (code_mspace_ == nullptr || data_mspace_ == nullptr) {
286 PLOG(FATAL) << "create_mspace_with_base failed";
287 }
288
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000289 SetFootprintLimit(current_capacity_);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100290
Mathieu Chartier8d8de0c2017-10-04 09:35:30 -0700291 CheckedCall(mprotect,
292 "mprotect jit code cache",
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100293 code_map_.Begin(),
294 code_map_.Size(),
Calin Juravle016fcbe22018-05-03 19:47:35 -0700295 memmap_flags_prot_code_);
Mathieu Chartier8d8de0c2017-10-04 09:35:30 -0700296 CheckedCall(mprotect,
297 "mprotect jit data cache",
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100298 data_map_.Begin(),
299 data_map_.Size(),
Mathieu Chartier8d8de0c2017-10-04 09:35:30 -0700300 kProtData);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100301
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000302 VLOG(jit) << "Created jit code cache: initial data size="
303 << PrettySize(initial_data_capacity)
304 << ", initial code size="
305 << PrettySize(initial_code_capacity);
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800306}
307
Vladimir Markob0b68cf2017-11-14 18:11:50 +0000308JitCodeCache::~JitCodeCache() {}
309
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100310bool JitCodeCache::ContainsPc(const void* ptr) const {
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100311 return code_map_.Begin() <= ptr && ptr < code_map_.End();
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800312}
313
Alex Light2d441b12018-06-08 15:33:21 -0700314bool JitCodeCache::WillExecuteJitCode(ArtMethod* method) {
315 ScopedObjectAccess soa(art::Thread::Current());
316 ScopedAssertNoThreadSuspension sants(__FUNCTION__);
317 if (ContainsPc(method->GetEntryPointFromQuickCompiledCode())) {
318 return true;
319 } else if (method->GetEntryPointFromQuickCompiledCode() == GetQuickInstrumentationEntryPoint()) {
320 return FindCompiledCodeForInstrumentation(method) != nullptr;
321 }
322 return false;
323}
324
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000325bool JitCodeCache::ContainsMethod(ArtMethod* method) {
326 MutexLock mu(Thread::Current(), lock_);
Vladimir Marko2196c652017-11-30 16:16:07 +0000327 if (UNLIKELY(method->IsNative())) {
328 auto it = jni_stubs_map_.find(JniStubKey(method));
329 if (it != jni_stubs_map_.end() &&
330 it->second.IsCompiled() &&
331 ContainsElement(it->second.GetMethods(), method)) {
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000332 return true;
333 }
Vladimir Marko2196c652017-11-30 16:16:07 +0000334 } else {
335 for (const auto& it : method_code_map_) {
336 if (it.second == method) {
337 return true;
338 }
339 }
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000340 }
341 return false;
342}
343
Vladimir Marko2196c652017-11-30 16:16:07 +0000344const void* JitCodeCache::GetJniStubCode(ArtMethod* method) {
345 DCHECK(method->IsNative());
346 MutexLock mu(Thread::Current(), lock_);
347 auto it = jni_stubs_map_.find(JniStubKey(method));
348 if (it != jni_stubs_map_.end()) {
349 JniStubData& data = it->second;
350 if (data.IsCompiled() && ContainsElement(data.GetMethods(), method)) {
351 return data.GetCode();
352 }
353 }
354 return nullptr;
355}
356
Alex Light2d441b12018-06-08 15:33:21 -0700357const void* JitCodeCache::FindCompiledCodeForInstrumentation(ArtMethod* method) {
Alex Light839f53a2018-07-10 15:46:14 -0700358 // If jit-gc is still on we use the SavedEntryPoint field for doing that and so cannot use it to
359 // find the instrumentation entrypoint.
360 if (LIKELY(GetGarbageCollectCode())) {
Alex Light2d441b12018-06-08 15:33:21 -0700361 return nullptr;
362 }
363 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
364 if (info == nullptr) {
365 return nullptr;
366 }
367 // When GC is disabled for trampoline tracing we will use SavedEntrypoint to hold the actual
368 // jit-compiled version of the method. If jit-gc is disabled for other reasons this will just be
369 // nullptr.
370 return info->GetSavedEntryPoint();
371}
372
Mathieu Chartier33fbf372016-03-07 13:48:08 -0800373class ScopedCodeCacheWrite : ScopedTrace {
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100374 public:
Calin Juravle016fcbe22018-05-03 19:47:35 -0700375 explicit ScopedCodeCacheWrite(const JitCodeCache* const code_cache)
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100376 : ScopedTrace("ScopedCodeCacheWrite"),
Calin Juravle016fcbe22018-05-03 19:47:35 -0700377 code_cache_(code_cache) {
Mathieu Chartier33fbf372016-03-07 13:48:08 -0800378 ScopedTrace trace("mprotect all");
Calin Juravle016fcbe22018-05-03 19:47:35 -0700379 CheckedCall(
380 mprotect,
381 "make code writable",
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100382 code_cache_->code_map_.Begin(),
383 code_cache_->code_map_.Size(),
Calin Juravle016fcbe22018-05-03 19:47:35 -0700384 code_cache_->memmap_flags_prot_code_ | PROT_WRITE);
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800385 }
Calin Juravle016fcbe22018-05-03 19:47:35 -0700386
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100387 ~ScopedCodeCacheWrite() {
Mathieu Chartier33fbf372016-03-07 13:48:08 -0800388 ScopedTrace trace("mprotect code");
Calin Juravle016fcbe22018-05-03 19:47:35 -0700389 CheckedCall(
390 mprotect,
391 "make code protected",
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100392 code_cache_->code_map_.Begin(),
393 code_cache_->code_map_.Size(),
Calin Juravle016fcbe22018-05-03 19:47:35 -0700394 code_cache_->memmap_flags_prot_code_);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100395 }
Mathieu Chartier8d8de0c2017-10-04 09:35:30 -0700396
David Sehrd1dbb742017-07-17 11:20:38 -0700397 private:
Calin Juravle016fcbe22018-05-03 19:47:35 -0700398 const JitCodeCache* const code_cache_;
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100399
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100400 DISALLOW_COPY_AND_ASSIGN(ScopedCodeCacheWrite);
401};
402
403uint8_t* JitCodeCache::CommitCode(Thread* self,
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100404 ArtMethod* method,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000405 uint8_t* stack_map,
406 uint8_t* roots_data,
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100407 const uint8_t* code,
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000408 size_t code_size,
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100409 size_t data_size,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000410 bool osr,
Mingyao Yang063fc772016-08-02 11:02:54 -0700411 Handle<mirror::ObjectArray<mirror::Object>> roots,
412 bool has_should_deoptimize_flag,
413 const ArenaSet<ArtMethod*>& cha_single_implementation_list) {
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100414 uint8_t* result = CommitCodeInternal(self,
415 method,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000416 stack_map,
417 roots_data,
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100418 code,
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000419 code_size,
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100420 data_size,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000421 osr,
Mingyao Yang063fc772016-08-02 11:02:54 -0700422 roots,
423 has_should_deoptimize_flag,
424 cha_single_implementation_list);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100425 if (result == nullptr) {
426 // Retry.
427 GarbageCollectCache(self);
428 result = CommitCodeInternal(self,
429 method,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000430 stack_map,
431 roots_data,
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100432 code,
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000433 code_size,
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100434 data_size,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000435 osr,
Mingyao Yang063fc772016-08-02 11:02:54 -0700436 roots,
437 has_should_deoptimize_flag,
438 cha_single_implementation_list);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100439 }
440 return result;
441}
442
443bool JitCodeCache::WaitForPotentialCollectionToComplete(Thread* self) {
444 bool in_collection = false;
445 while (collection_in_progress_) {
446 in_collection = true;
447 lock_cond_.Wait(self);
448 }
449 return in_collection;
450}
451
452static uintptr_t FromCodeToAllocation(const void* code) {
453 size_t alignment = GetInstructionSetAlignment(kRuntimeISA);
454 return reinterpret_cast<uintptr_t>(code) - RoundUp(sizeof(OatQuickMethodHeader), alignment);
455}
456
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000457static uint32_t ComputeRootTableSize(uint32_t number_of_roots) {
458 return sizeof(uint32_t) + number_of_roots * sizeof(GcRoot<mirror::Object>);
459}
460
461static uint32_t GetNumberOfRoots(const uint8_t* stack_map) {
462 // The length of the table is stored just before the stack map (and therefore at the end of
463 // the table itself), in order to be able to fetch it from a `stack_map` pointer.
464 return reinterpret_cast<const uint32_t*>(stack_map)[-1];
465}
466
Mathieu Chartier7a704be2016-11-22 13:24:40 -0800467static void FillRootTableLength(uint8_t* roots_data, uint32_t length) {
468 // Store the length of the table at the end. This will allow fetching it from a `stack_map`
469 // pointer.
470 reinterpret_cast<uint32_t*>(roots_data)[length] = length;
471}
472
Nicolas Geoffrayf4b94422016-12-05 00:10:09 +0000473static const uint8_t* FromStackMapToRoots(const uint8_t* stack_map_data) {
474 return stack_map_data - ComputeRootTableSize(GetNumberOfRoots(stack_map_data));
475}
476
Alex Light3e36a9c2018-06-19 09:45:05 -0700477static void DCheckRootsAreValid(Handle<mirror::ObjectArray<mirror::Object>> roots)
478 REQUIRES(!Locks::intern_table_lock_) REQUIRES_SHARED(Locks::mutator_lock_) {
479 if (!kIsDebugBuild) {
480 return;
481 }
482 const uint32_t length = roots->GetLength();
483 // Put all roots in `roots_data`.
484 for (uint32_t i = 0; i < length; ++i) {
485 ObjPtr<mirror::Object> object = roots->Get(i);
486 // Ensure the string is strongly interned. b/32995596
487 if (object->IsString()) {
488 ObjPtr<mirror::String> str = ObjPtr<mirror::String>::DownCast(object);
489 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
490 CHECK(class_linker->GetInternTable()->LookupStrong(Thread::Current(), str) != nullptr);
491 }
492 }
493}
494
495void JitCodeCache::FillRootTable(uint8_t* roots_data,
496 Handle<mirror::ObjectArray<mirror::Object>> roots) {
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000497 GcRoot<mirror::Object>* gc_roots = reinterpret_cast<GcRoot<mirror::Object>*>(roots_data);
Mathieu Chartier7a704be2016-11-22 13:24:40 -0800498 const uint32_t length = roots->GetLength();
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000499 // Put all roots in `roots_data`.
500 for (uint32_t i = 0; i < length; ++i) {
501 ObjPtr<mirror::Object> object = roots->Get(i);
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000502 gc_roots[i] = GcRoot<mirror::Object>(object);
503 }
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000504}
505
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100506static uint8_t* GetRootTable(const void* code_ptr, uint32_t* number_of_roots = nullptr) {
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000507 OatQuickMethodHeader* method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
508 uint8_t* data = method_header->GetOptimizedCodeInfoPtr();
509 uint32_t roots = GetNumberOfRoots(data);
510 if (number_of_roots != nullptr) {
511 *number_of_roots = roots;
512 }
513 return data - ComputeRootTableSize(roots);
514}
515
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100516// Use a sentinel for marking entries in the JIT table that have been cleared.
517// This helps diagnosing in case the compiled code tries to wrongly access such
518// entries.
Andreas Gampe5629d2d2017-05-15 16:28:13 -0700519static mirror::Class* const weak_sentinel =
520 reinterpret_cast<mirror::Class*>(Context::kBadGprBase + 0xff);
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100521
Nicolas Geoffray22384ae2016-12-12 22:33:36 +0000522// Helper for the GC to process a weak class in a JIT root table.
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100523static inline void ProcessWeakClass(GcRoot<mirror::Class>* root_ptr,
524 IsMarkedVisitor* visitor,
525 mirror::Class* update)
Nicolas Geoffray22384ae2016-12-12 22:33:36 +0000526 REQUIRES_SHARED(Locks::mutator_lock_) {
527 // This does not need a read barrier because this is called by GC.
528 mirror::Class* cls = root_ptr->Read<kWithoutReadBarrier>();
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100529 if (cls != nullptr && cls != weak_sentinel) {
Nicolas Geoffray22384ae2016-12-12 22:33:36 +0000530 DCHECK((cls->IsClass<kDefaultVerifyFlags, kWithoutReadBarrier>()));
531 // Look at the classloader of the class to know if it has been unloaded.
532 // This does not need a read barrier because this is called by GC.
533 mirror::Object* class_loader =
534 cls->GetClassLoader<kDefaultVerifyFlags, kWithoutReadBarrier>();
535 if (class_loader == nullptr || visitor->IsMarked(class_loader) != nullptr) {
536 // The class loader is live, update the entry if the class has moved.
537 mirror::Class* new_cls = down_cast<mirror::Class*>(visitor->IsMarked(cls));
538 // Note that new_object can be null for CMS and newly allocated objects.
539 if (new_cls != nullptr && new_cls != cls) {
540 *root_ptr = GcRoot<mirror::Class>(new_cls);
541 }
542 } else {
543 // The class loader is not live, clear the entry.
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100544 *root_ptr = GcRoot<mirror::Class>(update);
Nicolas Geoffray22384ae2016-12-12 22:33:36 +0000545 }
546 }
547}
548
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000549void JitCodeCache::SweepRootTables(IsMarkedVisitor* visitor) {
550 MutexLock mu(Thread::Current(), lock_);
551 for (const auto& entry : method_code_map_) {
552 uint32_t number_of_roots = 0;
553 uint8_t* roots_data = GetRootTable(entry.first, &number_of_roots);
554 GcRoot<mirror::Object>* roots = reinterpret_cast<GcRoot<mirror::Object>*>(roots_data);
555 for (uint32_t i = 0; i < number_of_roots; ++i) {
556 // This does not need a read barrier because this is called by GC.
557 mirror::Object* object = roots[i].Read<kWithoutReadBarrier>();
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100558 if (object == nullptr || object == weak_sentinel) {
Nicolas Geoffray22384ae2016-12-12 22:33:36 +0000559 // entry got deleted in a previous sweep.
560 } else if (object->IsString<kDefaultVerifyFlags, kWithoutReadBarrier>()) {
561 mirror::Object* new_object = visitor->IsMarked(object);
562 // We know the string is marked because it's a strongly-interned string that
563 // is always alive. The IsMarked implementation of the CMS collector returns
564 // null for newly allocated objects, but we know those haven't moved. Therefore,
565 // only update the entry if we get a different non-null string.
566 // TODO: Do not use IsMarked for j.l.Class, and adjust once we move this method
567 // out of the weak access/creation pause. b/32167580
568 if (new_object != nullptr && new_object != object) {
569 DCHECK(new_object->IsString());
570 roots[i] = GcRoot<mirror::Object>(new_object);
571 }
572 } else {
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100573 ProcessWeakClass(
574 reinterpret_cast<GcRoot<mirror::Class>*>(&roots[i]), visitor, weak_sentinel);
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000575 }
576 }
577 }
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000578 // Walk over inline caches to clear entries containing unloaded classes.
579 for (ProfilingInfo* info : profiling_infos_) {
580 for (size_t i = 0; i < info->number_of_inline_caches_; ++i) {
581 InlineCache* cache = &info->cache_[i];
582 for (size_t j = 0; j < InlineCache::kIndividualCacheSize; ++j) {
Nicolas Geoffray6ca115b2017-05-10 15:09:35 +0100583 ProcessWeakClass(&cache->classes_[j], visitor, nullptr);
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000584 }
585 }
586 }
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000587}
588
Orion Hodson607624f2018-05-11 10:10:46 +0100589void JitCodeCache::FreeCodeAndData(const void* code_ptr) {
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100590 uintptr_t allocation = FromCodeToAllocation(code_ptr);
David Srbecky5cc349f2015-12-18 15:04:48 +0000591 // Notify native debugger that we are about to remove the code.
592 // It does nothing if we are not using native debugger.
David Srbeckyfb3de3d2018-01-29 16:11:49 +0000593 MutexLock mu(Thread::Current(), *Locks::native_debug_interface_lock_);
David Srbecky440a9b32018-02-15 17:47:29 +0000594 RemoveNativeDebugInfoForJit(code_ptr);
Vladimir Marko2196c652017-11-30 16:16:07 +0000595 if (OatQuickMethodHeader::FromCodePointer(code_ptr)->IsOptimized()) {
596 FreeData(GetRootTable(code_ptr));
597 } // else this is a JNI stub without any data.
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100598 FreeCode(reinterpret_cast<uint8_t*>(allocation));
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100599}
600
Mingyao Yang063fc772016-08-02 11:02:54 -0700601void JitCodeCache::FreeAllMethodHeaders(
602 const std::unordered_set<OatQuickMethodHeader*>& method_headers) {
Mingyao Yang063fc772016-08-02 11:02:54 -0700603 // We need to remove entries in method_headers from CHA dependencies
604 // first since once we do FreeCode() below, the memory can be reused
605 // so it's possible for the same method_header to start representing
606 // different compile code.
607 MutexLock mu(Thread::Current(), lock_);
Alex Light33b7b5d2018-08-07 19:13:51 +0000608 {
609 MutexLock mu2(Thread::Current(), *Locks::cha_lock_);
610 Runtime::Current()->GetClassLinker()->GetClassHierarchyAnalysis()
611 ->RemoveDependentsWithMethodHeaders(method_headers);
612 }
613
Calin Juravle016fcbe22018-05-03 19:47:35 -0700614 ScopedCodeCacheWrite scc(this);
Mingyao Yang063fc772016-08-02 11:02:54 -0700615 for (const OatQuickMethodHeader* method_header : method_headers) {
Orion Hodson607624f2018-05-11 10:10:46 +0100616 FreeCodeAndData(method_header->GetCode());
Mingyao Yang063fc772016-08-02 11:02:54 -0700617 }
618}
619
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100620void JitCodeCache::RemoveMethodsIn(Thread* self, const LinearAlloc& alloc) {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800621 ScopedTrace trace(__PRETTY_FUNCTION__);
Mingyao Yang063fc772016-08-02 11:02:54 -0700622 // We use a set to first collect all method_headers whose code need to be
623 // removed. We need to free the underlying code after we remove CHA dependencies
624 // for entries in this set. And it's more efficient to iterate through
625 // the CHA dependency map just once with an unordered_set.
626 std::unordered_set<OatQuickMethodHeader*> method_headers;
Nicolas Geoffray26705e22015-10-28 12:50:11 +0000627 {
Mingyao Yang063fc772016-08-02 11:02:54 -0700628 MutexLock mu(self, lock_);
629 // We do not check if a code cache GC is in progress, as this method comes
630 // with the classlinker_classes_lock_ held, and suspending ourselves could
631 // lead to a deadlock.
632 {
Calin Juravle016fcbe22018-05-03 19:47:35 -0700633 ScopedCodeCacheWrite scc(this);
Vladimir Marko2196c652017-11-30 16:16:07 +0000634 for (auto it = jni_stubs_map_.begin(); it != jni_stubs_map_.end();) {
635 it->second.RemoveMethodsIn(alloc);
636 if (it->second.GetMethods().empty()) {
637 method_headers.insert(OatQuickMethodHeader::FromCodePointer(it->second.GetCode()));
638 it = jni_stubs_map_.erase(it);
639 } else {
640 it->first.UpdateShorty(it->second.GetMethods().front());
641 ++it;
642 }
643 }
Mingyao Yang063fc772016-08-02 11:02:54 -0700644 for (auto it = method_code_map_.begin(); it != method_code_map_.end();) {
645 if (alloc.ContainsUnsafe(it->second)) {
646 method_headers.insert(OatQuickMethodHeader::FromCodePointer(it->first));
647 it = method_code_map_.erase(it);
648 } else {
649 ++it;
650 }
651 }
652 }
653 for (auto it = osr_code_map_.begin(); it != osr_code_map_.end();) {
654 if (alloc.ContainsUnsafe(it->first)) {
655 // Note that the code has already been pushed to method_headers in the loop
656 // above and is going to be removed in FreeCode() below.
657 it = osr_code_map_.erase(it);
658 } else {
659 ++it;
660 }
661 }
662 for (auto it = profiling_infos_.begin(); it != profiling_infos_.end();) {
663 ProfilingInfo* info = *it;
664 if (alloc.ContainsUnsafe(info->GetMethod())) {
665 info->GetMethod()->SetProfilingInfo(nullptr);
666 FreeData(reinterpret_cast<uint8_t*>(info));
667 it = profiling_infos_.erase(it);
Nicolas Geoffray26705e22015-10-28 12:50:11 +0000668 } else {
669 ++it;
670 }
671 }
672 }
Mingyao Yang063fc772016-08-02 11:02:54 -0700673 FreeAllMethodHeaders(method_headers);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100674}
675
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000676bool JitCodeCache::IsWeakAccessEnabled(Thread* self) const {
677 return kUseReadBarrier
678 ? self->GetWeakRefAccessEnabled()
Orion Hodson88591fe2018-03-06 13:35:43 +0000679 : is_weak_access_enabled_.load(std::memory_order_seq_cst);
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000680}
681
682void JitCodeCache::WaitUntilInlineCacheAccessible(Thread* self) {
683 if (IsWeakAccessEnabled(self)) {
684 return;
685 }
686 ScopedThreadSuspension sts(self, kWaitingWeakGcRootRead);
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +0000687 MutexLock mu(self, lock_);
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000688 while (!IsWeakAccessEnabled(self)) {
689 inline_cache_cond_.Wait(self);
690 }
691}
692
693void JitCodeCache::BroadcastForInlineCacheAccess() {
694 Thread* self = Thread::Current();
695 MutexLock mu(self, lock_);
696 inline_cache_cond_.Broadcast(self);
697}
698
699void JitCodeCache::AllowInlineCacheAccess() {
700 DCHECK(!kUseReadBarrier);
Orion Hodson88591fe2018-03-06 13:35:43 +0000701 is_weak_access_enabled_.store(true, std::memory_order_seq_cst);
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000702 BroadcastForInlineCacheAccess();
703}
704
705void JitCodeCache::DisallowInlineCacheAccess() {
706 DCHECK(!kUseReadBarrier);
Orion Hodson88591fe2018-03-06 13:35:43 +0000707 is_weak_access_enabled_.store(false, std::memory_order_seq_cst);
Nicolas Geoffraye51ca8b2016-11-22 14:49:31 +0000708}
709
710void JitCodeCache::CopyInlineCacheInto(const InlineCache& ic,
711 Handle<mirror::ObjectArray<mirror::Class>> array) {
712 WaitUntilInlineCacheAccessible(Thread::Current());
713 // Note that we don't need to lock `lock_` here, the compiler calling
714 // this method has already ensured the inline cache will not be deleted.
715 for (size_t in_cache = 0, in_array = 0;
716 in_cache < InlineCache::kIndividualCacheSize;
717 ++in_cache) {
718 mirror::Class* object = ic.classes_[in_cache].Read();
719 if (object != nullptr) {
720 array->Set(in_array++, object);
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +0000721 }
722 }
723}
724
Mathieu Chartierf044c222017-05-31 15:27:54 -0700725static void ClearMethodCounter(ArtMethod* method, bool was_warm) {
726 if (was_warm) {
Vladimir Markoc945e0d2018-07-18 17:26:45 +0100727 method->SetPreviouslyWarm();
Mathieu Chartierf044c222017-05-31 15:27:54 -0700728 }
729 // We reset the counter to 1 so that the profile knows that the method was executed at least once.
730 // This is required for layout purposes.
Nicolas Geoffray88f50b12017-06-09 16:08:47 +0100731 // We also need to make sure we'll pass the warmup threshold again, so we set to 0 if
732 // the warmup threshold is 1.
733 uint16_t jit_warmup_threshold = Runtime::Current()->GetJITOptions()->GetWarmupThreshold();
734 method->SetCounter(std::min(jit_warmup_threshold - 1, 1));
Mathieu Chartierf044c222017-05-31 15:27:54 -0700735}
736
Alex Light33b7b5d2018-08-07 19:13:51 +0000737void JitCodeCache::WaitForPotentialCollectionToCompleteRunnable(Thread* self) {
738 while (collection_in_progress_) {
739 lock_.Unlock(self);
740 {
741 ScopedThreadSuspension sts(self, kSuspended);
742 MutexLock mu(self, lock_);
743 WaitForPotentialCollectionToComplete(self);
744 }
745 lock_.Lock(self);
746 }
747}
748
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100749uint8_t* JitCodeCache::CommitCodeInternal(Thread* self,
750 ArtMethod* method,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000751 uint8_t* stack_map,
752 uint8_t* roots_data,
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100753 const uint8_t* code,
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000754 size_t code_size,
Orion Hodsondbd05fe2017-08-10 11:41:35 +0100755 size_t data_size,
Nicolas Geoffray132d8362016-11-16 09:19:42 +0000756 bool osr,
Mingyao Yang063fc772016-08-02 11:02:54 -0700757 Handle<mirror::ObjectArray<mirror::Object>> roots,
758 bool has_should_deoptimize_flag,
759 const ArenaSet<ArtMethod*>&
760 cha_single_implementation_list) {
Vladimir Marko2196c652017-11-30 16:16:07 +0000761 DCHECK(!method->IsNative() || !osr);
Alex Light33b7b5d2018-08-07 19:13:51 +0000762
763 if (!method->IsNative()) {
764 // We need to do this before grabbing the lock_ because it needs to be able to see the string
765 // InternTable. Native methods do not have roots.
766 DCheckRootsAreValid(roots);
767 }
768
Nicolas Geoffray1e7de6c2015-10-21 12:07:31 +0100769 size_t alignment = GetInstructionSetAlignment(kRuntimeISA);
770 // Ensure the header ends up at expected instruction alignment.
771 size_t header_size = RoundUp(sizeof(OatQuickMethodHeader), alignment);
772 size_t total_size = header_size + code_size;
773
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100774 OatQuickMethodHeader* method_header = nullptr;
Nicolas Geoffray1e7de6c2015-10-21 12:07:31 +0100775 uint8_t* code_ptr = nullptr;
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +0000776 uint8_t* memory = nullptr;
Alex Light33b7b5d2018-08-07 19:13:51 +0000777 MutexLock mu(self, lock_);
778 // We need to make sure that there will be no jit-gcs going on and wait for any ongoing one to
779 // finish.
780 WaitForPotentialCollectionToCompleteRunnable(self);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100781 {
Alex Light33b7b5d2018-08-07 19:13:51 +0000782 ScopedCodeCacheWrite scc(this);
783 memory = AllocateCode(total_size);
784 if (memory == nullptr) {
785 return nullptr;
786 }
787 code_ptr = memory + header_size;
Nicolas Geoffrayd28b9692015-11-04 14:36:55 +0000788
Alex Light33b7b5d2018-08-07 19:13:51 +0000789 std::copy(code, code + code_size, code_ptr);
790 method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
791 new (method_header) OatQuickMethodHeader(
792 (stack_map != nullptr) ? code_ptr - stack_map : 0u,
793 code_size);
794 // Flush caches before we remove write permission because some ARMv8 Qualcomm kernels may
795 // trigger a segfault if a page fault occurs when requesting a cache maintenance operation.
796 // This is a kernel bug that we need to work around until affected devices (e.g. Nexus 5X and
797 // 6P) stop being supported or their kernels are fixed.
798 //
799 // For reference, this behavior is caused by this commit:
800 // https://android.googlesource.com/kernel/msm/+/3fbe6bc28a6b9939d0650f2f17eb5216c719950c
801 FlushInstructionCache(reinterpret_cast<char*>(code_ptr),
802 reinterpret_cast<char*>(code_ptr + code_size));
803 DCHECK(!Runtime::Current()->IsAotCompiler());
804 if (has_should_deoptimize_flag) {
805 method_header->SetHasShouldDeoptimizeFlag();
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100806 }
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100807
Nicolas Geoffray0a522232016-01-19 09:34:58 +0000808 number_of_compilations_++;
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100809 }
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000810 // We need to update the entry point in the runnable state for the instrumentation.
811 {
Alex Light33b7b5d2018-08-07 19:13:51 +0000812 // The following needs to be guarded by cha_lock_ also. Otherwise it's possible that the
813 // compiled code is considered invalidated by some class linking, but below we still make the
814 // compiled code valid for the method. Need cha_lock_ for checking all single-implementation
815 // flags and register dependencies.
Mingyao Yang063fc772016-08-02 11:02:54 -0700816 MutexLock cha_mu(self, *Locks::cha_lock_);
817 bool single_impl_still_valid = true;
818 for (ArtMethod* single_impl : cha_single_implementation_list) {
819 if (!single_impl->HasSingleImplementation()) {
Jeff Hao00286db2017-05-30 16:53:07 -0700820 // Simply discard the compiled code. Clear the counter so that it may be recompiled later.
821 // Hopefully the class hierarchy will be more stable when compilation is retried.
Mingyao Yang063fc772016-08-02 11:02:54 -0700822 single_impl_still_valid = false;
Mathieu Chartierf044c222017-05-31 15:27:54 -0700823 ClearMethodCounter(method, /*was_warm*/ false);
Mingyao Yang063fc772016-08-02 11:02:54 -0700824 break;
825 }
826 }
827
828 // Discard the code if any single-implementation assumptions are now invalid.
829 if (!single_impl_still_valid) {
830 VLOG(jit) << "JIT discarded jitted code due to invalid single-implementation assumptions.";
831 return nullptr;
832 }
Nicolas Geoffray433b79a2017-01-30 20:54:45 +0000833 DCHECK(cha_single_implementation_list.empty() || !Runtime::Current()->IsJavaDebuggable())
Alex Lightdba61482016-12-21 08:20:29 -0800834 << "Should not be using cha on debuggable apps/runs!";
835
Mingyao Yang063fc772016-08-02 11:02:54 -0700836 for (ArtMethod* single_impl : cha_single_implementation_list) {
Andreas Gampec1ac9ee2017-07-24 22:35:49 -0700837 Runtime::Current()->GetClassLinker()->GetClassHierarchyAnalysis()->AddDependency(
Mingyao Yang063fc772016-08-02 11:02:54 -0700838 single_impl, method, method_header);
839 }
840
Vladimir Marko2196c652017-11-30 16:16:07 +0000841 if (UNLIKELY(method->IsNative())) {
Vladimir Marko2196c652017-11-30 16:16:07 +0000842 auto it = jni_stubs_map_.find(JniStubKey(method));
843 DCHECK(it != jni_stubs_map_.end())
844 << "Entry inserted in NotifyCompilationOf() should be alive.";
845 JniStubData* data = &it->second;
846 DCHECK(ContainsElement(data->GetMethods(), method))
847 << "Entry inserted in NotifyCompilationOf() should contain this method.";
848 data->SetCode(code_ptr);
849 instrumentation::Instrumentation* instrum = Runtime::Current()->GetInstrumentation();
850 for (ArtMethod* m : data->GetMethods()) {
851 instrum->UpdateMethodsCode(m, method_header->GetEntryPoint());
852 }
Nicolas Geoffray480d5102016-04-18 12:09:30 +0100853 } else {
Vladimir Marko2196c652017-11-30 16:16:07 +0000854 // Fill the root table before updating the entry point.
855 DCHECK_EQ(FromStackMapToRoots(stack_map), roots_data);
856 DCHECK_LE(roots_data, stack_map);
857 FillRootTable(roots_data, roots);
858 {
859 // Flush data cache, as compiled code references literals in it.
Vladimir Marko2196c652017-11-30 16:16:07 +0000860 FlushDataCache(reinterpret_cast<char*>(roots_data),
861 reinterpret_cast<char*>(roots_data + data_size));
862 }
863 method_code_map_.Put(code_ptr, method);
864 if (osr) {
865 number_of_osr_compilations_++;
866 osr_code_map_.Put(method, code_ptr);
867 } else {
868 Runtime::Current()->GetInstrumentation()->UpdateMethodsCode(
869 method, method_header->GetEntryPoint());
870 }
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000871 }
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000872 VLOG(jit)
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100873 << "JIT added (osr=" << std::boolalpha << osr << std::noboolalpha << ") "
David Sehr709b0702016-10-13 09:12:37 -0700874 << ArtMethod::PrettyMethod(method) << "@" << method
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000875 << " ccache_size=" << PrettySize(CodeCacheSizeLocked()) << ": "
876 << " dcache_size=" << PrettySize(DataCacheSizeLocked()) << ": "
877 << reinterpret_cast<const void*>(method_header->GetEntryPoint()) << ","
Mingyao Yang063fc772016-08-02 11:02:54 -0700878 << reinterpret_cast<const void*>(method_header->GetEntryPoint() +
879 method_header->GetCodeSize());
Nicolas Geoffray933330a2016-03-16 14:20:06 +0000880 histogram_code_memory_use_.AddValue(code_size);
881 if (code_size > kCodeSizeLogThreshold) {
882 LOG(INFO) << "JIT allocated "
883 << PrettySize(code_size)
884 << " for compiled code of "
David Sehr709b0702016-10-13 09:12:37 -0700885 << ArtMethod::PrettyMethod(method);
Nicolas Geoffray933330a2016-03-16 14:20:06 +0000886 }
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000887 }
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100888
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100889 return reinterpret_cast<uint8_t*>(method_header);
890}
891
892size_t JitCodeCache::CodeCacheSize() {
893 MutexLock mu(Thread::Current(), lock_);
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000894 return CodeCacheSizeLocked();
895}
896
Orion Hodsoneced6922017-06-01 10:54:28 +0100897bool JitCodeCache::RemoveMethod(ArtMethod* method, bool release_memory) {
Vladimir Marko2196c652017-11-30 16:16:07 +0000898 // This function is used only for testing and only with non-native methods.
899 CHECK(!method->IsNative());
900
Orion Hodsoneced6922017-06-01 10:54:28 +0100901 MutexLock mu(Thread::Current(), lock_);
Orion Hodsoneced6922017-06-01 10:54:28 +0100902
Vladimir Marko2196c652017-11-30 16:16:07 +0000903 bool osr = osr_code_map_.find(method) != osr_code_map_.end();
904 bool in_cache = RemoveMethodLocked(method, release_memory);
Orion Hodsoneced6922017-06-01 10:54:28 +0100905
906 if (!in_cache) {
907 return false;
908 }
909
Orion Hodsoneced6922017-06-01 10:54:28 +0100910 method->ClearCounter();
911 Runtime::Current()->GetInstrumentation()->UpdateMethodsCode(
912 method, GetQuickToInterpreterBridge());
913 VLOG(jit)
914 << "JIT removed (osr=" << std::boolalpha << osr << std::noboolalpha << ") "
915 << ArtMethod::PrettyMethod(method) << "@" << method
916 << " ccache_size=" << PrettySize(CodeCacheSizeLocked()) << ": "
917 << " dcache_size=" << PrettySize(DataCacheSizeLocked());
918 return true;
919}
920
Vladimir Marko2196c652017-11-30 16:16:07 +0000921bool JitCodeCache::RemoveMethodLocked(ArtMethod* method, bool release_memory) {
922 if (LIKELY(!method->IsNative())) {
923 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
924 if (info != nullptr) {
925 RemoveElement(profiling_infos_, info);
926 }
927 method->SetProfilingInfo(nullptr);
928 }
929
930 bool in_cache = false;
Calin Juravle016fcbe22018-05-03 19:47:35 -0700931 ScopedCodeCacheWrite ccw(this);
Vladimir Marko2196c652017-11-30 16:16:07 +0000932 if (UNLIKELY(method->IsNative())) {
933 auto it = jni_stubs_map_.find(JniStubKey(method));
934 if (it != jni_stubs_map_.end() && it->second.RemoveMethod(method)) {
935 in_cache = true;
936 if (it->second.GetMethods().empty()) {
937 if (release_memory) {
Orion Hodson607624f2018-05-11 10:10:46 +0100938 FreeCodeAndData(it->second.GetCode());
Vladimir Marko2196c652017-11-30 16:16:07 +0000939 }
940 jni_stubs_map_.erase(it);
941 } else {
942 it->first.UpdateShorty(it->second.GetMethods().front());
943 }
944 }
945 } else {
946 for (auto it = method_code_map_.begin(); it != method_code_map_.end();) {
947 if (it->second == method) {
948 in_cache = true;
949 if (release_memory) {
Orion Hodson607624f2018-05-11 10:10:46 +0100950 FreeCodeAndData(it->first);
Vladimir Marko2196c652017-11-30 16:16:07 +0000951 }
952 it = method_code_map_.erase(it);
953 } else {
954 ++it;
955 }
956 }
957
958 auto osr_it = osr_code_map_.find(method);
959 if (osr_it != osr_code_map_.end()) {
960 osr_code_map_.erase(osr_it);
961 }
962 }
963
964 return in_cache;
965}
966
Alex Lightdba61482016-12-21 08:20:29 -0800967// This notifies the code cache that the given method has been redefined and that it should remove
968// any cached information it has on the method. All threads must be suspended before calling this
969// method. The compiled code for the method (if there is any) must not be in any threads call stack.
970void JitCodeCache::NotifyMethodRedefined(ArtMethod* method) {
971 MutexLock mu(Thread::Current(), lock_);
Vladimir Marko2196c652017-11-30 16:16:07 +0000972 RemoveMethodLocked(method, /* release_memory */ true);
Alex Lightdba61482016-12-21 08:20:29 -0800973}
974
975// This invalidates old_method. Once this function returns one can no longer use old_method to
976// execute code unless it is fixed up. This fixup will happen later in the process of installing a
977// class redefinition.
978// TODO We should add some info to ArtMethod to note that 'old_method' has been invalidated and
979// shouldn't be used since it is no longer logically in the jit code cache.
980// TODO We should add DCHECKS that validate that the JIT is paused when this method is entered.
981void JitCodeCache::MoveObsoleteMethod(ArtMethod* old_method, ArtMethod* new_method) {
Vladimir Marko2196c652017-11-30 16:16:07 +0000982 MutexLock mu(Thread::Current(), lock_);
Alex Lighteee0bd42017-02-14 15:31:45 +0000983 if (old_method->IsNative()) {
Vladimir Marko2196c652017-11-30 16:16:07 +0000984 // Update methods in jni_stubs_map_.
985 for (auto& entry : jni_stubs_map_) {
986 JniStubData& data = entry.second;
987 data.MoveObsoleteMethod(old_method, new_method);
988 }
Alex Lighteee0bd42017-02-14 15:31:45 +0000989 return;
990 }
Alex Lightdba61482016-12-21 08:20:29 -0800991 // Update ProfilingInfo to the new one and remove it from the old_method.
992 if (old_method->GetProfilingInfo(kRuntimePointerSize) != nullptr) {
993 DCHECK_EQ(old_method->GetProfilingInfo(kRuntimePointerSize)->GetMethod(), old_method);
994 ProfilingInfo* info = old_method->GetProfilingInfo(kRuntimePointerSize);
995 old_method->SetProfilingInfo(nullptr);
996 // Since the JIT should be paused and all threads suspended by the time this is called these
997 // checks should always pass.
998 DCHECK(!info->IsInUseByCompiler());
999 new_method->SetProfilingInfo(info);
Alex Light2d441b12018-06-08 15:33:21 -07001000 // Get rid of the old saved entrypoint if it is there.
1001 info->SetSavedEntryPoint(nullptr);
Alex Lightdba61482016-12-21 08:20:29 -08001002 info->method_ = new_method;
1003 }
1004 // Update method_code_map_ to point to the new method.
1005 for (auto& it : method_code_map_) {
1006 if (it.second == old_method) {
1007 it.second = new_method;
1008 }
1009 }
1010 // Update osr_code_map_ to point to the new method.
1011 auto code_map = osr_code_map_.find(old_method);
1012 if (code_map != osr_code_map_.end()) {
1013 osr_code_map_.Put(new_method, code_map->second);
1014 osr_code_map_.erase(old_method);
1015 }
1016}
1017
Nicolas Geoffraya5891e82015-11-06 14:18:27 +00001018size_t JitCodeCache::CodeCacheSizeLocked() {
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001019 return used_memory_for_code_;
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +01001020}
1021
1022size_t JitCodeCache::DataCacheSize() {
1023 MutexLock mu(Thread::Current(), lock_);
Nicolas Geoffraya5891e82015-11-06 14:18:27 +00001024 return DataCacheSizeLocked();
1025}
1026
1027size_t JitCodeCache::DataCacheSizeLocked() {
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001028 return used_memory_for_data_;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001029}
1030
Nicolas Geoffrayf46501c2016-11-22 13:45:36 +00001031void JitCodeCache::ClearData(Thread* self,
1032 uint8_t* stack_map_data,
1033 uint8_t* roots_data) {
1034 DCHECK_EQ(FromStackMapToRoots(stack_map_data), roots_data);
Nicolas Geoffrayd28b9692015-11-04 14:36:55 +00001035 MutexLock mu(self, lock_);
Nicolas Geoffrayf46501c2016-11-22 13:45:36 +00001036 FreeData(reinterpret_cast<uint8_t*>(roots_data));
Nicolas Geoffrayd28b9692015-11-04 14:36:55 +00001037}
1038
Nicolas Geoffrayed015ac2016-12-15 17:58:48 +00001039size_t JitCodeCache::ReserveData(Thread* self,
1040 size_t stack_map_size,
1041 size_t number_of_roots,
1042 ArtMethod* method,
1043 uint8_t** stack_map_data,
1044 uint8_t** roots_data) {
Nicolas Geoffray132d8362016-11-16 09:19:42 +00001045 size_t table_size = ComputeRootTableSize(number_of_roots);
David Srbecky8cd54542018-07-15 23:58:44 +01001046 size_t size = RoundUp(stack_map_size + table_size, sizeof(void*));
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001047 uint8_t* result = nullptr;
1048
1049 {
1050 ScopedThreadSuspension sts(self, kSuspended);
1051 MutexLock mu(self, lock_);
1052 WaitForPotentialCollectionToComplete(self);
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001053 result = AllocateData(size);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001054 }
1055
1056 if (result == nullptr) {
1057 // Retry.
1058 GarbageCollectCache(self);
1059 ScopedThreadSuspension sts(self, kSuspended);
1060 MutexLock mu(self, lock_);
1061 WaitForPotentialCollectionToComplete(self);
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001062 result = AllocateData(size);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001063 }
1064
Nicolas Geoffray933330a2016-03-16 14:20:06 +00001065 MutexLock mu(self, lock_);
1066 histogram_stack_map_memory_use_.AddValue(size);
1067 if (size > kStackMapSizeLogThreshold) {
1068 LOG(INFO) << "JIT allocated "
1069 << PrettySize(size)
1070 << " for stack maps of "
David Sehr709b0702016-10-13 09:12:37 -07001071 << ArtMethod::PrettyMethod(method);
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001072 }
Nicolas Geoffrayf4b94422016-12-05 00:10:09 +00001073 if (result != nullptr) {
1074 *roots_data = result;
1075 *stack_map_data = result + table_size;
1076 FillRootTableLength(*roots_data, number_of_roots);
Nicolas Geoffrayed015ac2016-12-15 17:58:48 +00001077 return size;
Nicolas Geoffrayf4b94422016-12-05 00:10:09 +00001078 } else {
1079 *roots_data = nullptr;
1080 *stack_map_data = nullptr;
Nicolas Geoffrayed015ac2016-12-15 17:58:48 +00001081 return 0;
Nicolas Geoffrayf4b94422016-12-05 00:10:09 +00001082 }
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001083}
1084
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001085class MarkCodeVisitor final : public StackVisitor {
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001086 public:
1087 MarkCodeVisitor(Thread* thread_in, JitCodeCache* code_cache_in)
1088 : StackVisitor(thread_in, nullptr, StackVisitor::StackWalkKind::kSkipInlinedFrames),
1089 code_cache_(code_cache_in),
1090 bitmap_(code_cache_->GetLiveBitmap()) {}
1091
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001092 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001093 const OatQuickMethodHeader* method_header = GetCurrentOatQuickMethodHeader();
1094 if (method_header == nullptr) {
1095 return true;
1096 }
1097 const void* code = method_header->GetCode();
1098 if (code_cache_->ContainsPc(code)) {
1099 // Use the atomic set version, as multiple threads are executing this code.
1100 bitmap_->AtomicTestAndSet(FromCodeToAllocation(code));
1101 }
1102 return true;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001103 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001104
1105 private:
1106 JitCodeCache* const code_cache_;
1107 CodeCacheBitmap* const bitmap_;
1108};
1109
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001110class MarkCodeClosure final : public Closure {
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001111 public:
1112 MarkCodeClosure(JitCodeCache* code_cache, Barrier* barrier)
1113 : code_cache_(code_cache), barrier_(barrier) {}
1114
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001115 void Run(Thread* thread) override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001116 ScopedTrace trace(__PRETTY_FUNCTION__);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001117 DCHECK(thread == Thread::Current() || thread->IsSuspended());
1118 MarkCodeVisitor visitor(thread, code_cache_);
1119 visitor.WalkStack();
Nicolas Geoffray5a23d2e2015-11-03 18:58:57 +00001120 if (kIsDebugBuild) {
1121 // The stack walking code queries the side instrumentation stack if it
1122 // sees an instrumentation exit pc, so the JIT code of methods in that stack
1123 // must have been seen. We sanity check this below.
1124 for (const instrumentation::InstrumentationStackFrame& frame
1125 : *thread->GetInstrumentationStack()) {
1126 // The 'method_' in InstrumentationStackFrame is the one that has return_pc_ in
1127 // its stack frame, it is not the method owning return_pc_. We just pass null to
1128 // LookupMethodHeader: the method is only checked against in debug builds.
1129 OatQuickMethodHeader* method_header =
Vladimir Marko2196c652017-11-30 16:16:07 +00001130 code_cache_->LookupMethodHeader(frame.return_pc_, /* method */ nullptr);
Nicolas Geoffray5a23d2e2015-11-03 18:58:57 +00001131 if (method_header != nullptr) {
1132 const void* code = method_header->GetCode();
1133 CHECK(code_cache_->GetLiveBitmap()->Test(FromCodeToAllocation(code)));
1134 }
1135 }
1136 }
Mathieu Chartier10d25082015-10-28 18:36:09 -07001137 barrier_->Pass(Thread::Current());
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001138 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001139
1140 private:
1141 JitCodeCache* const code_cache_;
1142 Barrier* const barrier_;
1143};
1144
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001145void JitCodeCache::NotifyCollectionDone(Thread* self) {
1146 collection_in_progress_ = false;
1147 lock_cond_.Broadcast(self);
1148}
1149
1150void JitCodeCache::SetFootprintLimit(size_t new_footprint) {
1151 size_t per_space_footprint = new_footprint / 2;
Orion Hodsondbd05fe2017-08-10 11:41:35 +01001152 DCHECK(IsAlignedParam(per_space_footprint, kPageSize));
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001153 DCHECK_EQ(per_space_footprint * 2, new_footprint);
1154 mspace_set_footprint_limit(data_mspace_, per_space_footprint);
1155 {
Calin Juravle016fcbe22018-05-03 19:47:35 -07001156 ScopedCodeCacheWrite scc(this);
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001157 mspace_set_footprint_limit(code_mspace_, per_space_footprint);
1158 }
1159}
1160
1161bool JitCodeCache::IncreaseCodeCacheCapacity() {
1162 if (current_capacity_ == max_capacity_) {
1163 return false;
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001164 }
1165
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001166 // Double the capacity if we're below 1MB, or increase it by 1MB if
1167 // we're above.
1168 if (current_capacity_ < 1 * MB) {
1169 current_capacity_ *= 2;
1170 } else {
1171 current_capacity_ += 1 * MB;
1172 }
1173 if (current_capacity_ > max_capacity_) {
1174 current_capacity_ = max_capacity_;
1175 }
1176
Nicolas Geoffray646d6382017-08-09 10:50:00 +01001177 VLOG(jit) << "Increasing code cache capacity to " << PrettySize(current_capacity_);
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001178
1179 SetFootprintLimit(current_capacity_);
1180
1181 return true;
1182}
1183
Nicolas Geoffray8d372502016-02-23 13:56:43 +00001184void JitCodeCache::MarkCompiledCodeOnThreadStacks(Thread* self) {
1185 Barrier barrier(0);
1186 size_t threads_running_checkpoint = 0;
1187 MarkCodeClosure closure(this, &barrier);
1188 threads_running_checkpoint = Runtime::Current()->GetThreadList()->RunCheckpoint(&closure);
1189 // Now that we have run our checkpoint, move to a suspended state and wait
1190 // for other threads to run the checkpoint.
1191 ScopedThreadSuspension sts(self, kSuspended);
1192 if (threads_running_checkpoint != 0) {
1193 barrier.Increment(self, threads_running_checkpoint);
1194 }
1195}
1196
Nicolas Geoffray35122442016-03-02 12:05:30 +00001197bool JitCodeCache::ShouldDoFullCollection() {
1198 if (current_capacity_ == max_capacity_) {
1199 // Always do a full collection when the code cache is full.
1200 return true;
1201 } else if (current_capacity_ < kReservedCapacity) {
1202 // Always do partial collection when the code cache size is below the reserved
1203 // capacity.
1204 return false;
1205 } else if (last_collection_increased_code_cache_) {
1206 // This time do a full collection.
1207 return true;
1208 } else {
1209 // This time do a partial collection.
1210 return false;
Nicolas Geoffray8d372502016-02-23 13:56:43 +00001211 }
1212}
1213
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001214void JitCodeCache::GarbageCollectCache(Thread* self) {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001215 ScopedTrace trace(__FUNCTION__);
Nicolas Geoffray8d372502016-02-23 13:56:43 +00001216 if (!garbage_collect_code_) {
1217 MutexLock mu(self, lock_);
1218 IncreaseCodeCacheCapacity();
1219 return;
1220 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001221
Nicolas Geoffraya5891e82015-11-06 14:18:27 +00001222 // Wait for an existing collection, or let everyone know we are starting one.
1223 {
1224 ScopedThreadSuspension sts(self, kSuspended);
1225 MutexLock mu(self, lock_);
1226 if (WaitForPotentialCollectionToComplete(self)) {
1227 return;
1228 } else {
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001229 number_of_collections_++;
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001230 live_bitmap_.reset(CodeCacheBitmap::Create(
1231 "code-cache-bitmap",
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001232 reinterpret_cast<uintptr_t>(code_map_.Begin()),
1233 reinterpret_cast<uintptr_t>(code_map_.Begin() + current_capacity_ / 2)));
Nicolas Geoffray8d372502016-02-23 13:56:43 +00001234 collection_in_progress_ = true;
1235 }
1236 }
1237
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001238 TimingLogger logger("JIT code cache timing logger", true, VLOG_IS_ON(jit));
Nicolas Geoffray8d372502016-02-23 13:56:43 +00001239 {
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001240 TimingLogger::ScopedTiming st("Code cache collection", &logger);
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001241
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001242 bool do_full_collection = false;
1243 {
1244 MutexLock mu(self, lock_);
1245 do_full_collection = ShouldDoFullCollection();
Nicolas Geoffraya96917a2016-03-01 22:18:02 +00001246 }
1247
Nicolas Geoffray646d6382017-08-09 10:50:00 +01001248 VLOG(jit) << "Do "
1249 << (do_full_collection ? "full" : "partial")
1250 << " code cache collection, code="
1251 << PrettySize(CodeCacheSize())
1252 << ", data=" << PrettySize(DataCacheSize());
Nicolas Geoffray35122442016-03-02 12:05:30 +00001253
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001254 DoCollection(self, /* collect_profiling_info */ do_full_collection);
1255
Nicolas Geoffray646d6382017-08-09 10:50:00 +01001256 VLOG(jit) << "After code cache collection, code="
1257 << PrettySize(CodeCacheSize())
1258 << ", data=" << PrettySize(DataCacheSize());
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001259
1260 {
1261 MutexLock mu(self, lock_);
1262
1263 // Increase the code cache only when we do partial collections.
1264 // TODO: base this strategy on how full the code cache is?
1265 if (do_full_collection) {
1266 last_collection_increased_code_cache_ = false;
1267 } else {
1268 last_collection_increased_code_cache_ = true;
1269 IncreaseCodeCacheCapacity();
Nicolas Geoffray35122442016-03-02 12:05:30 +00001270 }
1271
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001272 bool next_collection_will_be_full = ShouldDoFullCollection();
1273
1274 // Start polling the liveness of compiled code to prepare for the next full collection.
Nicolas Geoffray480d5102016-04-18 12:09:30 +01001275 if (next_collection_will_be_full) {
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001276 // Save the entry point of methods we have compiled, and update the entry
1277 // point of those methods to the interpreter. If the method is invoked, the
1278 // interpreter will update its entry point to the compiled code and call it.
1279 for (ProfilingInfo* info : profiling_infos_) {
1280 const void* entry_point = info->GetMethod()->GetEntryPointFromQuickCompiledCode();
1281 if (ContainsPc(entry_point)) {
1282 info->SetSavedEntryPoint(entry_point);
Vladimir Marko2196c652017-11-30 16:16:07 +00001283 // Don't call Instrumentation::UpdateMethodsCode(), as it can check the declaring
Nicolas Geoffray3b1a7f42017-02-22 10:21:00 +00001284 // class of the method. We may be concurrently running a GC which makes accessing
1285 // the class unsafe. We know it is OK to bypass the instrumentation as we've just
1286 // checked that the current entry point is JIT compiled code.
1287 info->GetMethod()->SetEntryPointFromQuickCompiledCode(GetQuickToInterpreterBridge());
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001288 }
1289 }
1290
1291 DCHECK(CheckLiveCompiledCodeHasProfilingInfo());
Vladimir Marko2196c652017-11-30 16:16:07 +00001292
1293 // Change entry points of native methods back to the GenericJNI entrypoint.
1294 for (const auto& entry : jni_stubs_map_) {
1295 const JniStubData& data = entry.second;
1296 if (!data.IsCompiled()) {
1297 continue;
1298 }
1299 // Make sure a single invocation of the GenericJNI trampoline tries to recompile.
1300 uint16_t new_counter = Runtime::Current()->GetJit()->HotMethodThreshold() - 1u;
1301 const OatQuickMethodHeader* method_header =
1302 OatQuickMethodHeader::FromCodePointer(data.GetCode());
1303 for (ArtMethod* method : data.GetMethods()) {
1304 if (method->GetEntryPointFromQuickCompiledCode() == method_header->GetEntryPoint()) {
1305 // Don't call Instrumentation::UpdateMethodsCode(), same as for normal methods above.
1306 method->SetCounter(new_counter);
1307 method->SetEntryPointFromQuickCompiledCode(GetQuickGenericJniStub());
1308 }
1309 }
1310 }
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001311 }
1312 live_bitmap_.reset(nullptr);
1313 NotifyCollectionDone(self);
Nicolas Geoffray35122442016-03-02 12:05:30 +00001314 }
Nicolas Geoffray35122442016-03-02 12:05:30 +00001315 }
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001316 Runtime::Current()->GetJit()->AddTimingLogger(logger);
Nicolas Geoffray35122442016-03-02 12:05:30 +00001317}
1318
Nicolas Geoffray9abb2972016-03-04 14:32:59 +00001319void JitCodeCache::RemoveUnmarkedCode(Thread* self) {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001320 ScopedTrace trace(__FUNCTION__);
Mingyao Yang063fc772016-08-02 11:02:54 -07001321 std::unordered_set<OatQuickMethodHeader*> method_headers;
1322 {
1323 MutexLock mu(self, lock_);
Calin Juravle016fcbe22018-05-03 19:47:35 -07001324 ScopedCodeCacheWrite scc(this);
Mingyao Yang063fc772016-08-02 11:02:54 -07001325 // Iterate over all compiled code and remove entries that are not marked.
Vladimir Marko2196c652017-11-30 16:16:07 +00001326 for (auto it = jni_stubs_map_.begin(); it != jni_stubs_map_.end();) {
1327 JniStubData* data = &it->second;
1328 if (!data->IsCompiled() || GetLiveBitmap()->Test(FromCodeToAllocation(data->GetCode()))) {
1329 ++it;
1330 } else {
1331 method_headers.insert(OatQuickMethodHeader::FromCodePointer(data->GetCode()));
1332 it = jni_stubs_map_.erase(it);
1333 }
1334 }
Mingyao Yang063fc772016-08-02 11:02:54 -07001335 for (auto it = method_code_map_.begin(); it != method_code_map_.end();) {
1336 const void* code_ptr = it->first;
1337 uintptr_t allocation = FromCodeToAllocation(code_ptr);
1338 if (GetLiveBitmap()->Test(allocation)) {
1339 ++it;
1340 } else {
Alex Light2d441b12018-06-08 15:33:21 -07001341 OatQuickMethodHeader* header = OatQuickMethodHeader::FromCodePointer(code_ptr);
1342 method_headers.insert(header);
Mingyao Yang063fc772016-08-02 11:02:54 -07001343 it = method_code_map_.erase(it);
1344 }
Nicolas Geoffray35122442016-03-02 12:05:30 +00001345 }
1346 }
Mingyao Yang063fc772016-08-02 11:02:54 -07001347 FreeAllMethodHeaders(method_headers);
Nicolas Geoffray35122442016-03-02 12:05:30 +00001348}
1349
1350void JitCodeCache::DoCollection(Thread* self, bool collect_profiling_info) {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001351 ScopedTrace trace(__FUNCTION__);
Nicolas Geoffray35122442016-03-02 12:05:30 +00001352 {
1353 MutexLock mu(self, lock_);
1354 if (collect_profiling_info) {
1355 // Clear the profiling info of methods that do not have compiled code as entrypoint.
1356 // Also remove the saved entry point from the ProfilingInfo objects.
1357 for (ProfilingInfo* info : profiling_infos_) {
1358 const void* ptr = info->GetMethod()->GetEntryPointFromQuickCompiledCode();
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001359 if (!ContainsPc(ptr) && !info->IsInUseByCompiler()) {
Nicolas Geoffray35122442016-03-02 12:05:30 +00001360 info->GetMethod()->SetProfilingInfo(nullptr);
1361 }
Nicolas Geoffrayb9a639d2016-03-22 11:25:20 +00001362
1363 if (info->GetSavedEntryPoint() != nullptr) {
1364 info->SetSavedEntryPoint(nullptr);
1365 // We are going to move this method back to interpreter. Clear the counter now to
Mathieu Chartierf044c222017-05-31 15:27:54 -07001366 // give it a chance to be hot again.
1367 ClearMethodCounter(info->GetMethod(), /*was_warm*/ true);
Nicolas Geoffrayb9a639d2016-03-22 11:25:20 +00001368 }
Nicolas Geoffray35122442016-03-02 12:05:30 +00001369 }
1370 } else if (kIsDebugBuild) {
1371 // Sanity check that the profiling infos do not have a dangling entry point.
1372 for (ProfilingInfo* info : profiling_infos_) {
1373 DCHECK(info->GetSavedEntryPoint() == nullptr);
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001374 }
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001375 }
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00001376
Nicolas Geoffray9abb2972016-03-04 14:32:59 +00001377 // Mark compiled code that are entrypoints of ArtMethods. Compiled code that is not
1378 // an entry point is either:
1379 // - an osr compiled code, that will be removed if not in a thread call stack.
1380 // - discarded compiled code, that will be removed if not in a thread call stack.
Vladimir Marko2196c652017-11-30 16:16:07 +00001381 for (const auto& entry : jni_stubs_map_) {
1382 const JniStubData& data = entry.second;
1383 const void* code_ptr = data.GetCode();
1384 const OatQuickMethodHeader* method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
1385 for (ArtMethod* method : data.GetMethods()) {
1386 if (method_header->GetEntryPoint() == method->GetEntryPointFromQuickCompiledCode()) {
1387 GetLiveBitmap()->AtomicTestAndSet(FromCodeToAllocation(code_ptr));
1388 break;
1389 }
1390 }
1391 }
Nicolas Geoffray9abb2972016-03-04 14:32:59 +00001392 for (const auto& it : method_code_map_) {
1393 ArtMethod* method = it.second;
1394 const void* code_ptr = it.first;
1395 const OatQuickMethodHeader* method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
1396 if (method_header->GetEntryPoint() == method->GetEntryPointFromQuickCompiledCode()) {
1397 GetLiveBitmap()->AtomicTestAndSet(FromCodeToAllocation(code_ptr));
1398 }
1399 }
1400
Nicolas Geoffrayd9994f02016-02-11 17:35:55 +00001401 // Empty osr method map, as osr compiled code will be deleted (except the ones
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00001402 // on thread stacks).
1403 osr_code_map_.clear();
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001404 }
1405
1406 // Run a checkpoint on all threads to mark the JIT compiled code they are running.
Nicolas Geoffray8d372502016-02-23 13:56:43 +00001407 MarkCompiledCodeOnThreadStacks(self);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001408
Nicolas Geoffray9abb2972016-03-04 14:32:59 +00001409 // At this point, mutator threads are still running, and entrypoints of methods can
1410 // change. We do know they cannot change to a code cache entry that is not marked,
1411 // therefore we can safely remove those entries.
1412 RemoveUnmarkedCode(self);
Nicolas Geoffraya96917a2016-03-01 22:18:02 +00001413
Nicolas Geoffray35122442016-03-02 12:05:30 +00001414 if (collect_profiling_info) {
1415 MutexLock mu(self, lock_);
1416 // Free all profiling infos of methods not compiled nor being compiled.
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001417 auto profiling_kept_end = std::remove_if(profiling_infos_.begin(), profiling_infos_.end(),
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001418 [this] (ProfilingInfo* info) NO_THREAD_SAFETY_ANALYSIS {
Nicolas Geoffray35122442016-03-02 12:05:30 +00001419 const void* ptr = info->GetMethod()->GetEntryPointFromQuickCompiledCode();
Nicolas Geoffray511e41b2016-03-02 17:09:35 +00001420 // We have previously cleared the ProfilingInfo pointer in the ArtMethod in the hope
1421 // that the compiled code would not get revived. As mutator threads run concurrently,
1422 // they may have revived the compiled code, and now we are in the situation where
1423 // a method has compiled code but no ProfilingInfo.
1424 // We make sure compiled methods have a ProfilingInfo object. It is needed for
1425 // code cache collection.
Andreas Gampe542451c2016-07-26 09:02:02 -07001426 if (ContainsPc(ptr) &&
1427 info->GetMethod()->GetProfilingInfo(kRuntimePointerSize) == nullptr) {
Nicolas Geoffray35122442016-03-02 12:05:30 +00001428 info->GetMethod()->SetProfilingInfo(info);
Andreas Gampe542451c2016-07-26 09:02:02 -07001429 } else if (info->GetMethod()->GetProfilingInfo(kRuntimePointerSize) != info) {
Nicolas Geoffray35122442016-03-02 12:05:30 +00001430 // No need for this ProfilingInfo object anymore.
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001431 FreeData(reinterpret_cast<uint8_t*>(info));
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001432 return true;
1433 }
1434 return false;
1435 });
1436 profiling_infos_.erase(profiling_kept_end, profiling_infos_.end());
Nicolas Geoffray35122442016-03-02 12:05:30 +00001437 DCHECK(CheckLiveCompiledCodeHasProfilingInfo());
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001438 }
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001439}
1440
Nicolas Geoffray35122442016-03-02 12:05:30 +00001441bool JitCodeCache::CheckLiveCompiledCodeHasProfilingInfo() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001442 ScopedTrace trace(__FUNCTION__);
Nicolas Geoffray35122442016-03-02 12:05:30 +00001443 // Check that methods we have compiled do have a ProfilingInfo object. We would
1444 // have memory leaks of compiled code otherwise.
1445 for (const auto& it : method_code_map_) {
1446 ArtMethod* method = it.second;
Andreas Gampe542451c2016-07-26 09:02:02 -07001447 if (method->GetProfilingInfo(kRuntimePointerSize) == nullptr) {
Nicolas Geoffray35122442016-03-02 12:05:30 +00001448 const void* code_ptr = it.first;
1449 const OatQuickMethodHeader* method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
1450 if (method_header->GetEntryPoint() == method->GetEntryPointFromQuickCompiledCode()) {
1451 // If the code is not dead, then we have a problem. Note that this can even
1452 // happen just after a collection, as mutator threads are running in parallel
1453 // and could deoptimize an existing compiled code.
1454 return false;
1455 }
1456 }
1457 }
1458 return true;
1459}
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001460
1461OatQuickMethodHeader* JitCodeCache::LookupMethodHeader(uintptr_t pc, ArtMethod* method) {
Vladimir Marko33bff252017-11-01 14:35:42 +00001462 static_assert(kRuntimeISA != InstructionSet::kThumb2, "kThumb2 cannot be a runtime ISA");
1463 if (kRuntimeISA == InstructionSet::kArm) {
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001464 // On Thumb-2, the pc is offset by one.
1465 --pc;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001466 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001467 if (!ContainsPc(reinterpret_cast<const void*>(pc))) {
1468 return nullptr;
1469 }
1470
Vladimir Marko2196c652017-11-30 16:16:07 +00001471 if (!kIsDebugBuild) {
1472 // Called with null `method` only from MarkCodeClosure::Run() in debug build.
1473 CHECK(method != nullptr);
Vladimir Marko47d31852017-11-28 18:36:12 +00001474 }
Vladimir Markoe7441632017-11-29 13:00:56 +00001475
Vladimir Marko2196c652017-11-30 16:16:07 +00001476 MutexLock mu(Thread::Current(), lock_);
1477 OatQuickMethodHeader* method_header = nullptr;
1478 ArtMethod* found_method = nullptr; // Only for DCHECK(), not for JNI stubs.
1479 if (method != nullptr && UNLIKELY(method->IsNative())) {
1480 auto it = jni_stubs_map_.find(JniStubKey(method));
1481 if (it == jni_stubs_map_.end() || !ContainsElement(it->second.GetMethods(), method)) {
1482 return nullptr;
1483 }
1484 const void* code_ptr = it->second.GetCode();
1485 method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
1486 if (!method_header->Contains(pc)) {
1487 return nullptr;
1488 }
1489 } else {
1490 auto it = method_code_map_.lower_bound(reinterpret_cast<const void*>(pc));
1491 if (it != method_code_map_.begin()) {
1492 --it;
1493 const void* code_ptr = it->first;
1494 if (OatQuickMethodHeader::FromCodePointer(code_ptr)->Contains(pc)) {
1495 method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
1496 found_method = it->second;
1497 }
1498 }
1499 if (method_header == nullptr && method == nullptr) {
1500 // Scan all compiled JNI stubs as well. This slow search is used only
1501 // for checks in debug build, for release builds the `method` is not null.
1502 for (auto&& entry : jni_stubs_map_) {
1503 const JniStubData& data = entry.second;
1504 if (data.IsCompiled() &&
1505 OatQuickMethodHeader::FromCodePointer(data.GetCode())->Contains(pc)) {
1506 method_header = OatQuickMethodHeader::FromCodePointer(data.GetCode());
1507 }
1508 }
1509 }
1510 if (method_header == nullptr) {
1511 return nullptr;
1512 }
Nicolas Geoffray056d7752017-11-30 09:12:13 +00001513 }
Vladimir Marko2196c652017-11-30 16:16:07 +00001514
1515 if (kIsDebugBuild && method != nullptr && !method->IsNative()) {
Alex Light1ebe4fe2017-01-30 14:57:11 -08001516 // When we are walking the stack to redefine classes and creating obsolete methods it is
1517 // possible that we might have updated the method_code_map by making this method obsolete in a
1518 // previous frame. Therefore we should just check that the non-obsolete version of this method
1519 // is the one we expect. We change to the non-obsolete versions in the error message since the
1520 // obsolete version of the method might not be fully initialized yet. This situation can only
1521 // occur when we are in the process of allocating and setting up obsolete methods. Otherwise
Andreas Gampe06c42a52017-07-26 14:17:14 -07001522 // method and it->second should be identical. (See openjdkjvmti/ti_redefine.cc for more
Alex Light1ebe4fe2017-01-30 14:57:11 -08001523 // information.)
Vladimir Marko2196c652017-11-30 16:16:07 +00001524 DCHECK_EQ(found_method->GetNonObsoleteMethod(), method->GetNonObsoleteMethod())
Alex Light1ebe4fe2017-01-30 14:57:11 -08001525 << ArtMethod::PrettyMethod(method->GetNonObsoleteMethod()) << " "
Vladimir Marko2196c652017-11-30 16:16:07 +00001526 << ArtMethod::PrettyMethod(found_method->GetNonObsoleteMethod()) << " "
David Sehr709b0702016-10-13 09:12:37 -07001527 << std::hex << pc;
Nicolas Geoffray5a23d2e2015-11-03 18:58:57 +00001528 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +01001529 return method_header;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001530}
1531
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00001532OatQuickMethodHeader* JitCodeCache::LookupOsrMethodHeader(ArtMethod* method) {
1533 MutexLock mu(Thread::Current(), lock_);
1534 auto it = osr_code_map_.find(method);
1535 if (it == osr_code_map_.end()) {
1536 return nullptr;
1537 }
1538 return OatQuickMethodHeader::FromCodePointer(it->second);
1539}
1540
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001541ProfilingInfo* JitCodeCache::AddProfilingInfo(Thread* self,
1542 ArtMethod* method,
1543 const std::vector<uint32_t>& entries,
Nicolas Geoffray1e7da9b2016-03-01 14:11:40 +00001544 bool retry_allocation)
1545 // No thread safety analysis as we are using TryLock/Unlock explicitly.
1546 NO_THREAD_SAFETY_ANALYSIS {
1547 ProfilingInfo* info = nullptr;
1548 if (!retry_allocation) {
1549 // If we are allocating for the interpreter, just try to lock, to avoid
1550 // lock contention with the JIT.
1551 if (lock_.ExclusiveTryLock(self)) {
1552 info = AddProfilingInfoInternal(self, method, entries);
1553 lock_.ExclusiveUnlock(self);
1554 }
1555 } else {
1556 {
1557 MutexLock mu(self, lock_);
1558 info = AddProfilingInfoInternal(self, method, entries);
1559 }
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001560
Nicolas Geoffray1e7da9b2016-03-01 14:11:40 +00001561 if (info == nullptr) {
1562 GarbageCollectCache(self);
1563 MutexLock mu(self, lock_);
1564 info = AddProfilingInfoInternal(self, method, entries);
1565 }
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001566 }
1567 return info;
1568}
1569
Nicolas Geoffray1e7da9b2016-03-01 14:11:40 +00001570ProfilingInfo* JitCodeCache::AddProfilingInfoInternal(Thread* self ATTRIBUTE_UNUSED,
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001571 ArtMethod* method,
1572 const std::vector<uint32_t>& entries) {
1573 size_t profile_info_size = RoundUp(
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001574 sizeof(ProfilingInfo) + sizeof(InlineCache) * entries.size(),
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001575 sizeof(void*));
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001576
1577 // Check whether some other thread has concurrently created it.
Andreas Gampe542451c2016-07-26 09:02:02 -07001578 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001579 if (info != nullptr) {
1580 return info;
1581 }
1582
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001583 uint8_t* data = AllocateData(profile_info_size);
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001584 if (data == nullptr) {
1585 return nullptr;
1586 }
1587 info = new (data) ProfilingInfo(method, entries);
Nicolas Geoffray07f35642016-01-04 16:06:51 +00001588
1589 // Make sure other threads see the data in the profiling info object before the
1590 // store in the ArtMethod's ProfilingInfo pointer.
Orion Hodson27b96762018-03-13 16:06:57 +00001591 std::atomic_thread_fence(std::memory_order_release);
Nicolas Geoffray07f35642016-01-04 16:06:51 +00001592
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001593 method->SetProfilingInfo(info);
1594 profiling_infos_.push_back(info);
Nicolas Geoffray933330a2016-03-16 14:20:06 +00001595 histogram_profiling_info_memory_use_.AddValue(profile_info_size);
Nicolas Geoffray26705e22015-10-28 12:50:11 +00001596 return info;
1597}
1598
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001599// NO_THREAD_SAFETY_ANALYSIS as this is called from mspace code, at which point the lock
1600// is already held.
1601void* JitCodeCache::MoreCore(const void* mspace, intptr_t increment) NO_THREAD_SAFETY_ANALYSIS {
1602 if (code_mspace_ == mspace) {
1603 size_t result = code_end_;
1604 code_end_ += increment;
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001605 return reinterpret_cast<void*>(result + code_map_.Begin());
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001606 } else {
1607 DCHECK_EQ(data_mspace_, mspace);
1608 size_t result = data_end_;
1609 data_end_ += increment;
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001610 return reinterpret_cast<void*>(result + data_map_.Begin());
Nicolas Geoffray0a3be162015-11-18 11:15:22 +00001611 }
1612}
1613
Calin Juravle99629622016-04-19 16:33:46 +01001614void JitCodeCache::GetProfiledMethods(const std::set<std::string>& dex_base_locations,
Calin Juravle940eb0c2017-01-30 19:30:44 -08001615 std::vector<ProfileMethodInfo>& methods) {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001616 ScopedTrace trace(__FUNCTION__);
Calin Juravle31f2c152015-10-23 17:56:15 +01001617 MutexLock mu(Thread::Current(), lock_);
Calin Juravlea39fd982017-05-18 10:15:52 -07001618 uint16_t jit_compile_threshold = Runtime::Current()->GetJITOptions()->GetCompileThreshold();
Calin Juravle99629622016-04-19 16:33:46 +01001619 for (const ProfilingInfo* info : profiling_infos_) {
1620 ArtMethod* method = info->GetMethod();
1621 const DexFile* dex_file = method->GetDexFile();
Mathieu Chartier79c87da2017-10-10 11:54:29 -07001622 const std::string base_location = DexFileLoader::GetBaseLocation(dex_file->GetLocation());
1623 if (!ContainsElement(dex_base_locations, base_location)) {
Calin Juravle940eb0c2017-01-30 19:30:44 -08001624 // Skip dex files which are not profiled.
1625 continue;
Calin Juravle31f2c152015-10-23 17:56:15 +01001626 }
Calin Juravle940eb0c2017-01-30 19:30:44 -08001627 std::vector<ProfileMethodInfo::ProfileInlineCache> inline_caches;
Calin Juravlea39fd982017-05-18 10:15:52 -07001628
1629 // If the method didn't reach the compilation threshold don't save the inline caches.
1630 // They might be incomplete and cause unnecessary deoptimizations.
1631 // If the inline cache is empty the compiler will generate a regular invoke virtual/interface.
1632 if (method->GetCounter() < jit_compile_threshold) {
1633 methods.emplace_back(/*ProfileMethodInfo*/
Mathieu Chartierbbe3a5e2017-06-13 16:36:17 -07001634 MethodReference(dex_file, method->GetDexMethodIndex()), inline_caches);
Calin Juravlea39fd982017-05-18 10:15:52 -07001635 continue;
1636 }
1637
Calin Juravle940eb0c2017-01-30 19:30:44 -08001638 for (size_t i = 0; i < info->number_of_inline_caches_; ++i) {
Mathieu Chartierdbddc222017-05-24 12:04:13 -07001639 std::vector<TypeReference> profile_classes;
Calin Juravle940eb0c2017-01-30 19:30:44 -08001640 const InlineCache& cache = info->cache_[i];
Calin Juravle13439f02017-02-21 01:17:21 -08001641 ArtMethod* caller = info->GetMethod();
Calin Juravle589e71e2017-03-03 16:05:05 -08001642 bool is_missing_types = false;
Calin Juravle940eb0c2017-01-30 19:30:44 -08001643 for (size_t k = 0; k < InlineCache::kIndividualCacheSize; k++) {
1644 mirror::Class* cls = cache.classes_[k].Read();
1645 if (cls == nullptr) {
1646 break;
1647 }
Calin Juravle4ca70a32017-02-21 16:22:24 -08001648
Calin Juravle13439f02017-02-21 01:17:21 -08001649 // Check if the receiver is in the boot class path or if it's in the
1650 // same class loader as the caller. If not, skip it, as there is not
1651 // much we can do during AOT.
1652 if (!cls->IsBootStrapClassLoaded() &&
1653 caller->GetClassLoader() != cls->GetClassLoader()) {
1654 is_missing_types = true;
1655 continue;
1656 }
1657
Calin Juravle4ca70a32017-02-21 16:22:24 -08001658 const DexFile* class_dex_file = nullptr;
1659 dex::TypeIndex type_index;
1660
1661 if (cls->GetDexCache() == nullptr) {
1662 DCHECK(cls->IsArrayClass()) << cls->PrettyClass();
Calin Juravlee21806f2017-02-22 11:49:43 -08001663 // Make a best effort to find the type index in the method's dex file.
1664 // We could search all open dex files but that might turn expensive
1665 // and probably not worth it.
Calin Juravle4ca70a32017-02-21 16:22:24 -08001666 class_dex_file = dex_file;
1667 type_index = cls->FindTypeIndexInOtherDexFile(*dex_file);
1668 } else {
1669 class_dex_file = &(cls->GetDexFile());
1670 type_index = cls->GetDexTypeIndex();
1671 }
1672 if (!type_index.IsValid()) {
1673 // Could be a proxy class or an array for which we couldn't find the type index.
Calin Juravle589e71e2017-03-03 16:05:05 -08001674 is_missing_types = true;
Calin Juravle4ca70a32017-02-21 16:22:24 -08001675 continue;
1676 }
Mathieu Chartier79c87da2017-10-10 11:54:29 -07001677 if (ContainsElement(dex_base_locations,
1678 DexFileLoader::GetBaseLocation(class_dex_file->GetLocation()))) {
Calin Juravle940eb0c2017-01-30 19:30:44 -08001679 // Only consider classes from the same apk (including multidex).
1680 profile_classes.emplace_back(/*ProfileMethodInfo::ProfileClassReference*/
Calin Juravle4ca70a32017-02-21 16:22:24 -08001681 class_dex_file, type_index);
Calin Juravle589e71e2017-03-03 16:05:05 -08001682 } else {
1683 is_missing_types = true;
Calin Juravle940eb0c2017-01-30 19:30:44 -08001684 }
1685 }
1686 if (!profile_classes.empty()) {
1687 inline_caches.emplace_back(/*ProfileMethodInfo::ProfileInlineCache*/
Calin Juravle589e71e2017-03-03 16:05:05 -08001688 cache.dex_pc_, is_missing_types, profile_classes);
Calin Juravle940eb0c2017-01-30 19:30:44 -08001689 }
1690 }
1691 methods.emplace_back(/*ProfileMethodInfo*/
Mathieu Chartierbbe3a5e2017-06-13 16:36:17 -07001692 MethodReference(dex_file, method->GetDexMethodIndex()), inline_caches);
Calin Juravle31f2c152015-10-23 17:56:15 +01001693 }
1694}
1695
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +01001696bool JitCodeCache::IsOsrCompiled(ArtMethod* method) {
1697 MutexLock mu(Thread::Current(), lock_);
1698 return osr_code_map_.find(method) != osr_code_map_.end();
1699}
1700
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00001701bool JitCodeCache::NotifyCompilationOf(ArtMethod* method, Thread* self, bool osr) {
1702 if (!osr && ContainsPc(method->GetEntryPointFromQuickCompiledCode())) {
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001703 return false;
1704 }
Nicolas Geoffraya42363f2015-12-17 14:57:09 +00001705
Nicolas Geoffraya42363f2015-12-17 14:57:09 +00001706 MutexLock mu(self, lock_);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00001707 if (osr && (osr_code_map_.find(method) != osr_code_map_.end())) {
1708 return false;
1709 }
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001710
Vladimir Marko2196c652017-11-30 16:16:07 +00001711 if (UNLIKELY(method->IsNative())) {
1712 JniStubKey key(method);
1713 auto it = jni_stubs_map_.find(key);
1714 bool new_compilation = false;
1715 if (it == jni_stubs_map_.end()) {
1716 // Create a new entry to mark the stub as being compiled.
1717 it = jni_stubs_map_.Put(key, JniStubData{});
1718 new_compilation = true;
1719 }
1720 JniStubData* data = &it->second;
1721 data->AddMethod(method);
1722 if (data->IsCompiled()) {
1723 OatQuickMethodHeader* method_header = OatQuickMethodHeader::FromCodePointer(data->GetCode());
1724 const void* entrypoint = method_header->GetEntryPoint();
1725 // Update also entrypoints of other methods held by the JniStubData.
1726 // We could simply update the entrypoint of `method` but if the last JIT GC has
1727 // changed these entrypoints to GenericJNI in preparation for a full GC, we may
1728 // as well change them back as this stub shall not be collected anyway and this
1729 // can avoid a few expensive GenericJNI calls.
1730 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
1731 for (ArtMethod* m : data->GetMethods()) {
Nicolas Geoffraya6e0e7d2018-01-26 13:16:50 +00001732 // Call the dedicated method instead of the more generic UpdateMethodsCode, because
1733 // `m` might be in the process of being deleted.
1734 instrumentation->UpdateNativeMethodsCodeToJitCode(m, entrypoint);
Vladimir Marko2196c652017-11-30 16:16:07 +00001735 }
1736 if (collection_in_progress_) {
1737 GetLiveBitmap()->AtomicTestAndSet(FromCodeToAllocation(data->GetCode()));
1738 }
1739 }
1740 return new_compilation;
1741 } else {
1742 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
1743 if (info == nullptr) {
1744 VLOG(jit) << method->PrettyMethod() << " needs a ProfilingInfo to be compiled";
1745 // Because the counter is not atomic, there are some rare cases where we may not hit the
1746 // threshold for creating the ProfilingInfo. Reset the counter now to "correct" this.
1747 ClearMethodCounter(method, /*was_warm*/ false);
1748 return false;
1749 }
Nicolas Geoffray056d7752017-11-30 09:12:13 +00001750
Vladimir Marko2196c652017-11-30 16:16:07 +00001751 if (info->IsMethodBeingCompiled(osr)) {
1752 return false;
1753 }
Nicolas Geoffray056d7752017-11-30 09:12:13 +00001754
Vladimir Marko2196c652017-11-30 16:16:07 +00001755 info->SetIsMethodBeingCompiled(true, osr);
1756 return true;
1757 }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001758}
1759
Nicolas Geoffray07e3ca92016-03-11 09:57:57 +00001760ProfilingInfo* JitCodeCache::NotifyCompilerUse(ArtMethod* method, Thread* self) {
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001761 MutexLock mu(self, lock_);
Andreas Gampe542451c2016-07-26 09:02:02 -07001762 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001763 if (info != nullptr) {
Nicolas Geoffrayf6d46682017-02-28 17:41:45 +00001764 if (!info->IncrementInlineUse()) {
1765 // Overflow of inlining uses, just bail.
1766 return nullptr;
1767 }
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001768 }
Nicolas Geoffray07e3ca92016-03-11 09:57:57 +00001769 return info;
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001770}
1771
Nicolas Geoffray07e3ca92016-03-11 09:57:57 +00001772void JitCodeCache::DoneCompilerUse(ArtMethod* method, Thread* self) {
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001773 MutexLock mu(self, lock_);
Andreas Gampe542451c2016-07-26 09:02:02 -07001774 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
Nicolas Geoffray07e3ca92016-03-11 09:57:57 +00001775 DCHECK(info != nullptr);
1776 info->DecrementInlineUse();
Nicolas Geoffrayb6e20ae2016-03-07 14:29:04 +00001777}
1778
Vladimir Marko2196c652017-11-30 16:16:07 +00001779void JitCodeCache::DoneCompiling(ArtMethod* method, Thread* self, bool osr) {
1780 DCHECK_EQ(Thread::Current(), self);
1781 MutexLock mu(self, lock_);
1782 if (UNLIKELY(method->IsNative())) {
1783 auto it = jni_stubs_map_.find(JniStubKey(method));
1784 DCHECK(it != jni_stubs_map_.end());
1785 JniStubData* data = &it->second;
1786 DCHECK(ContainsElement(data->GetMethods(), method));
1787 if (UNLIKELY(!data->IsCompiled())) {
1788 // Failed to compile; the JNI compiler never fails, but the cache may be full.
1789 jni_stubs_map_.erase(it); // Remove the entry added in NotifyCompilationOf().
1790 } // else CommitCodeInternal() updated entrypoints of all methods in the JniStubData.
1791 } else {
1792 ProfilingInfo* info = method->GetProfilingInfo(kRuntimePointerSize);
1793 DCHECK(info->IsMethodBeingCompiled(osr));
1794 info->SetIsMethodBeingCompiled(false, osr);
1795 }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01001796}
1797
Nicolas Geoffraya25dce92016-01-12 16:41:10 +00001798size_t JitCodeCache::GetMemorySizeOfCodePointer(const void* ptr) {
1799 MutexLock mu(Thread::Current(), lock_);
1800 return mspace_usable_size(reinterpret_cast<const void*>(FromCodeToAllocation(ptr)));
1801}
1802
Nicolas Geoffrayb88d59e2016-02-17 11:31:49 +00001803void JitCodeCache::InvalidateCompiledCodeFor(ArtMethod* method,
1804 const OatQuickMethodHeader* header) {
Vladimir Marko2196c652017-11-30 16:16:07 +00001805 DCHECK(!method->IsNative());
Andreas Gampe542451c2016-07-26 09:02:02 -07001806 ProfilingInfo* profiling_info = method->GetProfilingInfo(kRuntimePointerSize);
Alex Light2d441b12018-06-08 15:33:21 -07001807 const void* method_entrypoint = method->GetEntryPointFromQuickCompiledCode();
Nicolas Geoffray35122442016-03-02 12:05:30 +00001808 if ((profiling_info != nullptr) &&
1809 (profiling_info->GetSavedEntryPoint() == header->GetEntryPoint())) {
Alex Light2d441b12018-06-08 15:33:21 -07001810 // When instrumentation is set, the actual entrypoint is the one in the profiling info.
1811 method_entrypoint = profiling_info->GetSavedEntryPoint();
Nicolas Geoffray35122442016-03-02 12:05:30 +00001812 // Prevent future uses of the compiled code.
1813 profiling_info->SetSavedEntryPoint(nullptr);
1814 }
1815
Alex Light2d441b12018-06-08 15:33:21 -07001816 // Clear the method counter if we are running jitted code since we might want to jit this again in
1817 // the future.
1818 if (method_entrypoint == header->GetEntryPoint()) {
Jeff Hao00286db2017-05-30 16:53:07 -07001819 // The entrypoint is the one to invalidate, so we just update it to the interpreter entry point
Mathieu Chartierf044c222017-05-31 15:27:54 -07001820 // and clear the counter to get the method Jitted again.
Nicolas Geoffrayb88d59e2016-02-17 11:31:49 +00001821 Runtime::Current()->GetInstrumentation()->UpdateMethodsCode(
1822 method, GetQuickToInterpreterBridge());
Mathieu Chartierf044c222017-05-31 15:27:54 -07001823 ClearMethodCounter(method, /*was_warm*/ profiling_info != nullptr);
Nicolas Geoffrayb88d59e2016-02-17 11:31:49 +00001824 } else {
1825 MutexLock mu(Thread::Current(), lock_);
1826 auto it = osr_code_map_.find(method);
1827 if (it != osr_code_map_.end() && OatQuickMethodHeader::FromCodePointer(it->second) == header) {
1828 // Remove the OSR method, to avoid using it again.
1829 osr_code_map_.erase(it);
1830 }
1831 }
1832}
1833
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001834uint8_t* JitCodeCache::AllocateCode(size_t code_size) {
1835 size_t alignment = GetInstructionSetAlignment(kRuntimeISA);
1836 uint8_t* result = reinterpret_cast<uint8_t*>(
1837 mspace_memalign(code_mspace_, alignment, code_size));
1838 size_t header_size = RoundUp(sizeof(OatQuickMethodHeader), alignment);
1839 // Ensure the header ends up at expected instruction alignment.
1840 DCHECK_ALIGNED_PARAM(reinterpret_cast<uintptr_t>(result + header_size), alignment);
1841 used_memory_for_code_ += mspace_usable_size(result);
1842 return result;
1843}
1844
Orion Hodsondbd05fe2017-08-10 11:41:35 +01001845void JitCodeCache::FreeCode(uint8_t* code) {
1846 used_memory_for_code_ -= mspace_usable_size(code);
1847 mspace_free(code_mspace_, code);
Nicolas Geoffray38ea9bd2016-02-19 16:25:57 +00001848}
1849
1850uint8_t* JitCodeCache::AllocateData(size_t data_size) {
1851 void* result = mspace_malloc(data_mspace_, data_size);
1852 used_memory_for_data_ += mspace_usable_size(result);
1853 return reinterpret_cast<uint8_t*>(result);
1854}
1855
1856void JitCodeCache::FreeData(uint8_t* data) {
1857 used_memory_for_data_ -= mspace_usable_size(data);
1858 mspace_free(data_mspace_, data);
1859}
1860
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001861void JitCodeCache::Dump(std::ostream& os) {
1862 MutexLock mu(Thread::Current(), lock_);
David Srbeckyfb3de3d2018-01-29 16:11:49 +00001863 MutexLock mu2(Thread::Current(), *Locks::native_debug_interface_lock_);
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001864 os << "Current JIT code cache size: " << PrettySize(used_memory_for_code_) << "\n"
1865 << "Current JIT data cache size: " << PrettySize(used_memory_for_data_) << "\n"
David Srbecky440a9b32018-02-15 17:47:29 +00001866 << "Current JIT mini-debug-info size: " << PrettySize(GetJitNativeDebugInfoMemUsage()) << "\n"
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001867 << "Current JIT capacity: " << PrettySize(current_capacity_) << "\n"
Vladimir Marko2196c652017-11-30 16:16:07 +00001868 << "Current number of JIT JNI stub entries: " << jni_stubs_map_.size() << "\n"
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001869 << "Current number of JIT code cache entries: " << method_code_map_.size() << "\n"
1870 << "Total number of JIT compilations: " << number_of_compilations_ << "\n"
1871 << "Total number of JIT compilations for on stack replacement: "
1872 << number_of_osr_compilations_ << "\n"
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001873 << "Total number of JIT code cache collections: " << number_of_collections_ << std::endl;
Nicolas Geoffray933330a2016-03-16 14:20:06 +00001874 histogram_stack_map_memory_use_.PrintMemoryUse(os);
1875 histogram_code_memory_use_.PrintMemoryUse(os);
1876 histogram_profiling_info_memory_use_.PrintMemoryUse(os);
Nicolas Geoffraybcd94c82016-03-03 13:23:33 +00001877}
1878
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001879} // namespace jit
1880} // namespace art