]> git.proxmox.com Git - mirror_qemu.git/blame - block/vpc.c
iotests: Send the correct fd in socket_scm_helper
[mirror_qemu.git] / block / vpc.c
CommitLineData
6a0f9e82 1/*
cc2040f8 2 * Block driver for Connectix / Microsoft Virtual PC images
5fafdf24 3 *
6a0f9e82 4 * Copyright (c) 2005 Alex Beregszaszi
15d35bc5 5 * Copyright (c) 2009 Kevin Wolf <kwolf@suse.de>
5fafdf24 6 *
6a0f9e82
FB
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
24 */
faf07963 25#include "qemu-common.h"
737e150e 26#include "block/block_int.h"
1de7afc9 27#include "qemu/module.h"
caf71f86 28#include "migration/migration.h"
1fe1fa51
CA
29#if defined(CONFIG_UUID)
30#include <uuid/uuid.h>
31#endif
6a0f9e82
FB
32
33/**************************************************************/
34
35#define HEADER_SIZE 512
36
37//#define CACHE
38
2cfacb62
AL
39enum vhd_type {
40 VHD_FIXED = 2,
41 VHD_DYNAMIC = 3,
42 VHD_DIFFERENCING = 4,
43};
44
57c7d9e5
AL
45// Seconds since Jan 1, 2000 0:00:00 (UTC)
46#define VHD_TIMESTAMP_BASE 946684800
47
97f1c45c
JC
48#define VHD_MAX_SECTORS (65535LL * 255 * 255)
49
6a0f9e82 50// always big-endian
e54835c0 51typedef struct vhd_footer {
2cfacb62
AL
52 char creator[8]; // "conectix"
53 uint32_t features;
54 uint32_t version;
55
56 // Offset of next header structure, 0xFFFFFFFF if none
57 uint64_t data_offset;
58
59 // Seconds since Jan 1, 2000 0:00:00 (UTC)
60 uint32_t timestamp;
61
62 char creator_app[4]; // "vpc "
63 uint16_t major;
64 uint16_t minor;
65 char creator_os[4]; // "Wi2k"
66
67 uint64_t orig_size;
68 uint64_t size;
69
70 uint16_t cyls;
71 uint8_t heads;
72 uint8_t secs_per_cyl;
73
74 uint32_t type;
75
76 // Checksum of the Hard Disk Footer ("one's complement of the sum of all
77 // the bytes in the footer without the checksum field")
78 uint32_t checksum;
79
80 // UUID used to identify a parent hard disk (backing file)
81 uint8_t uuid[16];
82
83 uint8_t in_saved_state;
e54835c0 84} QEMU_PACKED VHDFooter;
b9fa33a6 85
e54835c0 86typedef struct vhd_dyndisk_header {
2cfacb62
AL
87 char magic[8]; // "cxsparse"
88
89 // Offset of next header structure, 0xFFFFFFFF if none
90 uint64_t data_offset;
91
92 // Offset of the Block Allocation Table (BAT)
93 uint64_t table_offset;
94
95 uint32_t version;
96 uint32_t max_table_entries; // 32bit/entry
97
98 // 2 MB by default, must be a power of two
99 uint32_t block_size;
100
101 uint32_t checksum;
102 uint8_t parent_uuid[16];
103 uint32_t parent_timestamp;
104 uint32_t reserved;
105
106 // Backing file name (in UTF-16)
107 uint8_t parent_name[512];
108
109 struct {
110 uint32_t platform;
111 uint32_t data_space;
112 uint32_t data_length;
113 uint32_t reserved;
114 uint64_t data_offset;
115 } parent_locator[8];
e54835c0 116} QEMU_PACKED VHDDynDiskHeader;
6a0f9e82
FB
117
118typedef struct BDRVVPCState {
848c66e8 119 CoMutex lock;
15d35bc5
AL
120 uint8_t footer_buf[HEADER_SIZE];
121 uint64_t free_data_block_offset;
2cfacb62 122 int max_table_entries;
6a0f9e82 123 uint32_t *pagetable;
15d35bc5
AL
124 uint64_t bat_offset;
125 uint64_t last_bitmap_offset;
6a0f9e82 126
2cfacb62 127 uint32_t block_size;
15d35bc5
AL
128 uint32_t bitmap_size;
129
6a0f9e82
FB
130#ifdef CACHE
131 uint8_t *pageentry_u8;
132 uint32_t *pageentry_u32;
133 uint16_t *pageentry_u16;
3b46e624 134
6a0f9e82
FB
135 uint64_t last_bitmap;
136#endif
612ff3d8
KW
137
138 Error *migration_blocker;
6a0f9e82
FB
139} BDRVVPCState;
140
57c7d9e5
AL
141static uint32_t vpc_checksum(uint8_t* buf, size_t size)
142{
143 uint32_t res = 0;
144 int i;
145
146 for (i = 0; i < size; i++)
147 res += buf[i];
148
149 return ~res;
150}
151
152
6a0f9e82
FB
153static int vpc_probe(const uint8_t *buf, int buf_size, const char *filename)
154{
ffe8ab83 155 if (buf_size >= 8 && !strncmp((char *)buf, "conectix", 8))
6a0f9e82 156 return 100;
6a0f9e82
FB
157 return 0;
158}
159
015a1036
HR
160static int vpc_open(BlockDriverState *bs, QDict *options, int flags,
161 Error **errp)
6a0f9e82
FB
162{
163 BDRVVPCState *s = bs->opaque;
66f82cee 164 int i;
e54835c0
JC
165 VHDFooter *footer;
166 VHDDynDiskHeader *dyndisk_header;
b9fa33a6 167 uint8_t buf[HEADER_SIZE];
57c7d9e5 168 uint32_t checksum;
97f1c45c 169 uint64_t computed_size;
24da78db 170 int disk_type = VHD_DYNAMIC;
59294e46 171 int ret;
6a0f9e82 172
59294e46
KW
173 ret = bdrv_pread(bs->file, 0, s->footer_buf, HEADER_SIZE);
174 if (ret < 0) {
6a0f9e82 175 goto fail;
59294e46 176 }
6a0f9e82 177
e54835c0 178 footer = (VHDFooter *) s->footer_buf;
24da78db
CA
179 if (strncmp(footer->creator, "conectix", 8)) {
180 int64_t offset = bdrv_getlength(bs->file);
59294e46
KW
181 if (offset < 0) {
182 ret = offset;
183 goto fail;
184 } else if (offset < HEADER_SIZE) {
185 ret = -EINVAL;
24da78db
CA
186 goto fail;
187 }
59294e46 188
24da78db 189 /* If a fixed disk, the footer is found only at the end of the file */
59294e46
KW
190 ret = bdrv_pread(bs->file, offset-HEADER_SIZE, s->footer_buf,
191 HEADER_SIZE);
192 if (ret < 0) {
24da78db
CA
193 goto fail;
194 }
195 if (strncmp(footer->creator, "conectix", 8)) {
76abe407
PB
196 error_setg(errp, "invalid VPC image");
197 ret = -EINVAL;
24da78db
CA
198 goto fail;
199 }
200 disk_type = VHD_FIXED;
201 }
6a0f9e82 202
57c7d9e5
AL
203 checksum = be32_to_cpu(footer->checksum);
204 footer->checksum = 0;
205 if (vpc_checksum(s->footer_buf, HEADER_SIZE) != checksum)
206 fprintf(stderr, "block-vpc: The header checksum of '%s' is "
66f82cee 207 "incorrect.\n", bs->filename);
57c7d9e5 208
c088b691
ZS
209 /* Write 'checksum' back to footer, or else will leave it with zero. */
210 footer->checksum = be32_to_cpu(checksum);
211
33ccf667
SH
212 // The visible size of a image in Virtual PC depends on the geometry
213 // rather than on the size stored in the footer (the size in the footer
214 // is too large usually)
215 bs->total_sectors = (int64_t)
216 be16_to_cpu(footer->cyls) * footer->heads * footer->secs_per_cyl;
1fa79228 217
0173e7bb
PL
218 /* images created with disk2vhd report a far higher virtual size
219 * than expected with the cyls * heads * sectors_per_cyl formula.
220 * use the footer->size instead if the image was created with
221 * disk2vhd.
222 */
223 if (!strncmp(footer->creator_app, "d2v", 4)) {
224 bs->total_sectors = be64_to_cpu(footer->size) / BDRV_SECTOR_SIZE;
225 }
226
258d2edb 227 /* Allow a maximum disk size of approximately 2 TB */
97f1c45c 228 if (bs->total_sectors >= VHD_MAX_SECTORS) {
59294e46 229 ret = -EFBIG;
efc8243d
SH
230 goto fail;
231 }
232
24da78db 233 if (disk_type == VHD_DYNAMIC) {
59294e46
KW
234 ret = bdrv_pread(bs->file, be64_to_cpu(footer->data_offset), buf,
235 HEADER_SIZE);
236 if (ret < 0) {
24da78db
CA
237 goto fail;
238 }
b9fa33a6 239
e54835c0 240 dyndisk_header = (VHDDynDiskHeader *) buf;
6a0f9e82 241
24da78db 242 if (strncmp(dyndisk_header->magic, "cxsparse", 8)) {
59294e46 243 ret = -EINVAL;
24da78db
CA
244 goto fail;
245 }
6a0f9e82 246
24da78db 247 s->block_size = be32_to_cpu(dyndisk_header->block_size);
5e71dfad
KW
248 if (!is_power_of_2(s->block_size) || s->block_size < BDRV_SECTOR_SIZE) {
249 error_setg(errp, "Invalid block size %" PRIu32, s->block_size);
250 ret = -EINVAL;
251 goto fail;
252 }
24da78db 253 s->bitmap_size = ((s->block_size / (8 * 512)) + 511) & ~511;
15d35bc5 254
24da78db 255 s->max_table_entries = be32_to_cpu(dyndisk_header->max_table_entries);
97f1c45c
JC
256
257 if ((bs->total_sectors * 512) / s->block_size > 0xffffffffU) {
258 ret = -EINVAL;
259 goto fail;
260 }
261 if (s->max_table_entries > (VHD_MAX_SECTORS * 512) / s->block_size) {
262 ret = -EINVAL;
263 goto fail;
264 }
265
266 computed_size = (uint64_t) s->max_table_entries * s->block_size;
267 if (computed_size < bs->total_sectors * 512) {
268 ret = -EINVAL;
269 goto fail;
270 }
271
5fb09cd5
KW
272 s->pagetable = qemu_try_blockalign(bs->file, s->max_table_entries * 4);
273 if (s->pagetable == NULL) {
274 ret = -ENOMEM;
275 goto fail;
276 }
b71d1c2e 277
24da78db 278 s->bat_offset = be64_to_cpu(dyndisk_header->table_offset);
59294e46
KW
279
280 ret = bdrv_pread(bs->file, s->bat_offset, s->pagetable,
281 s->max_table_entries * 4);
282 if (ret < 0) {
24da78db
CA
283 goto fail;
284 }
b71d1c2e 285
24da78db
CA
286 s->free_data_block_offset =
287 (s->bat_offset + (s->max_table_entries * 4) + 511) & ~511;
15d35bc5 288
24da78db
CA
289 for (i = 0; i < s->max_table_entries; i++) {
290 be32_to_cpus(&s->pagetable[i]);
291 if (s->pagetable[i] != 0xFFFFFFFF) {
292 int64_t next = (512 * (int64_t) s->pagetable[i]) +
293 s->bitmap_size + s->block_size;
15d35bc5 294
24da78db
CA
295 if (next > s->free_data_block_offset) {
296 s->free_data_block_offset = next;
297 }
298 }
15d35bc5 299 }
15d35bc5 300
fb8fe35f
PL
301 if (s->free_data_block_offset > bdrv_getlength(bs->file)) {
302 error_setg(errp, "block-vpc: free_data_block_offset points after "
303 "the end of file. The image has been truncated.");
304 ret = -EINVAL;
305 goto fail;
306 }
307
24da78db 308 s->last_bitmap_offset = (int64_t) -1;
6a0f9e82 309
6a0f9e82 310#ifdef CACHE
24da78db
CA
311 s->pageentry_u8 = g_malloc(512);
312 s->pageentry_u32 = s->pageentry_u8;
313 s->pageentry_u16 = s->pageentry_u8;
314 s->last_pagetable = -1;
6a0f9e82 315#endif
24da78db 316 }
6a0f9e82 317
848c66e8 318 qemu_co_mutex_init(&s->lock);
612ff3d8
KW
319
320 /* Disable migration when VHD images are used */
321 error_set(&s->migration_blocker,
322 QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
323 "vpc", bs->device_name, "live migration");
324 migrate_add_blocker(s->migration_blocker);
325
6a0f9e82 326 return 0;
59294e46
KW
327
328fail:
97f1c45c 329 qemu_vfree(s->pagetable);
59294e46
KW
330#ifdef CACHE
331 g_free(s->pageentry_u8);
332#endif
333 return ret;
6a0f9e82
FB
334}
335
3fe4b700
JC
336static int vpc_reopen_prepare(BDRVReopenState *state,
337 BlockReopenQueue *queue, Error **errp)
338{
339 return 0;
340}
341
b71d1c2e
AL
342/*
343 * Returns the absolute byte offset of the given sector in the image file.
344 * If the sector is not allocated, -1 is returned instead.
15d35bc5
AL
345 *
346 * The parameter write must be 1 if the offset will be used for a write
347 * operation (the block bitmaps is updated then), 0 otherwise.
b71d1c2e 348 */
15d35bc5
AL
349static inline int64_t get_sector_offset(BlockDriverState *bs,
350 int64_t sector_num, int write)
6a0f9e82
FB
351{
352 BDRVVPCState *s = bs->opaque;
353 uint64_t offset = sector_num * 512;
354 uint64_t bitmap_offset, block_offset;
355 uint32_t pagetable_index, pageentry_index;
356
2cfacb62
AL
357 pagetable_index = offset / s->block_size;
358 pageentry_index = (offset % s->block_size) / 512;
3b46e624 359
15d35bc5
AL
360 if (pagetable_index >= s->max_table_entries || s->pagetable[pagetable_index] == 0xffffffff)
361 return -1; // not allocated
6a0f9e82 362
378e2aea 363 bitmap_offset = 512 * (uint64_t) s->pagetable[pagetable_index];
15d35bc5
AL
364 block_offset = bitmap_offset + s->bitmap_size + (512 * pageentry_index);
365
366 // We must ensure that we don't write to any sectors which are marked as
367 // unused in the bitmap. We get away with setting all bits in the block
368 // bitmap each time we write to a new block. This might cause Virtual PC to
369 // miss sparse read optimization, but it's not a problem in terms of
370 // correctness.
371 if (write && (s->last_bitmap_offset != bitmap_offset)) {
372 uint8_t bitmap[s->bitmap_size];
373
374 s->last_bitmap_offset = bitmap_offset;
375 memset(bitmap, 0xff, s->bitmap_size);
078a458e 376 bdrv_pwrite_sync(bs->file, bitmap_offset, bitmap, s->bitmap_size);
15d35bc5 377 }
3b46e624 378
26a76461 379// printf("sector: %" PRIx64 ", index: %x, offset: %x, bioff: %" PRIx64 ", bloff: %" PRIx64 "\n",
6a0f9e82
FB
380// sector_num, pagetable_index, pageentry_index,
381// bitmap_offset, block_offset);
382
383// disabled by reason
384#if 0
385#ifdef CACHE
386 if (bitmap_offset != s->last_bitmap)
387 {
388 lseek(s->fd, bitmap_offset, SEEK_SET);
389
390 s->last_bitmap = bitmap_offset;
5fafdf24 391
6a0f9e82
FB
392 // Scary! Bitmap is stored as big endian 32bit entries,
393 // while we used to look it up byte by byte
394 read(s->fd, s->pageentry_u8, 512);
395 for (i = 0; i < 128; i++)
396 be32_to_cpus(&s->pageentry_u32[i]);
397 }
398
399 if ((s->pageentry_u8[pageentry_index / 8] >> (pageentry_index % 8)) & 1)
400 return -1;
401#else
402 lseek(s->fd, bitmap_offset + (pageentry_index / 8), SEEK_SET);
5fafdf24 403
6a0f9e82
FB
404 read(s->fd, &bitmap_entry, 1);
405
406 if ((bitmap_entry >> (pageentry_index % 8)) & 1)
407 return -1; // not allocated
408#endif
409#endif
6a0f9e82 410
b71d1c2e 411 return block_offset;
6a0f9e82
FB
412}
413
15d35bc5
AL
414/*
415 * Writes the footer to the end of the image file. This is needed when the
416 * file grows as it overwrites the old footer
417 *
418 * Returns 0 on success and < 0 on error
419 */
420static int rewrite_footer(BlockDriverState* bs)
421{
422 int ret;
423 BDRVVPCState *s = bs->opaque;
424 int64_t offset = s->free_data_block_offset;
425
078a458e 426 ret = bdrv_pwrite_sync(bs->file, offset, s->footer_buf, HEADER_SIZE);
15d35bc5
AL
427 if (ret < 0)
428 return ret;
429
430 return 0;
431}
432
433/*
434 * Allocates a new block. This involves writing a new footer and updating
435 * the Block Allocation Table to use the space at the old end of the image
436 * file (overwriting the old footer)
437 *
438 * Returns the sectors' offset in the image file on success and < 0 on error
439 */
440static int64_t alloc_block(BlockDriverState* bs, int64_t sector_num)
441{
442 BDRVVPCState *s = bs->opaque;
443 int64_t bat_offset;
444 uint32_t index, bat_value;
445 int ret;
446 uint8_t bitmap[s->bitmap_size];
447
448 // Check if sector_num is valid
449 if ((sector_num < 0) || (sector_num > bs->total_sectors))
450 return -1;
451
452 // Write entry into in-memory BAT
453 index = (sector_num * 512) / s->block_size;
454 if (s->pagetable[index] != 0xFFFFFFFF)
455 return -1;
456
457 s->pagetable[index] = s->free_data_block_offset / 512;
458
459 // Initialize the block's bitmap
460 memset(bitmap, 0xff, s->bitmap_size);
5bb1cbac 461 ret = bdrv_pwrite_sync(bs->file, s->free_data_block_offset, bitmap,
078a458e 462 s->bitmap_size);
5bb1cbac
KW
463 if (ret < 0) {
464 return ret;
465 }
15d35bc5
AL
466
467 // Write new footer (the old one will be overwritten)
468 s->free_data_block_offset += s->block_size + s->bitmap_size;
469 ret = rewrite_footer(bs);
470 if (ret < 0)
471 goto fail;
472
473 // Write BAT entry to disk
474 bat_offset = s->bat_offset + (4 * index);
475 bat_value = be32_to_cpu(s->pagetable[index]);
078a458e 476 ret = bdrv_pwrite_sync(bs->file, bat_offset, &bat_value, 4);
15d35bc5
AL
477 if (ret < 0)
478 goto fail;
479
480 return get_sector_offset(bs, sector_num, 0);
481
482fail:
483 s->free_data_block_offset -= (s->block_size + s->bitmap_size);
484 return -1;
485}
486
97b00e28
PB
487static int vpc_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
488{
489 BDRVVPCState *s = (BDRVVPCState *)bs->opaque;
490 VHDFooter *footer = (VHDFooter *) s->footer_buf;
491
0d4cc3e7 492 if (be32_to_cpu(footer->type) != VHD_FIXED) {
97b00e28
PB
493 bdi->cluster_size = s->block_size;
494 }
495
95de6d70 496 bdi->unallocated_blocks_are_zero = true;
97b00e28
PB
497 return 0;
498}
499
5fafdf24 500static int vpc_read(BlockDriverState *bs, int64_t sector_num,
6a0f9e82
FB
501 uint8_t *buf, int nb_sectors)
502{
6c6ea921 503 BDRVVPCState *s = bs->opaque;
6a0f9e82 504 int ret;
b71d1c2e 505 int64_t offset;
6c6ea921 506 int64_t sectors, sectors_per_block;
e54835c0 507 VHDFooter *footer = (VHDFooter *) s->footer_buf;
6a0f9e82 508
0d4cc3e7 509 if (be32_to_cpu(footer->type) == VHD_FIXED) {
24da78db
CA
510 return bdrv_read(bs->file, sector_num, buf, nb_sectors);
511 }
6a0f9e82 512 while (nb_sectors > 0) {
15d35bc5 513 offset = get_sector_offset(bs, sector_num, 0);
b71d1c2e 514
6c6ea921
KW
515 sectors_per_block = s->block_size >> BDRV_SECTOR_BITS;
516 sectors = sectors_per_block - (sector_num % sectors_per_block);
517 if (sectors > nb_sectors) {
518 sectors = nb_sectors;
519 }
520
b71d1c2e 521 if (offset == -1) {
6c6ea921 522 memset(buf, 0, sectors * BDRV_SECTOR_SIZE);
b71d1c2e 523 } else {
6c6ea921
KW
524 ret = bdrv_pread(bs->file, offset, buf,
525 sectors * BDRV_SECTOR_SIZE);
526 if (ret != sectors * BDRV_SECTOR_SIZE) {
b71d1c2e 527 return -1;
6c6ea921 528 }
b71d1c2e
AL
529 }
530
6c6ea921
KW
531 nb_sectors -= sectors;
532 sector_num += sectors;
533 buf += sectors * BDRV_SECTOR_SIZE;
6a0f9e82
FB
534 }
535 return 0;
536}
537
2914caa0
PB
538static coroutine_fn int vpc_co_read(BlockDriverState *bs, int64_t sector_num,
539 uint8_t *buf, int nb_sectors)
540{
541 int ret;
542 BDRVVPCState *s = bs->opaque;
543 qemu_co_mutex_lock(&s->lock);
544 ret = vpc_read(bs, sector_num, buf, nb_sectors);
545 qemu_co_mutex_unlock(&s->lock);
546 return ret;
547}
548
15d35bc5
AL
549static int vpc_write(BlockDriverState *bs, int64_t sector_num,
550 const uint8_t *buf, int nb_sectors)
551{
6c6ea921 552 BDRVVPCState *s = bs->opaque;
15d35bc5 553 int64_t offset;
6c6ea921 554 int64_t sectors, sectors_per_block;
15d35bc5 555 int ret;
e54835c0 556 VHDFooter *footer = (VHDFooter *) s->footer_buf;
15d35bc5 557
0d4cc3e7 558 if (be32_to_cpu(footer->type) == VHD_FIXED) {
24da78db
CA
559 return bdrv_write(bs->file, sector_num, buf, nb_sectors);
560 }
15d35bc5
AL
561 while (nb_sectors > 0) {
562 offset = get_sector_offset(bs, sector_num, 1);
563
6c6ea921
KW
564 sectors_per_block = s->block_size >> BDRV_SECTOR_BITS;
565 sectors = sectors_per_block - (sector_num % sectors_per_block);
566 if (sectors > nb_sectors) {
567 sectors = nb_sectors;
568 }
569
15d35bc5
AL
570 if (offset == -1) {
571 offset = alloc_block(bs, sector_num);
572 if (offset < 0)
573 return -1;
574 }
575
6c6ea921
KW
576 ret = bdrv_pwrite(bs->file, offset, buf, sectors * BDRV_SECTOR_SIZE);
577 if (ret != sectors * BDRV_SECTOR_SIZE) {
15d35bc5 578 return -1;
6c6ea921 579 }
15d35bc5 580
6c6ea921
KW
581 nb_sectors -= sectors;
582 sector_num += sectors;
583 buf += sectors * BDRV_SECTOR_SIZE;
15d35bc5
AL
584 }
585
586 return 0;
587}
588
e183ef75
PB
589static coroutine_fn int vpc_co_write(BlockDriverState *bs, int64_t sector_num,
590 const uint8_t *buf, int nb_sectors)
591{
592 int ret;
593 BDRVVPCState *s = bs->opaque;
594 qemu_co_mutex_lock(&s->lock);
595 ret = vpc_write(bs, sector_num, buf, nb_sectors);
596 qemu_co_mutex_unlock(&s->lock);
597 return ret;
598}
599
57c7d9e5
AL
600/*
601 * Calculates the number of cylinders, heads and sectors per cylinder
602 * based on a given number of sectors. This is the algorithm described
603 * in the VHD specification.
604 *
605 * Note that the geometry doesn't always exactly match total_sectors but
606 * may round it down.
6e9ea0c0 607 *
258d2edb
CA
608 * Returns 0 on success, -EFBIG if the size is larger than ~2 TB. Override
609 * the hardware EIDE and ATA-2 limit of 16 heads (max disk size of 127 GB)
610 * and instead allow up to 255 heads.
57c7d9e5 611 */
6e9ea0c0 612static int calculate_geometry(int64_t total_sectors, uint16_t* cyls,
57c7d9e5
AL
613 uint8_t* heads, uint8_t* secs_per_cyl)
614{
615 uint32_t cyls_times_heads;
616
258d2edb
CA
617 /* Allow a maximum disk size of approximately 2 TB */
618 if (total_sectors > 65535LL * 255 * 255) {
6e9ea0c0 619 return -EFBIG;
258d2edb 620 }
57c7d9e5
AL
621
622 if (total_sectors > 65535 * 16 * 63) {
623 *secs_per_cyl = 255;
258d2edb
CA
624 if (total_sectors > 65535 * 16 * 255) {
625 *heads = 255;
626 } else {
627 *heads = 16;
628 }
57c7d9e5
AL
629 cyls_times_heads = total_sectors / *secs_per_cyl;
630 } else {
631 *secs_per_cyl = 17;
632 cyls_times_heads = total_sectors / *secs_per_cyl;
633 *heads = (cyls_times_heads + 1023) / 1024;
634
635 if (*heads < 4)
636 *heads = 4;
637
638 if (cyls_times_heads >= (*heads * 1024) || *heads > 16) {
639 *secs_per_cyl = 31;
640 *heads = 16;
641 cyls_times_heads = total_sectors / *secs_per_cyl;
642 }
643
644 if (cyls_times_heads >= (*heads * 1024)) {
645 *secs_per_cyl = 63;
646 *heads = 16;
647 cyls_times_heads = total_sectors / *secs_per_cyl;
648 }
649 }
650
dede4188 651 *cyls = cyls_times_heads / *heads;
6e9ea0c0
AJ
652
653 return 0;
57c7d9e5
AL
654}
655
fef6070e
JC
656static int create_dynamic_disk(BlockDriverState *bs, uint8_t *buf,
657 int64_t total_sectors)
57c7d9e5 658{
e54835c0
JC
659 VHDDynDiskHeader *dyndisk_header =
660 (VHDDynDiskHeader *) buf;
57c7d9e5 661 size_t block_size, num_bat_entries;
24da78db 662 int i;
fef6070e
JC
663 int ret;
664 int64_t offset = 0;
57c7d9e5 665
57c7d9e5
AL
666 // Write the footer (twice: at the beginning and at the end)
667 block_size = 0x200000;
668 num_bat_entries = (total_sectors + block_size / 512) / (block_size / 512);
669
fef6070e
JC
670 ret = bdrv_pwrite_sync(bs, offset, buf, HEADER_SIZE);
671 if (ret) {
f0ff243a
BS
672 goto fail;
673 }
57c7d9e5 674
fef6070e
JC
675 offset = 1536 + ((num_bat_entries * 4 + 511) & ~511);
676 ret = bdrv_pwrite_sync(bs, offset, buf, HEADER_SIZE);
677 if (ret < 0) {
f0ff243a
BS
678 goto fail;
679 }
57c7d9e5
AL
680
681 // Write the initial BAT
fef6070e 682 offset = 3 * 512;
57c7d9e5
AL
683
684 memset(buf, 0xFF, 512);
f0ff243a 685 for (i = 0; i < (num_bat_entries * 4 + 511) / 512; i++) {
fef6070e
JC
686 ret = bdrv_pwrite_sync(bs, offset, buf, 512);
687 if (ret < 0) {
f0ff243a
BS
688 goto fail;
689 }
fef6070e 690 offset += 512;
f0ff243a 691 }
57c7d9e5 692
57c7d9e5
AL
693 // Prepare the Dynamic Disk Header
694 memset(buf, 0, 1024);
695
5ec4d682 696 memcpy(dyndisk_header->magic, "cxsparse", 8);
57c7d9e5 697
78439f6a
CA
698 /*
699 * Note: The spec is actually wrong here for data_offset, it says
700 * 0xFFFFFFFF, but MS tools expect all 64 bits to be set.
701 */
702 dyndisk_header->data_offset = be64_to_cpu(0xFFFFFFFFFFFFFFFFULL);
57c7d9e5
AL
703 dyndisk_header->table_offset = be64_to_cpu(3 * 512);
704 dyndisk_header->version = be32_to_cpu(0x00010000);
705 dyndisk_header->block_size = be32_to_cpu(block_size);
706 dyndisk_header->max_table_entries = be32_to_cpu(num_bat_entries);
707
708 dyndisk_header->checksum = be32_to_cpu(vpc_checksum(buf, 1024));
709
710 // Write the header
fef6070e 711 offset = 512;
57c7d9e5 712
fef6070e
JC
713 ret = bdrv_pwrite_sync(bs, offset, buf, 1024);
714 if (ret < 0) {
f0ff243a
BS
715 goto fail;
716 }
f0ff243a 717
24da78db
CA
718 fail:
719 return ret;
720}
721
fef6070e
JC
722static int create_fixed_disk(BlockDriverState *bs, uint8_t *buf,
723 int64_t total_size)
24da78db 724{
fef6070e 725 int ret;
24da78db
CA
726
727 /* Add footer to total size */
fef6070e
JC
728 total_size += HEADER_SIZE;
729
730 ret = bdrv_truncate(bs, total_size);
731 if (ret < 0) {
732 return ret;
24da78db
CA
733 }
734
fef6070e
JC
735 ret = bdrv_pwrite_sync(bs, total_size - HEADER_SIZE, buf, HEADER_SIZE);
736 if (ret < 0) {
737 return ret;
738 }
24da78db 739
24da78db
CA
740 return ret;
741}
742
fec9921f 743static int vpc_create(const char *filename, QemuOpts *opts, Error **errp)
24da78db
CA
744{
745 uint8_t buf[1024];
e54835c0 746 VHDFooter *footer = (VHDFooter *) buf;
fec9921f 747 char *disk_type_param;
fef6070e 748 int i;
24da78db
CA
749 uint16_t cyls = 0;
750 uint8_t heads = 0;
751 uint8_t secs_per_cyl = 0;
752 int64_t total_sectors;
753 int64_t total_size;
754 int disk_type;
755 int ret = -EIO;
fef6070e
JC
756 Error *local_err = NULL;
757 BlockDriverState *bs = NULL;
24da78db
CA
758
759 /* Read out options */
fec9921f
CL
760 total_size = qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0);
761 disk_type_param = qemu_opt_get_del(opts, BLOCK_OPT_SUBFMT);
762 if (disk_type_param) {
763 if (!strcmp(disk_type_param, "dynamic")) {
24da78db 764 disk_type = VHD_DYNAMIC;
fec9921f 765 } else if (!strcmp(disk_type_param, "fixed")) {
24da78db
CA
766 disk_type = VHD_FIXED;
767 } else {
fec9921f
CL
768 ret = -EINVAL;
769 goto out;
24da78db
CA
770 }
771 } else {
772 disk_type = VHD_DYNAMIC;
773 }
774
fef6070e
JC
775 ret = bdrv_create_file(filename, opts, &local_err);
776 if (ret < 0) {
777 error_propagate(errp, local_err);
fec9921f 778 goto out;
24da78db 779 }
fef6070e
JC
780 ret = bdrv_open(&bs, filename, NULL, NULL, BDRV_O_RDWR | BDRV_O_PROTOCOL,
781 NULL, &local_err);
782 if (ret < 0) {
783 error_propagate(errp, local_err);
784 goto out;
4ab15590
CL
785 }
786
ecd880d9
KW
787 /*
788 * Calculate matching total_size and geometry. Increase the number of
789 * sectors requested until we get enough (or fail). This ensures that
790 * qemu-img convert doesn't truncate images, but rather rounds up.
791 */
24da78db 792 total_sectors = total_size / BDRV_SECTOR_SIZE;
ecd880d9
KW
793 for (i = 0; total_sectors > (int64_t)cyls * heads * secs_per_cyl; i++) {
794 if (calculate_geometry(total_sectors + i, &cyls, &heads,
795 &secs_per_cyl))
796 {
24da78db 797 ret = -EFBIG;
fef6070e 798 goto out;
24da78db
CA
799 }
800 }
ecd880d9 801
24da78db
CA
802 total_sectors = (int64_t) cyls * heads * secs_per_cyl;
803
804 /* Prepare the Hard Disk Footer */
805 memset(buf, 0, 1024);
806
807 memcpy(footer->creator, "conectix", 8);
808 /* TODO Check if "qemu" creator_app is ok for VPC */
809 memcpy(footer->creator_app, "qemu", 4);
810 memcpy(footer->creator_os, "Wi2k", 4);
811
812 footer->features = be32_to_cpu(0x02);
813 footer->version = be32_to_cpu(0x00010000);
814 if (disk_type == VHD_DYNAMIC) {
815 footer->data_offset = be64_to_cpu(HEADER_SIZE);
816 } else {
817 footer->data_offset = be64_to_cpu(0xFFFFFFFFFFFFFFFFULL);
818 }
819 footer->timestamp = be32_to_cpu(time(NULL) - VHD_TIMESTAMP_BASE);
820
821 /* Version of Virtual PC 2007 */
822 footer->major = be16_to_cpu(0x0005);
823 footer->minor = be16_to_cpu(0x0003);
824 if (disk_type == VHD_DYNAMIC) {
825 footer->orig_size = be64_to_cpu(total_sectors * 512);
826 footer->size = be64_to_cpu(total_sectors * 512);
827 } else {
828 footer->orig_size = be64_to_cpu(total_size);
829 footer->size = be64_to_cpu(total_size);
830 }
831 footer->cyls = be16_to_cpu(cyls);
832 footer->heads = heads;
833 footer->secs_per_cyl = secs_per_cyl;
834
835 footer->type = be32_to_cpu(disk_type);
836
1fe1fa51
CA
837#if defined(CONFIG_UUID)
838 uuid_generate(footer->uuid);
839#endif
24da78db
CA
840
841 footer->checksum = be32_to_cpu(vpc_checksum(buf, HEADER_SIZE));
842
843 if (disk_type == VHD_DYNAMIC) {
fef6070e 844 ret = create_dynamic_disk(bs, buf, total_sectors);
24da78db 845 } else {
fef6070e 846 ret = create_fixed_disk(bs, buf, total_size);
24da78db
CA
847 }
848
fec9921f 849out:
fef6070e 850 bdrv_unref(bs);
fec9921f 851 g_free(disk_type_param);
f0ff243a 852 return ret;
57c7d9e5
AL
853}
854
72c6cc94
KW
855static int vpc_has_zero_init(BlockDriverState *bs)
856{
857 BDRVVPCState *s = bs->opaque;
e54835c0 858 VHDFooter *footer = (VHDFooter *) s->footer_buf;
72c6cc94 859
0d4cc3e7 860 if (be32_to_cpu(footer->type) == VHD_FIXED) {
72c6cc94
KW
861 return bdrv_has_zero_init(bs->file);
862 } else {
863 return 1;
864 }
865}
866
6a0f9e82
FB
867static void vpc_close(BlockDriverState *bs)
868{
869 BDRVVPCState *s = bs->opaque;
97f1c45c 870 qemu_vfree(s->pagetable);
6a0f9e82 871#ifdef CACHE
7267c094 872 g_free(s->pageentry_u8);
6a0f9e82 873#endif
612ff3d8
KW
874
875 migrate_del_blocker(s->migration_blocker);
876 error_free(s->migration_blocker);
6a0f9e82
FB
877}
878
fec9921f
CL
879static QemuOptsList vpc_create_opts = {
880 .name = "vpc-create-opts",
881 .head = QTAILQ_HEAD_INITIALIZER(vpc_create_opts.head),
882 .desc = {
883 {
884 .name = BLOCK_OPT_SIZE,
885 .type = QEMU_OPT_SIZE,
886 .help = "Virtual disk size"
887 },
888 {
889 .name = BLOCK_OPT_SUBFMT,
890 .type = QEMU_OPT_STRING,
891 .help =
892 "Type of virtual hard disk format. Supported formats are "
893 "{dynamic (default) | fixed} "
894 },
4ab15590
CL
895 {
896 .name = BLOCK_OPT_NOCOW,
897 .type = QEMU_OPT_BOOL,
898 .help = "Turn off copy-on-write (valid only on btrfs)"
899 },
fec9921f
CL
900 { /* end of list */ }
901 }
0e7e1989
KW
902};
903
5efa9d5a 904static BlockDriver bdrv_vpc = {
4a411185
KW
905 .format_name = "vpc",
906 .instance_size = sizeof(BDRVVPCState),
c68b89ac 907
72c6cc94
KW
908 .bdrv_probe = vpc_probe,
909 .bdrv_open = vpc_open,
910 .bdrv_close = vpc_close,
911 .bdrv_reopen_prepare = vpc_reopen_prepare,
c282e1fd 912 .bdrv_create = vpc_create,
0e7e1989 913
c68b89ac
KW
914 .bdrv_read = vpc_co_read,
915 .bdrv_write = vpc_co_write,
c68b89ac 916
97b00e28
PB
917 .bdrv_get_info = vpc_get_info,
918
fec9921f 919 .create_opts = &vpc_create_opts,
72c6cc94 920 .bdrv_has_zero_init = vpc_has_zero_init,
6a0f9e82 921};
5efa9d5a
AL
922
923static void bdrv_vpc_init(void)
924{
925 bdrv_register(&bdrv_vpc);
926}
927
928block_init(bdrv_vpc_init);