vmdk.c revision 269745
1265625Smarcel/*- 2265625Smarcel * Copyright (c) 2014 Juniper Networks, Inc. 3265625Smarcel * All rights reserved. 4265625Smarcel * 5265625Smarcel * Redistribution and use in source and binary forms, with or without 6265625Smarcel * modification, are permitted provided that the following conditions 7265625Smarcel * are met: 8265625Smarcel * 1. Redistributions of source code must retain the above copyright 9265625Smarcel * notice, this list of conditions and the following disclaimer. 10265625Smarcel * 2. Redistributions in binary form must reproduce the above copyright 11265625Smarcel * notice, this list of conditions and the following disclaimer in the 12265625Smarcel * documentation and/or other materials provided with the distribution. 13265625Smarcel * 14265625Smarcel * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15265625Smarcel * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16265625Smarcel * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17265625Smarcel * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18265625Smarcel * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19265625Smarcel * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20265625Smarcel * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21265625Smarcel * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22265625Smarcel * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23265625Smarcel * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24265625Smarcel * SUCH DAMAGE. 25265625Smarcel */ 26265625Smarcel 27265625Smarcel#include <sys/cdefs.h> 28265625Smarcel__FBSDID("$FreeBSD: head/usr.bin/mkimg/vmdk.c 269745 2014-08-09 04:47:12Z marcel $"); 29265625Smarcel 30265625Smarcel#include <sys/types.h> 31265625Smarcel#include <sys/endian.h> 32265625Smarcel#include <sys/errno.h> 33265725Smarcel#include <stdint.h> 34265725Smarcel#include <stdio.h> 35265625Smarcel#include <stdlib.h> 36265625Smarcel#include <string.h> 37265625Smarcel#include <unistd.h> 38265625Smarcel 39266039Smarcel#include "image.h" 40265625Smarcel#include "format.h" 41265625Smarcel#include "mkimg.h" 42265625Smarcel 43266112Smarcel#define VMDK_IMAGE_ROUND 1048576 44266099Smarcel#define VMDK_MIN_GRAIN_SIZE 8192 45266099Smarcel#define VMDK_SECTOR_SIZE 512 46266099Smarcel 47265684Smarcelstruct vmdk_header { 48265684Smarcel uint32_t magic; 49265684Smarcel#define VMDK_MAGIC 0x564d444b 50265684Smarcel uint32_t version; 51265684Smarcel#define VMDK_VERSION 1 52265684Smarcel uint32_t flags; 53265684Smarcel#define VMDK_FLAGS_NL_TEST (1 << 0) 54265684Smarcel#define VMDK_FLAGS_RGT_USED (1 << 1) 55265684Smarcel#define VMDK_FLAGS_COMPRESSED (1 << 16) 56265684Smarcel#define VMDK_FLAGS_MARKERS (1 << 17) 57265684Smarcel uint64_t capacity; 58265684Smarcel uint64_t grain_size; 59265684Smarcel uint64_t desc_offset; 60265684Smarcel uint64_t desc_size; 61265684Smarcel uint32_t ngtes; 62265684Smarcel#define VMDK_NGTES 512 63265684Smarcel uint64_t rgd_offset; 64265684Smarcel uint64_t gd_offset; 65265684Smarcel uint64_t overhead; 66265684Smarcel uint8_t unclean; 67266099Smarcel uint32_t nl_test; 68265684Smarcel#define VMDK_NL_TEST 0x0a200d0a 69265684Smarcel uint16_t compress; 70265684Smarcel#define VMDK_COMPRESS_NONE 0 71265684Smarcel#define VMDK_COMPRESS_DEFLATE 1 72265684Smarcel char padding[433]; 73265684Smarcel} __attribute__((__packed__)); 74265684Smarcel 75265725Smarcelstatic const char desc_fmt[] = 76265725Smarcel "# Disk DescriptorFile\n" 77265725Smarcel "version=%d\n" 78265725Smarcel "CID=%08x\n" 79265725Smarcel "parentCID=ffffffff\n" 80265725Smarcel "createType=\"monolithicSparse\"\n" 81265725Smarcel "# Extent description\n" 82265725Smarcel "RW %ju SPARSE \"%s\"\n" 83265725Smarcel "# The Disk Data Base\n" 84265725Smarcel "#DDB\n" 85265725Smarcel "ddb.adapterType = \"ide\"\n" 86265725Smarcel "ddb.geometry.cylinders = \"%u\"\n" 87265725Smarcel "ddb.geometry.heads = \"%u\"\n" 88265725Smarcel "ddb.geometry.sectors = \"%u\"\n"; 89265725Smarcel 90266099Smarcelstatic uint64_t grainsz; 91266099Smarcel 92265625Smarcelstatic int 93266099Smarcelvmdk_resize(lba_t imgsz) 94266039Smarcel{ 95266099Smarcel uint64_t imagesz; 96266039Smarcel 97266099Smarcel imagesz = imgsz * secsz; 98266112Smarcel imagesz = (imagesz + VMDK_IMAGE_ROUND - 1) & ~(VMDK_IMAGE_ROUND - 1); 99266099Smarcel grainsz = (blksz < VMDK_MIN_GRAIN_SIZE) ? VMDK_MIN_GRAIN_SIZE : blksz; 100266099Smarcel 101266099Smarcel if (verbose) 102266099Smarcel fprintf(stderr, "VMDK: image size = %ju, grain size = %ju\n", 103266099Smarcel (uintmax_t)imagesz, (uintmax_t)grainsz); 104266099Smarcel 105266099Smarcel grainsz /= VMDK_SECTOR_SIZE; 106266099Smarcel return (image_set_size(imagesz / secsz)); 107266039Smarcel} 108266039Smarcel 109266039Smarcelstatic int 110266099Smarcelvmdk_write(int fd) 111265625Smarcel{ 112266099Smarcel struct vmdk_header hdr; 113269745Smarcel uint32_t *gt, *gd, *rgd; 114266132Smarcel char *buf, *desc; 115266132Smarcel off_t cur, lim; 116266099Smarcel uint64_t imagesz; 117268646Smarcel lba_t blkofs, blkcnt; 118266099Smarcel size_t gdsz, gtsz; 119268646Smarcel uint32_t sec, cursec; 120266124Smarcel int error, desc_len, n, ngrains, ngts; 121265625Smarcel 122266099Smarcel imagesz = (image_get_size() * secsz) / VMDK_SECTOR_SIZE; 123266099Smarcel 124266099Smarcel memset(&hdr, 0, sizeof(hdr)); 125266099Smarcel le32enc(&hdr.magic, VMDK_MAGIC); 126266099Smarcel le32enc(&hdr.version, VMDK_VERSION); 127266099Smarcel le32enc(&hdr.flags, VMDK_FLAGS_NL_TEST | VMDK_FLAGS_RGT_USED); 128266099Smarcel le64enc(&hdr.capacity, imagesz); 129266099Smarcel le64enc(&hdr.grain_size, grainsz); 130266099Smarcel 131266099Smarcel n = asprintf(&desc, desc_fmt, 1 /*version*/, 0 /*CID*/, 132266099Smarcel (uintmax_t)imagesz /*size*/, "" /*name*/, 133265725Smarcel ncyls /*cylinders*/, nheads /*heads*/, nsecs /*sectors*/); 134266124Smarcel if (n == -1) 135266124Smarcel return (ENOMEM); 136266124Smarcel 137266099Smarcel desc_len = (n + VMDK_SECTOR_SIZE - 1) & ~(VMDK_SECTOR_SIZE - 1); 138265725Smarcel desc = realloc(desc, desc_len); 139266099Smarcel memset(desc + n, 0, desc_len - n); 140265725Smarcel 141266099Smarcel le64enc(&hdr.desc_offset, 1); 142266099Smarcel le64enc(&hdr.desc_size, desc_len / VMDK_SECTOR_SIZE); 143266099Smarcel le32enc(&hdr.ngtes, VMDK_NGTES); 144266099Smarcel 145266099Smarcel sec = desc_len / VMDK_SECTOR_SIZE + 1; 146266099Smarcel 147266099Smarcel ngrains = imagesz / grainsz; 148266099Smarcel ngts = (ngrains + VMDK_NGTES - 1) / VMDK_NGTES; 149266099Smarcel gdsz = (ngts * sizeof(uint32_t) + VMDK_SECTOR_SIZE - 1) & 150266099Smarcel ~(VMDK_SECTOR_SIZE - 1); 151269745Smarcel 152266124Smarcel gd = calloc(gdsz, 1); 153266124Smarcel if (gd == NULL) { 154266124Smarcel free(desc); 155266124Smarcel return (ENOMEM); 156266124Smarcel } 157269745Smarcel le64enc(&hdr.gd_offset, sec); 158266099Smarcel sec += gdsz / VMDK_SECTOR_SIZE; 159266099Smarcel for (n = 0; n < ngts; n++) { 160266099Smarcel le32enc(gd + n, sec); 161266099Smarcel sec += VMDK_NGTES * sizeof(uint32_t) / VMDK_SECTOR_SIZE; 162266099Smarcel } 163266099Smarcel 164269745Smarcel rgd = calloc(gdsz, 1); 165269745Smarcel if (rgd == NULL) { 166269745Smarcel free(gd); 167269745Smarcel free(desc); 168269745Smarcel return (ENOMEM); 169269745Smarcel } 170269745Smarcel le64enc(&hdr.rgd_offset, sec); 171269745Smarcel sec += gdsz / VMDK_SECTOR_SIZE; 172269745Smarcel for (n = 0; n < ngts; n++) { 173269745Smarcel le32enc(rgd + n, sec); 174269745Smarcel sec += VMDK_NGTES * sizeof(uint32_t) / VMDK_SECTOR_SIZE; 175269745Smarcel } 176269745Smarcel 177266099Smarcel sec = (sec + grainsz - 1) & ~(grainsz - 1); 178266099Smarcel 179266099Smarcel if (verbose) 180266099Smarcel fprintf(stderr, "VMDK: overhead = %ju\n", 181266099Smarcel (uintmax_t)(sec * VMDK_SECTOR_SIZE)); 182266099Smarcel 183266099Smarcel le64enc(&hdr.overhead, sec); 184266099Smarcel be32enc(&hdr.nl_test, VMDK_NL_TEST); 185266099Smarcel 186266099Smarcel gtsz = ngts * VMDK_NGTES * sizeof(uint32_t); 187266124Smarcel gt = calloc(gtsz, 1); 188266124Smarcel if (gt == NULL) { 189269745Smarcel free(rgd); 190266124Smarcel free(gd); 191266124Smarcel free(desc); 192266124Smarcel return (ENOMEM); 193266124Smarcel } 194266099Smarcel 195268646Smarcel cursec = sec; 196268646Smarcel blkcnt = (grainsz * VMDK_SECTOR_SIZE) / secsz; 197268646Smarcel for (n = 0; n < ngrains; n++) { 198268646Smarcel blkofs = n * blkcnt; 199268646Smarcel if (image_data(blkofs, blkcnt)) { 200268646Smarcel le32enc(gt + n, cursec); 201268646Smarcel cursec += grainsz; 202268646Smarcel } 203268646Smarcel } 204266099Smarcel 205266132Smarcel error = 0; 206266132Smarcel if (!error && sparse_write(fd, &hdr, VMDK_SECTOR_SIZE) < 0) 207266132Smarcel error = errno; 208266132Smarcel if (!error && sparse_write(fd, desc, desc_len) < 0) 209266132Smarcel error = errno; 210266132Smarcel if (!error && sparse_write(fd, gd, gdsz) < 0) 211266132Smarcel error = errno; 212266132Smarcel if (!error && sparse_write(fd, gt, gtsz) < 0) 213266132Smarcel error = errno; 214269745Smarcel if (!error && sparse_write(fd, rgd, gdsz) < 0) 215269745Smarcel error = errno; 216269745Smarcel if (!error && sparse_write(fd, gt, gtsz) < 0) 217269745Smarcel error = errno; 218266124Smarcel free(gt); 219269745Smarcel free(rgd); 220266124Smarcel free(gd); 221266124Smarcel free(desc); 222266132Smarcel if (error) 223266132Smarcel return (error); 224266124Smarcel 225269745Smarcel cur = VMDK_SECTOR_SIZE + desc_len + (gdsz + gtsz) * 2; 226266132Smarcel lim = sec * VMDK_SECTOR_SIZE; 227266132Smarcel if (cur < lim) { 228266132Smarcel buf = calloc(VMDK_SECTOR_SIZE, 1); 229266132Smarcel if (buf == NULL) 230266132Smarcel error = ENOMEM; 231266132Smarcel while (!error && cur < lim) { 232266132Smarcel if (sparse_write(fd, buf, VMDK_SECTOR_SIZE) < 0) 233266132Smarcel error = errno; 234266132Smarcel cur += VMDK_SECTOR_SIZE; 235266132Smarcel } 236266132Smarcel if (buf != NULL) 237266132Smarcel free(buf); 238266132Smarcel } 239268646Smarcel if (error) 240268646Smarcel return (error); 241268646Smarcel 242268646Smarcel blkcnt = (grainsz * VMDK_SECTOR_SIZE) / secsz; 243268646Smarcel for (n = 0; n < ngrains; n++) { 244268646Smarcel blkofs = n * blkcnt; 245268646Smarcel if (image_data(blkofs, blkcnt)) { 246268646Smarcel error = image_copyout_region(fd, blkofs, blkcnt); 247268646Smarcel if (error) 248268646Smarcel return (error); 249268646Smarcel } 250268646Smarcel } 251268646Smarcel return (image_copyout_done(fd)); 252265625Smarcel} 253265625Smarcel 254265625Smarcelstatic struct mkimg_format vmdk_format = { 255265625Smarcel .name = "vmdk", 256265625Smarcel .description = "Virtual Machine Disk", 257266039Smarcel .resize = vmdk_resize, 258265625Smarcel .write = vmdk_write, 259265625Smarcel}; 260265625Smarcel 261265625SmarcelFORMAT_DEFINE(vmdk_format); 262