fs/debugfs/file.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  *  file.c - part of debugfs, a tiny little debug file system
   4  *
   5  *  Copyright (C) 2004 Greg Kroah-Hartman <[email protected]>
   6  *  Copyright (C) 2004 IBM Inc.
   7  *
   8  *  debugfs is for people to use instead of /proc or /sys.
   9  *  See Documentation/filesystems/ for more details.
  10  */
  11
  12 #include <linux/module.h>
  13 #include <linux/fs.h>
  14 #include <linux/seq_file.h>
  15 #include <linux/pagemap.h>
  16 #include <linux/debugfs.h>
  17 #include <linux/io.h>
  18 #include <linux/slab.h>
  19 #include <linux/atomic.h>
  20 #include <linux/device.h>
  21 #include <linux/pm_runtime.h>
  22 #include <linux/poll.h>
  23 #include <linux/security.h>
  24
  25 #include "internal.h"
  26
  27 struct poll_table_struct;
  28
  29 static ssize_t default_read_file(struct file *file, char __user *buf,
  30                                  size_t count, loff_t *ppos)
  31 {
  32         return 0;
  33 }
  34
  35 static ssize_t default_write_file(struct file *file, const char __user *buf,
  36                                    size_t count, loff_t *ppos)
  37 {
  38         return count;
  39 }
  40
  41 const struct file_operations debugfs_noop_file_operations = {
  42         .read =         default_read_file,
  43         .write =        default_write_file,
  44         .open =         simple_open,
  45         .llseek =       noop_llseek,
  46 };
  47
  48 #define F_DENTRY(filp) ((filp)->f_path.dentry)
  49
  50 const struct file_operations *debugfs_real_fops(const struct file *filp)
  51 {
  52         struct debugfs_fsdata *fsd = F_DENTRY(filp)->d_fsdata;
  53
  54         if ((unsigned long)fsd & DEBUGFS_FSDATA_IS_REAL_FOPS_BIT) {
  55                 /*
  56                  * Urgh, we've been called w/o a protecting
  57                  * debugfs_file_get().
  58                  */
  59                 WARN_ON(1);
  60                 return NULL;
  61         }
  62
  63         return fsd->real_fops;
  64 }
  65 EXPORT_SYMBOL_GPL(debugfs_real_fops);
  66
  67 /**
  68  * debugfs_file_get - mark the beginning of file data access
  69  * @dentry: the dentry object whose data is being accessed.
  70  *
  71  * Up to a matching call to debugfs_file_put(), any successive call
  72  * into the file removing functions debugfs_remove() and
  73  * debugfs_remove_recursive() will block. Since associated private
  74  * file data may only get freed after a successful return of any of
  75  * the removal functions, you may safely access it after a successful
  76  * call to debugfs_file_get() without worrying about lifetime issues.
  77  *
  78  * If -%EIO is returned, the file has already been removed and thus,
  79  * it is not safe to access any of its data. If, on the other hand,
  80  * it is allowed to access the file data, zero is returned.
  81  */
  82 int debugfs_file_get(struct dentry *dentry)
  83 {
  84         struct debugfs_fsdata *fsd;
  85         void *d_fsd;
  86
  87         d_fsd = READ_ONCE(dentry->d_fsdata);
  88         if (!((unsigned long)d_fsd & DEBUGFS_FSDATA_IS_REAL_FOPS_BIT)) {
  89                 fsd = d_fsd;
  90         } else {
  91                 fsd = kmalloc(sizeof(*fsd), GFP_KERNEL);
  92                 if (!fsd)
  93                         return -ENOMEM;
  94
  95                 fsd->real_fops = (void *)((unsigned long)d_fsd &
  96                                         ~DEBUGFS_FSDATA_IS_REAL_FOPS_BIT);
  97                 refcount_set(&fsd->active_users, 1);
  98                 init_completion(&fsd->active_users_drained);
  99                 if (cmpxchg(&dentry->d_fsdata, d_fsd, fsd) != d_fsd) {
 100                         kfree(fsd);
 101                         fsd = READ_ONCE(dentry->d_fsdata);
 102                 }
 103         }
 104
 105         /*
 106          * In case of a successful cmpxchg() above, this check is
 107          * strictly necessary and must follow it, see the comment in
 108          * __debugfs_remove_file().
 109          * OTOH, if the cmpxchg() hasn't been executed or wasn't
 110          * successful, this serves the purpose of not starving
 111          * removers.
 112          */
 113         if (d_unlinked(dentry))
 114                 return -EIO;
 115
 116         if (!refcount_inc_not_zero(&fsd->active_users))
 117                 return -EIO;
 118
 119         return 0;
 120 }
 121 EXPORT_SYMBOL_GPL(debugfs_file_get);
 122
 123 /**
 124  * debugfs_file_put - mark the end of file data access
 125  * @dentry: the dentry object formerly passed to
 126  *          debugfs_file_get().
 127  *
 128  * Allow any ongoing concurrent call into debugfs_remove() or
 129  * debugfs_remove_recursive() blocked by a former call to
 130  * debugfs_file_get() to proceed and return to its caller.
 131  */
 132 void debugfs_file_put(struct dentry *dentry)
 133 {
 134         struct debugfs_fsdata *fsd = READ_ONCE(dentry->d_fsdata);
 135
 136         if (refcount_dec_and_test(&fsd->active_users))
 137                 complete(&fsd->active_users_drained);
 138 }
 139 EXPORT_SYMBOL_GPL(debugfs_file_put);
 140
 141 /*
 142  * Only permit access to world-readable files when the kernel is locked down.
 143  * We also need to exclude any file that has ways to write or alter it as root
 144  * can bypass the permissions check.
 145  */
 146 static int debugfs_locked_down(struct inode *inode,
 147                                struct file *filp,
 148                                const struct file_operations *real_fops)
 149 {
 150         if ((inode->i_mode & 07777) == 0444 &&
 151             !(filp->f_mode & FMODE_WRITE) &&
 152             !real_fops->unlocked_ioctl &&
 153             !real_fops->compat_ioctl &&
 154             !real_fops->mmap)
 155                 return 0;
 156
 157         if (security_locked_down(LOCKDOWN_DEBUGFS))
 158                 return -EPERM;
 159
 160         return 0;
 161 }
 162
 163 static int open_proxy_open(struct inode *inode, struct file *filp)
 164 {
 165         struct dentry *dentry = F_DENTRY(filp);
 166         const struct file_operations *real_fops = NULL;
 167         int r;
 168
 169         r = debugfs_file_get(dentry);
 170         if (r)
 171                 return r == -EIO ? -ENOENT : r;
 172
 173         real_fops = debugfs_real_fops(filp);
 174
 175         r = debugfs_locked_down(inode, filp, real_fops);
 176         if (r)
 177                 goto out;
 178
 179         if (!fops_get(real_fops)) {
 180 #ifdef MODULE
 181                 if (real_fops->owner &&
 182                     real_fops->owner->state == MODULE_STATE_GOING)
 183                         goto out;
 184 #endif
 185
 186                 /* Huh? Module did not clean up after itself at exit? */
 187                 WARN(1, "debugfs file owner did not clean up at exit: %pd",
 188                         dentry);
 189                 r = -ENXIO;
 190                 goto out;
 191         }
 192         replace_fops(filp, real_fops);
 193
 194         if (real_fops->open)
 195                 r = real_fops->open(inode, filp);
 196
 197 out:
 198         debugfs_file_put(dentry);
 199         return r;
 200 }
 201
 202 const struct file_operations debugfs_open_proxy_file_operations = {
 203         .open = open_proxy_open,
 204 };
 205
 206 #define PROTO(args...) args
 207 #define ARGS(args...) args
 208
 209 #define FULL_PROXY_FUNC(name, ret_type, filp, proto, args)              \
 210 static ret_type full_proxy_ ## name(proto)                              \
 211 {                                                                       \
 212         struct dentry *dentry = F_DENTRY(filp);                 \
 213         const struct file_operations *real_fops;                        \
 214         ret_type r;                                                     \
 215                                                                         \
 216         r = debugfs_file_get(dentry);                                   \
 217         if (unlikely(r))                                                \
 218                 return r;                                               \
 219         real_fops = debugfs_real_fops(filp);                            \
 220         r = real_fops->name(args);                                      \
 221         debugfs_file_put(dentry);                                       \
 222         return r;                                                       \
 223 }
 224
 225 FULL_PROXY_FUNC(llseek, loff_t, filp,
 226                 PROTO(struct file *filp, loff_t offset, int whence),
 227                 ARGS(filp, offset, whence));
 228
 229 FULL_PROXY_FUNC(read, ssize_t, filp,
 230                 PROTO(struct file *filp, char __user *buf, size_t size,
 231                         loff_t *ppos),
 232                 ARGS(filp, buf, size, ppos));
 233
 234 FULL_PROXY_FUNC(write, ssize_t, filp,
 235                 PROTO(struct file *filp, const char __user *buf, size_t size,
 236                         loff_t *ppos),
 237                 ARGS(filp, buf, size, ppos));
 238
 239 FULL_PROXY_FUNC(unlocked_ioctl, long, filp,
 240                 PROTO(struct file *filp, unsigned int cmd, unsigned long arg),
 241                 ARGS(filp, cmd, arg));
 242
 243 static __poll_t full_proxy_poll(struct file *filp,
 244                                 struct poll_table_struct *wait)
 245 {
 246         struct dentry *dentry = F_DENTRY(filp);
 247         __poll_t r = 0;
 248         const struct file_operations *real_fops;
 249
 250         if (debugfs_file_get(dentry))
 251                 return EPOLLHUP;
 252
 253         real_fops = debugfs_real_fops(filp);
 254         r = real_fops->poll(filp, wait);
 255         debugfs_file_put(dentry);
 256         return r;
 257 }
 258
 259 static int full_proxy_release(struct inode *inode, struct file *filp)
 260 {
 261         const struct dentry *dentry = F_DENTRY(filp);
 262         const struct file_operations *real_fops = debugfs_real_fops(filp);
 263         const struct file_operations *proxy_fops = filp->f_op;
 264         int r = 0;
 265
 266         /*
 267          * We must not protect this against removal races here: the
 268          * original releaser should be called unconditionally in order
 269          * not to leak any resources. Releasers must not assume that
 270          * ->i_private is still being meaningful here.
 271          */
 272         if (real_fops->release)
 273                 r = real_fops->release(inode, filp);
 274
 275         replace_fops(filp, d_inode(dentry)->i_fop);
 276         kfree((void *)proxy_fops);
 277         fops_put(real_fops);
 278         return r;
 279 }
 280
 281 static void __full_proxy_fops_init(struct file_operations *proxy_fops,
 282                                 const struct file_operations *real_fops)
 283 {
 284         proxy_fops->release = full_proxy_release;
 285         if (real_fops->llseek)
 286                 proxy_fops->llseek = full_proxy_llseek;
 287         if (real_fops->read)
 288                 proxy_fops->read = full_proxy_read;
 289         if (real_fops->write)
 290                 proxy_fops->write = full_proxy_write;
 291         if (real_fops->poll)
 292                 proxy_fops->poll = full_proxy_poll;
 293         if (real_fops->unlocked_ioctl)
 294                 proxy_fops->unlocked_ioctl = full_proxy_unlocked_ioctl;
 295 }
 296
 297 static int full_proxy_open(struct inode *inode, struct file *filp)
 298 {
 299         struct dentry *dentry = F_DENTRY(filp);
 300         const struct file_operations *real_fops = NULL;
 301         struct file_operations *proxy_fops = NULL;
 302         int r;
 303
 304         r = debugfs_file_get(dentry);
 305         if (r)
 306                 return r == -EIO ? -ENOENT : r;
 307
 308         real_fops = debugfs_real_fops(filp);
 309
 310         r = debugfs_locked_down(inode, filp, real_fops);
 311         if (r)
 312                 goto out;
 313
 314         if (!fops_get(real_fops)) {
 315 #ifdef MODULE
 316                 if (real_fops->owner &&
 317                     real_fops->owner->state == MODULE_STATE_GOING)
 318                         goto out;
 319 #endif
 320
 321                 /* Huh? Module did not cleanup after itself at exit? */
 322                 WARN(1, "debugfs file owner did not clean up at exit: %pd",
 323                         dentry);
 324                 r = -ENXIO;
 325                 goto out;
 326         }
 327
 328         proxy_fops = kzalloc(sizeof(*proxy_fops), GFP_KERNEL);
 329         if (!proxy_fops) {
 330                 r = -ENOMEM;
 331                 goto free_proxy;
 332         }
 333         __full_proxy_fops_init(proxy_fops, real_fops);
 334         replace_fops(filp, proxy_fops);
 335
 336         if (real_fops->open) {
 337                 r = real_fops->open(inode, filp);
 338                 if (r) {
 339                         replace_fops(filp, d_inode(dentry)->i_fop);
 340                         goto free_proxy;
 341                 } else if (filp->f_op != proxy_fops) {
 342                         /* No protection against file removal anymore. */
 343                         WARN(1, "debugfs file owner replaced proxy fops: %pd",
 344                                 dentry);
 345                         goto free_proxy;
 346                 }
 347         }
 348
 349         goto out;
 350 free_proxy:
 351         kfree(proxy_fops);
 352         fops_put(real_fops);
 353 out:
 354         debugfs_file_put(dentry);
 355         return r;
 356 }
 357
 358 const struct file_operations debugfs_full_proxy_file_operations = {
 359         .open = full_proxy_open,
 360 };
 361
 362 ssize_t debugfs_attr_read(struct file *file, char __user *buf,
 363                         size_t len, loff_t *ppos)
 364 {
 365         struct dentry *dentry = F_DENTRY(file);
 366         ssize_t ret;
 367
 368         ret = debugfs_file_get(dentry);
 369         if (unlikely(ret))
 370                 return ret;
 371         ret = simple_attr_read(file, buf, len, ppos);
 372         debugfs_file_put(dentry);
 373         return ret;
 374 }
 375 EXPORT_SYMBOL_GPL(debugfs_attr_read);
 376
 377 ssize_t debugfs_attr_write(struct file *file, const char __user *buf,
 378                          size_t len, loff_t *ppos)
 379 {
 380         struct dentry *dentry = F_DENTRY(file);
 381         ssize_t ret;
 382
 383         ret = debugfs_file_get(dentry);
 384         if (unlikely(ret))
 385                 return ret;
 386         ret = simple_attr_write(file, buf, len, ppos);
 387         debugfs_file_put(dentry);
 388         return ret;
 389 }
 390 EXPORT_SYMBOL_GPL(debugfs_attr_write);
 391
 392 static struct dentry *debugfs_create_mode_unsafe(const char *name, umode_t mode,
 393                                         struct dentry *parent, void *value,
 394                                         const struct file_operations *fops,
 395                                         const struct file_operations *fops_ro,
 396                                         const struct file_operations *fops_wo)
 397 {
 398         /* if there are no write bits set, make read only */
 399         if (!(mode & S_IWUGO))
 400                 return debugfs_create_file_unsafe(name, mode, parent, value,
 401                                                 fops_ro);
 402         /* if there are no read bits set, make write only */
 403         if (!(mode & S_IRUGO))
 404                 return debugfs_create_file_unsafe(name, mode, parent, value,
 405                                                 fops_wo);
 406
 407         return debugfs_create_file_unsafe(name, mode, parent, value, fops);
 408 }
 409
 410 static int debugfs_u8_set(void *data, u64 val)
 411 {
 412         *(u8 *)data = val;
 413         return 0;
 414 }
 415 static int debugfs_u8_get(void *data, u64 *val)
 416 {
 417         *val = *(u8 *)data;
 418         return 0;
 419 }
 420 DEFINE_DEBUGFS_ATTRIBUTE(fops_u8, debugfs_u8_get, debugfs_u8_set, "%llu\n");
 421 DEFINE_DEBUGFS_ATTRIBUTE(fops_u8_ro, debugfs_u8_get, NULL, "%llu\n");
 422 DEFINE_DEBUGFS_ATTRIBUTE(fops_u8_wo, NULL, debugfs_u8_set, "%llu\n");
 423
 424 /**
 425  * debugfs_create_u8 - create a debugfs file that is used to read and write an unsigned 8-bit value
 426  * @name: a pointer to a string containing the name of the file to create.
 427  * @mode: the permission that the file should have
 428  * @parent: a pointer to the parent dentry for this file.  This should be a
 429  *          directory dentry if set.  If this parameter is %NULL, then the
 430  *          file will be created in the root of the debugfs filesystem.
 431  * @value: a pointer to the variable that the file should read to and write
 432  *         from.
 433  *
 434  * This function creates a file in debugfs with the given name that
 435  * contains the value of the variable @value.  If the @mode variable is so
 436  * set, it can be read from, and written to.
 437  */
 438 void debugfs_create_u8(const char *name, umode_t mode, struct dentry *parent,
 439                        u8 *value)
 440 {
 441         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u8,
 442                                    &fops_u8_ro, &fops_u8_wo);
 443 }
 444 EXPORT_SYMBOL_GPL(debugfs_create_u8);
 445
 446 static int debugfs_u16_set(void *data, u64 val)
 447 {
 448         *(u16 *)data = val;
 449         return 0;
 450 }
 451 static int debugfs_u16_get(void *data, u64 *val)
 452 {
 453         *val = *(u16 *)data;
 454         return 0;
 455 }
 456 DEFINE_DEBUGFS_ATTRIBUTE(fops_u16, debugfs_u16_get, debugfs_u16_set, "%llu\n");
 457 DEFINE_DEBUGFS_ATTRIBUTE(fops_u16_ro, debugfs_u16_get, NULL, "%llu\n");
 458 DEFINE_DEBUGFS_ATTRIBUTE(fops_u16_wo, NULL, debugfs_u16_set, "%llu\n");
 459
 460 /**
 461  * debugfs_create_u16 - create a debugfs file that is used to read and write an unsigned 16-bit value
 462  * @name: a pointer to a string containing the name of the file to create.
 463  * @mode: the permission that the file should have
 464  * @parent: a pointer to the parent dentry for this file.  This should be a
 465  *          directory dentry if set.  If this parameter is %NULL, then the
 466  *          file will be created in the root of the debugfs filesystem.
 467  * @value: a pointer to the variable that the file should read to and write
 468  *         from.
 469  *
 470  * This function creates a file in debugfs with the given name that
 471  * contains the value of the variable @value.  If the @mode variable is so
 472  * set, it can be read from, and written to.
 473  */
 474 void debugfs_create_u16(const char *name, umode_t mode, struct dentry *parent,
 475                         u16 *value)
 476 {
 477         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u16,
 478                                    &fops_u16_ro, &fops_u16_wo);
 479 }
 480 EXPORT_SYMBOL_GPL(debugfs_create_u16);
 481
 482 static int debugfs_u32_set(void *data, u64 val)
 483 {
 484         *(u32 *)data = val;
 485         return 0;
 486 }
 487 static int debugfs_u32_get(void *data, u64 *val)
 488 {
 489         *val = *(u32 *)data;
 490         return 0;
 491 }
 492 DEFINE_DEBUGFS_ATTRIBUTE(fops_u32, debugfs_u32_get, debugfs_u32_set, "%llu\n");
 493 DEFINE_DEBUGFS_ATTRIBUTE(fops_u32_ro, debugfs_u32_get, NULL, "%llu\n");
 494 DEFINE_DEBUGFS_ATTRIBUTE(fops_u32_wo, NULL, debugfs_u32_set, "%llu\n");
 495
 496 /**
 497  * debugfs_create_u32 - create a debugfs file that is used to read and write an unsigned 32-bit value
 498  * @name: a pointer to a string containing the name of the file to create.
 499  * @mode: the permission that the file should have
 500  * @parent: a pointer to the parent dentry for this file.  This should be a
 501  *          directory dentry if set.  If this parameter is %NULL, then the
 502  *          file will be created in the root of the debugfs filesystem.
 503  * @value: a pointer to the variable that the file should read to and write
 504  *         from.
 505  *
 506  * This function creates a file in debugfs with the given name that
 507  * contains the value of the variable @value.  If the @mode variable is so
 508  * set, it can be read from, and written to.
 509  *
 510  * This function will return a pointer to a dentry if it succeeds.  This
 511  * pointer must be passed to the debugfs_remove() function when the file is
 512  * to be removed (no automatic cleanup happens if your module is unloaded,
 513  * you are responsible here.)  If an error occurs, ERR_PTR(-ERROR) will be
 514  * returned.
 515  *
 516  * If debugfs is not enabled in the kernel, the value ERR_PTR(-ENODEV) will
 517  * be returned.
 518  */
 519 struct dentry *debugfs_create_u32(const char *name, umode_t mode,
 520                                  struct dentry *parent, u32 *value)
 521 {
 522         return debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u32,
 523                                    &fops_u32_ro, &fops_u32_wo);
 524 }
 525 EXPORT_SYMBOL_GPL(debugfs_create_u32);
 526
 527 static int debugfs_u64_set(void *data, u64 val)
 528 {
 529         *(u64 *)data = val;
 530         return 0;
 531 }
 532
 533 static int debugfs_u64_get(void *data, u64 *val)
 534 {
 535         *val = *(u64 *)data;
 536         return 0;
 537 }
 538 DEFINE_DEBUGFS_ATTRIBUTE(fops_u64, debugfs_u64_get, debugfs_u64_set, "%llu\n");
 539 DEFINE_DEBUGFS_ATTRIBUTE(fops_u64_ro, debugfs_u64_get, NULL, "%llu\n");
 540 DEFINE_DEBUGFS_ATTRIBUTE(fops_u64_wo, NULL, debugfs_u64_set, "%llu\n");
 541
 542 /**
 543  * debugfs_create_u64 - create a debugfs file that is used to read and write an unsigned 64-bit value
 544  * @name: a pointer to a string containing the name of the file to create.
 545  * @mode: the permission that the file should have
 546  * @parent: a pointer to the parent dentry for this file.  This should be a
 547  *          directory dentry if set.  If this parameter is %NULL, then the
 548  *          file will be created in the root of the debugfs filesystem.
 549  * @value: a pointer to the variable that the file should read to and write
 550  *         from.
 551  *
 552  * This function creates a file in debugfs with the given name that
 553  * contains the value of the variable @value.  If the @mode variable is so
 554  * set, it can be read from, and written to.
 555  */
 556 void debugfs_create_u64(const char *name, umode_t mode, struct dentry *parent,
 557                         u64 *value)
 558 {
 559         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u64,
 560                                    &fops_u64_ro, &fops_u64_wo);
 561 }
 562 EXPORT_SYMBOL_GPL(debugfs_create_u64);
 563
 564 static int debugfs_ulong_set(void *data, u64 val)
 565 {
 566         *(unsigned long *)data = val;
 567         return 0;
 568 }
 569
 570 static int debugfs_ulong_get(void *data, u64 *val)
 571 {
 572         *val = *(unsigned long *)data;
 573         return 0;
 574 }
 575 DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong, debugfs_ulong_get, debugfs_ulong_set,
 576                         "%llu\n");
 577 DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong_ro, debugfs_ulong_get, NULL, "%llu\n");
 578 DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong_wo, NULL, debugfs_ulong_set, "%llu\n");
 579
 580 /**
 581  * debugfs_create_ulong - create a debugfs file that is used to read and write
 582  * an unsigned long value.
 583  * @name: a pointer to a string containing the name of the file to create.
 584  * @mode: the permission that the file should have
 585  * @parent: a pointer to the parent dentry for this file.  This should be a
 586  *          directory dentry if set.  If this parameter is %NULL, then the
 587  *          file will be created in the root of the debugfs filesystem.
 588  * @value: a pointer to the variable that the file should read to and write
 589  *         from.
 590  *
 591  * This function creates a file in debugfs with the given name that
 592  * contains the value of the variable @value.  If the @mode variable is so
 593  * set, it can be read from, and written to.
 594  *
 595  * This function will return a pointer to a dentry if it succeeds.  This
 596  * pointer must be passed to the debugfs_remove() function when the file is
 597  * to be removed (no automatic cleanup happens if your module is unloaded,
 598  * you are responsible here.)  If an error occurs, ERR_PTR(-ERROR) will be
 599  * returned.
 600  *
 601  * If debugfs is not enabled in the kernel, the value ERR_PTR(-ENODEV) will
 602  * be returned.
 603  */
 604 struct dentry *debugfs_create_ulong(const char *name, umode_t mode,
 605                                     struct dentry *parent, unsigned long *value)
 606 {
 607         return debugfs_create_mode_unsafe(name, mode, parent, value,
 608                                         &fops_ulong, &fops_ulong_ro,
 609                                         &fops_ulong_wo);
 610 }
 611 EXPORT_SYMBOL_GPL(debugfs_create_ulong);
 612
 613 DEFINE_DEBUGFS_ATTRIBUTE(fops_x8, debugfs_u8_get, debugfs_u8_set, "0x%02llx\n");
 614 DEFINE_DEBUGFS_ATTRIBUTE(fops_x8_ro, debugfs_u8_get, NULL, "0x%02llx\n");
 615 DEFINE_DEBUGFS_ATTRIBUTE(fops_x8_wo, NULL, debugfs_u8_set, "0x%02llx\n");
 616
 617 DEFINE_DEBUGFS_ATTRIBUTE(fops_x16, debugfs_u16_get, debugfs_u16_set,
 618                         "0x%04llx\n");
 619 DEFINE_DEBUGFS_ATTRIBUTE(fops_x16_ro, debugfs_u16_get, NULL, "0x%04llx\n");
 620 DEFINE_DEBUGFS_ATTRIBUTE(fops_x16_wo, NULL, debugfs_u16_set, "0x%04llx\n");
 621
 622 DEFINE_DEBUGFS_ATTRIBUTE(fops_x32, debugfs_u32_get, debugfs_u32_set,
 623                         "0x%08llx\n");
 624 DEFINE_DEBUGFS_ATTRIBUTE(fops_x32_ro, debugfs_u32_get, NULL, "0x%08llx\n");
 625 DEFINE_DEBUGFS_ATTRIBUTE(fops_x32_wo, NULL, debugfs_u32_set, "0x%08llx\n");
 626
 627 DEFINE_DEBUGFS_ATTRIBUTE(fops_x64, debugfs_u64_get, debugfs_u64_set,
 628                         "0x%016llx\n");
 629 DEFINE_DEBUGFS_ATTRIBUTE(fops_x64_ro, debugfs_u64_get, NULL, "0x%016llx\n");
 630 DEFINE_DEBUGFS_ATTRIBUTE(fops_x64_wo, NULL, debugfs_u64_set, "0x%016llx\n");
 631
 632 /*
 633  * debugfs_create_x{8,16,32,64} - create a debugfs file that is used to read and write an unsigned {8,16,32,64}-bit value
 634  *
 635  * These functions are exactly the same as the above functions (but use a hex
 636  * output for the decimal challenged). For details look at the above unsigned
 637  * decimal functions.
 638  */
 639
 640 /**
 641  * debugfs_create_x8 - create a debugfs file that is used to read and write an unsigned 8-bit value
 642  * @name: a pointer to a string containing the name of the file to create.
 643  * @mode: the permission that the file should have
 644  * @parent: a pointer to the parent dentry for this file.  This should be a
 645  *          directory dentry if set.  If this parameter is %NULL, then the
 646  *          file will be created in the root of the debugfs filesystem.
 647  * @value: a pointer to the variable that the file should read to and write
 648  *         from.
 649  */
 650 void debugfs_create_x8(const char *name, umode_t mode, struct dentry *parent,
 651                        u8 *value)
 652 {
 653         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x8,
 654                                    &fops_x8_ro, &fops_x8_wo);
 655 }
 656 EXPORT_SYMBOL_GPL(debugfs_create_x8);
 657
 658 /**
 659  * debugfs_create_x16 - create a debugfs file that is used to read and write an unsigned 16-bit value
 660  * @name: a pointer to a string containing the name of the file to create.
 661  * @mode: the permission that the file should have
 662  * @parent: a pointer to the parent dentry for this file.  This should be a
 663  *          directory dentry if set.  If this parameter is %NULL, then the
 664  *          file will be created in the root of the debugfs filesystem.
 665  * @value: a pointer to the variable that the file should read to and write
 666  *         from.
 667  */
 668 void debugfs_create_x16(const char *name, umode_t mode, struct dentry *parent,
 669                         u16 *value)
 670 {
 671         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x16,
 672                                    &fops_x16_ro, &fops_x16_wo);
 673 }
 674 EXPORT_SYMBOL_GPL(debugfs_create_x16);
 675
 676 /**
 677  * debugfs_create_x32 - create a debugfs file that is used to read and write an unsigned 32-bit value
 678  * @name: a pointer to a string containing the name of the file to create.
 679  * @mode: the permission that the file should have
 680  * @parent: a pointer to the parent dentry for this file.  This should be a
 681  *          directory dentry if set.  If this parameter is %NULL, then the
 682  *          file will be created in the root of the debugfs filesystem.
 683  * @value: a pointer to the variable that the file should read to and write
 684  *         from.
 685  */
 686 void debugfs_create_x32(const char *name, umode_t mode, struct dentry *parent,
 687                         u32 *value)
 688 {
 689         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x32,
 690                                    &fops_x32_ro, &fops_x32_wo);
 691 }
 692 EXPORT_SYMBOL_GPL(debugfs_create_x32);
 693
 694 /**
 695  * debugfs_create_x64 - create a debugfs file that is used to read and write an unsigned 64-bit value
 696  * @name: a pointer to a string containing the name of the file to create.
 697  * @mode: the permission that the file should have
 698  * @parent: a pointer to the parent dentry for this file.  This should be a
 699  *          directory dentry if set.  If this parameter is %NULL, then the
 700  *          file will be created in the root of the debugfs filesystem.
 701  * @value: a pointer to the variable that the file should read to and write
 702  *         from.
 703  */
 704 void debugfs_create_x64(const char *name, umode_t mode, struct dentry *parent,
 705                         u64 *value)
 706 {
 707         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x64,
 708                                    &fops_x64_ro, &fops_x64_wo);
 709 }
 710 EXPORT_SYMBOL_GPL(debugfs_create_x64);
 711
 712
 713 static int debugfs_size_t_set(void *data, u64 val)
 714 {
 715         *(size_t *)data = val;
 716         return 0;
 717 }
 718 static int debugfs_size_t_get(void *data, u64 *val)
 719 {
 720         *val = *(size_t *)data;
 721         return 0;
 722 }
 723 DEFINE_DEBUGFS_ATTRIBUTE(fops_size_t, debugfs_size_t_get, debugfs_size_t_set,
 724                         "%llu\n"); /* %llu and %zu are more or less the same */
 725 DEFINE_DEBUGFS_ATTRIBUTE(fops_size_t_ro, debugfs_size_t_get, NULL, "%llu\n");
 726 DEFINE_DEBUGFS_ATTRIBUTE(fops_size_t_wo, NULL, debugfs_size_t_set, "%llu\n");
 727
 728 /**
 729  * debugfs_create_size_t - create a debugfs file that is used to read and write an size_t value
 730  * @name: a pointer to a string containing the name of the file to create.
 731  * @mode: the permission that the file should have
 732  * @parent: a pointer to the parent dentry for this file.  This should be a
 733  *          directory dentry if set.  If this parameter is %NULL, then the
 734  *          file will be created in the root of the debugfs filesystem.
 735  * @value: a pointer to the variable that the file should read to and write
 736  *         from.
 737  */
 738 void debugfs_create_size_t(const char *name, umode_t mode,
 739                            struct dentry *parent, size_t *value)
 740 {
 741         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_size_t,
 742                                    &fops_size_t_ro, &fops_size_t_wo);
 743 }
 744 EXPORT_SYMBOL_GPL(debugfs_create_size_t);
 745
 746 static int debugfs_atomic_t_set(void *data, u64 val)
 747 {
 748         atomic_set((atomic_t *)data, val);
 749         return 0;
 750 }
 751 static int debugfs_atomic_t_get(void *data, u64 *val)
 752 {
 753         *val = atomic_read((atomic_t *)data);
 754         return 0;
 755 }
 756 DEFINE_DEBUGFS_ATTRIBUTE(fops_atomic_t, debugfs_atomic_t_get,
 757                         debugfs_atomic_t_set, "%lld\n");
 758 DEFINE_DEBUGFS_ATTRIBUTE(fops_atomic_t_ro, debugfs_atomic_t_get, NULL,
 759                         "%lld\n");
 760 DEFINE_DEBUGFS_ATTRIBUTE(fops_atomic_t_wo, NULL, debugfs_atomic_t_set,
 761                         "%lld\n");
 762
 763 /**
 764  * debugfs_create_atomic_t - create a debugfs file that is used to read and
 765  * write an atomic_t value
 766  * @name: a pointer to a string containing the name of the file to create.
 767  * @mode: the permission that the file should have
 768  * @parent: a pointer to the parent dentry for this file.  This should be a
 769  *          directory dentry if set.  If this parameter is %NULL, then the
 770  *          file will be created in the root of the debugfs filesystem.
 771  * @value: a pointer to the variable that the file should read to and write
 772  *         from.
 773  */
 774 void debugfs_create_atomic_t(const char *name, umode_t mode,
 775                              struct dentry *parent, atomic_t *value)
 776 {
 777         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_atomic_t,
 778                                    &fops_atomic_t_ro, &fops_atomic_t_wo);
 779 }
 780 EXPORT_SYMBOL_GPL(debugfs_create_atomic_t);
 781
 782 ssize_t debugfs_read_file_bool(struct file *file, char __user *user_buf,
 783                                size_t count, loff_t *ppos)
 784 {
 785         char buf[3];
 786         bool val;
 787         int r;
 788         struct dentry *dentry = F_DENTRY(file);
 789
 790         r = debugfs_file_get(dentry);
 791         if (unlikely(r))
 792                 return r;
 793         val = *(bool *)file->private_data;
 794         debugfs_file_put(dentry);
 795
 796         if (val)
 797                 buf[0] = 'Y';
 798         else
 799                 buf[0] = 'N';
 800         buf[1] = '\n';
 801         buf[2] = 0x00;
 802         return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
 803 }
 804 EXPORT_SYMBOL_GPL(debugfs_read_file_bool);
 805
 806 ssize_t debugfs_write_file_bool(struct file *file, const char __user *user_buf,
 807                                 size_t count, loff_t *ppos)
 808 {
 809         bool bv;
 810         int r;
 811         bool *val = file->private_data;
 812         struct dentry *dentry = F_DENTRY(file);
 813
 814         r = kstrtobool_from_user(user_buf, count, &bv);
 815         if (!r) {
 816                 r = debugfs_file_get(dentry);
 817                 if (unlikely(r))
 818                         return r;
 819                 *val = bv;
 820                 debugfs_file_put(dentry);
 821         }
 822
 823         return count;
 824 }
 825 EXPORT_SYMBOL_GPL(debugfs_write_file_bool);
 826
 827 static const struct file_operations fops_bool = {
 828         .read =         debugfs_read_file_bool,
 829         .write =        debugfs_write_file_bool,
 830         .open =         simple_open,
 831         .llseek =       default_llseek,
 832 };
 833
 834 static const struct file_operations fops_bool_ro = {
 835         .read =         debugfs_read_file_bool,
 836         .open =         simple_open,
 837         .llseek =       default_llseek,
 838 };
 839
 840 static const struct file_operations fops_bool_wo = {
 841         .write =        debugfs_write_file_bool,
 842         .open =         simple_open,
 843         .llseek =       default_llseek,
 844 };
 845
 846 /**
 847  * debugfs_create_bool - create a debugfs file that is used to read and write a boolean value
 848  * @name: a pointer to a string containing the name of the file to create.
 849  * @mode: the permission that the file should have
 850  * @parent: a pointer to the parent dentry for this file.  This should be a
 851  *          directory dentry if set.  If this parameter is %NULL, then the
 852  *          file will be created in the root of the debugfs filesystem.
 853  * @value: a pointer to the variable that the file should read to and write
 854  *         from.
 855  *
 856  * This function creates a file in debugfs with the given name that
 857  * contains the value of the variable @value.  If the @mode variable is so
 858  * set, it can be read from, and written to.
 859  *
 860  * This function will return a pointer to a dentry if it succeeds.  This
 861  * pointer must be passed to the debugfs_remove() function when the file is
 862  * to be removed (no automatic cleanup happens if your module is unloaded,
 863  * you are responsible here.)  If an error occurs, ERR_PTR(-ERROR) will be
 864  * returned.
 865  *
 866  * If debugfs is not enabled in the kernel, the value ERR_PTR(-ENODEV) will
 867  * be returned.
 868  */
 869 struct dentry *debugfs_create_bool(const char *name, umode_t mode,
 870                                    struct dentry *parent, bool *value)
 871 {
 872         return debugfs_create_mode_unsafe(name, mode, parent, value, &fops_bool,
 873                                    &fops_bool_ro, &fops_bool_wo);
 874 }
 875 EXPORT_SYMBOL_GPL(debugfs_create_bool);
 876
 877 static ssize_t read_file_blob(struct file *file, char __user *user_buf,
 878                               size_t count, loff_t *ppos)
 879 {
 880         struct debugfs_blob_wrapper *blob = file->private_data;
 881         struct dentry *dentry = F_DENTRY(file);
 882         ssize_t r;
 883
 884         r = debugfs_file_get(dentry);
 885         if (unlikely(r))
 886                 return r;
 887         r = simple_read_from_buffer(user_buf, count, ppos, blob->data,
 888                                 blob->size);
 889         debugfs_file_put(dentry);
 890         return r;
 891 }
 892
 893 static const struct file_operations fops_blob = {
 894         .read =         read_file_blob,
 895         .open =         simple_open,
 896         .llseek =       default_llseek,
 897 };
 898
 899 /**
 900  * debugfs_create_blob - create a debugfs file that is used to read a binary blob
 901  * @name: a pointer to a string containing the name of the file to create.
 902  * @mode: the permission that the file should have
 903  * @parent: a pointer to the parent dentry for this file.  This should be a
 904  *          directory dentry if set.  If this parameter is %NULL, then the
 905  *          file will be created in the root of the debugfs filesystem.
 906  * @blob: a pointer to a struct debugfs_blob_wrapper which contains a pointer
 907  *        to the blob data and the size of the data.
 908  *
 909  * This function creates a file in debugfs with the given name that exports
 910  * @blob->data as a binary blob. If the @mode variable is so set it can be
 911  * read from. Writing is not supported.
 912  *
 913  * This function will return a pointer to a dentry if it succeeds.  This
 914  * pointer must be passed to the debugfs_remove() function when the file is
 915  * to be removed (no automatic cleanup happens if your module is unloaded,
 916  * you are responsible here.)  If an error occurs, ERR_PTR(-ERROR) will be
 917  * returned.
 918  *
 919  * If debugfs is not enabled in the kernel, the value ERR_PTR(-ENODEV) will
 920  * be returned.
 921  */
 922 struct dentry *debugfs_create_blob(const char *name, umode_t mode,
 923                                    struct dentry *parent,
 924                                    struct debugfs_blob_wrapper *blob)
 925 {
 926         return debugfs_create_file_unsafe(name, mode, parent, blob, &fops_blob);
 927 }
 928 EXPORT_SYMBOL_GPL(debugfs_create_blob);
 929
 930 struct array_data {
 931         void *array;
 932         u32 elements;
 933 };
 934
 935 static size_t u32_format_array(char *buf, size_t bufsize,
 936                                u32 *array, int array_size)
 937 {
 938         size_t ret = 0;
 939
 940         while (--array_size >= 0) {
 941                 size_t len;
 942                 char term = array_size ? ' ' : '\n';
 943
 944                 len = snprintf(buf, bufsize, "%u%c", *array++, term);
 945                 ret += len;
 946
 947                 buf += len;
 948                 bufsize -= len;
 949         }
 950         return ret;
 951 }
 952
 953 static int u32_array_open(struct inode *inode, struct file *file)
 954 {
 955         struct array_data *data = inode->i_private;
 956         int size, elements = data->elements;
 957         char *buf;
 958
 959         /*
 960          * Max size:
 961          *  - 10 digits + ' '/'\n' = 11 bytes per number
 962          *  - terminating NUL character
 963          */
 964         size = elements*11;
 965         buf = kmalloc(size+1, GFP_KERNEL);
 966         if (!buf)
 967                 return -ENOMEM;
 968         buf[size] = 0;
 969
 970         file->private_data = buf;
 971         u32_format_array(buf, size, data->array, data->elements);
 972
 973         return nonseekable_open(inode, file);
 974 }
 975
 976 static ssize_t u32_array_read(struct file *file, char __user *buf, size_t len,
 977                               loff_t *ppos)
 978 {
 979         size_t size = strlen(file->private_data);
 980
 981         return simple_read_from_buffer(buf, len, ppos,
 982                                         file->private_data, size);
 983 }
 984
 985 static int u32_array_release(struct inode *inode, struct file *file)
 986 {
 987         kfree(file->private_data);
 988
 989         return 0;
 990 }
 991
 992 static const struct file_operations u32_array_fops = {
 993         .owner   = THIS_MODULE,
 994         .open    = u32_array_open,
 995         .release = u32_array_release,
 996         .read    = u32_array_read,
 997         .llseek  = no_llseek,
 998 };
 999
1000 /**
1001  * debugfs_create_u32_array - create a debugfs file that is used to read u32
1002  * array.
1003  * @name: a pointer to a string containing the name of the file to create.
1004  * @mode: the permission that the file should have.
1005  * @parent: a pointer to the parent dentry for this file.  This should be a
1006  *          directory dentry if set.  If this parameter is %NULL, then the
1007  *          file will be created in the root of the debugfs filesystem.
1008  * @array: u32 array that provides data.
1009  * @elements: total number of elements in the array.
1010  *
1011  * This function creates a file in debugfs with the given name that exports
1012  * @array as data. If the @mode variable is so set it can be read from.
1013  * Writing is not supported. Seek within the file is also not supported.
1014  * Once array is created its size can not be changed.
1015  */
1016 void debugfs_create_u32_array(const char *name, umode_t mode,
1017                               struct dentry *parent, u32 *array, u32 elements)
1018 {
1019         struct array_data *data = kmalloc(sizeof(*data), GFP_KERNEL);
1020
1021         if (data == NULL)
1022                 return;
1023
1024         data->array = array;
1025         data->elements = elements;
1026
1027         debugfs_create_file_unsafe(name, mode, parent, data, &u32_array_fops);
1028 }
1029 EXPORT_SYMBOL_GPL(debugfs_create_u32_array);
1030
1031 #ifdef CONFIG_HAS_IOMEM
1032
1033 /*
1034  * The regset32 stuff is used to print 32-bit registers using the
1035  * seq_file utilities. We offer printing a register set in an already-opened
1036  * sequential file or create a debugfs file that only prints a regset32.
1037  */
1038
1039 /**
1040  * debugfs_print_regs32 - use seq_print to describe a set of registers
1041  * @s: the seq_file structure being used to generate output
1042  * @regs: an array if struct debugfs_reg32 structures
1043  * @nregs: the length of the above array
1044  * @base: the base address to be used in reading the registers
1045  * @prefix: a string to be prefixed to every output line
1046  *
1047  * This function outputs a text block describing the current values of
1048  * some 32-bit hardware registers. It is meant to be used within debugfs
1049  * files based on seq_file that need to show registers, intermixed with other
1050  * information. The prefix argument may be used to specify a leading string,
1051  * because some peripherals have several blocks of identical registers,
1052  * for example configuration of dma channels
1053  */
1054 void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
1055                           int nregs, void __iomem *base, char *prefix)
1056 {
1057         int i;
1058
1059         for (i = 0; i < nregs; i++, regs++) {
1060                 if (prefix)
1061                         seq_printf(s, "%s", prefix);
1062                 seq_printf(s, "%s = 0x%08x\n", regs->name,
1063                            readl(base + regs->offset));
1064                 if (seq_has_overflowed(s))
1065                         break;
1066         }
1067 }
1068 EXPORT_SYMBOL_GPL(debugfs_print_regs32);
1069
1070 static int debugfs_show_regset32(struct seq_file *s, void *data)
1071 {
1072         struct debugfs_regset32 *regset = s->private;
1073
1074         if (regset->dev)
1075                 pm_runtime_get_sync(regset->dev);
1076
1077         debugfs_print_regs32(s, regset->regs, regset->nregs, regset->base, "");
1078
1079         if (regset->dev)
1080                 pm_runtime_put(regset->dev);
1081
1082         return 0;
1083 }
1084
1085 static int debugfs_open_regset32(struct inode *inode, struct file *file)
1086 {
1087         return single_open(file, debugfs_show_regset32, inode->i_private);
1088 }
1089
1090 static const struct file_operations fops_regset32 = {
1091         .open =         debugfs_open_regset32,
1092         .read =         seq_read,
1093         .llseek =       seq_lseek,
1094         .release =      single_release,
1095 };
1096
1097 /**
1098  * debugfs_create_regset32 - create a debugfs file that returns register values
1099  * @name: a pointer to a string containing the name of the file to create.
1100  * @mode: the permission that the file should have
1101  * @parent: a pointer to the parent dentry for this file.  This should be a
1102  *          directory dentry if set.  If this parameter is %NULL, then the
1103  *          file will be created in the root of the debugfs filesystem.
1104  * @regset: a pointer to a struct debugfs_regset32, which contains a pointer
1105  *          to an array of register definitions, the array size and the base
1106  *          address where the register bank is to be found.
1107  *
1108  * This function creates a file in debugfs with the given name that reports
1109  * the names and values of a set of 32-bit registers. If the @mode variable
1110  * is so set it can be read from. Writing is not supported.
1111  */
1112 void debugfs_create_regset32(const char *name, umode_t mode,
1113                              struct dentry *parent,
1114                              struct debugfs_regset32 *regset)
1115 {
1116         debugfs_create_file(name, mode, parent, regset, &fops_regset32);
1117 }
1118 EXPORT_SYMBOL_GPL(debugfs_create_regset32);
1119
1120 #endif /* CONFIG_HAS_IOMEM */
1121
1122 struct debugfs_devm_entry {
1123         int (*read)(struct seq_file *seq, void *data);
1124         struct device *dev;
1125 };
1126
1127 static int debugfs_devm_entry_open(struct inode *inode, struct file *f)
1128 {
1129         struct debugfs_devm_entry *entry = inode->i_private;
1130
1131         return single_open(f, entry->read, entry->dev);
1132 }
1133
1134 static const struct file_operations debugfs_devm_entry_ops = {
1135         .owner = THIS_MODULE,
1136         .open = debugfs_devm_entry_open,
1137         .release = single_release,
1138         .read = seq_read,
1139         .llseek = seq_lseek
1140 };
1141
1142 /**
1143  * debugfs_create_devm_seqfile - create a debugfs file that is bound to device.
1144  *
1145  * @dev: device related to this debugfs file.
1146  * @name: name of the debugfs file.
1147  * @parent: a pointer to the parent dentry for this file.  This should be a
1148  *      directory dentry if set.  If this parameter is %NULL, then the
1149  *      file will be created in the root of the debugfs filesystem.
1150  * @read_fn: function pointer called to print the seq_file content.
1151  */
1152 struct dentry *debugfs_create_devm_seqfile(struct device *dev, const char *name,
1153                                            struct dentry *parent,
1154                                            int (*read_fn)(struct seq_file *s,
1155                                                           void *data))
1156 {
1157         struct debugfs_devm_entry *entry;
1158
1159         if (IS_ERR(parent))
1160                 return ERR_PTR(-ENOENT);
1161
1162         entry = devm_kzalloc(dev, sizeof(*entry), GFP_KERNEL);
1163         if (!entry)
1164                 return ERR_PTR(-ENOMEM);
1165
1166         entry->read = read_fn;
1167         entry->dev = dev;
1168
1169         return debugfs_create_file(name, S_IRUGO, parent, entry,
1170                                    &debugfs_devm_entry_ops);
1171 }
1172 EXPORT_SYMBOL_GPL(debugfs_create_devm_seqfile);