2 * linux/fs/read_write.c
4 * Copyright (C) 1991, 1992 Linus Torvalds
7 #include <linux/slab.h>
8 #include <linux/stat.h>
9 #include <linux/fcntl.h>
10 #include <linux/file.h>
11 #include <linux/uio.h>
12 #include <linux/smp_lock.h>
13 #include <linux/fsnotify.h>
14 #include <linux/security.h>
15 #include <linux/module.h>
16 #include <linux/syscalls.h>
17 #include <linux/pagemap.h>
18 #include <linux/splice.h>
19 #include "read_write.h"
21 #include <asm/uaccess.h>
22 #include <asm/unistd.h>
24 const struct file_operations generic_ro_fops = {
25 .llseek = generic_file_llseek,
27 .aio_read = generic_file_aio_read,
28 .mmap = generic_file_readonly_mmap,
29 .splice_read = generic_file_splice_read,
32 EXPORT_SYMBOL(generic_ro_fops);
35 * generic_file_llseek_unlocked - lockless generic llseek implementation
36 * @file: file structure to seek on
37 * @offset: file offset to seek to
38 * @origin: type of seek
40 * Updates the file offset to the value specified by @offset and @origin.
41 * Locking must be provided by the caller.
44 generic_file_llseek_unlocked(struct file *file, loff_t offset, int origin)
46 struct inode *inode = file->f_mapping->host;
50 offset += inode->i_size;
54 * Here we special-case the lseek(fd, 0, SEEK_CUR)
55 * position-querying operation. Avoid rewriting the "same"
56 * f_pos value back to the file because a concurrent read(),
57 * write() or lseek() might have altered it
61 offset += file->f_pos;
65 if (offset < 0 || offset > inode->i_sb->s_maxbytes)
68 /* Special lock needed here? */
69 if (offset != file->f_pos) {
76 EXPORT_SYMBOL(generic_file_llseek_unlocked);
79 * generic_file_llseek - generic llseek implementation for regular files
80 * @file: file structure to seek on
81 * @offset: file offset to seek to
82 * @origin: type of seek
84 * This is a generic implemenation of ->llseek useable for all normal local
85 * filesystems. It just updates the file offset to the value specified by
86 * @offset and @origin under i_mutex.
88 loff_t generic_file_llseek(struct file *file, loff_t offset, int origin)
92 mutex_lock(&file->f_dentry->d_inode->i_mutex);
93 rval = generic_file_llseek_unlocked(file, offset, origin);
94 mutex_unlock(&file->f_dentry->d_inode->i_mutex);
98 EXPORT_SYMBOL(generic_file_llseek);
100 loff_t no_llseek(struct file *file, loff_t offset, int origin)
104 EXPORT_SYMBOL(no_llseek);
106 loff_t default_llseek(struct file *file, loff_t offset, int origin)
113 offset += i_size_read(file->f_path.dentry->d_inode);
117 retval = file->f_pos;
120 offset += file->f_pos;
124 if (offset != file->f_pos) {
125 file->f_pos = offset;
134 EXPORT_SYMBOL(default_llseek);
136 loff_t vfs_llseek(struct file *file, loff_t offset, int origin)
138 loff_t (*fn)(struct file *, loff_t, int);
141 if (file->f_mode & FMODE_LSEEK) {
143 if (file->f_op && file->f_op->llseek)
144 fn = file->f_op->llseek;
146 return fn(file, offset, origin);
148 EXPORT_SYMBOL(vfs_llseek);
150 SYSCALL_DEFINE3(lseek, unsigned int, fd, off_t, offset, unsigned int, origin)
157 file = fget_light(fd, &fput_needed);
162 if (origin <= SEEK_MAX) {
163 loff_t res = vfs_llseek(file, offset, origin);
165 if (res != (loff_t)retval)
166 retval = -EOVERFLOW; /* LFS: should only happen on 32 bit platforms */
168 fput_light(file, fput_needed);
173 #ifdef __ARCH_WANT_SYS_LLSEEK
174 SYSCALL_DEFINE5(llseek, unsigned int, fd, unsigned long, offset_high,
175 unsigned long, offset_low, loff_t __user *, result,
176 unsigned int, origin)
184 file = fget_light(fd, &fput_needed);
189 if (origin > SEEK_MAX)
192 offset = vfs_llseek(file, ((loff_t) offset_high << 32) | offset_low,
195 retval = (int)offset;
198 if (!copy_to_user(result, &offset, sizeof(offset)))
202 fput_light(file, fput_needed);
209 * rw_verify_area doesn't like huge counts. We limit
210 * them to something that fits in "int" so that others
211 * won't have to do range checks all the time.
213 #define MAX_RW_COUNT (INT_MAX & PAGE_CACHE_MASK)
215 int rw_verify_area(int read_write, struct file *file, loff_t *ppos, size_t count)
219 int retval = -EINVAL;
221 inode = file->f_path.dentry->d_inode;
222 if (unlikely((ssize_t) count < 0))
225 if (unlikely((pos < 0) || (loff_t) (pos + count) < 0))
228 if (unlikely(inode->i_flock && mandatory_lock(inode))) {
229 retval = locks_mandatory_area(
230 read_write == READ ? FLOCK_VERIFY_READ : FLOCK_VERIFY_WRITE,
231 inode, file, pos, count);
235 retval = security_file_permission(file,
236 read_write == READ ? MAY_READ : MAY_WRITE);
239 return count > MAX_RW_COUNT ? MAX_RW_COUNT : count;
242 static void wait_on_retry_sync_kiocb(struct kiocb *iocb)
244 set_current_state(TASK_UNINTERRUPTIBLE);
245 if (!kiocbIsKicked(iocb))
248 kiocbClearKicked(iocb);
249 __set_current_state(TASK_RUNNING);
252 ssize_t do_sync_read(struct file *filp, char __user *buf, size_t len, loff_t *ppos)
254 struct iovec iov = { .iov_base = buf, .iov_len = len };
258 init_sync_kiocb(&kiocb, filp);
259 kiocb.ki_pos = *ppos;
261 kiocb.ki_nbytes = len;
264 ret = filp->f_op->aio_read(&kiocb, &iov, 1, kiocb.ki_pos);
265 if (ret != -EIOCBRETRY)
267 wait_on_retry_sync_kiocb(&kiocb);
270 if (-EIOCBQUEUED == ret)
271 ret = wait_on_sync_kiocb(&kiocb);
272 *ppos = kiocb.ki_pos;
276 EXPORT_SYMBOL(do_sync_read);
278 ssize_t vfs_read(struct file *file, char __user *buf, size_t count, loff_t *pos)
282 if (!(file->f_mode & FMODE_READ))
284 if (!file->f_op || (!file->f_op->read && !file->f_op->aio_read))
286 if (unlikely(!access_ok(VERIFY_WRITE, buf, count)))
289 ret = rw_verify_area(READ, file, pos, count);
292 if (file->f_op->read)
293 ret = file->f_op->read(file, buf, count, pos);
295 ret = do_sync_read(file, buf, count, pos);
297 fsnotify_access(file->f_path.dentry);
298 add_rchar(current, ret);
306 EXPORT_SYMBOL(vfs_read);
308 ssize_t do_sync_write(struct file *filp, const char __user *buf, size_t len, loff_t *ppos)
310 struct iovec iov = { .iov_base = (void __user *)buf, .iov_len = len };
314 init_sync_kiocb(&kiocb, filp);
315 kiocb.ki_pos = *ppos;
317 kiocb.ki_nbytes = len;
320 ret = filp->f_op->aio_write(&kiocb, &iov, 1, kiocb.ki_pos);
321 if (ret != -EIOCBRETRY)
323 wait_on_retry_sync_kiocb(&kiocb);
326 if (-EIOCBQUEUED == ret)
327 ret = wait_on_sync_kiocb(&kiocb);
328 *ppos = kiocb.ki_pos;
332 EXPORT_SYMBOL(do_sync_write);
334 ssize_t vfs_write(struct file *file, const char __user *buf, size_t count, loff_t *pos)
338 if (!(file->f_mode & FMODE_WRITE))
340 if (!file->f_op || (!file->f_op->write && !file->f_op->aio_write))
342 if (unlikely(!access_ok(VERIFY_READ, buf, count)))
345 ret = rw_verify_area(WRITE, file, pos, count);
348 if (file->f_op->write)
349 ret = file->f_op->write(file, buf, count, pos);
351 ret = do_sync_write(file, buf, count, pos);
353 fsnotify_modify(file->f_path.dentry);
354 add_wchar(current, ret);
362 EXPORT_SYMBOL(vfs_write);
364 static inline loff_t file_pos_read(struct file *file)
369 static inline void file_pos_write(struct file *file, loff_t pos)
374 SYSCALL_DEFINE3(read, unsigned int, fd, char __user *, buf, size_t, count)
377 ssize_t ret = -EBADF;
380 file = fget_light(fd, &fput_needed);
382 loff_t pos = file_pos_read(file);
383 ret = vfs_read(file, buf, count, &pos);
384 file_pos_write(file, pos);
385 fput_light(file, fput_needed);
391 SYSCALL_DEFINE3(write, unsigned int, fd, const char __user *, buf,
395 ssize_t ret = -EBADF;
398 file = fget_light(fd, &fput_needed);
400 loff_t pos = file_pos_read(file);
401 ret = vfs_write(file, buf, count, &pos);
402 file_pos_write(file, pos);
403 fput_light(file, fput_needed);
409 SYSCALL_DEFINE(pread64)(unsigned int fd, char __user *buf,
410 size_t count, loff_t pos)
413 ssize_t ret = -EBADF;
419 file = fget_light(fd, &fput_needed);
422 if (file->f_mode & FMODE_PREAD)
423 ret = vfs_read(file, buf, count, &pos);
424 fput_light(file, fput_needed);
429 #ifdef CONFIG_HAVE_SYSCALL_WRAPPERS
430 asmlinkage long SyS_pread64(long fd, long buf, long count, loff_t pos)
432 return SYSC_pread64((unsigned int) fd, (char __user *) buf,
433 (size_t) count, pos);
435 SYSCALL_ALIAS(sys_pread64, SyS_pread64);
438 SYSCALL_DEFINE(pwrite64)(unsigned int fd, const char __user *buf,
439 size_t count, loff_t pos)
442 ssize_t ret = -EBADF;
448 file = fget_light(fd, &fput_needed);
451 if (file->f_mode & FMODE_PWRITE)
452 ret = vfs_write(file, buf, count, &pos);
453 fput_light(file, fput_needed);
458 #ifdef CONFIG_HAVE_SYSCALL_WRAPPERS
459 asmlinkage long SyS_pwrite64(long fd, long buf, long count, loff_t pos)
461 return SYSC_pwrite64((unsigned int) fd, (const char __user *) buf,
462 (size_t) count, pos);
464 SYSCALL_ALIAS(sys_pwrite64, SyS_pwrite64);
468 * Reduce an iovec's length in-place. Return the resulting number of segments
470 unsigned long iov_shorten(struct iovec *iov, unsigned long nr_segs, size_t to)
472 unsigned long seg = 0;
475 while (seg < nr_segs) {
477 if (len + iov->iov_len >= to) {
478 iov->iov_len = to - len;
486 EXPORT_SYMBOL(iov_shorten);
488 ssize_t do_sync_readv_writev(struct file *filp, const struct iovec *iov,
489 unsigned long nr_segs, size_t len, loff_t *ppos, iov_fn_t fn)
494 init_sync_kiocb(&kiocb, filp);
495 kiocb.ki_pos = *ppos;
497 kiocb.ki_nbytes = len;
500 ret = fn(&kiocb, iov, nr_segs, kiocb.ki_pos);
501 if (ret != -EIOCBRETRY)
503 wait_on_retry_sync_kiocb(&kiocb);
506 if (ret == -EIOCBQUEUED)
507 ret = wait_on_sync_kiocb(&kiocb);
508 *ppos = kiocb.ki_pos;
512 /* Do it by hand, with file-ops */
513 ssize_t do_loop_readv_writev(struct file *filp, struct iovec *iov,
514 unsigned long nr_segs, loff_t *ppos, io_fn_t fn)
516 struct iovec *vector = iov;
519 while (nr_segs > 0) {
524 base = vector->iov_base;
525 len = vector->iov_len;
529 nr = fn(filp, base, len, ppos);
544 /* A write operation does a read from user space and vice versa */
545 #define vrfy_dir(type) ((type) == READ ? VERIFY_WRITE : VERIFY_READ)
547 ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
548 unsigned long nr_segs, unsigned long fast_segs,
549 struct iovec *fast_pointer,
550 struct iovec **ret_pointer)
554 struct iovec *iov = fast_pointer;
557 * SuS says "The readv() function *may* fail if the iovcnt argument
558 * was less than or equal to 0, or greater than {IOV_MAX}. Linux has
559 * traditionally returned zero for zero segments, so...
567 * First get the "struct iovec" from user memory and
568 * verify all the pointers
570 if (nr_segs > UIO_MAXIOV) {
574 if (nr_segs > fast_segs) {
575 iov = kmalloc(nr_segs*sizeof(struct iovec), GFP_KERNEL);
581 if (copy_from_user(iov, uvector, nr_segs*sizeof(*uvector))) {
587 * According to the Single Unix Specification we should return EINVAL
588 * if an element length is < 0 when cast to ssize_t or if the
589 * total length would overflow the ssize_t return value of the
593 for (seg = 0; seg < nr_segs; seg++) {
594 void __user *buf = iov[seg].iov_base;
595 ssize_t len = (ssize_t)iov[seg].iov_len;
597 /* see if we we're about to use an invalid len or if
598 * it's about to overflow ssize_t */
599 if (len < 0 || (ret + len < ret)) {
603 if (unlikely(!access_ok(vrfy_dir(type), buf, len))) {
615 static ssize_t do_readv_writev(int type, struct file *file,
616 const struct iovec __user * uvector,
617 unsigned long nr_segs, loff_t *pos)
620 struct iovec iovstack[UIO_FASTIOV];
621 struct iovec *iov = iovstack;
631 ret = rw_copy_check_uvector(type, uvector, nr_segs,
632 ARRAY_SIZE(iovstack), iovstack, &iov);
637 ret = rw_verify_area(type, file, pos, tot_len);
643 fn = file->f_op->read;
644 fnv = file->f_op->aio_read;
646 fn = (io_fn_t)file->f_op->write;
647 fnv = file->f_op->aio_write;
651 ret = do_sync_readv_writev(file, iov, nr_segs, tot_len,
654 ret = do_loop_readv_writev(file, iov, nr_segs, pos, fn);
659 if ((ret + (type == READ)) > 0) {
661 fsnotify_access(file->f_path.dentry);
663 fsnotify_modify(file->f_path.dentry);
668 ssize_t vfs_readv(struct file *file, const struct iovec __user *vec,
669 unsigned long vlen, loff_t *pos)
671 if (!(file->f_mode & FMODE_READ))
673 if (!file->f_op || (!file->f_op->aio_read && !file->f_op->read))
676 return do_readv_writev(READ, file, vec, vlen, pos);
679 EXPORT_SYMBOL(vfs_readv);
681 ssize_t vfs_writev(struct file *file, const struct iovec __user *vec,
682 unsigned long vlen, loff_t *pos)
684 if (!(file->f_mode & FMODE_WRITE))
686 if (!file->f_op || (!file->f_op->aio_write && !file->f_op->write))
689 return do_readv_writev(WRITE, file, vec, vlen, pos);
692 EXPORT_SYMBOL(vfs_writev);
694 SYSCALL_DEFINE3(readv, unsigned long, fd, const struct iovec __user *, vec,
698 ssize_t ret = -EBADF;
701 file = fget_light(fd, &fput_needed);
703 loff_t pos = file_pos_read(file);
704 ret = vfs_readv(file, vec, vlen, &pos);
705 file_pos_write(file, pos);
706 fput_light(file, fput_needed);
710 add_rchar(current, ret);
715 SYSCALL_DEFINE3(writev, unsigned long, fd, const struct iovec __user *, vec,
719 ssize_t ret = -EBADF;
722 file = fget_light(fd, &fput_needed);
724 loff_t pos = file_pos_read(file);
725 ret = vfs_writev(file, vec, vlen, &pos);
726 file_pos_write(file, pos);
727 fput_light(file, fput_needed);
731 add_wchar(current, ret);
736 static inline loff_t pos_from_hilo(unsigned long high, unsigned long low)
738 #define HALF_LONG_BITS (BITS_PER_LONG / 2)
739 return (((loff_t)high << HALF_LONG_BITS) << HALF_LONG_BITS) | low;
742 SYSCALL_DEFINE5(preadv, unsigned long, fd, const struct iovec __user *, vec,
743 unsigned long, vlen, unsigned long, pos_l, unsigned long, pos_h)
745 loff_t pos = pos_from_hilo(pos_h, pos_l);
747 ssize_t ret = -EBADF;
753 file = fget_light(fd, &fput_needed);
756 if (file->f_mode & FMODE_PREAD)
757 ret = vfs_readv(file, vec, vlen, &pos);
758 fput_light(file, fput_needed);
762 add_rchar(current, ret);
767 SYSCALL_DEFINE5(pwritev, unsigned long, fd, const struct iovec __user *, vec,
768 unsigned long, vlen, unsigned long, pos_l, unsigned long, pos_h)
770 loff_t pos = pos_from_hilo(pos_h, pos_l);
772 ssize_t ret = -EBADF;
778 file = fget_light(fd, &fput_needed);
781 if (file->f_mode & FMODE_PWRITE)
782 ret = vfs_writev(file, vec, vlen, &pos);
783 fput_light(file, fput_needed);
787 add_wchar(current, ret);
792 static ssize_t do_sendfile(int out_fd, int in_fd, loff_t *ppos,
793 size_t count, loff_t max)
795 struct file * in_file, * out_file;
796 struct inode * in_inode, * out_inode;
799 int fput_needed_in, fput_needed_out, fl;
802 * Get input file, and verify that it is ok..
805 in_file = fget_light(in_fd, &fput_needed_in);
808 if (!(in_file->f_mode & FMODE_READ))
812 ppos = &in_file->f_pos;
814 if (!(in_file->f_mode & FMODE_PREAD))
816 retval = rw_verify_area(READ, in_file, ppos, count);
822 * Get output file, and verify that it is ok..
825 out_file = fget_light(out_fd, &fput_needed_out);
828 if (!(out_file->f_mode & FMODE_WRITE))
831 in_inode = in_file->f_path.dentry->d_inode;
832 out_inode = out_file->f_path.dentry->d_inode;
833 retval = rw_verify_area(WRITE, out_file, &out_file->f_pos, count);
839 max = min(in_inode->i_sb->s_maxbytes, out_inode->i_sb->s_maxbytes);
842 if (unlikely(pos + count > max)) {
852 * We need to debate whether we can enable this or not. The
853 * man page documents EAGAIN return for the output at least,
854 * and the application is arguably buggy if it doesn't expect
855 * EAGAIN on a non-blocking file descriptor.
857 if (in_file->f_flags & O_NONBLOCK)
858 fl = SPLICE_F_NONBLOCK;
860 retval = do_splice_direct(in_file, ppos, out_file, count, fl);
863 add_rchar(current, retval);
864 add_wchar(current, retval);
873 fput_light(out_file, fput_needed_out);
875 fput_light(in_file, fput_needed_in);
880 SYSCALL_DEFINE4(sendfile, int, out_fd, int, in_fd, off_t __user *, offset, size_t, count)
887 if (unlikely(get_user(off, offset)))
890 ret = do_sendfile(out_fd, in_fd, &pos, count, MAX_NON_LFS);
891 if (unlikely(put_user(pos, offset)))
896 return do_sendfile(out_fd, in_fd, NULL, count, 0);
899 SYSCALL_DEFINE4(sendfile64, int, out_fd, int, in_fd, loff_t __user *, offset, size_t, count)
905 if (unlikely(copy_from_user(&pos, offset, sizeof(loff_t))))
907 ret = do_sendfile(out_fd, in_fd, &pos, count, 0);
908 if (unlikely(put_user(pos, offset)))
913 return do_sendfile(out_fd, in_fd, NULL, count, 0);