fs/sysfs/sysfs.h

   1 /* type-specific structures for sysfs_dirent->s_* union members */
   2 struct sysfs_elem_dir {
   3         struct kobject          *kobj;
   4 };
   5
   6 struct sysfs_elem_symlink {
   7         struct sysfs_dirent     *target_sd;
   8 };
   9
  10 struct sysfs_elem_attr {
  11         struct attribute        *attr;
  12 };
  13
  14 struct sysfs_elem_bin_attr {
  15         struct bin_attribute    *bin_attr;
  16 };
  17
  18 /*
  19  * sysfs_dirent - the building block of sysfs hierarchy.  Each and
  20  * every sysfs node is represented by single sysfs_dirent.
  21  *
  22  * As long as s_count reference is held, the sysfs_dirent itself is
  23  * accessible.  Dereferencing s_elem or any other outer entity
  24  * requires s_active reference.
  25  */
  26 struct sysfs_dirent {
  27         atomic_t                s_count;
  28         atomic_t                s_active;
  29         struct sysfs_dirent     *s_parent;
  30         struct sysfs_dirent     *s_sibling;
  31         struct sysfs_dirent     *s_children;
  32         const char              *s_name;
  33
  34         union {
  35                 struct sysfs_elem_dir           s_dir;
  36                 struct sysfs_elem_symlink       s_symlink;
  37                 struct sysfs_elem_attr          s_attr;
  38                 struct sysfs_elem_bin_attr      s_bin_attr;
  39         };
  40
  41         unsigned int            s_flags;
  42         ino_t                   s_ino;
  43         umode_t                 s_mode;
  44         struct iattr            *s_iattr;
  45         atomic_t                s_event;
  46 };
  47
  48 #define SD_DEACTIVATED_BIAS             INT_MIN
  49
  50 #define SYSFS_TYPE_MASK                 0x00ff
  51 #define SYSFS_DIR                       0x0001
  52 #define SYSFS_KOBJ_ATTR                 0x0002
  53 #define SYSFS_KOBJ_BIN_ATTR             0x0004
  54 #define SYSFS_KOBJ_LINK                 0x0008
  55 #define SYSFS_COPY_NAME                 (SYSFS_DIR | SYSFS_KOBJ_LINK)
  56
  57 #define SYSFS_FLAG_MASK                 ~SYSFS_TYPE_MASK
  58 #define SYSFS_FLAG_REMOVED              0x0200
  59
  60 static inline unsigned int sysfs_type(struct sysfs_dirent *sd)
  61 {
  62         return sd->s_flags & SYSFS_TYPE_MASK;
  63 }
  64
  65 /*
  66  * Context structure to be used while adding/removing nodes.
  67  */
  68 struct sysfs_addrm_cxt {
  69         struct sysfs_dirent     *parent_sd;
  70         struct inode            *parent_inode;
  71         struct sysfs_dirent     *removed;
  72         int                     cnt;
  73 };
  74
  75 /*
  76  * mount.c
  77  */
  78 extern struct sysfs_dirent sysfs_root;
  79 extern struct super_block *sysfs_sb;
  80 extern struct kmem_cache *sysfs_dir_cachep;
  81
  82 /*
  83  * dir.c
  84  */
  85 extern struct mutex sysfs_mutex;
  86 extern struct mutex sysfs_rename_mutex;
  87 extern spinlock_t sysfs_assoc_lock;
  88
  89 extern const struct file_operations sysfs_dir_operations;
  90 extern const struct inode_operations sysfs_dir_inode_operations;
  91
  92 struct dentry *sysfs_get_dentry(struct sysfs_dirent *sd);
  93 struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd);
  94 void sysfs_put_active(struct sysfs_dirent *sd);
  95 struct sysfs_dirent *sysfs_get_active_two(struct sysfs_dirent *sd);
  96 void sysfs_put_active_two(struct sysfs_dirent *sd);
  97 void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
  98                        struct sysfs_dirent *parent_sd);
  99 int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
 100 void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
 101 void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt);
 102
 103 struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
 104                                        const unsigned char *name);
 105 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
 106                                       const unsigned char *name);
 107 struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type);
 108
 109 void release_sysfs_dirent(struct sysfs_dirent *sd);
 110
 111 int sysfs_create_subdir(struct kobject *kobj, const char *name,
 112                         struct sysfs_dirent **p_sd);
 113 void sysfs_remove_subdir(struct sysfs_dirent *sd);
 114
 115 static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
 116 {
 117         if (sd) {
 118                 WARN_ON(!atomic_read(&sd->s_count));
 119                 atomic_inc(&sd->s_count);
 120         }
 121         return sd;
 122 }
 123
 124 static inline void sysfs_put(struct sysfs_dirent *sd)
 125 {
 126         if (sd && atomic_dec_and_test(&sd->s_count))
 127                 release_sysfs_dirent(sd);
 128 }
 129
 130 /*
 131  * inode.c
 132  */
 133 struct inode *sysfs_get_inode(struct sysfs_dirent *sd);
 134 int sysfs_setattr(struct dentry *dentry, struct iattr *iattr);
 135 int sysfs_hash_and_remove(struct sysfs_dirent *dir_sd, const char *name);
 136
 137 /*
 138  * file.c
 139  */
 140 extern const struct file_operations sysfs_file_operations;
 141
 142 int sysfs_add_file(struct sysfs_dirent *dir_sd,
 143                    const struct attribute *attr, int type);
 144
 145 /*
 146  * bin.c
 147  */
 148 extern const struct file_operations bin_fops;
 149
 150 /*
 151  * symlink.c
 152  */
 153 extern const struct inode_operations sysfs_symlink_inode_operations;