[mirror_ubuntu-jammy-kernel.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/crash_core.h>
#include <asm/io.h>

#include <uapi/linux/kexec.h>

#ifdef CONFIG_KEXEC_CORE
#include <linux/list.h>
#include <linux/compat.h>
#include <linux/ioport.h>
#include <linux/module.h>
#include <asm/kexec.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);

int __weak arch_kexec_kernel_image_probe(struct kimage *image, void *buf,
					 unsigned long buf_len);
void * __weak arch_kexec_kernel_image_load(struct kimage *image);
int __weak arch_kexec_apply_relocations_add(struct purgatory_info *pi,
					    Elf_Shdr *section,
					    const Elf_Shdr *relsec,
					    const Elf_Shdr *symtab);
int __weak arch_kexec_apply_relocations(struct purgatory_info *pi,
					Elf_Shdr *section,
					const Elf_Shdr *relsec,
					const Elf_Shdr *symtab);

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

/* Alignment required for elf header segment */
#define ELF_CORE_HEADER_ALIGN   4096

struct crash_mem_range {
	u64 start, end;
};

struct crash_mem {
	unsigned int max_nr_ranges;
	unsigned int nr_ranges;
	struct crash_mem_range ranges[0];
};

extern int crash_exclude_mem_range(struct crash_mem *mem,
				   unsigned long long mstart,
				   unsigned long long mend);
extern int crash_prepare_elf64_headers(struct crash_mem *mem, int kernel_map,
				       void **addr, unsigned long *sz);
#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 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
};

/* 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);
extern void __crash_kexec(struct pt_regs *);
extern void crash_kexec(struct pt_regs *);
int kexec_should_crash(struct task_struct *);
int kexec_crash_loaded(void);
void crash_save_cpu(struct pt_regs *regs, int cpu);
extern int kimage_crash_copy_vmcoreinfo(struct kimage *image);

extern struct kimage *kexec_image;
extern struct kimage *kexec_crash_image;
extern int kexec_load_disabled;

#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
#else
#define KEXEC_FLAGS    (KEXEC_ON_CRASH | KEXEC_PRESERVE_CONTEXT)
#endif

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

/* Location of a reserved region to hold the crash kernel.
 */
extern struct resource crashk_res;
extern struct resource crashk_low_res;
extern note_buf_t __percpu *crash_notes;

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

int crash_shrink_memory(unsigned long new_size);
size_t crash_get_memory_size(void);
void crash_free_reserved_phys_range(unsigned long begin, unsigned long end);

void arch_kexec_protect_crashkres(void);
void arch_kexec_unprotect_crashkres(void);

#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

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

#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 */

#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
692f66f2	18	#include <linux/crash_core.h>
43546d86 RK	19	#include <asm/io.h>
43546d86 RK	20
607ca46e	21	#include <uapi/linux/kexec.h>
29a5c67e	22
2965faa5	23	#ifdef CONFIG_KEXEC_CORE
dc009d92	24	#include <linux/list.h>
dc009d92	25	#include <linux/compat.h>
9c15e852	26	#include <linux/ioport.h>
12db5562	27	#include <linux/module.h>
dc009d92 EB	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
7e01b5ac	44	#ifndef KEXEC_CONTROL_MEMORY_GFP
dc5cccac	45	#define KEXEC_CONTROL_MEMORY_GFP (GFP_KERNEL \| __GFP_NORETRY)
7e01b5ac MS	46	#endif
7e01b5ac MS	47
163f6876 HY	48	#ifndef KEXEC_CONTROL_PAGE_SIZE
163f6876 HY	49	#error KEXEC_CONTROL_PAGE_SIZE not defined
dc009d92 EB	50	#endif
	51
	52	#ifndef KEXEC_ARCH
	53	#error KEXEC_ARCH not defined
	54	#endif
	55
3d214fae MH	56	#ifndef KEXEC_CRASH_CONTROL_MEMORY_LIMIT
	57	#define KEXEC_CRASH_CONTROL_MEMORY_LIMIT KEXEC_CONTROL_MEMORY_LIMIT
	58	#endif
	59
558df720 MH	60	#ifndef KEXEC_CRASH_MEM_ALIGN
	61	#define KEXEC_CRASH_MEM_ALIGN PAGE_SIZE
	62	#endif
	63
692f66f2 HB	64	#define KEXEC_CORE_NOTE_NAME CRASH_CORE_NOTE_NAME
692f66f2 HB	65
dc009d92 EB	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;
dc009d92	72
dc009d92	73	struct kexec_segment {
815d5704 VG	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	};
dc009d92	86	size_t bufsz;
29a5c67e	87	unsigned long mem;
dc009d92 EB	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
978e30c9	100	#ifdef CONFIG_KEXEC_FILE
12db5562	101	struct purgatory_info {
65c225d3 PR	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	*/
12db5562 VG	111	Elf_Shdr *sechdrs;
12db5562 VG	112	/*
65c225d3 PR	113	* Temporary, modifiable buffer for stripped purgatory used for
65c225d3 PR	114	* relocation. This memory can be freed post image load.
12db5562 VG	115	*/
12db5562 VG	116	void *purgatory_buf;
12db5562 VG	117	};
12db5562 VG	118
ee6ebeda PR	119	struct kimage;
ee6ebeda PR	120
978e30c9 XP	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
99d5cadf	128	#ifdef CONFIG_KEXEC_SIG
978e30c9 XP	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;
99d5cadf	137	#ifdef CONFIG_KEXEC_SIG
978e30c9 XP	138	kexec_verify_sig_t *verify_sig;
	139	#endif
	140	};
60fe3910	141
9ec4ecef AT	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);
92a98a2b	146	int kexec_image_post_load_cleanup_default(struct kimage *image);
9ec4ecef	147
b6664ba4 AT	148	/*
	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.
	151	*/
	152	#ifndef KEXEC_BUF_MEM_UNKNOWN
	153	#define KEXEC_BUF_MEM_UNKNOWN 0
	154	#endif
	155
60fe3910 TJB	156	/**
	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.
	167	*/
	168	struct kexec_buf {
	169	struct kimage *image;
ec2b9bfa	170	void *buffer;
60fe3910 TJB	171	unsigned long bufsz;
	172	unsigned long mem;
	173	unsigned long memsz;
	174	unsigned long buf_align;
	175	unsigned long buf_min;
	176	unsigned long buf_max;
	177	bool top_down;
	178	};
	179
3be3f61d PR	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,
	183	bool get_value);
	184	void kexec_purgatory_get_symbol_addr(struct kimage image, const char *name);
	185
d5372c39 VG	186	int __weak arch_kexec_kernel_image_probe(struct kimage image, void buf,
d5372c39 VG	187	unsigned long buf_len);
89f579ce	188	void * __weak arch_kexec_kernel_image_load(struct kimage *image);
8aec395b PR	189	int __weak arch_kexec_apply_relocations_add(struct purgatory_info *pi,
	190	Elf_Shdr *section,
	191	const Elf_Shdr *relsec,
	192	const Elf_Shdr *symtab);
	193	int __weak arch_kexec_apply_relocations(struct purgatory_info *pi,
	194	Elf_Shdr *section,
	195	const Elf_Shdr *relsec,
	196	const Elf_Shdr *symtab);
	197
ec2b9bfa	198	extern int kexec_add_buffer(struct kexec_buf *kbuf);
e2e806f9	199	int kexec_locate_mem_hole(struct kexec_buf *kbuf);
babac4a8 AT	200
	201	/* Alignment required for elf header segment */
	202	#define ELF_CORE_HEADER_ALIGN 4096
	203
	204	struct crash_mem_range {
	205	u64 start, end;
	206	};
	207
	208	struct crash_mem {
	209	unsigned int max_nr_ranges;
	210	unsigned int nr_ranges;
	211	struct crash_mem_range ranges[0];
	212	};
	213
	214	extern int crash_exclude_mem_range(struct crash_mem *mem,
	215	unsigned long long mstart,
	216	unsigned long long mend);
	217	extern int crash_prepare_elf64_headers(struct crash_mem *mem, int kernel_map,
	218	void *addr, unsigned long sz);
60fe3910	219	#endif /* CONFIG_KEXEC_FILE */
978e30c9	220
175fca3b SS	221	#ifdef CONFIG_KEXEC_ELF
	222	struct kexec_elf_info {
	223	/*
	224	* Where the ELF binary contents are kept.
	225	* Memory managed by the user of the struct.
	226	*/
	227	const char *buffer;
	228
	229	const struct elfhdr *ehdr;
	230	const struct elf_phdr *proghdrs;
175fca3b SS	231	};
	232
	233	int kexec_build_elf_info(const char buf, size_t len, struct elfhdr ehdr,
	234	struct kexec_elf_info *elf_info);
	235
	236	int kexec_elf_load(struct kimage image, struct elfhdr ehdr,
	237	struct kexec_elf_info *elf_info,
	238	struct kexec_buf *kbuf,
	239	unsigned long *lowest_load_addr);
	240
	241	void kexec_free_elf_info(struct kexec_elf_info *elf_info);
	242	int kexec_elf_probe(const char *buf, unsigned long len);
	243	#endif
dc009d92 EB	244	struct kimage {
	245	kimage_entry_t head;
	246	kimage_entry_t *entry;
	247	kimage_entry_t *last_entry;
	248
dc009d92 EB	249	unsigned long start;
dc009d92 EB	250	struct page *control_code_page;
3ab83521	251	struct page *swap_page;
1229384f	252	void vmcoreinfo_data_copy; / locates in the crash memory */
dc009d92 EB	253
	254	unsigned long nr_segments;
	255	struct kexec_segment segment[KEXEC_SEGMENT_MAX];
	256
	257	struct list_head control_pages;
	258	struct list_head dest_pages;
7d3e2bca	259	struct list_head unusable_pages;
dc009d92 EB	260
	261	/* Address of next control page to allocate for crash kernels. */
	262	unsigned long control_page;
	263
	264	/* Flags to indicate special processing */
	265	unsigned int type : 1;
	266	#define KEXEC_TYPE_DEFAULT 0
	267	#define KEXEC_TYPE_CRASH 1
3ab83521	268	unsigned int preserve_context : 1;
cb105258 VG	269	/* If set, we are using file mode kexec syscall */
cb105258 VG	270	unsigned int file_mode:1;
92be3d6b HY	271
	272	#ifdef ARCH_HAS_KIMAGE_ARCH
	273	struct kimage_arch arch;
	274	#endif
cb105258	275
978e30c9	276	#ifdef CONFIG_KEXEC_FILE
cb105258 VG	277	/* Additional fields for file based kexec syscall */
	278	void *kernel_buf;
	279	unsigned long kernel_buf_len;
	280
	281	void *initrd_buf;
	282	unsigned long initrd_buf_len;
	283
	284	char *cmdline_buf;
	285	unsigned long cmdline_buf_len;
	286
	287	/* File operations provided by image loader */
9ec4ecef	288	const struct kexec_file_ops *fops;
cb105258 VG	289
	290	/* Image loader handling the kernel can store a pointer here */
	291	void *image_loader_data;
12db5562 VG	292
	293	/* Information for loading purgatory */
	294	struct purgatory_info purgatory_info;
978e30c9	295	#endif
cb105258	296	};
dc009d92 EB	297
dc009d92 EB	298	/* kexec interface functions */
3ab83521	299	extern void machine_kexec(struct kimage *image);
dc009d92 EB	300	extern int machine_kexec_prepare(struct kimage *image);
dc009d92 EB	301	extern void machine_kexec_cleanup(struct kimage *image);
3ab83521	302	extern int kernel_kexec(void);
72414d3f MS	303	extern struct page kimage_alloc_control_pages(struct kimage image,
72414d3f MS	304	unsigned int order);
7bbee5ca	305	extern void __crash_kexec(struct pt_regs *);
6e274d14 AN	306	extern void crash_kexec(struct pt_regs *);
6e274d14 AN	307	int kexec_should_crash(struct task_struct *);
21db79e8	308	int kexec_crash_loaded(void);
85916f81	309	void crash_save_cpu(struct pt_regs *regs, int cpu);
1229384f	310	extern int kimage_crash_copy_vmcoreinfo(struct kimage *image);
fd59d231	311
dc009d92	312	extern struct kimage *kexec_image;
c330dda9	313	extern struct kimage *kexec_crash_image;
7984754b	314	extern int kexec_load_disabled;
dc009d92	315
a7956113 ZN	316	#ifndef kexec_flush_icache_page
	317	#define kexec_flush_icache_page(page)
	318	#endif
	319
3ab83521 HY	320	/* List of defined/legal kexec flags */
	321	#ifndef CONFIG_KEXEC_JUMP
	322	#define KEXEC_FLAGS KEXEC_ON_CRASH
	323	#else
	324	#define KEXEC_FLAGS (KEXEC_ON_CRASH \| KEXEC_PRESERVE_CONTEXT)
	325	#endif
dc009d92	326
cb105258 VG	327	/* List of defined/legal kexec file flags */
	328	#define KEXEC_FILE_FLAGS (KEXEC_FILE_UNLOAD \| KEXEC_FILE_ON_CRASH \| \
	329	KEXEC_FILE_NO_INITRAMFS)
	330
dc009d92 EB	331	/* Location of a reserved region to hold the crash kernel.
	332	*/
	333	extern struct resource crashk_res;
0212f915	334	extern struct resource crashk_low_res;
43cf38eb	335	extern note_buf_t __percpu *crash_notes;
dc009d92	336
4fc9bbf9 KA	337	/* flag to track if kexec reboot is in progress */
	338	extern bool kexec_in_progress;
	339
06a7f711 AW	340	int crash_shrink_memory(unsigned long new_size);
06a7f711 AW	341	size_t crash_get_memory_size(void);
c0bb9e45	342	void crash_free_reserved_phys_range(unsigned long begin, unsigned long end);
a7956113	343
9b492cf5 XP	344	void arch_kexec_protect_crashkres(void);
9b492cf5 XP	345	void arch_kexec_unprotect_crashkres(void);
a43cac0d	346
43546d86 RK	347	#ifndef page_to_boot_pfn
	348	static inline unsigned long page_to_boot_pfn(struct page *page)
	349	{
	350	return page_to_pfn(page);
	351	}
	352	#endif
	353
	354	#ifndef boot_pfn_to_page
	355	static inline struct page *boot_pfn_to_page(unsigned long boot_pfn)
	356	{
	357	return pfn_to_page(boot_pfn);
	358	}
	359	#endif
	360
	361	#ifndef phys_to_boot_phys
	362	static inline unsigned long phys_to_boot_phys(phys_addr_t phys)
	363	{
	364	return phys;
	365	}
	366	#endif
	367
	368	#ifndef boot_phys_to_phys
	369	static inline phys_addr_t boot_phys_to_phys(unsigned long boot_phys)
	370	{
	371	return boot_phys;
	372	}
	373	#endif
	374
	375	static inline unsigned long virt_to_boot_phys(void *addr)
	376	{
	377	return phys_to_boot_phys(__pa((unsigned long)addr));
	378	}
	379
	380	static inline void *boot_phys_to_virt(unsigned long entry)
	381	{
	382	return phys_to_virt(boot_phys_to_phys(entry));
	383	}
	384
bba4ed01 TL	385	#ifndef arch_kexec_post_alloc_pages
	386	static inline int arch_kexec_post_alloc_pages(void *vaddr, unsigned int pages, gfp_t gfp) { return 0; }
	387	#endif
	388
	389	#ifndef arch_kexec_pre_free_pages
	390	static inline void arch_kexec_pre_free_pages(void *vaddr, unsigned int pages) { }
	391	#endif
	392
2965faa5	393	#else /* !CONFIG_KEXEC_CORE */
6e274d14 AN	394	struct pt_regs;
6e274d14 AN	395	struct task_struct;
7bbee5ca	396	static inline void __crash_kexec(struct pt_regs *regs) { }
6e274d14 AN	397	static inline void crash_kexec(struct pt_regs *regs) { }
6e274d14 AN	398	static inline int kexec_should_crash(struct task_struct *p) { return 0; }
21db79e8	399	static inline int kexec_crash_loaded(void) { return 0; }
2b94ed24	400	#define kexec_in_progress false
2965faa5	401	#endif /* CONFIG_KEXEC_CORE */
cf2df639 GL	402
	403	#endif /* !defined(__ASSEBMLY__) */
	404
dc009d92	405	#endif /* LINUX_KEXEC_H */