summaryrefslogtreecommitdiff
path: root/simpleperf/kallsyms_test.cpp
blob: d2bc858332e1fd2f9887dc717f1136c9c618c7b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/*
 * Copyright (C) 2020 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include <gtest/gtest.h>

#include <android-base/test_utils.h>

#include "get_test_data.h"
#include "kallsyms.h"
#include "test_util.h"

using namespace simpleperf;

static bool ModulesMatch(const char* p, const char* q) {
  if (p == nullptr && q == nullptr) {
    return true;
  }
  if (p != nullptr && q != nullptr) {
    return strcmp(p, q) == 0;
  }
  return false;
}

static bool KernelSymbolsMatch(const KernelSymbol& sym1, const KernelSymbol& sym2) {
  return sym1.addr == sym2.addr && sym1.type == sym2.type && strcmp(sym1.name, sym2.name) == 0 &&
         ModulesMatch(sym1.module, sym2.module);
}

// @CddTest = 6.1/C-0-2
TEST(kallsyms, ProcessKernelSymbols) {
  std::string data =
      "ffffffffa005c4e4 d __warned.41698   [libsas]\n"
      "aaaaaaaaaaaaaaaa T _text\n"
      "cccccccccccccccc c ccccc\n";
  KernelSymbol expected_symbol;
  expected_symbol.addr = 0xffffffffa005c4e4ULL;
  expected_symbol.type = 'd';
  expected_symbol.name = "__warned.41698";
  expected_symbol.module = "libsas";
  ASSERT_TRUE(ProcessKernelSymbols(
      data, std::bind(&KernelSymbolsMatch, std::placeholders::_1, expected_symbol)));

  expected_symbol.addr = 0xaaaaaaaaaaaaaaaaULL;
  expected_symbol.type = 'T';
  expected_symbol.name = "_text";
  expected_symbol.module = nullptr;
  ASSERT_TRUE(ProcessKernelSymbols(
      data, std::bind(&KernelSymbolsMatch, std::placeholders::_1, expected_symbol)));

  expected_symbol.name = "non_existent_symbol";
  ASSERT_FALSE(ProcessKernelSymbols(
      data, std::bind(&KernelSymbolsMatch, std::placeholders::_1, expected_symbol)));
}

// @CddTest = 6.1/C-0-2
TEST(kallsyms, ProcessKernelSymbols_ignore_arm_mapping_symbols) {
  std::string data =
      "aaaaaaaaaaaaaaaa t $x.9 [coresight_etm4x]\n"
      "bbbbbbbbbbbbbbbb t etm4_pm_clear [coresight_etm4x]\n";
  bool has_normal_symbol = false;
  bool has_arm_mapping_symbol = false;
  auto callback = [&](const KernelSymbol& sym) {
    if (strcmp(sym.name, "etm4_pm_clear") == 0) {
      has_normal_symbol = true;
    } else {
      has_arm_mapping_symbol = true;
    }
    return false;
  };
  ProcessKernelSymbols(data, callback);
  ASSERT_TRUE(has_normal_symbol);
  ASSERT_FALSE(has_arm_mapping_symbol);
}

#if defined(__ANDROID__)
// @CddTest = 6.1/C-0-2
TEST(kallsyms, GetKernelStartAddress) {
  TEST_REQUIRE_ROOT();
  ASSERT_NE(GetKernelStartAddress(), 0u);
}

// @CddTest = 6.1/C-0-2
TEST(kallsyms, LoadKernelSymbols) {
  TEST_REQUIRE_ROOT();
  std::string kallsyms;
  ASSERT_TRUE(LoadKernelSymbols(&kallsyms));
}

// @CddTest = 6.1/C-0-2
TEST(kallsyms, print_warning) {
  TEST_REQUIRE_NON_ROOT();
  const std::string warning_msg = "Access to kernel symbol addresses is restricted.";
  CapturedStderr capture;

  // Call each function requiring kernel addresses once. Check if the warning is printed.
  ResetKernelAddressWarning();
  ASSERT_EQ(0, GetKernelStartAddress());
  capture.Stop();
  ASSERT_NE(capture.str().find(warning_msg), std::string::npos);

  capture.Reset();
  capture.Start();
  ResetKernelAddressWarning();
  std::string kallsyms;
  ASSERT_FALSE(LoadKernelSymbols(&kallsyms));
  capture.Stop();
  ASSERT_NE(capture.str().find(warning_msg), std::string::npos);

  capture.Reset();
  capture.Start();
  ResetKernelAddressWarning();
  ASSERT_TRUE(GetLoadedModules().empty());
  capture.Stop();
  ASSERT_NE(capture.str().find(warning_msg), std::string::npos);

  // Call functions requiring kernel addresses more than once.
  // Check if the kernel address warning is only printed once.
  capture.Reset();
  capture.Start();
  ResetKernelAddressWarning();
  for (int i = 0; i < 2; i++) {
    ASSERT_EQ(0, GetKernelStartAddress());
    ASSERT_FALSE(LoadKernelSymbols(&kallsyms));
    ASSERT_TRUE(GetLoadedModules().empty());
  }
  capture.Stop();
  std::string output = capture.str();
  auto pos = output.find(warning_msg);
  ASSERT_NE(pos, std::string::npos);
  ASSERT_EQ(output.find(warning_msg, pos + warning_msg.size()), std::string::npos);
}
#endif  // defined(__ANDROID__)