12 #include <linux/file.h>
37 static inline bool unsigned_offsets(struct file *file)  in unsigned_offsets()  argument
39 	return file->f_op->fop_flags & FOP_UNSIGNED_OFFSET;  in unsigned_offsets()
43  * vfs_setpos_cookie - update the file offset for lseek and reset cookie
44  * @file:	file structure in question
45  * @offset:	file offset to seek to
46  * @maxsize:	maximum file size
49  * Update the file offset to the value specified by @offset if the given
50  * offset is valid and it is not equal to the current file offset and
55 static loff_t vfs_setpos_cookie(struct file *file, loff_t offset,  in vfs_setpos_cookie()  argument
58 	if (offset < 0 && !unsigned_offsets(file))  in vfs_setpos_cookie()
63 	if (offset != file->f_pos) {  in vfs_setpos_cookie()
64 		file->f_pos = offset;  in vfs_setpos_cookie()
72  * vfs_setpos - update the file offset for lseek
73  * @file:	file structure in question
74  * @offset:	file offset to seek to
75  * @maxsize:	maximum file size
77  * This is a low-level filesystem helper for updating the file offset to
79  * not equal to the current file offset.
83 loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize)  in vfs_setpos()  argument
85 	return vfs_setpos_cookie(file, offset, maxsize, NULL);  in vfs_setpos()
91  * @file: file to seek on
94  * @eof: end of file
102 static int must_set_pos(struct file *file, loff_t *offset, int whence, loff_t eof)  in must_set_pos()  argument
112 		 * f_pos value back to the file because a concurrent read(),  in must_set_pos()
116 			*offset = file->f_pos;  in must_set_pos()
122 		 * In the generic case the entire file is data, so as long as  in must_set_pos()
123 		 * offset isn't at the end of the file then the offset is data.  in must_set_pos()
130 		 * There is a virtual hole at the end of the file, so as long as  in must_set_pos()
144  * @file:	file structure to seek on
145  * @offset:	file offset to seek to
147  * @maxsize:	max size of this file in file system
151  * maximum file size and a custom EOF position, for e.g. hashed directories
159 generic_file_llseek_size(struct file *file, loff_t offset, int whence,  in generic_file_llseek_size()  argument
164 	ret = must_set_pos(file, &offset, whence, eof);  in generic_file_llseek_size()
172 		 * If the file requires locking via f_pos_lock we know  in generic_file_llseek_size()
173 		 * that mutual exclusion for SEEK_CUR on the same file  in generic_file_llseek_size()
174 		 * is guaranteed. If the file isn't locked, we take  in generic_file_llseek_size()
178 		if (file_seek_cur_needs_f_lock(file)) {  in generic_file_llseek_size()
179 			guard(spinlock)(&file->f_lock);  in generic_file_llseek_size()
180 			return vfs_setpos(file, file->f_pos + offset, maxsize);  in generic_file_llseek_size()
182 		return vfs_setpos(file, file->f_pos + offset, maxsize);  in generic_file_llseek_size()
185 	return vfs_setpos(file, offset, maxsize);  in generic_file_llseek_size()
191  * @file:	file structure to seek on
192  * @offset:	file offset to seek to
201 loff_t generic_llseek_cookie(struct file *file, loff_t offset, int whence,  in generic_llseek_cookie()  argument
204 	struct inode *inode = file->f_mapping->host;  in generic_llseek_cookie()
217 	if (WARN_ON_ONCE(!(file->f_mode & FMODE_ATOMIC_POS)))  in generic_llseek_cookie()
220 	ret = must_set_pos(file, &offset, whence, eof);  in generic_llseek_cookie()
228 		return vfs_setpos_cookie(file, file->f_pos + offset, maxsize, cookie);  in generic_llseek_cookie()
230 	return vfs_setpos_cookie(file, offset, maxsize, cookie);  in generic_llseek_cookie()
236  * @file:	file structure to seek on
237  * @offset:	file offset to seek to
241  * filesystems.  It just updates the file offset to the value specified by
244 loff_t generic_file_llseek(struct file *file, loff_t offset, int whence)  in generic_file_llseek()  argument
246 	struct inode *inode = file->f_mapping->host;  in generic_file_llseek()
248 	return generic_file_llseek_size(file, offset, whence,  in generic_file_llseek()
256  * @file:	file structure to seek on
257  * @offset:	file offset to seek to
259  * @size:	size of the file
262 loff_t fixed_size_llseek(struct file *file, loff_t offset, int whence, loff_t size)  in fixed_size_llseek()  argument
266 		return generic_file_llseek_size(file, offset, whence,  in fixed_size_llseek()
276  * @file:	file structure to seek on
277  * @offset:	file offset to seek to
281 loff_t no_seek_end_llseek(struct file *file, loff_t offset, int whence)  in no_seek_end_llseek()  argument
285 		return generic_file_llseek_size(file, offset, whence,  in no_seek_end_llseek()
295  * @file:	file structure to seek on
296  * @offset:	file offset to seek to
301 loff_t no_seek_end_llseek_size(struct file *file, loff_t offset, int whence, loff_t size)  in no_seek_end_llseek_size()  argument
305 		return generic_file_llseek_size(file, offset, whence,  in no_seek_end_llseek_size()
315  * @file:	file structure to seek on
316  * @offset:	file offset to seek to
320  * userspace expects the seek to succeed but the (device) file is actually not
324 loff_t noop_llseek(struct file *file, loff_t offset, int whence)  in noop_llseek()  argument
326 	return file->f_pos;  in noop_llseek()
330 loff_t default_llseek(struct file *file, loff_t offset, int whence)  in default_llseek()  argument
332 	struct inode *inode = file_inode(file);  in default_llseek()
342 				retval = file->f_pos;  in default_llseek()
345 			offset += file->f_pos;  in default_llseek()
349 			 * In the generic case the entire file is data, so as  in default_llseek()
350 			 * long as offset isn't at the end of the file then the  in default_llseek()
360 			 * There is a virtual hole at the end of the file, so  in default_llseek()
372 	if (offset >= 0 || unsigned_offsets(file)) {  in default_llseek()
373 		if (offset != file->f_pos)  in default_llseek()
374 			file->f_pos = offset;  in default_llseek()
383 loff_t vfs_llseek(struct file *file, loff_t offset, int whence)  in vfs_llseek()  argument
385 	if (!(file->f_mode & FMODE_LSEEK))  in vfs_llseek()
387 	return file->f_op->llseek(file, offset, whence);  in vfs_llseek()
449 int rw_verify_area(int read_write, struct file *file, const loff_t *ppos, size_t count)  in rw_verify_area()  argument
461 			if (!unsigned_offsets(file))  in rw_verify_area()
466 			if (!unsigned_offsets(file))  in rw_verify_area()
471 	ret = security_file_permission(file, mask);  in rw_verify_area()
475 	return fsnotify_file_area_perm(file, mask, ppos, count);  in rw_verify_area()
479 static ssize_t new_sync_read(struct file *filp, char __user *buf, size_t len, loff_t *ppos)  in new_sync_read()
496 static int warn_unsupported(struct file *file, const char *op)  in warn_unsupported()  argument
499 		"kernel %s not supported for file %pD4 (pid: %d comm: %.20s)\n",  in warn_unsupported()
500 		op, file, current->pid, current->comm);  in warn_unsupported()
504 ssize_t __kernel_read(struct file *file, void *buf, size_t count, loff_t *pos)  in __kernel_read()  argument
514 	if (WARN_ON_ONCE(!(file->f_mode & FMODE_READ)))  in __kernel_read()
516 	if (!(file->f_mode & FMODE_CAN_READ))  in __kernel_read()
522 	if (unlikely(!file->f_op->read_iter || file->f_op->read))  in __kernel_read()
523 		return warn_unsupported(file, "read");  in __kernel_read()
525 	init_sync_kiocb(&kiocb, file);  in __kernel_read()
528 	ret = file->f_op->read_iter(&kiocb, &iter);  in __kernel_read()
532 		fsnotify_access(file);  in __kernel_read()
539 ssize_t kernel_read(struct file *file, void *buf, size_t count, loff_t *pos)  in kernel_read()  argument
543 	ret = rw_verify_area(READ, file, pos, count);  in kernel_read()
546 	return __kernel_read(file, buf, count, pos);  in kernel_read()
550 ssize_t vfs_read(struct file *file, char __user *buf, size_t count, loff_t *pos)  in vfs_read()  argument
554 	if (!(file->f_mode & FMODE_READ))  in vfs_read()
556 	if (!(file->f_mode & FMODE_CAN_READ))  in vfs_read()
561 	ret = rw_verify_area(READ, file, pos, count);  in vfs_read()
567 	if (file->f_op->read)  in vfs_read()
568 		ret = file->f_op->read(file, buf, count, pos);  in vfs_read()
569 	else if (file->f_op->read_iter)  in vfs_read()
570 		ret = new_sync_read(file, buf, count, pos);  in vfs_read()
574 		fsnotify_access(file);  in vfs_read()
581 static ssize_t new_sync_write(struct file *filp, const char __user *buf, size_t len, loff_t *ppos)  in new_sync_write()
599 ssize_t __kernel_write_iter(struct file *file, struct iov_iter *from, loff_t *pos)  in __kernel_write_iter()  argument
604 	if (WARN_ON_ONCE(!(file->f_mode & FMODE_WRITE)))  in __kernel_write_iter()
606 	if (!(file->f_mode & FMODE_CAN_WRITE))  in __kernel_write_iter()
612 	if (unlikely(!file->f_op->write_iter || file->f_op->write))  in __kernel_write_iter()
613 		return warn_unsupported(file, "write");  in __kernel_write_iter()
615 	init_sync_kiocb(&kiocb, file);  in __kernel_write_iter()
617 	ret = file->f_op->write_iter(&kiocb, from);  in __kernel_write_iter()
621 		fsnotify_modify(file);  in __kernel_write_iter()
629 ssize_t __kernel_write(struct file *file, const void *buf, size_t count, loff_t *pos)  in __kernel_write()  argument
637 	return __kernel_write_iter(file, &iter, pos);  in __kernel_write()
648 ssize_t kernel_write(struct file *file, const void *buf, size_t count,  in kernel_write()  argument
653 	ret = rw_verify_area(WRITE, file, pos, count);  in kernel_write()
657 	file_start_write(file);  in kernel_write()
658 	ret =  __kernel_write(file, buf, count, pos);  in kernel_write()
659 	file_end_write(file);  in kernel_write()
664 ssize_t vfs_write(struct file *file, const char __user *buf, size_t count, loff_t *pos)  in vfs_write()  argument
668 	if (!(file->f_mode & FMODE_WRITE))  in vfs_write()
670 	if (!(file->f_mode & FMODE_CAN_WRITE))  in vfs_write()
675 	ret = rw_verify_area(WRITE, file, pos, count);  in vfs_write()
680 	file_start_write(file);  in vfs_write()
681 	if (file->f_op->write)  in vfs_write()
682 		ret = file->f_op->write(file, buf, count, pos);  in vfs_write()
683 	else if (file->f_op->write_iter)  in vfs_write()
684 		ret = new_sync_write(file, buf, count, pos);  in vfs_write()
688 		fsnotify_modify(file);  in vfs_write()
692 	file_end_write(file);  in vfs_write()
696 /* file_ppos returns &file->f_pos or NULL if file is stream */
697 static inline loff_t *file_ppos(struct file *file)  in file_ppos()  argument
699 	return file->f_mode & FMODE_STREAM ? NULL : &file->f_pos;  in file_ppos()
810 static ssize_t do_iter_readv_writev(struct file *filp, struct iov_iter *iter,  in do_iter_readv_writev()
832 /* Do it by hand, with file-ops */
833 static ssize_t do_loop_readv_writev(struct file *filp, struct iov_iter *iter,  in do_loop_readv_writev()
866 ssize_t vfs_iocb_iter_read(struct file *file, struct kiocb *iocb,  in vfs_iocb_iter_read()  argument
872 	if (!file->f_op->read_iter)  in vfs_iocb_iter_read()
874 	if (!(file->f_mode & FMODE_READ))  in vfs_iocb_iter_read()
876 	if (!(file->f_mode & FMODE_CAN_READ))  in vfs_iocb_iter_read()
882 	ret = rw_verify_area(READ, file, &iocb->ki_pos, tot_len);  in vfs_iocb_iter_read()
886 	ret = file->f_op->read_iter(iocb, iter);  in vfs_iocb_iter_read()
889 		fsnotify_access(file);  in vfs_iocb_iter_read()
894 ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,  in vfs_iter_read()  argument
900 	if (!file->f_op->read_iter)  in vfs_iter_read()
902 	if (!(file->f_mode & FMODE_READ))  in vfs_iter_read()
904 	if (!(file->f_mode & FMODE_CAN_READ))  in vfs_iter_read()
910 	ret = rw_verify_area(READ, file, ppos, tot_len);  in vfs_iter_read()
914 	ret = do_iter_readv_writev(file, iter, ppos, READ, flags);  in vfs_iter_read()
917 		fsnotify_access(file);  in vfs_iter_read()
926 ssize_t vfs_iocb_iter_write(struct file *file, struct kiocb *iocb,  in vfs_iocb_iter_write()  argument
932 	if (!file->f_op->write_iter)  in vfs_iocb_iter_write()
934 	if (!(file->f_mode & FMODE_WRITE))  in vfs_iocb_iter_write()
936 	if (!(file->f_mode & FMODE_CAN_WRITE))  in vfs_iocb_iter_write()
942 	ret = rw_verify_area(WRITE, file, &iocb->ki_pos, tot_len);  in vfs_iocb_iter_write()
947 	ret = file->f_op->write_iter(iocb, iter);  in vfs_iocb_iter_write()
951 		fsnotify_modify(file);  in vfs_iocb_iter_write()
957 ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,  in vfs_iter_write()  argument
963 	if (!(file->f_mode & FMODE_WRITE))  in vfs_iter_write()
965 	if (!(file->f_mode & FMODE_CAN_WRITE))  in vfs_iter_write()
967 	if (!file->f_op->write_iter)  in vfs_iter_write()
974 	ret = rw_verify_area(WRITE, file, ppos, tot_len);  in vfs_iter_write()
978 	file_start_write(file);  in vfs_iter_write()
979 	ret = do_iter_readv_writev(file, iter, ppos, WRITE, flags);  in vfs_iter_write()
981 		fsnotify_modify(file);  in vfs_iter_write()
982 	file_end_write(file);  in vfs_iter_write()
988 static ssize_t vfs_readv(struct file *file, const struct iovec __user *vec,  in vfs_readv()  argument
997 	if (!(file->f_mode & FMODE_READ))  in vfs_readv()
999 	if (!(file->f_mode & FMODE_CAN_READ))  in vfs_readv()
1011 	ret = rw_verify_area(READ, file, pos, tot_len);  in vfs_readv()
1015 	if (file->f_op->read_iter)  in vfs_readv()
1016 		ret = do_iter_readv_writev(file, &iter, pos, READ, flags);  in vfs_readv()
1018 		ret = do_loop_readv_writev(file, &iter, pos, READ, flags);  in vfs_readv()
1021 		fsnotify_access(file);  in vfs_readv()
1026 static ssize_t vfs_writev(struct file *file, const struct iovec __user *vec,  in vfs_writev()  argument
1035 	if (!(file->f_mode & FMODE_WRITE))  in vfs_writev()
1037 	if (!(file->f_mode & FMODE_CAN_WRITE))  in vfs_writev()
1049 	ret = rw_verify_area(WRITE, file, pos, tot_len);  in vfs_writev()
1053 	file_start_write(file);  in vfs_writev()
1054 	if (file->f_op->write_iter)  in vfs_writev()
1055 		ret = do_iter_readv_writev(file, &iter, pos, WRITE, flags);  in vfs_writev()
1057 		ret = do_loop_readv_writev(file, &iter, pos, WRITE, flags);  in vfs_writev()
1059 		fsnotify_modify(file);  in vfs_writev()
1060 	file_end_write(file);  in vfs_writev()
1311 	 * Get input file, and verify that it is ok..  in do_sendfile()
1332 	 * Get output file, and verify that it is ok..  in do_sendfile()
1358 	 * EAGAIN on a non-blocking file descriptor.  in do_sendfile()
1473  * Performs necessary checks before doing a file copy
1479 static int generic_copy_file_checks(struct file *file_in, loff_t pos_in,  in generic_copy_file_checks()
1480 				    struct file *file_out, loff_t pos_out,  in generic_copy_file_checks()
1495 	 * a file of the wrong filesystem type to filesystem driver can result  in generic_copy_file_checks()
1535 	/* Don't allow overlapped copying within the same file. */  in generic_copy_file_checks()
1546  * copy_file_range() differs from regular file read and write in that it
1550 ssize_t vfs_copy_file_range(struct file *file_in, loff_t pos_in,  in vfs_copy_file_range()
1551 			    struct file *file_out, loff_t pos_out,  in vfs_copy_file_range()
1580 	 * Cloning is supported by more file systems, so we implement copy on  in vfs_copy_file_range()
1622 	 * to splicing from input file, while file_start_write() is held on  in vfs_copy_file_range()
1623 	 * the output file on a different sb.  in vfs_copy_file_range()
1703 int generic_write_check_limits(struct file *file, loff_t pos, loff_t *count)  in generic_write_check_limits()  argument
1705 	struct inode *inode = file->f_mapping->host;  in generic_write_check_limits()
1717 	if (!(file->f_flags & O_LARGEFILE))  in generic_write_check_limits()
1732 	struct file *file = iocb->ki_filp;  in generic_write_checks_count()  local
1733 	struct inode *inode = file->f_mapping->host;  in generic_write_checks_count()
1746 	      (file->f_op->fop_flags & FOP_BUFFER_WASYNC)))  in generic_write_checks_count()
1775  * Performs common checks before doing a file copy/clone
1778 int generic_file_rw_checks(struct file *file_in, struct file *file_out)  in generic_file_rw_checks()