Documentation/sysrq.txt

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