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" 32*de0fbe64SKevin Wolf #include "block/aio-wait.h" 33a50c2ab8SKevin Wolf #include "trace-root.h" 341dac83f1SKevin Wolf #include "qapi/qapi-events-job.h" 3533e9e9bdSKevin Wolf 36e7c1d78bSKevin Wolf static QLIST_HEAD(, Job) jobs = QLIST_HEAD_INITIALIZER(jobs); 37e7c1d78bSKevin Wolf 38a50c2ab8SKevin Wolf /* Job State Transition Table */ 39a50c2ab8SKevin Wolf bool JobSTT[JOB_STATUS__MAX][JOB_STATUS__MAX] = { 40a50c2ab8SKevin Wolf /* U, C, R, P, Y, S, W, D, X, E, N */ 41a50c2ab8SKevin Wolf /* U: */ [JOB_STATUS_UNDEFINED] = {0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0}, 42a50c2ab8SKevin Wolf /* C: */ [JOB_STATUS_CREATED] = {0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 1}, 43a50c2ab8SKevin Wolf /* R: */ [JOB_STATUS_RUNNING] = {0, 0, 0, 1, 1, 0, 1, 0, 1, 0, 0}, 44a50c2ab8SKevin Wolf /* P: */ [JOB_STATUS_PAUSED] = {0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0}, 45a50c2ab8SKevin Wolf /* Y: */ [JOB_STATUS_READY] = {0, 0, 0, 0, 0, 1, 1, 0, 1, 0, 0}, 46a50c2ab8SKevin Wolf /* S: */ [JOB_STATUS_STANDBY] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0}, 47a50c2ab8SKevin Wolf /* W: */ [JOB_STATUS_WAITING] = {0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0}, 48a50c2ab8SKevin Wolf /* D: */ [JOB_STATUS_PENDING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, 49a50c2ab8SKevin Wolf /* X: */ [JOB_STATUS_ABORTING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, 50a50c2ab8SKevin Wolf /* E: */ [JOB_STATUS_CONCLUDED] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}, 51a50c2ab8SKevin Wolf /* N: */ [JOB_STATUS_NULL] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}, 52a50c2ab8SKevin Wolf }; 53a50c2ab8SKevin Wolf 54a50c2ab8SKevin Wolf bool JobVerbTable[JOB_VERB__MAX][JOB_STATUS__MAX] = { 55a50c2ab8SKevin Wolf /* U, C, R, P, Y, S, W, D, X, E, N */ 56a50c2ab8SKevin Wolf [JOB_VERB_CANCEL] = {0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0}, 57a50c2ab8SKevin Wolf [JOB_VERB_PAUSE] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 58a50c2ab8SKevin Wolf [JOB_VERB_RESUME] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 59a50c2ab8SKevin Wolf [JOB_VERB_SET_SPEED] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 60a50c2ab8SKevin Wolf [JOB_VERB_COMPLETE] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0}, 61a50c2ab8SKevin Wolf [JOB_VERB_FINALIZE] = {0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0}, 62a50c2ab8SKevin Wolf [JOB_VERB_DISMISS] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0}, 63a50c2ab8SKevin Wolf }; 64a50c2ab8SKevin Wolf 657eaa8fb5SKevin Wolf /* Transactional group of jobs */ 667eaa8fb5SKevin Wolf struct JobTxn { 677eaa8fb5SKevin Wolf 687eaa8fb5SKevin Wolf /* Is this txn being cancelled? */ 697eaa8fb5SKevin Wolf bool aborting; 707eaa8fb5SKevin Wolf 717eaa8fb5SKevin Wolf /* List of jobs */ 727eaa8fb5SKevin Wolf QLIST_HEAD(, Job) jobs; 737eaa8fb5SKevin Wolf 747eaa8fb5SKevin Wolf /* Reference count */ 757eaa8fb5SKevin Wolf int refcnt; 767eaa8fb5SKevin Wolf }; 777eaa8fb5SKevin Wolf 78da01ff7fSKevin Wolf /* Right now, this mutex is only needed to synchronize accesses to job->busy 79da01ff7fSKevin Wolf * and job->sleep_timer, such as concurrent calls to job_do_yield and 80da01ff7fSKevin Wolf * job_enter. */ 81da01ff7fSKevin Wolf static QemuMutex job_mutex; 82da01ff7fSKevin Wolf 83da01ff7fSKevin Wolf static void job_lock(void) 84da01ff7fSKevin Wolf { 85da01ff7fSKevin Wolf qemu_mutex_lock(&job_mutex); 86da01ff7fSKevin Wolf } 87da01ff7fSKevin Wolf 88da01ff7fSKevin Wolf static void job_unlock(void) 89da01ff7fSKevin Wolf { 90da01ff7fSKevin Wolf qemu_mutex_unlock(&job_mutex); 91da01ff7fSKevin Wolf } 92da01ff7fSKevin Wolf 93da01ff7fSKevin Wolf static void __attribute__((__constructor__)) job_init(void) 94da01ff7fSKevin Wolf { 95da01ff7fSKevin Wolf qemu_mutex_init(&job_mutex); 96da01ff7fSKevin Wolf } 97da01ff7fSKevin Wolf 987eaa8fb5SKevin Wolf JobTxn *job_txn_new(void) 997eaa8fb5SKevin Wolf { 1007eaa8fb5SKevin Wolf JobTxn *txn = g_new0(JobTxn, 1); 1017eaa8fb5SKevin Wolf QLIST_INIT(&txn->jobs); 1027eaa8fb5SKevin Wolf txn->refcnt = 1; 1037eaa8fb5SKevin Wolf return txn; 1047eaa8fb5SKevin Wolf } 1057eaa8fb5SKevin Wolf 1067eaa8fb5SKevin Wolf static void job_txn_ref(JobTxn *txn) 1077eaa8fb5SKevin Wolf { 1087eaa8fb5SKevin Wolf txn->refcnt++; 1097eaa8fb5SKevin Wolf } 1107eaa8fb5SKevin Wolf 1117eaa8fb5SKevin Wolf void job_txn_unref(JobTxn *txn) 1127eaa8fb5SKevin Wolf { 1137eaa8fb5SKevin Wolf if (txn && --txn->refcnt == 0) { 1147eaa8fb5SKevin Wolf g_free(txn); 1157eaa8fb5SKevin Wolf } 1167eaa8fb5SKevin Wolf } 1177eaa8fb5SKevin Wolf 1187eaa8fb5SKevin Wolf void job_txn_add_job(JobTxn *txn, Job *job) 1197eaa8fb5SKevin Wolf { 1207eaa8fb5SKevin Wolf if (!txn) { 1217eaa8fb5SKevin Wolf return; 1227eaa8fb5SKevin Wolf } 1237eaa8fb5SKevin Wolf 1247eaa8fb5SKevin Wolf assert(!job->txn); 1257eaa8fb5SKevin Wolf job->txn = txn; 1267eaa8fb5SKevin Wolf 1277eaa8fb5SKevin Wolf QLIST_INSERT_HEAD(&txn->jobs, job, txn_list); 1287eaa8fb5SKevin Wolf job_txn_ref(txn); 1297eaa8fb5SKevin Wolf } 1307eaa8fb5SKevin Wolf 1317eaa8fb5SKevin Wolf static void job_txn_del_job(Job *job) 1327eaa8fb5SKevin Wolf { 1337eaa8fb5SKevin Wolf if (job->txn) { 1347eaa8fb5SKevin Wolf QLIST_REMOVE(job, txn_list); 1357eaa8fb5SKevin Wolf job_txn_unref(job->txn); 1367eaa8fb5SKevin Wolf job->txn = NULL; 1377eaa8fb5SKevin Wolf } 1387eaa8fb5SKevin Wolf } 1397eaa8fb5SKevin Wolf 14049880165SFam Zheng static int job_txn_apply(JobTxn *txn, int fn(Job *)) 1417eaa8fb5SKevin Wolf { 1427eaa8fb5SKevin Wolf Job *job, *next; 1437eaa8fb5SKevin Wolf int rc = 0; 1447eaa8fb5SKevin Wolf 1457eaa8fb5SKevin Wolf QLIST_FOREACH_SAFE(job, &txn->jobs, txn_list, next) { 1467eaa8fb5SKevin Wolf rc = fn(job); 1477eaa8fb5SKevin Wolf if (rc) { 1487eaa8fb5SKevin Wolf break; 1497eaa8fb5SKevin Wolf } 1507eaa8fb5SKevin Wolf } 1517eaa8fb5SKevin Wolf return rc; 1527eaa8fb5SKevin Wolf } 1537eaa8fb5SKevin Wolf 154456273b0SKevin Wolf bool job_is_internal(Job *job) 1551dac83f1SKevin Wolf { 1561dac83f1SKevin Wolf return (job->id == NULL); 1571dac83f1SKevin Wolf } 1581dac83f1SKevin Wolf 1592e1795b5SKevin Wolf static void job_state_transition(Job *job, JobStatus s1) 160a50c2ab8SKevin Wolf { 161a50c2ab8SKevin Wolf JobStatus s0 = job->status; 162a50c2ab8SKevin Wolf assert(s1 >= 0 && s1 <= JOB_STATUS__MAX); 1634ad35181SKevin Wolf trace_job_state_transition(job, job->ret, 164a50c2ab8SKevin Wolf JobSTT[s0][s1] ? "allowed" : "disallowed", 165a50c2ab8SKevin Wolf JobStatus_str(s0), JobStatus_str(s1)); 166a50c2ab8SKevin Wolf assert(JobSTT[s0][s1]); 167a50c2ab8SKevin Wolf job->status = s1; 1681dac83f1SKevin Wolf 1691dac83f1SKevin Wolf if (!job_is_internal(job) && s1 != s0) { 1703ab72385SPeter Xu qapi_event_send_job_status_change(job->id, job->status); 1711dac83f1SKevin Wolf } 172a50c2ab8SKevin Wolf } 173a50c2ab8SKevin Wolf 174a50c2ab8SKevin Wolf int job_apply_verb(Job *job, JobVerb verb, Error **errp) 175a50c2ab8SKevin Wolf { 176a50c2ab8SKevin Wolf JobStatus s0 = job->status; 177a50c2ab8SKevin Wolf assert(verb >= 0 && verb <= JOB_VERB__MAX); 178a50c2ab8SKevin Wolf trace_job_apply_verb(job, JobStatus_str(s0), JobVerb_str(verb), 179a50c2ab8SKevin Wolf JobVerbTable[verb][s0] ? "allowed" : "prohibited"); 180a50c2ab8SKevin Wolf if (JobVerbTable[verb][s0]) { 181a50c2ab8SKevin Wolf return 0; 182a50c2ab8SKevin Wolf } 183a50c2ab8SKevin Wolf error_setg(errp, "Job '%s' in state '%s' cannot accept command verb '%s'", 184a50c2ab8SKevin Wolf job->id, JobStatus_str(s0), JobVerb_str(verb)); 185a50c2ab8SKevin Wolf return -EPERM; 186a50c2ab8SKevin Wolf } 187a50c2ab8SKevin Wolf 188252291eaSKevin Wolf JobType job_type(const Job *job) 189252291eaSKevin Wolf { 190252291eaSKevin Wolf return job->driver->job_type; 191252291eaSKevin Wolf } 192252291eaSKevin Wolf 193252291eaSKevin Wolf const char *job_type_str(const Job *job) 194252291eaSKevin Wolf { 195252291eaSKevin Wolf return JobType_str(job_type(job)); 196252291eaSKevin Wolf } 197252291eaSKevin Wolf 198daa7f2f9SKevin Wolf bool job_is_cancelled(Job *job) 199daa7f2f9SKevin Wolf { 200daa7f2f9SKevin Wolf return job->cancelled; 201daa7f2f9SKevin Wolf } 202daa7f2f9SKevin Wolf 203df956ae2SKevin Wolf bool job_is_ready(Job *job) 204df956ae2SKevin Wolf { 205df956ae2SKevin Wolf switch (job->status) { 206df956ae2SKevin Wolf case JOB_STATUS_UNDEFINED: 207df956ae2SKevin Wolf case JOB_STATUS_CREATED: 208df956ae2SKevin Wolf case JOB_STATUS_RUNNING: 209df956ae2SKevin Wolf case JOB_STATUS_PAUSED: 210df956ae2SKevin Wolf case JOB_STATUS_WAITING: 211df956ae2SKevin Wolf case JOB_STATUS_PENDING: 212df956ae2SKevin Wolf case JOB_STATUS_ABORTING: 213df956ae2SKevin Wolf case JOB_STATUS_CONCLUDED: 214df956ae2SKevin Wolf case JOB_STATUS_NULL: 215df956ae2SKevin Wolf return false; 216df956ae2SKevin Wolf case JOB_STATUS_READY: 217df956ae2SKevin Wolf case JOB_STATUS_STANDBY: 218df956ae2SKevin Wolf return true; 219df956ae2SKevin Wolf default: 220df956ae2SKevin Wolf g_assert_not_reached(); 221df956ae2SKevin Wolf } 222df956ae2SKevin Wolf return false; 223df956ae2SKevin Wolf } 224df956ae2SKevin Wolf 225dbe5e6c1SKevin Wolf bool job_is_completed(Job *job) 226dbe5e6c1SKevin Wolf { 227dbe5e6c1SKevin Wolf switch (job->status) { 228dbe5e6c1SKevin Wolf case JOB_STATUS_UNDEFINED: 229dbe5e6c1SKevin Wolf case JOB_STATUS_CREATED: 230dbe5e6c1SKevin Wolf case JOB_STATUS_RUNNING: 231dbe5e6c1SKevin Wolf case JOB_STATUS_PAUSED: 232dbe5e6c1SKevin Wolf case JOB_STATUS_READY: 233dbe5e6c1SKevin Wolf case JOB_STATUS_STANDBY: 234dbe5e6c1SKevin Wolf return false; 235dbe5e6c1SKevin Wolf case JOB_STATUS_WAITING: 236dbe5e6c1SKevin Wolf case JOB_STATUS_PENDING: 237dbe5e6c1SKevin Wolf case JOB_STATUS_ABORTING: 238dbe5e6c1SKevin Wolf case JOB_STATUS_CONCLUDED: 239dbe5e6c1SKevin Wolf case JOB_STATUS_NULL: 240dbe5e6c1SKevin Wolf return true; 241dbe5e6c1SKevin Wolf default: 242dbe5e6c1SKevin Wolf g_assert_not_reached(); 243dbe5e6c1SKevin Wolf } 244dbe5e6c1SKevin Wolf return false; 245dbe5e6c1SKevin Wolf } 246dbe5e6c1SKevin Wolf 2473d70ff53SKevin Wolf static bool job_started(Job *job) 248da01ff7fSKevin Wolf { 249da01ff7fSKevin Wolf return job->co; 250da01ff7fSKevin Wolf } 251da01ff7fSKevin Wolf 252198c49ccSKevin Wolf static bool job_should_pause(Job *job) 253da01ff7fSKevin Wolf { 254da01ff7fSKevin Wolf return job->pause_count > 0; 255da01ff7fSKevin Wolf } 256da01ff7fSKevin Wolf 257e7c1d78bSKevin Wolf Job *job_next(Job *job) 258e7c1d78bSKevin Wolf { 259e7c1d78bSKevin Wolf if (!job) { 260e7c1d78bSKevin Wolf return QLIST_FIRST(&jobs); 261e7c1d78bSKevin Wolf } 262e7c1d78bSKevin Wolf return QLIST_NEXT(job, job_list); 263e7c1d78bSKevin Wolf } 264e7c1d78bSKevin Wolf 265e7c1d78bSKevin Wolf Job *job_get(const char *id) 266e7c1d78bSKevin Wolf { 267e7c1d78bSKevin Wolf Job *job; 268e7c1d78bSKevin Wolf 269e7c1d78bSKevin Wolf QLIST_FOREACH(job, &jobs, job_list) { 270e7c1d78bSKevin Wolf if (job->id && !strcmp(id, job->id)) { 271e7c1d78bSKevin Wolf return job; 272e7c1d78bSKevin Wolf } 273e7c1d78bSKevin Wolf } 274e7c1d78bSKevin Wolf 275e7c1d78bSKevin Wolf return NULL; 276e7c1d78bSKevin Wolf } 277e7c1d78bSKevin Wolf 2785d43e86eSKevin Wolf static void job_sleep_timer_cb(void *opaque) 2795d43e86eSKevin Wolf { 2805d43e86eSKevin Wolf Job *job = opaque; 2815d43e86eSKevin Wolf 2825d43e86eSKevin Wolf job_enter(job); 2835d43e86eSKevin Wolf } 2845d43e86eSKevin Wolf 2857eaa8fb5SKevin Wolf void *job_create(const char *job_id, const JobDriver *driver, JobTxn *txn, 2867eaa8fb5SKevin Wolf AioContext *ctx, int flags, BlockCompletionFunc *cb, 2877eaa8fb5SKevin Wolf void *opaque, Error **errp) 28833e9e9bdSKevin Wolf { 28933e9e9bdSKevin Wolf Job *job; 29033e9e9bdSKevin Wolf 29133e9e9bdSKevin Wolf if (job_id) { 292bb02b65cSKevin Wolf if (flags & JOB_INTERNAL) { 293bb02b65cSKevin Wolf error_setg(errp, "Cannot specify job ID for internal job"); 294bb02b65cSKevin Wolf return NULL; 295bb02b65cSKevin Wolf } 29633e9e9bdSKevin Wolf if (!id_wellformed(job_id)) { 29733e9e9bdSKevin Wolf error_setg(errp, "Invalid job ID '%s'", job_id); 29833e9e9bdSKevin Wolf return NULL; 29933e9e9bdSKevin Wolf } 300e7c1d78bSKevin Wolf if (job_get(job_id)) { 301e7c1d78bSKevin Wolf error_setg(errp, "Job ID '%s' already in use", job_id); 302e7c1d78bSKevin Wolf return NULL; 303e7c1d78bSKevin Wolf } 304bb02b65cSKevin Wolf } else if (!(flags & JOB_INTERNAL)) { 305bb02b65cSKevin Wolf error_setg(errp, "An explicit job ID is required"); 306bb02b65cSKevin Wolf return NULL; 30733e9e9bdSKevin Wolf } 30833e9e9bdSKevin Wolf 30933e9e9bdSKevin Wolf job = g_malloc0(driver->instance_size); 31033e9e9bdSKevin Wolf job->driver = driver; 31133e9e9bdSKevin Wolf job->id = g_strdup(job_id); 31280fa2c75SKevin Wolf job->refcnt = 1; 31308be6fe2SKevin Wolf job->aio_context = ctx; 314da01ff7fSKevin Wolf job->busy = false; 315da01ff7fSKevin Wolf job->paused = true; 316da01ff7fSKevin Wolf job->pause_count = 1; 317bb02b65cSKevin Wolf job->auto_finalize = !(flags & JOB_MANUAL_FINALIZE); 318bb02b65cSKevin Wolf job->auto_dismiss = !(flags & JOB_MANUAL_DISMISS); 3194ad35181SKevin Wolf job->cb = cb; 3204ad35181SKevin Wolf job->opaque = opaque; 32133e9e9bdSKevin Wolf 322139a9f02SKevin Wolf notifier_list_init(&job->on_finalize_cancelled); 323139a9f02SKevin Wolf notifier_list_init(&job->on_finalize_completed); 324139a9f02SKevin Wolf notifier_list_init(&job->on_pending); 3252e1795b5SKevin Wolf notifier_list_init(&job->on_ready); 326139a9f02SKevin Wolf 327a50c2ab8SKevin Wolf job_state_transition(job, JOB_STATUS_CREATED); 3285d43e86eSKevin Wolf aio_timer_init(qemu_get_aio_context(), &job->sleep_timer, 3295d43e86eSKevin Wolf QEMU_CLOCK_REALTIME, SCALE_NS, 3305d43e86eSKevin Wolf job_sleep_timer_cb, job); 331a50c2ab8SKevin Wolf 332e7c1d78bSKevin Wolf QLIST_INSERT_HEAD(&jobs, job, job_list); 333e7c1d78bSKevin Wolf 3347eaa8fb5SKevin Wolf /* Single jobs are modeled as single-job transactions for sake of 3357eaa8fb5SKevin Wolf * consolidating the job management logic */ 3367eaa8fb5SKevin Wolf if (!txn) { 3377eaa8fb5SKevin Wolf txn = job_txn_new(); 3387eaa8fb5SKevin Wolf job_txn_add_job(txn, job); 3397eaa8fb5SKevin Wolf job_txn_unref(txn); 3407eaa8fb5SKevin Wolf } else { 3417eaa8fb5SKevin Wolf job_txn_add_job(txn, job); 3427eaa8fb5SKevin Wolf } 3437eaa8fb5SKevin Wolf 34433e9e9bdSKevin Wolf return job; 34533e9e9bdSKevin Wolf } 346fd61a701SKevin Wolf 34780fa2c75SKevin Wolf void job_ref(Job *job) 348fd61a701SKevin Wolf { 34980fa2c75SKevin Wolf ++job->refcnt; 35080fa2c75SKevin Wolf } 35180fa2c75SKevin Wolf 35280fa2c75SKevin Wolf void job_unref(Job *job) 35380fa2c75SKevin Wolf { 35480fa2c75SKevin Wolf if (--job->refcnt == 0) { 35580fa2c75SKevin Wolf assert(job->status == JOB_STATUS_NULL); 3565d43e86eSKevin Wolf assert(!timer_pending(&job->sleep_timer)); 3577eaa8fb5SKevin Wolf assert(!job->txn); 35880fa2c75SKevin Wolf 35980fa2c75SKevin Wolf if (job->driver->free) { 36080fa2c75SKevin Wolf job->driver->free(job); 36180fa2c75SKevin Wolf } 36280fa2c75SKevin Wolf 363e7c1d78bSKevin Wolf QLIST_REMOVE(job, job_list); 364e7c1d78bSKevin Wolf 3653d1f8b07SJohn Snow error_free(job->err); 366fd61a701SKevin Wolf g_free(job->id); 367fd61a701SKevin Wolf g_free(job); 368fd61a701SKevin Wolf } 36980fa2c75SKevin Wolf } 3701908a559SKevin Wolf 37130a5c887SKevin Wolf void job_progress_update(Job *job, uint64_t done) 37230a5c887SKevin Wolf { 37330a5c887SKevin Wolf job->progress_current += done; 37430a5c887SKevin Wolf } 37530a5c887SKevin Wolf 37630a5c887SKevin Wolf void job_progress_set_remaining(Job *job, uint64_t remaining) 37730a5c887SKevin Wolf { 37830a5c887SKevin Wolf job->progress_total = job->progress_current + remaining; 37930a5c887SKevin Wolf } 38030a5c887SKevin Wolf 38162f13600SMax Reitz void job_progress_increase_remaining(Job *job, uint64_t delta) 38262f13600SMax Reitz { 38362f13600SMax Reitz job->progress_total += delta; 38462f13600SMax Reitz } 38562f13600SMax Reitz 386139a9f02SKevin Wolf void job_event_cancelled(Job *job) 387139a9f02SKevin Wolf { 388139a9f02SKevin Wolf notifier_list_notify(&job->on_finalize_cancelled, job); 389139a9f02SKevin Wolf } 390139a9f02SKevin Wolf 391139a9f02SKevin Wolf void job_event_completed(Job *job) 392139a9f02SKevin Wolf { 393139a9f02SKevin Wolf notifier_list_notify(&job->on_finalize_completed, job); 394139a9f02SKevin Wolf } 395139a9f02SKevin Wolf 3967eaa8fb5SKevin Wolf static void job_event_pending(Job *job) 397139a9f02SKevin Wolf { 398139a9f02SKevin Wolf notifier_list_notify(&job->on_pending, job); 399139a9f02SKevin Wolf } 400139a9f02SKevin Wolf 4012e1795b5SKevin Wolf static void job_event_ready(Job *job) 4022e1795b5SKevin Wolf { 4032e1795b5SKevin Wolf notifier_list_notify(&job->on_ready, job); 4042e1795b5SKevin Wolf } 4052e1795b5SKevin Wolf 40634dc97b9SKevin Wolf static void job_event_idle(Job *job) 40734dc97b9SKevin Wolf { 40834dc97b9SKevin Wolf notifier_list_notify(&job->on_idle, job); 40934dc97b9SKevin Wolf } 41034dc97b9SKevin Wolf 411da01ff7fSKevin Wolf void job_enter_cond(Job *job, bool(*fn)(Job *job)) 412da01ff7fSKevin Wolf { 413da01ff7fSKevin Wolf if (!job_started(job)) { 414da01ff7fSKevin Wolf return; 415da01ff7fSKevin Wolf } 416da01ff7fSKevin Wolf if (job->deferred_to_main_loop) { 417da01ff7fSKevin Wolf return; 418da01ff7fSKevin Wolf } 419da01ff7fSKevin Wolf 420da01ff7fSKevin Wolf job_lock(); 421da01ff7fSKevin Wolf if (job->busy) { 422da01ff7fSKevin Wolf job_unlock(); 423da01ff7fSKevin Wolf return; 424da01ff7fSKevin Wolf } 425da01ff7fSKevin Wolf 426da01ff7fSKevin Wolf if (fn && !fn(job)) { 427da01ff7fSKevin Wolf job_unlock(); 428da01ff7fSKevin Wolf return; 429da01ff7fSKevin Wolf } 430da01ff7fSKevin Wolf 431da01ff7fSKevin Wolf assert(!job->deferred_to_main_loop); 432da01ff7fSKevin Wolf timer_del(&job->sleep_timer); 433da01ff7fSKevin Wolf job->busy = true; 434da01ff7fSKevin Wolf job_unlock(); 435da01ff7fSKevin Wolf aio_co_wake(job->co); 436da01ff7fSKevin Wolf } 437da01ff7fSKevin Wolf 4385d43e86eSKevin Wolf void job_enter(Job *job) 4395d43e86eSKevin Wolf { 4405d43e86eSKevin Wolf job_enter_cond(job, NULL); 4415d43e86eSKevin Wolf } 4425d43e86eSKevin Wolf 443da01ff7fSKevin Wolf /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds. 4443d70ff53SKevin Wolf * Reentering the job coroutine with job_enter() before the timer has expired 4453d70ff53SKevin Wolf * is allowed and cancels the timer. 446da01ff7fSKevin Wolf * 4473d70ff53SKevin Wolf * If @ns is (uint64_t) -1, no timer is scheduled and job_enter() must be 448da01ff7fSKevin Wolf * called explicitly. */ 449198c49ccSKevin Wolf static void coroutine_fn job_do_yield(Job *job, uint64_t ns) 450da01ff7fSKevin Wolf { 451da01ff7fSKevin Wolf job_lock(); 452da01ff7fSKevin Wolf if (ns != -1) { 453da01ff7fSKevin Wolf timer_mod(&job->sleep_timer, ns); 454da01ff7fSKevin Wolf } 455da01ff7fSKevin Wolf job->busy = false; 45634dc97b9SKevin Wolf job_event_idle(job); 457da01ff7fSKevin Wolf job_unlock(); 458da01ff7fSKevin Wolf qemu_coroutine_yield(); 459da01ff7fSKevin Wolf 460da01ff7fSKevin Wolf /* Set by job_enter_cond() before re-entering the coroutine. */ 461da01ff7fSKevin Wolf assert(job->busy); 462da01ff7fSKevin Wolf } 463da01ff7fSKevin Wolf 464da01ff7fSKevin Wolf void coroutine_fn job_pause_point(Job *job) 465da01ff7fSKevin Wolf { 466da01ff7fSKevin Wolf assert(job && job_started(job)); 467da01ff7fSKevin Wolf 468da01ff7fSKevin Wolf if (!job_should_pause(job)) { 469da01ff7fSKevin Wolf return; 470da01ff7fSKevin Wolf } 471da01ff7fSKevin Wolf if (job_is_cancelled(job)) { 472da01ff7fSKevin Wolf return; 473da01ff7fSKevin Wolf } 474da01ff7fSKevin Wolf 475da01ff7fSKevin Wolf if (job->driver->pause) { 476da01ff7fSKevin Wolf job->driver->pause(job); 477da01ff7fSKevin Wolf } 478da01ff7fSKevin Wolf 479da01ff7fSKevin Wolf if (job_should_pause(job) && !job_is_cancelled(job)) { 480da01ff7fSKevin Wolf JobStatus status = job->status; 481da01ff7fSKevin Wolf job_state_transition(job, status == JOB_STATUS_READY 482da01ff7fSKevin Wolf ? JOB_STATUS_STANDBY 483da01ff7fSKevin Wolf : JOB_STATUS_PAUSED); 484da01ff7fSKevin Wolf job->paused = true; 485da01ff7fSKevin Wolf job_do_yield(job, -1); 486da01ff7fSKevin Wolf job->paused = false; 487da01ff7fSKevin Wolf job_state_transition(job, status); 488da01ff7fSKevin Wolf } 489da01ff7fSKevin Wolf 490da01ff7fSKevin Wolf if (job->driver->resume) { 491da01ff7fSKevin Wolf job->driver->resume(job); 492da01ff7fSKevin Wolf } 493da01ff7fSKevin Wolf } 494da01ff7fSKevin Wolf 495198c49ccSKevin Wolf void job_yield(Job *job) 496198c49ccSKevin Wolf { 497198c49ccSKevin Wolf assert(job->busy); 498198c49ccSKevin Wolf 499198c49ccSKevin Wolf /* Check cancellation *before* setting busy = false, too! */ 500198c49ccSKevin Wolf if (job_is_cancelled(job)) { 501198c49ccSKevin Wolf return; 502198c49ccSKevin Wolf } 503198c49ccSKevin Wolf 504198c49ccSKevin Wolf if (!job_should_pause(job)) { 505198c49ccSKevin Wolf job_do_yield(job, -1); 506198c49ccSKevin Wolf } 507198c49ccSKevin Wolf 508198c49ccSKevin Wolf job_pause_point(job); 509198c49ccSKevin Wolf } 510198c49ccSKevin Wolf 5115d43e86eSKevin Wolf void coroutine_fn job_sleep_ns(Job *job, int64_t ns) 5125d43e86eSKevin Wolf { 5135d43e86eSKevin Wolf assert(job->busy); 5145d43e86eSKevin Wolf 5155d43e86eSKevin Wolf /* Check cancellation *before* setting busy = false, too! */ 5165d43e86eSKevin Wolf if (job_is_cancelled(job)) { 5175d43e86eSKevin Wolf return; 5185d43e86eSKevin Wolf } 5195d43e86eSKevin Wolf 5205d43e86eSKevin Wolf if (!job_should_pause(job)) { 5215d43e86eSKevin Wolf job_do_yield(job, qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + ns); 5225d43e86eSKevin Wolf } 5235d43e86eSKevin Wolf 5245d43e86eSKevin Wolf job_pause_point(job); 5255d43e86eSKevin Wolf } 5265d43e86eSKevin Wolf 527b69f777dSKevin Wolf void job_drain(Job *job) 528b69f777dSKevin Wolf { 529b69f777dSKevin Wolf /* If job is !busy this kicks it into the next pause point. */ 530b69f777dSKevin Wolf job_enter(job); 531b69f777dSKevin Wolf 532b69f777dSKevin Wolf if (job->driver->drain) { 533b69f777dSKevin Wolf job->driver->drain(job); 534b69f777dSKevin Wolf } 535b69f777dSKevin Wolf } 536b69f777dSKevin Wolf 537b15de828SKevin Wolf /* Assumes the block_job_mutex is held */ 538b15de828SKevin Wolf static bool job_timer_not_pending(Job *job) 539b15de828SKevin Wolf { 540b15de828SKevin Wolf return !timer_pending(&job->sleep_timer); 541b15de828SKevin Wolf } 542b15de828SKevin Wolf 543b15de828SKevin Wolf void job_pause(Job *job) 544b15de828SKevin Wolf { 545b15de828SKevin Wolf job->pause_count++; 546b15de828SKevin Wolf } 547b15de828SKevin Wolf 548b15de828SKevin Wolf void job_resume(Job *job) 549b15de828SKevin Wolf { 550b15de828SKevin Wolf assert(job->pause_count > 0); 551b15de828SKevin Wolf job->pause_count--; 552b15de828SKevin Wolf if (job->pause_count) { 553b15de828SKevin Wolf return; 554b15de828SKevin Wolf } 555b15de828SKevin Wolf 556b15de828SKevin Wolf /* kick only if no timer is pending */ 557b15de828SKevin Wolf job_enter_cond(job, job_timer_not_pending); 558b15de828SKevin Wolf } 559b15de828SKevin Wolf 560b15de828SKevin Wolf void job_user_pause(Job *job, Error **errp) 561b15de828SKevin Wolf { 562b15de828SKevin Wolf if (job_apply_verb(job, JOB_VERB_PAUSE, errp)) { 563b15de828SKevin Wolf return; 564b15de828SKevin Wolf } 565b15de828SKevin Wolf if (job->user_paused) { 566b15de828SKevin Wolf error_setg(errp, "Job is already paused"); 567b15de828SKevin Wolf return; 568b15de828SKevin Wolf } 569b15de828SKevin Wolf job->user_paused = true; 570b15de828SKevin Wolf job_pause(job); 571b15de828SKevin Wolf } 572b15de828SKevin Wolf 573b15de828SKevin Wolf bool job_user_paused(Job *job) 574b15de828SKevin Wolf { 575b15de828SKevin Wolf return job->user_paused; 576b15de828SKevin Wolf } 577b15de828SKevin Wolf 578b15de828SKevin Wolf void job_user_resume(Job *job, Error **errp) 579b15de828SKevin Wolf { 580b15de828SKevin Wolf assert(job); 581b15de828SKevin Wolf if (!job->user_paused || job->pause_count <= 0) { 582b15de828SKevin Wolf error_setg(errp, "Can't resume a job that was not paused"); 583b15de828SKevin Wolf return; 584b15de828SKevin Wolf } 585b15de828SKevin Wolf if (job_apply_verb(job, JOB_VERB_RESUME, errp)) { 586b15de828SKevin Wolf return; 587b15de828SKevin Wolf } 588b15de828SKevin Wolf if (job->driver->user_resume) { 589b15de828SKevin Wolf job->driver->user_resume(job); 590b15de828SKevin Wolf } 591b15de828SKevin Wolf job->user_paused = false; 592b15de828SKevin Wolf job_resume(job); 593b15de828SKevin Wolf } 594b15de828SKevin Wolf 5955f9a6a08SKevin Wolf static void job_do_dismiss(Job *job) 5964ad35181SKevin Wolf { 5974ad35181SKevin Wolf assert(job); 5984ad35181SKevin Wolf job->busy = false; 5994ad35181SKevin Wolf job->paused = false; 6004ad35181SKevin Wolf job->deferred_to_main_loop = true; 6014ad35181SKevin Wolf 6027eaa8fb5SKevin Wolf job_txn_del_job(job); 6034ad35181SKevin Wolf 6044ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_NULL); 6054ad35181SKevin Wolf job_unref(job); 6064ad35181SKevin Wolf } 6074ad35181SKevin Wolf 6085f9a6a08SKevin Wolf void job_dismiss(Job **jobptr, Error **errp) 6095f9a6a08SKevin Wolf { 6105f9a6a08SKevin Wolf Job *job = *jobptr; 6115f9a6a08SKevin Wolf /* similarly to _complete, this is QMP-interface only. */ 6125f9a6a08SKevin Wolf assert(job->id); 6135f9a6a08SKevin Wolf if (job_apply_verb(job, JOB_VERB_DISMISS, errp)) { 6145f9a6a08SKevin Wolf return; 6155f9a6a08SKevin Wolf } 6165f9a6a08SKevin Wolf 6175f9a6a08SKevin Wolf job_do_dismiss(job); 6185f9a6a08SKevin Wolf *jobptr = NULL; 6195f9a6a08SKevin Wolf } 6205f9a6a08SKevin Wolf 6214ad35181SKevin Wolf void job_early_fail(Job *job) 6224ad35181SKevin Wolf { 6234ad35181SKevin Wolf assert(job->status == JOB_STATUS_CREATED); 6244ad35181SKevin Wolf job_do_dismiss(job); 6254ad35181SKevin Wolf } 6264ad35181SKevin Wolf 6274ad35181SKevin Wolf static void job_conclude(Job *job) 6284ad35181SKevin Wolf { 6294ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_CONCLUDED); 6304ad35181SKevin Wolf if (job->auto_dismiss || !job_started(job)) { 6314ad35181SKevin Wolf job_do_dismiss(job); 6324ad35181SKevin Wolf } 6334ad35181SKevin Wolf } 6344ad35181SKevin Wolf 6353d70ff53SKevin Wolf static void job_update_rc(Job *job) 6364ad35181SKevin Wolf { 6374ad35181SKevin Wolf if (!job->ret && job_is_cancelled(job)) { 6384ad35181SKevin Wolf job->ret = -ECANCELED; 6394ad35181SKevin Wolf } 6404ad35181SKevin Wolf if (job->ret) { 6413d1f8b07SJohn Snow if (!job->err) { 6423d1f8b07SJohn Snow error_setg(&job->err, "%s", strerror(-job->ret)); 6431266c9b9SKevin Wolf } 6444ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_ABORTING); 6454ad35181SKevin Wolf } 6464ad35181SKevin Wolf } 6474ad35181SKevin Wolf 6484ad35181SKevin Wolf static void job_commit(Job *job) 6494ad35181SKevin Wolf { 6504ad35181SKevin Wolf assert(!job->ret); 6514ad35181SKevin Wolf if (job->driver->commit) { 6524ad35181SKevin Wolf job->driver->commit(job); 6534ad35181SKevin Wolf } 6544ad35181SKevin Wolf } 6554ad35181SKevin Wolf 6564ad35181SKevin Wolf static void job_abort(Job *job) 6574ad35181SKevin Wolf { 6584ad35181SKevin Wolf assert(job->ret); 6594ad35181SKevin Wolf if (job->driver->abort) { 6604ad35181SKevin Wolf job->driver->abort(job); 6614ad35181SKevin Wolf } 6624ad35181SKevin Wolf } 6634ad35181SKevin Wolf 6644ad35181SKevin Wolf static void job_clean(Job *job) 6654ad35181SKevin Wolf { 6664ad35181SKevin Wolf if (job->driver->clean) { 6674ad35181SKevin Wolf job->driver->clean(job); 6684ad35181SKevin Wolf } 6694ad35181SKevin Wolf } 6704ad35181SKevin Wolf 6717eaa8fb5SKevin Wolf static int job_finalize_single(Job *job) 6724ad35181SKevin Wolf { 6734ad35181SKevin Wolf assert(job_is_completed(job)); 6744ad35181SKevin Wolf 6754ad35181SKevin Wolf /* Ensure abort is called for late-transactional failures */ 6764ad35181SKevin Wolf job_update_rc(job); 6774ad35181SKevin Wolf 6784ad35181SKevin Wolf if (!job->ret) { 6794ad35181SKevin Wolf job_commit(job); 6804ad35181SKevin Wolf } else { 6814ad35181SKevin Wolf job_abort(job); 6824ad35181SKevin Wolf } 6834ad35181SKevin Wolf job_clean(job); 6844ad35181SKevin Wolf 6854ad35181SKevin Wolf if (job->cb) { 6864ad35181SKevin Wolf job->cb(job->opaque, job->ret); 6874ad35181SKevin Wolf } 6884ad35181SKevin Wolf 6894ad35181SKevin Wolf /* Emit events only if we actually started */ 6904ad35181SKevin Wolf if (job_started(job)) { 6914ad35181SKevin Wolf if (job_is_cancelled(job)) { 6924ad35181SKevin Wolf job_event_cancelled(job); 6934ad35181SKevin Wolf } else { 6944ad35181SKevin Wolf job_event_completed(job); 6954ad35181SKevin Wolf } 6964ad35181SKevin Wolf } 6974ad35181SKevin Wolf 6987eaa8fb5SKevin Wolf job_txn_del_job(job); 6994ad35181SKevin Wolf job_conclude(job); 7004ad35181SKevin Wolf return 0; 7014ad35181SKevin Wolf } 7024ad35181SKevin Wolf 7033d70ff53SKevin Wolf static void job_cancel_async(Job *job, bool force) 7047eaa8fb5SKevin Wolf { 7057eaa8fb5SKevin Wolf if (job->user_paused) { 7067eaa8fb5SKevin Wolf /* Do not call job_enter here, the caller will handle it. */ 7077eaa8fb5SKevin Wolf if (job->driver->user_resume) { 7087eaa8fb5SKevin Wolf job->driver->user_resume(job); 7097eaa8fb5SKevin Wolf } 710e321c059SJeff Cody job->user_paused = false; 7117eaa8fb5SKevin Wolf assert(job->pause_count > 0); 7127eaa8fb5SKevin Wolf job->pause_count--; 7137eaa8fb5SKevin Wolf } 7147eaa8fb5SKevin Wolf job->cancelled = true; 7157eaa8fb5SKevin Wolf /* To prevent 'force == false' overriding a previous 'force == true' */ 7167eaa8fb5SKevin Wolf job->force_cancel |= force; 7177eaa8fb5SKevin Wolf } 7187eaa8fb5SKevin Wolf 7193d70ff53SKevin Wolf static void job_completed_txn_abort(Job *job) 7207eaa8fb5SKevin Wolf { 7217eaa8fb5SKevin Wolf AioContext *ctx; 7227eaa8fb5SKevin Wolf JobTxn *txn = job->txn; 7237eaa8fb5SKevin Wolf Job *other_job; 7247eaa8fb5SKevin Wolf 7257eaa8fb5SKevin Wolf if (txn->aborting) { 7267eaa8fb5SKevin Wolf /* 7277eaa8fb5SKevin Wolf * We are cancelled by another job, which will handle everything. 7287eaa8fb5SKevin Wolf */ 7297eaa8fb5SKevin Wolf return; 7307eaa8fb5SKevin Wolf } 7317eaa8fb5SKevin Wolf txn->aborting = true; 7327eaa8fb5SKevin Wolf job_txn_ref(txn); 7337eaa8fb5SKevin Wolf 7347eaa8fb5SKevin Wolf /* We are the first failed job. Cancel other jobs. */ 7357eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 7367eaa8fb5SKevin Wolf ctx = other_job->aio_context; 7377eaa8fb5SKevin Wolf aio_context_acquire(ctx); 7387eaa8fb5SKevin Wolf } 7397eaa8fb5SKevin Wolf 7407eaa8fb5SKevin Wolf /* Other jobs are effectively cancelled by us, set the status for 7417eaa8fb5SKevin Wolf * them; this job, however, may or may not be cancelled, depending 7427eaa8fb5SKevin Wolf * on the caller, so leave it. */ 7437eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 7447eaa8fb5SKevin Wolf if (other_job != job) { 7457eaa8fb5SKevin Wolf job_cancel_async(other_job, false); 7467eaa8fb5SKevin Wolf } 7477eaa8fb5SKevin Wolf } 7487eaa8fb5SKevin Wolf while (!QLIST_EMPTY(&txn->jobs)) { 7497eaa8fb5SKevin Wolf other_job = QLIST_FIRST(&txn->jobs); 7507eaa8fb5SKevin Wolf ctx = other_job->aio_context; 7517eaa8fb5SKevin Wolf if (!job_is_completed(other_job)) { 7527eaa8fb5SKevin Wolf assert(job_is_cancelled(other_job)); 7537eaa8fb5SKevin Wolf job_finish_sync(other_job, NULL, NULL); 7547eaa8fb5SKevin Wolf } 7557eaa8fb5SKevin Wolf job_finalize_single(other_job); 7567eaa8fb5SKevin Wolf aio_context_release(ctx); 7577eaa8fb5SKevin Wolf } 7587eaa8fb5SKevin Wolf 7597eaa8fb5SKevin Wolf job_txn_unref(txn); 7607eaa8fb5SKevin Wolf } 7617eaa8fb5SKevin Wolf 7627eaa8fb5SKevin Wolf static int job_prepare(Job *job) 7637eaa8fb5SKevin Wolf { 7647eaa8fb5SKevin Wolf if (job->ret == 0 && job->driver->prepare) { 7657eaa8fb5SKevin Wolf job->ret = job->driver->prepare(job); 7661266c9b9SKevin Wolf job_update_rc(job); 7677eaa8fb5SKevin Wolf } 7687eaa8fb5SKevin Wolf return job->ret; 7697eaa8fb5SKevin Wolf } 7707eaa8fb5SKevin Wolf 7717eaa8fb5SKevin Wolf static int job_needs_finalize(Job *job) 7727eaa8fb5SKevin Wolf { 7737eaa8fb5SKevin Wolf return !job->auto_finalize; 7747eaa8fb5SKevin Wolf } 7757eaa8fb5SKevin Wolf 7767eaa8fb5SKevin Wolf static void job_do_finalize(Job *job) 7777eaa8fb5SKevin Wolf { 7787eaa8fb5SKevin Wolf int rc; 7797eaa8fb5SKevin Wolf assert(job && job->txn); 7807eaa8fb5SKevin Wolf 7817eaa8fb5SKevin Wolf /* prepare the transaction to complete */ 78249880165SFam Zheng rc = job_txn_apply(job->txn, job_prepare); 7837eaa8fb5SKevin Wolf if (rc) { 7847eaa8fb5SKevin Wolf job_completed_txn_abort(job); 7857eaa8fb5SKevin Wolf } else { 78649880165SFam Zheng job_txn_apply(job->txn, job_finalize_single); 7877eaa8fb5SKevin Wolf } 7887eaa8fb5SKevin Wolf } 7897eaa8fb5SKevin Wolf 7907eaa8fb5SKevin Wolf void job_finalize(Job *job, Error **errp) 7917eaa8fb5SKevin Wolf { 7927eaa8fb5SKevin Wolf assert(job && job->id); 7937eaa8fb5SKevin Wolf if (job_apply_verb(job, JOB_VERB_FINALIZE, errp)) { 7947eaa8fb5SKevin Wolf return; 7957eaa8fb5SKevin Wolf } 7967eaa8fb5SKevin Wolf job_do_finalize(job); 7977eaa8fb5SKevin Wolf } 7987eaa8fb5SKevin Wolf 7997eaa8fb5SKevin Wolf static int job_transition_to_pending(Job *job) 8007eaa8fb5SKevin Wolf { 8017eaa8fb5SKevin Wolf job_state_transition(job, JOB_STATUS_PENDING); 8027eaa8fb5SKevin Wolf if (!job->auto_finalize) { 8037eaa8fb5SKevin Wolf job_event_pending(job); 8047eaa8fb5SKevin Wolf } 8057eaa8fb5SKevin Wolf return 0; 8067eaa8fb5SKevin Wolf } 8077eaa8fb5SKevin Wolf 8082e1795b5SKevin Wolf void job_transition_to_ready(Job *job) 8092e1795b5SKevin Wolf { 8102e1795b5SKevin Wolf job_state_transition(job, JOB_STATUS_READY); 8112e1795b5SKevin Wolf job_event_ready(job); 8122e1795b5SKevin Wolf } 8132e1795b5SKevin Wolf 8143d70ff53SKevin Wolf static void job_completed_txn_success(Job *job) 8157eaa8fb5SKevin Wolf { 8167eaa8fb5SKevin Wolf JobTxn *txn = job->txn; 8177eaa8fb5SKevin Wolf Job *other_job; 8187eaa8fb5SKevin Wolf 8197eaa8fb5SKevin Wolf job_state_transition(job, JOB_STATUS_WAITING); 8207eaa8fb5SKevin Wolf 8217eaa8fb5SKevin Wolf /* 8227eaa8fb5SKevin Wolf * Successful completion, see if there are other running jobs in this 8237eaa8fb5SKevin Wolf * txn. 8247eaa8fb5SKevin Wolf */ 8257eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 8267eaa8fb5SKevin Wolf if (!job_is_completed(other_job)) { 8277eaa8fb5SKevin Wolf return; 8287eaa8fb5SKevin Wolf } 8297eaa8fb5SKevin Wolf assert(other_job->ret == 0); 8307eaa8fb5SKevin Wolf } 8317eaa8fb5SKevin Wolf 83249880165SFam Zheng job_txn_apply(txn, job_transition_to_pending); 8337eaa8fb5SKevin Wolf 8347eaa8fb5SKevin Wolf /* If no jobs need manual finalization, automatically do so */ 83549880165SFam Zheng if (job_txn_apply(txn, job_needs_finalize) == 0) { 8367eaa8fb5SKevin Wolf job_do_finalize(job); 8377eaa8fb5SKevin Wolf } 8387eaa8fb5SKevin Wolf } 8397eaa8fb5SKevin Wolf 840404ff28dSJohn Snow static void job_completed(Job *job) 8413d70ff53SKevin Wolf { 8423d70ff53SKevin Wolf assert(job && job->txn && !job_is_completed(job)); 8431266c9b9SKevin Wolf 8443d70ff53SKevin Wolf job_update_rc(job); 845404ff28dSJohn Snow trace_job_completed(job, job->ret); 8463d70ff53SKevin Wolf if (job->ret) { 8473d70ff53SKevin Wolf job_completed_txn_abort(job); 8483d70ff53SKevin Wolf } else { 8493d70ff53SKevin Wolf job_completed_txn_success(job); 8503d70ff53SKevin Wolf } 8513d70ff53SKevin Wolf } 8523d70ff53SKevin Wolf 853ccbfb331SJohn Snow /** Useful only as a type shim for aio_bh_schedule_oneshot. */ 854ccbfb331SJohn Snow static void job_exit(void *opaque) 855ccbfb331SJohn Snow { 856ccbfb331SJohn Snow Job *job = (Job *)opaque; 857d1756c78SKevin Wolf AioContext *ctx = job->aio_context; 858d1756c78SKevin Wolf 859d1756c78SKevin Wolf aio_context_acquire(ctx); 860ccbfb331SJohn Snow job_completed(job); 861d1756c78SKevin Wolf aio_context_release(ctx); 862ccbfb331SJohn Snow } 863ccbfb331SJohn Snow 864ccbfb331SJohn Snow /** 865ccbfb331SJohn Snow * All jobs must allow a pause point before entering their job proper. This 866ccbfb331SJohn Snow * ensures that jobs can be paused prior to being started, then resumed later. 867ccbfb331SJohn Snow */ 868ccbfb331SJohn Snow static void coroutine_fn job_co_entry(void *opaque) 869ccbfb331SJohn Snow { 870ccbfb331SJohn Snow Job *job = opaque; 871ccbfb331SJohn Snow 872ccbfb331SJohn Snow assert(job && job->driver && job->driver->run); 873ccbfb331SJohn Snow job_pause_point(job); 874ccbfb331SJohn Snow job->ret = job->driver->run(job, &job->err); 87534dc97b9SKevin Wolf job_event_idle(job); 876ccbfb331SJohn Snow job->deferred_to_main_loop = true; 877ccbfb331SJohn Snow aio_bh_schedule_oneshot(qemu_get_aio_context(), job_exit, job); 878ccbfb331SJohn Snow } 879ccbfb331SJohn Snow 880ccbfb331SJohn Snow void job_start(Job *job) 881ccbfb331SJohn Snow { 882ccbfb331SJohn Snow assert(job && !job_started(job) && job->paused && 883ccbfb331SJohn Snow job->driver && job->driver->run); 884ccbfb331SJohn Snow job->co = qemu_coroutine_create(job_co_entry, job); 885ccbfb331SJohn Snow job->pause_count--; 886ccbfb331SJohn Snow job->busy = true; 887ccbfb331SJohn Snow job->paused = false; 888ccbfb331SJohn Snow job_state_transition(job, JOB_STATUS_RUNNING); 889ccbfb331SJohn Snow aio_co_enter(job->aio_context, job->co); 890ccbfb331SJohn Snow } 891ccbfb331SJohn Snow 8923d70ff53SKevin Wolf void job_cancel(Job *job, bool force) 8933d70ff53SKevin Wolf { 8943d70ff53SKevin Wolf if (job->status == JOB_STATUS_CONCLUDED) { 8953d70ff53SKevin Wolf job_do_dismiss(job); 8963d70ff53SKevin Wolf return; 8973d70ff53SKevin Wolf } 8983d70ff53SKevin Wolf job_cancel_async(job, force); 8993d70ff53SKevin Wolf if (!job_started(job)) { 900404ff28dSJohn Snow job_completed(job); 9013d70ff53SKevin Wolf } else if (job->deferred_to_main_loop) { 9023d70ff53SKevin Wolf job_completed_txn_abort(job); 9033d70ff53SKevin Wolf } else { 9043d70ff53SKevin Wolf job_enter(job); 9053d70ff53SKevin Wolf } 9063d70ff53SKevin Wolf } 9073d70ff53SKevin Wolf 9083d70ff53SKevin Wolf void job_user_cancel(Job *job, bool force, Error **errp) 9093d70ff53SKevin Wolf { 9103d70ff53SKevin Wolf if (job_apply_verb(job, JOB_VERB_CANCEL, errp)) { 9113d70ff53SKevin Wolf return; 9123d70ff53SKevin Wolf } 9133d70ff53SKevin Wolf job_cancel(job, force); 9143d70ff53SKevin Wolf } 9153d70ff53SKevin Wolf 9163d70ff53SKevin Wolf /* A wrapper around job_cancel() taking an Error ** parameter so it may be 9173d70ff53SKevin Wolf * used with job_finish_sync() without the need for (rather nasty) function 9183d70ff53SKevin Wolf * pointer casts there. */ 9193d70ff53SKevin Wolf static void job_cancel_err(Job *job, Error **errp) 9203d70ff53SKevin Wolf { 9213d70ff53SKevin Wolf job_cancel(job, false); 9223d70ff53SKevin Wolf } 9233d70ff53SKevin Wolf 9243d70ff53SKevin Wolf int job_cancel_sync(Job *job) 9253d70ff53SKevin Wolf { 9263d70ff53SKevin Wolf return job_finish_sync(job, &job_cancel_err, NULL); 9273d70ff53SKevin Wolf } 9283d70ff53SKevin Wolf 9293d70ff53SKevin Wolf void job_cancel_sync_all(void) 9303d70ff53SKevin Wolf { 9313d70ff53SKevin Wolf Job *job; 9323d70ff53SKevin Wolf AioContext *aio_context; 9333d70ff53SKevin Wolf 9343d70ff53SKevin Wolf while ((job = job_next(NULL))) { 9353d70ff53SKevin Wolf aio_context = job->aio_context; 9363d70ff53SKevin Wolf aio_context_acquire(aio_context); 9373d70ff53SKevin Wolf job_cancel_sync(job); 9383d70ff53SKevin Wolf aio_context_release(aio_context); 9393d70ff53SKevin Wolf } 9403d70ff53SKevin Wolf } 9413d70ff53SKevin Wolf 9423d70ff53SKevin Wolf int job_complete_sync(Job *job, Error **errp) 9433d70ff53SKevin Wolf { 9443d70ff53SKevin Wolf return job_finish_sync(job, job_complete, errp); 9453d70ff53SKevin Wolf } 9463d70ff53SKevin Wolf 9473453d972SKevin Wolf void job_complete(Job *job, Error **errp) 9483453d972SKevin Wolf { 9493453d972SKevin Wolf /* Should not be reachable via external interface for internal jobs */ 9503453d972SKevin Wolf assert(job->id); 9513453d972SKevin Wolf if (job_apply_verb(job, JOB_VERB_COMPLETE, errp)) { 9523453d972SKevin Wolf return; 9533453d972SKevin Wolf } 9543453d972SKevin Wolf if (job->pause_count || job_is_cancelled(job) || !job->driver->complete) { 9553453d972SKevin Wolf error_setg(errp, "The active block job '%s' cannot be completed", 9563453d972SKevin Wolf job->id); 9573453d972SKevin Wolf return; 9583453d972SKevin Wolf } 9593453d972SKevin Wolf 9603453d972SKevin Wolf job->driver->complete(job, errp); 9613453d972SKevin Wolf } 9623453d972SKevin Wolf 9636a74c075SKevin Wolf int job_finish_sync(Job *job, void (*finish)(Job *, Error **errp), Error **errp) 9646a74c075SKevin Wolf { 9656a74c075SKevin Wolf Error *local_err = NULL; 966*de0fbe64SKevin Wolf AioWait dummy_wait = {}; 9676a74c075SKevin Wolf int ret; 9686a74c075SKevin Wolf 9696a74c075SKevin Wolf job_ref(job); 9706a74c075SKevin Wolf 9716a74c075SKevin Wolf if (finish) { 9726a74c075SKevin Wolf finish(job, &local_err); 9736a74c075SKevin Wolf } 9746a74c075SKevin Wolf if (local_err) { 9756a74c075SKevin Wolf error_propagate(errp, local_err); 9766a74c075SKevin Wolf job_unref(job); 9776a74c075SKevin Wolf return -EBUSY; 9786a74c075SKevin Wolf } 979*de0fbe64SKevin Wolf 980*de0fbe64SKevin Wolf AIO_WAIT_WHILE(&dummy_wait, job->aio_context, 981*de0fbe64SKevin Wolf (job_drain(job), !job_is_completed(job))); 982*de0fbe64SKevin Wolf 9836a74c075SKevin Wolf ret = (job_is_cancelled(job) && job->ret == 0) ? -ECANCELED : job->ret; 9846a74c075SKevin Wolf job_unref(job); 9856a74c075SKevin Wolf return ret; 9866a74c075SKevin Wolf } 987