xref: /linux-6.15/include/linux/crash_core.h (revision bb7e5ce7)
1 #ifndef LINUX_CRASH_CORE_H
2 #define LINUX_CRASH_CORE_H
3 
4 #include <linux/linkage.h>
5 #include <linux/elfcore.h>
6 #include <linux/elf.h>
7 
8 #define CRASH_CORE_NOTE_NAME	   "CORE"
9 #define CRASH_CORE_NOTE_HEAD_BYTES ALIGN(sizeof(struct elf_note), 4)
10 #define CRASH_CORE_NOTE_NAME_BYTES ALIGN(sizeof(CRASH_CORE_NOTE_NAME), 4)
11 #define CRASH_CORE_NOTE_DESC_BYTES ALIGN(sizeof(struct elf_prstatus), 4)
12 
13 /*
14  * The per-cpu notes area is a list of notes terminated by a "NULL"
15  * note header.  For kdump, the code in vmcore.c runs in the context
16  * of the second kernel to combine them into one note.
17  */
18 #define CRASH_CORE_NOTE_BYTES	   ((CRASH_CORE_NOTE_HEAD_BYTES * 2) +	\
19 				     CRASH_CORE_NOTE_NAME_BYTES +	\
20 				     CRASH_CORE_NOTE_DESC_BYTES)
21 
22 #define VMCOREINFO_BYTES	   PAGE_SIZE
23 #define VMCOREINFO_NOTE_NAME	   "VMCOREINFO"
24 #define VMCOREINFO_NOTE_NAME_BYTES ALIGN(sizeof(VMCOREINFO_NOTE_NAME), 4)
25 #define VMCOREINFO_NOTE_SIZE	   ((CRASH_CORE_NOTE_HEAD_BYTES * 2) +	\
26 				     VMCOREINFO_NOTE_NAME_BYTES +	\
27 				     VMCOREINFO_BYTES)
28 
29 typedef u32 note_buf_t[CRASH_CORE_NOTE_BYTES/4];
30 
31 void crash_update_vmcoreinfo_safecopy(void *ptr);
32 void crash_save_vmcoreinfo(void);
33 void arch_crash_save_vmcoreinfo(void);
34 __printf(1, 2)
35 void vmcoreinfo_append_str(const char *fmt, ...);
36 phys_addr_t paddr_vmcoreinfo_note(void);
37 
38 #define VMCOREINFO_OSRELEASE(value) \
39 	vmcoreinfo_append_str("OSRELEASE=%s\n", value)
40 #define VMCOREINFO_PAGESIZE(value) \
41 	vmcoreinfo_append_str("PAGESIZE=%ld\n", value)
42 #define VMCOREINFO_SYMBOL(name) \
43 	vmcoreinfo_append_str("SYMBOL(%s)=%lx\n", #name, (unsigned long)&name)
44 #define VMCOREINFO_SIZE(name) \
45 	vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
46 			      (unsigned long)sizeof(name))
47 #define VMCOREINFO_STRUCT_SIZE(name) \
48 	vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
49 			      (unsigned long)sizeof(struct name))
50 #define VMCOREINFO_OFFSET(name, field) \
51 	vmcoreinfo_append_str("OFFSET(%s.%s)=%lu\n", #name, #field, \
52 			      (unsigned long)offsetof(struct name, field))
53 #define VMCOREINFO_LENGTH(name, value) \
54 	vmcoreinfo_append_str("LENGTH(%s)=%lu\n", #name, (unsigned long)value)
55 #define VMCOREINFO_NUMBER(name) \
56 	vmcoreinfo_append_str("NUMBER(%s)=%ld\n", #name, (long)name)
57 #define VMCOREINFO_CONFIG(name) \
58 	vmcoreinfo_append_str("CONFIG_%s=y\n", #name)
59 
60 extern u32 *vmcoreinfo_note;
61 
62 Elf_Word *append_elf_note(Elf_Word *buf, char *name, unsigned int type,
63 			  void *data, size_t data_len);
64 void final_note(Elf_Word *buf);
65 
66 int __init parse_crashkernel(char *cmdline, unsigned long long system_ram,
67 		unsigned long long *crash_size, unsigned long long *crash_base);
68 int parse_crashkernel_high(char *cmdline, unsigned long long system_ram,
69 		unsigned long long *crash_size, unsigned long long *crash_base);
70 int parse_crashkernel_low(char *cmdline, unsigned long long system_ram,
71 		unsigned long long *crash_size, unsigned long long *crash_base);
72 
73 #endif /* LINUX_CRASH_CORE_H */
74