Merge remote-tracking branch 'mauro-exp/docbook3' into death-to-docbook
[sfrench/cifs-2.6.git] / fs / btrfs / transaction.h
1 /*
2  * Copyright (C) 2007 Oracle.  All rights reserved.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public
6  * License v2 as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11  * General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public
14  * License along with this program; if not, write to the
15  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
16  * Boston, MA 021110-1307, USA.
17  */
18
19 #ifndef __BTRFS_TRANSACTION__
20 #define __BTRFS_TRANSACTION__
21
22 #include <linux/refcount.h>
23 #include "btrfs_inode.h"
24 #include "delayed-ref.h"
25 #include "ctree.h"
26
27 enum btrfs_trans_state {
28         TRANS_STATE_RUNNING             = 0,
29         TRANS_STATE_BLOCKED             = 1,
30         TRANS_STATE_COMMIT_START        = 2,
31         TRANS_STATE_COMMIT_DOING        = 3,
32         TRANS_STATE_UNBLOCKED           = 4,
33         TRANS_STATE_COMPLETED           = 5,
34         TRANS_STATE_MAX                 = 6,
35 };
36
37 #define BTRFS_TRANS_HAVE_FREE_BGS       0
38 #define BTRFS_TRANS_DIRTY_BG_RUN        1
39 #define BTRFS_TRANS_CACHE_ENOSPC        2
40
41 struct btrfs_transaction {
42         u64 transid;
43         /*
44          * total external writers(USERSPACE/START/ATTACH) in this
45          * transaction, it must be zero before the transaction is
46          * being committed
47          */
48         atomic_t num_extwriters;
49         /*
50          * total writers in this transaction, it must be zero before the
51          * transaction can end
52          */
53         atomic_t num_writers;
54         refcount_t use_count;
55         atomic_t pending_ordered;
56
57         unsigned long flags;
58
59         /* Be protected by fs_info->trans_lock when we want to change it. */
60         enum btrfs_trans_state state;
61         struct list_head list;
62         struct extent_io_tree dirty_pages;
63         unsigned long start_time;
64         wait_queue_head_t writer_wait;
65         wait_queue_head_t commit_wait;
66         wait_queue_head_t pending_wait;
67         struct list_head pending_snapshots;
68         struct list_head pending_chunks;
69         struct list_head switch_commits;
70         struct list_head dirty_bgs;
71         struct list_head io_bgs;
72         struct list_head dropped_roots;
73         u64 num_dirty_bgs;
74
75         /*
76          * we need to make sure block group deletion doesn't race with
77          * free space cache writeout.  This mutex keeps them from stomping
78          * on each other
79          */
80         struct mutex cache_write_mutex;
81         spinlock_t dirty_bgs_lock;
82         /* Protected by spin lock fs_info->unused_bgs_lock. */
83         struct list_head deleted_bgs;
84         spinlock_t dropped_roots_lock;
85         struct btrfs_delayed_ref_root delayed_refs;
86         int aborted;
87         struct btrfs_fs_info *fs_info;
88 };
89
90 #define __TRANS_FREEZABLE       (1U << 0)
91
92 #define __TRANS_USERSPACE       (1U << 8)
93 #define __TRANS_START           (1U << 9)
94 #define __TRANS_ATTACH          (1U << 10)
95 #define __TRANS_JOIN            (1U << 11)
96 #define __TRANS_JOIN_NOLOCK     (1U << 12)
97 #define __TRANS_DUMMY           (1U << 13)
98
99 #define TRANS_USERSPACE         (__TRANS_USERSPACE | __TRANS_FREEZABLE)
100 #define TRANS_START             (__TRANS_START | __TRANS_FREEZABLE)
101 #define TRANS_ATTACH            (__TRANS_ATTACH)
102 #define TRANS_JOIN              (__TRANS_JOIN | __TRANS_FREEZABLE)
103 #define TRANS_JOIN_NOLOCK       (__TRANS_JOIN_NOLOCK)
104
105 #define TRANS_EXTWRITERS        (__TRANS_USERSPACE | __TRANS_START |    \
106                                  __TRANS_ATTACH)
107
108 #define BTRFS_SEND_TRANS_STUB   ((void *)1)
109
110 struct btrfs_trans_handle {
111         u64 transid;
112         u64 bytes_reserved;
113         u64 chunk_bytes_reserved;
114         unsigned long use_count;
115         unsigned long blocks_reserved;
116         unsigned long delayed_ref_updates;
117         struct btrfs_transaction *transaction;
118         struct btrfs_block_rsv *block_rsv;
119         struct btrfs_block_rsv *orig_rsv;
120         short aborted;
121         short adding_csums;
122         bool allocating_chunk;
123         bool can_flush_pending_bgs;
124         bool reloc_reserved;
125         bool sync;
126         bool dirty;
127         unsigned int type;
128         struct btrfs_root *root;
129         struct btrfs_fs_info *fs_info;
130         struct list_head new_bgs;
131 };
132
133 struct btrfs_pending_snapshot {
134         struct dentry *dentry;
135         struct inode *dir;
136         struct btrfs_root *root;
137         struct btrfs_root_item *root_item;
138         struct btrfs_root *snap;
139         struct btrfs_qgroup_inherit *inherit;
140         struct btrfs_path *path;
141         /* block reservation for the operation */
142         struct btrfs_block_rsv block_rsv;
143         u64 qgroup_reserved;
144         /* extra metadata reservation for relocation */
145         int error;
146         bool readonly;
147         struct list_head list;
148 };
149
150 static inline void btrfs_set_inode_last_trans(struct btrfs_trans_handle *trans,
151                                               struct inode *inode)
152 {
153         spin_lock(&BTRFS_I(inode)->lock);
154         BTRFS_I(inode)->last_trans = trans->transaction->transid;
155         BTRFS_I(inode)->last_sub_trans = BTRFS_I(inode)->root->log_transid;
156         BTRFS_I(inode)->last_log_commit = BTRFS_I(inode)->root->last_log_commit;
157         spin_unlock(&BTRFS_I(inode)->lock);
158 }
159
160 /*
161  * Make qgroup codes to skip given qgroupid, means the old/new_roots for
162  * qgroup won't contain the qgroupid in it.
163  */
164 static inline void btrfs_set_skip_qgroup(struct btrfs_trans_handle *trans,
165                                          u64 qgroupid)
166 {
167         struct btrfs_delayed_ref_root *delayed_refs;
168
169         delayed_refs = &trans->transaction->delayed_refs;
170         WARN_ON(delayed_refs->qgroup_to_skip);
171         delayed_refs->qgroup_to_skip = qgroupid;
172 }
173
174 static inline void btrfs_clear_skip_qgroup(struct btrfs_trans_handle *trans)
175 {
176         struct btrfs_delayed_ref_root *delayed_refs;
177
178         delayed_refs = &trans->transaction->delayed_refs;
179         WARN_ON(!delayed_refs->qgroup_to_skip);
180         delayed_refs->qgroup_to_skip = 0;
181 }
182
183 int btrfs_end_transaction(struct btrfs_trans_handle *trans);
184 struct btrfs_trans_handle *btrfs_start_transaction(struct btrfs_root *root,
185                                                    unsigned int num_items);
186 struct btrfs_trans_handle *btrfs_start_transaction_fallback_global_rsv(
187                                         struct btrfs_root *root,
188                                         unsigned int num_items,
189                                         int min_factor);
190 struct btrfs_trans_handle *btrfs_start_transaction_lflush(
191                                         struct btrfs_root *root,
192                                         unsigned int num_items);
193 struct btrfs_trans_handle *btrfs_join_transaction(struct btrfs_root *root);
194 struct btrfs_trans_handle *btrfs_join_transaction_nolock(struct btrfs_root *root);
195 struct btrfs_trans_handle *btrfs_attach_transaction(struct btrfs_root *root);
196 struct btrfs_trans_handle *btrfs_attach_transaction_barrier(
197                                         struct btrfs_root *root);
198 struct btrfs_trans_handle *btrfs_start_ioctl_transaction(struct btrfs_root *root);
199 int btrfs_wait_for_commit(struct btrfs_fs_info *fs_info, u64 transid);
200
201 void btrfs_add_dead_root(struct btrfs_root *root);
202 int btrfs_defrag_root(struct btrfs_root *root);
203 int btrfs_clean_one_deleted_snapshot(struct btrfs_root *root);
204 int btrfs_commit_transaction(struct btrfs_trans_handle *trans);
205 int btrfs_commit_transaction_async(struct btrfs_trans_handle *trans,
206                                    int wait_for_unblock);
207 int btrfs_end_transaction_throttle(struct btrfs_trans_handle *trans);
208 int btrfs_should_end_transaction(struct btrfs_trans_handle *trans);
209 void btrfs_throttle(struct btrfs_fs_info *fs_info);
210 int btrfs_record_root_in_trans(struct btrfs_trans_handle *trans,
211                                 struct btrfs_root *root);
212 int btrfs_write_marked_extents(struct btrfs_fs_info *fs_info,
213                                 struct extent_io_tree *dirty_pages, int mark);
214 int btrfs_wait_extents(struct btrfs_fs_info *fs_info,
215                        struct extent_io_tree *dirty_pages);
216 int btrfs_wait_tree_log_extents(struct btrfs_root *root, int mark);
217 int btrfs_transaction_blocked(struct btrfs_fs_info *info);
218 int btrfs_transaction_in_commit(struct btrfs_fs_info *info);
219 void btrfs_put_transaction(struct btrfs_transaction *transaction);
220 void btrfs_apply_pending_changes(struct btrfs_fs_info *fs_info);
221 void btrfs_add_dropped_root(struct btrfs_trans_handle *trans,
222                             struct btrfs_root *root);
223 #endif