simpleperf/cmd_record_test.cpp

   1 /*
   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 <gtest/gtest.h>
  18
  19 #include <unistd.h>
  20
  21 #include <android-base/file.h>
  22 #include <android-base/stringprintf.h>
  23 #include <android-base/test_utils.h>
  24
  25 #include <map>
  26 #include <memory>
  27 #include <thread>
  28
  29 #include "command.h"
  30 #include "environment.h"
  31 #include "event_selection_set.h"
  32 #include "get_test_data.h"
  33 #include "record.h"
  34 #include "record_file.h"
  35 #include "test_util.h"
  36 #include "thread_tree.h"
  37
  38 using namespace PerfFileFormat;
  39
  40 static std::unique_ptr<Command> RecordCmd() {
  41   return CreateCommandInstance("record");
  42 }
  43
  44 static bool RunRecordCmd(std::vector<std::string> v,
  45                          const char* output_file = nullptr) {
  46   std::unique_ptr<TemporaryFile> tmpfile;
  47   std::string out_file;
  48   if (output_file != nullptr) {
  49     out_file = output_file;
  50   } else {
  51     tmpfile.reset(new TemporaryFile);
  52     out_file = tmpfile->path;
  53   }
  54   v.insert(v.end(), {"-o", out_file, "sleep", SLEEP_SEC});
  55   return RecordCmd()->Run(v);
  56 }
  57
  58 TEST(record_cmd, no_options) { ASSERT_TRUE(RunRecordCmd({})); }
  59
  60 TEST(record_cmd, system_wide_option) {
  61   TEST_IN_ROOT(ASSERT_TRUE(RunRecordCmd({"-a"})));
  62 }
  63
  64 TEST(record_cmd, sample_period_option) {
  65   ASSERT_TRUE(RunRecordCmd({"-c", "100000"}));
  66 }
  67
  68 TEST(record_cmd, event_option) {
  69   ASSERT_TRUE(RunRecordCmd({"-e", "cpu-clock"}));
  70 }
  71
  72 TEST(record_cmd, freq_option) {
  73   ASSERT_TRUE(RunRecordCmd({"-f", "99"}));
  74   ASSERT_TRUE(RunRecordCmd({"-F", "99"}));
  75 }
  76
  77 TEST(record_cmd, output_file_option) {
  78   TemporaryFile tmpfile;
  79   ASSERT_TRUE(RecordCmd()->Run({"-o", tmpfile.path, "sleep", SLEEP_SEC}));
  80 }
  81
  82 TEST(record_cmd, dump_kernel_mmap) {
  83   TemporaryFile tmpfile;
  84   ASSERT_TRUE(RunRecordCmd({}, tmpfile.path));
  85   std::unique_ptr<RecordFileReader> reader =
  86       RecordFileReader::CreateInstance(tmpfile.path);
  87   ASSERT_TRUE(reader != nullptr);
  88   std::vector<std::unique_ptr<Record>> records = reader->DataSection();
  89   ASSERT_GT(records.size(), 0U);
  90   bool have_kernel_mmap = false;
  91   for (auto& record : records) {
  92     if (record->type() == PERF_RECORD_MMAP) {
  93       const MmapRecord* mmap_record =
  94           static_cast<const MmapRecord*>(record.get());
  95       if (strcmp(mmap_record->filename, DEFAULT_KERNEL_MMAP_NAME) == 0 ||
  96           strcmp(mmap_record->filename, DEFAULT_KERNEL_MMAP_NAME_PERF) == 0) {
  97         have_kernel_mmap = true;
  98         break;
  99       }
 100     }
 101   }
 102   ASSERT_TRUE(have_kernel_mmap);
 103 }
 104
 105 TEST(record_cmd, dump_build_id_feature) {
 106   TemporaryFile tmpfile;
 107   ASSERT_TRUE(RunRecordCmd({}, tmpfile.path));
 108   std::unique_ptr<RecordFileReader> reader =
 109       RecordFileReader::CreateInstance(tmpfile.path);
 110   ASSERT_TRUE(reader != nullptr);
 111   const FileHeader& file_header = reader->FileHeader();
 112   ASSERT_TRUE(file_header.features[FEAT_BUILD_ID / 8] &
 113               (1 << (FEAT_BUILD_ID % 8)));
 114   ASSERT_GT(reader->FeatureSectionDescriptors().size(), 0u);
 115 }
 116
 117 TEST(record_cmd, tracepoint_event) {
 118   TEST_IN_ROOT(ASSERT_TRUE(RunRecordCmd({"-a", "-e", "sched:sched_switch"})));
 119 }
 120
 121 TEST(record_cmd, branch_sampling) {
 122   if (IsBranchSamplingSupported()) {
 123     ASSERT_TRUE(RunRecordCmd({"-b"}));
 124     ASSERT_TRUE(RunRecordCmd({"-j", "any,any_call,any_ret,ind_call"}));
 125     ASSERT_TRUE(RunRecordCmd({"-j", "any,k"}));
 126     ASSERT_TRUE(RunRecordCmd({"-j", "any,u"}));
 127     ASSERT_FALSE(RunRecordCmd({"-j", "u"}));
 128   } else {
 129     GTEST_LOG_(INFO) << "This test does nothing as branch stack sampling is "
 130                         "not supported on this device.";
 131   }
 132 }
 133
 134 TEST(record_cmd, event_modifier) {
 135   ASSERT_TRUE(RunRecordCmd({"-e", "cpu-cycles:u"}));
 136 }
 137
 138 TEST(record_cmd, fp_callchain_sampling) {
 139   ASSERT_TRUE(RunRecordCmd({"--call-graph", "fp"}));
 140 }
 141
 142 TEST(record_cmd, fp_callchain_sampling_warning_on_arm) {
 143   if (GetBuildArch() != ARCH_ARM) {
 144     GTEST_LOG_(INFO) << "This test does nothing as it only tests on arm arch.";
 145     return;
 146   }
 147   ASSERT_EXIT(
 148       {
 149         exit(RunRecordCmd({"--call-graph", "fp"}) ? 0 : 1);
 150       },
 151       testing::ExitedWithCode(0), "doesn't work well on arm");
 152 }
 153
 154 TEST(record_cmd, system_wide_fp_callchain_sampling) {
 155   TEST_IN_ROOT(ASSERT_TRUE(RunRecordCmd({"-a", "--call-graph", "fp"})));
 156 }
 157
 158 TEST(record_cmd, dwarf_callchain_sampling) {
 159   ASSERT_TRUE(IsDwarfCallChainSamplingSupported());
 160   std::vector<std::unique_ptr<Workload>> workloads;
 161   CreateProcesses(1, &workloads);
 162   std::string pid = std::to_string(workloads[0]->GetPid());
 163   ASSERT_TRUE(RunRecordCmd({"-p", pid, "--call-graph", "dwarf"}));
 164   ASSERT_TRUE(RunRecordCmd({"-p", pid, "--call-graph", "dwarf,16384"}));
 165   ASSERT_FALSE(RunRecordCmd({"-p", pid, "--call-graph", "dwarf,65536"}));
 166   ASSERT_TRUE(RunRecordCmd({"-p", pid, "-g"}));
 167 }
 168
 169 TEST(record_cmd, system_wide_dwarf_callchain_sampling) {
 170   ASSERT_TRUE(IsDwarfCallChainSamplingSupported());
 171   TEST_IN_ROOT(RunRecordCmd({"-a", "--call-graph", "dwarf"}));
 172 }
 173
 174 TEST(record_cmd, no_unwind_option) {
 175   ASSERT_TRUE(IsDwarfCallChainSamplingSupported());
 176   ASSERT_TRUE(RunRecordCmd({"--call-graph", "dwarf", "--no-unwind"}));
 177   ASSERT_FALSE(RunRecordCmd({"--no-unwind"}));
 178 }
 179
 180 TEST(record_cmd, post_unwind_option) {
 181   ASSERT_TRUE(IsDwarfCallChainSamplingSupported());
 182   std::vector<std::unique_ptr<Workload>> workloads;
 183   CreateProcesses(1, &workloads);
 184   std::string pid = std::to_string(workloads[0]->GetPid());
 185   ASSERT_TRUE(RunRecordCmd({"-p", pid, "--call-graph", "dwarf", "--post-unwind"}));
 186   ASSERT_FALSE(RunRecordCmd({"--post-unwind"}));
 187   ASSERT_FALSE(
 188       RunRecordCmd({"--call-graph", "dwarf", "--no-unwind", "--post-unwind"}));
 189 }
 190
 191 TEST(record_cmd, existing_processes) {
 192   std::vector<std::unique_ptr<Workload>> workloads;
 193   CreateProcesses(2, &workloads);
 194   std::string pid_list = android::base::StringPrintf(
 195       "%d,%d", workloads[0]->GetPid(), workloads[1]->GetPid());
 196   ASSERT_TRUE(RunRecordCmd({"-p", pid_list}));
 197 }
 198
 199 TEST(record_cmd, existing_threads) {
 200   std::vector<std::unique_ptr<Workload>> workloads;
 201   CreateProcesses(2, &workloads);
 202   // Process id can also be used as thread id in linux.
 203   std::string tid_list = android::base::StringPrintf(
 204       "%d,%d", workloads[0]->GetPid(), workloads[1]->GetPid());
 205   ASSERT_TRUE(RunRecordCmd({"-t", tid_list}));
 206 }
 207
 208 TEST(record_cmd, no_monitored_threads) { ASSERT_FALSE(RecordCmd()->Run({""})); }
 209
 210 TEST(record_cmd, more_than_one_event_types) {
 211   ASSERT_TRUE(RunRecordCmd({"-e", "cpu-cycles,cpu-clock"}));
 212   ASSERT_TRUE(RunRecordCmd({"-e", "cpu-cycles", "-e", "cpu-clock"}));
 213 }
 214
 215 TEST(record_cmd, mmap_page_option) {
 216   ASSERT_TRUE(RunRecordCmd({"-m", "1"}));
 217   ASSERT_FALSE(RunRecordCmd({"-m", "0"}));
 218   ASSERT_FALSE(RunRecordCmd({"-m", "7"}));
 219 }
 220
 221 static void CheckKernelSymbol(const std::string& path, bool need_kallsyms,
 222                               bool* success) {
 223   *success = false;
 224   std::unique_ptr<RecordFileReader> reader =
 225       RecordFileReader::CreateInstance(path);
 226   ASSERT_TRUE(reader != nullptr);
 227   std::vector<std::unique_ptr<Record>> records = reader->DataSection();
 228   bool has_kernel_symbol_records = false;
 229   for (const auto& record : records) {
 230     if (record->type() == SIMPLE_PERF_RECORD_KERNEL_SYMBOL) {
 231       has_kernel_symbol_records = true;
 232     }
 233   }
 234   bool require_kallsyms = need_kallsyms && CheckKernelSymbolAddresses();
 235   ASSERT_EQ(require_kallsyms, has_kernel_symbol_records);
 236   *success = true;
 237 }
 238
 239 TEST(record_cmd, kernel_symbol) {
 240   TemporaryFile tmpfile;
 241   ASSERT_TRUE(RunRecordCmd({"--no-dump-symbols"}, tmpfile.path));
 242   bool success;
 243   CheckKernelSymbol(tmpfile.path, true, &success);
 244   ASSERT_TRUE(success);
 245   ASSERT_TRUE(RunRecordCmd({"--no-dump-symbols", "--no-dump-kernel-symbols"}, tmpfile.path));
 246   CheckKernelSymbol(tmpfile.path, false, &success);
 247   ASSERT_TRUE(success);
 248 }
 249
 250 // Check if the dso/symbol records in perf.data matches our expectation.
 251 static void CheckDsoSymbolRecords(const std::string& path,
 252                                   bool can_have_dso_symbol_records,
 253                                   bool* success) {
 254   *success = false;
 255   std::unique_ptr<RecordFileReader> reader =
 256       RecordFileReader::CreateInstance(path);
 257   ASSERT_TRUE(reader != nullptr);
 258   std::vector<std::unique_ptr<Record>> records = reader->DataSection();
 259   bool has_dso_record = false;
 260   bool has_symbol_record = false;
 261   std::map<uint64_t, bool> dso_hit_map;
 262   for (const auto& record : records) {
 263     if (record->type() == SIMPLE_PERF_RECORD_DSO) {
 264       has_dso_record = true;
 265       uint64_t dso_id = static_cast<const DsoRecord*>(record.get())->dso_id;
 266       ASSERT_EQ(dso_hit_map.end(), dso_hit_map.find(dso_id));
 267       dso_hit_map.insert(std::make_pair(dso_id, false));
 268     } else if (record->type() == SIMPLE_PERF_RECORD_SYMBOL) {
 269       has_symbol_record = true;
 270       uint64_t dso_id = static_cast<const SymbolRecord*>(record.get())->dso_id;
 271       auto it = dso_hit_map.find(dso_id);
 272       ASSERT_NE(dso_hit_map.end(), it);
 273       it->second = true;
 274     }
 275   }
 276   if (can_have_dso_symbol_records) {
 277     // It is possible that there are no samples hitting functions having symbol.
 278     // In that case, there are no dso/symbol records.
 279     ASSERT_EQ(has_dso_record, has_symbol_record);
 280     for (auto& pair : dso_hit_map) {
 281       ASSERT_TRUE(pair.second);
 282     }
 283   } else {
 284     ASSERT_FALSE(has_dso_record);
 285     ASSERT_FALSE(has_symbol_record);
 286   }
 287   *success = true;
 288 }
 289
 290 TEST(record_cmd, no_dump_symbols) {
 291   TemporaryFile tmpfile;
 292   ASSERT_TRUE(RunRecordCmd({}, tmpfile.path));
 293   bool success;
 294   CheckDsoSymbolRecords(tmpfile.path, true, &success);
 295   ASSERT_TRUE(success);
 296   ASSERT_TRUE(RunRecordCmd({"--no-dump-symbols"}, tmpfile.path));
 297   CheckDsoSymbolRecords(tmpfile.path, false, &success);
 298   ASSERT_TRUE(success);
 299   ASSERT_TRUE(IsDwarfCallChainSamplingSupported());
 300   std::vector<std::unique_ptr<Workload>> workloads;
 301   CreateProcesses(1, &workloads);
 302   std::string pid = std::to_string(workloads[0]->GetPid());
 303   ASSERT_TRUE(RunRecordCmd({"-p", pid, "-g"}, tmpfile.path));
 304   CheckDsoSymbolRecords(tmpfile.path, true, &success);
 305   ASSERT_TRUE(success);
 306   ASSERT_TRUE(RunRecordCmd({"-p", pid, "-g", "--no-dump-symbols"}, tmpfile.path));
 307   CheckDsoSymbolRecords(tmpfile.path, false, &success);
 308   ASSERT_TRUE(success);
 309 }
 310
 311 TEST(record_cmd, dump_kernel_symbols) {
 312   if (!IsRoot()) {
 313     GTEST_LOG_(INFO) << "Test requires root privilege";
 314     return;
 315   }
 316   TemporaryFile tmpfile;
 317   ASSERT_TRUE(RunRecordCmd({"-a", "-o", tmpfile.path, "sleep", "1"}));
 318   std::unique_ptr<RecordFileReader> reader = RecordFileReader::CreateInstance(tmpfile.path);
 319   ASSERT_TRUE(reader != nullptr);
 320   std::map<int, SectionDesc> section_map = reader->FeatureSectionDescriptors();
 321   ASSERT_NE(section_map.find(FEAT_FILE), section_map.end());
 322   std::string file_path;
 323   uint32_t file_type;
 324   uint64_t min_vaddr;
 325   std::vector<Symbol> symbols;
 326   size_t read_pos = 0;
 327   bool has_kernel_symbols = false;
 328   while (reader->ReadFileFeature(read_pos, &file_path, &file_type, &min_vaddr, &symbols)) {
 329     if (file_type == DSO_KERNEL && !symbols.empty()) {
 330       has_kernel_symbols = true;
 331     }
 332   }
 333   ASSERT_TRUE(has_kernel_symbols);
 334 }
 335
 336 TEST(record_cmd, group_option) {
 337   ASSERT_TRUE(RunRecordCmd({"--group", "cpu-cycles,cpu-clock", "-m", "16"}));
 338   ASSERT_TRUE(RunRecordCmd({"--group", "cpu-cycles,cpu-clock", "--group",
 339                             "cpu-cycles:u,cpu-clock:u", "--group",
 340                             "cpu-cycles:k,cpu-clock:k", "-m", "16"}));
 341 }
 342
 343 TEST(record_cmd, symfs_option) { ASSERT_TRUE(RunRecordCmd({"--symfs", "/"})); }
 344
 345 TEST(record_cmd, duration_option) {
 346   TemporaryFile tmpfile;
 347   ASSERT_TRUE(RecordCmd()->Run({"--duration", "1.2", "-p",
 348                                 std::to_string(getpid()), "-o", tmpfile.path, "--in-app"}));
 349   ASSERT_TRUE(
 350       RecordCmd()->Run({"--duration", "1", "-o", tmpfile.path, "sleep", "2"}));
 351 }
 352
 353 TEST(record_cmd, support_modifier_for_clock_events) {
 354   for (const std::string& e : {"cpu-clock", "task-clock"}) {
 355     for (const std::string& m : {"u", "k"}) {
 356       ASSERT_TRUE(RunRecordCmd({"-e", e + ":" + m})) << "event " << e << ":"
 357                                                      << m;
 358     }
 359   }
 360 }
 361
 362 TEST(record_cmd, handle_SIGHUP) {
 363   TemporaryFile tmpfile;
 364   std::thread thread([]() {
 365     sleep(1);
 366     kill(getpid(), SIGHUP);
 367   });
 368   thread.detach();
 369   ASSERT_TRUE(RecordCmd()->Run({"-o", tmpfile.path, "sleep", "1000000"}));
 370 }
 371
 372 TEST(record_cmd, stop_when_no_more_targets) {
 373   TemporaryFile tmpfile;
 374   std::atomic<int> tid(0);
 375   std::thread thread([&]() {
 376     tid = gettid();
 377     sleep(1);
 378   });
 379   thread.detach();
 380   while (tid == 0);
 381   ASSERT_TRUE(RecordCmd()->Run({"-o", tmpfile.path, "-t", std::to_string(tid), "--in-app"}));
 382 }
 383
 384 TEST(record_cmd, donot_stop_when_having_targets) {
 385   std::vector<std::unique_ptr<Workload>> workloads;
 386   CreateProcesses(1, &workloads);
 387   std::string pid = std::to_string(workloads[0]->GetPid());
 388   uint64_t start_time_in_ns = GetSystemClock();
 389   TemporaryFile tmpfile;
 390   ASSERT_TRUE(RecordCmd()->Run({"-o", tmpfile.path, "-p", pid, "--duration", "3"}));
 391   uint64_t end_time_in_ns = GetSystemClock();
 392   ASSERT_GT(end_time_in_ns - start_time_in_ns, static_cast<uint64_t>(2e9));
 393 }
 394
 395 TEST(record_cmd, start_profiling_fd_option) {
 396   int pipefd[2];
 397   ASSERT_EQ(0, pipe(pipefd));
 398   int read_fd = pipefd[0];
 399   int write_fd = pipefd[1];
 400   ASSERT_EXIT(
 401       {
 402         close(read_fd);
 403         exit(RunRecordCmd({"--start_profiling_fd", std::to_string(write_fd)}) ? 0 : 1);
 404       },
 405       testing::ExitedWithCode(0), "");
 406   close(write_fd);
 407   std::string s;
 408   ASSERT_TRUE(android::base::ReadFdToString(read_fd, &s));
 409   close(read_fd);
 410   ASSERT_EQ("STARTED", s);
 411 }
 412
 413 TEST(record_cmd, record_meta_info_feature) {
 414   TemporaryFile tmpfile;
 415   ASSERT_TRUE(RunRecordCmd({}, tmpfile.path));
 416   std::unique_ptr<RecordFileReader> reader = RecordFileReader::CreateInstance(tmpfile.path);
 417   ASSERT_TRUE(reader != nullptr);
 418   std::unordered_map<std::string, std::string> info_map;
 419   ASSERT_TRUE(reader->ReadMetaInfoFeature(&info_map));
 420   ASSERT_NE(info_map.find("simpleperf_version"), info_map.end());
 421 }
 422
 423 // See http://b/63135835.
 424 TEST(record_cmd, cpu_clock_for_a_long_time) {
 425   std::vector<std::unique_ptr<Workload>> workloads;
 426   CreateProcesses(1, &workloads);
 427   std::string pid = std::to_string(workloads[0]->GetPid());
 428   TemporaryFile tmpfile;
 429   ASSERT_TRUE(RecordCmd()->Run(
 430       {"-e", "cpu-clock", "-o", tmpfile.path, "-p", pid, "--duration", "3"}));
 431 }
 432
 433 TEST(record_cmd, dump_regs_for_tracepoint_events) {
 434   // Check if the kernel can dump registers for tracepoint events.
 435   // If not, probably a kernel patch below is missing:
 436   // "5b09a094f2 arm64: perf: Fix callchain parse error with kernel tracepoint events"
 437   std::vector<std::unique_ptr<Workload>> workloads;
 438   CreateProcesses(1, &workloads);
 439   std::string pid = std::to_string(workloads[0]->GetPid());
 440   TemporaryFile tmpfile;
 441   ASSERT_TRUE(RecordCmd()->Run({"-o", tmpfile.path, "-p", pid, "-e", "sched:sched_switch",
 442                                 "-g", "--no-unwind", "--duration", "1"}));
 443
 444   // If the kernel patch is missing, all regs dumped in sample records are zero.
 445   std::unique_ptr<RecordFileReader> reader = RecordFileReader::CreateInstance(tmpfile.path);
 446   CHECK(reader != nullptr);
 447   std::unique_ptr<Record> r;
 448   bool regs_all_zero = true;
 449   while (reader->ReadRecord(r) && r && regs_all_zero) {
 450     if (r->type() != PERF_RECORD_SAMPLE) {
 451       continue;
 452     }
 453     SampleRecord* s = static_cast<SampleRecord*>(r.get());
 454     for (size_t i = 0; i < s->regs_user_data.reg_nr; ++i) {
 455       if (s->regs_user_data.regs[i] != 0u) {
 456         regs_all_zero = false;
 457         break;
 458       }
 459     }
 460   }
 461   ASSERT_FALSE(regs_all_zero);
 462 }