blob: dd3779cf3a3b52325208a00ae4704360945d19fc [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Tejun Heo6d66f5c2007-09-20 17:31:38 +09002 * fs/sysfs/dir.c - sysfs core and dir operation implementation
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 * Please see Documentation/filesystems/sysfs.txt for more information.
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 */
12
13#undef DEBUG
14
15#include <linux/fs.h>
16#include <linux/mount.h>
17#include <linux/module.h>
18#include <linux/kobject.h>
Christoph Hellwig5f45f1a2005-06-23 00:09:12 -070019#include <linux/namei.h>
Tejun Heo2b611bb2007-06-14 03:45:13 +090020#include <linux/idr.h>
Tejun Heo8619f972007-06-14 03:45:18 +090021#include <linux/completion.h>
Dave Young869512a2007-07-26 14:53:53 +000022#include <linux/mutex.h>
Robert P. J. Dayc6f87732008-03-13 22:41:52 -040023#include <linux/slab.h>
Eric W. Biederman4c3da222009-11-04 02:50:06 -080024#include <linux/security.h>
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -080025#include <linux/hash.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include "sysfs.h"
27
Tejun Heo3007e992007-06-14 04:27:23 +090028DEFINE_MUTEX(sysfs_mutex);
Roel Kluinf7a75f02007-10-16 23:30:25 -070029DEFINE_SPINLOCK(sysfs_assoc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -080031#define to_sysfs_dirent(X) rb_entry((X), struct sysfs_dirent, s_rb);
32
Roel Kluinf7a75f02007-10-16 23:30:25 -070033static DEFINE_SPINLOCK(sysfs_ino_lock);
Tejun Heo2b611bb2007-06-14 03:45:13 +090034static DEFINE_IDA(sysfs_ino_ida);
35
Tejun Heob6b4a432007-06-14 03:45:18 +090036/**
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -080037 * sysfs_name_hash
38 * @ns: Namespace tag to hash
39 * @name: Null terminated string to hash
40 *
41 * Returns 31 bit hash of ns + name (so it fits in an off_t )
42 */
43static unsigned int sysfs_name_hash(const void *ns, const char *name)
44{
45 unsigned long hash = init_name_hash();
46 unsigned int len = strlen(name);
47 while (len--)
48 hash = partial_name_hash(*name++, hash);
49 hash = ( end_name_hash(hash) ^ hash_ptr( (void *)ns, 31 ) );
50 hash &= 0x7fffffffU;
51 /* Reserve hash numbers 0, 1 and INT_MAX for magic directory entries */
52 if (hash < 1)
53 hash += 2;
54 if (hash >= INT_MAX)
55 hash = INT_MAX - 1;
56 return hash;
57}
58
59static int sysfs_name_compare(unsigned int hash, const void *ns,
60 const char *name, const struct sysfs_dirent *sd)
61{
62 if (hash != sd->s_hash)
63 return hash - sd->s_hash;
64 if (ns != sd->s_ns)
65 return ns - sd->s_ns;
66 return strcmp(name, sd->s_name);
67}
68
69static int sysfs_sd_compare(const struct sysfs_dirent *left,
70 const struct sysfs_dirent *right)
71{
72 return sysfs_name_compare(left->s_hash, left->s_ns, left->s_name,
73 right);
74}
75
76/**
77 * sysfs_link_subling - link sysfs_dirent into sibling rbtree
Tejun Heo0c73f182007-06-14 03:45:18 +090078 * @sd: sysfs_dirent of interest
79 *
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -080080 * Link @sd into its sibling rbtree which starts from
Tejun Heobc747f32007-09-20 16:05:12 +090081 * sd->s_parent->s_dir.children.
Tejun Heo0c73f182007-06-14 03:45:18 +090082 *
83 * Locking:
Tejun Heo3007e992007-06-14 04:27:23 +090084 * mutex_lock(sysfs_mutex)
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -080085 *
86 * RETURNS:
87 * 0 on susccess -EEXIST on failure.
Tejun Heo0c73f182007-06-14 03:45:18 +090088 */
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -080089static int sysfs_link_sibling(struct sysfs_dirent *sd)
Tejun Heo0c73f182007-06-14 03:45:18 +090090{
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -080091 struct rb_node **node = &sd->s_parent->s_dir.children.rb_node;
92 struct rb_node *parent = NULL;
Mikulas Patocka4f72c0c2011-07-25 17:55:57 -040093
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -080094 while (*node) {
95 struct sysfs_dirent *pos;
96 int result;
Mikulas Patocka4f72c0c2011-07-25 17:55:57 -040097
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -080098 pos = to_sysfs_dirent(*node);
99 parent = *node;
100 result = sysfs_sd_compare(sd, pos);
101 if (result < 0)
102 node = &pos->s_rb.rb_left;
103 else if (result > 0)
104 node = &pos->s_rb.rb_right;
105 else
106 return -EEXIST;
Mikulas Patocka4f72c0c2011-07-25 17:55:57 -0400107 }
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800108 /* add new node and rebalance the tree */
109 rb_link_node(&sd->s_rb, parent, node);
110 rb_insert_color(&sd->s_rb, &sd->s_parent->s_dir.children);
111 return 0;
Tejun Heo0c73f182007-06-14 03:45:18 +0900112}
113
114/**
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800115 * sysfs_unlink_sibling - unlink sysfs_dirent from sibling rbtree
Tejun Heo0c73f182007-06-14 03:45:18 +0900116 * @sd: sysfs_dirent of interest
117 *
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800118 * Unlink @sd from its sibling rbtree which starts from
Tejun Heobc747f32007-09-20 16:05:12 +0900119 * sd->s_parent->s_dir.children.
Tejun Heo0c73f182007-06-14 03:45:18 +0900120 *
121 * Locking:
Tejun Heo3007e992007-06-14 04:27:23 +0900122 * mutex_lock(sysfs_mutex)
Tejun Heo0c73f182007-06-14 03:45:18 +0900123 */
Tejun Heo41fc1c22007-08-02 21:38:03 +0900124static void sysfs_unlink_sibling(struct sysfs_dirent *sd)
Tejun Heo0c73f182007-06-14 03:45:18 +0900125{
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800126 rb_erase(&sd->s_rb, &sd->s_parent->s_dir.children);
Tejun Heo0c73f182007-06-14 03:45:18 +0900127}
128
129/**
Tejun Heob6b4a432007-06-14 03:45:18 +0900130 * sysfs_get_active - get an active reference to sysfs_dirent
131 * @sd: sysfs_dirent to get an active reference to
132 *
133 * Get an active reference of @sd. This function is noop if @sd
134 * is NULL.
135 *
136 * RETURNS:
137 * Pointer to @sd on success, NULL on failure.
138 */
Eric W. Biedermane72ceb82010-02-11 15:18:38 -0800139struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd)
Tejun Heob6b4a432007-06-14 03:45:18 +0900140{
Tejun Heo8619f972007-06-14 03:45:18 +0900141 if (unlikely(!sd))
142 return NULL;
143
144 while (1) {
145 int v, t;
146
147 v = atomic_read(&sd->s_active);
148 if (unlikely(v < 0))
149 return NULL;
150
151 t = atomic_cmpxchg(&sd->s_active, v, v + 1);
Eric W. Biederman846f9972010-01-02 13:37:12 -0800152 if (likely(t == v)) {
153 rwsem_acquire_read(&sd->dep_map, 0, 1, _RET_IP_);
Tejun Heo8619f972007-06-14 03:45:18 +0900154 return sd;
Eric W. Biederman846f9972010-01-02 13:37:12 -0800155 }
Tejun Heo8619f972007-06-14 03:45:18 +0900156 if (t < 0)
157 return NULL;
158
159 cpu_relax();
Tejun Heob6b4a432007-06-14 03:45:18 +0900160 }
Tejun Heob6b4a432007-06-14 03:45:18 +0900161}
162
163/**
164 * sysfs_put_active - put an active reference to sysfs_dirent
165 * @sd: sysfs_dirent to put an active reference to
166 *
167 * Put an active reference to @sd. This function is noop if @sd
168 * is NULL.
169 */
Eric W. Biedermane72ceb82010-02-11 15:18:38 -0800170void sysfs_put_active(struct sysfs_dirent *sd)
Tejun Heob6b4a432007-06-14 03:45:18 +0900171{
Tejun Heo8619f972007-06-14 03:45:18 +0900172 int v;
173
174 if (unlikely(!sd))
175 return;
176
Eric W. Biederman846f9972010-01-02 13:37:12 -0800177 rwsem_release(&sd->dep_map, 1, _RET_IP_);
Tejun Heo8619f972007-06-14 03:45:18 +0900178 v = atomic_dec_return(&sd->s_active);
179 if (likely(v != SD_DEACTIVATED_BIAS))
180 return;
181
182 /* atomic_dec_return() is a mb(), we'll always see the updated
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400183 * sd->u.completion.
Tejun Heo8619f972007-06-14 03:45:18 +0900184 */
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400185 complete(sd->u.completion);
Tejun Heob6b4a432007-06-14 03:45:18 +0900186}
187
188/**
Tejun Heob6b4a432007-06-14 03:45:18 +0900189 * sysfs_deactivate - deactivate sysfs_dirent
190 * @sd: sysfs_dirent to deactivate
191 *
Tejun Heo8619f972007-06-14 03:45:18 +0900192 * Deny new active references and drain existing ones.
Tejun Heob6b4a432007-06-14 03:45:18 +0900193 */
Tejun Heofb6896d2007-06-14 04:27:24 +0900194static void sysfs_deactivate(struct sysfs_dirent *sd)
Tejun Heob6b4a432007-06-14 03:45:18 +0900195{
Tejun Heo8619f972007-06-14 03:45:18 +0900196 DECLARE_COMPLETION_ONSTACK(wait);
197 int v;
Tejun Heob6b4a432007-06-14 03:45:18 +0900198
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400199 BUG_ON(!(sd->s_flags & SYSFS_FLAG_REMOVED));
Eric W. Biedermana2db6842010-02-11 15:20:00 -0800200
201 if (!(sysfs_type(sd) & SYSFS_ACTIVE_REF))
202 return;
203
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400204 sd->u.completion = (void *)&wait;
Tejun Heo8619f972007-06-14 03:45:18 +0900205
Eric W. Biederman846f9972010-01-02 13:37:12 -0800206 rwsem_acquire(&sd->dep_map, 0, 0, _RET_IP_);
Tejun Heo8619f972007-06-14 03:45:18 +0900207 /* atomic_add_return() is a mb(), put_active() will always see
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400208 * the updated sd->u.completion.
Tejun Heob6b4a432007-06-14 03:45:18 +0900209 */
Tejun Heo8619f972007-06-14 03:45:18 +0900210 v = atomic_add_return(SD_DEACTIVATED_BIAS, &sd->s_active);
211
Eric W. Biederman846f9972010-01-02 13:37:12 -0800212 if (v != SD_DEACTIVATED_BIAS) {
213 lock_contended(&sd->dep_map, _RET_IP_);
Tejun Heo8619f972007-06-14 03:45:18 +0900214 wait_for_completion(&wait);
Eric W. Biederman846f9972010-01-02 13:37:12 -0800215 }
Tejun Heo8619f972007-06-14 03:45:18 +0900216
Eric W. Biederman846f9972010-01-02 13:37:12 -0800217 lock_acquired(&sd->dep_map, _RET_IP_);
218 rwsem_release(&sd->dep_map, 1, _RET_IP_);
Tejun Heob6b4a432007-06-14 03:45:18 +0900219}
220
Eric W. Biedermancafa6b52011-12-18 20:08:16 -0800221static int sysfs_alloc_ino(unsigned int *pino)
Tejun Heo2b611bb2007-06-14 03:45:13 +0900222{
223 int ino, rc;
224
225 retry:
226 spin_lock(&sysfs_ino_lock);
227 rc = ida_get_new_above(&sysfs_ino_ida, 2, &ino);
228 spin_unlock(&sysfs_ino_lock);
229
230 if (rc == -EAGAIN) {
231 if (ida_pre_get(&sysfs_ino_ida, GFP_KERNEL))
232 goto retry;
233 rc = -ENOMEM;
234 }
235
236 *pino = ino;
237 return rc;
238}
239
Eric W. Biedermancafa6b52011-12-18 20:08:16 -0800240static void sysfs_free_ino(unsigned int ino)
Tejun Heo2b611bb2007-06-14 03:45:13 +0900241{
242 spin_lock(&sysfs_ino_lock);
243 ida_remove(&sysfs_ino_ida, ino);
244 spin_unlock(&sysfs_ino_lock);
245}
246
Tejun Heofa7f9122007-06-14 03:45:13 +0900247void release_sysfs_dirent(struct sysfs_dirent * sd)
248{
Tejun Heo13b30862007-06-14 03:45:14 +0900249 struct sysfs_dirent *parent_sd;
250
251 repeat:
Tejun Heo3007e992007-06-14 04:27:23 +0900252 /* Moving/renaming is always done while holding reference.
253 * sd->s_parent won't change beneath us.
254 */
Tejun Heo13b30862007-06-14 03:45:14 +0900255 parent_sd = sd->s_parent;
256
Tejun Heob402d722007-06-14 04:27:21 +0900257 if (sysfs_type(sd) == SYSFS_KOBJ_LINK)
Tejun Heob1fc3d62007-09-20 16:05:11 +0900258 sysfs_put(sd->s_symlink.target_sd);
Tejun Heob402d722007-06-14 04:27:21 +0900259 if (sysfs_type(sd) & SYSFS_COPY_NAME)
Tejun Heo0c096b52007-06-14 03:45:15 +0900260 kfree(sd->s_name);
Eric W. Biederman4c3da222009-11-04 02:50:06 -0800261 if (sd->s_iattr && sd->s_iattr->ia_secdata)
262 security_release_secctx(sd->s_iattr->ia_secdata,
263 sd->s_iattr->ia_secdata_len);
Tejun Heofa7f9122007-06-14 03:45:13 +0900264 kfree(sd->s_iattr);
Tejun Heo2b611bb2007-06-14 03:45:13 +0900265 sysfs_free_ino(sd->s_ino);
Tejun Heofa7f9122007-06-14 03:45:13 +0900266 kmem_cache_free(sysfs_dir_cachep, sd);
Tejun Heo13b30862007-06-14 03:45:14 +0900267
268 sd = parent_sd;
269 if (sd && atomic_dec_and_test(&sd->s_count))
270 goto repeat;
Tejun Heofa7f9122007-06-14 03:45:13 +0900271}
272
Nick Pigginfe15ce42011-01-07 17:49:23 +1100273static int sysfs_dentry_delete(const struct dentry *dentry)
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800274{
275 struct sysfs_dirent *sd = dentry->d_fsdata;
276 return !!(sd->s_flags & SYSFS_FLAG_REMOVED);
277}
278
279static int sysfs_dentry_revalidate(struct dentry *dentry, struct nameidata *nd)
280{
Nick Piggin34286d62011-01-07 17:49:57 +1100281 struct sysfs_dirent *sd;
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800282 int is_dir;
283
Nick Piggin34286d62011-01-07 17:49:57 +1100284 if (nd->flags & LOOKUP_RCU)
285 return -ECHILD;
286
287 sd = dentry->d_fsdata;
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800288 mutex_lock(&sysfs_mutex);
289
290 /* The sysfs dirent has been deleted */
291 if (sd->s_flags & SYSFS_FLAG_REMOVED)
292 goto out_bad;
293
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800294 /* The sysfs dirent has been moved? */
295 if (dentry->d_parent->d_fsdata != sd->s_parent)
296 goto out_bad;
297
298 /* The sysfs dirent has been renamed */
299 if (strcmp(dentry->d_name.name, sd->s_name) != 0)
300 goto out_bad;
301
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800302 mutex_unlock(&sysfs_mutex);
303out_valid:
304 return 1;
305out_bad:
306 /* Remove the dentry from the dcache hashes.
307 * If this is a deleted dentry we use d_drop instead of d_delete
308 * so sysfs doesn't need to cope with negative dentries.
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800309 *
310 * If this is a dentry that has simply been renamed we
311 * use d_drop to remove it from the dcache lookup on its
312 * old parent. If this dentry persists later when a lookup
313 * is performed at its new name the dentry will be readded
314 * to the dcache hashes.
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800315 */
316 is_dir = (sysfs_type(sd) == SYSFS_DIR);
317 mutex_unlock(&sysfs_mutex);
318 if (is_dir) {
319 /* If we have submounts we must allow the vfs caches
320 * to lie about the state of the filesystem to prevent
321 * leaks and other nasty things.
322 */
323 if (have_submounts(dentry))
324 goto out_valid;
325 shrink_dcache_parent(dentry);
326 }
327 d_drop(dentry);
328 return 0;
329}
330
Eric W. Biederman28a027c2009-11-07 23:27:00 -0800331static void sysfs_dentry_iput(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332{
333 struct sysfs_dirent * sd = dentry->d_fsdata;
334
Eric W. Biederman5a26b792007-08-20 21:36:30 +0900335 sysfs_put(sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 iput(inode);
337}
338
Al Viroee1ec322009-02-20 06:01:46 +0000339static const struct dentry_operations sysfs_dentry_ops = {
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800340 .d_revalidate = sysfs_dentry_revalidate,
341 .d_delete = sysfs_dentry_delete,
Eric W. Biederman28a027c2009-11-07 23:27:00 -0800342 .d_iput = sysfs_dentry_iput,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343};
344
Tejun Heo3e519032007-06-14 03:45:15 +0900345struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346{
Tejun Heo0c096b52007-06-14 03:45:15 +0900347 char *dup_name = NULL;
Akinobu Mita01da2422007-07-14 11:03:35 +0900348 struct sysfs_dirent *sd;
Tejun Heo0c096b52007-06-14 03:45:15 +0900349
350 if (type & SYSFS_COPY_NAME) {
351 name = dup_name = kstrdup(name, GFP_KERNEL);
352 if (!name)
Akinobu Mita01da2422007-07-14 11:03:35 +0900353 return NULL;
Tejun Heo0c096b52007-06-14 03:45:15 +0900354 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355
Robert P. J. Dayc3762222007-02-10 01:45:03 -0800356 sd = kmem_cache_zalloc(sysfs_dir_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 if (!sd)
Akinobu Mita01da2422007-07-14 11:03:35 +0900358 goto err_out1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359
Tejun Heo0c096b52007-06-14 03:45:15 +0900360 if (sysfs_alloc_ino(&sd->s_ino))
Akinobu Mita01da2422007-07-14 11:03:35 +0900361 goto err_out2;
Tejun Heo2b611bb2007-06-14 03:45:13 +0900362
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 atomic_set(&sd->s_count, 1);
Tejun Heo8619f972007-06-14 03:45:18 +0900364 atomic_set(&sd->s_active, 0);
Tejun Heoa26cd722007-06-14 03:45:14 +0900365
Tejun Heo0c096b52007-06-14 03:45:15 +0900366 sd->s_name = name;
Tejun Heoa26cd722007-06-14 03:45:14 +0900367 sd->s_mode = mode;
Tejun Heob402d722007-06-14 04:27:21 +0900368 sd->s_flags = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
370 return sd;
Tejun Heo0c096b52007-06-14 03:45:15 +0900371
Akinobu Mita01da2422007-07-14 11:03:35 +0900372 err_out2:
Tejun Heo0c096b52007-06-14 03:45:15 +0900373 kmem_cache_free(sysfs_dir_cachep, sd);
Akinobu Mita01da2422007-07-14 11:03:35 +0900374 err_out1:
375 kfree(dup_name);
Tejun Heo0c096b52007-06-14 03:45:15 +0900376 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377}
378
Tejun Heo3007e992007-06-14 04:27:23 +0900379/**
Tejun Heofb6896d2007-06-14 04:27:24 +0900380 * sysfs_addrm_start - prepare for sysfs_dirent add/remove
381 * @acxt: pointer to sysfs_addrm_cxt to be used
382 * @parent_sd: parent sysfs_dirent
Tejun Heo3007e992007-06-14 04:27:23 +0900383 *
Tejun Heofb6896d2007-06-14 04:27:24 +0900384 * This function is called when the caller is about to add or
385 * remove sysfs_dirent under @parent_sd. This function acquires
Eric W. Biedermana16bbc32009-11-20 16:08:55 -0800386 * sysfs_mutex. @acxt is used to keep and pass context to
Tejun Heofb6896d2007-06-14 04:27:24 +0900387 * other addrm functions.
Tejun Heo3007e992007-06-14 04:27:23 +0900388 *
389 * LOCKING:
Tejun Heofb6896d2007-06-14 04:27:24 +0900390 * Kernel thread context (may sleep). sysfs_mutex is locked on
Eric W. Biedermana16bbc32009-11-20 16:08:55 -0800391 * return.
Tejun Heo3007e992007-06-14 04:27:23 +0900392 */
Tejun Heofb6896d2007-06-14 04:27:24 +0900393void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
394 struct sysfs_dirent *parent_sd)
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700395{
Tejun Heofb6896d2007-06-14 04:27:24 +0900396 memset(acxt, 0, sizeof(*acxt));
397 acxt->parent_sd = parent_sd;
398
Tejun Heofb6896d2007-06-14 04:27:24 +0900399 mutex_lock(&sysfs_mutex);
Tejun Heofb6896d2007-06-14 04:27:24 +0900400}
401
402/**
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200403 * __sysfs_add_one - add sysfs_dirent to parent without warning
404 * @acxt: addrm context to use
405 * @sd: sysfs_dirent to be added
406 *
407 * Get @acxt->parent_sd and set sd->s_parent to it and increment
408 * nlink of parent inode if @sd is a directory and link into the
409 * children list of the parent.
410 *
411 * This function should be called between calls to
412 * sysfs_addrm_start() and sysfs_addrm_finish() and should be
413 * passed the same @acxt as passed to sysfs_addrm_start().
414 *
415 * LOCKING:
416 * Determined by sysfs_addrm_start().
417 *
418 * RETURNS:
419 * 0 on success, -EEXIST if entry with the given name already
420 * exists.
421 */
422int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
423{
Eric W. Biederman6b0bfe92009-11-20 16:08:51 -0800424 struct sysfs_inode_attrs *ps_iattr;
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800425 int ret;
Eric W. Biederman6b0bfe92009-11-20 16:08:51 -0800426
Eric W. Biederman903e21e2011-10-12 22:02:43 +0000427 if (!!sysfs_ns_type(acxt->parent_sd) != !!sd->s_ns) {
428 WARN(1, KERN_WARNING "sysfs: ns %s in '%s' for '%s'\n",
429 sysfs_ns_type(acxt->parent_sd)? "required": "invalid",
430 acxt->parent_sd->s_name, sd->s_name);
431 return -EINVAL;
432 }
433
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800434 sd->s_hash = sysfs_name_hash(sd->s_ns, sd->s_name);
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200435 sd->s_parent = sysfs_get(acxt->parent_sd);
436
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800437 ret = sysfs_link_sibling(sd);
438 if (ret)
439 return ret;
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200440
Eric W. Biederman6b0bfe92009-11-20 16:08:51 -0800441 /* Update timestamps on the parent */
442 ps_iattr = acxt->parent_sd->s_iattr;
443 if (ps_iattr) {
444 struct iattr *ps_iattrs = &ps_iattr->ia_iattr;
445 ps_iattrs->ia_ctime = ps_iattrs->ia_mtime = CURRENT_TIME;
446 }
447
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200448 return 0;
449}
450
451/**
Alex Chiang425cb022009-02-12 10:56:59 -0700452 * sysfs_pathname - return full path to sysfs dirent
453 * @sd: sysfs_dirent whose path we want
454 * @path: caller allocated buffer
455 *
456 * Gives the name "/" to the sysfs_root entry; any path returned
457 * is relative to wherever sysfs is mounted.
458 *
459 * XXX: does no error checking on @path size
460 */
461static char *sysfs_pathname(struct sysfs_dirent *sd, char *path)
462{
463 if (sd->s_parent) {
464 sysfs_pathname(sd->s_parent, path);
465 strcat(path, "/");
466 }
467 strcat(path, sd->s_name);
468 return path;
469}
470
471/**
Tejun Heofb6896d2007-06-14 04:27:24 +0900472 * sysfs_add_one - add sysfs_dirent to parent
473 * @acxt: addrm context to use
474 * @sd: sysfs_dirent to be added
475 *
476 * Get @acxt->parent_sd and set sd->s_parent to it and increment
Tejun Heo181b2e42007-09-20 16:05:09 +0900477 * nlink of parent inode if @sd is a directory and link into the
478 * children list of the parent.
Tejun Heofb6896d2007-06-14 04:27:24 +0900479 *
480 * This function should be called between calls to
481 * sysfs_addrm_start() and sysfs_addrm_finish() and should be
482 * passed the same @acxt as passed to sysfs_addrm_start().
483 *
484 * LOCKING:
485 * Determined by sysfs_addrm_start().
Tejun Heo23dc2792007-08-02 21:38:03 +0900486 *
487 * RETURNS:
488 * 0 on success, -EEXIST if entry with the given name already
489 * exists.
Tejun Heofb6896d2007-06-14 04:27:24 +0900490 */
Tejun Heo23dc2792007-08-02 21:38:03 +0900491int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
Tejun Heofb6896d2007-06-14 04:27:24 +0900492{
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200493 int ret;
Tejun Heo23dc2792007-08-02 21:38:03 +0900494
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200495 ret = __sysfs_add_one(acxt, sd);
Alex Chiang425cb022009-02-12 10:56:59 -0700496 if (ret == -EEXIST) {
497 char *path = kzalloc(PATH_MAX, GFP_KERNEL);
498 WARN(1, KERN_WARNING
499 "sysfs: cannot create duplicate filename '%s'\n",
500 (path == NULL) ? sd->s_name :
501 strcat(strcat(sysfs_pathname(acxt->parent_sd, path), "/"),
502 sd->s_name));
503 kfree(path);
504 }
505
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200506 return ret;
Tejun Heofb6896d2007-06-14 04:27:24 +0900507}
508
509/**
510 * sysfs_remove_one - remove sysfs_dirent from parent
511 * @acxt: addrm context to use
Jean Delvare9fd5b1c2008-01-08 18:11:24 +0100512 * @sd: sysfs_dirent to be removed
Tejun Heofb6896d2007-06-14 04:27:24 +0900513 *
514 * Mark @sd removed and drop nlink of parent inode if @sd is a
Tejun Heo181b2e42007-09-20 16:05:09 +0900515 * directory. @sd is unlinked from the children list.
Tejun Heofb6896d2007-06-14 04:27:24 +0900516 *
517 * This function should be called between calls to
518 * sysfs_addrm_start() and sysfs_addrm_finish() and should be
519 * passed the same @acxt as passed to sysfs_addrm_start().
520 *
521 * LOCKING:
522 * Determined by sysfs_addrm_start().
523 */
524void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
525{
Eric W. Biederman6b0bfe92009-11-20 16:08:51 -0800526 struct sysfs_inode_attrs *ps_iattr;
527
Tejun Heo41fc1c22007-08-02 21:38:03 +0900528 BUG_ON(sd->s_flags & SYSFS_FLAG_REMOVED);
529
530 sysfs_unlink_sibling(sd);
Tejun Heofb6896d2007-06-14 04:27:24 +0900531
Eric W. Biederman6b0bfe92009-11-20 16:08:51 -0800532 /* Update timestamps on the parent */
533 ps_iattr = acxt->parent_sd->s_iattr;
534 if (ps_iattr) {
535 struct iattr *ps_iattrs = &ps_iattr->ia_iattr;
536 ps_iattrs->ia_ctime = ps_iattrs->ia_mtime = CURRENT_TIME;
537 }
538
Tejun Heofb6896d2007-06-14 04:27:24 +0900539 sd->s_flags |= SYSFS_FLAG_REMOVED;
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400540 sd->u.removed_list = acxt->removed;
Tejun Heofb6896d2007-06-14 04:27:24 +0900541 acxt->removed = sd;
Tejun Heoa0edd7c2007-06-14 04:27:24 +0900542}
543
544/**
Tejun Heofb6896d2007-06-14 04:27:24 +0900545 * sysfs_addrm_finish - finish up sysfs_dirent add/remove
546 * @acxt: addrm context to finish up
547 *
548 * Finish up sysfs_dirent add/remove. Resources acquired by
549 * sysfs_addrm_start() are released and removed sysfs_dirents are
Eric W. Biedermana16bbc32009-11-20 16:08:55 -0800550 * cleaned up.
Tejun Heofb6896d2007-06-14 04:27:24 +0900551 *
552 * LOCKING:
Eric W. Biedermana16bbc32009-11-20 16:08:55 -0800553 * sysfs_mutex is released.
Tejun Heofb6896d2007-06-14 04:27:24 +0900554 */
Tejun Heo990e53f2007-08-02 21:38:03 +0900555void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt)
Tejun Heofb6896d2007-06-14 04:27:24 +0900556{
557 /* release resources acquired by sysfs_addrm_start() */
558 mutex_unlock(&sysfs_mutex);
Tejun Heofb6896d2007-06-14 04:27:24 +0900559
560 /* kill removed sysfs_dirents */
561 while (acxt->removed) {
562 struct sysfs_dirent *sd = acxt->removed;
563
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400564 acxt->removed = sd->u.removed_list;
Tejun Heofb6896d2007-06-14 04:27:24 +0900565
Tejun Heofb6896d2007-06-14 04:27:24 +0900566 sysfs_deactivate(sd);
Eric W. Biedermane0edd3c2009-03-04 11:57:20 -0800567 unmap_bin_file(sd);
Tejun Heofb6896d2007-06-14 04:27:24 +0900568 sysfs_put(sd);
569 }
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700570}
571
Tejun Heof0b0af42007-06-14 04:27:22 +0900572/**
573 * sysfs_find_dirent - find sysfs_dirent with the given name
574 * @parent_sd: sysfs_dirent to search under
575 * @name: name to look for
Maneesh Sonic5168652006-03-09 19:40:14 +0530576 *
Tejun Heof0b0af42007-06-14 04:27:22 +0900577 * Look for sysfs_dirent with name @name under @parent_sd.
Maneesh Sonic5168652006-03-09 19:40:14 +0530578 *
Tejun Heof0b0af42007-06-14 04:27:22 +0900579 * LOCKING:
Tejun Heo3007e992007-06-14 04:27:23 +0900580 * mutex_lock(sysfs_mutex)
Tejun Heof0b0af42007-06-14 04:27:22 +0900581 *
582 * RETURNS:
583 * Pointer to sysfs_dirent if found, NULL if not.
Maneesh Sonic5168652006-03-09 19:40:14 +0530584 */
Tejun Heof0b0af42007-06-14 04:27:22 +0900585struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700586 const void *ns,
Tejun Heof0b0af42007-06-14 04:27:22 +0900587 const unsigned char *name)
Maneesh Sonic5168652006-03-09 19:40:14 +0530588{
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800589 struct rb_node *node = parent_sd->s_dir.children.rb_node;
590 unsigned int hash;
Maneesh Sonic5168652006-03-09 19:40:14 +0530591
Eric W. Biederman903e21e2011-10-12 22:02:43 +0000592 if (!!sysfs_ns_type(parent_sd) != !!ns) {
593 WARN(1, KERN_WARNING "sysfs: ns %s in '%s' for '%s'\n",
594 sysfs_ns_type(parent_sd)? "required": "invalid",
595 parent_sd->s_name, name);
596 return NULL;
597 }
598
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800599 hash = sysfs_name_hash(ns, name);
600 while (node) {
601 struct sysfs_dirent *sd;
602 int result;
Mikulas Patocka4f72c0c2011-07-25 17:55:57 -0400603
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800604 sd = to_sysfs_dirent(node);
605 result = sysfs_name_compare(hash, ns, name, sd);
606 if (result < 0)
607 node = node->rb_left;
608 else if (result > 0)
609 node = node->rb_right;
610 else
611 return sd;
Mikulas Patocka4f72c0c2011-07-25 17:55:57 -0400612 }
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800613 return NULL;
Tejun Heof0b0af42007-06-14 04:27:22 +0900614}
Maneesh Sonic5168652006-03-09 19:40:14 +0530615
Tejun Heof0b0af42007-06-14 04:27:22 +0900616/**
617 * sysfs_get_dirent - find and get sysfs_dirent with the given name
618 * @parent_sd: sysfs_dirent to search under
619 * @name: name to look for
620 *
621 * Look for sysfs_dirent with name @name under @parent_sd and get
622 * it if found.
623 *
624 * LOCKING:
Tejun Heo3007e992007-06-14 04:27:23 +0900625 * Kernel thread context (may sleep). Grabs sysfs_mutex.
Tejun Heof0b0af42007-06-14 04:27:22 +0900626 *
627 * RETURNS:
628 * Pointer to sysfs_dirent if found, NULL if not.
629 */
630struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700631 const void *ns,
Tejun Heof0b0af42007-06-14 04:27:22 +0900632 const unsigned char *name)
633{
634 struct sysfs_dirent *sd;
635
Tejun Heo3007e992007-06-14 04:27:23 +0900636 mutex_lock(&sysfs_mutex);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700637 sd = sysfs_find_dirent(parent_sd, ns, name);
Tejun Heof0b0af42007-06-14 04:27:22 +0900638 sysfs_get(sd);
Tejun Heo3007e992007-06-14 04:27:23 +0900639 mutex_unlock(&sysfs_mutex);
Tejun Heof0b0af42007-06-14 04:27:22 +0900640
641 return sd;
Maneesh Sonic5168652006-03-09 19:40:14 +0530642}
Neil Brownf1282c82008-07-16 08:58:04 +1000643EXPORT_SYMBOL_GPL(sysfs_get_dirent);
Maneesh Sonic5168652006-03-09 19:40:14 +0530644
Tejun Heo608e2662007-06-14 04:27:22 +0900645static int create_dir(struct kobject *kobj, struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700646 enum kobj_ns_type type, const void *ns, const char *name,
647 struct sysfs_dirent **p_sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 umode_t mode = S_IFDIR| S_IRWXU | S_IRUGO | S_IXUGO;
Tejun Heo51225032007-06-14 04:27:25 +0900650 struct sysfs_addrm_cxt acxt;
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900651 struct sysfs_dirent *sd;
Tejun Heo23dc2792007-08-02 21:38:03 +0900652 int rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
Tejun Heofc9f54b2007-06-14 03:45:17 +0900654 /* allocate */
Tejun Heo3e519032007-06-14 03:45:15 +0900655 sd = sysfs_new_dirent(name, mode, SYSFS_DIR);
Tejun Heoa26cd722007-06-14 03:45:14 +0900656 if (!sd)
Tejun Heo51225032007-06-14 04:27:25 +0900657 return -ENOMEM;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700658
659 sd->s_flags |= (type << SYSFS_NS_TYPE_SHIFT);
660 sd->s_ns = ns;
Tejun Heob1fc3d62007-09-20 16:05:11 +0900661 sd->s_dir.kobj = kobj;
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900662
Tejun Heo51225032007-06-14 04:27:25 +0900663 /* link in */
664 sysfs_addrm_start(&acxt, parent_sd);
Tejun Heo23dc2792007-08-02 21:38:03 +0900665 rc = sysfs_add_one(&acxt, sd);
666 sysfs_addrm_finish(&acxt);
Tejun Heo967e35d2007-07-18 16:38:11 +0900667
Tejun Heo23dc2792007-08-02 21:38:03 +0900668 if (rc == 0)
669 *p_sd = sd;
670 else
Tejun Heo967e35d2007-07-18 16:38:11 +0900671 sysfs_put(sd);
Tejun Heofc9f54b2007-06-14 03:45:17 +0900672
Tejun Heo23dc2792007-08-02 21:38:03 +0900673 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674}
675
Tejun Heo608e2662007-06-14 04:27:22 +0900676int sysfs_create_subdir(struct kobject *kobj, const char *name,
677 struct sysfs_dirent **p_sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678{
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700679 return create_dir(kobj, kobj->sd,
680 KOBJ_NS_TYPE_NONE, NULL, name, p_sd);
681}
682
Serge E. Hallynbe867b12010-05-03 16:23:15 -0500683/**
684 * sysfs_read_ns_type: return associated ns_type
685 * @kobj: the kobject being queried
686 *
687 * Each kobject can be tagged with exactly one namespace type
688 * (i.e. network or user). Return the ns_type associated with
689 * this object if any
690 */
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700691static enum kobj_ns_type sysfs_read_ns_type(struct kobject *kobj)
692{
693 const struct kobj_ns_type_operations *ops;
694 enum kobj_ns_type type;
695
696 ops = kobj_child_ns_ops(kobj);
697 if (!ops)
698 return KOBJ_NS_TYPE_NONE;
699
700 type = ops->type;
701 BUG_ON(type <= KOBJ_NS_TYPE_NONE);
702 BUG_ON(type >= KOBJ_NS_TYPES);
703 BUG_ON(!kobj_ns_type_registered(type));
704
705 return type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706}
707
708/**
709 * sysfs_create_dir - create a directory for an object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 * @kobj: object we're creating directory for.
711 */
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900712int sysfs_create_dir(struct kobject * kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713{
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700714 enum kobj_ns_type type;
Tejun Heo608e2662007-06-14 04:27:22 +0900715 struct sysfs_dirent *parent_sd, *sd;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700716 const void *ns = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 int error = 0;
718
719 BUG_ON(!kobj);
720
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900721 if (kobj->parent)
Tejun Heo608e2662007-06-14 04:27:22 +0900722 parent_sd = kobj->parent->sd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 else
Eric W. Biederman7d0c7d62007-08-20 21:36:30 +0900724 parent_sd = &sysfs_root;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700726 if (sysfs_ns_type(parent_sd))
727 ns = kobj->ktype->namespace(kobj);
728 type = sysfs_read_ns_type(kobj);
729
730 error = create_dir(kobj, parent_sd, type, ns, kobject_name(kobj), &sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 if (!error)
Tejun Heo608e2662007-06-14 04:27:22 +0900732 kobj->sd = sd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 return error;
734}
735
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736static struct dentry * sysfs_lookup(struct inode *dir, struct dentry *dentry,
737 struct nameidata *nd)
738{
Tejun Heo6cb52142007-07-31 19:15:08 +0900739 struct dentry *ret = NULL;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700740 struct dentry *parent = dentry->d_parent;
741 struct sysfs_dirent *parent_sd = parent->d_fsdata;
Tejun Heoa7a04752007-08-02 21:38:02 +0900742 struct sysfs_dirent *sd;
Tejun Heofc9f54b2007-06-14 03:45:17 +0900743 struct inode *inode;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700744 enum kobj_ns_type type;
745 const void *ns;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746
Tejun Heo6cb52142007-07-31 19:15:08 +0900747 mutex_lock(&sysfs_mutex);
748
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700749 type = sysfs_ns_type(parent_sd);
750 ns = sysfs_info(dir->i_sb)->ns[type];
751
752 sd = sysfs_find_dirent(parent_sd, ns, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753
Tejun Heofc9f54b2007-06-14 03:45:17 +0900754 /* no such entry */
Tejun Heoe49452c2008-01-16 12:06:14 +0900755 if (!sd) {
756 ret = ERR_PTR(-ENOENT);
Tejun Heo6cb52142007-07-31 19:15:08 +0900757 goto out_unlock;
Tejun Heoe49452c2008-01-16 12:06:14 +0900758 }
Tejun Heofc9f54b2007-06-14 03:45:17 +0900759
760 /* attach dentry and inode */
Eric W. Biedermanfac26222010-02-12 19:22:27 -0800761 inode = sysfs_get_inode(dir->i_sb, sd);
Tejun Heo6cb52142007-07-31 19:15:08 +0900762 if (!inode) {
763 ret = ERR_PTR(-ENOMEM);
764 goto out_unlock;
765 }
Tejun Heo3007e992007-06-14 04:27:23 +0900766
Tejun Heod6b4fd22007-09-20 16:05:11 +0900767 /* instantiate and hash dentry */
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800768 ret = d_find_alias(inode);
769 if (!ret) {
Nick Pigginfb045ad2011-01-07 17:49:55 +1100770 d_set_d_op(dentry, &sysfs_dentry_ops);
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800771 dentry->d_fsdata = sysfs_get(sd);
772 d_add(dentry, inode);
773 } else {
774 d_move(ret, dentry);
775 iput(inode);
776 }
Tejun Heofc9f54b2007-06-14 03:45:17 +0900777
Tejun Heo6cb52142007-07-31 19:15:08 +0900778 out_unlock:
Tejun Heo3007e992007-06-14 04:27:23 +0900779 mutex_unlock(&sysfs_mutex);
Tejun Heo6cb52142007-07-31 19:15:08 +0900780 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781}
782
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800783const struct inode_operations sysfs_dir_inode_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 .lookup = sysfs_lookup,
Eric W. Biedermane61ab4a2009-11-20 16:08:53 -0800785 .permission = sysfs_permission,
Maneesh Soni988d1862005-05-31 10:39:14 +0530786 .setattr = sysfs_setattr,
Eric W. Biedermane61ab4a2009-11-20 16:08:53 -0800787 .getattr = sysfs_getattr,
David P. Quigleyddd29ec2009-09-09 14:25:37 -0400788 .setxattr = sysfs_setxattr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789};
790
Tejun Heo608e2662007-06-14 04:27:22 +0900791static void remove_dir(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792{
Tejun Heofb6896d2007-06-14 04:27:24 +0900793 struct sysfs_addrm_cxt acxt;
794
795 sysfs_addrm_start(&acxt, sd->s_parent);
Tejun Heofb6896d2007-06-14 04:27:24 +0900796 sysfs_remove_one(&acxt, sd);
797 sysfs_addrm_finish(&acxt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798}
799
Tejun Heo608e2662007-06-14 04:27:22 +0900800void sysfs_remove_subdir(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801{
Tejun Heo608e2662007-06-14 04:27:22 +0900802 remove_dir(sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803}
804
805
Tejun Heo608e2662007-06-14 04:27:22 +0900806static void __sysfs_remove_dir(struct sysfs_dirent *dir_sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807{
Tejun Heofb6896d2007-06-14 04:27:24 +0900808 struct sysfs_addrm_cxt acxt;
Mikulas Patockaa406f752011-07-25 17:57:03 -0400809 struct rb_node *pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810
Tejun Heo608e2662007-06-14 04:27:22 +0900811 if (!dir_sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 return;
813
Tejun Heo608e2662007-06-14 04:27:22 +0900814 pr_debug("sysfs %s: removing dir\n", dir_sd->s_name);
Tejun Heofb6896d2007-06-14 04:27:24 +0900815 sysfs_addrm_start(&acxt, dir_sd);
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800816 pos = rb_first(&dir_sd->s_dir.children);
Mikulas Patockaa406f752011-07-25 17:57:03 -0400817 while (pos) {
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800818 struct sysfs_dirent *sd = to_sysfs_dirent(pos);
Mikulas Patockaa406f752011-07-25 17:57:03 -0400819 pos = rb_next(pos);
Eric W. Biederman3efa65b2007-08-20 21:36:30 +0900820 if (sysfs_type(sd) != SYSFS_DIR)
Tejun Heofb6896d2007-06-14 04:27:24 +0900821 sysfs_remove_one(&acxt, sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 }
Tejun Heofb6896d2007-06-14 04:27:24 +0900823 sysfs_addrm_finish(&acxt);
Tejun Heo0ab66082007-06-14 03:45:16 +0900824
Tejun Heo608e2662007-06-14 04:27:22 +0900825 remove_dir(dir_sd);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700826}
827
828/**
829 * sysfs_remove_dir - remove an object's directory.
830 * @kobj: object.
831 *
832 * The only thing special about this is that we remove any files in
833 * the directory before we remove the directory, and we've inlined
834 * what used to be sysfs_rmdir() below, instead of calling separately.
835 */
836
837void sysfs_remove_dir(struct kobject * kobj)
838{
Tejun Heo608e2662007-06-14 04:27:22 +0900839 struct sysfs_dirent *sd = kobj->sd;
Tejun Heoaecdced2007-06-14 03:45:15 +0900840
Tejun Heo5f995322007-06-14 04:27:23 +0900841 spin_lock(&sysfs_assoc_lock);
Tejun Heo608e2662007-06-14 04:27:22 +0900842 kobj->sd = NULL;
Tejun Heo5f995322007-06-14 04:27:23 +0900843 spin_unlock(&sysfs_assoc_lock);
Tejun Heoaecdced2007-06-14 03:45:15 +0900844
Tejun Heo608e2662007-06-14 04:27:22 +0900845 __sysfs_remove_dir(sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846}
847
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800848int sysfs_rename(struct sysfs_dirent *sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700849 struct sysfs_dirent *new_parent_sd, const void *new_ns,
850 const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851{
Tejun Heo51225032007-06-14 04:27:25 +0900852 const char *dup_name = NULL;
Tejun Heo996b7372007-06-14 03:45:14 +0900853 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800855 mutex_lock(&sysfs_mutex);
Eric W. Biederman932ea2e2007-08-20 21:36:30 +0900856
Eric W. Biederman9918f9a2007-08-20 21:36:31 +0900857 error = 0;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700858 if ((sd->s_parent == new_parent_sd) && (sd->s_ns == new_ns) &&
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800859 (strcmp(sd->s_name, new_name) == 0))
Eric W. Biederman9918f9a2007-08-20 21:36:31 +0900860 goto out; /* nothing to rename */
861
Tejun Heo996b7372007-06-14 03:45:14 +0900862 error = -EEXIST;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700863 if (sysfs_find_dirent(new_parent_sd, new_ns, new_name))
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800864 goto out;
Tejun Heo996b7372007-06-14 03:45:14 +0900865
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700866 /* rename sysfs_dirent */
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800867 if (strcmp(sd->s_name, new_name) != 0) {
868 error = -ENOMEM;
869 new_name = dup_name = kstrdup(new_name, GFP_KERNEL);
870 if (!new_name)
871 goto out;
Tejun Heo996b7372007-06-14 03:45:14 +0900872
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800873 dup_name = sd->s_name;
874 sd->s_name = new_name;
Eric W. Biedermand5c38b12012-01-31 06:40:26 -0800875 sd->s_hash = sysfs_name_hash(sd->s_ns, sd->s_name);
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800876 }
877
Eric W. Biedermanf6d90b42011-11-01 07:06:17 -0700878 /* Move to the appropriate place in the appropriate directories rbtree. */
879 sysfs_unlink_sibling(sd);
880 sysfs_get(new_parent_sd);
881 sysfs_put(sd->s_parent);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700882 sd->s_ns = new_ns;
Eric W. Biedermanf6d90b42011-11-01 07:06:17 -0700883 sd->s_parent = new_parent_sd;
884 sysfs_link_sibling(sd);
Tejun Heo0c096b52007-06-14 03:45:15 +0900885
Tejun Heo996b7372007-06-14 03:45:14 +0900886 error = 0;
Eric W. Biederman9918f9a2007-08-20 21:36:31 +0900887 out:
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800888 mutex_unlock(&sysfs_mutex);
889 kfree(dup_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 return error;
891}
892
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800893int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
894{
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700895 struct sysfs_dirent *parent_sd = kobj->sd->s_parent;
896 const void *new_ns = NULL;
897
898 if (sysfs_ns_type(parent_sd))
899 new_ns = kobj->ktype->namespace(kobj);
900
901 return sysfs_rename(kobj->sd, parent_sd, new_ns, new_name);
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800902}
903
Tejun Heo51225032007-06-14 04:27:25 +0900904int sysfs_move_dir(struct kobject *kobj, struct kobject *new_parent_kobj)
Cornelia Huck8a824722006-11-20 17:07:51 +0100905{
Tejun Heo51225032007-06-14 04:27:25 +0900906 struct sysfs_dirent *sd = kobj->sd;
907 struct sysfs_dirent *new_parent_sd;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700908 const void *new_ns = NULL;
Cornelia Huck8a824722006-11-20 17:07:51 +0100909
Tejun Heo51225032007-06-14 04:27:25 +0900910 BUG_ON(!sd->s_parent);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700911 if (sysfs_ns_type(sd->s_parent))
912 new_ns = kobj->ktype->namespace(kobj);
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800913 new_parent_sd = new_parent_kobj && new_parent_kobj->sd ?
Cornelia Hucka6a83572009-10-06 15:33:35 +0200914 new_parent_kobj->sd : &sysfs_root;
Cornelia Huck8a824722006-11-20 17:07:51 +0100915
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700916 return sysfs_rename(sd, new_parent_sd, new_ns, sd->s_name);
Cornelia Huck8a824722006-11-20 17:07:51 +0100917}
918
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919/* Relationship between s_mode and the DT_xxx types */
920static inline unsigned char dt_type(struct sysfs_dirent *sd)
921{
922 return (sd->s_mode >> 12) & 15;
923}
924
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800925static int sysfs_dir_release(struct inode *inode, struct file *filp)
926{
927 sysfs_put(filp->private_data);
928 return 0;
929}
930
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700931static struct sysfs_dirent *sysfs_dir_pos(const void *ns,
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800932 struct sysfs_dirent *parent_sd, loff_t hash, struct sysfs_dirent *pos)
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800933{
934 if (pos) {
935 int valid = !(pos->s_flags & SYSFS_FLAG_REMOVED) &&
936 pos->s_parent == parent_sd &&
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800937 hash == pos->s_hash;
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800938 sysfs_put(pos);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700939 if (!valid)
940 pos = NULL;
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800941 }
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800942 if (!pos && (hash > 1) && (hash < INT_MAX)) {
943 struct rb_node *node = parent_sd->s_dir.children.rb_node;
944 while (node) {
945 pos = to_sysfs_dirent(node);
946
947 if (hash < pos->s_hash)
948 node = node->rb_left;
949 else if (hash > pos->s_hash)
950 node = node->rb_right;
951 else
Mikulas Patockaa406f752011-07-25 17:57:03 -0400952 break;
Mikulas Patockaa406f752011-07-25 17:57:03 -0400953 }
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800954 }
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800955 /* Skip over entries in the wrong namespace */
Eric W. Biedermanb9e27802011-10-25 05:38:41 -0700956 while (pos && pos->s_ns != ns) {
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800957 struct rb_node *node = rb_next(&pos->s_rb);
958 if (!node)
Mikulas Patockaa406f752011-07-25 17:57:03 -0400959 pos = NULL;
960 else
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800961 pos = to_sysfs_dirent(node);
Mikulas Patockaa406f752011-07-25 17:57:03 -0400962 }
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800963 return pos;
964}
965
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700966static struct sysfs_dirent *sysfs_dir_next_pos(const void *ns,
967 struct sysfs_dirent *parent_sd, ino_t ino, struct sysfs_dirent *pos)
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800968{
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700969 pos = sysfs_dir_pos(ns, parent_sd, ino, pos);
Mikulas Patockaa406f752011-07-25 17:57:03 -0400970 if (pos) do {
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800971 struct rb_node *node = rb_next(&pos->s_rb);
972 if (!node)
Mikulas Patockaa406f752011-07-25 17:57:03 -0400973 pos = NULL;
974 else
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800975 pos = to_sysfs_dirent(node);
Eric W. Biedermanb9e27802011-10-25 05:38:41 -0700976 } while (pos && pos->s_ns != ns);
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800977 return pos;
978}
979
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980static int sysfs_readdir(struct file * filp, void * dirent, filldir_t filldir)
981{
Josef "Jeff" Sipekf427f5d2006-12-08 02:36:36 -0800982 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 struct sysfs_dirent * parent_sd = dentry->d_fsdata;
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800984 struct sysfs_dirent *pos = filp->private_data;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700985 enum kobj_ns_type type;
986 const void *ns;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 ino_t ino;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700989 type = sysfs_ns_type(parent_sd);
990 ns = sysfs_info(dentry->d_sb)->ns[type];
991
Eric W. Biederman3efa65b2007-08-20 21:36:30 +0900992 if (filp->f_pos == 0) {
993 ino = parent_sd->s_ino;
994 if (filldir(dirent, ".", 1, filp->f_pos, ino, DT_DIR) == 0)
995 filp->f_pos++;
996 }
997 if (filp->f_pos == 1) {
998 if (parent_sd->s_parent)
999 ino = parent_sd->s_parent->s_ino;
1000 else
Eric Sandeendc351252007-06-11 14:02:45 +09001001 ino = parent_sd->s_ino;
Eric W. Biederman3efa65b2007-08-20 21:36:30 +09001002 if (filldir(dirent, "..", 2, filp->f_pos, ino, DT_DIR) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 filp->f_pos++;
Eric W. Biederman3efa65b2007-08-20 21:36:30 +09001004 }
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001005 mutex_lock(&sysfs_mutex);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -07001006 for (pos = sysfs_dir_pos(ns, parent_sd, filp->f_pos, pos);
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001007 pos;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -07001008 pos = sysfs_dir_next_pos(ns, parent_sd, filp->f_pos, pos)) {
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001009 const char * name;
1010 unsigned int type;
1011 int len, ret;
Eric W. Biederman3efa65b2007-08-20 21:36:30 +09001012
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001013 name = pos->s_name;
1014 len = strlen(name);
1015 ino = pos->s_ino;
1016 type = dt_type(pos);
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -08001017 filp->f_pos = pos->s_hash;
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001018 filp->private_data = sysfs_get(pos);
Eric W. Biederman3efa65b2007-08-20 21:36:30 +09001019
Eric W. Biederman3efa65b2007-08-20 21:36:30 +09001020 mutex_unlock(&sysfs_mutex);
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001021 ret = filldir(dirent, name, len, filp->f_pos, ino, type);
1022 mutex_lock(&sysfs_mutex);
1023 if (ret < 0)
1024 break;
1025 }
1026 mutex_unlock(&sysfs_mutex);
1027 if ((filp->f_pos > 1) && !pos) { /* EOF */
1028 filp->f_pos = INT_MAX;
1029 filp->private_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 }
1031 return 0;
1032}
1033
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08001035const struct file_operations sysfs_dir_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 .read = generic_read_dir,
1037 .readdir = sysfs_readdir,
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001038 .release = sysfs_dir_release,
Christoph Hellwig3222a3e2008-09-03 21:53:01 +02001039 .llseek = generic_file_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040};