migration/block.c

   1 /*
   2  * QEMU live block migration
   3  *
   4  * Copyright IBM, Corp. 2009
   5  *
   6  * Authors:
   7  *  Liran Schour   <lirans@il.ibm.com>
   8  *
   9  * This work is licensed under the terms of the GNU GPL, version 2.  See
  10  * the COPYING file in the top-level directory.
  11  *
  12  * Contributions after 2012-01-13 are licensed under the terms of the
  13  * GNU GPL, version 2 or (at your option) any later version.
  14  */
  15
  16 #include "qemu/osdep.h"
  17 #include "qapi/error.h"
  18 #include "qemu-common.h"
  19 #include "block/block.h"
  20 #include "qemu/error-report.h"
  21 #include "qemu/main-loop.h"
  22 #include "hw/hw.h"
  23 #include "qemu/cutils.h"
  24 #include "qemu/queue.h"
  25 #include "qemu/timer.h"
  26 #include "migration/block.h"
  27 #include "migration/migration.h"
  28 #include "sysemu/blockdev.h"
  29 #include "sysemu/block-backend.h"
  30
  31 #define BLOCK_SIZE                       (1 << 20)
  32 #define BDRV_SECTORS_PER_DIRTY_CHUNK     (BLOCK_SIZE >> BDRV_SECTOR_BITS)
  33
  34 #define BLK_MIG_FLAG_DEVICE_BLOCK       0x01
  35 #define BLK_MIG_FLAG_EOS                0x02
  36 #define BLK_MIG_FLAG_PROGRESS           0x04
  37 #define BLK_MIG_FLAG_ZERO_BLOCK         0x08
  38
  39 #define MAX_IS_ALLOCATED_SEARCH 65536
  40
  41 #define MAX_INFLIGHT_IO 512
  42
  43 //#define DEBUG_BLK_MIGRATION
  44
  45 #ifdef DEBUG_BLK_MIGRATION
  46 #define DPRINTF(fmt, ...) \
  47     do { printf("blk_migration: " fmt, ## __VA_ARGS__); } while (0)
  48 #else
  49 #define DPRINTF(fmt, ...) \
  50     do { } while (0)
  51 #endif
  52
  53 typedef struct BlkMigDevState {
  54     /* Written during setup phase.  Can be read without a lock.  */
  55     BlockBackend *blk;
  56     char *blk_name;
  57     int shared_base;
  58     int64_t total_sectors;
  59     QSIMPLEQ_ENTRY(BlkMigDevState) entry;
  60     Error *blocker;
  61
  62     /* Only used by migration thread.  Does not need a lock.  */
  63     int bulk_completed;
  64     int64_t cur_sector;
  65     int64_t cur_dirty;
  66
  67     /* Data in the aio_bitmap is protected by block migration lock.
  68      * Allocation and free happen during setup and cleanup respectively.
  69      */
  70     unsigned long *aio_bitmap;
  71
  72     /* Protected by block migration lock.  */
  73     int64_t completed_sectors;
  74
  75     /* During migration this is protected by iothread lock / AioContext.
  76      * Allocation and free happen during setup and cleanup respectively.
  77      */
  78     BdrvDirtyBitmap *dirty_bitmap;
  79 } BlkMigDevState;
  80
  81 typedef struct BlkMigBlock {
  82     /* Only used by migration thread.  */
  83     uint8_t *buf;
  84     BlkMigDevState *bmds;
  85     int64_t sector;
  86     int nr_sectors;
  87     struct iovec iov;
  88     QEMUIOVector qiov;
  89     BlockAIOCB *aiocb;
  90
  91     /* Protected by block migration lock.  */
  92     int ret;
  93     QSIMPLEQ_ENTRY(BlkMigBlock) entry;
  94 } BlkMigBlock;
  95
  96 typedef struct BlkMigState {
  97     /* Written during setup phase.  Can be read without a lock.  */
  98     int blk_enable;
  99     int shared_base;
 100     QSIMPLEQ_HEAD(bmds_list, BlkMigDevState) bmds_list;
 101     int64_t total_sector_sum;
 102     bool zero_blocks;
 103
 104     /* Protected by lock.  */
 105     QSIMPLEQ_HEAD(blk_list, BlkMigBlock) blk_list;
 106     int submitted;
 107     int read_done;
 108
 109     /* Only used by migration thread.  Does not need a lock.  */
 110     int transferred;
 111     int prev_progress;
 112     int bulk_completed;
 113
 114     /* Lock must be taken _inside_ the iothread lock and any AioContexts.  */
 115     QemuMutex lock;
 116 } BlkMigState;
 117
 118 static BlkMigState block_mig_state;
 119
 120 static void blk_mig_lock(void)
 121 {
 122     qemu_mutex_lock(&block_mig_state.lock);
 123 }
 124
 125 static void blk_mig_unlock(void)
 126 {
 127     qemu_mutex_unlock(&block_mig_state.lock);
 128 }
 129
 130 /* Must run outside of the iothread lock during the bulk phase,
 131  * or the VM will stall.
 132  */
 133
 134 static void blk_send(QEMUFile *f, BlkMigBlock * blk)
 135 {
 136     int len;
 137     uint64_t flags = BLK_MIG_FLAG_DEVICE_BLOCK;
 138
 139     if (block_mig_state.zero_blocks &&
 140         buffer_is_zero(blk->buf, BLOCK_SIZE)) {
 141         flags |= BLK_MIG_FLAG_ZERO_BLOCK;
 142     }
 143
 144     /* sector number and flags */
 145     qemu_put_be64(f, (blk->sector << BDRV_SECTOR_BITS)
 146                      | flags);
 147
 148     /* device name */
 149     len = strlen(blk->bmds->blk_name);
 150     qemu_put_byte(f, len);
 151     qemu_put_buffer(f, (uint8_t *) blk->bmds->blk_name, len);
 152
 153     /* if a block is zero we need to flush here since the network
 154      * bandwidth is now a lot higher than the storage device bandwidth.
 155      * thus if we queue zero blocks we slow down the migration */
 156     if (flags & BLK_MIG_FLAG_ZERO_BLOCK) {
 157         qemu_fflush(f);
 158         return;
 159     }
 160
 161     qemu_put_buffer(f, blk->buf, BLOCK_SIZE);
 162 }
 163
 164 int blk_mig_active(void)
 165 {
 166     return !QSIMPLEQ_EMPTY(&block_mig_state.bmds_list);
 167 }
 168
 169 uint64_t blk_mig_bytes_transferred(void)
 170 {
 171     BlkMigDevState *bmds;
 172     uint64_t sum = 0;
 173
 174     blk_mig_lock();
 175     QSIMPLEQ_FOREACH(bmds, &block_mig_state.bmds_list, entry) {
 176         sum += bmds->completed_sectors;
 177     }
 178     blk_mig_unlock();
 179     return sum << BDRV_SECTOR_BITS;
 180 }
 181
 182 uint64_t blk_mig_bytes_remaining(void)
 183 {
 184     return blk_mig_bytes_total() - blk_mig_bytes_transferred();
 185 }
 186
 187 uint64_t blk_mig_bytes_total(void)
 188 {
 189     BlkMigDevState *bmds;
 190     uint64_t sum = 0;
 191
 192     QSIMPLEQ_FOREACH(bmds, &block_mig_state.bmds_list, entry) {
 193         sum += bmds->total_sectors;
 194     }
 195     return sum << BDRV_SECTOR_BITS;
 196 }
 197
 198
 199 /* Called with migration lock held.  */
 200
 201 static int bmds_aio_inflight(BlkMigDevState *bmds, int64_t sector)
 202 {
 203     int64_t chunk = sector / (int64_t)BDRV_SECTORS_PER_DIRTY_CHUNK;
 204
 205     if (sector < blk_nb_sectors(bmds->blk)) {
 206         return !!(bmds->aio_bitmap[chunk / (sizeof(unsigned long) * 8)] &
 207             (1UL << (chunk % (sizeof(unsigned long) * 8))));
 208     } else {
 209         return 0;
 210     }
 211 }
 212
 213 /* Called with migration lock held.  */
 214
 215 static void bmds_set_aio_inflight(BlkMigDevState *bmds, int64_t sector_num,
 216                              int nb_sectors, int set)
 217 {
 218     int64_t start, end;
 219     unsigned long val, idx, bit;
 220
 221     start = sector_num / BDRV_SECTORS_PER_DIRTY_CHUNK;
 222     end = (sector_num + nb_sectors - 1) / BDRV_SECTORS_PER_DIRTY_CHUNK;
 223
 224     for (; start <= end; start++) {
 225         idx = start / (sizeof(unsigned long) * 8);
 226         bit = start % (sizeof(unsigned long) * 8);
 227         val = bmds->aio_bitmap[idx];
 228         if (set) {
 229             val |= 1UL << bit;
 230         } else {
 231             val &= ~(1UL << bit);
 232         }
 233         bmds->aio_bitmap[idx] = val;
 234     }
 235 }
 236
 237 static void alloc_aio_bitmap(BlkMigDevState *bmds)
 238 {
 239     BlockBackend *bb = bmds->blk;
 240     int64_t bitmap_size;
 241
 242     bitmap_size = blk_nb_sectors(bb) + BDRV_SECTORS_PER_DIRTY_CHUNK * 8 - 1;
 243     bitmap_size /= BDRV_SECTORS_PER_DIRTY_CHUNK * 8;
 244
 245     bmds->aio_bitmap = g_malloc0(bitmap_size);
 246 }
 247
 248 /* Never hold migration lock when yielding to the main loop!  */
 249
 250 static void blk_mig_read_cb(void *opaque, int ret)
 251 {
 252     BlkMigBlock *blk = opaque;
 253
 254     blk_mig_lock();
 255     blk->ret = ret;
 256
 257     QSIMPLEQ_INSERT_TAIL(&block_mig_state.blk_list, blk, entry);
 258     bmds_set_aio_inflight(blk->bmds, blk->sector, blk->nr_sectors, 0);
 259
 260     block_mig_state.submitted--;
 261     block_mig_state.read_done++;
 262     assert(block_mig_state.submitted >= 0);
 263     blk_mig_unlock();
 264 }
 265
 266 /* Called with no lock taken.  */
 267
 268 static int mig_save_device_bulk(QEMUFile *f, BlkMigDevState *bmds)
 269 {
 270     int64_t total_sectors = bmds->total_sectors;
 271     int64_t cur_sector = bmds->cur_sector;
 272     BlockBackend *bb = bmds->blk;
 273     BlkMigBlock *blk;
 274     int nr_sectors;
 275
 276     if (bmds->shared_base) {
 277         qemu_mutex_lock_iothread();
 278         aio_context_acquire(blk_get_aio_context(bb));
 279         while (cur_sector < total_sectors &&
 280                !bdrv_is_allocated(blk_bs(bb), cur_sector,
 281                                   MAX_IS_ALLOCATED_SEARCH, &nr_sectors)) {
 282             cur_sector += nr_sectors;
 283         }
 284         aio_context_release(blk_get_aio_context(bb));
 285         qemu_mutex_unlock_iothread();
 286     }
 287
 288     if (cur_sector >= total_sectors) {
 289         bmds->cur_sector = bmds->completed_sectors = total_sectors;
 290         return 1;
 291     }
 292
 293     bmds->completed_sectors = cur_sector;
 294
 295     cur_sector &= ~((int64_t)BDRV_SECTORS_PER_DIRTY_CHUNK - 1);
 296
 297     /* we are going to transfer a full block even if it is not allocated */
 298     nr_sectors = BDRV_SECTORS_PER_DIRTY_CHUNK;
 299
 300     if (total_sectors - cur_sector < BDRV_SECTORS_PER_DIRTY_CHUNK) {
 301         nr_sectors = total_sectors - cur_sector;
 302     }
 303
 304     blk = g_new(BlkMigBlock, 1);
 305     blk->buf = g_malloc(BLOCK_SIZE);
 306     blk->bmds = bmds;
 307     blk->sector = cur_sector;
 308     blk->nr_sectors = nr_sectors;
 309
 310     blk->iov.iov_base = blk->buf;
 311     blk->iov.iov_len = nr_sectors * BDRV_SECTOR_SIZE;
 312     qemu_iovec_init_external(&blk->qiov, &blk->iov, 1);
 313
 314     blk_mig_lock();
 315     block_mig_state.submitted++;
 316     blk_mig_unlock();
 317
 318     /* We do not know if bs is under the main thread (and thus does
 319      * not acquire the AioContext when doing AIO) or rather under
 320      * dataplane.  Thus acquire both the iothread mutex and the
 321      * AioContext.
 322      *
 323      * This is ugly and will disappear when we make bdrv_* thread-safe,
 324      * without the need to acquire the AioContext.
 325      */
 326     qemu_mutex_lock_iothread();
 327     aio_context_acquire(blk_get_aio_context(bmds->blk));
 328     blk->aiocb = blk_aio_preadv(bb, cur_sector * BDRV_SECTOR_SIZE, &blk->qiov,
 329                                 0, blk_mig_read_cb, blk);
 330
 331     bdrv_reset_dirty_bitmap(bmds->dirty_bitmap, cur_sector, nr_sectors);
 332     aio_context_release(blk_get_aio_context(bmds->blk));
 333     qemu_mutex_unlock_iothread();
 334
 335     bmds->cur_sector = cur_sector + nr_sectors;
 336     return (bmds->cur_sector >= total_sectors);
 337 }
 338
 339 /* Called with iothread lock taken.  */
 340
 341 static int set_dirty_tracking(void)
 342 {
 343     BlkMigDevState *bmds;
 344     int ret;
 345
 346     QSIMPLEQ_FOREACH(bmds, &block_mig_state.bmds_list, entry) {
 347         aio_context_acquire(blk_get_aio_context(bmds->blk));
 348         bmds->dirty_bitmap = bdrv_create_dirty_bitmap(blk_bs(bmds->blk),
 349                                                       BLOCK_SIZE, NULL, NULL);
 350         aio_context_release(blk_get_aio_context(bmds->blk));
 351         if (!bmds->dirty_bitmap) {
 352             ret = -errno;
 353             goto fail;
 354         }
 355     }
 356     return 0;
 357
 358 fail:
 359     QSIMPLEQ_FOREACH(bmds, &block_mig_state.bmds_list, entry) {
 360         if (bmds->dirty_bitmap) {
 361             aio_context_acquire(blk_get_aio_context(bmds->blk));
 362             bdrv_release_dirty_bitmap(blk_bs(bmds->blk), bmds->dirty_bitmap);
 363             aio_context_release(blk_get_aio_context(bmds->blk));
 364         }
 365     }
 366     return ret;
 367 }
 368
 369 /* Called with iothread lock taken.  */
 370
 371 static void unset_dirty_tracking(void)
 372 {
 373     BlkMigDevState *bmds;
 374
 375     QSIMPLEQ_FOREACH(bmds, &block_mig_state.bmds_list, entry) {
 376         aio_context_acquire(blk_get_aio_context(bmds->blk));
 377         bdrv_release_dirty_bitmap(blk_bs(bmds->blk), bmds->dirty_bitmap);
 378         aio_context_release(blk_get_aio_context(bmds->blk));
 379     }
 380 }
 381
 382 static void init_blk_migration(QEMUFile *f)
 383 {
 384     BlockDriverState *bs;
 385     BlkMigDevState *bmds;
 386     int64_t sectors;
 387     BdrvNextIterator it;
 388     int i, num_bs = 0;
 389     struct {
 390         BlkMigDevState *bmds;
 391         BlockDriverState *bs;
 392     } *bmds_bs;
 393
 394     block_mig_state.submitted = 0;
 395     block_mig_state.read_done = 0;
 396     block_mig_state.transferred = 0;
 397     block_mig_state.total_sector_sum = 0;
 398     block_mig_state.prev_progress = -1;
 399     block_mig_state.bulk_completed = 0;
 400     block_mig_state.zero_blocks = migrate_zero_blocks();
 401
 402     for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
 403         num_bs++;
 404     }
 405     bmds_bs = g_malloc0(num_bs * sizeof(*bmds_bs));
 406
 407     for (i = 0, bs = bdrv_first(&it); bs; bs = bdrv_next(&it), i++) {
 408         if (bdrv_is_read_only(bs)) {
 409             continue;
 410         }
 411
 412         sectors = bdrv_nb_sectors(bs);
 413         if (sectors <= 0) {
 414             goto out;
 415         }
 416
 417         bmds = g_new0(BlkMigDevState, 1);
 418         /* FIXME Use real permissions */
 419         bmds->blk = blk_new(0, BLK_PERM_ALL);
 420         bmds->blk_name = g_strdup(bdrv_get_device_name(bs));
 421         bmds->bulk_completed = 0;
 422         bmds->total_sectors = sectors;
 423         bmds->completed_sectors = 0;
 424         bmds->shared_base = block_mig_state.shared_base;
 425
 426         assert(i < num_bs);
 427         bmds_bs[i].bmds = bmds;
 428         bmds_bs[i].bs = bs;
 429
 430         block_mig_state.total_sector_sum += sectors;
 431
 432         if (bmds->shared_base) {
 433             DPRINTF("Start migration for %s with shared base image\n",
 434                     bdrv_get_device_name(bs));
 435         } else {
 436             DPRINTF("Start full migration for %s\n", bdrv_get_device_name(bs));
 437         }
 438
 439         QSIMPLEQ_INSERT_TAIL(&block_mig_state.bmds_list, bmds, entry);
 440     }
 441
 442     /* Can only insert new BDSes now because doing so while iterating block
 443      * devices may end up in a deadlock (iterating the new BDSes, too). */
 444     for (i = 0; i < num_bs; i++) {
 445         BlkMigDevState *bmds = bmds_bs[i].bmds;
 446         BlockDriverState *bs = bmds_bs[i].bs;
 447
 448         if (bmds) {
 449             blk_insert_bs(bmds->blk, bs, &error_abort);
 450
 451             alloc_aio_bitmap(bmds);
 452             error_setg(&bmds->blocker, "block device is in use by migration");
 453             bdrv_op_block_all(bs, bmds->blocker);
 454         }
 455     }
 456
 457 out:
 458     g_free(bmds_bs);
 459 }
 460
 461 /* Called with no lock taken.  */
 462
 463 static int blk_mig_save_bulked_block(QEMUFile *f)
 464 {
 465     int64_t completed_sector_sum = 0;
 466     BlkMigDevState *bmds;
 467     int progress;
 468     int ret = 0;
 469
 470     QSIMPLEQ_FOREACH(bmds, &block_mig_state.bmds_list, entry) {
 471         if (bmds->bulk_completed == 0) {
 472             if (mig_save_device_bulk(f, bmds) == 1) {
 473                 /* completed bulk section for this device */
 474                 bmds->bulk_completed = 1;
 475             }
 476             completed_sector_sum += bmds->completed_sectors;
 477             ret = 1;
 478             break;
 479         } else {
 480             completed_sector_sum += bmds->completed_sectors;
 481         }
 482     }
 483
 484     if (block_mig_state.total_sector_sum != 0) {
 485         progress = completed_sector_sum * 100 /
 486                    block_mig_state.total_sector_sum;
 487     } else {
 488         progress = 100;
 489     }
 490     if (progress != block_mig_state.prev_progress) {
 491         block_mig_state.prev_progress = progress;
 492         qemu_put_be64(f, (progress << BDRV_SECTOR_BITS)
 493                          | BLK_MIG_FLAG_PROGRESS);
 494         DPRINTF("Completed %d %%\r", progress);
 495     }
 496
 497     return ret;
 498 }
 499
 500 static void blk_mig_reset_dirty_cursor(void)
 501 {
 502     BlkMigDevState *bmds;
 503
 504     QSIMPLEQ_FOREACH(bmds, &block_mig_state.bmds_list, entry) {
 505         bmds->cur_dirty = 0;
 506     }
 507 }
 508
 509 /* Called with iothread lock and AioContext taken.  */
 510
 511 static int mig_save_device_dirty(QEMUFile *f, BlkMigDevState *bmds,
 512                                  int is_async)
 513 {
 514     BlkMigBlock *blk;
 515     BlockDriverState *bs = blk_bs(bmds->blk);
 516     int64_t total_sectors = bmds->total_sectors;
 517     int64_t sector;
 518     int nr_sectors;
 519     int ret = -EIO;
 520
 521     for (sector = bmds->cur_dirty; sector < bmds->total_sectors;) {
 522         blk_mig_lock();
 523         if (bmds_aio_inflight(bmds, sector)) {
 524             blk_mig_unlock();
 525             blk_drain(bmds->blk);
 526         } else {
 527             blk_mig_unlock();
 528         }
 529         if (bdrv_get_dirty(bs, bmds->dirty_bitmap, sector)) {
 530
 531             if (total_sectors - sector < BDRV_SECTORS_PER_DIRTY_CHUNK) {
 532                 nr_sectors = total_sectors - sector;
 533             } else {
 534                 nr_sectors = BDRV_SECTORS_PER_DIRTY_CHUNK;
 535             }
 536             blk = g_new(BlkMigBlock, 1);
 537             blk->buf = g_malloc(BLOCK_SIZE);
 538             blk->bmds = bmds;
 539             blk->sector = sector;
 540             blk->nr_sectors = nr_sectors;
 541
 542             if (is_async) {
 543                 blk->iov.iov_base = blk->buf;
 544                 blk->iov.iov_len = nr_sectors * BDRV_SECTOR_SIZE;
 545                 qemu_iovec_init_external(&blk->qiov, &blk->iov, 1);
 546
 547                 blk->aiocb = blk_aio_preadv(bmds->blk,
 548                                             sector * BDRV_SECTOR_SIZE,
 549                                             &blk->qiov, 0, blk_mig_read_cb,
 550                                             blk);
 551
 552                 blk_mig_lock();
 553                 block_mig_state.submitted++;
 554                 bmds_set_aio_inflight(bmds, sector, nr_sectors, 1);
 555                 blk_mig_unlock();
 556             } else {
 557                 ret = blk_pread(bmds->blk, sector * BDRV_SECTOR_SIZE, blk->buf,
 558                                 nr_sectors * BDRV_SECTOR_SIZE);
 559                 if (ret < 0) {
 560                     goto error;
 561                 }
 562                 blk_send(f, blk);
 563
 564                 g_free(blk->buf);
 565                 g_free(blk);
 566             }
 567
 568             bdrv_reset_dirty_bitmap(bmds->dirty_bitmap, sector, nr_sectors);
 569             break;
 570         }
 571         sector += BDRV_SECTORS_PER_DIRTY_CHUNK;
 572         bmds->cur_dirty = sector;
 573     }
 574
 575     return (bmds->cur_dirty >= bmds->total_sectors);
 576
 577 error:
 578     DPRINTF("Error reading sector %" PRId64 "\n", sector);
 579     g_free(blk->buf);
 580     g_free(blk);
 581     return ret;
 582 }
 583
 584 /* Called with iothread lock taken.
 585  *
 586  * return value:
 587  * 0: too much data for max_downtime
 588  * 1: few enough data for max_downtime
 589 */
 590 static int blk_mig_save_dirty_block(QEMUFile *f, int is_async)
 591 {
 592     BlkMigDevState *bmds;
 593     int ret = 1;
 594
 595     QSIMPLEQ_FOREACH(bmds, &block_mig_state.bmds_list, entry) {
 596         aio_context_acquire(blk_get_aio_context(bmds->blk));
 597         ret = mig_save_device_dirty(f, bmds, is_async);
 598         aio_context_release(blk_get_aio_context(bmds->blk));
 599         if (ret <= 0) {
 600             break;
 601         }
 602     }
 603
 604     return ret;
 605 }
 606
 607 /* Called with no locks taken.  */
 608
 609 static int flush_blks(QEMUFile *f)
 610 {
 611     BlkMigBlock *blk;
 612     int ret = 0;
 613
 614     DPRINTF("%s Enter submitted %d read_done %d transferred %d\n",
 615             __FUNCTION__, block_mig_state.submitted, block_mig_state.read_done,
 616             block_mig_state.transferred);
 617
 618     blk_mig_lock();
 619     while ((blk = QSIMPLEQ_FIRST(&block_mig_state.blk_list)) != NULL) {
 620         if (qemu_file_rate_limit(f)) {
 621             break;
 622         }
 623         if (blk->ret < 0) {
 624             ret = blk->ret;
 625             break;
 626         }
 627
 628         QSIMPLEQ_REMOVE_HEAD(&block_mig_state.blk_list, entry);
 629         blk_mig_unlock();
 630         blk_send(f, blk);
 631         blk_mig_lock();
 632
 633         g_free(blk->buf);
 634         g_free(blk);
 635
 636         block_mig_state.read_done--;
 637         block_mig_state.transferred++;
 638         assert(block_mig_state.read_done >= 0);
 639     }
 640     blk_mig_unlock();
 641
 642     DPRINTF("%s Exit submitted %d read_done %d transferred %d\n", __FUNCTION__,
 643             block_mig_state.submitted, block_mig_state.read_done,
 644             block_mig_state.transferred);
 645     return ret;
 646 }
 647
 648 /* Called with iothread lock taken.  */
 649
 650 static int64_t get_remaining_dirty(void)
 651 {
 652     BlkMigDevState *bmds;
 653     int64_t dirty = 0;
 654
 655     QSIMPLEQ_FOREACH(bmds, &block_mig_state.bmds_list, entry) {
 656         aio_context_acquire(blk_get_aio_context(bmds->blk));
 657         dirty += bdrv_get_dirty_count(bmds->dirty_bitmap);
 658         aio_context_release(blk_get_aio_context(bmds->blk));
 659     }
 660
 661     return dirty << BDRV_SECTOR_BITS;
 662 }
 663
 664 /* Called with iothread lock taken.  */
 665
 666 static void block_migration_cleanup(void *opaque)
 667 {
 668     BlkMigDevState *bmds;
 669     BlkMigBlock *blk;
 670     AioContext *ctx;
 671
 672     bdrv_drain_all();
 673
 674     unset_dirty_tracking();
 675
 676     while ((bmds = QSIMPLEQ_FIRST(&block_mig_state.bmds_list)) != NULL) {
 677         QSIMPLEQ_REMOVE_HEAD(&block_mig_state.bmds_list, entry);
 678         bdrv_op_unblock_all(blk_bs(bmds->blk), bmds->blocker);
 679         error_free(bmds->blocker);
 680
 681         /* Save ctx, because bmds->blk can disappear during blk_unref.  */
 682         ctx = blk_get_aio_context(bmds->blk);
 683         aio_context_acquire(ctx);
 684         blk_unref(bmds->blk);
 685         aio_context_release(ctx);
 686
 687         g_free(bmds->blk_name);
 688         g_free(bmds->aio_bitmap);
 689         g_free(bmds);
 690     }
 691
 692     blk_mig_lock();
 693     while ((blk = QSIMPLEQ_FIRST(&block_mig_state.blk_list)) != NULL) {
 694         QSIMPLEQ_REMOVE_HEAD(&block_mig_state.blk_list, entry);
 695         g_free(blk->buf);
 696         g_free(blk);
 697     }
 698     blk_mig_unlock();
 699 }
 700
 701 static int block_save_setup(QEMUFile *f, void *opaque)
 702 {
 703     int ret;
 704
 705     DPRINTF("Enter save live setup submitted %d transferred %d\n",
 706             block_mig_state.submitted, block_mig_state.transferred);
 707
 708     qemu_mutex_lock_iothread();
 709     init_blk_migration(f);
 710
 711     /* start track dirty blocks */
 712     ret = set_dirty_tracking();
 713
 714     qemu_mutex_unlock_iothread();
 715
 716     if (ret) {
 717         return ret;
 718     }
 719
 720     ret = flush_blks(f);
 721     blk_mig_reset_dirty_cursor();
 722     qemu_put_be64(f, BLK_MIG_FLAG_EOS);
 723
 724     return ret;
 725 }
 726
 727 static int block_save_iterate(QEMUFile *f, void *opaque)
 728 {
 729     int ret;
 730     int64_t last_ftell = qemu_ftell(f);
 731     int64_t delta_ftell;
 732
 733     DPRINTF("Enter save live iterate submitted %d transferred %d\n",
 734             block_mig_state.submitted, block_mig_state.transferred);
 735
 736     ret = flush_blks(f);
 737     if (ret) {
 738         return ret;
 739     }
 740
 741     blk_mig_reset_dirty_cursor();
 742
 743     /* control the rate of transfer */
 744     blk_mig_lock();
 745     while ((block_mig_state.submitted +
 746             block_mig_state.read_done) * BLOCK_SIZE <
 747            qemu_file_get_rate_limit(f) &&
 748            (block_mig_state.submitted +
 749             block_mig_state.read_done) <
 750            MAX_INFLIGHT_IO) {
 751         blk_mig_unlock();
 752         if (block_mig_state.bulk_completed == 0) {
 753             /* first finish the bulk phase */
 754             if (blk_mig_save_bulked_block(f) == 0) {
 755                 /* finished saving bulk on all devices */
 756                 block_mig_state.bulk_completed = 1;
 757             }
 758             ret = 0;
 759         } else {
 760             /* Always called with iothread lock taken for
 761              * simplicity, block_save_complete also calls it.
 762              */
 763             qemu_mutex_lock_iothread();
 764             ret = blk_mig_save_dirty_block(f, 1);
 765             qemu_mutex_unlock_iothread();
 766         }
 767         if (ret < 0) {
 768             return ret;
 769         }
 770         blk_mig_lock();
 771         if (ret != 0) {
 772             /* no more dirty blocks */
 773             break;
 774         }
 775     }
 776     blk_mig_unlock();
 777
 778     ret = flush_blks(f);
 779     if (ret) {
 780         return ret;
 781     }
 782
 783     qemu_put_be64(f, BLK_MIG_FLAG_EOS);
 784     delta_ftell = qemu_ftell(f) - last_ftell;
 785     if (delta_ftell > 0) {
 786         return 1;
 787     } else if (delta_ftell < 0) {
 788         return -1;
 789     } else {
 790         return 0;
 791     }
 792 }
 793
 794 /* Called with iothread lock taken.  */
 795
 796 static int block_save_complete(QEMUFile *f, void *opaque)
 797 {
 798     int ret;
 799
 800     DPRINTF("Enter save live complete submitted %d transferred %d\n",
 801             block_mig_state.submitted, block_mig_state.transferred);
 802
 803     ret = flush_blks(f);
 804     if (ret) {
 805         return ret;
 806     }
 807
 808     blk_mig_reset_dirty_cursor();
 809
 810     /* we know for sure that save bulk is completed and
 811        all async read completed */
 812     blk_mig_lock();
 813     assert(block_mig_state.submitted == 0);
 814     blk_mig_unlock();
 815
 816     do {
 817         ret = blk_mig_save_dirty_block(f, 0);
 818         if (ret < 0) {
 819             return ret;
 820         }
 821     } while (ret == 0);
 822
 823     /* report completion */
 824     qemu_put_be64(f, (100 << BDRV_SECTOR_BITS) | BLK_MIG_FLAG_PROGRESS);
 825
 826     DPRINTF("Block migration completed\n");
 827
 828     qemu_put_be64(f, BLK_MIG_FLAG_EOS);
 829
 830     return 0;
 831 }
 832
 833 static void block_save_pending(QEMUFile *f, void *opaque, uint64_t max_size,
 834                                uint64_t *non_postcopiable_pending,
 835                                uint64_t *postcopiable_pending)
 836 {
 837     /* Estimate pending number of bytes to send */
 838     uint64_t pending;
 839
 840     qemu_mutex_lock_iothread();
 841     pending = get_remaining_dirty();
 842     qemu_mutex_unlock_iothread();
 843
 844     blk_mig_lock();
 845     pending += block_mig_state.submitted * BLOCK_SIZE +
 846                block_mig_state.read_done * BLOCK_SIZE;
 847     blk_mig_unlock();
 848
 849     /* Report at least one block pending during bulk phase */
 850     if (pending <= max_size && !block_mig_state.bulk_completed) {
 851         pending = max_size + BLOCK_SIZE;
 852     }
 853
 854     DPRINTF("Enter save live pending  %" PRIu64 "\n", pending);
 855     /* We don't do postcopy */
 856     *non_postcopiable_pending += pending;
 857 }
 858
 859 static int block_load(QEMUFile *f, void *opaque, int version_id)
 860 {
 861     static int banner_printed;
 862     int len, flags;
 863     char device_name[256];
 864     int64_t addr;
 865     BlockBackend *blk, *blk_prev = NULL;;
 866     Error *local_err = NULL;
 867     uint8_t *buf;
 868     int64_t total_sectors = 0;
 869     int nr_sectors;
 870     int ret;
 871
 872     do {
 873         addr = qemu_get_be64(f);
 874
 875         flags = addr & ~BDRV_SECTOR_MASK;
 876         addr >>= BDRV_SECTOR_BITS;
 877
 878         if (flags & BLK_MIG_FLAG_DEVICE_BLOCK) {
 879             /* get device name */
 880             len = qemu_get_byte(f);
 881             qemu_get_buffer(f, (uint8_t *)device_name, len);
 882             device_name[len] = '\0';
 883
 884             blk = blk_by_name(device_name);
 885             if (!blk) {
 886                 fprintf(stderr, "Error unknown block device %s\n",
 887                         device_name);
 888                 return -EINVAL;
 889             }
 890
 891             if (blk != blk_prev) {
 892                 blk_prev = blk;
 893                 total_sectors = blk_nb_sectors(blk);
 894                 if (total_sectors <= 0) {
 895                     error_report("Error getting length of block device %s",
 896                                  device_name);
 897                     return -EINVAL;
 898                 }
 899
 900                 blk_invalidate_cache(blk, &local_err);
 901                 if (local_err) {
 902                     error_report_err(local_err);
 903                     return -EINVAL;
 904                 }
 905             }
 906
 907             if (total_sectors - addr < BDRV_SECTORS_PER_DIRTY_CHUNK) {
 908                 nr_sectors = total_sectors - addr;
 909             } else {
 910                 nr_sectors = BDRV_SECTORS_PER_DIRTY_CHUNK;
 911             }
 912
 913             if (flags & BLK_MIG_FLAG_ZERO_BLOCK) {
 914                 ret = blk_pwrite_zeroes(blk, addr * BDRV_SECTOR_SIZE,
 915                                         nr_sectors * BDRV_SECTOR_SIZE,
 916                                         BDRV_REQ_MAY_UNMAP);
 917             } else {
 918                 buf = g_malloc(BLOCK_SIZE);
 919                 qemu_get_buffer(f, buf, BLOCK_SIZE);
 920                 ret = blk_pwrite(blk, addr * BDRV_SECTOR_SIZE, buf,
 921                                  nr_sectors * BDRV_SECTOR_SIZE, 0);
 922                 g_free(buf);
 923             }
 924
 925             if (ret < 0) {
 926                 return ret;
 927             }
 928         } else if (flags & BLK_MIG_FLAG_PROGRESS) {
 929             if (!banner_printed) {
 930                 printf("Receiving block device images\n");
 931                 banner_printed = 1;
 932             }
 933             printf("Completed %d %%%c", (int)addr,
 934                    (addr == 100) ? '\n' : '\r');
 935             fflush(stdout);
 936         } else if (!(flags & BLK_MIG_FLAG_EOS)) {
 937             fprintf(stderr, "Unknown block migration flags: %#x\n", flags);
 938             return -EINVAL;
 939         }
 940         ret = qemu_file_get_error(f);
 941         if (ret != 0) {
 942             return ret;
 943         }
 944     } while (!(flags & BLK_MIG_FLAG_EOS));
 945
 946     return 0;
 947 }
 948
 949 static void block_set_params(const MigrationParams *params, void *opaque)
 950 {
 951     block_mig_state.blk_enable = params->blk;
 952     block_mig_state.shared_base = params->shared;
 953
 954     /* shared base means that blk_enable = 1 */
 955     block_mig_state.blk_enable |= params->shared;
 956 }
 957
 958 static bool block_is_active(void *opaque)
 959 {
 960     return block_mig_state.blk_enable == 1;
 961 }
 962
 963 static SaveVMHandlers savevm_block_handlers = {
 964     .set_params = block_set_params,
 965     .save_live_setup = block_save_setup,
 966     .save_live_iterate = block_save_iterate,
 967     .save_live_complete_precopy = block_save_complete,
 968     .save_live_pending = block_save_pending,
 969     .load_state = block_load,
 970     .cleanup = block_migration_cleanup,
 971     .is_active = block_is_active,
 972 };
 973
 974 void blk_mig_init(void)
 975 {
 976     QSIMPLEQ_INIT(&block_mig_state.bmds_list);
 977     QSIMPLEQ_INIT(&block_mig_state.blk_list);
 978     qemu_mutex_init(&block_mig_state.lock);
 979
 980     register_savevm_live(NULL, "block", 0, 1, &savevm_block_handlers,
 981                          &block_mig_state);
 982 }