xref: /openbmc/linux/fs/xfs/xfs_trans.h (revision 48ca54e3)
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
59 #define	XFS_LI_WHITEOUT	4
60 
61 #define XFS_LI_FLAGS \
62 	{ (1u << XFS_LI_IN_AIL),	"IN_AIL" }, \
63 	{ (1u << XFS_LI_ABORTED),	"ABORTED" }, \
64 	{ (1u << XFS_LI_FAILED),	"FAILED" }, \
65 	{ (1u << XFS_LI_DIRTY),		"DIRTY" }, \
66 	{ (1u << XFS_LI_WHITEOUT),	"WHITEOUT" }
67 
68 struct xfs_item_ops {
69 	unsigned flags;
70 	void (*iop_size)(struct xfs_log_item *, int *, int *);
71 	void (*iop_format)(struct xfs_log_item *, struct xfs_log_vec *);
72 	void (*iop_pin)(struct xfs_log_item *);
73 	void (*iop_unpin)(struct xfs_log_item *, int remove);
74 	uint (*iop_push)(struct xfs_log_item *, struct list_head *);
75 	void (*iop_committing)(struct xfs_log_item *lip, xfs_csn_t seq);
76 	void (*iop_release)(struct xfs_log_item *);
77 	xfs_lsn_t (*iop_committed)(struct xfs_log_item *, xfs_lsn_t);
78 	int (*iop_recover)(struct xfs_log_item *lip,
79 			   struct list_head *capture_list);
80 	bool (*iop_match)(struct xfs_log_item *item, uint64_t id);
81 	struct xfs_log_item *(*iop_relog)(struct xfs_log_item *intent,
82 			struct xfs_trans *tp);
83 	struct xfs_log_item *(*iop_intent)(struct xfs_log_item *intent_done);
84 };
85 
86 /*
87  * Log item ops flags
88  */
89 /*
90  * Release the log item when the journal commits instead of inserting into the
91  * AIL for writeback tracking and/or log tail pinning.
92  */
93 #define XFS_ITEM_RELEASE_WHEN_COMMITTED	(1 << 0)
94 #define XFS_ITEM_INTENT			(1 << 1)
95 #define XFS_ITEM_INTENT_DONE		(1 << 2)
96 
97 static inline bool
98 xlog_item_is_intent(struct xfs_log_item *lip)
99 {
100 	return lip->li_ops->flags & XFS_ITEM_INTENT;
101 }
102 
103 static inline bool
104 xlog_item_is_intent_done(struct xfs_log_item *lip)
105 {
106 	return lip->li_ops->flags & XFS_ITEM_INTENT_DONE;
107 }
108 
109 void	xfs_log_item_init(struct xfs_mount *mp, struct xfs_log_item *item,
110 			  int type, const struct xfs_item_ops *ops);
111 
112 /*
113  * Return values for the iop_push() routines.
114  */
115 #define XFS_ITEM_SUCCESS	0
116 #define XFS_ITEM_PINNED		1
117 #define XFS_ITEM_LOCKED		2
118 #define XFS_ITEM_FLUSHING	3
119 
120 /*
121  * This is the structure maintained for every active transaction.
122  */
123 typedef struct xfs_trans {
124 	unsigned int		t_magic;	/* magic number */
125 	unsigned int		t_log_res;	/* amt of log space resvd */
126 	unsigned int		t_log_count;	/* count for perm log res */
127 	unsigned int		t_blk_res;	/* # of blocks resvd */
128 	unsigned int		t_blk_res_used;	/* # of resvd blocks used */
129 	unsigned int		t_rtx_res;	/* # of rt extents resvd */
130 	unsigned int		t_rtx_res_used;	/* # of resvd rt extents used */
131 	unsigned int		t_flags;	/* misc flags */
132 	xfs_fsblock_t		t_firstblock;	/* first block allocated */
133 	struct xlog_ticket	*t_ticket;	/* log mgr ticket */
134 	struct xfs_mount	*t_mountp;	/* ptr to fs mount struct */
135 	struct xfs_dquot_acct   *t_dqinfo;	/* acctg info for dquots */
136 	int64_t			t_icount_delta;	/* superblock icount change */
137 	int64_t			t_ifree_delta;	/* superblock ifree change */
138 	int64_t			t_fdblocks_delta; /* superblock fdblocks chg */
139 	int64_t			t_res_fdblocks_delta; /* on-disk only chg */
140 	int64_t			t_frextents_delta;/* superblock freextents chg*/
141 	int64_t			t_res_frextents_delta; /* on-disk only chg */
142 	int64_t			t_dblocks_delta;/* superblock dblocks change */
143 	int64_t			t_agcount_delta;/* superblock agcount change */
144 	int64_t			t_imaxpct_delta;/* superblock imaxpct change */
145 	int64_t			t_rextsize_delta;/* superblock rextsize chg */
146 	int64_t			t_rbmblocks_delta;/* superblock rbmblocks chg */
147 	int64_t			t_rblocks_delta;/* superblock rblocks change */
148 	int64_t			t_rextents_delta;/* superblocks rextents chg */
149 	int64_t			t_rextslog_delta;/* superblocks rextslog chg */
150 	struct list_head	t_items;	/* log item descriptors */
151 	struct list_head	t_busy;		/* list of busy extents */
152 	struct list_head	t_dfops;	/* deferred operations */
153 	unsigned long		t_pflags;	/* saved process flags state */
154 } xfs_trans_t;
155 
156 /*
157  * XFS transaction mechanism exported interfaces that are
158  * actually macros.
159  */
160 #define	xfs_trans_set_sync(tp)		((tp)->t_flags |= XFS_TRANS_SYNC)
161 
162 /*
163  * XFS transaction mechanism exported interfaces.
164  */
165 int		xfs_trans_alloc(struct xfs_mount *mp, struct xfs_trans_res *resp,
166 			uint blocks, uint rtextents, uint flags,
167 			struct xfs_trans **tpp);
168 int		xfs_trans_alloc_empty(struct xfs_mount *mp,
169 			struct xfs_trans **tpp);
170 void		xfs_trans_mod_sb(xfs_trans_t *, uint, int64_t);
171 
172 int xfs_trans_get_buf_map(struct xfs_trans *tp, struct xfs_buftarg *target,
173 		struct xfs_buf_map *map, int nmaps, xfs_buf_flags_t flags,
174 		struct xfs_buf **bpp);
175 
176 static inline int
177 xfs_trans_get_buf(
178 	struct xfs_trans	*tp,
179 	struct xfs_buftarg	*target,
180 	xfs_daddr_t		blkno,
181 	int			numblks,
182 	xfs_buf_flags_t		flags,
183 	struct xfs_buf		**bpp)
184 {
185 	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
186 	return xfs_trans_get_buf_map(tp, target, &map, 1, flags, bpp);
187 }
188 
189 int		xfs_trans_read_buf_map(struct xfs_mount *mp,
190 				       struct xfs_trans *tp,
191 				       struct xfs_buftarg *target,
192 				       struct xfs_buf_map *map, int nmaps,
193 				       xfs_buf_flags_t flags,
194 				       struct xfs_buf **bpp,
195 				       const struct xfs_buf_ops *ops);
196 
197 static inline int
198 xfs_trans_read_buf(
199 	struct xfs_mount	*mp,
200 	struct xfs_trans	*tp,
201 	struct xfs_buftarg	*target,
202 	xfs_daddr_t		blkno,
203 	int			numblks,
204 	xfs_buf_flags_t		flags,
205 	struct xfs_buf		**bpp,
206 	const struct xfs_buf_ops *ops)
207 {
208 	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
209 	return xfs_trans_read_buf_map(mp, tp, target, &map, 1,
210 				      flags, bpp, ops);
211 }
212 
213 struct xfs_buf	*xfs_trans_getsb(struct xfs_trans *);
214 
215 void		xfs_trans_brelse(xfs_trans_t *, struct xfs_buf *);
216 void		xfs_trans_bjoin(xfs_trans_t *, struct xfs_buf *);
217 void		xfs_trans_bhold(xfs_trans_t *, struct xfs_buf *);
218 void		xfs_trans_bhold_release(xfs_trans_t *, struct xfs_buf *);
219 void		xfs_trans_binval(xfs_trans_t *, struct xfs_buf *);
220 void		xfs_trans_inode_buf(xfs_trans_t *, struct xfs_buf *);
221 void		xfs_trans_stale_inode_buf(xfs_trans_t *, struct xfs_buf *);
222 bool		xfs_trans_ordered_buf(xfs_trans_t *, struct xfs_buf *);
223 void		xfs_trans_dquot_buf(xfs_trans_t *, struct xfs_buf *, uint);
224 void		xfs_trans_inode_alloc_buf(xfs_trans_t *, struct xfs_buf *);
225 void		xfs_trans_ichgtime(struct xfs_trans *, struct xfs_inode *, int);
226 void		xfs_trans_ijoin(struct xfs_trans *, struct xfs_inode *, uint);
227 void		xfs_trans_log_buf(struct xfs_trans *, struct xfs_buf *, uint,
228 				  uint);
229 void		xfs_trans_dirty_buf(struct xfs_trans *, struct xfs_buf *);
230 bool		xfs_trans_buf_is_dirty(struct xfs_buf *bp);
231 void		xfs_trans_log_inode(xfs_trans_t *, struct xfs_inode *, uint);
232 
233 int		xfs_trans_commit(struct xfs_trans *);
234 int		xfs_trans_roll(struct xfs_trans **);
235 int		xfs_trans_roll_inode(struct xfs_trans **, struct xfs_inode *);
236 void		xfs_trans_cancel(xfs_trans_t *);
237 int		xfs_trans_ail_init(struct xfs_mount *);
238 void		xfs_trans_ail_destroy(struct xfs_mount *);
239 
240 void		xfs_trans_buf_set_type(struct xfs_trans *, struct xfs_buf *,
241 				       enum xfs_blft);
242 void		xfs_trans_buf_copy_type(struct xfs_buf *dst_bp,
243 					struct xfs_buf *src_bp);
244 
245 extern struct kmem_cache	*xfs_trans_cache;
246 
247 static inline struct xfs_log_item *
248 xfs_trans_item_relog(
249 	struct xfs_log_item	*lip,
250 	struct xfs_trans	*tp)
251 {
252 	return lip->li_ops->iop_relog(lip, tp);
253 }
254 
255 struct xfs_dquot;
256 
257 int xfs_trans_alloc_inode(struct xfs_inode *ip, struct xfs_trans_res *resv,
258 		unsigned int dblocks, unsigned int rblocks, bool force,
259 		struct xfs_trans **tpp);
260 int xfs_trans_alloc_icreate(struct xfs_mount *mp, struct xfs_trans_res *resv,
261 		struct xfs_dquot *udqp, struct xfs_dquot *gdqp,
262 		struct xfs_dquot *pdqp, unsigned int dblocks,
263 		struct xfs_trans **tpp);
264 int xfs_trans_alloc_ichange(struct xfs_inode *ip, struct xfs_dquot *udqp,
265 		struct xfs_dquot *gdqp, struct xfs_dquot *pdqp, bool force,
266 		struct xfs_trans **tpp);
267 int xfs_trans_alloc_dir(struct xfs_inode *dp, struct xfs_trans_res *resv,
268 		struct xfs_inode *ip, unsigned int *dblocks,
269 		struct xfs_trans **tpp, int *nospace_error);
270 
271 static inline void
272 xfs_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 
280 static inline void
281 xfs_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 
290 static inline void
291 xfs_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