[linux-block.git] / include / linux / crash_core.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef LINUX_CRASH_CORE_H
#define LINUX_CRASH_CORE_H

#include <linux/linkage.h>
#include <linux/elfcore.h>
#include <linux/elf.h>

#define CRASH_CORE_NOTE_NAME	   "CORE"
#define CRASH_CORE_NOTE_HEAD_BYTES ALIGN(sizeof(struct elf_note), 4)
#define CRASH_CORE_NOTE_NAME_BYTES ALIGN(sizeof(CRASH_CORE_NOTE_NAME), 4)
#define CRASH_CORE_NOTE_DESC_BYTES ALIGN(sizeof(struct elf_prstatus), 4)

/*
 * The per-cpu notes area is a list of notes terminated by a "NULL"
 * note header.  For kdump, the code in vmcore.c runs in the context
 * of the second kernel to combine them into one note.
 */
#define CRASH_CORE_NOTE_BYTES	   ((CRASH_CORE_NOTE_HEAD_BYTES * 2) +	\
				     CRASH_CORE_NOTE_NAME_BYTES +	\
				     CRASH_CORE_NOTE_DESC_BYTES)

#define VMCOREINFO_BYTES	   PAGE_SIZE
#define VMCOREINFO_NOTE_NAME	   "VMCOREINFO"
#define VMCOREINFO_NOTE_NAME_BYTES ALIGN(sizeof(VMCOREINFO_NOTE_NAME), 4)
#define VMCOREINFO_NOTE_SIZE	   ((CRASH_CORE_NOTE_HEAD_BYTES * 2) +	\
				     VMCOREINFO_NOTE_NAME_BYTES +	\
				     VMCOREINFO_BYTES)

typedef u32 note_buf_t[CRASH_CORE_NOTE_BYTES/4];

void crash_update_vmcoreinfo_safecopy(void *ptr);
void crash_save_vmcoreinfo(void);
void arch_crash_save_vmcoreinfo(void);
__printf(1, 2)
void vmcoreinfo_append_str(const char *fmt, ...);
phys_addr_t paddr_vmcoreinfo_note(void);

#define VMCOREINFO_OSRELEASE(value) \
	vmcoreinfo_append_str("OSRELEASE=%s\n", value)
#define VMCOREINFO_BUILD_ID()						\
	({								\
		static_assert(sizeof(vmlinux_build_id) == 20);		\
		vmcoreinfo_append_str("BUILD-ID=%20phN\n", vmlinux_build_id); \
	})

#define VMCOREINFO_PAGESIZE(value) \
	vmcoreinfo_append_str("PAGESIZE=%ld\n", value)
#define VMCOREINFO_SYMBOL(name) \
	vmcoreinfo_append_str("SYMBOL(%s)=%lx\n", #name, (unsigned long)&name)
#define VMCOREINFO_SYMBOL_ARRAY(name) \
	vmcoreinfo_append_str("SYMBOL(%s)=%lx\n", #name, (unsigned long)name)
#define VMCOREINFO_SIZE(name) \
	vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
			      (unsigned long)sizeof(name))
#define VMCOREINFO_STRUCT_SIZE(name) \
	vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
			      (unsigned long)sizeof(struct name))
#define VMCOREINFO_OFFSET(name, field) \
	vmcoreinfo_append_str("OFFSET(%s.%s)=%lu\n", #name, #field, \
			      (unsigned long)offsetof(struct name, field))
#define VMCOREINFO_TYPE_OFFSET(name, field) \
	vmcoreinfo_append_str("OFFSET(%s.%s)=%lu\n", #name, #field, \
			      (unsigned long)offsetof(name, field))
#define VMCOREINFO_LENGTH(name, value) \
	vmcoreinfo_append_str("LENGTH(%s)=%lu\n", #name, (unsigned long)value)
#define VMCOREINFO_NUMBER(name) \
	vmcoreinfo_append_str("NUMBER(%s)=%ld\n", #name, (long)name)
#define VMCOREINFO_CONFIG(name) \
	vmcoreinfo_append_str("CONFIG_%s=y\n", #name)

extern unsigned char *vmcoreinfo_data;
extern size_t vmcoreinfo_size;
extern u32 *vmcoreinfo_note;

Elf_Word *append_elf_note(Elf_Word *buf, char *name, unsigned int type,
			  void *data, size_t data_len);
void final_note(Elf_Word *buf);

int __init parse_crashkernel(char *cmdline, unsigned long long system_ram,
		unsigned long long *crash_size, unsigned long long *crash_base);
int parse_crashkernel_high(char *cmdline, unsigned long long system_ram,
		unsigned long long *crash_size, unsigned long long *crash_base);
int parse_crashkernel_low(char *cmdline, unsigned long long system_ram,
		unsigned long long *crash_size, unsigned long long *crash_base);

#endif /* LINUX_CRASH_CORE_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
692f66f2 HB	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
cd0ae1d3 MH	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	*/
692f66f2 HB	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
203e9e41	23	#define VMCOREINFO_BYTES PAGE_SIZE
692f66f2 HB	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
	30	typedef u32 note_buf_t[CRASH_CORE_NOTE_BYTES/4];
	31
1229384f	32	void crash_update_vmcoreinfo_safecopy(void *ptr);
692f66f2 HB	33	void crash_save_vmcoreinfo(void);
	34	void arch_crash_save_vmcoreinfo(void);
	35	__printf(1, 2)
	36	void vmcoreinfo_append_str(const char *fmt, ...);
	37	phys_addr_t paddr_vmcoreinfo_note(void);
	38
	39	#define VMCOREINFO_OSRELEASE(value) \
	40	vmcoreinfo_append_str("OSRELEASE=%s\n", value)
44e8a5e9 SB	41	#define VMCOREINFO_BUILD_ID() \
	42	({ \
	43	static_assert(sizeof(vmlinux_build_id) == 20); \
	44	vmcoreinfo_append_str("BUILD-ID=%20phN\n", vmlinux_build_id); \
	45	})
	46
692f66f2 HB	47	#define VMCOREINFO_PAGESIZE(value) \
	48	vmcoreinfo_append_str("PAGESIZE=%ld\n", value)
	49	#define VMCOREINFO_SYMBOL(name) \
	50	vmcoreinfo_append_str("SYMBOL(%s)=%lx\n", #name, (unsigned long)&name)
a0b12803 KS	51	#define VMCOREINFO_SYMBOL_ARRAY(name) \
a0b12803 KS	52	vmcoreinfo_append_str("SYMBOL(%s)=%lx\n", #name, (unsigned long)name)
692f66f2 HB	53	#define VMCOREINFO_SIZE(name) \
	54	vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
	55	(unsigned long)sizeof(name))
	56	#define VMCOREINFO_STRUCT_SIZE(name) \
	57	vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
	58	(unsigned long)sizeof(struct name))
	59	#define VMCOREINFO_OFFSET(name, field) \
	60	vmcoreinfo_append_str("OFFSET(%s.%s)=%lu\n", #name, #field, \
	61	(unsigned long)offsetof(struct name, field))
0d6f5540 JO	62	#define VMCOREINFO_TYPE_OFFSET(name, field) \
	63	vmcoreinfo_append_str("OFFSET(%s.%s)=%lu\n", #name, #field, \
	64	(unsigned long)offsetof(name, field))
692f66f2 HB	65	#define VMCOREINFO_LENGTH(name, value) \
	66	vmcoreinfo_append_str("LENGTH(%s)=%lu\n", #name, (unsigned long)value)
	67	#define VMCOREINFO_NUMBER(name) \
	68	vmcoreinfo_append_str("NUMBER(%s)=%ld\n", #name, (long)name)
	69	#define VMCOREINFO_CONFIG(name) \
	70	vmcoreinfo_append_str("CONFIG_%s=y\n", #name)
	71
23c85094 OS	72	extern unsigned char *vmcoreinfo_data;
23c85094 OS	73	extern size_t vmcoreinfo_size;
203e9e41	74	extern u32 *vmcoreinfo_note;
692f66f2	75
51dbd925 HB	76	Elf_Word append_elf_note(Elf_Word buf, char *name, unsigned int type,
	77	void *data, size_t data_len);
	78	void final_note(Elf_Word *buf);
	79
692f66f2 HB	80	int __init parse_crashkernel(char *cmdline, unsigned long long system_ram,
	81	unsigned long long crash_size, unsigned long long crash_base);
	82	int parse_crashkernel_high(char *cmdline, unsigned long long system_ram,
	83	unsigned long long crash_size, unsigned long long crash_base);
	84	int parse_crashkernel_low(char *cmdline, unsigned long long system_ram,
	85	unsigned long long crash_size, unsigned long long crash_base);
	86
	87	#endif /* LINUX_CRASH_CORE_H */