[deliverable/linux.git] / include / linux / kexec.h

#ifndef LINUX_KEXEC_H
#define LINUX_KEXEC_H

#include <uapi/linux/kexec.h>

#ifdef CONFIG_KEXEC
#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.
 */
#ifndef KEXEC_NOTE_BYTES
#define KEXEC_NOTE_BYTES ( (KEXEC_NOTE_HEAD_BYTES * 2) +		\
			    KEXEC_CORE_NOTE_NAME_BYTES +		\
			    KEXEC_CORE_NOTE_DESC_BYTES )
#endif

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

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

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 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;

#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);
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;
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

#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;
extern struct resource crashk_low_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;

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

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