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