xref: /openbmc/linux/fs/xfs/xfs_trans.h (revision 2427f03f)
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 xfs_buf;
12 struct xfs_buftarg;
13 struct xfs_efd_log_item;
14 struct xfs_efi_log_item;
15 struct xfs_inode;
16 struct xfs_item_ops;
17 struct xfs_log_iovec;
18 struct xfs_mount;
19 struct xfs_trans;
20 struct xfs_trans_res;
21 struct xfs_dquot_acct;
22 struct xfs_rud_log_item;
23 struct xfs_rui_log_item;
24 struct xfs_btree_cur;
25 struct xfs_cui_log_item;
26 struct xfs_cud_log_item;
27 struct xfs_bui_log_item;
28 struct xfs_bud_log_item;
29 
30 struct 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 
65 struct 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? */
83 static inline bool
84 xlog_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? */
91 static inline bool
92 xlog_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 
104 void	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  * This is the structure maintained for every active transaction.
117  */
118 typedef struct xfs_trans {
119 	unsigned int		t_magic;	/* magic number */
120 	unsigned int		t_log_res;	/* amt of log space resvd */
121 	unsigned int		t_log_count;	/* count for perm log res */
122 	unsigned int		t_blk_res;	/* # of blocks resvd */
123 	unsigned int		t_blk_res_used;	/* # of resvd blocks used */
124 	unsigned int		t_rtx_res;	/* # of rt extents resvd */
125 	unsigned int		t_rtx_res_used;	/* # of resvd rt extents used */
126 	unsigned int		t_flags;	/* misc flags */
127 	xfs_fsblock_t		t_firstblock;	/* first block allocated */
128 	struct xlog_ticket	*t_ticket;	/* log mgr ticket */
129 	struct xfs_mount	*t_mountp;	/* ptr to fs mount struct */
130 	struct xfs_dquot_acct   *t_dqinfo;	/* acctg info for dquots */
131 	int64_t			t_icount_delta;	/* superblock icount change */
132 	int64_t			t_ifree_delta;	/* superblock ifree change */
133 	int64_t			t_fdblocks_delta; /* superblock fdblocks chg */
134 	int64_t			t_res_fdblocks_delta; /* on-disk only chg */
135 	int64_t			t_frextents_delta;/* superblock freextents chg*/
136 	int64_t			t_res_frextents_delta; /* on-disk only chg */
137 	int64_t			t_dblocks_delta;/* superblock dblocks change */
138 	int64_t			t_agcount_delta;/* superblock agcount change */
139 	int64_t			t_imaxpct_delta;/* superblock imaxpct change */
140 	int64_t			t_rextsize_delta;/* superblock rextsize chg */
141 	int64_t			t_rbmblocks_delta;/* superblock rbmblocks chg */
142 	int64_t			t_rblocks_delta;/* superblock rblocks change */
143 	int64_t			t_rextents_delta;/* superblocks rextents chg */
144 	int64_t			t_rextslog_delta;/* superblocks rextslog chg */
145 	struct list_head	t_items;	/* log item descriptors */
146 	struct list_head	t_busy;		/* list of busy extents */
147 	struct list_head	t_dfops;	/* deferred operations */
148 	unsigned long		t_pflags;	/* saved process flags state */
149 } xfs_trans_t;
150 
151 /*
152  * XFS transaction mechanism exported interfaces that are
153  * actually macros.
154  */
155 #define	xfs_trans_set_sync(tp)		((tp)->t_flags |= XFS_TRANS_SYNC)
156 
157 /*
158  * XFS transaction mechanism exported interfaces.
159  */
160 int		xfs_trans_alloc(struct xfs_mount *mp, struct xfs_trans_res *resp,
161 			uint blocks, uint rtextents, uint flags,
162 			struct xfs_trans **tpp);
163 int		xfs_trans_alloc_empty(struct xfs_mount *mp,
164 			struct xfs_trans **tpp);
165 void		xfs_trans_mod_sb(xfs_trans_t *, uint, int64_t);
166 
167 int xfs_trans_get_buf_map(struct xfs_trans *tp, struct xfs_buftarg *target,
168 		struct xfs_buf_map *map, int nmaps, xfs_buf_flags_t flags,
169 		struct xfs_buf **bpp);
170 
171 static inline int
172 xfs_trans_get_buf(
173 	struct xfs_trans	*tp,
174 	struct xfs_buftarg	*target,
175 	xfs_daddr_t		blkno,
176 	int			numblks,
177 	uint			flags,
178 	struct xfs_buf		**bpp)
179 {
180 	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
181 	return xfs_trans_get_buf_map(tp, target, &map, 1, flags, bpp);
182 }
183 
184 int		xfs_trans_read_buf_map(struct xfs_mount *mp,
185 				       struct xfs_trans *tp,
186 				       struct xfs_buftarg *target,
187 				       struct xfs_buf_map *map, int nmaps,
188 				       xfs_buf_flags_t flags,
189 				       struct xfs_buf **bpp,
190 				       const struct xfs_buf_ops *ops);
191 
192 static inline int
193 xfs_trans_read_buf(
194 	struct xfs_mount	*mp,
195 	struct xfs_trans	*tp,
196 	struct xfs_buftarg	*target,
197 	xfs_daddr_t		blkno,
198 	int			numblks,
199 	xfs_buf_flags_t		flags,
200 	struct xfs_buf		**bpp,
201 	const struct xfs_buf_ops *ops)
202 {
203 	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
204 	return xfs_trans_read_buf_map(mp, tp, target, &map, 1,
205 				      flags, bpp, ops);
206 }
207 
208 struct xfs_buf	*xfs_trans_getsb(struct xfs_trans *);
209 
210 void		xfs_trans_brelse(xfs_trans_t *, struct xfs_buf *);
211 void		xfs_trans_bjoin(xfs_trans_t *, struct xfs_buf *);
212 void		xfs_trans_bhold(xfs_trans_t *, struct xfs_buf *);
213 void		xfs_trans_bhold_release(xfs_trans_t *, struct xfs_buf *);
214 void		xfs_trans_binval(xfs_trans_t *, struct xfs_buf *);
215 void		xfs_trans_inode_buf(xfs_trans_t *, struct xfs_buf *);
216 void		xfs_trans_stale_inode_buf(xfs_trans_t *, struct xfs_buf *);
217 bool		xfs_trans_ordered_buf(xfs_trans_t *, struct xfs_buf *);
218 void		xfs_trans_dquot_buf(xfs_trans_t *, struct xfs_buf *, uint);
219 void		xfs_trans_inode_alloc_buf(xfs_trans_t *, struct xfs_buf *);
220 void		xfs_trans_ichgtime(struct xfs_trans *, struct xfs_inode *, int);
221 void		xfs_trans_ijoin(struct xfs_trans *, struct xfs_inode *, uint);
222 void		xfs_trans_log_buf(struct xfs_trans *, struct xfs_buf *, uint,
223 				  uint);
224 void		xfs_trans_dirty_buf(struct xfs_trans *, struct xfs_buf *);
225 bool		xfs_trans_buf_is_dirty(struct xfs_buf *bp);
226 void		xfs_trans_log_inode(xfs_trans_t *, struct xfs_inode *, uint);
227 
228 int		xfs_trans_commit(struct xfs_trans *);
229 int		xfs_trans_roll(struct xfs_trans **);
230 int		xfs_trans_roll_inode(struct xfs_trans **, struct xfs_inode *);
231 void		xfs_trans_cancel(xfs_trans_t *);
232 int		xfs_trans_ail_init(struct xfs_mount *);
233 void		xfs_trans_ail_destroy(struct xfs_mount *);
234 
235 void		xfs_trans_buf_set_type(struct xfs_trans *, struct xfs_buf *,
236 				       enum xfs_blft);
237 void		xfs_trans_buf_copy_type(struct xfs_buf *dst_bp,
238 					struct xfs_buf *src_bp);
239 
240 extern struct kmem_cache	*xfs_trans_cache;
241 
242 static inline struct xfs_log_item *
243 xfs_trans_item_relog(
244 	struct xfs_log_item	*lip,
245 	struct xfs_trans	*tp)
246 {
247 	return lip->li_ops->iop_relog(lip, tp);
248 }
249 
250 struct xfs_dquot;
251 
252 int xfs_trans_alloc_inode(struct xfs_inode *ip, struct xfs_trans_res *resv,
253 		unsigned int dblocks, unsigned int rblocks, bool force,
254 		struct xfs_trans **tpp);
255 int xfs_trans_alloc_icreate(struct xfs_mount *mp, struct xfs_trans_res *resv,
256 		struct xfs_dquot *udqp, struct xfs_dquot *gdqp,
257 		struct xfs_dquot *pdqp, unsigned int dblocks,
258 		struct xfs_trans **tpp);
259 int xfs_trans_alloc_ichange(struct xfs_inode *ip, struct xfs_dquot *udqp,
260 		struct xfs_dquot *gdqp, struct xfs_dquot *pdqp, bool force,
261 		struct xfs_trans **tpp);
262 
263 static inline void
264 xfs_trans_set_context(
265 	struct xfs_trans	*tp)
266 {
267 	ASSERT(current->journal_info == NULL);
268 	tp->t_pflags = memalloc_nofs_save();
269 	current->journal_info = tp;
270 }
271 
272 static inline void
273 xfs_trans_clear_context(
274 	struct xfs_trans	*tp)
275 {
276 	if (current->journal_info == tp) {
277 		memalloc_nofs_restore(tp->t_pflags);
278 		current->journal_info = NULL;
279 	}
280 }
281 
282 static inline void
283 xfs_trans_switch_context(
284 	struct xfs_trans	*old_tp,
285 	struct xfs_trans	*new_tp)
286 {
287 	ASSERT(current->journal_info == old_tp);
288 	new_tp->t_pflags = old_tp->t_pflags;
289 	old_tp->t_pflags = 0;
290 	current->journal_info = new_tp;
291 }
292 
293 #endif	/* __XFS_TRANS_H__ */
294