Magic_SysRq_key

Magic SysRq key

Magic SysRq key

Keyboard commands for recovering a Linux machine


The magic SysRq key is a key combination understood by the Linux kernel, which allows the user to perform various low-level commands regardless of the system's state. It is often used to recover from freezes, or to reboot a computer without corrupting the filesystem.[1] Its effect is similar to the computer's hardware reset button (or power switch) but with many more options and much more control.

The SysRq key

This key combination provides access to features for disaster recovery. In this sense, it can be considered a form of escape sequence. Principal among the offered commands are means to forcibly unmount file systems, kill processes, recover keyboard state, and write unwritten data to disk.

The magic SysRq key cannot work under certain conditions, such as a kernel panic[2] or a hardware failure preventing the kernel from running properly.

Commands

The key combination consists of Alt+SysRq and another key, which controls the command issued. SysRq may be released before pressing the command key, as long as Alt remains held down.

The combinations always assume the QWERTY keyboard layout;[citation needed] for example, on the Dvorak keyboard layout, the combination to shut down the system uses the R key instead of O. Furthermore, some keyboards may not provide a separate SysRq key. In this case, a separate PrtScn key should be present.

On some devices, notably laptops, the Fn key may need to be pressed to use the magic SysRq key, e.g. on Thinkpad Carbon X1 the SysRq is activated by pressing Alt+Fn+S simultaneously, then releasing Fn and S while still holding Alt.[3] On a ChromeOS device, SysRq is activated by pressing Alt+Volume Up (F10)+<key>.

SysRq functionalities can also be accessed without a keyboard. See § Other ways to invoke Magic SysRq below. Note that some commands may be disabled out of the box as specified in the bitmask value in /proc/sys/kernel/sysrq.[4]

More information Action, QWERTY ...

Example output of the SysRq+h command:

sysrq: HELP : loglevel(0-9) reboot(b) crash(c) terminate-all-tasks(e) memory-full-oom-kill(f) kill-all-tasks(i) thaw-filesystems(j) sak(k) show-backtrace-all-active-cpus(l) show-memory-usage(m) nice-all-RT-tasks(n) poweroff(o) show-registers(p) show-all-timers(q) unraw(r) sync(s) show-task-states(t) unmount(u) force-fb(v) show-blocked-tasks(w) dump-ftrace-buffer(z)

Uses

Before the advent of journaled filesystems a common use of the magic SysRq key was to perform a safe reboot of a Linux computer which has otherwise locked up (abbr. REISUB), which avoided a risk of filesystem corruption. With modern filesystems, this practice is not encouraged, offering no upsides over straight reboot,[7] though the default value of kernel.sysrq in such distributions as Ubuntu and Debian remains 176 and 438 [8] respectively.

Another past use was to kill a frozen graphical program, as the X Window System used to have complete control over graphical mode and input devices.

On distributions that do not include a textmode command, the key command Ctrl+Alt+F1 may sometimes be able to force a return to a text console. (Use F1, F2, F3, ... , Fn, where n is the highest number of text consoles set up by the distribution. Ctrl+Alt+F(n+1) would normally be used to reenter GUI mode on a system on which the X server has not crashed.) There are also distributions where Ctrl+Alt + (F3, ... ,F(n-2)) opens text consoles, Ctrl+Alt+F1 reenter GUI mode, Ctrl+Alt+F2 reenter GUI mode on the login page, in order to log in another user.

Configuration

The feature is controlled both by a compile-time option in the kernel configuration, CONFIG_MAGIC_SYSRQ, and a sysctl kernel parameter, kernel.sysrq.

On newer kernels (since 2.6.12[9]), it is possible to have more fine-grained control over how the magic SysRq key can be used.[10] On these machines, the number written to /proc/sys/kernel/sysrq can be 0, 1, or a number greater than 1 which is a bitmask indicating which features to allow. On Ubuntu this is set at boot time to the value defined in /etc/sysctl.d/10-magic-sysrq.conf .

Other ways to invoke Magic SysRq

While the magic SysRq key was originally implemented as part of the kernel's keyboard handler for debugging, the functionality has been also exposed via the proc filesystem and is commonly used to provide extended management capabilities to headless and remote systems. From user space programs (such as a command line shell), SysRq may be accessed by writing to /proc/sysrq-trigger (e.g., echo s > /proc/sysrq-trigger).[1]

Many embedded systems have no attached keyboard, but instead use a serial console for text input/output to the running system. It is possible to invoke a Magic SysRq feature over a serial console by sending a serial break signal, followed by the desired key. The method of sending a break is dependent on the terminal program or hardware used to connect to the serial console. A sysctl option needs to be set to enable this function.[11]

The Linux daemons sysrqd[12] and tcpconsole[13] provide a method of accessing SysRq features over a TCP connection after authenticating with a plain-text password. The hangwatch[14] daemon will invoke pre-configured SysRq triggers when system load average exceeds a certain threshold.

The Xen hypervisor has functionality to send magic commands to hosted domains via its xm sysrq command.[15] Additionally, a SysRq command can be invoked from a Xen paravirtual console by sending a break sequence Ctrl+O followed by the desired key.

Chromebooks have a keyboard but no dedicated SysRq key. They use Alt+VolumeUp (Alt+F10) instead,[16][17][18] however some keys have a different function.[19][20]

IBM Power Systems servers can invoke the Magic SysRq feature using Ctrl+O followed by the desired key from the Hardware Management Console.

IBM mainframe partitions can invoke the Magic SysRq feature using ^+- followed by the desired key on 3270 or HMC console.

See also


References

  1. "Linux Magic System Request Key Hacks". kernel.org. 2013-08-12. Retrieved 2017-05-21.
  2. Khamlichi, Mel (18 Oct 2010), Use Magic SysRq Combination Key to Recover from a Frozen System in Linux, Unixmen, archived from the original on 20 August 2014, retrieved 21 Sep 2014.
  3. "Alt+SysRq on a laptop". Super User. Retrieved 25 July 2023.
  4. Barnes, Jesse (2008-11-07). "DRM: i915: add mode setting support". Git (commit). Kernel. Retrieved 2013-08-31.
  5. "Linux Magic System Request Key Hacks". 2021-09-13. Retrieved 2022-09-25.
  6. Calleja, Diego (2012-07-17). "Linux 2.6.12". Linux Kernel Newbies. Retrieved 2013-08-31.
  7. "QA/Sysrq". Fedora Project. 2013-05-09. Retrieved 2015-04-09.
  8. Turner, Glen; Komarinski, Mark F (2003-03-31). "Magic SysRq key". Remote Serial Console How-To. The Linux Documentation Project. Retrieved 2015-05-08.
  9. Danjou, Julien. "sysrqd". GitHub (project). Retrieved 2016-09-13.
  10. van Heusden, Folkert. "tcpconsole". Archived from the original on 2017-08-31. Retrieved 2013-08-31.
  11. Morgan, Paul. "hangwatch". GitHub. Retrieved 2013-08-31.
  12. "27. The xm command quick reference", Enterprise Linux 5 Virtualization Guide, RedHat, retrieved 2013-08-31
  13. "Debug Button Shortcuts". Chromium OS docs. Retrieved 2018-10-22.
  14. "Helping debug system hangs". The Chromium Projects. Retrieved 2018-09-25.

Share this article:

This article uses material from the Wikipedia article Magic_SysRq_key, and is written by contributors. Text is available under a CC BY-SA 4.0 International License; additional terms may apply. Images, videos and audio are available under their respective licenses.