Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 *
4 * Copyright (C) 2007 Alan Stern
5 * Copyright (C) 2009 IBM Corporation
6 * Copyright (C) 2009 Frederic Weisbecker <fweisbec@gmail.com>
7 *
8 * Authors: Alan Stern <stern@rowland.harvard.edu>
9 * K.Prasad <prasad@linux.vnet.ibm.com>
10 * Frederic Weisbecker <fweisbec@gmail.com>
11 */
12
13/*
14 * HW_breakpoint: a unified kernel/user-space hardware breakpoint facility,
15 * using the CPU's debug registers.
16 */
17
18#include <linux/perf_event.h>
19#include <linux/hw_breakpoint.h>
20#include <linux/irqflags.h>
21#include <linux/notifier.h>
22#include <linux/kallsyms.h>
23#include <linux/kprobes.h>
24#include <linux/percpu.h>
25#include <linux/kdebug.h>
26#include <linux/kernel.h>
27#include <linux/export.h>
28#include <linux/sched.h>
29#include <linux/smp.h>
30
31#include <asm/hw_breakpoint.h>
32#include <asm/processor.h>
33#include <asm/debugreg.h>
34#include <asm/user.h>
35
36/* Per cpu debug control register value */
37DEFINE_PER_CPU(unsigned long, cpu_dr7);
38EXPORT_PER_CPU_SYMBOL(cpu_dr7);
39
40/* Per cpu debug address registers values */
41static DEFINE_PER_CPU(unsigned long, cpu_debugreg[HBP_NUM]);
42
43/*
44 * Stores the breakpoints currently in use on each breakpoint address
45 * register for each cpus
46 */
47static DEFINE_PER_CPU(struct perf_event *, bp_per_reg[HBP_NUM]);
48
49
50static inline unsigned long
51__encode_dr7(int drnum, unsigned int len, unsigned int type)
52{
53 unsigned long bp_info;
54
55 bp_info = (len | type) & 0xf;
56 bp_info <<= (DR_CONTROL_SHIFT + drnum * DR_CONTROL_SIZE);
57 bp_info |= (DR_GLOBAL_ENABLE << (drnum * DR_ENABLE_SIZE));
58
59 return bp_info;
60}
61
62/*
63 * Encode the length, type, Exact, and Enable bits for a particular breakpoint
64 * as stored in debug register 7.
65 */
66unsigned long encode_dr7(int drnum, unsigned int len, unsigned int type)
67{
68 return __encode_dr7(drnum, len, type) | DR_GLOBAL_SLOWDOWN;
69}
70
71/*
72 * Decode the length and type bits for a particular breakpoint as
73 * stored in debug register 7. Return the "enabled" status.
74 */
75int decode_dr7(unsigned long dr7, int bpnum, unsigned *len, unsigned *type)
76{
77 int bp_info = dr7 >> (DR_CONTROL_SHIFT + bpnum * DR_CONTROL_SIZE);
78
79 *len = (bp_info & 0xc) | 0x40;
80 *type = (bp_info & 0x3) | 0x80;
81
82 return (dr7 >> (bpnum * DR_ENABLE_SIZE)) & 0x3;
83}
84
85/*
86 * Install a perf counter breakpoint.
87 *
88 * We seek a free debug address register and use it for this
89 * breakpoint. Eventually we enable it in the debug control register.
90 *
91 * Atomic: we hold the counter->ctx->lock and we only handle variables
92 * and registers local to this cpu.
93 */
94int arch_install_hw_breakpoint(struct perf_event *bp)
95{
96 struct arch_hw_breakpoint *info = counter_arch_bp(bp);
97 unsigned long *dr7;
98 int i;
99
100 for (i = 0; i < HBP_NUM; i++) {
101 struct perf_event **slot = this_cpu_ptr(&bp_per_reg[i]);
102
103 if (!*slot) {
104 *slot = bp;
105 break;
106 }
107 }
108
109 if (WARN_ONCE(i == HBP_NUM, "Can't find any breakpoint slot"))
110 return -EBUSY;
111
112 set_debugreg(info->address, i);
113 __this_cpu_write(cpu_debugreg[i], info->address);
114
115 dr7 = this_cpu_ptr(&cpu_dr7);
116 *dr7 |= encode_dr7(i, info->len, info->type);
117
118 set_debugreg(*dr7, 7);
119 if (info->mask)
120 set_dr_addr_mask(info->mask, i);
121
122 return 0;
123}
124
125/*
126 * Uninstall the breakpoint contained in the given counter.
127 *
128 * First we search the debug address register it uses and then we disable
129 * it.
130 *
131 * Atomic: we hold the counter->ctx->lock and we only handle variables
132 * and registers local to this cpu.
133 */
134void arch_uninstall_hw_breakpoint(struct perf_event *bp)
135{
136 struct arch_hw_breakpoint *info = counter_arch_bp(bp);
137 unsigned long *dr7;
138 int i;
139
140 for (i = 0; i < HBP_NUM; i++) {
141 struct perf_event **slot = this_cpu_ptr(&bp_per_reg[i]);
142
143 if (*slot == bp) {
144 *slot = NULL;
145 break;
146 }
147 }
148
149 if (WARN_ONCE(i == HBP_NUM, "Can't find any breakpoint slot"))
150 return;
151
152 dr7 = this_cpu_ptr(&cpu_dr7);
153 *dr7 &= ~__encode_dr7(i, info->len, info->type);
154
155 set_debugreg(*dr7, 7);
156 if (info->mask)
157 set_dr_addr_mask(0, i);
158}
159
160static int arch_bp_generic_len(int x86_len)
161{
162 switch (x86_len) {
163 case X86_BREAKPOINT_LEN_1:
164 return HW_BREAKPOINT_LEN_1;
165 case X86_BREAKPOINT_LEN_2:
166 return HW_BREAKPOINT_LEN_2;
167 case X86_BREAKPOINT_LEN_4:
168 return HW_BREAKPOINT_LEN_4;
169#ifdef CONFIG_X86_64
170 case X86_BREAKPOINT_LEN_8:
171 return HW_BREAKPOINT_LEN_8;
172#endif
173 default:
174 return -EINVAL;
175 }
176}
177
178int arch_bp_generic_fields(int x86_len, int x86_type,
179 int *gen_len, int *gen_type)
180{
181 int len;
182
183 /* Type */
184 switch (x86_type) {
185 case X86_BREAKPOINT_EXECUTE:
186 if (x86_len != X86_BREAKPOINT_LEN_X)
187 return -EINVAL;
188
189 *gen_type = HW_BREAKPOINT_X;
190 *gen_len = sizeof(long);
191 return 0;
192 case X86_BREAKPOINT_WRITE:
193 *gen_type = HW_BREAKPOINT_W;
194 break;
195 case X86_BREAKPOINT_RW:
196 *gen_type = HW_BREAKPOINT_W | HW_BREAKPOINT_R;
197 break;
198 default:
199 return -EINVAL;
200 }
201
202 /* Len */
203 len = arch_bp_generic_len(x86_len);
204 if (len < 0)
205 return -EINVAL;
206 *gen_len = len;
207
208 return 0;
209}
210
211/*
212 * Check for virtual address in kernel space.
213 */
214int arch_check_bp_in_kernelspace(struct arch_hw_breakpoint *hw)
215{
216 unsigned long va;
217 int len;
218
219 va = hw->address;
220 len = arch_bp_generic_len(hw->len);
221 WARN_ON_ONCE(len < 0);
222
223 /*
224 * We don't need to worry about va + len - 1 overflowing:
225 * we already require that va is aligned to a multiple of len.
226 */
227 return (va >= TASK_SIZE_MAX) || ((va + len - 1) >= TASK_SIZE_MAX);
228}
229
230static int arch_build_bp_info(struct perf_event *bp,
231 const struct perf_event_attr *attr,
232 struct arch_hw_breakpoint *hw)
233{
234 hw->address = attr->bp_addr;
235 hw->mask = 0;
236
237 /* Type */
238 switch (attr->bp_type) {
239 case HW_BREAKPOINT_W:
240 hw->type = X86_BREAKPOINT_WRITE;
241 break;
242 case HW_BREAKPOINT_W | HW_BREAKPOINT_R:
243 hw->type = X86_BREAKPOINT_RW;
244 break;
245 case HW_BREAKPOINT_X:
246 /*
247 * We don't allow kernel breakpoints in places that are not
248 * acceptable for kprobes. On non-kprobes kernels, we don't
249 * allow kernel breakpoints at all.
250 */
251 if (attr->bp_addr >= TASK_SIZE_MAX) {
252 if (within_kprobe_blacklist(attr->bp_addr))
253 return -EINVAL;
254 }
255
256 hw->type = X86_BREAKPOINT_EXECUTE;
257 /*
258 * x86 inst breakpoints need to have a specific undefined len.
259 * But we still need to check userspace is not trying to setup
260 * an unsupported length, to get a range breakpoint for example.
261 */
262 if (attr->bp_len == sizeof(long)) {
263 hw->len = X86_BREAKPOINT_LEN_X;
264 return 0;
265 }
266 /* fall through */
267 default:
268 return -EINVAL;
269 }
270
271 /* Len */
272 switch (attr->bp_len) {
273 case HW_BREAKPOINT_LEN_1:
274 hw->len = X86_BREAKPOINT_LEN_1;
275 break;
276 case HW_BREAKPOINT_LEN_2:
277 hw->len = X86_BREAKPOINT_LEN_2;
278 break;
279 case HW_BREAKPOINT_LEN_4:
280 hw->len = X86_BREAKPOINT_LEN_4;
281 break;
282#ifdef CONFIG_X86_64
283 case HW_BREAKPOINT_LEN_8:
284 hw->len = X86_BREAKPOINT_LEN_8;
285 break;
286#endif
287 default:
288 /* AMD range breakpoint */
289 if (!is_power_of_2(attr->bp_len))
290 return -EINVAL;
291 if (attr->bp_addr & (attr->bp_len - 1))
292 return -EINVAL;
293
294 if (!boot_cpu_has(X86_FEATURE_BPEXT))
295 return -EOPNOTSUPP;
296
297 /*
298 * It's impossible to use a range breakpoint to fake out
299 * user vs kernel detection because bp_len - 1 can't
300 * have the high bit set. If we ever allow range instruction
301 * breakpoints, then we'll have to check for kprobe-blacklisted
302 * addresses anywhere in the range.
303 */
304 hw->mask = attr->bp_len - 1;
305 hw->len = X86_BREAKPOINT_LEN_1;
306 }
307
308 return 0;
309}
310
311/*
312 * Validate the arch-specific HW Breakpoint register settings
313 */
314int hw_breakpoint_arch_parse(struct perf_event *bp,
315 const struct perf_event_attr *attr,
316 struct arch_hw_breakpoint *hw)
317{
318 unsigned int align;
319 int ret;
320
321
322 ret = arch_build_bp_info(bp, attr, hw);
323 if (ret)
324 return ret;
325
326 switch (hw->len) {
327 case X86_BREAKPOINT_LEN_1:
328 align = 0;
329 if (hw->mask)
330 align = hw->mask;
331 break;
332 case X86_BREAKPOINT_LEN_2:
333 align = 1;
334 break;
335 case X86_BREAKPOINT_LEN_4:
336 align = 3;
337 break;
338#ifdef CONFIG_X86_64
339 case X86_BREAKPOINT_LEN_8:
340 align = 7;
341 break;
342#endif
343 default:
344 WARN_ON_ONCE(1);
345 return -EINVAL;
346 }
347
348 /*
349 * Check that the low-order bits of the address are appropriate
350 * for the alignment implied by len.
351 */
352 if (hw->address & align)
353 return -EINVAL;
354
355 return 0;
356}
357
358/*
359 * Dump the debug register contents to the user.
360 * We can't dump our per cpu values because it
361 * may contain cpu wide breakpoint, something that
362 * doesn't belong to the current task.
363 *
364 * TODO: include non-ptrace user breakpoints (perf)
365 */
366void aout_dump_debugregs(struct user *dump)
367{
368 int i;
369 int dr7 = 0;
370 struct perf_event *bp;
371 struct arch_hw_breakpoint *info;
372 struct thread_struct *thread = ¤t->thread;
373
374 for (i = 0; i < HBP_NUM; i++) {
375 bp = thread->ptrace_bps[i];
376
377 if (bp && !bp->attr.disabled) {
378 dump->u_debugreg[i] = bp->attr.bp_addr;
379 info = counter_arch_bp(bp);
380 dr7 |= encode_dr7(i, info->len, info->type);
381 } else {
382 dump->u_debugreg[i] = 0;
383 }
384 }
385
386 dump->u_debugreg[4] = 0;
387 dump->u_debugreg[5] = 0;
388 dump->u_debugreg[6] = current->thread.debugreg6;
389
390 dump->u_debugreg[7] = dr7;
391}
392EXPORT_SYMBOL_GPL(aout_dump_debugregs);
393
394/*
395 * Release the user breakpoints used by ptrace
396 */
397void flush_ptrace_hw_breakpoint(struct task_struct *tsk)
398{
399 int i;
400 struct thread_struct *t = &tsk->thread;
401
402 for (i = 0; i < HBP_NUM; i++) {
403 unregister_hw_breakpoint(t->ptrace_bps[i]);
404 t->ptrace_bps[i] = NULL;
405 }
406
407 t->debugreg6 = 0;
408 t->ptrace_dr7 = 0;
409}
410
411void hw_breakpoint_restore(void)
412{
413 set_debugreg(__this_cpu_read(cpu_debugreg[0]), 0);
414 set_debugreg(__this_cpu_read(cpu_debugreg[1]), 1);
415 set_debugreg(__this_cpu_read(cpu_debugreg[2]), 2);
416 set_debugreg(__this_cpu_read(cpu_debugreg[3]), 3);
417 set_debugreg(current->thread.debugreg6, 6);
418 set_debugreg(__this_cpu_read(cpu_dr7), 7);
419}
420EXPORT_SYMBOL_GPL(hw_breakpoint_restore);
421
422/*
423 * Handle debug exception notifications.
424 *
425 * Return value is either NOTIFY_STOP or NOTIFY_DONE as explained below.
426 *
427 * NOTIFY_DONE returned if one of the following conditions is true.
428 * i) When the causative address is from user-space and the exception
429 * is a valid one, i.e. not triggered as a result of lazy debug register
430 * switching
431 * ii) When there are more bits than trap<n> set in DR6 register (such
432 * as BD, BS or BT) indicating that more than one debug condition is
433 * met and requires some more action in do_debug().
434 *
435 * NOTIFY_STOP returned for all other cases
436 *
437 */
438static int hw_breakpoint_handler(struct die_args *args)
439{
440 int i, cpu, rc = NOTIFY_STOP;
441 struct perf_event *bp;
442 unsigned long dr7, dr6;
443 unsigned long *dr6_p;
444
445 /* The DR6 value is pointed by args->err */
446 dr6_p = (unsigned long *)ERR_PTR(args->err);
447 dr6 = *dr6_p;
448
449 /* If it's a single step, TRAP bits are random */
450 if (dr6 & DR_STEP)
451 return NOTIFY_DONE;
452
453 /* Do an early return if no trap bits are set in DR6 */
454 if ((dr6 & DR_TRAP_BITS) == 0)
455 return NOTIFY_DONE;
456
457 get_debugreg(dr7, 7);
458 /* Disable breakpoints during exception handling */
459 set_debugreg(0UL, 7);
460 /*
461 * Assert that local interrupts are disabled
462 * Reset the DRn bits in the virtualized register value.
463 * The ptrace trigger routine will add in whatever is needed.
464 */
465 current->thread.debugreg6 &= ~DR_TRAP_BITS;
466 cpu = get_cpu();
467
468 /* Handle all the breakpoints that were triggered */
469 for (i = 0; i < HBP_NUM; ++i) {
470 if (likely(!(dr6 & (DR_TRAP0 << i))))
471 continue;
472
473 /*
474 * The counter may be concurrently released but that can only
475 * occur from a call_rcu() path. We can then safely fetch
476 * the breakpoint, use its callback, touch its counter
477 * while we are in an rcu_read_lock() path.
478 */
479 rcu_read_lock();
480
481 bp = per_cpu(bp_per_reg[i], cpu);
482 /*
483 * Reset the 'i'th TRAP bit in dr6 to denote completion of
484 * exception handling
485 */
486 (*dr6_p) &= ~(DR_TRAP0 << i);
487 /*
488 * bp can be NULL due to lazy debug register switching
489 * or due to concurrent perf counter removing.
490 */
491 if (!bp) {
492 rcu_read_unlock();
493 break;
494 }
495
496 perf_bp_event(bp, args->regs);
497
498 /*
499 * Set up resume flag to avoid breakpoint recursion when
500 * returning back to origin.
501 */
502 if (bp->hw.info.type == X86_BREAKPOINT_EXECUTE)
503 args->regs->flags |= X86_EFLAGS_RF;
504
505 rcu_read_unlock();
506 }
507 /*
508 * Further processing in do_debug() is needed for a) user-space
509 * breakpoints (to generate signals) and b) when the system has
510 * taken exception due to multiple causes
511 */
512 if ((current->thread.debugreg6 & DR_TRAP_BITS) ||
513 (dr6 & (~DR_TRAP_BITS)))
514 rc = NOTIFY_DONE;
515
516 set_debugreg(dr7, 7);
517 put_cpu();
518
519 return rc;
520}
521
522/*
523 * Handle debug exception notifications.
524 */
525int hw_breakpoint_exceptions_notify(
526 struct notifier_block *unused, unsigned long val, void *data)
527{
528 if (val != DIE_DEBUG)
529 return NOTIFY_DONE;
530
531 return hw_breakpoint_handler(data);
532}
533
534void hw_breakpoint_pmu_read(struct perf_event *bp)
535{
536 /* TODO */
537}
1/*
2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
15 *
16 * Copyright (C) 2007 Alan Stern
17 * Copyright (C) 2009 IBM Corporation
18 * Copyright (C) 2009 Frederic Weisbecker <fweisbec@gmail.com>
19 *
20 * Authors: Alan Stern <stern@rowland.harvard.edu>
21 * K.Prasad <prasad@linux.vnet.ibm.com>
22 * Frederic Weisbecker <fweisbec@gmail.com>
23 */
24
25/*
26 * HW_breakpoint: a unified kernel/user-space hardware breakpoint facility,
27 * using the CPU's debug registers.
28 */
29
30#include <linux/perf_event.h>
31#include <linux/hw_breakpoint.h>
32#include <linux/irqflags.h>
33#include <linux/notifier.h>
34#include <linux/kallsyms.h>
35#include <linux/kprobes.h>
36#include <linux/percpu.h>
37#include <linux/kdebug.h>
38#include <linux/kernel.h>
39#include <linux/module.h>
40#include <linux/sched.h>
41#include <linux/smp.h>
42
43#include <asm/hw_breakpoint.h>
44#include <asm/processor.h>
45#include <asm/debugreg.h>
46
47/* Per cpu debug control register value */
48DEFINE_PER_CPU(unsigned long, cpu_dr7);
49EXPORT_PER_CPU_SYMBOL(cpu_dr7);
50
51/* Per cpu debug address registers values */
52static DEFINE_PER_CPU(unsigned long, cpu_debugreg[HBP_NUM]);
53
54/*
55 * Stores the breakpoints currently in use on each breakpoint address
56 * register for each cpus
57 */
58static DEFINE_PER_CPU(struct perf_event *, bp_per_reg[HBP_NUM]);
59
60
61static inline unsigned long
62__encode_dr7(int drnum, unsigned int len, unsigned int type)
63{
64 unsigned long bp_info;
65
66 bp_info = (len | type) & 0xf;
67 bp_info <<= (DR_CONTROL_SHIFT + drnum * DR_CONTROL_SIZE);
68 bp_info |= (DR_GLOBAL_ENABLE << (drnum * DR_ENABLE_SIZE));
69
70 return bp_info;
71}
72
73/*
74 * Encode the length, type, Exact, and Enable bits for a particular breakpoint
75 * as stored in debug register 7.
76 */
77unsigned long encode_dr7(int drnum, unsigned int len, unsigned int type)
78{
79 return __encode_dr7(drnum, len, type) | DR_GLOBAL_SLOWDOWN;
80}
81
82/*
83 * Decode the length and type bits for a particular breakpoint as
84 * stored in debug register 7. Return the "enabled" status.
85 */
86int decode_dr7(unsigned long dr7, int bpnum, unsigned *len, unsigned *type)
87{
88 int bp_info = dr7 >> (DR_CONTROL_SHIFT + bpnum * DR_CONTROL_SIZE);
89
90 *len = (bp_info & 0xc) | 0x40;
91 *type = (bp_info & 0x3) | 0x80;
92
93 return (dr7 >> (bpnum * DR_ENABLE_SIZE)) & 0x3;
94}
95
96/*
97 * Install a perf counter breakpoint.
98 *
99 * We seek a free debug address register and use it for this
100 * breakpoint. Eventually we enable it in the debug control register.
101 *
102 * Atomic: we hold the counter->ctx->lock and we only handle variables
103 * and registers local to this cpu.
104 */
105int arch_install_hw_breakpoint(struct perf_event *bp)
106{
107 struct arch_hw_breakpoint *info = counter_arch_bp(bp);
108 unsigned long *dr7;
109 int i;
110
111 for (i = 0; i < HBP_NUM; i++) {
112 struct perf_event **slot = &__get_cpu_var(bp_per_reg[i]);
113
114 if (!*slot) {
115 *slot = bp;
116 break;
117 }
118 }
119
120 if (WARN_ONCE(i == HBP_NUM, "Can't find any breakpoint slot"))
121 return -EBUSY;
122
123 set_debugreg(info->address, i);
124 __this_cpu_write(cpu_debugreg[i], info->address);
125
126 dr7 = &__get_cpu_var(cpu_dr7);
127 *dr7 |= encode_dr7(i, info->len, info->type);
128
129 set_debugreg(*dr7, 7);
130
131 return 0;
132}
133
134/*
135 * Uninstall the breakpoint contained in the given counter.
136 *
137 * First we search the debug address register it uses and then we disable
138 * it.
139 *
140 * Atomic: we hold the counter->ctx->lock and we only handle variables
141 * and registers local to this cpu.
142 */
143void arch_uninstall_hw_breakpoint(struct perf_event *bp)
144{
145 struct arch_hw_breakpoint *info = counter_arch_bp(bp);
146 unsigned long *dr7;
147 int i;
148
149 for (i = 0; i < HBP_NUM; i++) {
150 struct perf_event **slot = &__get_cpu_var(bp_per_reg[i]);
151
152 if (*slot == bp) {
153 *slot = NULL;
154 break;
155 }
156 }
157
158 if (WARN_ONCE(i == HBP_NUM, "Can't find any breakpoint slot"))
159 return;
160
161 dr7 = &__get_cpu_var(cpu_dr7);
162 *dr7 &= ~__encode_dr7(i, info->len, info->type);
163
164 set_debugreg(*dr7, 7);
165}
166
167static int get_hbp_len(u8 hbp_len)
168{
169 unsigned int len_in_bytes = 0;
170
171 switch (hbp_len) {
172 case X86_BREAKPOINT_LEN_1:
173 len_in_bytes = 1;
174 break;
175 case X86_BREAKPOINT_LEN_2:
176 len_in_bytes = 2;
177 break;
178 case X86_BREAKPOINT_LEN_4:
179 len_in_bytes = 4;
180 break;
181#ifdef CONFIG_X86_64
182 case X86_BREAKPOINT_LEN_8:
183 len_in_bytes = 8;
184 break;
185#endif
186 }
187 return len_in_bytes;
188}
189
190/*
191 * Check for virtual address in kernel space.
192 */
193int arch_check_bp_in_kernelspace(struct perf_event *bp)
194{
195 unsigned int len;
196 unsigned long va;
197 struct arch_hw_breakpoint *info = counter_arch_bp(bp);
198
199 va = info->address;
200 len = get_hbp_len(info->len);
201
202 return (va >= TASK_SIZE) && ((va + len - 1) >= TASK_SIZE);
203}
204
205int arch_bp_generic_fields(int x86_len, int x86_type,
206 int *gen_len, int *gen_type)
207{
208 /* Type */
209 switch (x86_type) {
210 case X86_BREAKPOINT_EXECUTE:
211 if (x86_len != X86_BREAKPOINT_LEN_X)
212 return -EINVAL;
213
214 *gen_type = HW_BREAKPOINT_X;
215 *gen_len = sizeof(long);
216 return 0;
217 case X86_BREAKPOINT_WRITE:
218 *gen_type = HW_BREAKPOINT_W;
219 break;
220 case X86_BREAKPOINT_RW:
221 *gen_type = HW_BREAKPOINT_W | HW_BREAKPOINT_R;
222 break;
223 default:
224 return -EINVAL;
225 }
226
227 /* Len */
228 switch (x86_len) {
229 case X86_BREAKPOINT_LEN_1:
230 *gen_len = HW_BREAKPOINT_LEN_1;
231 break;
232 case X86_BREAKPOINT_LEN_2:
233 *gen_len = HW_BREAKPOINT_LEN_2;
234 break;
235 case X86_BREAKPOINT_LEN_4:
236 *gen_len = HW_BREAKPOINT_LEN_4;
237 break;
238#ifdef CONFIG_X86_64
239 case X86_BREAKPOINT_LEN_8:
240 *gen_len = HW_BREAKPOINT_LEN_8;
241 break;
242#endif
243 default:
244 return -EINVAL;
245 }
246
247 return 0;
248}
249
250
251static int arch_build_bp_info(struct perf_event *bp)
252{
253 struct arch_hw_breakpoint *info = counter_arch_bp(bp);
254
255 info->address = bp->attr.bp_addr;
256
257 /* Type */
258 switch (bp->attr.bp_type) {
259 case HW_BREAKPOINT_W:
260 info->type = X86_BREAKPOINT_WRITE;
261 break;
262 case HW_BREAKPOINT_W | HW_BREAKPOINT_R:
263 info->type = X86_BREAKPOINT_RW;
264 break;
265 case HW_BREAKPOINT_X:
266 info->type = X86_BREAKPOINT_EXECUTE;
267 /*
268 * x86 inst breakpoints need to have a specific undefined len.
269 * But we still need to check userspace is not trying to setup
270 * an unsupported length, to get a range breakpoint for example.
271 */
272 if (bp->attr.bp_len == sizeof(long)) {
273 info->len = X86_BREAKPOINT_LEN_X;
274 return 0;
275 }
276 default:
277 return -EINVAL;
278 }
279
280 /* Len */
281 switch (bp->attr.bp_len) {
282 case HW_BREAKPOINT_LEN_1:
283 info->len = X86_BREAKPOINT_LEN_1;
284 break;
285 case HW_BREAKPOINT_LEN_2:
286 info->len = X86_BREAKPOINT_LEN_2;
287 break;
288 case HW_BREAKPOINT_LEN_4:
289 info->len = X86_BREAKPOINT_LEN_4;
290 break;
291#ifdef CONFIG_X86_64
292 case HW_BREAKPOINT_LEN_8:
293 info->len = X86_BREAKPOINT_LEN_8;
294 break;
295#endif
296 default:
297 return -EINVAL;
298 }
299
300 return 0;
301}
302/*
303 * Validate the arch-specific HW Breakpoint register settings
304 */
305int arch_validate_hwbkpt_settings(struct perf_event *bp)
306{
307 struct arch_hw_breakpoint *info = counter_arch_bp(bp);
308 unsigned int align;
309 int ret;
310
311
312 ret = arch_build_bp_info(bp);
313 if (ret)
314 return ret;
315
316 ret = -EINVAL;
317
318 switch (info->len) {
319 case X86_BREAKPOINT_LEN_1:
320 align = 0;
321 break;
322 case X86_BREAKPOINT_LEN_2:
323 align = 1;
324 break;
325 case X86_BREAKPOINT_LEN_4:
326 align = 3;
327 break;
328#ifdef CONFIG_X86_64
329 case X86_BREAKPOINT_LEN_8:
330 align = 7;
331 break;
332#endif
333 default:
334 return ret;
335 }
336
337 /*
338 * Check that the low-order bits of the address are appropriate
339 * for the alignment implied by len.
340 */
341 if (info->address & align)
342 return -EINVAL;
343
344 return 0;
345}
346
347/*
348 * Dump the debug register contents to the user.
349 * We can't dump our per cpu values because it
350 * may contain cpu wide breakpoint, something that
351 * doesn't belong to the current task.
352 *
353 * TODO: include non-ptrace user breakpoints (perf)
354 */
355void aout_dump_debugregs(struct user *dump)
356{
357 int i;
358 int dr7 = 0;
359 struct perf_event *bp;
360 struct arch_hw_breakpoint *info;
361 struct thread_struct *thread = ¤t->thread;
362
363 for (i = 0; i < HBP_NUM; i++) {
364 bp = thread->ptrace_bps[i];
365
366 if (bp && !bp->attr.disabled) {
367 dump->u_debugreg[i] = bp->attr.bp_addr;
368 info = counter_arch_bp(bp);
369 dr7 |= encode_dr7(i, info->len, info->type);
370 } else {
371 dump->u_debugreg[i] = 0;
372 }
373 }
374
375 dump->u_debugreg[4] = 0;
376 dump->u_debugreg[5] = 0;
377 dump->u_debugreg[6] = current->thread.debugreg6;
378
379 dump->u_debugreg[7] = dr7;
380}
381EXPORT_SYMBOL_GPL(aout_dump_debugregs);
382
383/*
384 * Release the user breakpoints used by ptrace
385 */
386void flush_ptrace_hw_breakpoint(struct task_struct *tsk)
387{
388 int i;
389 struct thread_struct *t = &tsk->thread;
390
391 for (i = 0; i < HBP_NUM; i++) {
392 unregister_hw_breakpoint(t->ptrace_bps[i]);
393 t->ptrace_bps[i] = NULL;
394 }
395
396 t->debugreg6 = 0;
397 t->ptrace_dr7 = 0;
398}
399
400void hw_breakpoint_restore(void)
401{
402 set_debugreg(__this_cpu_read(cpu_debugreg[0]), 0);
403 set_debugreg(__this_cpu_read(cpu_debugreg[1]), 1);
404 set_debugreg(__this_cpu_read(cpu_debugreg[2]), 2);
405 set_debugreg(__this_cpu_read(cpu_debugreg[3]), 3);
406 set_debugreg(current->thread.debugreg6, 6);
407 set_debugreg(__this_cpu_read(cpu_dr7), 7);
408}
409EXPORT_SYMBOL_GPL(hw_breakpoint_restore);
410
411/*
412 * Handle debug exception notifications.
413 *
414 * Return value is either NOTIFY_STOP or NOTIFY_DONE as explained below.
415 *
416 * NOTIFY_DONE returned if one of the following conditions is true.
417 * i) When the causative address is from user-space and the exception
418 * is a valid one, i.e. not triggered as a result of lazy debug register
419 * switching
420 * ii) When there are more bits than trap<n> set in DR6 register (such
421 * as BD, BS or BT) indicating that more than one debug condition is
422 * met and requires some more action in do_debug().
423 *
424 * NOTIFY_STOP returned for all other cases
425 *
426 */
427static int __kprobes hw_breakpoint_handler(struct die_args *args)
428{
429 int i, cpu, rc = NOTIFY_STOP;
430 struct perf_event *bp;
431 unsigned long dr7, dr6;
432 unsigned long *dr6_p;
433
434 /* The DR6 value is pointed by args->err */
435 dr6_p = (unsigned long *)ERR_PTR(args->err);
436 dr6 = *dr6_p;
437
438 /* If it's a single step, TRAP bits are random */
439 if (dr6 & DR_STEP)
440 return NOTIFY_DONE;
441
442 /* Do an early return if no trap bits are set in DR6 */
443 if ((dr6 & DR_TRAP_BITS) == 0)
444 return NOTIFY_DONE;
445
446 get_debugreg(dr7, 7);
447 /* Disable breakpoints during exception handling */
448 set_debugreg(0UL, 7);
449 /*
450 * Assert that local interrupts are disabled
451 * Reset the DRn bits in the virtualized register value.
452 * The ptrace trigger routine will add in whatever is needed.
453 */
454 current->thread.debugreg6 &= ~DR_TRAP_BITS;
455 cpu = get_cpu();
456
457 /* Handle all the breakpoints that were triggered */
458 for (i = 0; i < HBP_NUM; ++i) {
459 if (likely(!(dr6 & (DR_TRAP0 << i))))
460 continue;
461
462 /*
463 * The counter may be concurrently released but that can only
464 * occur from a call_rcu() path. We can then safely fetch
465 * the breakpoint, use its callback, touch its counter
466 * while we are in an rcu_read_lock() path.
467 */
468 rcu_read_lock();
469
470 bp = per_cpu(bp_per_reg[i], cpu);
471 /*
472 * Reset the 'i'th TRAP bit in dr6 to denote completion of
473 * exception handling
474 */
475 (*dr6_p) &= ~(DR_TRAP0 << i);
476 /*
477 * bp can be NULL due to lazy debug register switching
478 * or due to concurrent perf counter removing.
479 */
480 if (!bp) {
481 rcu_read_unlock();
482 break;
483 }
484
485 perf_bp_event(bp, args->regs);
486
487 /*
488 * Set up resume flag to avoid breakpoint recursion when
489 * returning back to origin.
490 */
491 if (bp->hw.info.type == X86_BREAKPOINT_EXECUTE)
492 args->regs->flags |= X86_EFLAGS_RF;
493
494 rcu_read_unlock();
495 }
496 /*
497 * Further processing in do_debug() is needed for a) user-space
498 * breakpoints (to generate signals) and b) when the system has
499 * taken exception due to multiple causes
500 */
501 if ((current->thread.debugreg6 & DR_TRAP_BITS) ||
502 (dr6 & (~DR_TRAP_BITS)))
503 rc = NOTIFY_DONE;
504
505 set_debugreg(dr7, 7);
506 put_cpu();
507
508 return rc;
509}
510
511/*
512 * Handle debug exception notifications.
513 */
514int __kprobes hw_breakpoint_exceptions_notify(
515 struct notifier_block *unused, unsigned long val, void *data)
516{
517 if (val != DIE_DEBUG)
518 return NOTIFY_DONE;
519
520 return hw_breakpoint_handler(data);
521}
522
523void hw_breakpoint_pmu_read(struct perf_event *bp)
524{
525 /* TODO */
526}