e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * IPRT Disk Volume Management API (DVM).
c7814cf6e1240a519cbec0441e033d0e2470ed00vboxsync * Copyright (C) 2011-2012 Oracle Corporation
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * available from http://www.virtualbox.org. This file is free software;
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * you can redistribute it and/or modify it under the terms of the GNU
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * General Public License (GPL) as published by the Free Software
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * The contents of this file may alternatively be used under the terms
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * of the Common Development and Distribution License Version 1.0
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * VirtualBox OSE distribution, in which case the provisions of the
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * CDDL are applicable instead of those of the GPL.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * You may elect to license modified versions of this file under the
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * terms and conditions of either the GPL or the CDDL or both.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync/** @defgroup grp_dvm IPRT Disk Volume Management
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Volume type.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Comparable to the FS type in MBR partition maps
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * or the partition type GUIDs in GPT tables.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync /** Invalid. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync /** Unknown. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync /** Volume hosts a NTFS filesystem. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync /** Volume hosts a FAT16 filesystem. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync /** Volume hosts a FAT32 filesystem. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync /** Volume hosts a Linux swap. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync /** Volume hosts a Linux filesystem. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync /** Volume hosts a Linux LVM. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync /** Volume hosts a Linux SoftRaid. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync /** Volume hosts a FreeBSD disklabel. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync /** Volume hosts a NetBSD disklabel. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync /** Volume hosts a OpenBSD disklabel. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync /** Volume hosts a Mac OS X HFS or HFS+ filesystem. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync /** Volume hosts a Solaris volume. */
68fb2428898c55a7172e6a75a0a8d7ce259919bdvboxsync /** End of the valid values. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync /** Usual 32bit hack. */
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync/** @defgroup grp_dvm_flags Flags used by RTDvmCreate.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync/** DVM flags - Blocks are always marked as unused if the volume has
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * no block status callback set.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * The default is to mark them as used. */
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync#define DVM_FLAGS_NO_STATUS_CALLBACK_MARK_AS_UNUSED RT_BIT_32(0)
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync/** DVM flags - Space which is unused in the map will be marked as used
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * when calling RTDvmMapQueryBlockStatus(). */
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync#define DVM_FLAGS_UNUSED_SPACE_MARK_AS_USED RT_BIT_32(1)
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync/** Mask of all valid flags. */
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync#define DVM_FLAGS_MASK (DVM_FLAGS_NO_STATUS_CALLBACK_MARK_AS_UNUSED | DVM_FLAGS_UNUSED_SPACE_MARK_AS_USED)
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync/** @defgroup grp_dvm_vol_flags Volume flags used by DVMVolumeGetFlags.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync/** Volume flags - Volume is bootable. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync/** Volume flags - Volume is active. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync/** A handle to a volume manager. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync/** A pointer to a volume manager handle. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync/** NIL volume manager handle. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync/** A handle to a volume in a volume map. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync/** A pointer to a volume handle. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync/** NIL volume handle. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Callback to read data from the underlying medium.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @returns IPRT status code.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param pvUser Opaque user data passed on creation.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param off Offset to start reading from.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param pvBuf Where to store the read data.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param cbRead How many bytes to read.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsynctypedef DECLCALLBACK(int) FNDVMREAD(void *pvUser, uint64_t off, void *pvBuf, size_t cbRead);
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync/** Pointer to a read callback. */
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Callback to write data to the underlying medium.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @returns IPRT status code.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param pvUser Opaque user data passed on creation.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param off Offset to start writing to.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param pvBuf The data to write.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param cbRead How many bytes to write.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsynctypedef DECLCALLBACK(int) FNDVMWRITE(void *pvUser, uint64_t off, const void *pvBuf, size_t cbWrite);
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync/** Pointer to a read callback. */
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * Callback for querying the block allocation status of a volume.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * @returns IPRT status code.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * @param pvUser Opaque user data passed when setting the callback.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * @param off Offset relative to the start of the volume.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * @param cb Range to check in bytes.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * @param pfAllocated Where to store the allocation status on success.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsynctypedef DECLCALLBACK(int) FNDVMVOLUMEQUERYBLOCKSTATUS(void *pvUser, uint64_t off,
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync/** Pointer to a query block allocation status callback. */
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsynctypedef FNDVMVOLUMEQUERYBLOCKSTATUS *PFNDVMVOLUMEQUERYBLOCKSTATUS;
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Create a new volume manager.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @returns IPRT status.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param phVolMgr Where to store the handle to the volume manager on
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param pfnRead Read callback for the underlying
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param pfnWrite Write callback for the underlying
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param cbDisk Size of the underlying disk in bytes.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param cbSector Size of one sector in bytes.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * @param fFlags Combination of RTDVM_FLAGS_*
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param pvUser Opaque user data passed to the callbacks.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsyncRTDECL(int) RTDvmCreate(PRTDVM phVolMgr, PFNDVMREAD pfnRead,
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Retain a given volume manager.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @returns New reference count on success, UINT32_MAX on failure.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param hVolMgr The volume manager to retain.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Releases a given volume manager.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @returns New reference count on success (0 if closed), UINT32_MAX on failure.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param hVolMgr The volume manager to release.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Probes the underyling disk for the best volume manager format handler
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * and opens it.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @returns IPRT status code.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @retval VERR_NOT_FOUND if no backend can handle the volume map on the disk.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param hVolMgr The volume manager handle.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Initializes a new volume map using the given format handler.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @returns IPRT status code.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param hVolMgr The volume manager handle.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param pszFmt The format to use for the new map.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsyncRTDECL(int) RTDvmMapInitialize(RTDVM hVolMgr, const char *pszFmt);
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Gets the currently used format of the disk map.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @returns Name of the format.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param hVolMgr The volume manager handle.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsyncRTDECL(const char *) RTDvmMapGetFormat(RTDVM hVolMgr);
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Gets the number of valid partitions in the map.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @returns The number of valid volumes in the map or UINT32_MAX on failure.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param hVolMgr The volume manager handle.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsyncRTDECL(uint32_t) RTDvmMapGetValidVolumes(RTDVM hVolMgr);
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Gets the maximum number of partitions the map can hold.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @returns The maximum number of volumes in the map or UINT32_MAX on failure.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param hVolMgr The volume manager handle.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsyncRTDECL(uint32_t) RTDvmMapGetMaxVolumes(RTDVM hVolMgr);
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Get the first valid volume from a map.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @returns IPRT status code.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param hVolMgr The volume manager handle.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param phVol Where to store the handle to the first volume on
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * success. Release with RTDvmVolumeRelease().
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsyncRTDECL(int) RTDvmMapQueryFirstVolume(RTDVM hVolMgr, PRTDVMVOLUME phVol);
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Get the first valid volume from a map.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @returns IPRT status code.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param hVolMgr The volume manager handle.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param hVol Handle of the current volume.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param phVolNext Where to store the handle to the next volume on
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * success. Release with RTDvmVolumeRelease().
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsyncRTDECL(int) RTDvmMapQueryNextVolume(RTDVM hVolMgr, RTDVMVOLUME hVol, PRTDVMVOLUME phVolNext);
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * Returns whether the given block on the disk is in use.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * @returns IPRT status code.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * @param hVolMgr The volume manager handler.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * @param off The start offset to check for.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * @param cb The range in bytes to check.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * @param pfAllocated Where to store the status on success.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * @remark This method will return true even if a part of the range is not in use.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsyncRTDECL(int) RTDvmMapQueryBlockStatus(RTDVM hVolMgr, uint64_t off, uint64_t cb,
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Retains a valid volume handle.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @returns New reference count on success, UINT32_MAX on failure.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param hVol The volume to retain.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsyncRTDECL(uint32_t) RTDvmVolumeRetain(RTDVMVOLUME hVol);
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Releases a valid volume handle.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @returns New reference count on success (0 if closed), UINT32_MAX on failure.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param hVol The volume to release.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsyncRTDECL(uint32_t) RTDvmVolumeRelease(RTDVMVOLUME hVol);
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * Sets the callback to query the block allocation status for a volume.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * This overwrites any other callback set previously.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * @returns nothing.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * @param hVol The volume handle.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * @param pfnQueryBlockStatus The callback to set. Can be NULL to disable
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * a previous callback.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsync * @param pvUser Opaque user data passed in the callback.
2a0a20dee7f474c26cc8f6f9d7aa12c345c2b73bvboxsyncRTDECL(void) RTDvmVolumeSetQueryBlockStatusCallback(RTDVMVOLUME hVol,
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Get the size of a volume in bytes.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @returns Size of the volume in bytes or 0 on failure.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param hVol The volume handle.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsyncRTDECL(uint64_t) RTDvmVolumeGetSize(RTDVMVOLUME hVol);
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Gets the name of the volume if supported.
1f96defca77af991e72fed46159433af9ae6b73evboxsync * @returns IPRT status code.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param hVol The volume handle.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param ppszVolName Where to store the name of the volume on success.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * The string must be freed with RTStrFree().
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsyncRTDECL(int) RTDvmVolumeQueryName(RTDVMVOLUME hVol, char **ppszVolName);
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Get the volume type of the volume if supported.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @returns The volume type on success, DVMVOLTYPE_INVALID if hVol is invalid.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param hVol The volume handle.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsyncRTDECL(RTDVMVOLTYPE) RTDvmVolumeGetType(RTDVMVOLUME hVol);
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Get the volume flags of the volume if supported.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @returns The volume flags or UINT64_MAX on failure.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param hVol The volume handle.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsyncRTDECL(uint64_t) RTDvmVolumeGetFlags(RTDVMVOLUME hVol);
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Reads data from the given volume.
1f96defca77af991e72fed46159433af9ae6b73evboxsync * @returns IPRT status code.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param hVol The volume handle.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param off Where to start reading from - 0 is the beginning of
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * the volume.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param pvBuf Where to store the read data.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param cbRead How many bytes to read.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsyncRTDECL(int) RTDvmVolumeRead(RTDVMVOLUME hVol, uint64_t off, void *pvBuf, size_t cbRead);
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Writes data to the given volume.
1f96defca77af991e72fed46159433af9ae6b73evboxsync * @returns IPRT status code.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param hVol The volume handle.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param off Where to start writing to - 0 is the beginning of
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * the volume.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param pvBuf The data to write.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param cbWrite How many bytes to write.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsyncRTDECL(int) RTDvmVolumeWrite(RTDVMVOLUME hVol, uint64_t off, const void *pvBuf, size_t cbWrite);
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * Returns the description of a given volume type.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @returns The description of the type.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsync * @param enmVolType The volume type.
e52b0dfe3d9ead70e24f2ce4ed3faa6c79c00618vboxsyncRTDECL(const char *) RTDvmVolumeTypeGetDescr(RTDVMVOLTYPE enmVolType);
1f96defca77af991e72fed46159433af9ae6b73evboxsync * Creates an VFS file from a volume handle.
1f96defca77af991e72fed46159433af9ae6b73evboxsync * @returns IPRT status code.
1f96defca77af991e72fed46159433af9ae6b73evboxsync * @param hVol The volume handle.
1f96defca77af991e72fed46159433af9ae6b73evboxsync * @param phVfsFileOut Where to store the VFS file handle on success.