Loading...
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
25enum 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#define BTRFS_TRANS_HAVE_FREE_BGS 0
36#define BTRFS_TRANS_DIRTY_BG_RUN 1
37#define BTRFS_TRANS_CACHE_ENOSPC 2
38
39struct btrfs_transaction {
40 u64 transid;
41 /*
42 * total external writers(USERSPACE/START/ATTACH) in this
43 * transaction, it must be zero before the transaction is
44 * being committed
45 */
46 atomic_t num_extwriters;
47 /*
48 * total writers in this transaction, it must be zero before the
49 * transaction can end
50 */
51 atomic_t num_writers;
52 atomic_t use_count;
53 atomic_t pending_ordered;
54
55 unsigned long flags;
56
57 /* Be protected by fs_info->trans_lock when we want to change it. */
58 enum btrfs_trans_state state;
59 struct list_head list;
60 struct extent_io_tree dirty_pages;
61 unsigned long start_time;
62 wait_queue_head_t writer_wait;
63 wait_queue_head_t commit_wait;
64 wait_queue_head_t pending_wait;
65 struct list_head pending_snapshots;
66 struct list_head pending_chunks;
67 struct list_head switch_commits;
68 struct list_head dirty_bgs;
69 struct list_head io_bgs;
70 struct list_head dropped_roots;
71 u64 num_dirty_bgs;
72
73 /*
74 * we need to make sure block group deletion doesn't race with
75 * free space cache writeout. This mutex keeps them from stomping
76 * on each other
77 */
78 struct mutex cache_write_mutex;
79 spinlock_t dirty_bgs_lock;
80 /* Protected by spin lock fs_info->unused_bgs_lock. */
81 struct list_head deleted_bgs;
82 spinlock_t dropped_roots_lock;
83 struct btrfs_delayed_ref_root delayed_refs;
84 int aborted;
85 struct btrfs_fs_info *fs_info;
86};
87
88#define __TRANS_FREEZABLE (1U << 0)
89
90#define __TRANS_USERSPACE (1U << 8)
91#define __TRANS_START (1U << 9)
92#define __TRANS_ATTACH (1U << 10)
93#define __TRANS_JOIN (1U << 11)
94#define __TRANS_JOIN_NOLOCK (1U << 12)
95#define __TRANS_DUMMY (1U << 13)
96
97#define TRANS_USERSPACE (__TRANS_USERSPACE | __TRANS_FREEZABLE)
98#define TRANS_START (__TRANS_START | __TRANS_FREEZABLE)
99#define TRANS_ATTACH (__TRANS_ATTACH)
100#define TRANS_JOIN (__TRANS_JOIN | __TRANS_FREEZABLE)
101#define TRANS_JOIN_NOLOCK (__TRANS_JOIN_NOLOCK)
102
103#define TRANS_EXTWRITERS (__TRANS_USERSPACE | __TRANS_START | \
104 __TRANS_ATTACH)
105
106#define BTRFS_SEND_TRANS_STUB ((void *)1)
107
108struct btrfs_trans_handle {
109 u64 transid;
110 u64 bytes_reserved;
111 u64 chunk_bytes_reserved;
112 unsigned long use_count;
113 unsigned long blocks_reserved;
114 unsigned long delayed_ref_updates;
115 struct btrfs_transaction *transaction;
116 struct btrfs_block_rsv *block_rsv;
117 struct btrfs_block_rsv *orig_rsv;
118 short aborted;
119 short adding_csums;
120 bool allocating_chunk;
121 bool can_flush_pending_bgs;
122 bool reloc_reserved;
123 bool sync;
124 bool dirty;
125 unsigned int type;
126 struct btrfs_root *root;
127 struct btrfs_fs_info *fs_info;
128 struct seq_list delayed_ref_elem;
129 struct list_head qgroup_ref_list;
130 struct list_head new_bgs;
131};
132
133struct 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
150static 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 */
164static 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
174static 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
183int btrfs_end_transaction(struct btrfs_trans_handle *trans);
184struct btrfs_trans_handle *btrfs_start_transaction(struct btrfs_root *root,
185 unsigned int num_items);
186struct btrfs_trans_handle *btrfs_start_transaction_fallback_global_rsv(
187 struct btrfs_root *root,
188 unsigned int num_items,
189 int min_factor);
190struct btrfs_trans_handle *btrfs_start_transaction_lflush(
191 struct btrfs_root *root,
192 unsigned int num_items);
193struct btrfs_trans_handle *btrfs_join_transaction(struct btrfs_root *root);
194struct btrfs_trans_handle *btrfs_join_transaction_nolock(struct btrfs_root *root);
195struct btrfs_trans_handle *btrfs_attach_transaction(struct btrfs_root *root);
196struct btrfs_trans_handle *btrfs_attach_transaction_barrier(
197 struct btrfs_root *root);
198struct btrfs_trans_handle *btrfs_start_ioctl_transaction(struct btrfs_root *root);
199int btrfs_wait_for_commit(struct btrfs_fs_info *fs_info, u64 transid);
200
201void btrfs_add_dead_root(struct btrfs_root *root);
202int btrfs_defrag_root(struct btrfs_root *root);
203int btrfs_clean_one_deleted_snapshot(struct btrfs_root *root);
204int btrfs_commit_transaction(struct btrfs_trans_handle *trans);
205int btrfs_commit_transaction_async(struct btrfs_trans_handle *trans,
206 int wait_for_unblock);
207int btrfs_end_transaction_throttle(struct btrfs_trans_handle *trans);
208int btrfs_should_end_transaction(struct btrfs_trans_handle *trans);
209void btrfs_throttle(struct btrfs_fs_info *fs_info);
210int btrfs_record_root_in_trans(struct btrfs_trans_handle *trans,
211 struct btrfs_root *root);
212int btrfs_write_marked_extents(struct btrfs_fs_info *fs_info,
213 struct extent_io_tree *dirty_pages, int mark);
214int btrfs_wait_extents(struct btrfs_fs_info *fs_info,
215 struct extent_io_tree *dirty_pages);
216int btrfs_wait_tree_log_extents(struct btrfs_root *root, int mark);
217int btrfs_transaction_blocked(struct btrfs_fs_info *info);
218int btrfs_transaction_in_commit(struct btrfs_fs_info *info);
219void btrfs_put_transaction(struct btrfs_transaction *transaction);
220void btrfs_apply_pending_changes(struct btrfs_fs_info *fs_info);
221void btrfs_add_dropped_root(struct btrfs_trans_handle *trans,
222 struct btrfs_root *root);
223#endif
1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * Copyright (C) 2007 Oracle. All rights reserved.
4 */
5
6#ifndef BTRFS_TRANSACTION_H
7#define BTRFS_TRANSACTION_H
8
9#include <linux/refcount.h>
10#include "btrfs_inode.h"
11#include "delayed-ref.h"
12#include "ctree.h"
13
14enum btrfs_trans_state {
15 TRANS_STATE_RUNNING,
16 TRANS_STATE_COMMIT_START,
17 TRANS_STATE_COMMIT_DOING,
18 TRANS_STATE_UNBLOCKED,
19 TRANS_STATE_COMPLETED,
20 TRANS_STATE_MAX,
21};
22
23#define BTRFS_TRANS_HAVE_FREE_BGS 0
24#define BTRFS_TRANS_DIRTY_BG_RUN 1
25#define BTRFS_TRANS_CACHE_ENOSPC 2
26
27struct btrfs_transaction {
28 u64 transid;
29 /*
30 * total external writers(USERSPACE/START/ATTACH) in this
31 * transaction, it must be zero before the transaction is
32 * being committed
33 */
34 atomic_t num_extwriters;
35 /*
36 * total writers in this transaction, it must be zero before the
37 * transaction can end
38 */
39 atomic_t num_writers;
40 refcount_t use_count;
41
42 unsigned long flags;
43
44 /* Be protected by fs_info->trans_lock when we want to change it. */
45 enum btrfs_trans_state state;
46 int aborted;
47 struct list_head list;
48 struct extent_io_tree dirty_pages;
49 time64_t start_time;
50 wait_queue_head_t writer_wait;
51 wait_queue_head_t commit_wait;
52 struct list_head pending_snapshots;
53 struct list_head dev_update_list;
54 struct list_head switch_commits;
55 struct list_head dirty_bgs;
56
57 /*
58 * There is no explicit lock which protects io_bgs, rather its
59 * consistency is implied by the fact that all the sites which modify
60 * it do so under some form of transaction critical section, namely:
61 *
62 * - btrfs_start_dirty_block_groups - This function can only ever be
63 * run by one of the transaction committers. Refer to
64 * BTRFS_TRANS_DIRTY_BG_RUN usage in btrfs_commit_transaction
65 *
66 * - btrfs_write_dirty_blockgroups - this is called by
67 * commit_cowonly_roots from transaction critical section
68 * (TRANS_STATE_COMMIT_DOING)
69 *
70 * - btrfs_cleanup_dirty_bgs - called on transaction abort
71 */
72 struct list_head io_bgs;
73 struct list_head dropped_roots;
74 struct extent_io_tree pinned_extents;
75
76 /*
77 * we need to make sure block group deletion doesn't race with
78 * free space cache writeout. This mutex keeps them from stomping
79 * on each other
80 */
81 struct mutex cache_write_mutex;
82 spinlock_t dirty_bgs_lock;
83 /* Protected by spin lock fs_info->unused_bgs_lock. */
84 struct list_head deleted_bgs;
85 spinlock_t dropped_roots_lock;
86 struct btrfs_delayed_ref_root delayed_refs;
87 struct btrfs_fs_info *fs_info;
88};
89
90#define __TRANS_FREEZABLE (1U << 0)
91
92#define __TRANS_START (1U << 9)
93#define __TRANS_ATTACH (1U << 10)
94#define __TRANS_JOIN (1U << 11)
95#define __TRANS_JOIN_NOLOCK (1U << 12)
96#define __TRANS_DUMMY (1U << 13)
97#define __TRANS_JOIN_NOSTART (1U << 14)
98
99#define TRANS_START (__TRANS_START | __TRANS_FREEZABLE)
100#define TRANS_ATTACH (__TRANS_ATTACH)
101#define TRANS_JOIN (__TRANS_JOIN | __TRANS_FREEZABLE)
102#define TRANS_JOIN_NOLOCK (__TRANS_JOIN_NOLOCK)
103#define TRANS_JOIN_NOSTART (__TRANS_JOIN_NOSTART)
104
105#define TRANS_EXTWRITERS (__TRANS_START | __TRANS_ATTACH)
106
107#define BTRFS_SEND_TRANS_STUB ((void *)1)
108
109struct btrfs_trans_handle {
110 u64 transid;
111 u64 bytes_reserved;
112 u64 chunk_bytes_reserved;
113 unsigned long delayed_ref_updates;
114 struct btrfs_transaction *transaction;
115 struct btrfs_block_rsv *block_rsv;
116 struct btrfs_block_rsv *orig_rsv;
117 refcount_t use_count;
118 unsigned int type;
119 /*
120 * Error code of transaction abort, set outside of locks and must use
121 * the READ_ONCE/WRITE_ONCE access
122 */
123 short aborted;
124 bool adding_csums;
125 bool allocating_chunk;
126 bool can_flush_pending_bgs;
127 bool reloc_reserved;
128 bool dirty;
129 struct btrfs_root *root;
130 struct btrfs_fs_info *fs_info;
131 struct list_head new_bgs;
132};
133
134/*
135 * The abort status can be changed between calls and is not protected by locks.
136 * This accepts btrfs_transaction and btrfs_trans_handle as types. Once it's
137 * set to a non-zero value it does not change, so the macro should be in checks
138 * but is not necessary for further reads of the value.
139 */
140#define TRANS_ABORTED(trans) (unlikely(READ_ONCE((trans)->aborted)))
141
142struct btrfs_pending_snapshot {
143 struct dentry *dentry;
144 struct inode *dir;
145 struct btrfs_root *root;
146 struct btrfs_root_item *root_item;
147 struct btrfs_root *snap;
148 struct btrfs_qgroup_inherit *inherit;
149 struct btrfs_path *path;
150 /* block reservation for the operation */
151 struct btrfs_block_rsv block_rsv;
152 /* extra metadata reservation for relocation */
153 int error;
154 /* Preallocated anonymous block device number */
155 dev_t anon_dev;
156 bool readonly;
157 struct list_head list;
158};
159
160static inline void btrfs_set_inode_last_trans(struct btrfs_trans_handle *trans,
161 struct btrfs_inode *inode)
162{
163 spin_lock(&inode->lock);
164 inode->last_trans = trans->transaction->transid;
165 inode->last_sub_trans = inode->root->log_transid;
166 inode->last_log_commit = inode->root->last_log_commit;
167 spin_unlock(&inode->lock);
168}
169
170/*
171 * Make qgroup codes to skip given qgroupid, means the old/new_roots for
172 * qgroup won't contain the qgroupid in it.
173 */
174static inline void btrfs_set_skip_qgroup(struct btrfs_trans_handle *trans,
175 u64 qgroupid)
176{
177 struct btrfs_delayed_ref_root *delayed_refs;
178
179 delayed_refs = &trans->transaction->delayed_refs;
180 WARN_ON(delayed_refs->qgroup_to_skip);
181 delayed_refs->qgroup_to_skip = qgroupid;
182}
183
184static inline void btrfs_clear_skip_qgroup(struct btrfs_trans_handle *trans)
185{
186 struct btrfs_delayed_ref_root *delayed_refs;
187
188 delayed_refs = &trans->transaction->delayed_refs;
189 WARN_ON(!delayed_refs->qgroup_to_skip);
190 delayed_refs->qgroup_to_skip = 0;
191}
192
193int btrfs_end_transaction(struct btrfs_trans_handle *trans);
194struct btrfs_trans_handle *btrfs_start_transaction(struct btrfs_root *root,
195 unsigned int num_items);
196struct btrfs_trans_handle *btrfs_start_transaction_fallback_global_rsv(
197 struct btrfs_root *root,
198 unsigned int num_items);
199struct btrfs_trans_handle *btrfs_join_transaction(struct btrfs_root *root);
200struct btrfs_trans_handle *btrfs_join_transaction_spacecache(struct btrfs_root *root);
201struct btrfs_trans_handle *btrfs_join_transaction_nostart(struct btrfs_root *root);
202struct btrfs_trans_handle *btrfs_attach_transaction(struct btrfs_root *root);
203struct btrfs_trans_handle *btrfs_attach_transaction_barrier(
204 struct btrfs_root *root);
205int btrfs_wait_for_commit(struct btrfs_fs_info *fs_info, u64 transid);
206
207void btrfs_add_dead_root(struct btrfs_root *root);
208int btrfs_defrag_root(struct btrfs_root *root);
209int btrfs_clean_one_deleted_snapshot(struct btrfs_root *root);
210int btrfs_commit_transaction(struct btrfs_trans_handle *trans);
211int btrfs_commit_transaction_async(struct btrfs_trans_handle *trans,
212 int wait_for_unblock);
213int btrfs_end_transaction_throttle(struct btrfs_trans_handle *trans);
214int btrfs_should_end_transaction(struct btrfs_trans_handle *trans);
215void btrfs_throttle(struct btrfs_fs_info *fs_info);
216int btrfs_record_root_in_trans(struct btrfs_trans_handle *trans,
217 struct btrfs_root *root);
218int btrfs_write_marked_extents(struct btrfs_fs_info *fs_info,
219 struct extent_io_tree *dirty_pages, int mark);
220int btrfs_wait_tree_log_extents(struct btrfs_root *root, int mark);
221int btrfs_transaction_blocked(struct btrfs_fs_info *info);
222int btrfs_transaction_in_commit(struct btrfs_fs_info *info);
223void btrfs_put_transaction(struct btrfs_transaction *transaction);
224void btrfs_apply_pending_changes(struct btrfs_fs_info *fs_info);
225void btrfs_add_dropped_root(struct btrfs_trans_handle *trans,
226 struct btrfs_root *root);
227void btrfs_trans_release_chunk_metadata(struct btrfs_trans_handle *trans);
228
229#endif