1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2000-2002,2005 Silicon Graphics, Inc.
6 #ifndef __XFS_TRANS_H__
7 #define __XFS_TRANS_H__
9 /* kernel only transaction subsystem defines */
13 struct xfs_efd_log_item;
14 struct xfs_efi_log_item;
21 struct xfs_dquot_acct;
22 struct xfs_rud_log_item;
23 struct xfs_rui_log_item;
25 struct xfs_cui_log_item;
26 struct xfs_cud_log_item;
27 struct xfs_bui_log_item;
28 struct xfs_bud_log_item;
31 struct list_head li_ail; /* AIL pointers */
32 struct list_head li_trans; /* transaction list */
33 xfs_lsn_t li_lsn; /* last on-disk lsn */
34 struct xfs_mount *li_mountp; /* ptr to fs mount */
35 struct xfs_ail *li_ailp; /* ptr to AIL */
36 uint li_type; /* item type */
37 unsigned long li_flags; /* misc flags */
38 struct xfs_buf *li_buf; /* real buffer pointer */
39 struct list_head li_bio_list; /* buffer item list */
40 void (*li_cb)(struct xfs_buf *,
41 struct xfs_log_item *);
42 /* buffer item iodone */
44 const struct xfs_item_ops *li_ops; /* function list */
47 struct list_head li_cil; /* CIL pointers */
48 struct xfs_log_vec *li_lv; /* active log vector */
49 struct xfs_log_vec *li_lv_shadow; /* standby vector */
50 xfs_lsn_t li_seq; /* CIL commit seq */
54 * li_flags use the (set/test/clear)_bit atomic interfaces because updates can
55 * race with each other and we don't want to have to use the AIL lock to
56 * serialise all updates.
58 #define XFS_LI_IN_AIL 0
59 #define XFS_LI_ABORTED 1
60 #define XFS_LI_FAILED 2
61 #define XFS_LI_DIRTY 3 /* log item dirty in transaction */
62 #define XFS_LI_RECOVERED 4 /* log intent item has been recovered */
64 #define XFS_LI_FLAGS \
65 { (1 << XFS_LI_IN_AIL), "IN_AIL" }, \
66 { (1 << XFS_LI_ABORTED), "ABORTED" }, \
67 { (1 << XFS_LI_FAILED), "FAILED" }, \
68 { (1 << XFS_LI_DIRTY), "DIRTY" }, \
69 { (1 << XFS_LI_RECOVERED), "RECOVERED" }
73 void (*iop_size)(struct xfs_log_item *, int *, int *);
74 void (*iop_format)(struct xfs_log_item *, struct xfs_log_vec *);
75 void (*iop_pin)(struct xfs_log_item *);
76 void (*iop_unpin)(struct xfs_log_item *, int remove);
77 uint (*iop_push)(struct xfs_log_item *, struct list_head *);
78 void (*iop_committing)(struct xfs_log_item *, xfs_lsn_t commit_lsn);
79 void (*iop_release)(struct xfs_log_item *);
80 xfs_lsn_t (*iop_committed)(struct xfs_log_item *, xfs_lsn_t);
81 void (*iop_error)(struct xfs_log_item *, xfs_buf_t *);
82 int (*iop_recover)(struct xfs_log_item *lip, struct xfs_trans *tp);
83 bool (*iop_match)(struct xfs_log_item *item, uint64_t id);
87 * Release the log item as soon as committed. This is for items just logging
88 * intents that never need to be written back in place.
90 #define XFS_ITEM_RELEASE_WHEN_COMMITTED (1 << 0)
92 void xfs_log_item_init(struct xfs_mount *mp, struct xfs_log_item *item,
93 int type, const struct xfs_item_ops *ops);
96 * Return values for the iop_push() routines.
98 #define XFS_ITEM_SUCCESS 0
99 #define XFS_ITEM_PINNED 1
100 #define XFS_ITEM_LOCKED 2
101 #define XFS_ITEM_FLUSHING 3
104 * Deferred operation item relogging limits.
106 #define XFS_DEFER_OPS_NR_INODES 2 /* join up to two inodes */
107 #define XFS_DEFER_OPS_NR_BUFS 2 /* join up to two buffers */
110 * This is the structure maintained for every active transaction.
112 typedef struct xfs_trans {
113 unsigned int t_magic; /* magic number */
114 unsigned int t_log_res; /* amt of log space resvd */
115 unsigned int t_log_count; /* count for perm log res */
116 unsigned int t_blk_res; /* # of blocks resvd */
117 unsigned int t_blk_res_used; /* # of resvd blocks used */
118 unsigned int t_rtx_res; /* # of rt extents resvd */
119 unsigned int t_rtx_res_used; /* # of resvd rt extents used */
120 unsigned int t_flags; /* misc flags */
121 xfs_fsblock_t t_firstblock; /* first block allocated */
122 struct xlog_ticket *t_ticket; /* log mgr ticket */
123 struct xfs_mount *t_mountp; /* ptr to fs mount struct */
124 struct xfs_dquot_acct *t_dqinfo; /* acctg info for dquots */
125 int64_t t_icount_delta; /* superblock icount change */
126 int64_t t_ifree_delta; /* superblock ifree change */
127 int64_t t_fdblocks_delta; /* superblock fdblocks chg */
128 int64_t t_res_fdblocks_delta; /* on-disk only chg */
129 int64_t t_frextents_delta;/* superblock freextents chg*/
130 int64_t t_res_frextents_delta; /* on-disk only chg */
131 #if defined(DEBUG) || defined(XFS_WARN)
132 int64_t t_ag_freeblks_delta; /* debugging counter */
133 int64_t t_ag_flist_delta; /* debugging counter */
134 int64_t t_ag_btree_delta; /* debugging counter */
136 int64_t t_dblocks_delta;/* superblock dblocks change */
137 int64_t t_agcount_delta;/* superblock agcount change */
138 int64_t t_imaxpct_delta;/* superblock imaxpct change */
139 int64_t t_rextsize_delta;/* superblock rextsize chg */
140 int64_t t_rbmblocks_delta;/* superblock rbmblocks chg */
141 int64_t t_rblocks_delta;/* superblock rblocks change */
142 int64_t t_rextents_delta;/* superblocks rextents chg */
143 int64_t t_rextslog_delta;/* superblocks rextslog chg */
144 struct list_head t_items; /* log item descriptors */
145 struct list_head t_busy; /* list of busy extents */
146 struct list_head t_dfops; /* deferred operations */
147 unsigned long t_pflags; /* saved process flags state */
151 * XFS transaction mechanism exported interfaces that are
154 #define xfs_trans_set_sync(tp) ((tp)->t_flags |= XFS_TRANS_SYNC)
156 #if defined(DEBUG) || defined(XFS_WARN)
157 #define xfs_trans_agblocks_delta(tp, d) ((tp)->t_ag_freeblks_delta += (int64_t)d)
158 #define xfs_trans_agflist_delta(tp, d) ((tp)->t_ag_flist_delta += (int64_t)d)
159 #define xfs_trans_agbtree_delta(tp, d) ((tp)->t_ag_btree_delta += (int64_t)d)
161 #define xfs_trans_agblocks_delta(tp, d)
162 #define xfs_trans_agflist_delta(tp, d)
163 #define xfs_trans_agbtree_delta(tp, d)
167 * XFS transaction mechanism exported interfaces.
169 int xfs_trans_alloc(struct xfs_mount *mp, struct xfs_trans_res *resp,
170 uint blocks, uint rtextents, uint flags,
171 struct xfs_trans **tpp);
172 int xfs_trans_alloc_empty(struct xfs_mount *mp,
173 struct xfs_trans **tpp);
174 void xfs_trans_mod_sb(xfs_trans_t *, uint, int64_t);
176 int xfs_trans_get_buf_map(struct xfs_trans *tp, struct xfs_buftarg *target,
177 struct xfs_buf_map *map, int nmaps, xfs_buf_flags_t flags,
178 struct xfs_buf **bpp);
182 struct xfs_trans *tp,
183 struct xfs_buftarg *target,
187 struct xfs_buf **bpp)
189 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
190 return xfs_trans_get_buf_map(tp, target, &map, 1, flags, bpp);
193 int xfs_trans_read_buf_map(struct xfs_mount *mp,
194 struct xfs_trans *tp,
195 struct xfs_buftarg *target,
196 struct xfs_buf_map *map, int nmaps,
197 xfs_buf_flags_t flags,
198 struct xfs_buf **bpp,
199 const struct xfs_buf_ops *ops);
203 struct xfs_mount *mp,
204 struct xfs_trans *tp,
205 struct xfs_buftarg *target,
208 xfs_buf_flags_t flags,
209 struct xfs_buf **bpp,
210 const struct xfs_buf_ops *ops)
212 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
213 return xfs_trans_read_buf_map(mp, tp, target, &map, 1,
217 struct xfs_buf *xfs_trans_getsb(xfs_trans_t *, struct xfs_mount *);
219 void xfs_trans_brelse(xfs_trans_t *, struct xfs_buf *);
220 void xfs_trans_bjoin(xfs_trans_t *, struct xfs_buf *);
221 void xfs_trans_bhold(xfs_trans_t *, struct xfs_buf *);
222 void xfs_trans_bhold_release(xfs_trans_t *, struct xfs_buf *);
223 void xfs_trans_binval(xfs_trans_t *, struct xfs_buf *);
224 void xfs_trans_inode_buf(xfs_trans_t *, struct xfs_buf *);
225 void xfs_trans_stale_inode_buf(xfs_trans_t *, struct xfs_buf *);
226 bool xfs_trans_ordered_buf(xfs_trans_t *, struct xfs_buf *);
227 void xfs_trans_dquot_buf(xfs_trans_t *, struct xfs_buf *, uint);
228 void xfs_trans_inode_alloc_buf(xfs_trans_t *, struct xfs_buf *);
229 void xfs_trans_ichgtime(struct xfs_trans *, struct xfs_inode *, int);
230 void xfs_trans_ijoin(struct xfs_trans *, struct xfs_inode *, uint);
231 void xfs_trans_log_buf(struct xfs_trans *, struct xfs_buf *, uint,
233 void xfs_trans_dirty_buf(struct xfs_trans *, struct xfs_buf *);
234 bool xfs_trans_buf_is_dirty(struct xfs_buf *bp);
235 void xfs_trans_log_inode(xfs_trans_t *, struct xfs_inode *, uint);
237 int xfs_trans_commit(struct xfs_trans *);
238 int xfs_trans_roll(struct xfs_trans **);
239 int xfs_trans_roll_inode(struct xfs_trans **, struct xfs_inode *);
240 void xfs_trans_cancel(xfs_trans_t *);
241 int xfs_trans_ail_init(struct xfs_mount *);
242 void xfs_trans_ail_destroy(struct xfs_mount *);
244 void xfs_trans_buf_set_type(struct xfs_trans *, struct xfs_buf *,
246 void xfs_trans_buf_copy_type(struct xfs_buf *dst_bp,
247 struct xfs_buf *src_bp);
249 extern kmem_zone_t *xfs_trans_zone;
251 #endif /* __XFS_TRANS_H__ */