xref: /openbmc/linux/fs/xfs/xfs_trans_priv.h (revision 92b19ff5)
1 /*
2  * Copyright (c) 2000,2002,2005 Silicon Graphics, Inc.
3  * All Rights Reserved.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License as
7  * published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it would be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write the Free Software Foundation,
16  * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17  */
18 #ifndef __XFS_TRANS_PRIV_H__
19 #define	__XFS_TRANS_PRIV_H__
20 
21 struct xfs_log_item;
22 struct xfs_log_item_desc;
23 struct xfs_mount;
24 struct xfs_trans;
25 struct xfs_ail;
26 struct xfs_log_vec;
27 
28 
29 void	xfs_trans_init(struct xfs_mount *);
30 void	xfs_trans_add_item(struct xfs_trans *, struct xfs_log_item *);
31 void	xfs_trans_del_item(struct xfs_log_item *);
32 void	xfs_trans_free_items(struct xfs_trans *tp, xfs_lsn_t commit_lsn,
33 				bool abort);
34 void	xfs_trans_unreserve_and_mod_sb(struct xfs_trans *tp);
35 
36 void	xfs_trans_committed_bulk(struct xfs_ail *ailp, struct xfs_log_vec *lv,
37 				xfs_lsn_t commit_lsn, int aborted);
38 /*
39  * AIL traversal cursor.
40  *
41  * Rather than using a generation number for detecting changes in the ail, use
42  * a cursor that is protected by the ail lock. The aild cursor exists in the
43  * struct xfs_ail, but other traversals can declare it on the stack and link it
44  * to the ail list.
45  *
46  * When an object is deleted from or moved int the AIL, the cursor list is
47  * searched to see if the object is a designated cursor item. If it is, it is
48  * deleted from the cursor so that the next time the cursor is used traversal
49  * will return to the start.
50  *
51  * This means a traversal colliding with a removal will cause a restart of the
52  * list scan, rather than any insertion or deletion anywhere in the list. The
53  * low bit of the item pointer is set if the cursor has been invalidated so
54  * that we can tell the difference between invalidation and reaching the end
55  * of the list to trigger traversal restarts.
56  */
57 struct xfs_ail_cursor {
58 	struct list_head	list;
59 	struct xfs_log_item	*item;
60 };
61 
62 /*
63  * Private AIL structures.
64  *
65  * Eventually we need to drive the locking in here as well.
66  */
67 struct xfs_ail {
68 	struct xfs_mount	*xa_mount;
69 	struct task_struct	*xa_task;
70 	struct list_head	xa_ail;
71 	xfs_lsn_t		xa_target;
72 	xfs_lsn_t		xa_target_prev;
73 	struct list_head	xa_cursors;
74 	spinlock_t		xa_lock;
75 	xfs_lsn_t		xa_last_pushed_lsn;
76 	int			xa_log_flush;
77 	struct list_head	xa_buf_list;
78 	wait_queue_head_t	xa_empty;
79 };
80 
81 /*
82  * From xfs_trans_ail.c
83  */
84 void	xfs_trans_ail_update_bulk(struct xfs_ail *ailp,
85 				struct xfs_ail_cursor *cur,
86 				struct xfs_log_item **log_items, int nr_items,
87 				xfs_lsn_t lsn) __releases(ailp->xa_lock);
88 /*
89  * Return a pointer to the first item in the AIL.  If the AIL is empty, then
90  * return NULL.
91  */
92 static inline struct xfs_log_item *
93 xfs_ail_min(
94 	struct xfs_ail  *ailp)
95 {
96 	return list_first_entry_or_null(&ailp->xa_ail, struct xfs_log_item,
97 					li_ail);
98 }
99 
100 static inline void
101 xfs_trans_ail_update(
102 	struct xfs_ail		*ailp,
103 	struct xfs_log_item	*lip,
104 	xfs_lsn_t		lsn) __releases(ailp->xa_lock)
105 {
106 	xfs_trans_ail_update_bulk(ailp, NULL, &lip, 1, lsn);
107 }
108 
109 void	xfs_trans_ail_delete_bulk(struct xfs_ail *ailp,
110 				struct xfs_log_item **log_items, int nr_items,
111 				int shutdown_type)
112 				__releases(ailp->xa_lock);
113 static inline void
114 xfs_trans_ail_delete(
115 	struct xfs_ail	*ailp,
116 	xfs_log_item_t	*lip,
117 	int		shutdown_type) __releases(ailp->xa_lock)
118 {
119 	xfs_trans_ail_delete_bulk(ailp, &lip, 1, shutdown_type);
120 }
121 
122 void			xfs_ail_push(struct xfs_ail *, xfs_lsn_t);
123 void			xfs_ail_push_all(struct xfs_ail *);
124 void			xfs_ail_push_all_sync(struct xfs_ail *);
125 struct xfs_log_item	*xfs_ail_min(struct xfs_ail  *ailp);
126 xfs_lsn_t		xfs_ail_min_lsn(struct xfs_ail *ailp);
127 
128 struct xfs_log_item *	xfs_trans_ail_cursor_first(struct xfs_ail *ailp,
129 					struct xfs_ail_cursor *cur,
130 					xfs_lsn_t lsn);
131 struct xfs_log_item *	xfs_trans_ail_cursor_last(struct xfs_ail *ailp,
132 					struct xfs_ail_cursor *cur,
133 					xfs_lsn_t lsn);
134 struct xfs_log_item *	xfs_trans_ail_cursor_next(struct xfs_ail *ailp,
135 					struct xfs_ail_cursor *cur);
136 void			xfs_trans_ail_cursor_done(struct xfs_ail_cursor *cur);
137 
138 #if BITS_PER_LONG != 64
139 static inline void
140 xfs_trans_ail_copy_lsn(
141 	struct xfs_ail	*ailp,
142 	xfs_lsn_t	*dst,
143 	xfs_lsn_t	*src)
144 {
145 	ASSERT(sizeof(xfs_lsn_t) == 8);	/* don't lock if it shrinks */
146 	spin_lock(&ailp->xa_lock);
147 	*dst = *src;
148 	spin_unlock(&ailp->xa_lock);
149 }
150 #else
151 static inline void
152 xfs_trans_ail_copy_lsn(
153 	struct xfs_ail	*ailp,
154 	xfs_lsn_t	*dst,
155 	xfs_lsn_t	*src)
156 {
157 	ASSERT(sizeof(xfs_lsn_t) == 8);
158 	*dst = *src;
159 }
160 #endif
161 #endif	/* __XFS_TRANS_PRIV_H__ */
162