1 /* 2 * Block driver for the various disk image formats used by Bochs 3 * Currently only for "growing" type in read-only mode 4 * 5 * Copyright (c) 2005 Alex Beregszaszi 6 * 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 */ 25 #include "qemu-common.h" 26 #include "block/block_int.h" 27 #include "qemu/module.h" 28 29 /**************************************************************/ 30 31 #define HEADER_MAGIC "Bochs Virtual HD Image" 32 #define HEADER_VERSION 0x00020000 33 #define HEADER_V1 0x00010000 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 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 48 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 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 68 69 union { 70 struct { 71 uint32_t catalog; // num of entries 72 uint32_t bitmap; // bitmap size 73 uint32_t extent; // extent size 74 uint32_t reserved; // for ??? 75 uint64_t disk; // disk size 76 char padding[HEADER_SIZE - 64 - 8 - 24]; 77 } redolog; 78 char padding[HEADER_SIZE - 64 - 8]; 79 } extra; 80 }; 81 82 typedef struct BDRVBochsState { 83 CoMutex lock; 84 uint32_t *catalog_bitmap; 85 int catalog_size; 86 87 int data_offset; 88 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; 97 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) && 104 ((le32_to_cpu(bochs->version) == HEADER_VERSION) || 105 (le32_to_cpu(bochs->version) == HEADER_V1))) 106 return 100; 107 108 return 0; 109 } 110 111 static int bochs_open(BlockDriverState *bs, QDict *options, int flags, 112 Error **errp) 113 { 114 BDRVBochsState *s = bs->opaque; 115 int i; 116 struct bochs_header bochs; 117 struct bochs_header_v1 header_v1; 118 int ret; 119 120 bs->read_only = 1; // no write support yet 121 122 ret = bdrv_pread(bs->file, 0, &bochs, sizeof(bochs)); 123 if (ret < 0) { 124 return ret; 125 } 126 127 if (strcmp(bochs.magic, HEADER_MAGIC) || 128 strcmp(bochs.type, REDOLOG_TYPE) || 129 strcmp(bochs.subtype, GROWING_TYPE) || 130 ((le32_to_cpu(bochs.version) != HEADER_VERSION) && 131 (le32_to_cpu(bochs.version) != HEADER_V1))) { 132 return -EMEDIUMTYPE; 133 } 134 135 if (le32_to_cpu(bochs.version) == HEADER_V1) { 136 memcpy(&header_v1, &bochs, sizeof(bochs)); 137 bs->total_sectors = le64_to_cpu(header_v1.extra.redolog.disk) / 512; 138 } else { 139 bs->total_sectors = le64_to_cpu(bochs.extra.redolog.disk) / 512; 140 } 141 142 s->catalog_size = le32_to_cpu(bochs.extra.redolog.catalog); 143 s->catalog_bitmap = g_malloc(s->catalog_size * 4); 144 145 ret = bdrv_pread(bs->file, le32_to_cpu(bochs.header), s->catalog_bitmap, 146 s->catalog_size * 4); 147 if (ret < 0) { 148 goto fail; 149 } 150 151 for (i = 0; i < s->catalog_size; i++) 152 le32_to_cpus(&s->catalog_bitmap[i]); 153 154 s->data_offset = le32_to_cpu(bochs.header) + (s->catalog_size * 4); 155 156 s->bitmap_blocks = 1 + (le32_to_cpu(bochs.extra.redolog.bitmap) - 1) / 512; 157 s->extent_blocks = 1 + (le32_to_cpu(bochs.extra.redolog.extent) - 1) / 512; 158 159 s->extent_size = le32_to_cpu(bochs.extra.redolog.extent); 160 161 qemu_co_mutex_init(&s->lock); 162 return 0; 163 164 fail: 165 g_free(s->catalog_bitmap); 166 return ret; 167 } 168 169 static int64_t seek_to_sector(BlockDriverState *bs, int64_t sector_num) 170 { 171 BDRVBochsState *s = bs->opaque; 172 int64_t offset = sector_num * 512; 173 int64_t extent_index, extent_offset, bitmap_offset; 174 char bitmap_entry; 175 176 // seek to sector 177 extent_index = offset / s->extent_size; 178 extent_offset = (offset % s->extent_size) / 512; 179 180 if (s->catalog_bitmap[extent_index] == 0xffffffff) { 181 return -1; /* not allocated */ 182 } 183 184 bitmap_offset = s->data_offset + (512 * s->catalog_bitmap[extent_index] * 185 (s->extent_blocks + s->bitmap_blocks)); 186 187 /* read in bitmap for current extent */ 188 if (bdrv_pread(bs->file, bitmap_offset + (extent_offset / 8), 189 &bitmap_entry, 1) != 1) { 190 return -1; 191 } 192 193 if (!((bitmap_entry >> (extent_offset % 8)) & 1)) { 194 return -1; /* not allocated */ 195 } 196 197 return bitmap_offset + (512 * (s->bitmap_blocks + extent_offset)); 198 } 199 200 static int bochs_read(BlockDriverState *bs, int64_t sector_num, 201 uint8_t *buf, int nb_sectors) 202 { 203 int ret; 204 205 while (nb_sectors > 0) { 206 int64_t block_offset = seek_to_sector(bs, sector_num); 207 if (block_offset >= 0) { 208 ret = bdrv_pread(bs->file, block_offset, buf, 512); 209 if (ret != 512) { 210 return -1; 211 } 212 } else 213 memset(buf, 0, 512); 214 nb_sectors--; 215 sector_num++; 216 buf += 512; 217 } 218 return 0; 219 } 220 221 static coroutine_fn int bochs_co_read(BlockDriverState *bs, int64_t sector_num, 222 uint8_t *buf, int nb_sectors) 223 { 224 int ret; 225 BDRVBochsState *s = bs->opaque; 226 qemu_co_mutex_lock(&s->lock); 227 ret = bochs_read(bs, sector_num, buf, nb_sectors); 228 qemu_co_mutex_unlock(&s->lock); 229 return ret; 230 } 231 232 static void bochs_close(BlockDriverState *bs) 233 { 234 BDRVBochsState *s = bs->opaque; 235 g_free(s->catalog_bitmap); 236 } 237 238 static BlockDriver bdrv_bochs = { 239 .format_name = "bochs", 240 .instance_size = sizeof(BDRVBochsState), 241 .bdrv_probe = bochs_probe, 242 .bdrv_open = bochs_open, 243 .bdrv_read = bochs_co_read, 244 .bdrv_close = bochs_close, 245 }; 246 247 static void bdrv_bochs_init(void) 248 { 249 bdrv_register(&bdrv_bochs); 250 } 251 252 block_init(bdrv_bochs_init); 253