1 // SPDX-License-Identifier: GPL-2.0-only
5 * Copyright (C) 1991, 1992 Linus Torvalds
8 #include <linux/string.h>
10 #include <linux/file.h>
11 #include <linux/fdtable.h>
12 #include <linux/fsnotify.h>
13 #include <linux/module.h>
14 #include <linux/tty.h>
15 #include <linux/namei.h>
16 #include <linux/backing-dev.h>
17 #include <linux/capability.h>
18 #include <linux/securebits.h>
19 #include <linux/security.h>
20 #include <linux/mount.h>
21 #include <linux/fcntl.h>
22 #include <linux/slab.h>
23 #include <linux/uaccess.h>
25 #include <linux/personality.h>
26 #include <linux/pagemap.h>
27 #include <linux/syscalls.h>
28 #include <linux/rcupdate.h>
29 #include <linux/audit.h>
30 #include <linux/falloc.h>
31 #include <linux/fs_struct.h>
32 #include <linux/dnotify.h>
33 #include <linux/compat.h>
34 #include <linux/mnt_idmapping.h>
35 #include <linux/filelock.h>
39 int do_truncate(struct mnt_idmap
*idmap
, struct dentry
*dentry
,
40 loff_t length
, unsigned int time_attrs
, struct file
*filp
)
43 struct iattr newattrs
;
45 /* Not pretty: "inode->i_size" shouldn't really be signed. But it is. */
49 newattrs
.ia_size
= length
;
50 newattrs
.ia_valid
= ATTR_SIZE
| time_attrs
;
52 newattrs
.ia_file
= filp
;
53 newattrs
.ia_valid
|= ATTR_FILE
;
56 /* Remove suid, sgid, and file capabilities on truncate too */
57 ret
= dentry_needs_remove_privs(idmap
, dentry
);
61 newattrs
.ia_valid
|= ret
| ATTR_FORCE
;
63 inode_lock(dentry
->d_inode
);
64 /* Note any delegations or leases have already been broken: */
65 ret
= notify_change(idmap
, dentry
, &newattrs
, NULL
);
66 inode_unlock(dentry
->d_inode
);
70 long vfs_truncate(const struct path
*path
, loff_t length
)
72 struct mnt_idmap
*idmap
;
76 inode
= path
->dentry
->d_inode
;
78 /* For directories it's -EISDIR, for other non-regulars - -EINVAL */
79 if (S_ISDIR(inode
->i_mode
))
81 if (!S_ISREG(inode
->i_mode
))
84 error
= mnt_want_write(path
->mnt
);
88 idmap
= mnt_idmap(path
->mnt
);
89 error
= inode_permission(idmap
, inode
, MAY_WRITE
);
91 goto mnt_drop_write_and_out
;
95 goto mnt_drop_write_and_out
;
97 error
= get_write_access(inode
);
99 goto mnt_drop_write_and_out
;
102 * Make sure that there are no leases. get_write_access() protects
103 * against the truncate racing with a lease-granting setlease().
105 error
= break_lease(inode
, O_WRONLY
);
107 goto put_write_and_out
;
109 error
= security_path_truncate(path
);
111 error
= do_truncate(idmap
, path
->dentry
, length
, 0, NULL
);
114 put_write_access(inode
);
115 mnt_drop_write_and_out
:
116 mnt_drop_write(path
->mnt
);
120 EXPORT_SYMBOL_GPL(vfs_truncate
);
122 long do_sys_truncate(const char __user
*pathname
, loff_t length
)
124 unsigned int lookup_flags
= LOOKUP_FOLLOW
;
128 if (length
< 0) /* sorry, but loff_t says... */
132 error
= user_path_at(AT_FDCWD
, pathname
, lookup_flags
, &path
);
134 error
= vfs_truncate(&path
, length
);
137 if (retry_estale(error
, lookup_flags
)) {
138 lookup_flags
|= LOOKUP_REVAL
;
144 SYSCALL_DEFINE2(truncate
, const char __user
*, path
, long, length
)
146 return do_sys_truncate(path
, length
);
150 COMPAT_SYSCALL_DEFINE2(truncate
, const char __user
*, path
, compat_off_t
, length
)
152 return do_sys_truncate(path
, length
);
156 long do_ftruncate(struct file
*file
, loff_t length
, int small
)
159 struct dentry
*dentry
;
162 /* explicitly opened as large or we are on 64-bit box */
163 if (file
->f_flags
& O_LARGEFILE
)
166 dentry
= file
->f_path
.dentry
;
167 inode
= dentry
->d_inode
;
168 if (!S_ISREG(inode
->i_mode
) || !(file
->f_mode
& FMODE_WRITE
))
171 /* Cannot ftruncate over 2^31 bytes without large file support */
172 if (small
&& length
> MAX_NON_LFS
)
175 /* Check IS_APPEND on real upper inode */
176 if (IS_APPEND(file_inode(file
)))
178 sb_start_write(inode
->i_sb
);
179 error
= security_file_truncate(file
);
181 error
= do_truncate(file_mnt_idmap(file
), dentry
, length
,
182 ATTR_MTIME
| ATTR_CTIME
, file
);
183 sb_end_write(inode
->i_sb
);
188 long do_sys_ftruncate(unsigned int fd
, loff_t length
, int small
)
196 return do_ftruncate(fd_file(f
), length
, small
);
199 SYSCALL_DEFINE2(ftruncate
, unsigned int, fd
, off_t
, length
)
201 return do_sys_ftruncate(fd
, length
, 1);
205 COMPAT_SYSCALL_DEFINE2(ftruncate
, unsigned int, fd
, compat_off_t
, length
)
207 return do_sys_ftruncate(fd
, length
, 1);
211 /* LFS versions of truncate are only needed on 32 bit machines */
212 #if BITS_PER_LONG == 32
213 SYSCALL_DEFINE2(truncate64
, const char __user
*, path
, loff_t
, length
)
215 return do_sys_truncate(path
, length
);
218 SYSCALL_DEFINE2(ftruncate64
, unsigned int, fd
, loff_t
, length
)
220 return do_sys_ftruncate(fd
, length
, 0);
222 #endif /* BITS_PER_LONG == 32 */
224 #if defined(CONFIG_COMPAT) && defined(__ARCH_WANT_COMPAT_TRUNCATE64)
225 COMPAT_SYSCALL_DEFINE3(truncate64
, const char __user
*, pathname
,
226 compat_arg_u64_dual(length
))
228 return ksys_truncate(pathname
, compat_arg_u64_glue(length
));
232 #if defined(CONFIG_COMPAT) && defined(__ARCH_WANT_COMPAT_FTRUNCATE64)
233 COMPAT_SYSCALL_DEFINE3(ftruncate64
, unsigned int, fd
,
234 compat_arg_u64_dual(length
))
236 return ksys_ftruncate(fd
, compat_arg_u64_glue(length
));
240 int vfs_fallocate(struct file
*file
, int mode
, loff_t offset
, loff_t len
)
242 struct inode
*inode
= file_inode(file
);
246 if (offset
< 0 || len
<= 0)
249 if (mode
& ~(FALLOC_FL_MODE_MASK
| FALLOC_FL_KEEP_SIZE
))
253 * Modes are exclusive, even if that is not obvious from the encoding
254 * as bit masks and the mix with the flag in the same namespace.
256 * To make things even more complicated, FALLOC_FL_ALLOCATE_RANGE is
257 * encoded as no bit set.
259 switch (mode
& FALLOC_FL_MODE_MASK
) {
260 case FALLOC_FL_ALLOCATE_RANGE
:
261 case FALLOC_FL_UNSHARE_RANGE
:
262 case FALLOC_FL_ZERO_RANGE
:
264 case FALLOC_FL_PUNCH_HOLE
:
265 if (!(mode
& FALLOC_FL_KEEP_SIZE
))
268 case FALLOC_FL_COLLAPSE_RANGE
:
269 case FALLOC_FL_INSERT_RANGE
:
270 if (mode
& FALLOC_FL_KEEP_SIZE
)
277 if (!(file
->f_mode
& FMODE_WRITE
))
281 * On append-only files only space preallocation is supported.
283 if ((mode
& ~FALLOC_FL_KEEP_SIZE
) && IS_APPEND(inode
))
286 if (IS_IMMUTABLE(inode
))
290 * We cannot allow any fallocate operation on an active swapfile
292 if (IS_SWAPFILE(inode
))
296 * Revalidate the write permissions, in case security policy has
297 * changed since the files were opened.
299 ret
= security_file_permission(file
, MAY_WRITE
);
303 ret
= fsnotify_file_area_perm(file
, MAY_WRITE
, &offset
, len
);
307 if (S_ISFIFO(inode
->i_mode
))
310 if (S_ISDIR(inode
->i_mode
))
313 if (!S_ISREG(inode
->i_mode
) && !S_ISBLK(inode
->i_mode
))
316 /* Check for wraparound */
317 if (check_add_overflow(offset
, len
, &sum
))
320 if (sum
> inode
->i_sb
->s_maxbytes
)
323 if (!file
->f_op
->fallocate
)
326 file_start_write(file
);
327 ret
= file
->f_op
->fallocate(file
, mode
, offset
, len
);
330 * Create inotify and fanotify events.
332 * To keep the logic simple always create events if fallocate succeeds.
333 * This implies that events are even created if the file size remains
334 * unchanged, e.g. when using flag FALLOC_FL_KEEP_SIZE.
337 fsnotify_modify(file
);
339 file_end_write(file
);
342 EXPORT_SYMBOL_GPL(vfs_fallocate
);
344 int ksys_fallocate(int fd
, int mode
, loff_t offset
, loff_t len
)
351 return vfs_fallocate(fd_file(f
), mode
, offset
, len
);
354 SYSCALL_DEFINE4(fallocate
, int, fd
, int, mode
, loff_t
, offset
, loff_t
, len
)
356 return ksys_fallocate(fd
, mode
, offset
, len
);
359 #if defined(CONFIG_COMPAT) && defined(__ARCH_WANT_COMPAT_FALLOCATE)
360 COMPAT_SYSCALL_DEFINE6(fallocate
, int, fd
, int, mode
, compat_arg_u64_dual(offset
),
361 compat_arg_u64_dual(len
))
363 return ksys_fallocate(fd
, mode
, compat_arg_u64_glue(offset
),
364 compat_arg_u64_glue(len
));
369 * access() needs to use the real uid/gid, not the effective uid/gid.
370 * We do this by temporarily clearing all FS-related capabilities and
371 * switching the fsuid/fsgid around to the real ones.
373 * Creating new credentials is expensive, so we try to skip doing it,
374 * which we can if the result would match what we already got.
376 static bool access_need_override_creds(int flags
)
378 const struct cred
*cred
;
380 if (flags
& AT_EACCESS
)
383 cred
= current_cred();
384 if (!uid_eq(cred
->fsuid
, cred
->uid
) ||
385 !gid_eq(cred
->fsgid
, cred
->gid
))
388 if (!issecure(SECURE_NO_SETUID_FIXUP
)) {
389 kuid_t root_uid
= make_kuid(cred
->user_ns
, 0);
390 if (!uid_eq(cred
->uid
, root_uid
)) {
391 if (!cap_isclear(cred
->cap_effective
))
394 if (!cap_isidentical(cred
->cap_effective
,
395 cred
->cap_permitted
))
403 static const struct cred
*access_override_creds(void)
405 const struct cred
*old_cred
;
406 struct cred
*override_cred
;
408 override_cred
= prepare_creds();
413 * XXX access_need_override_creds performs checks in hopes of skipping
414 * this work. Make sure it stays in sync if making any changes in this
418 override_cred
->fsuid
= override_cred
->uid
;
419 override_cred
->fsgid
= override_cred
->gid
;
421 if (!issecure(SECURE_NO_SETUID_FIXUP
)) {
422 /* Clear the capabilities if we switch to a non-root user */
423 kuid_t root_uid
= make_kuid(override_cred
->user_ns
, 0);
424 if (!uid_eq(override_cred
->uid
, root_uid
))
425 cap_clear(override_cred
->cap_effective
);
427 override_cred
->cap_effective
=
428 override_cred
->cap_permitted
;
432 * The new set of credentials can *only* be used in
433 * task-synchronous circumstances, and does not need
434 * RCU freeing, unless somebody then takes a separate
437 * NOTE! This is _only_ true because this credential
438 * is used purely for override_creds() that installs
439 * it as the subjective cred. Other threads will be
440 * accessing ->real_cred, not the subjective cred.
442 * If somebody _does_ make a copy of this (using the
443 * 'get_current_cred()' function), that will clear the
444 * non_rcu field, because now that other user may be
445 * expecting RCU freeing. But normal thread-synchronous
446 * cred accesses will keep things non-racy to avoid RCU
449 override_cred
->non_rcu
= 1;
451 old_cred
= override_creds(override_cred
);
453 /* override_cred() gets its own ref */
454 put_cred(override_cred
);
459 static long do_faccessat(int dfd
, const char __user
*filename
, int mode
, int flags
)
464 unsigned int lookup_flags
= LOOKUP_FOLLOW
;
465 const struct cred
*old_cred
= NULL
;
467 if (mode
& ~S_IRWXO
) /* where's F_OK, X_OK, W_OK, R_OK? */
470 if (flags
& ~(AT_EACCESS
| AT_SYMLINK_NOFOLLOW
| AT_EMPTY_PATH
))
473 if (flags
& AT_SYMLINK_NOFOLLOW
)
474 lookup_flags
&= ~LOOKUP_FOLLOW
;
475 if (flags
& AT_EMPTY_PATH
)
476 lookup_flags
|= LOOKUP_EMPTY
;
478 if (access_need_override_creds(flags
)) {
479 old_cred
= access_override_creds();
485 res
= user_path_at(dfd
, filename
, lookup_flags
, &path
);
489 inode
= d_backing_inode(path
.dentry
);
491 if ((mode
& MAY_EXEC
) && S_ISREG(inode
->i_mode
)) {
493 * MAY_EXEC on regular files is denied if the fs is mounted
494 * with the "noexec" flag.
497 if (path_noexec(&path
))
498 goto out_path_release
;
501 res
= inode_permission(mnt_idmap(path
.mnt
), inode
, mode
| MAY_ACCESS
);
502 /* SuS v2 requires we report a read only fs too */
503 if (res
|| !(mode
& S_IWOTH
) || special_file(inode
->i_mode
))
504 goto out_path_release
;
506 * This is a rare case where using __mnt_is_readonly()
507 * is OK without a mnt_want/drop_write() pair. Since
508 * no actual write to the fs is performed here, we do
509 * not need to telegraph to that to anyone.
511 * By doing this, we accept that this access is
512 * inherently racy and know that the fs may change
513 * state before we even see this result.
515 if (__mnt_is_readonly(path
.mnt
))
520 if (retry_estale(res
, lookup_flags
)) {
521 lookup_flags
|= LOOKUP_REVAL
;
526 revert_creds(old_cred
);
531 SYSCALL_DEFINE3(faccessat
, int, dfd
, const char __user
*, filename
, int, mode
)
533 return do_faccessat(dfd
, filename
, mode
, 0);
536 SYSCALL_DEFINE4(faccessat2
, int, dfd
, const char __user
*, filename
, int, mode
,
539 return do_faccessat(dfd
, filename
, mode
, flags
);
542 SYSCALL_DEFINE2(access
, const char __user
*, filename
, int, mode
)
544 return do_faccessat(AT_FDCWD
, filename
, mode
, 0);
547 SYSCALL_DEFINE1(chdir
, const char __user
*, filename
)
551 unsigned int lookup_flags
= LOOKUP_FOLLOW
| LOOKUP_DIRECTORY
;
553 error
= user_path_at(AT_FDCWD
, filename
, lookup_flags
, &path
);
557 error
= path_permission(&path
, MAY_EXEC
| MAY_CHDIR
);
561 set_fs_pwd(current
->fs
, &path
);
565 if (retry_estale(error
, lookup_flags
)) {
566 lookup_flags
|= LOOKUP_REVAL
;
573 SYSCALL_DEFINE1(fchdir
, unsigned int, fd
)
575 CLASS(fd_raw
, f
)(fd
);
581 if (!d_can_lookup(fd_file(f
)->f_path
.dentry
))
584 error
= file_permission(fd_file(f
), MAY_EXEC
| MAY_CHDIR
);
586 set_fs_pwd(current
->fs
, &fd_file(f
)->f_path
);
590 SYSCALL_DEFINE1(chroot
, const char __user
*, filename
)
594 unsigned int lookup_flags
= LOOKUP_FOLLOW
| LOOKUP_DIRECTORY
;
596 error
= user_path_at(AT_FDCWD
, filename
, lookup_flags
, &path
);
600 error
= path_permission(&path
, MAY_EXEC
| MAY_CHDIR
);
605 if (!ns_capable(current_user_ns(), CAP_SYS_CHROOT
))
607 error
= security_path_chroot(&path
);
611 set_fs_root(current
->fs
, &path
);
615 if (retry_estale(error
, lookup_flags
)) {
616 lookup_flags
|= LOOKUP_REVAL
;
623 int chmod_common(const struct path
*path
, umode_t mode
)
625 struct inode
*inode
= path
->dentry
->d_inode
;
626 struct inode
*delegated_inode
= NULL
;
627 struct iattr newattrs
;
630 error
= mnt_want_write(path
->mnt
);
635 error
= security_path_chmod(path
, mode
);
638 newattrs
.ia_mode
= (mode
& S_IALLUGO
) | (inode
->i_mode
& ~S_IALLUGO
);
639 newattrs
.ia_valid
= ATTR_MODE
| ATTR_CTIME
;
640 error
= notify_change(mnt_idmap(path
->mnt
), path
->dentry
,
641 &newattrs
, &delegated_inode
);
644 if (delegated_inode
) {
645 error
= break_deleg_wait(&delegated_inode
);
649 mnt_drop_write(path
->mnt
);
653 int vfs_fchmod(struct file
*file
, umode_t mode
)
656 return chmod_common(&file
->f_path
, mode
);
659 SYSCALL_DEFINE2(fchmod
, unsigned int, fd
, umode_t
, mode
)
666 return vfs_fchmod(fd_file(f
), mode
);
669 static int do_fchmodat(int dfd
, const char __user
*filename
, umode_t mode
,
674 unsigned int lookup_flags
;
676 if (unlikely(flags
& ~(AT_SYMLINK_NOFOLLOW
| AT_EMPTY_PATH
)))
679 lookup_flags
= (flags
& AT_SYMLINK_NOFOLLOW
) ? 0 : LOOKUP_FOLLOW
;
680 if (flags
& AT_EMPTY_PATH
)
681 lookup_flags
|= LOOKUP_EMPTY
;
684 error
= user_path_at(dfd
, filename
, lookup_flags
, &path
);
686 error
= chmod_common(&path
, mode
);
688 if (retry_estale(error
, lookup_flags
)) {
689 lookup_flags
|= LOOKUP_REVAL
;
696 SYSCALL_DEFINE4(fchmodat2
, int, dfd
, const char __user
*, filename
,
697 umode_t
, mode
, unsigned int, flags
)
699 return do_fchmodat(dfd
, filename
, mode
, flags
);
702 SYSCALL_DEFINE3(fchmodat
, int, dfd
, const char __user
*, filename
,
705 return do_fchmodat(dfd
, filename
, mode
, 0);
708 SYSCALL_DEFINE2(chmod
, const char __user
*, filename
, umode_t
, mode
)
710 return do_fchmodat(AT_FDCWD
, filename
, mode
, 0);
714 * Check whether @kuid is valid and if so generate and set vfsuid_t in
717 * Return: true if @kuid is valid, false if not.
719 static inline bool setattr_vfsuid(struct iattr
*attr
, kuid_t kuid
)
721 if (!uid_valid(kuid
))
723 attr
->ia_valid
|= ATTR_UID
;
724 attr
->ia_vfsuid
= VFSUIDT_INIT(kuid
);
729 * Check whether @kgid is valid and if so generate and set vfsgid_t in
732 * Return: true if @kgid is valid, false if not.
734 static inline bool setattr_vfsgid(struct iattr
*attr
, kgid_t kgid
)
736 if (!gid_valid(kgid
))
738 attr
->ia_valid
|= ATTR_GID
;
739 attr
->ia_vfsgid
= VFSGIDT_INIT(kgid
);
743 int chown_common(const struct path
*path
, uid_t user
, gid_t group
)
745 struct mnt_idmap
*idmap
;
746 struct user_namespace
*fs_userns
;
747 struct inode
*inode
= path
->dentry
->d_inode
;
748 struct inode
*delegated_inode
= NULL
;
750 struct iattr newattrs
;
754 uid
= make_kuid(current_user_ns(), user
);
755 gid
= make_kgid(current_user_ns(), group
);
757 idmap
= mnt_idmap(path
->mnt
);
758 fs_userns
= i_user_ns(inode
);
761 newattrs
.ia_vfsuid
= INVALID_VFSUID
;
762 newattrs
.ia_vfsgid
= INVALID_VFSGID
;
763 newattrs
.ia_valid
= ATTR_CTIME
;
764 if ((user
!= (uid_t
)-1) && !setattr_vfsuid(&newattrs
, uid
))
766 if ((group
!= (gid_t
)-1) && !setattr_vfsgid(&newattrs
, gid
))
769 if (!S_ISDIR(inode
->i_mode
))
770 newattrs
.ia_valid
|= ATTR_KILL_SUID
| ATTR_KILL_PRIV
|
771 setattr_should_drop_sgid(idmap
, inode
);
772 /* Continue to send actual fs values, not the mount values. */
773 error
= security_path_chown(
775 from_vfsuid(idmap
, fs_userns
, newattrs
.ia_vfsuid
),
776 from_vfsgid(idmap
, fs_userns
, newattrs
.ia_vfsgid
));
778 error
= notify_change(idmap
, path
->dentry
, &newattrs
,
781 if (delegated_inode
) {
782 error
= break_deleg_wait(&delegated_inode
);
789 int do_fchownat(int dfd
, const char __user
*filename
, uid_t user
, gid_t group
,
796 if ((flag
& ~(AT_SYMLINK_NOFOLLOW
| AT_EMPTY_PATH
)) != 0)
799 lookup_flags
= (flag
& AT_SYMLINK_NOFOLLOW
) ? 0 : LOOKUP_FOLLOW
;
800 if (flag
& AT_EMPTY_PATH
)
801 lookup_flags
|= LOOKUP_EMPTY
;
803 error
= user_path_at(dfd
, filename
, lookup_flags
, &path
);
806 error
= mnt_want_write(path
.mnt
);
809 error
= chown_common(&path
, user
, group
);
810 mnt_drop_write(path
.mnt
);
813 if (retry_estale(error
, lookup_flags
)) {
814 lookup_flags
|= LOOKUP_REVAL
;
821 SYSCALL_DEFINE5(fchownat
, int, dfd
, const char __user
*, filename
, uid_t
, user
,
822 gid_t
, group
, int, flag
)
824 return do_fchownat(dfd
, filename
, user
, group
, flag
);
827 SYSCALL_DEFINE3(chown
, const char __user
*, filename
, uid_t
, user
, gid_t
, group
)
829 return do_fchownat(AT_FDCWD
, filename
, user
, group
, 0);
832 SYSCALL_DEFINE3(lchown
, const char __user
*, filename
, uid_t
, user
, gid_t
, group
)
834 return do_fchownat(AT_FDCWD
, filename
, user
, group
,
835 AT_SYMLINK_NOFOLLOW
);
838 int vfs_fchown(struct file
*file
, uid_t user
, gid_t group
)
842 error
= mnt_want_write_file(file
);
846 error
= chown_common(&file
->f_path
, user
, group
);
847 mnt_drop_write_file(file
);
851 int ksys_fchown(unsigned int fd
, uid_t user
, gid_t group
)
858 return vfs_fchown(fd_file(f
), user
, group
);
861 SYSCALL_DEFINE3(fchown
, unsigned int, fd
, uid_t
, user
, gid_t
, group
)
863 return ksys_fchown(fd
, user
, group
);
866 static inline int file_get_write_access(struct file
*f
)
870 error
= get_write_access(f
->f_inode
);
873 error
= mnt_get_write_access(f
->f_path
.mnt
);
876 if (unlikely(f
->f_mode
& FMODE_BACKING
)) {
877 error
= mnt_get_write_access(backing_file_user_path(f
)->mnt
);
884 mnt_put_write_access(f
->f_path
.mnt
);
886 put_write_access(f
->f_inode
);
890 static int do_dentry_open(struct file
*f
,
891 int (*open
)(struct inode
*, struct file
*))
893 static const struct file_operations empty_fops
= {};
894 struct inode
*inode
= f
->f_path
.dentry
->d_inode
;
897 path_get(&f
->f_path
);
899 f
->f_mapping
= inode
->i_mapping
;
900 f
->f_wb_err
= filemap_sample_wb_err(f
->f_mapping
);
901 f
->f_sb_err
= file_sample_sb_err(f
);
903 if (unlikely(f
->f_flags
& O_PATH
)) {
904 f
->f_mode
= FMODE_PATH
| FMODE_OPENED
;
905 f
->f_op
= &empty_fops
;
909 if ((f
->f_mode
& (FMODE_READ
| FMODE_WRITE
)) == FMODE_READ
) {
910 i_readcount_inc(inode
);
911 } else if (f
->f_mode
& FMODE_WRITE
&& !special_file(inode
->i_mode
)) {
912 error
= file_get_write_access(f
);
915 f
->f_mode
|= FMODE_WRITER
;
918 /* POSIX.1-2008/SUSv4 Section XSI 2.9.7 */
919 if (S_ISREG(inode
->i_mode
) || S_ISDIR(inode
->i_mode
))
920 f
->f_mode
|= FMODE_ATOMIC_POS
;
922 f
->f_op
= fops_get(inode
->i_fop
);
923 if (WARN_ON(!f
->f_op
)) {
928 error
= security_file_open(f
);
932 error
= fsnotify_open_perm(f
);
936 error
= break_lease(file_inode(f
), f
->f_flags
);
940 /* normally all 3 are set; ->open() can clear them if needed */
941 f
->f_mode
|= FMODE_LSEEK
| FMODE_PREAD
| FMODE_PWRITE
;
943 open
= f
->f_op
->open
;
945 error
= open(inode
, f
);
949 f
->f_mode
|= FMODE_OPENED
;
950 if ((f
->f_mode
& FMODE_READ
) &&
951 likely(f
->f_op
->read
|| f
->f_op
->read_iter
))
952 f
->f_mode
|= FMODE_CAN_READ
;
953 if ((f
->f_mode
& FMODE_WRITE
) &&
954 likely(f
->f_op
->write
|| f
->f_op
->write_iter
))
955 f
->f_mode
|= FMODE_CAN_WRITE
;
956 if ((f
->f_mode
& FMODE_LSEEK
) && !f
->f_op
->llseek
)
957 f
->f_mode
&= ~FMODE_LSEEK
;
958 if (f
->f_mapping
->a_ops
&& f
->f_mapping
->a_ops
->direct_IO
)
959 f
->f_mode
|= FMODE_CAN_ODIRECT
;
961 f
->f_flags
&= ~(O_CREAT
| O_EXCL
| O_NOCTTY
| O_TRUNC
);
962 f
->f_iocb_flags
= iocb_flags(f
);
964 file_ra_state_init(&f
->f_ra
, f
->f_mapping
->host
->i_mapping
);
966 if ((f
->f_flags
& O_DIRECT
) && !(f
->f_mode
& FMODE_CAN_ODIRECT
))
970 * XXX: Huge page cache doesn't support writing yet. Drop all page
971 * cache for this file before processing writes.
973 if (f
->f_mode
& FMODE_WRITE
) {
975 * Depends on full fence from get_write_access() to synchronize
976 * against collapse_file() regarding i_writecount and nr_thps
977 * updates. Ensures subsequent insertion of THPs into the page
980 if (filemap_nr_thps(inode
->i_mapping
)) {
981 struct address_space
*mapping
= inode
->i_mapping
;
983 filemap_invalidate_lock(inode
->i_mapping
);
985 * unmap_mapping_range just need to be called once
986 * here, because the private pages is not need to be
987 * unmapped mapping (e.g. data segment of dynamic
988 * shared libraries here).
990 unmap_mapping_range(mapping
, 0, 0, 0);
991 truncate_inode_pages(mapping
, 0);
992 filemap_invalidate_unlock(inode
->i_mapping
);
999 if (WARN_ON_ONCE(error
> 0))
1004 path_put(&f
->f_path
);
1005 f
->f_path
.mnt
= NULL
;
1006 f
->f_path
.dentry
= NULL
;
1012 * finish_open - finish opening a file
1013 * @file: file pointer
1014 * @dentry: pointer to dentry
1015 * @open: open callback
1017 * This can be used to finish opening a file passed to i_op->atomic_open().
1019 * If the open callback is set to NULL, then the standard f_op->open()
1020 * filesystem callback is substituted.
1022 * NB: the dentry reference is _not_ consumed. If, for example, the dentry is
1023 * the return value of d_splice_alias(), then the caller needs to perform dput()
1024 * on it after finish_open().
1026 * Returns zero on success or -errno if the open failed.
1028 int finish_open(struct file
*file
, struct dentry
*dentry
,
1029 int (*open
)(struct inode
*, struct file
*))
1031 BUG_ON(file
->f_mode
& FMODE_OPENED
); /* once it's opened, it's opened */
1033 file
->f_path
.dentry
= dentry
;
1034 return do_dentry_open(file
, open
);
1036 EXPORT_SYMBOL(finish_open
);
1039 * finish_no_open - finish ->atomic_open() without opening the file
1041 * @file: file pointer
1042 * @dentry: dentry or NULL (as returned from ->lookup())
1044 * This can be used to set the result of a successful lookup in ->atomic_open().
1046 * NB: unlike finish_open() this function does consume the dentry reference and
1047 * the caller need not dput() it.
1049 * Returns "0" which must be the return value of ->atomic_open() after having
1050 * called this function.
1052 int finish_no_open(struct file
*file
, struct dentry
*dentry
)
1054 file
->f_path
.dentry
= dentry
;
1057 EXPORT_SYMBOL(finish_no_open
);
1059 char *file_path(struct file
*filp
, char *buf
, int buflen
)
1061 return d_path(&filp
->f_path
, buf
, buflen
);
1063 EXPORT_SYMBOL(file_path
);
1066 * vfs_open - open the file at the given path
1067 * @path: path to open
1068 * @file: newly allocated file with f_flag initialized
1070 int vfs_open(const struct path
*path
, struct file
*file
)
1074 file
->f_path
= *path
;
1075 ret
= do_dentry_open(file
, NULL
);
1078 * Once we return a file with FMODE_OPENED, __fput() will call
1079 * fsnotify_close(), so we need fsnotify_open() here for
1082 fsnotify_open(file
);
1087 struct file
*dentry_open(const struct path
*path
, int flags
,
1088 const struct cred
*cred
)
1093 /* We must always pass in a valid mount pointer. */
1096 f
= alloc_empty_file(flags
, cred
);
1098 error
= vfs_open(path
, f
);
1106 EXPORT_SYMBOL(dentry_open
);
1109 * dentry_create - Create and open a file
1110 * @path: path to create
1112 * @mode: mode bits for new file
1113 * @cred: credentials to use
1115 * Caller must hold the parent directory's lock, and have prepared
1116 * a negative dentry, placed in @path->dentry, for the new file.
1118 * Caller sets @path->mnt to the vfsmount of the filesystem where
1119 * the new file is to be created. The parent directory and the
1120 * negative dentry must reside on the same filesystem instance.
1122 * On success, returns a "struct file *". Otherwise a ERR_PTR
1125 struct file
*dentry_create(const struct path
*path
, int flags
, umode_t mode
,
1126 const struct cred
*cred
)
1131 f
= alloc_empty_file(flags
, cred
);
1135 error
= vfs_create(mnt_idmap(path
->mnt
),
1136 d_inode(path
->dentry
->d_parent
),
1137 path
->dentry
, mode
, true);
1139 error
= vfs_open(path
, f
);
1141 if (unlikely(error
)) {
1143 return ERR_PTR(error
);
1147 EXPORT_SYMBOL(dentry_create
);
1150 * kernel_file_open - open a file for kernel internal use
1151 * @path: path of the file to open
1152 * @flags: open flags
1153 * @cred: credentials for open
1155 * Open a file for use by in-kernel consumers. The file is not accounted
1156 * against nr_files and must not be installed into the file descriptor
1159 * Return: Opened file on success, an error pointer on failure.
1161 struct file
*kernel_file_open(const struct path
*path
, int flags
,
1162 const struct cred
*cred
)
1167 f
= alloc_empty_file_noaccount(flags
, cred
);
1172 error
= do_dentry_open(f
, NULL
);
1175 return ERR_PTR(error
);
1181 EXPORT_SYMBOL_GPL(kernel_file_open
);
1183 #define WILL_CREATE(flags) (flags & (O_CREAT | __O_TMPFILE))
1184 #define O_PATH_FLAGS (O_DIRECTORY | O_NOFOLLOW | O_PATH | O_CLOEXEC)
1186 inline struct open_how
build_open_how(int flags
, umode_t mode
)
1188 struct open_how how
= {
1189 .flags
= flags
& VALID_OPEN_FLAGS
,
1190 .mode
= mode
& S_IALLUGO
,
1193 /* O_PATH beats everything else. */
1194 if (how
.flags
& O_PATH
)
1195 how
.flags
&= O_PATH_FLAGS
;
1196 /* Modes should only be set for create-like flags. */
1197 if (!WILL_CREATE(how
.flags
))
1202 inline int build_open_flags(const struct open_how
*how
, struct open_flags
*op
)
1204 u64 flags
= how
->flags
;
1205 u64 strip
= __FMODE_NONOTIFY
| O_CLOEXEC
;
1206 int lookup_flags
= 0;
1207 int acc_mode
= ACC_MODE(flags
);
1209 BUILD_BUG_ON_MSG(upper_32_bits(VALID_OPEN_FLAGS
),
1210 "struct open_flags doesn't yet handle flags > 32 bits");
1213 * Strip flags that either shouldn't be set by userspace like
1214 * FMODE_NONOTIFY or that aren't relevant in determining struct
1215 * open_flags like O_CLOEXEC.
1220 * Older syscalls implicitly clear all of the invalid flags or argument
1221 * values before calling build_open_flags(), but openat2(2) checks all
1224 if (flags
& ~VALID_OPEN_FLAGS
)
1226 if (how
->resolve
& ~VALID_RESOLVE_FLAGS
)
1229 /* Scoping flags are mutually exclusive. */
1230 if ((how
->resolve
& RESOLVE_BENEATH
) && (how
->resolve
& RESOLVE_IN_ROOT
))
1233 /* Deal with the mode. */
1234 if (WILL_CREATE(flags
)) {
1235 if (how
->mode
& ~S_IALLUGO
)
1237 op
->mode
= how
->mode
| S_IFREG
;
1245 * Block bugs where O_DIRECTORY | O_CREAT created regular files.
1246 * Note, that blocking O_DIRECTORY | O_CREAT here also protects
1247 * O_TMPFILE below which requires O_DIRECTORY being raised.
1249 if ((flags
& (O_DIRECTORY
| O_CREAT
)) == (O_DIRECTORY
| O_CREAT
))
1252 /* Now handle the creative implementation of O_TMPFILE. */
1253 if (flags
& __O_TMPFILE
) {
1255 * In order to ensure programs get explicit errors when trying
1256 * to use O_TMPFILE on old kernels we enforce that O_DIRECTORY
1257 * is raised alongside __O_TMPFILE.
1259 if (!(flags
& O_DIRECTORY
))
1261 if (!(acc_mode
& MAY_WRITE
))
1264 if (flags
& O_PATH
) {
1265 /* O_PATH only permits certain other flags to be set. */
1266 if (flags
& ~O_PATH_FLAGS
)
1272 * O_SYNC is implemented as __O_SYNC|O_DSYNC. As many places only
1273 * check for O_DSYNC if the need any syncing at all we enforce it's
1274 * always set instead of having to deal with possibly weird behaviour
1275 * for malicious applications setting only __O_SYNC.
1277 if (flags
& __O_SYNC
)
1280 op
->open_flag
= flags
;
1282 /* O_TRUNC implies we need access checks for write permissions */
1283 if (flags
& O_TRUNC
)
1284 acc_mode
|= MAY_WRITE
;
1286 /* Allow the LSM permission hook to distinguish append
1287 access from general write access. */
1288 if (flags
& O_APPEND
)
1289 acc_mode
|= MAY_APPEND
;
1291 op
->acc_mode
= acc_mode
;
1293 op
->intent
= flags
& O_PATH
? 0 : LOOKUP_OPEN
;
1295 if (flags
& O_CREAT
) {
1296 op
->intent
|= LOOKUP_CREATE
;
1297 if (flags
& O_EXCL
) {
1298 op
->intent
|= LOOKUP_EXCL
;
1299 flags
|= O_NOFOLLOW
;
1303 if (flags
& O_DIRECTORY
)
1304 lookup_flags
|= LOOKUP_DIRECTORY
;
1305 if (!(flags
& O_NOFOLLOW
))
1306 lookup_flags
|= LOOKUP_FOLLOW
;
1308 if (how
->resolve
& RESOLVE_NO_XDEV
)
1309 lookup_flags
|= LOOKUP_NO_XDEV
;
1310 if (how
->resolve
& RESOLVE_NO_MAGICLINKS
)
1311 lookup_flags
|= LOOKUP_NO_MAGICLINKS
;
1312 if (how
->resolve
& RESOLVE_NO_SYMLINKS
)
1313 lookup_flags
|= LOOKUP_NO_SYMLINKS
;
1314 if (how
->resolve
& RESOLVE_BENEATH
)
1315 lookup_flags
|= LOOKUP_BENEATH
;
1316 if (how
->resolve
& RESOLVE_IN_ROOT
)
1317 lookup_flags
|= LOOKUP_IN_ROOT
;
1318 if (how
->resolve
& RESOLVE_CACHED
) {
1319 /* Don't bother even trying for create/truncate/tmpfile open */
1320 if (flags
& (O_TRUNC
| O_CREAT
| __O_TMPFILE
))
1322 lookup_flags
|= LOOKUP_CACHED
;
1325 op
->lookup_flags
= lookup_flags
;
1330 * file_open_name - open file and return file pointer
1332 * @name: struct filename containing path to open
1333 * @flags: open flags as per the open(2) second argument
1334 * @mode: mode for the new file if O_CREAT is set, else ignored
1336 * This is the helper to open a file from kernelspace if you really
1337 * have to. But in generally you should not do this, so please move
1338 * along, nothing to see here..
1340 struct file
*file_open_name(struct filename
*name
, int flags
, umode_t mode
)
1342 struct open_flags op
;
1343 struct open_how how
= build_open_how(flags
, mode
);
1344 int err
= build_open_flags(&how
, &op
);
1346 return ERR_PTR(err
);
1347 return do_filp_open(AT_FDCWD
, name
, &op
);
1351 * filp_open - open file and return file pointer
1353 * @filename: path to open
1354 * @flags: open flags as per the open(2) second argument
1355 * @mode: mode for the new file if O_CREAT is set, else ignored
1357 * This is the helper to open a file from kernelspace if you really
1358 * have to. But in generally you should not do this, so please move
1359 * along, nothing to see here..
1361 struct file
*filp_open(const char *filename
, int flags
, umode_t mode
)
1363 struct filename
*name
= getname_kernel(filename
);
1364 struct file
*file
= ERR_CAST(name
);
1366 if (!IS_ERR(name
)) {
1367 file
= file_open_name(name
, flags
, mode
);
1372 EXPORT_SYMBOL(filp_open
);
1374 struct file
*file_open_root(const struct path
*root
,
1375 const char *filename
, int flags
, umode_t mode
)
1377 struct open_flags op
;
1378 struct open_how how
= build_open_how(flags
, mode
);
1379 int err
= build_open_flags(&how
, &op
);
1381 return ERR_PTR(err
);
1382 return do_file_open_root(root
, filename
, &op
);
1384 EXPORT_SYMBOL(file_open_root
);
1386 static long do_sys_openat2(int dfd
, const char __user
*filename
,
1387 struct open_how
*how
)
1389 struct open_flags op
;
1390 int fd
= build_open_flags(how
, &op
);
1391 struct filename
*tmp
;
1396 tmp
= getname(filename
);
1398 return PTR_ERR(tmp
);
1400 fd
= get_unused_fd_flags(how
->flags
);
1402 struct file
*f
= do_filp_open(dfd
, tmp
, &op
);
1414 long do_sys_open(int dfd
, const char __user
*filename
, int flags
, umode_t mode
)
1416 struct open_how how
= build_open_how(flags
, mode
);
1417 return do_sys_openat2(dfd
, filename
, &how
);
1421 SYSCALL_DEFINE3(open
, const char __user
*, filename
, int, flags
, umode_t
, mode
)
1423 if (force_o_largefile())
1424 flags
|= O_LARGEFILE
;
1425 return do_sys_open(AT_FDCWD
, filename
, flags
, mode
);
1428 SYSCALL_DEFINE4(openat
, int, dfd
, const char __user
*, filename
, int, flags
,
1431 if (force_o_largefile())
1432 flags
|= O_LARGEFILE
;
1433 return do_sys_open(dfd
, filename
, flags
, mode
);
1436 SYSCALL_DEFINE4(openat2
, int, dfd
, const char __user
*, filename
,
1437 struct open_how __user
*, how
, size_t, usize
)
1440 struct open_how tmp
;
1442 BUILD_BUG_ON(sizeof(struct open_how
) < OPEN_HOW_SIZE_VER0
);
1443 BUILD_BUG_ON(sizeof(struct open_how
) != OPEN_HOW_SIZE_LATEST
);
1445 if (unlikely(usize
< OPEN_HOW_SIZE_VER0
))
1447 if (unlikely(usize
> PAGE_SIZE
))
1450 err
= copy_struct_from_user(&tmp
, sizeof(tmp
), how
, usize
);
1454 audit_openat2_how(&tmp
);
1456 /* O_LARGEFILE is only allowed for non-O_PATH. */
1457 if (!(tmp
.flags
& O_PATH
) && force_o_largefile())
1458 tmp
.flags
|= O_LARGEFILE
;
1460 return do_sys_openat2(dfd
, filename
, &tmp
);
1463 #ifdef CONFIG_COMPAT
1465 * Exactly like sys_open(), except that it doesn't set the
1468 COMPAT_SYSCALL_DEFINE3(open
, const char __user
*, filename
, int, flags
, umode_t
, mode
)
1470 return do_sys_open(AT_FDCWD
, filename
, flags
, mode
);
1474 * Exactly like sys_openat(), except that it doesn't set the
1477 COMPAT_SYSCALL_DEFINE4(openat
, int, dfd
, const char __user
*, filename
, int, flags
, umode_t
, mode
)
1479 return do_sys_open(dfd
, filename
, flags
, mode
);
1486 * For backward compatibility? Maybe this should be moved
1487 * into arch/i386 instead?
1489 SYSCALL_DEFINE2(creat
, const char __user
*, pathname
, umode_t
, mode
)
1491 int flags
= O_CREAT
| O_WRONLY
| O_TRUNC
;
1493 if (force_o_largefile())
1494 flags
|= O_LARGEFILE
;
1495 return do_sys_open(AT_FDCWD
, pathname
, flags
, mode
);
1500 * "id" is the POSIX thread ID. We use the
1501 * files pointer for this..
1503 static int filp_flush(struct file
*filp
, fl_owner_t id
)
1507 if (CHECK_DATA_CORRUPTION(file_count(filp
) == 0,
1508 "VFS: Close: file count is 0 (f_op=%ps)",
1513 if (filp
->f_op
->flush
)
1514 retval
= filp
->f_op
->flush(filp
, id
);
1516 if (likely(!(filp
->f_mode
& FMODE_PATH
))) {
1517 dnotify_flush(filp
, id
);
1518 locks_remove_posix(filp
, id
);
1523 int filp_close(struct file
*filp
, fl_owner_t id
)
1527 retval
= filp_flush(filp
, id
);
1532 EXPORT_SYMBOL(filp_close
);
1535 * Careful here! We test whether the file pointer is NULL before
1536 * releasing the fd. This ensures that one clone task can't release
1537 * an fd while another clone is opening it.
1539 SYSCALL_DEFINE1(close
, unsigned int, fd
)
1544 file
= file_close_fd(fd
);
1548 retval
= filp_flush(file
, current
->files
);
1551 * We're returning to user space. Don't bother
1552 * with any delayed fput() cases.
1556 /* can't restart close syscall because file table entry was cleared */
1557 if (unlikely(retval
== -ERESTARTSYS
||
1558 retval
== -ERESTARTNOINTR
||
1559 retval
== -ERESTARTNOHAND
||
1560 retval
== -ERESTART_RESTARTBLOCK
))
1567 * This routine simulates a hangup on the tty, to arrange that users
1568 * are given clean terminals at login time.
1570 SYSCALL_DEFINE0(vhangup
)
1572 if (capable(CAP_SYS_TTY_CONFIG
)) {
1580 * Called when an inode is about to be open.
1581 * We use this to disallow opening large files on 32bit systems if
1582 * the caller didn't specify O_LARGEFILE. On 64bit systems we force
1583 * on this flag in sys_open.
1585 int generic_file_open(struct inode
* inode
, struct file
* filp
)
1587 if (!(filp
->f_flags
& O_LARGEFILE
) && i_size_read(inode
) > MAX_NON_LFS
)
1592 EXPORT_SYMBOL(generic_file_open
);
1595 * This is used by subsystems that don't want seekable
1596 * file descriptors. The function is not supposed to ever fail, the only
1597 * reason it returns an 'int' and not 'void' is so that it can be plugged
1598 * directly into file_operations structure.
1600 int nonseekable_open(struct inode
*inode
, struct file
*filp
)
1602 filp
->f_mode
&= ~(FMODE_LSEEK
| FMODE_PREAD
| FMODE_PWRITE
);
1606 EXPORT_SYMBOL(nonseekable_open
);
1609 * stream_open is used by subsystems that want stream-like file descriptors.
1610 * Such file descriptors are not seekable and don't have notion of position
1611 * (file.f_pos is always 0 and ppos passed to .read()/.write() is always NULL).
1612 * Contrary to file descriptors of other regular files, .read() and .write()
1613 * can run simultaneously.
1615 * stream_open never fails and is marked to return int so that it could be
1616 * directly used as file_operations.open .
1618 int stream_open(struct inode
*inode
, struct file
*filp
)
1620 filp
->f_mode
&= ~(FMODE_LSEEK
| FMODE_PREAD
| FMODE_PWRITE
| FMODE_ATOMIC_POS
);
1621 filp
->f_mode
|= FMODE_STREAM
;
1625 EXPORT_SYMBOL(stream_open
);