inode.c 12.7 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/*
 *  file.c - part of debugfs, a tiny little debug file system
 *
 *  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.
 *
 */

/* uncomment to get debug messages from the debug filesystem, ah the irony. */
/* #define DEBUG */

#include <linux/module.h>
#include <linux/fs.h>
#include <linux/mount.h>
#include <linux/pagemap.h>
#include <linux/init.h>
R
Randy Dunlap 已提交
24
#include <linux/kobject.h>
L
Linus Torvalds 已提交
25 26
#include <linux/namei.h>
#include <linux/debugfs.h>
27
#include <linux/fsnotify.h>
28
#include <linux/string.h>
L
Linus Torvalds 已提交
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51

#define DEBUGFS_MAGIC	0x64626720

static struct vfsmount *debugfs_mount;
static int debugfs_mount_count;

static struct inode *debugfs_get_inode(struct super_block *sb, int mode, dev_t dev)
{
	struct inode *inode = new_inode(sb);

	if (inode) {
		inode->i_mode = mode;
		inode->i_uid = 0;
		inode->i_gid = 0;
		inode->i_blocks = 0;
		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:
			inode->i_fop = &debugfs_file_operations;
			break;
52 53 54
		case S_IFLNK:
			inode->i_op = &debugfs_link_operations;
			break;
L
Linus Torvalds 已提交
55 56 57 58
		case S_IFDIR:
			inode->i_op = &simple_dir_inode_operations;
			inode->i_fop = &simple_dir_operations;

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

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

	if (dentry->d_inode)
		return -EEXIST;

J
Jens Axboe 已提交
78
	inode = debugfs_get_inode(dir->i_sb, mode, dev);
L
Linus Torvalds 已提交
79 80 81 82 83 84 85 86 87 88 89 90 91 92
	if (inode) {
		d_instantiate(dentry, inode);
		dget(dentry);
		error = 0;
	}
	return error;
}

static int debugfs_mkdir(struct inode *dir, struct dentry *dentry, int mode)
{
	int res;

	mode = (mode & (S_IRWXUGO | S_ISVTX)) | S_IFDIR;
	res = debugfs_mknod(dir, dentry, mode, 0);
93
	if (!res) {
94
		inc_nlink(dir);
95 96
		fsnotify_mkdir(dir, dentry);
	}
L
Linus Torvalds 已提交
97 98 99
	return res;
}

100 101 102 103 104 105
static int debugfs_link(struct inode *dir, struct dentry *dentry, int mode)
{
	mode = (mode & S_IALLUGO) | S_IFLNK;
	return debugfs_mknod(dir, dentry, mode, 0);
}

L
Linus Torvalds 已提交
106 107
static int debugfs_create(struct inode *dir, struct dentry *dentry, int mode)
{
108 109
	int res;

L
Linus Torvalds 已提交
110
	mode = (mode & S_IALLUGO) | S_IFREG;
111 112 113 114
	res = debugfs_mknod(dir, dentry, mode, 0);
	if (!res)
		fsnotify_create(dir, dentry);
	return res;
L
Linus Torvalds 已提交
115 116 117 118 119 120 121 122 123 124 125 126 127 128
}

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);
}

129 130 131
static int debug_get_sb(struct file_system_type *fs_type,
			int flags, const char *dev_name,
			void *data, struct vfsmount *mnt)
L
Linus Torvalds 已提交
132
{
133
	return get_sb_single(fs_type, flags, data, debug_fill_super, mnt);
L
Linus Torvalds 已提交
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
}

static struct file_system_type debug_fs_type = {
	.owner =	THIS_MODULE,
	.name =		"debugfs",
	.get_sb =	debug_get_sb,
	.kill_sb =	kill_litter_super,
};

static int debugfs_create_by_name(const char *name, mode_t mode,
				  struct dentry *parent,
				  struct dentry **dentry)
{
	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.
	 */
M
Mathieu Desnoyers 已提交
154
	if (!parent) {
L
Linus Torvalds 已提交
155 156 157 158 159 160 161 162 163 164
		if (debugfs_mount && debugfs_mount->mnt_sb) {
			parent = debugfs_mount->mnt_sb->s_root;
		}
	}
	if (!parent) {
		pr_debug("debugfs: Ah! can not find a parent!\n");
		return -EFAULT;
	}

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

	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.
 * @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 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
195
 *        on.  The inode.i_private pointer will point to this value on
L
Linus Torvalds 已提交
196 197 198 199 200 201 202 203 204 205 206 207
 *        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
 * wide range of flexibility in createing 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,
208
 * you are responsible here.)  If an error occurs, %NULL will be returned.
L
Linus Torvalds 已提交
209
 *
210
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
211
 * returned.
L
Linus Torvalds 已提交
212 213 214
 */
struct dentry *debugfs_create_file(const char *name, mode_t mode,
				   struct dentry *parent, void *data,
215
				   const struct file_operations *fops)
L
Linus Torvalds 已提交
216 217 218 219 220 221
{
	struct dentry *dentry = NULL;
	int error;

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

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

	error = debugfs_create_by_name(name, mode, parent, &dentry);
	if (error) {
		dentry = NULL;
230
		simple_release_fs(&debugfs_mount, &debugfs_mount_count);
L
Linus Torvalds 已提交
231 232 233 234 235
		goto exit;
	}

	if (dentry->d_inode) {
		if (data)
236
			dentry->d_inode->i_private = data;
L
Linus Torvalds 已提交
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
		if (fops)
			dentry->d_inode->i_fop = fops;
	}
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,
258
 * you are responsible here.)  If an error occurs, %NULL will be returned.
L
Linus Torvalds 已提交
259
 *
260
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
261
 * returned.
L
Linus Torvalds 已提交
262 263 264 265 266 267 268 269 270
 */
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);

271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
/**
 * 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
292
 * returned.
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
 */
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);

L
Linus Torvalds 已提交
312 313 314 315 316 317 318
/**
 * 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 已提交
319
 * debugfs_create_file() or variants thereof.)
L
Linus Torvalds 已提交
320 321 322 323 324 325 326 327
 *
 * 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;
328
	int ret = 0;
L
Linus Torvalds 已提交
329 330 331 332 333 334 335 336
	
	if (!dentry)
		return;

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

337
	mutex_lock(&parent->d_inode->i_mutex);
L
Linus Torvalds 已提交
338 339
	if (debugfs_positive(dentry)) {
		if (dentry->d_inode) {
340
			dget(dentry);
341 342
			switch (dentry->d_inode->i_mode & S_IFMT) {
			case S_IFDIR:
343
				ret = simple_rmdir(parent->d_inode, dentry);
344 345 346 347 348
				break;
			case S_IFLNK:
				kfree(dentry->d_inode->i_private);
				/* fall through */
			default:
L
Linus Torvalds 已提交
349
				simple_unlink(parent->d_inode, dentry);
350 351
				break;
			}
352 353 354
			if (!ret)
				d_delete(dentry);
			dput(dentry);
L
Linus Torvalds 已提交
355 356
		}
	}
357
	mutex_unlock(&parent->d_inode->i_mutex);
L
Linus Torvalds 已提交
358 359 360 361
	simple_release_fs(&debugfs_mount, &debugfs_mount_count);
}
EXPORT_SYMBOL_GPL(debugfs_remove);

J
Jan Kara 已提交
362 363 364 365 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 404 405 406 407 408 409 410 411
/**
 * 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,
		old_dentry->d_name.name, S_ISDIR(old_dentry->d_inode->i_mode),
412
		NULL, old_dentry);
J
Jan Kara 已提交
413 414 415 416 417 418 419 420 421 422 423 424
	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);

425
static struct kobject *debug_kobj;
L
Linus Torvalds 已提交
426 427 428 429 430

static int __init debugfs_init(void)
{
	int retval;

431
	debug_kobj = kobject_create_and_add("debug", kernel_kobj);
432 433
	if (!debug_kobj)
		return -EINVAL;
L
Linus Torvalds 已提交
434 435 436

	retval = register_filesystem(&debug_fs_type);
	if (retval)
437
		kobject_put(debug_kobj);
L
Linus Torvalds 已提交
438 439 440 441 442 443 444
	return retval;
}

static void __exit debugfs_exit(void)
{
	simple_release_fs(&debugfs_mount, &debugfs_mount_count);
	unregister_filesystem(&debug_fs_type);
445
	kobject_put(debug_kobj);
L
Linus Torvalds 已提交
446 447 448 449 450 451
}

core_initcall(debugfs_init);
module_exit(debugfs_exit);
MODULE_LICENSE("GPL");