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