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 const struct xfs_item_ops *li_ops; /* function list */
41
42 /* delayed logging */
43 struct list_head li_cil; /* CIL pointers */
44 struct xfs_log_vec *li_lv; /* active log vector */
45 struct xfs_log_vec *li_lv_shadow; /* standby vector */
46 xfs_csn_t li_seq; /* CIL commit seq */
47 };
48
49 /*
50 * li_flags use the (set/test/clear)_bit atomic interfaces because updates can
51 * race with each other and we don't want to have to use the AIL lock to
52 * serialise all updates.
53 */
54 #define XFS_LI_IN_AIL 0
55 #define XFS_LI_ABORTED 1
56 #define XFS_LI_FAILED 2
57 #define XFS_LI_DIRTY 3 /* log item dirty in transaction */
58
59 #define XFS_LI_FLAGS \
60 { (1 << XFS_LI_IN_AIL), "IN_AIL" }, \
61 { (1 << XFS_LI_ABORTED), "ABORTED" }, \
62 { (1 << XFS_LI_FAILED), "FAILED" }, \
63 { (1 << XFS_LI_DIRTY), "DIRTY" }
64
65 struct xfs_item_ops {
66 unsigned flags;
67 void (*iop_size)(struct xfs_log_item *, int *, int *);
68 void (*iop_format)(struct xfs_log_item *, struct xfs_log_vec *);
69 void (*iop_pin)(struct xfs_log_item *);
70 void (*iop_unpin)(struct xfs_log_item *, int remove);
71 uint (*iop_push)(struct xfs_log_item *, struct list_head *);
72 void (*iop_committing)(struct xfs_log_item *lip, xfs_csn_t seq);
73 void (*iop_release)(struct xfs_log_item *);
74 xfs_lsn_t (*iop_committed)(struct xfs_log_item *, xfs_lsn_t);
75 int (*iop_recover)(struct xfs_log_item *lip,
76 struct list_head *capture_list);
77 bool (*iop_match)(struct xfs_log_item *item, uint64_t id);
78 struct xfs_log_item *(*iop_relog)(struct xfs_log_item *intent,
79 struct xfs_trans *tp);
80 };
81
82 /* Is this log item a deferred action intent? */
83 static inline bool
xlog_item_is_intent(struct xfs_log_item * lip)84 xlog_item_is_intent(struct xfs_log_item *lip)
85 {
86 return lip->li_ops->iop_recover != NULL &&
87 lip->li_ops->iop_match != NULL;
88 }
89
90 /* Is this a log intent-done item? */
91 static inline bool
xlog_item_is_intent_done(struct xfs_log_item * lip)92 xlog_item_is_intent_done(struct xfs_log_item *lip)
93 {
94 return lip->li_ops->iop_unpin == NULL &&
95 lip->li_ops->iop_push == NULL;
96 }
97
98 /*
99 * Release the log item as soon as committed. This is for items just logging
100 * intents that never need to be written back in place.
101 */
102 #define XFS_ITEM_RELEASE_WHEN_COMMITTED (1 << 0)
103
104 void xfs_log_item_init(struct xfs_mount *mp, struct xfs_log_item *item,
105 int type, const struct xfs_item_ops *ops);
106
107 /*
108 * Return values for the iop_push() routines.
109 */
110 #define XFS_ITEM_SUCCESS 0
111 #define XFS_ITEM_PINNED 1
112 #define XFS_ITEM_LOCKED 2
113 #define XFS_ITEM_FLUSHING 3
114
115 /*
116 * Deferred operation item relogging limits.
117 */
118 #define XFS_DEFER_OPS_NR_INODES 2 /* join up to two inodes */
119 #define XFS_DEFER_OPS_NR_BUFS 2 /* join up to two buffers */
120
121 /*
122 * This is the structure maintained for every active transaction.
123 */
124 typedef struct xfs_trans {
125 unsigned int t_magic; /* magic number */
126 unsigned int t_log_res; /* amt of log space resvd */
127 unsigned int t_log_count; /* count for perm log res */
128 unsigned int t_blk_res; /* # of blocks resvd */
129 unsigned int t_blk_res_used; /* # of resvd blocks used */
130 unsigned int t_rtx_res; /* # of rt extents resvd */
131 unsigned int t_rtx_res_used; /* # of resvd rt extents used */
132 unsigned int t_flags; /* misc flags */
133 xfs_fsblock_t t_firstblock; /* first block allocated */
134 struct xlog_ticket *t_ticket; /* log mgr ticket */
135 struct xfs_mount *t_mountp; /* ptr to fs mount struct */
136 struct xfs_dquot_acct *t_dqinfo; /* acctg info for dquots */
137 int64_t t_icount_delta; /* superblock icount change */
138 int64_t t_ifree_delta; /* superblock ifree change */
139 int64_t t_fdblocks_delta; /* superblock fdblocks chg */
140 int64_t t_res_fdblocks_delta; /* on-disk only chg */
141 int64_t t_frextents_delta;/* superblock freextents chg*/
142 int64_t t_res_frextents_delta; /* on-disk only chg */
143 int64_t t_dblocks_delta;/* superblock dblocks change */
144 int64_t t_agcount_delta;/* superblock agcount change */
145 int64_t t_imaxpct_delta;/* superblock imaxpct change */
146 int64_t t_rextsize_delta;/* superblock rextsize chg */
147 int64_t t_rbmblocks_delta;/* superblock rbmblocks chg */
148 int64_t t_rblocks_delta;/* superblock rblocks change */
149 int64_t t_rextents_delta;/* superblocks rextents chg */
150 int64_t t_rextslog_delta;/* superblocks rextslog chg */
151 struct list_head t_items; /* log item descriptors */
152 struct list_head t_busy; /* list of busy extents */
153 struct list_head t_dfops; /* deferred operations */
154 unsigned long t_pflags; /* saved process flags state */
155 } xfs_trans_t;
156
157 /*
158 * XFS transaction mechanism exported interfaces that are
159 * actually macros.
160 */
161 #define xfs_trans_set_sync(tp) ((tp)->t_flags |= XFS_TRANS_SYNC)
162
163 /*
164 * XFS transaction mechanism exported interfaces.
165 */
166 int xfs_trans_alloc(struct xfs_mount *mp, struct xfs_trans_res *resp,
167 uint blocks, uint rtextents, uint flags,
168 struct xfs_trans **tpp);
169 int xfs_trans_alloc_empty(struct xfs_mount *mp,
170 struct xfs_trans **tpp);
171 void xfs_trans_mod_sb(xfs_trans_t *, uint, int64_t);
172
173 int xfs_trans_get_buf_map(struct xfs_trans *tp, struct xfs_buftarg *target,
174 struct xfs_buf_map *map, int nmaps, xfs_buf_flags_t flags,
175 struct xfs_buf **bpp);
176
177 static inline int
xfs_trans_get_buf(struct xfs_trans * tp,struct xfs_buftarg * target,xfs_daddr_t blkno,int numblks,uint flags,struct xfs_buf ** bpp)178 xfs_trans_get_buf(
179 struct xfs_trans *tp,
180 struct xfs_buftarg *target,
181 xfs_daddr_t blkno,
182 int numblks,
183 uint flags,
184 struct xfs_buf **bpp)
185 {
186 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
187 return xfs_trans_get_buf_map(tp, target, &map, 1, flags, bpp);
188 }
189
190 int xfs_trans_read_buf_map(struct xfs_mount *mp,
191 struct xfs_trans *tp,
192 struct xfs_buftarg *target,
193 struct xfs_buf_map *map, int nmaps,
194 xfs_buf_flags_t flags,
195 struct xfs_buf **bpp,
196 const struct xfs_buf_ops *ops);
197
198 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)199 xfs_trans_read_buf(
200 struct xfs_mount *mp,
201 struct xfs_trans *tp,
202 struct xfs_buftarg *target,
203 xfs_daddr_t blkno,
204 int numblks,
205 xfs_buf_flags_t flags,
206 struct xfs_buf **bpp,
207 const struct xfs_buf_ops *ops)
208 {
209 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
210 return xfs_trans_read_buf_map(mp, tp, target, &map, 1,
211 flags, bpp, ops);
212 }
213
214 struct xfs_buf *xfs_trans_getsb(struct xfs_trans *);
215
216 void xfs_trans_brelse(xfs_trans_t *, struct xfs_buf *);
217 void xfs_trans_bjoin(xfs_trans_t *, struct xfs_buf *);
218 void xfs_trans_bhold(xfs_trans_t *, struct xfs_buf *);
219 void xfs_trans_bhold_release(xfs_trans_t *, struct xfs_buf *);
220 void xfs_trans_binval(xfs_trans_t *, struct xfs_buf *);
221 void xfs_trans_inode_buf(xfs_trans_t *, struct xfs_buf *);
222 void xfs_trans_stale_inode_buf(xfs_trans_t *, struct xfs_buf *);
223 bool xfs_trans_ordered_buf(xfs_trans_t *, struct xfs_buf *);
224 void xfs_trans_dquot_buf(xfs_trans_t *, struct xfs_buf *, uint);
225 void xfs_trans_inode_alloc_buf(xfs_trans_t *, struct xfs_buf *);
226 void xfs_trans_ichgtime(struct xfs_trans *, struct xfs_inode *, int);
227 void xfs_trans_ijoin(struct xfs_trans *, struct xfs_inode *, uint);
228 void xfs_trans_log_buf(struct xfs_trans *, struct xfs_buf *, uint,
229 uint);
230 void xfs_trans_dirty_buf(struct xfs_trans *, struct xfs_buf *);
231 bool xfs_trans_buf_is_dirty(struct xfs_buf *bp);
232 void xfs_trans_log_inode(xfs_trans_t *, struct xfs_inode *, uint);
233
234 int xfs_trans_commit(struct xfs_trans *);
235 int xfs_trans_roll(struct xfs_trans **);
236 int xfs_trans_roll_inode(struct xfs_trans **, struct xfs_inode *);
237 void xfs_trans_cancel(xfs_trans_t *);
238 int xfs_trans_ail_init(struct xfs_mount *);
239 void xfs_trans_ail_destroy(struct xfs_mount *);
240
241 void xfs_trans_buf_set_type(struct xfs_trans *, struct xfs_buf *,
242 enum xfs_blft);
243 void xfs_trans_buf_copy_type(struct xfs_buf *dst_bp,
244 struct xfs_buf *src_bp);
245
246 extern kmem_zone_t *xfs_trans_zone;
247
248 static inline struct xfs_log_item *
xfs_trans_item_relog(struct xfs_log_item * lip,struct xfs_trans * tp)249 xfs_trans_item_relog(
250 struct xfs_log_item *lip,
251 struct xfs_trans *tp)
252 {
253 return lip->li_ops->iop_relog(lip, tp);
254 }
255
256 struct xfs_dquot;
257
258 int xfs_trans_alloc_inode(struct xfs_inode *ip, struct xfs_trans_res *resv,
259 unsigned int dblocks, unsigned int rblocks, bool force,
260 struct xfs_trans **tpp);
261 int xfs_trans_alloc_icreate(struct xfs_mount *mp, struct xfs_trans_res *resv,
262 struct xfs_dquot *udqp, struct xfs_dquot *gdqp,
263 struct xfs_dquot *pdqp, unsigned int dblocks,
264 struct xfs_trans **tpp);
265 int xfs_trans_alloc_ichange(struct xfs_inode *ip, struct xfs_dquot *udqp,
266 struct xfs_dquot *gdqp, struct xfs_dquot *pdqp, bool force,
267 struct xfs_trans **tpp);
268
269 static inline void
xfs_trans_set_context(struct xfs_trans * tp)270 xfs_trans_set_context(
271 struct xfs_trans *tp)
272 {
273 ASSERT(current->journal_info == NULL);
274 tp->t_pflags = memalloc_nofs_save();
275 current->journal_info = tp;
276 }
277
278 static inline void
xfs_trans_clear_context(struct xfs_trans * tp)279 xfs_trans_clear_context(
280 struct xfs_trans *tp)
281 {
282 if (current->journal_info == tp) {
283 memalloc_nofs_restore(tp->t_pflags);
284 current->journal_info = NULL;
285 }
286 }
287
288 static inline void
xfs_trans_switch_context(struct xfs_trans * old_tp,struct xfs_trans * new_tp)289 xfs_trans_switch_context(
290 struct xfs_trans *old_tp,
291 struct xfs_trans *new_tp)
292 {
293 ASSERT(current->journal_info == old_tp);
294 new_tp->t_pflags = old_tp->t_pflags;
295 old_tp->t_pflags = 0;
296 current->journal_info = new_tp;
297 }
298
299 #endif /* __XFS_TRANS_H__ */
300
