bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Block driver for the various disk image formats used by Bochs |
| 3 | * Currently only for "growing" type in read-only mode |
ths | 5fafdf2 | 2007-09-16 21:08:06 +0000 | [diff] [blame] | 4 | * |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 5 | * Copyright (c) 2005 Alex Beregszaszi |
ths | 5fafdf2 | 2007-09-16 21:08:06 +0000 | [diff] [blame] | 6 | * |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 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 | */ |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 25 | #include "qemu-common.h" |
Paolo Bonzini | 737e150 | 2012-12-17 18:19:44 +0100 | [diff] [blame] | 26 | #include "block/block_int.h" |
Paolo Bonzini | 1de7afc | 2012-12-17 18:20:00 +0100 | [diff] [blame] | 27 | #include "qemu/module.h" |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 28 | |
| 29 | /**************************************************************/ |
| 30 | |
| 31 | #define HEADER_MAGIC "Bochs Virtual HD Image" |
ths | 6850dd9 | 2007-01-05 18:56:04 +0000 | [diff] [blame] | 32 | #define HEADER_VERSION 0x00020000 |
| 33 | #define HEADER_V1 0x00010000 |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 34 | #define HEADER_SIZE 512 |
| 35 | |
| 36 | #define REDOLOG_TYPE "Redolog" |
| 37 | #define GROWING_TYPE "Growing" |
| 38 | |
| 39 | // not allocated: 0xffffffff |
| 40 | |
| 41 | // always little-endian |
ths | 6850dd9 | 2007-01-05 18:56:04 +0000 | [diff] [blame] | 42 | struct bochs_header_v1 { |
| 43 | char magic[32]; // "Bochs Virtual HD Image" |
| 44 | char type[16]; // "Redolog" |
| 45 | char subtype[16]; // "Undoable" / "Volatile" / "Growing" |
| 46 | uint32_t version; |
| 47 | uint32_t header; // size of header |
ths | 3b46e62 | 2007-09-17 08:09:54 +0000 | [diff] [blame] | 48 | |
ths | 6850dd9 | 2007-01-05 18:56:04 +0000 | [diff] [blame] | 49 | union { |
| 50 | struct { |
| 51 | uint32_t catalog; // num of entries |
| 52 | uint32_t bitmap; // bitmap size |
| 53 | uint32_t extent; // extent size |
| 54 | uint64_t disk; // disk size |
| 55 | char padding[HEADER_SIZE - 64 - 8 - 20]; |
| 56 | } redolog; |
| 57 | char padding[HEADER_SIZE - 64 - 8]; |
| 58 | } extra; |
| 59 | }; |
| 60 | |
| 61 | // always little-endian |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 62 | struct bochs_header { |
| 63 | char magic[32]; // "Bochs Virtual HD Image" |
| 64 | char type[16]; // "Redolog" |
| 65 | char subtype[16]; // "Undoable" / "Volatile" / "Growing" |
| 66 | uint32_t version; |
| 67 | uint32_t header; // size of header |
ths | 3b46e62 | 2007-09-17 08:09:54 +0000 | [diff] [blame] | 68 | |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 69 | union { |
| 70 | struct { |
| 71 | uint32_t catalog; // num of entries |
| 72 | uint32_t bitmap; // bitmap size |
| 73 | uint32_t extent; // extent size |
ths | 6850dd9 | 2007-01-05 18:56:04 +0000 | [diff] [blame] | 74 | uint32_t reserved; // for ??? |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 75 | uint64_t disk; // disk size |
ths | 6850dd9 | 2007-01-05 18:56:04 +0000 | [diff] [blame] | 76 | char padding[HEADER_SIZE - 64 - 8 - 24]; |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 77 | } redolog; |
| 78 | char padding[HEADER_SIZE - 64 - 8]; |
| 79 | } extra; |
| 80 | }; |
| 81 | |
| 82 | typedef struct BDRVBochsState { |
Paolo Bonzini | 848c66e | 2011-10-20 13:16:21 +0200 | [diff] [blame] | 83 | CoMutex lock; |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 84 | uint32_t *catalog_bitmap; |
| 85 | int catalog_size; |
ths | 3b46e62 | 2007-09-17 08:09:54 +0000 | [diff] [blame] | 86 | |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 87 | int data_offset; |
ths | 3b46e62 | 2007-09-17 08:09:54 +0000 | [diff] [blame] | 88 | |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 89 | int bitmap_blocks; |
| 90 | int extent_blocks; |
| 91 | int extent_size; |
| 92 | } BDRVBochsState; |
| 93 | |
| 94 | static int bochs_probe(const uint8_t *buf, int buf_size, const char *filename) |
| 95 | { |
| 96 | const struct bochs_header *bochs = (const void *)buf; |
ths | 3b46e62 | 2007-09-17 08:09:54 +0000 | [diff] [blame] | 97 | |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 98 | if (buf_size < HEADER_SIZE) |
| 99 | return 0; |
| 100 | |
| 101 | if (!strcmp(bochs->magic, HEADER_MAGIC) && |
| 102 | !strcmp(bochs->type, REDOLOG_TYPE) && |
| 103 | !strcmp(bochs->subtype, GROWING_TYPE) && |
ths | 6850dd9 | 2007-01-05 18:56:04 +0000 | [diff] [blame] | 104 | ((le32_to_cpu(bochs->version) == HEADER_VERSION) || |
| 105 | (le32_to_cpu(bochs->version) == HEADER_V1))) |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 106 | return 100; |
| 107 | |
| 108 | return 0; |
| 109 | } |
| 110 | |
Kevin Wolf | 1a86938 | 2013-03-15 10:35:01 +0100 | [diff] [blame] | 111 | static int bochs_open(BlockDriverState *bs, QDict *options, int flags) |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 112 | { |
| 113 | BDRVBochsState *s = bs->opaque; |
Christoph Hellwig | 7a6f391 | 2010-05-04 12:44:21 +0200 | [diff] [blame] | 114 | int i; |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 115 | struct bochs_header bochs; |
ths | 6850dd9 | 2007-01-05 18:56:04 +0000 | [diff] [blame] | 116 | struct bochs_header_v1 header_v1; |
Kevin Wolf | 5b7d7df | 2013-01-25 17:07:27 +0100 | [diff] [blame] | 117 | int ret; |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 118 | |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 119 | bs->read_only = 1; // no write support yet |
ths | 3b46e62 | 2007-09-17 08:09:54 +0000 | [diff] [blame] | 120 | |
Kevin Wolf | 5b7d7df | 2013-01-25 17:07:27 +0100 | [diff] [blame] | 121 | ret = bdrv_pread(bs->file, 0, &bochs, sizeof(bochs)); |
| 122 | if (ret < 0) { |
| 123 | return ret; |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 124 | } |
| 125 | |
| 126 | if (strcmp(bochs.magic, HEADER_MAGIC) || |
| 127 | strcmp(bochs.type, REDOLOG_TYPE) || |
| 128 | strcmp(bochs.subtype, GROWING_TYPE) || |
ths | 6850dd9 | 2007-01-05 18:56:04 +0000 | [diff] [blame] | 129 | ((le32_to_cpu(bochs.version) != HEADER_VERSION) && |
| 130 | (le32_to_cpu(bochs.version) != HEADER_V1))) { |
Stefan Weil | 15bac0d | 2013-01-17 21:45:25 +0100 | [diff] [blame] | 131 | return -EMEDIUMTYPE; |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 132 | } |
| 133 | |
ths | 6850dd9 | 2007-01-05 18:56:04 +0000 | [diff] [blame] | 134 | if (le32_to_cpu(bochs.version) == HEADER_V1) { |
| 135 | memcpy(&header_v1, &bochs, sizeof(bochs)); |
| 136 | bs->total_sectors = le64_to_cpu(header_v1.extra.redolog.disk) / 512; |
| 137 | } else { |
| 138 | bs->total_sectors = le64_to_cpu(bochs.extra.redolog.disk) / 512; |
| 139 | } |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 140 | |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 141 | s->catalog_size = le32_to_cpu(bochs.extra.redolog.catalog); |
Anthony Liguori | 7267c09 | 2011-08-20 22:09:37 -0500 | [diff] [blame] | 142 | s->catalog_bitmap = g_malloc(s->catalog_size * 4); |
Kevin Wolf | 5b7d7df | 2013-01-25 17:07:27 +0100 | [diff] [blame] | 143 | |
| 144 | ret = bdrv_pread(bs->file, le32_to_cpu(bochs.header), s->catalog_bitmap, |
| 145 | s->catalog_size * 4); |
| 146 | if (ret < 0) { |
| 147 | goto fail; |
| 148 | } |
| 149 | |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 150 | for (i = 0; i < s->catalog_size; i++) |
| 151 | le32_to_cpus(&s->catalog_bitmap[i]); |
| 152 | |
| 153 | s->data_offset = le32_to_cpu(bochs.header) + (s->catalog_size * 4); |
| 154 | |
| 155 | s->bitmap_blocks = 1 + (le32_to_cpu(bochs.extra.redolog.bitmap) - 1) / 512; |
| 156 | s->extent_blocks = 1 + (le32_to_cpu(bochs.extra.redolog.extent) - 1) / 512; |
ths | 3b46e62 | 2007-09-17 08:09:54 +0000 | [diff] [blame] | 157 | |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 158 | s->extent_size = le32_to_cpu(bochs.extra.redolog.extent); |
| 159 | |
Paolo Bonzini | 848c66e | 2011-10-20 13:16:21 +0200 | [diff] [blame] | 160 | qemu_co_mutex_init(&s->lock); |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 161 | return 0; |
Kevin Wolf | 5b7d7df | 2013-01-25 17:07:27 +0100 | [diff] [blame] | 162 | |
| 163 | fail: |
| 164 | g_free(s->catalog_bitmap); |
| 165 | return ret; |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 166 | } |
| 167 | |
Christoph Hellwig | efbca10 | 2010-05-04 12:44:08 +0200 | [diff] [blame] | 168 | static int64_t seek_to_sector(BlockDriverState *bs, int64_t sector_num) |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 169 | { |
| 170 | BDRVBochsState *s = bs->opaque; |
| 171 | int64_t offset = sector_num * 512; |
Christoph Hellwig | efbca10 | 2010-05-04 12:44:08 +0200 | [diff] [blame] | 172 | int64_t extent_index, extent_offset, bitmap_offset; |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 173 | char bitmap_entry; |
| 174 | |
| 175 | // seek to sector |
| 176 | extent_index = offset / s->extent_size; |
| 177 | extent_offset = (offset % s->extent_size) / 512; |
ths | 3b46e62 | 2007-09-17 08:09:54 +0000 | [diff] [blame] | 178 | |
Christoph Hellwig | efbca10 | 2010-05-04 12:44:08 +0200 | [diff] [blame] | 179 | if (s->catalog_bitmap[extent_index] == 0xffffffff) { |
| 180 | return -1; /* not allocated */ |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 181 | } |
| 182 | |
| 183 | bitmap_offset = s->data_offset + (512 * s->catalog_bitmap[extent_index] * |
| 184 | (s->extent_blocks + s->bitmap_blocks)); |
ths | 3b46e62 | 2007-09-17 08:09:54 +0000 | [diff] [blame] | 185 | |
Christoph Hellwig | efbca10 | 2010-05-04 12:44:08 +0200 | [diff] [blame] | 186 | /* read in bitmap for current extent */ |
Christoph Hellwig | 7a6f391 | 2010-05-04 12:44:21 +0200 | [diff] [blame] | 187 | if (bdrv_pread(bs->file, bitmap_offset + (extent_offset / 8), |
| 188 | &bitmap_entry, 1) != 1) { |
Blue Swirl | ecbe157 | 2009-12-25 19:27:18 +0000 | [diff] [blame] | 189 | return -1; |
| 190 | } |
ths | 3b46e62 | 2007-09-17 08:09:54 +0000 | [diff] [blame] | 191 | |
Christoph Hellwig | efbca10 | 2010-05-04 12:44:08 +0200 | [diff] [blame] | 192 | if (!((bitmap_entry >> (extent_offset % 8)) & 1)) { |
| 193 | return -1; /* not allocated */ |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 194 | } |
| 195 | |
Christoph Hellwig | efbca10 | 2010-05-04 12:44:08 +0200 | [diff] [blame] | 196 | return bitmap_offset + (512 * (s->bitmap_blocks + extent_offset)); |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 197 | } |
| 198 | |
ths | 5fafdf2 | 2007-09-16 21:08:06 +0000 | [diff] [blame] | 199 | static int bochs_read(BlockDriverState *bs, int64_t sector_num, |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 200 | uint8_t *buf, int nb_sectors) |
| 201 | { |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 202 | int ret; |
| 203 | |
| 204 | while (nb_sectors > 0) { |
Christoph Hellwig | efbca10 | 2010-05-04 12:44:08 +0200 | [diff] [blame] | 205 | int64_t block_offset = seek_to_sector(bs, sector_num); |
| 206 | if (block_offset >= 0) { |
Christoph Hellwig | 7a6f391 | 2010-05-04 12:44:21 +0200 | [diff] [blame] | 207 | ret = bdrv_pread(bs->file, block_offset, buf, 512); |
Christoph Hellwig | efbca10 | 2010-05-04 12:44:08 +0200 | [diff] [blame] | 208 | if (ret != 512) { |
| 209 | return -1; |
| 210 | } |
| 211 | } else |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 212 | memset(buf, 0, 512); |
| 213 | nb_sectors--; |
| 214 | sector_num++; |
| 215 | buf += 512; |
| 216 | } |
| 217 | return 0; |
| 218 | } |
| 219 | |
Paolo Bonzini | 2914caa | 2011-10-20 13:16:22 +0200 | [diff] [blame] | 220 | static coroutine_fn int bochs_co_read(BlockDriverState *bs, int64_t sector_num, |
| 221 | uint8_t *buf, int nb_sectors) |
| 222 | { |
| 223 | int ret; |
| 224 | BDRVBochsState *s = bs->opaque; |
| 225 | qemu_co_mutex_lock(&s->lock); |
| 226 | ret = bochs_read(bs, sector_num, buf, nb_sectors); |
| 227 | qemu_co_mutex_unlock(&s->lock); |
| 228 | return ret; |
| 229 | } |
| 230 | |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 231 | static void bochs_close(BlockDriverState *bs) |
| 232 | { |
| 233 | BDRVBochsState *s = bs->opaque; |
Anthony Liguori | 7267c09 | 2011-08-20 22:09:37 -0500 | [diff] [blame] | 234 | g_free(s->catalog_bitmap); |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 235 | } |
| 236 | |
Anthony Liguori | 5efa9d5 | 2009-05-09 17:03:42 -0500 | [diff] [blame] | 237 | static BlockDriver bdrv_bochs = { |
aurel32 | e60f469 | 2009-03-07 22:00:29 +0000 | [diff] [blame] | 238 | .format_name = "bochs", |
| 239 | .instance_size = sizeof(BDRVBochsState), |
| 240 | .bdrv_probe = bochs_probe, |
Christoph Hellwig | 7a6f391 | 2010-05-04 12:44:21 +0200 | [diff] [blame] | 241 | .bdrv_open = bochs_open, |
Paolo Bonzini | 2914caa | 2011-10-20 13:16:22 +0200 | [diff] [blame] | 242 | .bdrv_read = bochs_co_read, |
aurel32 | e60f469 | 2009-03-07 22:00:29 +0000 | [diff] [blame] | 243 | .bdrv_close = bochs_close, |
bellard | a8753c3 | 2005-04-26 21:34:00 +0000 | [diff] [blame] | 244 | }; |
Anthony Liguori | 5efa9d5 | 2009-05-09 17:03:42 -0500 | [diff] [blame] | 245 | |
| 246 | static void bdrv_bochs_init(void) |
| 247 | { |
| 248 | bdrv_register(&bdrv_bochs); |
| 249 | } |
| 250 | |
| 251 | block_init(bdrv_bochs_init); |