]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/linux/kexec.h
kernel/kexec_file.c: search symbols in read-only kexec_purgatory
[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;
117
118 /* Address where purgatory is finally loaded and is executed from */
119 unsigned long purgatory_load_addr;
120};
121
ee6ebeda
PR
122struct kimage;
123
978e30c9
XP
124typedef int (kexec_probe_t)(const char *kernel_buf, unsigned long kernel_size);
125typedef void *(kexec_load_t)(struct kimage *image, char *kernel_buf,
126 unsigned long kernel_len, char *initrd,
127 unsigned long initrd_len, char *cmdline,
128 unsigned long cmdline_len);
129typedef int (kexec_cleanup_t)(void *loader_data);
130
131#ifdef CONFIG_KEXEC_VERIFY_SIG
132typedef int (kexec_verify_sig_t)(const char *kernel_buf,
133 unsigned long kernel_len);
134#endif
135
136struct kexec_file_ops {
137 kexec_probe_t *probe;
138 kexec_load_t *load;
139 kexec_cleanup_t *cleanup;
140#ifdef CONFIG_KEXEC_VERIFY_SIG
141 kexec_verify_sig_t *verify_sig;
142#endif
143};
60fe3910 144
9ec4ecef
AT
145extern const struct kexec_file_ops * const kexec_file_loaders[];
146
147int kexec_image_probe_default(struct kimage *image, void *buf,
148 unsigned long buf_len);
149
60fe3910
TJB
150/**
151 * struct kexec_buf - parameters for finding a place for a buffer in memory
152 * @image: kexec image in which memory to search.
153 * @buffer: Contents which will be copied to the allocated memory.
154 * @bufsz: Size of @buffer.
155 * @mem: On return will have address of the buffer in memory.
156 * @memsz: Size for the buffer in memory.
157 * @buf_align: Minimum alignment needed.
158 * @buf_min: The buffer can't be placed below this address.
159 * @buf_max: The buffer can't be placed above this address.
160 * @top_down: Allocate from top of memory.
161 */
162struct kexec_buf {
163 struct kimage *image;
ec2b9bfa 164 void *buffer;
60fe3910
TJB
165 unsigned long bufsz;
166 unsigned long mem;
167 unsigned long memsz;
168 unsigned long buf_align;
169 unsigned long buf_min;
170 unsigned long buf_max;
171 bool top_down;
172};
173
174int __weak arch_kexec_walk_mem(struct kexec_buf *kbuf,
1d2e733b 175 int (*func)(struct resource *, void *));
ec2b9bfa 176extern int kexec_add_buffer(struct kexec_buf *kbuf);
e2e806f9 177int kexec_locate_mem_hole(struct kexec_buf *kbuf);
babac4a8
AT
178
179/* Alignment required for elf header segment */
180#define ELF_CORE_HEADER_ALIGN 4096
181
182struct crash_mem_range {
183 u64 start, end;
184};
185
186struct crash_mem {
187 unsigned int max_nr_ranges;
188 unsigned int nr_ranges;
189 struct crash_mem_range ranges[0];
190};
191
192extern int crash_exclude_mem_range(struct crash_mem *mem,
193 unsigned long long mstart,
194 unsigned long long mend);
195extern int crash_prepare_elf64_headers(struct crash_mem *mem, int kernel_map,
196 void **addr, unsigned long *sz);
60fe3910 197#endif /* CONFIG_KEXEC_FILE */
978e30c9 198
dc009d92
EB
199struct kimage {
200 kimage_entry_t head;
201 kimage_entry_t *entry;
202 kimage_entry_t *last_entry;
203
dc009d92
EB
204 unsigned long start;
205 struct page *control_code_page;
3ab83521 206 struct page *swap_page;
1229384f 207 void *vmcoreinfo_data_copy; /* locates in the crash memory */
dc009d92
EB
208
209 unsigned long nr_segments;
210 struct kexec_segment segment[KEXEC_SEGMENT_MAX];
211
212 struct list_head control_pages;
213 struct list_head dest_pages;
7d3e2bca 214 struct list_head unusable_pages;
dc009d92
EB
215
216 /* Address of next control page to allocate for crash kernels. */
217 unsigned long control_page;
218
219 /* Flags to indicate special processing */
220 unsigned int type : 1;
221#define KEXEC_TYPE_DEFAULT 0
222#define KEXEC_TYPE_CRASH 1
3ab83521 223 unsigned int preserve_context : 1;
cb105258
VG
224 /* If set, we are using file mode kexec syscall */
225 unsigned int file_mode:1;
92be3d6b
HY
226
227#ifdef ARCH_HAS_KIMAGE_ARCH
228 struct kimage_arch arch;
229#endif
cb105258 230
978e30c9 231#ifdef CONFIG_KEXEC_FILE
cb105258
VG
232 /* Additional fields for file based kexec syscall */
233 void *kernel_buf;
234 unsigned long kernel_buf_len;
235
236 void *initrd_buf;
237 unsigned long initrd_buf_len;
238
239 char *cmdline_buf;
240 unsigned long cmdline_buf_len;
241
242 /* File operations provided by image loader */
9ec4ecef 243 const struct kexec_file_ops *fops;
cb105258
VG
244
245 /* Image loader handling the kernel can store a pointer here */
246 void *image_loader_data;
12db5562
VG
247
248 /* Information for loading purgatory */
249 struct purgatory_info purgatory_info;
978e30c9 250#endif
cb105258 251};
dc009d92
EB
252
253/* kexec interface functions */
3ab83521 254extern void machine_kexec(struct kimage *image);
dc009d92
EB
255extern int machine_kexec_prepare(struct kimage *image);
256extern void machine_kexec_cleanup(struct kimage *image);
3ab83521 257extern int kernel_kexec(void);
72414d3f
MS
258extern struct page *kimage_alloc_control_pages(struct kimage *image,
259 unsigned int order);
12db5562
VG
260extern int kexec_load_purgatory(struct kimage *image, unsigned long min,
261 unsigned long max, int top_down,
262 unsigned long *load_addr);
263extern int kexec_purgatory_get_set_symbol(struct kimage *image,
264 const char *name, void *buf,
265 unsigned int size, bool get_value);
266extern void *kexec_purgatory_get_symbol_addr(struct kimage *image,
267 const char *name);
7bbee5ca 268extern void __crash_kexec(struct pt_regs *);
6e274d14
AN
269extern void crash_kexec(struct pt_regs *);
270int kexec_should_crash(struct task_struct *);
21db79e8 271int kexec_crash_loaded(void);
85916f81 272void crash_save_cpu(struct pt_regs *regs, int cpu);
1229384f 273extern int kimage_crash_copy_vmcoreinfo(struct kimage *image);
fd59d231 274
dc009d92 275extern struct kimage *kexec_image;
c330dda9 276extern struct kimage *kexec_crash_image;
7984754b 277extern int kexec_load_disabled;
dc009d92 278
a7956113
ZN
279#ifndef kexec_flush_icache_page
280#define kexec_flush_icache_page(page)
281#endif
282
3ab83521
HY
283/* List of defined/legal kexec flags */
284#ifndef CONFIG_KEXEC_JUMP
285#define KEXEC_FLAGS KEXEC_ON_CRASH
286#else
287#define KEXEC_FLAGS (KEXEC_ON_CRASH | KEXEC_PRESERVE_CONTEXT)
288#endif
dc009d92 289
cb105258
VG
290/* List of defined/legal kexec file flags */
291#define KEXEC_FILE_FLAGS (KEXEC_FILE_UNLOAD | KEXEC_FILE_ON_CRASH | \
292 KEXEC_FILE_NO_INITRAMFS)
293
dc009d92
EB
294/* Location of a reserved region to hold the crash kernel.
295 */
296extern struct resource crashk_res;
0212f915 297extern struct resource crashk_low_res;
43cf38eb 298extern note_buf_t __percpu *crash_notes;
dc009d92 299
4fc9bbf9
KA
300/* flag to track if kexec reboot is in progress */
301extern bool kexec_in_progress;
302
06a7f711
AW
303int crash_shrink_memory(unsigned long new_size);
304size_t crash_get_memory_size(void);
c0bb9e45 305void crash_free_reserved_phys_range(unsigned long begin, unsigned long end);
a7956113 306
a43cac0d
DY
307int __weak arch_kexec_apply_relocations_add(const Elf_Ehdr *ehdr,
308 Elf_Shdr *sechdrs, unsigned int relsec);
309int __weak arch_kexec_apply_relocations(const Elf_Ehdr *ehdr, Elf_Shdr *sechdrs,
310 unsigned int relsec);
9b492cf5
XP
311void arch_kexec_protect_crashkres(void);
312void arch_kexec_unprotect_crashkres(void);
a43cac0d 313
43546d86
RK
314#ifndef page_to_boot_pfn
315static inline unsigned long page_to_boot_pfn(struct page *page)
316{
317 return page_to_pfn(page);
318}
319#endif
320
321#ifndef boot_pfn_to_page
322static inline struct page *boot_pfn_to_page(unsigned long boot_pfn)
323{
324 return pfn_to_page(boot_pfn);
325}
326#endif
327
328#ifndef phys_to_boot_phys
329static inline unsigned long phys_to_boot_phys(phys_addr_t phys)
330{
331 return phys;
332}
333#endif
334
335#ifndef boot_phys_to_phys
336static inline phys_addr_t boot_phys_to_phys(unsigned long boot_phys)
337{
338 return boot_phys;
339}
340#endif
341
342static inline unsigned long virt_to_boot_phys(void *addr)
343{
344 return phys_to_boot_phys(__pa((unsigned long)addr));
345}
346
347static inline void *boot_phys_to_virt(unsigned long entry)
348{
349 return phys_to_virt(boot_phys_to_phys(entry));
350}
351
bba4ed01
TL
352#ifndef arch_kexec_post_alloc_pages
353static inline int arch_kexec_post_alloc_pages(void *vaddr, unsigned int pages, gfp_t gfp) { return 0; }
354#endif
355
356#ifndef arch_kexec_pre_free_pages
357static inline void arch_kexec_pre_free_pages(void *vaddr, unsigned int pages) { }
358#endif
359
2965faa5 360#else /* !CONFIG_KEXEC_CORE */
6e274d14
AN
361struct pt_regs;
362struct task_struct;
7bbee5ca 363static inline void __crash_kexec(struct pt_regs *regs) { }
6e274d14
AN
364static inline void crash_kexec(struct pt_regs *regs) { }
365static inline int kexec_should_crash(struct task_struct *p) { return 0; }
21db79e8 366static inline int kexec_crash_loaded(void) { return 0; }
2b94ed24 367#define kexec_in_progress false
2965faa5 368#endif /* CONFIG_KEXEC_CORE */
cf2df639
GL
369
370#endif /* !defined(__ASSEBMLY__) */
371
dc009d92 372#endif /* LINUX_KEXEC_H */