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 33 static 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 if (type & PERF_SAMPLE_AUX) { 154 COMP(aux_sample.size); 155 if (memcmp(s1->aux_sample.data, s2->aux_sample.data, 156 s1->aux_sample.size)) { 157 pr_debug("Samples differ at 'aux_sample'\n"); 158 return false; 159 } 160 } 161 162 return true; 163 } 164 165 static int do_test(u64 sample_type, u64 sample_regs, u64 read_format) 166 { 167 struct evsel evsel = { 168 .needs_swap = false, 169 .core = { 170 . attr = { 171 .sample_type = sample_type, 172 .read_format = read_format, 173 }, 174 }, 175 }; 176 union perf_event *event; 177 union { 178 struct ip_callchain callchain; 179 u64 data[64]; 180 } callchain = { 181 /* 3 ips */ 182 .data = {3, 201, 202, 203}, 183 }; 184 union { 185 struct branch_stack branch_stack; 186 u64 data[64]; 187 } branch_stack = { 188 /* 1 branch_entry */ 189 .data = {1, 211, 212, 213}, 190 }; 191 u64 regs[64]; 192 const u64 raw_data[] = {0x123456780a0b0c0dULL, 0x1102030405060708ULL}; 193 const u64 data[] = {0x2211443366558877ULL, 0, 0xaabbccddeeff4321ULL}; 194 const u64 aux_data[] = {0xa55a, 0, 0xeeddee, 0x0282028202820282}; 195 struct perf_sample sample = { 196 .ip = 101, 197 .pid = 102, 198 .tid = 103, 199 .time = 104, 200 .addr = 105, 201 .id = 106, 202 .stream_id = 107, 203 .period = 108, 204 .weight = 109, 205 .cpu = 110, 206 .raw_size = sizeof(raw_data), 207 .data_src = 111, 208 .transaction = 112, 209 .raw_data = (void *)raw_data, 210 .callchain = &callchain.callchain, 211 .branch_stack = &branch_stack.branch_stack, 212 .user_regs = { 213 .abi = PERF_SAMPLE_REGS_ABI_64, 214 .mask = sample_regs, 215 .regs = regs, 216 }, 217 .user_stack = { 218 .size = sizeof(data), 219 .data = (void *)data, 220 }, 221 .read = { 222 .time_enabled = 0x030a59d664fca7deULL, 223 .time_running = 0x011b6ae553eb98edULL, 224 }, 225 .intr_regs = { 226 .abi = PERF_SAMPLE_REGS_ABI_64, 227 .mask = sample_regs, 228 .regs = regs, 229 }, 230 .phys_addr = 113, 231 .aux_sample = { 232 .size = sizeof(aux_data), 233 .data = (void *)aux_data, 234 }, 235 }; 236 struct sample_read_value values[] = {{1, 5}, {9, 3}, {2, 7}, {6, 4},}; 237 struct perf_sample sample_out; 238 size_t i, sz, bufsz; 239 int err, ret = -1; 240 241 if (sample_type & PERF_SAMPLE_REGS_USER) 242 evsel.core.attr.sample_regs_user = sample_regs; 243 244 if (sample_type & PERF_SAMPLE_REGS_INTR) 245 evsel.core.attr.sample_regs_intr = sample_regs; 246 247 for (i = 0; i < sizeof(regs); i++) 248 *(i + (u8 *)regs) = i & 0xfe; 249 250 if (read_format & PERF_FORMAT_GROUP) { 251 sample.read.group.nr = 4; 252 sample.read.group.values = values; 253 } else { 254 sample.read.one.value = 0x08789faeb786aa87ULL; 255 sample.read.one.id = 99; 256 } 257 258 sz = perf_event__sample_event_size(&sample, sample_type, read_format); 259 bufsz = sz + 4096; /* Add a bit for overrun checking */ 260 event = malloc(bufsz); 261 if (!event) { 262 pr_debug("malloc failed\n"); 263 return -1; 264 } 265 266 memset(event, 0xff, bufsz); 267 event->header.type = PERF_RECORD_SAMPLE; 268 event->header.misc = 0; 269 event->header.size = sz; 270 271 err = perf_event__synthesize_sample(event, sample_type, read_format, 272 &sample); 273 if (err) { 274 pr_debug("%s failed for sample_type %#"PRIx64", error %d\n", 275 "perf_event__synthesize_sample", sample_type, err); 276 goto out_free; 277 } 278 279 /* The data does not contain 0xff so we use that to check the size */ 280 for (i = bufsz; i > 0; i--) { 281 if (*(i - 1 + (u8 *)event) != 0xff) 282 break; 283 } 284 if (i != sz) { 285 pr_debug("Event size mismatch: actual %zu vs expected %zu\n", 286 i, sz); 287 goto out_free; 288 } 289 290 evsel.sample_size = __perf_evsel__sample_size(sample_type); 291 292 err = perf_evsel__parse_sample(&evsel, event, &sample_out); 293 if (err) { 294 pr_debug("%s failed for sample_type %#"PRIx64", error %d\n", 295 "perf_evsel__parse_sample", sample_type, err); 296 goto out_free; 297 } 298 299 if (!samples_same(&sample, &sample_out, sample_type, read_format)) { 300 pr_debug("parsing failed for sample_type %#"PRIx64"\n", 301 sample_type); 302 goto out_free; 303 } 304 305 ret = 0; 306 out_free: 307 free(event); 308 if (ret && read_format) 309 pr_debug("read_format %#"PRIx64"\n", read_format); 310 return ret; 311 } 312 313 /** 314 * test__sample_parsing - test sample parsing. 315 * 316 * This function implements a test that synthesizes a sample event, parses it 317 * and then checks that the parsed sample matches the original sample. The test 318 * checks sample format bits separately and together. If the test passes %0 is 319 * returned, otherwise %-1 is returned. 320 */ 321 int test__sample_parsing(struct test *test __maybe_unused, int subtest __maybe_unused) 322 { 323 const u64 rf[] = {4, 5, 6, 7, 12, 13, 14, 15}; 324 u64 sample_type; 325 u64 sample_regs; 326 size_t i; 327 int err; 328 329 /* 330 * Fail the test if it has not been updated when new sample format bits 331 * were added. Please actually update the test rather than just change 332 * the condition below. 333 */ 334 if (PERF_SAMPLE_MAX > PERF_SAMPLE_AUX << 1) { 335 pr_debug("sample format has changed, some new PERF_SAMPLE_ bit was introduced - test needs updating\n"); 336 return -1; 337 } 338 339 /* Test each sample format bit separately */ 340 for (sample_type = 1; sample_type != PERF_SAMPLE_MAX; 341 sample_type <<= 1) { 342 /* Test read_format variations */ 343 if (sample_type == PERF_SAMPLE_READ) { 344 for (i = 0; i < ARRAY_SIZE(rf); i++) { 345 err = do_test(sample_type, 0, rf[i]); 346 if (err) 347 return err; 348 } 349 continue; 350 } 351 sample_regs = 0; 352 353 if (sample_type == PERF_SAMPLE_REGS_USER) 354 sample_regs = 0x3fff; 355 356 if (sample_type == PERF_SAMPLE_REGS_INTR) 357 sample_regs = 0xff0fff; 358 359 err = do_test(sample_type, sample_regs, 0); 360 if (err) 361 return err; 362 } 363 364 /* Test all sample format bits together */ 365 sample_type = PERF_SAMPLE_MAX - 1; 366 sample_regs = 0x3fff; /* shared yb intr and user regs */ 367 for (i = 0; i < ARRAY_SIZE(rf); i++) { 368 err = do_test(sample_type, sample_regs, rf[i]); 369 if (err) 370 return err; 371 } 372 373 return 0; 374 } 375