xref: /openbmc/linux/fs/xfs/xfs_trans.h (revision f5b06569)
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_busy_extent;
36 struct xfs_rud_log_item;
37 struct xfs_rui_log_item;
38 struct xfs_btree_cur;
39 
40 typedef struct xfs_log_item {
41 	struct list_head		li_ail;		/* AIL pointers */
42 	xfs_lsn_t			li_lsn;		/* last on-disk lsn */
43 	struct xfs_log_item_desc	*li_desc;	/* ptr to current desc*/
44 	struct xfs_mount		*li_mountp;	/* ptr to fs mount */
45 	struct xfs_ail			*li_ailp;	/* ptr to AIL */
46 	uint				li_type;	/* item type */
47 	uint				li_flags;	/* misc flags */
48 	struct xfs_log_item		*li_bio_list;	/* buffer item list */
49 	void				(*li_cb)(struct xfs_buf *,
50 						 struct xfs_log_item *);
51 							/* buffer item iodone */
52 							/* callback func */
53 	const struct xfs_item_ops	*li_ops;	/* function list */
54 
55 	/* delayed logging */
56 	struct list_head		li_cil;		/* CIL pointers */
57 	struct xfs_log_vec		*li_lv;		/* active log vector */
58 	struct xfs_log_vec		*li_lv_shadow;	/* standby 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_vec *);
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 void	xfs_log_item_init(struct xfs_mount *mp, struct xfs_log_item *item,
81 			  int type, const struct xfs_item_ops *ops);
82 
83 /*
84  * Return values for the iop_push() routines.
85  */
86 #define XFS_ITEM_SUCCESS	0
87 #define XFS_ITEM_PINNED		1
88 #define XFS_ITEM_LOCKED		2
89 #define XFS_ITEM_FLUSHING	3
90 
91 
92 /*
93  * This is the structure maintained for every active transaction.
94  */
95 typedef struct xfs_trans {
96 	unsigned int		t_magic;	/* magic number */
97 	unsigned int		t_log_res;	/* amt of log space resvd */
98 	unsigned int		t_log_count;	/* count for perm log res */
99 	unsigned int		t_blk_res;	/* # of blocks resvd */
100 	unsigned int		t_blk_res_used;	/* # of resvd blocks used */
101 	unsigned int		t_rtx_res;	/* # of rt extents resvd */
102 	unsigned int		t_rtx_res_used;	/* # of resvd rt extents used */
103 	struct xlog_ticket	*t_ticket;	/* log mgr ticket */
104 	xfs_lsn_t		t_lsn;		/* log seq num of start of
105 						 * transaction. */
106 	xfs_lsn_t		t_commit_lsn;	/* log seq num of end of
107 						 * transaction. */
108 	struct xfs_mount	*t_mountp;	/* ptr to fs mount struct */
109 	struct xfs_dquot_acct   *t_dqinfo;	/* acctg info for dquots */
110 	unsigned int		t_flags;	/* misc flags */
111 	int64_t			t_icount_delta;	/* superblock icount change */
112 	int64_t			t_ifree_delta;	/* superblock ifree change */
113 	int64_t			t_fdblocks_delta; /* superblock fdblocks chg */
114 	int64_t			t_res_fdblocks_delta; /* on-disk only chg */
115 	int64_t			t_frextents_delta;/* superblock freextents chg*/
116 	int64_t			t_res_frextents_delta; /* on-disk only chg */
117 #if defined(DEBUG) || defined(XFS_WARN)
118 	int64_t			t_ag_freeblks_delta; /* debugging counter */
119 	int64_t			t_ag_flist_delta; /* debugging counter */
120 	int64_t			t_ag_btree_delta; /* debugging counter */
121 #endif
122 	int64_t			t_dblocks_delta;/* superblock dblocks change */
123 	int64_t			t_agcount_delta;/* superblock agcount change */
124 	int64_t			t_imaxpct_delta;/* superblock imaxpct change */
125 	int64_t			t_rextsize_delta;/* superblock rextsize chg */
126 	int64_t			t_rbmblocks_delta;/* superblock rbmblocks chg */
127 	int64_t			t_rblocks_delta;/* superblock rblocks change */
128 	int64_t			t_rextents_delta;/* superblocks rextents chg */
129 	int64_t			t_rextslog_delta;/* superblocks rextslog chg */
130 	struct list_head	t_items;	/* log item descriptors */
131 	struct list_head	t_busy;		/* list of busy extents */
132 	unsigned long		t_pflags;	/* saved process flags state */
133 } xfs_trans_t;
134 
135 /*
136  * XFS transaction mechanism exported interfaces that are
137  * actually macros.
138  */
139 #define	xfs_trans_set_sync(tp)		((tp)->t_flags |= XFS_TRANS_SYNC)
140 
141 #if defined(DEBUG) || defined(XFS_WARN)
142 #define	xfs_trans_agblocks_delta(tp, d)	((tp)->t_ag_freeblks_delta += (int64_t)d)
143 #define	xfs_trans_agflist_delta(tp, d)	((tp)->t_ag_flist_delta += (int64_t)d)
144 #define	xfs_trans_agbtree_delta(tp, d)	((tp)->t_ag_btree_delta += (int64_t)d)
145 #else
146 #define	xfs_trans_agblocks_delta(tp, d)
147 #define	xfs_trans_agflist_delta(tp, d)
148 #define	xfs_trans_agbtree_delta(tp, d)
149 #endif
150 
151 /*
152  * XFS transaction mechanism exported interfaces.
153  */
154 int		xfs_trans_alloc(struct xfs_mount *mp, struct xfs_trans_res *resp,
155 			uint blocks, uint rtextents, uint flags,
156 			struct xfs_trans **tpp);
157 void		xfs_trans_mod_sb(xfs_trans_t *, uint, int64_t);
158 
159 struct xfs_buf	*xfs_trans_get_buf_map(struct xfs_trans *tp,
160 				       struct xfs_buftarg *target,
161 				       struct xfs_buf_map *map, int nmaps,
162 				       uint flags);
163 
164 static inline struct xfs_buf *
165 xfs_trans_get_buf(
166 	struct xfs_trans	*tp,
167 	struct xfs_buftarg	*target,
168 	xfs_daddr_t		blkno,
169 	int			numblks,
170 	uint			flags)
171 {
172 	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
173 	return xfs_trans_get_buf_map(tp, target, &map, 1, flags);
174 }
175 
176 int		xfs_trans_read_buf_map(struct xfs_mount *mp,
177 				       struct xfs_trans *tp,
178 				       struct xfs_buftarg *target,
179 				       struct xfs_buf_map *map, int nmaps,
180 				       xfs_buf_flags_t flags,
181 				       struct xfs_buf **bpp,
182 				       const struct xfs_buf_ops *ops);
183 
184 static inline int
185 xfs_trans_read_buf(
186 	struct xfs_mount	*mp,
187 	struct xfs_trans	*tp,
188 	struct xfs_buftarg	*target,
189 	xfs_daddr_t		blkno,
190 	int			numblks,
191 	xfs_buf_flags_t		flags,
192 	struct xfs_buf		**bpp,
193 	const struct xfs_buf_ops *ops)
194 {
195 	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
196 	return xfs_trans_read_buf_map(mp, tp, target, &map, 1,
197 				      flags, bpp, ops);
198 }
199 
200 struct xfs_buf	*xfs_trans_getsb(xfs_trans_t *, struct xfs_mount *, int);
201 
202 void		xfs_trans_brelse(xfs_trans_t *, struct xfs_buf *);
203 void		xfs_trans_bjoin(xfs_trans_t *, struct xfs_buf *);
204 void		xfs_trans_bhold(xfs_trans_t *, struct xfs_buf *);
205 void		xfs_trans_bhold_release(xfs_trans_t *, struct xfs_buf *);
206 void		xfs_trans_binval(xfs_trans_t *, struct xfs_buf *);
207 void		xfs_trans_inode_buf(xfs_trans_t *, struct xfs_buf *);
208 void		xfs_trans_stale_inode_buf(xfs_trans_t *, struct xfs_buf *);
209 void		xfs_trans_ordered_buf(xfs_trans_t *, struct xfs_buf *);
210 void		xfs_trans_dquot_buf(xfs_trans_t *, struct xfs_buf *, uint);
211 void		xfs_trans_inode_alloc_buf(xfs_trans_t *, struct xfs_buf *);
212 void		xfs_trans_ichgtime(struct xfs_trans *, struct xfs_inode *, int);
213 void		xfs_trans_ijoin(struct xfs_trans *, struct xfs_inode *, uint);
214 void		xfs_trans_log_buf(xfs_trans_t *, struct xfs_buf *, uint, uint);
215 void		xfs_trans_log_inode(xfs_trans_t *, struct xfs_inode *, uint);
216 
217 void		xfs_extent_free_init_defer_op(void);
218 struct xfs_efd_log_item	*xfs_trans_get_efd(struct xfs_trans *,
219 				  struct xfs_efi_log_item *,
220 				  uint);
221 int		xfs_trans_free_extent(struct xfs_trans *,
222 				      struct xfs_efd_log_item *, xfs_fsblock_t,
223 				      xfs_extlen_t, struct xfs_owner_info *);
224 int		xfs_trans_commit(struct xfs_trans *);
225 int		__xfs_trans_roll(struct xfs_trans **, struct xfs_inode *, int *);
226 int		xfs_trans_roll(struct xfs_trans **, struct xfs_inode *);
227 void		xfs_trans_cancel(xfs_trans_t *);
228 int		xfs_trans_ail_init(struct xfs_mount *);
229 void		xfs_trans_ail_destroy(struct xfs_mount *);
230 
231 void		xfs_trans_buf_set_type(struct xfs_trans *, struct xfs_buf *,
232 				       enum xfs_blft);
233 void		xfs_trans_buf_copy_type(struct xfs_buf *dst_bp,
234 					struct xfs_buf *src_bp);
235 
236 extern kmem_zone_t	*xfs_trans_zone;
237 extern kmem_zone_t	*xfs_log_item_desc_zone;
238 
239 /* rmap updates */
240 enum xfs_rmap_intent_type;
241 
242 void xfs_rmap_update_init_defer_op(void);
243 struct xfs_rud_log_item *xfs_trans_get_rud(struct xfs_trans *tp,
244 		struct xfs_rui_log_item *ruip);
245 int xfs_trans_log_finish_rmap_update(struct xfs_trans *tp,
246 		struct xfs_rud_log_item *rudp, enum xfs_rmap_intent_type type,
247 		__uint64_t owner, int whichfork, xfs_fileoff_t startoff,
248 		xfs_fsblock_t startblock, xfs_filblks_t blockcount,
249 		xfs_exntst_t state, struct xfs_btree_cur **pcur);
250 
251 #endif	/* __XFS_TRANS_H__ */
252