vd-image-backend.h@ 69107

Last change on this file since 69107 was 69107, checked in by vboxsync, 7 years ago
include/VBox/: (C) year
Property svn:eol-style set to `native`
File size: 26.6 KB

Line
1	/** @file
2	* VD: Image backend interface.
3	*/
4
5	/*
6	* Copyright (C) 2006-2017 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_image_backend_h
27	#define ___VBox_vd_image_backend_h
28
29	#include <VBox/vd.h>
30	#include <VBox/vd-common.h>
31	#include <VBox/vd-ifs-internal.h>
32
33
34	/** @name VBox HDD backend write flags
35	* @{
36	*/
37	/** Do not allocate a new block on this write. This is just an advisory
38	* flag. The backend may still decide in some circumstances that it wants
39	* to ignore this flag (which may cause extra dynamic image expansion). */
40	#define VD_WRITE_NO_ALLOC RT_BIT(1)
41	/** @}*/
42
43	/** @name VBox HDD backend discard flags
44	* @{
45	*/
46	/** Don't discard block but mark the given range as unused
47	* (usually by writing 0's to it).
48	* This doesn't require the range to be aligned on a block boundary but
49	* the image size might not be decreased. */
50	#define VD_DISCARD_MARK_UNUSED RT_BIT(0)
51	/** @}*/
52
53	/** @name VBox HDD backend metadata traverse flags
54	* @{
55	*/
56	/** Include per block metadata while traversing the metadata.
57	* This might take much longer instead of traversing just global metadata. */
58	#define VD_TRAVERSE_METADATA_INCLUDE_PER_BLOCK_METADATA RT_BIT(0)
59	/** @}*/
60
61	/**
62	* Image format backend interface used by VBox HDD Container implementation.
63	*/
64	typedef struct VDIMAGEBACKEND
65	{
66	/** Structure version. VD_IMGBACKEND_VERSION defines the current version. */
67	uint32_t u32Version;
68	/** The name of the backend (constant string). */
69	const char *pszBackendName;
70	/** The capabilities of the backend. */
71	uint64_t uBackendCaps;
72
73	/**
74	* Pointer to a NULL-terminated array, containing the supported
75	* file extensions. Note that some backends do not work on files, so this
76	* pointer may just contain NULL.
77	*/
78	PCVDFILEEXTENSION paFileExtensions;
79
80	/**
81	* Pointer to an array of structs describing each supported config key.
82	* Terminated by a NULL config key. Note that some backends do not support
83	* the configuration interface, so this pointer may just contain NULL.
84	* Mandatory if the backend sets VD_CAP_CONFIG.
85	*/
86	PCVDCONFIGINFO paConfigInfo;
87
88	/**
89	* Check whether the file is supported by the backend.
90	*
91	* @returns VBox status code.
92	* @param pszFilename Name of the image file.
93	* @param pVDIfsDisk Pointer to the per-disk VD interface list.
94	* @param pVDIfsImage Pointer to the per-image VD interface list.
95	* @param penmType Returns the supported device type on success.
96	*/
97	DECLR3CALLBACKMEMBER(int, pfnProbe, (const char *pszFilename, PVDINTERFACE pVDIfsDisk,
98	PVDINTERFACE pVDIfsImage, VDTYPE *penmType));
99
100	/**
101	* Open a disk image.
102	*
103	* @returns VBox status code.
104	* @param pszFilename Name of the image file to open. Guaranteed to be available and
105	* unchanged during the lifetime of this image.
106	* @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants.
107	* @param pVDIfsDisk Pointer to the per-disk VD interface list.
108	* @param pVDIfsImage Pointer to the per-image VD interface list.
109	* @param enmType Requested type of the image.
110	* @param ppBackendData Opaque state data for this image.
111	*/
112	DECLR3CALLBACKMEMBER(int, pfnOpen, (const char *pszFilename, unsigned uOpenFlags,
113	PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
114	VDTYPE enmType, void **ppBackendData));
115
116	/**
117	* Create a disk image.
118	*
119	* @returns VBox status code.
120	* @param pszFilename Name of the image file to create. Guaranteed to be available and
121	* unchanged during the lifetime of this image.
122	* @param cbSize Image size in bytes.
123	* @param uImageFlags Flags specifying special image features.
124	* @param pszComment Pointer to image comment. NULL is ok.
125	* @param pPCHSGeometry Physical drive geometry CHS <= (16383,16,255).
126	* @param pLCHSGeometry Logical drive geometry CHS <= (1024,255,63).
127	* @param pUuid New UUID of the image. Not NULL.
128	* @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants.
129	* @param uPercentStart Starting value for progress percentage.
130	* @param uPercentSpan Span for varying progress percentage.
131	* @param pVDIfsDisk Pointer to the per-disk VD interface list.
132	* @param pVDIfsImage Pointer to the per-image VD interface list.
133	* @param pVDIfsOperation Pointer to the per-operation VD interface list.
134	* @param enmType Requested type of the image.
135	* @param ppBackendData Opaque state data for this image.
136	*/
137	DECLR3CALLBACKMEMBER(int, pfnCreate, (const char *pszFilename, uint64_t cbSize,
138	unsigned uImageFlags, const char *pszComment,
139	PCVDGEOMETRY pPCHSGeometry,
140	PCVDGEOMETRY pLCHSGeometry,
141	PCRTUUID pUuid, unsigned uOpenFlags,
142	unsigned uPercentStart, unsigned uPercentSpan,
143	PVDINTERFACE pVDIfsDisk,
144	PVDINTERFACE pVDIfsImage,
145	PVDINTERFACE pVDIfsOperation,
146	VDTYPE enmType,
147	void **ppBackendData));
148
149	/**
150	* Rename a disk image. Only needs to work as long as the operating
151	* system's rename file functionality is usable. If an attempt is made to
152	* rename an image to a location on another disk/filesystem, this function
153	* may just fail with an appropriate error code (not changing the opened
154	* image data at all). Also works only on images which actually refer to
155	* regular files. May be NULL.
156	*
157	* @returns VBox status code.
158	* @param pBackendData Opaque state data for this image.
159	* @param pszFilename New name of the image file. Guaranteed to be available and
160	* unchanged during the lifetime of this image.
161	*/
162	DECLR3CALLBACKMEMBER(int, pfnRename, (void pBackendData, const char pszFilename));
163
164	/**
165	* Close a disk image.
166	*
167	* @returns VBox status code.
168	* @param pBackendData Opaque state data for this image.
169	* @param fDelete If true, delete the image from the host disk.
170	*/
171	DECLR3CALLBACKMEMBER(int, pfnClose, (void *pBackendData, bool fDelete));
172
173	/**
174	* Start a read request.
175	*
176	* @returns VBox status code.
177	* @param pBackendData Opaque state data for this image.
178	* @param uOffset The offset of the virtual disk to read from.
179	* @param cbToRead How many bytes to read.
180	* @param pIoCtx I/O context associated with this request.
181	* @param pcbActuallyRead Pointer to returned number of bytes read.
182	*/
183	DECLR3CALLBACKMEMBER(int, pfnRead, (void *pBackendData, uint64_t uOffset, size_t cbToRead,
184	PVDIOCTX pIoCtx, size_t *pcbActuallyRead));
185
186	/**
187	* Start a write request.
188	*
189	* @returns VBox status code.
190	* @param pBackendData Opaque state data for this image.
191	* @param uOffset The offset of the virtual disk to write to.
192	* @param cbToWrite How many bytes to write.
193	* @param pIoCtx I/O context associated with this request.
194	* @param pcbWriteProcess Pointer to returned number of bytes that could
195	* be processed. In case the function returned
196	* VERR_VD_BLOCK_FREE this is the number of bytes
197	* that could be written in a full block write,
198	* when prefixed/postfixed by the appropriate
199	* amount of (previously read) padding data.
200	* @param pcbPreRead Pointer to the returned amount of data that must
201	* be prefixed to perform a full block write.
202	* @param pcbPostRead Pointer to the returned amount of data that must
203	* be postfixed to perform a full block write.
204	* @param fWrite Flags which affect write behavior. Combination
205	* of the VD_WRITE_* flags.
206	*/
207	DECLR3CALLBACKMEMBER(int, pfnWrite, (void *pBackendData, uint64_t uOffset, size_t cbToWrite,
208	PVDIOCTX pIoCtx,
209	size_t pcbWriteProcess, size_t pcbPreRead,
210	size_t *pcbPostRead, unsigned fWrite));
211
212	/**
213	* Flush data to disk.
214	*
215	* @returns VBox status code.
216	* @param pBackendData Opaque state data for this image.
217	* @param pIoCtx I/O context associated with this request.
218	*/
219	DECLR3CALLBACKMEMBER(int, pfnFlush, (void *pBackendData, PVDIOCTX pIoCtx));
220
221	/**
222	* Discards the given amount of bytes decreasing the size of the image if possible
223	*
224	* @returns VBox status code.
225	* @retval VERR_VD_DISCARD_ALIGNMENT_NOT_MET if the range doesn't meet the required alignment
226	* for the discard.
227	* @param pBackendData Opaque state data for this image.
228	* @param pIoCtx I/O context associated with this request.
229	* @param uOffset The offset of the first byte to discard.
230	* @param cbDiscard How many bytes to discard.
231	* @param pcbPreAllocated Pointer to the returned amount of bytes that must
232	* be discarded before the range to perform a full
233	* block discard.
234	* @param pcbPostAllocated Pointer to the returned amount of bytes that must
235	* be discarded after the range to perform a full
236	* block discard.
237	* @param pcbActuallyDiscarded Pointer to the returned amount of bytes which
238	* could be actually discarded.
239	* @param ppbmAllocationBitmap Where to store the pointer to the allocation bitmap
240	* if VERR_VD_DISCARD_ALIGNMENT_NOT_MET is returned or NULL
241	* if the allocation bitmap should be returned.
242	* @param fDiscard Flags which affect discard behavior. Combination
243	* of the VD_DISCARD_* flags.
244	*/
245	DECLR3CALLBACKMEMBER(int, pfnDiscard, (void *pBackendData, PVDIOCTX pIoCtx,
246	uint64_t uOffset, size_t cbDiscard,
247	size_t *pcbPreAllocated,
248	size_t *pcbPostAllocated,
249	size_t *pcbActuallyDiscarded,
250	void **ppbmAllocationBitmap,
251	unsigned fDiscard));
252
253	/**
254	* Get the version of a disk image.
255	*
256	* @returns version of disk image.
257	* @param pBackendData Opaque state data for this image.
258	*/
259	DECLR3CALLBACKMEMBER(unsigned, pfnGetVersion, (void *pBackendData));
260
261	/**
262	* Get the file size of a disk image.
263	*
264	* @returns size of disk image in bytes.
265	* @param pBackendData Opaque state data for this image.
266	*/
267	DECLR3CALLBACKMEMBER(uint64_t, pfnGetFileSize, (void *pBackendData));
268
269	/**
270	* Get virtual disk PCHS geometry stored in a disk image.
271	*
272	* @returns VBox status code.
273	* @returns VERR_VD_GEOMETRY_NOT_SET if no geometry present in the image.
274	* @param pBackendData Opaque state data for this image.
275	* @param pPCHSGeometry Where to store the geometry. Not NULL.
276	*/
277	DECLR3CALLBACKMEMBER(int, pfnGetPCHSGeometry, (void *pBackendData, PVDGEOMETRY pPCHSGeometry));
278
279	/**
280	* Set virtual disk PCHS geometry stored in a disk image.
281	* Only called if geometry is different than before.
282	*
283	* @returns VBox status code.
284	* @param pBackendData Opaque state data for this image.
285	* @param pPCHSGeometry Where to load the geometry from. Not NULL.
286	*/
287	DECLR3CALLBACKMEMBER(int, pfnSetPCHSGeometry, (void *pBackendData, PCVDGEOMETRY pPCHSGeometry));
288
289	/**
290	* Get virtual disk LCHS geometry stored in a disk image.
291	*
292	* @returns VBox status code.
293	* @returns VERR_VD_GEOMETRY_NOT_SET if no geometry present in the image.
294	* @param pBackendData Opaque state data for this image.
295	* @param pLCHSGeometry Where to store the geometry. Not NULL.
296	*/
297	DECLR3CALLBACKMEMBER(int, pfnGetLCHSGeometry, (void *pBackendData, PVDGEOMETRY pLCHSGeometry));
298
299	/**
300	* Set virtual disk LCHS geometry stored in a disk image.
301	* Only called if geometry is different than before.
302	*
303	* @returns VBox status code.
304	* @param pBackendData Opaque state data for this image.
305	* @param pLCHSGeometry Where to load the geometry from. Not NULL.
306	*/
307	DECLR3CALLBACKMEMBER(int, pfnSetLCHSGeometry, (void *pBackendData, PCVDGEOMETRY pLCHSGeometry));
308
309	/**
310	* Returns a region list for the disk image if supported, optional.
311	*
312	* @returns VBox status code.
313	* @retval VERR_NOT_SUPPORTED if region lists are not supported for this kind of image.
314	* @param pBackendData Opaque state data for this image.
315	* @param ppRegionList Where to store the pointer to the region list on success.
316	*/
317	DECLR3CALLBACKMEMBER(int, pfnQueryRegions, (void pBackendData, PCVDREGIONLIST ppRegionList));
318
319	/**
320	* Releases the region list acquired with VDIMAGEBACKEND::pfnQueryRegions() before.
321	*
322	* @returns nothing.
323	* @param pBackendData Opaque state data for this image.
324	* @param pRegionList The region list to release.
325	*/
326	DECLR3CALLBACKMEMBER(void, pfnRegionListRelease, (void *pBackendData, PCVDREGIONLIST pRegionList));
327
328	/**
329	* Get the image flags of a disk image.
330	*
331	* @returns image flags of disk image (VD_IMAGE_FLAGS_XXX).
332	* @param pBackendData Opaque state data for this image.
333	*/
334	DECLR3CALLBACKMEMBER(unsigned, pfnGetImageFlags, (void *pBackendData));
335
336	/**
337	* Get the open flags of a disk image.
338	*
339	* @returns open flags of disk image (VD_OPEN_FLAGS_XXX).
340	* @param pBackendData Opaque state data for this image.
341	*/
342	DECLR3CALLBACKMEMBER(unsigned, pfnGetOpenFlags, (void *pBackendData));
343
344	/**
345	* Set the open flags of a disk image.
346	*
347	* May cause the image to be locked in a different mode or be reopened (which
348	* can fail).
349	*
350	* @returns VBox status code.
351	* @param pBackendData Opaque state data for this image.
352	* @param uOpenFlags New open flags for this image (VD_OPEN_FLAGS_XXX).
353	*/
354	DECLR3CALLBACKMEMBER(int, pfnSetOpenFlags, (void *pBackendData, unsigned uOpenFlags));
355
356	/**
357	* Get comment of a disk image.
358	*
359	* @returns VBox status code.
360	* @param pBackendData Opaque state data for this image.
361	* @param pszComment Where to store the comment.
362	* @param cbComment Size of the comment buffer.
363	*/
364	DECLR3CALLBACKMEMBER(int, pfnGetComment, (void pBackendData, char pszComment, size_t cbComment));
365
366	/**
367	* Set comment of a disk image.
368	*
369	* @returns VBox status code.
370	* @param pBackendData Opaque state data for this image.
371	* @param pszComment Where to get the comment from. NULL resets comment.
372	* The comment is silently truncated if the image format
373	* limit is exceeded.
374	*/
375	DECLR3CALLBACKMEMBER(int, pfnSetComment, (void pBackendData, const char pszComment));
376
377	/**
378	* Get UUID of a disk image.
379	*
380	* @returns VBox status code.
381	* @param pBackendData Opaque state data for this image.
382	* @param pUuid Where to store the image UUID.
383	*/
384	DECLR3CALLBACKMEMBER(int, pfnGetUuid, (void *pBackendData, PRTUUID pUuid));
385
386	/**
387	* Set UUID of a disk image.
388	*
389	* @returns VBox status code.
390	* @param pBackendData Opaque state data for this image.
391	* @param pUuid Where to get the image UUID from.
392	*/
393	DECLR3CALLBACKMEMBER(int, pfnSetUuid, (void *pBackendData, PCRTUUID pUuid));
394
395	/**
396	* Get last modification UUID of a disk image.
397	*
398	* @returns VBox status code.
399	* @param pBackendData Opaque state data for this image.
400	* @param pUuid Where to store the image modification UUID.
401	*/
402	DECLR3CALLBACKMEMBER(int, pfnGetModificationUuid, (void *pBackendData, PRTUUID pUuid));
403
404	/**
405	* Set last modification UUID of a disk image.
406	*
407	* @returns VBox status code.
408	* @param pBackendData Opaque state data for this image.
409	* @param pUuid Where to get the image modification UUID from.
410	*/
411	DECLR3CALLBACKMEMBER(int, pfnSetModificationUuid, (void *pBackendData, PCRTUUID pUuid));
412
413	/**
414	* Get parent UUID of a disk image.
415	*
416	* @returns VBox status code.
417	* @param pBackendData Opaque state data for this image.
418	* @param pUuid Where to store the parent image UUID.
419	*/
420	DECLR3CALLBACKMEMBER(int, pfnGetParentUuid, (void *pBackendData, PRTUUID pUuid));
421
422	/**
423	* Set parent UUID of a disk image.
424	*
425	* @returns VBox status code.
426	* @param pBackendData Opaque state data for this image.
427	* @param pUuid Where to get the parent image UUID from.
428	*/
429	DECLR3CALLBACKMEMBER(int, pfnSetParentUuid, (void *pBackendData, PCRTUUID pUuid));
430
431	/**
432	* Get parent modification UUID of a disk image.
433	*
434	* @returns VBox status code.
435	* @param pBackendData Opaque state data for this image.
436	* @param pUuid Where to store the parent image modification UUID.
437	*/
438	DECLR3CALLBACKMEMBER(int, pfnGetParentModificationUuid, (void *pBackendData, PRTUUID pUuid));
439
440	/**
441	* Set parent modification UUID of a disk image.
442	*
443	* @returns VBox status code.
444	* @param pBackendData Opaque state data for this image.
445	* @param pUuid Where to get the parent image modification UUID from.
446	*/
447	DECLR3CALLBACKMEMBER(int, pfnSetParentModificationUuid, (void *pBackendData, PCRTUUID pUuid));
448
449	/**
450	* Dump information about a disk image.
451	*
452	* @param pBackendData Opaque state data for this image.
453	*/
454	DECLR3CALLBACKMEMBER(void, pfnDump, (void *pBackendData));
455
456	/**
457	* Get a time stamp of a disk image. May be NULL.
458	*
459	* @returns VBox status code.
460	* @param pBackendData Opaque state data for this image.
461	* @param pTimestamp Where to store the time stamp.
462	*/
463	DECLR3CALLBACKMEMBER(int, pfnGetTimestamp, (void *pBackendData, PRTTIMESPEC pTimestamp));
464
465	/**
466	* Get the parent time stamp of a disk image. May be NULL.
467	*
468	* @returns VBox status code.
469	* @param pBackendData Opaque state data for this image.
470	* @param pTimestamp Where to store the time stamp.
471	*/
472	DECLR3CALLBACKMEMBER(int, pfnGetParentTimestamp, (void *pBackendData, PRTTIMESPEC pTimestamp));
473
474	/**
475	* Set the parent time stamp of a disk image. May be NULL.
476	*
477	* @returns VBox status code.
478	* @param pBackendData Opaque state data for this image.
479	* @param pTimestamp Where to get the time stamp from.
480	*/
481	DECLR3CALLBACKMEMBER(int, pfnSetParentTimestamp, (void *pBackendData, PCRTTIMESPEC pTimestamp));
482
483	/**
484	* Get the relative path to parent image. May be NULL.
485	*
486	* @returns VBox status code.
487	* @param pBackendData Opaque state data for this image.
488	* @param ppszParentFilename Where to store the path.
489	*/
490	DECLR3CALLBACKMEMBER(int, pfnGetParentFilename, (void pBackendData, char *ppszParentFilename));
491
492	/**
493	* Set the relative path to parent image. May be NULL.
494	*
495	* @returns VBox status code.
496	* @param pBackendData Opaque state data for this image.
497	* @param pszParentFilename Where to get the path from.
498	*/
499	DECLR3CALLBACKMEMBER(int, pfnSetParentFilename, (void pBackendData, const char pszParentFilename));
500
501	/** Returns a human readable hard disk location string given a
502	* set of hard disk configuration keys. The returned string is an
503	* equivalent of the full file path for image-based hard disks.
504	* Mandatory for backends with no VD_CAP_FILE and NULL otherwise. */
505	DECLR3CALLBACKMEMBER(int, pfnComposeLocation, (PVDINTERFACE pConfig, char **pszLocation));
506
507	/** Returns a human readable hard disk name string given a
508	* set of hard disk configuration keys. The returned string is an
509	* equivalent of the file name part in the full file path for
510	* image-based hard disks. Mandatory for backends with no
511	* VD_CAP_FILE and NULL otherwise. */
512	DECLR3CALLBACKMEMBER(int, pfnComposeName, (PVDINTERFACE pConfig, char **pszName));
513
514	/**
515	* Compact the image. The pointer may be NULL, indicating that this
516	* isn't supported yet (for file-based images) or not necessary.
517	*
518	* @returns VBox status code.
519	* @returns VERR_NOT_SUPPORTED if this image cannot be compacted yet.
520	* @param pBackendData Opaque state data for this image.
521	* @param uPercentStart Starting value for progress percentage.
522	* @param uPercentSpan Span for varying progress percentage.
523	* @param pVDIfsDisk Pointer to the per-disk VD interface list.
524	* @param pVDIfsImage Pointer to the per-image VD interface list.
525	* @param pVDIfsOperation Pointer to the per-operation VD interface list.
526	*/
527	DECLR3CALLBACKMEMBER(int, pfnCompact, (void *pBackendData,
528	unsigned uPercentStart, unsigned uPercentSpan,
529	PVDINTERFACE pVDIfsDisk,
530	PVDINTERFACE pVDIfsImage,
531	PVDINTERFACE pVDIfsOperation));
532
533	/**
534	* Resize the image. The pointer may be NULL, indicating that this
535	* isn't supported yet (for file-based images) or not necessary.
536	*
537	* @returns VBox status code.
538	* @returns VERR_NOT_SUPPORTED if this image cannot be resized yet.
539	* @param pBackendData Opaque state data for this image.
540	* @param cbSize New size of the image.
541	* @param pPCHSGeometry Pointer to the new physical disk geometry <= (16383,16,63). Not NULL.
542	* @param pLCHSGeometry Pointer to the new logical disk geometry <= (x,255,63). Not NULL.
543	* @param uPercentStart Starting value for progress percentage.
544	* @param uPercentSpan Span for varying progress percentage.
545	* @param pVDIfsDisk Pointer to the per-disk VD interface list.
546	* @param pVDIfsImage Pointer to the per-image VD interface list.
547	* @param pVDIfsOperation Pointer to the per-operation VD interface list.
548	*/
549	DECLR3CALLBACKMEMBER(int, pfnResize, (void *pBackendData,
550	uint64_t cbSize,
551	PCVDGEOMETRY pPCHSGeometry,
552	PCVDGEOMETRY pLCHSGeometry,
553	unsigned uPercentStart, unsigned uPercentSpan,
554	PVDINTERFACE pVDIfsDisk,
555	PVDINTERFACE pVDIfsImage,
556	PVDINTERFACE pVDIfsOperation));
557
558	/**
559	* Try to repair the given image.
560	*
561	* @returns VBox status code.
562	* @param pszFilename Name of the image file.
563	* @param pVDIfsDisk Pointer to the per-disk VD interface list.
564	* @param pVDIfsImage Pointer to the per-image VD interface list.
565	* @param fFlags Combination of the VD_REPAIR_* flags.
566	*/
567	DECLR3CALLBACKMEMBER(int, pfnRepair, (const char *pszFilename, PVDINTERFACE pVDIfsDisk,
568	PVDINTERFACE pVDIfsImage, uint32_t fFlags));
569
570	/**
571	* Traverse all metadata of the opened image.
572	*
573	* @returns VBox status code.
574	* @param pBackendData Opaque state data for this image.
575	* @param fFlags Traverse flags, combination of VD_TRAVERSE_METDATA_* defines.
576	* @param pVDIfsDisk Pointer to the per-disk VD interface list.
577	* @param pVDIfsImage Pointer to the per-image VD interface list.
578	* @param pVDIfsOperation Pointer to the per-operation VD interface list.
579	*/
580	DECLR3CALLBACKMEMBER(int, pfnTraverseMetadata, (void *pBackendData, uint32_t fFlags,
581	PVDINTERFACE pVDIfsDisk,
582	PVDINTERFACE pVDIfsImage,
583	PVDINTERFACE pVDIfsOperation));
584
585	/** Initialization safty marker. */
586	uint32_t u32VersionEnd;
587
588	} VDIMAGEBACKEND;
589
590	/** Pointer to VD backend. */
591	typedef VDIMAGEBACKEND *PVDIMAGEBACKEND;
592	/** Constant pointer to VD backend. */
593	typedef const VDIMAGEBACKEND *PCVDIMAGEBACKEND;
594
595	/** The current version of the VDIMAGEBACKEND structure. */
596	#define VD_IMGBACKEND_VERSION VD_VERSION_MAKE(0xff01, 3, 0)
597
598	/** @copydoc VDIMAGEBACKEND::pfnComposeLocation */
599	DECLCALLBACK(int) genericFileComposeLocation(PVDINTERFACE pConfig, char **pszLocation);
600	/** @copydoc VDIMAGEBACKEND::pfnComposeName */
601	DECLCALLBACK(int) genericFileComposeName(PVDINTERFACE pConfig, char **pszName);
602
603	#endif

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/include/VBox/vd-image-backend.h@ 69107

Download in other formats: