xref: /openbmc/linux/fs/xfs/xfs_trans.h (revision 6c71a0574249f5e5a45fe055ab5f837023d5eeca)
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 xlog;
12  struct xfs_buf;
13  struct xfs_buftarg;
14  struct xfs_efd_log_item;
15  struct xfs_efi_log_item;
16  struct xfs_inode;
17  struct xfs_item_ops;
18  struct xfs_log_iovec;
19  struct xfs_mount;
20  struct xfs_trans;
21  struct xfs_trans_res;
22  struct xfs_dquot_acct;
23  struct xfs_rud_log_item;
24  struct xfs_rui_log_item;
25  struct xfs_btree_cur;
26  struct xfs_cui_log_item;
27  struct xfs_cud_log_item;
28  struct xfs_bui_log_item;
29  struct xfs_bud_log_item;
30  
31  struct xfs_log_item {
32  	struct list_head		li_ail;		/* AIL pointers */
33  	struct list_head		li_trans;	/* transaction list */
34  	xfs_lsn_t			li_lsn;		/* last on-disk lsn */
35  	struct xlog			*li_log;
36  	struct xfs_ail			*li_ailp;	/* ptr to AIL */
37  	uint				li_type;	/* item type */
38  	unsigned long			li_flags;	/* misc flags */
39  	struct xfs_buf			*li_buf;	/* real buffer pointer */
40  	struct list_head		li_bio_list;	/* buffer item list */
41  	const struct xfs_item_ops	*li_ops;	/* function list */
42  
43  	/* delayed logging */
44  	struct list_head		li_cil;		/* CIL pointers */
45  	struct xfs_log_vec		*li_lv;		/* active log vector */
46  	struct xfs_log_vec		*li_lv_shadow;	/* standby vector */
47  	xfs_csn_t			li_seq;		/* CIL commit seq */
48  	uint32_t			li_order_id;	/* CIL commit order */
49  };
50  
51  /*
52   * li_flags use the (set/test/clear)_bit atomic interfaces because updates can
53   * race with each other and we don't want to have to use the AIL lock to
54   * serialise all updates.
55   */
56  #define	XFS_LI_IN_AIL	0
57  #define	XFS_LI_ABORTED	1
58  #define	XFS_LI_FAILED	2
59  #define	XFS_LI_DIRTY	3
60  #define	XFS_LI_WHITEOUT	4
61  
62  #define XFS_LI_FLAGS \
63  	{ (1u << XFS_LI_IN_AIL),	"IN_AIL" }, \
64  	{ (1u << XFS_LI_ABORTED),	"ABORTED" }, \
65  	{ (1u << XFS_LI_FAILED),	"FAILED" }, \
66  	{ (1u << XFS_LI_DIRTY),		"DIRTY" }, \
67  	{ (1u << XFS_LI_WHITEOUT),	"WHITEOUT" }
68  
69  struct xfs_defer_pending;
70  
71  struct xfs_item_ops {
72  	unsigned flags;
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  	uint64_t (*iop_sort)(struct xfs_log_item *lip);
78  	int (*iop_precommit)(struct xfs_trans *tp, struct xfs_log_item *lip);
79  	void (*iop_committing)(struct xfs_log_item *lip, xfs_csn_t seq);
80  	xfs_lsn_t (*iop_committed)(struct xfs_log_item *, xfs_lsn_t);
81  	uint (*iop_push)(struct xfs_log_item *, struct list_head *);
82  	void (*iop_release)(struct xfs_log_item *);
83  	int (*iop_recover)(struct xfs_defer_pending *dfp,
84  			   struct list_head *capture_list);
85  	bool (*iop_match)(struct xfs_log_item *item, uint64_t id);
86  	struct xfs_log_item *(*iop_relog)(struct xfs_log_item *intent,
87  			struct xfs_trans *tp);
88  	struct xfs_log_item *(*iop_intent)(struct xfs_log_item *intent_done);
89  };
90  
91  /*
92   * Log item ops flags
93   */
94  /*
95   * Release the log item when the journal commits instead of inserting into the
96   * AIL for writeback tracking and/or log tail pinning.
97   */
98  #define XFS_ITEM_RELEASE_WHEN_COMMITTED	(1 << 0)
99  #define XFS_ITEM_INTENT			(1 << 1)
100  #define XFS_ITEM_INTENT_DONE		(1 << 2)
101  
102  static inline bool
xlog_item_is_intent(struct xfs_log_item * lip)103  xlog_item_is_intent(struct xfs_log_item *lip)
104  {
105  	return lip->li_ops->flags & XFS_ITEM_INTENT;
106  }
107  
108  static inline bool
xlog_item_is_intent_done(struct xfs_log_item * lip)109  xlog_item_is_intent_done(struct xfs_log_item *lip)
110  {
111  	return lip->li_ops->flags & XFS_ITEM_INTENT_DONE;
112  }
113  
114  void	xfs_log_item_init(struct xfs_mount *mp, struct xfs_log_item *item,
115  			  int type, const struct xfs_item_ops *ops);
116  
117  /*
118   * Return values for the iop_push() routines.
119   */
120  #define XFS_ITEM_SUCCESS	0
121  #define XFS_ITEM_PINNED		1
122  #define XFS_ITEM_LOCKED		2
123  #define XFS_ITEM_FLUSHING	3
124  
125  /*
126   * This is the structure maintained for every active transaction.
127   */
128  typedef struct xfs_trans {
129  	unsigned int		t_magic;	/* magic number */
130  	unsigned int		t_log_res;	/* amt of log space resvd */
131  	unsigned int		t_log_count;	/* count for perm log res */
132  	unsigned int		t_blk_res;	/* # of blocks resvd */
133  	unsigned int		t_blk_res_used;	/* # of resvd blocks used */
134  	unsigned int		t_rtx_res;	/* # of rt extents resvd */
135  	unsigned int		t_rtx_res_used;	/* # of resvd rt extents used */
136  	unsigned int		t_flags;	/* misc flags */
137  	xfs_agnumber_t		t_highest_agno;	/* highest AGF locked */
138  	struct xlog_ticket	*t_ticket;	/* log mgr ticket */
139  	struct xfs_mount	*t_mountp;	/* ptr to fs mount struct */
140  	struct xfs_dquot_acct   *t_dqinfo;	/* acctg info for dquots */
141  	int64_t			t_icount_delta;	/* superblock icount change */
142  	int64_t			t_ifree_delta;	/* superblock ifree change */
143  	int64_t			t_fdblocks_delta; /* superblock fdblocks chg */
144  	int64_t			t_res_fdblocks_delta; /* on-disk only chg */
145  	int64_t			t_frextents_delta;/* superblock freextents chg*/
146  	int64_t			t_res_frextents_delta; /* on-disk only chg */
147  	int64_t			t_dblocks_delta;/* superblock dblocks change */
148  	int64_t			t_agcount_delta;/* superblock agcount change */
149  	int64_t			t_imaxpct_delta;/* superblock imaxpct change */
150  	int64_t			t_rextsize_delta;/* superblock rextsize chg */
151  	int64_t			t_rbmblocks_delta;/* superblock rbmblocks chg */
152  	int64_t			t_rblocks_delta;/* superblock rblocks change */
153  	int64_t			t_rextents_delta;/* superblocks rextents chg */
154  	int64_t			t_rextslog_delta;/* superblocks rextslog chg */
155  	struct list_head	t_items;	/* log item descriptors */
156  	struct list_head	t_busy;		/* list of busy extents */
157  	struct list_head	t_dfops;	/* deferred operations */
158  	unsigned long		t_pflags;	/* saved process flags state */
159  } xfs_trans_t;
160  
161  /*
162   * XFS transaction mechanism exported interfaces that are
163   * actually macros.
164   */
165  #define	xfs_trans_set_sync(tp)		((tp)->t_flags |= XFS_TRANS_SYNC)
166  
167  /*
168   * XFS transaction mechanism exported interfaces.
169   */
170  int		xfs_trans_alloc(struct xfs_mount *mp, struct xfs_trans_res *resp,
171  			uint blocks, uint rtextents, uint flags,
172  			struct xfs_trans **tpp);
173  int		xfs_trans_alloc_empty(struct xfs_mount *mp,
174  			struct xfs_trans **tpp);
175  void		xfs_trans_mod_sb(xfs_trans_t *, uint, int64_t);
176  
177  int xfs_trans_get_buf_map(struct xfs_trans *tp, struct xfs_buftarg *target,
178  		struct xfs_buf_map *map, int nmaps, xfs_buf_flags_t flags,
179  		struct xfs_buf **bpp);
180  
181  static inline int
xfs_trans_get_buf(struct xfs_trans * tp,struct xfs_buftarg * target,xfs_daddr_t blkno,int numblks,xfs_buf_flags_t flags,struct xfs_buf ** bpp)182  xfs_trans_get_buf(
183  	struct xfs_trans	*tp,
184  	struct xfs_buftarg	*target,
185  	xfs_daddr_t		blkno,
186  	int			numblks,
187  	xfs_buf_flags_t		flags,
188  	struct xfs_buf		**bpp)
189  {
190  	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
191  	return xfs_trans_get_buf_map(tp, target, &map, 1, flags, bpp);
192  }
193  
194  int		xfs_trans_read_buf_map(struct xfs_mount *mp,
195  				       struct xfs_trans *tp,
196  				       struct xfs_buftarg *target,
197  				       struct xfs_buf_map *map, int nmaps,
198  				       xfs_buf_flags_t flags,
199  				       struct xfs_buf **bpp,
200  				       const struct xfs_buf_ops *ops);
201  
202  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)203  xfs_trans_read_buf(
204  	struct xfs_mount	*mp,
205  	struct xfs_trans	*tp,
206  	struct xfs_buftarg	*target,
207  	xfs_daddr_t		blkno,
208  	int			numblks,
209  	xfs_buf_flags_t		flags,
210  	struct xfs_buf		**bpp,
211  	const struct xfs_buf_ops *ops)
212  {
213  	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
214  	return xfs_trans_read_buf_map(mp, tp, target, &map, 1,
215  				      flags, bpp, ops);
216  }
217  
218  struct xfs_buf	*xfs_trans_getsb(struct xfs_trans *);
219  
220  void		xfs_trans_brelse(xfs_trans_t *, struct xfs_buf *);
221  void		xfs_trans_bjoin(xfs_trans_t *, struct xfs_buf *);
222  void		xfs_trans_bhold(xfs_trans_t *, struct xfs_buf *);
223  void		xfs_trans_bhold_release(xfs_trans_t *, struct xfs_buf *);
224  void		xfs_trans_binval(xfs_trans_t *, struct xfs_buf *);
225  void		xfs_trans_inode_buf(xfs_trans_t *, struct xfs_buf *);
226  void		xfs_trans_stale_inode_buf(xfs_trans_t *, struct xfs_buf *);
227  bool		xfs_trans_ordered_buf(xfs_trans_t *, struct xfs_buf *);
228  void		xfs_trans_dquot_buf(xfs_trans_t *, struct xfs_buf *, uint);
229  void		xfs_trans_inode_alloc_buf(xfs_trans_t *, struct xfs_buf *);
230  void		xfs_trans_ichgtime(struct xfs_trans *, struct xfs_inode *, int);
231  void		xfs_trans_ijoin(struct xfs_trans *, struct xfs_inode *, uint);
232  void		xfs_trans_log_buf(struct xfs_trans *, struct xfs_buf *, uint,
233  				  uint);
234  void		xfs_trans_dirty_buf(struct xfs_trans *, struct xfs_buf *);
235  bool		xfs_trans_buf_is_dirty(struct xfs_buf *bp);
236  void		xfs_trans_log_inode(xfs_trans_t *, struct xfs_inode *, uint);
237  
238  int		xfs_trans_commit(struct xfs_trans *);
239  int		xfs_trans_roll(struct xfs_trans **);
240  int		xfs_trans_roll_inode(struct xfs_trans **, struct xfs_inode *);
241  void		xfs_trans_cancel(xfs_trans_t *);
242  int		xfs_trans_ail_init(struct xfs_mount *);
243  void		xfs_trans_ail_destroy(struct xfs_mount *);
244  
245  void		xfs_trans_buf_set_type(struct xfs_trans *, struct xfs_buf *,
246  				       enum xfs_blft);
247  void		xfs_trans_buf_copy_type(struct xfs_buf *dst_bp,
248  					struct xfs_buf *src_bp);
249  
250  extern struct kmem_cache	*xfs_trans_cache;
251  
252  static inline struct xfs_log_item *
xfs_trans_item_relog(struct xfs_log_item * lip,struct xfs_trans * tp)253  xfs_trans_item_relog(
254  	struct xfs_log_item	*lip,
255  	struct xfs_trans	*tp)
256  {
257  	return lip->li_ops->iop_relog(lip, tp);
258  }
259  
260  struct xfs_dquot;
261  
262  int xfs_trans_alloc_inode(struct xfs_inode *ip, struct xfs_trans_res *resv,
263  		unsigned int dblocks, unsigned int rblocks, bool force,
264  		struct xfs_trans **tpp);
265  int xfs_trans_alloc_icreate(struct xfs_mount *mp, struct xfs_trans_res *resv,
266  		struct xfs_dquot *udqp, struct xfs_dquot *gdqp,
267  		struct xfs_dquot *pdqp, unsigned int dblocks,
268  		struct xfs_trans **tpp);
269  int xfs_trans_alloc_ichange(struct xfs_inode *ip, struct xfs_dquot *udqp,
270  		struct xfs_dquot *gdqp, struct xfs_dquot *pdqp, bool force,
271  		struct xfs_trans **tpp);
272  int xfs_trans_alloc_dir(struct xfs_inode *dp, struct xfs_trans_res *resv,
273  		struct xfs_inode *ip, unsigned int *dblocks,
274  		struct xfs_trans **tpp, int *nospace_error);
275  
276  static inline void
xfs_trans_set_context(struct xfs_trans * tp)277  xfs_trans_set_context(
278  	struct xfs_trans	*tp)
279  {
280  	tp->t_pflags = memalloc_nofs_save();
281  }
282  
283  static inline void
xfs_trans_clear_context(struct xfs_trans * tp)284  xfs_trans_clear_context(
285  	struct xfs_trans	*tp)
286  {
287  	memalloc_nofs_restore(tp->t_pflags);
288  }
289  
290  static inline void
xfs_trans_switch_context(struct xfs_trans * old_tp,struct xfs_trans * new_tp)291  xfs_trans_switch_context(
292  	struct xfs_trans	*old_tp,
293  	struct xfs_trans	*new_tp)
294  {
295  	new_tp->t_pflags = old_tp->t_pflags;
296  	old_tp->t_pflags = 0;
297  }
298  
299  #endif	/* __XFS_TRANS_H__ */
300