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