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_CRASH_CORE_H
3#define LINUX_CRASH_CORE_H
4
5#include <linux/linkage.h>
6#include <linux/elfcore.h>
7#include <linux/elf.h>
8
9#define CRASH_CORE_NOTE_NAME "CORE"
10#define CRASH_CORE_NOTE_HEAD_BYTES ALIGN(sizeof(struct elf_note), 4)
11#define CRASH_CORE_NOTE_NAME_BYTES ALIGN(sizeof(CRASH_CORE_NOTE_NAME), 4)
12#define CRASH_CORE_NOTE_DESC_BYTES ALIGN(sizeof(struct elf_prstatus), 4)
13
14/*
15 * The per-cpu notes area is a list of notes terminated by a "NULL"
16 * note header. For kdump, the code in vmcore.c runs in the context
17 * of the second kernel to combine them into one note.
18 */
19#define CRASH_CORE_NOTE_BYTES ((CRASH_CORE_NOTE_HEAD_BYTES * 2) + \
20 CRASH_CORE_NOTE_NAME_BYTES + \
21 CRASH_CORE_NOTE_DESC_BYTES)
22
23#define VMCOREINFO_BYTES PAGE_SIZE
24#define VMCOREINFO_NOTE_NAME "VMCOREINFO"
25#define VMCOREINFO_NOTE_NAME_BYTES ALIGN(sizeof(VMCOREINFO_NOTE_NAME), 4)
26#define VMCOREINFO_NOTE_SIZE ((CRASH_CORE_NOTE_HEAD_BYTES * 2) + \
27 VMCOREINFO_NOTE_NAME_BYTES + \
28 VMCOREINFO_BYTES)
29
30typedef u32 note_buf_t[CRASH_CORE_NOTE_BYTES/4];
31/* Per cpu memory for storing cpu states in case of system crash. */
32extern note_buf_t __percpu *crash_notes;
33
34void crash_update_vmcoreinfo_safecopy(void *ptr);
35void crash_save_vmcoreinfo(void);
36void arch_crash_save_vmcoreinfo(void);
37__printf(1, 2)
38void vmcoreinfo_append_str(const char *fmt, ...);
39phys_addr_t paddr_vmcoreinfo_note(void);
40
41#define VMCOREINFO_OSRELEASE(value) \
42 vmcoreinfo_append_str("OSRELEASE=%s\n", value)
43#define VMCOREINFO_BUILD_ID() \
44 ({ \
45 static_assert(sizeof(vmlinux_build_id) == 20); \
46 vmcoreinfo_append_str("BUILD-ID=%20phN\n", vmlinux_build_id); \
47 })
48
49#define VMCOREINFO_PAGESIZE(value) \
50 vmcoreinfo_append_str("PAGESIZE=%ld\n", value)
51#define VMCOREINFO_SYMBOL(name) \
52 vmcoreinfo_append_str("SYMBOL(%s)=%lx\n", #name, (unsigned long)&name)
53#define VMCOREINFO_SYMBOL_ARRAY(name) \
54 vmcoreinfo_append_str("SYMBOL(%s)=%lx\n", #name, (unsigned long)name)
55#define VMCOREINFO_SIZE(name) \
56 vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
57 (unsigned long)sizeof(name))
58#define VMCOREINFO_STRUCT_SIZE(name) \
59 vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
60 (unsigned long)sizeof(struct name))
61#define VMCOREINFO_OFFSET(name, field) \
62 vmcoreinfo_append_str("OFFSET(%s.%s)=%lu\n", #name, #field, \
63 (unsigned long)offsetof(struct name, field))
64#define VMCOREINFO_TYPE_OFFSET(name, field) \
65 vmcoreinfo_append_str("OFFSET(%s.%s)=%lu\n", #name, #field, \
66 (unsigned long)offsetof(name, field))
67#define VMCOREINFO_LENGTH(name, value) \
68 vmcoreinfo_append_str("LENGTH(%s)=%lu\n", #name, (unsigned long)value)
69#define VMCOREINFO_NUMBER(name) \
70 vmcoreinfo_append_str("NUMBER(%s)=%ld\n", #name, (long)name)
71#define VMCOREINFO_CONFIG(name) \
72 vmcoreinfo_append_str("CONFIG_%s=y\n", #name)
73
74extern unsigned char *vmcoreinfo_data;
75extern size_t vmcoreinfo_size;
76extern u32 *vmcoreinfo_note;
77
78Elf_Word *append_elf_note(Elf_Word *buf, char *name, unsigned int type,
79 void *data, size_t data_len);
80void final_note(Elf_Word *buf);
81
82int __init parse_crashkernel(char *cmdline, unsigned long long system_ram,
83 unsigned long long *crash_size, unsigned long long *crash_base);
84int parse_crashkernel_high(char *cmdline, unsigned long long system_ram,
85 unsigned long long *crash_size, unsigned long long *crash_base);
86int parse_crashkernel_low(char *cmdline, unsigned long long system_ram,
87 unsigned long long *crash_size, unsigned long long *crash_base);
88
89/* Alignment required for elf header segment */
90#define ELF_CORE_HEADER_ALIGN 4096
91
92struct crash_mem {
93 unsigned int max_nr_ranges;
94 unsigned int nr_ranges;
95 struct range ranges[];
96};
97
98extern int crash_exclude_mem_range(struct crash_mem *mem,
99 unsigned long long mstart,
100 unsigned long long mend);
101extern int crash_prepare_elf64_headers(struct crash_mem *mem, int need_kernel_map,
102 void **addr, unsigned long *sz);
103
104struct kimage;
105struct kexec_segment;
106
107#define KEXEC_CRASH_HP_NONE 0
108#define KEXEC_CRASH_HP_ADD_CPU 1
109#define KEXEC_CRASH_HP_REMOVE_CPU 2
110#define KEXEC_CRASH_HP_ADD_MEMORY 3
111#define KEXEC_CRASH_HP_REMOVE_MEMORY 4
112#define KEXEC_CRASH_HP_INVALID_CPU -1U
113
114#endif /* LINUX_CRASH_CORE_H */