VBoxHDD-new.h@ 7581

Last change on this file since 7581 was 7277, checked in by vboxsync, 17 years ago
Make the backend type a per-image property and get away from the per container property. Required e.g. for snapshotting iSCSI disks (whenever we get there).
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 27.8 KB

Line
1	/** @file
2	* VBox HDD Container API.
3	* Will replace VBoxHDD.h.
4	*/
5
6	/*
7	* Copyright (C) 2006-2008 innotek GmbH
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*
17	* The contents of this file may alternatively be used under the terms
18	* of the Common Development and Distribution License Version 1.0
19	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20	* VirtualBox OSE distribution, in which case the provisions of the
21	* CDDL are applicable instead of those of the GPL.
22	*
23	* You may elect to license modified versions of this file under the
24	* terms and conditions of either the GPL or the CDDL or both.
25	*/
26
27	#ifndef ___VBox_VD_h
28	#define ___VBox_VD_h
29
30	#include <VBox/cdefs.h>
31	#include <VBox/types.h>
32	#include <VBox/pdm.h>
33
34	__BEGIN_DECLS
35
36	#ifdef IN_RING0
37	# error "There are no VBox HDD Container APIs available in Ring-0 Host Context!"
38	#endif
39
40	/** @defgroup grp_vd VBox HDD Container
41	* @{
42	*/
43
44	/** Current VMDK image version. */
45	#define VMDK_IMAGE_VERSION (0x0001)
46
47	/** Current VDI image major version. */
48	#define VDI_IMAGE_VERSION_MAJOR (0x0001)
49	/** Current VDI image minor version. */
50	#define VDI_IMAGE_VERSION_MINOR (0x0001)
51	/** Current VDI image version. */
52	#define VDI_IMAGE_VERSION ((VDI_IMAGE_VERSION_MAJOR << 16) \| VDI_IMAGE_VERSION_MINOR)
53
54	/** Get VDI major version from combined version. */
55	#define VDI_GET_VERSION_MAJOR(uVer) ((uVer) >> 16)
56	/** Get VDI minor version from combined version. */
57	#define VDI_GET_VERSION_MINOR(uVer) ((uVer) & 0xffff)
58
59	/** Placeholder for specifying the last opened image. */
60	#define VD_LAST_IMAGE 0xffffffffU
61
62	/** @name VBox HDD container image types
63	* @{ */
64	typedef enum VDIMAGETYPE
65	{
66	/** Normal dynamically growing base image file. */
67	VD_IMAGE_TYPE_NORMAL = 1,
68	/** Preallocated base image file of a fixed size. */
69	VD_IMAGE_TYPE_FIXED,
70	/** Dynamically growing image file for undo/commit changes support. */
71	VD_IMAGE_TYPE_UNDO,
72	/** Dynamically growing image file for differencing support. */
73	VD_IMAGE_TYPE_DIFF,
74
75	/** First valid image type value. */
76	VD_IMAGE_TYPE_FIRST = VD_IMAGE_TYPE_NORMAL,
77	/** Last valid image type value. */
78	VD_IMAGE_TYPE_LAST = VD_IMAGE_TYPE_DIFF
79	} VDIMAGETYPE;
80	/** Pointer to VBox HDD container image type. */
81	typedef VDIMAGETYPE *PVDIMAGETYPE;
82	/** @} */
83
84	/** @name VBox HDD container image flags
85	* @{
86	*/
87	/** No flags. */
88	#define VD_IMAGE_FLAGS_NONE (0)
89	/** VMDK: Split image into 2GB extents. */
90	#define VD_VMDK_IMAGE_FLAGS_SPLIT_2G (0x0001)
91	/** VMDK: Raw disk image (giving access to a number of host partitions). */
92	#define VD_VMDK_IMAGE_FLAGS_RAWDISK (0x0002)
93	/** VDI: Fill new blocks with zeroes while expanding image file. Only valid
94	* for newly created images, never set for opened existing images. */
95	#define VD_VDI_IMAGE_FLAGS_ZERO_EXPAND (0x0100)
96
97	/** Mask of valid image flags for VMDK. */
98	#define VD_VMDK_IMAGE_FLAGS_MASK (VD_IMAGE_FLAGS_NONE \| VD_VMDK_IMAGE_FLAGS_SPLIT_2G \| VD_VMDK_IMAGE_FLAGS_RAWDISK)
99
100	/** Mask of valid image flags for VDI. */
101	#define VD_VDI_IMAGE_FLAGS_MASK (VD_IMAGE_FLAGS_NONE \| VD_VDI_IMAGE_FLAGS_ZERO_EXPAND)
102
103	/** Mask of all valid image flags for all formats. */
104	#define VD_IMAGE_FLAGS_MASK (VD_VMDK_IMAGE_FLAGS_MASK \| VD_VDI_IMAGE_FLAGS_MASK)
105
106	/** Default image flags. */
107	#define VD_IMAGE_FLAGS_DEFAULT (VD_IMAGE_FLAGS_NONE)
108	/** @} */
109
110
111	/**
112	* Auxiliary type for describing partitions on raw disks.
113	*/
114	typedef struct VBOXHDDRAWPART
115	{
116	/** Device to use for this partition. Can be the disk device if the offset
117	* field is set appropriately. If this is NULL, then this partition will
118	* not be accessible to the guest. The size of the partition must still
119	* be set correctly. */
120	const char *pszRawDevice;
121	/** Offset where the partition data starts in this device. */
122	uint64_t uPartitionStartOffset;
123	/** Offset where the partition data starts in the disk. */
124	uint64_t uPartitionStart;
125	/** Size of the partition. */
126	uint64_t cbPartition;
127	/** Size of the partitioning info to prepend. */
128	uint64_t cbPartitionData;
129	/** Offset where the partitioning info starts in the disk. */
130	uint64_t uPartitionDataStart;
131	/** Pointer to the partitioning info to prepend. */
132	const void *pvPartitionData;
133	} VBOXHDDRAWPART, *PVBOXHDDRAWPART;
134
135	/**
136	* Auxiliary data structure for creating raw disks.
137	*/
138	typedef struct VBOXHDDRAW
139	{
140	/** Signature for structure. Must be 'R', 'A', 'W', '\0'. Actually a trick
141	* to make logging of the comment string produce sensible results. */
142	char szSignature[4];
143	/** Flag whether access to full disk should be given (ignoring the
144	* partition information below). */
145	bool fRawDisk;
146	/** Filename for the raw disk. Ignored for partitioned raw disks.
147	* For Linux e.g. /dev/sda, and for Windows e.g. \\.\PhysicalDisk0. */
148	const char *pszRawDisk;
149	/** Number of entries in the partitions array. */
150	unsigned cPartitions;
151	/** Pointer to the partitions array. */
152	PVBOXHDDRAWPART pPartitions;
153	} VBOXHDDRAW, *PVBOXHDDRAW;
154
155	/** @name VBox HDD container image open mode flags
156	* @{
157	*/
158	/** Try to open image in read/write exclusive access mode if possible, or in read-only elsewhere. */
159	#define VD_OPEN_FLAGS_NORMAL 0
160	/** Open image in read-only mode with sharing access with others. */
161	#define VD_OPEN_FLAGS_READONLY RT_BIT(0)
162	/** Honor zero block writes instead of ignoring them whenever possible.
163	* This is not supported by all formats. It is silently ignored in this case. */
164	#define VD_OPEN_FLAGS_HONOR_ZEROES RT_BIT(1)
165	/** Honor writes of the same data instead of ignoring whenever possible.
166	* This is handled generically, and is only meaningful for differential image
167	* formats. It is silently ignored otherwise. */
168	#define VD_OPEN_FLAGS_HONOR_SAME RT_BIT(2)
169	/** Do not perform the base/diff image check on open. This internally implies
170	* opening the image as readonly. Images opened with this flag should only be
171	* used for querying information, and nothing else. */
172	#define VD_OPEN_FLAGS_INFO RT_BIT(3)
173	/** Mask of valid flags. */
174	#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)
175	/** @}*/
176
177	/**
178	* Error message callback.
179	*
180	* @param pvUser The opaque data passed on container creation.
181	* @param rc The VBox error code.
182	* @param RT_SRC_POS_DECL Use RT_SRC_POS.
183	* @param pszFormat Error message format string.
184	* @param va Error message arguments.
185	*/
186	typedef DECLCALLBACK(void) FNVDERROR(void pvUser, int rc, RT_SRC_POS_DECL, const char pszFormat, va_list va);
187	/** Pointer to a FNVDERROR(). */
188	typedef FNVDERROR *PFNVDERROR;
189
190
191	/**
192	* VBox HDD Container main structure.
193	*/
194	/* Forward declaration, VBOXHDD structure is visible only inside VBox HDD module. */
195	struct VBOXHDD;
196	typedef struct VBOXHDD VBOXHDD;
197	typedef VBOXHDD *PVBOXHDD;
198
199	/**
200	* Allocates and initializes an empty HDD container.
201	* No image files are opened.
202	*
203	* @returns VBox status code.
204	* @param pfnError Callback for setting extended error information.
205	* @param pvErrorUser Opaque parameter for pfnError.
206	* @param ppDisk Where to store the reference to HDD container.
207	*/
208	VBOXDDU_DECL(int) VDCreate(PFNVDERROR pfnError, void *pvErrorUser,
209	PVBOXHDD *ppDisk);
210
211	/**
212	* Destroys HDD container.
213	* If container has opened image files they will be closed.
214	*
215	* @param pDisk Pointer to HDD container.
216	*/
217	VBOXDDU_DECL(void) VDDestroy(PVBOXHDD pDisk);
218
219	/**
220	* Try to get the backend name which can use this image.
221	*
222	* @returns VBox status code.
223	* @param pszFilename Name of the image file for which the backend is queried.
224	* @param ppszFormat Receives pointer of the UTF-8 string which contains the format name.
225	* The returned pointer must be freed using RTStrFree().
226	*/
227	VBOXDDU_DECL(int) VDGetFormat(const char pszFilename, char *ppszFormat);
228
229	/**
230	* Opens an image file.
231	*
232	* The first opened image file in HDD container must have a base image type,
233	* others (next opened images) must be differencing or undo images.
234	* Linkage is checked for differencing image to be consistent with the previously opened image.
235	* When another differencing image is opened and the last image was opened in read/write access
236	* mode, then the last image is reopened in read-only with deny write sharing mode. This allows
237	* other processes to use images in read-only mode too.
238	*
239	* Note that the image is opened in read-only mode if a read/write open is not possible.
240	* Use VDIsReadOnly to check open mode.
241	*
242	* @returns VBox status code.
243	* @param pDisk Pointer to HDD container.
244	* @param pszBackend Name of the image file backend to use.
245	* @param pszFilename Name of the image file to open.
246	* @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants.
247	*/
248	VBOXDDU_DECL(int) VDOpen(PVBOXHDD pDisk, const char *pszBackend,
249	const char *pszFilename, unsigned uOpenFlags);
250
251	/**
252	* Creates and opens a new base image file.
253	*
254	* @returns VBox status code.
255	* @param pDisk Pointer to HDD container.
256	* @param pszBackend Name of the image file backend to use.
257	* @param pszFilename Name of the image file to create.
258	* @param enmType Image type, only base image types are acceptable.
259	* @param cbSize Image size in bytes.
260	* @param uImageFlags Flags specifying special image features.
261	* @param pszComment Pointer to image comment. NULL is ok.
262	* @param pPCHSGeometry Pointer to physical disk geometry <= (16383,16,63). Not NULL.
263	* @param pLCHSGeometry Pointer to logical disk geometry <= (1024,255,63). Not NULL.
264	* @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants.
265	* @param pfnProgress Progress callback. Optional. NULL if not to be used.
266	* @param pvUser User argument for the progress callback.
267	*/
268	VBOXDDU_DECL(int) VDCreateBase(PVBOXHDD pDisk, const char *pszBackend,
269	const char *pszFilename, VDIMAGETYPE enmType,
270	uint64_t cbSize, unsigned uImageFlags,
271	const char *pszComment,
272	PCPDMMEDIAGEOMETRY pPCHSGeometry,
273	PCPDMMEDIAGEOMETRY pLCHSGeometry,
274	unsigned uOpenFlags, PFNVMPROGRESS pfnProgress,
275	void *pvUser);
276
277	/**
278	* Creates and opens a new differencing image file in HDD container.
279	* See comments for VDOpen function about differencing images.
280	*
281	* @returns VBox status code.
282	* @param pDisk Pointer to HDD container.
283	* @param pszBackend Name of the image file backend to use.
284	* @param pszFilename Name of the differencing image file to create.
285	* @param uImageFlags Flags specifying special image features.
286	* @param pszComment Pointer to image comment. NULL is ok.
287	* @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants.
288	* @param pfnProgress Progress callback. Optional. NULL if not to be used.
289	* @param pvUser User argument for the progress callback.
290	*/
291	VBOXDDU_DECL(int) VDCreateDiff(PVBOXHDD pDisk, const char *pszBackend,
292	const char *pszFilename, unsigned uImageFlags,
293	const char *pszComment, unsigned uOpenFlags,
294	PFNVMPROGRESS pfnProgress, void *pvUser);
295
296	/**
297	* Merges two images (not necessarily with direct parent/child relationship).
298	* As a side effect the source image and potentially the other images which
299	* are also merged to the destination are deleted from both the disk and the
300	* images in the HDD container.
301	*
302	* @returns VBox status code.
303	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
304	* @param pDisk Pointer to HDD container.
305	* @param nImageFrom Name of the image file to merge from.
306	* @param nImageTo Name of the image file to merge to.
307	* @param pfnProgress Progress callback. Optional. NULL if not to be used.
308	* @param pvUser User argument for the progress callback.
309	*/
310	VBOXDDU_DECL(int) VDMerge(PVBOXHDD pDisk, unsigned nImageFrom,
311	unsigned nImageTo, PFNVMPROGRESS pfnProgress,
312	void *pvUser);
313
314	/**
315	* Copies an image from one HDD container to another.
316	* The copy is opened in the target HDD container.
317	* It is possible to convert between different image formats, because the
318	* backend for the destination may be different from the source.
319	* If both the source and destination reference the same HDD container,
320	* then the image is moved (by copying/deleting or renaming) to the new location.
321	* The source container is unchanged if the move operation fails, otherwise
322	* the image at the new location is opened in the same way as the old one was.
323	*
324	* @returns VBox status code.
325	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
326	* @param pDiskFrom Pointer to source HDD container.
327	* @param nImage Image number, counts from 0. 0 is always base image of container.
328	* @param pDiskTo Pointer to destination HDD container.
329	* @param pszBackend Name of the image file backend to use (may be NULL to use the same as the source).
330	* @param pszFilename New name of the image (may be NULL if pDiskFrom == pDiskTo).
331	* @param fMoveByRename If true, attempt to perform a move by renaming (if successful the new size is ignored).
332	* @param cbSize New image size (0 means leave unchanged).
333	* @param pfnProgress Progress callback. Optional. NULL if not to be used.
334	* @param pvUser User argument for the progress callback.
335	*/
336	VBOXDDU_DECL(int) VDCopy(PVBOXHDD pDiskFrom, unsigned nImage, PVBOXHDD pDiskTo,
337	const char pszBackend, const char pszFilename,
338	bool fMoveByRename, uint64_t cbSize,
339	PFNVMPROGRESS pfnProgress, void *pvUser);
340
341	/**
342	* Closes the last opened image file in HDD container.
343	* If previous image file was opened in read-only mode (that is normal) and closing image
344	* was opened in read-write mode (the whole disk was in read-write mode) - the previous image
345	* will be reopened in read/write mode.
346	*
347	* @returns VBox status code.
348	* @returns VERR_VDI_NOT_OPENED if no image is opened in HDD container.
349	* @param pDisk Pointer to HDD container.
350	* @param fDelete If true, delete the image from the host disk.
351	*/
352	VBOXDDU_DECL(int) VDClose(PVBOXHDD pDisk, bool fDelete);
353
354	/**
355	* Closes all opened image files in HDD container.
356	*
357	* @returns VBox status code.
358	* @param pDisk Pointer to HDD container.
359	*/
360	VBOXDDU_DECL(int) VDCloseAll(PVBOXHDD pDisk);
361
362	/**
363	* Read data from virtual HDD.
364	*
365	* @returns VBox status code.
366	* @returns VERR_VDI_NOT_OPENED if no image is opened in HDD container.
367	* @param pDisk Pointer to HDD container.
368	* @param uOffset Offset of first reading byte from start of disk.
369	* @param pvBuf Pointer to buffer for reading data.
370	* @param cbRead Number of bytes to read.
371	*/
372	VBOXDDU_DECL(int) VDRead(PVBOXHDD pDisk, uint64_t uOffset, void *pvBuf, size_t cbRead);
373
374	/**
375	* Write data to virtual HDD.
376	*
377	* @returns VBox status code.
378	* @returns VERR_VDI_NOT_OPENED if no image is opened in HDD container.
379	* @param pDisk Pointer to HDD container.
380	* @param uOffset Offset of first writing byte from start of disk.
381	* @param pvBuf Pointer to buffer for writing data.
382	* @param cbWrite Number of bytes to write.
383	*/
384	VBOXDDU_DECL(int) VDWrite(PVBOXHDD pDisk, uint64_t uOffset, const void *pvBuf, size_t cbWrite);
385
386	/**
387	* Make sure the on disk representation of a virtual HDD is up to date.
388	*
389	* @returns VBox status code.
390	* @returns VERR_VDI_NOT_OPENED if no image is opened in HDD container.
391	* @param pDisk Pointer to HDD container.
392	*/
393	VBOXDDU_DECL(int) VDFlush(PVBOXHDD pDisk);
394
395	/**
396	* Get number of opened images in HDD container.
397	*
398	* @returns Number of opened images for HDD container. 0 if no images have been opened.
399	* @param pDisk Pointer to HDD container.
400	*/
401	VBOXDDU_DECL(unsigned) VDGetCount(PVBOXHDD pDisk);
402
403	/**
404	* Get read/write mode of HDD container.
405	*
406	* @returns Virtual disk ReadOnly status.
407	* @returns true if no image is opened in HDD container.
408	* @param pDisk Pointer to HDD container.
409	*/
410	VBOXDDU_DECL(bool) VDIsReadOnly(PVBOXHDD pDisk);
411
412	/**
413	* Get total capacity of an image in HDD container.
414	*
415	* @returns Virtual disk size in bytes.
416	* @returns 0 if image with specified number was not opened.
417	* @param pDisk Pointer to HDD container.
418	* @param nImage Image number, counts from 0. 0 is always base image of container.
419	*/
420	VBOXDDU_DECL(uint64_t) VDGetSize(PVBOXHDD pDisk, unsigned nImage);
421
422	/**
423	* Get total file size of an image in HDD container.
424	*
425	* @returns Virtual disk size in bytes.
426	* @returns 0 if image with specified number was not opened.
427	* @param pDisk Pointer to HDD container.
428	* @param nImage Image number, counts from 0. 0 is always base image of container.
429	*/
430	VBOXDDU_DECL(uint64_t) VDGetFileSize(PVBOXHDD pDisk, unsigned nImage);
431
432	/**
433	* Get virtual disk PCHS geometry of an image in HDD container.
434	*
435	* @returns VBox status code.
436	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
437	* @returns VERR_VDI_GEOMETRY_NOT_SET if no geometry present in the HDD container.
438	* @param pDisk Pointer to HDD container.
439	* @param nImage Image number, counts from 0. 0 is always base image of container.
440	* @param pPCHSGeometry Where to store PCHS geometry. Not NULL.
441	*/
442	VBOXDDU_DECL(int) VDGetPCHSGeometry(PVBOXHDD pDisk, unsigned nImage,
443	PPDMMEDIAGEOMETRY pPCHSGeometry);
444
445	/**
446	* Store virtual disk PCHS geometry of an image in HDD container.
447	*
448	* @returns VBox status code.
449	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
450	* @param pDisk Pointer to HDD container.
451	* @param nImage Image number, counts from 0. 0 is always base image of container.
452	* @param pPCHSGeometry Where to load PCHS geometry from. Not NULL.
453	*/
454	VBOXDDU_DECL(int) VDSetPCHSGeometry(PVBOXHDD pDisk, unsigned nImage,
455	PCPDMMEDIAGEOMETRY pPCHSGeometry);
456
457	/**
458	* Get virtual disk LCHS geometry of an image in HDD container.
459	*
460	* @returns VBox status code.
461	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
462	* @returns VERR_VDI_GEOMETRY_NOT_SET if no geometry present in the HDD container.
463	* @param pDisk Pointer to HDD container.
464	* @param nImage Image number, counts from 0. 0 is always base image of container.
465	* @param pLCHSGeometry Where to store LCHS geometry. Not NULL.
466	*/
467	VBOXDDU_DECL(int) VDGetLCHSGeometry(PVBOXHDD pDisk, unsigned nImage,
468	PPDMMEDIAGEOMETRY pLCHSGeometry);
469
470	/**
471	* Store virtual disk LCHS geometry of an image in HDD container.
472	*
473	* @returns VBox status code.
474	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
475	* @param pDisk Pointer to HDD container.
476	* @param nImage Image number, counts from 0. 0 is always base image of container.
477	* @param pLCHSGeometry Where to load LCHS geometry from. Not NULL.
478	*/
479	VBOXDDU_DECL(int) VDSetLCHSGeometry(PVBOXHDD pDisk, unsigned nImage,
480	PCPDMMEDIAGEOMETRY pLCHSGeometry);
481
482	/**
483	* Get version of image in HDD container.
484	*
485	* @returns VBox status code.
486	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
487	* @param pDisk Pointer to HDD container.
488	* @param nImage Image number, counts from 0. 0 is always base image of container.
489	* @param puVersion Where to store the image version.
490	*/
491	VBOXDDU_DECL(int) VDGetVersion(PVBOXHDD pDisk, unsigned nImage,
492	unsigned *puVersion);
493
494	/**
495	* Get type of image in HDD container.
496	*
497	* @returns VBox status code.
498	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
499	* @param pDisk Pointer to HDD container.
500	* @param nImage Image number, counts from 0. 0 is always base image of container.
501	* @param penmType Where to store the image type.
502	*/
503	VBOXDDU_DECL(int) VDGetImageType(PVBOXHDD pDisk, unsigned nImage,
504	PVDIMAGETYPE penmType);
505
506	/**
507	* Get flags of image in HDD container.
508	*
509	* @returns VBox status code.
510	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
511	* @param pDisk Pointer to HDD container.
512	* @param nImage Image number, counts from 0. 0 is always base image of container.
513	* @param puImageFlags Where to store the image flags.
514	*/
515	VBOXDDU_DECL(int) VDGetImageFlags(PVBOXHDD pDisk, unsigned nImage, unsigned *puImageFlags);
516
517	/**
518	* Get open flags of image in HDD container.
519	*
520	* @returns VBox status code.
521	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
522	* @param pDisk Pointer to HDD container.
523	* @param nImage Image number, counts from 0. 0 is always base image of container.
524	* @param puOpenFlags Where to store the image open flags.
525	*/
526	VBOXDDU_DECL(int) VDGetOpenFlags(PVBOXHDD pDisk, unsigned nImage,
527	unsigned *puOpenFlags);
528
529	/**
530	* Set open flags of image in HDD container.
531	* This operation may cause file locking changes and/or files being reopened.
532	* Note that in case of unrecoverable error all images in HDD container will be closed.
533	*
534	* @returns VBox status code.
535	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
536	* @param pDisk Pointer to HDD container.
537	* @param nImage Image number, counts from 0. 0 is always base image of container.
538	* @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants.
539	*/
540	VBOXDDU_DECL(int) VDSetOpenFlags(PVBOXHDD pDisk, unsigned nImage,
541	unsigned uOpenFlags);
542
543	/**
544	* Get base filename of image in HDD container. Some image formats use
545	* other filenames as well, so don't use this for anything but informational
546	* purposes.
547	*
548	* @returns VBox status code.
549	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
550	* @returns VERR_BUFFER_OVERFLOW if pszFilename buffer too small to hold filename.
551	* @param pDisk Pointer to HDD container.
552	* @param nImage Image number, counts from 0. 0 is always base image of container.
553	* @param pszFilename Where to store the image file name.
554	* @param cbFilename Size of buffer pszFilename points to.
555	*/
556	VBOXDDU_DECL(int) VDGetFilename(PVBOXHDD pDisk, unsigned nImage,
557	char *pszFilename, unsigned cbFilename);
558
559	/**
560	* Get the comment line of image in HDD container.
561	*
562	* @returns VBox status code.
563	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
564	* @returns VERR_BUFFER_OVERFLOW if pszComment buffer too small to hold comment text.
565	* @param pDisk Pointer to HDD container.
566	* @param nImage Image number, counts from 0. 0 is always base image of container.
567	* @param pszComment Where to store the comment string of image. NULL is ok.
568	* @param cbComment The size of pszComment buffer. 0 is ok.
569	*/
570	VBOXDDU_DECL(int) VDGetComment(PVBOXHDD pDisk, unsigned nImage,
571	char *pszComment, unsigned cbComment);
572
573	/**
574	* Changes the comment line of image in HDD container.
575	*
576	* @returns VBox status code.
577	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
578	* @param pDisk Pointer to HDD container.
579	* @param nImage Image number, counts from 0. 0 is always base image of container.
580	* @param pszComment New comment string (UTF-8). NULL is allowed to reset the comment.
581	*/
582	VBOXDDU_DECL(int) VDSetComment(PVBOXHDD pDisk, unsigned nImage,
583	const char *pszComment);
584
585	/**
586	* Get UUID of image in HDD container.
587	*
588	* @returns VBox status code.
589	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
590	* @param pDisk Pointer to HDD container.
591	* @param nImage Image number, counts from 0. 0 is always base image of container.
592	* @param pUuid Where to store the image UUID.
593	*/
594	VBOXDDU_DECL(int) VDGetUuid(PVBOXHDD pDisk, unsigned nImage, PRTUUID pUuid);
595
596	/**
597	* Set the image's UUID. Should not be used by normal applications.
598	*
599	* @returns VBox status code.
600	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
601	* @param pDisk Pointer to HDD container.
602	* @param nImage Image number, counts from 0. 0 is always base image of container.
603	* @param pUuid New UUID of the image. If NULL, a new UUID is created.
604	*/
605	VBOXDDU_DECL(int) VDSetUuid(PVBOXHDD pDisk, unsigned nImage, PCRTUUID pUuid);
606
607	/**
608	* Get last modification UUID of image in HDD container.
609	*
610	* @returns VBox status code.
611	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
612	* @param pDisk Pointer to HDD container.
613	* @param nImage Image number, counts from 0. 0 is always base image of container.
614	* @param pUuid Where to store the image modification UUID.
615	*/
616	VBOXDDU_DECL(int) VDGetModificationUuid(PVBOXHDD pDisk, unsigned nImage,
617	PRTUUID pUuid);
618
619	/**
620	* Set the image's last modification UUID. Should not be used by normal applications.
621	*
622	* @returns VBox status code.
623	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
624	* @param pDisk Pointer to HDD container.
625	* @param nImage Image number, counts from 0. 0 is always base image of container.
626	* @param pUuid New modification UUID of the image. If NULL, a new UUID is created.
627	*/
628	VBOXDDU_DECL(int) VDSetModificationUuid(PVBOXHDD pDisk, unsigned nImage,
629	PCRTUUID pUuid);
630
631	/**
632	* Get parent UUID of image in HDD container.
633	*
634	* @returns VBox status code.
635	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
636	* @param pDisk Pointer to HDD container.
637	* @param nImage Image number, counts from 0. 0 is always base image of the container.
638	* @param pUuid Where to store the parent image UUID.
639	*/
640	VBOXDDU_DECL(int) VDGetParentUuid(PVBOXHDD pDisk, unsigned nImage,
641	PRTUUID pUuid);
642
643	/**
644	* Set the image's parent UUID. Should not be used by normal applications.
645	*
646	* @returns VBox status code.
647	* @param pDisk Pointer to HDD container.
648	* @param nImage Image number, counts from 0. 0 is always base image of container.
649	* @param pUuid New parent UUID of the image. If NULL, a new UUID is created.
650	*/
651	VBOXDDU_DECL(int) VDSetParentUuid(PVBOXHDD pDisk, unsigned nImage,
652	PCRTUUID pUuid);
653
654
655	/**
656	* Debug helper - dumps all opened images in HDD container into the log file.
657	*
658	* @param pDisk Pointer to HDD container.
659	*/
660	VBOXDDU_DECL(void) VDDumpImages(PVBOXHDD pDisk);
661
662	__END_DECLS
663
664	/** @} */
665
666	#endif

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

source: vbox/trunk/include/VBox/VBoxHDD-new.h@ 7581

Download in other formats: