migration/rdma: Fix qemu_get_cm_event_timeout() to always set error
[qemu/kevin.git] / migration / rdma.c
blob0039295a15bda86424a99ac5967cbc73e1d6ca6a
1 /*
2 * RDMA protocol and interfaces
4 * Copyright IBM, Corp. 2010-2013
5 * Copyright Red Hat, Inc. 2015-2016
7 * Authors:
8 * Michael R. Hines <mrhines@us.ibm.com>
9 * Jiuxing Liu <jl@us.ibm.com>
10 * Daniel P. Berrange <berrange@redhat.com>
12 * This work is licensed under the terms of the GNU GPL, version 2 or
13 * later. See the COPYING file in the top-level directory.
17 #include "qemu/osdep.h"
18 #include "qapi/error.h"
19 #include "qemu/cutils.h"
20 #include "exec/target_page.h"
21 #include "rdma.h"
22 #include "migration.h"
23 #include "migration-stats.h"
24 #include "qemu-file.h"
25 #include "ram.h"
26 #include "qemu/error-report.h"
27 #include "qemu/main-loop.h"
28 #include "qemu/module.h"
29 #include "qemu/rcu.h"
30 #include "qemu/sockets.h"
31 #include "qemu/bitmap.h"
32 #include "qemu/coroutine.h"
33 #include "exec/memory.h"
34 #include <sys/socket.h>
35 #include <netdb.h>
36 #include <arpa/inet.h>
37 #include <rdma/rdma_cma.h>
38 #include "trace.h"
39 #include "qom/object.h"
40 #include "options.h"
41 #include <poll.h>
44 * Print and error on both the Monitor and the Log file.
46 #define ERROR(errp, fmt, ...) \
47 do { \
48 fprintf(stderr, "RDMA ERROR: " fmt "\n", ## __VA_ARGS__); \
49 if (errp && (*(errp) == NULL)) { \
50 error_setg(errp, "RDMA ERROR: " fmt, ## __VA_ARGS__); \
51 } \
52 } while (0)
54 #define RDMA_RESOLVE_TIMEOUT_MS 10000
56 /* Do not merge data if larger than this. */
57 #define RDMA_MERGE_MAX (2 * 1024 * 1024)
58 #define RDMA_SIGNALED_SEND_MAX (RDMA_MERGE_MAX / 4096)
60 #define RDMA_REG_CHUNK_SHIFT 20 /* 1 MB */
63 * This is only for non-live state being migrated.
64 * Instead of RDMA_WRITE messages, we use RDMA_SEND
65 * messages for that state, which requires a different
66 * delivery design than main memory.
68 #define RDMA_SEND_INCREMENT 32768
71 * Maximum size infiniband SEND message
73 #define RDMA_CONTROL_MAX_BUFFER (512 * 1024)
74 #define RDMA_CONTROL_MAX_COMMANDS_PER_MESSAGE 4096
76 #define RDMA_CONTROL_VERSION_CURRENT 1
78 * Capabilities for negotiation.
80 #define RDMA_CAPABILITY_PIN_ALL 0x01
83 * Add the other flags above to this list of known capabilities
84 * as they are introduced.
86 static uint32_t known_capabilities = RDMA_CAPABILITY_PIN_ALL;
89 * A work request ID is 64-bits and we split up these bits
90 * into 3 parts:
92 * bits 0-15 : type of control message, 2^16
93 * bits 16-29: ram block index, 2^14
94 * bits 30-63: ram block chunk number, 2^34
96 * The last two bit ranges are only used for RDMA writes,
97 * in order to track their completion and potentially
98 * also track unregistration status of the message.
100 #define RDMA_WRID_TYPE_SHIFT 0UL
101 #define RDMA_WRID_BLOCK_SHIFT 16UL
102 #define RDMA_WRID_CHUNK_SHIFT 30UL
104 #define RDMA_WRID_TYPE_MASK \
105 ((1UL << RDMA_WRID_BLOCK_SHIFT) - 1UL)
107 #define RDMA_WRID_BLOCK_MASK \
108 (~RDMA_WRID_TYPE_MASK & ((1UL << RDMA_WRID_CHUNK_SHIFT) - 1UL))
110 #define RDMA_WRID_CHUNK_MASK (~RDMA_WRID_BLOCK_MASK & ~RDMA_WRID_TYPE_MASK)
113 * RDMA migration protocol:
114 * 1. RDMA Writes (data messages, i.e. RAM)
115 * 2. IB Send/Recv (control channel messages)
117 enum {
118 RDMA_WRID_NONE = 0,
119 RDMA_WRID_RDMA_WRITE = 1,
120 RDMA_WRID_SEND_CONTROL = 2000,
121 RDMA_WRID_RECV_CONTROL = 4000,
125 * Work request IDs for IB SEND messages only (not RDMA writes).
126 * This is used by the migration protocol to transmit
127 * control messages (such as device state and registration commands)
129 * We could use more WRs, but we have enough for now.
131 enum {
132 RDMA_WRID_READY = 0,
133 RDMA_WRID_DATA,
134 RDMA_WRID_CONTROL,
135 RDMA_WRID_MAX,
139 * SEND/RECV IB Control Messages.
141 enum {
142 RDMA_CONTROL_NONE = 0,
143 RDMA_CONTROL_ERROR,
144 RDMA_CONTROL_READY, /* ready to receive */
145 RDMA_CONTROL_QEMU_FILE, /* QEMUFile-transmitted bytes */
146 RDMA_CONTROL_RAM_BLOCKS_REQUEST, /* RAMBlock synchronization */
147 RDMA_CONTROL_RAM_BLOCKS_RESULT, /* RAMBlock synchronization */
148 RDMA_CONTROL_COMPRESS, /* page contains repeat values */
149 RDMA_CONTROL_REGISTER_REQUEST, /* dynamic page registration */
150 RDMA_CONTROL_REGISTER_RESULT, /* key to use after registration */
151 RDMA_CONTROL_REGISTER_FINISHED, /* current iteration finished */
152 RDMA_CONTROL_UNREGISTER_REQUEST, /* dynamic UN-registration */
153 RDMA_CONTROL_UNREGISTER_FINISHED, /* unpinning finished */
158 * Memory and MR structures used to represent an IB Send/Recv work request.
159 * This is *not* used for RDMA writes, only IB Send/Recv.
161 typedef struct {
162 uint8_t control[RDMA_CONTROL_MAX_BUFFER]; /* actual buffer to register */
163 struct ibv_mr *control_mr; /* registration metadata */
164 size_t control_len; /* length of the message */
165 uint8_t *control_curr; /* start of unconsumed bytes */
166 } RDMAWorkRequestData;
169 * Negotiate RDMA capabilities during connection-setup time.
171 typedef struct {
172 uint32_t version;
173 uint32_t flags;
174 } RDMACapabilities;
176 static void caps_to_network(RDMACapabilities *cap)
178 cap->version = htonl(cap->version);
179 cap->flags = htonl(cap->flags);
182 static void network_to_caps(RDMACapabilities *cap)
184 cap->version = ntohl(cap->version);
185 cap->flags = ntohl(cap->flags);
189 * Representation of a RAMBlock from an RDMA perspective.
190 * This is not transmitted, only local.
191 * This and subsequent structures cannot be linked lists
192 * because we're using a single IB message to transmit
193 * the information. It's small anyway, so a list is overkill.
195 typedef struct RDMALocalBlock {
196 char *block_name;
197 uint8_t *local_host_addr; /* local virtual address */
198 uint64_t remote_host_addr; /* remote virtual address */
199 uint64_t offset;
200 uint64_t length;
201 struct ibv_mr **pmr; /* MRs for chunk-level registration */
202 struct ibv_mr *mr; /* MR for non-chunk-level registration */
203 uint32_t *remote_keys; /* rkeys for chunk-level registration */
204 uint32_t remote_rkey; /* rkeys for non-chunk-level registration */
205 int index; /* which block are we */
206 unsigned int src_index; /* (Only used on dest) */
207 bool is_ram_block;
208 int nb_chunks;
209 unsigned long *transit_bitmap;
210 unsigned long *unregister_bitmap;
211 } RDMALocalBlock;
214 * Also represents a RAMblock, but only on the dest.
215 * This gets transmitted by the dest during connection-time
216 * to the source VM and then is used to populate the
217 * corresponding RDMALocalBlock with
218 * the information needed to perform the actual RDMA.
220 typedef struct QEMU_PACKED RDMADestBlock {
221 uint64_t remote_host_addr;
222 uint64_t offset;
223 uint64_t length;
224 uint32_t remote_rkey;
225 uint32_t padding;
226 } RDMADestBlock;
228 static const char *control_desc(unsigned int rdma_control)
230 static const char *strs[] = {
231 [RDMA_CONTROL_NONE] = "NONE",
232 [RDMA_CONTROL_ERROR] = "ERROR",
233 [RDMA_CONTROL_READY] = "READY",
234 [RDMA_CONTROL_QEMU_FILE] = "QEMU FILE",
235 [RDMA_CONTROL_RAM_BLOCKS_REQUEST] = "RAM BLOCKS REQUEST",
236 [RDMA_CONTROL_RAM_BLOCKS_RESULT] = "RAM BLOCKS RESULT",
237 [RDMA_CONTROL_COMPRESS] = "COMPRESS",
238 [RDMA_CONTROL_REGISTER_REQUEST] = "REGISTER REQUEST",
239 [RDMA_CONTROL_REGISTER_RESULT] = "REGISTER RESULT",
240 [RDMA_CONTROL_REGISTER_FINISHED] = "REGISTER FINISHED",
241 [RDMA_CONTROL_UNREGISTER_REQUEST] = "UNREGISTER REQUEST",
242 [RDMA_CONTROL_UNREGISTER_FINISHED] = "UNREGISTER FINISHED",
245 if (rdma_control > RDMA_CONTROL_UNREGISTER_FINISHED) {
246 return "??BAD CONTROL VALUE??";
249 return strs[rdma_control];
252 static uint64_t htonll(uint64_t v)
254 union { uint32_t lv[2]; uint64_t llv; } u;
255 u.lv[0] = htonl(v >> 32);
256 u.lv[1] = htonl(v & 0xFFFFFFFFULL);
257 return u.llv;
260 static uint64_t ntohll(uint64_t v)
262 union { uint32_t lv[2]; uint64_t llv; } u;
263 u.llv = v;
264 return ((uint64_t)ntohl(u.lv[0]) << 32) | (uint64_t) ntohl(u.lv[1]);
267 static void dest_block_to_network(RDMADestBlock *db)
269 db->remote_host_addr = htonll(db->remote_host_addr);
270 db->offset = htonll(db->offset);
271 db->length = htonll(db->length);
272 db->remote_rkey = htonl(db->remote_rkey);
275 static void network_to_dest_block(RDMADestBlock *db)
277 db->remote_host_addr = ntohll(db->remote_host_addr);
278 db->offset = ntohll(db->offset);
279 db->length = ntohll(db->length);
280 db->remote_rkey = ntohl(db->remote_rkey);
284 * Virtual address of the above structures used for transmitting
285 * the RAMBlock descriptions at connection-time.
286 * This structure is *not* transmitted.
288 typedef struct RDMALocalBlocks {
289 int nb_blocks;
290 bool init; /* main memory init complete */
291 RDMALocalBlock *block;
292 } RDMALocalBlocks;
295 * Main data structure for RDMA state.
296 * While there is only one copy of this structure being allocated right now,
297 * this is the place where one would start if you wanted to consider
298 * having more than one RDMA connection open at the same time.
300 typedef struct RDMAContext {
301 char *host;
302 int port;
303 char *host_port;
305 RDMAWorkRequestData wr_data[RDMA_WRID_MAX];
308 * This is used by *_exchange_send() to figure out whether or not
309 * the initial "READY" message has already been received or not.
310 * This is because other functions may potentially poll() and detect
311 * the READY message before send() does, in which case we need to
312 * know if it completed.
314 int control_ready_expected;
316 /* number of outstanding writes */
317 int nb_sent;
319 /* store info about current buffer so that we can
320 merge it with future sends */
321 uint64_t current_addr;
322 uint64_t current_length;
323 /* index of ram block the current buffer belongs to */
324 int current_index;
325 /* index of the chunk in the current ram block */
326 int current_chunk;
328 bool pin_all;
331 * infiniband-specific variables for opening the device
332 * and maintaining connection state and so forth.
334 * cm_id also has ibv_context, rdma_event_channel, and ibv_qp in
335 * cm_id->verbs, cm_id->channel, and cm_id->qp.
337 struct rdma_cm_id *cm_id; /* connection manager ID */
338 struct rdma_cm_id *listen_id;
339 bool connected;
341 struct ibv_context *verbs;
342 struct rdma_event_channel *channel;
343 struct ibv_qp *qp; /* queue pair */
344 struct ibv_comp_channel *recv_comp_channel; /* recv completion channel */
345 struct ibv_comp_channel *send_comp_channel; /* send completion channel */
346 struct ibv_pd *pd; /* protection domain */
347 struct ibv_cq *recv_cq; /* recvieve completion queue */
348 struct ibv_cq *send_cq; /* send completion queue */
351 * If a previous write failed (perhaps because of a failed
352 * memory registration, then do not attempt any future work
353 * and remember the error state.
355 int error_state;
356 bool error_reported;
357 bool received_error;
360 * Description of ram blocks used throughout the code.
362 RDMALocalBlocks local_ram_blocks;
363 RDMADestBlock *dest_blocks;
365 /* Index of the next RAMBlock received during block registration */
366 unsigned int next_src_index;
369 * Migration on *destination* started.
370 * Then use coroutine yield function.
371 * Source runs in a thread, so we don't care.
373 int migration_started_on_destination;
375 int total_registrations;
376 int total_writes;
378 int unregister_current, unregister_next;
379 uint64_t unregistrations[RDMA_SIGNALED_SEND_MAX];
381 GHashTable *blockmap;
383 /* the RDMAContext for return path */
384 struct RDMAContext *return_path;
385 bool is_return_path;
386 } RDMAContext;
388 #define TYPE_QIO_CHANNEL_RDMA "qio-channel-rdma"
389 OBJECT_DECLARE_SIMPLE_TYPE(QIOChannelRDMA, QIO_CHANNEL_RDMA)
393 struct QIOChannelRDMA {
394 QIOChannel parent;
395 RDMAContext *rdmain;
396 RDMAContext *rdmaout;
397 QEMUFile *file;
398 bool blocking; /* XXX we don't actually honour this yet */
402 * Main structure for IB Send/Recv control messages.
403 * This gets prepended at the beginning of every Send/Recv.
405 typedef struct QEMU_PACKED {
406 uint32_t len; /* Total length of data portion */
407 uint32_t type; /* which control command to perform */
408 uint32_t repeat; /* number of commands in data portion of same type */
409 uint32_t padding;
410 } RDMAControlHeader;
412 static void control_to_network(RDMAControlHeader *control)
414 control->type = htonl(control->type);
415 control->len = htonl(control->len);
416 control->repeat = htonl(control->repeat);
419 static void network_to_control(RDMAControlHeader *control)
421 control->type = ntohl(control->type);
422 control->len = ntohl(control->len);
423 control->repeat = ntohl(control->repeat);
427 * Register a single Chunk.
428 * Information sent by the source VM to inform the dest
429 * to register an single chunk of memory before we can perform
430 * the actual RDMA operation.
432 typedef struct QEMU_PACKED {
433 union QEMU_PACKED {
434 uint64_t current_addr; /* offset into the ram_addr_t space */
435 uint64_t chunk; /* chunk to lookup if unregistering */
436 } key;
437 uint32_t current_index; /* which ramblock the chunk belongs to */
438 uint32_t padding;
439 uint64_t chunks; /* how many sequential chunks to register */
440 } RDMARegister;
442 static int check_error_state(RDMAContext *rdma)
444 if (rdma->error_state && !rdma->error_reported) {
445 error_report("RDMA is in an error state waiting migration"
446 " to abort!");
447 rdma->error_reported = true;
449 return rdma->error_state;
452 static void register_to_network(RDMAContext *rdma, RDMARegister *reg)
454 RDMALocalBlock *local_block;
455 local_block = &rdma->local_ram_blocks.block[reg->current_index];
457 if (local_block->is_ram_block) {
459 * current_addr as passed in is an address in the local ram_addr_t
460 * space, we need to translate this for the destination
462 reg->key.current_addr -= local_block->offset;
463 reg->key.current_addr += rdma->dest_blocks[reg->current_index].offset;
465 reg->key.current_addr = htonll(reg->key.current_addr);
466 reg->current_index = htonl(reg->current_index);
467 reg->chunks = htonll(reg->chunks);
470 static void network_to_register(RDMARegister *reg)
472 reg->key.current_addr = ntohll(reg->key.current_addr);
473 reg->current_index = ntohl(reg->current_index);
474 reg->chunks = ntohll(reg->chunks);
477 typedef struct QEMU_PACKED {
478 uint32_t value; /* if zero, we will madvise() */
479 uint32_t block_idx; /* which ram block index */
480 uint64_t offset; /* Address in remote ram_addr_t space */
481 uint64_t length; /* length of the chunk */
482 } RDMACompress;
484 static void compress_to_network(RDMAContext *rdma, RDMACompress *comp)
486 comp->value = htonl(comp->value);
488 * comp->offset as passed in is an address in the local ram_addr_t
489 * space, we need to translate this for the destination
491 comp->offset -= rdma->local_ram_blocks.block[comp->block_idx].offset;
492 comp->offset += rdma->dest_blocks[comp->block_idx].offset;
493 comp->block_idx = htonl(comp->block_idx);
494 comp->offset = htonll(comp->offset);
495 comp->length = htonll(comp->length);
498 static void network_to_compress(RDMACompress *comp)
500 comp->value = ntohl(comp->value);
501 comp->block_idx = ntohl(comp->block_idx);
502 comp->offset = ntohll(comp->offset);
503 comp->length = ntohll(comp->length);
507 * The result of the dest's memory registration produces an "rkey"
508 * which the source VM must reference in order to perform
509 * the RDMA operation.
511 typedef struct QEMU_PACKED {
512 uint32_t rkey;
513 uint32_t padding;
514 uint64_t host_addr;
515 } RDMARegisterResult;
517 static void result_to_network(RDMARegisterResult *result)
519 result->rkey = htonl(result->rkey);
520 result->host_addr = htonll(result->host_addr);
523 static void network_to_result(RDMARegisterResult *result)
525 result->rkey = ntohl(result->rkey);
526 result->host_addr = ntohll(result->host_addr);
529 static int qemu_rdma_exchange_send(RDMAContext *rdma, RDMAControlHeader *head,
530 uint8_t *data, RDMAControlHeader *resp,
531 int *resp_idx,
532 int (*callback)(RDMAContext *rdma));
534 static inline uint64_t ram_chunk_index(const uint8_t *start,
535 const uint8_t *host)
537 return ((uintptr_t) host - (uintptr_t) start) >> RDMA_REG_CHUNK_SHIFT;
540 static inline uint8_t *ram_chunk_start(const RDMALocalBlock *rdma_ram_block,
541 uint64_t i)
543 return (uint8_t *)(uintptr_t)(rdma_ram_block->local_host_addr +
544 (i << RDMA_REG_CHUNK_SHIFT));
547 static inline uint8_t *ram_chunk_end(const RDMALocalBlock *rdma_ram_block,
548 uint64_t i)
550 uint8_t *result = ram_chunk_start(rdma_ram_block, i) +
551 (1UL << RDMA_REG_CHUNK_SHIFT);
553 if (result > (rdma_ram_block->local_host_addr + rdma_ram_block->length)) {
554 result = rdma_ram_block->local_host_addr + rdma_ram_block->length;
557 return result;
560 static void rdma_add_block(RDMAContext *rdma, const char *block_name,
561 void *host_addr,
562 ram_addr_t block_offset, uint64_t length)
564 RDMALocalBlocks *local = &rdma->local_ram_blocks;
565 RDMALocalBlock *block;
566 RDMALocalBlock *old = local->block;
568 local->block = g_new0(RDMALocalBlock, local->nb_blocks + 1);
570 if (local->nb_blocks) {
571 int x;
573 if (rdma->blockmap) {
574 for (x = 0; x < local->nb_blocks; x++) {
575 g_hash_table_remove(rdma->blockmap,
576 (void *)(uintptr_t)old[x].offset);
577 g_hash_table_insert(rdma->blockmap,
578 (void *)(uintptr_t)old[x].offset,
579 &local->block[x]);
582 memcpy(local->block, old, sizeof(RDMALocalBlock) * local->nb_blocks);
583 g_free(old);
586 block = &local->block[local->nb_blocks];
588 block->block_name = g_strdup(block_name);
589 block->local_host_addr = host_addr;
590 block->offset = block_offset;
591 block->length = length;
592 block->index = local->nb_blocks;
593 block->src_index = ~0U; /* Filled in by the receipt of the block list */
594 block->nb_chunks = ram_chunk_index(host_addr, host_addr + length) + 1UL;
595 block->transit_bitmap = bitmap_new(block->nb_chunks);
596 bitmap_clear(block->transit_bitmap, 0, block->nb_chunks);
597 block->unregister_bitmap = bitmap_new(block->nb_chunks);
598 bitmap_clear(block->unregister_bitmap, 0, block->nb_chunks);
599 block->remote_keys = g_new0(uint32_t, block->nb_chunks);
601 block->is_ram_block = local->init ? false : true;
603 if (rdma->blockmap) {
604 g_hash_table_insert(rdma->blockmap, (void *)(uintptr_t)block_offset, block);
607 trace_rdma_add_block(block_name, local->nb_blocks,
608 (uintptr_t) block->local_host_addr,
609 block->offset, block->length,
610 (uintptr_t) (block->local_host_addr + block->length),
611 BITS_TO_LONGS(block->nb_chunks) *
612 sizeof(unsigned long) * 8,
613 block->nb_chunks);
615 local->nb_blocks++;
619 * Memory regions need to be registered with the device and queue pairs setup
620 * in advanced before the migration starts. This tells us where the RAM blocks
621 * are so that we can register them individually.
623 static int qemu_rdma_init_one_block(RAMBlock *rb, void *opaque)
625 const char *block_name = qemu_ram_get_idstr(rb);
626 void *host_addr = qemu_ram_get_host_addr(rb);
627 ram_addr_t block_offset = qemu_ram_get_offset(rb);
628 ram_addr_t length = qemu_ram_get_used_length(rb);
629 rdma_add_block(opaque, block_name, host_addr, block_offset, length);
630 return 0;
634 * Identify the RAMBlocks and their quantity. They will be references to
635 * identify chunk boundaries inside each RAMBlock and also be referenced
636 * during dynamic page registration.
638 static void qemu_rdma_init_ram_blocks(RDMAContext *rdma)
640 RDMALocalBlocks *local = &rdma->local_ram_blocks;
641 int ret;
643 assert(rdma->blockmap == NULL);
644 memset(local, 0, sizeof *local);
645 ret = foreach_not_ignored_block(qemu_rdma_init_one_block, rdma);
646 assert(!ret);
647 trace_qemu_rdma_init_ram_blocks(local->nb_blocks);
648 rdma->dest_blocks = g_new0(RDMADestBlock,
649 rdma->local_ram_blocks.nb_blocks);
650 local->init = true;
654 * Note: If used outside of cleanup, the caller must ensure that the destination
655 * block structures are also updated
657 static void rdma_delete_block(RDMAContext *rdma, RDMALocalBlock *block)
659 RDMALocalBlocks *local = &rdma->local_ram_blocks;
660 RDMALocalBlock *old = local->block;
661 int x;
663 if (rdma->blockmap) {
664 g_hash_table_remove(rdma->blockmap, (void *)(uintptr_t)block->offset);
666 if (block->pmr) {
667 int j;
669 for (j = 0; j < block->nb_chunks; j++) {
670 if (!block->pmr[j]) {
671 continue;
673 ibv_dereg_mr(block->pmr[j]);
674 rdma->total_registrations--;
676 g_free(block->pmr);
677 block->pmr = NULL;
680 if (block->mr) {
681 ibv_dereg_mr(block->mr);
682 rdma->total_registrations--;
683 block->mr = NULL;
686 g_free(block->transit_bitmap);
687 block->transit_bitmap = NULL;
689 g_free(block->unregister_bitmap);
690 block->unregister_bitmap = NULL;
692 g_free(block->remote_keys);
693 block->remote_keys = NULL;
695 g_free(block->block_name);
696 block->block_name = NULL;
698 if (rdma->blockmap) {
699 for (x = 0; x < local->nb_blocks; x++) {
700 g_hash_table_remove(rdma->blockmap,
701 (void *)(uintptr_t)old[x].offset);
705 if (local->nb_blocks > 1) {
707 local->block = g_new0(RDMALocalBlock, local->nb_blocks - 1);
709 if (block->index) {
710 memcpy(local->block, old, sizeof(RDMALocalBlock) * block->index);
713 if (block->index < (local->nb_blocks - 1)) {
714 memcpy(local->block + block->index, old + (block->index + 1),
715 sizeof(RDMALocalBlock) *
716 (local->nb_blocks - (block->index + 1)));
717 for (x = block->index; x < local->nb_blocks - 1; x++) {
718 local->block[x].index--;
721 } else {
722 assert(block == local->block);
723 local->block = NULL;
726 trace_rdma_delete_block(block, (uintptr_t)block->local_host_addr,
727 block->offset, block->length,
728 (uintptr_t)(block->local_host_addr + block->length),
729 BITS_TO_LONGS(block->nb_chunks) *
730 sizeof(unsigned long) * 8, block->nb_chunks);
732 g_free(old);
734 local->nb_blocks--;
736 if (local->nb_blocks && rdma->blockmap) {
737 for (x = 0; x < local->nb_blocks; x++) {
738 g_hash_table_insert(rdma->blockmap,
739 (void *)(uintptr_t)local->block[x].offset,
740 &local->block[x]);
746 * Put in the log file which RDMA device was opened and the details
747 * associated with that device.
749 static void qemu_rdma_dump_id(const char *who, struct ibv_context *verbs)
751 struct ibv_port_attr port;
753 if (ibv_query_port(verbs, 1, &port)) {
754 error_report("Failed to query port information");
755 return;
758 printf("%s RDMA Device opened: kernel name %s "
759 "uverbs device name %s, "
760 "infiniband_verbs class device path %s, "
761 "infiniband class device path %s, "
762 "transport: (%d) %s\n",
763 who,
764 verbs->device->name,
765 verbs->device->dev_name,
766 verbs->device->dev_path,
767 verbs->device->ibdev_path,
768 port.link_layer,
769 (port.link_layer == IBV_LINK_LAYER_INFINIBAND) ? "Infiniband" :
770 ((port.link_layer == IBV_LINK_LAYER_ETHERNET)
771 ? "Ethernet" : "Unknown"));
775 * Put in the log file the RDMA gid addressing information,
776 * useful for folks who have trouble understanding the
777 * RDMA device hierarchy in the kernel.
779 static void qemu_rdma_dump_gid(const char *who, struct rdma_cm_id *id)
781 char sgid[33];
782 char dgid[33];
783 inet_ntop(AF_INET6, &id->route.addr.addr.ibaddr.sgid, sgid, sizeof sgid);
784 inet_ntop(AF_INET6, &id->route.addr.addr.ibaddr.dgid, dgid, sizeof dgid);
785 trace_qemu_rdma_dump_gid(who, sgid, dgid);
789 * As of now, IPv6 over RoCE / iWARP is not supported by linux.
790 * We will try the next addrinfo struct, and fail if there are
791 * no other valid addresses to bind against.
793 * If user is listening on '[::]', then we will not have a opened a device
794 * yet and have no way of verifying if the device is RoCE or not.
796 * In this case, the source VM will throw an error for ALL types of
797 * connections (both IPv4 and IPv6) if the destination machine does not have
798 * a regular infiniband network available for use.
800 * The only way to guarantee that an error is thrown for broken kernels is
801 * for the management software to choose a *specific* interface at bind time
802 * and validate what time of hardware it is.
804 * Unfortunately, this puts the user in a fix:
806 * If the source VM connects with an IPv4 address without knowing that the
807 * destination has bound to '[::]' the migration will unconditionally fail
808 * unless the management software is explicitly listening on the IPv4
809 * address while using a RoCE-based device.
811 * If the source VM connects with an IPv6 address, then we're OK because we can
812 * throw an error on the source (and similarly on the destination).
814 * But in mixed environments, this will be broken for a while until it is fixed
815 * inside linux.
817 * We do provide a *tiny* bit of help in this function: We can list all of the
818 * devices in the system and check to see if all the devices are RoCE or
819 * Infiniband.
821 * If we detect that we have a *pure* RoCE environment, then we can safely
822 * thrown an error even if the management software has specified '[::]' as the
823 * bind address.
825 * However, if there is are multiple hetergeneous devices, then we cannot make
826 * this assumption and the user just has to be sure they know what they are
827 * doing.
829 * Patches are being reviewed on linux-rdma.
831 static int qemu_rdma_broken_ipv6_kernel(struct ibv_context *verbs, Error **errp)
833 /* This bug only exists in linux, to our knowledge. */
834 #ifdef CONFIG_LINUX
835 struct ibv_port_attr port_attr;
838 * Verbs are only NULL if management has bound to '[::]'.
840 * Let's iterate through all the devices and see if there any pure IB
841 * devices (non-ethernet).
843 * If not, then we can safely proceed with the migration.
844 * Otherwise, there are no guarantees until the bug is fixed in linux.
846 if (!verbs) {
847 int num_devices, x;
848 struct ibv_device **dev_list = ibv_get_device_list(&num_devices);
849 bool roce_found = false;
850 bool ib_found = false;
852 for (x = 0; x < num_devices; x++) {
853 verbs = ibv_open_device(dev_list[x]);
855 * ibv_open_device() is not documented to set errno. If
856 * it does, it's somebody else's doc bug. If it doesn't,
857 * the use of errno below is wrong.
858 * TODO Find out whether ibv_open_device() sets errno.
860 if (!verbs) {
861 if (errno == EPERM) {
862 continue;
863 } else {
864 error_setg_errno(errp, errno,
865 "could not open RDMA device context");
866 return -EINVAL;
870 if (ibv_query_port(verbs, 1, &port_attr)) {
871 ibv_close_device(verbs);
872 ERROR(errp, "Could not query initial IB port");
873 return -EINVAL;
876 if (port_attr.link_layer == IBV_LINK_LAYER_INFINIBAND) {
877 ib_found = true;
878 } else if (port_attr.link_layer == IBV_LINK_LAYER_ETHERNET) {
879 roce_found = true;
882 ibv_close_device(verbs);
886 if (roce_found) {
887 if (ib_found) {
888 fprintf(stderr, "WARN: migrations may fail:"
889 " IPv6 over RoCE / iWARP in linux"
890 " is broken. But since you appear to have a"
891 " mixed RoCE / IB environment, be sure to only"
892 " migrate over the IB fabric until the kernel "
893 " fixes the bug.\n");
894 } else {
895 ERROR(errp, "You only have RoCE / iWARP devices in your systems"
896 " and your management software has specified '[::]'"
897 ", but IPv6 over RoCE / iWARP is not supported in Linux.");
898 return -ENONET;
902 return 0;
906 * If we have a verbs context, that means that some other than '[::]' was
907 * used by the management software for binding. In which case we can
908 * actually warn the user about a potentially broken kernel.
911 /* IB ports start with 1, not 0 */
912 if (ibv_query_port(verbs, 1, &port_attr)) {
913 ERROR(errp, "Could not query initial IB port");
914 return -EINVAL;
917 if (port_attr.link_layer == IBV_LINK_LAYER_ETHERNET) {
918 ERROR(errp, "Linux kernel's RoCE / iWARP does not support IPv6 "
919 "(but patches on linux-rdma in progress)");
920 return -ENONET;
923 #endif
925 return 0;
929 * Figure out which RDMA device corresponds to the requested IP hostname
930 * Also create the initial connection manager identifiers for opening
931 * the connection.
933 static int qemu_rdma_resolve_host(RDMAContext *rdma, Error **errp)
935 int ret;
936 struct rdma_addrinfo *res;
937 char port_str[16];
938 struct rdma_cm_event *cm_event;
939 char ip[40] = "unknown";
940 struct rdma_addrinfo *e;
942 if (rdma->host == NULL || !strcmp(rdma->host, "")) {
943 ERROR(errp, "RDMA hostname has not been set");
944 return -EINVAL;
947 /* create CM channel */
948 rdma->channel = rdma_create_event_channel();
949 if (!rdma->channel) {
950 ERROR(errp, "could not create CM channel");
951 return -EINVAL;
954 /* create CM id */
955 ret = rdma_create_id(rdma->channel, &rdma->cm_id, NULL, RDMA_PS_TCP);
956 if (ret) {
957 ERROR(errp, "could not create channel id");
958 goto err_resolve_create_id;
961 snprintf(port_str, 16, "%d", rdma->port);
962 port_str[15] = '\0';
964 ret = rdma_getaddrinfo(rdma->host, port_str, NULL, &res);
965 if (ret < 0) {
966 ERROR(errp, "could not rdma_getaddrinfo address %s", rdma->host);
967 goto err_resolve_get_addr;
970 for (e = res; e != NULL; e = e->ai_next) {
971 inet_ntop(e->ai_family,
972 &((struct sockaddr_in *) e->ai_dst_addr)->sin_addr, ip, sizeof ip);
973 trace_qemu_rdma_resolve_host_trying(rdma->host, ip);
975 ret = rdma_resolve_addr(rdma->cm_id, NULL, e->ai_dst_addr,
976 RDMA_RESOLVE_TIMEOUT_MS);
977 if (!ret) {
978 if (e->ai_family == AF_INET6) {
979 ret = qemu_rdma_broken_ipv6_kernel(rdma->cm_id->verbs, errp);
980 if (ret) {
981 continue;
984 goto route;
988 rdma_freeaddrinfo(res);
989 ERROR(errp, "could not resolve address %s", rdma->host);
990 goto err_resolve_get_addr;
992 route:
993 rdma_freeaddrinfo(res);
994 qemu_rdma_dump_gid("source_resolve_addr", rdma->cm_id);
996 ret = rdma_get_cm_event(rdma->channel, &cm_event);
997 if (ret) {
998 ERROR(errp, "could not perform event_addr_resolved");
999 goto err_resolve_get_addr;
1002 if (cm_event->event != RDMA_CM_EVENT_ADDR_RESOLVED) {
1003 ERROR(errp, "result not equal to event_addr_resolved %s",
1004 rdma_event_str(cm_event->event));
1005 error_report("rdma_resolve_addr");
1006 rdma_ack_cm_event(cm_event);
1007 ret = -EINVAL;
1008 goto err_resolve_get_addr;
1010 rdma_ack_cm_event(cm_event);
1012 /* resolve route */
1013 ret = rdma_resolve_route(rdma->cm_id, RDMA_RESOLVE_TIMEOUT_MS);
1014 if (ret) {
1015 ERROR(errp, "could not resolve rdma route");
1016 goto err_resolve_get_addr;
1019 ret = rdma_get_cm_event(rdma->channel, &cm_event);
1020 if (ret) {
1021 ERROR(errp, "could not perform event_route_resolved");
1022 goto err_resolve_get_addr;
1024 if (cm_event->event != RDMA_CM_EVENT_ROUTE_RESOLVED) {
1025 ERROR(errp, "result not equal to event_route_resolved: %s",
1026 rdma_event_str(cm_event->event));
1027 rdma_ack_cm_event(cm_event);
1028 ret = -EINVAL;
1029 goto err_resolve_get_addr;
1031 rdma_ack_cm_event(cm_event);
1032 rdma->verbs = rdma->cm_id->verbs;
1033 qemu_rdma_dump_id("source_resolve_host", rdma->cm_id->verbs);
1034 qemu_rdma_dump_gid("source_resolve_host", rdma->cm_id);
1035 return 0;
1037 err_resolve_get_addr:
1038 rdma_destroy_id(rdma->cm_id);
1039 rdma->cm_id = NULL;
1040 err_resolve_create_id:
1041 rdma_destroy_event_channel(rdma->channel);
1042 rdma->channel = NULL;
1043 return ret;
1047 * Create protection domain and completion queues
1049 static int qemu_rdma_alloc_pd_cq(RDMAContext *rdma)
1051 /* allocate pd */
1052 rdma->pd = ibv_alloc_pd(rdma->verbs);
1053 if (!rdma->pd) {
1054 error_report("failed to allocate protection domain");
1055 return -1;
1058 /* create receive completion channel */
1059 rdma->recv_comp_channel = ibv_create_comp_channel(rdma->verbs);
1060 if (!rdma->recv_comp_channel) {
1061 error_report("failed to allocate receive completion channel");
1062 goto err_alloc_pd_cq;
1066 * Completion queue can be filled by read work requests.
1068 rdma->recv_cq = ibv_create_cq(rdma->verbs, (RDMA_SIGNALED_SEND_MAX * 3),
1069 NULL, rdma->recv_comp_channel, 0);
1070 if (!rdma->recv_cq) {
1071 error_report("failed to allocate receive completion queue");
1072 goto err_alloc_pd_cq;
1075 /* create send completion channel */
1076 rdma->send_comp_channel = ibv_create_comp_channel(rdma->verbs);
1077 if (!rdma->send_comp_channel) {
1078 error_report("failed to allocate send completion channel");
1079 goto err_alloc_pd_cq;
1082 rdma->send_cq = ibv_create_cq(rdma->verbs, (RDMA_SIGNALED_SEND_MAX * 3),
1083 NULL, rdma->send_comp_channel, 0);
1084 if (!rdma->send_cq) {
1085 error_report("failed to allocate send completion queue");
1086 goto err_alloc_pd_cq;
1089 return 0;
1091 err_alloc_pd_cq:
1092 if (rdma->pd) {
1093 ibv_dealloc_pd(rdma->pd);
1095 if (rdma->recv_comp_channel) {
1096 ibv_destroy_comp_channel(rdma->recv_comp_channel);
1098 if (rdma->send_comp_channel) {
1099 ibv_destroy_comp_channel(rdma->send_comp_channel);
1101 if (rdma->recv_cq) {
1102 ibv_destroy_cq(rdma->recv_cq);
1103 rdma->recv_cq = NULL;
1105 rdma->pd = NULL;
1106 rdma->recv_comp_channel = NULL;
1107 rdma->send_comp_channel = NULL;
1108 return -1;
1113 * Create queue pairs.
1115 static int qemu_rdma_alloc_qp(RDMAContext *rdma)
1117 struct ibv_qp_init_attr attr = { 0 };
1118 int ret;
1120 attr.cap.max_send_wr = RDMA_SIGNALED_SEND_MAX;
1121 attr.cap.max_recv_wr = 3;
1122 attr.cap.max_send_sge = 1;
1123 attr.cap.max_recv_sge = 1;
1124 attr.send_cq = rdma->send_cq;
1125 attr.recv_cq = rdma->recv_cq;
1126 attr.qp_type = IBV_QPT_RC;
1128 ret = rdma_create_qp(rdma->cm_id, rdma->pd, &attr);
1129 if (ret) {
1130 return -1;
1133 rdma->qp = rdma->cm_id->qp;
1134 return 0;
1137 /* Check whether On-Demand Paging is supported by RDAM device */
1138 static bool rdma_support_odp(struct ibv_context *dev)
1140 struct ibv_device_attr_ex attr = {0};
1141 int ret = ibv_query_device_ex(dev, NULL, &attr);
1142 if (ret) {
1143 return false;
1146 if (attr.odp_caps.general_caps & IBV_ODP_SUPPORT) {
1147 return true;
1150 return false;
1154 * ibv_advise_mr to avoid RNR NAK error as far as possible.
1155 * The responder mr registering with ODP will sent RNR NAK back to
1156 * the requester in the face of the page fault.
1158 static void qemu_rdma_advise_prefetch_mr(struct ibv_pd *pd, uint64_t addr,
1159 uint32_t len, uint32_t lkey,
1160 const char *name, bool wr)
1162 #ifdef HAVE_IBV_ADVISE_MR
1163 int ret;
1164 int advice = wr ? IBV_ADVISE_MR_ADVICE_PREFETCH_WRITE :
1165 IBV_ADVISE_MR_ADVICE_PREFETCH;
1166 struct ibv_sge sg_list = {.lkey = lkey, .addr = addr, .length = len};
1168 ret = ibv_advise_mr(pd, advice,
1169 IBV_ADVISE_MR_FLAG_FLUSH, &sg_list, 1);
1170 /* ignore the error */
1171 trace_qemu_rdma_advise_mr(name, len, addr, strerror(ret));
1172 #endif
1175 static int qemu_rdma_reg_whole_ram_blocks(RDMAContext *rdma)
1177 int i;
1178 RDMALocalBlocks *local = &rdma->local_ram_blocks;
1180 for (i = 0; i < local->nb_blocks; i++) {
1181 int access = IBV_ACCESS_LOCAL_WRITE | IBV_ACCESS_REMOTE_WRITE;
1183 local->block[i].mr =
1184 ibv_reg_mr(rdma->pd,
1185 local->block[i].local_host_addr,
1186 local->block[i].length, access
1189 * ibv_reg_mr() is not documented to set errno. If it does,
1190 * it's somebody else's doc bug. If it doesn't, the use of
1191 * errno below is wrong.
1192 * TODO Find out whether ibv_reg_mr() sets errno.
1194 if (!local->block[i].mr &&
1195 errno == ENOTSUP && rdma_support_odp(rdma->verbs)) {
1196 access |= IBV_ACCESS_ON_DEMAND;
1197 /* register ODP mr */
1198 local->block[i].mr =
1199 ibv_reg_mr(rdma->pd,
1200 local->block[i].local_host_addr,
1201 local->block[i].length, access);
1202 trace_qemu_rdma_register_odp_mr(local->block[i].block_name);
1204 if (local->block[i].mr) {
1205 qemu_rdma_advise_prefetch_mr(rdma->pd,
1206 (uintptr_t)local->block[i].local_host_addr,
1207 local->block[i].length,
1208 local->block[i].mr->lkey,
1209 local->block[i].block_name,
1210 true);
1214 if (!local->block[i].mr) {
1215 perror("Failed to register local dest ram block!");
1216 break;
1218 rdma->total_registrations++;
1221 if (i >= local->nb_blocks) {
1222 return 0;
1225 for (i--; i >= 0; i--) {
1226 ibv_dereg_mr(local->block[i].mr);
1227 local->block[i].mr = NULL;
1228 rdma->total_registrations--;
1231 return -1;
1236 * Find the ram block that corresponds to the page requested to be
1237 * transmitted by QEMU.
1239 * Once the block is found, also identify which 'chunk' within that
1240 * block that the page belongs to.
1242 static void qemu_rdma_search_ram_block(RDMAContext *rdma,
1243 uintptr_t block_offset,
1244 uint64_t offset,
1245 uint64_t length,
1246 uint64_t *block_index,
1247 uint64_t *chunk_index)
1249 uint64_t current_addr = block_offset + offset;
1250 RDMALocalBlock *block = g_hash_table_lookup(rdma->blockmap,
1251 (void *) block_offset);
1252 assert(block);
1253 assert(current_addr >= block->offset);
1254 assert((current_addr + length) <= (block->offset + block->length));
1256 *block_index = block->index;
1257 *chunk_index = ram_chunk_index(block->local_host_addr,
1258 block->local_host_addr + (current_addr - block->offset));
1262 * Register a chunk with IB. If the chunk was already registered
1263 * previously, then skip.
1265 * Also return the keys associated with the registration needed
1266 * to perform the actual RDMA operation.
1268 static int qemu_rdma_register_and_get_keys(RDMAContext *rdma,
1269 RDMALocalBlock *block, uintptr_t host_addr,
1270 uint32_t *lkey, uint32_t *rkey, int chunk,
1271 uint8_t *chunk_start, uint8_t *chunk_end)
1273 if (block->mr) {
1274 if (lkey) {
1275 *lkey = block->mr->lkey;
1277 if (rkey) {
1278 *rkey = block->mr->rkey;
1280 return 0;
1283 /* allocate memory to store chunk MRs */
1284 if (!block->pmr) {
1285 block->pmr = g_new0(struct ibv_mr *, block->nb_chunks);
1289 * If 'rkey', then we're the destination, so grant access to the source.
1291 * If 'lkey', then we're the source VM, so grant access only to ourselves.
1293 if (!block->pmr[chunk]) {
1294 uint64_t len = chunk_end - chunk_start;
1295 int access = rkey ? IBV_ACCESS_LOCAL_WRITE | IBV_ACCESS_REMOTE_WRITE :
1298 trace_qemu_rdma_register_and_get_keys(len, chunk_start);
1300 block->pmr[chunk] = ibv_reg_mr(rdma->pd, chunk_start, len, access);
1302 * ibv_reg_mr() is not documented to set errno. If it does,
1303 * it's somebody else's doc bug. If it doesn't, the use of
1304 * errno below is wrong.
1305 * TODO Find out whether ibv_reg_mr() sets errno.
1307 if (!block->pmr[chunk] &&
1308 errno == ENOTSUP && rdma_support_odp(rdma->verbs)) {
1309 access |= IBV_ACCESS_ON_DEMAND;
1310 /* register ODP mr */
1311 block->pmr[chunk] = ibv_reg_mr(rdma->pd, chunk_start, len, access);
1312 trace_qemu_rdma_register_odp_mr(block->block_name);
1314 if (block->pmr[chunk]) {
1315 qemu_rdma_advise_prefetch_mr(rdma->pd, (uintptr_t)chunk_start,
1316 len, block->pmr[chunk]->lkey,
1317 block->block_name, rkey);
1322 if (!block->pmr[chunk]) {
1323 perror("Failed to register chunk!");
1324 fprintf(stderr, "Chunk details: block: %d chunk index %d"
1325 " start %" PRIuPTR " end %" PRIuPTR
1326 " host %" PRIuPTR
1327 " local %" PRIuPTR " registrations: %d\n",
1328 block->index, chunk, (uintptr_t)chunk_start,
1329 (uintptr_t)chunk_end, host_addr,
1330 (uintptr_t)block->local_host_addr,
1331 rdma->total_registrations);
1332 return -1;
1334 rdma->total_registrations++;
1336 if (lkey) {
1337 *lkey = block->pmr[chunk]->lkey;
1339 if (rkey) {
1340 *rkey = block->pmr[chunk]->rkey;
1342 return 0;
1346 * Register (at connection time) the memory used for control
1347 * channel messages.
1349 static int qemu_rdma_reg_control(RDMAContext *rdma, int idx)
1351 rdma->wr_data[idx].control_mr = ibv_reg_mr(rdma->pd,
1352 rdma->wr_data[idx].control, RDMA_CONTROL_MAX_BUFFER,
1353 IBV_ACCESS_LOCAL_WRITE | IBV_ACCESS_REMOTE_WRITE);
1354 if (rdma->wr_data[idx].control_mr) {
1355 rdma->total_registrations++;
1356 return 0;
1358 error_report("qemu_rdma_reg_control failed");
1359 return -1;
1363 * Perform a non-optimized memory unregistration after every transfer
1364 * for demonstration purposes, only if pin-all is not requested.
1366 * Potential optimizations:
1367 * 1. Start a new thread to run this function continuously
1368 - for bit clearing
1369 - and for receipt of unregister messages
1370 * 2. Use an LRU.
1371 * 3. Use workload hints.
1373 static int qemu_rdma_unregister_waiting(RDMAContext *rdma)
1375 while (rdma->unregistrations[rdma->unregister_current]) {
1376 int ret;
1377 uint64_t wr_id = rdma->unregistrations[rdma->unregister_current];
1378 uint64_t chunk =
1379 (wr_id & RDMA_WRID_CHUNK_MASK) >> RDMA_WRID_CHUNK_SHIFT;
1380 uint64_t index =
1381 (wr_id & RDMA_WRID_BLOCK_MASK) >> RDMA_WRID_BLOCK_SHIFT;
1382 RDMALocalBlock *block =
1383 &(rdma->local_ram_blocks.block[index]);
1384 RDMARegister reg = { .current_index = index };
1385 RDMAControlHeader resp = { .type = RDMA_CONTROL_UNREGISTER_FINISHED,
1387 RDMAControlHeader head = { .len = sizeof(RDMARegister),
1388 .type = RDMA_CONTROL_UNREGISTER_REQUEST,
1389 .repeat = 1,
1392 trace_qemu_rdma_unregister_waiting_proc(chunk,
1393 rdma->unregister_current);
1395 rdma->unregistrations[rdma->unregister_current] = 0;
1396 rdma->unregister_current++;
1398 if (rdma->unregister_current == RDMA_SIGNALED_SEND_MAX) {
1399 rdma->unregister_current = 0;
1404 * Unregistration is speculative (because migration is single-threaded
1405 * and we cannot break the protocol's inifinband message ordering).
1406 * Thus, if the memory is currently being used for transmission,
1407 * then abort the attempt to unregister and try again
1408 * later the next time a completion is received for this memory.
1410 clear_bit(chunk, block->unregister_bitmap);
1412 if (test_bit(chunk, block->transit_bitmap)) {
1413 trace_qemu_rdma_unregister_waiting_inflight(chunk);
1414 continue;
1417 trace_qemu_rdma_unregister_waiting_send(chunk);
1419 ret = ibv_dereg_mr(block->pmr[chunk]);
1420 block->pmr[chunk] = NULL;
1421 block->remote_keys[chunk] = 0;
1423 if (ret != 0) {
1425 * FIXME perror() is problematic, bcause ibv_dereg_mr() is
1426 * not documented to set errno. Will go away later in
1427 * this series.
1429 perror("unregistration chunk failed");
1430 return -ret;
1432 rdma->total_registrations--;
1434 reg.key.chunk = chunk;
1435 register_to_network(rdma, &reg);
1436 ret = qemu_rdma_exchange_send(rdma, &head, (uint8_t *) &reg,
1437 &resp, NULL, NULL);
1438 if (ret < 0) {
1439 return ret;
1442 trace_qemu_rdma_unregister_waiting_complete(chunk);
1445 return 0;
1448 static uint64_t qemu_rdma_make_wrid(uint64_t wr_id, uint64_t index,
1449 uint64_t chunk)
1451 uint64_t result = wr_id & RDMA_WRID_TYPE_MASK;
1453 result |= (index << RDMA_WRID_BLOCK_SHIFT);
1454 result |= (chunk << RDMA_WRID_CHUNK_SHIFT);
1456 return result;
1460 * Consult the connection manager to see a work request
1461 * (of any kind) has completed.
1462 * Return the work request ID that completed.
1464 static int qemu_rdma_poll(RDMAContext *rdma, struct ibv_cq *cq,
1465 uint64_t *wr_id_out, uint32_t *byte_len)
1467 int ret;
1468 struct ibv_wc wc;
1469 uint64_t wr_id;
1471 ret = ibv_poll_cq(cq, 1, &wc);
1473 if (!ret) {
1474 *wr_id_out = RDMA_WRID_NONE;
1475 return 0;
1478 if (ret < 0) {
1479 error_report("ibv_poll_cq failed");
1480 return ret;
1483 wr_id = wc.wr_id & RDMA_WRID_TYPE_MASK;
1485 if (wc.status != IBV_WC_SUCCESS) {
1486 fprintf(stderr, "ibv_poll_cq wc.status=%d %s!\n",
1487 wc.status, ibv_wc_status_str(wc.status));
1488 fprintf(stderr, "ibv_poll_cq wrid=%" PRIu64 "!\n", wr_id);
1490 return -1;
1493 if (rdma->control_ready_expected &&
1494 (wr_id >= RDMA_WRID_RECV_CONTROL)) {
1495 trace_qemu_rdma_poll_recv(wr_id - RDMA_WRID_RECV_CONTROL, wr_id,
1496 rdma->nb_sent);
1497 rdma->control_ready_expected = 0;
1500 if (wr_id == RDMA_WRID_RDMA_WRITE) {
1501 uint64_t chunk =
1502 (wc.wr_id & RDMA_WRID_CHUNK_MASK) >> RDMA_WRID_CHUNK_SHIFT;
1503 uint64_t index =
1504 (wc.wr_id & RDMA_WRID_BLOCK_MASK) >> RDMA_WRID_BLOCK_SHIFT;
1505 RDMALocalBlock *block = &(rdma->local_ram_blocks.block[index]);
1507 trace_qemu_rdma_poll_write(wr_id, rdma->nb_sent,
1508 index, chunk, block->local_host_addr,
1509 (void *)(uintptr_t)block->remote_host_addr);
1511 clear_bit(chunk, block->transit_bitmap);
1513 if (rdma->nb_sent > 0) {
1514 rdma->nb_sent--;
1516 } else {
1517 trace_qemu_rdma_poll_other(wr_id, rdma->nb_sent);
1520 *wr_id_out = wc.wr_id;
1521 if (byte_len) {
1522 *byte_len = wc.byte_len;
1525 return 0;
1528 /* Wait for activity on the completion channel.
1529 * Returns 0 on success, none-0 on error.
1531 static int qemu_rdma_wait_comp_channel(RDMAContext *rdma,
1532 struct ibv_comp_channel *comp_channel)
1534 struct rdma_cm_event *cm_event;
1535 int ret = -1;
1538 * Coroutine doesn't start until migration_fd_process_incoming()
1539 * so don't yield unless we know we're running inside of a coroutine.
1541 if (rdma->migration_started_on_destination &&
1542 migration_incoming_get_current()->state == MIGRATION_STATUS_ACTIVE) {
1543 yield_until_fd_readable(comp_channel->fd);
1544 } else {
1545 /* This is the source side, we're in a separate thread
1546 * or destination prior to migration_fd_process_incoming()
1547 * after postcopy, the destination also in a separate thread.
1548 * we can't yield; so we have to poll the fd.
1549 * But we need to be able to handle 'cancel' or an error
1550 * without hanging forever.
1552 while (!rdma->error_state && !rdma->received_error) {
1553 GPollFD pfds[2];
1554 pfds[0].fd = comp_channel->fd;
1555 pfds[0].events = G_IO_IN | G_IO_HUP | G_IO_ERR;
1556 pfds[0].revents = 0;
1558 pfds[1].fd = rdma->channel->fd;
1559 pfds[1].events = G_IO_IN | G_IO_HUP | G_IO_ERR;
1560 pfds[1].revents = 0;
1562 /* 0.1s timeout, should be fine for a 'cancel' */
1563 switch (qemu_poll_ns(pfds, 2, 100 * 1000 * 1000)) {
1564 case 2:
1565 case 1: /* fd active */
1566 if (pfds[0].revents) {
1567 return 0;
1570 if (pfds[1].revents) {
1571 ret = rdma_get_cm_event(rdma->channel, &cm_event);
1572 if (ret) {
1573 error_report("failed to get cm event while wait "
1574 "completion channel");
1575 return -EPIPE;
1578 error_report("receive cm event while wait comp channel,"
1579 "cm event is %d", cm_event->event);
1580 if (cm_event->event == RDMA_CM_EVENT_DISCONNECTED ||
1581 cm_event->event == RDMA_CM_EVENT_DEVICE_REMOVAL) {
1582 rdma_ack_cm_event(cm_event);
1583 return -EPIPE;
1585 rdma_ack_cm_event(cm_event);
1587 break;
1589 case 0: /* Timeout, go around again */
1590 break;
1592 default: /* Error of some type -
1593 * I don't trust errno from qemu_poll_ns
1595 error_report("%s: poll failed", __func__);
1596 return -EPIPE;
1599 if (migrate_get_current()->state == MIGRATION_STATUS_CANCELLING) {
1600 /* Bail out and let the cancellation happen */
1601 return -EPIPE;
1606 if (rdma->received_error) {
1607 return -EPIPE;
1609 return rdma->error_state;
1612 static struct ibv_comp_channel *to_channel(RDMAContext *rdma, uint64_t wrid)
1614 return wrid < RDMA_WRID_RECV_CONTROL ? rdma->send_comp_channel :
1615 rdma->recv_comp_channel;
1618 static struct ibv_cq *to_cq(RDMAContext *rdma, uint64_t wrid)
1620 return wrid < RDMA_WRID_RECV_CONTROL ? rdma->send_cq : rdma->recv_cq;
1624 * Block until the next work request has completed.
1626 * First poll to see if a work request has already completed,
1627 * otherwise block.
1629 * If we encounter completed work requests for IDs other than
1630 * the one we're interested in, then that's generally an error.
1632 * The only exception is actual RDMA Write completions. These
1633 * completions only need to be recorded, but do not actually
1634 * need further processing.
1636 static int qemu_rdma_block_for_wrid(RDMAContext *rdma,
1637 uint64_t wrid_requested,
1638 uint32_t *byte_len)
1640 int num_cq_events = 0, ret = 0;
1641 struct ibv_cq *cq;
1642 void *cq_ctx;
1643 uint64_t wr_id = RDMA_WRID_NONE, wr_id_in;
1644 struct ibv_comp_channel *ch = to_channel(rdma, wrid_requested);
1645 struct ibv_cq *poll_cq = to_cq(rdma, wrid_requested);
1647 if (ibv_req_notify_cq(poll_cq, 0)) {
1648 return -1;
1650 /* poll cq first */
1651 while (wr_id != wrid_requested) {
1652 ret = qemu_rdma_poll(rdma, poll_cq, &wr_id_in, byte_len);
1653 if (ret < 0) {
1654 return ret;
1657 wr_id = wr_id_in & RDMA_WRID_TYPE_MASK;
1659 if (wr_id == RDMA_WRID_NONE) {
1660 break;
1662 if (wr_id != wrid_requested) {
1663 trace_qemu_rdma_block_for_wrid_miss(wrid_requested, wr_id);
1667 if (wr_id == wrid_requested) {
1668 return 0;
1671 while (1) {
1672 ret = qemu_rdma_wait_comp_channel(rdma, ch);
1673 if (ret) {
1674 goto err_block_for_wrid;
1677 ret = ibv_get_cq_event(ch, &cq, &cq_ctx);
1678 if (ret) {
1680 * FIXME perror() is problematic, because ibv_reg_mr() is
1681 * not documented to set errno. Will go away later in
1682 * this series.
1684 perror("ibv_get_cq_event");
1685 goto err_block_for_wrid;
1688 num_cq_events++;
1690 ret = -ibv_req_notify_cq(cq, 0);
1691 if (ret) {
1692 goto err_block_for_wrid;
1695 while (wr_id != wrid_requested) {
1696 ret = qemu_rdma_poll(rdma, poll_cq, &wr_id_in, byte_len);
1697 if (ret < 0) {
1698 goto err_block_for_wrid;
1701 wr_id = wr_id_in & RDMA_WRID_TYPE_MASK;
1703 if (wr_id == RDMA_WRID_NONE) {
1704 break;
1706 if (wr_id != wrid_requested) {
1707 trace_qemu_rdma_block_for_wrid_miss(wrid_requested, wr_id);
1711 if (wr_id == wrid_requested) {
1712 goto success_block_for_wrid;
1716 success_block_for_wrid:
1717 if (num_cq_events) {
1718 ibv_ack_cq_events(cq, num_cq_events);
1720 return 0;
1722 err_block_for_wrid:
1723 if (num_cq_events) {
1724 ibv_ack_cq_events(cq, num_cq_events);
1727 rdma->error_state = ret;
1728 return ret;
1732 * Post a SEND message work request for the control channel
1733 * containing some data and block until the post completes.
1735 static int qemu_rdma_post_send_control(RDMAContext *rdma, uint8_t *buf,
1736 RDMAControlHeader *head)
1738 int ret = 0;
1739 RDMAWorkRequestData *wr = &rdma->wr_data[RDMA_WRID_CONTROL];
1740 struct ibv_send_wr *bad_wr;
1741 struct ibv_sge sge = {
1742 .addr = (uintptr_t)(wr->control),
1743 .length = head->len + sizeof(RDMAControlHeader),
1744 .lkey = wr->control_mr->lkey,
1746 struct ibv_send_wr send_wr = {
1747 .wr_id = RDMA_WRID_SEND_CONTROL,
1748 .opcode = IBV_WR_SEND,
1749 .send_flags = IBV_SEND_SIGNALED,
1750 .sg_list = &sge,
1751 .num_sge = 1,
1754 trace_qemu_rdma_post_send_control(control_desc(head->type));
1757 * We don't actually need to do a memcpy() in here if we used
1758 * the "sge" properly, but since we're only sending control messages
1759 * (not RAM in a performance-critical path), then its OK for now.
1761 * The copy makes the RDMAControlHeader simpler to manipulate
1762 * for the time being.
1764 assert(head->len <= RDMA_CONTROL_MAX_BUFFER - sizeof(*head));
1765 memcpy(wr->control, head, sizeof(RDMAControlHeader));
1766 control_to_network((void *) wr->control);
1768 if (buf) {
1769 memcpy(wr->control + sizeof(RDMAControlHeader), buf, head->len);
1773 ret = ibv_post_send(rdma->qp, &send_wr, &bad_wr);
1775 if (ret > 0) {
1776 error_report("Failed to use post IB SEND for control");
1777 return -ret;
1780 ret = qemu_rdma_block_for_wrid(rdma, RDMA_WRID_SEND_CONTROL, NULL);
1781 if (ret < 0) {
1782 error_report("rdma migration: send polling control error");
1785 return ret;
1789 * Post a RECV work request in anticipation of some future receipt
1790 * of data on the control channel.
1792 static int qemu_rdma_post_recv_control(RDMAContext *rdma, int idx)
1794 struct ibv_recv_wr *bad_wr;
1795 struct ibv_sge sge = {
1796 .addr = (uintptr_t)(rdma->wr_data[idx].control),
1797 .length = RDMA_CONTROL_MAX_BUFFER,
1798 .lkey = rdma->wr_data[idx].control_mr->lkey,
1801 struct ibv_recv_wr recv_wr = {
1802 .wr_id = RDMA_WRID_RECV_CONTROL + idx,
1803 .sg_list = &sge,
1804 .num_sge = 1,
1808 if (ibv_post_recv(rdma->qp, &recv_wr, &bad_wr)) {
1809 return -1;
1812 return 0;
1816 * Block and wait for a RECV control channel message to arrive.
1818 static int qemu_rdma_exchange_get_response(RDMAContext *rdma,
1819 RDMAControlHeader *head, uint32_t expecting, int idx)
1821 uint32_t byte_len;
1822 int ret = qemu_rdma_block_for_wrid(rdma, RDMA_WRID_RECV_CONTROL + idx,
1823 &byte_len);
1825 if (ret < 0) {
1826 error_report("rdma migration: recv polling control error!");
1827 return ret;
1830 network_to_control((void *) rdma->wr_data[idx].control);
1831 memcpy(head, rdma->wr_data[idx].control, sizeof(RDMAControlHeader));
1833 trace_qemu_rdma_exchange_get_response_start(control_desc(expecting));
1835 if (expecting == RDMA_CONTROL_NONE) {
1836 trace_qemu_rdma_exchange_get_response_none(control_desc(head->type),
1837 head->type);
1838 } else if (head->type != expecting || head->type == RDMA_CONTROL_ERROR) {
1839 error_report("Was expecting a %s (%d) control message"
1840 ", but got: %s (%d), length: %d",
1841 control_desc(expecting), expecting,
1842 control_desc(head->type), head->type, head->len);
1843 if (head->type == RDMA_CONTROL_ERROR) {
1844 rdma->received_error = true;
1846 return -EIO;
1848 if (head->len > RDMA_CONTROL_MAX_BUFFER - sizeof(*head)) {
1849 error_report("too long length: %d", head->len);
1850 return -EINVAL;
1852 if (sizeof(*head) + head->len != byte_len) {
1853 error_report("Malformed length: %d byte_len %d", head->len, byte_len);
1854 return -EINVAL;
1857 return 0;
1861 * When a RECV work request has completed, the work request's
1862 * buffer is pointed at the header.
1864 * This will advance the pointer to the data portion
1865 * of the control message of the work request's buffer that
1866 * was populated after the work request finished.
1868 static void qemu_rdma_move_header(RDMAContext *rdma, int idx,
1869 RDMAControlHeader *head)
1871 rdma->wr_data[idx].control_len = head->len;
1872 rdma->wr_data[idx].control_curr =
1873 rdma->wr_data[idx].control + sizeof(RDMAControlHeader);
1877 * This is an 'atomic' high-level operation to deliver a single, unified
1878 * control-channel message.
1880 * Additionally, if the user is expecting some kind of reply to this message,
1881 * they can request a 'resp' response message be filled in by posting an
1882 * additional work request on behalf of the user and waiting for an additional
1883 * completion.
1885 * The extra (optional) response is used during registration to us from having
1886 * to perform an *additional* exchange of message just to provide a response by
1887 * instead piggy-backing on the acknowledgement.
1889 static int qemu_rdma_exchange_send(RDMAContext *rdma, RDMAControlHeader *head,
1890 uint8_t *data, RDMAControlHeader *resp,
1891 int *resp_idx,
1892 int (*callback)(RDMAContext *rdma))
1894 int ret = 0;
1897 * Wait until the dest is ready before attempting to deliver the message
1898 * by waiting for a READY message.
1900 if (rdma->control_ready_expected) {
1901 RDMAControlHeader resp_ignored;
1903 ret = qemu_rdma_exchange_get_response(rdma, &resp_ignored,
1904 RDMA_CONTROL_READY,
1905 RDMA_WRID_READY);
1906 if (ret < 0) {
1907 return ret;
1912 * If the user is expecting a response, post a WR in anticipation of it.
1914 if (resp) {
1915 ret = qemu_rdma_post_recv_control(rdma, RDMA_WRID_DATA);
1916 if (ret) {
1917 error_report("rdma migration: error posting"
1918 " extra control recv for anticipated result!");
1919 return ret;
1924 * Post a WR to replace the one we just consumed for the READY message.
1926 ret = qemu_rdma_post_recv_control(rdma, RDMA_WRID_READY);
1927 if (ret) {
1928 error_report("rdma migration: error posting first control recv!");
1929 return ret;
1933 * Deliver the control message that was requested.
1935 ret = qemu_rdma_post_send_control(rdma, data, head);
1937 if (ret < 0) {
1938 error_report("Failed to send control buffer!");
1939 return ret;
1943 * If we're expecting a response, block and wait for it.
1945 if (resp) {
1946 if (callback) {
1947 trace_qemu_rdma_exchange_send_issue_callback();
1948 ret = callback(rdma);
1949 if (ret < 0) {
1950 return ret;
1954 trace_qemu_rdma_exchange_send_waiting(control_desc(resp->type));
1955 ret = qemu_rdma_exchange_get_response(rdma, resp,
1956 resp->type, RDMA_WRID_DATA);
1958 if (ret < 0) {
1959 return ret;
1962 qemu_rdma_move_header(rdma, RDMA_WRID_DATA, resp);
1963 if (resp_idx) {
1964 *resp_idx = RDMA_WRID_DATA;
1966 trace_qemu_rdma_exchange_send_received(control_desc(resp->type));
1969 rdma->control_ready_expected = 1;
1971 return 0;
1975 * This is an 'atomic' high-level operation to receive a single, unified
1976 * control-channel message.
1978 static int qemu_rdma_exchange_recv(RDMAContext *rdma, RDMAControlHeader *head,
1979 uint32_t expecting)
1981 RDMAControlHeader ready = {
1982 .len = 0,
1983 .type = RDMA_CONTROL_READY,
1984 .repeat = 1,
1986 int ret;
1989 * Inform the source that we're ready to receive a message.
1991 ret = qemu_rdma_post_send_control(rdma, NULL, &ready);
1993 if (ret < 0) {
1994 error_report("Failed to send control buffer!");
1995 return ret;
1999 * Block and wait for the message.
2001 ret = qemu_rdma_exchange_get_response(rdma, head,
2002 expecting, RDMA_WRID_READY);
2004 if (ret < 0) {
2005 return ret;
2008 qemu_rdma_move_header(rdma, RDMA_WRID_READY, head);
2011 * Post a new RECV work request to replace the one we just consumed.
2013 ret = qemu_rdma_post_recv_control(rdma, RDMA_WRID_READY);
2014 if (ret) {
2015 error_report("rdma migration: error posting second control recv!");
2016 return ret;
2019 return 0;
2023 * Write an actual chunk of memory using RDMA.
2025 * If we're using dynamic registration on the dest-side, we have to
2026 * send a registration command first.
2028 static int qemu_rdma_write_one(RDMAContext *rdma,
2029 int current_index, uint64_t current_addr,
2030 uint64_t length)
2032 struct ibv_sge sge;
2033 struct ibv_send_wr send_wr = { 0 };
2034 struct ibv_send_wr *bad_wr;
2035 int reg_result_idx, ret, count = 0;
2036 uint64_t chunk, chunks;
2037 uint8_t *chunk_start, *chunk_end;
2038 RDMALocalBlock *block = &(rdma->local_ram_blocks.block[current_index]);
2039 RDMARegister reg;
2040 RDMARegisterResult *reg_result;
2041 RDMAControlHeader resp = { .type = RDMA_CONTROL_REGISTER_RESULT };
2042 RDMAControlHeader head = { .len = sizeof(RDMARegister),
2043 .type = RDMA_CONTROL_REGISTER_REQUEST,
2044 .repeat = 1,
2047 retry:
2048 sge.addr = (uintptr_t)(block->local_host_addr +
2049 (current_addr - block->offset));
2050 sge.length = length;
2052 chunk = ram_chunk_index(block->local_host_addr,
2053 (uint8_t *)(uintptr_t)sge.addr);
2054 chunk_start = ram_chunk_start(block, chunk);
2056 if (block->is_ram_block) {
2057 chunks = length / (1UL << RDMA_REG_CHUNK_SHIFT);
2059 if (chunks && ((length % (1UL << RDMA_REG_CHUNK_SHIFT)) == 0)) {
2060 chunks--;
2062 } else {
2063 chunks = block->length / (1UL << RDMA_REG_CHUNK_SHIFT);
2065 if (chunks && ((block->length % (1UL << RDMA_REG_CHUNK_SHIFT)) == 0)) {
2066 chunks--;
2070 trace_qemu_rdma_write_one_top(chunks + 1,
2071 (chunks + 1) *
2072 (1UL << RDMA_REG_CHUNK_SHIFT) / 1024 / 1024);
2074 chunk_end = ram_chunk_end(block, chunk + chunks);
2077 while (test_bit(chunk, block->transit_bitmap)) {
2078 (void)count;
2079 trace_qemu_rdma_write_one_block(count++, current_index, chunk,
2080 sge.addr, length, rdma->nb_sent, block->nb_chunks);
2082 ret = qemu_rdma_block_for_wrid(rdma, RDMA_WRID_RDMA_WRITE, NULL);
2084 if (ret < 0) {
2085 error_report("Failed to Wait for previous write to complete "
2086 "block %d chunk %" PRIu64
2087 " current %" PRIu64 " len %" PRIu64 " %d",
2088 current_index, chunk, sge.addr, length, rdma->nb_sent);
2089 return ret;
2093 if (!rdma->pin_all || !block->is_ram_block) {
2094 if (!block->remote_keys[chunk]) {
2096 * This chunk has not yet been registered, so first check to see
2097 * if the entire chunk is zero. If so, tell the other size to
2098 * memset() + madvise() the entire chunk without RDMA.
2101 if (buffer_is_zero((void *)(uintptr_t)sge.addr, length)) {
2102 RDMACompress comp = {
2103 .offset = current_addr,
2104 .value = 0,
2105 .block_idx = current_index,
2106 .length = length,
2109 head.len = sizeof(comp);
2110 head.type = RDMA_CONTROL_COMPRESS;
2112 trace_qemu_rdma_write_one_zero(chunk, sge.length,
2113 current_index, current_addr);
2115 compress_to_network(rdma, &comp);
2116 ret = qemu_rdma_exchange_send(rdma, &head,
2117 (uint8_t *) &comp, NULL, NULL, NULL);
2119 if (ret < 0) {
2120 return -EIO;
2124 * TODO: Here we are sending something, but we are not
2125 * accounting for anything transferred. The following is wrong:
2127 * stat64_add(&mig_stats.rdma_bytes, sge.length);
2129 * because we are using some kind of compression. I
2130 * would think that head.len would be the more similar
2131 * thing to a correct value.
2133 stat64_add(&mig_stats.zero_pages,
2134 sge.length / qemu_target_page_size());
2135 return 1;
2139 * Otherwise, tell other side to register.
2141 reg.current_index = current_index;
2142 if (block->is_ram_block) {
2143 reg.key.current_addr = current_addr;
2144 } else {
2145 reg.key.chunk = chunk;
2147 reg.chunks = chunks;
2149 trace_qemu_rdma_write_one_sendreg(chunk, sge.length, current_index,
2150 current_addr);
2152 register_to_network(rdma, &reg);
2153 ret = qemu_rdma_exchange_send(rdma, &head, (uint8_t *) &reg,
2154 &resp, &reg_result_idx, NULL);
2155 if (ret < 0) {
2156 return ret;
2159 /* try to overlap this single registration with the one we sent. */
2160 if (qemu_rdma_register_and_get_keys(rdma, block, sge.addr,
2161 &sge.lkey, NULL, chunk,
2162 chunk_start, chunk_end)) {
2163 error_report("cannot get lkey");
2164 return -EINVAL;
2167 reg_result = (RDMARegisterResult *)
2168 rdma->wr_data[reg_result_idx].control_curr;
2170 network_to_result(reg_result);
2172 trace_qemu_rdma_write_one_recvregres(block->remote_keys[chunk],
2173 reg_result->rkey, chunk);
2175 block->remote_keys[chunk] = reg_result->rkey;
2176 block->remote_host_addr = reg_result->host_addr;
2177 } else {
2178 /* already registered before */
2179 if (qemu_rdma_register_and_get_keys(rdma, block, sge.addr,
2180 &sge.lkey, NULL, chunk,
2181 chunk_start, chunk_end)) {
2182 error_report("cannot get lkey!");
2183 return -EINVAL;
2187 send_wr.wr.rdma.rkey = block->remote_keys[chunk];
2188 } else {
2189 send_wr.wr.rdma.rkey = block->remote_rkey;
2191 if (qemu_rdma_register_and_get_keys(rdma, block, sge.addr,
2192 &sge.lkey, NULL, chunk,
2193 chunk_start, chunk_end)) {
2194 error_report("cannot get lkey!");
2195 return -EINVAL;
2200 * Encode the ram block index and chunk within this wrid.
2201 * We will use this information at the time of completion
2202 * to figure out which bitmap to check against and then which
2203 * chunk in the bitmap to look for.
2205 send_wr.wr_id = qemu_rdma_make_wrid(RDMA_WRID_RDMA_WRITE,
2206 current_index, chunk);
2208 send_wr.opcode = IBV_WR_RDMA_WRITE;
2209 send_wr.send_flags = IBV_SEND_SIGNALED;
2210 send_wr.sg_list = &sge;
2211 send_wr.num_sge = 1;
2212 send_wr.wr.rdma.remote_addr = block->remote_host_addr +
2213 (current_addr - block->offset);
2215 trace_qemu_rdma_write_one_post(chunk, sge.addr, send_wr.wr.rdma.remote_addr,
2216 sge.length);
2219 * ibv_post_send() does not return negative error numbers,
2220 * per the specification they are positive - no idea why.
2222 ret = ibv_post_send(rdma->qp, &send_wr, &bad_wr);
2224 if (ret == ENOMEM) {
2225 trace_qemu_rdma_write_one_queue_full();
2226 ret = qemu_rdma_block_for_wrid(rdma, RDMA_WRID_RDMA_WRITE, NULL);
2227 if (ret < 0) {
2228 error_report("rdma migration: failed to make "
2229 "room in full send queue!");
2230 return ret;
2233 goto retry;
2235 } else if (ret > 0) {
2237 * FIXME perror() is problematic, because whether
2238 * ibv_post_send() sets errno is unclear. Will go away later
2239 * in this series.
2241 perror("rdma migration: post rdma write failed");
2242 return -ret;
2245 set_bit(chunk, block->transit_bitmap);
2246 stat64_add(&mig_stats.normal_pages, sge.length / qemu_target_page_size());
2248 * We are adding to transferred the amount of data written, but no
2249 * overhead at all. I will asume that RDMA is magicaly and don't
2250 * need to transfer (at least) the addresses where it wants to
2251 * write the pages. Here it looks like it should be something
2252 * like:
2253 * sizeof(send_wr) + sge.length
2254 * but this being RDMA, who knows.
2256 stat64_add(&mig_stats.rdma_bytes, sge.length);
2257 ram_transferred_add(sge.length);
2258 rdma->total_writes++;
2260 return 0;
2264 * Push out any unwritten RDMA operations.
2266 * We support sending out multiple chunks at the same time.
2267 * Not all of them need to get signaled in the completion queue.
2269 static int qemu_rdma_write_flush(RDMAContext *rdma)
2271 int ret;
2273 if (!rdma->current_length) {
2274 return 0;
2277 ret = qemu_rdma_write_one(rdma,
2278 rdma->current_index, rdma->current_addr, rdma->current_length);
2280 if (ret < 0) {
2281 return ret;
2284 if (ret == 0) {
2285 rdma->nb_sent++;
2286 trace_qemu_rdma_write_flush(rdma->nb_sent);
2289 rdma->current_length = 0;
2290 rdma->current_addr = 0;
2292 return 0;
2295 static inline bool qemu_rdma_buffer_mergeable(RDMAContext *rdma,
2296 uint64_t offset, uint64_t len)
2298 RDMALocalBlock *block;
2299 uint8_t *host_addr;
2300 uint8_t *chunk_end;
2302 if (rdma->current_index < 0) {
2303 return false;
2306 if (rdma->current_chunk < 0) {
2307 return false;
2310 block = &(rdma->local_ram_blocks.block[rdma->current_index]);
2311 host_addr = block->local_host_addr + (offset - block->offset);
2312 chunk_end = ram_chunk_end(block, rdma->current_chunk);
2314 if (rdma->current_length == 0) {
2315 return false;
2319 * Only merge into chunk sequentially.
2321 if (offset != (rdma->current_addr + rdma->current_length)) {
2322 return false;
2325 if (offset < block->offset) {
2326 return false;
2329 if ((offset + len) > (block->offset + block->length)) {
2330 return false;
2333 if ((host_addr + len) > chunk_end) {
2334 return false;
2337 return true;
2341 * We're not actually writing here, but doing three things:
2343 * 1. Identify the chunk the buffer belongs to.
2344 * 2. If the chunk is full or the buffer doesn't belong to the current
2345 * chunk, then start a new chunk and flush() the old chunk.
2346 * 3. To keep the hardware busy, we also group chunks into batches
2347 * and only require that a batch gets acknowledged in the completion
2348 * queue instead of each individual chunk.
2350 static int qemu_rdma_write(RDMAContext *rdma,
2351 uint64_t block_offset, uint64_t offset,
2352 uint64_t len)
2354 uint64_t current_addr = block_offset + offset;
2355 uint64_t index = rdma->current_index;
2356 uint64_t chunk = rdma->current_chunk;
2357 int ret;
2359 /* If we cannot merge it, we flush the current buffer first. */
2360 if (!qemu_rdma_buffer_mergeable(rdma, current_addr, len)) {
2361 ret = qemu_rdma_write_flush(rdma);
2362 if (ret) {
2363 return ret;
2365 rdma->current_length = 0;
2366 rdma->current_addr = current_addr;
2368 qemu_rdma_search_ram_block(rdma, block_offset,
2369 offset, len, &index, &chunk);
2370 rdma->current_index = index;
2371 rdma->current_chunk = chunk;
2374 /* merge it */
2375 rdma->current_length += len;
2377 /* flush it if buffer is too large */
2378 if (rdma->current_length >= RDMA_MERGE_MAX) {
2379 return qemu_rdma_write_flush(rdma);
2382 return 0;
2385 static void qemu_rdma_cleanup(RDMAContext *rdma)
2387 int idx;
2389 if (rdma->cm_id && rdma->connected) {
2390 if ((rdma->error_state ||
2391 migrate_get_current()->state == MIGRATION_STATUS_CANCELLING) &&
2392 !rdma->received_error) {
2393 RDMAControlHeader head = { .len = 0,
2394 .type = RDMA_CONTROL_ERROR,
2395 .repeat = 1,
2397 error_report("Early error. Sending error.");
2398 qemu_rdma_post_send_control(rdma, NULL, &head);
2401 rdma_disconnect(rdma->cm_id);
2402 trace_qemu_rdma_cleanup_disconnect();
2403 rdma->connected = false;
2406 if (rdma->channel) {
2407 qemu_set_fd_handler(rdma->channel->fd, NULL, NULL, NULL);
2409 g_free(rdma->dest_blocks);
2410 rdma->dest_blocks = NULL;
2412 for (idx = 0; idx < RDMA_WRID_MAX; idx++) {
2413 if (rdma->wr_data[idx].control_mr) {
2414 rdma->total_registrations--;
2415 ibv_dereg_mr(rdma->wr_data[idx].control_mr);
2417 rdma->wr_data[idx].control_mr = NULL;
2420 if (rdma->local_ram_blocks.block) {
2421 while (rdma->local_ram_blocks.nb_blocks) {
2422 rdma_delete_block(rdma, &rdma->local_ram_blocks.block[0]);
2426 if (rdma->qp) {
2427 rdma_destroy_qp(rdma->cm_id);
2428 rdma->qp = NULL;
2430 if (rdma->recv_cq) {
2431 ibv_destroy_cq(rdma->recv_cq);
2432 rdma->recv_cq = NULL;
2434 if (rdma->send_cq) {
2435 ibv_destroy_cq(rdma->send_cq);
2436 rdma->send_cq = NULL;
2438 if (rdma->recv_comp_channel) {
2439 ibv_destroy_comp_channel(rdma->recv_comp_channel);
2440 rdma->recv_comp_channel = NULL;
2442 if (rdma->send_comp_channel) {
2443 ibv_destroy_comp_channel(rdma->send_comp_channel);
2444 rdma->send_comp_channel = NULL;
2446 if (rdma->pd) {
2447 ibv_dealloc_pd(rdma->pd);
2448 rdma->pd = NULL;
2450 if (rdma->cm_id) {
2451 rdma_destroy_id(rdma->cm_id);
2452 rdma->cm_id = NULL;
2455 /* the destination side, listen_id and channel is shared */
2456 if (rdma->listen_id) {
2457 if (!rdma->is_return_path) {
2458 rdma_destroy_id(rdma->listen_id);
2460 rdma->listen_id = NULL;
2462 if (rdma->channel) {
2463 if (!rdma->is_return_path) {
2464 rdma_destroy_event_channel(rdma->channel);
2466 rdma->channel = NULL;
2470 if (rdma->channel) {
2471 rdma_destroy_event_channel(rdma->channel);
2472 rdma->channel = NULL;
2474 g_free(rdma->host);
2475 g_free(rdma->host_port);
2476 rdma->host = NULL;
2477 rdma->host_port = NULL;
2481 static int qemu_rdma_source_init(RDMAContext *rdma, bool pin_all, Error **errp)
2483 int ret, idx;
2486 * Will be validated against destination's actual capabilities
2487 * after the connect() completes.
2489 rdma->pin_all = pin_all;
2491 ret = qemu_rdma_resolve_host(rdma, errp);
2492 if (ret) {
2493 goto err_rdma_source_init;
2496 ret = qemu_rdma_alloc_pd_cq(rdma);
2497 if (ret) {
2498 ERROR(errp, "rdma migration: error allocating pd and cq! Your mlock()"
2499 " limits may be too low. Please check $ ulimit -a # and "
2500 "search for 'ulimit -l' in the output");
2501 goto err_rdma_source_init;
2504 ret = qemu_rdma_alloc_qp(rdma);
2505 if (ret) {
2506 ERROR(errp, "rdma migration: error allocating qp!");
2507 goto err_rdma_source_init;
2510 qemu_rdma_init_ram_blocks(rdma);
2512 /* Build the hash that maps from offset to RAMBlock */
2513 rdma->blockmap = g_hash_table_new(g_direct_hash, g_direct_equal);
2514 for (idx = 0; idx < rdma->local_ram_blocks.nb_blocks; idx++) {
2515 g_hash_table_insert(rdma->blockmap,
2516 (void *)(uintptr_t)rdma->local_ram_blocks.block[idx].offset,
2517 &rdma->local_ram_blocks.block[idx]);
2520 for (idx = 0; idx < RDMA_WRID_MAX; idx++) {
2521 ret = qemu_rdma_reg_control(rdma, idx);
2522 if (ret) {
2523 ERROR(errp, "rdma migration: error registering %d control!",
2524 idx);
2525 goto err_rdma_source_init;
2529 return 0;
2531 err_rdma_source_init:
2532 qemu_rdma_cleanup(rdma);
2533 return -1;
2536 static int qemu_get_cm_event_timeout(RDMAContext *rdma,
2537 struct rdma_cm_event **cm_event,
2538 long msec, Error **errp)
2540 int ret;
2541 struct pollfd poll_fd = {
2542 .fd = rdma->channel->fd,
2543 .events = POLLIN,
2544 .revents = 0
2547 do {
2548 ret = poll(&poll_fd, 1, msec);
2549 } while (ret < 0 && errno == EINTR);
2551 if (ret == 0) {
2552 ERROR(errp, "poll cm event timeout");
2553 return -1;
2554 } else if (ret < 0) {
2555 ERROR(errp, "failed to poll cm event, errno=%i", errno);
2556 return -1;
2557 } else if (poll_fd.revents & POLLIN) {
2558 if (rdma_get_cm_event(rdma->channel, cm_event) < 0) {
2559 ERROR(errp, "failed to get cm event");
2560 return -1;
2562 return 0;
2563 } else {
2564 ERROR(errp, "no POLLIN event, revent=%x", poll_fd.revents);
2565 return -1;
2569 static int qemu_rdma_connect(RDMAContext *rdma, bool return_path,
2570 Error **errp)
2572 RDMACapabilities cap = {
2573 .version = RDMA_CONTROL_VERSION_CURRENT,
2574 .flags = 0,
2576 struct rdma_conn_param conn_param = { .initiator_depth = 2,
2577 .retry_count = 5,
2578 .private_data = &cap,
2579 .private_data_len = sizeof(cap),
2581 struct rdma_cm_event *cm_event;
2582 int ret;
2585 * Only negotiate the capability with destination if the user
2586 * on the source first requested the capability.
2588 if (rdma->pin_all) {
2589 trace_qemu_rdma_connect_pin_all_requested();
2590 cap.flags |= RDMA_CAPABILITY_PIN_ALL;
2593 caps_to_network(&cap);
2595 ret = qemu_rdma_post_recv_control(rdma, RDMA_WRID_READY);
2596 if (ret) {
2597 ERROR(errp, "posting second control recv");
2598 goto err_rdma_source_connect;
2601 ret = rdma_connect(rdma->cm_id, &conn_param);
2602 if (ret) {
2603 perror("rdma_connect");
2604 ERROR(errp, "connecting to destination!");
2605 goto err_rdma_source_connect;
2608 if (return_path) {
2609 ret = qemu_get_cm_event_timeout(rdma, &cm_event, 5000, errp);
2610 } else {
2611 ret = rdma_get_cm_event(rdma->channel, &cm_event);
2612 if (ret < 0) {
2613 ERROR(errp, "failed to get cm event");
2616 if (ret) {
2618 * FIXME perror() is wrong, because
2619 * qemu_get_cm_event_timeout() can fail without setting errno.
2620 * Will go away later in this series.
2622 perror("rdma_get_cm_event after rdma_connect");
2623 goto err_rdma_source_connect;
2626 if (cm_event->event != RDMA_CM_EVENT_ESTABLISHED) {
2627 error_report("rdma_get_cm_event != EVENT_ESTABLISHED after rdma_connect");
2628 ERROR(errp, "connecting to destination!");
2629 rdma_ack_cm_event(cm_event);
2630 goto err_rdma_source_connect;
2632 rdma->connected = true;
2634 memcpy(&cap, cm_event->param.conn.private_data, sizeof(cap));
2635 network_to_caps(&cap);
2638 * Verify that the *requested* capabilities are supported by the destination
2639 * and disable them otherwise.
2641 if (rdma->pin_all && !(cap.flags & RDMA_CAPABILITY_PIN_ALL)) {
2642 ERROR(errp, "Server cannot support pinning all memory. "
2643 "Will register memory dynamically.");
2644 rdma->pin_all = false;
2647 trace_qemu_rdma_connect_pin_all_outcome(rdma->pin_all);
2649 rdma_ack_cm_event(cm_event);
2651 rdma->control_ready_expected = 1;
2652 rdma->nb_sent = 0;
2653 return 0;
2655 err_rdma_source_connect:
2656 qemu_rdma_cleanup(rdma);
2657 return -1;
2660 static int qemu_rdma_dest_init(RDMAContext *rdma, Error **errp)
2662 int ret, idx;
2663 struct rdma_cm_id *listen_id;
2664 char ip[40] = "unknown";
2665 struct rdma_addrinfo *res, *e;
2666 char port_str[16];
2667 int reuse = 1;
2669 for (idx = 0; idx < RDMA_WRID_MAX; idx++) {
2670 rdma->wr_data[idx].control_len = 0;
2671 rdma->wr_data[idx].control_curr = NULL;
2674 if (!rdma->host || !rdma->host[0]) {
2675 ERROR(errp, "RDMA host is not set!");
2676 rdma->error_state = -EINVAL;
2677 return -1;
2679 /* create CM channel */
2680 rdma->channel = rdma_create_event_channel();
2681 if (!rdma->channel) {
2682 ERROR(errp, "could not create rdma event channel");
2683 rdma->error_state = -EINVAL;
2684 return -1;
2687 /* create CM id */
2688 ret = rdma_create_id(rdma->channel, &listen_id, NULL, RDMA_PS_TCP);
2689 if (ret) {
2690 ERROR(errp, "could not create cm_id!");
2691 goto err_dest_init_create_listen_id;
2694 snprintf(port_str, 16, "%d", rdma->port);
2695 port_str[15] = '\0';
2697 ret = rdma_getaddrinfo(rdma->host, port_str, NULL, &res);
2698 if (ret < 0) {
2699 ERROR(errp, "could not rdma_getaddrinfo address %s", rdma->host);
2700 goto err_dest_init_bind_addr;
2703 ret = rdma_set_option(listen_id, RDMA_OPTION_ID, RDMA_OPTION_ID_REUSEADDR,
2704 &reuse, sizeof reuse);
2705 if (ret) {
2706 ERROR(errp, "Error: could not set REUSEADDR option");
2707 goto err_dest_init_bind_addr;
2709 for (e = res; e != NULL; e = e->ai_next) {
2710 inet_ntop(e->ai_family,
2711 &((struct sockaddr_in *) e->ai_dst_addr)->sin_addr, ip, sizeof ip);
2712 trace_qemu_rdma_dest_init_trying(rdma->host, ip);
2713 ret = rdma_bind_addr(listen_id, e->ai_dst_addr);
2714 if (ret) {
2715 continue;
2717 if (e->ai_family == AF_INET6) {
2718 ret = qemu_rdma_broken_ipv6_kernel(listen_id->verbs, errp);
2719 if (ret) {
2720 continue;
2723 break;
2726 rdma_freeaddrinfo(res);
2727 if (!e) {
2728 ERROR(errp, "Error: could not rdma_bind_addr!");
2729 goto err_dest_init_bind_addr;
2732 rdma->listen_id = listen_id;
2733 qemu_rdma_dump_gid("dest_init", listen_id);
2734 return 0;
2736 err_dest_init_bind_addr:
2737 rdma_destroy_id(listen_id);
2738 err_dest_init_create_listen_id:
2739 rdma_destroy_event_channel(rdma->channel);
2740 rdma->channel = NULL;
2741 rdma->error_state = ret;
2742 return ret;
2746 static void qemu_rdma_return_path_dest_init(RDMAContext *rdma_return_path,
2747 RDMAContext *rdma)
2749 int idx;
2751 for (idx = 0; idx < RDMA_WRID_MAX; idx++) {
2752 rdma_return_path->wr_data[idx].control_len = 0;
2753 rdma_return_path->wr_data[idx].control_curr = NULL;
2756 /*the CM channel and CM id is shared*/
2757 rdma_return_path->channel = rdma->channel;
2758 rdma_return_path->listen_id = rdma->listen_id;
2760 rdma->return_path = rdma_return_path;
2761 rdma_return_path->return_path = rdma;
2762 rdma_return_path->is_return_path = true;
2765 static RDMAContext *qemu_rdma_data_init(const char *host_port, Error **errp)
2767 RDMAContext *rdma = NULL;
2768 InetSocketAddress *addr;
2770 if (host_port) {
2771 rdma = g_new0(RDMAContext, 1);
2772 rdma->current_index = -1;
2773 rdma->current_chunk = -1;
2775 addr = g_new(InetSocketAddress, 1);
2776 if (!inet_parse(addr, host_port, NULL)) {
2777 rdma->port = atoi(addr->port);
2778 rdma->host = g_strdup(addr->host);
2779 rdma->host_port = g_strdup(host_port);
2780 } else {
2781 ERROR(errp, "bad RDMA migration address '%s'", host_port);
2782 g_free(rdma);
2783 rdma = NULL;
2786 qapi_free_InetSocketAddress(addr);
2789 return rdma;
2793 * QEMUFile interface to the control channel.
2794 * SEND messages for control only.
2795 * VM's ram is handled with regular RDMA messages.
2797 static ssize_t qio_channel_rdma_writev(QIOChannel *ioc,
2798 const struct iovec *iov,
2799 size_t niov,
2800 int *fds,
2801 size_t nfds,
2802 int flags,
2803 Error **errp)
2805 QIOChannelRDMA *rioc = QIO_CHANNEL_RDMA(ioc);
2806 RDMAContext *rdma;
2807 int ret;
2808 ssize_t done = 0;
2809 size_t i, len;
2811 RCU_READ_LOCK_GUARD();
2812 rdma = qatomic_rcu_read(&rioc->rdmaout);
2814 if (!rdma) {
2815 error_setg(errp, "RDMA control channel output is not set");
2816 return -1;
2819 if (rdma->error_state) {
2820 error_setg(errp,
2821 "RDMA is in an error state waiting migration to abort!");
2822 return -1;
2826 * Push out any writes that
2827 * we're queued up for VM's ram.
2829 ret = qemu_rdma_write_flush(rdma);
2830 if (ret < 0) {
2831 rdma->error_state = ret;
2832 error_setg(errp, "qemu_rdma_write_flush failed");
2833 return -1;
2836 for (i = 0; i < niov; i++) {
2837 size_t remaining = iov[i].iov_len;
2838 uint8_t * data = (void *)iov[i].iov_base;
2839 while (remaining) {
2840 RDMAControlHeader head = {};
2842 len = MIN(remaining, RDMA_SEND_INCREMENT);
2843 remaining -= len;
2845 head.len = len;
2846 head.type = RDMA_CONTROL_QEMU_FILE;
2848 ret = qemu_rdma_exchange_send(rdma, &head, data, NULL, NULL, NULL);
2850 if (ret < 0) {
2851 rdma->error_state = ret;
2852 error_setg(errp, "qemu_rdma_exchange_send failed");
2853 return -1;
2856 data += len;
2857 done += len;
2861 return done;
2864 static size_t qemu_rdma_fill(RDMAContext *rdma, uint8_t *buf,
2865 size_t size, int idx)
2867 size_t len = 0;
2869 if (rdma->wr_data[idx].control_len) {
2870 trace_qemu_rdma_fill(rdma->wr_data[idx].control_len, size);
2872 len = MIN(size, rdma->wr_data[idx].control_len);
2873 memcpy(buf, rdma->wr_data[idx].control_curr, len);
2874 rdma->wr_data[idx].control_curr += len;
2875 rdma->wr_data[idx].control_len -= len;
2878 return len;
2882 * QEMUFile interface to the control channel.
2883 * RDMA links don't use bytestreams, so we have to
2884 * return bytes to QEMUFile opportunistically.
2886 static ssize_t qio_channel_rdma_readv(QIOChannel *ioc,
2887 const struct iovec *iov,
2888 size_t niov,
2889 int **fds,
2890 size_t *nfds,
2891 int flags,
2892 Error **errp)
2894 QIOChannelRDMA *rioc = QIO_CHANNEL_RDMA(ioc);
2895 RDMAContext *rdma;
2896 RDMAControlHeader head;
2897 int ret = 0;
2898 ssize_t done = 0;
2899 size_t i, len;
2901 RCU_READ_LOCK_GUARD();
2902 rdma = qatomic_rcu_read(&rioc->rdmain);
2904 if (!rdma) {
2905 error_setg(errp, "RDMA control channel input is not set");
2906 return -1;
2909 if (rdma->error_state) {
2910 error_setg(errp,
2911 "RDMA is in an error state waiting migration to abort!");
2912 return -1;
2915 for (i = 0; i < niov; i++) {
2916 size_t want = iov[i].iov_len;
2917 uint8_t *data = (void *)iov[i].iov_base;
2920 * First, we hold on to the last SEND message we
2921 * were given and dish out the bytes until we run
2922 * out of bytes.
2924 len = qemu_rdma_fill(rdma, data, want, 0);
2925 done += len;
2926 want -= len;
2927 /* Got what we needed, so go to next iovec */
2928 if (want == 0) {
2929 continue;
2932 /* If we got any data so far, then don't wait
2933 * for more, just return what we have */
2934 if (done > 0) {
2935 break;
2939 /* We've got nothing at all, so lets wait for
2940 * more to arrive
2942 ret = qemu_rdma_exchange_recv(rdma, &head, RDMA_CONTROL_QEMU_FILE);
2944 if (ret < 0) {
2945 rdma->error_state = ret;
2946 error_setg(errp, "qemu_rdma_exchange_recv failed");
2947 return -1;
2951 * SEND was received with new bytes, now try again.
2953 len = qemu_rdma_fill(rdma, data, want, 0);
2954 done += len;
2955 want -= len;
2957 /* Still didn't get enough, so lets just return */
2958 if (want) {
2959 if (done == 0) {
2960 return QIO_CHANNEL_ERR_BLOCK;
2961 } else {
2962 break;
2966 return done;
2970 * Block until all the outstanding chunks have been delivered by the hardware.
2972 static int qemu_rdma_drain_cq(RDMAContext *rdma)
2974 int ret;
2976 if (qemu_rdma_write_flush(rdma) < 0) {
2977 return -EIO;
2980 while (rdma->nb_sent) {
2981 ret = qemu_rdma_block_for_wrid(rdma, RDMA_WRID_RDMA_WRITE, NULL);
2982 if (ret < 0) {
2983 error_report("rdma migration: complete polling error!");
2984 return -EIO;
2988 qemu_rdma_unregister_waiting(rdma);
2990 return 0;
2994 static int qio_channel_rdma_set_blocking(QIOChannel *ioc,
2995 bool blocking,
2996 Error **errp)
2998 QIOChannelRDMA *rioc = QIO_CHANNEL_RDMA(ioc);
2999 /* XXX we should make readv/writev actually honour this :-) */
3000 rioc->blocking = blocking;
3001 return 0;
3005 typedef struct QIOChannelRDMASource QIOChannelRDMASource;
3006 struct QIOChannelRDMASource {
3007 GSource parent;
3008 QIOChannelRDMA *rioc;
3009 GIOCondition condition;
3012 static gboolean
3013 qio_channel_rdma_source_prepare(GSource *source,
3014 gint *timeout)
3016 QIOChannelRDMASource *rsource = (QIOChannelRDMASource *)source;
3017 RDMAContext *rdma;
3018 GIOCondition cond = 0;
3019 *timeout = -1;
3021 RCU_READ_LOCK_GUARD();
3022 if (rsource->condition == G_IO_IN) {
3023 rdma = qatomic_rcu_read(&rsource->rioc->rdmain);
3024 } else {
3025 rdma = qatomic_rcu_read(&rsource->rioc->rdmaout);
3028 if (!rdma) {
3029 error_report("RDMAContext is NULL when prepare Gsource");
3030 return FALSE;
3033 if (rdma->wr_data[0].control_len) {
3034 cond |= G_IO_IN;
3036 cond |= G_IO_OUT;
3038 return cond & rsource->condition;
3041 static gboolean
3042 qio_channel_rdma_source_check(GSource *source)
3044 QIOChannelRDMASource *rsource = (QIOChannelRDMASource *)source;
3045 RDMAContext *rdma;
3046 GIOCondition cond = 0;
3048 RCU_READ_LOCK_GUARD();
3049 if (rsource->condition == G_IO_IN) {
3050 rdma = qatomic_rcu_read(&rsource->rioc->rdmain);
3051 } else {
3052 rdma = qatomic_rcu_read(&rsource->rioc->rdmaout);
3055 if (!rdma) {
3056 error_report("RDMAContext is NULL when check Gsource");
3057 return FALSE;
3060 if (rdma->wr_data[0].control_len) {
3061 cond |= G_IO_IN;
3063 cond |= G_IO_OUT;
3065 return cond & rsource->condition;
3068 static gboolean
3069 qio_channel_rdma_source_dispatch(GSource *source,
3070 GSourceFunc callback,
3071 gpointer user_data)
3073 QIOChannelFunc func = (QIOChannelFunc)callback;
3074 QIOChannelRDMASource *rsource = (QIOChannelRDMASource *)source;
3075 RDMAContext *rdma;
3076 GIOCondition cond = 0;
3078 RCU_READ_LOCK_GUARD();
3079 if (rsource->condition == G_IO_IN) {
3080 rdma = qatomic_rcu_read(&rsource->rioc->rdmain);
3081 } else {
3082 rdma = qatomic_rcu_read(&rsource->rioc->rdmaout);
3085 if (!rdma) {
3086 error_report("RDMAContext is NULL when dispatch Gsource");
3087 return FALSE;
3090 if (rdma->wr_data[0].control_len) {
3091 cond |= G_IO_IN;
3093 cond |= G_IO_OUT;
3095 return (*func)(QIO_CHANNEL(rsource->rioc),
3096 (cond & rsource->condition),
3097 user_data);
3100 static void
3101 qio_channel_rdma_source_finalize(GSource *source)
3103 QIOChannelRDMASource *ssource = (QIOChannelRDMASource *)source;
3105 object_unref(OBJECT(ssource->rioc));
3108 static GSourceFuncs qio_channel_rdma_source_funcs = {
3109 qio_channel_rdma_source_prepare,
3110 qio_channel_rdma_source_check,
3111 qio_channel_rdma_source_dispatch,
3112 qio_channel_rdma_source_finalize
3115 static GSource *qio_channel_rdma_create_watch(QIOChannel *ioc,
3116 GIOCondition condition)
3118 QIOChannelRDMA *rioc = QIO_CHANNEL_RDMA(ioc);
3119 QIOChannelRDMASource *ssource;
3120 GSource *source;
3122 source = g_source_new(&qio_channel_rdma_source_funcs,
3123 sizeof(QIOChannelRDMASource));
3124 ssource = (QIOChannelRDMASource *)source;
3126 ssource->rioc = rioc;
3127 object_ref(OBJECT(rioc));
3129 ssource->condition = condition;
3131 return source;
3134 static void qio_channel_rdma_set_aio_fd_handler(QIOChannel *ioc,
3135 AioContext *read_ctx,
3136 IOHandler *io_read,
3137 AioContext *write_ctx,
3138 IOHandler *io_write,
3139 void *opaque)
3141 QIOChannelRDMA *rioc = QIO_CHANNEL_RDMA(ioc);
3142 if (io_read) {
3143 aio_set_fd_handler(read_ctx, rioc->rdmain->recv_comp_channel->fd,
3144 io_read, io_write, NULL, NULL, opaque);
3145 aio_set_fd_handler(read_ctx, rioc->rdmain->send_comp_channel->fd,
3146 io_read, io_write, NULL, NULL, opaque);
3147 } else {
3148 aio_set_fd_handler(write_ctx, rioc->rdmaout->recv_comp_channel->fd,
3149 io_read, io_write, NULL, NULL, opaque);
3150 aio_set_fd_handler(write_ctx, rioc->rdmaout->send_comp_channel->fd,
3151 io_read, io_write, NULL, NULL, opaque);
3155 struct rdma_close_rcu {
3156 struct rcu_head rcu;
3157 RDMAContext *rdmain;
3158 RDMAContext *rdmaout;
3161 /* callback from qio_channel_rdma_close via call_rcu */
3162 static void qio_channel_rdma_close_rcu(struct rdma_close_rcu *rcu)
3164 if (rcu->rdmain) {
3165 qemu_rdma_cleanup(rcu->rdmain);
3168 if (rcu->rdmaout) {
3169 qemu_rdma_cleanup(rcu->rdmaout);
3172 g_free(rcu->rdmain);
3173 g_free(rcu->rdmaout);
3174 g_free(rcu);
3177 static int qio_channel_rdma_close(QIOChannel *ioc,
3178 Error **errp)
3180 QIOChannelRDMA *rioc = QIO_CHANNEL_RDMA(ioc);
3181 RDMAContext *rdmain, *rdmaout;
3182 struct rdma_close_rcu *rcu = g_new(struct rdma_close_rcu, 1);
3184 trace_qemu_rdma_close();
3186 rdmain = rioc->rdmain;
3187 if (rdmain) {
3188 qatomic_rcu_set(&rioc->rdmain, NULL);
3191 rdmaout = rioc->rdmaout;
3192 if (rdmaout) {
3193 qatomic_rcu_set(&rioc->rdmaout, NULL);
3196 rcu->rdmain = rdmain;
3197 rcu->rdmaout = rdmaout;
3198 call_rcu(rcu, qio_channel_rdma_close_rcu, rcu);
3200 return 0;
3203 static int
3204 qio_channel_rdma_shutdown(QIOChannel *ioc,
3205 QIOChannelShutdown how,
3206 Error **errp)
3208 QIOChannelRDMA *rioc = QIO_CHANNEL_RDMA(ioc);
3209 RDMAContext *rdmain, *rdmaout;
3211 RCU_READ_LOCK_GUARD();
3213 rdmain = qatomic_rcu_read(&rioc->rdmain);
3214 rdmaout = qatomic_rcu_read(&rioc->rdmain);
3216 switch (how) {
3217 case QIO_CHANNEL_SHUTDOWN_READ:
3218 if (rdmain) {
3219 rdmain->error_state = -1;
3221 break;
3222 case QIO_CHANNEL_SHUTDOWN_WRITE:
3223 if (rdmaout) {
3224 rdmaout->error_state = -1;
3226 break;
3227 case QIO_CHANNEL_SHUTDOWN_BOTH:
3228 default:
3229 if (rdmain) {
3230 rdmain->error_state = -1;
3232 if (rdmaout) {
3233 rdmaout->error_state = -1;
3235 break;
3238 return 0;
3242 * Parameters:
3243 * @offset == 0 :
3244 * This means that 'block_offset' is a full virtual address that does not
3245 * belong to a RAMBlock of the virtual machine and instead
3246 * represents a private malloc'd memory area that the caller wishes to
3247 * transfer.
3249 * @offset != 0 :
3250 * Offset is an offset to be added to block_offset and used
3251 * to also lookup the corresponding RAMBlock.
3253 * @size : Number of bytes to transfer
3255 * @pages_sent : User-specificed pointer to indicate how many pages were
3256 * sent. Usually, this will not be more than a few bytes of
3257 * the protocol because most transfers are sent asynchronously.
3259 static int qemu_rdma_save_page(QEMUFile *f, ram_addr_t block_offset,
3260 ram_addr_t offset, size_t size)
3262 QIOChannelRDMA *rioc = QIO_CHANNEL_RDMA(qemu_file_get_ioc(f));
3263 RDMAContext *rdma;
3264 int ret;
3266 if (migration_in_postcopy()) {
3267 return RAM_SAVE_CONTROL_NOT_SUPP;
3270 RCU_READ_LOCK_GUARD();
3271 rdma = qatomic_rcu_read(&rioc->rdmaout);
3273 if (!rdma) {
3274 return -EIO;
3277 ret = check_error_state(rdma);
3278 if (ret) {
3279 return ret;
3282 qemu_fflush(f);
3285 * Add this page to the current 'chunk'. If the chunk
3286 * is full, or the page doesn't belong to the current chunk,
3287 * an actual RDMA write will occur and a new chunk will be formed.
3289 ret = qemu_rdma_write(rdma, block_offset, offset, size);
3290 if (ret < 0) {
3291 error_report("rdma migration: write error");
3292 goto err;
3296 * Drain the Completion Queue if possible, but do not block,
3297 * just poll.
3299 * If nothing to poll, the end of the iteration will do this
3300 * again to make sure we don't overflow the request queue.
3302 while (1) {
3303 uint64_t wr_id, wr_id_in;
3304 ret = qemu_rdma_poll(rdma, rdma->recv_cq, &wr_id_in, NULL);
3306 if (ret < 0) {
3307 error_report("rdma migration: polling error");
3308 goto err;
3311 wr_id = wr_id_in & RDMA_WRID_TYPE_MASK;
3313 if (wr_id == RDMA_WRID_NONE) {
3314 break;
3318 while (1) {
3319 uint64_t wr_id, wr_id_in;
3320 ret = qemu_rdma_poll(rdma, rdma->send_cq, &wr_id_in, NULL);
3322 if (ret < 0) {
3323 error_report("rdma migration: polling error");
3324 goto err;
3327 wr_id = wr_id_in & RDMA_WRID_TYPE_MASK;
3329 if (wr_id == RDMA_WRID_NONE) {
3330 break;
3334 return RAM_SAVE_CONTROL_DELAYED;
3335 err:
3336 rdma->error_state = ret;
3337 return ret;
3340 static void rdma_accept_incoming_migration(void *opaque);
3342 static void rdma_cm_poll_handler(void *opaque)
3344 RDMAContext *rdma = opaque;
3345 int ret;
3346 struct rdma_cm_event *cm_event;
3347 MigrationIncomingState *mis = migration_incoming_get_current();
3349 ret = rdma_get_cm_event(rdma->channel, &cm_event);
3350 if (ret) {
3351 error_report("get_cm_event failed %d", errno);
3352 return;
3355 if (cm_event->event == RDMA_CM_EVENT_DISCONNECTED ||
3356 cm_event->event == RDMA_CM_EVENT_DEVICE_REMOVAL) {
3357 if (!rdma->error_state &&
3358 migration_incoming_get_current()->state !=
3359 MIGRATION_STATUS_COMPLETED) {
3360 error_report("receive cm event, cm event is %d", cm_event->event);
3361 rdma->error_state = -EPIPE;
3362 if (rdma->return_path) {
3363 rdma->return_path->error_state = -EPIPE;
3366 rdma_ack_cm_event(cm_event);
3367 if (mis->loadvm_co) {
3368 qemu_coroutine_enter(mis->loadvm_co);
3370 return;
3372 rdma_ack_cm_event(cm_event);
3375 static int qemu_rdma_accept(RDMAContext *rdma)
3377 RDMACapabilities cap;
3378 struct rdma_conn_param conn_param = {
3379 .responder_resources = 2,
3380 .private_data = &cap,
3381 .private_data_len = sizeof(cap),
3383 RDMAContext *rdma_return_path = NULL;
3384 struct rdma_cm_event *cm_event;
3385 struct ibv_context *verbs;
3386 int ret = -EINVAL;
3387 int idx;
3389 ret = rdma_get_cm_event(rdma->channel, &cm_event);
3390 if (ret) {
3391 goto err_rdma_dest_wait;
3394 if (cm_event->event != RDMA_CM_EVENT_CONNECT_REQUEST) {
3395 rdma_ack_cm_event(cm_event);
3396 ret = -1;
3397 goto err_rdma_dest_wait;
3401 * initialize the RDMAContext for return path for postcopy after first
3402 * connection request reached.
3404 if ((migrate_postcopy() || migrate_return_path())
3405 && !rdma->is_return_path) {
3406 rdma_return_path = qemu_rdma_data_init(rdma->host_port, NULL);
3407 if (rdma_return_path == NULL) {
3408 rdma_ack_cm_event(cm_event);
3409 ret = -1;
3410 goto err_rdma_dest_wait;
3413 qemu_rdma_return_path_dest_init(rdma_return_path, rdma);
3416 memcpy(&cap, cm_event->param.conn.private_data, sizeof(cap));
3418 network_to_caps(&cap);
3420 if (cap.version < 1 || cap.version > RDMA_CONTROL_VERSION_CURRENT) {
3421 error_report("Unknown source RDMA version: %d, bailing...",
3422 cap.version);
3423 rdma_ack_cm_event(cm_event);
3424 ret = -1;
3425 goto err_rdma_dest_wait;
3429 * Respond with only the capabilities this version of QEMU knows about.
3431 cap.flags &= known_capabilities;
3434 * Enable the ones that we do know about.
3435 * Add other checks here as new ones are introduced.
3437 if (cap.flags & RDMA_CAPABILITY_PIN_ALL) {
3438 rdma->pin_all = true;
3441 rdma->cm_id = cm_event->id;
3442 verbs = cm_event->id->verbs;
3444 rdma_ack_cm_event(cm_event);
3446 trace_qemu_rdma_accept_pin_state(rdma->pin_all);
3448 caps_to_network(&cap);
3450 trace_qemu_rdma_accept_pin_verbsc(verbs);
3452 if (!rdma->verbs) {
3453 rdma->verbs = verbs;
3454 } else if (rdma->verbs != verbs) {
3455 error_report("ibv context not matching %p, %p!", rdma->verbs,
3456 verbs);
3457 ret = -1;
3458 goto err_rdma_dest_wait;
3461 qemu_rdma_dump_id("dest_init", verbs);
3463 ret = qemu_rdma_alloc_pd_cq(rdma);
3464 if (ret) {
3465 error_report("rdma migration: error allocating pd and cq!");
3466 goto err_rdma_dest_wait;
3469 ret = qemu_rdma_alloc_qp(rdma);
3470 if (ret) {
3471 error_report("rdma migration: error allocating qp!");
3472 goto err_rdma_dest_wait;
3475 qemu_rdma_init_ram_blocks(rdma);
3477 for (idx = 0; idx < RDMA_WRID_MAX; idx++) {
3478 ret = qemu_rdma_reg_control(rdma, idx);
3479 if (ret) {
3480 error_report("rdma: error registering %d control", idx);
3481 goto err_rdma_dest_wait;
3485 /* Accept the second connection request for return path */
3486 if ((migrate_postcopy() || migrate_return_path())
3487 && !rdma->is_return_path) {
3488 qemu_set_fd_handler(rdma->channel->fd, rdma_accept_incoming_migration,
3489 NULL,
3490 (void *)(intptr_t)rdma->return_path);
3491 } else {
3492 qemu_set_fd_handler(rdma->channel->fd, rdma_cm_poll_handler,
3493 NULL, rdma);
3496 ret = rdma_accept(rdma->cm_id, &conn_param);
3497 if (ret) {
3498 error_report("rdma_accept failed");
3499 goto err_rdma_dest_wait;
3502 ret = rdma_get_cm_event(rdma->channel, &cm_event);
3503 if (ret) {
3504 error_report("rdma_accept get_cm_event failed");
3505 goto err_rdma_dest_wait;
3508 if (cm_event->event != RDMA_CM_EVENT_ESTABLISHED) {
3509 error_report("rdma_accept not event established");
3510 rdma_ack_cm_event(cm_event);
3511 ret = -1;
3512 goto err_rdma_dest_wait;
3515 rdma_ack_cm_event(cm_event);
3516 rdma->connected = true;
3518 ret = qemu_rdma_post_recv_control(rdma, RDMA_WRID_READY);
3519 if (ret) {
3520 error_report("rdma migration: error posting second control recv");
3521 goto err_rdma_dest_wait;
3524 qemu_rdma_dump_gid("dest_connect", rdma->cm_id);
3526 return 0;
3528 err_rdma_dest_wait:
3529 rdma->error_state = ret;
3530 qemu_rdma_cleanup(rdma);
3531 g_free(rdma_return_path);
3532 return ret;
3535 static int dest_ram_sort_func(const void *a, const void *b)
3537 unsigned int a_index = ((const RDMALocalBlock *)a)->src_index;
3538 unsigned int b_index = ((const RDMALocalBlock *)b)->src_index;
3540 return (a_index < b_index) ? -1 : (a_index != b_index);
3544 * During each iteration of the migration, we listen for instructions
3545 * by the source VM to perform dynamic page registrations before they
3546 * can perform RDMA operations.
3548 * We respond with the 'rkey'.
3550 * Keep doing this until the source tells us to stop.
3552 static int qemu_rdma_registration_handle(QEMUFile *f)
3554 RDMAControlHeader reg_resp = { .len = sizeof(RDMARegisterResult),
3555 .type = RDMA_CONTROL_REGISTER_RESULT,
3556 .repeat = 0,
3558 RDMAControlHeader unreg_resp = { .len = 0,
3559 .type = RDMA_CONTROL_UNREGISTER_FINISHED,
3560 .repeat = 0,
3562 RDMAControlHeader blocks = { .type = RDMA_CONTROL_RAM_BLOCKS_RESULT,
3563 .repeat = 1 };
3564 QIOChannelRDMA *rioc = QIO_CHANNEL_RDMA(qemu_file_get_ioc(f));
3565 RDMAContext *rdma;
3566 RDMALocalBlocks *local;
3567 RDMAControlHeader head;
3568 RDMARegister *reg, *registers;
3569 RDMACompress *comp;
3570 RDMARegisterResult *reg_result;
3571 static RDMARegisterResult results[RDMA_CONTROL_MAX_COMMANDS_PER_MESSAGE];
3572 RDMALocalBlock *block;
3573 void *host_addr;
3574 int ret = 0;
3575 int idx = 0;
3576 int count = 0;
3577 int i = 0;
3579 RCU_READ_LOCK_GUARD();
3580 rdma = qatomic_rcu_read(&rioc->rdmain);
3582 if (!rdma) {
3583 return -EIO;
3586 ret = check_error_state(rdma);
3587 if (ret) {
3588 return ret;
3591 local = &rdma->local_ram_blocks;
3592 do {
3593 trace_qemu_rdma_registration_handle_wait();
3595 ret = qemu_rdma_exchange_recv(rdma, &head, RDMA_CONTROL_NONE);
3597 if (ret < 0) {
3598 break;
3601 if (head.repeat > RDMA_CONTROL_MAX_COMMANDS_PER_MESSAGE) {
3602 error_report("rdma: Too many requests in this message (%d)."
3603 "Bailing.", head.repeat);
3604 ret = -EIO;
3605 break;
3608 switch (head.type) {
3609 case RDMA_CONTROL_COMPRESS:
3610 comp = (RDMACompress *) rdma->wr_data[idx].control_curr;
3611 network_to_compress(comp);
3613 trace_qemu_rdma_registration_handle_compress(comp->length,
3614 comp->block_idx,
3615 comp->offset);
3616 if (comp->block_idx >= rdma->local_ram_blocks.nb_blocks) {
3617 error_report("rdma: 'compress' bad block index %u (vs %d)",
3618 (unsigned int)comp->block_idx,
3619 rdma->local_ram_blocks.nb_blocks);
3620 ret = -EIO;
3621 goto out;
3623 block = &(rdma->local_ram_blocks.block[comp->block_idx]);
3625 host_addr = block->local_host_addr +
3626 (comp->offset - block->offset);
3628 ram_handle_compressed(host_addr, comp->value, comp->length);
3629 break;
3631 case RDMA_CONTROL_REGISTER_FINISHED:
3632 trace_qemu_rdma_registration_handle_finished();
3633 goto out;
3635 case RDMA_CONTROL_RAM_BLOCKS_REQUEST:
3636 trace_qemu_rdma_registration_handle_ram_blocks();
3638 /* Sort our local RAM Block list so it's the same as the source,
3639 * we can do this since we've filled in a src_index in the list
3640 * as we received the RAMBlock list earlier.
3642 qsort(rdma->local_ram_blocks.block,
3643 rdma->local_ram_blocks.nb_blocks,
3644 sizeof(RDMALocalBlock), dest_ram_sort_func);
3645 for (i = 0; i < local->nb_blocks; i++) {
3646 local->block[i].index = i;
3649 if (rdma->pin_all) {
3650 ret = qemu_rdma_reg_whole_ram_blocks(rdma);
3651 if (ret) {
3652 error_report("rdma migration: error dest "
3653 "registering ram blocks");
3654 goto out;
3659 * Dest uses this to prepare to transmit the RAMBlock descriptions
3660 * to the source VM after connection setup.
3661 * Both sides use the "remote" structure to communicate and update
3662 * their "local" descriptions with what was sent.
3664 for (i = 0; i < local->nb_blocks; i++) {
3665 rdma->dest_blocks[i].remote_host_addr =
3666 (uintptr_t)(local->block[i].local_host_addr);
3668 if (rdma->pin_all) {
3669 rdma->dest_blocks[i].remote_rkey = local->block[i].mr->rkey;
3672 rdma->dest_blocks[i].offset = local->block[i].offset;
3673 rdma->dest_blocks[i].length = local->block[i].length;
3675 dest_block_to_network(&rdma->dest_blocks[i]);
3676 trace_qemu_rdma_registration_handle_ram_blocks_loop(
3677 local->block[i].block_name,
3678 local->block[i].offset,
3679 local->block[i].length,
3680 local->block[i].local_host_addr,
3681 local->block[i].src_index);
3684 blocks.len = rdma->local_ram_blocks.nb_blocks
3685 * sizeof(RDMADestBlock);
3688 ret = qemu_rdma_post_send_control(rdma,
3689 (uint8_t *) rdma->dest_blocks, &blocks);
3691 if (ret < 0) {
3692 error_report("rdma migration: error sending remote info");
3693 goto out;
3696 break;
3697 case RDMA_CONTROL_REGISTER_REQUEST:
3698 trace_qemu_rdma_registration_handle_register(head.repeat);
3700 reg_resp.repeat = head.repeat;
3701 registers = (RDMARegister *) rdma->wr_data[idx].control_curr;
3703 for (count = 0; count < head.repeat; count++) {
3704 uint64_t chunk;
3705 uint8_t *chunk_start, *chunk_end;
3707 reg = &registers[count];
3708 network_to_register(reg);
3710 reg_result = &results[count];
3712 trace_qemu_rdma_registration_handle_register_loop(count,
3713 reg->current_index, reg->key.current_addr, reg->chunks);
3715 if (reg->current_index >= rdma->local_ram_blocks.nb_blocks) {
3716 error_report("rdma: 'register' bad block index %u (vs %d)",
3717 (unsigned int)reg->current_index,
3718 rdma->local_ram_blocks.nb_blocks);
3719 ret = -ENOENT;
3720 goto out;
3722 block = &(rdma->local_ram_blocks.block[reg->current_index]);
3723 if (block->is_ram_block) {
3724 if (block->offset > reg->key.current_addr) {
3725 error_report("rdma: bad register address for block %s"
3726 " offset: %" PRIx64 " current_addr: %" PRIx64,
3727 block->block_name, block->offset,
3728 reg->key.current_addr);
3729 ret = -ERANGE;
3730 goto out;
3732 host_addr = (block->local_host_addr +
3733 (reg->key.current_addr - block->offset));
3734 chunk = ram_chunk_index(block->local_host_addr,
3735 (uint8_t *) host_addr);
3736 } else {
3737 chunk = reg->key.chunk;
3738 host_addr = block->local_host_addr +
3739 (reg->key.chunk * (1UL << RDMA_REG_CHUNK_SHIFT));
3740 /* Check for particularly bad chunk value */
3741 if (host_addr < (void *)block->local_host_addr) {
3742 error_report("rdma: bad chunk for block %s"
3743 " chunk: %" PRIx64,
3744 block->block_name, reg->key.chunk);
3745 ret = -ERANGE;
3746 goto out;
3749 chunk_start = ram_chunk_start(block, chunk);
3750 chunk_end = ram_chunk_end(block, chunk + reg->chunks);
3751 /* avoid "-Waddress-of-packed-member" warning */
3752 uint32_t tmp_rkey = 0;
3753 if (qemu_rdma_register_and_get_keys(rdma, block,
3754 (uintptr_t)host_addr, NULL, &tmp_rkey,
3755 chunk, chunk_start, chunk_end)) {
3756 error_report("cannot get rkey");
3757 ret = -EINVAL;
3758 goto out;
3760 reg_result->rkey = tmp_rkey;
3762 reg_result->host_addr = (uintptr_t)block->local_host_addr;
3764 trace_qemu_rdma_registration_handle_register_rkey(
3765 reg_result->rkey);
3767 result_to_network(reg_result);
3770 ret = qemu_rdma_post_send_control(rdma,
3771 (uint8_t *) results, &reg_resp);
3773 if (ret < 0) {
3774 error_report("Failed to send control buffer");
3775 goto out;
3777 break;
3778 case RDMA_CONTROL_UNREGISTER_REQUEST:
3779 trace_qemu_rdma_registration_handle_unregister(head.repeat);
3780 unreg_resp.repeat = head.repeat;
3781 registers = (RDMARegister *) rdma->wr_data[idx].control_curr;
3783 for (count = 0; count < head.repeat; count++) {
3784 reg = &registers[count];
3785 network_to_register(reg);
3787 trace_qemu_rdma_registration_handle_unregister_loop(count,
3788 reg->current_index, reg->key.chunk);
3790 block = &(rdma->local_ram_blocks.block[reg->current_index]);
3792 ret = ibv_dereg_mr(block->pmr[reg->key.chunk]);
3793 block->pmr[reg->key.chunk] = NULL;
3795 if (ret != 0) {
3796 perror("rdma unregistration chunk failed");
3797 ret = -ret;
3798 goto out;
3801 rdma->total_registrations--;
3803 trace_qemu_rdma_registration_handle_unregister_success(
3804 reg->key.chunk);
3807 ret = qemu_rdma_post_send_control(rdma, NULL, &unreg_resp);
3809 if (ret < 0) {
3810 error_report("Failed to send control buffer");
3811 goto out;
3813 break;
3814 case RDMA_CONTROL_REGISTER_RESULT:
3815 error_report("Invalid RESULT message at dest.");
3816 ret = -EIO;
3817 goto out;
3818 default:
3819 error_report("Unknown control message %s", control_desc(head.type));
3820 ret = -EIO;
3821 goto out;
3823 } while (1);
3824 out:
3825 if (ret < 0) {
3826 rdma->error_state = ret;
3828 return ret;
3831 /* Destination:
3832 * Called via a ram_control_load_hook during the initial RAM load section which
3833 * lists the RAMBlocks by name. This lets us know the order of the RAMBlocks
3834 * on the source.
3835 * We've already built our local RAMBlock list, but not yet sent the list to
3836 * the source.
3838 static int
3839 rdma_block_notification_handle(QEMUFile *f, const char *name)
3841 RDMAContext *rdma;
3842 QIOChannelRDMA *rioc = QIO_CHANNEL_RDMA(qemu_file_get_ioc(f));
3843 int curr;
3844 int found = -1;
3846 RCU_READ_LOCK_GUARD();
3847 rdma = qatomic_rcu_read(&rioc->rdmain);
3849 if (!rdma) {
3850 return -EIO;
3853 /* Find the matching RAMBlock in our local list */
3854 for (curr = 0; curr < rdma->local_ram_blocks.nb_blocks; curr++) {
3855 if (!strcmp(rdma->local_ram_blocks.block[curr].block_name, name)) {
3856 found = curr;
3857 break;
3861 if (found == -1) {
3862 error_report("RAMBlock '%s' not found on destination", name);
3863 return -ENOENT;
3866 rdma->local_ram_blocks.block[curr].src_index = rdma->next_src_index;
3867 trace_rdma_block_notification_handle(name, rdma->next_src_index);
3868 rdma->next_src_index++;
3870 return 0;
3873 static int rdma_load_hook(QEMUFile *f, uint64_t flags, void *data)
3875 switch (flags) {
3876 case RAM_CONTROL_BLOCK_REG:
3877 return rdma_block_notification_handle(f, data);
3879 case RAM_CONTROL_HOOK:
3880 return qemu_rdma_registration_handle(f);
3882 default:
3883 /* Shouldn't be called with any other values */
3884 abort();
3888 static int qemu_rdma_registration_start(QEMUFile *f,
3889 uint64_t flags, void *data)
3891 QIOChannelRDMA *rioc = QIO_CHANNEL_RDMA(qemu_file_get_ioc(f));
3892 RDMAContext *rdma;
3893 int ret;
3895 if (migration_in_postcopy()) {
3896 return 0;
3899 RCU_READ_LOCK_GUARD();
3900 rdma = qatomic_rcu_read(&rioc->rdmaout);
3901 if (!rdma) {
3902 return -EIO;
3905 ret = check_error_state(rdma);
3906 if (ret) {
3907 return ret;
3910 trace_qemu_rdma_registration_start(flags);
3911 qemu_put_be64(f, RAM_SAVE_FLAG_HOOK);
3912 qemu_fflush(f);
3914 return 0;
3918 * Inform dest that dynamic registrations are done for now.
3919 * First, flush writes, if any.
3921 static int qemu_rdma_registration_stop(QEMUFile *f,
3922 uint64_t flags, void *data)
3924 QIOChannelRDMA *rioc = QIO_CHANNEL_RDMA(qemu_file_get_ioc(f));
3925 RDMAContext *rdma;
3926 RDMAControlHeader head = { .len = 0, .repeat = 1 };
3927 int ret = 0;
3929 if (migration_in_postcopy()) {
3930 return 0;
3933 RCU_READ_LOCK_GUARD();
3934 rdma = qatomic_rcu_read(&rioc->rdmaout);
3935 if (!rdma) {
3936 return -EIO;
3939 ret = check_error_state(rdma);
3940 if (ret) {
3941 return ret;
3944 qemu_fflush(f);
3945 ret = qemu_rdma_drain_cq(rdma);
3947 if (ret < 0) {
3948 goto err;
3951 if (flags == RAM_CONTROL_SETUP) {
3952 RDMAControlHeader resp = {.type = RDMA_CONTROL_RAM_BLOCKS_RESULT };
3953 RDMALocalBlocks *local = &rdma->local_ram_blocks;
3954 int reg_result_idx, i, nb_dest_blocks;
3956 head.type = RDMA_CONTROL_RAM_BLOCKS_REQUEST;
3957 trace_qemu_rdma_registration_stop_ram();
3960 * Make sure that we parallelize the pinning on both sides.
3961 * For very large guests, doing this serially takes a really
3962 * long time, so we have to 'interleave' the pinning locally
3963 * with the control messages by performing the pinning on this
3964 * side before we receive the control response from the other
3965 * side that the pinning has completed.
3967 ret = qemu_rdma_exchange_send(rdma, &head, NULL, &resp,
3968 &reg_result_idx, rdma->pin_all ?
3969 qemu_rdma_reg_whole_ram_blocks : NULL);
3970 if (ret < 0) {
3971 fprintf(stderr, "receiving remote info!");
3972 return ret;
3975 nb_dest_blocks = resp.len / sizeof(RDMADestBlock);
3978 * The protocol uses two different sets of rkeys (mutually exclusive):
3979 * 1. One key to represent the virtual address of the entire ram block.
3980 * (dynamic chunk registration disabled - pin everything with one rkey.)
3981 * 2. One to represent individual chunks within a ram block.
3982 * (dynamic chunk registration enabled - pin individual chunks.)
3984 * Once the capability is successfully negotiated, the destination transmits
3985 * the keys to use (or sends them later) including the virtual addresses
3986 * and then propagates the remote ram block descriptions to his local copy.
3989 if (local->nb_blocks != nb_dest_blocks) {
3990 fprintf(stderr, "ram blocks mismatch (Number of blocks %d vs %d) "
3991 "Your QEMU command line parameters are probably "
3992 "not identical on both the source and destination.",
3993 local->nb_blocks, nb_dest_blocks);
3994 rdma->error_state = -EINVAL;
3995 return -EINVAL;
3998 qemu_rdma_move_header(rdma, reg_result_idx, &resp);
3999 memcpy(rdma->dest_blocks,
4000 rdma->wr_data[reg_result_idx].control_curr, resp.len);
4001 for (i = 0; i < nb_dest_blocks; i++) {
4002 network_to_dest_block(&rdma->dest_blocks[i]);
4004 /* We require that the blocks are in the same order */
4005 if (rdma->dest_blocks[i].length != local->block[i].length) {
4006 fprintf(stderr, "Block %s/%d has a different length %" PRIu64
4007 "vs %" PRIu64, local->block[i].block_name, i,
4008 local->block[i].length,
4009 rdma->dest_blocks[i].length);
4010 rdma->error_state = -EINVAL;
4011 return -EINVAL;
4013 local->block[i].remote_host_addr =
4014 rdma->dest_blocks[i].remote_host_addr;
4015 local->block[i].remote_rkey = rdma->dest_blocks[i].remote_rkey;
4019 trace_qemu_rdma_registration_stop(flags);
4021 head.type = RDMA_CONTROL_REGISTER_FINISHED;
4022 ret = qemu_rdma_exchange_send(rdma, &head, NULL, NULL, NULL, NULL);
4024 if (ret < 0) {
4025 goto err;
4028 return 0;
4029 err:
4030 rdma->error_state = ret;
4031 return ret;
4034 static const QEMUFileHooks rdma_read_hooks = {
4035 .hook_ram_load = rdma_load_hook,
4038 static const QEMUFileHooks rdma_write_hooks = {
4039 .before_ram_iterate = qemu_rdma_registration_start,
4040 .after_ram_iterate = qemu_rdma_registration_stop,
4041 .save_page = qemu_rdma_save_page,
4045 static void qio_channel_rdma_finalize(Object *obj)
4047 QIOChannelRDMA *rioc = QIO_CHANNEL_RDMA(obj);
4048 if (rioc->rdmain) {
4049 qemu_rdma_cleanup(rioc->rdmain);
4050 g_free(rioc->rdmain);
4051 rioc->rdmain = NULL;
4053 if (rioc->rdmaout) {
4054 qemu_rdma_cleanup(rioc->rdmaout);
4055 g_free(rioc->rdmaout);
4056 rioc->rdmaout = NULL;
4060 static void qio_channel_rdma_class_init(ObjectClass *klass,
4061 void *class_data G_GNUC_UNUSED)
4063 QIOChannelClass *ioc_klass = QIO_CHANNEL_CLASS(klass);
4065 ioc_klass->io_writev = qio_channel_rdma_writev;
4066 ioc_klass->io_readv = qio_channel_rdma_readv;
4067 ioc_klass->io_set_blocking = qio_channel_rdma_set_blocking;
4068 ioc_klass->io_close = qio_channel_rdma_close;
4069 ioc_klass->io_create_watch = qio_channel_rdma_create_watch;
4070 ioc_klass->io_set_aio_fd_handler = qio_channel_rdma_set_aio_fd_handler;
4071 ioc_klass->io_shutdown = qio_channel_rdma_shutdown;
4074 static const TypeInfo qio_channel_rdma_info = {
4075 .parent = TYPE_QIO_CHANNEL,
4076 .name = TYPE_QIO_CHANNEL_RDMA,
4077 .instance_size = sizeof(QIOChannelRDMA),
4078 .instance_finalize = qio_channel_rdma_finalize,
4079 .class_init = qio_channel_rdma_class_init,
4082 static void qio_channel_rdma_register_types(void)
4084 type_register_static(&qio_channel_rdma_info);
4087 type_init(qio_channel_rdma_register_types);
4089 static QEMUFile *rdma_new_input(RDMAContext *rdma)
4091 QIOChannelRDMA *rioc = QIO_CHANNEL_RDMA(object_new(TYPE_QIO_CHANNEL_RDMA));
4093 rioc->file = qemu_file_new_input(QIO_CHANNEL(rioc));
4094 rioc->rdmain = rdma;
4095 rioc->rdmaout = rdma->return_path;
4096 qemu_file_set_hooks(rioc->file, &rdma_read_hooks);
4098 return rioc->file;
4101 static QEMUFile *rdma_new_output(RDMAContext *rdma)
4103 QIOChannelRDMA *rioc = QIO_CHANNEL_RDMA(object_new(TYPE_QIO_CHANNEL_RDMA));
4105 rioc->file = qemu_file_new_output(QIO_CHANNEL(rioc));
4106 rioc->rdmaout = rdma;
4107 rioc->rdmain = rdma->return_path;
4108 qemu_file_set_hooks(rioc->file, &rdma_write_hooks);
4110 return rioc->file;
4113 static void rdma_accept_incoming_migration(void *opaque)
4115 RDMAContext *rdma = opaque;
4116 int ret;
4117 QEMUFile *f;
4118 Error *local_err = NULL;
4120 trace_qemu_rdma_accept_incoming_migration();
4121 ret = qemu_rdma_accept(rdma);
4123 if (ret) {
4124 fprintf(stderr, "RDMA ERROR: Migration initialization failed\n");
4125 return;
4128 trace_qemu_rdma_accept_incoming_migration_accepted();
4130 if (rdma->is_return_path) {
4131 return;
4134 f = rdma_new_input(rdma);
4135 if (f == NULL) {
4136 fprintf(stderr, "RDMA ERROR: could not open RDMA for input\n");
4137 qemu_rdma_cleanup(rdma);
4138 return;
4141 rdma->migration_started_on_destination = 1;
4142 migration_fd_process_incoming(f, &local_err);
4143 if (local_err) {
4144 error_reportf_err(local_err, "RDMA ERROR:");
4148 void rdma_start_incoming_migration(const char *host_port, Error **errp)
4150 int ret;
4151 RDMAContext *rdma;
4153 trace_rdma_start_incoming_migration();
4155 /* Avoid ram_block_discard_disable(), cannot change during migration. */
4156 if (ram_block_discard_is_required()) {
4157 error_setg(errp, "RDMA: cannot disable RAM discard");
4158 return;
4161 rdma = qemu_rdma_data_init(host_port, errp);
4162 if (rdma == NULL) {
4163 goto err;
4166 ret = qemu_rdma_dest_init(rdma, errp);
4167 if (ret) {
4168 goto err;
4171 trace_rdma_start_incoming_migration_after_dest_init();
4173 ret = rdma_listen(rdma->listen_id, 5);
4175 if (ret) {
4176 ERROR(errp, "listening on socket!");
4177 goto cleanup_rdma;
4180 trace_rdma_start_incoming_migration_after_rdma_listen();
4182 qemu_set_fd_handler(rdma->channel->fd, rdma_accept_incoming_migration,
4183 NULL, (void *)(intptr_t)rdma);
4184 return;
4186 cleanup_rdma:
4187 qemu_rdma_cleanup(rdma);
4188 err:
4189 if (rdma) {
4190 g_free(rdma->host);
4191 g_free(rdma->host_port);
4193 g_free(rdma);
4196 void rdma_start_outgoing_migration(void *opaque,
4197 const char *host_port, Error **errp)
4199 MigrationState *s = opaque;
4200 RDMAContext *rdma_return_path = NULL;
4201 RDMAContext *rdma;
4202 int ret = 0;
4204 /* Avoid ram_block_discard_disable(), cannot change during migration. */
4205 if (ram_block_discard_is_required()) {
4206 error_setg(errp, "RDMA: cannot disable RAM discard");
4207 return;
4210 rdma = qemu_rdma_data_init(host_port, errp);
4211 if (rdma == NULL) {
4212 goto err;
4215 ret = qemu_rdma_source_init(rdma, migrate_rdma_pin_all(), errp);
4217 if (ret) {
4218 goto err;
4221 trace_rdma_start_outgoing_migration_after_rdma_source_init();
4222 ret = qemu_rdma_connect(rdma, false, errp);
4224 if (ret) {
4225 goto err;
4228 /* RDMA postcopy need a separate queue pair for return path */
4229 if (migrate_postcopy() || migrate_return_path()) {
4230 rdma_return_path = qemu_rdma_data_init(host_port, errp);
4232 if (rdma_return_path == NULL) {
4233 goto return_path_err;
4236 ret = qemu_rdma_source_init(rdma_return_path,
4237 migrate_rdma_pin_all(), errp);
4239 if (ret) {
4240 goto return_path_err;
4243 ret = qemu_rdma_connect(rdma_return_path, true, errp);
4245 if (ret) {
4246 goto return_path_err;
4249 rdma->return_path = rdma_return_path;
4250 rdma_return_path->return_path = rdma;
4251 rdma_return_path->is_return_path = true;
4254 trace_rdma_start_outgoing_migration_after_rdma_connect();
4256 s->to_dst_file = rdma_new_output(rdma);
4257 migrate_fd_connect(s, NULL);
4258 return;
4259 return_path_err:
4260 qemu_rdma_cleanup(rdma);
4261 err:
4262 g_free(rdma);
4263 g_free(rdma_return_path);