1 /*
2 * Copyright (c) 2021 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 #include "perf_events_test.h"
17
18 #include <chrono>
19 #include <cinttypes>
20 #include <cstdlib>
21 #include <thread>
22 #include <unistd.h>
23
24 #include "debug_logger.h"
25 #include "utilities.h"
26
27 using namespace testing::ext;
28 using namespace std;
29 using namespace OHOS::HiviewDFX;
30
31 namespace OHOS {
32 namespace Developtools {
33 namespace HiPerf {
34 class PerfEventsTest : public testing::Test {
35 public:
36 static void SetUpTestCase(void);
37 static void TearDownTestCase(void);
38 void SetUp();
39 void TearDown();
40
41 static void TestCodeThread(void);
42 static void RunTestThreads(std::vector<std::thread> &threads);
43 static void SetAllConfig(PerfEvents &event);
44 static bool RecordCount(std::unique_ptr<PerfEventRecord> record);
45 static void StatCount(
46 const std::map<std::string, std::unique_ptr<PerfEvents::CountEvent>> &countEvents);
47
48 static constexpr int TEST_CODE_MEM_FILE_SIZE = 1024;
49 static constexpr auto TEST_CODE_SLEEP_BEFORE_RUN = 500ms;
50 static constexpr auto TEST_CODE_SLEEP_AFTER_RUN = 1000ms;
51 static constexpr int TEST_CODE_RUN_TIME = 10240;
52 static constexpr int DOUBLE = 2;
53 static constexpr int TRIPLE = 3;
54 static constexpr auto TEST_TIME = 3s;
55 static constexpr auto DEFAULT_TRACKING_TIME = 1000;
56 static constexpr auto DEFAULT_STAT_REPORT_TIME = 500;
57 static constexpr auto DEFAULT_SAMPLE_MMAPAGE = 256;
58
59 static uint64_t g_recordCount;
60 static uint64_t g_statCount;
61 };
62
SetUpTestCase()63 void PerfEventsTest::SetUpTestCase() {}
64
TearDownTestCase()65 void PerfEventsTest::TearDownTestCase() {}
66
SetUp()67 void PerfEventsTest::SetUp() {}
68
TearDown()69 void PerfEventsTest::TearDown() {}
70
71 uint64_t PerfEventsTest::g_recordCount = 0;
72 uint64_t PerfEventsTest::g_statCount = 0;
73
RecordCount(std::unique_ptr<PerfEventRecord> record)74 bool PerfEventsTest::RecordCount(std::unique_ptr<PerfEventRecord> record)
75 {
76 g_recordCount++;
77 if (record->GetType() == PERF_RECORD_SAMPLE) {
78 // the record is allowed from a cache memory, does not free memory after use
79 record.release();
80 }
81 return true;
82 }
83
StatCount(const std::map<std::string,std::unique_ptr<PerfEvents::CountEvent>> & countEvents)84 void PerfEventsTest::StatCount(
85 const std::map<std::string, std::unique_ptr<PerfEvents::CountEvent>> &countEvents)
86 {
87 g_statCount++;
88 }
89
TestCodeThread()90 void PerfEventsTest::TestCodeThread()
91 {
92 std::vector<std::unique_ptr<char[]>> mems;
93 int tid = gettid();
94 printf("%s:%d ++\n", __FUNCTION__, tid);
95 for (int n = 0; n < TRIPLE; n++) {
96 std::this_thread::sleep_for(TEST_CODE_SLEEP_BEFORE_RUN);
97 constexpr size_t memSize {TEST_CODE_MEM_FILE_SIZE};
98 for (int i = 0; i < TEST_CODE_RUN_TIME; i++) {
99 if (i % DOUBLE == 0) {
100 mems.push_back(std::make_unique<char[]>(memSize));
101 } else {
102 mems.push_back(std::make_unique<char[]>(memSize * DOUBLE));
103 }
104 }
105
106 for (int i = 0; i < TEST_CODE_RUN_TIME; i++) {
107 mems.pop_back();
108 }
109
110 std::this_thread::sleep_for(TEST_CODE_SLEEP_AFTER_RUN);
111 }
112 printf("%s:%d --\n", __FUNCTION__, tid);
113 }
114
RunTestThreads(std::vector<std::thread> & threads)115 void PerfEventsTest::RunTestThreads(std::vector<std::thread> &threads)
116 {
117 for (long i = 0; i < sysconf(_SC_NPROCESSORS_CONF); i++) {
118 threads.emplace_back(std::thread(&TestCodeThread));
119 }
120 }
121
122 // it isn't include sample and stat
SetAllConfig(PerfEvents & event)123 void PerfEventsTest::SetAllConfig(PerfEvents &event)
124 {
125 std::vector<pid_t> selectCpus_;
126 event.SetCpu(selectCpus_);
127 std::vector<pid_t> pids;
128 event.SetPid(pids);
129 event.SetSystemTarget(true);
130 event.SetTimeOut(DEFAULT_TRACKING_TIME);
131 event.SetInherit(false);
132 std::vector<std::string> trackedCommand_ {"ls"};
133 event.SetTrackedCommand(trackedCommand_);
134 const unsigned int frequency = 1000;
135 event.SetSampleFrequency(frequency);
136 const uint32_t dwarfSampleStackSize = 64;
137 event.SetDwarfSampleStackSize(dwarfSampleStackSize);
138 const int clockId = 1;
139 event.SetClockId(clockId);
140
141 // addevent must be tail
142 event.AddDefaultEvent(PERF_TYPE_HARDWARE);
143 event.AddDefaultEvent(PERF_TYPE_SOFTWARE);
144 }
145
RunTrack(PerfEvents & event)146 static void RunTrack(PerfEvents &event)
147 {
148 ASSERT_EQ(event.StartTracking(), true);
149 }
150
151 /**
152 * @tc.name: Test
153 * @tc.desc:
154 * @tc.type: FUNC
155 */
156 HWTEST_F(PerfEventsTest, GetSupportEvents, TestSize.Level1)
157 {
158 ScopeDebugLevel tempLogLevel(LEVEL_DEBUG);
159 StdoutRecord stdoutRecord;
160 stdoutRecord.Start();
161
162 PerfEvents event;
163 perf_type_id id = PERF_TYPE_HARDWARE;
164 while (id < PERF_TYPE_MAX) {
165 std::map<__u64, std::string> supportEvent = event.GetSupportEvents(id);
166 for (auto it = supportEvent.begin(); it != supportEvent.end(); ++it) {
167 printf("[%lld]\t%s\n", it->first, it->second.c_str());
168 }
169 id = perf_type_id(id + 1);
170 }
171
172 std::string stringOut = stdoutRecord.Stop();
173 }
174
175 HWTEST_F(PerfEventsTest, GetTypeName, TestSize.Level1)
176 {
177 ScopeDebugLevel tempLogLevel(LEVEL_DEBUG);
178 StdoutRecord stdoutRecord;
179 stdoutRecord.Start();
180
181 PerfEvents event;
182 perf_type_id id = PERF_TYPE_HARDWARE;
183 while (id < PERF_TYPE_MAX) {
184 std::string typeName = event.GetTypeName(id);
185 EXPECT_GT(typeName.size(), 0u) << "the type should have name";
186 printf("type[%d]\tname : %s\n", id, typeName.c_str());
187 id = perf_type_id(id + 1);
188 }
189
190 std::string stringOut = stdoutRecord.Stop();
191 }
192
193 HWTEST_F(PerfEventsTest, RecordNormal, TestSize.Level1)
194 {
195 ScopeDebugLevel tempLogLevel(LEVEL_DEBUG);
196 StdoutRecord stdoutRecord;
197 stdoutRecord.Start();
198
199 PerfEvents event;
200 // prepare
201 g_recordCount = 0;
202 event.SetMmapPages(DEFAULT_SAMPLE_MMAPAGE);
203 event.SetRecordCallBack(RecordCount);
204
205 std::vector<pid_t> selectCpus_;
206 event.SetCpu(selectCpus_);
207 std::vector<pid_t> pids;
208 event.SetPid(pids);
209 const unsigned int frequency = 1000;
210 event.SetSampleFrequency(frequency);
211 event.SetSystemTarget(true);
212 event.SetTimeOut(DEFAULT_TRACKING_TIME);
213 event.SetInherit(false);
214 std::vector<std::string> trackedCommand_ {"ls"};
215 event.SetTrackedCommand(trackedCommand_);
216 event.AddDefaultEvent(PERF_TYPE_SOFTWARE);
217 event.AddDefaultEvent(PERF_TYPE_HARDWARE);
218
219 ASSERT_EQ(event.PrepareTracking(), true);
220 std::thread runThread(RunTrack, std::ref(event));
221 std::vector<std::thread> testThreads;
222 RunTestThreads(testThreads);
223
224 std::this_thread::sleep_for(TEST_TIME);
225 EXPECT_EQ(event.PauseTracking(), true);
226 std::this_thread::sleep_for(TEST_TIME); // wait for clearing mmap buffer
227 uint64_t recordCount = g_recordCount;
228 std::this_thread::sleep_for(TEST_TIME);
229 EXPECT_EQ(recordCount, g_recordCount) << "now should have no record";
230 EXPECT_EQ(event.ResumeTracking(), true);
231 TestCodeThread();
232 std::this_thread::sleep_for(TEST_TIME);
233 EXPECT_EQ(event.StopTracking(), true);
234 runThread.join();
235 for (std::thread &t : testThreads) {
236 t.join();
237 }
238 ASSERT_GT(g_recordCount, recordCount) << "should have more records";
239
240 size_t lostSamples = 0;
241 size_t lostNonSamples = 0;
242 event.GetLostSamples(lostSamples, lostNonSamples);
243
244 std::string stringOut = stdoutRecord.Stop();
245 }
246
247 HWTEST_F(PerfEventsTest, RecordSetAll, TestSize.Level1)
248 {
249 ScopeDebugLevel tempLogLevel(LEVEL_DEBUG);
250 StdoutRecord stdoutRecord;
251 stdoutRecord.Start();
252
253 PerfEvents event;
254 // prepare
255 g_recordCount = 0;
256 event.SetMmapPages(DEFAULT_SAMPLE_MMAPAGE);
257 event.SetRecordCallBack(RecordCount);
258 SetAllConfig(event);
259 ASSERT_EQ(event.PrepareTracking(), true);
260 std::thread runThread(RunTrack, std::ref(event));
261 std::vector<std::thread> testThreads;
262 RunTestThreads(testThreads);
263
264 std::this_thread::sleep_for(TEST_TIME);
265 EXPECT_EQ(event.PauseTracking(), true);
266 std::this_thread::sleep_for(TEST_TIME); // wait for clearing mmap buffer
267 uint64_t recordCount = g_recordCount;
268 std::this_thread::sleep_for(TEST_TIME);
269 EXPECT_EQ(recordCount, g_recordCount) << "now should have no record";
270 EXPECT_EQ(event.ResumeTracking(), true);
271 TestCodeThread();
272 std::this_thread::sleep_for(TEST_TIME);
273 EXPECT_EQ(event.StopTracking(), true);
274 runThread.join();
275 for (std::thread &t : testThreads) {
276 t.join();
277 }
278 ASSERT_GT(g_recordCount, recordCount) << "should have more records";
279
280 std::string stringOut = stdoutRecord.Stop();
281 }
282
283 HWTEST_F(PerfEventsTest, StatNormal, TestSize.Level1)
284 {
285 ScopeDebugLevel tempLogLevel(LEVEL_DEBUG);
286 StdoutRecord stdoutRecord;
287 stdoutRecord.Start();
288
289 PerfEvents event;
290 // prepare
291 g_statCount = 0;
292 std::vector<pid_t> selectCpus_;
293 event.SetCpu(selectCpus_);
294 std::vector<pid_t> pids;
295 event.SetPid(pids);
296 event.SetSystemTarget(true);
297 event.SetTimeOut(DEFAULT_TRACKING_TIME);
298 event.SetTimeReport(DEFAULT_STAT_REPORT_TIME);
299 event.SetVerboseReport(false);
300 event.SetInherit(false);
301 std::vector<std::string> trackedCommand_ {"ls"};
302 event.SetTrackedCommand(trackedCommand_);
303 event.AddDefaultEvent(PERF_TYPE_SOFTWARE);
304 event.AddDefaultEvent(PERF_TYPE_TRACEPOINT);
305 event.SetStatCallBack(StatCount);
306 ASSERT_EQ(event.PrepareTracking(), true);
307 std::thread runThread(RunTrack, std::ref(event));
308 std::vector<std::thread> testThreads;
309 RunTestThreads(testThreads);
310
311 std::this_thread::sleep_for(TEST_TIME);
312 EXPECT_EQ(event.PauseTracking(), true);
313 EXPECT_GT(g_statCount, 0u) << "should have stats";
314 uint64_t statCount = g_statCount;
315 std::this_thread::sleep_for(TEST_TIME);
316 EXPECT_EQ(event.ResumeTracking(), true);
317 std::this_thread::sleep_for(TEST_TIME);
318 EXPECT_EQ(event.StopTracking(), true);
319 runThread.join();
320 for (std::thread &t : testThreads) {
321 t.join();
322 }
323 EXPECT_GT(g_statCount, statCount) << "should have more stats";
324
325 std::string stringOut = stdoutRecord.Stop();
326 }
327 } // namespace HiPerf
328 } // namespace Developtools
329 } // namespace OHOS
330