blob: 464c441e8e65ede0c82d6f71a3174be756ffb47c [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
Mathieu Chartiere401d142015-04-22 13:56:20 -070021#include "art_method-inl.h"
Calin Juravle66f55232015-12-08 15:09:10 +000022#include "base/stl_util.h"
Calin Juravle31f2c152015-10-23 17:56:15 +010023#include "base/time_utils.h"
David Srbecky5cc349f2015-12-18 15:04:48 +000024#include "debugger_interface.h"
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +010025#include "entrypoints/runtime_asm_entrypoints.h"
26#include "gc/accounting/bitmap-inl.h"
Nicolas Geoffray26705e22015-10-28 12:50:11 +000027#include "jit/profiling_info.h"
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +010028#include "linear_alloc.h"
Mathieu Chartiere5f13e52015-02-24 09:37:21 -080029#include "mem_map.h"
Mathieu Chartiere5f13e52015-02-24 09:37:21 -080030#include "oat_file-inl.h"
Nicolas Geoffray62623402015-10-28 19:15:05 +000031#include "scoped_thread_state_change.h"
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +010032#include "thread_list.h"
Mathieu Chartiere5f13e52015-02-24 09:37:21 -080033
34namespace art {
35namespace jit {
36
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +010037static constexpr int kProtAll = PROT_READ | PROT_WRITE | PROT_EXEC;
38static constexpr int kProtData = PROT_READ | PROT_WRITE;
39static constexpr int kProtCode = PROT_READ | PROT_EXEC;
40
41#define CHECKED_MPROTECT(memory, size, prot) \
42 do { \
43 int rc = mprotect(memory, size, prot); \
44 if (UNLIKELY(rc != 0)) { \
45 errno = rc; \
46 PLOG(FATAL) << "Failed to mprotect jit code cache"; \
47 } \
48 } while (false) \
49
Nicolas Geoffray0a3be162015-11-18 11:15:22 +000050JitCodeCache* JitCodeCache::Create(size_t initial_capacity,
51 size_t max_capacity,
Nicolas Geoffraya25dce92016-01-12 16:41:10 +000052 bool generate_debug_info,
Nicolas Geoffray0a3be162015-11-18 11:15:22 +000053 std::string* error_msg) {
54 CHECK_GE(max_capacity, initial_capacity);
Nicolas Geoffraya25dce92016-01-12 16:41:10 +000055
56 // Generating debug information is mostly for using the 'perf' tool, which does
57 // not work with ashmem.
58 bool use_ashmem = !generate_debug_info;
59 // With 'perf', we want a 1-1 mapping between an address and a method.
60 bool garbage_collect_code = !generate_debug_info;
61
Nicolas Geoffray0a3be162015-11-18 11:15:22 +000062 // We need to have 32 bit offsets from method headers in code cache which point to things
63 // in the data cache. If the maps are more than 4G apart, having multiple maps wouldn't work.
64 // Ensure we're below 1 GB to be safe.
65 if (max_capacity > 1 * GB) {
66 std::ostringstream oss;
67 oss << "Maxium code cache capacity is limited to 1 GB, "
68 << PrettySize(max_capacity) << " is too big";
69 *error_msg = oss.str();
70 return nullptr;
71 }
72
Mathieu Chartiere5f13e52015-02-24 09:37:21 -080073 std::string error_str;
74 // Map name specific for android_os_Debug.cpp accounting.
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +010075 MemMap* data_map = MemMap::MapAnonymous(
Nicolas Geoffraya25dce92016-01-12 16:41:10 +000076 "data-code-cache", nullptr, max_capacity, kProtAll, false, false, &error_str, use_ashmem);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +010077 if (data_map == nullptr) {
Mathieu Chartiere5f13e52015-02-24 09:37:21 -080078 std::ostringstream oss;
Nicolas Geoffray0a3be162015-11-18 11:15:22 +000079 oss << "Failed to create read write execute cache: " << error_str << " size=" << max_capacity;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -080080 *error_msg = oss.str();
81 return nullptr;
82 }
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +010083
Nicolas Geoffray0a3be162015-11-18 11:15:22 +000084 // Align both capacities to page size, as that's the unit mspaces use.
85 initial_capacity = RoundDown(initial_capacity, 2 * kPageSize);
86 max_capacity = RoundDown(max_capacity, 2 * kPageSize);
87
Nicolas Geoffray4e915fb2015-10-28 17:39:47 +000088 // Data cache is 1 / 2 of the map.
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +010089 // TODO: Make this variable?
Nicolas Geoffray0a3be162015-11-18 11:15:22 +000090 size_t data_size = max_capacity / 2;
91 size_t code_size = max_capacity - data_size;
92 DCHECK_EQ(code_size + data_size, max_capacity);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +010093 uint8_t* divider = data_map->Begin() + data_size;
94
Nicolas Geoffraya25dce92016-01-12 16:41:10 +000095 MemMap* code_map =
96 data_map->RemapAtEnd(divider, "jit-code-cache", kProtAll, &error_str, use_ashmem);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +010097 if (code_map == nullptr) {
98 std::ostringstream oss;
Nicolas Geoffray0a3be162015-11-18 11:15:22 +000099 oss << "Failed to create read write execute cache: " << error_str << " size=" << max_capacity;
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100100 *error_msg = oss.str();
101 return nullptr;
102 }
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100103 DCHECK_EQ(code_map->Begin(), divider);
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000104 data_size = initial_capacity / 2;
105 code_size = initial_capacity - data_size;
106 DCHECK_EQ(code_size + data_size, initial_capacity);
Nicolas Geoffraya25dce92016-01-12 16:41:10 +0000107 return new JitCodeCache(
Nicolas Geoffrayc3fec4c2016-01-14 16:16:35 +0000108 code_map, data_map, code_size, data_size, max_capacity, garbage_collect_code);
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800109}
110
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000111JitCodeCache::JitCodeCache(MemMap* code_map,
112 MemMap* data_map,
113 size_t initial_code_capacity,
114 size_t initial_data_capacity,
Nicolas Geoffraya25dce92016-01-12 16:41:10 +0000115 size_t max_capacity,
116 bool garbage_collect_code)
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100117 : lock_("Jit code cache", kJitCodeCacheLock),
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100118 lock_cond_("Jit code cache variable", lock_),
119 collection_in_progress_(false),
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100120 code_map_(code_map),
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000121 data_map_(data_map),
122 max_capacity_(max_capacity),
123 current_capacity_(initial_code_capacity + initial_data_capacity),
124 code_end_(initial_code_capacity),
125 data_end_(initial_data_capacity),
Calin Juravle31f2c152015-10-23 17:56:15 +0100126 has_done_one_collection_(false),
Nicolas Geoffraya25dce92016-01-12 16:41:10 +0000127 last_update_time_ns_(0),
Nicolas Geoffray0a522232016-01-19 09:34:58 +0000128 garbage_collect_code_(garbage_collect_code),
129 number_of_compilations_(0) {
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100130
Nicolas Geoffrayc3fec4c2016-01-14 16:16:35 +0000131 DCHECK_GE(max_capacity, initial_code_capacity + initial_data_capacity);
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000132 code_mspace_ = create_mspace_with_base(code_map_->Begin(), code_end_, false /*locked*/);
133 data_mspace_ = create_mspace_with_base(data_map_->Begin(), data_end_, false /*locked*/);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100134
135 if (code_mspace_ == nullptr || data_mspace_ == nullptr) {
136 PLOG(FATAL) << "create_mspace_with_base failed";
137 }
138
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000139 SetFootprintLimit(current_capacity_);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100140
141 CHECKED_MPROTECT(code_map_->Begin(), code_map_->Size(), kProtCode);
142 CHECKED_MPROTECT(data_map_->Begin(), data_map_->Size(), kProtData);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100143
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000144 VLOG(jit) << "Created jit code cache: initial data size="
145 << PrettySize(initial_data_capacity)
146 << ", initial code size="
147 << PrettySize(initial_code_capacity);
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800148}
149
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100150bool JitCodeCache::ContainsPc(const void* ptr) const {
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100151 return code_map_->Begin() <= ptr && ptr < code_map_->End();
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800152}
153
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000154bool JitCodeCache::ContainsMethod(ArtMethod* method) {
155 MutexLock mu(Thread::Current(), lock_);
156 for (auto& it : method_code_map_) {
157 if (it.second == method) {
158 return true;
159 }
160 }
161 return false;
162}
163
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100164class ScopedCodeCacheWrite {
165 public:
166 explicit ScopedCodeCacheWrite(MemMap* code_map) : code_map_(code_map) {
167 CHECKED_MPROTECT(code_map_->Begin(), code_map_->Size(), kProtAll);
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800168 }
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100169 ~ScopedCodeCacheWrite() {
170 CHECKED_MPROTECT(code_map_->Begin(), code_map_->Size(), kProtCode);
171 }
172 private:
173 MemMap* const code_map_;
174
175 DISALLOW_COPY_AND_ASSIGN(ScopedCodeCacheWrite);
176};
177
178uint8_t* JitCodeCache::CommitCode(Thread* self,
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100179 ArtMethod* method,
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100180 const uint8_t* mapping_table,
181 const uint8_t* vmap_table,
182 const uint8_t* gc_map,
183 size_t frame_size_in_bytes,
184 size_t core_spill_mask,
185 size_t fp_spill_mask,
186 const uint8_t* code,
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000187 size_t code_size,
188 bool osr) {
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100189 uint8_t* result = CommitCodeInternal(self,
190 method,
191 mapping_table,
192 vmap_table,
193 gc_map,
194 frame_size_in_bytes,
195 core_spill_mask,
196 fp_spill_mask,
197 code,
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000198 code_size,
199 osr);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100200 if (result == nullptr) {
201 // Retry.
202 GarbageCollectCache(self);
203 result = CommitCodeInternal(self,
204 method,
205 mapping_table,
206 vmap_table,
207 gc_map,
208 frame_size_in_bytes,
209 core_spill_mask,
210 fp_spill_mask,
211 code,
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000212 code_size,
213 osr);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100214 }
215 return result;
216}
217
218bool JitCodeCache::WaitForPotentialCollectionToComplete(Thread* self) {
219 bool in_collection = false;
220 while (collection_in_progress_) {
221 in_collection = true;
222 lock_cond_.Wait(self);
223 }
224 return in_collection;
225}
226
227static uintptr_t FromCodeToAllocation(const void* code) {
228 size_t alignment = GetInstructionSetAlignment(kRuntimeISA);
229 return reinterpret_cast<uintptr_t>(code) - RoundUp(sizeof(OatQuickMethodHeader), alignment);
230}
231
232void JitCodeCache::FreeCode(const void* code_ptr, ArtMethod* method ATTRIBUTE_UNUSED) {
233 uintptr_t allocation = FromCodeToAllocation(code_ptr);
234 const OatQuickMethodHeader* method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
235 const uint8_t* data = method_header->GetNativeGcMap();
David Srbecky5cc349f2015-12-18 15:04:48 +0000236 // Notify native debugger that we are about to remove the code.
237 // It does nothing if we are not using native debugger.
238 DeleteJITCodeEntryForAddress(reinterpret_cast<uintptr_t>(code_ptr));
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100239 if (data != nullptr) {
240 mspace_free(data_mspace_, const_cast<uint8_t*>(data));
241 }
242 data = method_header->GetMappingTable();
243 if (data != nullptr) {
244 mspace_free(data_mspace_, const_cast<uint8_t*>(data));
245 }
246 // Use the offset directly to prevent sanity check that the method is
247 // compiled with optimizing.
248 // TODO(ngeoffray): Clean up.
249 if (method_header->vmap_table_offset_ != 0) {
250 data = method_header->code_ - method_header->vmap_table_offset_;
251 mspace_free(data_mspace_, const_cast<uint8_t*>(data));
252 }
253 mspace_free(code_mspace_, reinterpret_cast<uint8_t*>(allocation));
254}
255
256void JitCodeCache::RemoveMethodsIn(Thread* self, const LinearAlloc& alloc) {
257 MutexLock mu(self, lock_);
258 // We do not check if a code cache GC is in progress, as this method comes
259 // with the classlinker_classes_lock_ held, and suspending ourselves could
260 // lead to a deadlock.
Nicolas Geoffray26705e22015-10-28 12:50:11 +0000261 {
262 ScopedCodeCacheWrite scc(code_map_.get());
263 for (auto it = method_code_map_.begin(); it != method_code_map_.end();) {
264 if (alloc.ContainsUnsafe(it->second)) {
265 FreeCode(it->first, it->second);
266 it = method_code_map_.erase(it);
267 } else {
268 ++it;
269 }
270 }
271 }
272 for (auto it = profiling_infos_.begin(); it != profiling_infos_.end();) {
273 ProfilingInfo* info = *it;
274 if (alloc.ContainsUnsafe(info->GetMethod())) {
275 info->GetMethod()->SetProfilingInfo(nullptr);
276 mspace_free(data_mspace_, reinterpret_cast<uint8_t*>(info));
277 it = profiling_infos_.erase(it);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100278 } else {
279 ++it;
280 }
281 }
282}
283
284uint8_t* JitCodeCache::CommitCodeInternal(Thread* self,
285 ArtMethod* method,
286 const uint8_t* mapping_table,
287 const uint8_t* vmap_table,
288 const uint8_t* gc_map,
289 size_t frame_size_in_bytes,
290 size_t core_spill_mask,
291 size_t fp_spill_mask,
292 const uint8_t* code,
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000293 size_t code_size,
294 bool osr) {
Nicolas Geoffray1e7de6c2015-10-21 12:07:31 +0100295 size_t alignment = GetInstructionSetAlignment(kRuntimeISA);
296 // Ensure the header ends up at expected instruction alignment.
297 size_t header_size = RoundUp(sizeof(OatQuickMethodHeader), alignment);
298 size_t total_size = header_size + code_size;
299
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100300 OatQuickMethodHeader* method_header = nullptr;
Nicolas Geoffray1e7de6c2015-10-21 12:07:31 +0100301 uint8_t* code_ptr = nullptr;
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100302 {
Nicolas Geoffrayd28b9692015-11-04 14:36:55 +0000303 ScopedThreadSuspension sts(self, kSuspended);
304 MutexLock mu(self, lock_);
305 WaitForPotentialCollectionToComplete(self);
306 {
307 ScopedCodeCacheWrite scc(code_map_.get());
308 uint8_t* result = reinterpret_cast<uint8_t*>(
309 mspace_memalign(code_mspace_, alignment, total_size));
310 if (result == nullptr) {
311 return nullptr;
312 }
313 code_ptr = result + header_size;
314 DCHECK_ALIGNED_PARAM(reinterpret_cast<uintptr_t>(code_ptr), alignment);
315
316 std::copy(code, code + code_size, code_ptr);
317 method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
318 new (method_header) OatQuickMethodHeader(
319 (mapping_table == nullptr) ? 0 : code_ptr - mapping_table,
320 (vmap_table == nullptr) ? 0 : code_ptr - vmap_table,
321 (gc_map == nullptr) ? 0 : code_ptr - gc_map,
322 frame_size_in_bytes,
323 core_spill_mask,
324 fp_spill_mask,
325 code_size);
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100326 }
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100327
Roland Levillain32430262016-02-01 15:23:20 +0000328 FlushInstructionCache(reinterpret_cast<char*>(code_ptr),
329 reinterpret_cast<char*>(code_ptr + code_size));
Nicolas Geoffray0a522232016-01-19 09:34:58 +0000330 number_of_compilations_++;
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100331 }
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000332 // We need to update the entry point in the runnable state for the instrumentation.
333 {
334 MutexLock mu(self, lock_);
335 method_code_map_.Put(code_ptr, method);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000336 if (osr) {
337 osr_code_map_.Put(method, code_ptr);
338 } else {
339 Runtime::Current()->GetInstrumentation()->UpdateMethodsCode(
340 method, method_header->GetEntryPoint());
341 }
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000342 if (collection_in_progress_) {
343 // We need to update the live bitmap if there is a GC to ensure it sees this new
344 // code.
345 GetLiveBitmap()->AtomicTestAndSet(FromCodeToAllocation(code_ptr));
346 }
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000347 last_update_time_ns_.StoreRelease(NanoTime());
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000348 VLOG(jit)
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000349 << "JIT added (osr = " << std::boolalpha << osr << std::noboolalpha << ") "
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000350 << PrettyMethod(method) << "@" << method
351 << " ccache_size=" << PrettySize(CodeCacheSizeLocked()) << ": "
352 << " dcache_size=" << PrettySize(DataCacheSizeLocked()) << ": "
353 << reinterpret_cast<const void*>(method_header->GetEntryPoint()) << ","
354 << reinterpret_cast<const void*>(method_header->GetEntryPoint() + method_header->code_size_);
355 }
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100356
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100357 return reinterpret_cast<uint8_t*>(method_header);
358}
359
Nicolas Geoffray0a522232016-01-19 09:34:58 +0000360size_t JitCodeCache::NumberOfCompilations() {
361 MutexLock mu(Thread::Current(), lock_);
362 return number_of_compilations_;
363}
364
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100365size_t JitCodeCache::CodeCacheSize() {
366 MutexLock mu(Thread::Current(), lock_);
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000367 return CodeCacheSizeLocked();
368}
369
370size_t JitCodeCache::CodeCacheSizeLocked() {
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100371 size_t bytes_allocated = 0;
372 mspace_inspect_all(code_mspace_, DlmallocBytesAllocatedCallback, &bytes_allocated);
373 return bytes_allocated;
374}
375
376size_t JitCodeCache::DataCacheSize() {
377 MutexLock mu(Thread::Current(), lock_);
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000378 return DataCacheSizeLocked();
379}
380
381size_t JitCodeCache::DataCacheSizeLocked() {
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100382 size_t bytes_allocated = 0;
383 mspace_inspect_all(data_mspace_, DlmallocBytesAllocatedCallback, &bytes_allocated);
384 return bytes_allocated;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800385}
386
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100387size_t JitCodeCache::NumberOfCompiledCode() {
388 MutexLock mu(Thread::Current(), lock_);
389 return method_code_map_.size();
390}
391
Nicolas Geoffrayd28b9692015-11-04 14:36:55 +0000392void JitCodeCache::ClearData(Thread* self, void* data) {
393 MutexLock mu(self, lock_);
394 mspace_free(data_mspace_, data);
395}
396
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100397uint8_t* JitCodeCache::ReserveData(Thread* self, size_t size) {
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100398 size = RoundUp(size, sizeof(void*));
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100399 uint8_t* result = nullptr;
400
401 {
402 ScopedThreadSuspension sts(self, kSuspended);
403 MutexLock mu(self, lock_);
404 WaitForPotentialCollectionToComplete(self);
405 result = reinterpret_cast<uint8_t*>(mspace_malloc(data_mspace_, size));
406 }
407
408 if (result == nullptr) {
409 // Retry.
410 GarbageCollectCache(self);
411 ScopedThreadSuspension sts(self, kSuspended);
412 MutexLock mu(self, lock_);
413 WaitForPotentialCollectionToComplete(self);
414 result = reinterpret_cast<uint8_t*>(mspace_malloc(data_mspace_, size));
415 }
416
417 return result;
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100418}
419
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800420uint8_t* JitCodeCache::AddDataArray(Thread* self, const uint8_t* begin, const uint8_t* end) {
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100421 uint8_t* result = ReserveData(self, end - begin);
422 if (result == nullptr) {
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800423 return nullptr; // Out of space in the data cache.
424 }
Nicolas Geoffray0c3c2662015-10-15 13:53:04 +0100425 std::copy(begin, end, result);
426 return result;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800427}
428
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100429class MarkCodeVisitor FINAL : public StackVisitor {
430 public:
431 MarkCodeVisitor(Thread* thread_in, JitCodeCache* code_cache_in)
432 : StackVisitor(thread_in, nullptr, StackVisitor::StackWalkKind::kSkipInlinedFrames),
433 code_cache_(code_cache_in),
434 bitmap_(code_cache_->GetLiveBitmap()) {}
435
436 bool VisitFrame() OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
437 const OatQuickMethodHeader* method_header = GetCurrentOatQuickMethodHeader();
438 if (method_header == nullptr) {
439 return true;
440 }
441 const void* code = method_header->GetCode();
442 if (code_cache_->ContainsPc(code)) {
443 // Use the atomic set version, as multiple threads are executing this code.
444 bitmap_->AtomicTestAndSet(FromCodeToAllocation(code));
445 }
446 return true;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800447 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100448
449 private:
450 JitCodeCache* const code_cache_;
451 CodeCacheBitmap* const bitmap_;
452};
453
454class MarkCodeClosure FINAL : public Closure {
455 public:
456 MarkCodeClosure(JitCodeCache* code_cache, Barrier* barrier)
457 : code_cache_(code_cache), barrier_(barrier) {}
458
459 void Run(Thread* thread) OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
460 DCHECK(thread == Thread::Current() || thread->IsSuspended());
461 MarkCodeVisitor visitor(thread, code_cache_);
462 visitor.WalkStack();
Nicolas Geoffray5a23d2e2015-11-03 18:58:57 +0000463 if (kIsDebugBuild) {
464 // The stack walking code queries the side instrumentation stack if it
465 // sees an instrumentation exit pc, so the JIT code of methods in that stack
466 // must have been seen. We sanity check this below.
467 for (const instrumentation::InstrumentationStackFrame& frame
468 : *thread->GetInstrumentationStack()) {
469 // The 'method_' in InstrumentationStackFrame is the one that has return_pc_ in
470 // its stack frame, it is not the method owning return_pc_. We just pass null to
471 // LookupMethodHeader: the method is only checked against in debug builds.
472 OatQuickMethodHeader* method_header =
473 code_cache_->LookupMethodHeader(frame.return_pc_, nullptr);
474 if (method_header != nullptr) {
475 const void* code = method_header->GetCode();
476 CHECK(code_cache_->GetLiveBitmap()->Test(FromCodeToAllocation(code)));
477 }
478 }
479 }
Mathieu Chartier10d25082015-10-28 18:36:09 -0700480 barrier_->Pass(Thread::Current());
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800481 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100482
483 private:
484 JitCodeCache* const code_cache_;
485 Barrier* const barrier_;
486};
487
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000488void JitCodeCache::NotifyCollectionDone(Thread* self) {
489 collection_in_progress_ = false;
490 lock_cond_.Broadcast(self);
491}
492
493void JitCodeCache::SetFootprintLimit(size_t new_footprint) {
494 size_t per_space_footprint = new_footprint / 2;
495 DCHECK(IsAlignedParam(per_space_footprint, kPageSize));
496 DCHECK_EQ(per_space_footprint * 2, new_footprint);
497 mspace_set_footprint_limit(data_mspace_, per_space_footprint);
498 {
499 ScopedCodeCacheWrite scc(code_map_.get());
500 mspace_set_footprint_limit(code_mspace_, per_space_footprint);
501 }
502}
503
504bool JitCodeCache::IncreaseCodeCacheCapacity() {
505 if (current_capacity_ == max_capacity_) {
506 return false;
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100507 }
508
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000509 // Double the capacity if we're below 1MB, or increase it by 1MB if
510 // we're above.
511 if (current_capacity_ < 1 * MB) {
512 current_capacity_ *= 2;
513 } else {
514 current_capacity_ += 1 * MB;
515 }
516 if (current_capacity_ > max_capacity_) {
517 current_capacity_ = max_capacity_;
518 }
519
520 if (!kIsDebugBuild || VLOG_IS_ON(jit)) {
521 LOG(INFO) << "Increasing code cache capacity to " << PrettySize(current_capacity_);
522 }
523
524 SetFootprintLimit(current_capacity_);
525
526 return true;
527}
528
529void JitCodeCache::GarbageCollectCache(Thread* self) {
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000530 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100531
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000532 // Wait for an existing collection, or let everyone know we are starting one.
533 {
534 ScopedThreadSuspension sts(self, kSuspended);
535 MutexLock mu(self, lock_);
536 if (WaitForPotentialCollectionToComplete(self)) {
537 return;
538 } else {
539 collection_in_progress_ = true;
540 }
541 }
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000542
543 // Check if we just need to grow the capacity. If we don't, allocate the bitmap while
544 // we hold the lock.
545 {
546 MutexLock mu(self, lock_);
Nicolas Geoffraya25dce92016-01-12 16:41:10 +0000547 if (!garbage_collect_code_) {
548 IncreaseCodeCacheCapacity();
549 NotifyCollectionDone(self);
550 return;
551 } else if (has_done_one_collection_ && IncreaseCodeCacheCapacity()) {
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000552 has_done_one_collection_ = false;
553 NotifyCollectionDone(self);
554 return;
555 } else {
556 live_bitmap_.reset(CodeCacheBitmap::Create(
557 "code-cache-bitmap",
558 reinterpret_cast<uintptr_t>(code_map_->Begin()),
559 reinterpret_cast<uintptr_t>(code_map_->Begin() + current_capacity_ / 2)));
560 }
561 }
562
563 if (!kIsDebugBuild || VLOG_IS_ON(jit)) {
564 LOG(INFO) << "Clearing code cache, code="
565 << PrettySize(CodeCacheSize())
566 << ", data=" << PrettySize(DataCacheSize());
567 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100568 // Walk over all compiled methods and set the entry points of these
569 // methods to interpreter.
570 {
571 MutexLock mu(self, lock_);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100572 for (auto& it : method_code_map_) {
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000573 instrumentation->UpdateMethodsCode(it.second, GetQuickToInterpreterBridge());
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100574 }
Nicolas Geoffray26705e22015-10-28 12:50:11 +0000575 for (ProfilingInfo* info : profiling_infos_) {
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100576 if (!info->IsMethodBeingCompiled()) {
577 info->GetMethod()->SetProfilingInfo(nullptr);
578 }
Nicolas Geoffray26705e22015-10-28 12:50:11 +0000579 }
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000580
581 // Empty osr method map, as osr compile code will be deleted (except the ones
582 // on thread stacks).
583 osr_code_map_.clear();
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100584 }
585
586 // Run a checkpoint on all threads to mark the JIT compiled code they are running.
587 {
588 Barrier barrier(0);
Nicolas Geoffray62623402015-10-28 19:15:05 +0000589 size_t threads_running_checkpoint = 0;
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000590 MarkCodeClosure closure(this, &barrier);
591 threads_running_checkpoint =
592 Runtime::Current()->GetThreadList()->RunCheckpoint(&closure);
593 // Now that we have run our checkpoint, move to a suspended state and wait
594 // for other threads to run the checkpoint.
595 ScopedThreadSuspension sts(self, kSuspended);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100596 if (threads_running_checkpoint != 0) {
597 barrier.Increment(self, threads_running_checkpoint);
598 }
599 }
600
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100601 {
602 MutexLock mu(self, lock_);
Nicolas Geoffray26705e22015-10-28 12:50:11 +0000603 // Free unused compiled code, and restore the entry point of used compiled code.
604 {
605 ScopedCodeCacheWrite scc(code_map_.get());
606 for (auto it = method_code_map_.begin(); it != method_code_map_.end();) {
607 const void* code_ptr = it->first;
608 ArtMethod* method = it->second;
609 uintptr_t allocation = FromCodeToAllocation(code_ptr);
610 const OatQuickMethodHeader* method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
611 if (GetLiveBitmap()->Test(allocation)) {
Nicolas Geoffraya5891e82015-11-06 14:18:27 +0000612 instrumentation->UpdateMethodsCode(method, method_header->GetEntryPoint());
Nicolas Geoffray26705e22015-10-28 12:50:11 +0000613 ++it;
614 } else {
615 method->ClearCounter();
616 DCHECK_NE(method->GetEntryPointFromQuickCompiledCode(), method_header->GetEntryPoint());
617 FreeCode(code_ptr, method);
618 it = method_code_map_.erase(it);
619 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100620 }
621 }
Nicolas Geoffray26705e22015-10-28 12:50:11 +0000622
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100623 void* data_mspace = data_mspace_;
624 // Free all profiling infos of methods that were not being compiled.
625 auto profiling_kept_end = std::remove_if(profiling_infos_.begin(), profiling_infos_.end(),
626 [data_mspace] (ProfilingInfo* info) {
627 if (info->GetMethod()->GetProfilingInfo(sizeof(void*)) == nullptr) {
628 mspace_free(data_mspace, reinterpret_cast<uint8_t*>(info));
629 return true;
630 }
631 return false;
632 });
633 profiling_infos_.erase(profiling_kept_end, profiling_infos_.end());
Nicolas Geoffray26705e22015-10-28 12:50:11 +0000634
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000635 live_bitmap_.reset(nullptr);
636 has_done_one_collection_ = true;
637 NotifyCollectionDone(self);
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100638 }
639
640 if (!kIsDebugBuild || VLOG_IS_ON(jit)) {
641 LOG(INFO) << "After clearing code cache, code="
642 << PrettySize(CodeCacheSize())
643 << ", data=" << PrettySize(DataCacheSize());
644 }
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800645}
646
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100647
648OatQuickMethodHeader* JitCodeCache::LookupMethodHeader(uintptr_t pc, ArtMethod* method) {
649 static_assert(kRuntimeISA != kThumb2, "kThumb2 cannot be a runtime ISA");
650 if (kRuntimeISA == kArm) {
651 // On Thumb-2, the pc is offset by one.
652 --pc;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800653 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100654 if (!ContainsPc(reinterpret_cast<const void*>(pc))) {
655 return nullptr;
656 }
657
658 MutexLock mu(Thread::Current(), lock_);
659 if (method_code_map_.empty()) {
660 return nullptr;
661 }
662 auto it = method_code_map_.lower_bound(reinterpret_cast<const void*>(pc));
663 --it;
664
665 const void* code_ptr = it->first;
666 OatQuickMethodHeader* method_header = OatQuickMethodHeader::FromCodePointer(code_ptr);
667 if (!method_header->Contains(pc)) {
668 return nullptr;
669 }
Nicolas Geoffray5a23d2e2015-11-03 18:58:57 +0000670 if (kIsDebugBuild && method != nullptr) {
671 DCHECK_EQ(it->second, method)
672 << PrettyMethod(method) << " " << PrettyMethod(it->second) << " " << std::hex << pc;
673 }
Nicolas Geoffray1dad3f62015-10-23 14:59:54 +0100674 return method_header;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800675}
676
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000677OatQuickMethodHeader* JitCodeCache::LookupOsrMethodHeader(ArtMethod* method) {
678 MutexLock mu(Thread::Current(), lock_);
679 auto it = osr_code_map_.find(method);
680 if (it == osr_code_map_.end()) {
681 return nullptr;
682 }
683 return OatQuickMethodHeader::FromCodePointer(it->second);
684}
685
Nicolas Geoffray26705e22015-10-28 12:50:11 +0000686ProfilingInfo* JitCodeCache::AddProfilingInfo(Thread* self,
687 ArtMethod* method,
688 const std::vector<uint32_t>& entries,
689 bool retry_allocation) {
690 ProfilingInfo* info = AddProfilingInfoInternal(self, method, entries);
691
692 if (info == nullptr && retry_allocation) {
693 GarbageCollectCache(self);
694 info = AddProfilingInfoInternal(self, method, entries);
695 }
696 return info;
697}
698
699ProfilingInfo* JitCodeCache::AddProfilingInfoInternal(Thread* self,
700 ArtMethod* method,
701 const std::vector<uint32_t>& entries) {
702 size_t profile_info_size = RoundUp(
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100703 sizeof(ProfilingInfo) + sizeof(InlineCache) * entries.size(),
Nicolas Geoffray26705e22015-10-28 12:50:11 +0000704 sizeof(void*));
Nicolas Geoffray26705e22015-10-28 12:50:11 +0000705 MutexLock mu(self, lock_);
Nicolas Geoffray26705e22015-10-28 12:50:11 +0000706
707 // Check whether some other thread has concurrently created it.
708 ProfilingInfo* info = method->GetProfilingInfo(sizeof(void*));
709 if (info != nullptr) {
710 return info;
711 }
712
713 uint8_t* data = reinterpret_cast<uint8_t*>(mspace_malloc(data_mspace_, profile_info_size));
714 if (data == nullptr) {
715 return nullptr;
716 }
717 info = new (data) ProfilingInfo(method, entries);
Nicolas Geoffray07f35642016-01-04 16:06:51 +0000718
719 // Make sure other threads see the data in the profiling info object before the
720 // store in the ArtMethod's ProfilingInfo pointer.
721 QuasiAtomic::ThreadFenceRelease();
722
Nicolas Geoffray26705e22015-10-28 12:50:11 +0000723 method->SetProfilingInfo(info);
724 profiling_infos_.push_back(info);
725 return info;
726}
727
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000728// NO_THREAD_SAFETY_ANALYSIS as this is called from mspace code, at which point the lock
729// is already held.
730void* JitCodeCache::MoreCore(const void* mspace, intptr_t increment) NO_THREAD_SAFETY_ANALYSIS {
731 if (code_mspace_ == mspace) {
732 size_t result = code_end_;
733 code_end_ += increment;
734 return reinterpret_cast<void*>(result + code_map_->Begin());
735 } else {
736 DCHECK_EQ(data_mspace_, mspace);
737 size_t result = data_end_;
738 data_end_ += increment;
739 return reinterpret_cast<void*>(result + data_map_->Begin());
740 }
741}
742
Calin Juravleb4eddd22016-01-13 15:52:33 -0800743void JitCodeCache::GetCompiledArtMethods(const std::set<std::string>& dex_base_locations,
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000744 std::vector<ArtMethod*>& methods) {
Calin Juravle31f2c152015-10-23 17:56:15 +0100745 MutexLock mu(Thread::Current(), lock_);
746 for (auto it : method_code_map_) {
Calin Juravle66f55232015-12-08 15:09:10 +0000747 if (ContainsElement(dex_base_locations, it.second->GetDexFile()->GetBaseLocation())) {
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000748 methods.push_back(it.second);
Calin Juravle31f2c152015-10-23 17:56:15 +0100749 }
750 }
751}
752
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000753uint64_t JitCodeCache::GetLastUpdateTimeNs() const {
754 return last_update_time_ns_.LoadAcquire();
Calin Juravle31f2c152015-10-23 17:56:15 +0100755}
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100756
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000757bool JitCodeCache::NotifyCompilationOf(ArtMethod* method, Thread* self, bool osr) {
758 if (!osr && ContainsPc(method->GetEntryPointFromQuickCompiledCode())) {
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100759 return false;
760 }
Nicolas Geoffraya42363f2015-12-17 14:57:09 +0000761
Nicolas Geoffraya42363f2015-12-17 14:57:09 +0000762 MutexLock mu(self, lock_);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +0000763 if (osr && (osr_code_map_.find(method) != osr_code_map_.end())) {
764 return false;
765 }
Nicolas Geoffrayc26f1282016-01-29 11:41:25 +0000766 ProfilingInfo* info = method->GetProfilingInfo(sizeof(void*));
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100767 if (info == nullptr || info->IsMethodBeingCompiled()) {
768 return false;
769 }
770 info->SetIsMethodBeingCompiled(true);
771 return true;
772}
773
774void JitCodeCache::DoneCompiling(ArtMethod* method, Thread* self ATTRIBUTE_UNUSED) {
775 ProfilingInfo* info = method->GetProfilingInfo(sizeof(void*));
776 DCHECK(info->IsMethodBeingCompiled());
777 info->SetIsMethodBeingCompiled(false);
778}
779
Nicolas Geoffraya25dce92016-01-12 16:41:10 +0000780size_t JitCodeCache::GetMemorySizeOfCodePointer(const void* ptr) {
781 MutexLock mu(Thread::Current(), lock_);
782 return mspace_usable_size(reinterpret_cast<const void*>(FromCodeToAllocation(ptr)));
783}
784
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800785} // namespace jit
786} // namespace art