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 return true;
78 }
79
StatCount(const std::map<std::string,std::unique_ptr<PerfEvents::CountEvent>> & countEvents)80 void PerfEventsTest::StatCount(
81 const std::map<std::string, std::unique_ptr<PerfEvents::CountEvent>> &countEvents)
82 {
83 g_statCount++;
84 }
85
TestCodeThread()86 void PerfEventsTest::TestCodeThread()
87 {
88 std::vector<std::unique_ptr<char[]>> mems;
89 int tid = gettid();
90 printf("%s:%d ++\n", __FUNCTION__, tid);
91 for (int n = 0; n < TRIPLE; n++) {
92 std::this_thread::sleep_for(TEST_CODE_SLEEP_BEFORE_RUN);
93 constexpr size_t memSize {TEST_CODE_MEM_FILE_SIZE};
94 for (int i = 0; i < TEST_CODE_RUN_TIME; i++) {
95 if (i % DOUBLE == 0) {
96 mems.push_back(std::make_unique<char[]>(memSize));
97 } else {
98 mems.push_back(std::make_unique<char[]>(memSize * DOUBLE));
99 }
100 }
101
102 for (int i = 0; i < TEST_CODE_RUN_TIME; i++) {
103 mems.pop_back();
104 }
105
106 std::this_thread::sleep_for(TEST_CODE_SLEEP_AFTER_RUN);
107 }
108 printf("%s:%d --\n", __FUNCTION__, tid);
109 }
110
RunTestThreads(std::vector<std::thread> & threads)111 void PerfEventsTest::RunTestThreads(std::vector<std::thread> &threads)
112 {
113 for (long i = 0; i < sysconf(_SC_NPROCESSORS_CONF); i++) {
114 threads.emplace_back(std::thread(&TestCodeThread));
115 }
116 }
117
118 // it isn't include sample and stat
SetAllConfig(PerfEvents & event)119 void PerfEventsTest::SetAllConfig(PerfEvents &event)
120 {
121 std::vector<pid_t> selectCpus_;
122 event.SetCpu(selectCpus_);
123 std::vector<pid_t> pids;
124 event.SetPid(pids);
125 event.SetSystemTarget(true);
126 event.SetTimeOut(DEFAULT_TRACKING_TIME);
127 event.SetInherit(false);
128 std::vector<std::string> trackedCommand_ {};
129 event.SetTrackedCommand(trackedCommand_);
130 const unsigned int frequency = 1000;
131 event.SetSampleFrequency(frequency);
132 const uint32_t dwarfSampleStackSize = 64;
133 event.SetDwarfSampleStackSize(dwarfSampleStackSize);
134 const int clockId = 1;
135 event.SetClockId(clockId);
136
137 // addevent must be tail
138 event.AddDefaultEvent(PERF_TYPE_HARDWARE);
139 event.AddDefaultEvent(PERF_TYPE_SOFTWARE);
140 }
141
RunTrack(PerfEvents & event)142 static void RunTrack(PerfEvents &event)
143 {
144 ASSERT_EQ(event.StartTracking(), true);
145 }
146
147 /**
148 * @tc.name: Test
149 * @tc.desc:
150 * @tc.type: FUNC
151 */
152 HWTEST_F(PerfEventsTest, GetSupportEvents, TestSize.Level1)
153 {
154 ScopeDebugLevel tempLogLevel(LEVEL_DEBUG);
155 StdoutRecord stdoutRecord;
156 stdoutRecord.Start();
157
158 PerfEvents event;
159 perf_type_id id = PERF_TYPE_HARDWARE;
160 while (id < PERF_TYPE_MAX) {
161 std::map<__u64, std::string> supportEvent = event.GetSupportEvents(id);
162 for (auto it = supportEvent.begin(); it != supportEvent.end(); ++it) {
163 printf("[%lld]\t%s\n", it->first, it->second.c_str());
164 }
165 id = perf_type_id(id + 1);
166 }
167
168 std::string stringOut = stdoutRecord.Stop();
169 }
170
171 HWTEST_F(PerfEventsTest, GetTypeName, TestSize.Level1)
172 {
173 ScopeDebugLevel tempLogLevel(LEVEL_DEBUG);
174 StdoutRecord stdoutRecord;
175 stdoutRecord.Start();
176
177 PerfEvents event;
178 perf_type_id id = PERF_TYPE_HARDWARE;
179 while (id < PERF_TYPE_MAX) {
180 std::string typeName = event.GetTypeName(id);
181 EXPECT_GT(typeName.size(), 0u) << "the type should have name";
182 printf("type[%d]\tname : %s\n", id, typeName.c_str());
183 id = perf_type_id(id + 1);
184 }
185
186 std::string stringOut = stdoutRecord.Stop();
187 }
188
189 HWTEST_F(PerfEventsTest, RecordNormal, TestSize.Level1)
190 {
191 ScopeDebugLevel tempLogLevel(LEVEL_DEBUG);
192 StdoutRecord stdoutRecord;
193 stdoutRecord.Start();
194
195 PerfEvents event;
196 // prepare
197 g_recordCount = 0;
198 event.SetMmapPages(DEFAULT_SAMPLE_MMAPAGE);
199 event.SetRecordCallBack(RecordCount);
200
201 std::vector<pid_t> selectCpus_;
202 event.SetCpu(selectCpus_);
203 std::vector<pid_t> pids;
204 event.SetPid(pids);
205 const unsigned int frequency = 1000;
206 event.SetSampleFrequency(frequency);
207 event.SetSystemTarget(true);
208 event.SetTimeOut(DEFAULT_TRACKING_TIME);
209 event.SetInherit(false);
210 std::vector<std::string> trackedCommand_ {};
211 event.SetTrackedCommand(trackedCommand_);
212 event.AddDefaultEvent(PERF_TYPE_SOFTWARE);
213 event.AddDefaultEvent(PERF_TYPE_HARDWARE);
214
215 ASSERT_EQ(event.PrepareTracking(), true);
216 std::thread runThread(RunTrack, std::ref(event));
217 std::vector<std::thread> testThreads;
218 RunTestThreads(testThreads);
219
220 std::this_thread::sleep_for(TEST_TIME);
221 EXPECT_EQ(event.PauseTracking(), true);
222 std::this_thread::sleep_for(TEST_TIME); // wait for clearing mmap buffer
223 uint64_t recordCount = g_recordCount;
224 std::this_thread::sleep_for(TEST_TIME);
225 EXPECT_EQ(recordCount, g_recordCount) << "now should have no record";
226 EXPECT_EQ(event.ResumeTracking(), true);
227 TestCodeThread();
228 std::this_thread::sleep_for(TEST_TIME);
229 EXPECT_EQ(event.StopTracking(), true);
230 runThread.join();
231 for (std::thread &t : testThreads) {
232 t.join();
233 }
234 ASSERT_GT(g_recordCount, recordCount) << "should have more records";
235
236 size_t lostSamples = 0;
237 size_t lostNonSamples = 0;
238 event.GetLostSamples(lostSamples, lostNonSamples);
239
240 std::string stringOut = stdoutRecord.Stop();
241 }
242
243 HWTEST_F(PerfEventsTest, RecordSetAll, TestSize.Level1)
244 {
245 ScopeDebugLevel tempLogLevel(LEVEL_DEBUG);
246 StdoutRecord stdoutRecord;
247 stdoutRecord.Start();
248
249 PerfEvents event;
250 // prepare
251 g_recordCount = 0;
252 event.SetMmapPages(DEFAULT_SAMPLE_MMAPAGE);
253 event.SetRecordCallBack(RecordCount);
254 SetAllConfig(event);
255 ASSERT_EQ(event.PrepareTracking(), true);
256 std::thread runThread(RunTrack, std::ref(event));
257 std::vector<std::thread> testThreads;
258 RunTestThreads(testThreads);
259
260 std::this_thread::sleep_for(TEST_TIME);
261 EXPECT_EQ(event.PauseTracking(), true);
262 std::this_thread::sleep_for(TEST_TIME); // wait for clearing mmap buffer
263 uint64_t recordCount = g_recordCount;
264 std::this_thread::sleep_for(TEST_TIME);
265 EXPECT_EQ(recordCount, g_recordCount) << "now should have no record";
266 EXPECT_EQ(event.ResumeTracking(), true);
267 TestCodeThread();
268 std::this_thread::sleep_for(TEST_TIME);
269 EXPECT_EQ(event.StopTracking(), true);
270 runThread.join();
271 for (std::thread &t : testThreads) {
272 t.join();
273 }
274 ASSERT_GT(g_recordCount, recordCount) << "should have more records";
275
276 std::string stringOut = stdoutRecord.Stop();
277 }
278
279 HWTEST_F(PerfEventsTest, StatNormal, TestSize.Level1)
280 {
281 ScopeDebugLevel tempLogLevel(LEVEL_DEBUG);
282 StdoutRecord stdoutRecord;
283 stdoutRecord.Start();
284
285 PerfEvents event;
286 // prepare
287 g_statCount = 0;
288 std::vector<pid_t> selectCpus_;
289 event.SetCpu(selectCpus_);
290 std::vector<pid_t> pids;
291 event.SetPid(pids);
292 event.SetSystemTarget(true);
293 event.SetTimeOut(DEFAULT_TRACKING_TIME);
294 event.SetTimeReport(DEFAULT_STAT_REPORT_TIME);
295 event.SetVerboseReport(false);
296 event.SetInherit(false);
297 std::vector<std::string> trackedCommand_;
298 event.SetTrackedCommand(trackedCommand_);
299 event.AddDefaultEvent(PERF_TYPE_SOFTWARE);
300 event.AddDefaultEvent(PERF_TYPE_TRACEPOINT);
301 event.SetStatCallBack(StatCount);
302 ASSERT_EQ(event.PrepareTracking(), true);
303 std::thread runThread(RunTrack, std::ref(event));
304 std::vector<std::thread> testThreads;
305 RunTestThreads(testThreads);
306
307 std::this_thread::sleep_for(TEST_TIME);
308 EXPECT_EQ(event.PauseTracking(), true);
309 EXPECT_GT(g_statCount, 0u) << "should have stats";
310 uint64_t statCount = g_statCount;
311 std::this_thread::sleep_for(TEST_TIME);
312 EXPECT_EQ(event.ResumeTracking(), true);
313 std::this_thread::sleep_for(TEST_TIME);
314 EXPECT_EQ(event.StopTracking(), true);
315 runThread.join();
316 for (std::thread &t : testThreads) {
317 t.join();
318 }
319 EXPECT_GT(g_statCount, statCount) << "should have more stats";
320
321 std::string stringOut = stdoutRecord.Stop();
322 }
323 } // namespace HiPerf
324 } // namespace Developtools
325 } // namespace OHOS
326