fs/sysfs/sysfs.h

   1 /*
   2  * fs/sysfs/sysfs.h - sysfs internal header file
   3  *
   4  * Copyright (c) 2001-3 Patrick Mochel
   5  * Copyright (c) 2007 SUSE Linux Products GmbH
   6  * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
   7  *
   8  * This file is released under the GPLv2.
   9  */
  10
  11 #include <linux/lockdep.h>
  12 #include <linux/kobject_ns.h>
  13 #include <linux/fs.h>
  14 #include <linux/rbtree.h>
  15
  16 struct sysfs_open_dirent;
  17
  18 /* type-specific structures for sysfs_dirent->s_* union members */
  19 struct sysfs_elem_dir {
  20         unsigned long           subdirs;
  21         /* children rbtree starts here and goes through sd->s_rb */
  22         struct rb_root          children;
  23 };
  24
  25 struct sysfs_elem_symlink {
  26         struct sysfs_dirent     *target_sd;
  27 };
  28
  29 struct sysfs_elem_attr {
  30         const struct kernfs_ops *ops;
  31         struct sysfs_open_dirent *open;
  32         loff_t                  size;
  33 };
  34
  35 struct sysfs_inode_attrs {
  36         struct iattr    ia_iattr;
  37         void            *ia_secdata;
  38         u32             ia_secdata_len;
  39 };
  40
  41 /*
  42  * sysfs_dirent - the building block of sysfs hierarchy.  Each and
  43  * every sysfs node is represented by single sysfs_dirent.
  44  *
  45  * As long as s_count reference is held, the sysfs_dirent itself is
  46  * accessible.  Dereferencing s_elem or any other outer entity
  47  * requires s_active reference.
  48  */
  49 struct sysfs_dirent {
  50         atomic_t                s_count;
  51         atomic_t                s_active;
  52 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  53         struct lockdep_map      dep_map;
  54 #endif
  55         struct sysfs_dirent     *s_parent;
  56         const char              *s_name;
  57
  58         struct rb_node          s_rb;
  59
  60         union {
  61                 struct completion       *completion;
  62                 struct sysfs_dirent     *removed_list;
  63         } u;
  64
  65         const void              *s_ns; /* namespace tag */
  66         unsigned int            s_hash; /* ns + name hash */
  67         union {
  68                 struct sysfs_elem_dir           s_dir;
  69                 struct sysfs_elem_symlink       s_symlink;
  70                 struct sysfs_elem_attr          s_attr;
  71         };
  72
  73         void                    *priv;
  74
  75         unsigned short          s_flags;
  76         umode_t                 s_mode;
  77         unsigned int            s_ino;
  78         struct sysfs_inode_attrs *s_iattr;
  79 };
  80
  81 #define SD_DEACTIVATED_BIAS             INT_MIN
  82
  83 #define SYSFS_TYPE_MASK                 0x000f
  84 #define SYSFS_DIR                       0x0001
  85 #define SYSFS_KOBJ_ATTR                 0x0002
  86 #define SYSFS_KOBJ_LINK                 0x0004
  87 #define SYSFS_COPY_NAME                 (SYSFS_DIR | SYSFS_KOBJ_LINK)
  88 #define SYSFS_ACTIVE_REF                SYSFS_KOBJ_ATTR
  89
  90 #define SYSFS_FLAG_MASK                 ~SYSFS_TYPE_MASK
  91 #define SYSFS_FLAG_REMOVED              0x0010
  92 #define SYSFS_FLAG_NS                   0x0020
  93 #define SYSFS_FLAG_HAS_SEQ_SHOW         0x0040
  94 #define SYSFS_FLAG_HAS_MMAP             0x0080
  95 #define SYSFS_FLAG_LOCKDEP              0x0100
  96
  97 static inline unsigned int sysfs_type(struct sysfs_dirent *sd)
  98 {
  99         return sd->s_flags & SYSFS_TYPE_MASK;
 100 }
 101
 102 /*
 103  * Context structure to be used while adding/removing nodes.
 104  */
 105 struct sysfs_addrm_cxt {
 106         struct sysfs_dirent     *removed;
 107 };
 108
 109 /*
 110  * mount.c
 111  */
 112
 113 /*
 114  * Each sb is associated with one namespace tag, currently the network
 115  * namespace of the task which mounted this sysfs instance.  If multiple
 116  * tags become necessary, make the following an array and compare
 117  * sysfs_dirent tag against every entry.
 118  */
 119 struct sysfs_super_info {
 120         void *ns;
 121 };
 122 #define sysfs_info(SB) ((struct sysfs_super_info *)(SB->s_fs_info))
 123 extern struct sysfs_dirent sysfs_root;
 124 extern struct kmem_cache *sysfs_dir_cachep;
 125
 126 /*
 127  * dir.c
 128  */
 129 extern struct mutex sysfs_mutex;
 130 extern spinlock_t sysfs_symlink_target_lock;
 131 extern const struct dentry_operations sysfs_dentry_ops;
 132
 133 extern const struct file_operations sysfs_dir_operations;
 134 extern const struct inode_operations sysfs_dir_inode_operations;
 135
 136 struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd);
 137 void sysfs_put_active(struct sysfs_dirent *sd);
 138 void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt);
 139 void sysfs_warn_dup(struct sysfs_dirent *parent, const char *name);
 140 int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd,
 141                   struct sysfs_dirent *parent_sd);
 142 void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt);
 143
 144 struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
 145                                        const unsigned char *name,
 146                                        const void *ns);
 147 struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type);
 148
 149 void release_sysfs_dirent(struct sysfs_dirent *sd);
 150
 151 static inline struct sysfs_dirent *__sysfs_get(struct sysfs_dirent *sd)
 152 {
 153         if (sd) {
 154                 WARN_ON(!atomic_read(&sd->s_count));
 155                 atomic_inc(&sd->s_count);
 156         }
 157         return sd;
 158 }
 159 #define sysfs_get(sd) __sysfs_get(sd)
 160
 161 static inline void __sysfs_put(struct sysfs_dirent *sd)
 162 {
 163         if (sd && atomic_dec_and_test(&sd->s_count))
 164                 release_sysfs_dirent(sd);
 165 }
 166 #define sysfs_put(sd) __sysfs_put(sd)
 167
 168 /*
 169  * inode.c
 170  */
 171 struct inode *sysfs_get_inode(struct super_block *sb, struct sysfs_dirent *sd);
 172 void sysfs_evict_inode(struct inode *inode);
 173 int sysfs_permission(struct inode *inode, int mask);
 174 int sysfs_setattr(struct dentry *dentry, struct iattr *iattr);
 175 int sysfs_getattr(struct vfsmount *mnt, struct dentry *dentry,
 176                   struct kstat *stat);
 177 int sysfs_setxattr(struct dentry *dentry, const char *name, const void *value,
 178                    size_t size, int flags);
 179 int sysfs_inode_init(void);
 180
 181 /*
 182  * file.c
 183  */
 184 extern const struct file_operations kernfs_file_operations;
 185
 186 int sysfs_add_file(struct sysfs_dirent *dir_sd,
 187                    const struct attribute *attr, bool is_bin);
 188
 189 int sysfs_add_file_mode_ns(struct sysfs_dirent *dir_sd,
 190                            const struct attribute *attr, bool is_bin,
 191                            umode_t amode, const void *ns);
 192 void sysfs_unmap_bin_file(struct sysfs_dirent *sd);
 193
 194 /*
 195  * symlink.c
 196  */
 197 extern const struct inode_operations sysfs_symlink_inode_operations;
 198 int sysfs_create_link_sd(struct sysfs_dirent *sd, struct kobject *target,
 199                          const char *name);