Documentation/sysrq.txt

   1 Linux Magic System Request Key Hacks
   2 Documentation for sysrq.c
   3
   4 *  What is the magic SysRq key?
   5 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   6 It is a 'magical' key combo you can hit which the kernel will respond to
   7 regardless of whatever else it is doing, unless it is completely locked up.
   8
   9 *  How do I enable the magic SysRq key?
  10 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  11 You need to say "yes" to 'Magic SysRq key (CONFIG_MAGIC_SYSRQ)' when
  12 configuring the kernel. When running a kernel with SysRq compiled in,
  13 /proc/sys/kernel/sysrq controls the functions allowed to be invoked via
  14 the SysRq key. By default the file contains 1 which means that every
  15 possible SysRq request is allowed (in older versions SysRq was disabled
  16 by default, and you were required to specifically enable it at run-time
  17 but this is not the case any more). Here is the list of possible values
  18 in /proc/sys/kernel/sysrq:
  19    0 - disable sysrq completely
  20    1 - enable all functions of sysrq
  21   >1 - bitmask of allowed sysrq functions (see below for detailed function
  22        description):
  23           2 =   0x2 - enable control of console logging level
  24           4 =   0x4 - enable control of keyboard (SAK, unraw)
  25           8 =   0x8 - enable debugging dumps of processes etc.
  26          16 =  0x10 - enable sync command
  27          32 =  0x20 - enable remount read-only
  28          64 =  0x40 - enable signalling of processes (term, kill, oom-kill)
  29         128 =  0x80 - allow reboot/poweroff
  30         256 = 0x100 - allow nicing of all RT tasks
  31
  32 You can set the value in the file by the following command:
  33     echo "number" >/proc/sys/kernel/sysrq
  34
  35 The number may be written either as decimal or as hexadecimal with the
  36 0x prefix.
  37
  38 Note that the value of /proc/sys/kernel/sysrq influences only the invocation
  39 via a keyboard. Invocation of any operation via /proc/sysrq-trigger is always
  40 allowed (by a user with admin privileges).
  41
  42 *  How do I use the magic SysRq key?
  43 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  44 On x86   - You press the key combo 'ALT-SysRq-<command key>'. Note - Some
  45            keyboards may not have a key labeled 'SysRq'. The 'SysRq' key is
  46            also known as the 'Print Screen' key. Also some keyboards cannot
  47            handle so many keys being pressed at the same time, so you might
  48            have better luck with "press Alt", "press SysRq", "release SysRq",
  49            "press <command key>", release everything.
  50
  51 On SPARC - You press 'ALT-STOP-<command key>', I believe.
  52
  53 On the serial console (PC style standard serial ports only) -
  54            You send a BREAK, then within 5 seconds a command key. Sending
  55            BREAK twice is interpreted as a normal BREAK.
  56
  57 On PowerPC - Press 'ALT - Print Screen (or F13) - <command key>,
  58              Print Screen (or F13) - <command key> may suffice.
  59
  60 On other - If you know of the key combos for other architectures, please
  61            let me know so I can add them to this section.
  62
  63 On all -  write a character to /proc/sysrq-trigger.  e.g.:
  64
  65                 echo t > /proc/sysrq-trigger
  66
  67 *  What are the 'command' keys?
  68 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  69 'b'     - Will immediately reboot the system without syncing or unmounting
  70           your disks.
  71
  72 'c'     - Will perform a system crash by a NULL pointer dereference.
  73           A crashdump will be taken if configured.
  74
  75 'd'     - Shows all locks that are held.
  76
  77 'e'     - Send a SIGTERM to all processes, except for init.
  78
  79 'f'     - Will call oom_kill to kill a memory hog process.
  80
  81 'g'     - Used by kgdb (kernel debugger)
  82
  83 'h'     - Will display help (actually any other key than those listed
  84           here will display help. but 'h' is easy to remember :-)
  85
  86 'i'     - Send a SIGKILL to all processes, except for init.
  87
  88 'j'     - Forcibly "Just thaw it" - filesystems frozen by the FIFREEZE ioctl.
  89
  90 'k'     - Secure Access Key (SAK) Kills all programs on the current virtual
  91           console. NOTE: See important comments below in SAK section.
  92
  93 'l'     - Shows a stack backtrace for all active CPUs.
  94
  95 'm'     - Will dump current memory info to your console.
  96
  97 'n'     - Used to make RT tasks nice-able
  98
  99 'o'     - Will shut your system off (if configured and supported).
 100
 101 'p'     - Will dump the current registers and flags to your console.
 102
 103 'q'     - Will dump per CPU lists of all armed hrtimers (but NOT regular
 104           timer_list timers) and detailed information about all
 105           clockevent devices.
 106
 107 'r'     - Turns off keyboard raw mode and sets it to XLATE.
 108
 109 's'     - Will attempt to sync all mounted filesystems.
 110
 111 't'     - Will dump a list of current tasks and their information to your
 112           console.
 113
 114 'u'     - Will attempt to remount all mounted filesystems read-only.
 115
 116 'v'     - Forcefully restores framebuffer console
 117 'v'     - Causes ETM buffer dump [ARM-specific]
 118
 119 'w'     - Dumps tasks that are in uninterruptable (blocked) state.
 120
 121 'x'     - Used by xmon interface on ppc/powerpc platforms.
 122           Show global PMU Registers on sparc64.
 123
 124 'y'     - Show global CPU Registers [SPARC-64 specific]
 125
 126 'z'     - Dump the ftrace buffer
 127
 128 '0'-'9' - Sets the console log level, controlling which kernel messages
 129           will be printed to your console. ('0', for example would make
 130           it so that only emergency messages like PANICs or OOPSes would
 131           make it to your console.)
 132
 133 *  Okay, so what can I use them for?
 134 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 Well, unraw(r) is very handy when your X server or a svgalib program crashes.
 136
 137 sak(k) (Secure Access Key) is useful when you want to be sure there is no
 138 trojan program running at console which could grab your password
 139 when you would try to login. It will kill all programs on given console,
 140 thus letting you make sure that the login prompt you see is actually
 141 the one from init, not some trojan program.
 142 IMPORTANT: In its true form it is not a true SAK like the one in a :IMPORTANT
 143 IMPORTANT: c2 compliant system, and it should not be mistaken as   :IMPORTANT
 144 IMPORTANT: such.                                                   :IMPORTANT
 145        It seems others find it useful as (System Attention Key) which is
 146 useful when you want to exit a program that will not let you switch consoles.
 147 (For example, X or a svgalib program.)
 148
 149 reboot(b) is good when you're unable to shut down. But you should also
 150 sync(s) and umount(u) first.
 151
 152 crash(c) can be used to manually trigger a crashdump when the system is hung.
 153 Note that this just triggers a crash if there is no dump mechanism available.
 154
 155 sync(s) is great when your system is locked up, it allows you to sync your
 156 disks and will certainly lessen the chance of data loss and fscking. Note
 157 that the sync hasn't taken place until you see the "OK" and "Done" appear
 158 on the screen. (If the kernel is really in strife, you may not ever get the
 159 OK or Done message...)
 160
 161 umount(u) is basically useful in the same ways as sync(s). I generally sync(s),
 162 umount(u), then reboot(b) when my system locks. It's saved me many a fsck.
 163 Again, the unmount (remount read-only) hasn't taken place until you see the
 164 "OK" and "Done" message appear on the screen.
 165
 166 The loglevels '0'-'9' are useful when your console is being flooded with
 167 kernel messages you do not want to see. Selecting '0' will prevent all but
 168 the most urgent kernel messages from reaching your console. (They will
 169 still be logged if syslogd/klogd are alive, though.)
 170
 171 term(e) and kill(i) are useful if you have some sort of runaway process you
 172 are unable to kill any other way, especially if it's spawning other
 173 processes.
 174
 175 "just thaw it(j)" is useful if your system becomes unresponsive due to a frozen
 176 (probably root) filesystem via the FIFREEZE ioctl.
 177
 178 *  Sometimes SysRq seems to get 'stuck' after using it, what can I do?
 179 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 180 That happens to me, also. I've found that tapping shift, alt, and control
 181 on both sides of the keyboard, and hitting an invalid sysrq sequence again
 182 will fix the problem. (i.e., something like alt-sysrq-z). Switching to another
 183 virtual console (ALT+Fn) and then back again should also help.
 184
 185 *  I hit SysRq, but nothing seems to happen, what's wrong?
 186 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 187 There are some keyboards that produce a different keycode for SysRq than the
 188 pre-defined value of 99 (see KEY_SYSRQ in include/linux/input.h), or which
 189 don't have a SysRq key at all. In these cases, run 'showkey -s' to find an
 190 appropriate scancode sequence, and use 'setkeycodes <sequence> 99' to map
 191 this sequence to the usual SysRq code (e.g., 'setkeycodes e05b 99'). It's
 192 probably best to put this command in a boot script. Oh, and by the way, you
 193 exit 'showkey' by not typing anything for ten seconds.
 194
 195 *  I want to add SysRQ key events to a module, how does it work?
 196 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 197 In order to register a basic function with the table, you must first include
 198 the header 'include/linux/sysrq.h', this will define everything else you need.
 199 Next, you must create a sysrq_key_op struct, and populate it with A) the key
 200 handler function you will use, B) a help_msg string, that will print when SysRQ
 201 prints help, and C) an action_msg string, that will print right before your
 202 handler is called. Your handler must conform to the prototype in 'sysrq.h'.
 203
 204 After the sysrq_key_op is created, you can call the kernel function
 205 register_sysrq_key(int key, struct sysrq_key_op *op_p); this will
 206 register the operation pointed to by 'op_p' at table key 'key',
 207 if that slot in the table is blank. At module unload time, you must call
 208 the function unregister_sysrq_key(int key, struct sysrq_key_op *op_p), which
 209 will remove the key op pointed to by 'op_p' from the key 'key', if and only if
 210 it is currently registered in that slot. This is in case the slot has been
 211 overwritten since you registered it.
 212
 213 The Magic SysRQ system works by registering key operations against a key op
 214 lookup table, which is defined in 'drivers/char/sysrq.c'. This key table has
 215 a number of operations registered into it at compile time, but is mutable,
 216 and 2 functions are exported for interface to it:
 217         register_sysrq_key and unregister_sysrq_key.
 218 Of course, never ever leave an invalid pointer in the table. I.e., when
 219 your module that called register_sysrq_key() exits, it must call
 220 unregister_sysrq_key() to clean up the sysrq key table entry that it used.
 221 Null pointers in the table are always safe. :)
 222
 223 If for some reason you feel the need to call the handle_sysrq function from
 224 within a function called by handle_sysrq, you must be aware that you are in
 225 a lock (you are also in an interrupt handler, which means don't sleep!), so
 226 you must call __handle_sysrq_nolock instead.
 227
 228 *  When I hit a SysRq key combination only the header appears on the console?
 229 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 230 Sysrq output is subject to the same console loglevel control as all
 231 other console output.  This means that if the kernel was booted 'quiet'
 232 as is common on distro kernels the output may not appear on the actual
 233 console, even though it will appear in the dmesg buffer, and be accessible
 234 via the dmesg command and to the consumers of /proc/kmsg.  As a specific
 235 exception the header line from the sysrq command is passed to all console
 236 consumers as if the current loglevel was maximum.  If only the header
 237 is emitted it is almost certain that the kernel loglevel is too low.
 238 Should you require the output on the console channel then you will need
 239 to temporarily up the console loglevel using alt-sysrq-8 or:
 240
 241     echo 8 > /proc/sysrq-trigger
 242
 243 Remember to return the loglevel to normal after triggering the sysrq
 244 command you are interested in.
 245
 246 *  I have more questions, who can I ask?
 247 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 248 Just ask them on the linux-kernel mailing list:
 249         linux-kernel@vger.kernel.org
 250
 251 *  Credits
 252 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 253 Written by Mydraal <vulpyne@vulpyne.net>
 254 Updated by Adam Sulmicki <adam@cfar.umd.edu>
 255 Updated by Jeremy M. Dolan <jmd@turbogeek.org> 2001/01/28 10:15:59
 256 Added to by Crutcher Dunnavant <crutcher+kernel@datastacks.com>