blob: 46465d9fbc4d9c170ae4d980ae42957969923d4c [file] [log] [blame]
Will Deacon478fcb22012-03-05 11:49:33 +00001/*
2 * HW_breakpoint: a unified kernel/user-space hardware breakpoint facility,
3 * using the CPU's debug registers.
4 *
5 * Copyright (C) 2012 ARM Limited
6 * Author: Will Deacon <will.deacon@arm.com>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
21#define pr_fmt(fmt) "hw-breakpoint: " fmt
22
AKASHI Takahirofd92d4a2014-04-30 10:51:32 +010023#include <linux/compat.h>
Lorenzo Pieralisi60fc6942013-08-05 15:20:35 +010024#include <linux/cpu_pm.h>
Will Deacon478fcb22012-03-05 11:49:33 +000025#include <linux/errno.h>
26#include <linux/hw_breakpoint.h>
27#include <linux/perf_event.h>
28#include <linux/ptrace.h>
29#include <linux/smp.h>
30
Will Deacon478fcb22012-03-05 11:49:33 +000031#include <asm/current.h>
32#include <asm/debug-monitors.h>
33#include <asm/hw_breakpoint.h>
Will Deacon478fcb22012-03-05 11:49:33 +000034#include <asm/traps.h>
35#include <asm/cputype.h>
36#include <asm/system_misc.h>
37
38/* Breakpoint currently in use for each BRP. */
39static DEFINE_PER_CPU(struct perf_event *, bp_on_reg[ARM_MAX_BRP]);
40
41/* Watchpoint currently in use for each WRP. */
42static DEFINE_PER_CPU(struct perf_event *, wp_on_reg[ARM_MAX_WRP]);
43
44/* Currently stepping a per-CPU kernel breakpoint. */
45static DEFINE_PER_CPU(int, stepping_kernel_bp);
46
47/* Number of BRP/WRP registers on this CPU. */
48static int core_num_brps;
49static int core_num_wrps;
50
Will Deacon478fcb22012-03-05 11:49:33 +000051int hw_breakpoint_slots(int type)
52{
53 /*
54 * We can be called early, so don't rely on
55 * our static variables being initialised.
56 */
57 switch (type) {
58 case TYPE_INST:
59 return get_num_brps();
60 case TYPE_DATA:
61 return get_num_wrps();
62 default:
63 pr_warning("unknown slot type: %d\n", type);
64 return 0;
65 }
66}
67
68#define READ_WB_REG_CASE(OFF, N, REG, VAL) \
69 case (OFF + N): \
70 AARCH64_DBG_READ(N, REG, VAL); \
71 break
72
73#define WRITE_WB_REG_CASE(OFF, N, REG, VAL) \
74 case (OFF + N): \
75 AARCH64_DBG_WRITE(N, REG, VAL); \
76 break
77
78#define GEN_READ_WB_REG_CASES(OFF, REG, VAL) \
79 READ_WB_REG_CASE(OFF, 0, REG, VAL); \
80 READ_WB_REG_CASE(OFF, 1, REG, VAL); \
81 READ_WB_REG_CASE(OFF, 2, REG, VAL); \
82 READ_WB_REG_CASE(OFF, 3, REG, VAL); \
83 READ_WB_REG_CASE(OFF, 4, REG, VAL); \
84 READ_WB_REG_CASE(OFF, 5, REG, VAL); \
85 READ_WB_REG_CASE(OFF, 6, REG, VAL); \
86 READ_WB_REG_CASE(OFF, 7, REG, VAL); \
87 READ_WB_REG_CASE(OFF, 8, REG, VAL); \
88 READ_WB_REG_CASE(OFF, 9, REG, VAL); \
89 READ_WB_REG_CASE(OFF, 10, REG, VAL); \
90 READ_WB_REG_CASE(OFF, 11, REG, VAL); \
91 READ_WB_REG_CASE(OFF, 12, REG, VAL); \
92 READ_WB_REG_CASE(OFF, 13, REG, VAL); \
93 READ_WB_REG_CASE(OFF, 14, REG, VAL); \
94 READ_WB_REG_CASE(OFF, 15, REG, VAL)
95
96#define GEN_WRITE_WB_REG_CASES(OFF, REG, VAL) \
97 WRITE_WB_REG_CASE(OFF, 0, REG, VAL); \
98 WRITE_WB_REG_CASE(OFF, 1, REG, VAL); \
99 WRITE_WB_REG_CASE(OFF, 2, REG, VAL); \
100 WRITE_WB_REG_CASE(OFF, 3, REG, VAL); \
101 WRITE_WB_REG_CASE(OFF, 4, REG, VAL); \
102 WRITE_WB_REG_CASE(OFF, 5, REG, VAL); \
103 WRITE_WB_REG_CASE(OFF, 6, REG, VAL); \
104 WRITE_WB_REG_CASE(OFF, 7, REG, VAL); \
105 WRITE_WB_REG_CASE(OFF, 8, REG, VAL); \
106 WRITE_WB_REG_CASE(OFF, 9, REG, VAL); \
107 WRITE_WB_REG_CASE(OFF, 10, REG, VAL); \
108 WRITE_WB_REG_CASE(OFF, 11, REG, VAL); \
109 WRITE_WB_REG_CASE(OFF, 12, REG, VAL); \
110 WRITE_WB_REG_CASE(OFF, 13, REG, VAL); \
111 WRITE_WB_REG_CASE(OFF, 14, REG, VAL); \
112 WRITE_WB_REG_CASE(OFF, 15, REG, VAL)
113
114static u64 read_wb_reg(int reg, int n)
115{
116 u64 val = 0;
117
118 switch (reg + n) {
119 GEN_READ_WB_REG_CASES(AARCH64_DBG_REG_BVR, AARCH64_DBG_REG_NAME_BVR, val);
120 GEN_READ_WB_REG_CASES(AARCH64_DBG_REG_BCR, AARCH64_DBG_REG_NAME_BCR, val);
121 GEN_READ_WB_REG_CASES(AARCH64_DBG_REG_WVR, AARCH64_DBG_REG_NAME_WVR, val);
122 GEN_READ_WB_REG_CASES(AARCH64_DBG_REG_WCR, AARCH64_DBG_REG_NAME_WCR, val);
123 default:
124 pr_warning("attempt to read from unknown breakpoint register %d\n", n);
125 }
126
127 return val;
128}
129
130static void write_wb_reg(int reg, int n, u64 val)
131{
132 switch (reg + n) {
133 GEN_WRITE_WB_REG_CASES(AARCH64_DBG_REG_BVR, AARCH64_DBG_REG_NAME_BVR, val);
134 GEN_WRITE_WB_REG_CASES(AARCH64_DBG_REG_BCR, AARCH64_DBG_REG_NAME_BCR, val);
135 GEN_WRITE_WB_REG_CASES(AARCH64_DBG_REG_WVR, AARCH64_DBG_REG_NAME_WVR, val);
136 GEN_WRITE_WB_REG_CASES(AARCH64_DBG_REG_WCR, AARCH64_DBG_REG_NAME_WCR, val);
137 default:
138 pr_warning("attempt to write to unknown breakpoint register %d\n", n);
139 }
140 isb();
141}
142
143/*
144 * Convert a breakpoint privilege level to the corresponding exception
145 * level.
146 */
Will Deacon6f883d12015-07-27 18:36:54 +0100147static enum dbg_active_el debug_exception_level(int privilege)
Will Deacon478fcb22012-03-05 11:49:33 +0000148{
149 switch (privilege) {
150 case AARCH64_BREAKPOINT_EL0:
151 return DBG_ACTIVE_EL0;
152 case AARCH64_BREAKPOINT_EL1:
153 return DBG_ACTIVE_EL1;
154 default:
155 pr_warning("invalid breakpoint privilege level %d\n", privilege);
156 return -EINVAL;
157 }
158}
159
Lorenzo Pieralisi2f043042013-08-13 10:45:19 +0100160enum hw_breakpoint_ops {
161 HW_BREAKPOINT_INSTALL,
Lorenzo Pieralisi60fc6942013-08-05 15:20:35 +0100162 HW_BREAKPOINT_UNINSTALL,
163 HW_BREAKPOINT_RESTORE
Lorenzo Pieralisi2f043042013-08-13 10:45:19 +0100164};
165
Will Deacon8f48c062015-10-07 11:37:36 +0100166static int is_compat_bp(struct perf_event *bp)
167{
168 struct task_struct *tsk = bp->hw.target;
169
170 /*
171 * tsk can be NULL for per-cpu (non-ptrace) breakpoints.
172 * In this case, use the native interface, since we don't have
173 * the notion of a "compat CPU" and could end up relying on
174 * deprecated behaviour if we use unaligned watchpoints in
175 * AArch64 state.
176 */
177 return tsk && is_compat_thread(task_thread_info(tsk));
178}
179
Lorenzo Pieralisi2f043042013-08-13 10:45:19 +0100180/**
181 * hw_breakpoint_slot_setup - Find and setup a perf slot according to
182 * operations
183 *
184 * @slots: pointer to array of slots
185 * @max_slots: max number of slots
186 * @bp: perf_event to setup
187 * @ops: operation to be carried out on the slot
188 *
189 * Return:
190 * slot index on success
191 * -ENOSPC if no slot is available/matches
192 * -EINVAL on wrong operations parameter
Will Deacon478fcb22012-03-05 11:49:33 +0000193 */
Lorenzo Pieralisi2f043042013-08-13 10:45:19 +0100194static int hw_breakpoint_slot_setup(struct perf_event **slots, int max_slots,
195 struct perf_event *bp,
196 enum hw_breakpoint_ops ops)
197{
198 int i;
199 struct perf_event **slot;
200
201 for (i = 0; i < max_slots; ++i) {
202 slot = &slots[i];
203 switch (ops) {
204 case HW_BREAKPOINT_INSTALL:
205 if (!*slot) {
206 *slot = bp;
207 return i;
208 }
209 break;
210 case HW_BREAKPOINT_UNINSTALL:
211 if (*slot == bp) {
212 *slot = NULL;
213 return i;
214 }
215 break;
Lorenzo Pieralisi60fc6942013-08-05 15:20:35 +0100216 case HW_BREAKPOINT_RESTORE:
217 if (*slot == bp)
218 return i;
219 break;
Lorenzo Pieralisi2f043042013-08-13 10:45:19 +0100220 default:
221 pr_warn_once("Unhandled hw breakpoint ops %d\n", ops);
222 return -EINVAL;
223 }
224 }
225 return -ENOSPC;
226}
227
228static int hw_breakpoint_control(struct perf_event *bp,
229 enum hw_breakpoint_ops ops)
Will Deacon478fcb22012-03-05 11:49:33 +0000230{
231 struct arch_hw_breakpoint *info = counter_arch_bp(bp);
Lorenzo Pieralisi2f043042013-08-13 10:45:19 +0100232 struct perf_event **slots;
Will Deacon478fcb22012-03-05 11:49:33 +0000233 struct debug_info *debug_info = &current->thread.debug;
234 int i, max_slots, ctrl_reg, val_reg, reg_enable;
Will Deacon6f883d12015-07-27 18:36:54 +0100235 enum dbg_active_el dbg_el = debug_exception_level(info->ctrl.privilege);
Will Deacon478fcb22012-03-05 11:49:33 +0000236 u32 ctrl;
237
238 if (info->ctrl.type == ARM_BREAKPOINT_EXECUTE) {
239 /* Breakpoint */
240 ctrl_reg = AARCH64_DBG_REG_BCR;
241 val_reg = AARCH64_DBG_REG_BVR;
Christoph Lameter1436c1a2013-10-21 13:17:08 +0100242 slots = this_cpu_ptr(bp_on_reg);
Will Deacon478fcb22012-03-05 11:49:33 +0000243 max_slots = core_num_brps;
244 reg_enable = !debug_info->bps_disabled;
245 } else {
246 /* Watchpoint */
247 ctrl_reg = AARCH64_DBG_REG_WCR;
248 val_reg = AARCH64_DBG_REG_WVR;
Christoph Lameter1436c1a2013-10-21 13:17:08 +0100249 slots = this_cpu_ptr(wp_on_reg);
Will Deacon478fcb22012-03-05 11:49:33 +0000250 max_slots = core_num_wrps;
251 reg_enable = !debug_info->wps_disabled;
252 }
253
Lorenzo Pieralisi2f043042013-08-13 10:45:19 +0100254 i = hw_breakpoint_slot_setup(slots, max_slots, bp, ops);
Will Deacon478fcb22012-03-05 11:49:33 +0000255
Lorenzo Pieralisi2f043042013-08-13 10:45:19 +0100256 if (WARN_ONCE(i < 0, "Can't find any breakpoint slot"))
257 return i;
258
259 switch (ops) {
260 case HW_BREAKPOINT_INSTALL:
261 /*
262 * Ensure debug monitors are enabled at the correct exception
263 * level.
264 */
265 enable_debug_monitors(dbg_el);
Lorenzo Pieralisi60fc6942013-08-05 15:20:35 +0100266 /* Fall through */
267 case HW_BREAKPOINT_RESTORE:
Lorenzo Pieralisi2f043042013-08-13 10:45:19 +0100268 /* Setup the address register. */
269 write_wb_reg(val_reg, i, info->address);
270
271 /* Setup the control register. */
272 ctrl = encode_ctrl_reg(info->ctrl);
273 write_wb_reg(ctrl_reg, i,
274 reg_enable ? ctrl | 0x1 : ctrl & ~0x1);
275 break;
276 case HW_BREAKPOINT_UNINSTALL:
277 /* Reset the control register. */
278 write_wb_reg(ctrl_reg, i, 0);
279
280 /*
281 * Release the debug monitors for the correct exception
282 * level.
283 */
284 disable_debug_monitors(dbg_el);
285 break;
Will Deacon478fcb22012-03-05 11:49:33 +0000286 }
287
Will Deacon478fcb22012-03-05 11:49:33 +0000288 return 0;
289}
290
Lorenzo Pieralisi2f043042013-08-13 10:45:19 +0100291/*
292 * Install a perf counter breakpoint.
293 */
294int arch_install_hw_breakpoint(struct perf_event *bp)
295{
296 return hw_breakpoint_control(bp, HW_BREAKPOINT_INSTALL);
297}
298
Will Deacon478fcb22012-03-05 11:49:33 +0000299void arch_uninstall_hw_breakpoint(struct perf_event *bp)
300{
Lorenzo Pieralisi2f043042013-08-13 10:45:19 +0100301 hw_breakpoint_control(bp, HW_BREAKPOINT_UNINSTALL);
Will Deacon478fcb22012-03-05 11:49:33 +0000302}
303
304static int get_hbp_len(u8 hbp_len)
305{
306 unsigned int len_in_bytes = 0;
307
308 switch (hbp_len) {
309 case ARM_BREAKPOINT_LEN_1:
310 len_in_bytes = 1;
311 break;
312 case ARM_BREAKPOINT_LEN_2:
313 len_in_bytes = 2;
314 break;
315 case ARM_BREAKPOINT_LEN_4:
316 len_in_bytes = 4;
317 break;
318 case ARM_BREAKPOINT_LEN_8:
319 len_in_bytes = 8;
320 break;
321 }
322
323 return len_in_bytes;
324}
325
326/*
327 * Check whether bp virtual address is in kernel space.
328 */
329int arch_check_bp_in_kernelspace(struct perf_event *bp)
330{
331 unsigned int len;
332 unsigned long va;
333 struct arch_hw_breakpoint *info = counter_arch_bp(bp);
334
335 va = info->address;
336 len = get_hbp_len(info->ctrl.len);
337
338 return (va >= TASK_SIZE) && ((va + len - 1) >= TASK_SIZE);
339}
340
341/*
342 * Extract generic type and length encodings from an arch_hw_breakpoint_ctrl.
343 * Hopefully this will disappear when ptrace can bypass the conversion
344 * to generic breakpoint descriptions.
345 */
346int arch_bp_generic_fields(struct arch_hw_breakpoint_ctrl ctrl,
347 int *gen_len, int *gen_type)
348{
349 /* Type */
350 switch (ctrl.type) {
351 case ARM_BREAKPOINT_EXECUTE:
352 *gen_type = HW_BREAKPOINT_X;
353 break;
354 case ARM_BREAKPOINT_LOAD:
355 *gen_type = HW_BREAKPOINT_R;
356 break;
357 case ARM_BREAKPOINT_STORE:
358 *gen_type = HW_BREAKPOINT_W;
359 break;
360 case ARM_BREAKPOINT_LOAD | ARM_BREAKPOINT_STORE:
361 *gen_type = HW_BREAKPOINT_RW;
362 break;
363 default:
364 return -EINVAL;
365 }
366
367 /* Len */
368 switch (ctrl.len) {
369 case ARM_BREAKPOINT_LEN_1:
370 *gen_len = HW_BREAKPOINT_LEN_1;
371 break;
372 case ARM_BREAKPOINT_LEN_2:
373 *gen_len = HW_BREAKPOINT_LEN_2;
374 break;
375 case ARM_BREAKPOINT_LEN_4:
376 *gen_len = HW_BREAKPOINT_LEN_4;
377 break;
378 case ARM_BREAKPOINT_LEN_8:
379 *gen_len = HW_BREAKPOINT_LEN_8;
380 break;
381 default:
382 return -EINVAL;
383 }
384
385 return 0;
386}
387
388/*
389 * Construct an arch_hw_breakpoint from a perf_event.
390 */
391static int arch_build_bp_info(struct perf_event *bp)
392{
393 struct arch_hw_breakpoint *info = counter_arch_bp(bp);
394
395 /* Type */
396 switch (bp->attr.bp_type) {
397 case HW_BREAKPOINT_X:
398 info->ctrl.type = ARM_BREAKPOINT_EXECUTE;
399 break;
400 case HW_BREAKPOINT_R:
401 info->ctrl.type = ARM_BREAKPOINT_LOAD;
402 break;
403 case HW_BREAKPOINT_W:
404 info->ctrl.type = ARM_BREAKPOINT_STORE;
405 break;
406 case HW_BREAKPOINT_RW:
407 info->ctrl.type = ARM_BREAKPOINT_LOAD | ARM_BREAKPOINT_STORE;
408 break;
409 default:
410 return -EINVAL;
411 }
412
413 /* Len */
414 switch (bp->attr.bp_len) {
415 case HW_BREAKPOINT_LEN_1:
416 info->ctrl.len = ARM_BREAKPOINT_LEN_1;
417 break;
418 case HW_BREAKPOINT_LEN_2:
419 info->ctrl.len = ARM_BREAKPOINT_LEN_2;
420 break;
421 case HW_BREAKPOINT_LEN_4:
422 info->ctrl.len = ARM_BREAKPOINT_LEN_4;
423 break;
424 case HW_BREAKPOINT_LEN_8:
425 info->ctrl.len = ARM_BREAKPOINT_LEN_8;
426 break;
427 default:
428 return -EINVAL;
429 }
430
431 /*
432 * On AArch64, we only permit breakpoints of length 4, whereas
433 * AArch32 also requires breakpoints of length 2 for Thumb.
434 * Watchpoints can be of length 1, 2, 4 or 8 bytes.
435 */
436 if (info->ctrl.type == ARM_BREAKPOINT_EXECUTE) {
Will Deacon8f48c062015-10-07 11:37:36 +0100437 if (is_compat_bp(bp)) {
Will Deacon478fcb22012-03-05 11:49:33 +0000438 if (info->ctrl.len != ARM_BREAKPOINT_LEN_2 &&
439 info->ctrl.len != ARM_BREAKPOINT_LEN_4)
440 return -EINVAL;
441 } else if (info->ctrl.len != ARM_BREAKPOINT_LEN_4) {
442 /*
443 * FIXME: Some tools (I'm looking at you perf) assume
444 * that breakpoints should be sizeof(long). This
445 * is nonsense. For now, we fix up the parameter
446 * but we should probably return -EINVAL instead.
447 */
448 info->ctrl.len = ARM_BREAKPOINT_LEN_4;
449 }
450 }
451
452 /* Address */
453 info->address = bp->attr.bp_addr;
454
455 /*
456 * Privilege
457 * Note that we disallow combined EL0/EL1 breakpoints because
458 * that would complicate the stepping code.
459 */
460 if (arch_check_bp_in_kernelspace(bp))
461 info->ctrl.privilege = AARCH64_BREAKPOINT_EL1;
462 else
463 info->ctrl.privilege = AARCH64_BREAKPOINT_EL0;
464
465 /* Enabled? */
466 info->ctrl.enabled = !bp->attr.disabled;
467
468 return 0;
469}
470
471/*
472 * Validate the arch-specific HW Breakpoint register settings.
473 */
474int arch_validate_hwbkpt_settings(struct perf_event *bp)
475{
476 struct arch_hw_breakpoint *info = counter_arch_bp(bp);
477 int ret;
478 u64 alignment_mask, offset;
479
480 /* Build the arch_hw_breakpoint. */
481 ret = arch_build_bp_info(bp);
482 if (ret)
483 return ret;
484
485 /*
486 * Check address alignment.
487 * We don't do any clever alignment correction for watchpoints
488 * because using 64-bit unaligned addresses is deprecated for
489 * AArch64.
490 *
491 * AArch32 tasks expect some simple alignment fixups, so emulate
492 * that here.
493 */
Will Deacon8f48c062015-10-07 11:37:36 +0100494 if (is_compat_bp(bp)) {
Will Deacon478fcb22012-03-05 11:49:33 +0000495 if (info->ctrl.len == ARM_BREAKPOINT_LEN_8)
496 alignment_mask = 0x7;
497 else
498 alignment_mask = 0x3;
499 offset = info->address & alignment_mask;
500 switch (offset) {
501 case 0:
502 /* Aligned */
503 break;
504 case 1:
505 /* Allow single byte watchpoint. */
506 if (info->ctrl.len == ARM_BREAKPOINT_LEN_1)
507 break;
508 case 2:
509 /* Allow halfword watchpoints and breakpoints. */
510 if (info->ctrl.len == ARM_BREAKPOINT_LEN_2)
511 break;
512 default:
513 return -EINVAL;
514 }
515
516 info->address &= ~alignment_mask;
517 info->ctrl.len <<= offset;
518 } else {
519 if (info->ctrl.type == ARM_BREAKPOINT_EXECUTE)
520 alignment_mask = 0x3;
521 else
522 alignment_mask = 0x7;
523 if (info->address & alignment_mask)
524 return -EINVAL;
525 }
526
527 /*
528 * Disallow per-task kernel breakpoints since these would
529 * complicate the stepping code.
530 */
Peter Zijlstra50f16a82015-03-05 22:10:19 +0100531 if (info->ctrl.privilege == AARCH64_BREAKPOINT_EL1 && bp->hw.target)
Will Deacon478fcb22012-03-05 11:49:33 +0000532 return -EINVAL;
533
534 return 0;
535}
536
537/*
538 * Enable/disable all of the breakpoints active at the specified
539 * exception level at the register level.
540 * This is used when single-stepping after a breakpoint exception.
541 */
Will Deacon6f883d12015-07-27 18:36:54 +0100542static void toggle_bp_registers(int reg, enum dbg_active_el el, int enable)
Will Deacon478fcb22012-03-05 11:49:33 +0000543{
544 int i, max_slots, privilege;
545 u32 ctrl;
546 struct perf_event **slots;
547
548 switch (reg) {
549 case AARCH64_DBG_REG_BCR:
Christoph Lameter1436c1a2013-10-21 13:17:08 +0100550 slots = this_cpu_ptr(bp_on_reg);
Will Deacon478fcb22012-03-05 11:49:33 +0000551 max_slots = core_num_brps;
552 break;
553 case AARCH64_DBG_REG_WCR:
Christoph Lameter1436c1a2013-10-21 13:17:08 +0100554 slots = this_cpu_ptr(wp_on_reg);
Will Deacon478fcb22012-03-05 11:49:33 +0000555 max_slots = core_num_wrps;
556 break;
557 default:
558 return;
559 }
560
561 for (i = 0; i < max_slots; ++i) {
562 if (!slots[i])
563 continue;
564
565 privilege = counter_arch_bp(slots[i])->ctrl.privilege;
566 if (debug_exception_level(privilege) != el)
567 continue;
568
569 ctrl = read_wb_reg(reg, i);
570 if (enable)
571 ctrl |= 0x1;
572 else
573 ctrl &= ~0x1;
574 write_wb_reg(reg, i, ctrl);
575 }
576}
577
578/*
579 * Debug exception handlers.
580 */
581static int breakpoint_handler(unsigned long unused, unsigned int esr,
582 struct pt_regs *regs)
583{
584 int i, step = 0, *kernel_step;
585 u32 ctrl_reg;
586 u64 addr, val;
587 struct perf_event *bp, **slots;
588 struct debug_info *debug_info;
589 struct arch_hw_breakpoint_ctrl ctrl;
590
Christoph Lameter1436c1a2013-10-21 13:17:08 +0100591 slots = this_cpu_ptr(bp_on_reg);
Will Deacon478fcb22012-03-05 11:49:33 +0000592 addr = instruction_pointer(regs);
593 debug_info = &current->thread.debug;
594
595 for (i = 0; i < core_num_brps; ++i) {
596 rcu_read_lock();
597
598 bp = slots[i];
599
600 if (bp == NULL)
601 goto unlock;
602
603 /* Check if the breakpoint value matches. */
604 val = read_wb_reg(AARCH64_DBG_REG_BVR, i);
605 if (val != (addr & ~0x3))
606 goto unlock;
607
608 /* Possible match, check the byte address select to confirm. */
609 ctrl_reg = read_wb_reg(AARCH64_DBG_REG_BCR, i);
610 decode_ctrl_reg(ctrl_reg, &ctrl);
611 if (!((1 << (addr & 0x3)) & ctrl.len))
612 goto unlock;
613
614 counter_arch_bp(bp)->trigger = addr;
615 perf_bp_event(bp, regs);
616
617 /* Do we need to handle the stepping? */
618 if (!bp->overflow_handler)
619 step = 1;
620unlock:
621 rcu_read_unlock();
622 }
623
624 if (!step)
625 return 0;
626
627 if (user_mode(regs)) {
628 debug_info->bps_disabled = 1;
629 toggle_bp_registers(AARCH64_DBG_REG_BCR, DBG_ACTIVE_EL0, 0);
630
631 /* If we're already stepping a watchpoint, just return. */
632 if (debug_info->wps_disabled)
633 return 0;
634
635 if (test_thread_flag(TIF_SINGLESTEP))
636 debug_info->suspended_step = 1;
637 else
638 user_enable_single_step(current);
639 } else {
640 toggle_bp_registers(AARCH64_DBG_REG_BCR, DBG_ACTIVE_EL1, 0);
Christoph Lameter1436c1a2013-10-21 13:17:08 +0100641 kernel_step = this_cpu_ptr(&stepping_kernel_bp);
Will Deacon478fcb22012-03-05 11:49:33 +0000642
643 if (*kernel_step != ARM_KERNEL_STEP_NONE)
644 return 0;
645
646 if (kernel_active_single_step()) {
647 *kernel_step = ARM_KERNEL_STEP_SUSPEND;
648 } else {
649 *kernel_step = ARM_KERNEL_STEP_ACTIVE;
650 kernel_enable_single_step(regs);
651 }
652 }
653
654 return 0;
655}
656
657static int watchpoint_handler(unsigned long addr, unsigned int esr,
658 struct pt_regs *regs)
659{
660 int i, step = 0, *kernel_step, access;
661 u32 ctrl_reg;
662 u64 val, alignment_mask;
663 struct perf_event *wp, **slots;
664 struct debug_info *debug_info;
665 struct arch_hw_breakpoint *info;
666 struct arch_hw_breakpoint_ctrl ctrl;
667
Christoph Lameter1436c1a2013-10-21 13:17:08 +0100668 slots = this_cpu_ptr(wp_on_reg);
Will Deacon478fcb22012-03-05 11:49:33 +0000669 debug_info = &current->thread.debug;
670
671 for (i = 0; i < core_num_wrps; ++i) {
672 rcu_read_lock();
673
674 wp = slots[i];
675
676 if (wp == NULL)
677 goto unlock;
678
679 info = counter_arch_bp(wp);
680 /* AArch32 watchpoints are either 4 or 8 bytes aligned. */
681 if (is_compat_task()) {
682 if (info->ctrl.len == ARM_BREAKPOINT_LEN_8)
683 alignment_mask = 0x7;
684 else
685 alignment_mask = 0x3;
686 } else {
687 alignment_mask = 0x7;
688 }
689
690 /* Check if the watchpoint value matches. */
691 val = read_wb_reg(AARCH64_DBG_REG_WVR, i);
692 if (val != (addr & ~alignment_mask))
693 goto unlock;
694
695 /* Possible match, check the byte address select to confirm. */
696 ctrl_reg = read_wb_reg(AARCH64_DBG_REG_WCR, i);
697 decode_ctrl_reg(ctrl_reg, &ctrl);
698 if (!((1 << (addr & alignment_mask)) & ctrl.len))
699 goto unlock;
700
701 /*
702 * Check that the access type matches.
703 * 0 => load, otherwise => store
704 */
705 access = (esr & AARCH64_ESR_ACCESS_MASK) ? HW_BREAKPOINT_W :
706 HW_BREAKPOINT_R;
707 if (!(access & hw_breakpoint_type(wp)))
708 goto unlock;
709
710 info->trigger = addr;
711 perf_bp_event(wp, regs);
712
713 /* Do we need to handle the stepping? */
714 if (!wp->overflow_handler)
715 step = 1;
716
717unlock:
718 rcu_read_unlock();
719 }
720
721 if (!step)
722 return 0;
723
724 /*
725 * We always disable EL0 watchpoints because the kernel can
726 * cause these to fire via an unprivileged access.
727 */
728 toggle_bp_registers(AARCH64_DBG_REG_WCR, DBG_ACTIVE_EL0, 0);
729
730 if (user_mode(regs)) {
731 debug_info->wps_disabled = 1;
732
733 /* If we're already stepping a breakpoint, just return. */
734 if (debug_info->bps_disabled)
735 return 0;
736
737 if (test_thread_flag(TIF_SINGLESTEP))
738 debug_info->suspended_step = 1;
739 else
740 user_enable_single_step(current);
741 } else {
742 toggle_bp_registers(AARCH64_DBG_REG_WCR, DBG_ACTIVE_EL1, 0);
Christoph Lameter1436c1a2013-10-21 13:17:08 +0100743 kernel_step = this_cpu_ptr(&stepping_kernel_bp);
Will Deacon478fcb22012-03-05 11:49:33 +0000744
745 if (*kernel_step != ARM_KERNEL_STEP_NONE)
746 return 0;
747
748 if (kernel_active_single_step()) {
749 *kernel_step = ARM_KERNEL_STEP_SUSPEND;
750 } else {
751 *kernel_step = ARM_KERNEL_STEP_ACTIVE;
752 kernel_enable_single_step(regs);
753 }
754 }
755
756 return 0;
757}
758
759/*
760 * Handle single-step exception.
761 */
762int reinstall_suspended_bps(struct pt_regs *regs)
763{
764 struct debug_info *debug_info = &current->thread.debug;
765 int handled_exception = 0, *kernel_step;
766
Christoph Lameter1436c1a2013-10-21 13:17:08 +0100767 kernel_step = this_cpu_ptr(&stepping_kernel_bp);
Will Deacon478fcb22012-03-05 11:49:33 +0000768
769 /*
770 * Called from single-step exception handler.
771 * Return 0 if execution can resume, 1 if a SIGTRAP should be
772 * reported.
773 */
774 if (user_mode(regs)) {
775 if (debug_info->bps_disabled) {
776 debug_info->bps_disabled = 0;
777 toggle_bp_registers(AARCH64_DBG_REG_BCR, DBG_ACTIVE_EL0, 1);
778 handled_exception = 1;
779 }
780
781 if (debug_info->wps_disabled) {
782 debug_info->wps_disabled = 0;
783 toggle_bp_registers(AARCH64_DBG_REG_WCR, DBG_ACTIVE_EL0, 1);
784 handled_exception = 1;
785 }
786
787 if (handled_exception) {
788 if (debug_info->suspended_step) {
789 debug_info->suspended_step = 0;
790 /* Allow exception handling to fall-through. */
791 handled_exception = 0;
792 } else {
793 user_disable_single_step(current);
794 }
795 }
796 } else if (*kernel_step != ARM_KERNEL_STEP_NONE) {
797 toggle_bp_registers(AARCH64_DBG_REG_BCR, DBG_ACTIVE_EL1, 1);
798 toggle_bp_registers(AARCH64_DBG_REG_WCR, DBG_ACTIVE_EL1, 1);
799
800 if (!debug_info->wps_disabled)
801 toggle_bp_registers(AARCH64_DBG_REG_WCR, DBG_ACTIVE_EL0, 1);
802
803 if (*kernel_step != ARM_KERNEL_STEP_SUSPEND) {
804 kernel_disable_single_step();
805 handled_exception = 1;
806 } else {
807 handled_exception = 0;
808 }
809
810 *kernel_step = ARM_KERNEL_STEP_NONE;
811 }
812
813 return !handled_exception;
814}
815
816/*
817 * Context-switcher for restoring suspended breakpoints.
818 */
819void hw_breakpoint_thread_switch(struct task_struct *next)
820{
821 /*
822 * current next
823 * disabled: 0 0 => The usual case, NOTIFY_DONE
824 * 0 1 => Disable the registers
825 * 1 0 => Enable the registers
826 * 1 1 => NOTIFY_DONE. per-task bps will
827 * get taken care of by perf.
828 */
829
830 struct debug_info *current_debug_info, *next_debug_info;
831
832 current_debug_info = &current->thread.debug;
833 next_debug_info = &next->thread.debug;
834
835 /* Update breakpoints. */
836 if (current_debug_info->bps_disabled != next_debug_info->bps_disabled)
837 toggle_bp_registers(AARCH64_DBG_REG_BCR,
838 DBG_ACTIVE_EL0,
839 !next_debug_info->bps_disabled);
840
841 /* Update watchpoints. */
842 if (current_debug_info->wps_disabled != next_debug_info->wps_disabled)
843 toggle_bp_registers(AARCH64_DBG_REG_WCR,
844 DBG_ACTIVE_EL0,
845 !next_debug_info->wps_disabled);
846}
847
848/*
849 * CPU initialisation.
850 */
Lorenzo Pieralisi60fc6942013-08-05 15:20:35 +0100851static void hw_breakpoint_reset(void *unused)
Will Deacon478fcb22012-03-05 11:49:33 +0000852{
853 int i;
Lorenzo Pieralisi60fc6942013-08-05 15:20:35 +0100854 struct perf_event **slots;
855 /*
856 * When a CPU goes through cold-boot, it does not have any installed
857 * slot, so it is safe to share the same function for restoring and
858 * resetting breakpoints; when a CPU is hotplugged in, it goes
859 * through the slots, which are all empty, hence it just resets control
860 * and value for debug registers.
861 * When this function is triggered on warm-boot through a CPU PM
862 * notifier some slots might be initialized; if so they are
863 * reprogrammed according to the debug slots content.
864 */
865 for (slots = this_cpu_ptr(bp_on_reg), i = 0; i < core_num_brps; ++i) {
866 if (slots[i]) {
867 hw_breakpoint_control(slots[i], HW_BREAKPOINT_RESTORE);
868 } else {
869 write_wb_reg(AARCH64_DBG_REG_BCR, i, 0UL);
870 write_wb_reg(AARCH64_DBG_REG_BVR, i, 0UL);
871 }
Will Deacon478fcb22012-03-05 11:49:33 +0000872 }
873
Lorenzo Pieralisi60fc6942013-08-05 15:20:35 +0100874 for (slots = this_cpu_ptr(wp_on_reg), i = 0; i < core_num_wrps; ++i) {
875 if (slots[i]) {
876 hw_breakpoint_control(slots[i], HW_BREAKPOINT_RESTORE);
877 } else {
878 write_wb_reg(AARCH64_DBG_REG_WCR, i, 0UL);
879 write_wb_reg(AARCH64_DBG_REG_WVR, i, 0UL);
880 }
Will Deacon478fcb22012-03-05 11:49:33 +0000881 }
882}
883
Paul Gortmakerb8c64532013-06-18 10:18:31 -0400884static int hw_breakpoint_reset_notify(struct notifier_block *self,
Will Deacon478fcb22012-03-05 11:49:33 +0000885 unsigned long action,
886 void *hcpu)
887{
888 int cpu = (long)hcpu;
Will Deacone56d82a2015-09-11 15:31:24 +0100889 if ((action & ~CPU_TASKS_FROZEN) == CPU_ONLINE)
Lorenzo Pieralisi60fc6942013-08-05 15:20:35 +0100890 smp_call_function_single(cpu, hw_breakpoint_reset, NULL, 1);
Will Deacon478fcb22012-03-05 11:49:33 +0000891 return NOTIFY_OK;
892}
893
Paul Gortmakerb8c64532013-06-18 10:18:31 -0400894static struct notifier_block hw_breakpoint_reset_nb = {
Will Deacon478fcb22012-03-05 11:49:33 +0000895 .notifier_call = hw_breakpoint_reset_notify,
896};
897
Lorenzo Pieralisiaf3cfdb2015-01-26 18:33:44 +0000898#ifdef CONFIG_CPU_PM
Lorenzo Pieralisi65c021b2014-01-10 13:15:05 +0000899extern void cpu_suspend_set_dbg_restorer(void (*hw_bp_restore)(void *));
Lorenzo Pieralisi60fc6942013-08-05 15:20:35 +0100900#else
Lorenzo Pieralisi65c021b2014-01-10 13:15:05 +0000901static inline void cpu_suspend_set_dbg_restorer(void (*hw_bp_restore)(void *))
Lorenzo Pieralisi60fc6942013-08-05 15:20:35 +0100902{
903}
904#endif
905
Will Deacon478fcb22012-03-05 11:49:33 +0000906/*
907 * One-time initialisation.
908 */
909static int __init arch_hw_breakpoint_init(void)
910{
911 core_num_brps = get_num_brps();
912 core_num_wrps = get_num_wrps();
913
914 pr_info("found %d breakpoint and %d watchpoint registers.\n",
915 core_num_brps, core_num_wrps);
916
Srivatsa S. Bhat3d0dc642014-03-11 02:09:08 +0530917 cpu_notifier_register_begin();
918
Will Deacon478fcb22012-03-05 11:49:33 +0000919 /*
920 * Reset the breakpoint resources. We assume that a halting
921 * debugger will leave the world in a nice state for us.
922 */
Lorenzo Pieralisi60fc6942013-08-05 15:20:35 +0100923 smp_call_function(hw_breakpoint_reset, NULL, 1);
924 hw_breakpoint_reset(NULL);
Will Deacon478fcb22012-03-05 11:49:33 +0000925
926 /* Register debug fault handlers. */
927 hook_debug_fault_code(DBG_ESR_EVT_HWBP, breakpoint_handler, SIGTRAP,
928 TRAP_HWBKPT, "hw-breakpoint handler");
929 hook_debug_fault_code(DBG_ESR_EVT_HWWP, watchpoint_handler, SIGTRAP,
930 TRAP_HWBKPT, "hw-watchpoint handler");
931
932 /* Register hotplug notifier. */
Srivatsa S. Bhat3d0dc642014-03-11 02:09:08 +0530933 __register_cpu_notifier(&hw_breakpoint_reset_nb);
934
935 cpu_notifier_register_done();
936
Lorenzo Pieralisi65c021b2014-01-10 13:15:05 +0000937 /* Register cpu_suspend hw breakpoint restore hook */
938 cpu_suspend_set_dbg_restorer(hw_breakpoint_reset);
Will Deacon478fcb22012-03-05 11:49:33 +0000939
940 return 0;
941}
942arch_initcall(arch_hw_breakpoint_init);
943
944void hw_breakpoint_pmu_read(struct perf_event *bp)
945{
946}
947
948/*
949 * Dummy function to register with die_notifier.
950 */
951int hw_breakpoint_exceptions_notify(struct notifier_block *unused,
952 unsigned long val, void *data)
953{
954 return NOTIFY_DONE;
955}