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