2 * Persistent Storage - ramfs parts.
4 * Copyright (C) 2010 Intel Corporation <tony.luck@intel.com>
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.
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.
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
20 #include <linux/module.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>
27 #include <linux/list.h>
28 #include <linux/string.h>
29 #include <linux/mount.h>
30 #include <linux/seq_file.h>
31 #include <linux/ramfs.h>
32 #include <linux/parser.h>
33 #include <linux/sched.h>
34 #include <linux/magic.h>
35 #include <linux/pstore.h>
36 #include <linux/slab.h>
37 #include <linux/spinlock.h>
38 #include <linux/uaccess.h>
39 #include <linux/syslog.h>
43 #define PSTORE_NAMELEN 64
45 static DEFINE_SPINLOCK(allpstore_lock
);
46 static LIST_HEAD(allpstore
);
48 struct pstore_private
{
49 struct list_head list
;
50 struct pstore_record
*record
;
54 struct pstore_ftrace_seq_data
{
60 #define REC_SIZE sizeof(struct pstore_ftrace_record)
62 static void free_pstore_private(struct pstore_private
*private)
66 if (private->record
) {
67 kfree(private->record
->buf
);
68 kfree(private->record
);
73 static void *pstore_ftrace_seq_start(struct seq_file
*s
, loff_t
*pos
)
75 struct pstore_private
*ps
= s
->private;
76 struct pstore_ftrace_seq_data
*data
;
78 data
= kzalloc(sizeof(*data
), GFP_KERNEL
);
82 data
->off
= ps
->total_size
% REC_SIZE
;
83 data
->off
+= *pos
* REC_SIZE
;
84 if (data
->off
+ REC_SIZE
> ps
->total_size
) {
93 static void pstore_ftrace_seq_stop(struct seq_file
*s
, void *v
)
98 static void *pstore_ftrace_seq_next(struct seq_file
*s
, void *v
, loff_t
*pos
)
100 struct pstore_private
*ps
= s
->private;
101 struct pstore_ftrace_seq_data
*data
= v
;
103 data
->off
+= REC_SIZE
;
104 if (data
->off
+ REC_SIZE
> ps
->total_size
)
111 static int pstore_ftrace_seq_show(struct seq_file
*s
, void *v
)
113 struct pstore_private
*ps
= s
->private;
114 struct pstore_ftrace_seq_data
*data
= v
;
115 struct pstore_ftrace_record
*rec
;
117 rec
= (struct pstore_ftrace_record
*)(ps
->record
->buf
+ data
->off
);
119 seq_printf(s
, "CPU:%d ts:%llu %08lx %08lx %pf <- %pF\n",
120 pstore_ftrace_decode_cpu(rec
),
121 pstore_ftrace_read_timestamp(rec
),
122 rec
->ip
, rec
->parent_ip
, (void *)rec
->ip
,
123 (void *)rec
->parent_ip
);
128 static const struct seq_operations pstore_ftrace_seq_ops
= {
129 .start
= pstore_ftrace_seq_start
,
130 .next
= pstore_ftrace_seq_next
,
131 .stop
= pstore_ftrace_seq_stop
,
132 .show
= pstore_ftrace_seq_show
,
135 static int pstore_check_syslog_permissions(struct pstore_private
*ps
)
137 switch (ps
->record
->type
) {
138 case PSTORE_TYPE_DMESG
:
139 case PSTORE_TYPE_CONSOLE
:
140 return check_syslog_permissions(SYSLOG_ACTION_READ_ALL
,
147 static ssize_t
pstore_file_read(struct file
*file
, char __user
*userbuf
,
148 size_t count
, loff_t
*ppos
)
150 struct seq_file
*sf
= file
->private_data
;
151 struct pstore_private
*ps
= sf
->private;
153 if (ps
->record
->type
== PSTORE_TYPE_FTRACE
)
154 return seq_read(file
, userbuf
, count
, ppos
);
155 return simple_read_from_buffer(userbuf
, count
, ppos
,
156 ps
->record
->buf
, ps
->total_size
);
159 static int pstore_file_open(struct inode
*inode
, struct file
*file
)
161 struct pstore_private
*ps
= inode
->i_private
;
164 const struct seq_operations
*sops
= NULL
;
166 err
= pstore_check_syslog_permissions(ps
);
170 if (ps
->record
->type
== PSTORE_TYPE_FTRACE
)
171 sops
= &pstore_ftrace_seq_ops
;
173 err
= seq_open(file
, sops
);
177 sf
= file
->private_data
;
183 static loff_t
pstore_file_llseek(struct file
*file
, loff_t off
, int whence
)
185 struct seq_file
*sf
= file
->private_data
;
188 return seq_lseek(file
, off
, whence
);
189 return default_llseek(file
, off
, whence
);
192 static const struct file_operations pstore_file_operations
= {
193 .open
= pstore_file_open
,
194 .read
= pstore_file_read
,
195 .llseek
= pstore_file_llseek
,
196 .release
= seq_release
,
200 * When a file is unlinked from our file system we call the
201 * platform driver to erase the record from persistent store.
203 static int pstore_unlink(struct inode
*dir
, struct dentry
*dentry
)
205 struct pstore_private
*p
= d_inode(dentry
)->i_private
;
206 struct pstore_record
*record
= p
->record
;
209 err
= pstore_check_syslog_permissions(p
);
213 if (!record
->psi
->erase
)
216 mutex_lock(&record
->psi
->read_mutex
);
217 record
->psi
->erase(record
);
218 mutex_unlock(&record
->psi
->read_mutex
);
220 return simple_unlink(dir
, dentry
);
223 static void pstore_evict_inode(struct inode
*inode
)
225 struct pstore_private
*p
= inode
->i_private
;
230 spin_lock_irqsave(&allpstore_lock
, flags
);
232 spin_unlock_irqrestore(&allpstore_lock
, flags
);
233 free_pstore_private(p
);
237 static const struct inode_operations pstore_dir_inode_operations
= {
238 .lookup
= simple_lookup
,
239 .unlink
= pstore_unlink
,
242 static struct inode
*pstore_get_inode(struct super_block
*sb
)
244 struct inode
*inode
= new_inode(sb
);
246 inode
->i_ino
= get_next_ino();
247 inode
->i_atime
= inode
->i_mtime
= inode
->i_ctime
= current_time(inode
);
253 Opt_kmsg_bytes
, Opt_err
256 static const match_table_t tokens
= {
257 {Opt_kmsg_bytes
, "kmsg_bytes=%u"},
261 static void parse_options(char *options
)
264 substring_t args
[MAX_OPT_ARGS
];
270 while ((p
= strsep(&options
, ",")) != NULL
) {
276 token
= match_token(p
, tokens
, args
);
279 if (!match_int(&args
[0], &option
))
280 pstore_set_kmsg_bytes(option
);
286 static int pstore_remount(struct super_block
*sb
, int *flags
, char *data
)
294 static const struct super_operations pstore_ops
= {
295 .statfs
= simple_statfs
,
296 .drop_inode
= generic_delete_inode
,
297 .evict_inode
= pstore_evict_inode
,
298 .remount_fs
= pstore_remount
,
299 .show_options
= generic_show_options
,
302 static struct super_block
*pstore_sb
;
304 bool pstore_is_mounted(void)
306 return pstore_sb
!= NULL
;
310 * Make a regular file in the root directory of our file system.
311 * Load it up with "size" bytes of data from "buf".
312 * Set the mtime & ctime to the date that this record was originally stored.
314 int pstore_mkfile(struct dentry
*root
, struct pstore_record
*record
)
316 struct dentry
*dentry
;
319 char name
[PSTORE_NAMELEN
];
320 struct pstore_private
*private, *pos
;
322 size_t size
= record
->size
+ record
->ecc_notice_size
;
324 WARN_ON(!inode_is_locked(d_inode(root
)));
326 spin_lock_irqsave(&allpstore_lock
, flags
);
327 list_for_each_entry(pos
, &allpstore
, list
) {
328 if (pos
->record
->type
== record
->type
&&
329 pos
->record
->id
== record
->id
&&
330 pos
->record
->psi
== record
->psi
) {
335 spin_unlock_irqrestore(&allpstore_lock
, flags
);
340 inode
= pstore_get_inode(root
->d_sb
);
343 inode
->i_mode
= S_IFREG
| 0444;
344 inode
->i_fop
= &pstore_file_operations
;
345 private = kzalloc(sizeof(*private), GFP_KERNEL
);
348 private->record
= record
;
350 switch (record
->type
) {
351 case PSTORE_TYPE_DMESG
:
352 scnprintf(name
, sizeof(name
), "dmesg-%s-%lld%s",
353 record
->psi
->name
, record
->id
,
354 record
->compressed
? ".enc.z" : "");
356 case PSTORE_TYPE_CONSOLE
:
357 scnprintf(name
, sizeof(name
), "console-%s-%lld",
358 record
->psi
->name
, record
->id
);
360 case PSTORE_TYPE_FTRACE
:
361 scnprintf(name
, sizeof(name
), "ftrace-%s-%lld",
362 record
->psi
->name
, record
->id
);
364 case PSTORE_TYPE_MCE
:
365 scnprintf(name
, sizeof(name
), "mce-%s-%lld",
366 record
->psi
->name
, record
->id
);
368 case PSTORE_TYPE_PPC_RTAS
:
369 scnprintf(name
, sizeof(name
), "rtas-%s-%lld",
370 record
->psi
->name
, record
->id
);
372 case PSTORE_TYPE_PPC_OF
:
373 scnprintf(name
, sizeof(name
), "powerpc-ofw-%s-%lld",
374 record
->psi
->name
, record
->id
);
376 case PSTORE_TYPE_PPC_COMMON
:
377 scnprintf(name
, sizeof(name
), "powerpc-common-%s-%lld",
378 record
->psi
->name
, record
->id
);
380 case PSTORE_TYPE_PMSG
:
381 scnprintf(name
, sizeof(name
), "pmsg-%s-%lld",
382 record
->psi
->name
, record
->id
);
384 case PSTORE_TYPE_PPC_OPAL
:
385 scnprintf(name
, sizeof(name
), "powerpc-opal-%s-%lld",
386 record
->psi
->name
, record
->id
);
388 case PSTORE_TYPE_UNKNOWN
:
389 scnprintf(name
, sizeof(name
), "unknown-%s-%lld",
390 record
->psi
->name
, record
->id
);
393 scnprintf(name
, sizeof(name
), "type%d-%s-%lld",
394 record
->type
, record
->psi
->name
, record
->id
);
398 dentry
= d_alloc_name(root
, name
);
402 inode
->i_size
= private->total_size
= size
;
404 inode
->i_private
= private;
406 if (record
->time
.tv_sec
)
407 inode
->i_mtime
= inode
->i_ctime
= record
->time
;
409 d_add(dentry
, inode
);
411 spin_lock_irqsave(&allpstore_lock
, flags
);
412 list_add(&private->list
, &allpstore
);
413 spin_unlock_irqrestore(&allpstore_lock
, flags
);
418 free_pstore_private(private);
427 * Read all the records from the persistent store. Create
428 * files in our filesystem. Don't warn about -EEXIST errors
429 * when we are re-scanning the backing store looking to add new
432 void pstore_get_records(int quiet
)
434 struct pstore_info
*psi
= psinfo
;
437 if (!psi
|| !pstore_sb
)
440 root
= pstore_sb
->s_root
;
442 inode_lock(d_inode(root
));
443 pstore_get_backend_records(psi
, root
, quiet
);
444 inode_unlock(d_inode(root
));
447 static int pstore_fill_super(struct super_block
*sb
, void *data
, int silent
)
451 save_mount_options(sb
, data
);
455 sb
->s_maxbytes
= MAX_LFS_FILESIZE
;
456 sb
->s_blocksize
= PAGE_SIZE
;
457 sb
->s_blocksize_bits
= PAGE_SHIFT
;
458 sb
->s_magic
= PSTOREFS_MAGIC
;
459 sb
->s_op
= &pstore_ops
;
464 inode
= pstore_get_inode(sb
);
466 inode
->i_mode
= S_IFDIR
| 0755;
467 inode
->i_op
= &pstore_dir_inode_operations
;
468 inode
->i_fop
= &simple_dir_operations
;
471 sb
->s_root
= d_make_root(inode
);
475 pstore_get_records(0);
480 static struct dentry
*pstore_mount(struct file_system_type
*fs_type
,
481 int flags
, const char *dev_name
, void *data
)
483 return mount_single(fs_type
, flags
, data
, pstore_fill_super
);
486 static void pstore_kill_sb(struct super_block
*sb
)
488 kill_litter_super(sb
);
492 static struct file_system_type pstore_fs_type
= {
493 .owner
= THIS_MODULE
,
495 .mount
= pstore_mount
,
496 .kill_sb
= pstore_kill_sb
,
499 static int __init
init_pstore_fs(void)
503 /* Create a convenient mount point for people to access pstore */
504 err
= sysfs_create_mount_point(fs_kobj
, "pstore");
508 err
= register_filesystem(&pstore_fs_type
);
510 sysfs_remove_mount_point(fs_kobj
, "pstore");
515 module_init(init_pstore_fs
)
517 static void __exit
exit_pstore_fs(void)
519 unregister_filesystem(&pstore_fs_type
);
520 sysfs_remove_mount_point(fs_kobj
, "pstore");
522 module_exit(exit_pstore_fs
)
524 MODULE_AUTHOR("Tony Luck <tony.luck@intel.com>");
525 MODULE_LICENSE("GPL");