2 * Copyright (C) 2008 Oracle. All rights reserved.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public
6 * License v2 as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
13 * You should have received a copy of the GNU General Public
14 * License along with this program; if not, write to the
15 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
16 * Boston, MA 021110-1307, USA.
19 #define _XOPEN_SOURCE 500
24 #include <sys/types.h>
30 #include "kerncompat.h"
34 #include "transaction.h"
39 #define HEADER_MAGIC 0xbd5c25e27295668bULL
40 #define MAX_PENDING_SIZE (256 * 1024)
41 #define BLOCK_SIZE 1024
42 #define BLOCK_MASK (BLOCK_SIZE - 1)
44 #define COMPRESS_NONE 0
45 #define COMPRESS_ZLIB 1
47 struct meta_cluster_item {
50 } __attribute__ ((__packed__));
52 struct meta_cluster_header {
57 } __attribute__ ((__packed__));
59 /* cluster header + index items + buffers */
61 struct meta_cluster_header header;
62 struct meta_cluster_item items[];
63 } __attribute__ ((__packed__));
65 #define ITEMS_PER_CLUSTER ((BLOCK_SIZE - sizeof(struct meta_cluster)) / \
66 sizeof(struct meta_cluster_item))
69 struct list_head list;
70 struct list_head ordered;
78 struct metadump_struct {
79 struct btrfs_root *root;
82 struct meta_cluster *cluster;
86 pthread_mutex_t mutex;
89 struct list_head list;
90 struct list_head ordered;
101 struct mdrestore_struct {
107 pthread_mutex_t mutex;
110 struct list_head list;
118 static void csum_block(u8 *buf, size_t len)
120 char result[BTRFS_CRC32_SIZE];
122 crc = crc32c(crc, buf + BTRFS_CSUM_SIZE, len - BTRFS_CSUM_SIZE);
123 btrfs_csum_final(crc, result);
124 memcpy(buf, result, BTRFS_CRC32_SIZE);
128 * zero inline extents and csum items
130 static void zero_items(u8 *dst, struct extent_buffer *src)
132 struct btrfs_file_extent_item *fi;
133 struct btrfs_item *item;
134 struct btrfs_key key;
135 u32 nritems = btrfs_header_nritems(src);
140 for (i = 0; i < nritems; i++) {
141 item = btrfs_item_nr(src, i);
142 btrfs_item_key_to_cpu(src, &key, i);
143 if (key.type == BTRFS_CSUM_ITEM_KEY) {
144 size = btrfs_item_size_nr(src, i);
145 memset(dst + btrfs_leaf_data(src) +
146 btrfs_item_offset_nr(src, i), 0, size);
149 if (key.type != BTRFS_EXTENT_DATA_KEY)
152 fi = btrfs_item_ptr(src, i, struct btrfs_file_extent_item);
153 extent_type = btrfs_file_extent_type(src, fi);
154 if (extent_type != BTRFS_FILE_EXTENT_INLINE)
157 ptr = btrfs_file_extent_inline_start(fi);
158 size = btrfs_file_extent_inline_item_len(src, item);
159 memset(dst + ptr, 0, size);
164 * copy buffer and zero useless data in the buffer
166 static void copy_buffer(u8 *dst, struct extent_buffer *src)
172 memcpy(dst, src->data, src->len);
173 if (src->start == BTRFS_SUPER_INFO_OFFSET)
176 level = btrfs_header_level(src);
177 nritems = btrfs_header_nritems(src);
180 size = sizeof(struct btrfs_header);
181 memset(dst + size, 0, src->len - size);
182 } else if (level == 0) {
183 size = btrfs_leaf_data(src) +
184 btrfs_item_offset_nr(src, nritems - 1) -
185 btrfs_item_nr_offset(nritems);
186 memset(dst + btrfs_item_nr_offset(nritems), 0, size);
187 zero_items(dst, src);
189 size = offsetof(struct btrfs_node, ptrs) +
190 sizeof(struct btrfs_key_ptr) * nritems;
191 memset(dst + size, 0, src->len - size);
193 csum_block(dst, src->len);
196 static void *dump_worker(void *data)
198 struct metadump_struct *md = (struct metadump_struct *)data;
199 struct async_work *async;
203 pthread_mutex_lock(&md->mutex);
204 while (list_empty(&md->list)) {
206 pthread_mutex_unlock(&md->mutex);
209 pthread_cond_wait(&md->cond, &md->mutex);
211 async = list_entry(md->list.next, struct async_work, list);
212 list_del_init(&async->list);
213 pthread_mutex_unlock(&md->mutex);
215 if (md->compress_level > 0) {
216 u8 *orig = async->buffer;
218 async->bufsize = compressBound(async->size);
219 async->buffer = malloc(async->bufsize);
221 ret = compress2(async->buffer,
222 (unsigned long *)&async->bufsize,
223 orig, async->size, md->compress_level);
231 pthread_mutex_lock(&md->mutex);
233 pthread_mutex_unlock(&md->mutex);
239 static void meta_cluster_init(struct metadump_struct *md, u64 start)
241 struct meta_cluster_header *header;
245 header = &md->cluster->header;
246 header->magic = cpu_to_le64(HEADER_MAGIC);
247 header->bytenr = cpu_to_le64(start);
248 header->nritems = cpu_to_le32(0);
249 header->compress = md->compress_level > 0 ?
250 COMPRESS_ZLIB : COMPRESS_NONE;
253 static int metadump_init(struct metadump_struct *md, struct btrfs_root *root,
254 FILE *out, int num_threads, int compress_level)
258 memset(md, 0, sizeof(*md));
259 pthread_cond_init(&md->cond, NULL);
260 pthread_mutex_init(&md->mutex, NULL);
261 INIT_LIST_HEAD(&md->list);
262 INIT_LIST_HEAD(&md->ordered);
265 md->pending_start = (u64)-1;
266 md->compress_level = compress_level;
267 md->cluster = calloc(1, BLOCK_SIZE);
269 pthread_cond_destroy(&md->cond);
270 pthread_mutex_destroy(&md->mutex);
274 meta_cluster_init(md, 0);
278 md->num_threads = num_threads;
279 md->threads = calloc(num_threads, sizeof(pthread_t));
282 pthread_cond_destroy(&md->cond);
283 pthread_mutex_destroy(&md->mutex);
287 for (i = 0; i < num_threads; i++) {
288 ret = pthread_create(md->threads + i, NULL, dump_worker, md);
294 pthread_mutex_lock(&md->mutex);
296 pthread_cond_broadcast(&md->cond);
297 pthread_mutex_unlock(&md->mutex);
299 for (i--; i >= 0; i--)
300 pthread_join(md->threads[i], NULL);
302 pthread_cond_destroy(&md->cond);
303 pthread_mutex_destroy(&md->mutex);
311 static void metadump_destroy(struct metadump_struct *md)
314 pthread_mutex_lock(&md->mutex);
316 pthread_cond_broadcast(&md->cond);
317 pthread_mutex_unlock(&md->mutex);
319 for (i = 0; i < md->num_threads; i++)
320 pthread_join(md->threads[i], NULL);
322 pthread_cond_destroy(&md->cond);
323 pthread_mutex_destroy(&md->mutex);
328 static int write_zero(FILE *out, size_t size)
330 static char zero[BLOCK_SIZE];
331 return fwrite(zero, size, 1, out);
334 static int write_buffers(struct metadump_struct *md, u64 *next)
336 struct meta_cluster_header *header = &md->cluster->header;
337 struct meta_cluster_item *item;
338 struct async_work *async;
344 if (list_empty(&md->ordered))
347 /* wait until all buffers are compressed */
348 while (md->num_items > md->num_ready) {
349 struct timespec ts = {
353 pthread_mutex_unlock(&md->mutex);
354 nanosleep(&ts, NULL);
355 pthread_mutex_lock(&md->mutex);
358 /* setup and write index block */
359 list_for_each_entry(async, &md->ordered, ordered) {
360 item = md->cluster->items + nritems;
361 item->bytenr = cpu_to_le64(async->start);
362 item->size = cpu_to_le32(async->bufsize);
365 header->nritems = cpu_to_le32(nritems);
367 ret = fwrite(md->cluster, BLOCK_SIZE, 1, md->out);
369 fprintf(stderr, "Error writing out cluster: %d\n", errno);
374 bytenr += le64_to_cpu(header->bytenr) + BLOCK_SIZE;
375 while (!list_empty(&md->ordered)) {
376 async = list_entry(md->ordered.next, struct async_work,
378 list_del_init(&async->ordered);
380 bytenr += async->bufsize;
382 ret = fwrite(async->buffer, async->bufsize, 1,
387 fprintf(stderr, "Error writing out cluster: %d\n",
395 /* zero unused space in the last block */
396 if (!err && bytenr & BLOCK_MASK) {
397 size_t size = BLOCK_SIZE - (bytenr & BLOCK_MASK);
400 ret = write_zero(md->out, size);
402 fprintf(stderr, "Error zeroing out buffer: %d\n",
412 static int flush_pending(struct metadump_struct *md, int done)
414 struct async_work *async = NULL;
415 struct extent_buffer *eb;
416 u64 blocksize = md->root->nodesize;
422 if (md->pending_size) {
423 async = calloc(1, sizeof(*async));
427 async->start = md->pending_start;
428 async->size = md->pending_size;
429 async->bufsize = async->size;
430 async->buffer = malloc(async->bufsize);
431 if (!async->buffer) {
436 start = async->start;
439 eb = read_tree_block(md->root, start, blocksize, 0);
444 "Error reading metadata block\n");
447 copy_buffer(async->buffer + offset, eb);
448 free_extent_buffer(eb);
454 md->pending_start = (u64)-1;
455 md->pending_size = 0;
460 pthread_mutex_lock(&md->mutex);
462 list_add_tail(&async->ordered, &md->ordered);
464 if (md->compress_level > 0) {
465 list_add_tail(&async->list, &md->list);
466 pthread_cond_signal(&md->cond);
471 if (md->num_items >= ITEMS_PER_CLUSTER || done) {
472 ret = write_buffers(md, &start);
474 fprintf(stderr, "Error writing buffers %d\n",
477 meta_cluster_init(md, start);
479 pthread_mutex_unlock(&md->mutex);
483 static int add_metadata(u64 start, u64 size, struct metadump_struct *md)
486 if (md->pending_size + size > MAX_PENDING_SIZE ||
487 md->pending_start + md->pending_size != start) {
488 ret = flush_pending(md, 0);
491 md->pending_start = start;
493 readahead_tree_block(md->root, start, size, 0);
494 md->pending_size += size;
498 #ifdef BTRFS_COMPAT_EXTENT_TREE_V0
499 static int is_tree_block(struct btrfs_root *extent_root,
500 struct btrfs_path *path, u64 bytenr)
502 struct extent_buffer *leaf;
503 struct btrfs_key key;
507 leaf = path->nodes[0];
509 struct btrfs_extent_ref_v0 *ref_item;
511 if (path->slots[0] >= btrfs_header_nritems(leaf)) {
512 ret = btrfs_next_leaf(extent_root, path);
517 leaf = path->nodes[0];
519 btrfs_item_key_to_cpu(leaf, &key, path->slots[0]);
520 if (key.objectid != bytenr)
522 if (key.type != BTRFS_EXTENT_REF_V0_KEY)
524 ref_item = btrfs_item_ptr(leaf, path->slots[0],
525 struct btrfs_extent_ref_v0);
526 ref_objectid = btrfs_ref_objectid_v0(leaf, ref_item);
527 if (ref_objectid < BTRFS_FIRST_FREE_OBJECTID)
535 static int create_metadump(const char *input, FILE *out, int num_threads,
538 struct btrfs_root *root;
539 struct btrfs_root *extent_root;
540 struct btrfs_path *path = NULL;
541 struct extent_buffer *leaf;
542 struct btrfs_extent_item *ei;
543 struct btrfs_key key;
544 struct metadump_struct metadump;
550 root = open_ctree(input, 0, 0);
552 fprintf(stderr, "Open ctree failed\n");
556 BUG_ON(root->nodesize != root->leafsize);
558 ret = metadump_init(&metadump, root, out, num_threads,
561 fprintf(stderr, "Error initing metadump %d\n", ret);
566 ret = add_metadata(BTRFS_SUPER_INFO_OFFSET, 4096, &metadump);
568 fprintf(stderr, "Error adding metadata %d\n", ret);
573 extent_root = root->fs_info->extent_root;
574 path = btrfs_alloc_path();
576 fprintf(stderr, "Out of memory allocing path\n");
580 bytenr = BTRFS_SUPER_INFO_OFFSET + 4096;
581 key.objectid = bytenr;
582 key.type = BTRFS_EXTENT_ITEM_KEY;
585 ret = btrfs_search_slot(NULL, extent_root, &key, path, 0, 0);
587 fprintf(stderr, "Error searching extent root %d\n", ret);
593 leaf = path->nodes[0];
594 if (path->slots[0] >= btrfs_header_nritems(leaf)) {
595 ret = btrfs_next_leaf(extent_root, path);
597 fprintf(stderr, "Error going to next leaf %d"
604 leaf = path->nodes[0];
607 btrfs_item_key_to_cpu(leaf, &key, path->slots[0]);
608 if (key.objectid < bytenr ||
609 key.type != BTRFS_EXTENT_ITEM_KEY) {
614 bytenr = key.objectid;
615 num_bytes = key.offset;
617 if (btrfs_item_size_nr(leaf, path->slots[0]) > sizeof(*ei)) {
618 ei = btrfs_item_ptr(leaf, path->slots[0],
619 struct btrfs_extent_item);
620 if (btrfs_extent_flags(leaf, ei) &
621 BTRFS_EXTENT_FLAG_TREE_BLOCK) {
622 ret = add_metadata(bytenr, num_bytes,
625 fprintf(stderr, "Error adding block "
632 #ifdef BTRFS_COMPAT_EXTENT_TREE_V0
633 ret = is_tree_block(extent_root, path, bytenr);
635 fprintf(stderr, "Error checking tree block "
642 ret = add_metadata(bytenr, num_bytes,
645 fprintf(stderr, "Error adding block "
652 fprintf(stderr, "Either extent tree corruption or "
653 "you haven't built with V0 support\n");
662 ret = flush_pending(&metadump, 1);
666 fprintf(stderr, "Error flushing pending %d\n", ret);
669 metadump_destroy(&metadump);
671 btrfs_free_path(path);
672 ret = close_ctree(root);
673 return err ? err : ret;
676 static void update_super(u8 *buffer)
678 struct btrfs_super_block *super = (struct btrfs_super_block *)buffer;
679 struct btrfs_chunk *chunk;
680 struct btrfs_disk_key *key;
681 u32 sectorsize = btrfs_super_sectorsize(super);
682 u64 flags = btrfs_super_flags(super);
684 flags |= BTRFS_SUPER_FLAG_METADUMP;
685 btrfs_set_super_flags(super, flags);
687 key = (struct btrfs_disk_key *)(super->sys_chunk_array);
688 chunk = (struct btrfs_chunk *)(super->sys_chunk_array +
689 sizeof(struct btrfs_disk_key));
691 btrfs_set_disk_key_objectid(key, BTRFS_FIRST_CHUNK_TREE_OBJECTID);
692 btrfs_set_disk_key_type(key, BTRFS_CHUNK_ITEM_KEY);
693 btrfs_set_disk_key_offset(key, 0);
695 btrfs_set_stack_chunk_length(chunk, (u64)-1);
696 btrfs_set_stack_chunk_owner(chunk, BTRFS_EXTENT_TREE_OBJECTID);
697 btrfs_set_stack_chunk_stripe_len(chunk, 64 * 1024);
698 btrfs_set_stack_chunk_type(chunk, BTRFS_BLOCK_GROUP_SYSTEM);
699 btrfs_set_stack_chunk_io_align(chunk, sectorsize);
700 btrfs_set_stack_chunk_io_width(chunk, sectorsize);
701 btrfs_set_stack_chunk_sector_size(chunk, sectorsize);
702 btrfs_set_stack_chunk_num_stripes(chunk, 1);
703 btrfs_set_stack_chunk_sub_stripes(chunk, 0);
704 chunk->stripe.devid = super->dev_item.devid;
705 chunk->stripe.offset = cpu_to_le64(0);
706 memcpy(chunk->stripe.dev_uuid, super->dev_item.uuid, BTRFS_UUID_SIZE);
707 btrfs_set_super_sys_array_size(super, sizeof(*key) + sizeof(*chunk));
708 csum_block(buffer, 4096);
711 static void *restore_worker(void *data)
713 struct mdrestore_struct *mdres = (struct mdrestore_struct *)data;
714 struct async_work *async;
721 outfd = fileno(mdres->out);
722 buffer = malloc(MAX_PENDING_SIZE * 2);
724 fprintf(stderr, "Error allocing buffer\n");
725 pthread_mutex_lock(&mdres->mutex);
727 mdres->error = -ENOMEM;
728 pthread_mutex_unlock(&mdres->mutex);
735 pthread_mutex_lock(&mdres->mutex);
736 while (list_empty(&mdres->list)) {
738 pthread_mutex_unlock(&mdres->mutex);
741 pthread_cond_wait(&mdres->cond, &mdres->mutex);
743 async = list_entry(mdres->list.next, struct async_work, list);
744 list_del_init(&async->list);
745 pthread_mutex_unlock(&mdres->mutex);
747 if (mdres->compress_method == COMPRESS_ZLIB) {
748 size = MAX_PENDING_SIZE * 2;
749 ret = uncompress(buffer, (unsigned long *)&size,
750 async->buffer, async->bufsize);
752 fprintf(stderr, "Error decompressing %d\n",
758 outbuf = async->buffer;
759 size = async->bufsize;
762 if (async->start == BTRFS_SUPER_INFO_OFFSET)
763 update_super(outbuf);
765 ret = pwrite64(outfd, outbuf, size, async->start);
768 fprintf(stderr, "Error writing to device %d\n",
772 fprintf(stderr, "Short write\n");
777 pthread_mutex_lock(&mdres->mutex);
778 if (err && !mdres->error)
781 pthread_mutex_unlock(&mdres->mutex);
791 static void mdrestore_destroy(struct mdrestore_struct *mdres)
794 pthread_mutex_lock(&mdres->mutex);
796 pthread_cond_broadcast(&mdres->cond);
797 pthread_mutex_unlock(&mdres->mutex);
799 for (i = 0; i < mdres->num_threads; i++)
800 pthread_join(mdres->threads[i], NULL);
802 pthread_cond_destroy(&mdres->cond);
803 pthread_mutex_destroy(&mdres->mutex);
804 free(mdres->threads);
807 static int mdrestore_init(struct mdrestore_struct *mdres,
808 FILE *in, FILE *out, int num_threads)
812 memset(mdres, 0, sizeof(*mdres));
813 pthread_cond_init(&mdres->cond, NULL);
814 pthread_mutex_init(&mdres->mutex, NULL);
815 INIT_LIST_HEAD(&mdres->list);
822 mdres->num_threads = num_threads;
823 mdres->threads = calloc(num_threads, sizeof(pthread_t));
826 for (i = 0; i < num_threads; i++) {
827 ret = pthread_create(mdres->threads + i, NULL, restore_worker,
833 mdrestore_destroy(mdres);
837 static int add_cluster(struct meta_cluster *cluster,
838 struct mdrestore_struct *mdres, u64 *next)
840 struct meta_cluster_item *item;
841 struct meta_cluster_header *header = &cluster->header;
842 struct async_work *async;
847 BUG_ON(mdres->num_items);
848 mdres->compress_method = header->compress;
850 bytenr = le64_to_cpu(header->bytenr) + BLOCK_SIZE;
851 nritems = le32_to_cpu(header->nritems);
852 for (i = 0; i < nritems; i++) {
853 item = &cluster->items[i];
854 async = calloc(1, sizeof(*async));
856 fprintf(stderr, "Error allocating async\n");
859 async->start = le64_to_cpu(item->bytenr);
860 async->bufsize = le32_to_cpu(item->size);
861 async->buffer = malloc(async->bufsize);
862 if (!async->buffer) {
863 fprintf(stderr, "Error allocing async buffer\n");
867 ret = fread(async->buffer, async->bufsize, 1, mdres->in);
869 fprintf(stderr, "Error reading buffer %d\n", errno);
874 bytenr += async->bufsize;
876 pthread_mutex_lock(&mdres->mutex);
877 list_add_tail(&async->list, &mdres->list);
879 pthread_cond_signal(&mdres->cond);
880 pthread_mutex_unlock(&mdres->mutex);
882 if (bytenr & BLOCK_MASK) {
883 char buffer[BLOCK_MASK];
884 size_t size = BLOCK_SIZE - (bytenr & BLOCK_MASK);
887 ret = fread(buffer, size, 1, mdres->in);
889 fprintf(stderr, "Error reading in buffer %d\n", errno);
897 static int wait_for_worker(struct mdrestore_struct *mdres)
901 pthread_mutex_lock(&mdres->mutex);
903 while (!ret && mdres->num_items > 0) {
904 struct timespec ts = {
908 pthread_mutex_unlock(&mdres->mutex);
909 nanosleep(&ts, NULL);
910 pthread_mutex_lock(&mdres->mutex);
913 pthread_mutex_unlock(&mdres->mutex);
917 static int restore_metadump(const char *input, FILE *out, int num_threads)
919 struct meta_cluster *cluster = NULL;
920 struct meta_cluster_header *header;
921 struct mdrestore_struct mdrestore;
926 if (!strcmp(input, "-")) {
929 in = fopen(input, "r");
931 perror("unable to open metadump image");
936 cluster = malloc(BLOCK_SIZE);
938 fprintf(stderr, "Error allocating cluster\n");
944 ret = mdrestore_init(&mdrestore, in, out, num_threads);
946 fprintf(stderr, "Error initing mdrestore %d\n", ret);
954 ret = fread(cluster, BLOCK_SIZE, 1, in);
958 header = &cluster->header;
959 if (le64_to_cpu(header->magic) != HEADER_MAGIC ||
960 le64_to_cpu(header->bytenr) != bytenr) {
961 fprintf(stderr, "bad header in metadump image\n");
965 ret = add_cluster(cluster, &mdrestore, &bytenr);
967 fprintf(stderr, "Error adding cluster\n");
971 ret = wait_for_worker(&mdrestore);
973 fprintf(stderr, "One of the threads errored out %d\n",
979 mdrestore_destroy(&mdrestore);
986 static void print_usage(void)
988 fprintf(stderr, "usage: btrfs-image [options] source target\n");
989 fprintf(stderr, "\t-r \trestore metadump image\n");
990 fprintf(stderr, "\t-c value\tcompression level (0 ~ 9)\n");
991 fprintf(stderr, "\t-t value\tnumber of threads (1 ~ 32)\n");
995 int main(int argc, char *argv[])
1000 int compress_level = 0;
1006 int c = getopt(argc, argv, "rc:t:");
1014 num_threads = atoi(optarg);
1015 if (num_threads <= 0 || num_threads > 32)
1019 compress_level = atoi(optarg);
1020 if (compress_level < 0 || compress_level > 9)
1028 argc = argc - optind;
1031 source = argv[optind];
1032 target = argv[optind + 1];
1034 if (create && !strcmp(target, "-")) {
1037 out = fopen(target, "w+");
1039 perror("unable to create target file");
1044 if (num_threads == 0 && compress_level > 0) {
1045 num_threads = sysconf(_SC_NPROCESSORS_ONLN);
1046 if (num_threads <= 0)
1051 ret = create_metadump(source, out, num_threads,
1054 ret = restore_metadump(source, out, 1);