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" 32243af022SPaolo 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}, 5953ddb9c8SMax Reitz [JOB_VERB_COMPLETE] = {0, 0, 0, 0, 1, 1, 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 { 220a640fa0eSHanna Reitz /* force_cancel may be true only if cancelled is true, too */ 221a640fa0eSHanna Reitz assert(job->cancelled || !job->force_cancel); 222a640fa0eSHanna Reitz return job->force_cancel; 22308b83bffSHanna Reitz } 22408b83bffSHanna Reitz 22508b83bffSHanna Reitz bool job_cancel_requested(Job *job) 22608b83bffSHanna Reitz { 227daa7f2f9SKevin Wolf return job->cancelled; 228daa7f2f9SKevin Wolf } 229daa7f2f9SKevin Wolf 230df956ae2SKevin Wolf bool job_is_ready(Job *job) 231df956ae2SKevin Wolf { 232df956ae2SKevin Wolf switch (job->status) { 233df956ae2SKevin Wolf case JOB_STATUS_UNDEFINED: 234df956ae2SKevin Wolf case JOB_STATUS_CREATED: 235df956ae2SKevin Wolf case JOB_STATUS_RUNNING: 236df956ae2SKevin Wolf case JOB_STATUS_PAUSED: 237df956ae2SKevin Wolf case JOB_STATUS_WAITING: 238df956ae2SKevin Wolf case JOB_STATUS_PENDING: 239df956ae2SKevin Wolf case JOB_STATUS_ABORTING: 240df956ae2SKevin Wolf case JOB_STATUS_CONCLUDED: 241df956ae2SKevin Wolf case JOB_STATUS_NULL: 242df956ae2SKevin Wolf return false; 243df956ae2SKevin Wolf case JOB_STATUS_READY: 244df956ae2SKevin Wolf case JOB_STATUS_STANDBY: 245df956ae2SKevin Wolf return true; 246df956ae2SKevin Wolf default: 247df956ae2SKevin Wolf g_assert_not_reached(); 248df956ae2SKevin Wolf } 249df956ae2SKevin Wolf return false; 250df956ae2SKevin Wolf } 251df956ae2SKevin Wolf 252dbe5e6c1SKevin Wolf bool job_is_completed(Job *job) 253dbe5e6c1SKevin Wolf { 254dbe5e6c1SKevin Wolf switch (job->status) { 255dbe5e6c1SKevin Wolf case JOB_STATUS_UNDEFINED: 256dbe5e6c1SKevin Wolf case JOB_STATUS_CREATED: 257dbe5e6c1SKevin Wolf case JOB_STATUS_RUNNING: 258dbe5e6c1SKevin Wolf case JOB_STATUS_PAUSED: 259dbe5e6c1SKevin Wolf case JOB_STATUS_READY: 260dbe5e6c1SKevin Wolf case JOB_STATUS_STANDBY: 261dbe5e6c1SKevin Wolf return false; 262dbe5e6c1SKevin Wolf case JOB_STATUS_WAITING: 263dbe5e6c1SKevin Wolf case JOB_STATUS_PENDING: 264dbe5e6c1SKevin Wolf case JOB_STATUS_ABORTING: 265dbe5e6c1SKevin Wolf case JOB_STATUS_CONCLUDED: 266dbe5e6c1SKevin Wolf case JOB_STATUS_NULL: 267dbe5e6c1SKevin Wolf return true; 268dbe5e6c1SKevin Wolf default: 269dbe5e6c1SKevin Wolf g_assert_not_reached(); 270dbe5e6c1SKevin Wolf } 271dbe5e6c1SKevin Wolf return false; 272dbe5e6c1SKevin Wolf } 273dbe5e6c1SKevin Wolf 2743d70ff53SKevin Wolf static bool job_started(Job *job) 275da01ff7fSKevin Wolf { 276da01ff7fSKevin Wolf return job->co; 277da01ff7fSKevin Wolf } 278da01ff7fSKevin Wolf 279198c49ccSKevin Wolf static bool job_should_pause(Job *job) 280da01ff7fSKevin Wolf { 281da01ff7fSKevin Wolf return job->pause_count > 0; 282da01ff7fSKevin Wolf } 283da01ff7fSKevin Wolf 284e7c1d78bSKevin Wolf Job *job_next(Job *job) 285e7c1d78bSKevin Wolf { 286e7c1d78bSKevin Wolf if (!job) { 287e7c1d78bSKevin Wolf return QLIST_FIRST(&jobs); 288e7c1d78bSKevin Wolf } 289e7c1d78bSKevin Wolf return QLIST_NEXT(job, job_list); 290e7c1d78bSKevin Wolf } 291e7c1d78bSKevin Wolf 292e7c1d78bSKevin Wolf Job *job_get(const char *id) 293e7c1d78bSKevin Wolf { 294e7c1d78bSKevin Wolf Job *job; 295e7c1d78bSKevin Wolf 296e7c1d78bSKevin Wolf QLIST_FOREACH(job, &jobs, job_list) { 297e7c1d78bSKevin Wolf if (job->id && !strcmp(id, job->id)) { 298e7c1d78bSKevin Wolf return job; 299e7c1d78bSKevin Wolf } 300e7c1d78bSKevin Wolf } 301e7c1d78bSKevin Wolf 302e7c1d78bSKevin Wolf return NULL; 303e7c1d78bSKevin Wolf } 304e7c1d78bSKevin Wolf 3055d43e86eSKevin Wolf static void job_sleep_timer_cb(void *opaque) 3065d43e86eSKevin Wolf { 3075d43e86eSKevin Wolf Job *job = opaque; 3085d43e86eSKevin Wolf 3095d43e86eSKevin Wolf job_enter(job); 3105d43e86eSKevin Wolf } 3115d43e86eSKevin Wolf 3127eaa8fb5SKevin Wolf void *job_create(const char *job_id, const JobDriver *driver, JobTxn *txn, 3137eaa8fb5SKevin Wolf AioContext *ctx, int flags, BlockCompletionFunc *cb, 3147eaa8fb5SKevin Wolf void *opaque, Error **errp) 31533e9e9bdSKevin Wolf { 31633e9e9bdSKevin Wolf Job *job; 31733e9e9bdSKevin Wolf 31833e9e9bdSKevin Wolf if (job_id) { 319bb02b65cSKevin Wolf if (flags & JOB_INTERNAL) { 320bb02b65cSKevin Wolf error_setg(errp, "Cannot specify job ID for internal job"); 321bb02b65cSKevin Wolf return NULL; 322bb02b65cSKevin Wolf } 32333e9e9bdSKevin Wolf if (!id_wellformed(job_id)) { 32433e9e9bdSKevin Wolf error_setg(errp, "Invalid job ID '%s'", job_id); 32533e9e9bdSKevin Wolf return NULL; 32633e9e9bdSKevin Wolf } 327e7c1d78bSKevin Wolf if (job_get(job_id)) { 328e7c1d78bSKevin Wolf error_setg(errp, "Job ID '%s' already in use", job_id); 329e7c1d78bSKevin Wolf return NULL; 330e7c1d78bSKevin Wolf } 331bb02b65cSKevin Wolf } else if (!(flags & JOB_INTERNAL)) { 332bb02b65cSKevin Wolf error_setg(errp, "An explicit job ID is required"); 333bb02b65cSKevin Wolf return NULL; 33433e9e9bdSKevin Wolf } 33533e9e9bdSKevin Wolf 33633e9e9bdSKevin Wolf job = g_malloc0(driver->instance_size); 33733e9e9bdSKevin Wolf job->driver = driver; 33833e9e9bdSKevin Wolf job->id = g_strdup(job_id); 33980fa2c75SKevin Wolf job->refcnt = 1; 34008be6fe2SKevin Wolf job->aio_context = ctx; 341da01ff7fSKevin Wolf job->busy = false; 342da01ff7fSKevin Wolf job->paused = true; 343da01ff7fSKevin Wolf job->pause_count = 1; 344bb02b65cSKevin Wolf job->auto_finalize = !(flags & JOB_MANUAL_FINALIZE); 345bb02b65cSKevin Wolf job->auto_dismiss = !(flags & JOB_MANUAL_DISMISS); 3464ad35181SKevin Wolf job->cb = cb; 3474ad35181SKevin Wolf job->opaque = opaque; 34833e9e9bdSKevin Wolf 349a7b4f8fcSEmanuele Giuseppe Esposito progress_init(&job->progress); 350a7b4f8fcSEmanuele Giuseppe Esposito 351139a9f02SKevin Wolf notifier_list_init(&job->on_finalize_cancelled); 352139a9f02SKevin Wolf notifier_list_init(&job->on_finalize_completed); 353139a9f02SKevin Wolf notifier_list_init(&job->on_pending); 3542e1795b5SKevin Wolf notifier_list_init(&job->on_ready); 355252f4091SEmanuele Giuseppe Esposito notifier_list_init(&job->on_idle); 356139a9f02SKevin Wolf 357a50c2ab8SKevin Wolf job_state_transition(job, JOB_STATUS_CREATED); 3585d43e86eSKevin Wolf aio_timer_init(qemu_get_aio_context(), &job->sleep_timer, 3595d43e86eSKevin Wolf QEMU_CLOCK_REALTIME, SCALE_NS, 3605d43e86eSKevin Wolf job_sleep_timer_cb, job); 361a50c2ab8SKevin Wolf 362e7c1d78bSKevin Wolf QLIST_INSERT_HEAD(&jobs, job, job_list); 363e7c1d78bSKevin Wolf 3647eaa8fb5SKevin Wolf /* Single jobs are modeled as single-job transactions for sake of 3657eaa8fb5SKevin Wolf * consolidating the job management logic */ 3667eaa8fb5SKevin Wolf if (!txn) { 3677eaa8fb5SKevin Wolf txn = job_txn_new(); 3687eaa8fb5SKevin Wolf job_txn_add_job(txn, job); 3697eaa8fb5SKevin Wolf job_txn_unref(txn); 3707eaa8fb5SKevin Wolf } else { 3717eaa8fb5SKevin Wolf job_txn_add_job(txn, job); 3727eaa8fb5SKevin Wolf } 3737eaa8fb5SKevin Wolf 37433e9e9bdSKevin Wolf return job; 37533e9e9bdSKevin Wolf } 376fd61a701SKevin Wolf 37780fa2c75SKevin Wolf void job_ref(Job *job) 378fd61a701SKevin Wolf { 37980fa2c75SKevin Wolf ++job->refcnt; 38080fa2c75SKevin Wolf } 38180fa2c75SKevin Wolf 38280fa2c75SKevin Wolf void job_unref(Job *job) 38380fa2c75SKevin Wolf { 384*c70b8031SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 385*c70b8031SEmanuele Giuseppe Esposito 38680fa2c75SKevin Wolf if (--job->refcnt == 0) { 38780fa2c75SKevin Wolf assert(job->status == JOB_STATUS_NULL); 3885d43e86eSKevin Wolf assert(!timer_pending(&job->sleep_timer)); 3897eaa8fb5SKevin Wolf assert(!job->txn); 39080fa2c75SKevin Wolf 39180fa2c75SKevin Wolf if (job->driver->free) { 39280fa2c75SKevin Wolf job->driver->free(job); 39380fa2c75SKevin Wolf } 39480fa2c75SKevin Wolf 395e7c1d78bSKevin Wolf QLIST_REMOVE(job, job_list); 396e7c1d78bSKevin Wolf 397a7b4f8fcSEmanuele Giuseppe Esposito progress_destroy(&job->progress); 3983d1f8b07SJohn Snow error_free(job->err); 399fd61a701SKevin Wolf g_free(job->id); 400fd61a701SKevin Wolf g_free(job); 401fd61a701SKevin Wolf } 40280fa2c75SKevin Wolf } 4031908a559SKevin Wolf 40430a5c887SKevin Wolf void job_progress_update(Job *job, uint64_t done) 40530a5c887SKevin Wolf { 40601fe1ca9SVladimir Sementsov-Ogievskiy progress_work_done(&job->progress, done); 40730a5c887SKevin Wolf } 40830a5c887SKevin Wolf 40930a5c887SKevin Wolf void job_progress_set_remaining(Job *job, uint64_t remaining) 41030a5c887SKevin Wolf { 41101fe1ca9SVladimir Sementsov-Ogievskiy progress_set_remaining(&job->progress, remaining); 41230a5c887SKevin Wolf } 41330a5c887SKevin Wolf 41462f13600SMax Reitz void job_progress_increase_remaining(Job *job, uint64_t delta) 41562f13600SMax Reitz { 41601fe1ca9SVladimir Sementsov-Ogievskiy progress_increase_remaining(&job->progress, delta); 41762f13600SMax Reitz } 41862f13600SMax Reitz 419139a9f02SKevin Wolf void job_event_cancelled(Job *job) 420139a9f02SKevin Wolf { 421139a9f02SKevin Wolf notifier_list_notify(&job->on_finalize_cancelled, job); 422139a9f02SKevin Wolf } 423139a9f02SKevin Wolf 424139a9f02SKevin Wolf void job_event_completed(Job *job) 425139a9f02SKevin Wolf { 426139a9f02SKevin Wolf notifier_list_notify(&job->on_finalize_completed, job); 427139a9f02SKevin Wolf } 428139a9f02SKevin Wolf 4297eaa8fb5SKevin Wolf static void job_event_pending(Job *job) 430139a9f02SKevin Wolf { 431139a9f02SKevin Wolf notifier_list_notify(&job->on_pending, job); 432139a9f02SKevin Wolf } 433139a9f02SKevin Wolf 4342e1795b5SKevin Wolf static void job_event_ready(Job *job) 4352e1795b5SKevin Wolf { 4362e1795b5SKevin Wolf notifier_list_notify(&job->on_ready, job); 4372e1795b5SKevin Wolf } 4382e1795b5SKevin Wolf 43934dc97b9SKevin Wolf static void job_event_idle(Job *job) 44034dc97b9SKevin Wolf { 44134dc97b9SKevin Wolf notifier_list_notify(&job->on_idle, job); 44234dc97b9SKevin Wolf } 44334dc97b9SKevin Wolf 444da01ff7fSKevin Wolf void job_enter_cond(Job *job, bool(*fn)(Job *job)) 445da01ff7fSKevin Wolf { 446da01ff7fSKevin Wolf if (!job_started(job)) { 447da01ff7fSKevin Wolf return; 448da01ff7fSKevin Wolf } 449da01ff7fSKevin Wolf if (job->deferred_to_main_loop) { 450da01ff7fSKevin Wolf return; 451da01ff7fSKevin Wolf } 452da01ff7fSKevin Wolf 453da01ff7fSKevin Wolf job_lock(); 454da01ff7fSKevin Wolf if (job->busy) { 455da01ff7fSKevin Wolf job_unlock(); 456da01ff7fSKevin Wolf return; 457da01ff7fSKevin Wolf } 458da01ff7fSKevin Wolf 459da01ff7fSKevin Wolf if (fn && !fn(job)) { 460da01ff7fSKevin Wolf job_unlock(); 461da01ff7fSKevin Wolf return; 462da01ff7fSKevin Wolf } 463da01ff7fSKevin Wolf 464da01ff7fSKevin Wolf assert(!job->deferred_to_main_loop); 465da01ff7fSKevin Wolf timer_del(&job->sleep_timer); 466da01ff7fSKevin Wolf job->busy = true; 467da01ff7fSKevin Wolf job_unlock(); 46813726123SKevin Wolf aio_co_enter(job->aio_context, job->co); 469da01ff7fSKevin Wolf } 470da01ff7fSKevin Wolf 4715d43e86eSKevin Wolf void job_enter(Job *job) 4725d43e86eSKevin Wolf { 4735d43e86eSKevin Wolf job_enter_cond(job, NULL); 4745d43e86eSKevin Wolf } 4755d43e86eSKevin Wolf 476da01ff7fSKevin Wolf /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds. 4773d70ff53SKevin Wolf * Reentering the job coroutine with job_enter() before the timer has expired 4783d70ff53SKevin Wolf * is allowed and cancels the timer. 479da01ff7fSKevin Wolf * 4803d70ff53SKevin Wolf * If @ns is (uint64_t) -1, no timer is scheduled and job_enter() must be 481da01ff7fSKevin Wolf * called explicitly. */ 482198c49ccSKevin Wolf static void coroutine_fn job_do_yield(Job *job, uint64_t ns) 483da01ff7fSKevin Wolf { 484da01ff7fSKevin Wolf job_lock(); 485da01ff7fSKevin Wolf if (ns != -1) { 486da01ff7fSKevin Wolf timer_mod(&job->sleep_timer, ns); 487da01ff7fSKevin Wolf } 488da01ff7fSKevin Wolf job->busy = false; 48934dc97b9SKevin Wolf job_event_idle(job); 490da01ff7fSKevin Wolf job_unlock(); 491da01ff7fSKevin Wolf qemu_coroutine_yield(); 492da01ff7fSKevin Wolf 493da01ff7fSKevin Wolf /* Set by job_enter_cond() before re-entering the coroutine. */ 494da01ff7fSKevin Wolf assert(job->busy); 495da01ff7fSKevin Wolf } 496da01ff7fSKevin Wolf 497da01ff7fSKevin Wolf void coroutine_fn job_pause_point(Job *job) 498da01ff7fSKevin Wolf { 499da01ff7fSKevin Wolf assert(job && job_started(job)); 500da01ff7fSKevin Wolf 501da01ff7fSKevin Wolf if (!job_should_pause(job)) { 502da01ff7fSKevin Wolf return; 503da01ff7fSKevin Wolf } 504da01ff7fSKevin Wolf if (job_is_cancelled(job)) { 505da01ff7fSKevin Wolf return; 506da01ff7fSKevin Wolf } 507da01ff7fSKevin Wolf 508da01ff7fSKevin Wolf if (job->driver->pause) { 509da01ff7fSKevin Wolf job->driver->pause(job); 510da01ff7fSKevin Wolf } 511da01ff7fSKevin Wolf 512da01ff7fSKevin Wolf if (job_should_pause(job) && !job_is_cancelled(job)) { 513da01ff7fSKevin Wolf JobStatus status = job->status; 514da01ff7fSKevin Wolf job_state_transition(job, status == JOB_STATUS_READY 515da01ff7fSKevin Wolf ? JOB_STATUS_STANDBY 516da01ff7fSKevin Wolf : JOB_STATUS_PAUSED); 517da01ff7fSKevin Wolf job->paused = true; 518da01ff7fSKevin Wolf job_do_yield(job, -1); 519da01ff7fSKevin Wolf job->paused = false; 520da01ff7fSKevin Wolf job_state_transition(job, status); 521da01ff7fSKevin Wolf } 522da01ff7fSKevin Wolf 523da01ff7fSKevin Wolf if (job->driver->resume) { 524da01ff7fSKevin Wolf job->driver->resume(job); 525da01ff7fSKevin Wolf } 526da01ff7fSKevin Wolf } 527da01ff7fSKevin Wolf 528198c49ccSKevin Wolf void job_yield(Job *job) 529198c49ccSKevin Wolf { 530198c49ccSKevin Wolf assert(job->busy); 531198c49ccSKevin Wolf 532198c49ccSKevin Wolf /* Check cancellation *before* setting busy = false, too! */ 533198c49ccSKevin Wolf if (job_is_cancelled(job)) { 534198c49ccSKevin Wolf return; 535198c49ccSKevin Wolf } 536198c49ccSKevin Wolf 537198c49ccSKevin Wolf if (!job_should_pause(job)) { 538198c49ccSKevin Wolf job_do_yield(job, -1); 539198c49ccSKevin Wolf } 540198c49ccSKevin Wolf 541198c49ccSKevin Wolf job_pause_point(job); 542198c49ccSKevin Wolf } 543198c49ccSKevin Wolf 5445d43e86eSKevin Wolf void coroutine_fn job_sleep_ns(Job *job, int64_t ns) 5455d43e86eSKevin Wolf { 5465d43e86eSKevin Wolf assert(job->busy); 5475d43e86eSKevin Wolf 5485d43e86eSKevin Wolf /* Check cancellation *before* setting busy = false, too! */ 5495d43e86eSKevin Wolf if (job_is_cancelled(job)) { 5505d43e86eSKevin Wolf return; 5515d43e86eSKevin Wolf } 5525d43e86eSKevin Wolf 5535d43e86eSKevin Wolf if (!job_should_pause(job)) { 5545d43e86eSKevin Wolf job_do_yield(job, qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + ns); 5555d43e86eSKevin Wolf } 5565d43e86eSKevin Wolf 5575d43e86eSKevin Wolf job_pause_point(job); 5585d43e86eSKevin Wolf } 5595d43e86eSKevin Wolf 560b15de828SKevin Wolf /* Assumes the block_job_mutex is held */ 561b15de828SKevin Wolf static bool job_timer_not_pending(Job *job) 562b15de828SKevin Wolf { 563b15de828SKevin Wolf return !timer_pending(&job->sleep_timer); 564b15de828SKevin Wolf } 565b15de828SKevin Wolf 566b15de828SKevin Wolf void job_pause(Job *job) 567b15de828SKevin Wolf { 568b15de828SKevin Wolf job->pause_count++; 5693ee1483bSVladimir Sementsov-Ogievskiy if (!job->paused) { 5703ee1483bSVladimir Sementsov-Ogievskiy job_enter(job); 5713ee1483bSVladimir Sementsov-Ogievskiy } 572b15de828SKevin Wolf } 573b15de828SKevin Wolf 574b15de828SKevin Wolf void job_resume(Job *job) 575b15de828SKevin Wolf { 576b15de828SKevin Wolf assert(job->pause_count > 0); 577b15de828SKevin Wolf job->pause_count--; 578b15de828SKevin Wolf if (job->pause_count) { 579b15de828SKevin Wolf return; 580b15de828SKevin Wolf } 581b15de828SKevin Wolf 582b15de828SKevin Wolf /* kick only if no timer is pending */ 583b15de828SKevin Wolf job_enter_cond(job, job_timer_not_pending); 584b15de828SKevin Wolf } 585b15de828SKevin Wolf 586b15de828SKevin Wolf void job_user_pause(Job *job, Error **errp) 587b15de828SKevin Wolf { 588b15de828SKevin Wolf if (job_apply_verb(job, JOB_VERB_PAUSE, errp)) { 589b15de828SKevin Wolf return; 590b15de828SKevin Wolf } 591b15de828SKevin Wolf if (job->user_paused) { 592b15de828SKevin Wolf error_setg(errp, "Job is already paused"); 593b15de828SKevin Wolf return; 594b15de828SKevin Wolf } 595b15de828SKevin Wolf job->user_paused = true; 596b15de828SKevin Wolf job_pause(job); 597b15de828SKevin Wolf } 598b15de828SKevin Wolf 599b15de828SKevin Wolf bool job_user_paused(Job *job) 600b15de828SKevin Wolf { 601b15de828SKevin Wolf return job->user_paused; 602b15de828SKevin Wolf } 603b15de828SKevin Wolf 604b15de828SKevin Wolf void job_user_resume(Job *job, Error **errp) 605b15de828SKevin Wolf { 606b15de828SKevin Wolf assert(job); 607*c70b8031SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 608b15de828SKevin Wolf if (!job->user_paused || job->pause_count <= 0) { 609b15de828SKevin Wolf error_setg(errp, "Can't resume a job that was not paused"); 610b15de828SKevin Wolf return; 611b15de828SKevin Wolf } 612b15de828SKevin Wolf if (job_apply_verb(job, JOB_VERB_RESUME, errp)) { 613b15de828SKevin Wolf return; 614b15de828SKevin Wolf } 615b15de828SKevin Wolf if (job->driver->user_resume) { 616b15de828SKevin Wolf job->driver->user_resume(job); 617b15de828SKevin Wolf } 618b15de828SKevin Wolf job->user_paused = false; 619b15de828SKevin Wolf job_resume(job); 620b15de828SKevin Wolf } 621b15de828SKevin Wolf 6225f9a6a08SKevin Wolf static void job_do_dismiss(Job *job) 6234ad35181SKevin Wolf { 6244ad35181SKevin Wolf assert(job); 6254ad35181SKevin Wolf job->busy = false; 6264ad35181SKevin Wolf job->paused = false; 6274ad35181SKevin Wolf job->deferred_to_main_loop = true; 6284ad35181SKevin Wolf 6297eaa8fb5SKevin Wolf job_txn_del_job(job); 6304ad35181SKevin Wolf 6314ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_NULL); 6324ad35181SKevin Wolf job_unref(job); 6334ad35181SKevin Wolf } 6344ad35181SKevin Wolf 6355f9a6a08SKevin Wolf void job_dismiss(Job **jobptr, Error **errp) 6365f9a6a08SKevin Wolf { 6375f9a6a08SKevin Wolf Job *job = *jobptr; 6385f9a6a08SKevin Wolf /* similarly to _complete, this is QMP-interface only. */ 6395f9a6a08SKevin Wolf assert(job->id); 6405f9a6a08SKevin Wolf if (job_apply_verb(job, JOB_VERB_DISMISS, errp)) { 6415f9a6a08SKevin Wolf return; 6425f9a6a08SKevin Wolf } 6435f9a6a08SKevin Wolf 6445f9a6a08SKevin Wolf job_do_dismiss(job); 6455f9a6a08SKevin Wolf *jobptr = NULL; 6465f9a6a08SKevin Wolf } 6475f9a6a08SKevin Wolf 6484ad35181SKevin Wolf void job_early_fail(Job *job) 6494ad35181SKevin Wolf { 6504ad35181SKevin Wolf assert(job->status == JOB_STATUS_CREATED); 6514ad35181SKevin Wolf job_do_dismiss(job); 6524ad35181SKevin Wolf } 6534ad35181SKevin Wolf 6544ad35181SKevin Wolf static void job_conclude(Job *job) 6554ad35181SKevin Wolf { 6564ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_CONCLUDED); 6574ad35181SKevin Wolf if (job->auto_dismiss || !job_started(job)) { 6584ad35181SKevin Wolf job_do_dismiss(job); 6594ad35181SKevin Wolf } 6604ad35181SKevin Wolf } 6614ad35181SKevin Wolf 6623d70ff53SKevin Wolf static void job_update_rc(Job *job) 6634ad35181SKevin Wolf { 6644ad35181SKevin Wolf if (!job->ret && job_is_cancelled(job)) { 6654ad35181SKevin Wolf job->ret = -ECANCELED; 6664ad35181SKevin Wolf } 6674ad35181SKevin Wolf if (job->ret) { 6683d1f8b07SJohn Snow if (!job->err) { 6693d1f8b07SJohn Snow error_setg(&job->err, "%s", strerror(-job->ret)); 6701266c9b9SKevin Wolf } 6714ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_ABORTING); 6724ad35181SKevin Wolf } 6734ad35181SKevin Wolf } 6744ad35181SKevin Wolf 6754ad35181SKevin Wolf static void job_commit(Job *job) 6764ad35181SKevin Wolf { 6774ad35181SKevin Wolf assert(!job->ret); 678*c70b8031SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 6794ad35181SKevin Wolf if (job->driver->commit) { 6804ad35181SKevin Wolf job->driver->commit(job); 6814ad35181SKevin Wolf } 6824ad35181SKevin Wolf } 6834ad35181SKevin Wolf 6844ad35181SKevin Wolf static void job_abort(Job *job) 6854ad35181SKevin Wolf { 6864ad35181SKevin Wolf assert(job->ret); 687*c70b8031SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 6884ad35181SKevin Wolf if (job->driver->abort) { 6894ad35181SKevin Wolf job->driver->abort(job); 6904ad35181SKevin Wolf } 6914ad35181SKevin Wolf } 6924ad35181SKevin Wolf 6934ad35181SKevin Wolf static void job_clean(Job *job) 6944ad35181SKevin Wolf { 695*c70b8031SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 6964ad35181SKevin Wolf if (job->driver->clean) { 6974ad35181SKevin Wolf job->driver->clean(job); 6984ad35181SKevin Wolf } 6994ad35181SKevin Wolf } 7004ad35181SKevin Wolf 7017eaa8fb5SKevin Wolf static int job_finalize_single(Job *job) 7024ad35181SKevin Wolf { 7034ad35181SKevin Wolf assert(job_is_completed(job)); 7044ad35181SKevin Wolf 7054ad35181SKevin Wolf /* Ensure abort is called for late-transactional failures */ 7064ad35181SKevin Wolf job_update_rc(job); 7074ad35181SKevin Wolf 7084ad35181SKevin Wolf if (!job->ret) { 7094ad35181SKevin Wolf job_commit(job); 7104ad35181SKevin Wolf } else { 7114ad35181SKevin Wolf job_abort(job); 7124ad35181SKevin Wolf } 7134ad35181SKevin Wolf job_clean(job); 7144ad35181SKevin Wolf 7154ad35181SKevin Wolf if (job->cb) { 7164ad35181SKevin Wolf job->cb(job->opaque, job->ret); 7174ad35181SKevin Wolf } 7184ad35181SKevin Wolf 7194ad35181SKevin Wolf /* Emit events only if we actually started */ 7204ad35181SKevin Wolf if (job_started(job)) { 7214ad35181SKevin Wolf if (job_is_cancelled(job)) { 7224ad35181SKevin Wolf job_event_cancelled(job); 7234ad35181SKevin Wolf } else { 7244ad35181SKevin Wolf job_event_completed(job); 7254ad35181SKevin Wolf } 7264ad35181SKevin Wolf } 7274ad35181SKevin Wolf 7287eaa8fb5SKevin Wolf job_txn_del_job(job); 7294ad35181SKevin Wolf job_conclude(job); 7304ad35181SKevin Wolf return 0; 7314ad35181SKevin Wolf } 7324ad35181SKevin Wolf 7333d70ff53SKevin Wolf static void job_cancel_async(Job *job, bool force) 7347eaa8fb5SKevin Wolf { 735*c70b8031SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 7369820933bSVladimir Sementsov-Ogievskiy if (job->driver->cancel) { 73773895f38SHanna Reitz force = job->driver->cancel(job, force); 73873895f38SHanna Reitz } else { 73973895f38SHanna Reitz /* No .cancel() means the job will behave as if force-cancelled */ 74073895f38SHanna Reitz force = true; 7419820933bSVladimir Sementsov-Ogievskiy } 74273895f38SHanna Reitz 7437eaa8fb5SKevin Wolf if (job->user_paused) { 7447eaa8fb5SKevin Wolf /* Do not call job_enter here, the caller will handle it. */ 7457eaa8fb5SKevin Wolf if (job->driver->user_resume) { 7467eaa8fb5SKevin Wolf job->driver->user_resume(job); 7477eaa8fb5SKevin Wolf } 748e321c059SJeff Cody job->user_paused = false; 7497eaa8fb5SKevin Wolf assert(job->pause_count > 0); 7507eaa8fb5SKevin Wolf job->pause_count--; 7517eaa8fb5SKevin Wolf } 752401dd096SHanna Reitz 753401dd096SHanna Reitz /* 754401dd096SHanna Reitz * Ignore soft cancel requests after the job is already done 755401dd096SHanna Reitz * (We will still invoke job->driver->cancel() above, but if the 756401dd096SHanna Reitz * job driver supports soft cancelling and the job is done, that 757401dd096SHanna Reitz * should be a no-op, too. We still call it so it can override 758401dd096SHanna Reitz * @force.) 759401dd096SHanna Reitz */ 760401dd096SHanna Reitz if (force || !job->deferred_to_main_loop) { 7617eaa8fb5SKevin Wolf job->cancelled = true; 7627eaa8fb5SKevin Wolf /* To prevent 'force == false' overriding a previous 'force == true' */ 7637eaa8fb5SKevin Wolf job->force_cancel |= force; 7647eaa8fb5SKevin Wolf } 765401dd096SHanna Reitz } 7667eaa8fb5SKevin Wolf 7673d70ff53SKevin Wolf static void job_completed_txn_abort(Job *job) 7687eaa8fb5SKevin Wolf { 7697eaa8fb5SKevin Wolf AioContext *ctx; 7707eaa8fb5SKevin Wolf JobTxn *txn = job->txn; 7717eaa8fb5SKevin Wolf Job *other_job; 7727eaa8fb5SKevin Wolf 7737eaa8fb5SKevin Wolf if (txn->aborting) { 7747eaa8fb5SKevin Wolf /* 7757eaa8fb5SKevin Wolf * We are cancelled by another job, which will handle everything. 7767eaa8fb5SKevin Wolf */ 7777eaa8fb5SKevin Wolf return; 7787eaa8fb5SKevin Wolf } 7797eaa8fb5SKevin Wolf txn->aborting = true; 7807eaa8fb5SKevin Wolf job_txn_ref(txn); 7817eaa8fb5SKevin Wolf 782d4311314SHanna Reitz /* 783d4311314SHanna Reitz * We can only hold the single job's AioContext lock while calling 784644f3a29SKevin Wolf * job_finalize_single() because the finalization callbacks can involve 785d4311314SHanna Reitz * calls of AIO_WAIT_WHILE(), which could deadlock otherwise. 786d4311314SHanna Reitz * Note that the job's AioContext may change when it is finalized. 787d4311314SHanna Reitz */ 788d4311314SHanna Reitz job_ref(job); 789d4311314SHanna Reitz aio_context_release(job->aio_context); 7907eaa8fb5SKevin Wolf 7917eaa8fb5SKevin Wolf /* Other jobs are effectively cancelled by us, set the status for 7927eaa8fb5SKevin Wolf * them; this job, however, may or may not be cancelled, depending 7937eaa8fb5SKevin Wolf * on the caller, so leave it. */ 7947eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 7957eaa8fb5SKevin Wolf if (other_job != job) { 796644f3a29SKevin Wolf ctx = other_job->aio_context; 797644f3a29SKevin Wolf aio_context_acquire(ctx); 7981d4a43e9SHanna Reitz /* 7991d4a43e9SHanna Reitz * This is a transaction: If one job failed, no result will matter. 8001d4a43e9SHanna Reitz * Therefore, pass force=true to terminate all other jobs as quickly 8011d4a43e9SHanna Reitz * as possible. 8021d4a43e9SHanna Reitz */ 8031d4a43e9SHanna Reitz job_cancel_async(other_job, true); 804644f3a29SKevin Wolf aio_context_release(ctx); 8057eaa8fb5SKevin Wolf } 8067eaa8fb5SKevin Wolf } 8077eaa8fb5SKevin Wolf while (!QLIST_EMPTY(&txn->jobs)) { 8087eaa8fb5SKevin Wolf other_job = QLIST_FIRST(&txn->jobs); 809d4311314SHanna Reitz /* 810d4311314SHanna Reitz * The job's AioContext may change, so store it in @ctx so we 811d4311314SHanna Reitz * release the same context that we have acquired before. 812d4311314SHanna Reitz */ 8137eaa8fb5SKevin Wolf ctx = other_job->aio_context; 814644f3a29SKevin Wolf aio_context_acquire(ctx); 8157eaa8fb5SKevin Wolf if (!job_is_completed(other_job)) { 81608b83bffSHanna Reitz assert(job_cancel_requested(other_job)); 8177eaa8fb5SKevin Wolf job_finish_sync(other_job, NULL, NULL); 8187eaa8fb5SKevin Wolf } 8197eaa8fb5SKevin Wolf job_finalize_single(other_job); 8207eaa8fb5SKevin Wolf aio_context_release(ctx); 8217eaa8fb5SKevin Wolf } 8227eaa8fb5SKevin Wolf 823d4311314SHanna Reitz /* 824d4311314SHanna Reitz * Use job_ref()/job_unref() so we can read the AioContext here 825d4311314SHanna Reitz * even if the job went away during job_finalize_single(). 826d4311314SHanna Reitz */ 827d4311314SHanna Reitz aio_context_acquire(job->aio_context); 828d4311314SHanna Reitz job_unref(job); 829644f3a29SKevin Wolf 8307eaa8fb5SKevin Wolf job_txn_unref(txn); 8317eaa8fb5SKevin Wolf } 8327eaa8fb5SKevin Wolf 8337eaa8fb5SKevin Wolf static int job_prepare(Job *job) 8347eaa8fb5SKevin Wolf { 835*c70b8031SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 8367eaa8fb5SKevin Wolf if (job->ret == 0 && job->driver->prepare) { 8377eaa8fb5SKevin Wolf job->ret = job->driver->prepare(job); 8381266c9b9SKevin Wolf job_update_rc(job); 8397eaa8fb5SKevin Wolf } 8407eaa8fb5SKevin Wolf return job->ret; 8417eaa8fb5SKevin Wolf } 8427eaa8fb5SKevin Wolf 8437eaa8fb5SKevin Wolf static int job_needs_finalize(Job *job) 8447eaa8fb5SKevin Wolf { 8457eaa8fb5SKevin Wolf return !job->auto_finalize; 8467eaa8fb5SKevin Wolf } 8477eaa8fb5SKevin Wolf 8487eaa8fb5SKevin Wolf static void job_do_finalize(Job *job) 8497eaa8fb5SKevin Wolf { 8507eaa8fb5SKevin Wolf int rc; 8517eaa8fb5SKevin Wolf assert(job && job->txn); 8527eaa8fb5SKevin Wolf 8537eaa8fb5SKevin Wolf /* prepare the transaction to complete */ 854b660a84bSStefan Reiter rc = job_txn_apply(job, job_prepare); 8557eaa8fb5SKevin Wolf if (rc) { 8567eaa8fb5SKevin Wolf job_completed_txn_abort(job); 8577eaa8fb5SKevin Wolf } else { 858b660a84bSStefan Reiter job_txn_apply(job, job_finalize_single); 8597eaa8fb5SKevin Wolf } 8607eaa8fb5SKevin Wolf } 8617eaa8fb5SKevin Wolf 8627eaa8fb5SKevin Wolf void job_finalize(Job *job, Error **errp) 8637eaa8fb5SKevin Wolf { 8647eaa8fb5SKevin Wolf assert(job && job->id); 8657eaa8fb5SKevin Wolf if (job_apply_verb(job, JOB_VERB_FINALIZE, errp)) { 8667eaa8fb5SKevin Wolf return; 8677eaa8fb5SKevin Wolf } 8687eaa8fb5SKevin Wolf job_do_finalize(job); 8697eaa8fb5SKevin Wolf } 8707eaa8fb5SKevin Wolf 8717eaa8fb5SKevin Wolf static int job_transition_to_pending(Job *job) 8727eaa8fb5SKevin Wolf { 8737eaa8fb5SKevin Wolf job_state_transition(job, JOB_STATUS_PENDING); 8747eaa8fb5SKevin Wolf if (!job->auto_finalize) { 8757eaa8fb5SKevin Wolf job_event_pending(job); 8767eaa8fb5SKevin Wolf } 8777eaa8fb5SKevin Wolf return 0; 8787eaa8fb5SKevin Wolf } 8797eaa8fb5SKevin Wolf 8802e1795b5SKevin Wolf void job_transition_to_ready(Job *job) 8812e1795b5SKevin Wolf { 8822e1795b5SKevin Wolf job_state_transition(job, JOB_STATUS_READY); 8832e1795b5SKevin Wolf job_event_ready(job); 8842e1795b5SKevin Wolf } 8852e1795b5SKevin Wolf 8863d70ff53SKevin Wolf static void job_completed_txn_success(Job *job) 8877eaa8fb5SKevin Wolf { 8887eaa8fb5SKevin Wolf JobTxn *txn = job->txn; 8897eaa8fb5SKevin Wolf Job *other_job; 8907eaa8fb5SKevin Wolf 8917eaa8fb5SKevin Wolf job_state_transition(job, JOB_STATUS_WAITING); 8927eaa8fb5SKevin Wolf 8937eaa8fb5SKevin Wolf /* 8947eaa8fb5SKevin Wolf * Successful completion, see if there are other running jobs in this 8957eaa8fb5SKevin Wolf * txn. 8967eaa8fb5SKevin Wolf */ 8977eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 8987eaa8fb5SKevin Wolf if (!job_is_completed(other_job)) { 8997eaa8fb5SKevin Wolf return; 9007eaa8fb5SKevin Wolf } 9017eaa8fb5SKevin Wolf assert(other_job->ret == 0); 9027eaa8fb5SKevin Wolf } 9037eaa8fb5SKevin Wolf 904b660a84bSStefan Reiter job_txn_apply(job, job_transition_to_pending); 9057eaa8fb5SKevin Wolf 9067eaa8fb5SKevin Wolf /* If no jobs need manual finalization, automatically do so */ 907b660a84bSStefan Reiter if (job_txn_apply(job, job_needs_finalize) == 0) { 9087eaa8fb5SKevin Wolf job_do_finalize(job); 9097eaa8fb5SKevin Wolf } 9107eaa8fb5SKevin Wolf } 9117eaa8fb5SKevin Wolf 912404ff28dSJohn Snow static void job_completed(Job *job) 9133d70ff53SKevin Wolf { 9143d70ff53SKevin Wolf assert(job && job->txn && !job_is_completed(job)); 9151266c9b9SKevin Wolf 9163d70ff53SKevin Wolf job_update_rc(job); 917404ff28dSJohn Snow trace_job_completed(job, job->ret); 9183d70ff53SKevin Wolf if (job->ret) { 9193d70ff53SKevin Wolf job_completed_txn_abort(job); 9203d70ff53SKevin Wolf } else { 9213d70ff53SKevin Wolf job_completed_txn_success(job); 9223d70ff53SKevin Wolf } 9233d70ff53SKevin Wolf } 9243d70ff53SKevin Wolf 925ccbfb331SJohn Snow /** Useful only as a type shim for aio_bh_schedule_oneshot. */ 926ccbfb331SJohn Snow static void job_exit(void *opaque) 927ccbfb331SJohn Snow { 928ccbfb331SJohn Snow Job *job = (Job *)opaque; 929b660a84bSStefan Reiter AioContext *ctx; 930d1756c78SKevin Wolf 931b660a84bSStefan Reiter job_ref(job); 932b660a84bSStefan Reiter aio_context_acquire(job->aio_context); 933b5a7a057SKevin Wolf 934b5a7a057SKevin Wolf /* This is a lie, we're not quiescent, but still doing the completion 935b5a7a057SKevin Wolf * callbacks. However, completion callbacks tend to involve operations that 936b5a7a057SKevin Wolf * drain block nodes, and if .drained_poll still returned true, we would 937b5a7a057SKevin Wolf * deadlock. */ 938b5a7a057SKevin Wolf job->busy = false; 939b5a7a057SKevin Wolf job_event_idle(job); 940b5a7a057SKevin Wolf 941ccbfb331SJohn Snow job_completed(job); 942b5a7a057SKevin Wolf 943b660a84bSStefan Reiter /* 944b660a84bSStefan Reiter * Note that calling job_completed can move the job to a different 945b660a84bSStefan Reiter * aio_context, so we cannot cache from above. job_txn_apply takes care of 946b660a84bSStefan Reiter * acquiring the new lock, and we ref/unref to avoid job_completed freeing 947b660a84bSStefan Reiter * the job underneath us. 948b660a84bSStefan Reiter */ 949b660a84bSStefan Reiter ctx = job->aio_context; 950b660a84bSStefan Reiter job_unref(job); 951d1756c78SKevin Wolf aio_context_release(ctx); 952ccbfb331SJohn Snow } 953ccbfb331SJohn Snow 954ccbfb331SJohn Snow /** 955ccbfb331SJohn Snow * All jobs must allow a pause point before entering their job proper. This 956ccbfb331SJohn Snow * ensures that jobs can be paused prior to being started, then resumed later. 957ccbfb331SJohn Snow */ 958ccbfb331SJohn Snow static void coroutine_fn job_co_entry(void *opaque) 959ccbfb331SJohn Snow { 960ccbfb331SJohn Snow Job *job = opaque; 961ccbfb331SJohn Snow 962ccbfb331SJohn Snow assert(job && job->driver && job->driver->run); 963*c70b8031SEmanuele Giuseppe Esposito assert(job->aio_context == qemu_get_current_aio_context()); 964ccbfb331SJohn Snow job_pause_point(job); 965ccbfb331SJohn Snow job->ret = job->driver->run(job, &job->err); 966ccbfb331SJohn Snow job->deferred_to_main_loop = true; 967b5a7a057SKevin Wolf job->busy = true; 968ccbfb331SJohn Snow aio_bh_schedule_oneshot(qemu_get_aio_context(), job_exit, job); 969ccbfb331SJohn Snow } 970ccbfb331SJohn Snow 971ccbfb331SJohn Snow void job_start(Job *job) 972ccbfb331SJohn Snow { 973ccbfb331SJohn Snow assert(job && !job_started(job) && job->paused && 974ccbfb331SJohn Snow job->driver && job->driver->run); 975ccbfb331SJohn Snow job->co = qemu_coroutine_create(job_co_entry, job); 976ccbfb331SJohn Snow job->pause_count--; 977ccbfb331SJohn Snow job->busy = true; 978ccbfb331SJohn Snow job->paused = false; 979ccbfb331SJohn Snow job_state_transition(job, JOB_STATUS_RUNNING); 980ccbfb331SJohn Snow aio_co_enter(job->aio_context, job->co); 981ccbfb331SJohn Snow } 982ccbfb331SJohn Snow 9833d70ff53SKevin Wolf void job_cancel(Job *job, bool force) 9843d70ff53SKevin Wolf { 9853d70ff53SKevin Wolf if (job->status == JOB_STATUS_CONCLUDED) { 9863d70ff53SKevin Wolf job_do_dismiss(job); 9873d70ff53SKevin Wolf return; 9883d70ff53SKevin Wolf } 9893d70ff53SKevin Wolf job_cancel_async(job, force); 9903d70ff53SKevin Wolf if (!job_started(job)) { 991404ff28dSJohn Snow job_completed(job); 9923d70ff53SKevin Wolf } else if (job->deferred_to_main_loop) { 993401dd096SHanna Reitz /* 994401dd096SHanna Reitz * job_cancel_async() ignores soft-cancel requests for jobs 995401dd096SHanna Reitz * that are already done (i.e. deferred to the main loop). We 996401dd096SHanna Reitz * have to check again whether the job is really cancelled. 99708b83bffSHanna Reitz * (job_cancel_requested() and job_is_cancelled() are equivalent 99808b83bffSHanna Reitz * here, because job_cancel_async() will make soft-cancel 99908b83bffSHanna Reitz * requests no-ops when deferred_to_main_loop is true. We 100008b83bffSHanna Reitz * choose to call job_is_cancelled() to show that we invoke 100108b83bffSHanna Reitz * job_completed_txn_abort() only for force-cancelled jobs.) 1002401dd096SHanna Reitz */ 1003401dd096SHanna Reitz if (job_is_cancelled(job)) { 10043d70ff53SKevin Wolf job_completed_txn_abort(job); 1005401dd096SHanna Reitz } 10063d70ff53SKevin Wolf } else { 10073d70ff53SKevin Wolf job_enter(job); 10083d70ff53SKevin Wolf } 10093d70ff53SKevin Wolf } 10103d70ff53SKevin Wolf 10113d70ff53SKevin Wolf void job_user_cancel(Job *job, bool force, Error **errp) 10123d70ff53SKevin Wolf { 10133d70ff53SKevin Wolf if (job_apply_verb(job, JOB_VERB_CANCEL, errp)) { 10143d70ff53SKevin Wolf return; 10153d70ff53SKevin Wolf } 10163d70ff53SKevin Wolf job_cancel(job, force); 10173d70ff53SKevin Wolf } 10183d70ff53SKevin Wolf 10193d70ff53SKevin Wolf /* A wrapper around job_cancel() taking an Error ** parameter so it may be 10203d70ff53SKevin Wolf * used with job_finish_sync() without the need for (rather nasty) function 10213d70ff53SKevin Wolf * pointer casts there. */ 10223d70ff53SKevin Wolf static void job_cancel_err(Job *job, Error **errp) 10233d70ff53SKevin Wolf { 10243d70ff53SKevin Wolf job_cancel(job, false); 10253d70ff53SKevin Wolf } 10263d70ff53SKevin Wolf 10274cfb3f05SHanna Reitz /** 10284cfb3f05SHanna Reitz * Same as job_cancel_err(), but force-cancel. 10294cfb3f05SHanna Reitz */ 10304cfb3f05SHanna Reitz static void job_force_cancel_err(Job *job, Error **errp) 10313d70ff53SKevin Wolf { 10324cfb3f05SHanna Reitz job_cancel(job, true); 10334cfb3f05SHanna Reitz } 10344cfb3f05SHanna Reitz 10354cfb3f05SHanna Reitz int job_cancel_sync(Job *job, bool force) 10364cfb3f05SHanna Reitz { 10374cfb3f05SHanna Reitz if (force) { 10384cfb3f05SHanna Reitz return job_finish_sync(job, &job_force_cancel_err, NULL); 10394cfb3f05SHanna Reitz } else { 10403d70ff53SKevin Wolf return job_finish_sync(job, &job_cancel_err, NULL); 10413d70ff53SKevin Wolf } 10424cfb3f05SHanna Reitz } 10433d70ff53SKevin Wolf 10443d70ff53SKevin Wolf void job_cancel_sync_all(void) 10453d70ff53SKevin Wolf { 10463d70ff53SKevin Wolf Job *job; 10473d70ff53SKevin Wolf AioContext *aio_context; 10483d70ff53SKevin Wolf 10493d70ff53SKevin Wolf while ((job = job_next(NULL))) { 10503d70ff53SKevin Wolf aio_context = job->aio_context; 10513d70ff53SKevin Wolf aio_context_acquire(aio_context); 10524cfb3f05SHanna Reitz job_cancel_sync(job, true); 10533d70ff53SKevin Wolf aio_context_release(aio_context); 10543d70ff53SKevin Wolf } 10553d70ff53SKevin Wolf } 10563d70ff53SKevin Wolf 10573d70ff53SKevin Wolf int job_complete_sync(Job *job, Error **errp) 10583d70ff53SKevin Wolf { 10593d70ff53SKevin Wolf return job_finish_sync(job, job_complete, errp); 10603d70ff53SKevin Wolf } 10613d70ff53SKevin Wolf 10623453d972SKevin Wolf void job_complete(Job *job, Error **errp) 10633453d972SKevin Wolf { 10643453d972SKevin Wolf /* Should not be reachable via external interface for internal jobs */ 10653453d972SKevin Wolf assert(job->id); 1066*c70b8031SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 10673453d972SKevin Wolf if (job_apply_verb(job, JOB_VERB_COMPLETE, errp)) { 10683453d972SKevin Wolf return; 10693453d972SKevin Wolf } 107008b83bffSHanna Reitz if (job_cancel_requested(job) || !job->driver->complete) { 10713453d972SKevin Wolf error_setg(errp, "The active block job '%s' cannot be completed", 10723453d972SKevin Wolf job->id); 10733453d972SKevin Wolf return; 10743453d972SKevin Wolf } 10753453d972SKevin Wolf 10763453d972SKevin Wolf job->driver->complete(job, errp); 10773453d972SKevin Wolf } 10783453d972SKevin Wolf 10796a74c075SKevin Wolf int job_finish_sync(Job *job, void (*finish)(Job *, Error **errp), Error **errp) 10806a74c075SKevin Wolf { 10816a74c075SKevin Wolf Error *local_err = NULL; 10826a74c075SKevin Wolf int ret; 10836a74c075SKevin Wolf 10846a74c075SKevin Wolf job_ref(job); 10856a74c075SKevin Wolf 10866a74c075SKevin Wolf if (finish) { 10876a74c075SKevin Wolf finish(job, &local_err); 10886a74c075SKevin Wolf } 10896a74c075SKevin Wolf if (local_err) { 10906a74c075SKevin Wolf error_propagate(errp, local_err); 10916a74c075SKevin Wolf job_unref(job); 10926a74c075SKevin Wolf return -EBUSY; 10936a74c075SKevin Wolf } 1094de0fbe64SKevin Wolf 1095cfe29d82SKevin Wolf AIO_WAIT_WHILE(job->aio_context, 1096bb0c9409SVladimir Sementsov-Ogievskiy (job_enter(job), !job_is_completed(job))); 1097de0fbe64SKevin Wolf 10986a74c075SKevin Wolf ret = (job_is_cancelled(job) && job->ret == 0) ? -ECANCELED : job->ret; 10996a74c075SKevin Wolf job_unref(job); 11006a74c075SKevin Wolf return ret; 11016a74c075SKevin Wolf } 1102