blob: 70186e2e692a5b7134e00d34bb085a3bc8811df5 [file] [log] [blame]
Tejun Heob8441ed2013-11-24 09:54:58 -05001/*
2 * fs/kernfs/file.c - kernfs file implementation
3 *
4 * Copyright (c) 2001-3 Patrick Mochel
5 * Copyright (c) 2007 SUSE Linux Products GmbH
6 * Copyright (c) 2007, 2013 Tejun Heo <tj@kernel.org>
7 *
8 * This file is released under the GPLv2.
9 */
Tejun Heo414985a2013-11-28 14:54:34 -050010
11#include <linux/fs.h>
12#include <linux/seq_file.h>
13#include <linux/slab.h>
14#include <linux/poll.h>
15#include <linux/pagemap.h>
Tejun Heo414985a2013-11-28 14:54:34 -050016#include <linux/sched.h>
Tejun Heod911d982014-04-09 11:07:31 -040017#include <linux/fsnotify.h>
Tejun Heo414985a2013-11-28 14:54:34 -050018
19#include "kernfs-internal.h"
20
21/*
Tejun Heoc525aad2013-12-11 14:11:55 -050022 * There's one kernfs_open_file for each open file and one kernfs_open_node
Tejun Heo324a56e2013-12-11 14:11:53 -050023 * for each kernfs_node with one or more open files.
Tejun Heo414985a2013-11-28 14:54:34 -050024 *
Tejun Heoc525aad2013-12-11 14:11:55 -050025 * kernfs_node->attr.open points to kernfs_open_node. attr.open is
26 * protected by kernfs_open_node_lock.
Tejun Heo414985a2013-11-28 14:54:34 -050027 *
28 * filp->private_data points to seq_file whose ->private points to
Tejun Heoc525aad2013-12-11 14:11:55 -050029 * kernfs_open_file. kernfs_open_files are chained at
30 * kernfs_open_node->files, which is protected by kernfs_open_file_mutex.
Tejun Heo414985a2013-11-28 14:54:34 -050031 */
Tejun Heoc525aad2013-12-11 14:11:55 -050032static DEFINE_SPINLOCK(kernfs_open_node_lock);
33static DEFINE_MUTEX(kernfs_open_file_mutex);
Tejun Heo414985a2013-11-28 14:54:34 -050034
Tejun Heoc525aad2013-12-11 14:11:55 -050035struct kernfs_open_node {
Tejun Heo414985a2013-11-28 14:54:34 -050036 atomic_t refcnt;
37 atomic_t event;
38 wait_queue_head_t poll;
Tejun Heoc525aad2013-12-11 14:11:55 -050039 struct list_head files; /* goes through kernfs_open_file.list */
Tejun Heo414985a2013-11-28 14:54:34 -050040};
41
Tejun Heoecca47c2014-07-01 16:41:03 -040042/*
43 * kernfs_notify() may be called from any context and bounces notifications
44 * through a work item. To minimize space overhead in kernfs_node, the
45 * pending queue is implemented as a singly linked list of kernfs_nodes.
46 * The list is terminated with the self pointer so that whether a
47 * kernfs_node is on the list or not can be determined by testing the next
48 * pointer for NULL.
49 */
50#define KERNFS_NOTIFY_EOL ((void *)&kernfs_notify_list)
51
52static DEFINE_SPINLOCK(kernfs_notify_lock);
53static struct kernfs_node *kernfs_notify_list = KERNFS_NOTIFY_EOL;
54
Tejun Heoc525aad2013-12-11 14:11:55 -050055static struct kernfs_open_file *kernfs_of(struct file *file)
Tejun Heo414985a2013-11-28 14:54:34 -050056{
57 return ((struct seq_file *)file->private_data)->private;
58}
59
60/*
Tejun Heo324a56e2013-12-11 14:11:53 -050061 * Determine the kernfs_ops for the given kernfs_node. This function must
Tejun Heo414985a2013-11-28 14:54:34 -050062 * be called while holding an active reference.
63 */
Tejun Heo324a56e2013-12-11 14:11:53 -050064static const struct kernfs_ops *kernfs_ops(struct kernfs_node *kn)
Tejun Heo414985a2013-11-28 14:54:34 -050065{
Tejun Heodf23fc32013-12-11 14:11:56 -050066 if (kn->flags & KERNFS_LOCKDEP)
Tejun Heo324a56e2013-12-11 14:11:53 -050067 lockdep_assert_held(kn);
Tejun Heoadc5e8b2013-12-11 14:11:54 -050068 return kn->attr.ops;
Tejun Heo414985a2013-11-28 14:54:34 -050069}
70
Tejun Heobb305942014-01-14 09:52:01 -050071/*
72 * As kernfs_seq_stop() is also called after kernfs_seq_start() or
73 * kernfs_seq_next() failure, it needs to distinguish whether it's stopping
74 * a seq_file iteration which is fully initialized with an active reference
75 * or an aborted kernfs_seq_start() due to get_active failure. The
76 * position pointer is the only context for each seq_file iteration and
77 * thus the stop condition should be encoded in it. As the return value is
78 * directly visible to userland, ERR_PTR(-ENODEV) is the only acceptable
79 * choice to indicate get_active failure.
80 *
81 * Unfortunately, this is complicated due to the optional custom seq_file
82 * operations which may return ERR_PTR(-ENODEV) too. kernfs_seq_stop()
83 * can't distinguish whether ERR_PTR(-ENODEV) is from get_active failure or
84 * custom seq_file operations and thus can't decide whether put_active
85 * should be performed or not only on ERR_PTR(-ENODEV).
86 *
87 * This is worked around by factoring out the custom seq_stop() and
88 * put_active part into kernfs_seq_stop_active(), skipping it from
89 * kernfs_seq_stop() if ERR_PTR(-ENODEV) while invoking it directly after
90 * custom seq_file operations fail with ERR_PTR(-ENODEV) - this ensures
91 * that kernfs_seq_stop_active() is skipped only after get_active failure.
92 */
93static void kernfs_seq_stop_active(struct seq_file *sf, void *v)
94{
95 struct kernfs_open_file *of = sf->private;
96 const struct kernfs_ops *ops = kernfs_ops(of->kn);
97
98 if (ops->seq_stop)
99 ops->seq_stop(sf, v);
100 kernfs_put_active(of->kn);
101}
102
Tejun Heo414985a2013-11-28 14:54:34 -0500103static void *kernfs_seq_start(struct seq_file *sf, loff_t *ppos)
104{
Tejun Heoc525aad2013-12-11 14:11:55 -0500105 struct kernfs_open_file *of = sf->private;
Tejun Heo414985a2013-11-28 14:54:34 -0500106 const struct kernfs_ops *ops;
107
108 /*
NeilBrown2b758692014-10-13 16:41:28 +1100109 * @of->mutex nests outside active ref and is primarily to ensure that
Tejun Heo414985a2013-11-28 14:54:34 -0500110 * the ops aren't called concurrently for the same open file.
111 */
112 mutex_lock(&of->mutex);
Tejun Heoc637b8a2013-12-11 14:11:58 -0500113 if (!kernfs_get_active(of->kn))
Tejun Heo414985a2013-11-28 14:54:34 -0500114 return ERR_PTR(-ENODEV);
115
Tejun Heo324a56e2013-12-11 14:11:53 -0500116 ops = kernfs_ops(of->kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500117 if (ops->seq_start) {
Tejun Heobb305942014-01-14 09:52:01 -0500118 void *next = ops->seq_start(sf, ppos);
119 /* see the comment above kernfs_seq_stop_active() */
120 if (next == ERR_PTR(-ENODEV))
121 kernfs_seq_stop_active(sf, next);
122 return next;
Tejun Heo414985a2013-11-28 14:54:34 -0500123 } else {
124 /*
125 * The same behavior and code as single_open(). Returns
126 * !NULL if pos is at the beginning; otherwise, NULL.
127 */
128 return NULL + !*ppos;
129 }
130}
131
132static void *kernfs_seq_next(struct seq_file *sf, void *v, loff_t *ppos)
133{
Tejun Heoc525aad2013-12-11 14:11:55 -0500134 struct kernfs_open_file *of = sf->private;
Tejun Heo324a56e2013-12-11 14:11:53 -0500135 const struct kernfs_ops *ops = kernfs_ops(of->kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500136
137 if (ops->seq_next) {
Tejun Heobb305942014-01-14 09:52:01 -0500138 void *next = ops->seq_next(sf, v, ppos);
139 /* see the comment above kernfs_seq_stop_active() */
140 if (next == ERR_PTR(-ENODEV))
141 kernfs_seq_stop_active(sf, next);
142 return next;
Tejun Heo414985a2013-11-28 14:54:34 -0500143 } else {
144 /*
145 * The same behavior and code as single_open(), always
146 * terminate after the initial read.
147 */
148 ++*ppos;
149 return NULL;
150 }
151}
152
153static void kernfs_seq_stop(struct seq_file *sf, void *v)
154{
Tejun Heoc525aad2013-12-11 14:11:55 -0500155 struct kernfs_open_file *of = sf->private;
Tejun Heo414985a2013-11-28 14:54:34 -0500156
Tejun Heobb305942014-01-14 09:52:01 -0500157 if (v != ERR_PTR(-ENODEV))
158 kernfs_seq_stop_active(sf, v);
Tejun Heo414985a2013-11-28 14:54:34 -0500159 mutex_unlock(&of->mutex);
160}
161
162static int kernfs_seq_show(struct seq_file *sf, void *v)
163{
Tejun Heoc525aad2013-12-11 14:11:55 -0500164 struct kernfs_open_file *of = sf->private;
Tejun Heo414985a2013-11-28 14:54:34 -0500165
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500166 of->event = atomic_read(&of->kn->attr.open->event);
Tejun Heo414985a2013-11-28 14:54:34 -0500167
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500168 return of->kn->attr.ops->seq_show(sf, v);
Tejun Heo414985a2013-11-28 14:54:34 -0500169}
170
171static const struct seq_operations kernfs_seq_ops = {
172 .start = kernfs_seq_start,
173 .next = kernfs_seq_next,
174 .stop = kernfs_seq_stop,
175 .show = kernfs_seq_show,
176};
177
178/*
179 * As reading a bin file can have side-effects, the exact offset and bytes
180 * specified in read(2) call should be passed to the read callback making
181 * it difficult to use seq_file. Implement simplistic custom buffering for
182 * bin files.
183 */
Tejun Heoc525aad2013-12-11 14:11:55 -0500184static ssize_t kernfs_file_direct_read(struct kernfs_open_file *of,
Tejun Heo414985a2013-11-28 14:54:34 -0500185 char __user *user_buf, size_t count,
186 loff_t *ppos)
187{
188 ssize_t len = min_t(size_t, count, PAGE_SIZE);
189 const struct kernfs_ops *ops;
190 char *buf;
191
192 buf = kmalloc(len, GFP_KERNEL);
193 if (!buf)
194 return -ENOMEM;
195
196 /*
NeilBrown2b758692014-10-13 16:41:28 +1100197 * @of->mutex nests outside active ref and is primarily to ensure that
Tejun Heo414985a2013-11-28 14:54:34 -0500198 * the ops aren't called concurrently for the same open file.
199 */
200 mutex_lock(&of->mutex);
Tejun Heoc637b8a2013-12-11 14:11:58 -0500201 if (!kernfs_get_active(of->kn)) {
Tejun Heo414985a2013-11-28 14:54:34 -0500202 len = -ENODEV;
203 mutex_unlock(&of->mutex);
204 goto out_free;
205 }
206
Tejun Heo324a56e2013-12-11 14:11:53 -0500207 ops = kernfs_ops(of->kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500208 if (ops->read)
209 len = ops->read(of, buf, len, *ppos);
210 else
211 len = -EINVAL;
212
Tejun Heoc637b8a2013-12-11 14:11:58 -0500213 kernfs_put_active(of->kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500214 mutex_unlock(&of->mutex);
215
216 if (len < 0)
217 goto out_free;
218
219 if (copy_to_user(user_buf, buf, len)) {
220 len = -EFAULT;
221 goto out_free;
222 }
223
224 *ppos += len;
225
226 out_free:
227 kfree(buf);
228 return len;
229}
230
231/**
Tejun Heoc637b8a2013-12-11 14:11:58 -0500232 * kernfs_fop_read - kernfs vfs read callback
Tejun Heo414985a2013-11-28 14:54:34 -0500233 * @file: file pointer
234 * @user_buf: data to write
235 * @count: number of bytes
236 * @ppos: starting offset
237 */
Tejun Heoc637b8a2013-12-11 14:11:58 -0500238static ssize_t kernfs_fop_read(struct file *file, char __user *user_buf,
239 size_t count, loff_t *ppos)
Tejun Heo414985a2013-11-28 14:54:34 -0500240{
Tejun Heoc525aad2013-12-11 14:11:55 -0500241 struct kernfs_open_file *of = kernfs_of(file);
Tejun Heo414985a2013-11-28 14:54:34 -0500242
Tejun Heodf23fc32013-12-11 14:11:56 -0500243 if (of->kn->flags & KERNFS_HAS_SEQ_SHOW)
Tejun Heo414985a2013-11-28 14:54:34 -0500244 return seq_read(file, user_buf, count, ppos);
245 else
246 return kernfs_file_direct_read(of, user_buf, count, ppos);
247}
248
249/**
Tejun Heoc637b8a2013-12-11 14:11:58 -0500250 * kernfs_fop_write - kernfs vfs write callback
Tejun Heo414985a2013-11-28 14:54:34 -0500251 * @file: file pointer
252 * @user_buf: data to write
253 * @count: number of bytes
254 * @ppos: starting offset
255 *
256 * Copy data in from userland and pass it to the matching kernfs write
257 * operation.
258 *
259 * There is no easy way for us to know if userspace is only doing a partial
260 * write, so we don't support them. We expect the entire buffer to come on
261 * the first write. Hint: if you're writing a value, first read the file,
262 * modify only the the value you're changing, then write entire buffer
263 * back.
264 */
Tejun Heoc637b8a2013-12-11 14:11:58 -0500265static ssize_t kernfs_fop_write(struct file *file, const char __user *user_buf,
266 size_t count, loff_t *ppos)
Tejun Heo414985a2013-11-28 14:54:34 -0500267{
Tejun Heoc525aad2013-12-11 14:11:55 -0500268 struct kernfs_open_file *of = kernfs_of(file);
Tejun Heo414985a2013-11-28 14:54:34 -0500269 const struct kernfs_ops *ops;
Tejun Heob7ce40c2014-03-04 15:38:46 -0500270 size_t len;
271 char *buf;
272
273 if (of->atomic_write_len) {
274 len = count;
275 if (len > of->atomic_write_len)
276 return -E2BIG;
277 } else {
278 len = min_t(size_t, count, PAGE_SIZE);
279 }
280
NeilBrown2b758692014-10-13 16:41:28 +1100281 buf = of->prealloc_buf;
282 if (!buf)
283 buf = kmalloc(len + 1, GFP_KERNEL);
Tejun Heob7ce40c2014-03-04 15:38:46 -0500284 if (!buf)
285 return -ENOMEM;
286
Tejun Heo414985a2013-11-28 14:54:34 -0500287 /*
NeilBrown2b758692014-10-13 16:41:28 +1100288 * @of->mutex nests outside active ref and is used both to ensure that
289 * the ops aren't called concurrently for the same open file, and
290 * to provide exclusive access to ->prealloc_buf (when that exists).
Tejun Heo414985a2013-11-28 14:54:34 -0500291 */
292 mutex_lock(&of->mutex);
Tejun Heoc637b8a2013-12-11 14:11:58 -0500293 if (!kernfs_get_active(of->kn)) {
Tejun Heo414985a2013-11-28 14:54:34 -0500294 mutex_unlock(&of->mutex);
Tejun Heob7ce40c2014-03-04 15:38:46 -0500295 len = -ENODEV;
296 goto out_free;
Tejun Heo414985a2013-11-28 14:54:34 -0500297 }
298
NeilBrown2b758692014-10-13 16:41:28 +1100299 if (copy_from_user(buf, user_buf, len)) {
300 len = -EFAULT;
301 goto out_unlock;
302 }
303 buf[len] = '\0'; /* guarantee string termination */
304
Tejun Heo324a56e2013-12-11 14:11:53 -0500305 ops = kernfs_ops(of->kn);
Tejun Heob7ce40c2014-03-04 15:38:46 -0500306 if (ops->write)
307 len = ops->write(of, buf, len, *ppos);
308 else
Tejun Heo414985a2013-11-28 14:54:34 -0500309 len = -EINVAL;
310
Tejun Heo414985a2013-11-28 14:54:34 -0500311 if (len > 0)
312 *ppos += len;
NeilBrown2b758692014-10-13 16:41:28 +1100313
314out_unlock:
315 kernfs_put_active(of->kn);
316 mutex_unlock(&of->mutex);
Tejun Heob7ce40c2014-03-04 15:38:46 -0500317out_free:
NeilBrown2b758692014-10-13 16:41:28 +1100318 if (buf != of->prealloc_buf)
319 kfree(buf);
Tejun Heo414985a2013-11-28 14:54:34 -0500320 return len;
321}
322
323static void kernfs_vma_open(struct vm_area_struct *vma)
324{
325 struct file *file = vma->vm_file;
Tejun Heoc525aad2013-12-11 14:11:55 -0500326 struct kernfs_open_file *of = kernfs_of(file);
Tejun Heo414985a2013-11-28 14:54:34 -0500327
328 if (!of->vm_ops)
329 return;
330
Tejun Heoc637b8a2013-12-11 14:11:58 -0500331 if (!kernfs_get_active(of->kn))
Tejun Heo414985a2013-11-28 14:54:34 -0500332 return;
333
334 if (of->vm_ops->open)
335 of->vm_ops->open(vma);
336
Tejun Heoc637b8a2013-12-11 14:11:58 -0500337 kernfs_put_active(of->kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500338}
339
340static int kernfs_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
341{
342 struct file *file = vma->vm_file;
Tejun Heoc525aad2013-12-11 14:11:55 -0500343 struct kernfs_open_file *of = kernfs_of(file);
Tejun Heo414985a2013-11-28 14:54:34 -0500344 int ret;
345
346 if (!of->vm_ops)
347 return VM_FAULT_SIGBUS;
348
Tejun Heoc637b8a2013-12-11 14:11:58 -0500349 if (!kernfs_get_active(of->kn))
Tejun Heo414985a2013-11-28 14:54:34 -0500350 return VM_FAULT_SIGBUS;
351
352 ret = VM_FAULT_SIGBUS;
353 if (of->vm_ops->fault)
354 ret = of->vm_ops->fault(vma, vmf);
355
Tejun Heoc637b8a2013-12-11 14:11:58 -0500356 kernfs_put_active(of->kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500357 return ret;
358}
359
360static int kernfs_vma_page_mkwrite(struct vm_area_struct *vma,
361 struct vm_fault *vmf)
362{
363 struct file *file = vma->vm_file;
Tejun Heoc525aad2013-12-11 14:11:55 -0500364 struct kernfs_open_file *of = kernfs_of(file);
Tejun Heo414985a2013-11-28 14:54:34 -0500365 int ret;
366
367 if (!of->vm_ops)
368 return VM_FAULT_SIGBUS;
369
Tejun Heoc637b8a2013-12-11 14:11:58 -0500370 if (!kernfs_get_active(of->kn))
Tejun Heo414985a2013-11-28 14:54:34 -0500371 return VM_FAULT_SIGBUS;
372
373 ret = 0;
374 if (of->vm_ops->page_mkwrite)
375 ret = of->vm_ops->page_mkwrite(vma, vmf);
376 else
377 file_update_time(file);
378
Tejun Heoc637b8a2013-12-11 14:11:58 -0500379 kernfs_put_active(of->kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500380 return ret;
381}
382
383static int kernfs_vma_access(struct vm_area_struct *vma, unsigned long addr,
384 void *buf, int len, int write)
385{
386 struct file *file = vma->vm_file;
Tejun Heoc525aad2013-12-11 14:11:55 -0500387 struct kernfs_open_file *of = kernfs_of(file);
Tejun Heo414985a2013-11-28 14:54:34 -0500388 int ret;
389
390 if (!of->vm_ops)
391 return -EINVAL;
392
Tejun Heoc637b8a2013-12-11 14:11:58 -0500393 if (!kernfs_get_active(of->kn))
Tejun Heo414985a2013-11-28 14:54:34 -0500394 return -EINVAL;
395
396 ret = -EINVAL;
397 if (of->vm_ops->access)
398 ret = of->vm_ops->access(vma, addr, buf, len, write);
399
Tejun Heoc637b8a2013-12-11 14:11:58 -0500400 kernfs_put_active(of->kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500401 return ret;
402}
403
404#ifdef CONFIG_NUMA
405static int kernfs_vma_set_policy(struct vm_area_struct *vma,
406 struct mempolicy *new)
407{
408 struct file *file = vma->vm_file;
Tejun Heoc525aad2013-12-11 14:11:55 -0500409 struct kernfs_open_file *of = kernfs_of(file);
Tejun Heo414985a2013-11-28 14:54:34 -0500410 int ret;
411
412 if (!of->vm_ops)
413 return 0;
414
Tejun Heoc637b8a2013-12-11 14:11:58 -0500415 if (!kernfs_get_active(of->kn))
Tejun Heo414985a2013-11-28 14:54:34 -0500416 return -EINVAL;
417
418 ret = 0;
419 if (of->vm_ops->set_policy)
420 ret = of->vm_ops->set_policy(vma, new);
421
Tejun Heoc637b8a2013-12-11 14:11:58 -0500422 kernfs_put_active(of->kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500423 return ret;
424}
425
426static struct mempolicy *kernfs_vma_get_policy(struct vm_area_struct *vma,
427 unsigned long addr)
428{
429 struct file *file = vma->vm_file;
Tejun Heoc525aad2013-12-11 14:11:55 -0500430 struct kernfs_open_file *of = kernfs_of(file);
Tejun Heo414985a2013-11-28 14:54:34 -0500431 struct mempolicy *pol;
432
433 if (!of->vm_ops)
434 return vma->vm_policy;
435
Tejun Heoc637b8a2013-12-11 14:11:58 -0500436 if (!kernfs_get_active(of->kn))
Tejun Heo414985a2013-11-28 14:54:34 -0500437 return vma->vm_policy;
438
439 pol = vma->vm_policy;
440 if (of->vm_ops->get_policy)
441 pol = of->vm_ops->get_policy(vma, addr);
442
Tejun Heoc637b8a2013-12-11 14:11:58 -0500443 kernfs_put_active(of->kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500444 return pol;
445}
446
447static int kernfs_vma_migrate(struct vm_area_struct *vma,
448 const nodemask_t *from, const nodemask_t *to,
449 unsigned long flags)
450{
451 struct file *file = vma->vm_file;
Tejun Heoc525aad2013-12-11 14:11:55 -0500452 struct kernfs_open_file *of = kernfs_of(file);
Tejun Heo414985a2013-11-28 14:54:34 -0500453 int ret;
454
455 if (!of->vm_ops)
456 return 0;
457
Tejun Heoc637b8a2013-12-11 14:11:58 -0500458 if (!kernfs_get_active(of->kn))
Tejun Heo414985a2013-11-28 14:54:34 -0500459 return 0;
460
461 ret = 0;
462 if (of->vm_ops->migrate)
463 ret = of->vm_ops->migrate(vma, from, to, flags);
464
Tejun Heoc637b8a2013-12-11 14:11:58 -0500465 kernfs_put_active(of->kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500466 return ret;
467}
468#endif
469
470static const struct vm_operations_struct kernfs_vm_ops = {
471 .open = kernfs_vma_open,
472 .fault = kernfs_vma_fault,
473 .page_mkwrite = kernfs_vma_page_mkwrite,
474 .access = kernfs_vma_access,
475#ifdef CONFIG_NUMA
476 .set_policy = kernfs_vma_set_policy,
477 .get_policy = kernfs_vma_get_policy,
478 .migrate = kernfs_vma_migrate,
479#endif
480};
481
Tejun Heoc637b8a2013-12-11 14:11:58 -0500482static int kernfs_fop_mmap(struct file *file, struct vm_area_struct *vma)
Tejun Heo414985a2013-11-28 14:54:34 -0500483{
Tejun Heoc525aad2013-12-11 14:11:55 -0500484 struct kernfs_open_file *of = kernfs_of(file);
Tejun Heo414985a2013-11-28 14:54:34 -0500485 const struct kernfs_ops *ops;
486 int rc;
487
Tejun Heo9b2db6e2013-12-10 09:29:17 -0500488 /*
489 * mmap path and of->mutex are prone to triggering spurious lockdep
490 * warnings and we don't want to add spurious locking dependency
491 * between the two. Check whether mmap is actually implemented
492 * without grabbing @of->mutex by testing HAS_MMAP flag. See the
493 * comment in kernfs_file_open() for more details.
494 */
Tejun Heodf23fc32013-12-11 14:11:56 -0500495 if (!(of->kn->flags & KERNFS_HAS_MMAP))
Tejun Heo9b2db6e2013-12-10 09:29:17 -0500496 return -ENODEV;
497
Tejun Heo414985a2013-11-28 14:54:34 -0500498 mutex_lock(&of->mutex);
499
500 rc = -ENODEV;
Tejun Heoc637b8a2013-12-11 14:11:58 -0500501 if (!kernfs_get_active(of->kn))
Tejun Heo414985a2013-11-28 14:54:34 -0500502 goto out_unlock;
503
Tejun Heo324a56e2013-12-11 14:11:53 -0500504 ops = kernfs_ops(of->kn);
Tejun Heo9b2db6e2013-12-10 09:29:17 -0500505 rc = ops->mmap(of, vma);
Tejun Heob44b2142014-04-20 08:29:21 -0400506 if (rc)
507 goto out_put;
Tejun Heo414985a2013-11-28 14:54:34 -0500508
509 /*
510 * PowerPC's pci_mmap of legacy_mem uses shmem_zero_setup()
511 * to satisfy versions of X which crash if the mmap fails: that
512 * substitutes a new vm_file, and we don't then want bin_vm_ops.
513 */
514 if (vma->vm_file != file)
515 goto out_put;
516
517 rc = -EINVAL;
518 if (of->mmapped && of->vm_ops != vma->vm_ops)
519 goto out_put;
520
521 /*
522 * It is not possible to successfully wrap close.
523 * So error if someone is trying to use close.
524 */
525 rc = -EINVAL;
526 if (vma->vm_ops && vma->vm_ops->close)
527 goto out_put;
528
529 rc = 0;
530 of->mmapped = 1;
531 of->vm_ops = vma->vm_ops;
532 vma->vm_ops = &kernfs_vm_ops;
533out_put:
Tejun Heoc637b8a2013-12-11 14:11:58 -0500534 kernfs_put_active(of->kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500535out_unlock:
536 mutex_unlock(&of->mutex);
537
538 return rc;
539}
540
541/**
Tejun Heoc637b8a2013-12-11 14:11:58 -0500542 * kernfs_get_open_node - get or create kernfs_open_node
Tejun Heo324a56e2013-12-11 14:11:53 -0500543 * @kn: target kernfs_node
Tejun Heoc525aad2013-12-11 14:11:55 -0500544 * @of: kernfs_open_file for this instance of open
Tejun Heo414985a2013-11-28 14:54:34 -0500545 *
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500546 * If @kn->attr.open exists, increment its reference count; otherwise,
547 * create one. @of is chained to the files list.
Tejun Heo414985a2013-11-28 14:54:34 -0500548 *
549 * LOCKING:
550 * Kernel thread context (may sleep).
551 *
552 * RETURNS:
553 * 0 on success, -errno on failure.
554 */
Tejun Heoc637b8a2013-12-11 14:11:58 -0500555static int kernfs_get_open_node(struct kernfs_node *kn,
556 struct kernfs_open_file *of)
Tejun Heo414985a2013-11-28 14:54:34 -0500557{
Tejun Heoc525aad2013-12-11 14:11:55 -0500558 struct kernfs_open_node *on, *new_on = NULL;
Tejun Heo414985a2013-11-28 14:54:34 -0500559
560 retry:
Tejun Heoc525aad2013-12-11 14:11:55 -0500561 mutex_lock(&kernfs_open_file_mutex);
562 spin_lock_irq(&kernfs_open_node_lock);
Tejun Heo414985a2013-11-28 14:54:34 -0500563
Tejun Heoc525aad2013-12-11 14:11:55 -0500564 if (!kn->attr.open && new_on) {
565 kn->attr.open = new_on;
566 new_on = NULL;
Tejun Heo414985a2013-11-28 14:54:34 -0500567 }
568
Tejun Heoc525aad2013-12-11 14:11:55 -0500569 on = kn->attr.open;
570 if (on) {
571 atomic_inc(&on->refcnt);
572 list_add_tail(&of->list, &on->files);
Tejun Heo414985a2013-11-28 14:54:34 -0500573 }
574
Tejun Heoc525aad2013-12-11 14:11:55 -0500575 spin_unlock_irq(&kernfs_open_node_lock);
576 mutex_unlock(&kernfs_open_file_mutex);
Tejun Heo414985a2013-11-28 14:54:34 -0500577
Tejun Heoc525aad2013-12-11 14:11:55 -0500578 if (on) {
579 kfree(new_on);
Tejun Heo414985a2013-11-28 14:54:34 -0500580 return 0;
581 }
582
583 /* not there, initialize a new one and retry */
Tejun Heoc525aad2013-12-11 14:11:55 -0500584 new_on = kmalloc(sizeof(*new_on), GFP_KERNEL);
585 if (!new_on)
Tejun Heo414985a2013-11-28 14:54:34 -0500586 return -ENOMEM;
587
Tejun Heoc525aad2013-12-11 14:11:55 -0500588 atomic_set(&new_on->refcnt, 0);
589 atomic_set(&new_on->event, 1);
590 init_waitqueue_head(&new_on->poll);
591 INIT_LIST_HEAD(&new_on->files);
Tejun Heo414985a2013-11-28 14:54:34 -0500592 goto retry;
593}
594
595/**
Tejun Heoc637b8a2013-12-11 14:11:58 -0500596 * kernfs_put_open_node - put kernfs_open_node
Tejun Heo324a56e2013-12-11 14:11:53 -0500597 * @kn: target kernfs_nodet
Tejun Heoc525aad2013-12-11 14:11:55 -0500598 * @of: associated kernfs_open_file
Tejun Heo414985a2013-11-28 14:54:34 -0500599 *
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500600 * Put @kn->attr.open and unlink @of from the files list. If
Tejun Heo414985a2013-11-28 14:54:34 -0500601 * reference count reaches zero, disassociate and free it.
602 *
603 * LOCKING:
604 * None.
605 */
Tejun Heoc637b8a2013-12-11 14:11:58 -0500606static void kernfs_put_open_node(struct kernfs_node *kn,
607 struct kernfs_open_file *of)
Tejun Heo414985a2013-11-28 14:54:34 -0500608{
Tejun Heoc525aad2013-12-11 14:11:55 -0500609 struct kernfs_open_node *on = kn->attr.open;
Tejun Heo414985a2013-11-28 14:54:34 -0500610 unsigned long flags;
611
Tejun Heoc525aad2013-12-11 14:11:55 -0500612 mutex_lock(&kernfs_open_file_mutex);
613 spin_lock_irqsave(&kernfs_open_node_lock, flags);
Tejun Heo414985a2013-11-28 14:54:34 -0500614
615 if (of)
616 list_del(&of->list);
617
Tejun Heoc525aad2013-12-11 14:11:55 -0500618 if (atomic_dec_and_test(&on->refcnt))
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500619 kn->attr.open = NULL;
Tejun Heo414985a2013-11-28 14:54:34 -0500620 else
Tejun Heoc525aad2013-12-11 14:11:55 -0500621 on = NULL;
Tejun Heo414985a2013-11-28 14:54:34 -0500622
Tejun Heoc525aad2013-12-11 14:11:55 -0500623 spin_unlock_irqrestore(&kernfs_open_node_lock, flags);
624 mutex_unlock(&kernfs_open_file_mutex);
Tejun Heo414985a2013-11-28 14:54:34 -0500625
Tejun Heoc525aad2013-12-11 14:11:55 -0500626 kfree(on);
Tejun Heo414985a2013-11-28 14:54:34 -0500627}
628
Tejun Heoc637b8a2013-12-11 14:11:58 -0500629static int kernfs_fop_open(struct inode *inode, struct file *file)
Tejun Heo414985a2013-11-28 14:54:34 -0500630{
Tejun Heo324a56e2013-12-11 14:11:53 -0500631 struct kernfs_node *kn = file->f_path.dentry->d_fsdata;
Tejun Heo555724a2014-05-12 13:56:27 -0400632 struct kernfs_root *root = kernfs_root(kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500633 const struct kernfs_ops *ops;
Tejun Heoc525aad2013-12-11 14:11:55 -0500634 struct kernfs_open_file *of;
Tejun Heo414985a2013-11-28 14:54:34 -0500635 bool has_read, has_write, has_mmap;
636 int error = -EACCES;
637
Tejun Heoc637b8a2013-12-11 14:11:58 -0500638 if (!kernfs_get_active(kn))
Tejun Heo414985a2013-11-28 14:54:34 -0500639 return -ENODEV;
640
Tejun Heo324a56e2013-12-11 14:11:53 -0500641 ops = kernfs_ops(kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500642
643 has_read = ops->seq_show || ops->read || ops->mmap;
644 has_write = ops->write || ops->mmap;
645 has_mmap = ops->mmap;
646
Tejun Heo555724a2014-05-12 13:56:27 -0400647 /* see the flag definition for details */
648 if (root->flags & KERNFS_ROOT_EXTRA_OPEN_PERM_CHECK) {
649 if ((file->f_mode & FMODE_WRITE) &&
650 (!(inode->i_mode & S_IWUGO) || !has_write))
651 goto err_out;
Tejun Heo414985a2013-11-28 14:54:34 -0500652
Tejun Heo555724a2014-05-12 13:56:27 -0400653 if ((file->f_mode & FMODE_READ) &&
654 (!(inode->i_mode & S_IRUGO) || !has_read))
655 goto err_out;
656 }
Tejun Heo414985a2013-11-28 14:54:34 -0500657
Tejun Heoc525aad2013-12-11 14:11:55 -0500658 /* allocate a kernfs_open_file for the file */
Tejun Heo414985a2013-11-28 14:54:34 -0500659 error = -ENOMEM;
Tejun Heoc525aad2013-12-11 14:11:55 -0500660 of = kzalloc(sizeof(struct kernfs_open_file), GFP_KERNEL);
Tejun Heo414985a2013-11-28 14:54:34 -0500661 if (!of)
662 goto err_out;
663
664 /*
665 * The following is done to give a different lockdep key to
666 * @of->mutex for files which implement mmap. This is a rather
667 * crude way to avoid false positive lockdep warning around
668 * mm->mmap_sem - mmap nests @of->mutex under mm->mmap_sem and
669 * reading /sys/block/sda/trace/act_mask grabs sr_mutex, under
670 * which mm->mmap_sem nests, while holding @of->mutex. As each
671 * open file has a separate mutex, it's okay as long as those don't
672 * happen on the same file. At this point, we can't easily give
673 * each file a separate locking class. Let's differentiate on
674 * whether the file has mmap or not for now.
Tejun Heo9b2db6e2013-12-10 09:29:17 -0500675 *
676 * Both paths of the branch look the same. They're supposed to
677 * look that way and give @of->mutex different static lockdep keys.
Tejun Heo414985a2013-11-28 14:54:34 -0500678 */
679 if (has_mmap)
680 mutex_init(&of->mutex);
681 else
682 mutex_init(&of->mutex);
683
Tejun Heo324a56e2013-12-11 14:11:53 -0500684 of->kn = kn;
Tejun Heo414985a2013-11-28 14:54:34 -0500685 of->file = file;
686
687 /*
Tejun Heob7ce40c2014-03-04 15:38:46 -0500688 * Write path needs to atomic_write_len outside active reference.
689 * Cache it in open_file. See kernfs_fop_write() for details.
690 */
691 of->atomic_write_len = ops->atomic_write_len;
692
NeilBrown2b758692014-10-13 16:41:28 +1100693 if (ops->prealloc) {
694 int len = of->atomic_write_len ?: PAGE_SIZE;
695 of->prealloc_buf = kmalloc(len + 1, GFP_KERNEL);
696 error = -ENOMEM;
697 if (!of->prealloc_buf)
698 goto err_free;
699 }
700
Tejun Heob7ce40c2014-03-04 15:38:46 -0500701 /*
Tejun Heo414985a2013-11-28 14:54:34 -0500702 * Always instantiate seq_file even if read access doesn't use
703 * seq_file or is not requested. This unifies private data access
704 * and readable regular files are the vast majority anyway.
705 */
706 if (ops->seq_show)
707 error = seq_open(file, &kernfs_seq_ops);
708 else
709 error = seq_open(file, NULL);
710 if (error)
711 goto err_free;
712
713 ((struct seq_file *)file->private_data)->private = of;
714
715 /* seq_file clears PWRITE unconditionally, restore it if WRITE */
716 if (file->f_mode & FMODE_WRITE)
717 file->f_mode |= FMODE_PWRITE;
718
Tejun Heoc637b8a2013-12-11 14:11:58 -0500719 /* make sure we have open node struct */
720 error = kernfs_get_open_node(kn, of);
Tejun Heo414985a2013-11-28 14:54:34 -0500721 if (error)
722 goto err_close;
723
724 /* open succeeded, put active references */
Tejun Heoc637b8a2013-12-11 14:11:58 -0500725 kernfs_put_active(kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500726 return 0;
727
728err_close:
729 seq_release(inode, file);
730err_free:
NeilBrown2b758692014-10-13 16:41:28 +1100731 kfree(of->prealloc_buf);
Tejun Heo414985a2013-11-28 14:54:34 -0500732 kfree(of);
733err_out:
Tejun Heoc637b8a2013-12-11 14:11:58 -0500734 kernfs_put_active(kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500735 return error;
736}
737
Tejun Heoc637b8a2013-12-11 14:11:58 -0500738static int kernfs_fop_release(struct inode *inode, struct file *filp)
Tejun Heo414985a2013-11-28 14:54:34 -0500739{
Tejun Heo324a56e2013-12-11 14:11:53 -0500740 struct kernfs_node *kn = filp->f_path.dentry->d_fsdata;
Tejun Heoc525aad2013-12-11 14:11:55 -0500741 struct kernfs_open_file *of = kernfs_of(filp);
Tejun Heo414985a2013-11-28 14:54:34 -0500742
Tejun Heoc637b8a2013-12-11 14:11:58 -0500743 kernfs_put_open_node(kn, of);
Tejun Heo414985a2013-11-28 14:54:34 -0500744 seq_release(inode, filp);
NeilBrown2b758692014-10-13 16:41:28 +1100745 kfree(of->prealloc_buf);
Tejun Heo414985a2013-11-28 14:54:34 -0500746 kfree(of);
747
748 return 0;
749}
750
Greg Kroah-Hartman55f6e302014-01-13 14:27:16 -0800751void kernfs_unmap_bin_file(struct kernfs_node *kn)
Tejun Heo414985a2013-11-28 14:54:34 -0500752{
Tejun Heoc525aad2013-12-11 14:11:55 -0500753 struct kernfs_open_node *on;
754 struct kernfs_open_file *of;
Tejun Heo414985a2013-11-28 14:54:34 -0500755
Greg Kroah-Hartman55f6e302014-01-13 14:27:16 -0800756 if (!(kn->flags & KERNFS_HAS_MMAP))
757 return;
758
Tejun Heoc525aad2013-12-11 14:11:55 -0500759 spin_lock_irq(&kernfs_open_node_lock);
760 on = kn->attr.open;
761 if (on)
762 atomic_inc(&on->refcnt);
763 spin_unlock_irq(&kernfs_open_node_lock);
764 if (!on)
Tejun Heo414985a2013-11-28 14:54:34 -0500765 return;
766
Tejun Heoc525aad2013-12-11 14:11:55 -0500767 mutex_lock(&kernfs_open_file_mutex);
768 list_for_each_entry(of, &on->files, list) {
Tejun Heo414985a2013-11-28 14:54:34 -0500769 struct inode *inode = file_inode(of->file);
770 unmap_mapping_range(inode->i_mapping, 0, 0, 1);
771 }
Tejun Heoc525aad2013-12-11 14:11:55 -0500772 mutex_unlock(&kernfs_open_file_mutex);
Tejun Heo414985a2013-11-28 14:54:34 -0500773
Tejun Heoc637b8a2013-12-11 14:11:58 -0500774 kernfs_put_open_node(kn, NULL);
Tejun Heo414985a2013-11-28 14:54:34 -0500775}
776
Tejun Heoc637b8a2013-12-11 14:11:58 -0500777/*
778 * Kernfs attribute files are pollable. The idea is that you read
Tejun Heo414985a2013-11-28 14:54:34 -0500779 * the content and then you use 'poll' or 'select' to wait for
780 * the content to change. When the content changes (assuming the
781 * manager for the kobject supports notification), poll will
782 * return POLLERR|POLLPRI, and select will return the fd whether
783 * it is waiting for read, write, or exceptions.
784 * Once poll/select indicates that the value has changed, you
785 * need to close and re-open the file, or seek to 0 and read again.
786 * Reminder: this only works for attributes which actively support
787 * it, and it is not possible to test an attribute from userspace
788 * to see if it supports poll (Neither 'poll' nor 'select' return
789 * an appropriate error code). When in doubt, set a suitable timeout value.
790 */
Tejun Heoc637b8a2013-12-11 14:11:58 -0500791static unsigned int kernfs_fop_poll(struct file *filp, poll_table *wait)
Tejun Heo414985a2013-11-28 14:54:34 -0500792{
Tejun Heoc525aad2013-12-11 14:11:55 -0500793 struct kernfs_open_file *of = kernfs_of(filp);
Tejun Heo324a56e2013-12-11 14:11:53 -0500794 struct kernfs_node *kn = filp->f_path.dentry->d_fsdata;
Tejun Heoc525aad2013-12-11 14:11:55 -0500795 struct kernfs_open_node *on = kn->attr.open;
Tejun Heo414985a2013-11-28 14:54:34 -0500796
797 /* need parent for the kobj, grab both */
Tejun Heoc637b8a2013-12-11 14:11:58 -0500798 if (!kernfs_get_active(kn))
Tejun Heo414985a2013-11-28 14:54:34 -0500799 goto trigger;
800
Tejun Heoc525aad2013-12-11 14:11:55 -0500801 poll_wait(filp, &on->poll, wait);
Tejun Heo414985a2013-11-28 14:54:34 -0500802
Tejun Heoc637b8a2013-12-11 14:11:58 -0500803 kernfs_put_active(kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500804
Tejun Heoc525aad2013-12-11 14:11:55 -0500805 if (of->event != atomic_read(&on->event))
Tejun Heo414985a2013-11-28 14:54:34 -0500806 goto trigger;
807
808 return DEFAULT_POLLMASK;
809
810 trigger:
811 return DEFAULT_POLLMASK|POLLERR|POLLPRI;
812}
813
Tejun Heoecca47c2014-07-01 16:41:03 -0400814static void kernfs_notify_workfn(struct work_struct *work)
Tejun Heo414985a2013-11-28 14:54:34 -0500815{
Tejun Heoecca47c2014-07-01 16:41:03 -0400816 struct kernfs_node *kn;
Tejun Heoc525aad2013-12-11 14:11:55 -0500817 struct kernfs_open_node *on;
Tejun Heod911d982014-04-09 11:07:31 -0400818 struct kernfs_super_info *info;
Tejun Heoecca47c2014-07-01 16:41:03 -0400819repeat:
820 /* pop one off the notify_list */
821 spin_lock_irq(&kernfs_notify_lock);
822 kn = kernfs_notify_list;
823 if (kn == KERNFS_NOTIFY_EOL) {
824 spin_unlock_irq(&kernfs_notify_lock);
Tejun Heod911d982014-04-09 11:07:31 -0400825 return;
Tejun Heoecca47c2014-07-01 16:41:03 -0400826 }
827 kernfs_notify_list = kn->attr.notify_next;
828 kn->attr.notify_next = NULL;
829 spin_unlock_irq(&kernfs_notify_lock);
Tejun Heod911d982014-04-09 11:07:31 -0400830
831 /* kick poll */
Tejun Heoecca47c2014-07-01 16:41:03 -0400832 spin_lock_irq(&kernfs_open_node_lock);
Tejun Heo414985a2013-11-28 14:54:34 -0500833
Tejun Heod911d982014-04-09 11:07:31 -0400834 on = kn->attr.open;
835 if (on) {
836 atomic_inc(&on->event);
837 wake_up_interruptible(&on->poll);
Tejun Heo414985a2013-11-28 14:54:34 -0500838 }
839
Tejun Heoecca47c2014-07-01 16:41:03 -0400840 spin_unlock_irq(&kernfs_open_node_lock);
Tejun Heod911d982014-04-09 11:07:31 -0400841
842 /* kick fsnotify */
843 mutex_lock(&kernfs_mutex);
844
Tejun Heoecca47c2014-07-01 16:41:03 -0400845 list_for_each_entry(info, &kernfs_root(kn)->supers, node) {
Tejun Heod911d982014-04-09 11:07:31 -0400846 struct inode *inode;
847 struct dentry *dentry;
848
849 inode = ilookup(info->sb, kn->ino);
850 if (!inode)
851 continue;
852
853 dentry = d_find_any_alias(inode);
854 if (dentry) {
855 fsnotify_parent(NULL, dentry, FS_MODIFY);
856 fsnotify(inode, FS_MODIFY, inode, FSNOTIFY_EVENT_INODE,
857 NULL, 0);
858 dput(dentry);
859 }
860
861 iput(inode);
862 }
863
864 mutex_unlock(&kernfs_mutex);
Tejun Heoecca47c2014-07-01 16:41:03 -0400865 kernfs_put(kn);
866 goto repeat;
867}
868
869/**
870 * kernfs_notify - notify a kernfs file
871 * @kn: file to notify
872 *
873 * Notify @kn such that poll(2) on @kn wakes up. Maybe be called from any
874 * context.
875 */
876void kernfs_notify(struct kernfs_node *kn)
877{
878 static DECLARE_WORK(kernfs_notify_work, kernfs_notify_workfn);
879 unsigned long flags;
880
881 if (WARN_ON(kernfs_type(kn) != KERNFS_FILE))
882 return;
883
884 spin_lock_irqsave(&kernfs_notify_lock, flags);
885 if (!kn->attr.notify_next) {
886 kernfs_get(kn);
887 kn->attr.notify_next = kernfs_notify_list;
888 kernfs_notify_list = kn;
889 schedule_work(&kernfs_notify_work);
890 }
891 spin_unlock_irqrestore(&kernfs_notify_lock, flags);
Tejun Heo414985a2013-11-28 14:54:34 -0500892}
893EXPORT_SYMBOL_GPL(kernfs_notify);
894
Tejun Heoa797bfc2013-12-11 14:11:57 -0500895const struct file_operations kernfs_file_fops = {
Tejun Heoc637b8a2013-12-11 14:11:58 -0500896 .read = kernfs_fop_read,
897 .write = kernfs_fop_write,
Tejun Heo414985a2013-11-28 14:54:34 -0500898 .llseek = generic_file_llseek,
Tejun Heoc637b8a2013-12-11 14:11:58 -0500899 .mmap = kernfs_fop_mmap,
900 .open = kernfs_fop_open,
901 .release = kernfs_fop_release,
902 .poll = kernfs_fop_poll,
Tejun Heo414985a2013-11-28 14:54:34 -0500903};
904
905/**
Tejun Heo2063d602013-12-11 16:02:57 -0500906 * __kernfs_create_file - kernfs internal function to create a file
Tejun Heo414985a2013-11-28 14:54:34 -0500907 * @parent: directory to create the file in
908 * @name: name of the file
909 * @mode: mode of the file
910 * @size: size of the file
911 * @ops: kernfs operations for the file
912 * @priv: private data for the file
913 * @ns: optional namespace tag of the file
Fabian Frederick8278bd32014-07-04 21:47:53 +0200914 * @name_is_static: don't copy file name
Tejun Heo414985a2013-11-28 14:54:34 -0500915 * @key: lockdep key for the file's active_ref, %NULL to disable lockdep
916 *
917 * Returns the created node on success, ERR_PTR() value on error.
918 */
Tejun Heo2063d602013-12-11 16:02:57 -0500919struct kernfs_node *__kernfs_create_file(struct kernfs_node *parent,
920 const char *name,
921 umode_t mode, loff_t size,
922 const struct kernfs_ops *ops,
923 void *priv, const void *ns,
924 bool name_is_static,
925 struct lock_class_key *key)
Tejun Heo414985a2013-11-28 14:54:34 -0500926{
Tejun Heo324a56e2013-12-11 14:11:53 -0500927 struct kernfs_node *kn;
Tejun Heo2063d602013-12-11 16:02:57 -0500928 unsigned flags;
Tejun Heo414985a2013-11-28 14:54:34 -0500929 int rc;
930
Tejun Heo2063d602013-12-11 16:02:57 -0500931 flags = KERNFS_FILE;
932 if (name_is_static)
933 flags |= KERNFS_STATIC_NAME;
934
Tejun Heodb4aad22014-01-17 09:58:25 -0500935 kn = kernfs_new_node(parent, name, (mode & S_IALLUGO) | S_IFREG, flags);
Tejun Heo324a56e2013-12-11 14:11:53 -0500936 if (!kn)
Tejun Heo414985a2013-11-28 14:54:34 -0500937 return ERR_PTR(-ENOMEM);
938
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500939 kn->attr.ops = ops;
940 kn->attr.size = size;
941 kn->ns = ns;
Tejun Heo324a56e2013-12-11 14:11:53 -0500942 kn->priv = priv;
Tejun Heo414985a2013-11-28 14:54:34 -0500943
944#ifdef CONFIG_DEBUG_LOCK_ALLOC
945 if (key) {
Tejun Heo324a56e2013-12-11 14:11:53 -0500946 lockdep_init_map(&kn->dep_map, "s_active", key, 0);
Tejun Heodf23fc32013-12-11 14:11:56 -0500947 kn->flags |= KERNFS_LOCKDEP;
Tejun Heo414985a2013-11-28 14:54:34 -0500948 }
949#endif
950
951 /*
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500952 * kn->attr.ops is accesible only while holding active ref. We
Tejun Heo414985a2013-11-28 14:54:34 -0500953 * need to know whether some ops are implemented outside active
954 * ref. Cache their existence in flags.
955 */
956 if (ops->seq_show)
Tejun Heodf23fc32013-12-11 14:11:56 -0500957 kn->flags |= KERNFS_HAS_SEQ_SHOW;
Tejun Heo414985a2013-11-28 14:54:34 -0500958 if (ops->mmap)
Tejun Heodf23fc32013-12-11 14:11:56 -0500959 kn->flags |= KERNFS_HAS_MMAP;
Tejun Heo414985a2013-11-28 14:54:34 -0500960
Tejun Heo988cd7a2014-02-03 14:02:58 -0500961 rc = kernfs_add_one(kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500962 if (rc) {
Tejun Heo324a56e2013-12-11 14:11:53 -0500963 kernfs_put(kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500964 return ERR_PTR(rc);
965 }
Tejun Heo324a56e2013-12-11 14:11:53 -0500966 return kn;
Tejun Heo414985a2013-11-28 14:54:34 -0500967}