Merge branch 'linux-3.10.61' into dev-kernel-3.10
[linux-3.10.git] / fs / pstore / inode.c
1 /*
2  * Persistent Storage - ramfs parts.
3  *
4  * Copyright (C) 2010 Intel Corporation <tony.luck@intel.com>
5  * Copyright (C) 2014 NVIDIA Corporation. All rights reserved.
6  *
7  *  This program is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License version 2 as
9  *  published by the Free Software Foundation.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; if not, write to the Free Software
18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #include <linux/module.h>
22 #include <linux/fs.h>
23 #include <linux/fsnotify.h>
24 #include <linux/pagemap.h>
25 #include <linux/highmem.h>
26 #include <linux/time.h>
27 #include <linux/init.h>
28 #include <linux/list.h>
29 #include <linux/string.h>
30 #include <linux/mount.h>
31 #include <linux/seq_file.h>
32 #include <linux/ramfs.h>
33 #include <linux/parser.h>
34 #include <linux/sched.h>
35 #include <linux/magic.h>
36 #include <linux/pstore.h>
37 #include <linux/slab.h>
38 #include <linux/spinlock.h>
39 #include <linux/uaccess.h>
40
41 #include "internal.h"
42
43 #define PSTORE_NAMELEN  64
44
45 static DEFINE_SPINLOCK(allpstore_lock);
46 static LIST_HEAD(allpstore);
47
48 struct pstore_private {
49         struct list_head list;
50         struct pstore_info *psi;
51         enum pstore_type_id type;
52         u64     id;
53         int     count;
54         ssize_t size;
55         char    data[];
56 };
57
58 struct pstore_ftrace_seq_data {
59         const void *ptr;
60         size_t off;
61         size_t size;
62 };
63
64 #define REC_SIZE sizeof(struct pstore_ftrace_record)
65
66 static void *pstore_ftrace_seq_start(struct seq_file *s, loff_t *pos)
67 {
68         struct pstore_private *ps = s->private;
69         struct pstore_ftrace_seq_data *data;
70
71         data = kzalloc(sizeof(*data), GFP_KERNEL);
72         if (!data)
73                 return NULL;
74
75         data->off = ps->size % REC_SIZE;
76         data->off += *pos * REC_SIZE;
77         if (data->off + REC_SIZE > ps->size) {
78                 kfree(data);
79                 return NULL;
80         }
81
82         return data;
83
84 }
85
86 static void pstore_ftrace_seq_stop(struct seq_file *s, void *v)
87 {
88         kfree(v);
89 }
90
91 static void *pstore_ftrace_seq_next(struct seq_file *s, void *v, loff_t *pos)
92 {
93         struct pstore_private *ps = s->private;
94         struct pstore_ftrace_seq_data *data = v;
95
96         data->off += REC_SIZE;
97         if (data->off + REC_SIZE > ps->size)
98                 return NULL;
99
100         (*pos)++;
101         return data;
102 }
103
104 static int pstore_ftrace_seq_show(struct seq_file *s, void *v)
105 {
106         struct pstore_private *ps = s->private;
107         struct pstore_ftrace_seq_data *data = v;
108         struct pstore_ftrace_record *rec = (void *)(ps->data + data->off);
109
110         seq_printf(s, "%d %08lx  %08lx  %pf <- %pF\n",
111                 pstore_ftrace_decode_cpu(rec), rec->ip, rec->parent_ip,
112                 (void *)rec->ip, (void *)rec->parent_ip);
113
114         return 0;
115 }
116
117 static const struct seq_operations pstore_ftrace_seq_ops = {
118         .start  = pstore_ftrace_seq_start,
119         .next   = pstore_ftrace_seq_next,
120         .stop   = pstore_ftrace_seq_stop,
121         .show   = pstore_ftrace_seq_show,
122 };
123
124 struct pstore_rtrace_seq_data {
125         const void *ptr;
126         size_t off;
127         size_t size;
128 };
129
130 #define RTRACE_REC_SIZE sizeof(struct pstore_rtrace_record)
131
132 static void *pstore_rtrace_seq_start(struct seq_file *s, loff_t *pos)
133 {
134         struct pstore_private *ps = s->private;
135         struct pstore_rtrace_seq_data *data;
136
137         data = kzalloc(sizeof(*data), GFP_KERNEL);
138         if (!data)
139                 return NULL;
140
141         data->off = ps->size % RTRACE_REC_SIZE;
142         data->off += *pos * RTRACE_REC_SIZE;
143         if (data->off + RTRACE_REC_SIZE > ps->size) {
144                 kfree(data);
145                 return NULL;
146         }
147
148         return data;
149
150 }
151
152 static void pstore_rtrace_seq_stop(struct seq_file *s, void *v)
153 {
154         kfree(v);
155 }
156
157 static void *pstore_rtrace_seq_next(struct seq_file *s, void *v, loff_t *pos)
158 {
159         struct pstore_private *ps = s->private;
160         struct pstore_rtrace_seq_data *data = v;
161
162         data->off += RTRACE_REC_SIZE;
163         if (data->off + RTRACE_REC_SIZE > ps->size)
164                 return NULL;
165
166         (*pos)++;
167         return data;
168 }
169
170 static int pstore_rtrace_seq_show(struct seq_file *s, void *v)
171 {
172         struct pstore_private *ps = s->private;
173         struct pstore_rtrace_seq_data *data = v;
174         struct pstore_rtrace_record *rec = (void *)(ps->data + data->off);
175
176         seq_printf(s, "%d %c %p <- %p  %pF\n",
177                 rec->cpu, rec->event == RTRACE_READ ? 'R' : 'W',
178                 rec->raddr, rec->caller, (void *)rec->caller);
179
180         return 0;
181 }
182
183 static const struct seq_operations pstore_rtrace_seq_ops = {
184         .start  = pstore_rtrace_seq_start,
185         .next   = pstore_rtrace_seq_next,
186         .stop   = pstore_rtrace_seq_stop,
187         .show   = pstore_rtrace_seq_show,
188 };
189
190 static ssize_t pstore_file_read(struct file *file, char __user *userbuf,
191                                                 size_t count, loff_t *ppos)
192 {
193         struct seq_file *sf = file->private_data;
194         struct pstore_private *ps = sf->private;
195
196         if (ps->type == PSTORE_TYPE_FTRACE || ps->type == PSTORE_TYPE_RTRACE)
197                 return seq_read(file, userbuf, count, ppos);
198         return simple_read_from_buffer(userbuf, count, ppos, ps->data, ps->size);
199 }
200
201 static int pstore_file_open(struct inode *inode, struct file *file)
202 {
203         struct pstore_private *ps = inode->i_private;
204         struct seq_file *sf;
205         int err;
206         const struct seq_operations *sops = NULL;
207
208         if (ps->type == PSTORE_TYPE_FTRACE)
209                 sops = &pstore_ftrace_seq_ops;
210         else if (ps->type == PSTORE_TYPE_RTRACE)
211                 sops = &pstore_rtrace_seq_ops;
212
213         err = seq_open(file, sops);
214         if (err < 0)
215                 return err;
216
217         sf = file->private_data;
218         sf->private = ps;
219
220         return 0;
221 }
222
223 static loff_t pstore_file_llseek(struct file *file, loff_t off, int whence)
224 {
225         struct seq_file *sf = file->private_data;
226
227         if (sf->op)
228                 return seq_lseek(file, off, whence);
229         return default_llseek(file, off, whence);
230 }
231
232 static const struct file_operations pstore_file_operations = {
233         .open           = pstore_file_open,
234         .read           = pstore_file_read,
235         .llseek         = pstore_file_llseek,
236         .release        = seq_release,
237 };
238
239 /*
240  * When a file is unlinked from our file system we call the
241  * platform driver to erase the record from persistent store.
242  */
243 static int pstore_unlink(struct inode *dir, struct dentry *dentry)
244 {
245         struct pstore_private *p = dentry->d_inode->i_private;
246
247         if (p->psi->erase)
248                 p->psi->erase(p->type, p->id, p->count,
249                               dentry->d_inode->i_ctime, p->psi);
250
251         return simple_unlink(dir, dentry);
252 }
253
254 static void pstore_evict_inode(struct inode *inode)
255 {
256         struct pstore_private   *p = inode->i_private;
257         unsigned long           flags;
258
259         clear_inode(inode);
260         if (p) {
261                 spin_lock_irqsave(&allpstore_lock, flags);
262                 list_del(&p->list);
263                 spin_unlock_irqrestore(&allpstore_lock, flags);
264                 kfree(p);
265         }
266 }
267
268 static const struct inode_operations pstore_dir_inode_operations = {
269         .lookup         = simple_lookup,
270         .unlink         = pstore_unlink,
271 };
272
273 static struct inode *pstore_get_inode(struct super_block *sb)
274 {
275         struct inode *inode = new_inode(sb);
276         if (inode) {
277                 inode->i_ino = get_next_ino();
278                 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
279         }
280         return inode;
281 }
282
283 enum {
284         Opt_kmsg_bytes, Opt_err
285 };
286
287 static const match_table_t tokens = {
288         {Opt_kmsg_bytes, "kmsg_bytes=%u"},
289         {Opt_err, NULL}
290 };
291
292 static void parse_options(char *options)
293 {
294         char            *p;
295         substring_t     args[MAX_OPT_ARGS];
296         int             option;
297
298         if (!options)
299                 return;
300
301         while ((p = strsep(&options, ",")) != NULL) {
302                 int token;
303
304                 if (!*p)
305                         continue;
306
307                 token = match_token(p, tokens, args);
308                 switch (token) {
309                 case Opt_kmsg_bytes:
310                         if (!match_int(&args[0], &option))
311                                 pstore_set_kmsg_bytes(option);
312                         break;
313                 }
314         }
315 }
316
317 static int pstore_remount(struct super_block *sb, int *flags, char *data)
318 {
319         parse_options(data);
320
321         return 0;
322 }
323
324 static const struct super_operations pstore_ops = {
325         .statfs         = simple_statfs,
326         .drop_inode     = generic_delete_inode,
327         .evict_inode    = pstore_evict_inode,
328         .remount_fs     = pstore_remount,
329         .show_options   = generic_show_options,
330 };
331
332 static struct super_block *pstore_sb;
333
334 int pstore_is_mounted(void)
335 {
336         return pstore_sb != NULL;
337 }
338
339 /*
340  * Make a regular file in the root directory of our file system.
341  * Load it up with "size" bytes of data from "buf".
342  * Set the mtime & ctime to the date that this record was originally stored.
343  */
344 int pstore_mkfile(enum pstore_type_id type, char *psname, u64 id, int count,
345                   char *data, size_t size, struct timespec time,
346                   struct pstore_info *psi)
347 {
348         struct dentry           *root = pstore_sb->s_root;
349         struct dentry           *dentry;
350         struct inode            *inode;
351         int                     rc = 0;
352         char                    name[PSTORE_NAMELEN];
353         struct pstore_private   *private, *pos;
354         unsigned long           flags;
355
356         spin_lock_irqsave(&allpstore_lock, flags);
357         list_for_each_entry(pos, &allpstore, list) {
358                 if (pos->type == type &&
359                     pos->id == id &&
360                     pos->psi == psi) {
361                         rc = -EEXIST;
362                         break;
363                 }
364         }
365         spin_unlock_irqrestore(&allpstore_lock, flags);
366         if (rc)
367                 return rc;
368
369         rc = -ENOMEM;
370         inode = pstore_get_inode(pstore_sb);
371         if (!inode)
372                 goto fail;
373         inode->i_mode = S_IFREG | 0444;
374         inode->i_fop = &pstore_file_operations;
375         private = kmalloc(sizeof *private + size, GFP_KERNEL);
376         if (!private)
377                 goto fail_alloc;
378         private->type = type;
379         private->id = id;
380         private->count = count;
381         private->psi = psi;
382
383         switch (type) {
384         case PSTORE_TYPE_DMESG:
385                 sprintf(name, "dmesg-%s-%lld", psname, id);
386                 break;
387         case PSTORE_TYPE_CONSOLE:
388                 sprintf(name, "console-%s-%lld", psname, id);
389                 break;
390         case PSTORE_TYPE_FTRACE:
391                 sprintf(name, "ftrace-%s-%lld", psname, id);
392                 break;
393         case PSTORE_TYPE_RTRACE:
394                 sprintf(name, "rtrace-%s", psname);
395                 break;
396         case PSTORE_TYPE_MCE:
397                 sprintf(name, "mce-%s-%lld", psname, id);
398                 break;
399         case PSTORE_TYPE_UNKNOWN:
400                 sprintf(name, "unknown-%s-%lld", psname, id);
401                 break;
402         default:
403                 sprintf(name, "type%d-%s-%lld", type, psname, id);
404                 break;
405         }
406
407         mutex_lock(&root->d_inode->i_mutex);
408
409         rc = -ENOSPC;
410         dentry = d_alloc_name(root, name);
411         if (IS_ERR(dentry))
412                 goto fail_lockedalloc;
413
414         memcpy(private->data, data, size);
415         inode->i_size = private->size = size;
416
417         inode->i_private = private;
418
419         if (time.tv_sec)
420                 inode->i_mtime = inode->i_ctime = time;
421
422         d_add(dentry, inode);
423
424         spin_lock_irqsave(&allpstore_lock, flags);
425         list_add(&private->list, &allpstore);
426         spin_unlock_irqrestore(&allpstore_lock, flags);
427
428         mutex_unlock(&root->d_inode->i_mutex);
429
430         return 0;
431
432 fail_lockedalloc:
433         mutex_unlock(&root->d_inode->i_mutex);
434         kfree(private);
435 fail_alloc:
436         iput(inode);
437
438 fail:
439         return rc;
440 }
441
442 static int pstore_fill_super(struct super_block *sb, void *data, int silent)
443 {
444         struct inode *inode;
445
446         save_mount_options(sb, data);
447
448         pstore_sb = sb;
449
450         sb->s_maxbytes          = MAX_LFS_FILESIZE;
451         sb->s_blocksize         = PAGE_CACHE_SIZE;
452         sb->s_blocksize_bits    = PAGE_CACHE_SHIFT;
453         sb->s_magic             = PSTOREFS_MAGIC;
454         sb->s_op                = &pstore_ops;
455         sb->s_time_gran         = 1;
456
457         parse_options(data);
458
459         inode = pstore_get_inode(sb);
460         if (inode) {
461                 inode->i_mode = S_IFDIR | 0755;
462                 inode->i_op = &pstore_dir_inode_operations;
463                 inode->i_fop = &simple_dir_operations;
464                 inc_nlink(inode);
465         }
466         sb->s_root = d_make_root(inode);
467         if (!sb->s_root)
468                 return -ENOMEM;
469
470         pstore_get_records(0);
471
472         return 0;
473 }
474
475 static struct dentry *pstore_mount(struct file_system_type *fs_type,
476         int flags, const char *dev_name, void *data)
477 {
478         return mount_single(fs_type, flags, data, pstore_fill_super);
479 }
480
481 static void pstore_kill_sb(struct super_block *sb)
482 {
483         kill_litter_super(sb);
484         pstore_sb = NULL;
485 }
486
487 static struct file_system_type pstore_fs_type = {
488         .name           = "pstore",
489         .mount          = pstore_mount,
490         .kill_sb        = pstore_kill_sb,
491 };
492
493 static struct kobject *pstore_kobj;
494
495 static int __init init_pstore_fs(void)
496 {
497         int err = 0;
498
499         /* Create a convenient mount point for people to access pstore */
500         pstore_kobj = kobject_create_and_add("pstore", fs_kobj);
501         if (!pstore_kobj) {
502                 err = -ENOMEM;
503                 goto out;
504         }
505
506         err = register_filesystem(&pstore_fs_type);
507         if (err < 0)
508                 kobject_put(pstore_kobj);
509
510 out:
511         return err;
512 }
513 module_init(init_pstore_fs)
514
515 MODULE_AUTHOR("Tony Luck <tony.luck@intel.com>");
516 MODULE_LICENSE("GPL");