1 // SPDX-License-Identifier: GPL-2.0
3 * file.c - part of debugfs, a tiny little debug file system
5 * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
6 * Copyright (C) 2004 IBM Inc.
8 * debugfs is for people to use instead of /proc or /sys.
9 * See Documentation/filesystems/ for more details.
12 #include <linux/module.h>
14 #include <linux/seq_file.h>
15 #include <linux/pagemap.h>
16 #include <linux/debugfs.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>
27 struct poll_table_struct;
29 static ssize_t default_read_file(struct file *file, char __user *buf,
30 size_t count, loff_t *ppos)
35 static ssize_t default_write_file(struct file *file, const char __user *buf,
36 size_t count, loff_t *ppos)
41 const struct file_operations debugfs_noop_file_operations = {
42 .read = default_read_file,
43 .write = default_write_file,
45 .llseek = noop_llseek,
48 #define F_DENTRY(filp) ((filp)->f_path.dentry)
50 const struct file_operations *debugfs_real_fops(const struct file *filp)
52 struct debugfs_fsdata *fsd = F_DENTRY(filp)->d_fsdata;
54 if ((unsigned long)fsd & DEBUGFS_FSDATA_IS_REAL_FOPS_BIT) {
56 * Urgh, we've been called w/o a protecting
63 return fsd->real_fops;
65 EXPORT_SYMBOL_GPL(debugfs_real_fops);
68 * debugfs_file_get - mark the beginning of file data access
69 * @dentry: the dentry object whose data is being accessed.
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.
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.
82 int debugfs_file_get(struct dentry *dentry)
84 struct debugfs_fsdata *fsd;
87 d_fsd = READ_ONCE(dentry->d_fsdata);
88 if (!((unsigned long)d_fsd & DEBUGFS_FSDATA_IS_REAL_FOPS_BIT)) {
91 fsd = kmalloc(sizeof(*fsd), GFP_KERNEL);
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) {
101 fsd = READ_ONCE(dentry->d_fsdata);
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
113 if (d_unlinked(dentry))
116 if (!refcount_inc_not_zero(&fsd->active_users))
121 EXPORT_SYMBOL_GPL(debugfs_file_get);
124 * debugfs_file_put - mark the end of file data access
125 * @dentry: the dentry object formerly passed to
126 * debugfs_file_get().
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.
132 void debugfs_file_put(struct dentry *dentry)
134 struct debugfs_fsdata *fsd = READ_ONCE(dentry->d_fsdata);
136 if (refcount_dec_and_test(&fsd->active_users))
137 complete(&fsd->active_users_drained);
139 EXPORT_SYMBOL_GPL(debugfs_file_put);
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.
146 static int debugfs_locked_down(struct inode *inode,
148 const struct file_operations *real_fops)
150 if ((inode->i_mode & 07777 & ~0444) == 0 &&
151 !(filp->f_mode & FMODE_WRITE) &&
152 !real_fops->unlocked_ioctl &&
153 !real_fops->compat_ioctl &&
157 if (security_locked_down(LOCKDOWN_DEBUGFS))
163 static int open_proxy_open(struct inode *inode, struct file *filp)
165 struct dentry *dentry = F_DENTRY(filp);
166 const struct file_operations *real_fops = NULL;
169 r = debugfs_file_get(dentry);
171 return r == -EIO ? -ENOENT : r;
173 real_fops = debugfs_real_fops(filp);
175 r = debugfs_locked_down(inode, filp, real_fops);
179 if (!fops_get(real_fops)) {
180 #ifdef CONFIG_MODULES
181 if (real_fops->owner &&
182 real_fops->owner->state == MODULE_STATE_GOING) {
188 /* Huh? Module did not clean up after itself at exit? */
189 WARN(1, "debugfs file owner did not clean up at exit: %pd",
194 replace_fops(filp, real_fops);
197 r = real_fops->open(inode, filp);
200 debugfs_file_put(dentry);
204 const struct file_operations debugfs_open_proxy_file_operations = {
205 .open = open_proxy_open,
208 #define PROTO(args...) args
209 #define ARGS(args...) args
211 #define FULL_PROXY_FUNC(name, ret_type, filp, proto, args) \
212 static ret_type full_proxy_ ## name(proto) \
214 struct dentry *dentry = F_DENTRY(filp); \
215 const struct file_operations *real_fops; \
218 r = debugfs_file_get(dentry); \
221 real_fops = debugfs_real_fops(filp); \
222 r = real_fops->name(args); \
223 debugfs_file_put(dentry); \
227 FULL_PROXY_FUNC(llseek, loff_t, filp,
228 PROTO(struct file *filp, loff_t offset, int whence),
229 ARGS(filp, offset, whence));
231 FULL_PROXY_FUNC(read, ssize_t, filp,
232 PROTO(struct file *filp, char __user *buf, size_t size,
234 ARGS(filp, buf, size, ppos));
236 FULL_PROXY_FUNC(write, ssize_t, filp,
237 PROTO(struct file *filp, const char __user *buf, size_t size,
239 ARGS(filp, buf, size, ppos));
241 FULL_PROXY_FUNC(unlocked_ioctl, long, filp,
242 PROTO(struct file *filp, unsigned int cmd, unsigned long arg),
243 ARGS(filp, cmd, arg));
245 static __poll_t full_proxy_poll(struct file *filp,
246 struct poll_table_struct *wait)
248 struct dentry *dentry = F_DENTRY(filp);
250 const struct file_operations *real_fops;
252 if (debugfs_file_get(dentry))
255 real_fops = debugfs_real_fops(filp);
256 r = real_fops->poll(filp, wait);
257 debugfs_file_put(dentry);
261 static int full_proxy_release(struct inode *inode, struct file *filp)
263 const struct dentry *dentry = F_DENTRY(filp);
264 const struct file_operations *real_fops = debugfs_real_fops(filp);
265 const struct file_operations *proxy_fops = filp->f_op;
269 * We must not protect this against removal races here: the
270 * original releaser should be called unconditionally in order
271 * not to leak any resources. Releasers must not assume that
272 * ->i_private is still being meaningful here.
274 if (real_fops->release)
275 r = real_fops->release(inode, filp);
277 replace_fops(filp, d_inode(dentry)->i_fop);
283 static void __full_proxy_fops_init(struct file_operations *proxy_fops,
284 const struct file_operations *real_fops)
286 proxy_fops->release = full_proxy_release;
287 if (real_fops->llseek)
288 proxy_fops->llseek = full_proxy_llseek;
290 proxy_fops->read = full_proxy_read;
291 if (real_fops->write)
292 proxy_fops->write = full_proxy_write;
294 proxy_fops->poll = full_proxy_poll;
295 if (real_fops->unlocked_ioctl)
296 proxy_fops->unlocked_ioctl = full_proxy_unlocked_ioctl;
299 static int full_proxy_open(struct inode *inode, struct file *filp)
301 struct dentry *dentry = F_DENTRY(filp);
302 const struct file_operations *real_fops = NULL;
303 struct file_operations *proxy_fops = NULL;
306 r = debugfs_file_get(dentry);
308 return r == -EIO ? -ENOENT : r;
310 real_fops = debugfs_real_fops(filp);
312 r = debugfs_locked_down(inode, filp, real_fops);
316 if (!fops_get(real_fops)) {
317 #ifdef CONFIG_MODULES
318 if (real_fops->owner &&
319 real_fops->owner->state == MODULE_STATE_GOING) {
325 /* Huh? Module did not cleanup after itself at exit? */
326 WARN(1, "debugfs file owner did not clean up at exit: %pd",
332 proxy_fops = kzalloc(sizeof(*proxy_fops), GFP_KERNEL);
337 __full_proxy_fops_init(proxy_fops, real_fops);
338 replace_fops(filp, proxy_fops);
340 if (real_fops->open) {
341 r = real_fops->open(inode, filp);
343 replace_fops(filp, d_inode(dentry)->i_fop);
345 } else if (filp->f_op != proxy_fops) {
346 /* No protection against file removal anymore. */
347 WARN(1, "debugfs file owner replaced proxy fops: %pd",
358 debugfs_file_put(dentry);
362 const struct file_operations debugfs_full_proxy_file_operations = {
363 .open = full_proxy_open,
366 ssize_t debugfs_attr_read(struct file *file, char __user *buf,
367 size_t len, loff_t *ppos)
369 struct dentry *dentry = F_DENTRY(file);
372 ret = debugfs_file_get(dentry);
375 ret = simple_attr_read(file, buf, len, ppos);
376 debugfs_file_put(dentry);
379 EXPORT_SYMBOL_GPL(debugfs_attr_read);
381 static ssize_t debugfs_attr_write_xsigned(struct file *file, const char __user *buf,
382 size_t len, loff_t *ppos, bool is_signed)
384 struct dentry *dentry = F_DENTRY(file);
387 ret = debugfs_file_get(dentry);
391 ret = simple_attr_write_signed(file, buf, len, ppos);
393 ret = simple_attr_write(file, buf, len, ppos);
394 debugfs_file_put(dentry);
398 ssize_t debugfs_attr_write(struct file *file, const char __user *buf,
399 size_t len, loff_t *ppos)
401 return debugfs_attr_write_xsigned(file, buf, len, ppos, false);
403 EXPORT_SYMBOL_GPL(debugfs_attr_write);
405 ssize_t debugfs_attr_write_signed(struct file *file, const char __user *buf,
406 size_t len, loff_t *ppos)
408 return debugfs_attr_write_xsigned(file, buf, len, ppos, true);
410 EXPORT_SYMBOL_GPL(debugfs_attr_write_signed);
412 static struct dentry *debugfs_create_mode_unsafe(const char *name, umode_t mode,
413 struct dentry *parent, void *value,
414 const struct file_operations *fops,
415 const struct file_operations *fops_ro,
416 const struct file_operations *fops_wo)
418 /* if there are no write bits set, make read only */
419 if (!(mode & S_IWUGO))
420 return debugfs_create_file_unsafe(name, mode, parent, value,
422 /* if there are no read bits set, make write only */
423 if (!(mode & S_IRUGO))
424 return debugfs_create_file_unsafe(name, mode, parent, value,
427 return debugfs_create_file_unsafe(name, mode, parent, value, fops);
430 static int debugfs_u8_set(void *data, u64 val)
435 static int debugfs_u8_get(void *data, u64 *val)
440 DEFINE_DEBUGFS_ATTRIBUTE(fops_u8, debugfs_u8_get, debugfs_u8_set, "%llu\n");
441 DEFINE_DEBUGFS_ATTRIBUTE(fops_u8_ro, debugfs_u8_get, NULL, "%llu\n");
442 DEFINE_DEBUGFS_ATTRIBUTE(fops_u8_wo, NULL, debugfs_u8_set, "%llu\n");
445 * debugfs_create_u8 - create a debugfs file that is used to read and write an unsigned 8-bit value
446 * @name: a pointer to a string containing the name of the file to create.
447 * @mode: the permission that the file should have
448 * @parent: a pointer to the parent dentry for this file. This should be a
449 * directory dentry if set. If this parameter is %NULL, then the
450 * file will be created in the root of the debugfs filesystem.
451 * @value: a pointer to the variable that the file should read to and write
454 * This function creates a file in debugfs with the given name that
455 * contains the value of the variable @value. If the @mode variable is so
456 * set, it can be read from, and written to.
458 void debugfs_create_u8(const char *name, umode_t mode, struct dentry *parent,
461 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u8,
462 &fops_u8_ro, &fops_u8_wo);
464 EXPORT_SYMBOL_GPL(debugfs_create_u8);
466 static int debugfs_u16_set(void *data, u64 val)
471 static int debugfs_u16_get(void *data, u64 *val)
476 DEFINE_DEBUGFS_ATTRIBUTE(fops_u16, debugfs_u16_get, debugfs_u16_set, "%llu\n");
477 DEFINE_DEBUGFS_ATTRIBUTE(fops_u16_ro, debugfs_u16_get, NULL, "%llu\n");
478 DEFINE_DEBUGFS_ATTRIBUTE(fops_u16_wo, NULL, debugfs_u16_set, "%llu\n");
481 * debugfs_create_u16 - create a debugfs file that is used to read and write an unsigned 16-bit value
482 * @name: a pointer to a string containing the name of the file to create.
483 * @mode: the permission that the file should have
484 * @parent: a pointer to the parent dentry for this file. This should be a
485 * directory dentry if set. If this parameter is %NULL, then the
486 * file will be created in the root of the debugfs filesystem.
487 * @value: a pointer to the variable that the file should read to and write
490 * This function creates a file in debugfs with the given name that
491 * contains the value of the variable @value. If the @mode variable is so
492 * set, it can be read from, and written to.
494 void debugfs_create_u16(const char *name, umode_t mode, struct dentry *parent,
497 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u16,
498 &fops_u16_ro, &fops_u16_wo);
500 EXPORT_SYMBOL_GPL(debugfs_create_u16);
502 static int debugfs_u32_set(void *data, u64 val)
507 static int debugfs_u32_get(void *data, u64 *val)
512 DEFINE_DEBUGFS_ATTRIBUTE(fops_u32, debugfs_u32_get, debugfs_u32_set, "%llu\n");
513 DEFINE_DEBUGFS_ATTRIBUTE(fops_u32_ro, debugfs_u32_get, NULL, "%llu\n");
514 DEFINE_DEBUGFS_ATTRIBUTE(fops_u32_wo, NULL, debugfs_u32_set, "%llu\n");
517 * debugfs_create_u32 - create a debugfs file that is used to read and write an unsigned 32-bit value
518 * @name: a pointer to a string containing the name of the file to create.
519 * @mode: the permission that the file should have
520 * @parent: a pointer to the parent dentry for this file. This should be a
521 * directory dentry if set. If this parameter is %NULL, then the
522 * file will be created in the root of the debugfs filesystem.
523 * @value: a pointer to the variable that the file should read to and write
526 * This function creates a file in debugfs with the given name that
527 * contains the value of the variable @value. If the @mode variable is so
528 * set, it can be read from, and written to.
530 void debugfs_create_u32(const char *name, umode_t mode, struct dentry *parent,
533 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u32,
534 &fops_u32_ro, &fops_u32_wo);
536 EXPORT_SYMBOL_GPL(debugfs_create_u32);
538 static int debugfs_u64_set(void *data, u64 val)
544 static int debugfs_u64_get(void *data, u64 *val)
549 DEFINE_DEBUGFS_ATTRIBUTE(fops_u64, debugfs_u64_get, debugfs_u64_set, "%llu\n");
550 DEFINE_DEBUGFS_ATTRIBUTE(fops_u64_ro, debugfs_u64_get, NULL, "%llu\n");
551 DEFINE_DEBUGFS_ATTRIBUTE(fops_u64_wo, NULL, debugfs_u64_set, "%llu\n");
554 * debugfs_create_u64 - create a debugfs file that is used to read and write an unsigned 64-bit value
555 * @name: a pointer to a string containing the name of the file to create.
556 * @mode: the permission that the file should have
557 * @parent: a pointer to the parent dentry for this file. This should be a
558 * directory dentry if set. If this parameter is %NULL, then the
559 * file will be created in the root of the debugfs filesystem.
560 * @value: a pointer to the variable that the file should read to and write
563 * This function creates a file in debugfs with the given name that
564 * contains the value of the variable @value. If the @mode variable is so
565 * set, it can be read from, and written to.
567 void debugfs_create_u64(const char *name, umode_t mode, struct dentry *parent,
570 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u64,
571 &fops_u64_ro, &fops_u64_wo);
573 EXPORT_SYMBOL_GPL(debugfs_create_u64);
575 static int debugfs_ulong_set(void *data, u64 val)
577 *(unsigned long *)data = val;
581 static int debugfs_ulong_get(void *data, u64 *val)
583 *val = *(unsigned long *)data;
586 DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong, debugfs_ulong_get, debugfs_ulong_set,
588 DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong_ro, debugfs_ulong_get, NULL, "%llu\n");
589 DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong_wo, NULL, debugfs_ulong_set, "%llu\n");
592 * debugfs_create_ulong - create a debugfs file that is used to read and write
593 * an unsigned long value.
594 * @name: a pointer to a string containing the name of the file to create.
595 * @mode: the permission that the file should have
596 * @parent: a pointer to the parent dentry for this file. This should be a
597 * directory dentry if set. If this parameter is %NULL, then the
598 * file will be created in the root of the debugfs filesystem.
599 * @value: a pointer to the variable that the file should read to and write
602 * This function creates a file in debugfs with the given name that
603 * contains the value of the variable @value. If the @mode variable is so
604 * set, it can be read from, and written to.
606 void debugfs_create_ulong(const char *name, umode_t mode, struct dentry *parent,
607 unsigned long *value)
609 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_ulong,
610 &fops_ulong_ro, &fops_ulong_wo);
612 EXPORT_SYMBOL_GPL(debugfs_create_ulong);
614 DEFINE_DEBUGFS_ATTRIBUTE(fops_x8, debugfs_u8_get, debugfs_u8_set, "0x%02llx\n");
615 DEFINE_DEBUGFS_ATTRIBUTE(fops_x8_ro, debugfs_u8_get, NULL, "0x%02llx\n");
616 DEFINE_DEBUGFS_ATTRIBUTE(fops_x8_wo, NULL, debugfs_u8_set, "0x%02llx\n");
618 DEFINE_DEBUGFS_ATTRIBUTE(fops_x16, debugfs_u16_get, debugfs_u16_set,
620 DEFINE_DEBUGFS_ATTRIBUTE(fops_x16_ro, debugfs_u16_get, NULL, "0x%04llx\n");
621 DEFINE_DEBUGFS_ATTRIBUTE(fops_x16_wo, NULL, debugfs_u16_set, "0x%04llx\n");
623 DEFINE_DEBUGFS_ATTRIBUTE(fops_x32, debugfs_u32_get, debugfs_u32_set,
625 DEFINE_DEBUGFS_ATTRIBUTE(fops_x32_ro, debugfs_u32_get, NULL, "0x%08llx\n");
626 DEFINE_DEBUGFS_ATTRIBUTE(fops_x32_wo, NULL, debugfs_u32_set, "0x%08llx\n");
628 DEFINE_DEBUGFS_ATTRIBUTE(fops_x64, debugfs_u64_get, debugfs_u64_set,
630 DEFINE_DEBUGFS_ATTRIBUTE(fops_x64_ro, debugfs_u64_get, NULL, "0x%016llx\n");
631 DEFINE_DEBUGFS_ATTRIBUTE(fops_x64_wo, NULL, debugfs_u64_set, "0x%016llx\n");
634 * 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
636 * These functions are exactly the same as the above functions (but use a hex
637 * output for the decimal challenged). For details look at the above unsigned
642 * debugfs_create_x8 - create a debugfs file that is used to read and write an unsigned 8-bit value
643 * @name: a pointer to a string containing the name of the file to create.
644 * @mode: the permission that the file should have
645 * @parent: a pointer to the parent dentry for this file. This should be a
646 * directory dentry if set. If this parameter is %NULL, then the
647 * file will be created in the root of the debugfs filesystem.
648 * @value: a pointer to the variable that the file should read to and write
651 void debugfs_create_x8(const char *name, umode_t mode, struct dentry *parent,
654 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x8,
655 &fops_x8_ro, &fops_x8_wo);
657 EXPORT_SYMBOL_GPL(debugfs_create_x8);
660 * debugfs_create_x16 - create a debugfs file that is used to read and write an unsigned 16-bit value
661 * @name: a pointer to a string containing the name of the file to create.
662 * @mode: the permission that the file should have
663 * @parent: a pointer to the parent dentry for this file. This should be a
664 * directory dentry if set. If this parameter is %NULL, then the
665 * file will be created in the root of the debugfs filesystem.
666 * @value: a pointer to the variable that the file should read to and write
669 void debugfs_create_x16(const char *name, umode_t mode, struct dentry *parent,
672 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x16,
673 &fops_x16_ro, &fops_x16_wo);
675 EXPORT_SYMBOL_GPL(debugfs_create_x16);
678 * debugfs_create_x32 - create a debugfs file that is used to read and write an unsigned 32-bit value
679 * @name: a pointer to a string containing the name of the file to create.
680 * @mode: the permission that the file should have
681 * @parent: a pointer to the parent dentry for this file. This should be a
682 * directory dentry if set. If this parameter is %NULL, then the
683 * file will be created in the root of the debugfs filesystem.
684 * @value: a pointer to the variable that the file should read to and write
687 void debugfs_create_x32(const char *name, umode_t mode, struct dentry *parent,
690 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x32,
691 &fops_x32_ro, &fops_x32_wo);
693 EXPORT_SYMBOL_GPL(debugfs_create_x32);
696 * debugfs_create_x64 - create a debugfs file that is used to read and write an unsigned 64-bit value
697 * @name: a pointer to a string containing the name of the file to create.
698 * @mode: the permission that the file should have
699 * @parent: a pointer to the parent dentry for this file. This should be a
700 * directory dentry if set. If this parameter is %NULL, then the
701 * file will be created in the root of the debugfs filesystem.
702 * @value: a pointer to the variable that the file should read to and write
705 void debugfs_create_x64(const char *name, umode_t mode, struct dentry *parent,
708 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x64,
709 &fops_x64_ro, &fops_x64_wo);
711 EXPORT_SYMBOL_GPL(debugfs_create_x64);
714 static int debugfs_size_t_set(void *data, u64 val)
716 *(size_t *)data = val;
719 static int debugfs_size_t_get(void *data, u64 *val)
721 *val = *(size_t *)data;
724 DEFINE_DEBUGFS_ATTRIBUTE(fops_size_t, debugfs_size_t_get, debugfs_size_t_set,
725 "%llu\n"); /* %llu and %zu are more or less the same */
726 DEFINE_DEBUGFS_ATTRIBUTE(fops_size_t_ro, debugfs_size_t_get, NULL, "%llu\n");
727 DEFINE_DEBUGFS_ATTRIBUTE(fops_size_t_wo, NULL, debugfs_size_t_set, "%llu\n");
730 * debugfs_create_size_t - create a debugfs file that is used to read and write an size_t value
731 * @name: a pointer to a string containing the name of the file to create.
732 * @mode: the permission that the file should have
733 * @parent: a pointer to the parent dentry for this file. This should be a
734 * directory dentry if set. If this parameter is %NULL, then the
735 * file will be created in the root of the debugfs filesystem.
736 * @value: a pointer to the variable that the file should read to and write
739 void debugfs_create_size_t(const char *name, umode_t mode,
740 struct dentry *parent, size_t *value)
742 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_size_t,
743 &fops_size_t_ro, &fops_size_t_wo);
745 EXPORT_SYMBOL_GPL(debugfs_create_size_t);
747 static int debugfs_atomic_t_set(void *data, u64 val)
749 atomic_set((atomic_t *)data, val);
752 static int debugfs_atomic_t_get(void *data, u64 *val)
754 *val = atomic_read((atomic_t *)data);
757 DEFINE_DEBUGFS_ATTRIBUTE_SIGNED(fops_atomic_t, debugfs_atomic_t_get,
758 debugfs_atomic_t_set, "%lld\n");
759 DEFINE_DEBUGFS_ATTRIBUTE_SIGNED(fops_atomic_t_ro, debugfs_atomic_t_get, NULL,
761 DEFINE_DEBUGFS_ATTRIBUTE_SIGNED(fops_atomic_t_wo, NULL, debugfs_atomic_t_set,
765 * debugfs_create_atomic_t - create a debugfs file that is used to read and
766 * write an atomic_t value
767 * @name: a pointer to a string containing the name of the file to create.
768 * @mode: the permission that the file should have
769 * @parent: a pointer to the parent dentry for this file. This should be a
770 * directory dentry if set. If this parameter is %NULL, then the
771 * file will be created in the root of the debugfs filesystem.
772 * @value: a pointer to the variable that the file should read to and write
775 void debugfs_create_atomic_t(const char *name, umode_t mode,
776 struct dentry *parent, atomic_t *value)
778 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_atomic_t,
779 &fops_atomic_t_ro, &fops_atomic_t_wo);
781 EXPORT_SYMBOL_GPL(debugfs_create_atomic_t);
783 ssize_t debugfs_read_file_bool(struct file *file, char __user *user_buf,
784 size_t count, loff_t *ppos)
789 struct dentry *dentry = F_DENTRY(file);
791 r = debugfs_file_get(dentry);
794 val = *(bool *)file->private_data;
795 debugfs_file_put(dentry);
802 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
804 EXPORT_SYMBOL_GPL(debugfs_read_file_bool);
806 ssize_t debugfs_write_file_bool(struct file *file, const char __user *user_buf,
807 size_t count, loff_t *ppos)
811 bool *val = file->private_data;
812 struct dentry *dentry = F_DENTRY(file);
814 r = kstrtobool_from_user(user_buf, count, &bv);
816 r = debugfs_file_get(dentry);
820 debugfs_file_put(dentry);
825 EXPORT_SYMBOL_GPL(debugfs_write_file_bool);
827 static const struct file_operations fops_bool = {
828 .read = debugfs_read_file_bool,
829 .write = debugfs_write_file_bool,
831 .llseek = default_llseek,
834 static const struct file_operations fops_bool_ro = {
835 .read = debugfs_read_file_bool,
837 .llseek = default_llseek,
840 static const struct file_operations fops_bool_wo = {
841 .write = debugfs_write_file_bool,
843 .llseek = default_llseek,
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
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.
860 void debugfs_create_bool(const char *name, umode_t mode, struct dentry *parent,
863 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_bool,
864 &fops_bool_ro, &fops_bool_wo);
866 EXPORT_SYMBOL_GPL(debugfs_create_bool);
868 ssize_t debugfs_read_file_str(struct file *file, char __user *user_buf,
869 size_t count, loff_t *ppos)
871 struct dentry *dentry = F_DENTRY(file);
872 char *str, *copy = NULL;
876 ret = debugfs_file_get(dentry);
880 str = *(char **)file->private_data;
881 len = strlen(str) + 1;
882 copy = kmalloc(len, GFP_KERNEL);
884 debugfs_file_put(dentry);
888 copy_len = strscpy(copy, str, len);
889 debugfs_file_put(dentry);
895 copy[copy_len] = '\n';
897 ret = simple_read_from_buffer(user_buf, count, ppos, copy, len);
902 EXPORT_SYMBOL_GPL(debugfs_create_str);
904 static ssize_t debugfs_write_file_str(struct file *file, const char __user *user_buf,
905 size_t count, loff_t *ppos)
907 struct dentry *dentry = F_DENTRY(file);
908 char *old, *new = NULL;
912 r = debugfs_file_get(dentry);
916 old = *(char **)file->private_data;
918 /* only allow strict concatenation */
920 if (pos && pos != strlen(old))
924 if (pos + count + 1 > PAGE_SIZE)
928 new = kmalloc(pos + count + 1, GFP_KERNEL);
933 memcpy(new, old, pos);
936 if (copy_from_user(new + pos, user_buf, count))
939 new[pos + count] = '\0';
942 rcu_assign_pointer(*(char **)file->private_data, new);
946 debugfs_file_put(dentry);
951 debugfs_file_put(dentry);
955 static const struct file_operations fops_str = {
956 .read = debugfs_read_file_str,
957 .write = debugfs_write_file_str,
959 .llseek = default_llseek,
962 static const struct file_operations fops_str_ro = {
963 .read = debugfs_read_file_str,
965 .llseek = default_llseek,
968 static const struct file_operations fops_str_wo = {
969 .write = debugfs_write_file_str,
971 .llseek = default_llseek,
975 * debugfs_create_str - create a debugfs file that is used to read and write a string value
976 * @name: a pointer to a string containing the name of the file to create.
977 * @mode: the permission that the file should have
978 * @parent: a pointer to the parent dentry for this file. This should be a
979 * directory dentry if set. If this parameter is %NULL, then the
980 * file will be created in the root of the debugfs filesystem.
981 * @value: a pointer to the variable that the file should read to and write
984 * This function creates a file in debugfs with the given name that
985 * contains the value of the variable @value. If the @mode variable is so
986 * set, it can be read from, and written to.
988 void debugfs_create_str(const char *name, umode_t mode,
989 struct dentry *parent, char **value)
991 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_str,
992 &fops_str_ro, &fops_str_wo);
995 static ssize_t read_file_blob(struct file *file, char __user *user_buf,
996 size_t count, loff_t *ppos)
998 struct debugfs_blob_wrapper *blob = file->private_data;
999 struct dentry *dentry = F_DENTRY(file);
1002 r = debugfs_file_get(dentry);
1005 r = simple_read_from_buffer(user_buf, count, ppos, blob->data,
1007 debugfs_file_put(dentry);
1011 static const struct file_operations fops_blob = {
1012 .read = read_file_blob,
1013 .open = simple_open,
1014 .llseek = default_llseek,
1018 * debugfs_create_blob - create a debugfs file that is used to read a binary blob
1019 * @name: a pointer to a string containing the name of the file to create.
1020 * @mode: the read permission that the file should have (other permissions are
1022 * @parent: a pointer to the parent dentry for this file. This should be a
1023 * directory dentry if set. If this parameter is %NULL, then the
1024 * file will be created in the root of the debugfs filesystem.
1025 * @blob: a pointer to a struct debugfs_blob_wrapper which contains a pointer
1026 * to the blob data and the size of the data.
1028 * This function creates a file in debugfs with the given name that exports
1029 * @blob->data as a binary blob. If the @mode variable is so set it can be
1030 * read from. Writing is not supported.
1032 * This function will return a pointer to a dentry if it succeeds. This
1033 * pointer must be passed to the debugfs_remove() function when the file is
1034 * to be removed (no automatic cleanup happens if your module is unloaded,
1035 * you are responsible here.) If an error occurs, ERR_PTR(-ERROR) will be
1038 * If debugfs is not enabled in the kernel, the value ERR_PTR(-ENODEV) will
1041 struct dentry *debugfs_create_blob(const char *name, umode_t mode,
1042 struct dentry *parent,
1043 struct debugfs_blob_wrapper *blob)
1045 return debugfs_create_file_unsafe(name, mode & 0444, parent, blob, &fops_blob);
1047 EXPORT_SYMBOL_GPL(debugfs_create_blob);
1049 static size_t u32_format_array(char *buf, size_t bufsize,
1050 u32 *array, int array_size)
1054 while (--array_size >= 0) {
1056 char term = array_size ? ' ' : '\n';
1058 len = snprintf(buf, bufsize, "%u%c", *array++, term);
1067 static int u32_array_open(struct inode *inode, struct file *file)
1069 struct debugfs_u32_array *data = inode->i_private;
1070 int size, elements = data->n_elements;
1075 * - 10 digits + ' '/'\n' = 11 bytes per number
1076 * - terminating NUL character
1079 buf = kmalloc(size+1, GFP_KERNEL);
1084 file->private_data = buf;
1085 u32_format_array(buf, size, data->array, data->n_elements);
1087 return nonseekable_open(inode, file);
1090 static ssize_t u32_array_read(struct file *file, char __user *buf, size_t len,
1093 size_t size = strlen(file->private_data);
1095 return simple_read_from_buffer(buf, len, ppos,
1096 file->private_data, size);
1099 static int u32_array_release(struct inode *inode, struct file *file)
1101 kfree(file->private_data);
1106 static const struct file_operations u32_array_fops = {
1107 .owner = THIS_MODULE,
1108 .open = u32_array_open,
1109 .release = u32_array_release,
1110 .read = u32_array_read,
1111 .llseek = no_llseek,
1115 * debugfs_create_u32_array - create a debugfs file that is used to read u32
1117 * @name: a pointer to a string containing the name of the file to create.
1118 * @mode: the permission that the file should have.
1119 * @parent: a pointer to the parent dentry for this file. This should be a
1120 * directory dentry if set. If this parameter is %NULL, then the
1121 * file will be created in the root of the debugfs filesystem.
1122 * @array: wrapper struct containing data pointer and size of the array.
1124 * This function creates a file in debugfs with the given name that exports
1125 * @array as data. If the @mode variable is so set it can be read from.
1126 * Writing is not supported. Seek within the file is also not supported.
1127 * Once array is created its size can not be changed.
1129 void debugfs_create_u32_array(const char *name, umode_t mode,
1130 struct dentry *parent,
1131 struct debugfs_u32_array *array)
1133 debugfs_create_file_unsafe(name, mode, parent, array, &u32_array_fops);
1135 EXPORT_SYMBOL_GPL(debugfs_create_u32_array);
1137 #ifdef CONFIG_HAS_IOMEM
1140 * The regset32 stuff is used to print 32-bit registers using the
1141 * seq_file utilities. We offer printing a register set in an already-opened
1142 * sequential file or create a debugfs file that only prints a regset32.
1146 * debugfs_print_regs32 - use seq_print to describe a set of registers
1147 * @s: the seq_file structure being used to generate output
1148 * @regs: an array if struct debugfs_reg32 structures
1149 * @nregs: the length of the above array
1150 * @base: the base address to be used in reading the registers
1151 * @prefix: a string to be prefixed to every output line
1153 * This function outputs a text block describing the current values of
1154 * some 32-bit hardware registers. It is meant to be used within debugfs
1155 * files based on seq_file that need to show registers, intermixed with other
1156 * information. The prefix argument may be used to specify a leading string,
1157 * because some peripherals have several blocks of identical registers,
1158 * for example configuration of dma channels
1160 void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
1161 int nregs, void __iomem *base, char *prefix)
1165 for (i = 0; i < nregs; i++, regs++) {
1167 seq_printf(s, "%s", prefix);
1168 seq_printf(s, "%s = 0x%08x\n", regs->name,
1169 readl(base + regs->offset));
1170 if (seq_has_overflowed(s))
1174 EXPORT_SYMBOL_GPL(debugfs_print_regs32);
1176 static int debugfs_regset32_show(struct seq_file *s, void *data)
1178 struct debugfs_regset32 *regset = s->private;
1181 pm_runtime_get_sync(regset->dev);
1183 debugfs_print_regs32(s, regset->regs, regset->nregs, regset->base, "");
1186 pm_runtime_put(regset->dev);
1191 DEFINE_SHOW_ATTRIBUTE(debugfs_regset32);
1194 * debugfs_create_regset32 - create a debugfs file that returns register values
1195 * @name: a pointer to a string containing the name of the file to create.
1196 * @mode: the permission that the file should have
1197 * @parent: a pointer to the parent dentry for this file. This should be a
1198 * directory dentry if set. If this parameter is %NULL, then the
1199 * file will be created in the root of the debugfs filesystem.
1200 * @regset: a pointer to a struct debugfs_regset32, which contains a pointer
1201 * to an array of register definitions, the array size and the base
1202 * address where the register bank is to be found.
1204 * This function creates a file in debugfs with the given name that reports
1205 * the names and values of a set of 32-bit registers. If the @mode variable
1206 * is so set it can be read from. Writing is not supported.
1208 void debugfs_create_regset32(const char *name, umode_t mode,
1209 struct dentry *parent,
1210 struct debugfs_regset32 *regset)
1212 debugfs_create_file(name, mode, parent, regset, &debugfs_regset32_fops);
1214 EXPORT_SYMBOL_GPL(debugfs_create_regset32);
1216 #endif /* CONFIG_HAS_IOMEM */
1218 struct debugfs_devm_entry {
1219 int (*read)(struct seq_file *seq, void *data);
1223 static int debugfs_devm_entry_open(struct inode *inode, struct file *f)
1225 struct debugfs_devm_entry *entry = inode->i_private;
1227 return single_open(f, entry->read, entry->dev);
1230 static const struct file_operations debugfs_devm_entry_ops = {
1231 .owner = THIS_MODULE,
1232 .open = debugfs_devm_entry_open,
1233 .release = single_release,
1239 * debugfs_create_devm_seqfile - create a debugfs file that is bound to device.
1241 * @dev: device related to this debugfs file.
1242 * @name: name of the debugfs file.
1243 * @parent: a pointer to the parent dentry for this file. This should be a
1244 * directory dentry if set. If this parameter is %NULL, then the
1245 * file will be created in the root of the debugfs filesystem.
1246 * @read_fn: function pointer called to print the seq_file content.
1248 void debugfs_create_devm_seqfile(struct device *dev, const char *name,
1249 struct dentry *parent,
1250 int (*read_fn)(struct seq_file *s, void *data))
1252 struct debugfs_devm_entry *entry;
1257 entry = devm_kzalloc(dev, sizeof(*entry), GFP_KERNEL);
1261 entry->read = read_fn;
1264 debugfs_create_file(name, S_IRUGO, parent, entry,
1265 &debugfs_devm_entry_ops);
1267 EXPORT_SYMBOL_GPL(debugfs_create_devm_seqfile);