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/quotaops.h>
  27 #include <linux/smp_lock.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
  40 #include <asm/ptrace.h>
  41 #include <asm/irq_regs.h>
  42
  43 /* Whether we react on sysrq keys or just ignore them */
  44 int __read_mostly __sysrq_enabled = 1;
  45
  46 static int __read_mostly sysrq_always_enabled;
  47
  48 int sysrq_on(void)
  49 {
  50         return __sysrq_enabled || sysrq_always_enabled;
  51 }
  52
  53 /*
  54  * A value of 1 means 'all', other nonzero values are an op mask:
  55  */
  56 static inline int sysrq_on_mask(int mask)
  57 {
  58         return sysrq_always_enabled || __sysrq_enabled == 1 ||
  59                                                 (__sysrq_enabled & mask);
  60 }
  61
  62 static int __init sysrq_always_enabled_setup(char *str)
  63 {
  64         sysrq_always_enabled = 1;
  65         printk(KERN_INFO "debug: sysrq always enabled.\n");
  66
  67         return 1;
  68 }
  69
  70 __setup("sysrq_always_enabled", sysrq_always_enabled_setup);
  71
  72
  73 static void sysrq_handle_loglevel(int key, struct tty_struct *tty)
  74 {
  75         int i;
  76         i = key - '0';
  77         console_loglevel = 7;
  78         printk("Loglevel set to %d\n", i);
  79         console_loglevel = i;
  80 }
  81 static struct sysrq_key_op sysrq_loglevel_op = {
  82         .handler        = sysrq_handle_loglevel,
  83         .help_msg       = "loglevel0-8",
  84         .action_msg     = "Changing Loglevel",
  85         .enable_mask    = SYSRQ_ENABLE_LOG,
  86 };
  87
  88 #ifdef CONFIG_VT
  89 static void sysrq_handle_SAK(int key, struct tty_struct *tty)
  90 {
  91         struct work_struct *SAK_work = &vc_cons[fg_console].SAK_work;
  92         schedule_work(SAK_work);
  93 }
  94 static struct sysrq_key_op sysrq_SAK_op = {
  95         .handler        = sysrq_handle_SAK,
  96         .help_msg       = "saK",
  97         .action_msg     = "SAK",
  98         .enable_mask    = SYSRQ_ENABLE_KEYBOARD,
  99 };
 100 #else
 101 #define sysrq_SAK_op (*(struct sysrq_key_op *)0)
 102 #endif
 103
 104 #ifdef CONFIG_VT
 105 static void sysrq_handle_unraw(int key, struct tty_struct *tty)
 106 {
 107         struct kbd_struct *kbd = &kbd_table[fg_console];
 108
 109         if (kbd)
 110                 kbd->kbdmode = VC_XLATE;
 111 }
 112 static struct sysrq_key_op sysrq_unraw_op = {
 113         .handler        = sysrq_handle_unraw,
 114         .help_msg       = "unRaw",
 115         .action_msg     = "Keyboard mode set to XLATE",
 116         .enable_mask    = SYSRQ_ENABLE_KEYBOARD,
 117 };
 118 #else
 119 #define sysrq_unraw_op (*(struct sysrq_key_op *)0)
 120 #endif /* CONFIG_VT */
 121
 122 #ifdef CONFIG_KEXEC
 123 static void sysrq_handle_crashdump(int key, struct tty_struct *tty)
 124 {
 125         crash_kexec(get_irq_regs());
 126 }
 127 static struct sysrq_key_op sysrq_crashdump_op = {
 128         .handler        = sysrq_handle_crashdump,
 129         .help_msg       = "Crashdump",
 130         .action_msg     = "Trigger a crashdump",
 131         .enable_mask    = SYSRQ_ENABLE_DUMP,
 132 };
 133 #else
 134 #define sysrq_crashdump_op (*(struct sysrq_key_op *)0)
 135 #endif
 136
 137 static void sysrq_handle_reboot(int key, struct tty_struct *tty)
 138 {
 139         lockdep_off();
 140         local_irq_enable();
 141         emergency_restart();
 142 }
 143 static struct sysrq_key_op sysrq_reboot_op = {
 144         .handler        = sysrq_handle_reboot,
 145         .help_msg       = "reBoot",
 146         .action_msg     = "Resetting",
 147         .enable_mask    = SYSRQ_ENABLE_BOOT,
 148 };
 149
 150 static void sysrq_handle_sync(int key, struct tty_struct *tty)
 151 {
 152         emergency_sync();
 153 }
 154 static struct sysrq_key_op sysrq_sync_op = {
 155         .handler        = sysrq_handle_sync,
 156         .help_msg       = "Sync",
 157         .action_msg     = "Emergency Sync",
 158         .enable_mask    = SYSRQ_ENABLE_SYNC,
 159 };
 160
 161 static void sysrq_handle_mountro(int key, struct tty_struct *tty)
 162 {
 163         emergency_remount();
 164 }
 165 static struct sysrq_key_op sysrq_mountro_op = {
 166         .handler        = sysrq_handle_mountro,
 167         .help_msg       = "Unmount",
 168         .action_msg     = "Emergency Remount R/O",
 169         .enable_mask    = SYSRQ_ENABLE_REMOUNT,
 170 };
 171
 172 #ifdef CONFIG_LOCKDEP
 173 static void sysrq_handle_showlocks(int key, struct tty_struct *tty)
 174 {
 175         debug_show_all_locks();
 176 }
 177
 178 static struct sysrq_key_op sysrq_showlocks_op = {
 179         .handler        = sysrq_handle_showlocks,
 180         .help_msg       = "show-all-locks(D)",
 181         .action_msg     = "Show Locks Held",
 182 };
 183 #else
 184 #define sysrq_showlocks_op (*(struct sysrq_key_op *)0)
 185 #endif
 186
 187 static void sysrq_handle_showregs(int key, struct tty_struct *tty)
 188 {
 189         struct pt_regs *regs = get_irq_regs();
 190         if (regs)
 191                 show_regs(regs);
 192 }
 193 static struct sysrq_key_op sysrq_showregs_op = {
 194         .handler        = sysrq_handle_showregs,
 195         .help_msg       = "showPc",
 196         .action_msg     = "Show Regs",
 197         .enable_mask    = SYSRQ_ENABLE_DUMP,
 198 };
 199
 200 static void sysrq_handle_showstate(int key, struct tty_struct *tty)
 201 {
 202         show_state();
 203 }
 204 static struct sysrq_key_op sysrq_showstate_op = {
 205         .handler        = sysrq_handle_showstate,
 206         .help_msg       = "showTasks",
 207         .action_msg     = "Show State",
 208         .enable_mask    = SYSRQ_ENABLE_DUMP,
 209 };
 210
 211 static void sysrq_handle_showstate_blocked(int key, struct tty_struct *tty)
 212 {
 213         show_state_filter(TASK_UNINTERRUPTIBLE);
 214 }
 215 static struct sysrq_key_op sysrq_showstate_blocked_op = {
 216         .handler        = sysrq_handle_showstate_blocked,
 217         .help_msg       = "shoW-blocked-tasks",
 218         .action_msg     = "Show Blocked State",
 219         .enable_mask    = SYSRQ_ENABLE_DUMP,
 220 };
 221
 222
 223 static void sysrq_handle_showmem(int key, struct tty_struct *tty)
 224 {
 225         show_mem();
 226 }
 227 static struct sysrq_key_op sysrq_showmem_op = {
 228         .handler        = sysrq_handle_showmem,
 229         .help_msg       = "showMem",
 230         .action_msg     = "Show Memory",
 231         .enable_mask    = SYSRQ_ENABLE_DUMP,
 232 };
 233
 234 /*
 235  * Signal sysrq helper function.  Sends a signal to all user processes.
 236  */
 237 static void send_sig_all(int sig)
 238 {
 239         struct task_struct *p;
 240
 241         for_each_process(p) {
 242                 if (p->mm && !is_init(p))
 243                         /* Not swapper, init nor kernel thread */
 244                         force_sig(sig, p);
 245         }
 246 }
 247
 248 static void sysrq_handle_term(int key, struct tty_struct *tty)
 249 {
 250         send_sig_all(SIGTERM);
 251         console_loglevel = 8;
 252 }
 253 static struct sysrq_key_op sysrq_term_op = {
 254         .handler        = sysrq_handle_term,
 255         .help_msg       = "tErm",
 256         .action_msg     = "Terminate All Tasks",
 257         .enable_mask    = SYSRQ_ENABLE_SIGNAL,
 258 };
 259
 260 static void moom_callback(struct work_struct *ignored)
 261 {
 262         out_of_memory(&NODE_DATA(0)->node_zonelists[ZONE_NORMAL],
 263                         GFP_KERNEL, 0);
 264 }
 265
 266 static DECLARE_WORK(moom_work, moom_callback);
 267
 268 static void sysrq_handle_moom(int key, struct tty_struct *tty)
 269 {
 270         schedule_work(&moom_work);
 271 }
 272 static struct sysrq_key_op sysrq_moom_op = {
 273         .handler        = sysrq_handle_moom,
 274         .help_msg       = "Full",
 275         .action_msg     = "Manual OOM execution",
 276 };
 277
 278 static void sysrq_handle_kill(int key, struct tty_struct *tty)
 279 {
 280         send_sig_all(SIGKILL);
 281         console_loglevel = 8;
 282 }
 283 static struct sysrq_key_op sysrq_kill_op = {
 284         .handler        = sysrq_handle_kill,
 285         .help_msg       = "kIll",
 286         .action_msg     = "Kill All Tasks",
 287         .enable_mask    = SYSRQ_ENABLE_SIGNAL,
 288 };
 289
 290 static void sysrq_handle_unrt(int key, struct tty_struct *tty)
 291 {
 292         normalize_rt_tasks();
 293 }
 294 static struct sysrq_key_op sysrq_unrt_op = {
 295         .handler        = sysrq_handle_unrt,
 296         .help_msg       = "Nice",
 297         .action_msg     = "Nice All RT Tasks",
 298         .enable_mask    = SYSRQ_ENABLE_RTNICE,
 299 };
 300
 301 /* Key Operations table and lock */
 302 static DEFINE_SPINLOCK(sysrq_key_table_lock);
 303
 304 static struct sysrq_key_op *sysrq_key_table[36] = {
 305         &sysrq_loglevel_op,             /* 0 */
 306         &sysrq_loglevel_op,             /* 1 */
 307         &sysrq_loglevel_op,             /* 2 */
 308         &sysrq_loglevel_op,             /* 3 */
 309         &sysrq_loglevel_op,             /* 4 */
 310         &sysrq_loglevel_op,             /* 5 */
 311         &sysrq_loglevel_op,             /* 6 */
 312         &sysrq_loglevel_op,             /* 7 */
 313         &sysrq_loglevel_op,             /* 8 */
 314         &sysrq_loglevel_op,             /* 9 */
 315
 316         /*
 317          * a: Don't use for system provided sysrqs, it is handled specially on
 318          * sparc and will never arrive.
 319          */
 320         NULL,                           /* a */
 321         &sysrq_reboot_op,               /* b */
 322         &sysrq_crashdump_op,            /* c & ibm_emac driver debug */
 323         &sysrq_showlocks_op,            /* d */
 324         &sysrq_term_op,                 /* e */
 325         &sysrq_moom_op,                 /* f */
 326         /* g: May be registered by ppc for kgdb */
 327         NULL,                           /* g */
 328         NULL,                           /* h */
 329         &sysrq_kill_op,                 /* i */
 330         NULL,                           /* j */
 331         &sysrq_SAK_op,                  /* k */
 332         NULL,                           /* l */
 333         &sysrq_showmem_op,              /* m */
 334         &sysrq_unrt_op,                 /* n */
 335         /* o: This will often be registered as 'Off' at init time */
 336         NULL,                           /* o */
 337         &sysrq_showregs_op,             /* p */
 338         NULL,                           /* q */
 339         &sysrq_unraw_op,                /* r */
 340         &sysrq_sync_op,                 /* s */
 341         &sysrq_showstate_op,            /* t */
 342         &sysrq_mountro_op,              /* u */
 343         /* v: May be registered at init time by SMP VOYAGER */
 344         NULL,                           /* v */
 345         &sysrq_showstate_blocked_op,    /* w */
 346         /* x: May be registered on ppc/powerpc for xmon */
 347         NULL,                           /* x */
 348         NULL,                           /* y */
 349         NULL                            /* z */
 350 };
 351
 352 /* key2index calculation, -1 on invalid index */
 353 static int sysrq_key_table_key2index(int key)
 354 {
 355         int retval;
 356
 357         if ((key >= '0') && (key <= '9'))
 358                 retval = key - '0';
 359         else if ((key >= 'a') && (key <= 'z'))
 360                 retval = key + 10 - 'a';
 361         else
 362                 retval = -1;
 363         return retval;
 364 }
 365
 366 /*
 367  * get and put functions for the table, exposed to modules.
 368  */
 369 struct sysrq_key_op *__sysrq_get_key_op(int key)
 370 {
 371         struct sysrq_key_op *op_p = NULL;
 372         int i;
 373
 374         i = sysrq_key_table_key2index(key);
 375         if (i != -1)
 376                 op_p = sysrq_key_table[i];
 377         return op_p;
 378 }
 379
 380 static void __sysrq_put_key_op(int key, struct sysrq_key_op *op_p)
 381 {
 382         int i = sysrq_key_table_key2index(key);
 383
 384         if (i != -1)
 385                 sysrq_key_table[i] = op_p;
 386 }
 387
 388 /*
 389  * This is the non-locking version of handle_sysrq.  It must/can only be called
 390  * by sysrq key handlers, as they are inside of the lock
 391  */
 392 void __handle_sysrq(int key, struct tty_struct *tty, int check_mask)
 393 {
 394         struct sysrq_key_op *op_p;
 395         int orig_log_level;
 396         int i;
 397         unsigned long flags;
 398
 399         spin_lock_irqsave(&sysrq_key_table_lock, flags);
 400         orig_log_level = console_loglevel;
 401         console_loglevel = 7;
 402         printk(KERN_INFO "SysRq : ");
 403
 404         op_p = __sysrq_get_key_op(key);
 405         if (op_p) {
 406                 /*
 407                  * Should we check for enabled operations (/proc/sysrq-trigger
 408                  * should not) and is the invoked operation enabled?
 409                  */
 410                 if (!check_mask || sysrq_on_mask(op_p->enable_mask)) {
 411                         printk("%s\n", op_p->action_msg);
 412                         console_loglevel = orig_log_level;
 413                         op_p->handler(key, tty);
 414                 } else {
 415                         printk("This sysrq operation is disabled.\n");
 416                 }
 417         } else {
 418                 printk("HELP : ");
 419                 /* Only print the help msg once per handler */
 420                 for (i = 0; i < ARRAY_SIZE(sysrq_key_table); i++) {
 421                         if (sysrq_key_table[i]) {
 422                                 int j;
 423
 424                                 for (j = 0; sysrq_key_table[i] !=
 425                                                 sysrq_key_table[j]; j++)
 426                                         ;
 427                                 if (j != i)
 428                                         continue;
 429                                 printk("%s ", sysrq_key_table[i]->help_msg);
 430                         }
 431                 }
 432                 printk("\n");
 433                 console_loglevel = orig_log_level;
 434         }
 435         spin_unlock_irqrestore(&sysrq_key_table_lock, flags);
 436 }
 437
 438 /*
 439  * This function is called by the keyboard handler when SysRq is pressed
 440  * and any other keycode arrives.
 441  */
 442 void handle_sysrq(int key, struct tty_struct *tty)
 443 {
 444         if (sysrq_on())
 445                 __handle_sysrq(key, tty, 1);
 446 }
 447 EXPORT_SYMBOL(handle_sysrq);
 448
 449 static int __sysrq_swap_key_ops(int key, struct sysrq_key_op *insert_op_p,
 450                                 struct sysrq_key_op *remove_op_p)
 451 {
 452
 453         int retval;
 454         unsigned long flags;
 455
 456         spin_lock_irqsave(&sysrq_key_table_lock, flags);
 457         if (__sysrq_get_key_op(key) == remove_op_p) {
 458                 __sysrq_put_key_op(key, insert_op_p);
 459                 retval = 0;
 460         } else {
 461                 retval = -1;
 462         }
 463         spin_unlock_irqrestore(&sysrq_key_table_lock, flags);
 464         return retval;
 465 }
 466
 467 int register_sysrq_key(int key, struct sysrq_key_op *op_p)
 468 {
 469         return __sysrq_swap_key_ops(key, op_p, NULL);
 470 }
 471 EXPORT_SYMBOL(register_sysrq_key);
 472
 473 int unregister_sysrq_key(int key, struct sysrq_key_op *op_p)
 474 {
 475         return __sysrq_swap_key_ops(key, NULL, op_p);
 476 }
 477 EXPORT_SYMBOL(unregister_sysrq_key);