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
;
53 offset
+= file
->f_pos
;
57 if (offset
< 0 || offset
> inode
->i_sb
->s_maxbytes
)
60 /* Special lock needed here? */
61 if (offset
!= file
->f_pos
) {
68 EXPORT_SYMBOL(generic_file_llseek_unlocked
);
71 * generic_file_llseek - generic llseek implementation for regular files
72 * @file: file structure to seek on
73 * @offset: file offset to seek to
74 * @origin: type of seek
76 * This is a generic implemenation of ->llseek useable for all normal local
77 * filesystems. It just updates the file offset to the value specified by
78 * @offset and @origin under i_mutex.
80 loff_t
generic_file_llseek(struct file
*file
, loff_t offset
, int origin
)
84 mutex_lock(&file
->f_dentry
->d_inode
->i_mutex
);
85 rval
= generic_file_llseek_unlocked(file
, offset
, origin
);
86 mutex_unlock(&file
->f_dentry
->d_inode
->i_mutex
);
90 EXPORT_SYMBOL(generic_file_llseek
);
92 loff_t
no_llseek(struct file
*file
, loff_t offset
, int origin
)
96 EXPORT_SYMBOL(no_llseek
);
98 loff_t
default_llseek(struct file
*file
, loff_t offset
, int origin
)
105 offset
+= i_size_read(file
->f_path
.dentry
->d_inode
);
108 offset
+= file
->f_pos
;
112 if (offset
!= file
->f_pos
) {
113 file
->f_pos
= offset
;
121 EXPORT_SYMBOL(default_llseek
);
123 loff_t
vfs_llseek(struct file
*file
, loff_t offset
, int origin
)
125 loff_t (*fn
)(struct file
*, loff_t
, int);
128 if (file
->f_mode
& FMODE_LSEEK
) {
130 if (file
->f_op
&& file
->f_op
->llseek
)
131 fn
= file
->f_op
->llseek
;
133 return fn(file
, offset
, origin
);
135 EXPORT_SYMBOL(vfs_llseek
);
137 SYSCALL_DEFINE3(lseek
, unsigned int, fd
, off_t
, offset
, unsigned int, origin
)
144 file
= fget_light(fd
, &fput_needed
);
149 if (origin
<= SEEK_MAX
) {
150 loff_t res
= vfs_llseek(file
, offset
, origin
);
152 if (res
!= (loff_t
)retval
)
153 retval
= -EOVERFLOW
; /* LFS: should only happen on 32 bit platforms */
155 fput_light(file
, fput_needed
);
160 #ifdef __ARCH_WANT_SYS_LLSEEK
161 SYSCALL_DEFINE5(llseek
, unsigned int, fd
, unsigned long, offset_high
,
162 unsigned long, offset_low
, loff_t __user
*, result
,
163 unsigned int, origin
)
171 file
= fget_light(fd
, &fput_needed
);
176 if (origin
> SEEK_MAX
)
179 offset
= vfs_llseek(file
, ((loff_t
) offset_high
<< 32) | offset_low
,
182 retval
= (int)offset
;
185 if (!copy_to_user(result
, &offset
, sizeof(offset
)))
189 fput_light(file
, fput_needed
);
196 * rw_verify_area doesn't like huge counts. We limit
197 * them to something that fits in "int" so that others
198 * won't have to do range checks all the time.
200 #define MAX_RW_COUNT (INT_MAX & PAGE_CACHE_MASK)
202 int rw_verify_area(int read_write
, struct file
*file
, loff_t
*ppos
, size_t count
)
206 int retval
= -EINVAL
;
208 inode
= file
->f_path
.dentry
->d_inode
;
209 if (unlikely((ssize_t
) count
< 0))
212 if (unlikely((pos
< 0) || (loff_t
) (pos
+ count
) < 0))
215 if (unlikely(inode
->i_flock
&& mandatory_lock(inode
))) {
216 retval
= locks_mandatory_area(
217 read_write
== READ
? FLOCK_VERIFY_READ
: FLOCK_VERIFY_WRITE
,
218 inode
, file
, pos
, count
);
222 retval
= security_file_permission(file
,
223 read_write
== READ
? MAY_READ
: MAY_WRITE
);
226 return count
> MAX_RW_COUNT
? MAX_RW_COUNT
: count
;
229 static void wait_on_retry_sync_kiocb(struct kiocb
*iocb
)
231 set_current_state(TASK_UNINTERRUPTIBLE
);
232 if (!kiocbIsKicked(iocb
))
235 kiocbClearKicked(iocb
);
236 __set_current_state(TASK_RUNNING
);
239 ssize_t
do_sync_read(struct file
*filp
, char __user
*buf
, size_t len
, loff_t
*ppos
)
241 struct iovec iov
= { .iov_base
= buf
, .iov_len
= len
};
245 init_sync_kiocb(&kiocb
, filp
);
246 kiocb
.ki_pos
= *ppos
;
250 ret
= filp
->f_op
->aio_read(&kiocb
, &iov
, 1, kiocb
.ki_pos
);
251 if (ret
!= -EIOCBRETRY
)
253 wait_on_retry_sync_kiocb(&kiocb
);
256 if (-EIOCBQUEUED
== ret
)
257 ret
= wait_on_sync_kiocb(&kiocb
);
258 *ppos
= kiocb
.ki_pos
;
262 EXPORT_SYMBOL(do_sync_read
);
264 ssize_t
vfs_read(struct file
*file
, char __user
*buf
, size_t count
, loff_t
*pos
)
268 if (!(file
->f_mode
& FMODE_READ
))
270 if (!file
->f_op
|| (!file
->f_op
->read
&& !file
->f_op
->aio_read
))
272 if (unlikely(!access_ok(VERIFY_WRITE
, buf
, count
)))
275 ret
= rw_verify_area(READ
, file
, pos
, count
);
278 if (file
->f_op
->read
)
279 ret
= file
->f_op
->read(file
, buf
, count
, pos
);
281 ret
= do_sync_read(file
, buf
, count
, pos
);
283 fsnotify_access(file
->f_path
.dentry
);
284 add_rchar(current
, ret
);
292 EXPORT_SYMBOL(vfs_read
);
294 ssize_t
do_sync_write(struct file
*filp
, const char __user
*buf
, size_t len
, loff_t
*ppos
)
296 struct iovec iov
= { .iov_base
= (void __user
*)buf
, .iov_len
= len
};
300 init_sync_kiocb(&kiocb
, filp
);
301 kiocb
.ki_pos
= *ppos
;
305 ret
= filp
->f_op
->aio_write(&kiocb
, &iov
, 1, kiocb
.ki_pos
);
306 if (ret
!= -EIOCBRETRY
)
308 wait_on_retry_sync_kiocb(&kiocb
);
311 if (-EIOCBQUEUED
== ret
)
312 ret
= wait_on_sync_kiocb(&kiocb
);
313 *ppos
= kiocb
.ki_pos
;
317 EXPORT_SYMBOL(do_sync_write
);
319 ssize_t
vfs_write(struct file
*file
, const char __user
*buf
, size_t count
, loff_t
*pos
)
323 if (!(file
->f_mode
& FMODE_WRITE
))
325 if (!file
->f_op
|| (!file
->f_op
->write
&& !file
->f_op
->aio_write
))
327 if (unlikely(!access_ok(VERIFY_READ
, buf
, count
)))
330 ret
= rw_verify_area(WRITE
, file
, pos
, count
);
333 if (file
->f_op
->write
)
334 ret
= file
->f_op
->write(file
, buf
, count
, pos
);
336 ret
= do_sync_write(file
, buf
, count
, pos
);
338 fsnotify_modify(file
->f_path
.dentry
);
339 add_wchar(current
, ret
);
347 EXPORT_SYMBOL(vfs_write
);
349 static inline loff_t
file_pos_read(struct file
*file
)
354 static inline void file_pos_write(struct file
*file
, loff_t pos
)
359 SYSCALL_DEFINE3(read
, unsigned int, fd
, char __user
*, buf
, size_t, count
)
362 ssize_t ret
= -EBADF
;
365 file
= fget_light(fd
, &fput_needed
);
367 loff_t pos
= file_pos_read(file
);
368 ret
= vfs_read(file
, buf
, count
, &pos
);
369 file_pos_write(file
, pos
);
370 fput_light(file
, fput_needed
);
376 SYSCALL_DEFINE3(write
, unsigned int, fd
, const char __user
*, buf
,
380 ssize_t ret
= -EBADF
;
383 file
= fget_light(fd
, &fput_needed
);
385 loff_t pos
= file_pos_read(file
);
386 ret
= vfs_write(file
, buf
, count
, &pos
);
387 file_pos_write(file
, pos
);
388 fput_light(file
, fput_needed
);
394 SYSCALL_DEFINE(pread64
)(unsigned int fd
, char __user
*buf
,
395 size_t count
, loff_t pos
)
398 ssize_t ret
= -EBADF
;
404 file
= fget_light(fd
, &fput_needed
);
407 if (file
->f_mode
& FMODE_PREAD
)
408 ret
= vfs_read(file
, buf
, count
, &pos
);
409 fput_light(file
, fput_needed
);
414 #ifdef CONFIG_HAVE_SYSCALL_WRAPPERS
415 asmlinkage
long SyS_pread64(long fd
, long buf
, long count
, loff_t pos
)
417 return SYSC_pread64((unsigned int) fd
, (char __user
*) buf
,
418 (size_t) count
, pos
);
420 SYSCALL_ALIAS(sys_pread64
, SyS_pread64
);
423 SYSCALL_DEFINE(pwrite64
)(unsigned int fd
, const char __user
*buf
,
424 size_t count
, loff_t pos
)
427 ssize_t ret
= -EBADF
;
433 file
= fget_light(fd
, &fput_needed
);
436 if (file
->f_mode
& FMODE_PWRITE
)
437 ret
= vfs_write(file
, buf
, count
, &pos
);
438 fput_light(file
, fput_needed
);
443 #ifdef CONFIG_HAVE_SYSCALL_WRAPPERS
444 asmlinkage
long SyS_pwrite64(long fd
, long buf
, long count
, loff_t pos
)
446 return SYSC_pwrite64((unsigned int) fd
, (const char __user
*) buf
,
447 (size_t) count
, pos
);
449 SYSCALL_ALIAS(sys_pwrite64
, SyS_pwrite64
);
453 * Reduce an iovec's length in-place. Return the resulting number of segments
455 unsigned long iov_shorten(struct iovec
*iov
, unsigned long nr_segs
, size_t to
)
457 unsigned long seg
= 0;
460 while (seg
< nr_segs
) {
462 if (len
+ iov
->iov_len
>= to
) {
463 iov
->iov_len
= to
- len
;
471 EXPORT_SYMBOL(iov_shorten
);
473 ssize_t
do_sync_readv_writev(struct file
*filp
, const struct iovec
*iov
,
474 unsigned long nr_segs
, size_t len
, loff_t
*ppos
, iov_fn_t fn
)
479 init_sync_kiocb(&kiocb
, filp
);
480 kiocb
.ki_pos
= *ppos
;
482 kiocb
.ki_nbytes
= len
;
485 ret
= fn(&kiocb
, iov
, nr_segs
, kiocb
.ki_pos
);
486 if (ret
!= -EIOCBRETRY
)
488 wait_on_retry_sync_kiocb(&kiocb
);
491 if (ret
== -EIOCBQUEUED
)
492 ret
= wait_on_sync_kiocb(&kiocb
);
493 *ppos
= kiocb
.ki_pos
;
497 /* Do it by hand, with file-ops */
498 ssize_t
do_loop_readv_writev(struct file
*filp
, struct iovec
*iov
,
499 unsigned long nr_segs
, loff_t
*ppos
, io_fn_t fn
)
501 struct iovec
*vector
= iov
;
504 while (nr_segs
> 0) {
509 base
= vector
->iov_base
;
510 len
= vector
->iov_len
;
514 nr
= fn(filp
, base
, len
, ppos
);
529 /* A write operation does a read from user space and vice versa */
530 #define vrfy_dir(type) ((type) == READ ? VERIFY_WRITE : VERIFY_READ)
532 ssize_t
rw_copy_check_uvector(int type
, const struct iovec __user
* uvector
,
533 unsigned long nr_segs
, unsigned long fast_segs
,
534 struct iovec
*fast_pointer
,
535 struct iovec
**ret_pointer
)
539 struct iovec
*iov
= fast_pointer
;
542 * SuS says "The readv() function *may* fail if the iovcnt argument
543 * was less than or equal to 0, or greater than {IOV_MAX}. Linux has
544 * traditionally returned zero for zero segments, so...
552 * First get the "struct iovec" from user memory and
553 * verify all the pointers
555 if (nr_segs
> UIO_MAXIOV
) {
559 if (nr_segs
> fast_segs
) {
560 iov
= kmalloc(nr_segs
*sizeof(struct iovec
), GFP_KERNEL
);
566 if (copy_from_user(iov
, uvector
, nr_segs
*sizeof(*uvector
))) {
572 * According to the Single Unix Specification we should return EINVAL
573 * if an element length is < 0 when cast to ssize_t or if the
574 * total length would overflow the ssize_t return value of the
578 for (seg
= 0; seg
< nr_segs
; seg
++) {
579 void __user
*buf
= iov
[seg
].iov_base
;
580 ssize_t len
= (ssize_t
)iov
[seg
].iov_len
;
582 /* see if we we're about to use an invalid len or if
583 * it's about to overflow ssize_t */
584 if (len
< 0 || (ret
+ len
< ret
)) {
588 if (unlikely(!access_ok(vrfy_dir(type
), buf
, len
))) {
600 static ssize_t
do_readv_writev(int type
, struct file
*file
,
601 const struct iovec __user
* uvector
,
602 unsigned long nr_segs
, loff_t
*pos
)
605 struct iovec iovstack
[UIO_FASTIOV
];
606 struct iovec
*iov
= iovstack
;
616 ret
= rw_copy_check_uvector(type
, uvector
, nr_segs
,
617 ARRAY_SIZE(iovstack
), iovstack
, &iov
);
622 ret
= rw_verify_area(type
, file
, pos
, tot_len
);
628 fn
= file
->f_op
->read
;
629 fnv
= file
->f_op
->aio_read
;
631 fn
= (io_fn_t
)file
->f_op
->write
;
632 fnv
= file
->f_op
->aio_write
;
636 ret
= do_sync_readv_writev(file
, iov
, nr_segs
, tot_len
,
639 ret
= do_loop_readv_writev(file
, iov
, nr_segs
, pos
, fn
);
644 if ((ret
+ (type
== READ
)) > 0) {
646 fsnotify_access(file
->f_path
.dentry
);
648 fsnotify_modify(file
->f_path
.dentry
);
653 ssize_t
vfs_readv(struct file
*file
, const struct iovec __user
*vec
,
654 unsigned long vlen
, loff_t
*pos
)
656 if (!(file
->f_mode
& FMODE_READ
))
658 if (!file
->f_op
|| (!file
->f_op
->aio_read
&& !file
->f_op
->read
))
661 return do_readv_writev(READ
, file
, vec
, vlen
, pos
);
664 EXPORT_SYMBOL(vfs_readv
);
666 ssize_t
vfs_writev(struct file
*file
, const struct iovec __user
*vec
,
667 unsigned long vlen
, loff_t
*pos
)
669 if (!(file
->f_mode
& FMODE_WRITE
))
671 if (!file
->f_op
|| (!file
->f_op
->aio_write
&& !file
->f_op
->write
))
674 return do_readv_writev(WRITE
, file
, vec
, vlen
, pos
);
677 EXPORT_SYMBOL(vfs_writev
);
679 SYSCALL_DEFINE3(readv
, unsigned long, fd
, const struct iovec __user
*, vec
,
683 ssize_t ret
= -EBADF
;
686 file
= fget_light(fd
, &fput_needed
);
688 loff_t pos
= file_pos_read(file
);
689 ret
= vfs_readv(file
, vec
, vlen
, &pos
);
690 file_pos_write(file
, pos
);
691 fput_light(file
, fput_needed
);
695 add_rchar(current
, ret
);
700 SYSCALL_DEFINE3(writev
, unsigned long, fd
, const struct iovec __user
*, vec
,
704 ssize_t ret
= -EBADF
;
707 file
= fget_light(fd
, &fput_needed
);
709 loff_t pos
= file_pos_read(file
);
710 ret
= vfs_writev(file
, vec
, vlen
, &pos
);
711 file_pos_write(file
, pos
);
712 fput_light(file
, fput_needed
);
716 add_wchar(current
, ret
);
721 static ssize_t
do_sendfile(int out_fd
, int in_fd
, loff_t
*ppos
,
722 size_t count
, loff_t max
)
724 struct file
* in_file
, * out_file
;
725 struct inode
* in_inode
, * out_inode
;
728 int fput_needed_in
, fput_needed_out
, fl
;
731 * Get input file, and verify that it is ok..
734 in_file
= fget_light(in_fd
, &fput_needed_in
);
737 if (!(in_file
->f_mode
& FMODE_READ
))
740 in_inode
= in_file
->f_path
.dentry
->d_inode
;
743 if (!in_file
->f_op
|| !in_file
->f_op
->splice_read
)
747 ppos
= &in_file
->f_pos
;
749 if (!(in_file
->f_mode
& FMODE_PREAD
))
751 retval
= rw_verify_area(READ
, in_file
, ppos
, count
);
757 * Get output file, and verify that it is ok..
760 out_file
= fget_light(out_fd
, &fput_needed_out
);
763 if (!(out_file
->f_mode
& FMODE_WRITE
))
766 if (!out_file
->f_op
|| !out_file
->f_op
->sendpage
)
768 out_inode
= out_file
->f_path
.dentry
->d_inode
;
769 retval
= rw_verify_area(WRITE
, out_file
, &out_file
->f_pos
, count
);
775 max
= min(in_inode
->i_sb
->s_maxbytes
, out_inode
->i_sb
->s_maxbytes
);
779 if (unlikely(pos
< 0))
781 if (unlikely(pos
+ count
> max
)) {
791 * We need to debate whether we can enable this or not. The
792 * man page documents EAGAIN return for the output at least,
793 * and the application is arguably buggy if it doesn't expect
794 * EAGAIN on a non-blocking file descriptor.
796 if (in_file
->f_flags
& O_NONBLOCK
)
797 fl
= SPLICE_F_NONBLOCK
;
799 retval
= do_splice_direct(in_file
, ppos
, out_file
, count
, fl
);
802 add_rchar(current
, retval
);
803 add_wchar(current
, retval
);
812 fput_light(out_file
, fput_needed_out
);
814 fput_light(in_file
, fput_needed_in
);
819 SYSCALL_DEFINE4(sendfile
, int, out_fd
, int, in_fd
, off_t __user
*, offset
, size_t, count
)
826 if (unlikely(get_user(off
, offset
)))
829 ret
= do_sendfile(out_fd
, in_fd
, &pos
, count
, MAX_NON_LFS
);
830 if (unlikely(put_user(pos
, offset
)))
835 return do_sendfile(out_fd
, in_fd
, NULL
, count
, 0);
838 SYSCALL_DEFINE4(sendfile64
, int, out_fd
, int, in_fd
, loff_t __user
*, offset
, size_t, count
)
844 if (unlikely(copy_from_user(&pos
, offset
, sizeof(loff_t
))))
846 ret
= do_sendfile(out_fd
, in_fd
, &pos
, count
, 0);
847 if (unlikely(put_user(pos
, offset
)))
852 return do_sendfile(out_fd
, in_fd
, NULL
, count
, 0);