2 * QEMU live block migration
4 * Copyright IBM, Corp. 2009
9 * This work is licensed under the terms of the GNU GPL, version 2. See
10 * the COPYING file in the top-level directory.
14 #include "qemu-common.h"
15 #include "block_int.h"
17 #include "qemu-queue.h"
18 #include "qemu-timer.h"
20 #include "block-migration.h"
21 #include "migration.h"
24 #define BLOCK_SIZE (BDRV_SECTORS_PER_DIRTY_CHUNK << BDRV_SECTOR_BITS)
26 #define BLK_MIG_FLAG_DEVICE_BLOCK 0x01
27 #define BLK_MIG_FLAG_EOS 0x02
28 #define BLK_MIG_FLAG_PROGRESS 0x04
30 #define MAX_IS_ALLOCATED_SEARCH 65536
32 //#define DEBUG_BLK_MIGRATION
34 #ifdef DEBUG_BLK_MIGRATION
35 #define DPRINTF(fmt, ...) \
36 do { printf("blk_migration: " fmt, ## __VA_ARGS__); } while (0)
38 #define DPRINTF(fmt, ...) \
42 typedef struct BlkMigDevState {
48 int64_t completed_sectors;
49 int64_t total_sectors;
51 QSIMPLEQ_ENTRY(BlkMigDevState) entry;
52 unsigned long *aio_bitmap;
55 typedef struct BlkMigBlock {
62 BlockDriverAIOCB *aiocb;
65 QSIMPLEQ_ENTRY(BlkMigBlock) entry;
68 typedef struct BlkMigState {
71 QSIMPLEQ_HEAD(bmds_list, BlkMigDevState) bmds_list;
72 QSIMPLEQ_HEAD(blk_list, BlkMigBlock) blk_list;
76 int64_t total_sector_sum;
79 long double total_time;
83 static BlkMigState block_mig_state;
85 static void blk_send(QEMUFile *f, BlkMigBlock * blk)
89 /* sector number and flags */
90 qemu_put_be64(f, (blk->sector << BDRV_SECTOR_BITS)
91 | BLK_MIG_FLAG_DEVICE_BLOCK);
94 len = strlen(blk->bmds->bs->device_name);
95 qemu_put_byte(f, len);
96 qemu_put_buffer(f, (uint8_t *)blk->bmds->bs->device_name, len);
98 qemu_put_buffer(f, blk->buf, BLOCK_SIZE);
101 int blk_mig_active(void)
103 return !QSIMPLEQ_EMPTY(&block_mig_state.bmds_list);
106 uint64_t blk_mig_bytes_transferred(void)
108 BlkMigDevState *bmds;
111 QSIMPLEQ_FOREACH(bmds, &block_mig_state.bmds_list, entry) {
112 sum += bmds->completed_sectors;
114 return sum << BDRV_SECTOR_BITS;
117 uint64_t blk_mig_bytes_remaining(void)
119 return blk_mig_bytes_total() - blk_mig_bytes_transferred();
122 uint64_t blk_mig_bytes_total(void)
124 BlkMigDevState *bmds;
127 QSIMPLEQ_FOREACH(bmds, &block_mig_state.bmds_list, entry) {
128 sum += bmds->total_sectors;
130 return sum << BDRV_SECTOR_BITS;
133 static inline void add_avg_read_time(int64_t time)
135 block_mig_state.reads++;
136 block_mig_state.total_time += time;
139 static inline long double compute_read_bwidth(void)
141 assert(block_mig_state.total_time != 0);
142 return (block_mig_state.reads * BLOCK_SIZE)/ block_mig_state.total_time;
145 static int bmds_aio_inflight(BlkMigDevState *bmds, int64_t sector)
147 int64_t chunk = sector / (int64_t)BDRV_SECTORS_PER_DIRTY_CHUNK;
149 if ((sector << BDRV_SECTOR_BITS) < bdrv_getlength(bmds->bs)) {
150 return !!(bmds->aio_bitmap[chunk / (sizeof(unsigned long) * 8)] &
151 (1UL << (chunk % (sizeof(unsigned long) * 8))));
157 static void bmds_set_aio_inflight(BlkMigDevState *bmds, int64_t sector_num,
158 int nb_sectors, int set)
161 unsigned long val, idx, bit;
163 start = sector_num / BDRV_SECTORS_PER_DIRTY_CHUNK;
164 end = (sector_num + nb_sectors - 1) / BDRV_SECTORS_PER_DIRTY_CHUNK;
166 for (; start <= end; start++) {
167 idx = start / (sizeof(unsigned long) * 8);
168 bit = start % (sizeof(unsigned long) * 8);
169 val = bmds->aio_bitmap[idx];
173 val &= ~(1UL << bit);
175 bmds->aio_bitmap[idx] = val;
179 static void alloc_aio_bitmap(BlkMigDevState *bmds)
181 BlockDriverState *bs = bmds->bs;
184 bitmap_size = (bdrv_getlength(bs) >> BDRV_SECTOR_BITS) +
185 BDRV_SECTORS_PER_DIRTY_CHUNK * 8 - 1;
186 bitmap_size /= BDRV_SECTORS_PER_DIRTY_CHUNK * 8;
188 bmds->aio_bitmap = qemu_mallocz(bitmap_size);
191 static void blk_mig_read_cb(void *opaque, int ret)
193 BlkMigBlock *blk = opaque;
197 blk->time = qemu_get_clock_ns(rt_clock) - blk->time;
199 add_avg_read_time(blk->time);
201 QSIMPLEQ_INSERT_TAIL(&block_mig_state.blk_list, blk, entry);
202 bmds_set_aio_inflight(blk->bmds, blk->sector, blk->nr_sectors, 0);
204 block_mig_state.submitted--;
205 block_mig_state.read_done++;
206 assert(block_mig_state.submitted >= 0);
209 static int mig_save_device_bulk(Monitor *mon, QEMUFile *f,
210 BlkMigDevState *bmds)
212 int64_t total_sectors = bmds->total_sectors;
213 int64_t cur_sector = bmds->cur_sector;
214 BlockDriverState *bs = bmds->bs;
218 if (bmds->shared_base) {
219 while (cur_sector < total_sectors &&
220 !bdrv_is_allocated(bs, cur_sector, MAX_IS_ALLOCATED_SEARCH,
222 cur_sector += nr_sectors;
226 if (cur_sector >= total_sectors) {
227 bmds->cur_sector = bmds->completed_sectors = total_sectors;
231 bmds->completed_sectors = cur_sector;
233 cur_sector &= ~((int64_t)BDRV_SECTORS_PER_DIRTY_CHUNK - 1);
235 /* we are going to transfer a full block even if it is not allocated */
236 nr_sectors = BDRV_SECTORS_PER_DIRTY_CHUNK;
238 if (total_sectors - cur_sector < BDRV_SECTORS_PER_DIRTY_CHUNK) {
239 nr_sectors = total_sectors - cur_sector;
242 blk = qemu_malloc(sizeof(BlkMigBlock));
243 blk->buf = qemu_malloc(BLOCK_SIZE);
245 blk->sector = cur_sector;
246 blk->nr_sectors = nr_sectors;
248 blk->iov.iov_base = blk->buf;
249 blk->iov.iov_len = nr_sectors * BDRV_SECTOR_SIZE;
250 qemu_iovec_init_external(&blk->qiov, &blk->iov, 1);
252 blk->time = qemu_get_clock_ns(rt_clock);
254 blk->aiocb = bdrv_aio_readv(bs, cur_sector, &blk->qiov,
255 nr_sectors, blk_mig_read_cb, blk);
259 block_mig_state.submitted++;
261 bdrv_reset_dirty(bs, cur_sector, nr_sectors);
262 bmds->cur_sector = cur_sector + nr_sectors;
264 return (bmds->cur_sector >= total_sectors);
267 monitor_printf(mon, "Error reading sector %" PRId64 "\n", cur_sector);
268 qemu_file_set_error(f);
274 static void set_dirty_tracking(int enable)
276 BlkMigDevState *bmds;
278 QSIMPLEQ_FOREACH(bmds, &block_mig_state.bmds_list, entry) {
279 bdrv_set_dirty_tracking(bmds->bs, enable);
283 static void init_blk_migration_it(void *opaque, BlockDriverState *bs)
285 Monitor *mon = opaque;
286 BlkMigDevState *bmds;
289 if (!bdrv_is_read_only(bs)) {
290 sectors = bdrv_getlength(bs) >> BDRV_SECTOR_BITS;
295 bmds = qemu_mallocz(sizeof(BlkMigDevState));
297 bmds->bulk_completed = 0;
298 bmds->total_sectors = sectors;
299 bmds->completed_sectors = 0;
300 bmds->shared_base = block_mig_state.shared_base;
301 alloc_aio_bitmap(bmds);
303 block_mig_state.total_sector_sum += sectors;
305 if (bmds->shared_base) {
306 monitor_printf(mon, "Start migration for %s with shared base "
310 monitor_printf(mon, "Start full migration for %s\n",
314 QSIMPLEQ_INSERT_TAIL(&block_mig_state.bmds_list, bmds, entry);
318 static void init_blk_migration(Monitor *mon, QEMUFile *f)
320 block_mig_state.submitted = 0;
321 block_mig_state.read_done = 0;
322 block_mig_state.transferred = 0;
323 block_mig_state.total_sector_sum = 0;
324 block_mig_state.prev_progress = -1;
325 block_mig_state.bulk_completed = 0;
326 block_mig_state.total_time = 0;
327 block_mig_state.reads = 0;
329 bdrv_iterate(init_blk_migration_it, mon);
332 static int blk_mig_save_bulked_block(Monitor *mon, QEMUFile *f)
334 int64_t completed_sector_sum = 0;
335 BlkMigDevState *bmds;
339 QSIMPLEQ_FOREACH(bmds, &block_mig_state.bmds_list, entry) {
340 if (bmds->bulk_completed == 0) {
341 if (mig_save_device_bulk(mon, f, bmds) == 1) {
342 /* completed bulk section for this device */
343 bmds->bulk_completed = 1;
345 completed_sector_sum += bmds->completed_sectors;
349 completed_sector_sum += bmds->completed_sectors;
353 if (block_mig_state.total_sector_sum != 0) {
354 progress = completed_sector_sum * 100 /
355 block_mig_state.total_sector_sum;
359 if (progress != block_mig_state.prev_progress) {
360 block_mig_state.prev_progress = progress;
361 qemu_put_be64(f, (progress << BDRV_SECTOR_BITS)
362 | BLK_MIG_FLAG_PROGRESS);
363 monitor_printf(mon, "Completed %d %%\r", progress);
370 static void blk_mig_reset_dirty_cursor(void)
372 BlkMigDevState *bmds;
374 QSIMPLEQ_FOREACH(bmds, &block_mig_state.bmds_list, entry) {
379 static int mig_save_device_dirty(Monitor *mon, QEMUFile *f,
380 BlkMigDevState *bmds, int is_async)
383 int64_t total_sectors = bmds->total_sectors;
387 for (sector = bmds->cur_dirty; sector < bmds->total_sectors;) {
388 if (bmds_aio_inflight(bmds, sector)) {
391 if (bdrv_get_dirty(bmds->bs, sector)) {
393 if (total_sectors - sector < BDRV_SECTORS_PER_DIRTY_CHUNK) {
394 nr_sectors = total_sectors - sector;
396 nr_sectors = BDRV_SECTORS_PER_DIRTY_CHUNK;
398 blk = qemu_malloc(sizeof(BlkMigBlock));
399 blk->buf = qemu_malloc(BLOCK_SIZE);
401 blk->sector = sector;
402 blk->nr_sectors = nr_sectors;
405 blk->iov.iov_base = blk->buf;
406 blk->iov.iov_len = nr_sectors * BDRV_SECTOR_SIZE;
407 qemu_iovec_init_external(&blk->qiov, &blk->iov, 1);
409 blk->time = qemu_get_clock_ns(rt_clock);
411 blk->aiocb = bdrv_aio_readv(bmds->bs, sector, &blk->qiov,
412 nr_sectors, blk_mig_read_cb, blk);
416 block_mig_state.submitted++;
417 bmds_set_aio_inflight(bmds, sector, nr_sectors, 1);
419 if (bdrv_read(bmds->bs, sector, blk->buf,
429 bdrv_reset_dirty(bmds->bs, sector, nr_sectors);
432 sector += BDRV_SECTORS_PER_DIRTY_CHUNK;
433 bmds->cur_dirty = sector;
436 return (bmds->cur_dirty >= bmds->total_sectors);
439 monitor_printf(mon, "Error reading sector %" PRId64 "\n", sector);
440 qemu_file_set_error(f);
446 static int blk_mig_save_dirty_block(Monitor *mon, QEMUFile *f, int is_async)
448 BlkMigDevState *bmds;
451 QSIMPLEQ_FOREACH(bmds, &block_mig_state.bmds_list, entry) {
452 if (mig_save_device_dirty(mon, f, bmds, is_async) == 0) {
461 static void flush_blks(QEMUFile* f)
465 DPRINTF("%s Enter submitted %d read_done %d transferred %d\n",
466 __FUNCTION__, block_mig_state.submitted, block_mig_state.read_done,
467 block_mig_state.transferred);
469 while ((blk = QSIMPLEQ_FIRST(&block_mig_state.blk_list)) != NULL) {
470 if (qemu_file_rate_limit(f)) {
474 qemu_file_set_error(f);
479 QSIMPLEQ_REMOVE_HEAD(&block_mig_state.blk_list, entry);
483 block_mig_state.read_done--;
484 block_mig_state.transferred++;
485 assert(block_mig_state.read_done >= 0);
488 DPRINTF("%s Exit submitted %d read_done %d transferred %d\n", __FUNCTION__,
489 block_mig_state.submitted, block_mig_state.read_done,
490 block_mig_state.transferred);
493 static int64_t get_remaining_dirty(void)
495 BlkMigDevState *bmds;
498 QSIMPLEQ_FOREACH(bmds, &block_mig_state.bmds_list, entry) {
499 dirty += bdrv_get_dirty_count(bmds->bs);
502 return dirty * BLOCK_SIZE;
505 static int is_stage2_completed(void)
507 int64_t remaining_dirty;
510 if (block_mig_state.bulk_completed == 1) {
512 remaining_dirty = get_remaining_dirty();
513 if (remaining_dirty == 0) {
517 bwidth = compute_read_bwidth();
519 if ((remaining_dirty / bwidth) <=
520 migrate_max_downtime()) {
521 /* finish stage2 because we think that we can finish remaing work
522 below max_downtime */
531 static void blk_mig_cleanup(Monitor *mon)
533 BlkMigDevState *bmds;
536 while ((bmds = QSIMPLEQ_FIRST(&block_mig_state.bmds_list)) != NULL) {
537 QSIMPLEQ_REMOVE_HEAD(&block_mig_state.bmds_list, entry);
538 qemu_free(bmds->aio_bitmap);
542 while ((blk = QSIMPLEQ_FIRST(&block_mig_state.blk_list)) != NULL) {
543 QSIMPLEQ_REMOVE_HEAD(&block_mig_state.blk_list, entry);
548 set_dirty_tracking(0);
550 monitor_printf(mon, "\n");
553 static int block_save_live(Monitor *mon, QEMUFile *f, int stage, void *opaque)
555 DPRINTF("Enter save live stage %d submitted %d transferred %d\n",
556 stage, block_mig_state.submitted, block_mig_state.transferred);
559 blk_mig_cleanup(mon);
563 if (block_mig_state.blk_enable != 1) {
564 /* no need to migrate storage */
565 qemu_put_be64(f, BLK_MIG_FLAG_EOS);
570 init_blk_migration(mon, f);
572 /* start track dirty blocks */
573 set_dirty_tracking(1);
578 if (qemu_file_has_error(f)) {
579 blk_mig_cleanup(mon);
583 blk_mig_reset_dirty_cursor();
586 /* control the rate of transfer */
587 while ((block_mig_state.submitted +
588 block_mig_state.read_done) * BLOCK_SIZE <
589 qemu_file_get_rate_limit(f)) {
590 if (block_mig_state.bulk_completed == 0) {
591 /* first finish the bulk phase */
592 if (blk_mig_save_bulked_block(mon, f) == 0) {
593 /* finished saving bulk on all devices */
594 block_mig_state.bulk_completed = 1;
597 if (blk_mig_save_dirty_block(mon, f, 1) == 0) {
598 /* no more dirty blocks */
606 if (qemu_file_has_error(f)) {
607 blk_mig_cleanup(mon);
613 /* we know for sure that save bulk is completed and
614 all async read completed */
615 assert(block_mig_state.submitted == 0);
617 while (blk_mig_save_dirty_block(mon, f, 0) != 0);
618 blk_mig_cleanup(mon);
620 /* report completion */
621 qemu_put_be64(f, (100 << BDRV_SECTOR_BITS) | BLK_MIG_FLAG_PROGRESS);
623 if (qemu_file_has_error(f)) {
627 monitor_printf(mon, "Block migration completed\n");
630 qemu_put_be64(f, BLK_MIG_FLAG_EOS);
632 return ((stage == 2) && is_stage2_completed());
635 static int block_load(QEMUFile *f, void *opaque, int version_id)
637 static int banner_printed;
639 char device_name[256];
641 BlockDriverState *bs, *bs_prev = NULL;
643 int64_t total_sectors = 0;
647 addr = qemu_get_be64(f);
649 flags = addr & ~BDRV_SECTOR_MASK;
650 addr >>= BDRV_SECTOR_BITS;
652 if (flags & BLK_MIG_FLAG_DEVICE_BLOCK) {
654 /* get device name */
655 len = qemu_get_byte(f);
656 qemu_get_buffer(f, (uint8_t *)device_name, len);
657 device_name[len] = '\0';
659 bs = bdrv_find(device_name);
661 fprintf(stderr, "Error unknown block device %s\n",
668 total_sectors = bdrv_getlength(bs) >> BDRV_SECTOR_BITS;
669 if (total_sectors <= 0) {
670 error_report("Error getting length of block device %s\n",
676 if (total_sectors - addr < BDRV_SECTORS_PER_DIRTY_CHUNK) {
677 nr_sectors = total_sectors - addr;
679 nr_sectors = BDRV_SECTORS_PER_DIRTY_CHUNK;
682 buf = qemu_malloc(BLOCK_SIZE);
684 qemu_get_buffer(f, buf, BLOCK_SIZE);
685 ret = bdrv_write(bs, addr, buf, nr_sectors);
691 } else if (flags & BLK_MIG_FLAG_PROGRESS) {
692 if (!banner_printed) {
693 printf("Receiving block device images\n");
696 printf("Completed %d %%%c", (int)addr,
697 (addr == 100) ? '\n' : '\r');
699 } else if (!(flags & BLK_MIG_FLAG_EOS)) {
700 fprintf(stderr, "Unknown flags\n");
703 if (qemu_file_has_error(f)) {
706 } while (!(flags & BLK_MIG_FLAG_EOS));
711 static void block_set_params(int blk_enable, int shared_base, void *opaque)
713 block_mig_state.blk_enable = blk_enable;
714 block_mig_state.shared_base = shared_base;
716 /* shared base means that blk_enable = 1 */
717 block_mig_state.blk_enable |= shared_base;
720 void blk_mig_init(void)
722 QSIMPLEQ_INIT(&block_mig_state.bmds_list);
723 QSIMPLEQ_INIT(&block_mig_state.blk_list);
725 register_savevm_live(NULL, "block", 0, 1, block_set_params,
726 block_save_live, NULL, block_load, &block_mig_state);