xref: /linux/fs/xfs/libxfs/xfs_defer.h (revision 011f129fee4bd064a3db30ca1a0139548a619482)
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 
9 struct xfs_btree_cur;
10 struct xfs_defer_op_type;
11 struct xfs_defer_capture;
12 
13 /*
14  * Header for deferred operation list.
15  */
16 enum xfs_defer_ops_type {
17 	XFS_DEFER_OPS_TYPE_BMAP,
18 	XFS_DEFER_OPS_TYPE_REFCOUNT,
19 	XFS_DEFER_OPS_TYPE_RMAP,
20 	XFS_DEFER_OPS_TYPE_FREE,
21 	XFS_DEFER_OPS_TYPE_AGFL_FREE,
22 	XFS_DEFER_OPS_TYPE_ATTR,
23 	XFS_DEFER_OPS_TYPE_BARRIER,
24 	XFS_DEFER_OPS_TYPE_MAX,
25 };
26 
27 /*
28  * Save a log intent item and a list of extents, so that we can replay
29  * whatever action had to happen to the extent list and file the log done
30  * item.
31  */
32 struct xfs_defer_pending {
33 	struct list_head		dfp_list;	/* pending items */
34 	struct list_head		dfp_work;	/* work items */
35 	struct xfs_log_item		*dfp_intent;	/* log intent item */
36 	struct xfs_log_item		*dfp_done;	/* log done item */
37 	unsigned int			dfp_count;	/* # extent items */
38 	unsigned int			dfp_flags;
39 	enum xfs_defer_ops_type		dfp_type;
40 };
41 
42 /*
43  * Create a log intent item for this deferred item, but don't actually finish
44  * the work.  Caller must clear this before the final transaction commit.
45  */
46 #define XFS_DEFER_PAUSED	(1U << 0)
47 
48 #define XFS_DEFER_PENDING_STRINGS \
49 	{ XFS_DEFER_PAUSED,	"paused" }
50 
51 void xfs_defer_item_pause(struct xfs_trans *tp, struct xfs_defer_pending *dfp);
52 void xfs_defer_item_unpause(struct xfs_trans *tp, struct xfs_defer_pending *dfp);
53 
54 struct xfs_defer_pending *xfs_defer_add(struct xfs_trans *tp,
55 		enum xfs_defer_ops_type type, struct list_head *h);
56 int xfs_defer_finish_noroll(struct xfs_trans **tp);
57 int xfs_defer_finish(struct xfs_trans **tp);
58 int xfs_defer_finish_one(struct xfs_trans *tp, struct xfs_defer_pending *dfp);
59 void xfs_defer_cancel(struct xfs_trans *);
60 void xfs_defer_move(struct xfs_trans *dtp, struct xfs_trans *stp);
61 
62 /* Description of a deferred type. */
63 struct xfs_defer_op_type {
64 	struct xfs_log_item *(*create_intent)(struct xfs_trans *tp,
65 			struct list_head *items, unsigned int count, bool sort);
66 	void (*abort_intent)(struct xfs_log_item *intent);
67 	struct xfs_log_item *(*create_done)(struct xfs_trans *tp,
68 			struct xfs_log_item *intent, unsigned int count);
69 	int (*finish_item)(struct xfs_trans *tp, struct xfs_log_item *done,
70 			struct list_head *item, struct xfs_btree_cur **state);
71 	void (*finish_cleanup)(struct xfs_trans *tp,
72 			struct xfs_btree_cur *state, int error);
73 	void (*cancel_item)(struct list_head *item);
74 	int (*recover_work)(struct xfs_defer_pending *dfp,
75 			    struct list_head *capture_list);
76 	struct xfs_log_item *(*relog_intent)(struct xfs_trans *tp,
77 			struct xfs_log_item *intent,
78 			struct xfs_log_item *done_item);
79 	unsigned int		max_items;
80 };
81 
82 extern const struct xfs_defer_op_type xfs_bmap_update_defer_type;
83 extern const struct xfs_defer_op_type xfs_refcount_update_defer_type;
84 extern const struct xfs_defer_op_type xfs_rmap_update_defer_type;
85 extern const struct xfs_defer_op_type xfs_extent_free_defer_type;
86 extern const struct xfs_defer_op_type xfs_agfl_free_defer_type;
87 extern const struct xfs_defer_op_type xfs_attr_defer_type;
88 
89 
90 /*
91  * Deferred operation item relogging limits.
92  */
93 #define XFS_DEFER_OPS_NR_INODES	2	/* join up to two inodes */
94 #define XFS_DEFER_OPS_NR_BUFS	2	/* join up to two buffers */
95 
96 /* Resources that must be held across a transaction roll. */
97 struct xfs_defer_resources {
98 	/* held buffers */
99 	struct xfs_buf		*dr_bp[XFS_DEFER_OPS_NR_BUFS];
100 
101 	/* inodes with no unlock flags */
102 	struct xfs_inode	*dr_ip[XFS_DEFER_OPS_NR_INODES];
103 
104 	/* number of held buffers */
105 	unsigned short		dr_bufs;
106 
107 	/* bitmap of ordered buffers */
108 	unsigned short		dr_ordered;
109 
110 	/* number of held inodes */
111 	unsigned short		dr_inos;
112 };
113 
114 /*
115  * This structure enables a dfops user to detach the chain of deferred
116  * operations from a transaction so that they can be continued later.
117  */
118 struct xfs_defer_capture {
119 	/* List of other capture structures. */
120 	struct list_head	dfc_list;
121 
122 	/* Deferred ops state saved from the transaction. */
123 	struct list_head	dfc_dfops;
124 	unsigned int		dfc_tpflags;
125 
126 	/* Block reservations for the data and rt devices. */
127 	unsigned int		dfc_blkres;
128 	unsigned int		dfc_rtxres;
129 
130 	/* Log reservation saved from the transaction. */
131 	unsigned int		dfc_logres;
132 
133 	struct xfs_defer_resources dfc_held;
134 };
135 
136 /*
137  * Functions to capture a chain of deferred operations and continue them later.
138  * This doesn't normally happen except log recovery.
139  */
140 int xfs_defer_ops_capture_and_commit(struct xfs_trans *tp,
141 		struct list_head *capture_list);
142 void xfs_defer_ops_continue(struct xfs_defer_capture *d, struct xfs_trans *tp,
143 		struct xfs_defer_resources *dres);
144 void xfs_defer_ops_capture_abort(struct xfs_mount *mp,
145 		struct xfs_defer_capture *d);
146 void xfs_defer_resources_rele(struct xfs_defer_resources *dres);
147 
148 void xfs_defer_start_recovery(struct xfs_log_item *lip,
149 		enum xfs_defer_ops_type dfp_type, struct list_head *r_dfops);
150 void xfs_defer_cancel_recovery(struct xfs_mount *mp,
151 		struct xfs_defer_pending *dfp);
152 int xfs_defer_finish_recovery(struct xfs_mount *mp,
153 		struct xfs_defer_pending *dfp, struct list_head *capture_list);
154 
155 static inline void
156 xfs_defer_add_item(
157 	struct xfs_defer_pending	*dfp,
158 	struct list_head		*work)
159 {
160 	list_add_tail(work, &dfp->dfp_work);
161 	dfp->dfp_count++;
162 }
163 
164 int __init xfs_defer_init_item_caches(void);
165 void xfs_defer_destroy_item_caches(void);
166 
167 void xfs_defer_add_barrier(struct xfs_trans *tp);
168 
169 #endif /* __XFS_DEFER_H__ */
170