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 #ifdef CONFIG_KEXEC_CORE
24 #include <linux/list.h>
25 #include <linux/compat.h>
26 #include <linux/ioport.h>
27 #include <linux/module.h>
28 #include <asm/kexec.h>
30 /* Verify architecture specific macros are defined */
32 #ifndef KEXEC_SOURCE_MEMORY_LIMIT
33 #error KEXEC_SOURCE_MEMORY_LIMIT not defined
36 #ifndef KEXEC_DESTINATION_MEMORY_LIMIT
37 #error KEXEC_DESTINATION_MEMORY_LIMIT not defined
40 #ifndef KEXEC_CONTROL_MEMORY_LIMIT
41 #error KEXEC_CONTROL_MEMORY_LIMIT not defined
44 #ifndef KEXEC_CONTROL_MEMORY_GFP
45 #define KEXEC_CONTROL_MEMORY_GFP (GFP_KERNEL | __GFP_NORETRY)
48 #ifndef KEXEC_CONTROL_PAGE_SIZE
49 #error KEXEC_CONTROL_PAGE_SIZE not defined
53 #error KEXEC_ARCH not defined
56 #ifndef KEXEC_CRASH_CONTROL_MEMORY_LIMIT
57 #define KEXEC_CRASH_CONTROL_MEMORY_LIMIT KEXEC_CONTROL_MEMORY_LIMIT
60 #ifndef KEXEC_CRASH_MEM_ALIGN
61 #define KEXEC_CRASH_MEM_ALIGN PAGE_SIZE
64 #define KEXEC_CORE_NOTE_NAME CRASH_CORE_NOTE_NAME
67 * This structure is used to hold the arguments that are used when loading
71 typedef unsigned long kimage_entry_t;
73 struct kexec_segment {
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.
79 * Use ->buf when expecting to deal with user memory and use ->kbuf
80 * when expecting to deal with kernel memory.
92 struct compat_kexec_segment {
95 compat_ulong_t mem; /* User space sees this as a (void *) ... */
100 #ifdef CONFIG_KEXEC_FILE
101 struct purgatory_info {
103 * Pointer to elf header at the beginning of kexec_purgatory.
104 * Note: kexec_purgatory is read only
106 const Elf_Ehdr *ehdr;
108 * Temporary, modifiable buffer for sechdrs used for relocation.
109 * This memory can be freed post image load.
113 * Temporary, modifiable buffer for stripped purgatory used for
114 * relocation. This memory can be freed post image load.
121 typedef int (kexec_probe_t)(const char *kernel_buf, unsigned long kernel_size);
122 typedef 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);
126 typedef int (kexec_cleanup_t)(void *loader_data);
128 #ifdef CONFIG_KEXEC_VERIFY_SIG
129 typedef int (kexec_verify_sig_t)(const char *kernel_buf,
130 unsigned long kernel_len);
133 struct kexec_file_ops {
134 kexec_probe_t *probe;
136 kexec_cleanup_t *cleanup;
137 #ifdef CONFIG_KEXEC_VERIFY_SIG
138 kexec_verify_sig_t *verify_sig;
142 extern const struct kexec_file_ops * const kexec_file_loaders[];
144 int kexec_image_probe_default(struct kimage *image, void *buf,
145 unsigned long buf_len);
148 * struct kexec_buf - parameters for finding a place for a buffer in memory
149 * @image: kexec image in which memory to search.
150 * @buffer: Contents which will be copied to the allocated memory.
151 * @bufsz: Size of @buffer.
152 * @mem: On return will have address of the buffer in memory.
153 * @memsz: Size for the buffer in memory.
154 * @buf_align: Minimum alignment needed.
155 * @buf_min: The buffer can't be placed below this address.
156 * @buf_max: The buffer can't be placed above this address.
157 * @top_down: Allocate from top of memory.
160 struct kimage *image;
165 unsigned long buf_align;
166 unsigned long buf_min;
167 unsigned long buf_max;
171 int kexec_load_purgatory(struct kimage *image, struct kexec_buf *kbuf);
172 int kexec_purgatory_get_set_symbol(struct kimage *image, const char *name,
173 void *buf, unsigned int size,
175 void *kexec_purgatory_get_symbol_addr(struct kimage *image, const char *name);
177 int __weak arch_kexec_apply_relocations_add(struct purgatory_info *pi,
179 const Elf_Shdr *relsec,
180 const Elf_Shdr *symtab);
181 int __weak arch_kexec_apply_relocations(struct purgatory_info *pi,
183 const Elf_Shdr *relsec,
184 const Elf_Shdr *symtab);
186 int __weak arch_kexec_walk_mem(struct kexec_buf *kbuf,
187 int (*func)(struct resource *, void *));
188 extern int kexec_add_buffer(struct kexec_buf *kbuf);
189 int kexec_locate_mem_hole(struct kexec_buf *kbuf);
191 /* Alignment required for elf header segment */
192 #define ELF_CORE_HEADER_ALIGN 4096
194 struct crash_mem_range {
199 unsigned int max_nr_ranges;
200 unsigned int nr_ranges;
201 struct crash_mem_range ranges[0];
204 extern int crash_exclude_mem_range(struct crash_mem *mem,
205 unsigned long long mstart,
206 unsigned long long mend);
207 extern int crash_prepare_elf64_headers(struct crash_mem *mem, int kernel_map,
208 void **addr, unsigned long *sz);
209 #endif /* CONFIG_KEXEC_FILE */
213 kimage_entry_t *entry;
214 kimage_entry_t *last_entry;
217 struct page *control_code_page;
218 struct page *swap_page;
219 void *vmcoreinfo_data_copy; /* locates in the crash memory */
221 unsigned long nr_segments;
222 struct kexec_segment segment[KEXEC_SEGMENT_MAX];
224 struct list_head control_pages;
225 struct list_head dest_pages;
226 struct list_head unusable_pages;
228 /* Address of next control page to allocate for crash kernels. */
229 unsigned long control_page;
231 /* Flags to indicate special processing */
232 unsigned int type : 1;
233 #define KEXEC_TYPE_DEFAULT 0
234 #define KEXEC_TYPE_CRASH 1
235 unsigned int preserve_context : 1;
236 /* If set, we are using file mode kexec syscall */
237 unsigned int file_mode:1;
239 #ifdef ARCH_HAS_KIMAGE_ARCH
240 struct kimage_arch arch;
243 #ifdef CONFIG_KEXEC_FILE
244 /* Additional fields for file based kexec syscall */
246 unsigned long kernel_buf_len;
249 unsigned long initrd_buf_len;
252 unsigned long cmdline_buf_len;
254 /* File operations provided by image loader */
255 const struct kexec_file_ops *fops;
257 /* Image loader handling the kernel can store a pointer here */
258 void *image_loader_data;
260 /* Information for loading purgatory */
261 struct purgatory_info purgatory_info;
264 #ifdef CONFIG_IMA_KEXEC
265 /* Virtual address of IMA measurement buffer for kexec syscall */
270 /* kexec interface functions */
271 extern void machine_kexec(struct kimage *image);
272 extern int machine_kexec_prepare(struct kimage *image);
273 extern void machine_kexec_cleanup(struct kimage *image);
274 extern int kernel_kexec(void);
275 extern struct page *kimage_alloc_control_pages(struct kimage *image,
277 extern void __crash_kexec(struct pt_regs *);
278 extern void crash_kexec(struct pt_regs *);
279 int kexec_should_crash(struct task_struct *);
280 int kexec_crash_loaded(void);
281 void crash_save_cpu(struct pt_regs *regs, int cpu);
282 extern int kimage_crash_copy_vmcoreinfo(struct kimage *image);
284 extern struct kimage *kexec_image;
285 extern struct kimage *kexec_crash_image;
286 extern int kexec_load_disabled;
288 #ifndef kexec_flush_icache_page
289 #define kexec_flush_icache_page(page)
292 /* List of defined/legal kexec flags */
293 #ifndef CONFIG_KEXEC_JUMP
294 #define KEXEC_FLAGS KEXEC_ON_CRASH
296 #define KEXEC_FLAGS (KEXEC_ON_CRASH | KEXEC_PRESERVE_CONTEXT)
299 /* List of defined/legal kexec file flags */
300 #define KEXEC_FILE_FLAGS (KEXEC_FILE_UNLOAD | KEXEC_FILE_ON_CRASH | \
301 KEXEC_FILE_NO_INITRAMFS)
303 /* Location of a reserved region to hold the crash kernel.
305 extern struct resource crashk_res;
306 extern struct resource crashk_low_res;
307 extern note_buf_t __percpu *crash_notes;
309 /* flag to track if kexec reboot is in progress */
310 extern bool kexec_in_progress;
312 int crash_shrink_memory(unsigned long new_size);
313 size_t crash_get_memory_size(void);
314 void crash_free_reserved_phys_range(unsigned long begin, unsigned long end);
316 void arch_kexec_protect_crashkres(void);
317 void arch_kexec_unprotect_crashkres(void);
319 #ifndef page_to_boot_pfn
320 static inline unsigned long page_to_boot_pfn(struct page *page)
322 return page_to_pfn(page);
326 #ifndef boot_pfn_to_page
327 static inline struct page *boot_pfn_to_page(unsigned long boot_pfn)
329 return pfn_to_page(boot_pfn);
333 #ifndef phys_to_boot_phys
334 static inline unsigned long phys_to_boot_phys(phys_addr_t phys)
340 #ifndef boot_phys_to_phys
341 static inline phys_addr_t boot_phys_to_phys(unsigned long boot_phys)
347 static inline unsigned long virt_to_boot_phys(void *addr)
349 return phys_to_boot_phys(__pa((unsigned long)addr));
352 static inline void *boot_phys_to_virt(unsigned long entry)
354 return phys_to_virt(boot_phys_to_phys(entry));
357 #ifndef arch_kexec_post_alloc_pages
358 static inline int arch_kexec_post_alloc_pages(void *vaddr, unsigned int pages, gfp_t gfp) { return 0; }
361 #ifndef arch_kexec_pre_free_pages
362 static inline void arch_kexec_pre_free_pages(void *vaddr, unsigned int pages) { }
365 #else /* !CONFIG_KEXEC_CORE */
368 static inline void __crash_kexec(struct pt_regs *regs) { }
369 static inline void crash_kexec(struct pt_regs *regs) { }
370 static inline int kexec_should_crash(struct task_struct *p) { return 0; }
371 static inline int kexec_crash_loaded(void) { return 0; }
372 #define kexec_in_progress false
373 #endif /* CONFIG_KEXEC_CORE */
375 #endif /* !defined(__ASSEBMLY__) */
377 #endif /* LINUX_KEXEC_H */