]> git.proxmox.com Git - mirror_qemu.git/blame - block/dmg.c
dmg: use enumeration type instead of hard coding number
[mirror_qemu.git] / block / dmg.c
CommitLineData
585d0ed9
FB
1/*
2 * QEMU Block driver for DMG images
5fafdf24 3 *
585d0ed9 4 * Copyright (c) 2004 Johannes E. Schindelin
5fafdf24 5 *
585d0ed9
FB
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
80c71a24 24#include "qemu/osdep.h"
da34e65c 25#include "qapi/error.h"
faf07963 26#include "qemu-common.h"
737e150e 27#include "block/block_int.h"
1de7afc9 28#include "qemu/bswap.h"
d49b6836 29#include "qemu/error-report.h"
1de7afc9 30#include "qemu/module.h"
27685a8d
FZ
31#include "dmg.h"
32
33int (*dmg_uncompress_bz2)(char *next_in, unsigned int avail_in,
34 char *next_out, unsigned int avail_out);
585d0ed9 35
7a40b418
JF
36int (*dmg_uncompress_lzfse)(char *next_in, unsigned int avail_in,
37 char *next_out, unsigned int avail_out);
38
c165f775
SH
39enum {
40 /* Limit chunk sizes to prevent unreasonable amounts of memory being used
41 * or truncating when converting to 32-bit types
42 */
43 DMG_LENGTHS_MAX = 64 * 1024 * 1024, /* 64 MB */
44 DMG_SECTORCOUNTS_MAX = DMG_LENGTHS_MAX / 512,
45};
46
95a156f6
JF
47enum {
48 /* DMG Block Type */
49 UDZE = 0, /* Zeroes */
50 UDRW, /* RAW type */
51 UDIG, /* Ignore */
52 UDCO = 0x80000004,
53 UDZO,
54 UDBZ,
55 ULFO,
56 UDCM = 0x7ffffffe, /* Comments */
b47c7d53 57 UDLE = 0xffffffff /* Last Entry */
95a156f6
JF
58};
59
585d0ed9
FB
60static int dmg_probe(const uint8_t *buf, int buf_size, const char *filename)
61{
f5866fa4
KW
62 int len;
63
64 if (!filename) {
65 return 0;
66 }
67
68 len = strlen(filename);
69 if (len > 4 && !strcmp(filename + len - 4, ".dmg")) {
70 return 2;
71 }
585d0ed9
FB
72 return 0;
73}
74
69d34a36 75static int read_uint64(BlockDriverState *bs, int64_t offset, uint64_t *result)
585d0ed9 76{
69d34a36
KW
77 uint64_t buffer;
78 int ret;
79
cf2ab8fc 80 ret = bdrv_pread(bs->file, offset, &buffer, 8);
69d34a36
KW
81 if (ret < 0) {
82 return ret;
83 }
84
85 *result = be64_to_cpu(buffer);
86 return 0;
585d0ed9
FB
87}
88
69d34a36 89static int read_uint32(BlockDriverState *bs, int64_t offset, uint32_t *result)
585d0ed9 90{
69d34a36
KW
91 uint32_t buffer;
92 int ret;
93
cf2ab8fc 94 ret = bdrv_pread(bs->file, offset, &buffer, 4);
69d34a36
KW
95 if (ret < 0) {
96 return ret;
97 }
98
99 *result = be32_to_cpu(buffer);
100 return 0;
585d0ed9
FB
101}
102
7aee37b9
PW
103static inline uint64_t buff_read_uint64(const uint8_t *buffer, int64_t offset)
104{
105 return be64_to_cpu(*(uint64_t *)&buffer[offset]);
106}
107
108static inline uint32_t buff_read_uint32(const uint8_t *buffer, int64_t offset)
109{
110 return be32_to_cpu(*(uint32_t *)&buffer[offset]);
111}
112
f0dce234
SH
113/* Increase max chunk sizes, if necessary. This function is used to calculate
114 * the buffer sizes needed for compressed/uncompressed chunk I/O.
115 */
116static void update_max_chunk_size(BDRVDMGState *s, uint32_t chunk,
117 uint32_t *max_compressed_size,
118 uint32_t *max_sectors_per_chunk)
119{
120 uint32_t compressed_size = 0;
121 uint32_t uncompressed_sectors = 0;
122
123 switch (s->types[chunk]) {
95a156f6
JF
124 case UDZO: /* zlib compressed */
125 case UDBZ: /* bzip2 compressed */
126 case ULFO: /* lzfse compressed */
f0dce234
SH
127 compressed_size = s->lengths[chunk];
128 uncompressed_sectors = s->sectorcounts[chunk];
129 break;
95a156f6 130 case UDRW: /* copy */
6fb0022b 131 uncompressed_sectors = DIV_ROUND_UP(s->lengths[chunk], 512);
f0dce234 132 break;
95a156f6 133 case UDIG: /* zero */
177b7510
PW
134 /* as the all-zeroes block may be large, it is treated specially: the
135 * sector is not copied from a large buffer, a simple memset is used
136 * instead. Therefore uncompressed_sectors does not need to be set. */
f0dce234
SH
137 break;
138 }
139
140 if (compressed_size > *max_compressed_size) {
141 *max_compressed_size = compressed_size;
142 }
143 if (uncompressed_sectors > *max_sectors_per_chunk) {
144 *max_sectors_per_chunk = uncompressed_sectors;
145 }
146}
147
cf2ab8fc 148static int64_t dmg_find_koly_offset(BdrvChild *file, Error **errp)
fa8354bd 149{
cf2ab8fc 150 BlockDriverState *file_bs = file->bs;
fa8354bd
PW
151 int64_t length;
152 int64_t offset = 0;
153 uint8_t buffer[515];
154 int i, ret;
155
156 /* bdrv_getlength returns a multiple of block size (512), rounded up. Since
157 * dmg images can have odd sizes, try to look for the "koly" magic which
158 * marks the begin of the UDIF trailer (512 bytes). This magic can be found
159 * in the last 511 bytes of the second-last sector or the first 4 bytes of
160 * the last sector (search space: 515 bytes) */
161 length = bdrv_getlength(file_bs);
162 if (length < 0) {
163 error_setg_errno(errp, -length,
164 "Failed to get file size while reading UDIF trailer");
165 return length;
166 } else if (length < 512) {
167 error_setg(errp, "dmg file must be at least 512 bytes long");
168 return -EINVAL;
169 }
170 if (length > 511 + 512) {
171 offset = length - 511 - 512;
172 }
173 length = length < 515 ? length : 515;
cf2ab8fc 174 ret = bdrv_pread(file, offset, buffer, length);
fa8354bd
PW
175 if (ret < 0) {
176 error_setg_errno(errp, -ret, "Failed while reading UDIF trailer");
177 return ret;
178 }
179 for (i = 0; i < length - 3; i++) {
180 if (buffer[i] == 'k' && buffer[i+1] == 'o' &&
181 buffer[i+2] == 'l' && buffer[i+3] == 'y') {
182 return offset + i;
183 }
184 }
185 error_setg(errp, "Could not locate UDIF trailer in dmg file");
186 return -EINVAL;
187}
188
65a1c7c9
PW
189/* used when building the sector table */
190typedef struct DmgHeaderState {
191 /* used internally by dmg_read_mish_block to remember offsets of blocks
192 * across calls */
c6d34865 193 uint64_t data_fork_offset;
65a1c7c9
PW
194 /* exported for dmg_open */
195 uint32_t max_compressed_size;
196 uint32_t max_sectors_per_chunk;
197} DmgHeaderState;
198
a8b10c6e
PW
199static bool dmg_is_known_block_type(uint32_t entry_type)
200{
201 switch (entry_type) {
95a156f6
JF
202 case UDRW: /* uncompressed */
203 case UDIG: /* zeroes */
204 case UDZO: /* zlib */
a8b10c6e 205 return true;
95a156f6 206 case UDBZ: /* bzip2 */
27685a8d 207 return !!dmg_uncompress_bz2;
95a156f6 208 case ULFO: /* lzfse */
7a40b418 209 return !!dmg_uncompress_lzfse;
a8b10c6e
PW
210 default:
211 return false;
212 }
213}
214
7aee37b9
PW
215static int dmg_read_mish_block(BDRVDMGState *s, DmgHeaderState *ds,
216 uint8_t *buffer, uint32_t count)
65a1c7c9 217{
65a1c7c9
PW
218 uint32_t type, i;
219 int ret;
220 size_t new_size;
221 uint32_t chunk_count;
7aee37b9 222 int64_t offset = 0;
c6d34865
PW
223 uint64_t data_offset;
224 uint64_t in_offset = ds->data_fork_offset;
66ec3bba 225 uint64_t out_offset;
65a1c7c9 226
7aee37b9 227 type = buff_read_uint32(buffer, offset);
65a1c7c9
PW
228 /* skip data that is not a valid MISH block (invalid magic or too small) */
229 if (type != 0x6d697368 || count < 244) {
230 /* assume success for now */
231 return 0;
232 }
233
66ec3bba
PW
234 /* chunk offsets are relative to this sector number */
235 out_offset = buff_read_uint64(buffer, offset + 8);
236
c6d34865
PW
237 /* location in data fork for (compressed) blob (in bytes) */
238 data_offset = buff_read_uint64(buffer, offset + 0x18);
239 in_offset += data_offset;
240
241 /* move to begin of chunk entries */
242 offset += 204;
65a1c7c9
PW
243
244 chunk_count = (count - 204) / 40;
245 new_size = sizeof(uint64_t) * (s->n_chunks + chunk_count);
246 s->types = g_realloc(s->types, new_size / 2);
247 s->offsets = g_realloc(s->offsets, new_size);
248 s->lengths = g_realloc(s->lengths, new_size);
249 s->sectors = g_realloc(s->sectors, new_size);
250 s->sectorcounts = g_realloc(s->sectorcounts, new_size);
251
252 for (i = s->n_chunks; i < s->n_chunks + chunk_count; i++) {
7aee37b9 253 s->types[i] = buff_read_uint32(buffer, offset);
a8b10c6e 254 if (!dmg_is_known_block_type(s->types[i])) {
65a1c7c9
PW
255 chunk_count--;
256 i--;
a8b10c6e 257 offset += 40;
65a1c7c9
PW
258 continue;
259 }
65a1c7c9 260
a8b10c6e
PW
261 /* sector number */
262 s->sectors[i] = buff_read_uint64(buffer, offset + 8);
66ec3bba 263 s->sectors[i] += out_offset;
65a1c7c9 264
a8b10c6e
PW
265 /* sector count */
266 s->sectorcounts[i] = buff_read_uint64(buffer, offset + 0x10);
65a1c7c9 267
177b7510
PW
268 /* all-zeroes sector (type 2) does not need to be "uncompressed" and can
269 * therefore be unbounded. */
e80fcf59 270 if (s->types[i] != UDIG && s->sectorcounts[i] > DMG_SECTORCOUNTS_MAX) {
65a1c7c9
PW
271 error_report("sector count %" PRIu64 " for chunk %" PRIu32
272 " is larger than max (%u)",
273 s->sectorcounts[i], i, DMG_SECTORCOUNTS_MAX);
274 ret = -EINVAL;
275 goto fail;
276 }
277
a8b10c6e
PW
278 /* offset in (compressed) data fork */
279 s->offsets[i] = buff_read_uint64(buffer, offset + 0x18);
c6d34865 280 s->offsets[i] += in_offset;
65a1c7c9 281
a8b10c6e
PW
282 /* length in (compressed) data fork */
283 s->lengths[i] = buff_read_uint64(buffer, offset + 0x20);
65a1c7c9
PW
284
285 if (s->lengths[i] > DMG_LENGTHS_MAX) {
286 error_report("length %" PRIu64 " for chunk %" PRIu32
287 " is larger than max (%u)",
288 s->lengths[i], i, DMG_LENGTHS_MAX);
289 ret = -EINVAL;
290 goto fail;
291 }
292
293 update_max_chunk_size(s, i, &ds->max_compressed_size,
294 &ds->max_sectors_per_chunk);
a8b10c6e 295 offset += 40;
65a1c7c9
PW
296 }
297 s->n_chunks += chunk_count;
298 return 0;
299
300fail:
301 return ret;
302}
303
b0e8dc5d
PW
304static int dmg_read_resource_fork(BlockDriverState *bs, DmgHeaderState *ds,
305 uint64_t info_begin, uint64_t info_length)
585d0ed9 306{
7aee37b9 307 BDRVDMGState *s = bs->opaque;
69d34a36 308 int ret;
b0e8dc5d 309 uint32_t count, rsrc_data_offset;
7aee37b9 310 uint8_t *buffer = NULL;
b0e8dc5d
PW
311 uint64_t info_end;
312 uint64_t offset;
585d0ed9 313
b0e8dc5d 314 /* read offset from begin of resource fork (info_begin) to resource data */
65a1c7c9 315 ret = read_uint32(bs, info_begin, &rsrc_data_offset);
69d34a36
KW
316 if (ret < 0) {
317 goto fail;
b0e8dc5d 318 } else if (rsrc_data_offset > info_length) {
69d34a36 319 ret = -EINVAL;
16cdf7ce
CH
320 goto fail;
321 }
322
b0e8dc5d
PW
323 /* read length of resource data */
324 ret = read_uint32(bs, info_begin + 8, &count);
69d34a36
KW
325 if (ret < 0) {
326 goto fail;
b0e8dc5d 327 } else if (count == 0 || rsrc_data_offset + count > info_length) {
69d34a36 328 ret = -EINVAL;
16cdf7ce
CH
329 goto fail;
330 }
16cdf7ce 331
65a1c7c9 332 /* begin of resource data (consisting of one or more resources) */
b0e8dc5d
PW
333 offset = info_begin + rsrc_data_offset;
334
335 /* end of resource data (there is possibly a following resource map
336 * which will be ignored). */
337 info_end = offset + count;
585d0ed9 338
65a1c7c9 339 /* read offsets (mish blocks) from one or more resources in resource data */
16cdf7ce 340 while (offset < info_end) {
65a1c7c9 341 /* size of following resource */
69d34a36
KW
342 ret = read_uint32(bs, offset, &count);
343 if (ret < 0) {
344 goto fail;
f6e6652d 345 } else if (count == 0 || count > info_end - offset) {
69d34a36
KW
346 ret = -EINVAL;
347 goto fail;
348 }
16cdf7ce
CH
349 offset += 4;
350
7aee37b9 351 buffer = g_realloc(buffer, count);
cf2ab8fc 352 ret = bdrv_pread(bs->file, offset, buffer, count);
7aee37b9
PW
353 if (ret < 0) {
354 goto fail;
355 }
356
357 ret = dmg_read_mish_block(s, ds, buffer, count);
69d34a36
KW
358 if (ret < 0) {
359 goto fail;
360 }
65a1c7c9
PW
361 /* advance offset by size of resource */
362 offset += count;
585d0ed9 363 }
7aee37b9 364 ret = 0;
b0e8dc5d
PW
365
366fail:
7aee37b9 367 g_free(buffer);
b0e8dc5d
PW
368 return ret;
369}
370
0599e56e
PW
371static int dmg_read_plist_xml(BlockDriverState *bs, DmgHeaderState *ds,
372 uint64_t info_begin, uint64_t info_length)
373{
374 BDRVDMGState *s = bs->opaque;
375 int ret;
376 uint8_t *buffer = NULL;
377 char *data_begin, *data_end;
378
379 /* Have at least some length to avoid NULL for g_malloc. Attempt to set a
380 * safe upper cap on the data length. A test sample had a XML length of
381 * about 1 MiB. */
382 if (info_length == 0 || info_length > 16 * 1024 * 1024) {
383 ret = -EINVAL;
384 goto fail;
385 }
386
387 buffer = g_malloc(info_length + 1);
388 buffer[info_length] = '\0';
cf2ab8fc 389 ret = bdrv_pread(bs->file, info_begin, buffer, info_length);
0599e56e
PW
390 if (ret != info_length) {
391 ret = -EINVAL;
392 goto fail;
393 }
394
395 /* look for <data>...</data>. The data is 284 (0x11c) bytes after base64
396 * decode. The actual data element has 431 (0x1af) bytes which includes tabs
397 * and line feeds. */
398 data_end = (char *)buffer;
399 while ((data_begin = strstr(data_end, "<data>")) != NULL) {
400 guchar *mish;
401 gsize out_len = 0;
402
403 data_begin += 6;
404 data_end = strstr(data_begin, "</data>");
405 /* malformed XML? */
406 if (data_end == NULL) {
407 ret = -EINVAL;
408 goto fail;
409 }
410 *data_end++ = '\0';
411 mish = g_base64_decode(data_begin, &out_len);
412 ret = dmg_read_mish_block(s, ds, mish, (uint32_t)out_len);
413 g_free(mish);
414 if (ret < 0) {
415 goto fail;
416 }
417 }
418 ret = 0;
419
420fail:
421 g_free(buffer);
422 return ret;
423}
424
b0e8dc5d
PW
425static int dmg_open(BlockDriverState *bs, QDict *options, int flags,
426 Error **errp)
427{
428 BDRVDMGState *s = bs->opaque;
429 DmgHeaderState ds;
430 uint64_t rsrc_fork_offset, rsrc_fork_length;
0599e56e 431 uint64_t plist_xml_offset, plist_xml_length;
b0e8dc5d
PW
432 int64_t offset;
433 int ret;
434
eaa2410f
KW
435 ret = bdrv_apply_auto_read_only(bs, NULL, errp);
436 if (ret < 0) {
437 return ret;
438 }
439
4e4bf5c4
KW
440 bs->file = bdrv_open_child(NULL, options, "file", bs, &child_file,
441 false, errp);
442 if (!bs->file) {
443 return -EINVAL;
444 }
445
27685a8d 446 block_module_load_one("dmg-bz2");
7a40b418 447 block_module_load_one("dmg-lzfse");
3edf1e73 448
b0e8dc5d
PW
449 s->n_chunks = 0;
450 s->offsets = s->lengths = s->sectors = s->sectorcounts = NULL;
451 /* used by dmg_read_mish_block to keep track of the current I/O position */
c6d34865 452 ds.data_fork_offset = 0;
b0e8dc5d
PW
453 ds.max_compressed_size = 1;
454 ds.max_sectors_per_chunk = 1;
455
456 /* locate the UDIF trailer */
cf2ab8fc 457 offset = dmg_find_koly_offset(bs->file, errp);
b0e8dc5d
PW
458 if (offset < 0) {
459 ret = offset;
460 goto fail;
461 }
462
c6d34865
PW
463 /* offset of data fork (DataForkOffset) */
464 ret = read_uint64(bs, offset + 0x18, &ds.data_fork_offset);
465 if (ret < 0) {
466 goto fail;
467 } else if (ds.data_fork_offset > offset) {
468 ret = -EINVAL;
469 goto fail;
470 }
471
b0e8dc5d
PW
472 /* offset of resource fork (RsrcForkOffset) */
473 ret = read_uint64(bs, offset + 0x28, &rsrc_fork_offset);
474 if (ret < 0) {
475 goto fail;
476 }
477 ret = read_uint64(bs, offset + 0x30, &rsrc_fork_length);
478 if (ret < 0) {
479 goto fail;
480 }
f6e6652d
PW
481 if (rsrc_fork_offset >= offset ||
482 rsrc_fork_length > offset - rsrc_fork_offset) {
483 ret = -EINVAL;
484 goto fail;
485 }
0599e56e
PW
486 /* offset of property list (XMLOffset) */
487 ret = read_uint64(bs, offset + 0xd8, &plist_xml_offset);
488 if (ret < 0) {
489 goto fail;
490 }
491 ret = read_uint64(bs, offset + 0xe0, &plist_xml_length);
492 if (ret < 0) {
493 goto fail;
494 }
495 if (plist_xml_offset >= offset ||
496 plist_xml_length > offset - plist_xml_offset) {
497 ret = -EINVAL;
498 goto fail;
499 }
8daf4257
PW
500 ret = read_uint64(bs, offset + 0x1ec, (uint64_t *)&bs->total_sectors);
501 if (ret < 0) {
502 goto fail;
503 }
504 if (bs->total_sectors < 0) {
505 ret = -EINVAL;
506 goto fail;
507 }
b0e8dc5d
PW
508 if (rsrc_fork_length != 0) {
509 ret = dmg_read_resource_fork(bs, &ds,
510 rsrc_fork_offset, rsrc_fork_length);
511 if (ret < 0) {
512 goto fail;
513 }
0599e56e
PW
514 } else if (plist_xml_length != 0) {
515 ret = dmg_read_plist_xml(bs, &ds, plist_xml_offset, plist_xml_length);
516 if (ret < 0) {
517 goto fail;
518 }
b0e8dc5d
PW
519 } else {
520 ret = -EINVAL;
521 goto fail;
522 }
585d0ed9
FB
523
524 /* initialize zlib engine */
9a4f4c31 525 s->compressed_chunk = qemu_try_blockalign(bs->file->bs,
65a1c7c9 526 ds.max_compressed_size + 1);
9a4f4c31 527 s->uncompressed_chunk = qemu_try_blockalign(bs->file->bs,
65a1c7c9 528 512 * ds.max_sectors_per_chunk);
b546a944
KW
529 if (s->compressed_chunk == NULL || s->uncompressed_chunk == NULL) {
530 ret = -ENOMEM;
531 goto fail;
532 }
533
2c1885ad 534 if (inflateInit(&s->zstream) != Z_OK) {
69d34a36
KW
535 ret = -EINVAL;
536 goto fail;
537 }
585d0ed9
FB
538
539 s->current_chunk = s->n_chunks;
3b46e624 540
848c66e8 541 qemu_co_mutex_init(&s->lock);
585d0ed9 542 return 0;
69d34a36 543
1559ca00 544fail:
69d34a36
KW
545 g_free(s->types);
546 g_free(s->offsets);
547 g_free(s->lengths);
548 g_free(s->sectors);
549 g_free(s->sectorcounts);
b546a944
KW
550 qemu_vfree(s->compressed_chunk);
551 qemu_vfree(s->uncompressed_chunk);
69d34a36 552 return ret;
585d0ed9
FB
553}
554
a6506481
EB
555static void dmg_refresh_limits(BlockDriverState *bs, Error **errp)
556{
a5b8dd2c 557 bs->bl.request_alignment = BDRV_SECTOR_SIZE; /* No sub-sector I/O */
a6506481
EB
558}
559
585d0ed9 560static inline int is_sector_in_chunk(BDRVDMGState* s,
686d7148 561 uint32_t chunk_num, uint64_t sector_num)
585d0ed9 562{
2c1885ad
SH
563 if (chunk_num >= s->n_chunks || s->sectors[chunk_num] > sector_num ||
564 s->sectors[chunk_num] + s->sectorcounts[chunk_num] <= sector_num) {
565 return 0;
566 } else {
567 return -1;
568 }
585d0ed9
FB
569}
570
686d7148 571static inline uint32_t search_chunk(BDRVDMGState *s, uint64_t sector_num)
585d0ed9
FB
572{
573 /* binary search */
2c1885ad 574 uint32_t chunk1 = 0, chunk2 = s->n_chunks, chunk3;
5ef40828 575 while (chunk1 <= chunk2) {
2c1885ad
SH
576 chunk3 = (chunk1 + chunk2) / 2;
577 if (s->sectors[chunk3] > sector_num) {
5ef40828
YCL
578 if (chunk3 == 0) {
579 goto err;
580 }
581 chunk2 = chunk3 - 1;
2c1885ad
SH
582 } else if (s->sectors[chunk3] + s->sectorcounts[chunk3] > sector_num) {
583 return chunk3;
584 } else {
5ef40828 585 chunk1 = chunk3 + 1;
2c1885ad 586 }
585d0ed9 587 }
5ef40828 588err:
585d0ed9
FB
589 return s->n_chunks; /* error */
590}
591
686d7148 592static inline int dmg_read_chunk(BlockDriverState *bs, uint64_t sector_num)
585d0ed9 593{
64a31d5c
CH
594 BDRVDMGState *s = bs->opaque;
595
2c1885ad
SH
596 if (!is_sector_in_chunk(s, s->current_chunk, sector_num)) {
597 int ret;
598 uint32_t chunk = search_chunk(s, sector_num);
585d0ed9 599
2c1885ad
SH
600 if (chunk >= s->n_chunks) {
601 return -1;
602 }
585d0ed9 603
2c1885ad 604 s->current_chunk = s->n_chunks;
6b383c08 605 switch (s->types[chunk]) { /* block entry type */
95a156f6 606 case UDZO: { /* zlib compressed */
2c1885ad
SH
607 /* we need to buffer, because only the chunk as whole can be
608 * inflated. */
cf2ab8fc 609 ret = bdrv_pread(bs->file, s->offsets[chunk],
b404bf85 610 s->compressed_chunk, s->lengths[chunk]);
2c1885ad
SH
611 if (ret != s->lengths[chunk]) {
612 return -1;
613 }
614
615 s->zstream.next_in = s->compressed_chunk;
616 s->zstream.avail_in = s->lengths[chunk];
617 s->zstream.next_out = s->uncompressed_chunk;
618 s->zstream.avail_out = 512 * s->sectorcounts[chunk];
619 ret = inflateReset(&s->zstream);
620 if (ret != Z_OK) {
621 return -1;
622 }
623 ret = inflate(&s->zstream, Z_FINISH);
624 if (ret != Z_STREAM_END ||
625 s->zstream.total_out != 512 * s->sectorcounts[chunk]) {
626 return -1;
627 }
628 break; }
95a156f6 629 case UDBZ: /* bzip2 compressed */
27685a8d
FZ
630 if (!dmg_uncompress_bz2) {
631 break;
632 }
6b383c08
PW
633 /* we need to buffer, because only the chunk as whole can be
634 * inflated. */
cf2ab8fc 635 ret = bdrv_pread(bs->file, s->offsets[chunk],
6b383c08
PW
636 s->compressed_chunk, s->lengths[chunk]);
637 if (ret != s->lengths[chunk]) {
638 return -1;
639 }
640
27685a8d
FZ
641 ret = dmg_uncompress_bz2((char *)s->compressed_chunk,
642 (unsigned int) s->lengths[chunk],
643 (char *)s->uncompressed_chunk,
644 (unsigned int)
645 (512 * s->sectorcounts[chunk]));
646 if (ret < 0) {
647 return ret;
6b383c08
PW
648 }
649 break;
95a156f6 650 case ULFO:
7a40b418
JF
651 if (!dmg_uncompress_lzfse) {
652 break;
653 }
654 /* we need to buffer, because only the chunk as whole can be
655 * inflated. */
656 ret = bdrv_pread(bs->file, s->offsets[chunk],
657 s->compressed_chunk, s->lengths[chunk]);
658 if (ret != s->lengths[chunk]) {
659 return -1;
660 }
661
662 ret = dmg_uncompress_lzfse((char *)s->compressed_chunk,
663 (unsigned int) s->lengths[chunk],
664 (char *)s->uncompressed_chunk,
665 (unsigned int)
666 (512 * s->sectorcounts[chunk]));
667 if (ret < 0) {
668 return ret;
669 }
670 break;
95a156f6 671 case UDRW: /* copy */
cf2ab8fc 672 ret = bdrv_pread(bs->file, s->offsets[chunk],
64a31d5c 673 s->uncompressed_chunk, s->lengths[chunk]);
2c1885ad
SH
674 if (ret != s->lengths[chunk]) {
675 return -1;
676 }
677 break;
95a156f6 678 case UDIG: /* zero */
177b7510
PW
679 /* see dmg_read, it is treated specially. No buffer needs to be
680 * pre-filled, the zeroes can be set directly. */
2c1885ad
SH
681 break;
682 }
683 s->current_chunk = chunk;
585d0ed9
FB
684 }
685 return 0;
686}
687
3edf1e73
KW
688static int coroutine_fn
689dmg_co_preadv(BlockDriverState *bs, uint64_t offset, uint64_t bytes,
690 QEMUIOVector *qiov, int flags)
585d0ed9
FB
691{
692 BDRVDMGState *s = bs->opaque;
3edf1e73
KW
693 uint64_t sector_num = offset >> BDRV_SECTOR_BITS;
694 int nb_sectors = bytes >> BDRV_SECTOR_BITS;
695 int ret, i;
696
697 assert((offset & (BDRV_SECTOR_SIZE - 1)) == 0);
698 assert((bytes & (BDRV_SECTOR_SIZE - 1)) == 0);
699
700 qemu_co_mutex_lock(&s->lock);
585d0ed9 701
2c1885ad
SH
702 for (i = 0; i < nb_sectors; i++) {
703 uint32_t sector_offset_in_chunk;
3edf1e73
KW
704 void *data;
705
2c1885ad 706 if (dmg_read_chunk(bs, sector_num + i) != 0) {
3edf1e73
KW
707 ret = -EIO;
708 goto fail;
2c1885ad 709 }
177b7510
PW
710 /* Special case: current chunk is all zeroes. Do not perform a memcpy as
711 * s->uncompressed_chunk may be too small to cover the large all-zeroes
712 * section. dmg_read_chunk is called to find s->current_chunk */
e80fcf59 713 if (s->types[s->current_chunk] == UDIG) { /* all zeroes block entry */
3edf1e73 714 qemu_iovec_memset(qiov, i * 512, 0, 512);
177b7510
PW
715 continue;
716 }
2c1885ad 717 sector_offset_in_chunk = sector_num + i - s->sectors[s->current_chunk];
3edf1e73
KW
718 data = s->uncompressed_chunk + sector_offset_in_chunk * 512;
719 qemu_iovec_from_buf(qiov, i * 512, data, 512);
585d0ed9 720 }
585d0ed9 721
3edf1e73
KW
722 ret = 0;
723fail:
2914caa0
PB
724 qemu_co_mutex_unlock(&s->lock);
725 return ret;
726}
727
585d0ed9
FB
728static void dmg_close(BlockDriverState *bs)
729{
730 BDRVDMGState *s = bs->opaque;
4f8aa2e1
KW
731
732 g_free(s->types);
733 g_free(s->offsets);
734 g_free(s->lengths);
735 g_free(s->sectors);
736 g_free(s->sectorcounts);
b546a944
KW
737 qemu_vfree(s->compressed_chunk);
738 qemu_vfree(s->uncompressed_chunk);
4f8aa2e1 739
585d0ed9
FB
740 inflateEnd(&s->zstream);
741}
742
5efa9d5a 743static BlockDriver bdrv_dmg = {
2c1885ad
SH
744 .format_name = "dmg",
745 .instance_size = sizeof(BDRVDMGState),
746 .bdrv_probe = dmg_probe,
747 .bdrv_open = dmg_open,
a6506481 748 .bdrv_refresh_limits = dmg_refresh_limits,
862f215f 749 .bdrv_child_perm = bdrv_format_default_perms,
3edf1e73 750 .bdrv_co_preadv = dmg_co_preadv,
2c1885ad 751 .bdrv_close = dmg_close,
585d0ed9 752};
5efa9d5a
AL
753
754static void bdrv_dmg_init(void)
755{
756 bdrv_register(&bdrv_dmg);
757}
758
759block_init(bdrv_dmg_init);