1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2016 Oracle. All Rights Reserved.
4 * Author: Darrick J. Wong <darrick.wong@oracle.com>
8 #include "xfs_shared.h"
9 #include "xfs_format.h"
10 #include "xfs_log_format.h"
11 #include "xfs_trans_resv.h"
12 #include "xfs_mount.h"
13 #include "xfs_defer.h"
14 #include "xfs_inode.h"
15 #include "xfs_trans.h"
17 #include "xfs_bmap_util.h"
18 #include "xfs_trace.h"
19 #include "xfs_icache.h"
20 #include "xfs_btree.h"
21 #include "xfs_refcount_btree.h"
22 #include "xfs_refcount.h"
23 #include "xfs_bmap_btree.h"
24 #include "xfs_trans_space.h"
26 #include "xfs_alloc.h"
27 #include "xfs_quota.h"
28 #include "xfs_reflink.h"
29 #include "xfs_iomap.h"
31 #include "xfs_ag_resv.h"
34 * Copy on Write of Shared Blocks
36 * XFS must preserve "the usual" file semantics even when two files share
37 * the same physical blocks. This means that a write to one file must not
38 * alter the blocks in a different file; the way that we'll do that is
39 * through the use of a copy-on-write mechanism. At a high level, that
40 * means that when we want to write to a shared block, we allocate a new
41 * block, write the data to the new block, and if that succeeds we map the
42 * new block into the file.
44 * XFS provides a "delayed allocation" mechanism that defers the allocation
45 * of disk blocks to dirty-but-not-yet-mapped file blocks as long as
46 * possible. This reduces fragmentation by enabling the filesystem to ask
47 * for bigger chunks less often, which is exactly what we want for CoW.
49 * The delalloc mechanism begins when the kernel wants to make a block
50 * writable (write_begin or page_mkwrite). If the offset is not mapped, we
51 * create a delalloc mapping, which is a regular in-core extent, but without
52 * a real startblock. (For delalloc mappings, the startblock encodes both
53 * a flag that this is a delalloc mapping, and a worst-case estimate of how
54 * many blocks might be required to put the mapping into the BMBT.) delalloc
55 * mappings are a reservation against the free space in the filesystem;
56 * adjacent mappings can also be combined into fewer larger mappings.
58 * As an optimization, the CoW extent size hint (cowextsz) creates
59 * outsized aligned delalloc reservations in the hope of landing out of
60 * order nearby CoW writes in a single extent on disk, thereby reducing
61 * fragmentation and improving future performance.
63 * D: --RRRRRRSSSRRRRRRRR--- (data fork)
64 * C: ------DDDDDDD--------- (CoW fork)
66 * When dirty pages are being written out (typically in writepage), the
67 * delalloc reservations are converted into unwritten mappings by
68 * allocating blocks and replacing the delalloc mapping with real ones.
69 * A delalloc mapping can be replaced by several unwritten ones if the
70 * free space is fragmented.
72 * D: --RRRRRRSSSRRRRRRRR---
73 * C: ------UUUUUUU---------
75 * We want to adapt the delalloc mechanism for copy-on-write, since the
76 * write paths are similar. The first two steps (creating the reservation
77 * and allocating the blocks) are exactly the same as delalloc except that
78 * the mappings must be stored in a separate CoW fork because we do not want
79 * to disturb the mapping in the data fork until we're sure that the write
80 * succeeded. IO completion in this case is the process of removing the old
81 * mapping from the data fork and moving the new mapping from the CoW fork to
82 * the data fork. This will be discussed shortly.
84 * For now, unaligned directio writes will be bounced back to the page cache.
85 * Block-aligned directio writes will use the same mechanism as buffered
88 * Just prior to submitting the actual disk write requests, we convert
89 * the extents representing the range of the file actually being written
90 * (as opposed to extra pieces created for the cowextsize hint) to real
91 * extents. This will become important in the next step:
93 * D: --RRRRRRSSSRRRRRRRR---
94 * C: ------UUrrUUU---------
96 * CoW remapping must be done after the data block write completes,
97 * because we don't want to destroy the old data fork map until we're sure
98 * the new block has been written. Since the new mappings are kept in a
99 * separate fork, we can simply iterate these mappings to find the ones
100 * that cover the file blocks that we just CoW'd. For each extent, simply
101 * unmap the corresponding range in the data fork, map the new range into
102 * the data fork, and remove the extent from the CoW fork. Because of
103 * the presence of the cowextsize hint, however, we must be careful
104 * only to remap the blocks that we've actually written out -- we must
105 * never remap delalloc reservations nor CoW staging blocks that have
106 * yet to be written. This corresponds exactly to the real extents in
109 * D: --RRRRRRrrSRRRRRRRR---
110 * C: ------UU--UUU---------
112 * Since the remapping operation can be applied to an arbitrary file
113 * range, we record the need for the remap step as a flag in the ioend
114 * instead of declaring a new IO type. This is required for direct io
115 * because we only have ioend for the whole dio, and we have to be able to
116 * remember the presence of unwritten blocks and CoW blocks with a single
117 * ioend structure. Better yet, the more ground we can cover with one
122 * Given an AG extent, find the lowest-numbered run of shared blocks
123 * within that range and return the range in fbno/flen. If
124 * find_end_of_shared is true, return the longest contiguous extent of
125 * shared blocks. If there are no shared extents, fbno and flen will
126 * be set to NULLAGBLOCK and 0, respectively.
129 xfs_reflink_find_shared(
130 struct xfs_mount *mp,
131 struct xfs_trans *tp,
137 bool find_end_of_shared)
139 struct xfs_buf *agbp;
140 struct xfs_btree_cur *cur;
143 error = xfs_alloc_read_agf(mp, tp, agno, 0, &agbp);
149 cur = xfs_refcountbt_init_cursor(mp, tp, agbp, agno);
151 error = xfs_refcount_find_shared(cur, agbno, aglen, fbno, flen,
154 xfs_btree_del_cursor(cur, error);
156 xfs_trans_brelse(tp, agbp);
161 * Trim the mapping to the next block where there's a change in the
162 * shared/unshared status. More specifically, this means that we
163 * find the lowest-numbered extent of shared blocks that coincides with
164 * the given block mapping. If the shared extent overlaps the start of
165 * the mapping, trim the mapping to the end of the shared extent. If
166 * the shared region intersects the mapping, trim the mapping to the
167 * start of the shared extent. If there are no shared regions that
168 * overlap, just return the original extent.
171 xfs_reflink_trim_around_shared(
172 struct xfs_inode *ip,
173 struct xfs_bmbt_irec *irec,
183 /* Holes, unwritten, and delalloc extents cannot be shared */
184 if (!xfs_is_cow_inode(ip) || !xfs_bmap_is_real_extent(irec)) {
189 trace_xfs_reflink_trim_around_shared(ip, irec);
191 agno = XFS_FSB_TO_AGNO(ip->i_mount, irec->br_startblock);
192 agbno = XFS_FSB_TO_AGBNO(ip->i_mount, irec->br_startblock);
193 aglen = irec->br_blockcount;
195 error = xfs_reflink_find_shared(ip->i_mount, NULL, agno, agbno,
196 aglen, &fbno, &flen, true);
201 if (fbno == NULLAGBLOCK) {
202 /* No shared blocks at all. */
204 } else if (fbno == agbno) {
206 * The start of this extent is shared. Truncate the
207 * mapping at the end of the shared region so that a
208 * subsequent iteration starts at the start of the
211 irec->br_blockcount = flen;
216 * There's a shared extent midway through this extent.
217 * Truncate the mapping at the start of the shared
218 * extent so that a subsequent iteration starts at the
219 * start of the shared region.
221 irec->br_blockcount = fbno - agbno;
228 struct xfs_inode *ip,
229 struct xfs_bmbt_irec *imap,
232 /* We can't update any real extents in always COW mode. */
233 if (xfs_is_always_cow_inode(ip) &&
234 !isnullstartblock(imap->br_startblock)) {
239 /* Trim the mapping to the nearest shared extent boundary. */
240 return xfs_reflink_trim_around_shared(ip, imap, shared);
244 xfs_reflink_convert_cow_locked(
245 struct xfs_inode *ip,
246 xfs_fileoff_t offset_fsb,
247 xfs_filblks_t count_fsb)
249 struct xfs_iext_cursor icur;
250 struct xfs_bmbt_irec got;
251 struct xfs_btree_cur *dummy_cur = NULL;
255 if (!xfs_iext_lookup_extent(ip, ip->i_cowfp, offset_fsb, &icur, &got))
259 if (got.br_startoff >= offset_fsb + count_fsb)
261 if (got.br_state == XFS_EXT_NORM)
263 if (WARN_ON_ONCE(isnullstartblock(got.br_startblock)))
266 xfs_trim_extent(&got, offset_fsb, count_fsb);
267 if (!got.br_blockcount)
270 got.br_state = XFS_EXT_NORM;
271 error = xfs_bmap_add_extent_unwritten_real(NULL, ip,
272 XFS_COW_FORK, &icur, &dummy_cur, &got,
276 } while (xfs_iext_next_extent(ip->i_cowfp, &icur, &got));
281 /* Convert all of the unwritten CoW extents in a file's range to real ones. */
283 xfs_reflink_convert_cow(
284 struct xfs_inode *ip,
288 struct xfs_mount *mp = ip->i_mount;
289 xfs_fileoff_t offset_fsb = XFS_B_TO_FSBT(mp, offset);
290 xfs_fileoff_t end_fsb = XFS_B_TO_FSB(mp, offset + count);
291 xfs_filblks_t count_fsb = end_fsb - offset_fsb;
296 xfs_ilock(ip, XFS_ILOCK_EXCL);
297 error = xfs_reflink_convert_cow_locked(ip, offset_fsb, count_fsb);
298 xfs_iunlock(ip, XFS_ILOCK_EXCL);
303 * Find the extent that maps the given range in the COW fork. Even if the extent
304 * is not shared we might have a preallocation for it in the COW fork. If so we
305 * use it that rather than trigger a new allocation.
308 xfs_find_trim_cow_extent(
309 struct xfs_inode *ip,
310 struct xfs_bmbt_irec *imap,
314 xfs_fileoff_t offset_fsb = imap->br_startoff;
315 xfs_filblks_t count_fsb = imap->br_blockcount;
316 struct xfs_iext_cursor icur;
317 struct xfs_bmbt_irec got;
322 * If we don't find an overlapping extent, trim the range we need to
323 * allocate to fit the hole we found.
325 if (!xfs_iext_lookup_extent(ip, ip->i_cowfp, offset_fsb, &icur, &got))
326 got.br_startoff = offset_fsb + count_fsb;
327 if (got.br_startoff > offset_fsb) {
328 xfs_trim_extent(imap, imap->br_startoff,
329 got.br_startoff - imap->br_startoff);
330 return xfs_inode_need_cow(ip, imap, shared);
334 if (isnullstartblock(got.br_startblock)) {
335 xfs_trim_extent(imap, got.br_startoff, got.br_blockcount);
339 /* real extent found - no need to allocate */
340 xfs_trim_extent(&got, offset_fsb, count_fsb);
346 /* Allocate all CoW reservations covering a range of blocks in a file. */
348 xfs_reflink_allocate_cow(
349 struct xfs_inode *ip,
350 struct xfs_bmbt_irec *imap,
355 struct xfs_mount *mp = ip->i_mount;
356 xfs_fileoff_t offset_fsb = imap->br_startoff;
357 xfs_filblks_t count_fsb = imap->br_blockcount;
358 struct xfs_trans *tp;
359 int nimaps, error = 0;
361 xfs_filblks_t resaligned;
362 xfs_extlen_t resblks = 0;
364 ASSERT(xfs_isilocked(ip, XFS_ILOCK_EXCL));
366 ASSERT(!xfs_is_reflink_inode(ip));
367 xfs_ifork_init_cow(ip);
370 error = xfs_find_trim_cow_extent(ip, imap, shared, &found);
371 if (error || !*shared)
376 resaligned = xfs_aligned_fsb_count(imap->br_startoff,
377 imap->br_blockcount, xfs_get_cowextsz_hint(ip));
378 resblks = XFS_DIOSTRAT_SPACE_RES(mp, resaligned);
380 xfs_iunlock(ip, *lockmode);
381 error = xfs_trans_alloc(mp, &M_RES(mp)->tr_write, resblks, 0, 0, &tp);
382 *lockmode = XFS_ILOCK_EXCL;
383 xfs_ilock(ip, *lockmode);
388 error = xfs_qm_dqattach_locked(ip, false);
390 goto out_trans_cancel;
393 * Check for an overlapping extent again now that we dropped the ilock.
395 error = xfs_find_trim_cow_extent(ip, imap, shared, &found);
396 if (error || !*shared)
397 goto out_trans_cancel;
399 xfs_trans_cancel(tp);
403 error = xfs_trans_reserve_quota_nblks(tp, ip, resblks, 0,
404 XFS_QMOPT_RES_REGBLKS);
406 goto out_trans_cancel;
408 xfs_trans_ijoin(tp, ip, 0);
410 /* Allocate the entire reservation as unwritten blocks. */
412 error = xfs_bmapi_write(tp, ip, imap->br_startoff, imap->br_blockcount,
413 XFS_BMAPI_COWFORK | XFS_BMAPI_PREALLOC,
414 resblks, imap, &nimaps);
418 xfs_inode_set_cowblocks_tag(ip);
419 error = xfs_trans_commit(tp);
424 * Allocation succeeded but the requested range was not even partially
425 * satisfied? Bail out!
430 xfs_trim_extent(imap, offset_fsb, count_fsb);
432 * COW fork extents are supposed to remain unwritten until we're ready
433 * to initiate a disk write. For direct I/O we are going to write the
434 * data and need the conversion, but for buffered writes we're done.
436 if (!convert_now || imap->br_state == XFS_EXT_NORM)
438 trace_xfs_reflink_convert_cow(ip, imap);
439 return xfs_reflink_convert_cow_locked(ip, offset_fsb, count_fsb);
442 xfs_trans_unreserve_quota_nblks(tp, ip, (long)resblks, 0,
443 XFS_QMOPT_RES_REGBLKS);
445 xfs_trans_cancel(tp);
450 * Cancel CoW reservations for some block range of an inode.
452 * If cancel_real is true this function cancels all COW fork extents for the
453 * inode; if cancel_real is false, real extents are not cleared.
455 * Caller must have already joined the inode to the current transaction. The
456 * inode will be joined to the transaction returned to the caller.
459 xfs_reflink_cancel_cow_blocks(
460 struct xfs_inode *ip,
461 struct xfs_trans **tpp,
462 xfs_fileoff_t offset_fsb,
463 xfs_fileoff_t end_fsb,
466 struct xfs_ifork *ifp = XFS_IFORK_PTR(ip, XFS_COW_FORK);
467 struct xfs_bmbt_irec got, del;
468 struct xfs_iext_cursor icur;
471 if (!xfs_inode_has_cow_data(ip))
473 if (!xfs_iext_lookup_extent_before(ip, ifp, &end_fsb, &icur, &got))
476 /* Walk backwards until we're out of the I/O range... */
477 while (got.br_startoff + got.br_blockcount > offset_fsb) {
479 xfs_trim_extent(&del, offset_fsb, end_fsb - offset_fsb);
481 /* Extent delete may have bumped ext forward */
482 if (!del.br_blockcount) {
483 xfs_iext_prev(ifp, &icur);
487 trace_xfs_reflink_cancel_cow(ip, &del);
489 if (isnullstartblock(del.br_startblock)) {
490 error = xfs_bmap_del_extent_delay(ip, XFS_COW_FORK,
494 } else if (del.br_state == XFS_EXT_UNWRITTEN || cancel_real) {
495 ASSERT((*tpp)->t_firstblock == NULLFSBLOCK);
497 /* Free the CoW orphan record. */
498 xfs_refcount_free_cow_extent(*tpp, del.br_startblock,
501 xfs_bmap_add_free(*tpp, del.br_startblock,
502 del.br_blockcount, NULL);
504 /* Roll the transaction */
505 error = xfs_defer_finish(tpp);
509 /* Remove the mapping from the CoW fork. */
510 xfs_bmap_del_extent_cow(ip, &icur, &got, &del);
512 /* Remove the quota reservation */
513 error = xfs_trans_reserve_quota_nblks(NULL, ip,
514 -(long)del.br_blockcount, 0,
515 XFS_QMOPT_RES_REGBLKS);
519 /* Didn't do anything, push cursor back. */
520 xfs_iext_prev(ifp, &icur);
523 if (!xfs_iext_get_extent(ifp, &icur, &got))
527 /* clear tag if cow fork is emptied */
529 xfs_inode_clear_cowblocks_tag(ip);
534 * Cancel CoW reservations for some byte range of an inode.
536 * If cancel_real is true this function cancels all COW fork extents for the
537 * inode; if cancel_real is false, real extents are not cleared.
540 xfs_reflink_cancel_cow_range(
541 struct xfs_inode *ip,
546 struct xfs_trans *tp;
547 xfs_fileoff_t offset_fsb;
548 xfs_fileoff_t end_fsb;
551 trace_xfs_reflink_cancel_cow_range(ip, offset, count);
554 offset_fsb = XFS_B_TO_FSBT(ip->i_mount, offset);
555 if (count == NULLFILEOFF)
556 end_fsb = NULLFILEOFF;
558 end_fsb = XFS_B_TO_FSB(ip->i_mount, offset + count);
560 /* Start a rolling transaction to remove the mappings */
561 error = xfs_trans_alloc(ip->i_mount, &M_RES(ip->i_mount)->tr_write,
566 xfs_ilock(ip, XFS_ILOCK_EXCL);
567 xfs_trans_ijoin(tp, ip, 0);
569 /* Scrape out the old CoW reservations */
570 error = xfs_reflink_cancel_cow_blocks(ip, &tp, offset_fsb, end_fsb,
575 error = xfs_trans_commit(tp);
577 xfs_iunlock(ip, XFS_ILOCK_EXCL);
581 xfs_trans_cancel(tp);
582 xfs_iunlock(ip, XFS_ILOCK_EXCL);
584 trace_xfs_reflink_cancel_cow_range_error(ip, error, _RET_IP_);
589 * Remap part of the CoW fork into the data fork.
591 * We aim to remap the range starting at @offset_fsb and ending at @end_fsb
592 * into the data fork; this function will remap what it can (at the end of the
593 * range) and update @end_fsb appropriately. Each remap gets its own
594 * transaction because we can end up merging and splitting bmbt blocks for
595 * every remap operation and we'd like to keep the block reservation
596 * requirements as low as possible.
599 xfs_reflink_end_cow_extent(
600 struct xfs_inode *ip,
601 xfs_fileoff_t offset_fsb,
602 xfs_fileoff_t *end_fsb)
604 struct xfs_bmbt_irec got, del;
605 struct xfs_iext_cursor icur;
606 struct xfs_mount *mp = ip->i_mount;
607 struct xfs_trans *tp;
608 struct xfs_ifork *ifp = XFS_IFORK_PTR(ip, XFS_COW_FORK);
610 unsigned int resblks;
613 /* No COW extents? That's easy! */
614 if (ifp->if_bytes == 0) {
615 *end_fsb = offset_fsb;
619 resblks = XFS_EXTENTADD_SPACE_RES(mp, XFS_DATA_FORK);
620 error = xfs_trans_alloc(mp, &M_RES(mp)->tr_write, resblks, 0,
621 XFS_TRANS_RESERVE, &tp);
626 * Lock the inode. We have to ijoin without automatic unlock because
627 * the lead transaction is the refcountbt record deletion; the data
628 * fork update follows as a deferred log item.
630 xfs_ilock(ip, XFS_ILOCK_EXCL);
631 xfs_trans_ijoin(tp, ip, 0);
634 * In case of racing, overlapping AIO writes no COW extents might be
635 * left by the time I/O completes for the loser of the race. In that
638 if (!xfs_iext_lookup_extent_before(ip, ifp, end_fsb, &icur, &got) ||
639 got.br_startoff + got.br_blockcount <= offset_fsb) {
640 *end_fsb = offset_fsb;
645 * Structure copy @got into @del, then trim @del to the range that we
646 * were asked to remap. We preserve @got for the eventual CoW fork
647 * deletion; from now on @del represents the mapping that we're
648 * actually remapping.
651 xfs_trim_extent(&del, offset_fsb, *end_fsb - offset_fsb);
653 ASSERT(del.br_blockcount > 0);
656 * Only remap real extents that contain data. With AIO, speculative
657 * preallocations can leak into the range we are called upon, and we
660 if (!xfs_bmap_is_real_extent(&got)) {
661 *end_fsb = del.br_startoff;
665 /* Unmap the old blocks in the data fork. */
666 rlen = del.br_blockcount;
667 error = __xfs_bunmapi(tp, ip, del.br_startoff, &rlen, 0, 1);
671 /* Trim the extent to whatever got unmapped. */
672 xfs_trim_extent(&del, del.br_startoff + rlen, del.br_blockcount - rlen);
673 trace_xfs_reflink_cow_remap(ip, &del);
675 /* Free the CoW orphan record. */
676 xfs_refcount_free_cow_extent(tp, del.br_startblock, del.br_blockcount);
678 /* Map the new blocks into the data fork. */
679 xfs_bmap_map_extent(tp, ip, &del);
681 /* Charge this new data fork mapping to the on-disk quota. */
682 xfs_trans_mod_dquot_byino(tp, ip, XFS_TRANS_DQ_DELBCOUNT,
683 (long)del.br_blockcount);
685 /* Remove the mapping from the CoW fork. */
686 xfs_bmap_del_extent_cow(ip, &icur, &got, &del);
688 error = xfs_trans_commit(tp);
689 xfs_iunlock(ip, XFS_ILOCK_EXCL);
693 /* Update the caller about how much progress we made. */
694 *end_fsb = del.br_startoff;
698 xfs_trans_cancel(tp);
699 xfs_iunlock(ip, XFS_ILOCK_EXCL);
704 * Remap parts of a file's data fork after a successful CoW.
708 struct xfs_inode *ip,
712 xfs_fileoff_t offset_fsb;
713 xfs_fileoff_t end_fsb;
716 trace_xfs_reflink_end_cow(ip, offset, count);
718 offset_fsb = XFS_B_TO_FSBT(ip->i_mount, offset);
719 end_fsb = XFS_B_TO_FSB(ip->i_mount, offset + count);
722 * Walk backwards until we're out of the I/O range. The loop function
723 * repeatedly cycles the ILOCK to allocate one transaction per remapped
726 * If we're being called by writeback then the the pages will still
727 * have PageWriteback set, which prevents races with reflink remapping
728 * and truncate. Reflink remapping prevents races with writeback by
729 * taking the iolock and mmaplock before flushing the pages and
730 * remapping, which means there won't be any further writeback or page
731 * cache dirtying until the reflink completes.
733 * We should never have two threads issuing writeback for the same file
734 * region. There are also have post-eof checks in the writeback
735 * preparation code so that we don't bother writing out pages that are
736 * about to be truncated.
738 * If we're being called as part of directio write completion, the dio
739 * count is still elevated, which reflink and truncate will wait for.
740 * Reflink remapping takes the iolock and mmaplock and waits for
741 * pending dio to finish, which should prevent any directio until the
742 * remap completes. Multiple concurrent directio writes to the same
743 * region are handled by end_cow processing only occurring for the
744 * threads which succeed; the outcome of multiple overlapping direct
745 * writes is not well defined anyway.
747 * It's possible that a buffered write and a direct write could collide
748 * here (the buffered write stumbles in after the dio flushes and
749 * invalidates the page cache and immediately queues writeback), but we
750 * have never supported this 100%. If either disk write succeeds the
751 * blocks will be remapped.
753 while (end_fsb > offset_fsb && !error)
754 error = xfs_reflink_end_cow_extent(ip, offset_fsb, &end_fsb);
757 trace_xfs_reflink_end_cow_error(ip, error, _RET_IP_);
762 * Free leftover CoW reservations that didn't get cleaned out.
765 xfs_reflink_recover_cow(
766 struct xfs_mount *mp)
771 if (!xfs_sb_version_hasreflink(&mp->m_sb))
774 for (agno = 0; agno < mp->m_sb.sb_agcount; agno++) {
775 error = xfs_refcount_recover_cow_leftovers(mp, agno);
784 * Reflinking (Block) Ranges of Two Files Together
786 * First, ensure that the reflink flag is set on both inodes. The flag is an
787 * optimization to avoid unnecessary refcount btree lookups in the write path.
789 * Now we can iteratively remap the range of extents (and holes) in src to the
790 * corresponding ranges in dest. Let drange and srange denote the ranges of
791 * logical blocks in dest and src touched by the reflink operation.
793 * While the length of drange is greater than zero,
794 * - Read src's bmbt at the start of srange ("imap")
795 * - If imap doesn't exist, make imap appear to start at the end of srange
797 * - If imap starts before srange, advance imap to start at srange.
798 * - If imap goes beyond srange, truncate imap to end at the end of srange.
799 * - Punch (imap start - srange start + imap len) blocks from dest at
800 * offset (drange start).
801 * - If imap points to a real range of pblks,
802 * > Increase the refcount of the imap's pblks
803 * > Map imap's pblks into dest at the offset
804 * (drange start + imap start - srange start)
805 * - Advance drange and srange by (imap start - srange start + imap len)
807 * Finally, if the reflink made dest longer, update both the in-core and
808 * on-disk file sizes.
810 * ASCII Art Demonstration:
812 * Let's say we want to reflink this source file:
814 * ----SSSSSSS-SSSSS----SSSSSS (src file)
815 * <-------------------->
817 * into this destination file:
819 * --DDDDDDDDDDDDDDDDDDD--DDD (dest file)
820 * <-------------------->
821 * '-' means a hole, and 'S' and 'D' are written blocks in the src and dest.
822 * Observe that the range has different logical offsets in either file.
824 * Consider that the first extent in the source file doesn't line up with our
825 * reflink range. Unmapping and remapping are separate operations, so we can
826 * unmap more blocks from the destination file than we remap.
828 * ----SSSSSSS-SSSSS----SSSSSS
830 * --DDDDD---------DDDDD--DDD
833 * Now remap the source extent into the destination file:
835 * ----SSSSSSS-SSSSS----SSSSSS
837 * --DDDDD--SSSSSSSDDDDD--DDD
840 * Do likewise with the second hole and extent in our range. Holes in the
841 * unmap range don't affect our operation.
843 * ----SSSSSSS-SSSSS----SSSSSS
845 * --DDDDD--SSSSSSS-SSSSS-DDD
848 * Finally, unmap and remap part of the third extent. This will increase the
849 * size of the destination file.
851 * ----SSSSSSS-SSSSS----SSSSSS
853 * --DDDDD--SSSSSSS-SSSSS----SSS
856 * Once we update the destination file's i_size, we're done.
860 * Ensure the reflink bit is set in both inodes.
863 xfs_reflink_set_inode_flag(
864 struct xfs_inode *src,
865 struct xfs_inode *dest)
867 struct xfs_mount *mp = src->i_mount;
869 struct xfs_trans *tp;
871 if (xfs_is_reflink_inode(src) && xfs_is_reflink_inode(dest))
874 error = xfs_trans_alloc(mp, &M_RES(mp)->tr_ichange, 0, 0, 0, &tp);
878 /* Lock both files against IO */
879 if (src->i_ino == dest->i_ino)
880 xfs_ilock(src, XFS_ILOCK_EXCL);
882 xfs_lock_two_inodes(src, XFS_ILOCK_EXCL, dest, XFS_ILOCK_EXCL);
884 if (!xfs_is_reflink_inode(src)) {
885 trace_xfs_reflink_set_inode_flag(src);
886 xfs_trans_ijoin(tp, src, XFS_ILOCK_EXCL);
887 src->i_d.di_flags2 |= XFS_DIFLAG2_REFLINK;
888 xfs_trans_log_inode(tp, src, XFS_ILOG_CORE);
889 xfs_ifork_init_cow(src);
891 xfs_iunlock(src, XFS_ILOCK_EXCL);
893 if (src->i_ino == dest->i_ino)
896 if (!xfs_is_reflink_inode(dest)) {
897 trace_xfs_reflink_set_inode_flag(dest);
898 xfs_trans_ijoin(tp, dest, XFS_ILOCK_EXCL);
899 dest->i_d.di_flags2 |= XFS_DIFLAG2_REFLINK;
900 xfs_trans_log_inode(tp, dest, XFS_ILOG_CORE);
901 xfs_ifork_init_cow(dest);
903 xfs_iunlock(dest, XFS_ILOCK_EXCL);
906 error = xfs_trans_commit(tp);
912 trace_xfs_reflink_set_inode_flag_error(dest, error, _RET_IP_);
917 * Update destination inode size & cowextsize hint, if necessary.
920 xfs_reflink_update_dest(
921 struct xfs_inode *dest,
923 xfs_extlen_t cowextsize,
924 unsigned int remap_flags)
926 struct xfs_mount *mp = dest->i_mount;
927 struct xfs_trans *tp;
930 if (newlen <= i_size_read(VFS_I(dest)) && cowextsize == 0)
933 error = xfs_trans_alloc(mp, &M_RES(mp)->tr_ichange, 0, 0, 0, &tp);
937 xfs_ilock(dest, XFS_ILOCK_EXCL);
938 xfs_trans_ijoin(tp, dest, XFS_ILOCK_EXCL);
940 if (newlen > i_size_read(VFS_I(dest))) {
941 trace_xfs_reflink_update_inode_size(dest, newlen);
942 i_size_write(VFS_I(dest), newlen);
943 dest->i_d.di_size = newlen;
947 dest->i_d.di_cowextsize = cowextsize;
948 dest->i_d.di_flags2 |= XFS_DIFLAG2_COWEXTSIZE;
951 xfs_trans_log_inode(tp, dest, XFS_ILOG_CORE);
953 error = xfs_trans_commit(tp);
959 trace_xfs_reflink_update_inode_size_error(dest, error, _RET_IP_);
964 * Do we have enough reserve in this AG to handle a reflink? The refcount
965 * btree already reserved all the space it needs, but the rmap btree can grow
966 * infinitely, so we won't allow more reflinks when the AG is down to the
970 xfs_reflink_ag_has_free_space(
971 struct xfs_mount *mp,
974 struct xfs_perag *pag;
977 if (!xfs_sb_version_hasrmapbt(&mp->m_sb))
980 pag = xfs_perag_get(mp, agno);
981 if (xfs_ag_resv_critical(pag, XFS_AG_RESV_RMAPBT) ||
982 xfs_ag_resv_critical(pag, XFS_AG_RESV_METADATA))
989 * Unmap a range of blocks from a file, then map other blocks into the hole.
990 * The range to unmap is (destoff : destoff + srcioff + irec->br_blockcount).
991 * The extent irec is mapped into dest at irec->br_startoff.
994 xfs_reflink_remap_extent(
995 struct xfs_inode *ip,
996 struct xfs_bmbt_irec *irec,
997 xfs_fileoff_t destoff,
1000 struct xfs_mount *mp = ip->i_mount;
1001 bool real_extent = xfs_bmap_is_real_extent(irec);
1002 struct xfs_trans *tp;
1003 unsigned int resblks;
1004 struct xfs_bmbt_irec uirec;
1006 xfs_filblks_t unmap_len;
1010 unmap_len = irec->br_startoff + irec->br_blockcount - destoff;
1011 trace_xfs_reflink_punch_range(ip, destoff, unmap_len);
1013 /* No reflinking if we're low on space */
1015 error = xfs_reflink_ag_has_free_space(mp,
1016 XFS_FSB_TO_AGNO(mp, irec->br_startblock));
1021 /* Start a rolling transaction to switch the mappings */
1022 resblks = XFS_EXTENTADD_SPACE_RES(ip->i_mount, XFS_DATA_FORK);
1023 error = xfs_trans_alloc(mp, &M_RES(mp)->tr_write, resblks, 0, 0, &tp);
1027 xfs_ilock(ip, XFS_ILOCK_EXCL);
1028 xfs_trans_ijoin(tp, ip, 0);
1030 /* If we're not just clearing space, then do we have enough quota? */
1032 error = xfs_trans_reserve_quota_nblks(tp, ip,
1033 irec->br_blockcount, 0, XFS_QMOPT_RES_REGBLKS);
1038 trace_xfs_reflink_remap(ip, irec->br_startoff,
1039 irec->br_blockcount, irec->br_startblock);
1041 /* Unmap the old blocks in the data fork. */
1044 ASSERT(tp->t_firstblock == NULLFSBLOCK);
1045 error = __xfs_bunmapi(tp, ip, destoff, &rlen, 0, 1);
1050 * Trim the extent to whatever got unmapped.
1051 * Remember, bunmapi works backwards.
1053 uirec.br_startblock = irec->br_startblock + rlen;
1054 uirec.br_startoff = irec->br_startoff + rlen;
1055 uirec.br_blockcount = unmap_len - rlen;
1058 /* If this isn't a real mapping, we're done. */
1059 if (!real_extent || uirec.br_blockcount == 0)
1062 trace_xfs_reflink_remap(ip, uirec.br_startoff,
1063 uirec.br_blockcount, uirec.br_startblock);
1065 /* Update the refcount tree */
1066 xfs_refcount_increase_extent(tp, &uirec);
1068 /* Map the new blocks into the data fork. */
1069 xfs_bmap_map_extent(tp, ip, &uirec);
1071 /* Update quota accounting. */
1072 xfs_trans_mod_dquot_byino(tp, ip, XFS_TRANS_DQ_BCOUNT,
1073 uirec.br_blockcount);
1075 /* Update dest isize if needed. */
1076 newlen = XFS_FSB_TO_B(mp,
1077 uirec.br_startoff + uirec.br_blockcount);
1078 newlen = min_t(xfs_off_t, newlen, new_isize);
1079 if (newlen > i_size_read(VFS_I(ip))) {
1080 trace_xfs_reflink_update_inode_size(ip, newlen);
1081 i_size_write(VFS_I(ip), newlen);
1082 ip->i_d.di_size = newlen;
1083 xfs_trans_log_inode(tp, ip, XFS_ILOG_CORE);
1087 /* Process all the deferred stuff. */
1088 error = xfs_defer_finish(&tp);
1093 error = xfs_trans_commit(tp);
1094 xfs_iunlock(ip, XFS_ILOCK_EXCL);
1100 xfs_trans_cancel(tp);
1101 xfs_iunlock(ip, XFS_ILOCK_EXCL);
1103 trace_xfs_reflink_remap_extent_error(ip, error, _RET_IP_);
1108 * Iteratively remap one file's extents (and holes) to another's.
1111 xfs_reflink_remap_blocks(
1112 struct xfs_inode *src,
1114 struct xfs_inode *dest,
1119 struct xfs_bmbt_irec imap;
1120 xfs_fileoff_t srcoff;
1121 xfs_fileoff_t destoff;
1123 xfs_filblks_t range_len;
1124 xfs_filblks_t remapped_len = 0;
1125 xfs_off_t new_isize = pos_out + remap_len;
1129 destoff = XFS_B_TO_FSBT(src->i_mount, pos_out);
1130 srcoff = XFS_B_TO_FSBT(src->i_mount, pos_in);
1131 len = XFS_B_TO_FSB(src->i_mount, remap_len);
1133 /* drange = (destoff, destoff + len); srange = (srcoff, srcoff + len) */
1137 trace_xfs_reflink_remap_blocks_loop(src, srcoff, len,
1140 /* Read extent from the source file */
1142 lock_mode = xfs_ilock_data_map_shared(src);
1143 error = xfs_bmapi_read(src, srcoff, len, &imap, &nimaps, 0);
1144 xfs_iunlock(src, lock_mode);
1147 ASSERT(nimaps == 1);
1149 trace_xfs_reflink_remap_imap(src, srcoff, len, XFS_DATA_FORK,
1152 /* Translate imap into the destination file. */
1153 range_len = imap.br_startoff + imap.br_blockcount - srcoff;
1154 imap.br_startoff += destoff - srcoff;
1156 /* Clear dest from destoff to the end of imap and map it in. */
1157 error = xfs_reflink_remap_extent(dest, &imap, destoff,
1162 if (fatal_signal_pending(current)) {
1167 /* Advance drange/srange */
1168 srcoff += range_len;
1169 destoff += range_len;
1171 remapped_len += range_len;
1175 trace_xfs_reflink_remap_blocks_error(dest, error, _RET_IP_);
1176 *remapped = min_t(loff_t, remap_len,
1177 XFS_FSB_TO_B(src->i_mount, remapped_len));
1182 * Grab the exclusive iolock for a data copy from src to dest, making sure to
1183 * abide vfs locking order (lowest pointer value goes first) and breaking the
1184 * layout leases before proceeding. The loop is needed because we cannot call
1185 * the blocking break_layout() with the iolocks held, and therefore have to
1186 * back out both locks.
1189 xfs_iolock_two_inodes_and_break_layout(
1199 /* Wait to break both inodes' layouts before we start locking. */
1200 error = break_layout(src, true);
1204 error = break_layout(dest, true);
1209 /* Lock one inode and make sure nobody got in and leased it. */
1211 error = break_layout(src, false);
1214 if (error == -EWOULDBLOCK)
1222 /* Lock the other inode and make sure nobody got in and leased it. */
1223 inode_lock_nested(dest, I_MUTEX_NONDIR2);
1224 error = break_layout(dest, false);
1228 if (error == -EWOULDBLOCK)
1236 /* Unlock both inodes after they've been prepped for a range clone. */
1238 xfs_reflink_remap_unlock(
1239 struct file *file_in,
1240 struct file *file_out)
1242 struct inode *inode_in = file_inode(file_in);
1243 struct xfs_inode *src = XFS_I(inode_in);
1244 struct inode *inode_out = file_inode(file_out);
1245 struct xfs_inode *dest = XFS_I(inode_out);
1246 bool same_inode = (inode_in == inode_out);
1248 xfs_iunlock(dest, XFS_MMAPLOCK_EXCL);
1250 xfs_iunlock(src, XFS_MMAPLOCK_EXCL);
1251 inode_unlock(inode_out);
1253 inode_unlock(inode_in);
1257 * If we're reflinking to a point past the destination file's EOF, we must
1258 * zero any speculative post-EOF preallocations that sit between the old EOF
1259 * and the destination file offset.
1262 xfs_reflink_zero_posteof(
1263 struct xfs_inode *ip,
1266 loff_t isize = i_size_read(VFS_I(ip));
1271 trace_xfs_zero_eof(ip, isize, pos - isize);
1272 return iomap_zero_range(VFS_I(ip), isize, pos - isize, NULL,
1277 * Prepare two files for range cloning. Upon a successful return both inodes
1278 * will have the iolock and mmaplock held, the page cache of the out file will
1279 * be truncated, and any leases on the out file will have been broken. This
1280 * function borrows heavily from xfs_file_aio_write_checks.
1282 * The VFS allows partial EOF blocks to "match" for dedupe even though it hasn't
1283 * checked that the bytes beyond EOF physically match. Hence we cannot use the
1284 * EOF block in the source dedupe range because it's not a complete block match,
1285 * hence can introduce a corruption into the file that has it's block replaced.
1287 * In similar fashion, the VFS file cloning also allows partial EOF blocks to be
1288 * "block aligned" for the purposes of cloning entire files. However, if the
1289 * source file range includes the EOF block and it lands within the existing EOF
1290 * of the destination file, then we can expose stale data from beyond the source
1291 * file EOF in the destination file.
1293 * XFS doesn't support partial block sharing, so in both cases we have check
1294 * these cases ourselves. For dedupe, we can simply round the length to dedupe
1295 * down to the previous whole block and ignore the partial EOF block. While this
1296 * means we can't dedupe the last block of a file, this is an acceptible
1297 * tradeoff for simplicity on implementation.
1299 * For cloning, we want to share the partial EOF block if it is also the new EOF
1300 * block of the destination file. If the partial EOF block lies inside the
1301 * existing destination EOF, then we have to abort the clone to avoid exposing
1302 * stale data in the destination file. Hence we reject these clone attempts with
1303 * -EINVAL in this case.
1306 xfs_reflink_remap_prep(
1307 struct file *file_in,
1309 struct file *file_out,
1312 unsigned int remap_flags)
1314 struct inode *inode_in = file_inode(file_in);
1315 struct xfs_inode *src = XFS_I(inode_in);
1316 struct inode *inode_out = file_inode(file_out);
1317 struct xfs_inode *dest = XFS_I(inode_out);
1318 bool same_inode = (inode_in == inode_out);
1321 /* Lock both files against IO */
1322 ret = xfs_iolock_two_inodes_and_break_layout(inode_in, inode_out);
1326 xfs_ilock(src, XFS_MMAPLOCK_EXCL);
1328 xfs_lock_two_inodes(src, XFS_MMAPLOCK_EXCL, dest,
1331 /* Check file eligibility and prepare for block sharing. */
1333 /* Don't reflink realtime inodes */
1334 if (XFS_IS_REALTIME_INODE(src) || XFS_IS_REALTIME_INODE(dest))
1337 /* Don't share DAX file data for now. */
1338 if (IS_DAX(inode_in) || IS_DAX(inode_out))
1341 ret = generic_remap_file_range_prep(file_in, pos_in, file_out, pos_out,
1343 if (ret < 0 || *len == 0)
1346 /* Attach dquots to dest inode before changing block map */
1347 ret = xfs_qm_dqattach(dest);
1352 * Zero existing post-eof speculative preallocations in the destination
1355 ret = xfs_reflink_zero_posteof(dest, pos_out);
1359 /* Set flags and remap blocks. */
1360 ret = xfs_reflink_set_inode_flag(src, dest);
1365 * If pos_out > EOF, we may have dirtied blocks between EOF and
1366 * pos_out. In that case, we need to extend the flush and unmap to cover
1367 * from EOF to the end of the copy length.
1369 if (pos_out > XFS_ISIZE(dest)) {
1370 loff_t flen = *len + (pos_out - XFS_ISIZE(dest));
1371 ret = xfs_flush_unmap_range(dest, XFS_ISIZE(dest), flen);
1373 ret = xfs_flush_unmap_range(dest, pos_out, *len);
1380 xfs_reflink_remap_unlock(file_in, file_out);
1385 * The user wants to preemptively CoW all shared blocks in this file,
1386 * which enables us to turn off the reflink flag. Iterate all
1387 * extents which are not prealloc/delalloc to see which ranges are
1388 * mentioned in the refcount tree, then read those blocks into the
1389 * pagecache, dirty them, fsync them back out, and then we can update
1390 * the inode flag. What happens if we run out of memory? :)
1393 xfs_reflink_dirty_extents(
1394 struct xfs_inode *ip,
1399 struct xfs_mount *mp = ip->i_mount;
1400 xfs_agnumber_t agno;
1401 xfs_agblock_t agbno;
1407 struct xfs_bmbt_irec map[2];
1411 while (end - fbno > 0) {
1414 * Look for extents in the file. Skip holes, delalloc, or
1415 * unwritten extents; they can't be reflinked.
1417 error = xfs_bmapi_read(ip, fbno, end - fbno, map, &nmaps, 0);
1422 if (!xfs_bmap_is_real_extent(&map[0]))
1426 while (map[1].br_blockcount) {
1427 agno = XFS_FSB_TO_AGNO(mp, map[1].br_startblock);
1428 agbno = XFS_FSB_TO_AGBNO(mp, map[1].br_startblock);
1429 aglen = map[1].br_blockcount;
1431 error = xfs_reflink_find_shared(mp, NULL, agno, agbno,
1432 aglen, &rbno, &rlen, true);
1435 if (rbno == NULLAGBLOCK)
1438 /* Dirty the pages */
1439 xfs_iunlock(ip, XFS_ILOCK_EXCL);
1440 fpos = XFS_FSB_TO_B(mp, map[1].br_startoff +
1442 flen = XFS_FSB_TO_B(mp, rlen);
1443 if (fpos + flen > isize)
1444 flen = isize - fpos;
1445 error = iomap_file_dirty(VFS_I(ip), fpos, flen,
1447 xfs_ilock(ip, XFS_ILOCK_EXCL);
1451 map[1].br_blockcount -= (rbno - agbno + rlen);
1452 map[1].br_startoff += (rbno - agbno + rlen);
1453 map[1].br_startblock += (rbno - agbno + rlen);
1457 fbno = map[0].br_startoff + map[0].br_blockcount;
1463 /* Does this inode need the reflink flag? */
1465 xfs_reflink_inode_has_shared_extents(
1466 struct xfs_trans *tp,
1467 struct xfs_inode *ip,
1470 struct xfs_bmbt_irec got;
1471 struct xfs_mount *mp = ip->i_mount;
1472 struct xfs_ifork *ifp;
1473 xfs_agnumber_t agno;
1474 xfs_agblock_t agbno;
1478 struct xfs_iext_cursor icur;
1482 ifp = XFS_IFORK_PTR(ip, XFS_DATA_FORK);
1483 if (!(ifp->if_flags & XFS_IFEXTENTS)) {
1484 error = xfs_iread_extents(tp, ip, XFS_DATA_FORK);
1489 *has_shared = false;
1490 found = xfs_iext_lookup_extent(ip, ifp, 0, &icur, &got);
1492 if (isnullstartblock(got.br_startblock) ||
1493 got.br_state != XFS_EXT_NORM)
1495 agno = XFS_FSB_TO_AGNO(mp, got.br_startblock);
1496 agbno = XFS_FSB_TO_AGBNO(mp, got.br_startblock);
1497 aglen = got.br_blockcount;
1499 error = xfs_reflink_find_shared(mp, tp, agno, agbno, aglen,
1500 &rbno, &rlen, false);
1503 /* Is there still a shared block here? */
1504 if (rbno != NULLAGBLOCK) {
1509 found = xfs_iext_next_extent(ifp, &icur, &got);
1516 * Clear the inode reflink flag if there are no shared extents.
1518 * The caller is responsible for joining the inode to the transaction passed in.
1519 * The inode will be joined to the transaction that is returned to the caller.
1522 xfs_reflink_clear_inode_flag(
1523 struct xfs_inode *ip,
1524 struct xfs_trans **tpp)
1529 ASSERT(xfs_is_reflink_inode(ip));
1531 error = xfs_reflink_inode_has_shared_extents(*tpp, ip, &needs_flag);
1532 if (error || needs_flag)
1536 * We didn't find any shared blocks so turn off the reflink flag.
1537 * First, get rid of any leftover CoW mappings.
1539 error = xfs_reflink_cancel_cow_blocks(ip, tpp, 0, NULLFILEOFF, true);
1543 /* Clear the inode flag. */
1544 trace_xfs_reflink_unset_inode_flag(ip);
1545 ip->i_d.di_flags2 &= ~XFS_DIFLAG2_REFLINK;
1546 xfs_inode_clear_cowblocks_tag(ip);
1547 xfs_trans_log_inode(*tpp, ip, XFS_ILOG_CORE);
1553 * Clear the inode reflink flag if there are no shared extents and the size
1557 xfs_reflink_try_clear_inode_flag(
1558 struct xfs_inode *ip)
1560 struct xfs_mount *mp = ip->i_mount;
1561 struct xfs_trans *tp;
1564 /* Start a rolling transaction to remove the mappings */
1565 error = xfs_trans_alloc(mp, &M_RES(mp)->tr_write, 0, 0, 0, &tp);
1569 xfs_ilock(ip, XFS_ILOCK_EXCL);
1570 xfs_trans_ijoin(tp, ip, 0);
1572 error = xfs_reflink_clear_inode_flag(ip, &tp);
1576 error = xfs_trans_commit(tp);
1580 xfs_iunlock(ip, XFS_ILOCK_EXCL);
1583 xfs_trans_cancel(tp);
1585 xfs_iunlock(ip, XFS_ILOCK_EXCL);
1590 * Pre-COW all shared blocks within a given byte range of a file and turn off
1591 * the reflink flag if we unshare all of the file's blocks.
1594 xfs_reflink_unshare(
1595 struct xfs_inode *ip,
1599 struct xfs_mount *mp = ip->i_mount;
1605 if (!xfs_is_reflink_inode(ip))
1608 trace_xfs_reflink_unshare(ip, offset, len);
1610 inode_dio_wait(VFS_I(ip));
1612 /* Try to CoW the selected ranges */
1613 xfs_ilock(ip, XFS_ILOCK_EXCL);
1614 fbno = XFS_B_TO_FSBT(mp, offset);
1615 isize = i_size_read(VFS_I(ip));
1616 end = XFS_B_TO_FSB(mp, offset + len);
1617 error = xfs_reflink_dirty_extents(ip, fbno, end, isize);
1620 xfs_iunlock(ip, XFS_ILOCK_EXCL);
1622 /* Wait for the IO to finish */
1623 error = filemap_write_and_wait(VFS_I(ip)->i_mapping);
1627 /* Turn off the reflink flag if possible. */
1628 error = xfs_reflink_try_clear_inode_flag(ip);
1635 xfs_iunlock(ip, XFS_ILOCK_EXCL);
1637 trace_xfs_reflink_unshare_error(ip, error, _RET_IP_);