blob: 50947b5a915252590be5f2caf8d024bfd9f15794 [file] [log] [blame]
Chris Mason56bec292009-03-13 10:10:06 -04001/*
2 * Copyright (C) 2008 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#ifndef __DELAYED_REF__
19#define __DELAYED_REF__
20
Wang Sheng-Hui44a075b2012-09-21 08:21:01 +080021/* these are the possible values of struct btrfs_delayed_ref_node->action */
Chris Mason56bec292009-03-13 10:10:06 -040022#define BTRFS_ADD_DELAYED_REF 1 /* add one backref to the tree */
23#define BTRFS_DROP_DELAYED_REF 2 /* delete one backref from the tree */
24#define BTRFS_ADD_DELAYED_EXTENT 3 /* record a full extent allocation */
Chris Mason1a81af42009-03-25 09:55:11 -040025#define BTRFS_UPDATE_DELAYED_HEAD 4 /* not changing ref count on head ref */
Chris Mason56bec292009-03-13 10:10:06 -040026
Qu Wenruoc6fc2452015-03-30 17:03:00 +080027/*
28 * XXX: Qu: I really hate the design that ref_head and tree/data ref shares the
29 * same ref_node structure.
30 * Ref_head is in a higher logic level than tree/data ref, and duplicated
31 * bytenr/num_bytes in ref_node is really a waste or memory, they should be
32 * referred from ref_head.
33 * This gets more disgusting after we use list to store tree/data ref in
34 * ref_head. Must clean this mess up later.
35 */
Chris Mason56bec292009-03-13 10:10:06 -040036struct btrfs_delayed_ref_node {
Qu Wenruoc6fc2452015-03-30 17:03:00 +080037 /*data/tree ref use list, stored in ref_head->ref_list. */
38 struct list_head list;
Wang Xiaoguang1d57ee92016-10-26 18:07:33 +080039 /*
40 * If action is BTRFS_ADD_DELAYED_REF, also link this node to
41 * ref_head->ref_add_list, then we do not need to iterate the
42 * whole ref_head->ref_list to find BTRFS_ADD_DELAYED_REF nodes.
43 */
44 struct list_head add_list;
Qu Wenruoc6fc2452015-03-30 17:03:00 +080045
Chris Mason56bec292009-03-13 10:10:06 -040046 /* the starting bytenr of the extent */
47 u64 bytenr;
48
Chris Mason56bec292009-03-13 10:10:06 -040049 /* the size of the extent */
50 u64 num_bytes;
51
Arne Jansen00f04b82011-09-14 12:37:00 +020052 /* seq number to keep track of insertion order */
53 u64 seq;
54
Chris Mason56bec292009-03-13 10:10:06 -040055 /* ref count on this data structure */
56 atomic_t refs;
57
58 /*
59 * how many refs is this entry adding or deleting. For
60 * head refs, this may be a negative number because it is keeping
61 * track of the total mods done to the reference count.
62 * For individual refs, this will always be a positive number
63 *
64 * It may be more than one, since it is possible for a single
65 * parent to have more than one ref on an extent
66 */
67 int ref_mod;
68
Yan Zheng5d4f98a2009-06-10 10:45:14 -040069 unsigned int action:8;
70 unsigned int type:8;
Chris Mason56bec292009-03-13 10:10:06 -040071 /* is this node still in the rbtree? */
Yan Zheng5d4f98a2009-06-10 10:45:14 -040072 unsigned int is_head:1;
Chris Mason56bec292009-03-13 10:10:06 -040073 unsigned int in_tree:1;
74};
75
Yan Zheng5d4f98a2009-06-10 10:45:14 -040076struct btrfs_delayed_extent_op {
77 struct btrfs_disk_key key;
David Sterba35b3ad52015-11-30 16:51:29 +010078 u8 level;
79 bool update_key;
80 bool update_flags;
81 bool is_data;
Yan Zheng5d4f98a2009-06-10 10:45:14 -040082 u64 flags_to_set;
Yan Zheng5d4f98a2009-06-10 10:45:14 -040083};
84
Chris Mason56bec292009-03-13 10:10:06 -040085/*
86 * the head refs are used to hold a lock on a given extent, which allows us
87 * to make sure that only one process is running the delayed refs
88 * at a time for a single extent. They also store the sum of all the
89 * reference count modifications we've queued up.
90 */
91struct btrfs_delayed_ref_head {
92 struct btrfs_delayed_ref_node node;
93
94 /*
95 * the mutex is held while running the refs, and it is also
96 * held when checking the sum of reference modifications.
97 */
98 struct mutex mutex;
99
Josef Bacikd7df2c72014-01-23 09:21:38 -0500100 spinlock_t lock;
Qu Wenruoc6fc2452015-03-30 17:03:00 +0800101 struct list_head ref_list;
Wang Xiaoguang1d57ee92016-10-26 18:07:33 +0800102 /* accumulate add BTRFS_ADD_DELAYED_REF nodes to this ref_add_list. */
103 struct list_head ref_add_list;
Chris Masonc3e69d52009-03-13 10:17:05 -0400104
Liu Boc46effa2013-10-14 12:59:45 +0800105 struct rb_node href_node;
106
Yan Zheng5d4f98a2009-06-10 10:45:14 -0400107 struct btrfs_delayed_extent_op *extent_op;
Josef Bacik12621332015-02-03 07:50:16 -0800108
109 /*
110 * This is used to track the final ref_mod from all the refs associated
111 * with this head ref, this is not adjusted as delayed refs are run,
112 * this is meant to track if we need to do the csum accounting or not.
113 */
114 int total_ref_mod;
115
Chris Mason56bec292009-03-13 10:10:06 -0400116 /*
Qu Wenruof64d5ca2015-09-08 17:08:36 +0800117 * For qgroup reserved space freeing.
118 *
119 * ref_root and reserved will be recorded after
120 * BTRFS_ADD_DELAYED_EXTENT is called.
121 * And will be used to free reserved qgroup space at
122 * run_delayed_refs() time.
123 */
124 u64 qgroup_ref_root;
125 u64 qgroup_reserved;
126
127 /*
Chris Mason56bec292009-03-13 10:10:06 -0400128 * when a new extent is allocated, it is just reserved in memory
129 * The actual extent isn't inserted into the extent allocation tree
130 * until the delayed ref is processed. must_insert_reserved is
131 * used to flag a delayed ref so the accounting can be updated
132 * when a full insert is done.
133 *
134 * It is possible the extent will be freed before it is ever
135 * inserted into the extent allocation tree. In this case
136 * we need to update the in ram accounting to properly reflect
137 * the free has happened.
138 */
139 unsigned int must_insert_reserved:1;
Yan Zheng5d4f98a2009-06-10 10:45:14 -0400140 unsigned int is_data:1;
Josef Bacikd7df2c72014-01-23 09:21:38 -0500141 unsigned int processing:1;
Chris Mason56bec292009-03-13 10:10:06 -0400142};
143
Yan Zheng5d4f98a2009-06-10 10:45:14 -0400144struct btrfs_delayed_tree_ref {
Chris Mason56bec292009-03-13 10:10:06 -0400145 struct btrfs_delayed_ref_node node;
Arne Janseneebe0632011-09-14 14:01:24 +0200146 u64 root;
147 u64 parent;
Yan Zheng5d4f98a2009-06-10 10:45:14 -0400148 int level;
149};
Chris Mason56bec292009-03-13 10:10:06 -0400150
Yan Zheng5d4f98a2009-06-10 10:45:14 -0400151struct btrfs_delayed_data_ref {
152 struct btrfs_delayed_ref_node node;
Arne Janseneebe0632011-09-14 14:01:24 +0200153 u64 root;
154 u64 parent;
Yan Zheng5d4f98a2009-06-10 10:45:14 -0400155 u64 objectid;
156 u64 offset;
Chris Mason56bec292009-03-13 10:10:06 -0400157};
158
159struct btrfs_delayed_ref_root {
Liu Boc46effa2013-10-14 12:59:45 +0800160 /* head ref rbtree */
161 struct rb_root href_root;
162
Qu Wenruo3368d002015-04-16 14:34:17 +0800163 /* dirty extent records */
164 struct rb_root dirty_extent_root;
165
Chris Mason56bec292009-03-13 10:10:06 -0400166 /* this spin lock protects the rbtree and the entries inside */
167 spinlock_t lock;
168
169 /* how many delayed ref updates we've queued, used by the
170 * throttling code
171 */
Josef Bacikd7df2c72014-01-23 09:21:38 -0500172 atomic_t num_entries;
Chris Mason56bec292009-03-13 10:10:06 -0400173
Chris Masonc3e69d52009-03-13 10:17:05 -0400174 /* total number of head nodes in tree */
175 unsigned long num_heads;
176
177 /* total number of head nodes ready for processing */
178 unsigned long num_heads_ready;
179
Josef Bacik12621332015-02-03 07:50:16 -0800180 u64 pending_csums;
181
Chris Mason56bec292009-03-13 10:10:06 -0400182 /*
183 * set when the tree is flushing before a transaction commit,
184 * used by the throttling code to decide if new updates need
185 * to be run right away
186 */
187 int flushing;
Chris Masonc3e69d52009-03-13 10:17:05 -0400188
189 u64 run_delayed_start;
Qu Wenruo9086db82015-04-20 09:53:50 +0800190
191 /*
192 * To make qgroup to skip given root.
Nicholas D Steeves01327612016-05-19 21:18:45 -0400193 * This is for snapshot, as btrfs_qgroup_inherit() will manually
Qu Wenruo9086db82015-04-20 09:53:50 +0800194 * modify counters for snapshot and its source, so we should skip
195 * the snapshot in new_root/old_roots or it will get calculated twice
196 */
197 u64 qgroup_to_skip;
Chris Mason56bec292009-03-13 10:10:06 -0400198};
199
Miao Xie78a61842012-11-21 02:21:28 +0000200extern struct kmem_cache *btrfs_delayed_ref_head_cachep;
201extern struct kmem_cache *btrfs_delayed_tree_ref_cachep;
202extern struct kmem_cache *btrfs_delayed_data_ref_cachep;
203extern struct kmem_cache *btrfs_delayed_extent_op_cachep;
204
205int btrfs_delayed_ref_init(void);
206void btrfs_delayed_ref_exit(void);
207
208static inline struct btrfs_delayed_extent_op *
209btrfs_alloc_delayed_extent_op(void)
210{
211 return kmem_cache_alloc(btrfs_delayed_extent_op_cachep, GFP_NOFS);
212}
213
214static inline void
215btrfs_free_delayed_extent_op(struct btrfs_delayed_extent_op *op)
216{
217 if (op)
218 kmem_cache_free(btrfs_delayed_extent_op_cachep, op);
219}
220
Chris Mason56bec292009-03-13 10:10:06 -0400221static inline void btrfs_put_delayed_ref(struct btrfs_delayed_ref_node *ref)
222{
223 WARN_ON(atomic_read(&ref->refs) == 0);
224 if (atomic_dec_and_test(&ref->refs)) {
225 WARN_ON(ref->in_tree);
Miao Xie78a61842012-11-21 02:21:28 +0000226 switch (ref->type) {
227 case BTRFS_TREE_BLOCK_REF_KEY:
228 case BTRFS_SHARED_BLOCK_REF_KEY:
229 kmem_cache_free(btrfs_delayed_tree_ref_cachep, ref);
230 break;
231 case BTRFS_EXTENT_DATA_REF_KEY:
232 case BTRFS_SHARED_DATA_REF_KEY:
233 kmem_cache_free(btrfs_delayed_data_ref_cachep, ref);
234 break;
235 case 0:
236 kmem_cache_free(btrfs_delayed_ref_head_cachep, ref);
237 break;
238 default:
239 BUG();
240 }
Chris Mason56bec292009-03-13 10:10:06 -0400241 }
242}
243
Arne Jansen66d7e7f2011-09-12 15:26:38 +0200244int btrfs_add_delayed_tree_ref(struct btrfs_fs_info *fs_info,
245 struct btrfs_trans_handle *trans,
Yan Zheng5d4f98a2009-06-10 10:45:14 -0400246 u64 bytenr, u64 num_bytes, u64 parent,
247 u64 ref_root, int level, int action,
Filipe Mananab06c4bf2015-10-23 07:52:54 +0100248 struct btrfs_delayed_extent_op *extent_op);
Arne Jansen66d7e7f2011-09-12 15:26:38 +0200249int btrfs_add_delayed_data_ref(struct btrfs_fs_info *fs_info,
250 struct btrfs_trans_handle *trans,
Yan Zheng5d4f98a2009-06-10 10:45:14 -0400251 u64 bytenr, u64 num_bytes,
252 u64 parent, u64 ref_root,
Qu Wenruo5846a3c2015-10-26 14:11:18 +0800253 u64 owner, u64 offset, u64 reserved, int action,
Filipe Mananab06c4bf2015-10-23 07:52:54 +0100254 struct btrfs_delayed_extent_op *extent_op);
Arne Jansen66d7e7f2011-09-12 15:26:38 +0200255int btrfs_add_delayed_extent_op(struct btrfs_fs_info *fs_info,
256 struct btrfs_trans_handle *trans,
Yan Zheng5d4f98a2009-06-10 10:45:14 -0400257 u64 bytenr, u64 num_bytes,
258 struct btrfs_delayed_extent_op *extent_op);
Josef Bacikae1e2062012-08-07 16:00:32 -0400259void btrfs_merge_delayed_refs(struct btrfs_trans_handle *trans,
260 struct btrfs_fs_info *fs_info,
261 struct btrfs_delayed_ref_root *delayed_refs,
262 struct btrfs_delayed_ref_head *head);
Chris Mason56bec292009-03-13 10:10:06 -0400263
Chris Mason1887be62009-03-13 10:11:24 -0400264struct btrfs_delayed_ref_head *
265btrfs_find_delayed_ref_head(struct btrfs_trans_handle *trans, u64 bytenr);
Chris Masonc3e69d52009-03-13 10:17:05 -0400266int btrfs_delayed_ref_lock(struct btrfs_trans_handle *trans,
267 struct btrfs_delayed_ref_head *head);
Miao Xie093486c2012-12-19 08:10:10 +0000268static inline void btrfs_delayed_ref_unlock(struct btrfs_delayed_ref_head *head)
269{
270 mutex_unlock(&head->mutex);
271}
272
Josef Bacikd7df2c72014-01-23 09:21:38 -0500273
274struct btrfs_delayed_ref_head *
275btrfs_select_ref_head(struct btrfs_trans_handle *trans);
Arne Jansen00f04b82011-09-14 12:37:00 +0200276
Jan Schmidt097b8a72012-06-21 11:08:04 +0200277int btrfs_check_delayed_seq(struct btrfs_fs_info *fs_info,
278 struct btrfs_delayed_ref_root *delayed_refs,
Arne Jansen00f04b82011-09-14 12:37:00 +0200279 u64 seq);
280
281/*
Chris Mason56bec292009-03-13 10:10:06 -0400282 * a node might live in a head or a regular ref, this lets you
283 * test for the proper type to use.
284 */
285static int btrfs_delayed_ref_is_head(struct btrfs_delayed_ref_node *node)
286{
Yan Zheng5d4f98a2009-06-10 10:45:14 -0400287 return node->is_head;
Chris Mason56bec292009-03-13 10:10:06 -0400288}
289
290/*
291 * helper functions to cast a node into its container
292 */
Yan Zheng5d4f98a2009-06-10 10:45:14 -0400293static inline struct btrfs_delayed_tree_ref *
294btrfs_delayed_node_to_tree_ref(struct btrfs_delayed_ref_node *node)
Chris Mason56bec292009-03-13 10:10:06 -0400295{
296 WARN_ON(btrfs_delayed_ref_is_head(node));
Yan Zheng5d4f98a2009-06-10 10:45:14 -0400297 return container_of(node, struct btrfs_delayed_tree_ref, node);
298}
Chris Mason56bec292009-03-13 10:10:06 -0400299
Yan Zheng5d4f98a2009-06-10 10:45:14 -0400300static inline struct btrfs_delayed_data_ref *
301btrfs_delayed_node_to_data_ref(struct btrfs_delayed_ref_node *node)
302{
303 WARN_ON(btrfs_delayed_ref_is_head(node));
304 return container_of(node, struct btrfs_delayed_data_ref, node);
Chris Mason56bec292009-03-13 10:10:06 -0400305}
306
307static inline struct btrfs_delayed_ref_head *
308btrfs_delayed_node_to_head(struct btrfs_delayed_ref_node *node)
309{
310 WARN_ON(!btrfs_delayed_ref_is_head(node));
311 return container_of(node, struct btrfs_delayed_ref_head, node);
Chris Mason56bec292009-03-13 10:10:06 -0400312}
313#endif