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
);
97 int o_direct
= iocb
->ki_flags
& IOCB_DIRECT
;
98 int unaligned_aio
= 0;
103 ret
= generic_write_checks(iocb
, from
);
108 * Unaligned direct AIO must be serialized among each other as zeroing
109 * of partial blocks of two competing unaligned AIOs can result in data
112 if (o_direct
&& ext4_test_inode_flag(inode
, EXT4_INODE_EXTENTS
) &&
113 !is_sync_kiocb(iocb
) &&
114 ext4_unaligned_aio(inode
, from
, iocb
->ki_pos
)) {
116 ext4_unwritten_wait(inode
);
120 * If we have encountered a bitmap-format file, the size limit
121 * is smaller than s_maxbytes, which is for extent-mapped files.
123 if (!(ext4_test_inode_flag(inode
, EXT4_INODE_EXTENTS
))) {
124 struct ext4_sb_info
*sbi
= EXT4_SB(inode
->i_sb
);
126 if (iocb
->ki_pos
>= sbi
->s_bitmap_maxbytes
) {
130 iov_iter_truncate(from
, sbi
->s_bitmap_maxbytes
- iocb
->ki_pos
);
133 iocb
->private = &overwrite
;
135 size_t length
= iov_iter_count(from
);
136 loff_t pos
= iocb
->ki_pos
;
137 blk_start_plug(&plug
);
139 /* check whether we do a DIO overwrite or not */
140 if (ext4_should_dioread_nolock(inode
) && !unaligned_aio
&&
141 !file
->f_mapping
->nrpages
&& pos
+ length
<= i_size_read(inode
)) {
142 struct ext4_map_blocks map
;
143 unsigned int blkbits
= inode
->i_blkbits
;
146 map
.m_lblk
= pos
>> blkbits
;
147 map
.m_len
= (EXT4_BLOCK_ALIGN(pos
+ length
, blkbits
) >> blkbits
)
151 err
= ext4_map_blocks(NULL
, inode
, &map
, 0);
153 * 'err==len' means that all of blocks has
154 * been preallocated no matter they are
155 * initialized or not. For excluding
156 * unwritten extents, we need to check
157 * m_flags. There are two conditions that
158 * indicate for initialized extents. 1) If we
159 * hit extent cache, EXT4_MAP_MAPPED flag is
160 * returned; 2) If we do a real lookup,
161 * non-flags are returned. So we should check
162 * these two conditions.
164 if (err
== len
&& (map
.m_flags
& EXT4_MAP_MAPPED
))
169 ret
= __generic_file_write_iter(iocb
, from
);
175 err
= generic_write_sync(file
, iocb
->ki_pos
- ret
, ret
);
180 blk_finish_plug(&plug
);
190 static int ext4_dax_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
193 handle_t
*handle
= NULL
;
194 struct inode
*inode
= file_inode(vma
->vm_file
);
195 struct super_block
*sb
= inode
->i_sb
;
196 bool write
= vmf
->flags
& FAULT_FLAG_WRITE
;
199 sb_start_pagefault(sb
);
200 file_update_time(vma
->vm_file
);
201 down_read(&EXT4_I(inode
)->i_mmap_sem
);
202 handle
= ext4_journal_start_sb(sb
, EXT4_HT_WRITE_PAGE
,
203 EXT4_DATA_TRANS_BLOCKS(sb
));
205 down_read(&EXT4_I(inode
)->i_mmap_sem
);
208 result
= VM_FAULT_SIGBUS
;
210 result
= __dax_fault(vma
, vmf
, ext4_dax_mmap_get_block
, NULL
);
214 ext4_journal_stop(handle
);
215 up_read(&EXT4_I(inode
)->i_mmap_sem
);
216 sb_end_pagefault(sb
);
218 up_read(&EXT4_I(inode
)->i_mmap_sem
);
223 static int ext4_dax_pmd_fault(struct vm_area_struct
*vma
, unsigned long addr
,
224 pmd_t
*pmd
, unsigned int flags
)
227 handle_t
*handle
= NULL
;
228 struct inode
*inode
= file_inode(vma
->vm_file
);
229 struct super_block
*sb
= inode
->i_sb
;
230 bool write
= flags
& FAULT_FLAG_WRITE
;
233 sb_start_pagefault(sb
);
234 file_update_time(vma
->vm_file
);
235 down_read(&EXT4_I(inode
)->i_mmap_sem
);
236 handle
= ext4_journal_start_sb(sb
, EXT4_HT_WRITE_PAGE
,
237 ext4_chunk_trans_blocks(inode
,
238 PMD_SIZE
/ PAGE_SIZE
));
240 down_read(&EXT4_I(inode
)->i_mmap_sem
);
243 result
= VM_FAULT_SIGBUS
;
245 result
= __dax_pmd_fault(vma
, addr
, pmd
, flags
,
246 ext4_dax_mmap_get_block
, NULL
);
250 ext4_journal_stop(handle
);
251 up_read(&EXT4_I(inode
)->i_mmap_sem
);
252 sb_end_pagefault(sb
);
254 up_read(&EXT4_I(inode
)->i_mmap_sem
);
260 * Handle write fault for VM_MIXEDMAP mappings. Similarly to ext4_dax_fault()
261 * handler we check for races agaist truncate. Note that since we cycle through
262 * i_mmap_sem, we are sure that also any hole punching that began before we
263 * were called is finished by now and so if it included part of the file we
264 * are working on, our pte will get unmapped and the check for pte_same() in
265 * wp_pfn_shared() fails. Thus fault gets retried and things work out as
268 static int ext4_dax_pfn_mkwrite(struct vm_area_struct
*vma
,
269 struct vm_fault
*vmf
)
271 struct inode
*inode
= file_inode(vma
->vm_file
);
272 struct super_block
*sb
= inode
->i_sb
;
276 sb_start_pagefault(sb
);
277 file_update_time(vma
->vm_file
);
278 down_read(&EXT4_I(inode
)->i_mmap_sem
);
279 size
= (i_size_read(inode
) + PAGE_SIZE
- 1) >> PAGE_SHIFT
;
280 if (vmf
->pgoff
>= size
)
281 ret
= VM_FAULT_SIGBUS
;
283 ret
= dax_pfn_mkwrite(vma
, vmf
);
284 up_read(&EXT4_I(inode
)->i_mmap_sem
);
285 sb_end_pagefault(sb
);
290 static const struct vm_operations_struct ext4_dax_vm_ops
= {
291 .fault
= ext4_dax_fault
,
292 .pmd_fault
= ext4_dax_pmd_fault
,
293 .page_mkwrite
= ext4_dax_fault
,
294 .pfn_mkwrite
= ext4_dax_pfn_mkwrite
,
297 #define ext4_dax_vm_ops ext4_file_vm_ops
300 static const struct vm_operations_struct ext4_file_vm_ops
= {
301 .fault
= ext4_filemap_fault
,
302 .map_pages
= filemap_map_pages
,
303 .page_mkwrite
= ext4_page_mkwrite
,
306 static int ext4_file_mmap(struct file
*file
, struct vm_area_struct
*vma
)
308 struct inode
*inode
= file
->f_mapping
->host
;
310 if (ext4_encrypted_inode(inode
)) {
311 int err
= ext4_get_encryption_info(inode
);
314 if (ext4_encryption_info(inode
) == NULL
)
318 if (IS_DAX(file_inode(file
))) {
319 vma
->vm_ops
= &ext4_dax_vm_ops
;
320 vma
->vm_flags
|= VM_MIXEDMAP
| VM_HUGEPAGE
;
322 vma
->vm_ops
= &ext4_file_vm_ops
;
327 static int ext4_file_open(struct inode
* inode
, struct file
* filp
)
329 struct super_block
*sb
= inode
->i_sb
;
330 struct ext4_sb_info
*sbi
= EXT4_SB(inode
->i_sb
);
331 struct vfsmount
*mnt
= filp
->f_path
.mnt
;
337 if (unlikely(!(sbi
->s_mount_flags
& EXT4_MF_MNTDIR_SAMPLED
) &&
338 !(sb
->s_flags
& MS_RDONLY
))) {
339 sbi
->s_mount_flags
|= EXT4_MF_MNTDIR_SAMPLED
;
341 * Sample where the filesystem has been mounted and
342 * store it in the superblock for sysadmin convenience
343 * when trying to sort through large numbers of block
344 * devices or filesystem images.
346 memset(buf
, 0, sizeof(buf
));
348 path
.dentry
= mnt
->mnt_root
;
349 cp
= d_path(&path
, buf
, sizeof(buf
));
354 handle
= ext4_journal_start_sb(sb
, EXT4_HT_MISC
, 1);
356 return PTR_ERR(handle
);
357 BUFFER_TRACE(sbi
->s_sbh
, "get_write_access");
358 err
= ext4_journal_get_write_access(handle
, sbi
->s_sbh
);
360 ext4_journal_stop(handle
);
363 strlcpy(sbi
->s_es
->s_last_mounted
, cp
,
364 sizeof(sbi
->s_es
->s_last_mounted
));
365 ext4_handle_dirty_super(handle
, sb
);
366 ext4_journal_stop(handle
);
369 if (ext4_encrypted_inode(inode
)) {
370 ret
= ext4_get_encryption_info(inode
);
373 if (ext4_encryption_info(inode
) == NULL
)
377 dir
= dget_parent(file_dentry(filp
));
378 if (ext4_encrypted_inode(d_inode(dir
)) &&
379 !ext4_is_child_context_consistent_with_parent(d_inode(dir
), inode
)) {
380 ext4_warning(inode
->i_sb
,
381 "Inconsistent encryption contexts: %lu/%lu\n",
382 (unsigned long) d_inode(dir
)->i_ino
,
383 (unsigned long) inode
->i_ino
);
389 * Set up the jbd2_inode if we are opening the inode for
390 * writing and the journal is present
392 if (filp
->f_mode
& FMODE_WRITE
) {
393 ret
= ext4_inode_attach_jinode(inode
);
397 return dquot_file_open(inode
, filp
);
401 * Here we use ext4_map_blocks() to get a block mapping for a extent-based
402 * file rather than ext4_ext_walk_space() because we can introduce
403 * SEEK_DATA/SEEK_HOLE for block-mapped and extent-mapped file at the same
404 * function. When extent status tree has been fully implemented, it will
405 * track all extent status for a file and we can directly use it to
406 * retrieve the offset for SEEK_DATA/SEEK_HOLE.
410 * When we retrieve the offset for SEEK_DATA/SEEK_HOLE, we would need to
411 * lookup page cache to check whether or not there has some data between
412 * [startoff, endoff] because, if this range contains an unwritten extent,
413 * we determine this extent as a data or a hole according to whether the
414 * page cache has data or not.
416 static int ext4_find_unwritten_pgoff(struct inode
*inode
,
422 unsigned int blkbits
;
430 blkbits
= inode
->i_sb
->s_blocksize_bits
;
433 endoff
= (loff_t
)end_blk
<< blkbits
;
435 index
= startoff
>> PAGE_SHIFT
;
436 end
= endoff
>> PAGE_SHIFT
;
438 pagevec_init(&pvec
, 0);
441 unsigned long nr_pages
;
443 num
= min_t(pgoff_t
, end
- index
, PAGEVEC_SIZE
);
444 nr_pages
= pagevec_lookup(&pvec
, inode
->i_mapping
, index
,
447 if (whence
== SEEK_DATA
)
450 BUG_ON(whence
!= SEEK_HOLE
);
452 * If this is the first time to go into the loop and
453 * offset is not beyond the end offset, it will be a
454 * hole at this offset
456 if (lastoff
== startoff
|| lastoff
< endoff
)
462 * If this is the first time to go into the loop and
463 * offset is smaller than the first page offset, it will be a
464 * hole at this offset.
466 if (lastoff
== startoff
&& whence
== SEEK_HOLE
&&
467 lastoff
< page_offset(pvec
.pages
[0])) {
472 for (i
= 0; i
< nr_pages
; i
++) {
473 struct page
*page
= pvec
.pages
[i
];
474 struct buffer_head
*bh
, *head
;
477 * If the current offset is not beyond the end of given
478 * range, it will be a hole.
480 if (lastoff
< endoff
&& whence
== SEEK_HOLE
&&
489 if (unlikely(page
->mapping
!= inode
->i_mapping
)) {
494 if (!page_has_buffers(page
)) {
499 if (page_has_buffers(page
)) {
500 lastoff
= page_offset(page
);
501 bh
= head
= page_buffers(page
);
503 if (buffer_uptodate(bh
) ||
504 buffer_unwritten(bh
)) {
505 if (whence
== SEEK_DATA
)
508 if (whence
== SEEK_HOLE
)
512 *offset
= max_t(loff_t
,
517 lastoff
+= bh
->b_size
;
518 bh
= bh
->b_this_page
;
519 } while (bh
!= head
);
522 lastoff
= page_offset(page
) + PAGE_SIZE
;
527 * The no. of pages is less than our desired, that would be a
530 if (nr_pages
< num
&& whence
== SEEK_HOLE
) {
536 index
= pvec
.pages
[i
- 1]->index
+ 1;
537 pagevec_release(&pvec
);
538 } while (index
<= end
);
541 pagevec_release(&pvec
);
546 * ext4_seek_data() retrieves the offset for SEEK_DATA.
548 static loff_t
ext4_seek_data(struct file
*file
, loff_t offset
, loff_t maxsize
)
550 struct inode
*inode
= file
->f_mapping
->host
;
551 struct extent_status es
;
552 ext4_lblk_t start
, last
, end
;
553 loff_t dataoff
, isize
;
559 isize
= i_size_read(inode
);
560 if (offset
>= isize
) {
565 blkbits
= inode
->i_sb
->s_blocksize_bits
;
566 start
= offset
>> blkbits
;
568 end
= isize
>> blkbits
;
572 ret
= ext4_get_next_extent(inode
, last
, end
- last
+ 1, &es
);
574 /* No extent found -> no data */
583 dataoff
= (loff_t
)last
<< blkbits
;
584 if (!ext4_es_is_unwritten(&es
))
588 * If there is a unwritten extent at this offset,
589 * it will be as a data or a hole according to page
590 * cache that has data or not.
592 if (ext4_find_unwritten_pgoff(inode
, SEEK_DATA
,
593 es
.es_lblk
+ es
.es_len
, &dataoff
))
596 dataoff
= (loff_t
)last
<< blkbits
;
598 } while (last
<= end
);
605 return vfs_setpos(file
, dataoff
, maxsize
);
609 * ext4_seek_hole() retrieves the offset for SEEK_HOLE.
611 static loff_t
ext4_seek_hole(struct file
*file
, loff_t offset
, loff_t maxsize
)
613 struct inode
*inode
= file
->f_mapping
->host
;
614 struct extent_status es
;
615 ext4_lblk_t start
, last
, end
;
616 loff_t holeoff
, isize
;
622 isize
= i_size_read(inode
);
623 if (offset
>= isize
) {
628 blkbits
= inode
->i_sb
->s_blocksize_bits
;
629 start
= offset
>> blkbits
;
631 end
= isize
>> blkbits
;
635 ret
= ext4_get_next_extent(inode
, last
, end
- last
+ 1, &es
);
641 if (ret
== 0 || es
.es_lblk
> last
) {
643 holeoff
= (loff_t
)last
<< blkbits
;
647 * If there is a unwritten extent at this offset,
648 * it will be as a data or a hole according to page
649 * cache that has data or not.
651 if (ext4_es_is_unwritten(&es
) &&
652 ext4_find_unwritten_pgoff(inode
, SEEK_HOLE
,
653 last
+ es
.es_len
, &holeoff
))
657 holeoff
= (loff_t
)last
<< blkbits
;
659 } while (last
<= end
);
666 return vfs_setpos(file
, holeoff
, maxsize
);
670 * ext4_llseek() handles both block-mapped and extent-mapped maxbytes values
671 * by calling generic_file_llseek_size() with the appropriate maxbytes
674 loff_t
ext4_llseek(struct file
*file
, loff_t offset
, int whence
)
676 struct inode
*inode
= file
->f_mapping
->host
;
679 if (!(ext4_test_inode_flag(inode
, EXT4_INODE_EXTENTS
)))
680 maxbytes
= EXT4_SB(inode
->i_sb
)->s_bitmap_maxbytes
;
682 maxbytes
= inode
->i_sb
->s_maxbytes
;
688 return generic_file_llseek_size(file
, offset
, whence
,
689 maxbytes
, i_size_read(inode
));
691 return ext4_seek_data(file
, offset
, maxbytes
);
693 return ext4_seek_hole(file
, offset
, maxbytes
);
699 const struct file_operations ext4_file_operations
= {
700 .llseek
= ext4_llseek
,
701 .read_iter
= generic_file_read_iter
,
702 .write_iter
= ext4_file_write_iter
,
703 .unlocked_ioctl
= ext4_ioctl
,
705 .compat_ioctl
= ext4_compat_ioctl
,
707 .mmap
= ext4_file_mmap
,
708 .open
= ext4_file_open
,
709 .release
= ext4_release_file
,
710 .fsync
= ext4_sync_file
,
711 .splice_read
= generic_file_splice_read
,
712 .splice_write
= iter_file_splice_write
,
713 .fallocate
= ext4_fallocate
,
716 const struct inode_operations ext4_file_inode_operations
= {
717 .setattr
= ext4_setattr
,
718 .getattr
= ext4_getattr
,
719 .setxattr
= generic_setxattr
,
720 .getxattr
= generic_getxattr
,
721 .listxattr
= ext4_listxattr
,
722 .removexattr
= generic_removexattr
,
723 .get_acl
= ext4_get_acl
,
724 .set_acl
= ext4_set_acl
,
725 .fiemap
= ext4_fiemap
,