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 #include "util/util.h" 17 18 #include "tests.h" 19 20 #define COMP(m) do { \ 21 if (s1->m != s2->m) { \ 22 pr_debug("Samples differ at '"#m"'\n"); \ 23 return false; \ 24 } \ 25 } while (0) 26 27 #define MCOMP(m) do { \ 28 if (memcmp(&s1->m, &s2->m, sizeof(s1->m))) { \ 29 pr_debug("Samples differ at '"#m"'\n"); \ 30 return false; \ 31 } \ 32 } while (0) 33 34 /* 35 * Hardcode the expected values for branch_entry flags. 36 * These are based on the input value (213) specified 37 * in branch_stack variable. 38 */ 39 #define BS_EXPECTED_BE 0xa000d00000000000 40 #define BS_EXPECTED_LE 0x1aa00000000 41 #define FLAG(s) s->branch_stack->entries[i].flags 42 43 static bool samples_same(struct perf_sample *s1, 44 struct perf_sample *s2, 45 u64 type, u64 read_format, bool needs_swap) 46 { 47 size_t i; 48 49 if (type & PERF_SAMPLE_IDENTIFIER) 50 COMP(id); 51 52 if (type & PERF_SAMPLE_IP) 53 COMP(ip); 54 55 if (type & PERF_SAMPLE_TID) { 56 COMP(pid); 57 COMP(tid); 58 } 59 60 if (type & PERF_SAMPLE_TIME) 61 COMP(time); 62 63 if (type & PERF_SAMPLE_ADDR) 64 COMP(addr); 65 66 if (type & PERF_SAMPLE_ID) 67 COMP(id); 68 69 if (type & PERF_SAMPLE_STREAM_ID) 70 COMP(stream_id); 71 72 if (type & PERF_SAMPLE_CPU) 73 COMP(cpu); 74 75 if (type & PERF_SAMPLE_PERIOD) 76 COMP(period); 77 78 if (type & PERF_SAMPLE_READ) { 79 if (read_format & PERF_FORMAT_GROUP) 80 COMP(read.group.nr); 81 else 82 COMP(read.one.value); 83 if (read_format & PERF_FORMAT_TOTAL_TIME_ENABLED) 84 COMP(read.time_enabled); 85 if (read_format & PERF_FORMAT_TOTAL_TIME_RUNNING) 86 COMP(read.time_running); 87 /* PERF_FORMAT_ID is forced for PERF_SAMPLE_READ */ 88 if (read_format & PERF_FORMAT_GROUP) { 89 for (i = 0; i < s1->read.group.nr; i++) { 90 /* FIXME: check values without LOST */ 91 if (read_format & PERF_FORMAT_LOST) 92 MCOMP(read.group.values[i]); 93 } 94 } else { 95 COMP(read.one.id); 96 if (read_format & PERF_FORMAT_LOST) 97 COMP(read.one.lost); 98 } 99 } 100 101 if (type & PERF_SAMPLE_CALLCHAIN) { 102 COMP(callchain->nr); 103 for (i = 0; i < s1->callchain->nr; i++) 104 COMP(callchain->ips[i]); 105 } 106 107 if (type & PERF_SAMPLE_RAW) { 108 COMP(raw_size); 109 if (memcmp(s1->raw_data, s2->raw_data, s1->raw_size)) { 110 pr_debug("Samples differ at 'raw_data'\n"); 111 return false; 112 } 113 } 114 115 if (type & PERF_SAMPLE_BRANCH_STACK) { 116 COMP(branch_stack->nr); 117 COMP(branch_stack->hw_idx); 118 for (i = 0; i < s1->branch_stack->nr; i++) { 119 if (needs_swap) 120 return ((host_is_bigendian()) ? 121 (FLAG(s2).value == BS_EXPECTED_BE) : 122 (FLAG(s2).value == BS_EXPECTED_LE)); 123 else 124 MCOMP(branch_stack->entries[i]); 125 } 126 } 127 128 if (type & PERF_SAMPLE_REGS_USER) { 129 struct regs_dump *s1_regs = perf_sample__user_regs(s1); 130 struct regs_dump *s2_regs = perf_sample__user_regs(s2); 131 size_t sz = hweight_long(s1_regs->mask) * sizeof(u64); 132 133 COMP(user_regs->mask); 134 COMP(user_regs->abi); 135 if (s1_regs->abi && 136 (!s1_regs->regs || !s2_regs->regs || 137 memcmp(s1_regs->regs, s2_regs->regs, sz))) { 138 pr_debug("Samples differ at 'user_regs'\n"); 139 return false; 140 } 141 } 142 143 if (type & PERF_SAMPLE_STACK_USER) { 144 COMP(user_stack.size); 145 if (memcmp(s1->user_stack.data, s2->user_stack.data, 146 s1->user_stack.size)) { 147 pr_debug("Samples differ at 'user_stack'\n"); 148 return false; 149 } 150 } 151 152 if (type & PERF_SAMPLE_WEIGHT) 153 COMP(weight); 154 155 if (type & PERF_SAMPLE_WEIGHT_STRUCT) { 156 COMP(weight); 157 COMP(ins_lat); 158 COMP(weight3); 159 } 160 161 if (type & PERF_SAMPLE_DATA_SRC) 162 COMP(data_src); 163 164 if (type & PERF_SAMPLE_TRANSACTION) 165 COMP(transaction); 166 167 if (type & PERF_SAMPLE_REGS_INTR) { 168 struct regs_dump *s1_regs = perf_sample__intr_regs(s1); 169 struct regs_dump *s2_regs = perf_sample__intr_regs(s2); 170 size_t sz = hweight_long(s1_regs->mask) * sizeof(u64); 171 172 COMP(intr_regs->mask); 173 COMP(intr_regs->abi); 174 if (s1_regs->abi && 175 (!s1_regs->regs || !s2_regs->regs || 176 memcmp(s1_regs->regs, s2_regs->regs, sz))) { 177 pr_debug("Samples differ at 'intr_regs'\n"); 178 return false; 179 } 180 } 181 182 if (type & PERF_SAMPLE_PHYS_ADDR) 183 COMP(phys_addr); 184 185 if (type & PERF_SAMPLE_CGROUP) 186 COMP(cgroup); 187 188 if (type & PERF_SAMPLE_DATA_PAGE_SIZE) 189 COMP(data_page_size); 190 191 if (type & PERF_SAMPLE_CODE_PAGE_SIZE) 192 COMP(code_page_size); 193 194 if (type & PERF_SAMPLE_AUX) { 195 COMP(aux_sample.size); 196 if (memcmp(s1->aux_sample.data, s2->aux_sample.data, 197 s1->aux_sample.size)) { 198 pr_debug("Samples differ at 'aux_sample'\n"); 199 return false; 200 } 201 } 202 203 return true; 204 } 205 206 static int do_test(u64 sample_type, u64 sample_regs, u64 read_format) 207 { 208 struct perf_event_attr attr = { 209 .sample_type = sample_type, 210 .read_format = read_format, 211 }; 212 struct evsel *evsel; 213 union perf_event *event; 214 union { 215 struct ip_callchain callchain; 216 u64 data[64]; 217 } callchain = { 218 /* 3 ips */ 219 .data = {3, 201, 202, 203}, 220 }; 221 union { 222 struct branch_stack branch_stack; 223 u64 data[64]; 224 } branch_stack = { 225 /* 1 branch_entry */ 226 .data = {1, -1ULL, 211, 212, 213}, 227 }; 228 u64 regs[64]; 229 const u32 raw_data[] = {0x12345678, 0x0a0b0c0d, 0x11020304, 0x05060708, 0 }; 230 const u64 data[] = {0x2211443366558877ULL, 0, 0xaabbccddeeff4321ULL}; 231 const u64 aux_data[] = {0xa55a, 0, 0xeeddee, 0x0282028202820282}; 232 struct regs_dump user_regs = { 233 .abi = PERF_SAMPLE_REGS_ABI_64, 234 .mask = sample_regs, 235 .regs = regs, 236 }; 237 struct regs_dump intr_regs = { 238 .abi = PERF_SAMPLE_REGS_ABI_64, 239 .mask = sample_regs, 240 .regs = regs, 241 }; 242 struct perf_sample sample = { 243 .ip = 101, 244 .pid = 102, 245 .tid = 103, 246 .time = 104, 247 .addr = 105, 248 .id = 106, 249 .stream_id = 107, 250 .period = 108, 251 .weight = 109, 252 .cpu = 110, 253 .raw_size = sizeof(raw_data), 254 .data_src = 111, 255 .transaction = 112, 256 .raw_data = (void *)raw_data, 257 .callchain = &callchain.callchain, 258 .no_hw_idx = false, 259 .branch_stack = &branch_stack.branch_stack, 260 .user_regs = &user_regs, 261 .user_stack = { 262 .size = sizeof(data), 263 .data = (void *)data, 264 }, 265 .read = { 266 .time_enabled = 0x030a59d664fca7deULL, 267 .time_running = 0x011b6ae553eb98edULL, 268 }, 269 .intr_regs = &intr_regs, 270 .phys_addr = 113, 271 .cgroup = 114, 272 .data_page_size = 115, 273 .code_page_size = 116, 274 .ins_lat = 117, 275 .weight3 = 118, 276 .aux_sample = { 277 .size = sizeof(aux_data), 278 .data = (void *)aux_data, 279 }, 280 }; 281 struct sample_read_value values[] = {{1, 5, 0}, {9, 3, 0}, {2, 7, 0}, {6, 4, 1},}; 282 struct perf_sample sample_out, sample_out_endian; 283 size_t i, sz, bufsz; 284 int err, ret = -1; 285 286 evsel = evsel__new(&attr); 287 if (!evsel) { 288 pr_debug("evsel__new failed\n"); 289 return -1; 290 } 291 perf_sample__init(&sample_out, /*all=*/false); 292 perf_sample__init(&sample_out_endian, /*all=*/false); 293 if (sample_type & PERF_SAMPLE_REGS_USER) 294 evsel->core.attr.sample_regs_user = sample_regs; 295 296 if (sample_type & PERF_SAMPLE_REGS_INTR) 297 evsel->core.attr.sample_regs_intr = sample_regs; 298 299 if (sample_type & PERF_SAMPLE_BRANCH_STACK) 300 evsel->core.attr.branch_sample_type |= PERF_SAMPLE_BRANCH_HW_INDEX; 301 302 for (i = 0; i < sizeof(regs); i++) 303 *(i + (u8 *)regs) = i & 0xfe; 304 305 if (read_format & PERF_FORMAT_GROUP) { 306 sample.read.group.nr = 4; 307 sample.read.group.values = values; 308 } else { 309 sample.read.one.value = 0x08789faeb786aa87ULL; 310 sample.read.one.id = 99; 311 sample.read.one.lost = 1; 312 } 313 314 sz = perf_event__sample_event_size(&sample, sample_type, read_format, 315 evsel->core.attr.branch_sample_type); 316 bufsz = sz + 4096; /* Add a bit for overrun checking */ 317 event = malloc(bufsz); 318 if (!event) { 319 pr_debug("malloc failed\n"); 320 goto out_free; 321 } 322 323 memset(event, 0xff, bufsz); 324 event->header.type = PERF_RECORD_SAMPLE; 325 event->header.misc = 0; 326 event->header.size = sz; 327 328 err = perf_event__synthesize_sample(event, sample_type, read_format, 329 evsel->core.attr.branch_sample_type, &sample); 330 if (err) { 331 pr_debug("%s failed for sample_type %#"PRIx64", error %d\n", 332 "perf_event__synthesize_sample", sample_type, err); 333 goto out_free; 334 } 335 336 /* The data does not contain 0xff so we use that to check the size */ 337 for (i = bufsz; i > 0; i--) { 338 if (*(i - 1 + (u8 *)event) != 0xff) 339 break; 340 } 341 if (i != sz) { 342 pr_debug("Event size mismatch: actual %zu vs expected %zu\n", 343 i, sz); 344 goto out_free; 345 } 346 347 evsel->sample_size = __evsel__sample_size(sample_type); 348 349 err = evsel__parse_sample(evsel, event, &sample_out); 350 if (err) { 351 pr_debug("%s failed for sample_type %#"PRIx64", error %d\n", 352 "evsel__parse_sample", sample_type, err); 353 goto out_free; 354 } 355 356 if (!samples_same(&sample, &sample_out, sample_type, read_format, evsel->needs_swap)) { 357 pr_debug("parsing failed for sample_type %#"PRIx64"\n", 358 sample_type); 359 goto out_free; 360 } 361 362 if (sample_type == PERF_SAMPLE_BRANCH_STACK) { 363 evsel->needs_swap = true; 364 evsel->sample_size = __evsel__sample_size(sample_type); 365 err = evsel__parse_sample(evsel, event, &sample_out_endian); 366 if (err) { 367 pr_debug("%s failed for sample_type %#"PRIx64", error %d\n", 368 "evsel__parse_sample", sample_type, err); 369 goto out_free; 370 } 371 372 if (!samples_same(&sample, &sample_out_endian, sample_type, 373 read_format, evsel->needs_swap)) { 374 pr_debug("parsing failed for sample_type %#"PRIx64"\n", 375 sample_type); 376 goto out_free; 377 } 378 } 379 380 ret = 0; 381 out_free: 382 free(event); 383 perf_sample__exit(&sample_out_endian); 384 perf_sample__exit(&sample_out); 385 evsel__put(evsel); 386 if (ret && read_format) 387 pr_debug("read_format %#"PRIx64"\n", read_format); 388 return ret; 389 } 390 391 /** 392 * test__sample_parsing - test sample parsing. 393 * 394 * This function implements a test that synthesizes a sample event, parses it 395 * and then checks that the parsed sample matches the original sample. The test 396 * checks sample format bits separately and together. If the test passes %0 is 397 * returned, otherwise %-1 is returned. 398 */ 399 static int test__sample_parsing(struct test_suite *test __maybe_unused, int subtest __maybe_unused) 400 { 401 const u64 rf[] = {4, 5, 6, 7, 12, 13, 14, 15, 20, 21, 22, 28, 29, 30, 31}; 402 u64 sample_type; 403 u64 sample_regs; 404 size_t i; 405 int err; 406 407 /* 408 * Fail the test if it has not been updated when new sample format bits 409 * were added. Please actually update the test rather than just change 410 * the condition below. 411 */ 412 if (PERF_SAMPLE_MAX > PERF_SAMPLE_WEIGHT_STRUCT << 1) { 413 pr_debug("sample format has changed, some new PERF_SAMPLE_ bit was introduced - test needs updating\n"); 414 return -1; 415 } 416 417 /* Test each sample format bit separately */ 418 for (sample_type = 1; sample_type != PERF_SAMPLE_MAX; 419 sample_type <<= 1) { 420 /* Test read_format variations */ 421 if (sample_type == PERF_SAMPLE_READ) { 422 for (i = 0; i < ARRAY_SIZE(rf); i++) { 423 err = do_test(sample_type, 0, rf[i]); 424 if (err) 425 return err; 426 } 427 continue; 428 } 429 sample_regs = 0; 430 431 if (sample_type == PERF_SAMPLE_REGS_USER) 432 sample_regs = 0x3fff; 433 434 if (sample_type == PERF_SAMPLE_REGS_INTR) 435 sample_regs = 0xff0fff; 436 437 err = do_test(sample_type, sample_regs, 0); 438 if (err) 439 return err; 440 } 441 442 /* 443 * Test all sample format bits together 444 * Note: PERF_SAMPLE_WEIGHT and PERF_SAMPLE_WEIGHT_STRUCT cannot 445 * be set simultaneously. 446 */ 447 sample_type = (PERF_SAMPLE_MAX - 1) & ~PERF_SAMPLE_WEIGHT; 448 sample_regs = 0x3fff; /* shared yb intr and user regs */ 449 for (i = 0; i < ARRAY_SIZE(rf); i++) { 450 err = do_test(sample_type, sample_regs, rf[i]); 451 if (err) 452 return err; 453 } 454 sample_type = (PERF_SAMPLE_MAX - 1) & ~PERF_SAMPLE_WEIGHT_STRUCT; 455 for (i = 0; i < ARRAY_SIZE(rf); i++) { 456 err = do_test(sample_type, sample_regs, rf[i]); 457 if (err) 458 return err; 459 } 460 461 return 0; 462 } 463 464 DEFINE_SUITE("Sample parsing", sample_parsing); 465