2019-05-30 02:57:47 +03:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0-only */
|
2010-12-29 01:25:21 +03:00
|
|
|
/*
|
|
|
|
* Persistent Storage - pstore.h
|
|
|
|
*
|
|
|
|
* Copyright (C) 2010 Intel Corporation <tony.luck@intel.com>
|
|
|
|
*
|
|
|
|
* This code is the generic layer to export data records from platform
|
|
|
|
* level persistent storage via a file system.
|
|
|
|
*/
|
|
|
|
#ifndef _LINUX_PSTORE_H
|
|
|
|
#define _LINUX_PSTORE_H
|
|
|
|
|
2016-09-01 18:13:46 +03:00
|
|
|
#include <linux/compiler.h>
|
|
|
|
#include <linux/errno.h>
|
2011-11-18 01:13:29 +04:00
|
|
|
#include <linux/kmsg_dump.h>
|
2012-07-17 22:37:07 +04:00
|
|
|
#include <linux/mutex.h>
|
2022-03-14 21:59:53 +03:00
|
|
|
#include <linux/spinlock.h>
|
2016-09-01 18:13:46 +03:00
|
|
|
#include <linux/time.h>
|
|
|
|
#include <linux/types.h>
|
2011-11-18 01:13:29 +04:00
|
|
|
|
2017-03-04 03:59:29 +03:00
|
|
|
struct module;
|
|
|
|
|
2018-11-04 02:38:16 +03:00
|
|
|
/*
|
|
|
|
* pstore record types (see fs/pstore/platform.c for pstore_type_names[])
|
|
|
|
* These values may be written to storage (see EFI vars backend), so
|
|
|
|
* they are kind of an ABI. Be careful changing the mappings.
|
|
|
|
*/
|
2010-12-29 01:25:21 +03:00
|
|
|
enum pstore_type_id {
|
2018-11-04 02:38:16 +03:00
|
|
|
/* Frontend storage types */
|
2010-12-29 01:25:21 +03:00
|
|
|
PSTORE_TYPE_DMESG = 0,
|
|
|
|
PSTORE_TYPE_MCE = 1,
|
2012-05-26 17:20:19 +04:00
|
|
|
PSTORE_TYPE_CONSOLE = 2,
|
2012-07-10 04:10:41 +04:00
|
|
|
PSTORE_TYPE_FTRACE = 3,
|
2018-11-04 02:38:16 +03:00
|
|
|
|
|
|
|
/* PPC64-specific partition types */
|
2013-06-05 22:51:44 +04:00
|
|
|
PSTORE_TYPE_PPC_RTAS = 4,
|
2013-06-05 22:52:10 +04:00
|
|
|
PSTORE_TYPE_PPC_OF = 5,
|
2013-06-05 22:52:20 +04:00
|
|
|
PSTORE_TYPE_PPC_COMMON = 6,
|
2015-01-17 03:01:10 +03:00
|
|
|
PSTORE_TYPE_PMSG = 7,
|
2015-02-05 22:36:28 +03:00
|
|
|
PSTORE_TYPE_PPC_OPAL = 8,
|
2018-11-04 02:38:16 +03:00
|
|
|
|
|
|
|
/* End of the list */
|
|
|
|
PSTORE_TYPE_MAX
|
2010-12-29 01:25:21 +03:00
|
|
|
};
|
|
|
|
|
2018-11-04 02:38:16 +03:00
|
|
|
const char *pstore_type_to_name(enum pstore_type_id type);
|
|
|
|
enum pstore_type_id pstore_name_to_type(const char *name);
|
|
|
|
|
2017-03-04 03:59:29 +03:00
|
|
|
struct pstore_info;
|
|
|
|
/**
|
|
|
|
* struct pstore_record - details of a pstore record entry
|
|
|
|
* @psi: pstore backend driver information
|
|
|
|
* @type: pstore record type
|
|
|
|
* @id: per-type unique identifier for record
|
|
|
|
* @time: timestamp of the record
|
|
|
|
* @buf: pointer to record contents
|
|
|
|
* @size: size of @buf
|
|
|
|
* @ecc_notice_size:
|
|
|
|
* ECC information for @buf
|
2017-03-04 10:28:53 +03:00
|
|
|
*
|
|
|
|
* Valid for PSTORE_TYPE_DMESG @type:
|
|
|
|
*
|
|
|
|
* @count: Oops count since boot
|
|
|
|
* @reason: kdump reason for notification
|
|
|
|
* @part: position in a multipart record
|
|
|
|
* @compressed: whether the buffer is compressed
|
|
|
|
*
|
2017-03-04 03:59:29 +03:00
|
|
|
*/
|
|
|
|
struct pstore_record {
|
|
|
|
struct pstore_info *psi;
|
|
|
|
enum pstore_type_id type;
|
|
|
|
u64 id;
|
2018-05-15 01:50:52 +03:00
|
|
|
struct timespec64 time;
|
2017-03-04 03:59:29 +03:00
|
|
|
char *buf;
|
|
|
|
ssize_t size;
|
|
|
|
ssize_t ecc_notice_size;
|
2017-03-04 10:28:53 +03:00
|
|
|
|
|
|
|
int count;
|
|
|
|
enum kmsg_dump_reason reason;
|
|
|
|
unsigned int part;
|
|
|
|
bool compressed;
|
2017-03-04 03:59:29 +03:00
|
|
|
};
|
2012-07-17 22:37:07 +04:00
|
|
|
|
2017-03-03 23:16:16 +03:00
|
|
|
/**
|
|
|
|
* struct pstore_info - backend pstore driver structure
|
|
|
|
*
|
2018-11-02 00:03:07 +03:00
|
|
|
* @owner: module which is responsible for this backend driver
|
2017-03-03 23:16:16 +03:00
|
|
|
* @name: name of the backend driver
|
|
|
|
*
|
2022-03-14 21:59:53 +03:00
|
|
|
* @buf_lock: spinlock to serialize access to @buf
|
2017-03-03 23:16:16 +03:00
|
|
|
* @buf: preallocated crash dump buffer
|
2018-11-02 02:17:22 +03:00
|
|
|
* @bufsize: size of @buf available for crash dump bytes (must match
|
|
|
|
* smallest number of bytes available for writing to a
|
|
|
|
* backend entry, since compressed bytes don't take kindly
|
|
|
|
* to being truncated)
|
2017-03-03 23:16:16 +03:00
|
|
|
*
|
|
|
|
* @read_mutex: serializes @open, @read, @close, and @erase callbacks
|
|
|
|
* @flags: bitfield of frontends the backend can accept writes for
|
2020-05-05 18:45:07 +03:00
|
|
|
* @max_reason: Used when PSTORE_FLAGS_DMESG is set. Contains the
|
|
|
|
* kmsg_dump_reason enum value. KMSG_DUMP_UNDEF means
|
|
|
|
* "use existing kmsg_dump() filtering, based on the
|
|
|
|
* printk.always_kmsg_dump boot param" (which is either
|
|
|
|
* KMSG_DUMP_OOPS when false, or KMSG_DUMP_MAX when
|
|
|
|
* true); see printk.always_kmsg_dump for more details.
|
2017-03-03 23:16:16 +03:00
|
|
|
* @data: backend-private pointer passed back during callbacks
|
|
|
|
*
|
|
|
|
* Callbacks:
|
|
|
|
*
|
|
|
|
* @open:
|
|
|
|
* Notify backend that pstore is starting a full read of backend
|
|
|
|
* records. Followed by one or more @read calls, and a final @close.
|
|
|
|
*
|
|
|
|
* @psi: in: pointer to the struct pstore_info for the backend
|
|
|
|
*
|
|
|
|
* Returns 0 on success, and non-zero on error.
|
|
|
|
*
|
|
|
|
* @close:
|
|
|
|
* Notify backend that pstore has finished a full read of backend
|
|
|
|
* records. Always preceded by an @open call and one or more @read
|
|
|
|
* calls.
|
|
|
|
*
|
|
|
|
* @psi: in: pointer to the struct pstore_info for the backend
|
|
|
|
*
|
|
|
|
* Returns 0 on success, and non-zero on error. (Though pstore will
|
|
|
|
* ignore the error.)
|
|
|
|
*
|
|
|
|
* @read:
|
|
|
|
* Read next available backend record. Called after a successful
|
|
|
|
* @open.
|
|
|
|
*
|
2017-03-04 09:09:18 +03:00
|
|
|
* @record:
|
|
|
|
* pointer to record to populate. @buf should be allocated
|
|
|
|
* by the backend and filled. At least @type and @id should
|
|
|
|
* be populated, since these are used when creating pstorefs
|
|
|
|
* file names.
|
2017-03-03 23:16:16 +03:00
|
|
|
*
|
|
|
|
* Returns record size on success, zero when no more records are
|
|
|
|
* available, or negative on error.
|
|
|
|
*
|
|
|
|
* @write:
|
2017-03-06 09:41:10 +03:00
|
|
|
* A newly generated record needs to be written to backend storage.
|
2017-03-03 23:16:16 +03:00
|
|
|
*
|
2017-03-04 10:28:53 +03:00
|
|
|
* @record:
|
2017-03-06 09:41:10 +03:00
|
|
|
* pointer to record metadata. When @type is PSTORE_TYPE_DMESG,
|
|
|
|
* @buf will be pointing to the preallocated @psi.buf, since
|
|
|
|
* memory allocation may be broken during an Oops. Regardless,
|
|
|
|
* @buf must be proccesed or copied before returning. The
|
|
|
|
* backend is also expected to write @id with something that
|
2017-05-20 01:29:10 +03:00
|
|
|
* can help identify this record to a future @erase callback.
|
|
|
|
* The @time field will be prepopulated with the current time,
|
|
|
|
* when available. The @size field will have the size of data
|
|
|
|
* in @buf.
|
2017-03-03 23:16:16 +03:00
|
|
|
*
|
|
|
|
* Returns 0 on success, and non-zero on error.
|
|
|
|
*
|
2017-03-06 09:41:10 +03:00
|
|
|
* @write_user:
|
2017-03-03 23:16:16 +03:00
|
|
|
* Perform a frontend write to a backend record, using a specified
|
2017-03-05 11:56:38 +03:00
|
|
|
* buffer that is coming directly from userspace, instead of the
|
|
|
|
* @record @buf.
|
|
|
|
*
|
|
|
|
* @record: pointer to record metadata.
|
|
|
|
* @buf: pointer to userspace contents to write to backend
|
2017-03-03 23:16:16 +03:00
|
|
|
*
|
|
|
|
* Returns 0 on success, and non-zero on error.
|
|
|
|
*
|
|
|
|
* @erase:
|
|
|
|
* Delete a record from backend storage. Different backends
|
2017-03-05 10:31:19 +03:00
|
|
|
* identify records differently, so entire original record is
|
|
|
|
* passed back to assist in identification of what the backend
|
|
|
|
* should remove from storage.
|
2017-03-03 23:16:16 +03:00
|
|
|
*
|
2017-03-05 10:31:19 +03:00
|
|
|
* @record: pointer to record metadata.
|
2017-03-03 23:16:16 +03:00
|
|
|
*
|
|
|
|
* Returns 0 on success, and non-zero on error.
|
|
|
|
*
|
|
|
|
*/
|
2010-12-29 01:25:21 +03:00
|
|
|
struct pstore_info {
|
|
|
|
struct module *owner;
|
2020-05-08 19:16:02 +03:00
|
|
|
const char *name;
|
2017-03-03 23:16:16 +03:00
|
|
|
|
2022-03-14 21:59:53 +03:00
|
|
|
spinlock_t buf_lock;
|
2010-12-29 01:25:21 +03:00
|
|
|
char *buf;
|
|
|
|
size_t bufsize;
|
2017-03-03 23:16:16 +03:00
|
|
|
|
|
|
|
struct mutex read_mutex;
|
|
|
|
|
2013-12-19 03:17:10 +04:00
|
|
|
int flags;
|
2020-05-05 18:45:07 +03:00
|
|
|
int max_reason;
|
2017-03-03 23:16:16 +03:00
|
|
|
void *data;
|
|
|
|
|
2011-05-16 22:00:27 +04:00
|
|
|
int (*open)(struct pstore_info *psi);
|
|
|
|
int (*close)(struct pstore_info *psi);
|
2017-03-04 09:09:18 +03:00
|
|
|
ssize_t (*read)(struct pstore_record *record);
|
2017-03-04 10:28:53 +03:00
|
|
|
int (*write)(struct pstore_record *record);
|
2017-03-06 09:41:10 +03:00
|
|
|
int (*write_user)(struct pstore_record *record,
|
|
|
|
const char __user *buf);
|
2017-03-05 10:31:19 +03:00
|
|
|
int (*erase)(struct pstore_record *record);
|
2010-12-29 01:25:21 +03:00
|
|
|
};
|
|
|
|
|
2017-03-03 23:16:16 +03:00
|
|
|
/* Supported frontends */
|
2018-11-02 01:30:05 +03:00
|
|
|
#define PSTORE_FLAGS_DMESG BIT(0)
|
|
|
|
#define PSTORE_FLAGS_CONSOLE BIT(1)
|
|
|
|
#define PSTORE_FLAGS_FTRACE BIT(2)
|
|
|
|
#define PSTORE_FLAGS_PMSG BIT(3)
|
2016-07-27 18:08:25 +03:00
|
|
|
|
2010-12-29 01:25:21 +03:00
|
|
|
extern int pstore_register(struct pstore_info *);
|
2015-10-20 10:39:03 +03:00
|
|
|
extern void pstore_unregister(struct pstore_info *);
|
2010-12-29 01:25:21 +03:00
|
|
|
|
2016-10-20 10:34:05 +03:00
|
|
|
struct pstore_ftrace_record {
|
|
|
|
unsigned long ip;
|
|
|
|
unsigned long parent_ip;
|
|
|
|
u64 ts;
|
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
* ftrace related stuff: Both backends and frontends need these so expose
|
|
|
|
* them here.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#if NR_CPUS <= 2 && defined(CONFIG_ARM_THUMB)
|
|
|
|
#define PSTORE_CPU_IN_IP 0x1
|
|
|
|
#elif NR_CPUS <= 4 && defined(CONFIG_ARM)
|
|
|
|
#define PSTORE_CPU_IN_IP 0x3
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#define TS_CPU_SHIFT 8
|
|
|
|
#define TS_CPU_MASK (BIT(TS_CPU_SHIFT) - 1)
|
|
|
|
|
|
|
|
/*
|
|
|
|
* If CPU number can be stored in IP, store it there, otherwise store it in
|
|
|
|
* the time stamp. This means more timestamp resolution is available when
|
|
|
|
* the CPU can be stored in the IP.
|
|
|
|
*/
|
|
|
|
#ifdef PSTORE_CPU_IN_IP
|
|
|
|
static inline void
|
|
|
|
pstore_ftrace_encode_cpu(struct pstore_ftrace_record *rec, unsigned int cpu)
|
|
|
|
{
|
|
|
|
rec->ip |= cpu;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline unsigned int
|
|
|
|
pstore_ftrace_decode_cpu(struct pstore_ftrace_record *rec)
|
|
|
|
{
|
|
|
|
return rec->ip & PSTORE_CPU_IN_IP;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline u64
|
|
|
|
pstore_ftrace_read_timestamp(struct pstore_ftrace_record *rec)
|
|
|
|
{
|
|
|
|
return rec->ts;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void
|
|
|
|
pstore_ftrace_write_timestamp(struct pstore_ftrace_record *rec, u64 val)
|
|
|
|
{
|
|
|
|
rec->ts = val;
|
|
|
|
}
|
|
|
|
#else
|
|
|
|
static inline void
|
|
|
|
pstore_ftrace_encode_cpu(struct pstore_ftrace_record *rec, unsigned int cpu)
|
|
|
|
{
|
|
|
|
rec->ts &= ~(TS_CPU_MASK);
|
|
|
|
rec->ts |= cpu;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline unsigned int
|
|
|
|
pstore_ftrace_decode_cpu(struct pstore_ftrace_record *rec)
|
|
|
|
{
|
|
|
|
return rec->ts & TS_CPU_MASK;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline u64
|
|
|
|
pstore_ftrace_read_timestamp(struct pstore_ftrace_record *rec)
|
|
|
|
{
|
|
|
|
return rec->ts >> TS_CPU_SHIFT;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void
|
|
|
|
pstore_ftrace_write_timestamp(struct pstore_ftrace_record *rec, u64 val)
|
|
|
|
{
|
|
|
|
rec->ts = (rec->ts & TS_CPU_MASK) | (val << TS_CPU_SHIFT);
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2010-12-29 01:25:21 +03:00
|
|
|
#endif /*_LINUX_PSTORE_H*/
|