blob: b4074adbab01ea56b75ad0d538316308ed5e4ac9 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * dir.c - Operations for sysfs directories.
3 */
4
5#undef DEBUG
6
7#include <linux/fs.h>
8#include <linux/mount.h>
9#include <linux/module.h>
10#include <linux/kobject.h>
Christoph Hellwig5f45f1a2005-06-23 00:09:12 -070011#include <linux/namei.h>
Tejun Heo2b611bb2007-06-14 03:45:13 +090012#include <linux/idr.h>
Tejun Heo8619f972007-06-14 03:45:18 +090013#include <linux/completion.h>
Oliver Neukum94bebf42006-12-20 10:52:44 +010014#include <asm/semaphore.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include "sysfs.h"
16
17DECLARE_RWSEM(sysfs_rename_sem);
Tejun Heodd14cbc2007-06-11 14:04:01 +090018spinlock_t sysfs_lock = SPIN_LOCK_UNLOCKED;
Tejun Heoaecdced2007-06-14 03:45:15 +090019spinlock_t kobj_sysfs_assoc_lock = SPIN_LOCK_UNLOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
Tejun Heo2b611bb2007-06-14 03:45:13 +090021static spinlock_t sysfs_ino_lock = SPIN_LOCK_UNLOCKED;
22static DEFINE_IDA(sysfs_ino_ida);
23
Tejun Heob6b4a432007-06-14 03:45:18 +090024/**
Tejun Heo0c73f182007-06-14 03:45:18 +090025 * sysfs_link_sibling - link sysfs_dirent into sibling list
26 * @sd: sysfs_dirent of interest
27 *
28 * Link @sd into its sibling list which starts from
29 * sd->s_parent->s_children.
30 *
31 * Locking:
32 * mutex_lock(sd->s_parent->dentry->d_inode->i_mutex)
33 */
34static void sysfs_link_sibling(struct sysfs_dirent *sd)
35{
36 struct sysfs_dirent *parent_sd = sd->s_parent;
37
38 BUG_ON(sd->s_sibling);
39 sd->s_sibling = parent_sd->s_children;
40 parent_sd->s_children = sd;
41}
42
43/**
44 * sysfs_unlink_sibling - unlink sysfs_dirent from sibling list
45 * @sd: sysfs_dirent of interest
46 *
47 * Unlink @sd from its sibling list which starts from
48 * sd->s_parent->s_children.
49 *
50 * Locking:
51 * mutex_lock(sd->s_parent->dentry->d_inode->i_mutex)
52 */
53static void sysfs_unlink_sibling(struct sysfs_dirent *sd)
54{
55 struct sysfs_dirent **pos;
56
57 for (pos = &sd->s_parent->s_children; *pos; pos = &(*pos)->s_sibling) {
58 if (*pos == sd) {
59 *pos = sd->s_sibling;
60 sd->s_sibling = NULL;
61 break;
62 }
63 }
64}
65
66/**
Tejun Heob6b4a432007-06-14 03:45:18 +090067 * sysfs_get_active - get an active reference to sysfs_dirent
68 * @sd: sysfs_dirent to get an active reference to
69 *
70 * Get an active reference of @sd. This function is noop if @sd
71 * is NULL.
72 *
73 * RETURNS:
74 * Pointer to @sd on success, NULL on failure.
75 */
76struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd)
77{
Tejun Heo8619f972007-06-14 03:45:18 +090078 if (unlikely(!sd))
79 return NULL;
80
81 while (1) {
82 int v, t;
83
84 v = atomic_read(&sd->s_active);
85 if (unlikely(v < 0))
86 return NULL;
87
88 t = atomic_cmpxchg(&sd->s_active, v, v + 1);
89 if (likely(t == v))
90 return sd;
91 if (t < 0)
92 return NULL;
93
94 cpu_relax();
Tejun Heob6b4a432007-06-14 03:45:18 +090095 }
Tejun Heob6b4a432007-06-14 03:45:18 +090096}
97
98/**
99 * sysfs_put_active - put an active reference to sysfs_dirent
100 * @sd: sysfs_dirent to put an active reference to
101 *
102 * Put an active reference to @sd. This function is noop if @sd
103 * is NULL.
104 */
105void sysfs_put_active(struct sysfs_dirent *sd)
106{
Tejun Heo8619f972007-06-14 03:45:18 +0900107 struct completion *cmpl;
108 int v;
109
110 if (unlikely(!sd))
111 return;
112
113 v = atomic_dec_return(&sd->s_active);
114 if (likely(v != SD_DEACTIVATED_BIAS))
115 return;
116
117 /* atomic_dec_return() is a mb(), we'll always see the updated
Tejun Heo0c73f182007-06-14 03:45:18 +0900118 * sd->s_sibling.
Tejun Heo8619f972007-06-14 03:45:18 +0900119 */
Tejun Heo0c73f182007-06-14 03:45:18 +0900120 cmpl = (void *)sd->s_sibling;
Tejun Heo8619f972007-06-14 03:45:18 +0900121 complete(cmpl);
Tejun Heob6b4a432007-06-14 03:45:18 +0900122}
123
124/**
125 * sysfs_get_active_two - get active references to sysfs_dirent and parent
126 * @sd: sysfs_dirent of interest
127 *
128 * Get active reference to @sd and its parent. Parent's active
129 * reference is grabbed first. This function is noop if @sd is
130 * NULL.
131 *
132 * RETURNS:
133 * Pointer to @sd on success, NULL on failure.
134 */
135struct sysfs_dirent *sysfs_get_active_two(struct sysfs_dirent *sd)
136{
137 if (sd) {
138 if (sd->s_parent && unlikely(!sysfs_get_active(sd->s_parent)))
139 return NULL;
140 if (unlikely(!sysfs_get_active(sd))) {
141 sysfs_put_active(sd->s_parent);
142 return NULL;
143 }
144 }
145 return sd;
146}
147
148/**
149 * sysfs_put_active_two - put active references to sysfs_dirent and parent
150 * @sd: sysfs_dirent of interest
151 *
152 * Put active references to @sd and its parent. This function is
153 * noop if @sd is NULL.
154 */
155void sysfs_put_active_two(struct sysfs_dirent *sd)
156{
157 if (sd) {
158 sysfs_put_active(sd);
159 sysfs_put_active(sd->s_parent);
160 }
161}
162
163/**
164 * sysfs_deactivate - deactivate sysfs_dirent
165 * @sd: sysfs_dirent to deactivate
166 *
Tejun Heo8619f972007-06-14 03:45:18 +0900167 * Deny new active references and drain existing ones.
Tejun Heob6b4a432007-06-14 03:45:18 +0900168 */
169void sysfs_deactivate(struct sysfs_dirent *sd)
170{
Tejun Heo8619f972007-06-14 03:45:18 +0900171 DECLARE_COMPLETION_ONSTACK(wait);
172 int v;
Tejun Heob6b4a432007-06-14 03:45:18 +0900173
Tejun Heo0c73f182007-06-14 03:45:18 +0900174 BUG_ON(sd->s_sibling);
175 sd->s_sibling = (void *)&wait;
Tejun Heo8619f972007-06-14 03:45:18 +0900176
177 /* atomic_add_return() is a mb(), put_active() will always see
Tejun Heo0c73f182007-06-14 03:45:18 +0900178 * the updated sd->s_sibling.
Tejun Heob6b4a432007-06-14 03:45:18 +0900179 */
Tejun Heo8619f972007-06-14 03:45:18 +0900180 v = atomic_add_return(SD_DEACTIVATED_BIAS, &sd->s_active);
181
182 if (v != SD_DEACTIVATED_BIAS)
183 wait_for_completion(&wait);
184
Tejun Heo0c73f182007-06-14 03:45:18 +0900185 sd->s_sibling = NULL;
Tejun Heob6b4a432007-06-14 03:45:18 +0900186}
187
Tejun Heo42b37df2007-06-14 03:45:17 +0900188static int sysfs_alloc_ino(ino_t *pino)
Tejun Heo2b611bb2007-06-14 03:45:13 +0900189{
190 int ino, rc;
191
192 retry:
193 spin_lock(&sysfs_ino_lock);
194 rc = ida_get_new_above(&sysfs_ino_ida, 2, &ino);
195 spin_unlock(&sysfs_ino_lock);
196
197 if (rc == -EAGAIN) {
198 if (ida_pre_get(&sysfs_ino_ida, GFP_KERNEL))
199 goto retry;
200 rc = -ENOMEM;
201 }
202
203 *pino = ino;
204 return rc;
205}
206
207static void sysfs_free_ino(ino_t ino)
208{
209 spin_lock(&sysfs_ino_lock);
210 ida_remove(&sysfs_ino_ida, ino);
211 spin_unlock(&sysfs_ino_lock);
212}
213
Tejun Heofa7f9122007-06-14 03:45:13 +0900214void release_sysfs_dirent(struct sysfs_dirent * sd)
215{
Tejun Heo13b30862007-06-14 03:45:14 +0900216 struct sysfs_dirent *parent_sd;
217
218 repeat:
219 parent_sd = sd->s_parent;
220
Tejun Heo3e519032007-06-14 03:45:15 +0900221 if (sd->s_type & SYSFS_KOBJ_LINK)
Tejun Heo2b29ac22007-06-14 03:45:15 +0900222 sysfs_put(sd->s_elem.symlink.target_sd);
Tejun Heo0c096b52007-06-14 03:45:15 +0900223 if (sd->s_type & SYSFS_COPY_NAME)
224 kfree(sd->s_name);
Tejun Heofa7f9122007-06-14 03:45:13 +0900225 kfree(sd->s_iattr);
Tejun Heo2b611bb2007-06-14 03:45:13 +0900226 sysfs_free_ino(sd->s_ino);
Tejun Heofa7f9122007-06-14 03:45:13 +0900227 kmem_cache_free(sysfs_dir_cachep, sd);
Tejun Heo13b30862007-06-14 03:45:14 +0900228
229 sd = parent_sd;
230 if (sd && atomic_dec_and_test(&sd->s_count))
231 goto repeat;
Tejun Heofa7f9122007-06-14 03:45:13 +0900232}
233
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234static void sysfs_d_iput(struct dentry * dentry, struct inode * inode)
235{
236 struct sysfs_dirent * sd = dentry->d_fsdata;
237
238 if (sd) {
Tejun Heodd14cbc2007-06-11 14:04:01 +0900239 /* sd->s_dentry is protected with sysfs_lock. This
240 * allows sysfs_drop_dentry() to dereference it.
241 */
242 spin_lock(&sysfs_lock);
243
244 /* The dentry might have been deleted or another
245 * lookup could have happened updating sd->s_dentry to
246 * point the new dentry. Ignore if it isn't pointing
247 * to this dentry.
248 */
249 if (sd->s_dentry == dentry)
250 sd->s_dentry = NULL;
251 spin_unlock(&sysfs_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 sysfs_put(sd);
253 }
254 iput(inode);
255}
256
257static struct dentry_operations sysfs_dentry_ops = {
258 .d_iput = sysfs_d_iput,
259};
260
Tejun Heo3e519032007-06-14 03:45:15 +0900261struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262{
Tejun Heo0c096b52007-06-14 03:45:15 +0900263 char *dup_name = NULL;
264 struct sysfs_dirent *sd = NULL;
265
266 if (type & SYSFS_COPY_NAME) {
267 name = dup_name = kstrdup(name, GFP_KERNEL);
268 if (!name)
269 goto err_out;
270 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271
Robert P. J. Dayc3762222007-02-10 01:45:03 -0800272 sd = kmem_cache_zalloc(sysfs_dir_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 if (!sd)
Tejun Heo0c096b52007-06-14 03:45:15 +0900274 goto err_out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
Tejun Heo0c096b52007-06-14 03:45:15 +0900276 if (sysfs_alloc_ino(&sd->s_ino))
277 goto err_out;
Tejun Heo2b611bb2007-06-14 03:45:13 +0900278
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 atomic_set(&sd->s_count, 1);
Tejun Heo8619f972007-06-14 03:45:18 +0900280 atomic_set(&sd->s_active, 0);
Juha Yrjöläeea3f892006-08-03 19:06:25 +0300281 atomic_set(&sd->s_event, 1);
Tejun Heoa26cd722007-06-14 03:45:14 +0900282
Tejun Heo0c096b52007-06-14 03:45:15 +0900283 sd->s_name = name;
Tejun Heoa26cd722007-06-14 03:45:14 +0900284 sd->s_mode = mode;
285 sd->s_type = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286
287 return sd;
Tejun Heo0c096b52007-06-14 03:45:15 +0900288
289 err_out:
290 kfree(dup_name);
291 kmem_cache_free(sysfs_dir_cachep, sd);
292 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293}
294
Tejun Heo198a2a82007-06-14 03:45:16 +0900295static void sysfs_attach_dentry(struct sysfs_dirent *sd, struct dentry *dentry)
296{
297 dentry->d_op = &sysfs_dentry_ops;
298 dentry->d_fsdata = sysfs_get(sd);
299
300 /* protect sd->s_dentry against sysfs_d_iput */
301 spin_lock(&sysfs_lock);
302 sd->s_dentry = dentry;
303 spin_unlock(&sysfs_lock);
304
305 d_rehash(dentry);
306}
307
Tejun Heoa26cd722007-06-14 03:45:14 +0900308void sysfs_attach_dirent(struct sysfs_dirent *sd,
309 struct sysfs_dirent *parent_sd, struct dentry *dentry)
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700310{
Tejun Heo198a2a82007-06-14 03:45:16 +0900311 if (dentry)
312 sysfs_attach_dentry(sd, dentry);
Tejun Heoa26cd722007-06-14 03:45:14 +0900313
Tejun Heo13b30862007-06-14 03:45:14 +0900314 if (parent_sd) {
315 sd->s_parent = sysfs_get(parent_sd);
Tejun Heo0c73f182007-06-14 03:45:18 +0900316 sysfs_link_sibling(sd);
Tejun Heo13b30862007-06-14 03:45:14 +0900317 }
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700318}
319
Martin Waitza5802902006-04-02 13:59:55 +0200320/*
Maneesh Sonic5168652006-03-09 19:40:14 +0530321 *
322 * Return -EEXIST if there is already a sysfs element with the same name for
323 * the same parent.
324 *
325 * called with parent inode's i_mutex held
326 */
327int sysfs_dirent_exist(struct sysfs_dirent *parent_sd,
328 const unsigned char *new)
329{
330 struct sysfs_dirent * sd;
331
Tejun Heo0c73f182007-06-14 03:45:18 +0900332 for (sd = parent_sd->s_children; sd; sd = sd->s_sibling) {
Tejun Heo3e519032007-06-14 03:45:15 +0900333 if (sd->s_type) {
Tejun Heo0c096b52007-06-14 03:45:15 +0900334 if (strcmp(sd->s_name, new))
Maneesh Sonic5168652006-03-09 19:40:14 +0530335 continue;
336 else
337 return -EEXIST;
338 }
339 }
340
341 return 0;
342}
343
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900344static int create_dir(struct kobject *kobj, struct dentry *parent,
345 const char *name, struct dentry **p_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346{
347 int error;
348 umode_t mode = S_IFDIR| S_IRWXU | S_IRUGO | S_IXUGO;
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900349 struct dentry *dentry;
Tejun Heofc9f54b2007-06-14 03:45:17 +0900350 struct inode *inode;
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900351 struct sysfs_dirent *sd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900353 mutex_lock(&parent->d_inode->i_mutex);
354
Tejun Heofc9f54b2007-06-14 03:45:17 +0900355 /* allocate */
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900356 dentry = lookup_one_len(name, parent, strlen(name));
357 if (IS_ERR(dentry)) {
358 error = PTR_ERR(dentry);
359 goto out_unlock;
360 }
361
362 error = -EEXIST;
Tejun Heofc9f54b2007-06-14 03:45:17 +0900363 if (dentry->d_inode)
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900364 goto out_dput;
365
Tejun Heoa26cd722007-06-14 03:45:14 +0900366 error = -ENOMEM;
Tejun Heo3e519032007-06-14 03:45:15 +0900367 sd = sysfs_new_dirent(name, mode, SYSFS_DIR);
Tejun Heoa26cd722007-06-14 03:45:14 +0900368 if (!sd)
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900369 goto out_drop;
Tejun Heo3e519032007-06-14 03:45:15 +0900370 sd->s_elem.dir.kobj = kobj;
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900371
Tejun Heo8312a8d2007-06-14 03:45:17 +0900372 inode = sysfs_get_inode(sd);
Tejun Heofc9f54b2007-06-14 03:45:17 +0900373 if (!inode)
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900374 goto out_sput;
375
Tejun Heo8312a8d2007-06-14 03:45:17 +0900376 if (inode->i_state & I_NEW) {
377 inode->i_op = &sysfs_dir_inode_operations;
378 inode->i_fop = &sysfs_dir_operations;
379 /* directory inodes start off with i_nlink == 2 (for ".") */
380 inc_nlink(inode);
381 }
Tejun Heofc9f54b2007-06-14 03:45:17 +0900382
383 /* link in */
384 error = -EEXIST;
385 if (sysfs_dirent_exist(parent->d_fsdata, name))
386 goto out_iput;
387
388 sysfs_instantiate(dentry, inode);
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900389 inc_nlink(parent->d_inode);
Tejun Heo198a2a82007-06-14 03:45:16 +0900390 sysfs_attach_dirent(sd, parent->d_fsdata, dentry);
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900391
392 *p_dentry = dentry;
393 error = 0;
Tejun Heofc9f54b2007-06-14 03:45:17 +0900394 goto out_unlock; /* pin directory dentry in core */
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900395
Tejun Heofc9f54b2007-06-14 03:45:17 +0900396 out_iput:
397 iput(inode);
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900398 out_sput:
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900399 sysfs_put(sd);
400 out_drop:
401 d_drop(dentry);
402 out_dput:
403 dput(dentry);
404 out_unlock:
405 mutex_unlock(&parent->d_inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 return error;
407}
408
409
410int sysfs_create_subdir(struct kobject * k, const char * n, struct dentry ** d)
411{
412 return create_dir(k,k->dentry,n,d);
413}
414
415/**
416 * sysfs_create_dir - create a directory for an object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 * @kobj: object we're creating directory for.
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700418 * @shadow_parent: parent parent object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 */
420
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700421int sysfs_create_dir(struct kobject * kobj, struct dentry *shadow_parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422{
423 struct dentry * dentry = NULL;
424 struct dentry * parent;
425 int error = 0;
426
427 BUG_ON(!kobj);
428
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700429 if (shadow_parent)
430 parent = shadow_parent;
431 else if (kobj->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 parent = kobj->parent->dentry;
433 else if (sysfs_mount && sysfs_mount->mnt_sb)
434 parent = sysfs_mount->mnt_sb->s_root;
435 else
436 return -EFAULT;
437
438 error = create_dir(kobj,parent,kobject_name(kobj),&dentry);
439 if (!error)
440 kobj->dentry = dentry;
441 return error;
442}
443
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444static struct dentry * sysfs_lookup(struct inode *dir, struct dentry *dentry,
445 struct nameidata *nd)
446{
447 struct sysfs_dirent * parent_sd = dentry->d_parent->d_fsdata;
448 struct sysfs_dirent * sd;
Tejun Heofc9f54b2007-06-14 03:45:17 +0900449 struct inode *inode;
450 int found = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
Tejun Heo0c73f182007-06-14 03:45:18 +0900452 for (sd = parent_sd->s_children; sd; sd = sd->s_sibling) {
Tejun Heofc9f54b2007-06-14 03:45:17 +0900453 if ((sd->s_type & SYSFS_NOT_PINNED) &&
454 !strcmp(sd->s_name, dentry->d_name.name)) {
455 found = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 break;
457 }
458 }
459
Tejun Heofc9f54b2007-06-14 03:45:17 +0900460 /* no such entry */
461 if (!found)
462 return NULL;
463
464 /* attach dentry and inode */
Tejun Heo8312a8d2007-06-14 03:45:17 +0900465 inode = sysfs_get_inode(sd);
Tejun Heofc9f54b2007-06-14 03:45:17 +0900466 if (!inode)
467 return ERR_PTR(-ENOMEM);
468
Tejun Heo8312a8d2007-06-14 03:45:17 +0900469 if (inode->i_state & I_NEW) {
470 /* initialize inode according to type */
471 if (sd->s_type & SYSFS_KOBJ_ATTR) {
472 inode->i_size = PAGE_SIZE;
473 inode->i_fop = &sysfs_file_operations;
474 } else if (sd->s_type & SYSFS_KOBJ_BIN_ATTR) {
475 struct bin_attribute *bin_attr =
476 sd->s_elem.bin_attr.bin_attr;
477 inode->i_size = bin_attr->size;
478 inode->i_fop = &bin_fops;
479 } else if (sd->s_type & SYSFS_KOBJ_LINK)
480 inode->i_op = &sysfs_symlink_inode_operations;
481 }
Tejun Heofc9f54b2007-06-14 03:45:17 +0900482
483 sysfs_instantiate(dentry, inode);
484 sysfs_attach_dentry(sd, dentry);
485
486 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487}
488
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800489const struct inode_operations sysfs_dir_inode_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 .lookup = sysfs_lookup,
Maneesh Soni988d1862005-05-31 10:39:14 +0530491 .setattr = sysfs_setattr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492};
493
494static void remove_dir(struct dentry * d)
495{
Tejun Heodbde0fc2007-06-14 03:45:16 +0900496 struct dentry *parent = d->d_parent;
497 struct sysfs_dirent *sd = d->d_fsdata;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498
Jes Sorensen1b1dcc12006-01-09 15:59:24 -0800499 mutex_lock(&parent->d_inode->i_mutex);
Tejun Heodbde0fc2007-06-14 03:45:16 +0900500
Tejun Heo0c73f182007-06-14 03:45:18 +0900501 sysfs_unlink_sibling(sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502
503 pr_debug(" o %s removing done (%d)\n",d->d_name.name,
504 atomic_read(&d->d_count));
505
Jes Sorensen1b1dcc12006-01-09 15:59:24 -0800506 mutex_unlock(&parent->d_inode->i_mutex);
Tejun Heo0ab66082007-06-14 03:45:16 +0900507
Tejun Heodbde0fc2007-06-14 03:45:16 +0900508 sysfs_drop_dentry(sd);
Tejun Heo0ab66082007-06-14 03:45:16 +0900509 sysfs_deactivate(sd);
510 sysfs_put(sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511}
512
513void sysfs_remove_subdir(struct dentry * d)
514{
515 remove_dir(d);
516}
517
518
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700519static void __sysfs_remove_dir(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520{
Tejun Heo0c73f182007-06-14 03:45:18 +0900521 struct sysfs_dirent *removed = NULL;
522 struct sysfs_dirent *parent_sd;
523 struct sysfs_dirent **pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524
525 if (!dentry)
526 return;
527
528 pr_debug("sysfs %s: removing dir\n",dentry->d_name.name);
Jes Sorensen1b1dcc12006-01-09 15:59:24 -0800529 mutex_lock(&dentry->d_inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 parent_sd = dentry->d_fsdata;
Tejun Heo0c73f182007-06-14 03:45:18 +0900531 pos = &parent_sd->s_children;
532 while (*pos) {
533 struct sysfs_dirent *sd = *pos;
534
535 if (sd->s_type && (sd->s_type & SYSFS_NOT_PINNED)) {
536 *pos = sd->s_sibling;
537 sd->s_sibling = removed;
538 removed = sd;
539 } else
540 pos = &(*pos)->s_sibling;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 }
Jes Sorensen1b1dcc12006-01-09 15:59:24 -0800542 mutex_unlock(&dentry->d_inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
Tejun Heo0c73f182007-06-14 03:45:18 +0900544 while (removed) {
545 struct sysfs_dirent *sd = removed;
546
547 removed = sd->s_sibling;
548 sd->s_sibling = NULL;
549
Tejun Heodbde0fc2007-06-14 03:45:16 +0900550 sysfs_drop_dentry(sd);
Tejun Heo0ab66082007-06-14 03:45:16 +0900551 sysfs_deactivate(sd);
552 sysfs_put(sd);
553 }
554
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 remove_dir(dentry);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700556}
557
558/**
559 * sysfs_remove_dir - remove an object's directory.
560 * @kobj: object.
561 *
562 * The only thing special about this is that we remove any files in
563 * the directory before we remove the directory, and we've inlined
564 * what used to be sysfs_rmdir() below, instead of calling separately.
565 */
566
567void sysfs_remove_dir(struct kobject * kobj)
568{
Tejun Heoaecdced2007-06-14 03:45:15 +0900569 struct dentry *d = kobj->dentry;
570
571 spin_lock(&kobj_sysfs_assoc_lock);
Greg Kroah-Hartman641e6f32006-03-16 15:44:26 -0800572 kobj->dentry = NULL;
Tejun Heoaecdced2007-06-14 03:45:15 +0900573 spin_unlock(&kobj_sysfs_assoc_lock);
574
575 __sysfs_remove_dir(d);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576}
577
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700578int sysfs_rename_dir(struct kobject * kobj, struct dentry *new_parent,
579 const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580{
Tejun Heo0c096b52007-06-14 03:45:15 +0900581 struct sysfs_dirent *sd = kobj->dentry->d_fsdata;
582 struct sysfs_dirent *parent_sd = new_parent->d_fsdata;
583 struct dentry *new_dentry;
584 char *dup_name;
Tejun Heo996b7372007-06-14 03:45:14 +0900585 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700587 if (!new_parent)
588 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589
590 down_write(&sysfs_rename_sem);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700591 mutex_lock(&new_parent->d_inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700593 new_dentry = lookup_one_len(new_name, new_parent, strlen(new_name));
Tejun Heo996b7372007-06-14 03:45:14 +0900594 if (IS_ERR(new_dentry)) {
595 error = PTR_ERR(new_dentry);
596 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 }
Tejun Heo996b7372007-06-14 03:45:14 +0900598
599 /* By allowing two different directories with the same
600 * d_parent we allow this routine to move between different
601 * shadows of the same directory
602 */
603 error = -EINVAL;
604 if (kobj->dentry->d_parent->d_inode != new_parent->d_inode ||
605 new_dentry->d_parent->d_inode != new_parent->d_inode ||
606 new_dentry == kobj->dentry)
607 goto out_dput;
608
609 error = -EEXIST;
610 if (new_dentry->d_inode)
611 goto out_dput;
612
Tejun Heo0c096b52007-06-14 03:45:15 +0900613 /* rename kobject and sysfs_dirent */
614 error = -ENOMEM;
615 new_name = dup_name = kstrdup(new_name, GFP_KERNEL);
616 if (!new_name)
Tejun Heo996b7372007-06-14 03:45:14 +0900617 goto out_drop;
618
Tejun Heo0c096b52007-06-14 03:45:15 +0900619 error = kobject_set_name(kobj, "%s", new_name);
620 if (error)
621 goto out_free;
622
623 kfree(sd->s_name);
624 sd->s_name = new_name;
625
626 /* move under the new parent */
Tejun Heo996b7372007-06-14 03:45:14 +0900627 d_add(new_dentry, NULL);
628 d_move(kobj->dentry, new_dentry);
629
Tejun Heo0c73f182007-06-14 03:45:18 +0900630 sysfs_unlink_sibling(sd);
Tejun Heo7f7cfff2007-06-14 03:45:17 +0900631 sysfs_get(parent_sd);
632 sysfs_put(sd->s_parent);
633 sd->s_parent = parent_sd;
Tejun Heo0c73f182007-06-14 03:45:18 +0900634 sysfs_link_sibling(sd);
Tejun Heo996b7372007-06-14 03:45:14 +0900635
636 error = 0;
637 goto out_unlock;
638
Tejun Heo0c096b52007-06-14 03:45:15 +0900639 out_free:
640 kfree(dup_name);
Tejun Heo996b7372007-06-14 03:45:14 +0900641 out_drop:
642 d_drop(new_dentry);
643 out_dput:
644 dput(new_dentry);
645 out_unlock:
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700646 mutex_unlock(&new_parent->d_inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 up_write(&sysfs_rename_sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 return error;
649}
650
Cornelia Huck8a824722006-11-20 17:07:51 +0100651int sysfs_move_dir(struct kobject *kobj, struct kobject *new_parent)
652{
653 struct dentry *old_parent_dentry, *new_parent_dentry, *new_dentry;
654 struct sysfs_dirent *new_parent_sd, *sd;
655 int error;
656
Cornelia Huck8a824722006-11-20 17:07:51 +0100657 old_parent_dentry = kobj->parent ?
658 kobj->parent->dentry : sysfs_mount->mnt_sb->s_root;
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100659 new_parent_dentry = new_parent ?
660 new_parent->dentry : sysfs_mount->mnt_sb->s_root;
Cornelia Huck8a824722006-11-20 17:07:51 +0100661
Mark Lord0de15172007-03-06 01:42:03 -0800662 if (old_parent_dentry->d_inode == new_parent_dentry->d_inode)
663 return 0; /* nothing to move */
Cornelia Huck8a824722006-11-20 17:07:51 +0100664again:
665 mutex_lock(&old_parent_dentry->d_inode->i_mutex);
666 if (!mutex_trylock(&new_parent_dentry->d_inode->i_mutex)) {
667 mutex_unlock(&old_parent_dentry->d_inode->i_mutex);
668 goto again;
669 }
670
671 new_parent_sd = new_parent_dentry->d_fsdata;
672 sd = kobj->dentry->d_fsdata;
673
674 new_dentry = lookup_one_len(kobj->name, new_parent_dentry,
675 strlen(kobj->name));
676 if (IS_ERR(new_dentry)) {
677 error = PTR_ERR(new_dentry);
678 goto out;
679 } else
680 error = 0;
681 d_add(new_dentry, NULL);
682 d_move(kobj->dentry, new_dentry);
683 dput(new_dentry);
684
685 /* Remove from old parent's list and insert into new parent's list. */
Tejun Heo0c73f182007-06-14 03:45:18 +0900686 sysfs_unlink_sibling(sd);
Tejun Heo7f7cfff2007-06-14 03:45:17 +0900687 sysfs_get(new_parent_sd);
688 sysfs_put(sd->s_parent);
689 sd->s_parent = new_parent_sd;
Tejun Heo0c73f182007-06-14 03:45:18 +0900690 sysfs_link_sibling(sd);
Cornelia Huck8a824722006-11-20 17:07:51 +0100691
692out:
693 mutex_unlock(&new_parent_dentry->d_inode->i_mutex);
694 mutex_unlock(&old_parent_dentry->d_inode->i_mutex);
695
696 return error;
697}
698
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699static int sysfs_dir_open(struct inode *inode, struct file *file)
700{
Josef "Jeff" Sipekf427f5d2006-12-08 02:36:36 -0800701 struct dentry * dentry = file->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 struct sysfs_dirent * parent_sd = dentry->d_fsdata;
Tejun Heoa26cd722007-06-14 03:45:14 +0900703 struct sysfs_dirent * sd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704
Jes Sorensen1b1dcc12006-01-09 15:59:24 -0800705 mutex_lock(&dentry->d_inode->i_mutex);
Tejun Heo3e519032007-06-14 03:45:15 +0900706 sd = sysfs_new_dirent("_DIR_", 0, 0);
Tejun Heoa26cd722007-06-14 03:45:14 +0900707 if (sd)
708 sysfs_attach_dirent(sd, parent_sd, NULL);
Jes Sorensen1b1dcc12006-01-09 15:59:24 -0800709 mutex_unlock(&dentry->d_inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710
Tejun Heoa26cd722007-06-14 03:45:14 +0900711 file->private_data = sd;
712 return sd ? 0 : -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713}
714
715static int sysfs_dir_close(struct inode *inode, struct file *file)
716{
Josef "Jeff" Sipekf427f5d2006-12-08 02:36:36 -0800717 struct dentry * dentry = file->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 struct sysfs_dirent * cursor = file->private_data;
719
Jes Sorensen1b1dcc12006-01-09 15:59:24 -0800720 mutex_lock(&dentry->d_inode->i_mutex);
Tejun Heo0c73f182007-06-14 03:45:18 +0900721 sysfs_unlink_sibling(cursor);
Jes Sorensen1b1dcc12006-01-09 15:59:24 -0800722 mutex_unlock(&dentry->d_inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723
724 release_sysfs_dirent(cursor);
725
726 return 0;
727}
728
729/* Relationship between s_mode and the DT_xxx types */
730static inline unsigned char dt_type(struct sysfs_dirent *sd)
731{
732 return (sd->s_mode >> 12) & 15;
733}
734
735static int sysfs_readdir(struct file * filp, void * dirent, filldir_t filldir)
736{
Josef "Jeff" Sipekf427f5d2006-12-08 02:36:36 -0800737 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 struct sysfs_dirent * parent_sd = dentry->d_fsdata;
739 struct sysfs_dirent *cursor = filp->private_data;
Tejun Heo0c73f182007-06-14 03:45:18 +0900740 struct sysfs_dirent **pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 ino_t ino;
742 int i = filp->f_pos;
743
744 switch (i) {
745 case 0:
Eric Sandeendc351252007-06-11 14:02:45 +0900746 ino = parent_sd->s_ino;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 if (filldir(dirent, ".", 1, i, ino, DT_DIR) < 0)
748 break;
749 filp->f_pos++;
750 i++;
751 /* fallthrough */
752 case 1:
Tejun Heo13b30862007-06-14 03:45:14 +0900753 if (parent_sd->s_parent)
754 ino = parent_sd->s_parent->s_ino;
755 else
756 ino = parent_sd->s_ino;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 if (filldir(dirent, "..", 2, i, ino, DT_DIR) < 0)
758 break;
759 filp->f_pos++;
760 i++;
761 /* fallthrough */
762 default:
Tejun Heo0c73f182007-06-14 03:45:18 +0900763 pos = &parent_sd->s_children;
764 while (*pos != cursor)
765 pos = &(*pos)->s_sibling;
Akinobu Mita1bfba4e2006-06-26 00:24:40 -0700766
Tejun Heo0c73f182007-06-14 03:45:18 +0900767 /* unlink cursor */
768 *pos = cursor->s_sibling;
769
770 if (filp->f_pos == 2)
771 pos = &parent_sd->s_children;
772
773 for ( ; *pos; pos = &(*pos)->s_sibling) {
774 struct sysfs_dirent *next = *pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 const char * name;
776 int len;
777
Tejun Heo3e519032007-06-14 03:45:15 +0900778 if (!next->s_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 continue;
780
Tejun Heo0c096b52007-06-14 03:45:15 +0900781 name = next->s_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 len = strlen(name);
Eric Sandeendc351252007-06-11 14:02:45 +0900783 ino = next->s_ino;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784
785 if (filldir(dirent, name, len, filp->f_pos, ino,
786 dt_type(next)) < 0)
Tejun Heo0c73f182007-06-14 03:45:18 +0900787 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 filp->f_pos++;
790 }
Tejun Heo0c73f182007-06-14 03:45:18 +0900791
792 /* put cursor back in */
793 cursor->s_sibling = *pos;
794 *pos = cursor;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 }
796 return 0;
797}
798
799static loff_t sysfs_dir_lseek(struct file * file, loff_t offset, int origin)
800{
Josef "Jeff" Sipekf427f5d2006-12-08 02:36:36 -0800801 struct dentry * dentry = file->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
Jes Sorensen1b1dcc12006-01-09 15:59:24 -0800803 mutex_lock(&dentry->d_inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 switch (origin) {
805 case 1:
806 offset += file->f_pos;
807 case 0:
808 if (offset >= 0)
809 break;
810 default:
Josef "Jeff" Sipekf427f5d2006-12-08 02:36:36 -0800811 mutex_unlock(&file->f_path.dentry->d_inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 return -EINVAL;
813 }
814 if (offset != file->f_pos) {
815 file->f_pos = offset;
816 if (file->f_pos >= 2) {
817 struct sysfs_dirent *sd = dentry->d_fsdata;
818 struct sysfs_dirent *cursor = file->private_data;
Tejun Heo0c73f182007-06-14 03:45:18 +0900819 struct sysfs_dirent **pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 loff_t n = file->f_pos - 2;
821
Tejun Heo0c73f182007-06-14 03:45:18 +0900822 sysfs_unlink_sibling(cursor);
823
824 pos = &sd->s_children;
825 while (n && *pos) {
826 struct sysfs_dirent *next = *pos;
Tejun Heo3e519032007-06-14 03:45:15 +0900827 if (next->s_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 n--;
Tejun Heo0c73f182007-06-14 03:45:18 +0900829 pos = &(*pos)->s_sibling;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 }
Tejun Heo0c73f182007-06-14 03:45:18 +0900831
832 cursor->s_sibling = *pos;
833 *pos = cursor;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 }
835 }
Jes Sorensen1b1dcc12006-01-09 15:59:24 -0800836 mutex_unlock(&dentry->d_inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 return offset;
838}
839
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700840
841/**
842 * sysfs_make_shadowed_dir - Setup so a directory can be shadowed
843 * @kobj: object we're creating shadow of.
844 */
845
846int sysfs_make_shadowed_dir(struct kobject *kobj,
847 void * (*follow_link)(struct dentry *, struct nameidata *))
848{
849 struct inode *inode;
850 struct inode_operations *i_op;
851
852 inode = kobj->dentry->d_inode;
853 if (inode->i_op != &sysfs_dir_inode_operations)
854 return -EINVAL;
855
856 i_op = kmalloc(sizeof(*i_op), GFP_KERNEL);
857 if (!i_op)
858 return -ENOMEM;
859
860 memcpy(i_op, &sysfs_dir_inode_operations, sizeof(*i_op));
861 i_op->follow_link = follow_link;
862
863 /* Locking of inode->i_op?
864 * Since setting i_op is a single word write and they
865 * are atomic we should be ok here.
866 */
867 inode->i_op = i_op;
868 return 0;
869}
870
871/**
872 * sysfs_create_shadow_dir - create a shadow directory for an object.
873 * @kobj: object we're creating directory for.
874 *
875 * sysfs_make_shadowed_dir must already have been called on this
876 * directory.
877 */
878
879struct dentry *sysfs_create_shadow_dir(struct kobject *kobj)
880{
Tejun Heo13b30862007-06-14 03:45:14 +0900881 struct dentry *dir = kobj->dentry;
882 struct inode *inode = dir->d_inode;
883 struct dentry *parent = dir->d_parent;
884 struct sysfs_dirent *parent_sd = parent->d_fsdata;
885 struct dentry *shadow;
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700886 struct sysfs_dirent *sd;
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700887
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700888 shadow = ERR_PTR(-EINVAL);
889 if (!sysfs_is_shadowed_inode(inode))
890 goto out;
891
892 shadow = d_alloc(parent, &dir->d_name);
893 if (!shadow)
894 goto nomem;
895
Tejun Heo3e519032007-06-14 03:45:15 +0900896 sd = sysfs_new_dirent("_SHADOW_", inode->i_mode, SYSFS_DIR);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700897 if (!sd)
898 goto nomem;
Tejun Heo3e519032007-06-14 03:45:15 +0900899 sd->s_elem.dir.kobj = kobj;
Tejun Heo13b30862007-06-14 03:45:14 +0900900 /* point to parent_sd but don't attach to it */
901 sd->s_parent = sysfs_get(parent_sd);
Tejun Heoa26cd722007-06-14 03:45:14 +0900902 sysfs_attach_dirent(sd, NULL, shadow);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700903
904 d_instantiate(shadow, igrab(inode));
905 inc_nlink(inode);
906 inc_nlink(parent->d_inode);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700907
908 dget(shadow); /* Extra count - pin the dentry in core */
909
910out:
911 return shadow;
912nomem:
913 dput(shadow);
914 shadow = ERR_PTR(-ENOMEM);
915 goto out;
916}
917
918/**
919 * sysfs_remove_shadow_dir - remove an object's directory.
920 * @shadow: dentry of shadow directory
921 *
922 * The only thing special about this is that we remove any files in
923 * the directory before we remove the directory, and we've inlined
924 * what used to be sysfs_rmdir() below, instead of calling separately.
925 */
926
927void sysfs_remove_shadow_dir(struct dentry *shadow)
928{
929 __sysfs_remove_dir(shadow);
930}
931
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800932const struct file_operations sysfs_dir_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 .open = sysfs_dir_open,
934 .release = sysfs_dir_close,
935 .llseek = sysfs_dir_lseek,
936 .read = generic_read_dir,
937 .readdir = sysfs_readdir,
938};