include/linux/kexec.h

   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         /* Address where purgatory is finally loaded and is executed from */
 119         unsigned long purgatory_load_addr;
 120 };
 121
 122 struct kimage;
 123
 124 typedef int (kexec_probe_t)(const char *kernel_buf, unsigned long kernel_size);
 125 typedef void *(kexec_load_t)(struct kimage *image, char *kernel_buf,
 126                              unsigned long kernel_len, char *initrd,
 127                              unsigned long initrd_len, char *cmdline,
 128                              unsigned long cmdline_len);
 129 typedef int (kexec_cleanup_t)(void *loader_data);
 130
 131 #ifdef CONFIG_KEXEC_VERIFY_SIG
 132 typedef int (kexec_verify_sig_t)(const char *kernel_buf,
 133                                  unsigned long kernel_len);
 134 #endif
 135
 136 struct kexec_file_ops {
 137         kexec_probe_t *probe;
 138         kexec_load_t *load;
 139         kexec_cleanup_t *cleanup;
 140 #ifdef CONFIG_KEXEC_VERIFY_SIG
 141         kexec_verify_sig_t *verify_sig;
 142 #endif
 143 };
 144
 145 extern const struct kexec_file_ops * const kexec_file_loaders[];
 146
 147 int kexec_image_probe_default(struct kimage *image, void *buf,
 148                               unsigned long buf_len);
 149
 150 /**
 151  * struct kexec_buf - parameters for finding a place for a buffer in memory
 152  * @image:      kexec image in which memory to search.
 153  * @buffer:     Contents which will be copied to the allocated memory.
 154  * @bufsz:      Size of @buffer.
 155  * @mem:        On return will have address of the buffer in memory.
 156  * @memsz:      Size for the buffer in memory.
 157  * @buf_align:  Minimum alignment needed.
 158  * @buf_min:    The buffer can't be placed below this address.
 159  * @buf_max:    The buffer can't be placed above this address.
 160  * @top_down:   Allocate from top of memory.
 161  */
 162 struct kexec_buf {
 163         struct kimage *image;
 164         void *buffer;
 165         unsigned long bufsz;
 166         unsigned long mem;
 167         unsigned long memsz;
 168         unsigned long buf_align;
 169         unsigned long buf_min;
 170         unsigned long buf_max;
 171         bool top_down;
 172 };
 173
 174 int __weak arch_kexec_walk_mem(struct kexec_buf *kbuf,
 175                                int (*func)(struct resource *, void *));
 176 extern int kexec_add_buffer(struct kexec_buf *kbuf);
 177 int kexec_locate_mem_hole(struct kexec_buf *kbuf);
 178
 179 /* Alignment required for elf header segment */
 180 #define ELF_CORE_HEADER_ALIGN   4096
 181
 182 struct crash_mem_range {
 183         u64 start, end;
 184 };
 185
 186 struct crash_mem {
 187         unsigned int max_nr_ranges;
 188         unsigned int nr_ranges;
 189         struct crash_mem_range ranges[0];
 190 };
 191
 192 extern int crash_exclude_mem_range(struct crash_mem *mem,
 193                                    unsigned long long mstart,
 194                                    unsigned long long mend);
 195 extern int crash_prepare_elf64_headers(struct crash_mem *mem, int kernel_map,
 196                                        void **addr, unsigned long *sz);
 197 #endif /* CONFIG_KEXEC_FILE */
 198
 199 struct kimage {
 200         kimage_entry_t head;
 201         kimage_entry_t *entry;
 202         kimage_entry_t *last_entry;
 203
 204         unsigned long start;
 205         struct page *control_code_page;
 206         struct page *swap_page;
 207         void *vmcoreinfo_data_copy; /* locates in the crash memory */
 208
 209         unsigned long nr_segments;
 210         struct kexec_segment segment[KEXEC_SEGMENT_MAX];
 211
 212         struct list_head control_pages;
 213         struct list_head dest_pages;
 214         struct list_head unusable_pages;
 215
 216         /* Address of next control page to allocate for crash kernels. */
 217         unsigned long control_page;
 218
 219         /* Flags to indicate special processing */
 220         unsigned int type : 1;
 221 #define KEXEC_TYPE_DEFAULT 0
 222 #define KEXEC_TYPE_CRASH   1
 223         unsigned int preserve_context : 1;
 224         /* If set, we are using file mode kexec syscall */
 225         unsigned int file_mode:1;
 226
 227 #ifdef ARCH_HAS_KIMAGE_ARCH
 228         struct kimage_arch arch;
 229 #endif
 230
 231 #ifdef CONFIG_KEXEC_FILE
 232         /* Additional fields for file based kexec syscall */
 233         void *kernel_buf;
 234         unsigned long kernel_buf_len;
 235
 236         void *initrd_buf;
 237         unsigned long initrd_buf_len;
 238
 239         char *cmdline_buf;
 240         unsigned long cmdline_buf_len;
 241
 242         /* File operations provided by image loader */
 243         const struct kexec_file_ops *fops;
 244
 245         /* Image loader handling the kernel can store a pointer here */
 246         void *image_loader_data;
 247
 248         /* Information for loading purgatory */
 249         struct purgatory_info purgatory_info;
 250 #endif
 251 };
 252
 253 /* kexec interface functions */
 254 extern void machine_kexec(struct kimage *image);
 255 extern int machine_kexec_prepare(struct kimage *image);
 256 extern void machine_kexec_cleanup(struct kimage *image);
 257 extern int kernel_kexec(void);
 258 extern struct page *kimage_alloc_control_pages(struct kimage *image,
 259                                                 unsigned int order);
 260 extern int kexec_load_purgatory(struct kimage *image, unsigned long min,
 261                                 unsigned long max, int top_down,
 262                                 unsigned long *load_addr);
 263 extern int kexec_purgatory_get_set_symbol(struct kimage *image,
 264                                           const char *name, void *buf,
 265                                           unsigned int size, bool get_value);
 266 extern void *kexec_purgatory_get_symbol_addr(struct kimage *image,
 267                                              const char *name);
 268 extern void __crash_kexec(struct pt_regs *);
 269 extern void crash_kexec(struct pt_regs *);
 270 int kexec_should_crash(struct task_struct *);
 271 int kexec_crash_loaded(void);
 272 void crash_save_cpu(struct pt_regs *regs, int cpu);
 273 extern int kimage_crash_copy_vmcoreinfo(struct kimage *image);
 274
 275 extern struct kimage *kexec_image;
 276 extern struct kimage *kexec_crash_image;
 277 extern int kexec_load_disabled;
 278
 279 #ifndef kexec_flush_icache_page
 280 #define kexec_flush_icache_page(page)
 281 #endif
 282
 283 /* List of defined/legal kexec flags */
 284 #ifndef CONFIG_KEXEC_JUMP
 285 #define KEXEC_FLAGS    KEXEC_ON_CRASH
 286 #else
 287 #define KEXEC_FLAGS    (KEXEC_ON_CRASH | KEXEC_PRESERVE_CONTEXT)
 288 #endif
 289
 290 /* List of defined/legal kexec file flags */
 291 #define KEXEC_FILE_FLAGS        (KEXEC_FILE_UNLOAD | KEXEC_FILE_ON_CRASH | \
 292                                  KEXEC_FILE_NO_INITRAMFS)
 293
 294 /* Location of a reserved region to hold the crash kernel.
 295  */
 296 extern struct resource crashk_res;
 297 extern struct resource crashk_low_res;
 298 extern note_buf_t __percpu *crash_notes;
 299
 300 /* flag to track if kexec reboot is in progress */
 301 extern bool kexec_in_progress;
 302
 303 int crash_shrink_memory(unsigned long new_size);
 304 size_t crash_get_memory_size(void);
 305 void crash_free_reserved_phys_range(unsigned long begin, unsigned long end);
 306
 307 int __weak arch_kexec_apply_relocations_add(const Elf_Ehdr *ehdr,
 308                                         Elf_Shdr *sechdrs, unsigned int relsec);
 309 int __weak arch_kexec_apply_relocations(const Elf_Ehdr *ehdr, Elf_Shdr *sechdrs,
 310                                         unsigned int relsec);
 311 void arch_kexec_protect_crashkres(void);
 312 void arch_kexec_unprotect_crashkres(void);
 313
 314 #ifndef page_to_boot_pfn
 315 static inline unsigned long page_to_boot_pfn(struct page *page)
 316 {
 317         return page_to_pfn(page);
 318 }
 319 #endif
 320
 321 #ifndef boot_pfn_to_page
 322 static inline struct page *boot_pfn_to_page(unsigned long boot_pfn)
 323 {
 324         return pfn_to_page(boot_pfn);
 325 }
 326 #endif
 327
 328 #ifndef phys_to_boot_phys
 329 static inline unsigned long phys_to_boot_phys(phys_addr_t phys)
 330 {
 331         return phys;
 332 }
 333 #endif
 334
 335 #ifndef boot_phys_to_phys
 336 static inline phys_addr_t boot_phys_to_phys(unsigned long boot_phys)
 337 {
 338         return boot_phys;
 339 }
 340 #endif
 341
 342 static inline unsigned long virt_to_boot_phys(void *addr)
 343 {
 344         return phys_to_boot_phys(__pa((unsigned long)addr));
 345 }
 346
 347 static inline void *boot_phys_to_virt(unsigned long entry)
 348 {
 349         return phys_to_virt(boot_phys_to_phys(entry));
 350 }
 351
 352 #ifndef arch_kexec_post_alloc_pages
 353 static inline int arch_kexec_post_alloc_pages(void *vaddr, unsigned int pages, gfp_t gfp) { return 0; }
 354 #endif
 355
 356 #ifndef arch_kexec_pre_free_pages
 357 static inline void arch_kexec_pre_free_pages(void *vaddr, unsigned int pages) { }
 358 #endif
 359
 360 #else /* !CONFIG_KEXEC_CORE */
 361 struct pt_regs;
 362 struct task_struct;
 363 static inline void __crash_kexec(struct pt_regs *regs) { }
 364 static inline void crash_kexec(struct pt_regs *regs) { }
 365 static inline int kexec_should_crash(struct task_struct *p) { return 0; }
 366 static inline int kexec_crash_loaded(void) { return 0; }
 367 #define kexec_in_progress false
 368 #endif /* CONFIG_KEXEC_CORE */
 369
 370 #endif /* !defined(__ASSEBMLY__) */
 371
 372 #endif /* LINUX_KEXEC_H */