Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef LINUX_VMCORE_INFO_H
3#define LINUX_VMCORE_INFO_H
4
5#include <linux/linkage.h>
6#include <linux/elfcore.h>
7#include <linux/elf.h>
8
9#define CRASH_CORE_NOTE_HEAD_BYTES ALIGN(sizeof(struct elf_note), 4)
10#define CRASH_CORE_NOTE_NAME_BYTES ALIGN(sizeof(NN_PRSTATUS), 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
29typedef u32 note_buf_t[CRASH_CORE_NOTE_BYTES/4];
30/* Per cpu memory for storing cpu states in case of system crash. */
31extern note_buf_t __percpu *crash_notes;
32
33void crash_update_vmcoreinfo_safecopy(void *ptr);
34void crash_save_vmcoreinfo(void);
35void arch_crash_save_vmcoreinfo(void);
36__printf(1, 2)
37void vmcoreinfo_append_str(const char *fmt, ...);
38phys_addr_t paddr_vmcoreinfo_note(void);
39
40#define VMCOREINFO_OSRELEASE(value) \
41 vmcoreinfo_append_str("OSRELEASE=%s\n", value)
42#define VMCOREINFO_BUILD_ID() \
43 ({ \
44 static_assert(sizeof(vmlinux_build_id) == 20); \
45 vmcoreinfo_append_str("BUILD-ID=%20phN\n", vmlinux_build_id); \
46 })
47
48#define VMCOREINFO_PAGESIZE(value) \
49 vmcoreinfo_append_str("PAGESIZE=%ld\n", value)
50#define VMCOREINFO_SYMBOL(name) \
51 vmcoreinfo_append_str("SYMBOL(%s)=%lx\n", #name, (unsigned long)&name)
52#define VMCOREINFO_SYMBOL_ARRAY(name) \
53 vmcoreinfo_append_str("SYMBOL(%s)=%lx\n", #name, (unsigned long)name)
54#define VMCOREINFO_SIZE(name) \
55 vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
56 (unsigned long)sizeof(name))
57#define VMCOREINFO_STRUCT_SIZE(name) \
58 vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
59 (unsigned long)sizeof(struct name))
60#define VMCOREINFO_OFFSET(name, field) \
61 vmcoreinfo_append_str("OFFSET(%s.%s)=%lu\n", #name, #field, \
62 (unsigned long)offsetof(struct name, field))
63#define VMCOREINFO_TYPE_OFFSET(name, field) \
64 vmcoreinfo_append_str("OFFSET(%s.%s)=%lu\n", #name, #field, \
65 (unsigned long)offsetof(name, field))
66#define VMCOREINFO_LENGTH(name, value) \
67 vmcoreinfo_append_str("LENGTH(%s)=%lu\n", #name, (unsigned long)value)
68#define VMCOREINFO_NUMBER(name) \
69 vmcoreinfo_append_str("NUMBER(%s)=%ld\n", #name, (long)name)
70#define VMCOREINFO_CONFIG(name) \
71 vmcoreinfo_append_str("CONFIG_%s=y\n", #name)
72
73extern unsigned char *vmcoreinfo_data;
74extern size_t vmcoreinfo_size;
75extern u32 *vmcoreinfo_note;
76
77Elf_Word *append_elf_note(Elf_Word *buf, char *name, unsigned int type,
78 void *data, size_t data_len);
79void final_note(Elf_Word *buf);
80#endif /* LINUX_VMCORE_INFO_H */