1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef LINUX_KEXEC_H
3 #define LINUX_KEXEC_H
4
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)
14 #define IND_FLAGS (IND_DESTINATION | IND_INDIRECTION | IND_DONE | IND_SOURCE)
15
16 #if !defined(__ASSEMBLY__)
17
18 #include <linux/crash_core.h>
19 #include <asm/io.h>
20
21 #include <uapi/linux/kexec.h>
22
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>
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
44 #ifndef KEXEC_CONTROL_MEMORY_GFP
45 #define KEXEC_CONTROL_MEMORY_GFP (GFP_KERNEL | __GFP_NORETRY)
46 #endif
47
48 #ifndef KEXEC_CONTROL_PAGE_SIZE
49 #error KEXEC_CONTROL_PAGE_SIZE not defined
50 #endif
51
52 #ifndef KEXEC_ARCH
53 #error KEXEC_ARCH not defined
54 #endif
55
56 #ifndef KEXEC_CRASH_CONTROL_MEMORY_LIMIT
57 #define KEXEC_CRASH_CONTROL_MEMORY_LIMIT KEXEC_CONTROL_MEMORY_LIMIT
58 #endif
59
60 #ifndef KEXEC_CRASH_MEM_ALIGN
61 #define KEXEC_CRASH_MEM_ALIGN PAGE_SIZE
62 #endif
63
64 #define KEXEC_CORE_NOTE_NAME CRASH_CORE_NOTE_NAME
65
66 /*
67 * This structure is used to hold the arguments that are used when loading
68 * kernel binaries.
69 */
70
71 typedef unsigned long kimage_entry_t;
72
73 struct kexec_segment {
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 };
86 size_t bufsz;
87 unsigned long mem;
88 size_t memsz;
89 };
90
91 #ifdef CONFIG_COMPAT
92 struct 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
100 #ifdef CONFIG_KEXEC_FILE
101 struct purgatory_info {
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 */
111 Elf_Shdr *sechdrs;
112 /*
113 * Temporary, modifiable buffer for stripped purgatory used for
114 * relocation. This memory can be freed post image load.
115 */
116 void *purgatory_buf;
117 };
118
119 struct kimage;
120
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);
127
128 #ifdef CONFIG_KEXEC_VERIFY_SIG
129 typedef int (kexec_verify_sig_t)(const char *kernel_buf,
130 unsigned long kernel_len);
131 #endif
132
133 struct kexec_file_ops {
134 kexec_probe_t *probe;
135 kexec_load_t *load;
136 kexec_cleanup_t *cleanup;
137 #ifdef CONFIG_KEXEC_VERIFY_SIG
138 kexec_verify_sig_t *verify_sig;
139 #endif
140 };
141
142 extern const struct kexec_file_ops * const kexec_file_loaders[];
143
144 int kexec_image_probe_default(struct kimage *image, void *buf,
145 unsigned long buf_len);
146
147 /**
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.
158 */
159 struct kexec_buf {
160 struct kimage *image;
161 void *buffer;
162 unsigned long bufsz;
163 unsigned long mem;
164 unsigned long memsz;
165 unsigned long buf_align;
166 unsigned long buf_min;
167 unsigned long buf_max;
168 bool top_down;
169 };
170
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,
174 bool get_value);
175 void *kexec_purgatory_get_symbol_addr(struct kimage *image, const char *name);
176
177
178 int __weak arch_kexec_walk_mem(struct kexec_buf *kbuf,
179 int (*func)(struct resource *, void *));
180 extern int kexec_add_buffer(struct kexec_buf *kbuf);
181 int kexec_locate_mem_hole(struct kexec_buf *kbuf);
182
183 /* Alignment required for elf header segment */
184 #define ELF_CORE_HEADER_ALIGN 4096
185
186 struct crash_mem_range {
187 u64 start, end;
188 };
189
190 struct crash_mem {
191 unsigned int max_nr_ranges;
192 unsigned int nr_ranges;
193 struct crash_mem_range ranges[0];
194 };
195
196 extern int crash_exclude_mem_range(struct crash_mem *mem,
197 unsigned long long mstart,
198 unsigned long long mend);
199 extern int crash_prepare_elf64_headers(struct crash_mem *mem, int kernel_map,
200 void **addr, unsigned long *sz);
201
202 #ifndef arch_kexec_apply_relocations_add
203 /*
204 * arch_kexec_apply_relocations_add - apply relocations of type RELA
205 * @pi: Purgatory to be relocated.
206 * @section: Section relocations applying to.
207 * @relsec: Section containing RELAs.
208 * @symtab: Corresponding symtab.
209 *
210 * Return: 0 on success, negative errno on error.
211 */
212 static inline int
arch_kexec_apply_relocations_add(struct purgatory_info * pi,Elf_Shdr * section,const Elf_Shdr * relsec,const Elf_Shdr * symtab)213 arch_kexec_apply_relocations_add(struct purgatory_info *pi, Elf_Shdr *section,
214 const Elf_Shdr *relsec, const Elf_Shdr *symtab)
215 {
216 pr_err("RELA relocation unsupported.\n");
217 return -ENOEXEC;
218 }
219 #endif
220
221 #ifndef arch_kexec_apply_relocations
222 /*
223 * arch_kexec_apply_relocations - apply relocations of type REL
224 * @pi: Purgatory to be relocated.
225 * @section: Section relocations applying to.
226 * @relsec: Section containing RELs.
227 * @symtab: Corresponding symtab.
228 *
229 * Return: 0 on success, negative errno on error.
230 */
231 static inline int
arch_kexec_apply_relocations(struct purgatory_info * pi,Elf_Shdr * section,const Elf_Shdr * relsec,const Elf_Shdr * symtab)232 arch_kexec_apply_relocations(struct purgatory_info *pi, Elf_Shdr *section,
233 const Elf_Shdr *relsec, const Elf_Shdr *symtab)
234 {
235 pr_err("REL relocation unsupported.\n");
236 return -ENOEXEC;
237 }
238 #endif
239 #endif /* CONFIG_KEXEC_FILE */
240
241 struct kimage {
242 kimage_entry_t head;
243 kimage_entry_t *entry;
244 kimage_entry_t *last_entry;
245
246 unsigned long start;
247 struct page *control_code_page;
248 struct page *swap_page;
249 void *vmcoreinfo_data_copy; /* locates in the crash memory */
250
251 unsigned long nr_segments;
252 struct kexec_segment segment[KEXEC_SEGMENT_MAX];
253
254 struct list_head control_pages;
255 struct list_head dest_pages;
256 struct list_head unusable_pages;
257
258 /* Address of next control page to allocate for crash kernels. */
259 unsigned long control_page;
260
261 /* Flags to indicate special processing */
262 unsigned int type : 1;
263 #define KEXEC_TYPE_DEFAULT 0
264 #define KEXEC_TYPE_CRASH 1
265 unsigned int preserve_context : 1;
266 /* If set, we are using file mode kexec syscall */
267 unsigned int file_mode:1;
268
269 #ifdef ARCH_HAS_KIMAGE_ARCH
270 struct kimage_arch arch;
271 #endif
272
273 #ifdef CONFIG_KEXEC_FILE
274 /* Additional fields for file based kexec syscall */
275 void *kernel_buf;
276 unsigned long kernel_buf_len;
277
278 void *initrd_buf;
279 unsigned long initrd_buf_len;
280
281 char *cmdline_buf;
282 unsigned long cmdline_buf_len;
283
284 /* File operations provided by image loader */
285 const struct kexec_file_ops *fops;
286
287 /* Image loader handling the kernel can store a pointer here */
288 void *image_loader_data;
289
290 /* Information for loading purgatory */
291 struct purgatory_info purgatory_info;
292 #endif
293
294 #ifdef CONFIG_IMA_KEXEC
295 /* Virtual address of IMA measurement buffer for kexec syscall */
296 void *ima_buffer;
297 #endif
298 };
299
300 /* kexec interface functions */
301 extern void machine_kexec(struct kimage *image);
302 extern int machine_kexec_prepare(struct kimage *image);
303 extern void machine_kexec_cleanup(struct kimage *image);
304 extern int kernel_kexec(void);
305 extern struct page *kimage_alloc_control_pages(struct kimage *image,
306 unsigned int order);
307 extern void __crash_kexec(struct pt_regs *);
308 extern void crash_kexec(struct pt_regs *);
309 int kexec_should_crash(struct task_struct *);
310 int kexec_crash_loaded(void);
311 void crash_save_cpu(struct pt_regs *regs, int cpu);
312 extern int kimage_crash_copy_vmcoreinfo(struct kimage *image);
313
314 extern struct kimage *kexec_image;
315 extern struct kimage *kexec_crash_image;
316 extern int kexec_load_disabled;
317
318 #ifndef kexec_flush_icache_page
319 #define kexec_flush_icache_page(page)
320 #endif
321
322 /* List of defined/legal kexec flags */
323 #ifndef CONFIG_KEXEC_JUMP
324 #define KEXEC_FLAGS KEXEC_ON_CRASH
325 #else
326 #define KEXEC_FLAGS (KEXEC_ON_CRASH | KEXEC_PRESERVE_CONTEXT)
327 #endif
328
329 /* List of defined/legal kexec file flags */
330 #define KEXEC_FILE_FLAGS (KEXEC_FILE_UNLOAD | KEXEC_FILE_ON_CRASH | \
331 KEXEC_FILE_NO_INITRAMFS)
332
333 /* Location of a reserved region to hold the crash kernel.
334 */
335 extern struct resource crashk_res;
336 extern struct resource crashk_low_res;
337 extern note_buf_t __percpu *crash_notes;
338
339 /* flag to track if kexec reboot is in progress */
340 extern bool kexec_in_progress;
341
342 int crash_shrink_memory(unsigned long new_size);
343 size_t crash_get_memory_size(void);
344 void crash_free_reserved_phys_range(unsigned long begin, unsigned long end);
345
346 void arch_kexec_protect_crashkres(void);
347 void arch_kexec_unprotect_crashkres(void);
348
349 #ifndef page_to_boot_pfn
page_to_boot_pfn(struct page * page)350 static inline unsigned long page_to_boot_pfn(struct page *page)
351 {
352 return page_to_pfn(page);
353 }
354 #endif
355
356 #ifndef boot_pfn_to_page
boot_pfn_to_page(unsigned long boot_pfn)357 static inline struct page *boot_pfn_to_page(unsigned long boot_pfn)
358 {
359 return pfn_to_page(boot_pfn);
360 }
361 #endif
362
363 #ifndef phys_to_boot_phys
phys_to_boot_phys(phys_addr_t phys)364 static inline unsigned long phys_to_boot_phys(phys_addr_t phys)
365 {
366 return phys;
367 }
368 #endif
369
370 #ifndef boot_phys_to_phys
boot_phys_to_phys(unsigned long boot_phys)371 static inline phys_addr_t boot_phys_to_phys(unsigned long boot_phys)
372 {
373 return boot_phys;
374 }
375 #endif
376
virt_to_boot_phys(void * addr)377 static inline unsigned long virt_to_boot_phys(void *addr)
378 {
379 return phys_to_boot_phys(__pa((unsigned long)addr));
380 }
381
boot_phys_to_virt(unsigned long entry)382 static inline void *boot_phys_to_virt(unsigned long entry)
383 {
384 return phys_to_virt(boot_phys_to_phys(entry));
385 }
386
387 #ifndef arch_kexec_post_alloc_pages
arch_kexec_post_alloc_pages(void * vaddr,unsigned int pages,gfp_t gfp)388 static inline int arch_kexec_post_alloc_pages(void *vaddr, unsigned int pages, gfp_t gfp) { return 0; }
389 #endif
390
391 #ifndef arch_kexec_pre_free_pages
arch_kexec_pre_free_pages(void * vaddr,unsigned int pages)392 static inline void arch_kexec_pre_free_pages(void *vaddr, unsigned int pages) { }
393 #endif
394
395 #else /* !CONFIG_KEXEC_CORE */
396 struct pt_regs;
397 struct task_struct;
__crash_kexec(struct pt_regs * regs)398 static inline void __crash_kexec(struct pt_regs *regs) { }
crash_kexec(struct pt_regs * regs)399 static inline void crash_kexec(struct pt_regs *regs) { }
kexec_should_crash(struct task_struct * p)400 static inline int kexec_should_crash(struct task_struct *p) { return 0; }
kexec_crash_loaded(void)401 static inline int kexec_crash_loaded(void) { return 0; }
402 #define kexec_in_progress false
403 #endif /* CONFIG_KEXEC_CORE */
404
405 #endif /* !defined(__ASSEBMLY__) */
406
407 #endif /* LINUX_KEXEC_H */
408