xref: /openbmc/linux/fs/xfs/xfs_trans.h (revision c000c4f1)
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_defer_ops;
28 struct xfs_bui_log_item;
29 struct xfs_bud_log_item;
30 
31 typedef 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 xfs_mount		*li_mountp;	/* ptr to fs mount */
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 	void				(*li_cb)(struct xfs_buf *,
42 						 struct xfs_log_item *);
43 							/* buffer item iodone */
44 							/* callback func */
45 	const struct xfs_item_ops	*li_ops;	/* function list */
46 
47 	/* delayed logging */
48 	struct list_head		li_cil;		/* CIL pointers */
49 	struct xfs_log_vec		*li_lv;		/* active log vector */
50 	struct xfs_log_vec		*li_lv_shadow;	/* standby vector */
51 	xfs_lsn_t			li_seq;		/* CIL commit seq */
52 } xfs_log_item_t;
53 
54 /*
55  * li_flags use the (set/test/clear)_bit atomic interfaces because updates can
56  * race with each other and we don't want to have to use the AIL lock to
57  * serialise all updates.
58  */
59 #define	XFS_LI_IN_AIL	0
60 #define	XFS_LI_ABORTED	1
61 #define	XFS_LI_FAILED	2
62 #define	XFS_LI_DIRTY	3	/* log item dirty in transaction */
63 
64 #define XFS_LI_FLAGS \
65 	{ (1 << XFS_LI_IN_AIL),		"IN_AIL" }, \
66 	{ (1 << XFS_LI_ABORTED),	"ABORTED" }, \
67 	{ (1 << XFS_LI_FAILED),		"FAILED" }, \
68 	{ (1 << XFS_LI_DIRTY),		"DIRTY" }
69 
70 struct xfs_item_ops {
71 	void (*iop_size)(xfs_log_item_t *, int *, int *);
72 	void (*iop_format)(xfs_log_item_t *, struct xfs_log_vec *);
73 	void (*iop_pin)(xfs_log_item_t *);
74 	void (*iop_unpin)(xfs_log_item_t *, int remove);
75 	uint (*iop_push)(struct xfs_log_item *, struct list_head *);
76 	void (*iop_unlock)(xfs_log_item_t *);
77 	xfs_lsn_t (*iop_committed)(xfs_log_item_t *, xfs_lsn_t);
78 	void (*iop_committing)(xfs_log_item_t *, xfs_lsn_t);
79 	void (*iop_error)(xfs_log_item_t *, xfs_buf_t *);
80 };
81 
82 void	xfs_log_item_init(struct xfs_mount *mp, struct xfs_log_item *item,
83 			  int type, const struct xfs_item_ops *ops);
84 
85 /*
86  * Return values for the iop_push() routines.
87  */
88 #define XFS_ITEM_SUCCESS	0
89 #define XFS_ITEM_PINNED		1
90 #define XFS_ITEM_LOCKED		2
91 #define XFS_ITEM_FLUSHING	3
92 
93 
94 /*
95  * This is the structure maintained for every active transaction.
96  */
97 typedef struct xfs_trans {
98 	unsigned int		t_magic;	/* magic number */
99 	unsigned int		t_log_res;	/* amt of log space resvd */
100 	unsigned int		t_log_count;	/* count for perm log res */
101 	unsigned int		t_blk_res;	/* # of blocks resvd */
102 	unsigned int		t_blk_res_used;	/* # of resvd blocks used */
103 	unsigned int		t_rtx_res;	/* # of rt extents resvd */
104 	unsigned int		t_rtx_res_used;	/* # of resvd rt extents used */
105 	struct xlog_ticket	*t_ticket;	/* log mgr ticket */
106 	struct xfs_mount	*t_mountp;	/* ptr to fs mount struct */
107 	struct xfs_dquot_acct   *t_dqinfo;	/* acctg info for dquots */
108 	struct xfs_defer_ops	*t_agfl_dfops;	/* optional agfl fixup dfops */
109 	unsigned int		t_flags;	/* misc flags */
110 	int64_t			t_icount_delta;	/* superblock icount change */
111 	int64_t			t_ifree_delta;	/* superblock ifree change */
112 	int64_t			t_fdblocks_delta; /* superblock fdblocks chg */
113 	int64_t			t_res_fdblocks_delta; /* on-disk only chg */
114 	int64_t			t_frextents_delta;/* superblock freextents chg*/
115 	int64_t			t_res_frextents_delta; /* on-disk only chg */
116 #if defined(DEBUG) || defined(XFS_WARN)
117 	int64_t			t_ag_freeblks_delta; /* debugging counter */
118 	int64_t			t_ag_flist_delta; /* debugging counter */
119 	int64_t			t_ag_btree_delta; /* debugging counter */
120 #endif
121 	int64_t			t_dblocks_delta;/* superblock dblocks change */
122 	int64_t			t_agcount_delta;/* superblock agcount change */
123 	int64_t			t_imaxpct_delta;/* superblock imaxpct change */
124 	int64_t			t_rextsize_delta;/* superblock rextsize chg */
125 	int64_t			t_rbmblocks_delta;/* superblock rbmblocks chg */
126 	int64_t			t_rblocks_delta;/* superblock rblocks change */
127 	int64_t			t_rextents_delta;/* superblocks rextents chg */
128 	int64_t			t_rextslog_delta;/* superblocks rextslog chg */
129 	struct list_head	t_items;	/* log item descriptors */
130 	struct list_head	t_busy;		/* list of busy extents */
131 	unsigned long		t_pflags;	/* saved process flags state */
132 } xfs_trans_t;
133 
134 /*
135  * XFS transaction mechanism exported interfaces that are
136  * actually macros.
137  */
138 #define	xfs_trans_set_sync(tp)		((tp)->t_flags |= XFS_TRANS_SYNC)
139 
140 #if defined(DEBUG) || defined(XFS_WARN)
141 #define	xfs_trans_agblocks_delta(tp, d)	((tp)->t_ag_freeblks_delta += (int64_t)d)
142 #define	xfs_trans_agflist_delta(tp, d)	((tp)->t_ag_flist_delta += (int64_t)d)
143 #define	xfs_trans_agbtree_delta(tp, d)	((tp)->t_ag_btree_delta += (int64_t)d)
144 #else
145 #define	xfs_trans_agblocks_delta(tp, d)
146 #define	xfs_trans_agflist_delta(tp, d)
147 #define	xfs_trans_agbtree_delta(tp, d)
148 #endif
149 
150 /*
151  * XFS transaction mechanism exported interfaces.
152  */
153 int		xfs_trans_alloc(struct xfs_mount *mp, struct xfs_trans_res *resp,
154 			uint blocks, uint rtextents, uint flags,
155 			struct xfs_trans **tpp);
156 int		xfs_trans_alloc_empty(struct xfs_mount *mp,
157 			struct xfs_trans **tpp);
158 void		xfs_trans_mod_sb(xfs_trans_t *, uint, int64_t);
159 
160 struct xfs_buf	*xfs_trans_get_buf_map(struct xfs_trans *tp,
161 				       struct xfs_buftarg *target,
162 				       struct xfs_buf_map *map, int nmaps,
163 				       uint flags);
164 
165 static inline struct xfs_buf *
166 xfs_trans_get_buf(
167 	struct xfs_trans	*tp,
168 	struct xfs_buftarg	*target,
169 	xfs_daddr_t		blkno,
170 	int			numblks,
171 	uint			flags)
172 {
173 	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
174 	return xfs_trans_get_buf_map(tp, target, &map, 1, flags);
175 }
176 
177 int		xfs_trans_read_buf_map(struct xfs_mount *mp,
178 				       struct xfs_trans *tp,
179 				       struct xfs_buftarg *target,
180 				       struct xfs_buf_map *map, int nmaps,
181 				       xfs_buf_flags_t flags,
182 				       struct xfs_buf **bpp,
183 				       const struct xfs_buf_ops *ops);
184 
185 static inline int
186 xfs_trans_read_buf(
187 	struct xfs_mount	*mp,
188 	struct xfs_trans	*tp,
189 	struct xfs_buftarg	*target,
190 	xfs_daddr_t		blkno,
191 	int			numblks,
192 	xfs_buf_flags_t		flags,
193 	struct xfs_buf		**bpp,
194 	const struct xfs_buf_ops *ops)
195 {
196 	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
197 	return xfs_trans_read_buf_map(mp, tp, target, &map, 1,
198 				      flags, bpp, ops);
199 }
200 
201 struct xfs_buf	*xfs_trans_getsb(xfs_trans_t *, struct xfs_mount *, int);
202 
203 void		xfs_trans_brelse(xfs_trans_t *, struct xfs_buf *);
204 void		xfs_trans_bjoin(xfs_trans_t *, struct xfs_buf *);
205 void		xfs_trans_bhold(xfs_trans_t *, struct xfs_buf *);
206 void		xfs_trans_bhold_release(xfs_trans_t *, struct xfs_buf *);
207 void		xfs_trans_binval(xfs_trans_t *, struct xfs_buf *);
208 void		xfs_trans_inode_buf(xfs_trans_t *, struct xfs_buf *);
209 void		xfs_trans_stale_inode_buf(xfs_trans_t *, struct xfs_buf *);
210 bool		xfs_trans_ordered_buf(xfs_trans_t *, struct xfs_buf *);
211 void		xfs_trans_dquot_buf(xfs_trans_t *, struct xfs_buf *, uint);
212 void		xfs_trans_inode_alloc_buf(xfs_trans_t *, struct xfs_buf *);
213 void		xfs_trans_ichgtime(struct xfs_trans *, struct xfs_inode *, int);
214 void		xfs_trans_ijoin(struct xfs_trans *, struct xfs_inode *, uint);
215 void		xfs_trans_log_buf(struct xfs_trans *, struct xfs_buf *, uint,
216 				  uint);
217 void		xfs_trans_dirty_buf(struct xfs_trans *, struct xfs_buf *);
218 void		xfs_trans_log_inode(xfs_trans_t *, struct xfs_inode *, uint);
219 
220 void		xfs_extent_free_init_defer_op(void);
221 struct xfs_efd_log_item	*xfs_trans_get_efd(struct xfs_trans *,
222 				  struct xfs_efi_log_item *,
223 				  uint);
224 int		xfs_trans_free_extent(struct xfs_trans *,
225 				      struct xfs_efd_log_item *, xfs_fsblock_t,
226 				      xfs_extlen_t, struct xfs_owner_info *,
227 				      bool);
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 kmem_zone_t	*xfs_trans_zone;
241 
242 /* rmap updates */
243 enum xfs_rmap_intent_type;
244 
245 void xfs_rmap_update_init_defer_op(void);
246 struct xfs_rud_log_item *xfs_trans_get_rud(struct xfs_trans *tp,
247 		struct xfs_rui_log_item *ruip);
248 int xfs_trans_log_finish_rmap_update(struct xfs_trans *tp,
249 		struct xfs_rud_log_item *rudp, enum xfs_rmap_intent_type type,
250 		uint64_t owner, int whichfork, xfs_fileoff_t startoff,
251 		xfs_fsblock_t startblock, xfs_filblks_t blockcount,
252 		xfs_exntst_t state, struct xfs_btree_cur **pcur);
253 
254 /* refcount updates */
255 enum xfs_refcount_intent_type;
256 
257 void xfs_refcount_update_init_defer_op(void);
258 struct xfs_cud_log_item *xfs_trans_get_cud(struct xfs_trans *tp,
259 		struct xfs_cui_log_item *cuip);
260 int xfs_trans_log_finish_refcount_update(struct xfs_trans *tp,
261 		struct xfs_cud_log_item *cudp, struct xfs_defer_ops *dfops,
262 		enum xfs_refcount_intent_type type, xfs_fsblock_t startblock,
263 		xfs_extlen_t blockcount, xfs_fsblock_t *new_fsb,
264 		xfs_extlen_t *new_len, struct xfs_btree_cur **pcur);
265 
266 /* mapping updates */
267 enum xfs_bmap_intent_type;
268 
269 void xfs_bmap_update_init_defer_op(void);
270 struct xfs_bud_log_item *xfs_trans_get_bud(struct xfs_trans *tp,
271 		struct xfs_bui_log_item *buip);
272 int xfs_trans_log_finish_bmap_update(struct xfs_trans *tp,
273 		struct xfs_bud_log_item *rudp, struct xfs_defer_ops *dfops,
274 		enum xfs_bmap_intent_type type, struct xfs_inode *ip,
275 		int whichfork, xfs_fileoff_t startoff, xfs_fsblock_t startblock,
276 		xfs_filblks_t *blockcount, xfs_exntst_t state);
277 
278 #endif	/* __XFS_TRANS_H__ */
279