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