include/linux/crash_core.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 #ifndef LINUX_CRASH_CORE_H
0003 #define LINUX_CRASH_CORE_H
0004
0005 #include <linux/linkage.h>
0006 #include <linux/elfcore.h>
0007 #include <linux/elf.h>
0008
0009 #define CRASH_CORE_NOTE_NAME       "CORE"
0010 #define CRASH_CORE_NOTE_HEAD_BYTES ALIGN(sizeof(struct elf_note), 4)
0011 #define CRASH_CORE_NOTE_NAME_BYTES ALIGN(sizeof(CRASH_CORE_NOTE_NAME), 4)
0012 #define CRASH_CORE_NOTE_DESC_BYTES ALIGN(sizeof(struct elf_prstatus), 4)
0013
0014 /*
0015  * The per-cpu notes area is a list of notes terminated by a "NULL"
0016  * note header.  For kdump, the code in vmcore.c runs in the context
0017  * of the second kernel to combine them into one note.
0018  */
0019 #define CRASH_CORE_NOTE_BYTES      ((CRASH_CORE_NOTE_HEAD_BYTES * 2) +  \
0020                      CRASH_CORE_NOTE_NAME_BYTES +   \
0021                      CRASH_CORE_NOTE_DESC_BYTES)
0022
0023 #define VMCOREINFO_BYTES       PAGE_SIZE
0024 #define VMCOREINFO_NOTE_NAME       "VMCOREINFO"
0025 #define VMCOREINFO_NOTE_NAME_BYTES ALIGN(sizeof(VMCOREINFO_NOTE_NAME), 4)
0026 #define VMCOREINFO_NOTE_SIZE       ((CRASH_CORE_NOTE_HEAD_BYTES * 2) +  \
0027                      VMCOREINFO_NOTE_NAME_BYTES +   \
0028                      VMCOREINFO_BYTES)
0029
0030 typedef u32 note_buf_t[CRASH_CORE_NOTE_BYTES/4];
0031
0032 void crash_update_vmcoreinfo_safecopy(void *ptr);
0033 void crash_save_vmcoreinfo(void);
0034 void arch_crash_save_vmcoreinfo(void);
0035 __printf(1, 2)
0036 void vmcoreinfo_append_str(const char *fmt, ...);
0037 phys_addr_t paddr_vmcoreinfo_note(void);
0038
0039 #define VMCOREINFO_OSRELEASE(value) \
0040     vmcoreinfo_append_str("OSRELEASE=%s\n", value)
0041 #define VMCOREINFO_BUILD_ID()                       \
0042     ({                              \
0043         static_assert(sizeof(vmlinux_build_id) == 20);      \
0044         vmcoreinfo_append_str("BUILD-ID=%20phN\n", vmlinux_build_id); \
0045     })
0046
0047 #define VMCOREINFO_PAGESIZE(value) \
0048     vmcoreinfo_append_str("PAGESIZE=%ld\n", value)
0049 #define VMCOREINFO_SYMBOL(name) \
0050     vmcoreinfo_append_str("SYMBOL(%s)=%lx\n", #name, (unsigned long)&name)
0051 #define VMCOREINFO_SYMBOL_ARRAY(name) \
0052     vmcoreinfo_append_str("SYMBOL(%s)=%lx\n", #name, (unsigned long)name)
0053 #define VMCOREINFO_SIZE(name) \
0054     vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
0055                   (unsigned long)sizeof(name))
0056 #define VMCOREINFO_STRUCT_SIZE(name) \
0057     vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
0058                   (unsigned long)sizeof(struct name))
0059 #define VMCOREINFO_OFFSET(name, field) \
0060     vmcoreinfo_append_str("OFFSET(%s.%s)=%lu\n", #name, #field, \
0061                   (unsigned long)offsetof(struct name, field))
0062 #define VMCOREINFO_TYPE_OFFSET(name, field) \
0063     vmcoreinfo_append_str("OFFSET(%s.%s)=%lu\n", #name, #field, \
0064                   (unsigned long)offsetof(name, field))
0065 #define VMCOREINFO_LENGTH(name, value) \
0066     vmcoreinfo_append_str("LENGTH(%s)=%lu\n", #name, (unsigned long)value)
0067 #define VMCOREINFO_NUMBER(name) \
0068     vmcoreinfo_append_str("NUMBER(%s)=%ld\n", #name, (long)name)
0069 #define VMCOREINFO_CONFIG(name) \
0070     vmcoreinfo_append_str("CONFIG_%s=y\n", #name)
0071
0072 extern unsigned char *vmcoreinfo_data;
0073 extern size_t vmcoreinfo_size;
0074 extern u32 *vmcoreinfo_note;
0075
0076 Elf_Word *append_elf_note(Elf_Word *buf, char *name, unsigned int type,
0077               void *data, size_t data_len);
0078 void final_note(Elf_Word *buf);
0079
0080 int __init parse_crashkernel(char *cmdline, unsigned long long system_ram,
0081         unsigned long long *crash_size, unsigned long long *crash_base);
0082 int parse_crashkernel_high(char *cmdline, unsigned long long system_ram,
0083         unsigned long long *crash_size, unsigned long long *crash_base);
0084 int parse_crashkernel_low(char *cmdline, unsigned long long system_ram,
0085         unsigned long long *crash_size, unsigned long long *crash_base);
0086
0087 #endif /* LINUX_CRASH_CORE_H */