fs/debugfs/inode.c

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