inode.c 23.6 KB
Newer Older
L
Linus Torvalds 已提交
1
/*
H
Harry Wei 已提交
2
 *  inode.c - part of debugfs, a tiny little debug file system
L
Linus Torvalds 已提交
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
 *
 *  Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
 *  Copyright (C) 2004 IBM Inc.
 *
 *	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.
 *
 *  debugfs is for people to use instead of /proc or /sys.
 *  See Documentation/DocBook/kernel-api for more details.
 *
 */

#include <linux/module.h>
#include <linux/fs.h>
#include <linux/mount.h>
#include <linux/pagemap.h>
#include <linux/init.h>
R
Randy Dunlap 已提交
21
#include <linux/kobject.h>
L
Linus Torvalds 已提交
22 23
#include <linux/namei.h>
#include <linux/debugfs.h>
24
#include <linux/fsnotify.h>
25
#include <linux/string.h>
26 27
#include <linux/seq_file.h>
#include <linux/parser.h>
M
Mimi Zohar 已提交
28
#include <linux/magic.h>
29
#include <linux/slab.h>
30 31 32
#include <linux/srcu.h>

#include "internal.h"
L
Linus Torvalds 已提交
33

34
#define DEBUGFS_DEFAULT_MODE	0700
35

36 37
DEFINE_SRCU(debugfs_srcu);

L
Linus Torvalds 已提交
38 39
static struct vfsmount *debugfs_mount;
static int debugfs_mount_count;
40
static bool debugfs_registered;
L
Linus Torvalds 已提交
41

42
static struct inode *debugfs_get_inode(struct super_block *sb)
L
Linus Torvalds 已提交
43 44 45
{
	struct inode *inode = new_inode(sb);
	if (inode) {
46
		inode->i_ino = get_next_ino();
47
		inode->i_atime = inode->i_mtime =
48
			inode->i_ctime = current_time(inode);
L
Linus Torvalds 已提交
49
	}
50
	return inode;
L
Linus Torvalds 已提交
51 52
}

53
struct debugfs_mount_opts {
54 55
	kuid_t uid;
	kgid_t gid;
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
	umode_t mode;
};

enum {
	Opt_uid,
	Opt_gid,
	Opt_mode,
	Opt_err
};

static const match_table_t tokens = {
	{Opt_uid, "uid=%u"},
	{Opt_gid, "gid=%u"},
	{Opt_mode, "mode=%o"},
	{Opt_err, NULL}
};

struct debugfs_fs_info {
	struct debugfs_mount_opts mount_opts;
};

static int debugfs_parse_options(char *data, struct debugfs_mount_opts *opts)
{
	substring_t args[MAX_OPT_ARGS];
	int option;
	int token;
82 83
	kuid_t uid;
	kgid_t gid;
84 85 86 87 88 89 90 91 92 93 94 95 96
	char *p;

	opts->mode = DEBUGFS_DEFAULT_MODE;

	while ((p = strsep(&data, ",")) != NULL) {
		if (!*p)
			continue;

		token = match_token(p, tokens, args);
		switch (token) {
		case Opt_uid:
			if (match_int(&args[0], &option))
				return -EINVAL;
97 98 99 100
			uid = make_kuid(current_user_ns(), option);
			if (!uid_valid(uid))
				return -EINVAL;
			opts->uid = uid;
101 102
			break;
		case Opt_gid:
103
			if (match_int(&args[0], &option))
104
				return -EINVAL;
105 106 107 108
			gid = make_kgid(current_user_ns(), option);
			if (!gid_valid(gid))
				return -EINVAL;
			opts->gid = gid;
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
			break;
		case Opt_mode:
			if (match_octal(&args[0], &option))
				return -EINVAL;
			opts->mode = option & S_IALLUGO;
			break;
		/*
		 * We might like to report bad mount options here;
		 * but traditionally debugfs has ignored all mount options
		 */
		}
	}

	return 0;
}

static int debugfs_apply_options(struct super_block *sb)
{
	struct debugfs_fs_info *fsi = sb->s_fs_info;
128
	struct inode *inode = d_inode(sb->s_root);
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
	struct debugfs_mount_opts *opts = &fsi->mount_opts;

	inode->i_mode &= ~S_IALLUGO;
	inode->i_mode |= opts->mode;

	inode->i_uid = opts->uid;
	inode->i_gid = opts->gid;

	return 0;
}

static int debugfs_remount(struct super_block *sb, int *flags, char *data)
{
	int err;
	struct debugfs_fs_info *fsi = sb->s_fs_info;

145
	sync_filesystem(sb);
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
	err = debugfs_parse_options(data, &fsi->mount_opts);
	if (err)
		goto fail;

	debugfs_apply_options(sb);

fail:
	return err;
}

static int debugfs_show_options(struct seq_file *m, struct dentry *root)
{
	struct debugfs_fs_info *fsi = root->d_sb->s_fs_info;
	struct debugfs_mount_opts *opts = &fsi->mount_opts;

161 162 163 164 165 166
	if (!uid_eq(opts->uid, GLOBAL_ROOT_UID))
		seq_printf(m, ",uid=%u",
			   from_kuid_munged(&init_user_ns, opts->uid));
	if (!gid_eq(opts->gid, GLOBAL_ROOT_GID))
		seq_printf(m, ",gid=%u",
			   from_kgid_munged(&init_user_ns, opts->gid));
167 168 169 170 171 172
	if (opts->mode != DEBUGFS_DEFAULT_MODE)
		seq_printf(m, ",mode=%o", opts->mode);

	return 0;
}

173 174 175 176 177
static void debugfs_evict_inode(struct inode *inode)
{
	truncate_inode_pages_final(&inode->i_data);
	clear_inode(inode);
	if (S_ISLNK(inode->i_mode))
178
		kfree(inode->i_link);
179 180
}

181 182 183 184
static const struct super_operations debugfs_super_operations = {
	.statfs		= simple_statfs,
	.remount_fs	= debugfs_remount,
	.show_options	= debugfs_show_options,
185
	.evict_inode	= debugfs_evict_inode,
186 187
};

188 189
static struct vfsmount *debugfs_automount(struct path *path)
{
190 191 192
	debugfs_automount_t f;
	f = (debugfs_automount_t)path->dentry->d_fsdata;
	return f(path->dentry, d_inode(path->dentry)->i_private);
193 194 195 196 197 198 199
}

static const struct dentry_operations debugfs_dops = {
	.d_delete = always_delete_dentry,
	.d_automount = debugfs_automount,
};

L
Linus Torvalds 已提交
200 201
static int debug_fill_super(struct super_block *sb, void *data, int silent)
{
202
	static const struct tree_descr debug_files[] = {{""}};
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
	struct debugfs_fs_info *fsi;
	int err;

	save_mount_options(sb, data);

	fsi = kzalloc(sizeof(struct debugfs_fs_info), GFP_KERNEL);
	sb->s_fs_info = fsi;
	if (!fsi) {
		err = -ENOMEM;
		goto fail;
	}

	err = debugfs_parse_options(data, &fsi->mount_opts);
	if (err)
		goto fail;

	err  =  simple_fill_super(sb, DEBUGFS_MAGIC, debug_files);
	if (err)
		goto fail;

	sb->s_op = &debugfs_super_operations;
224
	sb->s_d_op = &debugfs_dops;
225 226 227 228

	debugfs_apply_options(sb);

	return 0;
L
Linus Torvalds 已提交
229

230 231 232 233
fail:
	kfree(fsi);
	sb->s_fs_info = NULL;
	return err;
L
Linus Torvalds 已提交
234 235
}

A
Al Viro 已提交
236
static struct dentry *debug_mount(struct file_system_type *fs_type,
237
			int flags, const char *dev_name,
A
Al Viro 已提交
238
			void *data)
L
Linus Torvalds 已提交
239
{
A
Al Viro 已提交
240
	return mount_single(fs_type, flags, data, debug_fill_super);
L
Linus Torvalds 已提交
241 242 243 244 245
}

static struct file_system_type debug_fs_type = {
	.owner =	THIS_MODULE,
	.name =		"debugfs",
A
Al Viro 已提交
246
	.mount =	debug_mount,
L
Linus Torvalds 已提交
247 248
	.kill_sb =	kill_litter_super,
};
249
MODULE_ALIAS_FS("debugfs");
L
Linus Torvalds 已提交
250

O
Omar Sandoval 已提交
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
/**
 * debugfs_lookup() - look up an existing debugfs file
 * @name: a pointer to a string containing the name of the file to look up.
 * @parent: a pointer to the parent dentry of the file.
 *
 * This function will return a pointer to a dentry if it succeeds.  If the file
 * doesn't exist or an error occurs, %NULL will be returned.  The returned
 * dentry must be passed to dput() when it is no longer needed.
 *
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 * returned.
 */
struct dentry *debugfs_lookup(const char *name, struct dentry *parent)
{
	struct dentry *dentry;

	if (IS_ERR(parent))
		return NULL;

	if (!parent)
		parent = debugfs_mount->mnt_root;

	inode_lock(d_inode(parent));
	dentry = lookup_one_len(name, parent, strlen(name));
	inode_unlock(d_inode(parent));

	if (IS_ERR(dentry))
		return NULL;
	if (!d_really_is_positive(dentry)) {
		dput(dentry);
		return NULL;
	}
	return dentry;
}
EXPORT_SYMBOL_GPL(debugfs_lookup);

287
static struct dentry *start_creating(const char *name, struct dentry *parent)
L
Linus Torvalds 已提交
288
{
289
	struct dentry *dentry;
290 291 292 293
	int error;

	pr_debug("debugfs: creating file '%s'\n",name);

294 295 296
	if (IS_ERR(parent))
		return parent;

297 298 299
	error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
			      &debugfs_mount_count);
	if (error)
300
		return ERR_PTR(error);
L
Linus Torvalds 已提交
301 302

	/* If the parent is not specified, we create it in the root.
303
	 * We need the root dentry to do this, which is in the super
L
Linus Torvalds 已提交
304 305 306
	 * block. A pointer to that is in the struct vfsmount that we
	 * have around.
	 */
307
	if (!parent)
308
		parent = debugfs_mount->mnt_root;
L
Linus Torvalds 已提交
309

A
Al Viro 已提交
310
	inode_lock(d_inode(parent));
311
	dentry = lookup_one_len(name, parent, strlen(name));
312
	if (!IS_ERR(dentry) && d_really_is_positive(dentry)) {
313
		dput(dentry);
314 315
		dentry = ERR_PTR(-EEXIST);
	}
316 317

	if (IS_ERR(dentry)) {
A
Al Viro 已提交
318
		inode_unlock(d_inode(parent));
319 320 321
		simple_release_fs(&debugfs_mount, &debugfs_mount_count);
	}

322 323 324
	return dentry;
}

325
static struct dentry *failed_creating(struct dentry *dentry)
326
{
A
Al Viro 已提交
327
	inode_unlock(d_inode(dentry->d_parent));
328
	dput(dentry);
329 330 331
	simple_release_fs(&debugfs_mount, &debugfs_mount_count);
	return NULL;
}
L
Linus Torvalds 已提交
332

333 334
static struct dentry *end_creating(struct dentry *dentry)
{
A
Al Viro 已提交
335
	inode_unlock(d_inode(dentry->d_parent));
336 337 338
	return dentry;
}

339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
static struct dentry *__debugfs_create_file(const char *name, umode_t mode,
				struct dentry *parent, void *data,
				const struct file_operations *proxy_fops,
				const struct file_operations *real_fops)
{
	struct dentry *dentry;
	struct inode *inode;

	if (!(mode & S_IFMT))
		mode |= S_IFREG;
	BUG_ON(!S_ISREG(mode));
	dentry = start_creating(name, parent);

	if (IS_ERR(dentry))
		return NULL;

	inode = debugfs_get_inode(dentry->d_sb);
	if (unlikely(!inode))
		return failed_creating(dentry);

	inode->i_mode = mode;
	inode->i_private = data;

	inode->i_fop = proxy_fops;
	dentry->d_fsdata = (void *)real_fops;

	d_instantiate(dentry, inode);
	fsnotify_create(d_inode(dentry->d_parent), dentry);
	return end_creating(dentry);
}

L
Linus Torvalds 已提交
370 371 372
/**
 * debugfs_create_file - create a file in the debugfs filesystem
 * @name: a pointer to a string containing the name of the file to create.
373
 * @mode: the permission that the file should have.
L
Linus Torvalds 已提交
374
 * @parent: a pointer to the parent dentry for this file.  This should be a
375
 *          directory dentry if set.  If this parameter is NULL, then the
L
Linus Torvalds 已提交
376 377
 *          file will be created in the root of the debugfs filesystem.
 * @data: a pointer to something that the caller will want to get to later
378
 *        on.  The inode.i_private pointer will point to this value on
L
Linus Torvalds 已提交
379 380 381 382 383
 *        the open() call.
 * @fops: a pointer to a struct file_operations that should be used for
 *        this file.
 *
 * This is the basic "create a file" function for debugfs.  It allows for a
384 385
 * wide range of flexibility in creating a file, or a directory (if you want
 * to create a directory, the debugfs_create_dir() function is
L
Linus Torvalds 已提交
386 387 388 389 390
 * recommended to be used instead.)
 *
 * This function will return a pointer to a dentry if it succeeds.  This
 * pointer must be passed to the debugfs_remove() function when the file is
 * to be removed (no automatic cleanup happens if your module is unloaded,
391
 * you are responsible here.)  If an error occurs, %NULL will be returned.
L
Linus Torvalds 已提交
392
 *
393
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
394
 * returned.
L
Linus Torvalds 已提交
395
 */
A
Al Viro 已提交
396
struct dentry *debugfs_create_file(const char *name, umode_t mode,
L
Linus Torvalds 已提交
397
				   struct dentry *parent, void *data,
398
				   const struct file_operations *fops)
L
Linus Torvalds 已提交
399
{
A
Al Viro 已提交
400

401 402 403 404 405 406
	return __debugfs_create_file(name, mode, parent, data,
				fops ? &debugfs_full_proxy_file_operations :
					&debugfs_noop_file_operations,
				fops);
}
EXPORT_SYMBOL_GPL(debugfs_create_file);
407

408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
/**
 * debugfs_create_file_unsafe - create a file in the debugfs filesystem
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have.
 * @parent: a pointer to the parent dentry for this file.  This should be a
 *          directory dentry if set.  If this parameter is NULL, then the
 *          file will be created in the root of the debugfs filesystem.
 * @data: a pointer to something that the caller will want to get to later
 *        on.  The inode.i_private pointer will point to this value on
 *        the open() call.
 * @fops: a pointer to a struct file_operations that should be used for
 *        this file.
 *
 * debugfs_create_file_unsafe() is completely analogous to
 * debugfs_create_file(), the only difference being that the fops
 * handed it will not get protected against file removals by the
 * debugfs core.
 *
 * It is your responsibility to protect your struct file_operation
 * methods against file removals by means of debugfs_use_file_start()
 * and debugfs_use_file_finish(). ->open() is still protected by
 * debugfs though.
 *
 * Any struct file_operations defined by means of
 * DEFINE_DEBUGFS_ATTRIBUTE() is protected against file removals and
 * thus, may be used here.
 */
435 436 437 438
struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
				   struct dentry *parent, void *data,
				   const struct file_operations *fops)
{
439

440 441 442 443
	return __debugfs_create_file(name, mode, parent, data,
				fops ? &debugfs_open_proxy_file_operations :
					&debugfs_noop_file_operations,
				fops);
L
Linus Torvalds 已提交
444
}
445
EXPORT_SYMBOL_GPL(debugfs_create_file_unsafe);
L
Linus Torvalds 已提交
446

447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
/**
 * debugfs_create_file_size - create a file in the debugfs filesystem
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have.
 * @parent: a pointer to the parent dentry for this file.  This should be a
 *          directory dentry if set.  If this parameter is NULL, then the
 *          file will be created in the root of the debugfs filesystem.
 * @data: a pointer to something that the caller will want to get to later
 *        on.  The inode.i_private pointer will point to this value on
 *        the open() call.
 * @fops: a pointer to a struct file_operations that should be used for
 *        this file.
 * @file_size: initial file size
 *
 * This is the basic "create a file" function for debugfs.  It allows for a
 * wide range of flexibility in creating a file, or a directory (if you want
 * to create a directory, the debugfs_create_dir() function is
 * recommended to be used instead.)
 *
 * This function will return a pointer to a dentry if it succeeds.  This
 * pointer must be passed to the debugfs_remove() function when the file is
 * to be removed (no automatic cleanup happens if your module is unloaded,
 * you are responsible here.)  If an error occurs, %NULL will be returned.
 *
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 * returned.
 */
struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
					struct dentry *parent, void *data,
					const struct file_operations *fops,
					loff_t file_size)
{
	struct dentry *de = debugfs_create_file(name, mode, parent, data, fops);

	if (de)
482
		d_inode(de)->i_size = file_size;
483 484 485 486
	return de;
}
EXPORT_SYMBOL_GPL(debugfs_create_file_size);

L
Linus Torvalds 已提交
487 488 489 490 491
/**
 * debugfs_create_dir - create a directory in the debugfs filesystem
 * @name: a pointer to a string containing the name of the directory to
 *        create.
 * @parent: a pointer to the parent dentry for this file.  This should be a
492
 *          directory dentry if set.  If this parameter is NULL, then the
L
Linus Torvalds 已提交
493 494 495 496 497 498 499
 *          directory will be created in the root of the debugfs filesystem.
 *
 * This function creates a directory in debugfs with the given name.
 *
 * This function will return a pointer to a dentry if it succeeds.  This
 * pointer must be passed to the debugfs_remove() function when the file is
 * to be removed (no automatic cleanup happens if your module is unloaded,
500
 * you are responsible here.)  If an error occurs, %NULL will be returned.
L
Linus Torvalds 已提交
501
 *
502
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
503
 * returned.
L
Linus Torvalds 已提交
504 505 506
 */
struct dentry *debugfs_create_dir(const char *name, struct dentry *parent)
{
A
Al Viro 已提交
507
	struct dentry *dentry = start_creating(name, parent);
A
Al Viro 已提交
508
	struct inode *inode;
A
Al Viro 已提交
509 510 511 512

	if (IS_ERR(dentry))
		return NULL;

513
	inode = debugfs_get_inode(dentry->d_sb);
A
Al Viro 已提交
514
	if (unlikely(!inode))
515
		return failed_creating(dentry);
A
Al Viro 已提交
516

517 518 519 520 521 522
	inode->i_mode = S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO;
	inode->i_op = &simple_dir_inode_operations;
	inode->i_fop = &simple_dir_operations;

	/* directory inodes start off with i_nlink == 2 (for "." entry) */
	inc_nlink(inode);
A
Al Viro 已提交
523
	d_instantiate(dentry, inode);
524 525
	inc_nlink(d_inode(dentry->d_parent));
	fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
526
	return end_creating(dentry);
L
Linus Torvalds 已提交
527 528 529
}
EXPORT_SYMBOL_GPL(debugfs_create_dir);

530 531 532 533 534 535 536 537 538 539 540 541 542
/**
 * debugfs_create_automount - create automount point in the debugfs filesystem
 * @name: a pointer to a string containing the name of the file to create.
 * @parent: a pointer to the parent dentry for this file.  This should be a
 *          directory dentry if set.  If this parameter is NULL, then the
 *          file will be created in the root of the debugfs filesystem.
 * @f: function to be called when pathname resolution steps on that one.
 * @data: opaque argument to pass to f().
 *
 * @f should return what ->d_automount() would.
 */
struct dentry *debugfs_create_automount(const char *name,
					struct dentry *parent,
543
					debugfs_automount_t f,
544 545 546 547 548 549 550 551 552 553 554 555
					void *data)
{
	struct dentry *dentry = start_creating(name, parent);
	struct inode *inode;

	if (IS_ERR(dentry))
		return NULL;

	inode = debugfs_get_inode(dentry->d_sb);
	if (unlikely(!inode))
		return failed_creating(dentry);

556
	make_empty_dir_inode(inode);
557 558 559
	inode->i_flags |= S_AUTOMOUNT;
	inode->i_private = data;
	dentry->d_fsdata = (void *)f;
560 561
	/* directory inodes start off with i_nlink == 2 (for "." entry) */
	inc_nlink(inode);
562
	d_instantiate(dentry, inode);
563 564
	inc_nlink(d_inode(dentry->d_parent));
	fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
565 566 567 568
	return end_creating(dentry);
}
EXPORT_SYMBOL(debugfs_create_automount);

569 570 571 572 573
/**
 * debugfs_create_symlink- create a symbolic link in the debugfs filesystem
 * @name: a pointer to a string containing the name of the symbolic link to
 *        create.
 * @parent: a pointer to the parent dentry for this symbolic link.  This
574
 *          should be a directory dentry if set.  If this parameter is NULL,
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
 *          then the symbolic link will be created in the root of the debugfs
 *          filesystem.
 * @target: a pointer to a string containing the path to the target of the
 *          symbolic link.
 *
 * This function creates a symbolic link with the given name in debugfs that
 * links to the given target path.
 *
 * This function will return a pointer to a dentry if it succeeds.  This
 * pointer must be passed to the debugfs_remove() function when the symbolic
 * link is to be removed (no automatic cleanup happens if your module is
 * unloaded, you are responsible here.)  If an error occurs, %NULL will be
 * returned.
 *
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
590
 * returned.
591 592 593 594
 */
struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
				      const char *target)
{
A
Al Viro 已提交
595
	struct dentry *dentry;
A
Al Viro 已提交
596 597
	struct inode *inode;
	char *link = kstrdup(target, GFP_KERNEL);
598 599 600
	if (!link)
		return NULL;

A
Al Viro 已提交
601 602
	dentry = start_creating(name, parent);
	if (IS_ERR(dentry)) {
603
		kfree(link);
A
Al Viro 已提交
604 605 606
		return NULL;
	}

607
	inode = debugfs_get_inode(dentry->d_sb);
A
Al Viro 已提交
608
	if (unlikely(!inode)) {
A
Al Viro 已提交
609
		kfree(link);
610
		return failed_creating(dentry);
A
Al Viro 已提交
611
	}
612
	inode->i_mode = S_IFLNK | S_IRWXUGO;
613 614
	inode->i_op = &simple_symlink_inode_operations;
	inode->i_link = link;
A
Al Viro 已提交
615
	d_instantiate(dentry, inode);
616
	return end_creating(dentry);
617 618 619
}
EXPORT_SYMBOL_GPL(debugfs_create_symlink);

620
static int __debugfs_remove(struct dentry *dentry, struct dentry *parent)
621 622 623
{
	int ret = 0;

A
Al Viro 已提交
624
	if (simple_positive(dentry)) {
625
		dget(dentry);
626
		if (d_is_dir(dentry))
627
			ret = simple_rmdir(d_inode(parent), dentry);
628
		else
629
			simple_unlink(d_inode(parent), dentry);
630 631 632
		if (!ret)
			d_delete(dentry);
		dput(dentry);
633
	}
634
	return ret;
635 636
}

L
Linus Torvalds 已提交
637 638 639
/**
 * debugfs_remove - removes a file or directory from the debugfs filesystem
 * @dentry: a pointer to a the dentry of the file or directory to be
640 641
 *          removed.  If this parameter is NULL or an error value, nothing
 *          will be done.
L
Linus Torvalds 已提交
642 643 644
 *
 * This function removes a file or directory in debugfs that was previously
 * created with a call to another debugfs function (like
K
Komal Shah 已提交
645
 * debugfs_create_file() or variants thereof.)
L
Linus Torvalds 已提交
646 647 648 649 650 651 652 653
 *
 * This function is required to be called in order for the file to be
 * removed, no automatic cleanup of files will happen when a module is
 * removed, you are responsible here.
 */
void debugfs_remove(struct dentry *dentry)
{
	struct dentry *parent;
654 655
	int ret;

656
	if (IS_ERR_OR_NULL(dentry))
L
Linus Torvalds 已提交
657 658 659
		return;

	parent = dentry->d_parent;
A
Al Viro 已提交
660
	inode_lock(d_inode(parent));
661
	ret = __debugfs_remove(dentry, parent);
A
Al Viro 已提交
662
	inode_unlock(d_inode(parent));
663 664
	if (!ret)
		simple_release_fs(&debugfs_mount, &debugfs_mount_count);
665

666
	synchronize_srcu(&debugfs_srcu);
667 668 669 670 671
}
EXPORT_SYMBOL_GPL(debugfs_remove);

/**
 * debugfs_remove_recursive - recursively removes a directory
672 673
 * @dentry: a pointer to a the dentry of the directory to be removed.  If this
 *          parameter is NULL or an error value, nothing will be done.
674 675 676 677 678 679 680 681 682 683 684
 *
 * This function recursively removes a directory tree in debugfs that
 * was previously created with a call to another debugfs function
 * (like debugfs_create_file() or variants thereof.)
 *
 * This function is required to be called in order for the file to be
 * removed, no automatic cleanup of files will happen when a module is
 * removed, you are responsible here.
 */
void debugfs_remove_recursive(struct dentry *dentry)
{
685
	struct dentry *child, *parent;
686

687
	if (IS_ERR_OR_NULL(dentry))
688 689 690
		return;

	parent = dentry;
691
 down:
A
Al Viro 已提交
692
	inode_lock(d_inode(parent));
693 694 695 696 697 698 699
 loop:
	/*
	 * The parent->d_subdirs is protected by the d_lock. Outside that
	 * lock, the child can be unlinked and set to be freed which can
	 * use the d_u.d_child as the rcu head and corrupt this list.
	 */
	spin_lock(&parent->d_lock);
700
	list_for_each_entry(child, &parent->d_subdirs, d_child) {
A
Al Viro 已提交
701
		if (!simple_positive(child))
702
			continue;
703

704
		/* perhaps simple_empty(child) makes more sense */
705
		if (!list_empty(&child->d_subdirs)) {
706
			spin_unlock(&parent->d_lock);
A
Al Viro 已提交
707
			inode_unlock(d_inode(parent));
708
			parent = child;
709
			goto down;
L
Linus Torvalds 已提交
710
		}
711 712 713

		spin_unlock(&parent->d_lock);

714 715
		if (!__debugfs_remove(child, parent))
			simple_release_fs(&debugfs_mount, &debugfs_mount_count);
716 717 718 719 720 721

		/*
		 * The parent->d_lock protects agaist child from unlinking
		 * from d_subdirs. When releasing the parent->d_lock we can
		 * no longer trust that the next pointer is valid.
		 * Restart the loop. We'll skip this one with the
A
Al Viro 已提交
722
		 * simple_positive() check.
723 724
		 */
		goto loop;
L
Linus Torvalds 已提交
725
	}
726
	spin_unlock(&parent->d_lock);
727

A
Al Viro 已提交
728
	inode_unlock(d_inode(parent));
729 730
	child = parent;
	parent = parent->d_parent;
A
Al Viro 已提交
731
	inode_lock(d_inode(parent));
732

733 734 735
	if (child != dentry)
		/* go up */
		goto loop;
736 737 738

	if (!__debugfs_remove(child, parent))
		simple_release_fs(&debugfs_mount, &debugfs_mount_count);
A
Al Viro 已提交
739
	inode_unlock(d_inode(parent));
740

741
	synchronize_srcu(&debugfs_srcu);
L
Linus Torvalds 已提交
742
}
743
EXPORT_SYMBOL_GPL(debugfs_remove_recursive);
L
Linus Torvalds 已提交
744

J
Jan Kara 已提交
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
/**
 * debugfs_rename - rename a file/directory in the debugfs filesystem
 * @old_dir: a pointer to the parent dentry for the renamed object. This
 *          should be a directory dentry.
 * @old_dentry: dentry of an object to be renamed.
 * @new_dir: a pointer to the parent dentry where the object should be
 *          moved. This should be a directory dentry.
 * @new_name: a pointer to a string containing the target name.
 *
 * This function renames a file/directory in debugfs.  The target must not
 * exist for rename to succeed.
 *
 * This function will return a pointer to old_dentry (which is updated to
 * reflect renaming) if it succeeds. If an error occurs, %NULL will be
 * returned.
 *
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 * returned.
 */
struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
		struct dentry *new_dir, const char *new_name)
{
	int error;
	struct dentry *dentry = NULL, *trap;
	const char *old_name;

	trap = lock_rename(new_dir, old_dir);
	/* Source or destination directories don't exist? */
773
	if (d_really_is_negative(old_dir) || d_really_is_negative(new_dir))
J
Jan Kara 已提交
774 775
		goto exit;
	/* Source does not exist, cyclic rename, or mountpoint? */
776
	if (d_really_is_negative(old_dentry) || old_dentry == trap ||
J
Jan Kara 已提交
777 778 779 780
	    d_mountpoint(old_dentry))
		goto exit;
	dentry = lookup_one_len(new_name, new_dir, strlen(new_name));
	/* Lookup failed, cyclic rename or target exists? */
781
	if (IS_ERR(dentry) || dentry == trap || d_really_is_positive(dentry))
J
Jan Kara 已提交
782 783 784 785
		goto exit;

	old_name = fsnotify_oldname_init(old_dentry->d_name.name);

786
	error = simple_rename(d_inode(old_dir), old_dentry, d_inode(new_dir),
787
			      dentry, 0);
J
Jan Kara 已提交
788 789 790 791 792
	if (error) {
		fsnotify_oldname_free(old_name);
		goto exit;
	}
	d_move(old_dentry, dentry);
793
	fsnotify_move(d_inode(old_dir), d_inode(new_dir), old_name,
794
		d_is_dir(old_dentry),
795
		NULL, old_dentry);
J
Jan Kara 已提交
796 797 798 799 800 801 802 803 804 805 806 807
	fsnotify_oldname_free(old_name);
	unlock_rename(new_dir, old_dir);
	dput(dentry);
	return old_dentry;
exit:
	if (dentry && !IS_ERR(dentry))
		dput(dentry);
	unlock_rename(new_dir, old_dir);
	return NULL;
}
EXPORT_SYMBOL_GPL(debugfs_rename);

808 809 810 811 812 813 814 815 816
/**
 * debugfs_initialized - Tells whether debugfs has been registered
 */
bool debugfs_initialized(void)
{
	return debugfs_registered;
}
EXPORT_SYMBOL_GPL(debugfs_initialized);

L
Linus Torvalds 已提交
817 818 819 820
static int __init debugfs_init(void)
{
	int retval;

821 822 823
	retval = sysfs_create_mount_point(kernel_kobj, "debug");
	if (retval)
		return retval;
L
Linus Torvalds 已提交
824 825 826

	retval = register_filesystem(&debug_fs_type);
	if (retval)
827
		sysfs_remove_mount_point(kernel_kobj, "debug");
828 829 830
	else
		debugfs_registered = true;

L
Linus Torvalds 已提交
831 832 833 834
	return retval;
}
core_initcall(debugfs_init);