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/fsnotify.h>
13 #include <linux/security.h>
14 #include <linux/export.h>
15 #include <linux/syscalls.h>
16 #include <linux/pagemap.h>
17 #include <linux/splice.h>
18 #include <linux/compat.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
);
34 static inline int unsigned_offsets(struct file
*file
)
36 return file
->f_mode
& FMODE_UNSIGNED_OFFSET
;
39 static loff_t
lseek_execute(struct file
*file
, struct inode
*inode
,
40 loff_t offset
, loff_t maxsize
)
42 if (offset
< 0 && !unsigned_offsets(file
))
47 if (offset
!= file
->f_pos
) {
55 * generic_file_llseek_size - generic llseek implementation for regular files
56 * @file: file structure to seek on
57 * @offset: file offset to seek to
58 * @whence: type of seek
59 * @size: max size of this file in file system
60 * @eof: offset used for SEEK_END position
62 * This is a variant of generic_file_llseek that allows passing in a custom
63 * maximum file size and a custom EOF position, for e.g. hashed directories
66 * SEEK_SET and SEEK_END are unsynchronized (but atomic on 64bit platforms)
67 * SEEK_CUR is synchronized against other SEEK_CURs, but not read/writes.
68 * read/writes behave like SEEK_SET against seeks.
71 generic_file_llseek_size(struct file
*file
, loff_t offset
, int whence
,
72 loff_t maxsize
, loff_t eof
)
74 struct inode
*inode
= file
->f_mapping
->host
;
82 * Here we special-case the lseek(fd, 0, SEEK_CUR)
83 * position-querying operation. Avoid rewriting the "same"
84 * f_pos value back to the file because a concurrent read(),
85 * write() or lseek() might have altered it
90 * f_lock protects against read/modify/write race with other
91 * SEEK_CURs. Note that parallel writes and reads behave
94 spin_lock(&file
->f_lock
);
95 offset
= lseek_execute(file
, inode
, file
->f_pos
+ offset
,
97 spin_unlock(&file
->f_lock
);
101 * In the generic case the entire file is data, so as long as
102 * offset isn't at the end of the file then the offset is data.
109 * There is a virtual hole at the end of the file, so as long as
110 * offset isn't i_size or larger, return i_size.
118 return lseek_execute(file
, inode
, offset
, maxsize
);
120 EXPORT_SYMBOL(generic_file_llseek_size
);
123 * generic_file_llseek - generic llseek implementation for regular files
124 * @file: file structure to seek on
125 * @offset: file offset to seek to
126 * @whence: type of seek
128 * This is a generic implemenation of ->llseek useable for all normal local
129 * filesystems. It just updates the file offset to the value specified by
130 * @offset and @whence under i_mutex.
132 loff_t
generic_file_llseek(struct file
*file
, loff_t offset
, int whence
)
134 struct inode
*inode
= file
->f_mapping
->host
;
136 return generic_file_llseek_size(file
, offset
, whence
,
137 inode
->i_sb
->s_maxbytes
,
140 EXPORT_SYMBOL(generic_file_llseek
);
143 * noop_llseek - No Operation Performed llseek implementation
144 * @file: file structure to seek on
145 * @offset: file offset to seek to
146 * @whence: type of seek
148 * This is an implementation of ->llseek useable for the rare special case when
149 * userspace expects the seek to succeed but the (device) file is actually not
150 * able to perform the seek. In this case you use noop_llseek() instead of
151 * falling back to the default implementation of ->llseek.
153 loff_t
noop_llseek(struct file
*file
, loff_t offset
, int whence
)
157 EXPORT_SYMBOL(noop_llseek
);
159 loff_t
no_llseek(struct file
*file
, loff_t offset
, int whence
)
163 EXPORT_SYMBOL(no_llseek
);
165 loff_t
default_llseek(struct file
*file
, loff_t offset
, int whence
)
167 struct inode
*inode
= file_inode(file
);
170 mutex_lock(&inode
->i_mutex
);
173 offset
+= i_size_read(inode
);
177 retval
= file
->f_pos
;
180 offset
+= file
->f_pos
;
184 * In the generic case the entire file is data, so as
185 * long as offset isn't at the end of the file then the
188 if (offset
>= inode
->i_size
) {
195 * There is a virtual hole at the end of the file, so
196 * as long as offset isn't i_size or larger, return
199 if (offset
>= inode
->i_size
) {
203 offset
= inode
->i_size
;
207 if (offset
>= 0 || unsigned_offsets(file
)) {
208 if (offset
!= file
->f_pos
) {
209 file
->f_pos
= offset
;
215 mutex_unlock(&inode
->i_mutex
);
218 EXPORT_SYMBOL(default_llseek
);
220 loff_t
vfs_llseek(struct file
*file
, loff_t offset
, int whence
)
222 loff_t (*fn
)(struct file
*, loff_t
, int);
225 if (file
->f_mode
& FMODE_LSEEK
) {
226 if (file
->f_op
&& file
->f_op
->llseek
)
227 fn
= file
->f_op
->llseek
;
229 return fn(file
, offset
, whence
);
231 EXPORT_SYMBOL(vfs_llseek
);
233 SYSCALL_DEFINE3(lseek
, unsigned int, fd
, off_t
, offset
, unsigned int, whence
)
236 struct fd f
= fdget(fd
);
241 if (whence
<= SEEK_MAX
) {
242 loff_t res
= vfs_llseek(f
.file
, offset
, whence
);
244 if (res
!= (loff_t
)retval
)
245 retval
= -EOVERFLOW
; /* LFS: should only happen on 32 bit platforms */
252 COMPAT_SYSCALL_DEFINE3(lseek
, unsigned int, fd
, compat_off_t
, offset
, unsigned int, whence
)
254 return sys_lseek(fd
, offset
, whence
);
258 #ifdef __ARCH_WANT_SYS_LLSEEK
259 SYSCALL_DEFINE5(llseek
, unsigned int, fd
, unsigned long, offset_high
,
260 unsigned long, offset_low
, loff_t __user
*, result
,
261 unsigned int, whence
)
264 struct fd f
= fdget(fd
);
271 if (whence
> SEEK_MAX
)
274 offset
= vfs_llseek(f
.file
, ((loff_t
) offset_high
<< 32) | offset_low
,
277 retval
= (int)offset
;
280 if (!copy_to_user(result
, &offset
, sizeof(offset
)))
290 * rw_verify_area doesn't like huge counts. We limit
291 * them to something that fits in "int" so that others
292 * won't have to do range checks all the time.
294 int rw_verify_area(int read_write
, struct file
*file
, loff_t
*ppos
, size_t count
)
298 int retval
= -EINVAL
;
300 inode
= file_inode(file
);
301 if (unlikely((ssize_t
) count
< 0))
304 if (unlikely(pos
< 0)) {
305 if (!unsigned_offsets(file
))
307 if (count
>= -pos
) /* both values are in 0..LLONG_MAX */
309 } else if (unlikely((loff_t
) (pos
+ count
) < 0)) {
310 if (!unsigned_offsets(file
))
314 if (unlikely(inode
->i_flock
&& mandatory_lock(inode
))) {
315 retval
= locks_mandatory_area(
316 read_write
== READ
? FLOCK_VERIFY_READ
: FLOCK_VERIFY_WRITE
,
317 inode
, file
, pos
, count
);
321 retval
= security_file_permission(file
,
322 read_write
== READ
? MAY_READ
: MAY_WRITE
);
325 return count
> MAX_RW_COUNT
? MAX_RW_COUNT
: count
;
328 static void wait_on_retry_sync_kiocb(struct kiocb
*iocb
)
330 set_current_state(TASK_UNINTERRUPTIBLE
);
331 if (!kiocbIsKicked(iocb
))
334 kiocbClearKicked(iocb
);
335 __set_current_state(TASK_RUNNING
);
338 ssize_t
do_sync_read(struct file
*filp
, char __user
*buf
, size_t len
, loff_t
*ppos
)
340 struct iovec iov
= { .iov_base
= buf
, .iov_len
= len
};
344 init_sync_kiocb(&kiocb
, filp
);
345 kiocb
.ki_pos
= *ppos
;
347 kiocb
.ki_nbytes
= len
;
350 ret
= filp
->f_op
->aio_read(&kiocb
, &iov
, 1, kiocb
.ki_pos
);
351 if (ret
!= -EIOCBRETRY
)
353 wait_on_retry_sync_kiocb(&kiocb
);
356 if (-EIOCBQUEUED
== ret
)
357 ret
= wait_on_sync_kiocb(&kiocb
);
358 *ppos
= kiocb
.ki_pos
;
362 EXPORT_SYMBOL(do_sync_read
);
364 ssize_t
vfs_read(struct file
*file
, char __user
*buf
, size_t count
, loff_t
*pos
)
368 if (!(file
->f_mode
& FMODE_READ
))
370 if (!file
->f_op
|| (!file
->f_op
->read
&& !file
->f_op
->aio_read
))
372 if (unlikely(!access_ok(VERIFY_WRITE
, buf
, count
)))
375 ret
= rw_verify_area(READ
, file
, pos
, count
);
378 if (file
->f_op
->read
)
379 ret
= file
->f_op
->read(file
, buf
, count
, pos
);
381 ret
= do_sync_read(file
, buf
, count
, pos
);
383 fsnotify_access(file
);
384 add_rchar(current
, ret
);
392 EXPORT_SYMBOL(vfs_read
);
394 ssize_t
do_sync_write(struct file
*filp
, const char __user
*buf
, size_t len
, loff_t
*ppos
)
396 struct iovec iov
= { .iov_base
= (void __user
*)buf
, .iov_len
= len
};
400 init_sync_kiocb(&kiocb
, filp
);
401 kiocb
.ki_pos
= *ppos
;
403 kiocb
.ki_nbytes
= len
;
406 ret
= filp
->f_op
->aio_write(&kiocb
, &iov
, 1, kiocb
.ki_pos
);
407 if (ret
!= -EIOCBRETRY
)
409 wait_on_retry_sync_kiocb(&kiocb
);
412 if (-EIOCBQUEUED
== ret
)
413 ret
= wait_on_sync_kiocb(&kiocb
);
414 *ppos
= kiocb
.ki_pos
;
418 EXPORT_SYMBOL(do_sync_write
);
420 ssize_t
vfs_write(struct file
*file
, const char __user
*buf
, size_t count
, loff_t
*pos
)
424 if (!(file
->f_mode
& FMODE_WRITE
))
426 if (!file
->f_op
|| (!file
->f_op
->write
&& !file
->f_op
->aio_write
))
428 if (unlikely(!access_ok(VERIFY_READ
, buf
, count
)))
431 ret
= rw_verify_area(WRITE
, file
, pos
, count
);
434 if (file
->f_op
->write
)
435 ret
= file
->f_op
->write(file
, buf
, count
, pos
);
437 ret
= do_sync_write(file
, buf
, count
, pos
);
439 fsnotify_modify(file
);
440 add_wchar(current
, ret
);
448 EXPORT_SYMBOL(vfs_write
);
450 static inline loff_t
file_pos_read(struct file
*file
)
455 static inline void file_pos_write(struct file
*file
, loff_t pos
)
460 SYSCALL_DEFINE3(read
, unsigned int, fd
, char __user
*, buf
, size_t, count
)
462 struct fd f
= fdget(fd
);
463 ssize_t ret
= -EBADF
;
466 loff_t pos
= file_pos_read(f
.file
);
467 ret
= vfs_read(f
.file
, buf
, count
, &pos
);
468 file_pos_write(f
.file
, pos
);
474 SYSCALL_DEFINE3(write
, unsigned int, fd
, const char __user
*, buf
,
477 struct fd f
= fdget(fd
);
478 ssize_t ret
= -EBADF
;
481 loff_t pos
= file_pos_read(f
.file
);
482 ret
= vfs_write(f
.file
, buf
, count
, &pos
);
483 file_pos_write(f
.file
, pos
);
490 SYSCALL_DEFINE(pread64
)(unsigned int fd
, char __user
*buf
,
491 size_t count
, loff_t pos
)
494 ssize_t ret
= -EBADF
;
502 if (f
.file
->f_mode
& FMODE_PREAD
)
503 ret
= vfs_read(f
.file
, buf
, count
, &pos
);
509 #ifdef CONFIG_HAVE_SYSCALL_WRAPPERS
510 asmlinkage
long SyS_pread64(long fd
, long buf
, long count
, loff_t pos
)
512 return SYSC_pread64((unsigned int) fd
, (char __user
*) buf
,
513 (size_t) count
, pos
);
515 SYSCALL_ALIAS(sys_pread64
, SyS_pread64
);
518 SYSCALL_DEFINE(pwrite64
)(unsigned int fd
, const char __user
*buf
,
519 size_t count
, loff_t pos
)
522 ssize_t ret
= -EBADF
;
530 if (f
.file
->f_mode
& FMODE_PWRITE
)
531 ret
= vfs_write(f
.file
, buf
, count
, &pos
);
537 #ifdef CONFIG_HAVE_SYSCALL_WRAPPERS
538 asmlinkage
long SyS_pwrite64(long fd
, long buf
, long count
, loff_t pos
)
540 return SYSC_pwrite64((unsigned int) fd
, (const char __user
*) buf
,
541 (size_t) count
, pos
);
543 SYSCALL_ALIAS(sys_pwrite64
, SyS_pwrite64
);
547 * Reduce an iovec's length in-place. Return the resulting number of segments
549 unsigned long iov_shorten(struct iovec
*iov
, unsigned long nr_segs
, size_t to
)
551 unsigned long seg
= 0;
554 while (seg
< nr_segs
) {
556 if (len
+ iov
->iov_len
>= to
) {
557 iov
->iov_len
= to
- len
;
565 EXPORT_SYMBOL(iov_shorten
);
567 ssize_t
do_sync_readv_writev(struct file
*filp
, const struct iovec
*iov
,
568 unsigned long nr_segs
, size_t len
, loff_t
*ppos
, iov_fn_t fn
)
573 init_sync_kiocb(&kiocb
, filp
);
574 kiocb
.ki_pos
= *ppos
;
576 kiocb
.ki_nbytes
= len
;
579 ret
= fn(&kiocb
, iov
, nr_segs
, kiocb
.ki_pos
);
580 if (ret
!= -EIOCBRETRY
)
582 wait_on_retry_sync_kiocb(&kiocb
);
585 if (ret
== -EIOCBQUEUED
)
586 ret
= wait_on_sync_kiocb(&kiocb
);
587 *ppos
= kiocb
.ki_pos
;
591 /* Do it by hand, with file-ops */
592 ssize_t
do_loop_readv_writev(struct file
*filp
, struct iovec
*iov
,
593 unsigned long nr_segs
, loff_t
*ppos
, io_fn_t fn
)
595 struct iovec
*vector
= iov
;
598 while (nr_segs
> 0) {
603 base
= vector
->iov_base
;
604 len
= vector
->iov_len
;
608 nr
= fn(filp
, base
, len
, ppos
);
623 /* A write operation does a read from user space and vice versa */
624 #define vrfy_dir(type) ((type) == READ ? VERIFY_WRITE : VERIFY_READ)
626 ssize_t
rw_copy_check_uvector(int type
, const struct iovec __user
* uvector
,
627 unsigned long nr_segs
, unsigned long fast_segs
,
628 struct iovec
*fast_pointer
,
629 struct iovec
**ret_pointer
)
633 struct iovec
*iov
= fast_pointer
;
636 * SuS says "The readv() function *may* fail if the iovcnt argument
637 * was less than or equal to 0, or greater than {IOV_MAX}. Linux has
638 * traditionally returned zero for zero segments, so...
646 * First get the "struct iovec" from user memory and
647 * verify all the pointers
649 if (nr_segs
> UIO_MAXIOV
) {
653 if (nr_segs
> fast_segs
) {
654 iov
= kmalloc(nr_segs
*sizeof(struct iovec
), GFP_KERNEL
);
660 if (copy_from_user(iov
, uvector
, nr_segs
*sizeof(*uvector
))) {
666 * According to the Single Unix Specification we should return EINVAL
667 * if an element length is < 0 when cast to ssize_t or if the
668 * total length would overflow the ssize_t return value of the
671 * Linux caps all read/write calls to MAX_RW_COUNT, and avoids the
675 for (seg
= 0; seg
< nr_segs
; seg
++) {
676 void __user
*buf
= iov
[seg
].iov_base
;
677 ssize_t len
= (ssize_t
)iov
[seg
].iov_len
;
679 /* see if we we're about to use an invalid len or if
680 * it's about to overflow ssize_t */
686 && unlikely(!access_ok(vrfy_dir(type
), buf
, len
))) {
690 if (len
> MAX_RW_COUNT
- ret
) {
691 len
= MAX_RW_COUNT
- ret
;
692 iov
[seg
].iov_len
= len
;
701 static ssize_t
do_readv_writev(int type
, struct file
*file
,
702 const struct iovec __user
* uvector
,
703 unsigned long nr_segs
, loff_t
*pos
)
706 struct iovec iovstack
[UIO_FASTIOV
];
707 struct iovec
*iov
= iovstack
;
717 ret
= rw_copy_check_uvector(type
, uvector
, nr_segs
,
718 ARRAY_SIZE(iovstack
), iovstack
, &iov
);
723 ret
= rw_verify_area(type
, file
, pos
, tot_len
);
729 fn
= file
->f_op
->read
;
730 fnv
= file
->f_op
->aio_read
;
732 fn
= (io_fn_t
)file
->f_op
->write
;
733 fnv
= file
->f_op
->aio_write
;
737 ret
= do_sync_readv_writev(file
, iov
, nr_segs
, tot_len
,
740 ret
= do_loop_readv_writev(file
, iov
, nr_segs
, pos
, fn
);
745 if ((ret
+ (type
== READ
)) > 0) {
747 fsnotify_access(file
);
749 fsnotify_modify(file
);
754 ssize_t
vfs_readv(struct file
*file
, const struct iovec __user
*vec
,
755 unsigned long vlen
, loff_t
*pos
)
757 if (!(file
->f_mode
& FMODE_READ
))
759 if (!file
->f_op
|| (!file
->f_op
->aio_read
&& !file
->f_op
->read
))
762 return do_readv_writev(READ
, file
, vec
, vlen
, pos
);
765 EXPORT_SYMBOL(vfs_readv
);
767 ssize_t
vfs_writev(struct file
*file
, const struct iovec __user
*vec
,
768 unsigned long vlen
, loff_t
*pos
)
770 if (!(file
->f_mode
& FMODE_WRITE
))
772 if (!file
->f_op
|| (!file
->f_op
->aio_write
&& !file
->f_op
->write
))
775 return do_readv_writev(WRITE
, file
, vec
, vlen
, pos
);
778 EXPORT_SYMBOL(vfs_writev
);
780 SYSCALL_DEFINE3(readv
, unsigned long, fd
, const struct iovec __user
*, vec
,
783 struct fd f
= fdget(fd
);
784 ssize_t ret
= -EBADF
;
787 loff_t pos
= file_pos_read(f
.file
);
788 ret
= vfs_readv(f
.file
, vec
, vlen
, &pos
);
789 file_pos_write(f
.file
, pos
);
794 add_rchar(current
, ret
);
799 SYSCALL_DEFINE3(writev
, unsigned long, fd
, const struct iovec __user
*, vec
,
802 struct fd f
= fdget(fd
);
803 ssize_t ret
= -EBADF
;
806 loff_t pos
= file_pos_read(f
.file
);
807 ret
= vfs_writev(f
.file
, vec
, vlen
, &pos
);
808 file_pos_write(f
.file
, pos
);
813 add_wchar(current
, ret
);
818 static inline loff_t
pos_from_hilo(unsigned long high
, unsigned long low
)
820 #define HALF_LONG_BITS (BITS_PER_LONG / 2)
821 return (((loff_t
)high
<< HALF_LONG_BITS
) << HALF_LONG_BITS
) | low
;
824 SYSCALL_DEFINE5(preadv
, unsigned long, fd
, const struct iovec __user
*, vec
,
825 unsigned long, vlen
, unsigned long, pos_l
, unsigned long, pos_h
)
827 loff_t pos
= pos_from_hilo(pos_h
, pos_l
);
829 ssize_t ret
= -EBADF
;
837 if (f
.file
->f_mode
& FMODE_PREAD
)
838 ret
= vfs_readv(f
.file
, vec
, vlen
, &pos
);
843 add_rchar(current
, ret
);
848 SYSCALL_DEFINE5(pwritev
, unsigned long, fd
, const struct iovec __user
*, vec
,
849 unsigned long, vlen
, unsigned long, pos_l
, unsigned long, pos_h
)
851 loff_t pos
= pos_from_hilo(pos_h
, pos_l
);
853 ssize_t ret
= -EBADF
;
861 if (f
.file
->f_mode
& FMODE_PWRITE
)
862 ret
= vfs_writev(f
.file
, vec
, vlen
, &pos
);
867 add_wchar(current
, ret
);
872 ssize_t
do_sendfile(int out_fd
, int in_fd
, loff_t
*ppos
, size_t count
,
876 struct inode
*in_inode
, *out_inode
;
882 * Get input file, and verify that it is ok..
888 if (!(in
.file
->f_mode
& FMODE_READ
))
892 ppos
= &in
.file
->f_pos
;
894 if (!(in
.file
->f_mode
& FMODE_PREAD
))
896 retval
= rw_verify_area(READ
, in
.file
, ppos
, count
);
902 * Get output file, and verify that it is ok..
908 if (!(out
.file
->f_mode
& FMODE_WRITE
))
911 in_inode
= file_inode(in
.file
);
912 out_inode
= file_inode(out
.file
);
913 retval
= rw_verify_area(WRITE
, out
.file
, &out
.file
->f_pos
, count
);
919 max
= min(in_inode
->i_sb
->s_maxbytes
, out_inode
->i_sb
->s_maxbytes
);
922 if (unlikely(pos
+ count
> max
)) {
932 * We need to debate whether we can enable this or not. The
933 * man page documents EAGAIN return for the output at least,
934 * and the application is arguably buggy if it doesn't expect
935 * EAGAIN on a non-blocking file descriptor.
937 if (in
.file
->f_flags
& O_NONBLOCK
)
938 fl
= SPLICE_F_NONBLOCK
;
940 retval
= do_splice_direct(in
.file
, ppos
, out
.file
, count
, fl
);
943 add_rchar(current
, retval
);
944 add_wchar(current
, retval
);
945 fsnotify_access(in
.file
);
946 fsnotify_modify(out
.file
);
962 SYSCALL_DEFINE4(sendfile
, int, out_fd
, int, in_fd
, off_t __user
*, offset
, size_t, count
)
969 if (unlikely(get_user(off
, offset
)))
972 ret
= do_sendfile(out_fd
, in_fd
, &pos
, count
, MAX_NON_LFS
);
973 if (unlikely(put_user(pos
, offset
)))
978 return do_sendfile(out_fd
, in_fd
, NULL
, count
, 0);
981 SYSCALL_DEFINE4(sendfile64
, int, out_fd
, int, in_fd
, loff_t __user
*, offset
, size_t, count
)
987 if (unlikely(copy_from_user(&pos
, offset
, sizeof(loff_t
))))
989 ret
= do_sendfile(out_fd
, in_fd
, &pos
, count
, 0);
990 if (unlikely(put_user(pos
, offset
)))
995 return do_sendfile(out_fd
, in_fd
, NULL
, count
, 0);