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