1 .\" Hey Emacs! This file is -*- nroff -*- source.
3 .\" Copyright (C) 2010 Intel Corporation
6 .\" Permission is granted to make and distribute verbatim copies of this
7 .\" manual provided the copyright notice and this permission notice are
8 .\" preserved on all copies.
10 .\" Permission is granted to copy and distribute modified versions of this
11 .\" manual under the conditions for verbatim copying, provided that the
12 .\" entire resulting derived work is distributed under the terms of a
13 .\" permission notice identical to this one.
15 .\" Since the Linux kernel and libraries are constantly changing, this
16 .\" manual page may be incorrect or out-of-date. The author(s) assume no
17 .\" responsibility for errors or omissions, or for damages resulting from
18 .\" the use of the information contained herein. The author(s) may not
19 .\" have taken the same level of care in the production of this manual,
20 .\" which is licensed free of charge, as they might when working
23 .\" Formatted or processed versions of this manual, if unaccompanied by
24 .\" the source, must acknowledge the copyright and authors of this work.
25 .TH KEXEC_LOAD 2 2010-11-04 "Linux" "Linux Programmer's Manual"
27 kexec_load \- load a new kernel for later execution
29 .B #include <linux/kexec.h>
31 .BI "long kexec_load(unsigned long " entry ", unsigned long " nr_segments ","
33 .BI " struct kexec_segment *" segments \
34 ", unsigned long " flags ");"
38 system call loads a new kernel that can be executed later by
43 argument is a mask whose high-order bits control the operation of the call.
44 The following values can be specified in
47 .BR KEXEC_ON_CRASH " (since Linux 2.6.13)"
48 Execute the new kernel automatically on a system crash.
49 .\" FIXME figure out how this is really used
51 .BR KEXEC_PRESERVE_CONTEXT " (since Linux 2.6.27)"
52 Preserve the system hardware and
53 software states before executing the new kernel.
54 This could be used for system suspend.
55 This flag is only available if the kernel was configured with
56 .BR CONFIG_KEXEC_JUMP ,
57 and is only effective if
63 contain the architecture of the to-be-executed kernel.
64 Specify (OR) the constant
66 to use the current architecture,
67 or one of the following architecture constants
69 .BR KEXEC_ARCH_X86_64 ,
71 .BR KEXEC_ARCH_PPC64 ,
72 .BR KEXEC_ARCH_IA_64 ,
78 .BR KEXEC_ARCH_MIPS_LE .
79 The architecture must be executable on the CPU of the system.
83 argument is the physical entry address in the kernel image.
86 argument is the number of segments pointed to by the
91 argument is an array of
93 structures which define the kernel layout:
97 struct kexec_segment {
98 void *buf; /* Buffer in user space */
99 size_t bufsz; /* Buffer length in user space */
100 void *mem; /* Physical address of kernel */
101 size_t memsz; /* Physical address length */
106 .\" FIXME elaborate on the following:
107 The kernel image defined by
109 is copied from the calling process into previously reserved memory.
114 On error, \-1 is returned and
116 is set to indicate the error.
120 Another crash kernel is already being loaded
121 or a crash kernel is already in use.
128 .\" KEXEC_SEGMENT_MAX == 16
131 The caller does not have the
137 system call first appeared in Linux 2.6.13.
139 This system call is Linux-specific.
141 Currently, there is no glibc support for
146 The required constants are in the kernel source file
148 which is not currently exported to glibc.
149 .\" FIXME Andi submitted a patch for this.
150 .\" Check if it got accepted later.
151 Therefore, these constants must be defined manually.
153 This system call is only available if the kernel was configured with