original/man2/kexec_load.2

   1 .\" Copyright (C) 2010 Intel Corporation
   2 .\" Author: Andi Kleen
   3 .\"
   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.
   8 .\"
   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.
  13 .\"
  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
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .TH KEXEC_LOAD 2 2014-08-19 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 kexec_load \- load a new kernel for later execution
  29 .SH SYNOPSIS
  30 .B #include <linux/kexec.h>
  31 .br
  32 .BI "long kexec_load(unsigned long " entry ", unsigned long " nr_segments ","
  33 .br
  34 .BI "                struct kexec_segment *" segments \
  35 ", unsigned long " flags ");"
  36
  37 .IR Note :
  38 There is no glibc wrapper for this system call; see NOTES.
  39 .SH DESCRIPTION
  40 The
  41 .BR kexec_load ()
  42 system call loads a new kernel that can be executed later by
  43 .BR reboot (2).
  44 .PP
  45 The
  46 .I flags
  47 argument is a bit mask that controls the operation of the call.
  48 The following values can be specified in
  49 .IR flags :
  50 .TP
  51 .BR KEXEC_ON_CRASH " (since Linux 2.6.13)"
  52 Execute the new kernel automatically on a system crash.
  53 .\" FIXME Explain in more detail how KEXEC_ON_CRASH is actually used
  54 .TP
  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
  62 .I nr_segments
  63 is greater than 0.
  64 .PP
  65 The high-order bits (corresponding to the mask 0xffff0000) of
  66 .I flags
  67 contain the architecture of the to-be-executed kernel.
  68 Specify (OR) the constant
  69 .B KEXEC_ARCH_DEFAULT
  70 to use the current architecture,
  71 or one of the following architecture constants
  72 .BR KEXEC_ARCH_386 ,
  73 .BR KEXEC_ARCH_68K ,
  74 .BR KEXEC_ARCH_X86_64 ,
  75 .BR KEXEC_ARCH_PPC ,
  76 .BR KEXEC_ARCH_PPC64 ,
  77 .BR KEXEC_ARCH_IA_64 ,
  78 .BR KEXEC_ARCH_ARM ,
  79 .BR KEXEC_ARCH_S390 ,
  80 .BR KEXEC_ARCH_SH ,
  81 .BR KEXEC_ARCH_MIPS ,
  82 and
  83 .BR KEXEC_ARCH_MIPS_LE .
  84 The architecture must be executable on the CPU of the system.
  85
  86 The
  87 .I entry
  88 argument is the physical entry address in the kernel image.
  89 The
  90 .I nr_segments
  91 argument is the number of segments pointed to by the
  92 .I segments
  93 pointer;
  94 the kernel imposes an (arbitrary) limit of 16 on the number of segments.
  95 The
  96 .I segments
  97 argument is an array of
  98 .I kexec_segment
  99 structures which define the kernel layout:
 100 .in +4n
 101 .nf
 102
 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 */
 108 };
 109 .fi
 110 .in
 111 .PP
 112 .\" FIXME Explain the details of how the kernel image defined by segments
 113 .\" is copied from the calling process into previously reserved memory.
 114 The kernel image defined by
 115 .I segments
 116 is copied from the calling process into previously reserved memory.
 117 .SH RETURN VALUE
 118 On success,
 119 .BR kexec_load ()
 120 returns 0.
 121 On error, \-1 is returned and
 122 .I errno
 123 is set to indicate the error.
 124 .SH ERRORS
 125 .TP
 126 .B EBUSY
 127 Another crash kernel is already being loaded
 128 or a crash kernel is already in use.
 129 .TP
 130 .B EINVAL
 131 .I flags
 132 is invalid; or
 133 .IR nr_segments
 134 is too large
 135 .\" KEXEC_SEGMENT_MAX == 16
 136 .TP
 137 .B EPERM
 138 The caller does not have the
 139 .BR CAP_SYS_BOOT
 140 capability.
 141 .SH VERSIONS
 142 The
 143 .BR kexec_load ()
 144 system call first appeared in Linux 2.6.13.
 145 .SH CONFORMING TO
 146 This system call is Linux-specific.
 147 .SH NOTES
 148 Currently, there is no glibc support for
 149 .BR kexec_load ().
 150 Call it using
 151 .BR syscall (2).
 152 .PP
 153 The required constants are in the Linux kernel source file
 154 .IR linux/kexec.h ,
 155 which is not currently exported to glibc.
 156 .\" FIXME . Andi submitted a patch for this.
 157 .\" Check if it got accepted later.
 158 Therefore, these constants must be defined manually.
 159
 160 This system call is available only if the kernel was configured with
 161 .BR CONFIG_KEXEC .
 162 .SH SEE ALSO
 163 .BR reboot (2),
 164 .BR syscall (2)