xref: /kernel/linux/linux-5.10/fs/xfs/xfs_trans.h (revision 8c2ecf20)
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
11struct xfs_buf;
12struct xfs_buftarg;
13struct xfs_efd_log_item;
14struct xfs_efi_log_item;
15struct xfs_inode;
16struct xfs_item_ops;
17struct xfs_log_iovec;
18struct xfs_mount;
19struct xfs_trans;
20struct xfs_trans_res;
21struct xfs_dquot_acct;
22struct xfs_rud_log_item;
23struct xfs_rui_log_item;
24struct xfs_btree_cur;
25struct xfs_cui_log_item;
26struct xfs_cud_log_item;
27struct xfs_bui_log_item;
28struct xfs_bud_log_item;
29
30struct xfs_log_item {
31	struct list_head		li_ail;		/* AIL pointers */
32	struct list_head		li_trans;	/* transaction list */
33	xfs_lsn_t			li_lsn;		/* last on-disk lsn */
34	struct xfs_mount		*li_mountp;	/* ptr to fs mount */
35	struct xfs_ail			*li_ailp;	/* ptr to AIL */
36	uint				li_type;	/* item type */
37	unsigned long			li_flags;	/* misc flags */
38	struct xfs_buf			*li_buf;	/* real buffer pointer */
39	struct list_head		li_bio_list;	/* buffer item list */
40	const struct xfs_item_ops	*li_ops;	/* function list */
41
42	/* delayed logging */
43	struct list_head		li_cil;		/* CIL pointers */
44	struct xfs_log_vec		*li_lv;		/* active log vector */
45	struct xfs_log_vec		*li_lv_shadow;	/* standby vector */
46	xfs_csn_t			li_seq;		/* CIL commit seq */
47};
48
49/*
50 * li_flags use the (set/test/clear)_bit atomic interfaces because updates can
51 * race with each other and we don't want to have to use the AIL lock to
52 * serialise all updates.
53 */
54#define	XFS_LI_IN_AIL	0
55#define	XFS_LI_ABORTED	1
56#define	XFS_LI_FAILED	2
57#define	XFS_LI_DIRTY	3	/* log item dirty in transaction */
58
59#define XFS_LI_FLAGS \
60	{ (1 << XFS_LI_IN_AIL),		"IN_AIL" }, \
61	{ (1 << XFS_LI_ABORTED),	"ABORTED" }, \
62	{ (1 << XFS_LI_FAILED),		"FAILED" }, \
63	{ (1 << XFS_LI_DIRTY),		"DIRTY" }
64
65struct xfs_item_ops {
66	unsigned flags;
67	void (*iop_size)(struct xfs_log_item *, int *, int *);
68	void (*iop_format)(struct xfs_log_item *, struct xfs_log_vec *);
69	void (*iop_pin)(struct xfs_log_item *);
70	void (*iop_unpin)(struct xfs_log_item *, int remove);
71	uint (*iop_push)(struct xfs_log_item *, struct list_head *);
72	void (*iop_committing)(struct xfs_log_item *lip, xfs_csn_t seq);
73	void (*iop_release)(struct xfs_log_item *);
74	xfs_lsn_t (*iop_committed)(struct xfs_log_item *, xfs_lsn_t);
75	int (*iop_recover)(struct xfs_log_item *lip,
76			   struct list_head *capture_list);
77	bool (*iop_match)(struct xfs_log_item *item, uint64_t id);
78	struct xfs_log_item *(*iop_relog)(struct xfs_log_item *intent,
79			struct xfs_trans *tp);
80};
81
82/* Is this log item a deferred action intent? */
83static inline bool
84xlog_item_is_intent(struct xfs_log_item *lip)
85{
86	return lip->li_ops->iop_recover != NULL &&
87	       lip->li_ops->iop_match != NULL;
88}
89
90/* Is this a log intent-done item? */
91static inline bool
92xlog_item_is_intent_done(struct xfs_log_item *lip)
93{
94	return lip->li_ops->iop_unpin == NULL &&
95	       lip->li_ops->iop_push == NULL;
96}
97
98/*
99 * Release the log item as soon as committed.  This is for items just logging
100 * intents that never need to be written back in place.
101 */
102#define XFS_ITEM_RELEASE_WHEN_COMMITTED	(1 << 0)
103
104void	xfs_log_item_init(struct xfs_mount *mp, struct xfs_log_item *item,
105			  int type, const struct xfs_item_ops *ops);
106
107/*
108 * Return values for the iop_push() routines.
109 */
110#define XFS_ITEM_SUCCESS	0
111#define XFS_ITEM_PINNED		1
112#define XFS_ITEM_LOCKED		2
113#define XFS_ITEM_FLUSHING	3
114
115/*
116 * Deferred operation item relogging limits.
117 */
118#define XFS_DEFER_OPS_NR_INODES	2	/* join up to two inodes */
119#define XFS_DEFER_OPS_NR_BUFS	2	/* join up to two buffers */
120
121/*
122 * This is the structure maintained for every active transaction.
123 */
124typedef struct xfs_trans {
125	unsigned int		t_magic;	/* magic number */
126	unsigned int		t_log_res;	/* amt of log space resvd */
127	unsigned int		t_log_count;	/* count for perm log res */
128	unsigned int		t_blk_res;	/* # of blocks resvd */
129	unsigned int		t_blk_res_used;	/* # of resvd blocks used */
130	unsigned int		t_rtx_res;	/* # of rt extents resvd */
131	unsigned int		t_rtx_res_used;	/* # of resvd rt extents used */
132	unsigned int		t_flags;	/* misc flags */
133	xfs_fsblock_t		t_firstblock;	/* first block allocated */
134	struct xlog_ticket	*t_ticket;	/* log mgr ticket */
135	struct xfs_mount	*t_mountp;	/* ptr to fs mount struct */
136	struct xfs_dquot_acct   *t_dqinfo;	/* acctg info for dquots */
137	int64_t			t_icount_delta;	/* superblock icount change */
138	int64_t			t_ifree_delta;	/* superblock ifree change */
139	int64_t			t_fdblocks_delta; /* superblock fdblocks chg */
140	int64_t			t_res_fdblocks_delta; /* on-disk only chg */
141	int64_t			t_frextents_delta;/* superblock freextents chg*/
142	int64_t			t_res_frextents_delta; /* on-disk only chg */
143#if defined(DEBUG) || defined(XFS_WARN)
144	int64_t			t_ag_freeblks_delta; /* debugging counter */
145	int64_t			t_ag_flist_delta; /* debugging counter */
146	int64_t			t_ag_btree_delta; /* debugging counter */
147#endif
148	int64_t			t_dblocks_delta;/* superblock dblocks change */
149	int64_t			t_agcount_delta;/* superblock agcount change */
150	int64_t			t_imaxpct_delta;/* superblock imaxpct change */
151	int64_t			t_rextsize_delta;/* superblock rextsize chg */
152	int64_t			t_rbmblocks_delta;/* superblock rbmblocks chg */
153	int64_t			t_rblocks_delta;/* superblock rblocks change */
154	int64_t			t_rextents_delta;/* superblocks rextents chg */
155	int64_t			t_rextslog_delta;/* superblocks rextslog chg */
156	struct list_head	t_items;	/* log item descriptors */
157	struct list_head	t_busy;		/* list of busy extents */
158	struct list_head	t_dfops;	/* deferred operations */
159	unsigned long		t_pflags;	/* saved process flags state */
160} xfs_trans_t;
161
162/*
163 * XFS transaction mechanism exported interfaces that are
164 * actually macros.
165 */
166#define	xfs_trans_set_sync(tp)		((tp)->t_flags |= XFS_TRANS_SYNC)
167
168#if defined(DEBUG) || defined(XFS_WARN)
169#define	xfs_trans_agblocks_delta(tp, d)	((tp)->t_ag_freeblks_delta += (int64_t)d)
170#define	xfs_trans_agflist_delta(tp, d)	((tp)->t_ag_flist_delta += (int64_t)d)
171#define	xfs_trans_agbtree_delta(tp, d)	((tp)->t_ag_btree_delta += (int64_t)d)
172#else
173#define	xfs_trans_agblocks_delta(tp, d)
174#define	xfs_trans_agflist_delta(tp, d)
175#define	xfs_trans_agbtree_delta(tp, d)
176#endif
177
178/*
179 * XFS transaction mechanism exported interfaces.
180 */
181int		xfs_trans_alloc(struct xfs_mount *mp, struct xfs_trans_res *resp,
182			uint blocks, uint rtextents, uint flags,
183			struct xfs_trans **tpp);
184int		xfs_trans_alloc_empty(struct xfs_mount *mp,
185			struct xfs_trans **tpp);
186void		xfs_trans_mod_sb(xfs_trans_t *, uint, int64_t);
187
188int xfs_trans_get_buf_map(struct xfs_trans *tp, struct xfs_buftarg *target,
189		struct xfs_buf_map *map, int nmaps, xfs_buf_flags_t flags,
190		struct xfs_buf **bpp);
191
192static inline int
193xfs_trans_get_buf(
194	struct xfs_trans	*tp,
195	struct xfs_buftarg	*target,
196	xfs_daddr_t		blkno,
197	int			numblks,
198	uint			flags,
199	struct xfs_buf		**bpp)
200{
201	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
202	return xfs_trans_get_buf_map(tp, target, &map, 1, flags, bpp);
203}
204
205int		xfs_trans_read_buf_map(struct xfs_mount *mp,
206				       struct xfs_trans *tp,
207				       struct xfs_buftarg *target,
208				       struct xfs_buf_map *map, int nmaps,
209				       xfs_buf_flags_t flags,
210				       struct xfs_buf **bpp,
211				       const struct xfs_buf_ops *ops);
212
213static inline int
214xfs_trans_read_buf(
215	struct xfs_mount	*mp,
216	struct xfs_trans	*tp,
217	struct xfs_buftarg	*target,
218	xfs_daddr_t		blkno,
219	int			numblks,
220	xfs_buf_flags_t		flags,
221	struct xfs_buf		**bpp,
222	const struct xfs_buf_ops *ops)
223{
224	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
225	return xfs_trans_read_buf_map(mp, tp, target, &map, 1,
226				      flags, bpp, ops);
227}
228
229struct xfs_buf	*xfs_trans_getsb(struct xfs_trans *);
230
231void		xfs_trans_brelse(xfs_trans_t *, struct xfs_buf *);
232void		xfs_trans_bjoin(xfs_trans_t *, struct xfs_buf *);
233void		xfs_trans_bhold(xfs_trans_t *, struct xfs_buf *);
234void		xfs_trans_bhold_release(xfs_trans_t *, struct xfs_buf *);
235void		xfs_trans_binval(xfs_trans_t *, struct xfs_buf *);
236void		xfs_trans_inode_buf(xfs_trans_t *, struct xfs_buf *);
237void		xfs_trans_stale_inode_buf(xfs_trans_t *, struct xfs_buf *);
238bool		xfs_trans_ordered_buf(xfs_trans_t *, struct xfs_buf *);
239void		xfs_trans_dquot_buf(xfs_trans_t *, struct xfs_buf *, uint);
240void		xfs_trans_inode_alloc_buf(xfs_trans_t *, struct xfs_buf *);
241void		xfs_trans_ichgtime(struct xfs_trans *, struct xfs_inode *, int);
242void		xfs_trans_ijoin(struct xfs_trans *, struct xfs_inode *, uint);
243void		xfs_trans_log_buf(struct xfs_trans *, struct xfs_buf *, uint,
244				  uint);
245void		xfs_trans_dirty_buf(struct xfs_trans *, struct xfs_buf *);
246bool		xfs_trans_buf_is_dirty(struct xfs_buf *bp);
247void		xfs_trans_log_inode(xfs_trans_t *, struct xfs_inode *, uint);
248
249int		xfs_trans_commit(struct xfs_trans *);
250int		xfs_trans_roll(struct xfs_trans **);
251int		xfs_trans_roll_inode(struct xfs_trans **, struct xfs_inode *);
252void		xfs_trans_cancel(xfs_trans_t *);
253int		xfs_trans_ail_init(struct xfs_mount *);
254void		xfs_trans_ail_destroy(struct xfs_mount *);
255
256void		xfs_trans_buf_set_type(struct xfs_trans *, struct xfs_buf *,
257				       enum xfs_blft);
258void		xfs_trans_buf_copy_type(struct xfs_buf *dst_bp,
259					struct xfs_buf *src_bp);
260
261extern kmem_zone_t	*xfs_trans_zone;
262
263static inline struct xfs_log_item *
264xfs_trans_item_relog(
265	struct xfs_log_item	*lip,
266	struct xfs_trans	*tp)
267{
268	return lip->li_ops->iop_relog(lip, tp);
269}
270
271static inline void
272xfs_trans_set_context(
273	struct xfs_trans	*tp)
274{
275	ASSERT(current->journal_info == NULL);
276	tp->t_pflags = memalloc_nofs_save();
277	current->journal_info = tp;
278}
279
280static inline void
281xfs_trans_clear_context(
282	struct xfs_trans	*tp)
283{
284	if (current->journal_info == tp) {
285		memalloc_nofs_restore(tp->t_pflags);
286		current->journal_info = NULL;
287	}
288}
289
290static inline void
291xfs_trans_switch_context(
292	struct xfs_trans	*old_tp,
293	struct xfs_trans	*new_tp)
294{
295	ASSERT(current->journal_info == old_tp);
296	new_tp->t_pflags = old_tp->t_pflags;
297	old_tp->t_pflags = 0;
298	current->journal_info = new_tp;
299}
300
301#endif	/* __XFS_TRANS_H__ */
302