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" 331dac83f1SKevin Wolf #include "qapi/qapi-events-job.h" 3433e9e9bdSKevin Wolf 35e7c1d78bSKevin Wolf static QLIST_HEAD(, Job) jobs = QLIST_HEAD_INITIALIZER(jobs); 36e7c1d78bSKevin Wolf 37a50c2ab8SKevin Wolf /* Job State Transition Table */ 38a50c2ab8SKevin Wolf bool JobSTT[JOB_STATUS__MAX][JOB_STATUS__MAX] = { 39a50c2ab8SKevin Wolf /* U, C, R, P, Y, S, W, D, X, E, N */ 40a50c2ab8SKevin Wolf /* U: */ [JOB_STATUS_UNDEFINED] = {0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0}, 41a50c2ab8SKevin Wolf /* C: */ [JOB_STATUS_CREATED] = {0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 1}, 42a50c2ab8SKevin Wolf /* R: */ [JOB_STATUS_RUNNING] = {0, 0, 0, 1, 1, 0, 1, 0, 1, 0, 0}, 43a50c2ab8SKevin Wolf /* P: */ [JOB_STATUS_PAUSED] = {0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0}, 44a50c2ab8SKevin Wolf /* Y: */ [JOB_STATUS_READY] = {0, 0, 0, 0, 0, 1, 1, 0, 1, 0, 0}, 45a50c2ab8SKevin Wolf /* S: */ [JOB_STATUS_STANDBY] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0}, 46a50c2ab8SKevin Wolf /* W: */ [JOB_STATUS_WAITING] = {0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0}, 47a50c2ab8SKevin Wolf /* D: */ [JOB_STATUS_PENDING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, 48a50c2ab8SKevin Wolf /* X: */ [JOB_STATUS_ABORTING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, 49a50c2ab8SKevin Wolf /* E: */ [JOB_STATUS_CONCLUDED] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}, 50a50c2ab8SKevin Wolf /* N: */ [JOB_STATUS_NULL] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}, 51a50c2ab8SKevin Wolf }; 52a50c2ab8SKevin Wolf 53a50c2ab8SKevin Wolf bool JobVerbTable[JOB_VERB__MAX][JOB_STATUS__MAX] = { 54a50c2ab8SKevin Wolf /* U, C, R, P, Y, S, W, D, X, E, N */ 55a50c2ab8SKevin Wolf [JOB_VERB_CANCEL] = {0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0}, 56a50c2ab8SKevin Wolf [JOB_VERB_PAUSE] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 57a50c2ab8SKevin Wolf [JOB_VERB_RESUME] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 58a50c2ab8SKevin Wolf [JOB_VERB_SET_SPEED] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 59a50c2ab8SKevin Wolf [JOB_VERB_COMPLETE] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0}, 60a50c2ab8SKevin Wolf [JOB_VERB_FINALIZE] = {0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0}, 61a50c2ab8SKevin Wolf [JOB_VERB_DISMISS] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0}, 62a50c2ab8SKevin Wolf }; 63a50c2ab8SKevin Wolf 647eaa8fb5SKevin Wolf /* Transactional group of jobs */ 657eaa8fb5SKevin Wolf struct JobTxn { 667eaa8fb5SKevin Wolf 677eaa8fb5SKevin Wolf /* Is this txn being cancelled? */ 687eaa8fb5SKevin Wolf bool aborting; 697eaa8fb5SKevin Wolf 707eaa8fb5SKevin Wolf /* List of jobs */ 717eaa8fb5SKevin Wolf QLIST_HEAD(, Job) jobs; 727eaa8fb5SKevin Wolf 737eaa8fb5SKevin Wolf /* Reference count */ 747eaa8fb5SKevin Wolf int refcnt; 757eaa8fb5SKevin Wolf }; 767eaa8fb5SKevin Wolf 77da01ff7fSKevin Wolf /* Right now, this mutex is only needed to synchronize accesses to job->busy 78da01ff7fSKevin Wolf * and job->sleep_timer, such as concurrent calls to job_do_yield and 79da01ff7fSKevin Wolf * job_enter. */ 80da01ff7fSKevin Wolf static QemuMutex job_mutex; 81da01ff7fSKevin Wolf 82da01ff7fSKevin Wolf static void job_lock(void) 83da01ff7fSKevin Wolf { 84da01ff7fSKevin Wolf qemu_mutex_lock(&job_mutex); 85da01ff7fSKevin Wolf } 86da01ff7fSKevin Wolf 87da01ff7fSKevin Wolf static void job_unlock(void) 88da01ff7fSKevin Wolf { 89da01ff7fSKevin Wolf qemu_mutex_unlock(&job_mutex); 90da01ff7fSKevin Wolf } 91da01ff7fSKevin Wolf 92da01ff7fSKevin Wolf static void __attribute__((__constructor__)) job_init(void) 93da01ff7fSKevin Wolf { 94da01ff7fSKevin Wolf qemu_mutex_init(&job_mutex); 95da01ff7fSKevin Wolf } 96da01ff7fSKevin Wolf 977eaa8fb5SKevin Wolf JobTxn *job_txn_new(void) 987eaa8fb5SKevin Wolf { 997eaa8fb5SKevin Wolf JobTxn *txn = g_new0(JobTxn, 1); 1007eaa8fb5SKevin Wolf QLIST_INIT(&txn->jobs); 1017eaa8fb5SKevin Wolf txn->refcnt = 1; 1027eaa8fb5SKevin Wolf return txn; 1037eaa8fb5SKevin Wolf } 1047eaa8fb5SKevin Wolf 1057eaa8fb5SKevin Wolf static void job_txn_ref(JobTxn *txn) 1067eaa8fb5SKevin Wolf { 1077eaa8fb5SKevin Wolf txn->refcnt++; 1087eaa8fb5SKevin Wolf } 1097eaa8fb5SKevin Wolf 1107eaa8fb5SKevin Wolf void job_txn_unref(JobTxn *txn) 1117eaa8fb5SKevin Wolf { 1127eaa8fb5SKevin Wolf if (txn && --txn->refcnt == 0) { 1137eaa8fb5SKevin Wolf g_free(txn); 1147eaa8fb5SKevin Wolf } 1157eaa8fb5SKevin Wolf } 1167eaa8fb5SKevin Wolf 1177eaa8fb5SKevin Wolf void job_txn_add_job(JobTxn *txn, Job *job) 1187eaa8fb5SKevin Wolf { 1197eaa8fb5SKevin Wolf if (!txn) { 1207eaa8fb5SKevin Wolf return; 1217eaa8fb5SKevin Wolf } 1227eaa8fb5SKevin Wolf 1237eaa8fb5SKevin Wolf assert(!job->txn); 1247eaa8fb5SKevin Wolf job->txn = txn; 1257eaa8fb5SKevin Wolf 1267eaa8fb5SKevin Wolf QLIST_INSERT_HEAD(&txn->jobs, job, txn_list); 1277eaa8fb5SKevin Wolf job_txn_ref(txn); 1287eaa8fb5SKevin Wolf } 1297eaa8fb5SKevin Wolf 1307eaa8fb5SKevin Wolf static void job_txn_del_job(Job *job) 1317eaa8fb5SKevin Wolf { 1327eaa8fb5SKevin Wolf if (job->txn) { 1337eaa8fb5SKevin Wolf QLIST_REMOVE(job, txn_list); 1347eaa8fb5SKevin Wolf job_txn_unref(job->txn); 1357eaa8fb5SKevin Wolf job->txn = NULL; 1367eaa8fb5SKevin Wolf } 1377eaa8fb5SKevin Wolf } 1387eaa8fb5SKevin Wolf 1397eaa8fb5SKevin Wolf static int job_txn_apply(JobTxn *txn, int fn(Job *), bool lock) 1407eaa8fb5SKevin Wolf { 1417eaa8fb5SKevin Wolf AioContext *ctx; 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 if (lock) { 1477eaa8fb5SKevin Wolf ctx = job->aio_context; 1487eaa8fb5SKevin Wolf aio_context_acquire(ctx); 1497eaa8fb5SKevin Wolf } 1507eaa8fb5SKevin Wolf rc = fn(job); 1517eaa8fb5SKevin Wolf if (lock) { 1527eaa8fb5SKevin Wolf aio_context_release(ctx); 1537eaa8fb5SKevin Wolf } 1547eaa8fb5SKevin Wolf if (rc) { 1557eaa8fb5SKevin Wolf break; 1567eaa8fb5SKevin Wolf } 1577eaa8fb5SKevin Wolf } 1587eaa8fb5SKevin Wolf return rc; 1597eaa8fb5SKevin Wolf } 1607eaa8fb5SKevin Wolf 161456273b0SKevin Wolf bool job_is_internal(Job *job) 1621dac83f1SKevin Wolf { 1631dac83f1SKevin Wolf return (job->id == NULL); 1641dac83f1SKevin Wolf } 1651dac83f1SKevin Wolf 1662e1795b5SKevin Wolf static void job_state_transition(Job *job, JobStatus s1) 167a50c2ab8SKevin Wolf { 168a50c2ab8SKevin Wolf JobStatus s0 = job->status; 169a50c2ab8SKevin Wolf assert(s1 >= 0 && s1 <= JOB_STATUS__MAX); 1704ad35181SKevin Wolf trace_job_state_transition(job, job->ret, 171a50c2ab8SKevin Wolf JobSTT[s0][s1] ? "allowed" : "disallowed", 172a50c2ab8SKevin Wolf JobStatus_str(s0), JobStatus_str(s1)); 173a50c2ab8SKevin Wolf assert(JobSTT[s0][s1]); 174a50c2ab8SKevin Wolf job->status = s1; 1751dac83f1SKevin Wolf 1761dac83f1SKevin Wolf if (!job_is_internal(job) && s1 != s0) { 1773ab72385SPeter Xu qapi_event_send_job_status_change(job->id, job->status); 1781dac83f1SKevin Wolf } 179a50c2ab8SKevin Wolf } 180a50c2ab8SKevin Wolf 181a50c2ab8SKevin Wolf int job_apply_verb(Job *job, JobVerb verb, Error **errp) 182a50c2ab8SKevin Wolf { 183a50c2ab8SKevin Wolf JobStatus s0 = job->status; 184a50c2ab8SKevin Wolf assert(verb >= 0 && verb <= JOB_VERB__MAX); 185a50c2ab8SKevin Wolf trace_job_apply_verb(job, JobStatus_str(s0), JobVerb_str(verb), 186a50c2ab8SKevin Wolf JobVerbTable[verb][s0] ? "allowed" : "prohibited"); 187a50c2ab8SKevin Wolf if (JobVerbTable[verb][s0]) { 188a50c2ab8SKevin Wolf return 0; 189a50c2ab8SKevin Wolf } 190a50c2ab8SKevin Wolf error_setg(errp, "Job '%s' in state '%s' cannot accept command verb '%s'", 191a50c2ab8SKevin Wolf job->id, JobStatus_str(s0), JobVerb_str(verb)); 192a50c2ab8SKevin Wolf return -EPERM; 193a50c2ab8SKevin Wolf } 194a50c2ab8SKevin Wolf 195252291eaSKevin Wolf JobType job_type(const Job *job) 196252291eaSKevin Wolf { 197252291eaSKevin Wolf return job->driver->job_type; 198252291eaSKevin Wolf } 199252291eaSKevin Wolf 200252291eaSKevin Wolf const char *job_type_str(const Job *job) 201252291eaSKevin Wolf { 202252291eaSKevin Wolf return JobType_str(job_type(job)); 203252291eaSKevin Wolf } 204252291eaSKevin Wolf 205daa7f2f9SKevin Wolf bool job_is_cancelled(Job *job) 206daa7f2f9SKevin Wolf { 207daa7f2f9SKevin Wolf return job->cancelled; 208daa7f2f9SKevin Wolf } 209daa7f2f9SKevin Wolf 210df956ae2SKevin Wolf bool job_is_ready(Job *job) 211df956ae2SKevin Wolf { 212df956ae2SKevin Wolf switch (job->status) { 213df956ae2SKevin Wolf case JOB_STATUS_UNDEFINED: 214df956ae2SKevin Wolf case JOB_STATUS_CREATED: 215df956ae2SKevin Wolf case JOB_STATUS_RUNNING: 216df956ae2SKevin Wolf case JOB_STATUS_PAUSED: 217df956ae2SKevin Wolf case JOB_STATUS_WAITING: 218df956ae2SKevin Wolf case JOB_STATUS_PENDING: 219df956ae2SKevin Wolf case JOB_STATUS_ABORTING: 220df956ae2SKevin Wolf case JOB_STATUS_CONCLUDED: 221df956ae2SKevin Wolf case JOB_STATUS_NULL: 222df956ae2SKevin Wolf return false; 223df956ae2SKevin Wolf case JOB_STATUS_READY: 224df956ae2SKevin Wolf case JOB_STATUS_STANDBY: 225df956ae2SKevin Wolf return true; 226df956ae2SKevin Wolf default: 227df956ae2SKevin Wolf g_assert_not_reached(); 228df956ae2SKevin Wolf } 229df956ae2SKevin Wolf return false; 230df956ae2SKevin Wolf } 231df956ae2SKevin Wolf 232dbe5e6c1SKevin Wolf bool job_is_completed(Job *job) 233dbe5e6c1SKevin Wolf { 234dbe5e6c1SKevin Wolf switch (job->status) { 235dbe5e6c1SKevin Wolf case JOB_STATUS_UNDEFINED: 236dbe5e6c1SKevin Wolf case JOB_STATUS_CREATED: 237dbe5e6c1SKevin Wolf case JOB_STATUS_RUNNING: 238dbe5e6c1SKevin Wolf case JOB_STATUS_PAUSED: 239dbe5e6c1SKevin Wolf case JOB_STATUS_READY: 240dbe5e6c1SKevin Wolf case JOB_STATUS_STANDBY: 241dbe5e6c1SKevin Wolf return false; 242dbe5e6c1SKevin Wolf case JOB_STATUS_WAITING: 243dbe5e6c1SKevin Wolf case JOB_STATUS_PENDING: 244dbe5e6c1SKevin Wolf case JOB_STATUS_ABORTING: 245dbe5e6c1SKevin Wolf case JOB_STATUS_CONCLUDED: 246dbe5e6c1SKevin Wolf case JOB_STATUS_NULL: 247dbe5e6c1SKevin Wolf return true; 248dbe5e6c1SKevin Wolf default: 249dbe5e6c1SKevin Wolf g_assert_not_reached(); 250dbe5e6c1SKevin Wolf } 251dbe5e6c1SKevin Wolf return false; 252dbe5e6c1SKevin Wolf } 253dbe5e6c1SKevin Wolf 2543d70ff53SKevin Wolf static bool job_started(Job *job) 255da01ff7fSKevin Wolf { 256da01ff7fSKevin Wolf return job->co; 257da01ff7fSKevin Wolf } 258da01ff7fSKevin Wolf 259198c49ccSKevin Wolf static bool job_should_pause(Job *job) 260da01ff7fSKevin Wolf { 261da01ff7fSKevin Wolf return job->pause_count > 0; 262da01ff7fSKevin Wolf } 263da01ff7fSKevin Wolf 264e7c1d78bSKevin Wolf Job *job_next(Job *job) 265e7c1d78bSKevin Wolf { 266e7c1d78bSKevin Wolf if (!job) { 267e7c1d78bSKevin Wolf return QLIST_FIRST(&jobs); 268e7c1d78bSKevin Wolf } 269e7c1d78bSKevin Wolf return QLIST_NEXT(job, job_list); 270e7c1d78bSKevin Wolf } 271e7c1d78bSKevin Wolf 272e7c1d78bSKevin Wolf Job *job_get(const char *id) 273e7c1d78bSKevin Wolf { 274e7c1d78bSKevin Wolf Job *job; 275e7c1d78bSKevin Wolf 276e7c1d78bSKevin Wolf QLIST_FOREACH(job, &jobs, job_list) { 277e7c1d78bSKevin Wolf if (job->id && !strcmp(id, job->id)) { 278e7c1d78bSKevin Wolf return job; 279e7c1d78bSKevin Wolf } 280e7c1d78bSKevin Wolf } 281e7c1d78bSKevin Wolf 282e7c1d78bSKevin Wolf return NULL; 283e7c1d78bSKevin Wolf } 284e7c1d78bSKevin Wolf 2855d43e86eSKevin Wolf static void job_sleep_timer_cb(void *opaque) 2865d43e86eSKevin Wolf { 2875d43e86eSKevin Wolf Job *job = opaque; 2885d43e86eSKevin Wolf 2895d43e86eSKevin Wolf job_enter(job); 2905d43e86eSKevin Wolf } 2915d43e86eSKevin Wolf 2927eaa8fb5SKevin Wolf void *job_create(const char *job_id, const JobDriver *driver, JobTxn *txn, 2937eaa8fb5SKevin Wolf AioContext *ctx, int flags, BlockCompletionFunc *cb, 2947eaa8fb5SKevin Wolf void *opaque, Error **errp) 29533e9e9bdSKevin Wolf { 29633e9e9bdSKevin Wolf Job *job; 29733e9e9bdSKevin Wolf 29833e9e9bdSKevin Wolf if (job_id) { 299bb02b65cSKevin Wolf if (flags & JOB_INTERNAL) { 300bb02b65cSKevin Wolf error_setg(errp, "Cannot specify job ID for internal job"); 301bb02b65cSKevin Wolf return NULL; 302bb02b65cSKevin Wolf } 30333e9e9bdSKevin Wolf if (!id_wellformed(job_id)) { 30433e9e9bdSKevin Wolf error_setg(errp, "Invalid job ID '%s'", job_id); 30533e9e9bdSKevin Wolf return NULL; 30633e9e9bdSKevin Wolf } 307e7c1d78bSKevin Wolf if (job_get(job_id)) { 308e7c1d78bSKevin Wolf error_setg(errp, "Job ID '%s' already in use", job_id); 309e7c1d78bSKevin Wolf return NULL; 310e7c1d78bSKevin Wolf } 311bb02b65cSKevin Wolf } else if (!(flags & JOB_INTERNAL)) { 312bb02b65cSKevin Wolf error_setg(errp, "An explicit job ID is required"); 313bb02b65cSKevin Wolf return NULL; 31433e9e9bdSKevin Wolf } 31533e9e9bdSKevin Wolf 31633e9e9bdSKevin Wolf job = g_malloc0(driver->instance_size); 31733e9e9bdSKevin Wolf job->driver = driver; 31833e9e9bdSKevin Wolf job->id = g_strdup(job_id); 31980fa2c75SKevin Wolf job->refcnt = 1; 32008be6fe2SKevin Wolf job->aio_context = ctx; 321da01ff7fSKevin Wolf job->busy = false; 322da01ff7fSKevin Wolf job->paused = true; 323da01ff7fSKevin Wolf job->pause_count = 1; 324bb02b65cSKevin Wolf job->auto_finalize = !(flags & JOB_MANUAL_FINALIZE); 325bb02b65cSKevin Wolf job->auto_dismiss = !(flags & JOB_MANUAL_DISMISS); 3264ad35181SKevin Wolf job->cb = cb; 3274ad35181SKevin Wolf job->opaque = opaque; 32833e9e9bdSKevin Wolf 329139a9f02SKevin Wolf notifier_list_init(&job->on_finalize_cancelled); 330139a9f02SKevin Wolf notifier_list_init(&job->on_finalize_completed); 331139a9f02SKevin Wolf notifier_list_init(&job->on_pending); 3322e1795b5SKevin Wolf notifier_list_init(&job->on_ready); 333139a9f02SKevin Wolf 334a50c2ab8SKevin Wolf job_state_transition(job, JOB_STATUS_CREATED); 3355d43e86eSKevin Wolf aio_timer_init(qemu_get_aio_context(), &job->sleep_timer, 3365d43e86eSKevin Wolf QEMU_CLOCK_REALTIME, SCALE_NS, 3375d43e86eSKevin Wolf job_sleep_timer_cb, job); 338a50c2ab8SKevin Wolf 339e7c1d78bSKevin Wolf QLIST_INSERT_HEAD(&jobs, job, job_list); 340e7c1d78bSKevin Wolf 3417eaa8fb5SKevin Wolf /* Single jobs are modeled as single-job transactions for sake of 3427eaa8fb5SKevin Wolf * consolidating the job management logic */ 3437eaa8fb5SKevin Wolf if (!txn) { 3447eaa8fb5SKevin Wolf txn = job_txn_new(); 3457eaa8fb5SKevin Wolf job_txn_add_job(txn, job); 3467eaa8fb5SKevin Wolf job_txn_unref(txn); 3477eaa8fb5SKevin Wolf } else { 3487eaa8fb5SKevin Wolf job_txn_add_job(txn, job); 3497eaa8fb5SKevin Wolf } 3507eaa8fb5SKevin Wolf 35133e9e9bdSKevin Wolf return job; 35233e9e9bdSKevin Wolf } 353fd61a701SKevin Wolf 35480fa2c75SKevin Wolf void job_ref(Job *job) 355fd61a701SKevin Wolf { 35680fa2c75SKevin Wolf ++job->refcnt; 35780fa2c75SKevin Wolf } 35880fa2c75SKevin Wolf 35980fa2c75SKevin Wolf void job_unref(Job *job) 36080fa2c75SKevin Wolf { 36180fa2c75SKevin Wolf if (--job->refcnt == 0) { 36280fa2c75SKevin Wolf assert(job->status == JOB_STATUS_NULL); 3635d43e86eSKevin Wolf assert(!timer_pending(&job->sleep_timer)); 3647eaa8fb5SKevin Wolf assert(!job->txn); 36580fa2c75SKevin Wolf 36680fa2c75SKevin Wolf if (job->driver->free) { 36780fa2c75SKevin Wolf job->driver->free(job); 36880fa2c75SKevin Wolf } 36980fa2c75SKevin Wolf 370e7c1d78bSKevin Wolf QLIST_REMOVE(job, job_list); 371e7c1d78bSKevin Wolf 3723d1f8b07SJohn Snow error_free(job->err); 373fd61a701SKevin Wolf g_free(job->id); 374fd61a701SKevin Wolf g_free(job); 375fd61a701SKevin Wolf } 37680fa2c75SKevin Wolf } 3771908a559SKevin Wolf 37830a5c887SKevin Wolf void job_progress_update(Job *job, uint64_t done) 37930a5c887SKevin Wolf { 38030a5c887SKevin Wolf job->progress_current += done; 38130a5c887SKevin Wolf } 38230a5c887SKevin Wolf 38330a5c887SKevin Wolf void job_progress_set_remaining(Job *job, uint64_t remaining) 38430a5c887SKevin Wolf { 38530a5c887SKevin Wolf job->progress_total = job->progress_current + remaining; 38630a5c887SKevin Wolf } 38730a5c887SKevin Wolf 38862f13600SMax Reitz void job_progress_increase_remaining(Job *job, uint64_t delta) 38962f13600SMax Reitz { 39062f13600SMax Reitz job->progress_total += delta; 39162f13600SMax Reitz } 39262f13600SMax Reitz 393139a9f02SKevin Wolf void job_event_cancelled(Job *job) 394139a9f02SKevin Wolf { 395139a9f02SKevin Wolf notifier_list_notify(&job->on_finalize_cancelled, job); 396139a9f02SKevin Wolf } 397139a9f02SKevin Wolf 398139a9f02SKevin Wolf void job_event_completed(Job *job) 399139a9f02SKevin Wolf { 400139a9f02SKevin Wolf notifier_list_notify(&job->on_finalize_completed, job); 401139a9f02SKevin Wolf } 402139a9f02SKevin Wolf 4037eaa8fb5SKevin Wolf static void job_event_pending(Job *job) 404139a9f02SKevin Wolf { 405139a9f02SKevin Wolf notifier_list_notify(&job->on_pending, job); 406139a9f02SKevin Wolf } 407139a9f02SKevin Wolf 4082e1795b5SKevin Wolf static void job_event_ready(Job *job) 4092e1795b5SKevin Wolf { 4102e1795b5SKevin Wolf notifier_list_notify(&job->on_ready, job); 4112e1795b5SKevin Wolf } 4122e1795b5SKevin Wolf 413da01ff7fSKevin Wolf void job_enter_cond(Job *job, bool(*fn)(Job *job)) 414da01ff7fSKevin Wolf { 415da01ff7fSKevin Wolf if (!job_started(job)) { 416da01ff7fSKevin Wolf return; 417da01ff7fSKevin Wolf } 418da01ff7fSKevin Wolf if (job->deferred_to_main_loop) { 419da01ff7fSKevin Wolf return; 420da01ff7fSKevin Wolf } 421da01ff7fSKevin Wolf 422da01ff7fSKevin Wolf job_lock(); 423da01ff7fSKevin Wolf if (job->busy) { 424da01ff7fSKevin Wolf job_unlock(); 425da01ff7fSKevin Wolf return; 426da01ff7fSKevin Wolf } 427da01ff7fSKevin Wolf 428da01ff7fSKevin Wolf if (fn && !fn(job)) { 429da01ff7fSKevin Wolf job_unlock(); 430da01ff7fSKevin Wolf return; 431da01ff7fSKevin Wolf } 432da01ff7fSKevin Wolf 433da01ff7fSKevin Wolf assert(!job->deferred_to_main_loop); 434da01ff7fSKevin Wolf timer_del(&job->sleep_timer); 435da01ff7fSKevin Wolf job->busy = true; 436da01ff7fSKevin Wolf job_unlock(); 437da01ff7fSKevin Wolf aio_co_wake(job->co); 438da01ff7fSKevin Wolf } 439da01ff7fSKevin Wolf 4405d43e86eSKevin Wolf void job_enter(Job *job) 4415d43e86eSKevin Wolf { 4425d43e86eSKevin Wolf job_enter_cond(job, NULL); 4435d43e86eSKevin Wolf } 4445d43e86eSKevin Wolf 445da01ff7fSKevin Wolf /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds. 4463d70ff53SKevin Wolf * Reentering the job coroutine with job_enter() before the timer has expired 4473d70ff53SKevin Wolf * is allowed and cancels the timer. 448da01ff7fSKevin Wolf * 4493d70ff53SKevin Wolf * If @ns is (uint64_t) -1, no timer is scheduled and job_enter() must be 450da01ff7fSKevin Wolf * called explicitly. */ 451198c49ccSKevin Wolf static void coroutine_fn job_do_yield(Job *job, uint64_t ns) 452da01ff7fSKevin Wolf { 453da01ff7fSKevin Wolf job_lock(); 454da01ff7fSKevin Wolf if (ns != -1) { 455da01ff7fSKevin Wolf timer_mod(&job->sleep_timer, ns); 456da01ff7fSKevin Wolf } 457da01ff7fSKevin Wolf job->busy = false; 458da01ff7fSKevin Wolf job_unlock(); 459da01ff7fSKevin Wolf qemu_coroutine_yield(); 460da01ff7fSKevin Wolf 461da01ff7fSKevin Wolf /* Set by job_enter_cond() before re-entering the coroutine. */ 462da01ff7fSKevin Wolf assert(job->busy); 463da01ff7fSKevin Wolf } 464da01ff7fSKevin Wolf 465da01ff7fSKevin Wolf void coroutine_fn job_pause_point(Job *job) 466da01ff7fSKevin Wolf { 467da01ff7fSKevin Wolf assert(job && job_started(job)); 468da01ff7fSKevin Wolf 469da01ff7fSKevin Wolf if (!job_should_pause(job)) { 470da01ff7fSKevin Wolf return; 471da01ff7fSKevin Wolf } 472da01ff7fSKevin Wolf if (job_is_cancelled(job)) { 473da01ff7fSKevin Wolf return; 474da01ff7fSKevin Wolf } 475da01ff7fSKevin Wolf 476da01ff7fSKevin Wolf if (job->driver->pause) { 477da01ff7fSKevin Wolf job->driver->pause(job); 478da01ff7fSKevin Wolf } 479da01ff7fSKevin Wolf 480da01ff7fSKevin Wolf if (job_should_pause(job) && !job_is_cancelled(job)) { 481da01ff7fSKevin Wolf JobStatus status = job->status; 482da01ff7fSKevin Wolf job_state_transition(job, status == JOB_STATUS_READY 483da01ff7fSKevin Wolf ? JOB_STATUS_STANDBY 484da01ff7fSKevin Wolf : JOB_STATUS_PAUSED); 485da01ff7fSKevin Wolf job->paused = true; 486da01ff7fSKevin Wolf job_do_yield(job, -1); 487da01ff7fSKevin Wolf job->paused = false; 488da01ff7fSKevin Wolf job_state_transition(job, status); 489da01ff7fSKevin Wolf } 490da01ff7fSKevin Wolf 491da01ff7fSKevin Wolf if (job->driver->resume) { 492da01ff7fSKevin Wolf job->driver->resume(job); 493da01ff7fSKevin Wolf } 494da01ff7fSKevin Wolf } 495da01ff7fSKevin Wolf 496198c49ccSKevin Wolf void job_yield(Job *job) 497198c49ccSKevin Wolf { 498198c49ccSKevin Wolf assert(job->busy); 499198c49ccSKevin Wolf 500198c49ccSKevin Wolf /* Check cancellation *before* setting busy = false, too! */ 501198c49ccSKevin Wolf if (job_is_cancelled(job)) { 502198c49ccSKevin Wolf return; 503198c49ccSKevin Wolf } 504198c49ccSKevin Wolf 505198c49ccSKevin Wolf if (!job_should_pause(job)) { 506198c49ccSKevin Wolf job_do_yield(job, -1); 507198c49ccSKevin Wolf } 508198c49ccSKevin Wolf 509198c49ccSKevin Wolf job_pause_point(job); 510198c49ccSKevin Wolf } 511198c49ccSKevin Wolf 5125d43e86eSKevin Wolf void coroutine_fn job_sleep_ns(Job *job, int64_t ns) 5135d43e86eSKevin Wolf { 5145d43e86eSKevin Wolf assert(job->busy); 5155d43e86eSKevin Wolf 5165d43e86eSKevin Wolf /* Check cancellation *before* setting busy = false, too! */ 5175d43e86eSKevin Wolf if (job_is_cancelled(job)) { 5185d43e86eSKevin Wolf return; 5195d43e86eSKevin Wolf } 5205d43e86eSKevin Wolf 5215d43e86eSKevin Wolf if (!job_should_pause(job)) { 5225d43e86eSKevin Wolf job_do_yield(job, qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + ns); 5235d43e86eSKevin Wolf } 5245d43e86eSKevin Wolf 5255d43e86eSKevin Wolf job_pause_point(job); 5265d43e86eSKevin Wolf } 5275d43e86eSKevin Wolf 528b69f777dSKevin Wolf void job_drain(Job *job) 529b69f777dSKevin Wolf { 530b69f777dSKevin Wolf /* If job is !busy this kicks it into the next pause point. */ 531b69f777dSKevin Wolf job_enter(job); 532b69f777dSKevin Wolf 533b69f777dSKevin Wolf if (job->driver->drain) { 534b69f777dSKevin Wolf job->driver->drain(job); 535b69f777dSKevin Wolf } 536b69f777dSKevin Wolf } 537b69f777dSKevin Wolf 538b15de828SKevin Wolf /* Assumes the block_job_mutex is held */ 539b15de828SKevin Wolf static bool job_timer_not_pending(Job *job) 540b15de828SKevin Wolf { 541b15de828SKevin Wolf return !timer_pending(&job->sleep_timer); 542b15de828SKevin Wolf } 543b15de828SKevin Wolf 544b15de828SKevin Wolf void job_pause(Job *job) 545b15de828SKevin Wolf { 546b15de828SKevin Wolf job->pause_count++; 547b15de828SKevin Wolf } 548b15de828SKevin Wolf 549b15de828SKevin Wolf void job_resume(Job *job) 550b15de828SKevin Wolf { 551b15de828SKevin Wolf assert(job->pause_count > 0); 552b15de828SKevin Wolf job->pause_count--; 553b15de828SKevin Wolf if (job->pause_count) { 554b15de828SKevin Wolf return; 555b15de828SKevin Wolf } 556b15de828SKevin Wolf 557b15de828SKevin Wolf /* kick only if no timer is pending */ 558b15de828SKevin Wolf job_enter_cond(job, job_timer_not_pending); 559b15de828SKevin Wolf } 560b15de828SKevin Wolf 561b15de828SKevin Wolf void job_user_pause(Job *job, Error **errp) 562b15de828SKevin Wolf { 563b15de828SKevin Wolf if (job_apply_verb(job, JOB_VERB_PAUSE, errp)) { 564b15de828SKevin Wolf return; 565b15de828SKevin Wolf } 566b15de828SKevin Wolf if (job->user_paused) { 567b15de828SKevin Wolf error_setg(errp, "Job is already paused"); 568b15de828SKevin Wolf return; 569b15de828SKevin Wolf } 570b15de828SKevin Wolf job->user_paused = true; 571b15de828SKevin Wolf job_pause(job); 572b15de828SKevin Wolf } 573b15de828SKevin Wolf 574b15de828SKevin Wolf bool job_user_paused(Job *job) 575b15de828SKevin Wolf { 576b15de828SKevin Wolf return job->user_paused; 577b15de828SKevin Wolf } 578b15de828SKevin Wolf 579b15de828SKevin Wolf void job_user_resume(Job *job, Error **errp) 580b15de828SKevin Wolf { 581b15de828SKevin Wolf assert(job); 582b15de828SKevin Wolf if (!job->user_paused || job->pause_count <= 0) { 583b15de828SKevin Wolf error_setg(errp, "Can't resume a job that was not paused"); 584b15de828SKevin Wolf return; 585b15de828SKevin Wolf } 586b15de828SKevin Wolf if (job_apply_verb(job, JOB_VERB_RESUME, errp)) { 587b15de828SKevin Wolf return; 588b15de828SKevin Wolf } 589b15de828SKevin Wolf if (job->driver->user_resume) { 590b15de828SKevin Wolf job->driver->user_resume(job); 591b15de828SKevin Wolf } 592b15de828SKevin Wolf job->user_paused = false; 593b15de828SKevin Wolf job_resume(job); 594b15de828SKevin Wolf } 595b15de828SKevin Wolf 5965f9a6a08SKevin Wolf static void job_do_dismiss(Job *job) 5974ad35181SKevin Wolf { 5984ad35181SKevin Wolf assert(job); 5994ad35181SKevin Wolf job->busy = false; 6004ad35181SKevin Wolf job->paused = false; 6014ad35181SKevin Wolf job->deferred_to_main_loop = true; 6024ad35181SKevin Wolf 6037eaa8fb5SKevin Wolf job_txn_del_job(job); 6044ad35181SKevin Wolf 6054ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_NULL); 6064ad35181SKevin Wolf job_unref(job); 6074ad35181SKevin Wolf } 6084ad35181SKevin Wolf 6095f9a6a08SKevin Wolf void job_dismiss(Job **jobptr, Error **errp) 6105f9a6a08SKevin Wolf { 6115f9a6a08SKevin Wolf Job *job = *jobptr; 6125f9a6a08SKevin Wolf /* similarly to _complete, this is QMP-interface only. */ 6135f9a6a08SKevin Wolf assert(job->id); 6145f9a6a08SKevin Wolf if (job_apply_verb(job, JOB_VERB_DISMISS, errp)) { 6155f9a6a08SKevin Wolf return; 6165f9a6a08SKevin Wolf } 6175f9a6a08SKevin Wolf 6185f9a6a08SKevin Wolf job_do_dismiss(job); 6195f9a6a08SKevin Wolf *jobptr = NULL; 6205f9a6a08SKevin Wolf } 6215f9a6a08SKevin Wolf 6224ad35181SKevin Wolf void job_early_fail(Job *job) 6234ad35181SKevin Wolf { 6244ad35181SKevin Wolf assert(job->status == JOB_STATUS_CREATED); 6254ad35181SKevin Wolf job_do_dismiss(job); 6264ad35181SKevin Wolf } 6274ad35181SKevin Wolf 6284ad35181SKevin Wolf static void job_conclude(Job *job) 6294ad35181SKevin Wolf { 6304ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_CONCLUDED); 6314ad35181SKevin Wolf if (job->auto_dismiss || !job_started(job)) { 6324ad35181SKevin Wolf job_do_dismiss(job); 6334ad35181SKevin Wolf } 6344ad35181SKevin Wolf } 6354ad35181SKevin Wolf 6363d70ff53SKevin Wolf static void job_update_rc(Job *job) 6374ad35181SKevin Wolf { 6384ad35181SKevin Wolf if (!job->ret && job_is_cancelled(job)) { 6394ad35181SKevin Wolf job->ret = -ECANCELED; 6404ad35181SKevin Wolf } 6414ad35181SKevin Wolf if (job->ret) { 6423d1f8b07SJohn Snow if (!job->err) { 6433d1f8b07SJohn Snow error_setg(&job->err, "%s", strerror(-job->ret)); 6441266c9b9SKevin Wolf } 6454ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_ABORTING); 6464ad35181SKevin Wolf } 6474ad35181SKevin Wolf } 6484ad35181SKevin Wolf 6494ad35181SKevin Wolf static void job_commit(Job *job) 6504ad35181SKevin Wolf { 6514ad35181SKevin Wolf assert(!job->ret); 6524ad35181SKevin Wolf if (job->driver->commit) { 6534ad35181SKevin Wolf job->driver->commit(job); 6544ad35181SKevin Wolf } 6554ad35181SKevin Wolf } 6564ad35181SKevin Wolf 6574ad35181SKevin Wolf static void job_abort(Job *job) 6584ad35181SKevin Wolf { 6594ad35181SKevin Wolf assert(job->ret); 6604ad35181SKevin Wolf if (job->driver->abort) { 6614ad35181SKevin Wolf job->driver->abort(job); 6624ad35181SKevin Wolf } 6634ad35181SKevin Wolf } 6644ad35181SKevin Wolf 6654ad35181SKevin Wolf static void job_clean(Job *job) 6664ad35181SKevin Wolf { 6674ad35181SKevin Wolf if (job->driver->clean) { 6684ad35181SKevin Wolf job->driver->clean(job); 6694ad35181SKevin Wolf } 6704ad35181SKevin Wolf } 6714ad35181SKevin Wolf 6727eaa8fb5SKevin Wolf static int job_finalize_single(Job *job) 6734ad35181SKevin Wolf { 6744ad35181SKevin Wolf assert(job_is_completed(job)); 6754ad35181SKevin Wolf 6764ad35181SKevin Wolf /* Ensure abort is called for late-transactional failures */ 6774ad35181SKevin Wolf job_update_rc(job); 6784ad35181SKevin Wolf 6794ad35181SKevin Wolf if (!job->ret) { 6804ad35181SKevin Wolf job_commit(job); 6814ad35181SKevin Wolf } else { 6824ad35181SKevin Wolf job_abort(job); 6834ad35181SKevin Wolf } 6844ad35181SKevin Wolf job_clean(job); 6854ad35181SKevin Wolf 6864ad35181SKevin Wolf if (job->cb) { 6874ad35181SKevin Wolf job->cb(job->opaque, job->ret); 6884ad35181SKevin Wolf } 6894ad35181SKevin Wolf 6904ad35181SKevin Wolf /* Emit events only if we actually started */ 6914ad35181SKevin Wolf if (job_started(job)) { 6924ad35181SKevin Wolf if (job_is_cancelled(job)) { 6934ad35181SKevin Wolf job_event_cancelled(job); 6944ad35181SKevin Wolf } else { 6954ad35181SKevin Wolf job_event_completed(job); 6964ad35181SKevin Wolf } 6974ad35181SKevin Wolf } 6984ad35181SKevin Wolf 6997eaa8fb5SKevin Wolf job_txn_del_job(job); 7004ad35181SKevin Wolf job_conclude(job); 7014ad35181SKevin Wolf return 0; 7024ad35181SKevin Wolf } 7034ad35181SKevin Wolf 7043d70ff53SKevin Wolf static void job_cancel_async(Job *job, bool force) 7057eaa8fb5SKevin Wolf { 7067eaa8fb5SKevin Wolf if (job->user_paused) { 7077eaa8fb5SKevin Wolf /* Do not call job_enter here, the caller will handle it. */ 7087eaa8fb5SKevin Wolf if (job->driver->user_resume) { 7097eaa8fb5SKevin Wolf job->driver->user_resume(job); 7107eaa8fb5SKevin Wolf } 711e321c059SJeff Cody job->user_paused = false; 7127eaa8fb5SKevin Wolf assert(job->pause_count > 0); 7137eaa8fb5SKevin Wolf job->pause_count--; 7147eaa8fb5SKevin Wolf } 7157eaa8fb5SKevin Wolf job->cancelled = true; 7167eaa8fb5SKevin Wolf /* To prevent 'force == false' overriding a previous 'force == true' */ 7177eaa8fb5SKevin Wolf job->force_cancel |= force; 7187eaa8fb5SKevin Wolf } 7197eaa8fb5SKevin Wolf 7203d70ff53SKevin Wolf static void job_completed_txn_abort(Job *job) 7217eaa8fb5SKevin Wolf { 7227eaa8fb5SKevin Wolf AioContext *ctx; 7237eaa8fb5SKevin Wolf JobTxn *txn = job->txn; 7247eaa8fb5SKevin Wolf Job *other_job; 7257eaa8fb5SKevin Wolf 7267eaa8fb5SKevin Wolf if (txn->aborting) { 7277eaa8fb5SKevin Wolf /* 7287eaa8fb5SKevin Wolf * We are cancelled by another job, which will handle everything. 7297eaa8fb5SKevin Wolf */ 7307eaa8fb5SKevin Wolf return; 7317eaa8fb5SKevin Wolf } 7327eaa8fb5SKevin Wolf txn->aborting = true; 7337eaa8fb5SKevin Wolf job_txn_ref(txn); 7347eaa8fb5SKevin Wolf 7357eaa8fb5SKevin Wolf /* We are the first failed job. Cancel other jobs. */ 7367eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 7377eaa8fb5SKevin Wolf ctx = other_job->aio_context; 7387eaa8fb5SKevin Wolf aio_context_acquire(ctx); 7397eaa8fb5SKevin Wolf } 7407eaa8fb5SKevin Wolf 7417eaa8fb5SKevin Wolf /* Other jobs are effectively cancelled by us, set the status for 7427eaa8fb5SKevin Wolf * them; this job, however, may or may not be cancelled, depending 7437eaa8fb5SKevin Wolf * on the caller, so leave it. */ 7447eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 7457eaa8fb5SKevin Wolf if (other_job != job) { 7467eaa8fb5SKevin Wolf job_cancel_async(other_job, false); 7477eaa8fb5SKevin Wolf } 7487eaa8fb5SKevin Wolf } 7497eaa8fb5SKevin Wolf while (!QLIST_EMPTY(&txn->jobs)) { 7507eaa8fb5SKevin Wolf other_job = QLIST_FIRST(&txn->jobs); 7517eaa8fb5SKevin Wolf ctx = other_job->aio_context; 7527eaa8fb5SKevin Wolf if (!job_is_completed(other_job)) { 7537eaa8fb5SKevin Wolf assert(job_is_cancelled(other_job)); 7547eaa8fb5SKevin Wolf job_finish_sync(other_job, NULL, NULL); 7557eaa8fb5SKevin Wolf } 7567eaa8fb5SKevin Wolf job_finalize_single(other_job); 7577eaa8fb5SKevin Wolf aio_context_release(ctx); 7587eaa8fb5SKevin Wolf } 7597eaa8fb5SKevin Wolf 7607eaa8fb5SKevin Wolf job_txn_unref(txn); 7617eaa8fb5SKevin Wolf } 7627eaa8fb5SKevin Wolf 7637eaa8fb5SKevin Wolf static int job_prepare(Job *job) 7647eaa8fb5SKevin Wolf { 7657eaa8fb5SKevin Wolf if (job->ret == 0 && job->driver->prepare) { 7667eaa8fb5SKevin Wolf job->ret = job->driver->prepare(job); 7671266c9b9SKevin Wolf job_update_rc(job); 7687eaa8fb5SKevin Wolf } 7697eaa8fb5SKevin Wolf return job->ret; 7707eaa8fb5SKevin Wolf } 7717eaa8fb5SKevin Wolf 7727eaa8fb5SKevin Wolf static int job_needs_finalize(Job *job) 7737eaa8fb5SKevin Wolf { 7747eaa8fb5SKevin Wolf return !job->auto_finalize; 7757eaa8fb5SKevin Wolf } 7767eaa8fb5SKevin Wolf 7777eaa8fb5SKevin Wolf static void job_do_finalize(Job *job) 7787eaa8fb5SKevin Wolf { 7797eaa8fb5SKevin Wolf int rc; 7807eaa8fb5SKevin Wolf assert(job && job->txn); 7817eaa8fb5SKevin Wolf 7827eaa8fb5SKevin Wolf /* prepare the transaction to complete */ 7837eaa8fb5SKevin Wolf rc = job_txn_apply(job->txn, job_prepare, true); 7847eaa8fb5SKevin Wolf if (rc) { 7857eaa8fb5SKevin Wolf job_completed_txn_abort(job); 7867eaa8fb5SKevin Wolf } else { 7877eaa8fb5SKevin Wolf job_txn_apply(job->txn, job_finalize_single, true); 7887eaa8fb5SKevin Wolf } 7897eaa8fb5SKevin Wolf } 7907eaa8fb5SKevin Wolf 7917eaa8fb5SKevin Wolf void job_finalize(Job *job, Error **errp) 7927eaa8fb5SKevin Wolf { 7937eaa8fb5SKevin Wolf assert(job && job->id); 7947eaa8fb5SKevin Wolf if (job_apply_verb(job, JOB_VERB_FINALIZE, errp)) { 7957eaa8fb5SKevin Wolf return; 7967eaa8fb5SKevin Wolf } 7977eaa8fb5SKevin Wolf job_do_finalize(job); 7987eaa8fb5SKevin Wolf } 7997eaa8fb5SKevin Wolf 8007eaa8fb5SKevin Wolf static int job_transition_to_pending(Job *job) 8017eaa8fb5SKevin Wolf { 8027eaa8fb5SKevin Wolf job_state_transition(job, JOB_STATUS_PENDING); 8037eaa8fb5SKevin Wolf if (!job->auto_finalize) { 8047eaa8fb5SKevin Wolf job_event_pending(job); 8057eaa8fb5SKevin Wolf } 8067eaa8fb5SKevin Wolf return 0; 8077eaa8fb5SKevin Wolf } 8087eaa8fb5SKevin Wolf 8092e1795b5SKevin Wolf void job_transition_to_ready(Job *job) 8102e1795b5SKevin Wolf { 8112e1795b5SKevin Wolf job_state_transition(job, JOB_STATUS_READY); 8122e1795b5SKevin Wolf job_event_ready(job); 8132e1795b5SKevin Wolf } 8142e1795b5SKevin Wolf 8153d70ff53SKevin Wolf static void job_completed_txn_success(Job *job) 8167eaa8fb5SKevin Wolf { 8177eaa8fb5SKevin Wolf JobTxn *txn = job->txn; 8187eaa8fb5SKevin Wolf Job *other_job; 8197eaa8fb5SKevin Wolf 8207eaa8fb5SKevin Wolf job_state_transition(job, JOB_STATUS_WAITING); 8217eaa8fb5SKevin Wolf 8227eaa8fb5SKevin Wolf /* 8237eaa8fb5SKevin Wolf * Successful completion, see if there are other running jobs in this 8247eaa8fb5SKevin Wolf * txn. 8257eaa8fb5SKevin Wolf */ 8267eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 8277eaa8fb5SKevin Wolf if (!job_is_completed(other_job)) { 8287eaa8fb5SKevin Wolf return; 8297eaa8fb5SKevin Wolf } 8307eaa8fb5SKevin Wolf assert(other_job->ret == 0); 8317eaa8fb5SKevin Wolf } 8327eaa8fb5SKevin Wolf 8337eaa8fb5SKevin Wolf job_txn_apply(txn, job_transition_to_pending, false); 8347eaa8fb5SKevin Wolf 8357eaa8fb5SKevin Wolf /* If no jobs need manual finalization, automatically do so */ 8367eaa8fb5SKevin Wolf if (job_txn_apply(txn, job_needs_finalize, false) == 0) { 8377eaa8fb5SKevin Wolf job_do_finalize(job); 8387eaa8fb5SKevin Wolf } 8397eaa8fb5SKevin Wolf } 8407eaa8fb5SKevin Wolf 841404ff28dSJohn Snow static void job_completed(Job *job) 8423d70ff53SKevin Wolf { 8433d70ff53SKevin Wolf assert(job && job->txn && !job_is_completed(job)); 8441266c9b9SKevin Wolf 8453d70ff53SKevin Wolf job_update_rc(job); 846404ff28dSJohn Snow trace_job_completed(job, job->ret); 8473d70ff53SKevin Wolf if (job->ret) { 8483d70ff53SKevin Wolf job_completed_txn_abort(job); 8493d70ff53SKevin Wolf } else { 8503d70ff53SKevin Wolf job_completed_txn_success(job); 8513d70ff53SKevin Wolf } 8523d70ff53SKevin Wolf } 8533d70ff53SKevin Wolf 854*ccbfb331SJohn Snow /** Useful only as a type shim for aio_bh_schedule_oneshot. */ 855*ccbfb331SJohn Snow static void job_exit(void *opaque) 856*ccbfb331SJohn Snow { 857*ccbfb331SJohn Snow Job *job = (Job *)opaque; 858*ccbfb331SJohn Snow job_completed(job); 859*ccbfb331SJohn Snow } 860*ccbfb331SJohn Snow 861*ccbfb331SJohn Snow /** 862*ccbfb331SJohn Snow * All jobs must allow a pause point before entering their job proper. This 863*ccbfb331SJohn Snow * ensures that jobs can be paused prior to being started, then resumed later. 864*ccbfb331SJohn Snow */ 865*ccbfb331SJohn Snow static void coroutine_fn job_co_entry(void *opaque) 866*ccbfb331SJohn Snow { 867*ccbfb331SJohn Snow Job *job = opaque; 868*ccbfb331SJohn Snow 869*ccbfb331SJohn Snow assert(job && job->driver && job->driver->run); 870*ccbfb331SJohn Snow job_pause_point(job); 871*ccbfb331SJohn Snow job->ret = job->driver->run(job, &job->err); 872*ccbfb331SJohn Snow job->deferred_to_main_loop = true; 873*ccbfb331SJohn Snow aio_bh_schedule_oneshot(qemu_get_aio_context(), job_exit, job); 874*ccbfb331SJohn Snow } 875*ccbfb331SJohn Snow 876*ccbfb331SJohn Snow void job_start(Job *job) 877*ccbfb331SJohn Snow { 878*ccbfb331SJohn Snow assert(job && !job_started(job) && job->paused && 879*ccbfb331SJohn Snow job->driver && job->driver->run); 880*ccbfb331SJohn Snow job->co = qemu_coroutine_create(job_co_entry, job); 881*ccbfb331SJohn Snow job->pause_count--; 882*ccbfb331SJohn Snow job->busy = true; 883*ccbfb331SJohn Snow job->paused = false; 884*ccbfb331SJohn Snow job_state_transition(job, JOB_STATUS_RUNNING); 885*ccbfb331SJohn Snow aio_co_enter(job->aio_context, job->co); 886*ccbfb331SJohn Snow } 887*ccbfb331SJohn Snow 8883d70ff53SKevin Wolf void job_cancel(Job *job, bool force) 8893d70ff53SKevin Wolf { 8903d70ff53SKevin Wolf if (job->status == JOB_STATUS_CONCLUDED) { 8913d70ff53SKevin Wolf job_do_dismiss(job); 8923d70ff53SKevin Wolf return; 8933d70ff53SKevin Wolf } 8943d70ff53SKevin Wolf job_cancel_async(job, force); 8953d70ff53SKevin Wolf if (!job_started(job)) { 896404ff28dSJohn Snow job_completed(job); 8973d70ff53SKevin Wolf } else if (job->deferred_to_main_loop) { 8983d70ff53SKevin Wolf job_completed_txn_abort(job); 8993d70ff53SKevin Wolf } else { 9003d70ff53SKevin Wolf job_enter(job); 9013d70ff53SKevin Wolf } 9023d70ff53SKevin Wolf } 9033d70ff53SKevin Wolf 9043d70ff53SKevin Wolf void job_user_cancel(Job *job, bool force, Error **errp) 9053d70ff53SKevin Wolf { 9063d70ff53SKevin Wolf if (job_apply_verb(job, JOB_VERB_CANCEL, errp)) { 9073d70ff53SKevin Wolf return; 9083d70ff53SKevin Wolf } 9093d70ff53SKevin Wolf job_cancel(job, force); 9103d70ff53SKevin Wolf } 9113d70ff53SKevin Wolf 9123d70ff53SKevin Wolf /* A wrapper around job_cancel() taking an Error ** parameter so it may be 9133d70ff53SKevin Wolf * used with job_finish_sync() without the need for (rather nasty) function 9143d70ff53SKevin Wolf * pointer casts there. */ 9153d70ff53SKevin Wolf static void job_cancel_err(Job *job, Error **errp) 9163d70ff53SKevin Wolf { 9173d70ff53SKevin Wolf job_cancel(job, false); 9183d70ff53SKevin Wolf } 9193d70ff53SKevin Wolf 9203d70ff53SKevin Wolf int job_cancel_sync(Job *job) 9213d70ff53SKevin Wolf { 9223d70ff53SKevin Wolf return job_finish_sync(job, &job_cancel_err, NULL); 9233d70ff53SKevin Wolf } 9243d70ff53SKevin Wolf 9253d70ff53SKevin Wolf void job_cancel_sync_all(void) 9263d70ff53SKevin Wolf { 9273d70ff53SKevin Wolf Job *job; 9283d70ff53SKevin Wolf AioContext *aio_context; 9293d70ff53SKevin Wolf 9303d70ff53SKevin Wolf while ((job = job_next(NULL))) { 9313d70ff53SKevin Wolf aio_context = job->aio_context; 9323d70ff53SKevin Wolf aio_context_acquire(aio_context); 9333d70ff53SKevin Wolf job_cancel_sync(job); 9343d70ff53SKevin Wolf aio_context_release(aio_context); 9353d70ff53SKevin Wolf } 9363d70ff53SKevin Wolf } 9373d70ff53SKevin Wolf 9383d70ff53SKevin Wolf int job_complete_sync(Job *job, Error **errp) 9393d70ff53SKevin Wolf { 9403d70ff53SKevin Wolf return job_finish_sync(job, job_complete, errp); 9413d70ff53SKevin Wolf } 9423d70ff53SKevin Wolf 9433453d972SKevin Wolf void job_complete(Job *job, Error **errp) 9443453d972SKevin Wolf { 9453453d972SKevin Wolf /* Should not be reachable via external interface for internal jobs */ 9463453d972SKevin Wolf assert(job->id); 9473453d972SKevin Wolf if (job_apply_verb(job, JOB_VERB_COMPLETE, errp)) { 9483453d972SKevin Wolf return; 9493453d972SKevin Wolf } 9503453d972SKevin Wolf if (job->pause_count || job_is_cancelled(job) || !job->driver->complete) { 9513453d972SKevin Wolf error_setg(errp, "The active block job '%s' cannot be completed", 9523453d972SKevin Wolf job->id); 9533453d972SKevin Wolf return; 9543453d972SKevin Wolf } 9553453d972SKevin Wolf 9563453d972SKevin Wolf job->driver->complete(job, errp); 9573453d972SKevin Wolf } 9583453d972SKevin Wolf 9596a74c075SKevin Wolf int job_finish_sync(Job *job, void (*finish)(Job *, Error **errp), Error **errp) 9606a74c075SKevin Wolf { 9616a74c075SKevin Wolf Error *local_err = NULL; 9626a74c075SKevin Wolf int ret; 9636a74c075SKevin Wolf 9646a74c075SKevin Wolf job_ref(job); 9656a74c075SKevin Wolf 9666a74c075SKevin Wolf if (finish) { 9676a74c075SKevin Wolf finish(job, &local_err); 9686a74c075SKevin Wolf } 9696a74c075SKevin Wolf if (local_err) { 9706a74c075SKevin Wolf error_propagate(errp, local_err); 9716a74c075SKevin Wolf job_unref(job); 9726a74c075SKevin Wolf return -EBUSY; 9736a74c075SKevin Wolf } 9746a74c075SKevin Wolf /* job_drain calls job_enter, and it should be enough to induce progress 9756a74c075SKevin Wolf * until the job completes or moves to the main thread. */ 9766a74c075SKevin Wolf while (!job->deferred_to_main_loop && !job_is_completed(job)) { 9776a74c075SKevin Wolf job_drain(job); 9786a74c075SKevin Wolf } 9796a74c075SKevin Wolf while (!job_is_completed(job)) { 9806a74c075SKevin Wolf aio_poll(qemu_get_aio_context(), true); 9816a74c075SKevin Wolf } 9826a74c075SKevin Wolf ret = (job_is_cancelled(job) && job->ret == 0) ? -ECANCELED : job->ret; 9836a74c075SKevin Wolf job_unref(job); 9846a74c075SKevin Wolf return ret; 9856a74c075SKevin Wolf } 986