1 // SPDX-License-Identifier: GPL-2.0-only
5 * Written 1992,1993 by Werner Almesberger
7 * regular file handling primitives for fat-based filesystems
10 #include <linux/capability.h>
11 #include <linux/module.h>
12 #include <linux/compat.h>
13 #include <linux/mount.h>
14 #include <linux/blkdev.h>
15 #include <linux/backing-dev.h>
16 #include <linux/fsnotify.h>
17 #include <linux/security.h>
18 #include <linux/falloc.h>
21 static long fat_fallocate(struct file
*file
, int mode
,
22 loff_t offset
, loff_t len
);
24 static int fat_ioctl_get_attributes(struct inode
*inode
, u32 __user
*user_attr
)
29 attr
= fat_make_attrs(inode
);
32 return put_user(attr
, user_attr
);
35 static int fat_ioctl_set_attributes(struct file
*file
, u32 __user
*user_attr
)
37 struct inode
*inode
= file_inode(file
);
38 struct msdos_sb_info
*sbi
= MSDOS_SB(inode
->i_sb
);
39 int is_dir
= S_ISDIR(inode
->i_mode
);
44 err
= get_user(attr
, user_attr
);
48 err
= mnt_want_write_file(file
);
54 * ATTR_VOLUME and ATTR_DIR cannot be changed; this also
55 * prevents the user from turning us into a VFAT
56 * longname entry. Also, we obviously can't set
57 * any of the NTFS attributes in the high 24 bits.
59 attr
&= 0xff & ~(ATTR_VOLUME
| ATTR_DIR
);
60 /* Merge in ATTR_VOLUME and ATTR_DIR */
61 attr
|= (MSDOS_I(inode
)->i_attrs
& ATTR_VOLUME
) |
62 (is_dir
? ATTR_DIR
: 0);
63 oldattr
= fat_make_attrs(inode
);
65 /* Equivalent to a chmod() */
66 ia
.ia_valid
= ATTR_MODE
| ATTR_CTIME
;
67 ia
.ia_ctime
= current_time(inode
);
69 ia
.ia_mode
= fat_make_mode(sbi
, attr
, S_IRWXUGO
);
71 ia
.ia_mode
= fat_make_mode(sbi
, attr
,
72 S_IRUGO
| S_IWUGO
| (inode
->i_mode
& S_IXUGO
));
75 /* The root directory has no attributes */
76 if (inode
->i_ino
== MSDOS_ROOT_INO
&& attr
!= ATTR_DIR
) {
78 goto out_unlock_inode
;
81 if (sbi
->options
.sys_immutable
&&
82 ((attr
| oldattr
) & ATTR_SYS
) &&
83 !capable(CAP_LINUX_IMMUTABLE
)) {
85 goto out_unlock_inode
;
89 * The security check is questionable... We single
90 * out the RO attribute for checking by the security
91 * module, just because it maps to a file mode.
93 err
= security_inode_setattr(file
->f_path
.dentry
, &ia
);
95 goto out_unlock_inode
;
97 /* This MUST be done before doing anything irreversible... */
98 err
= fat_setattr(file
->f_path
.dentry
, &ia
);
100 goto out_unlock_inode
;
102 fsnotify_change(file
->f_path
.dentry
, ia
.ia_valid
);
103 if (sbi
->options
.sys_immutable
) {
105 inode
->i_flags
|= S_IMMUTABLE
;
107 inode
->i_flags
&= ~S_IMMUTABLE
;
110 fat_save_attrs(inode
, attr
);
111 mark_inode_dirty(inode
);
114 mnt_drop_write_file(file
);
119 static int fat_ioctl_get_volume_id(struct inode
*inode
, u32 __user
*user_attr
)
121 struct msdos_sb_info
*sbi
= MSDOS_SB(inode
->i_sb
);
122 return put_user(sbi
->vol_id
, user_attr
);
125 static int fat_ioctl_fitrim(struct inode
*inode
, unsigned long arg
)
127 struct super_block
*sb
= inode
->i_sb
;
128 struct fstrim_range __user
*user_range
;
129 struct fstrim_range range
;
130 struct request_queue
*q
= bdev_get_queue(sb
->s_bdev
);
133 if (!capable(CAP_SYS_ADMIN
))
136 if (!blk_queue_discard(q
))
139 user_range
= (struct fstrim_range __user
*)arg
;
140 if (copy_from_user(&range
, user_range
, sizeof(range
)))
143 range
.minlen
= max_t(unsigned int, range
.minlen
,
144 q
->limits
.discard_granularity
);
146 err
= fat_trim_fs(inode
, &range
);
150 if (copy_to_user(user_range
, &range
, sizeof(range
)))
156 long fat_generic_ioctl(struct file
*filp
, unsigned int cmd
, unsigned long arg
)
158 struct inode
*inode
= file_inode(filp
);
159 u32 __user
*user_attr
= (u32 __user
*)arg
;
162 case FAT_IOCTL_GET_ATTRIBUTES
:
163 return fat_ioctl_get_attributes(inode
, user_attr
);
164 case FAT_IOCTL_SET_ATTRIBUTES
:
165 return fat_ioctl_set_attributes(filp
, user_attr
);
166 case FAT_IOCTL_GET_VOLUME_ID
:
167 return fat_ioctl_get_volume_id(inode
, user_attr
);
169 return fat_ioctl_fitrim(inode
, arg
);
171 return -ENOTTY
; /* Inappropriate ioctl for device */
175 static int fat_file_release(struct inode
*inode
, struct file
*filp
)
177 if ((filp
->f_mode
& FMODE_WRITE
) &&
178 MSDOS_SB(inode
->i_sb
)->options
.flush
) {
179 fat_flush_inodes(inode
->i_sb
, inode
, NULL
);
180 congestion_wait(BLK_RW_ASYNC
, HZ
/10);
185 int fat_file_fsync(struct file
*filp
, loff_t start
, loff_t end
, int datasync
)
187 struct inode
*inode
= filp
->f_mapping
->host
;
190 err
= __generic_file_fsync(filp
, start
, end
, datasync
);
194 err
= sync_mapping_buffers(MSDOS_SB(inode
->i_sb
)->fat_inode
->i_mapping
);
198 return blkdev_issue_flush(inode
->i_sb
->s_bdev
, GFP_KERNEL
, NULL
);
202 const struct file_operations fat_file_operations
= {
203 .llseek
= generic_file_llseek
,
204 .read_iter
= generic_file_read_iter
,
205 .write_iter
= generic_file_write_iter
,
206 .mmap
= generic_file_mmap
,
207 .release
= fat_file_release
,
208 .unlocked_ioctl
= fat_generic_ioctl
,
209 .compat_ioctl
= compat_ptr_ioctl
,
210 .fsync
= fat_file_fsync
,
211 .splice_read
= generic_file_splice_read
,
212 .splice_write
= iter_file_splice_write
,
213 .fallocate
= fat_fallocate
,
216 static int fat_cont_expand(struct inode
*inode
, loff_t size
)
218 struct address_space
*mapping
= inode
->i_mapping
;
219 loff_t start
= inode
->i_size
, count
= size
- inode
->i_size
;
222 err
= generic_cont_expand_simple(inode
, size
);
226 fat_truncate_time(inode
, NULL
, S_CTIME
|S_MTIME
);
227 mark_inode_dirty(inode
);
228 if (IS_SYNC(inode
)) {
232 * Opencode syncing since we don't have a file open to use
233 * standard fsync path.
235 err
= filemap_fdatawrite_range(mapping
, start
,
237 err2
= sync_mapping_buffers(mapping
);
240 err2
= write_inode_now(inode
, 1);
244 err
= filemap_fdatawait_range(mapping
, start
,
253 * Preallocate space for a file. This implements fat's fallocate file
254 * operation, which gets called from sys_fallocate system call. User
255 * space requests len bytes at offset. If FALLOC_FL_KEEP_SIZE is set
256 * we just allocate clusters without zeroing them out. Otherwise we
257 * allocate and zero out clusters via an expanding truncate.
259 static long fat_fallocate(struct file
*file
, int mode
,
260 loff_t offset
, loff_t len
)
262 int nr_cluster
; /* Number of clusters to be allocated */
263 loff_t mm_bytes
; /* Number of bytes to be allocated for file */
264 loff_t ondisksize
; /* block aligned on-disk size in bytes*/
265 struct inode
*inode
= file
->f_mapping
->host
;
266 struct super_block
*sb
= inode
->i_sb
;
267 struct msdos_sb_info
*sbi
= MSDOS_SB(sb
);
270 /* No support for hole punch or other fallocate flags. */
271 if (mode
& ~FALLOC_FL_KEEP_SIZE
)
274 /* No support for dir */
275 if (!S_ISREG(inode
->i_mode
))
279 if (mode
& FALLOC_FL_KEEP_SIZE
) {
280 ondisksize
= inode
->i_blocks
<< 9;
281 if ((offset
+ len
) <= ondisksize
)
284 /* First compute the number of clusters to be allocated */
285 mm_bytes
= offset
+ len
- ondisksize
;
286 nr_cluster
= (mm_bytes
+ (sbi
->cluster_size
- 1)) >>
289 /* Start the allocation.We are not zeroing out the clusters */
290 while (nr_cluster
-- > 0) {
291 err
= fat_add_cluster(inode
);
296 if ((offset
+ len
) <= i_size_read(inode
))
299 /* This is just an expanding truncate */
300 err
= fat_cont_expand(inode
, (offset
+ len
));
308 /* Free all clusters after the skip'th cluster. */
309 static int fat_free(struct inode
*inode
, int skip
)
311 struct super_block
*sb
= inode
->i_sb
;
312 int err
, wait
, free_start
, i_start
, i_logstart
;
314 if (MSDOS_I(inode
)->i_start
== 0)
317 fat_cache_inval_inode(inode
);
319 wait
= IS_DIRSYNC(inode
);
320 i_start
= free_start
= MSDOS_I(inode
)->i_start
;
321 i_logstart
= MSDOS_I(inode
)->i_logstart
;
323 /* First, we write the new file size. */
325 MSDOS_I(inode
)->i_start
= 0;
326 MSDOS_I(inode
)->i_logstart
= 0;
328 MSDOS_I(inode
)->i_attrs
|= ATTR_ARCH
;
329 fat_truncate_time(inode
, NULL
, S_CTIME
|S_MTIME
);
331 err
= fat_sync_inode(inode
);
333 MSDOS_I(inode
)->i_start
= i_start
;
334 MSDOS_I(inode
)->i_logstart
= i_logstart
;
338 mark_inode_dirty(inode
);
340 /* Write a new EOF, and get the remaining cluster chain for freeing. */
342 struct fat_entry fatent
;
343 int ret
, fclus
, dclus
;
345 ret
= fat_get_cluster(inode
, skip
- 1, &fclus
, &dclus
);
348 else if (ret
== FAT_ENT_EOF
)
351 fatent_init(&fatent
);
352 ret
= fat_ent_read(inode
, &fatent
, dclus
);
353 if (ret
== FAT_ENT_EOF
) {
354 fatent_brelse(&fatent
);
356 } else if (ret
== FAT_ENT_FREE
) {
358 "%s: invalid cluster chain (i_pos %lld)",
359 __func__
, MSDOS_I(inode
)->i_pos
);
361 } else if (ret
> 0) {
362 err
= fat_ent_write(inode
, &fatent
, FAT_ENT_EOF
, wait
);
366 fatent_brelse(&fatent
);
372 inode
->i_blocks
= skip
<< (MSDOS_SB(sb
)->cluster_bits
- 9);
374 /* Freeing the remained cluster chain */
375 return fat_free_clusters(inode
, free_start
);
378 void fat_truncate_blocks(struct inode
*inode
, loff_t offset
)
380 struct msdos_sb_info
*sbi
= MSDOS_SB(inode
->i_sb
);
381 const unsigned int cluster_size
= sbi
->cluster_size
;
385 * This protects against truncating a file bigger than it was then
386 * trying to write into the hole.
388 if (MSDOS_I(inode
)->mmu_private
> offset
)
389 MSDOS_I(inode
)->mmu_private
= offset
;
391 nr_clusters
= (offset
+ (cluster_size
- 1)) >> sbi
->cluster_bits
;
393 fat_free(inode
, nr_clusters
);
394 fat_flush_inodes(inode
->i_sb
, inode
, NULL
);
397 int fat_getattr(const struct path
*path
, struct kstat
*stat
,
398 u32 request_mask
, unsigned int flags
)
400 struct inode
*inode
= d_inode(path
->dentry
);
401 generic_fillattr(inode
, stat
);
402 stat
->blksize
= MSDOS_SB(inode
->i_sb
)->cluster_size
;
404 if (MSDOS_SB(inode
->i_sb
)->options
.nfs
== FAT_NFS_NOSTALE_RO
) {
405 /* Use i_pos for ino. This is used as fileid of nfs. */
406 stat
->ino
= fat_i_pos_read(MSDOS_SB(inode
->i_sb
), inode
);
410 EXPORT_SYMBOL_GPL(fat_getattr
);
412 static int fat_sanitize_mode(const struct msdos_sb_info
*sbi
,
413 struct inode
*inode
, umode_t
*mode_ptr
)
418 * Note, the basic check is already done by a caller of
419 * (attr->ia_mode & ~FAT_VALID_MODE)
422 if (S_ISREG(inode
->i_mode
))
423 mask
= sbi
->options
.fs_fmask
;
425 mask
= sbi
->options
.fs_dmask
;
427 perm
= *mode_ptr
& ~(S_IFMT
| mask
);
430 * Of the r and x bits, all (subject to umask) must be present. Of the
431 * w bits, either all (subject to umask) or none must be present.
433 * If fat_mode_can_hold_ro(inode) is false, can't change w bits.
435 if ((perm
& (S_IRUGO
| S_IXUGO
)) != (inode
->i_mode
& (S_IRUGO
|S_IXUGO
)))
437 if (fat_mode_can_hold_ro(inode
)) {
438 if ((perm
& S_IWUGO
) && ((perm
& S_IWUGO
) != (S_IWUGO
& ~mask
)))
441 if ((perm
& S_IWUGO
) != (S_IWUGO
& ~mask
))
445 *mode_ptr
&= S_IFMT
| perm
;
450 static int fat_allow_set_time(struct msdos_sb_info
*sbi
, struct inode
*inode
)
452 umode_t allow_utime
= sbi
->options
.allow_utime
;
454 if (!uid_eq(current_fsuid(), inode
->i_uid
)) {
455 if (in_group_p(inode
->i_gid
))
457 if (allow_utime
& MAY_WRITE
)
461 /* use a default check */
465 #define TIMES_SET_FLAGS (ATTR_MTIME_SET | ATTR_ATIME_SET | ATTR_TIMES_SET)
466 /* valid file mode bits */
467 #define FAT_VALID_MODE (S_IFREG | S_IFDIR | S_IRWXUGO)
469 int fat_setattr(struct dentry
*dentry
, struct iattr
*attr
)
471 struct msdos_sb_info
*sbi
= MSDOS_SB(dentry
->d_sb
);
472 struct inode
*inode
= d_inode(dentry
);
473 unsigned int ia_valid
;
476 /* Check for setting the inode time. */
477 ia_valid
= attr
->ia_valid
;
478 if (ia_valid
& TIMES_SET_FLAGS
) {
479 if (fat_allow_set_time(sbi
, inode
))
480 attr
->ia_valid
&= ~TIMES_SET_FLAGS
;
483 error
= setattr_prepare(dentry
, attr
);
484 attr
->ia_valid
= ia_valid
;
486 if (sbi
->options
.quiet
)
492 * Expand the file. Since inode_setattr() updates ->i_size
493 * before calling the ->truncate(), but FAT needs to fill the
494 * hole before it. XXX: this is no longer true with new truncate
497 if (attr
->ia_valid
& ATTR_SIZE
) {
498 inode_dio_wait(inode
);
500 if (attr
->ia_size
> inode
->i_size
) {
501 error
= fat_cont_expand(inode
, attr
->ia_size
);
502 if (error
|| attr
->ia_valid
== ATTR_SIZE
)
504 attr
->ia_valid
&= ~ATTR_SIZE
;
508 if (((attr
->ia_valid
& ATTR_UID
) &&
509 (!uid_eq(attr
->ia_uid
, sbi
->options
.fs_uid
))) ||
510 ((attr
->ia_valid
& ATTR_GID
) &&
511 (!gid_eq(attr
->ia_gid
, sbi
->options
.fs_gid
))) ||
512 ((attr
->ia_valid
& ATTR_MODE
) &&
513 (attr
->ia_mode
& ~FAT_VALID_MODE
)))
517 if (sbi
->options
.quiet
)
523 * We don't return -EPERM here. Yes, strange, but this is too
526 if (attr
->ia_valid
& ATTR_MODE
) {
527 if (fat_sanitize_mode(sbi
, inode
, &attr
->ia_mode
) < 0)
528 attr
->ia_valid
&= ~ATTR_MODE
;
531 if (attr
->ia_valid
& ATTR_SIZE
) {
532 error
= fat_block_truncate_page(inode
, attr
->ia_size
);
535 down_write(&MSDOS_I(inode
)->truncate_lock
);
536 truncate_setsize(inode
, attr
->ia_size
);
537 fat_truncate_blocks(inode
, attr
->ia_size
);
538 up_write(&MSDOS_I(inode
)->truncate_lock
);
542 * setattr_copy can't truncate these appropriately, so we'll
543 * copy them ourselves
545 if (attr
->ia_valid
& ATTR_ATIME
)
546 fat_truncate_time(inode
, &attr
->ia_atime
, S_ATIME
);
547 if (attr
->ia_valid
& ATTR_CTIME
)
548 fat_truncate_time(inode
, &attr
->ia_ctime
, S_CTIME
);
549 if (attr
->ia_valid
& ATTR_MTIME
)
550 fat_truncate_time(inode
, &attr
->ia_mtime
, S_MTIME
);
551 attr
->ia_valid
&= ~(ATTR_ATIME
|ATTR_CTIME
|ATTR_MTIME
);
553 setattr_copy(inode
, attr
);
554 mark_inode_dirty(inode
);
558 EXPORT_SYMBOL_GPL(fat_setattr
);
560 const struct inode_operations fat_file_inode_operations
= {
561 .setattr
= fat_setattr
,
562 .getattr
= fat_getattr
,
563 .update_time
= fat_update_time
,