PM/PCI: Update PCI power management documentation
[linux-2.6/libata-dev.git] / fs / fuse / file.c
bloba9f5e137f1d31547f86bbfdb87df11c07daf963f
1 /*
2 FUSE: Filesystem in Userspace
3 Copyright (C) 2001-2008 Miklos Szeredi <miklos@szeredi.hu>
5 This program can be distributed under the terms of the GNU GPL.
6 See the file COPYING.
7 */
9 #include "fuse_i.h"
11 #include <linux/pagemap.h>
12 #include <linux/slab.h>
13 #include <linux/kernel.h>
14 #include <linux/sched.h>
15 #include <linux/module.h>
17 static const struct file_operations fuse_direct_io_file_operations;
19 static int fuse_send_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
20 int opcode, struct fuse_open_out *outargp)
22 struct fuse_open_in inarg;
23 struct fuse_req *req;
24 int err;
26 req = fuse_get_req(fc);
27 if (IS_ERR(req))
28 return PTR_ERR(req);
30 memset(&inarg, 0, sizeof(inarg));
31 inarg.flags = file->f_flags & ~(O_CREAT | O_EXCL | O_NOCTTY);
32 if (!fc->atomic_o_trunc)
33 inarg.flags &= ~O_TRUNC;
34 req->in.h.opcode = opcode;
35 req->in.h.nodeid = nodeid;
36 req->in.numargs = 1;
37 req->in.args[0].size = sizeof(inarg);
38 req->in.args[0].value = &inarg;
39 req->out.numargs = 1;
40 req->out.args[0].size = sizeof(*outargp);
41 req->out.args[0].value = outargp;
42 fuse_request_send(fc, req);
43 err = req->out.h.error;
44 fuse_put_request(fc, req);
46 return err;
49 struct fuse_file *fuse_file_alloc(struct fuse_conn *fc)
51 struct fuse_file *ff;
53 ff = kmalloc(sizeof(struct fuse_file), GFP_KERNEL);
54 if (unlikely(!ff))
55 return NULL;
57 ff->fc = fc;
58 ff->reserved_req = fuse_request_alloc();
59 if (unlikely(!ff->reserved_req)) {
60 kfree(ff);
61 return NULL;
64 INIT_LIST_HEAD(&ff->write_entry);
65 atomic_set(&ff->count, 0);
66 RB_CLEAR_NODE(&ff->polled_node);
67 init_waitqueue_head(&ff->poll_wait);
69 spin_lock(&fc->lock);
70 ff->kh = ++fc->khctr;
71 spin_unlock(&fc->lock);
73 return ff;
76 void fuse_file_free(struct fuse_file *ff)
78 fuse_request_free(ff->reserved_req);
79 kfree(ff);
82 struct fuse_file *fuse_file_get(struct fuse_file *ff)
84 atomic_inc(&ff->count);
85 return ff;
88 static void fuse_release_end(struct fuse_conn *fc, struct fuse_req *req)
90 path_put(&req->misc.release.path);
93 static void fuse_file_put(struct fuse_file *ff)
95 if (atomic_dec_and_test(&ff->count)) {
96 struct fuse_req *req = ff->reserved_req;
98 req->end = fuse_release_end;
99 fuse_request_send_background(ff->fc, req);
100 kfree(ff);
104 int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
105 bool isdir)
107 struct fuse_open_out outarg;
108 struct fuse_file *ff;
109 int err;
110 int opcode = isdir ? FUSE_OPENDIR : FUSE_OPEN;
112 ff = fuse_file_alloc(fc);
113 if (!ff)
114 return -ENOMEM;
116 err = fuse_send_open(fc, nodeid, file, opcode, &outarg);
117 if (err) {
118 fuse_file_free(ff);
119 return err;
122 if (isdir)
123 outarg.open_flags &= ~FOPEN_DIRECT_IO;
125 ff->fh = outarg.fh;
126 ff->nodeid = nodeid;
127 ff->open_flags = outarg.open_flags;
128 file->private_data = fuse_file_get(ff);
130 return 0;
132 EXPORT_SYMBOL_GPL(fuse_do_open);
134 void fuse_finish_open(struct inode *inode, struct file *file)
136 struct fuse_file *ff = file->private_data;
138 if (ff->open_flags & FOPEN_DIRECT_IO)
139 file->f_op = &fuse_direct_io_file_operations;
140 if (!(ff->open_flags & FOPEN_KEEP_CACHE))
141 invalidate_inode_pages2(inode->i_mapping);
142 if (ff->open_flags & FOPEN_NONSEEKABLE)
143 nonseekable_open(inode, file);
146 int fuse_open_common(struct inode *inode, struct file *file, bool isdir)
148 struct fuse_conn *fc = get_fuse_conn(inode);
149 int err;
151 /* VFS checks this, but only _after_ ->open() */
152 if (file->f_flags & O_DIRECT)
153 return -EINVAL;
155 err = generic_file_open(inode, file);
156 if (err)
157 return err;
159 err = fuse_do_open(fc, get_node_id(inode), file, isdir);
160 if (err)
161 return err;
163 fuse_finish_open(inode, file);
165 return 0;
168 static void fuse_prepare_release(struct fuse_file *ff, int flags, int opcode)
170 struct fuse_conn *fc = ff->fc;
171 struct fuse_req *req = ff->reserved_req;
172 struct fuse_release_in *inarg = &req->misc.release.in;
174 spin_lock(&fc->lock);
175 list_del(&ff->write_entry);
176 if (!RB_EMPTY_NODE(&ff->polled_node))
177 rb_erase(&ff->polled_node, &fc->polled_files);
178 spin_unlock(&fc->lock);
180 wake_up_interruptible_sync(&ff->poll_wait);
182 inarg->fh = ff->fh;
183 inarg->flags = flags;
184 req->in.h.opcode = opcode;
185 req->in.h.nodeid = ff->nodeid;
186 req->in.numargs = 1;
187 req->in.args[0].size = sizeof(struct fuse_release_in);
188 req->in.args[0].value = inarg;
191 void fuse_release_common(struct file *file, int opcode)
193 struct fuse_file *ff;
194 struct fuse_req *req;
196 ff = file->private_data;
197 if (unlikely(!ff))
198 return;
200 req = ff->reserved_req;
201 fuse_prepare_release(ff, file->f_flags, opcode);
203 /* Hold vfsmount and dentry until release is finished */
204 path_get(&file->f_path);
205 req->misc.release.path = file->f_path;
208 * Normally this will send the RELEASE request, however if
209 * some asynchronous READ or WRITE requests are outstanding,
210 * the sending will be delayed.
212 fuse_file_put(ff);
215 static int fuse_open(struct inode *inode, struct file *file)
217 return fuse_open_common(inode, file, false);
220 static int fuse_release(struct inode *inode, struct file *file)
222 fuse_release_common(file, FUSE_RELEASE);
224 /* return value is ignored by VFS */
225 return 0;
228 void fuse_sync_release(struct fuse_file *ff, int flags)
230 WARN_ON(atomic_read(&ff->count) > 1);
231 fuse_prepare_release(ff, flags, FUSE_RELEASE);
232 ff->reserved_req->force = 1;
233 fuse_request_send(ff->fc, ff->reserved_req);
234 fuse_put_request(ff->fc, ff->reserved_req);
235 kfree(ff);
237 EXPORT_SYMBOL_GPL(fuse_sync_release);
240 * Scramble the ID space with XTEA, so that the value of the files_struct
241 * pointer is not exposed to userspace.
243 u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id)
245 u32 *k = fc->scramble_key;
246 u64 v = (unsigned long) id;
247 u32 v0 = v;
248 u32 v1 = v >> 32;
249 u32 sum = 0;
250 int i;
252 for (i = 0; i < 32; i++) {
253 v0 += ((v1 << 4 ^ v1 >> 5) + v1) ^ (sum + k[sum & 3]);
254 sum += 0x9E3779B9;
255 v1 += ((v0 << 4 ^ v0 >> 5) + v0) ^ (sum + k[sum>>11 & 3]);
258 return (u64) v0 + ((u64) v1 << 32);
262 * Check if page is under writeback
264 * This is currently done by walking the list of writepage requests
265 * for the inode, which can be pretty inefficient.
267 static bool fuse_page_is_writeback(struct inode *inode, pgoff_t index)
269 struct fuse_conn *fc = get_fuse_conn(inode);
270 struct fuse_inode *fi = get_fuse_inode(inode);
271 struct fuse_req *req;
272 bool found = false;
274 spin_lock(&fc->lock);
275 list_for_each_entry(req, &fi->writepages, writepages_entry) {
276 pgoff_t curr_index;
278 BUG_ON(req->inode != inode);
279 curr_index = req->misc.write.in.offset >> PAGE_CACHE_SHIFT;
280 if (curr_index == index) {
281 found = true;
282 break;
285 spin_unlock(&fc->lock);
287 return found;
291 * Wait for page writeback to be completed.
293 * Since fuse doesn't rely on the VM writeback tracking, this has to
294 * use some other means.
296 static int fuse_wait_on_page_writeback(struct inode *inode, pgoff_t index)
298 struct fuse_inode *fi = get_fuse_inode(inode);
300 wait_event(fi->page_waitq, !fuse_page_is_writeback(inode, index));
301 return 0;
304 static int fuse_flush(struct file *file, fl_owner_t id)
306 struct inode *inode = file->f_path.dentry->d_inode;
307 struct fuse_conn *fc = get_fuse_conn(inode);
308 struct fuse_file *ff = file->private_data;
309 struct fuse_req *req;
310 struct fuse_flush_in inarg;
311 int err;
313 if (is_bad_inode(inode))
314 return -EIO;
316 if (fc->no_flush)
317 return 0;
319 req = fuse_get_req_nofail(fc, file);
320 memset(&inarg, 0, sizeof(inarg));
321 inarg.fh = ff->fh;
322 inarg.lock_owner = fuse_lock_owner_id(fc, id);
323 req->in.h.opcode = FUSE_FLUSH;
324 req->in.h.nodeid = get_node_id(inode);
325 req->in.numargs = 1;
326 req->in.args[0].size = sizeof(inarg);
327 req->in.args[0].value = &inarg;
328 req->force = 1;
329 fuse_request_send(fc, req);
330 err = req->out.h.error;
331 fuse_put_request(fc, req);
332 if (err == -ENOSYS) {
333 fc->no_flush = 1;
334 err = 0;
336 return err;
340 * Wait for all pending writepages on the inode to finish.
342 * This is currently done by blocking further writes with FUSE_NOWRITE
343 * and waiting for all sent writes to complete.
345 * This must be called under i_mutex, otherwise the FUSE_NOWRITE usage
346 * could conflict with truncation.
348 static void fuse_sync_writes(struct inode *inode)
350 fuse_set_nowrite(inode);
351 fuse_release_nowrite(inode);
354 int fuse_fsync_common(struct file *file, struct dentry *de, int datasync,
355 int isdir)
357 struct inode *inode = de->d_inode;
358 struct fuse_conn *fc = get_fuse_conn(inode);
359 struct fuse_file *ff = file->private_data;
360 struct fuse_req *req;
361 struct fuse_fsync_in inarg;
362 int err;
364 if (is_bad_inode(inode))
365 return -EIO;
367 if ((!isdir && fc->no_fsync) || (isdir && fc->no_fsyncdir))
368 return 0;
371 * Start writeback against all dirty pages of the inode, then
372 * wait for all outstanding writes, before sending the FSYNC
373 * request.
375 err = write_inode_now(inode, 0);
376 if (err)
377 return err;
379 fuse_sync_writes(inode);
381 req = fuse_get_req(fc);
382 if (IS_ERR(req))
383 return PTR_ERR(req);
385 memset(&inarg, 0, sizeof(inarg));
386 inarg.fh = ff->fh;
387 inarg.fsync_flags = datasync ? 1 : 0;
388 req->in.h.opcode = isdir ? FUSE_FSYNCDIR : FUSE_FSYNC;
389 req->in.h.nodeid = get_node_id(inode);
390 req->in.numargs = 1;
391 req->in.args[0].size = sizeof(inarg);
392 req->in.args[0].value = &inarg;
393 fuse_request_send(fc, req);
394 err = req->out.h.error;
395 fuse_put_request(fc, req);
396 if (err == -ENOSYS) {
397 if (isdir)
398 fc->no_fsyncdir = 1;
399 else
400 fc->no_fsync = 1;
401 err = 0;
403 return err;
406 static int fuse_fsync(struct file *file, struct dentry *de, int datasync)
408 return fuse_fsync_common(file, de, datasync, 0);
411 void fuse_read_fill(struct fuse_req *req, struct file *file, loff_t pos,
412 size_t count, int opcode)
414 struct fuse_read_in *inarg = &req->misc.read.in;
415 struct fuse_file *ff = file->private_data;
417 inarg->fh = ff->fh;
418 inarg->offset = pos;
419 inarg->size = count;
420 inarg->flags = file->f_flags;
421 req->in.h.opcode = opcode;
422 req->in.h.nodeid = ff->nodeid;
423 req->in.numargs = 1;
424 req->in.args[0].size = sizeof(struct fuse_read_in);
425 req->in.args[0].value = inarg;
426 req->out.argvar = 1;
427 req->out.numargs = 1;
428 req->out.args[0].size = count;
431 static size_t fuse_send_read(struct fuse_req *req, struct file *file,
432 loff_t pos, size_t count, fl_owner_t owner)
434 struct fuse_file *ff = file->private_data;
435 struct fuse_conn *fc = ff->fc;
437 fuse_read_fill(req, file, pos, count, FUSE_READ);
438 if (owner != NULL) {
439 struct fuse_read_in *inarg = &req->misc.read.in;
441 inarg->read_flags |= FUSE_READ_LOCKOWNER;
442 inarg->lock_owner = fuse_lock_owner_id(fc, owner);
444 fuse_request_send(fc, req);
445 return req->out.args[0].size;
448 static void fuse_read_update_size(struct inode *inode, loff_t size,
449 u64 attr_ver)
451 struct fuse_conn *fc = get_fuse_conn(inode);
452 struct fuse_inode *fi = get_fuse_inode(inode);
454 spin_lock(&fc->lock);
455 if (attr_ver == fi->attr_version && size < inode->i_size) {
456 fi->attr_version = ++fc->attr_version;
457 i_size_write(inode, size);
459 spin_unlock(&fc->lock);
462 static int fuse_readpage(struct file *file, struct page *page)
464 struct inode *inode = page->mapping->host;
465 struct fuse_conn *fc = get_fuse_conn(inode);
466 struct fuse_req *req;
467 size_t num_read;
468 loff_t pos = page_offset(page);
469 size_t count = PAGE_CACHE_SIZE;
470 u64 attr_ver;
471 int err;
473 err = -EIO;
474 if (is_bad_inode(inode))
475 goto out;
478 * Page writeback can extend beyond the liftime of the
479 * page-cache page, so make sure we read a properly synced
480 * page.
482 fuse_wait_on_page_writeback(inode, page->index);
484 req = fuse_get_req(fc);
485 err = PTR_ERR(req);
486 if (IS_ERR(req))
487 goto out;
489 attr_ver = fuse_get_attr_version(fc);
491 req->out.page_zeroing = 1;
492 req->out.argpages = 1;
493 req->num_pages = 1;
494 req->pages[0] = page;
495 num_read = fuse_send_read(req, file, pos, count, NULL);
496 err = req->out.h.error;
497 fuse_put_request(fc, req);
499 if (!err) {
501 * Short read means EOF. If file size is larger, truncate it
503 if (num_read < count)
504 fuse_read_update_size(inode, pos + num_read, attr_ver);
506 SetPageUptodate(page);
509 fuse_invalidate_attr(inode); /* atime changed */
510 out:
511 unlock_page(page);
512 return err;
515 static void fuse_readpages_end(struct fuse_conn *fc, struct fuse_req *req)
517 int i;
518 size_t count = req->misc.read.in.size;
519 size_t num_read = req->out.args[0].size;
520 struct inode *inode = req->pages[0]->mapping->host;
523 * Short read means EOF. If file size is larger, truncate it
525 if (!req->out.h.error && num_read < count) {
526 loff_t pos = page_offset(req->pages[0]) + num_read;
527 fuse_read_update_size(inode, pos, req->misc.read.attr_ver);
530 fuse_invalidate_attr(inode); /* atime changed */
532 for (i = 0; i < req->num_pages; i++) {
533 struct page *page = req->pages[i];
534 if (!req->out.h.error)
535 SetPageUptodate(page);
536 else
537 SetPageError(page);
538 unlock_page(page);
540 if (req->ff)
541 fuse_file_put(req->ff);
544 static void fuse_send_readpages(struct fuse_req *req, struct file *file)
546 struct fuse_file *ff = file->private_data;
547 struct fuse_conn *fc = ff->fc;
548 loff_t pos = page_offset(req->pages[0]);
549 size_t count = req->num_pages << PAGE_CACHE_SHIFT;
551 req->out.argpages = 1;
552 req->out.page_zeroing = 1;
553 fuse_read_fill(req, file, pos, count, FUSE_READ);
554 req->misc.read.attr_ver = fuse_get_attr_version(fc);
555 if (fc->async_read) {
556 req->ff = fuse_file_get(ff);
557 req->end = fuse_readpages_end;
558 fuse_request_send_background(fc, req);
559 } else {
560 fuse_request_send(fc, req);
561 fuse_readpages_end(fc, req);
562 fuse_put_request(fc, req);
566 struct fuse_fill_data {
567 struct fuse_req *req;
568 struct file *file;
569 struct inode *inode;
572 static int fuse_readpages_fill(void *_data, struct page *page)
574 struct fuse_fill_data *data = _data;
575 struct fuse_req *req = data->req;
576 struct inode *inode = data->inode;
577 struct fuse_conn *fc = get_fuse_conn(inode);
579 fuse_wait_on_page_writeback(inode, page->index);
581 if (req->num_pages &&
582 (req->num_pages == FUSE_MAX_PAGES_PER_REQ ||
583 (req->num_pages + 1) * PAGE_CACHE_SIZE > fc->max_read ||
584 req->pages[req->num_pages - 1]->index + 1 != page->index)) {
585 fuse_send_readpages(req, data->file);
586 data->req = req = fuse_get_req(fc);
587 if (IS_ERR(req)) {
588 unlock_page(page);
589 return PTR_ERR(req);
592 req->pages[req->num_pages] = page;
593 req->num_pages++;
594 return 0;
597 static int fuse_readpages(struct file *file, struct address_space *mapping,
598 struct list_head *pages, unsigned nr_pages)
600 struct inode *inode = mapping->host;
601 struct fuse_conn *fc = get_fuse_conn(inode);
602 struct fuse_fill_data data;
603 int err;
605 err = -EIO;
606 if (is_bad_inode(inode))
607 goto out;
609 data.file = file;
610 data.inode = inode;
611 data.req = fuse_get_req(fc);
612 err = PTR_ERR(data.req);
613 if (IS_ERR(data.req))
614 goto out;
616 err = read_cache_pages(mapping, pages, fuse_readpages_fill, &data);
617 if (!err) {
618 if (data.req->num_pages)
619 fuse_send_readpages(data.req, file);
620 else
621 fuse_put_request(fc, data.req);
623 out:
624 return err;
627 static ssize_t fuse_file_aio_read(struct kiocb *iocb, const struct iovec *iov,
628 unsigned long nr_segs, loff_t pos)
630 struct inode *inode = iocb->ki_filp->f_mapping->host;
632 if (pos + iov_length(iov, nr_segs) > i_size_read(inode)) {
633 int err;
635 * If trying to read past EOF, make sure the i_size
636 * attribute is up-to-date.
638 err = fuse_update_attributes(inode, NULL, iocb->ki_filp, NULL);
639 if (err)
640 return err;
643 return generic_file_aio_read(iocb, iov, nr_segs, pos);
646 static void fuse_write_fill(struct fuse_req *req, struct fuse_file *ff,
647 loff_t pos, size_t count)
649 struct fuse_write_in *inarg = &req->misc.write.in;
650 struct fuse_write_out *outarg = &req->misc.write.out;
652 inarg->fh = ff->fh;
653 inarg->offset = pos;
654 inarg->size = count;
655 req->in.h.opcode = FUSE_WRITE;
656 req->in.h.nodeid = ff->nodeid;
657 req->in.numargs = 2;
658 if (ff->fc->minor < 9)
659 req->in.args[0].size = FUSE_COMPAT_WRITE_IN_SIZE;
660 else
661 req->in.args[0].size = sizeof(struct fuse_write_in);
662 req->in.args[0].value = inarg;
663 req->in.args[1].size = count;
664 req->out.numargs = 1;
665 req->out.args[0].size = sizeof(struct fuse_write_out);
666 req->out.args[0].value = outarg;
669 static size_t fuse_send_write(struct fuse_req *req, struct file *file,
670 loff_t pos, size_t count, fl_owner_t owner)
672 struct fuse_file *ff = file->private_data;
673 struct fuse_conn *fc = ff->fc;
674 struct fuse_write_in *inarg = &req->misc.write.in;
676 fuse_write_fill(req, ff, pos, count);
677 inarg->flags = file->f_flags;
678 if (owner != NULL) {
679 inarg->write_flags |= FUSE_WRITE_LOCKOWNER;
680 inarg->lock_owner = fuse_lock_owner_id(fc, owner);
682 fuse_request_send(fc, req);
683 return req->misc.write.out.size;
686 static int fuse_write_begin(struct file *file, struct address_space *mapping,
687 loff_t pos, unsigned len, unsigned flags,
688 struct page **pagep, void **fsdata)
690 pgoff_t index = pos >> PAGE_CACHE_SHIFT;
692 *pagep = grab_cache_page_write_begin(mapping, index, flags);
693 if (!*pagep)
694 return -ENOMEM;
695 return 0;
698 static void fuse_write_update_size(struct inode *inode, loff_t pos)
700 struct fuse_conn *fc = get_fuse_conn(inode);
701 struct fuse_inode *fi = get_fuse_inode(inode);
703 spin_lock(&fc->lock);
704 fi->attr_version = ++fc->attr_version;
705 if (pos > inode->i_size)
706 i_size_write(inode, pos);
707 spin_unlock(&fc->lock);
710 static int fuse_buffered_write(struct file *file, struct inode *inode,
711 loff_t pos, unsigned count, struct page *page)
713 int err;
714 size_t nres;
715 struct fuse_conn *fc = get_fuse_conn(inode);
716 unsigned offset = pos & (PAGE_CACHE_SIZE - 1);
717 struct fuse_req *req;
719 if (is_bad_inode(inode))
720 return -EIO;
723 * Make sure writepages on the same page are not mixed up with
724 * plain writes.
726 fuse_wait_on_page_writeback(inode, page->index);
728 req = fuse_get_req(fc);
729 if (IS_ERR(req))
730 return PTR_ERR(req);
732 req->in.argpages = 1;
733 req->num_pages = 1;
734 req->pages[0] = page;
735 req->page_offset = offset;
736 nres = fuse_send_write(req, file, pos, count, NULL);
737 err = req->out.h.error;
738 fuse_put_request(fc, req);
739 if (!err && !nres)
740 err = -EIO;
741 if (!err) {
742 pos += nres;
743 fuse_write_update_size(inode, pos);
744 if (count == PAGE_CACHE_SIZE)
745 SetPageUptodate(page);
747 fuse_invalidate_attr(inode);
748 return err ? err : nres;
751 static int fuse_write_end(struct file *file, struct address_space *mapping,
752 loff_t pos, unsigned len, unsigned copied,
753 struct page *page, void *fsdata)
755 struct inode *inode = mapping->host;
756 int res = 0;
758 if (copied)
759 res = fuse_buffered_write(file, inode, pos, copied, page);
761 unlock_page(page);
762 page_cache_release(page);
763 return res;
766 static size_t fuse_send_write_pages(struct fuse_req *req, struct file *file,
767 struct inode *inode, loff_t pos,
768 size_t count)
770 size_t res;
771 unsigned offset;
772 unsigned i;
774 for (i = 0; i < req->num_pages; i++)
775 fuse_wait_on_page_writeback(inode, req->pages[i]->index);
777 res = fuse_send_write(req, file, pos, count, NULL);
779 offset = req->page_offset;
780 count = res;
781 for (i = 0; i < req->num_pages; i++) {
782 struct page *page = req->pages[i];
784 if (!req->out.h.error && !offset && count >= PAGE_CACHE_SIZE)
785 SetPageUptodate(page);
787 if (count > PAGE_CACHE_SIZE - offset)
788 count -= PAGE_CACHE_SIZE - offset;
789 else
790 count = 0;
791 offset = 0;
793 unlock_page(page);
794 page_cache_release(page);
797 return res;
800 static ssize_t fuse_fill_write_pages(struct fuse_req *req,
801 struct address_space *mapping,
802 struct iov_iter *ii, loff_t pos)
804 struct fuse_conn *fc = get_fuse_conn(mapping->host);
805 unsigned offset = pos & (PAGE_CACHE_SIZE - 1);
806 size_t count = 0;
807 int err;
809 req->in.argpages = 1;
810 req->page_offset = offset;
812 do {
813 size_t tmp;
814 struct page *page;
815 pgoff_t index = pos >> PAGE_CACHE_SHIFT;
816 size_t bytes = min_t(size_t, PAGE_CACHE_SIZE - offset,
817 iov_iter_count(ii));
819 bytes = min_t(size_t, bytes, fc->max_write - count);
821 again:
822 err = -EFAULT;
823 if (iov_iter_fault_in_readable(ii, bytes))
824 break;
826 err = -ENOMEM;
827 page = grab_cache_page_write_begin(mapping, index, 0);
828 if (!page)
829 break;
831 if (mapping_writably_mapped(mapping))
832 flush_dcache_page(page);
834 pagefault_disable();
835 tmp = iov_iter_copy_from_user_atomic(page, ii, offset, bytes);
836 pagefault_enable();
837 flush_dcache_page(page);
839 if (!tmp) {
840 unlock_page(page);
841 page_cache_release(page);
842 bytes = min(bytes, iov_iter_single_seg_count(ii));
843 goto again;
846 err = 0;
847 req->pages[req->num_pages] = page;
848 req->num_pages++;
850 iov_iter_advance(ii, tmp);
851 count += tmp;
852 pos += tmp;
853 offset += tmp;
854 if (offset == PAGE_CACHE_SIZE)
855 offset = 0;
857 if (!fc->big_writes)
858 break;
859 } while (iov_iter_count(ii) && count < fc->max_write &&
860 req->num_pages < FUSE_MAX_PAGES_PER_REQ && offset == 0);
862 return count > 0 ? count : err;
865 static ssize_t fuse_perform_write(struct file *file,
866 struct address_space *mapping,
867 struct iov_iter *ii, loff_t pos)
869 struct inode *inode = mapping->host;
870 struct fuse_conn *fc = get_fuse_conn(inode);
871 int err = 0;
872 ssize_t res = 0;
874 if (is_bad_inode(inode))
875 return -EIO;
877 do {
878 struct fuse_req *req;
879 ssize_t count;
881 req = fuse_get_req(fc);
882 if (IS_ERR(req)) {
883 err = PTR_ERR(req);
884 break;
887 count = fuse_fill_write_pages(req, mapping, ii, pos);
888 if (count <= 0) {
889 err = count;
890 } else {
891 size_t num_written;
893 num_written = fuse_send_write_pages(req, file, inode,
894 pos, count);
895 err = req->out.h.error;
896 if (!err) {
897 res += num_written;
898 pos += num_written;
900 /* break out of the loop on short write */
901 if (num_written != count)
902 err = -EIO;
905 fuse_put_request(fc, req);
906 } while (!err && iov_iter_count(ii));
908 if (res > 0)
909 fuse_write_update_size(inode, pos);
911 fuse_invalidate_attr(inode);
913 return res > 0 ? res : err;
916 static ssize_t fuse_file_aio_write(struct kiocb *iocb, const struct iovec *iov,
917 unsigned long nr_segs, loff_t pos)
919 struct file *file = iocb->ki_filp;
920 struct address_space *mapping = file->f_mapping;
921 size_t count = 0;
922 ssize_t written = 0;
923 struct inode *inode = mapping->host;
924 ssize_t err;
925 struct iov_iter i;
927 WARN_ON(iocb->ki_pos != pos);
929 err = generic_segment_checks(iov, &nr_segs, &count, VERIFY_READ);
930 if (err)
931 return err;
933 mutex_lock(&inode->i_mutex);
934 vfs_check_frozen(inode->i_sb, SB_FREEZE_WRITE);
936 /* We can write back this queue in page reclaim */
937 current->backing_dev_info = mapping->backing_dev_info;
939 err = generic_write_checks(file, &pos, &count, S_ISBLK(inode->i_mode));
940 if (err)
941 goto out;
943 if (count == 0)
944 goto out;
946 err = file_remove_suid(file);
947 if (err)
948 goto out;
950 file_update_time(file);
952 iov_iter_init(&i, iov, nr_segs, count, 0);
953 written = fuse_perform_write(file, mapping, &i, pos);
954 if (written >= 0)
955 iocb->ki_pos = pos + written;
957 out:
958 current->backing_dev_info = NULL;
959 mutex_unlock(&inode->i_mutex);
961 return written ? written : err;
964 static void fuse_release_user_pages(struct fuse_req *req, int write)
966 unsigned i;
968 for (i = 0; i < req->num_pages; i++) {
969 struct page *page = req->pages[i];
970 if (write)
971 set_page_dirty_lock(page);
972 put_page(page);
976 static int fuse_get_user_pages(struct fuse_req *req, const char __user *buf,
977 size_t *nbytesp, int write)
979 size_t nbytes = *nbytesp;
980 unsigned long user_addr = (unsigned long) buf;
981 unsigned offset = user_addr & ~PAGE_MASK;
982 int npages;
984 /* Special case for kernel I/O: can copy directly into the buffer */
985 if (segment_eq(get_fs(), KERNEL_DS)) {
986 if (write)
987 req->in.args[1].value = (void *) user_addr;
988 else
989 req->out.args[0].value = (void *) user_addr;
991 return 0;
994 nbytes = min_t(size_t, nbytes, FUSE_MAX_PAGES_PER_REQ << PAGE_SHIFT);
995 npages = (nbytes + offset + PAGE_SIZE - 1) >> PAGE_SHIFT;
996 npages = clamp(npages, 1, FUSE_MAX_PAGES_PER_REQ);
997 down_read(&current->mm->mmap_sem);
998 npages = get_user_pages(current, current->mm, user_addr, npages, !write,
999 0, req->pages, NULL);
1000 up_read(&current->mm->mmap_sem);
1001 if (npages < 0)
1002 return npages;
1004 req->num_pages = npages;
1005 req->page_offset = offset;
1007 if (write)
1008 req->in.argpages = 1;
1009 else
1010 req->out.argpages = 1;
1012 nbytes = (req->num_pages << PAGE_SHIFT) - req->page_offset;
1013 *nbytesp = min(*nbytesp, nbytes);
1015 return 0;
1018 ssize_t fuse_direct_io(struct file *file, const char __user *buf,
1019 size_t count, loff_t *ppos, int write)
1021 struct fuse_file *ff = file->private_data;
1022 struct fuse_conn *fc = ff->fc;
1023 size_t nmax = write ? fc->max_write : fc->max_read;
1024 loff_t pos = *ppos;
1025 ssize_t res = 0;
1026 struct fuse_req *req;
1028 req = fuse_get_req(fc);
1029 if (IS_ERR(req))
1030 return PTR_ERR(req);
1032 while (count) {
1033 size_t nres;
1034 fl_owner_t owner = current->files;
1035 size_t nbytes = min(count, nmax);
1036 int err = fuse_get_user_pages(req, buf, &nbytes, write);
1037 if (err) {
1038 res = err;
1039 break;
1042 if (write)
1043 nres = fuse_send_write(req, file, pos, nbytes, owner);
1044 else
1045 nres = fuse_send_read(req, file, pos, nbytes, owner);
1047 fuse_release_user_pages(req, !write);
1048 if (req->out.h.error) {
1049 if (!res)
1050 res = req->out.h.error;
1051 break;
1052 } else if (nres > nbytes) {
1053 res = -EIO;
1054 break;
1056 count -= nres;
1057 res += nres;
1058 pos += nres;
1059 buf += nres;
1060 if (nres != nbytes)
1061 break;
1062 if (count) {
1063 fuse_put_request(fc, req);
1064 req = fuse_get_req(fc);
1065 if (IS_ERR(req))
1066 break;
1069 if (!IS_ERR(req))
1070 fuse_put_request(fc, req);
1071 if (res > 0)
1072 *ppos = pos;
1074 return res;
1076 EXPORT_SYMBOL_GPL(fuse_direct_io);
1078 static ssize_t fuse_direct_read(struct file *file, char __user *buf,
1079 size_t count, loff_t *ppos)
1081 ssize_t res;
1082 struct inode *inode = file->f_path.dentry->d_inode;
1084 if (is_bad_inode(inode))
1085 return -EIO;
1087 res = fuse_direct_io(file, buf, count, ppos, 0);
1089 fuse_invalidate_attr(inode);
1091 return res;
1094 static ssize_t fuse_direct_write(struct file *file, const char __user *buf,
1095 size_t count, loff_t *ppos)
1097 struct inode *inode = file->f_path.dentry->d_inode;
1098 ssize_t res;
1100 if (is_bad_inode(inode))
1101 return -EIO;
1103 /* Don't allow parallel writes to the same file */
1104 mutex_lock(&inode->i_mutex);
1105 res = generic_write_checks(file, ppos, &count, 0);
1106 if (!res) {
1107 res = fuse_direct_io(file, buf, count, ppos, 1);
1108 if (res > 0)
1109 fuse_write_update_size(inode, *ppos);
1111 mutex_unlock(&inode->i_mutex);
1113 fuse_invalidate_attr(inode);
1115 return res;
1118 static void fuse_writepage_free(struct fuse_conn *fc, struct fuse_req *req)
1120 __free_page(req->pages[0]);
1121 fuse_file_put(req->ff);
1124 static void fuse_writepage_finish(struct fuse_conn *fc, struct fuse_req *req)
1126 struct inode *inode = req->inode;
1127 struct fuse_inode *fi = get_fuse_inode(inode);
1128 struct backing_dev_info *bdi = inode->i_mapping->backing_dev_info;
1130 list_del(&req->writepages_entry);
1131 dec_bdi_stat(bdi, BDI_WRITEBACK);
1132 dec_zone_page_state(req->pages[0], NR_WRITEBACK_TEMP);
1133 bdi_writeout_inc(bdi);
1134 wake_up(&fi->page_waitq);
1137 /* Called under fc->lock, may release and reacquire it */
1138 static void fuse_send_writepage(struct fuse_conn *fc, struct fuse_req *req)
1139 __releases(&fc->lock)
1140 __acquires(&fc->lock)
1142 struct fuse_inode *fi = get_fuse_inode(req->inode);
1143 loff_t size = i_size_read(req->inode);
1144 struct fuse_write_in *inarg = &req->misc.write.in;
1146 if (!fc->connected)
1147 goto out_free;
1149 if (inarg->offset + PAGE_CACHE_SIZE <= size) {
1150 inarg->size = PAGE_CACHE_SIZE;
1151 } else if (inarg->offset < size) {
1152 inarg->size = size & (PAGE_CACHE_SIZE - 1);
1153 } else {
1154 /* Got truncated off completely */
1155 goto out_free;
1158 req->in.args[1].size = inarg->size;
1159 fi->writectr++;
1160 fuse_request_send_background_locked(fc, req);
1161 return;
1163 out_free:
1164 fuse_writepage_finish(fc, req);
1165 spin_unlock(&fc->lock);
1166 fuse_writepage_free(fc, req);
1167 fuse_put_request(fc, req);
1168 spin_lock(&fc->lock);
1172 * If fi->writectr is positive (no truncate or fsync going on) send
1173 * all queued writepage requests.
1175 * Called with fc->lock
1177 void fuse_flush_writepages(struct inode *inode)
1178 __releases(&fc->lock)
1179 __acquires(&fc->lock)
1181 struct fuse_conn *fc = get_fuse_conn(inode);
1182 struct fuse_inode *fi = get_fuse_inode(inode);
1183 struct fuse_req *req;
1185 while (fi->writectr >= 0 && !list_empty(&fi->queued_writes)) {
1186 req = list_entry(fi->queued_writes.next, struct fuse_req, list);
1187 list_del_init(&req->list);
1188 fuse_send_writepage(fc, req);
1192 static void fuse_writepage_end(struct fuse_conn *fc, struct fuse_req *req)
1194 struct inode *inode = req->inode;
1195 struct fuse_inode *fi = get_fuse_inode(inode);
1197 mapping_set_error(inode->i_mapping, req->out.h.error);
1198 spin_lock(&fc->lock);
1199 fi->writectr--;
1200 fuse_writepage_finish(fc, req);
1201 spin_unlock(&fc->lock);
1202 fuse_writepage_free(fc, req);
1205 static int fuse_writepage_locked(struct page *page)
1207 struct address_space *mapping = page->mapping;
1208 struct inode *inode = mapping->host;
1209 struct fuse_conn *fc = get_fuse_conn(inode);
1210 struct fuse_inode *fi = get_fuse_inode(inode);
1211 struct fuse_req *req;
1212 struct fuse_file *ff;
1213 struct page *tmp_page;
1215 set_page_writeback(page);
1217 req = fuse_request_alloc_nofs();
1218 if (!req)
1219 goto err;
1221 tmp_page = alloc_page(GFP_NOFS | __GFP_HIGHMEM);
1222 if (!tmp_page)
1223 goto err_free;
1225 spin_lock(&fc->lock);
1226 BUG_ON(list_empty(&fi->write_files));
1227 ff = list_entry(fi->write_files.next, struct fuse_file, write_entry);
1228 req->ff = fuse_file_get(ff);
1229 spin_unlock(&fc->lock);
1231 fuse_write_fill(req, ff, page_offset(page), 0);
1233 copy_highpage(tmp_page, page);
1234 req->misc.write.in.write_flags |= FUSE_WRITE_CACHE;
1235 req->in.argpages = 1;
1236 req->num_pages = 1;
1237 req->pages[0] = tmp_page;
1238 req->page_offset = 0;
1239 req->end = fuse_writepage_end;
1240 req->inode = inode;
1242 inc_bdi_stat(mapping->backing_dev_info, BDI_WRITEBACK);
1243 inc_zone_page_state(tmp_page, NR_WRITEBACK_TEMP);
1244 end_page_writeback(page);
1246 spin_lock(&fc->lock);
1247 list_add(&req->writepages_entry, &fi->writepages);
1248 list_add_tail(&req->list, &fi->queued_writes);
1249 fuse_flush_writepages(inode);
1250 spin_unlock(&fc->lock);
1252 return 0;
1254 err_free:
1255 fuse_request_free(req);
1256 err:
1257 end_page_writeback(page);
1258 return -ENOMEM;
1261 static int fuse_writepage(struct page *page, struct writeback_control *wbc)
1263 int err;
1265 err = fuse_writepage_locked(page);
1266 unlock_page(page);
1268 return err;
1271 static int fuse_launder_page(struct page *page)
1273 int err = 0;
1274 if (clear_page_dirty_for_io(page)) {
1275 struct inode *inode = page->mapping->host;
1276 err = fuse_writepage_locked(page);
1277 if (!err)
1278 fuse_wait_on_page_writeback(inode, page->index);
1280 return err;
1284 * Write back dirty pages now, because there may not be any suitable
1285 * open files later
1287 static void fuse_vma_close(struct vm_area_struct *vma)
1289 filemap_write_and_wait(vma->vm_file->f_mapping);
1293 * Wait for writeback against this page to complete before allowing it
1294 * to be marked dirty again, and hence written back again, possibly
1295 * before the previous writepage completed.
1297 * Block here, instead of in ->writepage(), so that the userspace fs
1298 * can only block processes actually operating on the filesystem.
1300 * Otherwise unprivileged userspace fs would be able to block
1301 * unrelated:
1303 * - page migration
1304 * - sync(2)
1305 * - try_to_free_pages() with order > PAGE_ALLOC_COSTLY_ORDER
1307 static int fuse_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf)
1309 struct page *page = vmf->page;
1311 * Don't use page->mapping as it may become NULL from a
1312 * concurrent truncate.
1314 struct inode *inode = vma->vm_file->f_mapping->host;
1316 fuse_wait_on_page_writeback(inode, page->index);
1317 return 0;
1320 static const struct vm_operations_struct fuse_file_vm_ops = {
1321 .close = fuse_vma_close,
1322 .fault = filemap_fault,
1323 .page_mkwrite = fuse_page_mkwrite,
1326 static int fuse_file_mmap(struct file *file, struct vm_area_struct *vma)
1328 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE)) {
1329 struct inode *inode = file->f_dentry->d_inode;
1330 struct fuse_conn *fc = get_fuse_conn(inode);
1331 struct fuse_inode *fi = get_fuse_inode(inode);
1332 struct fuse_file *ff = file->private_data;
1334 * file may be written through mmap, so chain it onto the
1335 * inodes's write_file list
1337 spin_lock(&fc->lock);
1338 if (list_empty(&ff->write_entry))
1339 list_add(&ff->write_entry, &fi->write_files);
1340 spin_unlock(&fc->lock);
1342 file_accessed(file);
1343 vma->vm_ops = &fuse_file_vm_ops;
1344 return 0;
1347 static int fuse_direct_mmap(struct file *file, struct vm_area_struct *vma)
1349 /* Can't provide the coherency needed for MAP_SHARED */
1350 if (vma->vm_flags & VM_MAYSHARE)
1351 return -ENODEV;
1353 invalidate_inode_pages2(file->f_mapping);
1355 return generic_file_mmap(file, vma);
1358 static int convert_fuse_file_lock(const struct fuse_file_lock *ffl,
1359 struct file_lock *fl)
1361 switch (ffl->type) {
1362 case F_UNLCK:
1363 break;
1365 case F_RDLCK:
1366 case F_WRLCK:
1367 if (ffl->start > OFFSET_MAX || ffl->end > OFFSET_MAX ||
1368 ffl->end < ffl->start)
1369 return -EIO;
1371 fl->fl_start = ffl->start;
1372 fl->fl_end = ffl->end;
1373 fl->fl_pid = ffl->pid;
1374 break;
1376 default:
1377 return -EIO;
1379 fl->fl_type = ffl->type;
1380 return 0;
1383 static void fuse_lk_fill(struct fuse_req *req, struct file *file,
1384 const struct file_lock *fl, int opcode, pid_t pid,
1385 int flock)
1387 struct inode *inode = file->f_path.dentry->d_inode;
1388 struct fuse_conn *fc = get_fuse_conn(inode);
1389 struct fuse_file *ff = file->private_data;
1390 struct fuse_lk_in *arg = &req->misc.lk_in;
1392 arg->fh = ff->fh;
1393 arg->owner = fuse_lock_owner_id(fc, fl->fl_owner);
1394 arg->lk.start = fl->fl_start;
1395 arg->lk.end = fl->fl_end;
1396 arg->lk.type = fl->fl_type;
1397 arg->lk.pid = pid;
1398 if (flock)
1399 arg->lk_flags |= FUSE_LK_FLOCK;
1400 req->in.h.opcode = opcode;
1401 req->in.h.nodeid = get_node_id(inode);
1402 req->in.numargs = 1;
1403 req->in.args[0].size = sizeof(*arg);
1404 req->in.args[0].value = arg;
1407 static int fuse_getlk(struct file *file, struct file_lock *fl)
1409 struct inode *inode = file->f_path.dentry->d_inode;
1410 struct fuse_conn *fc = get_fuse_conn(inode);
1411 struct fuse_req *req;
1412 struct fuse_lk_out outarg;
1413 int err;
1415 req = fuse_get_req(fc);
1416 if (IS_ERR(req))
1417 return PTR_ERR(req);
1419 fuse_lk_fill(req, file, fl, FUSE_GETLK, 0, 0);
1420 req->out.numargs = 1;
1421 req->out.args[0].size = sizeof(outarg);
1422 req->out.args[0].value = &outarg;
1423 fuse_request_send(fc, req);
1424 err = req->out.h.error;
1425 fuse_put_request(fc, req);
1426 if (!err)
1427 err = convert_fuse_file_lock(&outarg.lk, fl);
1429 return err;
1432 static int fuse_setlk(struct file *file, struct file_lock *fl, int flock)
1434 struct inode *inode = file->f_path.dentry->d_inode;
1435 struct fuse_conn *fc = get_fuse_conn(inode);
1436 struct fuse_req *req;
1437 int opcode = (fl->fl_flags & FL_SLEEP) ? FUSE_SETLKW : FUSE_SETLK;
1438 pid_t pid = fl->fl_type != F_UNLCK ? current->tgid : 0;
1439 int err;
1441 if (fl->fl_lmops && fl->fl_lmops->fl_grant) {
1442 /* NLM needs asynchronous locks, which we don't support yet */
1443 return -ENOLCK;
1446 /* Unlock on close is handled by the flush method */
1447 if (fl->fl_flags & FL_CLOSE)
1448 return 0;
1450 req = fuse_get_req(fc);
1451 if (IS_ERR(req))
1452 return PTR_ERR(req);
1454 fuse_lk_fill(req, file, fl, opcode, pid, flock);
1455 fuse_request_send(fc, req);
1456 err = req->out.h.error;
1457 /* locking is restartable */
1458 if (err == -EINTR)
1459 err = -ERESTARTSYS;
1460 fuse_put_request(fc, req);
1461 return err;
1464 static int fuse_file_lock(struct file *file, int cmd, struct file_lock *fl)
1466 struct inode *inode = file->f_path.dentry->d_inode;
1467 struct fuse_conn *fc = get_fuse_conn(inode);
1468 int err;
1470 if (cmd == F_CANCELLK) {
1471 err = 0;
1472 } else if (cmd == F_GETLK) {
1473 if (fc->no_lock) {
1474 posix_test_lock(file, fl);
1475 err = 0;
1476 } else
1477 err = fuse_getlk(file, fl);
1478 } else {
1479 if (fc->no_lock)
1480 err = posix_lock_file(file, fl, NULL);
1481 else
1482 err = fuse_setlk(file, fl, 0);
1484 return err;
1487 static int fuse_file_flock(struct file *file, int cmd, struct file_lock *fl)
1489 struct inode *inode = file->f_path.dentry->d_inode;
1490 struct fuse_conn *fc = get_fuse_conn(inode);
1491 int err;
1493 if (fc->no_lock) {
1494 err = flock_lock_file_wait(file, fl);
1495 } else {
1496 /* emulate flock with POSIX locks */
1497 fl->fl_owner = (fl_owner_t) file;
1498 err = fuse_setlk(file, fl, 1);
1501 return err;
1504 static sector_t fuse_bmap(struct address_space *mapping, sector_t block)
1506 struct inode *inode = mapping->host;
1507 struct fuse_conn *fc = get_fuse_conn(inode);
1508 struct fuse_req *req;
1509 struct fuse_bmap_in inarg;
1510 struct fuse_bmap_out outarg;
1511 int err;
1513 if (!inode->i_sb->s_bdev || fc->no_bmap)
1514 return 0;
1516 req = fuse_get_req(fc);
1517 if (IS_ERR(req))
1518 return 0;
1520 memset(&inarg, 0, sizeof(inarg));
1521 inarg.block = block;
1522 inarg.blocksize = inode->i_sb->s_blocksize;
1523 req->in.h.opcode = FUSE_BMAP;
1524 req->in.h.nodeid = get_node_id(inode);
1525 req->in.numargs = 1;
1526 req->in.args[0].size = sizeof(inarg);
1527 req->in.args[0].value = &inarg;
1528 req->out.numargs = 1;
1529 req->out.args[0].size = sizeof(outarg);
1530 req->out.args[0].value = &outarg;
1531 fuse_request_send(fc, req);
1532 err = req->out.h.error;
1533 fuse_put_request(fc, req);
1534 if (err == -ENOSYS)
1535 fc->no_bmap = 1;
1537 return err ? 0 : outarg.block;
1540 static loff_t fuse_file_llseek(struct file *file, loff_t offset, int origin)
1542 loff_t retval;
1543 struct inode *inode = file->f_path.dentry->d_inode;
1545 mutex_lock(&inode->i_mutex);
1546 switch (origin) {
1547 case SEEK_END:
1548 retval = fuse_update_attributes(inode, NULL, file, NULL);
1549 if (retval)
1550 goto exit;
1551 offset += i_size_read(inode);
1552 break;
1553 case SEEK_CUR:
1554 offset += file->f_pos;
1556 retval = -EINVAL;
1557 if (offset >= 0 && offset <= inode->i_sb->s_maxbytes) {
1558 if (offset != file->f_pos) {
1559 file->f_pos = offset;
1560 file->f_version = 0;
1562 retval = offset;
1564 exit:
1565 mutex_unlock(&inode->i_mutex);
1566 return retval;
1569 static int fuse_ioctl_copy_user(struct page **pages, struct iovec *iov,
1570 unsigned int nr_segs, size_t bytes, bool to_user)
1572 struct iov_iter ii;
1573 int page_idx = 0;
1575 if (!bytes)
1576 return 0;
1578 iov_iter_init(&ii, iov, nr_segs, bytes, 0);
1580 while (iov_iter_count(&ii)) {
1581 struct page *page = pages[page_idx++];
1582 size_t todo = min_t(size_t, PAGE_SIZE, iov_iter_count(&ii));
1583 void *kaddr, *map;
1585 kaddr = map = kmap(page);
1587 while (todo) {
1588 char __user *uaddr = ii.iov->iov_base + ii.iov_offset;
1589 size_t iov_len = ii.iov->iov_len - ii.iov_offset;
1590 size_t copy = min(todo, iov_len);
1591 size_t left;
1593 if (!to_user)
1594 left = copy_from_user(kaddr, uaddr, copy);
1595 else
1596 left = copy_to_user(uaddr, kaddr, copy);
1598 if (unlikely(left))
1599 return -EFAULT;
1601 iov_iter_advance(&ii, copy);
1602 todo -= copy;
1603 kaddr += copy;
1606 kunmap(page);
1609 return 0;
1613 * For ioctls, there is no generic way to determine how much memory
1614 * needs to be read and/or written. Furthermore, ioctls are allowed
1615 * to dereference the passed pointer, so the parameter requires deep
1616 * copying but FUSE has no idea whatsoever about what to copy in or
1617 * out.
1619 * This is solved by allowing FUSE server to retry ioctl with
1620 * necessary in/out iovecs. Let's assume the ioctl implementation
1621 * needs to read in the following structure.
1623 * struct a {
1624 * char *buf;
1625 * size_t buflen;
1628 * On the first callout to FUSE server, inarg->in_size and
1629 * inarg->out_size will be NULL; then, the server completes the ioctl
1630 * with FUSE_IOCTL_RETRY set in out->flags, out->in_iovs set to 1 and
1631 * the actual iov array to
1633 * { { .iov_base = inarg.arg, .iov_len = sizeof(struct a) } }
1635 * which tells FUSE to copy in the requested area and retry the ioctl.
1636 * On the second round, the server has access to the structure and
1637 * from that it can tell what to look for next, so on the invocation,
1638 * it sets FUSE_IOCTL_RETRY, out->in_iovs to 2 and iov array to
1640 * { { .iov_base = inarg.arg, .iov_len = sizeof(struct a) },
1641 * { .iov_base = a.buf, .iov_len = a.buflen } }
1643 * FUSE will copy both struct a and the pointed buffer from the
1644 * process doing the ioctl and retry ioctl with both struct a and the
1645 * buffer.
1647 * This time, FUSE server has everything it needs and completes ioctl
1648 * without FUSE_IOCTL_RETRY which finishes the ioctl call.
1650 * Copying data out works the same way.
1652 * Note that if FUSE_IOCTL_UNRESTRICTED is clear, the kernel
1653 * automatically initializes in and out iovs by decoding @cmd with
1654 * _IOC_* macros and the server is not allowed to request RETRY. This
1655 * limits ioctl data transfers to well-formed ioctls and is the forced
1656 * behavior for all FUSE servers.
1658 long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
1659 unsigned int flags)
1661 struct fuse_file *ff = file->private_data;
1662 struct fuse_conn *fc = ff->fc;
1663 struct fuse_ioctl_in inarg = {
1664 .fh = ff->fh,
1665 .cmd = cmd,
1666 .arg = arg,
1667 .flags = flags
1669 struct fuse_ioctl_out outarg;
1670 struct fuse_req *req = NULL;
1671 struct page **pages = NULL;
1672 struct page *iov_page = NULL;
1673 struct iovec *in_iov = NULL, *out_iov = NULL;
1674 unsigned int in_iovs = 0, out_iovs = 0, num_pages = 0, max_pages;
1675 size_t in_size, out_size, transferred;
1676 int err;
1678 /* assume all the iovs returned by client always fits in a page */
1679 BUILD_BUG_ON(sizeof(struct iovec) * FUSE_IOCTL_MAX_IOV > PAGE_SIZE);
1681 err = -ENOMEM;
1682 pages = kzalloc(sizeof(pages[0]) * FUSE_MAX_PAGES_PER_REQ, GFP_KERNEL);
1683 iov_page = alloc_page(GFP_KERNEL);
1684 if (!pages || !iov_page)
1685 goto out;
1688 * If restricted, initialize IO parameters as encoded in @cmd.
1689 * RETRY from server is not allowed.
1691 if (!(flags & FUSE_IOCTL_UNRESTRICTED)) {
1692 struct iovec *iov = page_address(iov_page);
1694 iov->iov_base = (void __user *)arg;
1695 iov->iov_len = _IOC_SIZE(cmd);
1697 if (_IOC_DIR(cmd) & _IOC_WRITE) {
1698 in_iov = iov;
1699 in_iovs = 1;
1702 if (_IOC_DIR(cmd) & _IOC_READ) {
1703 out_iov = iov;
1704 out_iovs = 1;
1708 retry:
1709 inarg.in_size = in_size = iov_length(in_iov, in_iovs);
1710 inarg.out_size = out_size = iov_length(out_iov, out_iovs);
1713 * Out data can be used either for actual out data or iovs,
1714 * make sure there always is at least one page.
1716 out_size = max_t(size_t, out_size, PAGE_SIZE);
1717 max_pages = DIV_ROUND_UP(max(in_size, out_size), PAGE_SIZE);
1719 /* make sure there are enough buffer pages and init request with them */
1720 err = -ENOMEM;
1721 if (max_pages > FUSE_MAX_PAGES_PER_REQ)
1722 goto out;
1723 while (num_pages < max_pages) {
1724 pages[num_pages] = alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
1725 if (!pages[num_pages])
1726 goto out;
1727 num_pages++;
1730 req = fuse_get_req(fc);
1731 if (IS_ERR(req)) {
1732 err = PTR_ERR(req);
1733 req = NULL;
1734 goto out;
1736 memcpy(req->pages, pages, sizeof(req->pages[0]) * num_pages);
1737 req->num_pages = num_pages;
1739 /* okay, let's send it to the client */
1740 req->in.h.opcode = FUSE_IOCTL;
1741 req->in.h.nodeid = ff->nodeid;
1742 req->in.numargs = 1;
1743 req->in.args[0].size = sizeof(inarg);
1744 req->in.args[0].value = &inarg;
1745 if (in_size) {
1746 req->in.numargs++;
1747 req->in.args[1].size = in_size;
1748 req->in.argpages = 1;
1750 err = fuse_ioctl_copy_user(pages, in_iov, in_iovs, in_size,
1751 false);
1752 if (err)
1753 goto out;
1756 req->out.numargs = 2;
1757 req->out.args[0].size = sizeof(outarg);
1758 req->out.args[0].value = &outarg;
1759 req->out.args[1].size = out_size;
1760 req->out.argpages = 1;
1761 req->out.argvar = 1;
1763 fuse_request_send(fc, req);
1764 err = req->out.h.error;
1765 transferred = req->out.args[1].size;
1766 fuse_put_request(fc, req);
1767 req = NULL;
1768 if (err)
1769 goto out;
1771 /* did it ask for retry? */
1772 if (outarg.flags & FUSE_IOCTL_RETRY) {
1773 char *vaddr;
1775 /* no retry if in restricted mode */
1776 err = -EIO;
1777 if (!(flags & FUSE_IOCTL_UNRESTRICTED))
1778 goto out;
1780 in_iovs = outarg.in_iovs;
1781 out_iovs = outarg.out_iovs;
1784 * Make sure things are in boundary, separate checks
1785 * are to protect against overflow.
1787 err = -ENOMEM;
1788 if (in_iovs > FUSE_IOCTL_MAX_IOV ||
1789 out_iovs > FUSE_IOCTL_MAX_IOV ||
1790 in_iovs + out_iovs > FUSE_IOCTL_MAX_IOV)
1791 goto out;
1793 err = -EIO;
1794 if ((in_iovs + out_iovs) * sizeof(struct iovec) != transferred)
1795 goto out;
1797 /* okay, copy in iovs and retry */
1798 vaddr = kmap_atomic(pages[0], KM_USER0);
1799 memcpy(page_address(iov_page), vaddr, transferred);
1800 kunmap_atomic(vaddr, KM_USER0);
1802 in_iov = page_address(iov_page);
1803 out_iov = in_iov + in_iovs;
1805 goto retry;
1808 err = -EIO;
1809 if (transferred > inarg.out_size)
1810 goto out;
1812 err = fuse_ioctl_copy_user(pages, out_iov, out_iovs, transferred, true);
1813 out:
1814 if (req)
1815 fuse_put_request(fc, req);
1816 if (iov_page)
1817 __free_page(iov_page);
1818 while (num_pages)
1819 __free_page(pages[--num_pages]);
1820 kfree(pages);
1822 return err ? err : outarg.result;
1824 EXPORT_SYMBOL_GPL(fuse_do_ioctl);
1826 static long fuse_file_ioctl_common(struct file *file, unsigned int cmd,
1827 unsigned long arg, unsigned int flags)
1829 struct inode *inode = file->f_dentry->d_inode;
1830 struct fuse_conn *fc = get_fuse_conn(inode);
1832 if (!fuse_allow_task(fc, current))
1833 return -EACCES;
1835 if (is_bad_inode(inode))
1836 return -EIO;
1838 return fuse_do_ioctl(file, cmd, arg, flags);
1841 static long fuse_file_ioctl(struct file *file, unsigned int cmd,
1842 unsigned long arg)
1844 return fuse_file_ioctl_common(file, cmd, arg, 0);
1847 static long fuse_file_compat_ioctl(struct file *file, unsigned int cmd,
1848 unsigned long arg)
1850 return fuse_file_ioctl_common(file, cmd, arg, FUSE_IOCTL_COMPAT);
1854 * All files which have been polled are linked to RB tree
1855 * fuse_conn->polled_files which is indexed by kh. Walk the tree and
1856 * find the matching one.
1858 static struct rb_node **fuse_find_polled_node(struct fuse_conn *fc, u64 kh,
1859 struct rb_node **parent_out)
1861 struct rb_node **link = &fc->polled_files.rb_node;
1862 struct rb_node *last = NULL;
1864 while (*link) {
1865 struct fuse_file *ff;
1867 last = *link;
1868 ff = rb_entry(last, struct fuse_file, polled_node);
1870 if (kh < ff->kh)
1871 link = &last->rb_left;
1872 else if (kh > ff->kh)
1873 link = &last->rb_right;
1874 else
1875 return link;
1878 if (parent_out)
1879 *parent_out = last;
1880 return link;
1884 * The file is about to be polled. Make sure it's on the polled_files
1885 * RB tree. Note that files once added to the polled_files tree are
1886 * not removed before the file is released. This is because a file
1887 * polled once is likely to be polled again.
1889 static void fuse_register_polled_file(struct fuse_conn *fc,
1890 struct fuse_file *ff)
1892 spin_lock(&fc->lock);
1893 if (RB_EMPTY_NODE(&ff->polled_node)) {
1894 struct rb_node **link, *parent;
1896 link = fuse_find_polled_node(fc, ff->kh, &parent);
1897 BUG_ON(*link);
1898 rb_link_node(&ff->polled_node, parent, link);
1899 rb_insert_color(&ff->polled_node, &fc->polled_files);
1901 spin_unlock(&fc->lock);
1904 unsigned fuse_file_poll(struct file *file, poll_table *wait)
1906 struct fuse_file *ff = file->private_data;
1907 struct fuse_conn *fc = ff->fc;
1908 struct fuse_poll_in inarg = { .fh = ff->fh, .kh = ff->kh };
1909 struct fuse_poll_out outarg;
1910 struct fuse_req *req;
1911 int err;
1913 if (fc->no_poll)
1914 return DEFAULT_POLLMASK;
1916 poll_wait(file, &ff->poll_wait, wait);
1919 * Ask for notification iff there's someone waiting for it.
1920 * The client may ignore the flag and always notify.
1922 if (waitqueue_active(&ff->poll_wait)) {
1923 inarg.flags |= FUSE_POLL_SCHEDULE_NOTIFY;
1924 fuse_register_polled_file(fc, ff);
1927 req = fuse_get_req(fc);
1928 if (IS_ERR(req))
1929 return POLLERR;
1931 req->in.h.opcode = FUSE_POLL;
1932 req->in.h.nodeid = ff->nodeid;
1933 req->in.numargs = 1;
1934 req->in.args[0].size = sizeof(inarg);
1935 req->in.args[0].value = &inarg;
1936 req->out.numargs = 1;
1937 req->out.args[0].size = sizeof(outarg);
1938 req->out.args[0].value = &outarg;
1939 fuse_request_send(fc, req);
1940 err = req->out.h.error;
1941 fuse_put_request(fc, req);
1943 if (!err)
1944 return outarg.revents;
1945 if (err == -ENOSYS) {
1946 fc->no_poll = 1;
1947 return DEFAULT_POLLMASK;
1949 return POLLERR;
1951 EXPORT_SYMBOL_GPL(fuse_file_poll);
1954 * This is called from fuse_handle_notify() on FUSE_NOTIFY_POLL and
1955 * wakes up the poll waiters.
1957 int fuse_notify_poll_wakeup(struct fuse_conn *fc,
1958 struct fuse_notify_poll_wakeup_out *outarg)
1960 u64 kh = outarg->kh;
1961 struct rb_node **link;
1963 spin_lock(&fc->lock);
1965 link = fuse_find_polled_node(fc, kh, NULL);
1966 if (*link) {
1967 struct fuse_file *ff;
1969 ff = rb_entry(*link, struct fuse_file, polled_node);
1970 wake_up_interruptible_sync(&ff->poll_wait);
1973 spin_unlock(&fc->lock);
1974 return 0;
1977 static const struct file_operations fuse_file_operations = {
1978 .llseek = fuse_file_llseek,
1979 .read = do_sync_read,
1980 .aio_read = fuse_file_aio_read,
1981 .write = do_sync_write,
1982 .aio_write = fuse_file_aio_write,
1983 .mmap = fuse_file_mmap,
1984 .open = fuse_open,
1985 .flush = fuse_flush,
1986 .release = fuse_release,
1987 .fsync = fuse_fsync,
1988 .lock = fuse_file_lock,
1989 .flock = fuse_file_flock,
1990 .splice_read = generic_file_splice_read,
1991 .unlocked_ioctl = fuse_file_ioctl,
1992 .compat_ioctl = fuse_file_compat_ioctl,
1993 .poll = fuse_file_poll,
1996 static const struct file_operations fuse_direct_io_file_operations = {
1997 .llseek = fuse_file_llseek,
1998 .read = fuse_direct_read,
1999 .write = fuse_direct_write,
2000 .mmap = fuse_direct_mmap,
2001 .open = fuse_open,
2002 .flush = fuse_flush,
2003 .release = fuse_release,
2004 .fsync = fuse_fsync,
2005 .lock = fuse_file_lock,
2006 .flock = fuse_file_flock,
2007 .unlocked_ioctl = fuse_file_ioctl,
2008 .compat_ioctl = fuse_file_compat_ioctl,
2009 .poll = fuse_file_poll,
2010 /* no splice_read */
2013 static const struct address_space_operations fuse_file_aops = {
2014 .readpage = fuse_readpage,
2015 .writepage = fuse_writepage,
2016 .launder_page = fuse_launder_page,
2017 .write_begin = fuse_write_begin,
2018 .write_end = fuse_write_end,
2019 .readpages = fuse_readpages,
2020 .set_page_dirty = __set_page_dirty_nobuffers,
2021 .bmap = fuse_bmap,
2024 void fuse_init_file_inode(struct inode *inode)
2026 inode->i_fop = &fuse_file_operations;
2027 inode->i_data.a_ops = &fuse_file_aops;