GNU Linux-libre 4.14.324-gnu1
[releases.git] / fs / kernfs / dir.c
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  */
10
11 #include <linux/sched.h>
12 #include <linux/fs.h>
13 #include <linux/namei.h>
14 #include <linux/idr.h>
15 #include <linux/slab.h>
16 #include <linux/security.h>
17 #include <linux/hash.h>
18
19 #include "kernfs-internal.h"
20
21 DEFINE_MUTEX(kernfs_mutex);
22 static DEFINE_SPINLOCK(kernfs_rename_lock);     /* kn->parent and ->name */
23 /*
24  * Don't use rename_lock to piggy back on pr_cont_buf. We don't want to
25  * call pr_cont() while holding rename_lock. Because sometimes pr_cont()
26  * will perform wakeups when releasing console_sem. Holding rename_lock
27  * will introduce deadlock if the scheduler reads the kernfs_name in the
28  * wakeup path.
29  */
30 static DEFINE_SPINLOCK(kernfs_pr_cont_lock);
31 static char kernfs_pr_cont_buf[PATH_MAX];       /* protected by pr_cont_lock */
32 static DEFINE_SPINLOCK(kernfs_idr_lock);        /* root->ino_idr */
33
34 #define rb_to_kn(X) rb_entry((X), struct kernfs_node, rb)
35
36 static bool kernfs_active(struct kernfs_node *kn)
37 {
38         lockdep_assert_held(&kernfs_mutex);
39         return atomic_read(&kn->active) >= 0;
40 }
41
42 static bool kernfs_lockdep(struct kernfs_node *kn)
43 {
44 #ifdef CONFIG_DEBUG_LOCK_ALLOC
45         return kn->flags & KERNFS_LOCKDEP;
46 #else
47         return false;
48 #endif
49 }
50
51 static int kernfs_name_locked(struct kernfs_node *kn, char *buf, size_t buflen)
52 {
53         if (!kn)
54                 return strlcpy(buf, "(null)", buflen);
55
56         return strlcpy(buf, kn->parent ? kn->name : "/", buflen);
57 }
58
59 /* kernfs_node_depth - compute depth from @from to @to */
60 static size_t kernfs_depth(struct kernfs_node *from, struct kernfs_node *to)
61 {
62         size_t depth = 0;
63
64         while (to->parent && to != from) {
65                 depth++;
66                 to = to->parent;
67         }
68         return depth;
69 }
70
71 static struct kernfs_node *kernfs_common_ancestor(struct kernfs_node *a,
72                                                   struct kernfs_node *b)
73 {
74         size_t da, db;
75         struct kernfs_root *ra = kernfs_root(a), *rb = kernfs_root(b);
76
77         if (ra != rb)
78                 return NULL;
79
80         da = kernfs_depth(ra->kn, a);
81         db = kernfs_depth(rb->kn, b);
82
83         while (da > db) {
84                 a = a->parent;
85                 da--;
86         }
87         while (db > da) {
88                 b = b->parent;
89                 db--;
90         }
91
92         /* worst case b and a will be the same at root */
93         while (b != a) {
94                 b = b->parent;
95                 a = a->parent;
96         }
97
98         return a;
99 }
100
101 /**
102  * kernfs_path_from_node_locked - find a pseudo-absolute path to @kn_to,
103  * where kn_from is treated as root of the path.
104  * @kn_from: kernfs node which should be treated as root for the path
105  * @kn_to: kernfs node to which path is needed
106  * @buf: buffer to copy the path into
107  * @buflen: size of @buf
108  *
109  * We need to handle couple of scenarios here:
110  * [1] when @kn_from is an ancestor of @kn_to at some level
111  * kn_from: /n1/n2/n3
112  * kn_to:   /n1/n2/n3/n4/n5
113  * result:  /n4/n5
114  *
115  * [2] when @kn_from is on a different hierarchy and we need to find common
116  * ancestor between @kn_from and @kn_to.
117  * kn_from: /n1/n2/n3/n4
118  * kn_to:   /n1/n2/n5
119  * result:  /../../n5
120  * OR
121  * kn_from: /n1/n2/n3/n4/n5   [depth=5]
122  * kn_to:   /n1/n2/n3         [depth=3]
123  * result:  /../..
124  *
125  * [3] when @kn_to is NULL result will be "(null)"
126  *
127  * Returns the length of the full path.  If the full length is equal to or
128  * greater than @buflen, @buf contains the truncated path with the trailing
129  * '\0'.  On error, -errno is returned.
130  */
131 static int kernfs_path_from_node_locked(struct kernfs_node *kn_to,
132                                         struct kernfs_node *kn_from,
133                                         char *buf, size_t buflen)
134 {
135         struct kernfs_node *kn, *common;
136         const char parent_str[] = "/..";
137         size_t depth_from, depth_to, len = 0;
138         int i, j;
139
140         if (!kn_to)
141                 return strlcpy(buf, "(null)", buflen);
142
143         if (!kn_from)
144                 kn_from = kernfs_root(kn_to)->kn;
145
146         if (kn_from == kn_to)
147                 return strlcpy(buf, "/", buflen);
148
149         common = kernfs_common_ancestor(kn_from, kn_to);
150         if (WARN_ON(!common))
151                 return -EINVAL;
152
153         depth_to = kernfs_depth(common, kn_to);
154         depth_from = kernfs_depth(common, kn_from);
155
156         if (buf)
157                 buf[0] = '\0';
158
159         for (i = 0; i < depth_from; i++)
160                 len += strlcpy(buf + len, parent_str,
161                                len < buflen ? buflen - len : 0);
162
163         /* Calculate how many bytes we need for the rest */
164         for (i = depth_to - 1; i >= 0; i--) {
165                 for (kn = kn_to, j = 0; j < i; j++)
166                         kn = kn->parent;
167                 len += strlcpy(buf + len, "/",
168                                len < buflen ? buflen - len : 0);
169                 len += strlcpy(buf + len, kn->name,
170                                len < buflen ? buflen - len : 0);
171         }
172
173         return len;
174 }
175
176 /**
177  * kernfs_name - obtain the name of a given node
178  * @kn: kernfs_node of interest
179  * @buf: buffer to copy @kn's name into
180  * @buflen: size of @buf
181  *
182  * Copies the name of @kn into @buf of @buflen bytes.  The behavior is
183  * similar to strlcpy().  It returns the length of @kn's name and if @buf
184  * isn't long enough, it's filled upto @buflen-1 and nul terminated.
185  *
186  * Fills buffer with "(null)" if @kn is NULL.
187  *
188  * This function can be called from any context.
189  */
190 int kernfs_name(struct kernfs_node *kn, char *buf, size_t buflen)
191 {
192         unsigned long flags;
193         int ret;
194
195         spin_lock_irqsave(&kernfs_rename_lock, flags);
196         ret = kernfs_name_locked(kn, buf, buflen);
197         spin_unlock_irqrestore(&kernfs_rename_lock, flags);
198         return ret;
199 }
200
201 /**
202  * kernfs_path_from_node - build path of node @to relative to @from.
203  * @from: parent kernfs_node relative to which we need to build the path
204  * @to: kernfs_node of interest
205  * @buf: buffer to copy @to's path into
206  * @buflen: size of @buf
207  *
208  * Builds @to's path relative to @from in @buf. @from and @to must
209  * be on the same kernfs-root. If @from is not parent of @to, then a relative
210  * path (which includes '..'s) as needed to reach from @from to @to is
211  * returned.
212  *
213  * Returns the length of the full path.  If the full length is equal to or
214  * greater than @buflen, @buf contains the truncated path with the trailing
215  * '\0'.  On error, -errno is returned.
216  */
217 int kernfs_path_from_node(struct kernfs_node *to, struct kernfs_node *from,
218                           char *buf, size_t buflen)
219 {
220         unsigned long flags;
221         int ret;
222
223         spin_lock_irqsave(&kernfs_rename_lock, flags);
224         ret = kernfs_path_from_node_locked(to, from, buf, buflen);
225         spin_unlock_irqrestore(&kernfs_rename_lock, flags);
226         return ret;
227 }
228 EXPORT_SYMBOL_GPL(kernfs_path_from_node);
229
230 /**
231  * pr_cont_kernfs_name - pr_cont name of a kernfs_node
232  * @kn: kernfs_node of interest
233  *
234  * This function can be called from any context.
235  */
236 void pr_cont_kernfs_name(struct kernfs_node *kn)
237 {
238         unsigned long flags;
239
240         spin_lock_irqsave(&kernfs_pr_cont_lock, flags);
241
242         kernfs_name(kn, kernfs_pr_cont_buf, sizeof(kernfs_pr_cont_buf));
243         pr_cont("%s", kernfs_pr_cont_buf);
244
245         spin_unlock_irqrestore(&kernfs_pr_cont_lock, flags);
246 }
247
248 /**
249  * pr_cont_kernfs_path - pr_cont path of a kernfs_node
250  * @kn: kernfs_node of interest
251  *
252  * This function can be called from any context.
253  */
254 void pr_cont_kernfs_path(struct kernfs_node *kn)
255 {
256         unsigned long flags;
257         int sz;
258
259         spin_lock_irqsave(&kernfs_pr_cont_lock, flags);
260
261         sz = kernfs_path_from_node(kn, NULL, kernfs_pr_cont_buf,
262                                    sizeof(kernfs_pr_cont_buf));
263         if (sz < 0) {
264                 pr_cont("(error)");
265                 goto out;
266         }
267
268         if (sz >= sizeof(kernfs_pr_cont_buf)) {
269                 pr_cont("(name too long)");
270                 goto out;
271         }
272
273         pr_cont("%s", kernfs_pr_cont_buf);
274
275 out:
276         spin_unlock_irqrestore(&kernfs_pr_cont_lock, flags);
277 }
278
279 /**
280  * kernfs_get_parent - determine the parent node and pin it
281  * @kn: kernfs_node of interest
282  *
283  * Determines @kn's parent, pins and returns it.  This function can be
284  * called from any context.
285  */
286 struct kernfs_node *kernfs_get_parent(struct kernfs_node *kn)
287 {
288         struct kernfs_node *parent;
289         unsigned long flags;
290
291         spin_lock_irqsave(&kernfs_rename_lock, flags);
292         parent = kn->parent;
293         kernfs_get(parent);
294         spin_unlock_irqrestore(&kernfs_rename_lock, flags);
295
296         return parent;
297 }
298
299 /**
300  *      kernfs_name_hash
301  *      @name: Null terminated string to hash
302  *      @ns:   Namespace tag to hash
303  *
304  *      Returns 31 bit hash of ns + name (so it fits in an off_t )
305  */
306 static unsigned int kernfs_name_hash(const char *name, const void *ns)
307 {
308         unsigned long hash = init_name_hash(ns);
309         unsigned int len = strlen(name);
310         while (len--)
311                 hash = partial_name_hash(*name++, hash);
312         hash = end_name_hash(hash);
313         hash &= 0x7fffffffU;
314         /* Reserve hash numbers 0, 1 and INT_MAX for magic directory entries */
315         if (hash < 2)
316                 hash += 2;
317         if (hash >= INT_MAX)
318                 hash = INT_MAX - 1;
319         return hash;
320 }
321
322 static int kernfs_name_compare(unsigned int hash, const char *name,
323                                const void *ns, const struct kernfs_node *kn)
324 {
325         if (hash < kn->hash)
326                 return -1;
327         if (hash > kn->hash)
328                 return 1;
329         if (ns < kn->ns)
330                 return -1;
331         if (ns > kn->ns)
332                 return 1;
333         return strcmp(name, kn->name);
334 }
335
336 static int kernfs_sd_compare(const struct kernfs_node *left,
337                              const struct kernfs_node *right)
338 {
339         return kernfs_name_compare(left->hash, left->name, left->ns, right);
340 }
341
342 /**
343  *      kernfs_link_sibling - link kernfs_node into sibling rbtree
344  *      @kn: kernfs_node of interest
345  *
346  *      Link @kn into its sibling rbtree which starts from
347  *      @kn->parent->dir.children.
348  *
349  *      Locking:
350  *      mutex_lock(kernfs_mutex)
351  *
352  *      RETURNS:
353  *      0 on susccess -EEXIST on failure.
354  */
355 static int kernfs_link_sibling(struct kernfs_node *kn)
356 {
357         struct rb_node **node = &kn->parent->dir.children.rb_node;
358         struct rb_node *parent = NULL;
359
360         while (*node) {
361                 struct kernfs_node *pos;
362                 int result;
363
364                 pos = rb_to_kn(*node);
365                 parent = *node;
366                 result = kernfs_sd_compare(kn, pos);
367                 if (result < 0)
368                         node = &pos->rb.rb_left;
369                 else if (result > 0)
370                         node = &pos->rb.rb_right;
371                 else
372                         return -EEXIST;
373         }
374
375         /* add new node and rebalance the tree */
376         rb_link_node(&kn->rb, parent, node);
377         rb_insert_color(&kn->rb, &kn->parent->dir.children);
378
379         /* successfully added, account subdir number */
380         if (kernfs_type(kn) == KERNFS_DIR)
381                 kn->parent->dir.subdirs++;
382
383         return 0;
384 }
385
386 /**
387  *      kernfs_unlink_sibling - unlink kernfs_node from sibling rbtree
388  *      @kn: kernfs_node of interest
389  *
390  *      Try to unlink @kn from its sibling rbtree which starts from
391  *      kn->parent->dir.children.  Returns %true if @kn was actually
392  *      removed, %false if @kn wasn't on the rbtree.
393  *
394  *      Locking:
395  *      mutex_lock(kernfs_mutex)
396  */
397 static bool kernfs_unlink_sibling(struct kernfs_node *kn)
398 {
399         if (RB_EMPTY_NODE(&kn->rb))
400                 return false;
401
402         if (kernfs_type(kn) == KERNFS_DIR)
403                 kn->parent->dir.subdirs--;
404
405         rb_erase(&kn->rb, &kn->parent->dir.children);
406         RB_CLEAR_NODE(&kn->rb);
407         return true;
408 }
409
410 /**
411  *      kernfs_get_active - get an active reference to kernfs_node
412  *      @kn: kernfs_node to get an active reference to
413  *
414  *      Get an active reference of @kn.  This function is noop if @kn
415  *      is NULL.
416  *
417  *      RETURNS:
418  *      Pointer to @kn on success, NULL on failure.
419  */
420 struct kernfs_node *kernfs_get_active(struct kernfs_node *kn)
421 {
422         if (unlikely(!kn))
423                 return NULL;
424
425         if (!atomic_inc_unless_negative(&kn->active))
426                 return NULL;
427
428         if (kernfs_lockdep(kn))
429                 rwsem_acquire_read(&kn->dep_map, 0, 1, _RET_IP_);
430         return kn;
431 }
432
433 /**
434  *      kernfs_put_active - put an active reference to kernfs_node
435  *      @kn: kernfs_node to put an active reference to
436  *
437  *      Put an active reference to @kn.  This function is noop if @kn
438  *      is NULL.
439  */
440 void kernfs_put_active(struct kernfs_node *kn)
441 {
442         struct kernfs_root *root = kernfs_root(kn);
443         int v;
444
445         if (unlikely(!kn))
446                 return;
447
448         if (kernfs_lockdep(kn))
449                 rwsem_release(&kn->dep_map, 1, _RET_IP_);
450         v = atomic_dec_return(&kn->active);
451         if (likely(v != KN_DEACTIVATED_BIAS))
452                 return;
453
454         wake_up_all(&root->deactivate_waitq);
455 }
456
457 /**
458  * kernfs_drain - drain kernfs_node
459  * @kn: kernfs_node to drain
460  *
461  * Drain existing usages and nuke all existing mmaps of @kn.  Mutiple
462  * removers may invoke this function concurrently on @kn and all will
463  * return after draining is complete.
464  */
465 static void kernfs_drain(struct kernfs_node *kn)
466         __releases(&kernfs_mutex) __acquires(&kernfs_mutex)
467 {
468         struct kernfs_root *root = kernfs_root(kn);
469
470         lockdep_assert_held(&kernfs_mutex);
471         WARN_ON_ONCE(kernfs_active(kn));
472
473         mutex_unlock(&kernfs_mutex);
474
475         if (kernfs_lockdep(kn)) {
476                 rwsem_acquire(&kn->dep_map, 0, 0, _RET_IP_);
477                 if (atomic_read(&kn->active) != KN_DEACTIVATED_BIAS)
478                         lock_contended(&kn->dep_map, _RET_IP_);
479         }
480
481         /* but everyone should wait for draining */
482         wait_event(root->deactivate_waitq,
483                    atomic_read(&kn->active) == KN_DEACTIVATED_BIAS);
484
485         if (kernfs_lockdep(kn)) {
486                 lock_acquired(&kn->dep_map, _RET_IP_);
487                 rwsem_release(&kn->dep_map, 1, _RET_IP_);
488         }
489
490         kernfs_drain_open_files(kn);
491
492         mutex_lock(&kernfs_mutex);
493 }
494
495 /**
496  * kernfs_get - get a reference count on a kernfs_node
497  * @kn: the target kernfs_node
498  */
499 void kernfs_get(struct kernfs_node *kn)
500 {
501         if (kn) {
502                 WARN_ON(!atomic_read(&kn->count));
503                 atomic_inc(&kn->count);
504         }
505 }
506 EXPORT_SYMBOL_GPL(kernfs_get);
507
508 /**
509  * kernfs_put - put a reference count on a kernfs_node
510  * @kn: the target kernfs_node
511  *
512  * Put a reference count of @kn and destroy it if it reached zero.
513  */
514 void kernfs_put(struct kernfs_node *kn)
515 {
516         struct kernfs_node *parent;
517         struct kernfs_root *root;
518
519         /*
520          * kernfs_node is freed with ->count 0, kernfs_find_and_get_node_by_ino
521          * depends on this to filter reused stale node
522          */
523         if (!kn || !atomic_dec_and_test(&kn->count))
524                 return;
525         root = kernfs_root(kn);
526  repeat:
527         /*
528          * Moving/renaming is always done while holding reference.
529          * kn->parent won't change beneath us.
530          */
531         parent = kn->parent;
532
533         WARN_ONCE(atomic_read(&kn->active) != KN_DEACTIVATED_BIAS,
534                   "kernfs_put: %s/%s: released with incorrect active_ref %d\n",
535                   parent ? parent->name : "", kn->name, atomic_read(&kn->active));
536
537         if (kernfs_type(kn) == KERNFS_LINK)
538                 kernfs_put(kn->symlink.target_kn);
539
540         kfree_const(kn->name);
541
542         if (kn->iattr) {
543                 if (kn->iattr->ia_secdata)
544                         security_release_secctx(kn->iattr->ia_secdata,
545                                                 kn->iattr->ia_secdata_len);
546                 simple_xattrs_free(&kn->iattr->xattrs);
547         }
548         kfree(kn->iattr);
549         spin_lock(&kernfs_idr_lock);
550         idr_remove(&root->ino_idr, kn->id.ino);
551         spin_unlock(&kernfs_idr_lock);
552         kmem_cache_free(kernfs_node_cache, kn);
553
554         kn = parent;
555         if (kn) {
556                 if (atomic_dec_and_test(&kn->count))
557                         goto repeat;
558         } else {
559                 /* just released the root kn, free @root too */
560                 idr_destroy(&root->ino_idr);
561                 kfree(root);
562         }
563 }
564 EXPORT_SYMBOL_GPL(kernfs_put);
565
566 static int kernfs_dop_revalidate(struct dentry *dentry, unsigned int flags)
567 {
568         struct kernfs_node *kn;
569
570         if (flags & LOOKUP_RCU)
571                 return -ECHILD;
572
573         /* Always perform fresh lookup for negatives */
574         if (d_really_is_negative(dentry))
575                 goto out_bad_unlocked;
576
577         kn = kernfs_dentry_node(dentry);
578         mutex_lock(&kernfs_mutex);
579
580         /* The kernfs node has been deactivated */
581         if (!kernfs_active(kn))
582                 goto out_bad;
583
584         /* The kernfs node has been moved? */
585         if (kernfs_dentry_node(dentry->d_parent) != kn->parent)
586                 goto out_bad;
587
588         /* The kernfs node has been renamed */
589         if (strcmp(dentry->d_name.name, kn->name) != 0)
590                 goto out_bad;
591
592         /* The kernfs node has been moved to a different namespace */
593         if (kn->parent && kernfs_ns_enabled(kn->parent) &&
594             kernfs_info(dentry->d_sb)->ns != kn->ns)
595                 goto out_bad;
596
597         mutex_unlock(&kernfs_mutex);
598         return 1;
599 out_bad:
600         mutex_unlock(&kernfs_mutex);
601 out_bad_unlocked:
602         return 0;
603 }
604
605 const struct dentry_operations kernfs_dops = {
606         .d_revalidate   = kernfs_dop_revalidate,
607 };
608
609 /**
610  * kernfs_node_from_dentry - determine kernfs_node associated with a dentry
611  * @dentry: the dentry in question
612  *
613  * Return the kernfs_node associated with @dentry.  If @dentry is not a
614  * kernfs one, %NULL is returned.
615  *
616  * While the returned kernfs_node will stay accessible as long as @dentry
617  * is accessible, the returned node can be in any state and the caller is
618  * fully responsible for determining what's accessible.
619  */
620 struct kernfs_node *kernfs_node_from_dentry(struct dentry *dentry)
621 {
622         if (dentry->d_sb->s_op == &kernfs_sops &&
623             !d_really_is_negative(dentry))
624                 return kernfs_dentry_node(dentry);
625         return NULL;
626 }
627
628 static struct kernfs_node *__kernfs_new_node(struct kernfs_root *root,
629                                              const char *name, umode_t mode,
630                                              unsigned flags)
631 {
632         struct kernfs_node *kn;
633         u32 gen;
634         int ret;
635
636         name = kstrdup_const(name, GFP_KERNEL);
637         if (!name)
638                 return NULL;
639
640         kn = kmem_cache_zalloc(kernfs_node_cache, GFP_KERNEL);
641         if (!kn)
642                 goto err_out1;
643
644         idr_preload(GFP_KERNEL);
645         spin_lock(&kernfs_idr_lock);
646         ret = idr_alloc_cyclic(&root->ino_idr, kn, 1, 0, GFP_ATOMIC);
647         if (ret >= 0 && ret < root->last_ino)
648                 root->next_generation++;
649         gen = root->next_generation;
650         root->last_ino = ret;
651         spin_unlock(&kernfs_idr_lock);
652         idr_preload_end();
653         if (ret < 0)
654                 goto err_out2;
655         kn->id.ino = ret;
656         kn->id.generation = gen;
657
658         /*
659          * set ino first. This RELEASE is paired with atomic_inc_not_zero in
660          * kernfs_find_and_get_node_by_ino
661          */
662         atomic_set_release(&kn->count, 1);
663         atomic_set(&kn->active, KN_DEACTIVATED_BIAS);
664         RB_CLEAR_NODE(&kn->rb);
665
666         kn->name = name;
667         kn->mode = mode;
668         kn->flags = flags;
669
670         return kn;
671
672  err_out2:
673         kmem_cache_free(kernfs_node_cache, kn);
674  err_out1:
675         kfree_const(name);
676         return NULL;
677 }
678
679 struct kernfs_node *kernfs_new_node(struct kernfs_node *parent,
680                                     const char *name, umode_t mode,
681                                     unsigned flags)
682 {
683         struct kernfs_node *kn;
684
685         kn = __kernfs_new_node(kernfs_root(parent), name, mode, flags);
686         if (kn) {
687                 kernfs_get(parent);
688                 kn->parent = parent;
689         }
690         return kn;
691 }
692
693 /*
694  * kernfs_find_and_get_node_by_ino - get kernfs_node from inode number
695  * @root: the kernfs root
696  * @ino: inode number
697  *
698  * RETURNS:
699  * NULL on failure. Return a kernfs node with reference counter incremented
700  */
701 struct kernfs_node *kernfs_find_and_get_node_by_ino(struct kernfs_root *root,
702                                                     unsigned int ino)
703 {
704         struct kernfs_node *kn;
705
706         rcu_read_lock();
707         kn = idr_find(&root->ino_idr, ino);
708         if (!kn)
709                 goto out;
710
711         /*
712          * Since kernfs_node is freed in RCU, it's possible an old node for ino
713          * is freed, but reused before RCU grace period. But a freed node (see
714          * kernfs_put) or an incompletedly initialized node (see
715          * __kernfs_new_node) should have 'count' 0. We can use this fact to
716          * filter out such node.
717          */
718         if (!atomic_inc_not_zero(&kn->count)) {
719                 kn = NULL;
720                 goto out;
721         }
722
723         /*
724          * The node could be a new node or a reused node. If it's a new node,
725          * we are ok. If it's reused because of RCU (because of
726          * SLAB_TYPESAFE_BY_RCU), the __kernfs_new_node always sets its 'ino'
727          * before 'count'. So if 'count' is uptodate, 'ino' should be uptodate,
728          * hence we can use 'ino' to filter stale node.
729          */
730         if (kn->id.ino != ino)
731                 goto out;
732         rcu_read_unlock();
733
734         return kn;
735 out:
736         rcu_read_unlock();
737         kernfs_put(kn);
738         return NULL;
739 }
740
741 /**
742  *      kernfs_add_one - add kernfs_node to parent without warning
743  *      @kn: kernfs_node to be added
744  *
745  *      The caller must already have initialized @kn->parent.  This
746  *      function increments nlink of the parent's inode if @kn is a
747  *      directory and link into the children list of the parent.
748  *
749  *      RETURNS:
750  *      0 on success, -EEXIST if entry with the given name already
751  *      exists.
752  */
753 int kernfs_add_one(struct kernfs_node *kn)
754 {
755         struct kernfs_node *parent = kn->parent;
756         struct kernfs_iattrs *ps_iattr;
757         bool has_ns;
758         int ret;
759
760         mutex_lock(&kernfs_mutex);
761
762         ret = -EINVAL;
763         has_ns = kernfs_ns_enabled(parent);
764         if (WARN(has_ns != (bool)kn->ns, KERN_WARNING "kernfs: ns %s in '%s' for '%s'\n",
765                  has_ns ? "required" : "invalid", parent->name, kn->name))
766                 goto out_unlock;
767
768         if (kernfs_type(parent) != KERNFS_DIR)
769                 goto out_unlock;
770
771         ret = -ENOENT;
772         if (parent->flags & KERNFS_EMPTY_DIR)
773                 goto out_unlock;
774
775         if ((parent->flags & KERNFS_ACTIVATED) && !kernfs_active(parent))
776                 goto out_unlock;
777
778         kn->hash = kernfs_name_hash(kn->name, kn->ns);
779
780         ret = kernfs_link_sibling(kn);
781         if (ret)
782                 goto out_unlock;
783
784         /* Update timestamps on the parent */
785         ps_iattr = parent->iattr;
786         if (ps_iattr) {
787                 struct iattr *ps_iattrs = &ps_iattr->ia_iattr;
788                 ktime_get_real_ts(&ps_iattrs->ia_ctime);
789                 ps_iattrs->ia_mtime = ps_iattrs->ia_ctime;
790         }
791
792         mutex_unlock(&kernfs_mutex);
793
794         /*
795          * Activate the new node unless CREATE_DEACTIVATED is requested.
796          * If not activated here, the kernfs user is responsible for
797          * activating the node with kernfs_activate().  A node which hasn't
798          * been activated is not visible to userland and its removal won't
799          * trigger deactivation.
800          */
801         if (!(kernfs_root(kn)->flags & KERNFS_ROOT_CREATE_DEACTIVATED))
802                 kernfs_activate(kn);
803         return 0;
804
805 out_unlock:
806         mutex_unlock(&kernfs_mutex);
807         return ret;
808 }
809
810 /**
811  * kernfs_find_ns - find kernfs_node with the given name
812  * @parent: kernfs_node to search under
813  * @name: name to look for
814  * @ns: the namespace tag to use
815  *
816  * Look for kernfs_node with name @name under @parent.  Returns pointer to
817  * the found kernfs_node on success, %NULL on failure.
818  */
819 static struct kernfs_node *kernfs_find_ns(struct kernfs_node *parent,
820                                           const unsigned char *name,
821                                           const void *ns)
822 {
823         struct rb_node *node = parent->dir.children.rb_node;
824         bool has_ns = kernfs_ns_enabled(parent);
825         unsigned int hash;
826
827         lockdep_assert_held(&kernfs_mutex);
828
829         if (has_ns != (bool)ns) {
830                 WARN(1, KERN_WARNING "kernfs: ns %s in '%s' for '%s'\n",
831                      has_ns ? "required" : "invalid", parent->name, name);
832                 return NULL;
833         }
834
835         hash = kernfs_name_hash(name, ns);
836         while (node) {
837                 struct kernfs_node *kn;
838                 int result;
839
840                 kn = rb_to_kn(node);
841                 result = kernfs_name_compare(hash, name, ns, kn);
842                 if (result < 0)
843                         node = node->rb_left;
844                 else if (result > 0)
845                         node = node->rb_right;
846                 else
847                         return kn;
848         }
849         return NULL;
850 }
851
852 static struct kernfs_node *kernfs_walk_ns(struct kernfs_node *parent,
853                                           const unsigned char *path,
854                                           const void *ns)
855 {
856         size_t len;
857         char *p, *name;
858
859         lockdep_assert_held(&kernfs_mutex);
860
861         spin_lock_irq(&kernfs_pr_cont_lock);
862
863         len = strlcpy(kernfs_pr_cont_buf, path, sizeof(kernfs_pr_cont_buf));
864
865         if (len >= sizeof(kernfs_pr_cont_buf)) {
866                 spin_unlock_irq(&kernfs_pr_cont_lock);
867                 return NULL;
868         }
869
870         p = kernfs_pr_cont_buf;
871
872         while ((name = strsep(&p, "/")) && parent) {
873                 if (*name == '\0')
874                         continue;
875                 parent = kernfs_find_ns(parent, name, ns);
876         }
877
878         spin_unlock_irq(&kernfs_pr_cont_lock);
879
880         return parent;
881 }
882
883 /**
884  * kernfs_find_and_get_ns - find and get kernfs_node with the given name
885  * @parent: kernfs_node to search under
886  * @name: name to look for
887  * @ns: the namespace tag to use
888  *
889  * Look for kernfs_node with name @name under @parent and get a reference
890  * if found.  This function may sleep and returns pointer to the found
891  * kernfs_node on success, %NULL on failure.
892  */
893 struct kernfs_node *kernfs_find_and_get_ns(struct kernfs_node *parent,
894                                            const char *name, const void *ns)
895 {
896         struct kernfs_node *kn;
897
898         mutex_lock(&kernfs_mutex);
899         kn = kernfs_find_ns(parent, name, ns);
900         kernfs_get(kn);
901         mutex_unlock(&kernfs_mutex);
902
903         return kn;
904 }
905 EXPORT_SYMBOL_GPL(kernfs_find_and_get_ns);
906
907 /**
908  * kernfs_walk_and_get_ns - find and get kernfs_node with the given path
909  * @parent: kernfs_node to search under
910  * @path: path to look for
911  * @ns: the namespace tag to use
912  *
913  * Look for kernfs_node with path @path under @parent and get a reference
914  * if found.  This function may sleep and returns pointer to the found
915  * kernfs_node on success, %NULL on failure.
916  */
917 struct kernfs_node *kernfs_walk_and_get_ns(struct kernfs_node *parent,
918                                            const char *path, const void *ns)
919 {
920         struct kernfs_node *kn;
921
922         mutex_lock(&kernfs_mutex);
923         kn = kernfs_walk_ns(parent, path, ns);
924         kernfs_get(kn);
925         mutex_unlock(&kernfs_mutex);
926
927         return kn;
928 }
929
930 /**
931  * kernfs_create_root - create a new kernfs hierarchy
932  * @scops: optional syscall operations for the hierarchy
933  * @flags: KERNFS_ROOT_* flags
934  * @priv: opaque data associated with the new directory
935  *
936  * Returns the root of the new hierarchy on success, ERR_PTR() value on
937  * failure.
938  */
939 struct kernfs_root *kernfs_create_root(struct kernfs_syscall_ops *scops,
940                                        unsigned int flags, void *priv)
941 {
942         struct kernfs_root *root;
943         struct kernfs_node *kn;
944
945         root = kzalloc(sizeof(*root), GFP_KERNEL);
946         if (!root)
947                 return ERR_PTR(-ENOMEM);
948
949         idr_init(&root->ino_idr);
950         INIT_LIST_HEAD(&root->supers);
951         root->next_generation = 1;
952
953         kn = __kernfs_new_node(root, "", S_IFDIR | S_IRUGO | S_IXUGO,
954                                KERNFS_DIR);
955         if (!kn) {
956                 idr_destroy(&root->ino_idr);
957                 kfree(root);
958                 return ERR_PTR(-ENOMEM);
959         }
960
961         kn->priv = priv;
962         kn->dir.root = root;
963
964         root->syscall_ops = scops;
965         root->flags = flags;
966         root->kn = kn;
967         init_waitqueue_head(&root->deactivate_waitq);
968
969         if (!(root->flags & KERNFS_ROOT_CREATE_DEACTIVATED))
970                 kernfs_activate(kn);
971
972         return root;
973 }
974
975 /**
976  * kernfs_destroy_root - destroy a kernfs hierarchy
977  * @root: root of the hierarchy to destroy
978  *
979  * Destroy the hierarchy anchored at @root by removing all existing
980  * directories and destroying @root.
981  */
982 void kernfs_destroy_root(struct kernfs_root *root)
983 {
984         kernfs_remove(root->kn);        /* will also free @root */
985 }
986
987 /**
988  * kernfs_create_dir_ns - create a directory
989  * @parent: parent in which to create a new directory
990  * @name: name of the new directory
991  * @mode: mode of the new directory
992  * @priv: opaque data associated with the new directory
993  * @ns: optional namespace tag of the directory
994  *
995  * Returns the created node on success, ERR_PTR() value on failure.
996  */
997 struct kernfs_node *kernfs_create_dir_ns(struct kernfs_node *parent,
998                                          const char *name, umode_t mode,
999                                          void *priv, const void *ns)
1000 {
1001         struct kernfs_node *kn;
1002         int rc;
1003
1004         /* allocate */
1005         kn = kernfs_new_node(parent, name, mode | S_IFDIR, KERNFS_DIR);
1006         if (!kn)
1007                 return ERR_PTR(-ENOMEM);
1008
1009         kn->dir.root = parent->dir.root;
1010         kn->ns = ns;
1011         kn->priv = priv;
1012
1013         /* link in */
1014         rc = kernfs_add_one(kn);
1015         if (!rc)
1016                 return kn;
1017
1018         kernfs_put(kn);
1019         return ERR_PTR(rc);
1020 }
1021
1022 /**
1023  * kernfs_create_empty_dir - create an always empty directory
1024  * @parent: parent in which to create a new directory
1025  * @name: name of the new directory
1026  *
1027  * Returns the created node on success, ERR_PTR() value on failure.
1028  */
1029 struct kernfs_node *kernfs_create_empty_dir(struct kernfs_node *parent,
1030                                             const char *name)
1031 {
1032         struct kernfs_node *kn;
1033         int rc;
1034
1035         /* allocate */
1036         kn = kernfs_new_node(parent, name, S_IRUGO|S_IXUGO|S_IFDIR, KERNFS_DIR);
1037         if (!kn)
1038                 return ERR_PTR(-ENOMEM);
1039
1040         kn->flags |= KERNFS_EMPTY_DIR;
1041         kn->dir.root = parent->dir.root;
1042         kn->ns = NULL;
1043         kn->priv = NULL;
1044
1045         /* link in */
1046         rc = kernfs_add_one(kn);
1047         if (!rc)
1048                 return kn;
1049
1050         kernfs_put(kn);
1051         return ERR_PTR(rc);
1052 }
1053
1054 static struct dentry *kernfs_iop_lookup(struct inode *dir,
1055                                         struct dentry *dentry,
1056                                         unsigned int flags)
1057 {
1058         struct dentry *ret;
1059         struct kernfs_node *parent = dir->i_private;
1060         struct kernfs_node *kn;
1061         struct inode *inode;
1062         const void *ns = NULL;
1063
1064         mutex_lock(&kernfs_mutex);
1065
1066         if (kernfs_ns_enabled(parent))
1067                 ns = kernfs_info(dir->i_sb)->ns;
1068
1069         kn = kernfs_find_ns(parent, dentry->d_name.name, ns);
1070
1071         /* no such entry */
1072         if (!kn || !kernfs_active(kn)) {
1073                 ret = NULL;
1074                 goto out_unlock;
1075         }
1076
1077         /* attach dentry and inode */
1078         inode = kernfs_get_inode(dir->i_sb, kn);
1079         if (!inode) {
1080                 ret = ERR_PTR(-ENOMEM);
1081                 goto out_unlock;
1082         }
1083
1084         /* instantiate and hash dentry */
1085         ret = d_splice_alias(inode, dentry);
1086  out_unlock:
1087         mutex_unlock(&kernfs_mutex);
1088         return ret;
1089 }
1090
1091 static int kernfs_iop_mkdir(struct inode *dir, struct dentry *dentry,
1092                             umode_t mode)
1093 {
1094         struct kernfs_node *parent = dir->i_private;
1095         struct kernfs_syscall_ops *scops = kernfs_root(parent)->syscall_ops;
1096         int ret;
1097
1098         if (!scops || !scops->mkdir)
1099                 return -EPERM;
1100
1101         if (!kernfs_get_active(parent))
1102                 return -ENODEV;
1103
1104         ret = scops->mkdir(parent, dentry->d_name.name, mode);
1105
1106         kernfs_put_active(parent);
1107         return ret;
1108 }
1109
1110 static int kernfs_iop_rmdir(struct inode *dir, struct dentry *dentry)
1111 {
1112         struct kernfs_node *kn  = kernfs_dentry_node(dentry);
1113         struct kernfs_syscall_ops *scops = kernfs_root(kn)->syscall_ops;
1114         int ret;
1115
1116         if (!scops || !scops->rmdir)
1117                 return -EPERM;
1118
1119         if (!kernfs_get_active(kn))
1120                 return -ENODEV;
1121
1122         ret = scops->rmdir(kn);
1123
1124         kernfs_put_active(kn);
1125         return ret;
1126 }
1127
1128 static int kernfs_iop_rename(struct inode *old_dir, struct dentry *old_dentry,
1129                              struct inode *new_dir, struct dentry *new_dentry,
1130                              unsigned int flags)
1131 {
1132         struct kernfs_node *kn = kernfs_dentry_node(old_dentry);
1133         struct kernfs_node *new_parent = new_dir->i_private;
1134         struct kernfs_syscall_ops *scops = kernfs_root(kn)->syscall_ops;
1135         int ret;
1136
1137         if (flags)
1138                 return -EINVAL;
1139
1140         if (!scops || !scops->rename)
1141                 return -EPERM;
1142
1143         if (!kernfs_get_active(kn))
1144                 return -ENODEV;
1145
1146         if (!kernfs_get_active(new_parent)) {
1147                 kernfs_put_active(kn);
1148                 return -ENODEV;
1149         }
1150
1151         ret = scops->rename(kn, new_parent, new_dentry->d_name.name);
1152
1153         kernfs_put_active(new_parent);
1154         kernfs_put_active(kn);
1155         return ret;
1156 }
1157
1158 const struct inode_operations kernfs_dir_iops = {
1159         .lookup         = kernfs_iop_lookup,
1160         .permission     = kernfs_iop_permission,
1161         .setattr        = kernfs_iop_setattr,
1162         .getattr        = kernfs_iop_getattr,
1163         .listxattr      = kernfs_iop_listxattr,
1164
1165         .mkdir          = kernfs_iop_mkdir,
1166         .rmdir          = kernfs_iop_rmdir,
1167         .rename         = kernfs_iop_rename,
1168 };
1169
1170 static struct kernfs_node *kernfs_leftmost_descendant(struct kernfs_node *pos)
1171 {
1172         struct kernfs_node *last;
1173
1174         while (true) {
1175                 struct rb_node *rbn;
1176
1177                 last = pos;
1178
1179                 if (kernfs_type(pos) != KERNFS_DIR)
1180                         break;
1181
1182                 rbn = rb_first(&pos->dir.children);
1183                 if (!rbn)
1184                         break;
1185
1186                 pos = rb_to_kn(rbn);
1187         }
1188
1189         return last;
1190 }
1191
1192 /**
1193  * kernfs_next_descendant_post - find the next descendant for post-order walk
1194  * @pos: the current position (%NULL to initiate traversal)
1195  * @root: kernfs_node whose descendants to walk
1196  *
1197  * Find the next descendant to visit for post-order traversal of @root's
1198  * descendants.  @root is included in the iteration and the last node to be
1199  * visited.
1200  */
1201 static struct kernfs_node *kernfs_next_descendant_post(struct kernfs_node *pos,
1202                                                        struct kernfs_node *root)
1203 {
1204         struct rb_node *rbn;
1205
1206         lockdep_assert_held(&kernfs_mutex);
1207
1208         /* if first iteration, visit leftmost descendant which may be root */
1209         if (!pos)
1210                 return kernfs_leftmost_descendant(root);
1211
1212         /* if we visited @root, we're done */
1213         if (pos == root)
1214                 return NULL;
1215
1216         /* if there's an unvisited sibling, visit its leftmost descendant */
1217         rbn = rb_next(&pos->rb);
1218         if (rbn)
1219                 return kernfs_leftmost_descendant(rb_to_kn(rbn));
1220
1221         /* no sibling left, visit parent */
1222         return pos->parent;
1223 }
1224
1225 /**
1226  * kernfs_activate - activate a node which started deactivated
1227  * @kn: kernfs_node whose subtree is to be activated
1228  *
1229  * If the root has KERNFS_ROOT_CREATE_DEACTIVATED set, a newly created node
1230  * needs to be explicitly activated.  A node which hasn't been activated
1231  * isn't visible to userland and deactivation is skipped during its
1232  * removal.  This is useful to construct atomic init sequences where
1233  * creation of multiple nodes should either succeed or fail atomically.
1234  *
1235  * The caller is responsible for ensuring that this function is not called
1236  * after kernfs_remove*() is invoked on @kn.
1237  */
1238 void kernfs_activate(struct kernfs_node *kn)
1239 {
1240         struct kernfs_node *pos;
1241
1242         mutex_lock(&kernfs_mutex);
1243
1244         pos = NULL;
1245         while ((pos = kernfs_next_descendant_post(pos, kn))) {
1246                 if (!pos || (pos->flags & KERNFS_ACTIVATED))
1247                         continue;
1248
1249                 WARN_ON_ONCE(pos->parent && RB_EMPTY_NODE(&pos->rb));
1250                 WARN_ON_ONCE(atomic_read(&pos->active) != KN_DEACTIVATED_BIAS);
1251
1252                 atomic_sub(KN_DEACTIVATED_BIAS, &pos->active);
1253                 pos->flags |= KERNFS_ACTIVATED;
1254         }
1255
1256         mutex_unlock(&kernfs_mutex);
1257 }
1258
1259 static void __kernfs_remove(struct kernfs_node *kn)
1260 {
1261         struct kernfs_node *pos;
1262
1263         lockdep_assert_held(&kernfs_mutex);
1264
1265         /*
1266          * Short-circuit if non-root @kn has already finished removal.
1267          * This is for kernfs_remove_self() which plays with active ref
1268          * after removal.
1269          */
1270         if (!kn || (kn->parent && RB_EMPTY_NODE(&kn->rb)))
1271                 return;
1272
1273         pr_debug("kernfs %s: removing\n", kn->name);
1274
1275         /* prevent any new usage under @kn by deactivating all nodes */
1276         pos = NULL;
1277         while ((pos = kernfs_next_descendant_post(pos, kn)))
1278                 if (kernfs_active(pos))
1279                         atomic_add(KN_DEACTIVATED_BIAS, &pos->active);
1280
1281         /* deactivate and unlink the subtree node-by-node */
1282         do {
1283                 pos = kernfs_leftmost_descendant(kn);
1284
1285                 /*
1286                  * kernfs_drain() drops kernfs_mutex temporarily and @pos's
1287                  * base ref could have been put by someone else by the time
1288                  * the function returns.  Make sure it doesn't go away
1289                  * underneath us.
1290                  */
1291                 kernfs_get(pos);
1292
1293                 /*
1294                  * Drain iff @kn was activated.  This avoids draining and
1295                  * its lockdep annotations for nodes which have never been
1296                  * activated and allows embedding kernfs_remove() in create
1297                  * error paths without worrying about draining.
1298                  */
1299                 if (kn->flags & KERNFS_ACTIVATED)
1300                         kernfs_drain(pos);
1301                 else
1302                         WARN_ON_ONCE(atomic_read(&kn->active) != KN_DEACTIVATED_BIAS);
1303
1304                 /*
1305                  * kernfs_unlink_sibling() succeeds once per node.  Use it
1306                  * to decide who's responsible for cleanups.
1307                  */
1308                 if (!pos->parent || kernfs_unlink_sibling(pos)) {
1309                         struct kernfs_iattrs *ps_iattr =
1310                                 pos->parent ? pos->parent->iattr : NULL;
1311
1312                         /* update timestamps on the parent */
1313                         if (ps_iattr) {
1314                                 ktime_get_real_ts(&ps_iattr->ia_iattr.ia_ctime);
1315                                 ps_iattr->ia_iattr.ia_mtime =
1316                                         ps_iattr->ia_iattr.ia_ctime;
1317                         }
1318
1319                         kernfs_put(pos);
1320                 }
1321
1322                 kernfs_put(pos);
1323         } while (pos != kn);
1324 }
1325
1326 /**
1327  * kernfs_remove - remove a kernfs_node recursively
1328  * @kn: the kernfs_node to remove
1329  *
1330  * Remove @kn along with all its subdirectories and files.
1331  */
1332 void kernfs_remove(struct kernfs_node *kn)
1333 {
1334         mutex_lock(&kernfs_mutex);
1335         __kernfs_remove(kn);
1336         mutex_unlock(&kernfs_mutex);
1337 }
1338
1339 /**
1340  * kernfs_break_active_protection - break out of active protection
1341  * @kn: the self kernfs_node
1342  *
1343  * The caller must be running off of a kernfs operation which is invoked
1344  * with an active reference - e.g. one of kernfs_ops.  Each invocation of
1345  * this function must also be matched with an invocation of
1346  * kernfs_unbreak_active_protection().
1347  *
1348  * This function releases the active reference of @kn the caller is
1349  * holding.  Once this function is called, @kn may be removed at any point
1350  * and the caller is solely responsible for ensuring that the objects it
1351  * dereferences are accessible.
1352  */
1353 void kernfs_break_active_protection(struct kernfs_node *kn)
1354 {
1355         /*
1356          * Take out ourself out of the active ref dependency chain.  If
1357          * we're called without an active ref, lockdep will complain.
1358          */
1359         kernfs_put_active(kn);
1360 }
1361
1362 /**
1363  * kernfs_unbreak_active_protection - undo kernfs_break_active_protection()
1364  * @kn: the self kernfs_node
1365  *
1366  * If kernfs_break_active_protection() was called, this function must be
1367  * invoked before finishing the kernfs operation.  Note that while this
1368  * function restores the active reference, it doesn't and can't actually
1369  * restore the active protection - @kn may already or be in the process of
1370  * being removed.  Once kernfs_break_active_protection() is invoked, that
1371  * protection is irreversibly gone for the kernfs operation instance.
1372  *
1373  * While this function may be called at any point after
1374  * kernfs_break_active_protection() is invoked, its most useful location
1375  * would be right before the enclosing kernfs operation returns.
1376  */
1377 void kernfs_unbreak_active_protection(struct kernfs_node *kn)
1378 {
1379         /*
1380          * @kn->active could be in any state; however, the increment we do
1381          * here will be undone as soon as the enclosing kernfs operation
1382          * finishes and this temporary bump can't break anything.  If @kn
1383          * is alive, nothing changes.  If @kn is being deactivated, the
1384          * soon-to-follow put will either finish deactivation or restore
1385          * deactivated state.  If @kn is already removed, the temporary
1386          * bump is guaranteed to be gone before @kn is released.
1387          */
1388         atomic_inc(&kn->active);
1389         if (kernfs_lockdep(kn))
1390                 rwsem_acquire(&kn->dep_map, 0, 1, _RET_IP_);
1391 }
1392
1393 /**
1394  * kernfs_remove_self - remove a kernfs_node from its own method
1395  * @kn: the self kernfs_node to remove
1396  *
1397  * The caller must be running off of a kernfs operation which is invoked
1398  * with an active reference - e.g. one of kernfs_ops.  This can be used to
1399  * implement a file operation which deletes itself.
1400  *
1401  * For example, the "delete" file for a sysfs device directory can be
1402  * implemented by invoking kernfs_remove_self() on the "delete" file
1403  * itself.  This function breaks the circular dependency of trying to
1404  * deactivate self while holding an active ref itself.  It isn't necessary
1405  * to modify the usual removal path to use kernfs_remove_self().  The
1406  * "delete" implementation can simply invoke kernfs_remove_self() on self
1407  * before proceeding with the usual removal path.  kernfs will ignore later
1408  * kernfs_remove() on self.
1409  *
1410  * kernfs_remove_self() can be called multiple times concurrently on the
1411  * same kernfs_node.  Only the first one actually performs removal and
1412  * returns %true.  All others will wait until the kernfs operation which
1413  * won self-removal finishes and return %false.  Note that the losers wait
1414  * for the completion of not only the winning kernfs_remove_self() but also
1415  * the whole kernfs_ops which won the arbitration.  This can be used to
1416  * guarantee, for example, all concurrent writes to a "delete" file to
1417  * finish only after the whole operation is complete.
1418  */
1419 bool kernfs_remove_self(struct kernfs_node *kn)
1420 {
1421         bool ret;
1422
1423         mutex_lock(&kernfs_mutex);
1424         kernfs_break_active_protection(kn);
1425
1426         /*
1427          * SUICIDAL is used to arbitrate among competing invocations.  Only
1428          * the first one will actually perform removal.  When the removal
1429          * is complete, SUICIDED is set and the active ref is restored
1430          * while holding kernfs_mutex.  The ones which lost arbitration
1431          * waits for SUICDED && drained which can happen only after the
1432          * enclosing kernfs operation which executed the winning instance
1433          * of kernfs_remove_self() finished.
1434          */
1435         if (!(kn->flags & KERNFS_SUICIDAL)) {
1436                 kn->flags |= KERNFS_SUICIDAL;
1437                 __kernfs_remove(kn);
1438                 kn->flags |= KERNFS_SUICIDED;
1439                 ret = true;
1440         } else {
1441                 wait_queue_head_t *waitq = &kernfs_root(kn)->deactivate_waitq;
1442                 DEFINE_WAIT(wait);
1443
1444                 while (true) {
1445                         prepare_to_wait(waitq, &wait, TASK_UNINTERRUPTIBLE);
1446
1447                         if ((kn->flags & KERNFS_SUICIDED) &&
1448                             atomic_read(&kn->active) == KN_DEACTIVATED_BIAS)
1449                                 break;
1450
1451                         mutex_unlock(&kernfs_mutex);
1452                         schedule();
1453                         mutex_lock(&kernfs_mutex);
1454                 }
1455                 finish_wait(waitq, &wait);
1456                 WARN_ON_ONCE(!RB_EMPTY_NODE(&kn->rb));
1457                 ret = false;
1458         }
1459
1460         /*
1461          * This must be done while holding kernfs_mutex; otherwise, waiting
1462          * for SUICIDED && deactivated could finish prematurely.
1463          */
1464         kernfs_unbreak_active_protection(kn);
1465
1466         mutex_unlock(&kernfs_mutex);
1467         return ret;
1468 }
1469
1470 /**
1471  * kernfs_remove_by_name_ns - find a kernfs_node by name and remove it
1472  * @parent: parent of the target
1473  * @name: name of the kernfs_node to remove
1474  * @ns: namespace tag of the kernfs_node to remove
1475  *
1476  * Look for the kernfs_node with @name and @ns under @parent and remove it.
1477  * Returns 0 on success, -ENOENT if such entry doesn't exist.
1478  */
1479 int kernfs_remove_by_name_ns(struct kernfs_node *parent, const char *name,
1480                              const void *ns)
1481 {
1482         struct kernfs_node *kn;
1483
1484         if (!parent) {
1485                 WARN(1, KERN_WARNING "kernfs: can not remove '%s', no directory\n",
1486                         name);
1487                 return -ENOENT;
1488         }
1489
1490         mutex_lock(&kernfs_mutex);
1491
1492         kn = kernfs_find_ns(parent, name, ns);
1493         if (kn) {
1494                 kernfs_get(kn);
1495                 __kernfs_remove(kn);
1496                 kernfs_put(kn);
1497         }
1498
1499         mutex_unlock(&kernfs_mutex);
1500
1501         if (kn)
1502                 return 0;
1503         else
1504                 return -ENOENT;
1505 }
1506
1507 /**
1508  * kernfs_rename_ns - move and rename a kernfs_node
1509  * @kn: target node
1510  * @new_parent: new parent to put @sd under
1511  * @new_name: new name
1512  * @new_ns: new namespace tag
1513  */
1514 int kernfs_rename_ns(struct kernfs_node *kn, struct kernfs_node *new_parent,
1515                      const char *new_name, const void *new_ns)
1516 {
1517         struct kernfs_node *old_parent;
1518         const char *old_name = NULL;
1519         int error;
1520
1521         /* can't move or rename root */
1522         if (!kn->parent)
1523                 return -EINVAL;
1524
1525         mutex_lock(&kernfs_mutex);
1526
1527         error = -ENOENT;
1528         if (!kernfs_active(kn) || !kernfs_active(new_parent) ||
1529             (new_parent->flags & KERNFS_EMPTY_DIR))
1530                 goto out;
1531
1532         error = 0;
1533         if ((kn->parent == new_parent) && (kn->ns == new_ns) &&
1534             (strcmp(kn->name, new_name) == 0))
1535                 goto out;       /* nothing to rename */
1536
1537         error = -EEXIST;
1538         if (kernfs_find_ns(new_parent, new_name, new_ns))
1539                 goto out;
1540
1541         /* rename kernfs_node */
1542         if (strcmp(kn->name, new_name) != 0) {
1543                 error = -ENOMEM;
1544                 new_name = kstrdup_const(new_name, GFP_KERNEL);
1545                 if (!new_name)
1546                         goto out;
1547         } else {
1548                 new_name = NULL;
1549         }
1550
1551         /*
1552          * Move to the appropriate place in the appropriate directories rbtree.
1553          */
1554         kernfs_unlink_sibling(kn);
1555         kernfs_get(new_parent);
1556
1557         /* rename_lock protects ->parent and ->name accessors */
1558         spin_lock_irq(&kernfs_rename_lock);
1559
1560         old_parent = kn->parent;
1561         kn->parent = new_parent;
1562
1563         kn->ns = new_ns;
1564         if (new_name) {
1565                 old_name = kn->name;
1566                 kn->name = new_name;
1567         }
1568
1569         spin_unlock_irq(&kernfs_rename_lock);
1570
1571         kn->hash = kernfs_name_hash(kn->name, kn->ns);
1572         kernfs_link_sibling(kn);
1573
1574         kernfs_put(old_parent);
1575         kfree_const(old_name);
1576
1577         error = 0;
1578  out:
1579         mutex_unlock(&kernfs_mutex);
1580         return error;
1581 }
1582
1583 /* Relationship between s_mode and the DT_xxx types */
1584 static inline unsigned char dt_type(struct kernfs_node *kn)
1585 {
1586         return (kn->mode >> 12) & 15;
1587 }
1588
1589 static int kernfs_dir_fop_release(struct inode *inode, struct file *filp)
1590 {
1591         kernfs_put(filp->private_data);
1592         return 0;
1593 }
1594
1595 static struct kernfs_node *kernfs_dir_pos(const void *ns,
1596         struct kernfs_node *parent, loff_t hash, struct kernfs_node *pos)
1597 {
1598         if (pos) {
1599                 int valid = kernfs_active(pos) &&
1600                         pos->parent == parent && hash == pos->hash;
1601                 kernfs_put(pos);
1602                 if (!valid)
1603                         pos = NULL;
1604         }
1605         if (!pos && (hash > 1) && (hash < INT_MAX)) {
1606                 struct rb_node *node = parent->dir.children.rb_node;
1607                 while (node) {
1608                         pos = rb_to_kn(node);
1609
1610                         if (hash < pos->hash)
1611                                 node = node->rb_left;
1612                         else if (hash > pos->hash)
1613                                 node = node->rb_right;
1614                         else
1615                                 break;
1616                 }
1617         }
1618         /* Skip over entries which are dying/dead or in the wrong namespace */
1619         while (pos && (!kernfs_active(pos) || pos->ns != ns)) {
1620                 struct rb_node *node = rb_next(&pos->rb);
1621                 if (!node)
1622                         pos = NULL;
1623                 else
1624                         pos = rb_to_kn(node);
1625         }
1626         return pos;
1627 }
1628
1629 static struct kernfs_node *kernfs_dir_next_pos(const void *ns,
1630         struct kernfs_node *parent, ino_t ino, struct kernfs_node *pos)
1631 {
1632         pos = kernfs_dir_pos(ns, parent, ino, pos);
1633         if (pos) {
1634                 do {
1635                         struct rb_node *node = rb_next(&pos->rb);
1636                         if (!node)
1637                                 pos = NULL;
1638                         else
1639                                 pos = rb_to_kn(node);
1640                 } while (pos && (!kernfs_active(pos) || pos->ns != ns));
1641         }
1642         return pos;
1643 }
1644
1645 static int kernfs_fop_readdir(struct file *file, struct dir_context *ctx)
1646 {
1647         struct dentry *dentry = file->f_path.dentry;
1648         struct kernfs_node *parent = kernfs_dentry_node(dentry);
1649         struct kernfs_node *pos = file->private_data;
1650         const void *ns = NULL;
1651
1652         if (!dir_emit_dots(file, ctx))
1653                 return 0;
1654         mutex_lock(&kernfs_mutex);
1655
1656         if (kernfs_ns_enabled(parent))
1657                 ns = kernfs_info(dentry->d_sb)->ns;
1658
1659         for (pos = kernfs_dir_pos(ns, parent, ctx->pos, pos);
1660              pos;
1661              pos = kernfs_dir_next_pos(ns, parent, ctx->pos, pos)) {
1662                 const char *name = pos->name;
1663                 unsigned int type = dt_type(pos);
1664                 int len = strlen(name);
1665                 ino_t ino = pos->id.ino;
1666
1667                 ctx->pos = pos->hash;
1668                 file->private_data = pos;
1669                 kernfs_get(pos);
1670
1671                 mutex_unlock(&kernfs_mutex);
1672                 if (!dir_emit(ctx, name, len, ino, type))
1673                         return 0;
1674                 mutex_lock(&kernfs_mutex);
1675         }
1676         mutex_unlock(&kernfs_mutex);
1677         file->private_data = NULL;
1678         ctx->pos = INT_MAX;
1679         return 0;
1680 }
1681
1682 const struct file_operations kernfs_dir_fops = {
1683         .read           = generic_read_dir,
1684         .iterate_shared = kernfs_fop_readdir,
1685         .release        = kernfs_dir_fop_release,
1686         .llseek         = generic_file_llseek,
1687 };