xref: /openbmc/linux/fs/xfs/xfs_trans.h (revision f7777dcc)
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 struct xfs_log_item;
22 
23 #include "xfs_trans_resv.h"
24 
25 /* kernel only transaction subsystem defines */
26 
27 struct xfs_buf;
28 struct xfs_buftarg;
29 struct xfs_efd_log_item;
30 struct xfs_efi_log_item;
31 struct xfs_inode;
32 struct xfs_item_ops;
33 struct xfs_log_iovec;
34 struct xfs_log_item_desc;
35 struct xfs_mount;
36 struct xfs_trans;
37 struct xfs_trans_res;
38 struct xfs_dquot_acct;
39 struct xfs_busy_extent;
40 
41 typedef struct xfs_log_item {
42 	struct list_head		li_ail;		/* AIL pointers */
43 	xfs_lsn_t			li_lsn;		/* last on-disk lsn */
44 	struct xfs_log_item_desc	*li_desc;	/* ptr to current desc*/
45 	struct xfs_mount		*li_mountp;	/* ptr to fs mount */
46 	struct xfs_ail			*li_ailp;	/* ptr to AIL */
47 	uint				li_type;	/* item type */
48 	uint				li_flags;	/* misc flags */
49 	struct xfs_log_item		*li_bio_list;	/* buffer item list */
50 	void				(*li_cb)(struct xfs_buf *,
51 						 struct xfs_log_item *);
52 							/* buffer item iodone */
53 							/* callback func */
54 	const struct xfs_item_ops	*li_ops;	/* function list */
55 
56 	/* delayed logging */
57 	struct list_head		li_cil;		/* CIL pointers */
58 	struct xfs_log_vec		*li_lv;		/* active log vector */
59 	xfs_lsn_t			li_seq;		/* CIL commit seq */
60 } xfs_log_item_t;
61 
62 #define	XFS_LI_IN_AIL	0x1
63 #define XFS_LI_ABORTED	0x2
64 
65 #define XFS_LI_FLAGS \
66 	{ XFS_LI_IN_AIL,	"IN_AIL" }, \
67 	{ XFS_LI_ABORTED,	"ABORTED" }
68 
69 struct xfs_item_ops {
70 	void (*iop_size)(xfs_log_item_t *, int *, int *);
71 	void (*iop_format)(xfs_log_item_t *, struct xfs_log_iovec *);
72 	void (*iop_pin)(xfs_log_item_t *);
73 	void (*iop_unpin)(xfs_log_item_t *, int remove);
74 	uint (*iop_push)(struct xfs_log_item *, struct list_head *);
75 	void (*iop_unlock)(xfs_log_item_t *);
76 	xfs_lsn_t (*iop_committed)(xfs_log_item_t *, xfs_lsn_t);
77 	void (*iop_committing)(xfs_log_item_t *, xfs_lsn_t);
78 };
79 
80 /*
81  * Return values for the iop_push() routines.
82  */
83 #define XFS_ITEM_SUCCESS	0
84 #define XFS_ITEM_PINNED		1
85 #define XFS_ITEM_LOCKED		2
86 #define XFS_ITEM_FLUSHING	3
87 
88 /*
89  * This is the type of function which can be given to xfs_trans_callback()
90  * to be called upon the transaction's commit to disk.
91  */
92 typedef void (*xfs_trans_callback_t)(struct xfs_trans *, void *);
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 	xfs_log_callback_t	t_logcb;	/* log callback struct */
100 	unsigned int		t_type;		/* transaction type */
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 	xfs_trans_header_t	t_header;	/* header for in-log trans */
136 	struct list_head	t_busy;		/* list of busy extents */
137 	unsigned long		t_pflags;	/* saved process flags state */
138 } xfs_trans_t;
139 
140 /*
141  * XFS transaction mechanism exported interfaces that are
142  * actually macros.
143  */
144 #define	xfs_trans_get_log_res(tp)	((tp)->t_log_res)
145 #define	xfs_trans_get_log_count(tp)	((tp)->t_log_count)
146 #define	xfs_trans_get_block_res(tp)	((tp)->t_blk_res)
147 #define	xfs_trans_set_sync(tp)		((tp)->t_flags |= XFS_TRANS_SYNC)
148 
149 #if defined(DEBUG) || defined(XFS_WARN)
150 #define	xfs_trans_agblocks_delta(tp, d)	((tp)->t_ag_freeblks_delta += (int64_t)d)
151 #define	xfs_trans_agflist_delta(tp, d)	((tp)->t_ag_flist_delta += (int64_t)d)
152 #define	xfs_trans_agbtree_delta(tp, d)	((tp)->t_ag_btree_delta += (int64_t)d)
153 #else
154 #define	xfs_trans_agblocks_delta(tp, d)
155 #define	xfs_trans_agflist_delta(tp, d)
156 #define	xfs_trans_agbtree_delta(tp, d)
157 #endif
158 
159 /*
160  * XFS transaction mechanism exported interfaces.
161  */
162 xfs_trans_t	*xfs_trans_alloc(struct xfs_mount *, uint);
163 xfs_trans_t	*_xfs_trans_alloc(struct xfs_mount *, uint, xfs_km_flags_t);
164 xfs_trans_t	*xfs_trans_dup(xfs_trans_t *);
165 int		xfs_trans_reserve(struct xfs_trans *, struct xfs_trans_res *,
166 				  uint, uint);
167 void		xfs_trans_mod_sb(xfs_trans_t *, uint, int64_t);
168 
169 struct xfs_buf	*xfs_trans_get_buf_map(struct xfs_trans *tp,
170 				       struct xfs_buftarg *target,
171 				       struct xfs_buf_map *map, int nmaps,
172 				       uint flags);
173 
174 static inline struct xfs_buf *
175 xfs_trans_get_buf(
176 	struct xfs_trans	*tp,
177 	struct xfs_buftarg	*target,
178 	xfs_daddr_t		blkno,
179 	int			numblks,
180 	uint			flags)
181 {
182 	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
183 	return xfs_trans_get_buf_map(tp, target, &map, 1, flags);
184 }
185 
186 int		xfs_trans_read_buf_map(struct xfs_mount *mp,
187 				       struct xfs_trans *tp,
188 				       struct xfs_buftarg *target,
189 				       struct xfs_buf_map *map, int nmaps,
190 				       xfs_buf_flags_t flags,
191 				       struct xfs_buf **bpp,
192 				       const struct xfs_buf_ops *ops);
193 
194 static inline int
195 xfs_trans_read_buf(
196 	struct xfs_mount	*mp,
197 	struct xfs_trans	*tp,
198 	struct xfs_buftarg	*target,
199 	xfs_daddr_t		blkno,
200 	int			numblks,
201 	xfs_buf_flags_t		flags,
202 	struct xfs_buf		**bpp,
203 	const struct xfs_buf_ops *ops)
204 {
205 	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
206 	return xfs_trans_read_buf_map(mp, tp, target, &map, 1,
207 				      flags, bpp, ops);
208 }
209 
210 struct xfs_buf	*xfs_trans_getsb(xfs_trans_t *, struct xfs_mount *, int);
211 
212 void		xfs_trans_brelse(xfs_trans_t *, struct xfs_buf *);
213 void		xfs_trans_bjoin(xfs_trans_t *, struct xfs_buf *);
214 void		xfs_trans_bhold(xfs_trans_t *, struct xfs_buf *);
215 void		xfs_trans_bhold_release(xfs_trans_t *, struct xfs_buf *);
216 void		xfs_trans_binval(xfs_trans_t *, struct xfs_buf *);
217 void		xfs_trans_inode_buf(xfs_trans_t *, struct xfs_buf *);
218 void		xfs_trans_stale_inode_buf(xfs_trans_t *, struct xfs_buf *);
219 void		xfs_trans_ordered_buf(xfs_trans_t *, struct xfs_buf *);
220 void		xfs_trans_dquot_buf(xfs_trans_t *, struct xfs_buf *, uint);
221 void		xfs_trans_inode_alloc_buf(xfs_trans_t *, struct xfs_buf *);
222 void		xfs_trans_ichgtime(struct xfs_trans *, struct xfs_inode *, int);
223 void		xfs_trans_ijoin(struct xfs_trans *, struct xfs_inode *, uint);
224 void		xfs_trans_log_buf(xfs_trans_t *, struct xfs_buf *, uint, uint);
225 void		xfs_trans_log_inode(xfs_trans_t *, struct xfs_inode *, uint);
226 struct xfs_efi_log_item	*xfs_trans_get_efi(xfs_trans_t *, uint);
227 void		xfs_efi_release(struct xfs_efi_log_item *, uint);
228 void		xfs_trans_log_efi_extent(xfs_trans_t *,
229 					 struct xfs_efi_log_item *,
230 					 xfs_fsblock_t,
231 					 xfs_extlen_t);
232 struct xfs_efd_log_item	*xfs_trans_get_efd(xfs_trans_t *,
233 				  struct xfs_efi_log_item *,
234 				  uint);
235 void		xfs_trans_log_efd_extent(xfs_trans_t *,
236 					 struct xfs_efd_log_item *,
237 					 xfs_fsblock_t,
238 					 xfs_extlen_t);
239 int		xfs_trans_commit(xfs_trans_t *, uint flags);
240 void		xfs_trans_cancel(xfs_trans_t *, int);
241 int		xfs_trans_ail_init(struct xfs_mount *);
242 void		xfs_trans_ail_destroy(struct xfs_mount *);
243 
244 extern kmem_zone_t	*xfs_trans_zone;
245 extern kmem_zone_t	*xfs_log_item_desc_zone;
246 
247 #endif	/* __XFS_TRANS_H__ */
248