7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * VHDX - VHDX Disk image, Core Code.
c5397a397db4649847120db7615898569cc41669vboxsync * Copyright (C) 2012-2015 Oracle Corporation
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * available from http://www.virtualbox.org. This file is free software;
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * you can redistribute it and/or modify it under the terms of the GNU
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * General Public License (GPL) as published by the Free Software
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/*******************************************************************************
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync* Header Files *
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync*******************************************************************************/
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/*******************************************************************************
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync* On disk data structures *
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync*******************************************************************************/
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * VHDX file type identifier.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Signature. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Creator ID - UTF-16 string (not neccessarily null terminated). */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Pointer to an on disk VHDX file type identifier. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** VHDX file type identifier signature ("vhdxfile"). */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_FILE_IDENTIFIER_SIGNATURE UINT64_C(0x656c696678646876)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Start offset of the VHDX file type identifier. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * VHDX header.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Signature. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Checksum. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Sequence number. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** File write UUID. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Data write UUID. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Log UUID. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Version of the log format. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** VHDX format version.. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Length of the log region. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Start offset of the log offset in the file. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Reserved bytes. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Pointer to an on disk VHDX header. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** VHDX header signature ("head"). */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Start offset of the first VHDX header. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Start offset of the second VHDX header. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Current Log format version. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Current VHDX format version. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * VHDX region table header
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Signature. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Checksum. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Number of region table entries following this header. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Reserved. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Pointer to an on disk VHDX region table header. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** VHDX region table header signature. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_REGION_TBL_HDR_SIGNATURE UINT32_C(0x69676572)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Maximum number of entries which can follow. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_REGION_TBL_HDR_ENTRY_COUNT_MAX UINT32_C(2047)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Offset where the region table is stored (192 KB). */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Maximum size of the region table. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * VHDX region table entry.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Object UUID. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** File offset of the region. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Length of the region in bytes. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Flags for this object. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Pointer to an on disk VHDX region table entry. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsynctypedef struct VhdxRegionTblEntry *PVhdxRegionTblEntry;
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Flag whether this region is required. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_REGION_TBL_ENTRY_FLAGS_IS_REQUIRED RT_BIT_32(0)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** UUID for the BAT region. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_REGION_TBL_ENTRY_UUID_BAT "2dc27766-f623-4200-9d64-115e9bfd4a08"
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** UUID for the metadata region. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_REGION_TBL_ENTRY_UUID_METADATA "8b7ca206-4790-4b9a-b8fe-575f050f886e"
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * VHDX Log entry header.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Signature. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Checksum. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Total length of the entry in bytes. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Tail of the log entries. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Sequence number. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Number of descriptors in this log entry. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Reserved. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Log UUID. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** VHDX file size in bytes while the log entry was written. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** File size in bytes all allocated file structures fit into when the
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * log entry was written. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Pointer to an on disk VHDX log entry header. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** VHDX log entry signature ("loge"). */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_LOG_ENTRY_HEADER_SIGNATURE UINT32_C(0x65676f6c)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * VHDX log zero descriptor.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Signature of this descriptor. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Reserved. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Length of the section to zero. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** File offset to write zeros to. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Sequence number (must macht the field in the log entry header). */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Pointer to an on disk VHDX log zero descriptor. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Signature of a VHDX log zero descriptor ("zero"). */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_LOG_ZERO_DESC_SIGNATURE UINT32_C(0x6f72657a)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * VHDX log data descriptor.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Signature of this descriptor. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Trailing 4 bytes removed from the update. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Leading 8 bytes removed from the update. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** File offset to write zeros to. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Sequence number (must macht the field in the log entry header). */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Pointer to an on disk VHDX log data descriptor. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Signature of a VHDX log data descriptor ("desc"). */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_LOG_DATA_DESC_SIGNATURE UINT32_C(0x63736564)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * VHDX log data sector.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Signature of the data sector. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** 4 most significant bytes of the sequence number. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Raw data associated with the update. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** 4 least significant bytes of the sequence number. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Pointer to an on disk VHDX log data sector. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Signature of a VHDX log data sector ("data"). */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_LOG_DATA_SECTOR_SIGNATURE UINT32_C(0x61746164)
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * VHDX BAT entry.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync /** The BAT entry, contains state and offset. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync/** Return the BAT state from a given entry. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync#define VHDX_BAT_ENTRY_GET_STATE(bat) ((bat) & UINT64_C(0x7))
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync/** Get the FileOffsetMB field from a given BAT entry. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync#define VHDX_BAT_ENTRY_GET_FILE_OFFSET_MB(bat) (((bat) & UINT64_C(0xfffffffffff00000)) >> 20)
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync/** Get a byte offset from the BAT entry. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync#define VHDX_BAT_ENTRY_GET_FILE_OFFSET(bat) (VHDX_BAT_ENTRY_GET_FILE_OFFSET_MB(bat) * (uint64_t)_1M)
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync/** Block not present and the data is undefined. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync#define VHDX_BAT_ENTRY_PAYLOAD_BLOCK_NOT_PRESENT (0)
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync/** Data in this block is undefined. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync/** Data in this block contains zeros. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync/** Block was unmapped by the application or system and data is either zero or
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * the data before the block was unmapped. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync/** Block data is in the file pointed to by the FileOffsetMB field. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync#define VHDX_BAT_ENTRY_PAYLOAD_BLOCK_FULLY_PRESENT (6)
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync/** Block is partially present, use sector bitmap to get present sectors. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync#define VHDX_BAT_ENTRY_PAYLOAD_BLOCK_PARTIALLY_PRESENT (7)
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync/** The sector bitmap block is undefined and not allocated in the file. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync/** The sector bitmap block is defined at the file location. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * VHDX Metadata tabl header.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Signature. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Reserved. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Number of entries in the table. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Reserved */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Pointer to an on disk metadata table header. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Signature of a VHDX metadata table header ("metadata"). */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_METADATA_TBL_HDR_SIGNATURE UINT64_C(0x617461646174656d)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Maximum number of entries the metadata table can have. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_METADATA_TBL_HDR_ENTRY_COUNT_MAX UINT16_C(2047)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * VHDX Metadata table entry.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Item UUID. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Offset of the metadata item. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Length of the metadata item. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Flags for the metadata item. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Reserved. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Pointer to an on disk metadata table entry. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsynctypedef VhdxMetadataTblEntry *PVhdxMetadataTblEntry;
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** FLag whether the metadata item is system or user metadata. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_METADATA_TBL_ENTRY_FLAGS_IS_USER RT_BIT_32(0)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** FLag whether the metadata item is file or virtual disk metadata. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_METADATA_TBL_ENTRY_FLAGS_IS_VDISK RT_BIT_32(1)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** FLag whether the backend must understand the metadata item to load the image. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_METADATA_TBL_ENTRY_FLAGS_IS_REQUIRED RT_BIT_32(2)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** File parameters item UUID. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_METADATA_TBL_ENTRY_ITEM_FILE_PARAMS "caa16737-fa36-4d43-b3b6-33f0aa44e76b"
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Virtual disk size item UUID. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync#define VHDX_METADATA_TBL_ENTRY_ITEM_VDISK_SIZE "2fa54224-cd1b-4876-b211-5dbed83bf4b8"
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Page 83 UUID. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_METADATA_TBL_ENTRY_ITEM_PAGE83_DATA "beca12ab-b2e6-4523-93ef-c309e000c746"
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Logical sector size UUID. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_METADATA_TBL_ENTRY_ITEM_LOG_SECT_SIZE "8141bf1d-a96f-4709-ba47-f233a8faab5f"
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Physical sector size UUID. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_METADATA_TBL_ENTRY_ITEM_PHYS_SECT_SIZE "cda348c7-445d-4471-9cc9-e9885251c556"
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Parent locator UUID. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_METADATA_TBL_ENTRY_ITEM_PARENT_LOCATOR "a8d35f2d-b30b-454d-abf7-d3d84834ab0c"
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * VHDX File parameters metadata item.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Block size. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Flags. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Pointer to an on disk VHDX file parameters metadata item. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsynctypedef struct VhdxFileParameters *PVhdxFileParameters;
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Flag whether to leave blocks allocated in the file or if it is possible to unmap them. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_FILE_PARAMETERS_FLAGS_LEAVE_BLOCKS_ALLOCATED RT_BIT_32(0)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Flag whether this file has a parent VHDX file. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_FILE_PARAMETERS_FLAGS_HAS_PARENT RT_BIT_32(1)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * VHDX virtual disk size metadata item.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Virtual disk size. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Pointer to an on disk VHDX virtual disk size metadata item. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * VHDX page 83 data metadata item.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** UUID for the SCSI device. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Pointer to an on disk VHDX vpage 83 data metadata item. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * VHDX virtual disk logical sector size.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Logical sector size. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Pointer to an on disk VHDX virtual disk logical sector size metadata item. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsynctypedef struct VhdxVDiskLogicalSectorSize *PVhdxVDiskLogicalSectorSize;
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * VHDX virtual disk physical sector size.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Physical sector size. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Pointer to an on disk VHDX virtual disk physical sector size metadata item. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsynctypedef struct VhdxVDiskPhysicalSectorSize *PVhdxVDiskPhysicalSectorSize;
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * VHDX parent locator header.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Locator type UUID. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Reserved. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Number of key value pairs. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Pointer to an on disk VHDX parent locator header metadata item. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsynctypedef struct VhdxParentLocatorHeader *PVhdxParentLocatorHeader;
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** VHDX parent locator type. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define VHDX_PARENT_LOCATOR_TYPE_VHDX "b04aefb7-d19e-4a81-b789-25b8e9445913"
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * VHDX parent locator entry.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Offset of the key. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Offset of the value. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Length of the key. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Length of the value. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Pointer to an on disk VHDX parent locator entry. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsynctypedef struct VhdxParentLocatorEntry *PVhdxParentLocatorEntry;
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/*******************************************************************************
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync* Constants And Macros, Structures and Typedefs *
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync*******************************************************************************/
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Table to validate the metadata item UUIDs and the flags.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Item UUID. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Flag whether this is a user or system metadata item. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Flag whether this is a virtual disk or file metadata item. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Flag whether this metadata item is required to load the file. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Metadata item enum associated with this UUID. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * VHDX image data structure.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Image name. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Storage handle. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Pointer to the per-disk VD interface list. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Pointer to the per-image VD interface list. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Error interface. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** I/O interface. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Open flags passed by VBoxHD layer. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Image flags defined during creation or determined during open. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Version of the VHDX image format. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Total size of the image. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync /** Logical sector size of the image. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync /** Block size of the image. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Physical geometry of this image. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Logical geometry of this image. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync /** The BAT. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync /** Chunk ratio. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Endianess conversion direction.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** Host to file endianess. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /** File to host endianess. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** Macros for endianess conversion. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define SET_ENDIAN_U16(u16) (enmConv == VHDXECONV_H2F ? RT_H2LE_U16(u16) : RT_LE2H_U16(u16))
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define SET_ENDIAN_U32(u32) (enmConv == VHDXECONV_H2F ? RT_H2LE_U32(u32) : RT_LE2H_U32(u32))
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync#define SET_ENDIAN_U64(u64) (enmConv == VHDXECONV_H2F ? RT_H2LE_U64(u64) : RT_LE2H_U64(u64))
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/*******************************************************************************
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync* Static Variables *
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync*******************************************************************************/
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * NULL-terminated array of supported file extensions.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic const VDFILEEXTENSION s_aVhdxFileExtensions[] =
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Static table to verify the metadata item properties and the flags.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic const VHDXMETADATAITEMPROPS s_aVhdxMetadataItemProps[] =
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pcszItemUuid fIsUser, fIsVDisk, fIsRequired, enmMetadataItem */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync {VHDX_METADATA_TBL_ENTRY_ITEM_FILE_PARAMS, false, false, true, VHDXMETADATAITEM_FILE_PARAMS},
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync {VHDX_METADATA_TBL_ENTRY_ITEM_VDISK_SIZE, false, true, true, VHDXMETADATAITEM_VDISK_SIZE},
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync {VHDX_METADATA_TBL_ENTRY_ITEM_PAGE83_DATA, false, true, true, VHDXMETADATAITEM_PAGE83_DATA},
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync {VHDX_METADATA_TBL_ENTRY_ITEM_LOG_SECT_SIZE, false, true, true, VHDXMETADATAITEM_LOGICAL_SECTOR_SIZE},
7857b80bc975196753458b1d9e00277f6ce0ff52vboxsync {VHDX_METADATA_TBL_ENTRY_ITEM_PHYS_SECT_SIZE, false, true, true, VHDXMETADATAITEM_PHYSICAL_SECTOR_SIZE},
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync {VHDX_METADATA_TBL_ENTRY_ITEM_PARENT_LOCATOR, false, false, true, VHDXMETADATAITEM_PARENT_LOCATOR}
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/*******************************************************************************
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync* Internal Functions *
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync*******************************************************************************/
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Converts the file identifier between file and host endianness.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns nothing.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param enmConv Direction of the conversion.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pFileIdentifierConv Where to store the converted file identifier.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pFileIdentifier The file identifier to convert.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @note It is safe to use the same pointer for pFileIdentifierConv and pFileIdentifier.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncDECLINLINE(void) vhdxConvFileIdentifierEndianess(VHDXECONV enmConv, PVhdxFileIdentifier pFileIdentifierConv,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pFileIdentifierConv->u64Signature = SET_ENDIAN_U64(pFileIdentifier->u64Signature);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync for (unsigned i = 0; i < RT_ELEMENTS(pFileIdentifierConv->awszCreator); i++)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pFileIdentifierConv->awszCreator[i] = SET_ENDIAN_U16(pFileIdentifier->awszCreator[i]);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Converts a UUID between file and host endianness.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns nothing.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param enmConv Direction of the conversion.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pUuidConv Where to store the converted UUID.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pUuid The UUID to convert.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @note It is safe to use the same pointer for pUuidConv and pUuid.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncDECLINLINE(void) vhdxConvUuidEndianess(VHDXECONV enmConv, PRTUUID pUuidConv, PRTUUID pUuid)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pUuidConv->Gen.u32TimeLow = SET_ENDIAN_U32(pUuid->Gen.u32TimeLow);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pUuidConv->Gen.u16TimeMid = SET_ENDIAN_U16(pUuid->Gen.u16TimeMid);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pUuidConv->Gen.u16TimeHiAndVersion = SET_ENDIAN_U16(pUuid->Gen.u16TimeHiAndVersion);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pUuidConv->Gen.u8ClockSeqHiAndReserved = pUuid->Gen.u8ClockSeqHiAndReserved;
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pUuidConv->Gen.u8ClockSeqLow = pUuid->Gen.u8ClockSeqLow;
d331b18099c73242f3884554e6179536b8a2dac0vboxsync for (unsigned i = 0; i < RT_ELEMENTS(pUuidConv->Gen.au8Node); i++)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Converts a VHDX header between file and host endianness.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns nothing.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param enmConv Direction of the conversion.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pHdrConv Where to store the converted header.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pHdr The VHDX header to convert.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @note It is safe to use the same pointer for pHdrConv and pHdr.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncDECLINLINE(void) vhdxConvHeaderEndianess(VHDXECONV enmConv, PVhdxHeader pHdrConv, PVhdxHeader pHdr)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pHdrConv->u32Signature = SET_ENDIAN_U32(pHdr->u32Signature);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pHdrConv->u32Checksum = SET_ENDIAN_U32(pHdr->u32Checksum);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pHdrConv->u64SequenceNumber = SET_ENDIAN_U64(pHdr->u64SequenceNumber);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync vhdxConvUuidEndianess(enmConv, &pHdrConv->UuidFileWrite, &pHdrConv->UuidFileWrite);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync vhdxConvUuidEndianess(enmConv, &pHdrConv->UuidDataWrite, &pHdrConv->UuidDataWrite);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync vhdxConvUuidEndianess(enmConv, &pHdrConv->UuidLog, &pHdrConv->UuidLog);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pHdrConv->u16LogVersion = SET_ENDIAN_U16(pHdr->u16LogVersion);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pHdrConv->u16Version = SET_ENDIAN_U16(pHdr->u16Version);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pHdrConv->u32LogLength = SET_ENDIAN_U32(pHdr->u32LogLength);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pHdrConv->u64LogOffset = SET_ENDIAN_U64(pHdr->u64LogOffset);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Converts a VHDX region table header between file and host endianness.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns nothing.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param enmConv Direction of the conversion.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pRegTblHdrConv Where to store the converted header.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pRegTblHdr The VHDX region table header to convert.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @note It is safe to use the same pointer for pRegTblHdrConv and pRegTblHdr.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncDECLINLINE(void) vhdxConvRegionTblHdrEndianess(VHDXECONV enmConv, PVhdxRegionTblHdr pRegTblHdrConv,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pRegTblHdrConv->u32Signature = SET_ENDIAN_U32(pRegTblHdr->u32Signature);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pRegTblHdrConv->u32Checksum = SET_ENDIAN_U32(pRegTblHdr->u32Checksum);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pRegTblHdrConv->u32EntryCount = SET_ENDIAN_U32(pRegTblHdr->u32EntryCount);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pRegTblHdrConv->u32Reserved = SET_ENDIAN_U32(pRegTblHdr->u32Reserved);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Converts a VHDX region table entry between file and host endianness.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns nothing.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param enmConv Direction of the conversion.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pRegTblEntConv Where to store the converted region table entry.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pRegTblEnt The VHDX region table entry to convert.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @note It is safe to use the same pointer for pRegTblEntConv and pRegTblEnt.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncDECLINLINE(void) vhdxConvRegionTblEntryEndianess(VHDXECONV enmConv, PVhdxRegionTblEntry pRegTblEntConv,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync vhdxConvUuidEndianess(enmConv, &pRegTblEntConv->UuidObject, &pRegTblEnt->UuidObject);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pRegTblEntConv->u64FileOffset = SET_ENDIAN_U64(pRegTblEnt->u64FileOffset);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pRegTblEntConv->u32Length = SET_ENDIAN_U32(pRegTblEnt->u32Length);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pRegTblEntConv->u32Flags = SET_ENDIAN_U32(pRegTblEnt->u32Flags);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Converts a VHDX log entry header between file and host endianness.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns nothing.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param enmConv Direction of the conversion.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pLogEntryHdrConv Where to store the converted log entry header.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pLogEntryHdr The VHDX log entry header to convert.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @note It is safe to use the same pointer for pLogEntryHdrConv and pLogEntryHdr.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncDECLINLINE(void) vhdxConvLogEntryHdrEndianess(VHDXECONV enmConv, PVhdxLogEntryHdr pLogEntryHdrConv,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogEntryHdrConv->u32Signature = SET_ENDIAN_U32(pLogEntryHdr->u32Signature);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogEntryHdrConv->u32Checksum = SET_ENDIAN_U32(pLogEntryHdr->u32Checksum);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogEntryHdrConv->u32EntryLength = SET_ENDIAN_U32(pLogEntryHdr->u32EntryLength);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogEntryHdrConv->u32Tail = SET_ENDIAN_U32(pLogEntryHdr->u32Tail);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogEntryHdrConv->u64SequenceNumber = SET_ENDIAN_U64(pLogEntryHdr->u64SequenceNumber);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogEntryHdrConv->u32DescriptorCount = SET_ENDIAN_U32(pLogEntryHdr->u32DescriptorCount);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogEntryHdrConv->u32Reserved = SET_ENDIAN_U32(pLogEntryHdr->u32Reserved);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync vhdxConvUuidEndianess(enmConv, &pLogEntryHdrConv->UuidLog, &pLogEntryHdr->UuidLog);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogEntryHdrConv->u64FlushedFileOffset = SET_ENDIAN_U64(pLogEntryHdr->u64FlushedFileOffset);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Converts a VHDX log zero descriptor between file and host endianness.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns nothing.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param enmConv Direction of the conversion.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pLogZeroDescConv Where to store the converted log zero descriptor.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pLogZeroDesc The VHDX log zero descriptor to convert.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @note It is safe to use the same pointer for pLogZeroDescConv and pLogZeroDesc.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncDECLINLINE(void) vhdxConvLogZeroDescEndianess(VHDXECONV enmConv, PVhdxLogZeroDesc pLogZeroDescConv,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogZeroDescConv->u32ZeroSignature = SET_ENDIAN_U32(pLogZeroDesc->u32ZeroSignature);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogZeroDescConv->u32Reserved = SET_ENDIAN_U32(pLogZeroDesc->u32Reserved);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogZeroDescConv->u64ZeroLength = SET_ENDIAN_U64(pLogZeroDesc->u64ZeroLength);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogZeroDescConv->u64FileOffset = SET_ENDIAN_U64(pLogZeroDesc->u64FileOffset);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogZeroDescConv->u64SequenceNumber = SET_ENDIAN_U64(pLogZeroDesc->u64SequenceNumber);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Converts a VHDX log data descriptor between file and host endianness.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns nothing.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param enmConv Direction of the conversion.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pLogDataDescConv Where to store the converted log data descriptor.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pLogDataDesc The VHDX log data descriptor to convert.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @note It is safe to use the same pointer for pLogDataDescConv and pLogDataDesc.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncDECLINLINE(void) vhdxConvLogDataDescEndianess(VHDXECONV enmConv, PVhdxLogDataDesc pLogDataDescConv,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogDataDescConv->u32DataSignature = SET_ENDIAN_U32(pLogDataDesc->u32DataSignature);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogDataDescConv->u32TrailingBytes = SET_ENDIAN_U32(pLogDataDesc->u32TrailingBytes);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogDataDescConv->u64LeadingBytes = SET_ENDIAN_U64(pLogDataDesc->u64LeadingBytes);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogDataDescConv->u64FileOffset = SET_ENDIAN_U64(pLogDataDesc->u64FileOffset);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogDataDescConv->u64SequenceNumber = SET_ENDIAN_U64(pLogDataDesc->u64SequenceNumber);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Converts a VHDX log data sector between file and host endianness.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns nothing.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param enmConv Direction of the conversion.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pLogDataSectorConv Where to store the converted log data sector.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pLogDataSector The VHDX log data sector to convert.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @note It is safe to use the same pointer for pLogDataSectorConv and pLogDataSector.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncDECLINLINE(void) vhdxConvLogDataSectorEndianess(VHDXECONV enmConv, PVhdxLogDataSector pLogDataSectorConv,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogDataSectorConv->u32DataSignature = SET_ENDIAN_U32(pLogDataSector->u32DataSignature);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogDataSectorConv->u32SequenceHigh = SET_ENDIAN_U32(pLogDataSector->u32SequenceHigh);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pLogDataSectorConv->u32SequenceLow = SET_ENDIAN_U32(pLogDataSector->u32SequenceLow);
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * Converts a BAT between file and host endianess.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * @returns nothing.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * @param enmConv Direction of the conversion.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * @param paBatEntriesConv Where to store the converted BAT.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * @param paBatEntries The VHDX BAT to convert.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * @note It is safe to use the same pointer for paBatEntriesConv and paBatEntries.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsyncDECLINLINE(void) vhdxConvBatTableEndianess(VHDXECONV enmConv, PVhdxBatEntry paBatEntriesConv,
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync paBatEntriesConv[i].u64BatEntry = SET_ENDIAN_U64(paBatEntries[i].u64BatEntry);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Converts a VHDX metadata table header between file and host endianness.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns nothing.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param enmConv Direction of the conversion.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pMetadataTblHdrConv Where to store the converted metadata table header.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pMetadataTblHdr The VHDX metadata table header to convert.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @note It is safe to use the same pointer for pMetadataTblHdrConv and pMetadataTblHdr.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncDECLINLINE(void) vhdxConvMetadataTblHdrEndianess(VHDXECONV enmConv, PVhdxMetadataTblHdr pMetadataTblHdrConv,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pMetadataTblHdrConv->u64Signature = SET_ENDIAN_U64(pMetadataTblHdr->u64Signature);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pMetadataTblHdrConv->u16Reserved = SET_ENDIAN_U16(pMetadataTblHdr->u16Reserved);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pMetadataTblHdrConv->u16EntryCount = SET_ENDIAN_U16(pMetadataTblHdr->u16EntryCount);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync for (unsigned i = 0; i < RT_ELEMENTS(pMetadataTblHdr->u32Reserved2); i++)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pMetadataTblHdrConv->u32Reserved2[i] = SET_ENDIAN_U32(pMetadataTblHdr->u32Reserved2[i]);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Converts a VHDX metadata table entry between file and host endianness.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns nothing.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param enmConv Direction of the conversion.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pMetadataTblEntryConv Where to store the converted metadata table entry.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pMetadataTblEntry The VHDX metadata table entry to convert.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @note It is safe to use the same pointer for pMetadataTblEntryConv and pMetadataTblEntry.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncDECLINLINE(void) vhdxConvMetadataTblEntryEndianess(VHDXECONV enmConv, PVhdxMetadataTblEntry pMetadataTblEntryConv,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync vhdxConvUuidEndianess(enmConv, &pMetadataTblEntryConv->UuidItem, &pMetadataTblEntry->UuidItem);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pMetadataTblEntryConv->u32Offset = SET_ENDIAN_U32(pMetadataTblEntry->u32Offset);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pMetadataTblEntryConv->u32Length = SET_ENDIAN_U32(pMetadataTblEntry->u32Length);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pMetadataTblEntryConv->u32Flags = SET_ENDIAN_U32(pMetadataTblEntry->u32Flags);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pMetadataTblEntryConv->u32Reserved = SET_ENDIAN_U32(pMetadataTblEntry->u32Reserved);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Converts a VHDX file parameters item between file and host endianness.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns nothing.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param enmConv Direction of the conversion.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pFileParamsConv Where to store the converted file parameters item entry.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pFileParams The VHDX file parameters item to convert.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @note It is safe to use the same pointer for pFileParamsConv and pFileParams.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncDECLINLINE(void) vhdxConvFileParamsEndianess(VHDXECONV enmConv, PVhdxFileParameters pFileParamsConv,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pFileParamsConv->u32BlockSize = SET_ENDIAN_U32(pFileParams->u32BlockSize);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pFileParamsConv->u32Flags = SET_ENDIAN_U32(pFileParams->u32Flags);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Converts a VHDX virtual disk size item between file and host endianness.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns nothing.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param enmConv Direction of the conversion.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pVDiskSizeConv Where to store the converted virtual disk size item entry.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pVDiskSize The VHDX virtual disk size item to convert.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @note It is safe to use the same pointer for pVDiskSizeConv and pVDiskSize.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncDECLINLINE(void) vhdxConvVDiskSizeEndianess(VHDXECONV enmConv, PVhdxVDiskSize pVDiskSizeConv,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pVDiskSizeConv->u64VDiskSize = SET_ENDIAN_U64(pVDiskSize->u64VDiskSize);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Converts a VHDX page 83 data item between file and host endianness.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns nothing.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param enmConv Direction of the conversion.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pPage83DataConv Where to store the converted page 83 data item entry.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pPage83Data The VHDX page 83 data item to convert.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @note It is safe to use the same pointer for pPage83DataConv and pPage83Data.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncDECLINLINE(void) vhdxConvPage83DataEndianess(VHDXECONV enmConv, PVhdxPage83Data pPage83DataConv,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync vhdxConvUuidEndianess(enmConv, &pPage83DataConv->UuidPage83Data, &pPage83Data->UuidPage83Data);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Converts a VHDX logical sector size item between file and host endianness.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns nothing.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param enmConv Direction of the conversion.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pVDiskLogSectSizeConv Where to store the converted logical sector size item entry.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pVDiskLogSectSize The VHDX logical sector size item to convert.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @note It is safe to use the same pointer for pVDiskLogSectSizeConv and pVDiskLogSectSize.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncDECLINLINE(void) vhdxConvVDiskLogSectSizeEndianess(VHDXECONV enmConv, PVhdxVDiskLogicalSectorSize pVDiskLogSectSizeConv,
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync pVDiskLogSectSizeConv->u32LogicalSectorSize = SET_ENDIAN_U32(pVDiskLogSectSize->u32LogicalSectorSize);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Converts a VHDX physical sector size item between file and host endianness.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns nothing.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param enmConv Direction of the conversion.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pVDiskPhysSectSizeConv Where to store the converted physical sector size item entry.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pVDiskPhysSectSize The VHDX physical sector size item to convert.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @note It is safe to use the same pointer for pVDiskPhysSectSizeConv and pVDiskPhysSectSize.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncDECLINLINE(void) vhdxConvVDiskPhysSectSizeEndianess(VHDXECONV enmConv, PVhdxVDiskPhysicalSectorSize pVDiskPhysSectSizeConv,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pVDiskPhysSectSizeConv->u64PhysicalSectorSize = SET_ENDIAN_U64(pVDiskPhysSectSize->u64PhysicalSectorSize);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Converts a VHDX parent locator header item between file and host endianness.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns nothing.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param enmConv Direction of the conversion.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pParentLocatorHdrConv Where to store the converted parent locator header item entry.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pParentLocatorHdr The VHDX parent locator header item to convert.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @note It is safe to use the same pointer for pParentLocatorHdrConv and pParentLocatorHdr.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncDECLINLINE(void) vhdxConvParentLocatorHeaderEndianness(VHDXECONV enmConv, PVhdxParentLocatorHeader pParentLocatorHdrConv,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync vhdxConvUuidEndianess(enmConv, &pParentLocatorHdrConv->UuidLocatorType, &pParentLocatorHdr->UuidLocatorType);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pParentLocatorHdrConv->u16Reserved = SET_ENDIAN_U16(pParentLocatorHdr->u16Reserved);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pParentLocatorHdrConv->u16KeyValueCount = SET_ENDIAN_U16(pParentLocatorHdr->u16KeyValueCount);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Converts a VHDX parent locator entry between file and host endianness.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns nothing.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param enmConv Direction of the conversion.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pParentLocatorEntryConv Where to store the converted parent locator entry.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pParentLocatorEntry The VHDX parent locator entry to convert.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @note It is safe to use the same pointer for pParentLocatorEntryConv and pParentLocatorEntry.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncDECLINLINE(void) vhdxConvParentLocatorEntryEndianess(VHDXECONV enmConv, PVhdxParentLocatorEntry pParentLocatorEntryConv,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pParentLocatorEntryConv->u32KeyOffset = SET_ENDIAN_U32(pParentLocatorEntry->u32KeyOffset);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pParentLocatorEntryConv->u32ValueOffset = SET_ENDIAN_U32(pParentLocatorEntry->u32ValueOffset);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pParentLocatorEntryConv->u16KeyLength = SET_ENDIAN_U16(pParentLocatorEntry->u16KeyLength);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pParentLocatorEntryConv->u16ValueLength = SET_ENDIAN_U16(pParentLocatorEntry->u16ValueLength);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Internal. Free all allocated space for representing an image except pImage,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * and optionally delete the image from disk.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxFreeImage(PVHDXIMAGE pImage, bool fDelete)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Freeing a never allocated image (e.g. because the open failed) is
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * not signalled as an error. After all nothing bad happens. */
087dde58aa358a95ec868962cb1efe670ae626davboxsync rc = vdIfIoIntFileClose(pImage->pIfIo, pImage->pStorage);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync vdIfIoIntFileDelete(pImage->pIfIo, pImage->pszFilename);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Loads all required fields from the given VHDX header.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * The header must be converted to the host endianess and validated already.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns VBox status code.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pImage Image instance data.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pHdr The header to load.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxLoadHeader(PVHDXIMAGE pImage, PVhdxHeader pHdr)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("pImage=%#p pHdr=%#p\n", pImage, pHdr));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Most fields in the header are not required because the backend implements
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * readonly access only so far.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * We just have to check that the log is empty, we have to refuse to load the
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * image otherwsie because replaying the log is not implemented.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Check that the log UUID is zero. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfError(pImage->pIfError, VERR_NOT_SUPPORTED, RT_SRC_POS,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync "VHDX: Image \'%s\' has a non empty log which is not supported",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfError(pImage->pIfError, VERR_NOT_SUPPORTED, RT_SRC_POS,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync "VHDX: Image \'%s\' uses an unsupported version (%u) of the VHDX format",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Determines the current header and loads it.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns VBox status code.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pImage Image instance data.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxFindAndLoadCurrentHeader(PVHDXIMAGE pImage)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * The VHDX format defines two headers at different offsets to provide failure
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * consistency. Only one header is current. This can be determined using the
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * sequence number and checksum fields in the header.
26f97962f40b6594246862e4d80676c0f2e2ff7dvboxsync pHdr1 = (PVhdxHeader)RTMemAllocZ(sizeof(VhdxHeader));
26f97962f40b6594246862e4d80676c0f2e2ff7dvboxsync pHdr2 = (PVhdxHeader)RTMemAllocZ(sizeof(VhdxHeader));
26f97962f40b6594246862e4d80676c0f2e2ff7dvboxsync /* Read the first header. */
26f97962f40b6594246862e4d80676c0f2e2ff7dvboxsync rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, VHDX_HEADER1_OFFSET,
26f97962f40b6594246862e4d80676c0f2e2ff7dvboxsync vhdxConvHeaderEndianess(VHDXECONV_F2H, pHdr1, pHdr1);
26f97962f40b6594246862e4d80676c0f2e2ff7dvboxsync /* Validate checksum. */
26f97962f40b6594246862e4d80676c0f2e2ff7dvboxsync /* Try to read the second header in any case (even if reading the first failed). */
26f97962f40b6594246862e4d80676c0f2e2ff7dvboxsync rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, VHDX_HEADER2_OFFSET,
26f97962f40b6594246862e4d80676c0f2e2ff7dvboxsync vhdxConvHeaderEndianess(VHDXECONV_F2H, pHdr2, pHdr2);
26f97962f40b6594246862e4d80676c0f2e2ff7dvboxsync /* Validate checksum. */
26f97962f40b6594246862e4d80676c0f2e2ff7dvboxsync /* Determine the current header. */
26f97962f40b6594246862e4d80676c0f2e2ff7dvboxsync /* Only one header is valid - use it. */
26f97962f40b6594246862e4d80676c0f2e2ff7dvboxsync rc = vhdxLoadHeader(pImage, fHdr1Valid ? pHdr1 : pHdr2);
26f97962f40b6594246862e4d80676c0f2e2ff7dvboxsync /* Crap, both headers are corrupt, refuse to load the image. */
26f97962f40b6594246862e4d80676c0f2e2ff7dvboxsync rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
26f97962f40b6594246862e4d80676c0f2e2ff7dvboxsync "VHDX: Can not load the image because both headers are corrupt");
26f97962f40b6594246862e4d80676c0f2e2ff7dvboxsync /* Both headers are valid. Use the sequence number to find the current one. */
26f97962f40b6594246862e4d80676c0f2e2ff7dvboxsync if (pHdr1->u64SequenceNumber > pHdr2->u64SequenceNumber)
26f97962f40b6594246862e4d80676c0f2e2ff7dvboxsync rc = vdIfError(pImage->pIfError, VERR_NO_MEMORY, RT_SRC_POS,
26f97962f40b6594246862e4d80676c0f2e2ff7dvboxsync "VHDX: Out of memory while allocating memory for the header");
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Loads the BAT region.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns VBox status code.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pImage Image instance data.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param offRegion Start offset of the region.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param cbRegion Size of the region.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxLoadBatRegion(PVHDXIMAGE pImage, uint64_t offRegion,
8db52e8b95b5eaf3453fb5b8db46211562780c1fvboxsync /* Calculate required values first. */
abebc94c58a78d5a80809dfb6aa4b17c1ab8fe33vboxsync uint64_t uChunkRatio64 = (RT_BIT_64(23) * pImage->cbLogicalSector) / pImage->cbBlock;
abebc94c58a78d5a80809dfb6aa4b17c1ab8fe33vboxsync uChunkRatio = (uint32_t)uChunkRatio64; Assert(uChunkRatio == uChunkRatio64);
abebc94c58a78d5a80809dfb6aa4b17c1ab8fe33vboxsync uint64_t cDataBlocks64 = pImage->cbSize / pImage->cbBlock;
abebc94c58a78d5a80809dfb6aa4b17c1ab8fe33vboxsync cDataBlocks = (uint32_t)cDataBlocks64; Assert(cDataBlocks == cDataBlocks64);
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync cBatEntries = cDataBlocks + (cDataBlocks - 1)/uChunkRatio;
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * Load the complete BAT region first, convert to host endianess and process
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * it afterwards. The SB entries can be removed because they are not needed yet.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync paBatEntries = (PVhdxBatEntry)RTMemAlloc(cbBatEntries);
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, offRegion,
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync vhdxConvBatTableEndianess(VHDXECONV_F2H, paBatEntries, paBatEntries,
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync /* Go through the table and validate it. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync for (unsigned i = 0; i < cBatEntries; i++)
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync if ( i != 0
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync && (i % uChunkRatio) == 0)
7857b80bc975196753458b1d9e00277f6ce0ff52vboxsync * Disabled the verification because there are images out there with the sector bitmap
7857b80bc975196753458b1d9e00277f6ce0ff52vboxsync * marked as present. The entry is never accessed and the image is readonly anyway,
7857b80bc975196753458b1d9e00277f6ce0ff52vboxsync * so no harm done.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync /* Sector bitmap block. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync if ( VHDX_BAT_ENTRY_GET_STATE(paBatEntries[i].u64BatEntry)
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync "VHDX: Sector bitmap block at entry %u of image \'%s\' marked as present, violation of the specification",
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync /* Payload block. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync if ( VHDX_BAT_ENTRY_GET_STATE(paBatEntries[i].u64BatEntry)
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync "VHDX: Payload block at entry %u of image \'%s\' marked as partially present, violation of the specification",
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync "VHDX: Error reading the BAT from image \'%s\'",
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync rc = vdIfError(pImage->pIfError, VERR_NO_MEMORY, RT_SRC_POS,
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync "VHDX: Out of memory allocating memory for %u BAT entries of image \'%s\'",
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync "VHDX: Mismatch between calculated number of BAT entries and region size (expected %u got %u) for image \'%s\'",
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * Load the file parameters metadata item from the file.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * @returns VBox status code.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * @param pImage Image instance data.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * @param offItem File offset where the data is stored.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * @param cbItem Size of the item in the file.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsyncstatic int vhdxLoadFileParametersMetadata(PVHDXIMAGE pImage, uint64_t offItem, size_t cbItem)
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync LogFlowFunc(("pImage=%#p offItem=%llu cbItem=%zu\n", pImage, offItem, cbItem));
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync "VHDX: File parameters item size mismatch (expected %u got %zu) in image \'%s\'",
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync sizeof(VhdxFileParameters), cbItem, pImage->pszFilename);
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, offItem,
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync vhdxConvFileParamsEndianess(VHDXECONV_F2H, &FileParameters, &FileParameters);
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync /* @todo: No support for differencing images yet. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync if (FileParameters.u32Flags & VHDX_FILE_PARAMETERS_FLAGS_HAS_PARENT)
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync rc = vdIfError(pImage->pIfError, VERR_NOT_SUPPORTED, RT_SRC_POS,
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync "VHDX: Image \'%s\' is a differencing image which is not supported yet",
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync "VHDX: Reading the file parameters metadata item from image \'%s\' failed",
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * Load the virtual disk size metadata item from the file.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * @returns VBox status code.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * @param pImage Image instance data.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * @param offItem File offset where the data is stored.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * @param cbItem Size of the item in the file.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsyncstatic int vhdxLoadVDiskSizeMetadata(PVHDXIMAGE pImage, uint64_t offItem, size_t cbItem)
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync LogFlowFunc(("pImage=%#p offItem=%llu cbItem=%zu\n", pImage, offItem, cbItem));
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync "VHDX: Virtual disk size item size mismatch (expected %u got %zu) in image \'%s\'",
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync sizeof(VhdxVDiskSize), cbItem, pImage->pszFilename);
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, offItem,
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync vhdxConvVDiskSizeEndianess(VHDXECONV_F2H, &VDiskSize, &VDiskSize);
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync "VHDX: Reading the virtual disk size metadata item from image \'%s\' failed",
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * Load the logical sector size metadata item from the file.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * @returns VBox status code.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * @param pImage Image instance data.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * @param offItem File offset where the data is stored.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * @param cbItem Size of the item in the file.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsyncstatic int vhdxLoadVDiskLogSectorSizeMetadata(PVHDXIMAGE pImage, uint64_t offItem, size_t cbItem)
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync LogFlowFunc(("pImage=%#p offItem=%llu cbItem=%zu\n", pImage, offItem, cbItem));
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync "VHDX: Virtual disk logical sector size item size mismatch (expected %u got %zu) in image \'%s\'",
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync sizeof(VhdxVDiskLogicalSectorSize), cbItem, pImage->pszFilename);
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, offItem,
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync vhdxConvVDiskLogSectSizeEndianess(VHDXECONV_F2H, &VDiskLogSectSize,
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync pImage->cbLogicalSector = VDiskLogSectSize.u32LogicalSectorSize;
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync "VHDX: Reading the virtual disk logical sector size metadata item from image \'%s\' failed",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Loads the metadata region.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns VBox status code.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pImage Image instance data.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param offRegion Start offset of the region.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param cbRegion Size of the region.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxLoadMetadataRegion(PVHDXIMAGE pImage, uint64_t offRegion,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Load the header first. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, offRegion,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync vhdxConvMetadataTblHdrEndianess(VHDXECONV_F2H, &MetadataTblHdr, &MetadataTblHdr);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Validate structure. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync if (MetadataTblHdr.u64Signature != VHDX_METADATA_TBL_HDR_SIGNATURE)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync "VHDX: Incorrect metadata table header signature for image \'%s\'",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync else if (MetadataTblHdr.u16EntryCount > VHDX_METADATA_TBL_HDR_ENTRY_COUNT_MAX)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync "VHDX: Incorrect entry count in metadata table header of image \'%s\'",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync else if (cbRegion < (MetadataTblHdr.u16EntryCount * sizeof(VhdxMetadataTblEntry) + sizeof(VhdxMetadataTblHdr)))
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync "VHDX: Metadata table of image \'%s\' exceeds region size",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync uint64_t offMetadataTblEntry = offRegion + sizeof(VhdxMetadataTblHdr);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync for (unsigned i = 0; i < MetadataTblHdr.u16EntryCount; i++)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync VHDXMETADATAITEM enmMetadataItem = VHDXMETADATAITEM_UNKNOWN;
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, offMetadataTblEntry,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync "VHDX: Reading metadata table entry from image \'%s\' failed",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync vhdxConvMetadataTblEntryEndianess(VHDXECONV_F2H, &MetadataTblEntry, &MetadataTblEntry);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Check whether the flags match the expectations. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync for (unsigned idxProp = 0; idxProp < RT_ELEMENTS(s_aVhdxMetadataItemProps); idxProp++)
7857b80bc975196753458b1d9e00277f6ce0ff52vboxsync * Check for specification violations and bail out, except
7857b80bc975196753458b1d9e00277f6ce0ff52vboxsync * for the required flag of the physical sector size metadata item.
7857b80bc975196753458b1d9e00277f6ce0ff52vboxsync * Early images had the required flag not set opposed to the specification.
7857b80bc975196753458b1d9e00277f6ce0ff52vboxsync * We don't want to brerak those images.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync if ( !!(MetadataTblEntry.u32Flags & VHDX_METADATA_TBL_ENTRY_FLAGS_IS_USER)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync "VHDX: User flag of metadata item does not meet expectations \'%s\'",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync else if ( !!(MetadataTblEntry.u32Flags & VHDX_METADATA_TBL_ENTRY_FLAGS_IS_VDISK)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync "VHDX: Virtual disk flag of metadata item does not meet expectations \'%s\'",
7857b80bc975196753458b1d9e00277f6ce0ff52vboxsync else if ( !!(MetadataTblEntry.u32Flags & VHDX_METADATA_TBL_ENTRY_FLAGS_IS_REQUIRED)
7857b80bc975196753458b1d9e00277f6ce0ff52vboxsync && (s_aVhdxMetadataItemProps[idxProp].enmMetadataItem != VHDXMETADATAITEM_PHYSICAL_SECTOR_SIZE))
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync "VHDX: Required flag of metadata item does not meet expectations \'%s\'",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync enmMetadataItem = s_aVhdxMetadataItemProps[idxProp].enmMetadataItem;
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync offMetadataItem = offRegion + MetadataTblEntry.u32Offset;
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync rc = vhdxLoadFileParametersMetadata(pImage, offMetadataItem,
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync rc = vhdxLoadVDiskSizeMetadata(pImage, offMetadataItem,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Nothing to do here for now (marked as required but
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * there is no API to pass this information to the caller)
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync rc = vhdxLoadVDiskLogSectorSizeMetadata(pImage, offMetadataItem,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Nothing to do here for now (marked as required but
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * there is no API to pass this information to the caller)
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync rc = vdIfError(pImage->pIfError, VERR_NOT_SUPPORTED, RT_SRC_POS,
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync "VHDX: Image \'%s\' is a differencing image which is not supported yet",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync if (MetadataTblEntry.u32Flags & VHDX_METADATA_TBL_ENTRY_FLAGS_IS_REQUIRED)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfError(pImage->pIfError, VERR_NOT_SUPPORTED, RT_SRC_POS,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync "VHDX: Unsupported but required metadata item in image \'%s\'",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync "VHDX: Reading the metadata table header for image \'%s\' failed",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Loads the region table and the associated regions.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @returns VBox status code.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * @param pImage Image instance data.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Load the complete region table into memory. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pbRegionTbl = (uint8_t *)RTMemTmpAlloc(VHDX_REGION_TBL_SIZE_MAX);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, VHDX_REGION_TBL_HDR_OFFSET,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Copy the region table header to a dedicated structure where we can
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * convert it to host endianess.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync memcpy(&RegionTblHdr, pbRegionTbl, sizeof(RegionTblHdr));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync vhdxConvRegionTblHdrEndianess(VHDXECONV_F2H, &RegionTblHdr, &RegionTblHdr);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Set checksum field to 0 during crc computation. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Verify the region table integrity. */
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync u32ChkSum = RTCrc32C(pbRegionTbl, VHDX_REGION_TBL_SIZE_MAX);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync if (RegionTblHdr.u32Signature != VHDX_REGION_TBL_HDR_SIGNATURE)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync "VHDX: Invalid signature for region table header of image \'%s\'",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync "VHDX: CRC32 checksum mismatch for the region table of image \'%s\' (expected %#x got %#x)",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pImage->pszFilename, RegionTblHdr.u32Checksum, u32ChkSum);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync else if (RegionTblHdr.u32EntryCount > VHDX_REGION_TBL_HDR_ENTRY_COUNT_MAX)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync "VHDX: Invalid entry count field in the region table header of image \'%s\'",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Parse the region table entries. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync PVhdxRegionTblEntry pRegTblEntry = (PVhdxRegionTblEntry)(pbRegionTbl + sizeof(VhdxRegionTblHdr));
6c963c10234349b40ca2f7511e568325ac86299evboxsync VhdxRegionTblEntry RegTblEntryBat; /* BAT region table entry. */
6c963c10234349b40ca2f7511e568325ac86299evboxsync RT_ZERO(RegTblEntryBat); /* Maybe uninitialized, gcc. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync for (unsigned i = 0; i < RegionTblHdr.u32EntryCount; i++)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync vhdxConvRegionTblEntryEndianess(VHDXECONV_F2H, pRegTblEntry, pRegTblEntry);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Check the uuid for known regions. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync if (!RTUuidCompareStr(&pRegTblEntry->UuidObject, VHDX_REGION_TBL_ENTRY_UUID_BAT))
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * Save the BAT region and process it later.
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync * It may come before the metadata region but needs the block size.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync if (pRegTblEntry->u32Flags & VHDX_REGION_TBL_ENTRY_FLAGS_IS_REQUIRED)
8db52e8b95b5eaf3453fb5b8db46211562780c1fvboxsync RegTblEntryBat.u32Length = pRegTblEntry->u32Length;
8db52e8b95b5eaf3453fb5b8db46211562780c1fvboxsync RegTblEntryBat.u64FileOffset = pRegTblEntry->u64FileOffset;
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync "VHDX: BAT region not marked as required in image \'%s\'",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync else if (!RTUuidCompareStr(&pRegTblEntry->UuidObject, VHDX_REGION_TBL_ENTRY_UUID_METADATA))
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync if (pRegTblEntry->u32Flags & VHDX_REGION_TBL_ENTRY_FLAGS_IS_REQUIRED)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vhdxLoadMetadataRegion(pImage, pRegTblEntry->u64FileOffset, pRegTblEntry->u32Length);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync "VHDX: Metadata region not marked as required in image \'%s\'",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync else if (pRegTblEntry->u32Flags & VHDX_REGION_TBL_ENTRY_FLAGS_IS_REQUIRED)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* The region is not known but marked as required, fail to load the image. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfError(pImage->pIfError, VERR_NOT_SUPPORTED, RT_SRC_POS,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync "VHDX: Unknown required region in image \'%s\'",
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync rc = vhdxLoadBatRegion(pImage, RegTblEntryBat.u64FileOffset, RegTblEntryBat.u32Length);
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync "VHDX: BAT region in image \'%s\' is missing",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync "VHDX: Reading the region table for image \'%s\' failed",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfError(pImage->pIfError, VERR_NO_MEMORY, RT_SRC_POS,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync "VHDX: Out of memory allocating memory for the region table of image \'%s\'",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Internal: Open an image, constructing all necessary data structures.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxOpenImage(PVHDXIMAGE pImage, unsigned uOpenFlags)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("pImage=%#p uOpenFlags=%#x\n", pImage, uOpenFlags));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pImage->pIfError = VDIfErrorGet(pImage->pVDIfsDisk);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync AssertPtrReturn(pImage->pIfIo, VERR_INVALID_PARAMETER);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Refuse write access, it is not implemented so far. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Open the image.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfIoIntFileOpen(pImage->pIfIo, pImage->pszFilename,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync false /* fCreate */),
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Do NOT signal an appropriate error here, as the VD layer has the
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * choice of retrying the open if it failed. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfIoIntFileGetSize(pImage->pIfIo, pImage->pStorage, &cbFile);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, VHDX_FILE_IDENTIFIER_OFFSET,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync vhdxConvFileIdentifierEndianess(VHDXECONV_F2H, &FileIdentifier,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync if (FileIdentifier.u64Signature != VHDX_FILE_IDENTIFIER_SIGNATURE)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Load the region table. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnCheckIfValid */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxCheckIfValid(const char *pszFilename, PVDINTERFACE pVDIfsDisk,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("pszFilename=\"%s\" pVDIfsDisk=%#p pVDIfsImage=%#p\n", pszFilename, pVDIfsDisk, pVDIfsImage));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync PVDINTERFACEIOINT pIfIo = VDIfIoIntGet(pVDIfsImage);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync * Open the file and read the file identifier.
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync false /* fCreate */),
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfIoIntFileGetSize(pIfIo, pStorage, &cbFile);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfIoIntFileReadSync(pIfIo, pStorage, VHDX_FILE_IDENTIFIER_OFFSET,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync vhdxConvFileIdentifierEndianess(VHDXECONV_F2H, &FileIdentifier,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync if (FileIdentifier.u64Signature != VHDX_FILE_IDENTIFIER_SIGNATURE)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnOpen */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxOpen(const char *pszFilename, unsigned uOpenFlags,
c5397a397db4649847120db7615898569cc41669vboxsync LogFlowFunc(("pszFilename=\"%s\" uOpenFlags=%#x pVDIfsDisk=%#p pVDIfsImage=%#p enmType=%u ppBackendData=%#p\n", pszFilename, uOpenFlags, pVDIfsDisk, pVDIfsImage, enmType, ppBackendData));
c5397a397db4649847120db7615898569cc41669vboxsync NOREF(enmType); /**< @todo r=klaus make use of the type info. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Check open flags. All valid flags are supported. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pImage = (PVHDXIMAGE)RTMemAllocZ(sizeof(VHDXIMAGE));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("returns %Rrc (pBackendData=%#p)\n", rc, *ppBackendData));
c5397a397db4649847120db7615898569cc41669vboxsync/** @interface_method_impl{VBOXHDDBACKEND,pfnCreate} */
c5397a397db4649847120db7615898569cc41669vboxsyncstatic DECLCALLBACK(int) vhdxCreate(const char *pszFilename, uint64_t cbSize,
c5397a397db4649847120db7615898569cc41669vboxsync PCVDGEOMETRY pPCHSGeometry, PCVDGEOMETRY pLCHSGeometry,
c5397a397db4649847120db7615898569cc41669vboxsync LogFlowFunc(("pszFilename=\"%s\" cbSize=%llu uImageFlags=%#x pszComment=\"%s\" pPCHSGeometry=%#p pLCHSGeometry=%#p Uuid=%RTuuid uOpenFlags=%#x uPercentStart=%u uPercentSpan=%u pVDIfsDisk=%#p pVDIfsImage=%#p pVDIfsOperation=%#p enmType=%u ppBackendData=%#p",
c5397a397db4649847120db7615898569cc41669vboxsync pszFilename, cbSize, uImageFlags, pszComment, pPCHSGeometry, pLCHSGeometry, pUuid, uOpenFlags, uPercentStart, uPercentSpan, pVDIfsDisk, pVDIfsImage, pVDIfsOperation, enmType, ppBackendData));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnRename */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxRename(void *pBackendData, const char *pszFilename)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("pBackendData=%#p pszFilename=%#p\n", pBackendData, pszFilename));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Check arguments. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Close the image. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Rename the file. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync rc = vdIfIoIntFileMove(pImage->pIfIo, pImage->pszFilename, pszFilename, 0);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* The move failed, try to reopen the original image. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync int rc2 = vhdxOpenImage(pImage, pImage->uOpenFlags);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Update pImage with the new information. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Open the old image with new name. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnClose */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxClose(void *pBackendData, bool fDelete)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("pBackendData=%#p fDelete=%d\n", pBackendData, fDelete));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnRead */
d7856d565919537fcfd3ea1630608ba3ed2a25bcvboxsyncstatic int vhdxRead(void *pBackendData, uint64_t uOffset, size_t cbToRead,
d7856d565919537fcfd3ea1630608ba3ed2a25bcvboxsync LogFlowFunc(("pBackendData=%#p uOffset=%llu pIoCtx=%#p cbToRead=%zu pcbActuallyRead=%#p\n",
d7856d565919537fcfd3ea1630608ba3ed2a25bcvboxsync pBackendData, uOffset, pIoCtx, cbToRead, pcbActuallyRead));
abebc94c58a78d5a80809dfb6aa4b17c1ab8fe33vboxsync uint32_t idxBat = (uint32_t)(uOffset / pImage->cbBlock); Assert(idxBat == uOffset / pImage->cbBlock);
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync idxBat += idxBat / pImage->uChunkRatio; /* Add interleaving sector bitmap entries. */
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync cbToRead = RT_MIN(cbToRead, pImage->cbBlock - offRead);
d7856d565919537fcfd3ea1630608ba3ed2a25bcvboxsync vdIfIoIntIoCtxSet(pImage->pIfIo, pIoCtx, 0, cbToRead);
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync uint64_t offFile = VHDX_BAT_ENTRY_GET_FILE_OFFSET(uBatEntry) + offRead;
d7856d565919537fcfd3ea1630608ba3ed2a25bcvboxsync rc = vdIfIoIntFileReadUser(pImage->pIfIo, pImage->pStorage, offFile,
2edc42391ae11e0b7e58fe8a538cc7053dda7a34vboxsync case VHDX_BAT_ENTRY_PAYLOAD_BLOCK_PARTIALLY_PRESENT:
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnWrite */
d7856d565919537fcfd3ea1630608ba3ed2a25bcvboxsyncstatic int vhdxWrite(void *pBackendData, uint64_t uOffset, size_t cbToWrite,
d7856d565919537fcfd3ea1630608ba3ed2a25bcvboxsync PVDIOCTX pIoCtx, size_t *pcbWriteProcess, size_t *pcbPreRead,
d7856d565919537fcfd3ea1630608ba3ed2a25bcvboxsync LogFlowFunc(("pBackendData=%#p uOffset=%llu pIoCtx=%#p cbToWrite=%zu pcbWriteProcess=%#p pcbPreRead=%#p pcbPostRead=%#p\n",
d7856d565919537fcfd3ea1630608ba3ed2a25bcvboxsync pBackendData, uOffset, pIoCtx, cbToWrite, pcbWriteProcess, pcbPreRead, pcbPostRead));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnFlush */
d7856d565919537fcfd3ea1630608ba3ed2a25bcvboxsyncstatic int vhdxFlush(void *pBackendData, PVDIOCTX pIoCtx)
d7856d565919537fcfd3ea1630608ba3ed2a25bcvboxsync LogFlowFunc(("pBackendData=%#p pIoCtx=%#p\n", pBackendData, pIoCtx));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnGetVersion */
35f5e9bef11abdf4f242ba8140229704fa063a0avboxsync/** @copydoc VBOXHDDBACKEND::pfnGetSectorSize */
35f5e9bef11abdf4f242ba8140229704fa063a0avboxsyncstatic uint32_t vhdxGetSectorSize(void *pBackendData)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnGetSize */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnGetFileSize */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync int rc = vdIfIoIntFileGetSize(pImage->pIfIo, pImage->pStorage, &cbFile);
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnGetPCHSGeometry */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p\n", pBackendData, pPCHSGeometry));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("returns %Rrc (PCHS=%u/%u/%u)\n", rc, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnSetPCHSGeometry */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p PCHS=%u/%u/%u\n", pBackendData, pPCHSGeometry, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnGetLCHSGeometry */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p\n", pBackendData, pLCHSGeometry));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("returns %Rrc (LCHS=%u/%u/%u)\n", rc, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnSetLCHSGeometry */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p LCHS=%u/%u/%u\n", pBackendData, pLCHSGeometry, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnGetImageFlags */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic unsigned vhdxGetImageFlags(void *pBackendData)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnGetOpenFlags */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic unsigned vhdxGetOpenFlags(void *pBackendData)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnSetOpenFlags */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxSetOpenFlags(void *pBackendData, unsigned uOpenFlags)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("pBackendData=%#p\n uOpenFlags=%#x", pBackendData, uOpenFlags));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Image must be opened and the new flags must be valid. */
6a084dcaae277db9310cbba28991235f49594389vboxsync if (!pImage || (uOpenFlags & ~(VD_OPEN_FLAGS_READONLY | VD_OPEN_FLAGS_INFO | VD_OPEN_FLAGS_SKIP_CONSISTENCY_CHECKS)))
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* Implement this operation via reopening the image. */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnGetComment */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxGetComment(void *pBackendData, char *pszComment,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("pBackendData=%#p pszComment=%#p cbComment=%zu\n", pBackendData, pszComment, cbComment));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("returns %Rrc comment='%s'\n", rc, pszComment));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnSetComment */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxSetComment(void *pBackendData, const char *pszComment)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("pBackendData=%#p pszComment=\"%s\"\n", pBackendData, pszComment));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnGetUuid */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxGetUuid(void *pBackendData, PRTUUID pUuid)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnSetUuid */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxSetUuid(void *pBackendData, PCRTUUID pUuid)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnGetModificationUuid */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxGetModificationUuid(void *pBackendData, PRTUUID pUuid)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnSetModificationUuid */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxSetModificationUuid(void *pBackendData, PCRTUUID pUuid)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnGetParentUuid */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxGetParentUuid(void *pBackendData, PRTUUID pUuid)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnSetParentUuid */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxSetParentUuid(void *pBackendData, PCRTUUID pUuid)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnGetParentModificationUuid */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxGetParentModificationUuid(void *pBackendData, PRTUUID pUuid)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnSetParentModificationUuid */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsyncstatic int vhdxSetParentModificationUuid(void *pBackendData, PCRTUUID pUuid)
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync/** @copydoc VBOXHDDBACKEND::pfnDump */
abebc94c58a78d5a80809dfb6aa4b17c1ab8fe33vboxsync vdIfErrorMessage(pImage->pIfError, "Header: Geometry PCHS=%u/%u/%u LCHS=%u/%u/%u cbSector=%u\n",
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pImage->PCHSGeometry.cCylinders, pImage->PCHSGeometry.cHeads, pImage->PCHSGeometry.cSectors,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync pImage->LCHSGeometry.cCylinders, pImage->LCHSGeometry.cHeads, pImage->LCHSGeometry.cSectors,
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pszBackendName */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* cbSize */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* uBackendCaps */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* paFileExtensions */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* paConfigInfo */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnCheckIfValid */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnOpen */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnCreate */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnRename */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnClose */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnRead */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnWrite */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnFlush */
d7856d565919537fcfd3ea1630608ba3ed2a25bcvboxsync /* pfnDiscard */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnGetVersion */
35f5e9bef11abdf4f242ba8140229704fa063a0avboxsync /* pfnGetSectorSize */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnGetSize */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnGetFileSize */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnGetPCHSGeometry */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnSetPCHSGeometry */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnGetLCHSGeometry */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnSetLCHSGeometry */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnGetImageFlags */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnGetOpenFlags */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnSetOpenFlags */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnGetComment */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnSetComment */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnGetUuid */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnSetUuid */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnGetModificationUuid */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnSetModificationUuid */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnGetParentUuid */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnSetParentUuid */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnGetParentModificationUuid */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnSetParentModificationUuid */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnDump */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnGetTimeStamp */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnGetParentTimeStamp */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnSetParentTimeStamp */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnGetParentFilename */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnSetParentFilename */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnComposeLocation */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnComposeName */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnCompact */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnResize */
7ce0e5475f7c2c9e35ab188330bb58e3490972d6vboxsync /* pfnRepair */
5af981fb39925101cec5e22afb746e2125b55ce4vboxsync /* pfnTraverseMetadata */