xref: /linux/fs/xfs/xfs_trans.h (revision f85bea18f71b2817ea45d63c6d1b91f9bc4a811f)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (c) 2000-2002,2005 Silicon Graphics, Inc.
4  * All Rights Reserved.
5  */
6 #ifndef	__XFS_TRANS_H__
7 #define	__XFS_TRANS_H__
8 
9 /* kernel only transaction subsystem defines */
10 
11 struct xlog;
12 struct xfs_buf;
13 struct xfs_buftarg;
14 struct xfs_efd_log_item;
15 struct xfs_efi_log_item;
16 struct xfs_inode;
17 struct xfs_item_ops;
18 struct xfs_log_iovec;
19 struct xfs_mount;
20 struct xfs_trans;
21 struct xfs_trans_res;
22 struct xfs_dquot_acct;
23 struct xfs_rud_log_item;
24 struct xfs_rui_log_item;
25 struct xfs_btree_cur;
26 struct xfs_cui_log_item;
27 struct xfs_cud_log_item;
28 struct xfs_bui_log_item;
29 struct xfs_bud_log_item;
30 
31 struct xfs_log_item {
32 	struct list_head		li_ail;		/* AIL pointers */
33 	struct list_head		li_trans;	/* transaction list */
34 	xfs_lsn_t			li_lsn;		/* last on-disk lsn */
35 	struct xlog			*li_log;
36 	struct xfs_ail			*li_ailp;	/* ptr to AIL */
37 	uint				li_type;	/* item type */
38 	unsigned long			li_flags;	/* misc flags */
39 	struct xfs_buf			*li_buf;	/* real buffer pointer */
40 	struct list_head		li_bio_list;	/* buffer item list */
41 	const struct xfs_item_ops	*li_ops;	/* function list */
42 
43 	/* delayed logging */
44 	struct list_head		li_cil;		/* CIL pointers */
45 	struct xfs_log_vec		*li_lv;		/* active log vector */
46 	struct xfs_log_vec		*li_lv_shadow;	/* standby vector */
47 	xfs_csn_t			li_seq;		/* CIL commit seq */
48 	uint32_t			li_order_id;	/* CIL commit order */
49 };
50 
51 /*
52  * li_flags use the (set/test/clear)_bit atomic interfaces because updates can
53  * race with each other and we don't want to have to use the AIL lock to
54  * serialise all updates.
55  */
56 #define	XFS_LI_IN_AIL	0
57 #define	XFS_LI_ABORTED	1
58 #define	XFS_LI_FAILED	2
59 #define	XFS_LI_DIRTY	3
60 #define	XFS_LI_WHITEOUT	4
61 
62 #define XFS_LI_FLAGS \
63 	{ (1u << XFS_LI_IN_AIL),	"IN_AIL" }, \
64 	{ (1u << XFS_LI_ABORTED),	"ABORTED" }, \
65 	{ (1u << XFS_LI_FAILED),	"FAILED" }, \
66 	{ (1u << XFS_LI_DIRTY),		"DIRTY" }, \
67 	{ (1u << XFS_LI_WHITEOUT),	"WHITEOUT" }
68 
69 struct xfs_item_ops {
70 	unsigned flags;
71 	void (*iop_size)(struct xfs_log_item *, int *, int *);
72 	void (*iop_format)(struct xfs_log_item *, struct xfs_log_vec *);
73 	void (*iop_pin)(struct xfs_log_item *);
74 	void (*iop_unpin)(struct xfs_log_item *, int remove);
75 	uint64_t (*iop_sort)(struct xfs_log_item *lip);
76 	int (*iop_precommit)(struct xfs_trans *tp, struct xfs_log_item *lip);
77 	void (*iop_committing)(struct xfs_log_item *lip, xfs_csn_t seq);
78 	xfs_lsn_t (*iop_committed)(struct xfs_log_item *, xfs_lsn_t);
79 	uint (*iop_push)(struct xfs_log_item *, struct list_head *);
80 	void (*iop_release)(struct xfs_log_item *);
81 	bool (*iop_match)(struct xfs_log_item *item, uint64_t id);
82 	struct xfs_log_item *(*iop_intent)(struct xfs_log_item *intent_done);
83 };
84 
85 /*
86  * Log item ops flags
87  */
88 /*
89  * Release the log item when the journal commits instead of inserting into the
90  * AIL for writeback tracking and/or log tail pinning.
91  */
92 #define XFS_ITEM_RELEASE_WHEN_COMMITTED	(1 << 0)
93 #define XFS_ITEM_INTENT			(1 << 1)
94 #define XFS_ITEM_INTENT_DONE		(1 << 2)
95 
96 static inline bool
97 xlog_item_is_intent(struct xfs_log_item *lip)
98 {
99 	return lip->li_ops->flags & XFS_ITEM_INTENT;
100 }
101 
102 static inline bool
103 xlog_item_is_intent_done(struct xfs_log_item *lip)
104 {
105 	return lip->li_ops->flags & XFS_ITEM_INTENT_DONE;
106 }
107 
108 void	xfs_log_item_init(struct xfs_mount *mp, struct xfs_log_item *item,
109 			  int type, const struct xfs_item_ops *ops);
110 
111 /*
112  * Return values for the iop_push() routines.
113  */
114 #define XFS_ITEM_SUCCESS	0
115 #define XFS_ITEM_PINNED		1
116 #define XFS_ITEM_LOCKED		2
117 #define XFS_ITEM_FLUSHING	3
118 
119 /*
120  * This is the structure maintained for every active transaction.
121  */
122 typedef struct xfs_trans {
123 	unsigned int		t_magic;	/* magic number */
124 	unsigned int		t_log_res;	/* amt of log space resvd */
125 	unsigned int		t_log_count;	/* count for perm log res */
126 	unsigned int		t_blk_res;	/* # of blocks resvd */
127 	unsigned int		t_blk_res_used;	/* # of resvd blocks used */
128 	unsigned int		t_rtx_res;	/* # of rt extents resvd */
129 	unsigned int		t_rtx_res_used;	/* # of resvd rt extents used */
130 	unsigned int		t_flags;	/* misc flags */
131 	xfs_agnumber_t		t_highest_agno;	/* highest AGF locked */
132 	struct xlog_ticket	*t_ticket;	/* log mgr ticket */
133 	struct xfs_mount	*t_mountp;	/* ptr to fs mount struct */
134 	struct xfs_dquot_acct   *t_dqinfo;	/* acctg info for dquots */
135 	int64_t			t_icount_delta;	/* superblock icount change */
136 	int64_t			t_ifree_delta;	/* superblock ifree change */
137 	int64_t			t_fdblocks_delta; /* superblock fdblocks chg */
138 	int64_t			t_res_fdblocks_delta; /* on-disk only chg */
139 	int64_t			t_frextents_delta;/* superblock freextents chg*/
140 	int64_t			t_res_frextents_delta; /* on-disk only chg */
141 	int64_t			t_dblocks_delta;/* superblock dblocks change */
142 	int64_t			t_agcount_delta;/* superblock agcount change */
143 	int64_t			t_imaxpct_delta;/* superblock imaxpct change */
144 	int64_t			t_rextsize_delta;/* superblock rextsize chg */
145 	int64_t			t_rbmblocks_delta;/* superblock rbmblocks chg */
146 	int64_t			t_rblocks_delta;/* superblock rblocks change */
147 	int64_t			t_rextents_delta;/* superblocks rextents chg */
148 	int64_t			t_rextslog_delta;/* superblocks rextslog chg */
149 	struct list_head	t_items;	/* log item descriptors */
150 	struct list_head	t_busy;		/* list of busy extents */
151 	struct list_head	t_dfops;	/* deferred operations */
152 	unsigned long		t_pflags;	/* saved process flags state */
153 } xfs_trans_t;
154 
155 /*
156  * XFS transaction mechanism exported interfaces that are
157  * actually macros.
158  */
159 #define	xfs_trans_set_sync(tp)		((tp)->t_flags |= XFS_TRANS_SYNC)
160 
161 /*
162  * XFS transaction mechanism exported interfaces.
163  */
164 int		xfs_trans_alloc(struct xfs_mount *mp, struct xfs_trans_res *resp,
165 			uint blocks, uint rtextents, uint flags,
166 			struct xfs_trans **tpp);
167 int		xfs_trans_reserve_more(struct xfs_trans *tp,
168 			unsigned int blocks, unsigned int rtextents);
169 int		xfs_trans_alloc_empty(struct xfs_mount *mp,
170 			struct xfs_trans **tpp);
171 void		xfs_trans_mod_sb(xfs_trans_t *, uint, int64_t);
172 
173 int xfs_trans_get_buf_map(struct xfs_trans *tp, struct xfs_buftarg *target,
174 		struct xfs_buf_map *map, int nmaps, xfs_buf_flags_t flags,
175 		struct xfs_buf **bpp);
176 
177 static inline int
178 xfs_trans_get_buf(
179 	struct xfs_trans	*tp,
180 	struct xfs_buftarg	*target,
181 	xfs_daddr_t		blkno,
182 	int			numblks,
183 	xfs_buf_flags_t		flags,
184 	struct xfs_buf		**bpp)
185 {
186 	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
187 	return xfs_trans_get_buf_map(tp, target, &map, 1, flags, bpp);
188 }
189 
190 int		xfs_trans_read_buf_map(struct xfs_mount *mp,
191 				       struct xfs_trans *tp,
192 				       struct xfs_buftarg *target,
193 				       struct xfs_buf_map *map, int nmaps,
194 				       xfs_buf_flags_t flags,
195 				       struct xfs_buf **bpp,
196 				       const struct xfs_buf_ops *ops);
197 
198 static inline int
199 xfs_trans_read_buf(
200 	struct xfs_mount	*mp,
201 	struct xfs_trans	*tp,
202 	struct xfs_buftarg	*target,
203 	xfs_daddr_t		blkno,
204 	int			numblks,
205 	xfs_buf_flags_t		flags,
206 	struct xfs_buf		**bpp,
207 	const struct xfs_buf_ops *ops)
208 {
209 	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
210 	return xfs_trans_read_buf_map(mp, tp, target, &map, 1,
211 				      flags, bpp, ops);
212 }
213 
214 struct xfs_buf	*xfs_trans_getsb(struct xfs_trans *);
215 
216 void		xfs_trans_brelse(xfs_trans_t *, struct xfs_buf *);
217 void		xfs_trans_bjoin(xfs_trans_t *, struct xfs_buf *);
218 void		xfs_trans_bdetach(struct xfs_trans *tp, struct xfs_buf *bp);
219 void		xfs_trans_bhold(xfs_trans_t *, struct xfs_buf *);
220 void		xfs_trans_bhold_release(xfs_trans_t *, struct xfs_buf *);
221 void		xfs_trans_binval(xfs_trans_t *, struct xfs_buf *);
222 void		xfs_trans_inode_buf(xfs_trans_t *, struct xfs_buf *);
223 void		xfs_trans_stale_inode_buf(xfs_trans_t *, struct xfs_buf *);
224 bool		xfs_trans_ordered_buf(xfs_trans_t *, struct xfs_buf *);
225 void		xfs_trans_dquot_buf(xfs_trans_t *, struct xfs_buf *, uint);
226 void		xfs_trans_inode_alloc_buf(xfs_trans_t *, struct xfs_buf *);
227 void		xfs_trans_ichgtime(struct xfs_trans *, struct xfs_inode *, int);
228 void		xfs_trans_ijoin(struct xfs_trans *, struct xfs_inode *, uint);
229 void		xfs_trans_log_buf(struct xfs_trans *, struct xfs_buf *, uint,
230 				  uint);
231 void		xfs_trans_dirty_buf(struct xfs_trans *, struct xfs_buf *);
232 bool		xfs_trans_buf_is_dirty(struct xfs_buf *bp);
233 void		xfs_trans_log_inode(xfs_trans_t *, struct xfs_inode *, uint);
234 
235 int		xfs_trans_commit(struct xfs_trans *);
236 int		xfs_trans_roll(struct xfs_trans **);
237 int		xfs_trans_roll_inode(struct xfs_trans **, struct xfs_inode *);
238 void		xfs_trans_cancel(xfs_trans_t *);
239 int		xfs_trans_ail_init(struct xfs_mount *);
240 void		xfs_trans_ail_destroy(struct xfs_mount *);
241 
242 void		xfs_trans_buf_set_type(struct xfs_trans *, struct xfs_buf *,
243 				       enum xfs_blft);
244 void		xfs_trans_buf_copy_type(struct xfs_buf *dst_bp,
245 					struct xfs_buf *src_bp);
246 
247 extern struct kmem_cache	*xfs_trans_cache;
248 
249 struct xfs_dquot;
250 
251 int xfs_trans_alloc_inode(struct xfs_inode *ip, struct xfs_trans_res *resv,
252 		unsigned int dblocks, unsigned int rblocks, bool force,
253 		struct xfs_trans **tpp);
254 int xfs_trans_reserve_more_inode(struct xfs_trans *tp, struct xfs_inode *ip,
255 		unsigned int dblocks, unsigned int rblocks, bool force_quota);
256 int xfs_trans_alloc_icreate(struct xfs_mount *mp, struct xfs_trans_res *resv,
257 		struct xfs_dquot *udqp, struct xfs_dquot *gdqp,
258 		struct xfs_dquot *pdqp, unsigned int dblocks,
259 		struct xfs_trans **tpp);
260 int xfs_trans_alloc_ichange(struct xfs_inode *ip, struct xfs_dquot *udqp,
261 		struct xfs_dquot *gdqp, struct xfs_dquot *pdqp, bool force,
262 		struct xfs_trans **tpp);
263 int xfs_trans_alloc_dir(struct xfs_inode *dp, struct xfs_trans_res *resv,
264 		struct xfs_inode *ip, unsigned int *dblocks,
265 		struct xfs_trans **tpp, int *nospace_error);
266 
267 static inline void
268 xfs_trans_set_context(
269 	struct xfs_trans	*tp)
270 {
271 	tp->t_pflags = memalloc_nofs_save();
272 }
273 
274 static inline void
275 xfs_trans_clear_context(
276 	struct xfs_trans	*tp)
277 {
278 	memalloc_nofs_restore(tp->t_pflags);
279 }
280 
281 static inline void
282 xfs_trans_switch_context(
283 	struct xfs_trans	*old_tp,
284 	struct xfs_trans	*new_tp)
285 {
286 	new_tp->t_pflags = old_tp->t_pflags;
287 	old_tp->t_pflags = 0;
288 }
289 
290 #endif	/* __XFS_TRANS_H__ */
291