]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/linux/kexec.h
Merge tag 'x86-urgent-2020-08-30' of git://git.kernel.org/pub/scm/linux/kernel/git...
[mirror_ubuntu-jammy-kernel.git] / include / linux / kexec.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
dc009d92
EB
2#ifndef LINUX_KEXEC_H
3#define LINUX_KEXEC_H
4
cf2df639
GL
5#define IND_DESTINATION_BIT 0
6#define IND_INDIRECTION_BIT 1
7#define IND_DONE_BIT 2
8#define IND_SOURCE_BIT 3
9
10#define IND_DESTINATION (1 << IND_DESTINATION_BIT)
11#define IND_INDIRECTION (1 << IND_INDIRECTION_BIT)
12#define IND_DONE (1 << IND_DONE_BIT)
13#define IND_SOURCE (1 << IND_SOURCE_BIT)
b28c2ee8 14#define IND_FLAGS (IND_DESTINATION | IND_INDIRECTION | IND_DONE | IND_SOURCE)
cf2df639
GL
15
16#if !defined(__ASSEMBLY__)
17
692f66f2 18#include <linux/crash_core.h>
43546d86
RK
19#include <asm/io.h>
20
607ca46e 21#include <uapi/linux/kexec.h>
29a5c67e 22
2965faa5 23#ifdef CONFIG_KEXEC_CORE
dc009d92 24#include <linux/list.h>
dc009d92 25#include <linux/compat.h>
9c15e852 26#include <linux/ioport.h>
12db5562 27#include <linux/module.h>
dc009d92
EB
28#include <asm/kexec.h>
29
30/* Verify architecture specific macros are defined */
31
32#ifndef KEXEC_SOURCE_MEMORY_LIMIT
33#error KEXEC_SOURCE_MEMORY_LIMIT not defined
34#endif
35
36#ifndef KEXEC_DESTINATION_MEMORY_LIMIT
37#error KEXEC_DESTINATION_MEMORY_LIMIT not defined
38#endif
39
40#ifndef KEXEC_CONTROL_MEMORY_LIMIT
41#error KEXEC_CONTROL_MEMORY_LIMIT not defined
42#endif
43
7e01b5ac 44#ifndef KEXEC_CONTROL_MEMORY_GFP
dc5cccac 45#define KEXEC_CONTROL_MEMORY_GFP (GFP_KERNEL | __GFP_NORETRY)
7e01b5ac
MS
46#endif
47
163f6876
HY
48#ifndef KEXEC_CONTROL_PAGE_SIZE
49#error KEXEC_CONTROL_PAGE_SIZE not defined
dc009d92
EB
50#endif
51
52#ifndef KEXEC_ARCH
53#error KEXEC_ARCH not defined
54#endif
55
3d214fae
MH
56#ifndef KEXEC_CRASH_CONTROL_MEMORY_LIMIT
57#define KEXEC_CRASH_CONTROL_MEMORY_LIMIT KEXEC_CONTROL_MEMORY_LIMIT
58#endif
59
558df720
MH
60#ifndef KEXEC_CRASH_MEM_ALIGN
61#define KEXEC_CRASH_MEM_ALIGN PAGE_SIZE
62#endif
63
692f66f2
HB
64#define KEXEC_CORE_NOTE_NAME CRASH_CORE_NOTE_NAME
65
dc009d92
EB
66/*
67 * This structure is used to hold the arguments that are used when loading
68 * kernel binaries.
69 */
70
71typedef unsigned long kimage_entry_t;
dc009d92 72
dc009d92 73struct kexec_segment {
815d5704
VG
74 /*
75 * This pointer can point to user memory if kexec_load() system
76 * call is used or will point to kernel memory if
77 * kexec_file_load() system call is used.
78 *
79 * Use ->buf when expecting to deal with user memory and use ->kbuf
80 * when expecting to deal with kernel memory.
81 */
82 union {
83 void __user *buf;
84 void *kbuf;
85 };
dc009d92 86 size_t bufsz;
29a5c67e 87 unsigned long mem;
dc009d92
EB
88 size_t memsz;
89};
90
91#ifdef CONFIG_COMPAT
92struct compat_kexec_segment {
93 compat_uptr_t buf;
94 compat_size_t bufsz;
95 compat_ulong_t mem; /* User space sees this as a (void *) ... */
96 compat_size_t memsz;
97};
98#endif
99
978e30c9 100#ifdef CONFIG_KEXEC_FILE
12db5562 101struct purgatory_info {
65c225d3
PR
102 /*
103 * Pointer to elf header at the beginning of kexec_purgatory.
104 * Note: kexec_purgatory is read only
105 */
106 const Elf_Ehdr *ehdr;
107 /*
108 * Temporary, modifiable buffer for sechdrs used for relocation.
109 * This memory can be freed post image load.
110 */
12db5562
VG
111 Elf_Shdr *sechdrs;
112 /*
65c225d3
PR
113 * Temporary, modifiable buffer for stripped purgatory used for
114 * relocation. This memory can be freed post image load.
12db5562
VG
115 */
116 void *purgatory_buf;
12db5562
VG
117};
118
ee6ebeda
PR
119struct kimage;
120
978e30c9
XP
121typedef int (kexec_probe_t)(const char *kernel_buf, unsigned long kernel_size);
122typedef void *(kexec_load_t)(struct kimage *image, char *kernel_buf,
123 unsigned long kernel_len, char *initrd,
124 unsigned long initrd_len, char *cmdline,
125 unsigned long cmdline_len);
126typedef int (kexec_cleanup_t)(void *loader_data);
127
99d5cadf 128#ifdef CONFIG_KEXEC_SIG
978e30c9
XP
129typedef int (kexec_verify_sig_t)(const char *kernel_buf,
130 unsigned long kernel_len);
131#endif
132
133struct kexec_file_ops {
134 kexec_probe_t *probe;
135 kexec_load_t *load;
136 kexec_cleanup_t *cleanup;
99d5cadf 137#ifdef CONFIG_KEXEC_SIG
978e30c9
XP
138 kexec_verify_sig_t *verify_sig;
139#endif
140};
60fe3910 141
9ec4ecef
AT
142extern const struct kexec_file_ops * const kexec_file_loaders[];
143
144int kexec_image_probe_default(struct kimage *image, void *buf,
145 unsigned long buf_len);
92a98a2b 146int kexec_image_post_load_cleanup_default(struct kimage *image);
9ec4ecef 147
b6664ba4
AT
148/*
149 * If kexec_buf.mem is set to this value, kexec_locate_mem_hole()
150 * will try to allocate free memory. Arch may overwrite it.
151 */
152#ifndef KEXEC_BUF_MEM_UNKNOWN
153#define KEXEC_BUF_MEM_UNKNOWN 0
154#endif
155
60fe3910
TJB
156/**
157 * struct kexec_buf - parameters for finding a place for a buffer in memory
158 * @image: kexec image in which memory to search.
159 * @buffer: Contents which will be copied to the allocated memory.
160 * @bufsz: Size of @buffer.
161 * @mem: On return will have address of the buffer in memory.
162 * @memsz: Size for the buffer in memory.
163 * @buf_align: Minimum alignment needed.
164 * @buf_min: The buffer can't be placed below this address.
165 * @buf_max: The buffer can't be placed above this address.
166 * @top_down: Allocate from top of memory.
167 */
168struct kexec_buf {
169 struct kimage *image;
ec2b9bfa 170 void *buffer;
60fe3910
TJB
171 unsigned long bufsz;
172 unsigned long mem;
173 unsigned long memsz;
174 unsigned long buf_align;
175 unsigned long buf_min;
176 unsigned long buf_max;
177 bool top_down;
178};
179
3be3f61d
PR
180int kexec_load_purgatory(struct kimage *image, struct kexec_buf *kbuf);
181int kexec_purgatory_get_set_symbol(struct kimage *image, const char *name,
182 void *buf, unsigned int size,
183 bool get_value);
184void *kexec_purgatory_get_symbol_addr(struct kimage *image, const char *name);
185
f891f197
HB
186/* Architectures may override the below functions */
187int arch_kexec_kernel_image_probe(struct kimage *image, void *buf,
188 unsigned long buf_len);
189void *arch_kexec_kernel_image_load(struct kimage *image);
190int arch_kexec_apply_relocations_add(struct purgatory_info *pi,
191 Elf_Shdr *section,
192 const Elf_Shdr *relsec,
193 const Elf_Shdr *symtab);
194int arch_kexec_apply_relocations(struct purgatory_info *pi,
195 Elf_Shdr *section,
196 const Elf_Shdr *relsec,
197 const Elf_Shdr *symtab);
198int arch_kimage_file_post_load_cleanup(struct kimage *image);
199#ifdef CONFIG_KEXEC_SIG
200int arch_kexec_kernel_verify_sig(struct kimage *image, void *buf,
201 unsigned long buf_len);
202#endif
203int arch_kexec_locate_mem_hole(struct kexec_buf *kbuf);
8aec395b 204
ec2b9bfa 205extern int kexec_add_buffer(struct kexec_buf *kbuf);
e2e806f9 206int kexec_locate_mem_hole(struct kexec_buf *kbuf);
babac4a8
AT
207
208/* Alignment required for elf header segment */
209#define ELF_CORE_HEADER_ALIGN 4096
210
211struct crash_mem_range {
212 u64 start, end;
213};
214
215struct crash_mem {
216 unsigned int max_nr_ranges;
217 unsigned int nr_ranges;
50b6951f 218 struct crash_mem_range ranges[];
babac4a8
AT
219};
220
221extern int crash_exclude_mem_range(struct crash_mem *mem,
222 unsigned long long mstart,
223 unsigned long long mend);
224extern int crash_prepare_elf64_headers(struct crash_mem *mem, int kernel_map,
225 void **addr, unsigned long *sz);
60fe3910 226#endif /* CONFIG_KEXEC_FILE */
978e30c9 227
175fca3b
SS
228#ifdef CONFIG_KEXEC_ELF
229struct kexec_elf_info {
230 /*
231 * Where the ELF binary contents are kept.
232 * Memory managed by the user of the struct.
233 */
234 const char *buffer;
235
236 const struct elfhdr *ehdr;
237 const struct elf_phdr *proghdrs;
175fca3b
SS
238};
239
240int kexec_build_elf_info(const char *buf, size_t len, struct elfhdr *ehdr,
241 struct kexec_elf_info *elf_info);
242
243int kexec_elf_load(struct kimage *image, struct elfhdr *ehdr,
244 struct kexec_elf_info *elf_info,
245 struct kexec_buf *kbuf,
246 unsigned long *lowest_load_addr);
247
248void kexec_free_elf_info(struct kexec_elf_info *elf_info);
249int kexec_elf_probe(const char *buf, unsigned long len);
250#endif
dc009d92
EB
251struct kimage {
252 kimage_entry_t head;
253 kimage_entry_t *entry;
254 kimage_entry_t *last_entry;
255
dc009d92
EB
256 unsigned long start;
257 struct page *control_code_page;
3ab83521 258 struct page *swap_page;
1229384f 259 void *vmcoreinfo_data_copy; /* locates in the crash memory */
dc009d92
EB
260
261 unsigned long nr_segments;
262 struct kexec_segment segment[KEXEC_SEGMENT_MAX];
263
264 struct list_head control_pages;
265 struct list_head dest_pages;
7d3e2bca 266 struct list_head unusable_pages;
dc009d92
EB
267
268 /* Address of next control page to allocate for crash kernels. */
269 unsigned long control_page;
270
271 /* Flags to indicate special processing */
272 unsigned int type : 1;
273#define KEXEC_TYPE_DEFAULT 0
274#define KEXEC_TYPE_CRASH 1
3ab83521 275 unsigned int preserve_context : 1;
cb105258
VG
276 /* If set, we are using file mode kexec syscall */
277 unsigned int file_mode:1;
92be3d6b
HY
278
279#ifdef ARCH_HAS_KIMAGE_ARCH
280 struct kimage_arch arch;
281#endif
cb105258 282
978e30c9 283#ifdef CONFIG_KEXEC_FILE
cb105258
VG
284 /* Additional fields for file based kexec syscall */
285 void *kernel_buf;
286 unsigned long kernel_buf_len;
287
288 void *initrd_buf;
289 unsigned long initrd_buf_len;
290
291 char *cmdline_buf;
292 unsigned long cmdline_buf_len;
293
294 /* File operations provided by image loader */
9ec4ecef 295 const struct kexec_file_ops *fops;
cb105258
VG
296
297 /* Image loader handling the kernel can store a pointer here */
298 void *image_loader_data;
12db5562
VG
299
300 /* Information for loading purgatory */
301 struct purgatory_info purgatory_info;
978e30c9 302#endif
cb105258 303};
dc009d92
EB
304
305/* kexec interface functions */
3ab83521 306extern void machine_kexec(struct kimage *image);
dc009d92
EB
307extern int machine_kexec_prepare(struct kimage *image);
308extern void machine_kexec_cleanup(struct kimage *image);
3ab83521 309extern int kernel_kexec(void);
72414d3f
MS
310extern struct page *kimage_alloc_control_pages(struct kimage *image,
311 unsigned int order);
7bbee5ca 312extern void __crash_kexec(struct pt_regs *);
6e274d14
AN
313extern void crash_kexec(struct pt_regs *);
314int kexec_should_crash(struct task_struct *);
21db79e8 315int kexec_crash_loaded(void);
85916f81 316void crash_save_cpu(struct pt_regs *regs, int cpu);
1229384f 317extern int kimage_crash_copy_vmcoreinfo(struct kimage *image);
fd59d231 318
dc009d92 319extern struct kimage *kexec_image;
c330dda9 320extern struct kimage *kexec_crash_image;
7984754b 321extern int kexec_load_disabled;
dc009d92 322
a7956113
ZN
323#ifndef kexec_flush_icache_page
324#define kexec_flush_icache_page(page)
325#endif
326
3ab83521
HY
327/* List of defined/legal kexec flags */
328#ifndef CONFIG_KEXEC_JUMP
329#define KEXEC_FLAGS KEXEC_ON_CRASH
330#else
331#define KEXEC_FLAGS (KEXEC_ON_CRASH | KEXEC_PRESERVE_CONTEXT)
332#endif
dc009d92 333
cb105258
VG
334/* List of defined/legal kexec file flags */
335#define KEXEC_FILE_FLAGS (KEXEC_FILE_UNLOAD | KEXEC_FILE_ON_CRASH | \
336 KEXEC_FILE_NO_INITRAMFS)
337
dc009d92
EB
338/* Location of a reserved region to hold the crash kernel.
339 */
340extern struct resource crashk_res;
0212f915 341extern struct resource crashk_low_res;
43cf38eb 342extern note_buf_t __percpu *crash_notes;
dc009d92 343
4fc9bbf9
KA
344/* flag to track if kexec reboot is in progress */
345extern bool kexec_in_progress;
346
06a7f711
AW
347int crash_shrink_memory(unsigned long new_size);
348size_t crash_get_memory_size(void);
c0bb9e45 349void crash_free_reserved_phys_range(unsigned long begin, unsigned long end);
a7956113 350
9b492cf5
XP
351void arch_kexec_protect_crashkres(void);
352void arch_kexec_unprotect_crashkres(void);
a43cac0d 353
43546d86
RK
354#ifndef page_to_boot_pfn
355static inline unsigned long page_to_boot_pfn(struct page *page)
356{
357 return page_to_pfn(page);
358}
359#endif
360
361#ifndef boot_pfn_to_page
362static inline struct page *boot_pfn_to_page(unsigned long boot_pfn)
363{
364 return pfn_to_page(boot_pfn);
365}
366#endif
367
368#ifndef phys_to_boot_phys
369static inline unsigned long phys_to_boot_phys(phys_addr_t phys)
370{
371 return phys;
372}
373#endif
374
375#ifndef boot_phys_to_phys
376static inline phys_addr_t boot_phys_to_phys(unsigned long boot_phys)
377{
378 return boot_phys;
379}
380#endif
381
382static inline unsigned long virt_to_boot_phys(void *addr)
383{
384 return phys_to_boot_phys(__pa((unsigned long)addr));
385}
386
387static inline void *boot_phys_to_virt(unsigned long entry)
388{
389 return phys_to_virt(boot_phys_to_phys(entry));
390}
391
bba4ed01
TL
392#ifndef arch_kexec_post_alloc_pages
393static inline int arch_kexec_post_alloc_pages(void *vaddr, unsigned int pages, gfp_t gfp) { return 0; }
394#endif
395
396#ifndef arch_kexec_pre_free_pages
397static inline void arch_kexec_pre_free_pages(void *vaddr, unsigned int pages) { }
398#endif
399
2965faa5 400#else /* !CONFIG_KEXEC_CORE */
6e274d14
AN
401struct pt_regs;
402struct task_struct;
7bbee5ca 403static inline void __crash_kexec(struct pt_regs *regs) { }
6e274d14
AN
404static inline void crash_kexec(struct pt_regs *regs) { }
405static inline int kexec_should_crash(struct task_struct *p) { return 0; }
21db79e8 406static inline int kexec_crash_loaded(void) { return 0; }
2b94ed24 407#define kexec_in_progress false
2965faa5 408#endif /* CONFIG_KEXEC_CORE */
cf2df639
GL
409
410#endif /* !defined(__ASSEBMLY__) */
411
dc009d92 412#endif /* LINUX_KEXEC_H */