kernel/linux/Documentation/sysrq.txt

   1 Linux Magic System Request Key Hacks
   2 Documentation for sysrq.c version 1.15
   3 Last update: $Date: 2006/04/12 06:25:09 $
   4
   5 *  What is the magic SysRq key?
   6 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   7 It is a 'magical' key combo you can hit which the kernel will respond to
   8 regardless of whatever else it is doing, unless it is completely locked up.
   9
  10 *  How do I enable the magic SysRq key?
  11 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  12 You need to say "yes" to 'Magic SysRq key (CONFIG_MAGIC_SYSRQ)' when
  13 configuring the kernel. When running on a kernel with SysRq compiled in, it
  14 may be DISABLED at run-time using following command:
  15
  16         echo "0" > /proc/sys/kernel/sysrq
  17
  18 Note that previous versions disabled sysrq by default, and you were required
  19 to specifically enable it at run-time. That is not the case any longer.
  20
  21 *  How do I use the magic SysRq key?
  22 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  23 On x86   - You press the key combo 'ALT-SysRq-<command key>'. Note - Some
  24            keyboards may not have a key labeled 'SysRq'. The 'SysRq' key is
  25            also known as the 'Print Screen' key. Also some keyboards cannot
  26            handle so many keys being pressed at the same time, so you might
  27            have better luck with "press Alt", "press SysRq", "release Alt",
  28            "press <command key>", release everything.
  29
  30 On SPARC - You press 'ALT-STOP-<command key>', I believe.
  31
  32 On the serial console (PC style standard serial ports only) -
  33            You send a BREAK, then within 5 seconds a command key. Sending
  34            BREAK twice is interpreted as a normal BREAK.
  35
  36 On PowerPC - Press 'ALT - Print Screen (or F13) - <command key>,
  37              Print Screen (or F13) - <command key> may suffice.
  38
  39 On other - If you know of the key combos for other architectures, please
  40            let me know so I can add them to this section.
  41
  42 On all -  write a character to /proc/sysrq-trigger.  eg:
  43
  44                 echo t > /proc/sysrq-trigger
  45
  46 *  What are the 'command' keys?
  47 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  48 'r'     - Turns off keyboard raw mode and sets it to XLATE.
  49
  50 'k'     - Secure Access Key (SAK) Kills all programs on the current virtual
  51           console. NOTE: See important comments below in SAK section.
  52
  53 'b'     - Will immediately reboot the system without syncing or unmounting
  54           your disks.
  55
  56 'o'     - Will shut your system off (if configured and supported).
  57
  58 's'     - Will attempt to sync all mounted filesystems.
  59
  60 'u'     - Will attempt to remount all mounted filesystems read-only.
  61
  62 'p'     - Will dump the current registers and flags to your console.
  63
  64 't'     - Will dump a list of current tasks and their information to your
  65           console.
  66
  67 'm'     - Will dump current memory info to your console.
  68
  69 'v'     - Dumps Voyager SMP processor info to your console.
  70
  71 '0'-'9' - Sets the console log level, controlling which kernel messages
  72           will be printed to your console. ('0', for example would make
  73           it so that only emergency messages like PANICs or OOPSes would
  74           make it to your console.)
  75
  76 'e'     - Send a SIGTERM to all processes, except for init.
  77
  78 'i'     - Send a SIGKILL to all processes, except for init.
  79
  80 'l'     - Send a SIGKILL to all processes, INCLUDING init. (Your system
  81           will be non-functional after this.)
  82
  83 'h'     - Will display help ( actually any other key than those listed
  84           above will display help. but 'h' is easy to remember :-)
  85
  86 *  Okay, so what can I use them for?
  87 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  88 Well, un'R'aw is very handy when your X server or a svgalib program crashes.
  89
  90 sa'K' (Secure Access Key) is useful when you want to be sure there are no
  91 trojan program is running at console and which could grab your password
  92 when you would try to login. It will kill all programs on given console
  93 and thus letting you make sure that the login prompt you see is actually
  94 the one from init, not some trojan program.
  95 IMPORTANT:In its true form it is not a true SAK like the one in   :IMPORTANT
  96 IMPORTANT:c2 compliant systems, and it should be mistook as such. :IMPORTANT
  97        It seems other find it useful as (System Attention Key) which is
  98 useful when you want to exit a program that will not let you switch consoles.
  99 (For example, X or a svgalib program.)
 100
 101 re'B'oot is good when you're unable to shut down. But you should also 'S'ync
 102 and 'U'mount first.
 103
 104 'S'ync is great when your system is locked up, it allows you to sync your
 105 disks and will certainly lessen the chance of data loss and fscking. Note
 106 that the sync hasn't taken place until you see the "OK" and "Done" appear
 107 on the screen. (If the kernel is really in strife, you may not ever get the
 108 OK or Done message...)
 109
 110 'U'mount is basically useful in the same ways as 'S'ync. I generally 'S'ync,
 111 'U'mount, then re'B'oot when my system locks. It's saved me many a fsck.
 112 Again, the unmount (remount read-only) hasn't taken place until you see the
 113 "OK" and "Done" message appear on the screen.
 114
 115 The loglevel'0'-'9' is useful when your console is being flooded with
 116 kernel messages you do not want to see. Setting '0' will prevent all but
 117 the most urgent kernel messages from reaching your console. (They will
 118 still be logged if syslogd/klogd are alive, though.)
 119
 120 t'E'rm and k'I'll are useful if you have some sort of runaway process you
 121 are unable to kill any other way, especially if it's spawning other
 122 processes.
 123
 124 *  Sometimes SysRq seems to get 'stuck' after using it, what can I do?
 125 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 126 That happens to me, also. I've found that tapping shift, alt, and control
 127 on both sides of the keyboard, and hitting an invalid sysrq sequence again
 128 will fix the problem. (ie, something like alt-sysrq-z). Switching to another
 129 virtual console (ALT+Fn) and then back again should also help.
 130
 131 *  I hit SysRq, but nothing seems to happen, what's wrong?
 132 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 There are some keyboards that send different scancodes for SysRq than the
 134 pre-defined 0x54. So if SysRq doesn't work out of the box for a certain
 135 keyboard, run 'showkey -s' to find out the proper scancode sequence. Then
 136 use 'setkeycodes <sequence> 84' to define this sequence to the usual SysRq
 137 code (84 is decimal for 0x54). It's probably best to put this command in a
 138 boot script. Oh, and by the way, you exit 'showkey' by not typing anything
 139 for ten seconds.
 140
 141 *  I want to add SysRQ key events to a module, how does it work?
 142 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 143 In order to register a basic function with the table, you must first include
 144 the header 'include/linux/sysrq.h', this will define everything else you need.
 145 Next, you must create a sysrq_key_op struct, and populate it with A) the key
 146 handler function you will use, B) a help_msg string, that will print when SysRQ
 147 prints help, and C) an action_msg string, that will print right before your
 148 handler is called. Your handler must conform to the protoype in 'sysrq.h'.
 149
 150 After the sysrq_key_op is created, you can call the macro
 151 register_sysrq_key(int key, struct sysrq_key_op *op_p) that is defined in
 152 sysrq.h, this will register the operation pointed to by 'op_p' at table
 153 key 'key', if that slot in the table is blank. At module unload time, you must
 154 call the macro unregister_sysrq_key(int key, struct sysrq_key_op *op_p), which
 155 will remove the key op pointed to by 'op_p' from the key 'key', if and only if
 156 it is currently registered in that slot. This is in case the slot has been
 157 overwritten since you registered it.
 158
 159 The Magic SysRQ system works by registering key operations against a key op
 160 lookup table, which is defined in 'drivers/char/sysrq.c'. This key table has
 161 a number of operations registered into it at compile time, but is mutable,
 162 and 4 functions are exported for interface to it: __sysrq_lock_table,
 163 __sysrq_unlock_table, __sysrq_get_key_op, and __sysrq_put_key_op. The
 164 functions __sysrq_swap_key_ops and __sysrq_swap_key_ops_nolock are defined
 165 in the header itself, and the REGISTER and UNREGISTER macros are built from
 166 these. More complex (and dangerous!) manipulations of the table are possible
 167 using these functions, but you must be careful to always lock the table before
 168 you read or write from it, and to unlock it again when you are done. (And of
 169 course, to never ever leave an invalid pointer in the table). Null pointers in
 170 the table are always safe :)
 171
 172 If for some reason you feel the need to call the handle_sysrq function from
 173 within a function called by handle_sysrq, you must be aware that you are in
 174 a lock (you are also in an interrupt handler, which means don't sleep!), so
 175 you must call __handle_sysrq_nolock instead.
 176
 177 *  I have more questions, who can I ask?
 178 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 179 You may feel free to send email to myrdraal@deathsdoor.com, and I will
 180 respond as soon as possible.
 181  -Myrdraal
 182
 183 And I'll answer any questions about the registration system you got, also
 184 responding as soon as possible.
 185  -Crutcher
 186
 187 *  Credits
 188 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 189 Written by Mydraal <myrdraal@deathsdoor.com>
 190 Updated by Adam Sulmicki <adam@cfar.umd.edu>
 191 Updated by Jeremy M. Dolan <jmd@turbogeek.org> 2001/01/28 10:15:59
 192 Added to by Crutcher Dunnavant <crutcher+kernel@datastacks.com>