blob: c0bf38a21caae119deac73128ae7b2ac4db19ce3 [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
Alan Stern356c05d2012-05-14 13:30:03 -0400135#ifdef CONFIG_DEBUG_LOCK_ALLOC
136
137/* Test for attributes that want to ignore lockdep for read-locking */
138static bool ignore_lockdep(struct sysfs_dirent *sd)
139{
140 return sysfs_type(sd) == SYSFS_KOBJ_ATTR &&
141 sd->s_attr.attr->ignore_lockdep;
142}
143
144#else
145
146static inline bool ignore_lockdep(struct sysfs_dirent *sd)
147{
148 return true;
149}
150
151#endif
152
Tejun Heo0c73f182007-06-14 03:45:18 +0900153/**
Tejun Heob6b4a432007-06-14 03:45:18 +0900154 * sysfs_get_active - get an active reference to sysfs_dirent
155 * @sd: sysfs_dirent to get an active reference to
156 *
157 * Get an active reference of @sd. This function is noop if @sd
158 * is NULL.
159 *
160 * RETURNS:
161 * Pointer to @sd on success, NULL on failure.
162 */
Eric W. Biedermane72ceb82010-02-11 15:18:38 -0800163struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd)
Tejun Heob6b4a432007-06-14 03:45:18 +0900164{
Tejun Heo8619f972007-06-14 03:45:18 +0900165 if (unlikely(!sd))
166 return NULL;
167
168 while (1) {
169 int v, t;
170
171 v = atomic_read(&sd->s_active);
172 if (unlikely(v < 0))
173 return NULL;
174
175 t = atomic_cmpxchg(&sd->s_active, v, v + 1);
Alan Stern356c05d2012-05-14 13:30:03 -0400176 if (likely(t == v))
177 break;
Tejun Heo8619f972007-06-14 03:45:18 +0900178 if (t < 0)
179 return NULL;
180
181 cpu_relax();
Tejun Heob6b4a432007-06-14 03:45:18 +0900182 }
Alan Stern356c05d2012-05-14 13:30:03 -0400183
184 if (likely(!ignore_lockdep(sd)))
185 rwsem_acquire_read(&sd->dep_map, 0, 1, _RET_IP_);
186 return sd;
Tejun Heob6b4a432007-06-14 03:45:18 +0900187}
188
189/**
190 * sysfs_put_active - put an active reference to sysfs_dirent
191 * @sd: sysfs_dirent to put an active reference to
192 *
193 * Put an active reference to @sd. This function is noop if @sd
194 * is NULL.
195 */
Eric W. Biedermane72ceb82010-02-11 15:18:38 -0800196void sysfs_put_active(struct sysfs_dirent *sd)
Tejun Heob6b4a432007-06-14 03:45:18 +0900197{
Tejun Heo8619f972007-06-14 03:45:18 +0900198 int v;
199
200 if (unlikely(!sd))
201 return;
202
Alan Stern356c05d2012-05-14 13:30:03 -0400203 if (likely(!ignore_lockdep(sd)))
204 rwsem_release(&sd->dep_map, 1, _RET_IP_);
Tejun Heo8619f972007-06-14 03:45:18 +0900205 v = atomic_dec_return(&sd->s_active);
206 if (likely(v != SD_DEACTIVATED_BIAS))
207 return;
208
209 /* atomic_dec_return() is a mb(), we'll always see the updated
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400210 * sd->u.completion.
Tejun Heo8619f972007-06-14 03:45:18 +0900211 */
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400212 complete(sd->u.completion);
Tejun Heob6b4a432007-06-14 03:45:18 +0900213}
214
215/**
Tejun Heob6b4a432007-06-14 03:45:18 +0900216 * sysfs_deactivate - deactivate sysfs_dirent
217 * @sd: sysfs_dirent to deactivate
218 *
Tejun Heo8619f972007-06-14 03:45:18 +0900219 * Deny new active references and drain existing ones.
Tejun Heob6b4a432007-06-14 03:45:18 +0900220 */
Tejun Heofb6896d2007-06-14 04:27:24 +0900221static void sysfs_deactivate(struct sysfs_dirent *sd)
Tejun Heob6b4a432007-06-14 03:45:18 +0900222{
Tejun Heo8619f972007-06-14 03:45:18 +0900223 DECLARE_COMPLETION_ONSTACK(wait);
224 int v;
Tejun Heob6b4a432007-06-14 03:45:18 +0900225
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400226 BUG_ON(!(sd->s_flags & SYSFS_FLAG_REMOVED));
Eric W. Biedermana2db6842010-02-11 15:20:00 -0800227
228 if (!(sysfs_type(sd) & SYSFS_ACTIVE_REF))
229 return;
230
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400231 sd->u.completion = (void *)&wait;
Tejun Heo8619f972007-06-14 03:45:18 +0900232
Eric W. Biederman846f9972010-01-02 13:37:12 -0800233 rwsem_acquire(&sd->dep_map, 0, 0, _RET_IP_);
Tejun Heo8619f972007-06-14 03:45:18 +0900234 /* atomic_add_return() is a mb(), put_active() will always see
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400235 * the updated sd->u.completion.
Tejun Heob6b4a432007-06-14 03:45:18 +0900236 */
Tejun Heo8619f972007-06-14 03:45:18 +0900237 v = atomic_add_return(SD_DEACTIVATED_BIAS, &sd->s_active);
238
Eric W. Biederman846f9972010-01-02 13:37:12 -0800239 if (v != SD_DEACTIVATED_BIAS) {
240 lock_contended(&sd->dep_map, _RET_IP_);
Tejun Heo8619f972007-06-14 03:45:18 +0900241 wait_for_completion(&wait);
Eric W. Biederman846f9972010-01-02 13:37:12 -0800242 }
Tejun Heo8619f972007-06-14 03:45:18 +0900243
Eric W. Biederman846f9972010-01-02 13:37:12 -0800244 lock_acquired(&sd->dep_map, _RET_IP_);
245 rwsem_release(&sd->dep_map, 1, _RET_IP_);
Tejun Heob6b4a432007-06-14 03:45:18 +0900246}
247
Eric W. Biedermancafa6b52011-12-18 20:08:16 -0800248static int sysfs_alloc_ino(unsigned int *pino)
Tejun Heo2b611bb2007-06-14 03:45:13 +0900249{
250 int ino, rc;
251
252 retry:
253 spin_lock(&sysfs_ino_lock);
254 rc = ida_get_new_above(&sysfs_ino_ida, 2, &ino);
255 spin_unlock(&sysfs_ino_lock);
256
257 if (rc == -EAGAIN) {
258 if (ida_pre_get(&sysfs_ino_ida, GFP_KERNEL))
259 goto retry;
260 rc = -ENOMEM;
261 }
262
263 *pino = ino;
264 return rc;
265}
266
Eric W. Biedermancafa6b52011-12-18 20:08:16 -0800267static void sysfs_free_ino(unsigned int ino)
Tejun Heo2b611bb2007-06-14 03:45:13 +0900268{
269 spin_lock(&sysfs_ino_lock);
270 ida_remove(&sysfs_ino_ida, ino);
271 spin_unlock(&sysfs_ino_lock);
272}
273
Tejun Heofa7f9122007-06-14 03:45:13 +0900274void release_sysfs_dirent(struct sysfs_dirent * sd)
275{
Tejun Heo13b30862007-06-14 03:45:14 +0900276 struct sysfs_dirent *parent_sd;
277
278 repeat:
Tejun Heo3007e992007-06-14 04:27:23 +0900279 /* Moving/renaming is always done while holding reference.
280 * sd->s_parent won't change beneath us.
281 */
Tejun Heo13b30862007-06-14 03:45:14 +0900282 parent_sd = sd->s_parent;
283
Tejun Heob402d722007-06-14 04:27:21 +0900284 if (sysfs_type(sd) == SYSFS_KOBJ_LINK)
Tejun Heob1fc3d62007-09-20 16:05:11 +0900285 sysfs_put(sd->s_symlink.target_sd);
Tejun Heob402d722007-06-14 04:27:21 +0900286 if (sysfs_type(sd) & SYSFS_COPY_NAME)
Tejun Heo0c096b52007-06-14 03:45:15 +0900287 kfree(sd->s_name);
Eric W. Biederman4c3da222009-11-04 02:50:06 -0800288 if (sd->s_iattr && sd->s_iattr->ia_secdata)
289 security_release_secctx(sd->s_iattr->ia_secdata,
290 sd->s_iattr->ia_secdata_len);
Tejun Heofa7f9122007-06-14 03:45:13 +0900291 kfree(sd->s_iattr);
Tejun Heo2b611bb2007-06-14 03:45:13 +0900292 sysfs_free_ino(sd->s_ino);
Tejun Heofa7f9122007-06-14 03:45:13 +0900293 kmem_cache_free(sysfs_dir_cachep, sd);
Tejun Heo13b30862007-06-14 03:45:14 +0900294
295 sd = parent_sd;
296 if (sd && atomic_dec_and_test(&sd->s_count))
297 goto repeat;
Tejun Heofa7f9122007-06-14 03:45:13 +0900298}
299
Nick Pigginfe15ce42011-01-07 17:49:23 +1100300static int sysfs_dentry_delete(const struct dentry *dentry)
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800301{
302 struct sysfs_dirent *sd = dentry->d_fsdata;
303 return !!(sd->s_flags & SYSFS_FLAG_REMOVED);
304}
305
306static int sysfs_dentry_revalidate(struct dentry *dentry, struct nameidata *nd)
307{
Nick Piggin34286d62011-01-07 17:49:57 +1100308 struct sysfs_dirent *sd;
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800309 int is_dir;
Glauber Costae5bcac62012-07-06 13:09:07 +0400310 int type;
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800311
Nick Piggin34286d62011-01-07 17:49:57 +1100312 if (nd->flags & LOOKUP_RCU)
313 return -ECHILD;
314
315 sd = dentry->d_fsdata;
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800316 mutex_lock(&sysfs_mutex);
317
318 /* The sysfs dirent has been deleted */
319 if (sd->s_flags & SYSFS_FLAG_REMOVED)
320 goto out_bad;
321
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800322 /* The sysfs dirent has been moved? */
323 if (dentry->d_parent->d_fsdata != sd->s_parent)
324 goto out_bad;
325
326 /* The sysfs dirent has been renamed */
327 if (strcmp(dentry->d_name.name, sd->s_name) != 0)
328 goto out_bad;
329
Glauber Costae5bcac62012-07-06 13:09:07 +0400330 /* The sysfs dirent has been moved to a different namespace */
331 type = KOBJ_NS_TYPE_NONE;
332 if (sd->s_parent)
333 type = sysfs_ns_type(sd->s_parent);
334 if (type && (sysfs_info(dentry->d_sb)->ns[type] != sd->s_ns))
335 goto out_bad;
336
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800337 mutex_unlock(&sysfs_mutex);
338out_valid:
339 return 1;
340out_bad:
341 /* Remove the dentry from the dcache hashes.
342 * If this is a deleted dentry we use d_drop instead of d_delete
343 * so sysfs doesn't need to cope with negative dentries.
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800344 *
345 * If this is a dentry that has simply been renamed we
346 * use d_drop to remove it from the dcache lookup on its
347 * old parent. If this dentry persists later when a lookup
348 * is performed at its new name the dentry will be readded
349 * to the dcache hashes.
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800350 */
351 is_dir = (sysfs_type(sd) == SYSFS_DIR);
352 mutex_unlock(&sysfs_mutex);
353 if (is_dir) {
354 /* If we have submounts we must allow the vfs caches
355 * to lie about the state of the filesystem to prevent
356 * leaks and other nasty things.
357 */
358 if (have_submounts(dentry))
359 goto out_valid;
360 shrink_dcache_parent(dentry);
361 }
362 d_drop(dentry);
363 return 0;
364}
365
Eric W. Biederman28a027c2009-11-07 23:27:00 -0800366static void sysfs_dentry_iput(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367{
368 struct sysfs_dirent * sd = dentry->d_fsdata;
369
Eric W. Biederman5a26b792007-08-20 21:36:30 +0900370 sysfs_put(sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 iput(inode);
372}
373
Al Viroee1ec322009-02-20 06:01:46 +0000374static const struct dentry_operations sysfs_dentry_ops = {
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800375 .d_revalidate = sysfs_dentry_revalidate,
376 .d_delete = sysfs_dentry_delete,
Eric W. Biederman28a027c2009-11-07 23:27:00 -0800377 .d_iput = sysfs_dentry_iput,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378};
379
Tejun Heo3e519032007-06-14 03:45:15 +0900380struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381{
Tejun Heo0c096b52007-06-14 03:45:15 +0900382 char *dup_name = NULL;
Akinobu Mita01da2422007-07-14 11:03:35 +0900383 struct sysfs_dirent *sd;
Tejun Heo0c096b52007-06-14 03:45:15 +0900384
385 if (type & SYSFS_COPY_NAME) {
386 name = dup_name = kstrdup(name, GFP_KERNEL);
387 if (!name)
Akinobu Mita01da2422007-07-14 11:03:35 +0900388 return NULL;
Tejun Heo0c096b52007-06-14 03:45:15 +0900389 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
Robert P. J. Dayc3762222007-02-10 01:45:03 -0800391 sd = kmem_cache_zalloc(sysfs_dir_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 if (!sd)
Akinobu Mita01da2422007-07-14 11:03:35 +0900393 goto err_out1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
Tejun Heo0c096b52007-06-14 03:45:15 +0900395 if (sysfs_alloc_ino(&sd->s_ino))
Akinobu Mita01da2422007-07-14 11:03:35 +0900396 goto err_out2;
Tejun Heo2b611bb2007-06-14 03:45:13 +0900397
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 atomic_set(&sd->s_count, 1);
Tejun Heo8619f972007-06-14 03:45:18 +0900399 atomic_set(&sd->s_active, 0);
Tejun Heoa26cd722007-06-14 03:45:14 +0900400
Tejun Heo0c096b52007-06-14 03:45:15 +0900401 sd->s_name = name;
Tejun Heoa26cd722007-06-14 03:45:14 +0900402 sd->s_mode = mode;
Tejun Heob402d722007-06-14 04:27:21 +0900403 sd->s_flags = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404
405 return sd;
Tejun Heo0c096b52007-06-14 03:45:15 +0900406
Akinobu Mita01da2422007-07-14 11:03:35 +0900407 err_out2:
Tejun Heo0c096b52007-06-14 03:45:15 +0900408 kmem_cache_free(sysfs_dir_cachep, sd);
Akinobu Mita01da2422007-07-14 11:03:35 +0900409 err_out1:
410 kfree(dup_name);
Tejun Heo0c096b52007-06-14 03:45:15 +0900411 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412}
413
Tejun Heo3007e992007-06-14 04:27:23 +0900414/**
Tejun Heofb6896d2007-06-14 04:27:24 +0900415 * sysfs_addrm_start - prepare for sysfs_dirent add/remove
416 * @acxt: pointer to sysfs_addrm_cxt to be used
417 * @parent_sd: parent sysfs_dirent
Tejun Heo3007e992007-06-14 04:27:23 +0900418 *
Tejun Heofb6896d2007-06-14 04:27:24 +0900419 * This function is called when the caller is about to add or
420 * remove sysfs_dirent under @parent_sd. This function acquires
Eric W. Biedermana16bbc32009-11-20 16:08:55 -0800421 * sysfs_mutex. @acxt is used to keep and pass context to
Tejun Heofb6896d2007-06-14 04:27:24 +0900422 * other addrm functions.
Tejun Heo3007e992007-06-14 04:27:23 +0900423 *
424 * LOCKING:
Tejun Heofb6896d2007-06-14 04:27:24 +0900425 * Kernel thread context (may sleep). sysfs_mutex is locked on
Eric W. Biedermana16bbc32009-11-20 16:08:55 -0800426 * return.
Tejun Heo3007e992007-06-14 04:27:23 +0900427 */
Tejun Heofb6896d2007-06-14 04:27:24 +0900428void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
429 struct sysfs_dirent *parent_sd)
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700430{
Tejun Heofb6896d2007-06-14 04:27:24 +0900431 memset(acxt, 0, sizeof(*acxt));
432 acxt->parent_sd = parent_sd;
433
Tejun Heofb6896d2007-06-14 04:27:24 +0900434 mutex_lock(&sysfs_mutex);
Tejun Heofb6896d2007-06-14 04:27:24 +0900435}
436
437/**
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200438 * __sysfs_add_one - add sysfs_dirent to parent without warning
439 * @acxt: addrm context to use
440 * @sd: sysfs_dirent to be added
441 *
442 * Get @acxt->parent_sd and set sd->s_parent to it and increment
443 * nlink of parent inode if @sd is a directory and link into the
444 * children list of the parent.
445 *
446 * This function should be called between calls to
447 * sysfs_addrm_start() and sysfs_addrm_finish() and should be
448 * passed the same @acxt as passed to sysfs_addrm_start().
449 *
450 * LOCKING:
451 * Determined by sysfs_addrm_start().
452 *
453 * RETURNS:
454 * 0 on success, -EEXIST if entry with the given name already
455 * exists.
456 */
457int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
458{
Eric W. Biederman6b0bfe92009-11-20 16:08:51 -0800459 struct sysfs_inode_attrs *ps_iattr;
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800460 int ret;
Eric W. Biederman6b0bfe92009-11-20 16:08:51 -0800461
Eric W. Biederman903e21e2011-10-12 22:02:43 +0000462 if (!!sysfs_ns_type(acxt->parent_sd) != !!sd->s_ns) {
463 WARN(1, KERN_WARNING "sysfs: ns %s in '%s' for '%s'\n",
464 sysfs_ns_type(acxt->parent_sd)? "required": "invalid",
465 acxt->parent_sd->s_name, sd->s_name);
466 return -EINVAL;
467 }
468
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800469 sd->s_hash = sysfs_name_hash(sd->s_ns, sd->s_name);
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200470 sd->s_parent = sysfs_get(acxt->parent_sd);
471
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800472 ret = sysfs_link_sibling(sd);
473 if (ret)
474 return ret;
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200475
Eric W. Biederman6b0bfe92009-11-20 16:08:51 -0800476 /* Update timestamps on the parent */
477 ps_iattr = acxt->parent_sd->s_iattr;
478 if (ps_iattr) {
479 struct iattr *ps_iattrs = &ps_iattr->ia_iattr;
480 ps_iattrs->ia_ctime = ps_iattrs->ia_mtime = CURRENT_TIME;
481 }
482
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200483 return 0;
484}
485
486/**
Alex Chiang425cb022009-02-12 10:56:59 -0700487 * sysfs_pathname - return full path to sysfs dirent
488 * @sd: sysfs_dirent whose path we want
489 * @path: caller allocated buffer
490 *
491 * Gives the name "/" to the sysfs_root entry; any path returned
492 * is relative to wherever sysfs is mounted.
493 *
494 * XXX: does no error checking on @path size
495 */
496static char *sysfs_pathname(struct sysfs_dirent *sd, char *path)
497{
498 if (sd->s_parent) {
499 sysfs_pathname(sd->s_parent, path);
500 strcat(path, "/");
501 }
502 strcat(path, sd->s_name);
503 return path;
504}
505
506/**
Tejun Heofb6896d2007-06-14 04:27:24 +0900507 * sysfs_add_one - add sysfs_dirent to parent
508 * @acxt: addrm context to use
509 * @sd: sysfs_dirent to be added
510 *
511 * Get @acxt->parent_sd and set sd->s_parent to it and increment
Tejun Heo181b2e42007-09-20 16:05:09 +0900512 * nlink of parent inode if @sd is a directory and link into the
513 * children list of the parent.
Tejun Heofb6896d2007-06-14 04:27:24 +0900514 *
515 * This function should be called between calls to
516 * sysfs_addrm_start() and sysfs_addrm_finish() and should be
517 * passed the same @acxt as passed to sysfs_addrm_start().
518 *
519 * LOCKING:
520 * Determined by sysfs_addrm_start().
Tejun Heo23dc2792007-08-02 21:38:03 +0900521 *
522 * RETURNS:
523 * 0 on success, -EEXIST if entry with the given name already
524 * exists.
Tejun Heofb6896d2007-06-14 04:27:24 +0900525 */
Tejun Heo23dc2792007-08-02 21:38:03 +0900526int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
Tejun Heofb6896d2007-06-14 04:27:24 +0900527{
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200528 int ret;
Tejun Heo23dc2792007-08-02 21:38:03 +0900529
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200530 ret = __sysfs_add_one(acxt, sd);
Alex Chiang425cb022009-02-12 10:56:59 -0700531 if (ret == -EEXIST) {
532 char *path = kzalloc(PATH_MAX, GFP_KERNEL);
533 WARN(1, KERN_WARNING
534 "sysfs: cannot create duplicate filename '%s'\n",
535 (path == NULL) ? sd->s_name :
536 strcat(strcat(sysfs_pathname(acxt->parent_sd, path), "/"),
537 sd->s_name));
538 kfree(path);
539 }
540
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200541 return ret;
Tejun Heofb6896d2007-06-14 04:27:24 +0900542}
543
544/**
545 * sysfs_remove_one - remove sysfs_dirent from parent
546 * @acxt: addrm context to use
Jean Delvare9fd5b1c2008-01-08 18:11:24 +0100547 * @sd: sysfs_dirent to be removed
Tejun Heofb6896d2007-06-14 04:27:24 +0900548 *
549 * Mark @sd removed and drop nlink of parent inode if @sd is a
Tejun Heo181b2e42007-09-20 16:05:09 +0900550 * directory. @sd is unlinked from the children list.
Tejun Heofb6896d2007-06-14 04:27:24 +0900551 *
552 * This function should be called between calls to
553 * sysfs_addrm_start() and sysfs_addrm_finish() and should be
554 * passed the same @acxt as passed to sysfs_addrm_start().
555 *
556 * LOCKING:
557 * Determined by sysfs_addrm_start().
558 */
559void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
560{
Eric W. Biederman6b0bfe92009-11-20 16:08:51 -0800561 struct sysfs_inode_attrs *ps_iattr;
562
Tejun Heo41fc1c22007-08-02 21:38:03 +0900563 BUG_ON(sd->s_flags & SYSFS_FLAG_REMOVED);
564
565 sysfs_unlink_sibling(sd);
Tejun Heofb6896d2007-06-14 04:27:24 +0900566
Eric W. Biederman6b0bfe92009-11-20 16:08:51 -0800567 /* Update timestamps on the parent */
568 ps_iattr = acxt->parent_sd->s_iattr;
569 if (ps_iattr) {
570 struct iattr *ps_iattrs = &ps_iattr->ia_iattr;
571 ps_iattrs->ia_ctime = ps_iattrs->ia_mtime = CURRENT_TIME;
572 }
573
Tejun Heofb6896d2007-06-14 04:27:24 +0900574 sd->s_flags |= SYSFS_FLAG_REMOVED;
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400575 sd->u.removed_list = acxt->removed;
Tejun Heofb6896d2007-06-14 04:27:24 +0900576 acxt->removed = sd;
Tejun Heoa0edd7c2007-06-14 04:27:24 +0900577}
578
579/**
Tejun Heofb6896d2007-06-14 04:27:24 +0900580 * sysfs_addrm_finish - finish up sysfs_dirent add/remove
581 * @acxt: addrm context to finish up
582 *
583 * Finish up sysfs_dirent add/remove. Resources acquired by
584 * sysfs_addrm_start() are released and removed sysfs_dirents are
Eric W. Biedermana16bbc32009-11-20 16:08:55 -0800585 * cleaned up.
Tejun Heofb6896d2007-06-14 04:27:24 +0900586 *
587 * LOCKING:
Eric W. Biedermana16bbc32009-11-20 16:08:55 -0800588 * sysfs_mutex is released.
Tejun Heofb6896d2007-06-14 04:27:24 +0900589 */
Tejun Heo990e53f2007-08-02 21:38:03 +0900590void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt)
Tejun Heofb6896d2007-06-14 04:27:24 +0900591{
592 /* release resources acquired by sysfs_addrm_start() */
593 mutex_unlock(&sysfs_mutex);
Tejun Heofb6896d2007-06-14 04:27:24 +0900594
595 /* kill removed sysfs_dirents */
596 while (acxt->removed) {
597 struct sysfs_dirent *sd = acxt->removed;
598
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400599 acxt->removed = sd->u.removed_list;
Tejun Heofb6896d2007-06-14 04:27:24 +0900600
Tejun Heofb6896d2007-06-14 04:27:24 +0900601 sysfs_deactivate(sd);
Eric W. Biedermane0edd3c2009-03-04 11:57:20 -0800602 unmap_bin_file(sd);
Tejun Heofb6896d2007-06-14 04:27:24 +0900603 sysfs_put(sd);
604 }
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700605}
606
Tejun Heof0b0af42007-06-14 04:27:22 +0900607/**
608 * sysfs_find_dirent - find sysfs_dirent with the given name
609 * @parent_sd: sysfs_dirent to search under
610 * @name: name to look for
Maneesh Sonic5168652006-03-09 19:40:14 +0530611 *
Tejun Heof0b0af42007-06-14 04:27:22 +0900612 * Look for sysfs_dirent with name @name under @parent_sd.
Maneesh Sonic5168652006-03-09 19:40:14 +0530613 *
Tejun Heof0b0af42007-06-14 04:27:22 +0900614 * LOCKING:
Tejun Heo3007e992007-06-14 04:27:23 +0900615 * mutex_lock(sysfs_mutex)
Tejun Heof0b0af42007-06-14 04:27:22 +0900616 *
617 * RETURNS:
618 * Pointer to sysfs_dirent if found, NULL if not.
Maneesh Sonic5168652006-03-09 19:40:14 +0530619 */
Tejun Heof0b0af42007-06-14 04:27:22 +0900620struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700621 const void *ns,
Tejun Heof0b0af42007-06-14 04:27:22 +0900622 const unsigned char *name)
Maneesh Sonic5168652006-03-09 19:40:14 +0530623{
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800624 struct rb_node *node = parent_sd->s_dir.children.rb_node;
625 unsigned int hash;
Maneesh Sonic5168652006-03-09 19:40:14 +0530626
Eric W. Biederman903e21e2011-10-12 22:02:43 +0000627 if (!!sysfs_ns_type(parent_sd) != !!ns) {
628 WARN(1, KERN_WARNING "sysfs: ns %s in '%s' for '%s'\n",
629 sysfs_ns_type(parent_sd)? "required": "invalid",
630 parent_sd->s_name, name);
631 return NULL;
632 }
633
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800634 hash = sysfs_name_hash(ns, name);
635 while (node) {
636 struct sysfs_dirent *sd;
637 int result;
Mikulas Patocka4f72c0c2011-07-25 17:55:57 -0400638
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800639 sd = to_sysfs_dirent(node);
640 result = sysfs_name_compare(hash, ns, name, sd);
641 if (result < 0)
642 node = node->rb_left;
643 else if (result > 0)
644 node = node->rb_right;
645 else
646 return sd;
Mikulas Patocka4f72c0c2011-07-25 17:55:57 -0400647 }
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800648 return NULL;
Tejun Heof0b0af42007-06-14 04:27:22 +0900649}
Maneesh Sonic5168652006-03-09 19:40:14 +0530650
Tejun Heof0b0af42007-06-14 04:27:22 +0900651/**
652 * sysfs_get_dirent - find and get sysfs_dirent with the given name
653 * @parent_sd: sysfs_dirent to search under
654 * @name: name to look for
655 *
656 * Look for sysfs_dirent with name @name under @parent_sd and get
657 * it if found.
658 *
659 * LOCKING:
Tejun Heo3007e992007-06-14 04:27:23 +0900660 * Kernel thread context (may sleep). Grabs sysfs_mutex.
Tejun Heof0b0af42007-06-14 04:27:22 +0900661 *
662 * RETURNS:
663 * Pointer to sysfs_dirent if found, NULL if not.
664 */
665struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700666 const void *ns,
Tejun Heof0b0af42007-06-14 04:27:22 +0900667 const unsigned char *name)
668{
669 struct sysfs_dirent *sd;
670
Tejun Heo3007e992007-06-14 04:27:23 +0900671 mutex_lock(&sysfs_mutex);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700672 sd = sysfs_find_dirent(parent_sd, ns, name);
Tejun Heof0b0af42007-06-14 04:27:22 +0900673 sysfs_get(sd);
Tejun Heo3007e992007-06-14 04:27:23 +0900674 mutex_unlock(&sysfs_mutex);
Tejun Heof0b0af42007-06-14 04:27:22 +0900675
676 return sd;
Maneesh Sonic5168652006-03-09 19:40:14 +0530677}
Neil Brownf1282c82008-07-16 08:58:04 +1000678EXPORT_SYMBOL_GPL(sysfs_get_dirent);
Maneesh Sonic5168652006-03-09 19:40:14 +0530679
Tejun Heo608e2662007-06-14 04:27:22 +0900680static int create_dir(struct kobject *kobj, struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700681 enum kobj_ns_type type, const void *ns, const char *name,
682 struct sysfs_dirent **p_sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 umode_t mode = S_IFDIR| S_IRWXU | S_IRUGO | S_IXUGO;
Tejun Heo51225032007-06-14 04:27:25 +0900685 struct sysfs_addrm_cxt acxt;
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900686 struct sysfs_dirent *sd;
Tejun Heo23dc2792007-08-02 21:38:03 +0900687 int rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688
Tejun Heofc9f54b2007-06-14 03:45:17 +0900689 /* allocate */
Tejun Heo3e519032007-06-14 03:45:15 +0900690 sd = sysfs_new_dirent(name, mode, SYSFS_DIR);
Tejun Heoa26cd722007-06-14 03:45:14 +0900691 if (!sd)
Tejun Heo51225032007-06-14 04:27:25 +0900692 return -ENOMEM;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700693
694 sd->s_flags |= (type << SYSFS_NS_TYPE_SHIFT);
695 sd->s_ns = ns;
Tejun Heob1fc3d62007-09-20 16:05:11 +0900696 sd->s_dir.kobj = kobj;
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900697
Tejun Heo51225032007-06-14 04:27:25 +0900698 /* link in */
699 sysfs_addrm_start(&acxt, parent_sd);
Tejun Heo23dc2792007-08-02 21:38:03 +0900700 rc = sysfs_add_one(&acxt, sd);
701 sysfs_addrm_finish(&acxt);
Tejun Heo967e35d2007-07-18 16:38:11 +0900702
Tejun Heo23dc2792007-08-02 21:38:03 +0900703 if (rc == 0)
704 *p_sd = sd;
705 else
Tejun Heo967e35d2007-07-18 16:38:11 +0900706 sysfs_put(sd);
Tejun Heofc9f54b2007-06-14 03:45:17 +0900707
Tejun Heo23dc2792007-08-02 21:38:03 +0900708 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709}
710
Tejun Heo608e2662007-06-14 04:27:22 +0900711int sysfs_create_subdir(struct kobject *kobj, const char *name,
712 struct sysfs_dirent **p_sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713{
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700714 return create_dir(kobj, kobj->sd,
715 KOBJ_NS_TYPE_NONE, NULL, name, p_sd);
716}
717
Serge E. Hallynbe867b12010-05-03 16:23:15 -0500718/**
719 * sysfs_read_ns_type: return associated ns_type
720 * @kobj: the kobject being queried
721 *
722 * Each kobject can be tagged with exactly one namespace type
723 * (i.e. network or user). Return the ns_type associated with
724 * this object if any
725 */
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700726static enum kobj_ns_type sysfs_read_ns_type(struct kobject *kobj)
727{
728 const struct kobj_ns_type_operations *ops;
729 enum kobj_ns_type type;
730
731 ops = kobj_child_ns_ops(kobj);
732 if (!ops)
733 return KOBJ_NS_TYPE_NONE;
734
735 type = ops->type;
736 BUG_ON(type <= KOBJ_NS_TYPE_NONE);
737 BUG_ON(type >= KOBJ_NS_TYPES);
738 BUG_ON(!kobj_ns_type_registered(type));
739
740 return type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741}
742
743/**
744 * sysfs_create_dir - create a directory for an object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 * @kobj: object we're creating directory for.
746 */
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900747int sysfs_create_dir(struct kobject * kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748{
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700749 enum kobj_ns_type type;
Tejun Heo608e2662007-06-14 04:27:22 +0900750 struct sysfs_dirent *parent_sd, *sd;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700751 const void *ns = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 int error = 0;
753
754 BUG_ON(!kobj);
755
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900756 if (kobj->parent)
Tejun Heo608e2662007-06-14 04:27:22 +0900757 parent_sd = kobj->parent->sd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 else
Eric W. Biederman7d0c7d62007-08-20 21:36:30 +0900759 parent_sd = &sysfs_root;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760
Dan Williams3a198882012-04-06 13:41:06 -0700761 if (!parent_sd)
762 return -ENOENT;
763
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700764 if (sysfs_ns_type(parent_sd))
765 ns = kobj->ktype->namespace(kobj);
766 type = sysfs_read_ns_type(kobj);
767
768 error = create_dir(kobj, parent_sd, type, ns, kobject_name(kobj), &sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 if (!error)
Tejun Heo608e2662007-06-14 04:27:22 +0900770 kobj->sd = sd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 return error;
772}
773
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774static struct dentry * sysfs_lookup(struct inode *dir, struct dentry *dentry,
775 struct nameidata *nd)
776{
Tejun Heo6cb52142007-07-31 19:15:08 +0900777 struct dentry *ret = NULL;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700778 struct dentry *parent = dentry->d_parent;
779 struct sysfs_dirent *parent_sd = parent->d_fsdata;
Tejun Heoa7a04752007-08-02 21:38:02 +0900780 struct sysfs_dirent *sd;
Tejun Heofc9f54b2007-06-14 03:45:17 +0900781 struct inode *inode;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700782 enum kobj_ns_type type;
783 const void *ns;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784
Tejun Heo6cb52142007-07-31 19:15:08 +0900785 mutex_lock(&sysfs_mutex);
786
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700787 type = sysfs_ns_type(parent_sd);
788 ns = sysfs_info(dir->i_sb)->ns[type];
789
790 sd = sysfs_find_dirent(parent_sd, ns, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791
Tejun Heofc9f54b2007-06-14 03:45:17 +0900792 /* no such entry */
Tejun Heoe49452c2008-01-16 12:06:14 +0900793 if (!sd) {
794 ret = ERR_PTR(-ENOENT);
Tejun Heo6cb52142007-07-31 19:15:08 +0900795 goto out_unlock;
Tejun Heoe49452c2008-01-16 12:06:14 +0900796 }
Tejun Heofc9f54b2007-06-14 03:45:17 +0900797
798 /* attach dentry and inode */
Eric W. Biedermanfac26222010-02-12 19:22:27 -0800799 inode = sysfs_get_inode(dir->i_sb, sd);
Tejun Heo6cb52142007-07-31 19:15:08 +0900800 if (!inode) {
801 ret = ERR_PTR(-ENOMEM);
802 goto out_unlock;
803 }
Tejun Heo3007e992007-06-14 04:27:23 +0900804
Tejun Heod6b4fd22007-09-20 16:05:11 +0900805 /* instantiate and hash dentry */
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800806 ret = d_find_alias(inode);
807 if (!ret) {
Nick Pigginfb045ad2011-01-07 17:49:55 +1100808 d_set_d_op(dentry, &sysfs_dentry_ops);
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800809 dentry->d_fsdata = sysfs_get(sd);
810 d_add(dentry, inode);
811 } else {
812 d_move(ret, dentry);
813 iput(inode);
814 }
Tejun Heofc9f54b2007-06-14 03:45:17 +0900815
Tejun Heo6cb52142007-07-31 19:15:08 +0900816 out_unlock:
Tejun Heo3007e992007-06-14 04:27:23 +0900817 mutex_unlock(&sysfs_mutex);
Tejun Heo6cb52142007-07-31 19:15:08 +0900818 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819}
820
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800821const struct inode_operations sysfs_dir_inode_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 .lookup = sysfs_lookup,
Eric W. Biedermane61ab4a2009-11-20 16:08:53 -0800823 .permission = sysfs_permission,
Maneesh Soni988d1862005-05-31 10:39:14 +0530824 .setattr = sysfs_setattr,
Eric W. Biedermane61ab4a2009-11-20 16:08:53 -0800825 .getattr = sysfs_getattr,
David P. Quigleyddd29ec2009-09-09 14:25:37 -0400826 .setxattr = sysfs_setxattr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827};
828
Tejun Heo608e2662007-06-14 04:27:22 +0900829static void remove_dir(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830{
Tejun Heofb6896d2007-06-14 04:27:24 +0900831 struct sysfs_addrm_cxt acxt;
832
833 sysfs_addrm_start(&acxt, sd->s_parent);
Tejun Heofb6896d2007-06-14 04:27:24 +0900834 sysfs_remove_one(&acxt, sd);
835 sysfs_addrm_finish(&acxt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836}
837
Tejun Heo608e2662007-06-14 04:27:22 +0900838void sysfs_remove_subdir(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839{
Tejun Heo608e2662007-06-14 04:27:22 +0900840 remove_dir(sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841}
842
843
Tejun Heo608e2662007-06-14 04:27:22 +0900844static void __sysfs_remove_dir(struct sysfs_dirent *dir_sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845{
Tejun Heofb6896d2007-06-14 04:27:24 +0900846 struct sysfs_addrm_cxt acxt;
Mikulas Patockaa406f752011-07-25 17:57:03 -0400847 struct rb_node *pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848
Tejun Heo608e2662007-06-14 04:27:22 +0900849 if (!dir_sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 return;
851
Tejun Heo608e2662007-06-14 04:27:22 +0900852 pr_debug("sysfs %s: removing dir\n", dir_sd->s_name);
Tejun Heofb6896d2007-06-14 04:27:24 +0900853 sysfs_addrm_start(&acxt, dir_sd);
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800854 pos = rb_first(&dir_sd->s_dir.children);
Mikulas Patockaa406f752011-07-25 17:57:03 -0400855 while (pos) {
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800856 struct sysfs_dirent *sd = to_sysfs_dirent(pos);
Mikulas Patockaa406f752011-07-25 17:57:03 -0400857 pos = rb_next(pos);
Eric W. Biederman3efa65b2007-08-20 21:36:30 +0900858 if (sysfs_type(sd) != SYSFS_DIR)
Tejun Heofb6896d2007-06-14 04:27:24 +0900859 sysfs_remove_one(&acxt, sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 }
Tejun Heofb6896d2007-06-14 04:27:24 +0900861 sysfs_addrm_finish(&acxt);
Tejun Heo0ab66082007-06-14 03:45:16 +0900862
Tejun Heo608e2662007-06-14 04:27:22 +0900863 remove_dir(dir_sd);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700864}
865
866/**
867 * sysfs_remove_dir - remove an object's directory.
868 * @kobj: object.
869 *
870 * The only thing special about this is that we remove any files in
871 * the directory before we remove the directory, and we've inlined
872 * what used to be sysfs_rmdir() below, instead of calling separately.
873 */
874
875void sysfs_remove_dir(struct kobject * kobj)
876{
Tejun Heo608e2662007-06-14 04:27:22 +0900877 struct sysfs_dirent *sd = kobj->sd;
Tejun Heoaecdced2007-06-14 03:45:15 +0900878
Tejun Heo5f995322007-06-14 04:27:23 +0900879 spin_lock(&sysfs_assoc_lock);
Tejun Heo608e2662007-06-14 04:27:22 +0900880 kobj->sd = NULL;
Tejun Heo5f995322007-06-14 04:27:23 +0900881 spin_unlock(&sysfs_assoc_lock);
Tejun Heoaecdced2007-06-14 03:45:15 +0900882
Tejun Heo608e2662007-06-14 04:27:22 +0900883 __sysfs_remove_dir(sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884}
885
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800886int sysfs_rename(struct sysfs_dirent *sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700887 struct sysfs_dirent *new_parent_sd, const void *new_ns,
888 const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889{
Tejun Heo996b7372007-06-14 03:45:14 +0900890 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800892 mutex_lock(&sysfs_mutex);
Eric W. Biederman932ea2e2007-08-20 21:36:30 +0900893
Eric W. Biederman9918f9a2007-08-20 21:36:31 +0900894 error = 0;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700895 if ((sd->s_parent == new_parent_sd) && (sd->s_ns == new_ns) &&
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800896 (strcmp(sd->s_name, new_name) == 0))
Eric W. Biederman9918f9a2007-08-20 21:36:31 +0900897 goto out; /* nothing to rename */
898
Tejun Heo996b7372007-06-14 03:45:14 +0900899 error = -EEXIST;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700900 if (sysfs_find_dirent(new_parent_sd, new_ns, new_name))
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800901 goto out;
Tejun Heo996b7372007-06-14 03:45:14 +0900902
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700903 /* rename sysfs_dirent */
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800904 if (strcmp(sd->s_name, new_name) != 0) {
905 error = -ENOMEM;
Sasikantha babub4eafca2012-05-03 02:26:14 +0530906 new_name = kstrdup(new_name, GFP_KERNEL);
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800907 if (!new_name)
908 goto out;
Tejun Heo996b7372007-06-14 03:45:14 +0900909
Sasikantha babub4eafca2012-05-03 02:26:14 +0530910 kfree(sd->s_name);
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800911 sd->s_name = new_name;
912 }
913
Eric W. Biedermanf6d90b42011-11-01 07:06:17 -0700914 /* Move to the appropriate place in the appropriate directories rbtree. */
915 sysfs_unlink_sibling(sd);
916 sysfs_get(new_parent_sd);
917 sysfs_put(sd->s_parent);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700918 sd->s_ns = new_ns;
Tom Goff70fa4a62012-04-04 12:06:20 -0700919 sd->s_hash = sysfs_name_hash(sd->s_ns, sd->s_name);
Eric W. Biedermanf6d90b42011-11-01 07:06:17 -0700920 sd->s_parent = new_parent_sd;
921 sysfs_link_sibling(sd);
Tejun Heo0c096b52007-06-14 03:45:15 +0900922
Tejun Heo996b7372007-06-14 03:45:14 +0900923 error = 0;
Eric W. Biederman9918f9a2007-08-20 21:36:31 +0900924 out:
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800925 mutex_unlock(&sysfs_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 return error;
927}
928
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800929int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
930{
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700931 struct sysfs_dirent *parent_sd = kobj->sd->s_parent;
932 const void *new_ns = NULL;
933
934 if (sysfs_ns_type(parent_sd))
935 new_ns = kobj->ktype->namespace(kobj);
936
937 return sysfs_rename(kobj->sd, parent_sd, new_ns, new_name);
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800938}
939
Tejun Heo51225032007-06-14 04:27:25 +0900940int sysfs_move_dir(struct kobject *kobj, struct kobject *new_parent_kobj)
Cornelia Huck8a824722006-11-20 17:07:51 +0100941{
Tejun Heo51225032007-06-14 04:27:25 +0900942 struct sysfs_dirent *sd = kobj->sd;
943 struct sysfs_dirent *new_parent_sd;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700944 const void *new_ns = NULL;
Cornelia Huck8a824722006-11-20 17:07:51 +0100945
Tejun Heo51225032007-06-14 04:27:25 +0900946 BUG_ON(!sd->s_parent);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700947 if (sysfs_ns_type(sd->s_parent))
948 new_ns = kobj->ktype->namespace(kobj);
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800949 new_parent_sd = new_parent_kobj && new_parent_kobj->sd ?
Cornelia Hucka6a83572009-10-06 15:33:35 +0200950 new_parent_kobj->sd : &sysfs_root;
Cornelia Huck8a824722006-11-20 17:07:51 +0100951
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700952 return sysfs_rename(sd, new_parent_sd, new_ns, sd->s_name);
Cornelia Huck8a824722006-11-20 17:07:51 +0100953}
954
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955/* Relationship between s_mode and the DT_xxx types */
956static inline unsigned char dt_type(struct sysfs_dirent *sd)
957{
958 return (sd->s_mode >> 12) & 15;
959}
960
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800961static int sysfs_dir_release(struct inode *inode, struct file *filp)
962{
963 sysfs_put(filp->private_data);
964 return 0;
965}
966
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700967static struct sysfs_dirent *sysfs_dir_pos(const void *ns,
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800968 struct sysfs_dirent *parent_sd, loff_t hash, struct sysfs_dirent *pos)
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800969{
970 if (pos) {
971 int valid = !(pos->s_flags & SYSFS_FLAG_REMOVED) &&
972 pos->s_parent == parent_sd &&
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800973 hash == pos->s_hash;
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800974 sysfs_put(pos);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700975 if (!valid)
976 pos = NULL;
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800977 }
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800978 if (!pos && (hash > 1) && (hash < INT_MAX)) {
979 struct rb_node *node = parent_sd->s_dir.children.rb_node;
980 while (node) {
981 pos = to_sysfs_dirent(node);
982
983 if (hash < pos->s_hash)
984 node = node->rb_left;
985 else if (hash > pos->s_hash)
986 node = node->rb_right;
987 else
Mikulas Patockaa406f752011-07-25 17:57:03 -0400988 break;
Mikulas Patockaa406f752011-07-25 17:57:03 -0400989 }
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800990 }
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800991 /* Skip over entries in the wrong namespace */
Eric W. Biedermanb9e2780d2011-10-25 05:38:41 -0700992 while (pos && pos->s_ns != ns) {
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800993 struct rb_node *node = rb_next(&pos->s_rb);
994 if (!node)
Mikulas Patockaa406f752011-07-25 17:57:03 -0400995 pos = NULL;
996 else
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800997 pos = to_sysfs_dirent(node);
Mikulas Patockaa406f752011-07-25 17:57:03 -0400998 }
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800999 return pos;
1000}
1001
Eric W. Biederman3ff195b2010-03-30 11:31:26 -07001002static struct sysfs_dirent *sysfs_dir_next_pos(const void *ns,
1003 struct sysfs_dirent *parent_sd, ino_t ino, struct sysfs_dirent *pos)
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001004{
Eric W. Biederman3ff195b2010-03-30 11:31:26 -07001005 pos = sysfs_dir_pos(ns, parent_sd, ino, pos);
Mikulas Patockaa406f752011-07-25 17:57:03 -04001006 if (pos) do {
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -08001007 struct rb_node *node = rb_next(&pos->s_rb);
1008 if (!node)
Mikulas Patockaa406f752011-07-25 17:57:03 -04001009 pos = NULL;
1010 else
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -08001011 pos = to_sysfs_dirent(node);
Eric W. Biedermanb9e2780d2011-10-25 05:38:41 -07001012 } while (pos && pos->s_ns != ns);
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001013 return pos;
1014}
1015
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016static int sysfs_readdir(struct file * filp, void * dirent, filldir_t filldir)
1017{
Josef "Jeff" Sipekf427f5d2006-12-08 02:36:36 -08001018 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 struct sysfs_dirent * parent_sd = dentry->d_fsdata;
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001020 struct sysfs_dirent *pos = filp->private_data;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -07001021 enum kobj_ns_type type;
1022 const void *ns;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 ino_t ino;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024
Eric W. Biederman3ff195b2010-03-30 11:31:26 -07001025 type = sysfs_ns_type(parent_sd);
1026 ns = sysfs_info(dentry->d_sb)->ns[type];
1027
Eric W. Biederman3efa65b2007-08-20 21:36:30 +09001028 if (filp->f_pos == 0) {
1029 ino = parent_sd->s_ino;
1030 if (filldir(dirent, ".", 1, filp->f_pos, ino, DT_DIR) == 0)
1031 filp->f_pos++;
1032 }
1033 if (filp->f_pos == 1) {
1034 if (parent_sd->s_parent)
1035 ino = parent_sd->s_parent->s_ino;
1036 else
Eric Sandeendc351252007-06-11 14:02:45 +09001037 ino = parent_sd->s_ino;
Eric W. Biederman3efa65b2007-08-20 21:36:30 +09001038 if (filldir(dirent, "..", 2, filp->f_pos, ino, DT_DIR) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 filp->f_pos++;
Eric W. Biederman3efa65b2007-08-20 21:36:30 +09001040 }
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001041 mutex_lock(&sysfs_mutex);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -07001042 for (pos = sysfs_dir_pos(ns, parent_sd, filp->f_pos, pos);
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001043 pos;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -07001044 pos = sysfs_dir_next_pos(ns, parent_sd, filp->f_pos, pos)) {
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001045 const char * name;
1046 unsigned int type;
1047 int len, ret;
Eric W. Biederman3efa65b2007-08-20 21:36:30 +09001048
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001049 name = pos->s_name;
1050 len = strlen(name);
1051 ino = pos->s_ino;
1052 type = dt_type(pos);
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -08001053 filp->f_pos = pos->s_hash;
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001054 filp->private_data = sysfs_get(pos);
Eric W. Biederman3efa65b2007-08-20 21:36:30 +09001055
Eric W. Biederman3efa65b2007-08-20 21:36:30 +09001056 mutex_unlock(&sysfs_mutex);
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001057 ret = filldir(dirent, name, len, filp->f_pos, ino, type);
1058 mutex_lock(&sysfs_mutex);
1059 if (ret < 0)
1060 break;
1061 }
1062 mutex_unlock(&sysfs_mutex);
1063 if ((filp->f_pos > 1) && !pos) { /* EOF */
1064 filp->f_pos = INT_MAX;
1065 filp->private_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 }
1067 return 0;
1068}
1069
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08001071const struct file_operations sysfs_dir_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 .read = generic_read_dir,
1073 .readdir = sysfs_readdir,
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001074 .release = sysfs_dir_release,
Christoph Hellwig3222a3e2008-09-03 21:53:01 +02001075 .llseek = generic_file_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076};