1 .\" Copyright (C) 2010 Intel Corporation
4 .\" %%%LICENSE_START(VERBATIM)
5 .\" Permission is granted to make and distribute verbatim copies of this
6 .\" manual provided the copyright notice and this permission notice are
7 .\" preserved on all copies.
9 .\" Permission is granted to copy and distribute modified versions of this
10 .\" manual under the conditions for verbatim copying, provided that the
11 .\" entire resulting derived work is distributed under the terms of a
12 .\" permission notice identical to this one.
14 .\" Since the Linux kernel and libraries are constantly changing, this
15 .\" manual page may be incorrect or out-of-date. The author(s) assume no
16 .\" responsibility for errors or omissions, or for damages resulting from
17 .\" the use of the information contained herein. The author(s) may not
18 .\" have taken the same level of care in the production of this manual,
19 .\" which is licensed free of charge, as they might when working
22 .\" Formatted or processed versions of this manual, if unaccompanied by
23 .\" the source, must acknowledge the copyright and authors of this work.
26 .TH KEXEC_LOAD 2 2012-07-13 "Linux" "Linux Programmer's Manual"
28 kexec_load \- load a new kernel for later execution
30 .B #include <linux/kexec.h>
32 .BI "long kexec_load(unsigned long " entry ", unsigned long " nr_segments ","
34 .BI " struct kexec_segment *" segments \
35 ", unsigned long " flags ");"
38 There is no glibc wrapper for this system call; see NOTES.
42 system call loads a new kernel that can be executed later by
47 argument is a bit mask that controls the operation of the call.
48 The following values can be specified in
51 .BR KEXEC_ON_CRASH " (since Linux 2.6.13)"
52 Execute the new kernel automatically on a system crash.
53 .\" FIXME figure out how this is really used
55 .BR KEXEC_PRESERVE_CONTEXT " (since Linux 2.6.27)"
56 Preserve the system hardware and
57 software states before executing the new kernel.
58 This could be used for system suspend.
59 This flag is available only if the kernel was configured with
60 .BR CONFIG_KEXEC_JUMP ,
61 and is effective only if
65 The high-order bits (corresponding to the mask 0xffff0000) of
67 contain the architecture of the to-be-executed kernel.
68 Specify (OR) the constant
70 to use the current architecture,
71 or one of the following architecture constants
74 .BR KEXEC_ARCH_X86_64 ,
76 .BR KEXEC_ARCH_PPC64 ,
77 .BR KEXEC_ARCH_IA_64 ,
83 .BR KEXEC_ARCH_MIPS_LE .
84 The architecture must be executable on the CPU of the system.
88 argument is the physical entry address in the kernel image.
91 argument is the number of segments pointed to by the
94 the kernel imposes an (arbitrary) limit of 16 on the number of segments.
97 argument is an array of
99 structures which define the kernel layout:
103 struct kexec_segment {
104 void *buf; /* Buffer in user space */
105 size_t bufsz; /* Buffer length in user space */
106 void *mem; /* Physical address of kernel */
107 size_t memsz; /* Physical address length */
112 .\" FIXME elaborate on the following:
113 The kernel image defined by
115 is copied from the calling process into previously reserved memory.
120 On error, \-1 is returned and
122 is set to indicate the error.
126 Another crash kernel is already being loaded
127 or a crash kernel is already in use.
134 .\" KEXEC_SEGMENT_MAX == 16
137 The caller does not have the
143 system call first appeared in Linux 2.6.13.
145 This system call is Linux-specific.
147 Currently, there is no glibc support for
152 The required constants are in the Linux kernel source file
154 which is not currently exported to glibc.
155 .\" FIXME Andi submitted a patch for this.
156 .\" Check if it got accepted later.
157 Therefore, these constants must be defined manually.
159 This system call is available only if the kernel was configured with