xref: /openbmc/linux/fs/xfs/xfs_trans.h (revision f125e2d4)
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 	void				(*li_cb)(struct xfs_buf *,
41 						 struct xfs_log_item *);
42 							/* buffer item iodone */
43 							/* callback func */
44 	const struct xfs_item_ops	*li_ops;	/* function list */
45 
46 	/* delayed logging */
47 	struct list_head		li_cil;		/* CIL pointers */
48 	struct xfs_log_vec		*li_lv;		/* active log vector */
49 	struct xfs_log_vec		*li_lv_shadow;	/* standby vector */
50 	xfs_lsn_t			li_seq;		/* CIL commit seq */
51 };
52 
53 /*
54  * li_flags use the (set/test/clear)_bit atomic interfaces because updates can
55  * race with each other and we don't want to have to use the AIL lock to
56  * serialise all updates.
57  */
58 #define	XFS_LI_IN_AIL	0
59 #define	XFS_LI_ABORTED	1
60 #define	XFS_LI_FAILED	2
61 #define	XFS_LI_DIRTY	3	/* log item dirty in transaction */
62 
63 #define XFS_LI_FLAGS \
64 	{ (1 << XFS_LI_IN_AIL),		"IN_AIL" }, \
65 	{ (1 << XFS_LI_ABORTED),	"ABORTED" }, \
66 	{ (1 << XFS_LI_FAILED),		"FAILED" }, \
67 	{ (1 << XFS_LI_DIRTY),		"DIRTY" }
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 	uint (*iop_push)(struct xfs_log_item *, struct list_head *);
76 	void (*iop_committing)(struct xfs_log_item *, xfs_lsn_t commit_lsn);
77 	void (*iop_release)(struct xfs_log_item *);
78 	xfs_lsn_t (*iop_committed)(struct xfs_log_item *, xfs_lsn_t);
79 	void (*iop_error)(struct xfs_log_item *, xfs_buf_t *);
80 };
81 
82 /*
83  * Release the log item as soon as committed.  This is for items just logging
84  * intents that never need to be written back in place.
85  */
86 #define XFS_ITEM_RELEASE_WHEN_COMMITTED	(1 << 0)
87 
88 void	xfs_log_item_init(struct xfs_mount *mp, struct xfs_log_item *item,
89 			  int type, const struct xfs_item_ops *ops);
90 
91 /*
92  * Return values for the iop_push() routines.
93  */
94 #define XFS_ITEM_SUCCESS	0
95 #define XFS_ITEM_PINNED		1
96 #define XFS_ITEM_LOCKED		2
97 #define XFS_ITEM_FLUSHING	3
98 
99 /*
100  * Deferred operation item relogging limits.
101  */
102 #define XFS_DEFER_OPS_NR_INODES	2	/* join up to two inodes */
103 #define XFS_DEFER_OPS_NR_BUFS	2	/* join up to two buffers */
104 
105 /*
106  * This is the structure maintained for every active transaction.
107  */
108 typedef struct xfs_trans {
109 	unsigned int		t_magic;	/* magic number */
110 	unsigned int		t_log_res;	/* amt of log space resvd */
111 	unsigned int		t_log_count;	/* count for perm log res */
112 	unsigned int		t_blk_res;	/* # of blocks resvd */
113 	unsigned int		t_blk_res_used;	/* # of resvd blocks used */
114 	unsigned int		t_rtx_res;	/* # of rt extents resvd */
115 	unsigned int		t_rtx_res_used;	/* # of resvd rt extents used */
116 	unsigned int		t_flags;	/* misc flags */
117 	xfs_fsblock_t		t_firstblock;	/* first block allocated */
118 	struct xlog_ticket	*t_ticket;	/* log mgr ticket */
119 	struct xfs_mount	*t_mountp;	/* ptr to fs mount struct */
120 	struct xfs_dquot_acct   *t_dqinfo;	/* acctg info for dquots */
121 	int64_t			t_icount_delta;	/* superblock icount change */
122 	int64_t			t_ifree_delta;	/* superblock ifree change */
123 	int64_t			t_fdblocks_delta; /* superblock fdblocks chg */
124 	int64_t			t_res_fdblocks_delta; /* on-disk only chg */
125 	int64_t			t_frextents_delta;/* superblock freextents chg*/
126 	int64_t			t_res_frextents_delta; /* on-disk only chg */
127 #if defined(DEBUG) || defined(XFS_WARN)
128 	int64_t			t_ag_freeblks_delta; /* debugging counter */
129 	int64_t			t_ag_flist_delta; /* debugging counter */
130 	int64_t			t_ag_btree_delta; /* debugging counter */
131 #endif
132 	int64_t			t_dblocks_delta;/* superblock dblocks change */
133 	int64_t			t_agcount_delta;/* superblock agcount change */
134 	int64_t			t_imaxpct_delta;/* superblock imaxpct change */
135 	int64_t			t_rextsize_delta;/* superblock rextsize chg */
136 	int64_t			t_rbmblocks_delta;/* superblock rbmblocks chg */
137 	int64_t			t_rblocks_delta;/* superblock rblocks change */
138 	int64_t			t_rextents_delta;/* superblocks rextents chg */
139 	int64_t			t_rextslog_delta;/* superblocks rextslog chg */
140 	struct list_head	t_items;	/* log item descriptors */
141 	struct list_head	t_busy;		/* list of busy extents */
142 	struct list_head	t_dfops;	/* deferred operations */
143 	unsigned long		t_pflags;	/* saved process flags state */
144 } xfs_trans_t;
145 
146 /*
147  * XFS transaction mechanism exported interfaces that are
148  * actually macros.
149  */
150 #define	xfs_trans_set_sync(tp)		((tp)->t_flags |= XFS_TRANS_SYNC)
151 
152 #if defined(DEBUG) || defined(XFS_WARN)
153 #define	xfs_trans_agblocks_delta(tp, d)	((tp)->t_ag_freeblks_delta += (int64_t)d)
154 #define	xfs_trans_agflist_delta(tp, d)	((tp)->t_ag_flist_delta += (int64_t)d)
155 #define	xfs_trans_agbtree_delta(tp, d)	((tp)->t_ag_btree_delta += (int64_t)d)
156 #else
157 #define	xfs_trans_agblocks_delta(tp, d)
158 #define	xfs_trans_agflist_delta(tp, d)
159 #define	xfs_trans_agbtree_delta(tp, d)
160 #endif
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 	uint			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(xfs_trans_t *, struct xfs_mount *);
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 kmem_zone_t	*xfs_trans_zone;
246 
247 #endif	/* __XFS_TRANS_H__ */
248