blob: e068e744dbddf4a4c1e43b00720d7c8ec24cae8b [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/**
Warner Wang43474912013-05-13 11:11:05 +080077 * sysfs_link_sibling - 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
Maarten Lankhorst3db3c622013-03-08 16:07:27 +0100168 if (!atomic_inc_unless_negative(&sd->s_active))
169 return NULL;
Alan Stern356c05d2012-05-14 13:30:03 -0400170
171 if (likely(!ignore_lockdep(sd)))
172 rwsem_acquire_read(&sd->dep_map, 0, 1, _RET_IP_);
173 return sd;
Tejun Heob6b4a432007-06-14 03:45:18 +0900174}
175
176/**
177 * sysfs_put_active - put an active reference to sysfs_dirent
178 * @sd: sysfs_dirent to put an active reference to
179 *
180 * Put an active reference to @sd. This function is noop if @sd
181 * is NULL.
182 */
Eric W. Biedermane72ceb82010-02-11 15:18:38 -0800183void sysfs_put_active(struct sysfs_dirent *sd)
Tejun Heob6b4a432007-06-14 03:45:18 +0900184{
Tejun Heo8619f972007-06-14 03:45:18 +0900185 int v;
186
187 if (unlikely(!sd))
188 return;
189
Alan Stern356c05d2012-05-14 13:30:03 -0400190 if (likely(!ignore_lockdep(sd)))
191 rwsem_release(&sd->dep_map, 1, _RET_IP_);
Tejun Heo8619f972007-06-14 03:45:18 +0900192 v = atomic_dec_return(&sd->s_active);
193 if (likely(v != SD_DEACTIVATED_BIAS))
194 return;
195
196 /* atomic_dec_return() is a mb(), we'll always see the updated
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400197 * sd->u.completion.
Tejun Heo8619f972007-06-14 03:45:18 +0900198 */
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400199 complete(sd->u.completion);
Tejun Heob6b4a432007-06-14 03:45:18 +0900200}
201
202/**
Tejun Heob6b4a432007-06-14 03:45:18 +0900203 * sysfs_deactivate - deactivate sysfs_dirent
204 * @sd: sysfs_dirent to deactivate
205 *
Tejun Heo8619f972007-06-14 03:45:18 +0900206 * Deny new active references and drain existing ones.
Tejun Heob6b4a432007-06-14 03:45:18 +0900207 */
Tejun Heofb6896d2007-06-14 04:27:24 +0900208static void sysfs_deactivate(struct sysfs_dirent *sd)
Tejun Heob6b4a432007-06-14 03:45:18 +0900209{
Tejun Heo8619f972007-06-14 03:45:18 +0900210 DECLARE_COMPLETION_ONSTACK(wait);
211 int v;
Tejun Heob6b4a432007-06-14 03:45:18 +0900212
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400213 BUG_ON(!(sd->s_flags & SYSFS_FLAG_REMOVED));
Eric W. Biedermana2db6842010-02-11 15:20:00 -0800214
215 if (!(sysfs_type(sd) & SYSFS_ACTIVE_REF))
216 return;
217
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400218 sd->u.completion = (void *)&wait;
Tejun Heo8619f972007-06-14 03:45:18 +0900219
Eric W. Biederman846f9972010-01-02 13:37:12 -0800220 rwsem_acquire(&sd->dep_map, 0, 0, _RET_IP_);
Tejun Heo8619f972007-06-14 03:45:18 +0900221 /* atomic_add_return() is a mb(), put_active() will always see
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400222 * the updated sd->u.completion.
Tejun Heob6b4a432007-06-14 03:45:18 +0900223 */
Tejun Heo8619f972007-06-14 03:45:18 +0900224 v = atomic_add_return(SD_DEACTIVATED_BIAS, &sd->s_active);
225
Eric W. Biederman846f9972010-01-02 13:37:12 -0800226 if (v != SD_DEACTIVATED_BIAS) {
227 lock_contended(&sd->dep_map, _RET_IP_);
Tejun Heo8619f972007-06-14 03:45:18 +0900228 wait_for_completion(&wait);
Eric W. Biederman846f9972010-01-02 13:37:12 -0800229 }
Tejun Heo8619f972007-06-14 03:45:18 +0900230
Eric W. Biederman846f9972010-01-02 13:37:12 -0800231 lock_acquired(&sd->dep_map, _RET_IP_);
232 rwsem_release(&sd->dep_map, 1, _RET_IP_);
Tejun Heob6b4a432007-06-14 03:45:18 +0900233}
234
Eric W. Biedermancafa6b52011-12-18 20:08:16 -0800235static int sysfs_alloc_ino(unsigned int *pino)
Tejun Heo2b611bb2007-06-14 03:45:13 +0900236{
237 int ino, rc;
238
239 retry:
240 spin_lock(&sysfs_ino_lock);
241 rc = ida_get_new_above(&sysfs_ino_ida, 2, &ino);
242 spin_unlock(&sysfs_ino_lock);
243
244 if (rc == -EAGAIN) {
245 if (ida_pre_get(&sysfs_ino_ida, GFP_KERNEL))
246 goto retry;
247 rc = -ENOMEM;
248 }
249
250 *pino = ino;
251 return rc;
252}
253
Eric W. Biedermancafa6b52011-12-18 20:08:16 -0800254static void sysfs_free_ino(unsigned int ino)
Tejun Heo2b611bb2007-06-14 03:45:13 +0900255{
256 spin_lock(&sysfs_ino_lock);
257 ida_remove(&sysfs_ino_ida, ino);
258 spin_unlock(&sysfs_ino_lock);
259}
260
Tejun Heofa7f9122007-06-14 03:45:13 +0900261void release_sysfs_dirent(struct sysfs_dirent * sd)
262{
Tejun Heo13b30862007-06-14 03:45:14 +0900263 struct sysfs_dirent *parent_sd;
264
265 repeat:
Tejun Heo3007e992007-06-14 04:27:23 +0900266 /* Moving/renaming is always done while holding reference.
267 * sd->s_parent won't change beneath us.
268 */
Tejun Heo13b30862007-06-14 03:45:14 +0900269 parent_sd = sd->s_parent;
270
Ming Leibb2b0052013-04-04 22:22:37 +0800271 WARN(!(sd->s_flags & SYSFS_FLAG_REMOVED),
272 "sysfs: free using entry: %s/%s\n",
273 parent_sd ? parent_sd->s_name : "", sd->s_name);
274
Tejun Heob402d722007-06-14 04:27:21 +0900275 if (sysfs_type(sd) == SYSFS_KOBJ_LINK)
Tejun Heob1fc3d62007-09-20 16:05:11 +0900276 sysfs_put(sd->s_symlink.target_sd);
Tejun Heob402d722007-06-14 04:27:21 +0900277 if (sysfs_type(sd) & SYSFS_COPY_NAME)
Tejun Heo0c096b52007-06-14 03:45:15 +0900278 kfree(sd->s_name);
Eric W. Biederman4c3da222009-11-04 02:50:06 -0800279 if (sd->s_iattr && sd->s_iattr->ia_secdata)
280 security_release_secctx(sd->s_iattr->ia_secdata,
281 sd->s_iattr->ia_secdata_len);
Tejun Heofa7f9122007-06-14 03:45:13 +0900282 kfree(sd->s_iattr);
Tejun Heo2b611bb2007-06-14 03:45:13 +0900283 sysfs_free_ino(sd->s_ino);
Tejun Heofa7f9122007-06-14 03:45:13 +0900284 kmem_cache_free(sysfs_dir_cachep, sd);
Tejun Heo13b30862007-06-14 03:45:14 +0900285
286 sd = parent_sd;
287 if (sd && atomic_dec_and_test(&sd->s_count))
288 goto repeat;
Tejun Heofa7f9122007-06-14 03:45:13 +0900289}
290
Nick Pigginfe15ce42011-01-07 17:49:23 +1100291static int sysfs_dentry_delete(const struct dentry *dentry)
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800292{
293 struct sysfs_dirent *sd = dentry->d_fsdata;
Al Viro469796d2012-06-07 20:51:39 -0400294 return !(sd && !(sd->s_flags & SYSFS_FLAG_REMOVED));
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800295}
296
Al Viro0b728e12012-06-10 16:03:43 -0400297static int sysfs_dentry_revalidate(struct dentry *dentry, unsigned int flags)
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800298{
Nick Piggin34286d62011-01-07 17:49:57 +1100299 struct sysfs_dirent *sd;
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800300 int is_dir;
Glauber Costae5bcac62012-07-06 13:09:07 +0400301 int type;
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800302
Al Viro0b728e12012-06-10 16:03:43 -0400303 if (flags & LOOKUP_RCU)
Nick Piggin34286d62011-01-07 17:49:57 +1100304 return -ECHILD;
305
306 sd = dentry->d_fsdata;
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800307 mutex_lock(&sysfs_mutex);
308
309 /* The sysfs dirent has been deleted */
310 if (sd->s_flags & SYSFS_FLAG_REMOVED)
311 goto out_bad;
312
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800313 /* The sysfs dirent has been moved? */
314 if (dentry->d_parent->d_fsdata != sd->s_parent)
315 goto out_bad;
316
317 /* The sysfs dirent has been renamed */
318 if (strcmp(dentry->d_name.name, sd->s_name) != 0)
319 goto out_bad;
320
Glauber Costae5bcac62012-07-06 13:09:07 +0400321 /* The sysfs dirent has been moved to a different namespace */
322 type = KOBJ_NS_TYPE_NONE;
Andrew Morton17f79be2012-07-09 16:13:36 -0700323 if (sd->s_parent) {
Glauber Costae5bcac62012-07-06 13:09:07 +0400324 type = sysfs_ns_type(sd->s_parent);
Andrew Morton17f79be2012-07-09 16:13:36 -0700325 if (type != KOBJ_NS_TYPE_NONE &&
326 sysfs_info(dentry->d_sb)->ns[type] != sd->s_ns)
327 goto out_bad;
328 }
Glauber Costae5bcac62012-07-06 13:09:07 +0400329
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800330 mutex_unlock(&sysfs_mutex);
331out_valid:
332 return 1;
333out_bad:
334 /* Remove the dentry from the dcache hashes.
335 * If this is a deleted dentry we use d_drop instead of d_delete
336 * so sysfs doesn't need to cope with negative dentries.
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800337 *
338 * If this is a dentry that has simply been renamed we
339 * use d_drop to remove it from the dcache lookup on its
340 * old parent. If this dentry persists later when a lookup
341 * is performed at its new name the dentry will be readded
342 * to the dcache hashes.
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800343 */
344 is_dir = (sysfs_type(sd) == SYSFS_DIR);
345 mutex_unlock(&sysfs_mutex);
346 if (is_dir) {
347 /* If we have submounts we must allow the vfs caches
348 * to lie about the state of the filesystem to prevent
349 * leaks and other nasty things.
350 */
351 if (have_submounts(dentry))
352 goto out_valid;
353 shrink_dcache_parent(dentry);
354 }
355 d_drop(dentry);
356 return 0;
357}
358
Al Viro469796d2012-06-07 20:51:39 -0400359static void sysfs_dentry_release(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360{
Al Viro469796d2012-06-07 20:51:39 -0400361 sysfs_put(dentry->d_fsdata);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362}
363
Al Viro469796d2012-06-07 20:51:39 -0400364const struct dentry_operations sysfs_dentry_ops = {
Eric W. Biedermane8f077c2009-11-07 23:27:01 -0800365 .d_revalidate = sysfs_dentry_revalidate,
366 .d_delete = sysfs_dentry_delete,
Al Viro469796d2012-06-07 20:51:39 -0400367 .d_release = sysfs_dentry_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368};
369
Tejun Heo3e519032007-06-14 03:45:15 +0900370struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371{
Tejun Heo0c096b52007-06-14 03:45:15 +0900372 char *dup_name = NULL;
Akinobu Mita01da2422007-07-14 11:03:35 +0900373 struct sysfs_dirent *sd;
Tejun Heo0c096b52007-06-14 03:45:15 +0900374
375 if (type & SYSFS_COPY_NAME) {
376 name = dup_name = kstrdup(name, GFP_KERNEL);
377 if (!name)
Akinobu Mita01da2422007-07-14 11:03:35 +0900378 return NULL;
Tejun Heo0c096b52007-06-14 03:45:15 +0900379 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
Robert P. J. Dayc3762222007-02-10 01:45:03 -0800381 sd = kmem_cache_zalloc(sysfs_dir_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 if (!sd)
Akinobu Mita01da2422007-07-14 11:03:35 +0900383 goto err_out1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
Tejun Heo0c096b52007-06-14 03:45:15 +0900385 if (sysfs_alloc_ino(&sd->s_ino))
Akinobu Mita01da2422007-07-14 11:03:35 +0900386 goto err_out2;
Tejun Heo2b611bb2007-06-14 03:45:13 +0900387
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 atomic_set(&sd->s_count, 1);
Tejun Heo8619f972007-06-14 03:45:18 +0900389 atomic_set(&sd->s_active, 0);
Tejun Heoa26cd722007-06-14 03:45:14 +0900390
Tejun Heo0c096b52007-06-14 03:45:15 +0900391 sd->s_name = name;
Tejun Heoa26cd722007-06-14 03:45:14 +0900392 sd->s_mode = mode;
Ming Leibb2b0052013-04-04 22:22:37 +0800393 sd->s_flags = type | SYSFS_FLAG_REMOVED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
395 return sd;
Tejun Heo0c096b52007-06-14 03:45:15 +0900396
Akinobu Mita01da2422007-07-14 11:03:35 +0900397 err_out2:
Tejun Heo0c096b52007-06-14 03:45:15 +0900398 kmem_cache_free(sysfs_dir_cachep, sd);
Akinobu Mita01da2422007-07-14 11:03:35 +0900399 err_out1:
400 kfree(dup_name);
Tejun Heo0c096b52007-06-14 03:45:15 +0900401 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402}
403
Tejun Heo3007e992007-06-14 04:27:23 +0900404/**
Tejun Heofb6896d2007-06-14 04:27:24 +0900405 * sysfs_addrm_start - prepare for sysfs_dirent add/remove
406 * @acxt: pointer to sysfs_addrm_cxt to be used
407 * @parent_sd: parent sysfs_dirent
Tejun Heo3007e992007-06-14 04:27:23 +0900408 *
Tejun Heofb6896d2007-06-14 04:27:24 +0900409 * This function is called when the caller is about to add or
410 * remove sysfs_dirent under @parent_sd. This function acquires
Eric W. Biedermana16bbc32009-11-20 16:08:55 -0800411 * sysfs_mutex. @acxt is used to keep and pass context to
Tejun Heofb6896d2007-06-14 04:27:24 +0900412 * other addrm functions.
Tejun Heo3007e992007-06-14 04:27:23 +0900413 *
414 * LOCKING:
Tejun Heofb6896d2007-06-14 04:27:24 +0900415 * Kernel thread context (may sleep). sysfs_mutex is locked on
Eric W. Biedermana16bbc32009-11-20 16:08:55 -0800416 * return.
Tejun Heo3007e992007-06-14 04:27:23 +0900417 */
Tejun Heofb6896d2007-06-14 04:27:24 +0900418void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
419 struct sysfs_dirent *parent_sd)
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700420{
Tejun Heofb6896d2007-06-14 04:27:24 +0900421 memset(acxt, 0, sizeof(*acxt));
422 acxt->parent_sd = parent_sd;
423
Tejun Heofb6896d2007-06-14 04:27:24 +0900424 mutex_lock(&sysfs_mutex);
Tejun Heofb6896d2007-06-14 04:27:24 +0900425}
426
427/**
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200428 * __sysfs_add_one - add sysfs_dirent to parent without warning
429 * @acxt: addrm context to use
430 * @sd: sysfs_dirent to be added
431 *
432 * Get @acxt->parent_sd and set sd->s_parent to it and increment
433 * nlink of parent inode if @sd is a directory and link into the
434 * children list of the parent.
435 *
436 * This function should be called between calls to
437 * sysfs_addrm_start() and sysfs_addrm_finish() and should be
438 * passed the same @acxt as passed to sysfs_addrm_start().
439 *
440 * LOCKING:
441 * Determined by sysfs_addrm_start().
442 *
443 * RETURNS:
444 * 0 on success, -EEXIST if entry with the given name already
445 * exists.
446 */
447int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
448{
Eric W. Biederman6b0bfe92009-11-20 16:08:51 -0800449 struct sysfs_inode_attrs *ps_iattr;
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800450 int ret;
Eric W. Biederman6b0bfe92009-11-20 16:08:51 -0800451
Eric W. Biederman903e21e2011-10-12 22:02:43 +0000452 if (!!sysfs_ns_type(acxt->parent_sd) != !!sd->s_ns) {
453 WARN(1, KERN_WARNING "sysfs: ns %s in '%s' for '%s'\n",
454 sysfs_ns_type(acxt->parent_sd)? "required": "invalid",
455 acxt->parent_sd->s_name, sd->s_name);
456 return -EINVAL;
457 }
458
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800459 sd->s_hash = sysfs_name_hash(sd->s_ns, sd->s_name);
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200460 sd->s_parent = sysfs_get(acxt->parent_sd);
461
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800462 ret = sysfs_link_sibling(sd);
463 if (ret)
464 return ret;
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200465
Eric W. Biederman6b0bfe92009-11-20 16:08:51 -0800466 /* Update timestamps on the parent */
467 ps_iattr = acxt->parent_sd->s_iattr;
468 if (ps_iattr) {
469 struct iattr *ps_iattrs = &ps_iattr->ia_iattr;
470 ps_iattrs->ia_ctime = ps_iattrs->ia_mtime = CURRENT_TIME;
471 }
472
Ming Leibb2b0052013-04-04 22:22:37 +0800473 /* Mark the entry added into directory tree */
474 sd->s_flags &= ~SYSFS_FLAG_REMOVED;
475
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200476 return 0;
477}
478
479/**
Alex Chiang425cb022009-02-12 10:56:59 -0700480 * sysfs_pathname - return full path to sysfs dirent
481 * @sd: sysfs_dirent whose path we want
Geert Uytterhoeven66081a72012-09-29 22:23:19 +0200482 * @path: caller allocated buffer of size PATH_MAX
Alex Chiang425cb022009-02-12 10:56:59 -0700483 *
484 * Gives the name "/" to the sysfs_root entry; any path returned
485 * is relative to wherever sysfs is mounted.
Alex Chiang425cb022009-02-12 10:56:59 -0700486 */
487static char *sysfs_pathname(struct sysfs_dirent *sd, char *path)
488{
489 if (sd->s_parent) {
490 sysfs_pathname(sd->s_parent, path);
Geert Uytterhoeven66081a72012-09-29 22:23:19 +0200491 strlcat(path, "/", PATH_MAX);
Alex Chiang425cb022009-02-12 10:56:59 -0700492 }
Geert Uytterhoeven66081a72012-09-29 22:23:19 +0200493 strlcat(path, sd->s_name, PATH_MAX);
Alex Chiang425cb022009-02-12 10:56:59 -0700494 return path;
495}
496
497/**
Tejun Heofb6896d2007-06-14 04:27:24 +0900498 * sysfs_add_one - add sysfs_dirent to parent
499 * @acxt: addrm context to use
500 * @sd: sysfs_dirent to be added
501 *
502 * Get @acxt->parent_sd and set sd->s_parent to it and increment
Tejun Heo181b2e42007-09-20 16:05:09 +0900503 * nlink of parent inode if @sd is a directory and link into the
504 * children list of the parent.
Tejun Heofb6896d2007-06-14 04:27:24 +0900505 *
506 * This function should be called between calls to
507 * sysfs_addrm_start() and sysfs_addrm_finish() and should be
508 * passed the same @acxt as passed to sysfs_addrm_start().
509 *
510 * LOCKING:
511 * Determined by sysfs_addrm_start().
Tejun Heo23dc2792007-08-02 21:38:03 +0900512 *
513 * RETURNS:
514 * 0 on success, -EEXIST if entry with the given name already
515 * exists.
Tejun Heofb6896d2007-06-14 04:27:24 +0900516 */
Tejun Heo23dc2792007-08-02 21:38:03 +0900517int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
Tejun Heofb6896d2007-06-14 04:27:24 +0900518{
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200519 int ret;
Tejun Heo23dc2792007-08-02 21:38:03 +0900520
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200521 ret = __sysfs_add_one(acxt, sd);
Alex Chiang425cb022009-02-12 10:56:59 -0700522 if (ret == -EEXIST) {
523 char *path = kzalloc(PATH_MAX, GFP_KERNEL);
524 WARN(1, KERN_WARNING
525 "sysfs: cannot create duplicate filename '%s'\n",
Geert Uytterhoeven66081a72012-09-29 22:23:19 +0200526 (path == NULL) ? sd->s_name
527 : (sysfs_pathname(acxt->parent_sd, path),
528 strlcat(path, "/", PATH_MAX),
529 strlcat(path, sd->s_name, PATH_MAX),
530 path));
Alex Chiang425cb022009-02-12 10:56:59 -0700531 kfree(path);
532 }
533
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200534 return ret;
Tejun Heofb6896d2007-06-14 04:27:24 +0900535}
536
537/**
538 * sysfs_remove_one - remove sysfs_dirent from parent
539 * @acxt: addrm context to use
Jean Delvare9fd5b1c2008-01-08 18:11:24 +0100540 * @sd: sysfs_dirent to be removed
Tejun Heofb6896d2007-06-14 04:27:24 +0900541 *
542 * Mark @sd removed and drop nlink of parent inode if @sd is a
Tejun Heo181b2e42007-09-20 16:05:09 +0900543 * directory. @sd is unlinked from the children list.
Tejun Heofb6896d2007-06-14 04:27:24 +0900544 *
545 * This function should be called between calls to
546 * sysfs_addrm_start() and sysfs_addrm_finish() and should be
547 * passed the same @acxt as passed to sysfs_addrm_start().
548 *
549 * LOCKING:
550 * Determined by sysfs_addrm_start().
551 */
552void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
553{
Eric W. Biederman6b0bfe92009-11-20 16:08:51 -0800554 struct sysfs_inode_attrs *ps_iattr;
555
Tejun Heo41fc1c22007-08-02 21:38:03 +0900556 BUG_ON(sd->s_flags & SYSFS_FLAG_REMOVED);
557
558 sysfs_unlink_sibling(sd);
Tejun Heofb6896d2007-06-14 04:27:24 +0900559
Eric W. Biederman6b0bfe92009-11-20 16:08:51 -0800560 /* Update timestamps on the parent */
561 ps_iattr = acxt->parent_sd->s_iattr;
562 if (ps_iattr) {
563 struct iattr *ps_iattrs = &ps_iattr->ia_iattr;
564 ps_iattrs->ia_ctime = ps_iattrs->ia_mtime = CURRENT_TIME;
565 }
566
Tejun Heofb6896d2007-06-14 04:27:24 +0900567 sd->s_flags |= SYSFS_FLAG_REMOVED;
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400568 sd->u.removed_list = acxt->removed;
Tejun Heofb6896d2007-06-14 04:27:24 +0900569 acxt->removed = sd;
Tejun Heoa0edd7c2007-06-14 04:27:24 +0900570}
571
572/**
Tejun Heofb6896d2007-06-14 04:27:24 +0900573 * sysfs_addrm_finish - finish up sysfs_dirent add/remove
574 * @acxt: addrm context to finish up
575 *
576 * Finish up sysfs_dirent add/remove. Resources acquired by
577 * sysfs_addrm_start() are released and removed sysfs_dirents are
Eric W. Biedermana16bbc32009-11-20 16:08:55 -0800578 * cleaned up.
Tejun Heofb6896d2007-06-14 04:27:24 +0900579 *
580 * LOCKING:
Eric W. Biedermana16bbc32009-11-20 16:08:55 -0800581 * sysfs_mutex is released.
Tejun Heofb6896d2007-06-14 04:27:24 +0900582 */
Tejun Heo990e53f2007-08-02 21:38:03 +0900583void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt)
Tejun Heofb6896d2007-06-14 04:27:24 +0900584{
585 /* release resources acquired by sysfs_addrm_start() */
586 mutex_unlock(&sysfs_mutex);
Tejun Heofb6896d2007-06-14 04:27:24 +0900587
588 /* kill removed sysfs_dirents */
589 while (acxt->removed) {
590 struct sysfs_dirent *sd = acxt->removed;
591
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -0400592 acxt->removed = sd->u.removed_list;
Tejun Heofb6896d2007-06-14 04:27:24 +0900593
Tejun Heofb6896d2007-06-14 04:27:24 +0900594 sysfs_deactivate(sd);
Eric W. Biedermane0edd3c2009-03-04 11:57:20 -0800595 unmap_bin_file(sd);
Tejun Heofb6896d2007-06-14 04:27:24 +0900596 sysfs_put(sd);
597 }
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700598}
599
Tejun Heof0b0af42007-06-14 04:27:22 +0900600/**
601 * sysfs_find_dirent - find sysfs_dirent with the given name
602 * @parent_sd: sysfs_dirent to search under
603 * @name: name to look for
Maneesh Sonic5168652006-03-09 19:40:14 +0530604 *
Tejun Heof0b0af42007-06-14 04:27:22 +0900605 * Look for sysfs_dirent with name @name under @parent_sd.
Maneesh Sonic5168652006-03-09 19:40:14 +0530606 *
Tejun Heof0b0af42007-06-14 04:27:22 +0900607 * LOCKING:
Tejun Heo3007e992007-06-14 04:27:23 +0900608 * mutex_lock(sysfs_mutex)
Tejun Heof0b0af42007-06-14 04:27:22 +0900609 *
610 * RETURNS:
611 * Pointer to sysfs_dirent if found, NULL if not.
Maneesh Sonic5168652006-03-09 19:40:14 +0530612 */
Tejun Heof0b0af42007-06-14 04:27:22 +0900613struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700614 const void *ns,
Tejun Heof0b0af42007-06-14 04:27:22 +0900615 const unsigned char *name)
Maneesh Sonic5168652006-03-09 19:40:14 +0530616{
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800617 struct rb_node *node = parent_sd->s_dir.children.rb_node;
618 unsigned int hash;
Maneesh Sonic5168652006-03-09 19:40:14 +0530619
Eric W. Biederman903e21e2011-10-12 22:02:43 +0000620 if (!!sysfs_ns_type(parent_sd) != !!ns) {
621 WARN(1, KERN_WARNING "sysfs: ns %s in '%s' for '%s'\n",
622 sysfs_ns_type(parent_sd)? "required": "invalid",
623 parent_sd->s_name, name);
624 return NULL;
625 }
626
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800627 hash = sysfs_name_hash(ns, name);
628 while (node) {
629 struct sysfs_dirent *sd;
630 int result;
Mikulas Patocka4f72c0c2011-07-25 17:55:57 -0400631
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800632 sd = to_sysfs_dirent(node);
633 result = sysfs_name_compare(hash, ns, name, sd);
634 if (result < 0)
635 node = node->rb_left;
636 else if (result > 0)
637 node = node->rb_right;
638 else
639 return sd;
Mikulas Patocka4f72c0c2011-07-25 17:55:57 -0400640 }
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800641 return NULL;
Tejun Heof0b0af42007-06-14 04:27:22 +0900642}
Maneesh Sonic5168652006-03-09 19:40:14 +0530643
Tejun Heof0b0af42007-06-14 04:27:22 +0900644/**
645 * sysfs_get_dirent - find and get sysfs_dirent with the given name
646 * @parent_sd: sysfs_dirent to search under
647 * @name: name to look for
648 *
649 * Look for sysfs_dirent with name @name under @parent_sd and get
650 * it if found.
651 *
652 * LOCKING:
Tejun Heo3007e992007-06-14 04:27:23 +0900653 * Kernel thread context (may sleep). Grabs sysfs_mutex.
Tejun Heof0b0af42007-06-14 04:27:22 +0900654 *
655 * RETURNS:
656 * Pointer to sysfs_dirent if found, NULL if not.
657 */
658struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700659 const void *ns,
Tejun Heof0b0af42007-06-14 04:27:22 +0900660 const unsigned char *name)
661{
662 struct sysfs_dirent *sd;
663
Tejun Heo3007e992007-06-14 04:27:23 +0900664 mutex_lock(&sysfs_mutex);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700665 sd = sysfs_find_dirent(parent_sd, ns, name);
Tejun Heof0b0af42007-06-14 04:27:22 +0900666 sysfs_get(sd);
Tejun Heo3007e992007-06-14 04:27:23 +0900667 mutex_unlock(&sysfs_mutex);
Tejun Heof0b0af42007-06-14 04:27:22 +0900668
669 return sd;
Maneesh Sonic5168652006-03-09 19:40:14 +0530670}
Neil Brownf1282c82008-07-16 08:58:04 +1000671EXPORT_SYMBOL_GPL(sysfs_get_dirent);
Maneesh Sonic5168652006-03-09 19:40:14 +0530672
Tejun Heo608e2662007-06-14 04:27:22 +0900673static int create_dir(struct kobject *kobj, struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700674 enum kobj_ns_type type, const void *ns, const char *name,
675 struct sysfs_dirent **p_sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 umode_t mode = S_IFDIR| S_IRWXU | S_IRUGO | S_IXUGO;
Tejun Heo51225032007-06-14 04:27:25 +0900678 struct sysfs_addrm_cxt acxt;
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900679 struct sysfs_dirent *sd;
Tejun Heo23dc2792007-08-02 21:38:03 +0900680 int rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681
Tejun Heofc9f54b2007-06-14 03:45:17 +0900682 /* allocate */
Tejun Heo3e519032007-06-14 03:45:15 +0900683 sd = sysfs_new_dirent(name, mode, SYSFS_DIR);
Tejun Heoa26cd722007-06-14 03:45:14 +0900684 if (!sd)
Tejun Heo51225032007-06-14 04:27:25 +0900685 return -ENOMEM;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700686
687 sd->s_flags |= (type << SYSFS_NS_TYPE_SHIFT);
688 sd->s_ns = ns;
Tejun Heob1fc3d62007-09-20 16:05:11 +0900689 sd->s_dir.kobj = kobj;
Tejun Heodfeb9fb2007-06-14 03:45:14 +0900690
Tejun Heo51225032007-06-14 04:27:25 +0900691 /* link in */
692 sysfs_addrm_start(&acxt, parent_sd);
Tejun Heo23dc2792007-08-02 21:38:03 +0900693 rc = sysfs_add_one(&acxt, sd);
694 sysfs_addrm_finish(&acxt);
Tejun Heo967e35d2007-07-18 16:38:11 +0900695
Tejun Heo23dc2792007-08-02 21:38:03 +0900696 if (rc == 0)
697 *p_sd = sd;
698 else
Tejun Heo967e35d2007-07-18 16:38:11 +0900699 sysfs_put(sd);
Tejun Heofc9f54b2007-06-14 03:45:17 +0900700
Tejun Heo23dc2792007-08-02 21:38:03 +0900701 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702}
703
Tejun Heo608e2662007-06-14 04:27:22 +0900704int sysfs_create_subdir(struct kobject *kobj, const char *name,
705 struct sysfs_dirent **p_sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706{
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700707 return create_dir(kobj, kobj->sd,
708 KOBJ_NS_TYPE_NONE, NULL, name, p_sd);
709}
710
Serge E. Hallynbe867b12010-05-03 16:23:15 -0500711/**
712 * sysfs_read_ns_type: return associated ns_type
713 * @kobj: the kobject being queried
714 *
715 * Each kobject can be tagged with exactly one namespace type
716 * (i.e. network or user). Return the ns_type associated with
717 * this object if any
718 */
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700719static enum kobj_ns_type sysfs_read_ns_type(struct kobject *kobj)
720{
721 const struct kobj_ns_type_operations *ops;
722 enum kobj_ns_type type;
723
724 ops = kobj_child_ns_ops(kobj);
725 if (!ops)
726 return KOBJ_NS_TYPE_NONE;
727
728 type = ops->type;
729 BUG_ON(type <= KOBJ_NS_TYPE_NONE);
730 BUG_ON(type >= KOBJ_NS_TYPES);
731 BUG_ON(!kobj_ns_type_registered(type));
732
733 return type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734}
735
736/**
737 * sysfs_create_dir - create a directory for an object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 * @kobj: object we're creating directory for.
739 */
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900740int sysfs_create_dir(struct kobject * kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741{
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700742 enum kobj_ns_type type;
Tejun Heo608e2662007-06-14 04:27:22 +0900743 struct sysfs_dirent *parent_sd, *sd;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700744 const void *ns = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 int error = 0;
746
747 BUG_ON(!kobj);
748
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900749 if (kobj->parent)
Tejun Heo608e2662007-06-14 04:27:22 +0900750 parent_sd = kobj->parent->sd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 else
Eric W. Biederman7d0c7d62007-08-20 21:36:30 +0900752 parent_sd = &sysfs_root;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753
Dan Williams3a198882012-04-06 13:41:06 -0700754 if (!parent_sd)
755 return -ENOENT;
756
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700757 if (sysfs_ns_type(parent_sd))
758 ns = kobj->ktype->namespace(kobj);
759 type = sysfs_read_ns_type(kobj);
760
761 error = create_dir(kobj, parent_sd, type, ns, kobject_name(kobj), &sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 if (!error)
Tejun Heo608e2662007-06-14 04:27:22 +0900763 kobj->sd = sd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 return error;
765}
766
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767static struct dentry * sysfs_lookup(struct inode *dir, struct dentry *dentry,
Al Viro00cd8dd2012-06-10 17:13:09 -0400768 unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769{
Tejun Heo6cb52142007-07-31 19:15:08 +0900770 struct dentry *ret = NULL;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700771 struct dentry *parent = dentry->d_parent;
772 struct sysfs_dirent *parent_sd = parent->d_fsdata;
Tejun Heoa7a04752007-08-02 21:38:02 +0900773 struct sysfs_dirent *sd;
Tejun Heofc9f54b2007-06-14 03:45:17 +0900774 struct inode *inode;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700775 enum kobj_ns_type type;
776 const void *ns;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777
Tejun Heo6cb52142007-07-31 19:15:08 +0900778 mutex_lock(&sysfs_mutex);
779
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700780 type = sysfs_ns_type(parent_sd);
781 ns = sysfs_info(dir->i_sb)->ns[type];
782
783 sd = sysfs_find_dirent(parent_sd, ns, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784
Tejun Heofc9f54b2007-06-14 03:45:17 +0900785 /* no such entry */
Tejun Heoe49452c2008-01-16 12:06:14 +0900786 if (!sd) {
787 ret = ERR_PTR(-ENOENT);
Tejun Heo6cb52142007-07-31 19:15:08 +0900788 goto out_unlock;
Tejun Heoe49452c2008-01-16 12:06:14 +0900789 }
Al Viro469796d2012-06-07 20:51:39 -0400790 dentry->d_fsdata = sysfs_get(sd);
Tejun Heofc9f54b2007-06-14 03:45:17 +0900791
792 /* attach dentry and inode */
Eric W. Biedermanfac26222010-02-12 19:22:27 -0800793 inode = sysfs_get_inode(dir->i_sb, sd);
Tejun Heo6cb52142007-07-31 19:15:08 +0900794 if (!inode) {
795 ret = ERR_PTR(-ENOMEM);
796 goto out_unlock;
797 }
Tejun Heo3007e992007-06-14 04:27:23 +0900798
Tejun Heod6b4fd22007-09-20 16:05:11 +0900799 /* instantiate and hash dentry */
Al Viroe77fb7c2012-06-07 20:56:54 -0400800 ret = d_materialise_unique(dentry, inode);
Tejun Heo6cb52142007-07-31 19:15:08 +0900801 out_unlock:
Tejun Heo3007e992007-06-14 04:27:23 +0900802 mutex_unlock(&sysfs_mutex);
Tejun Heo6cb52142007-07-31 19:15:08 +0900803 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804}
805
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800806const struct inode_operations sysfs_dir_inode_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 .lookup = sysfs_lookup,
Eric W. Biedermane61ab4a2009-11-20 16:08:53 -0800808 .permission = sysfs_permission,
Maneesh Soni988d1862005-05-31 10:39:14 +0530809 .setattr = sysfs_setattr,
Eric W. Biedermane61ab4a2009-11-20 16:08:53 -0800810 .getattr = sysfs_getattr,
David P. Quigleyddd29ec2009-09-09 14:25:37 -0400811 .setxattr = sysfs_setxattr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812};
813
Tejun Heo608e2662007-06-14 04:27:22 +0900814static void remove_dir(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815{
Tejun Heofb6896d2007-06-14 04:27:24 +0900816 struct sysfs_addrm_cxt acxt;
817
818 sysfs_addrm_start(&acxt, sd->s_parent);
Tejun Heofb6896d2007-06-14 04:27:24 +0900819 sysfs_remove_one(&acxt, sd);
820 sysfs_addrm_finish(&acxt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821}
822
Tejun Heo608e2662007-06-14 04:27:22 +0900823void sysfs_remove_subdir(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824{
Tejun Heo608e2662007-06-14 04:27:22 +0900825 remove_dir(sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826}
827
828
Tejun Heo608e2662007-06-14 04:27:22 +0900829static void __sysfs_remove_dir(struct sysfs_dirent *dir_sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830{
Tejun Heofb6896d2007-06-14 04:27:24 +0900831 struct sysfs_addrm_cxt acxt;
Mikulas Patockaa406f752011-07-25 17:57:03 -0400832 struct rb_node *pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833
Tejun Heo608e2662007-06-14 04:27:22 +0900834 if (!dir_sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 return;
836
Tejun Heo608e2662007-06-14 04:27:22 +0900837 pr_debug("sysfs %s: removing dir\n", dir_sd->s_name);
Tejun Heofb6896d2007-06-14 04:27:24 +0900838 sysfs_addrm_start(&acxt, dir_sd);
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800839 pos = rb_first(&dir_sd->s_dir.children);
Mikulas Patockaa406f752011-07-25 17:57:03 -0400840 while (pos) {
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800841 struct sysfs_dirent *sd = to_sysfs_dirent(pos);
Mikulas Patockaa406f752011-07-25 17:57:03 -0400842 pos = rb_next(pos);
Eric W. Biederman3efa65b2007-08-20 21:36:30 +0900843 if (sysfs_type(sd) != SYSFS_DIR)
Tejun Heofb6896d2007-06-14 04:27:24 +0900844 sysfs_remove_one(&acxt, sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 }
Tejun Heofb6896d2007-06-14 04:27:24 +0900846 sysfs_addrm_finish(&acxt);
Tejun Heo0ab66082007-06-14 03:45:16 +0900847
Tejun Heo608e2662007-06-14 04:27:22 +0900848 remove_dir(dir_sd);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700849}
850
851/**
852 * sysfs_remove_dir - remove an object's directory.
853 * @kobj: object.
854 *
855 * The only thing special about this is that we remove any files in
856 * the directory before we remove the directory, and we've inlined
857 * what used to be sysfs_rmdir() below, instead of calling separately.
858 */
859
860void sysfs_remove_dir(struct kobject * kobj)
861{
Tejun Heo608e2662007-06-14 04:27:22 +0900862 struct sysfs_dirent *sd = kobj->sd;
Tejun Heoaecdced2007-06-14 03:45:15 +0900863
Tejun Heo5f995322007-06-14 04:27:23 +0900864 spin_lock(&sysfs_assoc_lock);
Tejun Heo608e2662007-06-14 04:27:22 +0900865 kobj->sd = NULL;
Tejun Heo5f995322007-06-14 04:27:23 +0900866 spin_unlock(&sysfs_assoc_lock);
Tejun Heoaecdced2007-06-14 03:45:15 +0900867
Tejun Heo608e2662007-06-14 04:27:22 +0900868 __sysfs_remove_dir(sd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869}
870
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800871int sysfs_rename(struct sysfs_dirent *sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700872 struct sysfs_dirent *new_parent_sd, const void *new_ns,
873 const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874{
Tejun Heo996b7372007-06-14 03:45:14 +0900875 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800877 mutex_lock(&sysfs_mutex);
Eric W. Biederman932ea2e2007-08-20 21:36:30 +0900878
Eric W. Biederman9918f9a2007-08-20 21:36:31 +0900879 error = 0;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700880 if ((sd->s_parent == new_parent_sd) && (sd->s_ns == new_ns) &&
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800881 (strcmp(sd->s_name, new_name) == 0))
Eric W. Biederman9918f9a2007-08-20 21:36:31 +0900882 goto out; /* nothing to rename */
883
Tejun Heo996b7372007-06-14 03:45:14 +0900884 error = -EEXIST;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700885 if (sysfs_find_dirent(new_parent_sd, new_ns, new_name))
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800886 goto out;
Tejun Heo996b7372007-06-14 03:45:14 +0900887
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700888 /* rename sysfs_dirent */
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800889 if (strcmp(sd->s_name, new_name) != 0) {
890 error = -ENOMEM;
Sasikantha babub4eafca2012-05-03 02:26:14 +0530891 new_name = kstrdup(new_name, GFP_KERNEL);
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800892 if (!new_name)
893 goto out;
Tejun Heo996b7372007-06-14 03:45:14 +0900894
Sasikantha babub4eafca2012-05-03 02:26:14 +0530895 kfree(sd->s_name);
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800896 sd->s_name = new_name;
897 }
898
Eric W. Biedermanf6d90b42011-11-01 07:06:17 -0700899 /* Move to the appropriate place in the appropriate directories rbtree. */
900 sysfs_unlink_sibling(sd);
901 sysfs_get(new_parent_sd);
902 sysfs_put(sd->s_parent);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700903 sd->s_ns = new_ns;
Tom Goff70fa4a62012-04-04 12:06:20 -0700904 sd->s_hash = sysfs_name_hash(sd->s_ns, sd->s_name);
Eric W. Biedermanf6d90b42011-11-01 07:06:17 -0700905 sd->s_parent = new_parent_sd;
906 sysfs_link_sibling(sd);
Tejun Heo0c096b52007-06-14 03:45:15 +0900907
Tejun Heo996b7372007-06-14 03:45:14 +0900908 error = 0;
Eric W. Biederman9918f9a2007-08-20 21:36:31 +0900909 out:
Eric W. Biederman832b6af2009-11-20 16:08:56 -0800910 mutex_unlock(&sysfs_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 return error;
912}
913
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800914int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
915{
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700916 struct sysfs_dirent *parent_sd = kobj->sd->s_parent;
917 const void *new_ns = NULL;
918
919 if (sysfs_ns_type(parent_sd))
920 new_ns = kobj->ktype->namespace(kobj);
921
922 return sysfs_rename(kobj->sd, parent_sd, new_ns, new_name);
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800923}
924
Tejun Heo51225032007-06-14 04:27:25 +0900925int sysfs_move_dir(struct kobject *kobj, struct kobject *new_parent_kobj)
Cornelia Huck8a824722006-11-20 17:07:51 +0100926{
Tejun Heo51225032007-06-14 04:27:25 +0900927 struct sysfs_dirent *sd = kobj->sd;
928 struct sysfs_dirent *new_parent_sd;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700929 const void *new_ns = NULL;
Cornelia Huck8a824722006-11-20 17:07:51 +0100930
Tejun Heo51225032007-06-14 04:27:25 +0900931 BUG_ON(!sd->s_parent);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700932 if (sysfs_ns_type(sd->s_parent))
933 new_ns = kobj->ktype->namespace(kobj);
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800934 new_parent_sd = new_parent_kobj && new_parent_kobj->sd ?
Cornelia Hucka6a83572009-10-06 15:33:35 +0200935 new_parent_kobj->sd : &sysfs_root;
Cornelia Huck8a824722006-11-20 17:07:51 +0100936
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700937 return sysfs_rename(sd, new_parent_sd, new_ns, sd->s_name);
Cornelia Huck8a824722006-11-20 17:07:51 +0100938}
939
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940/* Relationship between s_mode and the DT_xxx types */
941static inline unsigned char dt_type(struct sysfs_dirent *sd)
942{
943 return (sd->s_mode >> 12) & 15;
944}
945
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800946static int sysfs_dir_release(struct inode *inode, struct file *filp)
947{
948 sysfs_put(filp->private_data);
949 return 0;
950}
951
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700952static struct sysfs_dirent *sysfs_dir_pos(const void *ns,
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800953 struct sysfs_dirent *parent_sd, loff_t hash, struct sysfs_dirent *pos)
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800954{
955 if (pos) {
956 int valid = !(pos->s_flags & SYSFS_FLAG_REMOVED) &&
957 pos->s_parent == parent_sd &&
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800958 hash == pos->s_hash;
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800959 sysfs_put(pos);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700960 if (!valid)
961 pos = NULL;
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800962 }
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800963 if (!pos && (hash > 1) && (hash < INT_MAX)) {
964 struct rb_node *node = parent_sd->s_dir.children.rb_node;
965 while (node) {
966 pos = to_sysfs_dirent(node);
967
968 if (hash < pos->s_hash)
969 node = node->rb_left;
970 else if (hash > pos->s_hash)
971 node = node->rb_right;
972 else
Mikulas Patockaa406f752011-07-25 17:57:03 -0400973 break;
Mikulas Patockaa406f752011-07-25 17:57:03 -0400974 }
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800975 }
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800976 /* Skip over entries in the wrong namespace */
Eric W. Biedermanb9e2780d2011-10-25 05:38:41 -0700977 while (pos && pos->s_ns != ns) {
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800978 struct rb_node *node = rb_next(&pos->s_rb);
979 if (!node)
Mikulas Patockaa406f752011-07-25 17:57:03 -0400980 pos = NULL;
981 else
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800982 pos = to_sysfs_dirent(node);
Mikulas Patockaa406f752011-07-25 17:57:03 -0400983 }
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800984 return pos;
985}
986
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700987static struct sysfs_dirent *sysfs_dir_next_pos(const void *ns,
988 struct sysfs_dirent *parent_sd, ino_t ino, struct sysfs_dirent *pos)
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800989{
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700990 pos = sysfs_dir_pos(ns, parent_sd, ino, pos);
Mikulas Patockaa406f752011-07-25 17:57:03 -0400991 if (pos) do {
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800992 struct rb_node *node = rb_next(&pos->s_rb);
993 if (!node)
Mikulas Patockaa406f752011-07-25 17:57:03 -0400994 pos = NULL;
995 else
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -0800996 pos = to_sysfs_dirent(node);
Eric W. Biedermanb9e2780d2011-10-25 05:38:41 -0700997 } while (pos && pos->s_ns != ns);
Eric W. Biederman1e5289c2010-01-01 14:43:53 -0800998 return pos;
999}
1000
Al Virod55fea82013-05-16 14:31:02 -04001001static int sysfs_readdir(struct file *file, struct dir_context *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002{
Al Virod55fea82013-05-16 14:31:02 -04001003 struct dentry *dentry = file->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 struct sysfs_dirent * parent_sd = dentry->d_fsdata;
Al Virod55fea82013-05-16 14:31:02 -04001005 struct sysfs_dirent *pos = file->private_data;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -07001006 enum kobj_ns_type type;
1007 const void *ns;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008
Eric W. Biederman3ff195b2010-03-30 11:31:26 -07001009 type = sysfs_ns_type(parent_sd);
1010 ns = sysfs_info(dentry->d_sb)->ns[type];
1011
Al Virod55fea82013-05-16 14:31:02 -04001012 if (!dir_emit_dots(file, ctx))
1013 return 0;
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001014 mutex_lock(&sysfs_mutex);
Al Virod55fea82013-05-16 14:31:02 -04001015 for (pos = sysfs_dir_pos(ns, parent_sd, ctx->pos, pos);
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001016 pos;
Al Virod55fea82013-05-16 14:31:02 -04001017 pos = sysfs_dir_next_pos(ns, parent_sd, ctx->pos, pos)) {
1018 const char *name = pos->s_name;
1019 unsigned int type = dt_type(pos);
1020 int len = strlen(name);
1021 ino_t ino = pos->s_ino;
1022 ctx->pos = pos->s_hash;
1023 file->private_data = sysfs_get(pos);
Eric W. Biederman3efa65b2007-08-20 21:36:30 +09001024
Eric W. Biederman3efa65b2007-08-20 21:36:30 +09001025 mutex_unlock(&sysfs_mutex);
Al Virod55fea82013-05-16 14:31:02 -04001026 if (!dir_emit(ctx, name, len, ino, type))
1027 return 0;
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001028 mutex_lock(&sysfs_mutex);
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001029 }
1030 mutex_unlock(&sysfs_mutex);
Al Virod55fea82013-05-16 14:31:02 -04001031 file->private_data = NULL;
1032 ctx->pos = INT_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 return 0;
1034}
1035
Ming Lei991f76f2013-03-20 23:25:24 +08001036static loff_t sysfs_dir_llseek(struct file *file, loff_t offset, int whence)
1037{
1038 struct inode *inode = file_inode(file);
1039 loff_t ret;
1040
1041 mutex_lock(&inode->i_mutex);
1042 ret = generic_file_llseek(file, offset, whence);
1043 mutex_unlock(&inode->i_mutex);
1044
1045 return ret;
1046}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08001048const struct file_operations sysfs_dir_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 .read = generic_read_dir,
Al Virod55fea82013-05-16 14:31:02 -04001050 .iterate = sysfs_readdir,
Eric W. Biederman1e5289c2010-01-01 14:43:53 -08001051 .release = sysfs_dir_release,
Ming Lei991f76f2013-03-20 23:25:24 +08001052 .llseek = sysfs_dir_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053};