blockjob.c

   1 /*
   2  * QEMU System Emulator block driver
   3  *
   4  * Copyright (c) 2011 IBM Corp.
   5  * Copyright (c) 2012 Red Hat, Inc.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  23  * THE SOFTWARE.
  24  */
  25
  26 #include "qemu/osdep.h"
  27 #include "block/block.h"
  28 #include "block/blockjob_int.h"
  29 #include "block/block_int.h"
  30 #include "block/trace.h"
  31 #include "sysemu/block-backend.h"
  32 #include "qapi/error.h"
  33 #include "qapi/qapi-events-block-core.h"
  34 #include "qapi/qmp/qerror.h"
  35 #include "qemu/coroutine.h"
  36 #include "qemu/main-loop.h"
  37 #include "qemu/timer.h"
  38
  39 /*
  40  * The block job API is composed of two categories of functions.
  41  *
  42  * The first includes functions used by the monitor.  The monitor is
  43  * peculiar in that it accesses the block job list with block_job_get, and
  44  * therefore needs consistency across block_job_get and the actual operation
  45  * (e.g. block_job_set_speed).  The consistency is achieved with
  46  * aio_context_acquire/release.  These functions are declared in blockjob.h.
  47  *
  48  * The second includes functions used by the block job drivers and sometimes
  49  * by the core block layer.  These do not care about locking, because the
  50  * whole coroutine runs under the AioContext lock, and are declared in
  51  * blockjob_int.h.
  52  */
  53
  54 static bool is_block_job(Job *job)
  55 {
  56     return job_type(job) == JOB_TYPE_BACKUP ||
  57            job_type(job) == JOB_TYPE_COMMIT ||
  58            job_type(job) == JOB_TYPE_MIRROR ||
  59            job_type(job) == JOB_TYPE_STREAM;
  60 }
  61
  62 BlockJob *block_job_next(BlockJob *bjob)
  63 {
  64     Job *job = bjob ? &bjob->job : NULL;
  65
  66     do {
  67         job = job_next(job);
  68     } while (job && !is_block_job(job));
  69
  70     return job ? container_of(job, BlockJob, job) : NULL;
  71 }
  72
  73 BlockJob *block_job_get(const char *id)
  74 {
  75     Job *job = job_get(id);
  76
  77     if (job && is_block_job(job)) {
  78         return container_of(job, BlockJob, job);
  79     } else {
  80         return NULL;
  81     }
  82 }
  83
  84 void block_job_free(Job *job)
  85 {
  86     BlockJob *bjob = container_of(job, BlockJob, job);
  87
  88     block_job_remove_all_bdrv(bjob);
  89     blk_unref(bjob->blk);
  90     error_free(bjob->blocker);
  91 }
  92
  93 static char *child_job_get_parent_desc(BdrvChild *c)
  94 {
  95     BlockJob *job = c->opaque;
  96     return g_strdup_printf("%s job '%s'", job_type_str(&job->job), job->job.id);
  97 }
  98
  99 static void child_job_drained_begin(BdrvChild *c)
 100 {
 101     BlockJob *job = c->opaque;
 102     job_pause(&job->job);
 103 }
 104
 105 static bool child_job_drained_poll(BdrvChild *c)
 106 {
 107     BlockJob *bjob = c->opaque;
 108     Job *job = &bjob->job;
 109     const BlockJobDriver *drv = block_job_driver(bjob);
 110
 111     /* An inactive or completed job doesn't have any pending requests. Jobs
 112      * with !job->busy are either already paused or have a pause point after
 113      * being reentered, so no job driver code will run before they pause. */
 114     if (!job->busy || job_is_completed(job)) {
 115         return false;
 116     }
 117
 118     /* Otherwise, assume that it isn't fully stopped yet, but allow the job to
 119      * override this assumption. */
 120     if (drv->drained_poll) {
 121         return drv->drained_poll(bjob);
 122     } else {
 123         return true;
 124     }
 125 }
 126
 127 static void child_job_drained_end(BdrvChild *c, int *drained_end_counter)
 128 {
 129     BlockJob *job = c->opaque;
 130     job_resume(&job->job);
 131 }
 132
 133 static bool child_job_can_set_aio_ctx(BdrvChild *c, AioContext *ctx,
 134                                       GSList **ignore, Error **errp)
 135 {
 136     BlockJob *job = c->opaque;
 137     GSList *l;
 138
 139     for (l = job->nodes; l; l = l->next) {
 140         BdrvChild *sibling = l->data;
 141         if (!bdrv_child_can_set_aio_context(sibling, ctx, ignore, errp)) {
 142             return false;
 143         }
 144     }
 145     return true;
 146 }
 147
 148 static void child_job_set_aio_ctx(BdrvChild *c, AioContext *ctx,
 149                                   GSList **ignore)
 150 {
 151     BlockJob *job = c->opaque;
 152     GSList *l;
 153
 154     for (l = job->nodes; l; l = l->next) {
 155         BdrvChild *sibling = l->data;
 156         if (g_slist_find(*ignore, sibling)) {
 157             continue;
 158         }
 159         *ignore = g_slist_prepend(*ignore, sibling);
 160         bdrv_set_aio_context_ignore(sibling->bs, ctx, ignore);
 161     }
 162
 163     job->job.aio_context = ctx;
 164 }
 165
 166 static AioContext *child_job_get_parent_aio_context(BdrvChild *c)
 167 {
 168     BlockJob *job = c->opaque;
 169
 170     return job->job.aio_context;
 171 }
 172
 173 static const BdrvChildClass child_job = {
 174     .get_parent_desc    = child_job_get_parent_desc,
 175     .drained_begin      = child_job_drained_begin,
 176     .drained_poll       = child_job_drained_poll,
 177     .drained_end        = child_job_drained_end,
 178     .can_set_aio_ctx    = child_job_can_set_aio_ctx,
 179     .set_aio_ctx        = child_job_set_aio_ctx,
 180     .stay_at_node       = true,
 181     .get_parent_aio_context = child_job_get_parent_aio_context,
 182 };
 183
 184 void block_job_remove_all_bdrv(BlockJob *job)
 185 {
 186     /*
 187      * bdrv_root_unref_child() may reach child_job_[can_]set_aio_ctx(),
 188      * which will also traverse job->nodes, so consume the list one by
 189      * one to make sure that such a concurrent access does not attempt
 190      * to process an already freed BdrvChild.
 191      */
 192     while (job->nodes) {
 193         GSList *l = job->nodes;
 194         BdrvChild *c = l->data;
 195
 196         job->nodes = l->next;
 197
 198         bdrv_op_unblock_all(c->bs, job->blocker);
 199         bdrv_root_unref_child(c);
 200
 201         g_slist_free_1(l);
 202     }
 203 }
 204
 205 bool block_job_has_bdrv(BlockJob *job, BlockDriverState *bs)
 206 {
 207     GSList *el;
 208
 209     for (el = job->nodes; el; el = el->next) {
 210         BdrvChild *c = el->data;
 211         if (c->bs == bs) {
 212             return true;
 213         }
 214     }
 215
 216     return false;
 217 }
 218
 219 int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs,
 220                        uint64_t perm, uint64_t shared_perm, Error **errp)
 221 {
 222     BdrvChild *c;
 223     bool need_context_ops;
 224
 225     bdrv_ref(bs);
 226
 227     need_context_ops = bdrv_get_aio_context(bs) != job->job.aio_context;
 228
 229     if (need_context_ops && job->job.aio_context != qemu_get_aio_context()) {
 230         aio_context_release(job->job.aio_context);
 231     }
 232     c = bdrv_root_attach_child(bs, name, &child_job, 0,
 233                                job->job.aio_context, perm, shared_perm, job,
 234                                errp);
 235     if (need_context_ops && job->job.aio_context != qemu_get_aio_context()) {
 236         aio_context_acquire(job->job.aio_context);
 237     }
 238     if (c == NULL) {
 239         return -EPERM;
 240     }
 241
 242     job->nodes = g_slist_prepend(job->nodes, c);
 243     bdrv_op_block_all(bs, job->blocker);
 244
 245     return 0;
 246 }
 247
 248 static void block_job_on_idle(Notifier *n, void *opaque)
 249 {
 250     aio_wait_kick();
 251 }
 252
 253 bool block_job_is_internal(BlockJob *job)
 254 {
 255     return (job->job.id == NULL);
 256 }
 257
 258 const BlockJobDriver *block_job_driver(BlockJob *job)
 259 {
 260     return container_of(job->job.driver, BlockJobDriver, job_driver);
 261 }
 262
 263 /* Assumes the job_mutex is held */
 264 static bool job_timer_pending(Job *job)
 265 {
 266     return timer_pending(&job->sleep_timer);
 267 }
 268
 269 bool block_job_set_speed(BlockJob *job, int64_t speed, Error **errp)
 270 {
 271     const BlockJobDriver *drv = block_job_driver(job);
 272     int64_t old_speed = job->speed;
 273
 274     if (job_apply_verb(&job->job, JOB_VERB_SET_SPEED, errp) < 0) {
 275         return false;
 276     }
 277     if (speed < 0) {
 278         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "speed",
 279                    "a non-negative value");
 280         return false;
 281     }
 282
 283     ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME);
 284
 285     job->speed = speed;
 286
 287     if (drv->set_speed) {
 288         drv->set_speed(job, speed);
 289     }
 290
 291     if (speed && speed <= old_speed) {
 292         return true;
 293     }
 294
 295     /* kick only if a timer is pending */
 296     job_enter_cond(&job->job, job_timer_pending);
 297
 298     return true;
 299 }
 300
 301 int64_t block_job_ratelimit_get_delay(BlockJob *job, uint64_t n)
 302 {
 303     if (!job->speed) {
 304         return 0;
 305     }
 306
 307     return ratelimit_calculate_delay(&job->limit, n);
 308 }
 309
 310 BlockJobInfo *block_job_query(BlockJob *job, Error **errp)
 311 {
 312     BlockJobInfo *info;
 313
 314     if (block_job_is_internal(job)) {
 315         error_setg(errp, "Cannot query QEMU internal jobs");
 316         return NULL;
 317     }
 318     info = g_new0(BlockJobInfo, 1);
 319     info->type      = g_strdup(job_type_str(&job->job));
 320     info->device    = g_strdup(job->job.id);
 321     info->busy      = qatomic_read(&job->job.busy);
 322     info->paused    = job->job.pause_count > 0;
 323     info->offset    = job->job.progress.current;
 324     info->len       = job->job.progress.total;
 325     info->speed     = job->speed;
 326     info->io_status = job->iostatus;
 327     info->ready     = job_is_ready(&job->job),
 328     info->status    = job->job.status;
 329     info->auto_finalize = job->job.auto_finalize;
 330     info->auto_dismiss  = job->job.auto_dismiss;
 331     if (job->job.ret) {
 332         info->has_error = true;
 333         info->error = job->job.err ?
 334                         g_strdup(error_get_pretty(job->job.err)) :
 335                         g_strdup(strerror(-job->job.ret));
 336     }
 337     return info;
 338 }
 339
 340 static void block_job_iostatus_set_err(BlockJob *job, int error)
 341 {
 342     if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
 343         job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
 344                                           BLOCK_DEVICE_IO_STATUS_FAILED;
 345     }
 346 }
 347
 348 static void block_job_event_cancelled(Notifier *n, void *opaque)
 349 {
 350     BlockJob *job = opaque;
 351
 352     if (block_job_is_internal(job)) {
 353         return;
 354     }
 355
 356     qapi_event_send_block_job_cancelled(job_type(&job->job),
 357                                         job->job.id,
 358                                         job->job.progress.total,
 359                                         job->job.progress.current,
 360                                         job->speed);
 361 }
 362
 363 static void block_job_event_completed(Notifier *n, void *opaque)
 364 {
 365     BlockJob *job = opaque;
 366     const char *msg = NULL;
 367
 368     if (block_job_is_internal(job)) {
 369         return;
 370     }
 371
 372     if (job->job.ret < 0) {
 373         msg = error_get_pretty(job->job.err);
 374     }
 375
 376     qapi_event_send_block_job_completed(job_type(&job->job),
 377                                         job->job.id,
 378                                         job->job.progress.total,
 379                                         job->job.progress.current,
 380                                         job->speed,
 381                                         !!msg,
 382                                         msg);
 383 }
 384
 385 static void block_job_event_pending(Notifier *n, void *opaque)
 386 {
 387     BlockJob *job = opaque;
 388
 389     if (block_job_is_internal(job)) {
 390         return;
 391     }
 392
 393     qapi_event_send_block_job_pending(job_type(&job->job),
 394                                       job->job.id);
 395 }
 396
 397 static void block_job_event_ready(Notifier *n, void *opaque)
 398 {
 399     BlockJob *job = opaque;
 400
 401     if (block_job_is_internal(job)) {
 402         return;
 403     }
 404
 405     qapi_event_send_block_job_ready(job_type(&job->job),
 406                                     job->job.id,
 407                                     job->job.progress.total,
 408                                     job->job.progress.current,
 409                                     job->speed);
 410 }
 411
 412
 413 /*
 414  * API for block job drivers and the block layer.  These functions are
 415  * declared in blockjob_int.h.
 416  */
 417
 418 void *block_job_create(const char *job_id, const BlockJobDriver *driver,
 419                        JobTxn *txn, BlockDriverState *bs, uint64_t perm,
 420                        uint64_t shared_perm, int64_t speed, int flags,
 421                        BlockCompletionFunc *cb, void *opaque, Error **errp)
 422 {
 423     BlockBackend *blk;
 424     BlockJob *job;
 425
 426     if (job_id == NULL && !(flags & JOB_INTERNAL)) {
 427         job_id = bdrv_get_device_name(bs);
 428     }
 429
 430     blk = blk_new_with_bs(bs, perm, shared_perm, errp);
 431     if (!blk) {
 432         return NULL;
 433     }
 434
 435     job = job_create(job_id, &driver->job_driver, txn, blk_get_aio_context(blk),
 436                      flags, cb, opaque, errp);
 437     if (job == NULL) {
 438         blk_unref(blk);
 439         return NULL;
 440     }
 441
 442     assert(is_block_job(&job->job));
 443     assert(job->job.driver->free == &block_job_free);
 444     assert(job->job.driver->user_resume == &block_job_user_resume);
 445
 446     job->blk = blk;
 447
 448     job->finalize_cancelled_notifier.notify = block_job_event_cancelled;
 449     job->finalize_completed_notifier.notify = block_job_event_completed;
 450     job->pending_notifier.notify = block_job_event_pending;
 451     job->ready_notifier.notify = block_job_event_ready;
 452     job->idle_notifier.notify = block_job_on_idle;
 453
 454     notifier_list_add(&job->job.on_finalize_cancelled,
 455                       &job->finalize_cancelled_notifier);
 456     notifier_list_add(&job->job.on_finalize_completed,
 457                       &job->finalize_completed_notifier);
 458     notifier_list_add(&job->job.on_pending, &job->pending_notifier);
 459     notifier_list_add(&job->job.on_ready, &job->ready_notifier);
 460     notifier_list_add(&job->job.on_idle, &job->idle_notifier);
 461
 462     error_setg(&job->blocker, "block device is in use by block job: %s",
 463                job_type_str(&job->job));
 464     block_job_add_bdrv(job, "main node", bs, 0, BLK_PERM_ALL, &error_abort);
 465
 466     bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker);
 467
 468     /* Disable request queuing in the BlockBackend to avoid deadlocks on drain:
 469      * The job reports that it's busy until it reaches a pause point. */
 470     blk_set_disable_request_queuing(blk, true);
 471     blk_set_allow_aio_context_change(blk, true);
 472
 473     /* Only set speed when necessary to avoid NotSupported error */
 474     if (speed != 0) {
 475         if (!block_job_set_speed(job, speed, errp)) {
 476             job_early_fail(&job->job);
 477             return NULL;
 478         }
 479     }
 480
 481     return job;
 482 }
 483
 484 void block_job_iostatus_reset(BlockJob *job)
 485 {
 486     if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
 487         return;
 488     }
 489     assert(job->job.user_paused && job->job.pause_count > 0);
 490     job->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
 491 }
 492
 493 void block_job_user_resume(Job *job)
 494 {
 495     BlockJob *bjob = container_of(job, BlockJob, job);
 496     block_job_iostatus_reset(bjob);
 497 }
 498
 499 BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err,
 500                                         int is_read, int error)
 501 {
 502     BlockErrorAction action;
 503
 504     switch (on_err) {
 505     case BLOCKDEV_ON_ERROR_ENOSPC:
 506     case BLOCKDEV_ON_ERROR_AUTO:
 507         action = (error == ENOSPC) ?
 508                  BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT;
 509         break;
 510     case BLOCKDEV_ON_ERROR_STOP:
 511         action = BLOCK_ERROR_ACTION_STOP;
 512         break;
 513     case BLOCKDEV_ON_ERROR_REPORT:
 514         action = BLOCK_ERROR_ACTION_REPORT;
 515         break;
 516     case BLOCKDEV_ON_ERROR_IGNORE:
 517         action = BLOCK_ERROR_ACTION_IGNORE;
 518         break;
 519     default:
 520         abort();
 521     }
 522     if (!block_job_is_internal(job)) {
 523         qapi_event_send_block_job_error(job->job.id,
 524                                         is_read ? IO_OPERATION_TYPE_READ :
 525                                         IO_OPERATION_TYPE_WRITE,
 526                                         action);
 527     }
 528     if (action == BLOCK_ERROR_ACTION_STOP) {
 529         if (!job->job.user_paused) {
 530             job_pause(&job->job);
 531             /* make the pause user visible, which will be resumed from QMP. */
 532             job->job.user_paused = true;
 533         }
 534         block_job_iostatus_set_err(job, error);
 535     }
 536     return action;
 537 }