include/linux/kernfs.h

   1 /*
   2  * kernfs.h - pseudo filesystem decoupled from vfs locking
   3  *
   4  * This file is released under the GPLv2.
   5  */
   6
   7 #ifndef __LINUX_KERNFS_H
   8 #define __LINUX_KERNFS_H
   9
  10 #include <linux/kernel.h>
  11 #include <linux/err.h>
  12 #include <linux/list.h>
  13 #include <linux/mutex.h>
  14 #include <linux/idr.h>
  15 #include <linux/lockdep.h>
  16 #include <linux/rbtree.h>
  17 #include <linux/atomic.h>
  18 #include <linux/wait.h>
  19
  20 struct file;
  21 struct dentry;
  22 struct iattr;
  23 struct seq_file;
  24 struct vm_area_struct;
  25 struct super_block;
  26 struct file_system_type;
  27
  28 struct kernfs_open_node;
  29 struct kernfs_iattrs;
  30
  31 enum kernfs_node_type {
  32         KERNFS_DIR              = 0x0001,
  33         KERNFS_FILE             = 0x0002,
  34         KERNFS_LINK             = 0x0004,
  35 };
  36
  37 #define KERNFS_TYPE_MASK        0x000f
  38 #define KERNFS_FLAG_MASK        ~KERNFS_TYPE_MASK
  39
  40 enum kernfs_node_flag {
  41         KERNFS_ACTIVATED        = 0x0010,
  42         KERNFS_NS               = 0x0020,
  43         KERNFS_HAS_SEQ_SHOW     = 0x0040,
  44         KERNFS_HAS_MMAP         = 0x0080,
  45         KERNFS_LOCKDEP          = 0x0100,
  46         KERNFS_SUICIDAL         = 0x0400,
  47         KERNFS_SUICIDED         = 0x0800,
  48         KERNFS_EMPTY_DIR        = 0x1000,
  49         KERNFS_HAS_RELEASE      = 0x2000,
  50 };
  51
  52 /* @flags for kernfs_create_root() */
  53 enum kernfs_root_flag {
  54         /*
  55          * kernfs_nodes are created in the deactivated state and invisible.
  56          * They require explicit kernfs_activate() to become visible.  This
  57          * can be used to make related nodes become visible atomically
  58          * after all nodes are created successfully.
  59          */
  60         KERNFS_ROOT_CREATE_DEACTIVATED          = 0x0001,
  61
  62         /*
  63          * For regular flies, if the opener has CAP_DAC_OVERRIDE, open(2)
  64          * succeeds regardless of the RW permissions.  sysfs had an extra
  65          * layer of enforcement where open(2) fails with -EACCES regardless
  66          * of CAP_DAC_OVERRIDE if the permission doesn't have the
  67          * respective read or write access at all (none of S_IRUGO or
  68          * S_IWUGO) or the respective operation isn't implemented.  The
  69          * following flag enables that behavior.
  70          */
  71         KERNFS_ROOT_EXTRA_OPEN_PERM_CHECK       = 0x0002,
  72
  73         /*
  74          * The filesystem supports exportfs operation, so userspace can use
  75          * fhandle to access nodes of the fs.
  76          */
  77         KERNFS_ROOT_SUPPORT_EXPORTOP            = 0x0004,
  78 };
  79
  80 /* type-specific structures for kernfs_node union members */
  81 struct kernfs_elem_dir {
  82         unsigned long           subdirs;
  83         /* children rbtree starts here and goes through kn->rb */
  84         struct rb_root          children;
  85
  86         /*
  87          * The kernfs hierarchy this directory belongs to.  This fits
  88          * better directly in kernfs_node but is here to save space.
  89          */
  90         struct kernfs_root      *root;
  91 };
  92
  93 struct kernfs_elem_symlink {
  94         struct kernfs_node      *target_kn;
  95 };
  96
  97 struct kernfs_elem_attr {
  98         const struct kernfs_ops *ops;
  99         struct kernfs_open_node *open;
 100         loff_t                  size;
 101         struct kernfs_node      *notify_next;   /* for kernfs_notify() */
 102 };
 103
 104 /* represent a kernfs node */
 105 union kernfs_node_id {
 106         struct {
 107                 /*
 108                  * blktrace will export this struct as a simplified 'struct
 109                  * fid' (which is a big data struction), so userspace can use
 110                  * it to find kernfs node. The layout must match the first two
 111                  * fields of 'struct fid' exactly.
 112                  */
 113                 u32             ino;
 114                 u32             generation;
 115         };
 116         u64                     id;
 117 };
 118
 119 /*
 120  * kernfs_node - the building block of kernfs hierarchy.  Each and every
 121  * kernfs node is represented by single kernfs_node.  Most fields are
 122  * private to kernfs and shouldn't be accessed directly by kernfs users.
 123  *
 124  * As long as s_count reference is held, the kernfs_node itself is
 125  * accessible.  Dereferencing elem or any other outer entity requires
 126  * active reference.
 127  */
 128 struct kernfs_node {
 129         atomic_t                count;
 130         atomic_t                active;
 131 #ifdef CONFIG_DEBUG_LOCK_ALLOC
 132         struct lockdep_map      dep_map;
 133 #endif
 134         /*
 135          * Use kernfs_get_parent() and kernfs_name/path() instead of
 136          * accessing the following two fields directly.  If the node is
 137          * never moved to a different parent, it is safe to access the
 138          * parent directly.
 139          */
 140         struct kernfs_node      *parent;
 141         const char              *name;
 142
 143         struct rb_node          rb;
 144
 145         const void              *ns;    /* namespace tag */
 146         unsigned int            hash;   /* ns + name hash */
 147         union {
 148                 struct kernfs_elem_dir          dir;
 149                 struct kernfs_elem_symlink      symlink;
 150                 struct kernfs_elem_attr         attr;
 151         };
 152
 153         void                    *priv;
 154
 155         union kernfs_node_id    id;
 156         unsigned short          flags;
 157         umode_t                 mode;
 158         struct kernfs_iattrs    *iattr;
 159 };
 160
 161 /*
 162  * kernfs_syscall_ops may be specified on kernfs_create_root() to support
 163  * syscalls.  These optional callbacks are invoked on the matching syscalls
 164  * and can perform any kernfs operations which don't necessarily have to be
 165  * the exact operation requested.  An active reference is held for each
 166  * kernfs_node parameter.
 167  */
 168 struct kernfs_syscall_ops {
 169         int (*remount_fs)(struct kernfs_root *root, int *flags, char *data);
 170         int (*show_options)(struct seq_file *sf, struct kernfs_root *root);
 171
 172         int (*mkdir)(struct kernfs_node *parent, const char *name,
 173                      umode_t mode);
 174         int (*rmdir)(struct kernfs_node *kn);
 175         int (*rename)(struct kernfs_node *kn, struct kernfs_node *new_parent,
 176                       const char *new_name);
 177         int (*show_path)(struct seq_file *sf, struct kernfs_node *kn,
 178                          struct kernfs_root *root);
 179 };
 180
 181 struct kernfs_root {
 182         /* published fields */
 183         struct kernfs_node      *kn;
 184         unsigned int            flags;  /* KERNFS_ROOT_* flags */
 185
 186         /* private fields, do not use outside kernfs proper */
 187         struct idr              ino_idr;
 188         u32                     last_ino;
 189         u32                     next_generation;
 190         struct kernfs_syscall_ops *syscall_ops;
 191
 192         /* list of kernfs_super_info of this root, protected by kernfs_mutex */
 193         struct list_head        supers;
 194
 195         wait_queue_head_t       deactivate_waitq;
 196 };
 197
 198 struct kernfs_open_file {
 199         /* published fields */
 200         struct kernfs_node      *kn;
 201         struct file             *file;
 202         struct seq_file         *seq_file;
 203         void                    *priv;
 204
 205         /* private fields, do not use outside kernfs proper */
 206         struct mutex            mutex;
 207         struct mutex            prealloc_mutex;
 208         int                     event;
 209         struct list_head        list;
 210         char                    *prealloc_buf;
 211
 212         size_t                  atomic_write_len;
 213         bool                    mmapped:1;
 214         bool                    released:1;
 215         const struct vm_operations_struct *vm_ops;
 216 };
 217
 218 struct kernfs_ops {
 219         /*
 220          * Optional open/release methods.  Both are called with
 221          * @of->seq_file populated.
 222          */
 223         int (*open)(struct kernfs_open_file *of);
 224         void (*release)(struct kernfs_open_file *of);
 225
 226         /*
 227          * Read is handled by either seq_file or raw_read().
 228          *
 229          * If seq_show() is present, seq_file path is active.  Other seq
 230          * operations are optional and if not implemented, the behavior is
 231          * equivalent to single_open().  @sf->private points to the
 232          * associated kernfs_open_file.
 233          *
 234          * read() is bounced through kernel buffer and a read larger than
 235          * PAGE_SIZE results in partial operation of PAGE_SIZE.
 236          */
 237         int (*seq_show)(struct seq_file *sf, void *v);
 238
 239         void *(*seq_start)(struct seq_file *sf, loff_t *ppos);
 240         void *(*seq_next)(struct seq_file *sf, void *v, loff_t *ppos);
 241         void (*seq_stop)(struct seq_file *sf, void *v);
 242
 243         ssize_t (*read)(struct kernfs_open_file *of, char *buf, size_t bytes,
 244                         loff_t off);
 245
 246         /*
 247          * write() is bounced through kernel buffer.  If atomic_write_len
 248          * is not set, a write larger than PAGE_SIZE results in partial
 249          * operations of PAGE_SIZE chunks.  If atomic_write_len is set,
 250          * writes upto the specified size are executed atomically but
 251          * larger ones are rejected with -E2BIG.
 252          */
 253         size_t atomic_write_len;
 254         /*
 255          * "prealloc" causes a buffer to be allocated at open for
 256          * all read/write requests.  As ->seq_show uses seq_read()
 257          * which does its own allocation, it is incompatible with
 258          * ->prealloc.  Provide ->read and ->write with ->prealloc.
 259          */
 260         bool prealloc;
 261         ssize_t (*write)(struct kernfs_open_file *of, char *buf, size_t bytes,
 262                          loff_t off);
 263
 264         int (*mmap)(struct kernfs_open_file *of, struct vm_area_struct *vma);
 265
 266 #ifdef CONFIG_DEBUG_LOCK_ALLOC
 267         struct lock_class_key   lockdep_key;
 268 #endif
 269 };
 270
 271 #ifdef CONFIG_KERNFS
 272
 273 static inline enum kernfs_node_type kernfs_type(struct kernfs_node *kn)
 274 {
 275         return kn->flags & KERNFS_TYPE_MASK;
 276 }
 277
 278 /**
 279  * kernfs_enable_ns - enable namespace under a directory
 280  * @kn: directory of interest, should be empty
 281  *
 282  * This is to be called right after @kn is created to enable namespace
 283  * under it.  All children of @kn must have non-NULL namespace tags and
 284  * only the ones which match the super_block's tag will be visible.
 285  */
 286 static inline void kernfs_enable_ns(struct kernfs_node *kn)
 287 {
 288         WARN_ON_ONCE(kernfs_type(kn) != KERNFS_DIR);
 289         WARN_ON_ONCE(!RB_EMPTY_ROOT(&kn->dir.children));
 290         kn->flags |= KERNFS_NS;
 291 }
 292
 293 /**
 294  * kernfs_ns_enabled - test whether namespace is enabled
 295  * @kn: the node to test
 296  *
 297  * Test whether namespace filtering is enabled for the children of @ns.
 298  */
 299 static inline bool kernfs_ns_enabled(struct kernfs_node *kn)
 300 {
 301         return kn->flags & KERNFS_NS;
 302 }
 303
 304 int kernfs_name(struct kernfs_node *kn, char *buf, size_t buflen);
 305 int kernfs_path_from_node(struct kernfs_node *root_kn, struct kernfs_node *kn,
 306                           char *buf, size_t buflen);
 307 void pr_cont_kernfs_name(struct kernfs_node *kn);
 308 void pr_cont_kernfs_path(struct kernfs_node *kn);
 309 struct kernfs_node *kernfs_get_parent(struct kernfs_node *kn);
 310 struct kernfs_node *kernfs_find_and_get_ns(struct kernfs_node *parent,
 311                                            const char *name, const void *ns);
 312 struct kernfs_node *kernfs_walk_and_get_ns(struct kernfs_node *parent,
 313                                            const char *path, const void *ns);
 314 void kernfs_get(struct kernfs_node *kn);
 315 void kernfs_put(struct kernfs_node *kn);
 316
 317 struct kernfs_node *kernfs_node_from_dentry(struct dentry *dentry);
 318 struct kernfs_root *kernfs_root_from_sb(struct super_block *sb);
 319 struct inode *kernfs_get_inode(struct super_block *sb, struct kernfs_node *kn);
 320
 321 struct dentry *kernfs_node_dentry(struct kernfs_node *kn,
 322                                   struct super_block *sb);
 323 struct kernfs_root *kernfs_create_root(struct kernfs_syscall_ops *scops,
 324                                        unsigned int flags, void *priv);
 325 void kernfs_destroy_root(struct kernfs_root *root);
 326
 327 struct kernfs_node *kernfs_create_dir_ns(struct kernfs_node *parent,
 328                                          const char *name, umode_t mode,
 329                                          void *priv, const void *ns);
 330 struct kernfs_node *kernfs_create_empty_dir(struct kernfs_node *parent,
 331                                             const char *name);
 332 struct kernfs_node *__kernfs_create_file(struct kernfs_node *parent,
 333                                          const char *name,
 334                                          umode_t mode, loff_t size,
 335                                          const struct kernfs_ops *ops,
 336                                          void *priv, const void *ns,
 337                                          struct lock_class_key *key);
 338 struct kernfs_node *kernfs_create_link(struct kernfs_node *parent,
 339                                        const char *name,
 340                                        struct kernfs_node *target);
 341 void kernfs_activate(struct kernfs_node *kn);
 342 void kernfs_remove(struct kernfs_node *kn);
 343 void kernfs_break_active_protection(struct kernfs_node *kn);
 344 void kernfs_unbreak_active_protection(struct kernfs_node *kn);
 345 bool kernfs_remove_self(struct kernfs_node *kn);
 346 int kernfs_remove_by_name_ns(struct kernfs_node *parent, const char *name,
 347                              const void *ns);
 348 int kernfs_rename_ns(struct kernfs_node *kn, struct kernfs_node *new_parent,
 349                      const char *new_name, const void *new_ns);
 350 int kernfs_setattr(struct kernfs_node *kn, const struct iattr *iattr);
 351 void kernfs_notify(struct kernfs_node *kn);
 352
 353 const void *kernfs_super_ns(struct super_block *sb);
 354 struct dentry *kernfs_mount_ns(struct file_system_type *fs_type, int flags,
 355                                struct kernfs_root *root, unsigned long magic,
 356                                bool *new_sb_created, const void *ns);
 357 void kernfs_kill_sb(struct super_block *sb);
 358 struct super_block *kernfs_pin_sb(struct kernfs_root *root, const void *ns);
 359
 360 void kernfs_init(void);
 361
 362 struct kernfs_node *kernfs_get_node_by_id(struct kernfs_root *root,
 363         const union kernfs_node_id *id);
 364 #else   /* CONFIG_KERNFS */
 365
 366 static inline enum kernfs_node_type kernfs_type(struct kernfs_node *kn)
 367 { return 0; }   /* whatever */
 368
 369 static inline void kernfs_enable_ns(struct kernfs_node *kn) { }
 370
 371 static inline bool kernfs_ns_enabled(struct kernfs_node *kn)
 372 { return false; }
 373
 374 static inline int kernfs_name(struct kernfs_node *kn, char *buf, size_t buflen)
 375 { return -ENOSYS; }
 376
 377 static inline int kernfs_path_from_node(struct kernfs_node *root_kn,
 378                                         struct kernfs_node *kn,
 379                                         char *buf, size_t buflen)
 380 { return -ENOSYS; }
 381
 382 static inline void pr_cont_kernfs_name(struct kernfs_node *kn) { }
 383 static inline void pr_cont_kernfs_path(struct kernfs_node *kn) { }
 384
 385 static inline struct kernfs_node *kernfs_get_parent(struct kernfs_node *kn)
 386 { return NULL; }
 387
 388 static inline struct kernfs_node *
 389 kernfs_find_and_get_ns(struct kernfs_node *parent, const char *name,
 390                        const void *ns)
 391 { return NULL; }
 392 static inline struct kernfs_node *
 393 kernfs_walk_and_get_ns(struct kernfs_node *parent, const char *path,
 394                        const void *ns)
 395 { return NULL; }
 396
 397 static inline void kernfs_get(struct kernfs_node *kn) { }
 398 static inline void kernfs_put(struct kernfs_node *kn) { }
 399
 400 static inline struct kernfs_node *kernfs_node_from_dentry(struct dentry *dentry)
 401 { return NULL; }
 402
 403 static inline struct kernfs_root *kernfs_root_from_sb(struct super_block *sb)
 404 { return NULL; }
 405
 406 static inline struct inode *
 407 kernfs_get_inode(struct super_block *sb, struct kernfs_node *kn)
 408 { return NULL; }
 409
 410 static inline struct kernfs_root *
 411 kernfs_create_root(struct kernfs_syscall_ops *scops, unsigned int flags,
 412                    void *priv)
 413 { return ERR_PTR(-ENOSYS); }
 414
 415 static inline void kernfs_destroy_root(struct kernfs_root *root) { }
 416
 417 static inline struct kernfs_node *
 418 kernfs_create_dir_ns(struct kernfs_node *parent, const char *name,
 419                      umode_t mode, void *priv, const void *ns)
 420 { return ERR_PTR(-ENOSYS); }
 421
 422 static inline struct kernfs_node *
 423 __kernfs_create_file(struct kernfs_node *parent, const char *name,
 424                      umode_t mode, loff_t size, const struct kernfs_ops *ops,
 425                      void *priv, const void *ns, struct lock_class_key *key)
 426 { return ERR_PTR(-ENOSYS); }
 427
 428 static inline struct kernfs_node *
 429 kernfs_create_link(struct kernfs_node *parent, const char *name,
 430                    struct kernfs_node *target)
 431 { return ERR_PTR(-ENOSYS); }
 432
 433 static inline void kernfs_activate(struct kernfs_node *kn) { }
 434
 435 static inline void kernfs_remove(struct kernfs_node *kn) { }
 436
 437 static inline bool kernfs_remove_self(struct kernfs_node *kn)
 438 { return false; }
 439
 440 static inline int kernfs_remove_by_name_ns(struct kernfs_node *kn,
 441                                            const char *name, const void *ns)
 442 { return -ENOSYS; }
 443
 444 static inline int kernfs_rename_ns(struct kernfs_node *kn,
 445                                    struct kernfs_node *new_parent,
 446                                    const char *new_name, const void *new_ns)
 447 { return -ENOSYS; }
 448
 449 static inline int kernfs_setattr(struct kernfs_node *kn,
 450                                  const struct iattr *iattr)
 451 { return -ENOSYS; }
 452
 453 static inline void kernfs_notify(struct kernfs_node *kn) { }
 454
 455 static inline const void *kernfs_super_ns(struct super_block *sb)
 456 { return NULL; }
 457
 458 static inline struct dentry *
 459 kernfs_mount_ns(struct file_system_type *fs_type, int flags,
 460                 struct kernfs_root *root, unsigned long magic,
 461                 bool *new_sb_created, const void *ns)
 462 { return ERR_PTR(-ENOSYS); }
 463
 464 static inline void kernfs_kill_sb(struct super_block *sb) { }
 465
 466 static inline void kernfs_init(void) { }
 467
 468 #endif  /* CONFIG_KERNFS */
 469
 470 /**
 471  * kernfs_path - build full path of a given node
 472  * @kn: kernfs_node of interest
 473  * @buf: buffer to copy @kn's name into
 474  * @buflen: size of @buf
 475  *
 476  * Builds and returns the full path of @kn in @buf of @buflen bytes.  The
 477  * path is built from the end of @buf so the returned pointer usually
 478  * doesn't match @buf.  If @buf isn't long enough, @buf is nul terminated
 479  * and %NULL is returned.
 480  */
 481 static inline int kernfs_path(struct kernfs_node *kn, char *buf, size_t buflen)
 482 {
 483         return kernfs_path_from_node(kn, NULL, buf, buflen);
 484 }
 485
 486 static inline struct kernfs_node *
 487 kernfs_find_and_get(struct kernfs_node *kn, const char *name)
 488 {
 489         return kernfs_find_and_get_ns(kn, name, NULL);
 490 }
 491
 492 static inline struct kernfs_node *
 493 kernfs_walk_and_get(struct kernfs_node *kn, const char *path)
 494 {
 495         return kernfs_walk_and_get_ns(kn, path, NULL);
 496 }
 497
 498 static inline struct kernfs_node *
 499 kernfs_create_dir(struct kernfs_node *parent, const char *name, umode_t mode,
 500                   void *priv)
 501 {
 502         return kernfs_create_dir_ns(parent, name, mode, priv, NULL);
 503 }
 504
 505 static inline struct kernfs_node *
 506 kernfs_create_file_ns(struct kernfs_node *parent, const char *name,
 507                       umode_t mode, loff_t size, const struct kernfs_ops *ops,
 508                       void *priv, const void *ns)
 509 {
 510         struct lock_class_key *key = NULL;
 511
 512 #ifdef CONFIG_DEBUG_LOCK_ALLOC
 513         key = (struct lock_class_key *)&ops->lockdep_key;
 514 #endif
 515         return __kernfs_create_file(parent, name, mode, size, ops, priv, ns,
 516                                     key);
 517 }
 518
 519 static inline struct kernfs_node *
 520 kernfs_create_file(struct kernfs_node *parent, const char *name, umode_t mode,
 521                    loff_t size, const struct kernfs_ops *ops, void *priv)
 522 {
 523         return kernfs_create_file_ns(parent, name, mode, size, ops, priv, NULL);
 524 }
 525
 526 static inline int kernfs_remove_by_name(struct kernfs_node *parent,
 527                                         const char *name)
 528 {
 529         return kernfs_remove_by_name_ns(parent, name, NULL);
 530 }
 531
 532 static inline int kernfs_rename(struct kernfs_node *kn,
 533                                 struct kernfs_node *new_parent,
 534                                 const char *new_name)
 535 {
 536         return kernfs_rename_ns(kn, new_parent, new_name, NULL);
 537 }
 538
 539 static inline struct dentry *
 540 kernfs_mount(struct file_system_type *fs_type, int flags,
 541                 struct kernfs_root *root, unsigned long magic,
 542                 bool *new_sb_created)
 543 {
 544         return kernfs_mount_ns(fs_type, flags, root,
 545                                 magic, new_sb_created, NULL);
 546 }
 547
 548 #endif  /* __LINUX_KERNFS_H */