2 * Linux Magic System Request Key Hacks
4 * (c) 1997 Martin Mares <mj@atrey.karlin.mff.cuni.cz>
5 * based on ideas by Pavel Machek <pavel@atrey.karlin.mff.cuni.cz>
7 * (c) 2000 Crutcher Dunnavant <crutcher+kernel@datastacks.com>
8 * overhauled to use key registration
9 * based upon discusions in irc://irc.openprojects.net/#kernelnewbies
11 * Copyright (c) 2010 Dmitry Torokhov
12 * Input handler conversion
15 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
17 #include <linux/sched.h>
18 #include <linux/interrupt.h>
21 #include <linux/mount.h>
22 #include <linux/kdev_t.h>
23 #include <linux/major.h>
24 #include <linux/reboot.h>
25 #include <linux/sysrq.h>
26 #include <linux/kbd_kern.h>
27 #include <linux/proc_fs.h>
28 #include <linux/nmi.h>
29 #include <linux/quotaops.h>
30 #include <linux/perf_event.h>
31 #include <linux/kernel.h>
32 #include <linux/module.h>
33 #include <linux/suspend.h>
34 #include <linux/writeback.h>
35 #include <linux/swap.h>
36 #include <linux/spinlock.h>
37 #include <linux/vt_kern.h>
38 #include <linux/workqueue.h>
39 #include <linux/hrtimer.h>
40 #include <linux/oom.h>
41 #include <linux/slab.h>
42 #include <linux/input.h>
43 #include <linux/uaccess.h>
44 #include <linux/delay.h>
46 #include <asm/ptrace.h>
47 #include <asm/irq_regs.h>
49 /* Whether we react on sysrq keys or just ignore them */
50 static int __read_mostly sysrq_enabled = SYSRQ_DEFAULT_ENABLE;
51 static bool __read_mostly sysrq_always_enabled;
53 static bool sysrq_on(void)
55 return sysrq_enabled || sysrq_always_enabled;
59 * A value of 1 means 'all', other nonzero values are an op mask:
61 static bool sysrq_on_mask(int mask)
63 return sysrq_always_enabled ||
65 (sysrq_enabled & mask);
68 static int __init sysrq_always_enabled_setup(char *str)
70 sysrq_always_enabled = true;
71 pr_info("sysrq always enabled.\n");
76 __setup("sysrq_always_enabled", sysrq_always_enabled_setup);
79 static void sysrq_handle_loglevel(int key)
85 printk("Loglevel set to %d\n", i);
88 static struct sysrq_key_op sysrq_loglevel_op = {
89 .handler = sysrq_handle_loglevel,
90 .help_msg = "loglevel(0-9)",
91 .action_msg = "Changing Loglevel",
92 .enable_mask = SYSRQ_ENABLE_LOG,
96 static void sysrq_handle_SAK(int key)
98 struct work_struct *SAK_work = &vc_cons[fg_console].SAK_work;
99 schedule_work(SAK_work);
101 static struct sysrq_key_op sysrq_SAK_op = {
102 .handler = sysrq_handle_SAK,
105 .enable_mask = SYSRQ_ENABLE_KEYBOARD,
108 #define sysrq_SAK_op (*(struct sysrq_key_op *)NULL)
112 static void sysrq_handle_unraw(int key)
114 vt_reset_unicode(fg_console);
117 static struct sysrq_key_op sysrq_unraw_op = {
118 .handler = sysrq_handle_unraw,
120 .action_msg = "Keyboard mode set to system default",
121 .enable_mask = SYSRQ_ENABLE_KEYBOARD,
124 #define sysrq_unraw_op (*(struct sysrq_key_op *)NULL)
125 #endif /* CONFIG_VT */
127 static void sysrq_handle_crash(int key)
131 panic_on_oops = 1; /* force panic */
135 static struct sysrq_key_op sysrq_crash_op = {
136 .handler = sysrq_handle_crash,
138 .action_msg = "Trigger a crash",
139 .enable_mask = SYSRQ_ENABLE_DUMP,
142 static void sysrq_handle_reboot(int key)
148 static struct sysrq_key_op sysrq_reboot_op = {
149 .handler = sysrq_handle_reboot,
150 .help_msg = "reBoot",
151 .action_msg = "Resetting",
152 .enable_mask = SYSRQ_ENABLE_BOOT,
155 static void sysrq_handle_sync(int key)
159 static struct sysrq_key_op sysrq_sync_op = {
160 .handler = sysrq_handle_sync,
162 .action_msg = "Emergency Sync",
163 .enable_mask = SYSRQ_ENABLE_SYNC,
166 static void sysrq_handle_show_timers(int key)
168 sysrq_timer_list_show();
171 static struct sysrq_key_op sysrq_show_timers_op = {
172 .handler = sysrq_handle_show_timers,
173 .help_msg = "show-all-timers(Q)",
174 .action_msg = "Show clockevent devices & pending hrtimers (no others)",
177 static void sysrq_handle_mountro(int key)
181 static struct sysrq_key_op sysrq_mountro_op = {
182 .handler = sysrq_handle_mountro,
183 .help_msg = "Unmount",
184 .action_msg = "Emergency Remount R/O",
185 .enable_mask = SYSRQ_ENABLE_REMOUNT,
188 #ifdef CONFIG_LOCKDEP
189 static void sysrq_handle_showlocks(int key)
191 debug_show_all_locks();
194 static struct sysrq_key_op sysrq_showlocks_op = {
195 .handler = sysrq_handle_showlocks,
196 .help_msg = "show-all-locks(D)",
197 .action_msg = "Show Locks Held",
200 #define sysrq_showlocks_op (*(struct sysrq_key_op *)NULL)
204 static DEFINE_SPINLOCK(show_lock);
206 static void showacpu(void *dummy)
210 /* Idle CPUs have no interesting backtrace. */
211 if (idle_cpu(smp_processor_id()))
214 spin_lock_irqsave(&show_lock, flags);
215 printk(KERN_INFO "CPU%d:\n", smp_processor_id());
216 show_stack(NULL, NULL);
217 spin_unlock_irqrestore(&show_lock, flags);
220 static void sysrq_showregs_othercpus(struct work_struct *dummy)
222 smp_call_function(showacpu, NULL, 0);
225 static DECLARE_WORK(sysrq_showallcpus, sysrq_showregs_othercpus);
227 static void sysrq_handle_showallcpus(int key)
230 * Fall back to the workqueue based printing if the
231 * backtrace printing did not succeed or the
232 * architecture has no support for it:
234 if (!trigger_all_cpu_backtrace()) {
235 struct pt_regs *regs = get_irq_regs();
238 printk(KERN_INFO "CPU%d:\n", smp_processor_id());
241 schedule_work(&sysrq_showallcpus);
245 static struct sysrq_key_op sysrq_showallcpus_op = {
246 .handler = sysrq_handle_showallcpus,
247 .help_msg = "show-backtrace-all-active-cpus(L)",
248 .action_msg = "Show backtrace of all active CPUs",
249 .enable_mask = SYSRQ_ENABLE_DUMP,
253 static void sysrq_handle_showregs(int key)
255 struct pt_regs *regs = get_irq_regs();
258 perf_event_print_debug();
260 static struct sysrq_key_op sysrq_showregs_op = {
261 .handler = sysrq_handle_showregs,
262 .help_msg = "show-registers(P)",
263 .action_msg = "Show Regs",
264 .enable_mask = SYSRQ_ENABLE_DUMP,
267 static void sysrq_handle_showstate(int key)
271 static struct sysrq_key_op sysrq_showstate_op = {
272 .handler = sysrq_handle_showstate,
273 .help_msg = "show-task-states(T)",
274 .action_msg = "Show State",
275 .enable_mask = SYSRQ_ENABLE_DUMP,
278 static void sysrq_handle_showstate_blocked(int key)
280 show_state_filter(TASK_UNINTERRUPTIBLE);
282 static struct sysrq_key_op sysrq_showstate_blocked_op = {
283 .handler = sysrq_handle_showstate_blocked,
284 .help_msg = "show-blocked-tasks(W)",
285 .action_msg = "Show Blocked State",
286 .enable_mask = SYSRQ_ENABLE_DUMP,
289 #ifdef CONFIG_TRACING
290 #include <linux/ftrace.h>
292 static void sysrq_ftrace_dump(int key)
294 ftrace_dump(DUMP_ALL);
296 static struct sysrq_key_op sysrq_ftrace_dump_op = {
297 .handler = sysrq_ftrace_dump,
298 .help_msg = "dump-ftrace-buffer(Z)",
299 .action_msg = "Dump ftrace buffer",
300 .enable_mask = SYSRQ_ENABLE_DUMP,
303 #define sysrq_ftrace_dump_op (*(struct sysrq_key_op *)NULL)
306 static void sysrq_handle_showmem(int key)
310 static struct sysrq_key_op sysrq_showmem_op = {
311 .handler = sysrq_handle_showmem,
312 .help_msg = "show-memory-usage(M)",
313 .action_msg = "Show Memory",
314 .enable_mask = SYSRQ_ENABLE_DUMP,
318 * Signal sysrq helper function. Sends a signal to all user processes.
320 static void send_sig_all(int sig)
322 struct task_struct *p;
324 read_lock(&tasklist_lock);
325 for_each_process(p) {
326 if (p->flags & PF_KTHREAD)
328 if (is_global_init(p))
331 do_send_sig_info(sig, SEND_SIG_FORCED, p, true);
333 read_unlock(&tasklist_lock);
336 static void sysrq_handle_term(int key)
338 send_sig_all(SIGTERM);
339 console_loglevel = 8;
341 static struct sysrq_key_op sysrq_term_op = {
342 .handler = sysrq_handle_term,
343 .help_msg = "terminate-all-tasks(E)",
344 .action_msg = "Terminate All Tasks",
345 .enable_mask = SYSRQ_ENABLE_SIGNAL,
348 static void moom_callback(struct work_struct *ignored)
350 out_of_memory(node_zonelist(0, GFP_KERNEL), GFP_KERNEL, 0, NULL, true);
353 static DECLARE_WORK(moom_work, moom_callback);
355 static void sysrq_handle_moom(int key)
357 schedule_work(&moom_work);
359 static struct sysrq_key_op sysrq_moom_op = {
360 .handler = sysrq_handle_moom,
361 .help_msg = "memory-full-oom-kill(F)",
362 .action_msg = "Manual OOM execution",
363 .enable_mask = SYSRQ_ENABLE_SIGNAL,
367 static void sysrq_handle_thaw(int key)
369 emergency_thaw_all();
371 static struct sysrq_key_op sysrq_thaw_op = {
372 .handler = sysrq_handle_thaw,
373 .help_msg = "thaw-filesystems(J)",
374 .action_msg = "Emergency Thaw of all frozen filesystems",
375 .enable_mask = SYSRQ_ENABLE_SIGNAL,
379 static void sysrq_handle_kill(int key)
381 send_sig_all(SIGKILL);
382 console_loglevel = 8;
384 static struct sysrq_key_op sysrq_kill_op = {
385 .handler = sysrq_handle_kill,
386 .help_msg = "kill-all-tasks(I)",
387 .action_msg = "Kill All Tasks",
388 .enable_mask = SYSRQ_ENABLE_SIGNAL,
391 static void sysrq_handle_unrt(int key)
393 normalize_rt_tasks();
395 static struct sysrq_key_op sysrq_unrt_op = {
396 .handler = sysrq_handle_unrt,
397 .help_msg = "nice-all-RT-tasks(N)",
398 .action_msg = "Nice All RT Tasks",
399 .enable_mask = SYSRQ_ENABLE_RTNICE,
402 static void sysrq_handle_cros_xkey(int key)
404 sysrq_handle_showstate_blocked(key);
405 sysrq_handle_sync(key);
406 mdelay(1000); /* Delay for a bit to give time for sync to complete */
407 sysrq_handle_crash(key);
410 static struct sysrq_key_op sysrq_cros_xkey = {
411 .handler = sysrq_handle_cros_xkey,
412 .help_msg = "Cros-dump-and-crash",
413 .action_msg = "Cros dump and crash",
414 .enable_mask = SYSRQ_ENABLE_CROS_XKEY,
417 /* Key Operations table and lock */
418 static DEFINE_SPINLOCK(sysrq_key_table_lock);
420 static struct sysrq_key_op *sysrq_key_table[36] = {
421 &sysrq_loglevel_op, /* 0 */
422 &sysrq_loglevel_op, /* 1 */
423 &sysrq_loglevel_op, /* 2 */
424 &sysrq_loglevel_op, /* 3 */
425 &sysrq_loglevel_op, /* 4 */
426 &sysrq_loglevel_op, /* 5 */
427 &sysrq_loglevel_op, /* 6 */
428 &sysrq_loglevel_op, /* 7 */
429 &sysrq_loglevel_op, /* 8 */
430 &sysrq_loglevel_op, /* 9 */
433 * a: Don't use for system provided sysrqs, it is handled specially on
434 * sparc and will never arrive.
437 &sysrq_reboot_op, /* b */
438 &sysrq_crash_op, /* c & ibm_emac driver debug */
439 &sysrq_showlocks_op, /* d */
440 &sysrq_term_op, /* e */
441 &sysrq_moom_op, /* f */
442 /* g: May be registered for the kernel debugger */
444 NULL, /* h - reserved for help */
445 &sysrq_kill_op, /* i */
447 &sysrq_thaw_op, /* j */
451 &sysrq_SAK_op, /* k */
453 &sysrq_showallcpus_op, /* l */
457 &sysrq_showmem_op, /* m */
458 &sysrq_unrt_op, /* n */
459 /* o: This will often be registered as 'Off' at init time */
461 &sysrq_showregs_op, /* p */
462 &sysrq_show_timers_op, /* q */
463 &sysrq_unraw_op, /* r */
464 &sysrq_sync_op, /* s */
465 &sysrq_showstate_op, /* t */
466 &sysrq_mountro_op, /* u */
467 /* v: May be registered for frame buffer console restore */
469 &sysrq_showstate_blocked_op, /* w */
471 * x: May be registered on ppc/powerpc for xmon. On Chrome OS, this
472 * is the dump and crash key.
474 &sysrq_cros_xkey, /* x */
475 /* y: May be registered on sparc64 for global register dump */
477 &sysrq_ftrace_dump_op, /* z */
480 /* key2index calculation, -1 on invalid index */
481 static int sysrq_key_table_key2index(int key)
485 if ((key >= '0') && (key <= '9'))
487 else if ((key >= 'a') && (key <= 'z'))
488 retval = key + 10 - 'a';
495 * get and put functions for the table, exposed to modules.
497 struct sysrq_key_op *__sysrq_get_key_op(int key)
499 struct sysrq_key_op *op_p = NULL;
502 i = sysrq_key_table_key2index(key);
504 op_p = sysrq_key_table[i];
509 static void __sysrq_put_key_op(int key, struct sysrq_key_op *op_p)
511 int i = sysrq_key_table_key2index(key);
514 sysrq_key_table[i] = op_p;
517 void __handle_sysrq(int key, bool check_mask)
519 struct sysrq_key_op *op_p;
524 spin_lock_irqsave(&sysrq_key_table_lock, flags);
526 * Raise the apparent loglevel to maximum so that the sysrq header
527 * is shown to provide the user with positive feedback. We do not
528 * simply emit this at KERN_EMERG as that would change message
529 * routing in the consumers of /proc/kmsg.
531 orig_log_level = console_loglevel;
532 console_loglevel = 7;
533 printk(KERN_INFO "SysRq : ");
535 op_p = __sysrq_get_key_op(key);
538 * Should we check for enabled operations (/proc/sysrq-trigger
539 * should not) and is the invoked operation enabled?
541 if (!check_mask || sysrq_on_mask(op_p->enable_mask)) {
542 printk("%s\n", op_p->action_msg);
543 console_loglevel = orig_log_level;
546 printk("This sysrq operation is disabled.\n");
550 /* Only print the help msg once per handler */
551 for (i = 0; i < ARRAY_SIZE(sysrq_key_table); i++) {
552 if (sysrq_key_table[i]) {
555 for (j = 0; sysrq_key_table[i] !=
556 sysrq_key_table[j]; j++)
560 printk("%s ", sysrq_key_table[i]->help_msg);
564 console_loglevel = orig_log_level;
566 spin_unlock_irqrestore(&sysrq_key_table_lock, flags);
569 void handle_sysrq(int key)
572 __handle_sysrq(key, true);
574 EXPORT_SYMBOL(handle_sysrq);
578 /* Simple translation table for the SysRq keys */
579 static const unsigned char sysrq_xlate[KEY_CNT] =
580 "\000\0331234567890-=\177\t" /* 0x00 - 0x0f */
581 "qwertyuiop[]\r\000as" /* 0x10 - 0x1f */
582 "dfghjkl;'`\000\\zxcv" /* 0x20 - 0x2f */
583 "bnm,./\000*\000 \000\201\202\203\204\205" /* 0x30 - 0x3f */
584 "\206\207\210\211\212\000\000789-456+1" /* 0x40 - 0x4f */
585 "230\177\000\000\213\214\000\000\000\000\000\000\000\000\000\000" /* 0x50 - 0x5f */
586 "\r\000/"; /* 0x60 - 0x6f */
589 struct input_handle handle;
590 struct work_struct reinject_work;
591 unsigned long key_down[BITS_TO_LONGS(KEY_CNT)];
593 unsigned int alt_use;
599 static void sysrq_reinject_alt_sysrq(struct work_struct *work)
601 struct sysrq_state *sysrq =
602 container_of(work, struct sysrq_state, reinject_work);
603 struct input_handle *handle = &sysrq->handle;
604 unsigned int alt_code = sysrq->alt_use;
606 if (sysrq->need_reinject) {
607 /* we do not want the assignment to be reordered */
608 sysrq->reinjecting = true;
611 /* Simulate press and release of Alt + SysRq */
612 input_inject_event(handle, EV_KEY, alt_code, 1);
613 input_inject_event(handle, EV_KEY, KEY_SYSRQ, 1);
614 input_inject_event(handle, EV_SYN, SYN_REPORT, 1);
616 input_inject_event(handle, EV_KEY, KEY_SYSRQ, 0);
617 input_inject_event(handle, EV_KEY, alt_code, 0);
618 input_inject_event(handle, EV_SYN, SYN_REPORT, 1);
621 sysrq->reinjecting = false;
625 static bool sysrq_filter(struct input_handle *handle,
626 unsigned int type, unsigned int code, int value)
628 struct sysrq_state *sysrq = handle->private;
629 bool was_active = sysrq->active;
633 * Do not filter anything if we are in the process of re-injecting
634 * Alt+SysRq combination.
636 if (sysrq->reinjecting)
651 /* One of ALTs is being released */
652 if (sysrq->active && code == sysrq->alt_use)
653 sysrq->active = false;
655 sysrq->alt = KEY_RESERVED;
657 } else if (value != 2) {
659 sysrq->need_reinject = false;
665 if (value == 1 && sysrq->alt != KEY_RESERVED) {
666 sysrq->active = true;
667 sysrq->alt_use = sysrq->alt;
669 * If nothing else will be pressed we'll need
670 * to re-inject Alt-SysRq keysroke.
672 sysrq->need_reinject = true;
676 * Pretend that sysrq was never pressed at all. This
677 * is needed to properly handle KGDB which will try
678 * to release all keys after exiting debugger. If we
679 * do not clear key bit it KGDB will end up sending
680 * release events for Alt and SysRq, potentially
681 * triggering print screen function.
684 clear_bit(KEY_SYSRQ, handle->dev->key);
689 if (sysrq->active && value && value != 2) {
690 sysrq->need_reinject = false;
691 __handle_sysrq(sysrq_xlate[code], true);
696 suppress = sysrq->active;
698 if (!sysrq->active) {
700 * If we are not suppressing key presses keep track of
701 * keyboard state so we can release keys that have been
702 * pressed before entering SysRq mode.
705 set_bit(code, sysrq->key_down);
707 clear_bit(code, sysrq->key_down);
710 schedule_work(&sysrq->reinject_work);
712 } else if (value == 0 &&
713 test_and_clear_bit(code, sysrq->key_down)) {
715 * Pass on release events for keys that was pressed before
716 * entering SysRq mode.
723 suppress = sysrq->active;
730 static int sysrq_connect(struct input_handler *handler,
731 struct input_dev *dev,
732 const struct input_device_id *id)
734 struct sysrq_state *sysrq;
737 sysrq = kzalloc(sizeof(struct sysrq_state), GFP_KERNEL);
741 INIT_WORK(&sysrq->reinject_work, sysrq_reinject_alt_sysrq);
743 sysrq->handle.dev = dev;
744 sysrq->handle.handler = handler;
745 sysrq->handle.name = "sysrq";
746 sysrq->handle.private = sysrq;
748 error = input_register_handle(&sysrq->handle);
750 pr_err("Failed to register input sysrq handler, error %d\n",
755 error = input_open_device(&sysrq->handle);
757 pr_err("Failed to open input device, error %d\n", error);
764 input_unregister_handle(&sysrq->handle);
770 static void sysrq_disconnect(struct input_handle *handle)
772 struct sysrq_state *sysrq = handle->private;
774 input_close_device(handle);
775 cancel_work_sync(&sysrq->reinject_work);
776 input_unregister_handle(handle);
781 * We are matching on KEY_LEFTALT instead of KEY_SYSRQ because not all
782 * keyboards have SysRq key predefined and so user may add it to keymap
783 * later, but we expect all such keyboards to have left alt.
785 static const struct input_device_id sysrq_ids[] = {
787 .flags = INPUT_DEVICE_ID_MATCH_EVBIT |
788 INPUT_DEVICE_ID_MATCH_KEYBIT,
789 .evbit = { BIT_MASK(EV_KEY) },
790 .keybit = { BIT_MASK(KEY_LEFTALT) },
795 static struct input_handler sysrq_handler = {
796 .filter = sysrq_filter,
797 .connect = sysrq_connect,
798 .disconnect = sysrq_disconnect,
800 .id_table = sysrq_ids,
803 static bool sysrq_handler_registered;
805 static inline void sysrq_register_handler(void)
809 error = input_register_handler(&sysrq_handler);
811 pr_err("Failed to register input handler, error %d", error);
813 sysrq_handler_registered = true;
816 static inline void sysrq_unregister_handler(void)
818 if (sysrq_handler_registered) {
819 input_unregister_handler(&sysrq_handler);
820 sysrq_handler_registered = false;
826 static inline void sysrq_register_handler(void)
830 static inline void sysrq_unregister_handler(void)
834 #endif /* CONFIG_INPUT */
836 int sysrq_toggle_support(int enable_mask)
838 bool was_enabled = sysrq_on();
840 sysrq_enabled = enable_mask;
842 if (was_enabled != sysrq_on()) {
844 sysrq_register_handler();
846 sysrq_unregister_handler();
852 static int __sysrq_swap_key_ops(int key, struct sysrq_key_op *insert_op_p,
853 struct sysrq_key_op *remove_op_p)
858 spin_lock_irqsave(&sysrq_key_table_lock, flags);
859 if (__sysrq_get_key_op(key) == remove_op_p) {
860 __sysrq_put_key_op(key, insert_op_p);
865 spin_unlock_irqrestore(&sysrq_key_table_lock, flags);
869 int register_sysrq_key(int key, struct sysrq_key_op *op_p)
871 return __sysrq_swap_key_ops(key, op_p, NULL);
873 EXPORT_SYMBOL(register_sysrq_key);
875 int unregister_sysrq_key(int key, struct sysrq_key_op *op_p)
877 return __sysrq_swap_key_ops(key, NULL, op_p);
879 EXPORT_SYMBOL(unregister_sysrq_key);
881 #ifdef CONFIG_PROC_FS
883 * writing 'C' to /proc/sysrq-trigger is like sysrq-C
885 static ssize_t write_sysrq_trigger(struct file *file, const char __user *buf,
886 size_t count, loff_t *ppos)
891 if (get_user(c, buf))
893 __handle_sysrq(c, false);
899 static const struct file_operations proc_sysrq_trigger_operations = {
900 .write = write_sysrq_trigger,
901 .llseek = noop_llseek,
904 static void sysrq_init_procfs(void)
906 if (!proc_create("sysrq-trigger", S_IWUSR, NULL,
907 &proc_sysrq_trigger_operations))
908 pr_err("Failed to register proc interface\n");
913 static inline void sysrq_init_procfs(void)
917 #endif /* CONFIG_PROC_FS */
919 static int __init sysrq_init(void)
924 sysrq_register_handler();
928 module_init(sysrq_init);