include/linux/crash_dump.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef LINUX_CRASH_DUMP_H
   3 #define LINUX_CRASH_DUMP_H
   4
   5 #include <linux/kexec.h>
   6 #include <linux/proc_fs.h>
   7 #include <linux/elf.h>
   8 #include <linux/pgtable.h>
   9 #include <uapi/linux/vmcore.h>
  10
  11 #include <linux/pgtable.h> /* for pgprot_t */
  12
  13 /* For IS_ENABLED(CONFIG_CRASH_DUMP) */
  14 #define ELFCORE_ADDR_MAX        (-1ULL)
  15 #define ELFCORE_ADDR_ERR        (-2ULL)
  16
  17 extern unsigned long long elfcorehdr_addr;
  18 extern unsigned long long elfcorehdr_size;
  19
  20 #ifdef CONFIG_CRASH_DUMP
  21 extern int elfcorehdr_alloc(unsigned long long *addr, unsigned long long *size);
  22 extern void elfcorehdr_free(unsigned long long addr);
  23 extern ssize_t elfcorehdr_read(char *buf, size_t count, u64 *ppos);
  24 extern ssize_t elfcorehdr_read_notes(char *buf, size_t count, u64 *ppos);
  25 extern int remap_oldmem_pfn_range(struct vm_area_struct *vma,
  26                                   unsigned long from, unsigned long pfn,
  27                                   unsigned long size, pgprot_t prot);
  28
  29 extern ssize_t copy_oldmem_page(unsigned long, char *, size_t,
  30                                                 unsigned long, int);
  31 extern ssize_t copy_oldmem_page_encrypted(unsigned long pfn, char *buf,
  32                                           size_t csize, unsigned long offset,
  33                                           int userbuf);
  34
  35 void vmcore_cleanup(void);
  36
  37 /* Architecture code defines this if there are other possible ELF
  38  * machine types, e.g. on bi-arch capable hardware. */
  39 #ifndef vmcore_elf_check_arch_cross
  40 #define vmcore_elf_check_arch_cross(x) 0
  41 #endif
  42
  43 /*
  44  * Architecture code can redefine this if there are any special checks
  45  * needed for 32-bit ELF or 64-bit ELF vmcores.  In case of 32-bit
  46  * only architecture, vmcore_elf64_check_arch can be set to zero.
  47  */
  48 #ifndef vmcore_elf32_check_arch
  49 #define vmcore_elf32_check_arch(x) elf_check_arch(x)
  50 #endif
  51
  52 #ifndef vmcore_elf64_check_arch
  53 #define vmcore_elf64_check_arch(x) (elf_check_arch(x) || vmcore_elf_check_arch_cross(x))
  54 #endif
  55
  56 /*
  57  * is_kdump_kernel() checks whether this kernel is booting after a panic of
  58  * previous kernel or not. This is determined by checking if previous kernel
  59  * has passed the elf core header address on command line.
  60  *
  61  * This is not just a test if CONFIG_CRASH_DUMP is enabled or not. It will
  62  * return true if CONFIG_CRASH_DUMP=y and if kernel is booting after a panic
  63  * of previous kernel.
  64  */
  65
  66 static inline bool is_kdump_kernel(void)
  67 {
  68         return elfcorehdr_addr != ELFCORE_ADDR_MAX;
  69 }
  70
  71 /* is_vmcore_usable() checks if the kernel is booting after a panic and
  72  * the vmcore region is usable.
  73  *
  74  * This makes use of the fact that due to alignment -2ULL is not
  75  * a valid pointer, much in the vain of IS_ERR(), except
  76  * dealing directly with an unsigned long long rather than a pointer.
  77  */
  78
  79 static inline int is_vmcore_usable(void)
  80 {
  81         return is_kdump_kernel() && elfcorehdr_addr != ELFCORE_ADDR_ERR ? 1 : 0;
  82 }
  83
  84 /* vmcore_unusable() marks the vmcore as unusable,
  85  * without disturbing the logic of is_kdump_kernel()
  86  */
  87
  88 static inline void vmcore_unusable(void)
  89 {
  90         if (is_kdump_kernel())
  91                 elfcorehdr_addr = ELFCORE_ADDR_ERR;
  92 }
  93
  94 /**
  95  * struct vmcore_cb - driver callbacks for /proc/vmcore handling
  96  * @pfn_is_ram: check whether a PFN really is RAM and should be accessed when
  97  *              reading the vmcore. Will return "true" if it is RAM or if the
  98  *              callback cannot tell. If any callback returns "false", it's not
  99  *              RAM and the page must not be accessed; zeroes should be
 100  *              indicated in the vmcore instead. For example, a ballooned page
 101  *              contains no data and reading from such a page will cause high
 102  *              load in the hypervisor.
 103  * @next: List head to manage registered callbacks internally; initialized by
 104  *        register_vmcore_cb().
 105  *
 106  * vmcore callbacks allow drivers managing physical memory ranges to
 107  * coordinate with vmcore handling code, for example, to prevent accessing
 108  * physical memory ranges that should not be accessed when reading the vmcore,
 109  * although included in the vmcore header as memory ranges to dump.
 110  */
 111 struct vmcore_cb {
 112         bool (*pfn_is_ram)(struct vmcore_cb *cb, unsigned long pfn);
 113         struct list_head next;
 114 };
 115 extern void register_vmcore_cb(struct vmcore_cb *cb);
 116 extern void unregister_vmcore_cb(struct vmcore_cb *cb);
 117
 118 #else /* !CONFIG_CRASH_DUMP */
 119 static inline bool is_kdump_kernel(void) { return 0; }
 120 #endif /* CONFIG_CRASH_DUMP */
 121
 122 /* Device Dump information to be filled by drivers */
 123 struct vmcoredd_data {
 124         char dump_name[VMCOREDD_MAX_NAME_BYTES]; /* Unique name of the dump */
 125         unsigned int size;                       /* Size of the dump */
 126         /* Driver's registered callback to be invoked to collect dump */
 127         int (*vmcoredd_callback)(struct vmcoredd_data *data, void *buf);
 128 };
 129
 130 #ifdef CONFIG_PROC_VMCORE_DEVICE_DUMP
 131 int vmcore_add_device_dump(struct vmcoredd_data *data);
 132 #else
 133 static inline int vmcore_add_device_dump(struct vmcoredd_data *data)
 134 {
 135         return -EOPNOTSUPP;
 136 }
 137 #endif /* CONFIG_PROC_VMCORE_DEVICE_DUMP */
 138
 139 #ifdef CONFIG_PROC_VMCORE
 140 ssize_t read_from_oldmem(char *buf, size_t count,
 141                          u64 *ppos, int userbuf,
 142                          bool encrypted);
 143 #else
 144 static inline ssize_t read_from_oldmem(char *buf, size_t count,
 145                                        u64 *ppos, int userbuf,
 146                                        bool encrypted)
 147 {
 148         return -EOPNOTSUPP;
 149 }
 150 #endif /* CONFIG_PROC_VMCORE */
 151
 152 #endif /* LINUX_CRASHDUMP_H */