perfprofd/perfprofdcore.cc

   1 /*
   2 **
   3 ** Copyright 2015, The Android Open Source Project
   4 **
   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
   8 **
   9 **     http://www.apache.org/licenses/LICENSE-2.0
  10 **
  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.
  16 */
  17
  18 #include <assert.h>
  19 #include <dirent.h>
  20 #include <errno.h>
  21 #include <fcntl.h>
  22 #include <signal.h>
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <sys/stat.h>
  27 #include <sys/types.h>
  28 #include <sys/wait.h>
  29 #include <time.h>
  30 #include <unistd.h>
  31 #include <string>
  32 #include <sstream>
  33 #include <map>
  34 #include <set>
  35 #include <cctype>
  36
  37 #include <android-base/file.h>
  38 #include <android-base/macros.h>
  39 #include <android-base/properties.h>
  40 #include <android-base/stringprintf.h>
  41
  42 #include "perfprofdcore.h"
  43 #include "perfprofdutils.h"
  44 #include "perf_data_converter.h"
  45 #include "cpuconfig.h"
  46 #include "configreader.h"
  47
  48 //
  49 // Perf profiling daemon -- collects system-wide profiles using
  50 //
  51 //       simpleperf record -a
  52 //
  53 // and encodes them so that they can be uploaded by a separate service.
  54 //
  55
  56 //......................................................................
  57
  58 //
  59 // Output file from 'perf record'.
  60 //
  61 #define PERF_OUTPUT "perf.data"
  62
  63 //
  64 // This enum holds the results of the "should we profile" configuration check.
  65 //
  66 typedef enum {
  67
  68   // All systems go for profile collection.
  69   DO_COLLECT_PROFILE,
  70
  71   // The selected configuration directory doesn't exist.
  72   DONT_PROFILE_MISSING_CONFIG_DIR,
  73
  74   // Destination directory does not contain the semaphore file that
  75   // the perf profile uploading service creates when it determines
  76   // that the user has opted "in" for usage data collection. No
  77   // semaphore -> no user approval -> no profiling.
  78   DONT_PROFILE_MISSING_SEMAPHORE,
  79
  80   // No perf executable present
  81   DONT_PROFILE_MISSING_PERF_EXECUTABLE,
  82
  83   // We're running in the emulator, perf won't be able to do much
  84   DONT_PROFILE_RUNNING_IN_EMULATOR
  85
  86 } CKPROFILE_RESULT;
  87
  88 //
  89 // Are we running in the emulator? If so, stub out profile collection
  90 // Starts as uninitialized (-1), then set to 1 or 0 at init time.
  91 //
  92 static int running_in_emulator = -1;
  93
  94 //
  95 // Is this a debug build ('userdebug' or 'eng')?
  96 // Starts as uninitialized (-1), then set to 1 or 0 at init time.
  97 //
  98 static int is_debug_build = -1;
  99
 100 //
 101 // Path to the perf file to convert and exit? Empty value is the default, daemon mode.
 102 //
 103 static std::string perf_file_to_convert = "";
 104
 105 //
 106 // Random number generator seed (set at startup time).
 107 //
 108 static unsigned short random_seed[3];
 109
 110 //
 111 // SIGHUP handler. Sending SIGHUP to the daemon can be used to break it
 112 // out of a sleep() call so as to trigger a new collection (debugging)
 113 //
 114 static void sig_hup(int /* signum */)
 115 {
 116   W_ALOGW("SIGHUP received");
 117 }
 118
 119 //
 120 // Parse command line args. Currently supported flags:
 121 // *  "-c PATH" sets the path of the config file to PATH.
 122 // *  "-x PATH" reads PATH as a perf data file and saves it as a file in
 123 //    perf_profile.proto format. ".encoded" suffix is appended to PATH to form
 124 //    the output file path.
 125 //
 126 static void parse_args(int argc, char** argv)
 127 {
 128   int ac;
 129
 130   for (ac = 1; ac < argc; ++ac) {
 131     if (!strcmp(argv[ac], "-c")) {
 132       if (ac >= argc-1) {
 133         W_ALOGE("malformed command line: -c option requires argument)");
 134         continue;
 135       }
 136       ConfigReader::setConfigFilePath(argv[ac+1]);
 137       ++ac;
 138     } else if (!strcmp(argv[ac], "-x")) {
 139       if (ac >= argc-1) {
 140         W_ALOGE("malformed command line: -x option requires argument)");
 141         continue;
 142       }
 143       perf_file_to_convert = argv[ac+1];
 144       ++ac;
 145     } else {
 146       W_ALOGE("malformed command line: unknown option or arg %s)", argv[ac]);
 147       continue;
 148     }
 149   }
 150 }
 151
 152 //
 153 // Convert a CKPROFILE_RESULT to a string
 154 //
 155 const char *ckprofile_result_to_string(CKPROFILE_RESULT result)
 156 {
 157   switch (result) {
 158     case DO_COLLECT_PROFILE:
 159       return "DO_COLLECT_PROFILE";
 160     case DONT_PROFILE_MISSING_CONFIG_DIR:
 161       return "missing config directory";
 162     case DONT_PROFILE_MISSING_SEMAPHORE:
 163       return "missing semaphore file";
 164     case DONT_PROFILE_MISSING_PERF_EXECUTABLE:
 165       return "missing 'perf' executable";
 166     case DONT_PROFILE_RUNNING_IN_EMULATOR:
 167       return "running in emulator";
 168     default: return "unknown";
 169   }
 170   return "notreached";
 171 }
 172
 173 //
 174 // Convert a PROFILE_RESULT to a string
 175 //
 176 const char *profile_result_to_string(PROFILE_RESULT result)
 177 {
 178   switch(result) {
 179     case OK_PROFILE_COLLECTION:
 180       return "profile collection succeeded";
 181     case ERR_FORK_FAILED:
 182       return "fork() system call failed";
 183     case ERR_PERF_RECORD_FAILED:
 184       return "perf record returned bad exit status";
 185     case ERR_PERF_ENCODE_FAILED:
 186       return "failure encoding perf.data to protobuf";
 187     case ERR_OPEN_ENCODED_FILE_FAILED:
 188       return "failed to open encoded perf file";
 189     case ERR_WRITE_ENCODED_FILE_FAILED:
 190       return "write to encoded perf file failed";
 191     default: return "unknown";
 192   }
 193   return "notreached";
 194 }
 195
 196 //
 197 // Check to see whether we should perform a profile collection
 198 //
 199 static CKPROFILE_RESULT check_profiling_enabled(const Config& config)
 200 {
 201   //
 202   // Profile collection in the emulator doesn't make sense
 203   //
 204   assert(running_in_emulator != -1);
 205   if (running_in_emulator) {
 206     return DONT_PROFILE_RUNNING_IN_EMULATOR;
 207   }
 208
 209   if (!config.IsProfilingEnabled()) {
 210     return DONT_PROFILE_MISSING_CONFIG_DIR;
 211   }
 212
 213   // Check for existence of simpleperf/perf executable
 214   std::string pp = config.perf_path;
 215   if (access(pp.c_str(), R_OK|X_OK) == -1) {
 216     W_ALOGW("unable to access/execute %s", pp.c_str());
 217     return DONT_PROFILE_MISSING_PERF_EXECUTABLE;
 218   }
 219
 220   //
 221   // We are good to go
 222   //
 223   return DO_COLLECT_PROFILE;
 224 }
 225
 226 bool get_booting()
 227 {
 228   return android::base::GetBoolProperty("sys.boot_completed", false) != true;
 229 }
 230
 231 //
 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:
 235 //
 236 //       pid_t child_pid = ...;
 237 //       { AlarmHelper h(10, child_pid);
 238 //         ... = read_from_child(child_pid, ...);
 239 //       }
 240 //
 241 // NB: this helper is not re-entrant-- avoid nested use or
 242 // use by multiple threads
 243 //
 244 class AlarmHelper {
 245  public:
 246   AlarmHelper(unsigned num_seconds, pid_t child)
 247   {
 248     struct sigaction sigact;
 249     assert(child);
 250     assert(child_ == 0);
 251     memset(&sigact, 0, sizeof(sigact));
 252     sigact.sa_sigaction = handler;
 253     sigaction(SIGALRM, &sigact, &oldsigact_);
 254     child_ = child;
 255     alarm(num_seconds);
 256   }
 257   ~AlarmHelper()
 258   {
 259     alarm(0);
 260     child_ = 0;
 261     sigaction(SIGALRM, &oldsigact_, NULL);
 262   }
 263   static void handler(int, siginfo_t *, void *);
 264
 265  private:
 266   struct sigaction oldsigact_;
 267   static pid_t child_;
 268 };
 269
 270 pid_t AlarmHelper::child_;
 271
 272 void AlarmHelper::handler(int, siginfo_t *, void *)
 273 {
 274   W_ALOGW("SIGALRM timeout");
 275   kill(child_, SIGKILL);
 276 }
 277
 278 //
 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".
 285 //
 286 bool get_camera_active()
 287 {
 288   int pipefds[2];
 289   if (pipe2(pipefds, O_CLOEXEC) != 0) {
 290     W_ALOGE("pipe2() failed (%s)", strerror(errno));
 291     return false;
 292   }
 293   pid_t pid = fork();
 294   if (pid == -1) {
 295     W_ALOGE("fork() failed (%s)", strerror(errno));
 296     close(pipefds[0]);
 297     close(pipefds[1]);
 298     return false;
 299   } else if (pid == 0) {
 300     // child
 301     close(pipefds[0]);
 302     dup2(pipefds[1], fileno(stderr));
 303     dup2(pipefds[1], fileno(stdout));
 304     const char *argv[10];
 305     unsigned slot = 0;
 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));
 311     return false;
 312   }
 313   // parent
 314   AlarmHelper helper(10, pid);
 315   close(pipefds[1]);
 316
 317   // read output
 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);
 322   close(pipefds[0]);
 323   if (result) {
 324     std::stringstream ss(dump_output);
 325     std::string line;
 326     while (std::getline(ss,line,'\n')) {
 327       if (line.find("Camera module API version:") !=
 328           std::string::npos) {
 329         have_cam = true;
 330       }
 331       if (line.find("No camera module available") !=
 332           std::string::npos ||
 333           line.find("No active camera clients yet") !=
 334           std::string::npos) {
 335         have_clients = false;
 336       }
 337     }
 338   }
 339
 340   // reap child (no zombies please)
 341   int st = 0;
 342   TEMP_FAILURE_RETRY(waitpid(pid, &st, 0));
 343   return have_cam && have_clients;
 344 }
 345
 346 bool get_charging()
 347 {
 348   std::string psdir("/sys/class/power_supply");
 349   DIR* dir = opendir(psdir.c_str());
 350   if (dir == NULL) {
 351     W_ALOGE("Failed to open dir %s (%s)", psdir.c_str(), strerror(errno));
 352     return false;
 353   }
 354   struct dirent* e;
 355   bool result = false;
 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;
 360       int value = 0;
 361       if (android::base::ReadFileToString(online_path.c_str(), &contents) &&
 362           sscanf(contents.c_str(), "%d", &value) == 1) {
 363         if (value) {
 364           result = true;
 365           break;
 366         }
 367       }
 368     }
 369   }
 370   closedir(dir);
 371   return result;
 372 }
 373
 374 bool postprocess_proc_stat_contents(const std::string &pscontents,
 375                                     long unsigned *idleticks,
 376                                     long unsigned *remainingticks)
 377 {
 378   long unsigned usertime, nicetime, systime, idletime, iowaittime;
 379   long unsigned irqtime, softirqtime;
 380
 381   int rc = sscanf(pscontents.c_str(), "cpu  %lu %lu %lu %lu %lu %lu %lu",
 382                   &usertime, &nicetime, &systime, &idletime,
 383                   &iowaittime, &irqtime, &softirqtime);
 384   if (rc != 7) {
 385     return false;
 386   }
 387   *idleticks = idletime;
 388   *remainingticks = usertime + nicetime + systime + iowaittime + irqtime + softirqtime;
 389   return true;
 390 }
 391
 392 unsigned collect_cpu_utilization()
 393 {
 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)) {
 399       return 0;
 400     }
 401     if (!postprocess_proc_stat_contents(contents, &idle[iter], &busy[iter])) {
 402       return 0;
 403     }
 404     if (iter == 0) {
 405       sleep(1);
 406     }
 407   }
 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;
 411 }
 412
 413 static void annotate_encoded_perf_profile(wireless_android_play_playlog::AndroidPerfProfile *profile,
 414                                           const Config& config,
 415                                           unsigned cpu_utilization)
 416 {
 417   //
 418   // Incorporate cpu utilization (collected prior to perf run)
 419   //
 420   if (config.collect_cpu_utilization) {
 421     profile->set_cpu_utilization(cpu_utilization);
 422   }
 423
 424   //
 425   // Load average as reported by the kernel
 426   //
 427   std::string load;
 428   double fload = 0.0;
 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);
 433   } else {
 434     W_ALOGE("Failed to read or scan /proc/loadavg (%s)", strerror(errno));
 435   }
 436
 437   //
 438   // Device still booting? Camera in use? Plugged into charger?
 439   //
 440   bool is_booting = get_booting();
 441   if (config.collect_booting) {
 442     profile->set_booting(is_booting);
 443   }
 444   if (config.collect_camera_active) {
 445     profile->set_camera_active(is_booting ? false : get_camera_active());
 446   }
 447   if (config.collect_charging_state) {
 448     profile->set_on_charger(get_charging());
 449   }
 450
 451   //
 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?
 455   //
 456   std::string disp;
 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);
 460   } else {
 461     W_ALOGE("Failed to read /sys/power/wake_unlock (%s)", strerror(errno));
 462   }
 463 }
 464
 465 inline char* string_as_array(std::string* str) {
 466   return str->empty() ? NULL : &*str->begin();
 467 }
 468
 469 PROFILE_RESULT encode_to_proto(const std::string &data_file_path,
 470                                const char *encoded_file_path,
 471                                const Config& config,
 472                                unsigned cpu_utilization)
 473 {
 474   //
 475   // Open and read perf.data file
 476   //
 477   const wireless_android_play_playlog::AndroidPerfProfile &encodedProfile =
 478       wireless_android_logging_awp::RawPerfDataToAndroidPerfProfile(data_file_path);
 479
 480   //
 481   // Issue error if no samples
 482   //
 483   if (encodedProfile.programs().size() == 0) {
 484     return ERR_PERF_ENCODE_FAILED;
 485   }
 486
 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&>
 491       (encodedProfile);
 492   annotate_encoded_perf_profile(&prof, config, cpu_utilization);
 493
 494   //
 495   // Serialize protobuf to array
 496   //
 497   int size = encodedProfile.ByteSize();
 498   std::string data;
 499   data.resize(size);
 500   ::google::protobuf::uint8* dtarget =
 501         reinterpret_cast<::google::protobuf::uint8*>(string_as_array(&data));
 502   encodedProfile.SerializeWithCachedSizesToArray(dtarget);
 503
 504   //
 505   // Open file and write encoded data to it
 506   //
 507   FILE *fp = fopen(encoded_file_path, "w");
 508   if (!fp) {
 509     return ERR_OPEN_ENCODED_FILE_FAILED;
 510   }
 511   size_t fsiz = size;
 512   if (fwrite(dtarget, fsiz, 1, fp) != 1) {
 513     fclose(fp);
 514     return ERR_WRITE_ENCODED_FILE_FAILED;
 515   }
 516   fclose(fp);
 517   chmod(encoded_file_path, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH);
 518
 519   return OK_PROFILE_COLLECTION;
 520 }
 521
 522 //
 523 // Invoke "perf record". Return value is OK_PROFILE_COLLECTION for
 524 // success, or some other error code if something went wrong.
 525 //
 526 static PROFILE_RESULT invoke_perf(Config& config,
 527                                   const std::string &perf_path,
 528                                   unsigned sampling_period,
 529                                   const char *stack_profile_opt,
 530                                   unsigned duration,
 531                                   const std::string &data_file_path,
 532                                   const std::string &perf_stderr_path)
 533 {
 534   pid_t pid = fork();
 535
 536   if (pid == -1) {
 537     return ERR_FORK_FAILED;
 538   }
 539
 540   if (pid == 0) {
 541     // child
 542
 543     // Open file to receive stderr/stdout from perf
 544     FILE *efp = fopen(perf_stderr_path.c_str(), "w");
 545     if (efp) {
 546       dup2(fileno(efp), STDERR_FILENO);
 547       dup2(fileno(efp), STDOUT_FILENO);
 548     } else {
 549       W_ALOGW("unable to open %s for writing", perf_stderr_path.c_str());
 550     }
 551
 552     // marshall arguments
 553     constexpr unsigned max_args = 14;
 554     const char *argv[max_args];
 555     unsigned slot = 0;
 556     argv[slot++] = perf_path.c_str();
 557     argv[slot++] = "record";
 558
 559     // -o perf.data
 560     argv[slot++] = "-o";
 561     argv[slot++] = data_file_path.c_str();
 562
 563     // -c N
 564     argv[slot++] = "-c";
 565     std::string p_str = android::base::StringPrintf("%u", sampling_period);
 566     argv[slot++] = p_str.c_str();
 567
 568     // -g if desired
 569     if (stack_profile_opt)
 570       argv[slot++] = stack_profile_opt;
 571
 572     std::string pid_str;
 573     if (config.process < 0) {
 574       // system wide profiling
 575       argv[slot++] = "-a";
 576     } else {
 577       argv[slot++] = "-p";
 578       pid_str = std::to_string(config.process);
 579       argv[slot++] = pid_str.c_str();
 580     }
 581
 582     // no need for kernel symbols
 583     argv[slot++] = "--no-dump-kernel-symbols";
 584
 585     // sleep <duration>
 586     argv[slot++] = "/system/bin/sleep";
 587     std::string d_str = android::base::StringPrintf("%u", duration);
 588     argv[slot++] = d_str.c_str();
 589
 590     // terminator
 591     argv[slot++] = nullptr;
 592     assert(slot < max_args);
 593
 594     // record the final command line in the error output file for
 595     // posterity/debugging purposes
 596     fprintf(stderr, "perf invocation (pid=%d):\n", getpid());
 597     for (unsigned i = 0; argv[i] != nullptr; ++i) {
 598       fprintf(stderr, "%s%s", i ? " " : "", argv[i]);
 599     }
 600     fprintf(stderr, "\n");
 601
 602     // exec
 603     execvp(argv[0], (char * const *)argv);
 604     fprintf(stderr, "exec failed: %s\n", strerror(errno));
 605     exit(1);
 606
 607   } else {
 608     // parent
 609
 610     // Try to sleep.
 611     config.Sleep(duration);
 612
 613     // We may have been woken up to stop profiling.
 614     if (config.ShouldStopProfiling()) {
 615       // Send SIGHUP to simpleperf to make it stop.
 616       kill(pid, SIGHUP);
 617     }
 618
 619     // Wait for the child, so it's reaped correctly.
 620     int st = 0;
 621     pid_t reaped = TEMP_FAILURE_RETRY(waitpid(pid, &st, 0));
 622
 623     if (reaped == -1) {
 624       W_ALOGW("waitpid failed: %s", strerror(errno));
 625     } else if (WIFSIGNALED(st)) {
 626       if (WTERMSIG(st) == SIGHUP && config.ShouldStopProfiling()) {
 627         // That was us...
 628         return OK_PROFILE_COLLECTION;
 629       }
 630       W_ALOGW("perf killed by signal %d", WTERMSIG(st));
 631     } else if (WEXITSTATUS(st) != 0) {
 632       W_ALOGW("perf bad exit status %d", WEXITSTATUS(st));
 633     } else {
 634       return OK_PROFILE_COLLECTION;
 635     }
 636   }
 637
 638   return ERR_PERF_RECORD_FAILED;
 639 }
 640
 641 //
 642 // Remove all files in the destination directory during initialization
 643 //
 644 static void cleanup_destination_dir(const std::string& dest_dir)
 645 {
 646   DIR* dir = opendir(dest_dir.c_str());
 647   if (dir != NULL) {
 648     struct dirent* e;
 649     while ((e = readdir(dir)) != 0) {
 650       if (e->d_name[0] != '.') {
 651         std::string file_path = dest_dir + "/" + e->d_name;
 652         remove(file_path.c_str());
 653       }
 654     }
 655     closedir(dir);
 656   } else {
 657     W_ALOGW("unable to open destination dir %s for cleanup",
 658             dest_dir.c_str());
 659   }
 660 }
 661
 662 //
 663 // Post-processes after profile is collected and converted to protobuf.
 664 // * GMS core stores processed file sequence numbers in
 665 //   /data/data/com.google.android.gms/files/perfprofd_processed.txt
 666 // * Update /data/misc/perfprofd/perfprofd_produced.txt to remove the sequence
 667 //   numbers that have been processed and append the current seq number
 668 // Returns true if the current_seq should increment.
 669 //
 670 static bool post_process(const Config& config, int current_seq)
 671 {
 672   const std::string& dest_dir = config.destination_directory;
 673   std::string processed_file_path =
 674       config.config_directory + "/" + PROCESSED_FILENAME;
 675   std::string produced_file_path = dest_dir + "/" + PRODUCED_FILENAME;
 676
 677
 678   std::set<int> processed;
 679   FILE *fp = fopen(processed_file_path.c_str(), "r");
 680   if (fp != NULL) {
 681     int seq;
 682     while(fscanf(fp, "%d\n", &seq) > 0) {
 683       if (remove(android::base::StringPrintf(
 684           "%s/perf.data.encoded.%d", dest_dir.c_str(),seq).c_str()) == 0) {
 685         processed.insert(seq);
 686       }
 687     }
 688     fclose(fp);
 689   }
 690
 691   std::set<int> produced;
 692   fp = fopen(produced_file_path.c_str(), "r");
 693   if (fp != NULL) {
 694     int seq;
 695     while(fscanf(fp, "%d\n", &seq) > 0) {
 696       if (processed.find(seq) == processed.end()) {
 697         produced.insert(seq);
 698       }
 699     }
 700     fclose(fp);
 701   }
 702
 703   uint32_t maxLive = config.max_unprocessed_profiles;
 704   if (produced.size() >= maxLive) {
 705     return false;
 706   }
 707
 708   produced.insert(current_seq);
 709   fp = fopen(produced_file_path.c_str(), "w");
 710   if (fp == NULL) {
 711     W_ALOGW("Cannot write %s", produced_file_path.c_str());
 712     return false;
 713   }
 714   for (std::set<int>::const_iterator iter = produced.begin();
 715        iter != produced.end(); ++iter) {
 716     fprintf(fp, "%d\n", *iter);
 717   }
 718   fclose(fp);
 719   chmod(produced_file_path.c_str(),
 720         S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH);
 721   return true;
 722 }
 723
 724 //
 725 // Collect a perf profile. Steps for this operation are:
 726 // - kick off 'perf record'
 727 // - read perf.data, convert to protocol buf
 728 //
 729 static PROFILE_RESULT collect_profile(Config& config, int seq)
 730 {
 731   //
 732   // Collect cpu utilization if enabled
 733   //
 734   unsigned cpu_utilization = 0;
 735   if (config.collect_cpu_utilization) {
 736     cpu_utilization = collect_cpu_utilization();
 737   }
 738
 739   //
 740   // Form perf.data file name, perf error output file name
 741   //
 742   const std::string& destdir = config.destination_directory;
 743   std::string data_file_path(destdir);
 744   data_file_path += "/";
 745   data_file_path += PERF_OUTPUT;
 746   std::string perf_stderr_path(destdir);
 747   perf_stderr_path += "/perferr.txt";
 748
 749   //
 750   // Remove any existing perf.data file -- if we don't do this, perf
 751   // will rename the old file and we'll have extra cruft lying around.
 752   //
 753   struct stat statb;
 754   if (stat(data_file_path.c_str(), &statb) == 0) { // if file exists...
 755     if (unlink(data_file_path.c_str())) {          // then try to remove
 756       W_ALOGW("unable to unlink previous perf.data file");
 757     }
 758   }
 759
 760   //
 761   // The "mpdecision" daemon can cause problems for profile
 762   // collection: if it decides to online a CPU partway through the
 763   // 'perf record' run, the activity on that CPU will be invisible to
 764   // perf, and if it offlines a CPU during the recording this can
 765   // sometimes leave the PMU in an unusable state (dmesg errors of the
 766   // form "perfevents: unable to request IRQXXX for ...").  To avoid
 767   // these issues, if "mpdecision" is running the helper below will
 768   // stop the service and then online all available CPUs. The object
 769   // destructor (invoked when this routine terminates) will then
 770   // restart the service again when needed.
 771   //
 772   uint32_t duration = config.sample_duration_in_s;
 773   bool hardwire = config.hardwire_cpus;
 774   uint32_t max_duration = config.hardwire_cpus_max_duration_in_s;
 775   bool take_action = (hardwire && duration <= max_duration);
 776   HardwireCpuHelper helper(take_action);
 777
 778   //
 779   // Invoke perf
 780   //
 781   const char *stack_profile_opt =
 782       (config.stack_profile ? "-g" : nullptr);
 783   const std::string& perf_path = config.perf_path;
 784   uint32_t period = config.sampling_period;
 785
 786   PROFILE_RESULT ret = invoke_perf(config,
 787                                    perf_path.c_str(),
 788                                    period,
 789                                    stack_profile_opt,
 790                                    duration,
 791                                    data_file_path,
 792                                    perf_stderr_path);
 793   if (ret != OK_PROFILE_COLLECTION) {
 794     return ret;
 795   }
 796
 797   //
 798   // Read the resulting perf.data file, encode into protocol buffer, then write
 799   // the result to the file perf.data.encoded
 800   //
 801   std::string path = android::base::StringPrintf(
 802       "%s.encoded.%d", data_file_path.c_str(), seq);
 803   return encode_to_proto(data_file_path, path.c_str(), config, cpu_utilization);
 804 }
 805
 806 //
 807 // Assuming that we want to collect a profile every N seconds,
 808 // randomly partition N into two sub-intervals.
 809 //
 810 static void determine_before_after(unsigned &sleep_before_collect,
 811                                    unsigned &sleep_after_collect,
 812                                    unsigned collection_interval)
 813 {
 814   double frac = erand48(random_seed);
 815   sleep_before_collect = (unsigned) (((double)collection_interval) * frac);
 816   assert(sleep_before_collect <= collection_interval);
 817   sleep_after_collect = collection_interval - sleep_before_collect;
 818 }
 819
 820 //
 821 // Set random number generator seed
 822 //
 823 static void set_seed(uint32_t use_fixed_seed)
 824 {
 825   unsigned seed = 0;
 826   if (use_fixed_seed) {
 827     //
 828     // Use fixed user-specified seed
 829     //
 830     seed = use_fixed_seed;
 831   } else {
 832     //
 833     // Randomized seed
 834     //
 835     seed = arc4random();
 836   }
 837   W_ALOGI("random seed set to %u", seed);
 838   // Distribute the 32-bit seed into the three 16-bit array
 839   // elements. The specific values being written do not especially
 840   // matter as long as we are setting them to something based on the seed.
 841   random_seed[0] = seed & 0xffff;
 842   random_seed[1] = (seed >> 16);
 843   random_seed[2] = (random_seed[0] ^ random_seed[1]);
 844 }
 845
 846 static void CommonInit(uint32_t use_fixed_seed, const char* dest_dir) {
 847   // Children of init inherit an artificially low OOM score -- this is not
 848   // desirable for perfprofd (its OOM score should be on par with
 849   // other user processes).
 850   std::stringstream oomscore_path;
 851   oomscore_path << "/proc/" << getpid() << "/oom_score_adj";
 852   if (!android::base::WriteStringToFile("0", oomscore_path.str())) {
 853     W_ALOGE("unable to write to %s", oomscore_path.str().c_str());
 854   }
 855
 856   set_seed(use_fixed_seed);
 857   if (dest_dir != nullptr) {
 858     cleanup_destination_dir(dest_dir);
 859   }
 860
 861   running_in_emulator = android::base::GetBoolProperty("ro.kernel.qemu", false);
 862   is_debug_build = android::base::GetBoolProperty("ro.debuggable", false);
 863 }
 864
 865 //
 866 // Initialization
 867 //
 868 static void init(const Config& config)
 869 {
 870   // TODO: Consider whether we want to clean things or just overwrite.
 871   CommonInit(config.use_fixed_seed, nullptr);
 872 }
 873
 874 static void init(ConfigReader &config)
 875 {
 876   if (!config.readFile()) {
 877     W_ALOGE("unable to open configuration file %s",
 878             config.getConfigFilePath());
 879   }
 880
 881   CommonInit(static_cast<uint32_t>(config.getUnsignedValue("use_fixed_seed")),
 882              config.getStringValue("destination_directory").c_str());
 883
 884   signal(SIGHUP, sig_hup);
 885 }
 886
 887 template <typename ConfigFn, typename UpdateFn>
 888 static void ProfilingLoopImpl(ConfigFn config, UpdateFn update) {
 889   unsigned iterations = 0;
 890   int seq = 0;
 891   while(config()->main_loop_iterations == 0 ||
 892       iterations < config()->main_loop_iterations) {
 893     if (config()->ShouldStopProfiling()) {
 894       return;
 895     }
 896
 897     // Figure out where in the collection interval we're going to actually
 898     // run perf
 899     unsigned sleep_before_collect = 0;
 900     unsigned sleep_after_collect = 0;
 901     determine_before_after(sleep_before_collect, sleep_after_collect,
 902                            config()->collection_interval_in_s);
 903     config()->Sleep(sleep_before_collect);
 904
 905     if (config()->ShouldStopProfiling()) {
 906       return;
 907     }
 908
 909     // Run any necessary updates.
 910     update();
 911
 912     // Check for profiling enabled...
 913     CKPROFILE_RESULT ckresult = check_profiling_enabled(*config());
 914     if (ckresult != DO_COLLECT_PROFILE) {
 915       W_ALOGI("profile collection skipped (%s)",
 916               ckprofile_result_to_string(ckresult));
 917     } else {
 918       // Kick off the profiling run...
 919       W_ALOGI("initiating profile collection");
 920       PROFILE_RESULT result = collect_profile(*config(), seq);
 921       if (result != OK_PROFILE_COLLECTION) {
 922         W_ALOGI("profile collection failed (%s)",
 923                 profile_result_to_string(result));
 924       } else {
 925         if (post_process(*config(), seq)) {
 926           seq++;
 927         }
 928         W_ALOGI("profile collection complete");
 929       }
 930     }
 931
 932     if (config()->ShouldStopProfiling()) {
 933       return;
 934     }
 935
 936     config()->Sleep(sleep_after_collect);
 937     iterations += 1;
 938   }
 939 }
 940
 941 void ProfilingLoop(Config& config) {
 942   init(config);
 943
 944   auto config_fn = [&config]() {
 945     return &config;;
 946   };
 947   auto do_nothing = []() {
 948   };
 949   ProfilingLoopImpl(config_fn, do_nothing);
 950 }
 951
 952 //
 953 // Main routine:
 954 // 1. parse cmd line args
 955 // 2. read config file
 956 // 3. loop: {
 957 //       sleep for a while
 958 //       perform a profile collection
 959 //    }
 960 //
 961 int perfprofd_main(int argc, char** argv, Config* config)
 962 {
 963   ConfigReader config_reader;
 964
 965   W_ALOGI("starting Android Wide Profiling daemon");
 966
 967   parse_args(argc, argv);
 968   init(config_reader);
 969   config_reader.FillConfig(config);
 970
 971   if (!perf_file_to_convert.empty()) {
 972     std::string encoded_path = perf_file_to_convert + ".encoded";
 973     encode_to_proto(perf_file_to_convert, encoded_path.c_str(), *config, 0);
 974     return 0;
 975   }
 976
 977   // Early exit if we're not supposed to run on this build flavor
 978   if (is_debug_build != 1 && config->only_debug_build) {
 979     W_ALOGI("early exit due to inappropriate build type");
 980     return 0;
 981   }
 982
 983   auto config_fn = [config]() {
 984     return config;
 985   };
 986   auto reread_config = [&config_reader, config]() {
 987     // Reread config file -- the uploader may have rewritten it as a result
 988     // of a gservices change
 989     config_reader.readFile();
 990     config_reader.FillConfig(config);
 991   };
 992   ProfilingLoopImpl(config_fn, reread_config);
 993
 994   W_ALOGI("finishing Android Wide Profiling daemon");
 995   return 0;
 996 }