133e9e9bdSKevin Wolf /* 233e9e9bdSKevin Wolf * Background jobs (long-running operations) 333e9e9bdSKevin Wolf * 433e9e9bdSKevin Wolf * Copyright (c) 2011 IBM Corp. 533e9e9bdSKevin Wolf * Copyright (c) 2012, 2018 Red Hat, Inc. 633e9e9bdSKevin Wolf * 733e9e9bdSKevin Wolf * Permission is hereby granted, free of charge, to any person obtaining a copy 833e9e9bdSKevin Wolf * of this software and associated documentation files (the "Software"), to deal 933e9e9bdSKevin Wolf * in the Software without restriction, including without limitation the rights 1033e9e9bdSKevin Wolf * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 1133e9e9bdSKevin Wolf * copies of the Software, and to permit persons to whom the Software is 1233e9e9bdSKevin Wolf * furnished to do so, subject to the following conditions: 1333e9e9bdSKevin Wolf * 1433e9e9bdSKevin Wolf * The above copyright notice and this permission notice shall be included in 1533e9e9bdSKevin Wolf * all copies or substantial portions of the Software. 1633e9e9bdSKevin Wolf * 1733e9e9bdSKevin Wolf * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 1833e9e9bdSKevin Wolf * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 1933e9e9bdSKevin Wolf * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 2033e9e9bdSKevin Wolf * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 2133e9e9bdSKevin Wolf * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 2233e9e9bdSKevin Wolf * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 2333e9e9bdSKevin Wolf * THE SOFTWARE. 2433e9e9bdSKevin Wolf */ 2533e9e9bdSKevin Wolf 2633e9e9bdSKevin Wolf #include "qemu/osdep.h" 2733e9e9bdSKevin Wolf #include "qemu-common.h" 2833e9e9bdSKevin Wolf #include "qapi/error.h" 2933e9e9bdSKevin Wolf #include "qemu/job.h" 3033e9e9bdSKevin Wolf #include "qemu/id.h" 311908a559SKevin Wolf #include "qemu/main-loop.h" 32a50c2ab8SKevin Wolf #include "trace-root.h" 3333e9e9bdSKevin Wolf 34e7c1d78bSKevin Wolf static QLIST_HEAD(, Job) jobs = QLIST_HEAD_INITIALIZER(jobs); 35e7c1d78bSKevin Wolf 36a50c2ab8SKevin Wolf /* Job State Transition Table */ 37a50c2ab8SKevin Wolf bool JobSTT[JOB_STATUS__MAX][JOB_STATUS__MAX] = { 38a50c2ab8SKevin Wolf /* U, C, R, P, Y, S, W, D, X, E, N */ 39a50c2ab8SKevin Wolf /* U: */ [JOB_STATUS_UNDEFINED] = {0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0}, 40a50c2ab8SKevin Wolf /* C: */ [JOB_STATUS_CREATED] = {0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 1}, 41a50c2ab8SKevin Wolf /* R: */ [JOB_STATUS_RUNNING] = {0, 0, 0, 1, 1, 0, 1, 0, 1, 0, 0}, 42a50c2ab8SKevin Wolf /* P: */ [JOB_STATUS_PAUSED] = {0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0}, 43a50c2ab8SKevin Wolf /* Y: */ [JOB_STATUS_READY] = {0, 0, 0, 0, 0, 1, 1, 0, 1, 0, 0}, 44a50c2ab8SKevin Wolf /* S: */ [JOB_STATUS_STANDBY] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0}, 45a50c2ab8SKevin Wolf /* W: */ [JOB_STATUS_WAITING] = {0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0}, 46a50c2ab8SKevin Wolf /* D: */ [JOB_STATUS_PENDING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, 47a50c2ab8SKevin Wolf /* X: */ [JOB_STATUS_ABORTING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, 48a50c2ab8SKevin Wolf /* E: */ [JOB_STATUS_CONCLUDED] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}, 49a50c2ab8SKevin Wolf /* N: */ [JOB_STATUS_NULL] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}, 50a50c2ab8SKevin Wolf }; 51a50c2ab8SKevin Wolf 52a50c2ab8SKevin Wolf bool JobVerbTable[JOB_VERB__MAX][JOB_STATUS__MAX] = { 53a50c2ab8SKevin Wolf /* U, C, R, P, Y, S, W, D, X, E, N */ 54a50c2ab8SKevin Wolf [JOB_VERB_CANCEL] = {0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0}, 55a50c2ab8SKevin Wolf [JOB_VERB_PAUSE] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 56a50c2ab8SKevin Wolf [JOB_VERB_RESUME] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 57a50c2ab8SKevin Wolf [JOB_VERB_SET_SPEED] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 58a50c2ab8SKevin Wolf [JOB_VERB_COMPLETE] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0}, 59a50c2ab8SKevin Wolf [JOB_VERB_FINALIZE] = {0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0}, 60a50c2ab8SKevin Wolf [JOB_VERB_DISMISS] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0}, 61a50c2ab8SKevin Wolf }; 62a50c2ab8SKevin Wolf 63da01ff7fSKevin Wolf /* Right now, this mutex is only needed to synchronize accesses to job->busy 64da01ff7fSKevin Wolf * and job->sleep_timer, such as concurrent calls to job_do_yield and 65da01ff7fSKevin Wolf * job_enter. */ 66da01ff7fSKevin Wolf static QemuMutex job_mutex; 67da01ff7fSKevin Wolf 68da01ff7fSKevin Wolf static void job_lock(void) 69da01ff7fSKevin Wolf { 70da01ff7fSKevin Wolf qemu_mutex_lock(&job_mutex); 71da01ff7fSKevin Wolf } 72da01ff7fSKevin Wolf 73da01ff7fSKevin Wolf static void job_unlock(void) 74da01ff7fSKevin Wolf { 75da01ff7fSKevin Wolf qemu_mutex_unlock(&job_mutex); 76da01ff7fSKevin Wolf } 77da01ff7fSKevin Wolf 78da01ff7fSKevin Wolf static void __attribute__((__constructor__)) job_init(void) 79da01ff7fSKevin Wolf { 80da01ff7fSKevin Wolf qemu_mutex_init(&job_mutex); 81da01ff7fSKevin Wolf } 82da01ff7fSKevin Wolf 83a50c2ab8SKevin Wolf /* TODO Make static once the whole state machine is in job.c */ 84a50c2ab8SKevin Wolf void job_state_transition(Job *job, JobStatus s1) 85a50c2ab8SKevin Wolf { 86a50c2ab8SKevin Wolf JobStatus s0 = job->status; 87a50c2ab8SKevin Wolf assert(s1 >= 0 && s1 <= JOB_STATUS__MAX); 884ad35181SKevin Wolf trace_job_state_transition(job, job->ret, 89a50c2ab8SKevin Wolf JobSTT[s0][s1] ? "allowed" : "disallowed", 90a50c2ab8SKevin Wolf JobStatus_str(s0), JobStatus_str(s1)); 91a50c2ab8SKevin Wolf assert(JobSTT[s0][s1]); 92a50c2ab8SKevin Wolf job->status = s1; 93a50c2ab8SKevin Wolf } 94a50c2ab8SKevin Wolf 95a50c2ab8SKevin Wolf int job_apply_verb(Job *job, JobVerb verb, Error **errp) 96a50c2ab8SKevin Wolf { 97a50c2ab8SKevin Wolf JobStatus s0 = job->status; 98a50c2ab8SKevin Wolf assert(verb >= 0 && verb <= JOB_VERB__MAX); 99a50c2ab8SKevin Wolf trace_job_apply_verb(job, JobStatus_str(s0), JobVerb_str(verb), 100a50c2ab8SKevin Wolf JobVerbTable[verb][s0] ? "allowed" : "prohibited"); 101a50c2ab8SKevin Wolf if (JobVerbTable[verb][s0]) { 102a50c2ab8SKevin Wolf return 0; 103a50c2ab8SKevin Wolf } 104a50c2ab8SKevin Wolf error_setg(errp, "Job '%s' in state '%s' cannot accept command verb '%s'", 105a50c2ab8SKevin Wolf job->id, JobStatus_str(s0), JobVerb_str(verb)); 106a50c2ab8SKevin Wolf return -EPERM; 107a50c2ab8SKevin Wolf } 108a50c2ab8SKevin Wolf 109252291eaSKevin Wolf JobType job_type(const Job *job) 110252291eaSKevin Wolf { 111252291eaSKevin Wolf return job->driver->job_type; 112252291eaSKevin Wolf } 113252291eaSKevin Wolf 114252291eaSKevin Wolf const char *job_type_str(const Job *job) 115252291eaSKevin Wolf { 116252291eaSKevin Wolf return JobType_str(job_type(job)); 117252291eaSKevin Wolf } 118252291eaSKevin Wolf 119daa7f2f9SKevin Wolf bool job_is_cancelled(Job *job) 120daa7f2f9SKevin Wolf { 121daa7f2f9SKevin Wolf return job->cancelled; 122daa7f2f9SKevin Wolf } 123daa7f2f9SKevin Wolf 124dbe5e6c1SKevin Wolf bool job_is_completed(Job *job) 125dbe5e6c1SKevin Wolf { 126dbe5e6c1SKevin Wolf switch (job->status) { 127dbe5e6c1SKevin Wolf case JOB_STATUS_UNDEFINED: 128dbe5e6c1SKevin Wolf case JOB_STATUS_CREATED: 129dbe5e6c1SKevin Wolf case JOB_STATUS_RUNNING: 130dbe5e6c1SKevin Wolf case JOB_STATUS_PAUSED: 131dbe5e6c1SKevin Wolf case JOB_STATUS_READY: 132dbe5e6c1SKevin Wolf case JOB_STATUS_STANDBY: 133dbe5e6c1SKevin Wolf return false; 134dbe5e6c1SKevin Wolf case JOB_STATUS_WAITING: 135dbe5e6c1SKevin Wolf case JOB_STATUS_PENDING: 136dbe5e6c1SKevin Wolf case JOB_STATUS_ABORTING: 137dbe5e6c1SKevin Wolf case JOB_STATUS_CONCLUDED: 138dbe5e6c1SKevin Wolf case JOB_STATUS_NULL: 139dbe5e6c1SKevin Wolf return true; 140dbe5e6c1SKevin Wolf default: 141dbe5e6c1SKevin Wolf g_assert_not_reached(); 142dbe5e6c1SKevin Wolf } 143dbe5e6c1SKevin Wolf return false; 144dbe5e6c1SKevin Wolf } 145dbe5e6c1SKevin Wolf 146da01ff7fSKevin Wolf bool job_started(Job *job) 147da01ff7fSKevin Wolf { 148da01ff7fSKevin Wolf return job->co; 149da01ff7fSKevin Wolf } 150da01ff7fSKevin Wolf 151da01ff7fSKevin Wolf bool job_should_pause(Job *job) 152da01ff7fSKevin Wolf { 153da01ff7fSKevin Wolf return job->pause_count > 0; 154da01ff7fSKevin Wolf } 155da01ff7fSKevin Wolf 156e7c1d78bSKevin Wolf Job *job_next(Job *job) 157e7c1d78bSKevin Wolf { 158e7c1d78bSKevin Wolf if (!job) { 159e7c1d78bSKevin Wolf return QLIST_FIRST(&jobs); 160e7c1d78bSKevin Wolf } 161e7c1d78bSKevin Wolf return QLIST_NEXT(job, job_list); 162e7c1d78bSKevin Wolf } 163e7c1d78bSKevin Wolf 164e7c1d78bSKevin Wolf Job *job_get(const char *id) 165e7c1d78bSKevin Wolf { 166e7c1d78bSKevin Wolf Job *job; 167e7c1d78bSKevin Wolf 168e7c1d78bSKevin Wolf QLIST_FOREACH(job, &jobs, job_list) { 169e7c1d78bSKevin Wolf if (job->id && !strcmp(id, job->id)) { 170e7c1d78bSKevin Wolf return job; 171e7c1d78bSKevin Wolf } 172e7c1d78bSKevin Wolf } 173e7c1d78bSKevin Wolf 174e7c1d78bSKevin Wolf return NULL; 175e7c1d78bSKevin Wolf } 176e7c1d78bSKevin Wolf 1775d43e86eSKevin Wolf static void job_sleep_timer_cb(void *opaque) 1785d43e86eSKevin Wolf { 1795d43e86eSKevin Wolf Job *job = opaque; 1805d43e86eSKevin Wolf 1815d43e86eSKevin Wolf job_enter(job); 1825d43e86eSKevin Wolf } 1835d43e86eSKevin Wolf 18408be6fe2SKevin Wolf void *job_create(const char *job_id, const JobDriver *driver, AioContext *ctx, 1854ad35181SKevin Wolf int flags, BlockCompletionFunc *cb, void *opaque, Error **errp) 18633e9e9bdSKevin Wolf { 18733e9e9bdSKevin Wolf Job *job; 18833e9e9bdSKevin Wolf 18933e9e9bdSKevin Wolf if (job_id) { 190bb02b65cSKevin Wolf if (flags & JOB_INTERNAL) { 191bb02b65cSKevin Wolf error_setg(errp, "Cannot specify job ID for internal job"); 192bb02b65cSKevin Wolf return NULL; 193bb02b65cSKevin Wolf } 19433e9e9bdSKevin Wolf if (!id_wellformed(job_id)) { 19533e9e9bdSKevin Wolf error_setg(errp, "Invalid job ID '%s'", job_id); 19633e9e9bdSKevin Wolf return NULL; 19733e9e9bdSKevin Wolf } 198e7c1d78bSKevin Wolf if (job_get(job_id)) { 199e7c1d78bSKevin Wolf error_setg(errp, "Job ID '%s' already in use", job_id); 200e7c1d78bSKevin Wolf return NULL; 201e7c1d78bSKevin Wolf } 202bb02b65cSKevin Wolf } else if (!(flags & JOB_INTERNAL)) { 203bb02b65cSKevin Wolf error_setg(errp, "An explicit job ID is required"); 204bb02b65cSKevin Wolf return NULL; 20533e9e9bdSKevin Wolf } 20633e9e9bdSKevin Wolf 20733e9e9bdSKevin Wolf job = g_malloc0(driver->instance_size); 20833e9e9bdSKevin Wolf job->driver = driver; 20933e9e9bdSKevin Wolf job->id = g_strdup(job_id); 21080fa2c75SKevin Wolf job->refcnt = 1; 21108be6fe2SKevin Wolf job->aio_context = ctx; 212da01ff7fSKevin Wolf job->busy = false; 213da01ff7fSKevin Wolf job->paused = true; 214da01ff7fSKevin Wolf job->pause_count = 1; 215bb02b65cSKevin Wolf job->auto_finalize = !(flags & JOB_MANUAL_FINALIZE); 216bb02b65cSKevin Wolf job->auto_dismiss = !(flags & JOB_MANUAL_DISMISS); 2174ad35181SKevin Wolf job->cb = cb; 2184ad35181SKevin Wolf job->opaque = opaque; 21933e9e9bdSKevin Wolf 220139a9f02SKevin Wolf notifier_list_init(&job->on_finalize_cancelled); 221139a9f02SKevin Wolf notifier_list_init(&job->on_finalize_completed); 222139a9f02SKevin Wolf notifier_list_init(&job->on_pending); 223139a9f02SKevin Wolf 224a50c2ab8SKevin Wolf job_state_transition(job, JOB_STATUS_CREATED); 2255d43e86eSKevin Wolf aio_timer_init(qemu_get_aio_context(), &job->sleep_timer, 2265d43e86eSKevin Wolf QEMU_CLOCK_REALTIME, SCALE_NS, 2275d43e86eSKevin Wolf job_sleep_timer_cb, job); 228a50c2ab8SKevin Wolf 229e7c1d78bSKevin Wolf QLIST_INSERT_HEAD(&jobs, job, job_list); 230e7c1d78bSKevin Wolf 23133e9e9bdSKevin Wolf return job; 23233e9e9bdSKevin Wolf } 233fd61a701SKevin Wolf 23480fa2c75SKevin Wolf void job_ref(Job *job) 235fd61a701SKevin Wolf { 23680fa2c75SKevin Wolf ++job->refcnt; 23780fa2c75SKevin Wolf } 23880fa2c75SKevin Wolf 23980fa2c75SKevin Wolf void job_unref(Job *job) 24080fa2c75SKevin Wolf { 24180fa2c75SKevin Wolf if (--job->refcnt == 0) { 24280fa2c75SKevin Wolf assert(job->status == JOB_STATUS_NULL); 2435d43e86eSKevin Wolf assert(!timer_pending(&job->sleep_timer)); 24480fa2c75SKevin Wolf 24580fa2c75SKevin Wolf if (job->driver->free) { 24680fa2c75SKevin Wolf job->driver->free(job); 24780fa2c75SKevin Wolf } 24880fa2c75SKevin Wolf 249e7c1d78bSKevin Wolf QLIST_REMOVE(job, job_list); 250e7c1d78bSKevin Wolf 251fd61a701SKevin Wolf g_free(job->id); 252fd61a701SKevin Wolf g_free(job); 253fd61a701SKevin Wolf } 25480fa2c75SKevin Wolf } 2551908a559SKevin Wolf 256139a9f02SKevin Wolf void job_event_cancelled(Job *job) 257139a9f02SKevin Wolf { 258139a9f02SKevin Wolf notifier_list_notify(&job->on_finalize_cancelled, job); 259139a9f02SKevin Wolf } 260139a9f02SKevin Wolf 261139a9f02SKevin Wolf void job_event_completed(Job *job) 262139a9f02SKevin Wolf { 263139a9f02SKevin Wolf notifier_list_notify(&job->on_finalize_completed, job); 264139a9f02SKevin Wolf } 265139a9f02SKevin Wolf 266139a9f02SKevin Wolf void job_event_pending(Job *job) 267139a9f02SKevin Wolf { 268139a9f02SKevin Wolf notifier_list_notify(&job->on_pending, job); 269139a9f02SKevin Wolf } 270139a9f02SKevin Wolf 271da01ff7fSKevin Wolf void job_enter_cond(Job *job, bool(*fn)(Job *job)) 272da01ff7fSKevin Wolf { 273da01ff7fSKevin Wolf if (!job_started(job)) { 274da01ff7fSKevin Wolf return; 275da01ff7fSKevin Wolf } 276da01ff7fSKevin Wolf if (job->deferred_to_main_loop) { 277da01ff7fSKevin Wolf return; 278da01ff7fSKevin Wolf } 279da01ff7fSKevin Wolf 280da01ff7fSKevin Wolf job_lock(); 281da01ff7fSKevin Wolf if (job->busy) { 282da01ff7fSKevin Wolf job_unlock(); 283da01ff7fSKevin Wolf return; 284da01ff7fSKevin Wolf } 285da01ff7fSKevin Wolf 286da01ff7fSKevin Wolf if (fn && !fn(job)) { 287da01ff7fSKevin Wolf job_unlock(); 288da01ff7fSKevin Wolf return; 289da01ff7fSKevin Wolf } 290da01ff7fSKevin Wolf 291da01ff7fSKevin Wolf assert(!job->deferred_to_main_loop); 292da01ff7fSKevin Wolf timer_del(&job->sleep_timer); 293da01ff7fSKevin Wolf job->busy = true; 294da01ff7fSKevin Wolf job_unlock(); 295da01ff7fSKevin Wolf aio_co_wake(job->co); 296da01ff7fSKevin Wolf } 297da01ff7fSKevin Wolf 2985d43e86eSKevin Wolf void job_enter(Job *job) 2995d43e86eSKevin Wolf { 3005d43e86eSKevin Wolf job_enter_cond(job, NULL); 3015d43e86eSKevin Wolf } 3025d43e86eSKevin Wolf 303da01ff7fSKevin Wolf /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds. 304da01ff7fSKevin Wolf * Reentering the job coroutine with block_job_enter() before the timer has 305da01ff7fSKevin Wolf * expired is allowed and cancels the timer. 306da01ff7fSKevin Wolf * 307da01ff7fSKevin Wolf * If @ns is (uint64_t) -1, no timer is scheduled and block_job_enter() must be 308da01ff7fSKevin Wolf * called explicitly. */ 309da01ff7fSKevin Wolf void coroutine_fn job_do_yield(Job *job, uint64_t ns) 310da01ff7fSKevin Wolf { 311da01ff7fSKevin Wolf job_lock(); 312da01ff7fSKevin Wolf if (ns != -1) { 313da01ff7fSKevin Wolf timer_mod(&job->sleep_timer, ns); 314da01ff7fSKevin Wolf } 315da01ff7fSKevin Wolf job->busy = false; 316da01ff7fSKevin Wolf job_unlock(); 317da01ff7fSKevin Wolf qemu_coroutine_yield(); 318da01ff7fSKevin Wolf 319da01ff7fSKevin Wolf /* Set by job_enter_cond() before re-entering the coroutine. */ 320da01ff7fSKevin Wolf assert(job->busy); 321da01ff7fSKevin Wolf } 322da01ff7fSKevin Wolf 323da01ff7fSKevin Wolf void coroutine_fn job_pause_point(Job *job) 324da01ff7fSKevin Wolf { 325da01ff7fSKevin Wolf assert(job && job_started(job)); 326da01ff7fSKevin Wolf 327da01ff7fSKevin Wolf if (!job_should_pause(job)) { 328da01ff7fSKevin Wolf return; 329da01ff7fSKevin Wolf } 330da01ff7fSKevin Wolf if (job_is_cancelled(job)) { 331da01ff7fSKevin Wolf return; 332da01ff7fSKevin Wolf } 333da01ff7fSKevin Wolf 334da01ff7fSKevin Wolf if (job->driver->pause) { 335da01ff7fSKevin Wolf job->driver->pause(job); 336da01ff7fSKevin Wolf } 337da01ff7fSKevin Wolf 338da01ff7fSKevin Wolf if (job_should_pause(job) && !job_is_cancelled(job)) { 339da01ff7fSKevin Wolf JobStatus status = job->status; 340da01ff7fSKevin Wolf job_state_transition(job, status == JOB_STATUS_READY 341da01ff7fSKevin Wolf ? JOB_STATUS_STANDBY 342da01ff7fSKevin Wolf : JOB_STATUS_PAUSED); 343da01ff7fSKevin Wolf job->paused = true; 344da01ff7fSKevin Wolf job_do_yield(job, -1); 345da01ff7fSKevin Wolf job->paused = false; 346da01ff7fSKevin Wolf job_state_transition(job, status); 347da01ff7fSKevin Wolf } 348da01ff7fSKevin Wolf 349da01ff7fSKevin Wolf if (job->driver->resume) { 350da01ff7fSKevin Wolf job->driver->resume(job); 351da01ff7fSKevin Wolf } 352da01ff7fSKevin Wolf } 353da01ff7fSKevin Wolf 3545d43e86eSKevin Wolf void coroutine_fn job_sleep_ns(Job *job, int64_t ns) 3555d43e86eSKevin Wolf { 3565d43e86eSKevin Wolf assert(job->busy); 3575d43e86eSKevin Wolf 3585d43e86eSKevin Wolf /* Check cancellation *before* setting busy = false, too! */ 3595d43e86eSKevin Wolf if (job_is_cancelled(job)) { 3605d43e86eSKevin Wolf return; 3615d43e86eSKevin Wolf } 3625d43e86eSKevin Wolf 3635d43e86eSKevin Wolf if (!job_should_pause(job)) { 3645d43e86eSKevin Wolf job_do_yield(job, qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + ns); 3655d43e86eSKevin Wolf } 3665d43e86eSKevin Wolf 3675d43e86eSKevin Wolf job_pause_point(job); 3685d43e86eSKevin Wolf } 3695d43e86eSKevin Wolf 370b69f777dSKevin Wolf void job_drain(Job *job) 371b69f777dSKevin Wolf { 372b69f777dSKevin Wolf /* If job is !busy this kicks it into the next pause point. */ 373b69f777dSKevin Wolf job_enter(job); 374b69f777dSKevin Wolf 375b69f777dSKevin Wolf if (job->driver->drain) { 376b69f777dSKevin Wolf job->driver->drain(job); 377b69f777dSKevin Wolf } 378b69f777dSKevin Wolf } 379b69f777dSKevin Wolf 380b69f777dSKevin Wolf 381da01ff7fSKevin Wolf /** 382da01ff7fSKevin Wolf * All jobs must allow a pause point before entering their job proper. This 383da01ff7fSKevin Wolf * ensures that jobs can be paused prior to being started, then resumed later. 384da01ff7fSKevin Wolf */ 385da01ff7fSKevin Wolf static void coroutine_fn job_co_entry(void *opaque) 386da01ff7fSKevin Wolf { 387da01ff7fSKevin Wolf Job *job = opaque; 388da01ff7fSKevin Wolf 389da01ff7fSKevin Wolf assert(job && job->driver && job->driver->start); 390da01ff7fSKevin Wolf job_pause_point(job); 391da01ff7fSKevin Wolf job->driver->start(job); 392da01ff7fSKevin Wolf } 393da01ff7fSKevin Wolf 394da01ff7fSKevin Wolf 395da01ff7fSKevin Wolf void job_start(Job *job) 396da01ff7fSKevin Wolf { 397da01ff7fSKevin Wolf assert(job && !job_started(job) && job->paused && 398da01ff7fSKevin Wolf job->driver && job->driver->start); 399da01ff7fSKevin Wolf job->co = qemu_coroutine_create(job_co_entry, job); 400da01ff7fSKevin Wolf job->pause_count--; 401da01ff7fSKevin Wolf job->busy = true; 402da01ff7fSKevin Wolf job->paused = false; 403da01ff7fSKevin Wolf job_state_transition(job, JOB_STATUS_RUNNING); 404da01ff7fSKevin Wolf aio_co_enter(job->aio_context, job->co); 405da01ff7fSKevin Wolf } 406da01ff7fSKevin Wolf 407b15de828SKevin Wolf /* Assumes the block_job_mutex is held */ 408b15de828SKevin Wolf static bool job_timer_not_pending(Job *job) 409b15de828SKevin Wolf { 410b15de828SKevin Wolf return !timer_pending(&job->sleep_timer); 411b15de828SKevin Wolf } 412b15de828SKevin Wolf 413b15de828SKevin Wolf void job_pause(Job *job) 414b15de828SKevin Wolf { 415b15de828SKevin Wolf job->pause_count++; 416b15de828SKevin Wolf } 417b15de828SKevin Wolf 418b15de828SKevin Wolf void job_resume(Job *job) 419b15de828SKevin Wolf { 420b15de828SKevin Wolf assert(job->pause_count > 0); 421b15de828SKevin Wolf job->pause_count--; 422b15de828SKevin Wolf if (job->pause_count) { 423b15de828SKevin Wolf return; 424b15de828SKevin Wolf } 425b15de828SKevin Wolf 426b15de828SKevin Wolf /* kick only if no timer is pending */ 427b15de828SKevin Wolf job_enter_cond(job, job_timer_not_pending); 428b15de828SKevin Wolf } 429b15de828SKevin Wolf 430b15de828SKevin Wolf void job_user_pause(Job *job, Error **errp) 431b15de828SKevin Wolf { 432b15de828SKevin Wolf if (job_apply_verb(job, JOB_VERB_PAUSE, errp)) { 433b15de828SKevin Wolf return; 434b15de828SKevin Wolf } 435b15de828SKevin Wolf if (job->user_paused) { 436b15de828SKevin Wolf error_setg(errp, "Job is already paused"); 437b15de828SKevin Wolf return; 438b15de828SKevin Wolf } 439b15de828SKevin Wolf job->user_paused = true; 440b15de828SKevin Wolf job_pause(job); 441b15de828SKevin Wolf } 442b15de828SKevin Wolf 443b15de828SKevin Wolf bool job_user_paused(Job *job) 444b15de828SKevin Wolf { 445b15de828SKevin Wolf return job->user_paused; 446b15de828SKevin Wolf } 447b15de828SKevin Wolf 448b15de828SKevin Wolf void job_user_resume(Job *job, Error **errp) 449b15de828SKevin Wolf { 450b15de828SKevin Wolf assert(job); 451b15de828SKevin Wolf if (!job->user_paused || job->pause_count <= 0) { 452b15de828SKevin Wolf error_setg(errp, "Can't resume a job that was not paused"); 453b15de828SKevin Wolf return; 454b15de828SKevin Wolf } 455b15de828SKevin Wolf if (job_apply_verb(job, JOB_VERB_RESUME, errp)) { 456b15de828SKevin Wolf return; 457b15de828SKevin Wolf } 458b15de828SKevin Wolf if (job->driver->user_resume) { 459b15de828SKevin Wolf job->driver->user_resume(job); 460b15de828SKevin Wolf } 461b15de828SKevin Wolf job->user_paused = false; 462b15de828SKevin Wolf job_resume(job); 463b15de828SKevin Wolf } 464b15de828SKevin Wolf 4654ad35181SKevin Wolf void job_do_dismiss(Job *job) 4664ad35181SKevin Wolf { 4674ad35181SKevin Wolf assert(job); 4684ad35181SKevin Wolf job->busy = false; 4694ad35181SKevin Wolf job->paused = false; 4704ad35181SKevin Wolf job->deferred_to_main_loop = true; 4714ad35181SKevin Wolf 4724ad35181SKevin Wolf /* TODO Don't assume it's a BlockJob */ 4734ad35181SKevin Wolf block_job_txn_del_job((BlockJob*) job); 4744ad35181SKevin Wolf 4754ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_NULL); 4764ad35181SKevin Wolf job_unref(job); 4774ad35181SKevin Wolf } 4784ad35181SKevin Wolf 4794ad35181SKevin Wolf void job_early_fail(Job *job) 4804ad35181SKevin Wolf { 4814ad35181SKevin Wolf assert(job->status == JOB_STATUS_CREATED); 4824ad35181SKevin Wolf job_do_dismiss(job); 4834ad35181SKevin Wolf } 4844ad35181SKevin Wolf 4854ad35181SKevin Wolf static void job_conclude(Job *job) 4864ad35181SKevin Wolf { 4874ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_CONCLUDED); 4884ad35181SKevin Wolf if (job->auto_dismiss || !job_started(job)) { 4894ad35181SKevin Wolf job_do_dismiss(job); 4904ad35181SKevin Wolf } 4914ad35181SKevin Wolf } 4924ad35181SKevin Wolf 4934ad35181SKevin Wolf void job_update_rc(Job *job) 4944ad35181SKevin Wolf { 4954ad35181SKevin Wolf if (!job->ret && job_is_cancelled(job)) { 4964ad35181SKevin Wolf job->ret = -ECANCELED; 4974ad35181SKevin Wolf } 4984ad35181SKevin Wolf if (job->ret) { 4994ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_ABORTING); 5004ad35181SKevin Wolf } 5014ad35181SKevin Wolf } 5024ad35181SKevin Wolf 5034ad35181SKevin Wolf static void job_commit(Job *job) 5044ad35181SKevin Wolf { 5054ad35181SKevin Wolf assert(!job->ret); 5064ad35181SKevin Wolf if (job->driver->commit) { 5074ad35181SKevin Wolf job->driver->commit(job); 5084ad35181SKevin Wolf } 5094ad35181SKevin Wolf } 5104ad35181SKevin Wolf 5114ad35181SKevin Wolf static void job_abort(Job *job) 5124ad35181SKevin Wolf { 5134ad35181SKevin Wolf assert(job->ret); 5144ad35181SKevin Wolf if (job->driver->abort) { 5154ad35181SKevin Wolf job->driver->abort(job); 5164ad35181SKevin Wolf } 5174ad35181SKevin Wolf } 5184ad35181SKevin Wolf 5194ad35181SKevin Wolf static void job_clean(Job *job) 5204ad35181SKevin Wolf { 5214ad35181SKevin Wolf if (job->driver->clean) { 5224ad35181SKevin Wolf job->driver->clean(job); 5234ad35181SKevin Wolf } 5244ad35181SKevin Wolf } 5254ad35181SKevin Wolf 5264ad35181SKevin Wolf int job_finalize_single(Job *job) 5274ad35181SKevin Wolf { 5284ad35181SKevin Wolf assert(job_is_completed(job)); 5294ad35181SKevin Wolf 5304ad35181SKevin Wolf /* Ensure abort is called for late-transactional failures */ 5314ad35181SKevin Wolf job_update_rc(job); 5324ad35181SKevin Wolf 5334ad35181SKevin Wolf if (!job->ret) { 5344ad35181SKevin Wolf job_commit(job); 5354ad35181SKevin Wolf } else { 5364ad35181SKevin Wolf job_abort(job); 5374ad35181SKevin Wolf } 5384ad35181SKevin Wolf job_clean(job); 5394ad35181SKevin Wolf 5404ad35181SKevin Wolf if (job->cb) { 5414ad35181SKevin Wolf job->cb(job->opaque, job->ret); 5424ad35181SKevin Wolf } 5434ad35181SKevin Wolf 5444ad35181SKevin Wolf /* Emit events only if we actually started */ 5454ad35181SKevin Wolf if (job_started(job)) { 5464ad35181SKevin Wolf if (job_is_cancelled(job)) { 5474ad35181SKevin Wolf job_event_cancelled(job); 5484ad35181SKevin Wolf } else { 5494ad35181SKevin Wolf job_event_completed(job); 5504ad35181SKevin Wolf } 5514ad35181SKevin Wolf } 5524ad35181SKevin Wolf 5534ad35181SKevin Wolf /* TODO Don't assume it's a BlockJob */ 5544ad35181SKevin Wolf block_job_txn_del_job((BlockJob*) job); 5554ad35181SKevin Wolf job_conclude(job); 5564ad35181SKevin Wolf return 0; 5574ad35181SKevin Wolf } 5584ad35181SKevin Wolf 5593453d972SKevin Wolf void job_complete(Job *job, Error **errp) 5603453d972SKevin Wolf { 5613453d972SKevin Wolf /* Should not be reachable via external interface for internal jobs */ 5623453d972SKevin Wolf assert(job->id); 5633453d972SKevin Wolf if (job_apply_verb(job, JOB_VERB_COMPLETE, errp)) { 5643453d972SKevin Wolf return; 5653453d972SKevin Wolf } 5663453d972SKevin Wolf if (job->pause_count || job_is_cancelled(job) || !job->driver->complete) { 5673453d972SKevin Wolf error_setg(errp, "The active block job '%s' cannot be completed", 5683453d972SKevin Wolf job->id); 5693453d972SKevin Wolf return; 5703453d972SKevin Wolf } 5713453d972SKevin Wolf 5723453d972SKevin Wolf job->driver->complete(job, errp); 5733453d972SKevin Wolf } 5743453d972SKevin Wolf 575b15de828SKevin Wolf 5761908a559SKevin Wolf typedef struct { 5771908a559SKevin Wolf Job *job; 5781908a559SKevin Wolf JobDeferToMainLoopFn *fn; 5791908a559SKevin Wolf void *opaque; 5801908a559SKevin Wolf } JobDeferToMainLoopData; 5811908a559SKevin Wolf 5821908a559SKevin Wolf static void job_defer_to_main_loop_bh(void *opaque) 5831908a559SKevin Wolf { 5841908a559SKevin Wolf JobDeferToMainLoopData *data = opaque; 5851908a559SKevin Wolf Job *job = data->job; 5861908a559SKevin Wolf AioContext *aio_context = job->aio_context; 5871908a559SKevin Wolf 5881908a559SKevin Wolf aio_context_acquire(aio_context); 5891908a559SKevin Wolf data->fn(data->job, data->opaque); 5901908a559SKevin Wolf aio_context_release(aio_context); 5911908a559SKevin Wolf 5921908a559SKevin Wolf g_free(data); 5931908a559SKevin Wolf } 5941908a559SKevin Wolf 5951908a559SKevin Wolf void job_defer_to_main_loop(Job *job, JobDeferToMainLoopFn *fn, void *opaque) 5961908a559SKevin Wolf { 5971908a559SKevin Wolf JobDeferToMainLoopData *data = g_malloc(sizeof(*data)); 5981908a559SKevin Wolf data->job = job; 5991908a559SKevin Wolf data->fn = fn; 6001908a559SKevin Wolf data->opaque = opaque; 6011908a559SKevin Wolf job->deferred_to_main_loop = true; 6021908a559SKevin Wolf 6031908a559SKevin Wolf aio_bh_schedule_oneshot(qemu_get_aio_context(), 6041908a559SKevin Wolf job_defer_to_main_loop_bh, data); 6051908a559SKevin Wolf } 606*6a74c075SKevin Wolf 607*6a74c075SKevin Wolf int job_finish_sync(Job *job, void (*finish)(Job *, Error **errp), Error **errp) 608*6a74c075SKevin Wolf { 609*6a74c075SKevin Wolf Error *local_err = NULL; 610*6a74c075SKevin Wolf int ret; 611*6a74c075SKevin Wolf 612*6a74c075SKevin Wolf job_ref(job); 613*6a74c075SKevin Wolf 614*6a74c075SKevin Wolf if (finish) { 615*6a74c075SKevin Wolf finish(job, &local_err); 616*6a74c075SKevin Wolf } 617*6a74c075SKevin Wolf if (local_err) { 618*6a74c075SKevin Wolf error_propagate(errp, local_err); 619*6a74c075SKevin Wolf job_unref(job); 620*6a74c075SKevin Wolf return -EBUSY; 621*6a74c075SKevin Wolf } 622*6a74c075SKevin Wolf /* job_drain calls job_enter, and it should be enough to induce progress 623*6a74c075SKevin Wolf * until the job completes or moves to the main thread. */ 624*6a74c075SKevin Wolf while (!job->deferred_to_main_loop && !job_is_completed(job)) { 625*6a74c075SKevin Wolf job_drain(job); 626*6a74c075SKevin Wolf } 627*6a74c075SKevin Wolf while (!job_is_completed(job)) { 628*6a74c075SKevin Wolf aio_poll(qemu_get_aio_context(), true); 629*6a74c075SKevin Wolf } 630*6a74c075SKevin Wolf ret = (job_is_cancelled(job) && job->ret == 0) ? -ECANCELED : job->ret; 631*6a74c075SKevin Wolf job_unref(job); 632*6a74c075SKevin Wolf return ret; 633*6a74c075SKevin Wolf } 634