ssm.h@ 27095

Last change on this file since 27095 was 26112, checked in by vboxsync, 15 years ago
PDM,UsbMsd,++: Resumed hacking the MSD code.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 51.3 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	* @param uPass The data pass.
434	* @thread Any.
435	*/
436	typedef DECLCALLBACK(int) FNSSMDEVLIVEVOTE(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uPass);
437	/** Pointer to a FNSSMDEVLIVEVOTE() function. */
438	typedef FNSSMDEVLIVEVOTE *PFNSSMDEVLIVEVOTE;
439
440	/**
441	* Prepare state save operation.
442	*
443	* @returns VBox status code.
444	* @param pDevIns Device instance of the device which registered the data unit.
445	* @param pSSM SSM operation handle.
446	*/
447	typedef DECLCALLBACK(int) FNSSMDEVSAVEPREP(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
448	/** Pointer to a FNSSMDEVSAVEPREP() function. */
449	typedef FNSSMDEVSAVEPREP *PFNSSMDEVSAVEPREP;
450
451	/**
452	* Execute state save operation.
453	*
454	* @returns VBox status code.
455	* @param pDevIns Device instance of the device which registered the data unit.
456	* @param pSSM SSM operation handle.
457	*/
458	typedef DECLCALLBACK(int) FNSSMDEVSAVEEXEC(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
459	/** Pointer to a FNSSMDEVSAVEEXEC() function. */
460	typedef FNSSMDEVSAVEEXEC *PFNSSMDEVSAVEEXEC;
461
462	/**
463	* Done state save operation.
464	*
465	* @returns VBox status code.
466	* @param pDevIns Device instance of the device which registered the data unit.
467	* @param pSSM SSM operation handle.
468	*/
469	typedef DECLCALLBACK(int) FNSSMDEVSAVEDONE(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
470	/** Pointer to a FNSSMDEVSAVEDONE() function. */
471	typedef FNSSMDEVSAVEDONE *PFNSSMDEVSAVEDONE;
472
473	/**
474	* Prepare state load operation.
475	*
476	* @returns VBox status code.
477	* @param pDevIns Device instance of the device which registered the data unit.
478	* @param pSSM SSM operation handle.
479	*/
480	typedef DECLCALLBACK(int) FNSSMDEVLOADPREP(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
481	/** Pointer to a FNSSMDEVLOADPREP() function. */
482	typedef FNSSMDEVLOADPREP *PFNSSMDEVLOADPREP;
483
484	/**
485	* Execute state load operation.
486	*
487	* @returns VBox status code.
488	* @param pDevIns Device instance of the device which registered the data unit.
489	* @param pSSM SSM operation handle.
490	* @param uVersion Data layout version.
491	* @param uPass The pass. This is always SSM_PASS_FINAL for units
492	* that doesn't specify a pfnSaveLive callback.
493	*/
494	typedef DECLCALLBACK(int) FNSSMDEVLOADEXEC(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass);
495	/** Pointer to a FNSSMDEVLOADEXEC() function. */
496	typedef FNSSMDEVLOADEXEC *PFNSSMDEVLOADEXEC;
497
498	/**
499	* Done state load operation.
500	*
501	* @returns VBox load code.
502	* @param pDevIns Device instance of the device which registered the data unit.
503	* @param pSSM SSM operation handle.
504	*/
505	typedef DECLCALLBACK(int) FNSSMDEVLOADDONE(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
506	/** Pointer to a FNSSMDEVLOADDONE() function. */
507	typedef FNSSMDEVLOADDONE *PFNSSMDEVLOADDONE;
508
509	/** @} */
510
511
512	/** The PDM USB device callback variants.
513	* @{
514	*/
515
516	/**
517	* Prepare state live save operation.
518	*
519	* @returns VBox status code.
520	* @param pUsbIns The USB device instance of the USB device which
521	* registered the data unit.
522	* @param pSSM SSM operation handle.
523	* @thread Any.
524	*/
525	typedef DECLCALLBACK(int) FNSSMUSBLIVEPREP(PPDMUSBINS pUsbIns, PSSMHANDLE pSSM);
526	/** Pointer to a FNSSMUSBLIVEPREP() function. */
527	typedef FNSSMUSBLIVEPREP *PFNSSMUSBLIVEPREP;
528
529	/**
530	* Execute state live save operation.
531	*
532	* This will be called repeatedly until all units vote that the live phase has
533	* been concluded.
534	*
535	* @returns VBox status code.
536	* @param pUsbIns The USB device instance of the USB device which
537	* registered the data unit.
538	* @param pSSM SSM operation handle.
539	* @param uPass The pass.
540	* @thread Any.
541	*/
542	typedef DECLCALLBACK(int) FNSSMUSBLIVEEXEC(PPDMUSBINS pUsbIns, PSSMHANDLE pSSM, uint32_t uPass);
543	/** Pointer to a FNSSMUSBLIVEEXEC() function. */
544	typedef FNSSMUSBLIVEEXEC *PFNSSMUSBLIVEEXEC;
545
546	/**
547	* Vote on whether the live part of the saving has been concluded.
548	*
549	* The vote stops once a unit has vetoed the decision, so don't rely upon this
550	* being called every time.
551	*
552	* @returns VBox status code.
553	* @retval VINF_SUCCESS if done.
554	* @retval VINF_SSM_VOTE_FOR_ANOTHER_PASS if another pass is needed.
555	* @retval VINF_SSM_VOTE_DONE_DONT_CALL_AGAIN if the live saving of the unit is
556	* done and there is not need calling it again before the final pass.
557	* @retval VERR_SSM_VOTE_FOR_GIVING_UP if its time to give up.
558	*
559	* @param pUsbIns The USB device instance of the USB device which
560	* registered the data unit.
561	* @param pSSM SSM operation handle.
562	* @param uPass The data pass.
563	* @thread Any.
564	*/
565	typedef DECLCALLBACK(int) FNSSMUSBLIVEVOTE(PPDMUSBINS pUsbIns, PSSMHANDLE pSSM, uint32_t uPass);
566	/** Pointer to a FNSSMUSBLIVEVOTE() function. */
567	typedef FNSSMUSBLIVEVOTE *PFNSSMUSBLIVEVOTE;
568
569	/**
570	* Prepare state save operation.
571	*
572	* @returns VBox status code.
573	* @param pUsbIns The USB device instance of the USB device which
574	* registered the data unit.
575	* @param pSSM SSM operation handle.
576	*/
577	typedef DECLCALLBACK(int) FNSSMUSBSAVEPREP(PPDMUSBINS pUsbIns, PSSMHANDLE pSSM);
578	/** Pointer to a FNSSMUSBSAVEPREP() function. */
579	typedef FNSSMUSBSAVEPREP *PFNSSMUSBSAVEPREP;
580
581	/**
582	* Execute state save operation.
583	*
584	* @returns VBox status code.
585	* @param pUsbIns The USB device instance of the USB device which
586	* registered the data unit.
587	* @param pSSM SSM operation handle.
588	*/
589	typedef DECLCALLBACK(int) FNSSMUSBSAVEEXEC(PPDMUSBINS pUsbIns, PSSMHANDLE pSSM);
590	/** Pointer to a FNSSMUSBSAVEEXEC() function. */
591	typedef FNSSMUSBSAVEEXEC *PFNSSMUSBSAVEEXEC;
592
593	/**
594	* Done state save operation.
595	*
596	* @returns VBox status code.
597	* @param pUsbIns The USB device instance of the USB device which
598	* registered the data unit.
599	* @param pSSM SSM operation handle.
600	*/
601	typedef DECLCALLBACK(int) FNSSMUSBSAVEDONE(PPDMUSBINS pUsbIns, PSSMHANDLE pSSM);
602	/** Pointer to a FNSSMUSBSAVEDONE() function. */
603	typedef FNSSMUSBSAVEDONE *PFNSSMUSBSAVEDONE;
604
605	/**
606	* Prepare state load operation.
607	*
608	* @returns VBox status code.
609	* @param pUsbIns The USB device instance of the USB device which
610	* registered the data unit.
611	* @param pSSM SSM operation handle.
612	*/
613	typedef DECLCALLBACK(int) FNSSMUSBLOADPREP(PPDMUSBINS pUsbIns, PSSMHANDLE pSSM);
614	/** Pointer to a FNSSMUSBLOADPREP() function. */
615	typedef FNSSMUSBLOADPREP *PFNSSMUSBLOADPREP;
616
617	/**
618	* Execute state load operation.
619	*
620	* @returns VBox status code.
621	* @param pUsbIns The USB device instance of the USB device which
622	* registered the data unit.
623	* @param pSSM SSM operation handle.
624	* @param uVersion Data layout version.
625	* @param uPass The pass. This is always SSM_PASS_FINAL for units
626	* that doesn't specify a pfnSaveLive callback.
627	*/
628	typedef DECLCALLBACK(int) FNSSMUSBLOADEXEC(PPDMUSBINS pUsbIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass);
629	/** Pointer to a FNSSMUSBLOADEXEC() function. */
630	typedef FNSSMUSBLOADEXEC *PFNSSMUSBLOADEXEC;
631
632	/**
633	* Done state load operation.
634	*
635	* @returns VBox load code.
636	* @param pUsbIns The USB device instance of the USB device which
637	* registered the data unit.
638	* @param pSSM SSM operation handle.
639	*/
640	typedef DECLCALLBACK(int) FNSSMUSBLOADDONE(PPDMUSBINS pUsbIns, PSSMHANDLE pSSM);
641	/** Pointer to a FNSSMUSBLOADDONE() function. */
642	typedef FNSSMUSBLOADDONE *PFNSSMUSBLOADDONE;
643
644	/** @} */
645
646
647	/** The PDM Driver callback variants.
648	* @{
649	*/
650
651	/**
652	* Prepare state live save operation.
653	*
654	* @returns VBox status code.
655	* @param pDrvIns Driver instance of the driver which registered the
656	* data unit.
657	* @param pSSM SSM operation handle.
658	* @thread Any.
659	*/
660	typedef DECLCALLBACK(int) FNSSMDRVLIVEPREP(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
661	/** Pointer to a FNSSMDRVLIVEPREP() function. */
662	typedef FNSSMDRVLIVEPREP *PFNSSMDRVLIVEPREP;
663
664	/**
665	* Execute state live save operation.
666	*
667	* This will be called repeatedly until all units vote that the live phase has
668	* been concluded.
669	*
670	* @returns VBox status code.
671	* @param pDrvIns Driver instance of the driver which registered the
672	* data unit.
673	* @param pSSM SSM operation handle.
674	* @param uPass The data pass.
675	* @thread Any.
676	*/
677	typedef DECLCALLBACK(int) FNSSMDRVLIVEEXEC(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM, uint32_t uPass);
678	/** Pointer to a FNSSMDRVLIVEEXEC() function. */
679	typedef FNSSMDRVLIVEEXEC *PFNSSMDRVLIVEEXEC;
680
681	/**
682	* Vote on whether the live part of the saving has been concluded.
683	*
684	* The vote stops once a unit has vetoed the decision, so don't rely upon this
685	* being called every time.
686	*
687	* @returns VBox status code.
688	* @retval VINF_SUCCESS if done.
689	* @retval VINF_SSM_VOTE_FOR_ANOTHER_PASS if another pass is needed.
690	* @retval VINF_SSM_VOTE_DONE_DONT_CALL_AGAIN if the live saving of the unit is
691	* done and there is not need calling it again before the final pass.
692	* @retval VERR_SSM_VOTE_FOR_GIVING_UP if its time to give up.
693	*
694	* @param pDrvIns Driver instance of the driver which registered the
695	* data unit.
696	* @param pSSM SSM operation handle.
697	* @param uPass The data pass.
698	* @thread Any.
699	*/
700	typedef DECLCALLBACK(int) FNSSMDRVLIVEVOTE(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM, uint32_t uPass);
701	/** Pointer to a FNSSMDRVLIVEVOTE() function. */
702	typedef FNSSMDRVLIVEVOTE *PFNSSMDRVLIVEVOTE;
703
704
705	/**
706	* Prepare state save operation.
707	*
708	* @returns VBox status code.
709	* @param pDrvIns Driver instance of the driver which registered the data unit.
710	* @param pSSM SSM operation handle.
711	*/
712	typedef DECLCALLBACK(int) FNSSMDRVSAVEPREP(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
713	/** Pointer to a FNSSMDRVSAVEPREP() function. */
714	typedef FNSSMDRVSAVEPREP *PFNSSMDRVSAVEPREP;
715
716	/**
717	* Execute state save operation.
718	*
719	* @returns VBox status code.
720	* @param pDrvIns Driver instance of the driver which registered the data unit.
721	* @param pSSM SSM operation handle.
722	*/
723	typedef DECLCALLBACK(int) FNSSMDRVSAVEEXEC(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
724	/** Pointer to a FNSSMDRVSAVEEXEC() function. */
725	typedef FNSSMDRVSAVEEXEC *PFNSSMDRVSAVEEXEC;
726
727	/**
728	* Done state save operation.
729	*
730	* @returns VBox status code.
731	* @param pDrvIns Driver instance of the driver which registered the data unit.
732	* @param pSSM SSM operation handle.
733	*/
734	typedef DECLCALLBACK(int) FNSSMDRVSAVEDONE(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
735	/** Pointer to a FNSSMDRVSAVEDONE() function. */
736	typedef FNSSMDRVSAVEDONE *PFNSSMDRVSAVEDONE;
737
738	/**
739	* Prepare state load operation.
740	*
741	* @returns VBox status code.
742	* @param pDrvIns Driver instance of the driver which registered the data unit.
743	* @param pSSM SSM operation handle.
744	*/
745	typedef DECLCALLBACK(int) FNSSMDRVLOADPREP(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
746	/** Pointer to a FNSSMDRVLOADPREP() function. */
747	typedef FNSSMDRVLOADPREP *PFNSSMDRVLOADPREP;
748
749	/**
750	* Execute state load operation.
751	*
752	* @returns VBox status code.
753	* @param pDrvIns Driver instance of the driver which registered the data unit.
754	* @param pSSM SSM operation handle.
755	* @param uVersion Data layout version.
756	* @param uPass The pass. This is always SSM_PASS_FINAL for units
757	* that doesn't specify a pfnSaveLive callback.
758	*/
759	typedef DECLCALLBACK(int) FNSSMDRVLOADEXEC(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass);
760	/** Pointer to a FNSSMDRVLOADEXEC() function. */
761	typedef FNSSMDRVLOADEXEC *PFNSSMDRVLOADEXEC;
762
763	/**
764	* Done state load operation.
765	*
766	* @returns VBox load code.
767	* @param pDrvIns Driver instance of the driver which registered the data unit.
768	* @param pSSM SSM operation handle.
769	*/
770	typedef DECLCALLBACK(int) FNSSMDRVLOADDONE(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
771	/** Pointer to a FNSSMDRVLOADDONE() function. */
772	typedef FNSSMDRVLOADDONE *PFNSSMDRVLOADDONE;
773
774	/** @} */
775
776
777	/** The internal callback variants.
778	* @{
779	*/
780
781
782	/**
783	* Prepare state live save operation.
784	*
785	* @returns VBox status code.
786	* @param pVM VM Handle.
787	* @param pSSM SSM operation handle.
788	* @thread Any.
789	*/
790	typedef DECLCALLBACK(int) FNSSMINTLIVEPREP(PVM pVM, PSSMHANDLE pSSM);
791	/** Pointer to a FNSSMINTLIVEPREP() function. */
792	typedef FNSSMINTLIVEPREP *PFNSSMINTLIVEPREP;
793
794	/**
795	* Execute state live save operation.
796	*
797	* This will be called repeatedly until all units vote that the live phase has
798	* been concluded.
799	*
800	* @returns VBox status code.
801	* @param pVM VM Handle.
802	* @param pSSM SSM operation handle.
803	* @param uPass The data pass.
804	* @thread Any.
805	*/
806	typedef DECLCALLBACK(int) FNSSMINTLIVEEXEC(PVM pVM, PSSMHANDLE pSSM, uint32_t uPass);
807	/** Pointer to a FNSSMINTLIVEEXEC() function. */
808	typedef FNSSMINTLIVEEXEC *PFNSSMINTLIVEEXEC;
809
810	/**
811	* Vote on whether the live part of the saving has been concluded.
812	*
813	* The vote stops once a unit has vetoed the decision, so don't rely upon this
814	* being called every time.
815	*
816	* @returns VBox status code.
817	* @retval VINF_SUCCESS if done.
818	* @retval VINF_SSM_VOTE_FOR_ANOTHER_PASS if another pass is needed.
819	* @retval VINF_SSM_VOTE_DONE_DONT_CALL_AGAIN if the live saving of the unit is
820	* done and there is not need calling it again before the final pass.
821	* @retval VERR_SSM_VOTE_FOR_GIVING_UP if its time to give up.
822	*
823	* @param pVM VM Handle.
824	* @param pSSM SSM operation handle.
825	* @param uPass The data pass.
826	* @thread Any.
827	*/
828	typedef DECLCALLBACK(int) FNSSMINTLIVEVOTE(PVM pVM, PSSMHANDLE pSSM, uint32_t uPass);
829	/** Pointer to a FNSSMINTLIVEVOTE() function. */
830	typedef FNSSMINTLIVEVOTE *PFNSSMINTLIVEVOTE;
831
832	/**
833	* Prepare state save operation.
834	*
835	* @returns VBox status code.
836	* @param pVM VM Handle.
837	* @param pSSM SSM operation handle.
838	*/
839	typedef DECLCALLBACK(int) FNSSMINTSAVEPREP(PVM pVM, PSSMHANDLE pSSM);
840	/** Pointer to a FNSSMINTSAVEPREP() function. */
841	typedef FNSSMINTSAVEPREP *PFNSSMINTSAVEPREP;
842
843	/**
844	* Execute state save operation.
845	*
846	* @returns VBox status code.
847	* @param pVM VM Handle.
848	* @param pSSM SSM operation handle.
849	*/
850	typedef DECLCALLBACK(int) FNSSMINTSAVEEXEC(PVM pVM, PSSMHANDLE pSSM);
851	/** Pointer to a FNSSMINTSAVEEXEC() function. */
852	typedef FNSSMINTSAVEEXEC *PFNSSMINTSAVEEXEC;
853
854	/**
855	* Done state save operation.
856	*
857	* @returns VBox status code.
858	* @param pVM VM Handle.
859	* @param pSSM SSM operation handle.
860	*/
861	typedef DECLCALLBACK(int) FNSSMINTSAVEDONE(PVM pVM, PSSMHANDLE pSSM);
862	/** Pointer to a FNSSMINTSAVEDONE() function. */
863	typedef FNSSMINTSAVEDONE *PFNSSMINTSAVEDONE;
864
865	/**
866	* Prepare state load operation.
867	*
868	* @returns VBox status code.
869	* @param pVM VM Handle.
870	* @param pSSM SSM operation handle.
871	*/
872	typedef DECLCALLBACK(int) FNSSMINTLOADPREP(PVM pVM, PSSMHANDLE pSSM);
873	/** Pointer to a FNSSMINTLOADPREP() function. */
874	typedef FNSSMINTLOADPREP *PFNSSMINTLOADPREP;
875
876	/**
877	* Execute state load operation.
878	*
879	* @returns VBox status code.
880	* @param pVM VM Handle.
881	* @param pSSM SSM operation handle.
882	* @param uVersion Data layout version.
883	* @param uPass The pass. This is always SSM_PASS_FINAL for units
884	* that doesn't specify a pfnSaveLive callback.
885	*/
886	typedef DECLCALLBACK(int) FNSSMINTLOADEXEC(PVM pVM, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass);
887	/** Pointer to a FNSSMINTLOADEXEC() function. */
888	typedef FNSSMINTLOADEXEC *PFNSSMINTLOADEXEC;
889
890	/**
891	* Done state load operation.
892	*
893	* @returns VBox load code.
894	* @param pVM VM Handle.
895	* @param pSSM SSM operation handle.
896	*/
897	typedef DECLCALLBACK(int) FNSSMINTLOADDONE(PVM pVM, PSSMHANDLE pSSM);
898	/** Pointer to a FNSSMINTLOADDONE() function. */
899	typedef FNSSMINTLOADDONE *PFNSSMINTLOADDONE;
900
901	/** @} */
902
903
904	/** The External callback variants.
905	* @{
906	*/
907
908	/**
909	* Prepare state live save operation.
910	*
911	* @returns VBox status code.
912	* @param pSSM SSM operation handle.
913	* @param pvUser User argument.
914	* @thread Any.
915	*/
916	typedef DECLCALLBACK(int) FNSSMEXTLIVEPREP(PSSMHANDLE pSSM, void *pvUser);
917	/** Pointer to a FNSSMEXTLIVEPREP() function. */
918	typedef FNSSMEXTLIVEPREP *PFNSSMEXTLIVEPREP;
919
920	/**
921	* Execute state live save operation.
922	*
923	* This will be called repeatedly until all units vote that the live phase has
924	* been concluded.
925	*
926	* @returns VBox status code.
927	* @param pSSM SSM operation handle.
928	* @param pvUser User argument.
929	* @param uPass The data pass.
930	* @thread Any.
931	*/
932	typedef DECLCALLBACK(int) FNSSMEXTLIVEEXEC(PSSMHANDLE pSSM, void *pvUser, uint32_t uPass);
933	/** Pointer to a FNSSMEXTLIVEEXEC() function. */
934	typedef FNSSMEXTLIVEEXEC *PFNSSMEXTLIVEEXEC;
935
936	/**
937	* Vote on whether the live part of the saving has been concluded.
938	*
939	* The vote stops once a unit has vetoed the decision, so don't rely upon this
940	* being called every time.
941	*
942	* @returns VBox status code.
943	* @retval VINF_SUCCESS if done.
944	* @retval VINF_SSM_VOTE_FOR_ANOTHER_PASS if another pass is needed.
945	* @retval VINF_SSM_VOTE_DONE_DONT_CALL_AGAIN if the live saving of the unit is
946	* done and there is not need calling it again before the final pass.
947	* @retval VERR_SSM_VOTE_FOR_GIVING_UP if its time to give up.
948	*
949	* @param pSSM SSM operation handle.
950	* @param pvUser User argument.
951	* @param uPass The data pass.
952	* @thread Any.
953	*/
954	typedef DECLCALLBACK(int) FNSSMEXTLIVEVOTE(PSSMHANDLE pSSM, void *pvUser, uint32_t uPass);
955	/** Pointer to a FNSSMEXTLIVEVOTE() function. */
956	typedef FNSSMEXTLIVEVOTE *PFNSSMEXTLIVEVOTE;
957
958	/**
959	* Prepare state save operation.
960	*
961	* @returns VBox status code.
962	* @param pSSM SSM operation handle.
963	* @param pvUser User argument.
964	*/
965	typedef DECLCALLBACK(int) FNSSMEXTSAVEPREP(PSSMHANDLE pSSM, void *pvUser);
966	/** Pointer to a FNSSMEXTSAVEPREP() function. */
967	typedef FNSSMEXTSAVEPREP *PFNSSMEXTSAVEPREP;
968
969	/**
970	* Execute state save operation.
971	*
972	* @param pSSM SSM operation handle.
973	* @param pvUser User argument.
974	* @author The lack of return code is for legacy reasons.
975	*/
976	typedef DECLCALLBACK(void) FNSSMEXTSAVEEXEC(PSSMHANDLE pSSM, void *pvUser);
977	/** Pointer to a FNSSMEXTSAVEEXEC() function. */
978	typedef FNSSMEXTSAVEEXEC *PFNSSMEXTSAVEEXEC;
979
980	/**
981	* Done state save operation.
982	*
983	* @returns VBox status code.
984	* @param pSSM SSM operation handle.
985	* @param pvUser User argument.
986	*/
987	typedef DECLCALLBACK(int) FNSSMEXTSAVEDONE(PSSMHANDLE pSSM, void *pvUser);
988	/** Pointer to a FNSSMEXTSAVEDONE() function. */
989	typedef FNSSMEXTSAVEDONE *PFNSSMEXTSAVEDONE;
990
991	/**
992	* Prepare state load operation.
993	*
994	* @returns VBox status code.
995	* @param pSSM SSM operation handle.
996	* @param pvUser User argument.
997	*/
998	typedef DECLCALLBACK(int) FNSSMEXTLOADPREP(PSSMHANDLE pSSM, void *pvUser);
999	/** Pointer to a FNSSMEXTLOADPREP() function. */
1000	typedef FNSSMEXTLOADPREP *PFNSSMEXTLOADPREP;
1001
1002	/**
1003	* Execute state load operation.
1004	*
1005	* @returns VBox status code.
1006	* @param pSSM SSM operation handle.
1007	* @param pvUser User argument.
1008	* @param uVersion Data layout version.
1009	* @param uPass The pass. This is always SSM_PASS_FINAL for units
1010	* that doesn't specify a pfnSaveLive callback.
1011	* @remark The odd return value is for legacy reasons.
1012	*/
1013	typedef DECLCALLBACK(int) FNSSMEXTLOADEXEC(PSSMHANDLE pSSM, void *pvUser, uint32_t uVersion, uint32_t uPass);
1014	/** Pointer to a FNSSMEXTLOADEXEC() function. */
1015	typedef FNSSMEXTLOADEXEC *PFNSSMEXTLOADEXEC;
1016
1017	/**
1018	* Done state load operation.
1019	*
1020	* @returns VBox load code.
1021	* @param pSSM SSM operation handle.
1022	* @param pvUser User argument.
1023	*/
1024	typedef DECLCALLBACK(int) FNSSMEXTLOADDONE(PSSMHANDLE pSSM, void *pvUser);
1025	/** Pointer to a FNSSMEXTLOADDONE() function. */
1026	typedef FNSSMEXTLOADDONE *PFNSSMEXTLOADDONE;
1027
1028	/** @} */
1029
1030
1031	/**
1032	* SSM stream method table.
1033	*
1034	* This is used by external parties for teleporting over TCP or any other media.
1035	* SSM also uses this internally for file access, thus the 2-3 file centric
1036	* methods.
1037	*/
1038	typedef struct SSMSTRMOPS
1039	{
1040	/** Struct magic + version (SSMSTRMOPS_VERSION). */
1041	uint32_t u32Version;
1042
1043	/**
1044	* Write bytes to the stream.
1045	*
1046	* @returns VBox status code.
1047	* @param pvUser The user argument.
1048	* @param offStream The stream offset we're (supposed to be) at.
1049	* @param pvBuf Pointer to the data.
1050	* @param cbToWrite The number of bytes to write.
1051	*/
1052	DECLCALLBACKMEMBER(int, pfnWrite)(void pvUser, uint64_t offStream, const void pvBuf, size_t cbToWrite);
1053
1054	/**
1055	* Read bytes to the stream.
1056	*
1057	* @returns VBox status code.
1058	* @param pvUser The user argument.
1059	* @param offStream The stream offset we're (supposed to be) at.
1060	* @param pvBuf Where to return the bytes.
1061	* @param cbToRead The number of bytes to read.
1062	* @param pcbRead Where to return the number of bytes actually
1063	* read. This may differ from cbToRead when the
1064	* end of the stream is encountered.
1065	*/
1066	DECLCALLBACKMEMBER(int, pfnRead)(void pvUser, uint64_t offStream, void pvBuf, size_t cbToRead, size_t *pcbRead);
1067
1068	/**
1069	* Seeks in the stream.
1070	*
1071	* @returns VBox status code.
1072	* @retval VERR_NOT_SUPPORTED if the stream doesn't support this action.
1073	*
1074	* @param pvUser The user argument.
1075	* @param offSeek The seek offset.
1076	* @param uMethod RTFILE_SEEK_BEGIN, RTFILE_SEEK_END or
1077	* RTFILE_SEEK_CURRENT.
1078	* @param poffActual Where to store the new file position. Optional.
1079	*/
1080	DECLCALLBACKMEMBER(int, pfnSeek)(void pvUser, int64_t offSeek, unsigned uMethod, uint64_t poffActual);
1081
1082	/**
1083	* Get the current stream position.
1084	*
1085	* @returns The correct stream position.
1086	* @param pvUser The user argument.
1087	*/
1088	DECLCALLBACKMEMBER(uint64_t, pfnTell)(void *pvUser);
1089
1090	/**
1091	* Get the size/length of the stream.
1092	*
1093	* @returns VBox status code.
1094	* @retval VERR_NOT_SUPPORTED if the stream doesn't support this action.
1095	*
1096	* @param pvUser The user argument.
1097	* @param pcb Where to return the size/length.
1098	*/
1099	DECLCALLBACKMEMBER(int, pfnSize)(void pvUser, uint64_t pcb);
1100
1101	/**
1102	* Check if the stream is OK or not (cancelled).
1103	*
1104	* @returns VBox status code.
1105	* @param pvUser The user argument.
1106	*
1107	* @remarks The method is expected to do a LogRel on failure.
1108	*/
1109	DECLCALLBACKMEMBER(int, pfnIsOk)(void *pvUser);
1110
1111	/**
1112	* Close the stream.
1113	*
1114	* @returns VBox status code.
1115	* @param pvUser The user argument.
1116	* @param fCancelled True if the operation was cancelled.
1117	*/
1118	DECLCALLBACKMEMBER(int, pfnClose)(void *pvUser, bool fCancelled);
1119
1120	/** Struct magic + version (SSMSTRMOPS_VERSION). */
1121	uint32_t u32EndVersion;
1122	} SSMSTRMOPS;
1123	/** Struct magic + version (SSMSTRMOPS_VERSION). */
1124	#define SSMSTRMOPS_VERSION UINT32_C(0x55aa0001)
1125
1126
1127	VMMR3_INT_DECL(void) SSMR3Term(PVM pVM);
1128	VMMR3DECL(int) SSMR3RegisterDevice(PVM pVM, PPDMDEVINS pDevIns, const char pszName, uint32_t uInstance, uint32_t uVersion, size_t cbGuess, const char pszBefore,
1129	PFNSSMDEVLIVEPREP pfnLivePrep, PFNSSMDEVLIVEEXEC pfnLiveExec, PFNSSMDEVLIVEVOTE pfnLiveVote,
1130	PFNSSMDEVSAVEPREP pfnSavePrep, PFNSSMDEVSAVEEXEC pfnSaveExec, PFNSSMDEVSAVEDONE pfnSaveDone,
1131	PFNSSMDEVLOADPREP pfnLoadPrep, PFNSSMDEVLOADEXEC pfnLoadExec, PFNSSMDEVLOADDONE pfnLoadDone);
1132	VMMR3DECL(int) SSMR3RegisterDriver(PVM pVM, PPDMDRVINS pDrvIns, const char *pszName, uint32_t uInstance, uint32_t uVersion, size_t cbGuess,
1133	PFNSSMDRVLIVEPREP pfnLivePrep, PFNSSMDRVLIVEEXEC pfnLiveExec, PFNSSMDRVLIVEVOTE pfnLiveVote,
1134	PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
1135	PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone);
1136	VMMR3DECL(int) SSMR3RegisterInternal(PVM pVM, const char *pszName, uint32_t uInstance, uint32_t uVersion, size_t cbGuess,
1137	PFNSSMINTLIVEPREP pfnLivePrep, PFNSSMINTLIVEEXEC pfnLiveExec, PFNSSMINTLIVEVOTE pfnLiveVote,
1138	PFNSSMINTSAVEPREP pfnSavePrep, PFNSSMINTSAVEEXEC pfnSaveExec, PFNSSMINTSAVEDONE pfnSaveDone,
1139	PFNSSMINTLOADPREP pfnLoadPrep, PFNSSMINTLOADEXEC pfnLoadExec, PFNSSMINTLOADDONE pfnLoadDone);
1140	VMMR3DECL(int) SSMR3RegisterExternal(PVM pVM, const char *pszName, uint32_t uInstance, uint32_t uVersion, size_t cbGuess,
1141	PFNSSMEXTLIVEPREP pfnLivePrep, PFNSSMEXTLIVEEXEC pfnLiveExec, PFNSSMEXTLIVEVOTE pfnLiveVote,
1142	PFNSSMEXTSAVEPREP pfnSavePrep, PFNSSMEXTSAVEEXEC pfnSaveExec, PFNSSMEXTSAVEDONE pfnSaveDone,
1143	PFNSSMEXTLOADPREP pfnLoadPrep, PFNSSMEXTLOADEXEC pfnLoadExec, PFNSSMEXTLOADDONE pfnLoadDone, void *pvUser);
1144	VMMR3_INT_DECL(int) SSMR3DeregisterDevice(PVM pVM, PPDMDEVINS pDevIns, const char *pszName, uint32_t uInstance);
1145	VMMR3_INT_DECL(int) SSMR3DeregisterDriver(PVM pVM, PPDMDRVINS pDrvIns, const char *pszName, uint32_t uInstance);
1146	VMMR3DECL(int) SSMR3DeregisterInternal(PVM pVM, const char *pszName);
1147	VMMR3DECL(int) SSMR3DeregisterExternal(PVM pVM, const char *pszName);
1148	VMMR3DECL(int) SSMR3Save(PVM pVM, const char pszFilename, SSMAFTER enmAfter, PFNVMPROGRESS pfnProgress, void pvUser);
1149	VMMR3_INT_DECL(int) SSMR3LiveSave(PVM pVM, uint32_t cMsMaxDowntime,
1150	const char pszFilename, PCSSMSTRMOPS pStreamOps, void pvStreamOps,
1151	SSMAFTER enmAfter, PFNVMPROGRESS pfnProgress, void *pvProgressUser,
1152	PSSMHANDLE *ppSSM);
1153	VMMR3_INT_DECL(int) SSMR3LiveDoStep1(PSSMHANDLE pSSM);
1154	VMMR3_INT_DECL(int) SSMR3LiveDoStep2(PSSMHANDLE pSSM);
1155	VMMR3_INT_DECL(int) SSMR3LiveDone(PSSMHANDLE pSSM);
1156	VMMR3DECL(int) SSMR3Load(PVM pVM, const char pszFilename, PCSSMSTRMOPS pStreamOps, void pvStreamOpsUser,
1157	SSMAFTER enmAfter, PFNVMPROGRESS pfnProgress, void *pvProgressUser);
1158	VMMR3DECL(int) SSMR3ValidateFile(const char *pszFilename, bool fChecksumIt);
1159	VMMR3DECL(int) SSMR3Open(const char pszFilename, unsigned fFlags, PSSMHANDLE ppSSM);
1160	VMMR3DECL(int) SSMR3Close(PSSMHANDLE pSSM);
1161	VMMR3DECL(int) SSMR3Seek(PSSMHANDLE pSSM, const char pszUnit, uint32_t iInstance, uint32_t piVersion);
1162	VMMR3DECL(int) SSMR3HandleGetStatus(PSSMHANDLE pSSM);
1163	VMMR3DECL(int) SSMR3HandleSetStatus(PSSMHANDLE pSSM, int iStatus);
1164	VMMR3DECL(SSMAFTER) SSMR3HandleGetAfter(PSSMHANDLE pSSM);
1165	VMMR3DECL(bool) SSMR3HandleIsLiveSave(PSSMHANDLE pSSM);
1166	VMMR3DECL(uint32_t) SSMR3HandleMaxDowntime(PSSMHANDLE pSSM);
1167	VMMR3DECL(uint32_t) SSMR3HandleHostBits(PSSMHANDLE pSSM);
1168	VMMR3DECL(uint32_t) SSMR3HandleRevision(PSSMHANDLE pSSM);
1169	VMMR3DECL(uint32_t) SSMR3HandleVersion(PSSMHANDLE pSSM);
1170	VMMR3DECL(const char *) SSMR3HandleHostOSAndArch(PSSMHANDLE pSSM);
1171	VMMR3_INT_DECL(int) SSMR3SetGCPtrSize(PSSMHANDLE pSSM, unsigned cbGCPtr);
1172	VMMR3DECL(int) SSMR3Cancel(PVM pVM);
1173
1174
1175	/** Save operations.
1176	* @{
1177	*/
1178	VMMR3DECL(int) SSMR3PutStruct(PSSMHANDLE pSSM, const void *pvStruct, PCSSMFIELD paFields);
1179	VMMR3DECL(int) SSMR3PutStructEx(PSSMHANDLE pSSM, const void pvStruct, size_t cbStruct, uint32_t fFlags, PCSSMFIELD paFields, void pvUser);
1180	VMMR3DECL(int) SSMR3PutBool(PSSMHANDLE pSSM, bool fBool);
1181	VMMR3DECL(int) SSMR3PutU8(PSSMHANDLE pSSM, uint8_t u8);
1182	VMMR3DECL(int) SSMR3PutS8(PSSMHANDLE pSSM, int8_t i8);
1183	VMMR3DECL(int) SSMR3PutU16(PSSMHANDLE pSSM, uint16_t u16);
1184	VMMR3DECL(int) SSMR3PutS16(PSSMHANDLE pSSM, int16_t i16);
1185	VMMR3DECL(int) SSMR3PutU32(PSSMHANDLE pSSM, uint32_t u32);
1186	VMMR3DECL(int) SSMR3PutS32(PSSMHANDLE pSSM, int32_t i32);
1187	VMMR3DECL(int) SSMR3PutU64(PSSMHANDLE pSSM, uint64_t u64);
1188	VMMR3DECL(int) SSMR3PutS64(PSSMHANDLE pSSM, int64_t i64);
1189	VMMR3DECL(int) SSMR3PutU128(PSSMHANDLE pSSM, uint128_t u128);
1190	VMMR3DECL(int) SSMR3PutS128(PSSMHANDLE pSSM, int128_t i128);
1191	VMMR3DECL(int) SSMR3PutUInt(PSSMHANDLE pSSM, RTUINT u);
1192	VMMR3DECL(int) SSMR3PutSInt(PSSMHANDLE pSSM, RTINT i);
1193	VMMR3DECL(int) SSMR3PutGCUInt(PSSMHANDLE pSSM, RTGCUINT u);
1194	VMMR3DECL(int) SSMR3PutGCUIntReg(PSSMHANDLE pSSM, RTGCUINTREG u);
1195	VMMR3DECL(int) SSMR3PutGCPhys32(PSSMHANDLE pSSM, RTGCPHYS32 GCPhys);
1196	VMMR3DECL(int) SSMR3PutGCPhys64(PSSMHANDLE pSSM, RTGCPHYS64 GCPhys);
1197	VMMR3DECL(int) SSMR3PutGCPhys(PSSMHANDLE pSSM, RTGCPHYS GCPhys);
1198	VMMR3DECL(int) SSMR3PutGCPtr(PSSMHANDLE pSSM, RTGCPTR GCPtr);
1199	VMMR3DECL(int) SSMR3PutGCUIntPtr(PSSMHANDLE pSSM, RTGCUINTPTR GCPtr);
1200	VMMR3DECL(int) SSMR3PutRCPtr(PSSMHANDLE pSSM, RTRCPTR RCPtr);
1201	VMMR3DECL(int) SSMR3PutIOPort(PSSMHANDLE pSSM, RTIOPORT IOPort);
1202	VMMR3DECL(int) SSMR3PutSel(PSSMHANDLE pSSM, RTSEL Sel);
1203	VMMR3DECL(int) SSMR3PutMem(PSSMHANDLE pSSM, const void *pv, size_t cb);
1204	VMMR3DECL(int) SSMR3PutStrZ(PSSMHANDLE pSSM, const char *psz);
1205	/** @} */
1206
1207
1208
1209	/** Load operations.
1210	* @{
1211	*/
1212	VMMR3DECL(int) SSMR3GetStruct(PSSMHANDLE pSSM, void *pvStruct, PCSSMFIELD paFields);
1213	VMMR3DECL(int) SSMR3GetStructEx(PSSMHANDLE pSSM, void pvStruct, size_t cbStruct, uint32_t fFlags, PCSSMFIELD paFields, void pvUser);
1214	VMMR3DECL(int) SSMR3GetBool(PSSMHANDLE pSSM, bool *pfBool);
1215	VMMR3DECL(int) SSMR3GetU8(PSSMHANDLE pSSM, uint8_t *pu8);
1216	VMMR3DECL(int) SSMR3GetS8(PSSMHANDLE pSSM, int8_t *pi8);
1217	VMMR3DECL(int) SSMR3GetU16(PSSMHANDLE pSSM, uint16_t *pu16);
1218	VMMR3DECL(int) SSMR3GetS16(PSSMHANDLE pSSM, int16_t *pi16);
1219	VMMR3DECL(int) SSMR3GetU32(PSSMHANDLE pSSM, uint32_t *pu32);
1220	VMMR3DECL(int) SSMR3GetS32(PSSMHANDLE pSSM, int32_t *pi32);
1221	VMMR3DECL(int) SSMR3GetU64(PSSMHANDLE pSSM, uint64_t *pu64);
1222	VMMR3DECL(int) SSMR3GetS64(PSSMHANDLE pSSM, int64_t *pi64);
1223	VMMR3DECL(int) SSMR3GetU128(PSSMHANDLE pSSM, uint128_t *pu128);
1224	VMMR3DECL(int) SSMR3GetS128(PSSMHANDLE pSSM, int128_t *pi128);
1225	VMMR3DECL(int) SSMR3GetUInt(PSSMHANDLE pSSM, PRTUINT pu);
1226	VMMR3DECL(int) SSMR3GetSInt(PSSMHANDLE pSSM, PRTINT pi);
1227	VMMR3DECL(int) SSMR3GetGCUInt(PSSMHANDLE pSSM, PRTGCUINT pu);
1228	VMMR3DECL(int) SSMR3GetGCUIntReg(PSSMHANDLE pSSM, PRTGCUINTREG pu);
1229	VMMR3DECL(int) SSMR3GetGCPhys32(PSSMHANDLE pSSM, PRTGCPHYS32 pGCPhys);
1230	VMMR3DECL(int) SSMR3GetGCPhys64(PSSMHANDLE pSSM, PRTGCPHYS64 pGCPhys);
1231	VMMR3DECL(int) SSMR3GetGCPhys(PSSMHANDLE pSSM, PRTGCPHYS pGCPhys);
1232	VMMR3DECL(int) SSMR3GetGCPtr(PSSMHANDLE pSSM, PRTGCPTR pGCPtr);
1233	VMMR3DECL(int) SSMR3GetGCUIntPtr(PSSMHANDLE pSSM, PRTGCUINTPTR pGCPtr);
1234	VMMR3DECL(int) SSMR3GetRCPtr(PSSMHANDLE pSSM, PRTRCPTR pRCPtr);
1235	VMMR3DECL(int) SSMR3GetIOPort(PSSMHANDLE pSSM, PRTIOPORT pIOPort);
1236	VMMR3DECL(int) SSMR3GetSel(PSSMHANDLE pSSM, PRTSEL pSel);
1237	VMMR3DECL(int) SSMR3GetMem(PSSMHANDLE pSSM, void *pv, size_t cb);
1238	VMMR3DECL(int) SSMR3GetStrZ(PSSMHANDLE pSSM, char *psz, size_t cbMax);
1239	VMMR3DECL(int) SSMR3GetStrZEx(PSSMHANDLE pSSM, char psz, size_t cbMax, size_t pcbStr);
1240	VMMR3DECL(int) SSMR3GetTimer(PSSMHANDLE pSSM, PTMTIMER pTimer);
1241	VMMR3DECL(int) SSMR3Skip(PSSMHANDLE pSSM, size_t cb);
1242	VMMR3DECL(int) SSMR3SkipToEndOfUnit(PSSMHANDLE pSSM);
1243	VMMR3DECL(int) SSMR3SetLoadError(PSSMHANDLE pSSM, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...);
1244	VMMR3DECL(int) SSMR3SetLoadErrorV(PSSMHANDLE pSSM, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va);
1245	VMMR3DECL(int) SSMR3SetCfgError(PSSMHANDLE pSSM, RT_SRC_POS_DECL, const char *pszFormat, ...);
1246
1247	/** @} */
1248
1249	/** @} */
1250	#endif /* IN_RING3 */
1251
1252
1253	/** @} */
1254
1255	RT_C_DECLS_END
1256
1257	#endif
1258

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

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

Download in other formats: