xref: /openbmc/linux/fs/xfs/xfs_trans.h (revision 6396bb221514d2876fd6dc0aa2a1f240d99b37bb)
1 /*
2  * Copyright (c) 2000-2002,2005 Silicon Graphics, Inc.
3  * All Rights Reserved.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License as
7  * published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it would be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write the Free Software Foundation,
16  * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17  */
18 #ifndef	__XFS_TRANS_H__
19 #define	__XFS_TRANS_H__
20 
21 /* kernel only transaction subsystem defines */
22 
23 struct xfs_buf;
24 struct xfs_buftarg;
25 struct xfs_efd_log_item;
26 struct xfs_efi_log_item;
27 struct xfs_inode;
28 struct xfs_item_ops;
29 struct xfs_log_iovec;
30 struct xfs_mount;
31 struct xfs_trans;
32 struct xfs_trans_res;
33 struct xfs_dquot_acct;
34 struct xfs_rud_log_item;
35 struct xfs_rui_log_item;
36 struct xfs_btree_cur;
37 struct xfs_cui_log_item;
38 struct xfs_cud_log_item;
39 struct xfs_defer_ops;
40 struct xfs_bui_log_item;
41 struct xfs_bud_log_item;
42 
43 typedef struct xfs_log_item {
44 	struct list_head		li_ail;		/* AIL pointers */
45 	struct list_head		li_trans;	/* transaction list */
46 	xfs_lsn_t			li_lsn;		/* last on-disk lsn */
47 	struct xfs_mount		*li_mountp;	/* ptr to fs mount */
48 	struct xfs_ail			*li_ailp;	/* ptr to AIL */
49 	uint				li_type;	/* item type */
50 	unsigned long			li_flags;	/* misc flags */
51 	struct xfs_buf			*li_buf;	/* real buffer pointer */
52 	struct list_head		li_bio_list;	/* buffer item list */
53 	void				(*li_cb)(struct xfs_buf *,
54 						 struct xfs_log_item *);
55 							/* buffer item iodone */
56 							/* callback func */
57 	const struct xfs_item_ops	*li_ops;	/* function list */
58 
59 	/* delayed logging */
60 	struct list_head		li_cil;		/* CIL pointers */
61 	struct xfs_log_vec		*li_lv;		/* active log vector */
62 	struct xfs_log_vec		*li_lv_shadow;	/* standby vector */
63 	xfs_lsn_t			li_seq;		/* CIL commit seq */
64 } xfs_log_item_t;
65 
66 /*
67  * li_flags use the (set/test/clear)_bit atomic interfaces because updates can
68  * race with each other and we don't want to have to use the AIL lock to
69  * serialise all updates.
70  */
71 #define	XFS_LI_IN_AIL	0
72 #define	XFS_LI_ABORTED	1
73 #define	XFS_LI_FAILED	2
74 #define	XFS_LI_DIRTY	3	/* log item dirty in transaction */
75 
76 #define XFS_LI_FLAGS \
77 	{ (1 << XFS_LI_IN_AIL),		"IN_AIL" }, \
78 	{ (1 << XFS_LI_ABORTED),	"ABORTED" }, \
79 	{ (1 << XFS_LI_FAILED),		"FAILED" }, \
80 	{ (1 << XFS_LI_DIRTY),		"DIRTY" }
81 
82 struct xfs_item_ops {
83 	void (*iop_size)(xfs_log_item_t *, int *, int *);
84 	void (*iop_format)(xfs_log_item_t *, struct xfs_log_vec *);
85 	void (*iop_pin)(xfs_log_item_t *);
86 	void (*iop_unpin)(xfs_log_item_t *, int remove);
87 	uint (*iop_push)(struct xfs_log_item *, struct list_head *);
88 	void (*iop_unlock)(xfs_log_item_t *);
89 	xfs_lsn_t (*iop_committed)(xfs_log_item_t *, xfs_lsn_t);
90 	void (*iop_committing)(xfs_log_item_t *, xfs_lsn_t);
91 	void (*iop_error)(xfs_log_item_t *, xfs_buf_t *);
92 };
93 
94 void	xfs_log_item_init(struct xfs_mount *mp, struct xfs_log_item *item,
95 			  int type, const struct xfs_item_ops *ops);
96 
97 /*
98  * Return values for the iop_push() routines.
99  */
100 #define XFS_ITEM_SUCCESS	0
101 #define XFS_ITEM_PINNED		1
102 #define XFS_ITEM_LOCKED		2
103 #define XFS_ITEM_FLUSHING	3
104 
105 
106 /*
107  * This is the structure maintained for every active transaction.
108  */
109 typedef struct xfs_trans {
110 	unsigned int		t_magic;	/* magic number */
111 	unsigned int		t_log_res;	/* amt of log space resvd */
112 	unsigned int		t_log_count;	/* count for perm log res */
113 	unsigned int		t_blk_res;	/* # of blocks resvd */
114 	unsigned int		t_blk_res_used;	/* # of resvd blocks used */
115 	unsigned int		t_rtx_res;	/* # of rt extents resvd */
116 	unsigned int		t_rtx_res_used;	/* # of resvd rt extents used */
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 	struct xfs_defer_ops	*t_agfl_dfops;	/* optional agfl fixup dfops */
121 	unsigned int		t_flags;	/* misc flags */
122 	int64_t			t_icount_delta;	/* superblock icount change */
123 	int64_t			t_ifree_delta;	/* superblock ifree change */
124 	int64_t			t_fdblocks_delta; /* superblock fdblocks chg */
125 	int64_t			t_res_fdblocks_delta; /* on-disk only chg */
126 	int64_t			t_frextents_delta;/* superblock freextents chg*/
127 	int64_t			t_res_frextents_delta; /* on-disk only chg */
128 #if defined(DEBUG) || defined(XFS_WARN)
129 	int64_t			t_ag_freeblks_delta; /* debugging counter */
130 	int64_t			t_ag_flist_delta; /* debugging counter */
131 	int64_t			t_ag_btree_delta; /* debugging counter */
132 #endif
133 	int64_t			t_dblocks_delta;/* superblock dblocks change */
134 	int64_t			t_agcount_delta;/* superblock agcount change */
135 	int64_t			t_imaxpct_delta;/* superblock imaxpct change */
136 	int64_t			t_rextsize_delta;/* superblock rextsize chg */
137 	int64_t			t_rbmblocks_delta;/* superblock rbmblocks chg */
138 	int64_t			t_rblocks_delta;/* superblock rblocks change */
139 	int64_t			t_rextents_delta;/* superblocks rextents chg */
140 	int64_t			t_rextslog_delta;/* superblocks rextslog chg */
141 	struct list_head	t_items;	/* log item descriptors */
142 	struct list_head	t_busy;		/* list of busy extents */
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 struct xfs_buf	*xfs_trans_get_buf_map(struct xfs_trans *tp,
173 				       struct xfs_buftarg *target,
174 				       struct xfs_buf_map *map, int nmaps,
175 				       uint flags);
176 
177 static inline struct xfs_buf *
178 xfs_trans_get_buf(
179 	struct xfs_trans	*tp,
180 	struct xfs_buftarg	*target,
181 	xfs_daddr_t		blkno,
182 	int			numblks,
183 	uint			flags)
184 {
185 	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
186 	return xfs_trans_get_buf_map(tp, target, &map, 1, flags);
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 *, int);
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 void		xfs_trans_log_inode(xfs_trans_t *, struct xfs_inode *, uint);
231 
232 void		xfs_extent_free_init_defer_op(void);
233 struct xfs_efd_log_item	*xfs_trans_get_efd(struct xfs_trans *,
234 				  struct xfs_efi_log_item *,
235 				  uint);
236 int		xfs_trans_free_extent(struct xfs_trans *,
237 				      struct xfs_efd_log_item *, xfs_fsblock_t,
238 				      xfs_extlen_t, struct xfs_owner_info *,
239 				      bool);
240 int		xfs_trans_commit(struct xfs_trans *);
241 int		xfs_trans_roll(struct xfs_trans **);
242 int		xfs_trans_roll_inode(struct xfs_trans **, struct xfs_inode *);
243 void		xfs_trans_cancel(xfs_trans_t *);
244 int		xfs_trans_ail_init(struct xfs_mount *);
245 void		xfs_trans_ail_destroy(struct xfs_mount *);
246 
247 void		xfs_trans_buf_set_type(struct xfs_trans *, struct xfs_buf *,
248 				       enum xfs_blft);
249 void		xfs_trans_buf_copy_type(struct xfs_buf *dst_bp,
250 					struct xfs_buf *src_bp);
251 
252 extern kmem_zone_t	*xfs_trans_zone;
253 
254 /* rmap updates */
255 enum xfs_rmap_intent_type;
256 
257 void xfs_rmap_update_init_defer_op(void);
258 struct xfs_rud_log_item *xfs_trans_get_rud(struct xfs_trans *tp,
259 		struct xfs_rui_log_item *ruip);
260 int xfs_trans_log_finish_rmap_update(struct xfs_trans *tp,
261 		struct xfs_rud_log_item *rudp, enum xfs_rmap_intent_type type,
262 		uint64_t owner, int whichfork, xfs_fileoff_t startoff,
263 		xfs_fsblock_t startblock, xfs_filblks_t blockcount,
264 		xfs_exntst_t state, struct xfs_btree_cur **pcur);
265 
266 /* refcount updates */
267 enum xfs_refcount_intent_type;
268 
269 void xfs_refcount_update_init_defer_op(void);
270 struct xfs_cud_log_item *xfs_trans_get_cud(struct xfs_trans *tp,
271 		struct xfs_cui_log_item *cuip);
272 int xfs_trans_log_finish_refcount_update(struct xfs_trans *tp,
273 		struct xfs_cud_log_item *cudp, struct xfs_defer_ops *dfops,
274 		enum xfs_refcount_intent_type type, xfs_fsblock_t startblock,
275 		xfs_extlen_t blockcount, xfs_fsblock_t *new_fsb,
276 		xfs_extlen_t *new_len, struct xfs_btree_cur **pcur);
277 
278 /* mapping updates */
279 enum xfs_bmap_intent_type;
280 
281 void xfs_bmap_update_init_defer_op(void);
282 struct xfs_bud_log_item *xfs_trans_get_bud(struct xfs_trans *tp,
283 		struct xfs_bui_log_item *buip);
284 int xfs_trans_log_finish_bmap_update(struct xfs_trans *tp,
285 		struct xfs_bud_log_item *rudp, struct xfs_defer_ops *dfops,
286 		enum xfs_bmap_intent_type type, struct xfs_inode *ip,
287 		int whichfork, xfs_fileoff_t startoff, xfs_fsblock_t startblock,
288 		xfs_filblks_t *blockcount, xfs_exntst_t state);
289 
290 #endif	/* __XFS_TRANS_H__ */
291