ssm.h@ 24646

Last change on this file since 24646 was 24264, checked in by vboxsync, 15 years ago
SSM: Added SSMR3SetLoadError[V] and SSMR3SetCfgError for setting log errors.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 45.6 KB

Line
1	/** @file
2	* SSM - The Save State Manager. (VMM)
3	*/
4
5	/*
6	* Copyright (C) 2006-2007 Sun Microsystems, Inc.
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	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
26	* Clara, CA 95054 USA or visit http://www.sun.com if you need
27	* additional information or have any questions.
28	*/
29
30	#ifndef ___VBox_ssm_h
31	#define ___VBox_ssm_h
32
33	#include <VBox/cdefs.h>
34	#include <VBox/types.h>
35	#include <VBox/tm.h>
36	#include <VBox/vmapi.h>
37
38	RT_C_DECLS_BEGIN
39
40	/** @defgroup grp_ssm The Saved State Manager API
41	* @{
42	*/
43
44	/**
45	* Determine the major version of the SSM version. If the major SSM version of two snapshots is
46	* different, the snapshots are incompatible.
47	*/
48	#define SSM_VERSION_MAJOR(ver) ((ver) & 0xffff0000)
49
50	/**
51	* Determine the minor version of the SSM version. If the major SSM version of two snapshots is
52	* the same, the code must handle incompatibilies between minor version changes (e.g. use dummy
53	* values for non-existent fields).
54	*/
55	#define SSM_VERSION_MINOR(ver) ((ver) & 0x0000ffff)
56
57	/**
58	* Determine if the major version changed between two SSM versions.
59	*/
60	#define SSM_VERSION_MAJOR_CHANGED(ver1,ver2) (SSM_VERSION_MAJOR(ver1) != SSM_VERSION_MAJOR(ver2))
61
62	/** The special value for the final pass. */
63	#define SSM_PASS_FINAL UINT32_MAX
64
65
66	#ifdef IN_RING3
67	/** @defgroup grp_ssm_r3 The SSM Host Context Ring-3 API
68	* @{
69	*/
70
71
72	/**
73	* What to do after the save/load operation.
74	*/
75	typedef enum SSMAFTER
76	{
77	/** Invalid. */
78	SSMAFTER_INVALID = 0,
79	/** Will resume the loaded state. */
80	SSMAFTER_RESUME,
81	/** Will destroy the VM after saving. */
82	SSMAFTER_DESTROY,
83	/** Will continue execution after saving the VM. */
84	SSMAFTER_CONTINUE,
85	/** Will teleport the VM.
86	* The source VM will be destroyed (then one saving), the destination VM
87	* will continue execution. */
88	SSMAFTER_TELEPORT,
89	/** Will debug the saved state.
90	* This is used to drop some of the stricter consitentcy checks so it'll
91	* load fine in the debugger or animator. */
92	SSMAFTER_DEBUG_IT,
93	/** The file was opened using SSMR3Open() and we have no idea what the plan is. */
94	SSMAFTER_OPENED
95	} SSMAFTER;
96
97
98	/** Pointer to a structure field description. */
99	typedef struct SSMFIELD *PSSMFIELD;
100	/** Pointer to a const structure field description. */
101	typedef const struct SSMFIELD *PCSSMFIELD;
102
103	/**
104	* SSMFIELD Get/Put callback function.
105	*
106	* This is call for getting and putting the field it is associated with. It's
107	* up to the callback to work the saved state correctly.
108	*
109	* @returns VBox status code.
110	*
111	* @param pSSM The saved state handle.
112	* @param pField The field that is being processed.
113	* @param pvStruct Pointer to the structure.
114	* @param fFlags SSMSTRUCT_FLAGS_XXX.
115	* @param fGetOrPut True if getting, false if putting.
116	* @param pvUser The user argument specified to SSMR3GetStructEx or
117	* SSMR3PutStructEx.
118	*/
119	typedef DECLCALLBACK(int) FNSSMFIELDGETPUT(PSSMHANDLE pSSM, const struct SSMFIELD pField, void pvStruct,
120	uint32_t fFlags, bool fGetOrPut, void *pvUser);
121	/** Pointer to a SSMFIELD Get/Put callback. */
122	typedef FNSSMFIELDGETPUT *PFNSSMFIELDGETPUT;
123
124	/**
125	* SSM field transformers.
126	*
127	* These are stored in the SSMFIELD::pfnGetPutOrTransformer and must therefore
128	* have values outside the valid pointer range.
129	*/
130	typedef enum SSMFIELDTRANS
131	{
132	/** Invalid. */
133	SSMFIELDTRANS_INVALID = 0,
134	/** No transformation. */
135	SSMFIELDTRANS_NO_TRANSFORMATION,
136	/** Guest context (GC) physical address. */
137	SSMFIELDTRANS_GCPHYS,
138	/** Guest context (GC) virtual address. */
139	SSMFIELDTRANS_GCPTR,
140	/** Raw-mode context (RC) virtual address. */
141	SSMFIELDTRANS_RCPTR,
142	/** Array of raw-mode context (RC) virtual addresses. */
143	SSMFIELDTRANS_RCPTR_ARRAY,
144	/** Host context (HC) virtual address used as a NULL indicator. See
145	* SSMFIELD_ENTRY_HCPTR_NI. */
146	SSMFIELDTRANS_HCPTR_NI,
147	/** Array of SSMFIELDTRANS_HCPTR_NI. */
148	SSMFIELDTRANS_HCPTR_NI_ARRAY,
149	/** Host context (HC) virtual address used to hold a unsigned 32-bit value. */
150	SSMFIELDTRANS_HCPTR_HACK_U32,
151
152	/** Ignorable field. See SSMFIELD_ENTRY_IGNORE. */
153	SSMFIELDTRANS_IGNORE,
154	/** Ignorable guest context (GC) physical address. */
155	SSMFIELDTRANS_IGN_GCPHYS,
156	/** Ignorable guest context (GC) virtual address. */
157	SSMFIELDTRANS_IGN_GCPTR,
158	/** Ignorable raw-mode context (RC) virtual address. */
159	SSMFIELDTRANS_IGN_RCPTR,
160	/** Ignorable host context (HC) virtual address. */
161	SSMFIELDTRANS_IGN_HCPTR,
162
163	/** Old field.
164	* Save as zeros and skip on restore (nowhere to restore it any longer). */
165	SSMFIELDTRANS_OLD,
166	/** Old guest context (GC) physical address. */
167	SSMFIELDTRANS_OLD_GCPHYS,
168	/** Old guest context (GC) virtual address. */
169	SSMFIELDTRANS_OLD_GCPTR,
170	/** Old raw-mode context (RC) virtual address. */
171	SSMFIELDTRANS_OLD_RCPTR,
172	/** Old host context (HC) virtual address. */
173	SSMFIELDTRANS_OLD_HCPTR,
174	/** Old host context specific padding.
175	* The lower word is the size of 32-bit hosts, the upper for 64-bit hosts. */
176	SSMFIELDTRANS_OLD_PAD_HC,
177	/** Old padding specific to the 32-bit Microsoft C Compiler. */
178	SSMFIELDTRANS_OLD_PAD_MSC32,
179
180	/** Padding that differs between 32-bit and 64-bit hosts.
181	* The first byte of SSMFIELD::cb contains the size for 32-bit hosts.
182	* The second byte of SSMFIELD::cb contains the size for 64-bit hosts.
183	* The upper word of SSMFIELD::cb contains the actual field size.
184	*/
185	SSMFIELDTRANS_PAD_HC,
186	/** Padding for 32-bit hosts only.
187	* SSMFIELD::cb has the same format as for SSMFIELDTRANS_PAD_HC. */
188	SSMFIELDTRANS_PAD_HC32,
189	/** Padding for 64-bit hosts only.
190	* SSMFIELD::cb has the same format as for SSMFIELDTRANS_PAD_HC. */
191	SSMFIELDTRANS_PAD_HC64,
192	/** Automatic compiler padding that may differ between 32-bit and
193	* 64-bit hosts. SSMFIELD::cb has the same format as for
194	* SSMFIELDTRANS_PAD_HC. */
195	SSMFIELDTRANS_PAD_HC_AUTO,
196	/** Automatic compiler padding specific to the 32-bit Microsoft C
197	* compiler.
198	* SSMFIELD::cb has the same format as for SSMFIELDTRANS_PAD_HC. */
199	SSMFIELDTRANS_PAD_MSC32_AUTO
200	} SSMFIELDTRANS;
201
202	/** Tests if it's a padding field with the special SSMFIELD::cb format.
203	* @returns true / false.
204	* @param pfn The SSMFIELD::pfnGetPutOrTransformer value.
205	*/
206	#define SSMFIELDTRANS_IS_PADDING(pfn) \
207	( (uintptr_t)(pfn) >= SSMFIELDTRANS_PAD_HC && (uintptr_t)(pfn) <= SSMFIELDTRANS_PAD_MSC32_AUTO )
208
209	/** Tests if it's an entry for an old field.
210	*
211	* @returns true / false.
212	* @param pfn The SSMFIELD::pfnGetPutOrTransformer value.
213	*/
214	#define SSMFIELDTRANS_IS_OLD(pfn) \
215	( (uintptr_t)(pfn) >= SSMFIELDTRANS_OLD && (uintptr_t)(pfn) <= SSMFIELDTRANS_OLD_PAD_MSC32 )
216
217	/**
218	* A structure field description.
219	*/
220	typedef struct SSMFIELD
221	{
222	/** Getter and putter callback or transformer index. */
223	PFNSSMFIELDGETPUT pfnGetPutOrTransformer;
224	/** Field offset into the structure. */
225	uint32_t off;
226	/** The size of the field. */
227	uint32_t cb;
228	/** Field name. */
229	const char *pszName;
230	} SSMFIELD;
231
232	/** Emit a SSMFIELD array entry.
233	* @internal */
234	#define SSMFIELD_ENTRY_INT(Name, off, cb, enmTransformer) \
235	{ (PFNSSMFIELDGETPUT)(uintptr_t)(enmTransformer), (off), (cb), Name }
236	/** Emit a SSMFIELD array entry.
237	* @internal */
238	#define SSMFIELD_ENTRY_TF_INT(Type, Field, enmTransformer) \
239	SSMFIELD_ENTRY_INT(#Type "::" #Field, RT_OFFSETOF(Type, Field), RT_SIZEOFMEMB(Type, Field), enmTransformer)
240	/** Emit a SSMFIELD array entry for an old field.
241	* @internal */
242	#define SSMFIELD_ENTRY_OLD_INT(Field, cb, enmTransformer) \
243	SSMFIELD_ENTRY_INT("old::" #Field, UINT32_MAX / 2, (cb), enmTransformer)
244	/** Emit a SSMFIELD array entry for an alignment padding.
245	* @internal */
246	#define SSMFIELD_ENTRY_PAD_INT(Type, Field, cb32, cb64, enmTransformer) \
247	SSMFIELD_ENTRY_INT(#Type "::" #Field, RT_OFFSETOF(Type, Field), \
248	(RT_SIZEOFMEMB(Type, Field) << 16) \| (cb32) \| ((cb64) << 8), enmTransformer)
249	/** Emit a SSMFIELD array entry for an alignment padding.
250	* @internal */
251	#define SSMFIELD_ENTRY_PAD_OTHER_INT(Type, Field, cb32, cb64, enmTransformer) \
252	SSMFIELD_ENTRY_INT(#Type "::" #Field, UINT32_MAX / 2, 0 \| (cb32) \| ((cb64) << 8), enmTransformer)
253
254	/** Emit a SSMFIELD array entry. */
255	#define SSMFIELD_ENTRY(Type, Field) SSMFIELD_ENTRY_TF_INT(Type, Field, SSMFIELDTRANS_NO_TRANSFORMATION)
256	/** Emit a SSMFIELD array entry for a custom made field. This is intended
257	* for working around bitfields in old structures. */
258	#define SSMFIELD_ENTRY_CUSTOM(Field, off, cb) SSMFIELD_ENTRY_INT("custom::" #Field, off, cb, SSMFIELDTRANS_NO_TRANSFORMATION)
259	/** Emit a SSMFIELD array entry for a RTGCPHYS type. */
260	#define SSMFIELD_ENTRY_GCPHYS(Type, Field) SSMFIELD_ENTRY_TF_INT(Type, Field, SSMFIELDTRANS_GCPHYS)
261	/** Emit a SSMFIELD array entry for a RTGCPTR type. */
262	#define SSMFIELD_ENTRY_GCPTR(Type, Field) SSMFIELD_ENTRY_TF_INT(Type, Field, SSMFIELDTRANS_GCPTR)
263	/** Emit a SSMFIELD array entry for a raw-mode context pointer. */
264	#define SSMFIELD_ENTRY_RCPTR(Type, Field) SSMFIELD_ENTRY_TF_INT(Type, Field, SSMFIELDTRANS_RCPTR)
265	/** Emit a SSMFIELD array entry for a raw-mode context pointer. */
266	#define SSMFIELD_ENTRY_RCPTR_ARRAY(Type, Field) SSMFIELD_ENTRY_TF_INT(Type, Field, SSMFIELDTRANS_RCPTR_ARRAY)
267	/** Emit a SSMFIELD array entry for a ring-0 or ring-3 pointer type that is only
268	* of interest as a NULL indicator.
269	*
270	* This is always restored as a 0 (NULL) or 1 value. When
271	* SSMSTRUCT_FLAGS_DONT_IGNORE is set, the pointer will be saved in its
272	* entirety, when clear it will be saved as a boolean. */
273	#define SSMFIELD_ENTRY_HCPTR_NI(Type, Field) SSMFIELD_ENTRY_TF_INT(Type, Field, SSMFIELDTRANS_HCPTR_NI)
274	/** Same as SSMFIELD_ENTRY_HCPTR_NI, except it's an array of the buggers. */
275	#define SSMFIELD_ENTRY_HCPTR_NI_ARRAY(Type, Field) SSMFIELD_ENTRY_TF_INT(Type, Field, SSMFIELDTRANS_HCPTR_NI_ARRAY)
276	/** Emit a SSMFIELD array entry for a ring-0 or ring-3 pointer type that has
277	* been hacked such that it will never exceed 32-bit. No sign extenending. */
278	#define SSMFIELD_ENTRY_HCPTR_HACK_U32(Type, Field) SSMFIELD_ENTRY_TF_INT(Type, Field, SSMFIELDTRANS_HCPTR_HACK_U32)
279
280	/** Emit a SSMFIELD array entry for a field that can be ignored.
281	* It is stored as zeros if SSMSTRUCT_FLAGS_DONT_IGNORE is specified to
282	* SSMR3PutStructEx. The member is never touched upon restore. */
283	#define SSMFIELD_ENTRY_IGNORE(Type, Field) SSMFIELD_ENTRY_TF_INT(Type, Field, SSMFIELDTRANS_IGNORE)
284	/** Emit a SSMFIELD array entry for an ignorable RTGCPHYS type. */
285	#define SSMFIELD_ENTRY_IGN_GCPHYS(Type, Field) SSMFIELD_ENTRY_TF_INT(Type, Field, SSMFIELDTRANS_IGN_GCPHYS)
286	/** Emit a SSMFIELD array entry for an ignorable RTGCPHYS type. */
287	#define SSMFIELD_ENTRY_IGN_GCPTR(Type, Field) SSMFIELD_ENTRY_TF_INT(Type, Field, SSMFIELDTRANS_IGN_GCPTR)
288	/** Emit a SSMFIELD array entry for an ignorable raw-mode context pointer. */
289	#define SSMFIELD_ENTRY_IGN_RCPTR(Type, Field) SSMFIELD_ENTRY_TF_INT(Type, Field, SSMFIELDTRANS_IGN_RCPTR)
290	/** Emit a SSMFIELD array entry for an ignorable ring-3 or/and ring-0 pointer. */
291	#define SSMFIELD_ENTRY_IGN_HCPTR(Type, Field) SSMFIELD_ENTRY_TF_INT(Type, Field, SSMFIELDTRANS_IGN_HCPTR)
292
293	/** Emit a SSMFIELD array entry for an old field that should be ignored now.
294	* It is stored as zeros and skipped on load. */
295	#define SSMFIELD_ENTRY_OLD(Field, cb) SSMFIELD_ENTRY_OLD_INT(Field, cb, SSMFIELDTRANS_OLD)
296	/** Same as SSMFIELD_ENTRY_IGN_GCPHYS, except there is no structure field. */
297	#define SSMFIELD_ENTRY_OLD_GCPHYS(Field) SSMFIELD_ENTRY_OLD_INT(Field, sizeof(RTGCPHYS), SSMFIELDTRANS_OLD_GCPHYS)
298	/** Same as SSMFIELD_ENTRY_IGN_GCPTR, except there is no structure field. */
299	#define SSMFIELD_ENTRY_OLD_GCPTR(Field) SSMFIELD_ENTRY_OLD_INT(Field, sizeof(RTGCPTR), SSMFIELDTRANS_OLD_GCPTR)
300	/** Same as SSMFIELD_ENTRY_IGN_RCPTR, except there is no structure field. */
301	#define SSMFIELD_ENTRY_OLD_RCPTR(Field) SSMFIELD_ENTRY_OLD_INT(Field, sizeof(RTRCPTR), SSMFIELDTRANS_OLD_RCPTR)
302	/** Same as SSMFIELD_ENTRY_IGN_HCPTR, except there is no structure field. */
303	#define SSMFIELD_ENTRY_OLD_HCPTR(Field) SSMFIELD_ENTRY_OLD_INT(Field, sizeof(RTHCPTR), SSMFIELDTRANS_OLD_HCPTR)
304	/** Same as SSMFIELD_ENTRY_PAD_HC, except there is no structure field. */
305	#define SSMFIELD_ENTRY_OLD_PAD_HC(Field, cb32, cb64) \
306	SSMFIELD_ENTRY_OLD_INT(Field, RT_MAKE_U32((cb32), (cb64)), SSMFIELDTRANS_OLD_PAD_HC)
307	/** Same as SSMFIELD_ENTRY_PAD_HC64, except there is no structure field. */
308	#define SSMFIELD_ENTRY_OLD_PAD_HC64(Field, cb) SSMFIELD_ENTRY_OLD_PAD_HC(Field, 0, cb)
309	/** Same as SSMFIELD_ENTRY_PAD_HC32, except there is no structure field. */
310	#define SSMFIELD_ENTRY_OLD_PAD_HC32(Field, cb) SSMFIELD_ENTRY_OLD_PAD_HC(Field, cb, 0)
311	/** Same as SSMFIELD_ENTRY_PAD_HC, except there is no structure field. */
312	#define SSMFIELD_ENTRY_OLD_PAD_MSC32(Field, cb) SSMFIELD_ENTRY_OLD_INT(Field, cb, SSMFIELDTRANS_OLD_PAD_MSC32)
313
314	/** Emit a SSMFIELD array entry for a padding that differs in size between
315	* 64-bit and 32-bit hosts. */
316	#define SSMFIELD_ENTRY_PAD_HC(Type, Field, cb32, cb64) SSMFIELD_ENTRY_PAD_INT( Type, Field, cb32, cb64, SSMFIELDTRANS_PAD_HC)
317	/** Emit a SSMFIELD array entry for a padding that is exclusive to 64-bit hosts. */
318	#if HC_ARCH_BITS == 64
319	# define SSMFIELD_ENTRY_PAD_HC64(Type, Field, cb) SSMFIELD_ENTRY_PAD_INT( Type, Field, 0, cb, SSMFIELDTRANS_PAD_HC64)
320	#else
321	# define SSMFIELD_ENTRY_PAD_HC64(Type, Field, cb) SSMFIELD_ENTRY_PAD_OTHER_INT(Type, Field, 0, cb, SSMFIELDTRANS_PAD_HC64)
322	#endif
323	/** Emit a SSMFIELD array entry for a 32-bit padding for on 64-bits hosts. */
324	#if HC_ARCH_BITS == 32
325	# define SSMFIELD_ENTRY_PAD_HC32(Type, Field, cb) SSMFIELD_ENTRY_PAD_INT( Type, Field, cb, 0, SSMFIELDTRANS_PAD_HC32)
326	#else
327	# define SSMFIELD_ENTRY_PAD_HC32(Type, Field, cb) SSMFIELD_ENTRY_PAD_OTHER_INT(Type, Field, cb, 0, SSMFIELDTRANS_PAD_HC32)
328	#endif
329	/** Emit a SSMFIELD array entry for an automatic compiler padding that may
330	* differ in size between 64-bit and 32-bit hosts. */
331	#if HC_ARCH_BITS == 64
332	# define SSMFIELD_ENTRY_PAD_HC_AUTO(cb32, cb64) \
333	{ \
334	(PFNSSMFIELDGETPUT)(uintptr_t)(SSMFIELDTRANS_PAD_HC_AUTO), \
335	UINT32_MAX / 2, (cb64 << 16) \| (cb32) \| ((cb64) << 8), "<compiler-padding>" \
336	}
337	#else
338	# define SSMFIELD_ENTRY_PAD_HC_AUTO(cb32, cb64) \
339	{ \
340	(PFNSSMFIELDGETPUT)(uintptr_t)(SSMFIELDTRANS_PAD_HC_AUTO), \
341	UINT32_MAX / 2, (cb32 << 16) \| (cb32) \| ((cb64) << 8), "<compiler-padding>" \
342	}
343	#endif
344	/** Emit a SSMFIELD array entry for an automatic compiler padding that is unique
345	* to the 32-bit microsoft compiler. This is usually used together with
346	* SSMFIELD_ENTRY_PAD_HC. /
347	#if HC_ARCH_BITS == 32 && defined(_MSC_VER)
348	# define SSMFIELD_ENTRY_PAD_MSC32_AUTO(cb) \
349	{ \
350	(PFNSSMFIELDGETPUT)(uintptr_t)(SSMFIELDTRANS_PAD_MSC32_AUTO), \
351	UINT32_MAX / 2, ((cb) << 16) \| (cb), "<msc32-padding>" \
352	}
353	#else
354	# define SSMFIELD_ENTRY_PAD_MSC32_AUTO(cb) \
355	{ \
356	(PFNSSMFIELDGETPUT)(uintptr_t)(SSMFIELDTRANS_PAD_MSC32_AUTO), \
357	UINT32_MAX / 2, (cb), "<msc32-padding>" \
358	}
359	#endif
360
361	/** Emit a SSMFIELD array entry for a field with a custom callback. */
362	#define SSMFIELD_ENTRY_CALLBACK(Type, Field, pfnGetPut) \
363	{ (pfnGetPut), RT_OFFSETOF(Type, Field), RT_SIZEOFMEMB(Type, Field), #Type "::" #Field }
364	/** Emit the terminating entry of a SSMFIELD array. */
365	#define SSMFIELD_ENTRY_TERM() { (PFNSSMFIELDGETPUT)(uintptr_t)SSMFIELDTRANS_INVALID, UINT32_MAX, UINT32_MAX, NULL }
366
367
368	/** @name SSMR3GetStructEx and SSMR3PutStructEx flags.
369	* @{ */
370	/** The field descriptors must exactly cover the entire struct, A to Z. */
371	#define SSMSTRUCT_FLAGS_FULL_STRUCT RT_BIT_32(0)
372	/** No start and end markers, just the raw bits. */
373	#define SSMSTRUCT_FLAGS_NO_MARKERS RT_BIT_32(1)
374	/** Do not ignore any ignorable fields. */
375	#define SSMSTRUCT_FLAGS_DONT_IGNORE RT_BIT_32(2)
376	/** Saved using SSMR3PutMem, don't be too strict. */
377	#define SSMSTRUCT_FLAGS_SAVED_AS_MEM RT_BIT_32(3)
378	/** Band-aid for old SSMR3PutMem/SSMR3GetMem of structurs with host pointers. */
379	#define SSMSTRUCT_FLAGS_MEM_BAND_AID ( SSMSTRUCT_FLAGS_DONT_IGNORE \| SSMSTRUCT_FLAGS_FULL_STRUCT \
380	\| SSMSTRUCT_FLAGS_NO_MARKERS \| SSMSTRUCT_FLAGS_SAVED_AS_MEM)
381	/** Mask of the valid bits. */
382	#define SSMSTRUCT_FLAGS_VALID_MASK UINT32_C(0x0000000f)
383	/** @} */
384
385
386	/** The PDM Device callback variants.
387	* @{
388	*/
389
390	/**
391	* Prepare state live save operation.
392	*
393	* @returns VBox status code.
394	* @param pDevIns Device instance of the device which registered the data unit.
395	* @param pSSM SSM operation handle.
396	* @thread Any.
397	*/
398	typedef DECLCALLBACK(int) FNSSMDEVLIVEPREP(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
399	/** Pointer to a FNSSMDEVLIVEPREP() function. */
400	typedef FNSSMDEVLIVEPREP *PFNSSMDEVLIVEPREP;
401
402	/**
403	* Execute state live save operation.
404	*
405	* This will be called repeatedly until all units vote that the live phase has
406	* been concluded.
407	*
408	* @returns VBox status code.
409	* @param pDevIns Device instance of the device which registered the data unit.
410	* @param pSSM SSM operation handle.
411	* @param uPass The pass.
412	* @thread Any.
413	*/
414	typedef DECLCALLBACK(int) FNSSMDEVLIVEEXEC(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uPass);
415	/** Pointer to a FNSSMDEVLIVEEXEC() function. */
416	typedef FNSSMDEVLIVEEXEC *PFNSSMDEVLIVEEXEC;
417
418	/**
419	* Vote on whether the live part of the saving has been concluded.
420	*
421	* The vote stops once a unit has vetoed the decision, so don't rely upon this
422	* being called every time.
423	*
424	* @returns VBox status code.
425	* @retval VINF_SUCCESS if done.
426	* @retval VINF_SSM_VOTE_FOR_ANOTHER_PASS if another pass is needed.
427	* @retval VINF_SSM_VOTE_DONE_DONT_CALL_AGAIN if the live saving of the unit is
428	* done and there is not need calling it again before the final pass.
429	* @retval VERR_SSM_VOTE_FOR_GIVING_UP if its time to give up.
430	*
431	* @param pDevIns Device instance of the device which registered the data unit.
432	* @param pSSM SSM operation handle.
433	* @thread Any.
434	*/
435	typedef DECLCALLBACK(int) FNSSMDEVLIVEVOTE(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
436	/** Pointer to a FNSSMDEVLIVEVOTE() function. */
437	typedef FNSSMDEVLIVEVOTE *PFNSSMDEVLIVEVOTE;
438
439	/**
440	* Prepare state save operation.
441	*
442	* @returns VBox status code.
443	* @param pDevIns Device instance of the device which registered the data unit.
444	* @param pSSM SSM operation handle.
445	*/
446	typedef DECLCALLBACK(int) FNSSMDEVSAVEPREP(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
447	/** Pointer to a FNSSMDEVSAVEPREP() function. */
448	typedef FNSSMDEVSAVEPREP *PFNSSMDEVSAVEPREP;
449
450	/**
451	* Execute state save operation.
452	*
453	* @returns VBox status code.
454	* @param pDevIns Device instance of the device which registered the data unit.
455	* @param pSSM SSM operation handle.
456	*/
457	typedef DECLCALLBACK(int) FNSSMDEVSAVEEXEC(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
458	/** Pointer to a FNSSMDEVSAVEEXEC() function. */
459	typedef FNSSMDEVSAVEEXEC *PFNSSMDEVSAVEEXEC;
460
461	/**
462	* Done state save operation.
463	*
464	* @returns VBox status code.
465	* @param pDevIns Device instance of the device which registered the data unit.
466	* @param pSSM SSM operation handle.
467	*/
468	typedef DECLCALLBACK(int) FNSSMDEVSAVEDONE(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
469	/** Pointer to a FNSSMDEVSAVEDONE() function. */
470	typedef FNSSMDEVSAVEDONE *PFNSSMDEVSAVEDONE;
471
472	/**
473	* Prepare state load operation.
474	*
475	* @returns VBox status code.
476	* @param pDevIns Device instance of the device which registered the data unit.
477	* @param pSSM SSM operation handle.
478	*/
479	typedef DECLCALLBACK(int) FNSSMDEVLOADPREP(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
480	/** Pointer to a FNSSMDEVLOADPREP() function. */
481	typedef FNSSMDEVLOADPREP *PFNSSMDEVLOADPREP;
482
483	/**
484	* Execute state load operation.
485	*
486	* @returns VBox status code.
487	* @param pDevIns Device instance of the device which registered the data unit.
488	* @param pSSM SSM operation handle.
489	* @param uVersion Data layout version.
490	* @param uPass The pass. This is always SSM_PASS_FINAL for units
491	* that doesn't specify a pfnSaveLive callback.
492	*/
493	typedef DECLCALLBACK(int) FNSSMDEVLOADEXEC(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass);
494	/** Pointer to a FNSSMDEVLOADEXEC() function. */
495	typedef FNSSMDEVLOADEXEC *PFNSSMDEVLOADEXEC;
496
497	/**
498	* Done state load operation.
499	*
500	* @returns VBox load code.
501	* @param pDevIns Device instance of the device which registered the data unit.
502	* @param pSSM SSM operation handle.
503	*/
504	typedef DECLCALLBACK(int) FNSSMDEVLOADDONE(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
505	/** Pointer to a FNSSMDEVLOADDONE() function. */
506	typedef FNSSMDEVLOADDONE *PFNSSMDEVLOADDONE;
507
508	/** @} */
509
510
511	/** The PDM Driver callback variants.
512	* @{
513	*/
514
515	/**
516	* Prepare state live save operation.
517	*
518	* @returns VBox status code.
519	* @param pDrvIns Driver instance of the device which registered the
520	* data unit.
521	* @param pSSM SSM operation handle.
522	* @thread Any.
523	*/
524	typedef DECLCALLBACK(int) FNSSMDRVLIVEPREP(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
525	/** Pointer to a FNSSMDRVLIVEPREP() function. */
526	typedef FNSSMDRVLIVEPREP *PFNSSMDRVLIVEPREP;
527
528	/**
529	* Execute state live save operation.
530	*
531	* This will be called repeatedly until all units vote that the live phase has
532	* been concluded.
533	*
534	* @returns VBox status code.
535	* @param pDrvIns Driver instance of the device which registered the
536	* data unit.
537	* @param pSSM SSM operation handle.
538	* @param uPass The data pass.
539	* @thread Any.
540	*/
541	typedef DECLCALLBACK(int) FNSSMDRVLIVEEXEC(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM, uint32_t uPass);
542	/** Pointer to a FNSSMDRVLIVEEXEC() function. */
543	typedef FNSSMDRVLIVEEXEC *PFNSSMDRVLIVEEXEC;
544
545	/**
546	* Vote on whether the live part of the saving has been concluded.
547	*
548	* The vote stops once a unit has vetoed the decision, so don't rely upon this
549	* being called every time.
550	*
551	* @returns VBox status code.
552	* @retval VINF_SUCCESS if done.
553	* @retval VINF_SSM_VOTE_FOR_ANOTHER_PASS if another pass is needed.
554	* @retval VINF_SSM_VOTE_DONE_DONT_CALL_AGAIN if the live saving of the unit is
555	* done and there is not need calling it again before the final pass.
556	* @retval VERR_SSM_VOTE_FOR_GIVING_UP if its time to give up.
557	*
558	* @param pDrvIns Driver instance of the device which registered the
559	* data unit.
560	* @param pSSM SSM operation handle.
561	* @thread Any.
562	*/
563	typedef DECLCALLBACK(int) FNSSMDRVLIVEVOTE(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
564	/** Pointer to a FNSSMDRVLIVEVOTE() function. */
565	typedef FNSSMDRVLIVEVOTE *PFNSSMDRVLIVEVOTE;
566
567
568	/**
569	* Prepare state save operation.
570	*
571	* @returns VBox status code.
572	* @param pDrvIns Driver instance of the driver which registered the data unit.
573	* @param pSSM SSM operation handle.
574	*/
575	typedef DECLCALLBACK(int) FNSSMDRVSAVEPREP(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
576	/** Pointer to a FNSSMDRVSAVEPREP() function. */
577	typedef FNSSMDRVSAVEPREP *PFNSSMDRVSAVEPREP;
578
579	/**
580	* Execute state save operation.
581	*
582	* @returns VBox status code.
583	* @param pDrvIns Driver instance of the driver which registered the data unit.
584	* @param pSSM SSM operation handle.
585	*/
586	typedef DECLCALLBACK(int) FNSSMDRVSAVEEXEC(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
587	/** Pointer to a FNSSMDRVSAVEEXEC() function. */
588	typedef FNSSMDRVSAVEEXEC *PFNSSMDRVSAVEEXEC;
589
590	/**
591	* Done state save operation.
592	*
593	* @returns VBox status code.
594	* @param pDrvIns Driver instance of the driver which registered the data unit.
595	* @param pSSM SSM operation handle.
596	*/
597	typedef DECLCALLBACK(int) FNSSMDRVSAVEDONE(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
598	/** Pointer to a FNSSMDRVSAVEDONE() function. */
599	typedef FNSSMDRVSAVEDONE *PFNSSMDRVSAVEDONE;
600
601	/**
602	* Prepare state load operation.
603	*
604	* @returns VBox status code.
605	* @param pDrvIns Driver instance of the driver which registered the data unit.
606	* @param pSSM SSM operation handle.
607	*/
608	typedef DECLCALLBACK(int) FNSSMDRVLOADPREP(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
609	/** Pointer to a FNSSMDRVLOADPREP() function. */
610	typedef FNSSMDRVLOADPREP *PFNSSMDRVLOADPREP;
611
612	/**
613	* Execute state load operation.
614	*
615	* @returns VBox status code.
616	* @param pDrvIns Driver instance of the driver which registered the data unit.
617	* @param pSSM SSM operation handle.
618	* @param uVersion Data layout version.
619	* @param uPass The pass. This is always SSM_PASS_FINAL for units
620	* that doesn't specify a pfnSaveLive callback.
621	*/
622	typedef DECLCALLBACK(int) FNSSMDRVLOADEXEC(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass);
623	/** Pointer to a FNSSMDRVLOADEXEC() function. */
624	typedef FNSSMDRVLOADEXEC *PFNSSMDRVLOADEXEC;
625
626	/**
627	* Done state load operation.
628	*
629	* @returns VBox load code.
630	* @param pDrvIns Driver instance of the driver which registered the data unit.
631	* @param pSSM SSM operation handle.
632	*/
633	typedef DECLCALLBACK(int) FNSSMDRVLOADDONE(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
634	/** Pointer to a FNSSMDRVLOADDONE() function. */
635	typedef FNSSMDRVLOADDONE *PFNSSMDRVLOADDONE;
636
637	/** @} */
638
639
640	/** The internal callback variants.
641	* @{
642	*/
643
644
645	/**
646	* Prepare state live save operation.
647	*
648	* @returns VBox status code.
649	* @param pVM VM Handle.
650	* @param pSSM SSM operation handle.
651	* @thread Any.
652	*/
653	typedef DECLCALLBACK(int) FNSSMINTLIVEPREP(PVM pVM, PSSMHANDLE pSSM);
654	/** Pointer to a FNSSMINTLIVEPREP() function. */
655	typedef FNSSMINTLIVEPREP *PFNSSMINTLIVEPREP;
656
657	/**
658	* Execute state live save operation.
659	*
660	* This will be called repeatedly until all units vote that the live phase has
661	* been concluded.
662	*
663	* @returns VBox status code.
664	* @param pVM VM Handle.
665	* @param pSSM SSM operation handle.
666	* @param uPass The data pass.
667	* @thread Any.
668	*/
669	typedef DECLCALLBACK(int) FNSSMINTLIVEEXEC(PVM pVM, PSSMHANDLE pSSM, uint32_t uPass);
670	/** Pointer to a FNSSMINTLIVEEXEC() function. */
671	typedef FNSSMINTLIVEEXEC *PFNSSMINTLIVEEXEC;
672
673	/**
674	* Vote on whether the live part of the saving has been concluded.
675	*
676	* The vote stops once a unit has vetoed the decision, so don't rely upon this
677	* being called every time.
678	*
679	* @returns VBox status code.
680	* @retval VINF_SUCCESS if done.
681	* @retval VINF_SSM_VOTE_FOR_ANOTHER_PASS if another pass is needed.
682	* @retval VINF_SSM_VOTE_DONE_DONT_CALL_AGAIN if the live saving of the unit is
683	* done and there is not need calling it again before the final pass.
684	* @retval VERR_SSM_VOTE_FOR_GIVING_UP if its time to give up.
685	*
686	* @param pVM VM Handle.
687	* @param pSSM SSM operation handle.
688	* @thread Any.
689	*/
690	typedef DECLCALLBACK(int) FNSSMINTLIVEVOTE(PVM pVM, PSSMHANDLE pSSM);
691	/** Pointer to a FNSSMINTLIVEVOTE() function. */
692	typedef FNSSMINTLIVEVOTE *PFNSSMINTLIVEVOTE;
693
694	/**
695	* Prepare state save operation.
696	*
697	* @returns VBox status code.
698	* @param pVM VM Handle.
699	* @param pSSM SSM operation handle.
700	*/
701	typedef DECLCALLBACK(int) FNSSMINTSAVEPREP(PVM pVM, PSSMHANDLE pSSM);
702	/** Pointer to a FNSSMINTSAVEPREP() function. */
703	typedef FNSSMINTSAVEPREP *PFNSSMINTSAVEPREP;
704
705	/**
706	* Execute state save operation.
707	*
708	* @returns VBox status code.
709	* @param pVM VM Handle.
710	* @param pSSM SSM operation handle.
711	*/
712	typedef DECLCALLBACK(int) FNSSMINTSAVEEXEC(PVM pVM, PSSMHANDLE pSSM);
713	/** Pointer to a FNSSMINTSAVEEXEC() function. */
714	typedef FNSSMINTSAVEEXEC *PFNSSMINTSAVEEXEC;
715
716	/**
717	* Done state save operation.
718	*
719	* @returns VBox status code.
720	* @param pVM VM Handle.
721	* @param pSSM SSM operation handle.
722	*/
723	typedef DECLCALLBACK(int) FNSSMINTSAVEDONE(PVM pVM, PSSMHANDLE pSSM);
724	/** Pointer to a FNSSMINTSAVEDONE() function. */
725	typedef FNSSMINTSAVEDONE *PFNSSMINTSAVEDONE;
726
727	/**
728	* Prepare state load operation.
729	*
730	* @returns VBox status code.
731	* @param pVM VM Handle.
732	* @param pSSM SSM operation handle.
733	*/
734	typedef DECLCALLBACK(int) FNSSMINTLOADPREP(PVM pVM, PSSMHANDLE pSSM);
735	/** Pointer to a FNSSMINTLOADPREP() function. */
736	typedef FNSSMINTLOADPREP *PFNSSMINTLOADPREP;
737
738	/**
739	* Execute state load operation.
740	*
741	* @returns VBox status code.
742	* @param pVM VM Handle.
743	* @param pSSM SSM operation handle.
744	* @param uVersion Data layout version.
745	* @param uPass The pass. This is always SSM_PASS_FINAL for units
746	* that doesn't specify a pfnSaveLive callback.
747	*/
748	typedef DECLCALLBACK(int) FNSSMINTLOADEXEC(PVM pVM, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass);
749	/** Pointer to a FNSSMINTLOADEXEC() function. */
750	typedef FNSSMINTLOADEXEC *PFNSSMINTLOADEXEC;
751
752	/**
753	* Done state load operation.
754	*
755	* @returns VBox load code.
756	* @param pVM VM Handle.
757	* @param pSSM SSM operation handle.
758	*/
759	typedef DECLCALLBACK(int) FNSSMINTLOADDONE(PVM pVM, PSSMHANDLE pSSM);
760	/** Pointer to a FNSSMINTLOADDONE() function. */
761	typedef FNSSMINTLOADDONE *PFNSSMINTLOADDONE;
762
763	/** @} */
764
765
766	/** The External callback variants.
767	* @{
768	*/
769
770	/**
771	* Prepare state live save operation.
772	*
773	* @returns VBox status code.
774	* @param pSSM SSM operation handle.
775	* @param pvUser User argument.
776	* @thread Any.
777	*/
778	typedef DECLCALLBACK(int) FNSSMEXTLIVEPREP(PSSMHANDLE pSSM, void *pvUser);
779	/** Pointer to a FNSSMEXTLIVEPREP() function. */
780	typedef FNSSMEXTLIVEPREP *PFNSSMEXTLIVEPREP;
781
782	/**
783	* Execute state live save operation.
784	*
785	* This will be called repeatedly until all units vote that the live phase has
786	* been concluded.
787	*
788	* @returns VBox status code.
789	* @param pSSM SSM operation handle.
790	* @param pvUser User argument.
791	* @param uPass The data pass.
792	* @thread Any.
793	*/
794	typedef DECLCALLBACK(int) FNSSMEXTLIVEEXEC(PSSMHANDLE pSSM, void *pvUser, uint32_t uPass);
795	/** Pointer to a FNSSMEXTLIVEEXEC() function. */
796	typedef FNSSMEXTLIVEEXEC *PFNSSMEXTLIVEEXEC;
797
798	/**
799	* Vote on whether the live part of the saving has been concluded.
800	*
801	* The vote stops once a unit has vetoed the decision, so don't rely upon this
802	* being called every time.
803	*
804	* @returns VBox status code.
805	* @retval VINF_SUCCESS if done.
806	* @retval VINF_SSM_VOTE_FOR_ANOTHER_PASS if another pass is needed.
807	* @retval VINF_SSM_VOTE_DONE_DONT_CALL_AGAIN if the live saving of the unit is
808	* done and there is not need calling it again before the final pass.
809	* @retval VERR_SSM_VOTE_FOR_GIVING_UP if its time to give up.
810	*
811	* @param pSSM SSM operation handle.
812	* @param pvUser User argument.
813	* @thread Any.
814	*/
815	typedef DECLCALLBACK(int) FNSSMEXTLIVEVOTE(PSSMHANDLE pSSM, void *pvUser);
816	/** Pointer to a FNSSMEXTLIVEVOTE() function. */
817	typedef FNSSMEXTLIVEVOTE *PFNSSMEXTLIVEVOTE;
818
819	/**
820	* Prepare state save operation.
821	*
822	* @returns VBox status code.
823	* @param pSSM SSM operation handle.
824	* @param pvUser User argument.
825	*/
826	typedef DECLCALLBACK(int) FNSSMEXTSAVEPREP(PSSMHANDLE pSSM, void *pvUser);
827	/** Pointer to a FNSSMEXTSAVEPREP() function. */
828	typedef FNSSMEXTSAVEPREP *PFNSSMEXTSAVEPREP;
829
830	/**
831	* Execute state save operation.
832	*
833	* @param pSSM SSM operation handle.
834	* @param pvUser User argument.
835	* @author The lack of return code is for legacy reasons.
836	*/
837	typedef DECLCALLBACK(void) FNSSMEXTSAVEEXEC(PSSMHANDLE pSSM, void *pvUser);
838	/** Pointer to a FNSSMEXTSAVEEXEC() function. */
839	typedef FNSSMEXTSAVEEXEC *PFNSSMEXTSAVEEXEC;
840
841	/**
842	* Done state save operation.
843	*
844	* @returns VBox status code.
845	* @param pSSM SSM operation handle.
846	* @param pvUser User argument.
847	*/
848	typedef DECLCALLBACK(int) FNSSMEXTSAVEDONE(PSSMHANDLE pSSM, void *pvUser);
849	/** Pointer to a FNSSMEXTSAVEDONE() function. */
850	typedef FNSSMEXTSAVEDONE *PFNSSMEXTSAVEDONE;
851
852	/**
853	* Prepare state load operation.
854	*
855	* @returns VBox status code.
856	* @param pSSM SSM operation handle.
857	* @param pvUser User argument.
858	*/
859	typedef DECLCALLBACK(int) FNSSMEXTLOADPREP(PSSMHANDLE pSSM, void *pvUser);
860	/** Pointer to a FNSSMEXTLOADPREP() function. */
861	typedef FNSSMEXTLOADPREP *PFNSSMEXTLOADPREP;
862
863	/**
864	* Execute state load operation.
865	*
866	* @returns VBox status code.
867	* @param pSSM SSM operation handle.
868	* @param pvUser User argument.
869	* @param uVersion Data layout version.
870	* @param uPass The pass. This is always SSM_PASS_FINAL for units
871	* that doesn't specify a pfnSaveLive callback.
872	* @remark The odd return value is for legacy reasons.
873	*/
874	typedef DECLCALLBACK(int) FNSSMEXTLOADEXEC(PSSMHANDLE pSSM, void *pvUser, uint32_t uVersion, uint32_t uPass);
875	/** Pointer to a FNSSMEXTLOADEXEC() function. */
876	typedef FNSSMEXTLOADEXEC *PFNSSMEXTLOADEXEC;
877
878	/**
879	* Done state load operation.
880	*
881	* @returns VBox load code.
882	* @param pSSM SSM operation handle.
883	* @param pvUser User argument.
884	*/
885	typedef DECLCALLBACK(int) FNSSMEXTLOADDONE(PSSMHANDLE pSSM, void *pvUser);
886	/** Pointer to a FNSSMEXTLOADDONE() function. */
887	typedef FNSSMEXTLOADDONE *PFNSSMEXTLOADDONE;
888
889	/** @} */
890
891
892	/**
893	* SSM stream method table.
894	*
895	* This is used by external parties for teleporting over TCP or any other media.
896	* SSM also uses this internally for file access, thus the 2-3 file centric
897	* methods.
898	*/
899	typedef struct SSMSTRMOPS
900	{
901	/** Struct magic + version (SSMSTRMOPS_VERSION). */
902	uint32_t u32Version;
903
904	/**
905	* Write bytes to the stream.
906	*
907	* @returns VBox status code.
908	* @param pvUser The user argument.
909	* @param offStream The stream offset we're (supposed to be) at.
910	* @param pvBuf Pointer to the data.
911	* @param cbToWrite The number of bytes to write.
912	*/
913	DECLCALLBACKMEMBER(int, pfnWrite)(void pvUser, uint64_t offStream, const void pvBuf, size_t cbToWrite);
914
915	/**
916	* Read bytes to the stream.
917	*
918	* @returns VBox status code.
919	* @param pvUser The user argument.
920	* @param offStream The stream offset we're (supposed to be) at.
921	* @param pvBuf Where to return the bytes.
922	* @param cbToRead The number of bytes to read.
923	* @param pcbRead Where to return the number of bytes actually
924	* read. This may differ from cbToRead when the
925	* end of the stream is encountered.
926	*/
927	DECLCALLBACKMEMBER(int, pfnRead)(void pvUser, uint64_t offStream, void pvBuf, size_t cbToRead, size_t *pcbRead);
928
929	/**
930	* Seeks in the stream.
931	*
932	* @returns VBox status code.
933	* @retval VERR_NOT_SUPPORTED if the stream doesn't support this action.
934	*
935	* @param pvUser The user argument.
936	* @param offSeek The seek offset.
937	* @param uMethod RTFILE_SEEK_BEGIN, RTFILE_SEEK_END or
938	* RTFILE_SEEK_CURRENT.
939	* @param poffActual Where to store the new file position. Optional.
940	*/
941	DECLCALLBACKMEMBER(int, pfnSeek)(void pvUser, int64_t offSeek, unsigned uMethod, uint64_t poffActual);
942
943	/**
944	* Get the current stream position.
945	*
946	* @returns The correct stream position.
947	* @param pvUser The user argument.
948	*/
949	DECLCALLBACKMEMBER(uint64_t, pfnTell)(void *pvUser);
950
951	/**
952	* Get the size/length of the stream.
953	*
954	* @returns VBox status code.
955	* @retval VERR_NOT_SUPPORTED if the stream doesn't support this action.
956	*
957	* @param pvUser The user argument.
958	* @param pcb Where to return the size/length.
959	*/
960	DECLCALLBACKMEMBER(int, pfnSize)(void pvUser, uint64_t pcb);
961
962	/**
963	* Close the stream.
964	*
965	* @returns VBox status code.
966	* @param pvUser The user argument.
967	*/
968	DECLCALLBACKMEMBER(int, pfnClose)(void *pvUser);
969
970	/** Struct magic + version (SSMSTRMOPS_VERSION). */
971	uint32_t u32EndVersion;
972	} SSMSTRMOPS;
973	/** Struct magic + version (SSMSTRMOPS_VERSION). */
974	#define SSMSTRMOPS_VERSION UINT32_C(0x55aa0001)
975
976
977	VMMR3_INT_DECL(void) SSMR3Term(PVM pVM);
978	VMMR3DECL(int) SSMR3RegisterDevice(PVM pVM, PPDMDEVINS pDevIns, const char pszName, uint32_t uInstance, uint32_t uVersion, size_t cbGuess, const char pszBefore,
979	PFNSSMDEVLIVEPREP pfnLivePrep, PFNSSMDEVLIVEEXEC pfnLiveExec, PFNSSMDEVLIVEVOTE pfnLiveVote,
980	PFNSSMDEVSAVEPREP pfnSavePrep, PFNSSMDEVSAVEEXEC pfnSaveExec, PFNSSMDEVSAVEDONE pfnSaveDone,
981	PFNSSMDEVLOADPREP pfnLoadPrep, PFNSSMDEVLOADEXEC pfnLoadExec, PFNSSMDEVLOADDONE pfnLoadDone);
982	VMMR3DECL(int) SSMR3RegisterDriver(PVM pVM, PPDMDRVINS pDrvIns, const char *pszName, uint32_t uInstance, uint32_t uVersion, size_t cbGuess,
983	PFNSSMDRVLIVEPREP pfnLivePrep, PFNSSMDRVLIVEEXEC pfnLiveExec, PFNSSMDRVLIVEVOTE pfnLiveVote,
984	PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
985	PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone);
986	VMMR3DECL(int) SSMR3RegisterInternal(PVM pVM, const char *pszName, uint32_t uInstance, uint32_t uVersion, size_t cbGuess,
987	PFNSSMINTLIVEPREP pfnLivePrep, PFNSSMINTLIVEEXEC pfnLiveExec, PFNSSMINTLIVEVOTE pfnLiveVote,
988	PFNSSMINTSAVEPREP pfnSavePrep, PFNSSMINTSAVEEXEC pfnSaveExec, PFNSSMINTSAVEDONE pfnSaveDone,
989	PFNSSMINTLOADPREP pfnLoadPrep, PFNSSMINTLOADEXEC pfnLoadExec, PFNSSMINTLOADDONE pfnLoadDone);
990	VMMR3DECL(int) SSMR3RegisterExternal(PVM pVM, const char *pszName, uint32_t uInstance, uint32_t uVersion, size_t cbGuess,
991	PFNSSMEXTLIVEPREP pfnLivePrep, PFNSSMEXTLIVEEXEC pfnLiveExec, PFNSSMEXTLIVEVOTE pfnLiveVote,
992	PFNSSMEXTSAVEPREP pfnSavePrep, PFNSSMEXTSAVEEXEC pfnSaveExec, PFNSSMEXTSAVEDONE pfnSaveDone,
993	PFNSSMEXTLOADPREP pfnLoadPrep, PFNSSMEXTLOADEXEC pfnLoadExec, PFNSSMEXTLOADDONE pfnLoadDone, void *pvUser);
994	VMMR3_INT_DECL(int) SSMR3DeregisterDevice(PVM pVM, PPDMDEVINS pDevIns, const char *pszName, uint32_t uInstance);
995	VMMR3_INT_DECL(int) SSMR3DeregisterDriver(PVM pVM, PPDMDRVINS pDrvIns, const char *pszName, uint32_t uInstance);
996	VMMR3DECL(int) SSMR3DeregisterInternal(PVM pVM, const char *pszName);
997	VMMR3DECL(int) SSMR3DeregisterExternal(PVM pVM, const char *pszName);
998	VMMR3DECL(int) SSMR3Save(PVM pVM, const char pszFilename, SSMAFTER enmAfter, PFNVMPROGRESS pfnProgress, void pvUser);
999	VMMR3_INT_DECL(int) SSMR3LiveSave(PVM pVM, const char pszFilename, PCSSMSTRMOPS pStreamOps, void pvStreamOps,
1000	SSMAFTER enmAfter, PFNVMPROGRESS pfnProgress, void pvProgressUser, PSSMHANDLE ppSSM);
1001	VMMR3_INT_DECL(int) SSMR3LiveDoStep1(PSSMHANDLE pSSM);
1002	VMMR3_INT_DECL(int) SSMR3LiveDoStep2(PSSMHANDLE pSSM);
1003	VMMR3_INT_DECL(int) SSMR3LiveDone(PSSMHANDLE pSSM);
1004	VMMR3DECL(int) SSMR3Load(PVM pVM, const char pszFilename, PCSSMSTRMOPS pStreamOps, void pvStreamOpsUser,
1005	SSMAFTER enmAfter, PFNVMPROGRESS pfnProgress, void *pvProgressUser);
1006	VMMR3DECL(int) SSMR3ValidateFile(const char *pszFilename, bool fChecksumIt);
1007	VMMR3DECL(int) SSMR3Open(const char pszFilename, unsigned fFlags, PSSMHANDLE ppSSM);
1008	VMMR3DECL(int) SSMR3Close(PSSMHANDLE pSSM);
1009	VMMR3DECL(int) SSMR3Seek(PSSMHANDLE pSSM, const char pszUnit, uint32_t iInstance, uint32_t piVersion);
1010	VMMR3DECL(int) SSMR3HandleGetStatus(PSSMHANDLE pSSM);
1011	VMMR3DECL(int) SSMR3HandleSetStatus(PSSMHANDLE pSSM, int iStatus);
1012	VMMR3DECL(SSMAFTER) SSMR3HandleGetAfter(PSSMHANDLE pSSM);
1013	VMMR3DECL(bool) SSMR3HandleIsLiveSave(PSSMHANDLE pSSM);
1014	VMMR3DECL(uint32_t) SSMR3HandleHostBits(PSSMHANDLE pSSM);
1015	VMMR3_INT_DECL(int) SSMR3SetGCPtrSize(PSSMHANDLE pSSM, unsigned cbGCPtr);
1016	VMMR3DECL(int) SSMR3Cancel(PVM pVM);
1017
1018
1019	/** Save operations.
1020	* @{
1021	*/
1022	VMMR3DECL(int) SSMR3PutStruct(PSSMHANDLE pSSM, const void *pvStruct, PCSSMFIELD paFields);
1023	VMMR3DECL(int) SSMR3PutStructEx(PSSMHANDLE pSSM, const void pvStruct, size_t cbStruct, uint32_t fFlags, PCSSMFIELD paFields, void pvUser);
1024	VMMR3DECL(int) SSMR3PutBool(PSSMHANDLE pSSM, bool fBool);
1025	VMMR3DECL(int) SSMR3PutU8(PSSMHANDLE pSSM, uint8_t u8);
1026	VMMR3DECL(int) SSMR3PutS8(PSSMHANDLE pSSM, int8_t i8);
1027	VMMR3DECL(int) SSMR3PutU16(PSSMHANDLE pSSM, uint16_t u16);
1028	VMMR3DECL(int) SSMR3PutS16(PSSMHANDLE pSSM, int16_t i16);
1029	VMMR3DECL(int) SSMR3PutU32(PSSMHANDLE pSSM, uint32_t u32);
1030	VMMR3DECL(int) SSMR3PutS32(PSSMHANDLE pSSM, int32_t i32);
1031	VMMR3DECL(int) SSMR3PutU64(PSSMHANDLE pSSM, uint64_t u64);
1032	VMMR3DECL(int) SSMR3PutS64(PSSMHANDLE pSSM, int64_t i64);
1033	VMMR3DECL(int) SSMR3PutU128(PSSMHANDLE pSSM, uint128_t u128);
1034	VMMR3DECL(int) SSMR3PutS128(PSSMHANDLE pSSM, int128_t i128);
1035	VMMR3DECL(int) SSMR3PutUInt(PSSMHANDLE pSSM, RTUINT u);
1036	VMMR3DECL(int) SSMR3PutSInt(PSSMHANDLE pSSM, RTINT i);
1037	VMMR3DECL(int) SSMR3PutGCUInt(PSSMHANDLE pSSM, RTGCUINT u);
1038	VMMR3DECL(int) SSMR3PutGCUIntReg(PSSMHANDLE pSSM, RTGCUINTREG u);
1039	VMMR3DECL(int) SSMR3PutGCPhys32(PSSMHANDLE pSSM, RTGCPHYS32 GCPhys);
1040	VMMR3DECL(int) SSMR3PutGCPhys64(PSSMHANDLE pSSM, RTGCPHYS64 GCPhys);
1041	VMMR3DECL(int) SSMR3PutGCPhys(PSSMHANDLE pSSM, RTGCPHYS GCPhys);
1042	VMMR3DECL(int) SSMR3PutGCPtr(PSSMHANDLE pSSM, RTGCPTR GCPtr);
1043	VMMR3DECL(int) SSMR3PutGCUIntPtr(PSSMHANDLE pSSM, RTGCUINTPTR GCPtr);
1044	VMMR3DECL(int) SSMR3PutRCPtr(PSSMHANDLE pSSM, RTRCPTR RCPtr);
1045	VMMR3DECL(int) SSMR3PutIOPort(PSSMHANDLE pSSM, RTIOPORT IOPort);
1046	VMMR3DECL(int) SSMR3PutSel(PSSMHANDLE pSSM, RTSEL Sel);
1047	VMMR3DECL(int) SSMR3PutMem(PSSMHANDLE pSSM, const void *pv, size_t cb);
1048	VMMR3DECL(int) SSMR3PutStrZ(PSSMHANDLE pSSM, const char *psz);
1049	/** @} */
1050
1051
1052
1053	/** Load operations.
1054	* @{
1055	*/
1056	VMMR3DECL(int) SSMR3GetStruct(PSSMHANDLE pSSM, void *pvStruct, PCSSMFIELD paFields);
1057	VMMR3DECL(int) SSMR3GetStructEx(PSSMHANDLE pSSM, void pvStruct, size_t cbStruct, uint32_t fFlags, PCSSMFIELD paFields, void pvUser);
1058	VMMR3DECL(int) SSMR3GetBool(PSSMHANDLE pSSM, bool *pfBool);
1059	VMMR3DECL(int) SSMR3GetU8(PSSMHANDLE pSSM, uint8_t *pu8);
1060	VMMR3DECL(int) SSMR3GetS8(PSSMHANDLE pSSM, int8_t *pi8);
1061	VMMR3DECL(int) SSMR3GetU16(PSSMHANDLE pSSM, uint16_t *pu16);
1062	VMMR3DECL(int) SSMR3GetS16(PSSMHANDLE pSSM, int16_t *pi16);
1063	VMMR3DECL(int) SSMR3GetU32(PSSMHANDLE pSSM, uint32_t *pu32);
1064	VMMR3DECL(int) SSMR3GetS32(PSSMHANDLE pSSM, int32_t *pi32);
1065	VMMR3DECL(int) SSMR3GetU64(PSSMHANDLE pSSM, uint64_t *pu64);
1066	VMMR3DECL(int) SSMR3GetS64(PSSMHANDLE pSSM, int64_t *pi64);
1067	VMMR3DECL(int) SSMR3GetU128(PSSMHANDLE pSSM, uint128_t *pu128);
1068	VMMR3DECL(int) SSMR3GetS128(PSSMHANDLE pSSM, int128_t *pi128);
1069	VMMR3DECL(int) SSMR3GetUInt(PSSMHANDLE pSSM, PRTUINT pu);
1070	VMMR3DECL(int) SSMR3GetSInt(PSSMHANDLE pSSM, PRTINT pi);
1071	VMMR3DECL(int) SSMR3GetGCUInt(PSSMHANDLE pSSM, PRTGCUINT pu);
1072	VMMR3DECL(int) SSMR3GetGCUIntReg(PSSMHANDLE pSSM, PRTGCUINTREG pu);
1073	VMMR3DECL(int) SSMR3GetGCPhys32(PSSMHANDLE pSSM, PRTGCPHYS32 pGCPhys);
1074	VMMR3DECL(int) SSMR3GetGCPhys64(PSSMHANDLE pSSM, PRTGCPHYS64 pGCPhys);
1075	VMMR3DECL(int) SSMR3GetGCPhys(PSSMHANDLE pSSM, PRTGCPHYS pGCPhys);
1076	VMMR3DECL(int) SSMR3GetGCPtr(PSSMHANDLE pSSM, PRTGCPTR pGCPtr);
1077	VMMR3DECL(int) SSMR3GetGCUIntPtr(PSSMHANDLE pSSM, PRTGCUINTPTR pGCPtr);
1078	VMMR3DECL(int) SSMR3GetRCPtr(PSSMHANDLE pSSM, PRTRCPTR pRCPtr);
1079	VMMR3DECL(int) SSMR3GetIOPort(PSSMHANDLE pSSM, PRTIOPORT pIOPort);
1080	VMMR3DECL(int) SSMR3GetSel(PSSMHANDLE pSSM, PRTSEL pSel);
1081	VMMR3DECL(int) SSMR3GetMem(PSSMHANDLE pSSM, void *pv, size_t cb);
1082	VMMR3DECL(int) SSMR3GetStrZ(PSSMHANDLE pSSM, char *psz, size_t cbMax);
1083	VMMR3DECL(int) SSMR3GetStrZEx(PSSMHANDLE pSSM, char psz, size_t cbMax, size_t pcbStr);
1084	VMMR3DECL(int) SSMR3GetTimer(PSSMHANDLE pSSM, PTMTIMER pTimer);
1085	VMMR3DECL(int) SSMR3Skip(PSSMHANDLE pSSM, size_t cb);
1086	VMMR3DECL(int) SSMR3SkipToEndOfUnit(PSSMHANDLE pSSM);
1087	VMMR3DECL(int) SSMR3SetLoadError(PSSMHANDLE pSSM, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...);
1088	VMMR3DECL(int) SSMR3SetLoadErrorV(PSSMHANDLE pSSM, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va);
1089	VMMR3DECL(int) SSMR3SetCfgError(PSSMHANDLE pSSM, RT_SRC_POS_DECL, const char *pszFormat, ...);
1090
1091	/** @} */
1092
1093	/** @} */
1094	#endif /* IN_RING3 */
1095
1096
1097	/** @} */
1098
1099	RT_C_DECLS_END
1100
1101	#endif
1102

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

source: vbox/trunk/include/VBox/ssm.h@ 24646

Download in other formats: