1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2017 Red Hat, Inc.
6 #include <linux/cred.h>
7 #include <linux/file.h>
8 #include <linux/mount.h>
9 #include <linux/xattr.h>
10 #include <linux/uio.h>
11 #include <linux/uaccess.h>
12 #include <linux/splice.h>
13 #include <linux/security.h>
16 #include "overlayfs.h"
20 struct kiocb *orig_iocb;
24 static struct kmem_cache *ovl_aio_request_cachep;
26 static char ovl_whatisit(struct inode *inode, struct inode *realinode)
28 if (realinode != ovl_inode_upper(inode))
30 if (ovl_has_upperdata(inode))
36 /* No atime modificaton nor notify on underlying */
37 #define OVL_OPEN_FLAGS (O_NOATIME | FMODE_NONOTIFY)
39 static struct file *ovl_open_realfile(const struct file *file,
40 struct inode *realinode)
42 struct inode *inode = file_inode(file);
43 struct file *realfile;
44 const struct cred *old_cred;
45 int flags = file->f_flags | OVL_OPEN_FLAGS;
46 int acc_mode = ACC_MODE(flags);
50 acc_mode |= MAY_APPEND;
52 old_cred = ovl_override_creds(inode->i_sb);
53 err = inode_permission(realinode, MAY_OPEN | acc_mode);
55 realfile = ERR_PTR(err);
56 } else if (!inode_owner_or_capable(realinode)) {
57 realfile = ERR_PTR(-EPERM);
59 realfile = open_with_fake_path(&file->f_path, flags, realinode,
62 revert_creds(old_cred);
64 pr_debug("open(%p[%pD2/%c], 0%o) -> (%p, 0%o)\n",
65 file, file, ovl_whatisit(inode, realinode), file->f_flags,
66 realfile, IS_ERR(realfile) ? 0 : realfile->f_flags);
71 #define OVL_SETFL_MASK (O_APPEND | O_NONBLOCK | O_NDELAY | O_DIRECT)
73 static int ovl_change_flags(struct file *file, unsigned int flags)
75 struct inode *inode = file_inode(file);
78 flags |= OVL_OPEN_FLAGS;
80 /* If some flag changed that cannot be changed then something's amiss */
81 if (WARN_ON((file->f_flags ^ flags) & ~OVL_SETFL_MASK))
84 flags &= OVL_SETFL_MASK;
86 if (((flags ^ file->f_flags) & O_APPEND) && IS_APPEND(inode))
89 if (flags & O_DIRECT) {
90 if (!file->f_mapping->a_ops ||
91 !file->f_mapping->a_ops->direct_IO)
95 if (file->f_op->check_flags) {
96 err = file->f_op->check_flags(flags);
101 spin_lock(&file->f_lock);
102 file->f_flags = (file->f_flags & ~OVL_SETFL_MASK) | flags;
103 spin_unlock(&file->f_lock);
108 static int ovl_real_fdget_meta(const struct file *file, struct fd *real,
111 struct inode *inode = file_inode(file);
112 struct inode *realinode;
115 real->file = file->private_data;
118 realinode = ovl_inode_real(inode);
120 realinode = ovl_inode_realdata(inode);
122 /* Has it been copied up since we'd opened it? */
123 if (unlikely(file_inode(real->file) != realinode)) {
124 real->flags = FDPUT_FPUT;
125 real->file = ovl_open_realfile(file, realinode);
127 return PTR_ERR_OR_ZERO(real->file);
130 /* Did the flags change since open? */
131 if (unlikely((file->f_flags ^ real->file->f_flags) & ~OVL_OPEN_FLAGS))
132 return ovl_change_flags(real->file, file->f_flags);
137 static int ovl_real_fdget(const struct file *file, struct fd *real)
139 if (d_is_dir(file_dentry(file))) {
141 real->file = ovl_dir_real_file(file, false);
143 return PTR_ERR_OR_ZERO(real->file);
146 return ovl_real_fdget_meta(file, real, false);
149 static int ovl_open(struct inode *inode, struct file *file)
151 struct file *realfile;
154 err = ovl_maybe_copy_up(file_dentry(file), file->f_flags);
158 /* No longer need these flags, so don't pass them on to underlying fs */
159 file->f_flags &= ~(O_CREAT | O_EXCL | O_NOCTTY | O_TRUNC);
161 realfile = ovl_open_realfile(file, ovl_inode_realdata(inode));
162 if (IS_ERR(realfile))
163 return PTR_ERR(realfile);
165 file->private_data = realfile;
170 static int ovl_release(struct inode *inode, struct file *file)
172 fput(file->private_data);
177 static loff_t ovl_llseek(struct file *file, loff_t offset, int whence)
179 struct inode *inode = file_inode(file);
181 const struct cred *old_cred;
185 * The two special cases below do not need to involve real fs,
186 * so we can optimizing concurrent callers.
189 if (whence == SEEK_CUR)
192 if (whence == SEEK_SET)
193 return vfs_setpos(file, 0, 0);
196 ret = ovl_real_fdget(file, &real);
201 * Overlay file f_pos is the master copy that is preserved
202 * through copy up and modified on read/write, but only real
203 * fs knows how to SEEK_HOLE/SEEK_DATA and real fs may impose
204 * limitations that are more strict than ->s_maxbytes for specific
205 * files, so we use the real file to perform seeks.
207 ovl_inode_lock(inode);
208 real.file->f_pos = file->f_pos;
210 old_cred = ovl_override_creds(inode->i_sb);
211 ret = vfs_llseek(real.file, offset, whence);
212 revert_creds(old_cred);
214 file->f_pos = real.file->f_pos;
215 ovl_inode_unlock(inode);
222 static void ovl_file_accessed(struct file *file)
224 struct inode *inode, *upperinode;
226 if (file->f_flags & O_NOATIME)
229 inode = file_inode(file);
230 upperinode = ovl_inode_upper(inode);
235 if ((!timespec64_equal(&inode->i_mtime, &upperinode->i_mtime) ||
236 !timespec64_equal(&inode->i_ctime, &upperinode->i_ctime))) {
237 inode->i_mtime = upperinode->i_mtime;
238 inode->i_ctime = upperinode->i_ctime;
241 touch_atime(&file->f_path);
244 static rwf_t ovl_iocb_to_rwf(int ifl)
248 if (ifl & IOCB_NOWAIT)
250 if (ifl & IOCB_HIPRI)
252 if (ifl & IOCB_DSYNC)
260 static void ovl_aio_cleanup_handler(struct ovl_aio_req *aio_req)
262 struct kiocb *iocb = &aio_req->iocb;
263 struct kiocb *orig_iocb = aio_req->orig_iocb;
265 if (iocb->ki_flags & IOCB_WRITE) {
266 struct inode *inode = file_inode(orig_iocb->ki_filp);
268 /* Actually acquired in ovl_write_iter() */
269 __sb_writers_acquired(file_inode(iocb->ki_filp)->i_sb,
271 file_end_write(iocb->ki_filp);
272 ovl_copyattr(ovl_inode_real(inode), inode);
275 orig_iocb->ki_pos = iocb->ki_pos;
277 kmem_cache_free(ovl_aio_request_cachep, aio_req);
280 static void ovl_aio_rw_complete(struct kiocb *iocb, long res, long res2)
282 struct ovl_aio_req *aio_req = container_of(iocb,
283 struct ovl_aio_req, iocb);
284 struct kiocb *orig_iocb = aio_req->orig_iocb;
286 ovl_aio_cleanup_handler(aio_req);
287 orig_iocb->ki_complete(orig_iocb, res, res2);
290 static ssize_t ovl_read_iter(struct kiocb *iocb, struct iov_iter *iter)
292 struct file *file = iocb->ki_filp;
294 const struct cred *old_cred;
297 if (!iov_iter_count(iter))
300 ret = ovl_real_fdget(file, &real);
304 old_cred = ovl_override_creds(file_inode(file)->i_sb);
305 if (is_sync_kiocb(iocb)) {
306 ret = vfs_iter_read(real.file, iter, &iocb->ki_pos,
307 ovl_iocb_to_rwf(iocb->ki_flags));
309 struct ovl_aio_req *aio_req;
312 aio_req = kmem_cache_zalloc(ovl_aio_request_cachep, GFP_KERNEL);
318 aio_req->orig_iocb = iocb;
319 kiocb_clone(&aio_req->iocb, iocb, real.file);
320 aio_req->iocb.ki_complete = ovl_aio_rw_complete;
321 ret = vfs_iocb_iter_read(real.file, &aio_req->iocb, iter);
322 if (ret != -EIOCBQUEUED)
323 ovl_aio_cleanup_handler(aio_req);
326 revert_creds(old_cred);
327 ovl_file_accessed(file);
334 static ssize_t ovl_write_iter(struct kiocb *iocb, struct iov_iter *iter)
336 struct file *file = iocb->ki_filp;
337 struct inode *inode = file_inode(file);
339 const struct cred *old_cred;
341 int ifl = iocb->ki_flags;
343 if (!iov_iter_count(iter))
348 ovl_copyattr(ovl_inode_real(inode), inode);
349 ret = file_remove_privs(file);
353 ret = ovl_real_fdget(file, &real);
357 if (!ovl_should_sync(OVL_FS(inode->i_sb)))
358 ifl &= ~(IOCB_DSYNC | IOCB_SYNC);
360 old_cred = ovl_override_creds(file_inode(file)->i_sb);
361 if (is_sync_kiocb(iocb)) {
362 file_start_write(real.file);
363 ret = vfs_iter_write(real.file, iter, &iocb->ki_pos,
364 ovl_iocb_to_rwf(ifl));
365 file_end_write(real.file);
367 ovl_copyattr(ovl_inode_real(inode), inode);
369 struct ovl_aio_req *aio_req;
372 aio_req = kmem_cache_zalloc(ovl_aio_request_cachep, GFP_KERNEL);
376 file_start_write(real.file);
377 /* Pacify lockdep, same trick as done in aio_write() */
378 __sb_writers_release(file_inode(real.file)->i_sb,
382 aio_req->orig_iocb = iocb;
383 kiocb_clone(&aio_req->iocb, iocb, real.file);
384 aio_req->iocb.ki_flags = ifl;
385 aio_req->iocb.ki_complete = ovl_aio_rw_complete;
386 ret = vfs_iocb_iter_write(real.file, &aio_req->iocb, iter);
387 if (ret != -EIOCBQUEUED)
388 ovl_aio_cleanup_handler(aio_req);
391 revert_creds(old_cred);
400 static ssize_t ovl_splice_read(struct file *in, loff_t *ppos,
401 struct pipe_inode_info *pipe, size_t len,
406 const struct cred *old_cred;
408 ret = ovl_real_fdget(in, &real);
412 old_cred = ovl_override_creds(file_inode(in)->i_sb);
413 ret = generic_file_splice_read(real.file, ppos, pipe, len, flags);
414 revert_creds(old_cred);
416 ovl_file_accessed(in);
422 ovl_splice_write(struct pipe_inode_info *pipe, struct file *out,
423 loff_t *ppos, size_t len, unsigned int flags)
426 const struct cred *old_cred;
429 ret = ovl_real_fdget(out, &real);
433 old_cred = ovl_override_creds(file_inode(out)->i_sb);
434 ret = iter_file_splice_write(pipe, real.file, ppos, len, flags);
435 revert_creds(old_cred);
437 ovl_file_accessed(out);
442 static int ovl_fsync(struct file *file, loff_t start, loff_t end, int datasync)
445 const struct cred *old_cred;
448 if (!ovl_should_sync(OVL_FS(file_inode(file)->i_sb)))
451 ret = ovl_real_fdget_meta(file, &real, !datasync);
455 /* Don't sync lower file for fear of receiving EROFS error */
456 if (file_inode(real.file) == ovl_inode_upper(file_inode(file))) {
457 old_cred = ovl_override_creds(file_inode(file)->i_sb);
458 ret = vfs_fsync_range(real.file, start, end, datasync);
459 revert_creds(old_cred);
467 static int ovl_mmap(struct file *file, struct vm_area_struct *vma)
469 struct file *realfile = file->private_data;
470 const struct cred *old_cred;
473 if (!realfile->f_op->mmap)
476 if (WARN_ON(file != vma->vm_file))
479 vma->vm_file = get_file(realfile);
481 old_cred = ovl_override_creds(file_inode(file)->i_sb);
482 ret = call_mmap(vma->vm_file, vma);
483 revert_creds(old_cred);
486 /* Drop reference count from new vm_file value */
489 /* Drop reference count from previous vm_file value */
493 ovl_file_accessed(file);
498 static long ovl_fallocate(struct file *file, int mode, loff_t offset, loff_t len)
500 struct inode *inode = file_inode(file);
502 const struct cred *old_cred;
505 ret = ovl_real_fdget(file, &real);
509 old_cred = ovl_override_creds(file_inode(file)->i_sb);
510 ret = vfs_fallocate(real.file, mode, offset, len);
511 revert_creds(old_cred);
514 ovl_copyattr(ovl_inode_real(inode), inode);
521 static int ovl_fadvise(struct file *file, loff_t offset, loff_t len, int advice)
524 const struct cred *old_cred;
527 ret = ovl_real_fdget(file, &real);
531 old_cred = ovl_override_creds(file_inode(file)->i_sb);
532 ret = vfs_fadvise(real.file, offset, len, advice);
533 revert_creds(old_cred);
540 static long ovl_real_ioctl(struct file *file, unsigned int cmd,
544 const struct cred *old_cred;
547 ret = ovl_real_fdget(file, &real);
551 old_cred = ovl_override_creds(file_inode(file)->i_sb);
552 ret = security_file_ioctl(real.file, cmd, arg);
554 ret = vfs_ioctl(real.file, cmd, arg);
555 revert_creds(old_cred);
562 static unsigned int ovl_iflags_to_fsflags(unsigned int iflags)
564 unsigned int flags = 0;
568 if (iflags & S_APPEND)
569 flags |= FS_APPEND_FL;
570 if (iflags & S_IMMUTABLE)
571 flags |= FS_IMMUTABLE_FL;
572 if (iflags & S_NOATIME)
573 flags |= FS_NOATIME_FL;
578 static long ovl_ioctl_set_flags(struct file *file, unsigned int cmd,
579 unsigned long arg, unsigned int flags)
582 struct inode *inode = file_inode(file);
583 unsigned int oldflags;
585 if (!inode_owner_or_capable(inode))
588 ret = mnt_want_write_file(file);
594 /* Check the capability before cred override */
595 oldflags = ovl_iflags_to_fsflags(READ_ONCE(inode->i_flags));
596 ret = vfs_ioc_setflags_prepare(inode, oldflags, flags);
600 ret = ovl_maybe_copy_up(file_dentry(file), O_WRONLY);
604 ret = ovl_real_ioctl(file, cmd, arg);
606 ovl_copyflags(ovl_inode_real(inode), inode);
610 mnt_drop_write_file(file);
616 static long ovl_ioctl_set_fsflags(struct file *file, unsigned int cmd,
621 if (get_user(flags, (int __user *) arg))
624 return ovl_ioctl_set_flags(file, cmd, arg, flags);
627 static unsigned int ovl_fsxflags_to_fsflags(unsigned int xflags)
629 unsigned int flags = 0;
631 if (xflags & FS_XFLAG_SYNC)
633 if (xflags & FS_XFLAG_APPEND)
634 flags |= FS_APPEND_FL;
635 if (xflags & FS_XFLAG_IMMUTABLE)
636 flags |= FS_IMMUTABLE_FL;
637 if (xflags & FS_XFLAG_NOATIME)
638 flags |= FS_NOATIME_FL;
643 static long ovl_ioctl_set_fsxflags(struct file *file, unsigned int cmd,
648 memset(&fa, 0, sizeof(fa));
649 if (copy_from_user(&fa, (void __user *) arg, sizeof(fa)))
652 return ovl_ioctl_set_flags(file, cmd, arg,
653 ovl_fsxflags_to_fsflags(fa.fsx_xflags));
656 long ovl_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
661 case FS_IOC_GETFLAGS:
662 case FS_IOC_FSGETXATTR:
663 ret = ovl_real_ioctl(file, cmd, arg);
666 case FS_IOC_SETFLAGS:
667 ret = ovl_ioctl_set_fsflags(file, cmd, arg);
670 case FS_IOC_FSSETXATTR:
671 ret = ovl_ioctl_set_fsxflags(file, cmd, arg);
682 long ovl_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
685 case FS_IOC32_GETFLAGS:
686 cmd = FS_IOC_GETFLAGS;
689 case FS_IOC32_SETFLAGS:
690 cmd = FS_IOC_SETFLAGS;
697 return ovl_ioctl(file, cmd, arg);
707 static loff_t ovl_copyfile(struct file *file_in, loff_t pos_in,
708 struct file *file_out, loff_t pos_out,
709 loff_t len, unsigned int flags, enum ovl_copyop op)
711 struct inode *inode_out = file_inode(file_out);
712 struct fd real_in, real_out;
713 const struct cred *old_cred;
716 ret = ovl_real_fdget(file_out, &real_out);
720 ret = ovl_real_fdget(file_in, &real_in);
726 old_cred = ovl_override_creds(file_inode(file_out)->i_sb);
729 ret = vfs_copy_file_range(real_in.file, pos_in,
730 real_out.file, pos_out, len, flags);
734 ret = vfs_clone_file_range(real_in.file, pos_in,
735 real_out.file, pos_out, len, flags);
739 ret = vfs_dedupe_file_range_one(real_in.file, pos_in,
740 real_out.file, pos_out, len,
744 revert_creds(old_cred);
747 ovl_copyattr(ovl_inode_real(inode_out), inode_out);
755 static ssize_t ovl_copy_file_range(struct file *file_in, loff_t pos_in,
756 struct file *file_out, loff_t pos_out,
757 size_t len, unsigned int flags)
759 return ovl_copyfile(file_in, pos_in, file_out, pos_out, len, flags,
763 static loff_t ovl_remap_file_range(struct file *file_in, loff_t pos_in,
764 struct file *file_out, loff_t pos_out,
765 loff_t len, unsigned int remap_flags)
769 if (remap_flags & ~(REMAP_FILE_DEDUP | REMAP_FILE_ADVISORY))
772 if (remap_flags & REMAP_FILE_DEDUP)
778 * Don't copy up because of a dedupe request, this wouldn't make sense
779 * most of the time (data would be duplicated instead of deduplicated).
781 if (op == OVL_DEDUPE &&
782 (!ovl_inode_upper(file_inode(file_in)) ||
783 !ovl_inode_upper(file_inode(file_out))))
786 return ovl_copyfile(file_in, pos_in, file_out, pos_out, len,
790 const struct file_operations ovl_file_operations = {
792 .release = ovl_release,
793 .llseek = ovl_llseek,
794 .read_iter = ovl_read_iter,
795 .write_iter = ovl_write_iter,
798 .fallocate = ovl_fallocate,
799 .fadvise = ovl_fadvise,
800 .unlocked_ioctl = ovl_ioctl,
802 .compat_ioctl = ovl_compat_ioctl,
804 .splice_read = ovl_splice_read,
805 .splice_write = ovl_splice_write,
807 .copy_file_range = ovl_copy_file_range,
808 .remap_file_range = ovl_remap_file_range,
811 int __init ovl_aio_request_cache_init(void)
813 ovl_aio_request_cachep = kmem_cache_create("ovl_aio_req",
814 sizeof(struct ovl_aio_req),
815 0, SLAB_HWCACHE_ALIGN, NULL);
816 if (!ovl_aio_request_cachep)
822 void ovl_aio_request_cache_destroy(void)
824 kmem_cache_destroy(ovl_aio_request_cachep);