1 // SPDX-License-Identifier: GPL-2.0+
4 * Ptrace test for hw breakpoints
6 * Based on tools/testing/selftests/breakpoints/breakpoint_test.c
8 * This test forks and the parent then traces the child doing various
9 * types of ptrace enabled breakpoints
11 * Copyright (C) 2018 Michael Neuling, IBM Corporation.
14 #include <sys/ptrace.h>
21 #include <sys/types.h>
23 #include <sys/syscall.h>
24 #include <linux/limits.h>
28 #define SPRN_PVR 0x11F
29 #define PVR_8xx 0x00500000
34 * Use volatile on all global var so that compiler doesn't
35 * optimise their load/stores. Otherwise selftest can fail.
37 static volatile __u64 glvar;
39 #define DAWR_MAX_LEN 512
40 static volatile __u8 big_var[DAWR_MAX_LEN] __attribute__((aligned(512)));
45 __u8 a[A_LEN]; /* double word aligned */
46 __u8 b[B_LEN]; /* double word unaligned */
48 static volatile struct gstruct gstruct __attribute__((aligned(512)));
50 static volatile char cwd[PATH_MAX] __attribute__((aligned(8)));
52 static void get_dbginfo(pid_t child_pid, struct ppc_debug_info *dbginfo)
54 if (ptrace(PPC_PTRACE_GETHWDBGINFO, child_pid, NULL, dbginfo)) {
55 perror("Can't get breakpoint info");
60 static bool dawr_present(struct ppc_debug_info *dbginfo)
62 return !!(dbginfo->features & PPC_DEBUG_FEATURE_DATA_BP_DAWR);
65 static void write_var(int len)
68 volatile __u16 *psvar;
69 volatile __u32 *pivar;
70 volatile __u64 *plvar;
74 pcvar = (volatile __u8 *)&glvar;
78 psvar = (volatile __u16 *)&glvar;
82 pivar = (volatile __u32 *)&glvar;
86 plvar = (volatile __u64 *)&glvar;
87 *plvar = 0xffffffffffffffffLL;
92 static void read_var(int len)
94 __u8 cvar __attribute__((unused));
95 __u16 svar __attribute__((unused));
96 __u32 ivar __attribute__((unused));
97 __u64 lvar __attribute__((unused));
101 cvar = (volatile __u8)glvar;
104 svar = (volatile __u16)glvar;
107 ivar = (volatile __u32)glvar;
110 lvar = (volatile __u64)glvar;
115 static void test_workload(void)
117 __u8 cvar __attribute__((unused));
118 __u32 ivar __attribute__((unused));
121 if (ptrace(PTRACE_TRACEME, 0, NULL, 0)) {
122 perror("Child can't be traced?");
126 /* Wake up father so that it sets up the first test */
127 kill(getpid(), SIGUSR1);
129 /* PTRACE_SET_DEBUGREG, WO test */
130 for (len = 1; len <= sizeof(glvar); len <<= 1)
133 /* PTRACE_SET_DEBUGREG, RO test */
134 for (len = 1; len <= sizeof(glvar); len <<= 1)
137 /* PTRACE_SET_DEBUGREG, RW test */
138 for (len = 1; len <= sizeof(glvar); len <<= 1) {
145 /* PTRACE_SET_DEBUGREG, Kernel Access Userspace test */
146 syscall(__NR_getcwd, &cwd, PATH_MAX);
148 /* PPC_PTRACE_SETHWDEBUG, MODE_EXACT, WO test */
151 /* PPC_PTRACE_SETHWDEBUG, MODE_EXACT, RO test */
154 /* PPC_PTRACE_SETHWDEBUG, MODE_EXACT, RW test */
160 /* PPC_PTRACE_SETHWDEBUG, MODE_EXACT, Kernel Access Userspace test */
161 syscall(__NR_getcwd, &cwd, PATH_MAX);
163 /* PPC_PTRACE_SETHWDEBUG, MODE_RANGE, DW ALIGNED, WO test */
164 gstruct.a[rand() % A_LEN] = 'a';
166 /* PPC_PTRACE_SETHWDEBUG, MODE_RANGE, DW ALIGNED, RO test */
167 cvar = gstruct.a[rand() % A_LEN];
169 /* PPC_PTRACE_SETHWDEBUG, MODE_RANGE, DW ALIGNED, RW test */
171 gstruct.a[rand() % A_LEN] = 'a';
173 cvar = gstruct.a[rand() % A_LEN];
175 /* PPC_PTRACE_SETHWDEBUG, MODE_RANGE, DW UNALIGNED, WO test */
176 gstruct.b[rand() % B_LEN] = 'b';
178 /* PPC_PTRACE_SETHWDEBUG, MODE_RANGE, DW UNALIGNED, RO test */
179 cvar = gstruct.b[rand() % B_LEN];
181 /* PPC_PTRACE_SETHWDEBUG, MODE_RANGE, DW UNALIGNED, RW test */
183 gstruct.b[rand() % B_LEN] = 'b';
185 cvar = gstruct.b[rand() % B_LEN];
187 /* PPC_PTRACE_SETHWDEBUG, MODE_RANGE, DW UNALIGNED, DAR OUTSIDE, RW test */
189 *((int *)(gstruct.a + 4)) = 10;
191 ivar = *((int *)(gstruct.a + 4));
193 /* PPC_PTRACE_SETHWDEBUG. DAWR_MAX_LEN. RW test */
195 big_var[rand() % DAWR_MAX_LEN] = 'a';
197 cvar = big_var[rand() % DAWR_MAX_LEN];
199 /* PPC_PTRACE_SETHWDEBUG 2, MODE_RANGE, DW ALIGNED, WO test */
200 gstruct.a[rand() % A_LEN] = 'a';
202 /* PPC_PTRACE_SETHWDEBUG 2, MODE_RANGE, DW UNALIGNED, RO test */
203 cvar = gstruct.b[rand() % B_LEN];
205 /* PPC_PTRACE_SETHWDEBUG 2, MODE_RANGE, DAWR Overlap, WO test */
206 gstruct.a[rand() % A_LEN] = 'a';
208 /* PPC_PTRACE_SETHWDEBUG 2, MODE_RANGE, DAWR Overlap, RO test */
209 cvar = gstruct.a[rand() % A_LEN];
212 static void check_success(pid_t child_pid, const char *name, const char *type,
213 unsigned long saddr, int len)
217 unsigned long eaddr = (saddr + len - 1) | 0x7;
221 /* Wait for the child to SIGTRAP */
224 ptrace(PTRACE_GETSIGINFO, child_pid, NULL, &siginfo);
226 if (!WIFSTOPPED(status) || WSTOPSIG(status) != SIGTRAP ||
227 (unsigned long)siginfo.si_addr < saddr ||
228 (unsigned long)siginfo.si_addr > eaddr) {
229 printf("%s, %s, len: %d: Fail\n", name, type, len);
233 printf("%s, %s, len: %d: Ok\n", name, type, len);
237 * For ptrace registered watchpoint, signal is generated
238 * before executing load/store. Singlestep the instruction
239 * and then continue the test.
241 ptrace(PTRACE_SINGLESTEP, child_pid, NULL, 0);
246 static void ptrace_set_debugreg(pid_t child_pid, unsigned long wp_addr)
248 if (ptrace(PTRACE_SET_DEBUGREG, child_pid, 0, wp_addr)) {
249 perror("PTRACE_SET_DEBUGREG failed");
254 static int ptrace_sethwdebug(pid_t child_pid, struct ppc_hw_breakpoint *info)
256 int wh = ptrace(PPC_PTRACE_SETHWDEBUG, child_pid, 0, info);
259 perror("PPC_PTRACE_SETHWDEBUG failed");
265 static void ptrace_delhwdebug(pid_t child_pid, int wh)
267 if (ptrace(PPC_PTRACE_DELHWDEBUG, child_pid, 0, wh) < 0) {
268 perror("PPC_PTRACE_DELHWDEBUG failed");
273 #define DABR_READ_SHIFT 0
274 #define DABR_WRITE_SHIFT 1
275 #define DABR_TRANSLATION_SHIFT 2
277 static int test_set_debugreg(pid_t child_pid)
279 unsigned long wp_addr = (unsigned long)&glvar;
280 char *name = "PTRACE_SET_DEBUGREG";
283 /* PTRACE_SET_DEBUGREG, WO test*/
285 wp_addr |= (1UL << DABR_WRITE_SHIFT);
286 wp_addr |= (1UL << DABR_TRANSLATION_SHIFT);
287 for (len = 1; len <= sizeof(glvar); len <<= 1) {
288 ptrace_set_debugreg(child_pid, wp_addr);
289 ptrace(PTRACE_CONT, child_pid, NULL, 0);
290 check_success(child_pid, name, "WO", wp_addr, len);
293 /* PTRACE_SET_DEBUGREG, RO test */
295 wp_addr |= (1UL << DABR_READ_SHIFT);
296 wp_addr |= (1UL << DABR_TRANSLATION_SHIFT);
297 for (len = 1; len <= sizeof(glvar); len <<= 1) {
298 ptrace_set_debugreg(child_pid, wp_addr);
299 ptrace(PTRACE_CONT, child_pid, NULL, 0);
300 check_success(child_pid, name, "RO", wp_addr, len);
303 /* PTRACE_SET_DEBUGREG, RW test */
305 wp_addr |= (1Ul << DABR_READ_SHIFT);
306 wp_addr |= (1UL << DABR_WRITE_SHIFT);
307 wp_addr |= (1UL << DABR_TRANSLATION_SHIFT);
308 for (len = 1; len <= sizeof(glvar); len <<= 1) {
309 ptrace_set_debugreg(child_pid, wp_addr);
310 ptrace(PTRACE_CONT, child_pid, NULL, 0);
311 check_success(child_pid, name, "RW", wp_addr, len);
314 ptrace_set_debugreg(child_pid, 0);
318 static int test_set_debugreg_kernel_userspace(pid_t child_pid)
320 unsigned long wp_addr = (unsigned long)cwd;
321 char *name = "PTRACE_SET_DEBUGREG";
323 /* PTRACE_SET_DEBUGREG, Kernel Access Userspace test */
325 wp_addr |= (1Ul << DABR_READ_SHIFT);
326 wp_addr |= (1UL << DABR_WRITE_SHIFT);
327 wp_addr |= (1UL << DABR_TRANSLATION_SHIFT);
328 ptrace_set_debugreg(child_pid, wp_addr);
329 ptrace(PTRACE_CONT, child_pid, NULL, 0);
330 check_success(child_pid, name, "Kernel Access Userspace", wp_addr, 8);
332 ptrace_set_debugreg(child_pid, 0);
336 static void get_ppc_hw_breakpoint(struct ppc_hw_breakpoint *info, int type,
337 unsigned long addr, int len)
340 info->trigger_type = type;
341 info->condition_mode = PPC_BREAKPOINT_CONDITION_NONE;
342 info->addr = (__u64)addr;
343 info->addr2 = (__u64)addr + len;
344 info->condition_value = 0;
346 info->addr_mode = PPC_BREAKPOINT_MODE_EXACT;
348 info->addr_mode = PPC_BREAKPOINT_MODE_RANGE_INCLUSIVE;
351 static void test_sethwdebug_exact(pid_t child_pid)
353 struct ppc_hw_breakpoint info;
354 unsigned long wp_addr = (unsigned long)&glvar;
355 char *name = "PPC_PTRACE_SETHWDEBUG, MODE_EXACT";
356 int len = 1; /* hardcoded in kernel */
359 /* PPC_PTRACE_SETHWDEBUG, MODE_EXACT, WO test */
360 get_ppc_hw_breakpoint(&info, PPC_BREAKPOINT_TRIGGER_WRITE, wp_addr, 0);
361 wh = ptrace_sethwdebug(child_pid, &info);
362 ptrace(PTRACE_CONT, child_pid, NULL, 0);
363 check_success(child_pid, name, "WO", wp_addr, len);
364 ptrace_delhwdebug(child_pid, wh);
366 /* PPC_PTRACE_SETHWDEBUG, MODE_EXACT, RO test */
367 get_ppc_hw_breakpoint(&info, PPC_BREAKPOINT_TRIGGER_READ, wp_addr, 0);
368 wh = ptrace_sethwdebug(child_pid, &info);
369 ptrace(PTRACE_CONT, child_pid, NULL, 0);
370 check_success(child_pid, name, "RO", wp_addr, len);
371 ptrace_delhwdebug(child_pid, wh);
373 /* PPC_PTRACE_SETHWDEBUG, MODE_EXACT, RW test */
374 get_ppc_hw_breakpoint(&info, PPC_BREAKPOINT_TRIGGER_RW, wp_addr, 0);
375 wh = ptrace_sethwdebug(child_pid, &info);
376 ptrace(PTRACE_CONT, child_pid, NULL, 0);
377 check_success(child_pid, name, "RW", wp_addr, len);
378 ptrace_delhwdebug(child_pid, wh);
381 static void test_sethwdebug_exact_kernel_userspace(pid_t child_pid)
383 struct ppc_hw_breakpoint info;
384 unsigned long wp_addr = (unsigned long)&cwd;
385 char *name = "PPC_PTRACE_SETHWDEBUG, MODE_EXACT";
386 int len = 1; /* hardcoded in kernel */
389 /* PPC_PTRACE_SETHWDEBUG, MODE_EXACT, Kernel Access Userspace test */
390 get_ppc_hw_breakpoint(&info, PPC_BREAKPOINT_TRIGGER_WRITE, wp_addr, 0);
391 wh = ptrace_sethwdebug(child_pid, &info);
392 ptrace(PTRACE_CONT, child_pid, NULL, 0);
393 check_success(child_pid, name, "Kernel Access Userspace", wp_addr, len);
394 ptrace_delhwdebug(child_pid, wh);
397 static void test_sethwdebug_range_aligned(pid_t child_pid)
399 struct ppc_hw_breakpoint info;
400 unsigned long wp_addr;
401 char *name = "PPC_PTRACE_SETHWDEBUG, MODE_RANGE, DW ALIGNED";
405 /* PPC_PTRACE_SETHWDEBUG, MODE_RANGE, DW ALIGNED, WO test */
406 wp_addr = (unsigned long)&gstruct.a;
408 get_ppc_hw_breakpoint(&info, PPC_BREAKPOINT_TRIGGER_WRITE, wp_addr, len);
409 wh = ptrace_sethwdebug(child_pid, &info);
410 ptrace(PTRACE_CONT, child_pid, NULL, 0);
411 check_success(child_pid, name, "WO", wp_addr, len);
412 ptrace_delhwdebug(child_pid, wh);
414 /* PPC_PTRACE_SETHWDEBUG, MODE_RANGE, DW ALIGNED, RO test */
415 wp_addr = (unsigned long)&gstruct.a;
417 get_ppc_hw_breakpoint(&info, PPC_BREAKPOINT_TRIGGER_READ, wp_addr, len);
418 wh = ptrace_sethwdebug(child_pid, &info);
419 ptrace(PTRACE_CONT, child_pid, NULL, 0);
420 check_success(child_pid, name, "RO", wp_addr, len);
421 ptrace_delhwdebug(child_pid, wh);
423 /* PPC_PTRACE_SETHWDEBUG, MODE_RANGE, DW ALIGNED, RW test */
424 wp_addr = (unsigned long)&gstruct.a;
426 get_ppc_hw_breakpoint(&info, PPC_BREAKPOINT_TRIGGER_RW, wp_addr, len);
427 wh = ptrace_sethwdebug(child_pid, &info);
428 ptrace(PTRACE_CONT, child_pid, NULL, 0);
429 check_success(child_pid, name, "RW", wp_addr, len);
430 ptrace_delhwdebug(child_pid, wh);
433 static void test_multi_sethwdebug_range(pid_t child_pid)
435 struct ppc_hw_breakpoint info1, info2;
436 unsigned long wp_addr1, wp_addr2;
437 char *name1 = "PPC_PTRACE_SETHWDEBUG 2, MODE_RANGE, DW ALIGNED";
438 char *name2 = "PPC_PTRACE_SETHWDEBUG 2, MODE_RANGE, DW UNALIGNED";
442 wp_addr1 = (unsigned long)&gstruct.a;
443 wp_addr2 = (unsigned long)&gstruct.b;
446 get_ppc_hw_breakpoint(&info1, PPC_BREAKPOINT_TRIGGER_WRITE, wp_addr1, len1);
447 get_ppc_hw_breakpoint(&info2, PPC_BREAKPOINT_TRIGGER_READ, wp_addr2, len2);
449 /* PPC_PTRACE_SETHWDEBUG 2, MODE_RANGE, DW ALIGNED, WO test */
450 wh1 = ptrace_sethwdebug(child_pid, &info1);
452 /* PPC_PTRACE_SETHWDEBUG 2, MODE_RANGE, DW UNALIGNED, RO test */
453 wh2 = ptrace_sethwdebug(child_pid, &info2);
455 ptrace(PTRACE_CONT, child_pid, NULL, 0);
456 check_success(child_pid, name1, "WO", wp_addr1, len1);
458 ptrace(PTRACE_CONT, child_pid, NULL, 0);
459 check_success(child_pid, name2, "RO", wp_addr2, len2);
461 ptrace_delhwdebug(child_pid, wh1);
462 ptrace_delhwdebug(child_pid, wh2);
465 static void test_multi_sethwdebug_range_dawr_overlap(pid_t child_pid)
467 struct ppc_hw_breakpoint info1, info2;
468 unsigned long wp_addr1, wp_addr2;
469 char *name = "PPC_PTRACE_SETHWDEBUG 2, MODE_RANGE, DAWR Overlap";
473 wp_addr1 = (unsigned long)&gstruct.a;
474 wp_addr2 = (unsigned long)&gstruct.a;
477 get_ppc_hw_breakpoint(&info1, PPC_BREAKPOINT_TRIGGER_WRITE, wp_addr1, len1);
478 get_ppc_hw_breakpoint(&info2, PPC_BREAKPOINT_TRIGGER_READ, wp_addr2, len2);
480 /* PPC_PTRACE_SETHWDEBUG 2, MODE_RANGE, DAWR Overlap, WO test */
481 wh1 = ptrace_sethwdebug(child_pid, &info1);
483 /* PPC_PTRACE_SETHWDEBUG 2, MODE_RANGE, DAWR Overlap, RO test */
484 wh2 = ptrace_sethwdebug(child_pid, &info2);
486 ptrace(PTRACE_CONT, child_pid, NULL, 0);
487 check_success(child_pid, name, "WO", wp_addr1, len1);
489 ptrace(PTRACE_CONT, child_pid, NULL, 0);
490 check_success(child_pid, name, "RO", wp_addr2, len2);
492 ptrace_delhwdebug(child_pid, wh1);
493 ptrace_delhwdebug(child_pid, wh2);
496 static void test_sethwdebug_range_unaligned(pid_t child_pid)
498 struct ppc_hw_breakpoint info;
499 unsigned long wp_addr;
500 char *name = "PPC_PTRACE_SETHWDEBUG, MODE_RANGE, DW UNALIGNED";
504 /* PPC_PTRACE_SETHWDEBUG, MODE_RANGE, DW UNALIGNED, WO test */
505 wp_addr = (unsigned long)&gstruct.b;
507 get_ppc_hw_breakpoint(&info, PPC_BREAKPOINT_TRIGGER_WRITE, wp_addr, len);
508 wh = ptrace_sethwdebug(child_pid, &info);
509 ptrace(PTRACE_CONT, child_pid, NULL, 0);
510 check_success(child_pid, name, "WO", wp_addr, len);
511 ptrace_delhwdebug(child_pid, wh);
513 /* PPC_PTRACE_SETHWDEBUG, MODE_RANGE, DW UNALIGNED, RO test */
514 wp_addr = (unsigned long)&gstruct.b;
516 get_ppc_hw_breakpoint(&info, PPC_BREAKPOINT_TRIGGER_READ, wp_addr, len);
517 wh = ptrace_sethwdebug(child_pid, &info);
518 ptrace(PTRACE_CONT, child_pid, NULL, 0);
519 check_success(child_pid, name, "RO", wp_addr, len);
520 ptrace_delhwdebug(child_pid, wh);
522 /* PPC_PTRACE_SETHWDEBUG, MODE_RANGE, DW UNALIGNED, RW test */
523 wp_addr = (unsigned long)&gstruct.b;
525 get_ppc_hw_breakpoint(&info, PPC_BREAKPOINT_TRIGGER_RW, wp_addr, len);
526 wh = ptrace_sethwdebug(child_pid, &info);
527 ptrace(PTRACE_CONT, child_pid, NULL, 0);
528 check_success(child_pid, name, "RW", wp_addr, len);
529 ptrace_delhwdebug(child_pid, wh);
533 static void test_sethwdebug_range_unaligned_dar(pid_t child_pid)
535 struct ppc_hw_breakpoint info;
536 unsigned long wp_addr;
537 char *name = "PPC_PTRACE_SETHWDEBUG, MODE_RANGE, DW UNALIGNED, DAR OUTSIDE";
541 /* PPC_PTRACE_SETHWDEBUG, MODE_RANGE, DW UNALIGNED, DAR OUTSIDE, RW test */
542 wp_addr = (unsigned long)&gstruct.b;
544 get_ppc_hw_breakpoint(&info, PPC_BREAKPOINT_TRIGGER_WRITE, wp_addr, len);
545 wh = ptrace_sethwdebug(child_pid, &info);
546 ptrace(PTRACE_CONT, child_pid, NULL, 0);
547 check_success(child_pid, name, "RW", wp_addr, len);
548 ptrace_delhwdebug(child_pid, wh);
551 static void test_sethwdebug_dawr_max_range(pid_t child_pid)
553 struct ppc_hw_breakpoint info;
554 unsigned long wp_addr;
555 char *name = "PPC_PTRACE_SETHWDEBUG, DAWR_MAX_LEN";
559 /* PPC_PTRACE_SETHWDEBUG, DAWR_MAX_LEN, RW test */
560 wp_addr = (unsigned long)big_var;
562 get_ppc_hw_breakpoint(&info, PPC_BREAKPOINT_TRIGGER_RW, wp_addr, len);
563 wh = ptrace_sethwdebug(child_pid, &info);
564 ptrace(PTRACE_CONT, child_pid, NULL, 0);
565 check_success(child_pid, name, "RW", wp_addr, len);
566 ptrace_delhwdebug(child_pid, wh);
569 /* Set the breakpoints and check the child successfully trigger them */
571 run_tests(pid_t child_pid, struct ppc_debug_info *dbginfo, bool dawr)
573 test_set_debugreg(child_pid);
574 test_set_debugreg_kernel_userspace(child_pid);
575 test_sethwdebug_exact(child_pid);
576 test_sethwdebug_exact_kernel_userspace(child_pid);
577 if (dbginfo->features & PPC_DEBUG_FEATURE_DATA_BP_RANGE) {
578 test_sethwdebug_range_aligned(child_pid);
579 if (dawr || is_8xx) {
580 test_sethwdebug_range_unaligned(child_pid);
581 test_sethwdebug_range_unaligned_dar(child_pid);
582 test_sethwdebug_dawr_max_range(child_pid);
583 if (dbginfo->num_data_bps > 1) {
584 test_multi_sethwdebug_range(child_pid);
585 test_multi_sethwdebug_range_dawr_overlap(child_pid);
591 static int ptrace_hwbreak(void)
594 struct ppc_debug_info dbginfo;
605 get_dbginfo(child_pid, &dbginfo);
606 SKIP_IF_MSG(dbginfo.num_data_bps == 0, "No data breakpoints present");
608 dawr = dawr_present(&dbginfo);
609 run_tests(child_pid, &dbginfo, dawr);
611 /* Let the child exit first. */
612 ptrace(PTRACE_CONT, child_pid, NULL, 0);
616 * Testcases exits immediately with -1 on any failure. If
617 * it has reached here, it means all tests were successful.
622 int main(int argc, char **argv, char **envp)
624 is_8xx = mfspr(SPRN_PVR) == PVR_8xx;
626 return test_harness(ptrace_hwbreak, "ptrace-hwbreak");