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 637eaa8fb5SKevin Wolf /* Transactional group of jobs */ 647eaa8fb5SKevin Wolf struct JobTxn { 657eaa8fb5SKevin Wolf 667eaa8fb5SKevin Wolf /* Is this txn being cancelled? */ 677eaa8fb5SKevin Wolf bool aborting; 687eaa8fb5SKevin Wolf 697eaa8fb5SKevin Wolf /* List of jobs */ 707eaa8fb5SKevin Wolf QLIST_HEAD(, Job) jobs; 717eaa8fb5SKevin Wolf 727eaa8fb5SKevin Wolf /* Reference count */ 737eaa8fb5SKevin Wolf int refcnt; 747eaa8fb5SKevin Wolf }; 757eaa8fb5SKevin Wolf 76da01ff7fSKevin Wolf /* Right now, this mutex is only needed to synchronize accesses to job->busy 77da01ff7fSKevin Wolf * and job->sleep_timer, such as concurrent calls to job_do_yield and 78da01ff7fSKevin Wolf * job_enter. */ 79da01ff7fSKevin Wolf static QemuMutex job_mutex; 80da01ff7fSKevin Wolf 81da01ff7fSKevin Wolf static void job_lock(void) 82da01ff7fSKevin Wolf { 83da01ff7fSKevin Wolf qemu_mutex_lock(&job_mutex); 84da01ff7fSKevin Wolf } 85da01ff7fSKevin Wolf 86da01ff7fSKevin Wolf static void job_unlock(void) 87da01ff7fSKevin Wolf { 88da01ff7fSKevin Wolf qemu_mutex_unlock(&job_mutex); 89da01ff7fSKevin Wolf } 90da01ff7fSKevin Wolf 91da01ff7fSKevin Wolf static void __attribute__((__constructor__)) job_init(void) 92da01ff7fSKevin Wolf { 93da01ff7fSKevin Wolf qemu_mutex_init(&job_mutex); 94da01ff7fSKevin Wolf } 95da01ff7fSKevin Wolf 967eaa8fb5SKevin Wolf JobTxn *job_txn_new(void) 977eaa8fb5SKevin Wolf { 987eaa8fb5SKevin Wolf JobTxn *txn = g_new0(JobTxn, 1); 997eaa8fb5SKevin Wolf QLIST_INIT(&txn->jobs); 1007eaa8fb5SKevin Wolf txn->refcnt = 1; 1017eaa8fb5SKevin Wolf return txn; 1027eaa8fb5SKevin Wolf } 1037eaa8fb5SKevin Wolf 1047eaa8fb5SKevin Wolf static void job_txn_ref(JobTxn *txn) 1057eaa8fb5SKevin Wolf { 1067eaa8fb5SKevin Wolf txn->refcnt++; 1077eaa8fb5SKevin Wolf } 1087eaa8fb5SKevin Wolf 1097eaa8fb5SKevin Wolf void job_txn_unref(JobTxn *txn) 1107eaa8fb5SKevin Wolf { 1117eaa8fb5SKevin Wolf if (txn && --txn->refcnt == 0) { 1127eaa8fb5SKevin Wolf g_free(txn); 1137eaa8fb5SKevin Wolf } 1147eaa8fb5SKevin Wolf } 1157eaa8fb5SKevin Wolf 1167eaa8fb5SKevin Wolf void job_txn_add_job(JobTxn *txn, Job *job) 1177eaa8fb5SKevin Wolf { 1187eaa8fb5SKevin Wolf if (!txn) { 1197eaa8fb5SKevin Wolf return; 1207eaa8fb5SKevin Wolf } 1217eaa8fb5SKevin Wolf 1227eaa8fb5SKevin Wolf assert(!job->txn); 1237eaa8fb5SKevin Wolf job->txn = txn; 1247eaa8fb5SKevin Wolf 1257eaa8fb5SKevin Wolf QLIST_INSERT_HEAD(&txn->jobs, job, txn_list); 1267eaa8fb5SKevin Wolf job_txn_ref(txn); 1277eaa8fb5SKevin Wolf } 1287eaa8fb5SKevin Wolf 1297eaa8fb5SKevin Wolf static void job_txn_del_job(Job *job) 1307eaa8fb5SKevin Wolf { 1317eaa8fb5SKevin Wolf if (job->txn) { 1327eaa8fb5SKevin Wolf QLIST_REMOVE(job, txn_list); 1337eaa8fb5SKevin Wolf job_txn_unref(job->txn); 1347eaa8fb5SKevin Wolf job->txn = NULL; 1357eaa8fb5SKevin Wolf } 1367eaa8fb5SKevin Wolf } 1377eaa8fb5SKevin Wolf 1387eaa8fb5SKevin Wolf static int job_txn_apply(JobTxn *txn, int fn(Job *), bool lock) 1397eaa8fb5SKevin Wolf { 1407eaa8fb5SKevin Wolf AioContext *ctx; 1417eaa8fb5SKevin Wolf Job *job, *next; 1427eaa8fb5SKevin Wolf int rc = 0; 1437eaa8fb5SKevin Wolf 1447eaa8fb5SKevin Wolf QLIST_FOREACH_SAFE(job, &txn->jobs, txn_list, next) { 1457eaa8fb5SKevin Wolf if (lock) { 1467eaa8fb5SKevin Wolf ctx = job->aio_context; 1477eaa8fb5SKevin Wolf aio_context_acquire(ctx); 1487eaa8fb5SKevin Wolf } 1497eaa8fb5SKevin Wolf rc = fn(job); 1507eaa8fb5SKevin Wolf if (lock) { 1517eaa8fb5SKevin Wolf aio_context_release(ctx); 1527eaa8fb5SKevin Wolf } 1537eaa8fb5SKevin Wolf if (rc) { 1547eaa8fb5SKevin Wolf break; 1557eaa8fb5SKevin Wolf } 1567eaa8fb5SKevin Wolf } 1577eaa8fb5SKevin Wolf return rc; 1587eaa8fb5SKevin Wolf } 1597eaa8fb5SKevin Wolf 1607eaa8fb5SKevin Wolf 161a50c2ab8SKevin Wolf /* TODO Make static once the whole state machine is in job.c */ 162a50c2ab8SKevin Wolf void job_state_transition(Job *job, JobStatus s1) 163a50c2ab8SKevin Wolf { 164a50c2ab8SKevin Wolf JobStatus s0 = job->status; 165a50c2ab8SKevin Wolf assert(s1 >= 0 && s1 <= JOB_STATUS__MAX); 1664ad35181SKevin Wolf trace_job_state_transition(job, job->ret, 167a50c2ab8SKevin Wolf JobSTT[s0][s1] ? "allowed" : "disallowed", 168a50c2ab8SKevin Wolf JobStatus_str(s0), JobStatus_str(s1)); 169a50c2ab8SKevin Wolf assert(JobSTT[s0][s1]); 170a50c2ab8SKevin Wolf job->status = s1; 171a50c2ab8SKevin Wolf } 172a50c2ab8SKevin Wolf 173a50c2ab8SKevin Wolf int job_apply_verb(Job *job, JobVerb verb, Error **errp) 174a50c2ab8SKevin Wolf { 175a50c2ab8SKevin Wolf JobStatus s0 = job->status; 176a50c2ab8SKevin Wolf assert(verb >= 0 && verb <= JOB_VERB__MAX); 177a50c2ab8SKevin Wolf trace_job_apply_verb(job, JobStatus_str(s0), JobVerb_str(verb), 178a50c2ab8SKevin Wolf JobVerbTable[verb][s0] ? "allowed" : "prohibited"); 179a50c2ab8SKevin Wolf if (JobVerbTable[verb][s0]) { 180a50c2ab8SKevin Wolf return 0; 181a50c2ab8SKevin Wolf } 182a50c2ab8SKevin Wolf error_setg(errp, "Job '%s' in state '%s' cannot accept command verb '%s'", 183a50c2ab8SKevin Wolf job->id, JobStatus_str(s0), JobVerb_str(verb)); 184a50c2ab8SKevin Wolf return -EPERM; 185a50c2ab8SKevin Wolf } 186a50c2ab8SKevin Wolf 187252291eaSKevin Wolf JobType job_type(const Job *job) 188252291eaSKevin Wolf { 189252291eaSKevin Wolf return job->driver->job_type; 190252291eaSKevin Wolf } 191252291eaSKevin Wolf 192252291eaSKevin Wolf const char *job_type_str(const Job *job) 193252291eaSKevin Wolf { 194252291eaSKevin Wolf return JobType_str(job_type(job)); 195252291eaSKevin Wolf } 196252291eaSKevin Wolf 197daa7f2f9SKevin Wolf bool job_is_cancelled(Job *job) 198daa7f2f9SKevin Wolf { 199daa7f2f9SKevin Wolf return job->cancelled; 200daa7f2f9SKevin Wolf } 201daa7f2f9SKevin Wolf 202dbe5e6c1SKevin Wolf bool job_is_completed(Job *job) 203dbe5e6c1SKevin Wolf { 204dbe5e6c1SKevin Wolf switch (job->status) { 205dbe5e6c1SKevin Wolf case JOB_STATUS_UNDEFINED: 206dbe5e6c1SKevin Wolf case JOB_STATUS_CREATED: 207dbe5e6c1SKevin Wolf case JOB_STATUS_RUNNING: 208dbe5e6c1SKevin Wolf case JOB_STATUS_PAUSED: 209dbe5e6c1SKevin Wolf case JOB_STATUS_READY: 210dbe5e6c1SKevin Wolf case JOB_STATUS_STANDBY: 211dbe5e6c1SKevin Wolf return false; 212dbe5e6c1SKevin Wolf case JOB_STATUS_WAITING: 213dbe5e6c1SKevin Wolf case JOB_STATUS_PENDING: 214dbe5e6c1SKevin Wolf case JOB_STATUS_ABORTING: 215dbe5e6c1SKevin Wolf case JOB_STATUS_CONCLUDED: 216dbe5e6c1SKevin Wolf case JOB_STATUS_NULL: 217dbe5e6c1SKevin Wolf return true; 218dbe5e6c1SKevin Wolf default: 219dbe5e6c1SKevin Wolf g_assert_not_reached(); 220dbe5e6c1SKevin Wolf } 221dbe5e6c1SKevin Wolf return false; 222dbe5e6c1SKevin Wolf } 223dbe5e6c1SKevin Wolf 224*3d70ff53SKevin Wolf static bool job_started(Job *job) 225da01ff7fSKevin Wolf { 226da01ff7fSKevin Wolf return job->co; 227da01ff7fSKevin Wolf } 228da01ff7fSKevin Wolf 229da01ff7fSKevin Wolf bool job_should_pause(Job *job) 230da01ff7fSKevin Wolf { 231da01ff7fSKevin Wolf return job->pause_count > 0; 232da01ff7fSKevin Wolf } 233da01ff7fSKevin Wolf 234e7c1d78bSKevin Wolf Job *job_next(Job *job) 235e7c1d78bSKevin Wolf { 236e7c1d78bSKevin Wolf if (!job) { 237e7c1d78bSKevin Wolf return QLIST_FIRST(&jobs); 238e7c1d78bSKevin Wolf } 239e7c1d78bSKevin Wolf return QLIST_NEXT(job, job_list); 240e7c1d78bSKevin Wolf } 241e7c1d78bSKevin Wolf 242e7c1d78bSKevin Wolf Job *job_get(const char *id) 243e7c1d78bSKevin Wolf { 244e7c1d78bSKevin Wolf Job *job; 245e7c1d78bSKevin Wolf 246e7c1d78bSKevin Wolf QLIST_FOREACH(job, &jobs, job_list) { 247e7c1d78bSKevin Wolf if (job->id && !strcmp(id, job->id)) { 248e7c1d78bSKevin Wolf return job; 249e7c1d78bSKevin Wolf } 250e7c1d78bSKevin Wolf } 251e7c1d78bSKevin Wolf 252e7c1d78bSKevin Wolf return NULL; 253e7c1d78bSKevin Wolf } 254e7c1d78bSKevin Wolf 2555d43e86eSKevin Wolf static void job_sleep_timer_cb(void *opaque) 2565d43e86eSKevin Wolf { 2575d43e86eSKevin Wolf Job *job = opaque; 2585d43e86eSKevin Wolf 2595d43e86eSKevin Wolf job_enter(job); 2605d43e86eSKevin Wolf } 2615d43e86eSKevin Wolf 2627eaa8fb5SKevin Wolf void *job_create(const char *job_id, const JobDriver *driver, JobTxn *txn, 2637eaa8fb5SKevin Wolf AioContext *ctx, int flags, BlockCompletionFunc *cb, 2647eaa8fb5SKevin Wolf void *opaque, Error **errp) 26533e9e9bdSKevin Wolf { 26633e9e9bdSKevin Wolf Job *job; 26733e9e9bdSKevin Wolf 26833e9e9bdSKevin Wolf if (job_id) { 269bb02b65cSKevin Wolf if (flags & JOB_INTERNAL) { 270bb02b65cSKevin Wolf error_setg(errp, "Cannot specify job ID for internal job"); 271bb02b65cSKevin Wolf return NULL; 272bb02b65cSKevin Wolf } 27333e9e9bdSKevin Wolf if (!id_wellformed(job_id)) { 27433e9e9bdSKevin Wolf error_setg(errp, "Invalid job ID '%s'", job_id); 27533e9e9bdSKevin Wolf return NULL; 27633e9e9bdSKevin Wolf } 277e7c1d78bSKevin Wolf if (job_get(job_id)) { 278e7c1d78bSKevin Wolf error_setg(errp, "Job ID '%s' already in use", job_id); 279e7c1d78bSKevin Wolf return NULL; 280e7c1d78bSKevin Wolf } 281bb02b65cSKevin Wolf } else if (!(flags & JOB_INTERNAL)) { 282bb02b65cSKevin Wolf error_setg(errp, "An explicit job ID is required"); 283bb02b65cSKevin Wolf return NULL; 28433e9e9bdSKevin Wolf } 28533e9e9bdSKevin Wolf 28633e9e9bdSKevin Wolf job = g_malloc0(driver->instance_size); 28733e9e9bdSKevin Wolf job->driver = driver; 28833e9e9bdSKevin Wolf job->id = g_strdup(job_id); 28980fa2c75SKevin Wolf job->refcnt = 1; 29008be6fe2SKevin Wolf job->aio_context = ctx; 291da01ff7fSKevin Wolf job->busy = false; 292da01ff7fSKevin Wolf job->paused = true; 293da01ff7fSKevin Wolf job->pause_count = 1; 294bb02b65cSKevin Wolf job->auto_finalize = !(flags & JOB_MANUAL_FINALIZE); 295bb02b65cSKevin Wolf job->auto_dismiss = !(flags & JOB_MANUAL_DISMISS); 2964ad35181SKevin Wolf job->cb = cb; 2974ad35181SKevin Wolf job->opaque = opaque; 29833e9e9bdSKevin Wolf 299139a9f02SKevin Wolf notifier_list_init(&job->on_finalize_cancelled); 300139a9f02SKevin Wolf notifier_list_init(&job->on_finalize_completed); 301139a9f02SKevin Wolf notifier_list_init(&job->on_pending); 302139a9f02SKevin Wolf 303a50c2ab8SKevin Wolf job_state_transition(job, JOB_STATUS_CREATED); 3045d43e86eSKevin Wolf aio_timer_init(qemu_get_aio_context(), &job->sleep_timer, 3055d43e86eSKevin Wolf QEMU_CLOCK_REALTIME, SCALE_NS, 3065d43e86eSKevin Wolf job_sleep_timer_cb, job); 307a50c2ab8SKevin Wolf 308e7c1d78bSKevin Wolf QLIST_INSERT_HEAD(&jobs, job, job_list); 309e7c1d78bSKevin Wolf 3107eaa8fb5SKevin Wolf /* Single jobs are modeled as single-job transactions for sake of 3117eaa8fb5SKevin Wolf * consolidating the job management logic */ 3127eaa8fb5SKevin Wolf if (!txn) { 3137eaa8fb5SKevin Wolf txn = job_txn_new(); 3147eaa8fb5SKevin Wolf job_txn_add_job(txn, job); 3157eaa8fb5SKevin Wolf job_txn_unref(txn); 3167eaa8fb5SKevin Wolf } else { 3177eaa8fb5SKevin Wolf job_txn_add_job(txn, job); 3187eaa8fb5SKevin Wolf } 3197eaa8fb5SKevin Wolf 32033e9e9bdSKevin Wolf return job; 32133e9e9bdSKevin Wolf } 322fd61a701SKevin Wolf 32380fa2c75SKevin Wolf void job_ref(Job *job) 324fd61a701SKevin Wolf { 32580fa2c75SKevin Wolf ++job->refcnt; 32680fa2c75SKevin Wolf } 32780fa2c75SKevin Wolf 32880fa2c75SKevin Wolf void job_unref(Job *job) 32980fa2c75SKevin Wolf { 33080fa2c75SKevin Wolf if (--job->refcnt == 0) { 33180fa2c75SKevin Wolf assert(job->status == JOB_STATUS_NULL); 3325d43e86eSKevin Wolf assert(!timer_pending(&job->sleep_timer)); 3337eaa8fb5SKevin Wolf assert(!job->txn); 33480fa2c75SKevin Wolf 33580fa2c75SKevin Wolf if (job->driver->free) { 33680fa2c75SKevin Wolf job->driver->free(job); 33780fa2c75SKevin Wolf } 33880fa2c75SKevin Wolf 339e7c1d78bSKevin Wolf QLIST_REMOVE(job, job_list); 340e7c1d78bSKevin Wolf 341fd61a701SKevin Wolf g_free(job->id); 342fd61a701SKevin Wolf g_free(job); 343fd61a701SKevin Wolf } 34480fa2c75SKevin Wolf } 3451908a559SKevin Wolf 346139a9f02SKevin Wolf void job_event_cancelled(Job *job) 347139a9f02SKevin Wolf { 348139a9f02SKevin Wolf notifier_list_notify(&job->on_finalize_cancelled, job); 349139a9f02SKevin Wolf } 350139a9f02SKevin Wolf 351139a9f02SKevin Wolf void job_event_completed(Job *job) 352139a9f02SKevin Wolf { 353139a9f02SKevin Wolf notifier_list_notify(&job->on_finalize_completed, job); 354139a9f02SKevin Wolf } 355139a9f02SKevin Wolf 3567eaa8fb5SKevin Wolf static void job_event_pending(Job *job) 357139a9f02SKevin Wolf { 358139a9f02SKevin Wolf notifier_list_notify(&job->on_pending, job); 359139a9f02SKevin Wolf } 360139a9f02SKevin Wolf 361da01ff7fSKevin Wolf void job_enter_cond(Job *job, bool(*fn)(Job *job)) 362da01ff7fSKevin Wolf { 363da01ff7fSKevin Wolf if (!job_started(job)) { 364da01ff7fSKevin Wolf return; 365da01ff7fSKevin Wolf } 366da01ff7fSKevin Wolf if (job->deferred_to_main_loop) { 367da01ff7fSKevin Wolf return; 368da01ff7fSKevin Wolf } 369da01ff7fSKevin Wolf 370da01ff7fSKevin Wolf job_lock(); 371da01ff7fSKevin Wolf if (job->busy) { 372da01ff7fSKevin Wolf job_unlock(); 373da01ff7fSKevin Wolf return; 374da01ff7fSKevin Wolf } 375da01ff7fSKevin Wolf 376da01ff7fSKevin Wolf if (fn && !fn(job)) { 377da01ff7fSKevin Wolf job_unlock(); 378da01ff7fSKevin Wolf return; 379da01ff7fSKevin Wolf } 380da01ff7fSKevin Wolf 381da01ff7fSKevin Wolf assert(!job->deferred_to_main_loop); 382da01ff7fSKevin Wolf timer_del(&job->sleep_timer); 383da01ff7fSKevin Wolf job->busy = true; 384da01ff7fSKevin Wolf job_unlock(); 385da01ff7fSKevin Wolf aio_co_wake(job->co); 386da01ff7fSKevin Wolf } 387da01ff7fSKevin Wolf 3885d43e86eSKevin Wolf void job_enter(Job *job) 3895d43e86eSKevin Wolf { 3905d43e86eSKevin Wolf job_enter_cond(job, NULL); 3915d43e86eSKevin Wolf } 3925d43e86eSKevin Wolf 393da01ff7fSKevin Wolf /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds. 394*3d70ff53SKevin Wolf * Reentering the job coroutine with job_enter() before the timer has expired 395*3d70ff53SKevin Wolf * is allowed and cancels the timer. 396da01ff7fSKevin Wolf * 397*3d70ff53SKevin Wolf * If @ns is (uint64_t) -1, no timer is scheduled and job_enter() must be 398da01ff7fSKevin Wolf * called explicitly. */ 399da01ff7fSKevin Wolf void coroutine_fn job_do_yield(Job *job, uint64_t ns) 400da01ff7fSKevin Wolf { 401da01ff7fSKevin Wolf job_lock(); 402da01ff7fSKevin Wolf if (ns != -1) { 403da01ff7fSKevin Wolf timer_mod(&job->sleep_timer, ns); 404da01ff7fSKevin Wolf } 405da01ff7fSKevin Wolf job->busy = false; 406da01ff7fSKevin Wolf job_unlock(); 407da01ff7fSKevin Wolf qemu_coroutine_yield(); 408da01ff7fSKevin Wolf 409da01ff7fSKevin Wolf /* Set by job_enter_cond() before re-entering the coroutine. */ 410da01ff7fSKevin Wolf assert(job->busy); 411da01ff7fSKevin Wolf } 412da01ff7fSKevin Wolf 413da01ff7fSKevin Wolf void coroutine_fn job_pause_point(Job *job) 414da01ff7fSKevin Wolf { 415da01ff7fSKevin Wolf assert(job && job_started(job)); 416da01ff7fSKevin Wolf 417da01ff7fSKevin Wolf if (!job_should_pause(job)) { 418da01ff7fSKevin Wolf return; 419da01ff7fSKevin Wolf } 420da01ff7fSKevin Wolf if (job_is_cancelled(job)) { 421da01ff7fSKevin Wolf return; 422da01ff7fSKevin Wolf } 423da01ff7fSKevin Wolf 424da01ff7fSKevin Wolf if (job->driver->pause) { 425da01ff7fSKevin Wolf job->driver->pause(job); 426da01ff7fSKevin Wolf } 427da01ff7fSKevin Wolf 428da01ff7fSKevin Wolf if (job_should_pause(job) && !job_is_cancelled(job)) { 429da01ff7fSKevin Wolf JobStatus status = job->status; 430da01ff7fSKevin Wolf job_state_transition(job, status == JOB_STATUS_READY 431da01ff7fSKevin Wolf ? JOB_STATUS_STANDBY 432da01ff7fSKevin Wolf : JOB_STATUS_PAUSED); 433da01ff7fSKevin Wolf job->paused = true; 434da01ff7fSKevin Wolf job_do_yield(job, -1); 435da01ff7fSKevin Wolf job->paused = false; 436da01ff7fSKevin Wolf job_state_transition(job, status); 437da01ff7fSKevin Wolf } 438da01ff7fSKevin Wolf 439da01ff7fSKevin Wolf if (job->driver->resume) { 440da01ff7fSKevin Wolf job->driver->resume(job); 441da01ff7fSKevin Wolf } 442da01ff7fSKevin Wolf } 443da01ff7fSKevin Wolf 4445d43e86eSKevin Wolf void coroutine_fn job_sleep_ns(Job *job, int64_t ns) 4455d43e86eSKevin Wolf { 4465d43e86eSKevin Wolf assert(job->busy); 4475d43e86eSKevin Wolf 4485d43e86eSKevin Wolf /* Check cancellation *before* setting busy = false, too! */ 4495d43e86eSKevin Wolf if (job_is_cancelled(job)) { 4505d43e86eSKevin Wolf return; 4515d43e86eSKevin Wolf } 4525d43e86eSKevin Wolf 4535d43e86eSKevin Wolf if (!job_should_pause(job)) { 4545d43e86eSKevin Wolf job_do_yield(job, qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + ns); 4555d43e86eSKevin Wolf } 4565d43e86eSKevin Wolf 4575d43e86eSKevin Wolf job_pause_point(job); 4585d43e86eSKevin Wolf } 4595d43e86eSKevin Wolf 460b69f777dSKevin Wolf void job_drain(Job *job) 461b69f777dSKevin Wolf { 462b69f777dSKevin Wolf /* If job is !busy this kicks it into the next pause point. */ 463b69f777dSKevin Wolf job_enter(job); 464b69f777dSKevin Wolf 465b69f777dSKevin Wolf if (job->driver->drain) { 466b69f777dSKevin Wolf job->driver->drain(job); 467b69f777dSKevin Wolf } 468b69f777dSKevin Wolf } 469b69f777dSKevin Wolf 470b69f777dSKevin Wolf 471da01ff7fSKevin Wolf /** 472da01ff7fSKevin Wolf * All jobs must allow a pause point before entering their job proper. This 473da01ff7fSKevin Wolf * ensures that jobs can be paused prior to being started, then resumed later. 474da01ff7fSKevin Wolf */ 475da01ff7fSKevin Wolf static void coroutine_fn job_co_entry(void *opaque) 476da01ff7fSKevin Wolf { 477da01ff7fSKevin Wolf Job *job = opaque; 478da01ff7fSKevin Wolf 479da01ff7fSKevin Wolf assert(job && job->driver && job->driver->start); 480da01ff7fSKevin Wolf job_pause_point(job); 481da01ff7fSKevin Wolf job->driver->start(job); 482da01ff7fSKevin Wolf } 483da01ff7fSKevin Wolf 484da01ff7fSKevin Wolf 485da01ff7fSKevin Wolf void job_start(Job *job) 486da01ff7fSKevin Wolf { 487da01ff7fSKevin Wolf assert(job && !job_started(job) && job->paused && 488da01ff7fSKevin Wolf job->driver && job->driver->start); 489da01ff7fSKevin Wolf job->co = qemu_coroutine_create(job_co_entry, job); 490da01ff7fSKevin Wolf job->pause_count--; 491da01ff7fSKevin Wolf job->busy = true; 492da01ff7fSKevin Wolf job->paused = false; 493da01ff7fSKevin Wolf job_state_transition(job, JOB_STATUS_RUNNING); 494da01ff7fSKevin Wolf aio_co_enter(job->aio_context, job->co); 495da01ff7fSKevin Wolf } 496da01ff7fSKevin Wolf 497b15de828SKevin Wolf /* Assumes the block_job_mutex is held */ 498b15de828SKevin Wolf static bool job_timer_not_pending(Job *job) 499b15de828SKevin Wolf { 500b15de828SKevin Wolf return !timer_pending(&job->sleep_timer); 501b15de828SKevin Wolf } 502b15de828SKevin Wolf 503b15de828SKevin Wolf void job_pause(Job *job) 504b15de828SKevin Wolf { 505b15de828SKevin Wolf job->pause_count++; 506b15de828SKevin Wolf } 507b15de828SKevin Wolf 508b15de828SKevin Wolf void job_resume(Job *job) 509b15de828SKevin Wolf { 510b15de828SKevin Wolf assert(job->pause_count > 0); 511b15de828SKevin Wolf job->pause_count--; 512b15de828SKevin Wolf if (job->pause_count) { 513b15de828SKevin Wolf return; 514b15de828SKevin Wolf } 515b15de828SKevin Wolf 516b15de828SKevin Wolf /* kick only if no timer is pending */ 517b15de828SKevin Wolf job_enter_cond(job, job_timer_not_pending); 518b15de828SKevin Wolf } 519b15de828SKevin Wolf 520b15de828SKevin Wolf void job_user_pause(Job *job, Error **errp) 521b15de828SKevin Wolf { 522b15de828SKevin Wolf if (job_apply_verb(job, JOB_VERB_PAUSE, errp)) { 523b15de828SKevin Wolf return; 524b15de828SKevin Wolf } 525b15de828SKevin Wolf if (job->user_paused) { 526b15de828SKevin Wolf error_setg(errp, "Job is already paused"); 527b15de828SKevin Wolf return; 528b15de828SKevin Wolf } 529b15de828SKevin Wolf job->user_paused = true; 530b15de828SKevin Wolf job_pause(job); 531b15de828SKevin Wolf } 532b15de828SKevin Wolf 533b15de828SKevin Wolf bool job_user_paused(Job *job) 534b15de828SKevin Wolf { 535b15de828SKevin Wolf return job->user_paused; 536b15de828SKevin Wolf } 537b15de828SKevin Wolf 538b15de828SKevin Wolf void job_user_resume(Job *job, Error **errp) 539b15de828SKevin Wolf { 540b15de828SKevin Wolf assert(job); 541b15de828SKevin Wolf if (!job->user_paused || job->pause_count <= 0) { 542b15de828SKevin Wolf error_setg(errp, "Can't resume a job that was not paused"); 543b15de828SKevin Wolf return; 544b15de828SKevin Wolf } 545b15de828SKevin Wolf if (job_apply_verb(job, JOB_VERB_RESUME, errp)) { 546b15de828SKevin Wolf return; 547b15de828SKevin Wolf } 548b15de828SKevin Wolf if (job->driver->user_resume) { 549b15de828SKevin Wolf job->driver->user_resume(job); 550b15de828SKevin Wolf } 551b15de828SKevin Wolf job->user_paused = false; 552b15de828SKevin Wolf job_resume(job); 553b15de828SKevin Wolf } 554b15de828SKevin Wolf 5554ad35181SKevin Wolf void job_do_dismiss(Job *job) 5564ad35181SKevin Wolf { 5574ad35181SKevin Wolf assert(job); 5584ad35181SKevin Wolf job->busy = false; 5594ad35181SKevin Wolf job->paused = false; 5604ad35181SKevin Wolf job->deferred_to_main_loop = true; 5614ad35181SKevin Wolf 5627eaa8fb5SKevin Wolf job_txn_del_job(job); 5634ad35181SKevin Wolf 5644ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_NULL); 5654ad35181SKevin Wolf job_unref(job); 5664ad35181SKevin Wolf } 5674ad35181SKevin Wolf 5684ad35181SKevin Wolf void job_early_fail(Job *job) 5694ad35181SKevin Wolf { 5704ad35181SKevin Wolf assert(job->status == JOB_STATUS_CREATED); 5714ad35181SKevin Wolf job_do_dismiss(job); 5724ad35181SKevin Wolf } 5734ad35181SKevin Wolf 5744ad35181SKevin Wolf static void job_conclude(Job *job) 5754ad35181SKevin Wolf { 5764ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_CONCLUDED); 5774ad35181SKevin Wolf if (job->auto_dismiss || !job_started(job)) { 5784ad35181SKevin Wolf job_do_dismiss(job); 5794ad35181SKevin Wolf } 5804ad35181SKevin Wolf } 5814ad35181SKevin Wolf 582*3d70ff53SKevin Wolf static void job_update_rc(Job *job) 5834ad35181SKevin Wolf { 5844ad35181SKevin Wolf if (!job->ret && job_is_cancelled(job)) { 5854ad35181SKevin Wolf job->ret = -ECANCELED; 5864ad35181SKevin Wolf } 5874ad35181SKevin Wolf if (job->ret) { 5884ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_ABORTING); 5894ad35181SKevin Wolf } 5904ad35181SKevin Wolf } 5914ad35181SKevin Wolf 5924ad35181SKevin Wolf static void job_commit(Job *job) 5934ad35181SKevin Wolf { 5944ad35181SKevin Wolf assert(!job->ret); 5954ad35181SKevin Wolf if (job->driver->commit) { 5964ad35181SKevin Wolf job->driver->commit(job); 5974ad35181SKevin Wolf } 5984ad35181SKevin Wolf } 5994ad35181SKevin Wolf 6004ad35181SKevin Wolf static void job_abort(Job *job) 6014ad35181SKevin Wolf { 6024ad35181SKevin Wolf assert(job->ret); 6034ad35181SKevin Wolf if (job->driver->abort) { 6044ad35181SKevin Wolf job->driver->abort(job); 6054ad35181SKevin Wolf } 6064ad35181SKevin Wolf } 6074ad35181SKevin Wolf 6084ad35181SKevin Wolf static void job_clean(Job *job) 6094ad35181SKevin Wolf { 6104ad35181SKevin Wolf if (job->driver->clean) { 6114ad35181SKevin Wolf job->driver->clean(job); 6124ad35181SKevin Wolf } 6134ad35181SKevin Wolf } 6144ad35181SKevin Wolf 6157eaa8fb5SKevin Wolf static int job_finalize_single(Job *job) 6164ad35181SKevin Wolf { 6174ad35181SKevin Wolf assert(job_is_completed(job)); 6184ad35181SKevin Wolf 6194ad35181SKevin Wolf /* Ensure abort is called for late-transactional failures */ 6204ad35181SKevin Wolf job_update_rc(job); 6214ad35181SKevin Wolf 6224ad35181SKevin Wolf if (!job->ret) { 6234ad35181SKevin Wolf job_commit(job); 6244ad35181SKevin Wolf } else { 6254ad35181SKevin Wolf job_abort(job); 6264ad35181SKevin Wolf } 6274ad35181SKevin Wolf job_clean(job); 6284ad35181SKevin Wolf 6294ad35181SKevin Wolf if (job->cb) { 6304ad35181SKevin Wolf job->cb(job->opaque, job->ret); 6314ad35181SKevin Wolf } 6324ad35181SKevin Wolf 6334ad35181SKevin Wolf /* Emit events only if we actually started */ 6344ad35181SKevin Wolf if (job_started(job)) { 6354ad35181SKevin Wolf if (job_is_cancelled(job)) { 6364ad35181SKevin Wolf job_event_cancelled(job); 6374ad35181SKevin Wolf } else { 6384ad35181SKevin Wolf job_event_completed(job); 6394ad35181SKevin Wolf } 6404ad35181SKevin Wolf } 6414ad35181SKevin Wolf 6427eaa8fb5SKevin Wolf job_txn_del_job(job); 6434ad35181SKevin Wolf job_conclude(job); 6444ad35181SKevin Wolf return 0; 6454ad35181SKevin Wolf } 6464ad35181SKevin Wolf 647*3d70ff53SKevin Wolf static void job_cancel_async(Job *job, bool force) 6487eaa8fb5SKevin Wolf { 6497eaa8fb5SKevin Wolf if (job->user_paused) { 6507eaa8fb5SKevin Wolf /* Do not call job_enter here, the caller will handle it. */ 6517eaa8fb5SKevin Wolf job->user_paused = false; 6527eaa8fb5SKevin Wolf if (job->driver->user_resume) { 6537eaa8fb5SKevin Wolf job->driver->user_resume(job); 6547eaa8fb5SKevin Wolf } 6557eaa8fb5SKevin Wolf assert(job->pause_count > 0); 6567eaa8fb5SKevin Wolf job->pause_count--; 6577eaa8fb5SKevin Wolf } 6587eaa8fb5SKevin Wolf job->cancelled = true; 6597eaa8fb5SKevin Wolf /* To prevent 'force == false' overriding a previous 'force == true' */ 6607eaa8fb5SKevin Wolf job->force_cancel |= force; 6617eaa8fb5SKevin Wolf } 6627eaa8fb5SKevin Wolf 663*3d70ff53SKevin Wolf static void job_completed_txn_abort(Job *job) 6647eaa8fb5SKevin Wolf { 6657eaa8fb5SKevin Wolf AioContext *ctx; 6667eaa8fb5SKevin Wolf JobTxn *txn = job->txn; 6677eaa8fb5SKevin Wolf Job *other_job; 6687eaa8fb5SKevin Wolf 6697eaa8fb5SKevin Wolf if (txn->aborting) { 6707eaa8fb5SKevin Wolf /* 6717eaa8fb5SKevin Wolf * We are cancelled by another job, which will handle everything. 6727eaa8fb5SKevin Wolf */ 6737eaa8fb5SKevin Wolf return; 6747eaa8fb5SKevin Wolf } 6757eaa8fb5SKevin Wolf txn->aborting = true; 6767eaa8fb5SKevin Wolf job_txn_ref(txn); 6777eaa8fb5SKevin Wolf 6787eaa8fb5SKevin Wolf /* We are the first failed job. Cancel other jobs. */ 6797eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 6807eaa8fb5SKevin Wolf ctx = other_job->aio_context; 6817eaa8fb5SKevin Wolf aio_context_acquire(ctx); 6827eaa8fb5SKevin Wolf } 6837eaa8fb5SKevin Wolf 6847eaa8fb5SKevin Wolf /* Other jobs are effectively cancelled by us, set the status for 6857eaa8fb5SKevin Wolf * them; this job, however, may or may not be cancelled, depending 6867eaa8fb5SKevin Wolf * on the caller, so leave it. */ 6877eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 6887eaa8fb5SKevin Wolf if (other_job != job) { 6897eaa8fb5SKevin Wolf job_cancel_async(other_job, false); 6907eaa8fb5SKevin Wolf } 6917eaa8fb5SKevin Wolf } 6927eaa8fb5SKevin Wolf while (!QLIST_EMPTY(&txn->jobs)) { 6937eaa8fb5SKevin Wolf other_job = QLIST_FIRST(&txn->jobs); 6947eaa8fb5SKevin Wolf ctx = other_job->aio_context; 6957eaa8fb5SKevin Wolf if (!job_is_completed(other_job)) { 6967eaa8fb5SKevin Wolf assert(job_is_cancelled(other_job)); 6977eaa8fb5SKevin Wolf job_finish_sync(other_job, NULL, NULL); 6987eaa8fb5SKevin Wolf } 6997eaa8fb5SKevin Wolf job_finalize_single(other_job); 7007eaa8fb5SKevin Wolf aio_context_release(ctx); 7017eaa8fb5SKevin Wolf } 7027eaa8fb5SKevin Wolf 7037eaa8fb5SKevin Wolf job_txn_unref(txn); 7047eaa8fb5SKevin Wolf } 7057eaa8fb5SKevin Wolf 7067eaa8fb5SKevin Wolf static int job_prepare(Job *job) 7077eaa8fb5SKevin Wolf { 7087eaa8fb5SKevin Wolf if (job->ret == 0 && job->driver->prepare) { 7097eaa8fb5SKevin Wolf job->ret = job->driver->prepare(job); 7107eaa8fb5SKevin Wolf } 7117eaa8fb5SKevin Wolf return job->ret; 7127eaa8fb5SKevin Wolf } 7137eaa8fb5SKevin Wolf 7147eaa8fb5SKevin Wolf static int job_needs_finalize(Job *job) 7157eaa8fb5SKevin Wolf { 7167eaa8fb5SKevin Wolf return !job->auto_finalize; 7177eaa8fb5SKevin Wolf } 7187eaa8fb5SKevin Wolf 7197eaa8fb5SKevin Wolf static void job_do_finalize(Job *job) 7207eaa8fb5SKevin Wolf { 7217eaa8fb5SKevin Wolf int rc; 7227eaa8fb5SKevin Wolf assert(job && job->txn); 7237eaa8fb5SKevin Wolf 7247eaa8fb5SKevin Wolf /* prepare the transaction to complete */ 7257eaa8fb5SKevin Wolf rc = job_txn_apply(job->txn, job_prepare, true); 7267eaa8fb5SKevin Wolf if (rc) { 7277eaa8fb5SKevin Wolf job_completed_txn_abort(job); 7287eaa8fb5SKevin Wolf } else { 7297eaa8fb5SKevin Wolf job_txn_apply(job->txn, job_finalize_single, true); 7307eaa8fb5SKevin Wolf } 7317eaa8fb5SKevin Wolf } 7327eaa8fb5SKevin Wolf 7337eaa8fb5SKevin Wolf void job_finalize(Job *job, Error **errp) 7347eaa8fb5SKevin Wolf { 7357eaa8fb5SKevin Wolf assert(job && job->id); 7367eaa8fb5SKevin Wolf if (job_apply_verb(job, JOB_VERB_FINALIZE, errp)) { 7377eaa8fb5SKevin Wolf return; 7387eaa8fb5SKevin Wolf } 7397eaa8fb5SKevin Wolf job_do_finalize(job); 7407eaa8fb5SKevin Wolf } 7417eaa8fb5SKevin Wolf 7427eaa8fb5SKevin Wolf static int job_transition_to_pending(Job *job) 7437eaa8fb5SKevin Wolf { 7447eaa8fb5SKevin Wolf job_state_transition(job, JOB_STATUS_PENDING); 7457eaa8fb5SKevin Wolf if (!job->auto_finalize) { 7467eaa8fb5SKevin Wolf job_event_pending(job); 7477eaa8fb5SKevin Wolf } 7487eaa8fb5SKevin Wolf return 0; 7497eaa8fb5SKevin Wolf } 7507eaa8fb5SKevin Wolf 751*3d70ff53SKevin Wolf static void job_completed_txn_success(Job *job) 7527eaa8fb5SKevin Wolf { 7537eaa8fb5SKevin Wolf JobTxn *txn = job->txn; 7547eaa8fb5SKevin Wolf Job *other_job; 7557eaa8fb5SKevin Wolf 7567eaa8fb5SKevin Wolf job_state_transition(job, JOB_STATUS_WAITING); 7577eaa8fb5SKevin Wolf 7587eaa8fb5SKevin Wolf /* 7597eaa8fb5SKevin Wolf * Successful completion, see if there are other running jobs in this 7607eaa8fb5SKevin Wolf * txn. 7617eaa8fb5SKevin Wolf */ 7627eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 7637eaa8fb5SKevin Wolf if (!job_is_completed(other_job)) { 7647eaa8fb5SKevin Wolf return; 7657eaa8fb5SKevin Wolf } 7667eaa8fb5SKevin Wolf assert(other_job->ret == 0); 7677eaa8fb5SKevin Wolf } 7687eaa8fb5SKevin Wolf 7697eaa8fb5SKevin Wolf job_txn_apply(txn, job_transition_to_pending, false); 7707eaa8fb5SKevin Wolf 7717eaa8fb5SKevin Wolf /* If no jobs need manual finalization, automatically do so */ 7727eaa8fb5SKevin Wolf if (job_txn_apply(txn, job_needs_finalize, false) == 0) { 7737eaa8fb5SKevin Wolf job_do_finalize(job); 7747eaa8fb5SKevin Wolf } 7757eaa8fb5SKevin Wolf } 7767eaa8fb5SKevin Wolf 777*3d70ff53SKevin Wolf void job_completed(Job *job, int ret) 778*3d70ff53SKevin Wolf { 779*3d70ff53SKevin Wolf assert(job && job->txn && !job_is_completed(job)); 780*3d70ff53SKevin Wolf job->ret = ret; 781*3d70ff53SKevin Wolf job_update_rc(job); 782*3d70ff53SKevin Wolf trace_job_completed(job, ret, job->ret); 783*3d70ff53SKevin Wolf if (job->ret) { 784*3d70ff53SKevin Wolf job_completed_txn_abort(job); 785*3d70ff53SKevin Wolf } else { 786*3d70ff53SKevin Wolf job_completed_txn_success(job); 787*3d70ff53SKevin Wolf } 788*3d70ff53SKevin Wolf } 789*3d70ff53SKevin Wolf 790*3d70ff53SKevin Wolf void job_cancel(Job *job, bool force) 791*3d70ff53SKevin Wolf { 792*3d70ff53SKevin Wolf if (job->status == JOB_STATUS_CONCLUDED) { 793*3d70ff53SKevin Wolf job_do_dismiss(job); 794*3d70ff53SKevin Wolf return; 795*3d70ff53SKevin Wolf } 796*3d70ff53SKevin Wolf job_cancel_async(job, force); 797*3d70ff53SKevin Wolf if (!job_started(job)) { 798*3d70ff53SKevin Wolf job_completed(job, -ECANCELED); 799*3d70ff53SKevin Wolf } else if (job->deferred_to_main_loop) { 800*3d70ff53SKevin Wolf job_completed_txn_abort(job); 801*3d70ff53SKevin Wolf } else { 802*3d70ff53SKevin Wolf job_enter(job); 803*3d70ff53SKevin Wolf } 804*3d70ff53SKevin Wolf } 805*3d70ff53SKevin Wolf 806*3d70ff53SKevin Wolf void job_user_cancel(Job *job, bool force, Error **errp) 807*3d70ff53SKevin Wolf { 808*3d70ff53SKevin Wolf if (job_apply_verb(job, JOB_VERB_CANCEL, errp)) { 809*3d70ff53SKevin Wolf return; 810*3d70ff53SKevin Wolf } 811*3d70ff53SKevin Wolf job_cancel(job, force); 812*3d70ff53SKevin Wolf } 813*3d70ff53SKevin Wolf 814*3d70ff53SKevin Wolf /* A wrapper around job_cancel() taking an Error ** parameter so it may be 815*3d70ff53SKevin Wolf * used with job_finish_sync() without the need for (rather nasty) function 816*3d70ff53SKevin Wolf * pointer casts there. */ 817*3d70ff53SKevin Wolf static void job_cancel_err(Job *job, Error **errp) 818*3d70ff53SKevin Wolf { 819*3d70ff53SKevin Wolf job_cancel(job, false); 820*3d70ff53SKevin Wolf } 821*3d70ff53SKevin Wolf 822*3d70ff53SKevin Wolf int job_cancel_sync(Job *job) 823*3d70ff53SKevin Wolf { 824*3d70ff53SKevin Wolf return job_finish_sync(job, &job_cancel_err, NULL); 825*3d70ff53SKevin Wolf } 826*3d70ff53SKevin Wolf 827*3d70ff53SKevin Wolf void job_cancel_sync_all(void) 828*3d70ff53SKevin Wolf { 829*3d70ff53SKevin Wolf Job *job; 830*3d70ff53SKevin Wolf AioContext *aio_context; 831*3d70ff53SKevin Wolf 832*3d70ff53SKevin Wolf while ((job = job_next(NULL))) { 833*3d70ff53SKevin Wolf aio_context = job->aio_context; 834*3d70ff53SKevin Wolf aio_context_acquire(aio_context); 835*3d70ff53SKevin Wolf job_cancel_sync(job); 836*3d70ff53SKevin Wolf aio_context_release(aio_context); 837*3d70ff53SKevin Wolf } 838*3d70ff53SKevin Wolf } 839*3d70ff53SKevin Wolf 840*3d70ff53SKevin Wolf int job_complete_sync(Job *job, Error **errp) 841*3d70ff53SKevin Wolf { 842*3d70ff53SKevin Wolf return job_finish_sync(job, job_complete, errp); 843*3d70ff53SKevin Wolf } 844*3d70ff53SKevin Wolf 8453453d972SKevin Wolf void job_complete(Job *job, Error **errp) 8463453d972SKevin Wolf { 8473453d972SKevin Wolf /* Should not be reachable via external interface for internal jobs */ 8483453d972SKevin Wolf assert(job->id); 8493453d972SKevin Wolf if (job_apply_verb(job, JOB_VERB_COMPLETE, errp)) { 8503453d972SKevin Wolf return; 8513453d972SKevin Wolf } 8523453d972SKevin Wolf if (job->pause_count || job_is_cancelled(job) || !job->driver->complete) { 8533453d972SKevin Wolf error_setg(errp, "The active block job '%s' cannot be completed", 8543453d972SKevin Wolf job->id); 8553453d972SKevin Wolf return; 8563453d972SKevin Wolf } 8573453d972SKevin Wolf 8583453d972SKevin Wolf job->driver->complete(job, errp); 8593453d972SKevin Wolf } 8603453d972SKevin Wolf 861b15de828SKevin Wolf 8621908a559SKevin Wolf typedef struct { 8631908a559SKevin Wolf Job *job; 8641908a559SKevin Wolf JobDeferToMainLoopFn *fn; 8651908a559SKevin Wolf void *opaque; 8661908a559SKevin Wolf } JobDeferToMainLoopData; 8671908a559SKevin Wolf 8681908a559SKevin Wolf static void job_defer_to_main_loop_bh(void *opaque) 8691908a559SKevin Wolf { 8701908a559SKevin Wolf JobDeferToMainLoopData *data = opaque; 8711908a559SKevin Wolf Job *job = data->job; 8721908a559SKevin Wolf AioContext *aio_context = job->aio_context; 8731908a559SKevin Wolf 8741908a559SKevin Wolf aio_context_acquire(aio_context); 8751908a559SKevin Wolf data->fn(data->job, data->opaque); 8761908a559SKevin Wolf aio_context_release(aio_context); 8771908a559SKevin Wolf 8781908a559SKevin Wolf g_free(data); 8791908a559SKevin Wolf } 8801908a559SKevin Wolf 8811908a559SKevin Wolf void job_defer_to_main_loop(Job *job, JobDeferToMainLoopFn *fn, void *opaque) 8821908a559SKevin Wolf { 8831908a559SKevin Wolf JobDeferToMainLoopData *data = g_malloc(sizeof(*data)); 8841908a559SKevin Wolf data->job = job; 8851908a559SKevin Wolf data->fn = fn; 8861908a559SKevin Wolf data->opaque = opaque; 8871908a559SKevin Wolf job->deferred_to_main_loop = true; 8881908a559SKevin Wolf 8891908a559SKevin Wolf aio_bh_schedule_oneshot(qemu_get_aio_context(), 8901908a559SKevin Wolf job_defer_to_main_loop_bh, data); 8911908a559SKevin Wolf } 8926a74c075SKevin Wolf 8936a74c075SKevin Wolf int job_finish_sync(Job *job, void (*finish)(Job *, Error **errp), Error **errp) 8946a74c075SKevin Wolf { 8956a74c075SKevin Wolf Error *local_err = NULL; 8966a74c075SKevin Wolf int ret; 8976a74c075SKevin Wolf 8986a74c075SKevin Wolf job_ref(job); 8996a74c075SKevin Wolf 9006a74c075SKevin Wolf if (finish) { 9016a74c075SKevin Wolf finish(job, &local_err); 9026a74c075SKevin Wolf } 9036a74c075SKevin Wolf if (local_err) { 9046a74c075SKevin Wolf error_propagate(errp, local_err); 9056a74c075SKevin Wolf job_unref(job); 9066a74c075SKevin Wolf return -EBUSY; 9076a74c075SKevin Wolf } 9086a74c075SKevin Wolf /* job_drain calls job_enter, and it should be enough to induce progress 9096a74c075SKevin Wolf * until the job completes or moves to the main thread. */ 9106a74c075SKevin Wolf while (!job->deferred_to_main_loop && !job_is_completed(job)) { 9116a74c075SKevin Wolf job_drain(job); 9126a74c075SKevin Wolf } 9136a74c075SKevin Wolf while (!job_is_completed(job)) { 9146a74c075SKevin Wolf aio_poll(qemu_get_aio_context(), true); 9156a74c075SKevin Wolf } 9166a74c075SKevin Wolf ret = (job_is_cancelled(job) && job->ret == 0) ? -ECANCELED : job->ret; 9176a74c075SKevin Wolf job_unref(job); 9186a74c075SKevin Wolf return ret; 9196a74c075SKevin Wolf } 920