blob: 17f76fc0517377094cf318a544eb55b2e8eaeb56 [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
Simon Horman6672f762007-05-08 00:28:22 -070036#define KEXEC_NOTE_HEAD_BYTES ALIGN(sizeof(struct elf_note), 4)
37#define KEXEC_CORE_NOTE_NAME "CORE"
38#define KEXEC_CORE_NOTE_NAME_BYTES ALIGN(sizeof(KEXEC_CORE_NOTE_NAME), 4)
39#define KEXEC_CORE_NOTE_DESC_BYTES ALIGN(sizeof(struct elf_prstatus), 4)
40/*
41 * The per-cpu notes area is a list of notes terminated by a "NULL"
42 * note header. For kdump, the code in vmcore.c runs in the context
43 * of the second kernel to combine them into one note.
44 */
45#define KEXEC_NOTE_BYTES ( (KEXEC_NOTE_HEAD_BYTES * 2) + \
46 KEXEC_CORE_NOTE_NAME_BYTES + \
47 KEXEC_CORE_NOTE_DESC_BYTES )
48
Eric W. Biedermandc009d92005-06-25 14:57:52 -070049/*
50 * This structure is used to hold the arguments that are used when loading
51 * kernel binaries.
52 */
53
54typedef unsigned long kimage_entry_t;
55#define IND_DESTINATION 0x1
56#define IND_INDIRECTION 0x2
57#define IND_DONE 0x4
58#define IND_SOURCE 0x8
59
akpm@osdl.org720e1a92006-01-09 20:51:51 -080060#define KEXEC_SEGMENT_MAX 16
Eric W. Biedermandc009d92005-06-25 14:57:52 -070061struct kexec_segment {
62 void __user *buf;
63 size_t bufsz;
64 unsigned long mem; /* User space sees this as a (void *) ... */
65 size_t memsz;
66};
67
68#ifdef CONFIG_COMPAT
69struct compat_kexec_segment {
70 compat_uptr_t buf;
71 compat_size_t bufsz;
72 compat_ulong_t mem; /* User space sees this as a (void *) ... */
73 compat_size_t memsz;
74};
75#endif
76
77struct kimage {
78 kimage_entry_t head;
79 kimage_entry_t *entry;
80 kimage_entry_t *last_entry;
81
82 unsigned long destination;
83
84 unsigned long start;
85 struct page *control_code_page;
Huang Ying3ab83522008-07-25 19:45:07 -070086 struct page *swap_page;
Eric W. Biedermandc009d92005-06-25 14:57:52 -070087
88 unsigned long nr_segments;
89 struct kexec_segment segment[KEXEC_SEGMENT_MAX];
90
91 struct list_head control_pages;
92 struct list_head dest_pages;
93 struct list_head unuseable_pages;
94
95 /* Address of next control page to allocate for crash kernels. */
96 unsigned long control_page;
97
98 /* Flags to indicate special processing */
99 unsigned int type : 1;
100#define KEXEC_TYPE_DEFAULT 0
101#define KEXEC_TYPE_CRASH 1
Huang Ying3ab83522008-07-25 19:45:07 -0700102 unsigned int preserve_context : 1;
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700103};
104
105
106
107/* kexec interface functions */
Huang Ying3ab83522008-07-25 19:45:07 -0700108extern void machine_kexec(struct kimage *image);
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700109extern int machine_kexec_prepare(struct kimage *image);
110extern void machine_kexec_cleanup(struct kimage *image);
111extern asmlinkage long sys_kexec_load(unsigned long entry,
Maneesh Soni72414d32005-06-25 14:58:28 -0700112 unsigned long nr_segments,
113 struct kexec_segment __user *segments,
114 unsigned long flags);
Huang Ying3ab83522008-07-25 19:45:07 -0700115extern int kernel_kexec(void);
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700116#ifdef CONFIG_COMPAT
117extern asmlinkage long compat_sys_kexec_load(unsigned long entry,
Maneesh Soni72414d32005-06-25 14:58:28 -0700118 unsigned long nr_segments,
119 struct compat_kexec_segment __user *segments,
120 unsigned long flags);
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700121#endif
Maneesh Soni72414d32005-06-25 14:58:28 -0700122extern struct page *kimage_alloc_control_pages(struct kimage *image,
123 unsigned int order);
Alexander Nyberg6e274d12005-06-25 14:58:26 -0700124extern void crash_kexec(struct pt_regs *);
125int kexec_should_crash(struct task_struct *);
Magnus Damm85916f82006-12-06 20:40:41 -0800126void crash_save_cpu(struct pt_regs *regs, int cpu);
Ken'ichi Ohmichifd59d232007-10-16 23:27:27 -0700127void crash_save_vmcoreinfo(void);
128void arch_crash_save_vmcoreinfo(void);
Ken'ichi Ohmichid7682812007-10-16 23:27:28 -0700129void vmcoreinfo_append_str(const char *fmt, ...)
130 __attribute__ ((format (printf, 1, 2)));
Ken'ichi Ohmichifd59d232007-10-16 23:27:27 -0700131unsigned long paddr_vmcoreinfo_note(void);
132
Bernhard Wallec6e2bee2008-08-05 13:01:05 -0700133#define VMCOREINFO_OSRELEASE(value) \
134 vmcoreinfo_append_str("OSRELEASE=%s\n", value)
Ken'ichi Ohmichibba1f602008-02-07 00:15:22 -0800135#define VMCOREINFO_PAGESIZE(value) \
136 vmcoreinfo_append_str("PAGESIZE=%ld\n", value)
Ken'ichi Ohmichibcbba6c2007-10-16 23:27:30 -0700137#define VMCOREINFO_SYMBOL(name) \
Ken'ichi Ohmichifd59d232007-10-16 23:27:27 -0700138 vmcoreinfo_append_str("SYMBOL(%s)=%lx\n", #name, (unsigned long)&name)
Ken'ichi Ohmichibcbba6c2007-10-16 23:27:30 -0700139#define VMCOREINFO_SIZE(name) \
Ken'ichi Ohmichid7682812007-10-16 23:27:28 -0700140 vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
Ken'ichi Ohmichi6cfa0622007-10-16 23:27:28 -0700141 (unsigned long)sizeof(name))
Ken'ichi Ohmichic76f8602008-02-07 00:15:20 -0800142#define VMCOREINFO_STRUCT_SIZE(name) \
143 vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
144 (unsigned long)sizeof(struct name))
Ken'ichi Ohmichibcbba6c2007-10-16 23:27:30 -0700145#define VMCOREINFO_OFFSET(name, field) \
Ken'ichi Ohmichid7682812007-10-16 23:27:28 -0700146 vmcoreinfo_append_str("OFFSET(%s.%s)=%lu\n", #name, #field, \
Ken'ichi Ohmichi1e4f2952008-02-07 00:15:22 -0800147 (unsigned long)offsetof(struct name, field))
Ken'ichi Ohmichibcbba6c2007-10-16 23:27:30 -0700148#define VMCOREINFO_LENGTH(name, value) \
Ken'ichi Ohmichid7682812007-10-16 23:27:28 -0700149 vmcoreinfo_append_str("LENGTH(%s)=%lu\n", #name, (unsigned long)value)
Ken'ichi Ohmichibcbba6c2007-10-16 23:27:30 -0700150#define VMCOREINFO_NUMBER(name) \
Ken'ichi Ohmichi6cfa0622007-10-16 23:27:28 -0700151 vmcoreinfo_append_str("NUMBER(%s)=%ld\n", #name, (long)name)
Ken'ichi Ohmichibcbba6c2007-10-16 23:27:30 -0700152#define VMCOREINFO_CONFIG(name) \
Ken'ichi Ohmichifd59d232007-10-16 23:27:27 -0700153 vmcoreinfo_append_str("CONFIG_%s=y\n", #name)
154
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700155extern struct kimage *kexec_image;
Jeff Moyerc330dda2006-06-23 02:05:07 -0700156extern struct kimage *kexec_crash_image;
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700157
Zou Nan haia79561132006-12-07 09:51:35 -0800158#ifndef kexec_flush_icache_page
159#define kexec_flush_icache_page(page)
160#endif
161
Huang Ying3ab83522008-07-25 19:45:07 -0700162#define KEXEC_ON_CRASH 0x00000001
163#define KEXEC_PRESERVE_CONTEXT 0x00000002
164#define KEXEC_ARCH_MASK 0xffff0000
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700165
166/* These values match the ELF architecture values.
167 * Unless there is a good reason that should continue to be the case.
168 */
169#define KEXEC_ARCH_DEFAULT ( 0 << 16)
170#define KEXEC_ARCH_386 ( 3 << 16)
171#define KEXEC_ARCH_X86_64 (62 << 16)
172#define KEXEC_ARCH_PPC (20 << 16)
173#define KEXEC_ARCH_PPC64 (21 << 16)
174#define KEXEC_ARCH_IA_64 (50 << 16)
Richard Purdiec587e4a2007-02-06 21:29:00 +0100175#define KEXEC_ARCH_ARM (40 << 16)
Heiko Carstenscf13f0e2005-06-25 14:58:11 -0700176#define KEXEC_ARCH_S390 (22 << 16)
kogiidena9d441902006-01-16 22:14:10 -0800177#define KEXEC_ARCH_SH (42 << 16)
Nicolas Schichan583bb862006-10-18 15:14:55 +0200178#define KEXEC_ARCH_MIPS_LE (10 << 16)
179#define KEXEC_ARCH_MIPS ( 8 << 16)
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700180
Huang Ying3ab83522008-07-25 19:45:07 -0700181/* List of defined/legal kexec flags */
182#ifndef CONFIG_KEXEC_JUMP
183#define KEXEC_FLAGS KEXEC_ON_CRASH
184#else
185#define KEXEC_FLAGS (KEXEC_ON_CRASH | KEXEC_PRESERVE_CONTEXT)
186#endif
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700187
Ken'ichi Ohmichifd59d232007-10-16 23:27:27 -0700188#define VMCOREINFO_BYTES (4096)
189#define VMCOREINFO_NOTE_NAME "VMCOREINFO"
190#define VMCOREINFO_NOTE_NAME_BYTES ALIGN(sizeof(VMCOREINFO_NOTE_NAME), 4)
191#define VMCOREINFO_NOTE_SIZE (KEXEC_NOTE_HEAD_BYTES*2 + VMCOREINFO_BYTES \
192 + VMCOREINFO_NOTE_NAME_BYTES)
193
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700194/* Location of a reserved region to hold the crash kernel.
195 */
196extern struct resource crashk_res;
Simon Horman6672f762007-05-08 00:28:22 -0700197typedef u32 note_buf_t[KEXEC_NOTE_BYTES/4];
Vivek Goyalcc571652006-01-09 20:51:41 -0800198extern note_buf_t *crash_notes;
Ken'ichi Ohmichifd59d232007-10-16 23:27:27 -0700199extern u32 vmcoreinfo_note[VMCOREINFO_NOTE_SIZE/4];
Ken'ichi Ohmichid7682812007-10-16 23:27:28 -0700200extern size_t vmcoreinfo_size;
201extern size_t vmcoreinfo_max_size;
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700202
Bernhard Wallecba63c32007-10-18 23:40:58 -0700203int __init parse_crashkernel(char *cmdline, unsigned long long system_ram,
204 unsigned long long *crash_size, unsigned long long *crash_base);
Zou Nan haia79561132006-12-07 09:51:35 -0800205
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700206#else /* !CONFIG_KEXEC */
Alexander Nyberg6e274d12005-06-25 14:58:26 -0700207struct pt_regs;
208struct task_struct;
209static inline void crash_kexec(struct pt_regs *regs) { }
210static inline int kexec_should_crash(struct task_struct *p) { return 0; }
Eric W. Biedermandc009d92005-06-25 14:57:52 -0700211#endif /* CONFIG_KEXEC */
212#endif /* LINUX_KEXEC_H */