1 #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>
9 #include <linux/ioport.h>
10 #include <linux/elfcore.h>
11 #include <linux/elf.h>
12 #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 
28 #ifndef KEXEC_CONTROL_PAGE_SIZE
29 #error KEXEC_CONTROL_PAGE_SIZE not defined
30 #endif
31 
32 #ifndef KEXEC_ARCH
33 #error KEXEC_ARCH not defined
34 #endif
35 
36 #ifndef KEXEC_CRASH_CONTROL_MEMORY_LIMIT
37 #define KEXEC_CRASH_CONTROL_MEMORY_LIMIT KEXEC_CONTROL_MEMORY_LIMIT
38 #endif
39 
40 #ifndef KEXEC_CRASH_MEM_ALIGN
41 #define KEXEC_CRASH_MEM_ALIGN PAGE_SIZE
42 #endif
43 
44 #define KEXEC_NOTE_HEAD_BYTES ALIGN(sizeof(struct elf_note), 4)
45 #define KEXEC_CORE_NOTE_NAME "CORE"
46 #define KEXEC_CORE_NOTE_NAME_BYTES ALIGN(sizeof(KEXEC_CORE_NOTE_NAME), 4)
47 #define KEXEC_CORE_NOTE_DESC_BYTES ALIGN(sizeof(struct elf_prstatus), 4)
48 /*
49  * The per-cpu notes area is a list of notes terminated by a "NULL"
50  * note header.  For kdump, the code in vmcore.c runs in the context
51  * of the second kernel to combine them into one note.
52  */
53 #ifndef KEXEC_NOTE_BYTES
54 #define KEXEC_NOTE_BYTES ( (KEXEC_NOTE_HEAD_BYTES * 2) +		\
55 			    KEXEC_CORE_NOTE_NAME_BYTES +		\
56 			    KEXEC_CORE_NOTE_DESC_BYTES )
57 #endif
58 
59 /*
60  * This structure is used to hold the arguments that are used when loading
61  * kernel binaries.
62  */
63 
64 typedef unsigned long kimage_entry_t;
65 #define IND_DESTINATION  0x1
66 #define IND_INDIRECTION  0x2
67 #define IND_DONE         0x4
68 #define IND_SOURCE       0x8
69 
70 #define KEXEC_SEGMENT_MAX 16
71 struct kexec_segment {
72 	void __user *buf;
73 	size_t bufsz;
74 	unsigned long mem;	/* User space sees this as a (void *) ... */
75 	size_t memsz;
76 };
77 
78 #ifdef CONFIG_COMPAT
79 struct compat_kexec_segment {
80 	compat_uptr_t buf;
81 	compat_size_t bufsz;
82 	compat_ulong_t mem;	/* User space sees this as a (void *) ... */
83 	compat_size_t memsz;
84 };
85 #endif
86 
87 struct kimage {
88 	kimage_entry_t head;
89 	kimage_entry_t *entry;
90 	kimage_entry_t *last_entry;
91 
92 	unsigned long destination;
93 
94 	unsigned long start;
95 	struct page *control_code_page;
96 	struct page *swap_page;
97 
98 	unsigned long nr_segments;
99 	struct kexec_segment segment[KEXEC_SEGMENT_MAX];
100 
101 	struct list_head control_pages;
102 	struct list_head dest_pages;
103 	struct list_head unuseable_pages;
104 
105 	/* Address of next control page to allocate for crash kernels. */
106 	unsigned long control_page;
107 
108 	/* Flags to indicate special processing */
109 	unsigned int type : 1;
110 #define KEXEC_TYPE_DEFAULT 0
111 #define KEXEC_TYPE_CRASH   1
112 	unsigned int preserve_context : 1;
113 
114 #ifdef ARCH_HAS_KIMAGE_ARCH
115 	struct kimage_arch arch;
116 #endif
117 };
118 
119 
120 
121 /* kexec interface functions */
122 extern void machine_kexec(struct kimage *image);
123 extern int machine_kexec_prepare(struct kimage *image);
124 extern void machine_kexec_cleanup(struct kimage *image);
125 extern asmlinkage long sys_kexec_load(unsigned long entry,
126 					unsigned long nr_segments,
127 					struct kexec_segment __user *segments,
128 					unsigned long flags);
129 extern int kernel_kexec(void);
130 #ifdef CONFIG_COMPAT
131 extern asmlinkage long compat_sys_kexec_load(unsigned long entry,
132 				unsigned long nr_segments,
133 				struct compat_kexec_segment __user *segments,
134 				unsigned long flags);
135 #endif
136 extern struct page *kimage_alloc_control_pages(struct kimage *image,
137 						unsigned int order);
138 extern void crash_kexec(struct pt_regs *);
139 int kexec_should_crash(struct task_struct *);
140 void crash_save_cpu(struct pt_regs *regs, int cpu);
141 void crash_save_vmcoreinfo(void);
142 void crash_map_reserved_pages(void);
143 void crash_unmap_reserved_pages(void);
144 void arch_crash_save_vmcoreinfo(void);
145 __printf(1, 2)
146 void vmcoreinfo_append_str(const char *fmt, ...);
147 unsigned long paddr_vmcoreinfo_note(void);
148 
149 #define VMCOREINFO_OSRELEASE(value) \
150 	vmcoreinfo_append_str("OSRELEASE=%s\n", value)
151 #define VMCOREINFO_PAGESIZE(value) \
152 	vmcoreinfo_append_str("PAGESIZE=%ld\n", value)
153 #define VMCOREINFO_SYMBOL(name) \
154 	vmcoreinfo_append_str("SYMBOL(%s)=%lx\n", #name, (unsigned long)&name)
155 #define VMCOREINFO_SIZE(name) \
156 	vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
157 			      (unsigned long)sizeof(name))
158 #define VMCOREINFO_STRUCT_SIZE(name) \
159 	vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
160 			      (unsigned long)sizeof(struct name))
161 #define VMCOREINFO_OFFSET(name, field) \
162 	vmcoreinfo_append_str("OFFSET(%s.%s)=%lu\n", #name, #field, \
163 			      (unsigned long)offsetof(struct name, field))
164 #define VMCOREINFO_LENGTH(name, value) \
165 	vmcoreinfo_append_str("LENGTH(%s)=%lu\n", #name, (unsigned long)value)
166 #define VMCOREINFO_NUMBER(name) \
167 	vmcoreinfo_append_str("NUMBER(%s)=%ld\n", #name, (long)name)
168 #define VMCOREINFO_CONFIG(name) \
169 	vmcoreinfo_append_str("CONFIG_%s=y\n", #name)
170 
171 extern struct kimage *kexec_image;
172 extern struct kimage *kexec_crash_image;
173 
174 #ifndef kexec_flush_icache_page
175 #define kexec_flush_icache_page(page)
176 #endif
177 
178 #define KEXEC_ON_CRASH		0x00000001
179 #define KEXEC_PRESERVE_CONTEXT	0x00000002
180 #define KEXEC_ARCH_MASK		0xffff0000
181 
182 /* These values match the ELF architecture values.
183  * Unless there is a good reason that should continue to be the case.
184  */
185 #define KEXEC_ARCH_DEFAULT ( 0 << 16)
186 #define KEXEC_ARCH_386     ( 3 << 16)
187 #define KEXEC_ARCH_X86_64  (62 << 16)
188 #define KEXEC_ARCH_PPC     (20 << 16)
189 #define KEXEC_ARCH_PPC64   (21 << 16)
190 #define KEXEC_ARCH_IA_64   (50 << 16)
191 #define KEXEC_ARCH_ARM     (40 << 16)
192 #define KEXEC_ARCH_S390    (22 << 16)
193 #define KEXEC_ARCH_SH      (42 << 16)
194 #define KEXEC_ARCH_MIPS_LE (10 << 16)
195 #define KEXEC_ARCH_MIPS    ( 8 << 16)
196 
197 /* List of defined/legal kexec flags */
198 #ifndef CONFIG_KEXEC_JUMP
199 #define KEXEC_FLAGS    KEXEC_ON_CRASH
200 #else
201 #define KEXEC_FLAGS    (KEXEC_ON_CRASH | KEXEC_PRESERVE_CONTEXT)
202 #endif
203 
204 #define VMCOREINFO_BYTES           (4096)
205 #define VMCOREINFO_NOTE_NAME       "VMCOREINFO"
206 #define VMCOREINFO_NOTE_NAME_BYTES ALIGN(sizeof(VMCOREINFO_NOTE_NAME), 4)
207 #define VMCOREINFO_NOTE_SIZE       (KEXEC_NOTE_HEAD_BYTES*2 + VMCOREINFO_BYTES \
208 				    + VMCOREINFO_NOTE_NAME_BYTES)
209 
210 /* Location of a reserved region to hold the crash kernel.
211  */
212 extern struct resource crashk_res;
213 typedef u32 note_buf_t[KEXEC_NOTE_BYTES/4];
214 extern note_buf_t __percpu *crash_notes;
215 extern u32 vmcoreinfo_note[VMCOREINFO_NOTE_SIZE/4];
216 extern size_t vmcoreinfo_size;
217 extern size_t vmcoreinfo_max_size;
218 
219 int __init parse_crashkernel(char *cmdline, unsigned long long system_ram,
220 		unsigned long long *crash_size, unsigned long long *crash_base);
221 int crash_shrink_memory(unsigned long new_size);
222 size_t crash_get_memory_size(void);
223 void crash_free_reserved_phys_range(unsigned long begin, unsigned long end);
224 
225 #else /* !CONFIG_KEXEC */
226 struct pt_regs;
227 struct task_struct;
crash_kexec(struct pt_regs * regs)228 static inline void crash_kexec(struct pt_regs *regs) { }
kexec_should_crash(struct task_struct * p)229 static inline int kexec_should_crash(struct task_struct *p) { return 0; }
230 #endif /* CONFIG_KEXEC */
231 #endif /* LINUX_KEXEC_H */
232