2 * Block driver for Parallels disk image format
4 * Copyright (c) 2007 Alex Beregszaszi
5 * Copyright (c) 2015 Denis V. Lunev <den@openvz.org>
7 * This code was originally based on comparing different disk images created
8 * by Parallels. Currently it is based on opened OpenVZ sources
10 * http://git.openvz.org/?p=ploop;a=summary
12 * Permission is hereby granted, free of charge, to any person obtaining a copy
13 * of this software and associated documentation files (the "Software"), to deal
14 * in the Software without restriction, including without limitation the rights
15 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16 * copies of the Software, and to permit persons to whom the Software is
17 * furnished to do so, subject to the following conditions:
19 * The above copyright notice and this permission notice shall be included in
20 * all copies or substantial portions of the Software.
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
25 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
31 #include "qemu/osdep.h"
32 #include "qemu/error-report.h"
33 #include "qapi/error.h"
34 #include "block/block_int.h"
35 #include "block/qdict.h"
36 #include "sysemu/block-backend.h"
37 #include "qemu/module.h"
38 #include "qemu/option.h"
39 #include "qapi/qmp/qdict.h"
40 #include "qapi/qobject-input-visitor.h"
41 #include "qapi/qapi-visit-block-core.h"
42 #include "qemu/bswap.h"
43 #include "qemu/bitmap.h"
44 #include "qemu/memalign.h"
45 #include "migration/blocker.h"
46 #include "parallels.h"
48 /**************************************************************/
50 #define HEADER_MAGIC "WithoutFreeSpace"
51 #define HEADER_MAGIC2 "WithouFreSpacExt"
52 #define HEADER_VERSION 2
53 #define HEADER_INUSE_MAGIC (0x746F6E59)
54 #define MAX_PARALLELS_IMAGE_FACTOR (1ull << 32)
56 static QEnumLookup prealloc_mode_lookup
= {
57 .array
= (const char *const[]) {
61 .size
= PRL_PREALLOC_MODE__MAX
64 #define PARALLELS_OPT_PREALLOC_MODE "prealloc-mode"
65 #define PARALLELS_OPT_PREALLOC_SIZE "prealloc-size"
67 static QemuOptsList parallels_runtime_opts
= {
69 .head
= QTAILQ_HEAD_INITIALIZER(parallels_runtime_opts
.head
),
72 .name
= PARALLELS_OPT_PREALLOC_SIZE
,
73 .type
= QEMU_OPT_SIZE
,
74 .help
= "Preallocation size on image expansion",
75 .def_value_str
= "128M",
78 .name
= PARALLELS_OPT_PREALLOC_MODE
,
79 .type
= QEMU_OPT_STRING
,
80 .help
= "Preallocation mode on image expansion "
81 "(allowed values: falloc, truncate)",
82 .def_value_str
= "falloc",
84 { /* end of list */ },
88 static QemuOptsList parallels_create_opts
= {
89 .name
= "parallels-create-opts",
90 .head
= QTAILQ_HEAD_INITIALIZER(parallels_create_opts
.head
),
93 .name
= BLOCK_OPT_SIZE
,
94 .type
= QEMU_OPT_SIZE
,
95 .help
= "Virtual disk size",
98 .name
= BLOCK_OPT_CLUSTER_SIZE
,
99 .type
= QEMU_OPT_SIZE
,
100 .help
= "Parallels image cluster size",
101 .def_value_str
= stringify(DEFAULT_CLUSTER_SIZE
),
103 { /* end of list */ }
108 static int64_t bat2sect(BDRVParallelsState
*s
, uint32_t idx
)
110 return (uint64_t)le32_to_cpu(s
->bat_bitmap
[idx
]) * s
->off_multiplier
;
113 static uint32_t bat_entry_off(uint32_t idx
)
115 return sizeof(ParallelsHeader
) + sizeof(uint32_t) * idx
;
118 static int64_t seek_to_sector(BDRVParallelsState
*s
, int64_t sector_num
)
120 uint32_t index
, offset
;
122 index
= sector_num
/ s
->tracks
;
123 offset
= sector_num
% s
->tracks
;
126 if ((index
>= s
->bat_size
) || (s
->bat_bitmap
[index
] == 0)) {
129 return bat2sect(s
, index
) + offset
;
132 static int cluster_remainder(BDRVParallelsState
*s
, int64_t sector_num
,
135 int ret
= s
->tracks
- sector_num
% s
->tracks
;
136 return MIN(nb_sectors
, ret
);
139 static int64_t block_status(BDRVParallelsState
*s
, int64_t sector_num
,
140 int nb_sectors
, int *pnum
)
142 int64_t start_off
= -2, prev_end_off
= -2;
145 while (nb_sectors
> 0 || start_off
== -2) {
146 int64_t offset
= seek_to_sector(s
, sector_num
);
149 if (start_off
== -2) {
151 prev_end_off
= offset
;
152 } else if (offset
!= prev_end_off
) {
156 to_end
= cluster_remainder(s
, sector_num
, nb_sectors
);
157 nb_sectors
-= to_end
;
158 sector_num
+= to_end
;
162 prev_end_off
+= to_end
;
168 static void parallels_set_bat_entry(BDRVParallelsState
*s
,
169 uint32_t index
, uint32_t offset
)
171 s
->bat_bitmap
[index
] = cpu_to_le32(offset
);
172 bitmap_set(s
->bat_dirty_bmap
, bat_entry_off(index
) / s
->bat_dirty_block
, 1);
175 static int64_t coroutine_fn GRAPH_RDLOCK
176 allocate_clusters(BlockDriverState
*bs
, int64_t sector_num
,
177 int nb_sectors
, int *pnum
)
180 BDRVParallelsState
*s
= bs
->opaque
;
181 int64_t pos
, space
, idx
, to_allocate
, i
, len
;
183 pos
= block_status(s
, sector_num
, nb_sectors
, pnum
);
188 idx
= sector_num
/ s
->tracks
;
189 to_allocate
= DIV_ROUND_UP(sector_num
+ *pnum
, s
->tracks
) - idx
;
192 * This function is called only by parallels_co_writev(), which will never
193 * pass a sector_num at or beyond the end of the image (because the block
194 * layer never passes such a sector_num to that function). Therefore, idx
195 * is always below s->bat_size.
196 * block_status() will limit *pnum so that sector_num + *pnum will not
197 * exceed the image end. Therefore, idx + to_allocate cannot exceed
199 * Note that s->bat_size is an unsigned int, therefore idx + to_allocate
200 * will always fit into a uint32_t.
202 assert(idx
< s
->bat_size
&& idx
+ to_allocate
<= s
->bat_size
);
204 space
= to_allocate
* s
->tracks
;
205 len
= bdrv_co_getlength(bs
->file
->bs
);
209 if (s
->data_end
+ space
> (len
>> BDRV_SECTOR_BITS
)) {
210 space
+= s
->prealloc_size
;
212 * We require the expanded size to read back as zero. If the
213 * user permitted truncation, we try that; but if it fails, we
214 * force the safer-but-slower fallocate.
216 if (s
->prealloc_mode
== PRL_PREALLOC_MODE_TRUNCATE
) {
217 ret
= bdrv_co_truncate(bs
->file
,
218 (s
->data_end
+ space
) << BDRV_SECTOR_BITS
,
219 false, PREALLOC_MODE_OFF
,
220 BDRV_REQ_ZERO_WRITE
, NULL
);
221 if (ret
== -ENOTSUP
) {
222 s
->prealloc_mode
= PRL_PREALLOC_MODE_FALLOCATE
;
225 if (s
->prealloc_mode
== PRL_PREALLOC_MODE_FALLOCATE
) {
226 ret
= bdrv_co_pwrite_zeroes(bs
->file
,
227 s
->data_end
<< BDRV_SECTOR_BITS
,
228 space
<< BDRV_SECTOR_BITS
, 0);
236 * Try to read from backing to fill empty clusters
237 * FIXME: 1. previous write_zeroes may be redundant
238 * 2. most of data we read from backing will be rewritten by
239 * parallels_co_writev. On aligned-to-cluster write we do not need
241 * 3. it would be good to combine write of data from backing and new
242 * data into one write call.
245 int64_t nb_cow_sectors
= to_allocate
* s
->tracks
;
246 int64_t nb_cow_bytes
= nb_cow_sectors
<< BDRV_SECTOR_BITS
;
247 void *buf
= qemu_blockalign(bs
, nb_cow_bytes
);
249 ret
= bdrv_co_pread(bs
->backing
, idx
* s
->tracks
* BDRV_SECTOR_SIZE
,
250 nb_cow_bytes
, buf
, 0);
256 ret
= bdrv_co_pwrite(bs
->file
, s
->data_end
* BDRV_SECTOR_SIZE
,
257 nb_cow_bytes
, buf
, 0);
264 for (i
= 0; i
< to_allocate
; i
++) {
265 parallels_set_bat_entry(s
, idx
+ i
, s
->data_end
/ s
->off_multiplier
);
266 s
->data_end
+= s
->tracks
;
269 return bat2sect(s
, idx
) + sector_num
% s
->tracks
;
273 static int coroutine_fn GRAPH_RDLOCK
274 parallels_co_flush_to_os(BlockDriverState
*bs
)
276 BDRVParallelsState
*s
= bs
->opaque
;
277 unsigned long size
= DIV_ROUND_UP(s
->header_size
, s
->bat_dirty_block
);
280 qemu_co_mutex_lock(&s
->lock
);
282 bit
= find_first_bit(s
->bat_dirty_bmap
, size
);
284 uint32_t off
= bit
* s
->bat_dirty_block
;
285 uint32_t to_write
= s
->bat_dirty_block
;
288 if (off
+ to_write
> s
->header_size
) {
289 to_write
= s
->header_size
- off
;
291 ret
= bdrv_co_pwrite(bs
->file
, off
, to_write
,
292 (uint8_t *)s
->header
+ off
, 0);
294 qemu_co_mutex_unlock(&s
->lock
);
297 bit
= find_next_bit(s
->bat_dirty_bmap
, size
, bit
+ 1);
299 bitmap_zero(s
->bat_dirty_bmap
, size
);
301 qemu_co_mutex_unlock(&s
->lock
);
306 static int coroutine_fn
parallels_co_block_status(BlockDriverState
*bs
,
312 BlockDriverState
**file
)
314 BDRVParallelsState
*s
= bs
->opaque
;
317 assert(QEMU_IS_ALIGNED(offset
| bytes
, BDRV_SECTOR_SIZE
));
318 qemu_co_mutex_lock(&s
->lock
);
319 offset
= block_status(s
, offset
>> BDRV_SECTOR_BITS
,
320 bytes
>> BDRV_SECTOR_BITS
, &count
);
321 qemu_co_mutex_unlock(&s
->lock
);
323 *pnum
= count
* BDRV_SECTOR_SIZE
;
328 *map
= offset
* BDRV_SECTOR_SIZE
;
329 *file
= bs
->file
->bs
;
330 return BDRV_BLOCK_DATA
| BDRV_BLOCK_OFFSET_VALID
;
333 static int coroutine_fn GRAPH_RDLOCK
334 parallels_co_writev(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
335 QEMUIOVector
*qiov
, int flags
)
337 BDRVParallelsState
*s
= bs
->opaque
;
338 uint64_t bytes_done
= 0;
339 QEMUIOVector hd_qiov
;
342 qemu_iovec_init(&hd_qiov
, qiov
->niov
);
344 while (nb_sectors
> 0) {
348 qemu_co_mutex_lock(&s
->lock
);
349 position
= allocate_clusters(bs
, sector_num
, nb_sectors
, &n
);
350 qemu_co_mutex_unlock(&s
->lock
);
356 nbytes
= n
<< BDRV_SECTOR_BITS
;
358 qemu_iovec_reset(&hd_qiov
);
359 qemu_iovec_concat(&hd_qiov
, qiov
, bytes_done
, nbytes
);
361 ret
= bdrv_co_pwritev(bs
->file
, position
* BDRV_SECTOR_SIZE
, nbytes
,
369 bytes_done
+= nbytes
;
372 qemu_iovec_destroy(&hd_qiov
);
376 static int coroutine_fn GRAPH_RDLOCK
377 parallels_co_readv(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
380 BDRVParallelsState
*s
= bs
->opaque
;
381 uint64_t bytes_done
= 0;
382 QEMUIOVector hd_qiov
;
385 qemu_iovec_init(&hd_qiov
, qiov
->niov
);
387 while (nb_sectors
> 0) {
391 qemu_co_mutex_lock(&s
->lock
);
392 position
= block_status(s
, sector_num
, nb_sectors
, &n
);
393 qemu_co_mutex_unlock(&s
->lock
);
395 nbytes
= n
<< BDRV_SECTOR_BITS
;
397 qemu_iovec_reset(&hd_qiov
);
398 qemu_iovec_concat(&hd_qiov
, qiov
, bytes_done
, nbytes
);
402 ret
= bdrv_co_preadv(bs
->backing
, sector_num
* BDRV_SECTOR_SIZE
,
403 nbytes
, &hd_qiov
, 0);
408 qemu_iovec_memset(&hd_qiov
, 0, 0, nbytes
);
411 ret
= bdrv_co_preadv(bs
->file
, position
* BDRV_SECTOR_SIZE
, nbytes
,
420 bytes_done
+= nbytes
;
423 qemu_iovec_destroy(&hd_qiov
);
427 static void parallels_check_unclean(BlockDriverState
*bs
,
428 BdrvCheckResult
*res
,
431 BDRVParallelsState
*s
= bs
->opaque
;
433 if (!s
->header_unclean
) {
437 fprintf(stderr
, "%s image was not closed correctly\n",
438 fix
& BDRV_FIX_ERRORS
? "Repairing" : "ERROR");
440 if (fix
& BDRV_FIX_ERRORS
) {
441 /* parallels_close will do the job right */
442 res
->corruptions_fixed
++;
443 s
->header_unclean
= false;
447 static int coroutine_fn GRAPH_RDLOCK
448 parallels_check_outside_image(BlockDriverState
*bs
, BdrvCheckResult
*res
,
451 BDRVParallelsState
*s
= bs
->opaque
;
453 int64_t off
, high_off
, size
;
455 size
= bdrv_co_getlength(bs
->file
->bs
);
462 for (i
= 0; i
< s
->bat_size
; i
++) {
463 off
= bat2sect(s
, i
) << BDRV_SECTOR_BITS
;
464 if (off
+ s
->cluster_size
> size
) {
465 fprintf(stderr
, "%s cluster %u is outside image\n",
466 fix
& BDRV_FIX_ERRORS
? "Repairing" : "ERROR", i
);
468 if (fix
& BDRV_FIX_ERRORS
) {
469 parallels_set_bat_entry(s
, i
, 0);
470 res
->corruptions_fixed
++;
474 if (high_off
< off
) {
480 res
->image_end_offset
= s
->data_end
<< BDRV_SECTOR_BITS
;
482 res
->image_end_offset
= high_off
+ s
->cluster_size
;
483 s
->data_end
= res
->image_end_offset
>> BDRV_SECTOR_BITS
;
489 static int coroutine_fn GRAPH_RDLOCK
490 parallels_check_leak(BlockDriverState
*bs
, BdrvCheckResult
*res
,
493 BDRVParallelsState
*s
= bs
->opaque
;
497 size
= bdrv_getlength(bs
->file
->bs
);
503 if (size
> res
->image_end_offset
) {
505 count
= DIV_ROUND_UP(size
- res
->image_end_offset
, s
->cluster_size
);
506 fprintf(stderr
, "%s space leaked at the end of the image %" PRId64
"\n",
507 fix
& BDRV_FIX_LEAKS
? "Repairing" : "ERROR",
508 size
- res
->image_end_offset
);
510 if (fix
& BDRV_FIX_LEAKS
) {
511 Error
*local_err
= NULL
;
514 * In order to really repair the image, we must shrink it.
515 * That means we have to pass exact=true.
517 ret
= bdrv_co_truncate(bs
->file
, res
->image_end_offset
, true,
518 PREALLOC_MODE_OFF
, 0, &local_err
);
520 error_report_err(local_err
);
524 res
->leaks_fixed
+= count
;
531 static void parallels_collect_statistics(BlockDriverState
*bs
,
532 BdrvCheckResult
*res
,
535 BDRVParallelsState
*s
= bs
->opaque
;
536 int64_t off
, prev_off
;
539 res
->bfi
.total_clusters
= s
->bat_size
;
540 res
->bfi
.compressed_clusters
= 0; /* compression is not supported */
543 for (i
= 0; i
< s
->bat_size
; i
++) {
544 off
= bat2sect(s
, i
) << BDRV_SECTOR_BITS
;
546 * If BDRV_FIX_ERRORS is not set, out-of-image BAT entries were not
547 * fixed. Skip not allocated and out-of-image BAT entries.
549 if (off
== 0 || off
+ s
->cluster_size
> res
->image_end_offset
) {
554 if (prev_off
!= 0 && (prev_off
+ s
->cluster_size
) != off
) {
555 res
->bfi
.fragmented_clusters
++;
558 res
->bfi
.allocated_clusters
++;
562 static int coroutine_fn GRAPH_RDLOCK
563 parallels_co_check(BlockDriverState
*bs
, BdrvCheckResult
*res
,
566 BDRVParallelsState
*s
= bs
->opaque
;
569 WITH_QEMU_LOCK_GUARD(&s
->lock
) {
570 parallels_check_unclean(bs
, res
, fix
);
572 ret
= parallels_check_outside_image(bs
, res
, fix
);
577 ret
= parallels_check_leak(bs
, res
, fix
);
582 parallels_collect_statistics(bs
, res
, fix
);
585 ret
= bdrv_co_flush(bs
);
594 static int coroutine_fn GRAPH_UNLOCKED
595 parallels_co_create(BlockdevCreateOptions
* opts
, Error
**errp
)
597 BlockdevCreateOptionsParallels
*parallels_opts
;
598 BlockDriverState
*bs
;
600 int64_t total_size
, cl_size
;
601 uint32_t bat_entries
, bat_sectors
;
602 ParallelsHeader header
;
603 uint8_t tmp
[BDRV_SECTOR_SIZE
];
606 assert(opts
->driver
== BLOCKDEV_DRIVER_PARALLELS
);
607 parallels_opts
= &opts
->u
.parallels
;
610 total_size
= parallels_opts
->size
;
612 if (parallels_opts
->has_cluster_size
) {
613 cl_size
= parallels_opts
->cluster_size
;
615 cl_size
= DEFAULT_CLUSTER_SIZE
;
618 /* XXX What is the real limit here? This is an insanely large maximum. */
619 if (cl_size
>= INT64_MAX
/ MAX_PARALLELS_IMAGE_FACTOR
) {
620 error_setg(errp
, "Cluster size is too large");
623 if (total_size
>= MAX_PARALLELS_IMAGE_FACTOR
* cl_size
) {
624 error_setg(errp
, "Image size is too large for this cluster size");
628 if (!QEMU_IS_ALIGNED(total_size
, BDRV_SECTOR_SIZE
)) {
629 error_setg(errp
, "Image size must be a multiple of 512 bytes");
633 if (!QEMU_IS_ALIGNED(cl_size
, BDRV_SECTOR_SIZE
)) {
634 error_setg(errp
, "Cluster size must be a multiple of 512 bytes");
638 /* Create BlockBackend to write to the image */
639 bs
= bdrv_co_open_blockdev_ref(parallels_opts
->file
, errp
);
644 blk
= blk_co_new_with_bs(bs
, BLK_PERM_WRITE
| BLK_PERM_RESIZE
, BLK_PERM_ALL
,
650 blk_set_allow_write_beyond_eof(blk
, true);
652 /* Create image format */
653 bat_entries
= DIV_ROUND_UP(total_size
, cl_size
);
654 bat_sectors
= DIV_ROUND_UP(bat_entry_off(bat_entries
), cl_size
);
655 bat_sectors
= (bat_sectors
* cl_size
) >> BDRV_SECTOR_BITS
;
657 memset(&header
, 0, sizeof(header
));
658 memcpy(header
.magic
, HEADER_MAGIC2
, sizeof(header
.magic
));
659 header
.version
= cpu_to_le32(HEADER_VERSION
);
660 /* don't care much about geometry, it is not used on image level */
661 header
.heads
= cpu_to_le32(HEADS_NUMBER
);
662 header
.cylinders
= cpu_to_le32(total_size
/ BDRV_SECTOR_SIZE
663 / HEADS_NUMBER
/ SEC_IN_CYL
);
664 header
.tracks
= cpu_to_le32(cl_size
>> BDRV_SECTOR_BITS
);
665 header
.bat_entries
= cpu_to_le32(bat_entries
);
666 header
.nb_sectors
= cpu_to_le64(DIV_ROUND_UP(total_size
, BDRV_SECTOR_SIZE
));
667 header
.data_off
= cpu_to_le32(bat_sectors
);
669 /* write all the data */
670 memset(tmp
, 0, sizeof(tmp
));
671 memcpy(tmp
, &header
, sizeof(header
));
673 ret
= blk_co_pwrite(blk
, 0, BDRV_SECTOR_SIZE
, tmp
, 0);
677 ret
= blk_co_pwrite_zeroes(blk
, BDRV_SECTOR_SIZE
,
678 (bat_sectors
- 1) << BDRV_SECTOR_BITS
, 0);
690 error_setg_errno(errp
, -ret
, "Failed to create Parallels image");
694 static int coroutine_fn GRAPH_UNLOCKED
695 parallels_co_create_opts(BlockDriver
*drv
, const char *filename
,
696 QemuOpts
*opts
, Error
**errp
)
698 BlockdevCreateOptions
*create_options
= NULL
;
699 BlockDriverState
*bs
= NULL
;
704 static const QDictRenames opt_renames
[] = {
705 { BLOCK_OPT_CLUSTER_SIZE
, "cluster-size" },
709 /* Parse options and convert legacy syntax */
710 qdict
= qemu_opts_to_qdict_filtered(opts
, NULL
, ¶llels_create_opts
,
713 if (!qdict_rename_keys(qdict
, opt_renames
, errp
)) {
718 /* Create and open the file (protocol layer) */
719 ret
= bdrv_co_create_file(filename
, opts
, errp
);
724 bs
= bdrv_co_open(filename
, NULL
, NULL
,
725 BDRV_O_RDWR
| BDRV_O_RESIZE
| BDRV_O_PROTOCOL
, errp
);
731 /* Now get the QAPI type BlockdevCreateOptions */
732 qdict_put_str(qdict
, "driver", "parallels");
733 qdict_put_str(qdict
, "file", bs
->node_name
);
735 v
= qobject_input_visitor_new_flat_confused(qdict
, errp
);
741 visit_type_BlockdevCreateOptions(v
, NULL
, &create_options
, errp
);
743 if (!create_options
) {
748 /* Silently round up sizes */
749 create_options
->u
.parallels
.size
=
750 ROUND_UP(create_options
->u
.parallels
.size
, BDRV_SECTOR_SIZE
);
751 create_options
->u
.parallels
.cluster_size
=
752 ROUND_UP(create_options
->u
.parallels
.cluster_size
, BDRV_SECTOR_SIZE
);
754 /* Create the Parallels image (format layer) */
755 ret
= parallels_co_create(create_options
, errp
);
762 qobject_unref(qdict
);
764 qapi_free_BlockdevCreateOptions(create_options
);
769 static int parallels_probe(const uint8_t *buf
, int buf_size
,
770 const char *filename
)
772 const ParallelsHeader
*ph
= (const void *)buf
;
774 if (buf_size
< sizeof(ParallelsHeader
)) {
778 if ((!memcmp(ph
->magic
, HEADER_MAGIC
, 16) ||
779 !memcmp(ph
->magic
, HEADER_MAGIC2
, 16)) &&
780 (le32_to_cpu(ph
->version
) == HEADER_VERSION
)) {
787 static int parallels_update_header(BlockDriverState
*bs
)
789 BDRVParallelsState
*s
= bs
->opaque
;
790 unsigned size
= MAX(bdrv_opt_mem_align(bs
->file
->bs
),
791 sizeof(ParallelsHeader
));
793 if (size
> s
->header_size
) {
794 size
= s
->header_size
;
796 return bdrv_pwrite_sync(bs
->file
, 0, size
, s
->header
, 0);
799 static int parallels_open(BlockDriverState
*bs
, QDict
*options
, int flags
,
802 BDRVParallelsState
*s
= bs
->opaque
;
805 int64_t file_nb_sectors
;
806 QemuOpts
*opts
= NULL
;
807 Error
*local_err
= NULL
;
810 ret
= bdrv_open_file_child(NULL
, options
, "file", bs
, errp
);
815 file_nb_sectors
= bdrv_nb_sectors(bs
->file
->bs
);
816 if (file_nb_sectors
< 0) {
820 ret
= bdrv_pread(bs
->file
, 0, sizeof(ph
), &ph
, 0);
825 bs
->total_sectors
= le64_to_cpu(ph
.nb_sectors
);
827 if (le32_to_cpu(ph
.version
) != HEADER_VERSION
) {
830 if (!memcmp(ph
.magic
, HEADER_MAGIC
, 16)) {
831 s
->off_multiplier
= 1;
832 bs
->total_sectors
= 0xffffffff & bs
->total_sectors
;
833 } else if (!memcmp(ph
.magic
, HEADER_MAGIC2
, 16)) {
834 s
->off_multiplier
= le32_to_cpu(ph
.tracks
);
839 s
->tracks
= le32_to_cpu(ph
.tracks
);
840 if (s
->tracks
== 0) {
841 error_setg(errp
, "Invalid image: Zero sectors per track");
845 if (s
->tracks
> INT32_MAX
/513) {
846 error_setg(errp
, "Invalid image: Too big cluster");
850 s
->cluster_size
= s
->tracks
<< BDRV_SECTOR_BITS
;
852 s
->bat_size
= le32_to_cpu(ph
.bat_entries
);
853 if (s
->bat_size
> INT_MAX
/ sizeof(uint32_t)) {
854 error_setg(errp
, "Catalog too large");
859 size
= bat_entry_off(s
->bat_size
);
860 s
->header_size
= ROUND_UP(size
, bdrv_opt_mem_align(bs
->file
->bs
));
861 s
->header
= qemu_try_blockalign(bs
->file
->bs
, s
->header_size
);
862 if (s
->header
== NULL
) {
866 s
->data_end
= le32_to_cpu(ph
.data_off
);
867 if (s
->data_end
== 0) {
868 s
->data_end
= DIV_ROUND_UP(size
, BDRV_SECTOR_SIZE
);
870 if (s
->data_end
< (s
->header_size
>> BDRV_SECTOR_BITS
)) {
872 * There is not enough unused space to fit to block align between BAT
873 * and actual data. We can't avoid read-modify-write...
875 s
->header_size
= size
;
877 if (s
->data_end
> file_nb_sectors
) {
878 error_setg(errp
, "Invalid image: incorrect data_off field");
883 ret
= bdrv_pread(bs
->file
, 0, s
->header_size
, s
->header
, 0);
887 s
->bat_bitmap
= (uint32_t *)(s
->header
+ 1);
889 for (i
= 0; i
< s
->bat_size
; i
++) {
890 int64_t off
= bat2sect(s
, i
);
891 if (off
>= file_nb_sectors
) {
892 if (flags
& BDRV_O_CHECK
) {
895 error_setg(errp
, "parallels: Offset %" PRIi64
" in BAT[%d] entry "
896 "is larger than file size (%" PRIi64
")",
897 off
<< BDRV_SECTOR_BITS
, i
,
898 file_nb_sectors
<< BDRV_SECTOR_BITS
);
902 if (off
>= s
->data_end
) {
903 s
->data_end
= off
+ s
->tracks
;
907 if (le32_to_cpu(ph
.inuse
) == HEADER_INUSE_MAGIC
) {
908 /* Image was not closed correctly. The check is mandatory */
909 s
->header_unclean
= true;
910 if ((flags
& BDRV_O_RDWR
) && !(flags
& BDRV_O_CHECK
)) {
911 error_setg(errp
, "parallels: Image was not closed correctly; "
912 "cannot be opened read/write");
918 opts
= qemu_opts_create(¶llels_runtime_opts
, NULL
, 0, errp
);
923 if (!qemu_opts_absorb_qdict(opts
, options
, errp
)) {
928 qemu_opt_get_size_del(opts
, PARALLELS_OPT_PREALLOC_SIZE
, 0);
929 s
->prealloc_size
= MAX(s
->tracks
, s
->prealloc_size
>> BDRV_SECTOR_BITS
);
930 buf
= qemu_opt_get_del(opts
, PARALLELS_OPT_PREALLOC_MODE
);
931 /* prealloc_mode can be downgraded later during allocate_clusters */
932 s
->prealloc_mode
= qapi_enum_parse(&prealloc_mode_lookup
, buf
,
933 PRL_PREALLOC_MODE_FALLOCATE
,
936 if (local_err
!= NULL
) {
937 error_propagate(errp
, local_err
);
942 if (flags
& BDRV_O_RDWR
) {
944 * It's unsafe to open image RW if there is an extension (as we
945 * don't support it). But parallels driver in QEMU historically
946 * ignores the extension, so print warning and don't care.
948 warn_report("Format Extension ignored in RW mode");
950 ret
= parallels_read_format_extension(
951 bs
, le64_to_cpu(ph
.ext_off
) << BDRV_SECTOR_BITS
, errp
);
958 if ((flags
& BDRV_O_RDWR
) && !(flags
& BDRV_O_INACTIVE
)) {
959 s
->header
->inuse
= cpu_to_le32(HEADER_INUSE_MAGIC
);
960 ret
= parallels_update_header(bs
);
966 s
->bat_dirty_block
= 4 * qemu_real_host_page_size();
968 bitmap_new(DIV_ROUND_UP(s
->header_size
, s
->bat_dirty_block
));
970 /* Disable migration until bdrv_activate method is added */
971 error_setg(&s
->migration_blocker
, "The Parallels format used by node '%s' "
972 "does not support live migration",
973 bdrv_get_device_or_node_name(bs
));
974 ret
= migrate_add_blocker(s
->migration_blocker
, errp
);
976 error_free(s
->migration_blocker
);
979 qemu_co_mutex_init(&s
->lock
);
983 error_setg(errp
, "Image not in Parallels format");
987 qemu_vfree(s
->header
);
992 static void parallels_close(BlockDriverState
*bs
)
994 BDRVParallelsState
*s
= bs
->opaque
;
996 if ((bs
->open_flags
& BDRV_O_RDWR
) && !(bs
->open_flags
& BDRV_O_INACTIVE
)) {
997 s
->header
->inuse
= 0;
998 parallels_update_header(bs
);
1000 /* errors are ignored, so we might as well pass exact=true */
1001 bdrv_truncate(bs
->file
, s
->data_end
<< BDRV_SECTOR_BITS
, true,
1002 PREALLOC_MODE_OFF
, 0, NULL
);
1005 g_free(s
->bat_dirty_bmap
);
1006 qemu_vfree(s
->header
);
1008 migrate_del_blocker(s
->migration_blocker
);
1009 error_free(s
->migration_blocker
);
1012 static BlockDriver bdrv_parallels
= {
1013 .format_name
= "parallels",
1014 .instance_size
= sizeof(BDRVParallelsState
),
1015 .bdrv_probe
= parallels_probe
,
1016 .bdrv_open
= parallels_open
,
1017 .bdrv_close
= parallels_close
,
1018 .bdrv_child_perm
= bdrv_default_perms
,
1019 .bdrv_co_block_status
= parallels_co_block_status
,
1020 .bdrv_has_zero_init
= bdrv_has_zero_init_1
,
1021 .bdrv_co_flush_to_os
= parallels_co_flush_to_os
,
1022 .bdrv_co_readv
= parallels_co_readv
,
1023 .bdrv_co_writev
= parallels_co_writev
,
1025 .supports_backing
= true,
1026 .bdrv_co_create
= parallels_co_create
,
1027 .bdrv_co_create_opts
= parallels_co_create_opts
,
1028 .bdrv_co_check
= parallels_co_check
,
1029 .create_opts
= ¶llels_create_opts
,
1032 static void bdrv_parallels_init(void)
1034 bdrv_register(&bdrv_parallels
);
1037 block_init(bdrv_parallels_init
);