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