inode.c 9.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
/*
 * Persistent Storage - ramfs parts.
 *
 * Copyright (C) 2010 Intel Corporation <tony.luck@intel.com>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2 as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#include <linux/module.h>
#include <linux/fs.h>
#include <linux/fsnotify.h>
#include <linux/pagemap.h>
#include <linux/highmem.h>
#include <linux/time.h>
#include <linux/init.h>
27
#include <linux/list.h>
28 29
#include <linux/string.h>
#include <linux/mount.h>
30
#include <linux/seq_file.h>
31
#include <linux/ramfs.h>
32
#include <linux/parser.h>
33 34 35 36
#include <linux/sched.h>
#include <linux/magic.h>
#include <linux/pstore.h>
#include <linux/slab.h>
37
#include <linux/spinlock.h>
38 39 40 41 42 43
#include <linux/uaccess.h>

#include "internal.h"

#define	PSTORE_NAMELEN	64

44 45 46
static DEFINE_SPINLOCK(allpstore_lock);
static LIST_HEAD(allpstore);

47
struct pstore_private {
48
	struct list_head list;
49
	struct pstore_info *psi;
50 51
	enum pstore_type_id type;
	u64	id;
52
	int	count;
T
Tony Luck 已提交
53 54
	ssize_t	size;
	char	data[];
55 56
};

57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
struct pstore_ftrace_seq_data {
	const void *ptr;
	size_t off;
	size_t size;
};

#define REC_SIZE sizeof(struct pstore_ftrace_record)

static void *pstore_ftrace_seq_start(struct seq_file *s, loff_t *pos)
{
	struct pstore_private *ps = s->private;
	struct pstore_ftrace_seq_data *data;

	data = kzalloc(sizeof(*data), GFP_KERNEL);
	if (!data)
		return NULL;

	data->off = ps->size % REC_SIZE;
	data->off += *pos * REC_SIZE;
	if (data->off + REC_SIZE > ps->size) {
		kfree(data);
		return NULL;
	}

	return data;

}

static void pstore_ftrace_seq_stop(struct seq_file *s, void *v)
{
	kfree(v);
}

static void *pstore_ftrace_seq_next(struct seq_file *s, void *v, loff_t *pos)
{
	struct pstore_private *ps = s->private;
	struct pstore_ftrace_seq_data *data = v;

	data->off += REC_SIZE;
	if (data->off + REC_SIZE > ps->size)
		return NULL;

	(*pos)++;
	return data;
}

static int pstore_ftrace_seq_show(struct seq_file *s, void *v)
{
	struct pstore_private *ps = s->private;
	struct pstore_ftrace_seq_data *data = v;
	struct pstore_ftrace_record *rec = (void *)(ps->data + data->off);

	seq_printf(s, "%d %08lx  %08lx  %pf <- %pF\n",
		pstore_ftrace_decode_cpu(rec), rec->ip, rec->parent_ip,
		(void *)rec->ip, (void *)rec->parent_ip);

	return 0;
}

static const struct seq_operations pstore_ftrace_seq_ops = {
	.start	= pstore_ftrace_seq_start,
	.next	= pstore_ftrace_seq_next,
	.stop	= pstore_ftrace_seq_stop,
	.show	= pstore_ftrace_seq_show,
};

T
Tony Luck 已提交
123 124 125
static ssize_t pstore_file_read(struct file *file, char __user *userbuf,
						size_t count, loff_t *ppos)
{
126 127
	struct seq_file *sf = file->private_data;
	struct pstore_private *ps = sf->private;
T
Tony Luck 已提交
128

129 130
	if (ps->type == PSTORE_TYPE_FTRACE)
		return seq_read(file, userbuf, count, ppos);
T
Tony Luck 已提交
131 132 133
	return simple_read_from_buffer(userbuf, count, ppos, ps->data, ps->size);
}

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
static int pstore_file_open(struct inode *inode, struct file *file)
{
	struct pstore_private *ps = inode->i_private;
	struct seq_file *sf;
	int err;
	const struct seq_operations *sops = NULL;

	if (ps->type == PSTORE_TYPE_FTRACE)
		sops = &pstore_ftrace_seq_ops;

	err = seq_open(file, sops);
	if (err < 0)
		return err;

	sf = file->private_data;
	sf->private = ps;

	return 0;
}

154
static loff_t pstore_file_llseek(struct file *file, loff_t off, int whence)
155 156 157 158
{
	struct seq_file *sf = file->private_data;

	if (sf->op)
159 160
		return seq_lseek(file, off, whence);
	return default_llseek(file, off, whence);
161 162
}

T
Tony Luck 已提交
163
static const struct file_operations pstore_file_operations = {
164 165 166 167
	.open		= pstore_file_open,
	.read		= pstore_file_read,
	.llseek		= pstore_file_llseek,
	.release	= seq_release,
T
Tony Luck 已提交
168
};
169 170 171 172 173 174 175 176 177

/*
 * When a file is unlinked from our file system we call the
 * platform driver to erase the record from persistent store.
 */
static int pstore_unlink(struct inode *dir, struct dentry *dentry)
{
	struct pstore_private *p = dentry->d_inode->i_private;

178
	if (p->psi->erase)
179 180
		p->psi->erase(p->type, p->id, p->count,
			      dentry->d_inode->i_ctime, p->psi);
181 182 183 184

	return simple_unlink(dir, dentry);
}

T
Tony Luck 已提交
185 186
static void pstore_evict_inode(struct inode *inode)
{
187 188 189
	struct pstore_private	*p = inode->i_private;
	unsigned long		flags;

190
	clear_inode(inode);
191 192 193 194 195 196
	if (p) {
		spin_lock_irqsave(&allpstore_lock, flags);
		list_del(&p->list);
		spin_unlock_irqrestore(&allpstore_lock, flags);
		kfree(p);
	}
T
Tony Luck 已提交
197 198
}

199 200 201 202 203
static const struct inode_operations pstore_dir_inode_operations = {
	.lookup		= simple_lookup,
	.unlink		= pstore_unlink,
};

A
Al Viro 已提交
204
static struct inode *pstore_get_inode(struct super_block *sb)
T
Tony Luck 已提交
205 206 207 208 209 210 211 212 213
{
	struct inode *inode = new_inode(sb);
	if (inode) {
		inode->i_ino = get_next_ino();
		inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
	}
	return inode;
}

214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
enum {
	Opt_kmsg_bytes, Opt_err
};

static const match_table_t tokens = {
	{Opt_kmsg_bytes, "kmsg_bytes=%u"},
	{Opt_err, NULL}
};

static void parse_options(char *options)
{
	char		*p;
	substring_t	args[MAX_OPT_ARGS];
	int		option;

	if (!options)
		return;

	while ((p = strsep(&options, ",")) != NULL) {
		int token;

		if (!*p)
			continue;

		token = match_token(p, tokens, args);
		switch (token) {
		case Opt_kmsg_bytes:
			if (!match_int(&args[0], &option))
				pstore_set_kmsg_bytes(option);
			break;
		}
	}
}

static int pstore_remount(struct super_block *sb, int *flags, char *data)
{
	parse_options(data);

	return 0;
}

255 256 257
static const struct super_operations pstore_ops = {
	.statfs		= simple_statfs,
	.drop_inode	= generic_delete_inode,
T
Tony Luck 已提交
258
	.evict_inode	= pstore_evict_inode,
259
	.remount_fs	= pstore_remount,
260 261 262 263 264 265 266
	.show_options	= generic_show_options,
};

static struct super_block *pstore_sb;

int pstore_is_mounted(void)
{
T
Tony Luck 已提交
267
	return pstore_sb != NULL;
268 269 270 271 272 273 274
}

/*
 * Make a regular file in the root directory of our file system.
 * Load it up with "size" bytes of data from "buf".
 * Set the mtime & ctime to the date that this record was originally stored.
 */
275
int pstore_mkfile(enum pstore_type_id type, char *psname, u64 id, int count,
276 277
		  char *data, size_t size, struct timespec time,
		  struct pstore_info *psi)
278 279 280 281
{
	struct dentry		*root = pstore_sb->s_root;
	struct dentry		*dentry;
	struct inode		*inode;
282
	int			rc = 0;
283
	char			name[PSTORE_NAMELEN];
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
	struct pstore_private	*private, *pos;
	unsigned long		flags;

	spin_lock_irqsave(&allpstore_lock, flags);
	list_for_each_entry(pos, &allpstore, list) {
		if (pos->type == type &&
		    pos->id == id &&
		    pos->psi == psi) {
			rc = -EEXIST;
			break;
		}
	}
	spin_unlock_irqrestore(&allpstore_lock, flags);
	if (rc)
		return rc;
299 300

	rc = -ENOMEM;
A
Al Viro 已提交
301
	inode = pstore_get_inode(pstore_sb);
302 303
	if (!inode)
		goto fail;
A
Al Viro 已提交
304 305
	inode->i_mode = S_IFREG | 0444;
	inode->i_fop = &pstore_file_operations;
T
Tony Luck 已提交
306
	private = kmalloc(sizeof *private + size, GFP_KERNEL);
307 308
	if (!private)
		goto fail_alloc;
309
	private->type = type;
310
	private->id = id;
311
	private->count = count;
312
	private->psi = psi;
313 314 315 316 317

	switch (type) {
	case PSTORE_TYPE_DMESG:
		sprintf(name, "dmesg-%s-%lld", psname, id);
		break;
318 319 320
	case PSTORE_TYPE_CONSOLE:
		sprintf(name, "console-%s", psname);
		break;
321 322 323
	case PSTORE_TYPE_FTRACE:
		sprintf(name, "ftrace-%s", psname);
		break;
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
	case PSTORE_TYPE_MCE:
		sprintf(name, "mce-%s-%lld", psname, id);
		break;
	case PSTORE_TYPE_UNKNOWN:
		sprintf(name, "unknown-%s-%lld", psname, id);
		break;
	default:
		sprintf(name, "type%d-%s-%lld", type, psname, id);
		break;
	}

	mutex_lock(&root->d_inode->i_mutex);

	rc = -ENOSPC;
	dentry = d_alloc_name(root, name);
	if (IS_ERR(dentry))
		goto fail_lockedalloc;

T
Tony Luck 已提交
342 343
	memcpy(private->data, data, size);
	inode->i_size = private->size = size;
344 345 346 347 348 349

	inode->i_private = private;

	if (time.tv_sec)
		inode->i_mtime = inode->i_ctime = time;

T
Tony Luck 已提交
350
	d_add(dentry, inode);
351

352 353 354 355
	spin_lock_irqsave(&allpstore_lock, flags);
	list_add(&private->list, &allpstore);
	spin_unlock_irqrestore(&allpstore_lock, flags);

356
	mutex_unlock(&root->d_inode->i_mutex);
T
Tony Luck 已提交
357 358

	return 0;
359 360 361 362 363 364 365 366 367 368 369

fail_lockedalloc:
	mutex_unlock(&root->d_inode->i_mutex);
	kfree(private);
fail_alloc:
	iput(inode);

fail:
	return rc;
}

370
static int pstore_fill_super(struct super_block *sb, void *data, int silent)
371
{
A
Al Viro 已提交
372
	struct inode *inode;
373 374 375 376 377 378 379 380 381 382 383 384

	save_mount_options(sb, data);

	pstore_sb = sb;

	sb->s_maxbytes		= MAX_LFS_FILESIZE;
	sb->s_blocksize		= PAGE_CACHE_SIZE;
	sb->s_blocksize_bits	= PAGE_CACHE_SHIFT;
	sb->s_magic		= PSTOREFS_MAGIC;
	sb->s_op		= &pstore_ops;
	sb->s_time_gran		= 1;

385 386
	parse_options(data);

A
Al Viro 已提交
387
	inode = pstore_get_inode(sb);
A
Al Viro 已提交
388
	if (inode) {
A
Al Viro 已提交
389
		inode->i_mode = S_IFDIR | 0755;
A
Al Viro 已提交
390
		inode->i_op = &pstore_dir_inode_operations;
A
Al Viro 已提交
391 392
		inode->i_fop = &simple_dir_operations;
		inc_nlink(inode);
393
	}
A
Al Viro 已提交
394 395 396
	sb->s_root = d_make_root(inode);
	if (!sb->s_root)
		return -ENOMEM;
397

398
	pstore_get_records(0);
399 400 401 402

	return 0;
}

T
Tony Luck 已提交
403 404
static struct dentry *pstore_mount(struct file_system_type *fs_type,
	int flags, const char *dev_name, void *data)
405
{
T
Tony Luck 已提交
406
	return mount_single(fs_type, flags, data, pstore_fill_super);
407 408 409 410 411 412 413 414 415 416
}

static void pstore_kill_sb(struct super_block *sb)
{
	kill_litter_super(sb);
	pstore_sb = NULL;
}

static struct file_system_type pstore_fs_type = {
	.name		= "pstore",
T
Tony Luck 已提交
417
	.mount		= pstore_mount,
418 419 420
	.kill_sb	= pstore_kill_sb,
};

421 422
static struct kobject *pstore_kobj;

423 424
static int __init init_pstore_fs(void)
{
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
	int err = 0;

	/* Create a convenient mount point for people to access pstore */
	pstore_kobj = kobject_create_and_add("pstore", fs_kobj);
	if (!pstore_kobj) {
		err = -ENOMEM;
		goto out;
	}

	err = register_filesystem(&pstore_fs_type);
	if (err < 0)
		kobject_put(pstore_kobj);

out:
	return err;
440 441 442 443 444
}
module_init(init_pstore_fs)

MODULE_AUTHOR("Tony Luck <tony.luck@intel.com>");
MODULE_LICENSE("GPL");