[linux-2.6-block.git] / include / linux / kexec.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef LINUX_KEXEC_H
#define LINUX_KEXEC_H

#define IND_DESTINATION_BIT 0
#define IND_INDIRECTION_BIT 1
#define IND_DONE_BIT        2
#define IND_SOURCE_BIT      3

#define IND_DESTINATION  (1 << IND_DESTINATION_BIT)
#define IND_INDIRECTION  (1 << IND_INDIRECTION_BIT)
#define IND_DONE         (1 << IND_DONE_BIT)
#define IND_SOURCE       (1 << IND_SOURCE_BIT)
#define IND_FLAGS (IND_DESTINATION | IND_INDIRECTION | IND_DONE | IND_SOURCE)

#if !defined(__ASSEMBLY__)

#include <linux/vmcore_info.h>
#include <linux/crash_reserve.h>
#include <asm/io.h>
#include <linux/range.h>

#include <uapi/linux/kexec.h>
#include <linux/verification.h>

extern note_buf_t __percpu *crash_notes;

#ifdef CONFIG_KEXEC_CORE
#include <linux/list.h>
#include <linux/compat.h>
#include <linux/ioport.h>
#include <linux/module.h>
#include <linux/highmem.h>
#include <asm/kexec.h>
#include <linux/crash_core.h>

/* Verify architecture specific macros are defined */

#ifndef KEXEC_SOURCE_MEMORY_LIMIT
#error KEXEC_SOURCE_MEMORY_LIMIT not defined
#endif

#ifndef KEXEC_DESTINATION_MEMORY_LIMIT
#error KEXEC_DESTINATION_MEMORY_LIMIT not defined
#endif

#ifndef KEXEC_CONTROL_MEMORY_LIMIT
#error KEXEC_CONTROL_MEMORY_LIMIT not defined
#endif

#ifndef KEXEC_CONTROL_MEMORY_GFP
#define KEXEC_CONTROL_MEMORY_GFP (GFP_KERNEL | __GFP_NORETRY)
#endif

#ifndef KEXEC_CONTROL_PAGE_SIZE
#error KEXEC_CONTROL_PAGE_SIZE not defined
#endif

#ifndef KEXEC_ARCH
#error KEXEC_ARCH not defined
#endif

#ifndef KEXEC_CRASH_CONTROL_MEMORY_LIMIT
#define KEXEC_CRASH_CONTROL_MEMORY_LIMIT KEXEC_CONTROL_MEMORY_LIMIT
#endif

#ifndef KEXEC_CRASH_MEM_ALIGN
#define KEXEC_CRASH_MEM_ALIGN PAGE_SIZE
#endif

#define KEXEC_CORE_NOTE_NAME	CRASH_CORE_NOTE_NAME

/*
 * This structure is used to hold the arguments that are used when loading
 * kernel binaries.
 */

typedef unsigned long kimage_entry_t;

struct kexec_segment {
	/*
	 * This pointer can point to user memory if kexec_load() system
	 * call is used or will point to kernel memory if
	 * kexec_file_load() system call is used.
	 *
	 * Use ->buf when expecting to deal with user memory and use ->kbuf
	 * when expecting to deal with kernel memory.
	 */
	union {
		void __user *buf;
		void *kbuf;
	};
	size_t bufsz;
	unsigned long mem;
	size_t memsz;
};

#ifdef CONFIG_COMPAT
struct compat_kexec_segment {
	compat_uptr_t buf;
	compat_size_t bufsz;
	compat_ulong_t mem;	/* User space sees this as a (void *) ... */
	compat_size_t memsz;
};
#endif

#ifdef CONFIG_KEXEC_FILE
struct purgatory_info {
	/*
	 * Pointer to elf header at the beginning of kexec_purgatory.
	 * Note: kexec_purgatory is read only
	 */
	const Elf_Ehdr *ehdr;
	/*
	 * Temporary, modifiable buffer for sechdrs used for relocation.
	 * This memory can be freed post image load.
	 */
	Elf_Shdr *sechdrs;
	/*
	 * Temporary, modifiable buffer for stripped purgatory used for
	 * relocation. This memory can be freed post image load.
	 */
	void *purgatory_buf;
};

struct kimage;

typedef int (kexec_probe_t)(const char *kernel_buf, unsigned long kernel_size);
typedef void *(kexec_load_t)(struct kimage *image, char *kernel_buf,
			     unsigned long kernel_len, char *initrd,
			     unsigned long initrd_len, char *cmdline,
			     unsigned long cmdline_len);
typedef int (kexec_cleanup_t)(void *loader_data);

#ifdef CONFIG_KEXEC_SIG
typedef int (kexec_verify_sig_t)(const char *kernel_buf,
				 unsigned long kernel_len);
#endif

struct kexec_file_ops {
	kexec_probe_t *probe;
	kexec_load_t *load;
	kexec_cleanup_t *cleanup;
#ifdef CONFIG_KEXEC_SIG
	kexec_verify_sig_t *verify_sig;
#endif
};

extern const struct kexec_file_ops * const kexec_file_loaders[];

int kexec_image_probe_default(struct kimage *image, void *buf,
			      unsigned long buf_len);
int kexec_image_post_load_cleanup_default(struct kimage *image);

/*
 * If kexec_buf.mem is set to this value, kexec_locate_mem_hole()
 * will try to allocate free memory. Arch may overwrite it.
 */
#ifndef KEXEC_BUF_MEM_UNKNOWN
#define KEXEC_BUF_MEM_UNKNOWN 0
#endif

/**
 * struct kexec_buf - parameters for finding a place for a buffer in memory
 * @image:	kexec image in which memory to search.
 * @buffer:	Contents which will be copied to the allocated memory.
 * @bufsz:	Size of @buffer.
 * @mem:	On return will have address of the buffer in memory.
 * @memsz:	Size for the buffer in memory.
 * @buf_align:	Minimum alignment needed.
 * @buf_min:	The buffer can't be placed below this address.
 * @buf_max:	The buffer can't be placed above this address.
 * @top_down:	Allocate from top of memory.
 */
struct kexec_buf {
	struct kimage *image;
	void *buffer;
	unsigned long bufsz;
	unsigned long mem;
	unsigned long memsz;
	unsigned long buf_align;
	unsigned long buf_min;
	unsigned long buf_max;
	bool top_down;
};

int kexec_load_purgatory(struct kimage *image, struct kexec_buf *kbuf);
int kexec_purgatory_get_set_symbol(struct kimage *image, const char *name,
				   void *buf, unsigned int size,
				   bool get_value);
void *kexec_purgatory_get_symbol_addr(struct kimage *image, const char *name);

#ifndef arch_kexec_kernel_image_probe
static inline int
arch_kexec_kernel_image_probe(struct kimage *image, void *buf, unsigned long buf_len)
{
	return kexec_image_probe_default(image, buf, buf_len);
}
#endif

#ifndef arch_kimage_file_post_load_cleanup
static inline int arch_kimage_file_post_load_cleanup(struct kimage *image)
{
	return kexec_image_post_load_cleanup_default(image);
}
#endif

#ifdef CONFIG_KEXEC_SIG
#ifdef CONFIG_SIGNED_PE_FILE_VERIFICATION
int kexec_kernel_verify_pe_sig(const char *kernel, unsigned long kernel_len);
#endif
#endif

extern int kexec_add_buffer(struct kexec_buf *kbuf);
int kexec_locate_mem_hole(struct kexec_buf *kbuf);

#ifndef arch_kexec_locate_mem_hole
/**
 * arch_kexec_locate_mem_hole - Find free memory to place the segments.
 * @kbuf:                       Parameters for the memory search.
 *
 * On success, kbuf->mem will have the start address of the memory region found.
 *
 * Return: 0 on success, negative errno on error.
 */
static inline int arch_kexec_locate_mem_hole(struct kexec_buf *kbuf)
{
	return kexec_locate_mem_hole(kbuf);
}
#endif

#ifndef arch_kexec_apply_relocations_add
/*
 * arch_kexec_apply_relocations_add - apply relocations of type RELA
 * @pi:		Purgatory to be relocated.
 * @section:	Section relocations applying to.
 * @relsec:	Section containing RELAs.
 * @symtab:	Corresponding symtab.
 *
 * Return: 0 on success, negative errno on error.
 */
static inline int
arch_kexec_apply_relocations_add(struct purgatory_info *pi, Elf_Shdr *section,
				 const Elf_Shdr *relsec, const Elf_Shdr *symtab)
{
	pr_err("RELA relocation unsupported.\n");
	return -ENOEXEC;
}
#endif

#ifndef arch_kexec_apply_relocations
/*
 * arch_kexec_apply_relocations - apply relocations of type REL
 * @pi:		Purgatory to be relocated.
 * @section:	Section relocations applying to.
 * @relsec:	Section containing RELs.
 * @symtab:	Corresponding symtab.
 *
 * Return: 0 on success, negative errno on error.
 */
static inline int
arch_kexec_apply_relocations(struct purgatory_info *pi, Elf_Shdr *section,
			     const Elf_Shdr *relsec, const Elf_Shdr *symtab)
{
	pr_err("REL relocation unsupported.\n");
	return -ENOEXEC;
}
#endif
#endif /* CONFIG_KEXEC_FILE */

#ifdef CONFIG_KEXEC_ELF
struct kexec_elf_info {
	/*
	 * Where the ELF binary contents are kept.
	 * Memory managed by the user of the struct.
	 */
	const char *buffer;

	const struct elfhdr *ehdr;
	const struct elf_phdr *proghdrs;
};

int kexec_build_elf_info(const char *buf, size_t len, struct elfhdr *ehdr,
			       struct kexec_elf_info *elf_info);

int kexec_elf_load(struct kimage *image, struct elfhdr *ehdr,
			 struct kexec_elf_info *elf_info,
			 struct kexec_buf *kbuf,
			 unsigned long *lowest_load_addr);

void kexec_free_elf_info(struct kexec_elf_info *elf_info);
int kexec_elf_probe(const char *buf, unsigned long len);
#endif
struct kimage {
	kimage_entry_t head;
	kimage_entry_t *entry;
	kimage_entry_t *last_entry;

	unsigned long start;
	struct page *control_code_page;
	struct page *swap_page;
	void *vmcoreinfo_data_copy; /* locates in the crash memory */

	unsigned long nr_segments;
	struct kexec_segment segment[KEXEC_SEGMENT_MAX];

	struct list_head control_pages;
	struct list_head dest_pages;
	struct list_head unusable_pages;

	/* Address of next control page to allocate for crash kernels. */
	unsigned long control_page;

	/* Flags to indicate special processing */
	unsigned int type : 1;
#define KEXEC_TYPE_DEFAULT 0
#define KEXEC_TYPE_CRASH   1
	unsigned int preserve_context : 1;
	/* If set, we are using file mode kexec syscall */
	unsigned int file_mode:1;
#ifdef CONFIG_CRASH_HOTPLUG
	/* If set, allow changes to elfcorehdr of kexec_load'd image */
	unsigned int update_elfcorehdr:1;
#endif

#ifdef ARCH_HAS_KIMAGE_ARCH
	struct kimage_arch arch;
#endif

#ifdef CONFIG_KEXEC_FILE
	/* Additional fields for file based kexec syscall */
	void *kernel_buf;
	unsigned long kernel_buf_len;

	void *initrd_buf;
	unsigned long initrd_buf_len;

	char *cmdline_buf;
	unsigned long cmdline_buf_len;

	/* File operations provided by image loader */
	const struct kexec_file_ops *fops;

	/* Image loader handling the kernel can store a pointer here */
	void *image_loader_data;

	/* Information for loading purgatory */
	struct purgatory_info purgatory_info;
#endif

#ifdef CONFIG_CRASH_HOTPLUG
	int hp_action;
	int elfcorehdr_index;
	bool elfcorehdr_updated;
#endif

#ifdef CONFIG_IMA_KEXEC
	/* Virtual address of IMA measurement buffer for kexec syscall */
	void *ima_buffer;

	phys_addr_t ima_buffer_addr;
	size_t ima_buffer_size;
#endif

	/* Core ELF header buffer */
	void *elf_headers;
	unsigned long elf_headers_sz;
	unsigned long elf_load_addr;
};

/* kexec interface functions */
extern void machine_kexec(struct kimage *image);
extern int machine_kexec_prepare(struct kimage *image);
extern void machine_kexec_cleanup(struct kimage *image);
extern int kernel_kexec(void);
extern struct page *kimage_alloc_control_pages(struct kimage *image,
						unsigned int order);

#ifndef machine_kexec_post_load
static inline int machine_kexec_post_load(struct kimage *image) { return 0; }
#endif

extern struct kimage *kexec_image;
extern struct kimage *kexec_crash_image;

bool kexec_load_permitted(int kexec_image_type);

#ifndef kexec_flush_icache_page
#define kexec_flush_icache_page(page)
#endif

/* List of defined/legal kexec flags */
#ifndef CONFIG_KEXEC_JUMP
#define KEXEC_FLAGS    (KEXEC_ON_CRASH | KEXEC_UPDATE_ELFCOREHDR)
#else
#define KEXEC_FLAGS    (KEXEC_ON_CRASH | KEXEC_PRESERVE_CONTEXT | KEXEC_UPDATE_ELFCOREHDR)
#endif

/* List of defined/legal kexec file flags */
#define KEXEC_FILE_FLAGS	(KEXEC_FILE_UNLOAD | KEXEC_FILE_ON_CRASH | \
				 KEXEC_FILE_NO_INITRAMFS | KEXEC_FILE_DEBUG)

/* flag to track if kexec reboot is in progress */
extern bool kexec_in_progress;

#ifndef page_to_boot_pfn
static inline unsigned long page_to_boot_pfn(struct page *page)
{
	return page_to_pfn(page);
}
#endif

#ifndef boot_pfn_to_page
static inline struct page *boot_pfn_to_page(unsigned long boot_pfn)
{
	return pfn_to_page(boot_pfn);
}
#endif

#ifndef phys_to_boot_phys
static inline unsigned long phys_to_boot_phys(phys_addr_t phys)
{
	return phys;
}
#endif

#ifndef boot_phys_to_phys
static inline phys_addr_t boot_phys_to_phys(unsigned long boot_phys)
{
	return boot_phys;
}
#endif

#ifndef crash_free_reserved_phys_range
static inline void crash_free_reserved_phys_range(unsigned long begin, unsigned long end)
{
	unsigned long addr;

	for (addr = begin; addr < end; addr += PAGE_SIZE)
		free_reserved_page(boot_pfn_to_page(addr >> PAGE_SHIFT));
}
#endif

static inline unsigned long virt_to_boot_phys(void *addr)
{
	return phys_to_boot_phys(__pa((unsigned long)addr));
}

static inline void *boot_phys_to_virt(unsigned long entry)
{
	return phys_to_virt(boot_phys_to_phys(entry));
}

#ifndef arch_kexec_post_alloc_pages
static inline int arch_kexec_post_alloc_pages(void *vaddr, unsigned int pages, gfp_t gfp) { return 0; }
#endif

#ifndef arch_kexec_pre_free_pages
static inline void arch_kexec_pre_free_pages(void *vaddr, unsigned int pages) { }
#endif

extern bool kexec_file_dbg_print;

#define kexec_dprintk(fmt, ...)					\
	printk("%s" fmt,					\
	       kexec_file_dbg_print ? KERN_INFO : KERN_DEBUG,	\
	       ##__VA_ARGS__)

#else /* !CONFIG_KEXEC_CORE */
struct pt_regs;
struct task_struct;
static inline void __crash_kexec(struct pt_regs *regs) { }
static inline void crash_kexec(struct pt_regs *regs) { }
static inline int kexec_should_crash(struct task_struct *p) { return 0; }
static inline int kexec_crash_loaded(void) { return 0; }
#define kexec_in_progress false
#endif /* CONFIG_KEXEC_CORE */

#ifdef CONFIG_KEXEC_SIG
void set_kexec_sig_enforced(void);
#else
static inline void set_kexec_sig_enforced(void) {}
#endif

#endif /* !defined(__ASSEBMLY__) */

#endif /* LINUX_KEXEC_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
dc009d92 EB	2	#ifndef LINUX_KEXEC_H
	3	#define LINUX_KEXEC_H
	4
cf2df639 GL	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)
b28c2ee8	14	#define IND_FLAGS (IND_DESTINATION \| IND_INDIRECTION \| IND_DONE \| IND_SOURCE)
cf2df639 GL	15
	16	#if !defined(__ASSEMBLY__)
	17
443cbaf9	18	#include <linux/vmcore_info.h>
85fcde40	19	#include <linux/crash_reserve.h>
43546d86	20	#include <asm/io.h>
cade589f	21	#include <linux/range.h>
43546d86	22
607ca46e	23	#include <uapi/linux/kexec.h>
c903dae8	24	#include <linux/verification.h>
29a5c67e	25
f05fa109 JZ	26	extern note_buf_t __percpu *crash_notes;
f05fa109 JZ	27
2965faa5	28	#ifdef CONFIG_KEXEC_CORE
dc009d92	29	#include <linux/list.h>
dc009d92	30	#include <linux/compat.h>
9c15e852	31	#include <linux/ioport.h>
12db5562	32	#include <linux/module.h>
24726275	33	#include <linux/highmem.h>
dc009d92	34	#include <asm/kexec.h>
02aff848	35	#include <linux/crash_core.h>
dc009d92 EB	36
	37	/* Verify architecture specific macros are defined */
	38
	39	#ifndef KEXEC_SOURCE_MEMORY_LIMIT
	40	#error KEXEC_SOURCE_MEMORY_LIMIT not defined
	41	#endif
	42
	43	#ifndef KEXEC_DESTINATION_MEMORY_LIMIT
	44	#error KEXEC_DESTINATION_MEMORY_LIMIT not defined
	45	#endif
	46
	47	#ifndef KEXEC_CONTROL_MEMORY_LIMIT
	48	#error KEXEC_CONTROL_MEMORY_LIMIT not defined
	49	#endif
	50
7e01b5ac	51	#ifndef KEXEC_CONTROL_MEMORY_GFP
dc5cccac	52	#define KEXEC_CONTROL_MEMORY_GFP (GFP_KERNEL \| __GFP_NORETRY)
7e01b5ac MS	53	#endif
7e01b5ac MS	54
163f6876 HY	55	#ifndef KEXEC_CONTROL_PAGE_SIZE
163f6876 HY	56	#error KEXEC_CONTROL_PAGE_SIZE not defined
dc009d92 EB	57	#endif
	58
	59	#ifndef KEXEC_ARCH
	60	#error KEXEC_ARCH not defined
	61	#endif
	62
3d214fae MH	63	#ifndef KEXEC_CRASH_CONTROL_MEMORY_LIMIT
	64	#define KEXEC_CRASH_CONTROL_MEMORY_LIMIT KEXEC_CONTROL_MEMORY_LIMIT
	65	#endif
	66
558df720 MH	67	#ifndef KEXEC_CRASH_MEM_ALIGN
	68	#define KEXEC_CRASH_MEM_ALIGN PAGE_SIZE
	69	#endif
	70
692f66f2 HB	71	#define KEXEC_CORE_NOTE_NAME CRASH_CORE_NOTE_NAME
692f66f2 HB	72
dc009d92 EB	73	/*
	74	* This structure is used to hold the arguments that are used when loading
	75	* kernel binaries.
	76	*/
	77
	78	typedef unsigned long kimage_entry_t;
dc009d92	79
dc009d92	80	struct kexec_segment {
815d5704 VG	81	/*
	82	* This pointer can point to user memory if kexec_load() system
	83	* call is used or will point to kernel memory if
	84	* kexec_file_load() system call is used.
	85	*
	86	* Use ->buf when expecting to deal with user memory and use ->kbuf
	87	* when expecting to deal with kernel memory.
	88	*/
	89	union {
	90	void __user *buf;
	91	void *kbuf;
	92	};
dc009d92	93	size_t bufsz;
29a5c67e	94	unsigned long mem;
dc009d92 EB	95	size_t memsz;
	96	};
	97
	98	#ifdef CONFIG_COMPAT
	99	struct compat_kexec_segment {
	100	compat_uptr_t buf;
	101	compat_size_t bufsz;
	102	compat_ulong_t mem; /* User space sees this as a (void ) ... /
	103	compat_size_t memsz;
	104	};
	105	#endif
	106
978e30c9	107	#ifdef CONFIG_KEXEC_FILE
12db5562	108	struct purgatory_info {
65c225d3 PR	109	/*
	110	* Pointer to elf header at the beginning of kexec_purgatory.
	111	* Note: kexec_purgatory is read only
	112	*/
	113	const Elf_Ehdr *ehdr;
	114	/*
	115	* Temporary, modifiable buffer for sechdrs used for relocation.
	116	* This memory can be freed post image load.
	117	*/
12db5562 VG	118	Elf_Shdr *sechdrs;
12db5562 VG	119	/*
65c225d3 PR	120	* Temporary, modifiable buffer for stripped purgatory used for
65c225d3 PR	121	* relocation. This memory can be freed post image load.
12db5562 VG	122	*/
12db5562 VG	123	void *purgatory_buf;
12db5562 VG	124	};
12db5562 VG	125
ee6ebeda PR	126	struct kimage;
ee6ebeda PR	127
978e30c9 XP	128	typedef int (kexec_probe_t)(const char *kernel_buf, unsigned long kernel_size);
	129	typedef void (kexec_load_t)(struct kimage image, char *kernel_buf,
	130	unsigned long kernel_len, char *initrd,
	131	unsigned long initrd_len, char *cmdline,
	132	unsigned long cmdline_len);
	133	typedef int (kexec_cleanup_t)(void *loader_data);
	134
99d5cadf	135	#ifdef CONFIG_KEXEC_SIG
978e30c9 XP	136	typedef int (kexec_verify_sig_t)(const char *kernel_buf,
	137	unsigned long kernel_len);
	138	#endif
	139
	140	struct kexec_file_ops {
	141	kexec_probe_t *probe;
	142	kexec_load_t *load;
	143	kexec_cleanup_t *cleanup;
99d5cadf	144	#ifdef CONFIG_KEXEC_SIG
978e30c9 XP	145	kexec_verify_sig_t *verify_sig;
	146	#endif
	147	};
60fe3910	148
9ec4ecef AT	149	extern const struct kexec_file_ops * const kexec_file_loaders[];
	150
	151	int kexec_image_probe_default(struct kimage image, void buf,
	152	unsigned long buf_len);
92a98a2b	153	int kexec_image_post_load_cleanup_default(struct kimage *image);
9ec4ecef	154
b6664ba4 AT	155	/*
	156	* If kexec_buf.mem is set to this value, kexec_locate_mem_hole()
	157	* will try to allocate free memory. Arch may overwrite it.
	158	*/
	159	#ifndef KEXEC_BUF_MEM_UNKNOWN
	160	#define KEXEC_BUF_MEM_UNKNOWN 0
	161	#endif
	162
60fe3910 TJB	163	/**
	164	* struct kexec_buf - parameters for finding a place for a buffer in memory
	165	* @image: kexec image in which memory to search.
	166	* @buffer: Contents which will be copied to the allocated memory.
	167	* @bufsz: Size of @buffer.
	168	* @mem: On return will have address of the buffer in memory.
	169	* @memsz: Size for the buffer in memory.
	170	* @buf_align: Minimum alignment needed.
	171	* @buf_min: The buffer can't be placed below this address.
	172	* @buf_max: The buffer can't be placed above this address.
	173	* @top_down: Allocate from top of memory.
	174	*/
	175	struct kexec_buf {
	176	struct kimage *image;
ec2b9bfa	177	void *buffer;
60fe3910 TJB	178	unsigned long bufsz;
	179	unsigned long mem;
	180	unsigned long memsz;
	181	unsigned long buf_align;
	182	unsigned long buf_min;
	183	unsigned long buf_max;
	184	bool top_down;
	185	};
	186
3be3f61d PR	187	int kexec_load_purgatory(struct kimage image, struct kexec_buf kbuf);
	188	int kexec_purgatory_get_set_symbol(struct kimage image, const char name,
	189	void *buf, unsigned int size,
	190	bool get_value);
	191	void kexec_purgatory_get_symbol_addr(struct kimage image, const char *name);
65d9a9a6 NR	192
	193	#ifndef arch_kexec_kernel_image_probe
	194	static inline int
	195	arch_kexec_kernel_image_probe(struct kimage image, void buf, unsigned long buf_len)
	196	{
	197	return kexec_image_probe_default(image, buf, buf_len);
	198	}
	199	#endif
	200
	201	#ifndef arch_kimage_file_post_load_cleanup
	202	static inline int arch_kimage_file_post_load_cleanup(struct kimage *image)
	203	{
	204	return kexec_image_post_load_cleanup_default(image);
	205	}
	206	#endif
	207
c903dae8 CX	208	#ifdef CONFIG_KEXEC_SIG
	209	#ifdef CONFIG_SIGNED_PE_FILE_VERIFICATION
	210	int kexec_kernel_verify_pe_sig(const char *kernel, unsigned long kernel_len);
	211	#endif
	212	#endif
	213
ec2b9bfa	214	extern int kexec_add_buffer(struct kexec_buf *kbuf);
e2e806f9	215	int kexec_locate_mem_hole(struct kexec_buf *kbuf);
babac4a8	216
65d9a9a6 NR	217	#ifndef arch_kexec_locate_mem_hole
	218	/**
	219	* arch_kexec_locate_mem_hole - Find free memory to place the segments.
	220	* @kbuf: Parameters for the memory search.
	221	*
	222	* On success, kbuf->mem will have the start address of the memory region found.
	223	*
	224	* Return: 0 on success, negative errno on error.
	225	*/
	226	static inline int arch_kexec_locate_mem_hole(struct kexec_buf *kbuf)
	227	{
	228	return kexec_locate_mem_hole(kbuf);
	229	}
	230	#endif
	231
3e35142e NR	232	#ifndef arch_kexec_apply_relocations_add
	233	/*
	234	* arch_kexec_apply_relocations_add - apply relocations of type RELA
	235	* @pi: Purgatory to be relocated.
	236	* @section: Section relocations applying to.
	237	* @relsec: Section containing RELAs.
	238	* @symtab: Corresponding symtab.
	239	*
	240	* Return: 0 on success, negative errno on error.
	241	*/
	242	static inline int
	243	arch_kexec_apply_relocations_add(struct purgatory_info pi, Elf_Shdr section,
	244	const Elf_Shdr relsec, const Elf_Shdr symtab)
	245	{
	246	pr_err("RELA relocation unsupported.\n");
	247	return -ENOEXEC;
	248	}
	249	#endif
	250
	251	#ifndef arch_kexec_apply_relocations
	252	/*
	253	* arch_kexec_apply_relocations - apply relocations of type REL
	254	* @pi: Purgatory to be relocated.
	255	* @section: Section relocations applying to.
	256	* @relsec: Section containing RELs.
	257	* @symtab: Corresponding symtab.
	258	*
	259	* Return: 0 on success, negative errno on error.
	260	*/
	261	static inline int
	262	arch_kexec_apply_relocations(struct purgatory_info pi, Elf_Shdr section,
	263	const Elf_Shdr relsec, const Elf_Shdr symtab)
	264	{
	265	pr_err("REL relocation unsupported.\n");
	266	return -ENOEXEC;
	267	}
	268	#endif
60fe3910	269	#endif /* CONFIG_KEXEC_FILE */
978e30c9	270
175fca3b SS	271	#ifdef CONFIG_KEXEC_ELF
	272	struct kexec_elf_info {
	273	/*
	274	* Where the ELF binary contents are kept.
	275	* Memory managed by the user of the struct.
	276	*/
	277	const char *buffer;
	278
	279	const struct elfhdr *ehdr;
	280	const struct elf_phdr *proghdrs;
175fca3b SS	281	};
	282
	283	int kexec_build_elf_info(const char buf, size_t len, struct elfhdr ehdr,
	284	struct kexec_elf_info *elf_info);
	285
	286	int kexec_elf_load(struct kimage image, struct elfhdr ehdr,
	287	struct kexec_elf_info *elf_info,
	288	struct kexec_buf *kbuf,
	289	unsigned long *lowest_load_addr);
	290
	291	void kexec_free_elf_info(struct kexec_elf_info *elf_info);
	292	int kexec_elf_probe(const char *buf, unsigned long len);
	293	#endif
dc009d92 EB	294	struct kimage {
	295	kimage_entry_t head;
	296	kimage_entry_t *entry;
	297	kimage_entry_t *last_entry;
	298
dc009d92 EB	299	unsigned long start;
dc009d92 EB	300	struct page *control_code_page;
3ab83521	301	struct page *swap_page;
1229384f	302	void vmcoreinfo_data_copy; / locates in the crash memory */
dc009d92 EB	303
	304	unsigned long nr_segments;
	305	struct kexec_segment segment[KEXEC_SEGMENT_MAX];
	306
	307	struct list_head control_pages;
	308	struct list_head dest_pages;
7d3e2bca	309	struct list_head unusable_pages;
dc009d92 EB	310
	311	/* Address of next control page to allocate for crash kernels. */
	312	unsigned long control_page;
	313
	314	/* Flags to indicate special processing */
	315	unsigned int type : 1;
	316	#define KEXEC_TYPE_DEFAULT 0
	317	#define KEXEC_TYPE_CRASH 1
3ab83521	318	unsigned int preserve_context : 1;
cb105258 VG	319	/* If set, we are using file mode kexec syscall */
cb105258 VG	320	unsigned int file_mode:1;
a72bbec7 ED	321	#ifdef CONFIG_CRASH_HOTPLUG
	322	/* If set, allow changes to elfcorehdr of kexec_load'd image */
	323	unsigned int update_elfcorehdr:1;
	324	#endif
92be3d6b HY	325
	326	#ifdef ARCH_HAS_KIMAGE_ARCH
	327	struct kimage_arch arch;
	328	#endif
cb105258	329
978e30c9	330	#ifdef CONFIG_KEXEC_FILE
cb105258 VG	331	/* Additional fields for file based kexec syscall */
	332	void *kernel_buf;
	333	unsigned long kernel_buf_len;
	334
	335	void *initrd_buf;
	336	unsigned long initrd_buf_len;
	337
	338	char *cmdline_buf;
	339	unsigned long cmdline_buf_len;
	340
	341	/* File operations provided by image loader */
9ec4ecef	342	const struct kexec_file_ops *fops;
cb105258 VG	343
	344	/* Image loader handling the kernel can store a pointer here */
	345	void *image_loader_data;
12db5562 VG	346
	347	/* Information for loading purgatory */
	348	struct purgatory_info purgatory_info;
978e30c9	349	#endif
f31e3386	350
24726275 ED	351	#ifdef CONFIG_CRASH_HOTPLUG
	352	int hp_action;
	353	int elfcorehdr_index;
	354	bool elfcorehdr_updated;
	355	#endif
	356
f31e3386 LR	357	#ifdef CONFIG_IMA_KEXEC
	358	/* Virtual address of IMA measurement buffer for kexec syscall */
	359	void *ima_buffer;
0c605158 LR	360
	361	phys_addr_t ima_buffer_addr;
	362	size_t ima_buffer_size;
f31e3386	363	#endif
9336a5f6 LR	364
	365	/* Core ELF header buffer */
	366	void *elf_headers;
	367	unsigned long elf_headers_sz;
	368	unsigned long elf_load_addr;
cb105258	369	};
dc009d92 EB	370
dc009d92 EB	371	/* kexec interface functions */
3ab83521	372	extern void machine_kexec(struct kimage *image);
dc009d92 EB	373	extern int machine_kexec_prepare(struct kimage *image);
dc009d92 EB	374	extern void machine_kexec_cleanup(struct kimage *image);
3ab83521	375	extern int kernel_kexec(void);
72414d3f MS	376	extern struct page kimage_alloc_control_pages(struct kimage image,
72414d3f MS	377	unsigned int order);
0738eceb NR	378
	379	#ifndef machine_kexec_post_load
	380	static inline int machine_kexec_post_load(struct kimage *image) { return 0; }
	381	#endif
2596b6ae	382
dc009d92	383	extern struct kimage *kexec_image;
c330dda9	384	extern struct kimage *kexec_crash_image;
7e99f8b6	385
a42aaad2	386	bool kexec_load_permitted(int kexec_image_type);
dc009d92	387
a7956113 ZN	388	#ifndef kexec_flush_icache_page
	389	#define kexec_flush_icache_page(page)
	390	#endif
	391
3ab83521 HY	392	/* List of defined/legal kexec flags */
3ab83521 HY	393	#ifndef CONFIG_KEXEC_JUMP
a72bbec7	394	#define KEXEC_FLAGS (KEXEC_ON_CRASH \| KEXEC_UPDATE_ELFCOREHDR)
3ab83521	395	#else
a72bbec7	396	#define KEXEC_FLAGS (KEXEC_ON_CRASH \| KEXEC_PRESERVE_CONTEXT \| KEXEC_UPDATE_ELFCOREHDR)
3ab83521	397	#endif
dc009d92	398
cb105258 VG	399	/* List of defined/legal kexec file flags */
cb105258 VG	400	#define KEXEC_FILE_FLAGS (KEXEC_FILE_UNLOAD \| KEXEC_FILE_ON_CRASH \| \
cbc2fe9d	401	KEXEC_FILE_NO_INITRAMFS \| KEXEC_FILE_DEBUG)
cb105258	402
4fc9bbf9 KA	403	/* flag to track if kexec reboot is in progress */
	404	extern bool kexec_in_progress;
	405
43546d86 RK	406	#ifndef page_to_boot_pfn
	407	static inline unsigned long page_to_boot_pfn(struct page *page)
	408	{
	409	return page_to_pfn(page);
	410	}
	411	#endif
	412
	413	#ifndef boot_pfn_to_page
	414	static inline struct page *boot_pfn_to_page(unsigned long boot_pfn)
	415	{
	416	return pfn_to_page(boot_pfn);
	417	}
	418	#endif
	419
	420	#ifndef phys_to_boot_phys
	421	static inline unsigned long phys_to_boot_phys(phys_addr_t phys)
	422	{
	423	return phys;
	424	}
	425	#endif
	426
	427	#ifndef boot_phys_to_phys
	428	static inline phys_addr_t boot_phys_to_phys(unsigned long boot_phys)
	429	{
	430	return boot_phys;
	431	}
	432	#endif
	433
0738eceb NR	434	#ifndef crash_free_reserved_phys_range
	435	static inline void crash_free_reserved_phys_range(unsigned long begin, unsigned long end)
	436	{
	437	unsigned long addr;
	438
	439	for (addr = begin; addr < end; addr += PAGE_SIZE)
	440	free_reserved_page(boot_pfn_to_page(addr >> PAGE_SHIFT));
	441	}
	442	#endif
	443
43546d86 RK	444	static inline unsigned long virt_to_boot_phys(void *addr)
	445	{
	446	return phys_to_boot_phys(__pa((unsigned long)addr));
	447	}
	448
	449	static inline void *boot_phys_to_virt(unsigned long entry)
	450	{
	451	return phys_to_virt(boot_phys_to_phys(entry));
	452	}
	453
bba4ed01 TL	454	#ifndef arch_kexec_post_alloc_pages
	455	static inline int arch_kexec_post_alloc_pages(void *vaddr, unsigned int pages, gfp_t gfp) { return 0; }
	456	#endif
	457
	458	#ifndef arch_kexec_pre_free_pages
	459	static inline void arch_kexec_pre_free_pages(void *vaddr, unsigned int pages) { }
	460	#endif
	461
cbc2fe9d BH	462	extern bool kexec_file_dbg_print;
	463
	464	#define kexec_dprintk(fmt, ...) \
	465	printk("%s" fmt, \
	466	kexec_file_dbg_print ? KERN_INFO : KERN_DEBUG, \
	467	##__VA_ARGS__)
	468
2965faa5	469	#else /* !CONFIG_KEXEC_CORE */
6e274d14 AN	470	struct pt_regs;
6e274d14 AN	471	struct task_struct;
7bbee5ca	472	static inline void __crash_kexec(struct pt_regs *regs) { }
6e274d14 AN	473	static inline void crash_kexec(struct pt_regs *regs) { }
6e274d14 AN	474	static inline int kexec_should_crash(struct task_struct *p) { return 0; }
21db79e8	475	static inline int kexec_crash_loaded(void) { return 0; }
2b94ed24	476	#define kexec_in_progress false
2965faa5	477	#endif /* CONFIG_KEXEC_CORE */
cf2df639	478
af16df54 CX	479	#ifdef CONFIG_KEXEC_SIG
	480	void set_kexec_sig_enforced(void);
	481	#else
	482	static inline void set_kexec_sig_enforced(void) {}
	483	#endif
	484
cf2df639 GL	485	#endif /* !defined(__ASSEBMLY__) */
cf2df639 GL	486
dc009d92	487	#endif /* LINUX_KEXEC_H */