4 * Copyright (C) 1992, 1993, 1994, 1995
5 * Remy Card (card@masi.ibp.fr)
6 * Laboratoire MASI - Institut Blaise Pascal
7 * Universite Pierre et Marie Curie (Paris VI)
11 * linux/fs/minix/file.c
13 * Copyright (C) 1991, 1992 Linus Torvalds
15 * ext4 fs regular file handling primitives
17 * 64-bit file support on 64-bit platforms by Jakub Jelinek
18 * (jj@sunsite.ms.mff.cuni.cz)
21 #include <linux/time.h>
23 #include <linux/mount.h>
24 #include <linux/path.h>
25 #include <linux/dax.h>
26 #include <linux/quotaops.h>
27 #include <linux/pagevec.h>
28 #include <linux/uio.h>
30 #include "ext4_jbd2.h"
35 * Called when an inode is released. Note that this is different
36 * from ext4_file_open: open gets called at every open, but release
37 * gets called only when /all/ the files are closed.
39 static int ext4_release_file(struct inode
*inode
, struct file
*filp
)
41 if (ext4_test_inode_state(inode
, EXT4_STATE_DA_ALLOC_CLOSE
)) {
42 ext4_alloc_da_blocks(inode
);
43 ext4_clear_inode_state(inode
, EXT4_STATE_DA_ALLOC_CLOSE
);
45 /* if we are the last writer on the inode, drop the block reservation */
46 if ((filp
->f_mode
& FMODE_WRITE
) &&
47 (atomic_read(&inode
->i_writecount
) == 1) &&
48 !EXT4_I(inode
)->i_reserved_data_blocks
)
50 down_write(&EXT4_I(inode
)->i_data_sem
);
51 ext4_discard_preallocations(inode
);
52 up_write(&EXT4_I(inode
)->i_data_sem
);
54 if (is_dx(inode
) && filp
->private_data
)
55 ext4_htree_free_dir_info(filp
->private_data
);
60 static void ext4_unwritten_wait(struct inode
*inode
)
62 wait_queue_head_t
*wq
= ext4_ioend_wq(inode
);
64 wait_event(*wq
, (atomic_read(&EXT4_I(inode
)->i_unwritten
) == 0));
68 * This tests whether the IO in question is block-aligned or not.
69 * Ext4 utilizes unwritten extents when hole-filling during direct IO, and they
70 * are converted to written only after the IO is complete. Until they are
71 * mapped, these blocks appear as holes, so dio_zero_block() will assume that
72 * it needs to zero out portions of the start and/or end block. If 2 AIO
73 * threads are at work on the same unwritten block, they must be synchronized
74 * or one thread will zero the other's data, causing corruption.
77 ext4_unaligned_aio(struct inode
*inode
, struct iov_iter
*from
, loff_t pos
)
79 struct super_block
*sb
= inode
->i_sb
;
80 int blockmask
= sb
->s_blocksize
- 1;
82 if (pos
>= i_size_read(inode
))
85 if ((pos
| iov_iter_alignment(from
)) & blockmask
)
92 ext4_file_write_iter(struct kiocb
*iocb
, struct iov_iter
*from
)
94 struct file
*file
= iocb
->ki_filp
;
95 struct inode
*inode
= file_inode(iocb
->ki_filp
);
96 struct mutex
*aio_mutex
= NULL
;
98 int o_direct
= iocb
->ki_flags
& IOCB_DIRECT
;
103 * Unaligned direct AIO must be serialized; see comment above
104 * In the case of O_APPEND, assume that we must always serialize
107 ext4_test_inode_flag(inode
, EXT4_INODE_EXTENTS
) &&
108 !is_sync_kiocb(iocb
) &&
109 (iocb
->ki_flags
& IOCB_APPEND
||
110 ext4_unaligned_aio(inode
, from
, iocb
->ki_pos
))) {
111 aio_mutex
= ext4_aio_mutex(inode
);
112 mutex_lock(aio_mutex
);
113 ext4_unwritten_wait(inode
);
116 mutex_lock(&inode
->i_mutex
);
117 ret
= generic_write_checks(iocb
, from
);
122 * If we have encountered a bitmap-format file, the size limit
123 * is smaller than s_maxbytes, which is for extent-mapped files.
125 if (!(ext4_test_inode_flag(inode
, EXT4_INODE_EXTENTS
))) {
126 struct ext4_sb_info
*sbi
= EXT4_SB(inode
->i_sb
);
128 if (iocb
->ki_pos
>= sbi
->s_bitmap_maxbytes
) {
132 iov_iter_truncate(from
, sbi
->s_bitmap_maxbytes
- iocb
->ki_pos
);
135 iocb
->private = &overwrite
;
137 size_t length
= iov_iter_count(from
);
138 loff_t pos
= iocb
->ki_pos
;
139 blk_start_plug(&plug
);
141 /* check whether we do a DIO overwrite or not */
142 if (ext4_should_dioread_nolock(inode
) && !aio_mutex
&&
143 !file
->f_mapping
->nrpages
&& pos
+ length
<= i_size_read(inode
)) {
144 struct ext4_map_blocks map
;
145 unsigned int blkbits
= inode
->i_blkbits
;
148 map
.m_lblk
= pos
>> blkbits
;
149 map
.m_len
= (EXT4_BLOCK_ALIGN(pos
+ length
, blkbits
) >> blkbits
)
153 err
= ext4_map_blocks(NULL
, inode
, &map
, 0);
155 * 'err==len' means that all of blocks has
156 * been preallocated no matter they are
157 * initialized or not. For excluding
158 * unwritten extents, we need to check
159 * m_flags. There are two conditions that
160 * indicate for initialized extents. 1) If we
161 * hit extent cache, EXT4_MAP_MAPPED flag is
162 * returned; 2) If we do a real lookup,
163 * non-flags are returned. So we should check
164 * these two conditions.
166 if (err
== len
&& (map
.m_flags
& EXT4_MAP_MAPPED
))
171 ret
= __generic_file_write_iter(iocb
, from
);
172 mutex_unlock(&inode
->i_mutex
);
177 err
= generic_write_sync(file
, iocb
->ki_pos
- ret
, ret
);
182 blk_finish_plug(&plug
);
185 mutex_unlock(aio_mutex
);
189 mutex_unlock(&inode
->i_mutex
);
191 mutex_unlock(aio_mutex
);
196 static void ext4_end_io_unwritten(struct buffer_head
*bh
, int uptodate
)
198 struct inode
*inode
= bh
->b_assoc_map
->host
;
199 /* XXX: breaks on 32-bit > 16TB. Is that even supported? */
200 loff_t offset
= (loff_t
)(uintptr_t)bh
->b_private
<< inode
->i_blkbits
;
204 WARN_ON(!buffer_unwritten(bh
));
205 err
= ext4_convert_unwritten_extents(NULL
, inode
, offset
, bh
->b_size
);
208 static int ext4_dax_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
211 handle_t
*handle
= NULL
;
212 struct super_block
*sb
= file_inode(vma
->vm_file
)->i_sb
;
213 bool write
= vmf
->flags
& FAULT_FLAG_WRITE
;
216 sb_start_pagefault(sb
);
217 file_update_time(vma
->vm_file
);
218 handle
= ext4_journal_start_sb(sb
, EXT4_HT_WRITE_PAGE
,
219 EXT4_DATA_TRANS_BLOCKS(sb
));
223 result
= VM_FAULT_SIGBUS
;
225 result
= __dax_fault(vma
, vmf
, ext4_get_block_dax
,
226 ext4_end_io_unwritten
);
230 ext4_journal_stop(handle
);
231 sb_end_pagefault(sb
);
237 static int ext4_dax_pmd_fault(struct vm_area_struct
*vma
, unsigned long addr
,
238 pmd_t
*pmd
, unsigned int flags
)
241 handle_t
*handle
= NULL
;
242 struct inode
*inode
= file_inode(vma
->vm_file
);
243 struct super_block
*sb
= inode
->i_sb
;
244 bool write
= flags
& FAULT_FLAG_WRITE
;
247 sb_start_pagefault(sb
);
248 file_update_time(vma
->vm_file
);
249 handle
= ext4_journal_start_sb(sb
, EXT4_HT_WRITE_PAGE
,
250 ext4_chunk_trans_blocks(inode
,
251 PMD_SIZE
/ PAGE_SIZE
));
255 result
= VM_FAULT_SIGBUS
;
257 result
= __dax_pmd_fault(vma
, addr
, pmd
, flags
,
258 ext4_get_block_dax
, ext4_end_io_unwritten
);
262 ext4_journal_stop(handle
);
263 sb_end_pagefault(sb
);
269 static int ext4_dax_mkwrite(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
271 return dax_mkwrite(vma
, vmf
, ext4_get_block_dax
,
272 ext4_end_io_unwritten
);
275 static const struct vm_operations_struct ext4_dax_vm_ops
= {
276 .fault
= ext4_dax_fault
,
277 .pmd_fault
= ext4_dax_pmd_fault
,
278 .page_mkwrite
= ext4_dax_mkwrite
,
279 .pfn_mkwrite
= dax_pfn_mkwrite
,
282 #define ext4_dax_vm_ops ext4_file_vm_ops
285 static const struct vm_operations_struct ext4_file_vm_ops
= {
286 .fault
= filemap_fault
,
287 .map_pages
= filemap_map_pages
,
288 .page_mkwrite
= ext4_page_mkwrite
,
291 static int ext4_file_mmap(struct file
*file
, struct vm_area_struct
*vma
)
293 struct inode
*inode
= file
->f_mapping
->host
;
295 if (ext4_encrypted_inode(inode
)) {
296 int err
= ext4_get_encryption_info(inode
);
299 if (ext4_encryption_info(inode
) == NULL
)
303 if (IS_DAX(file_inode(file
))) {
304 vma
->vm_ops
= &ext4_dax_vm_ops
;
305 vma
->vm_flags
|= VM_MIXEDMAP
| VM_HUGEPAGE
;
307 vma
->vm_ops
= &ext4_file_vm_ops
;
312 static int ext4_file_open(struct inode
* inode
, struct file
* filp
)
314 struct super_block
*sb
= inode
->i_sb
;
315 struct ext4_sb_info
*sbi
= EXT4_SB(inode
->i_sb
);
316 struct vfsmount
*mnt
= filp
->f_path
.mnt
;
321 if (unlikely(!(sbi
->s_mount_flags
& EXT4_MF_MNTDIR_SAMPLED
) &&
322 !(sb
->s_flags
& MS_RDONLY
))) {
323 sbi
->s_mount_flags
|= EXT4_MF_MNTDIR_SAMPLED
;
325 * Sample where the filesystem has been mounted and
326 * store it in the superblock for sysadmin convenience
327 * when trying to sort through large numbers of block
328 * devices or filesystem images.
330 memset(buf
, 0, sizeof(buf
));
332 path
.dentry
= mnt
->mnt_root
;
333 cp
= d_path(&path
, buf
, sizeof(buf
));
338 handle
= ext4_journal_start_sb(sb
, EXT4_HT_MISC
, 1);
340 return PTR_ERR(handle
);
341 BUFFER_TRACE(sbi
->s_sbh
, "get_write_access");
342 err
= ext4_journal_get_write_access(handle
, sbi
->s_sbh
);
344 ext4_journal_stop(handle
);
347 strlcpy(sbi
->s_es
->s_last_mounted
, cp
,
348 sizeof(sbi
->s_es
->s_last_mounted
));
349 ext4_handle_dirty_super(handle
, sb
);
350 ext4_journal_stop(handle
);
353 if (ext4_encrypted_inode(inode
)) {
354 ret
= ext4_get_encryption_info(inode
);
357 if (ext4_encryption_info(inode
) == NULL
)
361 * Set up the jbd2_inode if we are opening the inode for
362 * writing and the journal is present
364 if (filp
->f_mode
& FMODE_WRITE
) {
365 ret
= ext4_inode_attach_jinode(inode
);
369 return dquot_file_open(inode
, filp
);
373 * Here we use ext4_map_blocks() to get a block mapping for a extent-based
374 * file rather than ext4_ext_walk_space() because we can introduce
375 * SEEK_DATA/SEEK_HOLE for block-mapped and extent-mapped file at the same
376 * function. When extent status tree has been fully implemented, it will
377 * track all extent status for a file and we can directly use it to
378 * retrieve the offset for SEEK_DATA/SEEK_HOLE.
382 * When we retrieve the offset for SEEK_DATA/SEEK_HOLE, we would need to
383 * lookup page cache to check whether or not there has some data between
384 * [startoff, endoff] because, if this range contains an unwritten extent,
385 * we determine this extent as a data or a hole according to whether the
386 * page cache has data or not.
388 static int ext4_find_unwritten_pgoff(struct inode
*inode
,
390 struct ext4_map_blocks
*map
,
394 unsigned int blkbits
;
402 blkbits
= inode
->i_sb
->s_blocksize_bits
;
405 endoff
= (loff_t
)(map
->m_lblk
+ map
->m_len
) << blkbits
;
407 index
= startoff
>> PAGE_CACHE_SHIFT
;
408 end
= endoff
>> PAGE_CACHE_SHIFT
;
410 pagevec_init(&pvec
, 0);
413 unsigned long nr_pages
;
415 num
= min_t(pgoff_t
, end
- index
, PAGEVEC_SIZE
);
416 nr_pages
= pagevec_lookup(&pvec
, inode
->i_mapping
, index
,
419 if (whence
== SEEK_DATA
)
422 BUG_ON(whence
!= SEEK_HOLE
);
424 * If this is the first time to go into the loop and
425 * offset is not beyond the end offset, it will be a
426 * hole at this offset
428 if (lastoff
== startoff
|| lastoff
< endoff
)
434 * If this is the first time to go into the loop and
435 * offset is smaller than the first page offset, it will be a
436 * hole at this offset.
438 if (lastoff
== startoff
&& whence
== SEEK_HOLE
&&
439 lastoff
< page_offset(pvec
.pages
[0])) {
444 for (i
= 0; i
< nr_pages
; i
++) {
445 struct page
*page
= pvec
.pages
[i
];
446 struct buffer_head
*bh
, *head
;
449 * If the current offset is not beyond the end of given
450 * range, it will be a hole.
452 if (lastoff
< endoff
&& whence
== SEEK_HOLE
&&
461 if (unlikely(page
->mapping
!= inode
->i_mapping
)) {
466 if (!page_has_buffers(page
)) {
471 if (page_has_buffers(page
)) {
472 lastoff
= page_offset(page
);
473 bh
= head
= page_buffers(page
);
475 if (buffer_uptodate(bh
) ||
476 buffer_unwritten(bh
)) {
477 if (whence
== SEEK_DATA
)
480 if (whence
== SEEK_HOLE
)
484 *offset
= max_t(loff_t
,
489 lastoff
+= bh
->b_size
;
490 bh
= bh
->b_this_page
;
491 } while (bh
!= head
);
494 lastoff
= page_offset(page
) + PAGE_SIZE
;
499 * The no. of pages is less than our desired, that would be a
502 if (nr_pages
< num
&& whence
== SEEK_HOLE
) {
508 index
= pvec
.pages
[i
- 1]->index
+ 1;
509 pagevec_release(&pvec
);
510 } while (index
<= end
);
513 pagevec_release(&pvec
);
518 * ext4_seek_data() retrieves the offset for SEEK_DATA.
520 static loff_t
ext4_seek_data(struct file
*file
, loff_t offset
, loff_t maxsize
)
522 struct inode
*inode
= file
->f_mapping
->host
;
523 struct ext4_map_blocks map
;
524 struct extent_status es
;
525 ext4_lblk_t start
, last
, end
;
526 loff_t dataoff
, isize
;
530 mutex_lock(&inode
->i_mutex
);
532 isize
= i_size_read(inode
);
533 if (offset
>= isize
) {
534 mutex_unlock(&inode
->i_mutex
);
538 blkbits
= inode
->i_sb
->s_blocksize_bits
;
539 start
= offset
>> blkbits
;
541 end
= isize
>> blkbits
;
546 map
.m_len
= end
- last
+ 1;
547 ret
= ext4_map_blocks(NULL
, inode
, &map
, 0);
548 if (ret
> 0 && !(map
.m_flags
& EXT4_MAP_UNWRITTEN
)) {
550 dataoff
= (loff_t
)last
<< blkbits
;
555 * If there is a delay extent at this offset,
556 * it will be as a data.
558 ext4_es_find_delayed_extent_range(inode
, last
, last
, &es
);
559 if (es
.es_len
!= 0 && in_range(last
, es
.es_lblk
, es
.es_len
)) {
561 dataoff
= (loff_t
)last
<< blkbits
;
566 * If there is a unwritten extent at this offset,
567 * it will be as a data or a hole according to page
568 * cache that has data or not.
570 if (map
.m_flags
& EXT4_MAP_UNWRITTEN
) {
572 unwritten
= ext4_find_unwritten_pgoff(inode
, SEEK_DATA
,
579 dataoff
= (loff_t
)last
<< blkbits
;
580 } while (last
<= end
);
582 mutex_unlock(&inode
->i_mutex
);
587 return vfs_setpos(file
, dataoff
, maxsize
);
591 * ext4_seek_hole() retrieves the offset for SEEK_HOLE.
593 static loff_t
ext4_seek_hole(struct file
*file
, loff_t offset
, loff_t maxsize
)
595 struct inode
*inode
= file
->f_mapping
->host
;
596 struct ext4_map_blocks map
;
597 struct extent_status es
;
598 ext4_lblk_t start
, last
, end
;
599 loff_t holeoff
, isize
;
603 mutex_lock(&inode
->i_mutex
);
605 isize
= i_size_read(inode
);
606 if (offset
>= isize
) {
607 mutex_unlock(&inode
->i_mutex
);
611 blkbits
= inode
->i_sb
->s_blocksize_bits
;
612 start
= offset
>> blkbits
;
614 end
= isize
>> blkbits
;
619 map
.m_len
= end
- last
+ 1;
620 ret
= ext4_map_blocks(NULL
, inode
, &map
, 0);
621 if (ret
> 0 && !(map
.m_flags
& EXT4_MAP_UNWRITTEN
)) {
623 holeoff
= (loff_t
)last
<< blkbits
;
628 * If there is a delay extent at this offset,
629 * we will skip this extent.
631 ext4_es_find_delayed_extent_range(inode
, last
, last
, &es
);
632 if (es
.es_len
!= 0 && in_range(last
, es
.es_lblk
, es
.es_len
)) {
633 last
= es
.es_lblk
+ es
.es_len
;
634 holeoff
= (loff_t
)last
<< blkbits
;
639 * If there is a unwritten extent at this offset,
640 * it will be as a data or a hole according to page
641 * cache that has data or not.
643 if (map
.m_flags
& EXT4_MAP_UNWRITTEN
) {
645 unwritten
= ext4_find_unwritten_pgoff(inode
, SEEK_HOLE
,
649 holeoff
= (loff_t
)last
<< blkbits
;
656 } while (last
<= end
);
658 mutex_unlock(&inode
->i_mutex
);
663 return vfs_setpos(file
, holeoff
, maxsize
);
667 * ext4_llseek() handles both block-mapped and extent-mapped maxbytes values
668 * by calling generic_file_llseek_size() with the appropriate maxbytes
671 loff_t
ext4_llseek(struct file
*file
, loff_t offset
, int whence
)
673 struct inode
*inode
= file
->f_mapping
->host
;
676 if (!(ext4_test_inode_flag(inode
, EXT4_INODE_EXTENTS
)))
677 maxbytes
= EXT4_SB(inode
->i_sb
)->s_bitmap_maxbytes
;
679 maxbytes
= inode
->i_sb
->s_maxbytes
;
685 return generic_file_llseek_size(file
, offset
, whence
,
686 maxbytes
, i_size_read(inode
));
688 return ext4_seek_data(file
, offset
, maxbytes
);
690 return ext4_seek_hole(file
, offset
, maxbytes
);
696 const struct file_operations ext4_file_operations
= {
697 .llseek
= ext4_llseek
,
698 .read_iter
= generic_file_read_iter
,
699 .write_iter
= ext4_file_write_iter
,
700 .unlocked_ioctl
= ext4_ioctl
,
702 .compat_ioctl
= ext4_compat_ioctl
,
704 .mmap
= ext4_file_mmap
,
705 .open
= ext4_file_open
,
706 .release
= ext4_release_file
,
707 .fsync
= ext4_sync_file
,
708 .splice_read
= generic_file_splice_read
,
709 .splice_write
= iter_file_splice_write
,
710 .fallocate
= ext4_fallocate
,
713 const struct inode_operations ext4_file_inode_operations
= {
714 .setattr
= ext4_setattr
,
715 .getattr
= ext4_getattr
,
716 .setxattr
= generic_setxattr
,
717 .getxattr
= generic_getxattr
,
718 .listxattr
= ext4_listxattr
,
719 .removexattr
= generic_removexattr
,
720 .get_acl
= ext4_get_acl
,
721 .set_acl
= ext4_set_acl
,
722 .fiemap
= ext4_fiemap
,