job.c

   1 /*
   2  * Background jobs (long-running operations)
   3  *
   4  * Copyright (c) 2011 IBM Corp.
   5  * Copyright (c) 2012, 2018 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 "qemu-common.h"
  28 #include "qapi/error.h"
  29 #include "qemu/job.h"
  30 #include "qemu/id.h"
  31 #include "qemu/main-loop.h"
  32 #include "trace-root.h"
  33 #include "qapi/qapi-events-job.h"
  34
  35 static QLIST_HEAD(, Job) jobs = QLIST_HEAD_INITIALIZER(jobs);
  36
  37 /* Job State Transition Table */
  38 bool JobSTT[JOB_STATUS__MAX][JOB_STATUS__MAX] = {
  39                                     /* U, C, R, P, Y, S, W, D, X, E, N */
  40     /* U: */ [JOB_STATUS_UNDEFINED] = {0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0},
  41     /* C: */ [JOB_STATUS_CREATED]   = {0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 1},
  42     /* R: */ [JOB_STATUS_RUNNING]   = {0, 0, 0, 1, 1, 0, 1, 0, 1, 0, 0},
  43     /* P: */ [JOB_STATUS_PAUSED]    = {0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0},
  44     /* Y: */ [JOB_STATUS_READY]     = {0, 0, 0, 0, 0, 1, 1, 0, 1, 0, 0},
  45     /* S: */ [JOB_STATUS_STANDBY]   = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0},
  46     /* W: */ [JOB_STATUS_WAITING]   = {0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0},
  47     /* D: */ [JOB_STATUS_PENDING]   = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0},
  48     /* X: */ [JOB_STATUS_ABORTING]  = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0},
  49     /* E: */ [JOB_STATUS_CONCLUDED] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1},
  50     /* N: */ [JOB_STATUS_NULL]      = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
  51 };
  52
  53 bool JobVerbTable[JOB_VERB__MAX][JOB_STATUS__MAX] = {
  54                                     /* U, C, R, P, Y, S, W, D, X, E, N */
  55     [JOB_VERB_CANCEL]               = {0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0},
  56     [JOB_VERB_PAUSE]                = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0},
  57     [JOB_VERB_RESUME]               = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0},
  58     [JOB_VERB_SET_SPEED]            = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0},
  59     [JOB_VERB_COMPLETE]             = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0},
  60     [JOB_VERB_FINALIZE]             = {0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0},
  61     [JOB_VERB_DISMISS]              = {0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0},
  62 };
  63
  64 /* Transactional group of jobs */
  65 struct JobTxn {
  66
  67     /* Is this txn being cancelled? */
  68     bool aborting;
  69
  70     /* List of jobs */
  71     QLIST_HEAD(, Job) jobs;
  72
  73     /* Reference count */
  74     int refcnt;
  75 };
  76
  77 /* Right now, this mutex is only needed to synchronize accesses to job->busy
  78  * and job->sleep_timer, such as concurrent calls to job_do_yield and
  79  * job_enter. */
  80 static QemuMutex job_mutex;
  81
  82 static void job_lock(void)
  83 {
  84     qemu_mutex_lock(&job_mutex);
  85 }
  86
  87 static void job_unlock(void)
  88 {
  89     qemu_mutex_unlock(&job_mutex);
  90 }
  91
  92 static void __attribute__((__constructor__)) job_init(void)
  93 {
  94     qemu_mutex_init(&job_mutex);
  95 }
  96
  97 JobTxn *job_txn_new(void)
  98 {
  99     JobTxn *txn = g_new0(JobTxn, 1);
 100     QLIST_INIT(&txn->jobs);
 101     txn->refcnt = 1;
 102     return txn;
 103 }
 104
 105 static void job_txn_ref(JobTxn *txn)
 106 {
 107     txn->refcnt++;
 108 }
 109
 110 void job_txn_unref(JobTxn *txn)
 111 {
 112     if (txn && --txn->refcnt == 0) {
 113         g_free(txn);
 114     }
 115 }
 116
 117 void job_txn_add_job(JobTxn *txn, Job *job)
 118 {
 119     if (!txn) {
 120         return;
 121     }
 122
 123     assert(!job->txn);
 124     job->txn = txn;
 125
 126     QLIST_INSERT_HEAD(&txn->jobs, job, txn_list);
 127     job_txn_ref(txn);
 128 }
 129
 130 static void job_txn_del_job(Job *job)
 131 {
 132     if (job->txn) {
 133         QLIST_REMOVE(job, txn_list);
 134         job_txn_unref(job->txn);
 135         job->txn = NULL;
 136     }
 137 }
 138
 139 static int job_txn_apply(JobTxn *txn, int fn(Job *))
 140 {
 141     Job *job, *next;
 142     int rc = 0;
 143
 144     QLIST_FOREACH_SAFE(job, &txn->jobs, txn_list, next) {
 145         rc = fn(job);
 146         if (rc) {
 147             break;
 148         }
 149     }
 150     return rc;
 151 }
 152
 153 bool job_is_internal(Job *job)
 154 {
 155     return (job->id == NULL);
 156 }
 157
 158 static void job_state_transition(Job *job, JobStatus s1)
 159 {
 160     JobStatus s0 = job->status;
 161     assert(s1 >= 0 && s1 <= JOB_STATUS__MAX);
 162     trace_job_state_transition(job, job->ret,
 163                                JobSTT[s0][s1] ? "allowed" : "disallowed",
 164                                JobStatus_str(s0), JobStatus_str(s1));
 165     assert(JobSTT[s0][s1]);
 166     job->status = s1;
 167
 168     if (!job_is_internal(job) && s1 != s0) {
 169         qapi_event_send_job_status_change(job->id, job->status);
 170     }
 171 }
 172
 173 int job_apply_verb(Job *job, JobVerb verb, Error **errp)
 174 {
 175     JobStatus s0 = job->status;
 176     assert(verb >= 0 && verb <= JOB_VERB__MAX);
 177     trace_job_apply_verb(job, JobStatus_str(s0), JobVerb_str(verb),
 178                          JobVerbTable[verb][s0] ? "allowed" : "prohibited");
 179     if (JobVerbTable[verb][s0]) {
 180         return 0;
 181     }
 182     error_setg(errp, "Job '%s' in state '%s' cannot accept command verb '%s'",
 183                job->id, JobStatus_str(s0), JobVerb_str(verb));
 184     return -EPERM;
 185 }
 186
 187 JobType job_type(const Job *job)
 188 {
 189     return job->driver->job_type;
 190 }
 191
 192 const char *job_type_str(const Job *job)
 193 {
 194     return JobType_str(job_type(job));
 195 }
 196
 197 bool job_is_cancelled(Job *job)
 198 {
 199     return job->cancelled;
 200 }
 201
 202 bool job_is_ready(Job *job)
 203 {
 204     switch (job->status) {
 205     case JOB_STATUS_UNDEFINED:
 206     case JOB_STATUS_CREATED:
 207     case JOB_STATUS_RUNNING:
 208     case JOB_STATUS_PAUSED:
 209     case JOB_STATUS_WAITING:
 210     case JOB_STATUS_PENDING:
 211     case JOB_STATUS_ABORTING:
 212     case JOB_STATUS_CONCLUDED:
 213     case JOB_STATUS_NULL:
 214         return false;
 215     case JOB_STATUS_READY:
 216     case JOB_STATUS_STANDBY:
 217         return true;
 218     default:
 219         g_assert_not_reached();
 220     }
 221     return false;
 222 }
 223
 224 bool job_is_completed(Job *job)
 225 {
 226     switch (job->status) {
 227     case JOB_STATUS_UNDEFINED:
 228     case JOB_STATUS_CREATED:
 229     case JOB_STATUS_RUNNING:
 230     case JOB_STATUS_PAUSED:
 231     case JOB_STATUS_READY:
 232     case JOB_STATUS_STANDBY:
 233         return false;
 234     case JOB_STATUS_WAITING:
 235     case JOB_STATUS_PENDING:
 236     case JOB_STATUS_ABORTING:
 237     case JOB_STATUS_CONCLUDED:
 238     case JOB_STATUS_NULL:
 239         return true;
 240     default:
 241         g_assert_not_reached();
 242     }
 243     return false;
 244 }
 245
 246 static bool job_started(Job *job)
 247 {
 248     return job->co;
 249 }
 250
 251 static bool job_should_pause(Job *job)
 252 {
 253     return job->pause_count > 0;
 254 }
 255
 256 Job *job_next(Job *job)
 257 {
 258     if (!job) {
 259         return QLIST_FIRST(&jobs);
 260     }
 261     return QLIST_NEXT(job, job_list);
 262 }
 263
 264 Job *job_get(const char *id)
 265 {
 266     Job *job;
 267
 268     QLIST_FOREACH(job, &jobs, job_list) {
 269         if (job->id && !strcmp(id, job->id)) {
 270             return job;
 271         }
 272     }
 273
 274     return NULL;
 275 }
 276
 277 static void job_sleep_timer_cb(void *opaque)
 278 {
 279     Job *job = opaque;
 280
 281     job_enter(job);
 282 }
 283
 284 void *job_create(const char *job_id, const JobDriver *driver, JobTxn *txn,
 285                  AioContext *ctx, int flags, BlockCompletionFunc *cb,
 286                  void *opaque, Error **errp)
 287 {
 288     Job *job;
 289
 290     if (job_id) {
 291         if (flags & JOB_INTERNAL) {
 292             error_setg(errp, "Cannot specify job ID for internal job");
 293             return NULL;
 294         }
 295         if (!id_wellformed(job_id)) {
 296             error_setg(errp, "Invalid job ID '%s'", job_id);
 297             return NULL;
 298         }
 299         if (job_get(job_id)) {
 300             error_setg(errp, "Job ID '%s' already in use", job_id);
 301             return NULL;
 302         }
 303     } else if (!(flags & JOB_INTERNAL)) {
 304         error_setg(errp, "An explicit job ID is required");
 305         return NULL;
 306     }
 307
 308     job = g_malloc0(driver->instance_size);
 309     job->driver        = driver;
 310     job->id            = g_strdup(job_id);
 311     job->refcnt        = 1;
 312     job->aio_context   = ctx;
 313     job->busy          = false;
 314     job->paused        = true;
 315     job->pause_count   = 1;
 316     job->auto_finalize = !(flags & JOB_MANUAL_FINALIZE);
 317     job->auto_dismiss  = !(flags & JOB_MANUAL_DISMISS);
 318     job->cb            = cb;
 319     job->opaque        = opaque;
 320
 321     notifier_list_init(&job->on_finalize_cancelled);
 322     notifier_list_init(&job->on_finalize_completed);
 323     notifier_list_init(&job->on_pending);
 324     notifier_list_init(&job->on_ready);
 325
 326     job_state_transition(job, JOB_STATUS_CREATED);
 327     aio_timer_init(qemu_get_aio_context(), &job->sleep_timer,
 328                    QEMU_CLOCK_REALTIME, SCALE_NS,
 329                    job_sleep_timer_cb, job);
 330
 331     QLIST_INSERT_HEAD(&jobs, job, job_list);
 332
 333     /* Single jobs are modeled as single-job transactions for sake of
 334      * consolidating the job management logic */
 335     if (!txn) {
 336         txn = job_txn_new();
 337         job_txn_add_job(txn, job);
 338         job_txn_unref(txn);
 339     } else {
 340         job_txn_add_job(txn, job);
 341     }
 342
 343     return job;
 344 }
 345
 346 void job_ref(Job *job)
 347 {
 348     ++job->refcnt;
 349 }
 350
 351 void job_unref(Job *job)
 352 {
 353     if (--job->refcnt == 0) {
 354         assert(job->status == JOB_STATUS_NULL);
 355         assert(!timer_pending(&job->sleep_timer));
 356         assert(!job->txn);
 357
 358         if (job->driver->free) {
 359             job->driver->free(job);
 360         }
 361
 362         QLIST_REMOVE(job, job_list);
 363
 364         error_free(job->err);
 365         g_free(job->id);
 366         g_free(job);
 367     }
 368 }
 369
 370 void job_progress_update(Job *job, uint64_t done)
 371 {
 372     job->progress_current += done;
 373 }
 374
 375 void job_progress_set_remaining(Job *job, uint64_t remaining)
 376 {
 377     job->progress_total = job->progress_current + remaining;
 378 }
 379
 380 void job_progress_increase_remaining(Job *job, uint64_t delta)
 381 {
 382     job->progress_total += delta;
 383 }
 384
 385 void job_event_cancelled(Job *job)
 386 {
 387     notifier_list_notify(&job->on_finalize_cancelled, job);
 388 }
 389
 390 void job_event_completed(Job *job)
 391 {
 392     notifier_list_notify(&job->on_finalize_completed, job);
 393 }
 394
 395 static void job_event_pending(Job *job)
 396 {
 397     notifier_list_notify(&job->on_pending, job);
 398 }
 399
 400 static void job_event_ready(Job *job)
 401 {
 402     notifier_list_notify(&job->on_ready, job);
 403 }
 404
 405 void job_enter_cond(Job *job, bool(*fn)(Job *job))
 406 {
 407     if (!job_started(job)) {
 408         return;
 409     }
 410     if (job->deferred_to_main_loop) {
 411         return;
 412     }
 413
 414     job_lock();
 415     if (job->busy) {
 416         job_unlock();
 417         return;
 418     }
 419
 420     if (fn && !fn(job)) {
 421         job_unlock();
 422         return;
 423     }
 424
 425     assert(!job->deferred_to_main_loop);
 426     timer_del(&job->sleep_timer);
 427     job->busy = true;
 428     job_unlock();
 429     aio_co_wake(job->co);
 430 }
 431
 432 void job_enter(Job *job)
 433 {
 434     job_enter_cond(job, NULL);
 435 }
 436
 437 /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds.
 438  * Reentering the job coroutine with job_enter() before the timer has expired
 439  * is allowed and cancels the timer.
 440  *
 441  * If @ns is (uint64_t) -1, no timer is scheduled and job_enter() must be
 442  * called explicitly. */
 443 static void coroutine_fn job_do_yield(Job *job, uint64_t ns)
 444 {
 445     job_lock();
 446     if (ns != -1) {
 447         timer_mod(&job->sleep_timer, ns);
 448     }
 449     job->busy = false;
 450     job_unlock();
 451     qemu_coroutine_yield();
 452
 453     /* Set by job_enter_cond() before re-entering the coroutine.  */
 454     assert(job->busy);
 455 }
 456
 457 void coroutine_fn job_pause_point(Job *job)
 458 {
 459     assert(job && job_started(job));
 460
 461     if (!job_should_pause(job)) {
 462         return;
 463     }
 464     if (job_is_cancelled(job)) {
 465         return;
 466     }
 467
 468     if (job->driver->pause) {
 469         job->driver->pause(job);
 470     }
 471
 472     if (job_should_pause(job) && !job_is_cancelled(job)) {
 473         JobStatus status = job->status;
 474         job_state_transition(job, status == JOB_STATUS_READY
 475                                   ? JOB_STATUS_STANDBY
 476                                   : JOB_STATUS_PAUSED);
 477         job->paused = true;
 478         job_do_yield(job, -1);
 479         job->paused = false;
 480         job_state_transition(job, status);
 481     }
 482
 483     if (job->driver->resume) {
 484         job->driver->resume(job);
 485     }
 486 }
 487
 488 void job_yield(Job *job)
 489 {
 490     assert(job->busy);
 491
 492     /* Check cancellation *before* setting busy = false, too!  */
 493     if (job_is_cancelled(job)) {
 494         return;
 495     }
 496
 497     if (!job_should_pause(job)) {
 498         job_do_yield(job, -1);
 499     }
 500
 501     job_pause_point(job);
 502 }
 503
 504 void coroutine_fn job_sleep_ns(Job *job, int64_t ns)
 505 {
 506     assert(job->busy);
 507
 508     /* Check cancellation *before* setting busy = false, too!  */
 509     if (job_is_cancelled(job)) {
 510         return;
 511     }
 512
 513     if (!job_should_pause(job)) {
 514         job_do_yield(job, qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + ns);
 515     }
 516
 517     job_pause_point(job);
 518 }
 519
 520 void job_drain(Job *job)
 521 {
 522     /* If job is !busy this kicks it into the next pause point. */
 523     job_enter(job);
 524
 525     if (job->driver->drain) {
 526         job->driver->drain(job);
 527     }
 528 }
 529
 530 /* Assumes the block_job_mutex is held */
 531 static bool job_timer_not_pending(Job *job)
 532 {
 533     return !timer_pending(&job->sleep_timer);
 534 }
 535
 536 void job_pause(Job *job)
 537 {
 538     job->pause_count++;
 539 }
 540
 541 void job_resume(Job *job)
 542 {
 543     assert(job->pause_count > 0);
 544     job->pause_count--;
 545     if (job->pause_count) {
 546         return;
 547     }
 548
 549     /* kick only if no timer is pending */
 550     job_enter_cond(job, job_timer_not_pending);
 551 }
 552
 553 void job_user_pause(Job *job, Error **errp)
 554 {
 555     if (job_apply_verb(job, JOB_VERB_PAUSE, errp)) {
 556         return;
 557     }
 558     if (job->user_paused) {
 559         error_setg(errp, "Job is already paused");
 560         return;
 561     }
 562     job->user_paused = true;
 563     job_pause(job);
 564 }
 565
 566 bool job_user_paused(Job *job)
 567 {
 568     return job->user_paused;
 569 }
 570
 571 void job_user_resume(Job *job, Error **errp)
 572 {
 573     assert(job);
 574     if (!job->user_paused || job->pause_count <= 0) {
 575         error_setg(errp, "Can't resume a job that was not paused");
 576         return;
 577     }
 578     if (job_apply_verb(job, JOB_VERB_RESUME, errp)) {
 579         return;
 580     }
 581     if (job->driver->user_resume) {
 582         job->driver->user_resume(job);
 583     }
 584     job->user_paused = false;
 585     job_resume(job);
 586 }
 587
 588 static void job_do_dismiss(Job *job)
 589 {
 590     assert(job);
 591     job->busy = false;
 592     job->paused = false;
 593     job->deferred_to_main_loop = true;
 594
 595     job_txn_del_job(job);
 596
 597     job_state_transition(job, JOB_STATUS_NULL);
 598     job_unref(job);
 599 }
 600
 601 void job_dismiss(Job **jobptr, Error **errp)
 602 {
 603     Job *job = *jobptr;
 604     /* similarly to _complete, this is QMP-interface only. */
 605     assert(job->id);
 606     if (job_apply_verb(job, JOB_VERB_DISMISS, errp)) {
 607         return;
 608     }
 609
 610     job_do_dismiss(job);
 611     *jobptr = NULL;
 612 }
 613
 614 void job_early_fail(Job *job)
 615 {
 616     assert(job->status == JOB_STATUS_CREATED);
 617     job_do_dismiss(job);
 618 }
 619
 620 static void job_conclude(Job *job)
 621 {
 622     job_state_transition(job, JOB_STATUS_CONCLUDED);
 623     if (job->auto_dismiss || !job_started(job)) {
 624         job_do_dismiss(job);
 625     }
 626 }
 627
 628 static void job_update_rc(Job *job)
 629 {
 630     if (!job->ret && job_is_cancelled(job)) {
 631         job->ret = -ECANCELED;
 632     }
 633     if (job->ret) {
 634         if (!job->err) {
 635             error_setg(&job->err, "%s", strerror(-job->ret));
 636         }
 637         job_state_transition(job, JOB_STATUS_ABORTING);
 638     }
 639 }
 640
 641 static void job_commit(Job *job)
 642 {
 643     assert(!job->ret);
 644     if (job->driver->commit) {
 645         job->driver->commit(job);
 646     }
 647 }
 648
 649 static void job_abort(Job *job)
 650 {
 651     assert(job->ret);
 652     if (job->driver->abort) {
 653         job->driver->abort(job);
 654     }
 655 }
 656
 657 static void job_clean(Job *job)
 658 {
 659     if (job->driver->clean) {
 660         job->driver->clean(job);
 661     }
 662 }
 663
 664 static int job_finalize_single(Job *job)
 665 {
 666     assert(job_is_completed(job));
 667
 668     /* Ensure abort is called for late-transactional failures */
 669     job_update_rc(job);
 670
 671     if (!job->ret) {
 672         job_commit(job);
 673     } else {
 674         job_abort(job);
 675     }
 676     job_clean(job);
 677
 678     if (job->cb) {
 679         job->cb(job->opaque, job->ret);
 680     }
 681
 682     /* Emit events only if we actually started */
 683     if (job_started(job)) {
 684         if (job_is_cancelled(job)) {
 685             job_event_cancelled(job);
 686         } else {
 687             job_event_completed(job);
 688         }
 689     }
 690
 691     job_txn_del_job(job);
 692     job_conclude(job);
 693     return 0;
 694 }
 695
 696 static void job_cancel_async(Job *job, bool force)
 697 {
 698     if (job->user_paused) {
 699         /* Do not call job_enter here, the caller will handle it.  */
 700         if (job->driver->user_resume) {
 701             job->driver->user_resume(job);
 702         }
 703         job->user_paused = false;
 704         assert(job->pause_count > 0);
 705         job->pause_count--;
 706     }
 707     job->cancelled = true;
 708     /* To prevent 'force == false' overriding a previous 'force == true' */
 709     job->force_cancel |= force;
 710 }
 711
 712 static void job_completed_txn_abort(Job *job)
 713 {
 714     AioContext *ctx;
 715     JobTxn *txn = job->txn;
 716     Job *other_job;
 717
 718     if (txn->aborting) {
 719         /*
 720          * We are cancelled by another job, which will handle everything.
 721          */
 722         return;
 723     }
 724     txn->aborting = true;
 725     job_txn_ref(txn);
 726
 727     /* We are the first failed job. Cancel other jobs. */
 728     QLIST_FOREACH(other_job, &txn->jobs, txn_list) {
 729         ctx = other_job->aio_context;
 730         aio_context_acquire(ctx);
 731     }
 732
 733     /* Other jobs are effectively cancelled by us, set the status for
 734      * them; this job, however, may or may not be cancelled, depending
 735      * on the caller, so leave it. */
 736     QLIST_FOREACH(other_job, &txn->jobs, txn_list) {
 737         if (other_job != job) {
 738             job_cancel_async(other_job, false);
 739         }
 740     }
 741     while (!QLIST_EMPTY(&txn->jobs)) {
 742         other_job = QLIST_FIRST(&txn->jobs);
 743         ctx = other_job->aio_context;
 744         if (!job_is_completed(other_job)) {
 745             assert(job_is_cancelled(other_job));
 746             job_finish_sync(other_job, NULL, NULL);
 747         }
 748         job_finalize_single(other_job);
 749         aio_context_release(ctx);
 750     }
 751
 752     job_txn_unref(txn);
 753 }
 754
 755 static int job_prepare(Job *job)
 756 {
 757     if (job->ret == 0 && job->driver->prepare) {
 758         job->ret = job->driver->prepare(job);
 759         job_update_rc(job);
 760     }
 761     return job->ret;
 762 }
 763
 764 static int job_needs_finalize(Job *job)
 765 {
 766     return !job->auto_finalize;
 767 }
 768
 769 static void job_do_finalize(Job *job)
 770 {
 771     int rc;
 772     assert(job && job->txn);
 773
 774     /* prepare the transaction to complete */
 775     rc = job_txn_apply(job->txn, job_prepare);
 776     if (rc) {
 777         job_completed_txn_abort(job);
 778     } else {
 779         job_txn_apply(job->txn, job_finalize_single);
 780     }
 781 }
 782
 783 void job_finalize(Job *job, Error **errp)
 784 {
 785     assert(job && job->id);
 786     if (job_apply_verb(job, JOB_VERB_FINALIZE, errp)) {
 787         return;
 788     }
 789     job_do_finalize(job);
 790 }
 791
 792 static int job_transition_to_pending(Job *job)
 793 {
 794     job_state_transition(job, JOB_STATUS_PENDING);
 795     if (!job->auto_finalize) {
 796         job_event_pending(job);
 797     }
 798     return 0;
 799 }
 800
 801 void job_transition_to_ready(Job *job)
 802 {
 803     job_state_transition(job, JOB_STATUS_READY);
 804     job_event_ready(job);
 805 }
 806
 807 static void job_completed_txn_success(Job *job)
 808 {
 809     JobTxn *txn = job->txn;
 810     Job *other_job;
 811
 812     job_state_transition(job, JOB_STATUS_WAITING);
 813
 814     /*
 815      * Successful completion, see if there are other running jobs in this
 816      * txn.
 817      */
 818     QLIST_FOREACH(other_job, &txn->jobs, txn_list) {
 819         if (!job_is_completed(other_job)) {
 820             return;
 821         }
 822         assert(other_job->ret == 0);
 823     }
 824
 825     job_txn_apply(txn, job_transition_to_pending);
 826
 827     /* If no jobs need manual finalization, automatically do so */
 828     if (job_txn_apply(txn, job_needs_finalize) == 0) {
 829         job_do_finalize(job);
 830     }
 831 }
 832
 833 static void job_completed(Job *job)
 834 {
 835     assert(job && job->txn && !job_is_completed(job));
 836
 837     job_update_rc(job);
 838     trace_job_completed(job, job->ret);
 839     if (job->ret) {
 840         job_completed_txn_abort(job);
 841     } else {
 842         job_completed_txn_success(job);
 843     }
 844 }
 845
 846 /** Useful only as a type shim for aio_bh_schedule_oneshot. */
 847 static void job_exit(void *opaque)
 848 {
 849     Job *job = (Job *)opaque;
 850     AioContext *ctx = job->aio_context;
 851
 852     aio_context_acquire(ctx);
 853     job_completed(job);
 854     aio_context_release(ctx);
 855 }
 856
 857 /**
 858  * All jobs must allow a pause point before entering their job proper. This
 859  * ensures that jobs can be paused prior to being started, then resumed later.
 860  */
 861 static void coroutine_fn job_co_entry(void *opaque)
 862 {
 863     Job *job = opaque;
 864
 865     assert(job && job->driver && job->driver->run);
 866     job_pause_point(job);
 867     job->ret = job->driver->run(job, &job->err);
 868     job->deferred_to_main_loop = true;
 869     aio_bh_schedule_oneshot(qemu_get_aio_context(), job_exit, job);
 870 }
 871
 872 void job_start(Job *job)
 873 {
 874     assert(job && !job_started(job) && job->paused &&
 875            job->driver && job->driver->run);
 876     job->co = qemu_coroutine_create(job_co_entry, job);
 877     job->pause_count--;
 878     job->busy = true;
 879     job->paused = false;
 880     job_state_transition(job, JOB_STATUS_RUNNING);
 881     aio_co_enter(job->aio_context, job->co);
 882 }
 883
 884 void job_cancel(Job *job, bool force)
 885 {
 886     if (job->status == JOB_STATUS_CONCLUDED) {
 887         job_do_dismiss(job);
 888         return;
 889     }
 890     job_cancel_async(job, force);
 891     if (!job_started(job)) {
 892         job_completed(job);
 893     } else if (job->deferred_to_main_loop) {
 894         job_completed_txn_abort(job);
 895     } else {
 896         job_enter(job);
 897     }
 898 }
 899
 900 void job_user_cancel(Job *job, bool force, Error **errp)
 901 {
 902     if (job_apply_verb(job, JOB_VERB_CANCEL, errp)) {
 903         return;
 904     }
 905     job_cancel(job, force);
 906 }
 907
 908 /* A wrapper around job_cancel() taking an Error ** parameter so it may be
 909  * used with job_finish_sync() without the need for (rather nasty) function
 910  * pointer casts there. */
 911 static void job_cancel_err(Job *job, Error **errp)
 912 {
 913     job_cancel(job, false);
 914 }
 915
 916 int job_cancel_sync(Job *job)
 917 {
 918     return job_finish_sync(job, &job_cancel_err, NULL);
 919 }
 920
 921 void job_cancel_sync_all(void)
 922 {
 923     Job *job;
 924     AioContext *aio_context;
 925
 926     while ((job = job_next(NULL))) {
 927         aio_context = job->aio_context;
 928         aio_context_acquire(aio_context);
 929         job_cancel_sync(job);
 930         aio_context_release(aio_context);
 931     }
 932 }
 933
 934 int job_complete_sync(Job *job, Error **errp)
 935 {
 936     return job_finish_sync(job, job_complete, errp);
 937 }
 938
 939 void job_complete(Job *job, Error **errp)
 940 {
 941     /* Should not be reachable via external interface for internal jobs */
 942     assert(job->id);
 943     if (job_apply_verb(job, JOB_VERB_COMPLETE, errp)) {
 944         return;
 945     }
 946     if (job->pause_count || job_is_cancelled(job) || !job->driver->complete) {
 947         error_setg(errp, "The active block job '%s' cannot be completed",
 948                    job->id);
 949         return;
 950     }
 951
 952     job->driver->complete(job, errp);
 953 }
 954
 955 int job_finish_sync(Job *job, void (*finish)(Job *, Error **errp), Error **errp)
 956 {
 957     Error *local_err = NULL;
 958     int ret;
 959
 960     job_ref(job);
 961
 962     if (finish) {
 963         finish(job, &local_err);
 964     }
 965     if (local_err) {
 966         error_propagate(errp, local_err);
 967         job_unref(job);
 968         return -EBUSY;
 969     }
 970     /* job_drain calls job_enter, and it should be enough to induce progress
 971      * until the job completes or moves to the main thread. */
 972     while (!job->deferred_to_main_loop && !job_is_completed(job)) {
 973         job_drain(job);
 974     }
 975     while (!job_is_completed(job)) {
 976         aio_poll(qemu_get_aio_context(), true);
 977     }
 978     ret = (job_is_cancelled(job) && job->ret == 0) ? -ECANCELED : job->ret;
 979     job_unref(job);
 980     return ret;
 981 }