ssm.h@ 24917

Last change on this file since 24917 was 24917, checked in by vboxsync, 15 years ago
SSM,Main: Fixed error propagation on the target side so that a source side cancellation ends up a s VERR_SSM_CANCELLED instead of VERR_SSM_LOADED_TOO_MUCH.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 46.5 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 Driver callback variants.
513	* @{
514	*/
515
516	/**
517	* Prepare state live save operation.
518	*
519	* @returns VBox status code.
520	* @param pDrvIns Driver instance of the device which registered the
521	* data unit.
522	* @param pSSM SSM operation handle.
523	* @thread Any.
524	*/
525	typedef DECLCALLBACK(int) FNSSMDRVLIVEPREP(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
526	/** Pointer to a FNSSMDRVLIVEPREP() function. */
527	typedef FNSSMDRVLIVEPREP *PFNSSMDRVLIVEPREP;
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 pDrvIns Driver instance of the device which registered the
537	* data unit.
538	* @param pSSM SSM operation handle.
539	* @param uPass The data pass.
540	* @thread Any.
541	*/
542	typedef DECLCALLBACK(int) FNSSMDRVLIVEEXEC(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM, uint32_t uPass);
543	/** Pointer to a FNSSMDRVLIVEEXEC() function. */
544	typedef FNSSMDRVLIVEEXEC *PFNSSMDRVLIVEEXEC;
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 pDrvIns Driver instance of the device which registered the
560	* data unit.
561	* @param pSSM SSM operation handle.
562	* @param uPass The data pass.
563	* @thread Any.
564	*/
565	typedef DECLCALLBACK(int) FNSSMDRVLIVEVOTE(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM, uint32_t uPass);
566	/** Pointer to a FNSSMDRVLIVEVOTE() function. */
567	typedef FNSSMDRVLIVEVOTE *PFNSSMDRVLIVEVOTE;
568
569
570	/**
571	* Prepare state save operation.
572	*
573	* @returns VBox status code.
574	* @param pDrvIns Driver instance of the driver which registered the data unit.
575	* @param pSSM SSM operation handle.
576	*/
577	typedef DECLCALLBACK(int) FNSSMDRVSAVEPREP(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
578	/** Pointer to a FNSSMDRVSAVEPREP() function. */
579	typedef FNSSMDRVSAVEPREP *PFNSSMDRVSAVEPREP;
580
581	/**
582	* Execute state save operation.
583	*
584	* @returns VBox status code.
585	* @param pDrvIns Driver instance of the driver which registered the data unit.
586	* @param pSSM SSM operation handle.
587	*/
588	typedef DECLCALLBACK(int) FNSSMDRVSAVEEXEC(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
589	/** Pointer to a FNSSMDRVSAVEEXEC() function. */
590	typedef FNSSMDRVSAVEEXEC *PFNSSMDRVSAVEEXEC;
591
592	/**
593	* Done state save operation.
594	*
595	* @returns VBox status code.
596	* @param pDrvIns Driver instance of the driver which registered the data unit.
597	* @param pSSM SSM operation handle.
598	*/
599	typedef DECLCALLBACK(int) FNSSMDRVSAVEDONE(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
600	/** Pointer to a FNSSMDRVSAVEDONE() function. */
601	typedef FNSSMDRVSAVEDONE *PFNSSMDRVSAVEDONE;
602
603	/**
604	* Prepare state load operation.
605	*
606	* @returns VBox status code.
607	* @param pDrvIns Driver instance of the driver which registered the data unit.
608	* @param pSSM SSM operation handle.
609	*/
610	typedef DECLCALLBACK(int) FNSSMDRVLOADPREP(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
611	/** Pointer to a FNSSMDRVLOADPREP() function. */
612	typedef FNSSMDRVLOADPREP *PFNSSMDRVLOADPREP;
613
614	/**
615	* Execute state load operation.
616	*
617	* @returns VBox status code.
618	* @param pDrvIns Driver instance of the driver which registered the data unit.
619	* @param pSSM SSM operation handle.
620	* @param uVersion Data layout version.
621	* @param uPass The pass. This is always SSM_PASS_FINAL for units
622	* that doesn't specify a pfnSaveLive callback.
623	*/
624	typedef DECLCALLBACK(int) FNSSMDRVLOADEXEC(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass);
625	/** Pointer to a FNSSMDRVLOADEXEC() function. */
626	typedef FNSSMDRVLOADEXEC *PFNSSMDRVLOADEXEC;
627
628	/**
629	* Done state load operation.
630	*
631	* @returns VBox load code.
632	* @param pDrvIns Driver instance of the driver which registered the data unit.
633	* @param pSSM SSM operation handle.
634	*/
635	typedef DECLCALLBACK(int) FNSSMDRVLOADDONE(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
636	/** Pointer to a FNSSMDRVLOADDONE() function. */
637	typedef FNSSMDRVLOADDONE *PFNSSMDRVLOADDONE;
638
639	/** @} */
640
641
642	/** The internal callback variants.
643	* @{
644	*/
645
646
647	/**
648	* Prepare state live save operation.
649	*
650	* @returns VBox status code.
651	* @param pVM VM Handle.
652	* @param pSSM SSM operation handle.
653	* @thread Any.
654	*/
655	typedef DECLCALLBACK(int) FNSSMINTLIVEPREP(PVM pVM, PSSMHANDLE pSSM);
656	/** Pointer to a FNSSMINTLIVEPREP() function. */
657	typedef FNSSMINTLIVEPREP *PFNSSMINTLIVEPREP;
658
659	/**
660	* Execute state live save operation.
661	*
662	* This will be called repeatedly until all units vote that the live phase has
663	* been concluded.
664	*
665	* @returns VBox status code.
666	* @param pVM VM Handle.
667	* @param pSSM SSM operation handle.
668	* @param uPass The data pass.
669	* @thread Any.
670	*/
671	typedef DECLCALLBACK(int) FNSSMINTLIVEEXEC(PVM pVM, PSSMHANDLE pSSM, uint32_t uPass);
672	/** Pointer to a FNSSMINTLIVEEXEC() function. */
673	typedef FNSSMINTLIVEEXEC *PFNSSMINTLIVEEXEC;
674
675	/**
676	* Vote on whether the live part of the saving has been concluded.
677	*
678	* The vote stops once a unit has vetoed the decision, so don't rely upon this
679	* being called every time.
680	*
681	* @returns VBox status code.
682	* @retval VINF_SUCCESS if done.
683	* @retval VINF_SSM_VOTE_FOR_ANOTHER_PASS if another pass is needed.
684	* @retval VINF_SSM_VOTE_DONE_DONT_CALL_AGAIN if the live saving of the unit is
685	* done and there is not need calling it again before the final pass.
686	* @retval VERR_SSM_VOTE_FOR_GIVING_UP if its time to give up.
687	*
688	* @param pVM VM Handle.
689	* @param pSSM SSM operation handle.
690	* @param uPass The data pass.
691	* @thread Any.
692	*/
693	typedef DECLCALLBACK(int) FNSSMINTLIVEVOTE(PVM pVM, PSSMHANDLE pSSM, uint32_t uPass);
694	/** Pointer to a FNSSMINTLIVEVOTE() function. */
695	typedef FNSSMINTLIVEVOTE *PFNSSMINTLIVEVOTE;
696
697	/**
698	* Prepare state save operation.
699	*
700	* @returns VBox status code.
701	* @param pVM VM Handle.
702	* @param pSSM SSM operation handle.
703	*/
704	typedef DECLCALLBACK(int) FNSSMINTSAVEPREP(PVM pVM, PSSMHANDLE pSSM);
705	/** Pointer to a FNSSMINTSAVEPREP() function. */
706	typedef FNSSMINTSAVEPREP *PFNSSMINTSAVEPREP;
707
708	/**
709	* Execute state save operation.
710	*
711	* @returns VBox status code.
712	* @param pVM VM Handle.
713	* @param pSSM SSM operation handle.
714	*/
715	typedef DECLCALLBACK(int) FNSSMINTSAVEEXEC(PVM pVM, PSSMHANDLE pSSM);
716	/** Pointer to a FNSSMINTSAVEEXEC() function. */
717	typedef FNSSMINTSAVEEXEC *PFNSSMINTSAVEEXEC;
718
719	/**
720	* Done state save operation.
721	*
722	* @returns VBox status code.
723	* @param pVM VM Handle.
724	* @param pSSM SSM operation handle.
725	*/
726	typedef DECLCALLBACK(int) FNSSMINTSAVEDONE(PVM pVM, PSSMHANDLE pSSM);
727	/** Pointer to a FNSSMINTSAVEDONE() function. */
728	typedef FNSSMINTSAVEDONE *PFNSSMINTSAVEDONE;
729
730	/**
731	* Prepare state load operation.
732	*
733	* @returns VBox status code.
734	* @param pVM VM Handle.
735	* @param pSSM SSM operation handle.
736	*/
737	typedef DECLCALLBACK(int) FNSSMINTLOADPREP(PVM pVM, PSSMHANDLE pSSM);
738	/** Pointer to a FNSSMINTLOADPREP() function. */
739	typedef FNSSMINTLOADPREP *PFNSSMINTLOADPREP;
740
741	/**
742	* Execute state load operation.
743	*
744	* @returns VBox status code.
745	* @param pVM VM Handle.
746	* @param pSSM SSM operation handle.
747	* @param uVersion Data layout version.
748	* @param uPass The pass. This is always SSM_PASS_FINAL for units
749	* that doesn't specify a pfnSaveLive callback.
750	*/
751	typedef DECLCALLBACK(int) FNSSMINTLOADEXEC(PVM pVM, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass);
752	/** Pointer to a FNSSMINTLOADEXEC() function. */
753	typedef FNSSMINTLOADEXEC *PFNSSMINTLOADEXEC;
754
755	/**
756	* Done state load operation.
757	*
758	* @returns VBox load code.
759	* @param pVM VM Handle.
760	* @param pSSM SSM operation handle.
761	*/
762	typedef DECLCALLBACK(int) FNSSMINTLOADDONE(PVM pVM, PSSMHANDLE pSSM);
763	/** Pointer to a FNSSMINTLOADDONE() function. */
764	typedef FNSSMINTLOADDONE *PFNSSMINTLOADDONE;
765
766	/** @} */
767
768
769	/** The External callback variants.
770	* @{
771	*/
772
773	/**
774	* Prepare state live save operation.
775	*
776	* @returns VBox status code.
777	* @param pSSM SSM operation handle.
778	* @param pvUser User argument.
779	* @thread Any.
780	*/
781	typedef DECLCALLBACK(int) FNSSMEXTLIVEPREP(PSSMHANDLE pSSM, void *pvUser);
782	/** Pointer to a FNSSMEXTLIVEPREP() function. */
783	typedef FNSSMEXTLIVEPREP *PFNSSMEXTLIVEPREP;
784
785	/**
786	* Execute state live save operation.
787	*
788	* This will be called repeatedly until all units vote that the live phase has
789	* been concluded.
790	*
791	* @returns VBox status code.
792	* @param pSSM SSM operation handle.
793	* @param pvUser User argument.
794	* @param uPass The data pass.
795	* @thread Any.
796	*/
797	typedef DECLCALLBACK(int) FNSSMEXTLIVEEXEC(PSSMHANDLE pSSM, void *pvUser, uint32_t uPass);
798	/** Pointer to a FNSSMEXTLIVEEXEC() function. */
799	typedef FNSSMEXTLIVEEXEC *PFNSSMEXTLIVEEXEC;
800
801	/**
802	* Vote on whether the live part of the saving has been concluded.
803	*
804	* The vote stops once a unit has vetoed the decision, so don't rely upon this
805	* being called every time.
806	*
807	* @returns VBox status code.
808	* @retval VINF_SUCCESS if done.
809	* @retval VINF_SSM_VOTE_FOR_ANOTHER_PASS if another pass is needed.
810	* @retval VINF_SSM_VOTE_DONE_DONT_CALL_AGAIN if the live saving of the unit is
811	* done and there is not need calling it again before the final pass.
812	* @retval VERR_SSM_VOTE_FOR_GIVING_UP if its time to give up.
813	*
814	* @param pSSM SSM operation handle.
815	* @param pvUser User argument.
816	* @param uPass The data pass.
817	* @thread Any.
818	*/
819	typedef DECLCALLBACK(int) FNSSMEXTLIVEVOTE(PSSMHANDLE pSSM, void *pvUser, uint32_t uPass);
820	/** Pointer to a FNSSMEXTLIVEVOTE() function. */
821	typedef FNSSMEXTLIVEVOTE *PFNSSMEXTLIVEVOTE;
822
823	/**
824	* Prepare state save operation.
825	*
826	* @returns VBox status code.
827	* @param pSSM SSM operation handle.
828	* @param pvUser User argument.
829	*/
830	typedef DECLCALLBACK(int) FNSSMEXTSAVEPREP(PSSMHANDLE pSSM, void *pvUser);
831	/** Pointer to a FNSSMEXTSAVEPREP() function. */
832	typedef FNSSMEXTSAVEPREP *PFNSSMEXTSAVEPREP;
833
834	/**
835	* Execute state save operation.
836	*
837	* @param pSSM SSM operation handle.
838	* @param pvUser User argument.
839	* @author The lack of return code is for legacy reasons.
840	*/
841	typedef DECLCALLBACK(void) FNSSMEXTSAVEEXEC(PSSMHANDLE pSSM, void *pvUser);
842	/** Pointer to a FNSSMEXTSAVEEXEC() function. */
843	typedef FNSSMEXTSAVEEXEC *PFNSSMEXTSAVEEXEC;
844
845	/**
846	* Done state save operation.
847	*
848	* @returns VBox status code.
849	* @param pSSM SSM operation handle.
850	* @param pvUser User argument.
851	*/
852	typedef DECLCALLBACK(int) FNSSMEXTSAVEDONE(PSSMHANDLE pSSM, void *pvUser);
853	/** Pointer to a FNSSMEXTSAVEDONE() function. */
854	typedef FNSSMEXTSAVEDONE *PFNSSMEXTSAVEDONE;
855
856	/**
857	* Prepare state load operation.
858	*
859	* @returns VBox status code.
860	* @param pSSM SSM operation handle.
861	* @param pvUser User argument.
862	*/
863	typedef DECLCALLBACK(int) FNSSMEXTLOADPREP(PSSMHANDLE pSSM, void *pvUser);
864	/** Pointer to a FNSSMEXTLOADPREP() function. */
865	typedef FNSSMEXTLOADPREP *PFNSSMEXTLOADPREP;
866
867	/**
868	* Execute state load operation.
869	*
870	* @returns VBox status code.
871	* @param pSSM SSM operation handle.
872	* @param pvUser User argument.
873	* @param uVersion Data layout version.
874	* @param uPass The pass. This is always SSM_PASS_FINAL for units
875	* that doesn't specify a pfnSaveLive callback.
876	* @remark The odd return value is for legacy reasons.
877	*/
878	typedef DECLCALLBACK(int) FNSSMEXTLOADEXEC(PSSMHANDLE pSSM, void *pvUser, uint32_t uVersion, uint32_t uPass);
879	/** Pointer to a FNSSMEXTLOADEXEC() function. */
880	typedef FNSSMEXTLOADEXEC *PFNSSMEXTLOADEXEC;
881
882	/**
883	* Done state load operation.
884	*
885	* @returns VBox load code.
886	* @param pSSM SSM operation handle.
887	* @param pvUser User argument.
888	*/
889	typedef DECLCALLBACK(int) FNSSMEXTLOADDONE(PSSMHANDLE pSSM, void *pvUser);
890	/** Pointer to a FNSSMEXTLOADDONE() function. */
891	typedef FNSSMEXTLOADDONE *PFNSSMEXTLOADDONE;
892
893	/** @} */
894
895
896	/**
897	* SSM stream method table.
898	*
899	* This is used by external parties for teleporting over TCP or any other media.
900	* SSM also uses this internally for file access, thus the 2-3 file centric
901	* methods.
902	*/
903	typedef struct SSMSTRMOPS
904	{
905	/** Struct magic + version (SSMSTRMOPS_VERSION). */
906	uint32_t u32Version;
907
908	/**
909	* Write bytes to the stream.
910	*
911	* @returns VBox status code.
912	* @param pvUser The user argument.
913	* @param offStream The stream offset we're (supposed to be) at.
914	* @param pvBuf Pointer to the data.
915	* @param cbToWrite The number of bytes to write.
916	*/
917	DECLCALLBACKMEMBER(int, pfnWrite)(void pvUser, uint64_t offStream, const void pvBuf, size_t cbToWrite);
918
919	/**
920	* Read bytes to the stream.
921	*
922	* @returns VBox status code.
923	* @param pvUser The user argument.
924	* @param offStream The stream offset we're (supposed to be) at.
925	* @param pvBuf Where to return the bytes.
926	* @param cbToRead The number of bytes to read.
927	* @param pcbRead Where to return the number of bytes actually
928	* read. This may differ from cbToRead when the
929	* end of the stream is encountered.
930	*/
931	DECLCALLBACKMEMBER(int, pfnRead)(void pvUser, uint64_t offStream, void pvBuf, size_t cbToRead, size_t *pcbRead);
932
933	/**
934	* Seeks in the stream.
935	*
936	* @returns VBox status code.
937	* @retval VERR_NOT_SUPPORTED if the stream doesn't support this action.
938	*
939	* @param pvUser The user argument.
940	* @param offSeek The seek offset.
941	* @param uMethod RTFILE_SEEK_BEGIN, RTFILE_SEEK_END or
942	* RTFILE_SEEK_CURRENT.
943	* @param poffActual Where to store the new file position. Optional.
944	*/
945	DECLCALLBACKMEMBER(int, pfnSeek)(void pvUser, int64_t offSeek, unsigned uMethod, uint64_t poffActual);
946
947	/**
948	* Get the current stream position.
949	*
950	* @returns The correct stream position.
951	* @param pvUser The user argument.
952	*/
953	DECLCALLBACKMEMBER(uint64_t, pfnTell)(void *pvUser);
954
955	/**
956	* Get the size/length of the stream.
957	*
958	* @returns VBox status code.
959	* @retval VERR_NOT_SUPPORTED if the stream doesn't support this action.
960	*
961	* @param pvUser The user argument.
962	* @param pcb Where to return the size/length.
963	*/
964	DECLCALLBACKMEMBER(int, pfnSize)(void pvUser, uint64_t pcb);
965
966	/**
967	* Check if the stream is OK or not (cancelled).
968	*
969	* @returns VBox status code.
970	* @param pvUser The user argument.
971	*
972	* @remarks The method is expected to do a LogRel on failure.
973	*/
974	DECLCALLBACKMEMBER(int, pfnIsOk)(void *pvUser);
975
976	/**
977	* Close the stream.
978	*
979	* @returns VBox status code.
980	* @param pvUser The user argument.
981	* @param fCancelled True if the operation was cancelled.
982	*/
983	DECLCALLBACKMEMBER(int, pfnClose)(void *pvUser, bool fCancelled);
984
985	/** Struct magic + version (SSMSTRMOPS_VERSION). */
986	uint32_t u32EndVersion;
987	} SSMSTRMOPS;
988	/** Struct magic + version (SSMSTRMOPS_VERSION). */
989	#define SSMSTRMOPS_VERSION UINT32_C(0x55aa0001)
990
991
992	VMMR3_INT_DECL(void) SSMR3Term(PVM pVM);
993	VMMR3DECL(int) SSMR3RegisterDevice(PVM pVM, PPDMDEVINS pDevIns, const char pszName, uint32_t uInstance, uint32_t uVersion, size_t cbGuess, const char pszBefore,
994	PFNSSMDEVLIVEPREP pfnLivePrep, PFNSSMDEVLIVEEXEC pfnLiveExec, PFNSSMDEVLIVEVOTE pfnLiveVote,
995	PFNSSMDEVSAVEPREP pfnSavePrep, PFNSSMDEVSAVEEXEC pfnSaveExec, PFNSSMDEVSAVEDONE pfnSaveDone,
996	PFNSSMDEVLOADPREP pfnLoadPrep, PFNSSMDEVLOADEXEC pfnLoadExec, PFNSSMDEVLOADDONE pfnLoadDone);
997	VMMR3DECL(int) SSMR3RegisterDriver(PVM pVM, PPDMDRVINS pDrvIns, const char *pszName, uint32_t uInstance, uint32_t uVersion, size_t cbGuess,
998	PFNSSMDRVLIVEPREP pfnLivePrep, PFNSSMDRVLIVEEXEC pfnLiveExec, PFNSSMDRVLIVEVOTE pfnLiveVote,
999	PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
1000	PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone);
1001	VMMR3DECL(int) SSMR3RegisterInternal(PVM pVM, const char *pszName, uint32_t uInstance, uint32_t uVersion, size_t cbGuess,
1002	PFNSSMINTLIVEPREP pfnLivePrep, PFNSSMINTLIVEEXEC pfnLiveExec, PFNSSMINTLIVEVOTE pfnLiveVote,
1003	PFNSSMINTSAVEPREP pfnSavePrep, PFNSSMINTSAVEEXEC pfnSaveExec, PFNSSMINTSAVEDONE pfnSaveDone,
1004	PFNSSMINTLOADPREP pfnLoadPrep, PFNSSMINTLOADEXEC pfnLoadExec, PFNSSMINTLOADDONE pfnLoadDone);
1005	VMMR3DECL(int) SSMR3RegisterExternal(PVM pVM, const char *pszName, uint32_t uInstance, uint32_t uVersion, size_t cbGuess,
1006	PFNSSMEXTLIVEPREP pfnLivePrep, PFNSSMEXTLIVEEXEC pfnLiveExec, PFNSSMEXTLIVEVOTE pfnLiveVote,
1007	PFNSSMEXTSAVEPREP pfnSavePrep, PFNSSMEXTSAVEEXEC pfnSaveExec, PFNSSMEXTSAVEDONE pfnSaveDone,
1008	PFNSSMEXTLOADPREP pfnLoadPrep, PFNSSMEXTLOADEXEC pfnLoadExec, PFNSSMEXTLOADDONE pfnLoadDone, void *pvUser);
1009	VMMR3_INT_DECL(int) SSMR3DeregisterDevice(PVM pVM, PPDMDEVINS pDevIns, const char *pszName, uint32_t uInstance);
1010	VMMR3_INT_DECL(int) SSMR3DeregisterDriver(PVM pVM, PPDMDRVINS pDrvIns, const char *pszName, uint32_t uInstance);
1011	VMMR3DECL(int) SSMR3DeregisterInternal(PVM pVM, const char *pszName);
1012	VMMR3DECL(int) SSMR3DeregisterExternal(PVM pVM, const char *pszName);
1013	VMMR3DECL(int) SSMR3Save(PVM pVM, const char pszFilename, SSMAFTER enmAfter, PFNVMPROGRESS pfnProgress, void pvUser);
1014	VMMR3_INT_DECL(int) SSMR3LiveSave(PVM pVM, uint32_t cMsMaxDowntime,
1015	const char pszFilename, PCSSMSTRMOPS pStreamOps, void pvStreamOps,
1016	SSMAFTER enmAfter, PFNVMPROGRESS pfnProgress, void *pvProgressUser,
1017	PSSMHANDLE *ppSSM);
1018	VMMR3_INT_DECL(int) SSMR3LiveDoStep1(PSSMHANDLE pSSM);
1019	VMMR3_INT_DECL(int) SSMR3LiveDoStep2(PSSMHANDLE pSSM);
1020	VMMR3_INT_DECL(int) SSMR3LiveDone(PSSMHANDLE pSSM);
1021	VMMR3DECL(int) SSMR3Load(PVM pVM, const char pszFilename, PCSSMSTRMOPS pStreamOps, void pvStreamOpsUser,
1022	SSMAFTER enmAfter, PFNVMPROGRESS pfnProgress, void *pvProgressUser);
1023	VMMR3DECL(int) SSMR3ValidateFile(const char *pszFilename, bool fChecksumIt);
1024	VMMR3DECL(int) SSMR3Open(const char pszFilename, unsigned fFlags, PSSMHANDLE ppSSM);
1025	VMMR3DECL(int) SSMR3Close(PSSMHANDLE pSSM);
1026	VMMR3DECL(int) SSMR3Seek(PSSMHANDLE pSSM, const char pszUnit, uint32_t iInstance, uint32_t piVersion);
1027	VMMR3DECL(int) SSMR3HandleGetStatus(PSSMHANDLE pSSM);
1028	VMMR3DECL(int) SSMR3HandleSetStatus(PSSMHANDLE pSSM, int iStatus);
1029	VMMR3DECL(SSMAFTER) SSMR3HandleGetAfter(PSSMHANDLE pSSM);
1030	VMMR3DECL(bool) SSMR3HandleIsLiveSave(PSSMHANDLE pSSM);
1031	VMMR3DECL(uint32_t) SSMR3HandleMaxDowntime(PSSMHANDLE pSSM);
1032	VMMR3DECL(uint32_t) SSMR3HandleHostBits(PSSMHANDLE pSSM);
1033	VMMR3DECL(uint32_t) SSMR3HandleRevision(PSSMHANDLE pSSM);
1034	VMMR3DECL(uint32_t) SSMR3HandleVersion(PSSMHANDLE pSSM);
1035	VMMR3DECL(const char *) SSMR3HandleHostOSAndArch(PSSMHANDLE pSSM);
1036	VMMR3_INT_DECL(int) SSMR3SetGCPtrSize(PSSMHANDLE pSSM, unsigned cbGCPtr);
1037	VMMR3DECL(int) SSMR3Cancel(PVM pVM);
1038
1039
1040	/** Save operations.
1041	* @{
1042	*/
1043	VMMR3DECL(int) SSMR3PutStruct(PSSMHANDLE pSSM, const void *pvStruct, PCSSMFIELD paFields);
1044	VMMR3DECL(int) SSMR3PutStructEx(PSSMHANDLE pSSM, const void pvStruct, size_t cbStruct, uint32_t fFlags, PCSSMFIELD paFields, void pvUser);
1045	VMMR3DECL(int) SSMR3PutBool(PSSMHANDLE pSSM, bool fBool);
1046	VMMR3DECL(int) SSMR3PutU8(PSSMHANDLE pSSM, uint8_t u8);
1047	VMMR3DECL(int) SSMR3PutS8(PSSMHANDLE pSSM, int8_t i8);
1048	VMMR3DECL(int) SSMR3PutU16(PSSMHANDLE pSSM, uint16_t u16);
1049	VMMR3DECL(int) SSMR3PutS16(PSSMHANDLE pSSM, int16_t i16);
1050	VMMR3DECL(int) SSMR3PutU32(PSSMHANDLE pSSM, uint32_t u32);
1051	VMMR3DECL(int) SSMR3PutS32(PSSMHANDLE pSSM, int32_t i32);
1052	VMMR3DECL(int) SSMR3PutU64(PSSMHANDLE pSSM, uint64_t u64);
1053	VMMR3DECL(int) SSMR3PutS64(PSSMHANDLE pSSM, int64_t i64);
1054	VMMR3DECL(int) SSMR3PutU128(PSSMHANDLE pSSM, uint128_t u128);
1055	VMMR3DECL(int) SSMR3PutS128(PSSMHANDLE pSSM, int128_t i128);
1056	VMMR3DECL(int) SSMR3PutUInt(PSSMHANDLE pSSM, RTUINT u);
1057	VMMR3DECL(int) SSMR3PutSInt(PSSMHANDLE pSSM, RTINT i);
1058	VMMR3DECL(int) SSMR3PutGCUInt(PSSMHANDLE pSSM, RTGCUINT u);
1059	VMMR3DECL(int) SSMR3PutGCUIntReg(PSSMHANDLE pSSM, RTGCUINTREG u);
1060	VMMR3DECL(int) SSMR3PutGCPhys32(PSSMHANDLE pSSM, RTGCPHYS32 GCPhys);
1061	VMMR3DECL(int) SSMR3PutGCPhys64(PSSMHANDLE pSSM, RTGCPHYS64 GCPhys);
1062	VMMR3DECL(int) SSMR3PutGCPhys(PSSMHANDLE pSSM, RTGCPHYS GCPhys);
1063	VMMR3DECL(int) SSMR3PutGCPtr(PSSMHANDLE pSSM, RTGCPTR GCPtr);
1064	VMMR3DECL(int) SSMR3PutGCUIntPtr(PSSMHANDLE pSSM, RTGCUINTPTR GCPtr);
1065	VMMR3DECL(int) SSMR3PutRCPtr(PSSMHANDLE pSSM, RTRCPTR RCPtr);
1066	VMMR3DECL(int) SSMR3PutIOPort(PSSMHANDLE pSSM, RTIOPORT IOPort);
1067	VMMR3DECL(int) SSMR3PutSel(PSSMHANDLE pSSM, RTSEL Sel);
1068	VMMR3DECL(int) SSMR3PutMem(PSSMHANDLE pSSM, const void *pv, size_t cb);
1069	VMMR3DECL(int) SSMR3PutStrZ(PSSMHANDLE pSSM, const char *psz);
1070	/** @} */
1071
1072
1073
1074	/** Load operations.
1075	* @{
1076	*/
1077	VMMR3DECL(int) SSMR3GetStruct(PSSMHANDLE pSSM, void *pvStruct, PCSSMFIELD paFields);
1078	VMMR3DECL(int) SSMR3GetStructEx(PSSMHANDLE pSSM, void pvStruct, size_t cbStruct, uint32_t fFlags, PCSSMFIELD paFields, void pvUser);
1079	VMMR3DECL(int) SSMR3GetBool(PSSMHANDLE pSSM, bool *pfBool);
1080	VMMR3DECL(int) SSMR3GetU8(PSSMHANDLE pSSM, uint8_t *pu8);
1081	VMMR3DECL(int) SSMR3GetS8(PSSMHANDLE pSSM, int8_t *pi8);
1082	VMMR3DECL(int) SSMR3GetU16(PSSMHANDLE pSSM, uint16_t *pu16);
1083	VMMR3DECL(int) SSMR3GetS16(PSSMHANDLE pSSM, int16_t *pi16);
1084	VMMR3DECL(int) SSMR3GetU32(PSSMHANDLE pSSM, uint32_t *pu32);
1085	VMMR3DECL(int) SSMR3GetS32(PSSMHANDLE pSSM, int32_t *pi32);
1086	VMMR3DECL(int) SSMR3GetU64(PSSMHANDLE pSSM, uint64_t *pu64);
1087	VMMR3DECL(int) SSMR3GetS64(PSSMHANDLE pSSM, int64_t *pi64);
1088	VMMR3DECL(int) SSMR3GetU128(PSSMHANDLE pSSM, uint128_t *pu128);
1089	VMMR3DECL(int) SSMR3GetS128(PSSMHANDLE pSSM, int128_t *pi128);
1090	VMMR3DECL(int) SSMR3GetUInt(PSSMHANDLE pSSM, PRTUINT pu);
1091	VMMR3DECL(int) SSMR3GetSInt(PSSMHANDLE pSSM, PRTINT pi);
1092	VMMR3DECL(int) SSMR3GetGCUInt(PSSMHANDLE pSSM, PRTGCUINT pu);
1093	VMMR3DECL(int) SSMR3GetGCUIntReg(PSSMHANDLE pSSM, PRTGCUINTREG pu);
1094	VMMR3DECL(int) SSMR3GetGCPhys32(PSSMHANDLE pSSM, PRTGCPHYS32 pGCPhys);
1095	VMMR3DECL(int) SSMR3GetGCPhys64(PSSMHANDLE pSSM, PRTGCPHYS64 pGCPhys);
1096	VMMR3DECL(int) SSMR3GetGCPhys(PSSMHANDLE pSSM, PRTGCPHYS pGCPhys);
1097	VMMR3DECL(int) SSMR3GetGCPtr(PSSMHANDLE pSSM, PRTGCPTR pGCPtr);
1098	VMMR3DECL(int) SSMR3GetGCUIntPtr(PSSMHANDLE pSSM, PRTGCUINTPTR pGCPtr);
1099	VMMR3DECL(int) SSMR3GetRCPtr(PSSMHANDLE pSSM, PRTRCPTR pRCPtr);
1100	VMMR3DECL(int) SSMR3GetIOPort(PSSMHANDLE pSSM, PRTIOPORT pIOPort);
1101	VMMR3DECL(int) SSMR3GetSel(PSSMHANDLE pSSM, PRTSEL pSel);
1102	VMMR3DECL(int) SSMR3GetMem(PSSMHANDLE pSSM, void *pv, size_t cb);
1103	VMMR3DECL(int) SSMR3GetStrZ(PSSMHANDLE pSSM, char *psz, size_t cbMax);
1104	VMMR3DECL(int) SSMR3GetStrZEx(PSSMHANDLE pSSM, char psz, size_t cbMax, size_t pcbStr);
1105	VMMR3DECL(int) SSMR3GetTimer(PSSMHANDLE pSSM, PTMTIMER pTimer);
1106	VMMR3DECL(int) SSMR3Skip(PSSMHANDLE pSSM, size_t cb);
1107	VMMR3DECL(int) SSMR3SkipToEndOfUnit(PSSMHANDLE pSSM);
1108	VMMR3DECL(int) SSMR3SetLoadError(PSSMHANDLE pSSM, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...);
1109	VMMR3DECL(int) SSMR3SetLoadErrorV(PSSMHANDLE pSSM, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va);
1110	VMMR3DECL(int) SSMR3SetCfgError(PSSMHANDLE pSSM, RT_SRC_POS_DECL, const char *pszFormat, ...);
1111
1112	/** @} */
1113
1114	/** @} */
1115	#endif /* IN_RING3 */
1116
1117
1118	/** @} */
1119
1120	RT_C_DECLS_END
1121
1122	#endif
1123

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

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

Download in other formats: