VirtualBox

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

Last change on this file since 46197 was 44522, checked in by vboxsync, 12 years ago

SSM: Hide SSMR3RegisterDevice and SSMR3RegisterDriver.

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette