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                 0x00ff
  84 #define SYSFS_DIR                       0x0001
  85 #define SYSFS_KOBJ_ATTR                 0x0002
  86 #define SYSFS_KOBJ_BIN_ATTR             0x0004
  87 #define SYSFS_KOBJ_LINK                 0x0008
  88 #define SYSFS_COPY_NAME                 (SYSFS_DIR | SYSFS_KOBJ_LINK)
  89 #define SYSFS_ACTIVE_REF                (SYSFS_KOBJ_ATTR | SYSFS_KOBJ_BIN_ATTR)
  90
  91 #define SYSFS_FLAG_MASK                 ~SYSFS_TYPE_MASK
  92 #define SYSFS_FLAG_NS                   0x01000
  93 #define SYSFS_FLAG_REMOVED              0x02000
  94 #define SYSFS_FLAG_HAS_SEQ_SHOW         0x04000
  95 #define SYSFS_FLAG_HAS_MMAP             0x08000
  96
  97 static inline unsigned int sysfs_type(struct sysfs_dirent *sd)
  98 {
  99         return sd->s_flags & SYSFS_TYPE_MASK;
 100 }
 101
 102 #ifdef CONFIG_DEBUG_LOCK_ALLOC
 103
 104 #define sysfs_dirent_init_lockdep(sd)                           \
 105 do {                                                            \
 106         struct attribute *attr = sd->priv;                      \
 107         struct lock_class_key *key = attr->key;                 \
 108         if (!key)                                               \
 109                 key = &attr->skey;                              \
 110                                                                 \
 111         lockdep_init_map(&sd->dep_map, "s_active", key, 0);     \
 112 } while (0)
 113
 114 /* Test for attributes that want to ignore lockdep for read-locking */
 115 static inline bool sysfs_ignore_lockdep(struct sysfs_dirent *sd)
 116 {
 117         struct attribute *attr = sd->priv;
 118         int type = sysfs_type(sd);
 119
 120         return (type == SYSFS_KOBJ_ATTR || type == SYSFS_KOBJ_BIN_ATTR) &&
 121                 attr->ignore_lockdep;
 122 }
 123
 124 #else
 125
 126 #define sysfs_dirent_init_lockdep(sd) do {} while (0)
 127
 128 static inline bool sysfs_ignore_lockdep(struct sysfs_dirent *sd)
 129 {
 130         return true;
 131 }
 132
 133 #endif
 134
 135 /*
 136  * Context structure to be used while adding/removing nodes.
 137  */
 138 struct sysfs_addrm_cxt {
 139         struct sysfs_dirent     *removed;
 140 };
 141
 142 /*
 143  * mount.c
 144  */
 145
 146 /*
 147  * Each sb is associated with one namespace tag, currently the network
 148  * namespace of the task which mounted this sysfs instance.  If multiple
 149  * tags become necessary, make the following an array and compare
 150  * sysfs_dirent tag against every entry.
 151  */
 152 struct sysfs_super_info {
 153         void *ns;
 154 };
 155 #define sysfs_info(SB) ((struct sysfs_super_info *)(SB->s_fs_info))
 156 extern struct sysfs_dirent sysfs_root;
 157 extern struct kmem_cache *sysfs_dir_cachep;
 158
 159 /*
 160  * dir.c
 161  */
 162 extern struct mutex sysfs_mutex;
 163 extern spinlock_t sysfs_symlink_target_lock;
 164 extern const struct dentry_operations sysfs_dentry_ops;
 165
 166 extern const struct file_operations sysfs_dir_operations;
 167 extern const struct inode_operations sysfs_dir_inode_operations;
 168
 169 struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd);
 170 void sysfs_put_active(struct sysfs_dirent *sd);
 171 void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt);
 172 void sysfs_warn_dup(struct sysfs_dirent *parent, const char *name);
 173 int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd,
 174                     struct sysfs_dirent *parent_sd);
 175 int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd,
 176                   struct sysfs_dirent *parent_sd);
 177 void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt);
 178
 179 struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
 180                                        const unsigned char *name,
 181                                        const void *ns);
 182 struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type);
 183
 184 void release_sysfs_dirent(struct sysfs_dirent *sd);
 185
 186 static inline struct sysfs_dirent *__sysfs_get(struct sysfs_dirent *sd)
 187 {
 188         if (sd) {
 189                 WARN_ON(!atomic_read(&sd->s_count));
 190                 atomic_inc(&sd->s_count);
 191         }
 192         return sd;
 193 }
 194 #define sysfs_get(sd) __sysfs_get(sd)
 195
 196 static inline void __sysfs_put(struct sysfs_dirent *sd)
 197 {
 198         if (sd && atomic_dec_and_test(&sd->s_count))
 199                 release_sysfs_dirent(sd);
 200 }
 201 #define sysfs_put(sd) __sysfs_put(sd)
 202
 203 /*
 204  * inode.c
 205  */
 206 struct inode *sysfs_get_inode(struct super_block *sb, struct sysfs_dirent *sd);
 207 void sysfs_evict_inode(struct inode *inode);
 208 int sysfs_permission(struct inode *inode, int mask);
 209 int sysfs_setattr(struct dentry *dentry, struct iattr *iattr);
 210 int sysfs_getattr(struct vfsmount *mnt, struct dentry *dentry,
 211                   struct kstat *stat);
 212 int sysfs_setxattr(struct dentry *dentry, const char *name, const void *value,
 213                    size_t size, int flags);
 214 int sysfs_inode_init(void);
 215
 216 /*
 217  * file.c
 218  */
 219 extern const struct file_operations kernfs_file_operations;
 220
 221 int sysfs_add_file(struct sysfs_dirent *dir_sd,
 222                    const struct attribute *attr, int type);
 223
 224 int sysfs_add_file_mode_ns(struct sysfs_dirent *dir_sd,
 225                            const struct attribute *attr, int type,
 226                            umode_t amode, const void *ns);
 227 void sysfs_unmap_bin_file(struct sysfs_dirent *sd);
 228
 229 /*
 230  * symlink.c
 231  */
 232 extern const struct inode_operations sysfs_symlink_inode_operations;
 233 int sysfs_create_link_sd(struct sysfs_dirent *sd, struct kobject *target,
 234                          const char *name);