block/stream.c

   1 /*
   2  * Image streaming
   3  *
   4  * Copyright IBM, Corp. 2011
   5  *
   6  * Authors:
   7  *  Stefan Hajnoczi   <stefanha@linux.vnet.ibm.com>
   8  *
   9  * This work is licensed under the terms of the GNU LGPL, version 2 or later.
  10  * See the COPYING.LIB file in the top-level directory.
  11  *
  12  */
  13
  14 #include "qemu/osdep.h"
  15 #include "trace.h"
  16 #include "block/block_int.h"
  17 #include "block/blockjob_int.h"
  18 #include "qapi/error.h"
  19 #include "qapi/qmp/qerror.h"
  20 #include "qapi/qmp/qdict.h"
  21 #include "qemu/ratelimit.h"
  22 #include "sysemu/block-backend.h"
  23 #include "block/copy-on-read.h"
  24
  25 enum {
  26     /*
  27      * Maximum chunk size to feed to copy-on-read.  This should be
  28      * large enough to process multiple clusters in a single call, so
  29      * that populating contiguous regions of the image is efficient.
  30      */
  31     STREAM_CHUNK = 512 * 1024, /* in bytes */
  32 };
  33
  34 typedef struct StreamBlockJob {
  35     BlockJob common;
  36     BlockBackend *blk;
  37     BlockDriverState *base_overlay; /* COW overlay (stream from this) */
  38     BlockDriverState *above_base;   /* Node directly above the base */
  39     BlockDriverState *cor_filter_bs;
  40     BlockDriverState *target_bs;
  41     BlockdevOnError on_error;
  42     char *backing_file_str;
  43     bool bs_read_only;
  44 } StreamBlockJob;
  45
  46 static int coroutine_fn stream_populate(BlockBackend *blk,
  47                                         int64_t offset, uint64_t bytes)
  48 {
  49     assert(bytes < SIZE_MAX);
  50
  51     return blk_co_preadv(blk, offset, bytes, NULL, BDRV_REQ_PREFETCH);
  52 }
  53
  54 static int stream_prepare(Job *job)
  55 {
  56     StreamBlockJob *s = container_of(job, StreamBlockJob, common.job);
  57     BlockDriverState *unfiltered_bs = bdrv_skip_filters(s->target_bs);
  58     BlockDriverState *base;
  59     BlockDriverState *unfiltered_base;
  60     Error *local_err = NULL;
  61     int ret = 0;
  62
  63     /* We should drop filter at this point, as filter hold the backing chain */
  64     bdrv_cor_filter_drop(s->cor_filter_bs);
  65     s->cor_filter_bs = NULL;
  66
  67     /*
  68      * bdrv_set_backing_hd() requires that unfiltered_bs is drained. Drain
  69      * already here and use bdrv_set_backing_hd_drained() instead because
  70      * the polling during drained_begin() might change the graph, and if we do
  71      * this only later, we may end up working with the wrong base node (or it
  72      * might even have gone away by the time we want to use it).
  73      */
  74     bdrv_drained_begin(unfiltered_bs);
  75
  76     base = bdrv_filter_or_cow_bs(s->above_base);
  77     unfiltered_base = bdrv_skip_filters(base);
  78
  79     if (bdrv_cow_child(unfiltered_bs)) {
  80         const char *base_id = NULL, *base_fmt = NULL;
  81         if (unfiltered_base) {
  82             base_id = s->backing_file_str ?: unfiltered_base->filename;
  83             if (unfiltered_base->drv) {
  84                 base_fmt = unfiltered_base->drv->format_name;
  85             }
  86         }
  87
  88         bdrv_set_backing_hd_drained(unfiltered_bs, base, &local_err);
  89
  90         /*
  91          * This call will do I/O, so the graph can change again from here on.
  92          * We have already completed the graph change, so we are not in danger
  93          * of operating on the wrong node any more if this happens.
  94          */
  95         ret = bdrv_change_backing_file(unfiltered_bs, base_id, base_fmt, false);
  96         if (local_err) {
  97             error_report_err(local_err);
  98             ret = -EPERM;
  99             goto out;
 100         }
 101     }
 102
 103 out:
 104     bdrv_drained_end(unfiltered_bs);
 105     return ret;
 106 }
 107
 108 static void stream_clean(Job *job)
 109 {
 110     StreamBlockJob *s = container_of(job, StreamBlockJob, common.job);
 111
 112     if (s->cor_filter_bs) {
 113         bdrv_cor_filter_drop(s->cor_filter_bs);
 114         s->cor_filter_bs = NULL;
 115     }
 116
 117     blk_unref(s->blk);
 118     s->blk = NULL;
 119
 120     /* Reopen the image back in read-only mode if necessary */
 121     if (s->bs_read_only) {
 122         /* Give up write permissions before making it read-only */
 123         bdrv_reopen_set_read_only(s->target_bs, true, NULL);
 124     }
 125
 126     g_free(s->backing_file_str);
 127 }
 128
 129 static int coroutine_fn stream_run(Job *job, Error **errp)
 130 {
 131     StreamBlockJob *s = container_of(job, StreamBlockJob, common.job);
 132     BlockDriverState *unfiltered_bs = bdrv_skip_filters(s->target_bs);
 133     int64_t len;
 134     int64_t offset = 0;
 135     uint64_t delay_ns = 0;
 136     int error = 0;
 137     int64_t n = 0; /* bytes */
 138
 139     if (unfiltered_bs == s->base_overlay) {
 140         /* Nothing to stream */
 141         return 0;
 142     }
 143
 144     len = bdrv_getlength(s->target_bs);
 145     if (len < 0) {
 146         return len;
 147     }
 148     job_progress_set_remaining(&s->common.job, len);
 149
 150     for ( ; offset < len; offset += n) {
 151         bool copy;
 152         int ret;
 153
 154         /* Note that even when no rate limit is applied we need to yield
 155          * with no pending I/O here so that bdrv_drain_all() returns.
 156          */
 157         job_sleep_ns(&s->common.job, delay_ns);
 158         if (job_is_cancelled(&s->common.job)) {
 159             break;
 160         }
 161
 162         copy = false;
 163
 164         WITH_GRAPH_RDLOCK_GUARD() {
 165             ret = bdrv_is_allocated(unfiltered_bs, offset, STREAM_CHUNK, &n);
 166             if (ret == 1) {
 167                 /* Allocated in the top, no need to copy.  */
 168             } else if (ret >= 0) {
 169                 /*
 170                  * Copy if allocated in the intermediate images.  Limit to the
 171                  * known-unallocated area [offset, offset+n*BDRV_SECTOR_SIZE).
 172                  */
 173                 ret = bdrv_is_allocated_above(bdrv_cow_bs(unfiltered_bs),
 174                                             s->base_overlay, true,
 175                                             offset, n, &n);
 176                 /* Finish early if end of backing file has been reached */
 177                 if (ret == 0 && n == 0) {
 178                     n = len - offset;
 179                 }
 180
 181                 copy = (ret > 0);
 182             }
 183         }
 184         trace_stream_one_iteration(s, offset, n, ret);
 185         if (copy) {
 186             ret = stream_populate(s->blk, offset, n);
 187         }
 188         if (ret < 0) {
 189             BlockErrorAction action =
 190                 block_job_error_action(&s->common, s->on_error, true, -ret);
 191             if (action == BLOCK_ERROR_ACTION_STOP) {
 192                 n = 0;
 193                 continue;
 194             }
 195             if (error == 0) {
 196                 error = ret;
 197             }
 198             if (action == BLOCK_ERROR_ACTION_REPORT) {
 199                 break;
 200             }
 201         }
 202
 203         /* Publish progress */
 204         job_progress_update(&s->common.job, n);
 205         if (copy) {
 206             delay_ns = block_job_ratelimit_get_delay(&s->common, n);
 207         } else {
 208             delay_ns = 0;
 209         }
 210     }
 211
 212     /* Do not remove the backing file if an error was there but ignored. */
 213     return error;
 214 }
 215
 216 static const BlockJobDriver stream_job_driver = {
 217     .job_driver = {
 218         .instance_size = sizeof(StreamBlockJob),
 219         .job_type      = JOB_TYPE_STREAM,
 220         .free          = block_job_free,
 221         .run           = stream_run,
 222         .prepare       = stream_prepare,
 223         .clean         = stream_clean,
 224         .user_resume   = block_job_user_resume,
 225     },
 226 };
 227
 228 void stream_start(const char *job_id, BlockDriverState *bs,
 229                   BlockDriverState *base, const char *backing_file_str,
 230                   BlockDriverState *bottom,
 231                   int creation_flags, int64_t speed,
 232                   BlockdevOnError on_error,
 233                   const char *filter_node_name,
 234                   Error **errp)
 235 {
 236     StreamBlockJob *s = NULL;
 237     BlockDriverState *iter;
 238     bool bs_read_only;
 239     int basic_flags = BLK_PERM_CONSISTENT_READ | BLK_PERM_WRITE_UNCHANGED;
 240     BlockDriverState *base_overlay;
 241     BlockDriverState *cor_filter_bs = NULL;
 242     BlockDriverState *above_base;
 243     QDict *opts;
 244     int ret;
 245
 246     GLOBAL_STATE_CODE();
 247
 248     assert(!(base && bottom));
 249     assert(!(backing_file_str && bottom));
 250
 251     if (bottom) {
 252         /*
 253          * New simple interface. The code is written in terms of old interface
 254          * with @base parameter (still, it doesn't freeze link to base, so in
 255          * this mean old code is correct for new interface). So, for now, just
 256          * emulate base_overlay and above_base. Still, when old interface
 257          * finally removed, we should refactor code to use only "bottom", but
 258          * not "*base*" things.
 259          */
 260         assert(!bottom->drv->is_filter);
 261         base_overlay = above_base = bottom;
 262     } else {
 263         base_overlay = bdrv_find_overlay(bs, base);
 264         if (!base_overlay) {
 265             error_setg(errp, "'%s' is not in the backing chain of '%s'",
 266                        base->node_name, bs->node_name);
 267             return;
 268         }
 269
 270         /*
 271          * Find the node directly above @base.  @base_overlay is a COW overlay,
 272          * so it must have a bdrv_cow_child(), but it is the immediate overlay
 273          * of @base, so between the two there can only be filters.
 274          */
 275         above_base = base_overlay;
 276         if (bdrv_cow_bs(above_base) != base) {
 277             above_base = bdrv_cow_bs(above_base);
 278             while (bdrv_filter_bs(above_base) != base) {
 279                 above_base = bdrv_filter_bs(above_base);
 280             }
 281         }
 282     }
 283
 284     /* Make sure that the image is opened in read-write mode */
 285     bs_read_only = bdrv_is_read_only(bs);
 286     if (bs_read_only) {
 287         int ret;
 288         /* Hold the chain during reopen */
 289         if (bdrv_freeze_backing_chain(bs, above_base, errp) < 0) {
 290             return;
 291         }
 292
 293         ret = bdrv_reopen_set_read_only(bs, false, errp);
 294
 295         /* failure, or cor-filter will hold the chain */
 296         bdrv_unfreeze_backing_chain(bs, above_base);
 297
 298         if (ret < 0) {
 299             return;
 300         }
 301     }
 302
 303     opts = qdict_new();
 304
 305     qdict_put_str(opts, "driver", "copy-on-read");
 306     qdict_put_str(opts, "file", bdrv_get_node_name(bs));
 307     /* Pass the base_overlay node name as 'bottom' to COR driver */
 308     qdict_put_str(opts, "bottom", base_overlay->node_name);
 309     if (filter_node_name) {
 310         qdict_put_str(opts, "node-name", filter_node_name);
 311     }
 312
 313     cor_filter_bs = bdrv_insert_node(bs, opts, BDRV_O_RDWR, errp);
 314     if (!cor_filter_bs) {
 315         goto fail;
 316     }
 317
 318     if (!filter_node_name) {
 319         cor_filter_bs->implicit = true;
 320     }
 321
 322     s = block_job_create(job_id, &stream_job_driver, NULL, cor_filter_bs,
 323                          0, BLK_PERM_ALL,
 324                          speed, creation_flags, NULL, NULL, errp);
 325     if (!s) {
 326         goto fail;
 327     }
 328
 329     s->blk = blk_new_with_bs(cor_filter_bs, BLK_PERM_CONSISTENT_READ,
 330                              basic_flags | BLK_PERM_WRITE, errp);
 331     if (!s->blk) {
 332         goto fail;
 333     }
 334     /*
 335      * Disable request queuing in the BlockBackend to avoid deadlocks on drain:
 336      * The job reports that it's busy until it reaches a pause point.
 337      */
 338     blk_set_disable_request_queuing(s->blk, true);
 339     blk_set_allow_aio_context_change(s->blk, true);
 340
 341     /*
 342      * Prevent concurrent jobs trying to modify the graph structure here, we
 343      * already have our own plans. Also don't allow resize as the image size is
 344      * queried only at the job start and then cached.
 345      */
 346     if (block_job_add_bdrv(&s->common, "active node", bs, 0,
 347                            basic_flags | BLK_PERM_WRITE, errp)) {
 348         goto fail;
 349     }
 350
 351     /* Block all intermediate nodes between bs and base, because they will
 352      * disappear from the chain after this operation. The streaming job reads
 353      * every block only once, assuming that it doesn't change, so forbid writes
 354      * and resizes. Reassign the base node pointer because the backing BS of the
 355      * bottom node might change after the call to bdrv_reopen_set_read_only()
 356      * due to parallel block jobs running.
 357      * above_base node might change after the call to
 358      * bdrv_reopen_set_read_only() due to parallel block jobs running.
 359      */
 360     base = bdrv_filter_or_cow_bs(above_base);
 361     for (iter = bdrv_filter_or_cow_bs(bs); iter != base;
 362          iter = bdrv_filter_or_cow_bs(iter))
 363     {
 364         ret = block_job_add_bdrv(&s->common, "intermediate node", iter, 0,
 365                                  basic_flags, errp);
 366         if (ret < 0) {
 367             goto fail;
 368         }
 369     }
 370
 371     s->base_overlay = base_overlay;
 372     s->above_base = above_base;
 373     s->backing_file_str = g_strdup(backing_file_str);
 374     s->cor_filter_bs = cor_filter_bs;
 375     s->target_bs = bs;
 376     s->bs_read_only = bs_read_only;
 377
 378     s->on_error = on_error;
 379     trace_stream_start(bs, base, s);
 380     job_start(&s->common.job);
 381     return;
 382
 383 fail:
 384     if (s) {
 385         job_early_fail(&s->common.job);
 386     }
 387     if (cor_filter_bs) {
 388         bdrv_cor_filter_drop(cor_filter_bs);
 389     }
 390     if (bs_read_only) {
 391         bdrv_reopen_set_read_only(bs, true, NULL);
 392     }
 393 }