mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-04 01:49:36 +00:00
0935288c6e
Make kernel GNU build-id available in VMCOREINFO. Having build-id in VMCOREINFO facilitates presenting appropriate kernel namelist image with debug information file to kernel crash dump analysis tools. Currently VMCOREINFO lacks uniquely identifiable key for crash analysis automation. Regarding if this patch is necessary or matching of linux_banner and OSRELEASE in VMCOREINFO employed by crash(8) meets the need -- IMO, build-id approach more foolproof, in most instances it is a cryptographic hash generated using internal code/ELF bits unlike kernel version string upon which linux_banner is based that is external to the code. I feel each is intended for a different purpose. Also OSRELEASE is not suitable when two different kernel builds from same version with different features enabled. Currently for most linux (and non-linux) systems build-id can be extracted using standard methods for file types such as user mode crash dumps, shared libraries, loadable kernel modules etc., This is an exception for linux kernel dump. Having build-id in VMCOREINFO brings some uniformity for automation tools. Tyler said: : I think this is a nice improvement over today's linux_banner approach for : correlating vmlinux to a kernel dump. : : The elf notes parsing in this patch lines up with what is described in in : the "Notes (Nhdr)" section of the elf(5) man page. : : BUILD_ID_MAX is sufficient to hold a sha1 build-id, which is the default : build-id type today in GNU ld(2). It is also sufficient to hold the : "fast" build-id, which is the default build-id type today in LLVM lld(2). Signed-off-by: Vijay Balakrishna <vijayb@linux.microsoft.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Reviewed-by: Tyler Hicks <tyhicks@linux.microsoft.com> Acked-by: Baoquan He <bhe@redhat.com> Cc: Dave Young <dyoung@redhat.com> Cc: Vivek Goyal <vgoyal@redhat.com> Link: http://lkml.kernel.org/r/1591849672-34104-1-git-send-email-vijayb@linux.microsoft.com Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
84 lines
3.3 KiB
C
84 lines
3.3 KiB
C
/* 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(value) \
|
|
vmcoreinfo_append_str("BUILD-ID=%s\n", value)
|
|
#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_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;
|
|
|
|
/* raw contents of kernel .notes section */
|
|
extern const void __start_notes __weak;
|
|
extern const void __stop_notes __weak;
|
|
|
|
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 */
|