xref: /openbmc/linux/fs/xfs/xfs_trans_priv.h (revision c059ee9d)
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_PRIV_H__
7 #define	__XFS_TRANS_PRIV_H__
8 
9 struct xlog;
10 struct xfs_log_item;
11 struct xfs_mount;
12 struct xfs_trans;
13 struct xfs_ail;
14 struct xfs_log_vec;
15 
16 
17 void	xfs_trans_init(struct xfs_mount *);
18 void	xfs_trans_add_item(struct xfs_trans *, struct xfs_log_item *);
19 void	xfs_trans_del_item(struct xfs_log_item *);
20 void	xfs_trans_unreserve_and_mod_sb(struct xfs_trans *tp);
21 
22 void	xfs_trans_committed_bulk(struct xfs_ail *ailp, struct xfs_log_vec *lv,
23 				xfs_lsn_t commit_lsn, bool aborted);
24 /*
25  * AIL traversal cursor.
26  *
27  * Rather than using a generation number for detecting changes in the ail, use
28  * a cursor that is protected by the ail lock. The aild cursor exists in the
29  * struct xfs_ail, but other traversals can declare it on the stack and link it
30  * to the ail list.
31  *
32  * When an object is deleted from or moved int the AIL, the cursor list is
33  * searched to see if the object is a designated cursor item. If it is, it is
34  * deleted from the cursor so that the next time the cursor is used traversal
35  * will return to the start.
36  *
37  * This means a traversal colliding with a removal will cause a restart of the
38  * list scan, rather than any insertion or deletion anywhere in the list. The
39  * low bit of the item pointer is set if the cursor has been invalidated so
40  * that we can tell the difference between invalidation and reaching the end
41  * of the list to trigger traversal restarts.
42  */
43 struct xfs_ail_cursor {
44 	struct list_head	list;
45 	struct xfs_log_item	*item;
46 };
47 
48 /*
49  * Private AIL structures.
50  *
51  * Eventually we need to drive the locking in here as well.
52  */
53 struct xfs_ail {
54 	struct xlog		*ail_log;
55 	struct task_struct	*ail_task;
56 	struct list_head	ail_head;
57 	xfs_lsn_t		ail_target;
58 	xfs_lsn_t		ail_target_prev;
59 	struct list_head	ail_cursors;
60 	spinlock_t		ail_lock;
61 	xfs_lsn_t		ail_last_pushed_lsn;
62 	int			ail_log_flush;
63 	struct list_head	ail_buf_list;
64 	wait_queue_head_t	ail_empty;
65 };
66 
67 /*
68  * From xfs_trans_ail.c
69  */
70 void	xfs_trans_ail_update_bulk(struct xfs_ail *ailp,
71 				struct xfs_ail_cursor *cur,
72 				struct xfs_log_item **log_items, int nr_items,
73 				xfs_lsn_t lsn) __releases(ailp->ail_lock);
74 /*
75  * Return a pointer to the first item in the AIL.  If the AIL is empty, then
76  * return NULL.
77  */
78 static inline struct xfs_log_item *
79 xfs_ail_min(
80 	struct xfs_ail  *ailp)
81 {
82 	return list_first_entry_or_null(&ailp->ail_head, struct xfs_log_item,
83 					li_ail);
84 }
85 
86 static inline void
87 xfs_trans_ail_update(
88 	struct xfs_ail		*ailp,
89 	struct xfs_log_item	*lip,
90 	xfs_lsn_t		lsn) __releases(ailp->ail_lock)
91 {
92 	xfs_trans_ail_update_bulk(ailp, NULL, &lip, 1, lsn);
93 }
94 
95 void xfs_trans_ail_insert(struct xfs_ail *ailp, struct xfs_log_item *lip,
96 		xfs_lsn_t lsn);
97 
98 xfs_lsn_t xfs_ail_delete_one(struct xfs_ail *ailp, struct xfs_log_item *lip);
99 void xfs_ail_update_finish(struct xfs_ail *ailp, xfs_lsn_t old_lsn)
100 			__releases(ailp->ail_lock);
101 void xfs_trans_ail_delete(struct xfs_log_item *lip, int shutdown_type);
102 
103 void			xfs_ail_push(struct xfs_ail *, xfs_lsn_t);
104 void			xfs_ail_push_all(struct xfs_ail *);
105 void			xfs_ail_push_all_sync(struct xfs_ail *);
106 struct xfs_log_item	*xfs_ail_min(struct xfs_ail  *ailp);
107 xfs_lsn_t		xfs_ail_min_lsn(struct xfs_ail *ailp);
108 
109 struct xfs_log_item *	xfs_trans_ail_cursor_first(struct xfs_ail *ailp,
110 					struct xfs_ail_cursor *cur,
111 					xfs_lsn_t lsn);
112 struct xfs_log_item *	xfs_trans_ail_cursor_last(struct xfs_ail *ailp,
113 					struct xfs_ail_cursor *cur,
114 					xfs_lsn_t lsn);
115 struct xfs_log_item *	xfs_trans_ail_cursor_next(struct xfs_ail *ailp,
116 					struct xfs_ail_cursor *cur);
117 void			xfs_trans_ail_cursor_done(struct xfs_ail_cursor *cur);
118 
119 #if BITS_PER_LONG != 64
120 static inline void
121 xfs_trans_ail_copy_lsn(
122 	struct xfs_ail	*ailp,
123 	xfs_lsn_t	*dst,
124 	xfs_lsn_t	*src)
125 {
126 	ASSERT(sizeof(xfs_lsn_t) == 8);	/* don't lock if it shrinks */
127 	spin_lock(&ailp->ail_lock);
128 	*dst = *src;
129 	spin_unlock(&ailp->ail_lock);
130 }
131 #else
132 static inline void
133 xfs_trans_ail_copy_lsn(
134 	struct xfs_ail	*ailp,
135 	xfs_lsn_t	*dst,
136 	xfs_lsn_t	*src)
137 {
138 	ASSERT(sizeof(xfs_lsn_t) == 8);
139 	*dst = *src;
140 }
141 #endif
142 
143 static inline void
144 xfs_clear_li_failed(
145 	struct xfs_log_item	*lip)
146 {
147 	struct xfs_buf	*bp = lip->li_buf;
148 
149 	ASSERT(test_bit(XFS_LI_IN_AIL, &lip->li_flags));
150 	lockdep_assert_held(&lip->li_ailp->ail_lock);
151 
152 	if (test_and_clear_bit(XFS_LI_FAILED, &lip->li_flags)) {
153 		lip->li_buf = NULL;
154 		xfs_buf_rele(bp);
155 	}
156 }
157 
158 static inline void
159 xfs_set_li_failed(
160 	struct xfs_log_item	*lip,
161 	struct xfs_buf		*bp)
162 {
163 	lockdep_assert_held(&lip->li_ailp->ail_lock);
164 
165 	if (!test_and_set_bit(XFS_LI_FAILED, &lip->li_flags)) {
166 		xfs_buf_hold(bp);
167 		lip->li_buf = bp;
168 	}
169 }
170 
171 #endif	/* __XFS_TRANS_PRIV_H__ */
172