2 * Persistent Storage - pstore.h
4 * Copyright (C) 2010 Intel Corporation <tony.luck@intel.com>
6 * This code is the generic layer to export data records from platform
7 * level persistent storage via a file system.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #ifndef _LINUX_PSTORE_H
23 #define _LINUX_PSTORE_H
25 #include <linux/compiler.h>
26 #include <linux/errno.h>
27 #include <linux/kmsg_dump.h>
28 #include <linux/mutex.h>
29 #include <linux/spinlock.h>
30 #include <linux/time.h>
31 #include <linux/types.h>
35 /* pstore record types (see fs/pstore/inode.c for filename templates) */
37 PSTORE_TYPE_DMESG = 0,
39 PSTORE_TYPE_CONSOLE = 2,
40 PSTORE_TYPE_FTRACE = 3,
41 /* PPC64 partition types */
42 PSTORE_TYPE_PPC_RTAS = 4,
43 PSTORE_TYPE_PPC_OF = 5,
44 PSTORE_TYPE_PPC_COMMON = 6,
46 PSTORE_TYPE_PPC_OPAL = 8,
47 PSTORE_TYPE_UNKNOWN = 255
52 * struct pstore_record - details of a pstore record entry
53 * @psi: pstore backend driver information
54 * @type: pstore record type
55 * @id: per-type unique identifier for record
56 * @time: timestamp of the record
57 * @buf: pointer to record contents
60 * ECC information for @buf
62 * Valid for PSTORE_TYPE_DMESG @type:
64 * @count: Oops count since boot
65 * @reason: kdump reason for notification
66 * @part: position in a multipart record
67 * @compressed: whether the buffer is compressed
70 struct pstore_record {
71 struct pstore_info *psi;
72 enum pstore_type_id type;
77 ssize_t ecc_notice_size;
80 enum kmsg_dump_reason reason;
86 * struct pstore_info - backend pstore driver structure
88 * @owner: module which is repsonsible for this backend driver
89 * @name: name of the backend driver
91 * @buf_lock: spinlock to serialize access to @buf
92 * @buf: preallocated crash dump buffer
93 * @bufsize: size of @buf available for crash dump writes
95 * @read_mutex: serializes @open, @read, @close, and @erase callbacks
96 * @flags: bitfield of frontends the backend can accept writes for
97 * @data: backend-private pointer passed back during callbacks
102 * Notify backend that pstore is starting a full read of backend
103 * records. Followed by one or more @read calls, and a final @close.
105 * @psi: in: pointer to the struct pstore_info for the backend
107 * Returns 0 on success, and non-zero on error.
110 * Notify backend that pstore has finished a full read of backend
111 * records. Always preceded by an @open call and one or more @read
114 * @psi: in: pointer to the struct pstore_info for the backend
116 * Returns 0 on success, and non-zero on error. (Though pstore will
120 * Read next available backend record. Called after a successful
124 * pointer to record to populate. @buf should be allocated
125 * by the backend and filled. At least @type and @id should
126 * be populated, since these are used when creating pstorefs
129 * Returns record size on success, zero when no more records are
130 * available, or negative on error.
133 * A newly generated record needs to be written to backend storage.
136 * pointer to record metadata. When @type is PSTORE_TYPE_DMESG,
137 * @buf will be pointing to the preallocated @psi.buf, since
138 * memory allocation may be broken during an Oops. Regardless,
139 * @buf must be proccesed or copied before returning. The
140 * backend is also expected to write @id with something that
141 8 can help identify this record to a future @erase callback.
143 * Returns 0 on success, and non-zero on error.
146 * Perform a frontend write to a backend record, using a specified
147 * buffer that is coming directly from userspace, instead of the
150 * @record: pointer to record metadata.
151 * @buf: pointer to userspace contents to write to backend
153 * Returns 0 on success, and non-zero on error.
156 * Delete a record from backend storage. Different backends
157 * identify records differently, so entire original record is
158 * passed back to assist in identification of what the backend
159 * should remove from storage.
161 * @record: pointer to record metadata.
163 * Returns 0 on success, and non-zero on error.
167 struct module *owner;
174 struct mutex read_mutex;
179 int (*open)(struct pstore_info *psi);
180 int (*close)(struct pstore_info *psi);
181 ssize_t (*read)(struct pstore_record *record);
182 int (*write)(struct pstore_record *record);
183 int (*write_user)(struct pstore_record *record,
184 const char __user *buf);
185 int (*erase)(struct pstore_record *record);
188 /* Supported frontends */
189 #define PSTORE_FLAGS_DMESG (1 << 0)
190 #define PSTORE_FLAGS_CONSOLE (1 << 1)
191 #define PSTORE_FLAGS_FTRACE (1 << 2)
192 #define PSTORE_FLAGS_PMSG (1 << 3)
194 extern int pstore_register(struct pstore_info *);
195 extern void pstore_unregister(struct pstore_info *);
196 extern bool pstore_cannot_block_path(enum kmsg_dump_reason reason);
198 struct pstore_ftrace_record {
200 unsigned long parent_ip;
205 * ftrace related stuff: Both backends and frontends need these so expose
209 #if NR_CPUS <= 2 && defined(CONFIG_ARM_THUMB)
210 #define PSTORE_CPU_IN_IP 0x1
211 #elif NR_CPUS <= 4 && defined(CONFIG_ARM)
212 #define PSTORE_CPU_IN_IP 0x3
215 #define TS_CPU_SHIFT 8
216 #define TS_CPU_MASK (BIT(TS_CPU_SHIFT) - 1)
219 * If CPU number can be stored in IP, store it there, otherwise store it in
220 * the time stamp. This means more timestamp resolution is available when
221 * the CPU can be stored in the IP.
223 #ifdef PSTORE_CPU_IN_IP
225 pstore_ftrace_encode_cpu(struct pstore_ftrace_record *rec, unsigned int cpu)
230 static inline unsigned int
231 pstore_ftrace_decode_cpu(struct pstore_ftrace_record *rec)
233 return rec->ip & PSTORE_CPU_IN_IP;
237 pstore_ftrace_read_timestamp(struct pstore_ftrace_record *rec)
243 pstore_ftrace_write_timestamp(struct pstore_ftrace_record *rec, u64 val)
249 pstore_ftrace_encode_cpu(struct pstore_ftrace_record *rec, unsigned int cpu)
251 rec->ts &= ~(TS_CPU_MASK);
255 static inline unsigned int
256 pstore_ftrace_decode_cpu(struct pstore_ftrace_record *rec)
258 return rec->ts & TS_CPU_MASK;
262 pstore_ftrace_read_timestamp(struct pstore_ftrace_record *rec)
264 return rec->ts >> TS_CPU_SHIFT;
268 pstore_ftrace_write_timestamp(struct pstore_ftrace_record *rec, u64 val)
270 rec->ts = (rec->ts & TS_CPU_MASK) | (val << TS_CPU_SHIFT);
274 #endif /*_LINUX_PSTORE_H*/