blob: a387534c9577855b6ea6d8e2868e4f85c52551b4 [file] [log] [blame]
Thomas Gleixner55716d22019-06-01 10:08:42 +02001// SPDX-License-Identifier: GPL-2.0-only
Tejun Heob8441ed2013-11-24 09:54:58 -05002/*
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>
Tejun Heob8441ed2013-11-24 09:54:58 -05008 */
Tejun Heofd7b9f72013-11-28 14:54:33 -05009
Tejun Heoabd54f02014-02-03 14:02:55 -050010#include <linux/sched.h>
Tejun Heofd7b9f72013-11-28 14:54:33 -050011#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
Tejun Heoa797bfc2013-12-11 14:11:57 -050020DEFINE_MUTEX(kernfs_mutex);
Tejun Heo3eef34a2014-02-07 13:32:07 -050021static DEFINE_SPINLOCK(kernfs_rename_lock); /* kn->parent and ->name */
22static char kernfs_pr_cont_buf[PATH_MAX]; /* protected by rename_lock */
Shaohua Li7d350792017-07-12 11:49:46 -070023static DEFINE_SPINLOCK(kernfs_idr_lock); /* root->ino_idr */
Tejun Heofd7b9f72013-11-28 14:54:33 -050024
Tejun Heoadc5e8b2013-12-11 14:11:54 -050025#define rb_to_kn(X) rb_entry((X), struct kernfs_node, rb)
Tejun Heofd7b9f72013-11-28 14:54:33 -050026
Tejun Heo81c173c2014-02-03 14:03:00 -050027static bool kernfs_active(struct kernfs_node *kn)
28{
29 lockdep_assert_held(&kernfs_mutex);
30 return atomic_read(&kn->active) >= 0;
31}
32
Tejun Heo182fd642014-02-03 14:02:59 -050033static 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
Tejun Heo3eef34a2014-02-07 13:32:07 -050042static int kernfs_name_locked(struct kernfs_node *kn, char *buf, size_t buflen)
43{
Konstantin Khlebnikov17627152017-02-08 14:28:55 +030044 if (!kn)
45 return strlcpy(buf, "(null)", buflen);
46
Tejun Heo3eef34a2014-02-07 13:32:07 -050047 return strlcpy(buf, kn->parent ? kn->name : "/", buflen);
48}
49
Aditya Kali9f6df572016-01-29 02:54:04 -060050/* kernfs_node_depth - compute depth from @from to @to */
51static size_t kernfs_depth(struct kernfs_node *from, struct kernfs_node *to)
Tejun Heo3eef34a2014-02-07 13:32:07 -050052{
Aditya Kali9f6df572016-01-29 02:54:04 -060053 size_t depth = 0;
Tejun Heo3eef34a2014-02-07 13:32:07 -050054
Aditya Kali9f6df572016-01-29 02:54:04 -060055 while (to->parent && to != from) {
56 depth++;
57 to = to->parent;
58 }
59 return depth;
60}
Tejun Heo3eef34a2014-02-07 13:32:07 -050061
Aditya Kali9f6df572016-01-29 02:54:04 -060062static 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);
Tejun Heo3eef34a2014-02-07 13:32:07 -050067
Aditya Kali9f6df572016-01-29 02:54:04 -060068 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 *
Konstantin Khlebnikov17627152017-02-08 14:28:55 +0300116 * [3] when @kn_to is NULL result will be "(null)"
117 *
Tejun Heo3abb1d92016-08-10 11:23:44 -0400118 * 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.
Aditya Kali9f6df572016-01-29 02:54:04 -0600121 */
122static 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[] = "/..";
Tejun Heo3abb1d92016-08-10 11:23:44 -0400128 size_t depth_from, depth_to, len = 0;
129 int i, j;
Aditya Kali9f6df572016-01-29 02:54:04 -0600130
Konstantin Khlebnikov17627152017-02-08 14:28:55 +0300131 if (!kn_to)
132 return strlcpy(buf, "(null)", buflen);
133
Aditya Kali9f6df572016-01-29 02:54:04 -0600134 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))
Tejun Heo3abb1d92016-08-10 11:23:44 -0400142 return -EINVAL;
Aditya Kali9f6df572016-01-29 02:54:04 -0600143
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 */
Tejun Heo3abb1d92016-08-10 11:23:44 -0400155 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);
Aditya Kali9f6df572016-01-29 02:54:04 -0600162 }
163
Tejun Heo3abb1d92016-08-10 11:23:44 -0400164 return len;
Tejun Heo3eef34a2014-02-07 13:32:07 -0500165}
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 *
Konstantin Khlebnikov17627152017-02-08 14:28:55 +0300177 * Fills buffer with "(null)" if @kn is NULL.
178 *
Tejun Heo3eef34a2014-02-07 13:32:07 -0500179 * This function can be called from any context.
180 */
181int 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/**
Aditya Kali9f6df572016-01-29 02:54:04 -0600193 * 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 *
Tejun Heo3abb1d92016-08-10 11:23:44 -0400204 * 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.
Aditya Kali9f6df572016-01-29 02:54:04 -0600207 */
208int 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}
219EXPORT_SYMBOL_GPL(kernfs_path_from_node);
220
221/**
Tejun Heo3eef34a2014-02-07 13:32:07 -0500222 * 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 */
227void 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 */
245void pr_cont_kernfs_path(struct kernfs_node *kn)
246{
247 unsigned long flags;
Aditya Kali9f6df572016-01-29 02:54:04 -0600248 int sz;
Tejun Heo3eef34a2014-02-07 13:32:07 -0500249
250 spin_lock_irqsave(&kernfs_rename_lock, flags);
251
Aditya Kali9f6df572016-01-29 02:54:04 -0600252 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 }
Tejun Heo3eef34a2014-02-07 13:32:07 -0500258
Aditya Kali9f6df572016-01-29 02:54:04 -0600259 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
266out:
Tejun Heo3eef34a2014-02-07 13:32:07 -0500267 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 */
277struct 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
Tejun Heofd7b9f72013-11-28 14:54:33 -0500290/**
Tejun Heoc637b8a2013-12-11 14:11:58 -0500291 * kernfs_name_hash
Tejun Heofd7b9f72013-11-28 14:54:33 -0500292 * @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 */
Tejun Heoc637b8a2013-12-11 14:11:58 -0500297static unsigned int kernfs_name_hash(const char *name, const void *ns)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500298{
Linus Torvalds8387ff22016-06-10 07:51:30 -0700299 unsigned long hash = init_name_hash(ns);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500300 unsigned int len = strlen(name);
301 while (len--)
302 hash = partial_name_hash(*name++, hash);
Linus Torvalds8387ff22016-06-10 07:51:30 -0700303 hash = end_name_hash(hash);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500304 hash &= 0x7fffffffU;
305 /* Reserve hash numbers 0, 1 and INT_MAX for magic directory entries */
Richard Cochran88391d42014-03-05 17:10:52 +0100306 if (hash < 2)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500307 hash += 2;
308 if (hash >= INT_MAX)
309 hash = INT_MAX - 1;
310 return hash;
311}
312
Tejun Heoc637b8a2013-12-11 14:11:58 -0500313static int kernfs_name_compare(unsigned int hash, const char *name,
314 const void *ns, const struct kernfs_node *kn)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500315{
Rasmus Villemoes72392ed2014-12-05 23:41:33 +0100316 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;
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500324 return strcmp(name, kn->name);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500325}
326
Tejun Heoc637b8a2013-12-11 14:11:58 -0500327static int kernfs_sd_compare(const struct kernfs_node *left,
328 const struct kernfs_node *right)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500329{
Tejun Heoc637b8a2013-12-11 14:11:58 -0500330 return kernfs_name_compare(left->hash, left->name, left->ns, right);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500331}
332
333/**
Tejun Heoc637b8a2013-12-11 14:11:58 -0500334 * kernfs_link_sibling - link kernfs_node into sibling rbtree
Tejun Heo324a56e2013-12-11 14:11:53 -0500335 * @kn: kernfs_node of interest
Tejun Heofd7b9f72013-11-28 14:54:33 -0500336 *
Tejun Heo324a56e2013-12-11 14:11:53 -0500337 * Link @kn into its sibling rbtree which starts from
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500338 * @kn->parent->dir.children.
Tejun Heofd7b9f72013-11-28 14:54:33 -0500339 *
340 * Locking:
Tejun Heoa797bfc2013-12-11 14:11:57 -0500341 * mutex_lock(kernfs_mutex)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500342 *
343 * RETURNS:
344 * 0 on susccess -EEXIST on failure.
345 */
Tejun Heoc637b8a2013-12-11 14:11:58 -0500346static int kernfs_link_sibling(struct kernfs_node *kn)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500347{
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500348 struct rb_node **node = &kn->parent->dir.children.rb_node;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500349 struct rb_node *parent = NULL;
350
Tejun Heofd7b9f72013-11-28 14:54:33 -0500351 while (*node) {
Tejun Heo324a56e2013-12-11 14:11:53 -0500352 struct kernfs_node *pos;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500353 int result;
354
Tejun Heo324a56e2013-12-11 14:11:53 -0500355 pos = rb_to_kn(*node);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500356 parent = *node;
Tejun Heoc637b8a2013-12-11 14:11:58 -0500357 result = kernfs_sd_compare(kn, pos);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500358 if (result < 0)
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500359 node = &pos->rb.rb_left;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500360 else if (result > 0)
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500361 node = &pos->rb.rb_right;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500362 else
363 return -EEXIST;
364 }
Jianyu Zhanc1befb82014-04-17 17:52:10 +0800365
Tejun Heofd7b9f72013-11-28 14:54:33 -0500366 /* add new node and rebalance the tree */
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500367 rb_link_node(&kn->rb, parent, node);
368 rb_insert_color(&kn->rb, &kn->parent->dir.children);
Jianyu Zhanc1befb82014-04-17 17:52:10 +0800369
370 /* successfully added, account subdir number */
371 if (kernfs_type(kn) == KERNFS_DIR)
372 kn->parent->dir.subdirs++;
373
Tejun Heofd7b9f72013-11-28 14:54:33 -0500374 return 0;
375}
376
377/**
Tejun Heoc637b8a2013-12-11 14:11:58 -0500378 * kernfs_unlink_sibling - unlink kernfs_node from sibling rbtree
Tejun Heo324a56e2013-12-11 14:11:53 -0500379 * @kn: kernfs_node of interest
Tejun Heofd7b9f72013-11-28 14:54:33 -0500380 *
Tejun Heo35beab02014-02-03 14:02:56 -0500381 * 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.
Tejun Heofd7b9f72013-11-28 14:54:33 -0500384 *
385 * Locking:
Tejun Heoa797bfc2013-12-11 14:11:57 -0500386 * mutex_lock(kernfs_mutex)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500387 */
Tejun Heo35beab02014-02-03 14:02:56 -0500388static bool kernfs_unlink_sibling(struct kernfs_node *kn)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500389{
Tejun Heo35beab02014-02-03 14:02:56 -0500390 if (RB_EMPTY_NODE(&kn->rb))
391 return false;
392
Tejun Heodf23fc32013-12-11 14:11:56 -0500393 if (kernfs_type(kn) == KERNFS_DIR)
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500394 kn->parent->dir.subdirs--;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500395
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500396 rb_erase(&kn->rb, &kn->parent->dir.children);
Tejun Heo35beab02014-02-03 14:02:56 -0500397 RB_CLEAR_NODE(&kn->rb);
398 return true;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500399}
400
401/**
Tejun Heoc637b8a2013-12-11 14:11:58 -0500402 * kernfs_get_active - get an active reference to kernfs_node
Tejun Heo324a56e2013-12-11 14:11:53 -0500403 * @kn: kernfs_node to get an active reference to
Tejun Heofd7b9f72013-11-28 14:54:33 -0500404 *
Tejun Heo324a56e2013-12-11 14:11:53 -0500405 * Get an active reference of @kn. This function is noop if @kn
Tejun Heofd7b9f72013-11-28 14:54:33 -0500406 * is NULL.
407 *
408 * RETURNS:
Tejun Heo324a56e2013-12-11 14:11:53 -0500409 * Pointer to @kn on success, NULL on failure.
Tejun Heofd7b9f72013-11-28 14:54:33 -0500410 */
Tejun Heoc637b8a2013-12-11 14:11:58 -0500411struct kernfs_node *kernfs_get_active(struct kernfs_node *kn)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500412{
Tejun Heo324a56e2013-12-11 14:11:53 -0500413 if (unlikely(!kn))
Tejun Heofd7b9f72013-11-28 14:54:33 -0500414 return NULL;
415
Greg Kroah-Hartmanf4b3e632014-01-13 14:13:39 -0800416 if (!atomic_inc_unless_negative(&kn->active))
417 return NULL;
418
Tejun Heo182fd642014-02-03 14:02:59 -0500419 if (kernfs_lockdep(kn))
Tejun Heo324a56e2013-12-11 14:11:53 -0500420 rwsem_acquire_read(&kn->dep_map, 0, 1, _RET_IP_);
Greg Kroah-Hartmanf4b3e632014-01-13 14:13:39 -0800421 return kn;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500422}
423
424/**
Tejun Heoc637b8a2013-12-11 14:11:58 -0500425 * kernfs_put_active - put an active reference to kernfs_node
Tejun Heo324a56e2013-12-11 14:11:53 -0500426 * @kn: kernfs_node to put an active reference to
Tejun Heofd7b9f72013-11-28 14:54:33 -0500427 *
Tejun Heo324a56e2013-12-11 14:11:53 -0500428 * Put an active reference to @kn. This function is noop if @kn
Tejun Heofd7b9f72013-11-28 14:54:33 -0500429 * is NULL.
430 */
Tejun Heoc637b8a2013-12-11 14:11:58 -0500431void kernfs_put_active(struct kernfs_node *kn)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500432{
Tejun Heoabd54f02014-02-03 14:02:55 -0500433 struct kernfs_root *root = kernfs_root(kn);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500434 int v;
435
Tejun Heo324a56e2013-12-11 14:11:53 -0500436 if (unlikely(!kn))
Tejun Heofd7b9f72013-11-28 14:54:33 -0500437 return;
438
Tejun Heo182fd642014-02-03 14:02:59 -0500439 if (kernfs_lockdep(kn))
Tejun Heo324a56e2013-12-11 14:11:53 -0500440 rwsem_release(&kn->dep_map, 1, _RET_IP_);
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500441 v = atomic_dec_return(&kn->active);
Tejun Heodf23fc32013-12-11 14:11:56 -0500442 if (likely(v != KN_DEACTIVATED_BIAS))
Tejun Heofd7b9f72013-11-28 14:54:33 -0500443 return;
444
Tejun Heoabd54f02014-02-03 14:02:55 -0500445 wake_up_all(&root->deactivate_waitq);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500446}
447
448/**
Tejun Heo81c173c2014-02-03 14:03:00 -0500449 * kernfs_drain - drain kernfs_node
450 * @kn: kernfs_node to drain
Tejun Heofd7b9f72013-11-28 14:54:33 -0500451 *
Tejun Heo81c173c2014-02-03 14:03:00 -0500452 * Drain existing usages and nuke all existing mmaps of @kn. Mutiple
453 * removers may invoke this function concurrently on @kn and all will
454 * return after draining is complete.
Tejun Heofd7b9f72013-11-28 14:54:33 -0500455 */
Tejun Heo81c173c2014-02-03 14:03:00 -0500456static void kernfs_drain(struct kernfs_node *kn)
Tejun Heo35beab02014-02-03 14:02:56 -0500457 __releases(&kernfs_mutex) __acquires(&kernfs_mutex)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500458{
Tejun Heoabd54f02014-02-03 14:02:55 -0500459 struct kernfs_root *root = kernfs_root(kn);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500460
Tejun Heo35beab02014-02-03 14:02:56 -0500461 lockdep_assert_held(&kernfs_mutex);
Tejun Heo81c173c2014-02-03 14:03:00 -0500462 WARN_ON_ONCE(kernfs_active(kn));
Tejun Heo35beab02014-02-03 14:02:56 -0500463
464 mutex_unlock(&kernfs_mutex);
465
Tejun Heo182fd642014-02-03 14:02:59 -0500466 if (kernfs_lockdep(kn)) {
Tejun Heoa6607932014-02-03 14:02:54 -0500467 rwsem_acquire(&kn->dep_map, 0, 0, _RET_IP_);
Tejun Heo35beab02014-02-03 14:02:56 -0500468 if (atomic_read(&kn->active) != KN_DEACTIVATED_BIAS)
469 lock_contended(&kn->dep_map, _RET_IP_);
470 }
Greg Kroah-Hartman08901472014-01-13 14:39:52 -0800471
Tejun Heo35beab02014-02-03 14:02:56 -0500472 /* but everyone should wait for draining */
Tejun Heoabd54f02014-02-03 14:02:55 -0500473 wait_event(root->deactivate_waitq,
474 atomic_read(&kn->active) == KN_DEACTIVATED_BIAS);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500475
Tejun Heo182fd642014-02-03 14:02:59 -0500476 if (kernfs_lockdep(kn)) {
Tejun Heoa6607932014-02-03 14:02:54 -0500477 lock_acquired(&kn->dep_map, _RET_IP_);
478 rwsem_release(&kn->dep_map, 1, _RET_IP_);
479 }
Tejun Heo35beab02014-02-03 14:02:56 -0500480
Tejun Heo0e67db22016-12-27 14:49:03 -0500481 kernfs_drain_open_files(kn);
Tejun Heoccf02aa2014-02-03 14:02:57 -0500482
Tejun Heo35beab02014-02-03 14:02:56 -0500483 mutex_lock(&kernfs_mutex);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500484}
485
Tejun Heofd7b9f72013-11-28 14:54:33 -0500486/**
Tejun Heo324a56e2013-12-11 14:11:53 -0500487 * kernfs_get - get a reference count on a kernfs_node
488 * @kn: the target kernfs_node
Tejun Heofd7b9f72013-11-28 14:54:33 -0500489 */
Tejun Heo324a56e2013-12-11 14:11:53 -0500490void kernfs_get(struct kernfs_node *kn)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500491{
Tejun Heo324a56e2013-12-11 14:11:53 -0500492 if (kn) {
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500493 WARN_ON(!atomic_read(&kn->count));
494 atomic_inc(&kn->count);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500495 }
496}
497EXPORT_SYMBOL_GPL(kernfs_get);
498
499/**
Tejun Heo324a56e2013-12-11 14:11:53 -0500500 * kernfs_put - put a reference count on a kernfs_node
501 * @kn: the target kernfs_node
Tejun Heofd7b9f72013-11-28 14:54:33 -0500502 *
Tejun Heo324a56e2013-12-11 14:11:53 -0500503 * Put a reference count of @kn and destroy it if it reached zero.
Tejun Heofd7b9f72013-11-28 14:54:33 -0500504 */
Tejun Heo324a56e2013-12-11 14:11:53 -0500505void kernfs_put(struct kernfs_node *kn)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500506{
Tejun Heo324a56e2013-12-11 14:11:53 -0500507 struct kernfs_node *parent;
Tejun Heoba7443b2013-11-28 14:54:40 -0500508 struct kernfs_root *root;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500509
Shaohua Liba16b282017-07-12 11:49:48 -0700510 /*
511 * kernfs_node is freed with ->count 0, kernfs_find_and_get_node_by_ino
512 * depends on this to filter reused stale node
513 */
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500514 if (!kn || !atomic_dec_and_test(&kn->count))
Tejun Heofd7b9f72013-11-28 14:54:33 -0500515 return;
Tejun Heo324a56e2013-12-11 14:11:53 -0500516 root = kernfs_root(kn);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500517 repeat:
Tejun Heo81c173c2014-02-03 14:03:00 -0500518 /*
519 * Moving/renaming is always done while holding reference.
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500520 * kn->parent won't change beneath us.
Tejun Heofd7b9f72013-11-28 14:54:33 -0500521 */
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500522 parent = kn->parent;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500523
Tejun Heo81c173c2014-02-03 14:03:00 -0500524 WARN_ONCE(atomic_read(&kn->active) != KN_DEACTIVATED_BIAS,
525 "kernfs_put: %s/%s: released with incorrect active_ref %d\n",
526 parent ? parent->name : "", kn->name, atomic_read(&kn->active));
Tejun Heofd7b9f72013-11-28 14:54:33 -0500527
Tejun Heodf23fc32013-12-11 14:11:56 -0500528 if (kernfs_type(kn) == KERNFS_LINK)
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500529 kernfs_put(kn->symlink.target_kn);
Tejun Heodfeb07502015-02-13 14:36:31 -0800530
531 kfree_const(kn->name);
532
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500533 if (kn->iattr) {
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500534 simple_xattrs_free(&kn->iattr->xattrs);
Ayush Mittal26e28d62019-02-06 10:25:42 +0530535 kmem_cache_free(kernfs_iattrs_cache, kn->iattr);
Tejun Heo23223922013-11-23 17:40:02 -0500536 }
Shaohua Li7d350792017-07-12 11:49:46 -0700537 spin_lock(&kernfs_idr_lock);
Shaohua Lic53cd492017-07-12 11:49:50 -0700538 idr_remove(&root->ino_idr, kn->id.ino);
Shaohua Li7d350792017-07-12 11:49:46 -0700539 spin_unlock(&kernfs_idr_lock);
Tejun Heoa797bfc2013-12-11 14:11:57 -0500540 kmem_cache_free(kernfs_node_cache, kn);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500541
Tejun Heo324a56e2013-12-11 14:11:53 -0500542 kn = parent;
543 if (kn) {
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500544 if (atomic_dec_and_test(&kn->count))
Tejun Heoba7443b2013-11-28 14:54:40 -0500545 goto repeat;
546 } else {
Tejun Heo324a56e2013-12-11 14:11:53 -0500547 /* just released the root kn, free @root too */
Shaohua Li7d350792017-07-12 11:49:46 -0700548 idr_destroy(&root->ino_idr);
Tejun Heoba7443b2013-11-28 14:54:40 -0500549 kfree(root);
550 }
Tejun Heofd7b9f72013-11-28 14:54:33 -0500551}
552EXPORT_SYMBOL_GPL(kernfs_put);
553
Tejun Heoc637b8a2013-12-11 14:11:58 -0500554static int kernfs_dop_revalidate(struct dentry *dentry, unsigned int flags)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500555{
Tejun Heo324a56e2013-12-11 14:11:53 -0500556 struct kernfs_node *kn;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500557
558 if (flags & LOOKUP_RCU)
559 return -ECHILD;
560
Tejun Heo19bbb922013-12-11 16:02:59 -0500561 /* Always perform fresh lookup for negatives */
David Howells2b0143b2015-03-17 22:25:59 +0000562 if (d_really_is_negative(dentry))
Tejun Heo19bbb922013-12-11 16:02:59 -0500563 goto out_bad_unlocked;
564
Shaohua Li319ba912017-07-12 11:49:49 -0700565 kn = kernfs_dentry_node(dentry);
Tejun Heoa797bfc2013-12-11 14:11:57 -0500566 mutex_lock(&kernfs_mutex);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500567
Tejun Heo81c173c2014-02-03 14:03:00 -0500568 /* The kernfs node has been deactivated */
569 if (!kernfs_active(kn))
Tejun Heofd7b9f72013-11-28 14:54:33 -0500570 goto out_bad;
571
Tejun Heoc637b8a2013-12-11 14:11:58 -0500572 /* The kernfs node has been moved? */
Shaohua Li319ba912017-07-12 11:49:49 -0700573 if (kernfs_dentry_node(dentry->d_parent) != kn->parent)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500574 goto out_bad;
575
Tejun Heoc637b8a2013-12-11 14:11:58 -0500576 /* The kernfs node has been renamed */
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500577 if (strcmp(dentry->d_name.name, kn->name) != 0)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500578 goto out_bad;
579
Tejun Heoc637b8a2013-12-11 14:11:58 -0500580 /* The kernfs node has been moved to a different namespace */
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500581 if (kn->parent && kernfs_ns_enabled(kn->parent) &&
Tejun Heoc525aad2013-12-11 14:11:55 -0500582 kernfs_info(dentry->d_sb)->ns != kn->ns)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500583 goto out_bad;
584
Tejun Heoa797bfc2013-12-11 14:11:57 -0500585 mutex_unlock(&kernfs_mutex);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500586 return 1;
587out_bad:
Tejun Heoa797bfc2013-12-11 14:11:57 -0500588 mutex_unlock(&kernfs_mutex);
Tejun Heo19bbb922013-12-11 16:02:59 -0500589out_bad_unlocked:
Tejun Heofd7b9f72013-11-28 14:54:33 -0500590 return 0;
591}
592
Tejun Heoa797bfc2013-12-11 14:11:57 -0500593const struct dentry_operations kernfs_dops = {
Tejun Heoc637b8a2013-12-11 14:11:58 -0500594 .d_revalidate = kernfs_dop_revalidate,
Tejun Heofd7b9f72013-11-28 14:54:33 -0500595};
596
Tejun Heo0c23b222014-02-03 14:09:15 -0500597/**
598 * kernfs_node_from_dentry - determine kernfs_node associated with a dentry
599 * @dentry: the dentry in question
600 *
601 * Return the kernfs_node associated with @dentry. If @dentry is not a
602 * kernfs one, %NULL is returned.
603 *
604 * While the returned kernfs_node will stay accessible as long as @dentry
605 * is accessible, the returned node can be in any state and the caller is
606 * fully responsible for determining what's accessible.
607 */
608struct kernfs_node *kernfs_node_from_dentry(struct dentry *dentry)
609{
Shaohua Li319ba912017-07-12 11:49:49 -0700610 if (dentry->d_sb->s_op == &kernfs_sops &&
611 !d_really_is_negative(dentry))
612 return kernfs_dentry_node(dentry);
Tejun Heo0c23b222014-02-03 14:09:15 -0500613 return NULL;
614}
615
Tejun Heodb4aad22014-01-17 09:58:25 -0500616static struct kernfs_node *__kernfs_new_node(struct kernfs_root *root,
Ondrej Mosnaceke19dfdc2019-02-22 15:57:18 +0100617 struct kernfs_node *parent,
Tejun Heodb4aad22014-01-17 09:58:25 -0500618 const char *name, umode_t mode,
Dmitry Torokhov488dee92018-07-20 21:56:47 +0000619 kuid_t uid, kgid_t gid,
Tejun Heodb4aad22014-01-17 09:58:25 -0500620 unsigned flags)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500621{
Tejun Heo324a56e2013-12-11 14:11:53 -0500622 struct kernfs_node *kn;
Shaohua Li4a3ef682017-07-12 11:49:47 -0700623 u32 gen;
624 int cursor;
Tejun Heobc755552013-11-28 14:54:41 -0500625 int ret;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500626
Tejun Heodfeb07502015-02-13 14:36:31 -0800627 name = kstrdup_const(name, GFP_KERNEL);
628 if (!name)
629 return NULL;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500630
Tejun Heoa797bfc2013-12-11 14:11:57 -0500631 kn = kmem_cache_zalloc(kernfs_node_cache, GFP_KERNEL);
Tejun Heo324a56e2013-12-11 14:11:53 -0500632 if (!kn)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500633 goto err_out1;
634
Shaohua Li7d350792017-07-12 11:49:46 -0700635 idr_preload(GFP_KERNEL);
636 spin_lock(&kernfs_idr_lock);
Shaohua Li4a3ef682017-07-12 11:49:47 -0700637 cursor = idr_get_cursor(&root->ino_idr);
638 ret = idr_alloc_cyclic(&root->ino_idr, kn, 1, 0, GFP_ATOMIC);
639 if (ret >= 0 && ret < cursor)
640 root->next_generation++;
641 gen = root->next_generation;
Shaohua Li7d350792017-07-12 11:49:46 -0700642 spin_unlock(&kernfs_idr_lock);
643 idr_preload_end();
Tejun Heobc755552013-11-28 14:54:41 -0500644 if (ret < 0)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500645 goto err_out2;
Shaohua Lic53cd492017-07-12 11:49:50 -0700646 kn->id.ino = ret;
647 kn->id.generation = gen;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500648
Shaohua Liba16b282017-07-12 11:49:48 -0700649 /*
Andrea Parri99826792019-04-16 14:17:11 +0200650 * set ino first. This RELEASE is paired with atomic_inc_not_zero in
Shaohua Liba16b282017-07-12 11:49:48 -0700651 * kernfs_find_and_get_node_by_ino
652 */
Andrea Parri99826792019-04-16 14:17:11 +0200653 atomic_set_release(&kn->count, 1);
Tejun Heo81c173c2014-02-03 14:03:00 -0500654 atomic_set(&kn->active, KN_DEACTIVATED_BIAS);
Tejun Heo35beab02014-02-03 14:02:56 -0500655 RB_CLEAR_NODE(&kn->rb);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500656
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500657 kn->name = name;
658 kn->mode = mode;
Tejun Heo81c173c2014-02-03 14:03:00 -0500659 kn->flags = flags;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500660
Dmitry Torokhov488dee92018-07-20 21:56:47 +0000661 if (!uid_eq(uid, GLOBAL_ROOT_UID) || !gid_eq(gid, GLOBAL_ROOT_GID)) {
662 struct iattr iattr = {
663 .ia_valid = ATTR_UID | ATTR_GID,
664 .ia_uid = uid,
665 .ia_gid = gid,
666 };
667
668 ret = __kernfs_setattr(kn, &iattr);
669 if (ret < 0)
670 goto err_out3;
671 }
672
Ondrej Mosnaceke19dfdc2019-02-22 15:57:18 +0100673 if (parent) {
674 ret = security_kernfs_init_security(parent, kn);
675 if (ret)
676 goto err_out3;
677 }
678
Tejun Heo324a56e2013-12-11 14:11:53 -0500679 return kn;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500680
Dmitry Torokhov488dee92018-07-20 21:56:47 +0000681 err_out3:
682 idr_remove(&root->ino_idr, kn->id.ino);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500683 err_out2:
Tejun Heoa797bfc2013-12-11 14:11:57 -0500684 kmem_cache_free(kernfs_node_cache, kn);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500685 err_out1:
Tejun Heodfeb07502015-02-13 14:36:31 -0800686 kfree_const(name);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500687 return NULL;
688}
689
Tejun Heodb4aad22014-01-17 09:58:25 -0500690struct kernfs_node *kernfs_new_node(struct kernfs_node *parent,
691 const char *name, umode_t mode,
Dmitry Torokhov488dee92018-07-20 21:56:47 +0000692 kuid_t uid, kgid_t gid,
Tejun Heodb4aad22014-01-17 09:58:25 -0500693 unsigned flags)
694{
695 struct kernfs_node *kn;
696
Ondrej Mosnaceke19dfdc2019-02-22 15:57:18 +0100697 kn = __kernfs_new_node(kernfs_root(parent), parent,
Dmitry Torokhov488dee92018-07-20 21:56:47 +0000698 name, mode, uid, gid, flags);
Tejun Heodb4aad22014-01-17 09:58:25 -0500699 if (kn) {
700 kernfs_get(parent);
701 kn->parent = parent;
702 }
703 return kn;
704}
705
Shaohua Liba16b282017-07-12 11:49:48 -0700706/*
707 * kernfs_find_and_get_node_by_ino - get kernfs_node from inode number
708 * @root: the kernfs root
709 * @ino: inode number
710 *
711 * RETURNS:
712 * NULL on failure. Return a kernfs node with reference counter incremented
713 */
714struct kernfs_node *kernfs_find_and_get_node_by_ino(struct kernfs_root *root,
715 unsigned int ino)
716{
717 struct kernfs_node *kn;
718
719 rcu_read_lock();
720 kn = idr_find(&root->ino_idr, ino);
721 if (!kn)
722 goto out;
723
724 /*
725 * Since kernfs_node is freed in RCU, it's possible an old node for ino
726 * is freed, but reused before RCU grace period. But a freed node (see
727 * kernfs_put) or an incompletedly initialized node (see
728 * __kernfs_new_node) should have 'count' 0. We can use this fact to
729 * filter out such node.
730 */
731 if (!atomic_inc_not_zero(&kn->count)) {
732 kn = NULL;
733 goto out;
734 }
735
736 /*
737 * The node could be a new node or a reused node. If it's a new node,
738 * we are ok. If it's reused because of RCU (because of
739 * SLAB_TYPESAFE_BY_RCU), the __kernfs_new_node always sets its 'ino'
740 * before 'count'. So if 'count' is uptodate, 'ino' should be uptodate,
741 * hence we can use 'ino' to filter stale node.
742 */
Shaohua Lic53cd492017-07-12 11:49:50 -0700743 if (kn->id.ino != ino)
Shaohua Liba16b282017-07-12 11:49:48 -0700744 goto out;
745 rcu_read_unlock();
746
747 return kn;
748out:
749 rcu_read_unlock();
750 kernfs_put(kn);
751 return NULL;
752}
753
Tejun Heofd7b9f72013-11-28 14:54:33 -0500754/**
Tejun Heoc637b8a2013-12-11 14:11:58 -0500755 * kernfs_add_one - add kernfs_node to parent without warning
Tejun Heo324a56e2013-12-11 14:11:53 -0500756 * @kn: kernfs_node to be added
Tejun Heofd7b9f72013-11-28 14:54:33 -0500757 *
Tejun Heodb4aad22014-01-17 09:58:25 -0500758 * The caller must already have initialized @kn->parent. This
759 * function increments nlink of the parent's inode if @kn is a
760 * directory and link into the children list of the parent.
Tejun Heofd7b9f72013-11-28 14:54:33 -0500761 *
Tejun Heofd7b9f72013-11-28 14:54:33 -0500762 * RETURNS:
763 * 0 on success, -EEXIST if entry with the given name already
764 * exists.
765 */
Tejun Heo988cd7a2014-02-03 14:02:58 -0500766int kernfs_add_one(struct kernfs_node *kn)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500767{
Tejun Heodb4aad22014-01-17 09:58:25 -0500768 struct kernfs_node *parent = kn->parent;
Tejun Heoc525aad2013-12-11 14:11:55 -0500769 struct kernfs_iattrs *ps_iattr;
Tejun Heo988cd7a2014-02-03 14:02:58 -0500770 bool has_ns;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500771 int ret;
772
Tejun Heo988cd7a2014-02-03 14:02:58 -0500773 mutex_lock(&kernfs_mutex);
774
775 ret = -EINVAL;
776 has_ns = kernfs_ns_enabled(parent);
777 if (WARN(has_ns != (bool)kn->ns, KERN_WARNING "kernfs: ns %s in '%s' for '%s'\n",
778 has_ns ? "required" : "invalid", parent->name, kn->name))
779 goto out_unlock;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500780
Tejun Heodf23fc32013-12-11 14:11:56 -0500781 if (kernfs_type(parent) != KERNFS_DIR)
Tejun Heo988cd7a2014-02-03 14:02:58 -0500782 goto out_unlock;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500783
Tejun Heo988cd7a2014-02-03 14:02:58 -0500784 ret = -ENOENT;
Eric W. Biedermanea015212015-05-13 16:09:29 -0500785 if (parent->flags & KERNFS_EMPTY_DIR)
786 goto out_unlock;
787
Tejun Heod35258e2014-02-03 14:09:12 -0500788 if ((parent->flags & KERNFS_ACTIVATED) && !kernfs_active(parent))
Tejun Heo988cd7a2014-02-03 14:02:58 -0500789 goto out_unlock;
Greg Kroah-Hartman798c75a2014-01-13 14:36:03 -0800790
Tejun Heoc637b8a2013-12-11 14:11:58 -0500791 kn->hash = kernfs_name_hash(kn->name, kn->ns);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500792
Tejun Heoc637b8a2013-12-11 14:11:58 -0500793 ret = kernfs_link_sibling(kn);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500794 if (ret)
Tejun Heo988cd7a2014-02-03 14:02:58 -0500795 goto out_unlock;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500796
797 /* Update timestamps on the parent */
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500798 ps_iattr = parent->iattr;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500799 if (ps_iattr) {
Ondrej Mosnacek05895212019-02-22 15:57:12 +0100800 ktime_get_real_ts64(&ps_iattr->ia_ctime);
801 ps_iattr->ia_mtime = ps_iattr->ia_ctime;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500802 }
803
Tejun Heod35258e2014-02-03 14:09:12 -0500804 mutex_unlock(&kernfs_mutex);
805
806 /*
807 * Activate the new node unless CREATE_DEACTIVATED is requested.
808 * If not activated here, the kernfs user is responsible for
809 * activating the node with kernfs_activate(). A node which hasn't
810 * been activated is not visible to userland and its removal won't
811 * trigger deactivation.
812 */
813 if (!(kernfs_root(kn)->flags & KERNFS_ROOT_CREATE_DEACTIVATED))
814 kernfs_activate(kn);
815 return 0;
816
Tejun Heo988cd7a2014-02-03 14:02:58 -0500817out_unlock:
Tejun Heoa797bfc2013-12-11 14:11:57 -0500818 mutex_unlock(&kernfs_mutex);
Tejun Heo988cd7a2014-02-03 14:02:58 -0500819 return ret;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500820}
821
822/**
Tejun Heo324a56e2013-12-11 14:11:53 -0500823 * kernfs_find_ns - find kernfs_node with the given name
824 * @parent: kernfs_node to search under
Tejun Heofd7b9f72013-11-28 14:54:33 -0500825 * @name: name to look for
826 * @ns: the namespace tag to use
827 *
Tejun Heo324a56e2013-12-11 14:11:53 -0500828 * Look for kernfs_node with name @name under @parent. Returns pointer to
829 * the found kernfs_node on success, %NULL on failure.
Tejun Heofd7b9f72013-11-28 14:54:33 -0500830 */
Tejun Heo324a56e2013-12-11 14:11:53 -0500831static struct kernfs_node *kernfs_find_ns(struct kernfs_node *parent,
832 const unsigned char *name,
833 const void *ns)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500834{
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500835 struct rb_node *node = parent->dir.children.rb_node;
Tejun Heoac9bba02013-11-29 17:19:09 -0500836 bool has_ns = kernfs_ns_enabled(parent);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500837 unsigned int hash;
838
Tejun Heoa797bfc2013-12-11 14:11:57 -0500839 lockdep_assert_held(&kernfs_mutex);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500840
841 if (has_ns != (bool)ns) {
Tejun Heoc637b8a2013-12-11 14:11:58 -0500842 WARN(1, KERN_WARNING "kernfs: ns %s in '%s' for '%s'\n",
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500843 has_ns ? "required" : "invalid", parent->name, name);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500844 return NULL;
845 }
846
Tejun Heoc637b8a2013-12-11 14:11:58 -0500847 hash = kernfs_name_hash(name, ns);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500848 while (node) {
Tejun Heo324a56e2013-12-11 14:11:53 -0500849 struct kernfs_node *kn;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500850 int result;
851
Tejun Heo324a56e2013-12-11 14:11:53 -0500852 kn = rb_to_kn(node);
Tejun Heoc637b8a2013-12-11 14:11:58 -0500853 result = kernfs_name_compare(hash, name, ns, kn);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500854 if (result < 0)
855 node = node->rb_left;
856 else if (result > 0)
857 node = node->rb_right;
858 else
Tejun Heo324a56e2013-12-11 14:11:53 -0500859 return kn;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500860 }
861 return NULL;
862}
863
Tejun Heobd96f762015-11-20 15:55:52 -0500864static struct kernfs_node *kernfs_walk_ns(struct kernfs_node *parent,
865 const unsigned char *path,
866 const void *ns)
867{
Tejun Heoe56ed3582016-01-15 12:30:14 -0500868 size_t len;
869 char *p, *name;
Tejun Heobd96f762015-11-20 15:55:52 -0500870
871 lockdep_assert_held(&kernfs_mutex);
872
Tejun Heoe56ed3582016-01-15 12:30:14 -0500873 /* grab kernfs_rename_lock to piggy back on kernfs_pr_cont_buf */
874 spin_lock_irq(&kernfs_rename_lock);
875
876 len = strlcpy(kernfs_pr_cont_buf, path, sizeof(kernfs_pr_cont_buf));
877
878 if (len >= sizeof(kernfs_pr_cont_buf)) {
879 spin_unlock_irq(&kernfs_rename_lock);
Tejun Heobd96f762015-11-20 15:55:52 -0500880 return NULL;
Tejun Heoe56ed3582016-01-15 12:30:14 -0500881 }
882
883 p = kernfs_pr_cont_buf;
Tejun Heobd96f762015-11-20 15:55:52 -0500884
885 while ((name = strsep(&p, "/")) && parent) {
886 if (*name == '\0')
887 continue;
888 parent = kernfs_find_ns(parent, name, ns);
889 }
890
Tejun Heoe56ed3582016-01-15 12:30:14 -0500891 spin_unlock_irq(&kernfs_rename_lock);
892
Tejun Heobd96f762015-11-20 15:55:52 -0500893 return parent;
894}
895
Tejun Heofd7b9f72013-11-28 14:54:33 -0500896/**
Tejun Heo324a56e2013-12-11 14:11:53 -0500897 * kernfs_find_and_get_ns - find and get kernfs_node with the given name
898 * @parent: kernfs_node to search under
Tejun Heofd7b9f72013-11-28 14:54:33 -0500899 * @name: name to look for
900 * @ns: the namespace tag to use
901 *
Tejun Heo324a56e2013-12-11 14:11:53 -0500902 * Look for kernfs_node with name @name under @parent and get a reference
Tejun Heofd7b9f72013-11-28 14:54:33 -0500903 * if found. This function may sleep and returns pointer to the found
Tejun Heo324a56e2013-12-11 14:11:53 -0500904 * kernfs_node on success, %NULL on failure.
Tejun Heofd7b9f72013-11-28 14:54:33 -0500905 */
Tejun Heo324a56e2013-12-11 14:11:53 -0500906struct kernfs_node *kernfs_find_and_get_ns(struct kernfs_node *parent,
907 const char *name, const void *ns)
Tejun Heofd7b9f72013-11-28 14:54:33 -0500908{
Tejun Heo324a56e2013-12-11 14:11:53 -0500909 struct kernfs_node *kn;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500910
Tejun Heoa797bfc2013-12-11 14:11:57 -0500911 mutex_lock(&kernfs_mutex);
Tejun Heo324a56e2013-12-11 14:11:53 -0500912 kn = kernfs_find_ns(parent, name, ns);
913 kernfs_get(kn);
Tejun Heoa797bfc2013-12-11 14:11:57 -0500914 mutex_unlock(&kernfs_mutex);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500915
Tejun Heo324a56e2013-12-11 14:11:53 -0500916 return kn;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500917}
918EXPORT_SYMBOL_GPL(kernfs_find_and_get_ns);
919
920/**
Tejun Heobd96f762015-11-20 15:55:52 -0500921 * kernfs_walk_and_get_ns - find and get kernfs_node with the given path
922 * @parent: kernfs_node to search under
923 * @path: path to look for
924 * @ns: the namespace tag to use
925 *
926 * Look for kernfs_node with path @path under @parent and get a reference
927 * if found. This function may sleep and returns pointer to the found
928 * kernfs_node on success, %NULL on failure.
929 */
930struct kernfs_node *kernfs_walk_and_get_ns(struct kernfs_node *parent,
931 const char *path, const void *ns)
932{
933 struct kernfs_node *kn;
934
935 mutex_lock(&kernfs_mutex);
936 kn = kernfs_walk_ns(parent, path, ns);
937 kernfs_get(kn);
938 mutex_unlock(&kernfs_mutex);
939
940 return kn;
941}
942
943/**
Tejun Heoba7443b2013-11-28 14:54:40 -0500944 * kernfs_create_root - create a new kernfs hierarchy
Tejun Heo90c07c82014-02-03 14:09:09 -0500945 * @scops: optional syscall operations for the hierarchy
Tejun Heod35258e2014-02-03 14:09:12 -0500946 * @flags: KERNFS_ROOT_* flags
Tejun Heoba7443b2013-11-28 14:54:40 -0500947 * @priv: opaque data associated with the new directory
948 *
949 * Returns the root of the new hierarchy on success, ERR_PTR() value on
950 * failure.
951 */
Tejun Heo90c07c82014-02-03 14:09:09 -0500952struct kernfs_root *kernfs_create_root(struct kernfs_syscall_ops *scops,
Tejun Heod35258e2014-02-03 14:09:12 -0500953 unsigned int flags, void *priv)
Tejun Heoba7443b2013-11-28 14:54:40 -0500954{
955 struct kernfs_root *root;
Tejun Heo324a56e2013-12-11 14:11:53 -0500956 struct kernfs_node *kn;
Tejun Heoba7443b2013-11-28 14:54:40 -0500957
958 root = kzalloc(sizeof(*root), GFP_KERNEL);
959 if (!root)
960 return ERR_PTR(-ENOMEM);
961
Shaohua Li7d350792017-07-12 11:49:46 -0700962 idr_init(&root->ino_idr);
Tejun Heo7d568a82014-04-09 11:07:30 -0400963 INIT_LIST_HEAD(&root->supers);
Shaohua Li4a3ef682017-07-12 11:49:47 -0700964 root->next_generation = 1;
Tejun Heobc755552013-11-28 14:54:41 -0500965
Ondrej Mosnaceke19dfdc2019-02-22 15:57:18 +0100966 kn = __kernfs_new_node(root, NULL, "", S_IFDIR | S_IRUGO | S_IXUGO,
Dmitry Torokhov488dee92018-07-20 21:56:47 +0000967 GLOBAL_ROOT_UID, GLOBAL_ROOT_GID,
Tejun Heodb4aad22014-01-17 09:58:25 -0500968 KERNFS_DIR);
Tejun Heo324a56e2013-12-11 14:11:53 -0500969 if (!kn) {
Shaohua Li7d350792017-07-12 11:49:46 -0700970 idr_destroy(&root->ino_idr);
Tejun Heoba7443b2013-11-28 14:54:40 -0500971 kfree(root);
972 return ERR_PTR(-ENOMEM);
973 }
974
Tejun Heo324a56e2013-12-11 14:11:53 -0500975 kn->priv = priv;
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500976 kn->dir.root = root;
Tejun Heoba7443b2013-11-28 14:54:40 -0500977
Tejun Heo90c07c82014-02-03 14:09:09 -0500978 root->syscall_ops = scops;
Tejun Heod35258e2014-02-03 14:09:12 -0500979 root->flags = flags;
Tejun Heo324a56e2013-12-11 14:11:53 -0500980 root->kn = kn;
Tejun Heoabd54f02014-02-03 14:02:55 -0500981 init_waitqueue_head(&root->deactivate_waitq);
Tejun Heoba7443b2013-11-28 14:54:40 -0500982
Tejun Heod35258e2014-02-03 14:09:12 -0500983 if (!(root->flags & KERNFS_ROOT_CREATE_DEACTIVATED))
984 kernfs_activate(kn);
985
Tejun Heoba7443b2013-11-28 14:54:40 -0500986 return root;
987}
988
989/**
990 * kernfs_destroy_root - destroy a kernfs hierarchy
991 * @root: root of the hierarchy to destroy
992 *
993 * Destroy the hierarchy anchored at @root by removing all existing
994 * directories and destroying @root.
995 */
996void kernfs_destroy_root(struct kernfs_root *root)
997{
Tejun Heo324a56e2013-12-11 14:11:53 -0500998 kernfs_remove(root->kn); /* will also free @root */
Tejun Heoba7443b2013-11-28 14:54:40 -0500999}
1000
1001/**
Tejun Heofd7b9f72013-11-28 14:54:33 -05001002 * kernfs_create_dir_ns - create a directory
1003 * @parent: parent in which to create a new directory
1004 * @name: name of the new directory
Tejun Heobb8b9d02013-12-11 16:02:55 -05001005 * @mode: mode of the new directory
Dmitry Torokhov488dee92018-07-20 21:56:47 +00001006 * @uid: uid of the new directory
1007 * @gid: gid of the new directory
Tejun Heofd7b9f72013-11-28 14:54:33 -05001008 * @priv: opaque data associated with the new directory
1009 * @ns: optional namespace tag of the directory
1010 *
1011 * Returns the created node on success, ERR_PTR() value on failure.
1012 */
Tejun Heo324a56e2013-12-11 14:11:53 -05001013struct kernfs_node *kernfs_create_dir_ns(struct kernfs_node *parent,
Tejun Heobb8b9d02013-12-11 16:02:55 -05001014 const char *name, umode_t mode,
Dmitry Torokhov488dee92018-07-20 21:56:47 +00001015 kuid_t uid, kgid_t gid,
Tejun Heobb8b9d02013-12-11 16:02:55 -05001016 void *priv, const void *ns)
Tejun Heofd7b9f72013-11-28 14:54:33 -05001017{
Tejun Heo324a56e2013-12-11 14:11:53 -05001018 struct kernfs_node *kn;
Tejun Heofd7b9f72013-11-28 14:54:33 -05001019 int rc;
1020
1021 /* allocate */
Dmitry Torokhov488dee92018-07-20 21:56:47 +00001022 kn = kernfs_new_node(parent, name, mode | S_IFDIR,
1023 uid, gid, KERNFS_DIR);
Tejun Heo324a56e2013-12-11 14:11:53 -05001024 if (!kn)
Tejun Heofd7b9f72013-11-28 14:54:33 -05001025 return ERR_PTR(-ENOMEM);
1026
Tejun Heoadc5e8b2013-12-11 14:11:54 -05001027 kn->dir.root = parent->dir.root;
1028 kn->ns = ns;
Tejun Heo324a56e2013-12-11 14:11:53 -05001029 kn->priv = priv;
Tejun Heofd7b9f72013-11-28 14:54:33 -05001030
1031 /* link in */
Tejun Heo988cd7a2014-02-03 14:02:58 -05001032 rc = kernfs_add_one(kn);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001033 if (!rc)
Tejun Heo324a56e2013-12-11 14:11:53 -05001034 return kn;
Tejun Heofd7b9f72013-11-28 14:54:33 -05001035
Tejun Heo324a56e2013-12-11 14:11:53 -05001036 kernfs_put(kn);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001037 return ERR_PTR(rc);
1038}
1039
Eric W. Biedermanea015212015-05-13 16:09:29 -05001040/**
1041 * kernfs_create_empty_dir - create an always empty directory
1042 * @parent: parent in which to create a new directory
1043 * @name: name of the new directory
1044 *
1045 * Returns the created node on success, ERR_PTR() value on failure.
1046 */
1047struct kernfs_node *kernfs_create_empty_dir(struct kernfs_node *parent,
1048 const char *name)
1049{
1050 struct kernfs_node *kn;
1051 int rc;
1052
1053 /* allocate */
Dmitry Torokhov488dee92018-07-20 21:56:47 +00001054 kn = kernfs_new_node(parent, name, S_IRUGO|S_IXUGO|S_IFDIR,
1055 GLOBAL_ROOT_UID, GLOBAL_ROOT_GID, KERNFS_DIR);
Eric W. Biedermanea015212015-05-13 16:09:29 -05001056 if (!kn)
1057 return ERR_PTR(-ENOMEM);
1058
1059 kn->flags |= KERNFS_EMPTY_DIR;
1060 kn->dir.root = parent->dir.root;
1061 kn->ns = NULL;
1062 kn->priv = NULL;
1063
1064 /* link in */
1065 rc = kernfs_add_one(kn);
1066 if (!rc)
1067 return kn;
1068
1069 kernfs_put(kn);
1070 return ERR_PTR(rc);
1071}
1072
Tejun Heoc637b8a2013-12-11 14:11:58 -05001073static struct dentry *kernfs_iop_lookup(struct inode *dir,
1074 struct dentry *dentry,
1075 unsigned int flags)
Tejun Heofd7b9f72013-11-28 14:54:33 -05001076{
Tejun Heo19bbb922013-12-11 16:02:59 -05001077 struct dentry *ret;
Shaohua Li319ba912017-07-12 11:49:49 -07001078 struct kernfs_node *parent = dir->i_private;
Tejun Heo324a56e2013-12-11 14:11:53 -05001079 struct kernfs_node *kn;
Tejun Heofd7b9f72013-11-28 14:54:33 -05001080 struct inode *inode;
1081 const void *ns = NULL;
1082
Tejun Heoa797bfc2013-12-11 14:11:57 -05001083 mutex_lock(&kernfs_mutex);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001084
Tejun Heo324a56e2013-12-11 14:11:53 -05001085 if (kernfs_ns_enabled(parent))
Tejun Heoc525aad2013-12-11 14:11:55 -05001086 ns = kernfs_info(dir->i_sb)->ns;
Tejun Heofd7b9f72013-11-28 14:54:33 -05001087
Tejun Heo324a56e2013-12-11 14:11:53 -05001088 kn = kernfs_find_ns(parent, dentry->d_name.name, ns);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001089
1090 /* no such entry */
Tejun Heob9c9dad2014-02-03 14:09:11 -05001091 if (!kn || !kernfs_active(kn)) {
Tejun Heo19bbb922013-12-11 16:02:59 -05001092 ret = NULL;
Tejun Heofd7b9f72013-11-28 14:54:33 -05001093 goto out_unlock;
1094 }
Tejun Heofd7b9f72013-11-28 14:54:33 -05001095
1096 /* attach dentry and inode */
Tejun Heoc637b8a2013-12-11 14:11:58 -05001097 inode = kernfs_get_inode(dir->i_sb, kn);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001098 if (!inode) {
1099 ret = ERR_PTR(-ENOMEM);
1100 goto out_unlock;
1101 }
1102
1103 /* instantiate and hash dentry */
Al Viro41d28bc2014-10-12 22:24:21 -04001104 ret = d_splice_alias(inode, dentry);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001105 out_unlock:
Tejun Heoa797bfc2013-12-11 14:11:57 -05001106 mutex_unlock(&kernfs_mutex);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001107 return ret;
1108}
1109
Tejun Heo80b9bbe2013-12-11 16:03:00 -05001110static int kernfs_iop_mkdir(struct inode *dir, struct dentry *dentry,
1111 umode_t mode)
1112{
1113 struct kernfs_node *parent = dir->i_private;
Tejun Heo90c07c82014-02-03 14:09:09 -05001114 struct kernfs_syscall_ops *scops = kernfs_root(parent)->syscall_ops;
Tejun Heo07c75302014-02-03 14:09:08 -05001115 int ret;
Tejun Heo80b9bbe2013-12-11 16:03:00 -05001116
Tejun Heo90c07c82014-02-03 14:09:09 -05001117 if (!scops || !scops->mkdir)
Tejun Heo80b9bbe2013-12-11 16:03:00 -05001118 return -EPERM;
1119
Tejun Heo07c75302014-02-03 14:09:08 -05001120 if (!kernfs_get_active(parent))
1121 return -ENODEV;
1122
Tejun Heo90c07c82014-02-03 14:09:09 -05001123 ret = scops->mkdir(parent, dentry->d_name.name, mode);
Tejun Heo07c75302014-02-03 14:09:08 -05001124
1125 kernfs_put_active(parent);
1126 return ret;
Tejun Heo80b9bbe2013-12-11 16:03:00 -05001127}
1128
1129static int kernfs_iop_rmdir(struct inode *dir, struct dentry *dentry)
1130{
Shaohua Li319ba912017-07-12 11:49:49 -07001131 struct kernfs_node *kn = kernfs_dentry_node(dentry);
Tejun Heo90c07c82014-02-03 14:09:09 -05001132 struct kernfs_syscall_ops *scops = kernfs_root(kn)->syscall_ops;
Tejun Heo07c75302014-02-03 14:09:08 -05001133 int ret;
Tejun Heo80b9bbe2013-12-11 16:03:00 -05001134
Tejun Heo90c07c82014-02-03 14:09:09 -05001135 if (!scops || !scops->rmdir)
Tejun Heo80b9bbe2013-12-11 16:03:00 -05001136 return -EPERM;
1137
Tejun Heo07c75302014-02-03 14:09:08 -05001138 if (!kernfs_get_active(kn))
1139 return -ENODEV;
1140
Tejun Heo90c07c82014-02-03 14:09:09 -05001141 ret = scops->rmdir(kn);
Tejun Heo07c75302014-02-03 14:09:08 -05001142
1143 kernfs_put_active(kn);
1144 return ret;
Tejun Heo80b9bbe2013-12-11 16:03:00 -05001145}
1146
1147static int kernfs_iop_rename(struct inode *old_dir, struct dentry *old_dentry,
Miklos Szeredi1cd66c92016-09-27 11:03:58 +02001148 struct inode *new_dir, struct dentry *new_dentry,
1149 unsigned int flags)
Tejun Heo80b9bbe2013-12-11 16:03:00 -05001150{
Shaohua Li319ba912017-07-12 11:49:49 -07001151 struct kernfs_node *kn = kernfs_dentry_node(old_dentry);
Tejun Heo80b9bbe2013-12-11 16:03:00 -05001152 struct kernfs_node *new_parent = new_dir->i_private;
Tejun Heo90c07c82014-02-03 14:09:09 -05001153 struct kernfs_syscall_ops *scops = kernfs_root(kn)->syscall_ops;
Tejun Heo07c75302014-02-03 14:09:08 -05001154 int ret;
Tejun Heo80b9bbe2013-12-11 16:03:00 -05001155
Miklos Szeredi1cd66c92016-09-27 11:03:58 +02001156 if (flags)
1157 return -EINVAL;
1158
Tejun Heo90c07c82014-02-03 14:09:09 -05001159 if (!scops || !scops->rename)
Tejun Heo80b9bbe2013-12-11 16:03:00 -05001160 return -EPERM;
1161
Tejun Heo07c75302014-02-03 14:09:08 -05001162 if (!kernfs_get_active(kn))
1163 return -ENODEV;
1164
1165 if (!kernfs_get_active(new_parent)) {
1166 kernfs_put_active(kn);
1167 return -ENODEV;
1168 }
1169
Tejun Heo90c07c82014-02-03 14:09:09 -05001170 ret = scops->rename(kn, new_parent, new_dentry->d_name.name);
Tejun Heo07c75302014-02-03 14:09:08 -05001171
1172 kernfs_put_active(new_parent);
1173 kernfs_put_active(kn);
1174 return ret;
Tejun Heo80b9bbe2013-12-11 16:03:00 -05001175}
1176
Tejun Heoa797bfc2013-12-11 14:11:57 -05001177const struct inode_operations kernfs_dir_iops = {
Tejun Heoc637b8a2013-12-11 14:11:58 -05001178 .lookup = kernfs_iop_lookup,
1179 .permission = kernfs_iop_permission,
1180 .setattr = kernfs_iop_setattr,
1181 .getattr = kernfs_iop_getattr,
Tejun Heoc637b8a2013-12-11 14:11:58 -05001182 .listxattr = kernfs_iop_listxattr,
Tejun Heo80b9bbe2013-12-11 16:03:00 -05001183
1184 .mkdir = kernfs_iop_mkdir,
1185 .rmdir = kernfs_iop_rmdir,
1186 .rename = kernfs_iop_rename,
Tejun Heofd7b9f72013-11-28 14:54:33 -05001187};
1188
Tejun Heoc637b8a2013-12-11 14:11:58 -05001189static struct kernfs_node *kernfs_leftmost_descendant(struct kernfs_node *pos)
Tejun Heofd7b9f72013-11-28 14:54:33 -05001190{
Tejun Heo324a56e2013-12-11 14:11:53 -05001191 struct kernfs_node *last;
Tejun Heofd7b9f72013-11-28 14:54:33 -05001192
1193 while (true) {
1194 struct rb_node *rbn;
1195
1196 last = pos;
1197
Tejun Heodf23fc32013-12-11 14:11:56 -05001198 if (kernfs_type(pos) != KERNFS_DIR)
Tejun Heofd7b9f72013-11-28 14:54:33 -05001199 break;
1200
Tejun Heoadc5e8b2013-12-11 14:11:54 -05001201 rbn = rb_first(&pos->dir.children);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001202 if (!rbn)
1203 break;
1204
Tejun Heo324a56e2013-12-11 14:11:53 -05001205 pos = rb_to_kn(rbn);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001206 }
1207
1208 return last;
1209}
1210
1211/**
Tejun Heoc637b8a2013-12-11 14:11:58 -05001212 * kernfs_next_descendant_post - find the next descendant for post-order walk
Tejun Heofd7b9f72013-11-28 14:54:33 -05001213 * @pos: the current position (%NULL to initiate traversal)
Tejun Heo324a56e2013-12-11 14:11:53 -05001214 * @root: kernfs_node whose descendants to walk
Tejun Heofd7b9f72013-11-28 14:54:33 -05001215 *
1216 * Find the next descendant to visit for post-order traversal of @root's
1217 * descendants. @root is included in the iteration and the last node to be
1218 * visited.
1219 */
Tejun Heoc637b8a2013-12-11 14:11:58 -05001220static struct kernfs_node *kernfs_next_descendant_post(struct kernfs_node *pos,
1221 struct kernfs_node *root)
Tejun Heofd7b9f72013-11-28 14:54:33 -05001222{
1223 struct rb_node *rbn;
1224
Tejun Heoa797bfc2013-12-11 14:11:57 -05001225 lockdep_assert_held(&kernfs_mutex);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001226
1227 /* if first iteration, visit leftmost descendant which may be root */
1228 if (!pos)
Tejun Heoc637b8a2013-12-11 14:11:58 -05001229 return kernfs_leftmost_descendant(root);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001230
1231 /* if we visited @root, we're done */
1232 if (pos == root)
1233 return NULL;
1234
1235 /* if there's an unvisited sibling, visit its leftmost descendant */
Tejun Heoadc5e8b2013-12-11 14:11:54 -05001236 rbn = rb_next(&pos->rb);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001237 if (rbn)
Tejun Heoc637b8a2013-12-11 14:11:58 -05001238 return kernfs_leftmost_descendant(rb_to_kn(rbn));
Tejun Heofd7b9f72013-11-28 14:54:33 -05001239
1240 /* no sibling left, visit parent */
Tejun Heoadc5e8b2013-12-11 14:11:54 -05001241 return pos->parent;
Tejun Heofd7b9f72013-11-28 14:54:33 -05001242}
1243
Tejun Heod35258e2014-02-03 14:09:12 -05001244/**
1245 * kernfs_activate - activate a node which started deactivated
1246 * @kn: kernfs_node whose subtree is to be activated
1247 *
1248 * If the root has KERNFS_ROOT_CREATE_DEACTIVATED set, a newly created node
1249 * needs to be explicitly activated. A node which hasn't been activated
1250 * isn't visible to userland and deactivation is skipped during its
1251 * removal. This is useful to construct atomic init sequences where
1252 * creation of multiple nodes should either succeed or fail atomically.
1253 *
1254 * The caller is responsible for ensuring that this function is not called
1255 * after kernfs_remove*() is invoked on @kn.
1256 */
1257void kernfs_activate(struct kernfs_node *kn)
1258{
1259 struct kernfs_node *pos;
1260
1261 mutex_lock(&kernfs_mutex);
1262
1263 pos = NULL;
1264 while ((pos = kernfs_next_descendant_post(pos, kn))) {
1265 if (!pos || (pos->flags & KERNFS_ACTIVATED))
1266 continue;
1267
1268 WARN_ON_ONCE(pos->parent && RB_EMPTY_NODE(&pos->rb));
1269 WARN_ON_ONCE(atomic_read(&pos->active) != KN_DEACTIVATED_BIAS);
1270
1271 atomic_sub(KN_DEACTIVATED_BIAS, &pos->active);
1272 pos->flags |= KERNFS_ACTIVATED;
1273 }
1274
1275 mutex_unlock(&kernfs_mutex);
1276}
1277
Tejun Heo988cd7a2014-02-03 14:02:58 -05001278static void __kernfs_remove(struct kernfs_node *kn)
Tejun Heofd7b9f72013-11-28 14:54:33 -05001279{
Tejun Heo35beab02014-02-03 14:02:56 -05001280 struct kernfs_node *pos;
1281
1282 lockdep_assert_held(&kernfs_mutex);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001283
Tejun Heo6b0afc22014-02-03 14:03:01 -05001284 /*
1285 * Short-circuit if non-root @kn has already finished removal.
1286 * This is for kernfs_remove_self() which plays with active ref
1287 * after removal.
1288 */
1289 if (!kn || (kn->parent && RB_EMPTY_NODE(&kn->rb)))
Greg Kroah-Hartmance9b4992014-01-13 13:50:31 -08001290 return;
1291
Tejun Heoc637b8a2013-12-11 14:11:58 -05001292 pr_debug("kernfs %s: removing\n", kn->name);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001293
Tejun Heo81c173c2014-02-03 14:03:00 -05001294 /* prevent any new usage under @kn by deactivating all nodes */
Tejun Heo35beab02014-02-03 14:02:56 -05001295 pos = NULL;
1296 while ((pos = kernfs_next_descendant_post(pos, kn)))
Tejun Heo81c173c2014-02-03 14:03:00 -05001297 if (kernfs_active(pos))
1298 atomic_add(KN_DEACTIVATED_BIAS, &pos->active);
Tejun Heo35beab02014-02-03 14:02:56 -05001299
1300 /* deactivate and unlink the subtree node-by-node */
Tejun Heofd7b9f72013-11-28 14:54:33 -05001301 do {
Tejun Heo35beab02014-02-03 14:02:56 -05001302 pos = kernfs_leftmost_descendant(kn);
1303
1304 /*
Tejun Heo81c173c2014-02-03 14:03:00 -05001305 * kernfs_drain() drops kernfs_mutex temporarily and @pos's
1306 * base ref could have been put by someone else by the time
1307 * the function returns. Make sure it doesn't go away
1308 * underneath us.
Tejun Heo35beab02014-02-03 14:02:56 -05001309 */
1310 kernfs_get(pos);
1311
Tejun Heod35258e2014-02-03 14:09:12 -05001312 /*
1313 * Drain iff @kn was activated. This avoids draining and
1314 * its lockdep annotations for nodes which have never been
1315 * activated and allows embedding kernfs_remove() in create
1316 * error paths without worrying about draining.
1317 */
1318 if (kn->flags & KERNFS_ACTIVATED)
1319 kernfs_drain(pos);
1320 else
1321 WARN_ON_ONCE(atomic_read(&kn->active) != KN_DEACTIVATED_BIAS);
Tejun Heo35beab02014-02-03 14:02:56 -05001322
1323 /*
1324 * kernfs_unlink_sibling() succeeds once per node. Use it
1325 * to decide who's responsible for cleanups.
1326 */
1327 if (!pos->parent || kernfs_unlink_sibling(pos)) {
1328 struct kernfs_iattrs *ps_iattr =
1329 pos->parent ? pos->parent->iattr : NULL;
1330
1331 /* update timestamps on the parent */
1332 if (ps_iattr) {
Ondrej Mosnacek05895212019-02-22 15:57:12 +01001333 ktime_get_real_ts64(&ps_iattr->ia_ctime);
1334 ps_iattr->ia_mtime = ps_iattr->ia_ctime;
Tejun Heo35beab02014-02-03 14:02:56 -05001335 }
1336
Tejun Heo988cd7a2014-02-03 14:02:58 -05001337 kernfs_put(pos);
Tejun Heo35beab02014-02-03 14:02:56 -05001338 }
1339
1340 kernfs_put(pos);
1341 } while (pos != kn);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001342}
1343
1344/**
Tejun Heo324a56e2013-12-11 14:11:53 -05001345 * kernfs_remove - remove a kernfs_node recursively
1346 * @kn: the kernfs_node to remove
Tejun Heofd7b9f72013-11-28 14:54:33 -05001347 *
Tejun Heo324a56e2013-12-11 14:11:53 -05001348 * Remove @kn along with all its subdirectories and files.
Tejun Heofd7b9f72013-11-28 14:54:33 -05001349 */
Tejun Heo324a56e2013-12-11 14:11:53 -05001350void kernfs_remove(struct kernfs_node *kn)
Tejun Heofd7b9f72013-11-28 14:54:33 -05001351{
Tejun Heo988cd7a2014-02-03 14:02:58 -05001352 mutex_lock(&kernfs_mutex);
1353 __kernfs_remove(kn);
1354 mutex_unlock(&kernfs_mutex);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001355}
1356
1357/**
Tejun Heo6b0afc22014-02-03 14:03:01 -05001358 * kernfs_break_active_protection - break out of active protection
1359 * @kn: the self kernfs_node
1360 *
1361 * The caller must be running off of a kernfs operation which is invoked
1362 * with an active reference - e.g. one of kernfs_ops. Each invocation of
1363 * this function must also be matched with an invocation of
1364 * kernfs_unbreak_active_protection().
1365 *
1366 * This function releases the active reference of @kn the caller is
1367 * holding. Once this function is called, @kn may be removed at any point
1368 * and the caller is solely responsible for ensuring that the objects it
1369 * dereferences are accessible.
1370 */
1371void kernfs_break_active_protection(struct kernfs_node *kn)
1372{
1373 /*
1374 * Take out ourself out of the active ref dependency chain. If
1375 * we're called without an active ref, lockdep will complain.
1376 */
1377 kernfs_put_active(kn);
1378}
1379
1380/**
1381 * kernfs_unbreak_active_protection - undo kernfs_break_active_protection()
1382 * @kn: the self kernfs_node
1383 *
1384 * If kernfs_break_active_protection() was called, this function must be
1385 * invoked before finishing the kernfs operation. Note that while this
1386 * function restores the active reference, it doesn't and can't actually
1387 * restore the active protection - @kn may already or be in the process of
1388 * being removed. Once kernfs_break_active_protection() is invoked, that
1389 * protection is irreversibly gone for the kernfs operation instance.
1390 *
1391 * While this function may be called at any point after
1392 * kernfs_break_active_protection() is invoked, its most useful location
1393 * would be right before the enclosing kernfs operation returns.
1394 */
1395void kernfs_unbreak_active_protection(struct kernfs_node *kn)
1396{
1397 /*
1398 * @kn->active could be in any state; however, the increment we do
1399 * here will be undone as soon as the enclosing kernfs operation
1400 * finishes and this temporary bump can't break anything. If @kn
1401 * is alive, nothing changes. If @kn is being deactivated, the
1402 * soon-to-follow put will either finish deactivation or restore
1403 * deactivated state. If @kn is already removed, the temporary
1404 * bump is guaranteed to be gone before @kn is released.
1405 */
1406 atomic_inc(&kn->active);
1407 if (kernfs_lockdep(kn))
1408 rwsem_acquire(&kn->dep_map, 0, 1, _RET_IP_);
1409}
1410
1411/**
1412 * kernfs_remove_self - remove a kernfs_node from its own method
1413 * @kn: the self kernfs_node to remove
1414 *
1415 * The caller must be running off of a kernfs operation which is invoked
1416 * with an active reference - e.g. one of kernfs_ops. This can be used to
1417 * implement a file operation which deletes itself.
1418 *
1419 * For example, the "delete" file for a sysfs device directory can be
1420 * implemented by invoking kernfs_remove_self() on the "delete" file
1421 * itself. This function breaks the circular dependency of trying to
1422 * deactivate self while holding an active ref itself. It isn't necessary
1423 * to modify the usual removal path to use kernfs_remove_self(). The
1424 * "delete" implementation can simply invoke kernfs_remove_self() on self
1425 * before proceeding with the usual removal path. kernfs will ignore later
1426 * kernfs_remove() on self.
1427 *
1428 * kernfs_remove_self() can be called multiple times concurrently on the
1429 * same kernfs_node. Only the first one actually performs removal and
1430 * returns %true. All others will wait until the kernfs operation which
1431 * won self-removal finishes and return %false. Note that the losers wait
1432 * for the completion of not only the winning kernfs_remove_self() but also
1433 * the whole kernfs_ops which won the arbitration. This can be used to
1434 * guarantee, for example, all concurrent writes to a "delete" file to
1435 * finish only after the whole operation is complete.
1436 */
1437bool kernfs_remove_self(struct kernfs_node *kn)
1438{
1439 bool ret;
1440
1441 mutex_lock(&kernfs_mutex);
1442 kernfs_break_active_protection(kn);
1443
1444 /*
1445 * SUICIDAL is used to arbitrate among competing invocations. Only
1446 * the first one will actually perform removal. When the removal
1447 * is complete, SUICIDED is set and the active ref is restored
1448 * while holding kernfs_mutex. The ones which lost arbitration
1449 * waits for SUICDED && drained which can happen only after the
1450 * enclosing kernfs operation which executed the winning instance
1451 * of kernfs_remove_self() finished.
1452 */
1453 if (!(kn->flags & KERNFS_SUICIDAL)) {
1454 kn->flags |= KERNFS_SUICIDAL;
1455 __kernfs_remove(kn);
1456 kn->flags |= KERNFS_SUICIDED;
1457 ret = true;
1458 } else {
1459 wait_queue_head_t *waitq = &kernfs_root(kn)->deactivate_waitq;
1460 DEFINE_WAIT(wait);
1461
1462 while (true) {
1463 prepare_to_wait(waitq, &wait, TASK_UNINTERRUPTIBLE);
1464
1465 if ((kn->flags & KERNFS_SUICIDED) &&
1466 atomic_read(&kn->active) == KN_DEACTIVATED_BIAS)
1467 break;
1468
1469 mutex_unlock(&kernfs_mutex);
1470 schedule();
1471 mutex_lock(&kernfs_mutex);
1472 }
1473 finish_wait(waitq, &wait);
1474 WARN_ON_ONCE(!RB_EMPTY_NODE(&kn->rb));
1475 ret = false;
1476 }
1477
1478 /*
1479 * This must be done while holding kernfs_mutex; otherwise, waiting
1480 * for SUICIDED && deactivated could finish prematurely.
1481 */
1482 kernfs_unbreak_active_protection(kn);
1483
1484 mutex_unlock(&kernfs_mutex);
1485 return ret;
1486}
1487
1488/**
Tejun Heo324a56e2013-12-11 14:11:53 -05001489 * kernfs_remove_by_name_ns - find a kernfs_node by name and remove it
1490 * @parent: parent of the target
1491 * @name: name of the kernfs_node to remove
1492 * @ns: namespace tag of the kernfs_node to remove
Tejun Heofd7b9f72013-11-28 14:54:33 -05001493 *
Tejun Heo324a56e2013-12-11 14:11:53 -05001494 * Look for the kernfs_node with @name and @ns under @parent and remove it.
1495 * Returns 0 on success, -ENOENT if such entry doesn't exist.
Tejun Heofd7b9f72013-11-28 14:54:33 -05001496 */
Tejun Heo324a56e2013-12-11 14:11:53 -05001497int kernfs_remove_by_name_ns(struct kernfs_node *parent, const char *name,
Tejun Heofd7b9f72013-11-28 14:54:33 -05001498 const void *ns)
1499{
Tejun Heo324a56e2013-12-11 14:11:53 -05001500 struct kernfs_node *kn;
Tejun Heofd7b9f72013-11-28 14:54:33 -05001501
Tejun Heo324a56e2013-12-11 14:11:53 -05001502 if (!parent) {
Tejun Heoc637b8a2013-12-11 14:11:58 -05001503 WARN(1, KERN_WARNING "kernfs: can not remove '%s', no directory\n",
Tejun Heofd7b9f72013-11-28 14:54:33 -05001504 name);
1505 return -ENOENT;
1506 }
1507
Tejun Heo988cd7a2014-02-03 14:02:58 -05001508 mutex_lock(&kernfs_mutex);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001509
Tejun Heo324a56e2013-12-11 14:11:53 -05001510 kn = kernfs_find_ns(parent, name, ns);
1511 if (kn)
Tejun Heo988cd7a2014-02-03 14:02:58 -05001512 __kernfs_remove(kn);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001513
Tejun Heo988cd7a2014-02-03 14:02:58 -05001514 mutex_unlock(&kernfs_mutex);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001515
Tejun Heo324a56e2013-12-11 14:11:53 -05001516 if (kn)
Tejun Heofd7b9f72013-11-28 14:54:33 -05001517 return 0;
1518 else
1519 return -ENOENT;
1520}
1521
1522/**
1523 * kernfs_rename_ns - move and rename a kernfs_node
Tejun Heo324a56e2013-12-11 14:11:53 -05001524 * @kn: target node
Tejun Heofd7b9f72013-11-28 14:54:33 -05001525 * @new_parent: new parent to put @sd under
1526 * @new_name: new name
1527 * @new_ns: new namespace tag
1528 */
Tejun Heo324a56e2013-12-11 14:11:53 -05001529int kernfs_rename_ns(struct kernfs_node *kn, struct kernfs_node *new_parent,
Tejun Heofd7b9f72013-11-28 14:54:33 -05001530 const char *new_name, const void *new_ns)
1531{
Tejun Heo3eef34a2014-02-07 13:32:07 -05001532 struct kernfs_node *old_parent;
1533 const char *old_name = NULL;
Tejun Heofd7b9f72013-11-28 14:54:33 -05001534 int error;
1535
Tejun Heo3eef34a2014-02-07 13:32:07 -05001536 /* can't move or rename root */
1537 if (!kn->parent)
1538 return -EINVAL;
1539
Tejun Heoae343722014-01-10 08:57:21 -05001540 mutex_lock(&kernfs_mutex);
Tejun Heod0ae3d42013-12-11 16:02:56 -05001541
Greg Kroah-Hartman798c75a2014-01-13 14:36:03 -08001542 error = -ENOENT;
Eric W. Biedermanea015212015-05-13 16:09:29 -05001543 if (!kernfs_active(kn) || !kernfs_active(new_parent) ||
1544 (new_parent->flags & KERNFS_EMPTY_DIR))
Greg Kroah-Hartman798c75a2014-01-13 14:36:03 -08001545 goto out;
1546
Tejun Heofd7b9f72013-11-28 14:54:33 -05001547 error = 0;
Tejun Heoadc5e8b2013-12-11 14:11:54 -05001548 if ((kn->parent == new_parent) && (kn->ns == new_ns) &&
1549 (strcmp(kn->name, new_name) == 0))
Greg Kroah-Hartman798c75a2014-01-13 14:36:03 -08001550 goto out; /* nothing to rename */
Tejun Heofd7b9f72013-11-28 14:54:33 -05001551
1552 error = -EEXIST;
1553 if (kernfs_find_ns(new_parent, new_name, new_ns))
Greg Kroah-Hartman798c75a2014-01-13 14:36:03 -08001554 goto out;
Tejun Heofd7b9f72013-11-28 14:54:33 -05001555
Tejun Heo324a56e2013-12-11 14:11:53 -05001556 /* rename kernfs_node */
Tejun Heoadc5e8b2013-12-11 14:11:54 -05001557 if (strcmp(kn->name, new_name) != 0) {
Tejun Heofd7b9f72013-11-28 14:54:33 -05001558 error = -ENOMEM;
Andrzej Hajda75287a62015-02-13 14:36:27 -08001559 new_name = kstrdup_const(new_name, GFP_KERNEL);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001560 if (!new_name)
Greg Kroah-Hartman798c75a2014-01-13 14:36:03 -08001561 goto out;
Tejun Heo3eef34a2014-02-07 13:32:07 -05001562 } else {
1563 new_name = NULL;
Tejun Heofd7b9f72013-11-28 14:54:33 -05001564 }
1565
1566 /*
1567 * Move to the appropriate place in the appropriate directories rbtree.
1568 */
Tejun Heoc637b8a2013-12-11 14:11:58 -05001569 kernfs_unlink_sibling(kn);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001570 kernfs_get(new_parent);
Tejun Heo3eef34a2014-02-07 13:32:07 -05001571
1572 /* rename_lock protects ->parent and ->name accessors */
1573 spin_lock_irq(&kernfs_rename_lock);
1574
1575 old_parent = kn->parent;
Tejun Heoadc5e8b2013-12-11 14:11:54 -05001576 kn->parent = new_parent;
Tejun Heo3eef34a2014-02-07 13:32:07 -05001577
1578 kn->ns = new_ns;
1579 if (new_name) {
Tejun Heodfeb07502015-02-13 14:36:31 -08001580 old_name = kn->name;
Tejun Heo3eef34a2014-02-07 13:32:07 -05001581 kn->name = new_name;
1582 }
1583
1584 spin_unlock_irq(&kernfs_rename_lock);
1585
Tejun Heo9561a892014-02-10 17:57:09 -05001586 kn->hash = kernfs_name_hash(kn->name, kn->ns);
Tejun Heoc637b8a2013-12-11 14:11:58 -05001587 kernfs_link_sibling(kn);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001588
Tejun Heo3eef34a2014-02-07 13:32:07 -05001589 kernfs_put(old_parent);
Andrzej Hajda75287a62015-02-13 14:36:27 -08001590 kfree_const(old_name);
Tejun Heo3eef34a2014-02-07 13:32:07 -05001591
Tejun Heofd7b9f72013-11-28 14:54:33 -05001592 error = 0;
Greg Kroah-Hartman798c75a2014-01-13 14:36:03 -08001593 out:
Tejun Heoa797bfc2013-12-11 14:11:57 -05001594 mutex_unlock(&kernfs_mutex);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001595 return error;
1596}
1597
Tejun Heofd7b9f72013-11-28 14:54:33 -05001598/* Relationship between s_mode and the DT_xxx types */
Tejun Heo324a56e2013-12-11 14:11:53 -05001599static inline unsigned char dt_type(struct kernfs_node *kn)
Tejun Heofd7b9f72013-11-28 14:54:33 -05001600{
Tejun Heoadc5e8b2013-12-11 14:11:54 -05001601 return (kn->mode >> 12) & 15;
Tejun Heofd7b9f72013-11-28 14:54:33 -05001602}
1603
Tejun Heoc637b8a2013-12-11 14:11:58 -05001604static int kernfs_dir_fop_release(struct inode *inode, struct file *filp)
Tejun Heofd7b9f72013-11-28 14:54:33 -05001605{
1606 kernfs_put(filp->private_data);
1607 return 0;
1608}
1609
Tejun Heoc637b8a2013-12-11 14:11:58 -05001610static struct kernfs_node *kernfs_dir_pos(const void *ns,
Tejun Heo324a56e2013-12-11 14:11:53 -05001611 struct kernfs_node *parent, loff_t hash, struct kernfs_node *pos)
Tejun Heofd7b9f72013-11-28 14:54:33 -05001612{
1613 if (pos) {
Tejun Heo81c173c2014-02-03 14:03:00 -05001614 int valid = kernfs_active(pos) &&
Greg Kroah-Hartman798c75a2014-01-13 14:36:03 -08001615 pos->parent == parent && hash == pos->hash;
Tejun Heofd7b9f72013-11-28 14:54:33 -05001616 kernfs_put(pos);
1617 if (!valid)
1618 pos = NULL;
1619 }
1620 if (!pos && (hash > 1) && (hash < INT_MAX)) {
Tejun Heoadc5e8b2013-12-11 14:11:54 -05001621 struct rb_node *node = parent->dir.children.rb_node;
Tejun Heofd7b9f72013-11-28 14:54:33 -05001622 while (node) {
Tejun Heo324a56e2013-12-11 14:11:53 -05001623 pos = rb_to_kn(node);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001624
Tejun Heoadc5e8b2013-12-11 14:11:54 -05001625 if (hash < pos->hash)
Tejun Heofd7b9f72013-11-28 14:54:33 -05001626 node = node->rb_left;
Tejun Heoadc5e8b2013-12-11 14:11:54 -05001627 else if (hash > pos->hash)
Tejun Heofd7b9f72013-11-28 14:54:33 -05001628 node = node->rb_right;
1629 else
1630 break;
1631 }
1632 }
Tejun Heob9c9dad2014-02-03 14:09:11 -05001633 /* Skip over entries which are dying/dead or in the wrong namespace */
1634 while (pos && (!kernfs_active(pos) || pos->ns != ns)) {
Tejun Heoadc5e8b2013-12-11 14:11:54 -05001635 struct rb_node *node = rb_next(&pos->rb);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001636 if (!node)
1637 pos = NULL;
1638 else
Tejun Heo324a56e2013-12-11 14:11:53 -05001639 pos = rb_to_kn(node);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001640 }
1641 return pos;
1642}
1643
Tejun Heoc637b8a2013-12-11 14:11:58 -05001644static struct kernfs_node *kernfs_dir_next_pos(const void *ns,
Tejun Heo324a56e2013-12-11 14:11:53 -05001645 struct kernfs_node *parent, ino_t ino, struct kernfs_node *pos)
Tejun Heofd7b9f72013-11-28 14:54:33 -05001646{
Tejun Heoc637b8a2013-12-11 14:11:58 -05001647 pos = kernfs_dir_pos(ns, parent, ino, pos);
Tejun Heob9c9dad2014-02-03 14:09:11 -05001648 if (pos) {
Tejun Heofd7b9f72013-11-28 14:54:33 -05001649 do {
Tejun Heoadc5e8b2013-12-11 14:11:54 -05001650 struct rb_node *node = rb_next(&pos->rb);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001651 if (!node)
1652 pos = NULL;
1653 else
Tejun Heo324a56e2013-12-11 14:11:53 -05001654 pos = rb_to_kn(node);
Tejun Heob9c9dad2014-02-03 14:09:11 -05001655 } while (pos && (!kernfs_active(pos) || pos->ns != ns));
1656 }
Tejun Heofd7b9f72013-11-28 14:54:33 -05001657 return pos;
1658}
1659
Tejun Heoc637b8a2013-12-11 14:11:58 -05001660static int kernfs_fop_readdir(struct file *file, struct dir_context *ctx)
Tejun Heofd7b9f72013-11-28 14:54:33 -05001661{
1662 struct dentry *dentry = file->f_path.dentry;
Shaohua Li319ba912017-07-12 11:49:49 -07001663 struct kernfs_node *parent = kernfs_dentry_node(dentry);
Tejun Heo324a56e2013-12-11 14:11:53 -05001664 struct kernfs_node *pos = file->private_data;
Tejun Heofd7b9f72013-11-28 14:54:33 -05001665 const void *ns = NULL;
1666
1667 if (!dir_emit_dots(file, ctx))
1668 return 0;
Tejun Heoa797bfc2013-12-11 14:11:57 -05001669 mutex_lock(&kernfs_mutex);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001670
Tejun Heo324a56e2013-12-11 14:11:53 -05001671 if (kernfs_ns_enabled(parent))
Tejun Heoc525aad2013-12-11 14:11:55 -05001672 ns = kernfs_info(dentry->d_sb)->ns;
Tejun Heofd7b9f72013-11-28 14:54:33 -05001673
Tejun Heoc637b8a2013-12-11 14:11:58 -05001674 for (pos = kernfs_dir_pos(ns, parent, ctx->pos, pos);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001675 pos;
Tejun Heoc637b8a2013-12-11 14:11:58 -05001676 pos = kernfs_dir_next_pos(ns, parent, ctx->pos, pos)) {
Tejun Heoadc5e8b2013-12-11 14:11:54 -05001677 const char *name = pos->name;
Tejun Heofd7b9f72013-11-28 14:54:33 -05001678 unsigned int type = dt_type(pos);
1679 int len = strlen(name);
Shaohua Lic53cd492017-07-12 11:49:50 -07001680 ino_t ino = pos->id.ino;
Tejun Heofd7b9f72013-11-28 14:54:33 -05001681
Tejun Heoadc5e8b2013-12-11 14:11:54 -05001682 ctx->pos = pos->hash;
Tejun Heofd7b9f72013-11-28 14:54:33 -05001683 file->private_data = pos;
1684 kernfs_get(pos);
1685
Tejun Heoa797bfc2013-12-11 14:11:57 -05001686 mutex_unlock(&kernfs_mutex);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001687 if (!dir_emit(ctx, name, len, ino, type))
1688 return 0;
Tejun Heoa797bfc2013-12-11 14:11:57 -05001689 mutex_lock(&kernfs_mutex);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001690 }
Tejun Heoa797bfc2013-12-11 14:11:57 -05001691 mutex_unlock(&kernfs_mutex);
Tejun Heofd7b9f72013-11-28 14:54:33 -05001692 file->private_data = NULL;
1693 ctx->pos = INT_MAX;
1694 return 0;
1695}
1696
Tejun Heoa797bfc2013-12-11 14:11:57 -05001697const struct file_operations kernfs_dir_fops = {
Tejun Heofd7b9f72013-11-28 14:54:33 -05001698 .read = generic_read_dir,
Al Viro8cb0d2c2016-04-20 19:59:01 -04001699 .iterate_shared = kernfs_fop_readdir,
Tejun Heoc637b8a2013-12-11 14:11:58 -05001700 .release = kernfs_dir_fop_release,
Al Viro8cb0d2c2016-04-20 19:59:01 -04001701 .llseek = generic_file_llseek,
Tejun Heofd7b9f72013-11-28 14:54:33 -05001702};