Loading...
1/* SPDX-License-Identifier: GPL-2.0+ */
2/*
3 * Copyright (C) 2016 Oracle. All Rights Reserved.
4 * Author: Darrick J. Wong <darrick.wong@oracle.com>
5 */
6#ifndef __XFS_DEFER_H__
7#define __XFS_DEFER_H__
8
9struct xfs_btree_cur;
10struct xfs_defer_op_type;
11struct xfs_defer_capture;
12
13/*
14 * Save a log intent item and a list of extents, so that we can replay
15 * whatever action had to happen to the extent list and file the log done
16 * item.
17 */
18struct xfs_defer_pending {
19 struct list_head dfp_list; /* pending items */
20 struct list_head dfp_work; /* work items */
21 struct xfs_log_item *dfp_intent; /* log intent item */
22 struct xfs_log_item *dfp_done; /* log done item */
23 const struct xfs_defer_op_type *dfp_ops;
24 unsigned int dfp_count; /* # extent items */
25 unsigned int dfp_flags;
26};
27
28/*
29 * Create a log intent item for this deferred item, but don't actually finish
30 * the work. Caller must clear this before the final transaction commit.
31 */
32#define XFS_DEFER_PAUSED (1U << 0)
33
34#define XFS_DEFER_PENDING_STRINGS \
35 { XFS_DEFER_PAUSED, "paused" }
36
37void xfs_defer_item_pause(struct xfs_trans *tp, struct xfs_defer_pending *dfp);
38void xfs_defer_item_unpause(struct xfs_trans *tp, struct xfs_defer_pending *dfp);
39
40struct xfs_defer_pending *xfs_defer_add(struct xfs_trans *tp, struct list_head *h,
41 const struct xfs_defer_op_type *ops);
42int xfs_defer_finish_noroll(struct xfs_trans **tp);
43int xfs_defer_finish(struct xfs_trans **tp);
44int xfs_defer_finish_one(struct xfs_trans *tp, struct xfs_defer_pending *dfp);
45void xfs_defer_cancel(struct xfs_trans *);
46void xfs_defer_move(struct xfs_trans *dtp, struct xfs_trans *stp);
47
48/* Description of a deferred type. */
49struct xfs_defer_op_type {
50 const char *name;
51 unsigned int max_items;
52 struct xfs_log_item *(*create_intent)(struct xfs_trans *tp,
53 struct list_head *items, unsigned int count, bool sort);
54 void (*abort_intent)(struct xfs_log_item *intent);
55 struct xfs_log_item *(*create_done)(struct xfs_trans *tp,
56 struct xfs_log_item *intent, unsigned int count);
57 int (*finish_item)(struct xfs_trans *tp, struct xfs_log_item *done,
58 struct list_head *item, struct xfs_btree_cur **state);
59 void (*finish_cleanup)(struct xfs_trans *tp,
60 struct xfs_btree_cur *state, int error);
61 void (*cancel_item)(struct list_head *item);
62 int (*recover_work)(struct xfs_defer_pending *dfp,
63 struct list_head *capture_list);
64 struct xfs_log_item *(*relog_intent)(struct xfs_trans *tp,
65 struct xfs_log_item *intent,
66 struct xfs_log_item *done_item);
67};
68
69extern const struct xfs_defer_op_type xfs_bmap_update_defer_type;
70extern const struct xfs_defer_op_type xfs_refcount_update_defer_type;
71extern const struct xfs_defer_op_type xfs_rmap_update_defer_type;
72extern const struct xfs_defer_op_type xfs_extent_free_defer_type;
73extern const struct xfs_defer_op_type xfs_agfl_free_defer_type;
74extern const struct xfs_defer_op_type xfs_attr_defer_type;
75
76
77/*
78 * Deferred operation item relogging limits.
79 */
80#define XFS_DEFER_OPS_NR_INODES 2 /* join up to two inodes */
81#define XFS_DEFER_OPS_NR_BUFS 2 /* join up to two buffers */
82
83/* Resources that must be held across a transaction roll. */
84struct xfs_defer_resources {
85 /* held buffers */
86 struct xfs_buf *dr_bp[XFS_DEFER_OPS_NR_BUFS];
87
88 /* inodes with no unlock flags */
89 struct xfs_inode *dr_ip[XFS_DEFER_OPS_NR_INODES];
90
91 /* number of held buffers */
92 unsigned short dr_bufs;
93
94 /* bitmap of ordered buffers */
95 unsigned short dr_ordered;
96
97 /* number of held inodes */
98 unsigned short dr_inos;
99};
100
101/*
102 * This structure enables a dfops user to detach the chain of deferred
103 * operations from a transaction so that they can be continued later.
104 */
105struct xfs_defer_capture {
106 /* List of other capture structures. */
107 struct list_head dfc_list;
108
109 /* Deferred ops state saved from the transaction. */
110 struct list_head dfc_dfops;
111 unsigned int dfc_tpflags;
112
113 /* Block reservations for the data and rt devices. */
114 unsigned int dfc_blkres;
115 unsigned int dfc_rtxres;
116
117 /* Log reservation saved from the transaction. */
118 unsigned int dfc_logres;
119
120 struct xfs_defer_resources dfc_held;
121};
122
123/*
124 * Functions to capture a chain of deferred operations and continue them later.
125 * This doesn't normally happen except log recovery.
126 */
127int xfs_defer_ops_capture_and_commit(struct xfs_trans *tp,
128 struct list_head *capture_list);
129void xfs_defer_ops_continue(struct xfs_defer_capture *d, struct xfs_trans *tp,
130 struct xfs_defer_resources *dres);
131void xfs_defer_ops_capture_abort(struct xfs_mount *mp,
132 struct xfs_defer_capture *d);
133void xfs_defer_resources_rele(struct xfs_defer_resources *dres);
134
135void xfs_defer_start_recovery(struct xfs_log_item *lip,
136 struct list_head *r_dfops, const struct xfs_defer_op_type *ops);
137void xfs_defer_cancel_recovery(struct xfs_mount *mp,
138 struct xfs_defer_pending *dfp);
139int xfs_defer_finish_recovery(struct xfs_mount *mp,
140 struct xfs_defer_pending *dfp, struct list_head *capture_list);
141
142static inline void
143xfs_defer_add_item(
144 struct xfs_defer_pending *dfp,
145 struct list_head *work)
146{
147 list_add_tail(work, &dfp->dfp_work);
148 dfp->dfp_count++;
149}
150
151int __init xfs_defer_init_item_caches(void);
152void xfs_defer_destroy_item_caches(void);
153
154void xfs_defer_add_barrier(struct xfs_trans *tp);
155
156#endif /* __XFS_DEFER_H__ */
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#ifndef __XFS_DEFER_H__
21#define __XFS_DEFER_H__
22
23struct xfs_defer_op_type;
24
25/*
26 * Save a log intent item and a list of extents, so that we can replay
27 * whatever action had to happen to the extent list and file the log done
28 * item.
29 */
30struct xfs_defer_pending {
31 const struct xfs_defer_op_type *dfp_type; /* function pointers */
32 struct list_head dfp_list; /* pending items */
33 void *dfp_intent; /* log intent item */
34 void *dfp_done; /* log done item */
35 struct list_head dfp_work; /* work items */
36 unsigned int dfp_count; /* # extent items */
37};
38
39/*
40 * Header for deferred operation list.
41 *
42 * dop_low is used by the allocator to activate the lowspace algorithm -
43 * when free space is running low the extent allocator may choose to
44 * allocate an extent from an AG without leaving sufficient space for
45 * a btree split when inserting the new extent. In this case the allocator
46 * will enable the lowspace algorithm which is supposed to allow further
47 * allocations (such as btree splits and newroots) to allocate from
48 * sequential AGs. In order to avoid locking AGs out of order the lowspace
49 * algorithm will start searching for free space from AG 0. If the correct
50 * transaction reservations have been made then this algorithm will eventually
51 * find all the space it needs.
52 */
53enum xfs_defer_ops_type {
54 XFS_DEFER_OPS_TYPE_BMAP,
55 XFS_DEFER_OPS_TYPE_REFCOUNT,
56 XFS_DEFER_OPS_TYPE_RMAP,
57 XFS_DEFER_OPS_TYPE_FREE,
58 XFS_DEFER_OPS_TYPE_MAX,
59};
60
61#define XFS_DEFER_OPS_NR_INODES 2 /* join up to two inodes */
62
63struct xfs_defer_ops {
64 bool dop_committed; /* did any trans commit? */
65 bool dop_low; /* alloc in low mode */
66 struct list_head dop_intake; /* unlogged pending work */
67 struct list_head dop_pending; /* logged pending work */
68
69 /* relog these inodes with each roll */
70 struct xfs_inode *dop_inodes[XFS_DEFER_OPS_NR_INODES];
71};
72
73void xfs_defer_add(struct xfs_defer_ops *dop, enum xfs_defer_ops_type type,
74 struct list_head *h);
75int xfs_defer_finish(struct xfs_trans **tp, struct xfs_defer_ops *dop,
76 struct xfs_inode *ip);
77void xfs_defer_cancel(struct xfs_defer_ops *dop);
78void xfs_defer_init(struct xfs_defer_ops *dop, xfs_fsblock_t *fbp);
79bool xfs_defer_has_unfinished_work(struct xfs_defer_ops *dop);
80int xfs_defer_join(struct xfs_defer_ops *dop, struct xfs_inode *ip);
81
82/* Description of a deferred type. */
83struct xfs_defer_op_type {
84 enum xfs_defer_ops_type type;
85 unsigned int max_items;
86 void (*abort_intent)(void *);
87 void *(*create_done)(struct xfs_trans *, void *, unsigned int);
88 int (*finish_item)(struct xfs_trans *, struct xfs_defer_ops *,
89 struct list_head *, void *, void **);
90 void (*finish_cleanup)(struct xfs_trans *, void *, int);
91 void (*cancel_item)(struct list_head *);
92 int (*diff_items)(void *, struct list_head *, struct list_head *);
93 void *(*create_intent)(struct xfs_trans *, uint);
94 void (*log_item)(struct xfs_trans *, void *, struct list_head *);
95};
96
97void xfs_defer_init_op_type(const struct xfs_defer_op_type *type);
98
99#endif /* __XFS_DEFER_H__ */