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);
146 int kexec_image_post_load_cleanup_default(struct kimage *image);
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.
152 #ifndef KEXEC_BUF_MEM_UNKNOWN
153 #define KEXEC_BUF_MEM_UNKNOWN 0
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.
169 struct kimage *image;
174 unsigned long buf_align;
175 unsigned long buf_min;
176 unsigned long buf_max;
180 int kexec_load_purgatory(struct kimage *image, struct kexec_buf *kbuf);
181 int kexec_purgatory_get_set_symbol(struct kimage *image, const char *name,
182 void *buf, unsigned int size,
184 void *kexec_purgatory_get_symbol_addr(struct kimage *image, const char *name);
186 void * __weak arch_kexec_kernel_image_load(struct kimage *image);
187 int __weak arch_kexec_apply_relocations_add(struct purgatory_info *pi,
189 const Elf_Shdr *relsec,
190 const Elf_Shdr *symtab);
191 int __weak arch_kexec_apply_relocations(struct purgatory_info *pi,
193 const Elf_Shdr *relsec,
194 const Elf_Shdr *symtab);
196 extern int kexec_add_buffer(struct kexec_buf *kbuf);
197 int kexec_locate_mem_hole(struct kexec_buf *kbuf);
199 /* Alignment required for elf header segment */
200 #define ELF_CORE_HEADER_ALIGN 4096
202 struct crash_mem_range {
207 unsigned int max_nr_ranges;
208 unsigned int nr_ranges;
209 struct crash_mem_range ranges[0];
212 extern int crash_exclude_mem_range(struct crash_mem *mem,
213 unsigned long long mstart,
214 unsigned long long mend);
215 extern int crash_prepare_elf64_headers(struct crash_mem *mem, int kernel_map,
216 void **addr, unsigned long *sz);
217 #endif /* CONFIG_KEXEC_FILE */
219 #ifdef CONFIG_KEXEC_ELF
220 struct kexec_elf_info {
222 * Where the ELF binary contents are kept.
223 * Memory managed by the user of the struct.
227 const struct elfhdr *ehdr;
228 const struct elf_phdr *proghdrs;
231 int kexec_build_elf_info(const char *buf, size_t len, struct elfhdr *ehdr,
232 struct kexec_elf_info *elf_info);
234 int kexec_elf_load(struct kimage *image, struct elfhdr *ehdr,
235 struct kexec_elf_info *elf_info,
236 struct kexec_buf *kbuf,
237 unsigned long *lowest_load_addr);
239 void kexec_free_elf_info(struct kexec_elf_info *elf_info);
240 int kexec_elf_probe(const char *buf, unsigned long len);
244 kimage_entry_t *entry;
245 kimage_entry_t *last_entry;
248 struct page *control_code_page;
249 struct page *swap_page;
250 void *vmcoreinfo_data_copy; /* locates in the crash memory */
252 unsigned long nr_segments;
253 struct kexec_segment segment[KEXEC_SEGMENT_MAX];
255 struct list_head control_pages;
256 struct list_head dest_pages;
257 struct list_head unusable_pages;
259 /* Address of next control page to allocate for crash kernels. */
260 unsigned long control_page;
262 /* Flags to indicate special processing */
263 unsigned int type : 1;
264 #define KEXEC_TYPE_DEFAULT 0
265 #define KEXEC_TYPE_CRASH 1
266 unsigned int preserve_context : 1;
267 /* If set, we are using file mode kexec syscall */
268 unsigned int file_mode:1;
270 #ifdef ARCH_HAS_KIMAGE_ARCH
271 struct kimage_arch arch;
274 #ifdef CONFIG_KEXEC_FILE
275 /* Additional fields for file based kexec syscall */
277 unsigned long kernel_buf_len;
280 unsigned long initrd_buf_len;
283 unsigned long cmdline_buf_len;
285 /* File operations provided by image loader */
286 const struct kexec_file_ops *fops;
288 /* Image loader handling the kernel can store a pointer here */
289 void *image_loader_data;
291 /* Information for loading purgatory */
292 struct purgatory_info purgatory_info;
296 /* kexec interface functions */
297 extern void machine_kexec(struct kimage *image);
298 extern int machine_kexec_prepare(struct kimage *image);
299 extern void machine_kexec_cleanup(struct kimage *image);
300 extern int kernel_kexec(void);
301 extern struct page *kimage_alloc_control_pages(struct kimage *image,
303 extern void __crash_kexec(struct pt_regs *);
304 extern void crash_kexec(struct pt_regs *);
305 int kexec_should_crash(struct task_struct *);
306 int kexec_crash_loaded(void);
307 void crash_save_cpu(struct pt_regs *regs, int cpu);
308 extern int kimage_crash_copy_vmcoreinfo(struct kimage *image);
310 extern struct kimage *kexec_image;
311 extern struct kimage *kexec_crash_image;
312 extern int kexec_load_disabled;
314 #ifndef kexec_flush_icache_page
315 #define kexec_flush_icache_page(page)
318 /* List of defined/legal kexec flags */
319 #ifndef CONFIG_KEXEC_JUMP
320 #define KEXEC_FLAGS KEXEC_ON_CRASH
322 #define KEXEC_FLAGS (KEXEC_ON_CRASH | KEXEC_PRESERVE_CONTEXT)
325 /* List of defined/legal kexec file flags */
326 #define KEXEC_FILE_FLAGS (KEXEC_FILE_UNLOAD | KEXEC_FILE_ON_CRASH | \
327 KEXEC_FILE_NO_INITRAMFS)
329 /* Location of a reserved region to hold the crash kernel.
331 extern struct resource crashk_res;
332 extern struct resource crashk_low_res;
333 extern note_buf_t __percpu *crash_notes;
335 /* flag to track if kexec reboot is in progress */
336 extern bool kexec_in_progress;
338 int crash_shrink_memory(unsigned long new_size);
339 size_t crash_get_memory_size(void);
340 void crash_free_reserved_phys_range(unsigned long begin, unsigned long end);
342 void arch_kexec_protect_crashkres(void);
343 void arch_kexec_unprotect_crashkres(void);
345 #ifndef page_to_boot_pfn
346 static inline unsigned long page_to_boot_pfn(struct page *page)
348 return page_to_pfn(page);
352 #ifndef boot_pfn_to_page
353 static inline struct page *boot_pfn_to_page(unsigned long boot_pfn)
355 return pfn_to_page(boot_pfn);
359 #ifndef phys_to_boot_phys
360 static inline unsigned long phys_to_boot_phys(phys_addr_t phys)
366 #ifndef boot_phys_to_phys
367 static inline phys_addr_t boot_phys_to_phys(unsigned long boot_phys)
373 static inline unsigned long virt_to_boot_phys(void *addr)
375 return phys_to_boot_phys(__pa((unsigned long)addr));
378 static inline void *boot_phys_to_virt(unsigned long entry)
380 return phys_to_virt(boot_phys_to_phys(entry));
383 #ifndef arch_kexec_post_alloc_pages
384 static inline int arch_kexec_post_alloc_pages(void *vaddr, unsigned int pages, gfp_t gfp) { return 0; }
387 #ifndef arch_kexec_pre_free_pages
388 static inline void arch_kexec_pre_free_pages(void *vaddr, unsigned int pages) { }
391 #else /* !CONFIG_KEXEC_CORE */
394 static inline void __crash_kexec(struct pt_regs *regs) { }
395 static inline void crash_kexec(struct pt_regs *regs) { }
396 static inline int kexec_should_crash(struct task_struct *p) { return 0; }
397 static inline int kexec_crash_loaded(void) { return 0; }
398 #define kexec_in_progress false
399 #endif /* CONFIG_KEXEC_CORE */
401 #endif /* !defined(__ASSEBMLY__) */
403 #endif /* LINUX_KEXEC_H */