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/aio-wait.h" 28 #include "block/block.h" 29 #include "block/blockjob_int.h" 30 #include "block/block_int.h" 31 #include "block/trace.h" 32 #include "sysemu/block-backend.h" 33 #include "qapi/error.h" 34 #include "qapi/qapi-events-block-core.h" 35 #include "qapi/qmp/qerror.h" 36 #include "qemu/main-loop.h" 37 #include "qemu/timer.h" 38 39 static bool is_block_job(Job *job) 40 { 41 return job_type(job) == JOB_TYPE_BACKUP || 42 job_type(job) == JOB_TYPE_COMMIT || 43 job_type(job) == JOB_TYPE_MIRROR || 44 job_type(job) == JOB_TYPE_STREAM; 45 } 46 47 BlockJob *block_job_next_locked(BlockJob *bjob) 48 { 49 Job *job = bjob ? &bjob->job : NULL; 50 GLOBAL_STATE_CODE(); 51 52 do { 53 job = job_next_locked(job); 54 } while (job && !is_block_job(job)); 55 56 return job ? container_of(job, BlockJob, job) : NULL; 57 } 58 59 BlockJob *block_job_get_locked(const char *id) 60 { 61 Job *job = job_get_locked(id); 62 GLOBAL_STATE_CODE(); 63 64 if (job && is_block_job(job)) { 65 return container_of(job, BlockJob, job); 66 } else { 67 return NULL; 68 } 69 } 70 71 BlockJob *block_job_get(const char *id) 72 { 73 JOB_LOCK_GUARD(); 74 return block_job_get_locked(id); 75 } 76 77 void block_job_free(Job *job) 78 { 79 BlockJob *bjob = container_of(job, BlockJob, job); 80 GLOBAL_STATE_CODE(); 81 82 block_job_remove_all_bdrv(bjob); 83 ratelimit_destroy(&bjob->limit); 84 error_free(bjob->blocker); 85 } 86 87 static char *child_job_get_parent_desc(BdrvChild *c) 88 { 89 BlockJob *job = c->opaque; 90 return g_strdup_printf("%s job '%s'", job_type_str(&job->job), job->job.id); 91 } 92 93 static void child_job_drained_begin(BdrvChild *c) 94 { 95 BlockJob *job = c->opaque; 96 job_pause(&job->job); 97 } 98 99 static bool child_job_drained_poll(BdrvChild *c) 100 { 101 BlockJob *bjob = c->opaque; 102 Job *job = &bjob->job; 103 const BlockJobDriver *drv = block_job_driver(bjob); 104 105 /* An inactive or completed job doesn't have any pending requests. Jobs 106 * with !job->busy are either already paused or have a pause point after 107 * being reentered, so no job driver code will run before they pause. */ 108 WITH_JOB_LOCK_GUARD() { 109 if (!job->busy || job_is_completed_locked(job)) { 110 return false; 111 } 112 } 113 114 /* Otherwise, assume that it isn't fully stopped yet, but allow the job to 115 * override this assumption. */ 116 if (drv->drained_poll) { 117 return drv->drained_poll(bjob); 118 } else { 119 return true; 120 } 121 } 122 123 static void child_job_drained_end(BdrvChild *c) 124 { 125 BlockJob *job = c->opaque; 126 job_resume(&job->job); 127 } 128 129 typedef struct BdrvStateChildJobContext { 130 AioContext *new_ctx; 131 BlockJob *job; 132 } BdrvStateChildJobContext; 133 134 static void child_job_set_aio_ctx_commit(void *opaque) 135 { 136 BdrvStateChildJobContext *s = opaque; 137 BlockJob *job = s->job; 138 139 job_set_aio_context(&job->job, s->new_ctx); 140 } 141 142 static TransactionActionDrv change_child_job_context = { 143 .commit = child_job_set_aio_ctx_commit, 144 .clean = g_free, 145 }; 146 147 static bool child_job_change_aio_ctx(BdrvChild *c, AioContext *ctx, 148 GHashTable *visited, Transaction *tran, 149 Error **errp) 150 { 151 BlockJob *job = c->opaque; 152 BdrvStateChildJobContext *s; 153 GSList *l; 154 155 for (l = job->nodes; l; l = l->next) { 156 BdrvChild *sibling = l->data; 157 if (!bdrv_child_change_aio_context(sibling, ctx, visited, 158 tran, errp)) { 159 return false; 160 } 161 } 162 163 s = g_new(BdrvStateChildJobContext, 1); 164 *s = (BdrvStateChildJobContext) { 165 .new_ctx = ctx, 166 .job = job, 167 }; 168 169 tran_add(tran, &change_child_job_context, s); 170 return true; 171 } 172 173 static AioContext *child_job_get_parent_aio_context(BdrvChild *c) 174 { 175 BlockJob *job = c->opaque; 176 IO_CODE(); 177 JOB_LOCK_GUARD(); 178 179 return job->job.aio_context; 180 } 181 182 static const BdrvChildClass child_job = { 183 .get_parent_desc = child_job_get_parent_desc, 184 .drained_begin = child_job_drained_begin, 185 .drained_poll = child_job_drained_poll, 186 .drained_end = child_job_drained_end, 187 .change_aio_ctx = child_job_change_aio_ctx, 188 .stay_at_node = true, 189 .get_parent_aio_context = child_job_get_parent_aio_context, 190 }; 191 192 void block_job_remove_all_bdrv(BlockJob *job) 193 { 194 GLOBAL_STATE_CODE(); 195 /* 196 * bdrv_root_unref_child() may reach child_job_[can_]set_aio_ctx(), 197 * which will also traverse job->nodes, so consume the list one by 198 * one to make sure that such a concurrent access does not attempt 199 * to process an already freed BdrvChild. 200 */ 201 aio_context_release(job->job.aio_context); 202 bdrv_graph_wrlock(NULL); 203 aio_context_acquire(job->job.aio_context); 204 while (job->nodes) { 205 GSList *l = job->nodes; 206 BdrvChild *c = l->data; 207 208 job->nodes = l->next; 209 210 bdrv_op_unblock_all(c->bs, job->blocker); 211 bdrv_root_unref_child(c); 212 213 g_slist_free_1(l); 214 } 215 bdrv_graph_wrunlock(); 216 } 217 218 bool block_job_has_bdrv(BlockJob *job, BlockDriverState *bs) 219 { 220 GSList *el; 221 GLOBAL_STATE_CODE(); 222 223 for (el = job->nodes; el; el = el->next) { 224 BdrvChild *c = el->data; 225 if (c->bs == bs) { 226 return true; 227 } 228 } 229 230 return false; 231 } 232 233 int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs, 234 uint64_t perm, uint64_t shared_perm, Error **errp) 235 { 236 BdrvChild *c; 237 AioContext *ctx = bdrv_get_aio_context(bs); 238 bool need_context_ops; 239 GLOBAL_STATE_CODE(); 240 241 bdrv_ref(bs); 242 243 need_context_ops = ctx != job->job.aio_context; 244 245 if (need_context_ops) { 246 if (job->job.aio_context != qemu_get_aio_context()) { 247 aio_context_release(job->job.aio_context); 248 } 249 aio_context_acquire(ctx); 250 } 251 bdrv_graph_wrlock(bs); 252 c = bdrv_root_attach_child(bs, name, &child_job, 0, perm, shared_perm, job, 253 errp); 254 bdrv_graph_wrunlock(); 255 if (need_context_ops) { 256 aio_context_release(ctx); 257 if (job->job.aio_context != qemu_get_aio_context()) { 258 aio_context_acquire(job->job.aio_context); 259 } 260 } 261 if (c == NULL) { 262 return -EPERM; 263 } 264 265 job->nodes = g_slist_prepend(job->nodes, c); 266 bdrv_op_block_all(bs, job->blocker); 267 268 return 0; 269 } 270 271 /* Called with job_mutex lock held. */ 272 static void block_job_on_idle_locked(Notifier *n, void *opaque) 273 { 274 aio_wait_kick(); 275 } 276 277 bool block_job_is_internal(BlockJob *job) 278 { 279 return (job->job.id == NULL); 280 } 281 282 const BlockJobDriver *block_job_driver(BlockJob *job) 283 { 284 return container_of(job->job.driver, BlockJobDriver, job_driver); 285 } 286 287 /* Assumes the job_mutex is held */ 288 static bool job_timer_pending(Job *job) 289 { 290 return timer_pending(&job->sleep_timer); 291 } 292 293 bool block_job_set_speed_locked(BlockJob *job, int64_t speed, Error **errp) 294 { 295 const BlockJobDriver *drv = block_job_driver(job); 296 int64_t old_speed = job->speed; 297 298 GLOBAL_STATE_CODE(); 299 300 if (job_apply_verb_locked(&job->job, JOB_VERB_SET_SPEED, errp) < 0) { 301 return false; 302 } 303 if (speed < 0) { 304 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "speed", 305 "a non-negative value"); 306 return false; 307 } 308 309 ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME); 310 311 job->speed = speed; 312 313 if (drv->set_speed) { 314 job_unlock(); 315 drv->set_speed(job, speed); 316 job_lock(); 317 } 318 319 if (speed && speed <= old_speed) { 320 return true; 321 } 322 323 /* kick only if a timer is pending */ 324 job_enter_cond_locked(&job->job, job_timer_pending); 325 326 return true; 327 } 328 329 static bool block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) 330 { 331 JOB_LOCK_GUARD(); 332 return block_job_set_speed_locked(job, speed, errp); 333 } 334 335 void block_job_change_locked(BlockJob *job, BlockJobChangeOptions *opts, 336 Error **errp) 337 { 338 const BlockJobDriver *drv = block_job_driver(job); 339 340 GLOBAL_STATE_CODE(); 341 342 if (job_apply_verb_locked(&job->job, JOB_VERB_CHANGE, errp)) { 343 return; 344 } 345 346 if (drv->change) { 347 job_unlock(); 348 drv->change(job, opts, errp); 349 job_lock(); 350 } else { 351 error_setg(errp, "Job type does not support change"); 352 } 353 } 354 355 void block_job_ratelimit_processed_bytes(BlockJob *job, uint64_t n) 356 { 357 IO_CODE(); 358 ratelimit_calculate_delay(&job->limit, n); 359 } 360 361 void block_job_ratelimit_sleep(BlockJob *job) 362 { 363 uint64_t delay_ns; 364 365 /* 366 * Sleep at least once. If the job is reentered early, keep waiting until 367 * we've waited for the full time that is necessary to keep the job at the 368 * right speed. 369 * 370 * Make sure to recalculate the delay after each (possibly interrupted) 371 * sleep because the speed can change while the job has yielded. 372 */ 373 do { 374 delay_ns = ratelimit_calculate_delay(&job->limit, 0); 375 job_sleep_ns(&job->job, delay_ns); 376 } while (delay_ns && !job_is_cancelled(&job->job)); 377 } 378 379 BlockJobInfo *block_job_query_locked(BlockJob *job, Error **errp) 380 { 381 BlockJobInfo *info; 382 uint64_t progress_current, progress_total; 383 const BlockJobDriver *drv = block_job_driver(job); 384 385 GLOBAL_STATE_CODE(); 386 387 if (block_job_is_internal(job)) { 388 error_setg(errp, "Cannot query QEMU internal jobs"); 389 return NULL; 390 } 391 392 progress_get_snapshot(&job->job.progress, &progress_current, 393 &progress_total); 394 395 info = g_new0(BlockJobInfo, 1); 396 info->type = job_type(&job->job); 397 info->device = g_strdup(job->job.id); 398 info->busy = job->job.busy; 399 info->paused = job->job.pause_count > 0; 400 info->offset = progress_current; 401 info->len = progress_total; 402 info->speed = job->speed; 403 info->io_status = job->iostatus; 404 info->ready = job_is_ready_locked(&job->job), 405 info->status = job->job.status; 406 info->auto_finalize = job->job.auto_finalize; 407 info->auto_dismiss = job->job.auto_dismiss; 408 if (job->job.ret) { 409 info->error = job->job.err ? 410 g_strdup(error_get_pretty(job->job.err)) : 411 g_strdup(strerror(-job->job.ret)); 412 } 413 if (drv->query) { 414 job_unlock(); 415 drv->query(job, info); 416 job_lock(); 417 } 418 return info; 419 } 420 421 /* Called with job lock held */ 422 static void block_job_iostatus_set_err_locked(BlockJob *job, int error) 423 { 424 if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 425 job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : 426 BLOCK_DEVICE_IO_STATUS_FAILED; 427 } 428 } 429 430 /* Called with job_mutex lock held. */ 431 static void block_job_event_cancelled_locked(Notifier *n, void *opaque) 432 { 433 BlockJob *job = opaque; 434 uint64_t progress_current, progress_total; 435 436 if (block_job_is_internal(job)) { 437 return; 438 } 439 440 progress_get_snapshot(&job->job.progress, &progress_current, 441 &progress_total); 442 443 qapi_event_send_block_job_cancelled(job_type(&job->job), 444 job->job.id, 445 progress_total, 446 progress_current, 447 job->speed); 448 } 449 450 /* Called with job_mutex lock held. */ 451 static void block_job_event_completed_locked(Notifier *n, void *opaque) 452 { 453 BlockJob *job = opaque; 454 const char *msg = NULL; 455 uint64_t progress_current, progress_total; 456 457 if (block_job_is_internal(job)) { 458 return; 459 } 460 461 if (job->job.ret < 0) { 462 msg = error_get_pretty(job->job.err); 463 } 464 465 progress_get_snapshot(&job->job.progress, &progress_current, 466 &progress_total); 467 468 qapi_event_send_block_job_completed(job_type(&job->job), 469 job->job.id, 470 progress_total, 471 progress_current, 472 job->speed, 473 msg); 474 } 475 476 /* Called with job_mutex lock held. */ 477 static void block_job_event_pending_locked(Notifier *n, void *opaque) 478 { 479 BlockJob *job = opaque; 480 481 if (block_job_is_internal(job)) { 482 return; 483 } 484 485 qapi_event_send_block_job_pending(job_type(&job->job), 486 job->job.id); 487 } 488 489 /* Called with job_mutex lock held. */ 490 static void block_job_event_ready_locked(Notifier *n, void *opaque) 491 { 492 BlockJob *job = opaque; 493 uint64_t progress_current, progress_total; 494 495 if (block_job_is_internal(job)) { 496 return; 497 } 498 499 progress_get_snapshot(&job->job.progress, &progress_current, 500 &progress_total); 501 502 qapi_event_send_block_job_ready(job_type(&job->job), 503 job->job.id, 504 progress_total, 505 progress_current, 506 job->speed); 507 } 508 509 510 void *block_job_create(const char *job_id, const BlockJobDriver *driver, 511 JobTxn *txn, BlockDriverState *bs, uint64_t perm, 512 uint64_t shared_perm, int64_t speed, int flags, 513 BlockCompletionFunc *cb, void *opaque, Error **errp) 514 { 515 BlockJob *job; 516 int ret; 517 GLOBAL_STATE_CODE(); 518 GRAPH_RDLOCK_GUARD_MAINLOOP(); 519 520 if (job_id == NULL && !(flags & JOB_INTERNAL)) { 521 job_id = bdrv_get_device_name(bs); 522 } 523 524 job = job_create(job_id, &driver->job_driver, txn, bdrv_get_aio_context(bs), 525 flags, cb, opaque, errp); 526 if (job == NULL) { 527 return NULL; 528 } 529 530 assert(is_block_job(&job->job)); 531 assert(job->job.driver->free == &block_job_free); 532 assert(job->job.driver->user_resume == &block_job_user_resume); 533 534 ratelimit_init(&job->limit); 535 536 job->finalize_cancelled_notifier.notify = block_job_event_cancelled_locked; 537 job->finalize_completed_notifier.notify = block_job_event_completed_locked; 538 job->pending_notifier.notify = block_job_event_pending_locked; 539 job->ready_notifier.notify = block_job_event_ready_locked; 540 job->idle_notifier.notify = block_job_on_idle_locked; 541 542 WITH_JOB_LOCK_GUARD() { 543 notifier_list_add(&job->job.on_finalize_cancelled, 544 &job->finalize_cancelled_notifier); 545 notifier_list_add(&job->job.on_finalize_completed, 546 &job->finalize_completed_notifier); 547 notifier_list_add(&job->job.on_pending, &job->pending_notifier); 548 notifier_list_add(&job->job.on_ready, &job->ready_notifier); 549 notifier_list_add(&job->job.on_idle, &job->idle_notifier); 550 } 551 552 error_setg(&job->blocker, "block device is in use by block job: %s", 553 job_type_str(&job->job)); 554 555 ret = block_job_add_bdrv(job, "main node", bs, perm, shared_perm, errp); 556 if (ret < 0) { 557 goto fail; 558 } 559 560 bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); 561 562 if (!block_job_set_speed(job, speed, errp)) { 563 goto fail; 564 } 565 566 return job; 567 568 fail: 569 job_early_fail(&job->job); 570 return NULL; 571 } 572 573 void block_job_iostatus_reset_locked(BlockJob *job) 574 { 575 GLOBAL_STATE_CODE(); 576 if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 577 return; 578 } 579 assert(job->job.user_paused && job->job.pause_count > 0); 580 job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; 581 } 582 583 static void block_job_iostatus_reset(BlockJob *job) 584 { 585 JOB_LOCK_GUARD(); 586 block_job_iostatus_reset_locked(job); 587 } 588 589 void block_job_user_resume(Job *job) 590 { 591 BlockJob *bjob = container_of(job, BlockJob, job); 592 GLOBAL_STATE_CODE(); 593 block_job_iostatus_reset(bjob); 594 } 595 596 BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, 597 int is_read, int error) 598 { 599 BlockErrorAction action; 600 IO_CODE(); 601 602 switch (on_err) { 603 case BLOCKDEV_ON_ERROR_ENOSPC: 604 case BLOCKDEV_ON_ERROR_AUTO: 605 action = (error == ENOSPC) ? 606 BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; 607 break; 608 case BLOCKDEV_ON_ERROR_STOP: 609 action = BLOCK_ERROR_ACTION_STOP; 610 break; 611 case BLOCKDEV_ON_ERROR_REPORT: 612 action = BLOCK_ERROR_ACTION_REPORT; 613 break; 614 case BLOCKDEV_ON_ERROR_IGNORE: 615 action = BLOCK_ERROR_ACTION_IGNORE; 616 break; 617 default: 618 abort(); 619 } 620 if (!block_job_is_internal(job)) { 621 qapi_event_send_block_job_error(job->job.id, 622 is_read ? IO_OPERATION_TYPE_READ : 623 IO_OPERATION_TYPE_WRITE, 624 action); 625 } 626 if (action == BLOCK_ERROR_ACTION_STOP) { 627 WITH_JOB_LOCK_GUARD() { 628 if (!job->job.user_paused) { 629 job_pause_locked(&job->job); 630 /* 631 * make the pause user visible, which will be 632 * resumed from QMP. 633 */ 634 job->job.user_paused = true; 635 } 636 block_job_iostatus_set_err_locked(job, error); 637 } 638 } 639 return action; 640 } 641 642 AioContext *block_job_get_aio_context(BlockJob *job) 643 { 644 GLOBAL_STATE_CODE(); 645 return job->job.aio_context; 646 } 647