include/linux/debugfs.h

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  *  debugfs.h - 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 #ifndef _DEBUGFS_H_
  13 #define _DEBUGFS_H_
  14
  15 #include <linux/fs.h>
  16 #include <linux/seq_file.h>
  17
  18 #include <linux/types.h>
  19 #include <linux/compiler.h>
  20
  21 struct device;
  22 struct file_operations;
  23
  24 struct debugfs_blob_wrapper {
  25         void *data;
  26         unsigned long size;
  27 };
  28
  29 struct debugfs_reg32 {
  30         char *name;
  31         unsigned long offset;
  32 };
  33
  34 struct debugfs_regset32 {
  35         const struct debugfs_reg32 *regs;
  36         int nregs;
  37         void __iomem *base;
  38         struct device *dev;     /* Optional device for Runtime PM */
  39 };
  40
  41 extern struct dentry *arch_debugfs_dir;
  42
  43 #define DEFINE_DEBUGFS_ATTRIBUTE(__fops, __get, __set, __fmt)           \
  44 static int __fops ## _open(struct inode *inode, struct file *file)      \
  45 {                                                                       \
  46         __simple_attr_check_format(__fmt, 0ull);                        \
  47         return simple_attr_open(inode, file, __get, __set, __fmt);      \
  48 }                                                                       \
  49 static const struct file_operations __fops = {                          \
  50         .owner   = THIS_MODULE,                                         \
  51         .open    = __fops ## _open,                                     \
  52         .release = simple_attr_release,                                 \
  53         .read    = debugfs_attr_read,                                   \
  54         .write   = debugfs_attr_write,                                  \
  55         .llseek  = no_llseek,                                           \
  56 }
  57
  58 typedef struct vfsmount *(*debugfs_automount_t)(struct dentry *, void *);
  59
  60 #if defined(CONFIG_DEBUG_FS)
  61
  62 struct dentry *debugfs_lookup(const char *name, struct dentry *parent);
  63
  64 struct dentry *debugfs_create_file(const char *name, umode_t mode,
  65                                    struct dentry *parent, void *data,
  66                                    const struct file_operations *fops);
  67 struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
  68                                    struct dentry *parent, void *data,
  69                                    const struct file_operations *fops);
  70
  71 void debugfs_create_file_size(const char *name, umode_t mode,
  72                               struct dentry *parent, void *data,
  73                               const struct file_operations *fops,
  74                               loff_t file_size);
  75
  76 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
  77
  78 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
  79                                       const char *dest);
  80
  81 struct dentry *debugfs_create_automount(const char *name,
  82                                         struct dentry *parent,
  83                                         debugfs_automount_t f,
  84                                         void *data);
  85
  86 void debugfs_remove(struct dentry *dentry);
  87 #define debugfs_remove_recursive debugfs_remove
  88
  89 const struct file_operations *debugfs_real_fops(const struct file *filp);
  90
  91 int debugfs_file_get(struct dentry *dentry);
  92 void debugfs_file_put(struct dentry *dentry);
  93
  94 ssize_t debugfs_attr_read(struct file *file, char __user *buf,
  95                         size_t len, loff_t *ppos);
  96 ssize_t debugfs_attr_write(struct file *file, const char __user *buf,
  97                         size_t len, loff_t *ppos);
  98
  99 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
 100                 struct dentry *new_dir, const char *new_name);
 101
 102 void debugfs_create_u8(const char *name, umode_t mode, struct dentry *parent,
 103                        u8 *value);
 104 void debugfs_create_u16(const char *name, umode_t mode, struct dentry *parent,
 105                         u16 *value);
 106 void debugfs_create_u32(const char *name, umode_t mode, struct dentry *parent,
 107                         u32 *value);
 108 void debugfs_create_u64(const char *name, umode_t mode, struct dentry *parent,
 109                         u64 *value);
 110 struct dentry *debugfs_create_ulong(const char *name, umode_t mode,
 111                                     struct dentry *parent, unsigned long *value);
 112 void debugfs_create_x8(const char *name, umode_t mode, struct dentry *parent,
 113                        u8 *value);
 114 void debugfs_create_x16(const char *name, umode_t mode, struct dentry *parent,
 115                         u16 *value);
 116 void debugfs_create_x32(const char *name, umode_t mode, struct dentry *parent,
 117                         u32 *value);
 118 void debugfs_create_x64(const char *name, umode_t mode, struct dentry *parent,
 119                         u64 *value);
 120 void debugfs_create_size_t(const char *name, umode_t mode,
 121                            struct dentry *parent, size_t *value);
 122 void debugfs_create_atomic_t(const char *name, umode_t mode,
 123                              struct dentry *parent, atomic_t *value);
 124 struct dentry *debugfs_create_bool(const char *name, umode_t mode,
 125                                   struct dentry *parent, bool *value);
 126
 127 struct dentry *debugfs_create_blob(const char *name, umode_t mode,
 128                                   struct dentry *parent,
 129                                   struct debugfs_blob_wrapper *blob);
 130
 131 void debugfs_create_regset32(const char *name, umode_t mode,
 132                              struct dentry *parent,
 133                              struct debugfs_regset32 *regset);
 134
 135 void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
 136                           int nregs, void __iomem *base, char *prefix);
 137
 138 void debugfs_create_u32_array(const char *name, umode_t mode,
 139                               struct dentry *parent, u32 *array, u32 elements);
 140
 141 struct dentry *debugfs_create_devm_seqfile(struct device *dev, const char *name,
 142                                            struct dentry *parent,
 143                                            int (*read_fn)(struct seq_file *s,
 144                                                           void *data));
 145
 146 bool debugfs_initialized(void);
 147
 148 ssize_t debugfs_read_file_bool(struct file *file, char __user *user_buf,
 149                                size_t count, loff_t *ppos);
 150
 151 ssize_t debugfs_write_file_bool(struct file *file, const char __user *user_buf,
 152                                 size_t count, loff_t *ppos);
 153
 154 #else
 155
 156 #include <linux/err.h>
 157
 158 /*
 159  * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
 160  * so users have a chance to detect if there was a real error or not.  We don't
 161  * want to duplicate the design decision mistakes of procfs and devfs again.
 162  */
 163
 164 static inline struct dentry *debugfs_lookup(const char *name,
 165                                             struct dentry *parent)
 166 {
 167         return ERR_PTR(-ENODEV);
 168 }
 169
 170 static inline struct dentry *debugfs_create_file(const char *name, umode_t mode,
 171                                         struct dentry *parent, void *data,
 172                                         const struct file_operations *fops)
 173 {
 174         return ERR_PTR(-ENODEV);
 175 }
 176
 177 static inline struct dentry *debugfs_create_file_unsafe(const char *name,
 178                                         umode_t mode, struct dentry *parent,
 179                                         void *data,
 180                                         const struct file_operations *fops)
 181 {
 182         return ERR_PTR(-ENODEV);
 183 }
 184
 185 static inline void debugfs_create_file_size(const char *name, umode_t mode,
 186                                             struct dentry *parent, void *data,
 187                                             const struct file_operations *fops,
 188                                             loff_t file_size)
 189 { }
 190
 191 static inline struct dentry *debugfs_create_dir(const char *name,
 192                                                 struct dentry *parent)
 193 {
 194         return ERR_PTR(-ENODEV);
 195 }
 196
 197 static inline struct dentry *debugfs_create_symlink(const char *name,
 198                                                     struct dentry *parent,
 199                                                     const char *dest)
 200 {
 201         return ERR_PTR(-ENODEV);
 202 }
 203
 204 static inline struct dentry *debugfs_create_automount(const char *name,
 205                                         struct dentry *parent,
 206                                         debugfs_automount_t f,
 207                                         void *data)
 208 {
 209         return ERR_PTR(-ENODEV);
 210 }
 211
 212 static inline void debugfs_remove(struct dentry *dentry)
 213 { }
 214
 215 static inline void debugfs_remove_recursive(struct dentry *dentry)
 216 { }
 217
 218 const struct file_operations *debugfs_real_fops(const struct file *filp);
 219
 220 static inline int debugfs_file_get(struct dentry *dentry)
 221 {
 222         return 0;
 223 }
 224
 225 static inline void debugfs_file_put(struct dentry *dentry)
 226 { }
 227
 228 static inline ssize_t debugfs_attr_read(struct file *file, char __user *buf,
 229                                         size_t len, loff_t *ppos)
 230 {
 231         return -ENODEV;
 232 }
 233
 234 static inline ssize_t debugfs_attr_write(struct file *file,
 235                                         const char __user *buf,
 236                                         size_t len, loff_t *ppos)
 237 {
 238         return -ENODEV;
 239 }
 240
 241 static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
 242                 struct dentry *new_dir, char *new_name)
 243 {
 244         return ERR_PTR(-ENODEV);
 245 }
 246
 247 static inline void debugfs_create_u8(const char *name, umode_t mode,
 248                                      struct dentry *parent, u8 *value) { }
 249
 250 static inline void debugfs_create_u16(const char *name, umode_t mode,
 251                                       struct dentry *parent, u16 *value) { }
 252
 253 static inline void debugfs_create_u32(const char *name, umode_t mode,
 254                                       struct dentry *parent, u32 *value) { }
 255
 256 static inline void debugfs_create_u64(const char *name, umode_t mode,
 257                                       struct dentry *parent, u64 *value) { }
 258
 259 static inline struct dentry *debugfs_create_ulong(const char *name,
 260                                                 umode_t mode,
 261                                                 struct dentry *parent,
 262                                                 unsigned long *value)
 263 {
 264         return ERR_PTR(-ENODEV);
 265 }
 266
 267 static inline void debugfs_create_x8(const char *name, umode_t mode,
 268                                      struct dentry *parent, u8 *value) { }
 269
 270 static inline void debugfs_create_x16(const char *name, umode_t mode,
 271                                       struct dentry *parent, u16 *value) { }
 272
 273 static inline void debugfs_create_x32(const char *name, umode_t mode,
 274                                       struct dentry *parent, u32 *value) { }
 275
 276 static inline void debugfs_create_x64(const char *name, umode_t mode,
 277                                       struct dentry *parent, u64 *value) { }
 278
 279 static inline void debugfs_create_size_t(const char *name, umode_t mode,
 280                                          struct dentry *parent, size_t *value)
 281 { }
 282
 283 static inline void debugfs_create_atomic_t(const char *name, umode_t mode,
 284                                            struct dentry *parent,
 285                                            atomic_t *value)
 286 { }
 287
 288 static inline struct dentry *debugfs_create_bool(const char *name, umode_t mode,
 289                                                  struct dentry *parent,
 290                                                  bool *value)
 291 {
 292         return ERR_PTR(-ENODEV);
 293 }
 294
 295 static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode,
 296                                   struct dentry *parent,
 297                                   struct debugfs_blob_wrapper *blob)
 298 {
 299         return ERR_PTR(-ENODEV);
 300 }
 301
 302 static inline void debugfs_create_regset32(const char *name, umode_t mode,
 303                                            struct dentry *parent,
 304                                            struct debugfs_regset32 *regset)
 305 {
 306 }
 307
 308 static inline void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
 309                          int nregs, void __iomem *base, char *prefix)
 310 {
 311 }
 312
 313 static inline bool debugfs_initialized(void)
 314 {
 315         return false;
 316 }
 317
 318 static inline void debugfs_create_u32_array(const char *name, umode_t mode,
 319                                             struct dentry *parent, u32 *array,
 320                                             u32 elements)
 321 {
 322 }
 323
 324 static inline struct dentry *debugfs_create_devm_seqfile(struct device *dev,
 325                                                          const char *name,
 326                                                          struct dentry *parent,
 327                                            int (*read_fn)(struct seq_file *s,
 328                                                           void *data))
 329 {
 330         return ERR_PTR(-ENODEV);
 331 }
 332
 333 static inline ssize_t debugfs_read_file_bool(struct file *file,
 334                                              char __user *user_buf,
 335                                              size_t count, loff_t *ppos)
 336 {
 337         return -ENODEV;
 338 }
 339
 340 static inline ssize_t debugfs_write_file_bool(struct file *file,
 341                                               const char __user *user_buf,
 342                                               size_t count, loff_t *ppos)
 343 {
 344         return -ENODEV;
 345 }
 346
 347 #endif
 348
 349 /**
 350  * debugfs_create_xul - create a debugfs file that is used to read and write an
 351  * unsigned long value, formatted in hexadecimal
 352  * @name: a pointer to a string containing the name of the file to create.
 353  * @mode: the permission that the file should have
 354  * @parent: a pointer to the parent dentry for this file.  This should be a
 355  *          directory dentry if set.  If this parameter is %NULL, then the
 356  *          file will be created in the root of the debugfs filesystem.
 357  * @value: a pointer to the variable that the file should read to and write
 358  *         from.
 359  */
 360 static inline void debugfs_create_xul(const char *name, umode_t mode,
 361                                       struct dentry *parent,
 362                                       unsigned long *value)
 363 {
 364         if (sizeof(*value) == sizeof(u32))
 365                 debugfs_create_x32(name, mode, parent, (u32 *)value);
 366         else
 367                 debugfs_create_x64(name, mode, parent, (u64 *)value);
 368 }
 369
 370 #endif