3 ** Copyright 2015, The Android Open Source Project
5 ** Licensed under the Apache License, Version 2.0 (the "License");
6 ** you may not use this file except in compliance with the License.
7 ** You may obtain a copy of the License at
9 ** http://www.apache.org/licenses/LICENSE-2.0
11 ** Unless required by applicable law or agreed to in writing, software
12 ** distributed under the License is distributed on an "AS IS" BASIS,
13 ** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 ** See the License for the specific language governing permissions and
15 ** limitations under the License.
27 #include <sys/types.h>
37 #include <android-base/file.h>
38 #include <android-base/stringprintf.h>
39 #include <cutils/properties.h>
41 #include "perfprofdcore.h"
42 #include "perfprofdutils.h"
43 #include "perf_data_converter.h"
44 #include "cpuconfig.h"
45 #include "configreader.h"
48 // Perf profiling daemon -- collects system-wide profiles using
50 // simpleperf record -a
52 // and encodes them so that they can be uploaded by a separate service.
55 //......................................................................
58 // Output file from 'perf record'.
60 #define PERF_OUTPUT "perf.data"
63 // This enum holds the results of the "should we profile" configuration check.
67 // All systems go for profile collection.
70 // The selected configuration directory doesn't exist.
71 DONT_PROFILE_MISSING_CONFIG_DIR,
73 // Destination directory does not contain the semaphore file that
74 // the perf profile uploading service creates when it determines
75 // that the user has opted "in" for usage data collection. No
76 // semaphore -> no user approval -> no profiling.
77 DONT_PROFILE_MISSING_SEMAPHORE,
79 // No perf executable present
80 DONT_PROFILE_MISSING_PERF_EXECUTABLE,
82 // We're running in the emulator, perf won't be able to do much
83 DONT_PROFILE_RUNNING_IN_EMULATOR
88 // Are we running in the emulator? If so, stub out profile collection
89 // Starts as uninitialized (-1), then set to 1 or 0 at init time.
91 static int running_in_emulator = -1;
94 // Is this a debug build ('userdebug' or 'eng')?
95 // Starts as uninitialized (-1), then set to 1 or 0 at init time.
97 static int is_debug_build = -1;
100 // Random number generator seed (set at startup time).
102 static unsigned short random_seed[3];
105 // SIGHUP handler. Sending SIGHUP to the daemon can be used to break it
106 // out of a sleep() call so as to trigger a new collection (debugging)
108 static void sig_hup(int /* signum */)
110 W_ALOGW("SIGHUP received");
114 // Parse command line args. Currently you can supply "-c P" to set
115 // the path of the config file to P.
117 static void parse_args(int argc, char** argv)
121 for (ac = 1; ac < argc; ++ac) {
122 if (!strcmp(argv[ac], "-c")) {
124 W_ALOGE("malformed command line: -c option requires argument)");
127 ConfigReader::setConfigFilePath(argv[ac+1]);
130 W_ALOGE("malformed command line: unknown option or arg %s)", argv[ac]);
137 // Convert a CKPROFILE_RESULT to a string
139 const char *ckprofile_result_to_string(CKPROFILE_RESULT result)
142 case DO_COLLECT_PROFILE:
143 return "DO_COLLECT_PROFILE";
144 case DONT_PROFILE_MISSING_CONFIG_DIR:
145 return "missing config directory";
146 case DONT_PROFILE_MISSING_SEMAPHORE:
147 return "missing semaphore file";
148 case DONT_PROFILE_MISSING_PERF_EXECUTABLE:
149 return "missing 'perf' executable";
150 case DONT_PROFILE_RUNNING_IN_EMULATOR:
151 return "running in emulator";
152 default: return "unknown";
158 // Convert a PROFILE_RESULT to a string
160 const char *profile_result_to_string(PROFILE_RESULT result)
163 case OK_PROFILE_COLLECTION:
164 return "profile collection succeeded";
165 case ERR_FORK_FAILED:
166 return "fork() system call failed";
167 case ERR_PERF_RECORD_FAILED:
168 return "perf record returned bad exit status";
169 case ERR_PERF_ENCODE_FAILED:
170 return "failure encoding perf.data to protobuf";
171 case ERR_OPEN_ENCODED_FILE_FAILED:
172 return "failed to open encoded perf file";
173 case ERR_WRITE_ENCODED_FILE_FAILED:
174 return "write to encoded perf file failed";
175 default: return "unknown";
181 // Check to see whether we should perform a profile collection
183 static CKPROFILE_RESULT check_profiling_enabled(ConfigReader &config)
186 // Profile collection in the emulator doesn't make sense
188 assert(running_in_emulator != -1);
189 if (running_in_emulator) {
190 return DONT_PROFILE_RUNNING_IN_EMULATOR;
194 // Check for existence of semaphore file in config directory
196 if (access(config.getStringValue("config_directory").c_str(), F_OK) == -1) {
197 W_ALOGW("unable to open config directory %s: (%s)",
198 config.getStringValue("config_directory").c_str(), strerror(errno));
199 return DONT_PROFILE_MISSING_CONFIG_DIR;
203 // Check for existence of semaphore file
204 std::string semaphore_filepath = config.getStringValue("config_directory")
205 + "/" + SEMAPHORE_FILENAME;
206 if (access(semaphore_filepath.c_str(), F_OK) == -1) {
207 return DONT_PROFILE_MISSING_SEMAPHORE;
210 // Check for existence of simpleperf/perf executable
211 std::string pp = config.getStringValue("perf_path");
212 if (access(pp.c_str(), R_OK|X_OK) == -1) {
213 W_ALOGW("unable to access/execute %s", pp.c_str());
214 return DONT_PROFILE_MISSING_PERF_EXECUTABLE;
220 return DO_COLLECT_PROFILE;
225 char propBuf[PROPERTY_VALUE_MAX];
227 property_get("sys.boot_completed", propBuf, "");
228 return (propBuf[0] != '1');
232 // Constructor takes a timeout (in seconds) and a child pid; If an
233 // alarm set for the specified number of seconds triggers, then a
234 // SIGKILL is sent to the child. Destructor resets alarm. Example:
236 // pid_t child_pid = ...;
237 // { AlarmHelper h(10, child_pid);
238 // ... = read_from_child(child_pid, ...);
241 // NB: this helper is not re-entrant-- avoid nested use or
242 // use by multiple threads
246 AlarmHelper(unsigned num_seconds, pid_t child)
248 struct sigaction sigact;
251 memset(&sigact, 0, sizeof(sigact));
252 sigact.sa_sigaction = handler;
253 sigaction(SIGALRM, &sigact, &oldsigact_);
261 sigaction(SIGALRM, &oldsigact_, NULL);
263 static void handler(int, siginfo_t *, void *);
266 struct sigaction oldsigact_;
270 pid_t AlarmHelper::child_;
272 void AlarmHelper::handler(int, siginfo_t *, void *)
274 W_ALOGW("SIGALRM timeout");
275 kill(child_, SIGKILL);
279 // This implementation invokes "dumpsys media.camera" and inspects the
280 // output to determine if any camera clients are active. NB: this is
281 // currently disable (via config option) until the selinux issues can
282 // be sorted out. Another possible implementation (not yet attempted)
283 // would be to use the binder to call into the native camera service
284 // via "ICameraService".
286 bool get_camera_active()
289 if (pipe2(pipefds, O_CLOEXEC) != 0) {
290 W_ALOGE("pipe2() failed (%s)", strerror(errno));
295 W_ALOGE("fork() failed (%s)", strerror(errno));
299 } else if (pid == 0) {
302 dup2(pipefds[1], fileno(stderr));
303 dup2(pipefds[1], fileno(stdout));
304 const char *argv[10];
306 argv[slot++] = "/system/bin/dumpsys";
307 argv[slot++] = "media.camera";
308 argv[slot++] = nullptr;
309 execvp(argv[0], (char * const *)argv);
310 W_ALOGE("execvp() failed (%s)", strerror(errno));
314 AlarmHelper helper(10, pid);
318 bool have_cam = false;
319 bool have_clients = true;
320 std::string dump_output;
321 bool result = android::base::ReadFdToString(pipefds[0], &dump_output);
324 std::stringstream ss(dump_output);
326 while (std::getline(ss,line,'\n')) {
327 if (line.find("Camera module API version:") !=
331 if (line.find("No camera module available") !=
333 line.find("No active camera clients yet") !=
335 have_clients = false;
340 // reap child (no zombies please)
342 TEMP_FAILURE_RETRY(waitpid(pid, &st, 0));
343 return have_cam && have_clients;
348 std::string psdir("/sys/class/power_supply");
349 DIR* dir = opendir(psdir.c_str());
351 W_ALOGE("Failed to open dir %s (%s)", psdir.c_str(), strerror(errno));
356 while ((e = readdir(dir)) != 0) {
357 if (e->d_name[0] != '.') {
358 std::string online_path = psdir + "/" + e->d_name + "/online";
359 std::string contents;
361 if (android::base::ReadFileToString(online_path.c_str(), &contents) &&
362 sscanf(contents.c_str(), "%d", &value) == 1) {
374 bool postprocess_proc_stat_contents(const std::string &pscontents,
375 long unsigned *idleticks,
376 long unsigned *remainingticks)
378 long unsigned usertime, nicetime, systime, idletime, iowaittime;
379 long unsigned irqtime, softirqtime;
381 int rc = sscanf(pscontents.c_str(), "cpu %lu %lu %lu %lu %lu %lu %lu",
382 &usertime, &nicetime, &systime, &idletime,
383 &iowaittime, &irqtime, &softirqtime);
387 *idleticks = idletime;
388 *remainingticks = usertime + nicetime + systime + iowaittime + irqtime + softirqtime;
392 unsigned collect_cpu_utilization()
394 std::string contents;
395 long unsigned idle[2];
396 long unsigned busy[2];
397 for (unsigned iter = 0; iter < 2; ++iter) {
398 if (!android::base::ReadFileToString("/proc/stat", &contents)) {
401 if (!postprocess_proc_stat_contents(contents, &idle[iter], &busy[iter])) {
408 long unsigned total_delta = (idle[1] + busy[1]) - (idle[0] + busy[0]);
409 long unsigned busy_delta = busy[1] - busy[0];
410 return busy_delta * 100 / total_delta;
413 static void annotate_encoded_perf_profile(wireless_android_play_playlog::AndroidPerfProfile *profile,
414 const ConfigReader &config,
415 unsigned cpu_utilization)
418 // Incorporate cpu utilization (collected prior to perf run)
420 if (config.getUnsignedValue("collect_cpu_utilization")) {
421 profile->set_cpu_utilization(cpu_utilization);
425 // Load average as reported by the kernel
429 if (android::base::ReadFileToString("/proc/loadavg", &load) &&
430 sscanf(load.c_str(), "%lf", &fload) == 1) {
431 int iload = static_cast<int>(fload * 100.0);
432 profile->set_sys_load_average(iload);
434 W_ALOGE("Failed to read or scan /proc/loadavg (%s)", strerror(errno));
438 // Device still booting? Camera in use? Plugged into charger?
440 bool is_booting = get_booting();
441 if (config.getUnsignedValue("collect_booting")) {
442 profile->set_booting(is_booting);
444 if (config.getUnsignedValue("collect_camera_active")) {
445 profile->set_camera_active(is_booting ? false : get_camera_active());
447 if (config.getUnsignedValue("collect_charging_state")) {
448 profile->set_on_charger(get_charging());
452 // Examine the contents of wake_unlock to determine whether the
453 // device display is on or off. NB: is this really the only way to
454 // determine this info?
457 if (android::base::ReadFileToString("/sys/power/wake_unlock", &disp)) {
458 bool ison = (strstr(disp.c_str(), "PowerManagerService.Display") == 0);
459 profile->set_display_on(ison);
461 W_ALOGE("Failed to read /sys/power/wake_unlock (%s)", strerror(errno));
465 inline char* string_as_array(std::string* str) {
466 return str->empty() ? NULL : &*str->begin();
469 PROFILE_RESULT encode_to_proto(const std::string &data_file_path,
470 const char *encoded_file_path,
471 const ConfigReader &config,
472 unsigned cpu_utilization)
475 // Open and read perf.data file
477 const wireless_android_play_playlog::AndroidPerfProfile &encodedProfile =
478 wireless_android_logging_awp::RawPerfDataToAndroidPerfProfile(data_file_path);
481 // Issue error if no samples
483 if (encodedProfile.programs().size() == 0) {
484 return ERR_PERF_ENCODE_FAILED;
487 // All of the info in 'encodedProfile' is derived from the perf.data file;
488 // here we tack display status, cpu utilization, system load, etc.
489 wireless_android_play_playlog::AndroidPerfProfile &prof =
490 const_cast<wireless_android_play_playlog::AndroidPerfProfile&>
492 annotate_encoded_perf_profile(&prof, config, cpu_utilization);
495 // Serialize protobuf to array
497 int size = encodedProfile.ByteSize();
500 ::google::protobuf::uint8* dtarget =
501 reinterpret_cast<::google::protobuf::uint8*>(string_as_array(&data));
502 encodedProfile.SerializeWithCachedSizesToArray(dtarget);
505 // Open file and write encoded data to it
507 FILE *fp = fopen(encoded_file_path, "w");
509 return ERR_OPEN_ENCODED_FILE_FAILED;
512 if (fwrite(dtarget, fsiz, 1, fp) != 1) {
514 return ERR_WRITE_ENCODED_FILE_FAILED;
517 chmod(encoded_file_path, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH);
519 return OK_PROFILE_COLLECTION;
523 // Invoke "perf record". Return value is OK_PROFILE_COLLECTION for
524 // success, or some other error code if something went wrong.
526 static PROFILE_RESULT invoke_perf(const std::string &perf_path,
527 unsigned sampling_period,
528 const char *stack_profile_opt,
530 const std::string &data_file_path,
531 const std::string &perf_stderr_path)
536 return ERR_FORK_FAILED;
542 // Open file to receive stderr/stdout from perf
543 FILE *efp = fopen(perf_stderr_path.c_str(), "w");
545 dup2(fileno(efp), STDERR_FILENO);
546 dup2(fileno(efp), STDOUT_FILENO);
548 W_ALOGW("unable to open %s for writing", perf_stderr_path.c_str());
551 // marshall arguments
552 constexpr unsigned max_args = 12;
553 const char *argv[max_args];
555 argv[slot++] = perf_path.c_str();
556 argv[slot++] = "record";
560 argv[slot++] = data_file_path.c_str();
564 std::string p_str = android::base::StringPrintf("%u", sampling_period);
565 argv[slot++] = p_str.c_str();
568 if (stack_profile_opt)
569 argv[slot++] = stack_profile_opt;
571 // system wide profiling
575 argv[slot++] = "/system/bin/sleep";
576 std::string d_str = android::base::StringPrintf("%u", duration);
577 argv[slot++] = d_str.c_str();
580 argv[slot++] = nullptr;
581 assert(slot < max_args);
583 // record the final command line in the error output file for
584 // posterity/debugging purposes
585 fprintf(stderr, "perf invocation (pid=%d):\n", getpid());
586 for (unsigned i = 0; argv[i] != nullptr; ++i) {
587 fprintf(stderr, "%s%s", i ? " " : "", argv[i]);
589 fprintf(stderr, "\n");
592 execvp(argv[0], (char * const *)argv);
593 fprintf(stderr, "exec failed: %s\n", strerror(errno));
599 pid_t reaped = TEMP_FAILURE_RETRY(waitpid(pid, &st, 0));
602 W_ALOGW("waitpid failed: %s", strerror(errno));
603 } else if (WIFSIGNALED(st)) {
604 W_ALOGW("perf killed by signal %d", WTERMSIG(st));
605 } else if (WEXITSTATUS(st) != 0) {
606 W_ALOGW("perf bad exit status %d", WEXITSTATUS(st));
608 return OK_PROFILE_COLLECTION;
612 return ERR_PERF_RECORD_FAILED;
616 // Remove all files in the destination directory during initialization
618 static void cleanup_destination_dir(const ConfigReader &config)
620 std::string dest_dir = config.getStringValue("destination_directory");
621 DIR* dir = opendir(dest_dir.c_str());
624 while ((e = readdir(dir)) != 0) {
625 if (e->d_name[0] != '.') {
626 std::string file_path = dest_dir + "/" + e->d_name;
627 remove(file_path.c_str());
632 W_ALOGW("unable to open destination dir %s for cleanup",
638 // Post-processes after profile is collected and converted to protobuf.
639 // * GMS core stores processed file sequence numbers in
640 // /data/data/com.google.android.gms/files/perfprofd_processed.txt
641 // * Update /data/misc/perfprofd/perfprofd_produced.txt to remove the sequence
642 // numbers that have been processed and append the current seq number
643 // Returns true if the current_seq should increment.
645 static bool post_process(const ConfigReader &config, int current_seq)
647 std::string dest_dir = config.getStringValue("destination_directory");
648 std::string processed_file_path =
649 config.getStringValue("config_directory") + "/" + PROCESSED_FILENAME;
650 std::string produced_file_path = dest_dir + "/" + PRODUCED_FILENAME;
653 std::set<int> processed;
654 FILE *fp = fopen(processed_file_path.c_str(), "r");
657 while(fscanf(fp, "%d\n", &seq) > 0) {
658 if (remove(android::base::StringPrintf(
659 "%s/perf.data.encoded.%d", dest_dir.c_str(),seq).c_str()) == 0) {
660 processed.insert(seq);
666 std::set<int> produced;
667 fp = fopen(produced_file_path.c_str(), "r");
670 while(fscanf(fp, "%d\n", &seq) > 0) {
671 if (processed.find(seq) == processed.end()) {
672 produced.insert(seq);
678 unsigned maxLive = config.getUnsignedValue("max_unprocessed_profiles");
679 if (produced.size() >= maxLive) {
683 produced.insert(current_seq);
684 fp = fopen(produced_file_path.c_str(), "w");
686 W_ALOGW("Cannot write %s", produced_file_path.c_str());
689 for (std::set<int>::const_iterator iter = produced.begin();
690 iter != produced.end(); ++iter) {
691 fprintf(fp, "%d\n", *iter);
694 chmod(produced_file_path.c_str(),
695 S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH);
700 // Collect a perf profile. Steps for this operation are:
701 // - kick off 'perf record'
702 // - read perf.data, convert to protocol buf
704 static PROFILE_RESULT collect_profile(const ConfigReader &config, int seq)
707 // Collect cpu utilization if enabled
709 unsigned cpu_utilization = 0;
710 if (config.getUnsignedValue("collect_cpu_utilization")) {
711 cpu_utilization = collect_cpu_utilization();
715 // Form perf.data file name, perf error output file name
717 std::string destdir = config.getStringValue("destination_directory");
718 std::string data_file_path(destdir);
719 data_file_path += "/";
720 data_file_path += PERF_OUTPUT;
721 std::string perf_stderr_path(destdir);
722 perf_stderr_path += "/perferr.txt";
725 // Remove any existing perf.data file -- if we don't do this, perf
726 // will rename the old file and we'll have extra cruft lying around.
729 if (stat(data_file_path.c_str(), &statb) == 0) { // if file exists...
730 if (unlink(data_file_path.c_str())) { // then try to remove
731 W_ALOGW("unable to unlink previous perf.data file");
736 // The "mpdecision" daemon can cause problems for profile
737 // collection: if it decides to online a CPU partway through the
738 // 'perf record' run, the activity on that CPU will be invisible to
739 // perf, and if it offlines a CPU during the recording this can
740 // sometimes leave the PMU in an unusable state (dmesg errors of the
741 // form "perfevents: unable to request IRQXXX for ..."). To avoid
742 // these issues, if "mpdecision" is running the helper below will
743 // stop the service and then online all available CPUs. The object
744 // destructor (invoked when this routine terminates) will then
745 // restart the service again when needed.
747 unsigned duration = config.getUnsignedValue("sample_duration");
748 unsigned hardwire = config.getUnsignedValue("hardwire_cpus");
749 unsigned max_duration = config.getUnsignedValue("hardwire_cpus_max_duration");
750 bool take_action = (hardwire && duration <= max_duration);
751 HardwireCpuHelper helper(take_action);
756 const char *stack_profile_opt =
757 (config.getUnsignedValue("stack_profile") != 0 ? "-g" : nullptr);
758 std::string perf_path = config.getStringValue("perf_path");
759 unsigned period = config.getUnsignedValue("sampling_period");
761 PROFILE_RESULT ret = invoke_perf(perf_path.c_str(),
767 if (ret != OK_PROFILE_COLLECTION) {
772 // Read the resulting perf.data file, encode into protocol buffer, then write
773 // the result to the file perf.data.encoded
775 std::string path = android::base::StringPrintf(
776 "%s.encoded.%d", data_file_path.c_str(), seq);
777 return encode_to_proto(data_file_path, path.c_str(), config, cpu_utilization);
781 // Assuming that we want to collect a profile every N seconds,
782 // randomly partition N into two sub-intervals.
784 static void determine_before_after(unsigned &sleep_before_collect,
785 unsigned &sleep_after_collect,
786 unsigned collection_interval)
788 double frac = erand48(random_seed);
789 sleep_before_collect = (unsigned) (((double)collection_interval) * frac);
790 assert(sleep_before_collect <= collection_interval);
791 sleep_after_collect = collection_interval - sleep_before_collect;
795 // Set random number generator seed
797 static void set_seed(ConfigReader &config)
800 unsigned use_fixed_seed = config.getUnsignedValue("use_fixed_seed");
801 if (use_fixed_seed) {
803 // Use fixed user-specified seed
805 seed = use_fixed_seed;
812 W_ALOGI("random seed set to %u", seed);
813 // Distribute the 32-bit seed into the three 16-bit array
814 // elements. The specific values being written do not especially
815 // matter as long as we are setting them to something based on the seed.
816 random_seed[0] = seed & 0xffff;
817 random_seed[1] = (seed >> 16);
818 random_seed[2] = (random_seed[0] ^ random_seed[1]);
824 static void init(ConfigReader &config)
826 if (!config.readFile()) {
827 W_ALOGE("unable to open configuration file %s",
828 config.getConfigFilePath());
831 // Children of init inherit an artificially low OOM score -- this is not
832 // desirable for perfprofd (its OOM score should be on par with
833 // other user processes).
834 std::stringstream oomscore_path;
835 oomscore_path << "/proc/" << getpid() << "/oom_score_adj";
836 if (!android::base::WriteStringToFile("0", oomscore_path.str())) {
837 W_ALOGE("unable to write to %s", oomscore_path.str().c_str());
841 cleanup_destination_dir(config);
843 char propBuf[PROPERTY_VALUE_MAX];
845 property_get("ro.kernel.qemu", propBuf, "");
846 running_in_emulator = (propBuf[0] == '1');
847 property_get("ro.debuggable", propBuf, "");
848 is_debug_build = (propBuf[0] == '1');
850 signal(SIGHUP, sig_hup);
855 // 1. parse cmd line args
856 // 2. read config file
859 // perform a profile collection
862 int perfprofd_main(int argc, char** argv)
866 W_ALOGI("starting Android Wide Profiling daemon");
868 parse_args(argc, argv);
871 // Early exit if we're not supposed to run on this build flavor
872 if (is_debug_build != 1 &&
873 config.getUnsignedValue("only_debug_build") == 1) {
874 W_ALOGI("early exit due to inappropriate build type");
878 unsigned iterations = 0;
880 while(config.getUnsignedValue("main_loop_iterations") == 0 ||
881 iterations < config.getUnsignedValue("main_loop_iterations")) {
883 // Figure out where in the collection interval we're going to actually
885 unsigned sleep_before_collect = 0;
886 unsigned sleep_after_collect = 0;
887 determine_before_after(sleep_before_collect, sleep_after_collect,
888 config.getUnsignedValue("collection_interval"));
889 perfprofd_sleep(sleep_before_collect);
891 // Reread config file -- the uploader may have rewritten it as a result
892 // of a gservices change
895 // Check for profiling enabled...
896 CKPROFILE_RESULT ckresult = check_profiling_enabled(config);
897 if (ckresult != DO_COLLECT_PROFILE) {
898 W_ALOGI("profile collection skipped (%s)",
899 ckprofile_result_to_string(ckresult));
901 // Kick off the profiling run...
902 W_ALOGI("initiating profile collection");
903 PROFILE_RESULT result = collect_profile(config, seq);
904 if (result != OK_PROFILE_COLLECTION) {
905 W_ALOGI("profile collection failed (%s)",
906 profile_result_to_string(result));
908 if (post_process(config, seq)) {
911 W_ALOGI("profile collection complete");
914 perfprofd_sleep(sleep_after_collect);
918 W_ALOGI("finishing Android Wide Profiling daemon");