xref: /openbmc/linux/fs/xfs/xfs_trans_priv.h (revision cd5d5810)
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 int	xfs_trans_roll(struct xfs_trans **, struct xfs_inode *);
31 void	xfs_trans_add_item(struct xfs_trans *, struct xfs_log_item *);
32 void	xfs_trans_del_item(struct xfs_log_item *);
33 void	xfs_trans_free_items(struct xfs_trans *tp, xfs_lsn_t commit_lsn,
34 				int flags);
35 void	xfs_trans_unreserve_and_mod_sb(struct xfs_trans *tp);
36 
37 void	xfs_trans_committed_bulk(struct xfs_ail *ailp, struct xfs_log_vec *lv,
38 				xfs_lsn_t commit_lsn, int aborted);
39 /*
40  * AIL traversal cursor.
41  *
42  * Rather than using a generation number for detecting changes in the ail, use
43  * a cursor that is protected by the ail lock. The aild cursor exists in the
44  * struct xfs_ail, but other traversals can declare it on the stack and link it
45  * to the ail list.
46  *
47  * When an object is deleted from or moved int the AIL, the cursor list is
48  * searched to see if the object is a designated cursor item. If it is, it is
49  * deleted from the cursor so that the next time the cursor is used traversal
50  * will return to the start.
51  *
52  * This means a traversal colliding with a removal will cause a restart of the
53  * list scan, rather than any insertion or deletion anywhere in the list. The
54  * low bit of the item pointer is set if the cursor has been invalidated so
55  * that we can tell the difference between invalidation and reaching the end
56  * of the list to trigger traversal restarts.
57  */
58 struct xfs_ail_cursor {
59 	struct list_head	list;
60 	struct xfs_log_item	*item;
61 };
62 
63 /*
64  * Private AIL structures.
65  *
66  * Eventually we need to drive the locking in here as well.
67  */
68 struct xfs_ail {
69 	struct xfs_mount	*xa_mount;
70 	struct task_struct	*xa_task;
71 	struct list_head	xa_ail;
72 	xfs_lsn_t		xa_target;
73 	xfs_lsn_t		xa_target_prev;
74 	struct list_head	xa_cursors;
75 	spinlock_t		xa_lock;
76 	xfs_lsn_t		xa_last_pushed_lsn;
77 	int			xa_log_flush;
78 	struct list_head	xa_buf_list;
79 	wait_queue_head_t	xa_empty;
80 };
81 
82 /*
83  * From xfs_trans_ail.c
84  */
85 void	xfs_trans_ail_update_bulk(struct xfs_ail *ailp,
86 				struct xfs_ail_cursor *cur,
87 				struct xfs_log_item **log_items, int nr_items,
88 				xfs_lsn_t lsn) __releases(ailp->xa_lock);
89 /*
90  * Return a pointer to the first item in the AIL.  If the AIL is empty, then
91  * return NULL.
92  */
93 static inline struct xfs_log_item *
94 xfs_ail_min(
95 	struct xfs_ail  *ailp)
96 {
97 	return list_first_entry_or_null(&ailp->xa_ail, struct xfs_log_item,
98 					li_ail);
99 }
100 
101 static inline void
102 xfs_trans_ail_update(
103 	struct xfs_ail		*ailp,
104 	struct xfs_log_item	*lip,
105 	xfs_lsn_t		lsn) __releases(ailp->xa_lock)
106 {
107 	xfs_trans_ail_update_bulk(ailp, NULL, &lip, 1, lsn);
108 }
109 
110 void	xfs_trans_ail_delete_bulk(struct xfs_ail *ailp,
111 				struct xfs_log_item **log_items, int nr_items,
112 				int shutdown_type)
113 				__releases(ailp->xa_lock);
114 static inline void
115 xfs_trans_ail_delete(
116 	struct xfs_ail	*ailp,
117 	xfs_log_item_t	*lip,
118 	int		shutdown_type) __releases(ailp->xa_lock)
119 {
120 	xfs_trans_ail_delete_bulk(ailp, &lip, 1, shutdown_type);
121 }
122 
123 void			xfs_ail_push(struct xfs_ail *, xfs_lsn_t);
124 void			xfs_ail_push_all(struct xfs_ail *);
125 void			xfs_ail_push_all_sync(struct xfs_ail *);
126 struct xfs_log_item	*xfs_ail_min(struct xfs_ail  *ailp);
127 xfs_lsn_t		xfs_ail_min_lsn(struct xfs_ail *ailp);
128 
129 struct xfs_log_item *	xfs_trans_ail_cursor_first(struct xfs_ail *ailp,
130 					struct xfs_ail_cursor *cur,
131 					xfs_lsn_t lsn);
132 struct xfs_log_item *	xfs_trans_ail_cursor_last(struct xfs_ail *ailp,
133 					struct xfs_ail_cursor *cur,
134 					xfs_lsn_t lsn);
135 struct xfs_log_item *	xfs_trans_ail_cursor_next(struct xfs_ail *ailp,
136 					struct xfs_ail_cursor *cur);
137 void			xfs_trans_ail_cursor_done(struct xfs_ail *ailp,
138 					struct xfs_ail_cursor *cur);
139 
140 #if BITS_PER_LONG != 64
141 static inline void
142 xfs_trans_ail_copy_lsn(
143 	struct xfs_ail	*ailp,
144 	xfs_lsn_t	*dst,
145 	xfs_lsn_t	*src)
146 {
147 	ASSERT(sizeof(xfs_lsn_t) == 8);	/* don't lock if it shrinks */
148 	spin_lock(&ailp->xa_lock);
149 	*dst = *src;
150 	spin_unlock(&ailp->xa_lock);
151 }
152 #else
153 static inline void
154 xfs_trans_ail_copy_lsn(
155 	struct xfs_ail	*ailp,
156 	xfs_lsn_t	*dst,
157 	xfs_lsn_t	*src)
158 {
159 	ASSERT(sizeof(xfs_lsn_t) == 8);
160 	*dst = *src;
161 }
162 #endif
163 #endif	/* __XFS_TRANS_PRIV_H__ */
164