Loading...
1// SPDX-License-Identifier: GPL-2.0
2#include <stdbool.h>
3#include <inttypes.h>
4#include <stdlib.h>
5#include <string.h>
6#include <linux/bitops.h>
7#include <linux/kernel.h>
8#include <linux/types.h>
9
10#include "map_symbol.h"
11#include "branch.h"
12#include "event.h"
13#include "evsel.h"
14#include "debug.h"
15#include "util/synthetic-events.h"
16
17#include "tests.h"
18
19#define COMP(m) do { \
20 if (s1->m != s2->m) { \
21 pr_debug("Samples differ at '"#m"'\n"); \
22 return false; \
23 } \
24} while (0)
25
26#define MCOMP(m) do { \
27 if (memcmp(&s1->m, &s2->m, sizeof(s1->m))) { \
28 pr_debug("Samples differ at '"#m"'\n"); \
29 return false; \
30 } \
31} while (0)
32
33static bool samples_same(const struct perf_sample *s1,
34 const struct perf_sample *s2,
35 u64 type, u64 read_format)
36{
37 size_t i;
38
39 if (type & PERF_SAMPLE_IDENTIFIER)
40 COMP(id);
41
42 if (type & PERF_SAMPLE_IP)
43 COMP(ip);
44
45 if (type & PERF_SAMPLE_TID) {
46 COMP(pid);
47 COMP(tid);
48 }
49
50 if (type & PERF_SAMPLE_TIME)
51 COMP(time);
52
53 if (type & PERF_SAMPLE_ADDR)
54 COMP(addr);
55
56 if (type & PERF_SAMPLE_ID)
57 COMP(id);
58
59 if (type & PERF_SAMPLE_STREAM_ID)
60 COMP(stream_id);
61
62 if (type & PERF_SAMPLE_CPU)
63 COMP(cpu);
64
65 if (type & PERF_SAMPLE_PERIOD)
66 COMP(period);
67
68 if (type & PERF_SAMPLE_READ) {
69 if (read_format & PERF_FORMAT_GROUP)
70 COMP(read.group.nr);
71 else
72 COMP(read.one.value);
73 if (read_format & PERF_FORMAT_TOTAL_TIME_ENABLED)
74 COMP(read.time_enabled);
75 if (read_format & PERF_FORMAT_TOTAL_TIME_RUNNING)
76 COMP(read.time_running);
77 /* PERF_FORMAT_ID is forced for PERF_SAMPLE_READ */
78 if (read_format & PERF_FORMAT_GROUP) {
79 for (i = 0; i < s1->read.group.nr; i++)
80 MCOMP(read.group.values[i]);
81 } else {
82 COMP(read.one.id);
83 }
84 }
85
86 if (type & PERF_SAMPLE_CALLCHAIN) {
87 COMP(callchain->nr);
88 for (i = 0; i < s1->callchain->nr; i++)
89 COMP(callchain->ips[i]);
90 }
91
92 if (type & PERF_SAMPLE_RAW) {
93 COMP(raw_size);
94 if (memcmp(s1->raw_data, s2->raw_data, s1->raw_size)) {
95 pr_debug("Samples differ at 'raw_data'\n");
96 return false;
97 }
98 }
99
100 if (type & PERF_SAMPLE_BRANCH_STACK) {
101 COMP(branch_stack->nr);
102 for (i = 0; i < s1->branch_stack->nr; i++)
103 MCOMP(branch_stack->entries[i]);
104 }
105
106 if (type & PERF_SAMPLE_REGS_USER) {
107 size_t sz = hweight_long(s1->user_regs.mask) * sizeof(u64);
108
109 COMP(user_regs.mask);
110 COMP(user_regs.abi);
111 if (s1->user_regs.abi &&
112 (!s1->user_regs.regs || !s2->user_regs.regs ||
113 memcmp(s1->user_regs.regs, s2->user_regs.regs, sz))) {
114 pr_debug("Samples differ at 'user_regs'\n");
115 return false;
116 }
117 }
118
119 if (type & PERF_SAMPLE_STACK_USER) {
120 COMP(user_stack.size);
121 if (memcmp(s1->user_stack.data, s2->user_stack.data,
122 s1->user_stack.size)) {
123 pr_debug("Samples differ at 'user_stack'\n");
124 return false;
125 }
126 }
127
128 if (type & PERF_SAMPLE_WEIGHT)
129 COMP(weight);
130
131 if (type & PERF_SAMPLE_DATA_SRC)
132 COMP(data_src);
133
134 if (type & PERF_SAMPLE_TRANSACTION)
135 COMP(transaction);
136
137 if (type & PERF_SAMPLE_REGS_INTR) {
138 size_t sz = hweight_long(s1->intr_regs.mask) * sizeof(u64);
139
140 COMP(intr_regs.mask);
141 COMP(intr_regs.abi);
142 if (s1->intr_regs.abi &&
143 (!s1->intr_regs.regs || !s2->intr_regs.regs ||
144 memcmp(s1->intr_regs.regs, s2->intr_regs.regs, sz))) {
145 pr_debug("Samples differ at 'intr_regs'\n");
146 return false;
147 }
148 }
149
150 if (type & PERF_SAMPLE_PHYS_ADDR)
151 COMP(phys_addr);
152
153 return true;
154}
155
156static int do_test(u64 sample_type, u64 sample_regs, u64 read_format)
157{
158 struct evsel evsel = {
159 .needs_swap = false,
160 .core = {
161 . attr = {
162 .sample_type = sample_type,
163 .read_format = read_format,
164 },
165 },
166 };
167 union perf_event *event;
168 union {
169 struct ip_callchain callchain;
170 u64 data[64];
171 } callchain = {
172 /* 3 ips */
173 .data = {3, 201, 202, 203},
174 };
175 union {
176 struct branch_stack branch_stack;
177 u64 data[64];
178 } branch_stack = {
179 /* 1 branch_entry */
180 .data = {1, 211, 212, 213},
181 };
182 u64 regs[64];
183 const u64 raw_data[] = {0x123456780a0b0c0dULL, 0x1102030405060708ULL};
184 const u64 data[] = {0x2211443366558877ULL, 0, 0xaabbccddeeff4321ULL};
185 struct perf_sample sample = {
186 .ip = 101,
187 .pid = 102,
188 .tid = 103,
189 .time = 104,
190 .addr = 105,
191 .id = 106,
192 .stream_id = 107,
193 .period = 108,
194 .weight = 109,
195 .cpu = 110,
196 .raw_size = sizeof(raw_data),
197 .data_src = 111,
198 .transaction = 112,
199 .raw_data = (void *)raw_data,
200 .callchain = &callchain.callchain,
201 .branch_stack = &branch_stack.branch_stack,
202 .user_regs = {
203 .abi = PERF_SAMPLE_REGS_ABI_64,
204 .mask = sample_regs,
205 .regs = regs,
206 },
207 .user_stack = {
208 .size = sizeof(data),
209 .data = (void *)data,
210 },
211 .read = {
212 .time_enabled = 0x030a59d664fca7deULL,
213 .time_running = 0x011b6ae553eb98edULL,
214 },
215 .intr_regs = {
216 .abi = PERF_SAMPLE_REGS_ABI_64,
217 .mask = sample_regs,
218 .regs = regs,
219 },
220 .phys_addr = 113,
221 };
222 struct sample_read_value values[] = {{1, 5}, {9, 3}, {2, 7}, {6, 4},};
223 struct perf_sample sample_out;
224 size_t i, sz, bufsz;
225 int err, ret = -1;
226
227 if (sample_type & PERF_SAMPLE_REGS_USER)
228 evsel.core.attr.sample_regs_user = sample_regs;
229
230 if (sample_type & PERF_SAMPLE_REGS_INTR)
231 evsel.core.attr.sample_regs_intr = sample_regs;
232
233 for (i = 0; i < sizeof(regs); i++)
234 *(i + (u8 *)regs) = i & 0xfe;
235
236 if (read_format & PERF_FORMAT_GROUP) {
237 sample.read.group.nr = 4;
238 sample.read.group.values = values;
239 } else {
240 sample.read.one.value = 0x08789faeb786aa87ULL;
241 sample.read.one.id = 99;
242 }
243
244 sz = perf_event__sample_event_size(&sample, sample_type, read_format);
245 bufsz = sz + 4096; /* Add a bit for overrun checking */
246 event = malloc(bufsz);
247 if (!event) {
248 pr_debug("malloc failed\n");
249 return -1;
250 }
251
252 memset(event, 0xff, bufsz);
253 event->header.type = PERF_RECORD_SAMPLE;
254 event->header.misc = 0;
255 event->header.size = sz;
256
257 err = perf_event__synthesize_sample(event, sample_type, read_format,
258 &sample);
259 if (err) {
260 pr_debug("%s failed for sample_type %#"PRIx64", error %d\n",
261 "perf_event__synthesize_sample", sample_type, err);
262 goto out_free;
263 }
264
265 /* The data does not contain 0xff so we use that to check the size */
266 for (i = bufsz; i > 0; i--) {
267 if (*(i - 1 + (u8 *)event) != 0xff)
268 break;
269 }
270 if (i != sz) {
271 pr_debug("Event size mismatch: actual %zu vs expected %zu\n",
272 i, sz);
273 goto out_free;
274 }
275
276 evsel.sample_size = __perf_evsel__sample_size(sample_type);
277
278 err = perf_evsel__parse_sample(&evsel, event, &sample_out);
279 if (err) {
280 pr_debug("%s failed for sample_type %#"PRIx64", error %d\n",
281 "perf_evsel__parse_sample", sample_type, err);
282 goto out_free;
283 }
284
285 if (!samples_same(&sample, &sample_out, sample_type, read_format)) {
286 pr_debug("parsing failed for sample_type %#"PRIx64"\n",
287 sample_type);
288 goto out_free;
289 }
290
291 ret = 0;
292out_free:
293 free(event);
294 if (ret && read_format)
295 pr_debug("read_format %#"PRIx64"\n", read_format);
296 return ret;
297}
298
299/**
300 * test__sample_parsing - test sample parsing.
301 *
302 * This function implements a test that synthesizes a sample event, parses it
303 * and then checks that the parsed sample matches the original sample. The test
304 * checks sample format bits separately and together. If the test passes %0 is
305 * returned, otherwise %-1 is returned.
306 */
307int test__sample_parsing(struct test *test __maybe_unused, int subtest __maybe_unused)
308{
309 const u64 rf[] = {4, 5, 6, 7, 12, 13, 14, 15};
310 u64 sample_type;
311 u64 sample_regs;
312 size_t i;
313 int err;
314
315 /*
316 * Fail the test if it has not been updated when new sample format bits
317 * were added. Please actually update the test rather than just change
318 * the condition below.
319 */
320 if (PERF_SAMPLE_MAX > PERF_SAMPLE_PHYS_ADDR << 1) {
321 pr_debug("sample format has changed, some new PERF_SAMPLE_ bit was introduced - test needs updating\n");
322 return -1;
323 }
324
325 /* Test each sample format bit separately */
326 for (sample_type = 1; sample_type != PERF_SAMPLE_MAX;
327 sample_type <<= 1) {
328 /* Test read_format variations */
329 if (sample_type == PERF_SAMPLE_READ) {
330 for (i = 0; i < ARRAY_SIZE(rf); i++) {
331 err = do_test(sample_type, 0, rf[i]);
332 if (err)
333 return err;
334 }
335 continue;
336 }
337 sample_regs = 0;
338
339 if (sample_type == PERF_SAMPLE_REGS_USER)
340 sample_regs = 0x3fff;
341
342 if (sample_type == PERF_SAMPLE_REGS_INTR)
343 sample_regs = 0xff0fff;
344
345 err = do_test(sample_type, sample_regs, 0);
346 if (err)
347 return err;
348 }
349
350 /* Test all sample format bits together */
351 sample_type = PERF_SAMPLE_MAX - 1;
352 sample_regs = 0x3fff; /* shared yb intr and user regs */
353 for (i = 0; i < ARRAY_SIZE(rf); i++) {
354 err = do_test(sample_type, sample_regs, rf[i]);
355 if (err)
356 return err;
357 }
358
359 return 0;
360}
1#include <stdbool.h>
2#include <inttypes.h>
3
4#include "util.h"
5#include "event.h"
6#include "evsel.h"
7
8#include "tests.h"
9
10#define COMP(m) do { \
11 if (s1->m != s2->m) { \
12 pr_debug("Samples differ at '"#m"'\n"); \
13 return false; \
14 } \
15} while (0)
16
17#define MCOMP(m) do { \
18 if (memcmp(&s1->m, &s2->m, sizeof(s1->m))) { \
19 pr_debug("Samples differ at '"#m"'\n"); \
20 return false; \
21 } \
22} while (0)
23
24static bool samples_same(const struct perf_sample *s1,
25 const struct perf_sample *s2,
26 u64 type, u64 read_format)
27{
28 size_t i;
29
30 if (type & PERF_SAMPLE_IDENTIFIER)
31 COMP(id);
32
33 if (type & PERF_SAMPLE_IP)
34 COMP(ip);
35
36 if (type & PERF_SAMPLE_TID) {
37 COMP(pid);
38 COMP(tid);
39 }
40
41 if (type & PERF_SAMPLE_TIME)
42 COMP(time);
43
44 if (type & PERF_SAMPLE_ADDR)
45 COMP(addr);
46
47 if (type & PERF_SAMPLE_ID)
48 COMP(id);
49
50 if (type & PERF_SAMPLE_STREAM_ID)
51 COMP(stream_id);
52
53 if (type & PERF_SAMPLE_CPU)
54 COMP(cpu);
55
56 if (type & PERF_SAMPLE_PERIOD)
57 COMP(period);
58
59 if (type & PERF_SAMPLE_READ) {
60 if (read_format & PERF_FORMAT_GROUP)
61 COMP(read.group.nr);
62 else
63 COMP(read.one.value);
64 if (read_format & PERF_FORMAT_TOTAL_TIME_ENABLED)
65 COMP(read.time_enabled);
66 if (read_format & PERF_FORMAT_TOTAL_TIME_RUNNING)
67 COMP(read.time_running);
68 /* PERF_FORMAT_ID is forced for PERF_SAMPLE_READ */
69 if (read_format & PERF_FORMAT_GROUP) {
70 for (i = 0; i < s1->read.group.nr; i++)
71 MCOMP(read.group.values[i]);
72 } else {
73 COMP(read.one.id);
74 }
75 }
76
77 if (type & PERF_SAMPLE_CALLCHAIN) {
78 COMP(callchain->nr);
79 for (i = 0; i < s1->callchain->nr; i++)
80 COMP(callchain->ips[i]);
81 }
82
83 if (type & PERF_SAMPLE_RAW) {
84 COMP(raw_size);
85 if (memcmp(s1->raw_data, s2->raw_data, s1->raw_size)) {
86 pr_debug("Samples differ at 'raw_data'\n");
87 return false;
88 }
89 }
90
91 if (type & PERF_SAMPLE_BRANCH_STACK) {
92 COMP(branch_stack->nr);
93 for (i = 0; i < s1->branch_stack->nr; i++)
94 MCOMP(branch_stack->entries[i]);
95 }
96
97 if (type & PERF_SAMPLE_REGS_USER) {
98 size_t sz = hweight_long(s1->user_regs.mask) * sizeof(u64);
99
100 COMP(user_regs.mask);
101 COMP(user_regs.abi);
102 if (s1->user_regs.abi &&
103 (!s1->user_regs.regs || !s2->user_regs.regs ||
104 memcmp(s1->user_regs.regs, s2->user_regs.regs, sz))) {
105 pr_debug("Samples differ at 'user_regs'\n");
106 return false;
107 }
108 }
109
110 if (type & PERF_SAMPLE_STACK_USER) {
111 COMP(user_stack.size);
112 if (memcmp(s1->user_stack.data, s1->user_stack.data,
113 s1->user_stack.size)) {
114 pr_debug("Samples differ at 'user_stack'\n");
115 return false;
116 }
117 }
118
119 if (type & PERF_SAMPLE_WEIGHT)
120 COMP(weight);
121
122 if (type & PERF_SAMPLE_DATA_SRC)
123 COMP(data_src);
124
125 if (type & PERF_SAMPLE_TRANSACTION)
126 COMP(transaction);
127
128 return true;
129}
130
131static int do_test(u64 sample_type, u64 sample_regs_user, u64 read_format)
132{
133 struct perf_evsel evsel = {
134 .needs_swap = false,
135 .attr = {
136 .sample_type = sample_type,
137 .sample_regs_user = sample_regs_user,
138 .read_format = read_format,
139 },
140 };
141 union perf_event *event;
142 union {
143 struct ip_callchain callchain;
144 u64 data[64];
145 } callchain = {
146 /* 3 ips */
147 .data = {3, 201, 202, 203},
148 };
149 union {
150 struct branch_stack branch_stack;
151 u64 data[64];
152 } branch_stack = {
153 /* 1 branch_entry */
154 .data = {1, 211, 212, 213},
155 };
156 u64 user_regs[64];
157 const u64 raw_data[] = {0x123456780a0b0c0dULL, 0x1102030405060708ULL};
158 const u64 data[] = {0x2211443366558877ULL, 0, 0xaabbccddeeff4321ULL};
159 struct perf_sample sample = {
160 .ip = 101,
161 .pid = 102,
162 .tid = 103,
163 .time = 104,
164 .addr = 105,
165 .id = 106,
166 .stream_id = 107,
167 .period = 108,
168 .weight = 109,
169 .cpu = 110,
170 .raw_size = sizeof(raw_data),
171 .data_src = 111,
172 .transaction = 112,
173 .raw_data = (void *)raw_data,
174 .callchain = &callchain.callchain,
175 .branch_stack = &branch_stack.branch_stack,
176 .user_regs = {
177 .abi = PERF_SAMPLE_REGS_ABI_64,
178 .mask = sample_regs_user,
179 .regs = user_regs,
180 },
181 .user_stack = {
182 .size = sizeof(data),
183 .data = (void *)data,
184 },
185 .read = {
186 .time_enabled = 0x030a59d664fca7deULL,
187 .time_running = 0x011b6ae553eb98edULL,
188 },
189 };
190 struct sample_read_value values[] = {{1, 5}, {9, 3}, {2, 7}, {6, 4},};
191 struct perf_sample sample_out;
192 size_t i, sz, bufsz;
193 int err, ret = -1;
194
195 for (i = 0; i < sizeof(user_regs); i++)
196 *(i + (u8 *)user_regs) = i & 0xfe;
197
198 if (read_format & PERF_FORMAT_GROUP) {
199 sample.read.group.nr = 4;
200 sample.read.group.values = values;
201 } else {
202 sample.read.one.value = 0x08789faeb786aa87ULL;
203 sample.read.one.id = 99;
204 }
205
206 sz = perf_event__sample_event_size(&sample, sample_type, read_format);
207 bufsz = sz + 4096; /* Add a bit for overrun checking */
208 event = malloc(bufsz);
209 if (!event) {
210 pr_debug("malloc failed\n");
211 return -1;
212 }
213
214 memset(event, 0xff, bufsz);
215 event->header.type = PERF_RECORD_SAMPLE;
216 event->header.misc = 0;
217 event->header.size = sz;
218
219 err = perf_event__synthesize_sample(event, sample_type, read_format,
220 &sample, false);
221 if (err) {
222 pr_debug("%s failed for sample_type %#"PRIx64", error %d\n",
223 "perf_event__synthesize_sample", sample_type, err);
224 goto out_free;
225 }
226
227 /* The data does not contain 0xff so we use that to check the size */
228 for (i = bufsz; i > 0; i--) {
229 if (*(i - 1 + (u8 *)event) != 0xff)
230 break;
231 }
232 if (i != sz) {
233 pr_debug("Event size mismatch: actual %zu vs expected %zu\n",
234 i, sz);
235 goto out_free;
236 }
237
238 evsel.sample_size = __perf_evsel__sample_size(sample_type);
239
240 err = perf_evsel__parse_sample(&evsel, event, &sample_out);
241 if (err) {
242 pr_debug("%s failed for sample_type %#"PRIx64", error %d\n",
243 "perf_evsel__parse_sample", sample_type, err);
244 goto out_free;
245 }
246
247 if (!samples_same(&sample, &sample_out, sample_type, read_format)) {
248 pr_debug("parsing failed for sample_type %#"PRIx64"\n",
249 sample_type);
250 goto out_free;
251 }
252
253 ret = 0;
254out_free:
255 free(event);
256 if (ret && read_format)
257 pr_debug("read_format %#"PRIx64"\n", read_format);
258 return ret;
259}
260
261/**
262 * test__sample_parsing - test sample parsing.
263 *
264 * This function implements a test that synthesizes a sample event, parses it
265 * and then checks that the parsed sample matches the original sample. The test
266 * checks sample format bits separately and together. If the test passes %0 is
267 * returned, otherwise %-1 is returned.
268 */
269int test__sample_parsing(void)
270{
271 const u64 rf[] = {4, 5, 6, 7, 12, 13, 14, 15};
272 u64 sample_type;
273 u64 sample_regs_user;
274 size_t i;
275 int err;
276
277 /*
278 * Fail the test if it has not been updated when new sample format bits
279 * were added. Please actually update the test rather than just change
280 * the condition below.
281 */
282 if (PERF_SAMPLE_MAX > PERF_SAMPLE_TRANSACTION << 1) {
283 pr_debug("sample format has changed, some new PERF_SAMPLE_ bit was introduced - test needs updating\n");
284 return -1;
285 }
286
287 /* Test each sample format bit separately */
288 for (sample_type = 1; sample_type != PERF_SAMPLE_MAX;
289 sample_type <<= 1) {
290 /* Test read_format variations */
291 if (sample_type == PERF_SAMPLE_READ) {
292 for (i = 0; i < ARRAY_SIZE(rf); i++) {
293 err = do_test(sample_type, 0, rf[i]);
294 if (err)
295 return err;
296 }
297 continue;
298 }
299
300 if (sample_type == PERF_SAMPLE_REGS_USER)
301 sample_regs_user = 0x3fff;
302 else
303 sample_regs_user = 0;
304
305 err = do_test(sample_type, sample_regs_user, 0);
306 if (err)
307 return err;
308 }
309
310 /* Test all sample format bits together */
311 sample_type = PERF_SAMPLE_MAX - 1;
312 sample_regs_user = 0x3fff;
313 for (i = 0; i < ARRAY_SIZE(rf); i++) {
314 err = do_test(sample_type, sample_regs_user, rf[i]);
315 if (err)
316 return err;
317 }
318
319 return 0;
320}