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_format.h"
9 #include "xfs_log_format.h"
10 #include "xfs_trans_resv.h"
12 #include "xfs_shared.h"
13 #include "xfs_mount.h"
14 #include "xfs_defer.h"
15 #include "xfs_trans.h"
16 #include "xfs_trans_priv.h"
17 #include "xfs_refcount_item.h"
19 #include "xfs_refcount.h"
20 #include "xfs_error.h"
21 #include "xfs_log_priv.h"
22 #include "xfs_log_recover.h"
24 kmem_zone_t *xfs_cui_zone;
25 kmem_zone_t *xfs_cud_zone;
27 static const struct xfs_item_ops xfs_cui_item_ops;
29 static inline struct xfs_cui_log_item *CUI_ITEM(struct xfs_log_item *lip)
31 return container_of(lip, struct xfs_cui_log_item, cui_item);
36 struct xfs_cui_log_item *cuip)
38 if (cuip->cui_format.cui_nextents > XFS_CUI_MAX_FAST_EXTENTS)
41 kmem_cache_free(xfs_cui_zone, cuip);
45 * Freeing the CUI requires that we remove it from the AIL if it has already
46 * been placed there. However, the CUI may not yet have been placed in the AIL
47 * when called by xfs_cui_release() from CUD processing due to the ordering of
48 * committed vs unpin operations in bulk insert operations. Hence the reference
49 * count to ensure only the last caller frees the CUI.
53 struct xfs_cui_log_item *cuip)
55 ASSERT(atomic_read(&cuip->cui_refcount) > 0);
56 if (atomic_dec_and_test(&cuip->cui_refcount)) {
57 xfs_trans_ail_delete(&cuip->cui_item, SHUTDOWN_LOG_IO_ERROR);
58 xfs_cui_item_free(cuip);
65 struct xfs_log_item *lip,
69 struct xfs_cui_log_item *cuip = CUI_ITEM(lip);
72 *nbytes += xfs_cui_log_format_sizeof(cuip->cui_format.cui_nextents);
76 * This is called to fill in the vector of log iovecs for the
77 * given cui log item. We use only 1 iovec, and we point that
78 * at the cui_log_format structure embedded in the cui item.
79 * It is at this point that we assert that all of the extent
80 * slots in the cui item have been filled.
84 struct xfs_log_item *lip,
85 struct xfs_log_vec *lv)
87 struct xfs_cui_log_item *cuip = CUI_ITEM(lip);
88 struct xfs_log_iovec *vecp = NULL;
90 ASSERT(atomic_read(&cuip->cui_next_extent) ==
91 cuip->cui_format.cui_nextents);
93 cuip->cui_format.cui_type = XFS_LI_CUI;
94 cuip->cui_format.cui_size = 1;
96 xlog_copy_iovec(lv, &vecp, XLOG_REG_TYPE_CUI_FORMAT, &cuip->cui_format,
97 xfs_cui_log_format_sizeof(cuip->cui_format.cui_nextents));
101 * The unpin operation is the last place an CUI is manipulated in the log. It is
102 * either inserted in the AIL or aborted in the event of a log I/O error. In
103 * either case, the CUI transaction has been successfully committed to make it
104 * this far. Therefore, we expect whoever committed the CUI to either construct
105 * and commit the CUD or drop the CUD's reference in the event of error. Simply
106 * drop the log's CUI reference now that the log is done with it.
110 struct xfs_log_item *lip,
113 struct xfs_cui_log_item *cuip = CUI_ITEM(lip);
115 xfs_cui_release(cuip);
119 * The CUI has been either committed or aborted if the transaction has been
120 * cancelled. If the transaction was cancelled, an CUD isn't going to be
121 * constructed and thus we free the CUI here directly.
124 xfs_cui_item_release(
125 struct xfs_log_item *lip)
127 xfs_cui_release(CUI_ITEM(lip));
131 * Allocate and initialize an cui item with the given number of extents.
133 STATIC struct xfs_cui_log_item *
135 struct xfs_mount *mp,
139 struct xfs_cui_log_item *cuip;
141 ASSERT(nextents > 0);
142 if (nextents > XFS_CUI_MAX_FAST_EXTENTS)
143 cuip = kmem_zalloc(xfs_cui_log_item_sizeof(nextents),
146 cuip = kmem_cache_zalloc(xfs_cui_zone,
147 GFP_KERNEL | __GFP_NOFAIL);
149 xfs_log_item_init(mp, &cuip->cui_item, XFS_LI_CUI, &xfs_cui_item_ops);
150 cuip->cui_format.cui_nextents = nextents;
151 cuip->cui_format.cui_id = (uintptr_t)(void *)cuip;
152 atomic_set(&cuip->cui_next_extent, 0);
153 atomic_set(&cuip->cui_refcount, 2);
158 static inline struct xfs_cud_log_item *CUD_ITEM(struct xfs_log_item *lip)
160 return container_of(lip, struct xfs_cud_log_item, cud_item);
165 struct xfs_log_item *lip,
170 *nbytes += sizeof(struct xfs_cud_log_format);
174 * This is called to fill in the vector of log iovecs for the
175 * given cud log item. We use only 1 iovec, and we point that
176 * at the cud_log_format structure embedded in the cud item.
177 * It is at this point that we assert that all of the extent
178 * slots in the cud item have been filled.
182 struct xfs_log_item *lip,
183 struct xfs_log_vec *lv)
185 struct xfs_cud_log_item *cudp = CUD_ITEM(lip);
186 struct xfs_log_iovec *vecp = NULL;
188 cudp->cud_format.cud_type = XFS_LI_CUD;
189 cudp->cud_format.cud_size = 1;
191 xlog_copy_iovec(lv, &vecp, XLOG_REG_TYPE_CUD_FORMAT, &cudp->cud_format,
192 sizeof(struct xfs_cud_log_format));
196 * The CUD is either committed or aborted if the transaction is cancelled. If
197 * the transaction is cancelled, drop our reference to the CUI and free the
201 xfs_cud_item_release(
202 struct xfs_log_item *lip)
204 struct xfs_cud_log_item *cudp = CUD_ITEM(lip);
206 xfs_cui_release(cudp->cud_cuip);
207 kmem_cache_free(xfs_cud_zone, cudp);
210 static const struct xfs_item_ops xfs_cud_item_ops = {
211 .flags = XFS_ITEM_RELEASE_WHEN_COMMITTED,
212 .iop_size = xfs_cud_item_size,
213 .iop_format = xfs_cud_item_format,
214 .iop_release = xfs_cud_item_release,
217 static struct xfs_cud_log_item *
219 struct xfs_trans *tp,
220 struct xfs_cui_log_item *cuip)
222 struct xfs_cud_log_item *cudp;
224 cudp = kmem_cache_zalloc(xfs_cud_zone, GFP_KERNEL | __GFP_NOFAIL);
225 xfs_log_item_init(tp->t_mountp, &cudp->cud_item, XFS_LI_CUD,
227 cudp->cud_cuip = cuip;
228 cudp->cud_format.cud_cui_id = cuip->cui_format.cui_id;
230 xfs_trans_add_item(tp, &cudp->cud_item);
235 * Finish an refcount update and log it to the CUD. Note that the
236 * transaction is marked dirty regardless of whether the refcount
237 * update succeeds or fails to support the CUI/CUD lifecycle rules.
240 xfs_trans_log_finish_refcount_update(
241 struct xfs_trans *tp,
242 struct xfs_cud_log_item *cudp,
243 enum xfs_refcount_intent_type type,
244 xfs_fsblock_t startblock,
245 xfs_extlen_t blockcount,
246 xfs_fsblock_t *new_fsb,
247 xfs_extlen_t *new_len,
248 struct xfs_btree_cur **pcur)
252 error = xfs_refcount_finish_one(tp, type, startblock,
253 blockcount, new_fsb, new_len, pcur);
256 * Mark the transaction dirty, even on error. This ensures the
257 * transaction is aborted, which:
259 * 1.) releases the CUI and frees the CUD
260 * 2.) shuts down the filesystem
262 tp->t_flags |= XFS_TRANS_DIRTY;
263 set_bit(XFS_LI_DIRTY, &cudp->cud_item.li_flags);
268 /* Sort refcount intents by AG. */
270 xfs_refcount_update_diff_items(
272 const struct list_head *a,
273 const struct list_head *b)
275 struct xfs_mount *mp = priv;
276 struct xfs_refcount_intent *ra;
277 struct xfs_refcount_intent *rb;
279 ra = container_of(a, struct xfs_refcount_intent, ri_list);
280 rb = container_of(b, struct xfs_refcount_intent, ri_list);
281 return XFS_FSB_TO_AGNO(mp, ra->ri_startblock) -
282 XFS_FSB_TO_AGNO(mp, rb->ri_startblock);
285 /* Set the phys extent flags for this reverse mapping. */
287 xfs_trans_set_refcount_flags(
288 struct xfs_phys_extent *refc,
289 enum xfs_refcount_intent_type type)
293 case XFS_REFCOUNT_INCREASE:
294 case XFS_REFCOUNT_DECREASE:
295 case XFS_REFCOUNT_ALLOC_COW:
296 case XFS_REFCOUNT_FREE_COW:
297 refc->pe_flags |= type;
304 /* Log refcount updates in the intent item. */
306 xfs_refcount_update_log_item(
307 struct xfs_trans *tp,
308 struct xfs_cui_log_item *cuip,
309 struct xfs_refcount_intent *refc)
312 struct xfs_phys_extent *ext;
314 tp->t_flags |= XFS_TRANS_DIRTY;
315 set_bit(XFS_LI_DIRTY, &cuip->cui_item.li_flags);
318 * atomic_inc_return gives us the value after the increment;
319 * we want to use it as an array index so we need to subtract 1 from
322 next_extent = atomic_inc_return(&cuip->cui_next_extent) - 1;
323 ASSERT(next_extent < cuip->cui_format.cui_nextents);
324 ext = &cuip->cui_format.cui_extents[next_extent];
325 ext->pe_startblock = refc->ri_startblock;
326 ext->pe_len = refc->ri_blockcount;
327 xfs_trans_set_refcount_flags(ext, refc->ri_type);
330 static struct xfs_log_item *
331 xfs_refcount_update_create_intent(
332 struct xfs_trans *tp,
333 struct list_head *items,
337 struct xfs_mount *mp = tp->t_mountp;
338 struct xfs_cui_log_item *cuip = xfs_cui_init(mp, count);
339 struct xfs_refcount_intent *refc;
343 xfs_trans_add_item(tp, &cuip->cui_item);
345 list_sort(mp, items, xfs_refcount_update_diff_items);
346 list_for_each_entry(refc, items, ri_list)
347 xfs_refcount_update_log_item(tp, cuip, refc);
348 return &cuip->cui_item;
351 /* Get an CUD so we can process all the deferred refcount updates. */
352 static struct xfs_log_item *
353 xfs_refcount_update_create_done(
354 struct xfs_trans *tp,
355 struct xfs_log_item *intent,
358 return &xfs_trans_get_cud(tp, CUI_ITEM(intent))->cud_item;
361 /* Process a deferred refcount update. */
363 xfs_refcount_update_finish_item(
364 struct xfs_trans *tp,
365 struct xfs_log_item *done,
366 struct list_head *item,
367 struct xfs_btree_cur **state)
369 struct xfs_refcount_intent *refc;
370 xfs_fsblock_t new_fsb;
371 xfs_extlen_t new_aglen;
374 refc = container_of(item, struct xfs_refcount_intent, ri_list);
375 error = xfs_trans_log_finish_refcount_update(tp, CUD_ITEM(done),
376 refc->ri_type, refc->ri_startblock, refc->ri_blockcount,
377 &new_fsb, &new_aglen, state);
379 /* Did we run out of reservation? Requeue what we didn't finish. */
380 if (!error && new_aglen > 0) {
381 ASSERT(refc->ri_type == XFS_REFCOUNT_INCREASE ||
382 refc->ri_type == XFS_REFCOUNT_DECREASE);
383 refc->ri_startblock = new_fsb;
384 refc->ri_blockcount = new_aglen;
391 /* Abort all pending CUIs. */
393 xfs_refcount_update_abort_intent(
394 struct xfs_log_item *intent)
396 xfs_cui_release(CUI_ITEM(intent));
399 /* Cancel a deferred refcount update. */
401 xfs_refcount_update_cancel_item(
402 struct list_head *item)
404 struct xfs_refcount_intent *refc;
406 refc = container_of(item, struct xfs_refcount_intent, ri_list);
410 const struct xfs_defer_op_type xfs_refcount_update_defer_type = {
411 .max_items = XFS_CUI_MAX_FAST_EXTENTS,
412 .create_intent = xfs_refcount_update_create_intent,
413 .abort_intent = xfs_refcount_update_abort_intent,
414 .create_done = xfs_refcount_update_create_done,
415 .finish_item = xfs_refcount_update_finish_item,
416 .finish_cleanup = xfs_refcount_finish_one_cleanup,
417 .cancel_item = xfs_refcount_update_cancel_item,
421 * Process a refcount update intent item that was recovered from the log.
422 * We need to update the refcountbt.
425 xfs_cui_item_recover(
426 struct xfs_log_item *lip,
427 struct list_head *capture_list)
429 struct xfs_bmbt_irec irec;
430 struct xfs_cui_log_item *cuip = CUI_ITEM(lip);
431 struct xfs_phys_extent *refc;
432 struct xfs_cud_log_item *cudp;
433 struct xfs_trans *tp;
434 struct xfs_btree_cur *rcur = NULL;
435 struct xfs_mount *mp = lip->li_mountp;
436 xfs_fsblock_t startblock_fsb;
437 xfs_fsblock_t new_fsb;
438 xfs_extlen_t new_len;
439 unsigned int refc_type;
441 bool requeue_only = false;
442 enum xfs_refcount_intent_type type;
447 * First check the validity of the extents described by the
448 * CUI. If any are bad, then assume that all are bad and
451 for (i = 0; i < cuip->cui_format.cui_nextents; i++) {
452 refc = &cuip->cui_format.cui_extents[i];
453 startblock_fsb = XFS_BB_TO_FSB(mp,
454 XFS_FSB_TO_DADDR(mp, refc->pe_startblock));
455 switch (refc->pe_flags & XFS_REFCOUNT_EXTENT_TYPE_MASK) {
456 case XFS_REFCOUNT_INCREASE:
457 case XFS_REFCOUNT_DECREASE:
458 case XFS_REFCOUNT_ALLOC_COW:
459 case XFS_REFCOUNT_FREE_COW:
466 if (!op_ok || startblock_fsb == 0 ||
468 startblock_fsb >= mp->m_sb.sb_dblocks ||
469 refc->pe_len >= mp->m_sb.sb_agblocks ||
470 (refc->pe_flags & ~XFS_REFCOUNT_EXTENT_FLAGS))
471 return -EFSCORRUPTED;
475 * Under normal operation, refcount updates are deferred, so we
476 * wouldn't be adding them directly to a transaction. All
477 * refcount updates manage reservation usage internally and
478 * dynamically by deferring work that won't fit in the
479 * transaction. Normally, any work that needs to be deferred
480 * gets attached to the same defer_ops that scheduled the
481 * refcount update. However, we're in log recovery here, so we
482 * use the passed in defer_ops and to finish up any work that
483 * doesn't fit. We need to reserve enough blocks to handle a
484 * full btree split on either end of the refcount range.
486 error = xfs_trans_alloc(mp, &M_RES(mp)->tr_itruncate,
487 mp->m_refc_maxlevels * 2, 0, XFS_TRANS_RESERVE, &tp);
491 cudp = xfs_trans_get_cud(tp, cuip);
493 for (i = 0; i < cuip->cui_format.cui_nextents; i++) {
494 refc = &cuip->cui_format.cui_extents[i];
495 refc_type = refc->pe_flags & XFS_REFCOUNT_EXTENT_TYPE_MASK;
497 case XFS_REFCOUNT_INCREASE:
498 case XFS_REFCOUNT_DECREASE:
499 case XFS_REFCOUNT_ALLOC_COW:
500 case XFS_REFCOUNT_FREE_COW:
504 XFS_ERROR_REPORT(__func__, XFS_ERRLEVEL_LOW, mp);
505 error = -EFSCORRUPTED;
509 new_fsb = refc->pe_startblock;
510 new_len = refc->pe_len;
512 error = xfs_trans_log_finish_refcount_update(tp, cudp,
513 type, refc->pe_startblock, refc->pe_len,
514 &new_fsb, &new_len, &rcur);
518 /* Requeue what we didn't finish. */
520 irec.br_startblock = new_fsb;
521 irec.br_blockcount = new_len;
523 case XFS_REFCOUNT_INCREASE:
524 xfs_refcount_increase_extent(tp, &irec);
526 case XFS_REFCOUNT_DECREASE:
527 xfs_refcount_decrease_extent(tp, &irec);
529 case XFS_REFCOUNT_ALLOC_COW:
530 xfs_refcount_alloc_cow_extent(tp,
534 case XFS_REFCOUNT_FREE_COW:
535 xfs_refcount_free_cow_extent(tp,
546 xfs_refcount_finish_one_cleanup(tp, rcur, error);
547 return xfs_defer_ops_capture_and_commit(tp, NULL, capture_list);
550 xfs_refcount_finish_one_cleanup(tp, rcur, error);
551 xfs_trans_cancel(tp);
557 struct xfs_log_item *lip,
560 return CUI_ITEM(lip)->cui_format.cui_id == intent_id;
563 /* Relog an intent item to push the log tail forward. */
564 static struct xfs_log_item *
566 struct xfs_log_item *intent,
567 struct xfs_trans *tp)
569 struct xfs_cud_log_item *cudp;
570 struct xfs_cui_log_item *cuip;
571 struct xfs_phys_extent *extp;
574 count = CUI_ITEM(intent)->cui_format.cui_nextents;
575 extp = CUI_ITEM(intent)->cui_format.cui_extents;
577 tp->t_flags |= XFS_TRANS_DIRTY;
578 cudp = xfs_trans_get_cud(tp, CUI_ITEM(intent));
579 set_bit(XFS_LI_DIRTY, &cudp->cud_item.li_flags);
581 cuip = xfs_cui_init(tp->t_mountp, count);
582 memcpy(cuip->cui_format.cui_extents, extp, count * sizeof(*extp));
583 atomic_set(&cuip->cui_next_extent, count);
584 xfs_trans_add_item(tp, &cuip->cui_item);
585 set_bit(XFS_LI_DIRTY, &cuip->cui_item.li_flags);
586 return &cuip->cui_item;
589 static const struct xfs_item_ops xfs_cui_item_ops = {
590 .iop_size = xfs_cui_item_size,
591 .iop_format = xfs_cui_item_format,
592 .iop_unpin = xfs_cui_item_unpin,
593 .iop_release = xfs_cui_item_release,
594 .iop_recover = xfs_cui_item_recover,
595 .iop_match = xfs_cui_item_match,
596 .iop_relog = xfs_cui_item_relog,
600 * Copy an CUI format buffer from the given buf, and into the destination
601 * CUI format structure. The CUI/CUD items were designed not to need any
602 * special alignment handling.
606 struct xfs_log_iovec *buf,
607 struct xfs_cui_log_format *dst_cui_fmt)
609 struct xfs_cui_log_format *src_cui_fmt;
612 src_cui_fmt = buf->i_addr;
613 len = xfs_cui_log_format_sizeof(src_cui_fmt->cui_nextents);
615 if (buf->i_len == len) {
616 memcpy(dst_cui_fmt, src_cui_fmt, len);
619 XFS_ERROR_REPORT(__func__, XFS_ERRLEVEL_LOW, NULL);
620 return -EFSCORRUPTED;
624 * This routine is called to create an in-core extent refcount update
625 * item from the cui format structure which was logged on disk.
626 * It allocates an in-core cui, copies the extents from the format
627 * structure into it, and adds the cui to the AIL with the given
631 xlog_recover_cui_commit_pass2(
633 struct list_head *buffer_list,
634 struct xlog_recover_item *item,
638 struct xfs_mount *mp = log->l_mp;
639 struct xfs_cui_log_item *cuip;
640 struct xfs_cui_log_format *cui_formatp;
642 cui_formatp = item->ri_buf[0].i_addr;
644 cuip = xfs_cui_init(mp, cui_formatp->cui_nextents);
645 error = xfs_cui_copy_format(&item->ri_buf[0], &cuip->cui_format);
647 xfs_cui_item_free(cuip);
650 atomic_set(&cuip->cui_next_extent, cui_formatp->cui_nextents);
652 * Insert the intent into the AIL directly and drop one reference so
653 * that finishing or canceling the work will drop the other.
655 xfs_trans_ail_insert(log->l_ailp, &cuip->cui_item, lsn);
656 xfs_cui_release(cuip);
660 const struct xlog_recover_item_ops xlog_cui_item_ops = {
661 .item_type = XFS_LI_CUI,
662 .commit_pass2 = xlog_recover_cui_commit_pass2,
666 * This routine is called when an CUD format structure is found in a committed
667 * transaction in the log. Its purpose is to cancel the corresponding CUI if it
668 * was still in the log. To do this it searches the AIL for the CUI with an id
669 * equal to that in the CUD format structure. If we find it we drop the CUD
670 * reference, which removes the CUI from the AIL and frees it.
673 xlog_recover_cud_commit_pass2(
675 struct list_head *buffer_list,
676 struct xlog_recover_item *item,
679 struct xfs_cud_log_format *cud_formatp;
681 cud_formatp = item->ri_buf[0].i_addr;
682 if (item->ri_buf[0].i_len != sizeof(struct xfs_cud_log_format)) {
683 XFS_ERROR_REPORT(__func__, XFS_ERRLEVEL_LOW, log->l_mp);
684 return -EFSCORRUPTED;
687 xlog_recover_release_intent(log, XFS_LI_CUI, cud_formatp->cud_cui_id);
691 const struct xlog_recover_item_ops xlog_cud_item_ops = {
692 .item_type = XFS_LI_CUD,
693 .commit_pass2 = xlog_recover_cud_commit_pass2,