include/linux/debugfs.h

   1 /*
   2  *  debugfs.h - a tiny little debug file system
   3  *
   4  *  Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
   5  *  Copyright (C) 2004 IBM Inc.
   6  *
   7  *      This program is free software; you can redistribute it and/or
   8  *      modify it under the terms of the GNU General Public License version
   9  *      2 as published by the Free Software Foundation.
  10  *
  11  *  debugfs is for people to use instead of /proc or /sys.
  12  *  See Documentation/filesystems/ for more details.
  13  */
  14
  15 #ifndef _DEBUGFS_H_
  16 #define _DEBUGFS_H_
  17
  18 #include <linux/fs.h>
  19 #include <linux/seq_file.h>
  20
  21 #include <linux/types.h>
  22 #include <linux/compiler.h>
  23
  24 struct device;
  25 struct file_operations;
  26 struct srcu_struct;
  27
  28 struct debugfs_blob_wrapper {
  29         void *data;
  30         unsigned long size;
  31 };
  32
  33 struct debugfs_reg32 {
  34         char *name;
  35         unsigned long offset;
  36 };
  37
  38 struct debugfs_regset32 {
  39         const struct debugfs_reg32 *regs;
  40         int nregs;
  41         void __iomem *base;
  42 };
  43
  44 extern struct dentry *arch_debugfs_dir;
  45
  46 extern struct srcu_struct debugfs_srcu;
  47
  48 /**
  49  * debugfs_real_fops - getter for the real file operation
  50  * @filp: a pointer to a struct file
  51  *
  52  * Must only be called under the protection established by
  53  * debugfs_use_file_start().
  54  */
  55 static inline const struct file_operations *debugfs_real_fops(const struct file *filp)
  56         __must_hold(&debugfs_srcu)
  57 {
  58         /*
  59          * Neither the pointer to the struct file_operations, nor its
  60          * contents ever change -- srcu_dereference() is not needed here.
  61          */
  62         return filp->f_path.dentry->d_fsdata;
  63 }
  64
  65 #define DEFINE_DEBUGFS_ATTRIBUTE(__fops, __get, __set, __fmt)           \
  66 static int __fops ## _open(struct inode *inode, struct file *file)      \
  67 {                                                                       \
  68         __simple_attr_check_format(__fmt, 0ull);                        \
  69         return simple_attr_open(inode, file, __get, __set, __fmt);      \
  70 }                                                                       \
  71 static const struct file_operations __fops = {                          \
  72         .owner   = THIS_MODULE,                                         \
  73         .open    = __fops ## _open,                                     \
  74         .release = simple_attr_release,                                 \
  75         .read    = debugfs_attr_read,                                   \
  76         .write   = debugfs_attr_write,                                  \
  77         .llseek  = no_llseek,                                           \
  78 }
  79
  80 typedef struct vfsmount *(*debugfs_automount_t)(struct dentry *, void *);
  81
  82 #if defined(CONFIG_DEBUG_FS)
  83
  84 struct dentry *debugfs_lookup(const char *name, struct dentry *parent);
  85
  86 struct dentry *debugfs_create_file(const char *name, umode_t mode,
  87                                    struct dentry *parent, void *data,
  88                                    const struct file_operations *fops);
  89 struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
  90                                    struct dentry *parent, void *data,
  91                                    const struct file_operations *fops);
  92
  93 struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
  94                                         struct dentry *parent, void *data,
  95                                         const struct file_operations *fops,
  96                                         loff_t file_size);
  97
  98 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
  99
 100 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
 101                                       const char *dest);
 102
 103 struct dentry *debugfs_create_automount(const char *name,
 104                                         struct dentry *parent,
 105                                         debugfs_automount_t f,
 106                                         void *data);
 107
 108 void debugfs_remove(struct dentry *dentry);
 109 void debugfs_remove_recursive(struct dentry *dentry);
 110
 111 int debugfs_use_file_start(const struct dentry *dentry, int *srcu_idx)
 112         __acquires(&debugfs_srcu);
 113
 114 void debugfs_use_file_finish(int srcu_idx) __releases(&debugfs_srcu);
 115
 116 ssize_t debugfs_attr_read(struct file *file, char __user *buf,
 117                         size_t len, loff_t *ppos);
 118 ssize_t debugfs_attr_write(struct file *file, const char __user *buf,
 119                         size_t len, loff_t *ppos);
 120
 121 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
 122                 struct dentry *new_dir, const char *new_name);
 123
 124 struct dentry *debugfs_create_u8(const char *name, umode_t mode,
 125                                  struct dentry *parent, u8 *value);
 126 struct dentry *debugfs_create_u16(const char *name, umode_t mode,
 127                                   struct dentry *parent, u16 *value);
 128 struct dentry *debugfs_create_u32(const char *name, umode_t mode,
 129                                   struct dentry *parent, u32 *value);
 130 struct dentry *debugfs_create_u64(const char *name, umode_t mode,
 131                                   struct dentry *parent, u64 *value);
 132 struct dentry *debugfs_create_ulong(const char *name, umode_t mode,
 133                                     struct dentry *parent, unsigned long *value);
 134 struct dentry *debugfs_create_x8(const char *name, umode_t mode,
 135                                  struct dentry *parent, u8 *value);
 136 struct dentry *debugfs_create_x16(const char *name, umode_t mode,
 137                                   struct dentry *parent, u16 *value);
 138 struct dentry *debugfs_create_x32(const char *name, umode_t mode,
 139                                   struct dentry *parent, u32 *value);
 140 struct dentry *debugfs_create_x64(const char *name, umode_t mode,
 141                                   struct dentry *parent, u64 *value);
 142 struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
 143                                      struct dentry *parent, size_t *value);
 144 struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
 145                                      struct dentry *parent, atomic_t *value);
 146 struct dentry *debugfs_create_bool(const char *name, umode_t mode,
 147                                   struct dentry *parent, bool *value);
 148
 149 struct dentry *debugfs_create_blob(const char *name, umode_t mode,
 150                                   struct dentry *parent,
 151                                   struct debugfs_blob_wrapper *blob);
 152
 153 struct dentry *debugfs_create_regset32(const char *name, umode_t mode,
 154                                      struct dentry *parent,
 155                                      struct debugfs_regset32 *regset);
 156
 157 void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
 158                           int nregs, void __iomem *base, char *prefix);
 159
 160 struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
 161                                         struct dentry *parent,
 162                                         u32 *array, u32 elements);
 163
 164 struct dentry *debugfs_create_devm_seqfile(struct device *dev, const char *name,
 165                                            struct dentry *parent,
 166                                            int (*read_fn)(struct seq_file *s,
 167                                                           void *data));
 168
 169 bool debugfs_initialized(void);
 170
 171 ssize_t debugfs_read_file_bool(struct file *file, char __user *user_buf,
 172                                size_t count, loff_t *ppos);
 173
 174 ssize_t debugfs_write_file_bool(struct file *file, const char __user *user_buf,
 175                                 size_t count, loff_t *ppos);
 176
 177 #else
 178
 179 #include <linux/err.h>
 180
 181 /*
 182  * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
 183  * so users have a chance to detect if there was a real error or not.  We don't
 184  * want to duplicate the design decision mistakes of procfs and devfs again.
 185  */
 186
 187 static inline struct dentry *debugfs_lookup(const char *name,
 188                                             struct dentry *parent)
 189 {
 190         return ERR_PTR(-ENODEV);
 191 }
 192
 193 static inline struct dentry *debugfs_create_file(const char *name, umode_t mode,
 194                                         struct dentry *parent, void *data,
 195                                         const struct file_operations *fops)
 196 {
 197         return ERR_PTR(-ENODEV);
 198 }
 199
 200 static inline struct dentry *debugfs_create_file_unsafe(const char *name,
 201                                         umode_t mode, struct dentry *parent,
 202                                         void *data,
 203                                         const struct file_operations *fops)
 204 {
 205         return ERR_PTR(-ENODEV);
 206 }
 207
 208 static inline struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
 209                                         struct dentry *parent, void *data,
 210                                         const struct file_operations *fops,
 211                                         loff_t file_size)
 212 {
 213         return ERR_PTR(-ENODEV);
 214 }
 215
 216 static inline struct dentry *debugfs_create_dir(const char *name,
 217                                                 struct dentry *parent)
 218 {
 219         return ERR_PTR(-ENODEV);
 220 }
 221
 222 static inline struct dentry *debugfs_create_symlink(const char *name,
 223                                                     struct dentry *parent,
 224                                                     const char *dest)
 225 {
 226         return ERR_PTR(-ENODEV);
 227 }
 228
 229 static inline struct dentry *debugfs_create_automount(const char *name,
 230                                         struct dentry *parent,
 231                                         debugfs_automount_t f,
 232                                         void *data)
 233 {
 234         return ERR_PTR(-ENODEV);
 235 }
 236
 237 static inline void debugfs_remove(struct dentry *dentry)
 238 { }
 239
 240 static inline void debugfs_remove_recursive(struct dentry *dentry)
 241 { }
 242
 243 static inline int debugfs_use_file_start(const struct dentry *dentry,
 244                                         int *srcu_idx)
 245         __acquires(&debugfs_srcu)
 246 {
 247         return 0;
 248 }
 249
 250 static inline void debugfs_use_file_finish(int srcu_idx)
 251         __releases(&debugfs_srcu)
 252 { }
 253
 254 static inline ssize_t debugfs_attr_read(struct file *file, char __user *buf,
 255                                         size_t len, loff_t *ppos)
 256 {
 257         return -ENODEV;
 258 }
 259
 260 static inline ssize_t debugfs_attr_write(struct file *file,
 261                                         const char __user *buf,
 262                                         size_t len, loff_t *ppos)
 263 {
 264         return -ENODEV;
 265 }
 266
 267 static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
 268                 struct dentry *new_dir, char *new_name)
 269 {
 270         return ERR_PTR(-ENODEV);
 271 }
 272
 273 static inline struct dentry *debugfs_create_u8(const char *name, umode_t mode,
 274                                                struct dentry *parent,
 275                                                u8 *value)
 276 {
 277         return ERR_PTR(-ENODEV);
 278 }
 279
 280 static inline struct dentry *debugfs_create_u16(const char *name, umode_t mode,
 281                                                 struct dentry *parent,
 282                                                 u16 *value)
 283 {
 284         return ERR_PTR(-ENODEV);
 285 }
 286
 287 static inline struct dentry *debugfs_create_u32(const char *name, umode_t mode,
 288                                                 struct dentry *parent,
 289                                                 u32 *value)
 290 {
 291         return ERR_PTR(-ENODEV);
 292 }
 293
 294 static inline struct dentry *debugfs_create_u64(const char *name, umode_t mode,
 295                                                 struct dentry *parent,
 296                                                 u64 *value)
 297 {
 298         return ERR_PTR(-ENODEV);
 299 }
 300
 301 static inline struct dentry *debugfs_create_ulong(const char *name,
 302                                                 umode_t mode,
 303                                                 struct dentry *parent,
 304                                                 unsigned long *value)
 305 {
 306         return ERR_PTR(-ENODEV);
 307 }
 308
 309 static inline struct dentry *debugfs_create_x8(const char *name, umode_t mode,
 310                                                struct dentry *parent,
 311                                                u8 *value)
 312 {
 313         return ERR_PTR(-ENODEV);
 314 }
 315
 316 static inline struct dentry *debugfs_create_x16(const char *name, umode_t mode,
 317                                                 struct dentry *parent,
 318                                                 u16 *value)
 319 {
 320         return ERR_PTR(-ENODEV);
 321 }
 322
 323 static inline struct dentry *debugfs_create_x32(const char *name, umode_t mode,
 324                                                 struct dentry *parent,
 325                                                 u32 *value)
 326 {
 327         return ERR_PTR(-ENODEV);
 328 }
 329
 330 static inline struct dentry *debugfs_create_x64(const char *name, umode_t mode,
 331                                                 struct dentry *parent,
 332                                                 u64 *value)
 333 {
 334         return ERR_PTR(-ENODEV);
 335 }
 336
 337 static inline struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
 338                                      struct dentry *parent,
 339                                      size_t *value)
 340 {
 341         return ERR_PTR(-ENODEV);
 342 }
 343
 344 static inline struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
 345                                      struct dentry *parent, atomic_t *value)
 346 {
 347         return ERR_PTR(-ENODEV);
 348 }
 349
 350 static inline struct dentry *debugfs_create_bool(const char *name, umode_t mode,
 351                                                  struct dentry *parent,
 352                                                  bool *value)
 353 {
 354         return ERR_PTR(-ENODEV);
 355 }
 356
 357 static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode,
 358                                   struct dentry *parent,
 359                                   struct debugfs_blob_wrapper *blob)
 360 {
 361         return ERR_PTR(-ENODEV);
 362 }
 363
 364 static inline struct dentry *debugfs_create_regset32(const char *name,
 365                                    umode_t mode, struct dentry *parent,
 366                                    struct debugfs_regset32 *regset)
 367 {
 368         return ERR_PTR(-ENODEV);
 369 }
 370
 371 static inline void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
 372                          int nregs, void __iomem *base, char *prefix)
 373 {
 374 }
 375
 376 static inline bool debugfs_initialized(void)
 377 {
 378         return false;
 379 }
 380
 381 static inline struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
 382                                         struct dentry *parent,
 383                                         u32 *array, u32 elements)
 384 {
 385         return ERR_PTR(-ENODEV);
 386 }
 387
 388 static inline struct dentry *debugfs_create_devm_seqfile(struct device *dev,
 389                                                          const char *name,
 390                                                          struct dentry *parent,
 391                                            int (*read_fn)(struct seq_file *s,
 392                                                           void *data))
 393 {
 394         return ERR_PTR(-ENODEV);
 395 }
 396
 397 static inline ssize_t debugfs_read_file_bool(struct file *file,
 398                                              char __user *user_buf,
 399                                              size_t count, loff_t *ppos)
 400 {
 401         return -ENODEV;
 402 }
 403
 404 static inline ssize_t debugfs_write_file_bool(struct file *file,
 405                                               const char __user *user_buf,
 406                                               size_t count, loff_t *ppos)
 407 {
 408         return -ENODEV;
 409 }
 410
 411 #endif
 412
 413 #endif