1 /* 2 * inode.c - part of debugfs, a tiny little debug file system 3 * 4 * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com> 5 * Copyright (C) 2004 IBM Inc. 6 * 7 * This program is free software; you can redistribute it and/or 8 * modify it under the terms of the GNU General Public License version 9 * 2 as published by the Free Software Foundation. 10 * 11 * debugfs is for people to use instead of /proc or /sys. 12 * See Documentation/DocBook/kernel-api for more details. 13 * 14 */ 15 16 #include <linux/module.h> 17 #include <linux/fs.h> 18 #include <linux/mount.h> 19 #include <linux/pagemap.h> 20 #include <linux/init.h> 21 #include <linux/kobject.h> 22 #include <linux/namei.h> 23 #include <linux/debugfs.h> 24 #include <linux/fsnotify.h> 25 #include <linux/string.h> 26 #include <linux/seq_file.h> 27 #include <linux/parser.h> 28 #include <linux/magic.h> 29 #include <linux/slab.h> 30 #include <linux/srcu.h> 31 32 #include "internal.h" 33 34 #define DEBUGFS_DEFAULT_MODE 0700 35 36 DEFINE_SRCU(debugfs_srcu); 37 38 static struct vfsmount *debugfs_mount; 39 static int debugfs_mount_count; 40 static bool debugfs_registered; 41 42 static struct inode *debugfs_get_inode(struct super_block *sb) 43 { 44 struct inode *inode = new_inode(sb); 45 if (inode) { 46 inode->i_ino = get_next_ino(); 47 inode->i_atime = inode->i_mtime = 48 inode->i_ctime = current_time(inode); 49 } 50 return inode; 51 } 52 53 struct debugfs_mount_opts { 54 kuid_t uid; 55 kgid_t gid; 56 umode_t mode; 57 }; 58 59 enum { 60 Opt_uid, 61 Opt_gid, 62 Opt_mode, 63 Opt_err 64 }; 65 66 static const match_table_t tokens = { 67 {Opt_uid, "uid=%u"}, 68 {Opt_gid, "gid=%u"}, 69 {Opt_mode, "mode=%o"}, 70 {Opt_err, NULL} 71 }; 72 73 struct debugfs_fs_info { 74 struct debugfs_mount_opts mount_opts; 75 }; 76 77 static int debugfs_parse_options(char *data, struct debugfs_mount_opts *opts) 78 { 79 substring_t args[MAX_OPT_ARGS]; 80 int option; 81 int token; 82 kuid_t uid; 83 kgid_t gid; 84 char *p; 85 86 opts->mode = DEBUGFS_DEFAULT_MODE; 87 88 while ((p = strsep(&data, ",")) != NULL) { 89 if (!*p) 90 continue; 91 92 token = match_token(p, tokens, args); 93 switch (token) { 94 case Opt_uid: 95 if (match_int(&args[0], &option)) 96 return -EINVAL; 97 uid = make_kuid(current_user_ns(), option); 98 if (!uid_valid(uid)) 99 return -EINVAL; 100 opts->uid = uid; 101 break; 102 case Opt_gid: 103 if (match_int(&args[0], &option)) 104 return -EINVAL; 105 gid = make_kgid(current_user_ns(), option); 106 if (!gid_valid(gid)) 107 return -EINVAL; 108 opts->gid = gid; 109 break; 110 case Opt_mode: 111 if (match_octal(&args[0], &option)) 112 return -EINVAL; 113 opts->mode = option & S_IALLUGO; 114 break; 115 /* 116 * We might like to report bad mount options here; 117 * but traditionally debugfs has ignored all mount options 118 */ 119 } 120 } 121 122 return 0; 123 } 124 125 static int debugfs_apply_options(struct super_block *sb) 126 { 127 struct debugfs_fs_info *fsi = sb->s_fs_info; 128 struct inode *inode = d_inode(sb->s_root); 129 struct debugfs_mount_opts *opts = &fsi->mount_opts; 130 131 inode->i_mode &= ~S_IALLUGO; 132 inode->i_mode |= opts->mode; 133 134 inode->i_uid = opts->uid; 135 inode->i_gid = opts->gid; 136 137 return 0; 138 } 139 140 static int debugfs_remount(struct super_block *sb, int *flags, char *data) 141 { 142 int err; 143 struct debugfs_fs_info *fsi = sb->s_fs_info; 144 145 sync_filesystem(sb); 146 err = debugfs_parse_options(data, &fsi->mount_opts); 147 if (err) 148 goto fail; 149 150 debugfs_apply_options(sb); 151 152 fail: 153 return err; 154 } 155 156 static int debugfs_show_options(struct seq_file *m, struct dentry *root) 157 { 158 struct debugfs_fs_info *fsi = root->d_sb->s_fs_info; 159 struct debugfs_mount_opts *opts = &fsi->mount_opts; 160 161 if (!uid_eq(opts->uid, GLOBAL_ROOT_UID)) 162 seq_printf(m, ",uid=%u", 163 from_kuid_munged(&init_user_ns, opts->uid)); 164 if (!gid_eq(opts->gid, GLOBAL_ROOT_GID)) 165 seq_printf(m, ",gid=%u", 166 from_kgid_munged(&init_user_ns, opts->gid)); 167 if (opts->mode != DEBUGFS_DEFAULT_MODE) 168 seq_printf(m, ",mode=%o", opts->mode); 169 170 return 0; 171 } 172 173 static void debugfs_evict_inode(struct inode *inode) 174 { 175 truncate_inode_pages_final(&inode->i_data); 176 clear_inode(inode); 177 if (S_ISLNK(inode->i_mode)) 178 kfree(inode->i_link); 179 } 180 181 static const struct super_operations debugfs_super_operations = { 182 .statfs = simple_statfs, 183 .remount_fs = debugfs_remount, 184 .show_options = debugfs_show_options, 185 .evict_inode = debugfs_evict_inode, 186 }; 187 188 static struct vfsmount *debugfs_automount(struct path *path) 189 { 190 debugfs_automount_t f; 191 f = (debugfs_automount_t)path->dentry->d_fsdata; 192 return f(path->dentry, d_inode(path->dentry)->i_private); 193 } 194 195 static const struct dentry_operations debugfs_dops = { 196 .d_delete = always_delete_dentry, 197 .d_automount = debugfs_automount, 198 }; 199 200 static int debug_fill_super(struct super_block *sb, void *data, int silent) 201 { 202 static struct tree_descr debug_files[] = {{""}}; 203 struct debugfs_fs_info *fsi; 204 int err; 205 206 save_mount_options(sb, data); 207 208 fsi = kzalloc(sizeof(struct debugfs_fs_info), GFP_KERNEL); 209 sb->s_fs_info = fsi; 210 if (!fsi) { 211 err = -ENOMEM; 212 goto fail; 213 } 214 215 err = debugfs_parse_options(data, &fsi->mount_opts); 216 if (err) 217 goto fail; 218 219 err = simple_fill_super(sb, DEBUGFS_MAGIC, debug_files); 220 if (err) 221 goto fail; 222 223 sb->s_op = &debugfs_super_operations; 224 sb->s_d_op = &debugfs_dops; 225 226 debugfs_apply_options(sb); 227 228 return 0; 229 230 fail: 231 kfree(fsi); 232 sb->s_fs_info = NULL; 233 return err; 234 } 235 236 static struct dentry *debug_mount(struct file_system_type *fs_type, 237 int flags, const char *dev_name, 238 void *data) 239 { 240 return mount_single(fs_type, flags, data, debug_fill_super); 241 } 242 243 static struct file_system_type debug_fs_type = { 244 .owner = THIS_MODULE, 245 .name = "debugfs", 246 .mount = debug_mount, 247 .kill_sb = kill_litter_super, 248 }; 249 MODULE_ALIAS_FS("debugfs"); 250 251 /** 252 * debugfs_lookup() - look up an existing debugfs file 253 * @name: a pointer to a string containing the name of the file to look up. 254 * @parent: a pointer to the parent dentry of the file. 255 * 256 * This function will return a pointer to a dentry if it succeeds. If the file 257 * doesn't exist or an error occurs, %NULL will be returned. The returned 258 * dentry must be passed to dput() when it is no longer needed. 259 * 260 * If debugfs is not enabled in the kernel, the value -%ENODEV will be 261 * returned. 262 */ 263 struct dentry *debugfs_lookup(const char *name, struct dentry *parent) 264 { 265 struct dentry *dentry; 266 267 if (IS_ERR(parent)) 268 return NULL; 269 270 if (!parent) 271 parent = debugfs_mount->mnt_root; 272 273 inode_lock(d_inode(parent)); 274 dentry = lookup_one_len(name, parent, strlen(name)); 275 inode_unlock(d_inode(parent)); 276 277 if (IS_ERR(dentry)) 278 return NULL; 279 if (!d_really_is_positive(dentry)) { 280 dput(dentry); 281 return NULL; 282 } 283 return dentry; 284 } 285 EXPORT_SYMBOL_GPL(debugfs_lookup); 286 287 static struct dentry *start_creating(const char *name, struct dentry *parent) 288 { 289 struct dentry *dentry; 290 int error; 291 292 pr_debug("debugfs: creating file '%s'\n",name); 293 294 if (IS_ERR(parent)) 295 return parent; 296 297 error = simple_pin_fs(&debug_fs_type, &debugfs_mount, 298 &debugfs_mount_count); 299 if (error) 300 return ERR_PTR(error); 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 304 * block. A pointer to that is in the struct vfsmount that we 305 * have around. 306 */ 307 if (!parent) 308 parent = debugfs_mount->mnt_root; 309 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 dentry = ERR_PTR(-EEXIST); 315 } 316 317 if (IS_ERR(dentry)) { 318 inode_unlock(d_inode(parent)); 319 simple_release_fs(&debugfs_mount, &debugfs_mount_count); 320 } 321 322 return dentry; 323 } 324 325 static struct dentry *failed_creating(struct dentry *dentry) 326 { 327 inode_unlock(d_inode(dentry->d_parent)); 328 dput(dentry); 329 simple_release_fs(&debugfs_mount, &debugfs_mount_count); 330 return NULL; 331 } 332 333 static struct dentry *end_creating(struct dentry *dentry) 334 { 335 inode_unlock(d_inode(dentry->d_parent)); 336 return dentry; 337 } 338 339 static struct dentry *__debugfs_create_file(const char *name, umode_t mode, 340 struct dentry *parent, void *data, 341 const struct file_operations *proxy_fops, 342 const struct file_operations *real_fops) 343 { 344 struct dentry *dentry; 345 struct inode *inode; 346 347 if (!(mode & S_IFMT)) 348 mode |= S_IFREG; 349 BUG_ON(!S_ISREG(mode)); 350 dentry = start_creating(name, parent); 351 352 if (IS_ERR(dentry)) 353 return NULL; 354 355 inode = debugfs_get_inode(dentry->d_sb); 356 if (unlikely(!inode)) 357 return failed_creating(dentry); 358 359 inode->i_mode = mode; 360 inode->i_private = data; 361 362 inode->i_fop = proxy_fops; 363 dentry->d_fsdata = (void *)real_fops; 364 365 d_instantiate(dentry, inode); 366 fsnotify_create(d_inode(dentry->d_parent), dentry); 367 return end_creating(dentry); 368 } 369 370 /** 371 * debugfs_create_file - create a file in the debugfs filesystem 372 * @name: a pointer to a string containing the name of the file to create. 373 * @mode: the permission that the file should have. 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 376 * file will be created in the root of the debugfs filesystem. 377 * @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 379 * the open() call. 380 * @fops: a pointer to a struct file_operations that should be used for 381 * this file. 382 * 383 * This is the basic "create a file" function for debugfs. It allows for a 384 * wide range of flexibility in creating a file, or a directory (if you want 385 * to create a directory, the debugfs_create_dir() function is 386 * recommended to be used instead.) 387 * 388 * This function will return a pointer to a dentry if it succeeds. This 389 * pointer must be passed to the debugfs_remove() function when the file is 390 * 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. 392 * 393 * If debugfs is not enabled in the kernel, the value -%ENODEV will be 394 * returned. 395 */ 396 struct dentry *debugfs_create_file(const char *name, umode_t mode, 397 struct dentry *parent, void *data, 398 const struct file_operations *fops) 399 { 400 401 return __debugfs_create_file(name, mode, parent, data, 402 fops ? &debugfs_full_proxy_file_operations : 403 &debugfs_noop_file_operations, 404 fops); 405 } 406 EXPORT_SYMBOL_GPL(debugfs_create_file); 407 408 /** 409 * debugfs_create_file_unsafe - create a file in the debugfs filesystem 410 * @name: a pointer to a string containing the name of the file to create. 411 * @mode: the permission that the file should have. 412 * @parent: a pointer to the parent dentry for this file. This should be a 413 * directory dentry if set. If this parameter is NULL, then the 414 * file will be created in the root of the debugfs filesystem. 415 * @data: a pointer to something that the caller will want to get to later 416 * on. The inode.i_private pointer will point to this value on 417 * the open() call. 418 * @fops: a pointer to a struct file_operations that should be used for 419 * this file. 420 * 421 * debugfs_create_file_unsafe() is completely analogous to 422 * debugfs_create_file(), the only difference being that the fops 423 * handed it will not get protected against file removals by the 424 * debugfs core. 425 * 426 * It is your responsibility to protect your struct file_operation 427 * methods against file removals by means of debugfs_use_file_start() 428 * and debugfs_use_file_finish(). ->open() is still protected by 429 * debugfs though. 430 * 431 * Any struct file_operations defined by means of 432 * DEFINE_DEBUGFS_ATTRIBUTE() is protected against file removals and 433 * thus, may be used here. 434 */ 435 struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode, 436 struct dentry *parent, void *data, 437 const struct file_operations *fops) 438 { 439 440 return __debugfs_create_file(name, mode, parent, data, 441 fops ? &debugfs_open_proxy_file_operations : 442 &debugfs_noop_file_operations, 443 fops); 444 } 445 EXPORT_SYMBOL_GPL(debugfs_create_file_unsafe); 446 447 /** 448 * debugfs_create_file_size - create a file in the debugfs filesystem 449 * @name: a pointer to a string containing the name of the file to create. 450 * @mode: the permission that the file should have. 451 * @parent: a pointer to the parent dentry for this file. This should be a 452 * directory dentry if set. If this parameter is NULL, then the 453 * file will be created in the root of the debugfs filesystem. 454 * @data: a pointer to something that the caller will want to get to later 455 * on. The inode.i_private pointer will point to this value on 456 * the open() call. 457 * @fops: a pointer to a struct file_operations that should be used for 458 * this file. 459 * @file_size: initial file size 460 * 461 * This is the basic "create a file" function for debugfs. It allows for a 462 * wide range of flexibility in creating a file, or a directory (if you want 463 * to create a directory, the debugfs_create_dir() function is 464 * recommended to be used instead.) 465 * 466 * This function will return a pointer to a dentry if it succeeds. This 467 * pointer must be passed to the debugfs_remove() function when the file is 468 * to be removed (no automatic cleanup happens if your module is unloaded, 469 * you are responsible here.) If an error occurs, %NULL will be returned. 470 * 471 * If debugfs is not enabled in the kernel, the value -%ENODEV will be 472 * returned. 473 */ 474 struct dentry *debugfs_create_file_size(const char *name, umode_t mode, 475 struct dentry *parent, void *data, 476 const struct file_operations *fops, 477 loff_t file_size) 478 { 479 struct dentry *de = debugfs_create_file(name, mode, parent, data, fops); 480 481 if (de) 482 d_inode(de)->i_size = file_size; 483 return de; 484 } 485 EXPORT_SYMBOL_GPL(debugfs_create_file_size); 486 487 /** 488 * debugfs_create_dir - create a directory in the debugfs filesystem 489 * @name: a pointer to a string containing the name of the directory to 490 * create. 491 * @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 493 * directory will be created in the root of the debugfs filesystem. 494 * 495 * This function creates a directory in debugfs with the given name. 496 * 497 * This function will return a pointer to a dentry if it succeeds. This 498 * pointer must be passed to the debugfs_remove() function when the file is 499 * 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. 501 * 502 * If debugfs is not enabled in the kernel, the value -%ENODEV will be 503 * returned. 504 */ 505 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent) 506 { 507 struct dentry *dentry = start_creating(name, parent); 508 struct inode *inode; 509 510 if (IS_ERR(dentry)) 511 return NULL; 512 513 inode = debugfs_get_inode(dentry->d_sb); 514 if (unlikely(!inode)) 515 return failed_creating(dentry); 516 517 inode->i_mode = S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO; 518 inode->i_op = &simple_dir_inode_operations; 519 inode->i_fop = &simple_dir_operations; 520 521 /* directory inodes start off with i_nlink == 2 (for "." entry) */ 522 inc_nlink(inode); 523 d_instantiate(dentry, inode); 524 inc_nlink(d_inode(dentry->d_parent)); 525 fsnotify_mkdir(d_inode(dentry->d_parent), dentry); 526 return end_creating(dentry); 527 } 528 EXPORT_SYMBOL_GPL(debugfs_create_dir); 529 530 /** 531 * debugfs_create_automount - create automount point in the debugfs filesystem 532 * @name: a pointer to a string containing the name of the file to create. 533 * @parent: a pointer to the parent dentry for this file. This should be a 534 * directory dentry if set. If this parameter is NULL, then the 535 * file will be created in the root of the debugfs filesystem. 536 * @f: function to be called when pathname resolution steps on that one. 537 * @data: opaque argument to pass to f(). 538 * 539 * @f should return what ->d_automount() would. 540 */ 541 struct dentry *debugfs_create_automount(const char *name, 542 struct dentry *parent, 543 debugfs_automount_t f, 544 void *data) 545 { 546 struct dentry *dentry = start_creating(name, parent); 547 struct inode *inode; 548 549 if (IS_ERR(dentry)) 550 return NULL; 551 552 inode = debugfs_get_inode(dentry->d_sb); 553 if (unlikely(!inode)) 554 return failed_creating(dentry); 555 556 make_empty_dir_inode(inode); 557 inode->i_flags |= S_AUTOMOUNT; 558 inode->i_private = data; 559 dentry->d_fsdata = (void *)f; 560 /* directory inodes start off with i_nlink == 2 (for "." entry) */ 561 inc_nlink(inode); 562 d_instantiate(dentry, inode); 563 inc_nlink(d_inode(dentry->d_parent)); 564 fsnotify_mkdir(d_inode(dentry->d_parent), dentry); 565 return end_creating(dentry); 566 } 567 EXPORT_SYMBOL(debugfs_create_automount); 568 569 /** 570 * debugfs_create_symlink- create a symbolic link in the debugfs filesystem 571 * @name: a pointer to a string containing the name of the symbolic link to 572 * create. 573 * @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 * then the symbolic link will be created in the root of the debugfs 576 * filesystem. 577 * @target: a pointer to a string containing the path to the target of the 578 * symbolic link. 579 * 580 * This function creates a symbolic link with the given name in debugfs that 581 * links to the given target path. 582 * 583 * This function will return a pointer to a dentry if it succeeds. This 584 * pointer must be passed to the debugfs_remove() function when the symbolic 585 * link is to be removed (no automatic cleanup happens if your module is 586 * unloaded, you are responsible here.) If an error occurs, %NULL will be 587 * returned. 588 * 589 * If debugfs is not enabled in the kernel, the value -%ENODEV will be 590 * returned. 591 */ 592 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent, 593 const char *target) 594 { 595 struct dentry *dentry; 596 struct inode *inode; 597 char *link = kstrdup(target, GFP_KERNEL); 598 if (!link) 599 return NULL; 600 601 dentry = start_creating(name, parent); 602 if (IS_ERR(dentry)) { 603 kfree(link); 604 return NULL; 605 } 606 607 inode = debugfs_get_inode(dentry->d_sb); 608 if (unlikely(!inode)) { 609 kfree(link); 610 return failed_creating(dentry); 611 } 612 inode->i_mode = S_IFLNK | S_IRWXUGO; 613 inode->i_op = &simple_symlink_inode_operations; 614 inode->i_link = link; 615 d_instantiate(dentry, inode); 616 return end_creating(dentry); 617 } 618 EXPORT_SYMBOL_GPL(debugfs_create_symlink); 619 620 static int __debugfs_remove(struct dentry *dentry, struct dentry *parent) 621 { 622 int ret = 0; 623 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 if (!ret) 631 d_delete(dentry); 632 dput(dentry); 633 } 634 return ret; 635 } 636 637 /** 638 * debugfs_remove - removes a file or directory from the debugfs filesystem 639 * @dentry: a pointer to a the dentry of the file or directory to be 640 * removed. If this parameter is NULL or an error value, nothing 641 * will be done. 642 * 643 * This function removes a file or directory in debugfs that was previously 644 * created with a call to another debugfs function (like 645 * debugfs_create_file() or variants thereof.) 646 * 647 * This function is required to be called in order for the file to be 648 * removed, no automatic cleanup of files will happen when a module is 649 * removed, you are responsible here. 650 */ 651 void debugfs_remove(struct dentry *dentry) 652 { 653 struct dentry *parent; 654 int ret; 655 656 if (IS_ERR_OR_NULL(dentry)) 657 return; 658 659 parent = dentry->d_parent; 660 inode_lock(d_inode(parent)); 661 ret = __debugfs_remove(dentry, parent); 662 inode_unlock(d_inode(parent)); 663 if (!ret) 664 simple_release_fs(&debugfs_mount, &debugfs_mount_count); 665 666 synchronize_srcu(&debugfs_srcu); 667 } 668 EXPORT_SYMBOL_GPL(debugfs_remove); 669 670 /** 671 * debugfs_remove_recursive - recursively removes a directory 672 * @dentry: a pointer to a the dentry of the directory to be removed. If this 673 * parameter is NULL or an error value, nothing will be done. 674 * 675 * This function recursively removes a directory tree in debugfs that 676 * was previously created with a call to another debugfs function 677 * (like debugfs_create_file() or variants thereof.) 678 * 679 * This function is required to be called in order for the file to be 680 * removed, no automatic cleanup of files will happen when a module is 681 * removed, you are responsible here. 682 */ 683 void debugfs_remove_recursive(struct dentry *dentry) 684 { 685 struct dentry *child, *parent; 686 687 if (IS_ERR_OR_NULL(dentry)) 688 return; 689 690 parent = dentry; 691 down: 692 inode_lock(d_inode(parent)); 693 loop: 694 /* 695 * The parent->d_subdirs is protected by the d_lock. Outside that 696 * lock, the child can be unlinked and set to be freed which can 697 * use the d_u.d_child as the rcu head and corrupt this list. 698 */ 699 spin_lock(&parent->d_lock); 700 list_for_each_entry(child, &parent->d_subdirs, d_child) { 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); 707 inode_unlock(d_inode(parent)); 708 parent = child; 709 goto down; 710 } 711 712 spin_unlock(&parent->d_lock); 713 714 if (!__debugfs_remove(child, parent)) 715 simple_release_fs(&debugfs_mount, &debugfs_mount_count); 716 717 /* 718 * The parent->d_lock protects agaist child from unlinking 719 * from d_subdirs. When releasing the parent->d_lock we can 720 * no longer trust that the next pointer is valid. 721 * Restart the loop. We'll skip this one with the 722 * simple_positive() check. 723 */ 724 goto loop; 725 } 726 spin_unlock(&parent->d_lock); 727 728 inode_unlock(d_inode(parent)); 729 child = parent; 730 parent = parent->d_parent; 731 inode_lock(d_inode(parent)); 732 733 if (child != dentry) 734 /* go up */ 735 goto loop; 736 737 if (!__debugfs_remove(child, parent)) 738 simple_release_fs(&debugfs_mount, &debugfs_mount_count); 739 inode_unlock(d_inode(parent)); 740 741 synchronize_srcu(&debugfs_srcu); 742 } 743 EXPORT_SYMBOL_GPL(debugfs_remove_recursive); 744 745 /** 746 * debugfs_rename - rename a file/directory in the debugfs filesystem 747 * @old_dir: a pointer to the parent dentry for the renamed object. This 748 * should be a directory dentry. 749 * @old_dentry: dentry of an object to be renamed. 750 * @new_dir: a pointer to the parent dentry where the object should be 751 * moved. This should be a directory dentry. 752 * @new_name: a pointer to a string containing the target name. 753 * 754 * This function renames a file/directory in debugfs. The target must not 755 * exist for rename to succeed. 756 * 757 * This function will return a pointer to old_dentry (which is updated to 758 * reflect renaming) if it succeeds. If an error occurs, %NULL will be 759 * returned. 760 * 761 * If debugfs is not enabled in the kernel, the value -%ENODEV will be 762 * returned. 763 */ 764 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry, 765 struct dentry *new_dir, const char *new_name) 766 { 767 int error; 768 struct dentry *dentry = NULL, *trap; 769 const char *old_name; 770 771 trap = lock_rename(new_dir, old_dir); 772 /* Source or destination directories don't exist? */ 773 if (d_really_is_negative(old_dir) || d_really_is_negative(new_dir)) 774 goto exit; 775 /* Source does not exist, cyclic rename, or mountpoint? */ 776 if (d_really_is_negative(old_dentry) || old_dentry == trap || 777 d_mountpoint(old_dentry)) 778 goto exit; 779 dentry = lookup_one_len(new_name, new_dir, strlen(new_name)); 780 /* Lookup failed, cyclic rename or target exists? */ 781 if (IS_ERR(dentry) || dentry == trap || d_really_is_positive(dentry)) 782 goto exit; 783 784 old_name = fsnotify_oldname_init(old_dentry->d_name.name); 785 786 error = simple_rename(d_inode(old_dir), old_dentry, d_inode(new_dir), 787 dentry, 0); 788 if (error) { 789 fsnotify_oldname_free(old_name); 790 goto exit; 791 } 792 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); 796 fsnotify_oldname_free(old_name); 797 unlock_rename(new_dir, old_dir); 798 dput(dentry); 799 return old_dentry; 800 exit: 801 if (dentry && !IS_ERR(dentry)) 802 dput(dentry); 803 unlock_rename(new_dir, old_dir); 804 return NULL; 805 } 806 EXPORT_SYMBOL_GPL(debugfs_rename); 807 808 /** 809 * debugfs_initialized - Tells whether debugfs has been registered 810 */ 811 bool debugfs_initialized(void) 812 { 813 return debugfs_registered; 814 } 815 EXPORT_SYMBOL_GPL(debugfs_initialized); 816 817 static int __init debugfs_init(void) 818 { 819 int retval; 820 821 retval = sysfs_create_mount_point(kernel_kobj, "debug"); 822 if (retval) 823 return retval; 824 825 retval = register_filesystem(&debug_fs_type); 826 if (retval) 827 sysfs_remove_mount_point(kernel_kobj, "debug"); 828 else 829 debugfs_registered = true; 830 831 return retval; 832 } 833 core_initcall(debugfs_init); 834 835