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 "qapi/error.h" 2833e9e9bdSKevin Wolf #include "qemu/job.h" 2933e9e9bdSKevin Wolf #include "qemu/id.h" 301908a559SKevin Wolf #include "qemu/main-loop.h" 31de0fbe64SKevin Wolf #include "block/aio-wait.h" 32*243af022SPaolo Bonzini #include "trace/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 139b660a84bSStefan Reiter static int job_txn_apply(Job *job, int fn(Job *)) 1407eaa8fb5SKevin Wolf { 141b660a84bSStefan Reiter AioContext *inner_ctx; 142b660a84bSStefan Reiter Job *other_job, *next; 143b660a84bSStefan Reiter JobTxn *txn = job->txn; 1447eaa8fb5SKevin Wolf int rc = 0; 1457eaa8fb5SKevin Wolf 146b660a84bSStefan Reiter /* 147b660a84bSStefan Reiter * Similar to job_completed_txn_abort, we take each job's lock before 148b660a84bSStefan Reiter * applying fn, but since we assume that outer_ctx is held by the caller, 149b660a84bSStefan Reiter * we need to release it here to avoid holding the lock twice - which would 150b660a84bSStefan Reiter * break AIO_WAIT_WHILE from within fn. 151b660a84bSStefan Reiter */ 152b660a84bSStefan Reiter job_ref(job); 153b660a84bSStefan Reiter aio_context_release(job->aio_context); 154b660a84bSStefan Reiter 155b660a84bSStefan Reiter QLIST_FOREACH_SAFE(other_job, &txn->jobs, txn_list, next) { 156b660a84bSStefan Reiter inner_ctx = other_job->aio_context; 157b660a84bSStefan Reiter aio_context_acquire(inner_ctx); 158b660a84bSStefan Reiter rc = fn(other_job); 159b660a84bSStefan Reiter aio_context_release(inner_ctx); 1607eaa8fb5SKevin Wolf if (rc) { 1617eaa8fb5SKevin Wolf break; 1627eaa8fb5SKevin Wolf } 1637eaa8fb5SKevin Wolf } 164b660a84bSStefan Reiter 165b660a84bSStefan Reiter /* 166b660a84bSStefan Reiter * Note that job->aio_context might have been changed by calling fn, so we 167b660a84bSStefan Reiter * can't use a local variable to cache it. 168b660a84bSStefan Reiter */ 169b660a84bSStefan Reiter aio_context_acquire(job->aio_context); 170b660a84bSStefan Reiter job_unref(job); 1717eaa8fb5SKevin Wolf return rc; 1727eaa8fb5SKevin Wolf } 1737eaa8fb5SKevin Wolf 174456273b0SKevin Wolf bool job_is_internal(Job *job) 1751dac83f1SKevin Wolf { 1761dac83f1SKevin Wolf return (job->id == NULL); 1771dac83f1SKevin Wolf } 1781dac83f1SKevin Wolf 1792e1795b5SKevin Wolf static void job_state_transition(Job *job, JobStatus s1) 180a50c2ab8SKevin Wolf { 181a50c2ab8SKevin Wolf JobStatus s0 = job->status; 182c2032289SLiam Merwick assert(s1 >= 0 && s1 < JOB_STATUS__MAX); 1834ad35181SKevin Wolf trace_job_state_transition(job, job->ret, 184a50c2ab8SKevin Wolf JobSTT[s0][s1] ? "allowed" : "disallowed", 185a50c2ab8SKevin Wolf JobStatus_str(s0), JobStatus_str(s1)); 186a50c2ab8SKevin Wolf assert(JobSTT[s0][s1]); 187a50c2ab8SKevin Wolf job->status = s1; 1881dac83f1SKevin Wolf 1891dac83f1SKevin Wolf if (!job_is_internal(job) && s1 != s0) { 1903ab72385SPeter Xu qapi_event_send_job_status_change(job->id, job->status); 1911dac83f1SKevin Wolf } 192a50c2ab8SKevin Wolf } 193a50c2ab8SKevin Wolf 194a50c2ab8SKevin Wolf int job_apply_verb(Job *job, JobVerb verb, Error **errp) 195a50c2ab8SKevin Wolf { 196a50c2ab8SKevin Wolf JobStatus s0 = job->status; 197c2032289SLiam Merwick assert(verb >= 0 && verb < JOB_VERB__MAX); 198a50c2ab8SKevin Wolf trace_job_apply_verb(job, JobStatus_str(s0), JobVerb_str(verb), 199a50c2ab8SKevin Wolf JobVerbTable[verb][s0] ? "allowed" : "prohibited"); 200a50c2ab8SKevin Wolf if (JobVerbTable[verb][s0]) { 201a50c2ab8SKevin Wolf return 0; 202a50c2ab8SKevin Wolf } 203a50c2ab8SKevin Wolf error_setg(errp, "Job '%s' in state '%s' cannot accept command verb '%s'", 204a50c2ab8SKevin Wolf job->id, JobStatus_str(s0), JobVerb_str(verb)); 205a50c2ab8SKevin Wolf return -EPERM; 206a50c2ab8SKevin Wolf } 207a50c2ab8SKevin Wolf 208252291eaSKevin Wolf JobType job_type(const Job *job) 209252291eaSKevin Wolf { 210252291eaSKevin Wolf return job->driver->job_type; 211252291eaSKevin Wolf } 212252291eaSKevin Wolf 213252291eaSKevin Wolf const char *job_type_str(const Job *job) 214252291eaSKevin Wolf { 215252291eaSKevin Wolf return JobType_str(job_type(job)); 216252291eaSKevin Wolf } 217252291eaSKevin Wolf 218daa7f2f9SKevin Wolf bool job_is_cancelled(Job *job) 219daa7f2f9SKevin Wolf { 220daa7f2f9SKevin Wolf return job->cancelled; 221daa7f2f9SKevin Wolf } 222daa7f2f9SKevin Wolf 223df956ae2SKevin Wolf bool job_is_ready(Job *job) 224df956ae2SKevin Wolf { 225df956ae2SKevin Wolf switch (job->status) { 226df956ae2SKevin Wolf case JOB_STATUS_UNDEFINED: 227df956ae2SKevin Wolf case JOB_STATUS_CREATED: 228df956ae2SKevin Wolf case JOB_STATUS_RUNNING: 229df956ae2SKevin Wolf case JOB_STATUS_PAUSED: 230df956ae2SKevin Wolf case JOB_STATUS_WAITING: 231df956ae2SKevin Wolf case JOB_STATUS_PENDING: 232df956ae2SKevin Wolf case JOB_STATUS_ABORTING: 233df956ae2SKevin Wolf case JOB_STATUS_CONCLUDED: 234df956ae2SKevin Wolf case JOB_STATUS_NULL: 235df956ae2SKevin Wolf return false; 236df956ae2SKevin Wolf case JOB_STATUS_READY: 237df956ae2SKevin Wolf case JOB_STATUS_STANDBY: 238df956ae2SKevin Wolf return true; 239df956ae2SKevin Wolf default: 240df956ae2SKevin Wolf g_assert_not_reached(); 241df956ae2SKevin Wolf } 242df956ae2SKevin Wolf return false; 243df956ae2SKevin Wolf } 244df956ae2SKevin Wolf 245dbe5e6c1SKevin Wolf bool job_is_completed(Job *job) 246dbe5e6c1SKevin Wolf { 247dbe5e6c1SKevin Wolf switch (job->status) { 248dbe5e6c1SKevin Wolf case JOB_STATUS_UNDEFINED: 249dbe5e6c1SKevin Wolf case JOB_STATUS_CREATED: 250dbe5e6c1SKevin Wolf case JOB_STATUS_RUNNING: 251dbe5e6c1SKevin Wolf case JOB_STATUS_PAUSED: 252dbe5e6c1SKevin Wolf case JOB_STATUS_READY: 253dbe5e6c1SKevin Wolf case JOB_STATUS_STANDBY: 254dbe5e6c1SKevin Wolf return false; 255dbe5e6c1SKevin Wolf case JOB_STATUS_WAITING: 256dbe5e6c1SKevin Wolf case JOB_STATUS_PENDING: 257dbe5e6c1SKevin Wolf case JOB_STATUS_ABORTING: 258dbe5e6c1SKevin Wolf case JOB_STATUS_CONCLUDED: 259dbe5e6c1SKevin Wolf case JOB_STATUS_NULL: 260dbe5e6c1SKevin Wolf return true; 261dbe5e6c1SKevin Wolf default: 262dbe5e6c1SKevin Wolf g_assert_not_reached(); 263dbe5e6c1SKevin Wolf } 264dbe5e6c1SKevin Wolf return false; 265dbe5e6c1SKevin Wolf } 266dbe5e6c1SKevin Wolf 2673d70ff53SKevin Wolf static bool job_started(Job *job) 268da01ff7fSKevin Wolf { 269da01ff7fSKevin Wolf return job->co; 270da01ff7fSKevin Wolf } 271da01ff7fSKevin Wolf 272198c49ccSKevin Wolf static bool job_should_pause(Job *job) 273da01ff7fSKevin Wolf { 274da01ff7fSKevin Wolf return job->pause_count > 0; 275da01ff7fSKevin Wolf } 276da01ff7fSKevin Wolf 277e7c1d78bSKevin Wolf Job *job_next(Job *job) 278e7c1d78bSKevin Wolf { 279e7c1d78bSKevin Wolf if (!job) { 280e7c1d78bSKevin Wolf return QLIST_FIRST(&jobs); 281e7c1d78bSKevin Wolf } 282e7c1d78bSKevin Wolf return QLIST_NEXT(job, job_list); 283e7c1d78bSKevin Wolf } 284e7c1d78bSKevin Wolf 285e7c1d78bSKevin Wolf Job *job_get(const char *id) 286e7c1d78bSKevin Wolf { 287e7c1d78bSKevin Wolf Job *job; 288e7c1d78bSKevin Wolf 289e7c1d78bSKevin Wolf QLIST_FOREACH(job, &jobs, job_list) { 290e7c1d78bSKevin Wolf if (job->id && !strcmp(id, job->id)) { 291e7c1d78bSKevin Wolf return job; 292e7c1d78bSKevin Wolf } 293e7c1d78bSKevin Wolf } 294e7c1d78bSKevin Wolf 295e7c1d78bSKevin Wolf return NULL; 296e7c1d78bSKevin Wolf } 297e7c1d78bSKevin Wolf 2985d43e86eSKevin Wolf static void job_sleep_timer_cb(void *opaque) 2995d43e86eSKevin Wolf { 3005d43e86eSKevin Wolf Job *job = opaque; 3015d43e86eSKevin Wolf 3025d43e86eSKevin Wolf job_enter(job); 3035d43e86eSKevin Wolf } 3045d43e86eSKevin Wolf 3057eaa8fb5SKevin Wolf void *job_create(const char *job_id, const JobDriver *driver, JobTxn *txn, 3067eaa8fb5SKevin Wolf AioContext *ctx, int flags, BlockCompletionFunc *cb, 3077eaa8fb5SKevin Wolf void *opaque, Error **errp) 30833e9e9bdSKevin Wolf { 30933e9e9bdSKevin Wolf Job *job; 31033e9e9bdSKevin Wolf 31133e9e9bdSKevin Wolf if (job_id) { 312bb02b65cSKevin Wolf if (flags & JOB_INTERNAL) { 313bb02b65cSKevin Wolf error_setg(errp, "Cannot specify job ID for internal job"); 314bb02b65cSKevin Wolf return NULL; 315bb02b65cSKevin Wolf } 31633e9e9bdSKevin Wolf if (!id_wellformed(job_id)) { 31733e9e9bdSKevin Wolf error_setg(errp, "Invalid job ID '%s'", job_id); 31833e9e9bdSKevin Wolf return NULL; 31933e9e9bdSKevin Wolf } 320e7c1d78bSKevin Wolf if (job_get(job_id)) { 321e7c1d78bSKevin Wolf error_setg(errp, "Job ID '%s' already in use", job_id); 322e7c1d78bSKevin Wolf return NULL; 323e7c1d78bSKevin Wolf } 324bb02b65cSKevin Wolf } else if (!(flags & JOB_INTERNAL)) { 325bb02b65cSKevin Wolf error_setg(errp, "An explicit job ID is required"); 326bb02b65cSKevin Wolf return NULL; 32733e9e9bdSKevin Wolf } 32833e9e9bdSKevin Wolf 32933e9e9bdSKevin Wolf job = g_malloc0(driver->instance_size); 33033e9e9bdSKevin Wolf job->driver = driver; 33133e9e9bdSKevin Wolf job->id = g_strdup(job_id); 33280fa2c75SKevin Wolf job->refcnt = 1; 33308be6fe2SKevin Wolf job->aio_context = ctx; 334da01ff7fSKevin Wolf job->busy = false; 335da01ff7fSKevin Wolf job->paused = true; 336da01ff7fSKevin Wolf job->pause_count = 1; 337bb02b65cSKevin Wolf job->auto_finalize = !(flags & JOB_MANUAL_FINALIZE); 338bb02b65cSKevin Wolf job->auto_dismiss = !(flags & JOB_MANUAL_DISMISS); 3394ad35181SKevin Wolf job->cb = cb; 3404ad35181SKevin Wolf job->opaque = opaque; 34133e9e9bdSKevin Wolf 342139a9f02SKevin Wolf notifier_list_init(&job->on_finalize_cancelled); 343139a9f02SKevin Wolf notifier_list_init(&job->on_finalize_completed); 344139a9f02SKevin Wolf notifier_list_init(&job->on_pending); 3452e1795b5SKevin Wolf notifier_list_init(&job->on_ready); 346139a9f02SKevin Wolf 347a50c2ab8SKevin Wolf job_state_transition(job, JOB_STATUS_CREATED); 3485d43e86eSKevin Wolf aio_timer_init(qemu_get_aio_context(), &job->sleep_timer, 3495d43e86eSKevin Wolf QEMU_CLOCK_REALTIME, SCALE_NS, 3505d43e86eSKevin Wolf job_sleep_timer_cb, job); 351a50c2ab8SKevin Wolf 352e7c1d78bSKevin Wolf QLIST_INSERT_HEAD(&jobs, job, job_list); 353e7c1d78bSKevin Wolf 3547eaa8fb5SKevin Wolf /* Single jobs are modeled as single-job transactions for sake of 3557eaa8fb5SKevin Wolf * consolidating the job management logic */ 3567eaa8fb5SKevin Wolf if (!txn) { 3577eaa8fb5SKevin Wolf txn = job_txn_new(); 3587eaa8fb5SKevin Wolf job_txn_add_job(txn, job); 3597eaa8fb5SKevin Wolf job_txn_unref(txn); 3607eaa8fb5SKevin Wolf } else { 3617eaa8fb5SKevin Wolf job_txn_add_job(txn, job); 3627eaa8fb5SKevin Wolf } 3637eaa8fb5SKevin Wolf 36433e9e9bdSKevin Wolf return job; 36533e9e9bdSKevin Wolf } 366fd61a701SKevin Wolf 36780fa2c75SKevin Wolf void job_ref(Job *job) 368fd61a701SKevin Wolf { 36980fa2c75SKevin Wolf ++job->refcnt; 37080fa2c75SKevin Wolf } 37180fa2c75SKevin Wolf 37280fa2c75SKevin Wolf void job_unref(Job *job) 37380fa2c75SKevin Wolf { 37480fa2c75SKevin Wolf if (--job->refcnt == 0) { 37580fa2c75SKevin Wolf assert(job->status == JOB_STATUS_NULL); 3765d43e86eSKevin Wolf assert(!timer_pending(&job->sleep_timer)); 3777eaa8fb5SKevin Wolf assert(!job->txn); 37880fa2c75SKevin Wolf 37980fa2c75SKevin Wolf if (job->driver->free) { 38080fa2c75SKevin Wolf job->driver->free(job); 38180fa2c75SKevin Wolf } 38280fa2c75SKevin Wolf 383e7c1d78bSKevin Wolf QLIST_REMOVE(job, job_list); 384e7c1d78bSKevin Wolf 3853d1f8b07SJohn Snow error_free(job->err); 386fd61a701SKevin Wolf g_free(job->id); 387fd61a701SKevin Wolf g_free(job); 388fd61a701SKevin Wolf } 38980fa2c75SKevin Wolf } 3901908a559SKevin Wolf 39130a5c887SKevin Wolf void job_progress_update(Job *job, uint64_t done) 39230a5c887SKevin Wolf { 39301fe1ca9SVladimir Sementsov-Ogievskiy progress_work_done(&job->progress, done); 39430a5c887SKevin Wolf } 39530a5c887SKevin Wolf 39630a5c887SKevin Wolf void job_progress_set_remaining(Job *job, uint64_t remaining) 39730a5c887SKevin Wolf { 39801fe1ca9SVladimir Sementsov-Ogievskiy progress_set_remaining(&job->progress, remaining); 39930a5c887SKevin Wolf } 40030a5c887SKevin Wolf 40162f13600SMax Reitz void job_progress_increase_remaining(Job *job, uint64_t delta) 40262f13600SMax Reitz { 40301fe1ca9SVladimir Sementsov-Ogievskiy progress_increase_remaining(&job->progress, delta); 40462f13600SMax Reitz } 40562f13600SMax Reitz 406139a9f02SKevin Wolf void job_event_cancelled(Job *job) 407139a9f02SKevin Wolf { 408139a9f02SKevin Wolf notifier_list_notify(&job->on_finalize_cancelled, job); 409139a9f02SKevin Wolf } 410139a9f02SKevin Wolf 411139a9f02SKevin Wolf void job_event_completed(Job *job) 412139a9f02SKevin Wolf { 413139a9f02SKevin Wolf notifier_list_notify(&job->on_finalize_completed, job); 414139a9f02SKevin Wolf } 415139a9f02SKevin Wolf 4167eaa8fb5SKevin Wolf static void job_event_pending(Job *job) 417139a9f02SKevin Wolf { 418139a9f02SKevin Wolf notifier_list_notify(&job->on_pending, job); 419139a9f02SKevin Wolf } 420139a9f02SKevin Wolf 4212e1795b5SKevin Wolf static void job_event_ready(Job *job) 4222e1795b5SKevin Wolf { 4232e1795b5SKevin Wolf notifier_list_notify(&job->on_ready, job); 4242e1795b5SKevin Wolf } 4252e1795b5SKevin Wolf 42634dc97b9SKevin Wolf static void job_event_idle(Job *job) 42734dc97b9SKevin Wolf { 42834dc97b9SKevin Wolf notifier_list_notify(&job->on_idle, job); 42934dc97b9SKevin Wolf } 43034dc97b9SKevin Wolf 431da01ff7fSKevin Wolf void job_enter_cond(Job *job, bool(*fn)(Job *job)) 432da01ff7fSKevin Wolf { 433da01ff7fSKevin Wolf if (!job_started(job)) { 434da01ff7fSKevin Wolf return; 435da01ff7fSKevin Wolf } 436da01ff7fSKevin Wolf if (job->deferred_to_main_loop) { 437da01ff7fSKevin Wolf return; 438da01ff7fSKevin Wolf } 439da01ff7fSKevin Wolf 440da01ff7fSKevin Wolf job_lock(); 441da01ff7fSKevin Wolf if (job->busy) { 442da01ff7fSKevin Wolf job_unlock(); 443da01ff7fSKevin Wolf return; 444da01ff7fSKevin Wolf } 445da01ff7fSKevin Wolf 446da01ff7fSKevin Wolf if (fn && !fn(job)) { 447da01ff7fSKevin Wolf job_unlock(); 448da01ff7fSKevin Wolf return; 449da01ff7fSKevin Wolf } 450da01ff7fSKevin Wolf 451da01ff7fSKevin Wolf assert(!job->deferred_to_main_loop); 452da01ff7fSKevin Wolf timer_del(&job->sleep_timer); 453da01ff7fSKevin Wolf job->busy = true; 454da01ff7fSKevin Wolf job_unlock(); 45513726123SKevin Wolf aio_co_enter(job->aio_context, job->co); 456da01ff7fSKevin Wolf } 457da01ff7fSKevin Wolf 4585d43e86eSKevin Wolf void job_enter(Job *job) 4595d43e86eSKevin Wolf { 4605d43e86eSKevin Wolf job_enter_cond(job, NULL); 4615d43e86eSKevin Wolf } 4625d43e86eSKevin Wolf 463da01ff7fSKevin Wolf /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds. 4643d70ff53SKevin Wolf * Reentering the job coroutine with job_enter() before the timer has expired 4653d70ff53SKevin Wolf * is allowed and cancels the timer. 466da01ff7fSKevin Wolf * 4673d70ff53SKevin Wolf * If @ns is (uint64_t) -1, no timer is scheduled and job_enter() must be 468da01ff7fSKevin Wolf * called explicitly. */ 469198c49ccSKevin Wolf static void coroutine_fn job_do_yield(Job *job, uint64_t ns) 470da01ff7fSKevin Wolf { 471da01ff7fSKevin Wolf job_lock(); 472da01ff7fSKevin Wolf if (ns != -1) { 473da01ff7fSKevin Wolf timer_mod(&job->sleep_timer, ns); 474da01ff7fSKevin Wolf } 475da01ff7fSKevin Wolf job->busy = false; 47634dc97b9SKevin Wolf job_event_idle(job); 477da01ff7fSKevin Wolf job_unlock(); 478da01ff7fSKevin Wolf qemu_coroutine_yield(); 479da01ff7fSKevin Wolf 480da01ff7fSKevin Wolf /* Set by job_enter_cond() before re-entering the coroutine. */ 481da01ff7fSKevin Wolf assert(job->busy); 482da01ff7fSKevin Wolf } 483da01ff7fSKevin Wolf 484da01ff7fSKevin Wolf void coroutine_fn job_pause_point(Job *job) 485da01ff7fSKevin Wolf { 486da01ff7fSKevin Wolf assert(job && job_started(job)); 487da01ff7fSKevin Wolf 488da01ff7fSKevin Wolf if (!job_should_pause(job)) { 489da01ff7fSKevin Wolf return; 490da01ff7fSKevin Wolf } 491da01ff7fSKevin Wolf if (job_is_cancelled(job)) { 492da01ff7fSKevin Wolf return; 493da01ff7fSKevin Wolf } 494da01ff7fSKevin Wolf 495da01ff7fSKevin Wolf if (job->driver->pause) { 496da01ff7fSKevin Wolf job->driver->pause(job); 497da01ff7fSKevin Wolf } 498da01ff7fSKevin Wolf 499da01ff7fSKevin Wolf if (job_should_pause(job) && !job_is_cancelled(job)) { 500da01ff7fSKevin Wolf JobStatus status = job->status; 501da01ff7fSKevin Wolf job_state_transition(job, status == JOB_STATUS_READY 502da01ff7fSKevin Wolf ? JOB_STATUS_STANDBY 503da01ff7fSKevin Wolf : JOB_STATUS_PAUSED); 504da01ff7fSKevin Wolf job->paused = true; 505da01ff7fSKevin Wolf job_do_yield(job, -1); 506da01ff7fSKevin Wolf job->paused = false; 507da01ff7fSKevin Wolf job_state_transition(job, status); 508da01ff7fSKevin Wolf } 509da01ff7fSKevin Wolf 510da01ff7fSKevin Wolf if (job->driver->resume) { 511da01ff7fSKevin Wolf job->driver->resume(job); 512da01ff7fSKevin Wolf } 513da01ff7fSKevin Wolf } 514da01ff7fSKevin Wolf 515198c49ccSKevin Wolf void job_yield(Job *job) 516198c49ccSKevin Wolf { 517198c49ccSKevin Wolf assert(job->busy); 518198c49ccSKevin Wolf 519198c49ccSKevin Wolf /* Check cancellation *before* setting busy = false, too! */ 520198c49ccSKevin Wolf if (job_is_cancelled(job)) { 521198c49ccSKevin Wolf return; 522198c49ccSKevin Wolf } 523198c49ccSKevin Wolf 524198c49ccSKevin Wolf if (!job_should_pause(job)) { 525198c49ccSKevin Wolf job_do_yield(job, -1); 526198c49ccSKevin Wolf } 527198c49ccSKevin Wolf 528198c49ccSKevin Wolf job_pause_point(job); 529198c49ccSKevin Wolf } 530198c49ccSKevin Wolf 5315d43e86eSKevin Wolf void coroutine_fn job_sleep_ns(Job *job, int64_t ns) 5325d43e86eSKevin Wolf { 5335d43e86eSKevin Wolf assert(job->busy); 5345d43e86eSKevin Wolf 5355d43e86eSKevin Wolf /* Check cancellation *before* setting busy = false, too! */ 5365d43e86eSKevin Wolf if (job_is_cancelled(job)) { 5375d43e86eSKevin Wolf return; 5385d43e86eSKevin Wolf } 5395d43e86eSKevin Wolf 5405d43e86eSKevin Wolf if (!job_should_pause(job)) { 5415d43e86eSKevin Wolf job_do_yield(job, qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + ns); 5425d43e86eSKevin Wolf } 5435d43e86eSKevin Wolf 5445d43e86eSKevin Wolf job_pause_point(job); 5455d43e86eSKevin Wolf } 5465d43e86eSKevin Wolf 547b15de828SKevin Wolf /* Assumes the block_job_mutex is held */ 548b15de828SKevin Wolf static bool job_timer_not_pending(Job *job) 549b15de828SKevin Wolf { 550b15de828SKevin Wolf return !timer_pending(&job->sleep_timer); 551b15de828SKevin Wolf } 552b15de828SKevin Wolf 553b15de828SKevin Wolf void job_pause(Job *job) 554b15de828SKevin Wolf { 555b15de828SKevin Wolf job->pause_count++; 556b15de828SKevin Wolf } 557b15de828SKevin Wolf 558b15de828SKevin Wolf void job_resume(Job *job) 559b15de828SKevin Wolf { 560b15de828SKevin Wolf assert(job->pause_count > 0); 561b15de828SKevin Wolf job->pause_count--; 562b15de828SKevin Wolf if (job->pause_count) { 563b15de828SKevin Wolf return; 564b15de828SKevin Wolf } 565b15de828SKevin Wolf 566b15de828SKevin Wolf /* kick only if no timer is pending */ 567b15de828SKevin Wolf job_enter_cond(job, job_timer_not_pending); 568b15de828SKevin Wolf } 569b15de828SKevin Wolf 570b15de828SKevin Wolf void job_user_pause(Job *job, Error **errp) 571b15de828SKevin Wolf { 572b15de828SKevin Wolf if (job_apply_verb(job, JOB_VERB_PAUSE, errp)) { 573b15de828SKevin Wolf return; 574b15de828SKevin Wolf } 575b15de828SKevin Wolf if (job->user_paused) { 576b15de828SKevin Wolf error_setg(errp, "Job is already paused"); 577b15de828SKevin Wolf return; 578b15de828SKevin Wolf } 579b15de828SKevin Wolf job->user_paused = true; 580b15de828SKevin Wolf job_pause(job); 581b15de828SKevin Wolf } 582b15de828SKevin Wolf 583b15de828SKevin Wolf bool job_user_paused(Job *job) 584b15de828SKevin Wolf { 585b15de828SKevin Wolf return job->user_paused; 586b15de828SKevin Wolf } 587b15de828SKevin Wolf 588b15de828SKevin Wolf void job_user_resume(Job *job, Error **errp) 589b15de828SKevin Wolf { 590b15de828SKevin Wolf assert(job); 591b15de828SKevin Wolf if (!job->user_paused || job->pause_count <= 0) { 592b15de828SKevin Wolf error_setg(errp, "Can't resume a job that was not paused"); 593b15de828SKevin Wolf return; 594b15de828SKevin Wolf } 595b15de828SKevin Wolf if (job_apply_verb(job, JOB_VERB_RESUME, errp)) { 596b15de828SKevin Wolf return; 597b15de828SKevin Wolf } 598b15de828SKevin Wolf if (job->driver->user_resume) { 599b15de828SKevin Wolf job->driver->user_resume(job); 600b15de828SKevin Wolf } 601b15de828SKevin Wolf job->user_paused = false; 602b15de828SKevin Wolf job_resume(job); 603b15de828SKevin Wolf } 604b15de828SKevin Wolf 6055f9a6a08SKevin Wolf static void job_do_dismiss(Job *job) 6064ad35181SKevin Wolf { 6074ad35181SKevin Wolf assert(job); 6084ad35181SKevin Wolf job->busy = false; 6094ad35181SKevin Wolf job->paused = false; 6104ad35181SKevin Wolf job->deferred_to_main_loop = true; 6114ad35181SKevin Wolf 6127eaa8fb5SKevin Wolf job_txn_del_job(job); 6134ad35181SKevin Wolf 6144ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_NULL); 6154ad35181SKevin Wolf job_unref(job); 6164ad35181SKevin Wolf } 6174ad35181SKevin Wolf 6185f9a6a08SKevin Wolf void job_dismiss(Job **jobptr, Error **errp) 6195f9a6a08SKevin Wolf { 6205f9a6a08SKevin Wolf Job *job = *jobptr; 6215f9a6a08SKevin Wolf /* similarly to _complete, this is QMP-interface only. */ 6225f9a6a08SKevin Wolf assert(job->id); 6235f9a6a08SKevin Wolf if (job_apply_verb(job, JOB_VERB_DISMISS, errp)) { 6245f9a6a08SKevin Wolf return; 6255f9a6a08SKevin Wolf } 6265f9a6a08SKevin Wolf 6275f9a6a08SKevin Wolf job_do_dismiss(job); 6285f9a6a08SKevin Wolf *jobptr = NULL; 6295f9a6a08SKevin Wolf } 6305f9a6a08SKevin Wolf 6314ad35181SKevin Wolf void job_early_fail(Job *job) 6324ad35181SKevin Wolf { 6334ad35181SKevin Wolf assert(job->status == JOB_STATUS_CREATED); 6344ad35181SKevin Wolf job_do_dismiss(job); 6354ad35181SKevin Wolf } 6364ad35181SKevin Wolf 6374ad35181SKevin Wolf static void job_conclude(Job *job) 6384ad35181SKevin Wolf { 6394ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_CONCLUDED); 6404ad35181SKevin Wolf if (job->auto_dismiss || !job_started(job)) { 6414ad35181SKevin Wolf job_do_dismiss(job); 6424ad35181SKevin Wolf } 6434ad35181SKevin Wolf } 6444ad35181SKevin Wolf 6453d70ff53SKevin Wolf static void job_update_rc(Job *job) 6464ad35181SKevin Wolf { 6474ad35181SKevin Wolf if (!job->ret && job_is_cancelled(job)) { 6484ad35181SKevin Wolf job->ret = -ECANCELED; 6494ad35181SKevin Wolf } 6504ad35181SKevin Wolf if (job->ret) { 6513d1f8b07SJohn Snow if (!job->err) { 6523d1f8b07SJohn Snow error_setg(&job->err, "%s", strerror(-job->ret)); 6531266c9b9SKevin Wolf } 6544ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_ABORTING); 6554ad35181SKevin Wolf } 6564ad35181SKevin Wolf } 6574ad35181SKevin Wolf 6584ad35181SKevin Wolf static void job_commit(Job *job) 6594ad35181SKevin Wolf { 6604ad35181SKevin Wolf assert(!job->ret); 6614ad35181SKevin Wolf if (job->driver->commit) { 6624ad35181SKevin Wolf job->driver->commit(job); 6634ad35181SKevin Wolf } 6644ad35181SKevin Wolf } 6654ad35181SKevin Wolf 6664ad35181SKevin Wolf static void job_abort(Job *job) 6674ad35181SKevin Wolf { 6684ad35181SKevin Wolf assert(job->ret); 6694ad35181SKevin Wolf if (job->driver->abort) { 6704ad35181SKevin Wolf job->driver->abort(job); 6714ad35181SKevin Wolf } 6724ad35181SKevin Wolf } 6734ad35181SKevin Wolf 6744ad35181SKevin Wolf static void job_clean(Job *job) 6754ad35181SKevin Wolf { 6764ad35181SKevin Wolf if (job->driver->clean) { 6774ad35181SKevin Wolf job->driver->clean(job); 6784ad35181SKevin Wolf } 6794ad35181SKevin Wolf } 6804ad35181SKevin Wolf 6817eaa8fb5SKevin Wolf static int job_finalize_single(Job *job) 6824ad35181SKevin Wolf { 6834ad35181SKevin Wolf assert(job_is_completed(job)); 6844ad35181SKevin Wolf 6854ad35181SKevin Wolf /* Ensure abort is called for late-transactional failures */ 6864ad35181SKevin Wolf job_update_rc(job); 6874ad35181SKevin Wolf 6884ad35181SKevin Wolf if (!job->ret) { 6894ad35181SKevin Wolf job_commit(job); 6904ad35181SKevin Wolf } else { 6914ad35181SKevin Wolf job_abort(job); 6924ad35181SKevin Wolf } 6934ad35181SKevin Wolf job_clean(job); 6944ad35181SKevin Wolf 6954ad35181SKevin Wolf if (job->cb) { 6964ad35181SKevin Wolf job->cb(job->opaque, job->ret); 6974ad35181SKevin Wolf } 6984ad35181SKevin Wolf 6994ad35181SKevin Wolf /* Emit events only if we actually started */ 7004ad35181SKevin Wolf if (job_started(job)) { 7014ad35181SKevin Wolf if (job_is_cancelled(job)) { 7024ad35181SKevin Wolf job_event_cancelled(job); 7034ad35181SKevin Wolf } else { 7044ad35181SKevin Wolf job_event_completed(job); 7054ad35181SKevin Wolf } 7064ad35181SKevin Wolf } 7074ad35181SKevin Wolf 7087eaa8fb5SKevin Wolf job_txn_del_job(job); 7094ad35181SKevin Wolf job_conclude(job); 7104ad35181SKevin Wolf return 0; 7114ad35181SKevin Wolf } 7124ad35181SKevin Wolf 7133d70ff53SKevin Wolf static void job_cancel_async(Job *job, bool force) 7147eaa8fb5SKevin Wolf { 7157eaa8fb5SKevin Wolf if (job->user_paused) { 7167eaa8fb5SKevin Wolf /* Do not call job_enter here, the caller will handle it. */ 7177eaa8fb5SKevin Wolf if (job->driver->user_resume) { 7187eaa8fb5SKevin Wolf job->driver->user_resume(job); 7197eaa8fb5SKevin Wolf } 720e321c059SJeff Cody job->user_paused = false; 7217eaa8fb5SKevin Wolf assert(job->pause_count > 0); 7227eaa8fb5SKevin Wolf job->pause_count--; 7237eaa8fb5SKevin Wolf } 7247eaa8fb5SKevin Wolf job->cancelled = true; 7257eaa8fb5SKevin Wolf /* To prevent 'force == false' overriding a previous 'force == true' */ 7267eaa8fb5SKevin Wolf job->force_cancel |= force; 7277eaa8fb5SKevin Wolf } 7287eaa8fb5SKevin Wolf 7293d70ff53SKevin Wolf static void job_completed_txn_abort(Job *job) 7307eaa8fb5SKevin Wolf { 731644f3a29SKevin Wolf AioContext *outer_ctx = job->aio_context; 7327eaa8fb5SKevin Wolf AioContext *ctx; 7337eaa8fb5SKevin Wolf JobTxn *txn = job->txn; 7347eaa8fb5SKevin Wolf Job *other_job; 7357eaa8fb5SKevin Wolf 7367eaa8fb5SKevin Wolf if (txn->aborting) { 7377eaa8fb5SKevin Wolf /* 7387eaa8fb5SKevin Wolf * We are cancelled by another job, which will handle everything. 7397eaa8fb5SKevin Wolf */ 7407eaa8fb5SKevin Wolf return; 7417eaa8fb5SKevin Wolf } 7427eaa8fb5SKevin Wolf txn->aborting = true; 7437eaa8fb5SKevin Wolf job_txn_ref(txn); 7447eaa8fb5SKevin Wolf 745644f3a29SKevin Wolf /* We can only hold the single job's AioContext lock while calling 746644f3a29SKevin Wolf * job_finalize_single() because the finalization callbacks can involve 747644f3a29SKevin Wolf * calls of AIO_WAIT_WHILE(), which could deadlock otherwise. */ 748644f3a29SKevin Wolf aio_context_release(outer_ctx); 7497eaa8fb5SKevin Wolf 7507eaa8fb5SKevin Wolf /* Other jobs are effectively cancelled by us, set the status for 7517eaa8fb5SKevin Wolf * them; this job, however, may or may not be cancelled, depending 7527eaa8fb5SKevin Wolf * on the caller, so leave it. */ 7537eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 7547eaa8fb5SKevin Wolf if (other_job != job) { 755644f3a29SKevin Wolf ctx = other_job->aio_context; 756644f3a29SKevin Wolf aio_context_acquire(ctx); 7577eaa8fb5SKevin Wolf job_cancel_async(other_job, false); 758644f3a29SKevin Wolf aio_context_release(ctx); 7597eaa8fb5SKevin Wolf } 7607eaa8fb5SKevin Wolf } 7617eaa8fb5SKevin Wolf while (!QLIST_EMPTY(&txn->jobs)) { 7627eaa8fb5SKevin Wolf other_job = QLIST_FIRST(&txn->jobs); 7637eaa8fb5SKevin Wolf ctx = other_job->aio_context; 764644f3a29SKevin Wolf aio_context_acquire(ctx); 7657eaa8fb5SKevin Wolf if (!job_is_completed(other_job)) { 7667eaa8fb5SKevin Wolf assert(job_is_cancelled(other_job)); 7677eaa8fb5SKevin Wolf job_finish_sync(other_job, NULL, NULL); 7687eaa8fb5SKevin Wolf } 7697eaa8fb5SKevin Wolf job_finalize_single(other_job); 7707eaa8fb5SKevin Wolf aio_context_release(ctx); 7717eaa8fb5SKevin Wolf } 7727eaa8fb5SKevin Wolf 773644f3a29SKevin Wolf aio_context_acquire(outer_ctx); 774644f3a29SKevin Wolf 7757eaa8fb5SKevin Wolf job_txn_unref(txn); 7767eaa8fb5SKevin Wolf } 7777eaa8fb5SKevin Wolf 7787eaa8fb5SKevin Wolf static int job_prepare(Job *job) 7797eaa8fb5SKevin Wolf { 7807eaa8fb5SKevin Wolf if (job->ret == 0 && job->driver->prepare) { 7817eaa8fb5SKevin Wolf job->ret = job->driver->prepare(job); 7821266c9b9SKevin Wolf job_update_rc(job); 7837eaa8fb5SKevin Wolf } 7847eaa8fb5SKevin Wolf return job->ret; 7857eaa8fb5SKevin Wolf } 7867eaa8fb5SKevin Wolf 7877eaa8fb5SKevin Wolf static int job_needs_finalize(Job *job) 7887eaa8fb5SKevin Wolf { 7897eaa8fb5SKevin Wolf return !job->auto_finalize; 7907eaa8fb5SKevin Wolf } 7917eaa8fb5SKevin Wolf 7927eaa8fb5SKevin Wolf static void job_do_finalize(Job *job) 7937eaa8fb5SKevin Wolf { 7947eaa8fb5SKevin Wolf int rc; 7957eaa8fb5SKevin Wolf assert(job && job->txn); 7967eaa8fb5SKevin Wolf 7977eaa8fb5SKevin Wolf /* prepare the transaction to complete */ 798b660a84bSStefan Reiter rc = job_txn_apply(job, job_prepare); 7997eaa8fb5SKevin Wolf if (rc) { 8007eaa8fb5SKevin Wolf job_completed_txn_abort(job); 8017eaa8fb5SKevin Wolf } else { 802b660a84bSStefan Reiter job_txn_apply(job, job_finalize_single); 8037eaa8fb5SKevin Wolf } 8047eaa8fb5SKevin Wolf } 8057eaa8fb5SKevin Wolf 8067eaa8fb5SKevin Wolf void job_finalize(Job *job, Error **errp) 8077eaa8fb5SKevin Wolf { 8087eaa8fb5SKevin Wolf assert(job && job->id); 8097eaa8fb5SKevin Wolf if (job_apply_verb(job, JOB_VERB_FINALIZE, errp)) { 8107eaa8fb5SKevin Wolf return; 8117eaa8fb5SKevin Wolf } 8127eaa8fb5SKevin Wolf job_do_finalize(job); 8137eaa8fb5SKevin Wolf } 8147eaa8fb5SKevin Wolf 8157eaa8fb5SKevin Wolf static int job_transition_to_pending(Job *job) 8167eaa8fb5SKevin Wolf { 8177eaa8fb5SKevin Wolf job_state_transition(job, JOB_STATUS_PENDING); 8187eaa8fb5SKevin Wolf if (!job->auto_finalize) { 8197eaa8fb5SKevin Wolf job_event_pending(job); 8207eaa8fb5SKevin Wolf } 8217eaa8fb5SKevin Wolf return 0; 8227eaa8fb5SKevin Wolf } 8237eaa8fb5SKevin Wolf 8242e1795b5SKevin Wolf void job_transition_to_ready(Job *job) 8252e1795b5SKevin Wolf { 8262e1795b5SKevin Wolf job_state_transition(job, JOB_STATUS_READY); 8272e1795b5SKevin Wolf job_event_ready(job); 8282e1795b5SKevin Wolf } 8292e1795b5SKevin Wolf 8303d70ff53SKevin Wolf static void job_completed_txn_success(Job *job) 8317eaa8fb5SKevin Wolf { 8327eaa8fb5SKevin Wolf JobTxn *txn = job->txn; 8337eaa8fb5SKevin Wolf Job *other_job; 8347eaa8fb5SKevin Wolf 8357eaa8fb5SKevin Wolf job_state_transition(job, JOB_STATUS_WAITING); 8367eaa8fb5SKevin Wolf 8377eaa8fb5SKevin Wolf /* 8387eaa8fb5SKevin Wolf * Successful completion, see if there are other running jobs in this 8397eaa8fb5SKevin Wolf * txn. 8407eaa8fb5SKevin Wolf */ 8417eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 8427eaa8fb5SKevin Wolf if (!job_is_completed(other_job)) { 8437eaa8fb5SKevin Wolf return; 8447eaa8fb5SKevin Wolf } 8457eaa8fb5SKevin Wolf assert(other_job->ret == 0); 8467eaa8fb5SKevin Wolf } 8477eaa8fb5SKevin Wolf 848b660a84bSStefan Reiter job_txn_apply(job, job_transition_to_pending); 8497eaa8fb5SKevin Wolf 8507eaa8fb5SKevin Wolf /* If no jobs need manual finalization, automatically do so */ 851b660a84bSStefan Reiter if (job_txn_apply(job, job_needs_finalize) == 0) { 8527eaa8fb5SKevin Wolf job_do_finalize(job); 8537eaa8fb5SKevin Wolf } 8547eaa8fb5SKevin Wolf } 8557eaa8fb5SKevin Wolf 856404ff28dSJohn Snow static void job_completed(Job *job) 8573d70ff53SKevin Wolf { 8583d70ff53SKevin Wolf assert(job && job->txn && !job_is_completed(job)); 8591266c9b9SKevin Wolf 8603d70ff53SKevin Wolf job_update_rc(job); 861404ff28dSJohn Snow trace_job_completed(job, job->ret); 8623d70ff53SKevin Wolf if (job->ret) { 8633d70ff53SKevin Wolf job_completed_txn_abort(job); 8643d70ff53SKevin Wolf } else { 8653d70ff53SKevin Wolf job_completed_txn_success(job); 8663d70ff53SKevin Wolf } 8673d70ff53SKevin Wolf } 8683d70ff53SKevin Wolf 869ccbfb331SJohn Snow /** Useful only as a type shim for aio_bh_schedule_oneshot. */ 870ccbfb331SJohn Snow static void job_exit(void *opaque) 871ccbfb331SJohn Snow { 872ccbfb331SJohn Snow Job *job = (Job *)opaque; 873b660a84bSStefan Reiter AioContext *ctx; 874d1756c78SKevin Wolf 875b660a84bSStefan Reiter job_ref(job); 876b660a84bSStefan Reiter aio_context_acquire(job->aio_context); 877b5a7a057SKevin Wolf 878b5a7a057SKevin Wolf /* This is a lie, we're not quiescent, but still doing the completion 879b5a7a057SKevin Wolf * callbacks. However, completion callbacks tend to involve operations that 880b5a7a057SKevin Wolf * drain block nodes, and if .drained_poll still returned true, we would 881b5a7a057SKevin Wolf * deadlock. */ 882b5a7a057SKevin Wolf job->busy = false; 883b5a7a057SKevin Wolf job_event_idle(job); 884b5a7a057SKevin Wolf 885ccbfb331SJohn Snow job_completed(job); 886b5a7a057SKevin Wolf 887b660a84bSStefan Reiter /* 888b660a84bSStefan Reiter * Note that calling job_completed can move the job to a different 889b660a84bSStefan Reiter * aio_context, so we cannot cache from above. job_txn_apply takes care of 890b660a84bSStefan Reiter * acquiring the new lock, and we ref/unref to avoid job_completed freeing 891b660a84bSStefan Reiter * the job underneath us. 892b660a84bSStefan Reiter */ 893b660a84bSStefan Reiter ctx = job->aio_context; 894b660a84bSStefan Reiter job_unref(job); 895d1756c78SKevin Wolf aio_context_release(ctx); 896ccbfb331SJohn Snow } 897ccbfb331SJohn Snow 898ccbfb331SJohn Snow /** 899ccbfb331SJohn Snow * All jobs must allow a pause point before entering their job proper. This 900ccbfb331SJohn Snow * ensures that jobs can be paused prior to being started, then resumed later. 901ccbfb331SJohn Snow */ 902ccbfb331SJohn Snow static void coroutine_fn job_co_entry(void *opaque) 903ccbfb331SJohn Snow { 904ccbfb331SJohn Snow Job *job = opaque; 905ccbfb331SJohn Snow 906ccbfb331SJohn Snow assert(job && job->driver && job->driver->run); 907ccbfb331SJohn Snow job_pause_point(job); 908ccbfb331SJohn Snow job->ret = job->driver->run(job, &job->err); 909ccbfb331SJohn Snow job->deferred_to_main_loop = true; 910b5a7a057SKevin Wolf job->busy = true; 911ccbfb331SJohn Snow aio_bh_schedule_oneshot(qemu_get_aio_context(), job_exit, job); 912ccbfb331SJohn Snow } 913ccbfb331SJohn Snow 914ccbfb331SJohn Snow void job_start(Job *job) 915ccbfb331SJohn Snow { 916ccbfb331SJohn Snow assert(job && !job_started(job) && job->paused && 917ccbfb331SJohn Snow job->driver && job->driver->run); 918ccbfb331SJohn Snow job->co = qemu_coroutine_create(job_co_entry, job); 919ccbfb331SJohn Snow job->pause_count--; 920ccbfb331SJohn Snow job->busy = true; 921ccbfb331SJohn Snow job->paused = false; 922ccbfb331SJohn Snow job_state_transition(job, JOB_STATUS_RUNNING); 923ccbfb331SJohn Snow aio_co_enter(job->aio_context, job->co); 924ccbfb331SJohn Snow } 925ccbfb331SJohn Snow 9263d70ff53SKevin Wolf void job_cancel(Job *job, bool force) 9273d70ff53SKevin Wolf { 9283d70ff53SKevin Wolf if (job->status == JOB_STATUS_CONCLUDED) { 9293d70ff53SKevin Wolf job_do_dismiss(job); 9303d70ff53SKevin Wolf return; 9313d70ff53SKevin Wolf } 9323d70ff53SKevin Wolf job_cancel_async(job, force); 9333d70ff53SKevin Wolf if (!job_started(job)) { 934404ff28dSJohn Snow job_completed(job); 9353d70ff53SKevin Wolf } else if (job->deferred_to_main_loop) { 9363d70ff53SKevin Wolf job_completed_txn_abort(job); 9373d70ff53SKevin Wolf } else { 9383d70ff53SKevin Wolf job_enter(job); 9393d70ff53SKevin Wolf } 9403d70ff53SKevin Wolf } 9413d70ff53SKevin Wolf 9423d70ff53SKevin Wolf void job_user_cancel(Job *job, bool force, Error **errp) 9433d70ff53SKevin Wolf { 9443d70ff53SKevin Wolf if (job_apply_verb(job, JOB_VERB_CANCEL, errp)) { 9453d70ff53SKevin Wolf return; 9463d70ff53SKevin Wolf } 9473d70ff53SKevin Wolf job_cancel(job, force); 9483d70ff53SKevin Wolf } 9493d70ff53SKevin Wolf 9503d70ff53SKevin Wolf /* A wrapper around job_cancel() taking an Error ** parameter so it may be 9513d70ff53SKevin Wolf * used with job_finish_sync() without the need for (rather nasty) function 9523d70ff53SKevin Wolf * pointer casts there. */ 9533d70ff53SKevin Wolf static void job_cancel_err(Job *job, Error **errp) 9543d70ff53SKevin Wolf { 9553d70ff53SKevin Wolf job_cancel(job, false); 9563d70ff53SKevin Wolf } 9573d70ff53SKevin Wolf 9583d70ff53SKevin Wolf int job_cancel_sync(Job *job) 9593d70ff53SKevin Wolf { 9603d70ff53SKevin Wolf return job_finish_sync(job, &job_cancel_err, NULL); 9613d70ff53SKevin Wolf } 9623d70ff53SKevin Wolf 9633d70ff53SKevin Wolf void job_cancel_sync_all(void) 9643d70ff53SKevin Wolf { 9653d70ff53SKevin Wolf Job *job; 9663d70ff53SKevin Wolf AioContext *aio_context; 9673d70ff53SKevin Wolf 9683d70ff53SKevin Wolf while ((job = job_next(NULL))) { 9693d70ff53SKevin Wolf aio_context = job->aio_context; 9703d70ff53SKevin Wolf aio_context_acquire(aio_context); 9713d70ff53SKevin Wolf job_cancel_sync(job); 9723d70ff53SKevin Wolf aio_context_release(aio_context); 9733d70ff53SKevin Wolf } 9743d70ff53SKevin Wolf } 9753d70ff53SKevin Wolf 9763d70ff53SKevin Wolf int job_complete_sync(Job *job, Error **errp) 9773d70ff53SKevin Wolf { 9783d70ff53SKevin Wolf return job_finish_sync(job, job_complete, errp); 9793d70ff53SKevin Wolf } 9803d70ff53SKevin Wolf 9813453d972SKevin Wolf void job_complete(Job *job, Error **errp) 9823453d972SKevin Wolf { 9833453d972SKevin Wolf /* Should not be reachable via external interface for internal jobs */ 9843453d972SKevin Wolf assert(job->id); 9853453d972SKevin Wolf if (job_apply_verb(job, JOB_VERB_COMPLETE, errp)) { 9863453d972SKevin Wolf return; 9873453d972SKevin Wolf } 9883453d972SKevin Wolf if (job->pause_count || job_is_cancelled(job) || !job->driver->complete) { 9893453d972SKevin Wolf error_setg(errp, "The active block job '%s' cannot be completed", 9903453d972SKevin Wolf job->id); 9913453d972SKevin Wolf return; 9923453d972SKevin Wolf } 9933453d972SKevin Wolf 9943453d972SKevin Wolf job->driver->complete(job, errp); 9953453d972SKevin Wolf } 9963453d972SKevin Wolf 9976a74c075SKevin Wolf int job_finish_sync(Job *job, void (*finish)(Job *, Error **errp), Error **errp) 9986a74c075SKevin Wolf { 9996a74c075SKevin Wolf Error *local_err = NULL; 10006a74c075SKevin Wolf int ret; 10016a74c075SKevin Wolf 10026a74c075SKevin Wolf job_ref(job); 10036a74c075SKevin Wolf 10046a74c075SKevin Wolf if (finish) { 10056a74c075SKevin Wolf finish(job, &local_err); 10066a74c075SKevin Wolf } 10076a74c075SKevin Wolf if (local_err) { 10086a74c075SKevin Wolf error_propagate(errp, local_err); 10096a74c075SKevin Wolf job_unref(job); 10106a74c075SKevin Wolf return -EBUSY; 10116a74c075SKevin Wolf } 1012de0fbe64SKevin Wolf 1013cfe29d82SKevin Wolf AIO_WAIT_WHILE(job->aio_context, 1014bb0c9409SVladimir Sementsov-Ogievskiy (job_enter(job), !job_is_completed(job))); 1015de0fbe64SKevin Wolf 10166a74c075SKevin Wolf ret = (job_is_cancelled(job) && job->ret == 0) ? -ECANCELED : job->ret; 10176a74c075SKevin Wolf job_unref(job); 10186a74c075SKevin Wolf return ret; 10196a74c075SKevin Wolf } 1020