1 // SPDX-License-Identifier: GPL-2.0
5 * Copyright (C) 1992, 1993, 1994, 1995
6 * Remy Card (card@masi.ibp.fr)
7 * Laboratoire MASI - Institut Blaise Pascal
8 * Universite Pierre et Marie Curie (Paris VI)
12 * linux/fs/minix/file.c
14 * Copyright (C) 1991, 1992 Linus Torvalds
16 * ext4 fs regular file handling primitives
18 * 64-bit file support on 64-bit platforms by Jakub Jelinek
19 * (jj@sunsite.ms.mff.cuni.cz)
22 #include <linux/time.h>
24 #include <linux/iomap.h>
25 #include <linux/mount.h>
26 #include <linux/path.h>
27 #include <linux/dax.h>
28 #include <linux/quotaops.h>
29 #include <linux/pagevec.h>
30 #include <linux/uio.h>
31 #include <linux/mman.h>
33 #include "ext4_jbd2.h"
38 static ssize_t
ext4_dax_read_iter(struct kiocb
*iocb
, struct iov_iter
*to
)
40 struct inode
*inode
= file_inode(iocb
->ki_filp
);
43 if (!inode_trylock_shared(inode
)) {
44 if (iocb
->ki_flags
& IOCB_NOWAIT
)
46 inode_lock_shared(inode
);
49 * Recheck under inode lock - at this point we are sure it cannot
53 inode_unlock_shared(inode
);
54 /* Fallback to buffered IO in case we cannot support DAX */
55 return generic_file_read_iter(iocb
, to
);
57 ret
= dax_iomap_rw(iocb
, to
, &ext4_iomap_ops
);
58 inode_unlock_shared(inode
);
60 file_accessed(iocb
->ki_filp
);
65 static ssize_t
ext4_file_read_iter(struct kiocb
*iocb
, struct iov_iter
*to
)
67 if (unlikely(ext4_forced_shutdown(EXT4_SB(file_inode(iocb
->ki_filp
)->i_sb
))))
70 if (!iov_iter_count(to
))
71 return 0; /* skip atime */
74 if (IS_DAX(file_inode(iocb
->ki_filp
)))
75 return ext4_dax_read_iter(iocb
, to
);
77 return generic_file_read_iter(iocb
, to
);
81 * Called when an inode is released. Note that this is different
82 * from ext4_file_open: open gets called at every open, but release
83 * gets called only when /all/ the files are closed.
85 static int ext4_release_file(struct inode
*inode
, struct file
*filp
)
87 if (ext4_test_inode_state(inode
, EXT4_STATE_DA_ALLOC_CLOSE
)) {
88 ext4_alloc_da_blocks(inode
);
89 ext4_clear_inode_state(inode
, EXT4_STATE_DA_ALLOC_CLOSE
);
91 /* if we are the last writer on the inode, drop the block reservation */
92 if ((filp
->f_mode
& FMODE_WRITE
) &&
93 (atomic_read(&inode
->i_writecount
) == 1) &&
94 !EXT4_I(inode
)->i_reserved_data_blocks
)
96 down_write(&EXT4_I(inode
)->i_data_sem
);
97 ext4_discard_preallocations(inode
);
98 up_write(&EXT4_I(inode
)->i_data_sem
);
100 if (is_dx(inode
) && filp
->private_data
)
101 ext4_htree_free_dir_info(filp
->private_data
);
106 static void ext4_unwritten_wait(struct inode
*inode
)
108 wait_queue_head_t
*wq
= ext4_ioend_wq(inode
);
110 wait_event(*wq
, (atomic_read(&EXT4_I(inode
)->i_unwritten
) == 0));
114 * This tests whether the IO in question is block-aligned or not.
115 * Ext4 utilizes unwritten extents when hole-filling during direct IO, and they
116 * are converted to written only after the IO is complete. Until they are
117 * mapped, these blocks appear as holes, so dio_zero_block() will assume that
118 * it needs to zero out portions of the start and/or end block. If 2 AIO
119 * threads are at work on the same unwritten block, they must be synchronized
120 * or one thread will zero the other's data, causing corruption.
123 ext4_unaligned_aio(struct inode
*inode
, struct iov_iter
*from
, loff_t pos
)
125 struct super_block
*sb
= inode
->i_sb
;
126 int blockmask
= sb
->s_blocksize
- 1;
128 if (pos
>= ALIGN(i_size_read(inode
), sb
->s_blocksize
))
131 if ((pos
| iov_iter_alignment(from
)) & blockmask
)
137 /* Is IO overwriting allocated and initialized blocks? */
138 static bool ext4_overwrite_io(struct inode
*inode
, loff_t pos
, loff_t len
)
140 struct ext4_map_blocks map
;
141 unsigned int blkbits
= inode
->i_blkbits
;
144 if (pos
+ len
> i_size_read(inode
))
147 map
.m_lblk
= pos
>> blkbits
;
148 map
.m_len
= EXT4_MAX_BLOCKS(len
, pos
, blkbits
);
151 err
= ext4_map_blocks(NULL
, inode
, &map
, 0);
153 * 'err==len' means that all of the blocks have been preallocated,
154 * regardless of whether they have been initialized or not. To exclude
155 * unwritten extents, we need to check m_flags.
157 return err
== blklen
&& (map
.m_flags
& EXT4_MAP_MAPPED
);
160 static ssize_t
ext4_write_checks(struct kiocb
*iocb
, struct iov_iter
*from
)
162 struct inode
*inode
= file_inode(iocb
->ki_filp
);
165 ret
= generic_write_checks(iocb
, from
);
169 * If we have encountered a bitmap-format file, the size limit
170 * is smaller than s_maxbytes, which is for extent-mapped files.
172 if (!(ext4_test_inode_flag(inode
, EXT4_INODE_EXTENTS
))) {
173 struct ext4_sb_info
*sbi
= EXT4_SB(inode
->i_sb
);
175 if (iocb
->ki_pos
>= sbi
->s_bitmap_maxbytes
)
177 iov_iter_truncate(from
, sbi
->s_bitmap_maxbytes
- iocb
->ki_pos
);
179 return iov_iter_count(from
);
184 ext4_dax_write_iter(struct kiocb
*iocb
, struct iov_iter
*from
)
186 struct inode
*inode
= file_inode(iocb
->ki_filp
);
189 if (!inode_trylock(inode
)) {
190 if (iocb
->ki_flags
& IOCB_NOWAIT
)
194 ret
= ext4_write_checks(iocb
, from
);
197 ret
= file_remove_privs(iocb
->ki_filp
);
200 ret
= file_update_time(iocb
->ki_filp
);
204 ret
= dax_iomap_rw(iocb
, from
, &ext4_iomap_ops
);
208 ret
= generic_write_sync(iocb
, ret
);
214 ext4_file_write_iter(struct kiocb
*iocb
, struct iov_iter
*from
)
216 struct inode
*inode
= file_inode(iocb
->ki_filp
);
217 int o_direct
= iocb
->ki_flags
& IOCB_DIRECT
;
218 int unaligned_aio
= 0;
222 if (unlikely(ext4_forced_shutdown(EXT4_SB(inode
->i_sb
))))
227 return ext4_dax_write_iter(iocb
, from
);
229 if (!o_direct
&& (iocb
->ki_flags
& IOCB_NOWAIT
))
232 if (!inode_trylock(inode
)) {
233 if (iocb
->ki_flags
& IOCB_NOWAIT
)
238 ret
= ext4_write_checks(iocb
, from
);
243 * Unaligned direct AIO must be serialized among each other as zeroing
244 * of partial blocks of two competing unaligned AIOs can result in data
247 if (o_direct
&& ext4_test_inode_flag(inode
, EXT4_INODE_EXTENTS
) &&
248 !is_sync_kiocb(iocb
) &&
249 ext4_unaligned_aio(inode
, from
, iocb
->ki_pos
)) {
251 ext4_unwritten_wait(inode
);
254 iocb
->private = &overwrite
;
255 /* Check whether we do a DIO overwrite or not */
256 if (o_direct
&& !unaligned_aio
) {
257 if (ext4_overwrite_io(inode
, iocb
->ki_pos
, iov_iter_count(from
))) {
258 if (ext4_should_dioread_nolock(inode
))
260 } else if (iocb
->ki_flags
& IOCB_NOWAIT
) {
266 ret
= __generic_file_write_iter(iocb
, from
);
268 * Unaligned direct AIO must be the only IO in flight. Otherwise
269 * overlapping aligned IO after unaligned might result in data
272 if (ret
== -EIOCBQUEUED
&& unaligned_aio
)
273 ext4_unwritten_wait(inode
);
277 ret
= generic_write_sync(iocb
, ret
);
287 static vm_fault_t
ext4_dax_huge_fault(struct vm_fault
*vmf
,
288 enum page_entry_size pe_size
)
293 handle_t
*handle
= NULL
;
294 struct inode
*inode
= file_inode(vmf
->vma
->vm_file
);
295 struct super_block
*sb
= inode
->i_sb
;
298 * We have to distinguish real writes from writes which will result in a
299 * COW page; COW writes should *not* poke the journal (the file will not
300 * be changed). Doing so would cause unintended failures when mounted
303 * We check for VM_SHARED rather than vmf->cow_page since the latter is
304 * unset for pe_size != PE_SIZE_PTE (i.e. only in do_cow_fault); for
305 * other sizes, dax_iomap_fault will handle splitting / fallback so that
306 * we eventually come back with a COW page.
308 bool write
= (vmf
->flags
& FAULT_FLAG_WRITE
) &&
309 (vmf
->vma
->vm_flags
& VM_SHARED
);
313 sb_start_pagefault(sb
);
314 file_update_time(vmf
->vma
->vm_file
);
315 down_read(&EXT4_I(inode
)->i_mmap_sem
);
317 handle
= ext4_journal_start_sb(sb
, EXT4_HT_WRITE_PAGE
,
318 EXT4_DATA_TRANS_BLOCKS(sb
));
319 if (IS_ERR(handle
)) {
320 up_read(&EXT4_I(inode
)->i_mmap_sem
);
321 sb_end_pagefault(sb
);
322 return VM_FAULT_SIGBUS
;
325 down_read(&EXT4_I(inode
)->i_mmap_sem
);
327 result
= dax_iomap_fault(vmf
, pe_size
, &pfn
, &error
, &ext4_iomap_ops
);
329 ext4_journal_stop(handle
);
331 if ((result
& VM_FAULT_ERROR
) && error
== -ENOSPC
&&
332 ext4_should_retry_alloc(sb
, &retries
))
334 /* Handling synchronous page fault? */
335 if (result
& VM_FAULT_NEEDDSYNC
)
336 result
= dax_finish_sync_fault(vmf
, pe_size
, pfn
);
337 up_read(&EXT4_I(inode
)->i_mmap_sem
);
338 sb_end_pagefault(sb
);
340 up_read(&EXT4_I(inode
)->i_mmap_sem
);
346 static vm_fault_t
ext4_dax_fault(struct vm_fault
*vmf
)
348 return ext4_dax_huge_fault(vmf
, PE_SIZE_PTE
);
351 static const struct vm_operations_struct ext4_dax_vm_ops
= {
352 .fault
= ext4_dax_fault
,
353 .huge_fault
= ext4_dax_huge_fault
,
354 .page_mkwrite
= ext4_dax_fault
,
355 .pfn_mkwrite
= ext4_dax_fault
,
358 #define ext4_dax_vm_ops ext4_file_vm_ops
361 static const struct vm_operations_struct ext4_file_vm_ops
= {
362 .fault
= ext4_filemap_fault
,
363 .map_pages
= filemap_map_pages
,
364 .page_mkwrite
= ext4_page_mkwrite
,
367 static int ext4_file_mmap(struct file
*file
, struct vm_area_struct
*vma
)
369 struct inode
*inode
= file
->f_mapping
->host
;
371 if (unlikely(ext4_forced_shutdown(EXT4_SB(inode
->i_sb
))))
375 * We don't support synchronous mappings for non-DAX files. At least
376 * until someone comes with a sensible use case.
378 if (!IS_DAX(file_inode(file
)) && (vma
->vm_flags
& VM_SYNC
))
382 if (IS_DAX(file_inode(file
))) {
383 vma
->vm_ops
= &ext4_dax_vm_ops
;
384 vma
->vm_flags
|= VM_HUGEPAGE
;
386 vma
->vm_ops
= &ext4_file_vm_ops
;
391 static int ext4_sample_last_mounted(struct super_block
*sb
,
392 struct vfsmount
*mnt
)
394 struct ext4_sb_info
*sbi
= EXT4_SB(sb
);
400 if (likely(sbi
->s_mount_flags
& EXT4_MF_MNTDIR_SAMPLED
))
403 if (sb_rdonly(sb
) || !sb_start_intwrite_trylock(sb
))
406 sbi
->s_mount_flags
|= EXT4_MF_MNTDIR_SAMPLED
;
408 * Sample where the filesystem has been mounted and
409 * store it in the superblock for sysadmin convenience
410 * when trying to sort through large numbers of block
411 * devices or filesystem images.
413 memset(buf
, 0, sizeof(buf
));
415 path
.dentry
= mnt
->mnt_root
;
416 cp
= d_path(&path
, buf
, sizeof(buf
));
421 handle
= ext4_journal_start_sb(sb
, EXT4_HT_MISC
, 1);
422 err
= PTR_ERR(handle
);
425 BUFFER_TRACE(sbi
->s_sbh
, "get_write_access");
426 err
= ext4_journal_get_write_access(handle
, sbi
->s_sbh
);
429 strlcpy(sbi
->s_es
->s_last_mounted
, cp
,
430 sizeof(sbi
->s_es
->s_last_mounted
));
431 ext4_handle_dirty_super(handle
, sb
);
433 ext4_journal_stop(handle
);
439 static int ext4_file_open(struct inode
* inode
, struct file
* filp
)
443 if (unlikely(ext4_forced_shutdown(EXT4_SB(inode
->i_sb
))))
446 ret
= ext4_sample_last_mounted(inode
->i_sb
, filp
->f_path
.mnt
);
450 ret
= fscrypt_file_open(inode
, filp
);
455 * Set up the jbd2_inode if we are opening the inode for
456 * writing and the journal is present
458 if (filp
->f_mode
& FMODE_WRITE
) {
459 ret
= ext4_inode_attach_jinode(inode
);
464 filp
->f_mode
|= FMODE_NOWAIT
;
465 return dquot_file_open(inode
, filp
);
469 * ext4_llseek() handles both block-mapped and extent-mapped maxbytes values
470 * by calling generic_file_llseek_size() with the appropriate maxbytes
473 loff_t
ext4_llseek(struct file
*file
, loff_t offset
, int whence
)
475 struct inode
*inode
= file
->f_mapping
->host
;
478 if (!(ext4_test_inode_flag(inode
, EXT4_INODE_EXTENTS
)))
479 maxbytes
= EXT4_SB(inode
->i_sb
)->s_bitmap_maxbytes
;
481 maxbytes
= inode
->i_sb
->s_maxbytes
;
485 return generic_file_llseek_size(file
, offset
, whence
,
486 maxbytes
, i_size_read(inode
));
488 inode_lock_shared(inode
);
489 offset
= iomap_seek_hole(inode
, offset
, &ext4_iomap_ops
);
490 inode_unlock_shared(inode
);
493 inode_lock_shared(inode
);
494 offset
= iomap_seek_data(inode
, offset
, &ext4_iomap_ops
);
495 inode_unlock_shared(inode
);
501 return vfs_setpos(file
, offset
, maxbytes
);
504 const struct file_operations ext4_file_operations
= {
505 .llseek
= ext4_llseek
,
506 .read_iter
= ext4_file_read_iter
,
507 .write_iter
= ext4_file_write_iter
,
508 .unlocked_ioctl
= ext4_ioctl
,
510 .compat_ioctl
= ext4_compat_ioctl
,
512 .mmap
= ext4_file_mmap
,
513 .mmap_supported_flags
= MAP_SYNC
,
514 .open
= ext4_file_open
,
515 .release
= ext4_release_file
,
516 .fsync
= ext4_sync_file
,
517 .get_unmapped_area
= thp_get_unmapped_area
,
518 .splice_read
= generic_file_splice_read
,
519 .splice_write
= iter_file_splice_write
,
520 .fallocate
= ext4_fallocate
,
523 const struct inode_operations ext4_file_inode_operations
= {
524 .setattr
= ext4_setattr
,
525 .getattr
= ext4_file_getattr
,
526 .listxattr
= ext4_listxattr
,
527 .get_acl
= ext4_get_acl
,
528 .set_acl
= ext4_set_acl
,
529 .fiemap
= ext4_fiemap
,