fs/debugfs/inode.c

   1 /*
   2  *  file.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 /* uncomment to get debug messages from the debug filesystem, ah the irony. */
  17 /* #define DEBUG */
  18
  19 #include <linux/module.h>
  20 #include <linux/fs.h>
  21 #include <linux/mount.h>
  22 #include <linux/pagemap.h>
  23 #include <linux/init.h>
  24 #include <linux/kobject.h>
  25 #include <linux/namei.h>
  26 #include <linux/debugfs.h>
  27 #include <linux/fsnotify.h>
  28 #include <linux/string.h>
  29 #include <linux/magic.h>
  30
  31 static struct vfsmount *debugfs_mount;
  32 static int debugfs_mount_count;
  33 static bool debugfs_registered;
  34
  35 static struct inode *debugfs_get_inode(struct super_block *sb, int mode, dev_t dev,
  36                                        void *data, const struct file_operations *fops)
  37
  38 {
  39         struct inode *inode = new_inode(sb);
  40
  41         if (inode) {
  42                 inode->i_mode = mode;
  43                 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
  44                 switch (mode & S_IFMT) {
  45                 default:
  46                         init_special_inode(inode, mode, dev);
  47                         break;
  48                 case S_IFREG:
  49                         inode->i_fop = fops ? fops : &debugfs_file_operations;
  50                         inode->i_private = data;
  51                         break;
  52                 case S_IFLNK:
  53                         inode->i_op = &debugfs_link_operations;
  54                         inode->i_fop = fops;
  55                         inode->i_private = data;
  56                         break;
  57                 case S_IFDIR:
  58                         inode->i_op = &simple_dir_inode_operations;
  59                         inode->i_fop = fops ? fops : &simple_dir_operations;
  60                         inode->i_private = data;
  61
  62                         /* directory inodes start off with i_nlink == 2
  63                          * (for "." entry) */
  64                         inc_nlink(inode);
  65                         break;
  66                 }
  67         }
  68         return inode;
  69 }
  70
  71 /* SMP-safe */
  72 static int debugfs_mknod(struct inode *dir, struct dentry *dentry,
  73                          int mode, dev_t dev, void *data,
  74                          const struct file_operations *fops)
  75 {
  76         struct inode *inode;
  77         int error = -EPERM;
  78
  79         if (dentry->d_inode)
  80                 return -EEXIST;
  81
  82         inode = debugfs_get_inode(dir->i_sb, mode, dev, data, fops);
  83         if (inode) {
  84                 d_instantiate(dentry, inode);
  85                 dget(dentry);
  86                 error = 0;
  87         }
  88         return error;
  89 }
  90
  91 static int debugfs_mkdir(struct inode *dir, struct dentry *dentry, int mode,
  92                          void *data, const struct file_operations *fops)
  93 {
  94         int res;
  95
  96         mode = (mode & (S_IRWXUGO | S_ISVTX)) | S_IFDIR;
  97         res = debugfs_mknod(dir, dentry, mode, 0, data, fops);
  98         if (!res) {
  99                 inc_nlink(dir);
 100                 fsnotify_mkdir(dir, dentry);
 101         }
 102         return res;
 103 }
 104
 105 static int debugfs_link(struct inode *dir, struct dentry *dentry, int mode,
 106                         void *data, const struct file_operations *fops)
 107 {
 108         mode = (mode & S_IALLUGO) | S_IFLNK;
 109         return debugfs_mknod(dir, dentry, mode, 0, data, fops);
 110 }
 111
 112 static int debugfs_create(struct inode *dir, struct dentry *dentry, int mode,
 113                           void *data, const struct file_operations *fops)
 114 {
 115         int res;
 116
 117         mode = (mode & S_IALLUGO) | S_IFREG;
 118         res = debugfs_mknod(dir, dentry, mode, 0, data, fops);
 119         if (!res)
 120                 fsnotify_create(dir, dentry);
 121         return res;
 122 }
 123
 124 static inline int debugfs_positive(struct dentry *dentry)
 125 {
 126         return dentry->d_inode && !d_unhashed(dentry);
 127 }
 128
 129 static int debug_fill_super(struct super_block *sb, void *data, int silent)
 130 {
 131         static struct tree_descr debug_files[] = {{""}};
 132
 133         return simple_fill_super(sb, DEBUGFS_MAGIC, debug_files);
 134 }
 135
 136 static int debug_get_sb(struct file_system_type *fs_type,
 137                         int flags, const char *dev_name,
 138                         void *data, struct vfsmount *mnt)
 139 {
 140         return get_sb_single(fs_type, flags, data, debug_fill_super, mnt);
 141 }
 142
 143 static struct file_system_type debug_fs_type = {
 144         .owner =        THIS_MODULE,
 145         .name =         "debugfs",
 146         .get_sb =       debug_get_sb,
 147         .kill_sb =      kill_litter_super,
 148 };
 149
 150 static int debugfs_create_by_name(const char *name, mode_t mode,
 151                                   struct dentry *parent,
 152                                   struct dentry **dentry,
 153                                   void *data,
 154                                   const struct file_operations *fops)
 155 {
 156         int error = 0;
 157
 158         /* If the parent is not specified, we create it in the root.
 159          * We need the root dentry to do this, which is in the super
 160          * block. A pointer to that is in the struct vfsmount that we
 161          * have around.
 162          */
 163         if (!parent)
 164                 parent = debugfs_mount->mnt_sb->s_root;
 165
 166         *dentry = NULL;
 167         mutex_lock(&parent->d_inode->i_mutex);
 168         *dentry = lookup_one_len(name, parent, strlen(name));
 169         if (!IS_ERR(*dentry)) {
 170                 switch (mode & S_IFMT) {
 171                 case S_IFDIR:
 172                         error = debugfs_mkdir(parent->d_inode, *dentry, mode,
 173                                               data, fops);
 174                         break;
 175                 case S_IFLNK:
 176                         error = debugfs_link(parent->d_inode, *dentry, mode,
 177                                              data, fops);
 178                         break;
 179                 default:
 180                         error = debugfs_create(parent->d_inode, *dentry, mode,
 181                                                data, fops);
 182                         break;
 183                 }
 184                 dput(*dentry);
 185         } else
 186                 error = PTR_ERR(*dentry);
 187         mutex_unlock(&parent->d_inode->i_mutex);
 188
 189         return error;
 190 }
 191
 192 /**
 193  * debugfs_create_file - create a file in the debugfs filesystem
 194  * @name: a pointer to a string containing the name of the file to create.
 195  * @mode: the permission that the file should have.
 196  * @parent: a pointer to the parent dentry for this file.  This should be a
 197  *          directory dentry if set.  If this paramater is NULL, then the
 198  *          file will be created in the root of the debugfs filesystem.
 199  * @data: a pointer to something that the caller will want to get to later
 200  *        on.  The inode.i_private pointer will point to this value on
 201  *        the open() call.
 202  * @fops: a pointer to a struct file_operations that should be used for
 203  *        this file.
 204  *
 205  * This is the basic "create a file" function for debugfs.  It allows for a
 206  * wide range of flexibility in creating a file, or a directory (if you want
 207  * to create a directory, the debugfs_create_dir() function is
 208  * recommended to be used instead.)
 209  *
 210  * This function will return a pointer to a dentry if it succeeds.  This
 211  * pointer must be passed to the debugfs_remove() function when the file is
 212  * to be removed (no automatic cleanup happens if your module is unloaded,
 213  * you are responsible here.)  If an error occurs, %NULL will be returned.
 214  *
 215  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 216  * returned.
 217  */
 218 struct dentry *debugfs_create_file(const char *name, mode_t mode,
 219                                    struct dentry *parent, void *data,
 220                                    const struct file_operations *fops)
 221 {
 222         struct dentry *dentry = NULL;
 223         int error;
 224
 225         pr_debug("debugfs: creating file '%s'\n",name);
 226
 227         error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
 228                               &debugfs_mount_count);
 229         if (error)
 230                 goto exit;
 231
 232         error = debugfs_create_by_name(name, mode, parent, &dentry,
 233                                        data, fops);
 234         if (error) {
 235                 dentry = NULL;
 236                 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
 237                 goto exit;
 238         }
 239 exit:
 240         return dentry;
 241 }
 242 EXPORT_SYMBOL_GPL(debugfs_create_file);
 243
 244 /**
 245  * debugfs_create_dir - create a directory in the debugfs filesystem
 246  * @name: a pointer to a string containing the name of the directory to
 247  *        create.
 248  * @parent: a pointer to the parent dentry for this file.  This should be a
 249  *          directory dentry if set.  If this paramater is NULL, then the
 250  *          directory will be created in the root of the debugfs filesystem.
 251  *
 252  * This function creates a directory in debugfs with the given name.
 253  *
 254  * This function will return a pointer to a dentry if it succeeds.  This
 255  * pointer must be passed to the debugfs_remove() function when the file is
 256  * to be removed (no automatic cleanup happens if your module is unloaded,
 257  * you are responsible here.)  If an error occurs, %NULL will be returned.
 258  *
 259  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 260  * returned.
 261  */
 262 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent)
 263 {
 264         return debugfs_create_file(name,
 265                                    S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO,
 266                                    parent, NULL, NULL);
 267 }
 268 EXPORT_SYMBOL_GPL(debugfs_create_dir);
 269
 270 /**
 271  * debugfs_create_symlink- create a symbolic link in the debugfs filesystem
 272  * @name: a pointer to a string containing the name of the symbolic link to
 273  *        create.
 274  * @parent: a pointer to the parent dentry for this symbolic link.  This
 275  *          should be a directory dentry if set.  If this paramater is NULL,
 276  *          then the symbolic link will be created in the root of the debugfs
 277  *          filesystem.
 278  * @target: a pointer to a string containing the path to the target of the
 279  *          symbolic link.
 280  *
 281  * This function creates a symbolic link with the given name in debugfs that
 282  * links to the given target path.
 283  *
 284  * This function will return a pointer to a dentry if it succeeds.  This
 285  * pointer must be passed to the debugfs_remove() function when the symbolic
 286  * link is to be removed (no automatic cleanup happens if your module is
 287  * unloaded, you are responsible here.)  If an error occurs, %NULL will be
 288  * returned.
 289  *
 290  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 291  * returned.
 292  */
 293 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
 294                                       const char *target)
 295 {
 296         struct dentry *result;
 297         char *link;
 298
 299         link = kstrdup(target, GFP_KERNEL);
 300         if (!link)
 301                 return NULL;
 302
 303         result = debugfs_create_file(name, S_IFLNK | S_IRWXUGO, parent, link,
 304                                      NULL);
 305         if (!result)
 306                 kfree(link);
 307         return result;
 308 }
 309 EXPORT_SYMBOL_GPL(debugfs_create_symlink);
 310
 311 static void __debugfs_remove(struct dentry *dentry, struct dentry *parent)
 312 {
 313         int ret = 0;
 314
 315         if (debugfs_positive(dentry)) {
 316                 if (dentry->d_inode) {
 317                         dget(dentry);
 318                         switch (dentry->d_inode->i_mode & S_IFMT) {
 319                         case S_IFDIR:
 320                                 ret = simple_rmdir(parent->d_inode, dentry);
 321                                 break;
 322                         case S_IFLNK:
 323                                 kfree(dentry->d_inode->i_private);
 324                                 /* fall through */
 325                         default:
 326                                 simple_unlink(parent->d_inode, dentry);
 327                                 break;
 328                         }
 329                         if (!ret)
 330                                 d_delete(dentry);
 331                         dput(dentry);
 332                 }
 333         }
 334 }
 335
 336 /**
 337  * debugfs_remove - removes a file or directory from the debugfs filesystem
 338  * @dentry: a pointer to a the dentry of the file or directory to be
 339  *          removed.
 340  *
 341  * This function removes a file or directory in debugfs that was previously
 342  * created with a call to another debugfs function (like
 343  * debugfs_create_file() or variants thereof.)
 344  *
 345  * This function is required to be called in order for the file to be
 346  * removed, no automatic cleanup of files will happen when a module is
 347  * removed, you are responsible here.
 348  */
 349 void debugfs_remove(struct dentry *dentry)
 350 {
 351         struct dentry *parent;
 352
 353         if (!dentry)
 354                 return;
 355
 356         parent = dentry->d_parent;
 357         if (!parent || !parent->d_inode)
 358                 return;
 359
 360         mutex_lock(&parent->d_inode->i_mutex);
 361         __debugfs_remove(dentry, parent);
 362         mutex_unlock(&parent->d_inode->i_mutex);
 363         simple_release_fs(&debugfs_mount, &debugfs_mount_count);
 364 }
 365 EXPORT_SYMBOL_GPL(debugfs_remove);
 366
 367 /**
 368  * debugfs_remove_recursive - recursively removes a directory
 369  * @dentry: a pointer to a the dentry of the directory to be removed.
 370  *
 371  * This function recursively removes a directory tree in debugfs that
 372  * was previously created with a call to another debugfs function
 373  * (like debugfs_create_file() or variants thereof.)
 374  *
 375  * This function is required to be called in order for the file to be
 376  * removed, no automatic cleanup of files will happen when a module is
 377  * removed, you are responsible here.
 378  */
 379 void debugfs_remove_recursive(struct dentry *dentry)
 380 {
 381         struct dentry *child;
 382         struct dentry *parent;
 383
 384         if (!dentry)
 385                 return;
 386
 387         parent = dentry->d_parent;
 388         if (!parent || !parent->d_inode)
 389                 return;
 390
 391         parent = dentry;
 392         mutex_lock(&parent->d_inode->i_mutex);
 393
 394         while (1) {
 395                 /*
 396                  * When all dentries under "parent" has been removed,
 397                  * walk up the tree until we reach our starting point.
 398                  */
 399                 if (list_empty(&parent->d_subdirs)) {
 400                         mutex_unlock(&parent->d_inode->i_mutex);
 401                         if (parent == dentry)
 402                                 break;
 403                         parent = parent->d_parent;
 404                         mutex_lock(&parent->d_inode->i_mutex);
 405                 }
 406                 child = list_entry(parent->d_subdirs.next, struct dentry,
 407                                 d_u.d_child);
 408  next_sibling:
 409
 410                 /*
 411                  * If "child" isn't empty, walk down the tree and
 412                  * remove all its descendants first.
 413                  */
 414                 if (!list_empty(&child->d_subdirs)) {
 415                         mutex_unlock(&parent->d_inode->i_mutex);
 416                         parent = child;
 417                         mutex_lock(&parent->d_inode->i_mutex);
 418                         continue;
 419                 }
 420                 __debugfs_remove(child, parent);
 421                 if (parent->d_subdirs.next == &child->d_u.d_child) {
 422                         /*
 423                          * Try the next sibling.
 424                          */
 425                         if (child->d_u.d_child.next != &parent->d_subdirs) {
 426                                 child = list_entry(child->d_u.d_child.next,
 427                                                    struct dentry,
 428                                                    d_u.d_child);
 429                                 goto next_sibling;
 430                         }
 431
 432                         /*
 433                          * Avoid infinite loop if we fail to remove
 434                          * one dentry.
 435                          */
 436                         mutex_unlock(&parent->d_inode->i_mutex);
 437                         break;
 438                 }
 439                 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
 440         }
 441
 442         parent = dentry->d_parent;
 443         mutex_lock(&parent->d_inode->i_mutex);
 444         __debugfs_remove(dentry, parent);
 445         mutex_unlock(&parent->d_inode->i_mutex);
 446         simple_release_fs(&debugfs_mount, &debugfs_mount_count);
 447 }
 448 EXPORT_SYMBOL_GPL(debugfs_remove_recursive);
 449
 450 /**
 451  * debugfs_rename - rename a file/directory in the debugfs filesystem
 452  * @old_dir: a pointer to the parent dentry for the renamed object. This
 453  *          should be a directory dentry.
 454  * @old_dentry: dentry of an object to be renamed.
 455  * @new_dir: a pointer to the parent dentry where the object should be
 456  *          moved. This should be a directory dentry.
 457  * @new_name: a pointer to a string containing the target name.
 458  *
 459  * This function renames a file/directory in debugfs.  The target must not
 460  * exist for rename to succeed.
 461  *
 462  * This function will return a pointer to old_dentry (which is updated to
 463  * reflect renaming) if it succeeds. If an error occurs, %NULL will be
 464  * returned.
 465  *
 466  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 467  * returned.
 468  */
 469 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
 470                 struct dentry *new_dir, const char *new_name)
 471 {
 472         int error;
 473         struct dentry *dentry = NULL, *trap;
 474         const char *old_name;
 475
 476         trap = lock_rename(new_dir, old_dir);
 477         /* Source or destination directories don't exist? */
 478         if (!old_dir->d_inode || !new_dir->d_inode)
 479                 goto exit;
 480         /* Source does not exist, cyclic rename, or mountpoint? */
 481         if (!old_dentry->d_inode || old_dentry == trap ||
 482             d_mountpoint(old_dentry))
 483                 goto exit;
 484         dentry = lookup_one_len(new_name, new_dir, strlen(new_name));
 485         /* Lookup failed, cyclic rename or target exists? */
 486         if (IS_ERR(dentry) || dentry == trap || dentry->d_inode)
 487                 goto exit;
 488
 489         old_name = fsnotify_oldname_init(old_dentry->d_name.name);
 490
 491         error = simple_rename(old_dir->d_inode, old_dentry, new_dir->d_inode,
 492                 dentry);
 493         if (error) {
 494                 fsnotify_oldname_free(old_name);
 495                 goto exit;
 496         }
 497         d_move(old_dentry, dentry);
 498         fsnotify_move(old_dir->d_inode, new_dir->d_inode, old_name,
 499                 S_ISDIR(old_dentry->d_inode->i_mode),
 500                 NULL, old_dentry);
 501         fsnotify_oldname_free(old_name);
 502         unlock_rename(new_dir, old_dir);
 503         dput(dentry);
 504         return old_dentry;
 505 exit:
 506         if (dentry && !IS_ERR(dentry))
 507                 dput(dentry);
 508         unlock_rename(new_dir, old_dir);
 509         return NULL;
 510 }
 511 EXPORT_SYMBOL_GPL(debugfs_rename);
 512
 513 /**
 514  * debugfs_initialized - Tells whether debugfs has been registered
 515  */
 516 bool debugfs_initialized(void)
 517 {
 518         return debugfs_registered;
 519 }
 520 EXPORT_SYMBOL_GPL(debugfs_initialized);
 521
 522
 523 static struct kobject *debug_kobj;
 524
 525 static int __init debugfs_init(void)
 526 {
 527         int retval;
 528
 529         debug_kobj = kobject_create_and_add("debug", kernel_kobj);
 530         if (!debug_kobj)
 531                 return -EINVAL;
 532
 533         retval = register_filesystem(&debug_fs_type);
 534         if (retval)
 535                 kobject_put(debug_kobj);
 536         else
 537                 debugfs_registered = true;
 538
 539         return retval;
 540 }
 541
 542 static void __exit debugfs_exit(void)
 543 {
 544         debugfs_registered = false;
 545
 546         simple_release_fs(&debugfs_mount, &debugfs_mount_count);
 547         unregister_filesystem(&debug_fs_type);
 548         kobject_put(debug_kobj);
 549 }
 550
 551 core_initcall(debugfs_init);
 552 module_exit(debugfs_exit);
 553 MODULE_LICENSE("GPL");
 554