blob: ddc9f9612f168f026ea71aa4f4aac41bf6860369 [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
NeilBrown4ef67a82014-10-14 16:57:26 +1100192 buf = of->prealloc_buf;
193 if (!buf)
194 buf = kmalloc(len, GFP_KERNEL);
Tejun Heo414985a2013-11-28 14:54:34 -0500195 if (!buf)
196 return -ENOMEM;
197
198 /*
NeilBrown4ef67a82014-10-14 16:57:26 +1100199 * @of->mutex nests outside active ref and is used both to ensure that
200 * the ops aren't called concurrently for the same open file, and
201 * to provide exclusive access to ->prealloc_buf (when that exists).
Tejun Heo414985a2013-11-28 14:54:34 -0500202 */
203 mutex_lock(&of->mutex);
Tejun Heoc637b8a2013-12-11 14:11:58 -0500204 if (!kernfs_get_active(of->kn)) {
Tejun Heo414985a2013-11-28 14:54:34 -0500205 len = -ENODEV;
206 mutex_unlock(&of->mutex);
207 goto out_free;
208 }
209
Tejun Heo324a56e2013-12-11 14:11:53 -0500210 ops = kernfs_ops(of->kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500211 if (ops->read)
212 len = ops->read(of, buf, len, *ppos);
213 else
214 len = -EINVAL;
215
Tejun Heo414985a2013-11-28 14:54:34 -0500216 if (len < 0)
NeilBrown4ef67a82014-10-14 16:57:26 +1100217 goto out_unlock;
Tejun Heo414985a2013-11-28 14:54:34 -0500218
219 if (copy_to_user(user_buf, buf, len)) {
220 len = -EFAULT;
NeilBrown4ef67a82014-10-14 16:57:26 +1100221 goto out_unlock;
Tejun Heo414985a2013-11-28 14:54:34 -0500222 }
223
224 *ppos += len;
225
NeilBrown4ef67a82014-10-14 16:57:26 +1100226 out_unlock:
227 kernfs_put_active(of->kn);
228 mutex_unlock(&of->mutex);
Tejun Heo414985a2013-11-28 14:54:34 -0500229 out_free:
NeilBrown4ef67a82014-10-14 16:57:26 +1100230 if (buf != of->prealloc_buf)
231 kfree(buf);
Tejun Heo414985a2013-11-28 14:54:34 -0500232 return len;
233}
234
235/**
Tejun Heoc637b8a2013-12-11 14:11:58 -0500236 * kernfs_fop_read - kernfs vfs read callback
Tejun Heo414985a2013-11-28 14:54:34 -0500237 * @file: file pointer
238 * @user_buf: data to write
239 * @count: number of bytes
240 * @ppos: starting offset
241 */
Tejun Heoc637b8a2013-12-11 14:11:58 -0500242static ssize_t kernfs_fop_read(struct file *file, char __user *user_buf,
243 size_t count, loff_t *ppos)
Tejun Heo414985a2013-11-28 14:54:34 -0500244{
Tejun Heoc525aad2013-12-11 14:11:55 -0500245 struct kernfs_open_file *of = kernfs_of(file);
Tejun Heo414985a2013-11-28 14:54:34 -0500246
Tejun Heodf23fc32013-12-11 14:11:56 -0500247 if (of->kn->flags & KERNFS_HAS_SEQ_SHOW)
Tejun Heo414985a2013-11-28 14:54:34 -0500248 return seq_read(file, user_buf, count, ppos);
249 else
250 return kernfs_file_direct_read(of, user_buf, count, ppos);
251}
252
253/**
Tejun Heoc637b8a2013-12-11 14:11:58 -0500254 * kernfs_fop_write - kernfs vfs write callback
Tejun Heo414985a2013-11-28 14:54:34 -0500255 * @file: file pointer
256 * @user_buf: data to write
257 * @count: number of bytes
258 * @ppos: starting offset
259 *
260 * Copy data in from userland and pass it to the matching kernfs write
261 * operation.
262 *
263 * There is no easy way for us to know if userspace is only doing a partial
264 * write, so we don't support them. We expect the entire buffer to come on
265 * the first write. Hint: if you're writing a value, first read the file,
266 * modify only the the value you're changing, then write entire buffer
267 * back.
268 */
Tejun Heoc637b8a2013-12-11 14:11:58 -0500269static ssize_t kernfs_fop_write(struct file *file, const char __user *user_buf,
270 size_t count, loff_t *ppos)
Tejun Heo414985a2013-11-28 14:54:34 -0500271{
Tejun Heoc525aad2013-12-11 14:11:55 -0500272 struct kernfs_open_file *of = kernfs_of(file);
Tejun Heo414985a2013-11-28 14:54:34 -0500273 const struct kernfs_ops *ops;
Tejun Heob7ce40c2014-03-04 15:38:46 -0500274 size_t len;
275 char *buf;
276
277 if (of->atomic_write_len) {
278 len = count;
279 if (len > of->atomic_write_len)
280 return -E2BIG;
281 } else {
282 len = min_t(size_t, count, PAGE_SIZE);
283 }
284
NeilBrown2b758692014-10-13 16:41:28 +1100285 buf = of->prealloc_buf;
286 if (!buf)
287 buf = kmalloc(len + 1, GFP_KERNEL);
Tejun Heob7ce40c2014-03-04 15:38:46 -0500288 if (!buf)
289 return -ENOMEM;
290
Tejun Heo414985a2013-11-28 14:54:34 -0500291 /*
NeilBrown2b758692014-10-13 16:41:28 +1100292 * @of->mutex nests outside active ref and is used both to ensure that
293 * the ops aren't called concurrently for the same open file, and
294 * to provide exclusive access to ->prealloc_buf (when that exists).
Tejun Heo414985a2013-11-28 14:54:34 -0500295 */
296 mutex_lock(&of->mutex);
Tejun Heoc637b8a2013-12-11 14:11:58 -0500297 if (!kernfs_get_active(of->kn)) {
Tejun Heo414985a2013-11-28 14:54:34 -0500298 mutex_unlock(&of->mutex);
Tejun Heob7ce40c2014-03-04 15:38:46 -0500299 len = -ENODEV;
300 goto out_free;
Tejun Heo414985a2013-11-28 14:54:34 -0500301 }
302
NeilBrown2b758692014-10-13 16:41:28 +1100303 if (copy_from_user(buf, user_buf, len)) {
304 len = -EFAULT;
305 goto out_unlock;
306 }
307 buf[len] = '\0'; /* guarantee string termination */
308
Tejun Heo324a56e2013-12-11 14:11:53 -0500309 ops = kernfs_ops(of->kn);
Tejun Heob7ce40c2014-03-04 15:38:46 -0500310 if (ops->write)
311 len = ops->write(of, buf, len, *ppos);
312 else
Tejun Heo414985a2013-11-28 14:54:34 -0500313 len = -EINVAL;
314
Tejun Heo414985a2013-11-28 14:54:34 -0500315 if (len > 0)
316 *ppos += len;
NeilBrown2b758692014-10-13 16:41:28 +1100317
318out_unlock:
319 kernfs_put_active(of->kn);
320 mutex_unlock(&of->mutex);
Tejun Heob7ce40c2014-03-04 15:38:46 -0500321out_free:
NeilBrown2b758692014-10-13 16:41:28 +1100322 if (buf != of->prealloc_buf)
323 kfree(buf);
Tejun Heo414985a2013-11-28 14:54:34 -0500324 return len;
325}
326
327static void kernfs_vma_open(struct vm_area_struct *vma)
328{
329 struct file *file = vma->vm_file;
Tejun Heoc525aad2013-12-11 14:11:55 -0500330 struct kernfs_open_file *of = kernfs_of(file);
Tejun Heo414985a2013-11-28 14:54:34 -0500331
332 if (!of->vm_ops)
333 return;
334
Tejun Heoc637b8a2013-12-11 14:11:58 -0500335 if (!kernfs_get_active(of->kn))
Tejun Heo414985a2013-11-28 14:54:34 -0500336 return;
337
338 if (of->vm_ops->open)
339 of->vm_ops->open(vma);
340
Tejun Heoc637b8a2013-12-11 14:11:58 -0500341 kernfs_put_active(of->kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500342}
343
344static int kernfs_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
345{
346 struct file *file = vma->vm_file;
Tejun Heoc525aad2013-12-11 14:11:55 -0500347 struct kernfs_open_file *of = kernfs_of(file);
Tejun Heo414985a2013-11-28 14:54:34 -0500348 int ret;
349
350 if (!of->vm_ops)
351 return VM_FAULT_SIGBUS;
352
Tejun Heoc637b8a2013-12-11 14:11:58 -0500353 if (!kernfs_get_active(of->kn))
Tejun Heo414985a2013-11-28 14:54:34 -0500354 return VM_FAULT_SIGBUS;
355
356 ret = VM_FAULT_SIGBUS;
357 if (of->vm_ops->fault)
358 ret = of->vm_ops->fault(vma, vmf);
359
Tejun Heoc637b8a2013-12-11 14:11:58 -0500360 kernfs_put_active(of->kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500361 return ret;
362}
363
364static int kernfs_vma_page_mkwrite(struct vm_area_struct *vma,
365 struct vm_fault *vmf)
366{
367 struct file *file = vma->vm_file;
Tejun Heoc525aad2013-12-11 14:11:55 -0500368 struct kernfs_open_file *of = kernfs_of(file);
Tejun Heo414985a2013-11-28 14:54:34 -0500369 int ret;
370
371 if (!of->vm_ops)
372 return VM_FAULT_SIGBUS;
373
Tejun Heoc637b8a2013-12-11 14:11:58 -0500374 if (!kernfs_get_active(of->kn))
Tejun Heo414985a2013-11-28 14:54:34 -0500375 return VM_FAULT_SIGBUS;
376
377 ret = 0;
378 if (of->vm_ops->page_mkwrite)
379 ret = of->vm_ops->page_mkwrite(vma, vmf);
380 else
381 file_update_time(file);
382
Tejun Heoc637b8a2013-12-11 14:11:58 -0500383 kernfs_put_active(of->kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500384 return ret;
385}
386
387static int kernfs_vma_access(struct vm_area_struct *vma, unsigned long addr,
388 void *buf, int len, int write)
389{
390 struct file *file = vma->vm_file;
Tejun Heoc525aad2013-12-11 14:11:55 -0500391 struct kernfs_open_file *of = kernfs_of(file);
Tejun Heo414985a2013-11-28 14:54:34 -0500392 int ret;
393
394 if (!of->vm_ops)
395 return -EINVAL;
396
Tejun Heoc637b8a2013-12-11 14:11:58 -0500397 if (!kernfs_get_active(of->kn))
Tejun Heo414985a2013-11-28 14:54:34 -0500398 return -EINVAL;
399
400 ret = -EINVAL;
401 if (of->vm_ops->access)
402 ret = of->vm_ops->access(vma, addr, buf, len, write);
403
Tejun Heoc637b8a2013-12-11 14:11:58 -0500404 kernfs_put_active(of->kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500405 return ret;
406}
407
408#ifdef CONFIG_NUMA
409static int kernfs_vma_set_policy(struct vm_area_struct *vma,
410 struct mempolicy *new)
411{
412 struct file *file = vma->vm_file;
Tejun Heoc525aad2013-12-11 14:11:55 -0500413 struct kernfs_open_file *of = kernfs_of(file);
Tejun Heo414985a2013-11-28 14:54:34 -0500414 int ret;
415
416 if (!of->vm_ops)
417 return 0;
418
Tejun Heoc637b8a2013-12-11 14:11:58 -0500419 if (!kernfs_get_active(of->kn))
Tejun Heo414985a2013-11-28 14:54:34 -0500420 return -EINVAL;
421
422 ret = 0;
423 if (of->vm_ops->set_policy)
424 ret = of->vm_ops->set_policy(vma, new);
425
Tejun Heoc637b8a2013-12-11 14:11:58 -0500426 kernfs_put_active(of->kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500427 return ret;
428}
429
430static struct mempolicy *kernfs_vma_get_policy(struct vm_area_struct *vma,
431 unsigned long addr)
432{
433 struct file *file = vma->vm_file;
Tejun Heoc525aad2013-12-11 14:11:55 -0500434 struct kernfs_open_file *of = kernfs_of(file);
Tejun Heo414985a2013-11-28 14:54:34 -0500435 struct mempolicy *pol;
436
437 if (!of->vm_ops)
438 return vma->vm_policy;
439
Tejun Heoc637b8a2013-12-11 14:11:58 -0500440 if (!kernfs_get_active(of->kn))
Tejun Heo414985a2013-11-28 14:54:34 -0500441 return vma->vm_policy;
442
443 pol = vma->vm_policy;
444 if (of->vm_ops->get_policy)
445 pol = of->vm_ops->get_policy(vma, addr);
446
Tejun Heoc637b8a2013-12-11 14:11:58 -0500447 kernfs_put_active(of->kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500448 return pol;
449}
450
Tejun Heo414985a2013-11-28 14:54:34 -0500451#endif
452
453static const struct vm_operations_struct kernfs_vm_ops = {
454 .open = kernfs_vma_open,
455 .fault = kernfs_vma_fault,
456 .page_mkwrite = kernfs_vma_page_mkwrite,
457 .access = kernfs_vma_access,
458#ifdef CONFIG_NUMA
459 .set_policy = kernfs_vma_set_policy,
460 .get_policy = kernfs_vma_get_policy,
Tejun Heo414985a2013-11-28 14:54:34 -0500461#endif
462};
463
Tejun Heoc637b8a2013-12-11 14:11:58 -0500464static int kernfs_fop_mmap(struct file *file, struct vm_area_struct *vma)
Tejun Heo414985a2013-11-28 14:54:34 -0500465{
Tejun Heoc525aad2013-12-11 14:11:55 -0500466 struct kernfs_open_file *of = kernfs_of(file);
Tejun Heo414985a2013-11-28 14:54:34 -0500467 const struct kernfs_ops *ops;
468 int rc;
469
Tejun Heo9b2db6e2013-12-10 09:29:17 -0500470 /*
471 * mmap path and of->mutex are prone to triggering spurious lockdep
472 * warnings and we don't want to add spurious locking dependency
473 * between the two. Check whether mmap is actually implemented
474 * without grabbing @of->mutex by testing HAS_MMAP flag. See the
475 * comment in kernfs_file_open() for more details.
476 */
Tejun Heodf23fc32013-12-11 14:11:56 -0500477 if (!(of->kn->flags & KERNFS_HAS_MMAP))
Tejun Heo9b2db6e2013-12-10 09:29:17 -0500478 return -ENODEV;
479
Tejun Heo414985a2013-11-28 14:54:34 -0500480 mutex_lock(&of->mutex);
481
482 rc = -ENODEV;
Tejun Heoc637b8a2013-12-11 14:11:58 -0500483 if (!kernfs_get_active(of->kn))
Tejun Heo414985a2013-11-28 14:54:34 -0500484 goto out_unlock;
485
Tejun Heo324a56e2013-12-11 14:11:53 -0500486 ops = kernfs_ops(of->kn);
Tejun Heo9b2db6e2013-12-10 09:29:17 -0500487 rc = ops->mmap(of, vma);
Tejun Heob44b2142014-04-20 08:29:21 -0400488 if (rc)
489 goto out_put;
Tejun Heo414985a2013-11-28 14:54:34 -0500490
491 /*
492 * PowerPC's pci_mmap of legacy_mem uses shmem_zero_setup()
493 * to satisfy versions of X which crash if the mmap fails: that
494 * substitutes a new vm_file, and we don't then want bin_vm_ops.
495 */
496 if (vma->vm_file != file)
497 goto out_put;
498
499 rc = -EINVAL;
500 if (of->mmapped && of->vm_ops != vma->vm_ops)
501 goto out_put;
502
503 /*
504 * It is not possible to successfully wrap close.
505 * So error if someone is trying to use close.
506 */
507 rc = -EINVAL;
508 if (vma->vm_ops && vma->vm_ops->close)
509 goto out_put;
510
511 rc = 0;
512 of->mmapped = 1;
513 of->vm_ops = vma->vm_ops;
514 vma->vm_ops = &kernfs_vm_ops;
515out_put:
Tejun Heoc637b8a2013-12-11 14:11:58 -0500516 kernfs_put_active(of->kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500517out_unlock:
518 mutex_unlock(&of->mutex);
519
520 return rc;
521}
522
523/**
Tejun Heoc637b8a2013-12-11 14:11:58 -0500524 * kernfs_get_open_node - get or create kernfs_open_node
Tejun Heo324a56e2013-12-11 14:11:53 -0500525 * @kn: target kernfs_node
Tejun Heoc525aad2013-12-11 14:11:55 -0500526 * @of: kernfs_open_file for this instance of open
Tejun Heo414985a2013-11-28 14:54:34 -0500527 *
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500528 * If @kn->attr.open exists, increment its reference count; otherwise,
529 * create one. @of is chained to the files list.
Tejun Heo414985a2013-11-28 14:54:34 -0500530 *
531 * LOCKING:
532 * Kernel thread context (may sleep).
533 *
534 * RETURNS:
535 * 0 on success, -errno on failure.
536 */
Tejun Heoc637b8a2013-12-11 14:11:58 -0500537static int kernfs_get_open_node(struct kernfs_node *kn,
538 struct kernfs_open_file *of)
Tejun Heo414985a2013-11-28 14:54:34 -0500539{
Tejun Heoc525aad2013-12-11 14:11:55 -0500540 struct kernfs_open_node *on, *new_on = NULL;
Tejun Heo414985a2013-11-28 14:54:34 -0500541
542 retry:
Tejun Heoc525aad2013-12-11 14:11:55 -0500543 mutex_lock(&kernfs_open_file_mutex);
544 spin_lock_irq(&kernfs_open_node_lock);
Tejun Heo414985a2013-11-28 14:54:34 -0500545
Tejun Heoc525aad2013-12-11 14:11:55 -0500546 if (!kn->attr.open && new_on) {
547 kn->attr.open = new_on;
548 new_on = NULL;
Tejun Heo414985a2013-11-28 14:54:34 -0500549 }
550
Tejun Heoc525aad2013-12-11 14:11:55 -0500551 on = kn->attr.open;
552 if (on) {
553 atomic_inc(&on->refcnt);
554 list_add_tail(&of->list, &on->files);
Tejun Heo414985a2013-11-28 14:54:34 -0500555 }
556
Tejun Heoc525aad2013-12-11 14:11:55 -0500557 spin_unlock_irq(&kernfs_open_node_lock);
558 mutex_unlock(&kernfs_open_file_mutex);
Tejun Heo414985a2013-11-28 14:54:34 -0500559
Tejun Heoc525aad2013-12-11 14:11:55 -0500560 if (on) {
561 kfree(new_on);
Tejun Heo414985a2013-11-28 14:54:34 -0500562 return 0;
563 }
564
565 /* not there, initialize a new one and retry */
Tejun Heoc525aad2013-12-11 14:11:55 -0500566 new_on = kmalloc(sizeof(*new_on), GFP_KERNEL);
567 if (!new_on)
Tejun Heo414985a2013-11-28 14:54:34 -0500568 return -ENOMEM;
569
Tejun Heoc525aad2013-12-11 14:11:55 -0500570 atomic_set(&new_on->refcnt, 0);
571 atomic_set(&new_on->event, 1);
572 init_waitqueue_head(&new_on->poll);
573 INIT_LIST_HEAD(&new_on->files);
Tejun Heo414985a2013-11-28 14:54:34 -0500574 goto retry;
575}
576
577/**
Tejun Heoc637b8a2013-12-11 14:11:58 -0500578 * kernfs_put_open_node - put kernfs_open_node
Tejun Heo324a56e2013-12-11 14:11:53 -0500579 * @kn: target kernfs_nodet
Tejun Heoc525aad2013-12-11 14:11:55 -0500580 * @of: associated kernfs_open_file
Tejun Heo414985a2013-11-28 14:54:34 -0500581 *
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500582 * Put @kn->attr.open and unlink @of from the files list. If
Tejun Heo414985a2013-11-28 14:54:34 -0500583 * reference count reaches zero, disassociate and free it.
584 *
585 * LOCKING:
586 * None.
587 */
Tejun Heoc637b8a2013-12-11 14:11:58 -0500588static void kernfs_put_open_node(struct kernfs_node *kn,
589 struct kernfs_open_file *of)
Tejun Heo414985a2013-11-28 14:54:34 -0500590{
Tejun Heoc525aad2013-12-11 14:11:55 -0500591 struct kernfs_open_node *on = kn->attr.open;
Tejun Heo414985a2013-11-28 14:54:34 -0500592 unsigned long flags;
593
Tejun Heoc525aad2013-12-11 14:11:55 -0500594 mutex_lock(&kernfs_open_file_mutex);
595 spin_lock_irqsave(&kernfs_open_node_lock, flags);
Tejun Heo414985a2013-11-28 14:54:34 -0500596
597 if (of)
598 list_del(&of->list);
599
Tejun Heoc525aad2013-12-11 14:11:55 -0500600 if (atomic_dec_and_test(&on->refcnt))
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500601 kn->attr.open = NULL;
Tejun Heo414985a2013-11-28 14:54:34 -0500602 else
Tejun Heoc525aad2013-12-11 14:11:55 -0500603 on = NULL;
Tejun Heo414985a2013-11-28 14:54:34 -0500604
Tejun Heoc525aad2013-12-11 14:11:55 -0500605 spin_unlock_irqrestore(&kernfs_open_node_lock, flags);
606 mutex_unlock(&kernfs_open_file_mutex);
Tejun Heo414985a2013-11-28 14:54:34 -0500607
Tejun Heoc525aad2013-12-11 14:11:55 -0500608 kfree(on);
Tejun Heo414985a2013-11-28 14:54:34 -0500609}
610
Tejun Heoc637b8a2013-12-11 14:11:58 -0500611static int kernfs_fop_open(struct inode *inode, struct file *file)
Tejun Heo414985a2013-11-28 14:54:34 -0500612{
Tejun Heo324a56e2013-12-11 14:11:53 -0500613 struct kernfs_node *kn = file->f_path.dentry->d_fsdata;
Tejun Heo555724a2014-05-12 13:56:27 -0400614 struct kernfs_root *root = kernfs_root(kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500615 const struct kernfs_ops *ops;
Tejun Heoc525aad2013-12-11 14:11:55 -0500616 struct kernfs_open_file *of;
Tejun Heo414985a2013-11-28 14:54:34 -0500617 bool has_read, has_write, has_mmap;
618 int error = -EACCES;
619
Tejun Heoc637b8a2013-12-11 14:11:58 -0500620 if (!kernfs_get_active(kn))
Tejun Heo414985a2013-11-28 14:54:34 -0500621 return -ENODEV;
622
Tejun Heo324a56e2013-12-11 14:11:53 -0500623 ops = kernfs_ops(kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500624
625 has_read = ops->seq_show || ops->read || ops->mmap;
626 has_write = ops->write || ops->mmap;
627 has_mmap = ops->mmap;
628
Tejun Heo555724a2014-05-12 13:56:27 -0400629 /* see the flag definition for details */
630 if (root->flags & KERNFS_ROOT_EXTRA_OPEN_PERM_CHECK) {
631 if ((file->f_mode & FMODE_WRITE) &&
632 (!(inode->i_mode & S_IWUGO) || !has_write))
633 goto err_out;
Tejun Heo414985a2013-11-28 14:54:34 -0500634
Tejun Heo555724a2014-05-12 13:56:27 -0400635 if ((file->f_mode & FMODE_READ) &&
636 (!(inode->i_mode & S_IRUGO) || !has_read))
637 goto err_out;
638 }
Tejun Heo414985a2013-11-28 14:54:34 -0500639
Tejun Heoc525aad2013-12-11 14:11:55 -0500640 /* allocate a kernfs_open_file for the file */
Tejun Heo414985a2013-11-28 14:54:34 -0500641 error = -ENOMEM;
Tejun Heoc525aad2013-12-11 14:11:55 -0500642 of = kzalloc(sizeof(struct kernfs_open_file), GFP_KERNEL);
Tejun Heo414985a2013-11-28 14:54:34 -0500643 if (!of)
644 goto err_out;
645
646 /*
647 * The following is done to give a different lockdep key to
648 * @of->mutex for files which implement mmap. This is a rather
649 * crude way to avoid false positive lockdep warning around
650 * mm->mmap_sem - mmap nests @of->mutex under mm->mmap_sem and
651 * reading /sys/block/sda/trace/act_mask grabs sr_mutex, under
652 * which mm->mmap_sem nests, while holding @of->mutex. As each
653 * open file has a separate mutex, it's okay as long as those don't
654 * happen on the same file. At this point, we can't easily give
655 * each file a separate locking class. Let's differentiate on
656 * whether the file has mmap or not for now.
Tejun Heo9b2db6e2013-12-10 09:29:17 -0500657 *
658 * Both paths of the branch look the same. They're supposed to
659 * look that way and give @of->mutex different static lockdep keys.
Tejun Heo414985a2013-11-28 14:54:34 -0500660 */
661 if (has_mmap)
662 mutex_init(&of->mutex);
663 else
664 mutex_init(&of->mutex);
665
Tejun Heo324a56e2013-12-11 14:11:53 -0500666 of->kn = kn;
Tejun Heo414985a2013-11-28 14:54:34 -0500667 of->file = file;
668
669 /*
Tejun Heob7ce40c2014-03-04 15:38:46 -0500670 * Write path needs to atomic_write_len outside active reference.
671 * Cache it in open_file. See kernfs_fop_write() for details.
672 */
673 of->atomic_write_len = ops->atomic_write_len;
674
NeilBrown4ef67a82014-10-14 16:57:26 +1100675 error = -EINVAL;
676 /*
677 * ->seq_show is incompatible with ->prealloc,
678 * as seq_read does its own allocation.
679 * ->read must be used instead.
680 */
681 if (ops->prealloc && ops->seq_show)
682 goto err_free;
NeilBrown2b758692014-10-13 16:41:28 +1100683 if (ops->prealloc) {
684 int len = of->atomic_write_len ?: PAGE_SIZE;
685 of->prealloc_buf = kmalloc(len + 1, GFP_KERNEL);
686 error = -ENOMEM;
687 if (!of->prealloc_buf)
688 goto err_free;
689 }
690
Tejun Heob7ce40c2014-03-04 15:38:46 -0500691 /*
Tejun Heo414985a2013-11-28 14:54:34 -0500692 * Always instantiate seq_file even if read access doesn't use
693 * seq_file or is not requested. This unifies private data access
694 * and readable regular files are the vast majority anyway.
695 */
696 if (ops->seq_show)
697 error = seq_open(file, &kernfs_seq_ops);
698 else
699 error = seq_open(file, NULL);
700 if (error)
701 goto err_free;
702
703 ((struct seq_file *)file->private_data)->private = of;
704
705 /* seq_file clears PWRITE unconditionally, restore it if WRITE */
706 if (file->f_mode & FMODE_WRITE)
707 file->f_mode |= FMODE_PWRITE;
708
Tejun Heoc637b8a2013-12-11 14:11:58 -0500709 /* make sure we have open node struct */
710 error = kernfs_get_open_node(kn, of);
Tejun Heo414985a2013-11-28 14:54:34 -0500711 if (error)
712 goto err_close;
713
714 /* open succeeded, put active references */
Tejun Heoc637b8a2013-12-11 14:11:58 -0500715 kernfs_put_active(kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500716 return 0;
717
718err_close:
719 seq_release(inode, file);
720err_free:
NeilBrown2b758692014-10-13 16:41:28 +1100721 kfree(of->prealloc_buf);
Tejun Heo414985a2013-11-28 14:54:34 -0500722 kfree(of);
723err_out:
Tejun Heoc637b8a2013-12-11 14:11:58 -0500724 kernfs_put_active(kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500725 return error;
726}
727
Tejun Heoc637b8a2013-12-11 14:11:58 -0500728static int kernfs_fop_release(struct inode *inode, struct file *filp)
Tejun Heo414985a2013-11-28 14:54:34 -0500729{
Tejun Heo324a56e2013-12-11 14:11:53 -0500730 struct kernfs_node *kn = filp->f_path.dentry->d_fsdata;
Tejun Heoc525aad2013-12-11 14:11:55 -0500731 struct kernfs_open_file *of = kernfs_of(filp);
Tejun Heo414985a2013-11-28 14:54:34 -0500732
Tejun Heoc637b8a2013-12-11 14:11:58 -0500733 kernfs_put_open_node(kn, of);
Tejun Heo414985a2013-11-28 14:54:34 -0500734 seq_release(inode, filp);
NeilBrown2b758692014-10-13 16:41:28 +1100735 kfree(of->prealloc_buf);
Tejun Heo414985a2013-11-28 14:54:34 -0500736 kfree(of);
737
738 return 0;
739}
740
Greg Kroah-Hartman55f6e302014-01-13 14:27:16 -0800741void kernfs_unmap_bin_file(struct kernfs_node *kn)
Tejun Heo414985a2013-11-28 14:54:34 -0500742{
Tejun Heoc525aad2013-12-11 14:11:55 -0500743 struct kernfs_open_node *on;
744 struct kernfs_open_file *of;
Tejun Heo414985a2013-11-28 14:54:34 -0500745
Greg Kroah-Hartman55f6e302014-01-13 14:27:16 -0800746 if (!(kn->flags & KERNFS_HAS_MMAP))
747 return;
748
Tejun Heoc525aad2013-12-11 14:11:55 -0500749 spin_lock_irq(&kernfs_open_node_lock);
750 on = kn->attr.open;
751 if (on)
752 atomic_inc(&on->refcnt);
753 spin_unlock_irq(&kernfs_open_node_lock);
754 if (!on)
Tejun Heo414985a2013-11-28 14:54:34 -0500755 return;
756
Tejun Heoc525aad2013-12-11 14:11:55 -0500757 mutex_lock(&kernfs_open_file_mutex);
758 list_for_each_entry(of, &on->files, list) {
Tejun Heo414985a2013-11-28 14:54:34 -0500759 struct inode *inode = file_inode(of->file);
760 unmap_mapping_range(inode->i_mapping, 0, 0, 1);
761 }
Tejun Heoc525aad2013-12-11 14:11:55 -0500762 mutex_unlock(&kernfs_open_file_mutex);
Tejun Heo414985a2013-11-28 14:54:34 -0500763
Tejun Heoc637b8a2013-12-11 14:11:58 -0500764 kernfs_put_open_node(kn, NULL);
Tejun Heo414985a2013-11-28 14:54:34 -0500765}
766
Tejun Heoc637b8a2013-12-11 14:11:58 -0500767/*
768 * Kernfs attribute files are pollable. The idea is that you read
Tejun Heo414985a2013-11-28 14:54:34 -0500769 * the content and then you use 'poll' or 'select' to wait for
770 * the content to change. When the content changes (assuming the
771 * manager for the kobject supports notification), poll will
772 * return POLLERR|POLLPRI, and select will return the fd whether
773 * it is waiting for read, write, or exceptions.
774 * Once poll/select indicates that the value has changed, you
775 * need to close and re-open the file, or seek to 0 and read again.
776 * Reminder: this only works for attributes which actively support
777 * it, and it is not possible to test an attribute from userspace
778 * to see if it supports poll (Neither 'poll' nor 'select' return
779 * an appropriate error code). When in doubt, set a suitable timeout value.
780 */
Tejun Heoc637b8a2013-12-11 14:11:58 -0500781static unsigned int kernfs_fop_poll(struct file *filp, poll_table *wait)
Tejun Heo414985a2013-11-28 14:54:34 -0500782{
Tejun Heoc525aad2013-12-11 14:11:55 -0500783 struct kernfs_open_file *of = kernfs_of(filp);
Tejun Heo324a56e2013-12-11 14:11:53 -0500784 struct kernfs_node *kn = filp->f_path.dentry->d_fsdata;
Tejun Heoc525aad2013-12-11 14:11:55 -0500785 struct kernfs_open_node *on = kn->attr.open;
Tejun Heo414985a2013-11-28 14:54:34 -0500786
787 /* need parent for the kobj, grab both */
Tejun Heoc637b8a2013-12-11 14:11:58 -0500788 if (!kernfs_get_active(kn))
Tejun Heo414985a2013-11-28 14:54:34 -0500789 goto trigger;
790
Tejun Heoc525aad2013-12-11 14:11:55 -0500791 poll_wait(filp, &on->poll, wait);
Tejun Heo414985a2013-11-28 14:54:34 -0500792
Tejun Heoc637b8a2013-12-11 14:11:58 -0500793 kernfs_put_active(kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500794
Tejun Heoc525aad2013-12-11 14:11:55 -0500795 if (of->event != atomic_read(&on->event))
Tejun Heo414985a2013-11-28 14:54:34 -0500796 goto trigger;
797
798 return DEFAULT_POLLMASK;
799
800 trigger:
801 return DEFAULT_POLLMASK|POLLERR|POLLPRI;
802}
803
Tejun Heoecca47c2014-07-01 16:41:03 -0400804static void kernfs_notify_workfn(struct work_struct *work)
Tejun Heo414985a2013-11-28 14:54:34 -0500805{
Tejun Heoecca47c2014-07-01 16:41:03 -0400806 struct kernfs_node *kn;
Tejun Heoc525aad2013-12-11 14:11:55 -0500807 struct kernfs_open_node *on;
Tejun Heod911d982014-04-09 11:07:31 -0400808 struct kernfs_super_info *info;
Tejun Heoecca47c2014-07-01 16:41:03 -0400809repeat:
810 /* pop one off the notify_list */
811 spin_lock_irq(&kernfs_notify_lock);
812 kn = kernfs_notify_list;
813 if (kn == KERNFS_NOTIFY_EOL) {
814 spin_unlock_irq(&kernfs_notify_lock);
Tejun Heod911d982014-04-09 11:07:31 -0400815 return;
Tejun Heoecca47c2014-07-01 16:41:03 -0400816 }
817 kernfs_notify_list = kn->attr.notify_next;
818 kn->attr.notify_next = NULL;
819 spin_unlock_irq(&kernfs_notify_lock);
Tejun Heod911d982014-04-09 11:07:31 -0400820
821 /* kick poll */
Tejun Heoecca47c2014-07-01 16:41:03 -0400822 spin_lock_irq(&kernfs_open_node_lock);
Tejun Heo414985a2013-11-28 14:54:34 -0500823
Tejun Heod911d982014-04-09 11:07:31 -0400824 on = kn->attr.open;
825 if (on) {
826 atomic_inc(&on->event);
827 wake_up_interruptible(&on->poll);
Tejun Heo414985a2013-11-28 14:54:34 -0500828 }
829
Tejun Heoecca47c2014-07-01 16:41:03 -0400830 spin_unlock_irq(&kernfs_open_node_lock);
Tejun Heod911d982014-04-09 11:07:31 -0400831
832 /* kick fsnotify */
833 mutex_lock(&kernfs_mutex);
834
Tejun Heoecca47c2014-07-01 16:41:03 -0400835 list_for_each_entry(info, &kernfs_root(kn)->supers, node) {
Tejun Heod911d982014-04-09 11:07:31 -0400836 struct inode *inode;
837 struct dentry *dentry;
838
839 inode = ilookup(info->sb, kn->ino);
840 if (!inode)
841 continue;
842
843 dentry = d_find_any_alias(inode);
844 if (dentry) {
845 fsnotify_parent(NULL, dentry, FS_MODIFY);
846 fsnotify(inode, FS_MODIFY, inode, FSNOTIFY_EVENT_INODE,
847 NULL, 0);
848 dput(dentry);
849 }
850
851 iput(inode);
852 }
853
854 mutex_unlock(&kernfs_mutex);
Tejun Heoecca47c2014-07-01 16:41:03 -0400855 kernfs_put(kn);
856 goto repeat;
857}
858
859/**
860 * kernfs_notify - notify a kernfs file
861 * @kn: file to notify
862 *
863 * Notify @kn such that poll(2) on @kn wakes up. Maybe be called from any
864 * context.
865 */
866void kernfs_notify(struct kernfs_node *kn)
867{
868 static DECLARE_WORK(kernfs_notify_work, kernfs_notify_workfn);
869 unsigned long flags;
870
871 if (WARN_ON(kernfs_type(kn) != KERNFS_FILE))
872 return;
873
874 spin_lock_irqsave(&kernfs_notify_lock, flags);
875 if (!kn->attr.notify_next) {
876 kernfs_get(kn);
877 kn->attr.notify_next = kernfs_notify_list;
878 kernfs_notify_list = kn;
879 schedule_work(&kernfs_notify_work);
880 }
881 spin_unlock_irqrestore(&kernfs_notify_lock, flags);
Tejun Heo414985a2013-11-28 14:54:34 -0500882}
883EXPORT_SYMBOL_GPL(kernfs_notify);
884
Tejun Heoa797bfc2013-12-11 14:11:57 -0500885const struct file_operations kernfs_file_fops = {
Tejun Heoc637b8a2013-12-11 14:11:58 -0500886 .read = kernfs_fop_read,
887 .write = kernfs_fop_write,
Tejun Heo414985a2013-11-28 14:54:34 -0500888 .llseek = generic_file_llseek,
Tejun Heoc637b8a2013-12-11 14:11:58 -0500889 .mmap = kernfs_fop_mmap,
890 .open = kernfs_fop_open,
891 .release = kernfs_fop_release,
892 .poll = kernfs_fop_poll,
Tejun Heo414985a2013-11-28 14:54:34 -0500893};
894
895/**
Tejun Heo2063d602013-12-11 16:02:57 -0500896 * __kernfs_create_file - kernfs internal function to create a file
Tejun Heo414985a2013-11-28 14:54:34 -0500897 * @parent: directory to create the file in
898 * @name: name of the file
899 * @mode: mode of the file
900 * @size: size of the file
901 * @ops: kernfs operations for the file
902 * @priv: private data for the file
903 * @ns: optional namespace tag of the file
Fabian Frederick8278bd32014-07-04 21:47:53 +0200904 * @name_is_static: don't copy file name
Tejun Heo414985a2013-11-28 14:54:34 -0500905 * @key: lockdep key for the file's active_ref, %NULL to disable lockdep
906 *
907 * Returns the created node on success, ERR_PTR() value on error.
908 */
Tejun Heo2063d602013-12-11 16:02:57 -0500909struct kernfs_node *__kernfs_create_file(struct kernfs_node *parent,
910 const char *name,
911 umode_t mode, loff_t size,
912 const struct kernfs_ops *ops,
913 void *priv, const void *ns,
914 bool name_is_static,
915 struct lock_class_key *key)
Tejun Heo414985a2013-11-28 14:54:34 -0500916{
Tejun Heo324a56e2013-12-11 14:11:53 -0500917 struct kernfs_node *kn;
Tejun Heo2063d602013-12-11 16:02:57 -0500918 unsigned flags;
Tejun Heo414985a2013-11-28 14:54:34 -0500919 int rc;
920
Tejun Heo2063d602013-12-11 16:02:57 -0500921 flags = KERNFS_FILE;
922 if (name_is_static)
923 flags |= KERNFS_STATIC_NAME;
924
Tejun Heodb4aad22014-01-17 09:58:25 -0500925 kn = kernfs_new_node(parent, name, (mode & S_IALLUGO) | S_IFREG, flags);
Tejun Heo324a56e2013-12-11 14:11:53 -0500926 if (!kn)
Tejun Heo414985a2013-11-28 14:54:34 -0500927 return ERR_PTR(-ENOMEM);
928
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500929 kn->attr.ops = ops;
930 kn->attr.size = size;
931 kn->ns = ns;
Tejun Heo324a56e2013-12-11 14:11:53 -0500932 kn->priv = priv;
Tejun Heo414985a2013-11-28 14:54:34 -0500933
934#ifdef CONFIG_DEBUG_LOCK_ALLOC
935 if (key) {
Tejun Heo324a56e2013-12-11 14:11:53 -0500936 lockdep_init_map(&kn->dep_map, "s_active", key, 0);
Tejun Heodf23fc32013-12-11 14:11:56 -0500937 kn->flags |= KERNFS_LOCKDEP;
Tejun Heo414985a2013-11-28 14:54:34 -0500938 }
939#endif
940
941 /*
Tejun Heoadc5e8b2013-12-11 14:11:54 -0500942 * kn->attr.ops is accesible only while holding active ref. We
Tejun Heo414985a2013-11-28 14:54:34 -0500943 * need to know whether some ops are implemented outside active
944 * ref. Cache their existence in flags.
945 */
946 if (ops->seq_show)
Tejun Heodf23fc32013-12-11 14:11:56 -0500947 kn->flags |= KERNFS_HAS_SEQ_SHOW;
Tejun Heo414985a2013-11-28 14:54:34 -0500948 if (ops->mmap)
Tejun Heodf23fc32013-12-11 14:11:56 -0500949 kn->flags |= KERNFS_HAS_MMAP;
Tejun Heo414985a2013-11-28 14:54:34 -0500950
Tejun Heo988cd7a2014-02-03 14:02:58 -0500951 rc = kernfs_add_one(kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500952 if (rc) {
Tejun Heo324a56e2013-12-11 14:11:53 -0500953 kernfs_put(kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500954 return ERR_PTR(rc);
955 }
Tejun Heo324a56e2013-12-11 14:11:53 -0500956 return kn;
Tejun Heo414985a2013-11-28 14:54:34 -0500957}