blob: d998e8e278416ef5a1965f0ebe6c6f060caae2f9 [file] [log] [blame]
Tejun Heo3e519032007-06-14 03:45:15 +09001struct sysfs_elem_dir {
2 struct kobject * kobj;
3};
4
5struct sysfs_elem_symlink {
Tejun Heo2b29ac22007-06-14 03:45:15 +09006 struct sysfs_dirent * target_sd;
Tejun Heo3e519032007-06-14 03:45:15 +09007};
8
9struct sysfs_elem_attr {
10 struct attribute * attr;
11};
12
13struct sysfs_elem_bin_attr {
14 struct bin_attribute * bin_attr;
15};
16
Tejun Heo0ab66082007-06-14 03:45:16 +090017/*
18 * As long as s_count reference is held, the sysfs_dirent itself is
19 * accessible. Dereferencing s_elem or any other outer entity
20 * requires s_active reference.
21 */
Adam J. Richterd56c3ea2007-02-16 21:35:25 +080022struct sysfs_dirent {
23 atomic_t s_count;
Tejun Heo0ab66082007-06-14 03:45:16 +090024 struct rw_semaphore s_active;
Tejun Heo13b30862007-06-14 03:45:14 +090025 struct sysfs_dirent * s_parent;
Adam J. Richterd56c3ea2007-02-16 21:35:25 +080026 struct list_head s_sibling;
27 struct list_head s_children;
Tejun Heo0c096b52007-06-14 03:45:15 +090028 const char * s_name;
Tejun Heo3e519032007-06-14 03:45:15 +090029
30 union {
31 struct sysfs_elem_dir dir;
32 struct sysfs_elem_symlink symlink;
33 struct sysfs_elem_attr attr;
34 struct sysfs_elem_bin_attr bin_attr;
35 } s_elem;
36
Adam J. Richterd56c3ea2007-02-16 21:35:25 +080037 int s_type;
38 umode_t s_mode;
Eric Sandeendc351252007-06-11 14:02:45 +090039 ino_t s_ino;
Adam J. Richterd56c3ea2007-02-16 21:35:25 +080040 struct dentry * s_dentry;
41 struct iattr * s_iattr;
42 atomic_t s_event;
43};
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Tejun Heo0ab66082007-06-14 03:45:16 +090045/*
46 * A sysfs file which deletes another file when written to need to
47 * write lock the s_active of the victim while its s_active is read
48 * locked for the write operation. Tell lockdep that this is okay.
49 */
50enum sysfs_s_active_class
51{
52 SYSFS_S_ACTIVE_NORMAL, /* file r/w access, etc - default */
53 SYSFS_S_ACTIVE_DEACTIVATE, /* file deactivation */
54};
55
Linus Torvalds1da177e2005-04-16 15:20:36 -070056extern struct vfsmount * sysfs_mount;
Christoph Lametere18b8902006-12-06 20:33:20 -080057extern struct kmem_cache *sysfs_dir_cachep;
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -070059extern void sysfs_delete_inode(struct inode *inode);
Maneesh Soni82155342005-05-31 10:39:52 +053060extern struct inode * sysfs_new_inode(mode_t mode, struct sysfs_dirent *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070061extern int sysfs_create(struct dentry *, int mode, int (*init)(struct inode *));
62
Tejun Heofa7f9122007-06-14 03:45:13 +090063extern void release_sysfs_dirent(struct sysfs_dirent * sd);
Maneesh Sonic5168652006-03-09 19:40:14 +053064extern int sysfs_dirent_exist(struct sysfs_dirent *, const unsigned char *);
Tejun Heo3e519032007-06-14 03:45:15 +090065extern struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode,
66 int type);
Tejun Heoa26cd722007-06-14 03:45:14 +090067extern void sysfs_attach_dirent(struct sysfs_dirent *sd,
68 struct sysfs_dirent *parent_sd,
69 struct dentry *dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -070070
71extern int sysfs_add_file(struct dentry *, const struct attribute *, int);
Randy.Dunlap995982c2006-07-10 23:05:25 -070072extern int sysfs_hash_and_remove(struct dentry * dir, const char * name);
NeilBrown4508a7a2006-03-20 17:53:53 +110073extern struct sysfs_dirent *sysfs_find(struct sysfs_dirent *dir, const char * name);
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
75extern int sysfs_create_subdir(struct kobject *, const char *, struct dentry **);
76extern void sysfs_remove_subdir(struct dentry *);
77
Linus Torvalds1da177e2005-04-16 15:20:36 -070078extern void sysfs_drop_dentry(struct sysfs_dirent *sd, struct dentry *parent);
Maneesh Soni988d1862005-05-31 10:39:14 +053079extern int sysfs_setattr(struct dentry *dentry, struct iattr *iattr);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
Tejun Heodd14cbc2007-06-11 14:04:01 +090081extern spinlock_t sysfs_lock;
Tejun Heoaecdced2007-06-14 03:45:15 +090082extern spinlock_t kobj_sysfs_assoc_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -070083extern struct rw_semaphore sysfs_rename_sem;
84extern struct super_block * sysfs_sb;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -080085extern const struct file_operations sysfs_dir_operations;
86extern const struct file_operations sysfs_file_operations;
87extern const struct file_operations bin_fops;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -080088extern const struct inode_operations sysfs_dir_inode_operations;
89extern const struct inode_operations sysfs_symlink_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Oliver Neukum94bebf42006-12-20 10:52:44 +010091struct sysfs_buffer {
92 struct list_head associates;
93 size_t count;
94 loff_t pos;
95 char * page;
96 struct sysfs_ops * ops;
97 struct semaphore sem;
98 int orphaned;
99 int needs_read_fill;
100 int event;
101};
102
103struct sysfs_buffer_collection {
104 struct list_head associates;
105};
106
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107static inline struct sysfs_dirent * sysfs_get(struct sysfs_dirent * sd)
108{
109 if (sd) {
110 WARN_ON(!atomic_read(&sd->s_count));
111 atomic_inc(&sd->s_count);
112 }
113 return sd;
114}
115
116static inline void sysfs_put(struct sysfs_dirent * sd)
117{
Tejun Heo7a23ad42007-06-14 03:45:13 +0900118 if (sd && atomic_dec_and_test(&sd->s_count))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 release_sysfs_dirent(sd);
120}
121
Tejun Heo0ab66082007-06-14 03:45:16 +0900122/**
123 * sysfs_get_active - get an active reference to sysfs_dirent
124 * @sd: sysfs_dirent to get an active reference to
125 *
126 * Get an active reference of @sd. This function is noop if @sd
127 * is NULL.
128 *
129 * RETURNS:
130 * Pointer to @sd on success, NULL on failure.
131 */
132static inline struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd)
133{
134 if (sd) {
135 if (unlikely(!down_read_trylock(&sd->s_active)))
136 sd = NULL;
137 }
138 return sd;
139}
140
141/**
142 * sysfs_put_active - put an active reference to sysfs_dirent
143 * @sd: sysfs_dirent to put an active reference to
144 *
145 * Put an active reference to @sd. This function is noop if @sd
146 * is NULL.
147 */
148static inline void sysfs_put_active(struct sysfs_dirent *sd)
149{
150 if (sd)
151 up_read(&sd->s_active);
152}
153
154/**
155 * sysfs_get_active_two - get active references to sysfs_dirent and parent
156 * @sd: sysfs_dirent of interest
157 *
158 * Get active reference to @sd and its parent. Parent's active
159 * reference is grabbed first. This function is noop if @sd is
160 * NULL.
161 *
162 * RETURNS:
163 * Pointer to @sd on success, NULL on failure.
164 */
165static inline struct sysfs_dirent *sysfs_get_active_two(struct sysfs_dirent *sd)
166{
167 if (sd) {
168 if (sd->s_parent && unlikely(!sysfs_get_active(sd->s_parent)))
169 return NULL;
170 if (unlikely(!sysfs_get_active(sd))) {
171 sysfs_put_active(sd->s_parent);
172 return NULL;
173 }
174 }
175 return sd;
176}
177
178/**
179 * sysfs_put_active_two - put active references to sysfs_dirent and parent
180 * @sd: sysfs_dirent of interest
181 *
182 * Put active references to @sd and its parent. This function is
183 * noop if @sd is NULL.
184 */
185static inline void sysfs_put_active_two(struct sysfs_dirent *sd)
186{
187 if (sd) {
188 sysfs_put_active(sd);
189 sysfs_put_active(sd->s_parent);
190 }
191}
192
193/**
194 * sysfs_deactivate - deactivate sysfs_dirent
195 * @sd: sysfs_dirent to deactivate
196 *
197 * Deny new active references and drain existing ones. s_active
198 * will be unlocked when the sysfs_dirent is released.
199 */
200static inline void sysfs_deactivate(struct sysfs_dirent *sd)
201{
202 down_write_nested(&sd->s_active, SYSFS_S_ACTIVE_DEACTIVATE);
203
204 /* s_active will be unlocked by the thread doing the final put
205 * on @sd. Lie to lockdep.
206 */
207 rwsem_release(&sd->s_active.dep_map, 1, _RET_IP_);
208}
209
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700210static inline int sysfs_is_shadowed_inode(struct inode *inode)
211{
212 return S_ISDIR(inode->i_mode) && inode->i_op->follow_link;
213}