]> git.proxmox.com Git - mirror_qemu.git/blame - block/vpc.c
vpc: Ignore geometry for large images
[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 209 /* Write 'checksum' back to footer, or else will leave it with zero. */
a4127c42 210 footer->checksum = cpu_to_be32(checksum);
c088b691 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
0444dcee
KW
218 /* Images that have exactly the maximum geometry are probably bigger and
219 * would be truncated if we adhered to the geometry for them. Rely on
220 * footer->size for them. */
221 if (bs->total_sectors == 65535ULL * 16 * 255) {
0173e7bb
PL
222 bs->total_sectors = be64_to_cpu(footer->size) / BDRV_SECTOR_SIZE;
223 }
224
258d2edb 225 /* Allow a maximum disk size of approximately 2 TB */
97f1c45c 226 if (bs->total_sectors >= VHD_MAX_SECTORS) {
59294e46 227 ret = -EFBIG;
efc8243d
SH
228 goto fail;
229 }
230
24da78db 231 if (disk_type == VHD_DYNAMIC) {
59294e46
KW
232 ret = bdrv_pread(bs->file, be64_to_cpu(footer->data_offset), buf,
233 HEADER_SIZE);
234 if (ret < 0) {
24da78db
CA
235 goto fail;
236 }
b9fa33a6 237
e54835c0 238 dyndisk_header = (VHDDynDiskHeader *) buf;
6a0f9e82 239
24da78db 240 if (strncmp(dyndisk_header->magic, "cxsparse", 8)) {
59294e46 241 ret = -EINVAL;
24da78db
CA
242 goto fail;
243 }
6a0f9e82 244
24da78db 245 s->block_size = be32_to_cpu(dyndisk_header->block_size);
5e71dfad
KW
246 if (!is_power_of_2(s->block_size) || s->block_size < BDRV_SECTOR_SIZE) {
247 error_setg(errp, "Invalid block size %" PRIu32, s->block_size);
248 ret = -EINVAL;
249 goto fail;
250 }
24da78db 251 s->bitmap_size = ((s->block_size / (8 * 512)) + 511) & ~511;
15d35bc5 252
24da78db 253 s->max_table_entries = be32_to_cpu(dyndisk_header->max_table_entries);
97f1c45c
JC
254
255 if ((bs->total_sectors * 512) / s->block_size > 0xffffffffU) {
256 ret = -EINVAL;
257 goto fail;
258 }
259 if (s->max_table_entries > (VHD_MAX_SECTORS * 512) / s->block_size) {
260 ret = -EINVAL;
261 goto fail;
262 }
263
264 computed_size = (uint64_t) s->max_table_entries * s->block_size;
265 if (computed_size < bs->total_sectors * 512) {
266 ret = -EINVAL;
267 goto fail;
268 }
269
5fb09cd5
KW
270 s->pagetable = qemu_try_blockalign(bs->file, s->max_table_entries * 4);
271 if (s->pagetable == NULL) {
272 ret = -ENOMEM;
273 goto fail;
274 }
b71d1c2e 275
24da78db 276 s->bat_offset = be64_to_cpu(dyndisk_header->table_offset);
59294e46
KW
277
278 ret = bdrv_pread(bs->file, s->bat_offset, s->pagetable,
279 s->max_table_entries * 4);
280 if (ret < 0) {
24da78db
CA
281 goto fail;
282 }
b71d1c2e 283
24da78db
CA
284 s->free_data_block_offset =
285 (s->bat_offset + (s->max_table_entries * 4) + 511) & ~511;
15d35bc5 286
24da78db
CA
287 for (i = 0; i < s->max_table_entries; i++) {
288 be32_to_cpus(&s->pagetable[i]);
289 if (s->pagetable[i] != 0xFFFFFFFF) {
290 int64_t next = (512 * (int64_t) s->pagetable[i]) +
291 s->bitmap_size + s->block_size;
15d35bc5 292
24da78db
CA
293 if (next > s->free_data_block_offset) {
294 s->free_data_block_offset = next;
295 }
296 }
15d35bc5 297 }
15d35bc5 298
fb8fe35f
PL
299 if (s->free_data_block_offset > bdrv_getlength(bs->file)) {
300 error_setg(errp, "block-vpc: free_data_block_offset points after "
301 "the end of file. The image has been truncated.");
302 ret = -EINVAL;
303 goto fail;
304 }
305
24da78db 306 s->last_bitmap_offset = (int64_t) -1;
6a0f9e82 307
6a0f9e82 308#ifdef CACHE
24da78db
CA
309 s->pageentry_u8 = g_malloc(512);
310 s->pageentry_u32 = s->pageentry_u8;
311 s->pageentry_u16 = s->pageentry_u8;
312 s->last_pagetable = -1;
6a0f9e82 313#endif
24da78db 314 }
6a0f9e82 315
848c66e8 316 qemu_co_mutex_init(&s->lock);
612ff3d8
KW
317
318 /* Disable migration when VHD images are used */
319 error_set(&s->migration_blocker,
320 QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
bfb197e0 321 "vpc", bdrv_get_device_name(bs), "live migration");
612ff3d8
KW
322 migrate_add_blocker(s->migration_blocker);
323
6a0f9e82 324 return 0;
59294e46
KW
325
326fail:
97f1c45c 327 qemu_vfree(s->pagetable);
59294e46
KW
328#ifdef CACHE
329 g_free(s->pageentry_u8);
330#endif
331 return ret;
6a0f9e82
FB
332}
333
3fe4b700
JC
334static int vpc_reopen_prepare(BDRVReopenState *state,
335 BlockReopenQueue *queue, Error **errp)
336{
337 return 0;
338}
339
b71d1c2e
AL
340/*
341 * Returns the absolute byte offset of the given sector in the image file.
342 * If the sector is not allocated, -1 is returned instead.
15d35bc5
AL
343 *
344 * The parameter write must be 1 if the offset will be used for a write
345 * operation (the block bitmaps is updated then), 0 otherwise.
b71d1c2e 346 */
15d35bc5
AL
347static inline int64_t get_sector_offset(BlockDriverState *bs,
348 int64_t sector_num, int write)
6a0f9e82
FB
349{
350 BDRVVPCState *s = bs->opaque;
351 uint64_t offset = sector_num * 512;
352 uint64_t bitmap_offset, block_offset;
353 uint32_t pagetable_index, pageentry_index;
354
2cfacb62
AL
355 pagetable_index = offset / s->block_size;
356 pageentry_index = (offset % s->block_size) / 512;
3b46e624 357
15d35bc5
AL
358 if (pagetable_index >= s->max_table_entries || s->pagetable[pagetable_index] == 0xffffffff)
359 return -1; // not allocated
6a0f9e82 360
378e2aea 361 bitmap_offset = 512 * (uint64_t) s->pagetable[pagetable_index];
15d35bc5
AL
362 block_offset = bitmap_offset + s->bitmap_size + (512 * pageentry_index);
363
364 // We must ensure that we don't write to any sectors which are marked as
365 // unused in the bitmap. We get away with setting all bits in the block
366 // bitmap each time we write to a new block. This might cause Virtual PC to
367 // miss sparse read optimization, but it's not a problem in terms of
368 // correctness.
369 if (write && (s->last_bitmap_offset != bitmap_offset)) {
370 uint8_t bitmap[s->bitmap_size];
371
372 s->last_bitmap_offset = bitmap_offset;
373 memset(bitmap, 0xff, s->bitmap_size);
078a458e 374 bdrv_pwrite_sync(bs->file, bitmap_offset, bitmap, s->bitmap_size);
15d35bc5 375 }
3b46e624 376
26a76461 377// printf("sector: %" PRIx64 ", index: %x, offset: %x, bioff: %" PRIx64 ", bloff: %" PRIx64 "\n",
6a0f9e82
FB
378// sector_num, pagetable_index, pageentry_index,
379// bitmap_offset, block_offset);
380
381// disabled by reason
382#if 0
383#ifdef CACHE
384 if (bitmap_offset != s->last_bitmap)
385 {
386 lseek(s->fd, bitmap_offset, SEEK_SET);
387
388 s->last_bitmap = bitmap_offset;
5fafdf24 389
6a0f9e82
FB
390 // Scary! Bitmap is stored as big endian 32bit entries,
391 // while we used to look it up byte by byte
392 read(s->fd, s->pageentry_u8, 512);
393 for (i = 0; i < 128; i++)
394 be32_to_cpus(&s->pageentry_u32[i]);
395 }
396
397 if ((s->pageentry_u8[pageentry_index / 8] >> (pageentry_index % 8)) & 1)
398 return -1;
399#else
400 lseek(s->fd, bitmap_offset + (pageentry_index / 8), SEEK_SET);
5fafdf24 401
6a0f9e82
FB
402 read(s->fd, &bitmap_entry, 1);
403
404 if ((bitmap_entry >> (pageentry_index % 8)) & 1)
405 return -1; // not allocated
406#endif
407#endif
6a0f9e82 408
b71d1c2e 409 return block_offset;
6a0f9e82
FB
410}
411
15d35bc5
AL
412/*
413 * Writes the footer to the end of the image file. This is needed when the
414 * file grows as it overwrites the old footer
415 *
416 * Returns 0 on success and < 0 on error
417 */
418static int rewrite_footer(BlockDriverState* bs)
419{
420 int ret;
421 BDRVVPCState *s = bs->opaque;
422 int64_t offset = s->free_data_block_offset;
423
078a458e 424 ret = bdrv_pwrite_sync(bs->file, offset, s->footer_buf, HEADER_SIZE);
15d35bc5
AL
425 if (ret < 0)
426 return ret;
427
428 return 0;
429}
430
431/*
432 * Allocates a new block. This involves writing a new footer and updating
433 * the Block Allocation Table to use the space at the old end of the image
434 * file (overwriting the old footer)
435 *
436 * Returns the sectors' offset in the image file on success and < 0 on error
437 */
438static int64_t alloc_block(BlockDriverState* bs, int64_t sector_num)
439{
440 BDRVVPCState *s = bs->opaque;
441 int64_t bat_offset;
442 uint32_t index, bat_value;
443 int ret;
444 uint8_t bitmap[s->bitmap_size];
445
446 // Check if sector_num is valid
447 if ((sector_num < 0) || (sector_num > bs->total_sectors))
448 return -1;
449
450 // Write entry into in-memory BAT
451 index = (sector_num * 512) / s->block_size;
452 if (s->pagetable[index] != 0xFFFFFFFF)
453 return -1;
454
455 s->pagetable[index] = s->free_data_block_offset / 512;
456
457 // Initialize the block's bitmap
458 memset(bitmap, 0xff, s->bitmap_size);
5bb1cbac 459 ret = bdrv_pwrite_sync(bs->file, s->free_data_block_offset, bitmap,
078a458e 460 s->bitmap_size);
5bb1cbac
KW
461 if (ret < 0) {
462 return ret;
463 }
15d35bc5
AL
464
465 // Write new footer (the old one will be overwritten)
466 s->free_data_block_offset += s->block_size + s->bitmap_size;
467 ret = rewrite_footer(bs);
468 if (ret < 0)
469 goto fail;
470
471 // Write BAT entry to disk
472 bat_offset = s->bat_offset + (4 * index);
a4127c42 473 bat_value = cpu_to_be32(s->pagetable[index]);
078a458e 474 ret = bdrv_pwrite_sync(bs->file, bat_offset, &bat_value, 4);
15d35bc5
AL
475 if (ret < 0)
476 goto fail;
477
478 return get_sector_offset(bs, sector_num, 0);
479
480fail:
481 s->free_data_block_offset -= (s->block_size + s->bitmap_size);
482 return -1;
483}
484
97b00e28
PB
485static int vpc_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
486{
487 BDRVVPCState *s = (BDRVVPCState *)bs->opaque;
488 VHDFooter *footer = (VHDFooter *) s->footer_buf;
489
0d4cc3e7 490 if (be32_to_cpu(footer->type) != VHD_FIXED) {
97b00e28
PB
491 bdi->cluster_size = s->block_size;
492 }
493
95de6d70 494 bdi->unallocated_blocks_are_zero = true;
97b00e28
PB
495 return 0;
496}
497
5fafdf24 498static int vpc_read(BlockDriverState *bs, int64_t sector_num,
6a0f9e82
FB
499 uint8_t *buf, int nb_sectors)
500{
6c6ea921 501 BDRVVPCState *s = bs->opaque;
6a0f9e82 502 int ret;
b71d1c2e 503 int64_t offset;
6c6ea921 504 int64_t sectors, sectors_per_block;
e54835c0 505 VHDFooter *footer = (VHDFooter *) s->footer_buf;
6a0f9e82 506
0d4cc3e7 507 if (be32_to_cpu(footer->type) == VHD_FIXED) {
24da78db
CA
508 return bdrv_read(bs->file, sector_num, buf, nb_sectors);
509 }
6a0f9e82 510 while (nb_sectors > 0) {
15d35bc5 511 offset = get_sector_offset(bs, sector_num, 0);
b71d1c2e 512
6c6ea921
KW
513 sectors_per_block = s->block_size >> BDRV_SECTOR_BITS;
514 sectors = sectors_per_block - (sector_num % sectors_per_block);
515 if (sectors > nb_sectors) {
516 sectors = nb_sectors;
517 }
518
b71d1c2e 519 if (offset == -1) {
6c6ea921 520 memset(buf, 0, sectors * BDRV_SECTOR_SIZE);
b71d1c2e 521 } else {
6c6ea921
KW
522 ret = bdrv_pread(bs->file, offset, buf,
523 sectors * BDRV_SECTOR_SIZE);
524 if (ret != sectors * BDRV_SECTOR_SIZE) {
b71d1c2e 525 return -1;
6c6ea921 526 }
b71d1c2e
AL
527 }
528
6c6ea921
KW
529 nb_sectors -= sectors;
530 sector_num += sectors;
531 buf += sectors * BDRV_SECTOR_SIZE;
6a0f9e82
FB
532 }
533 return 0;
534}
535
2914caa0
PB
536static coroutine_fn int vpc_co_read(BlockDriverState *bs, int64_t sector_num,
537 uint8_t *buf, int nb_sectors)
538{
539 int ret;
540 BDRVVPCState *s = bs->opaque;
541 qemu_co_mutex_lock(&s->lock);
542 ret = vpc_read(bs, sector_num, buf, nb_sectors);
543 qemu_co_mutex_unlock(&s->lock);
544 return ret;
545}
546
15d35bc5
AL
547static int vpc_write(BlockDriverState *bs, int64_t sector_num,
548 const uint8_t *buf, int nb_sectors)
549{
6c6ea921 550 BDRVVPCState *s = bs->opaque;
15d35bc5 551 int64_t offset;
6c6ea921 552 int64_t sectors, sectors_per_block;
15d35bc5 553 int ret;
e54835c0 554 VHDFooter *footer = (VHDFooter *) s->footer_buf;
15d35bc5 555
0d4cc3e7 556 if (be32_to_cpu(footer->type) == VHD_FIXED) {
24da78db
CA
557 return bdrv_write(bs->file, sector_num, buf, nb_sectors);
558 }
15d35bc5
AL
559 while (nb_sectors > 0) {
560 offset = get_sector_offset(bs, sector_num, 1);
561
6c6ea921
KW
562 sectors_per_block = s->block_size >> BDRV_SECTOR_BITS;
563 sectors = sectors_per_block - (sector_num % sectors_per_block);
564 if (sectors > nb_sectors) {
565 sectors = nb_sectors;
566 }
567
15d35bc5
AL
568 if (offset == -1) {
569 offset = alloc_block(bs, sector_num);
570 if (offset < 0)
571 return -1;
572 }
573
6c6ea921
KW
574 ret = bdrv_pwrite(bs->file, offset, buf, sectors * BDRV_SECTOR_SIZE);
575 if (ret != sectors * BDRV_SECTOR_SIZE) {
15d35bc5 576 return -1;
6c6ea921 577 }
15d35bc5 578
6c6ea921
KW
579 nb_sectors -= sectors;
580 sector_num += sectors;
581 buf += sectors * BDRV_SECTOR_SIZE;
15d35bc5
AL
582 }
583
584 return 0;
585}
586
e183ef75
PB
587static coroutine_fn int vpc_co_write(BlockDriverState *bs, int64_t sector_num,
588 const uint8_t *buf, int nb_sectors)
589{
590 int ret;
591 BDRVVPCState *s = bs->opaque;
592 qemu_co_mutex_lock(&s->lock);
593 ret = vpc_write(bs, sector_num, buf, nb_sectors);
594 qemu_co_mutex_unlock(&s->lock);
595 return ret;
596}
597
0cc84887
KW
598static int64_t coroutine_fn vpc_co_get_block_status(BlockDriverState *bs,
599 int64_t sector_num, int nb_sectors, int *pnum)
600{
601 BDRVVPCState *s = bs->opaque;
602 VHDFooter *footer = (VHDFooter*) s->footer_buf;
2ec711dc 603 int64_t start, offset;
0cc84887
KW
604 bool allocated;
605 int n;
606
607 if (be32_to_cpu(footer->type) == VHD_FIXED) {
608 *pnum = nb_sectors;
609 return BDRV_BLOCK_RAW | BDRV_BLOCK_OFFSET_VALID | BDRV_BLOCK_DATA |
610 (sector_num << BDRV_SECTOR_BITS);
611 }
612
613 offset = get_sector_offset(bs, sector_num, 0);
614 start = offset;
615 allocated = (offset != -1);
616 *pnum = 0;
617
618 do {
619 /* All sectors in a block are contiguous (without using the bitmap) */
620 n = ROUND_UP(sector_num + 1, s->block_size / BDRV_SECTOR_SIZE)
621 - sector_num;
622 n = MIN(n, nb_sectors);
623
624 *pnum += n;
625 sector_num += n;
626 nb_sectors -= n;
2ec711dc
PL
627 /* *pnum can't be greater than one block for allocated
628 * sectors since there is always a bitmap in between. */
629 if (allocated) {
630 return BDRV_BLOCK_DATA | BDRV_BLOCK_OFFSET_VALID | start;
631 }
0cc84887
KW
632 if (nb_sectors == 0) {
633 break;
634 }
0cc84887 635 offset = get_sector_offset(bs, sector_num, 0);
2ec711dc 636 } while (offset == -1);
0cc84887 637
2ec711dc 638 return 0;
0cc84887
KW
639}
640
57c7d9e5
AL
641/*
642 * Calculates the number of cylinders, heads and sectors per cylinder
643 * based on a given number of sectors. This is the algorithm described
644 * in the VHD specification.
645 *
646 * Note that the geometry doesn't always exactly match total_sectors but
647 * may round it down.
6e9ea0c0 648 *
258d2edb
CA
649 * Returns 0 on success, -EFBIG if the size is larger than ~2 TB. Override
650 * the hardware EIDE and ATA-2 limit of 16 heads (max disk size of 127 GB)
651 * and instead allow up to 255 heads.
57c7d9e5 652 */
6e9ea0c0 653static int calculate_geometry(int64_t total_sectors, uint16_t* cyls,
57c7d9e5
AL
654 uint8_t* heads, uint8_t* secs_per_cyl)
655{
656 uint32_t cyls_times_heads;
657
258d2edb
CA
658 /* Allow a maximum disk size of approximately 2 TB */
659 if (total_sectors > 65535LL * 255 * 255) {
6e9ea0c0 660 return -EFBIG;
258d2edb 661 }
57c7d9e5
AL
662
663 if (total_sectors > 65535 * 16 * 63) {
664 *secs_per_cyl = 255;
258d2edb
CA
665 if (total_sectors > 65535 * 16 * 255) {
666 *heads = 255;
667 } else {
668 *heads = 16;
669 }
57c7d9e5
AL
670 cyls_times_heads = total_sectors / *secs_per_cyl;
671 } else {
672 *secs_per_cyl = 17;
673 cyls_times_heads = total_sectors / *secs_per_cyl;
674 *heads = (cyls_times_heads + 1023) / 1024;
675
676 if (*heads < 4)
677 *heads = 4;
678
679 if (cyls_times_heads >= (*heads * 1024) || *heads > 16) {
680 *secs_per_cyl = 31;
681 *heads = 16;
682 cyls_times_heads = total_sectors / *secs_per_cyl;
683 }
684
685 if (cyls_times_heads >= (*heads * 1024)) {
686 *secs_per_cyl = 63;
687 *heads = 16;
688 cyls_times_heads = total_sectors / *secs_per_cyl;
689 }
690 }
691
dede4188 692 *cyls = cyls_times_heads / *heads;
6e9ea0c0
AJ
693
694 return 0;
57c7d9e5
AL
695}
696
fef6070e
JC
697static int create_dynamic_disk(BlockDriverState *bs, uint8_t *buf,
698 int64_t total_sectors)
57c7d9e5 699{
e54835c0
JC
700 VHDDynDiskHeader *dyndisk_header =
701 (VHDDynDiskHeader *) buf;
57c7d9e5 702 size_t block_size, num_bat_entries;
24da78db 703 int i;
fef6070e
JC
704 int ret;
705 int64_t offset = 0;
57c7d9e5 706
57c7d9e5
AL
707 // Write the footer (twice: at the beginning and at the end)
708 block_size = 0x200000;
709 num_bat_entries = (total_sectors + block_size / 512) / (block_size / 512);
710
fef6070e
JC
711 ret = bdrv_pwrite_sync(bs, offset, buf, HEADER_SIZE);
712 if (ret) {
f0ff243a
BS
713 goto fail;
714 }
57c7d9e5 715
fef6070e
JC
716 offset = 1536 + ((num_bat_entries * 4 + 511) & ~511);
717 ret = bdrv_pwrite_sync(bs, offset, buf, HEADER_SIZE);
718 if (ret < 0) {
f0ff243a
BS
719 goto fail;
720 }
57c7d9e5
AL
721
722 // Write the initial BAT
fef6070e 723 offset = 3 * 512;
57c7d9e5
AL
724
725 memset(buf, 0xFF, 512);
f0ff243a 726 for (i = 0; i < (num_bat_entries * 4 + 511) / 512; i++) {
fef6070e
JC
727 ret = bdrv_pwrite_sync(bs, offset, buf, 512);
728 if (ret < 0) {
f0ff243a
BS
729 goto fail;
730 }
fef6070e 731 offset += 512;
f0ff243a 732 }
57c7d9e5 733
57c7d9e5
AL
734 // Prepare the Dynamic Disk Header
735 memset(buf, 0, 1024);
736
5ec4d682 737 memcpy(dyndisk_header->magic, "cxsparse", 8);
57c7d9e5 738
78439f6a
CA
739 /*
740 * Note: The spec is actually wrong here for data_offset, it says
741 * 0xFFFFFFFF, but MS tools expect all 64 bits to be set.
742 */
a4127c42
SH
743 dyndisk_header->data_offset = cpu_to_be64(0xFFFFFFFFFFFFFFFFULL);
744 dyndisk_header->table_offset = cpu_to_be64(3 * 512);
745 dyndisk_header->version = cpu_to_be32(0x00010000);
746 dyndisk_header->block_size = cpu_to_be32(block_size);
747 dyndisk_header->max_table_entries = cpu_to_be32(num_bat_entries);
57c7d9e5 748
a4127c42 749 dyndisk_header->checksum = cpu_to_be32(vpc_checksum(buf, 1024));
57c7d9e5
AL
750
751 // Write the header
fef6070e 752 offset = 512;
57c7d9e5 753
fef6070e
JC
754 ret = bdrv_pwrite_sync(bs, offset, buf, 1024);
755 if (ret < 0) {
f0ff243a
BS
756 goto fail;
757 }
f0ff243a 758
24da78db
CA
759 fail:
760 return ret;
761}
762
fef6070e
JC
763static int create_fixed_disk(BlockDriverState *bs, uint8_t *buf,
764 int64_t total_size)
24da78db 765{
fef6070e 766 int ret;
24da78db
CA
767
768 /* Add footer to total size */
fef6070e
JC
769 total_size += HEADER_SIZE;
770
771 ret = bdrv_truncate(bs, total_size);
772 if (ret < 0) {
773 return ret;
24da78db
CA
774 }
775
fef6070e
JC
776 ret = bdrv_pwrite_sync(bs, total_size - HEADER_SIZE, buf, HEADER_SIZE);
777 if (ret < 0) {
778 return ret;
779 }
24da78db 780
24da78db
CA
781 return ret;
782}
783
fec9921f 784static int vpc_create(const char *filename, QemuOpts *opts, Error **errp)
24da78db
CA
785{
786 uint8_t buf[1024];
e54835c0 787 VHDFooter *footer = (VHDFooter *) buf;
fec9921f 788 char *disk_type_param;
fef6070e 789 int i;
24da78db
CA
790 uint16_t cyls = 0;
791 uint8_t heads = 0;
792 uint8_t secs_per_cyl = 0;
793 int64_t total_sectors;
794 int64_t total_size;
795 int disk_type;
796 int ret = -EIO;
fef6070e
JC
797 Error *local_err = NULL;
798 BlockDriverState *bs = NULL;
24da78db
CA
799
800 /* Read out options */
c2eb918e
HT
801 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
802 BDRV_SECTOR_SIZE);
fec9921f
CL
803 disk_type_param = qemu_opt_get_del(opts, BLOCK_OPT_SUBFMT);
804 if (disk_type_param) {
805 if (!strcmp(disk_type_param, "dynamic")) {
24da78db 806 disk_type = VHD_DYNAMIC;
fec9921f 807 } else if (!strcmp(disk_type_param, "fixed")) {
24da78db
CA
808 disk_type = VHD_FIXED;
809 } else {
fec9921f
CL
810 ret = -EINVAL;
811 goto out;
24da78db
CA
812 }
813 } else {
814 disk_type = VHD_DYNAMIC;
815 }
816
fef6070e
JC
817 ret = bdrv_create_file(filename, opts, &local_err);
818 if (ret < 0) {
819 error_propagate(errp, local_err);
fec9921f 820 goto out;
24da78db 821 }
fef6070e
JC
822 ret = bdrv_open(&bs, filename, NULL, NULL, BDRV_O_RDWR | BDRV_O_PROTOCOL,
823 NULL, &local_err);
824 if (ret < 0) {
825 error_propagate(errp, local_err);
826 goto out;
4ab15590
CL
827 }
828
ecd880d9
KW
829 /*
830 * Calculate matching total_size and geometry. Increase the number of
831 * sectors requested until we get enough (or fail). This ensures that
832 * qemu-img convert doesn't truncate images, but rather rounds up.
833 */
24da78db 834 total_sectors = total_size / BDRV_SECTOR_SIZE;
ecd880d9
KW
835 for (i = 0; total_sectors > (int64_t)cyls * heads * secs_per_cyl; i++) {
836 if (calculate_geometry(total_sectors + i, &cyls, &heads,
837 &secs_per_cyl))
838 {
24da78db 839 ret = -EFBIG;
fef6070e 840 goto out;
24da78db
CA
841 }
842 }
ecd880d9 843
24da78db 844 total_sectors = (int64_t) cyls * heads * secs_per_cyl;
3f3f20dc 845 total_size = total_sectors * BDRV_SECTOR_SIZE;
24da78db
CA
846
847 /* Prepare the Hard Disk Footer */
848 memset(buf, 0, 1024);
849
850 memcpy(footer->creator, "conectix", 8);
851 /* TODO Check if "qemu" creator_app is ok for VPC */
852 memcpy(footer->creator_app, "qemu", 4);
853 memcpy(footer->creator_os, "Wi2k", 4);
854
a4127c42
SH
855 footer->features = cpu_to_be32(0x02);
856 footer->version = cpu_to_be32(0x00010000);
24da78db 857 if (disk_type == VHD_DYNAMIC) {
a4127c42 858 footer->data_offset = cpu_to_be64(HEADER_SIZE);
24da78db 859 } else {
a4127c42 860 footer->data_offset = cpu_to_be64(0xFFFFFFFFFFFFFFFFULL);
24da78db 861 }
a4127c42 862 footer->timestamp = cpu_to_be32(time(NULL) - VHD_TIMESTAMP_BASE);
24da78db
CA
863
864 /* Version of Virtual PC 2007 */
a4127c42
SH
865 footer->major = cpu_to_be16(0x0005);
866 footer->minor = cpu_to_be16(0x0003);
3f3f20dc
KW
867 footer->orig_size = cpu_to_be64(total_size);
868 footer->size = cpu_to_be64(total_size);
a4127c42 869 footer->cyls = cpu_to_be16(cyls);
24da78db
CA
870 footer->heads = heads;
871 footer->secs_per_cyl = secs_per_cyl;
872
a4127c42 873 footer->type = cpu_to_be32(disk_type);
24da78db 874
1fe1fa51
CA
875#if defined(CONFIG_UUID)
876 uuid_generate(footer->uuid);
877#endif
24da78db 878
a4127c42 879 footer->checksum = cpu_to_be32(vpc_checksum(buf, HEADER_SIZE));
24da78db
CA
880
881 if (disk_type == VHD_DYNAMIC) {
fef6070e 882 ret = create_dynamic_disk(bs, buf, total_sectors);
24da78db 883 } else {
fef6070e 884 ret = create_fixed_disk(bs, buf, total_size);
24da78db
CA
885 }
886
fec9921f 887out:
fef6070e 888 bdrv_unref(bs);
fec9921f 889 g_free(disk_type_param);
f0ff243a 890 return ret;
57c7d9e5
AL
891}
892
72c6cc94
KW
893static int vpc_has_zero_init(BlockDriverState *bs)
894{
895 BDRVVPCState *s = bs->opaque;
e54835c0 896 VHDFooter *footer = (VHDFooter *) s->footer_buf;
72c6cc94 897
0d4cc3e7 898 if (be32_to_cpu(footer->type) == VHD_FIXED) {
72c6cc94
KW
899 return bdrv_has_zero_init(bs->file);
900 } else {
901 return 1;
902 }
903}
904
6a0f9e82
FB
905static void vpc_close(BlockDriverState *bs)
906{
907 BDRVVPCState *s = bs->opaque;
97f1c45c 908 qemu_vfree(s->pagetable);
6a0f9e82 909#ifdef CACHE
7267c094 910 g_free(s->pageentry_u8);
6a0f9e82 911#endif
612ff3d8
KW
912
913 migrate_del_blocker(s->migration_blocker);
914 error_free(s->migration_blocker);
6a0f9e82
FB
915}
916
fec9921f
CL
917static QemuOptsList vpc_create_opts = {
918 .name = "vpc-create-opts",
919 .head = QTAILQ_HEAD_INITIALIZER(vpc_create_opts.head),
920 .desc = {
921 {
922 .name = BLOCK_OPT_SIZE,
923 .type = QEMU_OPT_SIZE,
924 .help = "Virtual disk size"
925 },
926 {
927 .name = BLOCK_OPT_SUBFMT,
928 .type = QEMU_OPT_STRING,
929 .help =
930 "Type of virtual hard disk format. Supported formats are "
931 "{dynamic (default) | fixed} "
932 },
933 { /* end of list */ }
934 }
0e7e1989
KW
935};
936
5efa9d5a 937static BlockDriver bdrv_vpc = {
4a411185
KW
938 .format_name = "vpc",
939 .instance_size = sizeof(BDRVVPCState),
c68b89ac 940
72c6cc94
KW
941 .bdrv_probe = vpc_probe,
942 .bdrv_open = vpc_open,
943 .bdrv_close = vpc_close,
944 .bdrv_reopen_prepare = vpc_reopen_prepare,
c282e1fd 945 .bdrv_create = vpc_create,
0e7e1989 946
0cc84887
KW
947 .bdrv_read = vpc_co_read,
948 .bdrv_write = vpc_co_write,
949 .bdrv_co_get_block_status = vpc_co_get_block_status,
c68b89ac 950
97b00e28
PB
951 .bdrv_get_info = vpc_get_info,
952
fec9921f 953 .create_opts = &vpc_create_opts,
72c6cc94 954 .bdrv_has_zero_init = vpc_has_zero_init,
6a0f9e82 955};
5efa9d5a
AL
956
957static void bdrv_vpc_init(void)
958{
959 bdrv_register(&bdrv_vpc);
960}
961
962block_init(bdrv_vpc_init);