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: stable/11/usr.bin/mkimg/vmdk.c 329059 2018-02-09 09:15:43Z manu $"); 29265625Smarcel 30265625Smarcel#include <sys/errno.h> 31265725Smarcel#include <stdint.h> 32265725Smarcel#include <stdio.h> 33265625Smarcel#include <stdlib.h> 34265625Smarcel#include <string.h> 35265625Smarcel#include <unistd.h> 36265625Smarcel 37329059Smanu#include "endian.h" 38266039Smarcel#include "image.h" 39265625Smarcel#include "format.h" 40265625Smarcel#include "mkimg.h" 41265625Smarcel 42266112Smarcel#define VMDK_IMAGE_ROUND 1048576 43266099Smarcel#define VMDK_MIN_GRAIN_SIZE 8192 44266099Smarcel#define VMDK_SECTOR_SIZE 512 45266099Smarcel 46265684Smarcelstruct vmdk_header { 47265684Smarcel uint32_t magic; 48265684Smarcel#define VMDK_MAGIC 0x564d444b 49265684Smarcel uint32_t version; 50265684Smarcel#define VMDK_VERSION 1 51265684Smarcel uint32_t flags; 52265684Smarcel#define VMDK_FLAGS_NL_TEST (1 << 0) 53265684Smarcel#define VMDK_FLAGS_RGT_USED (1 << 1) 54265684Smarcel#define VMDK_FLAGS_COMPRESSED (1 << 16) 55265684Smarcel#define VMDK_FLAGS_MARKERS (1 << 17) 56265684Smarcel uint64_t capacity; 57265684Smarcel uint64_t grain_size; 58265684Smarcel uint64_t desc_offset; 59265684Smarcel uint64_t desc_size; 60265684Smarcel uint32_t ngtes; 61265684Smarcel#define VMDK_NGTES 512 62265684Smarcel uint64_t rgd_offset; 63265684Smarcel uint64_t gd_offset; 64265684Smarcel uint64_t overhead; 65265684Smarcel uint8_t unclean; 66266099Smarcel uint32_t nl_test; 67265684Smarcel#define VMDK_NL_TEST 0x0a200d0a 68265684Smarcel uint16_t compress; 69265684Smarcel#define VMDK_COMPRESS_NONE 0 70265684Smarcel#define VMDK_COMPRESS_DEFLATE 1 71265684Smarcel char padding[433]; 72265684Smarcel} __attribute__((__packed__)); 73265684Smarcel 74265725Smarcelstatic const char desc_fmt[] = 75265725Smarcel "# Disk DescriptorFile\n" 76265725Smarcel "version=%d\n" 77265725Smarcel "CID=%08x\n" 78265725Smarcel "parentCID=ffffffff\n" 79265725Smarcel "createType=\"monolithicSparse\"\n" 80265725Smarcel "# Extent description\n" 81265725Smarcel "RW %ju SPARSE \"%s\"\n" 82265725Smarcel "# The Disk Data Base\n" 83265725Smarcel "#DDB\n" 84265725Smarcel "ddb.adapterType = \"ide\"\n" 85265725Smarcel "ddb.geometry.cylinders = \"%u\"\n" 86265725Smarcel "ddb.geometry.heads = \"%u\"\n" 87265725Smarcel "ddb.geometry.sectors = \"%u\"\n"; 88265725Smarcel 89266099Smarcelstatic uint64_t grainsz; 90266099Smarcel 91265625Smarcelstatic int 92266099Smarcelvmdk_resize(lba_t imgsz) 93266039Smarcel{ 94266099Smarcel uint64_t imagesz; 95266039Smarcel 96266099Smarcel imagesz = imgsz * secsz; 97266112Smarcel imagesz = (imagesz + VMDK_IMAGE_ROUND - 1) & ~(VMDK_IMAGE_ROUND - 1); 98266099Smarcel grainsz = (blksz < VMDK_MIN_GRAIN_SIZE) ? VMDK_MIN_GRAIN_SIZE : blksz; 99266099Smarcel 100266099Smarcel if (verbose) 101266099Smarcel fprintf(stderr, "VMDK: image size = %ju, grain size = %ju\n", 102266099Smarcel (uintmax_t)imagesz, (uintmax_t)grainsz); 103266099Smarcel 104266099Smarcel grainsz /= VMDK_SECTOR_SIZE; 105266099Smarcel return (image_set_size(imagesz / secsz)); 106266039Smarcel} 107266039Smarcel 108266039Smarcelstatic int 109266099Smarcelvmdk_write(int fd) 110265625Smarcel{ 111266099Smarcel struct vmdk_header hdr; 112269745Smarcel uint32_t *gt, *gd, *rgd; 113266132Smarcel char *buf, *desc; 114266132Smarcel off_t cur, lim; 115266099Smarcel uint64_t imagesz; 116268646Smarcel lba_t blkofs, blkcnt; 117266099Smarcel size_t gdsz, gtsz; 118268646Smarcel uint32_t sec, cursec; 119266124Smarcel int error, desc_len, n, ngrains, ngts; 120265625Smarcel 121266099Smarcel imagesz = (image_get_size() * secsz) / VMDK_SECTOR_SIZE; 122266099Smarcel 123266099Smarcel memset(&hdr, 0, sizeof(hdr)); 124266099Smarcel le32enc(&hdr.magic, VMDK_MAGIC); 125266099Smarcel le32enc(&hdr.version, VMDK_VERSION); 126266099Smarcel le32enc(&hdr.flags, VMDK_FLAGS_NL_TEST | VMDK_FLAGS_RGT_USED); 127266099Smarcel le64enc(&hdr.capacity, imagesz); 128266099Smarcel le64enc(&hdr.grain_size, grainsz); 129266099Smarcel 130266099Smarcel n = asprintf(&desc, desc_fmt, 1 /*version*/, 0 /*CID*/, 131266099Smarcel (uintmax_t)imagesz /*size*/, "" /*name*/, 132265725Smarcel ncyls /*cylinders*/, nheads /*heads*/, nsecs /*sectors*/); 133266124Smarcel if (n == -1) 134266124Smarcel return (ENOMEM); 135266124Smarcel 136266099Smarcel desc_len = (n + VMDK_SECTOR_SIZE - 1) & ~(VMDK_SECTOR_SIZE - 1); 137265725Smarcel desc = realloc(desc, desc_len); 138266099Smarcel memset(desc + n, 0, desc_len - n); 139265725Smarcel 140266099Smarcel le64enc(&hdr.desc_offset, 1); 141266099Smarcel le64enc(&hdr.desc_size, desc_len / VMDK_SECTOR_SIZE); 142266099Smarcel le32enc(&hdr.ngtes, VMDK_NGTES); 143266099Smarcel 144266099Smarcel sec = desc_len / VMDK_SECTOR_SIZE + 1; 145266099Smarcel 146266099Smarcel ngrains = imagesz / grainsz; 147266099Smarcel ngts = (ngrains + VMDK_NGTES - 1) / VMDK_NGTES; 148266099Smarcel gdsz = (ngts * sizeof(uint32_t) + VMDK_SECTOR_SIZE - 1) & 149266099Smarcel ~(VMDK_SECTOR_SIZE - 1); 150269745Smarcel 151317268Spfg gd = calloc(1, gdsz); 152266124Smarcel if (gd == NULL) { 153266124Smarcel free(desc); 154266124Smarcel return (ENOMEM); 155266124Smarcel } 156269745Smarcel le64enc(&hdr.gd_offset, sec); 157266099Smarcel sec += gdsz / VMDK_SECTOR_SIZE; 158266099Smarcel for (n = 0; n < ngts; n++) { 159266099Smarcel le32enc(gd + n, sec); 160266099Smarcel sec += VMDK_NGTES * sizeof(uint32_t) / VMDK_SECTOR_SIZE; 161266099Smarcel } 162266099Smarcel 163317268Spfg rgd = calloc(1, gdsz); 164269745Smarcel if (rgd == NULL) { 165269745Smarcel free(gd); 166269745Smarcel free(desc); 167269745Smarcel return (ENOMEM); 168269745Smarcel } 169269745Smarcel le64enc(&hdr.rgd_offset, sec); 170269745Smarcel sec += gdsz / VMDK_SECTOR_SIZE; 171269745Smarcel for (n = 0; n < ngts; n++) { 172269745Smarcel le32enc(rgd + n, sec); 173269745Smarcel sec += VMDK_NGTES * sizeof(uint32_t) / VMDK_SECTOR_SIZE; 174269745Smarcel } 175269745Smarcel 176266099Smarcel sec = (sec + grainsz - 1) & ~(grainsz - 1); 177266099Smarcel 178266099Smarcel if (verbose) 179266099Smarcel fprintf(stderr, "VMDK: overhead = %ju\n", 180266099Smarcel (uintmax_t)(sec * VMDK_SECTOR_SIZE)); 181266099Smarcel 182266099Smarcel le64enc(&hdr.overhead, sec); 183266099Smarcel be32enc(&hdr.nl_test, VMDK_NL_TEST); 184266099Smarcel 185317268Spfg gt = calloc(ngts, VMDK_NGTES * sizeof(uint32_t)); 186266124Smarcel if (gt == NULL) { 187269745Smarcel free(rgd); 188266124Smarcel free(gd); 189266124Smarcel free(desc); 190266124Smarcel return (ENOMEM); 191266124Smarcel } 192317268Spfg gtsz = ngts * VMDK_NGTES * sizeof(uint32_t); 193266099Smarcel 194268646Smarcel cursec = sec; 195268646Smarcel blkcnt = (grainsz * VMDK_SECTOR_SIZE) / secsz; 196268646Smarcel for (n = 0; n < ngrains; n++) { 197268646Smarcel blkofs = n * blkcnt; 198268646Smarcel if (image_data(blkofs, blkcnt)) { 199268646Smarcel le32enc(gt + n, cursec); 200268646Smarcel cursec += grainsz; 201268646Smarcel } 202268646Smarcel } 203266099Smarcel 204266132Smarcel error = 0; 205266132Smarcel if (!error && sparse_write(fd, &hdr, VMDK_SECTOR_SIZE) < 0) 206266132Smarcel error = errno; 207266132Smarcel if (!error && sparse_write(fd, desc, desc_len) < 0) 208266132Smarcel error = errno; 209266132Smarcel if (!error && sparse_write(fd, gd, gdsz) < 0) 210266132Smarcel error = errno; 211266132Smarcel if (!error && sparse_write(fd, gt, gtsz) < 0) 212266132Smarcel error = errno; 213269745Smarcel if (!error && sparse_write(fd, rgd, gdsz) < 0) 214269745Smarcel error = errno; 215269745Smarcel if (!error && sparse_write(fd, gt, gtsz) < 0) 216269745Smarcel error = errno; 217266124Smarcel free(gt); 218269745Smarcel free(rgd); 219266124Smarcel free(gd); 220266124Smarcel free(desc); 221266132Smarcel if (error) 222266132Smarcel return (error); 223266124Smarcel 224269745Smarcel cur = VMDK_SECTOR_SIZE + desc_len + (gdsz + gtsz) * 2; 225266132Smarcel lim = sec * VMDK_SECTOR_SIZE; 226266132Smarcel if (cur < lim) { 227317268Spfg buf = calloc(1, VMDK_SECTOR_SIZE); 228266132Smarcel if (buf == NULL) 229266132Smarcel error = ENOMEM; 230266132Smarcel while (!error && cur < lim) { 231266132Smarcel if (sparse_write(fd, buf, VMDK_SECTOR_SIZE) < 0) 232266132Smarcel error = errno; 233266132Smarcel cur += VMDK_SECTOR_SIZE; 234266132Smarcel } 235266132Smarcel if (buf != NULL) 236266132Smarcel free(buf); 237266132Smarcel } 238268646Smarcel if (error) 239268646Smarcel return (error); 240268646Smarcel 241268646Smarcel blkcnt = (grainsz * VMDK_SECTOR_SIZE) / secsz; 242268646Smarcel for (n = 0; n < ngrains; n++) { 243268646Smarcel blkofs = n * blkcnt; 244268646Smarcel if (image_data(blkofs, blkcnt)) { 245268646Smarcel error = image_copyout_region(fd, blkofs, blkcnt); 246268646Smarcel if (error) 247268646Smarcel return (error); 248268646Smarcel } 249268646Smarcel } 250268646Smarcel return (image_copyout_done(fd)); 251265625Smarcel} 252265625Smarcel 253265625Smarcelstatic struct mkimg_format vmdk_format = { 254265625Smarcel .name = "vmdk", 255265625Smarcel .description = "Virtual Machine Disk", 256266039Smarcel .resize = vmdk_resize, 257265625Smarcel .write = vmdk_write, 258265625Smarcel}; 259265625Smarcel 260265625SmarcelFORMAT_DEFINE(vmdk_format); 261