diff options
Diffstat (limited to 'include/migration')
| -rw-r--r-- | include/migration/block.h | 23 | ||||
| -rw-r--r-- | include/migration/migration.h | 207 | ||||
| -rw-r--r-- | include/migration/page_cache.h | 86 | ||||
| -rw-r--r-- | include/migration/qemu-file.h | 322 | ||||
| -rw-r--r-- | include/migration/vmstate.h | 853 | 
5 files changed, 1491 insertions, 0 deletions
diff --git a/include/migration/block.h b/include/migration/block.h new file mode 100644 index 00000000..ffa8ac0b --- /dev/null +++ b/include/migration/block.h @@ -0,0 +1,23 @@ +/* + * QEMU live block migration + * + * Copyright IBM, Corp. 2009 + * + * Authors: + *  Liran Schour   <lirans@il.ibm.com> + * + * This work is licensed under the terms of the GNU GPL, version 2.  See + * the COPYING file in the top-level directory. + * + */ + +#ifndef BLOCK_MIGRATION_H +#define BLOCK_MIGRATION_H + +void blk_mig_init(void); +int blk_mig_active(void); +uint64_t blk_mig_bytes_transferred(void); +uint64_t blk_mig_bytes_remaining(void); +uint64_t blk_mig_bytes_total(void); + +#endif /* BLOCK_MIGRATION_H */ diff --git a/include/migration/migration.h b/include/migration/migration.h new file mode 100644 index 00000000..83346210 --- /dev/null +++ b/include/migration/migration.h @@ -0,0 +1,207 @@ +/* + * QEMU live migration + * + * Copyright IBM, Corp. 2008 + * + * Authors: + *  Anthony Liguori   <aliguori@us.ibm.com> + * + * This work is licensed under the terms of the GNU GPL, version 2.  See + * the COPYING file in the top-level directory. + * + */ + +#ifndef QEMU_MIGRATION_H +#define QEMU_MIGRATION_H + +#include "qapi/qmp/qdict.h" +#include "qemu-common.h" +#include "qemu/thread.h" +#include "qemu/notify.h" +#include "qapi/error.h" +#include "migration/vmstate.h" +#include "qapi-types.h" +#include "exec/cpu-common.h" + +#define QEMU_VM_FILE_MAGIC           0x5145564d +#define QEMU_VM_FILE_VERSION_COMPAT  0x00000002 +#define QEMU_VM_FILE_VERSION         0x00000003 + +#define QEMU_VM_EOF                  0x00 +#define QEMU_VM_SECTION_START        0x01 +#define QEMU_VM_SECTION_PART         0x02 +#define QEMU_VM_SECTION_END          0x03 +#define QEMU_VM_SECTION_FULL         0x04 +#define QEMU_VM_SUBSECTION           0x05 +#define QEMU_VM_VMDESCRIPTION        0x06 +#define QEMU_VM_CONFIGURATION        0x07 +#define QEMU_VM_SECTION_FOOTER       0x7e + +struct MigrationParams { +    bool blk; +    bool shared; +}; + +typedef struct MigrationState MigrationState; + +typedef QLIST_HEAD(, LoadStateEntry) LoadStateEntry_Head; + +/* State for the incoming migration */ +struct MigrationIncomingState { +    QEMUFile *file; + +    /* See savevm.c */ +    LoadStateEntry_Head loadvm_handlers; +}; + +MigrationIncomingState *migration_incoming_get_current(void); +MigrationIncomingState *migration_incoming_state_new(QEMUFile *f); +void migration_incoming_state_destroy(void); + +struct MigrationState +{ +    int64_t bandwidth_limit; +    size_t bytes_xfer; +    size_t xfer_limit; +    QemuThread thread; +    QEMUBH *cleanup_bh; +    QEMUFile *file; +    int parameters[MIGRATION_PARAMETER_MAX]; + +    int state; +    MigrationParams params; +    double mbps; +    int64_t total_time; +    int64_t downtime; +    int64_t expected_downtime; +    int64_t dirty_pages_rate; +    int64_t dirty_bytes_rate; +    bool enabled_capabilities[MIGRATION_CAPABILITY_MAX]; +    int64_t xbzrle_cache_size; +    int64_t setup_time; +    int64_t dirty_sync_count; +}; + +void process_incoming_migration(QEMUFile *f); + +void qemu_start_incoming_migration(const char *uri, Error **errp); + +uint64_t migrate_max_downtime(void); + +void exec_start_incoming_migration(const char *host_port, Error **errp); + +void exec_start_outgoing_migration(MigrationState *s, const char *host_port, Error **errp); + +void tcp_start_incoming_migration(const char *host_port, Error **errp); + +void tcp_start_outgoing_migration(MigrationState *s, const char *host_port, Error **errp); + +void unix_start_incoming_migration(const char *path, Error **errp); + +void unix_start_outgoing_migration(MigrationState *s, const char *path, Error **errp); + +void fd_start_incoming_migration(const char *path, Error **errp); + +void fd_start_outgoing_migration(MigrationState *s, const char *fdname, Error **errp); + +void rdma_start_outgoing_migration(void *opaque, const char *host_port, Error **errp); + +void rdma_start_incoming_migration(const char *host_port, Error **errp); + +void migrate_fd_error(MigrationState *s); + +void migrate_fd_connect(MigrationState *s); + +int migrate_fd_close(MigrationState *s); + +void add_migration_state_change_notifier(Notifier *notify); +void remove_migration_state_change_notifier(Notifier *notify); +bool migration_in_setup(MigrationState *); +bool migration_has_finished(MigrationState *); +bool migration_has_failed(MigrationState *); +MigrationState *migrate_get_current(void); + +void migrate_compress_threads_create(void); +void migrate_compress_threads_join(void); +void migrate_decompress_threads_create(void); +void migrate_decompress_threads_join(void); +uint64_t ram_bytes_remaining(void); +uint64_t ram_bytes_transferred(void); +uint64_t ram_bytes_total(void); +void free_xbzrle_decoded_buf(void); + +void acct_update_position(QEMUFile *f, size_t size, bool zero); + +uint64_t dup_mig_bytes_transferred(void); +uint64_t dup_mig_pages_transferred(void); +uint64_t skipped_mig_bytes_transferred(void); +uint64_t skipped_mig_pages_transferred(void); +uint64_t norm_mig_bytes_transferred(void); +uint64_t norm_mig_pages_transferred(void); +uint64_t xbzrle_mig_bytes_transferred(void); +uint64_t xbzrle_mig_pages_transferred(void); +uint64_t xbzrle_mig_pages_overflow(void); +uint64_t xbzrle_mig_pages_cache_miss(void); +double xbzrle_mig_cache_miss_rate(void); + +void ram_handle_compressed(void *host, uint8_t ch, uint64_t size); + +/** + * @migrate_add_blocker - prevent migration from proceeding + * + * @reason - an error to be returned whenever migration is attempted + */ +void migrate_add_blocker(Error *reason); + +/** + * @migrate_del_blocker - remove a blocking error from migration + * + * @reason - the error blocking migration + */ +void migrate_del_blocker(Error *reason); + +bool migrate_zero_blocks(void); + +bool migrate_auto_converge(void); + +int xbzrle_encode_buffer(uint8_t *old_buf, uint8_t *new_buf, int slen, +                         uint8_t *dst, int dlen); +int xbzrle_decode_buffer(uint8_t *src, int slen, uint8_t *dst, int dlen); + +int migrate_use_xbzrle(void); +int64_t migrate_xbzrle_cache_size(void); + +int64_t xbzrle_cache_resize(int64_t new_size); + +bool migrate_use_compression(void); +int migrate_compress_level(void); +int migrate_compress_threads(void); +int migrate_decompress_threads(void); +bool migrate_use_events(void); + +void ram_control_before_iterate(QEMUFile *f, uint64_t flags); +void ram_control_after_iterate(QEMUFile *f, uint64_t flags); +void ram_control_load_hook(QEMUFile *f, uint64_t flags, void *data); + +/* Whenever this is found in the data stream, the flags + * will be passed to ram_control_load_hook in the incoming-migration + * side. This lets before_ram_iterate/after_ram_iterate add + * transport-specific sections to the RAM migration data. + */ +#define RAM_SAVE_FLAG_HOOK     0x80 + +#define RAM_SAVE_CONTROL_NOT_SUPP -1000 +#define RAM_SAVE_CONTROL_DELAYED  -2000 + +size_t ram_control_save_page(QEMUFile *f, ram_addr_t block_offset, +                             ram_addr_t offset, size_t size, +                             uint64_t *bytes_sent); + +void ram_mig_init(void); +void savevm_skip_section_footers(void); +void register_global_state(void); +void global_state_set_optional(void); +void savevm_skip_configuration(void); +int global_state_store(void); +void global_state_store_running(void); +#endif diff --git a/include/migration/page_cache.h b/include/migration/page_cache.h new file mode 100644 index 00000000..10ed5327 --- /dev/null +++ b/include/migration/page_cache.h @@ -0,0 +1,86 @@ +/* + * Page cache for QEMU + * The cache is base on a hash of the page address + * + * Copyright 2012 Red Hat, Inc. and/or its affiliates + * + * Authors: + *  Orit Wasserman  <owasserm@redhat.com> + * + * This work is licensed under the terms of the GNU GPL, version 2 or later. + * See the COPYING file in the top-level directory. + * + */ + +#ifndef PAGE_CACHE_H +#define PAGE_CACHE_H + +/* Page cache for storing guest pages */ +typedef struct PageCache PageCache; + +/** + * cache_init: Initialize the page cache + * + * + * Returns new allocated cache or NULL on error + * + * @cache pointer to the PageCache struct + * @num_pages: cache maximal number of cached pages + * @page_size: cache page size + */ +PageCache *cache_init(int64_t num_pages, unsigned int page_size); + +/** + * cache_fini: free all cache resources + * @cache pointer to the PageCache struct + */ +void cache_fini(PageCache *cache); + +/** + * cache_is_cached: Checks to see if the page is cached + * + * Returns %true if page is cached + * + * @cache pointer to the PageCache struct + * @addr: page addr + * @current_age: current bitmap generation + */ +bool cache_is_cached(const PageCache *cache, uint64_t addr, +                     uint64_t current_age); + +/** + * get_cached_data: Get the data cached for an addr + * + * Returns pointer to the data cached or NULL if not cached + * + * @cache pointer to the PageCache struct + * @addr: page addr + */ +uint8_t *get_cached_data(const PageCache *cache, uint64_t addr); + +/** + * cache_insert: insert the page into the cache. the page cache + * will dup the data on insert. the previous value will be overwritten + * + * Returns -1 when the page isn't inserted into cache + * + * @cache pointer to the PageCache struct + * @addr: page address + * @pdata: pointer to the page + * @current_age: current bitmap generation + */ +int cache_insert(PageCache *cache, uint64_t addr, const uint8_t *pdata, +                 uint64_t current_age); + +/** + * cache_resize: resize the page cache. In case of size reduction the extra + * pages will be freed + * + * Returns -1 on error new cache size on success + * + * @cache pointer to the PageCache struct + * @num_pages: new page cache size (in pages) + */ +int64_t cache_resize(PageCache *cache, int64_t num_pages); + +#endif diff --git a/include/migration/qemu-file.h b/include/migration/qemu-file.h new file mode 100644 index 00000000..ea49f33f --- /dev/null +++ b/include/migration/qemu-file.h @@ -0,0 +1,322 @@ +/* + * QEMU System Emulator + * + * Copyright (c) 2003-2008 Fabrice Bellard + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ +#ifndef QEMU_FILE_H +#define QEMU_FILE_H 1 +#include "exec/cpu-common.h" + +#include <stdint.h> + +/* This function writes a chunk of data to a file at the given position. + * The pos argument can be ignored if the file is only being used for + * streaming.  The handler should try to write all of the data it can. + */ +typedef int (QEMUFilePutBufferFunc)(void *opaque, const uint8_t *buf, +                                    int64_t pos, int size); + +/* Read a chunk of data from a file at the given position.  The pos argument + * can be ignored if the file is only be used for streaming.  The number of + * bytes actually read should be returned. + */ +typedef int (QEMUFileGetBufferFunc)(void *opaque, uint8_t *buf, +                                    int64_t pos, int size); + +/* Close a file + * + * Return negative error number on error, 0 or positive value on success. + * + * The meaning of return value on success depends on the specific back-end being + * used. + */ +typedef int (QEMUFileCloseFunc)(void *opaque); + +/* Called to return the OS file descriptor associated to the QEMUFile. + */ +typedef int (QEMUFileGetFD)(void *opaque); + +/* + * This function writes an iovec to file. + */ +typedef ssize_t (QEMUFileWritevBufferFunc)(void *opaque, struct iovec *iov, +                                           int iovcnt, int64_t pos); + +/* + * This function provides hooks around different + * stages of RAM migration. + * 'opaque' is the backend specific data in QEMUFile + * 'data' is call specific data associated with the 'flags' value + */ +typedef int (QEMURamHookFunc)(QEMUFile *f, void *opaque, uint64_t flags, +                              void *data); + +/* + * Constants used by ram_control_* hooks + */ +#define RAM_CONTROL_SETUP     0 +#define RAM_CONTROL_ROUND     1 +#define RAM_CONTROL_HOOK      2 +#define RAM_CONTROL_FINISH    3 +#define RAM_CONTROL_BLOCK_REG 4 + +/* + * This function allows override of where the RAM page + * is saved (such as RDMA, for example.) + */ +typedef size_t (QEMURamSaveFunc)(QEMUFile *f, void *opaque, +                               ram_addr_t block_offset, +                               ram_addr_t offset, +                               size_t size, +                               uint64_t *bytes_sent); + +/* + * Stop any read or write (depending on flags) on the underlying + * transport on the QEMUFile. + * Existing blocking reads/writes must be woken + * Returns 0 on success, -err on error + */ +typedef int (QEMUFileShutdownFunc)(void *opaque, bool rd, bool wr); + +typedef struct QEMUFileOps { +    QEMUFilePutBufferFunc *put_buffer; +    QEMUFileGetBufferFunc *get_buffer; +    QEMUFileCloseFunc *close; +    QEMUFileGetFD *get_fd; +    QEMUFileWritevBufferFunc *writev_buffer; +    QEMURamHookFunc *before_ram_iterate; +    QEMURamHookFunc *after_ram_iterate; +    QEMURamHookFunc *hook_ram_load; +    QEMURamSaveFunc *save_page; +    QEMUFileShutdownFunc *shut_down; +} QEMUFileOps; + +struct QEMUSizedBuffer { +    struct iovec *iov; +    size_t n_iov; +    size_t size; /* total allocated size in all iov's */ +    size_t used; /* number of used bytes */ +}; + +QEMUFile *qemu_fopen_ops(void *opaque, const QEMUFileOps *ops); +QEMUFile *qemu_fopen(const char *filename, const char *mode); +QEMUFile *qemu_fdopen(int fd, const char *mode); +QEMUFile *qemu_fopen_socket(int fd, const char *mode); +QEMUFile *qemu_popen_cmd(const char *command, const char *mode); +QEMUFile *qemu_bufopen(const char *mode, QEMUSizedBuffer *input); +int qemu_get_fd(QEMUFile *f); +int qemu_fclose(QEMUFile *f); +int64_t qemu_ftell(QEMUFile *f); +int64_t qemu_ftell_fast(QEMUFile *f); +void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size); +void qemu_put_byte(QEMUFile *f, int v); +/* + * put_buffer without copying the buffer. + * The buffer should be available till it is sent asynchronously. + */ +void qemu_put_buffer_async(QEMUFile *f, const uint8_t *buf, int size); +bool qemu_file_mode_is_not_valid(const char *mode); +bool qemu_file_is_writable(QEMUFile *f); + +QEMUSizedBuffer *qsb_create(const uint8_t *buffer, size_t len); +void qsb_free(QEMUSizedBuffer *); +size_t qsb_set_length(QEMUSizedBuffer *qsb, size_t length); +size_t qsb_get_length(const QEMUSizedBuffer *qsb); +ssize_t qsb_get_buffer(const QEMUSizedBuffer *, off_t start, size_t count, +                       uint8_t *buf); +ssize_t qsb_write_at(QEMUSizedBuffer *qsb, const uint8_t *buf, +                     off_t pos, size_t count); + + +/* + * For use on files opened with qemu_bufopen + */ +const QEMUSizedBuffer *qemu_buf_get(QEMUFile *f); + +static inline void qemu_put_ubyte(QEMUFile *f, unsigned int v) +{ +    qemu_put_byte(f, (int)v); +} + +#define qemu_put_sbyte qemu_put_byte + +void qemu_put_be16(QEMUFile *f, unsigned int v); +void qemu_put_be32(QEMUFile *f, unsigned int v); +void qemu_put_be64(QEMUFile *f, uint64_t v); +int qemu_peek_buffer(QEMUFile *f, uint8_t **buf, int size, size_t offset); +int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size); +ssize_t qemu_put_compression_data(QEMUFile *f, const uint8_t *p, size_t size, +                                  int level); +int qemu_put_qemu_file(QEMUFile *f_des, QEMUFile *f_src); +/* + * Note that you can only peek continuous bytes from where the current pointer + * is; you aren't guaranteed to be able to peak to +n bytes unless you've + * previously peeked +n-1. + */ +int qemu_peek_byte(QEMUFile *f, int offset); +int qemu_get_byte(QEMUFile *f); +void qemu_file_skip(QEMUFile *f, int size); +void qemu_update_position(QEMUFile *f, size_t size); + +static inline unsigned int qemu_get_ubyte(QEMUFile *f) +{ +    return (unsigned int)qemu_get_byte(f); +} + +#define qemu_get_sbyte qemu_get_byte + +unsigned int qemu_get_be16(QEMUFile *f); +unsigned int qemu_get_be32(QEMUFile *f); +uint64_t qemu_get_be64(QEMUFile *f); + +int qemu_file_rate_limit(QEMUFile *f); +void qemu_file_reset_rate_limit(QEMUFile *f); +void qemu_file_set_rate_limit(QEMUFile *f, int64_t new_rate); +int64_t qemu_file_get_rate_limit(QEMUFile *f); +int qemu_file_get_error(QEMUFile *f); +void qemu_file_set_error(QEMUFile *f, int ret); +int qemu_file_shutdown(QEMUFile *f); +void qemu_fflush(QEMUFile *f); + +static inline void qemu_put_be64s(QEMUFile *f, const uint64_t *pv) +{ +    qemu_put_be64(f, *pv); +} + +static inline void qemu_put_be32s(QEMUFile *f, const uint32_t *pv) +{ +    qemu_put_be32(f, *pv); +} + +static inline void qemu_put_be16s(QEMUFile *f, const uint16_t *pv) +{ +    qemu_put_be16(f, *pv); +} + +static inline void qemu_put_8s(QEMUFile *f, const uint8_t *pv) +{ +    qemu_put_byte(f, *pv); +} + +static inline void qemu_get_be64s(QEMUFile *f, uint64_t *pv) +{ +    *pv = qemu_get_be64(f); +} + +static inline void qemu_get_be32s(QEMUFile *f, uint32_t *pv) +{ +    *pv = qemu_get_be32(f); +} + +static inline void qemu_get_be16s(QEMUFile *f, uint16_t *pv) +{ +    *pv = qemu_get_be16(f); +} + +static inline void qemu_get_8s(QEMUFile *f, uint8_t *pv) +{ +    *pv = qemu_get_byte(f); +} + +// Signed versions for type safety +static inline void qemu_put_sbuffer(QEMUFile *f, const int8_t *buf, int size) +{ +    qemu_put_buffer(f, (const uint8_t *)buf, size); +} + +static inline void qemu_put_sbe16(QEMUFile *f, int v) +{ +    qemu_put_be16(f, (unsigned int)v); +} + +static inline void qemu_put_sbe32(QEMUFile *f, int v) +{ +    qemu_put_be32(f, (unsigned int)v); +} + +static inline void qemu_put_sbe64(QEMUFile *f, int64_t v) +{ +    qemu_put_be64(f, (uint64_t)v); +} + +static inline size_t qemu_get_sbuffer(QEMUFile *f, int8_t *buf, int size) +{ +    return qemu_get_buffer(f, (uint8_t *)buf, size); +} + +static inline int qemu_get_sbe16(QEMUFile *f) +{ +    return (int)qemu_get_be16(f); +} + +static inline int qemu_get_sbe32(QEMUFile *f) +{ +    return (int)qemu_get_be32(f); +} + +static inline int64_t qemu_get_sbe64(QEMUFile *f) +{ +    return (int64_t)qemu_get_be64(f); +} + +static inline void qemu_put_s8s(QEMUFile *f, const int8_t *pv) +{ +    qemu_put_8s(f, (const uint8_t *)pv); +} + +static inline void qemu_put_sbe16s(QEMUFile *f, const int16_t *pv) +{ +    qemu_put_be16s(f, (const uint16_t *)pv); +} + +static inline void qemu_put_sbe32s(QEMUFile *f, const int32_t *pv) +{ +    qemu_put_be32s(f, (const uint32_t *)pv); +} + +static inline void qemu_put_sbe64s(QEMUFile *f, const int64_t *pv) +{ +    qemu_put_be64s(f, (const uint64_t *)pv); +} + +static inline void qemu_get_s8s(QEMUFile *f, int8_t *pv) +{ +    qemu_get_8s(f, (uint8_t *)pv); +} + +static inline void qemu_get_sbe16s(QEMUFile *f, int16_t *pv) +{ +    qemu_get_be16s(f, (uint16_t *)pv); +} + +static inline void qemu_get_sbe32s(QEMUFile *f, int32_t *pv) +{ +    qemu_get_be32s(f, (uint32_t *)pv); +} + +static inline void qemu_get_sbe64s(QEMUFile *f, int64_t *pv) +{ +    qemu_get_be64s(f, (uint64_t *)pv); +} + +size_t qemu_get_counted_string(QEMUFile *f, char buf[256]); + +#endif diff --git a/include/migration/vmstate.h b/include/migration/vmstate.h new file mode 100644 index 00000000..2e5a97de --- /dev/null +++ b/include/migration/vmstate.h @@ -0,0 +1,853 @@ +/* + * QEMU migration/snapshot declarations + * + * Copyright (c) 2009-2011 Red Hat, Inc. + * + * Original author: Juan Quintela <quintela@redhat.com> + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ +#ifndef QEMU_VMSTATE_H +#define QEMU_VMSTATE_H 1 + +#ifndef CONFIG_USER_ONLY +#include <migration/qemu-file.h> +#endif +#include <qjson.h> + +typedef void SaveStateHandler(QEMUFile *f, void *opaque); +typedef int LoadStateHandler(QEMUFile *f, void *opaque, int version_id); + +typedef struct SaveVMHandlers { +    /* This runs inside the iothread lock.  */ +    void (*set_params)(const MigrationParams *params, void * opaque); +    SaveStateHandler *save_state; + +    void (*cancel)(void *opaque); +    int (*save_live_complete)(QEMUFile *f, void *opaque); + +    /* This runs both outside and inside the iothread lock.  */ +    bool (*is_active)(void *opaque); + +    /* This runs outside the iothread lock in the migration case, and +     * within the lock in the savevm case.  The callback had better only +     * use data that is local to the migration thread or protected +     * by other locks. +     */ +    int (*save_live_iterate)(QEMUFile *f, void *opaque); + +    /* This runs outside the iothread lock!  */ +    int (*save_live_setup)(QEMUFile *f, void *opaque); +    uint64_t (*save_live_pending)(QEMUFile *f, void *opaque, uint64_t max_size); + +    LoadStateHandler *load_state; +} SaveVMHandlers; + +int register_savevm(DeviceState *dev, +                    const char *idstr, +                    int instance_id, +                    int version_id, +                    SaveStateHandler *save_state, +                    LoadStateHandler *load_state, +                    void *opaque); + +int register_savevm_live(DeviceState *dev, +                         const char *idstr, +                         int instance_id, +                         int version_id, +                         SaveVMHandlers *ops, +                         void *opaque); + +void unregister_savevm(DeviceState *dev, const char *idstr, void *opaque); + +typedef struct VMStateInfo VMStateInfo; +typedef struct VMStateDescription VMStateDescription; + +struct VMStateInfo { +    const char *name; +    int (*get)(QEMUFile *f, void *pv, size_t size); +    void (*put)(QEMUFile *f, void *pv, size_t size); +}; + +enum VMStateFlags { +    VMS_SINGLE           = 0x001, +    VMS_POINTER          = 0x002, +    VMS_ARRAY            = 0x004, +    VMS_STRUCT           = 0x008, +    VMS_VARRAY_INT32     = 0x010,  /* Array with size in int32_t field*/ +    VMS_BUFFER           = 0x020,  /* static sized buffer */ +    VMS_ARRAY_OF_POINTER = 0x040, +    VMS_VARRAY_UINT16    = 0x080,  /* Array with size in uint16_t field */ +    VMS_VBUFFER          = 0x100,  /* Buffer with size in int32_t field */ +    VMS_MULTIPLY         = 0x200,  /* multiply "size" field by field_size */ +    VMS_VARRAY_UINT8     = 0x400,  /* Array with size in uint8_t field*/ +    VMS_VARRAY_UINT32    = 0x800,  /* Array with size in uint32_t field*/ +    VMS_MUST_EXIST       = 0x1000, /* Field must exist in input */ +    VMS_ALLOC            = 0x2000, /* Alloc a buffer on the destination */ +}; + +typedef struct { +    const char *name; +    size_t offset; +    size_t size; +    size_t start; +    int num; +    size_t num_offset; +    size_t size_offset; +    const VMStateInfo *info; +    enum VMStateFlags flags; +    const VMStateDescription *vmsd; +    int version_id; +    bool (*field_exists)(void *opaque, int version_id); +} VMStateField; + +struct VMStateDescription { +    const char *name; +    int unmigratable; +    int version_id; +    int minimum_version_id; +    int minimum_version_id_old; +    LoadStateHandler *load_state_old; +    int (*pre_load)(void *opaque); +    int (*post_load)(void *opaque, int version_id); +    void (*pre_save)(void *opaque); +    bool (*needed)(void *opaque); +    VMStateField *fields; +    const VMStateDescription **subsections; +}; + +extern const VMStateDescription vmstate_dummy; + +extern const VMStateInfo vmstate_info_bool; + +extern const VMStateInfo vmstate_info_int8; +extern const VMStateInfo vmstate_info_int16; +extern const VMStateInfo vmstate_info_int32; +extern const VMStateInfo vmstate_info_int64; + +extern const VMStateInfo vmstate_info_uint8_equal; +extern const VMStateInfo vmstate_info_uint16_equal; +extern const VMStateInfo vmstate_info_int32_equal; +extern const VMStateInfo vmstate_info_uint32_equal; +extern const VMStateInfo vmstate_info_uint64_equal; +extern const VMStateInfo vmstate_info_int32_le; + +extern const VMStateInfo vmstate_info_uint8; +extern const VMStateInfo vmstate_info_uint16; +extern const VMStateInfo vmstate_info_uint32; +extern const VMStateInfo vmstate_info_uint64; + +extern const VMStateInfo vmstate_info_float64; + +extern const VMStateInfo vmstate_info_timer; +extern const VMStateInfo vmstate_info_buffer; +extern const VMStateInfo vmstate_info_unused_buffer; +extern const VMStateInfo vmstate_info_bitmap; + +#define type_check_2darray(t1,t2,n,m) ((t1(*)[n][m])0 - (t2*)0) +#define type_check_array(t1,t2,n) ((t1(*)[n])0 - (t2*)0) +#define type_check_pointer(t1,t2) ((t1**)0 - (t2*)0) + +#define vmstate_offset_value(_state, _field, _type)                  \ +    (offsetof(_state, _field) +                                      \ +     type_check(_type, typeof_field(_state, _field))) + +#define vmstate_offset_pointer(_state, _field, _type)                \ +    (offsetof(_state, _field) +                                      \ +     type_check_pointer(_type, typeof_field(_state, _field))) + +#define vmstate_offset_array(_state, _field, _type, _num)            \ +    (offsetof(_state, _field) +                                      \ +     type_check_array(_type, typeof_field(_state, _field), _num)) + +#define vmstate_offset_2darray(_state, _field, _type, _n1, _n2)      \ +    (offsetof(_state, _field) +                                      \ +     type_check_2darray(_type, typeof_field(_state, _field), _n1, _n2)) + +#define vmstate_offset_sub_array(_state, _field, _type, _start)      \ +    vmstate_offset_value(_state, _field[_start], _type) + +#define vmstate_offset_buffer(_state, _field)                        \ +    vmstate_offset_array(_state, _field, uint8_t,                    \ +                         sizeof(typeof_field(_state, _field))) + +#define VMSTATE_SINGLE_TEST(_field, _state, _test, _version, _info, _type) { \ +    .name         = (stringify(_field)),                             \ +    .version_id   = (_version),                                      \ +    .field_exists = (_test),                                         \ +    .size         = sizeof(_type),                                   \ +    .info         = &(_info),                                        \ +    .flags        = VMS_SINGLE,                                      \ +    .offset       = vmstate_offset_value(_state, _field, _type),     \ +} + +/* Validate state using a boolean predicate. */ +#define VMSTATE_VALIDATE(_name, _test) { \ +    .name         = (_name),                                         \ +    .field_exists = (_test),                                         \ +    .flags        = VMS_ARRAY | VMS_MUST_EXIST,                      \ +    .num          = 0, /* 0 elements: no data, only run _test */     \ +} + +#define VMSTATE_POINTER(_field, _state, _version, _info, _type) {    \ +    .name       = (stringify(_field)),                               \ +    .version_id = (_version),                                        \ +    .info       = &(_info),                                          \ +    .size       = sizeof(_type),                                     \ +    .flags      = VMS_SINGLE|VMS_POINTER,                            \ +    .offset     = vmstate_offset_value(_state, _field, _type),       \ +} + +#define VMSTATE_POINTER_TEST(_field, _state, _test, _info, _type) {  \ +    .name       = (stringify(_field)),                               \ +    .info       = &(_info),                                          \ +    .field_exists = (_test),                                         \ +    .size       = sizeof(_type),                                     \ +    .flags      = VMS_SINGLE|VMS_POINTER,                            \ +    .offset     = vmstate_offset_value(_state, _field, _type),       \ +} + +#define VMSTATE_ARRAY(_field, _state, _num, _version, _info, _type) {\ +    .name       = (stringify(_field)),                               \ +    .version_id = (_version),                                        \ +    .num        = (_num),                                            \ +    .info       = &(_info),                                          \ +    .size       = sizeof(_type),                                     \ +    .flags      = VMS_ARRAY,                                         \ +    .offset     = vmstate_offset_array(_state, _field, _type, _num), \ +} + +#define VMSTATE_2DARRAY(_field, _state, _n1, _n2, _version, _info, _type) { \ +    .name       = (stringify(_field)),                                      \ +    .version_id = (_version),                                               \ +    .num        = (_n1) * (_n2),                                            \ +    .info       = &(_info),                                                 \ +    .size       = sizeof(_type),                                            \ +    .flags      = VMS_ARRAY,                                                \ +    .offset     = vmstate_offset_2darray(_state, _field, _type, _n1, _n2),  \ +} + +#define VMSTATE_ARRAY_TEST(_field, _state, _num, _test, _info, _type) {\ +    .name         = (stringify(_field)),                              \ +    .field_exists = (_test),                                          \ +    .num          = (_num),                                           \ +    .info         = &(_info),                                         \ +    .size         = sizeof(_type),                                    \ +    .flags        = VMS_ARRAY,                                        \ +    .offset       = vmstate_offset_array(_state, _field, _type, _num),\ +} + +#define VMSTATE_SUB_ARRAY(_field, _state, _start, _num, _version, _info, _type) { \ +    .name       = (stringify(_field)),                               \ +    .version_id = (_version),                                        \ +    .num        = (_num),                                            \ +    .info       = &(_info),                                          \ +    .size       = sizeof(_type),                                     \ +    .flags      = VMS_ARRAY,                                         \ +    .offset     = vmstate_offset_sub_array(_state, _field, _type, _start), \ +} + +#define VMSTATE_ARRAY_INT32_UNSAFE(_field, _state, _field_num, _info, _type) {\ +    .name       = (stringify(_field)),                               \ +    .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \ +    .info       = &(_info),                                          \ +    .size       = sizeof(_type),                                     \ +    .flags      = VMS_VARRAY_INT32,                                  \ +    .offset     = offsetof(_state, _field),                          \ +} + +#define VMSTATE_VARRAY_INT32(_field, _state, _field_num, _version, _info, _type) {\ +    .name       = (stringify(_field)),                               \ +    .version_id = (_version),                                        \ +    .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \ +    .info       = &(_info),                                          \ +    .size       = sizeof(_type),                                     \ +    .flags      = VMS_VARRAY_INT32|VMS_POINTER,                      \ +    .offset     = vmstate_offset_pointer(_state, _field, _type),     \ +} + +#define VMSTATE_VARRAY_UINT32(_field, _state, _field_num, _version, _info, _type) {\ +    .name       = (stringify(_field)),                               \ +    .version_id = (_version),                                        \ +    .num_offset = vmstate_offset_value(_state, _field_num, uint32_t),\ +    .info       = &(_info),                                          \ +    .size       = sizeof(_type),                                     \ +    .flags      = VMS_VARRAY_UINT32|VMS_POINTER,                     \ +    .offset     = vmstate_offset_pointer(_state, _field, _type),     \ +} + +#define VMSTATE_VARRAY_UINT16_UNSAFE(_field, _state, _field_num, _version, _info, _type) {\ +    .name       = (stringify(_field)),                               \ +    .version_id = (_version),                                        \ +    .num_offset = vmstate_offset_value(_state, _field_num, uint16_t),\ +    .info       = &(_info),                                          \ +    .size       = sizeof(_type),                                     \ +    .flags      = VMS_VARRAY_UINT16,                                 \ +    .offset     = offsetof(_state, _field),                          \ +} + +#define VMSTATE_STRUCT_TEST(_field, _state, _test, _version, _vmsd, _type) { \ +    .name         = (stringify(_field)),                             \ +    .version_id   = (_version),                                      \ +    .field_exists = (_test),                                         \ +    .vmsd         = &(_vmsd),                                        \ +    .size         = sizeof(_type),                                   \ +    .flags        = VMS_STRUCT,                                      \ +    .offset       = vmstate_offset_value(_state, _field, _type),     \ +} + +#define VMSTATE_STRUCT_POINTER_V(_field, _state, _version, _vmsd, _type) { \ +    .name         = (stringify(_field)),                             \ +    .version_id   = (_version),                                        \ +    .vmsd         = &(_vmsd),                                        \ +    .size         = sizeof(_type *),                                 \ +    .flags        = VMS_STRUCT|VMS_POINTER,                          \ +    .offset       = vmstate_offset_pointer(_state, _field, _type),   \ +} + +#define VMSTATE_STRUCT_POINTER_TEST_V(_field, _state, _test, _version, _vmsd, _type) { \ +    .name         = (stringify(_field)),                             \ +    .version_id   = (_version),                                        \ +    .field_exists = (_test),                                         \ +    .vmsd         = &(_vmsd),                                        \ +    .size         = sizeof(_type *),                                 \ +    .flags        = VMS_STRUCT|VMS_POINTER,                          \ +    .offset       = vmstate_offset_pointer(_state, _field, _type),   \ +} + +#define VMSTATE_ARRAY_OF_POINTER(_field, _state, _num, _version, _info, _type) {\ +    .name       = (stringify(_field)),                               \ +    .version_id = (_version),                                        \ +    .num        = (_num),                                            \ +    .info       = &(_info),                                          \ +    .size       = sizeof(_type),                                     \ +    .flags      = VMS_ARRAY|VMS_ARRAY_OF_POINTER,                    \ +    .offset     = vmstate_offset_array(_state, _field, _type, _num), \ +} + +#define VMSTATE_ARRAY_OF_POINTER_TO_STRUCT(_f, _s, _n, _v, _vmsd, _type) { \ +    .name       = (stringify(_f)),                                   \ +    .version_id = (_v),                                              \ +    .num        = (_n),                                              \ +    .vmsd       = &(_vmsd),                                          \ +    .size       = sizeof(_type *),                                    \ +    .flags      = VMS_ARRAY|VMS_STRUCT|VMS_ARRAY_OF_POINTER,         \ +    .offset     = vmstate_offset_array(_s, _f, _type*, _n),          \ +} + +#define VMSTATE_STRUCT_SUB_ARRAY(_field, _state, _start, _num, _version, _vmsd, _type) { \ +    .name       = (stringify(_field)),                                     \ +    .version_id = (_version),                                              \ +    .num        = (_num),                                                  \ +    .vmsd       = &(_vmsd),                                                \ +    .size       = sizeof(_type),                                           \ +    .flags      = VMS_STRUCT|VMS_ARRAY,                                    \ +    .offset     = vmstate_offset_sub_array(_state, _field, _type, _start), \ +} + +#define VMSTATE_STRUCT_ARRAY_TEST(_field, _state, _num, _test, _version, _vmsd, _type) { \ +    .name         = (stringify(_field)),                             \ +    .num          = (_num),                                          \ +    .field_exists = (_test),                                         \ +    .version_id   = (_version),                                      \ +    .vmsd         = &(_vmsd),                                        \ +    .size         = sizeof(_type),                                   \ +    .flags        = VMS_STRUCT|VMS_ARRAY,                            \ +    .offset       = vmstate_offset_array(_state, _field, _type, _num),\ +} + +#define VMSTATE_STRUCT_VARRAY_UINT8(_field, _state, _field_num, _version, _vmsd, _type) { \ +    .name       = (stringify(_field)),                               \ +    .num_offset = vmstate_offset_value(_state, _field_num, uint8_t), \ +    .version_id = (_version),                                        \ +    .vmsd       = &(_vmsd),                                          \ +    .size       = sizeof(_type),                                     \ +    .flags      = VMS_STRUCT|VMS_VARRAY_UINT8,                       \ +    .offset     = offsetof(_state, _field),                          \ +} + +#define VMSTATE_STRUCT_VARRAY_POINTER_INT32(_field, _state, _field_num, _vmsd, _type) { \ +    .name       = (stringify(_field)),                               \ +    .version_id = 0,                                                 \ +    .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \ +    .size       = sizeof(_type),                                     \ +    .vmsd       = &(_vmsd),                                          \ +    .flags      = VMS_POINTER | VMS_VARRAY_INT32 | VMS_STRUCT,       \ +    .offset     = vmstate_offset_pointer(_state, _field, _type),     \ +} + +#define VMSTATE_STRUCT_VARRAY_POINTER_UINT32(_field, _state, _field_num, _vmsd, _type) { \ +    .name       = (stringify(_field)),                               \ +    .version_id = 0,                                                 \ +    .num_offset = vmstate_offset_value(_state, _field_num, uint32_t),\ +    .size       = sizeof(_type),                                     \ +    .vmsd       = &(_vmsd),                                          \ +    .flags      = VMS_POINTER | VMS_VARRAY_INT32 | VMS_STRUCT,       \ +    .offset     = vmstate_offset_pointer(_state, _field, _type),     \ +} + +#define VMSTATE_STRUCT_VARRAY_POINTER_UINT16(_field, _state, _field_num, _vmsd, _type) { \ +    .name       = (stringify(_field)),                               \ +    .version_id = 0,                                                 \ +    .num_offset = vmstate_offset_value(_state, _field_num, uint16_t),\ +    .size       = sizeof(_type),                                     \ +    .vmsd       = &(_vmsd),                                          \ +    .flags      = VMS_POINTER | VMS_VARRAY_UINT16 | VMS_STRUCT,      \ +    .offset     = vmstate_offset_pointer(_state, _field, _type),     \ +} + +#define VMSTATE_STRUCT_VARRAY_INT32(_field, _state, _field_num, _version, _vmsd, _type) { \ +    .name       = (stringify(_field)),                               \ +    .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \ +    .version_id = (_version),                                        \ +    .vmsd       = &(_vmsd),                                          \ +    .size       = sizeof(_type),                                     \ +    .flags      = VMS_STRUCT|VMS_VARRAY_INT32,                       \ +    .offset     = offsetof(_state, _field),                          \ +} + +#define VMSTATE_STRUCT_VARRAY_UINT32(_field, _state, _field_num, _version, _vmsd, _type) { \ +    .name       = (stringify(_field)),                               \ +    .num_offset = vmstate_offset_value(_state, _field_num, uint32_t), \ +    .version_id = (_version),                                        \ +    .vmsd       = &(_vmsd),                                          \ +    .size       = sizeof(_type),                                     \ +    .flags      = VMS_STRUCT|VMS_VARRAY_UINT32,                      \ +    .offset     = offsetof(_state, _field),                          \ +} + +#define VMSTATE_STRUCT_VARRAY_ALLOC(_field, _state, _field_num, _version, _vmsd, _type) {\ +    .name       = (stringify(_field)),                               \ +    .version_id = (_version),                                        \ +    .vmsd       = &(_vmsd),                                          \ +    .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \ +    .size       = sizeof(_type),                                     \ +    .flags      = VMS_STRUCT|VMS_VARRAY_INT32|VMS_ALLOC|VMS_POINTER, \ +    .offset     = vmstate_offset_pointer(_state, _field, _type),     \ +} + +#define VMSTATE_STATIC_BUFFER(_field, _state, _version, _test, _start, _size) { \ +    .name         = (stringify(_field)),                             \ +    .version_id   = (_version),                                      \ +    .field_exists = (_test),                                         \ +    .size         = (_size - _start),                                \ +    .info         = &vmstate_info_buffer,                            \ +    .flags        = VMS_BUFFER,                                      \ +    .offset       = vmstate_offset_buffer(_state, _field) + _start,  \ +} + +#define VMSTATE_VBUFFER_MULTIPLY(_field, _state, _version, _test, _start, _field_size, _multiply) { \ +    .name         = (stringify(_field)),                             \ +    .version_id   = (_version),                                      \ +    .field_exists = (_test),                                         \ +    .size_offset  = vmstate_offset_value(_state, _field_size, uint32_t),\ +    .size         = (_multiply),                                      \ +    .info         = &vmstate_info_buffer,                            \ +    .flags        = VMS_VBUFFER|VMS_POINTER|VMS_MULTIPLY,            \ +    .offset       = offsetof(_state, _field),                        \ +    .start        = (_start),                                        \ +} + +#define VMSTATE_VBUFFER(_field, _state, _version, _test, _start, _field_size) { \ +    .name         = (stringify(_field)),                             \ +    .version_id   = (_version),                                      \ +    .field_exists = (_test),                                         \ +    .size_offset  = vmstate_offset_value(_state, _field_size, int32_t),\ +    .info         = &vmstate_info_buffer,                            \ +    .flags        = VMS_VBUFFER|VMS_POINTER,                         \ +    .offset       = offsetof(_state, _field),                        \ +    .start        = (_start),                                        \ +} + +#define VMSTATE_VBUFFER_UINT32(_field, _state, _version, _test, _start, _field_size) { \ +    .name         = (stringify(_field)),                             \ +    .version_id   = (_version),                                      \ +    .field_exists = (_test),                                         \ +    .size_offset  = vmstate_offset_value(_state, _field_size, uint32_t),\ +    .info         = &vmstate_info_buffer,                            \ +    .flags        = VMS_VBUFFER|VMS_POINTER,                         \ +    .offset       = offsetof(_state, _field),                        \ +    .start        = (_start),                                        \ +} + +#define VMSTATE_VBUFFER_ALLOC_UINT32(_field, _state, _version, _test, _start, _field_size) { \ +    .name         = (stringify(_field)),                             \ +    .version_id   = (_version),                                      \ +    .field_exists = (_test),                                         \ +    .size_offset  = vmstate_offset_value(_state, _field_size, uint32_t),\ +    .info         = &vmstate_info_buffer,                            \ +    .flags        = VMS_VBUFFER|VMS_POINTER|VMS_ALLOC,               \ +    .offset       = offsetof(_state, _field),                        \ +    .start        = (_start),                                        \ +} + +#define VMSTATE_BUFFER_UNSAFE_INFO_TEST(_field, _state, _test, _version, _info, _size) { \ +    .name       = (stringify(_field)),                               \ +    .version_id = (_version),                                        \ +    .field_exists = (_test),                                         \ +    .size       = (_size),                                           \ +    .info       = &(_info),                                          \ +    .flags      = VMS_BUFFER,                                        \ +    .offset     = offsetof(_state, _field),                          \ +} + +#define VMSTATE_BUFFER_POINTER_UNSAFE(_field, _state, _version, _size) { \ +    .name       = (stringify(_field)),                               \ +    .version_id = (_version),                                        \ +    .size       = (_size),                                           \ +    .info       = &vmstate_info_buffer,                              \ +    .flags      = VMS_BUFFER|VMS_POINTER,                            \ +    .offset     = offsetof(_state, _field),                          \ +} + +#define VMSTATE_UNUSED_BUFFER(_test, _version, _size) {              \ +    .name         = "unused",                                        \ +    .field_exists = (_test),                                         \ +    .version_id   = (_version),                                      \ +    .size         = (_size),                                         \ +    .info         = &vmstate_info_unused_buffer,                     \ +    .flags        = VMS_BUFFER,                                      \ +} + +/* _field_size should be a int32_t field in the _state struct giving the + * size of the bitmap _field in bits. + */ +#define VMSTATE_BITMAP(_field, _state, _version, _field_size) {      \ +    .name         = (stringify(_field)),                             \ +    .version_id   = (_version),                                      \ +    .size_offset  = vmstate_offset_value(_state, _field_size, int32_t),\ +    .info         = &vmstate_info_bitmap,                            \ +    .flags        = VMS_VBUFFER|VMS_POINTER,                         \ +    .offset       = offsetof(_state, _field),                        \ +} + +/* _f : field name +   _f_n : num of elements field_name +   _n : num of elements +   _s : struct state name +   _v : version +*/ + +#define VMSTATE_SINGLE(_field, _state, _version, _info, _type)        \ +    VMSTATE_SINGLE_TEST(_field, _state, NULL, _version, _info, _type) + +#define VMSTATE_STRUCT(_field, _state, _version, _vmsd, _type)        \ +    VMSTATE_STRUCT_TEST(_field, _state, NULL, _version, _vmsd, _type) + +#define VMSTATE_STRUCT_POINTER(_field, _state, _vmsd, _type)          \ +    VMSTATE_STRUCT_POINTER_V(_field, _state, 0, _vmsd, _type) + +#define VMSTATE_STRUCT_POINTER_TEST(_field, _state, _test, _vmsd, _type)     \ +    VMSTATE_STRUCT_POINTER_TEST_V(_field, _state, _test, 0, _vmsd, _type) + +#define VMSTATE_STRUCT_ARRAY(_field, _state, _num, _version, _vmsd, _type) \ +    VMSTATE_STRUCT_ARRAY_TEST(_field, _state, _num, NULL, _version,   \ +            _vmsd, _type) + +#define VMSTATE_BUFFER_UNSAFE_INFO(_field, _state, _version, _info, _size) \ +    VMSTATE_BUFFER_UNSAFE_INFO_TEST(_field, _state, NULL, _version, _info, \ +            _size) + +#define VMSTATE_BOOL_V(_f, _s, _v)                                    \ +    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_bool, bool) + +#define VMSTATE_INT8_V(_f, _s, _v)                                    \ +    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int8, int8_t) +#define VMSTATE_INT16_V(_f, _s, _v)                                   \ +    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int16, int16_t) +#define VMSTATE_INT32_V(_f, _s, _v)                                   \ +    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int32, int32_t) +#define VMSTATE_INT64_V(_f, _s, _v)                                   \ +    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int64, int64_t) + +#define VMSTATE_UINT8_V(_f, _s, _v)                                   \ +    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint8, uint8_t) +#define VMSTATE_UINT16_V(_f, _s, _v)                                  \ +    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint16, uint16_t) +#define VMSTATE_UINT32_V(_f, _s, _v)                                  \ +    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint32, uint32_t) +#define VMSTATE_UINT64_V(_f, _s, _v)                                  \ +    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint64, uint64_t) + +#define VMSTATE_BOOL(_f, _s)                                          \ +    VMSTATE_BOOL_V(_f, _s, 0) + +#define VMSTATE_INT8(_f, _s)                                          \ +    VMSTATE_INT8_V(_f, _s, 0) +#define VMSTATE_INT16(_f, _s)                                         \ +    VMSTATE_INT16_V(_f, _s, 0) +#define VMSTATE_INT32(_f, _s)                                         \ +    VMSTATE_INT32_V(_f, _s, 0) +#define VMSTATE_INT64(_f, _s)                                         \ +    VMSTATE_INT64_V(_f, _s, 0) + +#define VMSTATE_UINT8(_f, _s)                                         \ +    VMSTATE_UINT8_V(_f, _s, 0) +#define VMSTATE_UINT16(_f, _s)                                        \ +    VMSTATE_UINT16_V(_f, _s, 0) +#define VMSTATE_UINT32(_f, _s)                                        \ +    VMSTATE_UINT32_V(_f, _s, 0) +#define VMSTATE_UINT64(_f, _s)                                        \ +    VMSTATE_UINT64_V(_f, _s, 0) + +#define VMSTATE_UINT8_EQUAL(_f, _s)                                   \ +    VMSTATE_SINGLE(_f, _s, 0, vmstate_info_uint8_equal, uint8_t) + +#define VMSTATE_UINT16_EQUAL(_f, _s)                                  \ +    VMSTATE_SINGLE(_f, _s, 0, vmstate_info_uint16_equal, uint16_t) + +#define VMSTATE_UINT16_EQUAL_V(_f, _s, _v)                            \ +    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint16_equal, uint16_t) + +#define VMSTATE_INT32_EQUAL(_f, _s)                                   \ +    VMSTATE_SINGLE(_f, _s, 0, vmstate_info_int32_equal, int32_t) + +#define VMSTATE_UINT32_EQUAL_V(_f, _s, _v)                            \ +    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint32_equal, uint32_t) + +#define VMSTATE_UINT32_EQUAL(_f, _s)                                  \ +    VMSTATE_UINT32_EQUAL_V(_f, _s, 0) + +#define VMSTATE_UINT64_EQUAL_V(_f, _s, _v)                            \ +    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint64_equal, uint64_t) + +#define VMSTATE_UINT64_EQUAL(_f, _s)                                  \ +    VMSTATE_UINT64_EQUAL_V(_f, _s, 0) + +#define VMSTATE_INT32_POSITIVE_LE(_f, _s)                             \ +    VMSTATE_SINGLE(_f, _s, 0, vmstate_info_int32_le, int32_t) + +#define VMSTATE_INT8_TEST(_f, _s, _t)                               \ +    VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_int8, int8_t) + +#define VMSTATE_INT16_TEST(_f, _s, _t)                               \ +    VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_int16, int16_t) + +#define VMSTATE_INT32_TEST(_f, _s, _t)                                  \ +    VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_int32, int32_t) + +#define VMSTATE_INT64_TEST(_f, _s, _t)                                  \ +    VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_int64, int64_t) + +#define VMSTATE_UINT8_TEST(_f, _s, _t)                               \ +    VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint8, uint8_t) + +#define VMSTATE_UINT16_TEST(_f, _s, _t)                               \ +    VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint16, uint16_t) + +#define VMSTATE_UINT32_TEST(_f, _s, _t)                                  \ +    VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint32, uint32_t) + +#define VMSTATE_UINT64_TEST(_f, _s, _t)                                  \ +    VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint64, uint64_t) + + +#define VMSTATE_FLOAT64_V(_f, _s, _v)                                 \ +    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_float64, float64) + +#define VMSTATE_FLOAT64(_f, _s)                                       \ +    VMSTATE_FLOAT64_V(_f, _s, 0) + +#define VMSTATE_TIMER_PTR_TEST(_f, _s, _test)                             \ +    VMSTATE_POINTER_TEST(_f, _s, _test, vmstate_info_timer, QEMUTimer *) + +#define VMSTATE_TIMER_PTR_V(_f, _s, _v)                                   \ +    VMSTATE_POINTER(_f, _s, _v, vmstate_info_timer, QEMUTimer *) + +#define VMSTATE_TIMER_PTR(_f, _s)                                         \ +    VMSTATE_TIMER_PTR_V(_f, _s, 0) + +#define VMSTATE_TIMER_PTR_ARRAY(_f, _s, _n)                              \ +    VMSTATE_ARRAY_OF_POINTER(_f, _s, _n, 0, vmstate_info_timer, QEMUTimer *) + +#define VMSTATE_TIMER_TEST(_f, _s, _test)                             \ +    VMSTATE_SINGLE_TEST(_f, _s, _test, 0, vmstate_info_timer, QEMUTimer) + +#define VMSTATE_TIMER_V(_f, _s, _v)                                   \ +    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_timer, QEMUTimer) + +#define VMSTATE_TIMER(_f, _s)                                         \ +    VMSTATE_TIMER_V(_f, _s, 0) + +#define VMSTATE_TIMER_ARRAY(_f, _s, _n)                              \ +    VMSTATE_ARRAY(_f, _s, _n, 0, vmstate_info_timer, QEMUTimer) + +#define VMSTATE_BOOL_ARRAY_V(_f, _s, _n, _v)                         \ +    VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_bool, bool) + +#define VMSTATE_BOOL_ARRAY(_f, _s, _n)                               \ +    VMSTATE_BOOL_ARRAY_V(_f, _s, _n, 0) + +#define VMSTATE_UINT16_ARRAY_V(_f, _s, _n, _v)                         \ +    VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint16, uint16_t) + +#define VMSTATE_UINT16_2DARRAY_V(_f, _s, _n1, _n2, _v)                \ +    VMSTATE_2DARRAY(_f, _s, _n1, _n2, _v, vmstate_info_uint16, uint16_t) + +#define VMSTATE_UINT16_ARRAY(_f, _s, _n)                               \ +    VMSTATE_UINT16_ARRAY_V(_f, _s, _n, 0) + +#define VMSTATE_UINT16_2DARRAY(_f, _s, _n1, _n2)                      \ +    VMSTATE_UINT16_2DARRAY_V(_f, _s, _n1, _n2, 0) + +#define VMSTATE_UINT8_2DARRAY_V(_f, _s, _n1, _n2, _v)                 \ +    VMSTATE_2DARRAY(_f, _s, _n1, _n2, _v, vmstate_info_uint8, uint8_t) + +#define VMSTATE_UINT8_ARRAY_V(_f, _s, _n, _v)                         \ +    VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint8, uint8_t) + +#define VMSTATE_UINT8_ARRAY(_f, _s, _n)                               \ +    VMSTATE_UINT8_ARRAY_V(_f, _s, _n, 0) + +#define VMSTATE_UINT8_SUB_ARRAY(_f, _s, _start, _num)                \ +    VMSTATE_SUB_ARRAY(_f, _s, _start, _num, 0, vmstate_info_uint8, uint8_t) + +#define VMSTATE_UINT8_2DARRAY(_f, _s, _n1, _n2)                       \ +    VMSTATE_UINT8_2DARRAY_V(_f, _s, _n1, _n2, 0) + +#define VMSTATE_UINT32_ARRAY_V(_f, _s, _n, _v)                        \ +    VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint32, uint32_t) + +#define VMSTATE_UINT32_2DARRAY_V(_f, _s, _n1, _n2, _v)                \ +    VMSTATE_2DARRAY(_f, _s, _n1, _n2, _v, vmstate_info_uint32, uint32_t) + +#define VMSTATE_UINT32_ARRAY(_f, _s, _n)                              \ +    VMSTATE_UINT32_ARRAY_V(_f, _s, _n, 0) + +#define VMSTATE_UINT32_2DARRAY(_f, _s, _n1, _n2)                      \ +    VMSTATE_UINT32_2DARRAY_V(_f, _s, _n1, _n2, 0) + +#define VMSTATE_UINT64_ARRAY_V(_f, _s, _n, _v)                        \ +    VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint64, uint64_t) + +#define VMSTATE_UINT64_ARRAY(_f, _s, _n)                              \ +    VMSTATE_UINT64_ARRAY_V(_f, _s, _n, 0) + +#define VMSTATE_INT16_ARRAY_V(_f, _s, _n, _v)                         \ +    VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int16, int16_t) + +#define VMSTATE_INT16_ARRAY(_f, _s, _n)                               \ +    VMSTATE_INT16_ARRAY_V(_f, _s, _n, 0) + +#define VMSTATE_INT32_ARRAY_V(_f, _s, _n, _v)                         \ +    VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int32, int32_t) + +#define VMSTATE_INT32_ARRAY(_f, _s, _n)                               \ +    VMSTATE_INT32_ARRAY_V(_f, _s, _n, 0) + +#define VMSTATE_UINT32_SUB_ARRAY(_f, _s, _start, _num)                \ +    VMSTATE_SUB_ARRAY(_f, _s, _start, _num, 0, vmstate_info_uint32, uint32_t) + +#define VMSTATE_UINT32_ARRAY(_f, _s, _n)                              \ +    VMSTATE_UINT32_ARRAY_V(_f, _s, _n, 0) + +#define VMSTATE_INT64_ARRAY_V(_f, _s, _n, _v)                         \ +    VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int64, int64_t) + +#define VMSTATE_INT64_ARRAY(_f, _s, _n)                               \ +    VMSTATE_INT64_ARRAY_V(_f, _s, _n, 0) + +#define VMSTATE_FLOAT64_ARRAY_V(_f, _s, _n, _v)                       \ +    VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_float64, float64) + +#define VMSTATE_FLOAT64_ARRAY(_f, _s, _n)                             \ +    VMSTATE_FLOAT64_ARRAY_V(_f, _s, _n, 0) + +#define VMSTATE_BUFFER_V(_f, _s, _v)                                  \ +    VMSTATE_STATIC_BUFFER(_f, _s, _v, NULL, 0, sizeof(typeof_field(_s, _f))) + +#define VMSTATE_BUFFER(_f, _s)                                        \ +    VMSTATE_BUFFER_V(_f, _s, 0) + +#define VMSTATE_PARTIAL_BUFFER(_f, _s, _size)                         \ +    VMSTATE_STATIC_BUFFER(_f, _s, 0, NULL, 0, _size) + +#define VMSTATE_BUFFER_START_MIDDLE(_f, _s, _start) \ +    VMSTATE_STATIC_BUFFER(_f, _s, 0, NULL, _start, sizeof(typeof_field(_s, _f))) + +#define VMSTATE_PARTIAL_VBUFFER(_f, _s, _size)                        \ +    VMSTATE_VBUFFER(_f, _s, 0, NULL, 0, _size) + +#define VMSTATE_PARTIAL_VBUFFER_UINT32(_f, _s, _size)                        \ +    VMSTATE_VBUFFER_UINT32(_f, _s, 0, NULL, 0, _size) + +#define VMSTATE_SUB_VBUFFER(_f, _s, _start, _size)                    \ +    VMSTATE_VBUFFER(_f, _s, 0, NULL, _start, _size) + +#define VMSTATE_BUFFER_TEST(_f, _s, _test)                            \ +    VMSTATE_STATIC_BUFFER(_f, _s, 0, _test, 0, sizeof(typeof_field(_s, _f))) + +#define VMSTATE_BUFFER_UNSAFE(_field, _state, _version, _size)        \ +    VMSTATE_BUFFER_UNSAFE_INFO(_field, _state, _version, vmstate_info_buffer, _size) + +#define VMSTATE_UNUSED_V(_v, _size)                                   \ +    VMSTATE_UNUSED_BUFFER(NULL, _v, _size) + +#define VMSTATE_UNUSED(_size)                                         \ +    VMSTATE_UNUSED_V(0, _size) + +#define VMSTATE_UNUSED_TEST(_test, _size)                             \ +    VMSTATE_UNUSED_BUFFER(_test, 0, _size) + +#define VMSTATE_END_OF_LIST()                                         \ +    {} + +#define SELF_ANNOUNCE_ROUNDS 5 + +void loadvm_free_handlers(MigrationIncomingState *mis); + +int vmstate_load_state(QEMUFile *f, const VMStateDescription *vmsd, +                       void *opaque, int version_id); +void vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd, +                        void *opaque, QJSON *vmdesc); + +bool vmstate_save_needed(const VMStateDescription *vmsd, void *opaque); + +int vmstate_register_with_alias_id(DeviceState *dev, int instance_id, +                                   const VMStateDescription *vmsd, +                                   void *base, int alias_id, +                                   int required_for_version); + +static inline int vmstate_register(DeviceState *dev, int instance_id, +                                   const VMStateDescription *vmsd, +                                   void *opaque) +{ +    return vmstate_register_with_alias_id(dev, instance_id, vmsd, +                                          opaque, -1, 0); +} + +void vmstate_unregister(DeviceState *dev, const VMStateDescription *vmsd, +                        void *opaque); + +struct MemoryRegion; +void vmstate_register_ram(struct MemoryRegion *memory, DeviceState *dev); +void vmstate_unregister_ram(struct MemoryRegion *memory, DeviceState *dev); +void vmstate_register_ram_global(struct MemoryRegion *memory); + +static inline +int64_t self_announce_delay(int round) +{ +    assert(round < SELF_ANNOUNCE_ROUNDS && round > 0); +    /* delay 50ms, 150ms, 250ms, ... */ +    return 50 + (SELF_ANNOUNCE_ROUNDS - round - 1) * 100; +} + +void dump_vmstate_json_to_file(FILE *out_fp); + +#endif  | 
