kdump, vmcoreinfo: report memory sections virtual addresses
[deliverable/linux.git] / include / linux / kexec.h
CommitLineData
dc009d92
EB
1#ifndef LINUX_KEXEC_H
2#define LINUX_KEXEC_H
3
cf2df639
GL
4#define IND_DESTINATION_BIT 0
5#define IND_INDIRECTION_BIT 1
6#define IND_DONE_BIT 2
7#define IND_SOURCE_BIT 3
8
9#define IND_DESTINATION (1 << IND_DESTINATION_BIT)
10#define IND_INDIRECTION (1 << IND_INDIRECTION_BIT)
11#define IND_DONE (1 << IND_DONE_BIT)
12#define IND_SOURCE (1 << IND_SOURCE_BIT)
b28c2ee8 13#define IND_FLAGS (IND_DESTINATION | IND_INDIRECTION | IND_DONE | IND_SOURCE)
cf2df639
GL
14
15#if !defined(__ASSEMBLY__)
16
43546d86
RK
17#include <asm/io.h>
18
607ca46e 19#include <uapi/linux/kexec.h>
29a5c67e 20
2965faa5 21#ifdef CONFIG_KEXEC_CORE
dc009d92
EB
22#include <linux/list.h>
23#include <linux/linkage.h>
24#include <linux/compat.h>
9c15e852 25#include <linux/ioport.h>
6672f76a
SH
26#include <linux/elfcore.h>
27#include <linux/elf.h>
12db5562 28#include <linux/module.h>
dc009d92
EB
29#include <asm/kexec.h>
30
31/* Verify architecture specific macros are defined */
32
33#ifndef KEXEC_SOURCE_MEMORY_LIMIT
34#error KEXEC_SOURCE_MEMORY_LIMIT not defined
35#endif
36
37#ifndef KEXEC_DESTINATION_MEMORY_LIMIT
38#error KEXEC_DESTINATION_MEMORY_LIMIT not defined
39#endif
40
41#ifndef KEXEC_CONTROL_MEMORY_LIMIT
42#error KEXEC_CONTROL_MEMORY_LIMIT not defined
43#endif
44
7e01b5ac 45#ifndef KEXEC_CONTROL_MEMORY_GFP
dc5cccac 46#define KEXEC_CONTROL_MEMORY_GFP (GFP_KERNEL | __GFP_NORETRY)
7e01b5ac
MS
47#endif
48
163f6876
HY
49#ifndef KEXEC_CONTROL_PAGE_SIZE
50#error KEXEC_CONTROL_PAGE_SIZE not defined
dc009d92
EB
51#endif
52
53#ifndef KEXEC_ARCH
54#error KEXEC_ARCH not defined
55#endif
56
3d214fae
MH
57#ifndef KEXEC_CRASH_CONTROL_MEMORY_LIMIT
58#define KEXEC_CRASH_CONTROL_MEMORY_LIMIT KEXEC_CONTROL_MEMORY_LIMIT
59#endif
60
558df720
MH
61#ifndef KEXEC_CRASH_MEM_ALIGN
62#define KEXEC_CRASH_MEM_ALIGN PAGE_SIZE
63#endif
64
6672f76a
SH
65#define KEXEC_NOTE_HEAD_BYTES ALIGN(sizeof(struct elf_note), 4)
66#define KEXEC_CORE_NOTE_NAME "CORE"
67#define KEXEC_CORE_NOTE_NAME_BYTES ALIGN(sizeof(KEXEC_CORE_NOTE_NAME), 4)
68#define KEXEC_CORE_NOTE_DESC_BYTES ALIGN(sizeof(struct elf_prstatus), 4)
69/*
70 * The per-cpu notes area is a list of notes terminated by a "NULL"
71 * note header. For kdump, the code in vmcore.c runs in the context
72 * of the second kernel to combine them into one note.
73 */
cb78edfd 74#ifndef KEXEC_NOTE_BYTES
6672f76a
SH
75#define KEXEC_NOTE_BYTES ( (KEXEC_NOTE_HEAD_BYTES * 2) + \
76 KEXEC_CORE_NOTE_NAME_BYTES + \
77 KEXEC_CORE_NOTE_DESC_BYTES )
cb78edfd 78#endif
6672f76a 79
dc009d92
EB
80/*
81 * This structure is used to hold the arguments that are used when loading
82 * kernel binaries.
83 */
84
85typedef unsigned long kimage_entry_t;
dc009d92 86
dc009d92 87struct kexec_segment {
815d5704
VG
88 /*
89 * This pointer can point to user memory if kexec_load() system
90 * call is used or will point to kernel memory if
91 * kexec_file_load() system call is used.
92 *
93 * Use ->buf when expecting to deal with user memory and use ->kbuf
94 * when expecting to deal with kernel memory.
95 */
96 union {
97 void __user *buf;
98 void *kbuf;
99 };
dc009d92 100 size_t bufsz;
29a5c67e 101 unsigned long mem;
dc009d92
EB
102 size_t memsz;
103};
104
105#ifdef CONFIG_COMPAT
106struct compat_kexec_segment {
107 compat_uptr_t buf;
108 compat_size_t bufsz;
109 compat_ulong_t mem; /* User space sees this as a (void *) ... */
110 compat_size_t memsz;
111};
112#endif
113
978e30c9 114#ifdef CONFIG_KEXEC_FILE
12db5562
VG
115struct purgatory_info {
116 /* Pointer to elf header of read only purgatory */
117 Elf_Ehdr *ehdr;
118
119 /* Pointer to purgatory sechdrs which are modifiable */
120 Elf_Shdr *sechdrs;
121 /*
122 * Temporary buffer location where purgatory is loaded and relocated
123 * This memory can be freed post image load
124 */
125 void *purgatory_buf;
126
127 /* Address where purgatory is finally loaded and is executed from */
128 unsigned long purgatory_load_addr;
129};
130
978e30c9
XP
131typedef int (kexec_probe_t)(const char *kernel_buf, unsigned long kernel_size);
132typedef void *(kexec_load_t)(struct kimage *image, char *kernel_buf,
133 unsigned long kernel_len, char *initrd,
134 unsigned long initrd_len, char *cmdline,
135 unsigned long cmdline_len);
136typedef int (kexec_cleanup_t)(void *loader_data);
137
138#ifdef CONFIG_KEXEC_VERIFY_SIG
139typedef int (kexec_verify_sig_t)(const char *kernel_buf,
140 unsigned long kernel_len);
141#endif
142
143struct kexec_file_ops {
144 kexec_probe_t *probe;
145 kexec_load_t *load;
146 kexec_cleanup_t *cleanup;
147#ifdef CONFIG_KEXEC_VERIFY_SIG
148 kexec_verify_sig_t *verify_sig;
149#endif
150};
151#endif
152
dc009d92
EB
153struct kimage {
154 kimage_entry_t head;
155 kimage_entry_t *entry;
156 kimage_entry_t *last_entry;
157
dc009d92
EB
158 unsigned long start;
159 struct page *control_code_page;
3ab83521 160 struct page *swap_page;
dc009d92
EB
161
162 unsigned long nr_segments;
163 struct kexec_segment segment[KEXEC_SEGMENT_MAX];
164
165 struct list_head control_pages;
166 struct list_head dest_pages;
7d3e2bca 167 struct list_head unusable_pages;
dc009d92
EB
168
169 /* Address of next control page to allocate for crash kernels. */
170 unsigned long control_page;
171
172 /* Flags to indicate special processing */
173 unsigned int type : 1;
174#define KEXEC_TYPE_DEFAULT 0
175#define KEXEC_TYPE_CRASH 1
3ab83521 176 unsigned int preserve_context : 1;
cb105258
VG
177 /* If set, we are using file mode kexec syscall */
178 unsigned int file_mode:1;
92be3d6b
HY
179
180#ifdef ARCH_HAS_KIMAGE_ARCH
181 struct kimage_arch arch;
182#endif
cb105258 183
978e30c9 184#ifdef CONFIG_KEXEC_FILE
cb105258
VG
185 /* Additional fields for file based kexec syscall */
186 void *kernel_buf;
187 unsigned long kernel_buf_len;
188
189 void *initrd_buf;
190 unsigned long initrd_buf_len;
191
192 char *cmdline_buf;
193 unsigned long cmdline_buf_len;
194
195 /* File operations provided by image loader */
196 struct kexec_file_ops *fops;
197
198 /* Image loader handling the kernel can store a pointer here */
199 void *image_loader_data;
12db5562
VG
200
201 /* Information for loading purgatory */
202 struct purgatory_info purgatory_info;
978e30c9 203#endif
cb105258 204};
dc009d92
EB
205
206/* kexec interface functions */
3ab83521 207extern void machine_kexec(struct kimage *image);
dc009d92
EB
208extern int machine_kexec_prepare(struct kimage *image);
209extern void machine_kexec_cleanup(struct kimage *image);
210extern asmlinkage long sys_kexec_load(unsigned long entry,
72414d3f
MS
211 unsigned long nr_segments,
212 struct kexec_segment __user *segments,
213 unsigned long flags);
3ab83521 214extern int kernel_kexec(void);
cb105258
VG
215extern int kexec_add_buffer(struct kimage *image, char *buffer,
216 unsigned long bufsz, unsigned long memsz,
217 unsigned long buf_align, unsigned long buf_min,
218 unsigned long buf_max, bool top_down,
219 unsigned long *load_addr);
72414d3f
MS
220extern struct page *kimage_alloc_control_pages(struct kimage *image,
221 unsigned int order);
12db5562
VG
222extern int kexec_load_purgatory(struct kimage *image, unsigned long min,
223 unsigned long max, int top_down,
224 unsigned long *load_addr);
225extern int kexec_purgatory_get_set_symbol(struct kimage *image,
226 const char *name, void *buf,
227 unsigned int size, bool get_value);
228extern void *kexec_purgatory_get_symbol_addr(struct kimage *image,
229 const char *name);
7bbee5ca 230extern void __crash_kexec(struct pt_regs *);
6e274d14
AN
231extern void crash_kexec(struct pt_regs *);
232int kexec_should_crash(struct task_struct *);
21db79e8 233int kexec_crash_loaded(void);
85916f81 234void crash_save_cpu(struct pt_regs *regs, int cpu);
fd59d231
KO
235void crash_save_vmcoreinfo(void);
236void arch_crash_save_vmcoreinfo(void);
b9075fa9
JP
237__printf(1, 2)
238void vmcoreinfo_append_str(const char *fmt, ...);
dae28018 239phys_addr_t paddr_vmcoreinfo_note(void);
fd59d231 240
c6e2bee2
BW
241#define VMCOREINFO_OSRELEASE(value) \
242 vmcoreinfo_append_str("OSRELEASE=%s\n", value)
bba1f603
KO
243#define VMCOREINFO_PAGESIZE(value) \
244 vmcoreinfo_append_str("PAGESIZE=%ld\n", value)
bcbba6c1 245#define VMCOREINFO_SYMBOL(name) \
fd59d231 246 vmcoreinfo_append_str("SYMBOL(%s)=%lx\n", #name, (unsigned long)&name)
bcbba6c1 247#define VMCOREINFO_SIZE(name) \
6cfa062f
KO
248 vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
249 (unsigned long)sizeof(name))
c76f860c
KO
250#define VMCOREINFO_STRUCT_SIZE(name) \
251 vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
252 (unsigned long)sizeof(struct name))
bcbba6c1 253#define VMCOREINFO_OFFSET(name, field) \
d768281e 254 vmcoreinfo_append_str("OFFSET(%s.%s)=%lu\n", #name, #field, \
1e4f2955 255 (unsigned long)offsetof(struct name, field))
bcbba6c1 256#define VMCOREINFO_LENGTH(name, value) \
d768281e 257 vmcoreinfo_append_str("LENGTH(%s)=%lu\n", #name, (unsigned long)value)
bcbba6c1 258#define VMCOREINFO_NUMBER(name) \
6cfa062f 259 vmcoreinfo_append_str("NUMBER(%s)=%ld\n", #name, (long)name)
bcbba6c1 260#define VMCOREINFO_CONFIG(name) \
fd59d231 261 vmcoreinfo_append_str("CONFIG_%s=y\n", #name)
955d6ad6
HD
262#define VMCOREINFO_PHYS_BASE(value) \
263 vmcoreinfo_append_str("PHYS_BASE=%lx\n", (unsigned long)value)
90189ed3
TG
264#define VMCOREINFO_PAGE_OFFSET(value) \
265 vmcoreinfo_append_str("PAGE_OFFSET=%lx\n", (unsigned long)value)
266#define VMCOREINFO_VMALLOC_START(value) \
267 vmcoreinfo_append_str("VMALLOC_START=%lx\n", (unsigned long)value)
268#define VMCOREINFO_VMEMMAP_START(value) \
269 vmcoreinfo_append_str("VMEMMAP_START=%lx\n", (unsigned long)value)
fd59d231 270
dc009d92 271extern struct kimage *kexec_image;
c330dda9 272extern struct kimage *kexec_crash_image;
7984754b 273extern int kexec_load_disabled;
dc009d92 274
a7956113
ZN
275#ifndef kexec_flush_icache_page
276#define kexec_flush_icache_page(page)
277#endif
278
3ab83521
HY
279/* List of defined/legal kexec flags */
280#ifndef CONFIG_KEXEC_JUMP
281#define KEXEC_FLAGS KEXEC_ON_CRASH
282#else
283#define KEXEC_FLAGS (KEXEC_ON_CRASH | KEXEC_PRESERVE_CONTEXT)
284#endif
dc009d92 285
cb105258
VG
286/* List of defined/legal kexec file flags */
287#define KEXEC_FILE_FLAGS (KEXEC_FILE_UNLOAD | KEXEC_FILE_ON_CRASH | \
288 KEXEC_FILE_NO_INITRAMFS)
289
fd59d231
KO
290#define VMCOREINFO_BYTES (4096)
291#define VMCOREINFO_NOTE_NAME "VMCOREINFO"
292#define VMCOREINFO_NOTE_NAME_BYTES ALIGN(sizeof(VMCOREINFO_NOTE_NAME), 4)
293#define VMCOREINFO_NOTE_SIZE (KEXEC_NOTE_HEAD_BYTES*2 + VMCOREINFO_BYTES \
294 + VMCOREINFO_NOTE_NAME_BYTES)
295
dc009d92
EB
296/* Location of a reserved region to hold the crash kernel.
297 */
298extern struct resource crashk_res;
0212f915 299extern struct resource crashk_low_res;
6672f76a 300typedef u32 note_buf_t[KEXEC_NOTE_BYTES/4];
43cf38eb 301extern note_buf_t __percpu *crash_notes;
fd59d231 302extern u32 vmcoreinfo_note[VMCOREINFO_NOTE_SIZE/4];
d768281e
KO
303extern size_t vmcoreinfo_size;
304extern size_t vmcoreinfo_max_size;
dc009d92 305
4fc9bbf9
KA
306/* flag to track if kexec reboot is in progress */
307extern bool kexec_in_progress;
308
cba63c30
BW
309int __init parse_crashkernel(char *cmdline, unsigned long long system_ram,
310 unsigned long long *crash_size, unsigned long long *crash_base);
55a20ee7
YL
311int parse_crashkernel_high(char *cmdline, unsigned long long system_ram,
312 unsigned long long *crash_size, unsigned long long *crash_base);
0212f915
YL
313int parse_crashkernel_low(char *cmdline, unsigned long long system_ram,
314 unsigned long long *crash_size, unsigned long long *crash_base);
06a7f711
AW
315int crash_shrink_memory(unsigned long new_size);
316size_t crash_get_memory_size(void);
c0bb9e45 317void crash_free_reserved_phys_range(unsigned long begin, unsigned long end);
a7956113 318
a43cac0d
DY
319int __weak arch_kexec_kernel_image_probe(struct kimage *image, void *buf,
320 unsigned long buf_len);
321void * __weak arch_kexec_kernel_image_load(struct kimage *image);
322int __weak arch_kimage_file_post_load_cleanup(struct kimage *image);
323int __weak arch_kexec_kernel_verify_sig(struct kimage *image, void *buf,
324 unsigned long buf_len);
325int __weak arch_kexec_apply_relocations_add(const Elf_Ehdr *ehdr,
326 Elf_Shdr *sechdrs, unsigned int relsec);
327int __weak arch_kexec_apply_relocations(const Elf_Ehdr *ehdr, Elf_Shdr *sechdrs,
328 unsigned int relsec);
9b492cf5
XP
329void arch_kexec_protect_crashkres(void);
330void arch_kexec_unprotect_crashkres(void);
a43cac0d 331
43546d86
RK
332#ifndef page_to_boot_pfn
333static inline unsigned long page_to_boot_pfn(struct page *page)
334{
335 return page_to_pfn(page);
336}
337#endif
338
339#ifndef boot_pfn_to_page
340static inline struct page *boot_pfn_to_page(unsigned long boot_pfn)
341{
342 return pfn_to_page(boot_pfn);
343}
344#endif
345
346#ifndef phys_to_boot_phys
347static inline unsigned long phys_to_boot_phys(phys_addr_t phys)
348{
349 return phys;
350}
351#endif
352
353#ifndef boot_phys_to_phys
354static inline phys_addr_t boot_phys_to_phys(unsigned long boot_phys)
355{
356 return boot_phys;
357}
358#endif
359
360static inline unsigned long virt_to_boot_phys(void *addr)
361{
362 return phys_to_boot_phys(__pa((unsigned long)addr));
363}
364
365static inline void *boot_phys_to_virt(unsigned long entry)
366{
367 return phys_to_virt(boot_phys_to_phys(entry));
368}
369
2965faa5 370#else /* !CONFIG_KEXEC_CORE */
6e274d14
AN
371struct pt_regs;
372struct task_struct;
7bbee5ca 373static inline void __crash_kexec(struct pt_regs *regs) { }
6e274d14
AN
374static inline void crash_kexec(struct pt_regs *regs) { }
375static inline int kexec_should_crash(struct task_struct *p) { return 0; }
21db79e8 376static inline int kexec_crash_loaded(void) { return 0; }
2b94ed24 377#define kexec_in_progress false
2965faa5 378#endif /* CONFIG_KEXEC_CORE */
cf2df639
GL
379
380#endif /* !defined(__ASSEBMLY__) */
381
dc009d92 382#endif /* LINUX_KEXEC_H */
This page took 1.232604 seconds and 5 git commands to generate.