[mirror_ubuntu-bionic-kernel.git] / include / linux / kexec.h

#ifndef LINUX_KEXEC_H
#define LINUX_KEXEC_H

#ifdef CONFIG_KEXEC
#include <linux/types.h>
#include <linux/list.h>
#include <linux/linkage.h>
#include <linux/compat.h>
#include <linux/ioport.h>
#include <linux/elfcore.h>
#include <linux/elf.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_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_NOTE_HEAD_BYTES ALIGN(sizeof(struct elf_note), 4)
#define KEXEC_CORE_NOTE_NAME "CORE"
#define KEXEC_CORE_NOTE_NAME_BYTES ALIGN(sizeof(KEXEC_CORE_NOTE_NAME), 4)
#define KEXEC_CORE_NOTE_DESC_BYTES ALIGN(sizeof(struct elf_prstatus), 4)
/*
 * The per-cpu notes area is a list of notes terminated by a "NULL"
 * note header.  For kdump, the code in vmcore.c runs in the context
 * of the second kernel to combine them into one note.
 */
#define KEXEC_NOTE_BYTES ( (KEXEC_NOTE_HEAD_BYTES * 2) +		\
			    KEXEC_CORE_NOTE_NAME_BYTES +		\
			    KEXEC_CORE_NOTE_DESC_BYTES )

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

typedef unsigned long kimage_entry_t;
#define IND_DESTINATION  0x1
#define IND_INDIRECTION  0x2
#define IND_DONE         0x4
#define IND_SOURCE       0x8

#define KEXEC_SEGMENT_MAX 16
struct kexec_segment {
	void __user *buf;
	size_t bufsz;
	unsigned long mem;	/* User space sees this as a (void *) ... */
	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

struct kimage {
	kimage_entry_t head;
	kimage_entry_t *entry;
	kimage_entry_t *last_entry;

	unsigned long destination;

	unsigned long start;
	struct page *control_code_page;
	struct page *swap_page;

	unsigned long nr_segments;
	struct kexec_segment segment[KEXEC_SEGMENT_MAX];

	struct list_head control_pages;
	struct list_head dest_pages;
	struct list_head unuseable_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;

#ifdef ARCH_HAS_KIMAGE_ARCH
	struct kimage_arch arch;
#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 asmlinkage long sys_kexec_load(unsigned long entry,
					unsigned long nr_segments,
					struct kexec_segment __user *segments,
					unsigned long flags);
extern int kernel_kexec(void);
#ifdef CONFIG_COMPAT
extern asmlinkage long compat_sys_kexec_load(unsigned long entry,
				unsigned long nr_segments,
				struct compat_kexec_segment __user *segments,
				unsigned long flags);
#endif
extern struct page *kimage_alloc_control_pages(struct kimage *image,
						unsigned int order);
extern void crash_kexec(struct pt_regs *);
int kexec_should_crash(struct task_struct *);
void crash_save_cpu(struct pt_regs *regs, int cpu);
void crash_save_vmcoreinfo(void);
void crash_map_reserved_pages(void);
void crash_unmap_reserved_pages(void);
void arch_crash_save_vmcoreinfo(void);
__printf(1, 2)
void vmcoreinfo_append_str(const char *fmt, ...);
unsigned long paddr_vmcoreinfo_note(void);

#define VMCOREINFO_OSRELEASE(value) \
	vmcoreinfo_append_str("OSRELEASE=%s\n", value)
#define VMCOREINFO_PAGESIZE(value) \
	vmcoreinfo_append_str("PAGESIZE=%ld\n", value)
#define VMCOREINFO_SYMBOL(name) \
	vmcoreinfo_append_str("SYMBOL(%s)=%lx\n", #name, (unsigned long)&name)
#define VMCOREINFO_SIZE(name) \
	vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
			      (unsigned long)sizeof(name))
#define VMCOREINFO_STRUCT_SIZE(name) \
	vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
			      (unsigned long)sizeof(struct name))
#define VMCOREINFO_OFFSET(name, field) \
	vmcoreinfo_append_str("OFFSET(%s.%s)=%lu\n", #name, #field, \
			      (unsigned long)offsetof(struct name, field))
#define VMCOREINFO_LENGTH(name, value) \
	vmcoreinfo_append_str("LENGTH(%s)=%lu\n", #name, (unsigned long)value)
#define VMCOREINFO_NUMBER(name) \
	vmcoreinfo_append_str("NUMBER(%s)=%ld\n", #name, (long)name)
#define VMCOREINFO_CONFIG(name) \
	vmcoreinfo_append_str("CONFIG_%s=y\n", #name)

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

#ifndef kexec_flush_icache_page
#define kexec_flush_icache_page(page)
#endif

#define KEXEC_ON_CRASH		0x00000001
#define KEXEC_PRESERVE_CONTEXT	0x00000002
#define KEXEC_ARCH_MASK		0xffff0000

/* These values match the ELF architecture values.
 * Unless there is a good reason that should continue to be the case.
 */
#define KEXEC_ARCH_DEFAULT ( 0 << 16)
#define KEXEC_ARCH_386     ( 3 << 16)
#define KEXEC_ARCH_X86_64  (62 << 16)
#define KEXEC_ARCH_PPC     (20 << 16)
#define KEXEC_ARCH_PPC64   (21 << 16)
#define KEXEC_ARCH_IA_64   (50 << 16)
#define KEXEC_ARCH_ARM     (40 << 16)
#define KEXEC_ARCH_S390    (22 << 16)
#define KEXEC_ARCH_SH      (42 << 16)
#define KEXEC_ARCH_MIPS_LE (10 << 16)
#define KEXEC_ARCH_MIPS    ( 8 << 16)

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

#define VMCOREINFO_BYTES           (4096)
#define VMCOREINFO_NOTE_NAME       "VMCOREINFO"
#define VMCOREINFO_NOTE_NAME_BYTES ALIGN(sizeof(VMCOREINFO_NOTE_NAME), 4)
#define VMCOREINFO_NOTE_SIZE       (KEXEC_NOTE_HEAD_BYTES*2 + VMCOREINFO_BYTES \
				    + VMCOREINFO_NOTE_NAME_BYTES)

/* Location of a reserved region to hold the crash kernel.
 */
extern struct resource crashk_res;
typedef u32 note_buf_t[KEXEC_NOTE_BYTES/4];
extern note_buf_t __percpu *crash_notes;
extern u32 vmcoreinfo_note[VMCOREINFO_NOTE_SIZE/4];
extern size_t vmcoreinfo_size;
extern size_t vmcoreinfo_max_size;

int __init parse_crashkernel(char *cmdline, unsigned long long system_ram,
		unsigned long long *crash_size, unsigned long long *crash_base);
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);

#else /* !CONFIG_KEXEC */
struct pt_regs;
struct task_struct;
static inline void crash_kexec(struct pt_regs *regs) { }
static inline int kexec_should_crash(struct task_struct *p) { return 0; }
#endif /* CONFIG_KEXEC */
#endif /* LINUX_KEXEC_H */
Commit	Line	Data
dc009d92 EB	1	#ifndef LINUX_KEXEC_H
	2	#define LINUX_KEXEC_H
	3
	4	#ifdef CONFIG_KEXEC
	5	#include <linux/types.h>
	6	#include <linux/list.h>
	7	#include <linux/linkage.h>
	8	#include <linux/compat.h>
9c15e852	9	#include <linux/ioport.h>
6672f76a SH	10	#include <linux/elfcore.h>
6672f76a SH	11	#include <linux/elf.h>
dc009d92 EB	12	#include <asm/kexec.h>
	13
	14	/* Verify architecture specific macros are defined */
	15
	16	#ifndef KEXEC_SOURCE_MEMORY_LIMIT
	17	#error KEXEC_SOURCE_MEMORY_LIMIT not defined
	18	#endif
	19
	20	#ifndef KEXEC_DESTINATION_MEMORY_LIMIT
	21	#error KEXEC_DESTINATION_MEMORY_LIMIT not defined
	22	#endif
	23
	24	#ifndef KEXEC_CONTROL_MEMORY_LIMIT
	25	#error KEXEC_CONTROL_MEMORY_LIMIT not defined
	26	#endif
	27
163f6876 HY	28	#ifndef KEXEC_CONTROL_PAGE_SIZE
163f6876 HY	29	#error KEXEC_CONTROL_PAGE_SIZE not defined
dc009d92 EB	30	#endif
	31
	32	#ifndef KEXEC_ARCH
	33	#error KEXEC_ARCH not defined
	34	#endif
	35
3d214fae MH	36	#ifndef KEXEC_CRASH_CONTROL_MEMORY_LIMIT
	37	#define KEXEC_CRASH_CONTROL_MEMORY_LIMIT KEXEC_CONTROL_MEMORY_LIMIT
	38	#endif
	39
558df720 MH	40	#ifndef KEXEC_CRASH_MEM_ALIGN
	41	#define KEXEC_CRASH_MEM_ALIGN PAGE_SIZE
	42	#endif
	43
6672f76a SH	44	#define KEXEC_NOTE_HEAD_BYTES ALIGN(sizeof(struct elf_note), 4)
	45	#define KEXEC_CORE_NOTE_NAME "CORE"
	46	#define KEXEC_CORE_NOTE_NAME_BYTES ALIGN(sizeof(KEXEC_CORE_NOTE_NAME), 4)
	47	#define KEXEC_CORE_NOTE_DESC_BYTES ALIGN(sizeof(struct elf_prstatus), 4)
	48	/*
	49	* The per-cpu notes area is a list of notes terminated by a "NULL"
	50	* note header. For kdump, the code in vmcore.c runs in the context
	51	* of the second kernel to combine them into one note.
	52	*/
	53	#define KEXEC_NOTE_BYTES ( (KEXEC_NOTE_HEAD_BYTES * 2) + \
	54	KEXEC_CORE_NOTE_NAME_BYTES + \
	55	KEXEC_CORE_NOTE_DESC_BYTES )
	56
dc009d92 EB	57	/*
	58	* This structure is used to hold the arguments that are used when loading
	59	* kernel binaries.
	60	*/
	61
	62	typedef unsigned long kimage_entry_t;
	63	#define IND_DESTINATION 0x1
	64	#define IND_INDIRECTION 0x2
	65	#define IND_DONE 0x4
	66	#define IND_SOURCE 0x8
	67
720e1a9f	68	#define KEXEC_SEGMENT_MAX 16
dc009d92 EB	69	struct kexec_segment {
	70	void __user *buf;
	71	size_t bufsz;
	72	unsigned long mem; /* User space sees this as a (void ) ... /
	73	size_t memsz;
	74	};
	75
	76	#ifdef CONFIG_COMPAT
	77	struct compat_kexec_segment {
	78	compat_uptr_t buf;
	79	compat_size_t bufsz;
	80	compat_ulong_t mem; /* User space sees this as a (void ) ... /
	81	compat_size_t memsz;
	82	};
	83	#endif
	84
	85	struct kimage {
	86	kimage_entry_t head;
	87	kimage_entry_t *entry;
	88	kimage_entry_t *last_entry;
	89
	90	unsigned long destination;
	91
	92	unsigned long start;
	93	struct page *control_code_page;
3ab83521	94	struct page *swap_page;
dc009d92 EB	95
	96	unsigned long nr_segments;
	97	struct kexec_segment segment[KEXEC_SEGMENT_MAX];
	98
	99	struct list_head control_pages;
	100	struct list_head dest_pages;
	101	struct list_head unuseable_pages;
	102
	103	/* Address of next control page to allocate for crash kernels. */
	104	unsigned long control_page;
	105
	106	/* Flags to indicate special processing */
	107	unsigned int type : 1;
	108	#define KEXEC_TYPE_DEFAULT 0
	109	#define KEXEC_TYPE_CRASH 1
3ab83521	110	unsigned int preserve_context : 1;
92be3d6b HY	111
	112	#ifdef ARCH_HAS_KIMAGE_ARCH
	113	struct kimage_arch arch;
	114	#endif
dc009d92 EB	115	};
	116
	117
	118
	119	/* kexec interface functions */
3ab83521	120	extern void machine_kexec(struct kimage *image);
dc009d92 EB	121	extern int machine_kexec_prepare(struct kimage *image);
	122	extern void machine_kexec_cleanup(struct kimage *image);
	123	extern asmlinkage long sys_kexec_load(unsigned long entry,
72414d3f MS	124	unsigned long nr_segments,
	125	struct kexec_segment __user *segments,
	126	unsigned long flags);
3ab83521	127	extern int kernel_kexec(void);
dc009d92 EB	128	#ifdef CONFIG_COMPAT
dc009d92 EB	129	extern asmlinkage long compat_sys_kexec_load(unsigned long entry,
72414d3f MS	130	unsigned long nr_segments,
	131	struct compat_kexec_segment __user *segments,
	132	unsigned long flags);
dc009d92	133	#endif
72414d3f MS	134	extern struct page kimage_alloc_control_pages(struct kimage image,
72414d3f MS	135	unsigned int order);
6e274d14 AN	136	extern void crash_kexec(struct pt_regs *);
6e274d14 AN	137	int kexec_should_crash(struct task_struct *);
85916f81	138	void crash_save_cpu(struct pt_regs *regs, int cpu);
fd59d231	139	void crash_save_vmcoreinfo(void);
558df720 MH	140	void crash_map_reserved_pages(void);
558df720 MH	141	void crash_unmap_reserved_pages(void);
fd59d231	142	void arch_crash_save_vmcoreinfo(void);
b9075fa9 JP	143	__printf(1, 2)
b9075fa9 JP	144	void vmcoreinfo_append_str(const char *fmt, ...);
fd59d231 KO	145	unsigned long paddr_vmcoreinfo_note(void);
fd59d231 KO	146
c6e2bee2 BW	147	#define VMCOREINFO_OSRELEASE(value) \
c6e2bee2 BW	148	vmcoreinfo_append_str("OSRELEASE=%s\n", value)
bba1f603 KO	149	#define VMCOREINFO_PAGESIZE(value) \
bba1f603 KO	150	vmcoreinfo_append_str("PAGESIZE=%ld\n", value)
bcbba6c1	151	#define VMCOREINFO_SYMBOL(name) \
fd59d231	152	vmcoreinfo_append_str("SYMBOL(%s)=%lx\n", #name, (unsigned long)&name)
bcbba6c1	153	#define VMCOREINFO_SIZE(name) \
6cfa062f KO	154	vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
6cfa062f KO	155	(unsigned long)sizeof(name))
c76f860c KO	156	#define VMCOREINFO_STRUCT_SIZE(name) \
	157	vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
	158	(unsigned long)sizeof(struct name))
bcbba6c1	159	#define VMCOREINFO_OFFSET(name, field) \
d768281e	160	vmcoreinfo_append_str("OFFSET(%s.%s)=%lu\n", #name, #field, \
1e4f2955	161	(unsigned long)offsetof(struct name, field))
bcbba6c1	162	#define VMCOREINFO_LENGTH(name, value) \
d768281e	163	vmcoreinfo_append_str("LENGTH(%s)=%lu\n", #name, (unsigned long)value)
bcbba6c1	164	#define VMCOREINFO_NUMBER(name) \
6cfa062f	165	vmcoreinfo_append_str("NUMBER(%s)=%ld\n", #name, (long)name)
bcbba6c1	166	#define VMCOREINFO_CONFIG(name) \
fd59d231 KO	167	vmcoreinfo_append_str("CONFIG_%s=y\n", #name)
fd59d231 KO	168
dc009d92	169	extern struct kimage *kexec_image;
c330dda9	170	extern struct kimage *kexec_crash_image;
dc009d92	171
a7956113 ZN	172	#ifndef kexec_flush_icache_page
	173	#define kexec_flush_icache_page(page)
	174	#endif
	175
3ab83521 HY	176	#define KEXEC_ON_CRASH 0x00000001
	177	#define KEXEC_PRESERVE_CONTEXT 0x00000002
	178	#define KEXEC_ARCH_MASK 0xffff0000
dc009d92 EB	179
	180	/* These values match the ELF architecture values.
	181	* Unless there is a good reason that should continue to be the case.
	182	*/
	183	#define KEXEC_ARCH_DEFAULT ( 0 << 16)
	184	#define KEXEC_ARCH_386 ( 3 << 16)
	185	#define KEXEC_ARCH_X86_64 (62 << 16)
	186	#define KEXEC_ARCH_PPC (20 << 16)
	187	#define KEXEC_ARCH_PPC64 (21 << 16)
	188	#define KEXEC_ARCH_IA_64 (50 << 16)
c587e4a6	189	#define KEXEC_ARCH_ARM (40 << 16)
cf13f0ea	190	#define KEXEC_ARCH_S390 (22 << 16)
9d44190e	191	#define KEXEC_ARCH_SH (42 << 16)
583bb86f NS	192	#define KEXEC_ARCH_MIPS_LE (10 << 16)
583bb86f NS	193	#define KEXEC_ARCH_MIPS ( 8 << 16)
dc009d92	194
3ab83521 HY	195	/* List of defined/legal kexec flags */
	196	#ifndef CONFIG_KEXEC_JUMP
	197	#define KEXEC_FLAGS KEXEC_ON_CRASH
	198	#else
	199	#define KEXEC_FLAGS (KEXEC_ON_CRASH \| KEXEC_PRESERVE_CONTEXT)
	200	#endif
dc009d92	201
fd59d231 KO	202	#define VMCOREINFO_BYTES (4096)
	203	#define VMCOREINFO_NOTE_NAME "VMCOREINFO"
	204	#define VMCOREINFO_NOTE_NAME_BYTES ALIGN(sizeof(VMCOREINFO_NOTE_NAME), 4)
	205	#define VMCOREINFO_NOTE_SIZE (KEXEC_NOTE_HEAD_BYTES*2 + VMCOREINFO_BYTES \
	206	+ VMCOREINFO_NOTE_NAME_BYTES)
	207
dc009d92 EB	208	/* Location of a reserved region to hold the crash kernel.
	209	*/
	210	extern struct resource crashk_res;
6672f76a	211	typedef u32 note_buf_t[KEXEC_NOTE_BYTES/4];
43cf38eb	212	extern note_buf_t __percpu *crash_notes;
fd59d231	213	extern u32 vmcoreinfo_note[VMCOREINFO_NOTE_SIZE/4];
d768281e KO	214	extern size_t vmcoreinfo_size;
d768281e KO	215	extern size_t vmcoreinfo_max_size;
dc009d92	216
cba63c30 BW	217	int __init parse_crashkernel(char *cmdline, unsigned long long system_ram,
cba63c30 BW	218	unsigned long long crash_size, unsigned long long crash_base);
06a7f711 AW	219	int crash_shrink_memory(unsigned long new_size);
06a7f711 AW	220	size_t crash_get_memory_size(void);
c0bb9e45	221	void crash_free_reserved_phys_range(unsigned long begin, unsigned long end);
a7956113	222
dc009d92	223	#else /* !CONFIG_KEXEC */
6e274d14 AN	224	struct pt_regs;
	225	struct task_struct;
	226	static inline void crash_kexec(struct pt_regs *regs) { }
	227	static inline int kexec_should_crash(struct task_struct *p) { return 0; }
dc009d92 EB	228	#endif /* CONFIG_KEXEC */
dc009d92 EB	229	#endif /* LINUX_KEXEC_H */