pstore.h 7.64 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/*
 * 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.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2 as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
#ifndef _LINUX_PSTORE_H
#define _LINUX_PSTORE_H

Mark Salyzyn's avatar
Mark Salyzyn committed
25 26
#include <linux/compiler.h>
#include <linux/errno.h>
27
#include <linux/kmsg_dump.h>
28 29
#include <linux/mutex.h>
#include <linux/spinlock.h>
Mark Salyzyn's avatar
Mark Salyzyn committed
30 31
#include <linux/time.h>
#include <linux/types.h>
32

33 34
struct module;

35
/* pstore record types (see fs/pstore/inode.c for filename templates) */
36 37 38
enum pstore_type_id {
	PSTORE_TYPE_DMESG	= 0,
	PSTORE_TYPE_MCE		= 1,
39
	PSTORE_TYPE_CONSOLE	= 2,
40
	PSTORE_TYPE_FTRACE	= 3,
41 42
	/* PPC64 partition types */
	PSTORE_TYPE_PPC_RTAS	= 4,
43
	PSTORE_TYPE_PPC_OF	= 5,
44
	PSTORE_TYPE_PPC_COMMON	= 6,
45
	PSTORE_TYPE_PMSG	= 7,
46
	PSTORE_TYPE_PPC_OPAL	= 8,
47 48 49
	PSTORE_TYPE_UNKNOWN	= 255
};

50 51 52 53 54 55 56 57 58 59 60
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
61 62 63 64 65 66 67 68
 *
 * 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
 *
69 70 71 72 73
 */
struct pstore_record {
	struct pstore_info	*psi;
	enum pstore_type_id	type;
	u64			id;
74
	struct timespec64	time;
75 76 77
	char			*buf;
	ssize_t			size;
	ssize_t			ecc_notice_size;
78 79 80 81 82

	int			count;
	enum kmsg_dump_reason	reason;
	unsigned int		part;
	bool			compressed;
83
};
84

85 86 87 88 89 90 91 92
/**
 * struct pstore_info - backend pstore driver structure
 *
 * @owner:	module which is repsonsible for this backend driver
 * @name:	name of the backend driver
 *
 * @buf_lock:	spinlock to serialize access to @buf
 * @buf:	preallocated crash dump buffer
93 94 95 96
 * @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)
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
 *
 * @read_mutex:	serializes @open, @read, @close, and @erase callbacks
 * @flags:	bitfield of frontends the backend can accept writes for
 * @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.
 *
126 127 128 129 130
 *	@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.
131 132 133 134 135
 *
 *	Returns record size on success, zero when no more records are
 *	available, or negative on error.
 *
 * @write:
136
 *	A newly generated record needs to be written to backend storage.
137
 *
138
 *	@record:
139 140 141 142 143
 *		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
144 145 146 147
 *		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.
148 149 150
 *
 *	Returns 0 on success, and non-zero on error.
 *
151
 * @write_user:
152
 *	Perform a frontend write to a backend record, using a specified
153 154 155 156 157
 *	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
158 159 160 161 162
 *
 *	Returns 0 on success, and non-zero on error.
 *
 * @erase:
 *	Delete a record from backend storage.  Different backends
163 164 165
 *	identify records differently, so entire original record is
 *	passed back to assist in identification of what the backend
 *	should remove from storage.
166
 *
167
 *	@record:	pointer to record metadata.
168 169 170 171
 *
 *	Returns 0 on success, and non-zero on error.
 *
 */
172 173 174
struct pstore_info {
	struct module	*owner;
	char		*name;
175 176

	spinlock_t	buf_lock;
177 178
	char		*buf;
	size_t		bufsize;
179 180 181

	struct mutex	read_mutex;

182
	int		flags;
183 184
	void		*data;

185 186
	int		(*open)(struct pstore_info *psi);
	int		(*close)(struct pstore_info *psi);
187
	ssize_t		(*read)(struct pstore_record *record);
188
	int		(*write)(struct pstore_record *record);
189 190
	int		(*write_user)(struct pstore_record *record,
				      const char __user *buf);
191
	int		(*erase)(struct pstore_record *record);
192 193
};

194
/* Supported frontends */
195 196 197 198 199
#define PSTORE_FLAGS_DMESG	(1 << 0)
#define PSTORE_FLAGS_CONSOLE	(1 << 1)
#define PSTORE_FLAGS_FTRACE	(1 << 2)
#define PSTORE_FLAGS_PMSG	(1 << 3)

200
extern int pstore_register(struct pstore_info *);
Geliang Tang's avatar
Geliang Tang committed
201
extern void pstore_unregister(struct pstore_info *);
202
extern bool pstore_cannot_block_path(enum kmsg_dump_reason reason);
203

204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
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

280
#endif /*_LINUX_PSTORE_H*/