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
);
173 ret
= generic_write_sync(iocb
, ret
);
175 blk_finish_plug(&plug
);
185 static int ext4_dax_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
188 handle_t
*handle
= NULL
;
189 struct inode
*inode
= file_inode(vma
->vm_file
);
190 struct super_block
*sb
= inode
->i_sb
;
191 bool write
= vmf
->flags
& FAULT_FLAG_WRITE
;
194 sb_start_pagefault(sb
);
195 file_update_time(vma
->vm_file
);
196 down_read(&EXT4_I(inode
)->i_mmap_sem
);
197 handle
= ext4_journal_start_sb(sb
, EXT4_HT_WRITE_PAGE
,
198 EXT4_DATA_TRANS_BLOCKS(sb
));
200 down_read(&EXT4_I(inode
)->i_mmap_sem
);
203 result
= VM_FAULT_SIGBUS
;
205 result
= dax_fault(vma
, vmf
, ext4_dax_get_block
);
209 ext4_journal_stop(handle
);
210 up_read(&EXT4_I(inode
)->i_mmap_sem
);
211 sb_end_pagefault(sb
);
213 up_read(&EXT4_I(inode
)->i_mmap_sem
);
218 static int ext4_dax_pmd_fault(struct vm_area_struct
*vma
, unsigned long addr
,
219 pmd_t
*pmd
, unsigned int flags
)
222 handle_t
*handle
= NULL
;
223 struct inode
*inode
= file_inode(vma
->vm_file
);
224 struct super_block
*sb
= inode
->i_sb
;
225 bool write
= flags
& FAULT_FLAG_WRITE
;
228 sb_start_pagefault(sb
);
229 file_update_time(vma
->vm_file
);
230 down_read(&EXT4_I(inode
)->i_mmap_sem
);
231 handle
= ext4_journal_start_sb(sb
, EXT4_HT_WRITE_PAGE
,
232 ext4_chunk_trans_blocks(inode
,
233 PMD_SIZE
/ PAGE_SIZE
));
235 down_read(&EXT4_I(inode
)->i_mmap_sem
);
238 result
= VM_FAULT_SIGBUS
;
240 result
= dax_pmd_fault(vma
, addr
, pmd
, flags
,
245 ext4_journal_stop(handle
);
246 up_read(&EXT4_I(inode
)->i_mmap_sem
);
247 sb_end_pagefault(sb
);
249 up_read(&EXT4_I(inode
)->i_mmap_sem
);
255 * Handle write fault for VM_MIXEDMAP mappings. Similarly to ext4_dax_fault()
256 * handler we check for races agaist truncate. Note that since we cycle through
257 * i_mmap_sem, we are sure that also any hole punching that began before we
258 * were called is finished by now and so if it included part of the file we
259 * are working on, our pte will get unmapped and the check for pte_same() in
260 * wp_pfn_shared() fails. Thus fault gets retried and things work out as
263 static int ext4_dax_pfn_mkwrite(struct vm_area_struct
*vma
,
264 struct vm_fault
*vmf
)
266 struct inode
*inode
= file_inode(vma
->vm_file
);
267 struct super_block
*sb
= inode
->i_sb
;
271 sb_start_pagefault(sb
);
272 file_update_time(vma
->vm_file
);
273 down_read(&EXT4_I(inode
)->i_mmap_sem
);
274 size
= (i_size_read(inode
) + PAGE_SIZE
- 1) >> PAGE_SHIFT
;
275 if (vmf
->pgoff
>= size
)
276 ret
= VM_FAULT_SIGBUS
;
278 ret
= dax_pfn_mkwrite(vma
, vmf
);
279 up_read(&EXT4_I(inode
)->i_mmap_sem
);
280 sb_end_pagefault(sb
);
285 static const struct vm_operations_struct ext4_dax_vm_ops
= {
286 .fault
= ext4_dax_fault
,
287 .pmd_fault
= ext4_dax_pmd_fault
,
288 .page_mkwrite
= ext4_dax_fault
,
289 .pfn_mkwrite
= ext4_dax_pfn_mkwrite
,
292 #define ext4_dax_vm_ops ext4_file_vm_ops
295 static const struct vm_operations_struct ext4_file_vm_ops
= {
296 .fault
= ext4_filemap_fault
,
297 .map_pages
= filemap_map_pages
,
298 .page_mkwrite
= ext4_page_mkwrite
,
301 static int ext4_file_mmap(struct file
*file
, struct vm_area_struct
*vma
)
303 struct inode
*inode
= file
->f_mapping
->host
;
305 if (ext4_encrypted_inode(inode
)) {
306 int err
= fscrypt_get_encryption_info(inode
);
309 if (!fscrypt_has_encryption_key(inode
))
313 if (IS_DAX(file_inode(file
))) {
314 vma
->vm_ops
= &ext4_dax_vm_ops
;
315 vma
->vm_flags
|= VM_MIXEDMAP
| VM_HUGEPAGE
;
317 vma
->vm_ops
= &ext4_file_vm_ops
;
322 static int ext4_file_open(struct inode
* inode
, struct file
* filp
)
324 struct super_block
*sb
= inode
->i_sb
;
325 struct ext4_sb_info
*sbi
= EXT4_SB(inode
->i_sb
);
326 struct vfsmount
*mnt
= filp
->f_path
.mnt
;
332 if (unlikely(!(sbi
->s_mount_flags
& EXT4_MF_MNTDIR_SAMPLED
) &&
333 !(sb
->s_flags
& MS_RDONLY
))) {
334 sbi
->s_mount_flags
|= EXT4_MF_MNTDIR_SAMPLED
;
336 * Sample where the filesystem has been mounted and
337 * store it in the superblock for sysadmin convenience
338 * when trying to sort through large numbers of block
339 * devices or filesystem images.
341 memset(buf
, 0, sizeof(buf
));
343 path
.dentry
= mnt
->mnt_root
;
344 cp
= d_path(&path
, buf
, sizeof(buf
));
349 handle
= ext4_journal_start_sb(sb
, EXT4_HT_MISC
, 1);
351 return PTR_ERR(handle
);
352 BUFFER_TRACE(sbi
->s_sbh
, "get_write_access");
353 err
= ext4_journal_get_write_access(handle
, sbi
->s_sbh
);
355 ext4_journal_stop(handle
);
358 strlcpy(sbi
->s_es
->s_last_mounted
, cp
,
359 sizeof(sbi
->s_es
->s_last_mounted
));
360 ext4_handle_dirty_super(handle
, sb
);
361 ext4_journal_stop(handle
);
364 if (ext4_encrypted_inode(inode
)) {
365 ret
= fscrypt_get_encryption_info(inode
);
368 if (!fscrypt_has_encryption_key(inode
))
372 dir
= dget_parent(file_dentry(filp
));
373 if (ext4_encrypted_inode(d_inode(dir
)) &&
374 !fscrypt_has_permitted_context(d_inode(dir
), inode
)) {
375 ext4_warning(inode
->i_sb
,
376 "Inconsistent encryption contexts: %lu/%lu",
377 (unsigned long) d_inode(dir
)->i_ino
,
378 (unsigned long) inode
->i_ino
);
384 * Set up the jbd2_inode if we are opening the inode for
385 * writing and the journal is present
387 if (filp
->f_mode
& FMODE_WRITE
) {
388 ret
= ext4_inode_attach_jinode(inode
);
392 return dquot_file_open(inode
, filp
);
396 * Here we use ext4_map_blocks() to get a block mapping for a extent-based
397 * file rather than ext4_ext_walk_space() because we can introduce
398 * SEEK_DATA/SEEK_HOLE for block-mapped and extent-mapped file at the same
399 * function. When extent status tree has been fully implemented, it will
400 * track all extent status for a file and we can directly use it to
401 * retrieve the offset for SEEK_DATA/SEEK_HOLE.
405 * When we retrieve the offset for SEEK_DATA/SEEK_HOLE, we would need to
406 * lookup page cache to check whether or not there has some data between
407 * [startoff, endoff] because, if this range contains an unwritten extent,
408 * we determine this extent as a data or a hole according to whether the
409 * page cache has data or not.
411 static int ext4_find_unwritten_pgoff(struct inode
*inode
,
417 unsigned int blkbits
;
425 blkbits
= inode
->i_sb
->s_blocksize_bits
;
428 endoff
= (loff_t
)end_blk
<< blkbits
;
430 index
= startoff
>> PAGE_SHIFT
;
431 end
= endoff
>> PAGE_SHIFT
;
433 pagevec_init(&pvec
, 0);
436 unsigned long nr_pages
;
438 num
= min_t(pgoff_t
, end
- index
, PAGEVEC_SIZE
);
439 nr_pages
= pagevec_lookup(&pvec
, inode
->i_mapping
, index
,
442 if (whence
== SEEK_DATA
)
445 BUG_ON(whence
!= SEEK_HOLE
);
447 * If this is the first time to go into the loop and
448 * offset is not beyond the end offset, it will be a
449 * hole at this offset
451 if (lastoff
== startoff
|| lastoff
< endoff
)
457 * If this is the first time to go into the loop and
458 * offset is smaller than the first page offset, it will be a
459 * hole at this offset.
461 if (lastoff
== startoff
&& whence
== SEEK_HOLE
&&
462 lastoff
< page_offset(pvec
.pages
[0])) {
467 for (i
= 0; i
< nr_pages
; i
++) {
468 struct page
*page
= pvec
.pages
[i
];
469 struct buffer_head
*bh
, *head
;
472 * If the current offset is not beyond the end of given
473 * range, it will be a hole.
475 if (lastoff
< endoff
&& whence
== SEEK_HOLE
&&
484 if (unlikely(page
->mapping
!= inode
->i_mapping
)) {
489 if (!page_has_buffers(page
)) {
494 if (page_has_buffers(page
)) {
495 lastoff
= page_offset(page
);
496 bh
= head
= page_buffers(page
);
498 if (buffer_uptodate(bh
) ||
499 buffer_unwritten(bh
)) {
500 if (whence
== SEEK_DATA
)
503 if (whence
== SEEK_HOLE
)
507 *offset
= max_t(loff_t
,
512 lastoff
+= bh
->b_size
;
513 bh
= bh
->b_this_page
;
514 } while (bh
!= head
);
517 lastoff
= page_offset(page
) + PAGE_SIZE
;
522 * The no. of pages is less than our desired, that would be a
525 if (nr_pages
< num
&& whence
== SEEK_HOLE
) {
531 index
= pvec
.pages
[i
- 1]->index
+ 1;
532 pagevec_release(&pvec
);
533 } while (index
<= end
);
536 pagevec_release(&pvec
);
541 * ext4_seek_data() retrieves the offset for SEEK_DATA.
543 static loff_t
ext4_seek_data(struct file
*file
, loff_t offset
, loff_t maxsize
)
545 struct inode
*inode
= file
->f_mapping
->host
;
546 struct extent_status es
;
547 ext4_lblk_t start
, last
, end
;
548 loff_t dataoff
, isize
;
554 isize
= i_size_read(inode
);
555 if (offset
>= isize
) {
560 blkbits
= inode
->i_sb
->s_blocksize_bits
;
561 start
= offset
>> blkbits
;
563 end
= isize
>> blkbits
;
567 ret
= ext4_get_next_extent(inode
, last
, end
- last
+ 1, &es
);
569 /* No extent found -> no data */
578 dataoff
= (loff_t
)last
<< blkbits
;
579 if (!ext4_es_is_unwritten(&es
))
583 * If there is a unwritten extent at this offset,
584 * it will be as a data or a hole according to page
585 * cache that has data or not.
587 if (ext4_find_unwritten_pgoff(inode
, SEEK_DATA
,
588 es
.es_lblk
+ es
.es_len
, &dataoff
))
591 dataoff
= (loff_t
)last
<< blkbits
;
593 } while (last
<= end
);
600 return vfs_setpos(file
, dataoff
, maxsize
);
604 * ext4_seek_hole() retrieves the offset for SEEK_HOLE.
606 static loff_t
ext4_seek_hole(struct file
*file
, loff_t offset
, loff_t maxsize
)
608 struct inode
*inode
= file
->f_mapping
->host
;
609 struct extent_status es
;
610 ext4_lblk_t start
, last
, end
;
611 loff_t holeoff
, isize
;
617 isize
= i_size_read(inode
);
618 if (offset
>= isize
) {
623 blkbits
= inode
->i_sb
->s_blocksize_bits
;
624 start
= offset
>> blkbits
;
626 end
= isize
>> blkbits
;
630 ret
= ext4_get_next_extent(inode
, last
, end
- last
+ 1, &es
);
636 if (ret
== 0 || es
.es_lblk
> last
) {
638 holeoff
= (loff_t
)last
<< blkbits
;
642 * If there is a unwritten extent at this offset,
643 * it will be as a data or a hole according to page
644 * cache that has data or not.
646 if (ext4_es_is_unwritten(&es
) &&
647 ext4_find_unwritten_pgoff(inode
, SEEK_HOLE
,
648 last
+ es
.es_len
, &holeoff
))
652 holeoff
= (loff_t
)last
<< blkbits
;
654 } while (last
<= end
);
661 return vfs_setpos(file
, holeoff
, maxsize
);
665 * ext4_llseek() handles both block-mapped and extent-mapped maxbytes values
666 * by calling generic_file_llseek_size() with the appropriate maxbytes
669 loff_t
ext4_llseek(struct file
*file
, loff_t offset
, int whence
)
671 struct inode
*inode
= file
->f_mapping
->host
;
674 if (!(ext4_test_inode_flag(inode
, EXT4_INODE_EXTENTS
)))
675 maxbytes
= EXT4_SB(inode
->i_sb
)->s_bitmap_maxbytes
;
677 maxbytes
= inode
->i_sb
->s_maxbytes
;
683 return generic_file_llseek_size(file
, offset
, whence
,
684 maxbytes
, i_size_read(inode
));
686 return ext4_seek_data(file
, offset
, maxbytes
);
688 return ext4_seek_hole(file
, offset
, maxbytes
);
694 const struct file_operations ext4_file_operations
= {
695 .llseek
= ext4_llseek
,
696 .read_iter
= generic_file_read_iter
,
697 .write_iter
= ext4_file_write_iter
,
698 .unlocked_ioctl
= ext4_ioctl
,
700 .compat_ioctl
= ext4_compat_ioctl
,
702 .mmap
= ext4_file_mmap
,
703 .open
= ext4_file_open
,
704 .release
= ext4_release_file
,
705 .fsync
= ext4_sync_file
,
706 .splice_read
= generic_file_splice_read
,
707 .splice_write
= iter_file_splice_write
,
708 .fallocate
= ext4_fallocate
,
711 const struct inode_operations ext4_file_inode_operations
= {
712 .setattr
= ext4_setattr
,
713 .getattr
= ext4_getattr
,
714 .setxattr
= generic_setxattr
,
715 .getxattr
= generic_getxattr
,
716 .listxattr
= ext4_listxattr
,
717 .removexattr
= generic_removexattr
,
718 .get_acl
= ext4_get_acl
,
719 .set_acl
= ext4_set_acl
,
720 .fiemap
= ext4_fiemap
,