1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
/*
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 _H_MIGRATION_PROTOCOL
#define _H_MIGRATION_PROTOCOL
#include <spice/vd_agent.h>
#include "common/glz_encoder_dictionary.h"
/* ************************************************
* src-server to dst-server migration data messages
* ************************************************/
/* increase the version when the version of any
* of the migration data messages is increased */
#define SPICE_MIGRATION_PROTOCOL_VERSION 1
typedef struct __attribute__ ((__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 __attribute__ ((__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 (*(uint32_t *)"SVMD")
typedef struct __attribute__ ((__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 (*(uint32_t *)"SCMD")
typedef struct __attribute__ ((__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 (*(uint32_t *)"MNMD")
typedef struct __attribute__ ((__packed__)) SpiceMigrateDataMain {
SpiceMigrateDataCharDevice agent_base;
uint8_t client_agent_started; /* for discarding messages */
struct __attribute__ ((__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 __attribute__ ((__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 (*(uint32_t *)"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 __attribute__ ((__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 freezed 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 __attribute__ ((__packed__)) SpiceMigrateDataRect {
int32_t left;
int32_t top;
int32_t right;
int32_t bottom;
} SpiceMigrateDataRect;
typedef struct __attribute__ ((__packed__)) MigrateDisplaySurfaceLossless {
uint32_t id;
} MigrateDisplaySurfaceLossless;
typedef struct __attribute__ ((__packed__)) MigrateDisplaySurfaceLossy {
uint32_t id;
SpiceMigrateDataRect lossy_rect;
} MigrateDisplaySurfaceLossy;
typedef struct __attribute__ ((__packed__)) MigrateDisplaySurfacesAtClientLossless {
uint32_t num_surfaces;
MigrateDisplaySurfaceLossless surfaces[0];
} MigrateDisplaySurfacesAtClientLossless;
typedef struct __attribute__ ((__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 (*(uint32_t *)"ICMD")
typedef struct __attribute__ ((__packed__)) SpiceMigrateDataInputs {
uint16_t motion_count;
} SpiceMigrateDataInputs;
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
|
