1 // SPDX-License-Identifier: GPL-2.0
5 * Copyright (C) 1991, 1992 Linus Torvalds
8 #include <linux/export.h>
10 #include <linux/errno.h>
11 #include <linux/file.h>
12 #include <linux/highuid.h>
14 #include <linux/namei.h>
15 #include <linux/security.h>
16 #include <linux/cred.h>
17 #include <linux/syscalls.h>
18 #include <linux/pagemap.h>
19 #include <linux/compat.h>
21 #include <linux/uaccess.h>
22 #include <asm/unistd.h>
28 * generic_fillattr - Fill in the basic attributes from the inode struct
29 * @inode: Inode to use as the source
30 * @stat: Where to fill in the attributes
32 * Fill in the basic attributes in the kstat structure from data that's to be
33 * found on the VFS inode structure. This is the default if no getattr inode
34 * operation is supplied.
36 void generic_fillattr(struct inode *inode, struct kstat *stat)
38 stat->dev = inode->i_sb->s_dev;
39 stat->ino = inode->i_ino;
40 stat->mode = inode->i_mode;
41 stat->nlink = inode->i_nlink;
42 stat->uid = inode->i_uid;
43 stat->gid = inode->i_gid;
44 stat->rdev = inode->i_rdev;
45 stat->size = i_size_read(inode);
46 stat->atime = inode->i_atime;
47 stat->mtime = inode->i_mtime;
48 stat->ctime = inode->i_ctime;
49 stat->blksize = i_blocksize(inode);
50 stat->blocks = inode->i_blocks;
52 EXPORT_SYMBOL(generic_fillattr);
55 * vfs_getattr_nosec - getattr without security checks
56 * @path: file to get attributes from
57 * @stat: structure to return attributes in
58 * @request_mask: STATX_xxx flags indicating what the caller wants
59 * @query_flags: Query mode (KSTAT_QUERY_FLAGS)
61 * Get attributes without calling security_inode_getattr.
63 * Currently the only caller other than vfs_getattr is internal to the
64 * filehandle lookup code, which uses only the inode number and returns no
65 * attributes to any user. Any other code probably wants vfs_getattr.
67 int vfs_getattr_nosec(const struct path *path, struct kstat *stat,
68 u32 request_mask, unsigned int query_flags)
70 struct inode *inode = d_backing_inode(path->dentry);
72 memset(stat, 0, sizeof(*stat));
73 stat->result_mask |= STATX_BASIC_STATS;
74 query_flags &= KSTAT_QUERY_FLAGS;
76 /* allow the fs to override these if it really wants to */
77 /* SB_NOATIME means filesystem supplies dummy atime value */
78 if (inode->i_sb->s_flags & SB_NOATIME)
79 stat->result_mask &= ~STATX_ATIME;
80 if (IS_AUTOMOUNT(inode))
81 stat->attributes |= STATX_ATTR_AUTOMOUNT;
83 if (inode->i_op->getattr)
84 return inode->i_op->getattr(path, stat, request_mask,
87 generic_fillattr(inode, stat);
90 EXPORT_SYMBOL(vfs_getattr_nosec);
93 * vfs_getattr - Get the enhanced basic attributes of a file
94 * @path: The file of interest
95 * @stat: Where to return the statistics
96 * @request_mask: STATX_xxx flags indicating what the caller wants
97 * @query_flags: Query mode (KSTAT_QUERY_FLAGS)
99 * Ask the filesystem for a file's attributes. The caller must indicate in
100 * request_mask and query_flags to indicate what they want.
102 * If the file is remote, the filesystem can be forced to update the attributes
103 * from the backing store by passing AT_STATX_FORCE_SYNC in query_flags or can
104 * suppress the update by passing AT_STATX_DONT_SYNC.
106 * Bits must have been set in request_mask to indicate which attributes the
107 * caller wants retrieving. Any such attribute not requested may be returned
108 * anyway, but the value may be approximate, and, if remote, may not have been
109 * synchronised with the server.
111 * 0 will be returned on success, and a -ve error code if unsuccessful.
113 int vfs_getattr(const struct path *path, struct kstat *stat,
114 u32 request_mask, unsigned int query_flags)
118 retval = security_inode_getattr(path);
121 return vfs_getattr_nosec(path, stat, request_mask, query_flags);
123 EXPORT_SYMBOL(vfs_getattr);
126 * vfs_statx_fd - Get the enhanced basic attributes by file descriptor
127 * @fd: The file descriptor referring to the file of interest
128 * @stat: The result structure to fill in.
129 * @request_mask: STATX_xxx flags indicating what the caller wants
130 * @query_flags: Query mode (KSTAT_QUERY_FLAGS)
132 * This function is a wrapper around vfs_getattr(). The main difference is
133 * that it uses a file descriptor to determine the file location.
135 * 0 will be returned on success, and a -ve error code if unsuccessful.
137 int vfs_statx_fd(unsigned int fd, struct kstat *stat,
138 u32 request_mask, unsigned int query_flags)
143 if (query_flags & ~KSTAT_QUERY_FLAGS)
148 error = vfs_getattr(&f.file->f_path, stat,
149 request_mask, query_flags);
154 EXPORT_SYMBOL(vfs_statx_fd);
156 inline unsigned vfs_stat_set_lookup_flags(unsigned *lookup_flags, int flags)
158 if ((flags & ~(AT_SYMLINK_NOFOLLOW | AT_NO_AUTOMOUNT |
159 AT_EMPTY_PATH | KSTAT_QUERY_FLAGS)) != 0)
162 *lookup_flags = LOOKUP_FOLLOW | LOOKUP_AUTOMOUNT;
163 if (flags & AT_SYMLINK_NOFOLLOW)
164 *lookup_flags &= ~LOOKUP_FOLLOW;
165 if (flags & AT_NO_AUTOMOUNT)
166 *lookup_flags &= ~LOOKUP_AUTOMOUNT;
167 if (flags & AT_EMPTY_PATH)
168 *lookup_flags |= LOOKUP_EMPTY;
174 * vfs_statx - Get basic and extra attributes by filename
175 * @dfd: A file descriptor representing the base dir for a relative filename
176 * @filename: The name of the file of interest
177 * @flags: Flags to control the query
178 * @stat: The result structure to fill in.
179 * @request_mask: STATX_xxx flags indicating what the caller wants
181 * This function is a wrapper around vfs_getattr(). The main difference is
182 * that it uses a filename and base directory to determine the file location.
183 * Additionally, the use of AT_SYMLINK_NOFOLLOW in flags will prevent a symlink
184 * at the given name from being referenced.
186 * 0 will be returned on success, and a -ve error code if unsuccessful.
188 int vfs_statx(int dfd, const char __user *filename, int flags,
189 struct kstat *stat, u32 request_mask)
193 unsigned lookup_flags;
195 if (vfs_stat_set_lookup_flags(&lookup_flags, flags))
198 error = user_path_at(dfd, filename, lookup_flags, &path);
202 error = vfs_getattr(&path, stat, request_mask, flags);
203 stat->mnt_id = real_mount(path.mnt)->mnt_id;
204 stat->result_mask |= STATX_MNT_ID;
205 if (path.mnt->mnt_root == path.dentry)
206 stat->attributes |= STATX_ATTR_MOUNT_ROOT;
207 stat->attributes_mask |= STATX_ATTR_MOUNT_ROOT;
209 if (retry_estale(error, lookup_flags)) {
210 lookup_flags |= LOOKUP_REVAL;
216 EXPORT_SYMBOL(vfs_statx);
219 #ifdef __ARCH_WANT_OLD_STAT
222 * For backward compatibility? Maybe this should be moved
223 * into arch/i386 instead?
225 static int cp_old_stat(struct kstat *stat, struct __old_kernel_stat __user * statbuf)
227 static int warncount = 5;
228 struct __old_kernel_stat tmp;
232 printk(KERN_WARNING "VFS: Warning: %s using old stat() call. Recompile your binary.\n",
234 } else if (warncount < 0) {
235 /* it's laughable, but... */
239 memset(&tmp, 0, sizeof(struct __old_kernel_stat));
240 tmp.st_dev = old_encode_dev(stat->dev);
241 tmp.st_ino = stat->ino;
242 if (sizeof(tmp.st_ino) < sizeof(stat->ino) && tmp.st_ino != stat->ino)
244 tmp.st_mode = stat->mode;
245 tmp.st_nlink = stat->nlink;
246 if (tmp.st_nlink != stat->nlink)
248 SET_UID(tmp.st_uid, from_kuid_munged(current_user_ns(), stat->uid));
249 SET_GID(tmp.st_gid, from_kgid_munged(current_user_ns(), stat->gid));
250 tmp.st_rdev = old_encode_dev(stat->rdev);
251 #if BITS_PER_LONG == 32
252 if (stat->size > MAX_NON_LFS)
255 tmp.st_size = stat->size;
256 tmp.st_atime = stat->atime.tv_sec;
257 tmp.st_mtime = stat->mtime.tv_sec;
258 tmp.st_ctime = stat->ctime.tv_sec;
259 return copy_to_user(statbuf,&tmp,sizeof(tmp)) ? -EFAULT : 0;
262 SYSCALL_DEFINE2(stat, const char __user *, filename,
263 struct __old_kernel_stat __user *, statbuf)
268 error = vfs_stat(filename, &stat);
272 return cp_old_stat(&stat, statbuf);
275 SYSCALL_DEFINE2(lstat, const char __user *, filename,
276 struct __old_kernel_stat __user *, statbuf)
281 error = vfs_lstat(filename, &stat);
285 return cp_old_stat(&stat, statbuf);
288 SYSCALL_DEFINE2(fstat, unsigned int, fd, struct __old_kernel_stat __user *, statbuf)
291 int error = vfs_fstat(fd, &stat);
294 error = cp_old_stat(&stat, statbuf);
299 #endif /* __ARCH_WANT_OLD_STAT */
301 #ifdef __ARCH_WANT_NEW_STAT
303 #if BITS_PER_LONG == 32
304 # define choose_32_64(a,b) a
306 # define choose_32_64(a,b) b
309 #define valid_dev(x) choose_32_64(old_valid_dev(x),true)
310 #define encode_dev(x) choose_32_64(old_encode_dev,new_encode_dev)(x)
312 #ifndef INIT_STRUCT_STAT_PADDING
313 # define INIT_STRUCT_STAT_PADDING(st) memset(&st, 0, sizeof(st))
316 static int cp_new_stat(struct kstat *stat, struct stat __user *statbuf)
320 if (!valid_dev(stat->dev) || !valid_dev(stat->rdev))
322 #if BITS_PER_LONG == 32
323 if (stat->size > MAX_NON_LFS)
327 INIT_STRUCT_STAT_PADDING(tmp);
328 tmp.st_dev = encode_dev(stat->dev);
329 tmp.st_ino = stat->ino;
330 if (sizeof(tmp.st_ino) < sizeof(stat->ino) && tmp.st_ino != stat->ino)
332 tmp.st_mode = stat->mode;
333 tmp.st_nlink = stat->nlink;
334 if (tmp.st_nlink != stat->nlink)
336 SET_UID(tmp.st_uid, from_kuid_munged(current_user_ns(), stat->uid));
337 SET_GID(tmp.st_gid, from_kgid_munged(current_user_ns(), stat->gid));
338 tmp.st_rdev = encode_dev(stat->rdev);
339 tmp.st_size = stat->size;
340 tmp.st_atime = stat->atime.tv_sec;
341 tmp.st_mtime = stat->mtime.tv_sec;
342 tmp.st_ctime = stat->ctime.tv_sec;
343 #ifdef STAT_HAVE_NSEC
344 tmp.st_atime_nsec = stat->atime.tv_nsec;
345 tmp.st_mtime_nsec = stat->mtime.tv_nsec;
346 tmp.st_ctime_nsec = stat->ctime.tv_nsec;
348 tmp.st_blocks = stat->blocks;
349 tmp.st_blksize = stat->blksize;
350 return copy_to_user(statbuf,&tmp,sizeof(tmp)) ? -EFAULT : 0;
353 SYSCALL_DEFINE2(newstat, const char __user *, filename,
354 struct stat __user *, statbuf)
357 int error = vfs_stat(filename, &stat);
361 return cp_new_stat(&stat, statbuf);
364 SYSCALL_DEFINE2(newlstat, const char __user *, filename,
365 struct stat __user *, statbuf)
370 error = vfs_lstat(filename, &stat);
374 return cp_new_stat(&stat, statbuf);
377 #if !defined(__ARCH_WANT_STAT64) || defined(__ARCH_WANT_SYS_NEWFSTATAT)
378 SYSCALL_DEFINE4(newfstatat, int, dfd, const char __user *, filename,
379 struct stat __user *, statbuf, int, flag)
384 error = vfs_fstatat(dfd, filename, &stat, flag);
387 return cp_new_stat(&stat, statbuf);
391 SYSCALL_DEFINE2(newfstat, unsigned int, fd, struct stat __user *, statbuf)
394 int error = vfs_fstat(fd, &stat);
397 error = cp_new_stat(&stat, statbuf);
403 static int do_readlinkat(int dfd, const char __user *pathname,
404 char __user *buf, int bufsiz)
409 unsigned int lookup_flags = LOOKUP_EMPTY;
415 error = user_path_at_empty(dfd, pathname, lookup_flags, &path, &empty);
417 struct inode *inode = d_backing_inode(path.dentry);
419 error = empty ? -ENOENT : -EINVAL;
421 * AFS mountpoints allow readlink(2) but are not symlinks
423 if (d_is_symlink(path.dentry) || inode->i_op->readlink) {
424 error = security_inode_readlink(path.dentry);
427 error = vfs_readlink(path.dentry, buf, bufsiz);
431 if (retry_estale(error, lookup_flags)) {
432 lookup_flags |= LOOKUP_REVAL;
439 SYSCALL_DEFINE4(readlinkat, int, dfd, const char __user *, pathname,
440 char __user *, buf, int, bufsiz)
442 return do_readlinkat(dfd, pathname, buf, bufsiz);
445 SYSCALL_DEFINE3(readlink, const char __user *, path, char __user *, buf,
448 return do_readlinkat(AT_FDCWD, path, buf, bufsiz);
452 /* ---------- LFS-64 ----------- */
453 #if defined(__ARCH_WANT_STAT64) || defined(__ARCH_WANT_COMPAT_STAT64)
455 #ifndef INIT_STRUCT_STAT64_PADDING
456 # define INIT_STRUCT_STAT64_PADDING(st) memset(&st, 0, sizeof(st))
459 static long cp_new_stat64(struct kstat *stat, struct stat64 __user *statbuf)
463 INIT_STRUCT_STAT64_PADDING(tmp);
465 /* mips has weird padding, so we don't get 64 bits there */
466 tmp.st_dev = new_encode_dev(stat->dev);
467 tmp.st_rdev = new_encode_dev(stat->rdev);
469 tmp.st_dev = huge_encode_dev(stat->dev);
470 tmp.st_rdev = huge_encode_dev(stat->rdev);
472 tmp.st_ino = stat->ino;
473 if (sizeof(tmp.st_ino) < sizeof(stat->ino) && tmp.st_ino != stat->ino)
475 #ifdef STAT64_HAS_BROKEN_ST_INO
476 tmp.__st_ino = stat->ino;
478 tmp.st_mode = stat->mode;
479 tmp.st_nlink = stat->nlink;
480 tmp.st_uid = from_kuid_munged(current_user_ns(), stat->uid);
481 tmp.st_gid = from_kgid_munged(current_user_ns(), stat->gid);
482 tmp.st_atime = stat->atime.tv_sec;
483 tmp.st_atime_nsec = stat->atime.tv_nsec;
484 tmp.st_mtime = stat->mtime.tv_sec;
485 tmp.st_mtime_nsec = stat->mtime.tv_nsec;
486 tmp.st_ctime = stat->ctime.tv_sec;
487 tmp.st_ctime_nsec = stat->ctime.tv_nsec;
488 tmp.st_size = stat->size;
489 tmp.st_blocks = stat->blocks;
490 tmp.st_blksize = stat->blksize;
491 return copy_to_user(statbuf,&tmp,sizeof(tmp)) ? -EFAULT : 0;
494 SYSCALL_DEFINE2(stat64, const char __user *, filename,
495 struct stat64 __user *, statbuf)
498 int error = vfs_stat(filename, &stat);
501 error = cp_new_stat64(&stat, statbuf);
506 SYSCALL_DEFINE2(lstat64, const char __user *, filename,
507 struct stat64 __user *, statbuf)
510 int error = vfs_lstat(filename, &stat);
513 error = cp_new_stat64(&stat, statbuf);
518 SYSCALL_DEFINE2(fstat64, unsigned long, fd, struct stat64 __user *, statbuf)
521 int error = vfs_fstat(fd, &stat);
524 error = cp_new_stat64(&stat, statbuf);
529 SYSCALL_DEFINE4(fstatat64, int, dfd, const char __user *, filename,
530 struct stat64 __user *, statbuf, int, flag)
535 error = vfs_fstatat(dfd, filename, &stat, flag);
538 return cp_new_stat64(&stat, statbuf);
540 #endif /* __ARCH_WANT_STAT64 || __ARCH_WANT_COMPAT_STAT64 */
542 noinline_for_stack int
543 cp_statx(const struct kstat *stat, struct statx __user *buffer)
547 memset(&tmp, 0, sizeof(tmp));
549 tmp.stx_mask = stat->result_mask;
550 tmp.stx_blksize = stat->blksize;
551 tmp.stx_attributes = stat->attributes;
552 tmp.stx_nlink = stat->nlink;
553 tmp.stx_uid = from_kuid_munged(current_user_ns(), stat->uid);
554 tmp.stx_gid = from_kgid_munged(current_user_ns(), stat->gid);
555 tmp.stx_mode = stat->mode;
556 tmp.stx_ino = stat->ino;
557 tmp.stx_size = stat->size;
558 tmp.stx_blocks = stat->blocks;
559 tmp.stx_attributes_mask = stat->attributes_mask;
560 tmp.stx_atime.tv_sec = stat->atime.tv_sec;
561 tmp.stx_atime.tv_nsec = stat->atime.tv_nsec;
562 tmp.stx_btime.tv_sec = stat->btime.tv_sec;
563 tmp.stx_btime.tv_nsec = stat->btime.tv_nsec;
564 tmp.stx_ctime.tv_sec = stat->ctime.tv_sec;
565 tmp.stx_ctime.tv_nsec = stat->ctime.tv_nsec;
566 tmp.stx_mtime.tv_sec = stat->mtime.tv_sec;
567 tmp.stx_mtime.tv_nsec = stat->mtime.tv_nsec;
568 tmp.stx_rdev_major = MAJOR(stat->rdev);
569 tmp.stx_rdev_minor = MINOR(stat->rdev);
570 tmp.stx_dev_major = MAJOR(stat->dev);
571 tmp.stx_dev_minor = MINOR(stat->dev);
572 tmp.stx_mnt_id = stat->mnt_id;
574 return copy_to_user(buffer, &tmp, sizeof(tmp)) ? -EFAULT : 0;
578 * sys_statx - System call to get enhanced stats
579 * @dfd: Base directory to pathwalk from *or* fd to stat.
580 * @filename: File to stat or "" with AT_EMPTY_PATH
581 * @flags: AT_* flags to control pathwalk.
582 * @mask: Parts of statx struct actually required.
583 * @buffer: Result buffer.
585 * Note that fstat() can be emulated by setting dfd to the fd of interest,
586 * supplying "" as the filename and setting AT_EMPTY_PATH in the flags.
588 SYSCALL_DEFINE5(statx,
589 int, dfd, const char __user *, filename, unsigned, flags,
591 struct statx __user *, buffer)
596 if (mask & STATX__RESERVED)
598 if ((flags & AT_STATX_SYNC_TYPE) == AT_STATX_SYNC_TYPE)
601 error = vfs_statx(dfd, filename, flags, &stat, mask);
605 return cp_statx(&stat, buffer);
609 static int cp_compat_stat(struct kstat *stat, struct compat_stat __user *ubuf)
611 struct compat_stat tmp;
613 if (!old_valid_dev(stat->dev) || !old_valid_dev(stat->rdev))
616 memset(&tmp, 0, sizeof(tmp));
617 tmp.st_dev = old_encode_dev(stat->dev);
618 tmp.st_ino = stat->ino;
619 if (sizeof(tmp.st_ino) < sizeof(stat->ino) && tmp.st_ino != stat->ino)
621 tmp.st_mode = stat->mode;
622 tmp.st_nlink = stat->nlink;
623 if (tmp.st_nlink != stat->nlink)
625 SET_UID(tmp.st_uid, from_kuid_munged(current_user_ns(), stat->uid));
626 SET_GID(tmp.st_gid, from_kgid_munged(current_user_ns(), stat->gid));
627 tmp.st_rdev = old_encode_dev(stat->rdev);
628 if ((u64) stat->size > MAX_NON_LFS)
630 tmp.st_size = stat->size;
631 tmp.st_atime = stat->atime.tv_sec;
632 tmp.st_atime_nsec = stat->atime.tv_nsec;
633 tmp.st_mtime = stat->mtime.tv_sec;
634 tmp.st_mtime_nsec = stat->mtime.tv_nsec;
635 tmp.st_ctime = stat->ctime.tv_sec;
636 tmp.st_ctime_nsec = stat->ctime.tv_nsec;
637 tmp.st_blocks = stat->blocks;
638 tmp.st_blksize = stat->blksize;
639 return copy_to_user(ubuf, &tmp, sizeof(tmp)) ? -EFAULT : 0;
642 COMPAT_SYSCALL_DEFINE2(newstat, const char __user *, filename,
643 struct compat_stat __user *, statbuf)
648 error = vfs_stat(filename, &stat);
651 return cp_compat_stat(&stat, statbuf);
654 COMPAT_SYSCALL_DEFINE2(newlstat, const char __user *, filename,
655 struct compat_stat __user *, statbuf)
660 error = vfs_lstat(filename, &stat);
663 return cp_compat_stat(&stat, statbuf);
666 #ifndef __ARCH_WANT_STAT64
667 COMPAT_SYSCALL_DEFINE4(newfstatat, unsigned int, dfd,
668 const char __user *, filename,
669 struct compat_stat __user *, statbuf, int, flag)
674 error = vfs_fstatat(dfd, filename, &stat, flag);
677 return cp_compat_stat(&stat, statbuf);
681 COMPAT_SYSCALL_DEFINE2(newfstat, unsigned int, fd,
682 struct compat_stat __user *, statbuf)
685 int error = vfs_fstat(fd, &stat);
688 error = cp_compat_stat(&stat, statbuf);
693 /* Caller is here responsible for sufficient locking (ie. inode->i_lock) */
694 void __inode_add_bytes(struct inode *inode, loff_t bytes)
696 inode->i_blocks += bytes >> 9;
698 inode->i_bytes += bytes;
699 if (inode->i_bytes >= 512) {
701 inode->i_bytes -= 512;
704 EXPORT_SYMBOL(__inode_add_bytes);
706 void inode_add_bytes(struct inode *inode, loff_t bytes)
708 spin_lock(&inode->i_lock);
709 __inode_add_bytes(inode, bytes);
710 spin_unlock(&inode->i_lock);
713 EXPORT_SYMBOL(inode_add_bytes);
715 void __inode_sub_bytes(struct inode *inode, loff_t bytes)
717 inode->i_blocks -= bytes >> 9;
719 if (inode->i_bytes < bytes) {
721 inode->i_bytes += 512;
723 inode->i_bytes -= bytes;
726 EXPORT_SYMBOL(__inode_sub_bytes);
728 void inode_sub_bytes(struct inode *inode, loff_t bytes)
730 spin_lock(&inode->i_lock);
731 __inode_sub_bytes(inode, bytes);
732 spin_unlock(&inode->i_lock);
735 EXPORT_SYMBOL(inode_sub_bytes);
737 loff_t inode_get_bytes(struct inode *inode)
741 spin_lock(&inode->i_lock);
742 ret = __inode_get_bytes(inode);
743 spin_unlock(&inode->i_lock);
747 EXPORT_SYMBOL(inode_get_bytes);
749 void inode_set_bytes(struct inode *inode, loff_t bytes)
751 /* Caller is here responsible for sufficient locking
752 * (ie. inode->i_lock) */
753 inode->i_blocks = bytes >> 9;
754 inode->i_bytes = bytes & 511;
757 EXPORT_SYMBOL(inode_set_bytes);