blob: 35a36d39fa2cb2af62616918872706794a20d8e1 [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
Greg Kroah-Hartman54d20f02012-03-08 13:03:10 -080094 if (sysfs_type(sd) == SYSFS_DIR)
95 sd->s_parent->s_dir.subdirs++;
96
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -080097 while (*node) {
98 struct sysfs_dirent *pos;
99 int result;
Mikulas Patocka4f72c0c2011-07-25 17:55:57 -0400100
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800101 pos = to_sysfs_dirent(*node);
102 parent = *node;
103 result = sysfs_sd_compare(sd, pos);
104 if (result < 0)
105 node = &pos->s_rb.rb_left;
106 else if (result > 0)
107 node = &pos->s_rb.rb_right;
108 else
109 return -EEXIST;
Mikulas Patocka4f72c0c2011-07-25 17:55:57 -0400110 }
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800111 /* add new node and rebalance the tree */
112 rb_link_node(&sd->s_rb, parent, node);
113 rb_insert_color(&sd->s_rb, &sd->s_parent->s_dir.children);
114 return 0;
Tejun Heo0c73f182007-06-14 03:45:18 +0900115}
116
117/**
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800118 * sysfs_unlink_sibling - unlink sysfs_dirent from sibling rbtree
Tejun Heo0c73f182007-06-14 03:45:18 +0900119 * @sd: sysfs_dirent of interest
120 *
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800121 * Unlink @sd from its sibling rbtree which starts from
Tejun Heobc747f32007-09-20 16:05:12 +0900122 * sd->s_parent->s_dir.children.
Tejun Heo0c73f182007-06-14 03:45:18 +0900123 *
124 * Locking:
Tejun Heo3007e992007-06-14 04:27:23 +0900125 * mutex_lock(sysfs_mutex)
Tejun Heo0c73f182007-06-14 03:45:18 +0900126 */
Tejun Heo41fc1c22007-08-02 21:38:03 +0900127static void sysfs_unlink_sibling(struct sysfs_dirent *sd)
Tejun Heo0c73f182007-06-14 03:45:18 +0900128{
Greg Kroah-Hartman54d20f02012-03-08 13:03:10 -0800129 if (sysfs_type(sd) == SYSFS_DIR)
130 sd->s_parent->s_dir.subdirs--;
131
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800132 rb_erase(&sd->s_rb, &sd->s_parent->s_dir.children);
Tejun Heo0c73f182007-06-14 03:45:18 +0900133}
134
135/**
Tejun Heob6b4a432007-06-14 03:45:18 +0900136 * sysfs_get_active - get an active reference to sysfs_dirent
137 * @sd: sysfs_dirent to get an active reference to
138 *
139 * Get an active reference of @sd. This function is noop if @sd
140 * is NULL.
141 *
142 * RETURNS:
143 * Pointer to @sd on success, NULL on failure.
144 */
Eric W. Biedermane72ceb82010-02-11 15:18:38 -0800145struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd)
Tejun Heob6b4a432007-06-14 03:45:18 +0900146{
Tejun Heo8619f972007-06-14 03:45:18 +0900147 if (unlikely(!sd))
148 return NULL;
149
150 while (1) {
151 int v, t;
152
153 v = atomic_read(&sd->s_active);
154 if (unlikely(v < 0))
155 return NULL;
156
157 t = atomic_cmpxchg(&sd->s_active, v, v + 1);
Eric W. Biederman846f9972010-01-02 13:37:12 -0800158 if (likely(t == v)) {
159 rwsem_acquire_read(&sd->dep_map, 0, 1, _RET_IP_);
Tejun Heo8619f972007-06-14 03:45:18 +0900160 return sd;
Eric W. Biederman846f9972010-01-02 13:37:12 -0800161 }
Tejun Heo8619f972007-06-14 03:45:18 +0900162 if (t < 0)
163 return NULL;
164
165 cpu_relax();
Tejun Heob6b4a432007-06-14 03:45:18 +0900166 }
Tejun Heob6b4a432007-06-14 03:45:18 +0900167}
168
169/**
170 * sysfs_put_active - put an active reference to sysfs_dirent
171 * @sd: sysfs_dirent to put an active reference to
172 *
173 * Put an active reference to @sd. This function is noop if @sd
174 * is NULL.
175 */
Eric W. Biedermane72ceb82010-02-11 15:18:38 -0800176void sysfs_put_active(struct sysfs_dirent *sd)
Tejun Heob6b4a432007-06-14 03:45:18 +0900177{
Tejun Heo8619f972007-06-14 03:45:18 +0900178 int v;
179
180 if (unlikely(!sd))
181 return;
182
Eric W. Biederman846f9972010-01-02 13:37:12 -0800183 rwsem_release(&sd->dep_map, 1, _RET_IP_);
Tejun Heo8619f972007-06-14 03:45:18 +0900184 v = atomic_dec_return(&sd->s_active);
185 if (likely(v != SD_DEACTIVATED_BIAS))
186 return;
187
188 /* atomic_dec_return() is a mb(), we'll always see the updated
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400189 * sd->u.completion.
Tejun Heo8619f972007-06-14 03:45:18 +0900190 */
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400191 complete(sd->u.completion);
Tejun Heob6b4a432007-06-14 03:45:18 +0900192}
193
194/**
Tejun Heob6b4a432007-06-14 03:45:18 +0900195 * sysfs_deactivate - deactivate sysfs_dirent
196 * @sd: sysfs_dirent to deactivate
197 *
Tejun Heo8619f972007-06-14 03:45:18 +0900198 * Deny new active references and drain existing ones.
Tejun Heob6b4a432007-06-14 03:45:18 +0900199 */
Tejun Heofb6896d2007-06-14 04:27:24 +0900200static void sysfs_deactivate(struct sysfs_dirent *sd)
Tejun Heob6b4a432007-06-14 03:45:18 +0900201{
Tejun Heo8619f972007-06-14 03:45:18 +0900202 DECLARE_COMPLETION_ONSTACK(wait);
203 int v;
Tejun Heob6b4a432007-06-14 03:45:18 +0900204
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400205 BUG_ON(!(sd->s_flags & SYSFS_FLAG_REMOVED));
Eric W. Biedermana2db6842010-02-11 15:20:00 -0800206
207 if (!(sysfs_type(sd) & SYSFS_ACTIVE_REF))
208 return;
209
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400210 sd->u.completion = (void *)&wait;
Tejun Heo8619f972007-06-14 03:45:18 +0900211
Eric W. Biederman846f9972010-01-02 13:37:12 -0800212 rwsem_acquire(&sd->dep_map, 0, 0, _RET_IP_);
Tejun Heo8619f972007-06-14 03:45:18 +0900213 /* atomic_add_return() is a mb(), put_active() will always see
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400214 * the updated sd->u.completion.
Tejun Heob6b4a432007-06-14 03:45:18 +0900215 */
Tejun Heo8619f972007-06-14 03:45:18 +0900216 v = atomic_add_return(SD_DEACTIVATED_BIAS, &sd->s_active);
217
Eric W. Biederman846f9972010-01-02 13:37:12 -0800218 if (v != SD_DEACTIVATED_BIAS) {
219 lock_contended(&sd->dep_map, _RET_IP_);
Tejun Heo8619f972007-06-14 03:45:18 +0900220 wait_for_completion(&wait);
Eric W. Biederman846f9972010-01-02 13:37:12 -0800221 }
Tejun Heo8619f972007-06-14 03:45:18 +0900222
Eric W. Biederman846f9972010-01-02 13:37:12 -0800223 lock_acquired(&sd->dep_map, _RET_IP_);
224 rwsem_release(&sd->dep_map, 1, _RET_IP_);
Tejun Heob6b4a432007-06-14 03:45:18 +0900225}
226
Eric W. Biedermancafa6b52011-12-18 20:08:16 -0800227static int sysfs_alloc_ino(unsigned int *pino)
Tejun Heo2b611bb2007-06-14 03:45:13 +0900228{
229 int ino, rc;
230
231 retry:
232 spin_lock(&sysfs_ino_lock);
233 rc = ida_get_new_above(&sysfs_ino_ida, 2, &ino);
234 spin_unlock(&sysfs_ino_lock);
235
236 if (rc == -EAGAIN) {
237 if (ida_pre_get(&sysfs_ino_ida, GFP_KERNEL))
238 goto retry;
239 rc = -ENOMEM;
240 }
241
242 *pino = ino;
243 return rc;
244}
245
Eric W. Biedermancafa6b52011-12-18 20:08:16 -0800246static void sysfs_free_ino(unsigned int ino)
Tejun Heo2b611bb2007-06-14 03:45:13 +0900247{
248 spin_lock(&sysfs_ino_lock);
249 ida_remove(&sysfs_ino_ida, ino);
250 spin_unlock(&sysfs_ino_lock);
251}
252
Tejun Heofa7f9122007-06-14 03:45:13 +0900253void release_sysfs_dirent(struct sysfs_dirent * sd)
254{
Tejun Heo13b30862007-06-14 03:45:14 +0900255 struct sysfs_dirent *parent_sd;
256
257 repeat:
Tejun Heo3007e992007-06-14 04:27:23 +0900258 /* Moving/renaming is always done while holding reference.
259 * sd->s_parent won't change beneath us.
260 */
Tejun Heo13b30862007-06-14 03:45:14 +0900261 parent_sd = sd->s_parent;
262
Tejun Heob402d722007-06-14 04:27:21 +0900263 if (sysfs_type(sd) == SYSFS_KOBJ_LINK)
Tejun Heob1fc3d62007-09-20 16:05:11 +0900264 sysfs_put(sd->s_symlink.target_sd);
Tejun Heob402d722007-06-14 04:27:21 +0900265 if (sysfs_type(sd) & SYSFS_COPY_NAME)
Tejun Heo0c096b52007-06-14 03:45:15 +0900266 kfree(sd->s_name);
Eric W. Biederman4c3da222009-11-04 02:50:06 -0800267 if (sd->s_iattr && sd->s_iattr->ia_secdata)
268 security_release_secctx(sd->s_iattr->ia_secdata,
269 sd->s_iattr->ia_secdata_len);
Tejun Heofa7f9122007-06-14 03:45:13 +0900270 kfree(sd->s_iattr);
Tejun Heo2b611bb2007-06-14 03:45:13 +0900271 sysfs_free_ino(sd->s_ino);
Tejun Heofa7f9122007-06-14 03:45:13 +0900272 kmem_cache_free(sysfs_dir_cachep, sd);
Tejun Heo13b30862007-06-14 03:45:14 +0900273
274 sd = parent_sd;
275 if (sd && atomic_dec_and_test(&sd->s_count))
276 goto repeat;
Tejun Heofa7f9122007-06-14 03:45:13 +0900277}
278
Nick Pigginfe15ce42011-01-07 17:49:23 +1100279static int sysfs_dentry_delete(const struct dentry *dentry)
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800280{
281 struct sysfs_dirent *sd = dentry->d_fsdata;
282 return !!(sd->s_flags & SYSFS_FLAG_REMOVED);
283}
284
285static int sysfs_dentry_revalidate(struct dentry *dentry, struct nameidata *nd)
286{
Nick Piggin34286d62011-01-07 17:49:57 +1100287 struct sysfs_dirent *sd;
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800288 int is_dir;
289
Nick Piggin34286d62011-01-07 17:49:57 +1100290 if (nd->flags & LOOKUP_RCU)
291 return -ECHILD;
292
293 sd = dentry->d_fsdata;
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800294 mutex_lock(&sysfs_mutex);
295
296 /* The sysfs dirent has been deleted */
297 if (sd->s_flags & SYSFS_FLAG_REMOVED)
298 goto out_bad;
299
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800300 /* The sysfs dirent has been moved? */
301 if (dentry->d_parent->d_fsdata != sd->s_parent)
302 goto out_bad;
303
304 /* The sysfs dirent has been renamed */
305 if (strcmp(dentry->d_name.name, sd->s_name) != 0)
306 goto out_bad;
307
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800308 mutex_unlock(&sysfs_mutex);
309out_valid:
310 return 1;
311out_bad:
312 /* Remove the dentry from the dcache hashes.
313 * If this is a deleted dentry we use d_drop instead of d_delete
314 * so sysfs doesn't need to cope with negative dentries.
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800315 *
316 * If this is a dentry that has simply been renamed we
317 * use d_drop to remove it from the dcache lookup on its
318 * old parent. If this dentry persists later when a lookup
319 * is performed at its new name the dentry will be readded
320 * to the dcache hashes.
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800321 */
322 is_dir = (sysfs_type(sd) == SYSFS_DIR);
323 mutex_unlock(&sysfs_mutex);
324 if (is_dir) {
325 /* If we have submounts we must allow the vfs caches
326 * to lie about the state of the filesystem to prevent
327 * leaks and other nasty things.
328 */
329 if (have_submounts(dentry))
330 goto out_valid;
331 shrink_dcache_parent(dentry);
332 }
333 d_drop(dentry);
334 return 0;
335}
336
Eric W. Biederman28a027c2009-11-07 23:27:00 -0800337static void sysfs_dentry_iput(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338{
339 struct sysfs_dirent * sd = dentry->d_fsdata;
340
Eric W. Biederman5a26b792007-08-20 21:36:30 +0900341 sysfs_put(sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 iput(inode);
343}
344
Al Viroee1ec322009-02-20 06:01:46 +0000345static const struct dentry_operations sysfs_dentry_ops = {
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800346 .d_revalidate = sysfs_dentry_revalidate,
347 .d_delete = sysfs_dentry_delete,
Eric W. Biederman28a027c2009-11-07 23:27:00 -0800348 .d_iput = sysfs_dentry_iput,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349};
350
Tejun Heo3e519032007-06-14 03:45:15 +0900351struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352{
Tejun Heo0c096b52007-06-14 03:45:15 +0900353 char *dup_name = NULL;
Akinobu Mita01da2422007-07-14 11:03:35 +0900354 struct sysfs_dirent *sd;
Tejun Heo0c096b52007-06-14 03:45:15 +0900355
356 if (type & SYSFS_COPY_NAME) {
357 name = dup_name = kstrdup(name, GFP_KERNEL);
358 if (!name)
Akinobu Mita01da2422007-07-14 11:03:35 +0900359 return NULL;
Tejun Heo0c096b52007-06-14 03:45:15 +0900360 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
Robert P. J. Dayc3762222007-02-10 01:45:03 -0800362 sd = kmem_cache_zalloc(sysfs_dir_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 if (!sd)
Akinobu Mita01da2422007-07-14 11:03:35 +0900364 goto err_out1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365
Tejun Heo0c096b52007-06-14 03:45:15 +0900366 if (sysfs_alloc_ino(&sd->s_ino))
Akinobu Mita01da2422007-07-14 11:03:35 +0900367 goto err_out2;
Tejun Heo2b611bb2007-06-14 03:45:13 +0900368
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 atomic_set(&sd->s_count, 1);
Tejun Heo8619f972007-06-14 03:45:18 +0900370 atomic_set(&sd->s_active, 0);
Tejun Heoa26cd722007-06-14 03:45:14 +0900371
Tejun Heo0c096b52007-06-14 03:45:15 +0900372 sd->s_name = name;
Tejun Heoa26cd722007-06-14 03:45:14 +0900373 sd->s_mode = mode;
Tejun Heob402d722007-06-14 04:27:21 +0900374 sd->s_flags = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
376 return sd;
Tejun Heo0c096b52007-06-14 03:45:15 +0900377
Akinobu Mita01da2422007-07-14 11:03:35 +0900378 err_out2:
Tejun Heo0c096b52007-06-14 03:45:15 +0900379 kmem_cache_free(sysfs_dir_cachep, sd);
Akinobu Mita01da2422007-07-14 11:03:35 +0900380 err_out1:
381 kfree(dup_name);
Tejun Heo0c096b52007-06-14 03:45:15 +0900382 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383}
384
Tejun Heo3007e992007-06-14 04:27:23 +0900385/**
Tejun Heofb6896d2007-06-14 04:27:24 +0900386 * sysfs_addrm_start - prepare for sysfs_dirent add/remove
387 * @acxt: pointer to sysfs_addrm_cxt to be used
388 * @parent_sd: parent sysfs_dirent
Tejun Heo3007e992007-06-14 04:27:23 +0900389 *
Tejun Heofb6896d2007-06-14 04:27:24 +0900390 * This function is called when the caller is about to add or
391 * remove sysfs_dirent under @parent_sd. This function acquires
Eric W. Biedermana16bbc32009-11-20 16:08:55 -0800392 * sysfs_mutex. @acxt is used to keep and pass context to
Tejun Heofb6896d2007-06-14 04:27:24 +0900393 * other addrm functions.
Tejun Heo3007e992007-06-14 04:27:23 +0900394 *
395 * LOCKING:
Tejun Heofb6896d2007-06-14 04:27:24 +0900396 * Kernel thread context (may sleep). sysfs_mutex is locked on
Eric W. Biedermana16bbc32009-11-20 16:08:55 -0800397 * return.
Tejun Heo3007e992007-06-14 04:27:23 +0900398 */
Tejun Heofb6896d2007-06-14 04:27:24 +0900399void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
400 struct sysfs_dirent *parent_sd)
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700401{
Tejun Heofb6896d2007-06-14 04:27:24 +0900402 memset(acxt, 0, sizeof(*acxt));
403 acxt->parent_sd = parent_sd;
404
Tejun Heofb6896d2007-06-14 04:27:24 +0900405 mutex_lock(&sysfs_mutex);
Tejun Heofb6896d2007-06-14 04:27:24 +0900406}
407
408/**
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200409 * __sysfs_add_one - add sysfs_dirent to parent without warning
410 * @acxt: addrm context to use
411 * @sd: sysfs_dirent to be added
412 *
413 * Get @acxt->parent_sd and set sd->s_parent to it and increment
414 * nlink of parent inode if @sd is a directory and link into the
415 * children list of the parent.
416 *
417 * This function should be called between calls to
418 * sysfs_addrm_start() and sysfs_addrm_finish() and should be
419 * passed the same @acxt as passed to sysfs_addrm_start().
420 *
421 * LOCKING:
422 * Determined by sysfs_addrm_start().
423 *
424 * RETURNS:
425 * 0 on success, -EEXIST if entry with the given name already
426 * exists.
427 */
428int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
429{
Eric W. Biederman6b0bfe92009-11-20 16:08:51 -0800430 struct sysfs_inode_attrs *ps_iattr;
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800431 int ret;
Eric W. Biederman6b0bfe92009-11-20 16:08:51 -0800432
Eric W. Biederman903e21e2011-10-12 22:02:43 +0000433 if (!!sysfs_ns_type(acxt->parent_sd) != !!sd->s_ns) {
434 WARN(1, KERN_WARNING "sysfs: ns %s in '%s' for '%s'\n",
435 sysfs_ns_type(acxt->parent_sd)? "required": "invalid",
436 acxt->parent_sd->s_name, sd->s_name);
437 return -EINVAL;
438 }
439
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800440 sd->s_hash = sysfs_name_hash(sd->s_ns, sd->s_name);
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200441 sd->s_parent = sysfs_get(acxt->parent_sd);
442
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800443 ret = sysfs_link_sibling(sd);
444 if (ret)
445 return ret;
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200446
Eric W. Biederman6b0bfe92009-11-20 16:08:51 -0800447 /* Update timestamps on the parent */
448 ps_iattr = acxt->parent_sd->s_iattr;
449 if (ps_iattr) {
450 struct iattr *ps_iattrs = &ps_iattr->ia_iattr;
451 ps_iattrs->ia_ctime = ps_iattrs->ia_mtime = CURRENT_TIME;
452 }
453
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200454 return 0;
455}
456
457/**
Alex Chiang425cb022009-02-12 10:56:59 -0700458 * sysfs_pathname - return full path to sysfs dirent
459 * @sd: sysfs_dirent whose path we want
460 * @path: caller allocated buffer
461 *
462 * Gives the name "/" to the sysfs_root entry; any path returned
463 * is relative to wherever sysfs is mounted.
464 *
465 * XXX: does no error checking on @path size
466 */
467static char *sysfs_pathname(struct sysfs_dirent *sd, char *path)
468{
469 if (sd->s_parent) {
470 sysfs_pathname(sd->s_parent, path);
471 strcat(path, "/");
472 }
473 strcat(path, sd->s_name);
474 return path;
475}
476
477/**
Tejun Heofb6896d2007-06-14 04:27:24 +0900478 * sysfs_add_one - add sysfs_dirent to parent
479 * @acxt: addrm context to use
480 * @sd: sysfs_dirent to be added
481 *
482 * Get @acxt->parent_sd and set sd->s_parent to it and increment
Tejun Heo181b2e42007-09-20 16:05:09 +0900483 * nlink of parent inode if @sd is a directory and link into the
484 * children list of the parent.
Tejun Heofb6896d2007-06-14 04:27:24 +0900485 *
486 * This function should be called between calls to
487 * sysfs_addrm_start() and sysfs_addrm_finish() and should be
488 * passed the same @acxt as passed to sysfs_addrm_start().
489 *
490 * LOCKING:
491 * Determined by sysfs_addrm_start().
Tejun Heo23dc2792007-08-02 21:38:03 +0900492 *
493 * RETURNS:
494 * 0 on success, -EEXIST if entry with the given name already
495 * exists.
Tejun Heofb6896d2007-06-14 04:27:24 +0900496 */
Tejun Heo23dc2792007-08-02 21:38:03 +0900497int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
Tejun Heofb6896d2007-06-14 04:27:24 +0900498{
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200499 int ret;
Tejun Heo23dc2792007-08-02 21:38:03 +0900500
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200501 ret = __sysfs_add_one(acxt, sd);
Alex Chiang425cb022009-02-12 10:56:59 -0700502 if (ret == -EEXIST) {
503 char *path = kzalloc(PATH_MAX, GFP_KERNEL);
504 WARN(1, KERN_WARNING
505 "sysfs: cannot create duplicate filename '%s'\n",
506 (path == NULL) ? sd->s_name :
507 strcat(strcat(sysfs_pathname(acxt->parent_sd, path), "/"),
508 sd->s_name));
509 kfree(path);
510 }
511
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200512 return ret;
Tejun Heofb6896d2007-06-14 04:27:24 +0900513}
514
515/**
516 * sysfs_remove_one - remove sysfs_dirent from parent
517 * @acxt: addrm context to use
Jean Delvare9fd5b1c2008-01-08 18:11:24 +0100518 * @sd: sysfs_dirent to be removed
Tejun Heofb6896d2007-06-14 04:27:24 +0900519 *
520 * Mark @sd removed and drop nlink of parent inode if @sd is a
Tejun Heo181b2e42007-09-20 16:05:09 +0900521 * directory. @sd is unlinked from the children list.
Tejun Heofb6896d2007-06-14 04:27:24 +0900522 *
523 * This function should be called between calls to
524 * sysfs_addrm_start() and sysfs_addrm_finish() and should be
525 * passed the same @acxt as passed to sysfs_addrm_start().
526 *
527 * LOCKING:
528 * Determined by sysfs_addrm_start().
529 */
530void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
531{
Eric W. Biederman6b0bfe92009-11-20 16:08:51 -0800532 struct sysfs_inode_attrs *ps_iattr;
533
Tejun Heo41fc1c22007-08-02 21:38:03 +0900534 BUG_ON(sd->s_flags & SYSFS_FLAG_REMOVED);
535
536 sysfs_unlink_sibling(sd);
Tejun Heofb6896d2007-06-14 04:27:24 +0900537
Eric W. Biederman6b0bfe92009-11-20 16:08:51 -0800538 /* Update timestamps on the parent */
539 ps_iattr = acxt->parent_sd->s_iattr;
540 if (ps_iattr) {
541 struct iattr *ps_iattrs = &ps_iattr->ia_iattr;
542 ps_iattrs->ia_ctime = ps_iattrs->ia_mtime = CURRENT_TIME;
543 }
544
Tejun Heofb6896d2007-06-14 04:27:24 +0900545 sd->s_flags |= SYSFS_FLAG_REMOVED;
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400546 sd->u.removed_list = acxt->removed;
Tejun Heofb6896d2007-06-14 04:27:24 +0900547 acxt->removed = sd;
Tejun Heoa0edd7c2007-06-14 04:27:24 +0900548}
549
550/**
Tejun Heofb6896d2007-06-14 04:27:24 +0900551 * sysfs_addrm_finish - finish up sysfs_dirent add/remove
552 * @acxt: addrm context to finish up
553 *
554 * Finish up sysfs_dirent add/remove. Resources acquired by
555 * sysfs_addrm_start() are released and removed sysfs_dirents are
Eric W. Biedermana16bbc32009-11-20 16:08:55 -0800556 * cleaned up.
Tejun Heofb6896d2007-06-14 04:27:24 +0900557 *
558 * LOCKING:
Eric W. Biedermana16bbc32009-11-20 16:08:55 -0800559 * sysfs_mutex is released.
Tejun Heofb6896d2007-06-14 04:27:24 +0900560 */
Tejun Heo990e53f2007-08-02 21:38:03 +0900561void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt)
Tejun Heofb6896d2007-06-14 04:27:24 +0900562{
563 /* release resources acquired by sysfs_addrm_start() */
564 mutex_unlock(&sysfs_mutex);
Tejun Heofb6896d2007-06-14 04:27:24 +0900565
566 /* kill removed sysfs_dirents */
567 while (acxt->removed) {
568 struct sysfs_dirent *sd = acxt->removed;
569
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400570 acxt->removed = sd->u.removed_list;
Tejun Heofb6896d2007-06-14 04:27:24 +0900571
Tejun Heofb6896d2007-06-14 04:27:24 +0900572 sysfs_deactivate(sd);
Eric W. Biedermane0edd3c2009-03-04 11:57:20 -0800573 unmap_bin_file(sd);
Tejun Heofb6896d2007-06-14 04:27:24 +0900574 sysfs_put(sd);
575 }
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700576}
577
Tejun Heof0b0af42007-06-14 04:27:22 +0900578/**
579 * sysfs_find_dirent - find sysfs_dirent with the given name
580 * @parent_sd: sysfs_dirent to search under
581 * @name: name to look for
Maneesh Sonic5168652006-03-09 19:40:14 +0530582 *
Tejun Heof0b0af42007-06-14 04:27:22 +0900583 * Look for sysfs_dirent with name @name under @parent_sd.
Maneesh Sonic5168652006-03-09 19:40:14 +0530584 *
Tejun Heof0b0af42007-06-14 04:27:22 +0900585 * LOCKING:
Tejun Heo3007e992007-06-14 04:27:23 +0900586 * mutex_lock(sysfs_mutex)
Tejun Heof0b0af42007-06-14 04:27:22 +0900587 *
588 * RETURNS:
589 * Pointer to sysfs_dirent if found, NULL if not.
Maneesh Sonic5168652006-03-09 19:40:14 +0530590 */
Tejun Heof0b0af42007-06-14 04:27:22 +0900591struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700592 const void *ns,
Tejun Heof0b0af42007-06-14 04:27:22 +0900593 const unsigned char *name)
Maneesh Sonic5168652006-03-09 19:40:14 +0530594{
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800595 struct rb_node *node = parent_sd->s_dir.children.rb_node;
596 unsigned int hash;
Maneesh Sonic5168652006-03-09 19:40:14 +0530597
Eric W. Biederman903e21e2011-10-12 22:02:43 +0000598 if (!!sysfs_ns_type(parent_sd) != !!ns) {
599 WARN(1, KERN_WARNING "sysfs: ns %s in '%s' for '%s'\n",
600 sysfs_ns_type(parent_sd)? "required": "invalid",
601 parent_sd->s_name, name);
602 return NULL;
603 }
604
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800605 hash = sysfs_name_hash(ns, name);
606 while (node) {
607 struct sysfs_dirent *sd;
608 int result;
Mikulas Patocka4f72c0c2011-07-25 17:55:57 -0400609
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800610 sd = to_sysfs_dirent(node);
611 result = sysfs_name_compare(hash, ns, name, sd);
612 if (result < 0)
613 node = node->rb_left;
614 else if (result > 0)
615 node = node->rb_right;
616 else
617 return sd;
Mikulas Patocka4f72c0c2011-07-25 17:55:57 -0400618 }
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800619 return NULL;
Tejun Heof0b0af42007-06-14 04:27:22 +0900620}
Maneesh Sonic5168652006-03-09 19:40:14 +0530621
Tejun Heof0b0af42007-06-14 04:27:22 +0900622/**
623 * sysfs_get_dirent - find and get sysfs_dirent with the given name
624 * @parent_sd: sysfs_dirent to search under
625 * @name: name to look for
626 *
627 * Look for sysfs_dirent with name @name under @parent_sd and get
628 * it if found.
629 *
630 * LOCKING:
Tejun Heo3007e992007-06-14 04:27:23 +0900631 * Kernel thread context (may sleep). Grabs sysfs_mutex.
Tejun Heof0b0af42007-06-14 04:27:22 +0900632 *
633 * RETURNS:
634 * Pointer to sysfs_dirent if found, NULL if not.
635 */
636struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700637 const void *ns,
Tejun Heof0b0af42007-06-14 04:27:22 +0900638 const unsigned char *name)
639{
640 struct sysfs_dirent *sd;
641
Tejun Heo3007e992007-06-14 04:27:23 +0900642 mutex_lock(&sysfs_mutex);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700643 sd = sysfs_find_dirent(parent_sd, ns, name);
Tejun Heof0b0af42007-06-14 04:27:22 +0900644 sysfs_get(sd);
Tejun Heo3007e992007-06-14 04:27:23 +0900645 mutex_unlock(&sysfs_mutex);
Tejun Heof0b0af42007-06-14 04:27:22 +0900646
647 return sd;
Maneesh Sonic5168652006-03-09 19:40:14 +0530648}
Neil Brownf1282c82008-07-16 08:58:04 +1000649EXPORT_SYMBOL_GPL(sysfs_get_dirent);
Maneesh Sonic5168652006-03-09 19:40:14 +0530650
Tejun Heo608e2662007-06-14 04:27:22 +0900651static int create_dir(struct kobject *kobj, struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700652 enum kobj_ns_type type, const void *ns, const char *name,
653 struct sysfs_dirent **p_sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 umode_t mode = S_IFDIR| S_IRWXU | S_IRUGO | S_IXUGO;
Tejun Heo51225032007-06-14 04:27:25 +0900656 struct sysfs_addrm_cxt acxt;
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900657 struct sysfs_dirent *sd;
Tejun Heo23dc2792007-08-02 21:38:03 +0900658 int rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659
Tejun Heofc9f54b2007-06-14 03:45:17 +0900660 /* allocate */
Tejun Heo3e519032007-06-14 03:45:15 +0900661 sd = sysfs_new_dirent(name, mode, SYSFS_DIR);
Tejun Heoa26cd722007-06-14 03:45:14 +0900662 if (!sd)
Tejun Heo51225032007-06-14 04:27:25 +0900663 return -ENOMEM;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700664
665 sd->s_flags |= (type << SYSFS_NS_TYPE_SHIFT);
666 sd->s_ns = ns;
Tejun Heob1fc3d62007-09-20 16:05:11 +0900667 sd->s_dir.kobj = kobj;
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900668
Tejun Heo51225032007-06-14 04:27:25 +0900669 /* link in */
670 sysfs_addrm_start(&acxt, parent_sd);
Tejun Heo23dc2792007-08-02 21:38:03 +0900671 rc = sysfs_add_one(&acxt, sd);
672 sysfs_addrm_finish(&acxt);
Tejun Heo967e35d2007-07-18 16:38:11 +0900673
Tejun Heo23dc2792007-08-02 21:38:03 +0900674 if (rc == 0)
675 *p_sd = sd;
676 else
Tejun Heo967e35d2007-07-18 16:38:11 +0900677 sysfs_put(sd);
Tejun Heofc9f54b2007-06-14 03:45:17 +0900678
Tejun Heo23dc2792007-08-02 21:38:03 +0900679 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680}
681
Tejun Heo608e2662007-06-14 04:27:22 +0900682int sysfs_create_subdir(struct kobject *kobj, const char *name,
683 struct sysfs_dirent **p_sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684{
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700685 return create_dir(kobj, kobj->sd,
686 KOBJ_NS_TYPE_NONE, NULL, name, p_sd);
687}
688
Serge E. Hallynbe867b12010-05-03 16:23:15 -0500689/**
690 * sysfs_read_ns_type: return associated ns_type
691 * @kobj: the kobject being queried
692 *
693 * Each kobject can be tagged with exactly one namespace type
694 * (i.e. network or user). Return the ns_type associated with
695 * this object if any
696 */
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700697static enum kobj_ns_type sysfs_read_ns_type(struct kobject *kobj)
698{
699 const struct kobj_ns_type_operations *ops;
700 enum kobj_ns_type type;
701
702 ops = kobj_child_ns_ops(kobj);
703 if (!ops)
704 return KOBJ_NS_TYPE_NONE;
705
706 type = ops->type;
707 BUG_ON(type <= KOBJ_NS_TYPE_NONE);
708 BUG_ON(type >= KOBJ_NS_TYPES);
709 BUG_ON(!kobj_ns_type_registered(type));
710
711 return type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712}
713
714/**
715 * sysfs_create_dir - create a directory for an object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 * @kobj: object we're creating directory for.
717 */
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900718int sysfs_create_dir(struct kobject * kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719{
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700720 enum kobj_ns_type type;
Tejun Heo608e2662007-06-14 04:27:22 +0900721 struct sysfs_dirent *parent_sd, *sd;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700722 const void *ns = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 int error = 0;
724
725 BUG_ON(!kobj);
726
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900727 if (kobj->parent)
Tejun Heo608e2662007-06-14 04:27:22 +0900728 parent_sd = kobj->parent->sd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 else
Eric W. Biederman7d0c7d62007-08-20 21:36:30 +0900730 parent_sd = &sysfs_root;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731
Dan Williams3a198882012-04-06 13:41:06 -0700732 if (!parent_sd)
733 return -ENOENT;
734
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700735 if (sysfs_ns_type(parent_sd))
736 ns = kobj->ktype->namespace(kobj);
737 type = sysfs_read_ns_type(kobj);
738
739 error = create_dir(kobj, parent_sd, type, ns, kobject_name(kobj), &sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 if (!error)
Tejun Heo608e2662007-06-14 04:27:22 +0900741 kobj->sd = sd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 return error;
743}
744
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745static struct dentry * sysfs_lookup(struct inode *dir, struct dentry *dentry,
746 struct nameidata *nd)
747{
Tejun Heo6cb52142007-07-31 19:15:08 +0900748 struct dentry *ret = NULL;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700749 struct dentry *parent = dentry->d_parent;
750 struct sysfs_dirent *parent_sd = parent->d_fsdata;
Tejun Heoa7a04752007-08-02 21:38:02 +0900751 struct sysfs_dirent *sd;
Tejun Heofc9f54b2007-06-14 03:45:17 +0900752 struct inode *inode;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700753 enum kobj_ns_type type;
754 const void *ns;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
Tejun Heo6cb52142007-07-31 19:15:08 +0900756 mutex_lock(&sysfs_mutex);
757
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700758 type = sysfs_ns_type(parent_sd);
759 ns = sysfs_info(dir->i_sb)->ns[type];
760
761 sd = sysfs_find_dirent(parent_sd, ns, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762
Tejun Heofc9f54b2007-06-14 03:45:17 +0900763 /* no such entry */
Tejun Heoe49452c2008-01-16 12:06:14 +0900764 if (!sd) {
765 ret = ERR_PTR(-ENOENT);
Tejun Heo6cb52142007-07-31 19:15:08 +0900766 goto out_unlock;
Tejun Heoe49452c2008-01-16 12:06:14 +0900767 }
Tejun Heofc9f54b2007-06-14 03:45:17 +0900768
769 /* attach dentry and inode */
Eric W. Biedermanfac26222010-02-12 19:22:27 -0800770 inode = sysfs_get_inode(dir->i_sb, sd);
Tejun Heo6cb52142007-07-31 19:15:08 +0900771 if (!inode) {
772 ret = ERR_PTR(-ENOMEM);
773 goto out_unlock;
774 }
Tejun Heo3007e992007-06-14 04:27:23 +0900775
Tejun Heod6b4fd22007-09-20 16:05:11 +0900776 /* instantiate and hash dentry */
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800777 ret = d_find_alias(inode);
778 if (!ret) {
Nick Pigginfb045ad2011-01-07 17:49:55 +1100779 d_set_d_op(dentry, &sysfs_dentry_ops);
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800780 dentry->d_fsdata = sysfs_get(sd);
781 d_add(dentry, inode);
782 } else {
783 d_move(ret, dentry);
784 iput(inode);
785 }
Tejun Heofc9f54b2007-06-14 03:45:17 +0900786
Tejun Heo6cb52142007-07-31 19:15:08 +0900787 out_unlock:
Tejun Heo3007e992007-06-14 04:27:23 +0900788 mutex_unlock(&sysfs_mutex);
Tejun Heo6cb52142007-07-31 19:15:08 +0900789 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790}
791
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800792const struct inode_operations sysfs_dir_inode_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 .lookup = sysfs_lookup,
Eric W. Biedermane61ab4a2009-11-20 16:08:53 -0800794 .permission = sysfs_permission,
Maneesh Soni988d1862005-05-31 10:39:14 +0530795 .setattr = sysfs_setattr,
Eric W. Biedermane61ab4a2009-11-20 16:08:53 -0800796 .getattr = sysfs_getattr,
David P. Quigleyddd29ec2009-09-09 14:25:37 -0400797 .setxattr = sysfs_setxattr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798};
799
Tejun Heo608e2662007-06-14 04:27:22 +0900800static void remove_dir(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801{
Tejun Heofb6896d2007-06-14 04:27:24 +0900802 struct sysfs_addrm_cxt acxt;
803
804 sysfs_addrm_start(&acxt, sd->s_parent);
Tejun Heofb6896d2007-06-14 04:27:24 +0900805 sysfs_remove_one(&acxt, sd);
806 sysfs_addrm_finish(&acxt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807}
808
Tejun Heo608e2662007-06-14 04:27:22 +0900809void sysfs_remove_subdir(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810{
Tejun Heo608e2662007-06-14 04:27:22 +0900811 remove_dir(sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812}
813
814
Tejun Heo608e2662007-06-14 04:27:22 +0900815static void __sysfs_remove_dir(struct sysfs_dirent *dir_sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816{
Tejun Heofb6896d2007-06-14 04:27:24 +0900817 struct sysfs_addrm_cxt acxt;
Mikulas Patockaa406f752011-07-25 17:57:03 -0400818 struct rb_node *pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819
Tejun Heo608e2662007-06-14 04:27:22 +0900820 if (!dir_sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 return;
822
Tejun Heo608e2662007-06-14 04:27:22 +0900823 pr_debug("sysfs %s: removing dir\n", dir_sd->s_name);
Tejun Heofb6896d2007-06-14 04:27:24 +0900824 sysfs_addrm_start(&acxt, dir_sd);
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800825 pos = rb_first(&dir_sd->s_dir.children);
Mikulas Patockaa406f752011-07-25 17:57:03 -0400826 while (pos) {
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800827 struct sysfs_dirent *sd = to_sysfs_dirent(pos);
Mikulas Patockaa406f752011-07-25 17:57:03 -0400828 pos = rb_next(pos);
Eric W. Biederman3efa65b2007-08-20 21:36:30 +0900829 if (sysfs_type(sd) != SYSFS_DIR)
Tejun Heofb6896d2007-06-14 04:27:24 +0900830 sysfs_remove_one(&acxt, sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 }
Tejun Heofb6896d2007-06-14 04:27:24 +0900832 sysfs_addrm_finish(&acxt);
Tejun Heo0ab66082007-06-14 03:45:16 +0900833
Tejun Heo608e2662007-06-14 04:27:22 +0900834 remove_dir(dir_sd);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700835}
836
837/**
838 * sysfs_remove_dir - remove an object's directory.
839 * @kobj: object.
840 *
841 * The only thing special about this is that we remove any files in
842 * the directory before we remove the directory, and we've inlined
843 * what used to be sysfs_rmdir() below, instead of calling separately.
844 */
845
846void sysfs_remove_dir(struct kobject * kobj)
847{
Tejun Heo608e2662007-06-14 04:27:22 +0900848 struct sysfs_dirent *sd = kobj->sd;
Tejun Heoaecdced2007-06-14 03:45:15 +0900849
Tejun Heo5f995322007-06-14 04:27:23 +0900850 spin_lock(&sysfs_assoc_lock);
Tejun Heo608e2662007-06-14 04:27:22 +0900851 kobj->sd = NULL;
Tejun Heo5f995322007-06-14 04:27:23 +0900852 spin_unlock(&sysfs_assoc_lock);
Tejun Heoaecdced2007-06-14 03:45:15 +0900853
Tejun Heo608e2662007-06-14 04:27:22 +0900854 __sysfs_remove_dir(sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855}
856
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800857int sysfs_rename(struct sysfs_dirent *sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700858 struct sysfs_dirent *new_parent_sd, const void *new_ns,
859 const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860{
Tejun Heo51225032007-06-14 04:27:25 +0900861 const char *dup_name = NULL;
Tejun Heo996b7372007-06-14 03:45:14 +0900862 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800864 mutex_lock(&sysfs_mutex);
Eric W. Biederman932ea2e2007-08-20 21:36:30 +0900865
Eric W. Biederman9918f9a2007-08-20 21:36:31 +0900866 error = 0;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700867 if ((sd->s_parent == new_parent_sd) && (sd->s_ns == new_ns) &&
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800868 (strcmp(sd->s_name, new_name) == 0))
Eric W. Biederman9918f9a2007-08-20 21:36:31 +0900869 goto out; /* nothing to rename */
870
Tejun Heo996b7372007-06-14 03:45:14 +0900871 error = -EEXIST;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700872 if (sysfs_find_dirent(new_parent_sd, new_ns, new_name))
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800873 goto out;
Tejun Heo996b7372007-06-14 03:45:14 +0900874
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700875 /* rename sysfs_dirent */
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800876 if (strcmp(sd->s_name, new_name) != 0) {
877 error = -ENOMEM;
878 new_name = dup_name = kstrdup(new_name, GFP_KERNEL);
879 if (!new_name)
880 goto out;
Tejun Heo996b7372007-06-14 03:45:14 +0900881
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800882 dup_name = sd->s_name;
883 sd->s_name = new_name;
884 }
885
Eric W. Biedermanf6d90b42011-11-01 07:06:17 -0700886 /* Move to the appropriate place in the appropriate directories rbtree. */
887 sysfs_unlink_sibling(sd);
888 sysfs_get(new_parent_sd);
889 sysfs_put(sd->s_parent);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700890 sd->s_ns = new_ns;
Tom Goff70fa4a62012-04-04 12:06:20 -0700891 sd->s_hash = sysfs_name_hash(sd->s_ns, sd->s_name);
Eric W. Biedermanf6d90b42011-11-01 07:06:17 -0700892 sd->s_parent = new_parent_sd;
893 sysfs_link_sibling(sd);
Tejun Heo0c096b52007-06-14 03:45:15 +0900894
Tejun Heo996b7372007-06-14 03:45:14 +0900895 error = 0;
Eric W. Biederman9918f9a2007-08-20 21:36:31 +0900896 out:
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800897 mutex_unlock(&sysfs_mutex);
898 kfree(dup_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 return error;
900}
901
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800902int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
903{
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700904 struct sysfs_dirent *parent_sd = kobj->sd->s_parent;
905 const void *new_ns = NULL;
906
907 if (sysfs_ns_type(parent_sd))
908 new_ns = kobj->ktype->namespace(kobj);
909
910 return sysfs_rename(kobj->sd, parent_sd, new_ns, new_name);
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800911}
912
Tejun Heo51225032007-06-14 04:27:25 +0900913int sysfs_move_dir(struct kobject *kobj, struct kobject *new_parent_kobj)
Cornelia Huck8a824722006-11-20 17:07:51 +0100914{
Tejun Heo51225032007-06-14 04:27:25 +0900915 struct sysfs_dirent *sd = kobj->sd;
916 struct sysfs_dirent *new_parent_sd;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700917 const void *new_ns = NULL;
Cornelia Huck8a824722006-11-20 17:07:51 +0100918
Tejun Heo51225032007-06-14 04:27:25 +0900919 BUG_ON(!sd->s_parent);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700920 if (sysfs_ns_type(sd->s_parent))
921 new_ns = kobj->ktype->namespace(kobj);
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800922 new_parent_sd = new_parent_kobj && new_parent_kobj->sd ?
Cornelia Hucka6a83572009-10-06 15:33:35 +0200923 new_parent_kobj->sd : &sysfs_root;
Cornelia Huck8a824722006-11-20 17:07:51 +0100924
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700925 return sysfs_rename(sd, new_parent_sd, new_ns, sd->s_name);
Cornelia Huck8a824722006-11-20 17:07:51 +0100926}
927
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928/* Relationship between s_mode and the DT_xxx types */
929static inline unsigned char dt_type(struct sysfs_dirent *sd)
930{
931 return (sd->s_mode >> 12) & 15;
932}
933
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800934static int sysfs_dir_release(struct inode *inode, struct file *filp)
935{
936 sysfs_put(filp->private_data);
937 return 0;
938}
939
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700940static struct sysfs_dirent *sysfs_dir_pos(const void *ns,
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800941 struct sysfs_dirent *parent_sd, loff_t hash, struct sysfs_dirent *pos)
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800942{
943 if (pos) {
944 int valid = !(pos->s_flags & SYSFS_FLAG_REMOVED) &&
945 pos->s_parent == parent_sd &&
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800946 hash == pos->s_hash;
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800947 sysfs_put(pos);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700948 if (!valid)
949 pos = NULL;
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800950 }
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800951 if (!pos && (hash > 1) && (hash < INT_MAX)) {
952 struct rb_node *node = parent_sd->s_dir.children.rb_node;
953 while (node) {
954 pos = to_sysfs_dirent(node);
955
956 if (hash < pos->s_hash)
957 node = node->rb_left;
958 else if (hash > pos->s_hash)
959 node = node->rb_right;
960 else
Mikulas Patockaa406f752011-07-25 17:57:03 -0400961 break;
Mikulas Patockaa406f752011-07-25 17:57:03 -0400962 }
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800963 }
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800964 /* Skip over entries in the wrong namespace */
Eric W. Biedermanb9e2780d2011-10-25 05:38:41 -0700965 while (pos && pos->s_ns != ns) {
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800966 struct rb_node *node = rb_next(&pos->s_rb);
967 if (!node)
Mikulas Patockaa406f752011-07-25 17:57:03 -0400968 pos = NULL;
969 else
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800970 pos = to_sysfs_dirent(node);
Mikulas Patockaa406f752011-07-25 17:57:03 -0400971 }
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800972 return pos;
973}
974
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700975static struct sysfs_dirent *sysfs_dir_next_pos(const void *ns,
976 struct sysfs_dirent *parent_sd, ino_t ino, struct sysfs_dirent *pos)
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800977{
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700978 pos = sysfs_dir_pos(ns, parent_sd, ino, pos);
Mikulas Patockaa406f752011-07-25 17:57:03 -0400979 if (pos) do {
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800980 struct rb_node *node = rb_next(&pos->s_rb);
981 if (!node)
Mikulas Patockaa406f752011-07-25 17:57:03 -0400982 pos = NULL;
983 else
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800984 pos = to_sysfs_dirent(node);
Eric W. Biedermanb9e2780d2011-10-25 05:38:41 -0700985 } while (pos && pos->s_ns != ns);
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800986 return pos;
987}
988
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989static int sysfs_readdir(struct file * filp, void * dirent, filldir_t filldir)
990{
Josef "Jeff" Sipekf427f5d2006-12-08 02:36:36 -0800991 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 struct sysfs_dirent * parent_sd = dentry->d_fsdata;
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800993 struct sysfs_dirent *pos = filp->private_data;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700994 enum kobj_ns_type type;
995 const void *ns;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 ino_t ino;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700998 type = sysfs_ns_type(parent_sd);
999 ns = sysfs_info(dentry->d_sb)->ns[type];
1000
Eric W. Biederman3efa65b2007-08-20 21:36:30 +09001001 if (filp->f_pos == 0) {
1002 ino = parent_sd->s_ino;
1003 if (filldir(dirent, ".", 1, filp->f_pos, ino, DT_DIR) == 0)
1004 filp->f_pos++;
1005 }
1006 if (filp->f_pos == 1) {
1007 if (parent_sd->s_parent)
1008 ino = parent_sd->s_parent->s_ino;
1009 else
Eric Sandeendc351252007-06-11 14:02:45 +09001010 ino = parent_sd->s_ino;
Eric W. Biederman3efa65b2007-08-20 21:36:30 +09001011 if (filldir(dirent, "..", 2, filp->f_pos, ino, DT_DIR) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 filp->f_pos++;
Eric W. Biederman3efa65b2007-08-20 21:36:30 +09001013 }
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001014 mutex_lock(&sysfs_mutex);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -07001015 for (pos = sysfs_dir_pos(ns, parent_sd, filp->f_pos, pos);
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001016 pos;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -07001017 pos = sysfs_dir_next_pos(ns, parent_sd, filp->f_pos, pos)) {
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001018 const char * name;
1019 unsigned int type;
1020 int len, ret;
Eric W. Biederman3efa65b2007-08-20 21:36:30 +09001021
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001022 name = pos->s_name;
1023 len = strlen(name);
1024 ino = pos->s_ino;
1025 type = dt_type(pos);
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -08001026 filp->f_pos = pos->s_hash;
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001027 filp->private_data = sysfs_get(pos);
Eric W. Biederman3efa65b2007-08-20 21:36:30 +09001028
Eric W. Biederman3efa65b2007-08-20 21:36:30 +09001029 mutex_unlock(&sysfs_mutex);
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001030 ret = filldir(dirent, name, len, filp->f_pos, ino, type);
1031 mutex_lock(&sysfs_mutex);
1032 if (ret < 0)
1033 break;
1034 }
1035 mutex_unlock(&sysfs_mutex);
1036 if ((filp->f_pos > 1) && !pos) { /* EOF */
1037 filp->f_pos = INT_MAX;
1038 filp->private_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 }
1040 return 0;
1041}
1042
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08001044const struct file_operations sysfs_dir_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045 .read = generic_read_dir,
1046 .readdir = sysfs_readdir,
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001047 .release = sysfs_dir_release,
Christoph Hellwig3222a3e2008-09-03 21:53:01 +02001048 .llseek = generic_file_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049};