blob: 07d9aba7556298afc63719fa6af5342884f67811 [file] [log] [blame]
Eric W. Biedermandc009d92005-06-25 14:57:52 -07001#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>
Haren Myneni9c15e852006-02-10 01:51:05 -08009#include <linux/ioport.h>
Simon Horman6672f762007-05-08 00:28:22 -070010#include <linux/elfcore.h>
11#include <linux/elf.h>
Eric W. Biedermandc009d92005-06-25 14:57:52 -070012#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
Huang Ying163f6872008-08-15 00:40:22 -070028#ifndef KEXEC_CONTROL_PAGE_SIZE
29#error KEXEC_CONTROL_PAGE_SIZE not defined
Eric W. Biedermandc009d92005-06-25 14:57:52 -070030#endif
31
32#ifndef KEXEC_ARCH
33#error KEXEC_ARCH not defined
34#endif
35
Michael Holzheu3d214fa2011-10-30 15:16:36 +010036#ifndef KEXEC_CRASH_CONTROL_MEMORY_LIMIT
37#define KEXEC_CRASH_CONTROL_MEMORY_LIMIT KEXEC_CONTROL_MEMORY_LIMIT
38#endif
39
Simon Horman6672f762007-05-08 00:28:22 -070040#define KEXEC_NOTE_HEAD_BYTES ALIGN(sizeof(struct elf_note), 4)
41#define KEXEC_CORE_NOTE_NAME "CORE"
42#define KEXEC_CORE_NOTE_NAME_BYTES ALIGN(sizeof(KEXEC_CORE_NOTE_NAME), 4)
43#define KEXEC_CORE_NOTE_DESC_BYTES ALIGN(sizeof(struct elf_prstatus), 4)
44/*
45 * The per-cpu notes area is a list of notes terminated by a "NULL"
46 * note header. For kdump, the code in vmcore.c runs in the context
47 * of the second kernel to combine them into one note.
48 */
49#define KEXEC_NOTE_BYTES ( (KEXEC_NOTE_HEAD_BYTES * 2) + \
50 KEXEC_CORE_NOTE_NAME_BYTES + \
51 KEXEC_CORE_NOTE_DESC_BYTES )
52
Eric W. Biedermandc009d92005-06-25 14:57:52 -070053/*
54 * This structure is used to hold the arguments that are used when loading
55 * kernel binaries.
56 */
57
58typedef unsigned long kimage_entry_t;
59#define IND_DESTINATION 0x1
60#define IND_INDIRECTION 0x2
61#define IND_DONE 0x4
62#define IND_SOURCE 0x8
63
akpm@osdl.org720e1a92006-01-09 20:51:51 -080064#define KEXEC_SEGMENT_MAX 16
Eric W. Biedermandc009d92005-06-25 14:57:52 -070065struct kexec_segment {
66 void __user *buf;
67 size_t bufsz;
68 unsigned long mem; /* User space sees this as a (void *) ... */
69 size_t memsz;
70};
71
72#ifdef CONFIG_COMPAT
73struct compat_kexec_segment {
74 compat_uptr_t buf;
75 compat_size_t bufsz;
76 compat_ulong_t mem; /* User space sees this as a (void *) ... */
77 compat_size_t memsz;
78};
79#endif
80
81struct kimage {
82 kimage_entry_t head;
83 kimage_entry_t *entry;
84 kimage_entry_t *last_entry;
85
86 unsigned long destination;
87
88 unsigned long start;
89 struct page *control_code_page;
Huang Ying3ab83522008-07-25 19:45:07 -070090 struct page *swap_page;
Eric W. Biedermandc009d92005-06-25 14:57:52 -070091
92 unsigned long nr_segments;
93 struct kexec_segment segment[KEXEC_SEGMENT_MAX];
94
95 struct list_head control_pages;
96 struct list_head dest_pages;
97 struct list_head unuseable_pages;
98
99 /* Address of next control page to allocate for crash kernels. */
100 unsigned long control_page;
101
102 /* Flags to indicate special processing */
103 unsigned int type : 1;
104#define KEXEC_TYPE_DEFAULT 0
105#define KEXEC_TYPE_CRASH 1
Huang Ying3ab83522008-07-25 19:45:07 -0700106 unsigned int preserve_context : 1;
Huang Ying92be3d62008-10-31 09:48:08 +0800107
108#ifdef ARCH_HAS_KIMAGE_ARCH
109 struct kimage_arch arch;
110#endif
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700111};
112
113
114
115/* kexec interface functions */
Huang Ying3ab83522008-07-25 19:45:07 -0700116extern void machine_kexec(struct kimage *image);
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700117extern int machine_kexec_prepare(struct kimage *image);
118extern void machine_kexec_cleanup(struct kimage *image);
119extern asmlinkage long sys_kexec_load(unsigned long entry,
Maneesh Soni72414d32005-06-25 14:58:28 -0700120 unsigned long nr_segments,
121 struct kexec_segment __user *segments,
122 unsigned long flags);
Huang Ying3ab83522008-07-25 19:45:07 -0700123extern int kernel_kexec(void);
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700124#ifdef CONFIG_COMPAT
125extern asmlinkage long compat_sys_kexec_load(unsigned long entry,
Maneesh Soni72414d32005-06-25 14:58:28 -0700126 unsigned long nr_segments,
127 struct compat_kexec_segment __user *segments,
128 unsigned long flags);
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700129#endif
Maneesh Soni72414d32005-06-25 14:58:28 -0700130extern struct page *kimage_alloc_control_pages(struct kimage *image,
131 unsigned int order);
Alexander Nyberg6e274d12005-06-25 14:58:26 -0700132extern void crash_kexec(struct pt_regs *);
133int kexec_should_crash(struct task_struct *);
Magnus Damm85916f82006-12-06 20:40:41 -0800134void crash_save_cpu(struct pt_regs *regs, int cpu);
Ken'ichi Ohmichifd59d232007-10-16 23:27:27 -0700135void crash_save_vmcoreinfo(void);
136void arch_crash_save_vmcoreinfo(void);
Ken'ichi Ohmichid7682812007-10-16 23:27:28 -0700137void vmcoreinfo_append_str(const char *fmt, ...)
138 __attribute__ ((format (printf, 1, 2)));
Ken'ichi Ohmichifd59d232007-10-16 23:27:27 -0700139unsigned long paddr_vmcoreinfo_note(void);
140
Bernhard Wallec6e2bee2008-08-05 13:01:05 -0700141#define VMCOREINFO_OSRELEASE(value) \
142 vmcoreinfo_append_str("OSRELEASE=%s\n", value)
Ken'ichi Ohmichibba1f602008-02-07 00:15:22 -0800143#define VMCOREINFO_PAGESIZE(value) \
144 vmcoreinfo_append_str("PAGESIZE=%ld\n", value)
Ken'ichi Ohmichibcbba6c2007-10-16 23:27:30 -0700145#define VMCOREINFO_SYMBOL(name) \
Ken'ichi Ohmichifd59d232007-10-16 23:27:27 -0700146 vmcoreinfo_append_str("SYMBOL(%s)=%lx\n", #name, (unsigned long)&name)
Ken'ichi Ohmichibcbba6c2007-10-16 23:27:30 -0700147#define VMCOREINFO_SIZE(name) \
Ken'ichi Ohmichid7682812007-10-16 23:27:28 -0700148 vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
Ken'ichi Ohmichi6cfa0622007-10-16 23:27:28 -0700149 (unsigned long)sizeof(name))
Ken'ichi Ohmichic76f8602008-02-07 00:15:20 -0800150#define VMCOREINFO_STRUCT_SIZE(name) \
151 vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
152 (unsigned long)sizeof(struct name))
Ken'ichi Ohmichibcbba6c2007-10-16 23:27:30 -0700153#define VMCOREINFO_OFFSET(name, field) \
Ken'ichi Ohmichid7682812007-10-16 23:27:28 -0700154 vmcoreinfo_append_str("OFFSET(%s.%s)=%lu\n", #name, #field, \
Ken'ichi Ohmichi1e4f2952008-02-07 00:15:22 -0800155 (unsigned long)offsetof(struct name, field))
Ken'ichi Ohmichibcbba6c2007-10-16 23:27:30 -0700156#define VMCOREINFO_LENGTH(name, value) \
Ken'ichi Ohmichid7682812007-10-16 23:27:28 -0700157 vmcoreinfo_append_str("LENGTH(%s)=%lu\n", #name, (unsigned long)value)
Ken'ichi Ohmichibcbba6c2007-10-16 23:27:30 -0700158#define VMCOREINFO_NUMBER(name) \
Ken'ichi Ohmichi6cfa0622007-10-16 23:27:28 -0700159 vmcoreinfo_append_str("NUMBER(%s)=%ld\n", #name, (long)name)
Ken'ichi Ohmichibcbba6c2007-10-16 23:27:30 -0700160#define VMCOREINFO_CONFIG(name) \
Ken'ichi Ohmichifd59d232007-10-16 23:27:27 -0700161 vmcoreinfo_append_str("CONFIG_%s=y\n", #name)
162
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700163extern struct kimage *kexec_image;
Jeff Moyerc330dda2006-06-23 02:05:07 -0700164extern struct kimage *kexec_crash_image;
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700165
Zou Nan haia7956112006-12-07 09:51:35 -0800166#ifndef kexec_flush_icache_page
167#define kexec_flush_icache_page(page)
168#endif
169
Huang Ying3ab83522008-07-25 19:45:07 -0700170#define KEXEC_ON_CRASH 0x00000001
171#define KEXEC_PRESERVE_CONTEXT 0x00000002
172#define KEXEC_ARCH_MASK 0xffff0000
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700173
174/* These values match the ELF architecture values.
175 * Unless there is a good reason that should continue to be the case.
176 */
177#define KEXEC_ARCH_DEFAULT ( 0 << 16)
178#define KEXEC_ARCH_386 ( 3 << 16)
179#define KEXEC_ARCH_X86_64 (62 << 16)
180#define KEXEC_ARCH_PPC (20 << 16)
181#define KEXEC_ARCH_PPC64 (21 << 16)
182#define KEXEC_ARCH_IA_64 (50 << 16)
Richard Purdiec587e4a2007-02-06 21:29:00 +0100183#define KEXEC_ARCH_ARM (40 << 16)
Heiko Carstenscf13f0e2005-06-25 14:58:11 -0700184#define KEXEC_ARCH_S390 (22 << 16)
kogiidena9d441902006-01-16 22:14:10 -0800185#define KEXEC_ARCH_SH (42 << 16)
Nicolas Schichan583bb862006-10-18 15:14:55 +0200186#define KEXEC_ARCH_MIPS_LE (10 << 16)
187#define KEXEC_ARCH_MIPS ( 8 << 16)
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700188
Huang Ying3ab83522008-07-25 19:45:07 -0700189/* List of defined/legal kexec flags */
190#ifndef CONFIG_KEXEC_JUMP
191#define KEXEC_FLAGS KEXEC_ON_CRASH
192#else
193#define KEXEC_FLAGS (KEXEC_ON_CRASH | KEXEC_PRESERVE_CONTEXT)
194#endif
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700195
Ken'ichi Ohmichifd59d232007-10-16 23:27:27 -0700196#define VMCOREINFO_BYTES (4096)
197#define VMCOREINFO_NOTE_NAME "VMCOREINFO"
198#define VMCOREINFO_NOTE_NAME_BYTES ALIGN(sizeof(VMCOREINFO_NOTE_NAME), 4)
199#define VMCOREINFO_NOTE_SIZE (KEXEC_NOTE_HEAD_BYTES*2 + VMCOREINFO_BYTES \
200 + VMCOREINFO_NOTE_NAME_BYTES)
201
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700202/* Location of a reserved region to hold the crash kernel.
203 */
204extern struct resource crashk_res;
Simon Horman6672f762007-05-08 00:28:22 -0700205typedef u32 note_buf_t[KEXEC_NOTE_BYTES/4];
Tejun Heo43cf38e2010-02-02 14:38:57 +0900206extern note_buf_t __percpu *crash_notes;
Ken'ichi Ohmichifd59d232007-10-16 23:27:27 -0700207extern u32 vmcoreinfo_note[VMCOREINFO_NOTE_SIZE/4];
Ken'ichi Ohmichid7682812007-10-16 23:27:28 -0700208extern size_t vmcoreinfo_size;
209extern size_t vmcoreinfo_max_size;
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700210
Bernhard Wallecba63c32007-10-18 23:40:58 -0700211int __init parse_crashkernel(char *cmdline, unsigned long long system_ram,
212 unsigned long long *crash_size, unsigned long long *crash_base);
Amerigo Wang06a7f712009-12-15 16:47:46 -0800213int crash_shrink_memory(unsigned long new_size);
214size_t crash_get_memory_size(void);
Anton Blanchardc0bb9e42010-08-25 10:22:58 +1000215void crash_free_reserved_phys_range(unsigned long begin, unsigned long end);
Zou Nan haia7956112006-12-07 09:51:35 -0800216
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700217#else /* !CONFIG_KEXEC */
Alexander Nyberg6e274d12005-06-25 14:58:26 -0700218struct pt_regs;
219struct task_struct;
220static inline void crash_kexec(struct pt_regs *regs) { }
221static inline int kexec_should_crash(struct task_struct *p) { return 0; }
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700222#endif /* CONFIG_KEXEC */
223#endif /* LINUX_KEXEC_H */