1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18#include "qemu/osdep.h"
19#include "qapi/error.h"
20#include "qemu-common.h"
21#include "block/block_int.h"
22#include "sysemu/block-backend.h"
23#include "qemu/module.h"
24#include "qemu/crc32c.h"
25#include "qemu/bswap.h"
26#include "block/vhdx.h"
27#include "migration/blocker.h"
28#include "qemu/uuid.h"
29
30
31
32#define VHDX_BLOCK_OPT_LOG_SIZE "log_size"
33#define VHDX_BLOCK_OPT_BLOCK_SIZE "block_size"
34#define VHDX_BLOCK_OPT_ZERO "block_state_zero"
35
36typedef enum VHDXImageType {
37 VHDX_TYPE_DYNAMIC = 0,
38 VHDX_TYPE_FIXED,
39 VHDX_TYPE_DIFFERENCING,
40} VHDXImageType;
41
42
43
44
45
46
47static const MSGUID bat_guid = { .data1 = 0x2dc27766,
48 .data2 = 0xf623,
49 .data3 = 0x4200,
50 .data4 = { 0x9d, 0x64, 0x11, 0x5e,
51 0x9b, 0xfd, 0x4a, 0x08} };
52
53static const MSGUID metadata_guid = { .data1 = 0x8b7ca206,
54 .data2 = 0x4790,
55 .data3 = 0x4b9a,
56 .data4 = { 0xb8, 0xfe, 0x57, 0x5f,
57 0x05, 0x0f, 0x88, 0x6e} };
58
59
60
61
62static const MSGUID file_param_guid = { .data1 = 0xcaa16737,
63 .data2 = 0xfa36,
64 .data3 = 0x4d43,
65 .data4 = { 0xb3, 0xb6, 0x33, 0xf0,
66 0xaa, 0x44, 0xe7, 0x6b} };
67
68static const MSGUID virtual_size_guid = { .data1 = 0x2FA54224,
69 .data2 = 0xcd1b,
70 .data3 = 0x4876,
71 .data4 = { 0xb2, 0x11, 0x5d, 0xbe,
72 0xd8, 0x3b, 0xf4, 0xb8} };
73
74static const MSGUID page83_guid = { .data1 = 0xbeca12ab,
75 .data2 = 0xb2e6,
76 .data3 = 0x4523,
77 .data4 = { 0x93, 0xef, 0xc3, 0x09,
78 0xe0, 0x00, 0xc7, 0x46} };
79
80
81static const MSGUID phys_sector_guid = { .data1 = 0xcda348c7,
82 .data2 = 0x445d,
83 .data3 = 0x4471,
84 .data4 = { 0x9c, 0xc9, 0xe9, 0x88,
85 0x52, 0x51, 0xc5, 0x56} };
86
87static const MSGUID parent_locator_guid = { .data1 = 0xa8d35f2d,
88 .data2 = 0xb30b,
89 .data3 = 0x454d,
90 .data4 = { 0xab, 0xf7, 0xd3,
91 0xd8, 0x48, 0x34,
92 0xab, 0x0c} };
93
94static const MSGUID logical_sector_guid = { .data1 = 0x8141bf1d,
95 .data2 = 0xa96f,
96 .data3 = 0x4709,
97 .data4 = { 0xba, 0x47, 0xf2,
98 0x33, 0xa8, 0xfa,
99 0xab, 0x5f} };
100
101
102
103
104static const MSGUID parent_vhdx_guid __attribute__((unused))
105 = { .data1 = 0xb04aefb7,
106 .data2 = 0xd19e,
107 .data3 = 0x4a81,
108 .data4 = { 0xb7, 0x89, 0x25, 0xb8,
109 0xe9, 0x44, 0x59, 0x13} };
110
111
112#define META_FILE_PARAMETER_PRESENT 0x01
113#define META_VIRTUAL_DISK_SIZE_PRESENT 0x02
114#define META_PAGE_83_PRESENT 0x04
115#define META_LOGICAL_SECTOR_SIZE_PRESENT 0x08
116#define META_PHYS_SECTOR_SIZE_PRESENT 0x10
117#define META_PARENT_LOCATOR_PRESENT 0x20
118
119#define META_ALL_PRESENT \
120 (META_FILE_PARAMETER_PRESENT | META_VIRTUAL_DISK_SIZE_PRESENT | \
121 META_PAGE_83_PRESENT | META_LOGICAL_SECTOR_SIZE_PRESENT | \
122 META_PHYS_SECTOR_SIZE_PRESENT)
123
124
125typedef struct VHDXSectorInfo {
126 uint32_t bat_idx;
127 uint32_t sectors_avail;
128 uint32_t bytes_left;
129 uint32_t bytes_avail;
130 uint64_t file_offset;
131 uint64_t block_offset;
132} VHDXSectorInfo;
133
134
135
136
137
138
139
140
141
142
143
144uint32_t vhdx_update_checksum(uint8_t *buf, size_t size, int crc_offset)
145{
146 uint32_t crc;
147
148 assert(buf != NULL);
149 assert(size > (crc_offset + sizeof(crc)));
150
151 memset(buf + crc_offset, 0, sizeof(crc));
152 crc = crc32c(0xffffffff, buf, size);
153 cpu_to_le32s(&crc);
154 memcpy(buf + crc_offset, &crc, sizeof(crc));
155
156 return crc;
157}
158
159uint32_t vhdx_checksum_calc(uint32_t crc, uint8_t *buf, size_t size,
160 int crc_offset)
161{
162 uint32_t crc_new;
163 uint32_t crc_orig;
164 assert(buf != NULL);
165
166 if (crc_offset > 0) {
167 memcpy(&crc_orig, buf + crc_offset, sizeof(crc_orig));
168 memset(buf + crc_offset, 0, sizeof(crc_orig));
169 }
170
171 crc_new = crc32c(crc, buf, size);
172 if (crc_offset > 0) {
173 memcpy(buf + crc_offset, &crc_orig, sizeof(crc_orig));
174 }
175
176 return crc_new;
177}
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192bool vhdx_checksum_is_valid(uint8_t *buf, size_t size, int crc_offset)
193{
194 uint32_t crc_orig;
195 uint32_t crc;
196
197 assert(buf != NULL);
198 assert(size > (crc_offset + 4));
199
200 memcpy(&crc_orig, buf + crc_offset, sizeof(crc_orig));
201 crc_orig = le32_to_cpu(crc_orig);
202
203 crc = vhdx_checksum_calc(0xffffffff, buf, size, crc_offset);
204
205 return crc == crc_orig;
206}
207
208
209
210
211
212
213void vhdx_guid_generate(MSGUID *guid)
214{
215 QemuUUID uuid;
216 assert(guid != NULL);
217
218 qemu_uuid_generate(&uuid);
219 memcpy(guid, &uuid, sizeof(MSGUID));
220}
221
222
223static int vhdx_region_check(BDRVVHDXState *s, uint64_t start, uint64_t length)
224{
225 int ret = 0;
226 uint64_t end;
227 VHDXRegionEntry *r;
228
229 end = start + length;
230 QLIST_FOREACH(r, &s->regions, entries) {
231 if (!((start >= r->end) || (end <= r->start))) {
232 ret = -EINVAL;
233 goto exit;
234 }
235 }
236
237exit:
238 return ret;
239}
240
241
242static void vhdx_region_register(BDRVVHDXState *s,
243 uint64_t start, uint64_t length)
244{
245 VHDXRegionEntry *r;
246
247 r = g_malloc0(sizeof(*r));
248
249 r->start = start;
250 r->end = start + length;
251
252 QLIST_INSERT_HEAD(&s->regions, r, entries);
253}
254
255
256static void vhdx_region_unregister_all(BDRVVHDXState *s)
257{
258 VHDXRegionEntry *r, *r_next;
259
260 QLIST_FOREACH_SAFE(r, &s->regions, entries, r_next) {
261 QLIST_REMOVE(r, entries);
262 g_free(r);
263 }
264}
265
266static void vhdx_set_shift_bits(BDRVVHDXState *s)
267{
268 s->logical_sector_size_bits = ctz32(s->logical_sector_size);
269 s->sectors_per_block_bits = ctz32(s->sectors_per_block);
270 s->chunk_ratio_bits = ctz64(s->chunk_ratio);
271 s->block_size_bits = ctz32(s->block_size);
272}
273
274
275
276
277
278
279
280
281
282
283
284
285static int vhdx_probe(const uint8_t *buf, int buf_size, const char *filename)
286{
287 if (buf_size >= 8 && !memcmp(buf, "vhdxfile", 8)) {
288 return 100;
289 }
290 return 0;
291}
292
293
294
295
296
297
298
299
300static int vhdx_write_header(BdrvChild *file, VHDXHeader *hdr,
301 uint64_t offset, bool read)
302{
303 BlockDriverState *bs_file = file->bs;
304 uint8_t *buffer = NULL;
305 int ret;
306 VHDXHeader *header_le;
307
308 assert(bs_file != NULL);
309 assert(hdr != NULL);
310
311
312
313
314
315 buffer = qemu_blockalign(bs_file, VHDX_HEADER_SIZE);
316 if (read) {
317
318 ret = bdrv_pread(file, offset, buffer, VHDX_HEADER_SIZE);
319 if (ret < 0) {
320 goto exit;
321 }
322 } else {
323 memset(buffer, 0, VHDX_HEADER_SIZE);
324 }
325
326
327 header_le = (VHDXHeader *)buffer;
328 memcpy(header_le, hdr, sizeof(VHDXHeader));
329 vhdx_header_le_export(hdr, header_le);
330 vhdx_update_checksum(buffer, VHDX_HEADER_SIZE,
331 offsetof(VHDXHeader, checksum));
332 ret = bdrv_pwrite_sync(file, offset, header_le, sizeof(VHDXHeader));
333
334exit:
335 qemu_vfree(buffer);
336 return ret;
337}
338
339
340
341
342
343
344
345static int vhdx_update_header(BlockDriverState *bs, BDRVVHDXState *s,
346 bool generate_data_write_guid, MSGUID *log_guid)
347{
348 int ret = 0;
349 int hdr_idx = 0;
350 uint64_t header_offset = VHDX_HEADER1_OFFSET;
351
352 VHDXHeader *active_header;
353 VHDXHeader *inactive_header;
354
355
356 if (s->curr_header == 0) {
357 hdr_idx = 1;
358 header_offset = VHDX_HEADER2_OFFSET;
359 }
360
361 active_header = s->headers[s->curr_header];
362 inactive_header = s->headers[hdr_idx];
363
364 inactive_header->sequence_number = active_header->sequence_number + 1;
365
366
367
368 inactive_header->file_write_guid = s->session_guid;
369
370
371
372 if (generate_data_write_guid) {
373 vhdx_guid_generate(&inactive_header->data_write_guid);
374 }
375
376
377 if (log_guid) {
378 inactive_header->log_guid = *log_guid;
379 }
380
381 ret = vhdx_write_header(bs->file, inactive_header, header_offset, true);
382 if (ret < 0) {
383 goto exit;
384 }
385 s->curr_header = hdr_idx;
386
387exit:
388 return ret;
389}
390
391
392
393
394
395int vhdx_update_headers(BlockDriverState *bs, BDRVVHDXState *s,
396 bool generate_data_write_guid, MSGUID *log_guid)
397{
398 int ret;
399
400 ret = vhdx_update_header(bs, s, generate_data_write_guid, log_guid);
401 if (ret < 0) {
402 return ret;
403 }
404 ret = vhdx_update_header(bs, s, generate_data_write_guid, log_guid);
405 return ret;
406}
407
408
409static void vhdx_parse_header(BlockDriverState *bs, BDRVVHDXState *s,
410 Error **errp)
411{
412 int ret;
413 VHDXHeader *header1;
414 VHDXHeader *header2;
415 bool h1_valid = false;
416 bool h2_valid = false;
417 uint64_t h1_seq = 0;
418 uint64_t h2_seq = 0;
419 uint8_t *buffer;
420
421
422 header1 = qemu_blockalign(bs, sizeof(VHDXHeader));
423 header2 = qemu_blockalign(bs, sizeof(VHDXHeader));
424
425 buffer = qemu_blockalign(bs, VHDX_HEADER_SIZE);
426
427 s->headers[0] = header1;
428 s->headers[1] = header2;
429
430
431
432
433 ret = bdrv_pread(bs->file, VHDX_HEADER1_OFFSET, buffer,
434 VHDX_HEADER_SIZE);
435 if (ret < 0) {
436 goto fail;
437 }
438
439 memcpy(header1, buffer, sizeof(VHDXHeader));
440
441 if (vhdx_checksum_is_valid(buffer, VHDX_HEADER_SIZE, 4)) {
442 vhdx_header_le_import(header1);
443 if (header1->signature == VHDX_HEADER_SIGNATURE &&
444 header1->version == 1) {
445 h1_seq = header1->sequence_number;
446 h1_valid = true;
447 }
448 }
449
450 ret = bdrv_pread(bs->file, VHDX_HEADER2_OFFSET, buffer,
451 VHDX_HEADER_SIZE);
452 if (ret < 0) {
453 goto fail;
454 }
455
456 memcpy(header2, buffer, sizeof(VHDXHeader));
457
458 if (vhdx_checksum_is_valid(buffer, VHDX_HEADER_SIZE, 4)) {
459 vhdx_header_le_import(header2);
460 if (header2->signature == VHDX_HEADER_SIGNATURE &&
461 header2->version == 1) {
462 h2_seq = header2->sequence_number;
463 h2_valid = true;
464 }
465 }
466
467
468
469 if (h1_valid && !h2_valid) {
470 s->curr_header = 0;
471 } else if (!h1_valid && h2_valid) {
472 s->curr_header = 1;
473 } else if (!h1_valid && !h2_valid) {
474 goto fail;
475 } else {
476
477
478
479 if (h1_seq > h2_seq) {
480 s->curr_header = 0;
481 } else if (h2_seq > h1_seq) {
482 s->curr_header = 1;
483 } else {
484
485
486
487 if (!memcmp(header1, header2, sizeof(VHDXHeader))) {
488 s->curr_header = 0;
489 } else {
490 goto fail;
491 }
492 }
493 }
494
495 vhdx_region_register(s, s->headers[s->curr_header]->log_offset,
496 s->headers[s->curr_header]->log_length);
497 goto exit;
498
499fail:
500 error_setg_errno(errp, -ret, "No valid VHDX header found");
501 qemu_vfree(header1);
502 qemu_vfree(header2);
503 s->headers[0] = NULL;
504 s->headers[1] = NULL;
505exit:
506 qemu_vfree(buffer);
507}
508
509
510static int vhdx_open_region_tables(BlockDriverState *bs, BDRVVHDXState *s)
511{
512 int ret = 0;
513 uint8_t *buffer;
514 int offset = 0;
515 VHDXRegionTableEntry rt_entry;
516 uint32_t i;
517 bool bat_rt_found = false;
518 bool metadata_rt_found = false;
519
520
521
522 buffer = qemu_blockalign(bs, VHDX_HEADER_BLOCK_SIZE);
523
524 ret = bdrv_pread(bs->file, VHDX_REGION_TABLE_OFFSET, buffer,
525 VHDX_HEADER_BLOCK_SIZE);
526 if (ret < 0) {
527 goto fail;
528 }
529 memcpy(&s->rt, buffer, sizeof(s->rt));
530 offset += sizeof(s->rt);
531
532 if (!vhdx_checksum_is_valid(buffer, VHDX_HEADER_BLOCK_SIZE, 4)) {
533 ret = -EINVAL;
534 goto fail;
535 }
536
537 vhdx_region_header_le_import(&s->rt);
538
539 if (s->rt.signature != VHDX_REGION_SIGNATURE) {
540 ret = -EINVAL;
541 goto fail;
542 }
543
544
545
546 if (s->rt.entry_count > 2047) {
547 ret = -EINVAL;
548 goto fail;
549 }
550
551 for (i = 0; i < s->rt.entry_count; i++) {
552 memcpy(&rt_entry, buffer + offset, sizeof(rt_entry));
553 offset += sizeof(rt_entry);
554
555 vhdx_region_entry_le_import(&rt_entry);
556
557
558
559 ret = vhdx_region_check(s, rt_entry.file_offset, rt_entry.length);
560 if (ret < 0) {
561 goto fail;
562 }
563
564 vhdx_region_register(s, rt_entry.file_offset, rt_entry.length);
565
566
567 if (guid_eq(rt_entry.guid, bat_guid)) {
568
569 if (bat_rt_found) {
570 ret = -EINVAL;
571 goto fail;
572 }
573 bat_rt_found = true;
574 s->bat_rt = rt_entry;
575 continue;
576 }
577
578 if (guid_eq(rt_entry.guid, metadata_guid)) {
579
580 if (metadata_rt_found) {
581 ret = -EINVAL;
582 goto fail;
583 }
584 metadata_rt_found = true;
585 s->metadata_rt = rt_entry;
586 continue;
587 }
588
589 if (rt_entry.data_bits & VHDX_REGION_ENTRY_REQUIRED) {
590
591
592 ret = -ENOTSUP;
593 goto fail;
594 }
595 }
596
597 if (!bat_rt_found || !metadata_rt_found) {
598 ret = -EINVAL;
599 goto fail;
600 }
601
602 ret = 0;
603
604fail:
605 qemu_vfree(buffer);
606 return ret;
607}
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627static int vhdx_parse_metadata(BlockDriverState *bs, BDRVVHDXState *s)
628{
629 int ret = 0;
630 uint8_t *buffer;
631 int offset = 0;
632 uint32_t i = 0;
633 VHDXMetadataTableEntry md_entry;
634
635 buffer = qemu_blockalign(bs, VHDX_METADATA_TABLE_MAX_SIZE);
636
637 ret = bdrv_pread(bs->file, s->metadata_rt.file_offset, buffer,
638 VHDX_METADATA_TABLE_MAX_SIZE);
639 if (ret < 0) {
640 goto exit;
641 }
642 memcpy(&s->metadata_hdr, buffer, sizeof(s->metadata_hdr));
643 offset += sizeof(s->metadata_hdr);
644
645 vhdx_metadata_header_le_import(&s->metadata_hdr);
646
647 if (s->metadata_hdr.signature != VHDX_METADATA_SIGNATURE) {
648 ret = -EINVAL;
649 goto exit;
650 }
651
652 s->metadata_entries.present = 0;
653
654 if ((s->metadata_hdr.entry_count * sizeof(md_entry)) >
655 (VHDX_METADATA_TABLE_MAX_SIZE - offset)) {
656 ret = -EINVAL;
657 goto exit;
658 }
659
660 for (i = 0; i < s->metadata_hdr.entry_count; i++) {
661 memcpy(&md_entry, buffer + offset, sizeof(md_entry));
662 offset += sizeof(md_entry);
663
664 vhdx_metadata_entry_le_import(&md_entry);
665
666 if (guid_eq(md_entry.item_id, file_param_guid)) {
667 if (s->metadata_entries.present & META_FILE_PARAMETER_PRESENT) {
668 ret = -EINVAL;
669 goto exit;
670 }
671 s->metadata_entries.file_parameters_entry = md_entry;
672 s->metadata_entries.present |= META_FILE_PARAMETER_PRESENT;
673 continue;
674 }
675
676 if (guid_eq(md_entry.item_id, virtual_size_guid)) {
677 if (s->metadata_entries.present & META_VIRTUAL_DISK_SIZE_PRESENT) {
678 ret = -EINVAL;
679 goto exit;
680 }
681 s->metadata_entries.virtual_disk_size_entry = md_entry;
682 s->metadata_entries.present |= META_VIRTUAL_DISK_SIZE_PRESENT;
683 continue;
684 }
685
686 if (guid_eq(md_entry.item_id, page83_guid)) {
687 if (s->metadata_entries.present & META_PAGE_83_PRESENT) {
688 ret = -EINVAL;
689 goto exit;
690 }
691 s->metadata_entries.page83_data_entry = md_entry;
692 s->metadata_entries.present |= META_PAGE_83_PRESENT;
693 continue;
694 }
695
696 if (guid_eq(md_entry.item_id, logical_sector_guid)) {
697 if (s->metadata_entries.present &
698 META_LOGICAL_SECTOR_SIZE_PRESENT) {
699 ret = -EINVAL;
700 goto exit;
701 }
702 s->metadata_entries.logical_sector_size_entry = md_entry;
703 s->metadata_entries.present |= META_LOGICAL_SECTOR_SIZE_PRESENT;
704 continue;
705 }
706
707 if (guid_eq(md_entry.item_id, phys_sector_guid)) {
708 if (s->metadata_entries.present & META_PHYS_SECTOR_SIZE_PRESENT) {
709 ret = -EINVAL;
710 goto exit;
711 }
712 s->metadata_entries.phys_sector_size_entry = md_entry;
713 s->metadata_entries.present |= META_PHYS_SECTOR_SIZE_PRESENT;
714 continue;
715 }
716
717 if (guid_eq(md_entry.item_id, parent_locator_guid)) {
718 if (s->metadata_entries.present & META_PARENT_LOCATOR_PRESENT) {
719 ret = -EINVAL;
720 goto exit;
721 }
722 s->metadata_entries.parent_locator_entry = md_entry;
723 s->metadata_entries.present |= META_PARENT_LOCATOR_PRESENT;
724 continue;
725 }
726
727 if (md_entry.data_bits & VHDX_META_FLAGS_IS_REQUIRED) {
728
729
730 ret = -ENOTSUP;
731 goto exit;
732 }
733 }
734
735 if (s->metadata_entries.present != META_ALL_PRESENT) {
736 ret = -ENOTSUP;
737 goto exit;
738 }
739
740 ret = bdrv_pread(bs->file,
741 s->metadata_entries.file_parameters_entry.offset
742 + s->metadata_rt.file_offset,
743 &s->params,
744 sizeof(s->params));
745
746 if (ret < 0) {
747 goto exit;
748 }
749
750 le32_to_cpus(&s->params.block_size);
751 le32_to_cpus(&s->params.data_bits);
752
753
754
755
756
757
758
759 if (s->params.data_bits & VHDX_PARAMS_HAS_PARENT) {
760 if (s->metadata_entries.present & META_PARENT_LOCATOR_PRESENT) {
761
762 ret = -ENOTSUP;
763 goto exit;
764 } else {
765
766
767 ret = -EINVAL;
768 goto exit;
769 }
770 }
771
772
773
774
775 ret = bdrv_pread(bs->file,
776 s->metadata_entries.virtual_disk_size_entry.offset
777 + s->metadata_rt.file_offset,
778 &s->virtual_disk_size,
779 sizeof(uint64_t));
780 if (ret < 0) {
781 goto exit;
782 }
783 ret = bdrv_pread(bs->file,
784 s->metadata_entries.logical_sector_size_entry.offset
785 + s->metadata_rt.file_offset,
786 &s->logical_sector_size,
787 sizeof(uint32_t));
788 if (ret < 0) {
789 goto exit;
790 }
791 ret = bdrv_pread(bs->file,
792 s->metadata_entries.phys_sector_size_entry.offset
793 + s->metadata_rt.file_offset,
794 &s->physical_sector_size,
795 sizeof(uint32_t));
796 if (ret < 0) {
797 goto exit;
798 }
799
800 le64_to_cpus(&s->virtual_disk_size);
801 le32_to_cpus(&s->logical_sector_size);
802 le32_to_cpus(&s->physical_sector_size);
803
804 if (s->params.block_size < VHDX_BLOCK_SIZE_MIN ||
805 s->params.block_size > VHDX_BLOCK_SIZE_MAX) {
806 ret = -EINVAL;
807 goto exit;
808 }
809
810
811 if (s->logical_sector_size != 512 && s->logical_sector_size != 4096) {
812 ret = -EINVAL;
813 goto exit;
814 }
815
816
817
818 s->sectors_per_block = s->params.block_size / s->logical_sector_size;
819 s->chunk_ratio = (VHDX_MAX_SECTORS_PER_BLOCK) *
820 (uint64_t)s->logical_sector_size /
821 (uint64_t)s->params.block_size;
822
823
824
825
826
827 if (s->logical_sector_size & (s->logical_sector_size - 1)) {
828 ret = -EINVAL;
829 goto exit;
830 }
831 if (s->sectors_per_block & (s->sectors_per_block - 1)) {
832 ret = -EINVAL;
833 goto exit;
834 }
835 if (s->chunk_ratio & (s->chunk_ratio - 1)) {
836 ret = -EINVAL;
837 goto exit;
838 }
839 s->block_size = s->params.block_size;
840 if (s->block_size & (s->block_size - 1)) {
841 ret = -EINVAL;
842 goto exit;
843 }
844
845 vhdx_set_shift_bits(s);
846
847 ret = 0;
848
849exit:
850 qemu_vfree(buffer);
851 return ret;
852}
853
854
855
856
857
858static void vhdx_calc_bat_entries(BDRVVHDXState *s)
859{
860 uint32_t data_blocks_cnt, bitmap_blocks_cnt;
861
862 data_blocks_cnt = DIV_ROUND_UP(s->virtual_disk_size, s->block_size);
863 bitmap_blocks_cnt = DIV_ROUND_UP(data_blocks_cnt, s->chunk_ratio);
864
865 if (s->parent_entries) {
866 s->bat_entries = bitmap_blocks_cnt * (s->chunk_ratio + 1);
867 } else {
868 s->bat_entries = data_blocks_cnt +
869 ((data_blocks_cnt - 1) >> s->chunk_ratio_bits);
870 }
871
872}
873
874static void vhdx_close(BlockDriverState *bs)
875{
876 BDRVVHDXState *s = bs->opaque;
877 qemu_vfree(s->headers[0]);
878 s->headers[0] = NULL;
879 qemu_vfree(s->headers[1]);
880 s->headers[1] = NULL;
881 qemu_vfree(s->bat);
882 s->bat = NULL;
883 qemu_vfree(s->parent_entries);
884 s->parent_entries = NULL;
885 migrate_del_blocker(s->migration_blocker);
886 error_free(s->migration_blocker);
887 qemu_vfree(s->log.hdr);
888 s->log.hdr = NULL;
889 vhdx_region_unregister_all(s);
890}
891
892static int vhdx_open(BlockDriverState *bs, QDict *options, int flags,
893 Error **errp)
894{
895 BDRVVHDXState *s = bs->opaque;
896 int ret = 0;
897 uint32_t i;
898 uint64_t signature;
899 Error *local_err = NULL;
900
901 bs->file = bdrv_open_child(NULL, options, "file", bs, &child_file,
902 false, errp);
903 if (!bs->file) {
904 return -EINVAL;
905 }
906
907 s->bat = NULL;
908 s->first_visible_write = true;
909
910 qemu_co_mutex_init(&s->lock);
911 QLIST_INIT(&s->regions);
912
913
914 ret = bdrv_pread(bs->file, 0, &signature, sizeof(uint64_t));
915 if (ret < 0) {
916 goto fail;
917 }
918 if (memcmp(&signature, "vhdxfile", 8)) {
919 ret = -EINVAL;
920 goto fail;
921 }
922
923
924
925
926 vhdx_guid_generate(&s->session_guid);
927
928 vhdx_parse_header(bs, s, &local_err);
929 if (local_err != NULL) {
930 error_propagate(errp, local_err);
931 ret = -EINVAL;
932 goto fail;
933 }
934
935 ret = vhdx_parse_log(bs, s, &s->log_replayed_on_open, errp);
936 if (ret < 0) {
937 goto fail;
938 }
939
940 ret = vhdx_open_region_tables(bs, s);
941 if (ret < 0) {
942 goto fail;
943 }
944
945 ret = vhdx_parse_metadata(bs, s);
946 if (ret < 0) {
947 goto fail;
948 }
949
950 s->block_size = s->params.block_size;
951
952
953
954 bs->total_sectors = s->virtual_disk_size >> s->logical_sector_size_bits;
955
956 vhdx_calc_bat_entries(s);
957
958 s->bat_offset = s->bat_rt.file_offset;
959
960 if (s->bat_entries > s->bat_rt.length / sizeof(VHDXBatEntry)) {
961
962 ret = -EINVAL;
963 goto fail;
964 }
965
966
967 s->bat = qemu_try_blockalign(bs->file->bs, s->bat_rt.length);
968 if (s->bat == NULL) {
969 ret = -ENOMEM;
970 goto fail;
971 }
972
973 ret = bdrv_pread(bs->file, s->bat_offset, s->bat, s->bat_rt.length);
974 if (ret < 0) {
975 goto fail;
976 }
977
978 uint64_t payblocks = s->chunk_ratio;
979
980
981 for (i = 0; i < s->bat_entries; i++) {
982 le64_to_cpus(&s->bat[i]);
983 if (payblocks--) {
984
985 if ((s->bat[i] & VHDX_BAT_STATE_BIT_MASK) ==
986 PAYLOAD_BLOCK_FULLY_PRESENT) {
987 ret = vhdx_region_check(s, s->bat[i] & VHDX_BAT_FILE_OFF_MASK,
988 s->block_size);
989 if (ret < 0) {
990 goto fail;
991 }
992 }
993 } else {
994 payblocks = s->chunk_ratio;
995
996
997 }
998 }
999
1000
1001 error_setg(&s->migration_blocker, "The vhdx format used by node '%s' "
1002 "does not support live migration",
1003 bdrv_get_device_or_node_name(bs));
1004 ret = migrate_add_blocker(s->migration_blocker, &local_err);
1005 if (local_err) {
1006 error_propagate(errp, local_err);
1007 error_free(s->migration_blocker);
1008 goto fail;
1009 }
1010
1011 if (flags & BDRV_O_RDWR) {
1012 ret = vhdx_update_headers(bs, s, false, NULL);
1013 if (ret < 0) {
1014 goto fail;
1015 }
1016 }
1017
1018
1019
1020 return 0;
1021fail:
1022 vhdx_close(bs);
1023 return ret;
1024}
1025
1026static int vhdx_reopen_prepare(BDRVReopenState *state,
1027 BlockReopenQueue *queue, Error **errp)
1028{
1029 return 0;
1030}
1031
1032
1033
1034
1035
1036
1037static void vhdx_block_translate(BDRVVHDXState *s, int64_t sector_num,
1038 int nb_sectors, VHDXSectorInfo *sinfo)
1039{
1040 uint32_t block_offset;
1041
1042 sinfo->bat_idx = sector_num >> s->sectors_per_block_bits;
1043
1044
1045 block_offset = sector_num - (sinfo->bat_idx << s->sectors_per_block_bits);
1046
1047
1048
1049 sinfo->bat_idx += sinfo->bat_idx >> s->chunk_ratio_bits;
1050
1051
1052 sinfo->sectors_avail = s->sectors_per_block - block_offset;
1053
1054 sinfo->bytes_left = sinfo->sectors_avail << s->logical_sector_size_bits;
1055
1056 if (sinfo->sectors_avail > nb_sectors) {
1057 sinfo->sectors_avail = nb_sectors;
1058 }
1059
1060 sinfo->bytes_avail = sinfo->sectors_avail << s->logical_sector_size_bits;
1061
1062 sinfo->file_offset = s->bat[sinfo->bat_idx] & VHDX_BAT_FILE_OFF_MASK;
1063
1064 sinfo->block_offset = block_offset << s->logical_sector_size_bits;
1065
1066
1067 if (sinfo->file_offset == 0) {
1068 return;
1069 }
1070
1071
1072
1073
1074
1075
1076 sinfo->file_offset += sinfo->block_offset;
1077}
1078
1079
1080static int vhdx_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
1081{
1082 BDRVVHDXState *s = bs->opaque;
1083
1084 bdi->cluster_size = s->block_size;
1085
1086 bdi->unallocated_blocks_are_zero =
1087 (s->params.data_bits & VHDX_PARAMS_HAS_PARENT) == 0;
1088
1089 return 0;
1090}
1091
1092
1093static coroutine_fn int vhdx_co_readv(BlockDriverState *bs, int64_t sector_num,
1094 int nb_sectors, QEMUIOVector *qiov)
1095{
1096 BDRVVHDXState *s = bs->opaque;
1097 int ret = 0;
1098 VHDXSectorInfo sinfo;
1099 uint64_t bytes_done = 0;
1100 QEMUIOVector hd_qiov;
1101
1102 qemu_iovec_init(&hd_qiov, qiov->niov);
1103
1104 qemu_co_mutex_lock(&s->lock);
1105
1106 while (nb_sectors > 0) {
1107
1108
1109 if (s->params.data_bits & VHDX_PARAMS_HAS_PARENT) {
1110
1111 ret = -ENOTSUP;
1112 goto exit;
1113 } else {
1114 vhdx_block_translate(s, sector_num, nb_sectors, &sinfo);
1115
1116 qemu_iovec_reset(&hd_qiov);
1117 qemu_iovec_concat(&hd_qiov, qiov, bytes_done, sinfo.bytes_avail);
1118
1119
1120 switch (s->bat[sinfo.bat_idx] & VHDX_BAT_STATE_BIT_MASK) {
1121 case PAYLOAD_BLOCK_NOT_PRESENT:
1122 case PAYLOAD_BLOCK_UNDEFINED:
1123 case PAYLOAD_BLOCK_UNMAPPED:
1124 case PAYLOAD_BLOCK_UNMAPPED_v095:
1125 case PAYLOAD_BLOCK_ZERO:
1126
1127 qemu_iovec_memset(&hd_qiov, 0, 0, sinfo.bytes_avail);
1128 break;
1129 case PAYLOAD_BLOCK_FULLY_PRESENT:
1130 qemu_co_mutex_unlock(&s->lock);
1131 ret = bdrv_co_readv(bs->file,
1132 sinfo.file_offset >> BDRV_SECTOR_BITS,
1133 sinfo.sectors_avail, &hd_qiov);
1134 qemu_co_mutex_lock(&s->lock);
1135 if (ret < 0) {
1136 goto exit;
1137 }
1138 break;
1139 case PAYLOAD_BLOCK_PARTIALLY_PRESENT:
1140
1141
1142 default:
1143 ret = -EIO;
1144 goto exit;
1145 break;
1146 }
1147 nb_sectors -= sinfo.sectors_avail;
1148 sector_num += sinfo.sectors_avail;
1149 bytes_done += sinfo.bytes_avail;
1150 }
1151 }
1152 ret = 0;
1153exit:
1154 qemu_co_mutex_unlock(&s->lock);
1155 qemu_iovec_destroy(&hd_qiov);
1156 return ret;
1157}
1158
1159
1160
1161
1162
1163
1164
1165
1166static int vhdx_allocate_block(BlockDriverState *bs, BDRVVHDXState *s,
1167 uint64_t *new_offset)
1168{
1169 int64_t current_len;
1170
1171 current_len = bdrv_getlength(bs->file->bs);
1172 if (current_len < 0) {
1173 return current_len;
1174 }
1175
1176 *new_offset = current_len;
1177
1178
1179 *new_offset = ROUND_UP(*new_offset, 1024 * 1024);
1180 if (*new_offset > INT64_MAX) {
1181 return -EINVAL;
1182 }
1183
1184 return bdrv_truncate(bs->file, *new_offset + s->block_size,
1185 PREALLOC_MODE_OFF, NULL);
1186}
1187
1188
1189
1190
1191static void vhdx_update_bat_table_entry(BlockDriverState *bs, BDRVVHDXState *s,
1192 VHDXSectorInfo *sinfo,
1193 uint64_t *bat_entry_le,
1194 uint64_t *bat_offset, int state)
1195{
1196
1197
1198 if ((state == PAYLOAD_BLOCK_ZERO) ||
1199 (state == PAYLOAD_BLOCK_UNDEFINED) ||
1200 (state == PAYLOAD_BLOCK_NOT_PRESENT) ||
1201 (state == PAYLOAD_BLOCK_UNMAPPED)) {
1202 s->bat[sinfo->bat_idx] = 0;
1203
1204
1205
1206
1207 } else {
1208 s->bat[sinfo->bat_idx] = sinfo->file_offset;
1209 }
1210
1211 s->bat[sinfo->bat_idx] |= state & VHDX_BAT_STATE_BIT_MASK;
1212
1213 *bat_entry_le = cpu_to_le64(s->bat[sinfo->bat_idx]);
1214 *bat_offset = s->bat_offset + sinfo->bat_idx * sizeof(VHDXBatEntry);
1215
1216}
1217
1218
1219
1220int vhdx_user_visible_write(BlockDriverState *bs, BDRVVHDXState *s)
1221{
1222 int ret = 0;
1223 if (s->first_visible_write) {
1224 s->first_visible_write = false;
1225 ret = vhdx_update_headers(bs, s, true, NULL);
1226 }
1227 return ret;
1228}
1229
1230static coroutine_fn int vhdx_co_writev(BlockDriverState *bs, int64_t sector_num,
1231 int nb_sectors, QEMUIOVector *qiov)
1232{
1233 int ret = -ENOTSUP;
1234 BDRVVHDXState *s = bs->opaque;
1235 VHDXSectorInfo sinfo;
1236 uint64_t bytes_done = 0;
1237 uint64_t bat_entry = 0;
1238 uint64_t bat_entry_offset = 0;
1239 QEMUIOVector hd_qiov;
1240 struct iovec iov1 = { 0 };
1241 struct iovec iov2 = { 0 };
1242 int sectors_to_write;
1243 int bat_state;
1244 uint64_t bat_prior_offset = 0;
1245 bool bat_update = false;
1246
1247 qemu_iovec_init(&hd_qiov, qiov->niov);
1248
1249 qemu_co_mutex_lock(&s->lock);
1250
1251 ret = vhdx_user_visible_write(bs, s);
1252 if (ret < 0) {
1253 goto exit;
1254 }
1255
1256 while (nb_sectors > 0) {
1257 bool use_zero_buffers = false;
1258 bat_update = false;
1259 if (s->params.data_bits & VHDX_PARAMS_HAS_PARENT) {
1260
1261 ret = -ENOTSUP;
1262 goto exit;
1263 } else {
1264 vhdx_block_translate(s, sector_num, nb_sectors, &sinfo);
1265 sectors_to_write = sinfo.sectors_avail;
1266
1267 qemu_iovec_reset(&hd_qiov);
1268
1269 bat_state = s->bat[sinfo.bat_idx] & VHDX_BAT_STATE_BIT_MASK;
1270 switch (bat_state) {
1271 case PAYLOAD_BLOCK_ZERO:
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284 if (bdrv_has_zero_init(bs->file->bs) == 0) {
1285 use_zero_buffers = true;
1286
1287
1288 if (sinfo.block_offset) {
1289 iov1.iov_len = sinfo.block_offset;
1290 iov1.iov_base = qemu_blockalign(bs, iov1.iov_len);
1291 memset(iov1.iov_base, 0, iov1.iov_len);
1292 qemu_iovec_concat_iov(&hd_qiov, &iov1, 1, 0,
1293 iov1.iov_len);
1294 sectors_to_write += iov1.iov_len >> BDRV_SECTOR_BITS;
1295 }
1296
1297
1298 qemu_iovec_concat(&hd_qiov, qiov, bytes_done,
1299 sinfo.bytes_avail);
1300
1301
1302 if ((sinfo.bytes_avail - sinfo.block_offset) <
1303 s->block_size) {
1304 iov2.iov_len = s->block_size -
1305 (sinfo.bytes_avail + sinfo.block_offset);
1306 iov2.iov_base = qemu_blockalign(bs, iov2.iov_len);
1307 memset(iov2.iov_base, 0, iov2.iov_len);
1308 qemu_iovec_concat_iov(&hd_qiov, &iov2, 1, 0,
1309 iov2.iov_len);
1310 sectors_to_write += iov2.iov_len >> BDRV_SECTOR_BITS;
1311 }
1312 }
1313
1314 case PAYLOAD_BLOCK_NOT_PRESENT:
1315 case PAYLOAD_BLOCK_UNMAPPED:
1316 case PAYLOAD_BLOCK_UNMAPPED_v095:
1317 case PAYLOAD_BLOCK_UNDEFINED:
1318 bat_prior_offset = sinfo.file_offset;
1319 ret = vhdx_allocate_block(bs, s, &sinfo.file_offset);
1320 if (ret < 0) {
1321 goto exit;
1322 }
1323
1324
1325
1326 vhdx_update_bat_table_entry(bs, s, &sinfo, &bat_entry,
1327 &bat_entry_offset,
1328 PAYLOAD_BLOCK_FULLY_PRESENT);
1329 bat_update = true;
1330
1331
1332
1333 if (!use_zero_buffers) {
1334 sinfo.file_offset += sinfo.block_offset;
1335 }
1336
1337 case PAYLOAD_BLOCK_FULLY_PRESENT:
1338
1339
1340 if (sinfo.file_offset < (1024 * 1024)) {
1341 ret = -EFAULT;
1342 goto error_bat_restore;
1343 }
1344
1345 if (!use_zero_buffers) {
1346 qemu_iovec_concat(&hd_qiov, qiov, bytes_done,
1347 sinfo.bytes_avail);
1348 }
1349
1350 qemu_co_mutex_unlock(&s->lock);
1351 ret = bdrv_co_writev(bs->file,
1352 sinfo.file_offset >> BDRV_SECTOR_BITS,
1353 sectors_to_write, &hd_qiov);
1354 qemu_co_mutex_lock(&s->lock);
1355 if (ret < 0) {
1356 goto error_bat_restore;
1357 }
1358 break;
1359 case PAYLOAD_BLOCK_PARTIALLY_PRESENT:
1360
1361
1362 default:
1363 ret = -EIO;
1364 goto exit;
1365 break;
1366 }
1367
1368 if (bat_update) {
1369
1370
1371 ret = vhdx_log_write_and_flush(bs, s, &bat_entry,
1372 sizeof(VHDXBatEntry),
1373 bat_entry_offset);
1374 if (ret < 0) {
1375 goto exit;
1376 }
1377 }
1378
1379 nb_sectors -= sinfo.sectors_avail;
1380 sector_num += sinfo.sectors_avail;
1381 bytes_done += sinfo.bytes_avail;
1382
1383 }
1384 }
1385
1386 goto exit;
1387
1388error_bat_restore:
1389 if (bat_update) {
1390
1391
1392 sinfo.file_offset = bat_prior_offset;
1393 vhdx_update_bat_table_entry(bs, s, &sinfo, &bat_entry,
1394 &bat_entry_offset, bat_state);
1395 }
1396exit:
1397 qemu_vfree(iov1.iov_base);
1398 qemu_vfree(iov2.iov_base);
1399 qemu_co_mutex_unlock(&s->lock);
1400 qemu_iovec_destroy(&hd_qiov);
1401 return ret;
1402}
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412static int vhdx_create_new_headers(BlockBackend *blk, uint64_t image_size,
1413 uint32_t log_size)
1414{
1415 BlockDriverState *bs = blk_bs(blk);
1416 BdrvChild *child;
1417 int ret = 0;
1418 VHDXHeader *hdr = NULL;
1419
1420 hdr = g_new0(VHDXHeader, 1);
1421
1422 hdr->signature = VHDX_HEADER_SIGNATURE;
1423 hdr->sequence_number = g_random_int();
1424 hdr->log_version = 0;
1425 hdr->version = 1;
1426 hdr->log_length = log_size;
1427 hdr->log_offset = VHDX_HEADER_SECTION_END;
1428 vhdx_guid_generate(&hdr->file_write_guid);
1429 vhdx_guid_generate(&hdr->data_write_guid);
1430
1431
1432
1433
1434 child = QLIST_FIRST(&bs->parents);
1435 assert(!QLIST_NEXT(child, next_parent));
1436
1437 ret = vhdx_write_header(child, hdr, VHDX_HEADER1_OFFSET, false);
1438 if (ret < 0) {
1439 goto exit;
1440 }
1441 hdr->sequence_number++;
1442 ret = vhdx_write_header(child, hdr, VHDX_HEADER2_OFFSET, false);
1443 if (ret < 0) {
1444 goto exit;
1445 }
1446
1447exit:
1448 g_free(hdr);
1449 return ret;
1450}
1451
1452#define VHDX_METADATA_ENTRY_BUFFER_SIZE \
1453 (sizeof(VHDXFileParameters) +\
1454 sizeof(VHDXVirtualDiskSize) +\
1455 sizeof(VHDXPage83Data) +\
1456 sizeof(VHDXVirtualDiskLogicalSectorSize) +\
1457 sizeof(VHDXVirtualDiskPhysicalSectorSize))
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475static int vhdx_create_new_metadata(BlockBackend *blk,
1476 uint64_t image_size,
1477 uint32_t block_size,
1478 uint32_t sector_size,
1479 uint64_t metadata_offset,
1480 VHDXImageType type)
1481{
1482 int ret = 0;
1483 uint32_t offset = 0;
1484 void *buffer = NULL;
1485 void *entry_buffer;
1486 VHDXMetadataTableHeader *md_table;
1487 VHDXMetadataTableEntry *md_table_entry;
1488
1489
1490 VHDXFileParameters *mt_file_params;
1491 VHDXVirtualDiskSize *mt_virtual_size;
1492 VHDXPage83Data *mt_page83;
1493 VHDXVirtualDiskLogicalSectorSize *mt_log_sector_size;
1494 VHDXVirtualDiskPhysicalSectorSize *mt_phys_sector_size;
1495
1496 entry_buffer = g_malloc0(VHDX_METADATA_ENTRY_BUFFER_SIZE);
1497
1498 mt_file_params = entry_buffer;
1499 offset += sizeof(VHDXFileParameters);
1500 mt_virtual_size = entry_buffer + offset;
1501 offset += sizeof(VHDXVirtualDiskSize);
1502 mt_page83 = entry_buffer + offset;
1503 offset += sizeof(VHDXPage83Data);
1504 mt_log_sector_size = entry_buffer + offset;
1505 offset += sizeof(VHDXVirtualDiskLogicalSectorSize);
1506 mt_phys_sector_size = entry_buffer + offset;
1507
1508 mt_file_params->block_size = cpu_to_le32(block_size);
1509 if (type == VHDX_TYPE_FIXED) {
1510 mt_file_params->data_bits |= VHDX_PARAMS_LEAVE_BLOCKS_ALLOCED;
1511 cpu_to_le32s(&mt_file_params->data_bits);
1512 }
1513
1514 vhdx_guid_generate(&mt_page83->page_83_data);
1515 cpu_to_leguids(&mt_page83->page_83_data);
1516 mt_virtual_size->virtual_disk_size = cpu_to_le64(image_size);
1517 mt_log_sector_size->logical_sector_size = cpu_to_le32(sector_size);
1518 mt_phys_sector_size->physical_sector_size = cpu_to_le32(sector_size);
1519
1520 buffer = g_malloc0(VHDX_HEADER_BLOCK_SIZE);
1521 md_table = buffer;
1522
1523 md_table->signature = VHDX_METADATA_SIGNATURE;
1524 md_table->entry_count = 5;
1525 vhdx_metadata_header_le_export(md_table);
1526
1527
1528
1529 offset = 64 * KiB;
1530
1531 md_table_entry = buffer + sizeof(VHDXMetadataTableHeader);
1532
1533 md_table_entry[0].item_id = file_param_guid;
1534 md_table_entry[0].offset = offset;
1535 md_table_entry[0].length = sizeof(VHDXFileParameters);
1536 md_table_entry[0].data_bits |= VHDX_META_FLAGS_IS_REQUIRED;
1537 offset += md_table_entry[0].length;
1538 vhdx_metadata_entry_le_export(&md_table_entry[0]);
1539
1540 md_table_entry[1].item_id = virtual_size_guid;
1541 md_table_entry[1].offset = offset;
1542 md_table_entry[1].length = sizeof(VHDXVirtualDiskSize);
1543 md_table_entry[1].data_bits |= VHDX_META_FLAGS_IS_REQUIRED |
1544 VHDX_META_FLAGS_IS_VIRTUAL_DISK;
1545 offset += md_table_entry[1].length;
1546 vhdx_metadata_entry_le_export(&md_table_entry[1]);
1547
1548 md_table_entry[2].item_id = page83_guid;
1549 md_table_entry[2].offset = offset;
1550 md_table_entry[2].length = sizeof(VHDXPage83Data);
1551 md_table_entry[2].data_bits |= VHDX_META_FLAGS_IS_REQUIRED |
1552 VHDX_META_FLAGS_IS_VIRTUAL_DISK;
1553 offset += md_table_entry[2].length;
1554 vhdx_metadata_entry_le_export(&md_table_entry[2]);
1555
1556 md_table_entry[3].item_id = logical_sector_guid;
1557 md_table_entry[3].offset = offset;
1558 md_table_entry[3].length = sizeof(VHDXVirtualDiskLogicalSectorSize);
1559 md_table_entry[3].data_bits |= VHDX_META_FLAGS_IS_REQUIRED |
1560 VHDX_META_FLAGS_IS_VIRTUAL_DISK;
1561 offset += md_table_entry[3].length;
1562 vhdx_metadata_entry_le_export(&md_table_entry[3]);
1563
1564 md_table_entry[4].item_id = phys_sector_guid;
1565 md_table_entry[4].offset = offset;
1566 md_table_entry[4].length = sizeof(VHDXVirtualDiskPhysicalSectorSize);
1567 md_table_entry[4].data_bits |= VHDX_META_FLAGS_IS_REQUIRED |
1568 VHDX_META_FLAGS_IS_VIRTUAL_DISK;
1569 vhdx_metadata_entry_le_export(&md_table_entry[4]);
1570
1571 ret = blk_pwrite(blk, metadata_offset, buffer, VHDX_HEADER_BLOCK_SIZE, 0);
1572 if (ret < 0) {
1573 goto exit;
1574 }
1575
1576 ret = blk_pwrite(blk, metadata_offset + (64 * KiB), entry_buffer,
1577 VHDX_METADATA_ENTRY_BUFFER_SIZE, 0);
1578 if (ret < 0) {
1579 goto exit;
1580 }
1581
1582
1583exit:
1584 g_free(buffer);
1585 g_free(entry_buffer);
1586 return ret;
1587}
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597static int vhdx_create_bat(BlockBackend *blk, BDRVVHDXState *s,
1598 uint64_t image_size, VHDXImageType type,
1599 bool use_zero_blocks, uint64_t file_offset,
1600 uint32_t length, Error **errp)
1601{
1602 int ret = 0;
1603 uint64_t data_file_offset;
1604 uint64_t total_sectors = 0;
1605 uint64_t sector_num = 0;
1606 uint64_t unused;
1607 int block_state;
1608 VHDXSectorInfo sinfo;
1609
1610 assert(s->bat == NULL);
1611
1612
1613
1614
1615 data_file_offset = file_offset + length + 5 * MiB;
1616 total_sectors = image_size >> s->logical_sector_size_bits;
1617
1618 if (type == VHDX_TYPE_DYNAMIC) {
1619
1620
1621 ret = blk_truncate(blk, data_file_offset, PREALLOC_MODE_OFF, errp);
1622 if (ret < 0) {
1623 goto exit;
1624 }
1625 } else if (type == VHDX_TYPE_FIXED) {
1626 ret = blk_truncate(blk, data_file_offset + image_size,
1627 PREALLOC_MODE_OFF, errp);
1628 if (ret < 0) {
1629 goto exit;
1630 }
1631 } else {
1632 error_setg(errp, "Unsupported image type");
1633 ret = -ENOTSUP;
1634 goto exit;
1635 }
1636
1637 if (type == VHDX_TYPE_FIXED ||
1638 use_zero_blocks ||
1639 bdrv_has_zero_init(blk_bs(blk)) == 0) {
1640
1641 s->bat = g_try_malloc0(length);
1642 if (length && s->bat == NULL) {
1643 error_setg(errp, "Failed to allocate memory for the BAT");
1644 ret = -ENOMEM;
1645 goto exit;
1646 }
1647 block_state = type == VHDX_TYPE_FIXED ? PAYLOAD_BLOCK_FULLY_PRESENT :
1648 PAYLOAD_BLOCK_NOT_PRESENT;
1649 block_state = use_zero_blocks ? PAYLOAD_BLOCK_ZERO : block_state;
1650
1651 while (sector_num < total_sectors) {
1652 vhdx_block_translate(s, sector_num, s->sectors_per_block, &sinfo);
1653 sinfo.file_offset = data_file_offset +
1654 (sector_num << s->logical_sector_size_bits);
1655 sinfo.file_offset = ROUND_UP(sinfo.file_offset, MiB);
1656 vhdx_update_bat_table_entry(blk_bs(blk), s, &sinfo, &unused, &unused,
1657 block_state);
1658 cpu_to_le64s(&s->bat[sinfo.bat_idx]);
1659 sector_num += s->sectors_per_block;
1660 }
1661 ret = blk_pwrite(blk, file_offset, s->bat, length, 0);
1662 if (ret < 0) {
1663 error_setg_errno(errp, -ret, "Failed to write the BAT");
1664 goto exit;
1665 }
1666 }
1667
1668
1669
1670exit:
1671 g_free(s->bat);
1672 return ret;
1673}
1674
1675
1676
1677
1678
1679
1680
1681
1682static int vhdx_create_new_region_table(BlockBackend *blk,
1683 uint64_t image_size,
1684 uint32_t block_size,
1685 uint32_t sector_size,
1686 uint32_t log_size,
1687 bool use_zero_blocks,
1688 VHDXImageType type,
1689 uint64_t *metadata_offset,
1690 Error **errp)
1691{
1692 int ret = 0;
1693 uint32_t offset = 0;
1694 void *buffer = NULL;
1695 uint64_t bat_file_offset;
1696 uint32_t bat_length;
1697 BDRVVHDXState *s = NULL;
1698 VHDXRegionTableHeader *region_table;
1699 VHDXRegionTableEntry *rt_bat;
1700 VHDXRegionTableEntry *rt_metadata;
1701
1702 assert(metadata_offset != NULL);
1703
1704
1705
1706 s = g_new0(BDRVVHDXState, 1);
1707
1708 s->chunk_ratio = (VHDX_MAX_SECTORS_PER_BLOCK) *
1709 (uint64_t) sector_size / (uint64_t) block_size;
1710
1711 s->sectors_per_block = block_size / sector_size;
1712 s->virtual_disk_size = image_size;
1713 s->block_size = block_size;
1714 s->logical_sector_size = sector_size;
1715
1716 vhdx_set_shift_bits(s);
1717
1718 vhdx_calc_bat_entries(s);
1719
1720
1721
1722
1723
1724 buffer = g_malloc0(VHDX_HEADER_BLOCK_SIZE);
1725 region_table = buffer;
1726 offset += sizeof(VHDXRegionTableHeader);
1727 rt_bat = buffer + offset;
1728 offset += sizeof(VHDXRegionTableEntry);
1729 rt_metadata = buffer + offset;
1730
1731 region_table->signature = VHDX_REGION_SIGNATURE;
1732 region_table->entry_count = 2;
1733
1734 rt_bat->guid = bat_guid;
1735 rt_bat->length = ROUND_UP(s->bat_entries * sizeof(VHDXBatEntry), MiB);
1736 rt_bat->file_offset = ROUND_UP(VHDX_HEADER_SECTION_END + log_size, MiB);
1737 s->bat_offset = rt_bat->file_offset;
1738
1739 rt_metadata->guid = metadata_guid;
1740 rt_metadata->file_offset = ROUND_UP(rt_bat->file_offset + rt_bat->length,
1741 MiB);
1742 rt_metadata->length = 1 * MiB;
1743 *metadata_offset = rt_metadata->file_offset;
1744
1745 bat_file_offset = rt_bat->file_offset;
1746 bat_length = rt_bat->length;
1747
1748 vhdx_region_header_le_export(region_table);
1749 vhdx_region_entry_le_export(rt_bat);
1750 vhdx_region_entry_le_export(rt_metadata);
1751
1752 vhdx_update_checksum(buffer, VHDX_HEADER_BLOCK_SIZE,
1753 offsetof(VHDXRegionTableHeader, checksum));
1754
1755
1756
1757
1758 ret = vhdx_create_bat(blk, s, image_size, type, use_zero_blocks,
1759 bat_file_offset, bat_length, errp);
1760 if (ret < 0) {
1761 goto exit;
1762 }
1763
1764
1765 ret = blk_pwrite(blk, VHDX_REGION_TABLE_OFFSET, buffer,
1766 VHDX_HEADER_BLOCK_SIZE, 0);
1767 if (ret < 0) {
1768 error_setg_errno(errp, -ret, "Failed to write first region table");
1769 goto exit;
1770 }
1771
1772 ret = blk_pwrite(blk, VHDX_REGION_TABLE2_OFFSET, buffer,
1773 VHDX_HEADER_BLOCK_SIZE, 0);
1774 if (ret < 0) {
1775 error_setg_errno(errp, -ret, "Failed to write second region table");
1776 goto exit;
1777 }
1778
1779exit:
1780 g_free(s);
1781 g_free(buffer);
1782 return ret;
1783}
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802static int vhdx_create(const char *filename, QemuOpts *opts, Error **errp)
1803{
1804 int ret = 0;
1805 uint64_t image_size = (uint64_t) 2 * GiB;
1806 uint32_t log_size = 1 * MiB;
1807 uint32_t block_size = 0;
1808 uint64_t signature;
1809 uint64_t metadata_offset;
1810 bool use_zero_blocks = false;
1811
1812 gunichar2 *creator = NULL;
1813 glong creator_items;
1814 BlockBackend *blk;
1815 char *type = NULL;
1816 VHDXImageType image_type;
1817 Error *local_err = NULL;
1818
1819 image_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
1820 BDRV_SECTOR_SIZE);
1821 log_size = qemu_opt_get_size_del(opts, VHDX_BLOCK_OPT_LOG_SIZE, 0);
1822 block_size = qemu_opt_get_size_del(opts, VHDX_BLOCK_OPT_BLOCK_SIZE, 0);
1823 type = qemu_opt_get_del(opts, BLOCK_OPT_SUBFMT);
1824 use_zero_blocks = qemu_opt_get_bool_del(opts, VHDX_BLOCK_OPT_ZERO, true);
1825
1826 if (image_size > VHDX_MAX_IMAGE_SIZE) {
1827 error_setg_errno(errp, EINVAL, "Image size too large; max of 64TB");
1828 ret = -EINVAL;
1829 goto exit;
1830 }
1831
1832 if (type == NULL) {
1833 type = g_strdup("dynamic");
1834 }
1835
1836 if (!strcmp(type, "dynamic")) {
1837 image_type = VHDX_TYPE_DYNAMIC;
1838 } else if (!strcmp(type, "fixed")) {
1839 image_type = VHDX_TYPE_FIXED;
1840 } else if (!strcmp(type, "differencing")) {
1841 error_setg_errno(errp, ENOTSUP,
1842 "Differencing files not yet supported");
1843 ret = -ENOTSUP;
1844 goto exit;
1845 } else {
1846 error_setg(errp, "Invalid subformat '%s'", type);
1847 ret = -EINVAL;
1848 goto exit;
1849 }
1850
1851
1852
1853 if (block_size == 0) {
1854 if (image_size > 32 * TiB) {
1855 block_size = 64 * MiB;
1856 } else if (image_size > (uint64_t) 100 * GiB) {
1857 block_size = 32 * MiB;
1858 } else if (image_size > 1 * GiB) {
1859 block_size = 16 * MiB;
1860 } else {
1861 block_size = 8 * MiB;
1862 }
1863 }
1864
1865
1866
1867
1868 log_size = ROUND_UP(log_size, MiB);
1869
1870 block_size = ROUND_UP(block_size, MiB);
1871 block_size = block_size > VHDX_BLOCK_SIZE_MAX ? VHDX_BLOCK_SIZE_MAX :
1872 block_size;
1873
1874 ret = bdrv_create_file(filename, opts, &local_err);
1875 if (ret < 0) {
1876 error_propagate(errp, local_err);
1877 goto exit;
1878 }
1879
1880 blk = blk_new_open(filename, NULL, NULL,
1881 BDRV_O_RDWR | BDRV_O_RESIZE | BDRV_O_PROTOCOL,
1882 &local_err);
1883 if (blk == NULL) {
1884 error_propagate(errp, local_err);
1885 ret = -EIO;
1886 goto exit;
1887 }
1888
1889 blk_set_allow_write_beyond_eof(blk, true);
1890
1891
1892
1893
1894
1895 creator = g_utf8_to_utf16("QEMU v" QEMU_VERSION, -1, NULL,
1896 &creator_items, NULL);
1897 signature = cpu_to_le64(VHDX_FILE_SIGNATURE);
1898 ret = blk_pwrite(blk, VHDX_FILE_ID_OFFSET, &signature, sizeof(signature),
1899 0);
1900 if (ret < 0) {
1901 error_setg_errno(errp, -ret, "Failed to write file signature");
1902 goto delete_and_exit;
1903 }
1904 if (creator) {
1905 ret = blk_pwrite(blk, VHDX_FILE_ID_OFFSET + sizeof(signature),
1906 creator, creator_items * sizeof(gunichar2), 0);
1907 if (ret < 0) {
1908 error_setg_errno(errp, -ret, "Failed to write creator field");
1909 goto delete_and_exit;
1910 }
1911 }
1912
1913
1914
1915 ret = vhdx_create_new_headers(blk, image_size, log_size);
1916 if (ret < 0) {
1917 error_setg_errno(errp, -ret, "Failed to write image headers");
1918 goto delete_and_exit;
1919 }
1920
1921
1922 ret = vhdx_create_new_region_table(blk, image_size, block_size, 512,
1923 log_size, use_zero_blocks, image_type,
1924 &metadata_offset, errp);
1925 if (ret < 0) {
1926 goto delete_and_exit;
1927 }
1928
1929
1930 ret = vhdx_create_new_metadata(blk, image_size, block_size, 512,
1931 metadata_offset, image_type);
1932 if (ret < 0) {
1933 error_setg_errno(errp, -ret, "Failed to initialize metadata");
1934 goto delete_and_exit;
1935 }
1936
1937
1938delete_and_exit:
1939 blk_unref(blk);
1940exit:
1941 g_free(type);
1942 g_free(creator);
1943 return ret;
1944}
1945
1946
1947
1948
1949
1950
1951
1952
1953static int vhdx_check(BlockDriverState *bs, BdrvCheckResult *result,
1954 BdrvCheckMode fix)
1955{
1956 BDRVVHDXState *s = bs->opaque;
1957
1958 if (s->log_replayed_on_open) {
1959 result->corruptions_fixed++;
1960 }
1961 return 0;
1962}
1963
1964static QemuOptsList vhdx_create_opts = {
1965 .name = "vhdx-create-opts",
1966 .head = QTAILQ_HEAD_INITIALIZER(vhdx_create_opts.head),
1967 .desc = {
1968 {
1969 .name = BLOCK_OPT_SIZE,
1970 .type = QEMU_OPT_SIZE,
1971 .help = "Virtual disk size; max of 64TB."
1972 },
1973 {
1974 .name = VHDX_BLOCK_OPT_LOG_SIZE,
1975 .type = QEMU_OPT_SIZE,
1976 .def_value_str = stringify(DEFAULT_LOG_SIZE),
1977 .help = "Log size; min 1MB."
1978 },
1979 {
1980 .name = VHDX_BLOCK_OPT_BLOCK_SIZE,
1981 .type = QEMU_OPT_SIZE,
1982 .def_value_str = stringify(0),
1983 .help = "Block Size; min 1MB, max 256MB. " \
1984 "0 means auto-calculate based on image size."
1985 },
1986 {
1987 .name = BLOCK_OPT_SUBFMT,
1988 .type = QEMU_OPT_STRING,
1989 .help = "VHDX format type, can be either 'dynamic' or 'fixed'. "\
1990 "Default is 'dynamic'."
1991 },
1992 {
1993 .name = VHDX_BLOCK_OPT_ZERO,
1994 .type = QEMU_OPT_BOOL,
1995 .help = "Force use of payload blocks of type 'ZERO'. "\
1996 "Non-standard, but default. Do not set to 'off' when "\
1997 "using 'qemu-img convert' with subformat=dynamic."
1998 },
1999 { NULL }
2000 }
2001};
2002
2003static BlockDriver bdrv_vhdx = {
2004 .format_name = "vhdx",
2005 .instance_size = sizeof(BDRVVHDXState),
2006 .bdrv_probe = vhdx_probe,
2007 .bdrv_open = vhdx_open,
2008 .bdrv_close = vhdx_close,
2009 .bdrv_reopen_prepare = vhdx_reopen_prepare,
2010 .bdrv_child_perm = bdrv_format_default_perms,
2011 .bdrv_co_readv = vhdx_co_readv,
2012 .bdrv_co_writev = vhdx_co_writev,
2013 .bdrv_create = vhdx_create,
2014 .bdrv_get_info = vhdx_get_info,
2015 .bdrv_check = vhdx_check,
2016 .bdrv_has_zero_init = bdrv_has_zero_init_1,
2017
2018 .create_opts = &vhdx_create_opts,
2019};
2020
2021static void bdrv_vhdx_init(void)
2022{
2023 bdrv_register(&bdrv_vhdx);
2024}
2025
2026block_init(bdrv_vhdx_init);
2027