projects/linux·blob master · refs

1267 lines · 30.2 KiB

1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 *
4 * Copyright (C) 2009, 2010 ARM Limited
5 *
6 * Author: Will Deacon <[email protected]>
7 */
8
9/*
10 * HW_breakpoint: a unified kernel/user-space hardware breakpoint facility,
11 * using the CPU's debug registers.
12 */
13#define pr_fmt(fmt) "hw-breakpoint: " fmt
14
15#include <linux/errno.h>
16#include <linux/hardirq.h>
17#include <linux/perf_event.h>
18#include <linux/hw_breakpoint.h>
19#include <linux/smp.h>
20#include <linux/cfi.h>
21#include <linux/cpu_pm.h>
22#include <linux/coresight.h>
23
24#include <asm/cacheflush.h>
25#include <asm/cputype.h>
26#include <asm/current.h>
27#include <asm/hw_breakpoint.h>
28#include <asm/traps.h>
29
30/* Breakpoint currently in use for each BRP. */
31static DEFINE_PER_CPU(struct perf_event *, bp_on_reg[ARM_MAX_BRP]);
32
33/* Watchpoint currently in use for each WRP. */
34static DEFINE_PER_CPU(struct perf_event *, wp_on_reg[ARM_MAX_WRP]);
35
36/* Number of BRP/WRP registers on this CPU. */
37static int core_num_brps __ro_after_init;
38static int core_num_wrps __ro_after_init;
39
40/* Debug architecture version. */
41static u8 debug_arch __ro_after_init;
42
43/* Does debug architecture support OS Save and Restore? */
44static bool has_ossr __ro_after_init;
45
46/* Maximum supported watchpoint length. */
47static u8 max_watchpoint_len __ro_after_init;
48
49#define READ_WB_REG_CASE(OP2, M, VAL) \
50 case ((OP2 << 4) + M): \
51 ARM_DBG_READ(c0, c ## M, OP2, VAL); \
52 break
53
54#define WRITE_WB_REG_CASE(OP2, M, VAL) \
55 case ((OP2 << 4) + M): \
56 ARM_DBG_WRITE(c0, c ## M, OP2, VAL); \
57 break
58
59#define GEN_READ_WB_REG_CASES(OP2, VAL) \
60 READ_WB_REG_CASE(OP2, 0, VAL); \
61 READ_WB_REG_CASE(OP2, 1, VAL); \
62 READ_WB_REG_CASE(OP2, 2, VAL); \
63 READ_WB_REG_CASE(OP2, 3, VAL); \
64 READ_WB_REG_CASE(OP2, 4, VAL); \
65 READ_WB_REG_CASE(OP2, 5, VAL); \
66 READ_WB_REG_CASE(OP2, 6, VAL); \
67 READ_WB_REG_CASE(OP2, 7, VAL); \
68 READ_WB_REG_CASE(OP2, 8, VAL); \
69 READ_WB_REG_CASE(OP2, 9, VAL); \
70 READ_WB_REG_CASE(OP2, 10, VAL); \
71 READ_WB_REG_CASE(OP2, 11, VAL); \
72 READ_WB_REG_CASE(OP2, 12, VAL); \
73 READ_WB_REG_CASE(OP2, 13, VAL); \
74 READ_WB_REG_CASE(OP2, 14, VAL); \
75 READ_WB_REG_CASE(OP2, 15, VAL)
76
77#define GEN_WRITE_WB_REG_CASES(OP2, VAL) \
78 WRITE_WB_REG_CASE(OP2, 0, VAL); \
79 WRITE_WB_REG_CASE(OP2, 1, VAL); \
80 WRITE_WB_REG_CASE(OP2, 2, VAL); \
81 WRITE_WB_REG_CASE(OP2, 3, VAL); \
82 WRITE_WB_REG_CASE(OP2, 4, VAL); \
83 WRITE_WB_REG_CASE(OP2, 5, VAL); \
84 WRITE_WB_REG_CASE(OP2, 6, VAL); \
85 WRITE_WB_REG_CASE(OP2, 7, VAL); \
86 WRITE_WB_REG_CASE(OP2, 8, VAL); \
87 WRITE_WB_REG_CASE(OP2, 9, VAL); \
88 WRITE_WB_REG_CASE(OP2, 10, VAL); \
89 WRITE_WB_REG_CASE(OP2, 11, VAL); \
90 WRITE_WB_REG_CASE(OP2, 12, VAL); \
91 WRITE_WB_REG_CASE(OP2, 13, VAL); \
92 WRITE_WB_REG_CASE(OP2, 14, VAL); \
93 WRITE_WB_REG_CASE(OP2, 15, VAL)
94
95static u32 read_wb_reg(int n)
96{
97 u32 val = 0;
98
99 switch (n) {
100 GEN_READ_WB_REG_CASES(ARM_OP2_BVR, val);
101 GEN_READ_WB_REG_CASES(ARM_OP2_BCR, val);
102 GEN_READ_WB_REG_CASES(ARM_OP2_WVR, val);
103 GEN_READ_WB_REG_CASES(ARM_OP2_WCR, val);
104 default:
105 pr_warn("attempt to read from unknown breakpoint register %d\n",
106 n);
107 }
108
109 return val;
110}
111
112static void write_wb_reg(int n, u32 val)
113{
114 switch (n) {
115 GEN_WRITE_WB_REG_CASES(ARM_OP2_BVR, val);
116 GEN_WRITE_WB_REG_CASES(ARM_OP2_BCR, val);
117 GEN_WRITE_WB_REG_CASES(ARM_OP2_WVR, val);
118 GEN_WRITE_WB_REG_CASES(ARM_OP2_WCR, val);
119 default:
120 pr_warn("attempt to write to unknown breakpoint register %d\n",
121 n);
122 }
123 isb();
124}
125
126/* Determine debug architecture. */
127static u8 get_debug_arch(void)
128{
129 u32 didr;
130
131 /* Do we implement the extended CPUID interface? */
132 if (((read_cpuid_id() >> 16) & 0xf) != 0xf) {
133 pr_warn_once("CPUID feature registers not supported. "
134 "Assuming v6 debug is present.\n");
135 return ARM_DEBUG_ARCH_V6;
136 }
137
138 ARM_DBG_READ(c0, c0, 0, didr);
139 return (didr >> 16) & 0xf;
140}
141
142u8 arch_get_debug_arch(void)
143{
144 return debug_arch;
145}
146
147static int debug_arch_supported(void)
148{
149 u8 arch = get_debug_arch();
150
151 /* We don't support the memory-mapped interface. */
152 return (arch >= ARM_DEBUG_ARCH_V6 && arch <= ARM_DEBUG_ARCH_V7_ECP14) ||
153 arch >= ARM_DEBUG_ARCH_V7_1;
154}
155
156/* Can we determine the watchpoint access type from the fsr? */
157static int debug_exception_updates_fsr(void)
158{
159 return get_debug_arch() >= ARM_DEBUG_ARCH_V8;
160}
161
162/* Determine number of WRP registers available. */
163static int get_num_wrp_resources(void)
164{
165 u32 didr;
166 ARM_DBG_READ(c0, c0, 0, didr);
167 return ((didr >> 28) & 0xf) + 1;
168}
169
170/* Determine number of BRP registers available. */
171static int get_num_brp_resources(void)
172{
173 u32 didr;
174 ARM_DBG_READ(c0, c0, 0, didr);
175 return ((didr >> 24) & 0xf) + 1;
176}
177
178/* Does this core support mismatch breakpoints? */
179static int core_has_mismatch_brps(void)
180{
181 return (get_debug_arch() >= ARM_DEBUG_ARCH_V7_ECP14 &&
182 get_num_brp_resources() > 1);
183}
184
185/* Determine number of usable WRPs available. */
186static int get_num_wrps(void)
187{
188 /*
189 * On debug architectures prior to 7.1, when a watchpoint fires, the
190 * only way to work out which watchpoint it was is by disassembling
191 * the faulting instruction and working out the address of the memory
192 * access.
193 *
194 * Furthermore, we can only do this if the watchpoint was precise
195 * since imprecise watchpoints prevent us from calculating register
196 * based addresses.
197 *
198 * Providing we have more than 1 breakpoint register, we only report
199 * a single watchpoint register for the time being. This way, we always
200 * know which watchpoint fired. In the future we can either add a
201 * disassembler and address generation emulator, or we can insert a
202 * check to see if the DFAR is set on watchpoint exception entry
203 * [the ARM ARM states that the DFAR is UNKNOWN, but experience shows
204 * that it is set on some implementations].
205 */
206 if (get_debug_arch() < ARM_DEBUG_ARCH_V7_1)
207 return 1;
208
209 return get_num_wrp_resources();
210}
211
212/* Determine number of usable BRPs available. */
213static int get_num_brps(void)
214{
215 int brps = get_num_brp_resources();
216 return core_has_mismatch_brps() ? brps - 1 : brps;
217}
218
219/*
220 * In order to access the breakpoint/watchpoint control registers,
221 * we must be running in debug monitor mode. Unfortunately, we can
222 * be put into halting debug mode at any time by an external debugger
223 * but there is nothing we can do to prevent that.
224 */
225static int monitor_mode_enabled(void)
226{
227 u32 dscr;
228 ARM_DBG_READ(c0, c1, 0, dscr);
229 return !!(dscr & ARM_DSCR_MDBGEN);
230}
231
232static int enable_monitor_mode(void)
233{
234 u32 dscr;
235 ARM_DBG_READ(c0, c1, 0, dscr);
236
237 /* If monitor mode is already enabled, just return. */
238 if (dscr & ARM_DSCR_MDBGEN)
239 goto out;
240
241 /* Write to the corresponding DSCR. */
242 switch (get_debug_arch()) {
243 case ARM_DEBUG_ARCH_V6:
244 case ARM_DEBUG_ARCH_V6_1:
245 ARM_DBG_WRITE(c0, c1, 0, (dscr | ARM_DSCR_MDBGEN));
246 break;
247 case ARM_DEBUG_ARCH_V7_ECP14:
248 case ARM_DEBUG_ARCH_V7_1:
249 case ARM_DEBUG_ARCH_V8:
250 case ARM_DEBUG_ARCH_V8_1:
251 case ARM_DEBUG_ARCH_V8_2:
252 case ARM_DEBUG_ARCH_V8_4:
253 ARM_DBG_WRITE(c0, c2, 2, (dscr | ARM_DSCR_MDBGEN));
254 isb();
255 break;
256 default:
257 return -ENODEV;
258 }
259
260 /* Check that the write made it through. */
261 ARM_DBG_READ(c0, c1, 0, dscr);
262 if (!(dscr & ARM_DSCR_MDBGEN)) {
263 pr_warn_once("Failed to enable monitor mode on CPU %d.\n",
264 smp_processor_id());
265 return -EPERM;
266 }
267
268out:
269 return 0;
270}
271
272int hw_breakpoint_slots(int type)
273{
274 if (!debug_arch_supported())
275 return 0;
276
277 /*
278 * We can be called early, so don't rely on
279 * our static variables being initialised.
280 */
281 switch (type) {
282 case TYPE_INST:
283 return get_num_brps();
284 case TYPE_DATA:
285 return get_num_wrps();
286 default:
287 pr_warn("unknown slot type: %d\n", type);
288 return 0;
289 }
290}
291
292/*
293 * Check if 8-bit byte-address select is available.
294 * This clobbers WRP 0.
295 */
296static u8 get_max_wp_len(void)
297{
298 u32 ctrl_reg;
299 struct arch_hw_breakpoint_ctrl ctrl;
300 u8 size = 4;
301
302 if (debug_arch < ARM_DEBUG_ARCH_V7_ECP14)
303 goto out;
304
305 memset(&ctrl, 0, sizeof(ctrl));
306 ctrl.len = ARM_BREAKPOINT_LEN_8;
307 ctrl_reg = encode_ctrl_reg(ctrl);
308
309 write_wb_reg(ARM_BASE_WVR, 0);
310 write_wb_reg(ARM_BASE_WCR, ctrl_reg);
311 if ((read_wb_reg(ARM_BASE_WCR) & ctrl_reg) == ctrl_reg)
312 size = 8;
313
314out:
315 return size;
316}
317
318u8 arch_get_max_wp_len(void)
319{
320 return max_watchpoint_len;
321}
322
323/*
324 * Install a perf counter breakpoint.
325 */
326int arch_install_hw_breakpoint(struct perf_event *bp)
327{
328 struct arch_hw_breakpoint *info = counter_arch_bp(bp);
329 struct perf_event **slot, **slots;
330 int i, max_slots, ctrl_base, val_base;
331 u32 addr, ctrl;
332
333 addr = info->address;
334 ctrl = encode_ctrl_reg(info->ctrl) | 0x1;
335
336 if (info->ctrl.type == ARM_BREAKPOINT_EXECUTE) {
337 /* Breakpoint */
338 ctrl_base = ARM_BASE_BCR;
339 val_base = ARM_BASE_BVR;
340 slots = this_cpu_ptr(bp_on_reg);
341 max_slots = core_num_brps;
342 } else {
343 /* Watchpoint */
344 ctrl_base = ARM_BASE_WCR;
345 val_base = ARM_BASE_WVR;
346 slots = this_cpu_ptr(wp_on_reg);
347 max_slots = core_num_wrps;
348 }
349
350 for (i = 0; i < max_slots; ++i) {
351 slot = &slots[i];
352
353 if (!*slot) {
354 *slot = bp;
355 break;
356 }
357 }
358
359 if (i == max_slots) {
360 pr_warn("Can't find any breakpoint slot\n");
361 return -EBUSY;
362 }
363
364 /* Override the breakpoint data with the step data. */
365 if (info->step_ctrl.enabled) {
366 addr = info->trigger & ~0x3;
367 ctrl = encode_ctrl_reg(info->step_ctrl);
368 if (info->ctrl.type != ARM_BREAKPOINT_EXECUTE) {
369 i = 0;
370 ctrl_base = ARM_BASE_BCR + core_num_brps;
371 val_base = ARM_BASE_BVR + core_num_brps;
372 }
373 }
374
375 /* Setup the address register. */
376 write_wb_reg(val_base + i, addr);
377
378 /* Setup the control register. */
379 write_wb_reg(ctrl_base + i, ctrl);
380 return 0;
381}
382
383void arch_uninstall_hw_breakpoint(struct perf_event *bp)
384{
385 struct arch_hw_breakpoint *info = counter_arch_bp(bp);
386 struct perf_event **slot, **slots;
387 int i, max_slots, base;
388
389 if (info->ctrl.type == ARM_BREAKPOINT_EXECUTE) {
390 /* Breakpoint */
391 base = ARM_BASE_BCR;
392 slots = this_cpu_ptr(bp_on_reg);
393 max_slots = core_num_brps;
394 } else {
395 /* Watchpoint */
396 base = ARM_BASE_WCR;
397 slots = this_cpu_ptr(wp_on_reg);
398 max_slots = core_num_wrps;
399 }
400
401 /* Remove the breakpoint. */
402 for (i = 0; i < max_slots; ++i) {
403 slot = &slots[i];
404
405 if (*slot == bp) {
406 *slot = NULL;
407 break;
408 }
409 }
410
411 if (i == max_slots) {
412 pr_warn("Can't find any breakpoint slot\n");
413 return;
414 }
415
416 /* Ensure that we disable the mismatch breakpoint. */
417 if (info->ctrl.type != ARM_BREAKPOINT_EXECUTE &&
418 info->step_ctrl.enabled) {
419 i = 0;
420 base = ARM_BASE_BCR + core_num_brps;
421 }
422
423 /* Reset the control register. */
424 write_wb_reg(base + i, 0);
425}
426
427static int get_hbp_len(u8 hbp_len)
428{
429 unsigned int len_in_bytes = 0;
430
431 switch (hbp_len) {
432 case ARM_BREAKPOINT_LEN_1:
433 len_in_bytes = 1;
434 break;
435 case ARM_BREAKPOINT_LEN_2:
436 len_in_bytes = 2;
437 break;
438 case ARM_BREAKPOINT_LEN_4:
439 len_in_bytes = 4;
440 break;
441 case ARM_BREAKPOINT_LEN_8:
442 len_in_bytes = 8;
443 break;
444 }
445
446 return len_in_bytes;
447}
448
449/*
450 * Check whether bp virtual address is in kernel space.
451 */
452int arch_check_bp_in_kernelspace(struct arch_hw_breakpoint *hw)
453{
454 unsigned int len;
455 unsigned long va;
456
457 va = hw->address;
458 len = get_hbp_len(hw->ctrl.len);
459
460 return (va >= TASK_SIZE) && ((va + len - 1) >= TASK_SIZE);
461}
462
463/*
464 * Extract generic type and length encodings from an arch_hw_breakpoint_ctrl.
465 * Hopefully this will disappear when ptrace can bypass the conversion
466 * to generic breakpoint descriptions.
467 */
468int arch_bp_generic_fields(struct arch_hw_breakpoint_ctrl ctrl,
469 int *gen_len, int *gen_type)
470{
471 /* Type */
472 switch (ctrl.type) {
473 case ARM_BREAKPOINT_EXECUTE:
474 *gen_type = HW_BREAKPOINT_X;
475 break;
476 case ARM_BREAKPOINT_LOAD:
477 *gen_type = HW_BREAKPOINT_R;
478 break;
479 case ARM_BREAKPOINT_STORE:
480 *gen_type = HW_BREAKPOINT_W;
481 break;
482 case ARM_BREAKPOINT_LOAD | ARM_BREAKPOINT_STORE:
483 *gen_type = HW_BREAKPOINT_RW;
484 break;
485 default:
486 return -EINVAL;
487 }
488
489 /* Len */
490 switch (ctrl.len) {
491 case ARM_BREAKPOINT_LEN_1:
492 *gen_len = HW_BREAKPOINT_LEN_1;
493 break;
494 case ARM_BREAKPOINT_LEN_2:
495 *gen_len = HW_BREAKPOINT_LEN_2;
496 break;
497 case ARM_BREAKPOINT_LEN_4:
498 *gen_len = HW_BREAKPOINT_LEN_4;
499 break;
500 case ARM_BREAKPOINT_LEN_8:
501 *gen_len = HW_BREAKPOINT_LEN_8;
502 break;
503 default:
504 return -EINVAL;
505 }
506
507 return 0;
508}
509
510/*
511 * Construct an arch_hw_breakpoint from a perf_event.
512 */
513static int arch_build_bp_info(struct perf_event *bp,
514 const struct perf_event_attr *attr,
515 struct arch_hw_breakpoint *hw)
516{
517 /* Type */
518 switch (attr->bp_type) {
519 case HW_BREAKPOINT_X:
520 hw->ctrl.type = ARM_BREAKPOINT_EXECUTE;
521 break;
522 case HW_BREAKPOINT_R:
523 hw->ctrl.type = ARM_BREAKPOINT_LOAD;
524 break;
525 case HW_BREAKPOINT_W:
526 hw->ctrl.type = ARM_BREAKPOINT_STORE;
527 break;
528 case HW_BREAKPOINT_RW:
529 hw->ctrl.type = ARM_BREAKPOINT_LOAD | ARM_BREAKPOINT_STORE;
530 break;
531 default:
532 return -EINVAL;
533 }
534
535 /* Len */
536 switch (attr->bp_len) {
537 case HW_BREAKPOINT_LEN_1:
538 hw->ctrl.len = ARM_BREAKPOINT_LEN_1;
539 break;
540 case HW_BREAKPOINT_LEN_2:
541 hw->ctrl.len = ARM_BREAKPOINT_LEN_2;
542 break;
543 case HW_BREAKPOINT_LEN_4:
544 hw->ctrl.len = ARM_BREAKPOINT_LEN_4;
545 break;
546 case HW_BREAKPOINT_LEN_8:
547 hw->ctrl.len = ARM_BREAKPOINT_LEN_8;
548 if ((hw->ctrl.type != ARM_BREAKPOINT_EXECUTE)
549 && max_watchpoint_len >= 8)
550 break;
551 fallthrough;
552 default:
553 return -EINVAL;
554 }
555
556 /*
557 * Breakpoints must be of length 2 (thumb) or 4 (ARM) bytes.
558 * Watchpoints can be of length 1, 2, 4 or 8 bytes if supported
559 * by the hardware and must be aligned to the appropriate number of
560 * bytes.
561 */
562 if (hw->ctrl.type == ARM_BREAKPOINT_EXECUTE &&
563 hw->ctrl.len != ARM_BREAKPOINT_LEN_2 &&
564 hw->ctrl.len != ARM_BREAKPOINT_LEN_4)
565 return -EINVAL;
566
567 /* Address */
568 hw->address = attr->bp_addr;
569
570 /* Privilege */
571 hw->ctrl.privilege = ARM_BREAKPOINT_USER;
572 if (arch_check_bp_in_kernelspace(hw))
573 hw->ctrl.privilege |= ARM_BREAKPOINT_PRIV;
574
575 /* Enabled? */
576 hw->ctrl.enabled = !attr->disabled;
577
578 /* Mismatch */
579 hw->ctrl.mismatch = 0;
580
581 return 0;
582}
583
584/*
585 * Validate the arch-specific HW Breakpoint register settings.
586 */
587int hw_breakpoint_arch_parse(struct perf_event *bp,
588 const struct perf_event_attr *attr,
589 struct arch_hw_breakpoint *hw)
590{
591 int ret = 0;
592 u32 offset, alignment_mask = 0x3;
593
594 /* Ensure that we are in monitor debug mode. */
595 if (!monitor_mode_enabled())
596 return -ENODEV;
597
598 /* Build the arch_hw_breakpoint. */
599 ret = arch_build_bp_info(bp, attr, hw);
600 if (ret)
601 goto out;
602
603 /* Check address alignment. */
604 if (hw->ctrl.len == ARM_BREAKPOINT_LEN_8)
605 alignment_mask = 0x7;
606 offset = hw->address & alignment_mask;
607 switch (offset) {
608 case 0:
609 /* Aligned */
610 break;
611 case 1:
612 case 2:
613 /* Allow halfword watchpoints and breakpoints. */
614 if (hw->ctrl.len == ARM_BREAKPOINT_LEN_2)
615 break;
616 fallthrough;
617 case 3:
618 /* Allow single byte watchpoint. */
619 if (hw->ctrl.len == ARM_BREAKPOINT_LEN_1)
620 break;
621 fallthrough;
622 default:
623 ret = -EINVAL;
624 goto out;
625 }
626
627 hw->address &= ~alignment_mask;
628 hw->ctrl.len <<= offset;
629
630 if (is_default_overflow_handler(bp)) {
631 /*
632 * Mismatch breakpoints are required for single-stepping
633 * breakpoints.
634 */
635 if (!core_has_mismatch_brps())
636 return -EINVAL;
637
638 /* We don't allow mismatch breakpoints in kernel space. */
639 if (arch_check_bp_in_kernelspace(hw))
640 return -EPERM;
641
642 /*
643 * Per-cpu breakpoints are not supported by our stepping
644 * mechanism.
645 */
646 if (!bp->hw.target)
647 return -EINVAL;
648
649 /*
650 * We only support specific access types if the fsr
651 * reports them.
652 */
653 if (!debug_exception_updates_fsr() &&
654 (hw->ctrl.type == ARM_BREAKPOINT_LOAD ||
655 hw->ctrl.type == ARM_BREAKPOINT_STORE))
656 return -EINVAL;
657 }
658
659out:
660 return ret;
661}
662
663/*
664 * Enable/disable single-stepping over the breakpoint bp at address addr.
665 */
666static void enable_single_step(struct perf_event *bp, u32 addr)
667{
668 struct arch_hw_breakpoint *info = counter_arch_bp(bp);
669
670 arch_uninstall_hw_breakpoint(bp);
671 info->step_ctrl.mismatch = 1;
672 info->step_ctrl.len = ARM_BREAKPOINT_LEN_4;
673 info->step_ctrl.type = ARM_BREAKPOINT_EXECUTE;
674 info->step_ctrl.privilege = info->ctrl.privilege;
675 info->step_ctrl.enabled = 1;
676 info->trigger = addr;
677 arch_install_hw_breakpoint(bp);
678}
679
680static void disable_single_step(struct perf_event *bp)
681{
682 arch_uninstall_hw_breakpoint(bp);
683 counter_arch_bp(bp)->step_ctrl.enabled = 0;
684 arch_install_hw_breakpoint(bp);
685}
686
687/*
688 * Arm32 hardware does not always report a watchpoint hit address that matches
689 * one of the watchpoints set. It can also report an address "near" the
690 * watchpoint if a single instruction access both watched and unwatched
691 * addresses. There is no straight-forward way, short of disassembling the
692 * offending instruction, to map that address back to the watchpoint. This
693 * function computes the distance of the memory access from the watchpoint as a
694 * heuristic for the likelyhood that a given access triggered the watchpoint.
695 *
696 * See this same function in the arm64 platform code, which has the same
697 * problem.
698 *
699 * The function returns the distance of the address from the bytes watched by
700 * the watchpoint. In case of an exact match, it returns 0.
701 */
702static u32 get_distance_from_watchpoint(unsigned long addr, u32 val,
703 struct arch_hw_breakpoint_ctrl *ctrl)
704{
705 u32 wp_low, wp_high;
706 u32 lens, lene;
707
708 lens = __ffs(ctrl->len);
709 lene = __fls(ctrl->len);
710
711 wp_low = val + lens;
712 wp_high = val + lene;
713 if (addr < wp_low)
714 return wp_low - addr;
715 else if (addr > wp_high)
716 return addr - wp_high;
717 else
718 return 0;
719}
720
721static int watchpoint_fault_on_uaccess(struct pt_regs *regs,
722 struct arch_hw_breakpoint *info)
723{
724 return !user_mode(regs) && info->ctrl.privilege == ARM_BREAKPOINT_USER;
725}
726
727static void watchpoint_handler(unsigned long addr, unsigned int fsr,
728 struct pt_regs *regs)
729{
730 int i, access, closest_match = 0;
731 u32 min_dist = -1, dist;
732 u32 val, ctrl_reg;
733 struct perf_event *wp, **slots;
734 struct arch_hw_breakpoint *info;
735 struct arch_hw_breakpoint_ctrl ctrl;
736
737 slots = this_cpu_ptr(wp_on_reg);
738
739 /*
740 * Find all watchpoints that match the reported address. If no exact
741 * match is found. Attribute the hit to the closest watchpoint.
742 */
743 rcu_read_lock();
744 for (i = 0; i < core_num_wrps; ++i) {
745 wp = slots[i];
746 if (wp == NULL)
747 continue;
748
749 /*
750 * The DFAR is an unknown value on debug architectures prior
751 * to 7.1. Since we only allow a single watchpoint on these
752 * older CPUs, we can set the trigger to the lowest possible
753 * faulting address.
754 */
755 if (debug_arch < ARM_DEBUG_ARCH_V7_1) {
756 BUG_ON(i > 0);
757 info = counter_arch_bp(wp);
758 info->trigger = wp->attr.bp_addr;
759 } else {
760 /* Check that the access type matches. */
761 if (debug_exception_updates_fsr()) {
762 access = (fsr & ARM_FSR_ACCESS_MASK) ?
763 HW_BREAKPOINT_W : HW_BREAKPOINT_R;
764 if (!(access & hw_breakpoint_type(wp)))
765 continue;
766 }
767
768 val = read_wb_reg(ARM_BASE_WVR + i);
769 ctrl_reg = read_wb_reg(ARM_BASE_WCR + i);
770 decode_ctrl_reg(ctrl_reg, &ctrl);
771 dist = get_distance_from_watchpoint(addr, val, &ctrl);
772 if (dist < min_dist) {
773 min_dist = dist;
774 closest_match = i;
775 }
776 /* Is this an exact match? */
777 if (dist != 0)
778 continue;
779
780 /* We have a winner. */
781 info = counter_arch_bp(wp);
782 info->trigger = addr;
783 }
784
785 pr_debug("watchpoint fired: address = 0x%x\n", info->trigger);
786
787 /*
788 * If we triggered a user watchpoint from a uaccess routine,
789 * then handle the stepping ourselves since userspace really
790 * can't help us with this.
791 */
792 if (watchpoint_fault_on_uaccess(regs, info))
793 goto step;
794
795 perf_bp_event(wp, regs);
796
797 /*
798 * Defer stepping to the overflow handler if one is installed.
799 * Otherwise, insert a temporary mismatch breakpoint so that
800 * we can single-step over the watchpoint trigger.
801 */
802 if (!is_default_overflow_handler(wp))
803 continue;
804step:
805 enable_single_step(wp, instruction_pointer(regs));
806 }
807
808 if (min_dist > 0 && min_dist != -1) {
809 /* No exact match found. */
810 wp = slots[closest_match];
811 info = counter_arch_bp(wp);
812 info->trigger = addr;
813 pr_debug("watchpoint fired: address = 0x%x\n", info->trigger);
814 perf_bp_event(wp, regs);
815 if (is_default_overflow_handler(wp))
816 enable_single_step(wp, instruction_pointer(regs));
817 }
818
819 rcu_read_unlock();
820}
821
822static void watchpoint_single_step_handler(unsigned long pc)
823{
824 int i;
825 struct perf_event *wp, **slots;
826 struct arch_hw_breakpoint *info;
827
828 slots = this_cpu_ptr(wp_on_reg);
829
830 for (i = 0; i < core_num_wrps; ++i) {
831 rcu_read_lock();
832
833 wp = slots[i];
834
835 if (wp == NULL)
836 goto unlock;
837
838 info = counter_arch_bp(wp);
839 if (!info->step_ctrl.enabled)
840 goto unlock;
841
842 /*
843 * Restore the original watchpoint if we've completed the
844 * single-step.
845 */
846 if (info->trigger != pc)
847 disable_single_step(wp);
848
849unlock:
850 rcu_read_unlock();
851 }
852}
853
854static void breakpoint_handler(unsigned long unknown, struct pt_regs *regs)
855{
856 int i;
857 u32 ctrl_reg, val, addr;
858 struct perf_event *bp, **slots;
859 struct arch_hw_breakpoint *info;
860 struct arch_hw_breakpoint_ctrl ctrl;
861
862 slots = this_cpu_ptr(bp_on_reg);
863
864 /* The exception entry code places the amended lr in the PC. */
865 addr = regs->ARM_pc;
866
867 /* Check the currently installed breakpoints first. */
868 for (i = 0; i < core_num_brps; ++i) {
869 rcu_read_lock();
870
871 bp = slots[i];
872
873 if (bp == NULL)
874 goto unlock;
875
876 info = counter_arch_bp(bp);
877
878 /* Check if the breakpoint value matches. */
879 val = read_wb_reg(ARM_BASE_BVR + i);
880 if (val != (addr & ~0x3))
881 goto mismatch;
882
883 /* Possible match, check the byte address select to confirm. */
884 ctrl_reg = read_wb_reg(ARM_BASE_BCR + i);
885 decode_ctrl_reg(ctrl_reg, &ctrl);
886 if ((1 << (addr & 0x3)) & ctrl.len) {
887 info->trigger = addr;
888 pr_debug("breakpoint fired: address = 0x%x\n", addr);
889 perf_bp_event(bp, regs);
890 if (is_default_overflow_handler(bp))
891 enable_single_step(bp, addr);
892 goto unlock;
893 }
894
895mismatch:
896 /* If we're stepping a breakpoint, it can now be restored. */
897 if (info->step_ctrl.enabled)
898 disable_single_step(bp);
899unlock:
900 rcu_read_unlock();
901 }
902
903 /* Handle any pending watchpoint single-step breakpoints. */
904 watchpoint_single_step_handler(addr);
905}
906
907#ifdef CONFIG_CFI
908static void hw_breakpoint_cfi_handler(struct pt_regs *regs)
909{
910 /*
911 * TODO: implementing target and type to pass to CFI using the more
912 * elaborate report_cfi_failure() requires compiler work. To be able
913 * to properly extract target information the compiler needs to
914 * emit a stable instructions sequence for the CFI checks so we can
915 * decode the instructions preceding the trap and figure out which
916 * registers were used.
917 */
918
919 switch (report_cfi_failure_noaddr(regs, instruction_pointer(regs))) {
920 case BUG_TRAP_TYPE_BUG:
921 die("Oops - CFI", regs, 0);
922 break;
923 case BUG_TRAP_TYPE_WARN:
924 /* Skip the breaking instruction */
925 instruction_pointer(regs) += 4;
926 break;
927 default:
928 die("Unknown CFI error", regs, 0);
929 break;
930 }
931}
932#endif
933
934/*
935 * Called from either the Data Abort Handler [watchpoint] or the
936 * Prefetch Abort Handler [breakpoint] with interrupts disabled.
937 */
938static int hw_breakpoint_pending(unsigned long addr, unsigned int fsr,
939 struct pt_regs *regs)
940{
941 int ret = 0;
942 u32 dscr;
943
944 preempt_disable();
945
946 if (interrupts_enabled(regs))
947 local_irq_enable();
948
949 /* We only handle watchpoints and hardware breakpoints. */
950 ARM_DBG_READ(c0, c1, 0, dscr);
951
952 /* Perform perf callbacks. */
953 switch (ARM_DSCR_MOE(dscr)) {
954 case ARM_ENTRY_BREAKPOINT:
955 breakpoint_handler(addr, regs);
956 break;
957 case ARM_ENTRY_ASYNC_WATCHPOINT:
958 WARN(1, "Asynchronous watchpoint exception taken. Debugging results may be unreliable\n");
959 fallthrough;
960 case ARM_ENTRY_SYNC_WATCHPOINT:
961 watchpoint_handler(addr, fsr, regs);
962 break;
963#ifdef CONFIG_CFI
964 case ARM_ENTRY_CFI_BREAKPOINT:
965 if (user_mode(regs))
966 ret = 1; /* Don't handle userspace BKPT */
967 else
968 hw_breakpoint_cfi_handler(regs);
969 break;
970#endif
971 default:
972 ret = 1; /* Unhandled fault. */
973 }
974
975 preempt_enable();
976
977 return ret;
978}
979
980#ifdef CONFIG_ARM_ERRATA_764319
981static int oslsr_fault;
982
983static int debug_oslsr_trap(struct pt_regs *regs, unsigned int instr)
984{
985 oslsr_fault = 1;
986 instruction_pointer(regs) += 4;
987 return 0;
988}
989
990static struct undef_hook debug_oslsr_hook = {
991 .instr_mask = 0xffffffff,
992 .instr_val = 0xee115e91,
993 .fn = debug_oslsr_trap,
994};
995#endif
996
997/*
998 * One-time initialisation.
999 */
1000static cpumask_t debug_err_mask;
1001
1002static int debug_reg_trap(struct pt_regs *regs, unsigned int instr)
1003{
1004 int cpu = smp_processor_id();
1005
1006 pr_warn("Debug register access (0x%x) caused undefined instruction on CPU %d\n",
1007 instr, cpu);
1008
1009 /* Set the error flag for this CPU and skip the faulting instruction. */
1010 cpumask_set_cpu(cpu, &debug_err_mask);
1011 instruction_pointer(regs) += 4;
1012 return 0;
1013}
1014
1015static struct undef_hook debug_reg_hook = {
1016 .instr_mask = 0x0fe80f10,
1017 .instr_val = 0x0e000e10,
1018 .fn = debug_reg_trap,
1019};
1020
1021/* Does this core support OS Save and Restore? */
1022static bool core_has_os_save_restore(void)
1023{
1024 u32 oslsr;
1025
1026 switch (get_debug_arch()) {
1027 case ARM_DEBUG_ARCH_V7_1:
1028 return true;
1029 case ARM_DEBUG_ARCH_V7_ECP14:
1030#ifdef CONFIG_ARM_ERRATA_764319
1031 oslsr_fault = 0;
1032 register_undef_hook(&debug_oslsr_hook);
1033 ARM_DBG_READ(c1, c1, 4, oslsr);
1034 unregister_undef_hook(&debug_oslsr_hook);
1035 if (oslsr_fault)
1036 return false;
1037#else
1038 ARM_DBG_READ(c1, c1, 4, oslsr);
1039#endif
1040 if (oslsr & ARM_OSLSR_OSLM0)
1041 return true;
1042 fallthrough;
1043 default:
1044 return false;
1045 }
1046}
1047
1048static void reset_ctrl_regs(unsigned int cpu)
1049{
1050 int i, raw_num_brps, err = 0;
1051 u32 val;
1052
1053 /*
1054 * v7 debug contains save and restore registers so that debug state
1055 * can be maintained across low-power modes without leaving the debug
1056 * logic powered up. It is IMPLEMENTATION DEFINED whether we can access
1057 * the debug registers out of reset, so we must unlock the OS Lock
1058 * Access Register to avoid taking undefined instruction exceptions
1059 * later on.
1060 */
1061 switch (debug_arch) {
1062 case ARM_DEBUG_ARCH_V6:
1063 case ARM_DEBUG_ARCH_V6_1:
1064 /* ARMv6 cores clear the registers out of reset. */
1065 goto out_mdbgen;
1066 case ARM_DEBUG_ARCH_V7_ECP14:
1067 /*
1068 * Ensure sticky power-down is clear (i.e. debug logic is
1069 * powered up).
1070 */
1071 ARM_DBG_READ(c1, c5, 4, val);
1072 if ((val & 0x1) == 0)
1073 err = -EPERM;
1074
1075 if (!has_ossr)
1076 goto clear_vcr;
1077 break;
1078 case ARM_DEBUG_ARCH_V7_1:
1079 /*
1080 * Ensure the OS double lock is clear.
1081 */
1082 ARM_DBG_READ(c1, c3, 4, val);
1083 if ((val & 0x1) == 1)
1084 err = -EPERM;
1085 break;
1086 }
1087
1088 if (err) {
1089 pr_warn_once("CPU %d debug is powered down!\n", cpu);
1090 cpumask_or(&debug_err_mask, &debug_err_mask, cpumask_of(cpu));
1091 return;
1092 }
1093
1094 /*
1095 * Unconditionally clear the OS lock by writing a value
1096 * other than CS_LAR_KEY to the access register.
1097 */
1098 ARM_DBG_WRITE(c1, c0, 4, ~CORESIGHT_UNLOCK);
1099 isb();
1100
1101 /*
1102 * Clear any configured vector-catch events before
1103 * enabling monitor mode.
1104 */
1105clear_vcr:
1106 ARM_DBG_WRITE(c0, c7, 0, 0);
1107 isb();
1108
1109 if (cpumask_intersects(&debug_err_mask, cpumask_of(cpu))) {
1110 pr_warn_once("CPU %d failed to disable vector catch\n", cpu);
1111 return;
1112 }
1113
1114 /*
1115 * The control/value register pairs are UNKNOWN out of reset so
1116 * clear them to avoid spurious debug events.
1117 */
1118 raw_num_brps = get_num_brp_resources();
1119 for (i = 0; i < raw_num_brps; ++i) {
1120 write_wb_reg(ARM_BASE_BCR + i, 0UL);
1121 write_wb_reg(ARM_BASE_BVR + i, 0UL);
1122 }
1123
1124 for (i = 0; i < core_num_wrps; ++i) {
1125 write_wb_reg(ARM_BASE_WCR + i, 0UL);
1126 write_wb_reg(ARM_BASE_WVR + i, 0UL);
1127 }
1128
1129 if (cpumask_intersects(&debug_err_mask, cpumask_of(cpu))) {
1130 pr_warn_once("CPU %d failed to clear debug register pairs\n", cpu);
1131 return;
1132 }
1133
1134 /*
1135 * Have a crack at enabling monitor mode. We don't actually need
1136 * it yet, but reporting an error early is useful if it fails.
1137 */
1138out_mdbgen:
1139 if (enable_monitor_mode())
1140 cpumask_or(&debug_err_mask, &debug_err_mask, cpumask_of(cpu));
1141}
1142
1143static int dbg_reset_online(unsigned int cpu)
1144{
1145 local_irq_disable();
1146 reset_ctrl_regs(cpu);
1147 local_irq_enable();
1148 return 0;
1149}
1150
1151#ifdef CONFIG_CPU_PM
1152static int dbg_cpu_pm_notify(struct notifier_block *self, unsigned long action,
1153 void *v)
1154{
1155 if (action == CPU_PM_EXIT)
1156 reset_ctrl_regs(smp_processor_id());
1157
1158 return NOTIFY_OK;
1159}
1160
1161static struct notifier_block dbg_cpu_pm_nb = {
1162 .notifier_call = dbg_cpu_pm_notify,
1163};
1164
1165static void __init pm_init(void)
1166{
1167 cpu_pm_register_notifier(&dbg_cpu_pm_nb);
1168}
1169#else
1170static inline void pm_init(void)
1171{
1172}
1173#endif
1174
1175static int __init arch_hw_breakpoint_init(void)
1176{
1177 int ret;
1178
1179 debug_arch = get_debug_arch();
1180
1181 if (!debug_arch_supported()) {
1182 pr_info("debug architecture 0x%x unsupported.\n", debug_arch);
1183 return 0;
1184 }
1185
1186 /*
1187 * Scorpion CPUs (at least those in APQ8060) seem to set DBGPRSR.SPD
1188 * whenever a WFI is issued, even if the core is not powered down, in
1189 * violation of the architecture. When DBGPRSR.SPD is set, accesses to
1190 * breakpoint and watchpoint registers are treated as undefined, so
1191 * this results in boot time and runtime failures when these are
1192 * accessed and we unexpectedly take a trap.
1193 *
1194 * It's not clear if/how this can be worked around, so we blacklist
1195 * Scorpion CPUs to avoid these issues.
1196 */
1197 if (read_cpuid_part() == ARM_CPU_PART_SCORPION) {
1198 pr_info("Scorpion CPU detected. Hardware breakpoints and watchpoints disabled\n");
1199 return 0;
1200 }
1201
1202 has_ossr = core_has_os_save_restore();
1203
1204 /* Determine how many BRPs/WRPs are available. */
1205 core_num_brps = get_num_brps();
1206 core_num_wrps = get_num_wrps();
1207
1208 /*
1209 * We need to tread carefully here because DBGSWENABLE may be
1210 * driven low on this core and there isn't an architected way to
1211 * determine that.
1212 */
1213 cpus_read_lock();
1214 register_undef_hook(&debug_reg_hook);
1215
1216 /*
1217 * Register CPU notifier which resets the breakpoint resources. We
1218 * assume that a halting debugger will leave the world in a nice state
1219 * for us.
1220 */
1221 ret = cpuhp_setup_state_cpuslocked(CPUHP_AP_ONLINE_DYN,
1222 "arm/hw_breakpoint:online",
1223 dbg_reset_online, NULL);
1224 unregister_undef_hook(&debug_reg_hook);
1225 if (WARN_ON(ret < 0) || !cpumask_empty(&debug_err_mask)) {
1226 core_num_brps = 0;
1227 core_num_wrps = 0;
1228 if (ret > 0)
1229 cpuhp_remove_state_nocalls_cpuslocked(ret);
1230 cpus_read_unlock();
1231 return 0;
1232 }
1233
1234 pr_info("found %d " "%s" "breakpoint and %d watchpoint registers.\n",
1235 core_num_brps, core_has_mismatch_brps() ? "(+1 reserved) " :
1236 "", core_num_wrps);
1237
1238 /* Work out the maximum supported watchpoint length. */
1239 max_watchpoint_len = get_max_wp_len();
1240 pr_info("maximum watchpoint size is %u bytes.\n",
1241 max_watchpoint_len);
1242
1243 /* Register debug fault handler. */
1244 hook_fault_code(FAULT_CODE_DEBUG, hw_breakpoint_pending, SIGTRAP,
1245 TRAP_HWBKPT, "watchpoint debug exception");
1246 hook_ifault_code(FAULT_CODE_DEBUG, hw_breakpoint_pending, SIGTRAP,
1247 TRAP_HWBKPT, "breakpoint debug exception");
1248 cpus_read_unlock();
1249
1250 /* Register PM notifiers. */
1251 pm_init();
1252 return 0;
1253}
1254arch_initcall(arch_hw_breakpoint_init);
1255
1256void hw_breakpoint_pmu_read(struct perf_event *bp)
1257{
1258}
1259
1260/*
1261 * Dummy function to register with die_notifier.
1262 */
1263int hw_breakpoint_exceptions_notify(struct notifier_block *unused,
1264 unsigned long val, void *data)
1265{
1266 return NOTIFY_DONE;
1267}