xfs: refactor xfs_trans_reserve() interface
[linux-block.git] / fs / xfs / xfs_trans.h
CommitLineData
1da177e4 1/*
7b718769
NS
2 * Copyright (c) 2000-2002,2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
1da177e4 4 *
7b718769
NS
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
1da177e4
LT
7 * published by the Free Software Foundation.
8 *
7b718769
NS
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.
1da177e4 13 *
7b718769
NS
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
1da177e4
LT
17 */
18#ifndef __XFS_TRANS_H__
19#define __XFS_TRANS_H__
20
847fff5c
BN
21struct xfs_log_item;
22
7fd36c44 23#include "xfs_trans_resv.h"
1da177e4 24
7fd36c44 25/* kernel only transaction subsystem defines */
847fff5c
BN
26
27struct xfs_buf;
28struct xfs_buftarg;
29struct xfs_efd_log_item;
30struct xfs_efi_log_item;
31struct xfs_inode;
32struct xfs_item_ops;
33struct xfs_log_iovec;
34struct xfs_log_item_desc;
35struct xfs_mount;
36struct xfs_trans;
3d3c8b52 37struct xfs_trans_res;
847fff5c 38struct xfs_dquot_acct;
ed3b4d6c 39struct xfs_busy_extent;
847fff5c
BN
40
41typedef 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 */
fc1829f3 46 struct xfs_ail *li_ailp; /* ptr to AIL */
847fff5c
BN
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 */
272e42b2 54 const struct xfs_item_ops *li_ops; /* function list */
71e330b5
DC
55
56 /* delayed logging */
57 struct list_head li_cil; /* CIL pointers */
58 struct xfs_log_vec *li_lv; /* active log vector */
ccf7c23f 59 xfs_lsn_t li_seq; /* CIL commit seq */
847fff5c
BN
60} xfs_log_item_t;
61
62#define XFS_LI_IN_AIL 0x1
63#define XFS_LI_ABORTED 0x2
64
0b1b213f
CH
65#define XFS_LI_FLAGS \
66 { XFS_LI_IN_AIL, "IN_AIL" }, \
67 { XFS_LI_ABORTED, "ABORTED" }
68
272e42b2 69struct xfs_item_ops {
847fff5c
BN
70 uint (*iop_size)(xfs_log_item_t *);
71 void (*iop_format)(xfs_log_item_t *, struct xfs_log_iovec *);
72 void (*iop_pin)(xfs_log_item_t *);
9412e318 73 void (*iop_unpin)(xfs_log_item_t *, int remove);
43ff2122 74 uint (*iop_push)(struct xfs_log_item *, struct list_head *);
847fff5c
BN
75 void (*iop_unlock)(xfs_log_item_t *);
76 xfs_lsn_t (*iop_committed)(xfs_log_item_t *, xfs_lsn_t);
847fff5c 77 void (*iop_committing)(xfs_log_item_t *, xfs_lsn_t);
272e42b2 78};
847fff5c
BN
79
80#define IOP_SIZE(ip) (*(ip)->li_ops->iop_size)(ip)
81#define IOP_FORMAT(ip,vp) (*(ip)->li_ops->iop_format)(ip, vp)
82#define IOP_PIN(ip) (*(ip)->li_ops->iop_pin)(ip)
9412e318 83#define IOP_UNPIN(ip, remove) (*(ip)->li_ops->iop_unpin)(ip, remove)
43ff2122 84#define IOP_PUSH(ip, list) (*(ip)->li_ops->iop_push)(ip, list)
847fff5c
BN
85#define IOP_UNLOCK(ip) (*(ip)->li_ops->iop_unlock)(ip)
86#define IOP_COMMITTED(ip, lsn) (*(ip)->li_ops->iop_committed)(ip, lsn)
847fff5c
BN
87#define IOP_COMMITTING(ip, lsn) (*(ip)->li_ops->iop_committing)(ip, lsn)
88
89/*
43ff2122 90 * Return values for the IOP_PUSH() routines.
847fff5c 91 */
43ff2122
CH
92#define XFS_ITEM_SUCCESS 0
93#define XFS_ITEM_PINNED 1
94#define XFS_ITEM_LOCKED 2
95#define XFS_ITEM_FLUSHING 3
847fff5c 96
847fff5c
BN
97/*
98 * This is the type of function which can be given to xfs_trans_callback()
99 * to be called upon the transaction's commit to disk.
100 */
101typedef void (*xfs_trans_callback_t)(struct xfs_trans *, void *);
102
103/*
104 * This is the structure maintained for every active transaction.
105 */
106typedef struct xfs_trans {
107 unsigned int t_magic; /* magic number */
108 xfs_log_callback_t t_logcb; /* log callback struct */
109 unsigned int t_type; /* transaction type */
110 unsigned int t_log_res; /* amt of log space resvd */
111 unsigned int t_log_count; /* count for perm log res */
112 unsigned int t_blk_res; /* # of blocks resvd */
113 unsigned int t_blk_res_used; /* # of resvd blocks used */
114 unsigned int t_rtx_res; /* # of rt extents resvd */
115 unsigned int t_rtx_res_used; /* # of resvd rt extents used */
35a8a72f 116 struct xlog_ticket *t_ticket; /* log mgr ticket */
847fff5c
BN
117 xfs_lsn_t t_lsn; /* log seq num of start of
118 * transaction. */
119 xfs_lsn_t t_commit_lsn; /* log seq num of end of
120 * transaction. */
121 struct xfs_mount *t_mountp; /* ptr to fs mount struct */
122 struct xfs_dquot_acct *t_dqinfo; /* acctg info for dquots */
847fff5c
BN
123 unsigned int t_flags; /* misc flags */
124 int64_t t_icount_delta; /* superblock icount change */
125 int64_t t_ifree_delta; /* superblock ifree change */
126 int64_t t_fdblocks_delta; /* superblock fdblocks chg */
127 int64_t t_res_fdblocks_delta; /* on-disk only chg */
128 int64_t t_frextents_delta;/* superblock freextents chg*/
129 int64_t t_res_frextents_delta; /* on-disk only chg */
742ae1e3 130#if defined(DEBUG) || defined(XFS_WARN)
847fff5c
BN
131 int64_t t_ag_freeblks_delta; /* debugging counter */
132 int64_t t_ag_flist_delta; /* debugging counter */
133 int64_t t_ag_btree_delta; /* debugging counter */
134#endif
135 int64_t t_dblocks_delta;/* superblock dblocks change */
136 int64_t t_agcount_delta;/* superblock agcount change */
137 int64_t t_imaxpct_delta;/* superblock imaxpct change */
138 int64_t t_rextsize_delta;/* superblock rextsize chg */
139 int64_t t_rbmblocks_delta;/* superblock rbmblocks chg */
140 int64_t t_rblocks_delta;/* superblock rblocks change */
141 int64_t t_rextents_delta;/* superblocks rextents chg */
142 int64_t t_rextslog_delta;/* superblocks rextslog chg */
e98c414f 143 struct list_head t_items; /* log item descriptors */
847fff5c 144 xfs_trans_header_t t_header; /* header for in-log trans */
ed3b4d6c 145 struct list_head t_busy; /* list of busy extents */
847fff5c
BN
146 unsigned long t_pflags; /* saved process flags state */
147} xfs_trans_t;
148
1da177e4
LT
149/*
150 * XFS transaction mechanism exported interfaces that are
151 * actually macros.
152 */
153#define xfs_trans_get_log_res(tp) ((tp)->t_log_res)
154#define xfs_trans_get_log_count(tp) ((tp)->t_log_count)
155#define xfs_trans_get_block_res(tp) ((tp)->t_blk_res)
156#define xfs_trans_set_sync(tp) ((tp)->t_flags |= XFS_TRANS_SYNC)
157
742ae1e3 158#if defined(DEBUG) || defined(XFS_WARN)
20f4ebf2
DC
159#define xfs_trans_agblocks_delta(tp, d) ((tp)->t_ag_freeblks_delta += (int64_t)d)
160#define xfs_trans_agflist_delta(tp, d) ((tp)->t_ag_flist_delta += (int64_t)d)
161#define xfs_trans_agbtree_delta(tp, d) ((tp)->t_ag_btree_delta += (int64_t)d)
1da177e4
LT
162#else
163#define xfs_trans_agblocks_delta(tp, d)
164#define xfs_trans_agflist_delta(tp, d)
165#define xfs_trans_agbtree_delta(tp, d)
166#endif
167
168/*
169 * XFS transaction mechanism exported interfaces.
170 */
1da177e4 171xfs_trans_t *xfs_trans_alloc(struct xfs_mount *, uint);
77ba7877 172xfs_trans_t *_xfs_trans_alloc(struct xfs_mount *, uint, xfs_km_flags_t);
1da177e4 173xfs_trans_t *xfs_trans_dup(xfs_trans_t *);
3d3c8b52 174int xfs_trans_reserve(struct xfs_trans *, struct xfs_trans_res *,
1da177e4 175 uint, uint);
20f4ebf2 176void xfs_trans_mod_sb(xfs_trans_t *, uint, int64_t);
de2a4f59
DC
177
178struct xfs_buf *xfs_trans_get_buf_map(struct xfs_trans *tp,
179 struct xfs_buftarg *target,
180 struct xfs_buf_map *map, int nmaps,
181 uint flags);
182
183static inline struct xfs_buf *
184xfs_trans_get_buf(
185 struct xfs_trans *tp,
186 struct xfs_buftarg *target,
187 xfs_daddr_t blkno,
188 int numblks,
189 uint flags)
190{
c3f8fc73 191 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
de2a4f59
DC
192 return xfs_trans_get_buf_map(tp, target, &map, 1, flags);
193}
194
195int xfs_trans_read_buf_map(struct xfs_mount *mp,
196 struct xfs_trans *tp,
197 struct xfs_buftarg *target,
198 struct xfs_buf_map *map, int nmaps,
199 xfs_buf_flags_t flags,
c3f8fc73 200 struct xfs_buf **bpp,
1813dd64 201 const struct xfs_buf_ops *ops);
de2a4f59
DC
202
203static inline int
204xfs_trans_read_buf(
205 struct xfs_mount *mp,
206 struct xfs_trans *tp,
207 struct xfs_buftarg *target,
208 xfs_daddr_t blkno,
209 int numblks,
210 xfs_buf_flags_t flags,
c3f8fc73 211 struct xfs_buf **bpp,
1813dd64 212 const struct xfs_buf_ops *ops)
de2a4f59 213{
c3f8fc73
DC
214 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
215 return xfs_trans_read_buf_map(mp, tp, target, &map, 1,
1813dd64 216 flags, bpp, ops);
de2a4f59
DC
217}
218
1da177e4
LT
219struct xfs_buf *xfs_trans_getsb(xfs_trans_t *, struct xfs_mount *, int);
220
221void xfs_trans_brelse(xfs_trans_t *, struct xfs_buf *);
222void xfs_trans_bjoin(xfs_trans_t *, struct xfs_buf *);
223void xfs_trans_bhold(xfs_trans_t *, struct xfs_buf *);
efa092f3 224void xfs_trans_bhold_release(xfs_trans_t *, struct xfs_buf *);
1da177e4
LT
225void xfs_trans_binval(xfs_trans_t *, struct xfs_buf *);
226void xfs_trans_inode_buf(xfs_trans_t *, struct xfs_buf *);
1da177e4 227void xfs_trans_stale_inode_buf(xfs_trans_t *, struct xfs_buf *);
5f6bed76 228void xfs_trans_ordered_buf(xfs_trans_t *, struct xfs_buf *);
1da177e4
LT
229void xfs_trans_dquot_buf(xfs_trans_t *, struct xfs_buf *, uint);
230void xfs_trans_inode_alloc_buf(xfs_trans_t *, struct xfs_buf *);
dcd79a14 231void xfs_trans_ichgtime(struct xfs_trans *, struct xfs_inode *, int);
ddc3415a 232void xfs_trans_ijoin(struct xfs_trans *, struct xfs_inode *, uint);
1da177e4
LT
233void xfs_trans_log_buf(xfs_trans_t *, struct xfs_buf *, uint, uint);
234void xfs_trans_log_inode(xfs_trans_t *, struct xfs_inode *, uint);
235struct xfs_efi_log_item *xfs_trans_get_efi(xfs_trans_t *, uint);
236void xfs_efi_release(struct xfs_efi_log_item *, uint);
237void xfs_trans_log_efi_extent(xfs_trans_t *,
238 struct xfs_efi_log_item *,
239 xfs_fsblock_t,
240 xfs_extlen_t);
241struct xfs_efd_log_item *xfs_trans_get_efd(xfs_trans_t *,
242 struct xfs_efi_log_item *,
243 uint);
244void xfs_trans_log_efd_extent(xfs_trans_t *,
245 struct xfs_efd_log_item *,
246 xfs_fsblock_t,
247 xfs_extlen_t);
b1037058 248int xfs_trans_commit(xfs_trans_t *, uint flags);
1da177e4 249void xfs_trans_cancel(xfs_trans_t *, int);
249a8c11
DC
250int xfs_trans_ail_init(struct xfs_mount *);
251void xfs_trans_ail_destroy(struct xfs_mount *);
1da177e4 252
a8272ce0 253extern kmem_zone_t *xfs_trans_zone;
e98c414f 254extern kmem_zone_t *xfs_log_item_desc_zone;
a8272ce0 255
1da177e4 256#endif /* __XFS_TRANS_H__ */