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