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