pstore: Avoid deadlock in panic and emergency-restart path
[opensuse:kernel.git] / include / linux / pstore.h
1 /*
2  * Persistent Storage - pstore.h
3  *
4  * Copyright (C) 2010 Intel Corporation <tony.luck@intel.com>
5  *
6  * This code is the generic layer to export data records from platform
7  * level persistent storage via a file system.
8  *
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.
12  *
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.
17  *
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
21  */
22 #ifndef _LINUX_PSTORE_H
23 #define _LINUX_PSTORE_H
24
25 #include <linux/time.h>
26 #include <linux/kmsg_dump.h>
27 #include <linux/mutex.h>
28 #include <linux/types.h>
29 #include <linux/spinlock.h>
30 #include <linux/errno.h>
31
32 /* types */
33 enum pstore_type_id {
34         PSTORE_TYPE_DMESG       = 0,
35         PSTORE_TYPE_MCE         = 1,
36         PSTORE_TYPE_CONSOLE     = 2,
37         PSTORE_TYPE_FTRACE      = 3,
38         PSTORE_TYPE_UNKNOWN     = 255
39 };
40
41 struct module;
42
43 struct pstore_info {
44         struct module   *owner;
45         char            *name;
46         spinlock_t      buf_lock;       /* serialize access to 'buf' */
47         char            *buf;
48         size_t          bufsize;
49         struct mutex    read_mutex;     /* serialize open/read/close */
50         int             (*open)(struct pstore_info *psi);
51         int             (*close)(struct pstore_info *psi);
52         ssize_t         (*read)(u64 *id, enum pstore_type_id *type,
53                         int *count, struct timespec *time, char **buf,
54                         struct pstore_info *psi);
55         int             (*write)(enum pstore_type_id type,
56                         enum kmsg_dump_reason reason, u64 *id,
57                         unsigned int part, int count, size_t size,
58                         struct pstore_info *psi);
59         int             (*write_buf)(enum pstore_type_id type,
60                         enum kmsg_dump_reason reason, u64 *id,
61                         unsigned int part, const char *buf, size_t size,
62                         struct pstore_info *psi);
63         int             (*erase)(enum pstore_type_id type, u64 id,
64                         int count, struct timespec time,
65                         struct pstore_info *psi);
66         void            *data;
67 };
68
69 #ifdef CONFIG_PSTORE
70 extern int pstore_register(struct pstore_info *);
71 extern bool pstore_cannot_block_path(enum kmsg_dump_reason reason);
72 #else
73 static inline int
74 pstore_register(struct pstore_info *psi)
75 {
76         return -ENODEV;
77 }
78 static inline bool
79 pstore_cannot_block_path(enum kmsg_dump_reason reason)
80 {
81         return false;
82 }
83 #endif
84
85 #endif /*_LINUX_PSTORE_H*/