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