LXR linux/include/linux/crash

   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
  32void crash_update_vmcoreinfo_safecopy(void *ptr);
  33void crash_save_vmcoreinfo(void);
  34void arch_crash_save_vmcoreinfo(void);
  35__printf(1, 2)
  36void vmcoreinfo_append_str(const char *fmt, ...);
  37phys_addr_t paddr_vmcoreinfo_note(void);
  38
  39#define VMCOREINFO_OSRELEASE(value) \
  40        vmcoreinfo_append_str("OSRELEASE=%s\n", value)
  41#define VMCOREINFO_PAGESIZE(value) \
  42        vmcoreinfo_append_str("PAGESIZE=%ld\n", value)
  43#define VMCOREINFO_SYMBOL(name) \
  44        vmcoreinfo_append_str("SYMBOL(%s)=%lx\n", #name, (unsigned long)&name)
  45#define VMCOREINFO_SYMBOL_ARRAY(name) \
  46        vmcoreinfo_append_str("SYMBOL(%s)=%lx\n", #name, (unsigned long)name)
  47#define VMCOREINFO_SIZE(name) \
  48        vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
  49                              (unsigned long)sizeof(name))
  50#define VMCOREINFO_STRUCT_SIZE(name) \
  51        vmcoreinfo_append_str("SIZE(%s)=%lu\n", #name, \
  52                              (unsigned long)sizeof(struct name))
  53#define VMCOREINFO_OFFSET(name, field) \
  54        vmcoreinfo_append_str("OFFSET(%s.%s)=%lu\n", #name, #field, \
  55                              (unsigned long)offsetof(struct name, field))
  56#define VMCOREINFO_LENGTH(name, value) \
  57        vmcoreinfo_append_str("LENGTH(%s)=%lu\n", #name, (unsigned long)value)
  58#define VMCOREINFO_NUMBER(name) \
  59        vmcoreinfo_append_str("NUMBER(%s)=%ld\n", #name, (long)name)
  60#define VMCOREINFO_CONFIG(name) \
  61        vmcoreinfo_append_str("CONFIG_%s=y\n", #name)
  62
  63extern unsigned char *vmcoreinfo_data;
  64extern size_t vmcoreinfo_size;
  65extern u32 *vmcoreinfo_note;
  66
  67Elf_Word *append_elf_note(Elf_Word *buf, char *name, unsigned int type,
  68                          void *data, size_t data_len);
  69void final_note(Elf_Word *buf);
  70
  71int __init parse_crashkernel(char *cmdline, unsigned long long system_ram,
  72                unsigned long long *crash_size, unsigned long long *crash_base);
  73int parse_crashkernel_high(char *cmdline, unsigned long long system_ram,
  74                unsigned long long *crash_size, unsigned long long *crash_base);
  75int parse_crashkernel_low(char *cmdline, unsigned long long system_ram,
  76                unsigned long long *crash_size, unsigned long long *crash_base);
  77
  78#endif /* LINUX_CRASH_CORE_H */
  79