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
 *
 *  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.
12
 *  See ./Documentation/core-api/kernel-api.rst for more details.
L
Linus Torvalds 已提交
13 14 15 16 17 18 19 20
 *
 */

#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
	struct debugfs_fs_info *fsi;
	int err;

	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;
222
	sb->s_d_op = &debugfs_dops;
223 224 225 226

	debugfs_apply_options(sb);

	return 0;
L
Linus Torvalds 已提交
227

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

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

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

O
Omar Sandoval 已提交
249 250 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
/**
 * 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);

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

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

292 293 294
	if (IS_ERR(parent))
		return parent;

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

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

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

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

320 321 322
	return dentry;
}

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

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

337 338 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
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 已提交
368 369 370
/**
 * debugfs_create_file - create a file in the debugfs filesystem
 * @name: a pointer to a string containing the name of the file to create.
371
 * @mode: the permission that the file should have.
L
Linus Torvalds 已提交
372
 * @parent: a pointer to the parent dentry for this file.  This should be a
373
 *          directory dentry if set.  If this parameter is NULL, then the
L
Linus Torvalds 已提交
374 375
 *          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
376
 *        on.  The inode.i_private pointer will point to this value on
L
Linus Torvalds 已提交
377 378 379 380 381
 *        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
382 383
 * 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 已提交
384 385 386 387 388
 * 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,
389
 * you are responsible here.)  If an error occurs, %NULL will be returned.
L
Linus Torvalds 已提交
390
 *
391
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
392
 * returned.
L
Linus Torvalds 已提交
393
 */
A
Al Viro 已提交
394
struct dentry *debugfs_create_file(const char *name, umode_t mode,
L
Linus Torvalds 已提交
395
				   struct dentry *parent, void *data,
396
				   const struct file_operations *fops)
L
Linus Torvalds 已提交
397
{
A
Al Viro 已提交
398

399 400 401 402 403 404
	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);
405

406 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
/**
 * 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.
 */
433 434 435 436
struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
				   struct dentry *parent, void *data,
				   const struct file_operations *fops)
{
437

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

445 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
/**
 * 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)
480
		d_inode(de)->i_size = file_size;
481 482 483 484
	return de;
}
EXPORT_SYMBOL_GPL(debugfs_create_file_size);

L
Linus Torvalds 已提交
485 486 487 488 489
/**
 * 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
490
 *          directory dentry if set.  If this parameter is NULL, then the
L
Linus Torvalds 已提交
491 492 493 494 495 496 497
 *          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,
498
 * you are responsible here.)  If an error occurs, %NULL will be returned.
L
Linus Torvalds 已提交
499
 *
500
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
501
 * returned.
L
Linus Torvalds 已提交
502 503 504
 */
struct dentry *debugfs_create_dir(const char *name, struct dentry *parent)
{
A
Al Viro 已提交
505
	struct dentry *dentry = start_creating(name, parent);
A
Al Viro 已提交
506
	struct inode *inode;
A
Al Viro 已提交
507 508 509 510

	if (IS_ERR(dentry))
		return NULL;

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

515 516 517 518 519 520
	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 已提交
521
	d_instantiate(dentry, inode);
522 523
	inc_nlink(d_inode(dentry->d_parent));
	fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
524
	return end_creating(dentry);
L
Linus Torvalds 已提交
525 526 527
}
EXPORT_SYMBOL_GPL(debugfs_create_dir);

528 529 530 531 532 533 534 535 536 537 538 539 540
/**
 * 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,
541
					debugfs_automount_t f,
542 543 544 545 546 547 548 549 550 551 552 553
					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);

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

567 568 569 570 571
/**
 * 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
572
 *          should be a directory dentry if set.  If this parameter is NULL,
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
 *          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
588
 * returned.
589 590 591 592
 */
struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
				      const char *target)
{
A
Al Viro 已提交
593
	struct dentry *dentry;
A
Al Viro 已提交
594 595
	struct inode *inode;
	char *link = kstrdup(target, GFP_KERNEL);
596 597 598
	if (!link)
		return NULL;

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

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

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

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

L
Linus Torvalds 已提交
635 636 637
/**
 * 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
638 639
 *          removed.  If this parameter is NULL or an error value, nothing
 *          will be done.
L
Linus Torvalds 已提交
640 641 642
 *
 * This function removes a file or directory in debugfs that was previously
 * created with a call to another debugfs function (like
K
Komal Shah 已提交
643
 * debugfs_create_file() or variants thereof.)
L
Linus Torvalds 已提交
644 645 646 647 648 649 650 651
 *
 * 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;
652 653
	int ret;

654
	if (IS_ERR_OR_NULL(dentry))
L
Linus Torvalds 已提交
655 656 657
		return;

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

664
	synchronize_srcu(&debugfs_srcu);
665 666 667 668 669
}
EXPORT_SYMBOL_GPL(debugfs_remove);

/**
 * debugfs_remove_recursive - recursively removes a directory
670 671
 * @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.
672 673 674 675 676 677 678 679 680 681 682
 *
 * 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)
{
683
	struct dentry *child, *parent;
684

685
	if (IS_ERR_OR_NULL(dentry))
686 687 688
		return;

	parent = dentry;
689
 down:
A
Al Viro 已提交
690
	inode_lock(d_inode(parent));
691 692 693 694 695 696 697
 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);
698
	list_for_each_entry(child, &parent->d_subdirs, d_child) {
A
Al Viro 已提交
699
		if (!simple_positive(child))
700
			continue;
701

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

		spin_unlock(&parent->d_lock);

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

		/*
		 * 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 已提交
720
		 * simple_positive() check.
721 722
		 */
		goto loop;
L
Linus Torvalds 已提交
723
	}
724
	spin_unlock(&parent->d_lock);
725

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

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

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

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

J
Jan Kara 已提交
743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
/**
 * 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;
A
Al Viro 已提交
767
	struct name_snapshot old_name;
J
Jan Kara 已提交
768 769 770

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

A
Al Viro 已提交
782
	take_dentry_name_snapshot(&old_name, old_dentry);
J
Jan Kara 已提交
783

784
	error = simple_rename(d_inode(old_dir), old_dentry, d_inode(new_dir),
785
			      dentry, 0);
J
Jan Kara 已提交
786
	if (error) {
A
Al Viro 已提交
787
		release_dentry_name_snapshot(&old_name);
J
Jan Kara 已提交
788 789 790
		goto exit;
	}
	d_move(old_dentry, dentry);
A
Al Viro 已提交
791
	fsnotify_move(d_inode(old_dir), d_inode(new_dir), old_name.name,
792
		d_is_dir(old_dentry),
793
		NULL, old_dentry);
A
Al Viro 已提交
794
	release_dentry_name_snapshot(&old_name);
J
Jan Kara 已提交
795 796 797 798 799 800 801 802 803 804 805
	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);

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

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

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

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

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