arch/arm64/kernel/debug-monitors.c

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