xref: /aosp_15_r20/system/extras/simpleperf/kallsyms_test.cpp (revision 288bf5226967eb3dac5cce6c939ccc2a7f2b4fe5)
1*288bf522SAndroid Build Coastguard Worker /*
2*288bf522SAndroid Build Coastguard Worker  * Copyright (C) 2020 The Android Open Source Project
3*288bf522SAndroid Build Coastguard Worker  *
4*288bf522SAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*288bf522SAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*288bf522SAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*288bf522SAndroid Build Coastguard Worker  *
8*288bf522SAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*288bf522SAndroid Build Coastguard Worker  *
10*288bf522SAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*288bf522SAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*288bf522SAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*288bf522SAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*288bf522SAndroid Build Coastguard Worker  * limitations under the License.
15*288bf522SAndroid Build Coastguard Worker  */
16*288bf522SAndroid Build Coastguard Worker 
17*288bf522SAndroid Build Coastguard Worker #include <gtest/gtest.h>
18*288bf522SAndroid Build Coastguard Worker 
19*288bf522SAndroid Build Coastguard Worker #include <android-base/test_utils.h>
20*288bf522SAndroid Build Coastguard Worker 
21*288bf522SAndroid Build Coastguard Worker #include "get_test_data.h"
22*288bf522SAndroid Build Coastguard Worker #include "kallsyms.h"
23*288bf522SAndroid Build Coastguard Worker #include "test_util.h"
24*288bf522SAndroid Build Coastguard Worker 
25*288bf522SAndroid Build Coastguard Worker using namespace simpleperf;
26*288bf522SAndroid Build Coastguard Worker 
ModulesMatch(const char * p,const char * q)27*288bf522SAndroid Build Coastguard Worker static bool ModulesMatch(const char* p, const char* q) {
28*288bf522SAndroid Build Coastguard Worker   if (p == nullptr && q == nullptr) {
29*288bf522SAndroid Build Coastguard Worker     return true;
30*288bf522SAndroid Build Coastguard Worker   }
31*288bf522SAndroid Build Coastguard Worker   if (p != nullptr && q != nullptr) {
32*288bf522SAndroid Build Coastguard Worker     return strcmp(p, q) == 0;
33*288bf522SAndroid Build Coastguard Worker   }
34*288bf522SAndroid Build Coastguard Worker   return false;
35*288bf522SAndroid Build Coastguard Worker }
36*288bf522SAndroid Build Coastguard Worker 
KernelSymbolsMatch(const KernelSymbol & sym1,const KernelSymbol & sym2)37*288bf522SAndroid Build Coastguard Worker static bool KernelSymbolsMatch(const KernelSymbol& sym1, const KernelSymbol& sym2) {
38*288bf522SAndroid Build Coastguard Worker   return sym1.addr == sym2.addr && sym1.type == sym2.type && strcmp(sym1.name, sym2.name) == 0 &&
39*288bf522SAndroid Build Coastguard Worker          ModulesMatch(sym1.module, sym2.module);
40*288bf522SAndroid Build Coastguard Worker }
41*288bf522SAndroid Build Coastguard Worker 
42*288bf522SAndroid Build Coastguard Worker // @CddTest = 6.1/C-0-2
TEST(kallsyms,ProcessKernelSymbols)43*288bf522SAndroid Build Coastguard Worker TEST(kallsyms, ProcessKernelSymbols) {
44*288bf522SAndroid Build Coastguard Worker   std::string data =
45*288bf522SAndroid Build Coastguard Worker       "ffffffffa005c4e4 d __warned.41698   [libsas]\n"
46*288bf522SAndroid Build Coastguard Worker       "aaaaaaaaaaaaaaaa T _text\n"
47*288bf522SAndroid Build Coastguard Worker       "cccccccccccccccc c ccccc\n";
48*288bf522SAndroid Build Coastguard Worker   KernelSymbol expected_symbol;
49*288bf522SAndroid Build Coastguard Worker   expected_symbol.addr = 0xffffffffa005c4e4ULL;
50*288bf522SAndroid Build Coastguard Worker   expected_symbol.type = 'd';
51*288bf522SAndroid Build Coastguard Worker   expected_symbol.name = "__warned.41698";
52*288bf522SAndroid Build Coastguard Worker   expected_symbol.module = "libsas";
53*288bf522SAndroid Build Coastguard Worker   ASSERT_TRUE(ProcessKernelSymbols(
54*288bf522SAndroid Build Coastguard Worker       data, std::bind(&KernelSymbolsMatch, std::placeholders::_1, expected_symbol)));
55*288bf522SAndroid Build Coastguard Worker 
56*288bf522SAndroid Build Coastguard Worker   expected_symbol.addr = 0xaaaaaaaaaaaaaaaaULL;
57*288bf522SAndroid Build Coastguard Worker   expected_symbol.type = 'T';
58*288bf522SAndroid Build Coastguard Worker   expected_symbol.name = "_text";
59*288bf522SAndroid Build Coastguard Worker   expected_symbol.module = nullptr;
60*288bf522SAndroid Build Coastguard Worker   ASSERT_TRUE(ProcessKernelSymbols(
61*288bf522SAndroid Build Coastguard Worker       data, std::bind(&KernelSymbolsMatch, std::placeholders::_1, expected_symbol)));
62*288bf522SAndroid Build Coastguard Worker 
63*288bf522SAndroid Build Coastguard Worker   expected_symbol.name = "non_existent_symbol";
64*288bf522SAndroid Build Coastguard Worker   ASSERT_FALSE(ProcessKernelSymbols(
65*288bf522SAndroid Build Coastguard Worker       data, std::bind(&KernelSymbolsMatch, std::placeholders::_1, expected_symbol)));
66*288bf522SAndroid Build Coastguard Worker }
67*288bf522SAndroid Build Coastguard Worker 
68*288bf522SAndroid Build Coastguard Worker // @CddTest = 6.1/C-0-2
TEST(kallsyms,ProcessKernelSymbols_ignore_arm_mapping_symbols)69*288bf522SAndroid Build Coastguard Worker TEST(kallsyms, ProcessKernelSymbols_ignore_arm_mapping_symbols) {
70*288bf522SAndroid Build Coastguard Worker   std::string data =
71*288bf522SAndroid Build Coastguard Worker       "aaaaaaaaaaaaaaaa t $x.9 [coresight_etm4x]\n"
72*288bf522SAndroid Build Coastguard Worker       "bbbbbbbbbbbbbbbb t etm4_pm_clear [coresight_etm4x]\n";
73*288bf522SAndroid Build Coastguard Worker   bool has_normal_symbol = false;
74*288bf522SAndroid Build Coastguard Worker   bool has_arm_mapping_symbol = false;
75*288bf522SAndroid Build Coastguard Worker   auto callback = [&](const KernelSymbol& sym) {
76*288bf522SAndroid Build Coastguard Worker     if (strcmp(sym.name, "etm4_pm_clear") == 0) {
77*288bf522SAndroid Build Coastguard Worker       has_normal_symbol = true;
78*288bf522SAndroid Build Coastguard Worker     } else {
79*288bf522SAndroid Build Coastguard Worker       has_arm_mapping_symbol = true;
80*288bf522SAndroid Build Coastguard Worker     }
81*288bf522SAndroid Build Coastguard Worker     return false;
82*288bf522SAndroid Build Coastguard Worker   };
83*288bf522SAndroid Build Coastguard Worker   ProcessKernelSymbols(data, callback);
84*288bf522SAndroid Build Coastguard Worker   ASSERT_TRUE(has_normal_symbol);
85*288bf522SAndroid Build Coastguard Worker   ASSERT_FALSE(has_arm_mapping_symbol);
86*288bf522SAndroid Build Coastguard Worker }
87*288bf522SAndroid Build Coastguard Worker 
88*288bf522SAndroid Build Coastguard Worker #if defined(__ANDROID__)
89*288bf522SAndroid Build Coastguard Worker // @CddTest = 6.1/C-0-2
TEST(kallsyms,GetKernelStartAddress)90*288bf522SAndroid Build Coastguard Worker TEST(kallsyms, GetKernelStartAddress) {
91*288bf522SAndroid Build Coastguard Worker   TEST_REQUIRE_ROOT();
92*288bf522SAndroid Build Coastguard Worker   ASSERT_NE(GetKernelStartAddress(), 0u);
93*288bf522SAndroid Build Coastguard Worker }
94*288bf522SAndroid Build Coastguard Worker 
95*288bf522SAndroid Build Coastguard Worker // @CddTest = 6.1/C-0-2
TEST(kallsyms,LoadKernelSymbols)96*288bf522SAndroid Build Coastguard Worker TEST(kallsyms, LoadKernelSymbols) {
97*288bf522SAndroid Build Coastguard Worker   TEST_REQUIRE_ROOT();
98*288bf522SAndroid Build Coastguard Worker   std::string kallsyms;
99*288bf522SAndroid Build Coastguard Worker   ASSERT_TRUE(LoadKernelSymbols(&kallsyms));
100*288bf522SAndroid Build Coastguard Worker }
101*288bf522SAndroid Build Coastguard Worker 
102*288bf522SAndroid Build Coastguard Worker // @CddTest = 6.1/C-0-2
TEST(kallsyms,print_warning)103*288bf522SAndroid Build Coastguard Worker TEST(kallsyms, print_warning) {
104*288bf522SAndroid Build Coastguard Worker   TEST_REQUIRE_NON_ROOT();
105*288bf522SAndroid Build Coastguard Worker   const std::string warning_msg = "Access to kernel symbol addresses is restricted.";
106*288bf522SAndroid Build Coastguard Worker   CapturedStderr capture;
107*288bf522SAndroid Build Coastguard Worker 
108*288bf522SAndroid Build Coastguard Worker   // Call each function requiring kernel addresses once. Check if the warning is printed.
109*288bf522SAndroid Build Coastguard Worker   ResetKernelAddressWarning();
110*288bf522SAndroid Build Coastguard Worker   ASSERT_EQ(0, GetKernelStartAddress());
111*288bf522SAndroid Build Coastguard Worker   capture.Stop();
112*288bf522SAndroid Build Coastguard Worker   ASSERT_NE(capture.str().find(warning_msg), std::string::npos);
113*288bf522SAndroid Build Coastguard Worker 
114*288bf522SAndroid Build Coastguard Worker   capture.Reset();
115*288bf522SAndroid Build Coastguard Worker   capture.Start();
116*288bf522SAndroid Build Coastguard Worker   ResetKernelAddressWarning();
117*288bf522SAndroid Build Coastguard Worker   std::string kallsyms;
118*288bf522SAndroid Build Coastguard Worker   ASSERT_FALSE(LoadKernelSymbols(&kallsyms));
119*288bf522SAndroid Build Coastguard Worker   capture.Stop();
120*288bf522SAndroid Build Coastguard Worker   ASSERT_NE(capture.str().find(warning_msg), std::string::npos);
121*288bf522SAndroid Build Coastguard Worker 
122*288bf522SAndroid Build Coastguard Worker   capture.Reset();
123*288bf522SAndroid Build Coastguard Worker   capture.Start();
124*288bf522SAndroid Build Coastguard Worker   ResetKernelAddressWarning();
125*288bf522SAndroid Build Coastguard Worker   ASSERT_TRUE(GetLoadedModules().empty());
126*288bf522SAndroid Build Coastguard Worker   capture.Stop();
127*288bf522SAndroid Build Coastguard Worker   ASSERT_NE(capture.str().find(warning_msg), std::string::npos);
128*288bf522SAndroid Build Coastguard Worker 
129*288bf522SAndroid Build Coastguard Worker   // Call functions requiring kernel addresses more than once.
130*288bf522SAndroid Build Coastguard Worker   // Check if the kernel address warning is only printed once.
131*288bf522SAndroid Build Coastguard Worker   capture.Reset();
132*288bf522SAndroid Build Coastguard Worker   capture.Start();
133*288bf522SAndroid Build Coastguard Worker   ResetKernelAddressWarning();
134*288bf522SAndroid Build Coastguard Worker   for (int i = 0; i < 2; i++) {
135*288bf522SAndroid Build Coastguard Worker     ASSERT_EQ(0, GetKernelStartAddress());
136*288bf522SAndroid Build Coastguard Worker     ASSERT_FALSE(LoadKernelSymbols(&kallsyms));
137*288bf522SAndroid Build Coastguard Worker     ASSERT_TRUE(GetLoadedModules().empty());
138*288bf522SAndroid Build Coastguard Worker   }
139*288bf522SAndroid Build Coastguard Worker   capture.Stop();
140*288bf522SAndroid Build Coastguard Worker   std::string output = capture.str();
141*288bf522SAndroid Build Coastguard Worker   auto pos = output.find(warning_msg);
142*288bf522SAndroid Build Coastguard Worker   ASSERT_NE(pos, std::string::npos);
143*288bf522SAndroid Build Coastguard Worker   ASSERT_EQ(output.find(warning_msg, pos + warning_msg.size()), std::string::npos);
144*288bf522SAndroid Build Coastguard Worker }
145*288bf522SAndroid Build Coastguard Worker #endif  // defined(__ANDROID__)
146