7bf1d5fc2e9c591c3daeaf4e7a70b35e493a6fb8
[platform/kernel/linux-rpi.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         idr_remove(&root->ino_idr, (u32)kernfs_ino(kn));
641  err_out2:
642         kmem_cache_free(kernfs_node_cache, kn);
643  err_out1:
644         kfree_const(name);
645         return NULL;
646 }
647
648 struct kernfs_node *kernfs_new_node(struct kernfs_node *parent,
649                                     const char *name, umode_t mode,
650                                     kuid_t uid, kgid_t gid,
651                                     unsigned flags)
652 {
653         struct kernfs_node *kn;
654
655         kn = __kernfs_new_node(kernfs_root(parent), parent,
656                                name, mode, uid, gid, flags);
657         if (kn) {
658                 kernfs_get(parent);
659                 kn->parent = parent;
660         }
661         return kn;
662 }
663
664 /*
665  * kernfs_find_and_get_node_by_id - get kernfs_node from node id
666  * @root: the kernfs root
667  * @id: the target node id
668  *
669  * @id's lower 32bits encode ino and upper gen.  If the gen portion is
670  * zero, all generations are matched.
671  *
672  * RETURNS:
673  * NULL on failure. Return a kernfs node with reference counter incremented
674  */
675 struct kernfs_node *kernfs_find_and_get_node_by_id(struct kernfs_root *root,
676                                                    u64 id)
677 {
678         struct kernfs_node *kn;
679         ino_t ino = kernfs_id_ino(id);
680         u32 gen = kernfs_id_gen(id);
681
682         spin_lock(&kernfs_idr_lock);
683
684         kn = idr_find(&root->ino_idr, (u32)ino);
685         if (!kn)
686                 goto err_unlock;
687
688         if (sizeof(ino_t) >= sizeof(u64)) {
689                 /* we looked up with the low 32bits, compare the whole */
690                 if (kernfs_ino(kn) != ino)
691                         goto err_unlock;
692         } else {
693                 /* 0 matches all generations */
694                 if (unlikely(gen && kernfs_gen(kn) != gen))
695                         goto err_unlock;
696         }
697
698         /*
699          * ACTIVATED is protected with kernfs_mutex but it was clear when
700          * @kn was added to idr and we just wanna see it set.  No need to
701          * grab kernfs_mutex.
702          */
703         if (unlikely(!(kn->flags & KERNFS_ACTIVATED) ||
704                      !atomic_inc_not_zero(&kn->count)))
705                 goto err_unlock;
706
707         spin_unlock(&kernfs_idr_lock);
708         return kn;
709 err_unlock:
710         spin_unlock(&kernfs_idr_lock);
711         return NULL;
712 }
713
714 /**
715  *      kernfs_add_one - add kernfs_node to parent without warning
716  *      @kn: kernfs_node to be added
717  *
718  *      The caller must already have initialized @kn->parent.  This
719  *      function increments nlink of the parent's inode if @kn is a
720  *      directory and link into the children list of the parent.
721  *
722  *      RETURNS:
723  *      0 on success, -EEXIST if entry with the given name already
724  *      exists.
725  */
726 int kernfs_add_one(struct kernfs_node *kn)
727 {
728         struct kernfs_node *parent = kn->parent;
729         struct kernfs_iattrs *ps_iattr;
730         bool has_ns;
731         int ret;
732
733         down_write(&kernfs_rwsem);
734
735         ret = -EINVAL;
736         has_ns = kernfs_ns_enabled(parent);
737         if (WARN(has_ns != (bool)kn->ns, KERN_WARNING "kernfs: ns %s in '%s' for '%s'\n",
738                  has_ns ? "required" : "invalid", parent->name, kn->name))
739                 goto out_unlock;
740
741         if (kernfs_type(parent) != KERNFS_DIR)
742                 goto out_unlock;
743
744         ret = -ENOENT;
745         if (parent->flags & KERNFS_EMPTY_DIR)
746                 goto out_unlock;
747
748         if ((parent->flags & KERNFS_ACTIVATED) && !kernfs_active(parent))
749                 goto out_unlock;
750
751         kn->hash = kernfs_name_hash(kn->name, kn->ns);
752
753         ret = kernfs_link_sibling(kn);
754         if (ret)
755                 goto out_unlock;
756
757         /* Update timestamps on the parent */
758         ps_iattr = parent->iattr;
759         if (ps_iattr) {
760                 ktime_get_real_ts64(&ps_iattr->ia_ctime);
761                 ps_iattr->ia_mtime = ps_iattr->ia_ctime;
762         }
763
764         up_write(&kernfs_rwsem);
765
766         /*
767          * Activate the new node unless CREATE_DEACTIVATED is requested.
768          * If not activated here, the kernfs user is responsible for
769          * activating the node with kernfs_activate().  A node which hasn't
770          * been activated is not visible to userland and its removal won't
771          * trigger deactivation.
772          */
773         if (!(kernfs_root(kn)->flags & KERNFS_ROOT_CREATE_DEACTIVATED))
774                 kernfs_activate(kn);
775         return 0;
776
777 out_unlock:
778         up_write(&kernfs_rwsem);
779         return ret;
780 }
781
782 /**
783  * kernfs_find_ns - find kernfs_node with the given name
784  * @parent: kernfs_node to search under
785  * @name: name to look for
786  * @ns: the namespace tag to use
787  *
788  * Look for kernfs_node with name @name under @parent.  Returns pointer to
789  * the found kernfs_node on success, %NULL on failure.
790  */
791 static struct kernfs_node *kernfs_find_ns(struct kernfs_node *parent,
792                                           const unsigned char *name,
793                                           const void *ns)
794 {
795         struct rb_node *node = parent->dir.children.rb_node;
796         bool has_ns = kernfs_ns_enabled(parent);
797         unsigned int hash;
798
799         lockdep_assert_held(&kernfs_rwsem);
800
801         if (has_ns != (bool)ns) {
802                 WARN(1, KERN_WARNING "kernfs: ns %s in '%s' for '%s'\n",
803                      has_ns ? "required" : "invalid", parent->name, name);
804                 return NULL;
805         }
806
807         hash = kernfs_name_hash(name, ns);
808         while (node) {
809                 struct kernfs_node *kn;
810                 int result;
811
812                 kn = rb_to_kn(node);
813                 result = kernfs_name_compare(hash, name, ns, kn);
814                 if (result < 0)
815                         node = node->rb_left;
816                 else if (result > 0)
817                         node = node->rb_right;
818                 else
819                         return kn;
820         }
821         return NULL;
822 }
823
824 static struct kernfs_node *kernfs_walk_ns(struct kernfs_node *parent,
825                                           const unsigned char *path,
826                                           const void *ns)
827 {
828         size_t len;
829         char *p, *name;
830
831         lockdep_assert_held_read(&kernfs_rwsem);
832
833         spin_lock_irq(&kernfs_pr_cont_lock);
834
835         len = strlcpy(kernfs_pr_cont_buf, path, sizeof(kernfs_pr_cont_buf));
836
837         if (len >= sizeof(kernfs_pr_cont_buf)) {
838                 spin_unlock_irq(&kernfs_pr_cont_lock);
839                 return NULL;
840         }
841
842         p = kernfs_pr_cont_buf;
843
844         while ((name = strsep(&p, "/")) && parent) {
845                 if (*name == '\0')
846                         continue;
847                 parent = kernfs_find_ns(parent, name, ns);
848         }
849
850         spin_unlock_irq(&kernfs_pr_cont_lock);
851
852         return parent;
853 }
854
855 /**
856  * kernfs_find_and_get_ns - find and get kernfs_node with the given name
857  * @parent: kernfs_node to search under
858  * @name: name to look for
859  * @ns: the namespace tag to use
860  *
861  * Look for kernfs_node with name @name under @parent and get a reference
862  * if found.  This function may sleep and returns pointer to the found
863  * kernfs_node on success, %NULL on failure.
864  */
865 struct kernfs_node *kernfs_find_and_get_ns(struct kernfs_node *parent,
866                                            const char *name, const void *ns)
867 {
868         struct kernfs_node *kn;
869
870         down_read(&kernfs_rwsem);
871         kn = kernfs_find_ns(parent, name, ns);
872         kernfs_get(kn);
873         up_read(&kernfs_rwsem);
874
875         return kn;
876 }
877 EXPORT_SYMBOL_GPL(kernfs_find_and_get_ns);
878
879 /**
880  * kernfs_walk_and_get_ns - find and get kernfs_node with the given path
881  * @parent: kernfs_node to search under
882  * @path: path to look for
883  * @ns: the namespace tag to use
884  *
885  * Look for kernfs_node with path @path under @parent and get a reference
886  * if found.  This function may sleep and returns pointer to the found
887  * kernfs_node on success, %NULL on failure.
888  */
889 struct kernfs_node *kernfs_walk_and_get_ns(struct kernfs_node *parent,
890                                            const char *path, const void *ns)
891 {
892         struct kernfs_node *kn;
893
894         down_read(&kernfs_rwsem);
895         kn = kernfs_walk_ns(parent, path, ns);
896         kernfs_get(kn);
897         up_read(&kernfs_rwsem);
898
899         return kn;
900 }
901
902 /**
903  * kernfs_create_root - create a new kernfs hierarchy
904  * @scops: optional syscall operations for the hierarchy
905  * @flags: KERNFS_ROOT_* flags
906  * @priv: opaque data associated with the new directory
907  *
908  * Returns the root of the new hierarchy on success, ERR_PTR() value on
909  * failure.
910  */
911 struct kernfs_root *kernfs_create_root(struct kernfs_syscall_ops *scops,
912                                        unsigned int flags, void *priv)
913 {
914         struct kernfs_root *root;
915         struct kernfs_node *kn;
916
917         root = kzalloc(sizeof(*root), GFP_KERNEL);
918         if (!root)
919                 return ERR_PTR(-ENOMEM);
920
921         idr_init(&root->ino_idr);
922         INIT_LIST_HEAD(&root->supers);
923
924         /*
925          * On 64bit ino setups, id is ino.  On 32bit, low 32bits are ino.
926          * High bits generation.  The starting value for both ino and
927          * genenration is 1.  Initialize upper 32bit allocation
928          * accordingly.
929          */
930         if (sizeof(ino_t) >= sizeof(u64))
931                 root->id_highbits = 0;
932         else
933                 root->id_highbits = 1;
934
935         kn = __kernfs_new_node(root, NULL, "", S_IFDIR | S_IRUGO | S_IXUGO,
936                                GLOBAL_ROOT_UID, GLOBAL_ROOT_GID,
937                                KERNFS_DIR);
938         if (!kn) {
939                 idr_destroy(&root->ino_idr);
940                 kfree(root);
941                 return ERR_PTR(-ENOMEM);
942         }
943
944         kn->priv = priv;
945         kn->dir.root = root;
946
947         root->syscall_ops = scops;
948         root->flags = flags;
949         root->kn = kn;
950         init_waitqueue_head(&root->deactivate_waitq);
951
952         if (!(root->flags & KERNFS_ROOT_CREATE_DEACTIVATED))
953                 kernfs_activate(kn);
954
955         return root;
956 }
957
958 /**
959  * kernfs_destroy_root - destroy a kernfs hierarchy
960  * @root: root of the hierarchy to destroy
961  *
962  * Destroy the hierarchy anchored at @root by removing all existing
963  * directories and destroying @root.
964  */
965 void kernfs_destroy_root(struct kernfs_root *root)
966 {
967         kernfs_remove(root->kn);        /* will also free @root */
968 }
969
970 /**
971  * kernfs_create_dir_ns - create a directory
972  * @parent: parent in which to create a new directory
973  * @name: name of the new directory
974  * @mode: mode of the new directory
975  * @uid: uid of the new directory
976  * @gid: gid of the new directory
977  * @priv: opaque data associated with the new directory
978  * @ns: optional namespace tag of the directory
979  *
980  * Returns the created node on success, ERR_PTR() value on failure.
981  */
982 struct kernfs_node *kernfs_create_dir_ns(struct kernfs_node *parent,
983                                          const char *name, umode_t mode,
984                                          kuid_t uid, kgid_t gid,
985                                          void *priv, const void *ns)
986 {
987         struct kernfs_node *kn;
988         int rc;
989
990         /* allocate */
991         kn = kernfs_new_node(parent, name, mode | S_IFDIR,
992                              uid, gid, KERNFS_DIR);
993         if (!kn)
994                 return ERR_PTR(-ENOMEM);
995
996         kn->dir.root = parent->dir.root;
997         kn->ns = ns;
998         kn->priv = priv;
999
1000         /* link in */
1001         rc = kernfs_add_one(kn);
1002         if (!rc)
1003                 return kn;
1004
1005         kernfs_put(kn);
1006         return ERR_PTR(rc);
1007 }
1008
1009 /**
1010  * kernfs_create_empty_dir - create an always empty directory
1011  * @parent: parent in which to create a new directory
1012  * @name: name of the new directory
1013  *
1014  * Returns the created node on success, ERR_PTR() value on failure.
1015  */
1016 struct kernfs_node *kernfs_create_empty_dir(struct kernfs_node *parent,
1017                                             const char *name)
1018 {
1019         struct kernfs_node *kn;
1020         int rc;
1021
1022         /* allocate */
1023         kn = kernfs_new_node(parent, name, S_IRUGO|S_IXUGO|S_IFDIR,
1024                              GLOBAL_ROOT_UID, GLOBAL_ROOT_GID, KERNFS_DIR);
1025         if (!kn)
1026                 return ERR_PTR(-ENOMEM);
1027
1028         kn->flags |= KERNFS_EMPTY_DIR;
1029         kn->dir.root = parent->dir.root;
1030         kn->ns = NULL;
1031         kn->priv = NULL;
1032
1033         /* link in */
1034         rc = kernfs_add_one(kn);
1035         if (!rc)
1036                 return kn;
1037
1038         kernfs_put(kn);
1039         return ERR_PTR(rc);
1040 }
1041
1042 static int kernfs_dop_revalidate(struct dentry *dentry, unsigned int flags)
1043 {
1044         struct kernfs_node *kn;
1045
1046         if (flags & LOOKUP_RCU)
1047                 return -ECHILD;
1048
1049         /* Negative hashed dentry? */
1050         if (d_really_is_negative(dentry)) {
1051                 struct kernfs_node *parent;
1052
1053                 /* If the kernfs parent node has changed discard and
1054                  * proceed to ->lookup.
1055                  */
1056                 down_read(&kernfs_rwsem);
1057                 spin_lock(&dentry->d_lock);
1058                 parent = kernfs_dentry_node(dentry->d_parent);
1059                 if (parent) {
1060                         if (kernfs_dir_changed(parent, dentry)) {
1061                                 spin_unlock(&dentry->d_lock);
1062                                 up_read(&kernfs_rwsem);
1063                                 return 0;
1064                         }
1065                 }
1066                 spin_unlock(&dentry->d_lock);
1067                 up_read(&kernfs_rwsem);
1068
1069                 /* The kernfs parent node hasn't changed, leave the
1070                  * dentry negative and return success.
1071                  */
1072                 return 1;
1073         }
1074
1075         kn = kernfs_dentry_node(dentry);
1076         down_read(&kernfs_rwsem);
1077
1078         /* The kernfs node has been deactivated */
1079         if (!kernfs_active(kn))
1080                 goto out_bad;
1081
1082         /* The kernfs node has been moved? */
1083         if (kernfs_dentry_node(dentry->d_parent) != kn->parent)
1084                 goto out_bad;
1085
1086         /* The kernfs node has been renamed */
1087         if (strcmp(dentry->d_name.name, kn->name) != 0)
1088                 goto out_bad;
1089
1090         /* The kernfs node has been moved to a different namespace */
1091         if (kn->parent && kernfs_ns_enabled(kn->parent) &&
1092             kernfs_info(dentry->d_sb)->ns != kn->ns)
1093                 goto out_bad;
1094
1095         up_read(&kernfs_rwsem);
1096         return 1;
1097 out_bad:
1098         up_read(&kernfs_rwsem);
1099         return 0;
1100 }
1101
1102 const struct dentry_operations kernfs_dops = {
1103         .d_revalidate   = kernfs_dop_revalidate,
1104 };
1105
1106 static struct dentry *kernfs_iop_lookup(struct inode *dir,
1107                                         struct dentry *dentry,
1108                                         unsigned int flags)
1109 {
1110         struct kernfs_node *parent = dir->i_private;
1111         struct kernfs_node *kn;
1112         struct inode *inode = NULL;
1113         const void *ns = NULL;
1114
1115         down_read(&kernfs_rwsem);
1116         if (kernfs_ns_enabled(parent))
1117                 ns = kernfs_info(dir->i_sb)->ns;
1118
1119         kn = kernfs_find_ns(parent, dentry->d_name.name, ns);
1120         /* attach dentry and inode */
1121         if (kn) {
1122                 /* Inactive nodes are invisible to the VFS so don't
1123                  * create a negative.
1124                  */
1125                 if (!kernfs_active(kn)) {
1126                         up_read(&kernfs_rwsem);
1127                         return NULL;
1128                 }
1129                 inode = kernfs_get_inode(dir->i_sb, kn);
1130                 if (!inode)
1131                         inode = ERR_PTR(-ENOMEM);
1132         }
1133         /*
1134          * Needed for negative dentry validation.
1135          * The negative dentry can be created in kernfs_iop_lookup()
1136          * or transforms from positive dentry in dentry_unlink_inode()
1137          * called from vfs_rmdir().
1138          */
1139         if (!IS_ERR(inode))
1140                 kernfs_set_rev(parent, dentry);
1141         up_read(&kernfs_rwsem);
1142
1143         /* instantiate and hash (possibly negative) dentry */
1144         return d_splice_alias(inode, dentry);
1145 }
1146
1147 static int kernfs_iop_mkdir(struct user_namespace *mnt_userns,
1148                             struct inode *dir, struct dentry *dentry,
1149                             umode_t mode)
1150 {
1151         struct kernfs_node *parent = dir->i_private;
1152         struct kernfs_syscall_ops *scops = kernfs_root(parent)->syscall_ops;
1153         int ret;
1154
1155         if (!scops || !scops->mkdir)
1156                 return -EPERM;
1157
1158         if (!kernfs_get_active(parent))
1159                 return -ENODEV;
1160
1161         ret = scops->mkdir(parent, dentry->d_name.name, mode);
1162
1163         kernfs_put_active(parent);
1164         return ret;
1165 }
1166
1167 static int kernfs_iop_rmdir(struct inode *dir, struct dentry *dentry)
1168 {
1169         struct kernfs_node *kn  = kernfs_dentry_node(dentry);
1170         struct kernfs_syscall_ops *scops = kernfs_root(kn)->syscall_ops;
1171         int ret;
1172
1173         if (!scops || !scops->rmdir)
1174                 return -EPERM;
1175
1176         if (!kernfs_get_active(kn))
1177                 return -ENODEV;
1178
1179         ret = scops->rmdir(kn);
1180
1181         kernfs_put_active(kn);
1182         return ret;
1183 }
1184
1185 static int kernfs_iop_rename(struct user_namespace *mnt_userns,
1186                              struct inode *old_dir, struct dentry *old_dentry,
1187                              struct inode *new_dir, struct dentry *new_dentry,
1188                              unsigned int flags)
1189 {
1190         struct kernfs_node *kn = kernfs_dentry_node(old_dentry);
1191         struct kernfs_node *new_parent = new_dir->i_private;
1192         struct kernfs_syscall_ops *scops = kernfs_root(kn)->syscall_ops;
1193         int ret;
1194
1195         if (flags)
1196                 return -EINVAL;
1197
1198         if (!scops || !scops->rename)
1199                 return -EPERM;
1200
1201         if (!kernfs_get_active(kn))
1202                 return -ENODEV;
1203
1204         if (!kernfs_get_active(new_parent)) {
1205                 kernfs_put_active(kn);
1206                 return -ENODEV;
1207         }
1208
1209         ret = scops->rename(kn, new_parent, new_dentry->d_name.name);
1210
1211         kernfs_put_active(new_parent);
1212         kernfs_put_active(kn);
1213         return ret;
1214 }
1215
1216 const struct inode_operations kernfs_dir_iops = {
1217         .lookup         = kernfs_iop_lookup,
1218         .permission     = kernfs_iop_permission,
1219         .setattr        = kernfs_iop_setattr,
1220         .getattr        = kernfs_iop_getattr,
1221         .listxattr      = kernfs_iop_listxattr,
1222
1223         .mkdir          = kernfs_iop_mkdir,
1224         .rmdir          = kernfs_iop_rmdir,
1225         .rename         = kernfs_iop_rename,
1226 };
1227
1228 static struct kernfs_node *kernfs_leftmost_descendant(struct kernfs_node *pos)
1229 {
1230         struct kernfs_node *last;
1231
1232         while (true) {
1233                 struct rb_node *rbn;
1234
1235                 last = pos;
1236
1237                 if (kernfs_type(pos) != KERNFS_DIR)
1238                         break;
1239
1240                 rbn = rb_first(&pos->dir.children);
1241                 if (!rbn)
1242                         break;
1243
1244                 pos = rb_to_kn(rbn);
1245         }
1246
1247         return last;
1248 }
1249
1250 /**
1251  * kernfs_next_descendant_post - find the next descendant for post-order walk
1252  * @pos: the current position (%NULL to initiate traversal)
1253  * @root: kernfs_node whose descendants to walk
1254  *
1255  * Find the next descendant to visit for post-order traversal of @root's
1256  * descendants.  @root is included in the iteration and the last node to be
1257  * visited.
1258  */
1259 static struct kernfs_node *kernfs_next_descendant_post(struct kernfs_node *pos,
1260                                                        struct kernfs_node *root)
1261 {
1262         struct rb_node *rbn;
1263
1264         lockdep_assert_held_write(&kernfs_rwsem);
1265
1266         /* if first iteration, visit leftmost descendant which may be root */
1267         if (!pos)
1268                 return kernfs_leftmost_descendant(root);
1269
1270         /* if we visited @root, we're done */
1271         if (pos == root)
1272                 return NULL;
1273
1274         /* if there's an unvisited sibling, visit its leftmost descendant */
1275         rbn = rb_next(&pos->rb);
1276         if (rbn)
1277                 return kernfs_leftmost_descendant(rb_to_kn(rbn));
1278
1279         /* no sibling left, visit parent */
1280         return pos->parent;
1281 }
1282
1283 /**
1284  * kernfs_activate - activate a node which started deactivated
1285  * @kn: kernfs_node whose subtree is to be activated
1286  *
1287  * If the root has KERNFS_ROOT_CREATE_DEACTIVATED set, a newly created node
1288  * needs to be explicitly activated.  A node which hasn't been activated
1289  * isn't visible to userland and deactivation is skipped during its
1290  * removal.  This is useful to construct atomic init sequences where
1291  * creation of multiple nodes should either succeed or fail atomically.
1292  *
1293  * The caller is responsible for ensuring that this function is not called
1294  * after kernfs_remove*() is invoked on @kn.
1295  */
1296 void kernfs_activate(struct kernfs_node *kn)
1297 {
1298         struct kernfs_node *pos;
1299
1300         down_write(&kernfs_rwsem);
1301
1302         pos = NULL;
1303         while ((pos = kernfs_next_descendant_post(pos, kn))) {
1304                 if (pos->flags & KERNFS_ACTIVATED)
1305                         continue;
1306
1307                 WARN_ON_ONCE(pos->parent && RB_EMPTY_NODE(&pos->rb));
1308                 WARN_ON_ONCE(atomic_read(&pos->active) != KN_DEACTIVATED_BIAS);
1309
1310                 atomic_sub(KN_DEACTIVATED_BIAS, &pos->active);
1311                 pos->flags |= KERNFS_ACTIVATED;
1312         }
1313
1314         up_write(&kernfs_rwsem);
1315 }
1316
1317 static void __kernfs_remove(struct kernfs_node *kn)
1318 {
1319         struct kernfs_node *pos;
1320
1321         lockdep_assert_held_write(&kernfs_rwsem);
1322
1323         /*
1324          * Short-circuit if non-root @kn has already finished removal.
1325          * This is for kernfs_remove_self() which plays with active ref
1326          * after removal.
1327          */
1328         if (!kn || (kn->parent && RB_EMPTY_NODE(&kn->rb)))
1329                 return;
1330
1331         pr_debug("kernfs %s: removing\n", kn->name);
1332
1333         /* prevent any new usage under @kn by deactivating all nodes */
1334         pos = NULL;
1335         while ((pos = kernfs_next_descendant_post(pos, kn)))
1336                 if (kernfs_active(pos))
1337                         atomic_add(KN_DEACTIVATED_BIAS, &pos->active);
1338
1339         /* deactivate and unlink the subtree node-by-node */
1340         do {
1341                 pos = kernfs_leftmost_descendant(kn);
1342
1343                 /*
1344                  * kernfs_drain() drops kernfs_rwsem temporarily and @pos's
1345                  * base ref could have been put by someone else by the time
1346                  * the function returns.  Make sure it doesn't go away
1347                  * underneath us.
1348                  */
1349                 kernfs_get(pos);
1350
1351                 /*
1352                  * Drain iff @kn was activated.  This avoids draining and
1353                  * its lockdep annotations for nodes which have never been
1354                  * activated and allows embedding kernfs_remove() in create
1355                  * error paths without worrying about draining.
1356                  */
1357                 if (kn->flags & KERNFS_ACTIVATED)
1358                         kernfs_drain(pos);
1359                 else
1360                         WARN_ON_ONCE(atomic_read(&kn->active) != KN_DEACTIVATED_BIAS);
1361
1362                 /*
1363                  * kernfs_unlink_sibling() succeeds once per node.  Use it
1364                  * to decide who's responsible for cleanups.
1365                  */
1366                 if (!pos->parent || kernfs_unlink_sibling(pos)) {
1367                         struct kernfs_iattrs *ps_iattr =
1368                                 pos->parent ? pos->parent->iattr : NULL;
1369
1370                         /* update timestamps on the parent */
1371                         if (ps_iattr) {
1372                                 ktime_get_real_ts64(&ps_iattr->ia_ctime);
1373                                 ps_iattr->ia_mtime = ps_iattr->ia_ctime;
1374                         }
1375
1376                         kernfs_put(pos);
1377                 }
1378
1379                 kernfs_put(pos);
1380         } while (pos != kn);
1381 }
1382
1383 /**
1384  * kernfs_remove - remove a kernfs_node recursively
1385  * @kn: the kernfs_node to remove
1386  *
1387  * Remove @kn along with all its subdirectories and files.
1388  */
1389 void kernfs_remove(struct kernfs_node *kn)
1390 {
1391         down_write(&kernfs_rwsem);
1392         __kernfs_remove(kn);
1393         up_write(&kernfs_rwsem);
1394 }
1395
1396 /**
1397  * kernfs_break_active_protection - break out of active protection
1398  * @kn: the self kernfs_node
1399  *
1400  * The caller must be running off of a kernfs operation which is invoked
1401  * with an active reference - e.g. one of kernfs_ops.  Each invocation of
1402  * this function must also be matched with an invocation of
1403  * kernfs_unbreak_active_protection().
1404  *
1405  * This function releases the active reference of @kn the caller is
1406  * holding.  Once this function is called, @kn may be removed at any point
1407  * and the caller is solely responsible for ensuring that the objects it
1408  * dereferences are accessible.
1409  */
1410 void kernfs_break_active_protection(struct kernfs_node *kn)
1411 {
1412         /*
1413          * Take out ourself out of the active ref dependency chain.  If
1414          * we're called without an active ref, lockdep will complain.
1415          */
1416         kernfs_put_active(kn);
1417 }
1418
1419 /**
1420  * kernfs_unbreak_active_protection - undo kernfs_break_active_protection()
1421  * @kn: the self kernfs_node
1422  *
1423  * If kernfs_break_active_protection() was called, this function must be
1424  * invoked before finishing the kernfs operation.  Note that while this
1425  * function restores the active reference, it doesn't and can't actually
1426  * restore the active protection - @kn may already or be in the process of
1427  * being removed.  Once kernfs_break_active_protection() is invoked, that
1428  * protection is irreversibly gone for the kernfs operation instance.
1429  *
1430  * While this function may be called at any point after
1431  * kernfs_break_active_protection() is invoked, its most useful location
1432  * would be right before the enclosing kernfs operation returns.
1433  */
1434 void kernfs_unbreak_active_protection(struct kernfs_node *kn)
1435 {
1436         /*
1437          * @kn->active could be in any state; however, the increment we do
1438          * here will be undone as soon as the enclosing kernfs operation
1439          * finishes and this temporary bump can't break anything.  If @kn
1440          * is alive, nothing changes.  If @kn is being deactivated, the
1441          * soon-to-follow put will either finish deactivation or restore
1442          * deactivated state.  If @kn is already removed, the temporary
1443          * bump is guaranteed to be gone before @kn is released.
1444          */
1445         atomic_inc(&kn->active);
1446         if (kernfs_lockdep(kn))
1447                 rwsem_acquire(&kn->dep_map, 0, 1, _RET_IP_);
1448 }
1449
1450 /**
1451  * kernfs_remove_self - remove a kernfs_node from its own method
1452  * @kn: the self kernfs_node to remove
1453  *
1454  * The caller must be running off of a kernfs operation which is invoked
1455  * with an active reference - e.g. one of kernfs_ops.  This can be used to
1456  * implement a file operation which deletes itself.
1457  *
1458  * For example, the "delete" file for a sysfs device directory can be
1459  * implemented by invoking kernfs_remove_self() on the "delete" file
1460  * itself.  This function breaks the circular dependency of trying to
1461  * deactivate self while holding an active ref itself.  It isn't necessary
1462  * to modify the usual removal path to use kernfs_remove_self().  The
1463  * "delete" implementation can simply invoke kernfs_remove_self() on self
1464  * before proceeding with the usual removal path.  kernfs will ignore later
1465  * kernfs_remove() on self.
1466  *
1467  * kernfs_remove_self() can be called multiple times concurrently on the
1468  * same kernfs_node.  Only the first one actually performs removal and
1469  * returns %true.  All others will wait until the kernfs operation which
1470  * won self-removal finishes and return %false.  Note that the losers wait
1471  * for the completion of not only the winning kernfs_remove_self() but also
1472  * the whole kernfs_ops which won the arbitration.  This can be used to
1473  * guarantee, for example, all concurrent writes to a "delete" file to
1474  * finish only after the whole operation is complete.
1475  */
1476 bool kernfs_remove_self(struct kernfs_node *kn)
1477 {
1478         bool ret;
1479
1480         down_write(&kernfs_rwsem);
1481         kernfs_break_active_protection(kn);
1482
1483         /*
1484          * SUICIDAL is used to arbitrate among competing invocations.  Only
1485          * the first one will actually perform removal.  When the removal
1486          * is complete, SUICIDED is set and the active ref is restored
1487          * while kernfs_rwsem for held exclusive.  The ones which lost
1488          * arbitration waits for SUICIDED && drained which can happen only
1489          * after the enclosing kernfs operation which executed the winning
1490          * instance of kernfs_remove_self() finished.
1491          */
1492         if (!(kn->flags & KERNFS_SUICIDAL)) {
1493                 kn->flags |= KERNFS_SUICIDAL;
1494                 __kernfs_remove(kn);
1495                 kn->flags |= KERNFS_SUICIDED;
1496                 ret = true;
1497         } else {
1498                 wait_queue_head_t *waitq = &kernfs_root(kn)->deactivate_waitq;
1499                 DEFINE_WAIT(wait);
1500
1501                 while (true) {
1502                         prepare_to_wait(waitq, &wait, TASK_UNINTERRUPTIBLE);
1503
1504                         if ((kn->flags & KERNFS_SUICIDED) &&
1505                             atomic_read(&kn->active) == KN_DEACTIVATED_BIAS)
1506                                 break;
1507
1508                         up_write(&kernfs_rwsem);
1509                         schedule();
1510                         down_write(&kernfs_rwsem);
1511                 }
1512                 finish_wait(waitq, &wait);
1513                 WARN_ON_ONCE(!RB_EMPTY_NODE(&kn->rb));
1514                 ret = false;
1515         }
1516
1517         /*
1518          * This must be done while kernfs_rwsem held exclusive; otherwise,
1519          * waiting for SUICIDED && deactivated could finish prematurely.
1520          */
1521         kernfs_unbreak_active_protection(kn);
1522
1523         up_write(&kernfs_rwsem);
1524         return ret;
1525 }
1526
1527 /**
1528  * kernfs_remove_by_name_ns - find a kernfs_node by name and remove it
1529  * @parent: parent of the target
1530  * @name: name of the kernfs_node to remove
1531  * @ns: namespace tag of the kernfs_node to remove
1532  *
1533  * Look for the kernfs_node with @name and @ns under @parent and remove it.
1534  * Returns 0 on success, -ENOENT if such entry doesn't exist.
1535  */
1536 int kernfs_remove_by_name_ns(struct kernfs_node *parent, const char *name,
1537                              const void *ns)
1538 {
1539         struct kernfs_node *kn;
1540
1541         if (!parent) {
1542                 WARN(1, KERN_WARNING "kernfs: can not remove '%s', no directory\n",
1543                         name);
1544                 return -ENOENT;
1545         }
1546
1547         down_write(&kernfs_rwsem);
1548
1549         kn = kernfs_find_ns(parent, name, ns);
1550         if (kn)
1551                 __kernfs_remove(kn);
1552
1553         up_write(&kernfs_rwsem);
1554
1555         if (kn)
1556                 return 0;
1557         else
1558                 return -ENOENT;
1559 }
1560
1561 /**
1562  * kernfs_rename_ns - move and rename a kernfs_node
1563  * @kn: target node
1564  * @new_parent: new parent to put @sd under
1565  * @new_name: new name
1566  * @new_ns: new namespace tag
1567  */
1568 int kernfs_rename_ns(struct kernfs_node *kn, struct kernfs_node *new_parent,
1569                      const char *new_name, const void *new_ns)
1570 {
1571         struct kernfs_node *old_parent;
1572         const char *old_name = NULL;
1573         int error;
1574
1575         /* can't move or rename root */
1576         if (!kn->parent)
1577                 return -EINVAL;
1578
1579         down_write(&kernfs_rwsem);
1580
1581         error = -ENOENT;
1582         if (!kernfs_active(kn) || !kernfs_active(new_parent) ||
1583             (new_parent->flags & KERNFS_EMPTY_DIR))
1584                 goto out;
1585
1586         error = 0;
1587         if ((kn->parent == new_parent) && (kn->ns == new_ns) &&
1588             (strcmp(kn->name, new_name) == 0))
1589                 goto out;       /* nothing to rename */
1590
1591         error = -EEXIST;
1592         if (kernfs_find_ns(new_parent, new_name, new_ns))
1593                 goto out;
1594
1595         /* rename kernfs_node */
1596         if (strcmp(kn->name, new_name) != 0) {
1597                 error = -ENOMEM;
1598                 new_name = kstrdup_const(new_name, GFP_KERNEL);
1599                 if (!new_name)
1600                         goto out;
1601         } else {
1602                 new_name = NULL;
1603         }
1604
1605         /*
1606          * Move to the appropriate place in the appropriate directories rbtree.
1607          */
1608         kernfs_unlink_sibling(kn);
1609         kernfs_get(new_parent);
1610
1611         /* rename_lock protects ->parent and ->name accessors */
1612         spin_lock_irq(&kernfs_rename_lock);
1613
1614         old_parent = kn->parent;
1615         kn->parent = new_parent;
1616
1617         kn->ns = new_ns;
1618         if (new_name) {
1619                 old_name = kn->name;
1620                 kn->name = new_name;
1621         }
1622
1623         spin_unlock_irq(&kernfs_rename_lock);
1624
1625         kn->hash = kernfs_name_hash(kn->name, kn->ns);
1626         kernfs_link_sibling(kn);
1627
1628         kernfs_put(old_parent);
1629         kfree_const(old_name);
1630
1631         error = 0;
1632  out:
1633         up_write(&kernfs_rwsem);
1634         return error;
1635 }
1636
1637 /* Relationship between mode and the DT_xxx types */
1638 static inline unsigned char dt_type(struct kernfs_node *kn)
1639 {
1640         return (kn->mode >> 12) & 15;
1641 }
1642
1643 static int kernfs_dir_fop_release(struct inode *inode, struct file *filp)
1644 {
1645         kernfs_put(filp->private_data);
1646         return 0;
1647 }
1648
1649 static struct kernfs_node *kernfs_dir_pos(const void *ns,
1650         struct kernfs_node *parent, loff_t hash, struct kernfs_node *pos)
1651 {
1652         if (pos) {
1653                 int valid = kernfs_active(pos) &&
1654                         pos->parent == parent && hash == pos->hash;
1655                 kernfs_put(pos);
1656                 if (!valid)
1657                         pos = NULL;
1658         }
1659         if (!pos && (hash > 1) && (hash < INT_MAX)) {
1660                 struct rb_node *node = parent->dir.children.rb_node;
1661                 while (node) {
1662                         pos = rb_to_kn(node);
1663
1664                         if (hash < pos->hash)
1665                                 node = node->rb_left;
1666                         else if (hash > pos->hash)
1667                                 node = node->rb_right;
1668                         else
1669                                 break;
1670                 }
1671         }
1672         /* Skip over entries which are dying/dead or in the wrong namespace */
1673         while (pos && (!kernfs_active(pos) || pos->ns != ns)) {
1674                 struct rb_node *node = rb_next(&pos->rb);
1675                 if (!node)
1676                         pos = NULL;
1677                 else
1678                         pos = rb_to_kn(node);
1679         }
1680         return pos;
1681 }
1682
1683 static struct kernfs_node *kernfs_dir_next_pos(const void *ns,
1684         struct kernfs_node *parent, ino_t ino, struct kernfs_node *pos)
1685 {
1686         pos = kernfs_dir_pos(ns, parent, ino, pos);
1687         if (pos) {
1688                 do {
1689                         struct rb_node *node = rb_next(&pos->rb);
1690                         if (!node)
1691                                 pos = NULL;
1692                         else
1693                                 pos = rb_to_kn(node);
1694                 } while (pos && (!kernfs_active(pos) || pos->ns != ns));
1695         }
1696         return pos;
1697 }
1698
1699 static int kernfs_fop_readdir(struct file *file, struct dir_context *ctx)
1700 {
1701         struct dentry *dentry = file->f_path.dentry;
1702         struct kernfs_node *parent = kernfs_dentry_node(dentry);
1703         struct kernfs_node *pos = file->private_data;
1704         const void *ns = NULL;
1705
1706         if (!dir_emit_dots(file, ctx))
1707                 return 0;
1708         down_read(&kernfs_rwsem);
1709
1710         if (kernfs_ns_enabled(parent))
1711                 ns = kernfs_info(dentry->d_sb)->ns;
1712
1713         for (pos = kernfs_dir_pos(ns, parent, ctx->pos, pos);
1714              pos;
1715              pos = kernfs_dir_next_pos(ns, parent, ctx->pos, pos)) {
1716                 const char *name = pos->name;
1717                 unsigned int type = dt_type(pos);
1718                 int len = strlen(name);
1719                 ino_t ino = kernfs_ino(pos);
1720
1721                 ctx->pos = pos->hash;
1722                 file->private_data = pos;
1723                 kernfs_get(pos);
1724
1725                 up_read(&kernfs_rwsem);
1726                 if (!dir_emit(ctx, name, len, ino, type))
1727                         return 0;
1728                 down_read(&kernfs_rwsem);
1729         }
1730         up_read(&kernfs_rwsem);
1731         file->private_data = NULL;
1732         ctx->pos = INT_MAX;
1733         return 0;
1734 }
1735
1736 const struct file_operations kernfs_dir_fops = {
1737         .read           = generic_read_dir,
1738         .iterate_shared = kernfs_fop_readdir,
1739         .release        = kernfs_dir_fop_release,
1740         .llseek         = generic_file_llseek,
1741 };