2 * Copyright (C) 2007 Oracle. All rights reserved.
3 * Copyright (C) 2008 Morey Roof. All rights reserved.
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public
7 * License v2 as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public
15 * License along with this program; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 021110-1307, USA.
23 #include <sys/ioctl.h>
24 #include <sys/mount.h>
25 #include <sys/types.h>
27 #include <uuid/uuid.h>
32 #include <linux/loop.h>
33 #include <linux/major.h>
34 #include <linux/kdev_t.h>
36 #include <blkid/blkid.h>
38 #include <sys/statfs.h>
39 #include <linux/magic.h>
41 #include <sys/utsname.h>
43 #include "kerncompat.h"
44 #include "radix-tree.h"
47 #include "transaction.h"
55 #define BLKDISCARD _IO(0x12,119)
58 static int btrfs_scan_done = 0;
60 static char argv0_buf[ARGV0_BUF_SIZE] = "btrfs";
62 static int rand_seed_initlized = 0;
63 static unsigned short rand_seed[3];
65 const char *get_argv0_buf(void)
70 void fixup_argv0(char **argv, const char *token)
72 int len = strlen(argv0_buf);
74 snprintf(argv0_buf + len, sizeof(argv0_buf) - len, " %s", token);
78 void set_argv0(char **argv)
80 strncpy(argv0_buf, argv[0], sizeof(argv0_buf));
81 argv0_buf[sizeof(argv0_buf) - 1] = 0;
84 int check_argc_exact(int nargs, int expected)
87 fprintf(stderr, "%s: too few arguments\n", argv0_buf);
89 fprintf(stderr, "%s: too many arguments\n", argv0_buf);
91 return nargs != expected;
94 int check_argc_min(int nargs, int expected)
96 if (nargs < expected) {
97 fprintf(stderr, "%s: too few arguments\n", argv0_buf);
104 int check_argc_max(int nargs, int expected)
106 if (nargs > expected) {
107 fprintf(stderr, "%s: too many arguments\n", argv0_buf);
116 * Discard the given range in one go
118 static int discard_range(int fd, u64 start, u64 len)
120 u64 range[2] = { start, len };
122 if (ioctl(fd, BLKDISCARD, &range) < 0)
128 * Discard blocks in the given range in 1G chunks, the process is interruptible
130 static int discard_blocks(int fd, u64 start, u64 len)
134 u64 chunk_size = min_t(u64, len, 1*1024*1024*1024);
137 ret = discard_range(fd, start, chunk_size);
147 static u64 reference_root_table[] = {
148 [1] = BTRFS_ROOT_TREE_OBJECTID,
149 [2] = BTRFS_EXTENT_TREE_OBJECTID,
150 [3] = BTRFS_CHUNK_TREE_OBJECTID,
151 [4] = BTRFS_DEV_TREE_OBJECTID,
152 [5] = BTRFS_FS_TREE_OBJECTID,
153 [6] = BTRFS_CSUM_TREE_OBJECTID,
156 int test_uuid_unique(char *fs_uuid)
159 blkid_dev_iterate iter = NULL;
160 blkid_dev dev = NULL;
161 blkid_cache cache = NULL;
163 if (blkid_get_cache(&cache, NULL) < 0) {
164 printf("ERROR: lblkid cache get failed\n");
167 blkid_probe_all(cache);
168 iter = blkid_dev_iterate_begin(cache);
169 blkid_dev_set_search(iter, "UUID", fs_uuid);
171 while (blkid_dev_next(iter, &dev) == 0) {
172 dev = blkid_verify(cache, dev);
179 blkid_dev_iterate_end(iter);
180 blkid_put_cache(cache);
186 * Reserve space from free_tree.
187 * The algorithm is very simple, find the first cache_extent with enough space
188 * and allocate from its beginning.
190 static int reserve_free_space(struct cache_tree *free_tree, u64 len,
193 struct cache_extent *cache;
196 ASSERT(ret_start != NULL);
197 cache = first_cache_extent(free_tree);
199 if (cache->size > len) {
201 *ret_start = cache->start;
204 if (cache->size == 0) {
205 remove_cache_extent(free_tree, cache);
212 cache = next_cache_extent(cache);
219 static inline int write_temp_super(int fd, struct btrfs_super_block *sb,
225 crc = btrfs_csum_data(NULL, (char *)sb + BTRFS_CSUM_SIZE, crc,
226 BTRFS_SUPER_INFO_SIZE - BTRFS_CSUM_SIZE);
227 btrfs_csum_final(crc, &sb->csum[0]);
228 ret = pwrite(fd, sb, BTRFS_SUPER_INFO_SIZE, sb_bytenr);
229 if (ret < BTRFS_SUPER_INFO_SIZE)
230 ret = (ret < 0 ? -errno : -EIO);
237 * Setup temporary superblock at cfg->super_bynter
238 * Needed info are extracted from cfg, and root_bytenr, chunk_bytenr
240 * For now sys chunk array will be empty and dev_item is empty too.
241 * They will be re-initialized at temp chunk tree setup.
243 * The superblock signature is not valid, denotes a partially created
244 * filesystem, needs to be finalized.
246 static int setup_temp_super(int fd, struct btrfs_mkfs_config *cfg,
247 u64 root_bytenr, u64 chunk_bytenr)
249 unsigned char chunk_uuid[BTRFS_UUID_SIZE];
250 char super_buf[BTRFS_SUPER_INFO_SIZE];
251 struct btrfs_super_block *super = (struct btrfs_super_block *)super_buf;
254 memset(super_buf, 0, BTRFS_SUPER_INFO_SIZE);
255 cfg->num_bytes = round_down(cfg->num_bytes, cfg->sectorsize);
258 if (uuid_parse(cfg->fs_uuid, super->fsid) != 0) {
259 error("cound not parse UUID: %s", cfg->fs_uuid);
263 if (!test_uuid_unique(cfg->fs_uuid)) {
264 error("non-unique UUID: %s", cfg->fs_uuid);
269 uuid_generate(super->fsid);
270 uuid_unparse(super->fsid, cfg->fs_uuid);
272 uuid_generate(chunk_uuid);
273 uuid_unparse(chunk_uuid, cfg->chunk_uuid);
275 btrfs_set_super_bytenr(super, cfg->super_bytenr);
276 btrfs_set_super_num_devices(super, 1);
277 btrfs_set_super_magic(super, BTRFS_MAGIC_PARTIAL);
278 btrfs_set_super_generation(super, 1);
279 btrfs_set_super_root(super, root_bytenr);
280 btrfs_set_super_chunk_root(super, chunk_bytenr);
281 btrfs_set_super_total_bytes(super, cfg->num_bytes);
283 * Temporary filesystem will only have 6 tree roots:
284 * chunk tree, root tree, extent_tree, device tree, fs tree
287 btrfs_set_super_bytes_used(super, 6 * cfg->nodesize);
288 btrfs_set_super_sectorsize(super, cfg->sectorsize);
289 btrfs_set_super_leafsize(super, cfg->nodesize);
290 btrfs_set_super_nodesize(super, cfg->nodesize);
291 btrfs_set_super_stripesize(super, cfg->stripesize);
292 btrfs_set_super_csum_type(super, BTRFS_CSUM_TYPE_CRC32);
293 btrfs_set_super_chunk_root(super, chunk_bytenr);
294 btrfs_set_super_cache_generation(super, -1);
295 btrfs_set_super_incompat_flags(super, cfg->features);
297 __strncpy_null(super->label, cfg->label, BTRFS_LABEL_SIZE - 1);
299 /* Sys chunk array will be re-initialized at chunk tree init time */
300 super->sys_chunk_array_size = 0;
302 ret = write_temp_super(fd, super, cfg->super_bytenr);
308 * Setup an extent buffer for tree block.
310 static int setup_temp_extent_buffer(struct extent_buffer *buf,
311 struct btrfs_mkfs_config *cfg,
312 u64 bytenr, u64 owner)
314 unsigned char fsid[BTRFS_FSID_SIZE];
315 unsigned char chunk_uuid[BTRFS_UUID_SIZE];
318 ret = uuid_parse(cfg->fs_uuid, fsid);
321 ret = uuid_parse(cfg->chunk_uuid, chunk_uuid);
325 memset(buf->data, 0, cfg->nodesize);
326 buf->len = cfg->nodesize;
327 btrfs_set_header_bytenr(buf, bytenr);
328 btrfs_set_header_generation(buf, 1);
329 btrfs_set_header_backref_rev(buf, BTRFS_MIXED_BACKREF_REV);
330 btrfs_set_header_owner(buf, owner);
331 btrfs_set_header_flags(buf, BTRFS_HEADER_FLAG_WRITTEN);
332 write_extent_buffer(buf, chunk_uuid, btrfs_header_chunk_tree_uuid(buf),
334 write_extent_buffer(buf, fsid, btrfs_header_fsid(), BTRFS_FSID_SIZE);
338 static inline int write_temp_extent_buffer(int fd, struct extent_buffer *buf,
343 csum_tree_block_size(buf, BTRFS_CRC32_SIZE, 0);
345 /* Temporary extent buffer is always mapped 1:1 on disk */
346 ret = pwrite(fd, buf->data, buf->len, bytenr);
348 ret = (ret < 0 ? ret : -EIO);
355 * Insert a root item for temporary tree root
357 * Only used in make_btrfs_v2().
359 static void insert_temp_root_item(struct extent_buffer *buf,
360 struct btrfs_mkfs_config *cfg,
361 int *slot, u32 *itemoff, u64 objectid,
364 struct btrfs_root_item root_item;
365 struct btrfs_inode_item *inode_item;
366 struct btrfs_disk_key disk_key;
368 btrfs_set_header_nritems(buf, *slot + 1);
369 (*itemoff) -= sizeof(root_item);
370 memset(&root_item, 0, sizeof(root_item));
371 inode_item = &root_item.inode;
372 btrfs_set_stack_inode_generation(inode_item, 1);
373 btrfs_set_stack_inode_size(inode_item, 3);
374 btrfs_set_stack_inode_nlink(inode_item, 1);
375 btrfs_set_stack_inode_nbytes(inode_item, cfg->nodesize);
376 btrfs_set_stack_inode_mode(inode_item, S_IFDIR | 0755);
377 btrfs_set_root_refs(&root_item, 1);
378 btrfs_set_root_used(&root_item, cfg->nodesize);
379 btrfs_set_root_generation(&root_item, 1);
380 btrfs_set_root_bytenr(&root_item, bytenr);
382 memset(&disk_key, 0, sizeof(disk_key));
383 btrfs_set_disk_key_type(&disk_key, BTRFS_ROOT_ITEM_KEY);
384 btrfs_set_disk_key_objectid(&disk_key, objectid);
385 btrfs_set_disk_key_offset(&disk_key, 0);
387 btrfs_set_item_key(buf, &disk_key, *slot);
388 btrfs_set_item_offset(buf, btrfs_item_nr(*slot), *itemoff);
389 btrfs_set_item_size(buf, btrfs_item_nr(*slot), sizeof(root_item));
390 write_extent_buffer(buf, &root_item,
391 btrfs_item_ptr_offset(buf, *slot),
396 static int setup_temp_root_tree(int fd, struct btrfs_mkfs_config *cfg,
397 u64 root_bytenr, u64 extent_bytenr,
398 u64 dev_bytenr, u64 fs_bytenr, u64 csum_bytenr)
400 struct extent_buffer *buf = NULL;
401 u32 itemoff = __BTRFS_LEAF_DATA_SIZE(cfg->nodesize);
406 * Provided bytenr must in ascending order, or tree root will have a
409 if (!(root_bytenr < extent_bytenr && extent_bytenr < dev_bytenr &&
410 dev_bytenr < fs_bytenr && fs_bytenr < csum_bytenr)) {
411 error("bad tree bytenr order: "
412 "root < extent %llu < %llu, "
413 "extent < dev %llu < %llu, "
414 "dev < fs %llu < %llu, "
415 "fs < csum %llu < %llu",
416 (unsigned long long)root_bytenr,
417 (unsigned long long)extent_bytenr,
418 (unsigned long long)extent_bytenr,
419 (unsigned long long)dev_bytenr,
420 (unsigned long long)dev_bytenr,
421 (unsigned long long)fs_bytenr,
422 (unsigned long long)fs_bytenr,
423 (unsigned long long)csum_bytenr);
426 buf = malloc(sizeof(*buf) + cfg->nodesize);
430 ret = setup_temp_extent_buffer(buf, cfg, root_bytenr,
431 BTRFS_ROOT_TREE_OBJECTID);
435 insert_temp_root_item(buf, cfg, &slot, &itemoff,
436 BTRFS_EXTENT_TREE_OBJECTID, extent_bytenr);
437 insert_temp_root_item(buf, cfg, &slot, &itemoff,
438 BTRFS_DEV_TREE_OBJECTID, dev_bytenr);
439 insert_temp_root_item(buf, cfg, &slot, &itemoff,
440 BTRFS_FS_TREE_OBJECTID, fs_bytenr);
441 insert_temp_root_item(buf, cfg, &slot, &itemoff,
442 BTRFS_CSUM_TREE_OBJECTID, csum_bytenr);
444 ret = write_temp_extent_buffer(fd, buf, root_bytenr);
450 static int insert_temp_dev_item(int fd, struct extent_buffer *buf,
451 struct btrfs_mkfs_config *cfg,
452 int *slot, u32 *itemoff)
454 struct btrfs_disk_key disk_key;
455 struct btrfs_dev_item *dev_item;
456 char super_buf[BTRFS_SUPER_INFO_SIZE];
457 unsigned char dev_uuid[BTRFS_UUID_SIZE];
458 unsigned char fsid[BTRFS_FSID_SIZE];
459 struct btrfs_super_block *super = (struct btrfs_super_block *)super_buf;
462 ret = pread(fd, super_buf, BTRFS_SUPER_INFO_SIZE, cfg->super_bytenr);
463 if (ret < BTRFS_SUPER_INFO_SIZE) {
464 ret = (ret < 0 ? -errno : -EIO);
468 btrfs_set_header_nritems(buf, *slot + 1);
469 (*itemoff) -= sizeof(*dev_item);
470 /* setup device item 1, 0 is for replace case */
471 btrfs_set_disk_key_type(&disk_key, BTRFS_DEV_ITEM_KEY);
472 btrfs_set_disk_key_objectid(&disk_key, BTRFS_DEV_ITEMS_OBJECTID);
473 btrfs_set_disk_key_offset(&disk_key, 1);
474 btrfs_set_item_key(buf, &disk_key, *slot);
475 btrfs_set_item_offset(buf, btrfs_item_nr(*slot), *itemoff);
476 btrfs_set_item_size(buf, btrfs_item_nr(*slot), sizeof(*dev_item));
478 dev_item = btrfs_item_ptr(buf, *slot, struct btrfs_dev_item);
479 /* Generate device uuid */
480 uuid_generate(dev_uuid);
481 write_extent_buffer(buf, dev_uuid,
482 (unsigned long)btrfs_device_uuid(dev_item),
484 uuid_parse(cfg->fs_uuid, fsid);
485 write_extent_buffer(buf, fsid,
486 (unsigned long)btrfs_device_fsid(dev_item),
488 btrfs_set_device_id(buf, dev_item, 1);
489 btrfs_set_device_generation(buf, dev_item, 0);
490 btrfs_set_device_total_bytes(buf, dev_item, cfg->num_bytes);
492 * The number must match the initial SYSTEM and META chunk size
494 btrfs_set_device_bytes_used(buf, dev_item,
495 BTRFS_MKFS_SYSTEM_GROUP_SIZE +
496 BTRFS_CONVERT_META_GROUP_SIZE);
497 btrfs_set_device_io_align(buf, dev_item, cfg->sectorsize);
498 btrfs_set_device_io_width(buf, dev_item, cfg->sectorsize);
499 btrfs_set_device_sector_size(buf, dev_item, cfg->sectorsize);
500 btrfs_set_device_type(buf, dev_item, 0);
502 /* Super dev_item is not complete, copy the complete one to sb */
503 read_extent_buffer(buf, &super->dev_item, (unsigned long)dev_item,
505 ret = write_temp_super(fd, super, cfg->super_bytenr);
511 static int insert_temp_chunk_item(int fd, struct extent_buffer *buf,
512 struct btrfs_mkfs_config *cfg,
513 int *slot, u32 *itemoff, u64 start, u64 len,
516 struct btrfs_chunk *chunk;
517 struct btrfs_disk_key disk_key;
518 char super_buf[BTRFS_SUPER_INFO_SIZE];
519 struct btrfs_super_block *sb = (struct btrfs_super_block *)super_buf;
522 ret = pread(fd, super_buf, BTRFS_SUPER_INFO_SIZE,
524 if (ret < BTRFS_SUPER_INFO_SIZE) {
525 ret = (ret < 0 ? ret : -EIO);
529 btrfs_set_header_nritems(buf, *slot + 1);
530 (*itemoff) -= btrfs_chunk_item_size(1);
531 btrfs_set_disk_key_type(&disk_key, BTRFS_CHUNK_ITEM_KEY);
532 btrfs_set_disk_key_objectid(&disk_key, BTRFS_FIRST_CHUNK_TREE_OBJECTID);
533 btrfs_set_disk_key_offset(&disk_key, start);
534 btrfs_set_item_key(buf, &disk_key, *slot);
535 btrfs_set_item_offset(buf, btrfs_item_nr(*slot), *itemoff);
536 btrfs_set_item_size(buf, btrfs_item_nr(*slot),
537 btrfs_chunk_item_size(1));
539 chunk = btrfs_item_ptr(buf, *slot, struct btrfs_chunk);
540 btrfs_set_chunk_length(buf, chunk, len);
541 btrfs_set_chunk_owner(buf, chunk, BTRFS_EXTENT_TREE_OBJECTID);
542 btrfs_set_chunk_stripe_len(buf, chunk, 64 * 1024);
543 btrfs_set_chunk_type(buf, chunk, type);
544 btrfs_set_chunk_io_align(buf, chunk, cfg->sectorsize);
545 btrfs_set_chunk_io_width(buf, chunk, cfg->sectorsize);
546 btrfs_set_chunk_sector_size(buf, chunk, cfg->sectorsize);
547 btrfs_set_chunk_num_stripes(buf, chunk, 1);
548 /* TODO: Support DUP profile for system chunk */
549 btrfs_set_stripe_devid_nr(buf, chunk, 0, 1);
550 /* We are doing 1:1 mapping, so start is its dev offset */
551 btrfs_set_stripe_offset_nr(buf, chunk, 0, start);
552 write_extent_buffer(buf, &sb->dev_item.uuid,
553 (unsigned long)btrfs_stripe_dev_uuid_nr(chunk, 0),
558 * If it's system chunk, also copy it to super block.
560 if (type & BTRFS_BLOCK_GROUP_SYSTEM) {
563 cur = (char *)sb->sys_chunk_array + sb->sys_chunk_array_size;
564 memcpy(cur, &disk_key, sizeof(disk_key));
565 cur += sizeof(disk_key);
566 read_extent_buffer(buf, cur, (unsigned long int)chunk,
567 btrfs_chunk_item_size(1));
568 sb->sys_chunk_array_size += btrfs_chunk_item_size(1) +
571 ret = write_temp_super(fd, sb, cfg->super_bytenr);
576 static int setup_temp_chunk_tree(int fd, struct btrfs_mkfs_config *cfg,
577 u64 sys_chunk_start, u64 meta_chunk_start,
580 struct extent_buffer *buf = NULL;
581 u32 itemoff = __BTRFS_LEAF_DATA_SIZE(cfg->nodesize);
585 /* Must ensure SYS chunk starts before META chunk */
586 if (meta_chunk_start < sys_chunk_start) {
587 error("wrong chunk order: meta < system %llu < %llu",
588 (unsigned long long)meta_chunk_start,
589 (unsigned long long)sys_chunk_start);
592 buf = malloc(sizeof(*buf) + cfg->nodesize);
595 ret = setup_temp_extent_buffer(buf, cfg, chunk_bytenr,
596 BTRFS_CHUNK_TREE_OBJECTID);
600 ret = insert_temp_dev_item(fd, buf, cfg, &slot, &itemoff);
603 ret = insert_temp_chunk_item(fd, buf, cfg, &slot, &itemoff,
605 BTRFS_MKFS_SYSTEM_GROUP_SIZE,
606 BTRFS_BLOCK_GROUP_SYSTEM);
609 ret = insert_temp_chunk_item(fd, buf, cfg, &slot, &itemoff,
611 BTRFS_CONVERT_META_GROUP_SIZE,
612 BTRFS_BLOCK_GROUP_METADATA);
615 ret = write_temp_extent_buffer(fd, buf, chunk_bytenr);
622 static void insert_temp_dev_extent(struct extent_buffer *buf,
623 int *slot, u32 *itemoff, u64 start, u64 len)
625 struct btrfs_dev_extent *dev_extent;
626 struct btrfs_disk_key disk_key;
628 btrfs_set_header_nritems(buf, *slot + 1);
629 (*itemoff) -= sizeof(*dev_extent);
630 btrfs_set_disk_key_type(&disk_key, BTRFS_DEV_EXTENT_KEY);
631 btrfs_set_disk_key_objectid(&disk_key, 1);
632 btrfs_set_disk_key_offset(&disk_key, start);
633 btrfs_set_item_key(buf, &disk_key, *slot);
634 btrfs_set_item_offset(buf, btrfs_item_nr(*slot), *itemoff);
635 btrfs_set_item_size(buf, btrfs_item_nr(*slot), sizeof(*dev_extent));
637 dev_extent = btrfs_item_ptr(buf, *slot, struct btrfs_dev_extent);
638 btrfs_set_dev_extent_chunk_objectid(buf, dev_extent,
639 BTRFS_FIRST_CHUNK_TREE_OBJECTID);
640 btrfs_set_dev_extent_length(buf, dev_extent, len);
641 btrfs_set_dev_extent_chunk_offset(buf, dev_extent, start);
642 btrfs_set_dev_extent_chunk_tree(buf, dev_extent,
643 BTRFS_CHUNK_TREE_OBJECTID);
647 static int setup_temp_dev_tree(int fd, struct btrfs_mkfs_config *cfg,
648 u64 sys_chunk_start, u64 meta_chunk_start,
651 struct extent_buffer *buf = NULL;
652 u32 itemoff = __BTRFS_LEAF_DATA_SIZE(cfg->nodesize);
656 /* Must ensure SYS chunk starts before META chunk */
657 if (meta_chunk_start < sys_chunk_start) {
658 error("wrong chunk order: meta < system %llu < %llu",
659 (unsigned long long)meta_chunk_start,
660 (unsigned long long)sys_chunk_start);
663 buf = malloc(sizeof(*buf) + cfg->nodesize);
666 ret = setup_temp_extent_buffer(buf, cfg, dev_bytenr,
667 BTRFS_DEV_TREE_OBJECTID);
670 insert_temp_dev_extent(buf, &slot, &itemoff, sys_chunk_start,
671 BTRFS_MKFS_SYSTEM_GROUP_SIZE);
672 insert_temp_dev_extent(buf, &slot, &itemoff, meta_chunk_start,
673 BTRFS_CONVERT_META_GROUP_SIZE);
674 ret = write_temp_extent_buffer(fd, buf, dev_bytenr);
680 static int setup_temp_fs_tree(int fd, struct btrfs_mkfs_config *cfg,
683 struct extent_buffer *buf = NULL;
686 buf = malloc(sizeof(*buf) + cfg->nodesize);
689 ret = setup_temp_extent_buffer(buf, cfg, fs_bytenr,
690 BTRFS_FS_TREE_OBJECTID);
694 * Temporary fs tree is completely empty.
696 ret = write_temp_extent_buffer(fd, buf, fs_bytenr);
702 static int setup_temp_csum_tree(int fd, struct btrfs_mkfs_config *cfg,
705 struct extent_buffer *buf = NULL;
708 buf = malloc(sizeof(*buf) + cfg->nodesize);
711 ret = setup_temp_extent_buffer(buf, cfg, csum_bytenr,
712 BTRFS_CSUM_TREE_OBJECTID);
716 * Temporary csum tree is completely empty.
718 ret = write_temp_extent_buffer(fd, buf, csum_bytenr);
725 * Insert one temporary extent item.
727 * NOTE: if skinny_metadata is not enabled, this function must be called
728 * after all other trees are initialized.
729 * Or fs without skinny-metadata will be screwed up.
731 static int insert_temp_extent_item(int fd, struct extent_buffer *buf,
732 struct btrfs_mkfs_config *cfg,
733 int *slot, u32 *itemoff, u64 bytenr,
736 struct extent_buffer *tmp;
737 struct btrfs_extent_item *ei;
738 struct btrfs_extent_inline_ref *iref;
739 struct btrfs_disk_key disk_key;
740 struct btrfs_disk_key tree_info_key;
741 struct btrfs_tree_block_info *info;
743 int skinny_metadata = cfg->features &
744 BTRFS_FEATURE_INCOMPAT_SKINNY_METADATA;
748 itemsize = sizeof(*ei) + sizeof(*iref);
750 itemsize = sizeof(*ei) + sizeof(*iref) +
751 sizeof(struct btrfs_tree_block_info);
753 btrfs_set_header_nritems(buf, *slot + 1);
754 *(itemoff) -= itemsize;
756 if (skinny_metadata) {
757 btrfs_set_disk_key_type(&disk_key, BTRFS_METADATA_ITEM_KEY);
758 btrfs_set_disk_key_offset(&disk_key, 0);
760 btrfs_set_disk_key_type(&disk_key, BTRFS_EXTENT_ITEM_KEY);
761 btrfs_set_disk_key_offset(&disk_key, cfg->nodesize);
763 btrfs_set_disk_key_objectid(&disk_key, bytenr);
765 btrfs_set_item_key(buf, &disk_key, *slot);
766 btrfs_set_item_offset(buf, btrfs_item_nr(*slot), *itemoff);
767 btrfs_set_item_size(buf, btrfs_item_nr(*slot), itemsize);
769 ei = btrfs_item_ptr(buf, *slot, struct btrfs_extent_item);
770 btrfs_set_extent_refs(buf, ei, 1);
771 btrfs_set_extent_generation(buf, ei, 1);
772 btrfs_set_extent_flags(buf, ei, BTRFS_EXTENT_FLAG_TREE_BLOCK);
774 if (skinny_metadata) {
775 iref = (struct btrfs_extent_inline_ref *)(ei + 1);
777 info = (struct btrfs_tree_block_info *)(ei + 1);
778 iref = (struct btrfs_extent_inline_ref *)(info + 1);
780 btrfs_set_extent_inline_ref_type(buf, iref,
781 BTRFS_TREE_BLOCK_REF_KEY);
782 btrfs_set_extent_inline_ref_offset(buf, iref, ref_root);
789 * Lastly, check the tree block key by read the tree block
790 * Since we do 1:1 mapping for convert case, we can directly
791 * read the bytenr from disk
793 tmp = malloc(sizeof(*tmp) + cfg->nodesize);
796 ret = setup_temp_extent_buffer(tmp, cfg, bytenr, ref_root);
799 ret = pread(fd, tmp->data, cfg->nodesize, bytenr);
800 if (ret < cfg->nodesize) {
801 ret = (ret < 0 ? -errno : -EIO);
804 if (btrfs_header_nritems(tmp) == 0) {
805 btrfs_set_disk_key_type(&tree_info_key, 0);
806 btrfs_set_disk_key_objectid(&tree_info_key, 0);
807 btrfs_set_disk_key_offset(&tree_info_key, 0);
809 btrfs_item_key(tmp, &tree_info_key, 0);
811 btrfs_set_tree_block_key(buf, info, &tree_info_key);
818 static void insert_temp_block_group(struct extent_buffer *buf,
819 struct btrfs_mkfs_config *cfg,
820 int *slot, u32 *itemoff,
821 u64 bytenr, u64 len, u64 used, u64 flag)
823 struct btrfs_block_group_item bgi;
824 struct btrfs_disk_key disk_key;
826 btrfs_set_header_nritems(buf, *slot + 1);
827 (*itemoff) -= sizeof(bgi);
828 btrfs_set_disk_key_type(&disk_key, BTRFS_BLOCK_GROUP_ITEM_KEY);
829 btrfs_set_disk_key_objectid(&disk_key, bytenr);
830 btrfs_set_disk_key_offset(&disk_key, len);
831 btrfs_set_item_key(buf, &disk_key, *slot);
832 btrfs_set_item_offset(buf, btrfs_item_nr(*slot), *itemoff);
833 btrfs_set_item_size(buf, btrfs_item_nr(*slot), sizeof(bgi));
835 btrfs_set_block_group_flags(&bgi, flag);
836 btrfs_set_block_group_used(&bgi, used);
837 btrfs_set_block_group_chunk_objectid(&bgi,
838 BTRFS_FIRST_CHUNK_TREE_OBJECTID);
839 write_extent_buffer(buf, &bgi, btrfs_item_ptr_offset(buf, *slot),
844 static int setup_temp_extent_tree(int fd, struct btrfs_mkfs_config *cfg,
845 u64 chunk_bytenr, u64 root_bytenr,
846 u64 extent_bytenr, u64 dev_bytenr,
847 u64 fs_bytenr, u64 csum_bytenr)
849 struct extent_buffer *buf = NULL;
850 u32 itemoff = __BTRFS_LEAF_DATA_SIZE(cfg->nodesize);
855 * We must ensure provided bytenr are in ascending order,
856 * or extent tree key order will be broken.
858 if (!(chunk_bytenr < root_bytenr && root_bytenr < extent_bytenr &&
859 extent_bytenr < dev_bytenr && dev_bytenr < fs_bytenr &&
860 fs_bytenr < csum_bytenr)) {
861 error("bad tree bytenr order: "
862 "chunk < root %llu < %llu, "
863 "root < extent %llu < %llu, "
864 "extent < dev %llu < %llu, "
865 "dev < fs %llu < %llu, "
866 "fs < csum %llu < %llu",
867 (unsigned long long)chunk_bytenr,
868 (unsigned long long)root_bytenr,
869 (unsigned long long)root_bytenr,
870 (unsigned long long)extent_bytenr,
871 (unsigned long long)extent_bytenr,
872 (unsigned long long)dev_bytenr,
873 (unsigned long long)dev_bytenr,
874 (unsigned long long)fs_bytenr,
875 (unsigned long long)fs_bytenr,
876 (unsigned long long)csum_bytenr);
879 buf = malloc(sizeof(*buf) + cfg->nodesize);
883 ret = setup_temp_extent_buffer(buf, cfg, extent_bytenr,
884 BTRFS_EXTENT_TREE_OBJECTID);
888 ret = insert_temp_extent_item(fd, buf, cfg, &slot, &itemoff,
889 chunk_bytenr, BTRFS_CHUNK_TREE_OBJECTID);
893 insert_temp_block_group(buf, cfg, &slot, &itemoff, chunk_bytenr,
894 BTRFS_MKFS_SYSTEM_GROUP_SIZE, cfg->nodesize,
895 BTRFS_BLOCK_GROUP_SYSTEM);
897 ret = insert_temp_extent_item(fd, buf, cfg, &slot, &itemoff,
898 root_bytenr, BTRFS_ROOT_TREE_OBJECTID);
902 /* 5 tree block used, root, extent, dev, fs and csum*/
903 insert_temp_block_group(buf, cfg, &slot, &itemoff, root_bytenr,
904 BTRFS_CONVERT_META_GROUP_SIZE, cfg->nodesize * 5,
905 BTRFS_BLOCK_GROUP_METADATA);
907 ret = insert_temp_extent_item(fd, buf, cfg, &slot, &itemoff,
908 extent_bytenr, BTRFS_EXTENT_TREE_OBJECTID);
911 ret = insert_temp_extent_item(fd, buf, cfg, &slot, &itemoff,
912 dev_bytenr, BTRFS_DEV_TREE_OBJECTID);
915 ret = insert_temp_extent_item(fd, buf, cfg, &slot, &itemoff,
916 fs_bytenr, BTRFS_FS_TREE_OBJECTID);
919 ret = insert_temp_extent_item(fd, buf, cfg, &slot, &itemoff,
920 csum_bytenr, BTRFS_CSUM_TREE_OBJECTID);
924 ret = write_temp_extent_buffer(fd, buf, extent_bytenr);
931 * Improved version of make_btrfs().
934 * 1) Do chunk allocation to avoid used data
935 * And after this function, extent type matches chunk type
936 * 2) Better structured code
937 * No super long hand written codes to initialized all tree blocks
938 * Split into small blocks and reuse codes.
939 * TODO: Reuse tree operation facilities by introducing new flags
941 static int make_convert_btrfs(int fd, struct btrfs_mkfs_config *cfg,
942 struct btrfs_convert_context *cctx)
944 struct cache_tree *free = &cctx->free;
945 struct cache_tree *used = &cctx->used;
947 u64 meta_chunk_start;
948 /* chunk tree bytenr, in system chunk */
950 /* metadata trees bytenr, in metadata chunk */
958 /* Shouldn't happen */
959 BUG_ON(cache_tree_empty(used));
962 * reserve space for temporary superblock first
963 * Here we allocate a little larger space, to keep later
964 * free space will be STRIPE_LEN aligned
966 ret = reserve_free_space(free, BTRFS_STRIPE_LEN,
972 * Then reserve system chunk space
973 * TODO: Change system group size depending on cctx->total_bytes.
974 * If using current 4M, it can only handle less than one TB for
975 * worst case and then run out of sys space.
977 ret = reserve_free_space(free, BTRFS_MKFS_SYSTEM_GROUP_SIZE,
981 ret = reserve_free_space(free, BTRFS_CONVERT_META_GROUP_SIZE,
987 * Allocated meta/sys chunks will be mapped 1:1 with device offset.
989 * Inside the allocated metadata chunk, the layout will be:
990 * | offset | contents |
991 * -------------------------------------
993 * | +nodesize | extent root |
994 * | +nodesize * 2 | device root |
995 * | +nodesize * 3 | fs tree |
996 * | +nodesize * 4 | csum tree |
997 * -------------------------------------
998 * Inside the allocated system chunk, the layout will be:
999 * | offset | contents |
1000 * -------------------------------------
1001 * | +0 | chunk root |
1002 * -------------------------------------
1004 chunk_bytenr = sys_chunk_start;
1005 root_bytenr = meta_chunk_start;
1006 extent_bytenr = meta_chunk_start + cfg->nodesize;
1007 dev_bytenr = meta_chunk_start + cfg->nodesize * 2;
1008 fs_bytenr = meta_chunk_start + cfg->nodesize * 3;
1009 csum_bytenr = meta_chunk_start + cfg->nodesize * 4;
1011 ret = setup_temp_super(fd, cfg, root_bytenr, chunk_bytenr);
1015 ret = setup_temp_root_tree(fd, cfg, root_bytenr, extent_bytenr,
1016 dev_bytenr, fs_bytenr, csum_bytenr);
1019 ret = setup_temp_chunk_tree(fd, cfg, sys_chunk_start, meta_chunk_start,
1023 ret = setup_temp_dev_tree(fd, cfg, sys_chunk_start, meta_chunk_start,
1027 ret = setup_temp_fs_tree(fd, cfg, fs_bytenr);
1030 ret = setup_temp_csum_tree(fd, cfg, csum_bytenr);
1034 * Setup extent tree last, since it may need to read tree block key
1035 * for non-skinny metadata case.
1037 ret = setup_temp_extent_tree(fd, cfg, chunk_bytenr, root_bytenr,
1038 extent_bytenr, dev_bytenr, fs_bytenr,
1045 * @fs_uuid - if NULL, generates a UUID, returns back the new filesystem UUID
1047 * The superblock signature is not valid, denotes a partially created
1048 * filesystem, needs to be finalized.
1050 int make_btrfs(int fd, struct btrfs_mkfs_config *cfg,
1051 struct btrfs_convert_context *cctx)
1053 struct btrfs_super_block super;
1054 struct extent_buffer *buf;
1055 struct btrfs_root_item root_item;
1056 struct btrfs_disk_key disk_key;
1057 struct btrfs_extent_item *extent_item;
1058 struct btrfs_inode_item *inode_item;
1059 struct btrfs_chunk *chunk;
1060 struct btrfs_dev_item *dev_item;
1061 struct btrfs_dev_extent *dev_extent;
1062 u8 chunk_tree_uuid[BTRFS_UUID_SIZE];
1072 int skinny_metadata = !!(cfg->features &
1073 BTRFS_FEATURE_INCOMPAT_SKINNY_METADATA);
1077 return make_convert_btrfs(fd, cfg, cctx);
1078 buf = malloc(sizeof(*buf) + max(cfg->sectorsize, cfg->nodesize));
1082 first_free = BTRFS_SUPER_INFO_OFFSET + cfg->sectorsize * 2 - 1;
1083 first_free &= ~((u64)cfg->sectorsize - 1);
1085 memset(&super, 0, sizeof(super));
1087 num_bytes = (cfg->num_bytes / cfg->sectorsize) * cfg->sectorsize;
1088 if (*cfg->fs_uuid) {
1089 if (uuid_parse(cfg->fs_uuid, super.fsid) != 0) {
1090 error("cannot not parse UUID: %s", cfg->fs_uuid);
1094 if (!test_uuid_unique(cfg->fs_uuid)) {
1095 error("non-unique UUID: %s", cfg->fs_uuid);
1100 uuid_generate(super.fsid);
1101 uuid_unparse(super.fsid, cfg->fs_uuid);
1103 uuid_generate(super.dev_item.uuid);
1104 uuid_generate(chunk_tree_uuid);
1106 btrfs_set_super_bytenr(&super, cfg->blocks[0]);
1107 btrfs_set_super_num_devices(&super, 1);
1108 btrfs_set_super_magic(&super, BTRFS_MAGIC_PARTIAL);
1109 btrfs_set_super_generation(&super, 1);
1110 btrfs_set_super_root(&super, cfg->blocks[1]);
1111 btrfs_set_super_chunk_root(&super, cfg->blocks[3]);
1112 btrfs_set_super_total_bytes(&super, num_bytes);
1113 btrfs_set_super_bytes_used(&super, 6 * cfg->nodesize);
1114 btrfs_set_super_sectorsize(&super, cfg->sectorsize);
1115 btrfs_set_super_leafsize(&super, cfg->nodesize);
1116 btrfs_set_super_nodesize(&super, cfg->nodesize);
1117 btrfs_set_super_stripesize(&super, cfg->stripesize);
1118 btrfs_set_super_csum_type(&super, BTRFS_CSUM_TYPE_CRC32);
1119 btrfs_set_super_chunk_root_generation(&super, 1);
1120 btrfs_set_super_cache_generation(&super, -1);
1121 btrfs_set_super_incompat_flags(&super, cfg->features);
1123 __strncpy_null(super.label, cfg->label, BTRFS_LABEL_SIZE - 1);
1125 /* create the tree of root objects */
1126 memset(buf->data, 0, cfg->nodesize);
1127 buf->len = cfg->nodesize;
1128 btrfs_set_header_bytenr(buf, cfg->blocks[1]);
1129 btrfs_set_header_nritems(buf, 4);
1130 btrfs_set_header_generation(buf, 1);
1131 btrfs_set_header_backref_rev(buf, BTRFS_MIXED_BACKREF_REV);
1132 btrfs_set_header_owner(buf, BTRFS_ROOT_TREE_OBJECTID);
1133 write_extent_buffer(buf, super.fsid, btrfs_header_fsid(),
1136 write_extent_buffer(buf, chunk_tree_uuid,
1137 btrfs_header_chunk_tree_uuid(buf),
1140 /* create the items for the root tree */
1141 memset(&root_item, 0, sizeof(root_item));
1142 inode_item = &root_item.inode;
1143 btrfs_set_stack_inode_generation(inode_item, 1);
1144 btrfs_set_stack_inode_size(inode_item, 3);
1145 btrfs_set_stack_inode_nlink(inode_item, 1);
1146 btrfs_set_stack_inode_nbytes(inode_item, cfg->nodesize);
1147 btrfs_set_stack_inode_mode(inode_item, S_IFDIR | 0755);
1148 btrfs_set_root_refs(&root_item, 1);
1149 btrfs_set_root_used(&root_item, cfg->nodesize);
1150 btrfs_set_root_generation(&root_item, 1);
1152 memset(&disk_key, 0, sizeof(disk_key));
1153 btrfs_set_disk_key_type(&disk_key, BTRFS_ROOT_ITEM_KEY);
1154 btrfs_set_disk_key_offset(&disk_key, 0);
1157 itemoff = __BTRFS_LEAF_DATA_SIZE(cfg->nodesize) - sizeof(root_item);
1158 btrfs_set_root_bytenr(&root_item, cfg->blocks[2]);
1159 btrfs_set_disk_key_objectid(&disk_key, BTRFS_EXTENT_TREE_OBJECTID);
1160 btrfs_set_item_key(buf, &disk_key, nritems);
1161 btrfs_set_item_offset(buf, btrfs_item_nr(nritems), itemoff);
1162 btrfs_set_item_size(buf, btrfs_item_nr(nritems),
1164 write_extent_buffer(buf, &root_item, btrfs_item_ptr_offset(buf,
1165 nritems), sizeof(root_item));
1168 itemoff = itemoff - sizeof(root_item);
1169 btrfs_set_root_bytenr(&root_item, cfg->blocks[4]);
1170 btrfs_set_disk_key_objectid(&disk_key, BTRFS_DEV_TREE_OBJECTID);
1171 btrfs_set_item_key(buf, &disk_key, nritems);
1172 btrfs_set_item_offset(buf, btrfs_item_nr(nritems), itemoff);
1173 btrfs_set_item_size(buf, btrfs_item_nr(nritems),
1175 write_extent_buffer(buf, &root_item,
1176 btrfs_item_ptr_offset(buf, nritems),
1180 itemoff = itemoff - sizeof(root_item);
1181 btrfs_set_root_bytenr(&root_item, cfg->blocks[5]);
1182 btrfs_set_disk_key_objectid(&disk_key, BTRFS_FS_TREE_OBJECTID);
1183 btrfs_set_item_key(buf, &disk_key, nritems);
1184 btrfs_set_item_offset(buf, btrfs_item_nr(nritems), itemoff);
1185 btrfs_set_item_size(buf, btrfs_item_nr(nritems),
1187 write_extent_buffer(buf, &root_item,
1188 btrfs_item_ptr_offset(buf, nritems),
1192 itemoff = itemoff - sizeof(root_item);
1193 btrfs_set_root_bytenr(&root_item, cfg->blocks[6]);
1194 btrfs_set_disk_key_objectid(&disk_key, BTRFS_CSUM_TREE_OBJECTID);
1195 btrfs_set_item_key(buf, &disk_key, nritems);
1196 btrfs_set_item_offset(buf, btrfs_item_nr(nritems), itemoff);
1197 btrfs_set_item_size(buf, btrfs_item_nr(nritems),
1199 write_extent_buffer(buf, &root_item,
1200 btrfs_item_ptr_offset(buf, nritems),
1205 csum_tree_block_size(buf, BTRFS_CRC32_SIZE, 0);
1206 ret = pwrite(fd, buf->data, cfg->nodesize, cfg->blocks[1]);
1207 if (ret != cfg->nodesize) {
1208 ret = (ret < 0 ? -errno : -EIO);
1212 /* create the items for the extent tree */
1213 memset(buf->data + sizeof(struct btrfs_header), 0,
1214 cfg->nodesize - sizeof(struct btrfs_header));
1216 itemoff = __BTRFS_LEAF_DATA_SIZE(cfg->nodesize);
1217 for (i = 1; i < 7; i++) {
1218 item_size = sizeof(struct btrfs_extent_item);
1219 if (!skinny_metadata)
1220 item_size += sizeof(struct btrfs_tree_block_info);
1222 if (cfg->blocks[i] < first_free) {
1223 error("block[%d] below first free: %llu < %llu",
1224 i, (unsigned long long)cfg->blocks[i],
1225 (unsigned long long)first_free);
1229 if (cfg->blocks[i] < cfg->blocks[i - 1]) {
1230 error("blocks %d and %d in reverse order: %llu < %llu",
1232 (unsigned long long)cfg->blocks[i],
1233 (unsigned long long)cfg->blocks[i - 1]);
1238 /* create extent item */
1239 itemoff -= item_size;
1240 btrfs_set_disk_key_objectid(&disk_key, cfg->blocks[i]);
1241 if (skinny_metadata) {
1242 btrfs_set_disk_key_type(&disk_key,
1243 BTRFS_METADATA_ITEM_KEY);
1244 btrfs_set_disk_key_offset(&disk_key, 0);
1246 btrfs_set_disk_key_type(&disk_key,
1247 BTRFS_EXTENT_ITEM_KEY);
1248 btrfs_set_disk_key_offset(&disk_key, cfg->nodesize);
1250 btrfs_set_item_key(buf, &disk_key, nritems);
1251 btrfs_set_item_offset(buf, btrfs_item_nr(nritems),
1253 btrfs_set_item_size(buf, btrfs_item_nr(nritems),
1255 extent_item = btrfs_item_ptr(buf, nritems,
1256 struct btrfs_extent_item);
1257 btrfs_set_extent_refs(buf, extent_item, 1);
1258 btrfs_set_extent_generation(buf, extent_item, 1);
1259 btrfs_set_extent_flags(buf, extent_item,
1260 BTRFS_EXTENT_FLAG_TREE_BLOCK);
1263 /* create extent ref */
1264 ref_root = reference_root_table[i];
1265 btrfs_set_disk_key_objectid(&disk_key, cfg->blocks[i]);
1266 btrfs_set_disk_key_offset(&disk_key, ref_root);
1267 btrfs_set_disk_key_type(&disk_key, BTRFS_TREE_BLOCK_REF_KEY);
1268 btrfs_set_item_key(buf, &disk_key, nritems);
1269 btrfs_set_item_offset(buf, btrfs_item_nr(nritems),
1271 btrfs_set_item_size(buf, btrfs_item_nr(nritems), 0);
1274 btrfs_set_header_bytenr(buf, cfg->blocks[2]);
1275 btrfs_set_header_owner(buf, BTRFS_EXTENT_TREE_OBJECTID);
1276 btrfs_set_header_nritems(buf, nritems);
1277 csum_tree_block_size(buf, BTRFS_CRC32_SIZE, 0);
1278 ret = pwrite(fd, buf->data, cfg->nodesize, cfg->blocks[2]);
1279 if (ret != cfg->nodesize) {
1280 ret = (ret < 0 ? -errno : -EIO);
1284 /* create the chunk tree */
1285 memset(buf->data + sizeof(struct btrfs_header), 0,
1286 cfg->nodesize - sizeof(struct btrfs_header));
1288 item_size = sizeof(*dev_item);
1289 itemoff = __BTRFS_LEAF_DATA_SIZE(cfg->nodesize) - item_size;
1291 /* first device 1 (there is no device 0) */
1292 btrfs_set_disk_key_objectid(&disk_key, BTRFS_DEV_ITEMS_OBJECTID);
1293 btrfs_set_disk_key_offset(&disk_key, 1);
1294 btrfs_set_disk_key_type(&disk_key, BTRFS_DEV_ITEM_KEY);
1295 btrfs_set_item_key(buf, &disk_key, nritems);
1296 btrfs_set_item_offset(buf, btrfs_item_nr(nritems), itemoff);
1297 btrfs_set_item_size(buf, btrfs_item_nr(nritems), item_size);
1299 dev_item = btrfs_item_ptr(buf, nritems, struct btrfs_dev_item);
1300 btrfs_set_device_id(buf, dev_item, 1);
1301 btrfs_set_device_generation(buf, dev_item, 0);
1302 btrfs_set_device_total_bytes(buf, dev_item, num_bytes);
1303 btrfs_set_device_bytes_used(buf, dev_item,
1304 BTRFS_MKFS_SYSTEM_GROUP_SIZE);
1305 btrfs_set_device_io_align(buf, dev_item, cfg->sectorsize);
1306 btrfs_set_device_io_width(buf, dev_item, cfg->sectorsize);
1307 btrfs_set_device_sector_size(buf, dev_item, cfg->sectorsize);
1308 btrfs_set_device_type(buf, dev_item, 0);
1310 write_extent_buffer(buf, super.dev_item.uuid,
1311 (unsigned long)btrfs_device_uuid(dev_item),
1313 write_extent_buffer(buf, super.fsid,
1314 (unsigned long)btrfs_device_fsid(dev_item),
1316 read_extent_buffer(buf, &super.dev_item, (unsigned long)dev_item,
1320 item_size = btrfs_chunk_item_size(1);
1321 itemoff = itemoff - item_size;
1323 /* then we have chunk 0 */
1324 btrfs_set_disk_key_objectid(&disk_key, BTRFS_FIRST_CHUNK_TREE_OBJECTID);
1325 btrfs_set_disk_key_offset(&disk_key, 0);
1326 btrfs_set_disk_key_type(&disk_key, BTRFS_CHUNK_ITEM_KEY);
1327 btrfs_set_item_key(buf, &disk_key, nritems);
1328 btrfs_set_item_offset(buf, btrfs_item_nr(nritems), itemoff);
1329 btrfs_set_item_size(buf, btrfs_item_nr(nritems), item_size);
1331 chunk = btrfs_item_ptr(buf, nritems, struct btrfs_chunk);
1332 btrfs_set_chunk_length(buf, chunk, BTRFS_MKFS_SYSTEM_GROUP_SIZE);
1333 btrfs_set_chunk_owner(buf, chunk, BTRFS_EXTENT_TREE_OBJECTID);
1334 btrfs_set_chunk_stripe_len(buf, chunk, 64 * 1024);
1335 btrfs_set_chunk_type(buf, chunk, BTRFS_BLOCK_GROUP_SYSTEM);
1336 btrfs_set_chunk_io_align(buf, chunk, cfg->sectorsize);
1337 btrfs_set_chunk_io_width(buf, chunk, cfg->sectorsize);
1338 btrfs_set_chunk_sector_size(buf, chunk, cfg->sectorsize);
1339 btrfs_set_chunk_num_stripes(buf, chunk, 1);
1340 btrfs_set_stripe_devid_nr(buf, chunk, 0, 1);
1341 btrfs_set_stripe_offset_nr(buf, chunk, 0, 0);
1344 write_extent_buffer(buf, super.dev_item.uuid,
1345 (unsigned long)btrfs_stripe_dev_uuid(&chunk->stripe),
1348 /* copy the key for the chunk to the system array */
1349 ptr = super.sys_chunk_array;
1350 array_size = sizeof(disk_key);
1352 memcpy(ptr, &disk_key, sizeof(disk_key));
1353 ptr += sizeof(disk_key);
1355 /* copy the chunk to the system array */
1356 read_extent_buffer(buf, ptr, (unsigned long)chunk, item_size);
1357 array_size += item_size;
1359 btrfs_set_super_sys_array_size(&super, array_size);
1361 btrfs_set_header_bytenr(buf, cfg->blocks[3]);
1362 btrfs_set_header_owner(buf, BTRFS_CHUNK_TREE_OBJECTID);
1363 btrfs_set_header_nritems(buf, nritems);
1364 csum_tree_block_size(buf, BTRFS_CRC32_SIZE, 0);
1365 ret = pwrite(fd, buf->data, cfg->nodesize, cfg->blocks[3]);
1366 if (ret != cfg->nodesize) {
1367 ret = (ret < 0 ? -errno : -EIO);
1371 /* create the device tree */
1372 memset(buf->data + sizeof(struct btrfs_header), 0,
1373 cfg->nodesize - sizeof(struct btrfs_header));
1375 itemoff = __BTRFS_LEAF_DATA_SIZE(cfg->nodesize) -
1376 sizeof(struct btrfs_dev_extent);
1378 btrfs_set_disk_key_objectid(&disk_key, 1);
1379 btrfs_set_disk_key_offset(&disk_key, 0);
1380 btrfs_set_disk_key_type(&disk_key, BTRFS_DEV_EXTENT_KEY);
1381 btrfs_set_item_key(buf, &disk_key, nritems);
1382 btrfs_set_item_offset(buf, btrfs_item_nr(nritems), itemoff);
1383 btrfs_set_item_size(buf, btrfs_item_nr(nritems),
1384 sizeof(struct btrfs_dev_extent));
1385 dev_extent = btrfs_item_ptr(buf, nritems, struct btrfs_dev_extent);
1386 btrfs_set_dev_extent_chunk_tree(buf, dev_extent,
1387 BTRFS_CHUNK_TREE_OBJECTID);
1388 btrfs_set_dev_extent_chunk_objectid(buf, dev_extent,
1389 BTRFS_FIRST_CHUNK_TREE_OBJECTID);
1390 btrfs_set_dev_extent_chunk_offset(buf, dev_extent, 0);
1392 write_extent_buffer(buf, chunk_tree_uuid,
1393 (unsigned long)btrfs_dev_extent_chunk_tree_uuid(dev_extent),
1396 btrfs_set_dev_extent_length(buf, dev_extent,
1397 BTRFS_MKFS_SYSTEM_GROUP_SIZE);
1400 btrfs_set_header_bytenr(buf, cfg->blocks[4]);
1401 btrfs_set_header_owner(buf, BTRFS_DEV_TREE_OBJECTID);
1402 btrfs_set_header_nritems(buf, nritems);
1403 csum_tree_block_size(buf, BTRFS_CRC32_SIZE, 0);
1404 ret = pwrite(fd, buf->data, cfg->nodesize, cfg->blocks[4]);
1405 if (ret != cfg->nodesize) {
1406 ret = (ret < 0 ? -errno : -EIO);
1410 /* create the FS root */
1411 memset(buf->data + sizeof(struct btrfs_header), 0,
1412 cfg->nodesize - sizeof(struct btrfs_header));
1413 btrfs_set_header_bytenr(buf, cfg->blocks[5]);
1414 btrfs_set_header_owner(buf, BTRFS_FS_TREE_OBJECTID);
1415 btrfs_set_header_nritems(buf, 0);
1416 csum_tree_block_size(buf, BTRFS_CRC32_SIZE, 0);
1417 ret = pwrite(fd, buf->data, cfg->nodesize, cfg->blocks[5]);
1418 if (ret != cfg->nodesize) {
1419 ret = (ret < 0 ? -errno : -EIO);
1422 /* finally create the csum root */
1423 memset(buf->data + sizeof(struct btrfs_header), 0,
1424 cfg->nodesize - sizeof(struct btrfs_header));
1425 btrfs_set_header_bytenr(buf, cfg->blocks[6]);
1426 btrfs_set_header_owner(buf, BTRFS_CSUM_TREE_OBJECTID);
1427 btrfs_set_header_nritems(buf, 0);
1428 csum_tree_block_size(buf, BTRFS_CRC32_SIZE, 0);
1429 ret = pwrite(fd, buf->data, cfg->nodesize, cfg->blocks[6]);
1430 if (ret != cfg->nodesize) {
1431 ret = (ret < 0 ? -errno : -EIO);
1435 /* and write out the super block */
1436 memset(buf->data, 0, BTRFS_SUPER_INFO_SIZE);
1437 memcpy(buf->data, &super, sizeof(super));
1438 buf->len = BTRFS_SUPER_INFO_SIZE;
1439 csum_tree_block_size(buf, BTRFS_CRC32_SIZE, 0);
1440 ret = pwrite(fd, buf->data, BTRFS_SUPER_INFO_SIZE, cfg->blocks[0]);
1441 if (ret != BTRFS_SUPER_INFO_SIZE) {
1442 ret = (ret < 0 ? -errno : -EIO);
1454 * Feature stability status and versions: compat <= safe <= default
1456 static const struct btrfs_fs_feature {
1460 * Compatibility with kernel of given version. Filesystem can be
1463 const char *compat_ver;
1465 * Considered safe for use, but is not on by default, even if the
1466 * kernel supports the feature.
1468 const char *safe_ver;
1470 * Considered safe for use and will be turned on by default if
1471 * supported by the running kernel.
1473 const char *default_ver;
1475 } mkfs_features[] = {
1476 { "mixed-bg", BTRFS_FEATURE_INCOMPAT_MIXED_GROUPS,
1477 "2.6.37", "2.6.37", NULL,
1478 "mixed data and metadata block groups" },
1479 { "extref", BTRFS_FEATURE_INCOMPAT_EXTENDED_IREF,
1480 "3.7", "3.12", "3.12",
1481 "increased hardlink limit per file to 65536" },
1482 { "raid56", BTRFS_FEATURE_INCOMPAT_RAID56,
1484 "raid56 extended format" },
1485 { "skinny-metadata", BTRFS_FEATURE_INCOMPAT_SKINNY_METADATA,
1486 "3.10", "3.18", "3.18",
1487 "reduced-size metadata extent refs" },
1488 { "no-holes", BTRFS_FEATURE_INCOMPAT_NO_HOLES,
1489 "3.14", "4.0", NULL,
1490 "no explicit hole extents for files" },
1491 /* Keep this one last */
1492 { "list-all", BTRFS_FEATURE_LIST_ALL, NULL }
1495 static int parse_one_fs_feature(const char *name, u64 *flags)
1500 for (i = 0; i < ARRAY_SIZE(mkfs_features); i++) {
1501 if (name[0] == '^' &&
1502 !strcmp(mkfs_features[i].name, name + 1)) {
1503 *flags &= ~ mkfs_features[i].flag;
1505 } else if (!strcmp(mkfs_features[i].name, name)) {
1506 *flags |= mkfs_features[i].flag;
1514 void btrfs_parse_features_to_string(char *buf, u64 flags)
1520 for (i = 0; i < ARRAY_SIZE(mkfs_features); i++) {
1521 if (flags & mkfs_features[i].flag) {
1524 strcat(buf, mkfs_features[i].name);
1529 void btrfs_process_fs_features(u64 flags)
1533 for (i = 0; i < ARRAY_SIZE(mkfs_features); i++) {
1534 if (flags & mkfs_features[i].flag) {
1535 printf("Turning ON incompat feature '%s': %s\n",
1536 mkfs_features[i].name,
1537 mkfs_features[i].desc);
1542 void btrfs_list_all_fs_features(u64 mask_disallowed)
1546 fprintf(stderr, "Filesystem features available:\n");
1547 for (i = 0; i < ARRAY_SIZE(mkfs_features) - 1; i++) {
1548 const struct btrfs_fs_feature *feat = &mkfs_features[i];
1550 if (feat->flag & mask_disallowed)
1552 fprintf(stderr, "%-20s- %s (0x%llx", feat->name, feat->desc,
1554 if (feat->compat_ver)
1555 fprintf(stderr, ", compat=%s", feat->compat_ver);
1557 fprintf(stderr, ", safe=%s", feat->safe_ver);
1558 if (feat->default_ver)
1559 fprintf(stderr, ", default=%s", feat->default_ver);
1560 fprintf(stderr, ")\n");
1565 * Return NULL if all features were parsed fine, otherwise return the name of
1566 * the first unparsed.
1568 char* btrfs_parse_fs_features(char *namelist, u64 *flags)
1571 char *save_ptr = NULL; /* Satisfy static checkers */
1573 for (this_char = strtok_r(namelist, ",", &save_ptr);
1575 this_char = strtok_r(NULL, ",", &save_ptr)) {
1576 if (parse_one_fs_feature(this_char, flags))
1583 void print_kernel_version(FILE *stream, u32 version)
1587 v[0] = version & 0xFF;
1588 v[1] = (version >> 8) & 0xFF;
1589 v[2] = version >> 16;
1590 fprintf(stream, "%u.%u", v[2], v[1]);
1592 fprintf(stream, ".%u", v[0]);
1595 u32 get_running_kernel_version(void)
1597 struct utsname utsbuf;
1599 char *saveptr = NULL;
1603 if (strcmp(utsbuf.sysname, "Linux") != 0) {
1604 error("unsupported system: %s", utsbuf.sysname);
1608 tmp = strchr(utsbuf.release, '-');
1612 tmp = strtok_r(utsbuf.release, ".", &saveptr);
1613 if (!string_is_numerical(tmp))
1615 version = atoi(tmp) << 16;
1616 tmp = strtok_r(NULL, ".", &saveptr);
1617 if (!string_is_numerical(tmp))
1619 version |= atoi(tmp) << 8;
1620 tmp = strtok_r(NULL, ".", &saveptr);
1622 if (!string_is_numerical(tmp))
1624 version |= atoi(tmp);
1630 u64 btrfs_device_size(int fd, struct stat *st)
1633 if (S_ISREG(st->st_mode)) {
1636 if (!S_ISBLK(st->st_mode)) {
1639 if (ioctl(fd, BLKGETSIZE64, &size) >= 0) {
1645 static int zero_blocks(int fd, off_t start, size_t len)
1647 char *buf = malloc(len);
1653 memset(buf, 0, len);
1654 written = pwrite(fd, buf, len, start);
1661 #define ZERO_DEV_BYTES (2 * 1024 * 1024)
1663 /* don't write outside the device by clamping the region to the device size */
1664 static int zero_dev_clamped(int fd, off_t start, ssize_t len, u64 dev_size)
1666 off_t end = max(start, start + len);
1669 /* and don't overwrite the disk labels on sparc */
1670 start = max(start, 1024);
1671 end = max(end, 1024);
1674 start = min_t(u64, start, dev_size);
1675 end = min_t(u64, end, dev_size);
1677 return zero_blocks(fd, start, end - start);
1680 int btrfs_add_to_fsid(struct btrfs_trans_handle *trans,
1681 struct btrfs_root *root, int fd, const char *path,
1682 u64 device_total_bytes, u32 io_width, u32 io_align,
1685 struct btrfs_super_block *disk_super;
1686 struct btrfs_super_block *super = root->fs_info->super_copy;
1687 struct btrfs_device *device;
1688 struct btrfs_dev_item *dev_item;
1694 device_total_bytes = (device_total_bytes / sectorsize) * sectorsize;
1696 device = calloc(1, sizeof(*device));
1701 buf = calloc(1, sectorsize);
1707 disk_super = (struct btrfs_super_block *)buf;
1708 dev_item = &disk_super->dev_item;
1710 uuid_generate(device->uuid);
1713 device->io_width = io_width;
1714 device->io_align = io_align;
1715 device->sector_size = sectorsize;
1717 device->writeable = 1;
1718 device->total_bytes = device_total_bytes;
1719 device->bytes_used = 0;
1720 device->total_ios = 0;
1721 device->dev_root = root->fs_info->dev_root;
1722 device->name = strdup(path);
1723 if (!device->name) {
1728 INIT_LIST_HEAD(&device->dev_list);
1729 ret = btrfs_add_device(trans, root, device);
1733 fs_total_bytes = btrfs_super_total_bytes(super) + device_total_bytes;
1734 btrfs_set_super_total_bytes(super, fs_total_bytes);
1736 num_devs = btrfs_super_num_devices(super) + 1;
1737 btrfs_set_super_num_devices(super, num_devs);
1739 memcpy(disk_super, super, sizeof(*disk_super));
1741 btrfs_set_super_bytenr(disk_super, BTRFS_SUPER_INFO_OFFSET);
1742 btrfs_set_stack_device_id(dev_item, device->devid);
1743 btrfs_set_stack_device_type(dev_item, device->type);
1744 btrfs_set_stack_device_io_align(dev_item, device->io_align);
1745 btrfs_set_stack_device_io_width(dev_item, device->io_width);
1746 btrfs_set_stack_device_sector_size(dev_item, device->sector_size);
1747 btrfs_set_stack_device_total_bytes(dev_item, device->total_bytes);
1748 btrfs_set_stack_device_bytes_used(dev_item, device->bytes_used);
1749 memcpy(&dev_item->uuid, device->uuid, BTRFS_UUID_SIZE);
1751 ret = pwrite(fd, buf, sectorsize, BTRFS_SUPER_INFO_OFFSET);
1752 BUG_ON(ret != sectorsize);
1755 list_add(&device->dev_list, &root->fs_info->fs_devices->devices);
1756 device->fs_devices = root->fs_info->fs_devices;
1765 static int btrfs_wipe_existing_sb(int fd)
1767 const char *off = NULL;
1772 blkid_probe pr = NULL;
1774 pr = blkid_new_probe();
1778 if (blkid_probe_set_device(pr, fd, 0, 0)) {
1783 ret = blkid_probe_lookup_value(pr, "SBMAGIC_OFFSET", &off, NULL);
1785 ret = blkid_probe_lookup_value(pr, "SBMAGIC", NULL, &len);
1787 if (ret || len == 0 || off == NULL) {
1789 * If lookup fails, the probe did not find any values, eg. for
1790 * a file image or a loop device. Soft error.
1796 offset = strtoll(off, NULL, 10);
1797 if (len > sizeof(buf))
1800 memset(buf, 0, len);
1801 ret = pwrite(fd, buf, len, offset);
1803 error("cannot wipe existing superblock: %s", strerror(errno));
1805 } else if (ret != len) {
1806 error("cannot wipe existing superblock: wrote %d of %zd", ret, len);
1812 blkid_free_probe(pr);
1816 int btrfs_prepare_device(int fd, const char *file, u64 *block_count_ret,
1817 u64 max_block_count, unsigned opflags)
1823 ret = fstat(fd, &st);
1825 error("unable to stat %s: %s", file, strerror(errno));
1829 block_count = btrfs_device_size(fd, &st);
1830 if (block_count == 0) {
1831 error("unable to determine size of %s", file);
1834 if (max_block_count)
1835 block_count = min(block_count, max_block_count);
1837 if (opflags & PREP_DEVICE_DISCARD) {
1839 * We intentionally ignore errors from the discard ioctl. It
1840 * is not necessary for the mkfs functionality but just an
1843 if (discard_range(fd, 0, 0) == 0) {
1844 if (opflags & PREP_DEVICE_VERBOSE)
1845 printf("Performing full device TRIM (%s) ...\n",
1846 pretty_size(block_count));
1847 discard_blocks(fd, 0, block_count);
1851 ret = zero_dev_clamped(fd, 0, ZERO_DEV_BYTES, block_count);
1852 for (i = 0 ; !ret && i < BTRFS_SUPER_MIRROR_MAX; i++)
1853 ret = zero_dev_clamped(fd, btrfs_sb_offset(i),
1854 BTRFS_SUPER_INFO_SIZE, block_count);
1855 if (!ret && (opflags & PREP_DEVICE_ZERO_END))
1856 ret = zero_dev_clamped(fd, block_count - ZERO_DEV_BYTES,
1857 ZERO_DEV_BYTES, block_count);
1860 error("failed to zero device '%s': %s", file, strerror(-ret));
1864 ret = btrfs_wipe_existing_sb(fd);
1866 error("cannot wipe superblocks on %s", file);
1870 *block_count_ret = block_count;
1874 int btrfs_make_root_dir(struct btrfs_trans_handle *trans,
1875 struct btrfs_root *root, u64 objectid)
1878 struct btrfs_inode_item inode_item;
1879 time_t now = time(NULL);
1881 memset(&inode_item, 0, sizeof(inode_item));
1882 btrfs_set_stack_inode_generation(&inode_item, trans->transid);
1883 btrfs_set_stack_inode_size(&inode_item, 0);
1884 btrfs_set_stack_inode_nlink(&inode_item, 1);
1885 btrfs_set_stack_inode_nbytes(&inode_item, root->nodesize);
1886 btrfs_set_stack_inode_mode(&inode_item, S_IFDIR | 0755);
1887 btrfs_set_stack_timespec_sec(&inode_item.atime, now);
1888 btrfs_set_stack_timespec_nsec(&inode_item.atime, 0);
1889 btrfs_set_stack_timespec_sec(&inode_item.ctime, now);
1890 btrfs_set_stack_timespec_nsec(&inode_item.ctime, 0);
1891 btrfs_set_stack_timespec_sec(&inode_item.mtime, now);
1892 btrfs_set_stack_timespec_nsec(&inode_item.mtime, 0);
1893 btrfs_set_stack_timespec_sec(&inode_item.otime, now);
1894 btrfs_set_stack_timespec_nsec(&inode_item.otime, 0);
1896 if (root->fs_info->tree_root == root)
1897 btrfs_set_super_root_dir(root->fs_info->super_copy, objectid);
1899 ret = btrfs_insert_inode(trans, root, objectid, &inode_item);
1903 ret = btrfs_insert_inode_ref(trans, root, "..", 2, objectid, objectid, 0);
1907 btrfs_set_root_dirid(&root->root_item, objectid);
1914 * checks if a path is a block device node
1915 * Returns negative errno on failure, otherwise
1916 * returns 1 for blockdev, 0 for not-blockdev
1918 int is_block_device(const char *path)
1920 struct stat statbuf;
1922 if (stat(path, &statbuf) < 0)
1925 return !!S_ISBLK(statbuf.st_mode);
1929 * check if given path is a mount point
1930 * return 1 if yes. 0 if no. -1 for error
1932 int is_mount_point(const char *path)
1938 f = setmntent("/proc/self/mounts", "r");
1942 while ((mnt = getmntent(f)) != NULL) {
1943 if (strcmp(mnt->mnt_dir, path))
1952 static int is_reg_file(const char *path)
1954 struct stat statbuf;
1956 if (stat(path, &statbuf) < 0)
1958 return S_ISREG(statbuf.st_mode);
1962 * This function checks if the given input parameter is
1964 * return <0 : some error in the given input
1965 * return BTRFS_ARG_UNKNOWN: unknown input
1966 * return BTRFS_ARG_UUID: given input is uuid
1967 * return BTRFS_ARG_MNTPOINT: given input is path
1968 * return BTRFS_ARG_REG: given input is regular file
1969 * return BTRFS_ARG_BLKDEV: given input is block device
1971 int check_arg_type(const char *input)
1974 char path[PATH_MAX];
1979 if (realpath(input, path)) {
1980 if (is_block_device(path) == 1)
1981 return BTRFS_ARG_BLKDEV;
1983 if (is_mount_point(path) == 1)
1984 return BTRFS_ARG_MNTPOINT;
1986 if (is_reg_file(path))
1987 return BTRFS_ARG_REG;
1989 return BTRFS_ARG_UNKNOWN;
1992 if (strlen(input) == (BTRFS_UUID_UNPARSED_SIZE - 1) &&
1993 !uuid_parse(input, uuid))
1994 return BTRFS_ARG_UUID;
1996 return BTRFS_ARG_UNKNOWN;
2000 * Find the mount point for a mounted device.
2001 * On success, returns 0 with mountpoint in *mp.
2002 * On failure, returns -errno (not mounted yields -EINVAL)
2003 * Is noisy on failures, expects to be given a mounted device.
2005 int get_btrfs_mount(const char *dev, char *mp, size_t mp_size)
2010 ret = is_block_device(dev);
2013 error("not a block device: %s", dev);
2016 error("cannot check %s: %s", dev, strerror(-ret));
2021 fd = open(dev, O_RDONLY);
2024 error("cannot open %s: %s", dev, strerror(errno));
2028 ret = check_mounted_where(fd, dev, mp, mp_size, NULL);
2031 } else { /* mounted, all good */
2041 * Given a pathname, return a filehandle to:
2042 * the original pathname or,
2043 * if the pathname is a mounted btrfs device, to its mountpoint.
2045 * On error, return -1, errno should be set.
2047 int open_path_or_dev_mnt(const char *path, DIR **dirstream, int verbose)
2052 if (is_block_device(path)) {
2053 ret = get_btrfs_mount(path, mp, sizeof(mp));
2055 /* not a mounted btrfs dev */
2056 error_on(verbose, "'%s' is not a mounted btrfs device",
2061 ret = open_file_or_dir(mp, dirstream);
2062 error_on(verbose && ret < 0, "can't access '%s': %s",
2063 path, strerror(errno));
2065 ret = btrfs_open_dir(path, dirstream, 1);
2072 * Do the following checks before calling open_file_or_dir():
2073 * 1: path is in a btrfs filesystem
2074 * 2: path is a directory
2076 int btrfs_open_dir(const char *path, DIR **dirstream, int verbose)
2082 if (statfs(path, &stfs) != 0) {
2083 error_on(verbose, "cannot access '%s': %s", path,
2088 if (stfs.f_type != BTRFS_SUPER_MAGIC) {
2089 error_on(verbose, "not a btrfs filesystem: %s", path);
2093 if (stat(path, &st) != 0) {
2094 error_on(verbose, "cannot access '%s': %s", path,
2099 if (!S_ISDIR(st.st_mode)) {
2100 error_on(verbose, "not a directory: %s", path);
2104 ret = open_file_or_dir(path, dirstream);
2106 error_on(verbose, "cannot access '%s': %s", path,
2113 /* checks if a device is a loop device */
2114 static int is_loop_device (const char* device) {
2115 struct stat statbuf;
2117 if(stat(device, &statbuf) < 0)
2120 return (S_ISBLK(statbuf.st_mode) &&
2121 MAJOR(statbuf.st_rdev) == LOOP_MAJOR);
2125 * Takes a loop device path (e.g. /dev/loop0) and returns
2126 * the associated file (e.g. /images/my_btrfs.img) using
2129 static int resolve_loop_device_with_loopdev(const char* loop_dev, char* loop_file)
2133 struct loop_info64 lo64;
2135 fd = open(loop_dev, O_RDONLY | O_NONBLOCK);
2138 ret = ioctl(fd, LOOP_GET_STATUS64, &lo64);
2144 memcpy(loop_file, lo64.lo_file_name, sizeof(lo64.lo_file_name));
2145 loop_file[sizeof(lo64.lo_file_name)] = 0;
2153 /* Takes a loop device path (e.g. /dev/loop0) and returns
2154 * the associated file (e.g. /images/my_btrfs.img) */
2155 static int resolve_loop_device(const char* loop_dev, char* loop_file,
2162 char real_loop_dev[PATH_MAX];
2164 if (!realpath(loop_dev, real_loop_dev))
2166 snprintf(p, PATH_MAX, "/sys/block/%s/loop/backing_file", strrchr(real_loop_dev, '/'));
2167 if (!(f = fopen(p, "r"))) {
2168 if (errno == ENOENT)
2170 * It's possibly a partitioned loop device, which is
2171 * resolvable with loopdev API.
2173 return resolve_loop_device_with_loopdev(loop_dev, loop_file);
2177 snprintf(fmt, 20, "%%%i[^\n]", max_len-1);
2178 ret = fscanf(f, fmt, loop_file);
2187 * Checks whether a and b are identical or device
2188 * files associated with the same block device
2190 static int is_same_blk_file(const char* a, const char* b)
2192 struct stat st_buf_a, st_buf_b;
2193 char real_a[PATH_MAX];
2194 char real_b[PATH_MAX];
2196 if (!realpath(a, real_a))
2197 strncpy_null(real_a, a);
2199 if (!realpath(b, real_b))
2200 strncpy_null(real_b, b);
2202 /* Identical path? */
2203 if (strcmp(real_a, real_b) == 0)
2206 if (stat(a, &st_buf_a) < 0 || stat(b, &st_buf_b) < 0) {
2207 if (errno == ENOENT)
2212 /* Same blockdevice? */
2213 if (S_ISBLK(st_buf_a.st_mode) && S_ISBLK(st_buf_b.st_mode) &&
2214 st_buf_a.st_rdev == st_buf_b.st_rdev) {
2219 if (st_buf_a.st_dev == st_buf_b.st_dev &&
2220 st_buf_a.st_ino == st_buf_b.st_ino) {
2227 /* checks if a and b are identical or device
2228 * files associated with the same block device or
2229 * if one file is a loop device that uses the other
2232 static int is_same_loop_file(const char* a, const char* b)
2234 char res_a[PATH_MAX];
2235 char res_b[PATH_MAX];
2236 const char* final_a = NULL;
2237 const char* final_b = NULL;
2240 /* Resolve a if it is a loop device */
2241 if((ret = is_loop_device(a)) < 0) {
2246 ret = resolve_loop_device(a, res_a, sizeof(res_a));
2257 /* Resolve b if it is a loop device */
2258 if ((ret = is_loop_device(b)) < 0) {
2263 ret = resolve_loop_device(b, res_b, sizeof(res_b));
2274 return is_same_blk_file(final_a, final_b);
2277 /* Checks if a file exists and is a block or regular file*/
2278 static int is_existing_blk_or_reg_file(const char* filename)
2282 if(stat(filename, &st_buf) < 0) {
2289 return (S_ISBLK(st_buf.st_mode) || S_ISREG(st_buf.st_mode));
2292 /* Checks if a file is used (directly or indirectly via a loop device)
2293 * by a device in fs_devices
2295 static int blk_file_in_dev_list(struct btrfs_fs_devices* fs_devices,
2299 struct list_head *head;
2300 struct list_head *cur;
2301 struct btrfs_device *device;
2303 head = &fs_devices->devices;
2304 list_for_each(cur, head) {
2305 device = list_entry(cur, struct btrfs_device, dev_list);
2307 if((ret = is_same_loop_file(device->name, file)))
2315 * Resolve a pathname to a device mapper node to /dev/mapper/<name>
2316 * Returns NULL on invalid input or malloc failure; Other failures
2317 * will be handled by the caller using the input pathame.
2319 char *canonicalize_dm_name(const char *ptname)
2323 char path[PATH_MAX], name[PATH_MAX], *res = NULL;
2325 if (!ptname || !*ptname)
2328 snprintf(path, sizeof(path), "/sys/block/%s/dm/name", ptname);
2329 if (!(f = fopen(path, "r")))
2332 /* read <name>\n from sysfs */
2333 if (fgets(name, sizeof(name), f) && (sz = strlen(name)) > 1) {
2334 name[sz - 1] = '\0';
2335 snprintf(path, sizeof(path), "/dev/mapper/%s", name);
2337 if (access(path, F_OK) == 0)
2345 * Resolve a pathname to a canonical device node, e.g. /dev/sda1 or
2346 * to a device mapper pathname.
2347 * Returns NULL on invalid input or malloc failure; Other failures
2348 * will be handled by the caller using the input pathame.
2350 char *canonicalize_path(const char *path)
2352 char *canonical, *p;
2354 if (!path || !*path)
2357 canonical = realpath(path, NULL);
2359 return strdup(path);
2360 p = strrchr(canonical, '/');
2361 if (p && strncmp(p, "/dm-", 4) == 0 && isdigit(*(p + 4))) {
2362 char *dm = canonicalize_dm_name(p + 1);
2373 * returns 1 if the device was mounted, < 0 on error or 0 if everything
2374 * is safe to continue.
2376 int check_mounted(const char* file)
2381 fd = open(file, O_RDONLY);
2383 error("mount check: cannot open %s: %s", file,
2388 ret = check_mounted_where(fd, file, NULL, 0, NULL);
2394 int check_mounted_where(int fd, const char *file, char *where, int size,
2395 struct btrfs_fs_devices **fs_dev_ret)
2400 struct btrfs_fs_devices *fs_devices_mnt = NULL;
2404 /* scan the initial device */
2405 ret = btrfs_scan_one_device(fd, file, &fs_devices_mnt,
2406 &total_devs, BTRFS_SUPER_INFO_OFFSET, SBREAD_DEFAULT);
2407 is_btrfs = (ret >= 0);
2409 /* scan other devices */
2410 if (is_btrfs && total_devs > 1) {
2411 ret = btrfs_scan_devices();
2416 /* iterate over the list of currently mounted filesystems */
2417 if ((f = setmntent ("/proc/self/mounts", "r")) == NULL)
2420 while ((mnt = getmntent (f)) != NULL) {
2422 if(strcmp(mnt->mnt_type, "btrfs") != 0)
2425 ret = blk_file_in_dev_list(fs_devices_mnt, mnt->mnt_fsname);
2427 /* ignore entries in the mount table that are not
2428 associated with a file*/
2429 if((ret = is_existing_blk_or_reg_file(mnt->mnt_fsname)) < 0)
2430 goto out_mntloop_err;
2434 ret = is_same_loop_file(file, mnt->mnt_fsname);
2438 goto out_mntloop_err;
2443 /* Did we find an entry in mnt table? */
2444 if (mnt && size && where) {
2445 strncpy(where, mnt->mnt_dir, size);
2449 *fs_dev_ret = fs_devices_mnt;
2451 ret = (mnt != NULL);
2459 struct pending_dir {
2460 struct list_head list;
2461 char name[PATH_MAX];
2464 int btrfs_register_one_device(const char *fname)
2466 struct btrfs_ioctl_vol_args args;
2470 fd = open("/dev/btrfs-control", O_RDWR);
2473 "failed to open /dev/btrfs-control, skipping device registration: %s",
2477 memset(&args, 0, sizeof(args));
2478 strncpy_null(args.name, fname);
2479 ret = ioctl(fd, BTRFS_IOC_SCAN_DEV, &args);
2481 error("device scan failed on '%s': %s", fname,
2490 * Register all devices in the fs_uuid list created in the user
2491 * space. Ensure btrfs_scan_devices() is called before this func.
2493 int btrfs_register_all_devices(void)
2497 struct btrfs_fs_devices *fs_devices;
2498 struct btrfs_device *device;
2499 struct list_head *all_uuids;
2501 all_uuids = btrfs_scanned_uuids();
2503 list_for_each_entry(fs_devices, all_uuids, list) {
2504 list_for_each_entry(device, &fs_devices->devices, dev_list) {
2506 err = btrfs_register_one_device(device->name);
2516 int btrfs_device_already_in_root(struct btrfs_root *root, int fd,
2519 struct btrfs_super_block *disk_super;
2523 buf = malloc(BTRFS_SUPER_INFO_SIZE);
2528 ret = pread(fd, buf, BTRFS_SUPER_INFO_SIZE, super_offset);
2529 if (ret != BTRFS_SUPER_INFO_SIZE)
2533 disk_super = (struct btrfs_super_block *)buf;
2535 * Accept devices from the same filesystem, allow partially created
2538 if (btrfs_super_magic(disk_super) != BTRFS_MAGIC &&
2539 btrfs_super_magic(disk_super) != BTRFS_MAGIC_PARTIAL)
2542 if (!memcmp(disk_super->fsid, root->fs_info->super_copy->fsid,
2552 * Note: this function uses a static per-thread buffer. Do not call this
2553 * function more than 10 times within one argument list!
2555 const char *pretty_size_mode(u64 size, unsigned mode)
2557 static __thread int ps_index = 0;
2558 static __thread char ps_array[10][32];
2561 ret = ps_array[ps_index];
2564 (void)pretty_size_snprintf(size, ret, 32, mode);
2569 static const char* unit_suffix_binary[] =
2570 { "B", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB"};
2571 static const char* unit_suffix_decimal[] =
2572 { "B", "kB", "MB", "GB", "TB", "PB", "EB"};
2574 int pretty_size_snprintf(u64 size, char *str, size_t str_size, unsigned unit_mode)
2580 const char** suffix = NULL;
2586 if ((unit_mode & ~UNITS_MODE_MASK) == UNITS_RAW) {
2587 snprintf(str, str_size, "%llu", size);
2591 if ((unit_mode & ~UNITS_MODE_MASK) == UNITS_BINARY) {
2594 suffix = unit_suffix_binary;
2595 } else if ((unit_mode & ~UNITS_MODE_MASK) == UNITS_DECIMAL) {
2598 suffix = unit_suffix_decimal;
2603 fprintf(stderr, "INTERNAL ERROR: unknown unit base, mode %d\n",
2611 switch (unit_mode & UNITS_MODE_MASK) {
2612 case UNITS_TBYTES: base *= mult; num_divs++;
2613 case UNITS_GBYTES: base *= mult; num_divs++;
2614 case UNITS_MBYTES: base *= mult; num_divs++;
2615 case UNITS_KBYTES: num_divs++;
2622 while (size >= mult) {
2628 * If the value is smaller than base, we didn't do any
2629 * division, in that case, base should be 1, not original
2630 * base, or the unit will be wrong
2636 if (num_divs >= ARRAY_SIZE(unit_suffix_binary)) {
2638 printf("INTERNAL ERROR: unsupported unit suffix, index %d\n",
2643 fraction = (float)last_size / base;
2645 return snprintf(str, str_size, "%.2f%s", fraction, suffix[num_divs]);
2649 * __strncpy_null - strncpy with null termination
2650 * @dest: the target array
2651 * @src: the source string
2652 * @n: maximum bytes to copy (size of *dest)
2654 * Like strncpy, but ensures destination is null-terminated.
2656 * Copies the string pointed to by src, including the terminating null
2657 * byte ('\0'), to the buffer pointed to by dest, up to a maximum
2658 * of n bytes. Then ensure that dest is null-terminated.
2660 char *__strncpy_null(char *dest, const char *src, size_t n)
2662 strncpy(dest, src, n);
2669 * Checks to make sure that the label matches our requirements.
2671 0 if everything is safe and usable
2672 -1 if the label is too long
2674 static int check_label(const char *input)
2676 int len = strlen(input);
2678 if (len > BTRFS_LABEL_SIZE - 1) {
2679 error("label %s is too long (max %d)", input,
2680 BTRFS_LABEL_SIZE - 1);
2687 static int set_label_unmounted(const char *dev, const char *label)
2689 struct btrfs_trans_handle *trans;
2690 struct btrfs_root *root;
2693 ret = check_mounted(dev);
2695 error("checking mount status of %s failed: %d", dev, ret);
2699 error("device %s is mounted, use mount point", dev);
2703 /* Open the super_block at the default location
2704 * and as read-write.
2706 root = open_ctree(dev, 0, OPEN_CTREE_WRITES);
2707 if (!root) /* errors are printed by open_ctree() */
2710 trans = btrfs_start_transaction(root, 1);
2711 __strncpy_null(root->fs_info->super_copy->label, label, BTRFS_LABEL_SIZE - 1);
2713 btrfs_commit_transaction(trans, root);
2715 /* Now we close it since we are done. */
2720 static int set_label_mounted(const char *mount_path, const char *labelp)
2723 char label[BTRFS_LABEL_SIZE];
2725 fd = open(mount_path, O_RDONLY | O_NOATIME);
2727 error("unable to access %s: %s", mount_path, strerror(errno));
2731 memset(label, 0, sizeof(label));
2732 __strncpy_null(label, labelp, BTRFS_LABEL_SIZE - 1);
2733 if (ioctl(fd, BTRFS_IOC_SET_FSLABEL, label) < 0) {
2734 error("unable to set label of %s: %s", mount_path,
2744 int get_label_unmounted(const char *dev, char *label)
2746 struct btrfs_root *root;
2749 ret = check_mounted(dev);
2751 error("checking mount status of %s failed: %d", dev, ret);
2755 /* Open the super_block at the default location
2758 root = open_ctree(dev, 0, 0);
2762 __strncpy_null(label, root->fs_info->super_copy->label,
2763 BTRFS_LABEL_SIZE - 1);
2765 /* Now we close it since we are done. */
2771 * If a partition is mounted, try to get the filesystem label via its
2772 * mounted path rather than device. Return the corresponding error
2773 * the user specified the device path.
2775 int get_label_mounted(const char *mount_path, char *labelp)
2777 char label[BTRFS_LABEL_SIZE];
2781 fd = open(mount_path, O_RDONLY | O_NOATIME);
2783 error("unable to access %s: %s", mount_path, strerror(errno));
2787 memset(label, '\0', sizeof(label));
2788 ret = ioctl(fd, BTRFS_IOC_GET_FSLABEL, label);
2790 if (errno != ENOTTY)
2791 error("unable to get label of %s: %s", mount_path,
2798 __strncpy_null(labelp, label, BTRFS_LABEL_SIZE - 1);
2803 int get_label(const char *btrfs_dev, char *label)
2807 ret = is_existing_blk_or_reg_file(btrfs_dev);
2809 ret = get_label_mounted(btrfs_dev, label);
2811 ret = get_label_unmounted(btrfs_dev, label);
2816 int set_label(const char *btrfs_dev, const char *label)
2820 if (check_label(label))
2823 ret = is_existing_blk_or_reg_file(btrfs_dev);
2825 ret = set_label_mounted(btrfs_dev, label);
2827 ret = set_label_unmounted(btrfs_dev, label);
2833 * A not-so-good version fls64. No fascinating optimization since
2834 * no one except parse_size use it
2836 static int fls64(u64 x)
2840 for (i = 0; i <64; i++)
2841 if (x << i & (1ULL << 63))
2846 u64 parse_size(char *s)
2854 error("size value is empty");
2858 error("size value '%s' is less equal than 0", s);
2861 ret = strtoull(s, &endptr, 10);
2863 error("size value '%s' is invalid", s);
2866 if (endptr[0] && endptr[1]) {
2867 error("illegal suffix contains character '%c' in wrong position",
2872 * strtoll returns LLONG_MAX when overflow, if this happens,
2873 * need to call strtoull to get the real size
2875 if (errno == ERANGE && ret == ULLONG_MAX) {
2876 error("size value '%s' is too large for u64", s);
2880 c = tolower(endptr[0]);
2903 error("unknown size descriptor '%c'", c);
2907 /* Check whether ret * mult overflow */
2908 if (fls64(ret) + fls64(mult) - 1 > 64) {
2909 error("size value '%s' is too large for u64", s);
2916 u64 parse_qgroupid(const char *p)
2918 char *s = strchr(p, '/');
2919 const char *ptr_src_end = p + strlen(p);
2920 char *ptr_parse_end = NULL;
2929 /* Numeric format like '0/257' is the primary case */
2931 id = strtoull(p, &ptr_parse_end, 10);
2932 if (ptr_parse_end != ptr_src_end)
2936 level = strtoull(p, &ptr_parse_end, 10);
2937 if (ptr_parse_end != s)
2940 id = strtoull(s + 1, &ptr_parse_end, 10);
2941 if (ptr_parse_end != ptr_src_end)
2944 return (level << BTRFS_QGROUP_LEVEL_SHIFT) | id;
2947 /* Path format like subv at 'my_subvol' is the fallback case */
2948 ret = test_issubvolume(p);
2949 if (ret < 0 || !ret)
2951 fd = open(p, O_RDONLY);
2954 ret = lookup_path_rootid(fd, &id);
2956 error("failed to lookup root id: %s", strerror(-ret));
2963 error("invalid qgroupid or subvolume path: %s", p);
2967 int open_file_or_dir3(const char *fname, DIR **dirstream, int open_flags)
2973 ret = stat(fname, &st);
2977 if (S_ISDIR(st.st_mode)) {
2978 *dirstream = opendir(fname);
2981 fd = dirfd(*dirstream);
2982 } else if (S_ISREG(st.st_mode) || S_ISLNK(st.st_mode)) {
2983 fd = open(fname, open_flags);
2986 * we set this on purpose, in case the caller output
2987 * strerror(errno) as success
2995 closedir(*dirstream);
3002 int open_file_or_dir(const char *fname, DIR **dirstream)
3004 return open_file_or_dir3(fname, dirstream, O_RDWR);
3007 void close_file_or_dir(int fd, DIR *dirstream)
3010 closedir(dirstream);
3015 int get_device_info(int fd, u64 devid,
3016 struct btrfs_ioctl_dev_info_args *di_args)
3020 di_args->devid = devid;
3021 memset(&di_args->uuid, '\0', sizeof(di_args->uuid));
3023 ret = ioctl(fd, BTRFS_IOC_DEV_INFO, di_args);
3024 return ret < 0 ? -errno : 0;
3027 static u64 find_max_device_id(struct btrfs_ioctl_search_args *search_args,
3030 struct btrfs_dev_item *dev_item;
3031 char *buf = search_args->buf;
3033 buf += (nr_items - 1) * (sizeof(struct btrfs_ioctl_search_header)
3034 + sizeof(struct btrfs_dev_item));
3035 buf += sizeof(struct btrfs_ioctl_search_header);
3037 dev_item = (struct btrfs_dev_item *)buf;
3039 return btrfs_stack_device_id(dev_item);
3042 static int search_chunk_tree_for_fs_info(int fd,
3043 struct btrfs_ioctl_fs_info_args *fi_args)
3047 u64 start_devid = 1;
3048 struct btrfs_ioctl_search_args search_args;
3049 struct btrfs_ioctl_search_key *search_key = &search_args.key;
3051 fi_args->num_devices = 0;
3053 max_items = BTRFS_SEARCH_ARGS_BUFSIZE
3054 / (sizeof(struct btrfs_ioctl_search_header)
3055 + sizeof(struct btrfs_dev_item));
3057 search_key->tree_id = BTRFS_CHUNK_TREE_OBJECTID;
3058 search_key->min_objectid = BTRFS_DEV_ITEMS_OBJECTID;
3059 search_key->max_objectid = BTRFS_DEV_ITEMS_OBJECTID;
3060 search_key->min_type = BTRFS_DEV_ITEM_KEY;
3061 search_key->max_type = BTRFS_DEV_ITEM_KEY;
3062 search_key->min_transid = 0;
3063 search_key->max_transid = (u64)-1;
3064 search_key->nr_items = max_items;
3065 search_key->max_offset = (u64)-1;
3068 search_key->min_offset = start_devid;
3070 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &search_args);
3074 fi_args->num_devices += (u64)search_key->nr_items;
3076 if (search_key->nr_items == max_items) {
3077 start_devid = find_max_device_id(&search_args,
3078 search_key->nr_items) + 1;
3082 /* get the lastest max_id to stay consistent with the num_devices */
3083 if (search_key->nr_items == 0)
3085 * last tree_search returns an empty buf, use the devid of
3086 * the last dev_item of the previous tree_search
3088 fi_args->max_id = start_devid - 1;
3090 fi_args->max_id = find_max_device_id(&search_args,
3091 search_key->nr_items);
3097 * For a given path, fill in the ioctl fs_ and info_ args.
3098 * If the path is a btrfs mountpoint, fill info for all devices.
3099 * If the path is a btrfs device, fill in only that device.
3101 * The path provided must be either on a mounted btrfs fs,
3102 * or be a mounted btrfs device.
3104 * Returns 0 on success, or a negative errno.
3106 int get_fs_info(const char *path, struct btrfs_ioctl_fs_info_args *fi_args,
3107 struct btrfs_ioctl_dev_info_args **di_ret)
3114 struct btrfs_fs_devices *fs_devices_mnt = NULL;
3115 struct btrfs_ioctl_dev_info_args *di_args;
3116 struct btrfs_ioctl_dev_info_args tmp;
3118 DIR *dirstream = NULL;
3120 memset(fi_args, 0, sizeof(*fi_args));
3122 if (is_block_device(path) == 1) {
3123 struct btrfs_super_block *disk_super;
3124 char buf[BTRFS_SUPER_INFO_SIZE];
3126 /* Ensure it's mounted, then set path to the mountpoint */
3127 fd = open(path, O_RDONLY);
3130 error("cannot open %s: %s", path, strerror(errno));
3133 ret = check_mounted_where(fd, path, mp, sizeof(mp),
3142 /* Only fill in this one device */
3143 fi_args->num_devices = 1;
3145 disk_super = (struct btrfs_super_block *)buf;
3146 ret = btrfs_read_dev_super(fd, disk_super,
3147 BTRFS_SUPER_INFO_OFFSET, 0);
3152 last_devid = btrfs_stack_device_id(&disk_super->dev_item);
3153 fi_args->max_id = last_devid;
3155 memcpy(fi_args->fsid, fs_devices_mnt->fsid, BTRFS_FSID_SIZE);
3159 /* at this point path must not be for a block device */
3160 fd = open_file_or_dir(path, &dirstream);
3166 /* fill in fi_args if not just a single device */
3167 if (fi_args->num_devices != 1) {
3168 ret = ioctl(fd, BTRFS_IOC_FS_INFO, fi_args);
3175 * The fs_args->num_devices does not include seed devices
3177 ret = search_chunk_tree_for_fs_info(fd, fi_args);
3182 * search_chunk_tree_for_fs_info() will lacks the devid 0
3183 * so manual probe for it here.
3185 ret = get_device_info(fd, 0, &tmp);
3187 fi_args->num_devices++;
3190 if (last_devid == 0)
3195 if (!fi_args->num_devices)
3198 di_args = *di_ret = malloc((fi_args->num_devices) * sizeof(*di_args));
3205 memcpy(di_args, &tmp, sizeof(tmp));
3206 for (; last_devid <= fi_args->max_id; last_devid++) {
3207 ret = get_device_info(fd, last_devid, &di_args[ndevs]);
3216 * only when the only dev we wanted to find is not there then
3217 * let any error be returned
3219 if (fi_args->num_devices != 1) {
3225 close_file_or_dir(fd, dirstream);
3229 #define isoctal(c) (((c) & ~7) == '0')
3231 static inline void translate(char *f, char *t)
3233 while (*f != '\0') {
3235 isoctal(f[1]) && isoctal(f[2]) && isoctal(f[3])) {
3236 *t++ = 64*(f[1] & 7) + 8*(f[2] & 7) + (f[3] & 7);
3246 * Checks if the swap device.
3247 * Returns 1 if swap device, < 0 on error or 0 if not swap device.
3249 static int is_swap_device(const char *file)
3260 if (stat(file, &st_buf) < 0)
3262 if (S_ISBLK(st_buf.st_mode))
3263 dev = st_buf.st_rdev;
3264 else if (S_ISREG(st_buf.st_mode)) {
3265 dev = st_buf.st_dev;
3266 ino = st_buf.st_ino;
3270 if ((f = fopen("/proc/swaps", "r")) == NULL)
3273 /* skip the first line */
3274 if (fgets(tmp, sizeof(tmp), f) == NULL)
3277 while (fgets(tmp, sizeof(tmp), f) != NULL) {
3278 if ((cp = strchr(tmp, ' ')) != NULL)
3280 if ((cp = strchr(tmp, '\t')) != NULL)
3282 translate(tmp, buf);
3283 if (stat(buf, &st_buf) != 0)
3285 if (S_ISBLK(st_buf.st_mode)) {
3286 if (dev == st_buf.st_rdev) {
3290 } else if (S_ISREG(st_buf.st_mode)) {
3291 if (dev == st_buf.st_dev && ino == st_buf.st_ino) {
3305 * Check for existing filesystem or partition table on device.
3307 * 1 for existing fs or partition
3308 * 0 for nothing found
3309 * -1 for internal error
3311 static int check_overwrite(const char *device)
3314 blkid_probe pr = NULL;
3318 if (!device || !*device)
3321 ret = -1; /* will reset on success of all setup calls */
3323 pr = blkid_new_probe_from_filename(device);
3327 size = blkid_probe_get_size(pr);
3331 /* nothing to overwrite on a 0-length device */
3337 ret = blkid_probe_enable_partitions(pr, 1);
3341 ret = blkid_do_fullprobe(pr);
3346 * Blkid returns 1 for nothing found and 0 when it finds a signature,
3347 * but we want the exact opposite, so reverse the return value here.
3349 * In addition print some useful diagnostics about what actually is
3357 if (!blkid_probe_lookup_value(pr, "TYPE", &type, NULL)) {
3359 "%s appears to contain an existing "
3360 "filesystem (%s).\n", device, type);
3361 } else if (!blkid_probe_lookup_value(pr, "PTTYPE", &type, NULL)) {
3363 "%s appears to contain a partition "
3364 "table (%s).\n", device, type);
3367 "%s appears to contain something weird "
3368 "according to blkid\n", device);
3374 blkid_free_probe(pr);
3377 "probe of %s failed, cannot detect "
3378 "existing filesystem.\n", device);
3382 static int group_profile_devs_min(u64 flag)
3384 switch (flag & BTRFS_BLOCK_GROUP_PROFILE_MASK) {
3385 case 0: /* single */
3386 case BTRFS_BLOCK_GROUP_DUP:
3388 case BTRFS_BLOCK_GROUP_RAID0:
3389 case BTRFS_BLOCK_GROUP_RAID1:
3390 case BTRFS_BLOCK_GROUP_RAID5:
3392 case BTRFS_BLOCK_GROUP_RAID6:
3394 case BTRFS_BLOCK_GROUP_RAID10:
3401 int test_num_disk_vs_raid(u64 metadata_profile, u64 data_profile,
3402 u64 dev_cnt, int mixed, int ssd)
3405 u64 profile = metadata_profile | data_profile;
3410 allowed |= BTRFS_BLOCK_GROUP_RAID10;
3412 allowed |= BTRFS_BLOCK_GROUP_RAID6;
3414 allowed |= BTRFS_BLOCK_GROUP_RAID0 | BTRFS_BLOCK_GROUP_RAID1 |
3415 BTRFS_BLOCK_GROUP_RAID5;
3417 allowed |= BTRFS_BLOCK_GROUP_DUP;
3420 if (dev_cnt > 1 && profile & BTRFS_BLOCK_GROUP_DUP) {
3421 warning("DUP is not recommended on filesystem with multiple devices");
3423 if (metadata_profile & ~allowed) {
3425 "ERROR: unable to create FS with metadata profile %s "
3426 "(have %llu devices but %d devices are required)\n",
3427 btrfs_group_profile_str(metadata_profile), dev_cnt,
3428 group_profile_devs_min(metadata_profile));
3431 if (data_profile & ~allowed) {
3433 "ERROR: unable to create FS with data profile %s "
3434 "(have %llu devices but %d devices are required)\n",
3435 btrfs_group_profile_str(data_profile), dev_cnt,
3436 group_profile_devs_min(data_profile));
3440 if (dev_cnt == 3 && profile & BTRFS_BLOCK_GROUP_RAID6) {
3441 warning("RAID6 is not recommended on filesystem with 3 devices only");
3443 if (dev_cnt == 2 && profile & BTRFS_BLOCK_GROUP_RAID5) {
3444 warning("RAID5 is not recommended on filesystem with 2 devices only");
3446 warning_on(!mixed && (data_profile & BTRFS_BLOCK_GROUP_DUP) && ssd,
3447 "DUP may not actually lead to 2 copies on the device, see manual page");
3452 int group_profile_max_safe_loss(u64 flags)
3454 switch (flags & BTRFS_BLOCK_GROUP_PROFILE_MASK) {
3455 case 0: /* single */
3456 case BTRFS_BLOCK_GROUP_DUP:
3457 case BTRFS_BLOCK_GROUP_RAID0:
3459 case BTRFS_BLOCK_GROUP_RAID1:
3460 case BTRFS_BLOCK_GROUP_RAID5:
3461 case BTRFS_BLOCK_GROUP_RAID10:
3463 case BTRFS_BLOCK_GROUP_RAID6:
3471 * Check if a device is suitable for btrfs
3473 * 1: something is wrong, an error is printed
3476 int test_dev_for_mkfs(const char *file, int force_overwrite)
3481 ret = is_swap_device(file);
3483 error("checking status of %s: %s", file, strerror(-ret));
3487 error("%s is a swap device", file);
3490 if (!force_overwrite) {
3491 if (check_overwrite(file)) {
3492 error("use the -f option to force overwrite of %s",
3497 ret = check_mounted(file);
3499 error("cannot check mount status of %s: %s", file,
3504 error("%s is mounted", file);
3507 /* check if the device is busy */
3508 fd = open(file, O_RDWR|O_EXCL);
3510 error("unable to open %s: %s", file, strerror(errno));
3513 if (fstat(fd, &st)) {
3514 error("unable to stat %s: %s", file, strerror(errno));
3518 if (!S_ISBLK(st.st_mode)) {
3519 error("%s is not a block device", file);
3527 int btrfs_scan_devices(void)
3532 struct btrfs_fs_devices *tmp_devices;
3533 blkid_dev_iterate iter = NULL;
3534 blkid_dev dev = NULL;
3535 blkid_cache cache = NULL;
3536 char path[PATH_MAX];
3538 if (btrfs_scan_done)
3541 if (blkid_get_cache(&cache, NULL) < 0) {
3542 error("blkid cache get failed");
3545 blkid_probe_all(cache);
3546 iter = blkid_dev_iterate_begin(cache);
3547 blkid_dev_set_search(iter, "TYPE", "btrfs");
3548 while (blkid_dev_next(iter, &dev) == 0) {
3549 dev = blkid_verify(cache, dev);
3552 /* if we are here its definitely a btrfs disk*/
3553 strncpy_null(path, blkid_dev_devname(dev));
3555 fd = open(path, O_RDONLY);
3557 error("cannot open %s: %s", path, strerror(errno));
3560 ret = btrfs_scan_one_device(fd, path, &tmp_devices,
3561 &num_devices, BTRFS_SUPER_INFO_OFFSET,
3564 error("cannot scan %s: %s", path, strerror(-ret));
3571 blkid_dev_iterate_end(iter);
3572 blkid_put_cache(cache);
3574 btrfs_scan_done = 1;
3579 int is_vol_small(const char *file)
3586 fd = open(file, O_RDONLY);
3589 if (fstat(fd, &st) < 0) {
3594 size = btrfs_device_size(fd, &st);
3599 if (size < BTRFS_MKFS_SMALL_VOLUME_SIZE) {
3609 * This reads a line from the stdin and only returns non-zero if the
3610 * first whitespace delimited token is a case insensitive match with yes
3613 int ask_user(const char *question)
3615 char buf[30] = {0,};
3616 char *saveptr = NULL;
3619 printf("%s [y/N]: ", question);
3621 return fgets(buf, sizeof(buf) - 1, stdin) &&
3622 (answer = strtok_r(buf, " \t\n\r", &saveptr)) &&
3623 (!strcasecmp(answer, "yes") || !strcasecmp(answer, "y"));
3628 * - file or directory return the containing tree root id
3629 * - subvolume return its own tree id
3630 * - BTRFS_EMPTY_SUBVOL_DIR_OBJECTID (directory with ino == 2) the result is
3631 * undefined and function returns -1
3633 int lookup_path_rootid(int fd, u64 *rootid)
3635 struct btrfs_ioctl_ino_lookup_args args;
3638 memset(&args, 0, sizeof(args));
3640 args.objectid = BTRFS_FIRST_FREE_OBJECTID;
3642 ret = ioctl(fd, BTRFS_IOC_INO_LOOKUP, &args);
3646 *rootid = args.treeid;
3652 * return 0 if a btrfs mount point is found
3653 * return 1 if a mount point is found but not btrfs
3654 * return <0 if something goes wrong
3656 int find_mount_root(const char *path, char **mount_root)
3664 int longest_matchlen = 0;
3665 char *longest_match = NULL;
3667 fd = open(path, O_RDONLY | O_NOATIME);
3672 mnttab = setmntent("/proc/self/mounts", "r");
3676 while ((ent = getmntent(mnttab))) {
3677 len = strlen(ent->mnt_dir);
3678 if (strncmp(ent->mnt_dir, path, len) == 0) {
3679 /* match found and use the latest match */
3680 if (longest_matchlen <= len) {
3681 free(longest_match);
3682 longest_matchlen = len;
3683 longest_match = strdup(ent->mnt_dir);
3684 not_btrfs = strcmp(ent->mnt_type, "btrfs");
3693 free(longest_match);
3698 *mount_root = realpath(longest_match, NULL);
3702 free(longest_match);
3706 int test_minimum_size(const char *file, u32 nodesize)
3709 struct stat statbuf;
3711 fd = open(file, O_RDONLY);
3714 if (stat(file, &statbuf) < 0) {
3718 if (btrfs_device_size(fd, &statbuf) < btrfs_min_dev_size(nodesize)) {
3728 * Test if path is a directory
3730 * 0 - path exists but it is not a directory
3731 * 1 - path exists and it is a directory
3734 int test_isdir(const char *path)
3739 ret = stat(path, &st);
3743 return !!S_ISDIR(st.st_mode);
3746 void units_set_mode(unsigned *units, unsigned mode)
3748 unsigned base = *units & UNITS_MODE_MASK;
3750 *units = base | mode;
3753 void units_set_base(unsigned *units, unsigned base)
3755 unsigned mode = *units & ~UNITS_MODE_MASK;
3757 *units = base | mode;
3760 int find_next_key(struct btrfs_path *path, struct btrfs_key *key)
3764 for (level = 0; level < BTRFS_MAX_LEVEL; level++) {
3765 if (!path->nodes[level])
3767 if (path->slots[level] + 1 >=
3768 btrfs_header_nritems(path->nodes[level]))
3771 btrfs_item_key_to_cpu(path->nodes[level], key,
3772 path->slots[level] + 1);
3774 btrfs_node_key_to_cpu(path->nodes[level], key,
3775 path->slots[level] + 1);
3781 const char* btrfs_group_type_str(u64 flag)
3783 u64 mask = BTRFS_BLOCK_GROUP_TYPE_MASK |
3784 BTRFS_SPACE_INFO_GLOBAL_RSV;
3786 switch (flag & mask) {
3787 case BTRFS_BLOCK_GROUP_DATA:
3789 case BTRFS_BLOCK_GROUP_SYSTEM:
3791 case BTRFS_BLOCK_GROUP_METADATA:
3793 case BTRFS_BLOCK_GROUP_DATA|BTRFS_BLOCK_GROUP_METADATA:
3794 return "Data+Metadata";
3795 case BTRFS_SPACE_INFO_GLOBAL_RSV:
3796 return "GlobalReserve";
3802 const char* btrfs_group_profile_str(u64 flag)
3804 switch (flag & BTRFS_BLOCK_GROUP_PROFILE_MASK) {
3807 case BTRFS_BLOCK_GROUP_RAID0:
3809 case BTRFS_BLOCK_GROUP_RAID1:
3811 case BTRFS_BLOCK_GROUP_RAID5:
3813 case BTRFS_BLOCK_GROUP_RAID6:
3815 case BTRFS_BLOCK_GROUP_DUP:
3817 case BTRFS_BLOCK_GROUP_RAID10:
3824 u64 disk_size(const char *path)
3828 if (statfs(path, &sfs) < 0)
3831 return sfs.f_bsize * sfs.f_blocks;
3834 u64 get_partition_size(const char *dev)
3837 int fd = open(dev, O_RDONLY);
3841 if (ioctl(fd, BLKGETSIZE64, &result) < 0) {
3851 * Check if the BTRFS_IOC_TREE_SEARCH_V2 ioctl is supported on a given
3852 * filesystem, opened at fd
3854 int btrfs_tree_search2_ioctl_supported(int fd)
3856 struct btrfs_ioctl_search_args_v2 *args2;
3857 struct btrfs_ioctl_search_key *sk;
3858 int args2_size = 1024;
3859 char args2_buf[args2_size];
3862 args2 = (struct btrfs_ioctl_search_args_v2 *)args2_buf;
3866 * Search for the extent tree item in the root tree.
3868 sk->tree_id = BTRFS_ROOT_TREE_OBJECTID;
3869 sk->min_objectid = BTRFS_EXTENT_TREE_OBJECTID;
3870 sk->max_objectid = BTRFS_EXTENT_TREE_OBJECTID;
3871 sk->min_type = BTRFS_ROOT_ITEM_KEY;
3872 sk->max_type = BTRFS_ROOT_ITEM_KEY;
3874 sk->max_offset = (u64)-1;
3875 sk->min_transid = 0;
3876 sk->max_transid = (u64)-1;
3878 args2->buf_size = args2_size - sizeof(struct btrfs_ioctl_search_args_v2);
3879 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH_V2, args2);
3880 if (ret == -EOPNOTSUPP)
3887 int btrfs_check_nodesize(u32 nodesize, u32 sectorsize, u64 features)
3889 if (nodesize < sectorsize) {
3890 error("illegal nodesize %u (smaller than %u)",
3891 nodesize, sectorsize);
3893 } else if (nodesize > BTRFS_MAX_METADATA_BLOCKSIZE) {
3894 error("illegal nodesize %u (larger than %u)",
3895 nodesize, BTRFS_MAX_METADATA_BLOCKSIZE);
3897 } else if (nodesize & (sectorsize - 1)) {
3898 error("illegal nodesize %u (not aligned to %u)",
3899 nodesize, sectorsize);
3901 } else if (features & BTRFS_FEATURE_INCOMPAT_MIXED_GROUPS &&
3902 nodesize != sectorsize) {
3903 error("illegal nodesize %u (not equal to %u for mixed block group)",
3904 nodesize, sectorsize);
3911 * Copy a path argument from SRC to DEST and check the SRC length if it's at
3912 * most PATH_MAX and fits into DEST. DESTLEN is supposed to be exact size of
3914 * The destination buffer is zero terminated.
3915 * Return < 0 for error, 0 otherwise.
3917 int arg_copy_path(char *dest, const char *src, int destlen)
3919 size_t len = strlen(src);
3921 if (len >= PATH_MAX || len >= destlen)
3922 return -ENAMETOOLONG;
3924 __strncpy_null(dest, src, destlen);
3929 unsigned int get_unit_mode_from_arg(int *argc, char *argv[], int df_mode)
3931 unsigned int unit_mode = UNITS_DEFAULT;
3935 for (arg_i = 0; arg_i < *argc; arg_i++) {
3936 if (!strcmp(argv[arg_i], "--"))
3939 if (!strcmp(argv[arg_i], "--raw")) {
3940 unit_mode = UNITS_RAW;
3944 if (!strcmp(argv[arg_i], "--human-readable")) {
3945 unit_mode = UNITS_HUMAN_BINARY;
3950 if (!strcmp(argv[arg_i], "--iec")) {
3951 units_set_mode(&unit_mode, UNITS_BINARY);
3955 if (!strcmp(argv[arg_i], "--si")) {
3956 units_set_mode(&unit_mode, UNITS_DECIMAL);
3961 if (!strcmp(argv[arg_i], "--kbytes")) {
3962 units_set_base(&unit_mode, UNITS_KBYTES);
3966 if (!strcmp(argv[arg_i], "--mbytes")) {
3967 units_set_base(&unit_mode, UNITS_MBYTES);
3971 if (!strcmp(argv[arg_i], "--gbytes")) {
3972 units_set_base(&unit_mode, UNITS_GBYTES);
3976 if (!strcmp(argv[arg_i], "--tbytes")) {
3977 units_set_base(&unit_mode, UNITS_TBYTES);
3985 if (!strcmp(argv[arg_i], "-b")) {
3986 unit_mode = UNITS_RAW;
3990 if (!strcmp(argv[arg_i], "-h")) {
3991 unit_mode = UNITS_HUMAN_BINARY;
3995 if (!strcmp(argv[arg_i], "-H")) {
3996 unit_mode = UNITS_HUMAN_DECIMAL;
4000 if (!strcmp(argv[arg_i], "-k")) {
4001 units_set_base(&unit_mode, UNITS_KBYTES);
4005 if (!strcmp(argv[arg_i], "-m")) {
4006 units_set_base(&unit_mode, UNITS_MBYTES);
4010 if (!strcmp(argv[arg_i], "-g")) {
4011 units_set_base(&unit_mode, UNITS_GBYTES);
4015 if (!strcmp(argv[arg_i], "-t")) {
4016 units_set_base(&unit_mode, UNITS_TBYTES);
4022 for (arg_i = 0, arg_end = 0; arg_i < *argc; arg_i++) {
4025 argv[arg_end] = argv[arg_i];
4034 int string_is_numerical(const char *str)
4036 if (!(*str >= '0' && *str <= '9'))
4038 while (*str >= '0' && *str <= '9')
4046 * Preprocess @argv with getopt_long to reorder options and consume the "--"
4048 * Unknown short and long options are reported, optionally the @usage is printed
4051 void clean_args_no_options(int argc, char *argv[], const char * const *usagestr)
4053 static const struct option long_options[] = {
4058 int c = getopt_long(argc, argv, "", long_options, NULL);
4072 * Same as clean_args_no_options but pass through arguments that could look
4073 * like short options. Eg. reisze which takes a negative resize argument like
4076 * This accepts only two forms:
4077 * - "-- option1 option2 ..."
4078 * - "option1 option2 ..."
4080 void clean_args_no_options_relaxed(int argc, char *argv[], const char * const *usagestr)
4085 if (strcmp(argv[1], "--") == 0)
4089 /* Subvolume helper functions */
4091 * test if name is a correct subvolume name
4092 * this function return
4093 * 0-> name is not a correct subvolume name
4094 * 1-> name is a correct subvolume name
4096 int test_issubvolname(const char *name)
4098 return name[0] != '\0' && !strchr(name, '/') &&
4099 strcmp(name, ".") && strcmp(name, "..");
4103 * Test if path is a subvolume
4105 * 0 - path exists but it is not a subvolume
4106 * 1 - path exists and it is a subvolume
4109 int test_issubvolume(const char *path)
4115 res = stat(path, &st);
4119 if (st.st_ino != BTRFS_FIRST_FREE_OBJECTID || !S_ISDIR(st.st_mode))
4122 res = statfs(path, &stfs);
4126 return (int)stfs.f_type == BTRFS_SUPER_MAGIC;
4129 const char *subvol_strip_mountpoint(const char *mnt, const char *full_path)
4131 int len = strlen(mnt);
4135 if (mnt[len - 1] != '/')
4138 return full_path + len;
4145 * 1: Error; and error info printed to the terminal. Fixme.
4146 * 2: If the fullpath is root tree instead of subvol tree
4148 int get_subvol_info(const char *fullpath, struct root_info *get_ri)
4155 const char *svpath = NULL;
4156 DIR *dirstream1 = NULL;
4157 DIR *dirstream2 = NULL;
4159 ret = test_issubvolume(fullpath);
4163 error("not a subvolume: %s", fullpath);
4167 ret = find_mount_root(fullpath, &mnt);
4171 error("%s doesn't belong to btrfs mount point", fullpath);
4175 svpath = subvol_strip_mountpoint(mnt, fullpath);
4177 fd = btrfs_open_dir(fullpath, &dirstream1, 1);
4181 ret = btrfs_list_get_path_rootid(fd, &sv_id);
4185 mntfd = btrfs_open_dir(mnt, &dirstream2, 1);
4189 memset(get_ri, 0, sizeof(*get_ri));
4190 get_ri->root_id = sv_id;
4192 if (sv_id == BTRFS_FS_TREE_OBJECTID)
4193 ret = btrfs_get_toplevel_subvol(mntfd, get_ri);
4195 ret = btrfs_get_subvol(mntfd, get_ri);
4197 error("can't find '%s': %d", svpath, ret);
4200 close_file_or_dir(mntfd, dirstream2);
4201 close_file_or_dir(fd, dirstream1);
4207 void init_rand_seed(u64 seed)
4211 /* only use the last 48 bits */
4212 for (i = 0; i < 3; i++) {
4213 rand_seed[i] = (unsigned short)(seed ^ (unsigned short)(-1));
4216 rand_seed_initlized = 1;
4219 static void __init_seed(void)
4225 if(rand_seed_initlized)
4227 /* Use urandom as primary seed source. */
4228 fd = open("/dev/urandom", O_RDONLY);
4230 ret = read(fd, rand_seed, sizeof(rand_seed));
4232 if (ret < sizeof(rand_seed))
4236 /* Use time and pid as fallback seed */
4237 warning("failed to read /dev/urandom, use time and pid as random seed");
4238 gettimeofday(&tv, 0);
4239 rand_seed[0] = getpid() ^ (tv.tv_sec & 0xFFFF);
4240 rand_seed[1] = getppid() ^ (tv.tv_usec & 0xFFFF);
4241 rand_seed[2] = (tv.tv_sec ^ tv.tv_usec) >> 16;
4243 rand_seed_initlized = 1;
4250 * Don't use nrand48, its range is [0,2^31) The highest bit will alwasy
4251 * be 0. Use jrand48 to include the highest bit.
4253 return (u32)jrand48(rand_seed);
4256 unsigned int rand_range(unsigned int upper)
4260 * Use the full 48bits to mod, which would be more uniformly
4263 return (unsigned int)(jrand48(rand_seed) % upper);