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
;
191 /* This function is called only by parallels_co_writev(), which will never
192 * pass a sector_num at or beyond the end of the image (because the block
193 * layer never passes such a sector_num to that function). Therefore, idx
194 * is always below s->bat_size.
195 * block_status() will limit *pnum so that sector_num + *pnum will not
196 * exceed the image end. Therefore, idx + to_allocate cannot exceed
198 * Note that s->bat_size is an unsigned int, therefore idx + to_allocate
199 * will always fit into a uint32_t. */
200 assert(idx
< s
->bat_size
&& idx
+ to_allocate
<= s
->bat_size
);
202 space
= to_allocate
* s
->tracks
;
203 len
= bdrv_getlength(bs
->file
->bs
);
207 if (s
->data_end
+ space
> (len
>> BDRV_SECTOR_BITS
)) {
208 space
+= s
->prealloc_size
;
210 * We require the expanded size to read back as zero. If the
211 * user permitted truncation, we try that; but if it fails, we
212 * force the safer-but-slower fallocate.
214 if (s
->prealloc_mode
== PRL_PREALLOC_MODE_TRUNCATE
) {
215 ret
= bdrv_co_truncate(bs
->file
,
216 (s
->data_end
+ space
) << BDRV_SECTOR_BITS
,
217 false, PREALLOC_MODE_OFF
,
218 BDRV_REQ_ZERO_WRITE
, NULL
);
219 if (ret
== -ENOTSUP
) {
220 s
->prealloc_mode
= PRL_PREALLOC_MODE_FALLOCATE
;
223 if (s
->prealloc_mode
== PRL_PREALLOC_MODE_FALLOCATE
) {
224 ret
= bdrv_co_pwrite_zeroes(bs
->file
,
225 s
->data_end
<< BDRV_SECTOR_BITS
,
226 space
<< BDRV_SECTOR_BITS
, 0);
233 /* Try to read from backing to fill empty clusters
234 * FIXME: 1. previous write_zeroes may be redundant
235 * 2. most of data we read from backing will be rewritten by
236 * parallels_co_writev. On aligned-to-cluster write we do not need
238 * 3. it would be good to combine write of data from backing and new
239 * data into one write call */
241 int64_t nb_cow_sectors
= to_allocate
* s
->tracks
;
242 int64_t nb_cow_bytes
= nb_cow_sectors
<< BDRV_SECTOR_BITS
;
243 void *buf
= qemu_blockalign(bs
, nb_cow_bytes
);
245 ret
= bdrv_co_pread(bs
->backing
, idx
* s
->tracks
* BDRV_SECTOR_SIZE
,
246 nb_cow_bytes
, buf
, 0);
252 ret
= bdrv_co_pwrite(bs
->file
, s
->data_end
* BDRV_SECTOR_SIZE
,
253 nb_cow_bytes
, buf
, 0);
260 for (i
= 0; i
< to_allocate
; i
++) {
261 parallels_set_bat_entry(s
, idx
+ i
, s
->data_end
/ s
->off_multiplier
);
262 s
->data_end
+= s
->tracks
;
265 return bat2sect(s
, idx
) + sector_num
% s
->tracks
;
269 static int coroutine_fn GRAPH_RDLOCK
270 parallels_co_flush_to_os(BlockDriverState
*bs
)
272 BDRVParallelsState
*s
= bs
->opaque
;
273 unsigned long size
= DIV_ROUND_UP(s
->header_size
, s
->bat_dirty_block
);
276 qemu_co_mutex_lock(&s
->lock
);
278 bit
= find_first_bit(s
->bat_dirty_bmap
, size
);
280 uint32_t off
= bit
* s
->bat_dirty_block
;
281 uint32_t to_write
= s
->bat_dirty_block
;
284 if (off
+ to_write
> s
->header_size
) {
285 to_write
= s
->header_size
- off
;
287 ret
= bdrv_co_pwrite(bs
->file
, off
, to_write
,
288 (uint8_t *)s
->header
+ off
, 0);
290 qemu_co_mutex_unlock(&s
->lock
);
293 bit
= find_next_bit(s
->bat_dirty_bmap
, size
, bit
+ 1);
295 bitmap_zero(s
->bat_dirty_bmap
, size
);
297 qemu_co_mutex_unlock(&s
->lock
);
302 static int coroutine_fn
parallels_co_block_status(BlockDriverState
*bs
,
308 BlockDriverState
**file
)
310 BDRVParallelsState
*s
= bs
->opaque
;
313 assert(QEMU_IS_ALIGNED(offset
| bytes
, BDRV_SECTOR_SIZE
));
314 qemu_co_mutex_lock(&s
->lock
);
315 offset
= block_status(s
, offset
>> BDRV_SECTOR_BITS
,
316 bytes
>> BDRV_SECTOR_BITS
, &count
);
317 qemu_co_mutex_unlock(&s
->lock
);
319 *pnum
= count
* BDRV_SECTOR_SIZE
;
324 *map
= offset
* BDRV_SECTOR_SIZE
;
325 *file
= bs
->file
->bs
;
326 return BDRV_BLOCK_DATA
| BDRV_BLOCK_OFFSET_VALID
;
329 static int coroutine_fn GRAPH_RDLOCK
330 parallels_co_writev(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
331 QEMUIOVector
*qiov
, int flags
)
333 BDRVParallelsState
*s
= bs
->opaque
;
334 uint64_t bytes_done
= 0;
335 QEMUIOVector hd_qiov
;
338 qemu_iovec_init(&hd_qiov
, qiov
->niov
);
340 while (nb_sectors
> 0) {
344 qemu_co_mutex_lock(&s
->lock
);
345 position
= allocate_clusters(bs
, sector_num
, nb_sectors
, &n
);
346 qemu_co_mutex_unlock(&s
->lock
);
352 nbytes
= n
<< BDRV_SECTOR_BITS
;
354 qemu_iovec_reset(&hd_qiov
);
355 qemu_iovec_concat(&hd_qiov
, qiov
, bytes_done
, nbytes
);
357 ret
= bdrv_co_pwritev(bs
->file
, position
* BDRV_SECTOR_SIZE
, nbytes
,
365 bytes_done
+= nbytes
;
368 qemu_iovec_destroy(&hd_qiov
);
372 static int coroutine_fn GRAPH_RDLOCK
373 parallels_co_readv(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
376 BDRVParallelsState
*s
= bs
->opaque
;
377 uint64_t bytes_done
= 0;
378 QEMUIOVector hd_qiov
;
381 qemu_iovec_init(&hd_qiov
, qiov
->niov
);
383 while (nb_sectors
> 0) {
387 qemu_co_mutex_lock(&s
->lock
);
388 position
= block_status(s
, sector_num
, nb_sectors
, &n
);
389 qemu_co_mutex_unlock(&s
->lock
);
391 nbytes
= n
<< BDRV_SECTOR_BITS
;
393 qemu_iovec_reset(&hd_qiov
);
394 qemu_iovec_concat(&hd_qiov
, qiov
, bytes_done
, nbytes
);
398 ret
= bdrv_co_preadv(bs
->backing
, sector_num
* BDRV_SECTOR_SIZE
,
399 nbytes
, &hd_qiov
, 0);
404 qemu_iovec_memset(&hd_qiov
, 0, 0, nbytes
);
407 ret
= bdrv_co_preadv(bs
->file
, position
* BDRV_SECTOR_SIZE
, nbytes
,
416 bytes_done
+= nbytes
;
419 qemu_iovec_destroy(&hd_qiov
);
423 static void parallels_check_unclean(BlockDriverState
*bs
,
424 BdrvCheckResult
*res
,
427 BDRVParallelsState
*s
= bs
->opaque
;
429 if (!s
->header_unclean
) {
433 fprintf(stderr
, "%s image was not closed correctly\n",
434 fix
& BDRV_FIX_ERRORS
? "Repairing" : "ERROR");
436 if (fix
& BDRV_FIX_ERRORS
) {
437 /* parallels_close will do the job right */
438 res
->corruptions_fixed
++;
439 s
->header_unclean
= false;
443 static int coroutine_fn GRAPH_RDLOCK
444 parallels_check_outside_image(BlockDriverState
*bs
, BdrvCheckResult
*res
,
447 BDRVParallelsState
*s
= bs
->opaque
;
449 int64_t off
, high_off
, size
;
451 size
= bdrv_getlength(bs
->file
->bs
);
458 for (i
= 0; i
< s
->bat_size
; i
++) {
459 off
= bat2sect(s
, i
) << BDRV_SECTOR_BITS
;
461 fprintf(stderr
, "%s cluster %u is outside image\n",
462 fix
& BDRV_FIX_ERRORS
? "Repairing" : "ERROR", i
);
464 if (fix
& BDRV_FIX_ERRORS
) {
465 parallels_set_bat_entry(s
, i
, 0);
466 res
->corruptions_fixed
++;
470 if (high_off
< off
) {
476 res
->image_end_offset
= s
->data_end
<< BDRV_SECTOR_BITS
;
478 res
->image_end_offset
= high_off
+ s
->cluster_size
;
479 s
->data_end
= res
->image_end_offset
>> BDRV_SECTOR_BITS
;
485 static int coroutine_fn GRAPH_RDLOCK
486 parallels_check_leak(BlockDriverState
*bs
, BdrvCheckResult
*res
,
489 BDRVParallelsState
*s
= bs
->opaque
;
493 size
= bdrv_getlength(bs
->file
->bs
);
499 if (size
> res
->image_end_offset
) {
501 count
= DIV_ROUND_UP(size
- res
->image_end_offset
, s
->cluster_size
);
502 fprintf(stderr
, "%s space leaked at the end of the image %" PRId64
"\n",
503 fix
& BDRV_FIX_LEAKS
? "Repairing" : "ERROR",
504 size
- res
->image_end_offset
);
506 if (fix
& BDRV_FIX_LEAKS
) {
507 Error
*local_err
= NULL
;
510 * In order to really repair the image, we must shrink it.
511 * That means we have to pass exact=true.
513 ret
= bdrv_co_truncate(bs
->file
, res
->image_end_offset
, true,
514 PREALLOC_MODE_OFF
, 0, &local_err
);
516 error_report_err(local_err
);
520 res
->leaks_fixed
+= count
;
527 static void parallels_collect_statistics(BlockDriverState
*bs
,
528 BdrvCheckResult
*res
,
531 BDRVParallelsState
*s
= bs
->opaque
;
532 int64_t off
, prev_off
;
535 res
->bfi
.total_clusters
= s
->bat_size
;
536 res
->bfi
.compressed_clusters
= 0; /* compression is not supported */
539 for (i
= 0; i
< s
->bat_size
; i
++) {
540 off
= bat2sect(s
, i
) << BDRV_SECTOR_BITS
;
542 * If BDRV_FIX_ERRORS is not set, out-of-image BAT entries were not
543 * fixed. Skip not allocated and out-of-image BAT entries.
545 if (off
== 0 || off
+ s
->cluster_size
> res
->image_end_offset
) {
550 if (prev_off
!= 0 && (prev_off
+ s
->cluster_size
) != off
) {
551 res
->bfi
.fragmented_clusters
++;
554 res
->bfi
.allocated_clusters
++;
558 static int coroutine_fn GRAPH_RDLOCK
559 parallels_co_check(BlockDriverState
*bs
, BdrvCheckResult
*res
,
562 BDRVParallelsState
*s
= bs
->opaque
;
565 qemu_co_mutex_lock(&s
->lock
);
567 parallels_check_unclean(bs
, res
, fix
);
569 ret
= parallels_check_outside_image(bs
, res
, fix
);
574 ret
= parallels_check_leak(bs
, res
, fix
);
579 parallels_collect_statistics(bs
, res
, fix
);
582 qemu_co_mutex_unlock(&s
->lock
);
585 ret
= bdrv_co_flush(bs
);
595 static int coroutine_fn GRAPH_UNLOCKED
596 parallels_co_create(BlockdevCreateOptions
* opts
, Error
**errp
)
598 BlockdevCreateOptionsParallels
*parallels_opts
;
599 BlockDriverState
*bs
;
601 int64_t total_size
, cl_size
;
602 uint32_t bat_entries
, bat_sectors
;
603 ParallelsHeader header
;
604 uint8_t tmp
[BDRV_SECTOR_SIZE
];
607 assert(opts
->driver
== BLOCKDEV_DRIVER_PARALLELS
);
608 parallels_opts
= &opts
->u
.parallels
;
611 total_size
= parallels_opts
->size
;
613 if (parallels_opts
->has_cluster_size
) {
614 cl_size
= parallels_opts
->cluster_size
;
616 cl_size
= DEFAULT_CLUSTER_SIZE
;
619 /* XXX What is the real limit here? This is an insanely large maximum. */
620 if (cl_size
>= INT64_MAX
/ MAX_PARALLELS_IMAGE_FACTOR
) {
621 error_setg(errp
, "Cluster size is too large");
624 if (total_size
>= MAX_PARALLELS_IMAGE_FACTOR
* cl_size
) {
625 error_setg(errp
, "Image size is too large for this cluster size");
629 if (!QEMU_IS_ALIGNED(total_size
, BDRV_SECTOR_SIZE
)) {
630 error_setg(errp
, "Image size must be a multiple of 512 bytes");
634 if (!QEMU_IS_ALIGNED(cl_size
, BDRV_SECTOR_SIZE
)) {
635 error_setg(errp
, "Cluster size must be a multiple of 512 bytes");
639 /* Create BlockBackend to write to the image */
640 bs
= bdrv_co_open_blockdev_ref(parallels_opts
->file
, errp
);
645 blk
= blk_co_new_with_bs(bs
, BLK_PERM_WRITE
| BLK_PERM_RESIZE
, BLK_PERM_ALL
,
651 blk_set_allow_write_beyond_eof(blk
, true);
653 /* Create image format */
654 bat_entries
= DIV_ROUND_UP(total_size
, cl_size
);
655 bat_sectors
= DIV_ROUND_UP(bat_entry_off(bat_entries
), cl_size
);
656 bat_sectors
= (bat_sectors
* cl_size
) >> BDRV_SECTOR_BITS
;
658 memset(&header
, 0, sizeof(header
));
659 memcpy(header
.magic
, HEADER_MAGIC2
, sizeof(header
.magic
));
660 header
.version
= cpu_to_le32(HEADER_VERSION
);
661 /* don't care much about geometry, it is not used on image level */
662 header
.heads
= cpu_to_le32(HEADS_NUMBER
);
663 header
.cylinders
= cpu_to_le32(total_size
/ BDRV_SECTOR_SIZE
664 / HEADS_NUMBER
/ SEC_IN_CYL
);
665 header
.tracks
= cpu_to_le32(cl_size
>> BDRV_SECTOR_BITS
);
666 header
.bat_entries
= cpu_to_le32(bat_entries
);
667 header
.nb_sectors
= cpu_to_le64(DIV_ROUND_UP(total_size
, BDRV_SECTOR_SIZE
));
668 header
.data_off
= cpu_to_le32(bat_sectors
);
670 /* write all the data */
671 memset(tmp
, 0, sizeof(tmp
));
672 memcpy(tmp
, &header
, sizeof(header
));
674 ret
= blk_co_pwrite(blk
, 0, BDRV_SECTOR_SIZE
, tmp
, 0);
678 ret
= blk_co_pwrite_zeroes(blk
, BDRV_SECTOR_SIZE
,
679 (bat_sectors
- 1) << BDRV_SECTOR_BITS
, 0);
691 error_setg_errno(errp
, -ret
, "Failed to create Parallels image");
695 static int coroutine_fn GRAPH_UNLOCKED
696 parallels_co_create_opts(BlockDriver
*drv
, const char *filename
,
697 QemuOpts
*opts
, Error
**errp
)
699 BlockdevCreateOptions
*create_options
= NULL
;
700 BlockDriverState
*bs
= NULL
;
705 static const QDictRenames opt_renames
[] = {
706 { BLOCK_OPT_CLUSTER_SIZE
, "cluster-size" },
710 /* Parse options and convert legacy syntax */
711 qdict
= qemu_opts_to_qdict_filtered(opts
, NULL
, ¶llels_create_opts
,
714 if (!qdict_rename_keys(qdict
, opt_renames
, errp
)) {
719 /* Create and open the file (protocol layer) */
720 ret
= bdrv_co_create_file(filename
, opts
, errp
);
725 bs
= bdrv_co_open(filename
, NULL
, NULL
,
726 BDRV_O_RDWR
| BDRV_O_RESIZE
| BDRV_O_PROTOCOL
, errp
);
732 /* Now get the QAPI type BlockdevCreateOptions */
733 qdict_put_str(qdict
, "driver", "parallels");
734 qdict_put_str(qdict
, "file", bs
->node_name
);
736 v
= qobject_input_visitor_new_flat_confused(qdict
, errp
);
742 visit_type_BlockdevCreateOptions(v
, NULL
, &create_options
, errp
);
744 if (!create_options
) {
749 /* Silently round up sizes */
750 create_options
->u
.parallels
.size
=
751 ROUND_UP(create_options
->u
.parallels
.size
, BDRV_SECTOR_SIZE
);
752 create_options
->u
.parallels
.cluster_size
=
753 ROUND_UP(create_options
->u
.parallels
.cluster_size
, BDRV_SECTOR_SIZE
);
755 /* Create the Parallels image (format layer) */
756 ret
= parallels_co_create(create_options
, errp
);
763 qobject_unref(qdict
);
765 qapi_free_BlockdevCreateOptions(create_options
);
770 static int parallels_probe(const uint8_t *buf
, int buf_size
,
771 const char *filename
)
773 const ParallelsHeader
*ph
= (const void *)buf
;
775 if (buf_size
< sizeof(ParallelsHeader
)) {
779 if ((!memcmp(ph
->magic
, HEADER_MAGIC
, 16) ||
780 !memcmp(ph
->magic
, HEADER_MAGIC2
, 16)) &&
781 (le32_to_cpu(ph
->version
) == HEADER_VERSION
)) {
788 static int parallels_update_header(BlockDriverState
*bs
)
790 BDRVParallelsState
*s
= bs
->opaque
;
791 unsigned size
= MAX(bdrv_opt_mem_align(bs
->file
->bs
),
792 sizeof(ParallelsHeader
));
794 if (size
> s
->header_size
) {
795 size
= s
->header_size
;
797 return bdrv_pwrite_sync(bs
->file
, 0, size
, s
->header
, 0);
800 static int parallels_open(BlockDriverState
*bs
, QDict
*options
, int flags
,
803 BDRVParallelsState
*s
= bs
->opaque
;
806 int64_t file_nb_sectors
;
807 QemuOpts
*opts
= NULL
;
808 Error
*local_err
= NULL
;
811 ret
= bdrv_open_file_child(NULL
, options
, "file", bs
, errp
);
816 file_nb_sectors
= bdrv_nb_sectors(bs
->file
->bs
);
817 if (file_nb_sectors
< 0) {
821 ret
= bdrv_pread(bs
->file
, 0, sizeof(ph
), &ph
, 0);
826 bs
->total_sectors
= le64_to_cpu(ph
.nb_sectors
);
828 if (le32_to_cpu(ph
.version
) != HEADER_VERSION
) {
831 if (!memcmp(ph
.magic
, HEADER_MAGIC
, 16)) {
832 s
->off_multiplier
= 1;
833 bs
->total_sectors
= 0xffffffff & bs
->total_sectors
;
834 } else if (!memcmp(ph
.magic
, HEADER_MAGIC2
, 16)) {
835 s
->off_multiplier
= le32_to_cpu(ph
.tracks
);
840 s
->tracks
= le32_to_cpu(ph
.tracks
);
841 if (s
->tracks
== 0) {
842 error_setg(errp
, "Invalid image: Zero sectors per track");
846 if (s
->tracks
> INT32_MAX
/513) {
847 error_setg(errp
, "Invalid image: Too big cluster");
851 s
->cluster_size
= s
->tracks
<< BDRV_SECTOR_BITS
;
853 s
->bat_size
= le32_to_cpu(ph
.bat_entries
);
854 if (s
->bat_size
> INT_MAX
/ sizeof(uint32_t)) {
855 error_setg(errp
, "Catalog too large");
860 size
= bat_entry_off(s
->bat_size
);
861 s
->header_size
= ROUND_UP(size
, bdrv_opt_mem_align(bs
->file
->bs
));
862 s
->header
= qemu_try_blockalign(bs
->file
->bs
, s
->header_size
);
863 if (s
->header
== NULL
) {
867 s
->data_end
= le32_to_cpu(ph
.data_off
);
868 if (s
->data_end
== 0) {
869 s
->data_end
= ROUND_UP(bat_entry_off(s
->bat_size
), BDRV_SECTOR_SIZE
);
871 if (s
->data_end
< s
->header_size
) {
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... */
874 s
->header_size
= size
;
877 ret
= bdrv_pread(bs
->file
, 0, s
->header_size
, s
->header
, 0);
881 s
->bat_bitmap
= (uint32_t *)(s
->header
+ 1);
883 for (i
= 0; i
< s
->bat_size
; i
++) {
884 int64_t off
= bat2sect(s
, i
);
885 if (off
>= file_nb_sectors
) {
886 if (flags
& BDRV_O_CHECK
) {
889 error_setg(errp
, "parallels: Offset %" PRIi64
" in BAT[%d] entry "
890 "is larger than file size (%" PRIi64
")",
891 off
<< BDRV_SECTOR_BITS
, i
,
892 file_nb_sectors
<< BDRV_SECTOR_BITS
);
896 if (off
>= s
->data_end
) {
897 s
->data_end
= off
+ s
->tracks
;
901 if (le32_to_cpu(ph
.inuse
) == HEADER_INUSE_MAGIC
) {
902 /* Image was not closed correctly. The check is mandatory */
903 s
->header_unclean
= true;
904 if ((flags
& BDRV_O_RDWR
) && !(flags
& BDRV_O_CHECK
)) {
905 error_setg(errp
, "parallels: Image was not closed correctly; "
906 "cannot be opened read/write");
912 opts
= qemu_opts_create(¶llels_runtime_opts
, NULL
, 0, errp
);
917 if (!qemu_opts_absorb_qdict(opts
, options
, errp
)) {
922 qemu_opt_get_size_del(opts
, PARALLELS_OPT_PREALLOC_SIZE
, 0);
923 s
->prealloc_size
= MAX(s
->tracks
, s
->prealloc_size
>> BDRV_SECTOR_BITS
);
924 buf
= qemu_opt_get_del(opts
, PARALLELS_OPT_PREALLOC_MODE
);
925 /* prealloc_mode can be downgraded later during allocate_clusters */
926 s
->prealloc_mode
= qapi_enum_parse(&prealloc_mode_lookup
, buf
,
927 PRL_PREALLOC_MODE_FALLOCATE
,
930 if (local_err
!= NULL
) {
931 error_propagate(errp
, local_err
);
936 if (flags
& BDRV_O_RDWR
) {
938 * It's unsafe to open image RW if there is an extension (as we
939 * don't support it). But parallels driver in QEMU historically
940 * ignores the extension, so print warning and don't care.
942 warn_report("Format Extension ignored in RW mode");
944 ret
= parallels_read_format_extension(
945 bs
, le64_to_cpu(ph
.ext_off
) << BDRV_SECTOR_BITS
, errp
);
952 if ((flags
& BDRV_O_RDWR
) && !(flags
& BDRV_O_INACTIVE
)) {
953 s
->header
->inuse
= cpu_to_le32(HEADER_INUSE_MAGIC
);
954 ret
= parallels_update_header(bs
);
960 s
->bat_dirty_block
= 4 * qemu_real_host_page_size();
962 bitmap_new(DIV_ROUND_UP(s
->header_size
, s
->bat_dirty_block
));
964 /* Disable migration until bdrv_activate method is added */
965 error_setg(&s
->migration_blocker
, "The Parallels format used by node '%s' "
966 "does not support live migration",
967 bdrv_get_device_or_node_name(bs
));
968 ret
= migrate_add_blocker(s
->migration_blocker
, errp
);
970 error_free(s
->migration_blocker
);
973 qemu_co_mutex_init(&s
->lock
);
977 error_setg(errp
, "Image not in Parallels format");
981 qemu_vfree(s
->header
);
986 static void parallels_close(BlockDriverState
*bs
)
988 BDRVParallelsState
*s
= bs
->opaque
;
990 if ((bs
->open_flags
& BDRV_O_RDWR
) && !(bs
->open_flags
& BDRV_O_INACTIVE
)) {
991 s
->header
->inuse
= 0;
992 parallels_update_header(bs
);
994 /* errors are ignored, so we might as well pass exact=true */
995 bdrv_truncate(bs
->file
, s
->data_end
<< BDRV_SECTOR_BITS
, true,
996 PREALLOC_MODE_OFF
, 0, NULL
);
999 g_free(s
->bat_dirty_bmap
);
1000 qemu_vfree(s
->header
);
1002 migrate_del_blocker(s
->migration_blocker
);
1003 error_free(s
->migration_blocker
);
1006 static BlockDriver bdrv_parallels
= {
1007 .format_name
= "parallels",
1008 .instance_size
= sizeof(BDRVParallelsState
),
1009 .bdrv_probe
= parallels_probe
,
1010 .bdrv_open
= parallels_open
,
1011 .bdrv_close
= parallels_close
,
1012 .bdrv_child_perm
= bdrv_default_perms
,
1013 .bdrv_co_block_status
= parallels_co_block_status
,
1014 .bdrv_has_zero_init
= bdrv_has_zero_init_1
,
1015 .bdrv_co_flush_to_os
= parallels_co_flush_to_os
,
1016 .bdrv_co_readv
= parallels_co_readv
,
1017 .bdrv_co_writev
= parallels_co_writev
,
1019 .supports_backing
= true,
1020 .bdrv_co_create
= parallels_co_create
,
1021 .bdrv_co_create_opts
= parallels_co_create_opts
,
1022 .bdrv_co_check
= parallels_co_check
,
1023 .create_opts
= ¶llels_create_opts
,
1026 static void bdrv_parallels_init(void)
1028 bdrv_register(&bdrv_parallels
);
1031 block_init(bdrv_parallels_init
);