blob: 60857837a19af2f10d9fa3fb80526131bae35b8c [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 {
117 MutexLock mu(self, wait_lock_);
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100118 period_condition_.Wait(self);
119 total_number_of_wake_ups_++;
120 // We might have been woken up by a huge number of notifications to guarantee saving.
121 // If we didn't meet the minimum saving period go back to sleep (only if missed by
122 // a reasonable margin).
123 uint64_t sleep_time = NanoTime() - last_time_ns_saver_woke_up_;
124 while (kMinSavePeriodNs - sleep_time > (kMinSavePeriodNs / 10)) {
125 period_condition_.TimedWait(self, NsToMs(kMinSavePeriodNs - sleep_time), 0);
126 total_number_of_wake_ups_++;
127 sleep_time = NanoTime() - last_time_ns_saver_woke_up_;
128 }
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000129 }
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100130 total_ms_of_sleep_ += NsToMs(NanoTime() - sleep_start);
131
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000132 if (ShuttingDown(self)) {
133 break;
134 }
135
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100136 uint16_t new_methods = 0;
137 uint64_t start_work = NanoTime();
138 bool profile_saved_to_disk = ProcessProfilingInfo(&new_methods);
139 // Update the notification counter based on result. Note that there might be contention on this
140 // but we don't care about to be 100% precise.
141 if (!profile_saved_to_disk) {
142 // If we didn't save to disk it may be because we didn't have enough new methods.
143 // Set the jit activity notifications to new_methods so we can wake up earlier if needed.
144 jit_activity_notifications_ = new_methods;
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000145 }
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100146 total_ns_of_work_ += NanoTime() - start_work;
147 }
148}
Calin Juravlec19c1c22016-03-09 15:37:48 +0000149
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100150void ProfileSaver::NotifyJitActivity() {
151 MutexLock mu(Thread::Current(), *Locks::profiler_lock_);
152 if (instance_ == nullptr || instance_->shutting_down_) {
153 return;
154 }
155 instance_->NotifyJitActivityInternal();
156}
157
158void ProfileSaver::WakeUpSaver() {
159 jit_activity_notifications_ = 0;
160 last_time_ns_saver_woke_up_ = NanoTime();
161 period_condition_.Signal(Thread::Current());
162}
163
164void ProfileSaver::NotifyJitActivityInternal() {
165 // Unlikely to overflow but if it happens,
166 // we would have waken up the saver long before that.
167 jit_activity_notifications_++;
168 // Note that we are not as precise as we could be here but we don't want to wake the saver
169 // every time we see a hot method.
170 if (jit_activity_notifications_ > kMinimumNumberOfNotificationBeforeWake) {
171 MutexLock wait_mutex(Thread::Current(), wait_lock_);
172 if ((NanoTime() - last_time_ns_saver_woke_up_) > kMinSavePeriodNs) {
173 WakeUpSaver();
174 }
175 } else if (jit_activity_notifications_ > kMaximumNumberOfNotificationBeforeWake) {
176 // Make sure to wake up the saver if we see a spike in the number of notifications.
177 // This is a precaution to avoid "loosing" a big number of methods in case
178 // this is a spike with no jit after.
179 total_number_of_hot_spikes_++;
180 MutexLock wait_mutex(Thread::Current(), wait_lock_);
181 WakeUpSaver();
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000182 }
183}
184
Calin Juravle85f7bf32016-03-18 16:23:40 +0000185ProfileCompilationInfo* ProfileSaver::GetCachedProfiledInfo(const std::string& filename) {
186 auto info_it = profile_cache_.find(filename);
187 if (info_it == profile_cache_.end()) {
188 info_it = profile_cache_.Put(filename, ProfileCompilationInfo());
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000189 }
Calin Juravle85f7bf32016-03-18 16:23:40 +0000190 return &info_it->second;
191}
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000192
Calin Juravle85f7bf32016-03-18 16:23:40 +0000193void ProfileSaver::FetchAndCacheResolvedClasses() {
194 ScopedTrace trace(__PRETTY_FUNCTION__);
Calin Juravle85f7bf32016-03-18 16:23:40 +0000195 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
196 std::set<DexCacheResolvedClasses> resolved_classes =
197 class_linker->GetResolvedClasses(/*ignore boot classes*/ true);
198 MutexLock mu(Thread::Current(), *Locks::profiler_lock_);
199 uint64_t total_number_of_profile_entries_cached = 0;
Mathieu Chartier9275af62016-04-29 12:03:56 -0700200
Calin Juravle85f7bf32016-03-18 16:23:40 +0000201 for (const auto& it : tracked_dex_base_locations_) {
Mathieu Chartier9275af62016-04-29 12:03:56 -0700202 std::set<DexCacheResolvedClasses> resolved_classes_for_location;
Calin Juravle85f7bf32016-03-18 16:23:40 +0000203 const std::string& filename = it.first;
204 const std::set<std::string>& locations = it.second;
205
206 for (const DexCacheResolvedClasses& classes : resolved_classes) {
Mathieu Chartier9275af62016-04-29 12:03:56 -0700207 if (locations.find(classes.GetBaseLocation()) != locations.end()) {
208 VLOG(profiler) << "Added classes for location " << classes.GetBaseLocation()
209 << " (" << classes.GetDexLocation() << ")";
Calin Juravle85f7bf32016-03-18 16:23:40 +0000210 resolved_classes_for_location.insert(classes);
Mathieu Chartier9275af62016-04-29 12:03:56 -0700211 } else {
212 VLOG(profiler) << "Location not found " << classes.GetBaseLocation()
213 << " (" << classes.GetDexLocation() << ")";
Calin Juravle85f7bf32016-03-18 16:23:40 +0000214 }
215 }
216 ProfileCompilationInfo* info = GetCachedProfiledInfo(filename);
Calin Juravlee2d066d2016-04-19 16:33:46 +0100217 info->AddMethodsAndClasses(std::vector<MethodReference>(), resolved_classes_for_location);
Calin Juravle85f7bf32016-03-18 16:23:40 +0000218 total_number_of_profile_entries_cached += resolved_classes_for_location.size();
219 }
220 max_number_of_profile_entries_cached_ = std::max(
221 max_number_of_profile_entries_cached_,
222 total_number_of_profile_entries_cached);
223}
224
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100225bool ProfileSaver::ProcessProfilingInfo(uint16_t* new_methods) {
Calin Juravle85f7bf32016-03-18 16:23:40 +0000226 ScopedTrace trace(__PRETTY_FUNCTION__);
Calin Juravleb4eddd22016-01-13 15:52:33 -0800227 SafeMap<std::string, std::set<std::string>> tracked_locations;
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000228 {
Calin Juravleb4eddd22016-01-13 15:52:33 -0800229 // Make a copy so that we don't hold the lock while doing I/O.
230 MutexLock mu(Thread::Current(), *Locks::profiler_lock_);
231 tracked_locations = tracked_dex_base_locations_;
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000232 }
Calin Juravlec15e5662016-03-17 17:07:52 +0000233
Calin Juravle85f7bf32016-03-18 16:23:40 +0000234 bool profile_file_saved = false;
235 uint64_t total_number_of_profile_entries_cached = 0;
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100236 *new_methods = 0;
237
Calin Juravleb4eddd22016-01-13 15:52:33 -0800238 for (const auto& it : tracked_locations) {
239 if (ShuttingDown(Thread::Current())) {
240 return true;
241 }
242 const std::string& filename = it.first;
243 const std::set<std::string>& locations = it.second;
Calin Juravlee2d066d2016-04-19 16:33:46 +0100244 std::vector<MethodReference> methods;
Calin Juravleb4eddd22016-01-13 15:52:33 -0800245 {
246 ScopedObjectAccess soa(Thread::Current());
Calin Juravlee2d066d2016-04-19 16:33:46 +0100247 jit_code_cache_->GetProfiledMethods(locations, methods);
Calin Juravlec19c1c22016-03-09 15:37:48 +0000248 total_number_of_code_cache_queries_++;
Calin Juravleb4eddd22016-01-13 15:52:33 -0800249 }
Calin Juravlec15e5662016-03-17 17:07:52 +0000250
Calin Juravle85f7bf32016-03-18 16:23:40 +0000251 ProfileCompilationInfo* cached_info = GetCachedProfiledInfo(filename);
252 cached_info->AddMethodsAndClasses(methods, std::set<DexCacheResolvedClasses>());
Calin Juravle0cdaa6c2016-03-30 18:18:58 +0100253 int64_t delta_number_of_methods =
254 cached_info->GetNumberOfMethods() -
255 static_cast<int64_t>(last_save_number_of_methods_);
256 int64_t delta_number_of_classes =
257 cached_info->GetNumberOfResolvedClasses() -
258 static_cast<int64_t>(last_save_number_of_classes_);
Calin Juravle85f7bf32016-03-18 16:23:40 +0000259
260 if (delta_number_of_methods < kMinimumNumberOfMethodsToSave &&
261 delta_number_of_classes < kMinimumNumberOfClassesToSave) {
Calin Juravle0cdaa6c2016-03-30 18:18:58 +0100262 VLOG(profiler) << "Not enough information to save to: " << filename
Calin Juravle85f7bf32016-03-18 16:23:40 +0000263 << " Nr of methods: " << delta_number_of_methods
264 << " Nr of classes: " << delta_number_of_classes;
Calin Juravlec19c1c22016-03-09 15:37:48 +0000265 total_number_of_skipped_writes_++;
Calin Juravle85f7bf32016-03-18 16:23:40 +0000266 continue;
Calin Juravleb4eddd22016-01-13 15:52:33 -0800267 }
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100268 *new_methods = std::max(static_cast<uint16_t>(delta_number_of_methods), *new_methods);
Calin Juravlec19c1c22016-03-09 15:37:48 +0000269 uint64_t bytes_written;
Calin Juravlefe297a92016-03-24 20:33:22 +0000270 // Force the save. In case the profile data is corrupted or the the profile
271 // has the wrong version this will "fix" the file to the correct format.
272 if (cached_info->MergeAndSave(filename, &bytes_written, /*force*/ true)) {
Calin Juravle85f7bf32016-03-18 16:23:40 +0000273 last_save_number_of_methods_ = cached_info->GetNumberOfMethods();
Calin Juravle0cdaa6c2016-03-30 18:18:58 +0100274 last_save_number_of_classes_ = cached_info->GetNumberOfResolvedClasses();
Calin Juravle85f7bf32016-03-18 16:23:40 +0000275 // Clear resolved classes. No need to store them around as
276 // they don't change after the first write.
277 cached_info->ClearResolvedClasses();
Calin Juravlec19c1c22016-03-09 15:37:48 +0000278 if (bytes_written > 0) {
279 total_number_of_writes_++;
280 total_bytes_written_ += bytes_written;
Calin Juravle0cdaa6c2016-03-30 18:18:58 +0100281 profile_file_saved = true;
Calin Juravle85f7bf32016-03-18 16:23:40 +0000282 } else {
283 // At this point we could still have avoided the write.
284 // We load and merge the data from the file lazily at its first ever
285 // save attempt. So, whatever we are trying to save could already be
286 // in the file.
287 total_number_of_skipped_writes_++;
Calin Juravlec19c1c22016-03-09 15:37:48 +0000288 }
Calin Juravle85f7bf32016-03-18 16:23:40 +0000289 } else {
290 LOG(WARNING) << "Could not save profiling info to " << filename;
291 total_number_of_failed_writes_++;
Calin Juravleb4eddd22016-01-13 15:52:33 -0800292 }
Calin Juravle85f7bf32016-03-18 16:23:40 +0000293 total_number_of_profile_entries_cached +=
294 cached_info->GetNumberOfMethods() +
295 cached_info->GetNumberOfResolvedClasses();
Calin Juravleb4eddd22016-01-13 15:52:33 -0800296 }
Calin Juravle85f7bf32016-03-18 16:23:40 +0000297 max_number_of_profile_entries_cached_ = std::max(
298 max_number_of_profile_entries_cached_,
299 total_number_of_profile_entries_cached);
300 return profile_file_saved;
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000301}
302
303void* ProfileSaver::RunProfileSaverThread(void* arg) {
304 Runtime* runtime = Runtime::Current();
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000305
Calin Juravlee55fda12016-04-28 12:59:33 +0100306 bool attached = runtime->AttachCurrentThread("Profile Saver",
307 /*as_daemon*/true,
308 runtime->GetSystemThreadGroup(),
309 /*create_peer*/true);
310 if (!attached) {
311 CHECK(runtime->IsShuttingDown(Thread::Current()));
312 return nullptr;
313 }
314
315 ProfileSaver* profile_saver = reinterpret_cast<ProfileSaver*>(arg);
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000316 profile_saver->Run();
317
318 runtime->DetachCurrentThread();
319 VLOG(profiler) << "Profile saver shutdown";
320 return nullptr;
321}
322
Calin Juravle6044fa72016-03-25 17:17:09 +0000323static bool ShouldProfileLocation(const std::string& location) {
Calin Juravle75064232016-04-18 16:38:27 +0100324 OatFileManager& oat_manager = Runtime::Current()->GetOatFileManager();
325 const OatFile* oat_file = oat_manager.FindOpenedOatFileFromDexLocation(location);
Calin Juravle6044fa72016-03-25 17:17:09 +0000326 if (oat_file == nullptr) {
327 // This can happen if we fallback to run code directly from the APK.
328 // Profile it with the hope that the background dexopt will get us back into
329 // a good state.
Calin Juravle75064232016-04-18 16:38:27 +0100330 VLOG(profiler) << "Asked to profile a location without an oat file:" << location;
Calin Juravle6044fa72016-03-25 17:17:09 +0000331 return true;
332 }
333 CompilerFilter::Filter filter = oat_file->GetCompilerFilter();
Calin Juravled19dc462016-04-19 18:17:41 +0100334 if ((filter == CompilerFilter::kSpeed) || (filter == CompilerFilter::kEverything)) {
Calin Juravle75064232016-04-18 16:38:27 +0100335 VLOG(profiler)
Calin Juravled19dc462016-04-19 18:17:41 +0100336 << "Skip profiling oat file because it's already speed|everything compiled: "
337 << location << " oat location: " << oat_file->GetLocation();
Calin Juravle6044fa72016-03-25 17:17:09 +0000338 return false;
339 }
340 return true;
341}
342
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000343void ProfileSaver::Start(const std::string& output_filename,
344 jit::JitCodeCache* jit_code_cache,
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000345 const std::vector<std::string>& code_paths,
346 const std::string& foreign_dex_profile_path,
347 const std::string& app_data_dir) {
Calin Juravlee5de54c2016-04-20 14:22:09 +0100348 DCHECK(Runtime::Current()->SaveProfileInfo());
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000349 DCHECK(!output_filename.empty());
350 DCHECK(jit_code_cache != nullptr);
351
Calin Juravle6044fa72016-03-25 17:17:09 +0000352 std::vector<std::string> code_paths_to_profile;
353
354 for (const std::string& location : code_paths) {
355 if (ShouldProfileLocation(location)) {
356 code_paths_to_profile.push_back(location);
Calin Juravle6044fa72016-03-25 17:17:09 +0000357 }
358 }
359 if (code_paths_to_profile.empty()) {
Calin Juravle75064232016-04-18 16:38:27 +0100360 VLOG(profiler) << "No code paths should be profiled.";
Calin Juravle6044fa72016-03-25 17:17:09 +0000361 return;
362 }
363
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000364 MutexLock mu(Thread::Current(), *Locks::profiler_lock_);
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000365 if (instance_ != nullptr) {
Calin Juravleb4eddd22016-01-13 15:52:33 -0800366 // If we already have an instance, make sure it uses the same jit_code_cache.
367 // This may be called multiple times via Runtime::registerAppInfo (e.g. for
368 // apps which share the same runtime).
369 DCHECK_EQ(instance_->jit_code_cache_, jit_code_cache);
370 // Add the code_paths to the tracked locations.
Calin Juravle20ae7932016-04-18 18:59:22 +0100371 instance_->AddTrackedLocations(output_filename, app_data_dir, code_paths_to_profile);
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000372 return;
373 }
374
375 VLOG(profiler) << "Starting profile saver using output file: " << output_filename
Calin Juravle75064232016-04-18 16:38:27 +0100376 << ". Tracking: " << Join(code_paths_to_profile, ':');
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000377
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000378 instance_ = new ProfileSaver(output_filename,
379 jit_code_cache,
Calin Juravle75064232016-04-18 16:38:27 +0100380 code_paths_to_profile,
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000381 foreign_dex_profile_path,
382 app_data_dir);
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000383
384 // Create a new thread which does the saving.
385 CHECK_PTHREAD_CALL(
386 pthread_create,
387 (&profiler_pthread_, nullptr, &RunProfileSaverThread, reinterpret_cast<void*>(instance_)),
388 "Profile saver thread");
389}
390
Calin Juravlec19c1c22016-03-09 15:37:48 +0000391void ProfileSaver::Stop(bool dump_info) {
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000392 ProfileSaver* profile_saver = nullptr;
393 pthread_t profiler_pthread = 0U;
394
395 {
396 MutexLock profiler_mutex(Thread::Current(), *Locks::profiler_lock_);
Calin Juravleb4eddd22016-01-13 15:52:33 -0800397 VLOG(profiler) << "Stopping profile saver thread";
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000398 profile_saver = instance_;
399 profiler_pthread = profiler_pthread_;
400 if (instance_ == nullptr) {
401 DCHECK(false) << "Tried to stop a profile saver which was not started";
402 return;
403 }
404 if (instance_->shutting_down_) {
405 DCHECK(false) << "Tried to stop the profile saver twice";
406 return;
407 }
408 instance_->shutting_down_ = true;
Calin Juravlec19c1c22016-03-09 15:37:48 +0000409 if (dump_info) {
410 instance_->DumpInfo(LOG(INFO));
411 }
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000412 }
413
414 {
415 // Wake up the saver thread if it is sleeping to allow for a clean exit.
416 MutexLock wait_mutex(Thread::Current(), profile_saver->wait_lock_);
417 profile_saver->period_condition_.Signal(Thread::Current());
418 }
419
420 // Wait for the saver thread to stop.
421 CHECK_PTHREAD_CALL(pthread_join, (profiler_pthread, nullptr), "profile saver thread shutdown");
422
423 {
424 MutexLock profiler_mutex(Thread::Current(), *Locks::profiler_lock_);
425 instance_ = nullptr;
426 profiler_pthread_ = 0U;
427 }
428 delete profile_saver;
429}
430
431bool ProfileSaver::ShuttingDown(Thread* self) {
432 MutexLock mu(self, *Locks::profiler_lock_);
433 return shutting_down_;
434}
435
436bool ProfileSaver::IsStarted() {
437 MutexLock mu(Thread::Current(), *Locks::profiler_lock_);
438 return instance_ != nullptr;
439}
440
Calin Juravleb4eddd22016-01-13 15:52:33 -0800441void ProfileSaver::AddTrackedLocations(const std::string& output_filename,
Calin Juravle20ae7932016-04-18 18:59:22 +0100442 const std::string& app_data_dir,
Calin Juravleb4eddd22016-01-13 15:52:33 -0800443 const std::vector<std::string>& code_paths) {
444 auto it = tracked_dex_base_locations_.find(output_filename);
445 if (it == tracked_dex_base_locations_.end()) {
446 tracked_dex_base_locations_.Put(output_filename,
447 std::set<std::string>(code_paths.begin(), code_paths.end()));
Calin Juravle20ae7932016-04-18 18:59:22 +0100448 app_data_dirs_.insert(app_data_dir);
Calin Juravleb4eddd22016-01-13 15:52:33 -0800449 } else {
450 it->second.insert(code_paths.begin(), code_paths.end());
451 }
452}
453
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000454void ProfileSaver::NotifyDexUse(const std::string& dex_location) {
Calin Juravle6044fa72016-03-25 17:17:09 +0000455 if (!ShouldProfileLocation(dex_location)) {
456 return;
457 }
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000458 std::set<std::string> app_code_paths;
459 std::string foreign_dex_profile_path;
Calin Juravle20ae7932016-04-18 18:59:22 +0100460 std::set<std::string> app_data_dirs;
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000461 {
462 MutexLock mu(Thread::Current(), *Locks::profiler_lock_);
Calin Juravlec19c1c22016-03-09 15:37:48 +0000463 if (instance_ == nullptr) {
464 return;
465 }
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000466 // Make a copy so that we don't hold the lock while doing I/O.
467 for (const auto& it : instance_->tracked_dex_base_locations_) {
468 app_code_paths.insert(it.second.begin(), it.second.end());
469 }
470 foreign_dex_profile_path = instance_->foreign_dex_profile_path_;
Calin Juravle20ae7932016-04-18 18:59:22 +0100471 app_data_dirs.insert(instance_->app_data_dirs_.begin(), instance_->app_data_dirs_.end());
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000472 }
473
Calin Juravlec19c1c22016-03-09 15:37:48 +0000474 bool mark_created = MaybeRecordDexUseInternal(dex_location,
475 app_code_paths,
476 foreign_dex_profile_path,
Calin Juravle20ae7932016-04-18 18:59:22 +0100477 app_data_dirs);
Calin Juravlec19c1c22016-03-09 15:37:48 +0000478 if (mark_created) {
479 MutexLock mu(Thread::Current(), *Locks::profiler_lock_);
480 if (instance_ != nullptr) {
481 instance_->total_number_of_foreign_dex_marks_++;
482 }
483 }
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000484}
485
Calin Juravlec19c1c22016-03-09 15:37:48 +0000486bool ProfileSaver::MaybeRecordDexUseInternal(
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000487 const std::string& dex_location,
488 const std::set<std::string>& app_code_paths,
489 const std::string& foreign_dex_profile_path,
Calin Juravle20ae7932016-04-18 18:59:22 +0100490 const std::set<std::string>& app_data_dirs) {
Calin Juravle1fae45f2016-03-08 12:52:52 +0000491 if (dex_location.empty()) {
492 LOG(WARNING) << "Asked to record foreign dex use with an empty dex location.";
Calin Juravlec19c1c22016-03-09 15:37:48 +0000493 return false;
Calin Juravle1fae45f2016-03-08 12:52:52 +0000494 }
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000495 if (foreign_dex_profile_path.empty()) {
496 LOG(WARNING) << "Asked to record foreign dex use without a valid profile path ";
Calin Juravlec19c1c22016-03-09 15:37:48 +0000497 return false;
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000498 }
499
500 UniqueCPtr<const char[]> dex_location_real_path(realpath(dex_location.c_str(), nullptr));
Calin Juravle1fae45f2016-03-08 12:52:52 +0000501 if (dex_location_real_path == nullptr) {
502 PLOG(WARNING) << "Could not get realpath for " << dex_location;
503 }
504 std::string dex_location_real_path_str((dex_location_real_path == nullptr)
505 ? dex_location.c_str()
506 : dex_location_real_path.get());
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000507
Calin Juravle20ae7932016-04-18 18:59:22 +0100508 if (app_data_dirs.find(dex_location_real_path_str) != app_data_dirs.end()) {
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000509 // The dex location is under the application folder. Nothing to record.
Calin Juravlec19c1c22016-03-09 15:37:48 +0000510 return false;
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000511 }
512
513 if (app_code_paths.find(dex_location) != app_code_paths.end()) {
514 // The dex location belongs to the application code paths. Nothing to record.
Calin Juravlec19c1c22016-03-09 15:37:48 +0000515 return false;
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000516 }
517 // Do another round of checks with the real paths.
518 // Note that we could cache all the real locations in the saver (since it's an expensive
519 // operation). However we expect that app_code_paths is small (usually 1 element), and
520 // NotifyDexUse is called just a few times in the app lifetime. So we make the compromise
521 // to save some bytes of memory usage.
522 for (const auto& app_code_location : app_code_paths) {
523 UniqueCPtr<const char[]> real_app_code_location(realpath(app_code_location.c_str(), nullptr));
Calin Juravle1fae45f2016-03-08 12:52:52 +0000524 if (real_app_code_location == nullptr) {
525 PLOG(WARNING) << "Could not get realpath for " << app_code_location;
526 }
527 std::string real_app_code_location_str((real_app_code_location == nullptr)
528 ? app_code_location.c_str()
529 : real_app_code_location.get());
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000530 if (real_app_code_location_str == dex_location_real_path_str) {
531 // The dex location belongs to the application code paths. Nothing to record.
Calin Juravlec19c1c22016-03-09 15:37:48 +0000532 return false;
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000533 }
534 }
535
536 // For foreign dex files we record a flag on disk. PackageManager will (potentially) take this
537 // into account when deciding how to optimize the loaded dex file.
538 // The expected flag name is the canonical path of the apk where '/' is substituted to '@'.
539 // (it needs to be kept in sync with
540 // frameworks/base/services/core/java/com/android/server/pm/PackageDexOptimizer.java)
541 std::replace(dex_location_real_path_str.begin(), dex_location_real_path_str.end(), '/', '@');
542 std::string flag_path = foreign_dex_profile_path + "/" + dex_location_real_path_str;
Richard Uhler12e41572016-05-10 14:01:18 -0700543 // We use O_RDONLY as the access mode because we must supply some access
544 // mode, and there is no access mode that means 'create but do not read' the
545 // file. We will not not actually read from the file.
546 int fd = TEMP_FAILURE_RETRY(open(flag_path.c_str(),
547 O_CREAT | O_RDONLY | O_EXCL | O_CLOEXEC | O_NOFOLLOW, 0));
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000548 if (fd != -1) {
549 if (close(fd) != 0) {
550 PLOG(WARNING) << "Could not close file after flagging foreign dex use " << flag_path;
551 }
Calin Juravlec19c1c22016-03-09 15:37:48 +0000552 return true;
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000553 } else {
Richard Uhler12e41572016-05-10 14:01:18 -0700554 if (errno != EEXIST && errno != EACCES) {
555 // Another app could have already created the file, and selinux may not
556 // allow the read access to the file implied by the call to open.
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000557 PLOG(WARNING) << "Could not create foreign dex use mark " << flag_path;
Calin Juravlec19c1c22016-03-09 15:37:48 +0000558 return false;
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000559 }
Calin Juravlec19c1c22016-03-09 15:37:48 +0000560 return true;
Calin Juravle86a9ebe2016-02-24 10:13:09 +0000561 }
562}
563
Calin Juravlec19c1c22016-03-09 15:37:48 +0000564void ProfileSaver::DumpInstanceInfo(std::ostream& os) {
565 MutexLock mu(Thread::Current(), *Locks::profiler_lock_);
566 if (instance_ != nullptr) {
567 instance_->DumpInfo(os);
568 }
569}
570
571void ProfileSaver::DumpInfo(std::ostream& os) {
572 os << "ProfileSaver total_bytes_written=" << total_bytes_written_ << '\n'
573 << "ProfileSaver total_number_of_writes=" << total_number_of_writes_ << '\n'
Calin Juravle85f7bf32016-03-18 16:23:40 +0000574 << "ProfileSaver total_number_of_code_cache_queries="
575 << total_number_of_code_cache_queries_ << '\n'
Calin Juravlec19c1c22016-03-09 15:37:48 +0000576 << "ProfileSaver total_number_of_skipped_writes=" << total_number_of_skipped_writes_ << '\n'
577 << "ProfileSaver total_number_of_failed_writes=" << total_number_of_failed_writes_ << '\n'
Calin Juravle85f7bf32016-03-18 16:23:40 +0000578 << "ProfileSaver total_ms_of_sleep=" << total_ms_of_sleep_ << '\n'
Calin Juravle6044fa72016-03-25 17:17:09 +0000579 << "ProfileSaver total_ms_of_work=" << NsToMs(total_ns_of_work_) << '\n'
Calin Juravle85f7bf32016-03-18 16:23:40 +0000580 << "ProfileSaver total_number_of_foreign_dex_marks="
581 << total_number_of_foreign_dex_marks_ << '\n'
582 << "ProfileSaver max_number_profile_entries_cached="
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100583 << max_number_of_profile_entries_cached_ << '\n'
584 << "ProfileSaver total_number_of_hot_spikes=" << total_number_of_hot_spikes_ << '\n'
585 << "ProfileSaver total_number_of_wake_ups=" << total_number_of_wake_ups_ << '\n';
Calin Juravlec19c1c22016-03-09 15:37:48 +0000586}
587
Calin Juravlee5de54c2016-04-20 14:22:09 +0100588
589void ProfileSaver::ForceProcessProfiles() {
590 ProfileSaver* saver = nullptr;
591 {
592 MutexLock mu(Thread::Current(), *Locks::profiler_lock_);
593 saver = instance_;
594 }
595 // TODO(calin): this is not actually thread safe as the instance_ may have been deleted,
596 // but we only use this in testing when we now this won't happen.
597 // Refactor the way we handle the instance so that we don't end up in this situation.
598 if (saver != nullptr) {
Calin Juravle5fbb0fe2016-04-29 16:44:11 +0100599 uint16_t new_methods;
600 saver->ProcessProfilingInfo(&new_methods);
Calin Juravlee5de54c2016-04-20 14:22:09 +0100601 }
602}
603
604bool ProfileSaver::HasSeenMethod(const std::string& profile,
605 const DexFile* dex_file,
606 uint16_t method_idx) {
607 MutexLock mu(Thread::Current(), *Locks::profiler_lock_);
608 if (instance_ != nullptr) {
609 ProfileCompilationInfo* info = instance_->GetCachedProfiledInfo(profile);
610 if (info != nullptr) {
611 return info->ContainsMethod(MethodReference(dex_file, method_idx));
612 }
613 }
614 return false;
615}
616
Calin Juravle4d77b6a2015-12-01 18:38:09 +0000617} // namespace art