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