xref: /openbmc/linux/fs/xfs/xfs_reflink.c (revision b78412b8)
1 /*
2  * Copyright (C) 2016 Oracle.  All Rights Reserved.
3  *
4  * Author: Darrick J. Wong <darrick.wong@oracle.com>
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it would be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write the Free Software Foundation,
18  * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA.
19  */
20 #include "xfs.h"
21 #include "xfs_fs.h"
22 #include "xfs_shared.h"
23 #include "xfs_format.h"
24 #include "xfs_log_format.h"
25 #include "xfs_trans_resv.h"
26 #include "xfs_mount.h"
27 #include "xfs_defer.h"
28 #include "xfs_da_format.h"
29 #include "xfs_da_btree.h"
30 #include "xfs_inode.h"
31 #include "xfs_trans.h"
32 #include "xfs_inode_item.h"
33 #include "xfs_bmap.h"
34 #include "xfs_bmap_util.h"
35 #include "xfs_error.h"
36 #include "xfs_dir2.h"
37 #include "xfs_dir2_priv.h"
38 #include "xfs_ioctl.h"
39 #include "xfs_trace.h"
40 #include "xfs_log.h"
41 #include "xfs_icache.h"
42 #include "xfs_pnfs.h"
43 #include "xfs_btree.h"
44 #include "xfs_refcount_btree.h"
45 #include "xfs_refcount.h"
46 #include "xfs_bmap_btree.h"
47 #include "xfs_trans_space.h"
48 #include "xfs_bit.h"
49 #include "xfs_alloc.h"
50 #include "xfs_quota_defs.h"
51 #include "xfs_quota.h"
52 #include "xfs_btree.h"
53 #include "xfs_bmap_btree.h"
54 #include "xfs_reflink.h"
55 #include "xfs_iomap.h"
56 #include "xfs_rmap_btree.h"
57 #include "xfs_sb.h"
58 #include "xfs_ag_resv.h"
59 
60 /*
61  * Copy on Write of Shared Blocks
62  *
63  * XFS must preserve "the usual" file semantics even when two files share
64  * the same physical blocks.  This means that a write to one file must not
65  * alter the blocks in a different file; the way that we'll do that is
66  * through the use of a copy-on-write mechanism.  At a high level, that
67  * means that when we want to write to a shared block, we allocate a new
68  * block, write the data to the new block, and if that succeeds we map the
69  * new block into the file.
70  *
71  * XFS provides a "delayed allocation" mechanism that defers the allocation
72  * of disk blocks to dirty-but-not-yet-mapped file blocks as long as
73  * possible.  This reduces fragmentation by enabling the filesystem to ask
74  * for bigger chunks less often, which is exactly what we want for CoW.
75  *
76  * The delalloc mechanism begins when the kernel wants to make a block
77  * writable (write_begin or page_mkwrite).  If the offset is not mapped, we
78  * create a delalloc mapping, which is a regular in-core extent, but without
79  * a real startblock.  (For delalloc mappings, the startblock encodes both
80  * a flag that this is a delalloc mapping, and a worst-case estimate of how
81  * many blocks might be required to put the mapping into the BMBT.)  delalloc
82  * mappings are a reservation against the free space in the filesystem;
83  * adjacent mappings can also be combined into fewer larger mappings.
84  *
85  * As an optimization, the CoW extent size hint (cowextsz) creates
86  * outsized aligned delalloc reservations in the hope of landing out of
87  * order nearby CoW writes in a single extent on disk, thereby reducing
88  * fragmentation and improving future performance.
89  *
90  * D: --RRRRRRSSSRRRRRRRR--- (data fork)
91  * C: ------DDDDDDD--------- (CoW fork)
92  *
93  * When dirty pages are being written out (typically in writepage), the
94  * delalloc reservations are converted into unwritten mappings by
95  * allocating blocks and replacing the delalloc mapping with real ones.
96  * A delalloc mapping can be replaced by several unwritten ones if the
97  * free space is fragmented.
98  *
99  * D: --RRRRRRSSSRRRRRRRR---
100  * C: ------UUUUUUU---------
101  *
102  * We want to adapt the delalloc mechanism for copy-on-write, since the
103  * write paths are similar.  The first two steps (creating the reservation
104  * and allocating the blocks) are exactly the same as delalloc except that
105  * the mappings must be stored in a separate CoW fork because we do not want
106  * to disturb the mapping in the data fork until we're sure that the write
107  * succeeded.  IO completion in this case is the process of removing the old
108  * mapping from the data fork and moving the new mapping from the CoW fork to
109  * the data fork.  This will be discussed shortly.
110  *
111  * For now, unaligned directio writes will be bounced back to the page cache.
112  * Block-aligned directio writes will use the same mechanism as buffered
113  * writes.
114  *
115  * Just prior to submitting the actual disk write requests, we convert
116  * the extents representing the range of the file actually being written
117  * (as opposed to extra pieces created for the cowextsize hint) to real
118  * extents.  This will become important in the next step:
119  *
120  * D: --RRRRRRSSSRRRRRRRR---
121  * C: ------UUrrUUU---------
122  *
123  * CoW remapping must be done after the data block write completes,
124  * because we don't want to destroy the old data fork map until we're sure
125  * the new block has been written.  Since the new mappings are kept in a
126  * separate fork, we can simply iterate these mappings to find the ones
127  * that cover the file blocks that we just CoW'd.  For each extent, simply
128  * unmap the corresponding range in the data fork, map the new range into
129  * the data fork, and remove the extent from the CoW fork.  Because of
130  * the presence of the cowextsize hint, however, we must be careful
131  * only to remap the blocks that we've actually written out --  we must
132  * never remap delalloc reservations nor CoW staging blocks that have
133  * yet to be written.  This corresponds exactly to the real extents in
134  * the CoW fork:
135  *
136  * D: --RRRRRRrrSRRRRRRRR---
137  * C: ------UU--UUU---------
138  *
139  * Since the remapping operation can be applied to an arbitrary file
140  * range, we record the need for the remap step as a flag in the ioend
141  * instead of declaring a new IO type.  This is required for direct io
142  * because we only have ioend for the whole dio, and we have to be able to
143  * remember the presence of unwritten blocks and CoW blocks with a single
144  * ioend structure.  Better yet, the more ground we can cover with one
145  * ioend, the better.
146  */
147 
148 /*
149  * Given an AG extent, find the lowest-numbered run of shared blocks
150  * within that range and return the range in fbno/flen.  If
151  * find_end_of_shared is true, return the longest contiguous extent of
152  * shared blocks.  If there are no shared extents, fbno and flen will
153  * be set to NULLAGBLOCK and 0, respectively.
154  */
155 int
156 xfs_reflink_find_shared(
157 	struct xfs_mount	*mp,
158 	struct xfs_trans	*tp,
159 	xfs_agnumber_t		agno,
160 	xfs_agblock_t		agbno,
161 	xfs_extlen_t		aglen,
162 	xfs_agblock_t		*fbno,
163 	xfs_extlen_t		*flen,
164 	bool			find_end_of_shared)
165 {
166 	struct xfs_buf		*agbp;
167 	struct xfs_btree_cur	*cur;
168 	int			error;
169 
170 	error = xfs_alloc_read_agf(mp, tp, agno, 0, &agbp);
171 	if (error)
172 		return error;
173 	if (!agbp)
174 		return -ENOMEM;
175 
176 	cur = xfs_refcountbt_init_cursor(mp, tp, agbp, agno, NULL);
177 
178 	error = xfs_refcount_find_shared(cur, agbno, aglen, fbno, flen,
179 			find_end_of_shared);
180 
181 	xfs_btree_del_cursor(cur, error ? XFS_BTREE_ERROR : XFS_BTREE_NOERROR);
182 
183 	xfs_trans_brelse(tp, agbp);
184 	return error;
185 }
186 
187 /*
188  * Trim the mapping to the next block where there's a change in the
189  * shared/unshared status.  More specifically, this means that we
190  * find the lowest-numbered extent of shared blocks that coincides with
191  * the given block mapping.  If the shared extent overlaps the start of
192  * the mapping, trim the mapping to the end of the shared extent.  If
193  * the shared region intersects the mapping, trim the mapping to the
194  * start of the shared extent.  If there are no shared regions that
195  * overlap, just return the original extent.
196  */
197 int
198 xfs_reflink_trim_around_shared(
199 	struct xfs_inode	*ip,
200 	struct xfs_bmbt_irec	*irec,
201 	bool			*shared,
202 	bool			*trimmed)
203 {
204 	xfs_agnumber_t		agno;
205 	xfs_agblock_t		agbno;
206 	xfs_extlen_t		aglen;
207 	xfs_agblock_t		fbno;
208 	xfs_extlen_t		flen;
209 	int			error = 0;
210 
211 	/* Holes, unwritten, and delalloc extents cannot be shared */
212 	if (!xfs_is_reflink_inode(ip) || !xfs_bmap_is_real_extent(irec)) {
213 		*shared = false;
214 		return 0;
215 	}
216 
217 	trace_xfs_reflink_trim_around_shared(ip, irec);
218 
219 	agno = XFS_FSB_TO_AGNO(ip->i_mount, irec->br_startblock);
220 	agbno = XFS_FSB_TO_AGBNO(ip->i_mount, irec->br_startblock);
221 	aglen = irec->br_blockcount;
222 
223 	error = xfs_reflink_find_shared(ip->i_mount, NULL, agno, agbno,
224 			aglen, &fbno, &flen, true);
225 	if (error)
226 		return error;
227 
228 	*shared = *trimmed = false;
229 	if (fbno == NULLAGBLOCK) {
230 		/* No shared blocks at all. */
231 		return 0;
232 	} else if (fbno == agbno) {
233 		/*
234 		 * The start of this extent is shared.  Truncate the
235 		 * mapping at the end of the shared region so that a
236 		 * subsequent iteration starts at the start of the
237 		 * unshared region.
238 		 */
239 		irec->br_blockcount = flen;
240 		*shared = true;
241 		if (flen != aglen)
242 			*trimmed = true;
243 		return 0;
244 	} else {
245 		/*
246 		 * There's a shared extent midway through this extent.
247 		 * Truncate the mapping at the start of the shared
248 		 * extent so that a subsequent iteration starts at the
249 		 * start of the shared region.
250 		 */
251 		irec->br_blockcount = fbno - agbno;
252 		*trimmed = true;
253 		return 0;
254 	}
255 }
256 
257 /*
258  * Trim the passed in imap to the next shared/unshared extent boundary, and
259  * if imap->br_startoff points to a shared extent reserve space for it in the
260  * COW fork.  In this case *shared is set to true, else to false.
261  *
262  * Note that imap will always contain the block numbers for the existing blocks
263  * in the data fork, as the upper layers need them for read-modify-write
264  * operations.
265  */
266 int
267 xfs_reflink_reserve_cow(
268 	struct xfs_inode	*ip,
269 	struct xfs_bmbt_irec	*imap,
270 	bool			*shared)
271 {
272 	struct xfs_ifork	*ifp = XFS_IFORK_PTR(ip, XFS_COW_FORK);
273 	struct xfs_bmbt_irec	got;
274 	int			error = 0;
275 	bool			eof = false, trimmed;
276 	xfs_extnum_t		idx;
277 
278 	/*
279 	 * Search the COW fork extent list first.  This serves two purposes:
280 	 * first this implement the speculative preallocation using cowextisze,
281 	 * so that we also unshared block adjacent to shared blocks instead
282 	 * of just the shared blocks themselves.  Second the lookup in the
283 	 * extent list is generally faster than going out to the shared extent
284 	 * tree.
285 	 */
286 
287 	if (!xfs_iext_lookup_extent(ip, ifp, imap->br_startoff, &idx, &got))
288 		eof = true;
289 	if (!eof && got.br_startoff <= imap->br_startoff) {
290 		trace_xfs_reflink_cow_found(ip, imap);
291 		xfs_trim_extent(imap, got.br_startoff, got.br_blockcount);
292 
293 		*shared = true;
294 		return 0;
295 	}
296 
297 	/* Trim the mapping to the nearest shared extent boundary. */
298 	error = xfs_reflink_trim_around_shared(ip, imap, shared, &trimmed);
299 	if (error)
300 		return error;
301 
302 	/* Not shared?  Just report the (potentially capped) extent. */
303 	if (!*shared)
304 		return 0;
305 
306 	/*
307 	 * Fork all the shared blocks from our write offset until the end of
308 	 * the extent.
309 	 */
310 	error = xfs_qm_dqattach_locked(ip, 0);
311 	if (error)
312 		return error;
313 
314 	error = xfs_bmapi_reserve_delalloc(ip, XFS_COW_FORK, imap->br_startoff,
315 			imap->br_blockcount, 0, &got, &idx, eof);
316 	if (error == -ENOSPC || error == -EDQUOT)
317 		trace_xfs_reflink_cow_enospc(ip, imap);
318 	if (error)
319 		return error;
320 
321 	trace_xfs_reflink_cow_alloc(ip, &got);
322 	return 0;
323 }
324 
325 /* Convert part of an unwritten CoW extent to a real one. */
326 STATIC int
327 xfs_reflink_convert_cow_extent(
328 	struct xfs_inode		*ip,
329 	struct xfs_bmbt_irec		*imap,
330 	xfs_fileoff_t			offset_fsb,
331 	xfs_filblks_t			count_fsb,
332 	struct xfs_defer_ops		*dfops)
333 {
334 	xfs_fsblock_t			first_block = NULLFSBLOCK;
335 	int				nimaps = 1;
336 
337 	if (imap->br_state == XFS_EXT_NORM)
338 		return 0;
339 
340 	xfs_trim_extent(imap, offset_fsb, count_fsb);
341 	trace_xfs_reflink_convert_cow(ip, imap);
342 	if (imap->br_blockcount == 0)
343 		return 0;
344 	return xfs_bmapi_write(NULL, ip, imap->br_startoff, imap->br_blockcount,
345 			XFS_BMAPI_COWFORK | XFS_BMAPI_CONVERT, &first_block,
346 			0, imap, &nimaps, dfops);
347 }
348 
349 /* Convert all of the unwritten CoW extents in a file's range to real ones. */
350 int
351 xfs_reflink_convert_cow(
352 	struct xfs_inode	*ip,
353 	xfs_off_t		offset,
354 	xfs_off_t		count)
355 {
356 	struct xfs_bmbt_irec	got;
357 	struct xfs_defer_ops	dfops;
358 	struct xfs_mount	*mp = ip->i_mount;
359 	struct xfs_ifork	*ifp = XFS_IFORK_PTR(ip, XFS_COW_FORK);
360 	xfs_fileoff_t		offset_fsb = XFS_B_TO_FSBT(mp, offset);
361 	xfs_fileoff_t		end_fsb = XFS_B_TO_FSB(mp, offset + count);
362 	xfs_extnum_t		idx;
363 	bool			found;
364 	int			error = 0;
365 
366 	xfs_ilock(ip, XFS_ILOCK_EXCL);
367 
368 	/* Convert all the extents to real from unwritten. */
369 	for (found = xfs_iext_lookup_extent(ip, ifp, offset_fsb, &idx, &got);
370 	     found && got.br_startoff < end_fsb;
371 	     found = xfs_iext_get_extent(ifp, ++idx, &got)) {
372 		error = xfs_reflink_convert_cow_extent(ip, &got, offset_fsb,
373 				end_fsb - offset_fsb, &dfops);
374 		if (error)
375 			break;
376 	}
377 
378 	/* Finish up. */
379 	xfs_iunlock(ip, XFS_ILOCK_EXCL);
380 	return error;
381 }
382 
383 /* Allocate all CoW reservations covering a range of blocks in a file. */
384 int
385 xfs_reflink_allocate_cow(
386 	struct xfs_inode	*ip,
387 	struct xfs_bmbt_irec	*imap,
388 	bool			*shared,
389 	uint			*lockmode)
390 {
391 	struct xfs_mount	*mp = ip->i_mount;
392 	xfs_fileoff_t		offset_fsb = imap->br_startoff;
393 	xfs_filblks_t		count_fsb = imap->br_blockcount;
394 	struct xfs_bmbt_irec	got;
395 	struct xfs_defer_ops	dfops;
396 	struct xfs_trans	*tp = NULL;
397 	xfs_fsblock_t		first_block;
398 	int			nimaps, error = 0;
399 	bool			trimmed;
400 	xfs_filblks_t		resaligned;
401 	xfs_extlen_t		resblks = 0;
402 	xfs_extnum_t		idx;
403 
404 retry:
405 	ASSERT(xfs_is_reflink_inode(ip));
406 	ASSERT(xfs_isilocked(ip, XFS_ILOCK_EXCL | XFS_ILOCK_SHARED));
407 
408 	/*
409 	 * Even if the extent is not shared we might have a preallocation for
410 	 * it in the COW fork.  If so use it.
411 	 */
412 	if (xfs_iext_lookup_extent(ip, ip->i_cowfp, offset_fsb, &idx, &got) &&
413 	    got.br_startoff <= offset_fsb) {
414 		*shared = true;
415 
416 		/* If we have a real allocation in the COW fork we're done. */
417 		if (!isnullstartblock(got.br_startblock)) {
418 			xfs_trim_extent(&got, offset_fsb, count_fsb);
419 			*imap = got;
420 			goto convert;
421 		}
422 
423 		xfs_trim_extent(imap, got.br_startoff, got.br_blockcount);
424 	} else {
425 		error = xfs_reflink_trim_around_shared(ip, imap, shared, &trimmed);
426 		if (error || !*shared)
427 			goto out;
428 	}
429 
430 	if (!tp) {
431 		resaligned = xfs_aligned_fsb_count(imap->br_startoff,
432 			imap->br_blockcount, xfs_get_cowextsz_hint(ip));
433 		resblks = XFS_DIOSTRAT_SPACE_RES(mp, resaligned);
434 
435 		xfs_iunlock(ip, *lockmode);
436 		error = xfs_trans_alloc(mp, &M_RES(mp)->tr_write, resblks, 0, 0, &tp);
437 		*lockmode = XFS_ILOCK_EXCL;
438 		xfs_ilock(ip, *lockmode);
439 
440 		if (error)
441 			return error;
442 
443 		error = xfs_qm_dqattach_locked(ip, 0);
444 		if (error)
445 			goto out;
446 		goto retry;
447 	}
448 
449 	error = xfs_trans_reserve_quota_nblks(tp, ip, resblks, 0,
450 			XFS_QMOPT_RES_REGBLKS);
451 	if (error)
452 		goto out;
453 
454 	xfs_trans_ijoin(tp, ip, 0);
455 
456 	xfs_defer_init(&dfops, &first_block);
457 	nimaps = 1;
458 
459 	/* Allocate the entire reservation as unwritten blocks. */
460 	error = xfs_bmapi_write(tp, ip, imap->br_startoff, imap->br_blockcount,
461 			XFS_BMAPI_COWFORK | XFS_BMAPI_PREALLOC, &first_block,
462 			resblks, imap, &nimaps, &dfops);
463 	if (error)
464 		goto out_bmap_cancel;
465 
466 	/* Finish up. */
467 	error = xfs_defer_finish(&tp, &dfops);
468 	if (error)
469 		goto out_bmap_cancel;
470 
471 	error = xfs_trans_commit(tp);
472 	if (error)
473 		return error;
474 convert:
475 	return xfs_reflink_convert_cow_extent(ip, imap, offset_fsb, count_fsb,
476 			&dfops);
477 out_bmap_cancel:
478 	xfs_defer_cancel(&dfops);
479 	xfs_trans_unreserve_quota_nblks(tp, ip, (long)resblks, 0,
480 			XFS_QMOPT_RES_REGBLKS);
481 out:
482 	if (tp)
483 		xfs_trans_cancel(tp);
484 	return error;
485 }
486 
487 /*
488  * Find the CoW reservation for a given byte offset of a file.
489  */
490 bool
491 xfs_reflink_find_cow_mapping(
492 	struct xfs_inode		*ip,
493 	xfs_off_t			offset,
494 	struct xfs_bmbt_irec		*imap)
495 {
496 	struct xfs_ifork		*ifp = XFS_IFORK_PTR(ip, XFS_COW_FORK);
497 	xfs_fileoff_t			offset_fsb;
498 	struct xfs_bmbt_irec		got;
499 	xfs_extnum_t			idx;
500 
501 	ASSERT(xfs_isilocked(ip, XFS_ILOCK_EXCL | XFS_ILOCK_SHARED));
502 	ASSERT(xfs_is_reflink_inode(ip));
503 
504 	offset_fsb = XFS_B_TO_FSBT(ip->i_mount, offset);
505 	if (!xfs_iext_lookup_extent(ip, ifp, offset_fsb, &idx, &got))
506 		return false;
507 	if (got.br_startoff > offset_fsb)
508 		return false;
509 
510 	trace_xfs_reflink_find_cow_mapping(ip, offset, 1, XFS_IO_OVERWRITE,
511 			&got);
512 	*imap = got;
513 	return true;
514 }
515 
516 /*
517  * Trim an extent to end at the next CoW reservation past offset_fsb.
518  */
519 void
520 xfs_reflink_trim_irec_to_next_cow(
521 	struct xfs_inode		*ip,
522 	xfs_fileoff_t			offset_fsb,
523 	struct xfs_bmbt_irec		*imap)
524 {
525 	struct xfs_ifork		*ifp = XFS_IFORK_PTR(ip, XFS_COW_FORK);
526 	struct xfs_bmbt_irec		got;
527 	xfs_extnum_t			idx;
528 
529 	if (!xfs_is_reflink_inode(ip))
530 		return;
531 
532 	/* Find the extent in the CoW fork. */
533 	if (!xfs_iext_lookup_extent(ip, ifp, offset_fsb, &idx, &got))
534 		return;
535 
536 	/* This is the extent before; try sliding up one. */
537 	if (got.br_startoff < offset_fsb) {
538 		if (!xfs_iext_get_extent(ifp, idx + 1, &got))
539 			return;
540 	}
541 
542 	if (got.br_startoff >= imap->br_startoff + imap->br_blockcount)
543 		return;
544 
545 	imap->br_blockcount = got.br_startoff - imap->br_startoff;
546 	trace_xfs_reflink_trim_irec(ip, imap);
547 }
548 
549 /*
550  * Cancel CoW reservations for some block range of an inode.
551  *
552  * If cancel_real is true this function cancels all COW fork extents for the
553  * inode; if cancel_real is false, real extents are not cleared.
554  */
555 int
556 xfs_reflink_cancel_cow_blocks(
557 	struct xfs_inode		*ip,
558 	struct xfs_trans		**tpp,
559 	xfs_fileoff_t			offset_fsb,
560 	xfs_fileoff_t			end_fsb,
561 	bool				cancel_real)
562 {
563 	struct xfs_ifork		*ifp = XFS_IFORK_PTR(ip, XFS_COW_FORK);
564 	struct xfs_bmbt_irec		got, del;
565 	xfs_extnum_t			idx;
566 	xfs_fsblock_t			firstfsb;
567 	struct xfs_defer_ops		dfops;
568 	int				error = 0;
569 
570 	if (!xfs_is_reflink_inode(ip))
571 		return 0;
572 	if (!xfs_iext_lookup_extent(ip, ifp, offset_fsb, &idx, &got))
573 		return 0;
574 
575 	while (got.br_startoff < end_fsb) {
576 		del = got;
577 		xfs_trim_extent(&del, offset_fsb, end_fsb - offset_fsb);
578 		trace_xfs_reflink_cancel_cow(ip, &del);
579 
580 		if (isnullstartblock(del.br_startblock)) {
581 			error = xfs_bmap_del_extent_delay(ip, XFS_COW_FORK,
582 					&idx, &got, &del);
583 			if (error)
584 				break;
585 		} else if (del.br_state == XFS_EXT_UNWRITTEN || cancel_real) {
586 			xfs_trans_ijoin(*tpp, ip, 0);
587 			xfs_defer_init(&dfops, &firstfsb);
588 
589 			/* Free the CoW orphan record. */
590 			error = xfs_refcount_free_cow_extent(ip->i_mount,
591 					&dfops, del.br_startblock,
592 					del.br_blockcount);
593 			if (error)
594 				break;
595 
596 			xfs_bmap_add_free(ip->i_mount, &dfops,
597 					del.br_startblock, del.br_blockcount,
598 					NULL);
599 
600 			/* Update quota accounting */
601 			xfs_trans_mod_dquot_byino(*tpp, ip, XFS_TRANS_DQ_BCOUNT,
602 					-(long)del.br_blockcount);
603 
604 			/* Roll the transaction */
605 			xfs_defer_ijoin(&dfops, ip);
606 			error = xfs_defer_finish(tpp, &dfops);
607 			if (error) {
608 				xfs_defer_cancel(&dfops);
609 				break;
610 			}
611 
612 			/* Remove the mapping from the CoW fork. */
613 			xfs_bmap_del_extent_cow(ip, &idx, &got, &del);
614 		}
615 
616 		if (!xfs_iext_get_extent(ifp, ++idx, &got))
617 			break;
618 	}
619 
620 	/* clear tag if cow fork is emptied */
621 	if (!ifp->if_bytes)
622 		xfs_inode_clear_cowblocks_tag(ip);
623 
624 	return error;
625 }
626 
627 /*
628  * Cancel CoW reservations for some byte range of an inode.
629  *
630  * If cancel_real is true this function cancels all COW fork extents for the
631  * inode; if cancel_real is false, real extents are not cleared.
632  */
633 int
634 xfs_reflink_cancel_cow_range(
635 	struct xfs_inode	*ip,
636 	xfs_off_t		offset,
637 	xfs_off_t		count,
638 	bool			cancel_real)
639 {
640 	struct xfs_trans	*tp;
641 	xfs_fileoff_t		offset_fsb;
642 	xfs_fileoff_t		end_fsb;
643 	int			error;
644 
645 	trace_xfs_reflink_cancel_cow_range(ip, offset, count);
646 	ASSERT(xfs_is_reflink_inode(ip));
647 
648 	offset_fsb = XFS_B_TO_FSBT(ip->i_mount, offset);
649 	if (count == NULLFILEOFF)
650 		end_fsb = NULLFILEOFF;
651 	else
652 		end_fsb = XFS_B_TO_FSB(ip->i_mount, offset + count);
653 
654 	/* Start a rolling transaction to remove the mappings */
655 	error = xfs_trans_alloc(ip->i_mount, &M_RES(ip->i_mount)->tr_write,
656 			0, 0, 0, &tp);
657 	if (error)
658 		goto out;
659 
660 	xfs_ilock(ip, XFS_ILOCK_EXCL);
661 	xfs_trans_ijoin(tp, ip, 0);
662 
663 	/* Scrape out the old CoW reservations */
664 	error = xfs_reflink_cancel_cow_blocks(ip, &tp, offset_fsb, end_fsb,
665 			cancel_real);
666 	if (error)
667 		goto out_cancel;
668 
669 	error = xfs_trans_commit(tp);
670 
671 	xfs_iunlock(ip, XFS_ILOCK_EXCL);
672 	return error;
673 
674 out_cancel:
675 	xfs_trans_cancel(tp);
676 	xfs_iunlock(ip, XFS_ILOCK_EXCL);
677 out:
678 	trace_xfs_reflink_cancel_cow_range_error(ip, error, _RET_IP_);
679 	return error;
680 }
681 
682 /*
683  * Remap parts of a file's data fork after a successful CoW.
684  */
685 int
686 xfs_reflink_end_cow(
687 	struct xfs_inode		*ip,
688 	xfs_off_t			offset,
689 	xfs_off_t			count)
690 {
691 	struct xfs_ifork		*ifp = XFS_IFORK_PTR(ip, XFS_COW_FORK);
692 	struct xfs_bmbt_irec		got, del;
693 	struct xfs_trans		*tp;
694 	xfs_fileoff_t			offset_fsb;
695 	xfs_fileoff_t			end_fsb;
696 	xfs_fsblock_t			firstfsb;
697 	struct xfs_defer_ops		dfops;
698 	int				error;
699 	unsigned int			resblks;
700 	xfs_filblks_t			rlen;
701 	xfs_extnum_t			idx;
702 
703 	trace_xfs_reflink_end_cow(ip, offset, count);
704 
705 	/* No COW extents?  That's easy! */
706 	if (ifp->if_bytes == 0)
707 		return 0;
708 
709 	offset_fsb = XFS_B_TO_FSBT(ip->i_mount, offset);
710 	end_fsb = XFS_B_TO_FSB(ip->i_mount, offset + count);
711 
712 	/*
713 	 * Start a rolling transaction to switch the mappings.  We're
714 	 * unlikely ever to have to remap 16T worth of single-block
715 	 * extents, so just cap the worst case extent count to 2^32-1.
716 	 * Stick a warning in just in case, and avoid 64-bit division.
717 	 */
718 	BUILD_BUG_ON(MAX_RW_COUNT > UINT_MAX);
719 	if (end_fsb - offset_fsb > UINT_MAX) {
720 		error = -EFSCORRUPTED;
721 		xfs_force_shutdown(ip->i_mount, SHUTDOWN_CORRUPT_INCORE);
722 		ASSERT(0);
723 		goto out;
724 	}
725 	resblks = XFS_NEXTENTADD_SPACE_RES(ip->i_mount,
726 			(unsigned int)(end_fsb - offset_fsb),
727 			XFS_DATA_FORK);
728 	error = xfs_trans_alloc(ip->i_mount, &M_RES(ip->i_mount)->tr_write,
729 			resblks, 0, 0, &tp);
730 	if (error)
731 		goto out;
732 
733 	xfs_ilock(ip, XFS_ILOCK_EXCL);
734 	xfs_trans_ijoin(tp, ip, 0);
735 
736 	/* If there is a hole at end_fsb - 1 go to the previous extent */
737 	if (!xfs_iext_lookup_extent(ip, ifp, end_fsb - 1, &idx, &got) ||
738 	    got.br_startoff > end_fsb) {
739 		ASSERT(idx > 0);
740 		xfs_iext_get_extent(ifp, --idx, &got);
741 	}
742 
743 	/* Walk backwards until we're out of the I/O range... */
744 	while (got.br_startoff + got.br_blockcount > offset_fsb) {
745 		del = got;
746 		xfs_trim_extent(&del, offset_fsb, end_fsb - offset_fsb);
747 
748 		/* Extent delete may have bumped idx forward */
749 		if (!del.br_blockcount) {
750 			idx--;
751 			goto next_extent;
752 		}
753 
754 		ASSERT(!isnullstartblock(got.br_startblock));
755 
756 		/*
757 		 * Don't remap unwritten extents; these are
758 		 * speculatively preallocated CoW extents that have been
759 		 * allocated but have not yet been involved in a write.
760 		 */
761 		if (got.br_state == XFS_EXT_UNWRITTEN) {
762 			idx--;
763 			goto next_extent;
764 		}
765 
766 		/* Unmap the old blocks in the data fork. */
767 		xfs_defer_init(&dfops, &firstfsb);
768 		rlen = del.br_blockcount;
769 		error = __xfs_bunmapi(tp, ip, del.br_startoff, &rlen, 0, 1,
770 				&firstfsb, &dfops);
771 		if (error)
772 			goto out_defer;
773 
774 		/* Trim the extent to whatever got unmapped. */
775 		if (rlen) {
776 			xfs_trim_extent(&del, del.br_startoff + rlen,
777 				del.br_blockcount - rlen);
778 		}
779 		trace_xfs_reflink_cow_remap(ip, &del);
780 
781 		/* Free the CoW orphan record. */
782 		error = xfs_refcount_free_cow_extent(tp->t_mountp, &dfops,
783 				del.br_startblock, del.br_blockcount);
784 		if (error)
785 			goto out_defer;
786 
787 		/* Map the new blocks into the data fork. */
788 		error = xfs_bmap_map_extent(tp->t_mountp, &dfops, ip, &del);
789 		if (error)
790 			goto out_defer;
791 
792 		/* Remove the mapping from the CoW fork. */
793 		xfs_bmap_del_extent_cow(ip, &idx, &got, &del);
794 
795 		xfs_defer_ijoin(&dfops, ip);
796 		error = xfs_defer_finish(&tp, &dfops);
797 		if (error)
798 			goto out_defer;
799 next_extent:
800 		if (!xfs_iext_get_extent(ifp, idx, &got))
801 			break;
802 	}
803 
804 	error = xfs_trans_commit(tp);
805 	xfs_iunlock(ip, XFS_ILOCK_EXCL);
806 	if (error)
807 		goto out;
808 	return 0;
809 
810 out_defer:
811 	xfs_defer_cancel(&dfops);
812 	xfs_trans_cancel(tp);
813 	xfs_iunlock(ip, XFS_ILOCK_EXCL);
814 out:
815 	trace_xfs_reflink_end_cow_error(ip, error, _RET_IP_);
816 	return error;
817 }
818 
819 /*
820  * Free leftover CoW reservations that didn't get cleaned out.
821  */
822 int
823 xfs_reflink_recover_cow(
824 	struct xfs_mount	*mp)
825 {
826 	xfs_agnumber_t		agno;
827 	int			error = 0;
828 
829 	if (!xfs_sb_version_hasreflink(&mp->m_sb))
830 		return 0;
831 
832 	for (agno = 0; agno < mp->m_sb.sb_agcount; agno++) {
833 		error = xfs_refcount_recover_cow_leftovers(mp, agno);
834 		if (error)
835 			break;
836 	}
837 
838 	return error;
839 }
840 
841 /*
842  * Reflinking (Block) Ranges of Two Files Together
843  *
844  * First, ensure that the reflink flag is set on both inodes.  The flag is an
845  * optimization to avoid unnecessary refcount btree lookups in the write path.
846  *
847  * Now we can iteratively remap the range of extents (and holes) in src to the
848  * corresponding ranges in dest.  Let drange and srange denote the ranges of
849  * logical blocks in dest and src touched by the reflink operation.
850  *
851  * While the length of drange is greater than zero,
852  *    - Read src's bmbt at the start of srange ("imap")
853  *    - If imap doesn't exist, make imap appear to start at the end of srange
854  *      with zero length.
855  *    - If imap starts before srange, advance imap to start at srange.
856  *    - If imap goes beyond srange, truncate imap to end at the end of srange.
857  *    - Punch (imap start - srange start + imap len) blocks from dest at
858  *      offset (drange start).
859  *    - If imap points to a real range of pblks,
860  *         > Increase the refcount of the imap's pblks
861  *         > Map imap's pblks into dest at the offset
862  *           (drange start + imap start - srange start)
863  *    - Advance drange and srange by (imap start - srange start + imap len)
864  *
865  * Finally, if the reflink made dest longer, update both the in-core and
866  * on-disk file sizes.
867  *
868  * ASCII Art Demonstration:
869  *
870  * Let's say we want to reflink this source file:
871  *
872  * ----SSSSSSS-SSSSS----SSSSSS (src file)
873  *   <-------------------->
874  *
875  * into this destination file:
876  *
877  * --DDDDDDDDDDDDDDDDDDD--DDD (dest file)
878  *        <-------------------->
879  * '-' means a hole, and 'S' and 'D' are written blocks in the src and dest.
880  * Observe that the range has different logical offsets in either file.
881  *
882  * Consider that the first extent in the source file doesn't line up with our
883  * reflink range.  Unmapping  and remapping are separate operations, so we can
884  * unmap more blocks from the destination file than we remap.
885  *
886  * ----SSSSSSS-SSSSS----SSSSSS
887  *   <------->
888  * --DDDDD---------DDDDD--DDD
889  *        <------->
890  *
891  * Now remap the source extent into the destination file:
892  *
893  * ----SSSSSSS-SSSSS----SSSSSS
894  *   <------->
895  * --DDDDD--SSSSSSSDDDDD--DDD
896  *        <------->
897  *
898  * Do likewise with the second hole and extent in our range.  Holes in the
899  * unmap range don't affect our operation.
900  *
901  * ----SSSSSSS-SSSSS----SSSSSS
902  *            <---->
903  * --DDDDD--SSSSSSS-SSSSS-DDD
904  *                 <---->
905  *
906  * Finally, unmap and remap part of the third extent.  This will increase the
907  * size of the destination file.
908  *
909  * ----SSSSSSS-SSSSS----SSSSSS
910  *                  <----->
911  * --DDDDD--SSSSSSS-SSSSS----SSS
912  *                       <----->
913  *
914  * Once we update the destination file's i_size, we're done.
915  */
916 
917 /*
918  * Ensure the reflink bit is set in both inodes.
919  */
920 STATIC int
921 xfs_reflink_set_inode_flag(
922 	struct xfs_inode	*src,
923 	struct xfs_inode	*dest)
924 {
925 	struct xfs_mount	*mp = src->i_mount;
926 	int			error;
927 	struct xfs_trans	*tp;
928 
929 	if (xfs_is_reflink_inode(src) && xfs_is_reflink_inode(dest))
930 		return 0;
931 
932 	error = xfs_trans_alloc(mp, &M_RES(mp)->tr_ichange, 0, 0, 0, &tp);
933 	if (error)
934 		goto out_error;
935 
936 	/* Lock both files against IO */
937 	if (src->i_ino == dest->i_ino)
938 		xfs_ilock(src, XFS_ILOCK_EXCL);
939 	else
940 		xfs_lock_two_inodes(src, dest, XFS_ILOCK_EXCL);
941 
942 	if (!xfs_is_reflink_inode(src)) {
943 		trace_xfs_reflink_set_inode_flag(src);
944 		xfs_trans_ijoin(tp, src, XFS_ILOCK_EXCL);
945 		src->i_d.di_flags2 |= XFS_DIFLAG2_REFLINK;
946 		xfs_trans_log_inode(tp, src, XFS_ILOG_CORE);
947 		xfs_ifork_init_cow(src);
948 	} else
949 		xfs_iunlock(src, XFS_ILOCK_EXCL);
950 
951 	if (src->i_ino == dest->i_ino)
952 		goto commit_flags;
953 
954 	if (!xfs_is_reflink_inode(dest)) {
955 		trace_xfs_reflink_set_inode_flag(dest);
956 		xfs_trans_ijoin(tp, dest, XFS_ILOCK_EXCL);
957 		dest->i_d.di_flags2 |= XFS_DIFLAG2_REFLINK;
958 		xfs_trans_log_inode(tp, dest, XFS_ILOG_CORE);
959 		xfs_ifork_init_cow(dest);
960 	} else
961 		xfs_iunlock(dest, XFS_ILOCK_EXCL);
962 
963 commit_flags:
964 	error = xfs_trans_commit(tp);
965 	if (error)
966 		goto out_error;
967 	return error;
968 
969 out_error:
970 	trace_xfs_reflink_set_inode_flag_error(dest, error, _RET_IP_);
971 	return error;
972 }
973 
974 /*
975  * Update destination inode size & cowextsize hint, if necessary.
976  */
977 STATIC int
978 xfs_reflink_update_dest(
979 	struct xfs_inode	*dest,
980 	xfs_off_t		newlen,
981 	xfs_extlen_t		cowextsize,
982 	bool			is_dedupe)
983 {
984 	struct xfs_mount	*mp = dest->i_mount;
985 	struct xfs_trans	*tp;
986 	int			error;
987 
988 	if (is_dedupe && newlen <= i_size_read(VFS_I(dest)) && cowextsize == 0)
989 		return 0;
990 
991 	error = xfs_trans_alloc(mp, &M_RES(mp)->tr_ichange, 0, 0, 0, &tp);
992 	if (error)
993 		goto out_error;
994 
995 	xfs_ilock(dest, XFS_ILOCK_EXCL);
996 	xfs_trans_ijoin(tp, dest, XFS_ILOCK_EXCL);
997 
998 	if (newlen > i_size_read(VFS_I(dest))) {
999 		trace_xfs_reflink_update_inode_size(dest, newlen);
1000 		i_size_write(VFS_I(dest), newlen);
1001 		dest->i_d.di_size = newlen;
1002 	}
1003 
1004 	if (cowextsize) {
1005 		dest->i_d.di_cowextsize = cowextsize;
1006 		dest->i_d.di_flags2 |= XFS_DIFLAG2_COWEXTSIZE;
1007 	}
1008 
1009 	if (!is_dedupe) {
1010 		xfs_trans_ichgtime(tp, dest,
1011 				   XFS_ICHGTIME_MOD | XFS_ICHGTIME_CHG);
1012 	}
1013 	xfs_trans_log_inode(tp, dest, XFS_ILOG_CORE);
1014 
1015 	error = xfs_trans_commit(tp);
1016 	if (error)
1017 		goto out_error;
1018 	return error;
1019 
1020 out_error:
1021 	trace_xfs_reflink_update_inode_size_error(dest, error, _RET_IP_);
1022 	return error;
1023 }
1024 
1025 /*
1026  * Do we have enough reserve in this AG to handle a reflink?  The refcount
1027  * btree already reserved all the space it needs, but the rmap btree can grow
1028  * infinitely, so we won't allow more reflinks when the AG is down to the
1029  * btree reserves.
1030  */
1031 static int
1032 xfs_reflink_ag_has_free_space(
1033 	struct xfs_mount	*mp,
1034 	xfs_agnumber_t		agno)
1035 {
1036 	struct xfs_perag	*pag;
1037 	int			error = 0;
1038 
1039 	if (!xfs_sb_version_hasrmapbt(&mp->m_sb))
1040 		return 0;
1041 
1042 	pag = xfs_perag_get(mp, agno);
1043 	if (xfs_ag_resv_critical(pag, XFS_AG_RESV_AGFL) ||
1044 	    xfs_ag_resv_critical(pag, XFS_AG_RESV_METADATA))
1045 		error = -ENOSPC;
1046 	xfs_perag_put(pag);
1047 	return error;
1048 }
1049 
1050 /*
1051  * Unmap a range of blocks from a file, then map other blocks into the hole.
1052  * The range to unmap is (destoff : destoff + srcioff + irec->br_blockcount).
1053  * The extent irec is mapped into dest at irec->br_startoff.
1054  */
1055 STATIC int
1056 xfs_reflink_remap_extent(
1057 	struct xfs_inode	*ip,
1058 	struct xfs_bmbt_irec	*irec,
1059 	xfs_fileoff_t		destoff,
1060 	xfs_off_t		new_isize)
1061 {
1062 	struct xfs_mount	*mp = ip->i_mount;
1063 	bool			real_extent = xfs_bmap_is_real_extent(irec);
1064 	struct xfs_trans	*tp;
1065 	xfs_fsblock_t		firstfsb;
1066 	unsigned int		resblks;
1067 	struct xfs_defer_ops	dfops;
1068 	struct xfs_bmbt_irec	uirec;
1069 	xfs_filblks_t		rlen;
1070 	xfs_filblks_t		unmap_len;
1071 	xfs_off_t		newlen;
1072 	int			error;
1073 
1074 	unmap_len = irec->br_startoff + irec->br_blockcount - destoff;
1075 	trace_xfs_reflink_punch_range(ip, destoff, unmap_len);
1076 
1077 	/* No reflinking if we're low on space */
1078 	if (real_extent) {
1079 		error = xfs_reflink_ag_has_free_space(mp,
1080 				XFS_FSB_TO_AGNO(mp, irec->br_startblock));
1081 		if (error)
1082 			goto out;
1083 	}
1084 
1085 	/* Start a rolling transaction to switch the mappings */
1086 	resblks = XFS_EXTENTADD_SPACE_RES(ip->i_mount, XFS_DATA_FORK);
1087 	error = xfs_trans_alloc(mp, &M_RES(mp)->tr_write, resblks, 0, 0, &tp);
1088 	if (error)
1089 		goto out;
1090 
1091 	xfs_ilock(ip, XFS_ILOCK_EXCL);
1092 	xfs_trans_ijoin(tp, ip, 0);
1093 
1094 	/* If we're not just clearing space, then do we have enough quota? */
1095 	if (real_extent) {
1096 		error = xfs_trans_reserve_quota_nblks(tp, ip,
1097 				irec->br_blockcount, 0, XFS_QMOPT_RES_REGBLKS);
1098 		if (error)
1099 			goto out_cancel;
1100 	}
1101 
1102 	trace_xfs_reflink_remap(ip, irec->br_startoff,
1103 				irec->br_blockcount, irec->br_startblock);
1104 
1105 	/* Unmap the old blocks in the data fork. */
1106 	rlen = unmap_len;
1107 	while (rlen) {
1108 		xfs_defer_init(&dfops, &firstfsb);
1109 		error = __xfs_bunmapi(tp, ip, destoff, &rlen, 0, 1,
1110 				&firstfsb, &dfops);
1111 		if (error)
1112 			goto out_defer;
1113 
1114 		/*
1115 		 * Trim the extent to whatever got unmapped.
1116 		 * Remember, bunmapi works backwards.
1117 		 */
1118 		uirec.br_startblock = irec->br_startblock + rlen;
1119 		uirec.br_startoff = irec->br_startoff + rlen;
1120 		uirec.br_blockcount = unmap_len - rlen;
1121 		unmap_len = rlen;
1122 
1123 		/* If this isn't a real mapping, we're done. */
1124 		if (!real_extent || uirec.br_blockcount == 0)
1125 			goto next_extent;
1126 
1127 		trace_xfs_reflink_remap(ip, uirec.br_startoff,
1128 				uirec.br_blockcount, uirec.br_startblock);
1129 
1130 		/* Update the refcount tree */
1131 		error = xfs_refcount_increase_extent(mp, &dfops, &uirec);
1132 		if (error)
1133 			goto out_defer;
1134 
1135 		/* Map the new blocks into the data fork. */
1136 		error = xfs_bmap_map_extent(mp, &dfops, ip, &uirec);
1137 		if (error)
1138 			goto out_defer;
1139 
1140 		/* Update quota accounting. */
1141 		xfs_trans_mod_dquot_byino(tp, ip, XFS_TRANS_DQ_BCOUNT,
1142 				uirec.br_blockcount);
1143 
1144 		/* Update dest isize if needed. */
1145 		newlen = XFS_FSB_TO_B(mp,
1146 				uirec.br_startoff + uirec.br_blockcount);
1147 		newlen = min_t(xfs_off_t, newlen, new_isize);
1148 		if (newlen > i_size_read(VFS_I(ip))) {
1149 			trace_xfs_reflink_update_inode_size(ip, newlen);
1150 			i_size_write(VFS_I(ip), newlen);
1151 			ip->i_d.di_size = newlen;
1152 			xfs_trans_log_inode(tp, ip, XFS_ILOG_CORE);
1153 		}
1154 
1155 next_extent:
1156 		/* Process all the deferred stuff. */
1157 		xfs_defer_ijoin(&dfops, ip);
1158 		error = xfs_defer_finish(&tp, &dfops);
1159 		if (error)
1160 			goto out_defer;
1161 	}
1162 
1163 	error = xfs_trans_commit(tp);
1164 	xfs_iunlock(ip, XFS_ILOCK_EXCL);
1165 	if (error)
1166 		goto out;
1167 	return 0;
1168 
1169 out_defer:
1170 	xfs_defer_cancel(&dfops);
1171 out_cancel:
1172 	xfs_trans_cancel(tp);
1173 	xfs_iunlock(ip, XFS_ILOCK_EXCL);
1174 out:
1175 	trace_xfs_reflink_remap_extent_error(ip, error, _RET_IP_);
1176 	return error;
1177 }
1178 
1179 /*
1180  * Iteratively remap one file's extents (and holes) to another's.
1181  */
1182 STATIC int
1183 xfs_reflink_remap_blocks(
1184 	struct xfs_inode	*src,
1185 	xfs_fileoff_t		srcoff,
1186 	struct xfs_inode	*dest,
1187 	xfs_fileoff_t		destoff,
1188 	xfs_filblks_t		len,
1189 	xfs_off_t		new_isize)
1190 {
1191 	struct xfs_bmbt_irec	imap;
1192 	int			nimaps;
1193 	int			error = 0;
1194 	xfs_filblks_t		range_len;
1195 
1196 	/* drange = (destoff, destoff + len); srange = (srcoff, srcoff + len) */
1197 	while (len) {
1198 		trace_xfs_reflink_remap_blocks_loop(src, srcoff, len,
1199 				dest, destoff);
1200 		/* Read extent from the source file */
1201 		nimaps = 1;
1202 		xfs_ilock(src, XFS_ILOCK_EXCL);
1203 		error = xfs_bmapi_read(src, srcoff, len, &imap, &nimaps, 0);
1204 		xfs_iunlock(src, XFS_ILOCK_EXCL);
1205 		if (error)
1206 			goto err;
1207 		ASSERT(nimaps == 1);
1208 
1209 		trace_xfs_reflink_remap_imap(src, srcoff, len, XFS_IO_OVERWRITE,
1210 				&imap);
1211 
1212 		/* Translate imap into the destination file. */
1213 		range_len = imap.br_startoff + imap.br_blockcount - srcoff;
1214 		imap.br_startoff += destoff - srcoff;
1215 
1216 		/* Clear dest from destoff to the end of imap and map it in. */
1217 		error = xfs_reflink_remap_extent(dest, &imap, destoff,
1218 				new_isize);
1219 		if (error)
1220 			goto err;
1221 
1222 		if (fatal_signal_pending(current)) {
1223 			error = -EINTR;
1224 			goto err;
1225 		}
1226 
1227 		/* Advance drange/srange */
1228 		srcoff += range_len;
1229 		destoff += range_len;
1230 		len -= range_len;
1231 	}
1232 
1233 	return 0;
1234 
1235 err:
1236 	trace_xfs_reflink_remap_blocks_error(dest, error, _RET_IP_);
1237 	return error;
1238 }
1239 
1240 /*
1241  * Link a range of blocks from one file to another.
1242  */
1243 int
1244 xfs_reflink_remap_range(
1245 	struct file		*file_in,
1246 	loff_t			pos_in,
1247 	struct file		*file_out,
1248 	loff_t			pos_out,
1249 	u64			len,
1250 	bool			is_dedupe)
1251 {
1252 	struct inode		*inode_in = file_inode(file_in);
1253 	struct xfs_inode	*src = XFS_I(inode_in);
1254 	struct inode		*inode_out = file_inode(file_out);
1255 	struct xfs_inode	*dest = XFS_I(inode_out);
1256 	struct xfs_mount	*mp = src->i_mount;
1257 	bool			same_inode = (inode_in == inode_out);
1258 	xfs_fileoff_t		sfsbno, dfsbno;
1259 	xfs_filblks_t		fsblen;
1260 	xfs_extlen_t		cowextsize;
1261 	ssize_t			ret;
1262 
1263 	if (!xfs_sb_version_hasreflink(&mp->m_sb))
1264 		return -EOPNOTSUPP;
1265 
1266 	if (XFS_FORCED_SHUTDOWN(mp))
1267 		return -EIO;
1268 
1269 	/* Lock both files against IO */
1270 	lock_two_nondirectories(inode_in, inode_out);
1271 	if (same_inode)
1272 		xfs_ilock(src, XFS_MMAPLOCK_EXCL);
1273 	else
1274 		xfs_lock_two_inodes(src, dest, XFS_MMAPLOCK_EXCL);
1275 
1276 	/* Check file eligibility and prepare for block sharing. */
1277 	ret = -EINVAL;
1278 	/* Don't reflink realtime inodes */
1279 	if (XFS_IS_REALTIME_INODE(src) || XFS_IS_REALTIME_INODE(dest))
1280 		goto out_unlock;
1281 
1282 	/* Don't share DAX file data for now. */
1283 	if (IS_DAX(inode_in) || IS_DAX(inode_out))
1284 		goto out_unlock;
1285 
1286 	ret = vfs_clone_file_prep_inodes(inode_in, pos_in, inode_out, pos_out,
1287 			&len, is_dedupe);
1288 	if (ret <= 0)
1289 		goto out_unlock;
1290 
1291 	trace_xfs_reflink_remap_range(src, pos_in, len, dest, pos_out);
1292 
1293 	/* Set flags and remap blocks. */
1294 	ret = xfs_reflink_set_inode_flag(src, dest);
1295 	if (ret)
1296 		goto out_unlock;
1297 
1298 	dfsbno = XFS_B_TO_FSBT(mp, pos_out);
1299 	sfsbno = XFS_B_TO_FSBT(mp, pos_in);
1300 	fsblen = XFS_B_TO_FSB(mp, len);
1301 	ret = xfs_reflink_remap_blocks(src, sfsbno, dest, dfsbno, fsblen,
1302 			pos_out + len);
1303 	if (ret)
1304 		goto out_unlock;
1305 
1306 	/* Zap any page cache for the destination file's range. */
1307 	truncate_inode_pages_range(&inode_out->i_data, pos_out,
1308 				   PAGE_ALIGN(pos_out + len) - 1);
1309 
1310 	/*
1311 	 * Carry the cowextsize hint from src to dest if we're sharing the
1312 	 * entire source file to the entire destination file, the source file
1313 	 * has a cowextsize hint, and the destination file does not.
1314 	 */
1315 	cowextsize = 0;
1316 	if (pos_in == 0 && len == i_size_read(inode_in) &&
1317 	    (src->i_d.di_flags2 & XFS_DIFLAG2_COWEXTSIZE) &&
1318 	    pos_out == 0 && len >= i_size_read(inode_out) &&
1319 	    !(dest->i_d.di_flags2 & XFS_DIFLAG2_COWEXTSIZE))
1320 		cowextsize = src->i_d.di_cowextsize;
1321 
1322 	ret = xfs_reflink_update_dest(dest, pos_out + len, cowextsize,
1323 			is_dedupe);
1324 
1325 out_unlock:
1326 	xfs_iunlock(src, XFS_MMAPLOCK_EXCL);
1327 	if (!same_inode)
1328 		xfs_iunlock(dest, XFS_MMAPLOCK_EXCL);
1329 	unlock_two_nondirectories(inode_in, inode_out);
1330 	if (ret)
1331 		trace_xfs_reflink_remap_range_error(dest, ret, _RET_IP_);
1332 	return ret;
1333 }
1334 
1335 /*
1336  * The user wants to preemptively CoW all shared blocks in this file,
1337  * which enables us to turn off the reflink flag.  Iterate all
1338  * extents which are not prealloc/delalloc to see which ranges are
1339  * mentioned in the refcount tree, then read those blocks into the
1340  * pagecache, dirty them, fsync them back out, and then we can update
1341  * the inode flag.  What happens if we run out of memory? :)
1342  */
1343 STATIC int
1344 xfs_reflink_dirty_extents(
1345 	struct xfs_inode	*ip,
1346 	xfs_fileoff_t		fbno,
1347 	xfs_filblks_t		end,
1348 	xfs_off_t		isize)
1349 {
1350 	struct xfs_mount	*mp = ip->i_mount;
1351 	xfs_agnumber_t		agno;
1352 	xfs_agblock_t		agbno;
1353 	xfs_extlen_t		aglen;
1354 	xfs_agblock_t		rbno;
1355 	xfs_extlen_t		rlen;
1356 	xfs_off_t		fpos;
1357 	xfs_off_t		flen;
1358 	struct xfs_bmbt_irec	map[2];
1359 	int			nmaps;
1360 	int			error = 0;
1361 
1362 	while (end - fbno > 0) {
1363 		nmaps = 1;
1364 		/*
1365 		 * Look for extents in the file.  Skip holes, delalloc, or
1366 		 * unwritten extents; they can't be reflinked.
1367 		 */
1368 		error = xfs_bmapi_read(ip, fbno, end - fbno, map, &nmaps, 0);
1369 		if (error)
1370 			goto out;
1371 		if (nmaps == 0)
1372 			break;
1373 		if (!xfs_bmap_is_real_extent(&map[0]))
1374 			goto next;
1375 
1376 		map[1] = map[0];
1377 		while (map[1].br_blockcount) {
1378 			agno = XFS_FSB_TO_AGNO(mp, map[1].br_startblock);
1379 			agbno = XFS_FSB_TO_AGBNO(mp, map[1].br_startblock);
1380 			aglen = map[1].br_blockcount;
1381 
1382 			error = xfs_reflink_find_shared(mp, NULL, agno, agbno,
1383 					aglen, &rbno, &rlen, true);
1384 			if (error)
1385 				goto out;
1386 			if (rbno == NULLAGBLOCK)
1387 				break;
1388 
1389 			/* Dirty the pages */
1390 			xfs_iunlock(ip, XFS_ILOCK_EXCL);
1391 			fpos = XFS_FSB_TO_B(mp, map[1].br_startoff +
1392 					(rbno - agbno));
1393 			flen = XFS_FSB_TO_B(mp, rlen);
1394 			if (fpos + flen > isize)
1395 				flen = isize - fpos;
1396 			error = iomap_file_dirty(VFS_I(ip), fpos, flen,
1397 					&xfs_iomap_ops);
1398 			xfs_ilock(ip, XFS_ILOCK_EXCL);
1399 			if (error)
1400 				goto out;
1401 
1402 			map[1].br_blockcount -= (rbno - agbno + rlen);
1403 			map[1].br_startoff += (rbno - agbno + rlen);
1404 			map[1].br_startblock += (rbno - agbno + rlen);
1405 		}
1406 
1407 next:
1408 		fbno = map[0].br_startoff + map[0].br_blockcount;
1409 	}
1410 out:
1411 	return error;
1412 }
1413 
1414 /* Does this inode need the reflink flag? */
1415 int
1416 xfs_reflink_inode_has_shared_extents(
1417 	struct xfs_trans		*tp,
1418 	struct xfs_inode		*ip,
1419 	bool				*has_shared)
1420 {
1421 	struct xfs_bmbt_irec		got;
1422 	struct xfs_mount		*mp = ip->i_mount;
1423 	struct xfs_ifork		*ifp;
1424 	xfs_agnumber_t			agno;
1425 	xfs_agblock_t			agbno;
1426 	xfs_extlen_t			aglen;
1427 	xfs_agblock_t			rbno;
1428 	xfs_extlen_t			rlen;
1429 	xfs_extnum_t			idx;
1430 	bool				found;
1431 	int				error;
1432 
1433 	ifp = XFS_IFORK_PTR(ip, XFS_DATA_FORK);
1434 	if (!(ifp->if_flags & XFS_IFEXTENTS)) {
1435 		error = xfs_iread_extents(tp, ip, XFS_DATA_FORK);
1436 		if (error)
1437 			return error;
1438 	}
1439 
1440 	*has_shared = false;
1441 	found = xfs_iext_lookup_extent(ip, ifp, 0, &idx, &got);
1442 	while (found) {
1443 		if (isnullstartblock(got.br_startblock) ||
1444 		    got.br_state != XFS_EXT_NORM)
1445 			goto next;
1446 		agno = XFS_FSB_TO_AGNO(mp, got.br_startblock);
1447 		agbno = XFS_FSB_TO_AGBNO(mp, got.br_startblock);
1448 		aglen = got.br_blockcount;
1449 
1450 		error = xfs_reflink_find_shared(mp, tp, agno, agbno, aglen,
1451 				&rbno, &rlen, false);
1452 		if (error)
1453 			return error;
1454 		/* Is there still a shared block here? */
1455 		if (rbno != NULLAGBLOCK) {
1456 			*has_shared = true;
1457 			return 0;
1458 		}
1459 next:
1460 		found = xfs_iext_get_extent(ifp, ++idx, &got);
1461 	}
1462 
1463 	return 0;
1464 }
1465 
1466 /* Clear the inode reflink flag if there are no shared extents. */
1467 int
1468 xfs_reflink_clear_inode_flag(
1469 	struct xfs_inode	*ip,
1470 	struct xfs_trans	**tpp)
1471 {
1472 	bool			needs_flag;
1473 	int			error = 0;
1474 
1475 	ASSERT(xfs_is_reflink_inode(ip));
1476 
1477 	error = xfs_reflink_inode_has_shared_extents(*tpp, ip, &needs_flag);
1478 	if (error || needs_flag)
1479 		return error;
1480 
1481 	/*
1482 	 * We didn't find any shared blocks so turn off the reflink flag.
1483 	 * First, get rid of any leftover CoW mappings.
1484 	 */
1485 	error = xfs_reflink_cancel_cow_blocks(ip, tpp, 0, NULLFILEOFF, true);
1486 	if (error)
1487 		return error;
1488 
1489 	/* Clear the inode flag. */
1490 	trace_xfs_reflink_unset_inode_flag(ip);
1491 	ip->i_d.di_flags2 &= ~XFS_DIFLAG2_REFLINK;
1492 	xfs_inode_clear_cowblocks_tag(ip);
1493 	xfs_trans_ijoin(*tpp, ip, 0);
1494 	xfs_trans_log_inode(*tpp, ip, XFS_ILOG_CORE);
1495 
1496 	return error;
1497 }
1498 
1499 /*
1500  * Clear the inode reflink flag if there are no shared extents and the size
1501  * hasn't changed.
1502  */
1503 STATIC int
1504 xfs_reflink_try_clear_inode_flag(
1505 	struct xfs_inode	*ip)
1506 {
1507 	struct xfs_mount	*mp = ip->i_mount;
1508 	struct xfs_trans	*tp;
1509 	int			error = 0;
1510 
1511 	/* Start a rolling transaction to remove the mappings */
1512 	error = xfs_trans_alloc(mp, &M_RES(mp)->tr_write, 0, 0, 0, &tp);
1513 	if (error)
1514 		return error;
1515 
1516 	xfs_ilock(ip, XFS_ILOCK_EXCL);
1517 	xfs_trans_ijoin(tp, ip, 0);
1518 
1519 	error = xfs_reflink_clear_inode_flag(ip, &tp);
1520 	if (error)
1521 		goto cancel;
1522 
1523 	error = xfs_trans_commit(tp);
1524 	if (error)
1525 		goto out;
1526 
1527 	xfs_iunlock(ip, XFS_ILOCK_EXCL);
1528 	return 0;
1529 cancel:
1530 	xfs_trans_cancel(tp);
1531 out:
1532 	xfs_iunlock(ip, XFS_ILOCK_EXCL);
1533 	return error;
1534 }
1535 
1536 /*
1537  * Pre-COW all shared blocks within a given byte range of a file and turn off
1538  * the reflink flag if we unshare all of the file's blocks.
1539  */
1540 int
1541 xfs_reflink_unshare(
1542 	struct xfs_inode	*ip,
1543 	xfs_off_t		offset,
1544 	xfs_off_t		len)
1545 {
1546 	struct xfs_mount	*mp = ip->i_mount;
1547 	xfs_fileoff_t		fbno;
1548 	xfs_filblks_t		end;
1549 	xfs_off_t		isize;
1550 	int			error;
1551 
1552 	if (!xfs_is_reflink_inode(ip))
1553 		return 0;
1554 
1555 	trace_xfs_reflink_unshare(ip, offset, len);
1556 
1557 	inode_dio_wait(VFS_I(ip));
1558 
1559 	/* Try to CoW the selected ranges */
1560 	xfs_ilock(ip, XFS_ILOCK_EXCL);
1561 	fbno = XFS_B_TO_FSBT(mp, offset);
1562 	isize = i_size_read(VFS_I(ip));
1563 	end = XFS_B_TO_FSB(mp, offset + len);
1564 	error = xfs_reflink_dirty_extents(ip, fbno, end, isize);
1565 	if (error)
1566 		goto out_unlock;
1567 	xfs_iunlock(ip, XFS_ILOCK_EXCL);
1568 
1569 	/* Wait for the IO to finish */
1570 	error = filemap_write_and_wait(VFS_I(ip)->i_mapping);
1571 	if (error)
1572 		goto out;
1573 
1574 	/* Turn off the reflink flag if possible. */
1575 	error = xfs_reflink_try_clear_inode_flag(ip);
1576 	if (error)
1577 		goto out;
1578 
1579 	return 0;
1580 
1581 out_unlock:
1582 	xfs_iunlock(ip, XFS_ILOCK_EXCL);
1583 out:
1584 	trace_xfs_reflink_unshare_error(ip, error, _RET_IP_);
1585 	return error;
1586 }
1587