ssm.h@ 51934

Last change on this file since 51934 was 50575, checked in by vboxsync, 11 years ago
VMM: Added SSMR3RegisterStub and used it to provide saved state load-exec stubs for ignoring CSAM and PATM state when VBOX_WITH_RAW_MODE isn't defined or when HM is active.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 53.3 KB

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

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

source: vbox/trunk/include/VBox/vmm/ssm.h@ 51934

Download in other formats: