kexec.h 9.28 KB
Newer Older
1
2
3
#ifndef LINUX_KEXEC_H
#define LINUX_KEXEC_H

4
#include <uapi/linux/kexec.h>
5
6

#ifdef CONFIG_KEXEC
7
8
9
#include <linux/list.h>
#include <linux/linkage.h>
#include <linux/compat.h>
10
#include <linux/ioport.h>
11
12
#include <linux/elfcore.h>
#include <linux/elf.h>
13
#include <linux/module.h>
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
#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

30
31
#ifndef KEXEC_CONTROL_PAGE_SIZE
#error KEXEC_CONTROL_PAGE_SIZE not defined
32
33
34
35
36
37
#endif

#ifndef KEXEC_ARCH
#error KEXEC_ARCH not defined
#endif

38
39
40
41
#ifndef KEXEC_CRASH_CONTROL_MEMORY_LIMIT
#define KEXEC_CRASH_CONTROL_MEMORY_LIMIT KEXEC_CONTROL_MEMORY_LIMIT
#endif

42
43
44
45
#ifndef KEXEC_CRASH_MEM_ALIGN
#define KEXEC_CRASH_MEM_ALIGN PAGE_SIZE
#endif

46
47
48
49
50
51
52
53
54
#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.
 */
55
#ifndef KEXEC_NOTE_BYTES
56
57
58
#define KEXEC_NOTE_BYTES ( (KEXEC_NOTE_HEAD_BYTES * 2) +		\
			    KEXEC_CORE_NOTE_NAME_BYTES +		\
			    KEXEC_CORE_NOTE_DESC_BYTES )
59
#endif
60

61
62
63
64
65
66
67
68
69
70
71
72
/*
 * 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 {
73
74
75
76
77
78
79
80
81
82
83
84
	/*
	 * 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;
	};
85
	size_t bufsz;
86
	unsigned long mem;
87
88
89
90
91
92
93
94
95
96
97
98
	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

99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
struct kexec_sha_region {
	unsigned long start;
	unsigned long len;
};

struct purgatory_info {
	/* Pointer to elf header of read only purgatory */
	Elf_Ehdr *ehdr;

	/* Pointer to purgatory sechdrs which are modifiable */
	Elf_Shdr *sechdrs;
	/*
	 * Temporary buffer location where purgatory is loaded and relocated
	 * This memory can be freed post image load
	 */
	void *purgatory_buf;

	/* Address where purgatory is finally loaded and is executed from */
	unsigned long purgatory_load_addr;
};

120
121
122
123
124
125
126
127
128
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;
Huang Ying's avatar
Huang Ying committed
129
	struct page *swap_page;
130
131
132
133
134
135

	unsigned long nr_segments;
	struct kexec_segment segment[KEXEC_SEGMENT_MAX];

	struct list_head control_pages;
	struct list_head dest_pages;
136
	struct list_head unusable_pages;
137
138
139
140
141
142
143
144

	/* 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
Huang Ying's avatar
Huang Ying committed
145
	unsigned int preserve_context : 1;
146
147
	/* If set, we are using file mode kexec syscall */
	unsigned int file_mode:1;
148
149
150
151

#ifdef ARCH_HAS_KIMAGE_ARCH
	struct kimage_arch arch;
#endif
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

	/* 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 */
	struct kexec_file_ops *fops;

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

	/* Information for loading purgatory */
	struct purgatory_info purgatory_info;
171
172
};

173
174
175
176
177
178
179
180
181
182
183
184
185
186
/*
 * Keeps track of buffer parameters as provided by caller for requesting
 * memory placement of buffer.
 */
struct kexec_buf {
	struct kimage *image;
	char *buffer;
	unsigned long bufsz;
	unsigned long memsz;
	unsigned long buf_align;
	unsigned long buf_min;
	unsigned long buf_max;
	bool top_down;		/* allocate from top of memory hole */
};
187

188
189
190
191
192
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);
193
typedef int (kexec_cleanup_t)(void *loader_data);
194
195
196
197
198
199

struct kexec_file_ops {
	kexec_probe_t *probe;
	kexec_load_t *load;
	kexec_cleanup_t *cleanup;
};
200
201

/* kexec interface functions */
Huang Ying's avatar
Huang Ying committed
202
extern void machine_kexec(struct kimage *image);
203
204
205
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,
Maneesh Soni's avatar
Maneesh Soni committed
206
207
208
					unsigned long nr_segments,
					struct kexec_segment __user *segments,
					unsigned long flags);
Huang Ying's avatar
Huang Ying committed
209
extern int kernel_kexec(void);
210
211
212
213
214
extern int kexec_add_buffer(struct kimage *image, char *buffer,
			    unsigned long bufsz, unsigned long memsz,
			    unsigned long buf_align, unsigned long buf_min,
			    unsigned long buf_max, bool top_down,
			    unsigned long *load_addr);
Maneesh Soni's avatar
Maneesh Soni committed
215
216
extern struct page *kimage_alloc_control_pages(struct kimage *image,
						unsigned int order);
217
218
219
220
221
222
223
224
extern int kexec_load_purgatory(struct kimage *image, unsigned long min,
				unsigned long max, int top_down,
				unsigned long *load_addr);
extern int kexec_purgatory_get_set_symbol(struct kimage *image,
					  const char *name, void *buf,
					  unsigned int size, bool get_value);
extern void *kexec_purgatory_get_symbol_addr(struct kimage *image,
					     const char *name);
225
226
extern void crash_kexec(struct pt_regs *);
int kexec_should_crash(struct task_struct *);
227
void crash_save_cpu(struct pt_regs *regs, int cpu);
Ken'ichi Ohmichi's avatar
Ken'ichi Ohmichi committed
228
void crash_save_vmcoreinfo(void);
229
230
void crash_map_reserved_pages(void);
void crash_unmap_reserved_pages(void);
Ken'ichi Ohmichi's avatar
Ken'ichi Ohmichi committed
231
void arch_crash_save_vmcoreinfo(void);
232
233
__printf(1, 2)
void vmcoreinfo_append_str(const char *fmt, ...);
Ken'ichi Ohmichi's avatar
Ken'ichi Ohmichi committed
234
235
unsigned long paddr_vmcoreinfo_note(void);

236
237
#define VMCOREINFO_OSRELEASE(value) \
	vmcoreinfo_append_str("OSRELEASE=%s\n", value)
238
239
#define VMCOREINFO_PAGESIZE(value) \
	vmcoreinfo_append_str("PAGESIZE=%ld\n", value)
240
#define VMCOREINFO_SYMBOL(name) \
Ken'ichi Ohmichi's avatar
Ken'ichi Ohmichi committed
241
	vmcoreinfo_append_str("SYMBOL(%s)=%lx\n", #name, (unsigned long)&name)
242
#define VMCOREINFO_SIZE(name) \
243
244
	vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
			      (unsigned long)sizeof(name))
245
246
247
#define VMCOREINFO_STRUCT_SIZE(name) \
	vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
			      (unsigned long)sizeof(struct name))
248
#define VMCOREINFO_OFFSET(name, field) \
249
	vmcoreinfo_append_str("OFFSET(%s.%s)=%lu\n", #name, #field, \
250
			      (unsigned long)offsetof(struct name, field))
251
#define VMCOREINFO_LENGTH(name, value) \
252
	vmcoreinfo_append_str("LENGTH(%s)=%lu\n", #name, (unsigned long)value)
253
#define VMCOREINFO_NUMBER(name) \
254
	vmcoreinfo_append_str("NUMBER(%s)=%ld\n", #name, (long)name)
255
#define VMCOREINFO_CONFIG(name) \
Ken'ichi Ohmichi's avatar
Ken'ichi Ohmichi committed
256
257
	vmcoreinfo_append_str("CONFIG_%s=y\n", #name)

258
extern struct kimage *kexec_image;
259
extern struct kimage *kexec_crash_image;
260
extern int kexec_load_disabled;
261

Zou Nan hai's avatar
Zou Nan hai committed
262
263
264
265
#ifndef kexec_flush_icache_page
#define kexec_flush_icache_page(page)
#endif

Huang Ying's avatar
Huang Ying committed
266
267
268
269
270
271
/* 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
272

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

Ken'ichi Ohmichi's avatar
Ken'ichi Ohmichi committed
277
278
279
280
281
282
#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)

283
284
285
/* Location of a reserved region to hold the crash kernel.
 */
extern struct resource crashk_res;
286
extern struct resource crashk_low_res;
287
typedef u32 note_buf_t[KEXEC_NOTE_BYTES/4];
288
extern note_buf_t __percpu *crash_notes;
Ken'ichi Ohmichi's avatar
Ken'ichi Ohmichi committed
289
extern u32 vmcoreinfo_note[VMCOREINFO_NOTE_SIZE/4];
290
291
extern size_t vmcoreinfo_size;
extern size_t vmcoreinfo_max_size;
292

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

296
297
int __init parse_crashkernel(char *cmdline, unsigned long long system_ram,
		unsigned long long *crash_size, unsigned long long *crash_base);
298
299
int parse_crashkernel_high(char *cmdline, unsigned long long system_ram,
		unsigned long long *crash_size, unsigned long long *crash_base);
300
301
int parse_crashkernel_low(char *cmdline, unsigned long long system_ram,
		unsigned long long *crash_size, unsigned long long *crash_base);
302
303
int crash_shrink_memory(unsigned long new_size);
size_t crash_get_memory_size(void);
304
void crash_free_reserved_phys_range(unsigned long begin, unsigned long end);
Zou Nan hai's avatar
Zou Nan hai committed
305

306
#else /* !CONFIG_KEXEC */
307
308
309
310
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; }
311
312
#endif /* CONFIG_KEXEC */
#endif /* LINUX_KEXEC_H */