Documentation: Docbook: Fix files location change of kernel/[hr]timer.c
[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 #include "btrfs_inode.h"
22 #include "delayed-ref.h"
23 #include "ctree.h"
24
25 enum btrfs_trans_state {
26         TRANS_STATE_RUNNING             = 0,
27         TRANS_STATE_BLOCKED             = 1,
28         TRANS_STATE_COMMIT_START        = 2,
29         TRANS_STATE_COMMIT_DOING        = 3,
30         TRANS_STATE_UNBLOCKED           = 4,
31         TRANS_STATE_COMPLETED           = 5,
32         TRANS_STATE_MAX                 = 6,
33 };
34
35 struct btrfs_transaction {
36         u64 transid;
37         /*
38          * total external writers(USERSPACE/START/ATTACH) in this
39          * transaction, it must be zero before the transaction is
40          * being committed
41          */
42         atomic_t num_extwriters;
43         /*
44          * total writers in this transaction, it must be zero before the
45          * transaction can end
46          */
47         atomic_t num_writers;
48         atomic_t use_count;
49
50         /* Be protected by fs_info->trans_lock when we want to change it. */
51         enum btrfs_trans_state state;
52         struct list_head list;
53         struct extent_io_tree dirty_pages;
54         unsigned long start_time;
55         wait_queue_head_t writer_wait;
56         wait_queue_head_t commit_wait;
57         struct list_head pending_snapshots;
58         struct list_head ordered_operations;
59         struct list_head pending_chunks;
60         struct list_head switch_commits;
61         struct btrfs_delayed_ref_root delayed_refs;
62         int aborted;
63 };
64
65 #define __TRANS_FREEZABLE       (1U << 0)
66
67 #define __TRANS_USERSPACE       (1U << 8)
68 #define __TRANS_START           (1U << 9)
69 #define __TRANS_ATTACH          (1U << 10)
70 #define __TRANS_JOIN            (1U << 11)
71 #define __TRANS_JOIN_NOLOCK     (1U << 12)
72
73 #define TRANS_USERSPACE         (__TRANS_USERSPACE | __TRANS_FREEZABLE)
74 #define TRANS_START             (__TRANS_START | __TRANS_FREEZABLE)
75 #define TRANS_ATTACH            (__TRANS_ATTACH)
76 #define TRANS_JOIN              (__TRANS_JOIN | __TRANS_FREEZABLE)
77 #define TRANS_JOIN_NOLOCK       (__TRANS_JOIN_NOLOCK)
78
79 #define TRANS_EXTWRITERS        (__TRANS_USERSPACE | __TRANS_START |    \
80                                  __TRANS_ATTACH)
81
82 #define BTRFS_SEND_TRANS_STUB   1
83
84 struct btrfs_trans_handle {
85         u64 transid;
86         u64 bytes_reserved;
87         u64 qgroup_reserved;
88         unsigned long use_count;
89         unsigned long blocks_reserved;
90         unsigned long blocks_used;
91         unsigned long delayed_ref_updates;
92         struct btrfs_transaction *transaction;
93         struct btrfs_block_rsv *block_rsv;
94         struct btrfs_block_rsv *orig_rsv;
95         short aborted;
96         short adding_csums;
97         bool allocating_chunk;
98         bool reloc_reserved;
99         bool sync;
100         unsigned int type;
101         /*
102          * this root is only needed to validate that the root passed to
103          * start_transaction is the same as the one passed to end_transaction.
104          * Subvolume quota depends on this
105          */
106         struct btrfs_root *root;
107         struct seq_list delayed_ref_elem;
108         struct list_head qgroup_ref_list;
109         struct list_head new_bgs;
110 };
111
112 struct btrfs_pending_snapshot {
113         struct dentry *dentry;
114         struct inode *dir;
115         struct btrfs_root *root;
116         struct btrfs_root *snap;
117         struct btrfs_qgroup_inherit *inherit;
118         /* block reservation for the operation */
119         struct btrfs_block_rsv block_rsv;
120         u64 qgroup_reserved;
121         /* extra metadata reseration for relocation */
122         int error;
123         bool readonly;
124         struct list_head list;
125 };
126
127 static inline void btrfs_set_inode_last_trans(struct btrfs_trans_handle *trans,
128                                               struct inode *inode)
129 {
130         BTRFS_I(inode)->last_trans = trans->transaction->transid;
131         BTRFS_I(inode)->last_sub_trans = BTRFS_I(inode)->root->log_transid;
132         BTRFS_I(inode)->last_log_commit = BTRFS_I(inode)->root->last_log_commit;
133 }
134
135 int btrfs_end_transaction(struct btrfs_trans_handle *trans,
136                           struct btrfs_root *root);
137 struct btrfs_trans_handle *btrfs_start_transaction(struct btrfs_root *root,
138                                                    int num_items);
139 struct btrfs_trans_handle *btrfs_start_transaction_lflush(
140                                         struct btrfs_root *root, int num_items);
141 struct btrfs_trans_handle *btrfs_join_transaction(struct btrfs_root *root);
142 struct btrfs_trans_handle *btrfs_join_transaction_nolock(struct btrfs_root *root);
143 struct btrfs_trans_handle *btrfs_attach_transaction(struct btrfs_root *root);
144 struct btrfs_trans_handle *btrfs_attach_transaction_barrier(
145                                         struct btrfs_root *root);
146 struct btrfs_trans_handle *btrfs_start_ioctl_transaction(struct btrfs_root *root);
147 int btrfs_wait_for_commit(struct btrfs_root *root, u64 transid);
148 int btrfs_write_and_wait_transaction(struct btrfs_trans_handle *trans,
149                                      struct btrfs_root *root);
150
151 void btrfs_add_dead_root(struct btrfs_root *root);
152 int btrfs_defrag_root(struct btrfs_root *root);
153 int btrfs_clean_one_deleted_snapshot(struct btrfs_root *root);
154 int btrfs_commit_transaction(struct btrfs_trans_handle *trans,
155                              struct btrfs_root *root);
156 int btrfs_commit_transaction_async(struct btrfs_trans_handle *trans,
157                                    struct btrfs_root *root,
158                                    int wait_for_unblock);
159 int btrfs_end_transaction_throttle(struct btrfs_trans_handle *trans,
160                                    struct btrfs_root *root);
161 int btrfs_should_end_transaction(struct btrfs_trans_handle *trans,
162                                  struct btrfs_root *root);
163 void btrfs_throttle(struct btrfs_root *root);
164 int btrfs_record_root_in_trans(struct btrfs_trans_handle *trans,
165                                 struct btrfs_root *root);
166 int btrfs_write_marked_extents(struct btrfs_root *root,
167                                 struct extent_io_tree *dirty_pages, int mark);
168 int btrfs_wait_marked_extents(struct btrfs_root *root,
169                                 struct extent_io_tree *dirty_pages, int mark);
170 int btrfs_transaction_blocked(struct btrfs_fs_info *info);
171 int btrfs_transaction_in_commit(struct btrfs_fs_info *info);
172 void btrfs_put_transaction(struct btrfs_transaction *transaction);
173 #endif