diff options
Diffstat (limited to 'server/migration-protocol.h')
| -rw-r--r-- | server/migration-protocol.h | 219 |
1 files changed, 219 insertions, 0 deletions
diff --git a/server/migration-protocol.h b/server/migration-protocol.h new file mode 100644 index 00000000..2fc8e036 --- /dev/null +++ b/server/migration-protocol.h @@ -0,0 +1,219 @@ +/* + Copyright (C) 2012 Red Hat, Inc. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, see <http://www.gnu.org/licenses/>. +*/ + +#ifndef MIGRATION_PROTOCOL_H_ +#define MIGRATION_PROTOCOL_H_ + +#include <spice/macros.h> +#include <spice/vd_agent.h> +#include <common/log.h> + +#include "glz-encoder-dict.h" + +/* ************************************************ + * src-server to dst-server migration data messages + * ************************************************/ + +#include <spice/start-packed.h> + +/* increase the version when the version of any + * of the migration data messages is increased */ +#define SPICE_MIGRATION_PROTOCOL_VERSION 1 + +typedef struct SPICE_ATTR_PACKED SpiceMigrateDataHeader { + uint32_t magic; + uint32_t version; +} SpiceMigrateDataHeader; + +/* ******************** + * Char device base + * *******************/ + +/* increase the version of descendent char devices when this + * version is increased */ +#define SPICE_MIGRATE_DATA_CHAR_DEVICE_VERSION 1 + +/* Should be the first field of any of the char_devices migration data (see write_data_ptr) */ +typedef struct SPICE_ATTR_PACKED SpiceMigrateDataCharDevice { + uint32_t version; + uint8_t connected; + uint32_t num_client_tokens; + uint32_t num_send_tokens; + uint32_t write_size; /* write to dev */ + uint32_t write_num_client_tokens; /* how many messages from the client are part of the write_data */ + uint32_t write_data_ptr; /* offset from + SpiceMigrateDataCharDevice - sizeof(SpiceMigrateDataHeader) */ +} SpiceMigrateDataCharDevice; + +/* ******** + * spicevmc + * ********/ + +#define SPICE_MIGRATE_DATA_SPICEVMC_VERSION 1 /* NOTE: increase version when CHAR_DEVICE_VERSION + is increased */ +#define SPICE_MIGRATE_DATA_SPICEVMC_MAGIC SPICE_MAGIC_CONST("SVMD") +typedef struct SPICE_ATTR_PACKED SpiceMigrateDataSpiceVmc { + SpiceMigrateDataCharDevice base; +} SpiceMigrateDataSpiceVmc; + +/* ********* + * smartcard + * *********/ + +#define SPICE_MIGRATE_DATA_SMARTCARD_VERSION 1 /* NOTE: increase version when CHAR_DEVICE_VERSION + is increased */ +#define SPICE_MIGRATE_DATA_SMARTCARD_MAGIC SPICE_MAGIC_CONST("SCMD") +typedef struct SPICE_ATTR_PACKED SpiceMigrateDataSmartcard { + SpiceMigrateDataCharDevice base; + uint8_t reader_added; + uint32_t read_size; /* partial data read from dev */ + uint32_t read_data_ptr; +} SpiceMigrateDataSmartcard; + +/* ********************************* + * main channel (mainly guest agent) + * *********************************/ +#define SPICE_MIGRATE_DATA_MAIN_VERSION 1 /* NOTE: increase version when CHAR_DEVICE_VERSION + is increased */ +#define SPICE_MIGRATE_DATA_MAIN_MAGIC SPICE_MAGIC_CONST("MNMD") + +typedef struct SPICE_ATTR_PACKED SpiceMigrateDataMain { + SpiceMigrateDataCharDevice agent_base; + uint8_t client_agent_started; /* for discarding messages */ + + struct SPICE_ATTR_PACKED { + /* partial data read from device. Such data is stored only + * if the chunk header or the entire msg header haven't yet been read completely. + * Once the headers are read, partial reads of chunks can be sent as + * smaller chunks to the client, without the roundtrip overhead of migration data */ + uint32_t chunk_header_size; + VDIChunkHeader chunk_header; + uint8_t msg_header_done; + uint32_t msg_header_partial_len; + uint32_t msg_header_ptr; + uint32_t msg_remaining; + uint8_t msg_filter_result; + } agent2client; + + struct SPICE_ATTR_PACKED { + uint32_t msg_remaining; + uint8_t msg_filter_result; + } client2agent; +} SpiceMigrateDataMain; + +/* **************** + * display channel + * ***************/ + +#define SPICE_MIGRATE_DATA_DISPLAY_VERSION 1 +#define SPICE_MIGRATE_DATA_DISPLAY_MAGIC SPICE_MAGIC_CONST("DCMD") + +/* + * TODO: store the cache and dictionary data only in one channel (the + * freezer). + * TODO: optimizations: don't send surfaces information if it will be faster + * to resend the surfaces on-demand. + * */ +#define MIGRATE_DATA_DISPLAY_MAX_CACHE_CLIENTS 4 + +typedef struct SPICE_ATTR_PACKED SpiceMigrateDataDisplay { + uint64_t message_serial; + uint8_t low_bandwidth_setting; + + /* + * Synchronizing the shared pixmap cache. + * For now, the cache is not migrated, and instead, we reset it and send + * SPICE_MSG_DISPLAY_INVAL_ALL_PIXMAPS to the client. + * In order to keep the client and server caches consistent: + * The channel which froze the cache on the src side, unfreezes it + * on the dest side, and increases its generation (see 'reset' in red_client_shared_cach.h). + * In order to enforce that images that are added to the cache by other channels + * will reach the client only after SPICE_MSG_DISPLAY_INVAL_ALL_PIXMAPS, + * we send SPICE_MSG_WAIT_FOR_CHANNELS + * (see the generation mismatch handling in 'add' in red_client_shared_cach.h). + */ + uint8_t pixmap_cache_id; + int64_t pixmap_cache_size; + uint8_t pixmap_cache_freezer; + uint64_t pixmap_cache_clients[MIGRATE_DATA_DISPLAY_MAX_CACHE_CLIENTS]; + + uint8_t glz_dict_id; + GlzEncDictRestoreData glz_dict_data; + + uint32_t surfaces_at_client_ptr; /* reference to MigrateDisplaySurfacesAtClientLossless/Lossy. + Lossy: when jpeg-wan-compression(qemu cmd line)=always + or when jpeg-wan-compression=auto, + and low_bandwidth_setting=TRUE */ + +} SpiceMigrateDataDisplay; + +typedef struct SPICE_ATTR_PACKED SpiceMigrateDataRect { + int32_t left; + int32_t top; + int32_t right; + int32_t bottom; +} SpiceMigrateDataRect; + +typedef struct SPICE_ATTR_PACKED MigrateDisplaySurfaceLossless { + uint32_t id; +} MigrateDisplaySurfaceLossless; + +typedef struct SPICE_ATTR_PACKED MigrateDisplaySurfaceLossy { + uint32_t id; + SpiceMigrateDataRect lossy_rect; +} MigrateDisplaySurfaceLossy; + +typedef struct SPICE_ATTR_PACKED MigrateDisplaySurfacesAtClientLossless { + uint32_t num_surfaces; + MigrateDisplaySurfaceLossless surfaces[0]; +} MigrateDisplaySurfacesAtClientLossless; + +typedef struct SPICE_ATTR_PACKED MigrateDisplaySurfacesAtClientLossy { + uint32_t num_surfaces; + MigrateDisplaySurfaceLossy surfaces[0]; +} MigrateDisplaySurfacesAtClientLossy; + +/* **************** + * inputs channel + * ***************/ + +#define SPICE_MIGRATE_DATA_INPUTS_VERSION 1 +#define SPICE_MIGRATE_DATA_INPUTS_MAGIC SPICE_MAGIC_CONST("ICMD") + + +typedef struct SPICE_ATTR_PACKED SpiceMigrateDataInputs { + uint16_t motion_count; +} SpiceMigrateDataInputs; + +#include <spice/end-packed.h> + +static inline int migration_protocol_validate_header(SpiceMigrateDataHeader *header, + uint32_t magic, + uint32_t version) +{ + if (header->magic != magic) { + spice_error("bad magic %u (!= %u)", header->magic, magic); + return FALSE; + } + if (header->version > version) { + spice_error("unsupported version %u (> %u)", header->version, version); + return FALSE; + } + return TRUE; +} + +#endif /* MIGRATION_PROTOCOL_H_ */ |