Merge tag 'for-linus' of git://github.com/openrisc/linux
[linux-2.6-microblaze.git] / 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 <greg@kroah.com>
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 CONFIG_MODULES
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(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 CONFIG_MODULES
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 void debugfs_create_u32(const char *name, umode_t mode, struct dentry *parent,
511                         u32 *value)
512 {
513         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u32,
514                                    &fops_u32_ro, &fops_u32_wo);
515 }
516 EXPORT_SYMBOL_GPL(debugfs_create_u32);
517
518 static int debugfs_u64_set(void *data, u64 val)
519 {
520         *(u64 *)data = val;
521         return 0;
522 }
523
524 static int debugfs_u64_get(void *data, u64 *val)
525 {
526         *val = *(u64 *)data;
527         return 0;
528 }
529 DEFINE_DEBUGFS_ATTRIBUTE(fops_u64, debugfs_u64_get, debugfs_u64_set, "%llu\n");
530 DEFINE_DEBUGFS_ATTRIBUTE(fops_u64_ro, debugfs_u64_get, NULL, "%llu\n");
531 DEFINE_DEBUGFS_ATTRIBUTE(fops_u64_wo, NULL, debugfs_u64_set, "%llu\n");
532
533 /**
534  * debugfs_create_u64 - create a debugfs file that is used to read and write an unsigned 64-bit value
535  * @name: a pointer to a string containing the name of the file to create.
536  * @mode: the permission that the file should have
537  * @parent: a pointer to the parent dentry for this file.  This should be a
538  *          directory dentry if set.  If this parameter is %NULL, then the
539  *          file will be created in the root of the debugfs filesystem.
540  * @value: a pointer to the variable that the file should read to and write
541  *         from.
542  *
543  * This function creates a file in debugfs with the given name that
544  * contains the value of the variable @value.  If the @mode variable is so
545  * set, it can be read from, and written to.
546  */
547 void debugfs_create_u64(const char *name, umode_t mode, struct dentry *parent,
548                         u64 *value)
549 {
550         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u64,
551                                    &fops_u64_ro, &fops_u64_wo);
552 }
553 EXPORT_SYMBOL_GPL(debugfs_create_u64);
554
555 static int debugfs_ulong_set(void *data, u64 val)
556 {
557         *(unsigned long *)data = val;
558         return 0;
559 }
560
561 static int debugfs_ulong_get(void *data, u64 *val)
562 {
563         *val = *(unsigned long *)data;
564         return 0;
565 }
566 DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong, debugfs_ulong_get, debugfs_ulong_set,
567                         "%llu\n");
568 DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong_ro, debugfs_ulong_get, NULL, "%llu\n");
569 DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong_wo, NULL, debugfs_ulong_set, "%llu\n");
570
571 /**
572  * debugfs_create_ulong - create a debugfs file that is used to read and write
573  * an unsigned long value.
574  * @name: a pointer to a string containing the name of the file to create.
575  * @mode: the permission that the file should have
576  * @parent: a pointer to the parent dentry for this file.  This should be a
577  *          directory dentry if set.  If this parameter is %NULL, then the
578  *          file will be created in the root of the debugfs filesystem.
579  * @value: a pointer to the variable that the file should read to and write
580  *         from.
581  *
582  * This function creates a file in debugfs with the given name that
583  * contains the value of the variable @value.  If the @mode variable is so
584  * set, it can be read from, and written to.
585  */
586 void debugfs_create_ulong(const char *name, umode_t mode, struct dentry *parent,
587                           unsigned long *value)
588 {
589         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_ulong,
590                                    &fops_ulong_ro, &fops_ulong_wo);
591 }
592 EXPORT_SYMBOL_GPL(debugfs_create_ulong);
593
594 DEFINE_DEBUGFS_ATTRIBUTE(fops_x8, debugfs_u8_get, debugfs_u8_set, "0x%02llx\n");
595 DEFINE_DEBUGFS_ATTRIBUTE(fops_x8_ro, debugfs_u8_get, NULL, "0x%02llx\n");
596 DEFINE_DEBUGFS_ATTRIBUTE(fops_x8_wo, NULL, debugfs_u8_set, "0x%02llx\n");
597
598 DEFINE_DEBUGFS_ATTRIBUTE(fops_x16, debugfs_u16_get, debugfs_u16_set,
599                         "0x%04llx\n");
600 DEFINE_DEBUGFS_ATTRIBUTE(fops_x16_ro, debugfs_u16_get, NULL, "0x%04llx\n");
601 DEFINE_DEBUGFS_ATTRIBUTE(fops_x16_wo, NULL, debugfs_u16_set, "0x%04llx\n");
602
603 DEFINE_DEBUGFS_ATTRIBUTE(fops_x32, debugfs_u32_get, debugfs_u32_set,
604                         "0x%08llx\n");
605 DEFINE_DEBUGFS_ATTRIBUTE(fops_x32_ro, debugfs_u32_get, NULL, "0x%08llx\n");
606 DEFINE_DEBUGFS_ATTRIBUTE(fops_x32_wo, NULL, debugfs_u32_set, "0x%08llx\n");
607
608 DEFINE_DEBUGFS_ATTRIBUTE(fops_x64, debugfs_u64_get, debugfs_u64_set,
609                         "0x%016llx\n");
610 DEFINE_DEBUGFS_ATTRIBUTE(fops_x64_ro, debugfs_u64_get, NULL, "0x%016llx\n");
611 DEFINE_DEBUGFS_ATTRIBUTE(fops_x64_wo, NULL, debugfs_u64_set, "0x%016llx\n");
612
613 /*
614  * 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
615  *
616  * These functions are exactly the same as the above functions (but use a hex
617  * output for the decimal challenged). For details look at the above unsigned
618  * decimal functions.
619  */
620
621 /**
622  * debugfs_create_x8 - create a debugfs file that is used to read and write an unsigned 8-bit value
623  * @name: a pointer to a string containing the name of the file to create.
624  * @mode: the permission that the file should have
625  * @parent: a pointer to the parent dentry for this file.  This should be a
626  *          directory dentry if set.  If this parameter is %NULL, then the
627  *          file will be created in the root of the debugfs filesystem.
628  * @value: a pointer to the variable that the file should read to and write
629  *         from.
630  */
631 void debugfs_create_x8(const char *name, umode_t mode, struct dentry *parent,
632                        u8 *value)
633 {
634         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x8,
635                                    &fops_x8_ro, &fops_x8_wo);
636 }
637 EXPORT_SYMBOL_GPL(debugfs_create_x8);
638
639 /**
640  * debugfs_create_x16 - create a debugfs file that is used to read and write an unsigned 16-bit value
641  * @name: a pointer to a string containing the name of the file to create.
642  * @mode: the permission that the file should have
643  * @parent: a pointer to the parent dentry for this file.  This should be a
644  *          directory dentry if set.  If this parameter is %NULL, then the
645  *          file will be created in the root of the debugfs filesystem.
646  * @value: a pointer to the variable that the file should read to and write
647  *         from.
648  */
649 void debugfs_create_x16(const char *name, umode_t mode, struct dentry *parent,
650                         u16 *value)
651 {
652         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x16,
653                                    &fops_x16_ro, &fops_x16_wo);
654 }
655 EXPORT_SYMBOL_GPL(debugfs_create_x16);
656
657 /**
658  * debugfs_create_x32 - create a debugfs file that is used to read and write an unsigned 32-bit value
659  * @name: a pointer to a string containing the name of the file to create.
660  * @mode: the permission that the file should have
661  * @parent: a pointer to the parent dentry for this file.  This should be a
662  *          directory dentry if set.  If this parameter is %NULL, then the
663  *          file will be created in the root of the debugfs filesystem.
664  * @value: a pointer to the variable that the file should read to and write
665  *         from.
666  */
667 void debugfs_create_x32(const char *name, umode_t mode, struct dentry *parent,
668                         u32 *value)
669 {
670         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x32,
671                                    &fops_x32_ro, &fops_x32_wo);
672 }
673 EXPORT_SYMBOL_GPL(debugfs_create_x32);
674
675 /**
676  * debugfs_create_x64 - create a debugfs file that is used to read and write an unsigned 64-bit value
677  * @name: a pointer to a string containing the name of the file to create.
678  * @mode: the permission that the file should have
679  * @parent: a pointer to the parent dentry for this file.  This should be a
680  *          directory dentry if set.  If this parameter is %NULL, then the
681  *          file will be created in the root of the debugfs filesystem.
682  * @value: a pointer to the variable that the file should read to and write
683  *         from.
684  */
685 void debugfs_create_x64(const char *name, umode_t mode, struct dentry *parent,
686                         u64 *value)
687 {
688         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x64,
689                                    &fops_x64_ro, &fops_x64_wo);
690 }
691 EXPORT_SYMBOL_GPL(debugfs_create_x64);
692
693
694 static int debugfs_size_t_set(void *data, u64 val)
695 {
696         *(size_t *)data = val;
697         return 0;
698 }
699 static int debugfs_size_t_get(void *data, u64 *val)
700 {
701         *val = *(size_t *)data;
702         return 0;
703 }
704 DEFINE_DEBUGFS_ATTRIBUTE(fops_size_t, debugfs_size_t_get, debugfs_size_t_set,
705                         "%llu\n"); /* %llu and %zu are more or less the same */
706 DEFINE_DEBUGFS_ATTRIBUTE(fops_size_t_ro, debugfs_size_t_get, NULL, "%llu\n");
707 DEFINE_DEBUGFS_ATTRIBUTE(fops_size_t_wo, NULL, debugfs_size_t_set, "%llu\n");
708
709 /**
710  * debugfs_create_size_t - create a debugfs file that is used to read and write an size_t value
711  * @name: a pointer to a string containing the name of the file to create.
712  * @mode: the permission that the file should have
713  * @parent: a pointer to the parent dentry for this file.  This should be a
714  *          directory dentry if set.  If this parameter is %NULL, then the
715  *          file will be created in the root of the debugfs filesystem.
716  * @value: a pointer to the variable that the file should read to and write
717  *         from.
718  */
719 void debugfs_create_size_t(const char *name, umode_t mode,
720                            struct dentry *parent, size_t *value)
721 {
722         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_size_t,
723                                    &fops_size_t_ro, &fops_size_t_wo);
724 }
725 EXPORT_SYMBOL_GPL(debugfs_create_size_t);
726
727 static int debugfs_atomic_t_set(void *data, u64 val)
728 {
729         atomic_set((atomic_t *)data, val);
730         return 0;
731 }
732 static int debugfs_atomic_t_get(void *data, u64 *val)
733 {
734         *val = atomic_read((atomic_t *)data);
735         return 0;
736 }
737 DEFINE_DEBUGFS_ATTRIBUTE(fops_atomic_t, debugfs_atomic_t_get,
738                         debugfs_atomic_t_set, "%lld\n");
739 DEFINE_DEBUGFS_ATTRIBUTE(fops_atomic_t_ro, debugfs_atomic_t_get, NULL,
740                         "%lld\n");
741 DEFINE_DEBUGFS_ATTRIBUTE(fops_atomic_t_wo, NULL, debugfs_atomic_t_set,
742                         "%lld\n");
743
744 /**
745  * debugfs_create_atomic_t - create a debugfs file that is used to read and
746  * write an atomic_t value
747  * @name: a pointer to a string containing the name of the file to create.
748  * @mode: the permission that the file should have
749  * @parent: a pointer to the parent dentry for this file.  This should be a
750  *          directory dentry if set.  If this parameter is %NULL, then the
751  *          file will be created in the root of the debugfs filesystem.
752  * @value: a pointer to the variable that the file should read to and write
753  *         from.
754  */
755 void debugfs_create_atomic_t(const char *name, umode_t mode,
756                              struct dentry *parent, atomic_t *value)
757 {
758         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_atomic_t,
759                                    &fops_atomic_t_ro, &fops_atomic_t_wo);
760 }
761 EXPORT_SYMBOL_GPL(debugfs_create_atomic_t);
762
763 ssize_t debugfs_read_file_bool(struct file *file, char __user *user_buf,
764                                size_t count, loff_t *ppos)
765 {
766         char buf[2];
767         bool val;
768         int r;
769         struct dentry *dentry = F_DENTRY(file);
770
771         r = debugfs_file_get(dentry);
772         if (unlikely(r))
773                 return r;
774         val = *(bool *)file->private_data;
775         debugfs_file_put(dentry);
776
777         if (val)
778                 buf[0] = 'Y';
779         else
780                 buf[0] = 'N';
781         buf[1] = '\n';
782         return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
783 }
784 EXPORT_SYMBOL_GPL(debugfs_read_file_bool);
785
786 ssize_t debugfs_write_file_bool(struct file *file, const char __user *user_buf,
787                                 size_t count, loff_t *ppos)
788 {
789         bool bv;
790         int r;
791         bool *val = file->private_data;
792         struct dentry *dentry = F_DENTRY(file);
793
794         r = kstrtobool_from_user(user_buf, count, &bv);
795         if (!r) {
796                 r = debugfs_file_get(dentry);
797                 if (unlikely(r))
798                         return r;
799                 *val = bv;
800                 debugfs_file_put(dentry);
801         }
802
803         return count;
804 }
805 EXPORT_SYMBOL_GPL(debugfs_write_file_bool);
806
807 static const struct file_operations fops_bool = {
808         .read =         debugfs_read_file_bool,
809         .write =        debugfs_write_file_bool,
810         .open =         simple_open,
811         .llseek =       default_llseek,
812 };
813
814 static const struct file_operations fops_bool_ro = {
815         .read =         debugfs_read_file_bool,
816         .open =         simple_open,
817         .llseek =       default_llseek,
818 };
819
820 static const struct file_operations fops_bool_wo = {
821         .write =        debugfs_write_file_bool,
822         .open =         simple_open,
823         .llseek =       default_llseek,
824 };
825
826 /**
827  * debugfs_create_bool - create a debugfs file that is used to read and write a boolean value
828  * @name: a pointer to a string containing the name of the file to create.
829  * @mode: the permission that the file should have
830  * @parent: a pointer to the parent dentry for this file.  This should be a
831  *          directory dentry if set.  If this parameter is %NULL, then the
832  *          file will be created in the root of the debugfs filesystem.
833  * @value: a pointer to the variable that the file should read to and write
834  *         from.
835  *
836  * This function creates a file in debugfs with the given name that
837  * contains the value of the variable @value.  If the @mode variable is so
838  * set, it can be read from, and written to.
839  */
840 void debugfs_create_bool(const char *name, umode_t mode, struct dentry *parent,
841                          bool *value)
842 {
843         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_bool,
844                                    &fops_bool_ro, &fops_bool_wo);
845 }
846 EXPORT_SYMBOL_GPL(debugfs_create_bool);
847
848 ssize_t debugfs_read_file_str(struct file *file, char __user *user_buf,
849                               size_t count, loff_t *ppos)
850 {
851         struct dentry *dentry = F_DENTRY(file);
852         char *str, *copy = NULL;
853         int copy_len, len;
854         ssize_t ret;
855
856         ret = debugfs_file_get(dentry);
857         if (unlikely(ret))
858                 return ret;
859
860         str = *(char **)file->private_data;
861         len = strlen(str) + 1;
862         copy = kmalloc(len, GFP_KERNEL);
863         if (!copy) {
864                 debugfs_file_put(dentry);
865                 return -ENOMEM;
866         }
867
868         copy_len = strscpy(copy, str, len);
869         debugfs_file_put(dentry);
870         if (copy_len < 0) {
871                 kfree(copy);
872                 return copy_len;
873         }
874
875         copy[copy_len] = '\n';
876
877         ret = simple_read_from_buffer(user_buf, count, ppos, copy, len);
878         kfree(copy);
879
880         return ret;
881 }
882
883 static ssize_t debugfs_write_file_str(struct file *file, const char __user *user_buf,
884                                       size_t count, loff_t *ppos)
885 {
886         /* This is really only for read-only strings */
887         return -EINVAL;
888 }
889
890 static const struct file_operations fops_str = {
891         .read =         debugfs_read_file_str,
892         .write =        debugfs_write_file_str,
893         .open =         simple_open,
894         .llseek =       default_llseek,
895 };
896
897 static const struct file_operations fops_str_ro = {
898         .read =         debugfs_read_file_str,
899         .open =         simple_open,
900         .llseek =       default_llseek,
901 };
902
903 static const struct file_operations fops_str_wo = {
904         .write =        debugfs_write_file_str,
905         .open =         simple_open,
906         .llseek =       default_llseek,
907 };
908
909 /**
910  * debugfs_create_str - create a debugfs file that is used to read and write a string value
911  * @name: a pointer to a string containing the name of the file to create.
912  * @mode: the permission that the file should have
913  * @parent: a pointer to the parent dentry for this file.  This should be a
914  *          directory dentry if set.  If this parameter is %NULL, then the
915  *          file will be created in the root of the debugfs filesystem.
916  * @value: a pointer to the variable that the file should read to and write
917  *         from.
918  *
919  * This function creates a file in debugfs with the given name that
920  * contains the value of the variable @value.  If the @mode variable is so
921  * set, it can be read from, and written to.
922  *
923  * This function will return a pointer to a dentry if it succeeds.  This
924  * pointer must be passed to the debugfs_remove() function when the file is
925  * to be removed (no automatic cleanup happens if your module is unloaded,
926  * you are responsible here.)  If an error occurs, ERR_PTR(-ERROR) will be
927  * returned.
928  *
929  * If debugfs is not enabled in the kernel, the value ERR_PTR(-ENODEV) will
930  * be returned.
931  */
932 void debugfs_create_str(const char *name, umode_t mode,
933                         struct dentry *parent, char **value)
934 {
935         debugfs_create_mode_unsafe(name, mode, parent, value, &fops_str,
936                                    &fops_str_ro, &fops_str_wo);
937 }
938
939 static ssize_t read_file_blob(struct file *file, char __user *user_buf,
940                               size_t count, loff_t *ppos)
941 {
942         struct debugfs_blob_wrapper *blob = file->private_data;
943         struct dentry *dentry = F_DENTRY(file);
944         ssize_t r;
945
946         r = debugfs_file_get(dentry);
947         if (unlikely(r))
948                 return r;
949         r = simple_read_from_buffer(user_buf, count, ppos, blob->data,
950                                 blob->size);
951         debugfs_file_put(dentry);
952         return r;
953 }
954
955 static const struct file_operations fops_blob = {
956         .read =         read_file_blob,
957         .open =         simple_open,
958         .llseek =       default_llseek,
959 };
960
961 /**
962  * debugfs_create_blob - create a debugfs file that is used to read a binary blob
963  * @name: a pointer to a string containing the name of the file to create.
964  * @mode: the read permission that the file should have (other permissions are
965  *        masked out)
966  * @parent: a pointer to the parent dentry for this file.  This should be a
967  *          directory dentry if set.  If this parameter is %NULL, then the
968  *          file will be created in the root of the debugfs filesystem.
969  * @blob: a pointer to a struct debugfs_blob_wrapper which contains a pointer
970  *        to the blob data and the size of the data.
971  *
972  * This function creates a file in debugfs with the given name that exports
973  * @blob->data as a binary blob. If the @mode variable is so set it can be
974  * read from. Writing is not supported.
975  *
976  * This function will return a pointer to a dentry if it succeeds.  This
977  * pointer must be passed to the debugfs_remove() function when the file is
978  * to be removed (no automatic cleanup happens if your module is unloaded,
979  * you are responsible here.)  If an error occurs, ERR_PTR(-ERROR) will be
980  * returned.
981  *
982  * If debugfs is not enabled in the kernel, the value ERR_PTR(-ENODEV) will
983  * be returned.
984  */
985 struct dentry *debugfs_create_blob(const char *name, umode_t mode,
986                                    struct dentry *parent,
987                                    struct debugfs_blob_wrapper *blob)
988 {
989         return debugfs_create_file_unsafe(name, mode & 0444, parent, blob, &fops_blob);
990 }
991 EXPORT_SYMBOL_GPL(debugfs_create_blob);
992
993 static size_t u32_format_array(char *buf, size_t bufsize,
994                                u32 *array, int array_size)
995 {
996         size_t ret = 0;
997
998         while (--array_size >= 0) {
999                 size_t len;
1000                 char term = array_size ? ' ' : '\n';
1001
1002                 len = snprintf(buf, bufsize, "%u%c", *array++, term);
1003                 ret += len;
1004
1005                 buf += len;
1006                 bufsize -= len;
1007         }
1008         return ret;
1009 }
1010
1011 static int u32_array_open(struct inode *inode, struct file *file)
1012 {
1013         struct debugfs_u32_array *data = inode->i_private;
1014         int size, elements = data->n_elements;
1015         char *buf;
1016
1017         /*
1018          * Max size:
1019          *  - 10 digits + ' '/'\n' = 11 bytes per number
1020          *  - terminating NUL character
1021          */
1022         size = elements*11;
1023         buf = kmalloc(size+1, GFP_KERNEL);
1024         if (!buf)
1025                 return -ENOMEM;
1026         buf[size] = 0;
1027
1028         file->private_data = buf;
1029         u32_format_array(buf, size, data->array, data->n_elements);
1030
1031         return nonseekable_open(inode, file);
1032 }
1033
1034 static ssize_t u32_array_read(struct file *file, char __user *buf, size_t len,
1035                               loff_t *ppos)
1036 {
1037         size_t size = strlen(file->private_data);
1038
1039         return simple_read_from_buffer(buf, len, ppos,
1040                                         file->private_data, size);
1041 }
1042
1043 static int u32_array_release(struct inode *inode, struct file *file)
1044 {
1045         kfree(file->private_data);
1046
1047         return 0;
1048 }
1049
1050 static const struct file_operations u32_array_fops = {
1051         .owner   = THIS_MODULE,
1052         .open    = u32_array_open,
1053         .release = u32_array_release,
1054         .read    = u32_array_read,
1055         .llseek  = no_llseek,
1056 };
1057
1058 /**
1059  * debugfs_create_u32_array - create a debugfs file that is used to read u32
1060  * array.
1061  * @name: a pointer to a string containing the name of the file to create.
1062  * @mode: the permission that the file should have.
1063  * @parent: a pointer to the parent dentry for this file.  This should be a
1064  *          directory dentry if set.  If this parameter is %NULL, then the
1065  *          file will be created in the root of the debugfs filesystem.
1066  * @array: wrapper struct containing data pointer and size of the array.
1067  *
1068  * This function creates a file in debugfs with the given name that exports
1069  * @array as data. If the @mode variable is so set it can be read from.
1070  * Writing is not supported. Seek within the file is also not supported.
1071  * Once array is created its size can not be changed.
1072  */
1073 void debugfs_create_u32_array(const char *name, umode_t mode,
1074                               struct dentry *parent,
1075                               struct debugfs_u32_array *array)
1076 {
1077         debugfs_create_file_unsafe(name, mode, parent, array, &u32_array_fops);
1078 }
1079 EXPORT_SYMBOL_GPL(debugfs_create_u32_array);
1080
1081 #ifdef CONFIG_HAS_IOMEM
1082
1083 /*
1084  * The regset32 stuff is used to print 32-bit registers using the
1085  * seq_file utilities. We offer printing a register set in an already-opened
1086  * sequential file or create a debugfs file that only prints a regset32.
1087  */
1088
1089 /**
1090  * debugfs_print_regs32 - use seq_print to describe a set of registers
1091  * @s: the seq_file structure being used to generate output
1092  * @regs: an array if struct debugfs_reg32 structures
1093  * @nregs: the length of the above array
1094  * @base: the base address to be used in reading the registers
1095  * @prefix: a string to be prefixed to every output line
1096  *
1097  * This function outputs a text block describing the current values of
1098  * some 32-bit hardware registers. It is meant to be used within debugfs
1099  * files based on seq_file that need to show registers, intermixed with other
1100  * information. The prefix argument may be used to specify a leading string,
1101  * because some peripherals have several blocks of identical registers,
1102  * for example configuration of dma channels
1103  */
1104 void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
1105                           int nregs, void __iomem *base, char *prefix)
1106 {
1107         int i;
1108
1109         for (i = 0; i < nregs; i++, regs++) {
1110                 if (prefix)
1111                         seq_printf(s, "%s", prefix);
1112                 seq_printf(s, "%s = 0x%08x\n", regs->name,
1113                            readl(base + regs->offset));
1114                 if (seq_has_overflowed(s))
1115                         break;
1116         }
1117 }
1118 EXPORT_SYMBOL_GPL(debugfs_print_regs32);
1119
1120 static int debugfs_show_regset32(struct seq_file *s, void *data)
1121 {
1122         struct debugfs_regset32 *regset = s->private;
1123
1124         if (regset->dev)
1125                 pm_runtime_get_sync(regset->dev);
1126
1127         debugfs_print_regs32(s, regset->regs, regset->nregs, regset->base, "");
1128
1129         if (regset->dev)
1130                 pm_runtime_put(regset->dev);
1131
1132         return 0;
1133 }
1134
1135 static int debugfs_open_regset32(struct inode *inode, struct file *file)
1136 {
1137         return single_open(file, debugfs_show_regset32, inode->i_private);
1138 }
1139
1140 static const struct file_operations fops_regset32 = {
1141         .open =         debugfs_open_regset32,
1142         .read =         seq_read,
1143         .llseek =       seq_lseek,
1144         .release =      single_release,
1145 };
1146
1147 /**
1148  * debugfs_create_regset32 - create a debugfs file that returns register values
1149  * @name: a pointer to a string containing the name of the file to create.
1150  * @mode: the permission that the file should have
1151  * @parent: a pointer to the parent dentry for this file.  This should be a
1152  *          directory dentry if set.  If this parameter is %NULL, then the
1153  *          file will be created in the root of the debugfs filesystem.
1154  * @regset: a pointer to a struct debugfs_regset32, which contains a pointer
1155  *          to an array of register definitions, the array size and the base
1156  *          address where the register bank is to be found.
1157  *
1158  * This function creates a file in debugfs with the given name that reports
1159  * the names and values of a set of 32-bit registers. If the @mode variable
1160  * is so set it can be read from. Writing is not supported.
1161  */
1162 void debugfs_create_regset32(const char *name, umode_t mode,
1163                              struct dentry *parent,
1164                              struct debugfs_regset32 *regset)
1165 {
1166         debugfs_create_file(name, mode, parent, regset, &fops_regset32);
1167 }
1168 EXPORT_SYMBOL_GPL(debugfs_create_regset32);
1169
1170 #endif /* CONFIG_HAS_IOMEM */
1171
1172 struct debugfs_devm_entry {
1173         int (*read)(struct seq_file *seq, void *data);
1174         struct device *dev;
1175 };
1176
1177 static int debugfs_devm_entry_open(struct inode *inode, struct file *f)
1178 {
1179         struct debugfs_devm_entry *entry = inode->i_private;
1180
1181         return single_open(f, entry->read, entry->dev);
1182 }
1183
1184 static const struct file_operations debugfs_devm_entry_ops = {
1185         .owner = THIS_MODULE,
1186         .open = debugfs_devm_entry_open,
1187         .release = single_release,
1188         .read = seq_read,
1189         .llseek = seq_lseek
1190 };
1191
1192 /**
1193  * debugfs_create_devm_seqfile - create a debugfs file that is bound to device.
1194  *
1195  * @dev: device related to this debugfs file.
1196  * @name: name of the debugfs file.
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  * @read_fn: function pointer called to print the seq_file content.
1201  */
1202 void debugfs_create_devm_seqfile(struct device *dev, const char *name,
1203                                  struct dentry *parent,
1204                                  int (*read_fn)(struct seq_file *s, void *data))
1205 {
1206         struct debugfs_devm_entry *entry;
1207
1208         if (IS_ERR(parent))
1209                 return;
1210
1211         entry = devm_kzalloc(dev, sizeof(*entry), GFP_KERNEL);
1212         if (!entry)
1213                 return;
1214
1215         entry->read = read_fn;
1216         entry->dev = dev;
1217
1218         debugfs_create_file(name, S_IRUGO, parent, entry,
1219                             &debugfs_devm_entry_ops);
1220 }
1221 EXPORT_SYMBOL_GPL(debugfs_create_devm_seqfile);