blob: b0a786e9e344d32b96e9a0cb174dee3efdee0bfc [file] [log] [blame]
Calin Juravle4d77b6a2015-12-01 18:38:09 +00001/*
2 * Copyright (C) 2015 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 "profile_saver.h"
18
Calin Juravle86a9ebe2016-02-24 10:13:09 +000019#include <sys/types.h>
20#include <sys/stat.h>
21#include <fcntl.h>
22
Calin Juravle4d77b6a2015-12-01 18:38:09 +000023#include "art_method-inl.h"
Mathieu Chartierdabdc0f2016-03-04 14:58:03 -080024#include "base/systrace.h"
Calin Juravle6044fa72016-03-25 17:17:09 +000025#include "base/time_utils.h"
26#include "compiler_filter.h"
Calin Juravle4d77b6a2015-12-01 18:38:09 +000027#include "oat_file_manager.h"
Calin Juravle6044fa72016-03-25 17:17:09 +000028#include "scoped_thread_state_change.h"
29
Calin Juravle4d77b6a2015-12-01 18:38:09 +000030
31namespace art {
32
Calin Juravle4d77b6a2015-12-01 18:38:09 +000033// TODO: read the constants from ProfileOptions,
34// Add a random delay each time we go to sleep so that we don't hammer the CPU
35// with all profile savers running at the same time.
Calin Juravle5fbb0fe2016-04-29 16:44:11 +010036static constexpr const uint64_t kMinSavePeriodNs = MsToNs(20 * 1000); // 20 seconds
Calin Juravlec15e5662016-03-17 17:07:52 +000037static constexpr const uint64_t kSaveResolvedClassesDelayMs = 2 * 1000; // 2 seconds
Calin Juravle4d77b6a2015-12-01 18:38:09 +000038
Calin Juravle85f7bf32016-03-18 16:23:40 +000039static constexpr const uint32_t kMinimumNumberOfMethodsToSave = 10;
40static constexpr const uint32_t kMinimumNumberOfClassesToSave = 10;
Calin Juravle5fbb0fe2016-04-29 16:44:11 +010041static constexpr const uint32_t kMinimumNumberOfNotificationBeforeWake =
42 kMinimumNumberOfMethodsToSave;
43static constexpr const uint32_t kMaximumNumberOfNotificationBeforeWake = 50;
44
Calin Juravle4d77b6a2015-12-01 18:38:09 +000045
46ProfileSaver* ProfileSaver::instance_ = nullptr;
47pthread_t ProfileSaver::profiler_pthread_ = 0U;
48
49ProfileSaver::ProfileSaver(const std::string& output_filename,
50 jit::JitCodeCache* jit_code_cache,
Calin Juravle86a9ebe2016-02-24 10:13:09 +000051 const std::vector<std::string>& code_paths,
52 const std::string& foreign_dex_profile_path,
53 const std::string& app_data_dir)
Calin Juravleb4eddd22016-01-13 15:52:33 -080054 : jit_code_cache_(jit_code_cache),
Calin Juravle86a9ebe2016-02-24 10:13:09 +000055 foreign_dex_profile_path_(foreign_dex_profile_path),
Calin Juravle4d77b6a2015-12-01 18:38:09 +000056 shutting_down_(false),
Calin Juravle85f7bf32016-03-18 16:23:40 +000057 last_save_number_of_methods_(0),
Calin Juravle0cdaa6c2016-03-30 18:18:58 +010058 last_save_number_of_classes_(0),
Calin Juravle5fbb0fe2016-04-29 16:44:11 +010059 last_time_ns_saver_woke_up_(0),
60 jit_activity_notifications_(0),
Calin Juravle4d77b6a2015-12-01 18:38:09 +000061 wait_lock_("ProfileSaver wait lock"),
Calin Juravlec19c1c22016-03-09 15:37:48 +000062 period_condition_("ProfileSaver period condition", wait_lock_),
63 total_bytes_written_(0),
64 total_number_of_writes_(0),
65 total_number_of_code_cache_queries_(0),
66 total_number_of_skipped_writes_(0),
67 total_number_of_failed_writes_(0),
Calin Juravle85f7bf32016-03-18 16:23:40 +000068 total_ms_of_sleep_(0),
Calin Juravlec19c1c22016-03-09 15:37:48 +000069 total_ns_of_work_(0),
Calin Juravle85f7bf32016-03-18 16:23:40 +000070 total_number_of_foreign_dex_marks_(0),
Calin Juravle5fbb0fe2016-04-29 16:44:11 +010071 max_number_of_profile_entries_cached_(0),
72 total_number_of_hot_spikes_(0),
73 total_number_of_wake_ups_(0) {
Calin Juravle20ae7932016-04-18 18:59:22 +010074 AddTrackedLocations(output_filename, app_data_dir, code_paths);
Calin Juravle86a9ebe2016-02-24 10:13:09 +000075 if (!app_data_dir.empty()) {
76 // The application directory is used to determine which dex files are owned by app.
77 // Since it could be a symlink (e.g. /data/data instead of /data/user/0), and we
78 // don't have control over how the dex files are actually loaded (symlink or canonical path),
79 // store it's canonical form to be sure we use the same base when comparing.
80 UniqueCPtr<const char[]> app_data_dir_real_path(realpath(app_data_dir.c_str(), nullptr));
81 if (app_data_dir_real_path != nullptr) {
Calin Juravle20ae7932016-04-18 18:59:22 +010082 app_data_dirs_.emplace(app_data_dir_real_path.get());
Calin Juravle86a9ebe2016-02-24 10:13:09 +000083 } else {
Calin Juravle20ae7932016-04-18 18:59:22 +010084 LOG(WARNING) << "Failed to get the real path for app dir: " << app_data_dir
Calin Juravle86a9ebe2016-02-24 10:13:09 +000085 << ". The app dir will not be used to determine which dex files belong to the app";
86 }
87 }
Calin Juravle4d77b6a2015-12-01 18:38:09 +000088}
89
90void ProfileSaver::Run() {
Calin Juravle4d77b6a2015-12-01 18:38:09 +000091 Thread* self = Thread::Current();
92
Calin Juravle5fbb0fe2016-04-29 16:44:11 +010093 // Fetch the resolved classes for the app images after sleeping for
94 // kSaveResolvedClassesDelayMs.
95 // TODO(calin) This only considers the case of the primary profile file.
96 // Anything that gets loaded in the same VM will not have their resolved
97 // classes save (unless they started before the initial saving was done).
98 {
99 MutexLock mu(self, wait_lock_);
Mathieu Chartier0ec065d2016-05-18 19:51:23 -0700100 constexpr uint64_t kSleepTime = kSaveResolvedClassesDelayMs;
101 const uint64_t end_time = NanoTime() + MsToNs(kSleepTime);
102 while (true) {
103 const uint64_t current_time = NanoTime();
104 if (current_time >= end_time) {
105 break;
106 }
107 period_condition_.TimedWait(self, NsToMs(end_time - current_time), 0);
108 }
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100109 total_ms_of_sleep_ += kSaveResolvedClassesDelayMs;
110 }
111 FetchAndCacheResolvedClasses();
112
113 // Loop for the profiled methods.
Mathieu Chartier8913fc12015-12-09 16:38:30 -0800114 while (!ShuttingDown(self)) {
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100115 uint64_t sleep_start = NanoTime();
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000116 {
Calin Juravle0233a412016-05-18 15:49:36 -0700117 uint64_t sleep_time = 0;
118 {
119 MutexLock mu(self, wait_lock_);
120 period_condition_.Wait(self);
121 sleep_time = NanoTime() - last_time_ns_saver_woke_up_;
122 }
123 // Check if the thread was woken up for shutdown.
124 if (ShuttingDown(self)) {
125 break;
126 }
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100127 total_number_of_wake_ups_++;
128 // We might have been woken up by a huge number of notifications to guarantee saving.
129 // If we didn't meet the minimum saving period go back to sleep (only if missed by
130 // a reasonable margin).
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100131 while (kMinSavePeriodNs - sleep_time > (kMinSavePeriodNs / 10)) {
Calin Juravle0233a412016-05-18 15:49:36 -0700132 {
133 MutexLock mu(self, wait_lock_);
134 period_condition_.TimedWait(self, NsToMs(kMinSavePeriodNs - sleep_time), 0);
135 sleep_time = NanoTime() - last_time_ns_saver_woke_up_;
136 }
137 // Check if the thread was woken up for shutdown.
138 if (ShuttingDown(self)) {
139 break;
140 }
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100141 total_number_of_wake_ups_++;
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100142 }
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000143 }
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100144 total_ms_of_sleep_ += NsToMs(NanoTime() - sleep_start);
145
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000146 if (ShuttingDown(self)) {
147 break;
148 }
149
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100150 uint16_t new_methods = 0;
151 uint64_t start_work = NanoTime();
152 bool profile_saved_to_disk = ProcessProfilingInfo(&new_methods);
153 // Update the notification counter based on result. Note that there might be contention on this
154 // but we don't care about to be 100% precise.
155 if (!profile_saved_to_disk) {
156 // If we didn't save to disk it may be because we didn't have enough new methods.
157 // Set the jit activity notifications to new_methods so we can wake up earlier if needed.
158 jit_activity_notifications_ = new_methods;
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000159 }
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100160 total_ns_of_work_ += NanoTime() - start_work;
161 }
162}
Calin Juravlec19c1c22016-03-09 15:37:48 +0000163
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100164void ProfileSaver::NotifyJitActivity() {
165 MutexLock mu(Thread::Current(), *Locks::profiler_lock_);
166 if (instance_ == nullptr || instance_->shutting_down_) {
167 return;
168 }
169 instance_->NotifyJitActivityInternal();
170}
171
172void ProfileSaver::WakeUpSaver() {
173 jit_activity_notifications_ = 0;
174 last_time_ns_saver_woke_up_ = NanoTime();
175 period_condition_.Signal(Thread::Current());
176}
177
178void ProfileSaver::NotifyJitActivityInternal() {
179 // Unlikely to overflow but if it happens,
180 // we would have waken up the saver long before that.
181 jit_activity_notifications_++;
182 // Note that we are not as precise as we could be here but we don't want to wake the saver
183 // every time we see a hot method.
184 if (jit_activity_notifications_ > kMinimumNumberOfNotificationBeforeWake) {
185 MutexLock wait_mutex(Thread::Current(), wait_lock_);
186 if ((NanoTime() - last_time_ns_saver_woke_up_) > kMinSavePeriodNs) {
187 WakeUpSaver();
188 }
189 } else if (jit_activity_notifications_ > kMaximumNumberOfNotificationBeforeWake) {
190 // Make sure to wake up the saver if we see a spike in the number of notifications.
191 // This is a precaution to avoid "loosing" a big number of methods in case
192 // this is a spike with no jit after.
193 total_number_of_hot_spikes_++;
194 MutexLock wait_mutex(Thread::Current(), wait_lock_);
195 WakeUpSaver();
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000196 }
197}
198
Calin Juravle85f7bf32016-03-18 16:23:40 +0000199ProfileCompilationInfo* ProfileSaver::GetCachedProfiledInfo(const std::string& filename) {
200 auto info_it = profile_cache_.find(filename);
201 if (info_it == profile_cache_.end()) {
202 info_it = profile_cache_.Put(filename, ProfileCompilationInfo());
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000203 }
Calin Juravle85f7bf32016-03-18 16:23:40 +0000204 return &info_it->second;
205}
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000206
Calin Juravle85f7bf32016-03-18 16:23:40 +0000207void ProfileSaver::FetchAndCacheResolvedClasses() {
208 ScopedTrace trace(__PRETTY_FUNCTION__);
Calin Juravle85f7bf32016-03-18 16:23:40 +0000209 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
210 std::set<DexCacheResolvedClasses> resolved_classes =
211 class_linker->GetResolvedClasses(/*ignore boot classes*/ true);
212 MutexLock mu(Thread::Current(), *Locks::profiler_lock_);
213 uint64_t total_number_of_profile_entries_cached = 0;
Mathieu Chartier9275af62016-04-29 12:03:56 -0700214
Calin Juravle85f7bf32016-03-18 16:23:40 +0000215 for (const auto& it : tracked_dex_base_locations_) {
Mathieu Chartier9275af62016-04-29 12:03:56 -0700216 std::set<DexCacheResolvedClasses> resolved_classes_for_location;
Calin Juravle85f7bf32016-03-18 16:23:40 +0000217 const std::string& filename = it.first;
218 const std::set<std::string>& locations = it.second;
219
220 for (const DexCacheResolvedClasses& classes : resolved_classes) {
Mathieu Chartier9275af62016-04-29 12:03:56 -0700221 if (locations.find(classes.GetBaseLocation()) != locations.end()) {
222 VLOG(profiler) << "Added classes for location " << classes.GetBaseLocation()
223 << " (" << classes.GetDexLocation() << ")";
Calin Juravle85f7bf32016-03-18 16:23:40 +0000224 resolved_classes_for_location.insert(classes);
Mathieu Chartier9275af62016-04-29 12:03:56 -0700225 } else {
226 VLOG(profiler) << "Location not found " << classes.GetBaseLocation()
227 << " (" << classes.GetDexLocation() << ")";
Calin Juravle85f7bf32016-03-18 16:23:40 +0000228 }
229 }
230 ProfileCompilationInfo* info = GetCachedProfiledInfo(filename);
Calin Juravlee2d066d2016-04-19 16:33:46 +0100231 info->AddMethodsAndClasses(std::vector<MethodReference>(), resolved_classes_for_location);
Calin Juravle85f7bf32016-03-18 16:23:40 +0000232 total_number_of_profile_entries_cached += resolved_classes_for_location.size();
233 }
234 max_number_of_profile_entries_cached_ = std::max(
235 max_number_of_profile_entries_cached_,
236 total_number_of_profile_entries_cached);
237}
238
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100239bool ProfileSaver::ProcessProfilingInfo(uint16_t* new_methods) {
Calin Juravle85f7bf32016-03-18 16:23:40 +0000240 ScopedTrace trace(__PRETTY_FUNCTION__);
Calin Juravleb4eddd22016-01-13 15:52:33 -0800241 SafeMap<std::string, std::set<std::string>> tracked_locations;
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000242 {
Calin Juravleb4eddd22016-01-13 15:52:33 -0800243 // Make a copy so that we don't hold the lock while doing I/O.
244 MutexLock mu(Thread::Current(), *Locks::profiler_lock_);
245 tracked_locations = tracked_dex_base_locations_;
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000246 }
Calin Juravlec15e5662016-03-17 17:07:52 +0000247
Calin Juravle85f7bf32016-03-18 16:23:40 +0000248 bool profile_file_saved = false;
249 uint64_t total_number_of_profile_entries_cached = 0;
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100250 *new_methods = 0;
251
Calin Juravleb4eddd22016-01-13 15:52:33 -0800252 for (const auto& it : tracked_locations) {
253 if (ShuttingDown(Thread::Current())) {
254 return true;
255 }
256 const std::string& filename = it.first;
257 const std::set<std::string>& locations = it.second;
Calin Juravlee2d066d2016-04-19 16:33:46 +0100258 std::vector<MethodReference> methods;
Calin Juravleb4eddd22016-01-13 15:52:33 -0800259 {
260 ScopedObjectAccess soa(Thread::Current());
Calin Juravlee2d066d2016-04-19 16:33:46 +0100261 jit_code_cache_->GetProfiledMethods(locations, methods);
Calin Juravlec19c1c22016-03-09 15:37:48 +0000262 total_number_of_code_cache_queries_++;
Calin Juravleb4eddd22016-01-13 15:52:33 -0800263 }
Calin Juravlec15e5662016-03-17 17:07:52 +0000264
Calin Juravle85f7bf32016-03-18 16:23:40 +0000265 ProfileCompilationInfo* cached_info = GetCachedProfiledInfo(filename);
266 cached_info->AddMethodsAndClasses(methods, std::set<DexCacheResolvedClasses>());
Calin Juravle0cdaa6c2016-03-30 18:18:58 +0100267 int64_t delta_number_of_methods =
268 cached_info->GetNumberOfMethods() -
269 static_cast<int64_t>(last_save_number_of_methods_);
270 int64_t delta_number_of_classes =
271 cached_info->GetNumberOfResolvedClasses() -
272 static_cast<int64_t>(last_save_number_of_classes_);
Calin Juravle85f7bf32016-03-18 16:23:40 +0000273
274 if (delta_number_of_methods < kMinimumNumberOfMethodsToSave &&
275 delta_number_of_classes < kMinimumNumberOfClassesToSave) {
Calin Juravle0cdaa6c2016-03-30 18:18:58 +0100276 VLOG(profiler) << "Not enough information to save to: " << filename
Calin Juravle85f7bf32016-03-18 16:23:40 +0000277 << " Nr of methods: " << delta_number_of_methods
278 << " Nr of classes: " << delta_number_of_classes;
Calin Juravlec19c1c22016-03-09 15:37:48 +0000279 total_number_of_skipped_writes_++;
Calin Juravle85f7bf32016-03-18 16:23:40 +0000280 continue;
Calin Juravleb4eddd22016-01-13 15:52:33 -0800281 }
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100282 *new_methods = std::max(static_cast<uint16_t>(delta_number_of_methods), *new_methods);
Calin Juravlec19c1c22016-03-09 15:37:48 +0000283 uint64_t bytes_written;
Calin Juravlefe297a92016-03-24 20:33:22 +0000284 // Force the save. In case the profile data is corrupted or the the profile
285 // has the wrong version this will "fix" the file to the correct format.
286 if (cached_info->MergeAndSave(filename, &bytes_written, /*force*/ true)) {
Calin Juravle85f7bf32016-03-18 16:23:40 +0000287 last_save_number_of_methods_ = cached_info->GetNumberOfMethods();
Calin Juravle0cdaa6c2016-03-30 18:18:58 +0100288 last_save_number_of_classes_ = cached_info->GetNumberOfResolvedClasses();
Calin Juravle85f7bf32016-03-18 16:23:40 +0000289 // Clear resolved classes. No need to store them around as
290 // they don't change after the first write.
291 cached_info->ClearResolvedClasses();
Calin Juravlec19c1c22016-03-09 15:37:48 +0000292 if (bytes_written > 0) {
293 total_number_of_writes_++;
294 total_bytes_written_ += bytes_written;
Calin Juravle0cdaa6c2016-03-30 18:18:58 +0100295 profile_file_saved = true;
Calin Juravle85f7bf32016-03-18 16:23:40 +0000296 } else {
297 // At this point we could still have avoided the write.
298 // We load and merge the data from the file lazily at its first ever
299 // save attempt. So, whatever we are trying to save could already be
300 // in the file.
301 total_number_of_skipped_writes_++;
Calin Juravlec19c1c22016-03-09 15:37:48 +0000302 }
Calin Juravle85f7bf32016-03-18 16:23:40 +0000303 } else {
304 LOG(WARNING) << "Could not save profiling info to " << filename;
305 total_number_of_failed_writes_++;
Calin Juravleb4eddd22016-01-13 15:52:33 -0800306 }
Calin Juravle85f7bf32016-03-18 16:23:40 +0000307 total_number_of_profile_entries_cached +=
308 cached_info->GetNumberOfMethods() +
309 cached_info->GetNumberOfResolvedClasses();
Calin Juravleb4eddd22016-01-13 15:52:33 -0800310 }
Calin Juravle85f7bf32016-03-18 16:23:40 +0000311 max_number_of_profile_entries_cached_ = std::max(
312 max_number_of_profile_entries_cached_,
313 total_number_of_profile_entries_cached);
314 return profile_file_saved;
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000315}
316
317void* ProfileSaver::RunProfileSaverThread(void* arg) {
318 Runtime* runtime = Runtime::Current();
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000319
Calin Juravlee55fda12016-04-28 12:59:33 +0100320 bool attached = runtime->AttachCurrentThread("Profile Saver",
321 /*as_daemon*/true,
322 runtime->GetSystemThreadGroup(),
323 /*create_peer*/true);
324 if (!attached) {
325 CHECK(runtime->IsShuttingDown(Thread::Current()));
326 return nullptr;
327 }
328
329 ProfileSaver* profile_saver = reinterpret_cast<ProfileSaver*>(arg);
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000330 profile_saver->Run();
331
332 runtime->DetachCurrentThread();
333 VLOG(profiler) << "Profile saver shutdown";
334 return nullptr;
335}
336
Calin Juravle6044fa72016-03-25 17:17:09 +0000337static bool ShouldProfileLocation(const std::string& location) {
Calin Juravle75064232016-04-18 16:38:27 +0100338 OatFileManager& oat_manager = Runtime::Current()->GetOatFileManager();
339 const OatFile* oat_file = oat_manager.FindOpenedOatFileFromDexLocation(location);
Calin Juravle6044fa72016-03-25 17:17:09 +0000340 if (oat_file == nullptr) {
341 // This can happen if we fallback to run code directly from the APK.
342 // Profile it with the hope that the background dexopt will get us back into
343 // a good state.
Calin Juravle75064232016-04-18 16:38:27 +0100344 VLOG(profiler) << "Asked to profile a location without an oat file:" << location;
Calin Juravle6044fa72016-03-25 17:17:09 +0000345 return true;
346 }
347 CompilerFilter::Filter filter = oat_file->GetCompilerFilter();
Calin Juravled19dc462016-04-19 18:17:41 +0100348 if ((filter == CompilerFilter::kSpeed) || (filter == CompilerFilter::kEverything)) {
Calin Juravle75064232016-04-18 16:38:27 +0100349 VLOG(profiler)
Calin Juravled19dc462016-04-19 18:17:41 +0100350 << "Skip profiling oat file because it's already speed|everything compiled: "
351 << location << " oat location: " << oat_file->GetLocation();
Calin Juravle6044fa72016-03-25 17:17:09 +0000352 return false;
353 }
354 return true;
355}
356
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000357void ProfileSaver::Start(const std::string& output_filename,
358 jit::JitCodeCache* jit_code_cache,
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000359 const std::vector<std::string>& code_paths,
360 const std::string& foreign_dex_profile_path,
361 const std::string& app_data_dir) {
Calin Juravlee5de54c2016-04-20 14:22:09 +0100362 DCHECK(Runtime::Current()->SaveProfileInfo());
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000363 DCHECK(!output_filename.empty());
364 DCHECK(jit_code_cache != nullptr);
365
Calin Juravle6044fa72016-03-25 17:17:09 +0000366 std::vector<std::string> code_paths_to_profile;
367
368 for (const std::string& location : code_paths) {
369 if (ShouldProfileLocation(location)) {
370 code_paths_to_profile.push_back(location);
Calin Juravle6044fa72016-03-25 17:17:09 +0000371 }
372 }
373 if (code_paths_to_profile.empty()) {
Calin Juravle75064232016-04-18 16:38:27 +0100374 VLOG(profiler) << "No code paths should be profiled.";
Calin Juravle6044fa72016-03-25 17:17:09 +0000375 return;
376 }
377
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000378 MutexLock mu(Thread::Current(), *Locks::profiler_lock_);
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000379 if (instance_ != nullptr) {
Calin Juravleb4eddd22016-01-13 15:52:33 -0800380 // If we already have an instance, make sure it uses the same jit_code_cache.
381 // This may be called multiple times via Runtime::registerAppInfo (e.g. for
382 // apps which share the same runtime).
383 DCHECK_EQ(instance_->jit_code_cache_, jit_code_cache);
384 // Add the code_paths to the tracked locations.
Calin Juravle20ae7932016-04-18 18:59:22 +0100385 instance_->AddTrackedLocations(output_filename, app_data_dir, code_paths_to_profile);
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000386 return;
387 }
388
389 VLOG(profiler) << "Starting profile saver using output file: " << output_filename
Calin Juravle75064232016-04-18 16:38:27 +0100390 << ". Tracking: " << Join(code_paths_to_profile, ':');
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000391
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000392 instance_ = new ProfileSaver(output_filename,
393 jit_code_cache,
Calin Juravle75064232016-04-18 16:38:27 +0100394 code_paths_to_profile,
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000395 foreign_dex_profile_path,
396 app_data_dir);
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000397
398 // Create a new thread which does the saving.
399 CHECK_PTHREAD_CALL(
400 pthread_create,
401 (&profiler_pthread_, nullptr, &RunProfileSaverThread, reinterpret_cast<void*>(instance_)),
402 "Profile saver thread");
403}
404
Calin Juravlec19c1c22016-03-09 15:37:48 +0000405void ProfileSaver::Stop(bool dump_info) {
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000406 ProfileSaver* profile_saver = nullptr;
407 pthread_t profiler_pthread = 0U;
408
409 {
410 MutexLock profiler_mutex(Thread::Current(), *Locks::profiler_lock_);
Calin Juravleb4eddd22016-01-13 15:52:33 -0800411 VLOG(profiler) << "Stopping profile saver thread";
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000412 profile_saver = instance_;
413 profiler_pthread = profiler_pthread_;
414 if (instance_ == nullptr) {
415 DCHECK(false) << "Tried to stop a profile saver which was not started";
416 return;
417 }
418 if (instance_->shutting_down_) {
419 DCHECK(false) << "Tried to stop the profile saver twice";
420 return;
421 }
422 instance_->shutting_down_ = true;
Calin Juravlec19c1c22016-03-09 15:37:48 +0000423 if (dump_info) {
424 instance_->DumpInfo(LOG(INFO));
425 }
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000426 }
427
428 {
429 // Wake up the saver thread if it is sleeping to allow for a clean exit.
430 MutexLock wait_mutex(Thread::Current(), profile_saver->wait_lock_);
431 profile_saver->period_condition_.Signal(Thread::Current());
432 }
433
434 // Wait for the saver thread to stop.
435 CHECK_PTHREAD_CALL(pthread_join, (profiler_pthread, nullptr), "profile saver thread shutdown");
436
437 {
438 MutexLock profiler_mutex(Thread::Current(), *Locks::profiler_lock_);
439 instance_ = nullptr;
440 profiler_pthread_ = 0U;
441 }
442 delete profile_saver;
443}
444
445bool ProfileSaver::ShuttingDown(Thread* self) {
446 MutexLock mu(self, *Locks::profiler_lock_);
447 return shutting_down_;
448}
449
450bool ProfileSaver::IsStarted() {
451 MutexLock mu(Thread::Current(), *Locks::profiler_lock_);
452 return instance_ != nullptr;
453}
454
Calin Juravleb4eddd22016-01-13 15:52:33 -0800455void ProfileSaver::AddTrackedLocations(const std::string& output_filename,
Calin Juravle20ae7932016-04-18 18:59:22 +0100456 const std::string& app_data_dir,
Calin Juravleb4eddd22016-01-13 15:52:33 -0800457 const std::vector<std::string>& code_paths) {
458 auto it = tracked_dex_base_locations_.find(output_filename);
459 if (it == tracked_dex_base_locations_.end()) {
460 tracked_dex_base_locations_.Put(output_filename,
461 std::set<std::string>(code_paths.begin(), code_paths.end()));
Calin Juravle20ae7932016-04-18 18:59:22 +0100462 app_data_dirs_.insert(app_data_dir);
Calin Juravleb4eddd22016-01-13 15:52:33 -0800463 } else {
464 it->second.insert(code_paths.begin(), code_paths.end());
465 }
466}
467
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000468void ProfileSaver::NotifyDexUse(const std::string& dex_location) {
Calin Juravle6044fa72016-03-25 17:17:09 +0000469 if (!ShouldProfileLocation(dex_location)) {
470 return;
471 }
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000472 std::set<std::string> app_code_paths;
473 std::string foreign_dex_profile_path;
Calin Juravle20ae7932016-04-18 18:59:22 +0100474 std::set<std::string> app_data_dirs;
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000475 {
476 MutexLock mu(Thread::Current(), *Locks::profiler_lock_);
Calin Juravlec19c1c22016-03-09 15:37:48 +0000477 if (instance_ == nullptr) {
478 return;
479 }
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000480 // Make a copy so that we don't hold the lock while doing I/O.
481 for (const auto& it : instance_->tracked_dex_base_locations_) {
482 app_code_paths.insert(it.second.begin(), it.second.end());
483 }
484 foreign_dex_profile_path = instance_->foreign_dex_profile_path_;
Calin Juravle20ae7932016-04-18 18:59:22 +0100485 app_data_dirs.insert(instance_->app_data_dirs_.begin(), instance_->app_data_dirs_.end());
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000486 }
487
Calin Juravlec19c1c22016-03-09 15:37:48 +0000488 bool mark_created = MaybeRecordDexUseInternal(dex_location,
489 app_code_paths,
490 foreign_dex_profile_path,
Calin Juravle20ae7932016-04-18 18:59:22 +0100491 app_data_dirs);
Calin Juravlec19c1c22016-03-09 15:37:48 +0000492 if (mark_created) {
493 MutexLock mu(Thread::Current(), *Locks::profiler_lock_);
494 if (instance_ != nullptr) {
495 instance_->total_number_of_foreign_dex_marks_++;
496 }
497 }
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000498}
499
Calin Juravlec19c1c22016-03-09 15:37:48 +0000500bool ProfileSaver::MaybeRecordDexUseInternal(
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000501 const std::string& dex_location,
502 const std::set<std::string>& app_code_paths,
503 const std::string& foreign_dex_profile_path,
Calin Juravle20ae7932016-04-18 18:59:22 +0100504 const std::set<std::string>& app_data_dirs) {
Calin Juravle1fae45f2016-03-08 12:52:52 +0000505 if (dex_location.empty()) {
506 LOG(WARNING) << "Asked to record foreign dex use with an empty dex location.";
Calin Juravlec19c1c22016-03-09 15:37:48 +0000507 return false;
Calin Juravle1fae45f2016-03-08 12:52:52 +0000508 }
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000509 if (foreign_dex_profile_path.empty()) {
510 LOG(WARNING) << "Asked to record foreign dex use without a valid profile path ";
Calin Juravlec19c1c22016-03-09 15:37:48 +0000511 return false;
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000512 }
513
514 UniqueCPtr<const char[]> dex_location_real_path(realpath(dex_location.c_str(), nullptr));
Calin Juravle1fae45f2016-03-08 12:52:52 +0000515 if (dex_location_real_path == nullptr) {
516 PLOG(WARNING) << "Could not get realpath for " << dex_location;
517 }
518 std::string dex_location_real_path_str((dex_location_real_path == nullptr)
519 ? dex_location.c_str()
520 : dex_location_real_path.get());
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000521
Calin Juravle20ae7932016-04-18 18:59:22 +0100522 if (app_data_dirs.find(dex_location_real_path_str) != app_data_dirs.end()) {
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000523 // The dex location is under the application folder. Nothing to record.
Calin Juravlec19c1c22016-03-09 15:37:48 +0000524 return false;
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000525 }
526
527 if (app_code_paths.find(dex_location) != app_code_paths.end()) {
528 // The dex location belongs to the application code paths. Nothing to record.
Calin Juravlec19c1c22016-03-09 15:37:48 +0000529 return false;
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000530 }
531 // Do another round of checks with the real paths.
532 // Note that we could cache all the real locations in the saver (since it's an expensive
533 // operation). However we expect that app_code_paths is small (usually 1 element), and
534 // NotifyDexUse is called just a few times in the app lifetime. So we make the compromise
535 // to save some bytes of memory usage.
536 for (const auto& app_code_location : app_code_paths) {
537 UniqueCPtr<const char[]> real_app_code_location(realpath(app_code_location.c_str(), nullptr));
Calin Juravle1fae45f2016-03-08 12:52:52 +0000538 if (real_app_code_location == nullptr) {
539 PLOG(WARNING) << "Could not get realpath for " << app_code_location;
540 }
541 std::string real_app_code_location_str((real_app_code_location == nullptr)
542 ? app_code_location.c_str()
543 : real_app_code_location.get());
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000544 if (real_app_code_location_str == dex_location_real_path_str) {
545 // The dex location belongs to the application code paths. Nothing to record.
Calin Juravlec19c1c22016-03-09 15:37:48 +0000546 return false;
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000547 }
548 }
549
550 // For foreign dex files we record a flag on disk. PackageManager will (potentially) take this
551 // into account when deciding how to optimize the loaded dex file.
552 // The expected flag name is the canonical path of the apk where '/' is substituted to '@'.
553 // (it needs to be kept in sync with
554 // frameworks/base/services/core/java/com/android/server/pm/PackageDexOptimizer.java)
555 std::replace(dex_location_real_path_str.begin(), dex_location_real_path_str.end(), '/', '@');
556 std::string flag_path = foreign_dex_profile_path + "/" + dex_location_real_path_str;
Richard Uhler12e41572016-05-10 14:01:18 -0700557 // We use O_RDONLY as the access mode because we must supply some access
558 // mode, and there is no access mode that means 'create but do not read' the
559 // file. We will not not actually read from the file.
560 int fd = TEMP_FAILURE_RETRY(open(flag_path.c_str(),
561 O_CREAT | O_RDONLY | O_EXCL | O_CLOEXEC | O_NOFOLLOW, 0));
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000562 if (fd != -1) {
563 if (close(fd) != 0) {
564 PLOG(WARNING) << "Could not close file after flagging foreign dex use " << flag_path;
565 }
Calin Juravlec19c1c22016-03-09 15:37:48 +0000566 return true;
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000567 } else {
Richard Uhler12e41572016-05-10 14:01:18 -0700568 if (errno != EEXIST && errno != EACCES) {
569 // Another app could have already created the file, and selinux may not
570 // allow the read access to the file implied by the call to open.
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000571 PLOG(WARNING) << "Could not create foreign dex use mark " << flag_path;
Calin Juravlec19c1c22016-03-09 15:37:48 +0000572 return false;
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000573 }
Calin Juravlec19c1c22016-03-09 15:37:48 +0000574 return true;
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000575 }
576}
577
Calin Juravlec19c1c22016-03-09 15:37:48 +0000578void ProfileSaver::DumpInstanceInfo(std::ostream& os) {
579 MutexLock mu(Thread::Current(), *Locks::profiler_lock_);
580 if (instance_ != nullptr) {
581 instance_->DumpInfo(os);
582 }
583}
584
585void ProfileSaver::DumpInfo(std::ostream& os) {
586 os << "ProfileSaver total_bytes_written=" << total_bytes_written_ << '\n'
587 << "ProfileSaver total_number_of_writes=" << total_number_of_writes_ << '\n'
Calin Juravle85f7bf32016-03-18 16:23:40 +0000588 << "ProfileSaver total_number_of_code_cache_queries="
589 << total_number_of_code_cache_queries_ << '\n'
Calin Juravlec19c1c22016-03-09 15:37:48 +0000590 << "ProfileSaver total_number_of_skipped_writes=" << total_number_of_skipped_writes_ << '\n'
591 << "ProfileSaver total_number_of_failed_writes=" << total_number_of_failed_writes_ << '\n'
Calin Juravle85f7bf32016-03-18 16:23:40 +0000592 << "ProfileSaver total_ms_of_sleep=" << total_ms_of_sleep_ << '\n'
Calin Juravle6044fa72016-03-25 17:17:09 +0000593 << "ProfileSaver total_ms_of_work=" << NsToMs(total_ns_of_work_) << '\n'
Calin Juravle85f7bf32016-03-18 16:23:40 +0000594 << "ProfileSaver total_number_of_foreign_dex_marks="
595 << total_number_of_foreign_dex_marks_ << '\n'
596 << "ProfileSaver max_number_profile_entries_cached="
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100597 << max_number_of_profile_entries_cached_ << '\n'
598 << "ProfileSaver total_number_of_hot_spikes=" << total_number_of_hot_spikes_ << '\n'
599 << "ProfileSaver total_number_of_wake_ups=" << total_number_of_wake_ups_ << '\n';
Calin Juravlec19c1c22016-03-09 15:37:48 +0000600}
601
Calin Juravlee5de54c2016-04-20 14:22:09 +0100602
603void ProfileSaver::ForceProcessProfiles() {
604 ProfileSaver* saver = nullptr;
605 {
606 MutexLock mu(Thread::Current(), *Locks::profiler_lock_);
607 saver = instance_;
608 }
609 // TODO(calin): this is not actually thread safe as the instance_ may have been deleted,
610 // but we only use this in testing when we now this won't happen.
611 // Refactor the way we handle the instance so that we don't end up in this situation.
612 if (saver != nullptr) {
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100613 uint16_t new_methods;
614 saver->ProcessProfilingInfo(&new_methods);
Calin Juravlee5de54c2016-04-20 14:22:09 +0100615 }
616}
617
618bool ProfileSaver::HasSeenMethod(const std::string& profile,
619 const DexFile* dex_file,
620 uint16_t method_idx) {
621 MutexLock mu(Thread::Current(), *Locks::profiler_lock_);
622 if (instance_ != nullptr) {
623 ProfileCompilationInfo* info = instance_->GetCachedProfiledInfo(profile);
624 if (info != nullptr) {
625 return info->ContainsMethod(MethodReference(dex_file, method_idx));
626 }
627 }
628 return false;
629}
630
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000631} // namespace art