0d2b957ca3a31f4aa44ccfd7c0fd43f006c5922a
[sfrench/cifs-2.6.git] / fs / btrfs / root-tree.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (C) 2007 Oracle.  All rights reserved.
4  */
5
6 #include <linux/err.h>
7 #include <linux/uuid.h>
8 #include "ctree.h"
9 #include "transaction.h"
10 #include "disk-io.h"
11 #include "print-tree.h"
12
13 /*
14  * Read a root item from the tree. In case we detect a root item smaller then
15  * sizeof(root_item), we know it's an old version of the root structure and
16  * initialize all new fields to zero. The same happens if we detect mismatching
17  * generation numbers as then we know the root was once mounted with an older
18  * kernel that was not aware of the root item structure change.
19  */
20 static void btrfs_read_root_item(struct extent_buffer *eb, int slot,
21                                 struct btrfs_root_item *item)
22 {
23         uuid_le uuid;
24         u32 len;
25         int need_reset = 0;
26
27         len = btrfs_item_size_nr(eb, slot);
28         read_extent_buffer(eb, item, btrfs_item_ptr_offset(eb, slot),
29                            min_t(u32, len, sizeof(*item)));
30         if (len < sizeof(*item))
31                 need_reset = 1;
32         if (!need_reset && btrfs_root_generation(item)
33                 != btrfs_root_generation_v2(item)) {
34                 if (btrfs_root_generation_v2(item) != 0) {
35                         btrfs_warn(eb->fs_info,
36                                         "mismatching generation and generation_v2 found in root item. This root was probably mounted with an older kernel. Resetting all new fields.");
37                 }
38                 need_reset = 1;
39         }
40         if (need_reset) {
41                 memset(&item->generation_v2, 0,
42                         sizeof(*item) - offsetof(struct btrfs_root_item,
43                                         generation_v2));
44
45                 uuid_le_gen(&uuid);
46                 memcpy(item->uuid, uuid.b, BTRFS_UUID_SIZE);
47         }
48 }
49
50 /*
51  * btrfs_find_root - lookup the root by the key.
52  * root: the root of the root tree
53  * search_key: the key to search
54  * path: the path we search
55  * root_item: the root item of the tree we look for
56  * root_key: the root key of the tree we look for
57  *
58  * If ->offset of 'search_key' is -1ULL, it means we are not sure the offset
59  * of the search key, just lookup the root with the highest offset for a
60  * given objectid.
61  *
62  * If we find something return 0, otherwise > 0, < 0 on error.
63  */
64 int btrfs_find_root(struct btrfs_root *root, const struct btrfs_key *search_key,
65                     struct btrfs_path *path, struct btrfs_root_item *root_item,
66                     struct btrfs_key *root_key)
67 {
68         struct btrfs_key found_key;
69         struct extent_buffer *l;
70         int ret;
71         int slot;
72
73         ret = btrfs_search_slot(NULL, root, search_key, path, 0, 0);
74         if (ret < 0)
75                 return ret;
76
77         if (search_key->offset != -1ULL) {      /* the search key is exact */
78                 if (ret > 0)
79                         goto out;
80         } else {
81                 BUG_ON(ret == 0);               /* Logical error */
82                 if (path->slots[0] == 0)
83                         goto out;
84                 path->slots[0]--;
85                 ret = 0;
86         }
87
88         l = path->nodes[0];
89         slot = path->slots[0];
90
91         btrfs_item_key_to_cpu(l, &found_key, slot);
92         if (found_key.objectid != search_key->objectid ||
93             found_key.type != BTRFS_ROOT_ITEM_KEY) {
94                 ret = 1;
95                 goto out;
96         }
97
98         if (root_item)
99                 btrfs_read_root_item(l, slot, root_item);
100         if (root_key)
101                 memcpy(root_key, &found_key, sizeof(found_key));
102 out:
103         btrfs_release_path(path);
104         return ret;
105 }
106
107 void btrfs_set_root_node(struct btrfs_root_item *item,
108                          struct extent_buffer *node)
109 {
110         btrfs_set_root_bytenr(item, node->start);
111         btrfs_set_root_level(item, btrfs_header_level(node));
112         btrfs_set_root_generation(item, btrfs_header_generation(node));
113 }
114
115 /*
116  * copy the data in 'item' into the btree
117  */
118 int btrfs_update_root(struct btrfs_trans_handle *trans, struct btrfs_root
119                       *root, struct btrfs_key *key, struct btrfs_root_item
120                       *item)
121 {
122         struct btrfs_fs_info *fs_info = root->fs_info;
123         struct btrfs_path *path;
124         struct extent_buffer *l;
125         int ret;
126         int slot;
127         unsigned long ptr;
128         u32 old_len;
129
130         path = btrfs_alloc_path();
131         if (!path)
132                 return -ENOMEM;
133
134         ret = btrfs_search_slot(trans, root, key, path, 0, 1);
135         if (ret < 0) {
136                 btrfs_abort_transaction(trans, ret);
137                 goto out;
138         }
139
140         if (ret != 0) {
141                 btrfs_print_leaf(path->nodes[0]);
142                 btrfs_crit(fs_info, "unable to update root key %llu %u %llu",
143                            key->objectid, key->type, key->offset);
144                 BUG_ON(1);
145         }
146
147         l = path->nodes[0];
148         slot = path->slots[0];
149         ptr = btrfs_item_ptr_offset(l, slot);
150         old_len = btrfs_item_size_nr(l, slot);
151
152         /*
153          * If this is the first time we update the root item which originated
154          * from an older kernel, we need to enlarge the item size to make room
155          * for the added fields.
156          */
157         if (old_len < sizeof(*item)) {
158                 btrfs_release_path(path);
159                 ret = btrfs_search_slot(trans, root, key, path,
160                                 -1, 1);
161                 if (ret < 0) {
162                         btrfs_abort_transaction(trans, ret);
163                         goto out;
164                 }
165
166                 ret = btrfs_del_item(trans, root, path);
167                 if (ret < 0) {
168                         btrfs_abort_transaction(trans, ret);
169                         goto out;
170                 }
171                 btrfs_release_path(path);
172                 ret = btrfs_insert_empty_item(trans, root, path,
173                                 key, sizeof(*item));
174                 if (ret < 0) {
175                         btrfs_abort_transaction(trans, ret);
176                         goto out;
177                 }
178                 l = path->nodes[0];
179                 slot = path->slots[0];
180                 ptr = btrfs_item_ptr_offset(l, slot);
181         }
182
183         /*
184          * Update generation_v2 so at the next mount we know the new root
185          * fields are valid.
186          */
187         btrfs_set_root_generation_v2(item, btrfs_root_generation(item));
188
189         write_extent_buffer(l, item, ptr, sizeof(*item));
190         btrfs_mark_buffer_dirty(path->nodes[0]);
191 out:
192         btrfs_free_path(path);
193         return ret;
194 }
195
196 int btrfs_insert_root(struct btrfs_trans_handle *trans, struct btrfs_root *root,
197                       const struct btrfs_key *key, struct btrfs_root_item *item)
198 {
199         /*
200          * Make sure generation v1 and v2 match. See update_root for details.
201          */
202         btrfs_set_root_generation_v2(item, btrfs_root_generation(item));
203         return btrfs_insert_item(trans, root, key, item, sizeof(*item));
204 }
205
206 int btrfs_find_orphan_roots(struct btrfs_fs_info *fs_info)
207 {
208         struct btrfs_root *tree_root = fs_info->tree_root;
209         struct extent_buffer *leaf;
210         struct btrfs_path *path;
211         struct btrfs_key key;
212         struct btrfs_key root_key;
213         struct btrfs_root *root;
214         int err = 0;
215         int ret;
216
217         path = btrfs_alloc_path();
218         if (!path)
219                 return -ENOMEM;
220
221         key.objectid = BTRFS_ORPHAN_OBJECTID;
222         key.type = BTRFS_ORPHAN_ITEM_KEY;
223         key.offset = 0;
224
225         root_key.type = BTRFS_ROOT_ITEM_KEY;
226         root_key.offset = (u64)-1;
227
228         while (1) {
229                 ret = btrfs_search_slot(NULL, tree_root, &key, path, 0, 0);
230                 if (ret < 0) {
231                         err = ret;
232                         break;
233                 }
234
235                 leaf = path->nodes[0];
236                 if (path->slots[0] >= btrfs_header_nritems(leaf)) {
237                         ret = btrfs_next_leaf(tree_root, path);
238                         if (ret < 0)
239                                 err = ret;
240                         if (ret != 0)
241                                 break;
242                         leaf = path->nodes[0];
243                 }
244
245                 btrfs_item_key_to_cpu(leaf, &key, path->slots[0]);
246                 btrfs_release_path(path);
247
248                 if (key.objectid != BTRFS_ORPHAN_OBJECTID ||
249                     key.type != BTRFS_ORPHAN_ITEM_KEY)
250                         break;
251
252                 root_key.objectid = key.offset;
253                 key.offset++;
254
255                 /*
256                  * The root might have been inserted already, as before we look
257                  * for orphan roots, log replay might have happened, which
258                  * triggers a transaction commit and qgroup accounting, which
259                  * in turn reads and inserts fs roots while doing backref
260                  * walking.
261                  */
262                 root = btrfs_lookup_fs_root(fs_info, root_key.objectid);
263                 if (root) {
264                         WARN_ON(!test_bit(BTRFS_ROOT_ORPHAN_ITEM_INSERTED,
265                                           &root->state));
266                         if (btrfs_root_refs(&root->root_item) == 0)
267                                 btrfs_add_dead_root(root);
268                         continue;
269                 }
270
271                 root = btrfs_read_fs_root(tree_root, &root_key);
272                 err = PTR_ERR_OR_ZERO(root);
273                 if (err && err != -ENOENT) {
274                         break;
275                 } else if (err == -ENOENT) {
276                         struct btrfs_trans_handle *trans;
277
278                         btrfs_release_path(path);
279
280                         trans = btrfs_join_transaction(tree_root);
281                         if (IS_ERR(trans)) {
282                                 err = PTR_ERR(trans);
283                                 btrfs_handle_fs_error(fs_info, err,
284                                             "Failed to start trans to delete orphan item");
285                                 break;
286                         }
287                         err = btrfs_del_orphan_item(trans, tree_root,
288                                                     root_key.objectid);
289                         btrfs_end_transaction(trans);
290                         if (err) {
291                                 btrfs_handle_fs_error(fs_info, err,
292                                             "Failed to delete root orphan item");
293                                 break;
294                         }
295                         continue;
296                 }
297
298                 err = btrfs_init_fs_root(root);
299                 if (err) {
300                         btrfs_free_fs_root(root);
301                         break;
302                 }
303
304                 set_bit(BTRFS_ROOT_ORPHAN_ITEM_INSERTED, &root->state);
305
306                 err = btrfs_insert_fs_root(fs_info, root);
307                 if (err) {
308                         BUG_ON(err == -EEXIST);
309                         btrfs_free_fs_root(root);
310                         break;
311                 }
312
313                 if (btrfs_root_refs(&root->root_item) == 0)
314                         btrfs_add_dead_root(root);
315         }
316
317         btrfs_free_path(path);
318         return err;
319 }
320
321 /* drop the root item for 'key' from the tree root */
322 int btrfs_del_root(struct btrfs_trans_handle *trans,
323                    const struct btrfs_key *key)
324 {
325         struct btrfs_root *root = trans->fs_info->tree_root;
326         struct btrfs_path *path;
327         int ret;
328
329         path = btrfs_alloc_path();
330         if (!path)
331                 return -ENOMEM;
332         ret = btrfs_search_slot(trans, root, key, path, -1, 1);
333         if (ret < 0)
334                 goto out;
335
336         BUG_ON(ret != 0);
337
338         ret = btrfs_del_item(trans, root, path);
339 out:
340         btrfs_free_path(path);
341         return ret;
342 }
343
344 int btrfs_del_root_ref(struct btrfs_trans_handle *trans, u64 root_id,
345                        u64 ref_id, u64 dirid, u64 *sequence, const char *name,
346                        int name_len)
347
348 {
349         struct btrfs_root *tree_root = trans->fs_info->tree_root;
350         struct btrfs_path *path;
351         struct btrfs_root_ref *ref;
352         struct extent_buffer *leaf;
353         struct btrfs_key key;
354         unsigned long ptr;
355         int err = 0;
356         int ret;
357
358         path = btrfs_alloc_path();
359         if (!path)
360                 return -ENOMEM;
361
362         key.objectid = root_id;
363         key.type = BTRFS_ROOT_BACKREF_KEY;
364         key.offset = ref_id;
365 again:
366         ret = btrfs_search_slot(trans, tree_root, &key, path, -1, 1);
367         BUG_ON(ret < 0);
368         if (ret == 0) {
369                 leaf = path->nodes[0];
370                 ref = btrfs_item_ptr(leaf, path->slots[0],
371                                      struct btrfs_root_ref);
372
373                 WARN_ON(btrfs_root_ref_dirid(leaf, ref) != dirid);
374                 WARN_ON(btrfs_root_ref_name_len(leaf, ref) != name_len);
375                 ptr = (unsigned long)(ref + 1);
376                 WARN_ON(memcmp_extent_buffer(leaf, name, ptr, name_len));
377                 *sequence = btrfs_root_ref_sequence(leaf, ref);
378
379                 ret = btrfs_del_item(trans, tree_root, path);
380                 if (ret) {
381                         err = ret;
382                         goto out;
383                 }
384         } else
385                 err = -ENOENT;
386
387         if (key.type == BTRFS_ROOT_BACKREF_KEY) {
388                 btrfs_release_path(path);
389                 key.objectid = ref_id;
390                 key.type = BTRFS_ROOT_REF_KEY;
391                 key.offset = root_id;
392                 goto again;
393         }
394
395 out:
396         btrfs_free_path(path);
397         return err;
398 }
399
400 /*
401  * add a btrfs_root_ref item.  type is either BTRFS_ROOT_REF_KEY
402  * or BTRFS_ROOT_BACKREF_KEY.
403  *
404  * The dirid, sequence, name and name_len refer to the directory entry
405  * that is referencing the root.
406  *
407  * For a forward ref, the root_id is the id of the tree referencing
408  * the root and ref_id is the id of the subvol  or snapshot.
409  *
410  * For a back ref the root_id is the id of the subvol or snapshot and
411  * ref_id is the id of the tree referencing it.
412  *
413  * Will return 0, -ENOMEM, or anything from the CoW path
414  */
415 int btrfs_add_root_ref(struct btrfs_trans_handle *trans, u64 root_id,
416                        u64 ref_id, u64 dirid, u64 sequence, const char *name,
417                        int name_len)
418 {
419         struct btrfs_root *tree_root = trans->fs_info->tree_root;
420         struct btrfs_key key;
421         int ret;
422         struct btrfs_path *path;
423         struct btrfs_root_ref *ref;
424         struct extent_buffer *leaf;
425         unsigned long ptr;
426
427         path = btrfs_alloc_path();
428         if (!path)
429                 return -ENOMEM;
430
431         key.objectid = root_id;
432         key.type = BTRFS_ROOT_BACKREF_KEY;
433         key.offset = ref_id;
434 again:
435         ret = btrfs_insert_empty_item(trans, tree_root, path, &key,
436                                       sizeof(*ref) + name_len);
437         if (ret) {
438                 btrfs_abort_transaction(trans, ret);
439                 btrfs_free_path(path);
440                 return ret;
441         }
442
443         leaf = path->nodes[0];
444         ref = btrfs_item_ptr(leaf, path->slots[0], struct btrfs_root_ref);
445         btrfs_set_root_ref_dirid(leaf, ref, dirid);
446         btrfs_set_root_ref_sequence(leaf, ref, sequence);
447         btrfs_set_root_ref_name_len(leaf, ref, name_len);
448         ptr = (unsigned long)(ref + 1);
449         write_extent_buffer(leaf, name, ptr, name_len);
450         btrfs_mark_buffer_dirty(leaf);
451
452         if (key.type == BTRFS_ROOT_BACKREF_KEY) {
453                 btrfs_release_path(path);
454                 key.objectid = ref_id;
455                 key.type = BTRFS_ROOT_REF_KEY;
456                 key.offset = root_id;
457                 goto again;
458         }
459
460         btrfs_free_path(path);
461         return 0;
462 }
463
464 /*
465  * Old btrfs forgets to init root_item->flags and root_item->byte_limit
466  * for subvolumes. To work around this problem, we steal a bit from
467  * root_item->inode_item->flags, and use it to indicate if those fields
468  * have been properly initialized.
469  */
470 void btrfs_check_and_init_root_item(struct btrfs_root_item *root_item)
471 {
472         u64 inode_flags = btrfs_stack_inode_flags(&root_item->inode);
473
474         if (!(inode_flags & BTRFS_INODE_ROOT_ITEM_INIT)) {
475                 inode_flags |= BTRFS_INODE_ROOT_ITEM_INIT;
476                 btrfs_set_stack_inode_flags(&root_item->inode, inode_flags);
477                 btrfs_set_root_flags(root_item, 0);
478                 btrfs_set_root_limit(root_item, 0);
479         }
480 }
481
482 void btrfs_update_root_times(struct btrfs_trans_handle *trans,
483                              struct btrfs_root *root)
484 {
485         struct btrfs_root_item *item = &root->root_item;
486         struct timespec64 ct;
487
488         ktime_get_real_ts64(&ct);
489         spin_lock(&root->root_item_lock);
490         btrfs_set_root_ctransid(item, trans->transid);
491         btrfs_set_stack_timespec_sec(&item->ctime, ct.tv_sec);
492         btrfs_set_stack_timespec_nsec(&item->ctime, ct.tv_nsec);
493         spin_unlock(&root->root_item_lock);
494 }