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 <linux/crash_reserve.h> 20 #include <asm/io.h> 21 #include <linux/range.h> 22 23 #include <uapi/linux/kexec.h> 24 #include <linux/verification.h> 25 26 extern note_buf_t __percpu *crash_notes; 27 28 #ifdef CONFIG_KEXEC_CORE 29 #include <linux/list.h> 30 #include <linux/compat.h> 31 #include <linux/ioport.h> 32 #include <linux/module.h> 33 #include <linux/highmem.h> 34 #include <asm/kexec.h> 35 36 /* Verify architecture specific macros are defined */ 37 38 #ifndef KEXEC_SOURCE_MEMORY_LIMIT 39 #error KEXEC_SOURCE_MEMORY_LIMIT not defined 40 #endif 41 42 #ifndef KEXEC_DESTINATION_MEMORY_LIMIT 43 #error KEXEC_DESTINATION_MEMORY_LIMIT not defined 44 #endif 45 46 #ifndef KEXEC_CONTROL_MEMORY_LIMIT 47 #error KEXEC_CONTROL_MEMORY_LIMIT not defined 48 #endif 49 50 #ifndef KEXEC_CONTROL_MEMORY_GFP 51 #define KEXEC_CONTROL_MEMORY_GFP (GFP_KERNEL | __GFP_NORETRY) 52 #endif 53 54 #ifndef KEXEC_CONTROL_PAGE_SIZE 55 #error KEXEC_CONTROL_PAGE_SIZE not defined 56 #endif 57 58 #ifndef KEXEC_ARCH 59 #error KEXEC_ARCH not defined 60 #endif 61 62 #ifndef KEXEC_CRASH_CONTROL_MEMORY_LIMIT 63 #define KEXEC_CRASH_CONTROL_MEMORY_LIMIT KEXEC_CONTROL_MEMORY_LIMIT 64 #endif 65 66 #ifndef KEXEC_CRASH_MEM_ALIGN 67 #define KEXEC_CRASH_MEM_ALIGN PAGE_SIZE 68 #endif 69 70 #define KEXEC_CORE_NOTE_NAME CRASH_CORE_NOTE_NAME 71 72 /* 73 * This structure is used to hold the arguments that are used when loading 74 * kernel binaries. 75 */ 76 77 typedef unsigned long kimage_entry_t; 78 79 struct kexec_segment { 80 /* 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. 84 * 85 * Use ->buf when expecting to deal with user memory and use ->kbuf 86 * when expecting to deal with kernel memory. 87 */ 88 union { 89 void __user *buf; 90 void *kbuf; 91 }; 92 size_t bufsz; 93 unsigned long mem; 94 size_t memsz; 95 }; 96 97 #ifdef CONFIG_COMPAT 98 struct compat_kexec_segment { 99 compat_uptr_t buf; 100 compat_size_t bufsz; 101 compat_ulong_t mem; /* User space sees this as a (void *) ... */ 102 compat_size_t memsz; 103 }; 104 #endif 105 106 #ifdef CONFIG_KEXEC_FILE 107 struct purgatory_info { 108 /* 109 * Pointer to elf header at the beginning of kexec_purgatory. 110 * Note: kexec_purgatory is read only 111 */ 112 const Elf_Ehdr *ehdr; 113 /* 114 * Temporary, modifiable buffer for sechdrs used for relocation. 115 * This memory can be freed post image load. 116 */ 117 Elf_Shdr *sechdrs; 118 /* 119 * Temporary, modifiable buffer for stripped purgatory used for 120 * relocation. This memory can be freed post image load. 121 */ 122 void *purgatory_buf; 123 }; 124 125 struct kimage; 126 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); 133 134 #ifdef CONFIG_KEXEC_SIG 135 typedef int (kexec_verify_sig_t)(const char *kernel_buf, 136 unsigned long kernel_len); 137 #endif 138 139 struct kexec_file_ops { 140 kexec_probe_t *probe; 141 kexec_load_t *load; 142 kexec_cleanup_t *cleanup; 143 #ifdef CONFIG_KEXEC_SIG 144 kexec_verify_sig_t *verify_sig; 145 #endif 146 }; 147 148 extern const struct kexec_file_ops * const kexec_file_loaders[]; 149 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); 153 154 /* 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. 157 */ 158 #ifndef KEXEC_BUF_MEM_UNKNOWN 159 #define KEXEC_BUF_MEM_UNKNOWN 0 160 #endif 161 162 /** 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. 173 */ 174 struct kexec_buf { 175 struct kimage *image; 176 void *buffer; 177 unsigned long bufsz; 178 unsigned long mem; 179 unsigned long memsz; 180 unsigned long buf_align; 181 unsigned long buf_min; 182 unsigned long buf_max; 183 bool top_down; 184 }; 185 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, 189 bool get_value); 190 void *kexec_purgatory_get_symbol_addr(struct kimage *image, const char *name); 191 192 #ifndef arch_kexec_kernel_image_probe 193 static inline int 194 arch_kexec_kernel_image_probe(struct kimage *image, void *buf, unsigned long buf_len) 195 { 196 return kexec_image_probe_default(image, buf, buf_len); 197 } 198 #endif 199 200 #ifndef arch_kimage_file_post_load_cleanup 201 static inline int arch_kimage_file_post_load_cleanup(struct kimage *image) 202 { 203 return kexec_image_post_load_cleanup_default(image); 204 } 205 #endif 206 207 #ifdef CONFIG_KEXEC_SIG 208 #ifdef CONFIG_SIGNED_PE_FILE_VERIFICATION 209 int kexec_kernel_verify_pe_sig(const char *kernel, unsigned long kernel_len); 210 #endif 211 #endif 212 213 extern int kexec_add_buffer(struct kexec_buf *kbuf); 214 int kexec_locate_mem_hole(struct kexec_buf *kbuf); 215 216 #ifndef arch_kexec_locate_mem_hole 217 /** 218 * arch_kexec_locate_mem_hole - Find free memory to place the segments. 219 * @kbuf: Parameters for the memory search. 220 * 221 * On success, kbuf->mem will have the start address of the memory region found. 222 * 223 * Return: 0 on success, negative errno on error. 224 */ 225 static inline int arch_kexec_locate_mem_hole(struct kexec_buf *kbuf) 226 { 227 return kexec_locate_mem_hole(kbuf); 228 } 229 #endif 230 231 #ifndef arch_kexec_apply_relocations_add 232 /* 233 * arch_kexec_apply_relocations_add - apply relocations of type RELA 234 * @pi: Purgatory to be relocated. 235 * @section: Section relocations applying to. 236 * @relsec: Section containing RELAs. 237 * @symtab: Corresponding symtab. 238 * 239 * Return: 0 on success, negative errno on error. 240 */ 241 static inline int 242 arch_kexec_apply_relocations_add(struct purgatory_info *pi, Elf_Shdr *section, 243 const Elf_Shdr *relsec, const Elf_Shdr *symtab) 244 { 245 pr_err("RELA relocation unsupported.\n"); 246 return -ENOEXEC; 247 } 248 #endif 249 250 #ifndef arch_kexec_apply_relocations 251 /* 252 * arch_kexec_apply_relocations - apply relocations of type REL 253 * @pi: Purgatory to be relocated. 254 * @section: Section relocations applying to. 255 * @relsec: Section containing RELs. 256 * @symtab: Corresponding symtab. 257 * 258 * Return: 0 on success, negative errno on error. 259 */ 260 static inline int 261 arch_kexec_apply_relocations(struct purgatory_info *pi, Elf_Shdr *section, 262 const Elf_Shdr *relsec, const Elf_Shdr *symtab) 263 { 264 pr_err("REL relocation unsupported.\n"); 265 return -ENOEXEC; 266 } 267 #endif 268 #endif /* CONFIG_KEXEC_FILE */ 269 270 #ifdef CONFIG_KEXEC_ELF 271 struct kexec_elf_info { 272 /* 273 * Where the ELF binary contents are kept. 274 * Memory managed by the user of the struct. 275 */ 276 const char *buffer; 277 278 const struct elfhdr *ehdr; 279 const struct elf_phdr *proghdrs; 280 }; 281 282 int kexec_build_elf_info(const char *buf, size_t len, struct elfhdr *ehdr, 283 struct kexec_elf_info *elf_info); 284 285 int kexec_elf_load(struct kimage *image, struct elfhdr *ehdr, 286 struct kexec_elf_info *elf_info, 287 struct kexec_buf *kbuf, 288 unsigned long *lowest_load_addr); 289 290 void kexec_free_elf_info(struct kexec_elf_info *elf_info); 291 int kexec_elf_probe(const char *buf, unsigned long len); 292 #endif 293 struct kimage { 294 kimage_entry_t head; 295 kimage_entry_t *entry; 296 kimage_entry_t *last_entry; 297 298 unsigned long start; 299 struct page *control_code_page; 300 struct page *swap_page; 301 void *vmcoreinfo_data_copy; /* locates in the crash memory */ 302 303 unsigned long nr_segments; 304 struct kexec_segment segment[KEXEC_SEGMENT_MAX]; 305 306 struct list_head control_pages; 307 struct list_head dest_pages; 308 struct list_head unusable_pages; 309 310 /* Address of next control page to allocate for crash kernels. */ 311 unsigned long control_page; 312 313 /* Flags to indicate special processing */ 314 unsigned int type : 1; 315 #define KEXEC_TYPE_DEFAULT 0 316 #define KEXEC_TYPE_CRASH 1 317 unsigned int preserve_context : 1; 318 /* If set, we are using file mode kexec syscall */ 319 unsigned int file_mode:1; 320 #ifdef CONFIG_CRASH_HOTPLUG 321 /* If set, allow changes to elfcorehdr of kexec_load'd image */ 322 unsigned int update_elfcorehdr:1; 323 #endif 324 325 #ifdef ARCH_HAS_KIMAGE_ARCH 326 struct kimage_arch arch; 327 #endif 328 329 #ifdef CONFIG_KEXEC_FILE 330 /* Additional fields for file based kexec syscall */ 331 void *kernel_buf; 332 unsigned long kernel_buf_len; 333 334 void *initrd_buf; 335 unsigned long initrd_buf_len; 336 337 char *cmdline_buf; 338 unsigned long cmdline_buf_len; 339 340 /* File operations provided by image loader */ 341 const struct kexec_file_ops *fops; 342 343 /* Image loader handling the kernel can store a pointer here */ 344 void *image_loader_data; 345 346 /* Information for loading purgatory */ 347 struct purgatory_info purgatory_info; 348 #endif 349 350 #ifdef CONFIG_CRASH_HOTPLUG 351 int hp_action; 352 int elfcorehdr_index; 353 bool elfcorehdr_updated; 354 #endif 355 356 #ifdef CONFIG_IMA_KEXEC 357 /* Virtual address of IMA measurement buffer for kexec syscall */ 358 void *ima_buffer; 359 360 phys_addr_t ima_buffer_addr; 361 size_t ima_buffer_size; 362 #endif 363 364 /* Core ELF header buffer */ 365 void *elf_headers; 366 unsigned long elf_headers_sz; 367 unsigned long elf_load_addr; 368 }; 369 370 /* kexec interface functions */ 371 extern void machine_kexec(struct kimage *image); 372 extern int machine_kexec_prepare(struct kimage *image); 373 extern void machine_kexec_cleanup(struct kimage *image); 374 extern int kernel_kexec(void); 375 extern struct page *kimage_alloc_control_pages(struct kimage *image, 376 unsigned int order); 377 378 #ifndef machine_kexec_post_load 379 static inline int machine_kexec_post_load(struct kimage *image) { return 0; } 380 #endif 381 382 extern void __crash_kexec(struct pt_regs *); 383 extern void crash_kexec(struct pt_regs *); 384 int kexec_should_crash(struct task_struct *); 385 int kexec_crash_loaded(void); 386 void crash_save_cpu(struct pt_regs *regs, int cpu); 387 extern int kimage_crash_copy_vmcoreinfo(struct kimage *image); 388 389 extern struct kimage *kexec_image; 390 extern struct kimage *kexec_crash_image; 391 392 bool kexec_load_permitted(int kexec_image_type); 393 394 #ifndef kexec_flush_icache_page 395 #define kexec_flush_icache_page(page) 396 #endif 397 398 /* List of defined/legal kexec flags */ 399 #ifndef CONFIG_KEXEC_JUMP 400 #define KEXEC_FLAGS (KEXEC_ON_CRASH | KEXEC_UPDATE_ELFCOREHDR) 401 #else 402 #define KEXEC_FLAGS (KEXEC_ON_CRASH | KEXEC_PRESERVE_CONTEXT | KEXEC_UPDATE_ELFCOREHDR) 403 #endif 404 405 /* List of defined/legal kexec file flags */ 406 #define KEXEC_FILE_FLAGS (KEXEC_FILE_UNLOAD | KEXEC_FILE_ON_CRASH | \ 407 KEXEC_FILE_NO_INITRAMFS | KEXEC_FILE_DEBUG) 408 409 /* flag to track if kexec reboot is in progress */ 410 extern bool kexec_in_progress; 411 412 int crash_shrink_memory(unsigned long new_size); 413 ssize_t crash_get_memory_size(void); 414 415 #ifndef arch_kexec_protect_crashkres 416 /* 417 * Protection mechanism for crashkernel reserved memory after 418 * the kdump kernel is loaded. 419 * 420 * Provide an empty default implementation here -- architecture 421 * code may override this 422 */ 423 static inline void arch_kexec_protect_crashkres(void) { } 424 #endif 425 426 #ifndef arch_kexec_unprotect_crashkres 427 static inline void arch_kexec_unprotect_crashkres(void) { } 428 #endif 429 430 #ifndef page_to_boot_pfn 431 static inline unsigned long page_to_boot_pfn(struct page *page) 432 { 433 return page_to_pfn(page); 434 } 435 #endif 436 437 #ifndef boot_pfn_to_page 438 static inline struct page *boot_pfn_to_page(unsigned long boot_pfn) 439 { 440 return pfn_to_page(boot_pfn); 441 } 442 #endif 443 444 #ifndef phys_to_boot_phys 445 static inline unsigned long phys_to_boot_phys(phys_addr_t phys) 446 { 447 return phys; 448 } 449 #endif 450 451 #ifndef boot_phys_to_phys 452 static inline phys_addr_t boot_phys_to_phys(unsigned long boot_phys) 453 { 454 return boot_phys; 455 } 456 #endif 457 458 #ifndef crash_free_reserved_phys_range 459 static inline void crash_free_reserved_phys_range(unsigned long begin, unsigned long end) 460 { 461 unsigned long addr; 462 463 for (addr = begin; addr < end; addr += PAGE_SIZE) 464 free_reserved_page(boot_pfn_to_page(addr >> PAGE_SHIFT)); 465 } 466 #endif 467 468 static inline unsigned long virt_to_boot_phys(void *addr) 469 { 470 return phys_to_boot_phys(__pa((unsigned long)addr)); 471 } 472 473 static inline void *boot_phys_to_virt(unsigned long entry) 474 { 475 return phys_to_virt(boot_phys_to_phys(entry)); 476 } 477 478 #ifndef arch_kexec_post_alloc_pages 479 static inline int arch_kexec_post_alloc_pages(void *vaddr, unsigned int pages, gfp_t gfp) { return 0; } 480 #endif 481 482 #ifndef arch_kexec_pre_free_pages 483 static inline void arch_kexec_pre_free_pages(void *vaddr, unsigned int pages) { } 484 #endif 485 486 #ifndef arch_crash_handle_hotplug_event 487 static inline void arch_crash_handle_hotplug_event(struct kimage *image) { } 488 #endif 489 490 int crash_check_update_elfcorehdr(void); 491 492 #ifndef crash_hotplug_cpu_support 493 static inline int crash_hotplug_cpu_support(void) { return 0; } 494 #endif 495 496 #ifndef crash_hotplug_memory_support 497 static inline int crash_hotplug_memory_support(void) { return 0; } 498 #endif 499 500 #ifndef crash_get_elfcorehdr_size 501 static inline unsigned int crash_get_elfcorehdr_size(void) { return 0; } 502 #endif 503 504 extern bool kexec_file_dbg_print; 505 506 #define kexec_dprintk(fmt, ...) \ 507 printk("%s" fmt, \ 508 kexec_file_dbg_print ? KERN_INFO : KERN_DEBUG, \ 509 ##__VA_ARGS__) 510 511 #else /* !CONFIG_KEXEC_CORE */ 512 struct pt_regs; 513 struct task_struct; 514 static inline void __crash_kexec(struct pt_regs *regs) { } 515 static inline void crash_kexec(struct pt_regs *regs) { } 516 static inline int kexec_should_crash(struct task_struct *p) { return 0; } 517 static inline int kexec_crash_loaded(void) { return 0; } 518 #define kexec_in_progress false 519 #endif /* CONFIG_KEXEC_CORE */ 520 521 #ifdef CONFIG_KEXEC_SIG 522 void set_kexec_sig_enforced(void); 523 #else 524 static inline void set_kexec_sig_enforced(void) {} 525 #endif 526 527 #endif /* !defined(__ASSEBMLY__) */ 528 529 #endif /* LINUX_KEXEC_H */ 530