Merge tag 'char-misc-5.19-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/gregk...
[linux-block.git] / fs / xfs / xfs_trans.h
CommitLineData
0b61f8a4 1// SPDX-License-Identifier: GPL-2.0
1da177e4 2/*
7b718769
NS
3 * Copyright (c) 2000-2002,2005 Silicon Graphics, Inc.
4 * All Rights Reserved.
1da177e4
LT
5 */
6#ifndef __XFS_TRANS_H__
7#define __XFS_TRANS_H__
8
7fd36c44 9/* kernel only transaction subsystem defines */
847fff5c 10
d86142dd 11struct xlog;
847fff5c
BN
12struct xfs_buf;
13struct xfs_buftarg;
14struct xfs_efd_log_item;
15struct xfs_efi_log_item;
16struct xfs_inode;
17struct xfs_item_ops;
18struct xfs_log_iovec;
847fff5c
BN
19struct xfs_mount;
20struct xfs_trans;
3d3c8b52 21struct xfs_trans_res;
847fff5c 22struct xfs_dquot_acct;
f8dbebef
DW
23struct xfs_rud_log_item;
24struct xfs_rui_log_item;
9c194644 25struct xfs_btree_cur;
f997ee21 26struct xfs_cui_log_item;
33ba6129 27struct xfs_cud_log_item;
77d61fe4 28struct xfs_bui_log_item;
9f3afb57 29struct xfs_bud_log_item;
847fff5c 30
efe2330f 31struct xfs_log_item {
847fff5c 32 struct list_head li_ail; /* AIL pointers */
e6631f85 33 struct list_head li_trans; /* transaction list */
847fff5c 34 xfs_lsn_t li_lsn; /* last on-disk lsn */
d86142dd 35 struct xlog *li_log;
fc1829f3 36 struct xfs_ail *li_ailp; /* ptr to AIL */
847fff5c 37 uint li_type; /* item type */
22525c17 38 unsigned long li_flags; /* misc flags */
d3a304b6 39 struct xfs_buf *li_buf; /* real buffer pointer */
643c8c05 40 struct list_head li_bio_list; /* buffer item list */
272e42b2 41 const struct xfs_item_ops *li_ops; /* function list */
71e330b5
DC
42
43 /* delayed logging */
44 struct list_head li_cil; /* CIL pointers */
45 struct xfs_log_vec *li_lv; /* active log vector */
b1c5ebb2 46 struct xfs_log_vec *li_lv_shadow; /* standby vector */
5f9b4b0d 47 xfs_csn_t li_seq; /* CIL commit seq */
efe2330f 48};
847fff5c 49
22525c17
DC
50/*
51 * li_flags use the (set/test/clear)_bit atomic interfaces because updates can
52 * race with each other and we don't want to have to use the AIL lock to
53 * serialise all updates.
54 */
55#define XFS_LI_IN_AIL 0
56#define XFS_LI_ABORTED 1
57#define XFS_LI_FAILED 2
0d227466
DC
58#define XFS_LI_DIRTY 3
59#define XFS_LI_WHITEOUT 4
847fff5c 60
0b1b213f 61#define XFS_LI_FLAGS \
22d53f48
DC
62 { (1u << XFS_LI_IN_AIL), "IN_AIL" }, \
63 { (1u << XFS_LI_ABORTED), "ABORTED" }, \
64 { (1u << XFS_LI_FAILED), "FAILED" }, \
0d227466
DC
65 { (1u << XFS_LI_DIRTY), "DIRTY" }, \
66 { (1u << XFS_LI_WHITEOUT), "WHITEOUT" }
0b1b213f 67
272e42b2 68struct xfs_item_ops {
9ce632a2 69 unsigned flags;
efe2330f
CH
70 void (*iop_size)(struct xfs_log_item *, int *, int *);
71 void (*iop_format)(struct xfs_log_item *, struct xfs_log_vec *);
72 void (*iop_pin)(struct xfs_log_item *);
73 void (*iop_unpin)(struct xfs_log_item *, int remove);
43ff2122 74 uint (*iop_push)(struct xfs_log_item *, struct list_head *);
5f9b4b0d 75 void (*iop_committing)(struct xfs_log_item *lip, xfs_csn_t seq);
ddf92053 76 void (*iop_release)(struct xfs_log_item *);
efe2330f 77 xfs_lsn_t (*iop_committed)(struct xfs_log_item *, xfs_lsn_t);
e6fff81e
DW
78 int (*iop_recover)(struct xfs_log_item *lip,
79 struct list_head *capture_list);
154c733a 80 bool (*iop_match)(struct xfs_log_item *item, uint64_t id);
4e919af7
DW
81 struct xfs_log_item *(*iop_relog)(struct xfs_log_item *intent,
82 struct xfs_trans *tp);
c23ab603 83 struct xfs_log_item *(*iop_intent)(struct xfs_log_item *intent_done);
272e42b2 84};
847fff5c 85
f5b81200
DC
86/*
87 * Log item ops flags
88 */
89/*
90 * Release the log item when the journal commits instead of inserting into the
91 * AIL for writeback tracking and/or log tail pinning.
92 */
93#define XFS_ITEM_RELEASE_WHEN_COMMITTED (1 << 0)
94#define XFS_ITEM_INTENT (1 << 1)
95#define XFS_ITEM_INTENT_DONE (1 << 2)
96
d6b8fc6c
KX
97static inline bool
98xlog_item_is_intent(struct xfs_log_item *lip)
99{
f5b81200 100 return lip->li_ops->flags & XFS_ITEM_INTENT;
d6b8fc6c
KX
101}
102
d6b8fc6c
KX
103static inline bool
104xlog_item_is_intent_done(struct xfs_log_item *lip)
105{
f5b81200 106 return lip->li_ops->flags & XFS_ITEM_INTENT_DONE;
d6b8fc6c
KX
107}
108
239880ef
DC
109void xfs_log_item_init(struct xfs_mount *mp, struct xfs_log_item *item,
110 int type, const struct xfs_item_ops *ops);
111
847fff5c 112/*
904c17e6 113 * Return values for the iop_push() routines.
847fff5c 114 */
43ff2122
CH
115#define XFS_ITEM_SUCCESS 0
116#define XFS_ITEM_PINNED 1
117#define XFS_ITEM_LOCKED 2
118#define XFS_ITEM_FLUSHING 3
847fff5c 119
847fff5c
BN
120/*
121 * This is the structure maintained for every active transaction.
122 */
123typedef struct xfs_trans {
124 unsigned int t_magic; /* magic number */
847fff5c
BN
125 unsigned int t_log_res; /* amt of log space resvd */
126 unsigned int t_log_count; /* count for perm log res */
127 unsigned int t_blk_res; /* # of blocks resvd */
128 unsigned int t_blk_res_used; /* # of resvd blocks used */
129 unsigned int t_rtx_res; /* # of rt extents resvd */
130 unsigned int t_rtx_res_used; /* # of resvd rt extents used */
44fd2946 131 unsigned int t_flags; /* misc flags */
bba59c5e 132 xfs_fsblock_t t_firstblock; /* first block allocated */
35a8a72f 133 struct xlog_ticket *t_ticket; /* log mgr ticket */
847fff5c
BN
134 struct xfs_mount *t_mountp; /* ptr to fs mount struct */
135 struct xfs_dquot_acct *t_dqinfo; /* acctg info for dquots */
847fff5c
BN
136 int64_t t_icount_delta; /* superblock icount change */
137 int64_t t_ifree_delta; /* superblock ifree change */
138 int64_t t_fdblocks_delta; /* superblock fdblocks chg */
139 int64_t t_res_fdblocks_delta; /* on-disk only chg */
140 int64_t t_frextents_delta;/* superblock freextents chg*/
141 int64_t t_res_frextents_delta; /* on-disk only chg */
847fff5c
BN
142 int64_t t_dblocks_delta;/* superblock dblocks change */
143 int64_t t_agcount_delta;/* superblock agcount change */
144 int64_t t_imaxpct_delta;/* superblock imaxpct change */
145 int64_t t_rextsize_delta;/* superblock rextsize chg */
146 int64_t t_rbmblocks_delta;/* superblock rbmblocks chg */
147 int64_t t_rblocks_delta;/* superblock rblocks change */
148 int64_t t_rextents_delta;/* superblocks rextents chg */
149 int64_t t_rextslog_delta;/* superblocks rextslog chg */
e98c414f 150 struct list_head t_items; /* log item descriptors */
ed3b4d6c 151 struct list_head t_busy; /* list of busy extents */
9d9e6233 152 struct list_head t_dfops; /* deferred operations */
847fff5c
BN
153 unsigned long t_pflags; /* saved process flags state */
154} xfs_trans_t;
155
1da177e4
LT
156/*
157 * XFS transaction mechanism exported interfaces that are
158 * actually macros.
159 */
1da177e4
LT
160#define xfs_trans_set_sync(tp) ((tp)->t_flags |= XFS_TRANS_SYNC)
161
1da177e4
LT
162/*
163 * XFS transaction mechanism exported interfaces.
164 */
253f4911
CH
165int xfs_trans_alloc(struct xfs_mount *mp, struct xfs_trans_res *resp,
166 uint blocks, uint rtextents, uint flags,
167 struct xfs_trans **tpp);
e89c0413
DW
168int xfs_trans_alloc_empty(struct xfs_mount *mp,
169 struct xfs_trans **tpp);
20f4ebf2 170void xfs_trans_mod_sb(xfs_trans_t *, uint, int64_t);
de2a4f59 171
9676b54e
DW
172int xfs_trans_get_buf_map(struct xfs_trans *tp, struct xfs_buftarg *target,
173 struct xfs_buf_map *map, int nmaps, xfs_buf_flags_t flags,
174 struct xfs_buf **bpp);
de2a4f59 175
ce92464c 176static inline int
de2a4f59
DC
177xfs_trans_get_buf(
178 struct xfs_trans *tp,
179 struct xfs_buftarg *target,
180 xfs_daddr_t blkno,
181 int numblks,
b9b3fe15 182 xfs_buf_flags_t flags,
ce92464c 183 struct xfs_buf **bpp)
de2a4f59 184{
c3f8fc73 185 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
ce92464c 186 return xfs_trans_get_buf_map(tp, target, &map, 1, flags, bpp);
de2a4f59
DC
187}
188
189int xfs_trans_read_buf_map(struct xfs_mount *mp,
190 struct xfs_trans *tp,
191 struct xfs_buftarg *target,
192 struct xfs_buf_map *map, int nmaps,
193 xfs_buf_flags_t flags,
c3f8fc73 194 struct xfs_buf **bpp,
1813dd64 195 const struct xfs_buf_ops *ops);
de2a4f59
DC
196
197static inline int
198xfs_trans_read_buf(
199 struct xfs_mount *mp,
200 struct xfs_trans *tp,
201 struct xfs_buftarg *target,
202 xfs_daddr_t blkno,
203 int numblks,
204 xfs_buf_flags_t flags,
c3f8fc73 205 struct xfs_buf **bpp,
1813dd64 206 const struct xfs_buf_ops *ops)
de2a4f59 207{
c3f8fc73
DC
208 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
209 return xfs_trans_read_buf_map(mp, tp, target, &map, 1,
1813dd64 210 flags, bpp, ops);
de2a4f59
DC
211}
212
cead0b10 213struct xfs_buf *xfs_trans_getsb(struct xfs_trans *);
1da177e4
LT
214
215void xfs_trans_brelse(xfs_trans_t *, struct xfs_buf *);
216void xfs_trans_bjoin(xfs_trans_t *, struct xfs_buf *);
217void xfs_trans_bhold(xfs_trans_t *, struct xfs_buf *);
efa092f3 218void xfs_trans_bhold_release(xfs_trans_t *, struct xfs_buf *);
1da177e4
LT
219void xfs_trans_binval(xfs_trans_t *, struct xfs_buf *);
220void xfs_trans_inode_buf(xfs_trans_t *, struct xfs_buf *);
1da177e4 221void xfs_trans_stale_inode_buf(xfs_trans_t *, struct xfs_buf *);
a5814bce 222bool xfs_trans_ordered_buf(xfs_trans_t *, struct xfs_buf *);
1da177e4
LT
223void xfs_trans_dquot_buf(xfs_trans_t *, struct xfs_buf *, uint);
224void xfs_trans_inode_alloc_buf(xfs_trans_t *, struct xfs_buf *);
dcd79a14 225void xfs_trans_ichgtime(struct xfs_trans *, struct xfs_inode *, int);
ddc3415a 226void xfs_trans_ijoin(struct xfs_trans *, struct xfs_inode *, uint);
9684010d
BF
227void xfs_trans_log_buf(struct xfs_trans *, struct xfs_buf *, uint,
228 uint);
229void xfs_trans_dirty_buf(struct xfs_trans *, struct xfs_buf *);
38b6238e 230bool xfs_trans_buf_is_dirty(struct xfs_buf *bp);
1da177e4 231void xfs_trans_log_inode(xfs_trans_t *, struct xfs_inode *, uint);
9749fee8 232
70393313 233int xfs_trans_commit(struct xfs_trans *);
411350df
CH
234int xfs_trans_roll(struct xfs_trans **);
235int xfs_trans_roll_inode(struct xfs_trans **, struct xfs_inode *);
4906e215 236void xfs_trans_cancel(xfs_trans_t *);
249a8c11
DC
237int xfs_trans_ail_init(struct xfs_mount *);
238void xfs_trans_ail_destroy(struct xfs_mount *);
1da177e4 239
a4fbe6ab
DC
240void xfs_trans_buf_set_type(struct xfs_trans *, struct xfs_buf *,
241 enum xfs_blft);
242void xfs_trans_buf_copy_type(struct xfs_buf *dst_bp,
243 struct xfs_buf *src_bp);
244
182696fb 245extern struct kmem_cache *xfs_trans_cache;
a8272ce0 246
4e919af7
DW
247static inline struct xfs_log_item *
248xfs_trans_item_relog(
249 struct xfs_log_item *lip,
250 struct xfs_trans *tp)
251{
252 return lip->li_ops->iop_relog(lip, tp);
253}
254
f2f7b9ff
DW
255struct xfs_dquot;
256
3a1af6c3 257int xfs_trans_alloc_inode(struct xfs_inode *ip, struct xfs_trans_res *resv,
3de4eb10
DW
258 unsigned int dblocks, unsigned int rblocks, bool force,
259 struct xfs_trans **tpp);
f2f7b9ff
DW
260int xfs_trans_alloc_icreate(struct xfs_mount *mp, struct xfs_trans_res *resv,
261 struct xfs_dquot *udqp, struct xfs_dquot *gdqp,
262 struct xfs_dquot *pdqp, unsigned int dblocks,
263 struct xfs_trans **tpp);
7317a03d
DW
264int xfs_trans_alloc_ichange(struct xfs_inode *ip, struct xfs_dquot *udqp,
265 struct xfs_dquot *gdqp, struct xfs_dquot *pdqp, bool force,
266 struct xfs_trans **tpp);
871b9316
DW
267int xfs_trans_alloc_dir(struct xfs_inode *dp, struct xfs_trans_res *resv,
268 struct xfs_inode *ip, unsigned int *dblocks,
269 struct xfs_trans **tpp, int *nospace_error);
3a1af6c3 270
756b1c34
DC
271static inline void
272xfs_trans_set_context(
273 struct xfs_trans *tp)
274{
275 ASSERT(current->journal_info == NULL);
276 tp->t_pflags = memalloc_nofs_save();
277 current->journal_info = tp;
278}
279
280static inline void
281xfs_trans_clear_context(
282 struct xfs_trans *tp)
283{
284 if (current->journal_info == tp) {
285 memalloc_nofs_restore(tp->t_pflags);
286 current->journal_info = NULL;
287 }
288}
289
290static inline void
291xfs_trans_switch_context(
292 struct xfs_trans *old_tp,
293 struct xfs_trans *new_tp)
294{
295 ASSERT(current->journal_info == old_tp);
296 new_tp->t_pflags = old_tp->t_pflags;
297 old_tp->t_pflags = 0;
298 current->journal_info = new_tp;
299}
300
1da177e4 301#endif /* __XFS_TRANS_H__ */