Fix documentation of sysrq-q
[linux-2.6.git] / drivers / char / sysrq.c
1 /* -*- linux-c -*-
2  *
3  *      $Id: sysrq.c,v 1.15 1998/08/23 14:56:41 mj Exp $
4  *
5  *      Linux Magic System Request Key Hacks
6  *
7  *      (c) 1997 Martin Mares <mj@atrey.karlin.mff.cuni.cz>
8  *      based on ideas by Pavel Machek <pavel@atrey.karlin.mff.cuni.cz>
9  *
10  *      (c) 2000 Crutcher Dunnavant <crutcher+kernel@datastacks.com>
11  *      overhauled to use key registration
12  *      based upon discusions in irc://irc.openprojects.net/#kernelnewbies
13  */
14
15 #include <linux/sched.h>
16 #include <linux/interrupt.h>
17 #include <linux/mm.h>
18 #include <linux/fs.h>
19 #include <linux/tty.h>
20 #include <linux/mount.h>
21 #include <linux/kdev_t.h>
22 #include <linux/major.h>
23 #include <linux/reboot.h>
24 #include <linux/sysrq.h>
25 #include <linux/kbd_kern.h>
26 #include <linux/proc_fs.h>
27 #include <linux/quotaops.h>
28 #include <linux/kernel.h>
29 #include <linux/module.h>
30 #include <linux/suspend.h>
31 #include <linux/writeback.h>
32 #include <linux/buffer_head.h>          /* for fsync_bdev() */
33 #include <linux/swap.h>
34 #include <linux/spinlock.h>
35 #include <linux/vt_kern.h>
36 #include <linux/workqueue.h>
37 #include <linux/kexec.h>
38 #include <linux/irq.h>
39 #include <linux/hrtimer.h>
40 #include <linux/oom.h>
41
42 #include <asm/ptrace.h>
43 #include <asm/irq_regs.h>
44
45 /* Whether we react on sysrq keys or just ignore them */
46 int __read_mostly __sysrq_enabled = 1;
47
48 static int __read_mostly sysrq_always_enabled;
49
50 int sysrq_on(void)
51 {
52         return __sysrq_enabled || sysrq_always_enabled;
53 }
54
55 /*
56  * A value of 1 means 'all', other nonzero values are an op mask:
57  */
58 static inline int sysrq_on_mask(int mask)
59 {
60         return sysrq_always_enabled || __sysrq_enabled == 1 ||
61                                                 (__sysrq_enabled & mask);
62 }
63
64 static int __init sysrq_always_enabled_setup(char *str)
65 {
66         sysrq_always_enabled = 1;
67         printk(KERN_INFO "debug: sysrq always enabled.\n");
68
69         return 1;
70 }
71
72 __setup("sysrq_always_enabled", sysrq_always_enabled_setup);
73
74
75 static void sysrq_handle_loglevel(int key, struct tty_struct *tty)
76 {
77         int i;
78         i = key - '0';
79         console_loglevel = 7;
80         printk("Loglevel set to %d\n", i);
81         console_loglevel = i;
82 }
83 static struct sysrq_key_op sysrq_loglevel_op = {
84         .handler        = sysrq_handle_loglevel,
85         .help_msg       = "loglevel0-8",
86         .action_msg     = "Changing Loglevel",
87         .enable_mask    = SYSRQ_ENABLE_LOG,
88 };
89
90 #ifdef CONFIG_VT
91 static void sysrq_handle_SAK(int key, struct tty_struct *tty)
92 {
93         struct work_struct *SAK_work = &vc_cons[fg_console].SAK_work;
94         schedule_work(SAK_work);
95 }
96 static struct sysrq_key_op sysrq_SAK_op = {
97         .handler        = sysrq_handle_SAK,
98         .help_msg       = "saK",
99         .action_msg     = "SAK",
100         .enable_mask    = SYSRQ_ENABLE_KEYBOARD,
101 };
102 #else
103 #define sysrq_SAK_op (*(struct sysrq_key_op *)0)
104 #endif
105
106 #ifdef CONFIG_VT
107 static void sysrq_handle_unraw(int key, struct tty_struct *tty)
108 {
109         struct kbd_struct *kbd = &kbd_table[fg_console];
110
111         if (kbd)
112                 kbd->kbdmode = default_utf8 ? VC_UNICODE : VC_XLATE;
113 }
114 static struct sysrq_key_op sysrq_unraw_op = {
115         .handler        = sysrq_handle_unraw,
116         .help_msg       = "unRaw",
117         .action_msg     = "Keyboard mode set to system default",
118         .enable_mask    = SYSRQ_ENABLE_KEYBOARD,
119 };
120 #else
121 #define sysrq_unraw_op (*(struct sysrq_key_op *)0)
122 #endif /* CONFIG_VT */
123
124 #ifdef CONFIG_KEXEC
125 static void sysrq_handle_crashdump(int key, struct tty_struct *tty)
126 {
127         crash_kexec(get_irq_regs());
128 }
129 static struct sysrq_key_op sysrq_crashdump_op = {
130         .handler        = sysrq_handle_crashdump,
131         .help_msg       = "Crashdump",
132         .action_msg     = "Trigger a crashdump",
133         .enable_mask    = SYSRQ_ENABLE_DUMP,
134 };
135 #else
136 #define sysrq_crashdump_op (*(struct sysrq_key_op *)0)
137 #endif
138
139 static void sysrq_handle_reboot(int key, struct tty_struct *tty)
140 {
141         lockdep_off();
142         local_irq_enable();
143         emergency_restart();
144 }
145 static struct sysrq_key_op sysrq_reboot_op = {
146         .handler        = sysrq_handle_reboot,
147         .help_msg       = "reBoot",
148         .action_msg     = "Resetting",
149         .enable_mask    = SYSRQ_ENABLE_BOOT,
150 };
151
152 static void sysrq_handle_sync(int key, struct tty_struct *tty)
153 {
154         emergency_sync();
155 }
156 static struct sysrq_key_op sysrq_sync_op = {
157         .handler        = sysrq_handle_sync,
158         .help_msg       = "Sync",
159         .action_msg     = "Emergency Sync",
160         .enable_mask    = SYSRQ_ENABLE_SYNC,
161 };
162
163 static void sysrq_handle_show_timers(int key, struct tty_struct *tty)
164 {
165         sysrq_timer_list_show();
166 }
167
168 static struct sysrq_key_op sysrq_show_timers_op = {
169         .handler        = sysrq_handle_show_timers,
170         .help_msg       = "show-all-timers(Q)",
171         .action_msg     = "Show pending hrtimers (no others)",
172 };
173
174 static void sysrq_handle_mountro(int key, struct tty_struct *tty)
175 {
176         emergency_remount();
177 }
178 static struct sysrq_key_op sysrq_mountro_op = {
179         .handler        = sysrq_handle_mountro,
180         .help_msg       = "Unmount",
181         .action_msg     = "Emergency Remount R/O",
182         .enable_mask    = SYSRQ_ENABLE_REMOUNT,
183 };
184
185 #ifdef CONFIG_LOCKDEP
186 static void sysrq_handle_showlocks(int key, struct tty_struct *tty)
187 {
188         debug_show_all_locks();
189 }
190
191 static struct sysrq_key_op sysrq_showlocks_op = {
192         .handler        = sysrq_handle_showlocks,
193         .help_msg       = "show-all-locks(D)",
194         .action_msg     = "Show Locks Held",
195 };
196 #else
197 #define sysrq_showlocks_op (*(struct sysrq_key_op *)0)
198 #endif
199
200 #ifdef CONFIG_SMP
201 static DEFINE_SPINLOCK(show_lock);
202
203 static void showacpu(void *dummy)
204 {
205         unsigned long flags;
206
207         /* Idle CPUs have no interesting backtrace. */
208         if (idle_cpu(smp_processor_id()))
209                 return;
210
211         spin_lock_irqsave(&show_lock, flags);
212         printk(KERN_INFO "CPU%d:\n", smp_processor_id());
213         show_stack(NULL, NULL);
214         spin_unlock_irqrestore(&show_lock, flags);
215 }
216
217 static void sysrq_showregs_othercpus(struct work_struct *dummy)
218 {
219         smp_call_function(showacpu, NULL, 0);
220 }
221
222 static DECLARE_WORK(sysrq_showallcpus, sysrq_showregs_othercpus);
223
224 static void sysrq_handle_showallcpus(int key, struct tty_struct *tty)
225 {
226         struct pt_regs *regs = get_irq_regs();
227         if (regs) {
228                 printk(KERN_INFO "CPU%d:\n", smp_processor_id());
229                 show_regs(regs);
230         }
231         schedule_work(&sysrq_showallcpus);
232 }
233
234 static struct sysrq_key_op sysrq_showallcpus_op = {
235         .handler        = sysrq_handle_showallcpus,
236         .help_msg       = "aLlcpus",
237         .action_msg     = "Show backtrace of all active CPUs",
238         .enable_mask    = SYSRQ_ENABLE_DUMP,
239 };
240 #endif
241
242 static void sysrq_handle_showregs(int key, struct tty_struct *tty)
243 {
244         struct pt_regs *regs = get_irq_regs();
245         if (regs)
246                 show_regs(regs);
247 }
248 static struct sysrq_key_op sysrq_showregs_op = {
249         .handler        = sysrq_handle_showregs,
250         .help_msg       = "showPc",
251         .action_msg     = "Show Regs",
252         .enable_mask    = SYSRQ_ENABLE_DUMP,
253 };
254
255 static void sysrq_handle_showstate(int key, struct tty_struct *tty)
256 {
257         show_state();
258 }
259 static struct sysrq_key_op sysrq_showstate_op = {
260         .handler        = sysrq_handle_showstate,
261         .help_msg       = "showTasks",
262         .action_msg     = "Show State",
263         .enable_mask    = SYSRQ_ENABLE_DUMP,
264 };
265
266 static void sysrq_handle_showstate_blocked(int key, struct tty_struct *tty)
267 {
268         show_state_filter(TASK_UNINTERRUPTIBLE);
269 }
270 static struct sysrq_key_op sysrq_showstate_blocked_op = {
271         .handler        = sysrq_handle_showstate_blocked,
272         .help_msg       = "shoW-blocked-tasks",
273         .action_msg     = "Show Blocked State",
274         .enable_mask    = SYSRQ_ENABLE_DUMP,
275 };
276
277
278 static void sysrq_handle_showmem(int key, struct tty_struct *tty)
279 {
280         show_mem();
281 }
282 static struct sysrq_key_op sysrq_showmem_op = {
283         .handler        = sysrq_handle_showmem,
284         .help_msg       = "showMem",
285         .action_msg     = "Show Memory",
286         .enable_mask    = SYSRQ_ENABLE_DUMP,
287 };
288
289 /*
290  * Signal sysrq helper function.  Sends a signal to all user processes.
291  */
292 static void send_sig_all(int sig)
293 {
294         struct task_struct *p;
295
296         for_each_process(p) {
297                 if (p->mm && !is_global_init(p))
298                         /* Not swapper, init nor kernel thread */
299                         force_sig(sig, p);
300         }
301 }
302
303 static void sysrq_handle_term(int key, struct tty_struct *tty)
304 {
305         send_sig_all(SIGTERM);
306         console_loglevel = 8;
307 }
308 static struct sysrq_key_op sysrq_term_op = {
309         .handler        = sysrq_handle_term,
310         .help_msg       = "tErm",
311         .action_msg     = "Terminate All Tasks",
312         .enable_mask    = SYSRQ_ENABLE_SIGNAL,
313 };
314
315 static void moom_callback(struct work_struct *ignored)
316 {
317         out_of_memory(node_zonelist(0, GFP_KERNEL), GFP_KERNEL, 0);
318 }
319
320 static DECLARE_WORK(moom_work, moom_callback);
321
322 static void sysrq_handle_moom(int key, struct tty_struct *tty)
323 {
324         schedule_work(&moom_work);
325 }
326 static struct sysrq_key_op sysrq_moom_op = {
327         .handler        = sysrq_handle_moom,
328         .help_msg       = "Full",
329         .action_msg     = "Manual OOM execution",
330         .enable_mask    = SYSRQ_ENABLE_SIGNAL,
331 };
332
333 static void sysrq_handle_kill(int key, struct tty_struct *tty)
334 {
335         send_sig_all(SIGKILL);
336         console_loglevel = 8;
337 }
338 static struct sysrq_key_op sysrq_kill_op = {
339         .handler        = sysrq_handle_kill,
340         .help_msg       = "kIll",
341         .action_msg     = "Kill All Tasks",
342         .enable_mask    = SYSRQ_ENABLE_SIGNAL,
343 };
344
345 static void sysrq_handle_unrt(int key, struct tty_struct *tty)
346 {
347         normalize_rt_tasks();
348 }
349 static struct sysrq_key_op sysrq_unrt_op = {
350         .handler        = sysrq_handle_unrt,
351         .help_msg       = "Nice",
352         .action_msg     = "Nice All RT Tasks",
353         .enable_mask    = SYSRQ_ENABLE_RTNICE,
354 };
355
356 /* Key Operations table and lock */
357 static DEFINE_SPINLOCK(sysrq_key_table_lock);
358
359 static struct sysrq_key_op *sysrq_key_table[36] = {
360         &sysrq_loglevel_op,             /* 0 */
361         &sysrq_loglevel_op,             /* 1 */
362         &sysrq_loglevel_op,             /* 2 */
363         &sysrq_loglevel_op,             /* 3 */
364         &sysrq_loglevel_op,             /* 4 */
365         &sysrq_loglevel_op,             /* 5 */
366         &sysrq_loglevel_op,             /* 6 */
367         &sysrq_loglevel_op,             /* 7 */
368         &sysrq_loglevel_op,             /* 8 */
369         &sysrq_loglevel_op,             /* 9 */
370
371         /*
372          * a: Don't use for system provided sysrqs, it is handled specially on
373          * sparc and will never arrive.
374          */
375         NULL,                           /* a */
376         &sysrq_reboot_op,               /* b */
377         &sysrq_crashdump_op,            /* c & ibm_emac driver debug */
378         &sysrq_showlocks_op,            /* d */
379         &sysrq_term_op,                 /* e */
380         &sysrq_moom_op,                 /* f */
381         /* g: May be registered by ppc for kgdb */
382         NULL,                           /* g */
383         NULL,                           /* h */
384         &sysrq_kill_op,                 /* i */
385         NULL,                           /* j */
386         &sysrq_SAK_op,                  /* k */
387 #ifdef CONFIG_SMP
388         &sysrq_showallcpus_op,          /* l */
389 #else
390         NULL,                           /* l */
391 #endif
392         &sysrq_showmem_op,              /* m */
393         &sysrq_unrt_op,                 /* n */
394         /* o: This will often be registered as 'Off' at init time */
395         NULL,                           /* o */
396         &sysrq_showregs_op,             /* p */
397         &sysrq_show_timers_op,          /* q */
398         &sysrq_unraw_op,                /* r */
399         &sysrq_sync_op,                 /* s */
400         &sysrq_showstate_op,            /* t */
401         &sysrq_mountro_op,              /* u */
402         /* v: May be registered at init time by SMP VOYAGER */
403         NULL,                           /* v */
404         &sysrq_showstate_blocked_op,    /* w */
405         /* x: May be registered on ppc/powerpc for xmon */
406         NULL,                           /* x */
407         /* y: May be registered on sparc64 for global register dump */
408         NULL,                           /* y */
409         NULL                            /* z */
410 };
411
412 /* key2index calculation, -1 on invalid index */
413 static int sysrq_key_table_key2index(int key)
414 {
415         int retval;
416
417         if ((key >= '0') && (key <= '9'))
418                 retval = key - '0';
419         else if ((key >= 'a') && (key <= 'z'))
420                 retval = key + 10 - 'a';
421         else
422                 retval = -1;
423         return retval;
424 }
425
426 /*
427  * get and put functions for the table, exposed to modules.
428  */
429 struct sysrq_key_op *__sysrq_get_key_op(int key)
430 {
431         struct sysrq_key_op *op_p = NULL;
432         int i;
433
434         i = sysrq_key_table_key2index(key);
435         if (i != -1)
436                 op_p = sysrq_key_table[i];
437         return op_p;
438 }
439
440 static void __sysrq_put_key_op(int key, struct sysrq_key_op *op_p)
441 {
442         int i = sysrq_key_table_key2index(key);
443
444         if (i != -1)
445                 sysrq_key_table[i] = op_p;
446 }
447
448 /*
449  * This is the non-locking version of handle_sysrq.  It must/can only be called
450  * by sysrq key handlers, as they are inside of the lock
451  */
452 void __handle_sysrq(int key, struct tty_struct *tty, int check_mask)
453 {
454         struct sysrq_key_op *op_p;
455         int orig_log_level;
456         int i;
457         unsigned long flags;
458
459         spin_lock_irqsave(&sysrq_key_table_lock, flags);
460         orig_log_level = console_loglevel;
461         console_loglevel = 7;
462         printk(KERN_INFO "SysRq : ");
463
464         op_p = __sysrq_get_key_op(key);
465         if (op_p) {
466                 /*
467                  * Should we check for enabled operations (/proc/sysrq-trigger
468                  * should not) and is the invoked operation enabled?
469                  */
470                 if (!check_mask || sysrq_on_mask(op_p->enable_mask)) {
471                         printk("%s\n", op_p->action_msg);
472                         console_loglevel = orig_log_level;
473                         op_p->handler(key, tty);
474                 } else {
475                         printk("This sysrq operation is disabled.\n");
476                 }
477         } else {
478                 printk("HELP : ");
479                 /* Only print the help msg once per handler */
480                 for (i = 0; i < ARRAY_SIZE(sysrq_key_table); i++) {
481                         if (sysrq_key_table[i]) {
482                                 int j;
483
484                                 for (j = 0; sysrq_key_table[i] !=
485                                                 sysrq_key_table[j]; j++)
486                                         ;
487                                 if (j != i)
488                                         continue;
489                                 printk("%s ", sysrq_key_table[i]->help_msg);
490                         }
491                 }
492                 printk("\n");
493                 console_loglevel = orig_log_level;
494         }
495         spin_unlock_irqrestore(&sysrq_key_table_lock, flags);
496 }
497
498 /*
499  * This function is called by the keyboard handler when SysRq is pressed
500  * and any other keycode arrives.
501  */
502 void handle_sysrq(int key, struct tty_struct *tty)
503 {
504         if (sysrq_on())
505                 __handle_sysrq(key, tty, 1);
506 }
507 EXPORT_SYMBOL(handle_sysrq);
508
509 static int __sysrq_swap_key_ops(int key, struct sysrq_key_op *insert_op_p,
510                                 struct sysrq_key_op *remove_op_p)
511 {
512
513         int retval;
514         unsigned long flags;
515
516         spin_lock_irqsave(&sysrq_key_table_lock, flags);
517         if (__sysrq_get_key_op(key) == remove_op_p) {
518                 __sysrq_put_key_op(key, insert_op_p);
519                 retval = 0;
520         } else {
521                 retval = -1;
522         }
523         spin_unlock_irqrestore(&sysrq_key_table_lock, flags);
524         return retval;
525 }
526
527 int register_sysrq_key(int key, struct sysrq_key_op *op_p)
528 {
529         return __sysrq_swap_key_ops(key, op_p, NULL);
530 }
531 EXPORT_SYMBOL(register_sysrq_key);
532
533 int unregister_sysrq_key(int key, struct sysrq_key_op *op_p)
534 {
535         return __sysrq_swap_key_ops(key, NULL, op_p);
536 }
537 EXPORT_SYMBOL(unregister_sysrq_key);
538
539 #ifdef CONFIG_PROC_FS
540 /*
541  * writing 'C' to /proc/sysrq-trigger is like sysrq-C
542  */
543 static ssize_t write_sysrq_trigger(struct file *file, const char __user *buf,
544                                    size_t count, loff_t *ppos)
545 {
546         if (count) {
547                 char c;
548
549                 if (get_user(c, buf))
550                         return -EFAULT;
551                 __handle_sysrq(c, NULL, 0);
552         }
553         return count;
554 }
555
556 static const struct file_operations proc_sysrq_trigger_operations = {
557         .write          = write_sysrq_trigger,
558 };
559
560 static int __init sysrq_init(void)
561 {
562         proc_create("sysrq-trigger", S_IWUSR, NULL, &proc_sysrq_trigger_operations);
563         return 0;
564 }
565 module_init(sysrq_init);
566 #endif