treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 332
[linux-block.git] / fs / pstore / inode.c
CommitLineData
ca01d6dd
TL
1/*
2 * Persistent Storage - ramfs parts.
3 *
4 * Copyright (C) 2010 Intel Corporation <tony.luck@intel.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 */
19
20#include <linux/module.h>
21#include <linux/fs.h>
22#include <linux/fsnotify.h>
23#include <linux/pagemap.h>
24#include <linux/highmem.h>
25#include <linux/time.h>
26#include <linux/init.h>
6dda9266 27#include <linux/list.h>
ca01d6dd
TL
28#include <linux/string.h>
29#include <linux/mount.h>
060287b8 30#include <linux/seq_file.h>
ca01d6dd 31#include <linux/ramfs.h>
366f7e7a 32#include <linux/parser.h>
ca01d6dd
TL
33#include <linux/sched.h>
34#include <linux/magic.h>
35#include <linux/pstore.h>
36#include <linux/slab.h>
6dda9266 37#include <linux/spinlock.h>
ca01d6dd
TL
38#include <linux/uaccess.h>
39
40#include "internal.h"
41
42#define PSTORE_NAMELEN 64
43
6dda9266
LT
44static DEFINE_SPINLOCK(allpstore_lock);
45static LIST_HEAD(allpstore);
46
ca01d6dd 47struct pstore_private {
6dda9266 48 struct list_head list;
83f70f07
KC
49 struct pstore_record *record;
50 size_t total_size;
ca01d6dd
TL
51};
52
060287b8
AV
53struct pstore_ftrace_seq_data {
54 const void *ptr;
55 size_t off;
56 size_t size;
57};
58
59#define REC_SIZE sizeof(struct pstore_ftrace_record)
60
1dfff7dd
KC
61static void free_pstore_private(struct pstore_private *private)
62{
63 if (!private)
64 return;
83f70f07
KC
65 if (private->record) {
66 kfree(private->record->buf);
67 kfree(private->record);
68 }
1dfff7dd
KC
69 kfree(private);
70}
71
060287b8
AV
72static void *pstore_ftrace_seq_start(struct seq_file *s, loff_t *pos)
73{
74 struct pstore_private *ps = s->private;
75 struct pstore_ftrace_seq_data *data;
76
77 data = kzalloc(sizeof(*data), GFP_KERNEL);
78 if (!data)
79 return NULL;
80
83f70f07 81 data->off = ps->total_size % REC_SIZE;
060287b8 82 data->off += *pos * REC_SIZE;
83f70f07 83 if (data->off + REC_SIZE > ps->total_size) {
060287b8
AV
84 kfree(data);
85 return NULL;
86 }
87
88 return data;
89
90}
91
92static void pstore_ftrace_seq_stop(struct seq_file *s, void *v)
93{
94 kfree(v);
95}
96
97static void *pstore_ftrace_seq_next(struct seq_file *s, void *v, loff_t *pos)
98{
99 struct pstore_private *ps = s->private;
100 struct pstore_ftrace_seq_data *data = v;
101
102 data->off += REC_SIZE;
83f70f07 103 if (data->off + REC_SIZE > ps->total_size)
060287b8
AV
104 return NULL;
105
106 (*pos)++;
107 return data;
108}
109
110static int pstore_ftrace_seq_show(struct seq_file *s, void *v)
111{
112 struct pstore_private *ps = s->private;
113 struct pstore_ftrace_seq_data *data = v;
83f70f07
KC
114 struct pstore_ftrace_record *rec;
115
116 rec = (struct pstore_ftrace_record *)(ps->record->buf + data->off);
060287b8 117
d75f773c 118 seq_printf(s, "CPU:%d ts:%llu %08lx %08lx %ps <- %pS\n",
fbccdeb8
JF
119 pstore_ftrace_decode_cpu(rec),
120 pstore_ftrace_read_timestamp(rec),
121 rec->ip, rec->parent_ip, (void *)rec->ip,
122 (void *)rec->parent_ip);
060287b8
AV
123
124 return 0;
125}
126
127static const struct seq_operations pstore_ftrace_seq_ops = {
128 .start = pstore_ftrace_seq_start,
129 .next = pstore_ftrace_seq_next,
130 .stop = pstore_ftrace_seq_stop,
131 .show = pstore_ftrace_seq_show,
132};
133
fbe0aa1f
TL
134static ssize_t pstore_file_read(struct file *file, char __user *userbuf,
135 size_t count, loff_t *ppos)
136{
060287b8
AV
137 struct seq_file *sf = file->private_data;
138 struct pstore_private *ps = sf->private;
fbe0aa1f 139
83f70f07 140 if (ps->record->type == PSTORE_TYPE_FTRACE)
060287b8 141 return seq_read(file, userbuf, count, ppos);
83f70f07
KC
142 return simple_read_from_buffer(userbuf, count, ppos,
143 ps->record->buf, ps->total_size);
fbe0aa1f
TL
144}
145
060287b8
AV
146static int pstore_file_open(struct inode *inode, struct file *file)
147{
148 struct pstore_private *ps = inode->i_private;
149 struct seq_file *sf;
150 int err;
151 const struct seq_operations *sops = NULL;
152
83f70f07 153 if (ps->record->type == PSTORE_TYPE_FTRACE)
060287b8
AV
154 sops = &pstore_ftrace_seq_ops;
155
156 err = seq_open(file, sops);
157 if (err < 0)
158 return err;
159
160 sf = file->private_data;
161 sf->private = ps;
162
163 return 0;
164}
165
965c8e59 166static loff_t pstore_file_llseek(struct file *file, loff_t off, int whence)
060287b8
AV
167{
168 struct seq_file *sf = file->private_data;
169
170 if (sf->op)
965c8e59
AM
171 return seq_lseek(file, off, whence);
172 return default_llseek(file, off, whence);
060287b8
AV
173}
174
fbe0aa1f 175static const struct file_operations pstore_file_operations = {
060287b8
AV
176 .open = pstore_file_open,
177 .read = pstore_file_read,
178 .llseek = pstore_file_llseek,
179 .release = seq_release,
fbe0aa1f 180};
ca01d6dd
TL
181
182/*
183 * When a file is unlinked from our file system we call the
184 * platform driver to erase the record from persistent store.
185 */
186static int pstore_unlink(struct inode *dir, struct dentry *dentry)
187{
2b0143b5 188 struct pstore_private *p = d_inode(dentry)->i_private;
83f70f07 189 struct pstore_record *record = p->record;
ca01d6dd 190
a61072aa 191 if (!record->psi->erase)
bf288333 192 return -EPERM;
a61072aa
KC
193
194 mutex_lock(&record->psi->read_mutex);
195 record->psi->erase(record);
196 mutex_unlock(&record->psi->read_mutex);
ca01d6dd
TL
197
198 return simple_unlink(dir, dentry);
199}
200
a872d510
TL
201static void pstore_evict_inode(struct inode *inode)
202{
6dda9266
LT
203 struct pstore_private *p = inode->i_private;
204 unsigned long flags;
205
dbd5768f 206 clear_inode(inode);
6dda9266
LT
207 if (p) {
208 spin_lock_irqsave(&allpstore_lock, flags);
209 list_del(&p->list);
210 spin_unlock_irqrestore(&allpstore_lock, flags);
1dfff7dd 211 free_pstore_private(p);
6dda9266 212 }
a872d510
TL
213}
214
ca01d6dd
TL
215static const struct inode_operations pstore_dir_inode_operations = {
216 .lookup = simple_lookup,
217 .unlink = pstore_unlink,
218};
219
22a71c30 220static struct inode *pstore_get_inode(struct super_block *sb)
fbe0aa1f
TL
221{
222 struct inode *inode = new_inode(sb);
fbe0aa1f
TL
223 if (inode) {
224 inode->i_ino = get_next_ino();
078cd827 225 inode->i_atime = inode->i_mtime = inode->i_ctime = current_time(inode);
fbe0aa1f
TL
226 }
227 return inode;
228}
229
366f7e7a
LT
230enum {
231 Opt_kmsg_bytes, Opt_err
232};
233
234static const match_table_t tokens = {
235 {Opt_kmsg_bytes, "kmsg_bytes=%u"},
236 {Opt_err, NULL}
237};
238
239static void parse_options(char *options)
240{
241 char *p;
242 substring_t args[MAX_OPT_ARGS];
243 int option;
244
245 if (!options)
246 return;
247
248 while ((p = strsep(&options, ",")) != NULL) {
249 int token;
250
251 if (!*p)
252 continue;
253
254 token = match_token(p, tokens, args);
255 switch (token) {
256 case Opt_kmsg_bytes:
257 if (!match_int(&args[0], &option))
258 pstore_set_kmsg_bytes(option);
259 break;
260 }
261 }
262}
263
349d7438
DH
264/*
265 * Display the mount options in /proc/mounts.
266 */
267static int pstore_show_options(struct seq_file *m, struct dentry *root)
268{
269 if (kmsg_bytes != PSTORE_DEFAULT_KMSG_BYTES)
270 seq_printf(m, ",kmsg_bytes=%lu", kmsg_bytes);
271 return 0;
272}
273
366f7e7a
LT
274static int pstore_remount(struct super_block *sb, int *flags, char *data)
275{
02b9984d 276 sync_filesystem(sb);
366f7e7a
LT
277 parse_options(data);
278
279 return 0;
280}
281
ca01d6dd
TL
282static const struct super_operations pstore_ops = {
283 .statfs = simple_statfs,
284 .drop_inode = generic_delete_inode,
a872d510 285 .evict_inode = pstore_evict_inode,
366f7e7a 286 .remount_fs = pstore_remount,
349d7438 287 .show_options = pstore_show_options,
ca01d6dd
TL
288};
289
290static struct super_block *pstore_sb;
ca01d6dd 291
7e26e9ff 292bool pstore_is_mounted(void)
ca01d6dd 293{
fbe0aa1f 294 return pstore_sb != NULL;
ca01d6dd
TL
295}
296
297/*
298 * Make a regular file in the root directory of our file system.
299 * Load it up with "size" bytes of data from "buf".
300 * Set the mtime & ctime to the date that this record was originally stored.
301 */
3a7d2fd1 302int pstore_mkfile(struct dentry *root, struct pstore_record *record)
ca01d6dd 303{
ca01d6dd
TL
304 struct dentry *dentry;
305 struct inode *inode;
6dda9266 306 int rc = 0;
ca01d6dd 307 char name[PSTORE_NAMELEN];
6dda9266
LT
308 struct pstore_private *private, *pos;
309 unsigned long flags;
1edd1aa3 310 size_t size = record->size + record->ecc_notice_size;
6dda9266 311
3a7d2fd1
KC
312 WARN_ON(!inode_is_locked(d_inode(root)));
313
6dda9266
LT
314 spin_lock_irqsave(&allpstore_lock, flags);
315 list_for_each_entry(pos, &allpstore, list) {
83f70f07
KC
316 if (pos->record->type == record->type &&
317 pos->record->id == record->id &&
318 pos->record->psi == record->psi) {
6dda9266
LT
319 rc = -EEXIST;
320 break;
321 }
322 }
323 spin_unlock_irqrestore(&allpstore_lock, flags);
324 if (rc)
325 return rc;
ca01d6dd
TL
326
327 rc = -ENOMEM;
3a7d2fd1 328 inode = pstore_get_inode(root->d_sb);
ca01d6dd
TL
329 if (!inode)
330 goto fail;
22a71c30
AV
331 inode->i_mode = S_IFREG | 0444;
332 inode->i_fop = &pstore_file_operations;
1dfff7dd 333 private = kzalloc(sizeof(*private), GFP_KERNEL);
ca01d6dd
TL
334 if (!private)
335 goto fail_alloc;
83f70f07 336 private->record = record;
ca01d6dd 337
f0f23e54
JFG
338 scnprintf(name, sizeof(name), "%s-%s-%llu%s",
339 pstore_type_to_name(record->type),
340 record->psi->name, record->id,
341 record->compressed ? ".enc.z" : "");
ca01d6dd 342
ca01d6dd 343 dentry = d_alloc_name(root, name);
c39524e6 344 if (!dentry)
3a7d2fd1 345 goto fail_private;
ca01d6dd 346
83f70f07 347 inode->i_size = private->total_size = size;
ca01d6dd
TL
348
349 inode->i_private = private;
350
1edd1aa3
KC
351 if (record->time.tv_sec)
352 inode->i_mtime = inode->i_ctime = record->time;
ca01d6dd 353
fbe0aa1f 354 d_add(dentry, inode);
ca01d6dd 355
6dda9266
LT
356 spin_lock_irqsave(&allpstore_lock, flags);
357 list_add(&private->list, &allpstore);
358 spin_unlock_irqrestore(&allpstore_lock, flags);
359
fbe0aa1f 360 return 0;
ca01d6dd 361
3a7d2fd1 362fail_private:
1dfff7dd 363 free_pstore_private(private);
ca01d6dd
TL
364fail_alloc:
365 iput(inode);
366
367fail:
368 return rc;
369}
370
3a7d2fd1
KC
371/*
372 * Read all the records from the persistent store. Create
373 * files in our filesystem. Don't warn about -EEXIST errors
374 * when we are re-scanning the backing store looking to add new
375 * error records.
376 */
377void pstore_get_records(int quiet)
378{
379 struct pstore_info *psi = psinfo;
380 struct dentry *root;
381
382 if (!psi || !pstore_sb)
383 return;
384
385 root = pstore_sb->s_root;
386
387 inode_lock(d_inode(root));
388 pstore_get_backend_records(psi, root, quiet);
389 inode_unlock(d_inode(root));
390}
391
364ed2f4 392static int pstore_fill_super(struct super_block *sb, void *data, int silent)
ca01d6dd 393{
318ceed0 394 struct inode *inode;
ca01d6dd 395
ca01d6dd
TL
396 pstore_sb = sb;
397
398 sb->s_maxbytes = MAX_LFS_FILESIZE;
09cbfeaf
KS
399 sb->s_blocksize = PAGE_SIZE;
400 sb->s_blocksize_bits = PAGE_SHIFT;
ca01d6dd
TL
401 sb->s_magic = PSTOREFS_MAGIC;
402 sb->s_op = &pstore_ops;
403 sb->s_time_gran = 1;
404
366f7e7a
LT
405 parse_options(data);
406
22a71c30 407 inode = pstore_get_inode(sb);
318ceed0 408 if (inode) {
d7caa336 409 inode->i_mode = S_IFDIR | 0750;
318ceed0 410 inode->i_op = &pstore_dir_inode_operations;
22a71c30
AV
411 inode->i_fop = &simple_dir_operations;
412 inc_nlink(inode);
ca01d6dd 413 }
318ceed0
AV
414 sb->s_root = d_make_root(inode);
415 if (!sb->s_root)
416 return -ENOMEM;
ca01d6dd 417
6dda9266 418 pstore_get_records(0);
ca01d6dd
TL
419
420 return 0;
ca01d6dd
TL
421}
422
fbe0aa1f
TL
423static struct dentry *pstore_mount(struct file_system_type *fs_type,
424 int flags, const char *dev_name, void *data)
ca01d6dd 425{
fbe0aa1f 426 return mount_single(fs_type, flags, data, pstore_fill_super);
ca01d6dd
TL
427}
428
429static void pstore_kill_sb(struct super_block *sb)
430{
431 kill_litter_super(sb);
432 pstore_sb = NULL;
ca01d6dd
TL
433}
434
435static struct file_system_type pstore_fs_type = {
ee1d2674 436 .owner = THIS_MODULE,
ca01d6dd 437 .name = "pstore",
fbe0aa1f 438 .mount = pstore_mount,
ca01d6dd
TL
439 .kill_sb = pstore_kill_sb,
440};
441
cb095afd 442int __init pstore_init_fs(void)
ca01d6dd 443{
f9bb4882 444 int err;
fb0af3f2
JB
445
446 /* Create a convenient mount point for people to access pstore */
f9bb4882
EB
447 err = sysfs_create_mount_point(fs_kobj, "pstore");
448 if (err)
fb0af3f2 449 goto out;
fb0af3f2
JB
450
451 err = register_filesystem(&pstore_fs_type);
452 if (err < 0)
f9bb4882 453 sysfs_remove_mount_point(fs_kobj, "pstore");
fb0af3f2
JB
454
455out:
456 return err;
ca01d6dd 457}
ca01d6dd 458
cb095afd 459void __exit pstore_exit_fs(void)
ee1d2674
GT
460{
461 unregister_filesystem(&pstore_fs_type);
462 sysfs_remove_mount_point(fs_kobj, "pstore");
463}