xref: /openbmc/linux/fs/xfs/xfs_trans.h (revision e0d07278)
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_lsn_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 #define	XFS_LI_RECOVERED 4	/* log intent item has been recovered */
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 	{ (1 << XFS_LI_RECOVERED),	"RECOVERED" }
66 
67 struct xfs_item_ops {
68 	unsigned flags;
69 	void (*iop_size)(struct xfs_log_item *, int *, int *);
70 	void (*iop_format)(struct xfs_log_item *, struct xfs_log_vec *);
71 	void (*iop_pin)(struct xfs_log_item *);
72 	void (*iop_unpin)(struct xfs_log_item *, int remove);
73 	uint (*iop_push)(struct xfs_log_item *, struct list_head *);
74 	void (*iop_committing)(struct xfs_log_item *, xfs_lsn_t commit_lsn);
75 	void (*iop_release)(struct xfs_log_item *);
76 	xfs_lsn_t (*iop_committed)(struct xfs_log_item *, xfs_lsn_t);
77 	int (*iop_recover)(struct xfs_log_item *lip, struct xfs_trans *tp);
78 	bool (*iop_match)(struct xfs_log_item *item, uint64_t id);
79 };
80 
81 /*
82  * Release the log item as soon as committed.  This is for items just logging
83  * intents that never need to be written back in place.
84  */
85 #define XFS_ITEM_RELEASE_WHEN_COMMITTED	(1 << 0)
86 
87 void	xfs_log_item_init(struct xfs_mount *mp, struct xfs_log_item *item,
88 			  int type, const struct xfs_item_ops *ops);
89 
90 /*
91  * Return values for the iop_push() routines.
92  */
93 #define XFS_ITEM_SUCCESS	0
94 #define XFS_ITEM_PINNED		1
95 #define XFS_ITEM_LOCKED		2
96 #define XFS_ITEM_FLUSHING	3
97 
98 /*
99  * Deferred operation item relogging limits.
100  */
101 #define XFS_DEFER_OPS_NR_INODES	2	/* join up to two inodes */
102 #define XFS_DEFER_OPS_NR_BUFS	2	/* join up to two buffers */
103 
104 /*
105  * This is the structure maintained for every active transaction.
106  */
107 typedef struct xfs_trans {
108 	unsigned int		t_magic;	/* magic number */
109 	unsigned int		t_log_res;	/* amt of log space resvd */
110 	unsigned int		t_log_count;	/* count for perm log res */
111 	unsigned int		t_blk_res;	/* # of blocks resvd */
112 	unsigned int		t_blk_res_used;	/* # of resvd blocks used */
113 	unsigned int		t_rtx_res;	/* # of rt extents resvd */
114 	unsigned int		t_rtx_res_used;	/* # of resvd rt extents used */
115 	unsigned int		t_flags;	/* misc flags */
116 	xfs_fsblock_t		t_firstblock;	/* first block allocated */
117 	struct xlog_ticket	*t_ticket;	/* log mgr ticket */
118 	struct xfs_mount	*t_mountp;	/* ptr to fs mount struct */
119 	struct xfs_dquot_acct   *t_dqinfo;	/* acctg info for dquots */
120 	int64_t			t_icount_delta;	/* superblock icount change */
121 	int64_t			t_ifree_delta;	/* superblock ifree change */
122 	int64_t			t_fdblocks_delta; /* superblock fdblocks chg */
123 	int64_t			t_res_fdblocks_delta; /* on-disk only chg */
124 	int64_t			t_frextents_delta;/* superblock freextents chg*/
125 	int64_t			t_res_frextents_delta; /* on-disk only chg */
126 #if defined(DEBUG) || defined(XFS_WARN)
127 	int64_t			t_ag_freeblks_delta; /* debugging counter */
128 	int64_t			t_ag_flist_delta; /* debugging counter */
129 	int64_t			t_ag_btree_delta; /* debugging counter */
130 #endif
131 	int64_t			t_dblocks_delta;/* superblock dblocks change */
132 	int64_t			t_agcount_delta;/* superblock agcount change */
133 	int64_t			t_imaxpct_delta;/* superblock imaxpct change */
134 	int64_t			t_rextsize_delta;/* superblock rextsize chg */
135 	int64_t			t_rbmblocks_delta;/* superblock rbmblocks chg */
136 	int64_t			t_rblocks_delta;/* superblock rblocks change */
137 	int64_t			t_rextents_delta;/* superblocks rextents chg */
138 	int64_t			t_rextslog_delta;/* superblocks rextslog chg */
139 	struct list_head	t_items;	/* log item descriptors */
140 	struct list_head	t_busy;		/* list of busy extents */
141 	struct list_head	t_dfops;	/* deferred operations */
142 	unsigned long		t_pflags;	/* saved process flags state */
143 } xfs_trans_t;
144 
145 /*
146  * XFS transaction mechanism exported interfaces that are
147  * actually macros.
148  */
149 #define	xfs_trans_set_sync(tp)		((tp)->t_flags |= XFS_TRANS_SYNC)
150 
151 #if defined(DEBUG) || defined(XFS_WARN)
152 #define	xfs_trans_agblocks_delta(tp, d)	((tp)->t_ag_freeblks_delta += (int64_t)d)
153 #define	xfs_trans_agflist_delta(tp, d)	((tp)->t_ag_flist_delta += (int64_t)d)
154 #define	xfs_trans_agbtree_delta(tp, d)	((tp)->t_ag_btree_delta += (int64_t)d)
155 #else
156 #define	xfs_trans_agblocks_delta(tp, d)
157 #define	xfs_trans_agflist_delta(tp, d)
158 #define	xfs_trans_agbtree_delta(tp, d)
159 #endif
160 
161 /*
162  * XFS transaction mechanism exported interfaces.
163  */
164 int		xfs_trans_alloc(struct xfs_mount *mp, struct xfs_trans_res *resp,
165 			uint blocks, uint rtextents, uint flags,
166 			struct xfs_trans **tpp);
167 int		xfs_trans_alloc_empty(struct xfs_mount *mp,
168 			struct xfs_trans **tpp);
169 void		xfs_trans_mod_sb(xfs_trans_t *, uint, int64_t);
170 
171 int xfs_trans_get_buf_map(struct xfs_trans *tp, struct xfs_buftarg *target,
172 		struct xfs_buf_map *map, int nmaps, xfs_buf_flags_t flags,
173 		struct xfs_buf **bpp);
174 
175 static inline int
176 xfs_trans_get_buf(
177 	struct xfs_trans	*tp,
178 	struct xfs_buftarg	*target,
179 	xfs_daddr_t		blkno,
180 	int			numblks,
181 	uint			flags,
182 	struct xfs_buf		**bpp)
183 {
184 	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
185 	return xfs_trans_get_buf_map(tp, target, &map, 1, flags, bpp);
186 }
187 
188 int		xfs_trans_read_buf_map(struct xfs_mount *mp,
189 				       struct xfs_trans *tp,
190 				       struct xfs_buftarg *target,
191 				       struct xfs_buf_map *map, int nmaps,
192 				       xfs_buf_flags_t flags,
193 				       struct xfs_buf **bpp,
194 				       const struct xfs_buf_ops *ops);
195 
196 static inline int
197 xfs_trans_read_buf(
198 	struct xfs_mount	*mp,
199 	struct xfs_trans	*tp,
200 	struct xfs_buftarg	*target,
201 	xfs_daddr_t		blkno,
202 	int			numblks,
203 	xfs_buf_flags_t		flags,
204 	struct xfs_buf		**bpp,
205 	const struct xfs_buf_ops *ops)
206 {
207 	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
208 	return xfs_trans_read_buf_map(mp, tp, target, &map, 1,
209 				      flags, bpp, ops);
210 }
211 
212 struct xfs_buf	*xfs_trans_getsb(xfs_trans_t *, struct xfs_mount *);
213 
214 void		xfs_trans_brelse(xfs_trans_t *, struct xfs_buf *);
215 void		xfs_trans_bjoin(xfs_trans_t *, struct xfs_buf *);
216 void		xfs_trans_bhold(xfs_trans_t *, struct xfs_buf *);
217 void		xfs_trans_bhold_release(xfs_trans_t *, struct xfs_buf *);
218 void		xfs_trans_binval(xfs_trans_t *, struct xfs_buf *);
219 void		xfs_trans_inode_buf(xfs_trans_t *, struct xfs_buf *);
220 void		xfs_trans_stale_inode_buf(xfs_trans_t *, struct xfs_buf *);
221 bool		xfs_trans_ordered_buf(xfs_trans_t *, struct xfs_buf *);
222 void		xfs_trans_dquot_buf(xfs_trans_t *, struct xfs_buf *, uint);
223 void		xfs_trans_inode_alloc_buf(xfs_trans_t *, struct xfs_buf *);
224 void		xfs_trans_ichgtime(struct xfs_trans *, struct xfs_inode *, int);
225 void		xfs_trans_ijoin(struct xfs_trans *, struct xfs_inode *, uint);
226 void		xfs_trans_log_buf(struct xfs_trans *, struct xfs_buf *, uint,
227 				  uint);
228 void		xfs_trans_dirty_buf(struct xfs_trans *, struct xfs_buf *);
229 bool		xfs_trans_buf_is_dirty(struct xfs_buf *bp);
230 void		xfs_trans_log_inode(xfs_trans_t *, struct xfs_inode *, uint);
231 
232 int		xfs_trans_commit(struct xfs_trans *);
233 int		xfs_trans_roll(struct xfs_trans **);
234 int		xfs_trans_roll_inode(struct xfs_trans **, struct xfs_inode *);
235 void		xfs_trans_cancel(xfs_trans_t *);
236 int		xfs_trans_ail_init(struct xfs_mount *);
237 void		xfs_trans_ail_destroy(struct xfs_mount *);
238 
239 void		xfs_trans_buf_set_type(struct xfs_trans *, struct xfs_buf *,
240 				       enum xfs_blft);
241 void		xfs_trans_buf_copy_type(struct xfs_buf *dst_bp,
242 					struct xfs_buf *src_bp);
243 
244 extern kmem_zone_t	*xfs_trans_zone;
245 
246 #endif	/* __XFS_TRANS_H__ */
247