kernfs: add @mode to kernfs_create_dir[_ns]()
[deliverable/linux.git] / fs / kernfs / dir.c
CommitLineData
b8441ed2
TH
1/*
2 * fs/kernfs/dir.c - kernfs directory implementation
3 *
4 * Copyright (c) 2001-3 Patrick Mochel
5 * Copyright (c) 2007 SUSE Linux Products GmbH
6 * Copyright (c) 2007, 2013 Tejun Heo <tj@kernel.org>
7 *
8 * This file is released under the GPLv2.
9 */
fd7b9f7b
TH
10
11#include <linux/fs.h>
12#include <linux/namei.h>
13#include <linux/idr.h>
14#include <linux/slab.h>
15#include <linux/security.h>
16#include <linux/hash.h>
17
18#include "kernfs-internal.h"
19
a797bfc3 20DEFINE_MUTEX(kernfs_mutex);
fd7b9f7b 21
adc5e8b5 22#define rb_to_kn(X) rb_entry((X), struct kernfs_node, rb)
fd7b9f7b 23
fd7b9f7b 24/**
c637b8ac 25 * kernfs_name_hash
fd7b9f7b
TH
26 * @name: Null terminated string to hash
27 * @ns: Namespace tag to hash
28 *
29 * Returns 31 bit hash of ns + name (so it fits in an off_t )
30 */
c637b8ac 31static unsigned int kernfs_name_hash(const char *name, const void *ns)
fd7b9f7b
TH
32{
33 unsigned long hash = init_name_hash();
34 unsigned int len = strlen(name);
35 while (len--)
36 hash = partial_name_hash(*name++, hash);
37 hash = (end_name_hash(hash) ^ hash_ptr((void *)ns, 31));
38 hash &= 0x7fffffffU;
39 /* Reserve hash numbers 0, 1 and INT_MAX for magic directory entries */
40 if (hash < 1)
41 hash += 2;
42 if (hash >= INT_MAX)
43 hash = INT_MAX - 1;
44 return hash;
45}
46
c637b8ac
TH
47static int kernfs_name_compare(unsigned int hash, const char *name,
48 const void *ns, const struct kernfs_node *kn)
fd7b9f7b 49{
adc5e8b5
TH
50 if (hash != kn->hash)
51 return hash - kn->hash;
52 if (ns != kn->ns)
53 return ns - kn->ns;
54 return strcmp(name, kn->name);
fd7b9f7b
TH
55}
56
c637b8ac
TH
57static int kernfs_sd_compare(const struct kernfs_node *left,
58 const struct kernfs_node *right)
fd7b9f7b 59{
c637b8ac 60 return kernfs_name_compare(left->hash, left->name, left->ns, right);
fd7b9f7b
TH
61}
62
63/**
c637b8ac 64 * kernfs_link_sibling - link kernfs_node into sibling rbtree
324a56e1 65 * @kn: kernfs_node of interest
fd7b9f7b 66 *
324a56e1 67 * Link @kn into its sibling rbtree which starts from
adc5e8b5 68 * @kn->parent->dir.children.
fd7b9f7b
TH
69 *
70 * Locking:
a797bfc3 71 * mutex_lock(kernfs_mutex)
fd7b9f7b
TH
72 *
73 * RETURNS:
74 * 0 on susccess -EEXIST on failure.
75 */
c637b8ac 76static int kernfs_link_sibling(struct kernfs_node *kn)
fd7b9f7b 77{
adc5e8b5 78 struct rb_node **node = &kn->parent->dir.children.rb_node;
fd7b9f7b
TH
79 struct rb_node *parent = NULL;
80
df23fc39 81 if (kernfs_type(kn) == KERNFS_DIR)
adc5e8b5 82 kn->parent->dir.subdirs++;
fd7b9f7b
TH
83
84 while (*node) {
324a56e1 85 struct kernfs_node *pos;
fd7b9f7b
TH
86 int result;
87
324a56e1 88 pos = rb_to_kn(*node);
fd7b9f7b 89 parent = *node;
c637b8ac 90 result = kernfs_sd_compare(kn, pos);
fd7b9f7b 91 if (result < 0)
adc5e8b5 92 node = &pos->rb.rb_left;
fd7b9f7b 93 else if (result > 0)
adc5e8b5 94 node = &pos->rb.rb_right;
fd7b9f7b
TH
95 else
96 return -EEXIST;
97 }
98 /* add new node and rebalance the tree */
adc5e8b5
TH
99 rb_link_node(&kn->rb, parent, node);
100 rb_insert_color(&kn->rb, &kn->parent->dir.children);
fd7b9f7b
TH
101 return 0;
102}
103
104/**
c637b8ac 105 * kernfs_unlink_sibling - unlink kernfs_node from sibling rbtree
324a56e1 106 * @kn: kernfs_node of interest
fd7b9f7b 107 *
324a56e1 108 * Unlink @kn from its sibling rbtree which starts from
adc5e8b5 109 * kn->parent->dir.children.
fd7b9f7b
TH
110 *
111 * Locking:
a797bfc3 112 * mutex_lock(kernfs_mutex)
fd7b9f7b 113 */
c637b8ac 114static void kernfs_unlink_sibling(struct kernfs_node *kn)
fd7b9f7b 115{
df23fc39 116 if (kernfs_type(kn) == KERNFS_DIR)
adc5e8b5 117 kn->parent->dir.subdirs--;
fd7b9f7b 118
adc5e8b5 119 rb_erase(&kn->rb, &kn->parent->dir.children);
fd7b9f7b
TH
120}
121
122/**
c637b8ac 123 * kernfs_get_active - get an active reference to kernfs_node
324a56e1 124 * @kn: kernfs_node to get an active reference to
fd7b9f7b 125 *
324a56e1 126 * Get an active reference of @kn. This function is noop if @kn
fd7b9f7b
TH
127 * is NULL.
128 *
129 * RETURNS:
324a56e1 130 * Pointer to @kn on success, NULL on failure.
fd7b9f7b 131 */
c637b8ac 132struct kernfs_node *kernfs_get_active(struct kernfs_node *kn)
fd7b9f7b 133{
324a56e1 134 if (unlikely(!kn))
fd7b9f7b
TH
135 return NULL;
136
adc5e8b5 137 if (!atomic_inc_unless_negative(&kn->active))
fd7b9f7b
TH
138 return NULL;
139
df23fc39 140 if (kn->flags & KERNFS_LOCKDEP)
324a56e1
TH
141 rwsem_acquire_read(&kn->dep_map, 0, 1, _RET_IP_);
142 return kn;
fd7b9f7b
TH
143}
144
145/**
c637b8ac 146 * kernfs_put_active - put an active reference to kernfs_node
324a56e1 147 * @kn: kernfs_node to put an active reference to
fd7b9f7b 148 *
324a56e1 149 * Put an active reference to @kn. This function is noop if @kn
fd7b9f7b
TH
150 * is NULL.
151 */
c637b8ac 152void kernfs_put_active(struct kernfs_node *kn)
fd7b9f7b
TH
153{
154 int v;
155
324a56e1 156 if (unlikely(!kn))
fd7b9f7b
TH
157 return;
158
df23fc39 159 if (kn->flags & KERNFS_LOCKDEP)
324a56e1 160 rwsem_release(&kn->dep_map, 1, _RET_IP_);
adc5e8b5 161 v = atomic_dec_return(&kn->active);
df23fc39 162 if (likely(v != KN_DEACTIVATED_BIAS))
fd7b9f7b
TH
163 return;
164
324a56e1
TH
165 /*
166 * atomic_dec_return() is a mb(), we'll always see the updated
167 * kn->u.completion.
fd7b9f7b 168 */
324a56e1 169 complete(kn->u.completion);
fd7b9f7b
TH
170}
171
172/**
c637b8ac 173 * kernfs_deactivate - deactivate kernfs_node
324a56e1 174 * @kn: kernfs_node to deactivate
fd7b9f7b
TH
175 *
176 * Deny new active references and drain existing ones.
177 */
c637b8ac 178static void kernfs_deactivate(struct kernfs_node *kn)
fd7b9f7b
TH
179{
180 DECLARE_COMPLETION_ONSTACK(wait);
181 int v;
182
df23fc39 183 BUG_ON(!(kn->flags & KERNFS_REMOVED));
fd7b9f7b 184
df23fc39 185 if (!(kernfs_type(kn) & KERNFS_ACTIVE_REF))
fd7b9f7b
TH
186 return;
187
324a56e1 188 kn->u.completion = (void *)&wait;
fd7b9f7b 189
324a56e1 190 rwsem_acquire(&kn->dep_map, 0, 0, _RET_IP_);
fd7b9f7b 191 /* atomic_add_return() is a mb(), put_active() will always see
324a56e1 192 * the updated kn->u.completion.
fd7b9f7b 193 */
df23fc39 194 v = atomic_add_return(KN_DEACTIVATED_BIAS, &kn->active);
fd7b9f7b 195
df23fc39 196 if (v != KN_DEACTIVATED_BIAS) {
324a56e1 197 lock_contended(&kn->dep_map, _RET_IP_);
fd7b9f7b
TH
198 wait_for_completion(&wait);
199 }
200
324a56e1
TH
201 lock_acquired(&kn->dep_map, _RET_IP_);
202 rwsem_release(&kn->dep_map, 1, _RET_IP_);
fd7b9f7b
TH
203}
204
fd7b9f7b 205/**
324a56e1
TH
206 * kernfs_get - get a reference count on a kernfs_node
207 * @kn: the target kernfs_node
fd7b9f7b 208 */
324a56e1 209void kernfs_get(struct kernfs_node *kn)
fd7b9f7b 210{
324a56e1 211 if (kn) {
adc5e8b5
TH
212 WARN_ON(!atomic_read(&kn->count));
213 atomic_inc(&kn->count);
fd7b9f7b
TH
214 }
215}
216EXPORT_SYMBOL_GPL(kernfs_get);
217
218/**
324a56e1
TH
219 * kernfs_put - put a reference count on a kernfs_node
220 * @kn: the target kernfs_node
fd7b9f7b 221 *
324a56e1 222 * Put a reference count of @kn and destroy it if it reached zero.
fd7b9f7b 223 */
324a56e1 224void kernfs_put(struct kernfs_node *kn)
fd7b9f7b 225{
324a56e1 226 struct kernfs_node *parent;
ba7443bc 227 struct kernfs_root *root;
fd7b9f7b 228
adc5e8b5 229 if (!kn || !atomic_dec_and_test(&kn->count))
fd7b9f7b 230 return;
324a56e1 231 root = kernfs_root(kn);
fd7b9f7b
TH
232 repeat:
233 /* Moving/renaming is always done while holding reference.
adc5e8b5 234 * kn->parent won't change beneath us.
fd7b9f7b 235 */
adc5e8b5 236 parent = kn->parent;
fd7b9f7b 237
c637b8ac
TH
238 WARN(!(kn->flags & KERNFS_REMOVED), "kernfs: free using entry: %s/%s\n",
239 parent ? parent->name : "", kn->name);
324a56e1 240
df23fc39 241 if (kernfs_type(kn) == KERNFS_LINK)
adc5e8b5 242 kernfs_put(kn->symlink.target_kn);
df23fc39 243 if (kernfs_type(kn) & KERNFS_COPY_NAME)
adc5e8b5
TH
244 kfree(kn->name);
245 if (kn->iattr) {
246 if (kn->iattr->ia_secdata)
247 security_release_secctx(kn->iattr->ia_secdata,
248 kn->iattr->ia_secdata_len);
249 simple_xattrs_free(&kn->iattr->xattrs);
2322392b 250 }
adc5e8b5
TH
251 kfree(kn->iattr);
252 ida_simple_remove(&root->ino_ida, kn->ino);
a797bfc3 253 kmem_cache_free(kernfs_node_cache, kn);
fd7b9f7b 254
324a56e1
TH
255 kn = parent;
256 if (kn) {
adc5e8b5 257 if (atomic_dec_and_test(&kn->count))
ba7443bc
TH
258 goto repeat;
259 } else {
324a56e1 260 /* just released the root kn, free @root too */
bc755553 261 ida_destroy(&root->ino_ida);
ba7443bc
TH
262 kfree(root);
263 }
fd7b9f7b
TH
264}
265EXPORT_SYMBOL_GPL(kernfs_put);
266
c637b8ac 267static int kernfs_dop_delete(const struct dentry *dentry)
fd7b9f7b 268{
324a56e1 269 struct kernfs_node *kn = dentry->d_fsdata;
df23fc39 270 return !(kn && !(kn->flags & KERNFS_REMOVED));
fd7b9f7b
TH
271}
272
c637b8ac 273static int kernfs_dop_revalidate(struct dentry *dentry, unsigned int flags)
fd7b9f7b 274{
324a56e1 275 struct kernfs_node *kn;
fd7b9f7b
TH
276
277 if (flags & LOOKUP_RCU)
278 return -ECHILD;
279
324a56e1 280 kn = dentry->d_fsdata;
a797bfc3 281 mutex_lock(&kernfs_mutex);
fd7b9f7b 282
c637b8ac 283 /* The kernfs node has been deleted */
df23fc39 284 if (kn->flags & KERNFS_REMOVED)
fd7b9f7b
TH
285 goto out_bad;
286
c637b8ac 287 /* The kernfs node has been moved? */
adc5e8b5 288 if (dentry->d_parent->d_fsdata != kn->parent)
fd7b9f7b
TH
289 goto out_bad;
290
c637b8ac 291 /* The kernfs node has been renamed */
adc5e8b5 292 if (strcmp(dentry->d_name.name, kn->name) != 0)
fd7b9f7b
TH
293 goto out_bad;
294
c637b8ac 295 /* The kernfs node has been moved to a different namespace */
adc5e8b5 296 if (kn->parent && kernfs_ns_enabled(kn->parent) &&
c525aadd 297 kernfs_info(dentry->d_sb)->ns != kn->ns)
fd7b9f7b
TH
298 goto out_bad;
299
a797bfc3 300 mutex_unlock(&kernfs_mutex);
fd7b9f7b
TH
301out_valid:
302 return 1;
303out_bad:
c637b8ac
TH
304 /*
305 * Remove the dentry from the dcache hashes.
fd7b9f7b 306 * If this is a deleted dentry we use d_drop instead of d_delete
c637b8ac 307 * so kernfs doesn't need to cope with negative dentries.
fd7b9f7b
TH
308 *
309 * If this is a dentry that has simply been renamed we
310 * use d_drop to remove it from the dcache lookup on its
311 * old parent. If this dentry persists later when a lookup
312 * is performed at its new name the dentry will be readded
313 * to the dcache hashes.
314 */
a797bfc3 315 mutex_unlock(&kernfs_mutex);
fd7b9f7b
TH
316
317 /* If we have submounts we must allow the vfs caches
318 * to lie about the state of the filesystem to prevent
319 * leaks and other nasty things.
320 */
321 if (check_submounts_and_drop(dentry) != 0)
322 goto out_valid;
323
324 return 0;
325}
326
c637b8ac 327static void kernfs_dop_release(struct dentry *dentry)
fd7b9f7b
TH
328{
329 kernfs_put(dentry->d_fsdata);
330}
331
a797bfc3 332const struct dentry_operations kernfs_dops = {
c637b8ac
TH
333 .d_revalidate = kernfs_dop_revalidate,
334 .d_delete = kernfs_dop_delete,
335 .d_release = kernfs_dop_release,
fd7b9f7b
TH
336};
337
c637b8ac
TH
338struct kernfs_node *kernfs_new_node(struct kernfs_root *root, const char *name,
339 umode_t mode, int type)
fd7b9f7b
TH
340{
341 char *dup_name = NULL;
324a56e1 342 struct kernfs_node *kn;
bc755553 343 int ret;
fd7b9f7b 344
df23fc39 345 if (type & KERNFS_COPY_NAME) {
fd7b9f7b
TH
346 name = dup_name = kstrdup(name, GFP_KERNEL);
347 if (!name)
348 return NULL;
349 }
350
a797bfc3 351 kn = kmem_cache_zalloc(kernfs_node_cache, GFP_KERNEL);
324a56e1 352 if (!kn)
fd7b9f7b
TH
353 goto err_out1;
354
bc755553
TH
355 ret = ida_simple_get(&root->ino_ida, 1, 0, GFP_KERNEL);
356 if (ret < 0)
fd7b9f7b 357 goto err_out2;
adc5e8b5 358 kn->ino = ret;
fd7b9f7b 359
adc5e8b5
TH
360 atomic_set(&kn->count, 1);
361 atomic_set(&kn->active, 0);
fd7b9f7b 362
adc5e8b5
TH
363 kn->name = name;
364 kn->mode = mode;
df23fc39 365 kn->flags = type | KERNFS_REMOVED;
fd7b9f7b 366
324a56e1 367 return kn;
fd7b9f7b
TH
368
369 err_out2:
a797bfc3 370 kmem_cache_free(kernfs_node_cache, kn);
fd7b9f7b
TH
371 err_out1:
372 kfree(dup_name);
373 return NULL;
374}
375
376/**
c637b8ac 377 * kernfs_addrm_start - prepare for kernfs_node add/remove
c525aadd 378 * @acxt: pointer to kernfs_addrm_cxt to be used
fd7b9f7b
TH
379 *
380 * This function is called when the caller is about to add or remove
a797bfc3
TH
381 * kernfs_node. This function acquires kernfs_mutex. @acxt is used
382 * to keep and pass context to other addrm functions.
fd7b9f7b
TH
383 *
384 * LOCKING:
a797bfc3 385 * Kernel thread context (may sleep). kernfs_mutex is locked on
fd7b9f7b
TH
386 * return.
387 */
c637b8ac 388void kernfs_addrm_start(struct kernfs_addrm_cxt *acxt)
a797bfc3 389 __acquires(kernfs_mutex)
fd7b9f7b
TH
390{
391 memset(acxt, 0, sizeof(*acxt));
392
a797bfc3 393 mutex_lock(&kernfs_mutex);
fd7b9f7b
TH
394}
395
396/**
c637b8ac 397 * kernfs_add_one - add kernfs_node to parent without warning
fd7b9f7b 398 * @acxt: addrm context to use
324a56e1
TH
399 * @kn: kernfs_node to be added
400 * @parent: the parent kernfs_node to add @kn to
fd7b9f7b 401 *
adc5e8b5
TH
402 * Get @parent and set @kn->parent to it and increment nlink of the
403 * parent inode if @kn is a directory and link into the children list
404 * of the parent.
fd7b9f7b
TH
405 *
406 * This function should be called between calls to
c637b8ac
TH
407 * kernfs_addrm_start() and kernfs_addrm_finish() and should be passed
408 * the same @acxt as passed to kernfs_addrm_start().
fd7b9f7b
TH
409 *
410 * LOCKING:
c637b8ac 411 * Determined by kernfs_addrm_start().
fd7b9f7b
TH
412 *
413 * RETURNS:
414 * 0 on success, -EEXIST if entry with the given name already
415 * exists.
416 */
c637b8ac 417int kernfs_add_one(struct kernfs_addrm_cxt *acxt, struct kernfs_node *kn,
324a56e1 418 struct kernfs_node *parent)
fd7b9f7b 419{
324a56e1 420 bool has_ns = kernfs_ns_enabled(parent);
c525aadd 421 struct kernfs_iattrs *ps_iattr;
fd7b9f7b
TH
422 int ret;
423
adc5e8b5 424 if (has_ns != (bool)kn->ns) {
c637b8ac 425 WARN(1, KERN_WARNING "kernfs: ns %s in '%s' for '%s'\n",
adc5e8b5 426 has_ns ? "required" : "invalid", parent->name, kn->name);
fd7b9f7b
TH
427 return -EINVAL;
428 }
429
df23fc39 430 if (kernfs_type(parent) != KERNFS_DIR)
fd7b9f7b
TH
431 return -EINVAL;
432
c637b8ac 433 kn->hash = kernfs_name_hash(kn->name, kn->ns);
adc5e8b5 434 kn->parent = parent;
324a56e1 435 kernfs_get(parent);
fd7b9f7b 436
c637b8ac 437 ret = kernfs_link_sibling(kn);
fd7b9f7b
TH
438 if (ret)
439 return ret;
440
441 /* Update timestamps on the parent */
adc5e8b5 442 ps_iattr = parent->iattr;
fd7b9f7b
TH
443 if (ps_iattr) {
444 struct iattr *ps_iattrs = &ps_iattr->ia_iattr;
445 ps_iattrs->ia_ctime = ps_iattrs->ia_mtime = CURRENT_TIME;
446 }
447
448 /* Mark the entry added into directory tree */
df23fc39 449 kn->flags &= ~KERNFS_REMOVED;
fd7b9f7b
TH
450
451 return 0;
452}
453
454/**
c637b8ac 455 * kernfs_remove_one - remove kernfs_node from parent
fd7b9f7b 456 * @acxt: addrm context to use
324a56e1 457 * @kn: kernfs_node to be removed
fd7b9f7b 458 *
324a56e1
TH
459 * Mark @kn removed and drop nlink of parent inode if @kn is a
460 * directory. @kn is unlinked from the children list.
fd7b9f7b
TH
461 *
462 * This function should be called between calls to
c637b8ac
TH
463 * kernfs_addrm_start() and kernfs_addrm_finish() and should be
464 * passed the same @acxt as passed to kernfs_addrm_start().
fd7b9f7b
TH
465 *
466 * LOCKING:
c637b8ac 467 * Determined by kernfs_addrm_start().
fd7b9f7b 468 */
c637b8ac
TH
469static void kernfs_remove_one(struct kernfs_addrm_cxt *acxt,
470 struct kernfs_node *kn)
fd7b9f7b 471{
c525aadd 472 struct kernfs_iattrs *ps_iattr;
fd7b9f7b
TH
473
474 /*
475 * Removal can be called multiple times on the same node. Only the
476 * first invocation is effective and puts the base ref.
477 */
df23fc39 478 if (kn->flags & KERNFS_REMOVED)
fd7b9f7b
TH
479 return;
480
adc5e8b5 481 if (kn->parent) {
c637b8ac 482 kernfs_unlink_sibling(kn);
fd7b9f7b 483
ba7443bc 484 /* Update timestamps on the parent */
adc5e8b5 485 ps_iattr = kn->parent->iattr;
ba7443bc
TH
486 if (ps_iattr) {
487 ps_iattr->ia_iattr.ia_ctime = CURRENT_TIME;
488 ps_iattr->ia_iattr.ia_mtime = CURRENT_TIME;
489 }
fd7b9f7b
TH
490 }
491
df23fc39 492 kn->flags |= KERNFS_REMOVED;
324a56e1
TH
493 kn->u.removed_list = acxt->removed;
494 acxt->removed = kn;
fd7b9f7b
TH
495}
496
497/**
c637b8ac 498 * kernfs_addrm_finish - finish up kernfs_node add/remove
fd7b9f7b
TH
499 * @acxt: addrm context to finish up
500 *
324a56e1 501 * Finish up kernfs_node add/remove. Resources acquired by
c637b8ac 502 * kernfs_addrm_start() are released and removed kernfs_nodes are
fd7b9f7b
TH
503 * cleaned up.
504 *
505 * LOCKING:
a797bfc3 506 * kernfs_mutex is released.
fd7b9f7b 507 */
c637b8ac 508void kernfs_addrm_finish(struct kernfs_addrm_cxt *acxt)
a797bfc3 509 __releases(kernfs_mutex)
fd7b9f7b 510{
c637b8ac 511 /* release resources acquired by kernfs_addrm_start() */
a797bfc3 512 mutex_unlock(&kernfs_mutex);
fd7b9f7b 513
324a56e1 514 /* kill removed kernfs_nodes */
fd7b9f7b 515 while (acxt->removed) {
324a56e1 516 struct kernfs_node *kn = acxt->removed;
fd7b9f7b 517
324a56e1 518 acxt->removed = kn->u.removed_list;
fd7b9f7b 519
c637b8ac
TH
520 kernfs_deactivate(kn);
521 kernfs_unmap_bin_file(kn);
324a56e1 522 kernfs_put(kn);
fd7b9f7b
TH
523 }
524}
525
526/**
324a56e1
TH
527 * kernfs_find_ns - find kernfs_node with the given name
528 * @parent: kernfs_node to search under
fd7b9f7b
TH
529 * @name: name to look for
530 * @ns: the namespace tag to use
531 *
324a56e1
TH
532 * Look for kernfs_node with name @name under @parent. Returns pointer to
533 * the found kernfs_node on success, %NULL on failure.
fd7b9f7b 534 */
324a56e1
TH
535static struct kernfs_node *kernfs_find_ns(struct kernfs_node *parent,
536 const unsigned char *name,
537 const void *ns)
fd7b9f7b 538{
adc5e8b5 539 struct rb_node *node = parent->dir.children.rb_node;
ac9bba03 540 bool has_ns = kernfs_ns_enabled(parent);
fd7b9f7b
TH
541 unsigned int hash;
542
a797bfc3 543 lockdep_assert_held(&kernfs_mutex);
fd7b9f7b
TH
544
545 if (has_ns != (bool)ns) {
c637b8ac 546 WARN(1, KERN_WARNING "kernfs: ns %s in '%s' for '%s'\n",
adc5e8b5 547 has_ns ? "required" : "invalid", parent->name, name);
fd7b9f7b
TH
548 return NULL;
549 }
550
c637b8ac 551 hash = kernfs_name_hash(name, ns);
fd7b9f7b 552 while (node) {
324a56e1 553 struct kernfs_node *kn;
fd7b9f7b
TH
554 int result;
555
324a56e1 556 kn = rb_to_kn(node);
c637b8ac 557 result = kernfs_name_compare(hash, name, ns, kn);
fd7b9f7b
TH
558 if (result < 0)
559 node = node->rb_left;
560 else if (result > 0)
561 node = node->rb_right;
562 else
324a56e1 563 return kn;
fd7b9f7b
TH
564 }
565 return NULL;
566}
567
568/**
324a56e1
TH
569 * kernfs_find_and_get_ns - find and get kernfs_node with the given name
570 * @parent: kernfs_node to search under
fd7b9f7b
TH
571 * @name: name to look for
572 * @ns: the namespace tag to use
573 *
324a56e1 574 * Look for kernfs_node with name @name under @parent and get a reference
fd7b9f7b 575 * if found. This function may sleep and returns pointer to the found
324a56e1 576 * kernfs_node on success, %NULL on failure.
fd7b9f7b 577 */
324a56e1
TH
578struct kernfs_node *kernfs_find_and_get_ns(struct kernfs_node *parent,
579 const char *name, const void *ns)
fd7b9f7b 580{
324a56e1 581 struct kernfs_node *kn;
fd7b9f7b 582
a797bfc3 583 mutex_lock(&kernfs_mutex);
324a56e1
TH
584 kn = kernfs_find_ns(parent, name, ns);
585 kernfs_get(kn);
a797bfc3 586 mutex_unlock(&kernfs_mutex);
fd7b9f7b 587
324a56e1 588 return kn;
fd7b9f7b
TH
589}
590EXPORT_SYMBOL_GPL(kernfs_find_and_get_ns);
591
ba7443bc
TH
592/**
593 * kernfs_create_root - create a new kernfs hierarchy
594 * @priv: opaque data associated with the new directory
595 *
596 * Returns the root of the new hierarchy on success, ERR_PTR() value on
597 * failure.
598 */
599struct kernfs_root *kernfs_create_root(void *priv)
600{
601 struct kernfs_root *root;
324a56e1 602 struct kernfs_node *kn;
ba7443bc
TH
603
604 root = kzalloc(sizeof(*root), GFP_KERNEL);
605 if (!root)
606 return ERR_PTR(-ENOMEM);
607
bc755553
TH
608 ida_init(&root->ino_ida);
609
c637b8ac 610 kn = kernfs_new_node(root, "", S_IFDIR | S_IRUGO | S_IXUGO, KERNFS_DIR);
324a56e1 611 if (!kn) {
bc755553 612 ida_destroy(&root->ino_ida);
ba7443bc
TH
613 kfree(root);
614 return ERR_PTR(-ENOMEM);
615 }
616
df23fc39 617 kn->flags &= ~KERNFS_REMOVED;
324a56e1 618 kn->priv = priv;
adc5e8b5 619 kn->dir.root = root;
ba7443bc 620
324a56e1 621 root->kn = kn;
ba7443bc
TH
622
623 return root;
624}
625
626/**
627 * kernfs_destroy_root - destroy a kernfs hierarchy
628 * @root: root of the hierarchy to destroy
629 *
630 * Destroy the hierarchy anchored at @root by removing all existing
631 * directories and destroying @root.
632 */
633void kernfs_destroy_root(struct kernfs_root *root)
634{
324a56e1 635 kernfs_remove(root->kn); /* will also free @root */
ba7443bc
TH
636}
637
fd7b9f7b
TH
638/**
639 * kernfs_create_dir_ns - create a directory
640 * @parent: parent in which to create a new directory
641 * @name: name of the new directory
bb8b9d09 642 * @mode: mode of the new directory
fd7b9f7b
TH
643 * @priv: opaque data associated with the new directory
644 * @ns: optional namespace tag of the directory
645 *
646 * Returns the created node on success, ERR_PTR() value on failure.
647 */
324a56e1 648struct kernfs_node *kernfs_create_dir_ns(struct kernfs_node *parent,
bb8b9d09
TH
649 const char *name, umode_t mode,
650 void *priv, const void *ns)
fd7b9f7b 651{
c525aadd 652 struct kernfs_addrm_cxt acxt;
324a56e1 653 struct kernfs_node *kn;
fd7b9f7b
TH
654 int rc;
655
656 /* allocate */
bb8b9d09
TH
657 kn = kernfs_new_node(kernfs_root(parent), name, mode | S_IFDIR,
658 KERNFS_DIR);
324a56e1 659 if (!kn)
fd7b9f7b
TH
660 return ERR_PTR(-ENOMEM);
661
adc5e8b5
TH
662 kn->dir.root = parent->dir.root;
663 kn->ns = ns;
324a56e1 664 kn->priv = priv;
fd7b9f7b
TH
665
666 /* link in */
c637b8ac
TH
667 kernfs_addrm_start(&acxt);
668 rc = kernfs_add_one(&acxt, kn, parent);
669 kernfs_addrm_finish(&acxt);
fd7b9f7b
TH
670
671 if (!rc)
324a56e1 672 return kn;
fd7b9f7b 673
324a56e1 674 kernfs_put(kn);
fd7b9f7b
TH
675 return ERR_PTR(rc);
676}
677
c637b8ac
TH
678static struct dentry *kernfs_iop_lookup(struct inode *dir,
679 struct dentry *dentry,
680 unsigned int flags)
fd7b9f7b
TH
681{
682 struct dentry *ret = NULL;
324a56e1
TH
683 struct kernfs_node *parent = dentry->d_parent->d_fsdata;
684 struct kernfs_node *kn;
fd7b9f7b
TH
685 struct inode *inode;
686 const void *ns = NULL;
687
a797bfc3 688 mutex_lock(&kernfs_mutex);
fd7b9f7b 689
324a56e1 690 if (kernfs_ns_enabled(parent))
c525aadd 691 ns = kernfs_info(dir->i_sb)->ns;
fd7b9f7b 692
324a56e1 693 kn = kernfs_find_ns(parent, dentry->d_name.name, ns);
fd7b9f7b
TH
694
695 /* no such entry */
324a56e1 696 if (!kn) {
fd7b9f7b
TH
697 ret = ERR_PTR(-ENOENT);
698 goto out_unlock;
699 }
324a56e1
TH
700 kernfs_get(kn);
701 dentry->d_fsdata = kn;
fd7b9f7b
TH
702
703 /* attach dentry and inode */
c637b8ac 704 inode = kernfs_get_inode(dir->i_sb, kn);
fd7b9f7b
TH
705 if (!inode) {
706 ret = ERR_PTR(-ENOMEM);
707 goto out_unlock;
708 }
709
710 /* instantiate and hash dentry */
711 ret = d_materialise_unique(dentry, inode);
712 out_unlock:
a797bfc3 713 mutex_unlock(&kernfs_mutex);
fd7b9f7b
TH
714 return ret;
715}
716
a797bfc3 717const struct inode_operations kernfs_dir_iops = {
c637b8ac
TH
718 .lookup = kernfs_iop_lookup,
719 .permission = kernfs_iop_permission,
720 .setattr = kernfs_iop_setattr,
721 .getattr = kernfs_iop_getattr,
722 .setxattr = kernfs_iop_setxattr,
723 .removexattr = kernfs_iop_removexattr,
724 .getxattr = kernfs_iop_getxattr,
725 .listxattr = kernfs_iop_listxattr,
fd7b9f7b
TH
726};
727
c637b8ac 728static struct kernfs_node *kernfs_leftmost_descendant(struct kernfs_node *pos)
fd7b9f7b 729{
324a56e1 730 struct kernfs_node *last;
fd7b9f7b
TH
731
732 while (true) {
733 struct rb_node *rbn;
734
735 last = pos;
736
df23fc39 737 if (kernfs_type(pos) != KERNFS_DIR)
fd7b9f7b
TH
738 break;
739
adc5e8b5 740 rbn = rb_first(&pos->dir.children);
fd7b9f7b
TH
741 if (!rbn)
742 break;
743
324a56e1 744 pos = rb_to_kn(rbn);
fd7b9f7b
TH
745 }
746
747 return last;
748}
749
750/**
c637b8ac 751 * kernfs_next_descendant_post - find the next descendant for post-order walk
fd7b9f7b 752 * @pos: the current position (%NULL to initiate traversal)
324a56e1 753 * @root: kernfs_node whose descendants to walk
fd7b9f7b
TH
754 *
755 * Find the next descendant to visit for post-order traversal of @root's
756 * descendants. @root is included in the iteration and the last node to be
757 * visited.
758 */
c637b8ac
TH
759static struct kernfs_node *kernfs_next_descendant_post(struct kernfs_node *pos,
760 struct kernfs_node *root)
fd7b9f7b
TH
761{
762 struct rb_node *rbn;
763
a797bfc3 764 lockdep_assert_held(&kernfs_mutex);
fd7b9f7b
TH
765
766 /* if first iteration, visit leftmost descendant which may be root */
767 if (!pos)
c637b8ac 768 return kernfs_leftmost_descendant(root);
fd7b9f7b
TH
769
770 /* if we visited @root, we're done */
771 if (pos == root)
772 return NULL;
773
774 /* if there's an unvisited sibling, visit its leftmost descendant */
adc5e8b5 775 rbn = rb_next(&pos->rb);
fd7b9f7b 776 if (rbn)
c637b8ac 777 return kernfs_leftmost_descendant(rb_to_kn(rbn));
fd7b9f7b
TH
778
779 /* no sibling left, visit parent */
adc5e8b5 780 return pos->parent;
fd7b9f7b
TH
781}
782
c525aadd 783static void __kernfs_remove(struct kernfs_addrm_cxt *acxt,
324a56e1 784 struct kernfs_node *kn)
fd7b9f7b 785{
324a56e1 786 struct kernfs_node *pos, *next;
fd7b9f7b 787
324a56e1 788 if (!kn)
fd7b9f7b
TH
789 return;
790
c637b8ac 791 pr_debug("kernfs %s: removing\n", kn->name);
fd7b9f7b
TH
792
793 next = NULL;
794 do {
795 pos = next;
c637b8ac 796 next = kernfs_next_descendant_post(pos, kn);
fd7b9f7b 797 if (pos)
c637b8ac 798 kernfs_remove_one(acxt, pos);
fd7b9f7b
TH
799 } while (next);
800}
801
802/**
324a56e1
TH
803 * kernfs_remove - remove a kernfs_node recursively
804 * @kn: the kernfs_node to remove
fd7b9f7b 805 *
324a56e1 806 * Remove @kn along with all its subdirectories and files.
fd7b9f7b 807 */
324a56e1 808void kernfs_remove(struct kernfs_node *kn)
fd7b9f7b 809{
c525aadd 810 struct kernfs_addrm_cxt acxt;
fd7b9f7b 811
c637b8ac 812 kernfs_addrm_start(&acxt);
324a56e1 813 __kernfs_remove(&acxt, kn);
c637b8ac 814 kernfs_addrm_finish(&acxt);
fd7b9f7b
TH
815}
816
817/**
324a56e1
TH
818 * kernfs_remove_by_name_ns - find a kernfs_node by name and remove it
819 * @parent: parent of the target
820 * @name: name of the kernfs_node to remove
821 * @ns: namespace tag of the kernfs_node to remove
fd7b9f7b 822 *
324a56e1
TH
823 * Look for the kernfs_node with @name and @ns under @parent and remove it.
824 * Returns 0 on success, -ENOENT if such entry doesn't exist.
fd7b9f7b 825 */
324a56e1 826int kernfs_remove_by_name_ns(struct kernfs_node *parent, const char *name,
fd7b9f7b
TH
827 const void *ns)
828{
c525aadd 829 struct kernfs_addrm_cxt acxt;
324a56e1 830 struct kernfs_node *kn;
fd7b9f7b 831
324a56e1 832 if (!parent) {
c637b8ac 833 WARN(1, KERN_WARNING "kernfs: can not remove '%s', no directory\n",
fd7b9f7b
TH
834 name);
835 return -ENOENT;
836 }
837
c637b8ac 838 kernfs_addrm_start(&acxt);
fd7b9f7b 839
324a56e1
TH
840 kn = kernfs_find_ns(parent, name, ns);
841 if (kn)
842 __kernfs_remove(&acxt, kn);
fd7b9f7b 843
c637b8ac 844 kernfs_addrm_finish(&acxt);
fd7b9f7b 845
324a56e1 846 if (kn)
fd7b9f7b
TH
847 return 0;
848 else
849 return -ENOENT;
850}
851
852/**
853 * kernfs_rename_ns - move and rename a kernfs_node
324a56e1 854 * @kn: target node
fd7b9f7b
TH
855 * @new_parent: new parent to put @sd under
856 * @new_name: new name
857 * @new_ns: new namespace tag
858 */
324a56e1 859int kernfs_rename_ns(struct kernfs_node *kn, struct kernfs_node *new_parent,
fd7b9f7b
TH
860 const char *new_name, const void *new_ns)
861{
862 int error;
863
a797bfc3 864 mutex_lock(&kernfs_mutex);
fd7b9f7b
TH
865
866 error = 0;
adc5e8b5
TH
867 if ((kn->parent == new_parent) && (kn->ns == new_ns) &&
868 (strcmp(kn->name, new_name) == 0))
fd7b9f7b
TH
869 goto out; /* nothing to rename */
870
871 error = -EEXIST;
872 if (kernfs_find_ns(new_parent, new_name, new_ns))
873 goto out;
874
324a56e1 875 /* rename kernfs_node */
adc5e8b5 876 if (strcmp(kn->name, new_name) != 0) {
fd7b9f7b
TH
877 error = -ENOMEM;
878 new_name = kstrdup(new_name, GFP_KERNEL);
879 if (!new_name)
880 goto out;
881
adc5e8b5
TH
882 kfree(kn->name);
883 kn->name = new_name;
fd7b9f7b
TH
884 }
885
886 /*
887 * Move to the appropriate place in the appropriate directories rbtree.
888 */
c637b8ac 889 kernfs_unlink_sibling(kn);
fd7b9f7b 890 kernfs_get(new_parent);
adc5e8b5
TH
891 kernfs_put(kn->parent);
892 kn->ns = new_ns;
c637b8ac 893 kn->hash = kernfs_name_hash(kn->name, kn->ns);
adc5e8b5 894 kn->parent = new_parent;
c637b8ac 895 kernfs_link_sibling(kn);
fd7b9f7b
TH
896
897 error = 0;
898 out:
a797bfc3 899 mutex_unlock(&kernfs_mutex);
fd7b9f7b
TH
900 return error;
901}
902
fd7b9f7b 903/* Relationship between s_mode and the DT_xxx types */
324a56e1 904static inline unsigned char dt_type(struct kernfs_node *kn)
fd7b9f7b 905{
adc5e8b5 906 return (kn->mode >> 12) & 15;
fd7b9f7b
TH
907}
908
c637b8ac 909static int kernfs_dir_fop_release(struct inode *inode, struct file *filp)
fd7b9f7b
TH
910{
911 kernfs_put(filp->private_data);
912 return 0;
913}
914
c637b8ac 915static struct kernfs_node *kernfs_dir_pos(const void *ns,
324a56e1 916 struct kernfs_node *parent, loff_t hash, struct kernfs_node *pos)
fd7b9f7b
TH
917{
918 if (pos) {
df23fc39 919 int valid = !(pos->flags & KERNFS_REMOVED) &&
adc5e8b5 920 pos->parent == parent && hash == pos->hash;
fd7b9f7b
TH
921 kernfs_put(pos);
922 if (!valid)
923 pos = NULL;
924 }
925 if (!pos && (hash > 1) && (hash < INT_MAX)) {
adc5e8b5 926 struct rb_node *node = parent->dir.children.rb_node;
fd7b9f7b 927 while (node) {
324a56e1 928 pos = rb_to_kn(node);
fd7b9f7b 929
adc5e8b5 930 if (hash < pos->hash)
fd7b9f7b 931 node = node->rb_left;
adc5e8b5 932 else if (hash > pos->hash)
fd7b9f7b
TH
933 node = node->rb_right;
934 else
935 break;
936 }
937 }
938 /* Skip over entries in the wrong namespace */
adc5e8b5
TH
939 while (pos && pos->ns != ns) {
940 struct rb_node *node = rb_next(&pos->rb);
fd7b9f7b
TH
941 if (!node)
942 pos = NULL;
943 else
324a56e1 944 pos = rb_to_kn(node);
fd7b9f7b
TH
945 }
946 return pos;
947}
948
c637b8ac 949static struct kernfs_node *kernfs_dir_next_pos(const void *ns,
324a56e1 950 struct kernfs_node *parent, ino_t ino, struct kernfs_node *pos)
fd7b9f7b 951{
c637b8ac 952 pos = kernfs_dir_pos(ns, parent, ino, pos);
fd7b9f7b
TH
953 if (pos)
954 do {
adc5e8b5 955 struct rb_node *node = rb_next(&pos->rb);
fd7b9f7b
TH
956 if (!node)
957 pos = NULL;
958 else
324a56e1 959 pos = rb_to_kn(node);
adc5e8b5 960 } while (pos && pos->ns != ns);
fd7b9f7b
TH
961 return pos;
962}
963
c637b8ac 964static int kernfs_fop_readdir(struct file *file, struct dir_context *ctx)
fd7b9f7b
TH
965{
966 struct dentry *dentry = file->f_path.dentry;
324a56e1
TH
967 struct kernfs_node *parent = dentry->d_fsdata;
968 struct kernfs_node *pos = file->private_data;
fd7b9f7b
TH
969 const void *ns = NULL;
970
971 if (!dir_emit_dots(file, ctx))
972 return 0;
a797bfc3 973 mutex_lock(&kernfs_mutex);
fd7b9f7b 974
324a56e1 975 if (kernfs_ns_enabled(parent))
c525aadd 976 ns = kernfs_info(dentry->d_sb)->ns;
fd7b9f7b 977
c637b8ac 978 for (pos = kernfs_dir_pos(ns, parent, ctx->pos, pos);
fd7b9f7b 979 pos;
c637b8ac 980 pos = kernfs_dir_next_pos(ns, parent, ctx->pos, pos)) {
adc5e8b5 981 const char *name = pos->name;
fd7b9f7b
TH
982 unsigned int type = dt_type(pos);
983 int len = strlen(name);
adc5e8b5 984 ino_t ino = pos->ino;
fd7b9f7b 985
adc5e8b5 986 ctx->pos = pos->hash;
fd7b9f7b
TH
987 file->private_data = pos;
988 kernfs_get(pos);
989
a797bfc3 990 mutex_unlock(&kernfs_mutex);
fd7b9f7b
TH
991 if (!dir_emit(ctx, name, len, ino, type))
992 return 0;
a797bfc3 993 mutex_lock(&kernfs_mutex);
fd7b9f7b 994 }
a797bfc3 995 mutex_unlock(&kernfs_mutex);
fd7b9f7b
TH
996 file->private_data = NULL;
997 ctx->pos = INT_MAX;
998 return 0;
999}
1000
c637b8ac
TH
1001static loff_t kernfs_dir_fop_llseek(struct file *file, loff_t offset,
1002 int whence)
fd7b9f7b
TH
1003{
1004 struct inode *inode = file_inode(file);
1005 loff_t ret;
1006
1007 mutex_lock(&inode->i_mutex);
1008 ret = generic_file_llseek(file, offset, whence);
1009 mutex_unlock(&inode->i_mutex);
1010
1011 return ret;
1012}
1013
a797bfc3 1014const struct file_operations kernfs_dir_fops = {
fd7b9f7b 1015 .read = generic_read_dir,
c637b8ac
TH
1016 .iterate = kernfs_fop_readdir,
1017 .release = kernfs_dir_fop_release,
1018 .llseek = kernfs_dir_fop_llseek,
fd7b9f7b 1019};
This page took 0.080349 seconds and 5 git commands to generate.