1 /* SPDX-License-Identifier: GPL-2.0 */
5 #define IND_DESTINATION_BIT 0
6 #define IND_INDIRECTION_BIT 1
8 #define IND_SOURCE_BIT 3
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)
14 #define IND_FLAGS (IND_DESTINATION | IND_INDIRECTION | IND_DONE | IND_SOURCE)
16 #if !defined(__ASSEMBLY__)
18 #include <linux/crash_core.h>
21 #include <uapi/linux/kexec.h>
23 /* Location of a reserved region to hold the crash kernel.
25 extern struct resource crashk_res;
26 extern struct resource crashk_low_res;
27 extern note_buf_t __percpu *crash_notes;
29 #ifdef CONFIG_KEXEC_CORE
30 #include <linux/list.h>
31 #include <linux/compat.h>
32 #include <linux/ioport.h>
33 #include <linux/module.h>
34 #include <asm/kexec.h>
36 /* Verify architecture specific macros are defined */
38 #ifndef KEXEC_SOURCE_MEMORY_LIMIT
39 #error KEXEC_SOURCE_MEMORY_LIMIT not defined
42 #ifndef KEXEC_DESTINATION_MEMORY_LIMIT
43 #error KEXEC_DESTINATION_MEMORY_LIMIT not defined
46 #ifndef KEXEC_CONTROL_MEMORY_LIMIT
47 #error KEXEC_CONTROL_MEMORY_LIMIT not defined
50 #ifndef KEXEC_CONTROL_MEMORY_GFP
51 #define KEXEC_CONTROL_MEMORY_GFP (GFP_KERNEL | __GFP_NORETRY)
54 #ifndef KEXEC_CONTROL_PAGE_SIZE
55 #error KEXEC_CONTROL_PAGE_SIZE not defined
59 #error KEXEC_ARCH not defined
62 #ifndef KEXEC_CRASH_CONTROL_MEMORY_LIMIT
63 #define KEXEC_CRASH_CONTROL_MEMORY_LIMIT KEXEC_CONTROL_MEMORY_LIMIT
66 #ifndef KEXEC_CRASH_MEM_ALIGN
67 #define KEXEC_CRASH_MEM_ALIGN PAGE_SIZE
70 #define KEXEC_CORE_NOTE_NAME CRASH_CORE_NOTE_NAME
73 * This structure is used to hold the arguments that are used when loading
77 typedef unsigned long kimage_entry_t;
79 struct kexec_segment {
81 * This pointer can point to user memory if kexec_load() system
82 * call is used or will point to kernel memory if
83 * kexec_file_load() system call is used.
85 * Use ->buf when expecting to deal with user memory and use ->kbuf
86 * when expecting to deal with kernel memory.
98 struct compat_kexec_segment {
101 compat_ulong_t mem; /* User space sees this as a (void *) ... */
106 #ifdef CONFIG_KEXEC_FILE
107 struct purgatory_info {
109 * Pointer to elf header at the beginning of kexec_purgatory.
110 * Note: kexec_purgatory is read only
112 const Elf_Ehdr *ehdr;
114 * Temporary, modifiable buffer for sechdrs used for relocation.
115 * This memory can be freed post image load.
119 * Temporary, modifiable buffer for stripped purgatory used for
120 * relocation. This memory can be freed post image load.
127 typedef int (kexec_probe_t)(const char *kernel_buf, unsigned long kernel_size);
128 typedef void *(kexec_load_t)(struct kimage *image, char *kernel_buf,
129 unsigned long kernel_len, char *initrd,
130 unsigned long initrd_len, char *cmdline,
131 unsigned long cmdline_len);
132 typedef int (kexec_cleanup_t)(void *loader_data);
134 #ifdef CONFIG_KEXEC_SIG
135 typedef int (kexec_verify_sig_t)(const char *kernel_buf,
136 unsigned long kernel_len);
139 struct kexec_file_ops {
140 kexec_probe_t *probe;
142 kexec_cleanup_t *cleanup;
143 #ifdef CONFIG_KEXEC_SIG
144 kexec_verify_sig_t *verify_sig;
148 extern const struct kexec_file_ops * const kexec_file_loaders[];
150 int kexec_image_probe_default(struct kimage *image, void *buf,
151 unsigned long buf_len);
152 int kexec_image_post_load_cleanup_default(struct kimage *image);
155 * If kexec_buf.mem is set to this value, kexec_locate_mem_hole()
156 * will try to allocate free memory. Arch may overwrite it.
158 #ifndef KEXEC_BUF_MEM_UNKNOWN
159 #define KEXEC_BUF_MEM_UNKNOWN 0
163 * struct kexec_buf - parameters for finding a place for a buffer in memory
164 * @image: kexec image in which memory to search.
165 * @buffer: Contents which will be copied to the allocated memory.
166 * @bufsz: Size of @buffer.
167 * @mem: On return will have address of the buffer in memory.
168 * @memsz: Size for the buffer in memory.
169 * @buf_align: Minimum alignment needed.
170 * @buf_min: The buffer can't be placed below this address.
171 * @buf_max: The buffer can't be placed above this address.
172 * @top_down: Allocate from top of memory.
175 struct kimage *image;
180 unsigned long buf_align;
181 unsigned long buf_min;
182 unsigned long buf_max;
186 int kexec_load_purgatory(struct kimage *image, struct kexec_buf *kbuf);
187 int kexec_purgatory_get_set_symbol(struct kimage *image, const char *name,
188 void *buf, unsigned int size,
190 void *kexec_purgatory_get_symbol_addr(struct kimage *image, const char *name);
192 /* Architectures may override the below functions */
193 int arch_kexec_kernel_image_probe(struct kimage *image, void *buf,
194 unsigned long buf_len);
195 void *arch_kexec_kernel_image_load(struct kimage *image);
196 int arch_kexec_apply_relocations_add(struct purgatory_info *pi,
198 const Elf_Shdr *relsec,
199 const Elf_Shdr *symtab);
200 int arch_kexec_apply_relocations(struct purgatory_info *pi,
202 const Elf_Shdr *relsec,
203 const Elf_Shdr *symtab);
204 int arch_kimage_file_post_load_cleanup(struct kimage *image);
205 #ifdef CONFIG_KEXEC_SIG
206 int arch_kexec_kernel_verify_sig(struct kimage *image, void *buf,
207 unsigned long buf_len);
209 int arch_kexec_locate_mem_hole(struct kexec_buf *kbuf);
211 extern int kexec_add_buffer(struct kexec_buf *kbuf);
212 int kexec_locate_mem_hole(struct kexec_buf *kbuf);
214 /* Alignment required for elf header segment */
215 #define ELF_CORE_HEADER_ALIGN 4096
217 struct crash_mem_range {
222 unsigned int max_nr_ranges;
223 unsigned int nr_ranges;
224 struct crash_mem_range ranges[];
227 extern int crash_exclude_mem_range(struct crash_mem *mem,
228 unsigned long long mstart,
229 unsigned long long mend);
230 extern int crash_prepare_elf64_headers(struct crash_mem *mem, int kernel_map,
231 void **addr, unsigned long *sz);
232 #endif /* CONFIG_KEXEC_FILE */
234 #ifdef CONFIG_KEXEC_ELF
235 struct kexec_elf_info {
237 * Where the ELF binary contents are kept.
238 * Memory managed by the user of the struct.
242 const struct elfhdr *ehdr;
243 const struct elf_phdr *proghdrs;
246 int kexec_build_elf_info(const char *buf, size_t len, struct elfhdr *ehdr,
247 struct kexec_elf_info *elf_info);
249 int kexec_elf_load(struct kimage *image, struct elfhdr *ehdr,
250 struct kexec_elf_info *elf_info,
251 struct kexec_buf *kbuf,
252 unsigned long *lowest_load_addr);
254 void kexec_free_elf_info(struct kexec_elf_info *elf_info);
255 int kexec_elf_probe(const char *buf, unsigned long len);
259 kimage_entry_t *entry;
260 kimage_entry_t *last_entry;
263 struct page *control_code_page;
264 struct page *swap_page;
265 void *vmcoreinfo_data_copy; /* locates in the crash memory */
267 unsigned long nr_segments;
268 struct kexec_segment segment[KEXEC_SEGMENT_MAX];
270 struct list_head control_pages;
271 struct list_head dest_pages;
272 struct list_head unusable_pages;
274 /* Address of next control page to allocate for crash kernels. */
275 unsigned long control_page;
277 /* Flags to indicate special processing */
278 unsigned int type : 1;
279 #define KEXEC_TYPE_DEFAULT 0
280 #define KEXEC_TYPE_CRASH 1
281 unsigned int preserve_context : 1;
282 /* If set, we are using file mode kexec syscall */
283 unsigned int file_mode:1;
285 #ifdef ARCH_HAS_KIMAGE_ARCH
286 struct kimage_arch arch;
289 #ifdef CONFIG_KEXEC_FILE
290 /* Additional fields for file based kexec syscall */
292 unsigned long kernel_buf_len;
295 unsigned long initrd_buf_len;
298 unsigned long cmdline_buf_len;
300 /* File operations provided by image loader */
301 const struct kexec_file_ops *fops;
303 /* Image loader handling the kernel can store a pointer here */
304 void *image_loader_data;
306 /* Information for loading purgatory */
307 struct purgatory_info purgatory_info;
310 #ifdef CONFIG_IMA_KEXEC
311 /* Virtual address of IMA measurement buffer for kexec syscall */
314 phys_addr_t ima_buffer_addr;
315 size_t ima_buffer_size;
318 /* Core ELF header buffer */
320 unsigned long elf_headers_sz;
321 unsigned long elf_load_addr;
324 /* kexec interface functions */
325 extern void machine_kexec(struct kimage *image);
326 extern int machine_kexec_prepare(struct kimage *image);
327 extern void machine_kexec_cleanup(struct kimage *image);
328 extern int kernel_kexec(void);
329 extern struct page *kimage_alloc_control_pages(struct kimage *image,
331 int machine_kexec_post_load(struct kimage *image);
333 extern void __crash_kexec(struct pt_regs *);
334 extern void crash_kexec(struct pt_regs *);
335 int kexec_should_crash(struct task_struct *);
336 int kexec_crash_loaded(void);
337 void crash_save_cpu(struct pt_regs *regs, int cpu);
338 extern int kimage_crash_copy_vmcoreinfo(struct kimage *image);
340 extern struct kimage *kexec_image;
341 extern struct kimage *kexec_crash_image;
342 extern int kexec_load_disabled;
344 #ifndef kexec_flush_icache_page
345 #define kexec_flush_icache_page(page)
348 /* List of defined/legal kexec flags */
349 #ifndef CONFIG_KEXEC_JUMP
350 #define KEXEC_FLAGS KEXEC_ON_CRASH
352 #define KEXEC_FLAGS (KEXEC_ON_CRASH | KEXEC_PRESERVE_CONTEXT)
355 /* List of defined/legal kexec file flags */
356 #define KEXEC_FILE_FLAGS (KEXEC_FILE_UNLOAD | KEXEC_FILE_ON_CRASH | \
357 KEXEC_FILE_NO_INITRAMFS)
359 /* flag to track if kexec reboot is in progress */
360 extern bool kexec_in_progress;
362 int crash_shrink_memory(unsigned long new_size);
363 size_t crash_get_memory_size(void);
364 void crash_free_reserved_phys_range(unsigned long begin, unsigned long end);
366 void arch_kexec_protect_crashkres(void);
367 void arch_kexec_unprotect_crashkres(void);
369 #ifndef page_to_boot_pfn
370 static inline unsigned long page_to_boot_pfn(struct page *page)
372 return page_to_pfn(page);
376 #ifndef boot_pfn_to_page
377 static inline struct page *boot_pfn_to_page(unsigned long boot_pfn)
379 return pfn_to_page(boot_pfn);
383 #ifndef phys_to_boot_phys
384 static inline unsigned long phys_to_boot_phys(phys_addr_t phys)
390 #ifndef boot_phys_to_phys
391 static inline phys_addr_t boot_phys_to_phys(unsigned long boot_phys)
397 static inline unsigned long virt_to_boot_phys(void *addr)
399 return phys_to_boot_phys(__pa((unsigned long)addr));
402 static inline void *boot_phys_to_virt(unsigned long entry)
404 return phys_to_virt(boot_phys_to_phys(entry));
407 #ifndef arch_kexec_post_alloc_pages
408 static inline int arch_kexec_post_alloc_pages(void *vaddr, unsigned int pages, gfp_t gfp) { return 0; }
411 #ifndef arch_kexec_pre_free_pages
412 static inline void arch_kexec_pre_free_pages(void *vaddr, unsigned int pages) { }
415 #else /* !CONFIG_KEXEC_CORE */
418 static inline void __crash_kexec(struct pt_regs *regs) { }
419 static inline void crash_kexec(struct pt_regs *regs) { }
420 static inline int kexec_should_crash(struct task_struct *p) { return 0; }
421 static inline int kexec_crash_loaded(void) { return 0; }
422 #define kexec_in_progress false
423 #endif /* CONFIG_KEXEC_CORE */
425 #endif /* !defined(__ASSEBMLY__) */
427 #endif /* LINUX_KEXEC_H */