1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * Copyright (c) 2000-2002,2005 Silicon Graphics, Inc.
4 * All Rights Reserved.
5 */
6 #ifndef __XFS_TRANS_H__
7 #define __XFS_TRANS_H__
8
9 /* kernel only transaction subsystem defines */
10
11 struct xfs_buf;
12 struct xfs_buftarg;
13 struct xfs_efd_log_item;
14 struct xfs_efi_log_item;
15 struct xfs_inode;
16 struct xfs_item_ops;
17 struct xfs_log_iovec;
18 struct xfs_mount;
19 struct xfs_trans;
20 struct xfs_trans_res;
21 struct xfs_dquot_acct;
22 struct xfs_rud_log_item;
23 struct xfs_rui_log_item;
24 struct xfs_btree_cur;
25 struct xfs_cui_log_item;
26 struct xfs_cud_log_item;
27 struct xfs_bui_log_item;
28 struct xfs_bud_log_item;
29
30 struct xfs_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 */
43 /* callback func */
44 const struct xfs_item_ops *li_ops; /* function list */
45
46 /* delayed logging */
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 */
51 };
52
53 /*
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.
57 */
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
63 #define XFS_LI_FLAGS \
64 { (1 << XFS_LI_IN_AIL), "IN_AIL" }, \
65 { (1 << XFS_LI_ABORTED), "ABORTED" }, \
66 { (1 << XFS_LI_FAILED), "FAILED" }, \
67 { (1 << XFS_LI_DIRTY), "DIRTY" }
68
69 struct xfs_item_ops {
70 unsigned flags;
71 void (*iop_size)(struct xfs_log_item *, int *, int *);
72 void (*iop_format)(struct xfs_log_item *, struct xfs_log_vec *);
73 void (*iop_pin)(struct xfs_log_item *);
74 void (*iop_unpin)(struct xfs_log_item *, int remove);
75 uint (*iop_push)(struct xfs_log_item *, struct list_head *);
76 void (*iop_committing)(struct xfs_log_item *, xfs_lsn_t commit_lsn);
77 void (*iop_release)(struct xfs_log_item *);
78 xfs_lsn_t (*iop_committed)(struct xfs_log_item *, xfs_lsn_t);
79 void (*iop_error)(struct xfs_log_item *, xfs_buf_t *);
80 struct xfs_log_item *(*iop_relog)(struct xfs_log_item *intent,
81 struct xfs_trans *tp);
82 };
83
84 /*
85 * Release the log item as soon as committed. This is for items just logging
86 * intents that never need to be written back in place.
87 */
88 #define XFS_ITEM_RELEASE_WHEN_COMMITTED (1 << 0)
89
90 void xfs_log_item_init(struct xfs_mount *mp, struct xfs_log_item *item,
91 int type, const struct xfs_item_ops *ops);
92
93 /*
94 * Return values for the iop_push() routines.
95 */
96 #define XFS_ITEM_SUCCESS 0
97 #define XFS_ITEM_PINNED 1
98 #define XFS_ITEM_LOCKED 2
99 #define XFS_ITEM_FLUSHING 3
100
101 /*
102 * Deferred operation item relogging limits.
103 */
104 #define XFS_DEFER_OPS_NR_INODES 2 /* join up to two inodes */
105 #define XFS_DEFER_OPS_NR_BUFS 2 /* join up to two buffers */
106
107 /*
108 * This is the structure maintained for every active transaction.
109 */
110 typedef struct xfs_trans {
111 unsigned int t_magic; /* magic number */
112 unsigned int t_log_res; /* amt of log space resvd */
113 unsigned int t_log_count; /* count for perm log res */
114 unsigned int t_blk_res; /* # of blocks resvd */
115 unsigned int t_blk_res_used; /* # of resvd blocks used */
116 unsigned int t_rtx_res; /* # of rt extents resvd */
117 unsigned int t_rtx_res_used; /* # of resvd rt extents used */
118 unsigned int t_flags; /* misc flags */
119 xfs_fsblock_t t_firstblock; /* first block allocated */
120 struct xlog_ticket *t_ticket; /* log mgr ticket */
121 struct xfs_mount *t_mountp; /* ptr to fs mount struct */
122 struct xfs_dquot_acct *t_dqinfo; /* acctg info for dquots */
123 int64_t t_icount_delta; /* superblock icount change */
124 int64_t t_ifree_delta; /* superblock ifree change */
125 int64_t t_fdblocks_delta; /* superblock fdblocks chg */
126 int64_t t_res_fdblocks_delta; /* on-disk only chg */
127 int64_t t_frextents_delta;/* superblock freextents chg*/
128 int64_t t_res_frextents_delta; /* on-disk only chg */
129 #if defined(DEBUG) || defined(XFS_WARN)
130 int64_t t_ag_freeblks_delta; /* debugging counter */
131 int64_t t_ag_flist_delta; /* debugging counter */
132 int64_t t_ag_btree_delta; /* debugging counter */
133 #endif
134 int64_t t_dblocks_delta;/* superblock dblocks change */
135 int64_t t_agcount_delta;/* superblock agcount change */
136 int64_t t_imaxpct_delta;/* superblock imaxpct change */
137 int64_t t_rextsize_delta;/* superblock rextsize chg */
138 int64_t t_rbmblocks_delta;/* superblock rbmblocks chg */
139 int64_t t_rblocks_delta;/* superblock rblocks change */
140 int64_t t_rextents_delta;/* superblocks rextents chg */
141 int64_t t_rextslog_delta;/* superblocks rextslog chg */
142 struct list_head t_items; /* log item descriptors */
143 struct list_head t_busy; /* list of busy extents */
144 struct list_head t_dfops; /* deferred operations */
145 unsigned long t_pflags; /* saved process flags state */
146 } xfs_trans_t;
147
148 /*
149 * XFS transaction mechanism exported interfaces that are
150 * actually macros.
151 */
152 #define xfs_trans_set_sync(tp) ((tp)->t_flags |= XFS_TRANS_SYNC)
153
154 #if defined(DEBUG) || defined(XFS_WARN)
155 #define xfs_trans_agblocks_delta(tp, d) ((tp)->t_ag_freeblks_delta += (int64_t)d)
156 #define xfs_trans_agflist_delta(tp, d) ((tp)->t_ag_flist_delta += (int64_t)d)
157 #define xfs_trans_agbtree_delta(tp, d) ((tp)->t_ag_btree_delta += (int64_t)d)
158 #else
159 #define xfs_trans_agblocks_delta(tp, d)
160 #define xfs_trans_agflist_delta(tp, d)
161 #define xfs_trans_agbtree_delta(tp, d)
162 #endif
163
164 /*
165 * XFS transaction mechanism exported interfaces.
166 */
167 int xfs_trans_alloc(struct xfs_mount *mp, struct xfs_trans_res *resp,
168 uint blocks, uint rtextents, uint flags,
169 struct xfs_trans **tpp);
170 int xfs_trans_alloc_empty(struct xfs_mount *mp,
171 struct xfs_trans **tpp);
172 void xfs_trans_mod_sb(xfs_trans_t *, uint, int64_t);
173
174 struct xfs_buf *xfs_trans_get_buf_map(struct xfs_trans *tp,
175 struct xfs_buftarg *target,
176 struct xfs_buf_map *map, int nmaps,
177 uint flags);
178
179 static inline struct xfs_buf *
xfs_trans_get_buf(struct xfs_trans * tp,struct xfs_buftarg * target,xfs_daddr_t blkno,int numblks,uint flags)180 xfs_trans_get_buf(
181 struct xfs_trans *tp,
182 struct xfs_buftarg *target,
183 xfs_daddr_t blkno,
184 int numblks,
185 uint flags)
186 {
187 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
188 return xfs_trans_get_buf_map(tp, target, &map, 1, flags);
189 }
190
191 int xfs_trans_read_buf_map(struct xfs_mount *mp,
192 struct xfs_trans *tp,
193 struct xfs_buftarg *target,
194 struct xfs_buf_map *map, int nmaps,
195 xfs_buf_flags_t flags,
196 struct xfs_buf **bpp,
197 const struct xfs_buf_ops *ops);
198
199 static inline int
xfs_trans_read_buf(struct xfs_mount * mp,struct xfs_trans * tp,struct xfs_buftarg * target,xfs_daddr_t blkno,int numblks,xfs_buf_flags_t flags,struct xfs_buf ** bpp,const struct xfs_buf_ops * ops)200 xfs_trans_read_buf(
201 struct xfs_mount *mp,
202 struct xfs_trans *tp,
203 struct xfs_buftarg *target,
204 xfs_daddr_t blkno,
205 int numblks,
206 xfs_buf_flags_t flags,
207 struct xfs_buf **bpp,
208 const struct xfs_buf_ops *ops)
209 {
210 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
211 return xfs_trans_read_buf_map(mp, tp, target, &map, 1,
212 flags, bpp, ops);
213 }
214
215 struct xfs_buf *xfs_trans_getsb(xfs_trans_t *, struct xfs_mount *);
216
217 void xfs_trans_brelse(xfs_trans_t *, struct xfs_buf *);
218 void xfs_trans_bjoin(xfs_trans_t *, struct xfs_buf *);
219 void xfs_trans_bhold(xfs_trans_t *, struct xfs_buf *);
220 void xfs_trans_bhold_release(xfs_trans_t *, struct xfs_buf *);
221 void xfs_trans_binval(xfs_trans_t *, struct xfs_buf *);
222 void xfs_trans_inode_buf(xfs_trans_t *, struct xfs_buf *);
223 void xfs_trans_stale_inode_buf(xfs_trans_t *, struct xfs_buf *);
224 bool xfs_trans_ordered_buf(xfs_trans_t *, struct xfs_buf *);
225 void xfs_trans_dquot_buf(xfs_trans_t *, struct xfs_buf *, uint);
226 void xfs_trans_inode_alloc_buf(xfs_trans_t *, struct xfs_buf *);
227 void xfs_trans_ichgtime(struct xfs_trans *, struct xfs_inode *, int);
228 void xfs_trans_ijoin(struct xfs_trans *, struct xfs_inode *, uint);
229 void xfs_trans_log_buf(struct xfs_trans *, struct xfs_buf *, uint,
230 uint);
231 void xfs_trans_dirty_buf(struct xfs_trans *, struct xfs_buf *);
232 bool xfs_trans_buf_is_dirty(struct xfs_buf *bp);
233 void xfs_trans_log_inode(xfs_trans_t *, struct xfs_inode *, uint);
234
235 int xfs_trans_commit(struct xfs_trans *);
236 int xfs_trans_roll(struct xfs_trans **);
237 int xfs_trans_roll_inode(struct xfs_trans **, struct xfs_inode *);
238 void xfs_trans_cancel(xfs_trans_t *);
239 int xfs_trans_ail_init(struct xfs_mount *);
240 void xfs_trans_ail_destroy(struct xfs_mount *);
241
242 void xfs_trans_buf_set_type(struct xfs_trans *, struct xfs_buf *,
243 enum xfs_blft);
244 void xfs_trans_buf_copy_type(struct xfs_buf *dst_bp,
245 struct xfs_buf *src_bp);
246
247 extern kmem_zone_t *xfs_trans_zone;
248
249 static inline struct xfs_log_item *
xfs_trans_item_relog(struct xfs_log_item * lip,struct xfs_trans * tp)250 xfs_trans_item_relog(
251 struct xfs_log_item *lip,
252 struct xfs_trans *tp)
253 {
254 return lip->li_ops->iop_relog(lip, tp);
255 }
256
257 #endif /* __XFS_TRANS_H__ */
258