1 | /** @file
|
---|
2 | * VBox HDD Container API.
|
---|
3 | */
|
---|
4 |
|
---|
5 | /*
|
---|
6 | * Copyright (C) 2006-2010 Oracle Corporation
|
---|
7 | *
|
---|
8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
9 | * available from http://www.virtualbox.org. This file is free software;
|
---|
10 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
11 | * General Public License (GPL) as published by the Free Software
|
---|
12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
15 | *
|
---|
16 | * The contents of this file may alternatively be used under the terms
|
---|
17 | * of the Common Development and Distribution License Version 1.0
|
---|
18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
---|
19 | * VirtualBox OSE distribution, in which case the provisions of the
|
---|
20 | * CDDL are applicable instead of those of the GPL.
|
---|
21 | *
|
---|
22 | * You may elect to license modified versions of this file under the
|
---|
23 | * terms and conditions of either the GPL or the CDDL or both.
|
---|
24 | */
|
---|
25 |
|
---|
26 | #ifndef ___VBox_VD_h
|
---|
27 | #define ___VBox_VD_h
|
---|
28 |
|
---|
29 | #include <iprt/assert.h>
|
---|
30 | #include <iprt/string.h>
|
---|
31 | #include <iprt/mem.h>
|
---|
32 | #include <iprt/file.h>
|
---|
33 | #include <iprt/net.h>
|
---|
34 | #include <iprt/sg.h>
|
---|
35 | #include <VBox/cdefs.h>
|
---|
36 | #include <VBox/types.h>
|
---|
37 | #include <VBox/err.h>
|
---|
38 |
|
---|
39 | RT_C_DECLS_BEGIN
|
---|
40 |
|
---|
41 | #ifdef IN_RING0
|
---|
42 | # error "There are no VBox HDD Container APIs available in Ring-0 Host Context!"
|
---|
43 | #endif
|
---|
44 |
|
---|
45 | /** @defgroup grp_vd VBox HDD Container
|
---|
46 | * @{
|
---|
47 | */
|
---|
48 |
|
---|
49 | /** Current VMDK image version. */
|
---|
50 | #define VMDK_IMAGE_VERSION (0x0001)
|
---|
51 |
|
---|
52 | /** Current VDI image major version. */
|
---|
53 | #define VDI_IMAGE_VERSION_MAJOR (0x0001)
|
---|
54 | /** Current VDI image minor version. */
|
---|
55 | #define VDI_IMAGE_VERSION_MINOR (0x0001)
|
---|
56 | /** Current VDI image version. */
|
---|
57 | #define VDI_IMAGE_VERSION ((VDI_IMAGE_VERSION_MAJOR << 16) | VDI_IMAGE_VERSION_MINOR)
|
---|
58 |
|
---|
59 | /** Get VDI major version from combined version. */
|
---|
60 | #define VDI_GET_VERSION_MAJOR(uVer) ((uVer) >> 16)
|
---|
61 | /** Get VDI minor version from combined version. */
|
---|
62 | #define VDI_GET_VERSION_MINOR(uVer) ((uVer) & 0xffff)
|
---|
63 |
|
---|
64 | /** Placeholder for specifying the last opened image. */
|
---|
65 | #define VD_LAST_IMAGE 0xffffffffU
|
---|
66 |
|
---|
67 | /** @name VBox HDD container image flags
|
---|
68 | * @{
|
---|
69 | */
|
---|
70 | /** No flags. */
|
---|
71 | #define VD_IMAGE_FLAGS_NONE (0)
|
---|
72 | /** Fixed image. */
|
---|
73 | #define VD_IMAGE_FLAGS_FIXED (0x10000)
|
---|
74 | /** Diff image. Mutually exclusive with fixed image. */
|
---|
75 | #define VD_IMAGE_FLAGS_DIFF (0x20000)
|
---|
76 | /** VMDK: Split image into 2GB extents. */
|
---|
77 | #define VD_VMDK_IMAGE_FLAGS_SPLIT_2G (0x0001)
|
---|
78 | /** VMDK: Raw disk image (giving access to a number of host partitions). */
|
---|
79 | #define VD_VMDK_IMAGE_FLAGS_RAWDISK (0x0002)
|
---|
80 | /** VMDK: stream optimized image, read only. */
|
---|
81 | #define VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED (0x0004)
|
---|
82 | /** VMDK: ESX variant, use in addition to other flags. */
|
---|
83 | #define VD_VMDK_IMAGE_FLAGS_ESX (0x0008)
|
---|
84 | /** VDI: Fill new blocks with zeroes while expanding image file. Only valid
|
---|
85 | * for newly created images, never set for opened existing images. */
|
---|
86 | #define VD_VDI_IMAGE_FLAGS_ZERO_EXPAND (0x0100)
|
---|
87 |
|
---|
88 | /** Mask of valid image flags for VMDK. */
|
---|
89 | #define VD_VMDK_IMAGE_FLAGS_MASK ( VD_IMAGE_FLAGS_FIXED | VD_IMAGE_FLAGS_DIFF | VD_IMAGE_FLAGS_NONE \
|
---|
90 | | VD_VMDK_IMAGE_FLAGS_SPLIT_2G | VD_VMDK_IMAGE_FLAGS_RAWDISK \
|
---|
91 | | VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED | VD_VMDK_IMAGE_FLAGS_ESX)
|
---|
92 |
|
---|
93 | /** Mask of valid image flags for VDI. */
|
---|
94 | #define VD_VDI_IMAGE_FLAGS_MASK (VD_IMAGE_FLAGS_FIXED | VD_IMAGE_FLAGS_DIFF | VD_IMAGE_FLAGS_NONE | VD_VDI_IMAGE_FLAGS_ZERO_EXPAND)
|
---|
95 |
|
---|
96 | /** Mask of all valid image flags for all formats. */
|
---|
97 | #define VD_IMAGE_FLAGS_MASK (VD_VMDK_IMAGE_FLAGS_MASK | VD_VDI_IMAGE_FLAGS_MASK)
|
---|
98 |
|
---|
99 | /** Default image flags. */
|
---|
100 | #define VD_IMAGE_FLAGS_DEFAULT (VD_IMAGE_FLAGS_NONE)
|
---|
101 | /** @} */
|
---|
102 |
|
---|
103 |
|
---|
104 | /**
|
---|
105 | * Auxiliary type for describing partitions on raw disks. The entries must be
|
---|
106 | * in ascending order (as far as uStart is concerned), and must not overlap.
|
---|
107 | * Note that this does not correspond 1:1 to partitions, it is describing the
|
---|
108 | * general meaning of contiguous areas on the disk.
|
---|
109 | */
|
---|
110 | typedef struct VBOXHDDRAWPARTDESC
|
---|
111 | {
|
---|
112 | /** Device to use for this partition/data area. Can be the disk device if
|
---|
113 | * the offset field is set appropriately. If this is NULL, then this
|
---|
114 | * partition will not be accessible to the guest. The size of the data area
|
---|
115 | * must still be set correctly. */
|
---|
116 | const char *pszRawDevice;
|
---|
117 | /** Pointer to the partitioning info. NULL means this is a regular data
|
---|
118 | * area on disk, non-NULL denotes data which should be copied to the
|
---|
119 | * partition data overlay. */
|
---|
120 | const void *pvPartitionData;
|
---|
121 | /** Offset where the data starts in this device. */
|
---|
122 | uint64_t uStartOffset;
|
---|
123 | /** Offset where the data starts in the disk. */
|
---|
124 | uint64_t uStart;
|
---|
125 | /** Size of the data area. */
|
---|
126 | uint64_t cbData;
|
---|
127 | } VBOXHDDRAWPARTDESC, *PVBOXHDDRAWPARTDESC;
|
---|
128 |
|
---|
129 | /**
|
---|
130 | * Auxiliary data structure for creating raw disks.
|
---|
131 | */
|
---|
132 | typedef struct VBOXHDDRAW
|
---|
133 | {
|
---|
134 | /** Signature for structure. Must be 'R', 'A', 'W', '\\0'. Actually a trick
|
---|
135 | * to make logging of the comment string produce sensible results. */
|
---|
136 | char szSignature[4];
|
---|
137 | /** Flag whether access to full disk should be given (ignoring the
|
---|
138 | * partition information below). */
|
---|
139 | bool fRawDisk;
|
---|
140 | /** Filename for the raw disk. Ignored for partitioned raw disks.
|
---|
141 | * For Linux e.g. /dev/sda, and for Windows e.g. \\\\.\\PhysicalDisk0. */
|
---|
142 | const char *pszRawDisk;
|
---|
143 | /** Number of entries in the partition descriptor array. */
|
---|
144 | unsigned cPartDescs;
|
---|
145 | /** Pointer to the partition descriptor array. */
|
---|
146 | PVBOXHDDRAWPARTDESC pPartDescs;
|
---|
147 | } VBOXHDDRAW, *PVBOXHDDRAW;
|
---|
148 |
|
---|
149 | /** @name VBox HDD container image open mode flags
|
---|
150 | * @{
|
---|
151 | */
|
---|
152 | /** Try to open image in read/write exclusive access mode if possible, or in read-only elsewhere. */
|
---|
153 | #define VD_OPEN_FLAGS_NORMAL 0
|
---|
154 | /** Open image in read-only mode with sharing access with others. */
|
---|
155 | #define VD_OPEN_FLAGS_READONLY RT_BIT(0)
|
---|
156 | /** Honor zero block writes instead of ignoring them whenever possible.
|
---|
157 | * This is not supported by all formats. It is silently ignored in this case. */
|
---|
158 | #define VD_OPEN_FLAGS_HONOR_ZEROES RT_BIT(1)
|
---|
159 | /** Honor writes of the same data instead of ignoring whenever possible.
|
---|
160 | * This is handled generically, and is only meaningful for differential image
|
---|
161 | * formats. It is silently ignored otherwise. */
|
---|
162 | #define VD_OPEN_FLAGS_HONOR_SAME RT_BIT(2)
|
---|
163 | /** Do not perform the base/diff image check on open. This does NOT imply
|
---|
164 | * opening the image as readonly (would break e.g. adding UUIDs to VMDK files
|
---|
165 | * created by other products). Images opened with this flag should only be
|
---|
166 | * used for querying information, and nothing else. */
|
---|
167 | #define VD_OPEN_FLAGS_INFO RT_BIT(3)
|
---|
168 | /** Open image for asynchronous access. Only available if VD_CAP_ASYNC_IO is
|
---|
169 | * set. VDOpen fails with VERR_NOT_SUPPORTED if this operation is not supported for
|
---|
170 | * this kind of image. */
|
---|
171 | #define VD_OPEN_FLAGS_ASYNC_IO RT_BIT(4)
|
---|
172 | /** Allow sharing of the image for writable images. May be ignored if the
|
---|
173 | * format backend doesn't support this type of concurrent access. */
|
---|
174 | #define VD_OPEN_FLAGS_SHAREABLE RT_BIT(5)
|
---|
175 | /** Ask the backend to switch to sequential accesses if possible. Opening
|
---|
176 | * will not fail if it cannot do this, the flag will be simply ignored. */
|
---|
177 | #define VD_OPEN_FLAGS_SEQUENTIAL RT_BIT(6)
|
---|
178 | /** Mask of valid flags. */
|
---|
179 | #define VD_OPEN_FLAGS_MASK (VD_OPEN_FLAGS_NORMAL | VD_OPEN_FLAGS_READONLY | VD_OPEN_FLAGS_HONOR_ZEROES | VD_OPEN_FLAGS_HONOR_SAME | VD_OPEN_FLAGS_INFO | VD_OPEN_FLAGS_ASYNC_IO | VD_OPEN_FLAGS_SHAREABLE | VD_OPEN_FLAGS_SEQUENTIAL)
|
---|
180 | /** @}*/
|
---|
181 |
|
---|
182 | /**
|
---|
183 | * Helper functions to handle open flags.
|
---|
184 | */
|
---|
185 |
|
---|
186 | /**
|
---|
187 | * Translate VD_OPEN_FLAGS_* to RTFile open flags.
|
---|
188 | *
|
---|
189 | * @return RTFile open flags.
|
---|
190 | * @param uOpenFlags VD_OPEN_FLAGS_* open flags.
|
---|
191 | * @param fCreate Flag that the file should be created.
|
---|
192 | */
|
---|
193 | DECLINLINE(uint32_t) VDOpenFlagsToFileOpenFlags(unsigned uOpenFlags, bool fCreate)
|
---|
194 | {
|
---|
195 | AssertMsg(!((uOpenFlags & VD_OPEN_FLAGS_READONLY) && fCreate), ("Image can't be opened readonly while being created\n"));
|
---|
196 |
|
---|
197 | uint32_t fOpen = 0;
|
---|
198 |
|
---|
199 | if (RT_UNLIKELY(uOpenFlags & VD_OPEN_FLAGS_READONLY))
|
---|
200 | fOpen |= RTFILE_O_READ | RTFILE_O_DENY_NONE;
|
---|
201 | else
|
---|
202 | {
|
---|
203 | fOpen |= RTFILE_O_READWRITE;
|
---|
204 |
|
---|
205 | if (RT_UNLIKELY(uOpenFlags & VD_OPEN_FLAGS_SHAREABLE))
|
---|
206 | fOpen |= RTFILE_O_DENY_NONE;
|
---|
207 | else
|
---|
208 | fOpen |= RTFILE_O_DENY_WRITE;
|
---|
209 | }
|
---|
210 |
|
---|
211 | if (RT_UNLIKELY(fCreate))
|
---|
212 | fOpen |= RTFILE_O_CREATE | RTFILE_O_NOT_CONTENT_INDEXED;
|
---|
213 | else
|
---|
214 | fOpen |= RTFILE_O_OPEN;
|
---|
215 |
|
---|
216 | return fOpen;
|
---|
217 | }
|
---|
218 |
|
---|
219 |
|
---|
220 | /** @name VBox HDD container backend capability flags
|
---|
221 | * @{
|
---|
222 | */
|
---|
223 | /** Supports UUIDs as expected by VirtualBox code. */
|
---|
224 | #define VD_CAP_UUID RT_BIT(0)
|
---|
225 | /** Supports creating fixed size images, allocating all space instantly. */
|
---|
226 | #define VD_CAP_CREATE_FIXED RT_BIT(1)
|
---|
227 | /** Supports creating dynamically growing images, allocating space on demand. */
|
---|
228 | #define VD_CAP_CREATE_DYNAMIC RT_BIT(2)
|
---|
229 | /** Supports creating images split in chunks of a bit less than 2GBytes. */
|
---|
230 | #define VD_CAP_CREATE_SPLIT_2G RT_BIT(3)
|
---|
231 | /** Supports being used as differencing image format backend. */
|
---|
232 | #define VD_CAP_DIFF RT_BIT(4)
|
---|
233 | /** Supports asynchronous I/O operations for at least some configurations. */
|
---|
234 | #define VD_CAP_ASYNC RT_BIT(5)
|
---|
235 | /** The backend operates on files. The caller needs to know to handle the
|
---|
236 | * location appropriately. */
|
---|
237 | #define VD_CAP_FILE RT_BIT(6)
|
---|
238 | /** The backend uses the config interface. The caller needs to know how to
|
---|
239 | * provide the mandatory configuration parts this way. */
|
---|
240 | #define VD_CAP_CONFIG RT_BIT(7)
|
---|
241 | /** The backend uses the network stack interface. The caller has to provide
|
---|
242 | * the appropriate interface. */
|
---|
243 | #define VD_CAP_TCPNET RT_BIT(8)
|
---|
244 | /** The backend supports VFS (virtual filesystem) functionality since it uses
|
---|
245 | * VDINTERFACEIO exclusively for all file operations. */
|
---|
246 | #define VD_CAP_VFS RT_BIT(9)
|
---|
247 | /** @}*/
|
---|
248 |
|
---|
249 | /** @name VBox HDD container type.
|
---|
250 | * @{
|
---|
251 | */
|
---|
252 | typedef enum VDTYPE
|
---|
253 | {
|
---|
254 | /** Invalid. */
|
---|
255 | VDTYPE_INVALID = 0,
|
---|
256 | /** HardDisk */
|
---|
257 | VDTYPE_HDD,
|
---|
258 | /** CD/DVD */
|
---|
259 | VDTYPE_DVD,
|
---|
260 | /** Floppy. */
|
---|
261 | VDTYPE_FLOPPY
|
---|
262 | } VDTYPE;
|
---|
263 | /** @}*/
|
---|
264 |
|
---|
265 | /**
|
---|
266 | * Supported interface types.
|
---|
267 | */
|
---|
268 | typedef enum VDINTERFACETYPE
|
---|
269 | {
|
---|
270 | /** First valid interface. */
|
---|
271 | VDINTERFACETYPE_FIRST = 0,
|
---|
272 | /** Interface to pass error message to upper layers. Per-disk. */
|
---|
273 | VDINTERFACETYPE_ERROR = VDINTERFACETYPE_FIRST,
|
---|
274 | /** Interface for I/O operations. Per-image. */
|
---|
275 | VDINTERFACETYPE_IO,
|
---|
276 | /** Interface for progress notification. Per-operation. */
|
---|
277 | VDINTERFACETYPE_PROGRESS,
|
---|
278 | /** Interface for configuration information. Per-image. */
|
---|
279 | VDINTERFACETYPE_CONFIG,
|
---|
280 | /** Interface for TCP network stack. Per-image. */
|
---|
281 | VDINTERFACETYPE_TCPNET,
|
---|
282 | /** Interface for getting parent image state. Per-operation. */
|
---|
283 | VDINTERFACETYPE_PARENTSTATE,
|
---|
284 | /** Interface for synchronizing accesses from several threads. Per-disk. */
|
---|
285 | VDINTERFACETYPE_THREADSYNC,
|
---|
286 | /** Interface for I/O between the generic VBoxHDD code and the backend. Per-image (internal).
|
---|
287 | * This interface is completely internal and must not be used elsewhere. */
|
---|
288 | VDINTERFACETYPE_IOINT,
|
---|
289 | /** invalid interface. */
|
---|
290 | VDINTERFACETYPE_INVALID
|
---|
291 | } VDINTERFACETYPE;
|
---|
292 |
|
---|
293 | /**
|
---|
294 | * Common structure for all interfaces.
|
---|
295 | */
|
---|
296 | typedef struct VDINTERFACE
|
---|
297 | {
|
---|
298 | /** Human readable interface name. */
|
---|
299 | const char *pszInterfaceName;
|
---|
300 | /** The size of the struct. */
|
---|
301 | uint32_t cbSize;
|
---|
302 | /** Pointer to the next common interface structure. */
|
---|
303 | struct VDINTERFACE *pNext;
|
---|
304 | /** Interface type. */
|
---|
305 | VDINTERFACETYPE enmInterface;
|
---|
306 | /** Opaque user data which is passed on every call. */
|
---|
307 | void *pvUser;
|
---|
308 | /** Pointer to the function call table of the interface.
|
---|
309 | * As this is opaque this must be casted to the right interface
|
---|
310 | * struct defined below based on the interface type in enmInterface. */
|
---|
311 | void *pCallbacks;
|
---|
312 | } VDINTERFACE;
|
---|
313 | /** Pointer to a VDINTERFACE. */
|
---|
314 | typedef VDINTERFACE *PVDINTERFACE;
|
---|
315 | /** Pointer to a const VDINTERFACE. */
|
---|
316 | typedef const VDINTERFACE *PCVDINTERFACE;
|
---|
317 |
|
---|
318 | /**
|
---|
319 | * Helper functions to handle interface lists.
|
---|
320 | *
|
---|
321 | * @note These interface lists are used consistently to pass per-disk,
|
---|
322 | * per-image and/or per-operation callbacks. Those three purposes are strictly
|
---|
323 | * separate. See the individual interface declarations for what context they
|
---|
324 | * apply to. The caller is responsible for ensuring that the lifetime of the
|
---|
325 | * interface descriptors is appropriate for the category of interface.
|
---|
326 | */
|
---|
327 |
|
---|
328 | /**
|
---|
329 | * Get a specific interface from a list of interfaces specified by the type.
|
---|
330 | *
|
---|
331 | * @return Pointer to the matching interface or NULL if none was found.
|
---|
332 | * @param pVDIfs Pointer to the VD interface list.
|
---|
333 | * @param enmInterface Interface to search for.
|
---|
334 | */
|
---|
335 | DECLINLINE(PVDINTERFACE) VDInterfaceGet(PVDINTERFACE pVDIfs, VDINTERFACETYPE enmInterface)
|
---|
336 | {
|
---|
337 | AssertMsgReturn( enmInterface >= VDINTERFACETYPE_FIRST
|
---|
338 | && enmInterface < VDINTERFACETYPE_INVALID,
|
---|
339 | ("enmInterface=%u", enmInterface), NULL);
|
---|
340 |
|
---|
341 | while (pVDIfs)
|
---|
342 | {
|
---|
343 | /* Sanity checks. */
|
---|
344 | AssertMsgBreak(pVDIfs->cbSize == sizeof(VDINTERFACE),
|
---|
345 | ("cbSize=%u\n", pVDIfs->cbSize));
|
---|
346 |
|
---|
347 | if (pVDIfs->enmInterface == enmInterface)
|
---|
348 | return pVDIfs;
|
---|
349 | pVDIfs = pVDIfs->pNext;
|
---|
350 | }
|
---|
351 |
|
---|
352 | /* No matching interface was found. */
|
---|
353 | return NULL;
|
---|
354 | }
|
---|
355 |
|
---|
356 | /**
|
---|
357 | * Add an interface to a list of interfaces.
|
---|
358 | *
|
---|
359 | * @return VBox status code.
|
---|
360 | * @param pInterface Pointer to an unitialized common interface structure.
|
---|
361 | * @param pszName Name of the interface.
|
---|
362 | * @param enmInterface Type of the interface.
|
---|
363 | * @param pCallbacks The callback table of the interface.
|
---|
364 | * @param pvUser Opaque user data passed on every function call.
|
---|
365 | * @param ppVDIfs Pointer to the VD interface list.
|
---|
366 | */
|
---|
367 | DECLINLINE(int) VDInterfaceAdd(PVDINTERFACE pInterface, const char *pszName,
|
---|
368 | VDINTERFACETYPE enmInterface, void *pCallbacks,
|
---|
369 | void *pvUser, PVDINTERFACE *ppVDIfs)
|
---|
370 | {
|
---|
371 | /* Argument checks. */
|
---|
372 | AssertMsgReturn( enmInterface >= VDINTERFACETYPE_FIRST
|
---|
373 | && enmInterface < VDINTERFACETYPE_INVALID,
|
---|
374 | ("enmInterface=%u", enmInterface), VERR_INVALID_PARAMETER);
|
---|
375 |
|
---|
376 | AssertMsgReturn(VALID_PTR(pCallbacks),
|
---|
377 | ("pCallbacks=%#p", pCallbacks),
|
---|
378 | VERR_INVALID_PARAMETER);
|
---|
379 |
|
---|
380 | AssertMsgReturn(VALID_PTR(ppVDIfs),
|
---|
381 | ("pInterfaceList=%#p", ppVDIfs),
|
---|
382 | VERR_INVALID_PARAMETER);
|
---|
383 |
|
---|
384 | /* Fill out interface descriptor. */
|
---|
385 | pInterface->cbSize = sizeof(VDINTERFACE);
|
---|
386 | pInterface->pszInterfaceName = pszName;
|
---|
387 | pInterface->enmInterface = enmInterface;
|
---|
388 | pInterface->pCallbacks = pCallbacks;
|
---|
389 | pInterface->pvUser = pvUser;
|
---|
390 | pInterface->pNext = *ppVDIfs;
|
---|
391 |
|
---|
392 | /* Remember the new start of the list. */
|
---|
393 | *ppVDIfs = pInterface;
|
---|
394 |
|
---|
395 | return VINF_SUCCESS;
|
---|
396 | }
|
---|
397 |
|
---|
398 | /**
|
---|
399 | * Removes an interface from a list of interfaces.
|
---|
400 | *
|
---|
401 | * @return VBox status code
|
---|
402 | * @param pInterface Pointer to an initialized common interface structure to remove.
|
---|
403 | * @param ppVDIfs Pointer to the VD interface list to remove from.
|
---|
404 | */
|
---|
405 | DECLINLINE(int) VDInterfaceRemove(PVDINTERFACE pInterface, PVDINTERFACE *ppVDIfs)
|
---|
406 | {
|
---|
407 | int rc = VERR_NOT_FOUND;
|
---|
408 |
|
---|
409 | /* Argument checks. */
|
---|
410 | AssertMsgReturn(VALID_PTR(pInterface),
|
---|
411 | ("pInterface=%#p", pInterface),
|
---|
412 | VERR_INVALID_PARAMETER);
|
---|
413 |
|
---|
414 | AssertMsgReturn(VALID_PTR(ppVDIfs),
|
---|
415 | ("pInterfaceList=%#p", ppVDIfs),
|
---|
416 | VERR_INVALID_PARAMETER);
|
---|
417 |
|
---|
418 | if (*ppVDIfs)
|
---|
419 | {
|
---|
420 | PVDINTERFACE pPrev = NULL;
|
---|
421 | PVDINTERFACE pCurr = *ppVDIfs;
|
---|
422 |
|
---|
423 | while ( pCurr
|
---|
424 | && (pCurr != pInterface))
|
---|
425 | {
|
---|
426 | pPrev = pCurr;
|
---|
427 | pCurr = pCurr->pNext;
|
---|
428 | }
|
---|
429 |
|
---|
430 | /* First interface */
|
---|
431 | if (!pPrev)
|
---|
432 | {
|
---|
433 | *ppVDIfs = pCurr->pNext;
|
---|
434 | rc = VINF_SUCCESS;
|
---|
435 | }
|
---|
436 | else if (pCurr)
|
---|
437 | {
|
---|
438 | pPrev = pCurr->pNext;
|
---|
439 | rc = VINF_SUCCESS;
|
---|
440 | }
|
---|
441 | }
|
---|
442 |
|
---|
443 | return rc;
|
---|
444 | }
|
---|
445 |
|
---|
446 | /**
|
---|
447 | * Interface to deliver error messages (and also informational messages)
|
---|
448 | * to upper layers.
|
---|
449 | *
|
---|
450 | * Per-disk interface. Optional, but think twice if you want to miss the
|
---|
451 | * opportunity of reporting better human-readable error messages.
|
---|
452 | */
|
---|
453 | typedef struct VDINTERFACEERROR
|
---|
454 | {
|
---|
455 | /**
|
---|
456 | * Size of the error interface.
|
---|
457 | */
|
---|
458 | uint32_t cbSize;
|
---|
459 |
|
---|
460 | /**
|
---|
461 | * Interface type.
|
---|
462 | */
|
---|
463 | VDINTERFACETYPE enmInterface;
|
---|
464 |
|
---|
465 | /**
|
---|
466 | * Error message callback. Must be able to accept special IPRT format
|
---|
467 | * strings.
|
---|
468 | *
|
---|
469 | * @param pvUser The opaque data passed on container creation.
|
---|
470 | * @param rc The VBox error code.
|
---|
471 | * @param RT_SRC_POS_DECL Use RT_SRC_POS.
|
---|
472 | * @param pszFormat Error message format string.
|
---|
473 | * @param va Error message arguments.
|
---|
474 | */
|
---|
475 | DECLR3CALLBACKMEMBER(void, pfnError, (void *pvUser, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va));
|
---|
476 |
|
---|
477 | /**
|
---|
478 | * Informational message callback. May be NULL. Used e.g. in
|
---|
479 | * VDDumpImages(). Must be able to accept special IPRT format strings.
|
---|
480 | *
|
---|
481 | * @return VBox status code.
|
---|
482 | * @param pvUser The opaque data passed on container creation.
|
---|
483 | * @param pszFormat Message format string.
|
---|
484 | * @param va Message arguments.
|
---|
485 | */
|
---|
486 | DECLR3CALLBACKMEMBER(int, pfnMessage, (void *pvUser, const char *pszFormat, va_list va));
|
---|
487 |
|
---|
488 | } VDINTERFACEERROR, *PVDINTERFACEERROR;
|
---|
489 |
|
---|
490 | /**
|
---|
491 | * Get error interface from opaque callback table.
|
---|
492 | *
|
---|
493 | * @return Pointer to the callback table.
|
---|
494 | * @param pInterface Pointer to the interface descriptor.
|
---|
495 | */
|
---|
496 | DECLINLINE(PVDINTERFACEERROR) VDGetInterfaceError(PVDINTERFACE pInterface)
|
---|
497 | {
|
---|
498 | PVDINTERFACEERROR pInterfaceError;
|
---|
499 |
|
---|
500 | /* Check that the interface descriptor is a error interface. */
|
---|
501 | AssertMsgReturn( pInterface->enmInterface == VDINTERFACETYPE_ERROR
|
---|
502 | && pInterface->cbSize == sizeof(VDINTERFACE),
|
---|
503 | ("Not an error interface"), NULL);
|
---|
504 |
|
---|
505 | pInterfaceError = (PVDINTERFACEERROR)pInterface->pCallbacks;
|
---|
506 |
|
---|
507 | /* Do basic checks. */
|
---|
508 | AssertMsgReturn( pInterfaceError->cbSize == sizeof(VDINTERFACEERROR)
|
---|
509 | && pInterfaceError->enmInterface == VDINTERFACETYPE_ERROR,
|
---|
510 | ("A non error callback table attached to a error interface descriptor\n"), NULL);
|
---|
511 |
|
---|
512 | return pInterfaceError;
|
---|
513 | }
|
---|
514 |
|
---|
515 | /**
|
---|
516 | * Completion callback which is called by the interface owner
|
---|
517 | * to inform the backend that a task finished.
|
---|
518 | *
|
---|
519 | * @return VBox status code.
|
---|
520 | * @param pvUser Opaque user data which is passed on request submission.
|
---|
521 | * @param rcReq Status code of the completed request.
|
---|
522 | */
|
---|
523 | typedef DECLCALLBACK(int) FNVDCOMPLETED(void *pvUser, int rcReq);
|
---|
524 | /** Pointer to FNVDCOMPLETED() */
|
---|
525 | typedef FNVDCOMPLETED *PFNVDCOMPLETED;
|
---|
526 |
|
---|
527 | /**
|
---|
528 | * Support interface for I/O
|
---|
529 | *
|
---|
530 | * Per-image. Optional as input.
|
---|
531 | */
|
---|
532 | typedef struct VDINTERFACEIO
|
---|
533 | {
|
---|
534 | /**
|
---|
535 | * Size of the I/O interface.
|
---|
536 | */
|
---|
537 | uint32_t cbSize;
|
---|
538 |
|
---|
539 | /**
|
---|
540 | * Interface type.
|
---|
541 | */
|
---|
542 | VDINTERFACETYPE enmInterface;
|
---|
543 |
|
---|
544 | /**
|
---|
545 | * Open callback
|
---|
546 | *
|
---|
547 | * @return VBox status code.
|
---|
548 | * @param pvUser The opaque data passed on container creation.
|
---|
549 | * @param pszLocation Name of the location to open.
|
---|
550 | * @param fOpen Flags for opening the backend.
|
---|
551 | * See RTFILE_O_* #defines, inventing another set
|
---|
552 | * of open flags is not worth the mapping effort.
|
---|
553 | * @param pfnCompleted The callback which is called whenever a task
|
---|
554 | * completed. The backend has to pass the user data
|
---|
555 | * of the request initiator (ie the one who calls
|
---|
556 | * VDAsyncRead or VDAsyncWrite) in pvCompletion
|
---|
557 | * if this is NULL.
|
---|
558 | * @param ppStorage Where to store the opaque storage handle.
|
---|
559 | */
|
---|
560 | DECLR3CALLBACKMEMBER(int, pfnOpen, (void *pvUser, const char *pszLocation,
|
---|
561 | uint32_t fOpen,
|
---|
562 | PFNVDCOMPLETED pfnCompleted,
|
---|
563 | void **ppStorage));
|
---|
564 |
|
---|
565 | /**
|
---|
566 | * Close callback.
|
---|
567 | *
|
---|
568 | * @return VBox status code.
|
---|
569 | * @param pvUser The opaque data passed on container creation.
|
---|
570 | * @param pStorage The opaque storage handle to close.
|
---|
571 | */
|
---|
572 | DECLR3CALLBACKMEMBER(int, pfnClose, (void *pvUser, void *pStorage));
|
---|
573 |
|
---|
574 | /**
|
---|
575 | * Delete callback.
|
---|
576 | *
|
---|
577 | * @return VBox status code.
|
---|
578 | * @param pvUser The opaque data passed on container creation.
|
---|
579 | * @param pcszFilename Name of the file to delete.
|
---|
580 | */
|
---|
581 | DECLR3CALLBACKMEMBER(int, pfnDelete, (void *pvUser, const char *pcszFilename));
|
---|
582 |
|
---|
583 | /**
|
---|
584 | * Move callback.
|
---|
585 | *
|
---|
586 | * @return VBox status code.
|
---|
587 | * @param pvUser The opaque data passed on container creation.
|
---|
588 | * @param pcszSrc The path to the source file.
|
---|
589 | * @param pcszDst The path to the destination file.
|
---|
590 | * This file will be created.
|
---|
591 | * @param fMove A combination of the RTFILEMOVE_* flags.
|
---|
592 | */
|
---|
593 | DECLR3CALLBACKMEMBER(int, pfnMove, (void *pvUser, const char *pcszSrc, const char *pcszDst, unsigned fMove));
|
---|
594 |
|
---|
595 | /**
|
---|
596 | * Returns the free space on a disk.
|
---|
597 | *
|
---|
598 | * @return VBox status code.
|
---|
599 | * @param pvUser The opaque data passed on container creation.
|
---|
600 | * @param pcszFilename Name of a file to identify the disk.
|
---|
601 | * @param pcbFreeSpace Where to store the free space of the disk.
|
---|
602 | */
|
---|
603 | DECLR3CALLBACKMEMBER(int, pfnGetFreeSpace, (void *pvUser, const char *pcszFilename, int64_t *pcbFreeSpace));
|
---|
604 |
|
---|
605 | /**
|
---|
606 | * Returns the last modification timestamp of a file.
|
---|
607 | *
|
---|
608 | * @return VBox status code.
|
---|
609 | * @param pvUser The opaque data passed on container creation.
|
---|
610 | * @param pcszFilename Name of a file to identify the disk.
|
---|
611 | * @param pModificationTime Where to store the timestamp of the file.
|
---|
612 | */
|
---|
613 | DECLR3CALLBACKMEMBER(int, pfnGetModificationTime, (void *pvUser, const char *pcszFilename, PRTTIMESPEC pModificationTime));
|
---|
614 |
|
---|
615 | /**
|
---|
616 | * Returns the size of the opened storage backend.
|
---|
617 | *
|
---|
618 | * @return VBox status code.
|
---|
619 | * @param pvUser The opaque data passed on container creation.
|
---|
620 | * @param pStorage The opaque storage handle to close.
|
---|
621 | * @param pcbSize Where to store the size of the storage backend.
|
---|
622 | */
|
---|
623 | DECLR3CALLBACKMEMBER(int, pfnGetSize, (void *pvUser, void *pStorage, uint64_t *pcbSize));
|
---|
624 |
|
---|
625 | /**
|
---|
626 | * Sets the size of the opened storage backend if possible.
|
---|
627 | *
|
---|
628 | * @return VBox status code.
|
---|
629 | * @retval VERR_NOT_SUPPORTED if the backend does not support this operation.
|
---|
630 | * @param pvUser The opaque data passed on container creation.
|
---|
631 | * @param pStorage The opaque storage handle to close.
|
---|
632 | * @param cbSize The new size of the image.
|
---|
633 | */
|
---|
634 | DECLR3CALLBACKMEMBER(int, pfnSetSize, (void *pvUser, void *pStorage, uint64_t cbSize));
|
---|
635 |
|
---|
636 | /**
|
---|
637 | * Synchronous write callback.
|
---|
638 | *
|
---|
639 | * @return VBox status code.
|
---|
640 | * @param pvUser The opaque data passed on container creation.
|
---|
641 | * @param pStorage The storage handle to use.
|
---|
642 | * @param uOffset The offset to start from.
|
---|
643 | * @param pvBuffer Pointer to the bits need to be written.
|
---|
644 | * @param cbBuffer How many bytes to write.
|
---|
645 | * @param pcbWritten Where to store how many bytes were actually written.
|
---|
646 | */
|
---|
647 | DECLR3CALLBACKMEMBER(int, pfnWriteSync, (void *pvUser, void *pStorage, uint64_t uOffset,
|
---|
648 | const void *pvBuffer, size_t cbBuffer, size_t *pcbWritten));
|
---|
649 |
|
---|
650 | /**
|
---|
651 | * Synchronous read callback.
|
---|
652 | *
|
---|
653 | * @return VBox status code.
|
---|
654 | * @param pvUser The opaque data passed on container creation.
|
---|
655 | * @param pStorage The storage handle to use.
|
---|
656 | * @param uOffset The offset to start from.
|
---|
657 | * @param pvBuffer Where to store the read bits.
|
---|
658 | * @param cbBuffer How many bytes to read.
|
---|
659 | * @param pcbRead Where to store how many bytes were actually read.
|
---|
660 | */
|
---|
661 | DECLR3CALLBACKMEMBER(int, pfnReadSync, (void *pvUser, void *pStorage, uint64_t uOffset,
|
---|
662 | void *pvBuffer, size_t cbBuffer, size_t *pcbRead));
|
---|
663 |
|
---|
664 | /**
|
---|
665 | * Flush data to the storage backend.
|
---|
666 | *
|
---|
667 | * @return VBox status code.
|
---|
668 | * @param pvUser The opaque data passed on container creation.
|
---|
669 | * @param pStorage The storage handle to flush.
|
---|
670 | */
|
---|
671 | DECLR3CALLBACKMEMBER(int, pfnFlushSync, (void *pvUser, void *pStorage));
|
---|
672 |
|
---|
673 | /**
|
---|
674 | * Initiate an asynchronous read request.
|
---|
675 | *
|
---|
676 | * @return VBox status code.
|
---|
677 | * @param pvUser The opaque user data passed on container creation.
|
---|
678 | * @param pStorage The storage handle.
|
---|
679 | * @param uOffset The offset to start reading from.
|
---|
680 | * @param paSegments Scatter gather list to store the data in.
|
---|
681 | * @param cSegments Number of segments in the list.
|
---|
682 | * @param cbRead How many bytes to read.
|
---|
683 | * @param pvCompletion The opaque user data which is returned upon completion.
|
---|
684 | * @param ppTask Where to store the opaque task handle.
|
---|
685 | */
|
---|
686 | DECLR3CALLBACKMEMBER(int, pfnReadAsync, (void *pvUser, void *pStorage, uint64_t uOffset,
|
---|
687 | PCRTSGSEG paSegments, size_t cSegments,
|
---|
688 | size_t cbRead, void *pvCompletion,
|
---|
689 | void **ppTask));
|
---|
690 |
|
---|
691 | /**
|
---|
692 | * Initiate an asynchronous write request.
|
---|
693 | *
|
---|
694 | * @return VBox status code.
|
---|
695 | * @param pvUser The opaque user data passed on conatiner creation.
|
---|
696 | * @param pStorage The storage handle.
|
---|
697 | * @param uOffset The offset to start writing to.
|
---|
698 | * @param paSegments Scatter gather list of the data to write
|
---|
699 | * @param cSegments Number of segments in the list.
|
---|
700 | * @param cbWrite How many bytes to write.
|
---|
701 | * @param pvCompletion The opaque user data which is returned upon completion.
|
---|
702 | * @param ppTask Where to store the opaque task handle.
|
---|
703 | */
|
---|
704 | DECLR3CALLBACKMEMBER(int, pfnWriteAsync, (void *pvUser, void *pStorage, uint64_t uOffset,
|
---|
705 | PCRTSGSEG paSegments, size_t cSegments,
|
---|
706 | size_t cbWrite, void *pvCompletion,
|
---|
707 | void **ppTask));
|
---|
708 |
|
---|
709 | /**
|
---|
710 | * Initiates an async flush request.
|
---|
711 | *
|
---|
712 | * @return VBox status code.
|
---|
713 | * @param pvUser The opaque data passed on container creation.
|
---|
714 | * @param pStorage The storage handle to flush.
|
---|
715 | * @param pvCompletion The opaque user data which is returned upon completion.
|
---|
716 | * @param ppTask Where to store the opaque task handle.
|
---|
717 | */
|
---|
718 | DECLR3CALLBACKMEMBER(int, pfnFlushAsync, (void *pvUser, void *pStorage,
|
---|
719 | void *pvCompletion, void **ppTask));
|
---|
720 |
|
---|
721 | } VDINTERFACEIO, *PVDINTERFACEIO;
|
---|
722 |
|
---|
723 | /**
|
---|
724 | * Get I/O interface from opaque callback table.
|
---|
725 | *
|
---|
726 | * @return Pointer to the callback table.
|
---|
727 | * @param pInterface Pointer to the interface descriptor.
|
---|
728 | */
|
---|
729 | DECLINLINE(PVDINTERFACEIO) VDGetInterfaceIO(PVDINTERFACE pInterface)
|
---|
730 | {
|
---|
731 | PVDINTERFACEIO pInterfaceIO;
|
---|
732 |
|
---|
733 | /* Check that the interface descriptor is an I/O interface. */
|
---|
734 | AssertMsgReturn( (pInterface->enmInterface == VDINTERFACETYPE_IO)
|
---|
735 | && (pInterface->cbSize == sizeof(VDINTERFACE)),
|
---|
736 | ("Not an I/O interface"), NULL);
|
---|
737 |
|
---|
738 | pInterfaceIO = (PVDINTERFACEIO)pInterface->pCallbacks;
|
---|
739 |
|
---|
740 | /* Do basic checks. */
|
---|
741 | AssertMsgReturn( (pInterfaceIO->cbSize == sizeof(VDINTERFACEIO))
|
---|
742 | && (pInterfaceIO->enmInterface == VDINTERFACETYPE_IO),
|
---|
743 | ("A non I/O callback table attached to an I/O interface descriptor\n"), NULL);
|
---|
744 |
|
---|
745 | return pInterfaceIO;
|
---|
746 | }
|
---|
747 |
|
---|
748 | /**
|
---|
749 | * Callback which provides progress information about a currently running
|
---|
750 | * lengthy operation.
|
---|
751 | *
|
---|
752 | * @return VBox status code.
|
---|
753 | * @param pvUser The opaque user data associated with this interface.
|
---|
754 | * @param uPercent Completion percentage.
|
---|
755 | */
|
---|
756 | typedef DECLCALLBACK(int) FNVDPROGRESS(void *pvUser, unsigned uPercentage);
|
---|
757 | /** Pointer to FNVDPROGRESS() */
|
---|
758 | typedef FNVDPROGRESS *PFNVDPROGRESS;
|
---|
759 |
|
---|
760 | /**
|
---|
761 | * Progress notification interface
|
---|
762 | *
|
---|
763 | * Per-operation. Optional.
|
---|
764 | */
|
---|
765 | typedef struct VDINTERFACEPROGRESS
|
---|
766 | {
|
---|
767 | /**
|
---|
768 | * Size of the progress interface.
|
---|
769 | */
|
---|
770 | uint32_t cbSize;
|
---|
771 |
|
---|
772 | /**
|
---|
773 | * Interface type.
|
---|
774 | */
|
---|
775 | VDINTERFACETYPE enmInterface;
|
---|
776 |
|
---|
777 | /**
|
---|
778 | * Progress notification callbacks.
|
---|
779 | */
|
---|
780 | PFNVDPROGRESS pfnProgress;
|
---|
781 |
|
---|
782 | } VDINTERFACEPROGRESS, *PVDINTERFACEPROGRESS;
|
---|
783 |
|
---|
784 | /**
|
---|
785 | * Get progress interface from opaque callback table.
|
---|
786 | *
|
---|
787 | * @return Pointer to the callback table.
|
---|
788 | * @param pInterface Pointer to the interface descriptor.
|
---|
789 | */
|
---|
790 | DECLINLINE(PVDINTERFACEPROGRESS) VDGetInterfaceProgress(PVDINTERFACE pInterface)
|
---|
791 | {
|
---|
792 | PVDINTERFACEPROGRESS pInterfaceProgress;
|
---|
793 |
|
---|
794 | /* Check that the interface descriptor is a progress interface. */
|
---|
795 | AssertMsgReturn( (pInterface->enmInterface == VDINTERFACETYPE_PROGRESS)
|
---|
796 | && (pInterface->cbSize == sizeof(VDINTERFACE)),
|
---|
797 | ("Not a progress interface"), NULL);
|
---|
798 |
|
---|
799 |
|
---|
800 | pInterfaceProgress = (PVDINTERFACEPROGRESS)pInterface->pCallbacks;
|
---|
801 |
|
---|
802 | /* Do basic checks. */
|
---|
803 | AssertMsgReturn( (pInterfaceProgress->cbSize == sizeof(VDINTERFACEPROGRESS))
|
---|
804 | && (pInterfaceProgress->enmInterface == VDINTERFACETYPE_PROGRESS),
|
---|
805 | ("A non progress callback table attached to a progress interface descriptor\n"), NULL);
|
---|
806 |
|
---|
807 | return pInterfaceProgress;
|
---|
808 | }
|
---|
809 |
|
---|
810 |
|
---|
811 | /**
|
---|
812 | * Configuration information interface
|
---|
813 | *
|
---|
814 | * Per-image. Optional for most backends, but mandatory for images which do
|
---|
815 | * not operate on files (including standard block or character devices).
|
---|
816 | */
|
---|
817 | typedef struct VDINTERFACECONFIG
|
---|
818 | {
|
---|
819 | /**
|
---|
820 | * Size of the configuration interface.
|
---|
821 | */
|
---|
822 | uint32_t cbSize;
|
---|
823 |
|
---|
824 | /**
|
---|
825 | * Interface type.
|
---|
826 | */
|
---|
827 | VDINTERFACETYPE enmInterface;
|
---|
828 |
|
---|
829 | /**
|
---|
830 | * Validates that the keys are within a set of valid names.
|
---|
831 | *
|
---|
832 | * @return true if all key names are found in pszzAllowed.
|
---|
833 | * @return false if not.
|
---|
834 | * @param pvUser The opaque user data associated with this interface.
|
---|
835 | * @param pszzValid List of valid key names separated by '\\0' and ending with
|
---|
836 | * a double '\\0'.
|
---|
837 | */
|
---|
838 | DECLR3CALLBACKMEMBER(bool, pfnAreKeysValid, (void *pvUser, const char *pszzValid));
|
---|
839 |
|
---|
840 | /**
|
---|
841 | * Retrieves the length of the string value associated with a key (including
|
---|
842 | * the terminator, for compatibility with CFGMR3QuerySize).
|
---|
843 | *
|
---|
844 | * @return VBox status code.
|
---|
845 | * VERR_CFGM_VALUE_NOT_FOUND means that the key is not known.
|
---|
846 | * @param pvUser The opaque user data associated with this interface.
|
---|
847 | * @param pszName Name of the key to query.
|
---|
848 | * @param pcbValue Where to store the value length. Non-NULL.
|
---|
849 | */
|
---|
850 | DECLR3CALLBACKMEMBER(int, pfnQuerySize, (void *pvUser, const char *pszName, size_t *pcbValue));
|
---|
851 |
|
---|
852 | /**
|
---|
853 | * Query the string value associated with a key.
|
---|
854 | *
|
---|
855 | * @return VBox status code.
|
---|
856 | * VERR_CFGM_VALUE_NOT_FOUND means that the key is not known.
|
---|
857 | * VERR_CFGM_NOT_ENOUGH_SPACE means that the buffer is not big enough.
|
---|
858 | * @param pvUser The opaque user data associated with this interface.
|
---|
859 | * @param pszName Name of the key to query.
|
---|
860 | * @param pszValue Pointer to buffer where to store value.
|
---|
861 | * @param cchValue Length of value buffer.
|
---|
862 | */
|
---|
863 | DECLR3CALLBACKMEMBER(int, pfnQuery, (void *pvUser, const char *pszName, char *pszValue, size_t cchValue));
|
---|
864 |
|
---|
865 | } VDINTERFACECONFIG, *PVDINTERFACECONFIG;
|
---|
866 |
|
---|
867 | /**
|
---|
868 | * Get configuration information interface from opaque callback table.
|
---|
869 | *
|
---|
870 | * @return Pointer to the callback table.
|
---|
871 | * @param pInterface Pointer to the interface descriptor.
|
---|
872 | */
|
---|
873 | DECLINLINE(PVDINTERFACECONFIG) VDGetInterfaceConfig(PVDINTERFACE pInterface)
|
---|
874 | {
|
---|
875 | PVDINTERFACECONFIG pInterfaceConfig;
|
---|
876 |
|
---|
877 | /* Check that the interface descriptor is a config interface. */
|
---|
878 | AssertMsgReturn( (pInterface->enmInterface == VDINTERFACETYPE_CONFIG)
|
---|
879 | && (pInterface->cbSize == sizeof(VDINTERFACE)),
|
---|
880 | ("Not a config interface"), NULL);
|
---|
881 |
|
---|
882 | pInterfaceConfig = (PVDINTERFACECONFIG)pInterface->pCallbacks;
|
---|
883 |
|
---|
884 | /* Do basic checks. */
|
---|
885 | AssertMsgReturn( (pInterfaceConfig->cbSize == sizeof(VDINTERFACECONFIG))
|
---|
886 | && (pInterfaceConfig->enmInterface == VDINTERFACETYPE_CONFIG),
|
---|
887 | ("A non config callback table attached to a config interface descriptor\n"), NULL);
|
---|
888 |
|
---|
889 | return pInterfaceConfig;
|
---|
890 | }
|
---|
891 |
|
---|
892 | /**
|
---|
893 | * Query configuration, validates that the keys are within a set of valid names.
|
---|
894 | *
|
---|
895 | * @return true if all key names are found in pszzAllowed.
|
---|
896 | * @return false if not.
|
---|
897 | * @param pCfgIf Pointer to configuration callback table.
|
---|
898 | * @param pvUser The opaque user data associated with this interface.
|
---|
899 | * @param pszzValid List of valid names separated by '\\0' and ending with
|
---|
900 | * a double '\\0'.
|
---|
901 | */
|
---|
902 | DECLINLINE(bool) VDCFGAreKeysValid(PVDINTERFACECONFIG pCfgIf, void *pvUser,
|
---|
903 | const char *pszzValid)
|
---|
904 | {
|
---|
905 | return pCfgIf->pfnAreKeysValid(pvUser, pszzValid);
|
---|
906 | }
|
---|
907 |
|
---|
908 | /**
|
---|
909 | * Query configuration, unsigned 64-bit integer value with default.
|
---|
910 | *
|
---|
911 | * @return VBox status code.
|
---|
912 | * @param pCfgIf Pointer to configuration callback table.
|
---|
913 | * @param pvUser The opaque user data associated with this interface.
|
---|
914 | * @param pszName Name of an integer value
|
---|
915 | * @param pu64 Where to store the value. Set to default on failure.
|
---|
916 | * @param u64Def The default value.
|
---|
917 | */
|
---|
918 | DECLINLINE(int) VDCFGQueryU64Def(PVDINTERFACECONFIG pCfgIf, void *pvUser,
|
---|
919 | const char *pszName, uint64_t *pu64,
|
---|
920 | uint64_t u64Def)
|
---|
921 | {
|
---|
922 | char aszBuf[32];
|
---|
923 | int rc = pCfgIf->pfnQuery(pvUser, pszName, aszBuf, sizeof(aszBuf));
|
---|
924 | if (RT_SUCCESS(rc))
|
---|
925 | {
|
---|
926 | rc = RTStrToUInt64Full(aszBuf, 0, pu64);
|
---|
927 | }
|
---|
928 | else if (rc == VERR_CFGM_VALUE_NOT_FOUND)
|
---|
929 | {
|
---|
930 | rc = VINF_SUCCESS;
|
---|
931 | *pu64 = u64Def;
|
---|
932 | }
|
---|
933 | return rc;
|
---|
934 | }
|
---|
935 |
|
---|
936 | /**
|
---|
937 | * Query configuration, unsigned 32-bit integer value with default.
|
---|
938 | *
|
---|
939 | * @return VBox status code.
|
---|
940 | * @param pCfgIf Pointer to configuration callback table.
|
---|
941 | * @param pvUser The opaque user data associated with this interface.
|
---|
942 | * @param pszName Name of an integer value
|
---|
943 | * @param pu32 Where to store the value. Set to default on failure.
|
---|
944 | * @param u32Def The default value.
|
---|
945 | */
|
---|
946 | DECLINLINE(int) VDCFGQueryU32Def(PVDINTERFACECONFIG pCfgIf, void *pvUser,
|
---|
947 | const char *pszName, uint32_t *pu32,
|
---|
948 | uint32_t u32Def)
|
---|
949 | {
|
---|
950 | uint64_t u64;
|
---|
951 | int rc = VDCFGQueryU64Def(pCfgIf, pvUser, pszName, &u64, u32Def);
|
---|
952 | if (RT_SUCCESS(rc))
|
---|
953 | {
|
---|
954 | if (!(u64 & UINT64_C(0xffffffff00000000)))
|
---|
955 | *pu32 = (uint32_t)u64;
|
---|
956 | else
|
---|
957 | rc = VERR_CFGM_INTEGER_TOO_BIG;
|
---|
958 | }
|
---|
959 | return rc;
|
---|
960 | }
|
---|
961 |
|
---|
962 | /**
|
---|
963 | * Query configuration, bool value with default.
|
---|
964 | *
|
---|
965 | * @return VBox status code.
|
---|
966 | * @param pCfgIf Pointer to configuration callback table.
|
---|
967 | * @param pvUser The opaque user data associated with this interface.
|
---|
968 | * @param pszName Name of an integer value
|
---|
969 | * @param pf Where to store the value. Set to default on failure.
|
---|
970 | * @param fDef The default value.
|
---|
971 | */
|
---|
972 | DECLINLINE(int) VDCFGQueryBoolDef(PVDINTERFACECONFIG pCfgIf, void *pvUser,
|
---|
973 | const char *pszName, bool *pf,
|
---|
974 | bool fDef)
|
---|
975 | {
|
---|
976 | uint64_t u64;
|
---|
977 | int rc = VDCFGQueryU64Def(pCfgIf, pvUser, pszName, &u64, fDef);
|
---|
978 | if (RT_SUCCESS(rc))
|
---|
979 | *pf = u64 ? true : false;
|
---|
980 | return rc;
|
---|
981 | }
|
---|
982 |
|
---|
983 | /**
|
---|
984 | * Query configuration, dynamically allocated (RTMemAlloc) zero terminated
|
---|
985 | * character value.
|
---|
986 | *
|
---|
987 | * @return VBox status code.
|
---|
988 | * @param pCfgIf Pointer to configuration callback table.
|
---|
989 | * @param pvUser The opaque user data associated with this interface.
|
---|
990 | * @param pszName Name of an zero terminated character value
|
---|
991 | * @param ppszString Where to store the string pointer. Not set on failure.
|
---|
992 | * Free this using RTMemFree().
|
---|
993 | */
|
---|
994 | DECLINLINE(int) VDCFGQueryStringAlloc(PVDINTERFACECONFIG pCfgIf,
|
---|
995 | void *pvUser, const char *pszName,
|
---|
996 | char **ppszString)
|
---|
997 | {
|
---|
998 | size_t cb;
|
---|
999 | int rc = pCfgIf->pfnQuerySize(pvUser, pszName, &cb);
|
---|
1000 | if (RT_SUCCESS(rc))
|
---|
1001 | {
|
---|
1002 | char *pszString = (char *)RTMemAlloc(cb);
|
---|
1003 | if (pszString)
|
---|
1004 | {
|
---|
1005 | rc = pCfgIf->pfnQuery(pvUser, pszName, pszString, cb);
|
---|
1006 | if (RT_SUCCESS(rc))
|
---|
1007 | *ppszString = pszString;
|
---|
1008 | else
|
---|
1009 | RTMemFree(pszString);
|
---|
1010 | }
|
---|
1011 | else
|
---|
1012 | rc = VERR_NO_MEMORY;
|
---|
1013 | }
|
---|
1014 | return rc;
|
---|
1015 | }
|
---|
1016 |
|
---|
1017 | /**
|
---|
1018 | * Query configuration, dynamically allocated (RTMemAlloc) zero terminated
|
---|
1019 | * character value with default.
|
---|
1020 | *
|
---|
1021 | * @return VBox status code.
|
---|
1022 | * @param pCfgIf Pointer to configuration callback table.
|
---|
1023 | * @param pvUser The opaque user data associated with this interface.
|
---|
1024 | * @param pszName Name of an zero terminated character value
|
---|
1025 | * @param ppszString Where to store the string pointer. Not set on failure.
|
---|
1026 | * Free this using RTMemFree().
|
---|
1027 | * @param pszDef The default value.
|
---|
1028 | */
|
---|
1029 | DECLINLINE(int) VDCFGQueryStringAllocDef(PVDINTERFACECONFIG pCfgIf,
|
---|
1030 | void *pvUser, const char *pszName,
|
---|
1031 | char **ppszString,
|
---|
1032 | const char *pszDef)
|
---|
1033 | {
|
---|
1034 | size_t cb;
|
---|
1035 | int rc = pCfgIf->pfnQuerySize(pvUser, pszName, &cb);
|
---|
1036 | if (rc == VERR_CFGM_VALUE_NOT_FOUND || rc == VERR_CFGM_NO_PARENT)
|
---|
1037 | {
|
---|
1038 | cb = strlen(pszDef) + 1;
|
---|
1039 | rc = VINF_SUCCESS;
|
---|
1040 | }
|
---|
1041 | if (RT_SUCCESS(rc))
|
---|
1042 | {
|
---|
1043 | char *pszString = (char *)RTMemAlloc(cb);
|
---|
1044 | if (pszString)
|
---|
1045 | {
|
---|
1046 | rc = pCfgIf->pfnQuery(pvUser, pszName, pszString, cb);
|
---|
1047 | if (rc == VERR_CFGM_VALUE_NOT_FOUND || rc == VERR_CFGM_NO_PARENT)
|
---|
1048 | {
|
---|
1049 | memcpy(pszString, pszDef, cb);
|
---|
1050 | rc = VINF_SUCCESS;
|
---|
1051 | }
|
---|
1052 | if (RT_SUCCESS(rc))
|
---|
1053 | *ppszString = pszString;
|
---|
1054 | else
|
---|
1055 | RTMemFree(pszString);
|
---|
1056 | }
|
---|
1057 | else
|
---|
1058 | rc = VERR_NO_MEMORY;
|
---|
1059 | }
|
---|
1060 | return rc;
|
---|
1061 | }
|
---|
1062 |
|
---|
1063 | /**
|
---|
1064 | * Query configuration, dynamically allocated (RTMemAlloc) byte string value.
|
---|
1065 | *
|
---|
1066 | * @return VBox status code.
|
---|
1067 | * @param pCfgIf Pointer to configuration callback table.
|
---|
1068 | * @param pvUser The opaque user data associated with this interface.
|
---|
1069 | * @param pszName Name of an zero terminated character value
|
---|
1070 | * @param ppvData Where to store the byte string pointer. Not set on failure.
|
---|
1071 | * Free this using RTMemFree().
|
---|
1072 | * @param pcbData Where to store the byte string length.
|
---|
1073 | */
|
---|
1074 | DECLINLINE(int) VDCFGQueryBytesAlloc(PVDINTERFACECONFIG pCfgIf,
|
---|
1075 | void *pvUser, const char *pszName,
|
---|
1076 | void **ppvData, size_t *pcbData)
|
---|
1077 | {
|
---|
1078 | size_t cb;
|
---|
1079 | int rc = pCfgIf->pfnQuerySize(pvUser, pszName, &cb);
|
---|
1080 | if (RT_SUCCESS(rc))
|
---|
1081 | {
|
---|
1082 | char *pbData;
|
---|
1083 | Assert(cb);
|
---|
1084 |
|
---|
1085 | pbData = (char *)RTMemAlloc(cb);
|
---|
1086 | if (pbData)
|
---|
1087 | {
|
---|
1088 | rc = pCfgIf->pfnQuery(pvUser, pszName, pbData, cb);
|
---|
1089 | if (RT_SUCCESS(rc))
|
---|
1090 | {
|
---|
1091 | *ppvData = pbData;
|
---|
1092 | *pcbData = cb - 1; /* Exclude terminator of the queried string. */
|
---|
1093 | }
|
---|
1094 | else
|
---|
1095 | RTMemFree(pbData);
|
---|
1096 | }
|
---|
1097 | else
|
---|
1098 | rc = VERR_NO_MEMORY;
|
---|
1099 | }
|
---|
1100 | return rc;
|
---|
1101 | }
|
---|
1102 |
|
---|
1103 | /** Forward declaration of a VD socket. */
|
---|
1104 | typedef struct VDSOCKETINT *VDSOCKET;
|
---|
1105 | /** Pointer to a VD socket. */
|
---|
1106 | typedef VDSOCKET *PVDSOCKET;
|
---|
1107 | /** Nil socket handle. */
|
---|
1108 | #define NIL_VDSOCKET ((VDSOCKET)0)
|
---|
1109 |
|
---|
1110 | /** Connect flag to indicate that the backend wants to use the extended
|
---|
1111 | * socket I/O multiplexing call. This might not be supported on all configurations
|
---|
1112 | * (internal networking and iSCSI)
|
---|
1113 | * and the backend needs to take appropriate action.
|
---|
1114 | */
|
---|
1115 | #define VD_INTERFACETCPNET_CONNECT_EXTENDED_SELECT RT_BIT_32(0)
|
---|
1116 |
|
---|
1117 | /** @name Select events
|
---|
1118 | * @{ */
|
---|
1119 | /** Readable without blocking. */
|
---|
1120 | #define VD_INTERFACETCPNET_EVT_READ RT_BIT_32(0)
|
---|
1121 | /** Writable without blocking. */
|
---|
1122 | #define VD_INTERFACETCPNET_EVT_WRITE RT_BIT_32(1)
|
---|
1123 | /** Error condition, hangup, exception or similar. */
|
---|
1124 | #define VD_INTERFACETCPNET_EVT_ERROR RT_BIT_32(2)
|
---|
1125 | /** Hint for the select that getting interrupted while waiting is more likely.
|
---|
1126 | * The interface implementation can optimize the waiting strategy based on this.
|
---|
1127 | * It is assumed that it is more likely to get one of the above socket events
|
---|
1128 | * instead of being interrupted if the flag is not set. */
|
---|
1129 | #define VD_INTERFACETCPNET_HINT_INTERRUPT RT_BIT_32(3)
|
---|
1130 | /** Mask of the valid bits. */
|
---|
1131 | #define VD_INTERFACETCPNET_EVT_VALID_MASK UINT32_C(0x0000000f)
|
---|
1132 | /** @} */
|
---|
1133 |
|
---|
1134 | /**
|
---|
1135 | * TCP network stack interface
|
---|
1136 | *
|
---|
1137 | * Per-image. Mandatory for backends which have the VD_CAP_TCPNET bit set.
|
---|
1138 | */
|
---|
1139 | typedef struct VDINTERFACETCPNET
|
---|
1140 | {
|
---|
1141 | /**
|
---|
1142 | * Size of the configuration interface.
|
---|
1143 | */
|
---|
1144 | uint32_t cbSize;
|
---|
1145 |
|
---|
1146 | /**
|
---|
1147 | * Interface type.
|
---|
1148 | */
|
---|
1149 | VDINTERFACETYPE enmInterface;
|
---|
1150 |
|
---|
1151 | /**
|
---|
1152 | * Creates a socket. The socket is not connected if this succeeds.
|
---|
1153 | *
|
---|
1154 | * @return iprt status code.
|
---|
1155 | * @retval VERR_NOT_SUPPORTED if the combination of flags is not supported.
|
---|
1156 | * @param fFlags Combination of the VD_INTERFACETCPNET_CONNECT_* #defines.
|
---|
1157 | * @param pSock Where to store the handle.
|
---|
1158 | */
|
---|
1159 | DECLR3CALLBACKMEMBER(int, pfnSocketCreate, (uint32_t fFlags, PVDSOCKET pSock));
|
---|
1160 |
|
---|
1161 | /**
|
---|
1162 | * Destroys the socket.
|
---|
1163 | *
|
---|
1164 | * @return iprt status code.
|
---|
1165 | * @param Sock Socket descriptor.
|
---|
1166 | */
|
---|
1167 | DECLR3CALLBACKMEMBER(int, pfnSocketDestroy, (VDSOCKET Sock));
|
---|
1168 |
|
---|
1169 | /**
|
---|
1170 | * Connect as a client to a TCP port.
|
---|
1171 | *
|
---|
1172 | * @return iprt status code.
|
---|
1173 | * @param Sock Socket descriptor.
|
---|
1174 | * @param pszAddress The address to connect to.
|
---|
1175 | * @param uPort The port to connect to.
|
---|
1176 | */
|
---|
1177 | DECLR3CALLBACKMEMBER(int, pfnClientConnect, (VDSOCKET Sock, const char *pszAddress, uint32_t uPort));
|
---|
1178 |
|
---|
1179 | /**
|
---|
1180 | * Close a TCP connection.
|
---|
1181 | *
|
---|
1182 | * @return iprt status code.
|
---|
1183 | * @param Sock Socket descriptor.
|
---|
1184 | */
|
---|
1185 | DECLR3CALLBACKMEMBER(int, pfnClientClose, (VDSOCKET Sock));
|
---|
1186 |
|
---|
1187 | /**
|
---|
1188 | * Returns whether the socket is currently connected to the client.
|
---|
1189 | *
|
---|
1190 | * @returns true if the socket is connected.
|
---|
1191 | * false otherwise.
|
---|
1192 | * @param Sock Socket descriptor.
|
---|
1193 | */
|
---|
1194 | DECLR3CALLBACKMEMBER(bool, pfnIsClientConnected, (VDSOCKET Sock));
|
---|
1195 |
|
---|
1196 | /**
|
---|
1197 | * Socket I/O multiplexing.
|
---|
1198 | * Checks if the socket is ready for reading.
|
---|
1199 | *
|
---|
1200 | * @return iprt status code.
|
---|
1201 | * @param Sock Socket descriptor.
|
---|
1202 | * @param cMillies Number of milliseconds to wait for the socket.
|
---|
1203 | * Use RT_INDEFINITE_WAIT to wait for ever.
|
---|
1204 | */
|
---|
1205 | DECLR3CALLBACKMEMBER(int, pfnSelectOne, (VDSOCKET Sock, RTMSINTERVAL cMillies));
|
---|
1206 |
|
---|
1207 | /**
|
---|
1208 | * Receive data from a socket.
|
---|
1209 | *
|
---|
1210 | * @return iprt status code.
|
---|
1211 | * @param Sock Socket descriptor.
|
---|
1212 | * @param pvBuffer Where to put the data we read.
|
---|
1213 | * @param cbBuffer Read buffer size.
|
---|
1214 | * @param pcbRead Number of bytes read.
|
---|
1215 | * If NULL the entire buffer will be filled upon successful return.
|
---|
1216 | * If not NULL a partial read can be done successfully.
|
---|
1217 | */
|
---|
1218 | DECLR3CALLBACKMEMBER(int, pfnRead, (VDSOCKET Sock, void *pvBuffer, size_t cbBuffer, size_t *pcbRead));
|
---|
1219 |
|
---|
1220 | /**
|
---|
1221 | * Send data to a socket.
|
---|
1222 | *
|
---|
1223 | * @return iprt status code.
|
---|
1224 | * @param Sock Socket descriptor.
|
---|
1225 | * @param pvBuffer Buffer to write data to socket.
|
---|
1226 | * @param cbBuffer How much to write.
|
---|
1227 | */
|
---|
1228 | DECLR3CALLBACKMEMBER(int, pfnWrite, (VDSOCKET Sock, const void *pvBuffer, size_t cbBuffer));
|
---|
1229 |
|
---|
1230 | /**
|
---|
1231 | * Send data from scatter/gather buffer to a socket.
|
---|
1232 | *
|
---|
1233 | * @return iprt status code.
|
---|
1234 | * @param Sock Socket descriptor.
|
---|
1235 | * @param pSgBuffer Scatter/gather buffer to write data to socket.
|
---|
1236 | */
|
---|
1237 | DECLR3CALLBACKMEMBER(int, pfnSgWrite, (VDSOCKET Sock, PCRTSGBUF pSgBuffer));
|
---|
1238 |
|
---|
1239 | /**
|
---|
1240 | * Receive data from a socket - not blocking.
|
---|
1241 | *
|
---|
1242 | * @return iprt status code.
|
---|
1243 | * @param Sock Socket descriptor.
|
---|
1244 | * @param pvBuffer Where to put the data we read.
|
---|
1245 | * @param cbBuffer Read buffer size.
|
---|
1246 | * @param pcbRead Number of bytes read.
|
---|
1247 | */
|
---|
1248 | DECLR3CALLBACKMEMBER(int, pfnReadNB, (VDSOCKET Sock, void *pvBuffer, size_t cbBuffer, size_t *pcbRead));
|
---|
1249 |
|
---|
1250 | /**
|
---|
1251 | * Send data to a socket - not blocking.
|
---|
1252 | *
|
---|
1253 | * @return iprt status code.
|
---|
1254 | * @param Sock Socket descriptor.
|
---|
1255 | * @param pvBuffer Buffer to write data to socket.
|
---|
1256 | * @param cbBuffer How much to write.
|
---|
1257 | * @param pcbWritten Number of bytes written.
|
---|
1258 | */
|
---|
1259 | DECLR3CALLBACKMEMBER(int, pfnWriteNB, (VDSOCKET Sock, const void *pvBuffer, size_t cbBuffer, size_t *pcbWritten));
|
---|
1260 |
|
---|
1261 | /**
|
---|
1262 | * Send data from scatter/gather buffer to a socket - not blocking.
|
---|
1263 | *
|
---|
1264 | * @return iprt status code.
|
---|
1265 | * @param Sock Socket descriptor.
|
---|
1266 | * @param pSgBuffer Scatter/gather buffer to write data to socket.
|
---|
1267 | * @param pcbWritten Number of bytes written.
|
---|
1268 | */
|
---|
1269 | DECLR3CALLBACKMEMBER(int, pfnSgWriteNB, (VDSOCKET Sock, PRTSGBUF pSgBuffer, size_t *pcbWritten));
|
---|
1270 |
|
---|
1271 | /**
|
---|
1272 | * Flush socket write buffers.
|
---|
1273 | *
|
---|
1274 | * @return iprt status code.
|
---|
1275 | * @param Sock Socket descriptor.
|
---|
1276 | */
|
---|
1277 | DECLR3CALLBACKMEMBER(int, pfnFlush, (VDSOCKET Sock));
|
---|
1278 |
|
---|
1279 | /**
|
---|
1280 | * Enables or disables delaying sends to coalesce packets.
|
---|
1281 | *
|
---|
1282 | * @return iprt status code.
|
---|
1283 | * @param Sock Socket descriptor.
|
---|
1284 | * @param fEnable When set to true enables coalescing.
|
---|
1285 | */
|
---|
1286 | DECLR3CALLBACKMEMBER(int, pfnSetSendCoalescing, (VDSOCKET Sock, bool fEnable));
|
---|
1287 |
|
---|
1288 | /**
|
---|
1289 | * Gets the address of the local side.
|
---|
1290 | *
|
---|
1291 | * @return iprt status code.
|
---|
1292 | * @param Sock Socket descriptor.
|
---|
1293 | * @param pAddr Where to store the local address on success.
|
---|
1294 | */
|
---|
1295 | DECLR3CALLBACKMEMBER(int, pfnGetLocalAddress, (VDSOCKET Sock, PRTNETADDR pAddr));
|
---|
1296 |
|
---|
1297 | /**
|
---|
1298 | * Gets the address of the other party.
|
---|
1299 | *
|
---|
1300 | * @return iprt status code.
|
---|
1301 | * @param Sock Socket descriptor.
|
---|
1302 | * @param pAddr Where to store the peer address on success.
|
---|
1303 | */
|
---|
1304 | DECLR3CALLBACKMEMBER(int, pfnGetPeerAddress, (VDSOCKET Sock, PRTNETADDR pAddr));
|
---|
1305 |
|
---|
1306 | /**
|
---|
1307 | * Socket I/O multiplexing - extended version which can be woken up.
|
---|
1308 | * Checks if the socket is ready for reading or writing.
|
---|
1309 | *
|
---|
1310 | * @return iprt status code.
|
---|
1311 | * @retval VERR_INTERRUPTED if the thread was woken up by a pfnPoke call.
|
---|
1312 | * @param Sock Socket descriptor.
|
---|
1313 | * @param fEvents Mask of events to wait for.
|
---|
1314 | * @param pfEvents Where to store the received events.
|
---|
1315 | * @param cMillies Number of milliseconds to wait for the socket.
|
---|
1316 | * Use RT_INDEFINITE_WAIT to wait for ever.
|
---|
1317 | */
|
---|
1318 | DECLR3CALLBACKMEMBER(int, pfnSelectOneEx, (VDSOCKET Sock, uint32_t fEvents,
|
---|
1319 | uint32_t *pfEvents, RTMSINTERVAL cMillies));
|
---|
1320 |
|
---|
1321 | /**
|
---|
1322 | * Wakes up the thread waiting in pfnSelectOneEx.
|
---|
1323 | *
|
---|
1324 | * @return iprt status code.
|
---|
1325 | * @param Sock Socket descriptor.
|
---|
1326 | */
|
---|
1327 | DECLR3CALLBACKMEMBER(int, pfnPoke, (VDSOCKET Sock));
|
---|
1328 |
|
---|
1329 | } VDINTERFACETCPNET, *PVDINTERFACETCPNET;
|
---|
1330 |
|
---|
1331 | /**
|
---|
1332 | * Get TCP network stack interface from opaque callback table.
|
---|
1333 | *
|
---|
1334 | * @return Pointer to the callback table.
|
---|
1335 | * @param pInterface Pointer to the interface descriptor.
|
---|
1336 | */
|
---|
1337 | DECLINLINE(PVDINTERFACETCPNET) VDGetInterfaceTcpNet(PVDINTERFACE pInterface)
|
---|
1338 | {
|
---|
1339 | PVDINTERFACETCPNET pInterfaceTcpNet;
|
---|
1340 |
|
---|
1341 | /* Check that the interface descriptor is a TCP network stack interface. */
|
---|
1342 | AssertMsgReturn( (pInterface->enmInterface == VDINTERFACETYPE_TCPNET)
|
---|
1343 | && (pInterface->cbSize == sizeof(VDINTERFACE)),
|
---|
1344 | ("Not a TCP network stack interface"), NULL);
|
---|
1345 |
|
---|
1346 | pInterfaceTcpNet = (PVDINTERFACETCPNET)pInterface->pCallbacks;
|
---|
1347 |
|
---|
1348 | /* Do basic checks. */
|
---|
1349 | AssertMsgReturn( (pInterfaceTcpNet->cbSize == sizeof(VDINTERFACETCPNET))
|
---|
1350 | && (pInterfaceTcpNet->enmInterface == VDINTERFACETYPE_TCPNET),
|
---|
1351 | ("A non TCP network stack callback table attached to a TCP network stack interface descriptor\n"), NULL);
|
---|
1352 |
|
---|
1353 | return pInterfaceTcpNet;
|
---|
1354 | }
|
---|
1355 |
|
---|
1356 | /**
|
---|
1357 | * Interface to get the parent state.
|
---|
1358 | *
|
---|
1359 | * Per-operation interface. Optional, present only if there is a parent, and
|
---|
1360 | * used only internally for compacting.
|
---|
1361 | */
|
---|
1362 | typedef struct VDINTERFACEPARENTSTATE
|
---|
1363 | {
|
---|
1364 | /**
|
---|
1365 | * Size of the parent state interface.
|
---|
1366 | */
|
---|
1367 | uint32_t cbSize;
|
---|
1368 |
|
---|
1369 | /**
|
---|
1370 | * Interface type.
|
---|
1371 | */
|
---|
1372 | VDINTERFACETYPE enmInterface;
|
---|
1373 |
|
---|
1374 | /**
|
---|
1375 | * Read data callback.
|
---|
1376 | *
|
---|
1377 | * @return VBox status code.
|
---|
1378 | * @return VERR_VD_NOT_OPENED if no image is opened in HDD container.
|
---|
1379 | * @param pvUser The opaque data passed for the operation.
|
---|
1380 | * @param uOffset Offset of first reading byte from start of disk.
|
---|
1381 | * Must be aligned to a sector boundary.
|
---|
1382 | * @param pvBuffer Pointer to buffer for reading data.
|
---|
1383 | * @param cbBuffer Number of bytes to read.
|
---|
1384 | * Must be aligned to a sector boundary.
|
---|
1385 | */
|
---|
1386 | DECLR3CALLBACKMEMBER(int, pfnParentRead, (void *pvUser, uint64_t uOffset, void *pvBuffer, size_t cbBuffer));
|
---|
1387 |
|
---|
1388 | } VDINTERFACEPARENTSTATE, *PVDINTERFACEPARENTSTATE;
|
---|
1389 |
|
---|
1390 |
|
---|
1391 | /**
|
---|
1392 | * Get parent state interface from opaque callback table.
|
---|
1393 | *
|
---|
1394 | * @return Pointer to the callback table.
|
---|
1395 | * @param pInterface Pointer to the interface descriptor.
|
---|
1396 | */
|
---|
1397 | DECLINLINE(PVDINTERFACEPARENTSTATE) VDGetInterfaceParentState(PVDINTERFACE pInterface)
|
---|
1398 | {
|
---|
1399 | PVDINTERFACEPARENTSTATE pInterfaceParentState;
|
---|
1400 |
|
---|
1401 | /* Check that the interface descriptor is a parent state interface. */
|
---|
1402 | AssertMsgReturn( (pInterface->enmInterface == VDINTERFACETYPE_PARENTSTATE)
|
---|
1403 | && (pInterface->cbSize == sizeof(VDINTERFACE)),
|
---|
1404 | ("Not a parent state interface"), NULL);
|
---|
1405 |
|
---|
1406 | pInterfaceParentState = (PVDINTERFACEPARENTSTATE)pInterface->pCallbacks;
|
---|
1407 |
|
---|
1408 | /* Do basic checks. */
|
---|
1409 | AssertMsgReturn( (pInterfaceParentState->cbSize == sizeof(VDINTERFACEPARENTSTATE))
|
---|
1410 | && (pInterfaceParentState->enmInterface == VDINTERFACETYPE_PARENTSTATE),
|
---|
1411 | ("A non parent state callback table attached to a parent state interface descriptor\n"), NULL);
|
---|
1412 |
|
---|
1413 | return pInterfaceParentState;
|
---|
1414 | }
|
---|
1415 |
|
---|
1416 | /**
|
---|
1417 | * Interface to synchronize concurrent accesses by several threads.
|
---|
1418 | *
|
---|
1419 | * @note The scope of this interface is to manage concurrent accesses after
|
---|
1420 | * the HDD container has been created, and they must stop before destroying the
|
---|
1421 | * container. Opening or closing images is covered by the synchronization, but
|
---|
1422 | * that does not mean it is safe to close images while a thread executes
|
---|
1423 | * <link to="VDMerge"/> or <link to="VDCopy"/> operating on these images.
|
---|
1424 | * Making them safe would require the lock to be held during the entire
|
---|
1425 | * operation, which prevents other concurrent acitivities.
|
---|
1426 | *
|
---|
1427 | * @note Right now this is kept as simple as possible, and does not even
|
---|
1428 | * attempt to provide enough information to allow e.g. concurrent write
|
---|
1429 | * accesses to different areas of the disk. The reason is that it is very
|
---|
1430 | * difficult to predict which area of a disk is affected by a write,
|
---|
1431 | * especially when different image formats are mixed. Maybe later a more
|
---|
1432 | * sophisticated interface will be provided which has the necessary information
|
---|
1433 | * about worst case affected areas.
|
---|
1434 | *
|
---|
1435 | * Per-disk interface. Optional, needed if the disk is accessed concurrently
|
---|
1436 | * by several threads, e.g. when merging diff images while a VM is running.
|
---|
1437 | */
|
---|
1438 | typedef struct VDINTERFACETHREADSYNC
|
---|
1439 | {
|
---|
1440 | /**
|
---|
1441 | * Size of the thread synchronization interface.
|
---|
1442 | */
|
---|
1443 | uint32_t cbSize;
|
---|
1444 |
|
---|
1445 | /**
|
---|
1446 | * Interface type.
|
---|
1447 | */
|
---|
1448 | VDINTERFACETYPE enmInterface;
|
---|
1449 |
|
---|
1450 | /**
|
---|
1451 | * Start a read operation.
|
---|
1452 | */
|
---|
1453 | DECLR3CALLBACKMEMBER(int, pfnStartRead, (void *pvUser));
|
---|
1454 |
|
---|
1455 | /**
|
---|
1456 | * Finish a read operation.
|
---|
1457 | */
|
---|
1458 | DECLR3CALLBACKMEMBER(int, pfnFinishRead, (void *pvUser));
|
---|
1459 |
|
---|
1460 | /**
|
---|
1461 | * Start a write operation.
|
---|
1462 | */
|
---|
1463 | DECLR3CALLBACKMEMBER(int, pfnStartWrite, (void *pvUser));
|
---|
1464 |
|
---|
1465 | /**
|
---|
1466 | * Finish a write operation.
|
---|
1467 | */
|
---|
1468 | DECLR3CALLBACKMEMBER(int, pfnFinishWrite, (void *pvUser));
|
---|
1469 |
|
---|
1470 | } VDINTERFACETHREADSYNC, *PVDINTERFACETHREADSYNC;
|
---|
1471 |
|
---|
1472 | /**
|
---|
1473 | * Get thread synchronization interface from opaque callback table.
|
---|
1474 | *
|
---|
1475 | * @return Pointer to the callback table.
|
---|
1476 | * @param pInterface Pointer to the interface descriptor.
|
---|
1477 | */
|
---|
1478 | DECLINLINE(PVDINTERFACETHREADSYNC) VDGetInterfaceThreadSync(PVDINTERFACE pInterface)
|
---|
1479 | {
|
---|
1480 | PVDINTERFACETHREADSYNC pInterfaceThreadSync;
|
---|
1481 |
|
---|
1482 | /* Check that the interface descriptor is a thread synchronization interface. */
|
---|
1483 | AssertMsgReturn( (pInterface->enmInterface == VDINTERFACETYPE_THREADSYNC)
|
---|
1484 | && (pInterface->cbSize == sizeof(VDINTERFACE)),
|
---|
1485 | ("Not a thread synchronization interface"), NULL);
|
---|
1486 |
|
---|
1487 | pInterfaceThreadSync = (PVDINTERFACETHREADSYNC)pInterface->pCallbacks;
|
---|
1488 |
|
---|
1489 | /* Do basic checks. */
|
---|
1490 | AssertMsgReturn( (pInterfaceThreadSync->cbSize == sizeof(VDINTERFACETHREADSYNC))
|
---|
1491 | && (pInterfaceThreadSync->enmInterface == VDINTERFACETYPE_THREADSYNC),
|
---|
1492 | ("A non thread synchronization callback table attached to a thread synchronization interface descriptor\n"), NULL);
|
---|
1493 |
|
---|
1494 | return pInterfaceThreadSync;
|
---|
1495 | }
|
---|
1496 |
|
---|
1497 | /** @name Configuration interface key handling flags.
|
---|
1498 | * @{
|
---|
1499 | */
|
---|
1500 | /** Mandatory config key. Not providing a value for this key will cause
|
---|
1501 | * the backend to fail. */
|
---|
1502 | #define VD_CFGKEY_MANDATORY RT_BIT(0)
|
---|
1503 | /** Expert config key. Not showing it by default in the GUI is is probably
|
---|
1504 | * a good idea, as the average user won't understand it easily. */
|
---|
1505 | #define VD_CFGKEY_EXPERT RT_BIT(1)
|
---|
1506 | /** @}*/
|
---|
1507 |
|
---|
1508 |
|
---|
1509 | /**
|
---|
1510 | * Configuration value type for configuration information interface.
|
---|
1511 | */
|
---|
1512 | typedef enum VDCFGVALUETYPE
|
---|
1513 | {
|
---|
1514 | /** Integer value. */
|
---|
1515 | VDCFGVALUETYPE_INTEGER = 1,
|
---|
1516 | /** String value. */
|
---|
1517 | VDCFGVALUETYPE_STRING,
|
---|
1518 | /** Bytestring value. */
|
---|
1519 | VDCFGVALUETYPE_BYTES
|
---|
1520 | } VDCFGVALUETYPE;
|
---|
1521 |
|
---|
1522 |
|
---|
1523 | /**
|
---|
1524 | * Structure describing configuration keys required/supported by a backend
|
---|
1525 | * through the config interface.
|
---|
1526 | */
|
---|
1527 | typedef struct VDCONFIGINFO
|
---|
1528 | {
|
---|
1529 | /** Key name of the configuration. */
|
---|
1530 | const char *pszKey;
|
---|
1531 | /** Pointer to default value (descriptor). NULL if no useful default value
|
---|
1532 | * can be specified. */
|
---|
1533 | const char *pszDefaultValue;
|
---|
1534 | /** Value type for this key. */
|
---|
1535 | VDCFGVALUETYPE enmValueType;
|
---|
1536 | /** Key handling flags (a combination of VD_CFGKEY_* flags). */
|
---|
1537 | uint64_t uKeyFlags;
|
---|
1538 | } VDCONFIGINFO;
|
---|
1539 |
|
---|
1540 | /** Pointer to structure describing configuration keys. */
|
---|
1541 | typedef VDCONFIGINFO *PVDCONFIGINFO;
|
---|
1542 |
|
---|
1543 | /** Pointer to const structure describing configuration keys. */
|
---|
1544 | typedef const VDCONFIGINFO *PCVDCONFIGINFO;
|
---|
1545 |
|
---|
1546 | /**
|
---|
1547 | * Structure describing a file extension.
|
---|
1548 | */
|
---|
1549 | typedef struct VDFILEEXTENSION
|
---|
1550 | {
|
---|
1551 | /** Pointer to the NULL-terminated string containing the extension. */
|
---|
1552 | const char *pszExtension;
|
---|
1553 | /** The device type the extension supports. */
|
---|
1554 | VDTYPE enmType;
|
---|
1555 | } VDFILEEXTENSION;
|
---|
1556 |
|
---|
1557 | /** Pointer to a structure describing a file extension. */
|
---|
1558 | typedef VDFILEEXTENSION *PVDFILEEXTENSION;
|
---|
1559 |
|
---|
1560 | /** Pointer to a const structure describing a file extension. */
|
---|
1561 | typedef const VDFILEEXTENSION *PCVDFILEEXTENSION;
|
---|
1562 |
|
---|
1563 | /**
|
---|
1564 | * Data structure for returning a list of backend capabilities.
|
---|
1565 | */
|
---|
1566 | typedef struct VDBACKENDINFO
|
---|
1567 | {
|
---|
1568 | /** Name of the backend. Must be unique even with case insensitive comparison. */
|
---|
1569 | const char *pszBackend;
|
---|
1570 | /** Capabilities of the backend (a combination of the VD_CAP_* flags). */
|
---|
1571 | uint64_t uBackendCaps;
|
---|
1572 | /** Pointer to a NULL-terminated array of strings, containing the supported
|
---|
1573 | * file extensions. Note that some backends do not work on files, so this
|
---|
1574 | * pointer may just contain NULL. */
|
---|
1575 | PCVDFILEEXTENSION paFileExtensions;
|
---|
1576 | /** Pointer to an array of structs describing each supported config key.
|
---|
1577 | * Terminated by a NULL config key. Note that some backends do not support
|
---|
1578 | * the configuration interface, so this pointer may just contain NULL.
|
---|
1579 | * Mandatory if the backend sets VD_CAP_CONFIG. */
|
---|
1580 | PCVDCONFIGINFO paConfigInfo;
|
---|
1581 | /** Returns a human readable hard disk location string given a
|
---|
1582 | * set of hard disk configuration keys. The returned string is an
|
---|
1583 | * equivalent of the full file path for image-based hard disks.
|
---|
1584 | * Mandatory for backends with no VD_CAP_FILE and NULL otherwise. */
|
---|
1585 | DECLR3CALLBACKMEMBER(int, pfnComposeLocation, (PVDINTERFACE pConfig, char **pszLocation));
|
---|
1586 | /** Returns a human readable hard disk name string given a
|
---|
1587 | * set of hard disk configuration keys. The returned string is an
|
---|
1588 | * equivalent of the file name part in the full file path for
|
---|
1589 | * image-based hard disks. Mandatory for backends with no
|
---|
1590 | * VD_CAP_FILE and NULL otherwise. */
|
---|
1591 | DECLR3CALLBACKMEMBER(int, pfnComposeName, (PVDINTERFACE pConfig, char **pszName));
|
---|
1592 | } VDBACKENDINFO, *PVDBACKENDINFO;
|
---|
1593 |
|
---|
1594 |
|
---|
1595 | /** Forward declaration. Only visible in the VBoxHDD module. */
|
---|
1596 | /** I/O context */
|
---|
1597 | typedef struct VDIOCTX *PVDIOCTX;
|
---|
1598 | /** Storage backend handle. */
|
---|
1599 | typedef struct VDIOSTORAGE *PVDIOSTORAGE;
|
---|
1600 | /** Pointer to a storage backend handle. */
|
---|
1601 | typedef PVDIOSTORAGE *PPVDIOSTORAGE;
|
---|
1602 |
|
---|
1603 | /**
|
---|
1604 | * Completion callback for meta/userdata reads or writes.
|
---|
1605 | *
|
---|
1606 | * @return VBox status code.
|
---|
1607 | * VINF_SUCCESS if everything was successful and the transfer can continue.
|
---|
1608 | * VERR_VD_ASYNC_IO_IN_PROGRESS if there is another data transfer pending.
|
---|
1609 | * @param pBackendData The opaque backend data.
|
---|
1610 | * @param pIoCtx I/O context associated with this request.
|
---|
1611 | * @param pvUser Opaque user data passed during a read/write request.
|
---|
1612 | * @param rcReq Status code for the completed request.
|
---|
1613 | */
|
---|
1614 | typedef DECLCALLBACK(int) FNVDXFERCOMPLETED(void *pBackendData, PVDIOCTX pIoCtx, void *pvUser, int rcReq);
|
---|
1615 | /** Pointer to FNVDXFERCOMPLETED() */
|
---|
1616 | typedef FNVDXFERCOMPLETED *PFNVDXFERCOMPLETED;
|
---|
1617 |
|
---|
1618 | /** Metadata transfer handle. */
|
---|
1619 | typedef struct VDMETAXFER *PVDMETAXFER;
|
---|
1620 | /** Pointer to a metadata transfer handle. */
|
---|
1621 | typedef PVDMETAXFER *PPVDMETAXFER;
|
---|
1622 |
|
---|
1623 |
|
---|
1624 | /**
|
---|
1625 | * Internal I/O interface between the generic VD layer and the backends.
|
---|
1626 | *
|
---|
1627 | * Per-image. Always passed to backends.
|
---|
1628 | */
|
---|
1629 | typedef struct VDINTERFACEIOINT
|
---|
1630 | {
|
---|
1631 | /**
|
---|
1632 | * Size of the internal I/O interface.
|
---|
1633 | */
|
---|
1634 | uint32_t cbSize;
|
---|
1635 |
|
---|
1636 | /**
|
---|
1637 | * Interface type.
|
---|
1638 | */
|
---|
1639 | VDINTERFACETYPE enmInterface;
|
---|
1640 |
|
---|
1641 | /**
|
---|
1642 | * Open callback
|
---|
1643 | *
|
---|
1644 | * @return VBox status code.
|
---|
1645 | * @param pvUser The opaque data passed on container creation.
|
---|
1646 | * @param pszLocation Name of the location to open.
|
---|
1647 | * @param fOpen Flags for opening the backend.
|
---|
1648 | * See RTFILE_O_* #defines, inventing another set
|
---|
1649 | * of open flags is not worth the mapping effort.
|
---|
1650 | * @param ppStorage Where to store the storage handle.
|
---|
1651 | */
|
---|
1652 | DECLR3CALLBACKMEMBER(int, pfnOpen, (void *pvUser, const char *pszLocation,
|
---|
1653 | uint32_t fOpen, PPVDIOSTORAGE ppStorage));
|
---|
1654 |
|
---|
1655 | /**
|
---|
1656 | * Close callback.
|
---|
1657 | *
|
---|
1658 | * @return VBox status code.
|
---|
1659 | * @param pvUser The opaque data passed on container creation.
|
---|
1660 | * @param pStorage The storage handle to close.
|
---|
1661 | */
|
---|
1662 | DECLR3CALLBACKMEMBER(int, pfnClose, (void *pvUser, PVDIOSTORAGE pStorage));
|
---|
1663 |
|
---|
1664 | /**
|
---|
1665 | * Delete callback.
|
---|
1666 | *
|
---|
1667 | * @return VBox status code.
|
---|
1668 | * @param pvUser The opaque data passed on container creation.
|
---|
1669 | * @param pcszFilename Name of the file to delete.
|
---|
1670 | */
|
---|
1671 | DECLR3CALLBACKMEMBER(int, pfnDelete, (void *pvUser, const char *pcszFilename));
|
---|
1672 |
|
---|
1673 | /**
|
---|
1674 | * Move callback.
|
---|
1675 | *
|
---|
1676 | * @return VBox status code.
|
---|
1677 | * @param pvUser The opaque data passed on container creation.
|
---|
1678 | * @param pcszSrc The path to the source file.
|
---|
1679 | * @param pcszDst The path to the destination file.
|
---|
1680 | * This file will be created.
|
---|
1681 | * @param fMove A combination of the RTFILEMOVE_* flags.
|
---|
1682 | */
|
---|
1683 | DECLR3CALLBACKMEMBER(int, pfnMove, (void *pvUser, const char *pcszSrc, const char *pcszDst, unsigned fMove));
|
---|
1684 |
|
---|
1685 | /**
|
---|
1686 | * Returns the free space on a disk.
|
---|
1687 | *
|
---|
1688 | * @return VBox status code.
|
---|
1689 | * @param pvUser The opaque data passed on container creation.
|
---|
1690 | * @param pcszFilename Name of a file to identify the disk.
|
---|
1691 | * @param pcbFreeSpace Where to store the free space of the disk.
|
---|
1692 | */
|
---|
1693 | DECLR3CALLBACKMEMBER(int, pfnGetFreeSpace, (void *pvUser, const char *pcszFilename, int64_t *pcbFreeSpace));
|
---|
1694 |
|
---|
1695 | /**
|
---|
1696 | * Returns the last modification timestamp of a file.
|
---|
1697 | *
|
---|
1698 | * @return VBox status code.
|
---|
1699 | * @param pvUser The opaque data passed on container creation.
|
---|
1700 | * @param pcszFilename Name of a file to identify the disk.
|
---|
1701 | * @param pModificationTime Where to store the timestamp of the file.
|
---|
1702 | */
|
---|
1703 | DECLR3CALLBACKMEMBER(int, pfnGetModificationTime, (void *pvUser, const char *pcszFilename, PRTTIMESPEC pModificationTime));
|
---|
1704 |
|
---|
1705 | /**
|
---|
1706 | * Returns the size of the opened storage backend.
|
---|
1707 | *
|
---|
1708 | * @return VBox status code.
|
---|
1709 | * @param pvUser The opaque data passed on container creation.
|
---|
1710 | * @param pStorage The storage handle to get the size from.
|
---|
1711 | * @param pcbSize Where to store the size of the storage backend.
|
---|
1712 | */
|
---|
1713 | DECLR3CALLBACKMEMBER(int, pfnGetSize, (void *pvUser, PVDIOSTORAGE pStorage,
|
---|
1714 | uint64_t *pcbSize));
|
---|
1715 |
|
---|
1716 | /**
|
---|
1717 | * Sets the size of the opened storage backend if possible.
|
---|
1718 | *
|
---|
1719 | * @return VBox status code.
|
---|
1720 | * @retval VERR_NOT_SUPPORTED if the backend does not support this operation.
|
---|
1721 | * @param pvUser The opaque data passed on container creation.
|
---|
1722 | * @param pStorage The storage handle.
|
---|
1723 | * @param cbSize The new size of the image.
|
---|
1724 | */
|
---|
1725 | DECLR3CALLBACKMEMBER(int, pfnSetSize, (void *pvUser, PVDIOSTORAGE pStorage,
|
---|
1726 | uint64_t cbSize));
|
---|
1727 |
|
---|
1728 | /**
|
---|
1729 | * Synchronous write callback.
|
---|
1730 | *
|
---|
1731 | * @return VBox status code.
|
---|
1732 | * @param pvUser The opaque data passed on container creation.
|
---|
1733 | * @param pStorage The storage handle to use.
|
---|
1734 | * @param uOffset The offset to start from.
|
---|
1735 | * @param pvBuffer Pointer to the bits need to be written.
|
---|
1736 | * @param cbBuffer How many bytes to write.
|
---|
1737 | * @param pcbWritten Where to store how many bytes were actually written.
|
---|
1738 | *
|
---|
1739 | * @notes Do not use in code called from the async read/write entry points in the backends.
|
---|
1740 | * This should be only used during open/close of images and for the support functions
|
---|
1741 | * which are not called while a VM is running (pfnCompact).
|
---|
1742 | */
|
---|
1743 | DECLR3CALLBACKMEMBER(int, pfnWriteSync, (void *pvUser, PVDIOSTORAGE pStorage, uint64_t uOffset,
|
---|
1744 | const void *pvBuffer, size_t cbBuffer, size_t *pcbWritten));
|
---|
1745 |
|
---|
1746 | /**
|
---|
1747 | * Synchronous read callback.
|
---|
1748 | *
|
---|
1749 | * @return VBox status code.
|
---|
1750 | * @param pvUser The opaque data passed on container creation.
|
---|
1751 | * @param pStorage The storage handle to use.
|
---|
1752 | * @param uOffset The offset to start from.
|
---|
1753 | * @param pvBuffer Where to store the read bits.
|
---|
1754 | * @param cbBuffer How many bytes to read.
|
---|
1755 | * @param pcbRead Where to store how many bytes were actually read.
|
---|
1756 | *
|
---|
1757 | * @notes See pfnWriteSync()
|
---|
1758 | */
|
---|
1759 | DECLR3CALLBACKMEMBER(int, pfnReadSync, (void *pvUser, PVDIOSTORAGE pStorage, uint64_t uOffset,
|
---|
1760 | void *pvBuffer, size_t cbBuffer, size_t *pcbRead));
|
---|
1761 |
|
---|
1762 | /**
|
---|
1763 | * Flush data to the storage backend.
|
---|
1764 | *
|
---|
1765 | * @return VBox status code.
|
---|
1766 | * @param pvUser The opaque data passed on container creation.
|
---|
1767 | * @param pStorage The storage handle to flush.
|
---|
1768 | *
|
---|
1769 | * @notes See pfnWriteSync()
|
---|
1770 | */
|
---|
1771 | DECLR3CALLBACKMEMBER(int, pfnFlushSync, (void *pvUser, PVDIOSTORAGE pStorage));
|
---|
1772 |
|
---|
1773 | /**
|
---|
1774 | * Initiate an asynchronous read request for user data.
|
---|
1775 | *
|
---|
1776 | * @return VBox status code.
|
---|
1777 | * @param pvUser The opaque user data passed on container creation.
|
---|
1778 | * @param pStorage The storage handle.
|
---|
1779 | * @param uOffset The offset to start reading from.
|
---|
1780 | * @param pIoCtx I/O context passed in VDAsyncRead/Write.
|
---|
1781 | * @param cbRead How many bytes to read.
|
---|
1782 | */
|
---|
1783 | DECLR3CALLBACKMEMBER(int, pfnReadUserAsync, (void *pvUser, PVDIOSTORAGE pStorage,
|
---|
1784 | uint64_t uOffset, PVDIOCTX pIoCtx,
|
---|
1785 | size_t cbRead));
|
---|
1786 |
|
---|
1787 | /**
|
---|
1788 | * Initiate an asynchronous write request for user data.
|
---|
1789 | *
|
---|
1790 | * @return VBox status code.
|
---|
1791 | * @param pvUser The opaque user data passed on container creation.
|
---|
1792 | * @param pStorage The storage handle.
|
---|
1793 | * @param uOffset The offset to start writing to.
|
---|
1794 | * @param pIoCtx I/O context passed in VDAsyncRead/Write
|
---|
1795 | * @param cbWrite How many bytes to write.
|
---|
1796 | * @param pfnCompleted Completion callback.
|
---|
1797 | * @param pvCompleteUser Opaque user data passed in the completion callback.
|
---|
1798 | */
|
---|
1799 | DECLR3CALLBACKMEMBER(int, pfnWriteUserAsync, (void *pvUser, PVDIOSTORAGE pStorage,
|
---|
1800 | uint64_t uOffset, PVDIOCTX pIoCtx,
|
---|
1801 | size_t cbWrite,
|
---|
1802 | PFNVDXFERCOMPLETED pfnComplete,
|
---|
1803 | void *pvCompleteUser));
|
---|
1804 |
|
---|
1805 | /**
|
---|
1806 | * Reads metadata asynchronously from storage.
|
---|
1807 | * The current I/O context will be halted.
|
---|
1808 | *
|
---|
1809 | * @returns VBox status code.
|
---|
1810 | * @param pvUser The opaque user data passed on container creation.
|
---|
1811 | * @param pStorage The storage handle.
|
---|
1812 | * @param uOffset Offset to start reading from.
|
---|
1813 | * @param pvBuffer Where to store the data.
|
---|
1814 | * @param cbBuffer How many bytes to read.
|
---|
1815 | * @param pIoCtx The I/O context which triggered the read.
|
---|
1816 | * @param ppMetaXfer Where to store the metadata transfer handle on success.
|
---|
1817 | * @param pfnCompleted Completion callback.
|
---|
1818 | * @param pvCompleteUser Opaque user data passed in the completion callback.
|
---|
1819 | */
|
---|
1820 | DECLR3CALLBACKMEMBER(int, pfnReadMetaAsync, (void *pvUser, PVDIOSTORAGE pStorage,
|
---|
1821 | uint64_t uOffset, void *pvBuffer,
|
---|
1822 | size_t cbBuffer, PVDIOCTX pIoCtx,
|
---|
1823 | PPVDMETAXFER ppMetaXfer,
|
---|
1824 | PFNVDXFERCOMPLETED pfnComplete,
|
---|
1825 | void *pvCompleteUser));
|
---|
1826 |
|
---|
1827 | /**
|
---|
1828 | * Writes metadata asynchronously to storage.
|
---|
1829 | *
|
---|
1830 | * @returns VBox status code.
|
---|
1831 | * @param pvUser The opaque user data passed on container creation.
|
---|
1832 | * @param pStorage The storage handle.
|
---|
1833 | * @param uOffset Offset to start writing to.
|
---|
1834 | * @param pvBuffer Written data.
|
---|
1835 | * @param cbBuffer How many bytes to write.
|
---|
1836 | * @param pIoCtx The I/O context which triggered the write.
|
---|
1837 | * @param pfnCompleted Completion callback.
|
---|
1838 | * @param pvCompleteUser Opaque user data passed in the completion callback.
|
---|
1839 | */
|
---|
1840 | DECLR3CALLBACKMEMBER(int, pfnWriteMetaAsync, (void *pvUser, PVDIOSTORAGE pStorage,
|
---|
1841 | uint64_t uOffset, void *pvBuffer,
|
---|
1842 | size_t cbBuffer, PVDIOCTX pIoCtx,
|
---|
1843 | PFNVDXFERCOMPLETED pfnComplete,
|
---|
1844 | void *pvCompleteUser));
|
---|
1845 |
|
---|
1846 | /**
|
---|
1847 | * Releases a metadata transfer handle.
|
---|
1848 | * The free space can be used for another transfer.
|
---|
1849 | *
|
---|
1850 | * @returns nothing.
|
---|
1851 | * @param pvUser The opaque user data passed on container creation.
|
---|
1852 | * @param pMetaXfer The metadata transfer handle to release.
|
---|
1853 | */
|
---|
1854 | DECLR3CALLBACKMEMBER(void, pfnMetaXferRelease, (void *pvUser, PVDMETAXFER pMetaXfer));
|
---|
1855 |
|
---|
1856 | /**
|
---|
1857 | * Initiates an async flush request.
|
---|
1858 | *
|
---|
1859 | * @return VBox status code.
|
---|
1860 | * @param pvUser The opaque data passed on container creation.
|
---|
1861 | * @param pStorage The storage handle to flush.
|
---|
1862 | * @param pIoCtx I/O context which triggered the flush.
|
---|
1863 | * @param pfnCompleted Completion callback.
|
---|
1864 | * @param pvCompleteUser Opaque user data passed in the completion callback.
|
---|
1865 | */
|
---|
1866 | DECLR3CALLBACKMEMBER(int, pfnFlushAsync, (void *pvUser, PVDIOSTORAGE pStorage,
|
---|
1867 | PVDIOCTX pIoCtx,
|
---|
1868 | PFNVDXFERCOMPLETED pfnComplete,
|
---|
1869 | void *pvCompleteUser));
|
---|
1870 |
|
---|
1871 | /**
|
---|
1872 | * Copies a buffer into the I/O context.
|
---|
1873 | *
|
---|
1874 | * @return Number of bytes copied.
|
---|
1875 | * @param pvUser The opaque user data passed on container creation.
|
---|
1876 | * @param pIoCtx I/O context to copy the data to.
|
---|
1877 | * @param pvBuffer Buffer to copy.
|
---|
1878 | * @param cbBuffer Number of bytes to copy.
|
---|
1879 | */
|
---|
1880 | DECLR3CALLBACKMEMBER(size_t, pfnIoCtxCopyTo, (void *pvUser, PVDIOCTX pIoCtx,
|
---|
1881 | void *pvBuffer, size_t cbBuffer));
|
---|
1882 |
|
---|
1883 | /**
|
---|
1884 | * Copies data from the I/O context into a buffer.
|
---|
1885 | *
|
---|
1886 | * @return Number of bytes copied.
|
---|
1887 | * @param pvUser The opaque user data passed on container creation.
|
---|
1888 | * @param pIoCtx I/O context to copy the data from.
|
---|
1889 | * @param pvBuffer Destination buffer.
|
---|
1890 | * @param cbBuffer Number of bytes to copy.
|
---|
1891 | */
|
---|
1892 | DECLR3CALLBACKMEMBER(size_t, pfnIoCtxCopyFrom, (void *pvUser, PVDIOCTX pIoCtx,
|
---|
1893 | void *pvBuffer, size_t cbBuffer));
|
---|
1894 |
|
---|
1895 | /**
|
---|
1896 | * Sets the buffer of the given context to a specific byte.
|
---|
1897 | *
|
---|
1898 | * @return Number of bytes set.
|
---|
1899 | * @param pvUser The opaque user data passed on container creation.
|
---|
1900 | * @param pIoCtx I/O context to copy the data from.
|
---|
1901 | * @param ch The byte to set.
|
---|
1902 | * @param cbSet Number of bytes to set.
|
---|
1903 | */
|
---|
1904 | DECLR3CALLBACKMEMBER(size_t, pfnIoCtxSet, (void *pvUser, PVDIOCTX pIoCtx,
|
---|
1905 | int ch, size_t cbSet));
|
---|
1906 |
|
---|
1907 | /**
|
---|
1908 | * Creates a segment array from the I/O context data buffer.
|
---|
1909 | *
|
---|
1910 | * @returns Number of bytes the array describes.
|
---|
1911 | * @param pvUser The opaque user data passed on container creation.
|
---|
1912 | * @param pIoCtx I/O context to copy the data from.
|
---|
1913 | * @param paSeg The uninitialized segment array.
|
---|
1914 | * If NULL pcSeg will contain the number of segments needed
|
---|
1915 | * to describe the requested amount of data.
|
---|
1916 | * @param pcSeg The number of segments the given array has.
|
---|
1917 | * This will hold the actual number of entries needed upon return.
|
---|
1918 | * @param cbData Number of bytes the new array should describe.
|
---|
1919 | */
|
---|
1920 | DECLR3CALLBACKMEMBER(size_t, pfnIoCtxSegArrayCreate, (void *pvUser, PVDIOCTX pIoCtx,
|
---|
1921 | PRTSGSEG paSeg, unsigned *pcSeg,
|
---|
1922 | size_t cbData));
|
---|
1923 | /**
|
---|
1924 | * Marks the given number of bytes as completed and continues the I/O context.
|
---|
1925 | *
|
---|
1926 | * @returns nothing.
|
---|
1927 | * @param pvUser The opaque user data passed on container creation.
|
---|
1928 | * @param pIoCtx The I/O context.
|
---|
1929 | * @param rcReq Status code the request completed with.
|
---|
1930 | * @param cbCompleted Number of bytes completed.
|
---|
1931 | */
|
---|
1932 | DECLR3CALLBACKMEMBER(void, pfnIoCtxCompleted, (void *pvUser, PVDIOCTX pIoCtx,
|
---|
1933 | int rcReq, size_t cbCompleted));
|
---|
1934 | } VDINTERFACEIOINT, *PVDINTERFACEIOINT;
|
---|
1935 |
|
---|
1936 | /**
|
---|
1937 | * Get internal I/O interface from opaque callback table.
|
---|
1938 | *
|
---|
1939 | * @return Pointer to the callback table.
|
---|
1940 | * @param pInterface Pointer to the interface descriptor.
|
---|
1941 | */
|
---|
1942 | DECLINLINE(PVDINTERFACEIOINT) VDGetInterfaceIOInt(PVDINTERFACE pInterface)
|
---|
1943 | {
|
---|
1944 | PVDINTERFACEIOINT pInterfaceIOInt;
|
---|
1945 |
|
---|
1946 | /* Check that the interface descriptor is an internal I/O interface. */
|
---|
1947 | AssertMsgReturn( (pInterface->enmInterface == VDINTERFACETYPE_IOINT)
|
---|
1948 | && (pInterface->cbSize == sizeof(VDINTERFACE)),
|
---|
1949 | ("Not an internal I/O interface"), NULL);
|
---|
1950 |
|
---|
1951 | pInterfaceIOInt = (PVDINTERFACEIOINT)pInterface->pCallbacks;
|
---|
1952 |
|
---|
1953 | /* Do basic checks. */
|
---|
1954 | AssertMsgReturn( (pInterfaceIOInt->cbSize == sizeof(VDINTERFACEIOINT))
|
---|
1955 | && (pInterfaceIOInt->enmInterface == VDINTERFACETYPE_IOINT),
|
---|
1956 | ("A non internal I/O callback table attached to an internal I/O interface descriptor\n"), NULL);
|
---|
1957 |
|
---|
1958 | return pInterfaceIOInt;
|
---|
1959 | }
|
---|
1960 |
|
---|
1961 | /**
|
---|
1962 | * Request completion callback for the async read/write API.
|
---|
1963 | */
|
---|
1964 | typedef void (FNVDASYNCTRANSFERCOMPLETE) (void *pvUser1, void *pvUser2, int rcReq);
|
---|
1965 | /** Pointer to a transfer compelte callback. */
|
---|
1966 | typedef FNVDASYNCTRANSFERCOMPLETE *PFNVDASYNCTRANSFERCOMPLETE;
|
---|
1967 |
|
---|
1968 | /**
|
---|
1969 | * Disk geometry.
|
---|
1970 | */
|
---|
1971 | typedef struct VDGEOMETRY
|
---|
1972 | {
|
---|
1973 | /** Number of cylinders. */
|
---|
1974 | uint32_t cCylinders;
|
---|
1975 | /** Number of heads. */
|
---|
1976 | uint32_t cHeads;
|
---|
1977 | /** Number of sectors. */
|
---|
1978 | uint32_t cSectors;
|
---|
1979 | } VDGEOMETRY;
|
---|
1980 |
|
---|
1981 | /** Pointer to disk geometry. */
|
---|
1982 | typedef VDGEOMETRY *PVDGEOMETRY;
|
---|
1983 | /** Pointer to constant disk geometry. */
|
---|
1984 | typedef const VDGEOMETRY *PCVDGEOMETRY;
|
---|
1985 |
|
---|
1986 | /**
|
---|
1987 | * VBox HDD Container main structure.
|
---|
1988 | */
|
---|
1989 | /* Forward declaration, VBOXHDD structure is visible only inside VBox HDD module. */
|
---|
1990 | struct VBOXHDD;
|
---|
1991 | typedef struct VBOXHDD VBOXHDD;
|
---|
1992 | typedef VBOXHDD *PVBOXHDD;
|
---|
1993 |
|
---|
1994 | /**
|
---|
1995 | * Initializes HDD backends.
|
---|
1996 | *
|
---|
1997 | * @returns VBox status code.
|
---|
1998 | */
|
---|
1999 | VBOXDDU_DECL(int) VDInit(void);
|
---|
2000 |
|
---|
2001 | /**
|
---|
2002 | * Destroys loaded HDD backends.
|
---|
2003 | *
|
---|
2004 | * @returns VBox status code.
|
---|
2005 | */
|
---|
2006 | VBOXDDU_DECL(int) VDShutdown(void);
|
---|
2007 |
|
---|
2008 | /**
|
---|
2009 | * Lists all HDD backends and their capabilities in a caller-provided buffer.
|
---|
2010 | *
|
---|
2011 | * @return VBox status code.
|
---|
2012 | * VERR_BUFFER_OVERFLOW if not enough space is passed.
|
---|
2013 | * @param cEntriesAlloc Number of list entries available.
|
---|
2014 | * @param pEntries Pointer to array for the entries.
|
---|
2015 | * @param pcEntriesUsed Number of entries returned.
|
---|
2016 | */
|
---|
2017 | VBOXDDU_DECL(int) VDBackendInfo(unsigned cEntriesAlloc, PVDBACKENDINFO pEntries,
|
---|
2018 | unsigned *pcEntriesUsed);
|
---|
2019 |
|
---|
2020 | /**
|
---|
2021 | * Lists the capabilities of a backend identified by its name.
|
---|
2022 | *
|
---|
2023 | * @return VBox status code.
|
---|
2024 | * @param pszBackend The backend name (case insensitive).
|
---|
2025 | * @param pEntries Pointer to an entry.
|
---|
2026 | */
|
---|
2027 | VBOXDDU_DECL(int) VDBackendInfoOne(const char *pszBackend, PVDBACKENDINFO pEntry);
|
---|
2028 |
|
---|
2029 | /**
|
---|
2030 | * Allocates and initializes an empty HDD container.
|
---|
2031 | * No image files are opened.
|
---|
2032 | *
|
---|
2033 | * @return VBox status code.
|
---|
2034 | * @param pVDIfsDisk Pointer to the per-disk VD interface list.
|
---|
2035 | * @param enmType Type of the image container.
|
---|
2036 | * @param ppDisk Where to store the reference to HDD container.
|
---|
2037 | */
|
---|
2038 | VBOXDDU_DECL(int) VDCreate(PVDINTERFACE pVDIfsDisk, VDTYPE enmType, PVBOXHDD *ppDisk);
|
---|
2039 |
|
---|
2040 | /**
|
---|
2041 | * Destroys HDD container.
|
---|
2042 | * If container has opened image files they will be closed.
|
---|
2043 | *
|
---|
2044 | * @param pDisk Pointer to HDD container.
|
---|
2045 | */
|
---|
2046 | VBOXDDU_DECL(void) VDDestroy(PVBOXHDD pDisk);
|
---|
2047 |
|
---|
2048 | /**
|
---|
2049 | * Try to get the backend name which can use this image.
|
---|
2050 | *
|
---|
2051 | * @return VBox status code.
|
---|
2052 | * VINF_SUCCESS if a plugin was found.
|
---|
2053 | * ppszFormat contains the string which can be used as backend name.
|
---|
2054 | * VERR_NOT_SUPPORTED if no backend was found.
|
---|
2055 | * @param pVDIfsDisk Pointer to the per-disk VD interface list.
|
---|
2056 | * @param pVDIfsImage Pointer to the per-image VD interface list.
|
---|
2057 | * @param pszFilename Name of the image file for which the backend is queried.
|
---|
2058 | * @param ppszFormat Receives pointer of the UTF-8 string which contains the format name.
|
---|
2059 | * The returned pointer must be freed using RTStrFree().
|
---|
2060 | * @param penmType Where to store the type of the image.
|
---|
2061 | */
|
---|
2062 | VBOXDDU_DECL(int) VDGetFormat(PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
|
---|
2063 | const char *pszFilename, char **ppszFormat, VDTYPE *penmType);
|
---|
2064 |
|
---|
2065 | /**
|
---|
2066 | * Opens an image file.
|
---|
2067 | *
|
---|
2068 | * The first opened image file in HDD container must have a base image type,
|
---|
2069 | * others (next opened images) must be differencing or undo images.
|
---|
2070 | * Linkage is checked for differencing image to be consistent with the previously opened image.
|
---|
2071 | * When another differencing image is opened and the last image was opened in read/write access
|
---|
2072 | * mode, then the last image is reopened in read-only with deny write sharing mode. This allows
|
---|
2073 | * other processes to use images in read-only mode too.
|
---|
2074 | *
|
---|
2075 | * Note that the image is opened in read-only mode if a read/write open is not possible.
|
---|
2076 | * Use VDIsReadOnly to check open mode.
|
---|
2077 | *
|
---|
2078 | * @return VBox status code.
|
---|
2079 | * @param pDisk Pointer to HDD container.
|
---|
2080 | * @param pszBackend Name of the image file backend to use (case insensitive).
|
---|
2081 | * @param pszFilename Name of the image file to open.
|
---|
2082 | * @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants.
|
---|
2083 | * @param pVDIfsImage Pointer to the per-image VD interface list.
|
---|
2084 | */
|
---|
2085 | VBOXDDU_DECL(int) VDOpen(PVBOXHDD pDisk, const char *pszBackend,
|
---|
2086 | const char *pszFilename, unsigned uOpenFlags,
|
---|
2087 | PVDINTERFACE pVDIfsImage);
|
---|
2088 |
|
---|
2089 | /**
|
---|
2090 | * Opens a cache image.
|
---|
2091 | *
|
---|
2092 | * @return VBox status code.
|
---|
2093 | * @param pDisk Pointer to the HDD container which should use the cache image.
|
---|
2094 | * @param pszBackend Name of the cache file backend to use (case insensitive).
|
---|
2095 | * @param pszFilename Name of the cache image to open.
|
---|
2096 | * @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants.
|
---|
2097 | * @param pVDIfsCache Pointer to the per-cache VD interface list.
|
---|
2098 | */
|
---|
2099 | VBOXDDU_DECL(int) VDCacheOpen(PVBOXHDD pDisk, const char *pszBackend,
|
---|
2100 | const char *pszFilename, unsigned uOpenFlags,
|
---|
2101 | PVDINTERFACE pVDIfsCache);
|
---|
2102 |
|
---|
2103 | /**
|
---|
2104 | * Creates and opens a new base image file.
|
---|
2105 | *
|
---|
2106 | * @return VBox status code.
|
---|
2107 | * @param pDisk Pointer to HDD container.
|
---|
2108 | * @param pszBackend Name of the image file backend to use (case insensitive).
|
---|
2109 | * @param pszFilename Name of the image file to create.
|
---|
2110 | * @param cbSize Image size in bytes.
|
---|
2111 | * @param uImageFlags Flags specifying special image features.
|
---|
2112 | * @param pszComment Pointer to image comment. NULL is ok.
|
---|
2113 | * @param pPCHSGeometry Pointer to physical disk geometry <= (16383,16,63). Not NULL.
|
---|
2114 | * @param pLCHSGeometry Pointer to logical disk geometry <= (x,255,63). Not NULL.
|
---|
2115 | * @param pUuid New UUID of the image. If NULL, a new UUID is created.
|
---|
2116 | * @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants.
|
---|
2117 | * @param pVDIfsImage Pointer to the per-image VD interface list.
|
---|
2118 | * @param pVDIfsOperation Pointer to the per-operation VD interface list.
|
---|
2119 | */
|
---|
2120 | VBOXDDU_DECL(int) VDCreateBase(PVBOXHDD pDisk, const char *pszBackend,
|
---|
2121 | const char *pszFilename, uint64_t cbSize,
|
---|
2122 | unsigned uImageFlags, const char *pszComment,
|
---|
2123 | PCVDGEOMETRY pPCHSGeometry,
|
---|
2124 | PCVDGEOMETRY pLCHSGeometry,
|
---|
2125 | PCRTUUID pUuid, unsigned uOpenFlags,
|
---|
2126 | PVDINTERFACE pVDIfsImage,
|
---|
2127 | PVDINTERFACE pVDIfsOperation);
|
---|
2128 |
|
---|
2129 | /**
|
---|
2130 | * Creates and opens a new differencing image file in HDD container.
|
---|
2131 | * See comments for VDOpen function about differencing images.
|
---|
2132 | *
|
---|
2133 | * @return VBox status code.
|
---|
2134 | * @param pDisk Pointer to HDD container.
|
---|
2135 | * @param pszBackend Name of the image file backend to use (case insensitive).
|
---|
2136 | * @param pszFilename Name of the differencing image file to create.
|
---|
2137 | * @param uImageFlags Flags specifying special image features.
|
---|
2138 | * @param pszComment Pointer to image comment. NULL is ok.
|
---|
2139 | * @param pUuid New UUID of the image. If NULL, a new UUID is created.
|
---|
2140 | * @param pParentUuid New parent UUID of the image. If NULL, the UUID is queried automatically.
|
---|
2141 | * @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants.
|
---|
2142 | * @param pVDIfsImage Pointer to the per-image VD interface list.
|
---|
2143 | * @param pVDIfsOperation Pointer to the per-operation VD interface list.
|
---|
2144 | */
|
---|
2145 | VBOXDDU_DECL(int) VDCreateDiff(PVBOXHDD pDisk, const char *pszBackend,
|
---|
2146 | const char *pszFilename, unsigned uImageFlags,
|
---|
2147 | const char *pszComment, PCRTUUID pUuid,
|
---|
2148 | PCRTUUID pParentUuid, unsigned uOpenFlags,
|
---|
2149 | PVDINTERFACE pVDIfsImage,
|
---|
2150 | PVDINTERFACE pVDIfsOperation);
|
---|
2151 |
|
---|
2152 | /**
|
---|
2153 | * Creates and opens new cache image file in HDD container.
|
---|
2154 | *
|
---|
2155 | * @return VBox status code.
|
---|
2156 | * @param pDisk Name of the cache file backend to use (case insensitive).
|
---|
2157 | * @param pszFilename Name of the differencing cache file to create.
|
---|
2158 | * @param cbSize Maximum size of the cache.
|
---|
2159 | * @param uImageFlags Flags specifying special cache features.
|
---|
2160 | * @param pszComment Pointer to image comment. NULL is ok.
|
---|
2161 | * @param pUuid New UUID of the image. If NULL, a new UUID is created.
|
---|
2162 | * @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants.
|
---|
2163 | * @param pVDIfsCache Pointer to the per-cache VD interface list.
|
---|
2164 | * @param pVDIfsOperation Pointer to the per-operation VD interface list.
|
---|
2165 | */
|
---|
2166 | VBOXDDU_DECL(int) VDCreateCache(PVBOXHDD pDisk, const char *pszBackend,
|
---|
2167 | const char *pszFilename, uint64_t cbSize,
|
---|
2168 | unsigned uImageFlags, const char *pszComment,
|
---|
2169 | PCRTUUID pUuid, unsigned uOpenFlags,
|
---|
2170 | PVDINTERFACE pVDIfsCache, PVDINTERFACE pVDIfsOperation);
|
---|
2171 |
|
---|
2172 | /**
|
---|
2173 | * Merges two images (not necessarily with direct parent/child relationship).
|
---|
2174 | * As a side effect the source image and potentially the other images which
|
---|
2175 | * are also merged to the destination are deleted from both the disk and the
|
---|
2176 | * images in the HDD container.
|
---|
2177 | *
|
---|
2178 | * @return VBox status code.
|
---|
2179 | * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
|
---|
2180 | * @param pDisk Pointer to HDD container.
|
---|
2181 | * @param nImageFrom Image number to merge from, counts from 0. 0 is always base image of container.
|
---|
2182 | * @param nImageTo Image number to merge to, counts from 0. 0 is always base image of container.
|
---|
2183 | * @param pVDIfsOperation Pointer to the per-operation VD interface list.
|
---|
2184 | */
|
---|
2185 | VBOXDDU_DECL(int) VDMerge(PVBOXHDD pDisk, unsigned nImageFrom,
|
---|
2186 | unsigned nImageTo, PVDINTERFACE pVDIfsOperation);
|
---|
2187 |
|
---|
2188 | /**
|
---|
2189 | * Copies an image from one HDD container to another.
|
---|
2190 | * The copy is opened in the target HDD container.
|
---|
2191 | * It is possible to convert between different image formats, because the
|
---|
2192 | * backend for the destination may be different from the source.
|
---|
2193 | * If both the source and destination reference the same HDD container,
|
---|
2194 | * then the image is moved (by copying/deleting or renaming) to the new location.
|
---|
2195 | * The source container is unchanged if the move operation fails, otherwise
|
---|
2196 | * the image at the new location is opened in the same way as the old one was.
|
---|
2197 | *
|
---|
2198 | * @note The read/write accesses across disks are not synchronized, just the
|
---|
2199 | * accesses to each disk. Once there is a use case which requires a defined
|
---|
2200 | * read/write behavior in this situation this needs to be extended.
|
---|
2201 | *
|
---|
2202 | * @return VBox status code.
|
---|
2203 | * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
|
---|
2204 | * @param pDiskFrom Pointer to source HDD container.
|
---|
2205 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2206 | * @param pDiskTo Pointer to destination HDD container.
|
---|
2207 | * @param pszBackend Name of the image file backend to use (may be NULL to use the same as the source, case insensitive).
|
---|
2208 | * @param pszFilename New name of the image (may be NULL to specify that the
|
---|
2209 | * copy destination is the destination container, or
|
---|
2210 | * if pDiskFrom == pDiskTo, i.e. when moving).
|
---|
2211 | * @param fMoveByRename If true, attempt to perform a move by renaming (if successful the new size is ignored).
|
---|
2212 | * @param cbSize New image size (0 means leave unchanged).
|
---|
2213 | * @param uImageFlags Flags specifying special destination image features.
|
---|
2214 | * @param pDstUuid New UUID of the destination image. If NULL, a new UUID is created.
|
---|
2215 | * This parameter is used if and only if a true copy is created.
|
---|
2216 | * In all rename/move cases or copy to existing image cases the modification UUIDs are copied over.
|
---|
2217 | * @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants.
|
---|
2218 | * Only used if the destination image is created.
|
---|
2219 | * @param pVDIfsOperation Pointer to the per-operation VD interface list.
|
---|
2220 | * @param pDstVDIfsImage Pointer to the per-image VD interface list, for the
|
---|
2221 | * destination image.
|
---|
2222 | * @param pDstVDIfsOperation Pointer to the per-operation VD interface list,
|
---|
2223 | * for the destination operation.
|
---|
2224 | */
|
---|
2225 | VBOXDDU_DECL(int) VDCopy(PVBOXHDD pDiskFrom, unsigned nImage, PVBOXHDD pDiskTo,
|
---|
2226 | const char *pszBackend, const char *pszFilename,
|
---|
2227 | bool fMoveByRename, uint64_t cbSize,
|
---|
2228 | unsigned uImageFlags, PCRTUUID pDstUuid,
|
---|
2229 | unsigned uOpenFlags, PVDINTERFACE pVDIfsOperation,
|
---|
2230 | PVDINTERFACE pDstVDIfsImage,
|
---|
2231 | PVDINTERFACE pDstVDIfsOperation);
|
---|
2232 |
|
---|
2233 | /**
|
---|
2234 | * Optimizes the storage consumption of an image. Typically the unused blocks
|
---|
2235 | * have to be wiped with zeroes to achieve a substantial reduced storage use.
|
---|
2236 | * Another optimization done is reordering the image blocks, which can provide
|
---|
2237 | * a significant performance boost, as reads and writes tend to use less random
|
---|
2238 | * file offsets.
|
---|
2239 | *
|
---|
2240 | * @note Compaction is treated as a single operation with regard to thread
|
---|
2241 | * synchronization, which means that it potentially blocks other activities for
|
---|
2242 | * a long time. The complexity of compaction would grow even more if concurrent
|
---|
2243 | * accesses have to be handled.
|
---|
2244 | *
|
---|
2245 | * @return VBox status code.
|
---|
2246 | * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
|
---|
2247 | * @return VERR_VD_IMAGE_READ_ONLY if image is not writable.
|
---|
2248 | * @return VERR_NOT_SUPPORTED if this kind of image can be compacted, but
|
---|
2249 | * this isn't supported yet.
|
---|
2250 | * @param pDisk Pointer to HDD container.
|
---|
2251 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2252 | * @param pVDIfsOperation Pointer to the per-operation VD interface list.
|
---|
2253 | */
|
---|
2254 | VBOXDDU_DECL(int) VDCompact(PVBOXHDD pDisk, unsigned nImage,
|
---|
2255 | PVDINTERFACE pVDIfsOperation);
|
---|
2256 |
|
---|
2257 | /**
|
---|
2258 | * Resizes the given disk image to the given size.
|
---|
2259 | *
|
---|
2260 | * @return VBox status
|
---|
2261 | * @return VERR_VD_IMAGE_READ_ONLY if image is not writable.
|
---|
2262 | * @return VERR_NOT_SUPPORTED if this kind of image can be compacted, but
|
---|
2263 | *
|
---|
2264 | * @param pDisk Pointer to the HDD container.
|
---|
2265 | * @param cbSize New size of the image.
|
---|
2266 | * @param pPCHSGeometry Pointer to the new physical disk geometry <= (16383,16,63). Not NULL.
|
---|
2267 | * @param pLCHSGeometry Pointer to the new logical disk geometry <= (x,255,63). Not NULL.
|
---|
2268 | * @param pVDIfsOperation Pointer to the per-operation VD interface list.
|
---|
2269 | */
|
---|
2270 | VBOXDDU_DECL(int) VDResize(PVBOXHDD pDisk, uint64_t cbSize,
|
---|
2271 | PCVDGEOMETRY pPCHSGeometry,
|
---|
2272 | PCVDGEOMETRY pLCHSGeometry,
|
---|
2273 | PVDINTERFACE pVDIfsOperation);
|
---|
2274 |
|
---|
2275 | /**
|
---|
2276 | * Closes the last opened image file in HDD container.
|
---|
2277 | * If previous image file was opened in read-only mode (the normal case) and
|
---|
2278 | * the last opened image is in read-write mode then the previous image will be
|
---|
2279 | * reopened in read/write mode.
|
---|
2280 | *
|
---|
2281 | * @return VBox status code.
|
---|
2282 | * @return VERR_VD_NOT_OPENED if no image is opened in HDD container.
|
---|
2283 | * @param pDisk Pointer to HDD container.
|
---|
2284 | * @param fDelete If true, delete the image from the host disk.
|
---|
2285 | */
|
---|
2286 | VBOXDDU_DECL(int) VDClose(PVBOXHDD pDisk, bool fDelete);
|
---|
2287 |
|
---|
2288 | /**
|
---|
2289 | * Closes the currently opened cache image file in HDD container.
|
---|
2290 | *
|
---|
2291 | * @return VBox status code.
|
---|
2292 | * @return VERR_VD_NOT_OPENED if no cache is opened in HDD container.
|
---|
2293 | * @param pDisk Pointer to HDD container.
|
---|
2294 | * @param fDelete If true, delete the image from the host disk.
|
---|
2295 | */
|
---|
2296 | VBOXDDU_DECL(int) VDCacheClose(PVBOXHDD pDisk, bool fDelete);
|
---|
2297 |
|
---|
2298 | /**
|
---|
2299 | * Closes all opened image files in HDD container.
|
---|
2300 | *
|
---|
2301 | * @return VBox status code.
|
---|
2302 | * @param pDisk Pointer to HDD container.
|
---|
2303 | */
|
---|
2304 | VBOXDDU_DECL(int) VDCloseAll(PVBOXHDD pDisk);
|
---|
2305 |
|
---|
2306 | /**
|
---|
2307 | * Read data from virtual HDD.
|
---|
2308 | *
|
---|
2309 | * @return VBox status code.
|
---|
2310 | * @return VERR_VD_NOT_OPENED if no image is opened in HDD container.
|
---|
2311 | * @param pDisk Pointer to HDD container.
|
---|
2312 | * @param uOffset Offset of first reading byte from start of disk.
|
---|
2313 | * Must be aligned to a sector boundary.
|
---|
2314 | * @param pvBuffer Pointer to buffer for reading data.
|
---|
2315 | * @param cbBuffer Number of bytes to read.
|
---|
2316 | * Must be aligned to a sector boundary.
|
---|
2317 | */
|
---|
2318 | VBOXDDU_DECL(int) VDRead(PVBOXHDD pDisk, uint64_t uOffset, void *pvBuffer, size_t cbBuffer);
|
---|
2319 |
|
---|
2320 | /**
|
---|
2321 | * Write data to virtual HDD.
|
---|
2322 | *
|
---|
2323 | * @return VBox status code.
|
---|
2324 | * @return VERR_VD_NOT_OPENED if no image is opened in HDD container.
|
---|
2325 | * @param pDisk Pointer to HDD container.
|
---|
2326 | * @param uOffset Offset of first writing byte from start of disk.
|
---|
2327 | * Must be aligned to a sector boundary.
|
---|
2328 | * @param pvBuffer Pointer to buffer for writing data.
|
---|
2329 | * @param cbBuffer Number of bytes to write.
|
---|
2330 | * Must be aligned to a sector boundary.
|
---|
2331 | */
|
---|
2332 | VBOXDDU_DECL(int) VDWrite(PVBOXHDD pDisk, uint64_t uOffset, const void *pvBuffer, size_t cbBuffer);
|
---|
2333 |
|
---|
2334 | /**
|
---|
2335 | * Make sure the on disk representation of a virtual HDD is up to date.
|
---|
2336 | *
|
---|
2337 | * @return VBox status code.
|
---|
2338 | * @return VERR_VD_NOT_OPENED if no image is opened in HDD container.
|
---|
2339 | * @param pDisk Pointer to HDD container.
|
---|
2340 | */
|
---|
2341 | VBOXDDU_DECL(int) VDFlush(PVBOXHDD pDisk);
|
---|
2342 |
|
---|
2343 | /**
|
---|
2344 | * Get number of opened images in HDD container.
|
---|
2345 | *
|
---|
2346 | * @return Number of opened images for HDD container. 0 if no images have been opened.
|
---|
2347 | * @param pDisk Pointer to HDD container.
|
---|
2348 | */
|
---|
2349 | VBOXDDU_DECL(unsigned) VDGetCount(PVBOXHDD pDisk);
|
---|
2350 |
|
---|
2351 | /**
|
---|
2352 | * Get read/write mode of HDD container.
|
---|
2353 | *
|
---|
2354 | * @return Virtual disk ReadOnly status.
|
---|
2355 | * @return true if no image is opened in HDD container.
|
---|
2356 | * @param pDisk Pointer to HDD container.
|
---|
2357 | */
|
---|
2358 | VBOXDDU_DECL(bool) VDIsReadOnly(PVBOXHDD pDisk);
|
---|
2359 |
|
---|
2360 | /**
|
---|
2361 | * Get total capacity of an image in HDD container.
|
---|
2362 | *
|
---|
2363 | * @return Virtual disk size in bytes.
|
---|
2364 | * @return 0 if image with specified number was not opened.
|
---|
2365 | * @param pDisk Pointer to HDD container.
|
---|
2366 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2367 | */
|
---|
2368 | VBOXDDU_DECL(uint64_t) VDGetSize(PVBOXHDD pDisk, unsigned nImage);
|
---|
2369 |
|
---|
2370 | /**
|
---|
2371 | * Get total file size of an image in HDD container.
|
---|
2372 | *
|
---|
2373 | * @return Virtual disk size in bytes.
|
---|
2374 | * @return 0 if image with specified number was not opened.
|
---|
2375 | * @param pDisk Pointer to HDD container.
|
---|
2376 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2377 | */
|
---|
2378 | VBOXDDU_DECL(uint64_t) VDGetFileSize(PVBOXHDD pDisk, unsigned nImage);
|
---|
2379 |
|
---|
2380 | /**
|
---|
2381 | * Get virtual disk PCHS geometry of an image in HDD container.
|
---|
2382 | *
|
---|
2383 | * @return VBox status code.
|
---|
2384 | * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
|
---|
2385 | * @return VERR_VD_GEOMETRY_NOT_SET if no geometry present in the HDD container.
|
---|
2386 | * @param pDisk Pointer to HDD container.
|
---|
2387 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2388 | * @param pPCHSGeometry Where to store PCHS geometry. Not NULL.
|
---|
2389 | */
|
---|
2390 | VBOXDDU_DECL(int) VDGetPCHSGeometry(PVBOXHDD pDisk, unsigned nImage,
|
---|
2391 | PVDGEOMETRY pPCHSGeometry);
|
---|
2392 |
|
---|
2393 | /**
|
---|
2394 | * Store virtual disk PCHS geometry of an image in HDD container.
|
---|
2395 | *
|
---|
2396 | * @return VBox status code.
|
---|
2397 | * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
|
---|
2398 | * @param pDisk Pointer to HDD container.
|
---|
2399 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2400 | * @param pPCHSGeometry Where to load PCHS geometry from. Not NULL.
|
---|
2401 | */
|
---|
2402 | VBOXDDU_DECL(int) VDSetPCHSGeometry(PVBOXHDD pDisk, unsigned nImage,
|
---|
2403 | PCVDGEOMETRY pPCHSGeometry);
|
---|
2404 |
|
---|
2405 | /**
|
---|
2406 | * Get virtual disk LCHS geometry of an image in HDD container.
|
---|
2407 | *
|
---|
2408 | * @return VBox status code.
|
---|
2409 | * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
|
---|
2410 | * @return VERR_VD_GEOMETRY_NOT_SET if no geometry present in the HDD container.
|
---|
2411 | * @param pDisk Pointer to HDD container.
|
---|
2412 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2413 | * @param pLCHSGeometry Where to store LCHS geometry. Not NULL.
|
---|
2414 | */
|
---|
2415 | VBOXDDU_DECL(int) VDGetLCHSGeometry(PVBOXHDD pDisk, unsigned nImage,
|
---|
2416 | PVDGEOMETRY pLCHSGeometry);
|
---|
2417 |
|
---|
2418 | /**
|
---|
2419 | * Store virtual disk LCHS geometry of an image in HDD container.
|
---|
2420 | *
|
---|
2421 | * @return VBox status code.
|
---|
2422 | * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
|
---|
2423 | * @param pDisk Pointer to HDD container.
|
---|
2424 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2425 | * @param pLCHSGeometry Where to load LCHS geometry from. Not NULL.
|
---|
2426 | */
|
---|
2427 | VBOXDDU_DECL(int) VDSetLCHSGeometry(PVBOXHDD pDisk, unsigned nImage,
|
---|
2428 | PCVDGEOMETRY pLCHSGeometry);
|
---|
2429 |
|
---|
2430 | /**
|
---|
2431 | * Get version of image in HDD container.
|
---|
2432 | *
|
---|
2433 | * @return VBox status code.
|
---|
2434 | * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
|
---|
2435 | * @param pDisk Pointer to HDD container.
|
---|
2436 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2437 | * @param puVersion Where to store the image version.
|
---|
2438 | */
|
---|
2439 | VBOXDDU_DECL(int) VDGetVersion(PVBOXHDD pDisk, unsigned nImage,
|
---|
2440 | unsigned *puVersion);
|
---|
2441 |
|
---|
2442 | /**
|
---|
2443 | * List the capabilities of image backend in HDD container.
|
---|
2444 | *
|
---|
2445 | * @return VBox status code.
|
---|
2446 | * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
|
---|
2447 | * @param pDisk Pointer to the HDD container.
|
---|
2448 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2449 | * @param pbackendInfo Where to store the backend information.
|
---|
2450 | */
|
---|
2451 | VBOXDDU_DECL(int) VDBackendInfoSingle(PVBOXHDD pDisk, unsigned nImage,
|
---|
2452 | PVDBACKENDINFO pBackendInfo);
|
---|
2453 |
|
---|
2454 | /**
|
---|
2455 | * Get flags of image in HDD container.
|
---|
2456 | *
|
---|
2457 | * @return VBox status code.
|
---|
2458 | * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
|
---|
2459 | * @param pDisk Pointer to HDD container.
|
---|
2460 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2461 | * @param puImageFlags Where to store the image flags.
|
---|
2462 | */
|
---|
2463 | VBOXDDU_DECL(int) VDGetImageFlags(PVBOXHDD pDisk, unsigned nImage, unsigned *puImageFlags);
|
---|
2464 |
|
---|
2465 | /**
|
---|
2466 | * Get open flags of image in HDD container.
|
---|
2467 | *
|
---|
2468 | * @return VBox status code.
|
---|
2469 | * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
|
---|
2470 | * @param pDisk Pointer to HDD container.
|
---|
2471 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2472 | * @param puOpenFlags Where to store the image open flags.
|
---|
2473 | */
|
---|
2474 | VBOXDDU_DECL(int) VDGetOpenFlags(PVBOXHDD pDisk, unsigned nImage,
|
---|
2475 | unsigned *puOpenFlags);
|
---|
2476 |
|
---|
2477 | /**
|
---|
2478 | * Set open flags of image in HDD container.
|
---|
2479 | * This operation may cause file locking changes and/or files being reopened.
|
---|
2480 | * Note that in case of unrecoverable error all images in HDD container will be closed.
|
---|
2481 | *
|
---|
2482 | * @return VBox status code.
|
---|
2483 | * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
|
---|
2484 | * @param pDisk Pointer to HDD container.
|
---|
2485 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2486 | * @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants.
|
---|
2487 | */
|
---|
2488 | VBOXDDU_DECL(int) VDSetOpenFlags(PVBOXHDD pDisk, unsigned nImage,
|
---|
2489 | unsigned uOpenFlags);
|
---|
2490 |
|
---|
2491 | /**
|
---|
2492 | * Get base filename of image in HDD container. Some image formats use
|
---|
2493 | * other filenames as well, so don't use this for anything but informational
|
---|
2494 | * purposes.
|
---|
2495 | *
|
---|
2496 | * @return VBox status code.
|
---|
2497 | * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
|
---|
2498 | * @return VERR_BUFFER_OVERFLOW if pszFilename buffer too small to hold filename.
|
---|
2499 | * @param pDisk Pointer to HDD container.
|
---|
2500 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2501 | * @param pszFilename Where to store the image file name.
|
---|
2502 | * @param cbFilename Size of buffer pszFilename points to.
|
---|
2503 | */
|
---|
2504 | VBOXDDU_DECL(int) VDGetFilename(PVBOXHDD pDisk, unsigned nImage,
|
---|
2505 | char *pszFilename, unsigned cbFilename);
|
---|
2506 |
|
---|
2507 | /**
|
---|
2508 | * Get the comment line of image in HDD container.
|
---|
2509 | *
|
---|
2510 | * @return VBox status code.
|
---|
2511 | * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
|
---|
2512 | * @return VERR_BUFFER_OVERFLOW if pszComment buffer too small to hold comment text.
|
---|
2513 | * @param pDisk Pointer to HDD container.
|
---|
2514 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2515 | * @param pszComment Where to store the comment string of image. NULL is ok.
|
---|
2516 | * @param cbComment The size of pszComment buffer. 0 is ok.
|
---|
2517 | */
|
---|
2518 | VBOXDDU_DECL(int) VDGetComment(PVBOXHDD pDisk, unsigned nImage,
|
---|
2519 | char *pszComment, unsigned cbComment);
|
---|
2520 |
|
---|
2521 | /**
|
---|
2522 | * Changes the comment line of image in HDD container.
|
---|
2523 | *
|
---|
2524 | * @return VBox status code.
|
---|
2525 | * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
|
---|
2526 | * @param pDisk Pointer to HDD container.
|
---|
2527 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2528 | * @param pszComment New comment string (UTF-8). NULL is allowed to reset the comment.
|
---|
2529 | */
|
---|
2530 | VBOXDDU_DECL(int) VDSetComment(PVBOXHDD pDisk, unsigned nImage,
|
---|
2531 | const char *pszComment);
|
---|
2532 |
|
---|
2533 | /**
|
---|
2534 | * Get UUID of image in HDD container.
|
---|
2535 | *
|
---|
2536 | * @return VBox status code.
|
---|
2537 | * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
|
---|
2538 | * @param pDisk Pointer to HDD container.
|
---|
2539 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2540 | * @param pUuid Where to store the image UUID.
|
---|
2541 | */
|
---|
2542 | VBOXDDU_DECL(int) VDGetUuid(PVBOXHDD pDisk, unsigned nImage, PRTUUID pUuid);
|
---|
2543 |
|
---|
2544 | /**
|
---|
2545 | * Set the image's UUID. Should not be used by normal applications.
|
---|
2546 | *
|
---|
2547 | * @return VBox status code.
|
---|
2548 | * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
|
---|
2549 | * @param pDisk Pointer to HDD container.
|
---|
2550 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2551 | * @param pUuid New UUID of the image. If NULL, a new UUID is created.
|
---|
2552 | */
|
---|
2553 | VBOXDDU_DECL(int) VDSetUuid(PVBOXHDD pDisk, unsigned nImage, PCRTUUID pUuid);
|
---|
2554 |
|
---|
2555 | /**
|
---|
2556 | * Get last modification UUID of image in HDD container.
|
---|
2557 | *
|
---|
2558 | * @return VBox status code.
|
---|
2559 | * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
|
---|
2560 | * @param pDisk Pointer to HDD container.
|
---|
2561 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2562 | * @param pUuid Where to store the image modification UUID.
|
---|
2563 | */
|
---|
2564 | VBOXDDU_DECL(int) VDGetModificationUuid(PVBOXHDD pDisk, unsigned nImage,
|
---|
2565 | PRTUUID pUuid);
|
---|
2566 |
|
---|
2567 | /**
|
---|
2568 | * Set the image's last modification UUID. Should not be used by normal applications.
|
---|
2569 | *
|
---|
2570 | * @return VBox status code.
|
---|
2571 | * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
|
---|
2572 | * @param pDisk Pointer to HDD container.
|
---|
2573 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2574 | * @param pUuid New modification UUID of the image. If NULL, a new UUID is created.
|
---|
2575 | */
|
---|
2576 | VBOXDDU_DECL(int) VDSetModificationUuid(PVBOXHDD pDisk, unsigned nImage,
|
---|
2577 | PCRTUUID pUuid);
|
---|
2578 |
|
---|
2579 | /**
|
---|
2580 | * Get parent UUID of image in HDD container.
|
---|
2581 | *
|
---|
2582 | * @return VBox status code.
|
---|
2583 | * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
|
---|
2584 | * @param pDisk Pointer to HDD container.
|
---|
2585 | * @param nImage Image number, counts from 0. 0 is always base image of the container.
|
---|
2586 | * @param pUuid Where to store the parent image UUID.
|
---|
2587 | */
|
---|
2588 | VBOXDDU_DECL(int) VDGetParentUuid(PVBOXHDD pDisk, unsigned nImage,
|
---|
2589 | PRTUUID pUuid);
|
---|
2590 |
|
---|
2591 | /**
|
---|
2592 | * Set the image's parent UUID. Should not be used by normal applications.
|
---|
2593 | *
|
---|
2594 | * @return VBox status code.
|
---|
2595 | * @param pDisk Pointer to HDD container.
|
---|
2596 | * @param nImage Image number, counts from 0. 0 is always base image of container.
|
---|
2597 | * @param pUuid New parent UUID of the image. If NULL, a new UUID is created.
|
---|
2598 | */
|
---|
2599 | VBOXDDU_DECL(int) VDSetParentUuid(PVBOXHDD pDisk, unsigned nImage,
|
---|
2600 | PCRTUUID pUuid);
|
---|
2601 |
|
---|
2602 |
|
---|
2603 | /**
|
---|
2604 | * Debug helper - dumps all opened images in HDD container into the log file.
|
---|
2605 | *
|
---|
2606 | * @param pDisk Pointer to HDD container.
|
---|
2607 | */
|
---|
2608 | VBOXDDU_DECL(void) VDDumpImages(PVBOXHDD pDisk);
|
---|
2609 |
|
---|
2610 |
|
---|
2611 | /**
|
---|
2612 | * Start an asynchronous read request.
|
---|
2613 | *
|
---|
2614 | * @return VBox status code.
|
---|
2615 | * @param pDisk Pointer to the HDD container.
|
---|
2616 | * @param uOffset The offset of the virtual disk to read from.
|
---|
2617 | * @param cbRead How many bytes to read.
|
---|
2618 | * @param pcSgBuf Pointer to the S/G buffer to read into.
|
---|
2619 | * @param pfnComplete Completion callback.
|
---|
2620 | * @param pvUser User data which is passed on completion
|
---|
2621 | */
|
---|
2622 | VBOXDDU_DECL(int) VDAsyncRead(PVBOXHDD pDisk, uint64_t uOffset, size_t cbRead,
|
---|
2623 | PCRTSGBUF pcSgBuf,
|
---|
2624 | PFNVDASYNCTRANSFERCOMPLETE pfnComplete,
|
---|
2625 | void *pvUser1, void *pvUser2);
|
---|
2626 |
|
---|
2627 |
|
---|
2628 | /**
|
---|
2629 | * Start an asynchronous write request.
|
---|
2630 | *
|
---|
2631 | * @return VBox status code.
|
---|
2632 | * @param pDisk Pointer to the HDD container.
|
---|
2633 | * @param uOffset The offset of the virtual disk to write to.
|
---|
2634 | * @param cbWrtie How many bytes to write.
|
---|
2635 | * @param pcSgBuf Pointer to the S/G buffer to write from.
|
---|
2636 | * @param pfnComplete Completion callback.
|
---|
2637 | * @param pvUser User data which is passed on completion.
|
---|
2638 | */
|
---|
2639 | VBOXDDU_DECL(int) VDAsyncWrite(PVBOXHDD pDisk, uint64_t uOffset, size_t cbWrite,
|
---|
2640 | PCRTSGBUF pcSgBuf,
|
---|
2641 | PFNVDASYNCTRANSFERCOMPLETE pfnComplete,
|
---|
2642 | void *pvUser1, void *pvUser2);
|
---|
2643 |
|
---|
2644 |
|
---|
2645 | /**
|
---|
2646 | * Start an asynchronous flush request.
|
---|
2647 | *
|
---|
2648 | * @return VBox status code.
|
---|
2649 | * @param pDisk Pointer to the HDD container.
|
---|
2650 | * @param pfnComplete Completion callback.
|
---|
2651 | * @param pvUser User data which is passed on completion.
|
---|
2652 | */
|
---|
2653 | VBOXDDU_DECL(int) VDAsyncFlush(PVBOXHDD pDisk,
|
---|
2654 | PFNVDASYNCTRANSFERCOMPLETE pfnComplete,
|
---|
2655 | void *pvUser1, void *pvUser2);
|
---|
2656 | RT_C_DECLS_END
|
---|
2657 |
|
---|
2658 | /** @} */
|
---|
2659 |
|
---|
2660 | #endif
|
---|