inode.c 15.2 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>
M
Mimi Zohar 已提交
26
#include <linux/magic.h>
27
#include <linux/slab.h>
L
Linus Torvalds 已提交
28 29 30

static struct vfsmount *debugfs_mount;
static int debugfs_mount_count;
31
static bool debugfs_registered;
L
Linus Torvalds 已提交
32

33 34 35
static struct inode *debugfs_get_inode(struct super_block *sb, int mode, dev_t dev,
				       void *data, const struct file_operations *fops)

L
Linus Torvalds 已提交
36 37 38 39
{
	struct inode *inode = new_inode(sb);

	if (inode) {
40
		inode->i_ino = get_next_ino();
L
Linus Torvalds 已提交
41 42 43 44 45 46 47
		inode->i_mode = mode;
		inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
		switch (mode & S_IFMT) {
		default:
			init_special_inode(inode, mode, dev);
			break;
		case S_IFREG:
48 49
			inode->i_fop = fops ? fops : &debugfs_file_operations;
			inode->i_private = data;
L
Linus Torvalds 已提交
50
			break;
51 52
		case S_IFLNK:
			inode->i_op = &debugfs_link_operations;
53 54
			inode->i_fop = fops;
			inode->i_private = data;
55
			break;
L
Linus Torvalds 已提交
56 57
		case S_IFDIR:
			inode->i_op = &simple_dir_inode_operations;
58 59
			inode->i_fop = fops ? fops : &simple_dir_operations;
			inode->i_private = data;
L
Linus Torvalds 已提交
60

M
Mathieu Desnoyers 已提交
61 62
			/* directory inodes start off with i_nlink == 2
			 * (for "." entry) */
63
			inc_nlink(inode);
L
Linus Torvalds 已提交
64 65 66 67 68 69 70 71
			break;
		}
	}
	return inode; 
}

/* SMP-safe */
static int debugfs_mknod(struct inode *dir, struct dentry *dentry,
72 73
			 int mode, dev_t dev, void *data,
			 const struct file_operations *fops)
L
Linus Torvalds 已提交
74
{
J
Jens Axboe 已提交
75
	struct inode *inode;
L
Linus Torvalds 已提交
76 77 78 79 80
	int error = -EPERM;

	if (dentry->d_inode)
		return -EEXIST;

81
	inode = debugfs_get_inode(dir->i_sb, mode, dev, data, fops);
L
Linus Torvalds 已提交
82 83 84 85 86 87 88 89
	if (inode) {
		d_instantiate(dentry, inode);
		dget(dentry);
		error = 0;
	}
	return error;
}

90 91
static int debugfs_mkdir(struct inode *dir, struct dentry *dentry, int mode,
			 void *data, const struct file_operations *fops)
L
Linus Torvalds 已提交
92 93 94 95
{
	int res;

	mode = (mode & (S_IRWXUGO | S_ISVTX)) | S_IFDIR;
96
	res = debugfs_mknod(dir, dentry, mode, 0, data, fops);
97
	if (!res) {
98
		inc_nlink(dir);
99 100
		fsnotify_mkdir(dir, dentry);
	}
L
Linus Torvalds 已提交
101 102 103
	return res;
}

104 105
static int debugfs_link(struct inode *dir, struct dentry *dentry, int mode,
			void *data, const struct file_operations *fops)
106 107
{
	mode = (mode & S_IALLUGO) | S_IFLNK;
108
	return debugfs_mknod(dir, dentry, mode, 0, data, fops);
109 110
}

111 112
static int debugfs_create(struct inode *dir, struct dentry *dentry, int mode,
			  void *data, const struct file_operations *fops)
L
Linus Torvalds 已提交
113
{
114 115
	int res;

L
Linus Torvalds 已提交
116
	mode = (mode & S_IALLUGO) | S_IFREG;
117
	res = debugfs_mknod(dir, dentry, mode, 0, data, fops);
118 119 120
	if (!res)
		fsnotify_create(dir, dentry);
	return res;
L
Linus Torvalds 已提交
121 122 123 124 125 126 127 128 129 130 131 132 133 134
}

static inline int debugfs_positive(struct dentry *dentry)
{
	return dentry->d_inode && !d_unhashed(dentry);
}

static int debug_fill_super(struct super_block *sb, void *data, int silent)
{
	static struct tree_descr debug_files[] = {{""}};

	return simple_fill_super(sb, DEBUGFS_MAGIC, debug_files);
}

A
Al Viro 已提交
135
static struct dentry *debug_mount(struct file_system_type *fs_type,
136
			int flags, const char *dev_name,
A
Al Viro 已提交
137
			void *data)
L
Linus Torvalds 已提交
138
{
A
Al Viro 已提交
139
	return mount_single(fs_type, flags, data, debug_fill_super);
L
Linus Torvalds 已提交
140 141 142 143 144
}

static struct file_system_type debug_fs_type = {
	.owner =	THIS_MODULE,
	.name =		"debugfs",
A
Al Viro 已提交
145
	.mount =	debug_mount,
L
Linus Torvalds 已提交
146 147 148 149 150
	.kill_sb =	kill_litter_super,
};

static int debugfs_create_by_name(const char *name, mode_t mode,
				  struct dentry *parent,
151 152 153
				  struct dentry **dentry,
				  void *data,
				  const struct file_operations *fops)
L
Linus Torvalds 已提交
154 155 156 157 158 159 160 161
{
	int error = 0;

	/* If the parent is not specified, we create it in the root.
	 * We need the root dentry to do this, which is in the super 
	 * block. A pointer to that is in the struct vfsmount that we
	 * have around.
	 */
162 163
	if (!parent)
		parent = debugfs_mount->mnt_sb->s_root;
L
Linus Torvalds 已提交
164 165

	*dentry = NULL;
166
	mutex_lock(&parent->d_inode->i_mutex);
167
	*dentry = lookup_one_len(name, parent, strlen(name));
168
	if (!IS_ERR(*dentry)) {
169 170
		switch (mode & S_IFMT) {
		case S_IFDIR:
171 172
			error = debugfs_mkdir(parent->d_inode, *dentry, mode,
					      data, fops);
173 174
			break;
		case S_IFLNK:
175 176
			error = debugfs_link(parent->d_inode, *dentry, mode,
					     data, fops);
177 178
			break;
		default:
179 180
			error = debugfs_create(parent->d_inode, *dentry, mode,
					       data, fops);
181 182
			break;
		}
183
		dput(*dentry);
L
Linus Torvalds 已提交
184
	} else
185
		error = PTR_ERR(*dentry);
186
	mutex_unlock(&parent->d_inode->i_mutex);
L
Linus Torvalds 已提交
187 188 189 190 191 192 193

	return error;
}

/**
 * debugfs_create_file - create a file in the debugfs filesystem
 * @name: a pointer to a string containing the name of the file to create.
194
 * @mode: the permission that the file should have.
L
Linus Torvalds 已提交
195 196 197 198
 * @parent: a pointer to the parent dentry for this file.  This should be a
 *          directory dentry if set.  If this paramater 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
199
 *        on.  The inode.i_private pointer will point to this value on
L
Linus Torvalds 已提交
200 201 202 203 204
 *        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
205 206
 * 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 已提交
207 208 209 210 211
 * 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,
212
 * you are responsible here.)  If an error occurs, %NULL will be returned.
L
Linus Torvalds 已提交
213
 *
214
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
215
 * returned.
L
Linus Torvalds 已提交
216 217 218
 */
struct dentry *debugfs_create_file(const char *name, mode_t mode,
				   struct dentry *parent, void *data,
219
				   const struct file_operations *fops)
L
Linus Torvalds 已提交
220 221 222 223 224 225
{
	struct dentry *dentry = NULL;
	int error;

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

226 227
	error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
			      &debugfs_mount_count);
L
Linus Torvalds 已提交
228 229 230
	if (error)
		goto exit;

231 232
	error = debugfs_create_by_name(name, mode, parent, &dentry,
				       data, fops);
L
Linus Torvalds 已提交
233 234
	if (error) {
		dentry = NULL;
235
		simple_release_fs(&debugfs_mount, &debugfs_mount_count);
L
Linus Torvalds 已提交
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
		goto exit;
	}
exit:
	return dentry;
}
EXPORT_SYMBOL_GPL(debugfs_create_file);

/**
 * 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
 *          directory dentry if set.  If this paramater is NULL, then the
 *          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,
256
 * you are responsible here.)  If an error occurs, %NULL will be returned.
L
Linus Torvalds 已提交
257
 *
258
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
259
 * returned.
L
Linus Torvalds 已提交
260 261 262 263 264 265 266 267 268
 */
struct dentry *debugfs_create_dir(const char *name, struct dentry *parent)
{
	return debugfs_create_file(name, 
				   S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO,
				   parent, NULL, NULL);
}
EXPORT_SYMBOL_GPL(debugfs_create_dir);

269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
/**
 * 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
 *          should be a directory dentry if set.  If this paramater is NULL,
 *          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
290
 * returned.
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
 */
struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
				      const char *target)
{
	struct dentry *result;
	char *link;

	link = kstrdup(target, GFP_KERNEL);
	if (!link)
		return NULL;

	result = debugfs_create_file(name, S_IFLNK | S_IRWXUGO, parent, link,
				     NULL);
	if (!result)
		kfree(link);
	return result;
}
EXPORT_SYMBOL_GPL(debugfs_create_symlink);

310
static int __debugfs_remove(struct dentry *dentry, struct dentry *parent)
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
{
	int ret = 0;

	if (debugfs_positive(dentry)) {
		if (dentry->d_inode) {
			dget(dentry);
			switch (dentry->d_inode->i_mode & S_IFMT) {
			case S_IFDIR:
				ret = simple_rmdir(parent->d_inode, dentry);
				break;
			case S_IFLNK:
				kfree(dentry->d_inode->i_private);
				/* fall through */
			default:
				simple_unlink(parent->d_inode, dentry);
				break;
			}
			if (!ret)
				d_delete(dentry);
			dput(dentry);
		}
	}
333
	return ret;
334 335
}

L
Linus Torvalds 已提交
336 337 338 339 340 341 342
/**
 * 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
 *          removed.
 *
 * This function removes a file or directory in debugfs that was previously
 * created with a call to another debugfs function (like
K
Komal Shah 已提交
343
 * debugfs_create_file() or variants thereof.)
L
Linus Torvalds 已提交
344 345 346 347 348 349 350 351
 *
 * 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;
352 353
	int ret;

L
Linus Torvalds 已提交
354 355 356 357 358 359 360
	if (!dentry)
		return;

	parent = dentry->d_parent;
	if (!parent || !parent->d_inode)
		return;

361
	mutex_lock(&parent->d_inode->i_mutex);
362
	ret = __debugfs_remove(dentry, parent);
363
	mutex_unlock(&parent->d_inode->i_mutex);
364 365
	if (!ret)
		simple_release_fs(&debugfs_mount, &debugfs_mount_count);
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
}
EXPORT_SYMBOL_GPL(debugfs_remove);

/**
 * debugfs_remove_recursive - recursively removes a directory
 * @dentry: a pointer to a the dentry of the directory to be removed.
 *
 * 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)
{
	struct dentry *child;
	struct dentry *parent;

	if (!dentry)
		return;

	parent = dentry->d_parent;
	if (!parent || !parent->d_inode)
		return;

	parent = dentry;
	mutex_lock(&parent->d_inode->i_mutex);

	while (1) {
		/*
		 * When all dentries under "parent" has been removed,
		 * walk up the tree until we reach our starting point.
		 */
		if (list_empty(&parent->d_subdirs)) {
			mutex_unlock(&parent->d_inode->i_mutex);
			if (parent == dentry)
404
				break;
405 406 407 408 409
			parent = parent->d_parent;
			mutex_lock(&parent->d_inode->i_mutex);
		}
		child = list_entry(parent->d_subdirs.next, struct dentry,
				d_u.d_child);
410
 next_sibling:
411 412 413 414 415 416 417 418 419 420

		/*
		 * If "child" isn't empty, walk down the tree and
		 * remove all its descendants first.
		 */
		if (!list_empty(&child->d_subdirs)) {
			mutex_unlock(&parent->d_inode->i_mutex);
			parent = child;
			mutex_lock(&parent->d_inode->i_mutex);
			continue;
L
Linus Torvalds 已提交
421
		}
422 423
		__debugfs_remove(child, parent);
		if (parent->d_subdirs.next == &child->d_u.d_child) {
424 425 426 427 428 429 430 431 432 433
			/*
			 * Try the next sibling.
			 */
			if (child->d_u.d_child.next != &parent->d_subdirs) {
				child = list_entry(child->d_u.d_child.next,
						   struct dentry,
						   d_u.d_child);
				goto next_sibling;
			}

434 435 436 437 438 439 440 441
			/*
			 * Avoid infinite loop if we fail to remove
			 * one dentry.
			 */
			mutex_unlock(&parent->d_inode->i_mutex);
			break;
		}
		simple_release_fs(&debugfs_mount, &debugfs_mount_count);
L
Linus Torvalds 已提交
442
	}
443 444 445 446

	parent = dentry->d_parent;
	mutex_lock(&parent->d_inode->i_mutex);
	__debugfs_remove(dentry, parent);
447
	mutex_unlock(&parent->d_inode->i_mutex);
L
Linus Torvalds 已提交
448 449
	simple_release_fs(&debugfs_mount, &debugfs_mount_count);
}
450
EXPORT_SYMBOL_GPL(debugfs_remove_recursive);
L
Linus Torvalds 已提交
451

J
Jan Kara 已提交
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 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
/**
 * 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? */
	if (!old_dir->d_inode || !new_dir->d_inode)
		goto exit;
	/* Source does not exist, cyclic rename, or mountpoint? */
	if (!old_dentry->d_inode || old_dentry == trap ||
	    d_mountpoint(old_dentry))
		goto exit;
	dentry = lookup_one_len(new_name, new_dir, strlen(new_name));
	/* Lookup failed, cyclic rename or target exists? */
	if (IS_ERR(dentry) || dentry == trap || dentry->d_inode)
		goto exit;

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

	error = simple_rename(old_dir->d_inode, old_dentry, new_dir->d_inode,
		dentry);
	if (error) {
		fsnotify_oldname_free(old_name);
		goto exit;
	}
	d_move(old_dentry, dentry);
	fsnotify_move(old_dir->d_inode, new_dir->d_inode, old_name,
501
		S_ISDIR(old_dentry->d_inode->i_mode),
502
		NULL, old_dentry);
J
Jan Kara 已提交
503 504 505 506 507 508 509 510 511 512 513 514
	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);

515 516 517 518 519 520 521 522 523 524
/**
 * debugfs_initialized - Tells whether debugfs has been registered
 */
bool debugfs_initialized(void)
{
	return debugfs_registered;
}
EXPORT_SYMBOL_GPL(debugfs_initialized);


525
static struct kobject *debug_kobj;
L
Linus Torvalds 已提交
526 527 528 529 530

static int __init debugfs_init(void)
{
	int retval;

531
	debug_kobj = kobject_create_and_add("debug", kernel_kobj);
532 533
	if (!debug_kobj)
		return -EINVAL;
L
Linus Torvalds 已提交
534 535 536

	retval = register_filesystem(&debug_fs_type);
	if (retval)
537
		kobject_put(debug_kobj);
538 539 540
	else
		debugfs_registered = true;

L
Linus Torvalds 已提交
541 542 543 544
	return retval;
}
core_initcall(debugfs_init);