| 1 | /** @file
|
|---|
| 2 | * SSM - The Save State Manager.
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2006-2007 innotek GmbH
|
|---|
| 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_ssm_h
|
|---|
| 27 | #define ___VBox_ssm_h
|
|---|
| 28 |
|
|---|
| 29 | #include <VBox/cdefs.h>
|
|---|
| 30 | #include <VBox/types.h>
|
|---|
| 31 | #include <VBox/tm.h>
|
|---|
| 32 | #include <VBox/vmapi.h>
|
|---|
| 33 |
|
|---|
| 34 | __BEGIN_DECLS
|
|---|
| 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 |
|
|---|
| 59 | #ifdef IN_RING3
|
|---|
| 60 | /** @defgroup grp_ssm_r3 The SSM Host Context Ring-3 API
|
|---|
| 61 | * @{
|
|---|
| 62 | */
|
|---|
| 63 |
|
|---|
| 64 |
|
|---|
| 65 | /**
|
|---|
| 66 | * What to do after the save/load operation.
|
|---|
| 67 | */
|
|---|
| 68 | typedef enum SSMAFTER
|
|---|
| 69 | {
|
|---|
| 70 | /** Will resume the loaded state. */
|
|---|
| 71 | SSMAFTER_RESUME = 1,
|
|---|
| 72 | /** Will destroy the VM after saving. */
|
|---|
| 73 | SSMAFTER_DESTROY,
|
|---|
| 74 | /** Will continue execution after saving the VM. */
|
|---|
| 75 | SSMAFTER_CONTINUE,
|
|---|
| 76 | /** Will debug the saved state.
|
|---|
| 77 | * This is used to drop some of the stricter consitentcy checks so it'll
|
|---|
| 78 | * load fine in the debugger or animator. */
|
|---|
| 79 | SSMAFTER_DEBUG_IT,
|
|---|
| 80 | /** The file was opened using SSMR3Open() and we have no idea what the plan is. */
|
|---|
| 81 | SSMAFTER_OPENED
|
|---|
| 82 | } SSMAFTER;
|
|---|
| 83 |
|
|---|
| 84 |
|
|---|
| 85 | /**
|
|---|
| 86 | * A structure field description.
|
|---|
| 87 | */
|
|---|
| 88 | typedef struct SSMFIELD
|
|---|
| 89 | {
|
|---|
| 90 | /** Field offset into the structure. */
|
|---|
| 91 | uint32_t off;
|
|---|
| 92 | /** The size of the field. */
|
|---|
| 93 | uint32_t cb;
|
|---|
| 94 | } SSMFIELD;
|
|---|
| 95 | /** Pointer to a structure field description. */
|
|---|
| 96 | typedef SSMFIELD *PSSMFIELD;
|
|---|
| 97 | /** Pointer to a const structure field description. */
|
|---|
| 98 | typedef const SSMFIELD *PCSSMFIELD;
|
|---|
| 99 |
|
|---|
| 100 | /** Emit a SSMFIELD array entry. */
|
|---|
| 101 | #define SSMFIELD_ENTRY(Type, Field) { RT_OFFSETOF(Type, Field), RT_SIZEOFMEMB(Type, Field) }
|
|---|
| 102 | /** Emit the terminating entry of a SSMFIELD array. */
|
|---|
| 103 | #define SSMFIELD_ENTRY_TERM() { UINT32_MAX, UINT32_MAX }
|
|---|
| 104 |
|
|---|
| 105 |
|
|---|
| 106 |
|
|---|
| 107 | /** The PDM Device callback variants.
|
|---|
| 108 | * @{
|
|---|
| 109 | */
|
|---|
| 110 |
|
|---|
| 111 | /**
|
|---|
| 112 | * Prepare state save operation.
|
|---|
| 113 | *
|
|---|
| 114 | * @returns VBox status code.
|
|---|
| 115 | * @param pDevIns Device instance of the device which registered the data unit.
|
|---|
| 116 | * @param pSSM SSM operation handle.
|
|---|
| 117 | */
|
|---|
| 118 | typedef DECLCALLBACK(int) FNSSMDEVSAVEPREP(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
|
|---|
| 119 | /** Pointer to a FNSSMDEVSAVEPREP() function. */
|
|---|
| 120 | typedef FNSSMDEVSAVEPREP *PFNSSMDEVSAVEPREP;
|
|---|
| 121 |
|
|---|
| 122 | /**
|
|---|
| 123 | * Execute state save operation.
|
|---|
| 124 | *
|
|---|
| 125 | * @returns VBox status code.
|
|---|
| 126 | * @param pDevIns Device instance of the device which registered the data unit.
|
|---|
| 127 | * @param pSSM SSM operation handle.
|
|---|
| 128 | */
|
|---|
| 129 | typedef DECLCALLBACK(int) FNSSMDEVSAVEEXEC(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
|
|---|
| 130 | /** Pointer to a FNSSMDEVSAVEEXEC() function. */
|
|---|
| 131 | typedef FNSSMDEVSAVEEXEC *PFNSSMDEVSAVEEXEC;
|
|---|
| 132 |
|
|---|
| 133 | /**
|
|---|
| 134 | * Done state save operation.
|
|---|
| 135 | *
|
|---|
| 136 | * @returns VBox status code.
|
|---|
| 137 | * @param pDevIns Device instance of the device which registered the data unit.
|
|---|
| 138 | * @param pSSM SSM operation handle.
|
|---|
| 139 | */
|
|---|
| 140 | typedef DECLCALLBACK(int) FNSSMDEVSAVEDONE(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
|
|---|
| 141 | /** Pointer to a FNSSMDEVSAVEDONE() function. */
|
|---|
| 142 | typedef FNSSMDEVSAVEDONE *PFNSSMDEVSAVEDONE;
|
|---|
| 143 |
|
|---|
| 144 | /**
|
|---|
| 145 | * Prepare state load operation.
|
|---|
| 146 | *
|
|---|
| 147 | * @returns VBox status code.
|
|---|
| 148 | * @param pDevIns Device instance of the device which registered the data unit.
|
|---|
| 149 | * @param pSSM SSM operation handle.
|
|---|
| 150 | */
|
|---|
| 151 | typedef DECLCALLBACK(int) FNSSMDEVLOADPREP(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
|
|---|
| 152 | /** Pointer to a FNSSMDEVLOADPREP() function. */
|
|---|
| 153 | typedef FNSSMDEVLOADPREP *PFNSSMDEVLOADPREP;
|
|---|
| 154 |
|
|---|
| 155 | /**
|
|---|
| 156 | * Execute state load operation.
|
|---|
| 157 | *
|
|---|
| 158 | * @returns VBox status code.
|
|---|
| 159 | * @param pDevIns Device instance of the device which registered the data unit.
|
|---|
| 160 | * @param pSSM SSM operation handle.
|
|---|
| 161 | * @param u32Version Data layout version.
|
|---|
| 162 | */
|
|---|
| 163 | typedef DECLCALLBACK(int) FNSSMDEVLOADEXEC(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t u32Version);
|
|---|
| 164 | /** Pointer to a FNSSMDEVLOADEXEC() function. */
|
|---|
| 165 | typedef FNSSMDEVLOADEXEC *PFNSSMDEVLOADEXEC;
|
|---|
| 166 |
|
|---|
| 167 | /**
|
|---|
| 168 | * Done state load operation.
|
|---|
| 169 | *
|
|---|
| 170 | * @returns VBox load code.
|
|---|
| 171 | * @param pDevIns Device instance of the device which registered the data unit.
|
|---|
| 172 | * @param pSSM SSM operation handle.
|
|---|
| 173 | */
|
|---|
| 174 | typedef DECLCALLBACK(int) FNSSMDEVLOADDONE(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
|
|---|
| 175 | /** Pointer to a FNSSMDEVLOADDONE() function. */
|
|---|
| 176 | typedef FNSSMDEVLOADDONE *PFNSSMDEVLOADDONE;
|
|---|
| 177 |
|
|---|
| 178 | /** @} */
|
|---|
| 179 |
|
|---|
| 180 |
|
|---|
| 181 | /** The PDM Driver callback variants.
|
|---|
| 182 | * @{
|
|---|
| 183 | */
|
|---|
| 184 |
|
|---|
| 185 | /**
|
|---|
| 186 | * Prepare state save operation.
|
|---|
| 187 | *
|
|---|
| 188 | * @returns VBox status code.
|
|---|
| 189 | * @param pDrvIns Driver instance of the driver which registered the data unit.
|
|---|
| 190 | * @param pSSM SSM operation handle.
|
|---|
| 191 | */
|
|---|
| 192 | typedef DECLCALLBACK(int) FNSSMDRVSAVEPREP(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
|
|---|
| 193 | /** Pointer to a FNSSMDRVSAVEPREP() function. */
|
|---|
| 194 | typedef FNSSMDRVSAVEPREP *PFNSSMDRVSAVEPREP;
|
|---|
| 195 |
|
|---|
| 196 | /**
|
|---|
| 197 | * Execute state save operation.
|
|---|
| 198 | *
|
|---|
| 199 | * @returns VBox status code.
|
|---|
| 200 | * @param pDrvIns Driver instance of the driver which registered the data unit.
|
|---|
| 201 | * @param pSSM SSM operation handle.
|
|---|
| 202 | */
|
|---|
| 203 | typedef DECLCALLBACK(int) FNSSMDRVSAVEEXEC(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
|
|---|
| 204 | /** Pointer to a FNSSMDRVSAVEEXEC() function. */
|
|---|
| 205 | typedef FNSSMDRVSAVEEXEC *PFNSSMDRVSAVEEXEC;
|
|---|
| 206 |
|
|---|
| 207 | /**
|
|---|
| 208 | * Done state save operation.
|
|---|
| 209 | *
|
|---|
| 210 | * @returns VBox status code.
|
|---|
| 211 | * @param pDrvIns Driver instance of the driver which registered the data unit.
|
|---|
| 212 | * @param pSSM SSM operation handle.
|
|---|
| 213 | */
|
|---|
| 214 | typedef DECLCALLBACK(int) FNSSMDRVSAVEDONE(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
|
|---|
| 215 | /** Pointer to a FNSSMDRVSAVEDONE() function. */
|
|---|
| 216 | typedef FNSSMDRVSAVEDONE *PFNSSMDRVSAVEDONE;
|
|---|
| 217 |
|
|---|
| 218 | /**
|
|---|
| 219 | * Prepare state load operation.
|
|---|
| 220 | *
|
|---|
| 221 | * @returns VBox status code.
|
|---|
| 222 | * @param pDrvIns Driver instance of the driver which registered the data unit.
|
|---|
| 223 | * @param pSSM SSM operation handle.
|
|---|
| 224 | */
|
|---|
| 225 | typedef DECLCALLBACK(int) FNSSMDRVLOADPREP(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
|
|---|
| 226 | /** Pointer to a FNSSMDRVLOADPREP() function. */
|
|---|
| 227 | typedef FNSSMDRVLOADPREP *PFNSSMDRVLOADPREP;
|
|---|
| 228 |
|
|---|
| 229 | /**
|
|---|
| 230 | * Execute state load operation.
|
|---|
| 231 | *
|
|---|
| 232 | * @returns VBox status code.
|
|---|
| 233 | * @param pDrvIns Driver instance of the driver which registered the data unit.
|
|---|
| 234 | * @param pSSM SSM operation handle.
|
|---|
| 235 | * @param u32Version Data layout version.
|
|---|
| 236 | */
|
|---|
| 237 | typedef DECLCALLBACK(int) FNSSMDRVLOADEXEC(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM, uint32_t u32Version);
|
|---|
| 238 | /** Pointer to a FNSSMDRVLOADEXEC() function. */
|
|---|
| 239 | typedef FNSSMDRVLOADEXEC *PFNSSMDRVLOADEXEC;
|
|---|
| 240 |
|
|---|
| 241 | /**
|
|---|
| 242 | * Done state load operation.
|
|---|
| 243 | *
|
|---|
| 244 | * @returns VBox load code.
|
|---|
| 245 | * @param pDrvIns Driver instance of the driver which registered the data unit.
|
|---|
| 246 | * @param pSSM SSM operation handle.
|
|---|
| 247 | */
|
|---|
| 248 | typedef DECLCALLBACK(int) FNSSMDRVLOADDONE(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM);
|
|---|
| 249 | /** Pointer to a FNSSMDRVLOADDONE() function. */
|
|---|
| 250 | typedef FNSSMDRVLOADDONE *PFNSSMDRVLOADDONE;
|
|---|
| 251 |
|
|---|
| 252 | /** @} */
|
|---|
| 253 |
|
|---|
| 254 |
|
|---|
| 255 | /** The internal callback variants.
|
|---|
| 256 | * @{
|
|---|
| 257 | */
|
|---|
| 258 |
|
|---|
| 259 | /**
|
|---|
| 260 | * Prepare state save operation.
|
|---|
| 261 | *
|
|---|
| 262 | * @returns VBox status code.
|
|---|
| 263 | * @param pVM VM Handle.
|
|---|
| 264 | * @param pSSM SSM operation handle.
|
|---|
| 265 | */
|
|---|
| 266 | typedef DECLCALLBACK(int) FNSSMINTSAVEPREP(PVM pVM, PSSMHANDLE pSSM);
|
|---|
| 267 | /** Pointer to a FNSSMINTSAVEPREP() function. */
|
|---|
| 268 | typedef FNSSMINTSAVEPREP *PFNSSMINTSAVEPREP;
|
|---|
| 269 |
|
|---|
| 270 | /**
|
|---|
| 271 | * Execute state save operation.
|
|---|
| 272 | *
|
|---|
| 273 | * @returns VBox status code.
|
|---|
| 274 | * @param pVM VM Handle.
|
|---|
| 275 | * @param pSSM SSM operation handle.
|
|---|
| 276 | */
|
|---|
| 277 | typedef DECLCALLBACK(int) FNSSMINTSAVEEXEC(PVM pVM, PSSMHANDLE pSSM);
|
|---|
| 278 | /** Pointer to a FNSSMINTSAVEEXEC() function. */
|
|---|
| 279 | typedef FNSSMINTSAVEEXEC *PFNSSMINTSAVEEXEC;
|
|---|
| 280 |
|
|---|
| 281 | /**
|
|---|
| 282 | * Done state save operation.
|
|---|
| 283 | *
|
|---|
| 284 | * @returns VBox status code.
|
|---|
| 285 | * @param pVM VM Handle.
|
|---|
| 286 | * @param pSSM SSM operation handle.
|
|---|
| 287 | */
|
|---|
| 288 | typedef DECLCALLBACK(int) FNSSMINTSAVEDONE(PVM pVM, PSSMHANDLE pSSM);
|
|---|
| 289 | /** Pointer to a FNSSMINTSAVEDONE() function. */
|
|---|
| 290 | typedef FNSSMINTSAVEDONE *PFNSSMINTSAVEDONE;
|
|---|
| 291 |
|
|---|
| 292 | /**
|
|---|
| 293 | * Prepare state load operation.
|
|---|
| 294 | *
|
|---|
| 295 | * @returns VBox status code.
|
|---|
| 296 | * @param pVM VM Handle.
|
|---|
| 297 | * @param pSSM SSM operation handle.
|
|---|
| 298 | */
|
|---|
| 299 | typedef DECLCALLBACK(int) FNSSMINTLOADPREP(PVM pVM, PSSMHANDLE pSSM);
|
|---|
| 300 | /** Pointer to a FNSSMINTLOADPREP() function. */
|
|---|
| 301 | typedef FNSSMINTLOADPREP *PFNSSMINTLOADPREP;
|
|---|
| 302 |
|
|---|
| 303 | /**
|
|---|
| 304 | * Execute state load operation.
|
|---|
| 305 | *
|
|---|
| 306 | * @returns VBox status code.
|
|---|
| 307 | * @param pVM VM Handle.
|
|---|
| 308 | * @param pSSM SSM operation handle.
|
|---|
| 309 | * @param u32Version Data layout version.
|
|---|
| 310 | */
|
|---|
| 311 | typedef DECLCALLBACK(int) FNSSMINTLOADEXEC(PVM pVM, PSSMHANDLE pSSM, uint32_t u32Version);
|
|---|
| 312 | /** Pointer to a FNSSMINTLOADEXEC() function. */
|
|---|
| 313 | typedef FNSSMINTLOADEXEC *PFNSSMINTLOADEXEC;
|
|---|
| 314 |
|
|---|
| 315 | /**
|
|---|
| 316 | * Done state load operation.
|
|---|
| 317 | *
|
|---|
| 318 | * @returns VBox load code.
|
|---|
| 319 | * @param pVM VM Handle.
|
|---|
| 320 | * @param pSSM SSM operation handle.
|
|---|
| 321 | */
|
|---|
| 322 | typedef DECLCALLBACK(int) FNSSMINTLOADDONE(PVM pVM, PSSMHANDLE pSSM);
|
|---|
| 323 | /** Pointer to a FNSSMINTLOADDONE() function. */
|
|---|
| 324 | typedef FNSSMINTLOADDONE *PFNSSMINTLOADDONE;
|
|---|
| 325 |
|
|---|
| 326 | /** @} */
|
|---|
| 327 |
|
|---|
| 328 |
|
|---|
| 329 | /** The External callback variants.
|
|---|
| 330 | * @{
|
|---|
| 331 | */
|
|---|
| 332 |
|
|---|
| 333 | /**
|
|---|
| 334 | * Prepare state save operation.
|
|---|
| 335 | *
|
|---|
| 336 | * @returns VBox status code.
|
|---|
| 337 | * @param pSSM SSM operation handle.
|
|---|
| 338 | * @param pvUser User argument.
|
|---|
| 339 | */
|
|---|
| 340 | typedef DECLCALLBACK(int) FNSSMEXTSAVEPREP(PSSMHANDLE pSSM, void *pvUser);
|
|---|
| 341 | /** Pointer to a FNSSMEXTSAVEPREP() function. */
|
|---|
| 342 | typedef FNSSMEXTSAVEPREP *PFNSSMEXTSAVEPREP;
|
|---|
| 343 |
|
|---|
| 344 | /**
|
|---|
| 345 | * Execute state save operation.
|
|---|
| 346 | *
|
|---|
| 347 | * @param pSSM SSM operation handle.
|
|---|
| 348 | * @param pvUser User argument.
|
|---|
| 349 | * @author The lack of return code is for legacy reasons.
|
|---|
| 350 | */
|
|---|
| 351 | typedef DECLCALLBACK(void) FNSSMEXTSAVEEXEC(PSSMHANDLE pSSM, void *pvUser);
|
|---|
| 352 | /** Pointer to a FNSSMEXTSAVEEXEC() function. */
|
|---|
| 353 | typedef FNSSMEXTSAVEEXEC *PFNSSMEXTSAVEEXEC;
|
|---|
| 354 |
|
|---|
| 355 | /**
|
|---|
| 356 | * Done state save operation.
|
|---|
| 357 | *
|
|---|
| 358 | * @returns VBox status code.
|
|---|
| 359 | * @param pSSM SSM operation handle.
|
|---|
| 360 | * @param pvUser User argument.
|
|---|
| 361 | */
|
|---|
| 362 | typedef DECLCALLBACK(int) FNSSMEXTSAVEDONE(PSSMHANDLE pSSM, void *pvUser);
|
|---|
| 363 | /** Pointer to a FNSSMEXTSAVEDONE() function. */
|
|---|
| 364 | typedef FNSSMEXTSAVEDONE *PFNSSMEXTSAVEDONE;
|
|---|
| 365 |
|
|---|
| 366 | /**
|
|---|
| 367 | * Prepare state load operation.
|
|---|
| 368 | *
|
|---|
| 369 | * @returns VBox status code.
|
|---|
| 370 | * @param pSSM SSM operation handle.
|
|---|
| 371 | * @param pvUser User argument.
|
|---|
| 372 | */
|
|---|
| 373 | typedef DECLCALLBACK(int) FNSSMEXTLOADPREP(PSSMHANDLE pSSM, void *pvUser);
|
|---|
| 374 | /** Pointer to a FNSSMEXTLOADPREP() function. */
|
|---|
| 375 | typedef FNSSMEXTLOADPREP *PFNSSMEXTLOADPREP;
|
|---|
| 376 |
|
|---|
| 377 | /**
|
|---|
| 378 | * Execute state load operation.
|
|---|
| 379 | *
|
|---|
| 380 | * @returns 0 on success.
|
|---|
| 381 | * @returns Not 0 on failure.
|
|---|
| 382 | * @param pSSM SSM operation handle.
|
|---|
| 383 | * @param pvUser User argument.
|
|---|
| 384 | * @param u32Version Data layout version.
|
|---|
| 385 | * @remark The odd return value is for legacy reasons.
|
|---|
| 386 | */
|
|---|
| 387 | typedef DECLCALLBACK(int) FNSSMEXTLOADEXEC(PSSMHANDLE pSSM, void *pvUser, uint32_t u32Version);
|
|---|
| 388 | /** Pointer to a FNSSMEXTLOADEXEC() function. */
|
|---|
| 389 | typedef FNSSMEXTLOADEXEC *PFNSSMEXTLOADEXEC;
|
|---|
| 390 |
|
|---|
| 391 | /**
|
|---|
| 392 | * Done state load operation.
|
|---|
| 393 | *
|
|---|
| 394 | * @returns VBox load code.
|
|---|
| 395 | * @param pSSM SSM operation handle.
|
|---|
| 396 | * @param pvUser User argument.
|
|---|
| 397 | */
|
|---|
| 398 | typedef DECLCALLBACK(int) FNSSMEXTLOADDONE(PSSMHANDLE pSSM, void *pvUser);
|
|---|
| 399 | /** Pointer to a FNSSMEXTLOADDONE() function. */
|
|---|
| 400 | typedef FNSSMEXTLOADDONE *PFNSSMEXTLOADDONE;
|
|---|
| 401 |
|
|---|
| 402 | /** @} */
|
|---|
| 403 |
|
|---|
| 404 |
|
|---|
| 405 | SSMR3DECL(int) SSMR3Register(PVM pVM, PPDMDEVINS pDevIns, const char *pszName, uint32_t u32Instance, uint32_t u32Version, size_t cbGuess,
|
|---|
| 406 | PFNSSMDEVSAVEPREP pfnSavePrep, PFNSSMDEVSAVEEXEC pfnSaveExec, PFNSSMDEVSAVEDONE pfnSaveDone,
|
|---|
| 407 | PFNSSMDEVLOADPREP pfnLoadPrep, PFNSSMDEVLOADEXEC pfnLoadExec, PFNSSMDEVLOADDONE pfnLoadDone);
|
|---|
| 408 | SSMR3DECL(int) SSMR3RegisterDriver(PVM pVM, PPDMDRVINS pDrvIns, const char *pszName, uint32_t u32Instance, uint32_t u32Version, size_t cbGuess,
|
|---|
| 409 | PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
|
|---|
| 410 | PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone);
|
|---|
| 411 | SSMR3DECL(int) SSMR3RegisterInternal(PVM pVM, const char *pszName, uint32_t u32Instance, uint32_t u32Version, size_t cbGuess,
|
|---|
| 412 | PFNSSMINTSAVEPREP pfnSavePrep, PFNSSMINTSAVEEXEC pfnSaveExec, PFNSSMINTSAVEDONE pfnSaveDone,
|
|---|
| 413 | PFNSSMINTLOADPREP pfnLoadPrep, PFNSSMINTLOADEXEC pfnLoadExec, PFNSSMINTLOADDONE pfnLoadDone);
|
|---|
| 414 | SSMR3DECL(int) SSMR3RegisterExternal(PVM pVM, const char *pszName, uint32_t u32Instance, uint32_t u32Version, size_t cbGuess,
|
|---|
| 415 | PFNSSMEXTSAVEPREP pfnSavePrep, PFNSSMEXTSAVEEXEC pfnSaveExec, PFNSSMEXTSAVEDONE pfnSaveDone,
|
|---|
| 416 | PFNSSMEXTLOADPREP pfnLoadPrep, PFNSSMEXTLOADEXEC pfnLoadExec, PFNSSMEXTLOADDONE pfnLoadDone, void *pvUser);
|
|---|
| 417 | SSMR3DECL(int) SSMR3Deregister(PVM pVM, PPDMDEVINS pDevIns, const char *pszName, uint32_t u32Instance);
|
|---|
| 418 | SSMR3DECL(int) SSMR3DeregisterDriver(PVM pVM, PPDMDRVINS pDrvIns, const char *pszName, uint32_t u32Instance);
|
|---|
| 419 | SSMR3DECL(int) SSMR3DeregisterInternal(PVM pVM, const char *pszName);
|
|---|
| 420 | SSMR3DECL(int) SSMR3DeregisterExternal(PVM pVM, const char *pszName);
|
|---|
| 421 | SSMR3DECL(int) SSMR3Save(PVM pVM, const char *pszFilename, SSMAFTER enmAfter, PFNVMPROGRESS pfnProgress, void *pvUser);
|
|---|
| 422 | SSMR3DECL(int) SSMR3Load(PVM pVM, const char *pszFilename, SSMAFTER enmAfter, PFNVMPROGRESS pfnProgress, void *pvUser);
|
|---|
| 423 | SSMR3DECL(int) SSMR3ValidateFile(const char *pszFilename);
|
|---|
| 424 | SSMR3DECL(int) SSMR3Open(const char *pszFilename, unsigned fFlags, PSSMHANDLE *ppSSM);
|
|---|
| 425 | SSMR3DECL(int) SSMR3Close(PSSMHANDLE pSSM);
|
|---|
| 426 | SSMR3DECL(int) SSMR3Seek(PSSMHANDLE pSSM, const char *pszUnit, uint32_t iInstance, uint32_t *piVersion);
|
|---|
| 427 | SSMR3DECL(int) SSMR3HandleGetStatus(PSSMHANDLE pSSM);
|
|---|
| 428 | SSMR3DECL(int) SSMR3HandleSetStatus(PSSMHANDLE pSSM, int iStatus);
|
|---|
| 429 | SSMR3DECL(SSMAFTER) SSMR3HandleGetAfter(PSSMHANDLE pSSM);
|
|---|
| 430 |
|
|---|
| 431 |
|
|---|
| 432 | /** Save operations.
|
|---|
| 433 | * @{
|
|---|
| 434 | */
|
|---|
| 435 | SSMR3DECL(int) SSMR3PutStruct(PSSMHANDLE pSSM, const void *pvStruct, PCSSMFIELD paFields);
|
|---|
| 436 | SSMR3DECL(int) SSMR3PutBool(PSSMHANDLE pSSM, bool fBool);
|
|---|
| 437 | SSMR3DECL(int) SSMR3PutU8(PSSMHANDLE pSSM, uint8_t u8);
|
|---|
| 438 | SSMR3DECL(int) SSMR3PutS8(PSSMHANDLE pSSM, int8_t i8);
|
|---|
| 439 | SSMR3DECL(int) SSMR3PutU16(PSSMHANDLE pSSM, uint16_t u16);
|
|---|
| 440 | SSMR3DECL(int) SSMR3PutS16(PSSMHANDLE pSSM, int16_t i16);
|
|---|
| 441 | SSMR3DECL(int) SSMR3PutU32(PSSMHANDLE pSSM, uint32_t u32);
|
|---|
| 442 | SSMR3DECL(int) SSMR3PutS32(PSSMHANDLE pSSM, int32_t i32);
|
|---|
| 443 | SSMR3DECL(int) SSMR3PutU64(PSSMHANDLE pSSM, uint64_t u64);
|
|---|
| 444 | SSMR3DECL(int) SSMR3PutS64(PSSMHANDLE pSSM, int64_t i64);
|
|---|
| 445 | SSMR3DECL(int) SSMR3PutU128(PSSMHANDLE pSSM, uint128_t u128);
|
|---|
| 446 | SSMR3DECL(int) SSMR3PutS128(PSSMHANDLE pSSM, int128_t i128);
|
|---|
| 447 | SSMR3DECL(int) SSMR3PutUInt(PSSMHANDLE pSSM, RTUINT u);
|
|---|
| 448 | SSMR3DECL(int) SSMR3PutSInt(PSSMHANDLE pSSM, RTINT i);
|
|---|
| 449 | SSMR3DECL(int) SSMR3PutGCUInt(PSSMHANDLE pSSM, RTGCUINT u);
|
|---|
| 450 | SSMR3DECL(int) SSMR3PutGCSInt(PSSMHANDLE pSSM, RTGCINT i);
|
|---|
| 451 | SSMR3DECL(int) SSMR3PutGCPhys32(PSSMHANDLE pSSM, RTGCPHYS32 GCPhys);
|
|---|
| 452 | SSMR3DECL(int) SSMR3PutGCPhys64(PSSMHANDLE pSSM, RTGCPHYS64 GCPhys);
|
|---|
| 453 | SSMR3DECL(int) SSMR3PutGCPhys(PSSMHANDLE pSSM, RTGCPHYS GCPhys);
|
|---|
| 454 | SSMR3DECL(int) SSMR3PutGCPtr(PSSMHANDLE pSSM, RTGCPTR GCPtr);
|
|---|
| 455 | SSMR3DECL(int) SSMR3PutGCUIntPtr(PSSMHANDLE pSSM, RTGCUINTPTR GCPtr);
|
|---|
| 456 | SSMR3DECL(int) SSMR3PutHCUInt(PSSMHANDLE pSSM, RTHCUINT u);
|
|---|
| 457 | SSMR3DECL(int) SSMR3PutHCSInt(PSSMHANDLE pSSM, RTHCINT i);
|
|---|
| 458 | SSMR3DECL(int) SSMR3PutIOPort(PSSMHANDLE pSSM, RTIOPORT IOPort);
|
|---|
| 459 | SSMR3DECL(int) SSMR3PutSel(PSSMHANDLE pSSM, RTSEL Sel);
|
|---|
| 460 | SSMR3DECL(int) SSMR3PutMem(PSSMHANDLE pSSM, const void *pv, size_t cb);
|
|---|
| 461 | SSMR3DECL(int) SSMR3PutStrZ(PSSMHANDLE pSSM, const char *psz);
|
|---|
| 462 | /** @} */
|
|---|
| 463 |
|
|---|
| 464 |
|
|---|
| 465 |
|
|---|
| 466 | /** Load operations.
|
|---|
| 467 | * @{
|
|---|
| 468 | */
|
|---|
| 469 | SSMR3DECL(int) SSMR3GetStruct(PSSMHANDLE pSSM, void *pvStruct, PCSSMFIELD paFields);
|
|---|
| 470 | SSMR3DECL(int) SSMR3GetBool(PSSMHANDLE pSSM, bool *pfBool);
|
|---|
| 471 | SSMR3DECL(int) SSMR3GetU8(PSSMHANDLE pSSM, uint8_t *pu8);
|
|---|
| 472 | SSMR3DECL(int) SSMR3GetS8(PSSMHANDLE pSSM, int8_t *pi8);
|
|---|
| 473 | SSMR3DECL(int) SSMR3GetU16(PSSMHANDLE pSSM, uint16_t *pu16);
|
|---|
| 474 | SSMR3DECL(int) SSMR3GetS16(PSSMHANDLE pSSM, int16_t *pi16);
|
|---|
| 475 | SSMR3DECL(int) SSMR3GetU32(PSSMHANDLE pSSM, uint32_t *pu32);
|
|---|
| 476 | SSMR3DECL(int) SSMR3GetS32(PSSMHANDLE pSSM, int32_t *pi32);
|
|---|
| 477 | SSMR3DECL(int) SSMR3GetU64(PSSMHANDLE pSSM, uint64_t *pu64);
|
|---|
| 478 | SSMR3DECL(int) SSMR3GetS64(PSSMHANDLE pSSM, int64_t *pi64);
|
|---|
| 479 | SSMR3DECL(int) SSMR3GetU128(PSSMHANDLE pSSM, uint128_t *pu128);
|
|---|
| 480 | SSMR3DECL(int) SSMR3GetS128(PSSMHANDLE pSSM, int128_t *pi128);
|
|---|
| 481 | SSMR3DECL(int) SSMR3GetUInt(PSSMHANDLE pSSM, PRTUINT pu);
|
|---|
| 482 | SSMR3DECL(int) SSMR3GetSInt(PSSMHANDLE pSSM, PRTINT pi);
|
|---|
| 483 | SSMR3DECL(int) SSMR3GetGCUInt(PSSMHANDLE pSSM, PRTGCUINT pu);
|
|---|
| 484 | SSMR3DECL(int) SSMR3GetGCSInt(PSSMHANDLE pSSM, PRTGCINT pi);
|
|---|
| 485 | SSMR3DECL(int) SSMR3GetGCPhys32(PSSMHANDLE pSSM, PRTGCPHYS32 pGCPhys);
|
|---|
| 486 | SSMR3DECL(int) SSMR3GetGCPhys64(PSSMHANDLE pSSM, PRTGCPHYS64 pGCPhys);
|
|---|
| 487 | SSMR3DECL(int) SSMR3GetGCPhys(PSSMHANDLE pSSM, PRTGCPHYS pGCPhys);
|
|---|
| 488 | SSMR3DECL(int) SSMR3GetGCPtr(PSSMHANDLE pSSM, PRTGCPTR pGCPtr);
|
|---|
| 489 | SSMR3DECL(int) SSMR3GetGCUIntPtr(PSSMHANDLE pSSM, PRTGCUINTPTR pGCPtr);
|
|---|
| 490 | SSMR3DECL(int) SSMR3GetIOPort(PSSMHANDLE pSSM, PRTIOPORT pIOPort);
|
|---|
| 491 | SSMR3DECL(int) SSMR3GetHCUInt(PSSMHANDLE pSSM, PRTHCUINT pu);
|
|---|
| 492 | SSMR3DECL(int) SSMR3GetHCSInt(PSSMHANDLE pSSM, PRTHCINT pi);
|
|---|
| 493 | SSMR3DECL(int) SSMR3GetSel(PSSMHANDLE pSSM, PRTSEL pSel);
|
|---|
| 494 | SSMR3DECL(int) SSMR3GetMem(PSSMHANDLE pSSM, void *pv, size_t cb);
|
|---|
| 495 | SSMR3DECL(int) SSMR3GetStrZ(PSSMHANDLE pSSM, char *psz, size_t cbMax);
|
|---|
| 496 | SSMR3DECL(int) SSMR3GetStrZEx(PSSMHANDLE pSSM, char *psz, size_t cbMax, size_t *pcbStr);
|
|---|
| 497 | SSMR3DECL(int) SSMR3GetTimer(PSSMHANDLE pSSM, PTMTIMER pTimer);
|
|---|
| 498 |
|
|---|
| 499 | /** @} */
|
|---|
| 500 |
|
|---|
| 501 | /** @} */
|
|---|
| 502 | #endif /* IN_RING3 */
|
|---|
| 503 |
|
|---|
| 504 |
|
|---|
| 505 | /** @} */
|
|---|
| 506 |
|
|---|
| 507 | __END_DECLS
|
|---|
| 508 |
|
|---|
| 509 | #endif
|
|---|
| 510 |
|
|---|
