vmdk.c revision 269177
1/*- 2 * Copyright (c) 2014 Juniper Networks, Inc. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 */ 26 27#include <sys/cdefs.h> 28__FBSDID("$FreeBSD: stable/10/usr.bin/mkimg/vmdk.c 269177 2014-07-28 02:07:16Z marcel $"); 29 30#include <sys/types.h> 31#include <sys/endian.h> 32#include <sys/errno.h> 33#include <stdint.h> 34#include <stdio.h> 35#include <stdlib.h> 36#include <string.h> 37#include <unistd.h> 38 39#include "image.h" 40#include "format.h" 41#include "mkimg.h" 42 43#define VMDK_IMAGE_ROUND 1048576 44#define VMDK_MIN_GRAIN_SIZE 8192 45#define VMDK_SECTOR_SIZE 512 46 47struct vmdk_header { 48 uint32_t magic; 49#define VMDK_MAGIC 0x564d444b 50 uint32_t version; 51#define VMDK_VERSION 1 52 uint32_t flags; 53#define VMDK_FLAGS_NL_TEST (1 << 0) 54#define VMDK_FLAGS_RGT_USED (1 << 1) 55#define VMDK_FLAGS_COMPRESSED (1 << 16) 56#define VMDK_FLAGS_MARKERS (1 << 17) 57 uint64_t capacity; 58 uint64_t grain_size; 59 uint64_t desc_offset; 60 uint64_t desc_size; 61 uint32_t ngtes; 62#define VMDK_NGTES 512 63 uint64_t rgd_offset; 64 uint64_t gd_offset; 65 uint64_t overhead; 66 uint8_t unclean; 67 uint32_t nl_test; 68#define VMDK_NL_TEST 0x0a200d0a 69 uint16_t compress; 70#define VMDK_COMPRESS_NONE 0 71#define VMDK_COMPRESS_DEFLATE 1 72 char padding[433]; 73} __attribute__((__packed__)); 74 75static const char desc_fmt[] = 76 "# Disk DescriptorFile\n" 77 "version=%d\n" 78 "CID=%08x\n" 79 "parentCID=ffffffff\n" 80 "createType=\"monolithicSparse\"\n" 81 "# Extent description\n" 82 "RW %ju SPARSE \"%s\"\n" 83 "# The Disk Data Base\n" 84 "#DDB\n" 85 "ddb.adapterType = \"ide\"\n" 86 "ddb.geometry.cylinders = \"%u\"\n" 87 "ddb.geometry.heads = \"%u\"\n" 88 "ddb.geometry.sectors = \"%u\"\n"; 89 90static uint64_t grainsz; 91 92static int 93vmdk_resize(lba_t imgsz) 94{ 95 uint64_t imagesz; 96 97 imagesz = imgsz * secsz; 98 imagesz = (imagesz + VMDK_IMAGE_ROUND - 1) & ~(VMDK_IMAGE_ROUND - 1); 99 grainsz = (blksz < VMDK_MIN_GRAIN_SIZE) ? VMDK_MIN_GRAIN_SIZE : blksz; 100 101 if (verbose) 102 fprintf(stderr, "VMDK: image size = %ju, grain size = %ju\n", 103 (uintmax_t)imagesz, (uintmax_t)grainsz); 104 105 grainsz /= VMDK_SECTOR_SIZE; 106 return (image_set_size(imagesz / secsz)); 107} 108 109static int 110vmdk_write(int fd) 111{ 112 struct vmdk_header hdr; 113 uint32_t *gt, *gd; 114 char *buf, *desc; 115 off_t cur, lim; 116 uint64_t imagesz; 117 lba_t blkofs, blkcnt; 118 size_t gdsz, gtsz; 119 uint32_t sec, cursec; 120 int error, desc_len, n, ngrains, ngts; 121 122 imagesz = (image_get_size() * secsz) / VMDK_SECTOR_SIZE; 123 124 memset(&hdr, 0, sizeof(hdr)); 125 le32enc(&hdr.magic, VMDK_MAGIC); 126 le32enc(&hdr.version, VMDK_VERSION); 127 le32enc(&hdr.flags, VMDK_FLAGS_NL_TEST | VMDK_FLAGS_RGT_USED); 128 le64enc(&hdr.capacity, imagesz); 129 le64enc(&hdr.grain_size, grainsz); 130 131 n = asprintf(&desc, desc_fmt, 1 /*version*/, 0 /*CID*/, 132 (uintmax_t)imagesz /*size*/, "" /*name*/, 133 ncyls /*cylinders*/, nheads /*heads*/, nsecs /*sectors*/); 134 if (n == -1) 135 return (ENOMEM); 136 137 desc_len = (n + VMDK_SECTOR_SIZE - 1) & ~(VMDK_SECTOR_SIZE - 1); 138 desc = realloc(desc, desc_len); 139 memset(desc + n, 0, desc_len - n); 140 141 le64enc(&hdr.desc_offset, 1); 142 le64enc(&hdr.desc_size, desc_len / VMDK_SECTOR_SIZE); 143 le32enc(&hdr.ngtes, VMDK_NGTES); 144 145 sec = desc_len / VMDK_SECTOR_SIZE + 1; 146 le64enc(&hdr.rgd_offset, sec); 147 le64enc(&hdr.gd_offset, sec); 148 149 ngrains = imagesz / grainsz; 150 ngts = (ngrains + VMDK_NGTES - 1) / VMDK_NGTES; 151 gdsz = (ngts * sizeof(uint32_t) + VMDK_SECTOR_SIZE - 1) & 152 ~(VMDK_SECTOR_SIZE - 1); 153 gd = calloc(gdsz, 1); 154 if (gd == NULL) { 155 free(desc); 156 return (ENOMEM); 157 } 158 159 sec += gdsz / VMDK_SECTOR_SIZE; 160 for (n = 0; n < ngts; n++) { 161 le32enc(gd + n, sec); 162 sec += VMDK_NGTES * sizeof(uint32_t) / VMDK_SECTOR_SIZE; 163 } 164 165 sec = (sec + grainsz - 1) & ~(grainsz - 1); 166 167 if (verbose) 168 fprintf(stderr, "VMDK: overhead = %ju\n", 169 (uintmax_t)(sec * VMDK_SECTOR_SIZE)); 170 171 le64enc(&hdr.overhead, sec); 172 be32enc(&hdr.nl_test, VMDK_NL_TEST); 173 174 gtsz = ngts * VMDK_NGTES * sizeof(uint32_t); 175 gt = calloc(gtsz, 1); 176 if (gt == NULL) { 177 free(gd); 178 free(desc); 179 return (ENOMEM); 180 } 181 182 cursec = sec; 183 blkcnt = (grainsz * VMDK_SECTOR_SIZE) / secsz; 184 for (n = 0; n < ngrains; n++) { 185 blkofs = n * blkcnt; 186 if (image_data(blkofs, blkcnt)) { 187 le32enc(gt + n, cursec); 188 cursec += grainsz; 189 } 190 } 191 192 error = 0; 193 if (!error && sparse_write(fd, &hdr, VMDK_SECTOR_SIZE) < 0) 194 error = errno; 195 if (!error && sparse_write(fd, desc, desc_len) < 0) 196 error = errno; 197 if (!error && sparse_write(fd, gd, gdsz) < 0) 198 error = errno; 199 if (!error && sparse_write(fd, gt, gtsz) < 0) 200 error = errno; 201 free(gt); 202 free(gd); 203 free(desc); 204 if (error) 205 return (error); 206 207 cur = VMDK_SECTOR_SIZE + desc_len + gdsz + gtsz; 208 lim = sec * VMDK_SECTOR_SIZE; 209 if (cur < lim) { 210 buf = calloc(VMDK_SECTOR_SIZE, 1); 211 if (buf == NULL) 212 error = ENOMEM; 213 while (!error && cur < lim) { 214 if (sparse_write(fd, buf, VMDK_SECTOR_SIZE) < 0) 215 error = errno; 216 cur += VMDK_SECTOR_SIZE; 217 } 218 if (buf != NULL) 219 free(buf); 220 } 221 if (error) 222 return (error); 223 224 blkcnt = (grainsz * VMDK_SECTOR_SIZE) / secsz; 225 for (n = 0; n < ngrains; n++) { 226 blkofs = n * blkcnt; 227 if (image_data(blkofs, blkcnt)) { 228 error = image_copyout_region(fd, blkofs, blkcnt); 229 if (error) 230 return (error); 231 } 232 } 233 return (image_copyout_done(fd)); 234} 235 236static struct mkimg_format vmdk_format = { 237 .name = "vmdk", 238 .description = "Virtual Machine Disk", 239 .resize = vmdk_resize, 240 .write = vmdk_write, 241}; 242 243FORMAT_DEFINE(vmdk_format); 244