arm64: replace read_lock to rcu lock in call_break_hook
[deliverable/linux.git] / arch / arm64 / kernel / debug-monitors.c
CommitLineData
478fcb2c
WD
1/*
2 * ARMv8 single-step debug support and mdscr context switching.
3 *
4 * Copyright (C) 2012 ARM Limited
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 *
18 * Author: Will Deacon <will.deacon@arm.com>
19 */
20
21#include <linux/cpu.h>
22#include <linux/debugfs.h>
23#include <linux/hardirq.h>
24#include <linux/init.h>
25#include <linux/ptrace.h>
26#include <linux/stat.h>
1442b6ed 27#include <linux/uaccess.h>
478fcb2c
WD
28
29#include <asm/debug-monitors.h>
478fcb2c
WD
30#include <asm/cputype.h>
31#include <asm/system_misc.h>
32
478fcb2c
WD
33/* Determine debug architecture. */
34u8 debug_monitors_arch(void)
35{
36 return read_cpuid(ID_AA64DFR0_EL1) & 0xf;
37}
38
39/*
40 * MDSCR access routines.
41 */
42static void mdscr_write(u32 mdscr)
43{
44 unsigned long flags;
45 local_dbg_save(flags);
46 asm volatile("msr mdscr_el1, %0" :: "r" (mdscr));
47 local_dbg_restore(flags);
48}
49
50static u32 mdscr_read(void)
51{
52 u32 mdscr;
53 asm volatile("mrs %0, mdscr_el1" : "=r" (mdscr));
54 return mdscr;
55}
56
57/*
58 * Allow root to disable self-hosted debug from userspace.
59 * This is useful if you want to connect an external JTAG debugger.
60 */
61static u32 debug_enabled = 1;
62
63static int create_debug_debugfs_entry(void)
64{
65 debugfs_create_bool("debug_enabled", 0644, NULL, &debug_enabled);
66 return 0;
67}
68fs_initcall(create_debug_debugfs_entry);
69
70static int __init early_debug_disable(char *buf)
71{
72 debug_enabled = 0;
73 return 0;
74}
75
76early_param("nodebugmon", early_debug_disable);
77
78/*
79 * Keep track of debug users on each core.
80 * The ref counts are per-cpu so we use a local_t type.
81 */
1436c1aa
CL
82static DEFINE_PER_CPU(int, mde_ref_count);
83static DEFINE_PER_CPU(int, kde_ref_count);
478fcb2c 84
6f883d10 85void enable_debug_monitors(enum dbg_active_el el)
478fcb2c
WD
86{
87 u32 mdscr, enable = 0;
88
89 WARN_ON(preemptible());
90
1436c1aa 91 if (this_cpu_inc_return(mde_ref_count) == 1)
478fcb2c
WD
92 enable = DBG_MDSCR_MDE;
93
94 if (el == DBG_ACTIVE_EL1 &&
1436c1aa 95 this_cpu_inc_return(kde_ref_count) == 1)
478fcb2c
WD
96 enable |= DBG_MDSCR_KDE;
97
98 if (enable && debug_enabled) {
99 mdscr = mdscr_read();
100 mdscr |= enable;
101 mdscr_write(mdscr);
102 }
103}
104
6f883d10 105void disable_debug_monitors(enum dbg_active_el el)
478fcb2c
WD
106{
107 u32 mdscr, disable = 0;
108
109 WARN_ON(preemptible());
110
1436c1aa 111 if (this_cpu_dec_return(mde_ref_count) == 0)
478fcb2c
WD
112 disable = ~DBG_MDSCR_MDE;
113
114 if (el == DBG_ACTIVE_EL1 &&
1436c1aa 115 this_cpu_dec_return(kde_ref_count) == 0)
478fcb2c
WD
116 disable &= ~DBG_MDSCR_KDE;
117
118 if (disable) {
119 mdscr = mdscr_read();
120 mdscr &= disable;
121 mdscr_write(mdscr);
122 }
123}
124
125/*
126 * OS lock clearing.
127 */
128static void clear_os_lock(void *unused)
129{
478fcb2c 130 asm volatile("msr oslar_el1, %0" : : "r" (0));
478fcb2c
WD
131}
132
b8c6453a 133static int os_lock_notify(struct notifier_block *self,
478fcb2c
WD
134 unsigned long action, void *data)
135{
136 int cpu = (unsigned long)data;
e56d82a1 137 if ((action & ~CPU_TASKS_FROZEN) == CPU_ONLINE)
478fcb2c
WD
138 smp_call_function_single(cpu, clear_os_lock, NULL, 1);
139 return NOTIFY_OK;
140}
141
b8c6453a 142static struct notifier_block os_lock_nb = {
478fcb2c
WD
143 .notifier_call = os_lock_notify,
144};
145
b8c6453a 146static int debug_monitors_init(void)
478fcb2c 147{
4b0b68af
SB
148 cpu_notifier_register_begin();
149
478fcb2c 150 /* Clear the OS lock. */
d8ed442a
VK
151 on_each_cpu(clear_os_lock, NULL, 1);
152 isb();
153 local_dbg_enable();
478fcb2c
WD
154
155 /* Register hotplug handler. */
4b0b68af
SB
156 __register_cpu_notifier(&os_lock_nb);
157
158 cpu_notifier_register_done();
478fcb2c
WD
159 return 0;
160}
161postcore_initcall(debug_monitors_init);
162
163/*
164 * Single step API and exception handling.
165 */
166static void set_regs_spsr_ss(struct pt_regs *regs)
167{
168 unsigned long spsr;
169
170 spsr = regs->pstate;
171 spsr &= ~DBG_SPSR_SS;
172 spsr |= DBG_SPSR_SS;
173 regs->pstate = spsr;
174}
175
176static void clear_regs_spsr_ss(struct pt_regs *regs)
177{
178 unsigned long spsr;
179
180 spsr = regs->pstate;
181 spsr &= ~DBG_SPSR_SS;
182 regs->pstate = spsr;
183}
184
ee6214ce
SP
185/* EL1 Single Step Handler hooks */
186static LIST_HEAD(step_hook);
242c04bc 187static DEFINE_RWLOCK(step_hook_lock);
ee6214ce
SP
188
189void register_step_hook(struct step_hook *hook)
190{
191 write_lock(&step_hook_lock);
192 list_add(&hook->node, &step_hook);
193 write_unlock(&step_hook_lock);
194}
195
196void unregister_step_hook(struct step_hook *hook)
197{
198 write_lock(&step_hook_lock);
199 list_del(&hook->node);
200 write_unlock(&step_hook_lock);
201}
202
203/*
95485fdc 204 * Call registered single step handlers
ee6214ce
SP
205 * There is no Syndrome info to check for determining the handler.
206 * So we call all the registered handlers, until the right handler is
207 * found which returns zero.
208 */
209static int call_step_hook(struct pt_regs *regs, unsigned int esr)
210{
211 struct step_hook *hook;
212 int retval = DBG_HOOK_ERROR;
213
214 read_lock(&step_hook_lock);
215
216 list_for_each_entry(hook, &step_hook, node) {
217 retval = hook->fn(regs, esr);
218 if (retval == DBG_HOOK_HANDLED)
219 break;
220 }
221
222 read_unlock(&step_hook_lock);
223
224 return retval;
225}
226
478fcb2c
WD
227static int single_step_handler(unsigned long addr, unsigned int esr,
228 struct pt_regs *regs)
229{
230 siginfo_t info;
231
232 /*
233 * If we are stepping a pending breakpoint, call the hw_breakpoint
234 * handler first.
235 */
236 if (!reinstall_suspended_bps(regs))
237 return 0;
238
239 if (user_mode(regs)) {
240 info.si_signo = SIGTRAP;
241 info.si_errno = 0;
242 info.si_code = TRAP_HWBKPT;
243 info.si_addr = (void __user *)instruction_pointer(regs);
244 force_sig_info(SIGTRAP, &info, current);
245
246 /*
247 * ptrace will disable single step unless explicitly
248 * asked to re-enable it. For other clients, it makes
249 * sense to leave it enabled (i.e. rewind the controls
250 * to the active-not-pending state).
251 */
252 user_rewind_single_step(current);
253 } else {
ee6214ce
SP
254 if (call_step_hook(regs, esr) == DBG_HOOK_HANDLED)
255 return 0;
256
478fcb2c
WD
257 pr_warning("Unexpected kernel single-step exception at EL1\n");
258 /*
259 * Re-enable stepping since we know that we will be
260 * returning to regs.
261 */
262 set_regs_spsr_ss(regs);
263 }
264
265 return 0;
266}
267
ee6214ce
SP
268/*
269 * Breakpoint handler is re-entrant as another breakpoint can
270 * hit within breakpoint handler, especically in kprobes.
271 * Use reader/writer locks instead of plain spinlock.
272 */
273static LIST_HEAD(break_hook);
62c6c61a 274static DEFINE_SPINLOCK(break_hook_lock);
ee6214ce
SP
275
276void register_break_hook(struct break_hook *hook)
277{
62c6c61a
YS
278 spin_lock(&break_hook_lock);
279 list_add_rcu(&hook->node, &break_hook);
280 spin_unlock(&break_hook_lock);
ee6214ce
SP
281}
282
283void unregister_break_hook(struct break_hook *hook)
284{
62c6c61a
YS
285 spin_lock(&break_hook_lock);
286 list_del_rcu(&hook->node);
287 spin_unlock(&break_hook_lock);
288 synchronize_rcu();
ee6214ce
SP
289}
290
291static int call_break_hook(struct pt_regs *regs, unsigned int esr)
292{
293 struct break_hook *hook;
294 int (*fn)(struct pt_regs *regs, unsigned int esr) = NULL;
295
62c6c61a
YS
296 rcu_read_lock();
297 list_for_each_entry_rcu(hook, &break_hook, node)
ee6214ce
SP
298 if ((esr & hook->esr_mask) == hook->esr_val)
299 fn = hook->fn;
62c6c61a 300 rcu_read_unlock();
ee6214ce
SP
301
302 return fn ? fn(regs, esr) : DBG_HOOK_ERROR;
303}
304
1442b6ed
WD
305static int brk_handler(unsigned long addr, unsigned int esr,
306 struct pt_regs *regs)
307{
308 siginfo_t info;
309
c878e0cf
WD
310 if (user_mode(regs)) {
311 info = (siginfo_t) {
312 .si_signo = SIGTRAP,
313 .si_errno = 0,
314 .si_code = TRAP_BRKPT,
315 .si_addr = (void __user *)instruction_pointer(regs),
316 };
ee6214ce 317
c878e0cf
WD
318 force_sig_info(SIGTRAP, &info, current);
319 } else if (call_break_hook(regs, esr) != DBG_HOOK_HANDLED) {
320 pr_warning("Unexpected kernel BRK exception at EL1\n");
1442b6ed 321 return -EFAULT;
c878e0cf 322 }
1442b6ed 323
1442b6ed
WD
324 return 0;
325}
326
327int aarch32_break_handler(struct pt_regs *regs)
328{
329 siginfo_t info;
2dacab73
ML
330 u32 arm_instr;
331 u16 thumb_instr;
1442b6ed
WD
332 bool bp = false;
333 void __user *pc = (void __user *)instruction_pointer(regs);
334
335 if (!compat_user_mode(regs))
336 return -EFAULT;
337
338 if (compat_thumb_mode(regs)) {
339 /* get 16-bit Thumb instruction */
2dacab73
ML
340 get_user(thumb_instr, (u16 __user *)pc);
341 thumb_instr = le16_to_cpu(thumb_instr);
342 if (thumb_instr == AARCH32_BREAK_THUMB2_LO) {
1442b6ed 343 /* get second half of 32-bit Thumb-2 instruction */
2dacab73
ML
344 get_user(thumb_instr, (u16 __user *)(pc + 2));
345 thumb_instr = le16_to_cpu(thumb_instr);
346 bp = thumb_instr == AARCH32_BREAK_THUMB2_HI;
1442b6ed 347 } else {
2dacab73 348 bp = thumb_instr == AARCH32_BREAK_THUMB;
1442b6ed
WD
349 }
350 } else {
351 /* 32-bit ARM instruction */
2dacab73
ML
352 get_user(arm_instr, (u32 __user *)pc);
353 arm_instr = le32_to_cpu(arm_instr);
354 bp = (arm_instr & ~0xf0000000) == AARCH32_BREAK_ARM;
1442b6ed
WD
355 }
356
357 if (!bp)
358 return -EFAULT;
359
360 info = (siginfo_t) {
361 .si_signo = SIGTRAP,
362 .si_errno = 0,
363 .si_code = TRAP_BRKPT,
364 .si_addr = pc,
365 };
366
367 force_sig_info(SIGTRAP, &info, current);
368 return 0;
369}
370
371static int __init debug_traps_init(void)
478fcb2c
WD
372{
373 hook_debug_fault_code(DBG_ESR_EVT_HWSS, single_step_handler, SIGTRAP,
374 TRAP_HWBKPT, "single-step handler");
1442b6ed
WD
375 hook_debug_fault_code(DBG_ESR_EVT_BRK, brk_handler, SIGTRAP,
376 TRAP_BRKPT, "ptrace BRK handler");
478fcb2c
WD
377 return 0;
378}
1442b6ed 379arch_initcall(debug_traps_init);
478fcb2c
WD
380
381/* Re-enable single step for syscall restarting. */
382void user_rewind_single_step(struct task_struct *task)
383{
384 /*
385 * If single step is active for this thread, then set SPSR.SS
386 * to 1 to avoid returning to the active-pending state.
387 */
388 if (test_ti_thread_flag(task_thread_info(task), TIF_SINGLESTEP))
389 set_regs_spsr_ss(task_pt_regs(task));
390}
391
392void user_fastforward_single_step(struct task_struct *task)
393{
394 if (test_ti_thread_flag(task_thread_info(task), TIF_SINGLESTEP))
395 clear_regs_spsr_ss(task_pt_regs(task));
396}
397
398/* Kernel API */
399void kernel_enable_single_step(struct pt_regs *regs)
400{
401 WARN_ON(!irqs_disabled());
402 set_regs_spsr_ss(regs);
403 mdscr_write(mdscr_read() | DBG_MDSCR_SS);
404 enable_debug_monitors(DBG_ACTIVE_EL1);
405}
406
407void kernel_disable_single_step(void)
408{
409 WARN_ON(!irqs_disabled());
410 mdscr_write(mdscr_read() & ~DBG_MDSCR_SS);
411 disable_debug_monitors(DBG_ACTIVE_EL1);
412}
413
414int kernel_active_single_step(void)
415{
416 WARN_ON(!irqs_disabled());
417 return mdscr_read() & DBG_MDSCR_SS;
418}
419
420/* ptrace API */
421void user_enable_single_step(struct task_struct *task)
422{
423 set_ti_thread_flag(task_thread_info(task), TIF_SINGLESTEP);
424 set_regs_spsr_ss(task_pt_regs(task));
425}
426
427void user_disable_single_step(struct task_struct *task)
428{
429 clear_ti_thread_flag(task_thread_info(task), TIF_SINGLESTEP);
430}
This page took 0.159411 seconds and 5 git commands to generate.