2 * Multifd common functions
4 * Copyright (c) 2019-2020 Red Hat Inc
7 * Juan Quintela <quintela@redhat.com>
9 * This work is licensed under the terms of the GNU GPL, version 2 or later.
10 * See the COPYING file in the top-level directory.
13 #ifndef QEMU_MIGRATION_MULTIFD_H
14 #define QEMU_MIGRATION_MULTIFD_H
16 bool multifd_send_setup(void);
17 void multifd_send_shutdown(void);
18 int multifd_recv_setup(Error
**errp
);
19 void multifd_recv_cleanup(void);
20 void multifd_recv_shutdown(void);
21 bool multifd_recv_all_channels_created(void);
22 void multifd_recv_new_channel(QIOChannel
*ioc
, Error
**errp
);
23 void multifd_recv_sync_main(void);
24 int multifd_send_sync_main(void);
25 bool multifd_queue_page(RAMBlock
*block
, ram_addr_t offset
);
27 /* Multifd Compression flags */
28 #define MULTIFD_FLAG_SYNC (1 << 0)
30 /* We reserve 3 bits for compression methods */
31 #define MULTIFD_FLAG_COMPRESSION_MASK (7 << 1)
32 /* we need to be compatible. Before compression value was 0 */
33 #define MULTIFD_FLAG_NOCOMP (0 << 1)
34 #define MULTIFD_FLAG_ZLIB (1 << 1)
35 #define MULTIFD_FLAG_ZSTD (2 << 1)
37 /* This value needs to be a multiple of qemu_target_page_size() */
38 #define MULTIFD_PACKET_SIZE (512 * 1024)
44 /* maximum number of allocated pages */
47 uint32_t normal_pages
;
48 /* size of the next packet that contains pages */
49 uint32_t next_packet_size
;
51 uint64_t unused
[4]; /* Reserved for future use */
54 } __attribute__((packed
)) MultiFDPacket_t
;
57 /* number of used pages */
59 /* number of allocated pages */
61 /* offset of each page */
67 /* Fields are only written at creating/deletion time */
68 /* No lock required for them, they are read only */
72 /* channel thread name */
74 /* channel thread id */
77 QemuThread tls_thread
;
78 bool tls_thread_created
;
79 /* communication channel */
81 /* is the yank function registered */
83 /* packet allocated len */
87 /* number of pages in a full packet */
89 /* multifd flags for sending ram */
92 /* sem where to wait for more work */
94 /* syncs main thread and channels */
95 QemuSemaphore sem_sync
;
97 /* multifd flags for each packet */
100 * The sender thread has work to do if either of below boolean is set.
102 * @pending_job: a job is pending
103 * @pending_sync: a sync request is pending
105 * For both of these fields, they're only set by the requesters, and
106 * cleared by the multifd sender threads.
110 /* array of pages to sent.
111 * The owner of 'pages' depends of 'pending_job' value:
112 * pending_job == 0 -> migration_thread can use it.
113 * pending_job != 0 -> multifd_channel can use it.
115 MultiFDPages_t
*pages
;
117 /* thread local variables. No locking required */
119 /* pointer to the packet */
120 MultiFDPacket_t
*packet
;
121 /* size of the next packet that contains pages */
122 uint32_t next_packet_size
;
123 /* packets sent through this channel */
124 uint64_t packets_sent
;
125 /* non zero pages sent through this channel */
126 uint64_t total_normal_pages
;
127 /* buffers to send */
129 /* number of iovs used */
131 /* used for compression methods */
136 /* Fields are only written at creating/deletion time */
137 /* No lock required for them, they are read only */
141 /* channel thread name */
143 /* channel thread id */
146 /* communication channel */
148 /* packet allocated len */
150 /* guest page size */
152 /* number of pages in a full packet */
155 /* syncs main thread and channels */
156 QemuSemaphore sem_sync
;
158 /* this mutex protects the following parameters */
160 /* should this thread finish */
162 /* multifd flags for each packet */
164 /* global number of generated multifd packets */
167 /* thread local variables. No locking required */
169 /* pointer to the packet */
170 MultiFDPacket_t
*packet
;
171 /* size of the next packet that contains pages */
172 uint32_t next_packet_size
;
173 /* packets received through this channel */
174 uint64_t packets_recved
;
177 /* ramblock host address */
179 /* non zero pages recv through this channel */
180 uint64_t total_normal_pages
;
181 /* buffers to recv */
183 /* Pages that are not zero */
185 /* num of non zero pages */
187 /* used for de-compression methods */
192 /* Setup for sending side */
193 int (*send_setup
)(MultiFDSendParams
*p
, Error
**errp
);
194 /* Cleanup for sending side */
195 void (*send_cleanup
)(MultiFDSendParams
*p
, Error
**errp
);
196 /* Prepare the send packet */
197 int (*send_prepare
)(MultiFDSendParams
*p
, Error
**errp
);
198 /* Setup for receiving side */
199 int (*recv_setup
)(MultiFDRecvParams
*p
, Error
**errp
);
200 /* Cleanup for receiving side */
201 void (*recv_cleanup
)(MultiFDRecvParams
*p
);
203 int (*recv_pages
)(MultiFDRecvParams
*p
, Error
**errp
);
206 void multifd_register_ops(int method
, MultiFDMethods
*ops
);
207 void multifd_send_fill_packet(MultiFDSendParams
*p
);
209 static inline void multifd_send_prepare_header(MultiFDSendParams
*p
)
211 p
->iov
[0].iov_len
= p
->packet_len
;
212 p
->iov
[0].iov_base
= p
->packet
;