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 3555c5a25aSEmanuele Giuseppe Esposito /* 3655c5a25aSEmanuele Giuseppe Esposito * job_mutex protects the jobs list, but also makes the 3755c5a25aSEmanuele Giuseppe Esposito * struct job fields thread-safe. 3855c5a25aSEmanuele Giuseppe Esposito */ 3955c5a25aSEmanuele Giuseppe Esposito QemuMutex job_mutex; 4055c5a25aSEmanuele Giuseppe Esposito 41e7c1d78bSKevin Wolf static QLIST_HEAD(, Job) jobs = QLIST_HEAD_INITIALIZER(jobs); 42e7c1d78bSKevin Wolf 43a50c2ab8SKevin Wolf /* Job State Transition Table */ 44a50c2ab8SKevin Wolf bool JobSTT[JOB_STATUS__MAX][JOB_STATUS__MAX] = { 45a50c2ab8SKevin Wolf /* U, C, R, P, Y, S, W, D, X, E, N */ 46a50c2ab8SKevin Wolf /* U: */ [JOB_STATUS_UNDEFINED] = {0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0}, 47a50c2ab8SKevin Wolf /* C: */ [JOB_STATUS_CREATED] = {0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 1}, 48a50c2ab8SKevin Wolf /* R: */ [JOB_STATUS_RUNNING] = {0, 0, 0, 1, 1, 0, 1, 0, 1, 0, 0}, 49a50c2ab8SKevin Wolf /* P: */ [JOB_STATUS_PAUSED] = {0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0}, 50a50c2ab8SKevin Wolf /* Y: */ [JOB_STATUS_READY] = {0, 0, 0, 0, 0, 1, 1, 0, 1, 0, 0}, 51a50c2ab8SKevin Wolf /* S: */ [JOB_STATUS_STANDBY] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0}, 52a50c2ab8SKevin Wolf /* W: */ [JOB_STATUS_WAITING] = {0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0}, 53a50c2ab8SKevin Wolf /* D: */ [JOB_STATUS_PENDING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, 54a50c2ab8SKevin Wolf /* X: */ [JOB_STATUS_ABORTING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, 55a50c2ab8SKevin Wolf /* E: */ [JOB_STATUS_CONCLUDED] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}, 56a50c2ab8SKevin Wolf /* N: */ [JOB_STATUS_NULL] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}, 57a50c2ab8SKevin Wolf }; 58a50c2ab8SKevin Wolf 59a50c2ab8SKevin Wolf bool JobVerbTable[JOB_VERB__MAX][JOB_STATUS__MAX] = { 60a50c2ab8SKevin Wolf /* U, C, R, P, Y, S, W, D, X, E, N */ 61a50c2ab8SKevin Wolf [JOB_VERB_CANCEL] = {0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0}, 62a50c2ab8SKevin Wolf [JOB_VERB_PAUSE] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 63a50c2ab8SKevin Wolf [JOB_VERB_RESUME] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 64a50c2ab8SKevin Wolf [JOB_VERB_SET_SPEED] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 6553ddb9c8SMax Reitz [JOB_VERB_COMPLETE] = {0, 0, 0, 0, 1, 1, 0, 0, 0, 0, 0}, 66a50c2ab8SKevin Wolf [JOB_VERB_FINALIZE] = {0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0}, 67a50c2ab8SKevin Wolf [JOB_VERB_DISMISS] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0}, 68a50c2ab8SKevin Wolf }; 69a50c2ab8SKevin Wolf 707eaa8fb5SKevin Wolf /* Transactional group of jobs */ 717eaa8fb5SKevin Wolf struct JobTxn { 727eaa8fb5SKevin Wolf 737eaa8fb5SKevin Wolf /* Is this txn being cancelled? */ 747eaa8fb5SKevin Wolf bool aborting; 757eaa8fb5SKevin Wolf 767eaa8fb5SKevin Wolf /* List of jobs */ 777eaa8fb5SKevin Wolf QLIST_HEAD(, Job) jobs; 787eaa8fb5SKevin Wolf 797eaa8fb5SKevin Wolf /* Reference count */ 807eaa8fb5SKevin Wolf int refcnt; 817eaa8fb5SKevin Wolf }; 827eaa8fb5SKevin Wolf 8355c5a25aSEmanuele Giuseppe Esposito void job_lock(void) 8455c5a25aSEmanuele Giuseppe Esposito { 8555c5a25aSEmanuele Giuseppe Esposito /* nop */ 8655c5a25aSEmanuele Giuseppe Esposito } 87da01ff7fSKevin Wolf 8855c5a25aSEmanuele Giuseppe Esposito void job_unlock(void) 8955c5a25aSEmanuele Giuseppe Esposito { 9055c5a25aSEmanuele Giuseppe Esposito /* nop */ 9155c5a25aSEmanuele Giuseppe Esposito } 9255c5a25aSEmanuele Giuseppe Esposito 9355c5a25aSEmanuele Giuseppe Esposito static void real_job_lock(void) 94da01ff7fSKevin Wolf { 95da01ff7fSKevin Wolf qemu_mutex_lock(&job_mutex); 96da01ff7fSKevin Wolf } 97da01ff7fSKevin Wolf 9855c5a25aSEmanuele Giuseppe Esposito static void real_job_unlock(void) 99da01ff7fSKevin Wolf { 100da01ff7fSKevin Wolf qemu_mutex_unlock(&job_mutex); 101da01ff7fSKevin Wolf } 102da01ff7fSKevin Wolf 103da01ff7fSKevin Wolf static void __attribute__((__constructor__)) job_init(void) 104da01ff7fSKevin Wolf { 105da01ff7fSKevin Wolf qemu_mutex_init(&job_mutex); 106da01ff7fSKevin Wolf } 107da01ff7fSKevin Wolf 1087eaa8fb5SKevin Wolf JobTxn *job_txn_new(void) 1097eaa8fb5SKevin Wolf { 1107eaa8fb5SKevin Wolf JobTxn *txn = g_new0(JobTxn, 1); 1117eaa8fb5SKevin Wolf QLIST_INIT(&txn->jobs); 1127eaa8fb5SKevin Wolf txn->refcnt = 1; 1137eaa8fb5SKevin Wolf return txn; 1147eaa8fb5SKevin Wolf } 1157eaa8fb5SKevin Wolf 1167eaa8fb5SKevin Wolf static void job_txn_ref(JobTxn *txn) 1177eaa8fb5SKevin Wolf { 1187eaa8fb5SKevin Wolf txn->refcnt++; 1197eaa8fb5SKevin Wolf } 1207eaa8fb5SKevin Wolf 1217eaa8fb5SKevin Wolf void job_txn_unref(JobTxn *txn) 1227eaa8fb5SKevin Wolf { 1237eaa8fb5SKevin Wolf if (txn && --txn->refcnt == 0) { 1247eaa8fb5SKevin Wolf g_free(txn); 1257eaa8fb5SKevin Wolf } 1267eaa8fb5SKevin Wolf } 1277eaa8fb5SKevin Wolf 1287eaa8fb5SKevin Wolf void job_txn_add_job(JobTxn *txn, Job *job) 1297eaa8fb5SKevin Wolf { 1307eaa8fb5SKevin Wolf if (!txn) { 1317eaa8fb5SKevin Wolf return; 1327eaa8fb5SKevin Wolf } 1337eaa8fb5SKevin Wolf 1347eaa8fb5SKevin Wolf assert(!job->txn); 1357eaa8fb5SKevin Wolf job->txn = txn; 1367eaa8fb5SKevin Wolf 1377eaa8fb5SKevin Wolf QLIST_INSERT_HEAD(&txn->jobs, job, txn_list); 1387eaa8fb5SKevin Wolf job_txn_ref(txn); 1397eaa8fb5SKevin Wolf } 1407eaa8fb5SKevin Wolf 1417eaa8fb5SKevin Wolf static void job_txn_del_job(Job *job) 1427eaa8fb5SKevin Wolf { 1437eaa8fb5SKevin Wolf if (job->txn) { 1447eaa8fb5SKevin Wolf QLIST_REMOVE(job, txn_list); 1457eaa8fb5SKevin Wolf job_txn_unref(job->txn); 1467eaa8fb5SKevin Wolf job->txn = NULL; 1477eaa8fb5SKevin Wolf } 1487eaa8fb5SKevin Wolf } 1497eaa8fb5SKevin Wolf 150b660a84bSStefan Reiter static int job_txn_apply(Job *job, int fn(Job *)) 1517eaa8fb5SKevin Wolf { 152b660a84bSStefan Reiter AioContext *inner_ctx; 153b660a84bSStefan Reiter Job *other_job, *next; 154b660a84bSStefan Reiter JobTxn *txn = job->txn; 1557eaa8fb5SKevin Wolf int rc = 0; 1567eaa8fb5SKevin Wolf 157b660a84bSStefan Reiter /* 158b660a84bSStefan Reiter * Similar to job_completed_txn_abort, we take each job's lock before 159b660a84bSStefan Reiter * applying fn, but since we assume that outer_ctx is held by the caller, 160b660a84bSStefan Reiter * we need to release it here to avoid holding the lock twice - which would 161b660a84bSStefan Reiter * break AIO_WAIT_WHILE from within fn. 162b660a84bSStefan Reiter */ 163b660a84bSStefan Reiter job_ref(job); 164b660a84bSStefan Reiter aio_context_release(job->aio_context); 165b660a84bSStefan Reiter 166b660a84bSStefan Reiter QLIST_FOREACH_SAFE(other_job, &txn->jobs, txn_list, next) { 167b660a84bSStefan Reiter inner_ctx = other_job->aio_context; 168b660a84bSStefan Reiter aio_context_acquire(inner_ctx); 169b660a84bSStefan Reiter rc = fn(other_job); 170b660a84bSStefan Reiter aio_context_release(inner_ctx); 1717eaa8fb5SKevin Wolf if (rc) { 1727eaa8fb5SKevin Wolf break; 1737eaa8fb5SKevin Wolf } 1747eaa8fb5SKevin Wolf } 175b660a84bSStefan Reiter 176b660a84bSStefan Reiter /* 177b660a84bSStefan Reiter * Note that job->aio_context might have been changed by calling fn, so we 178b660a84bSStefan Reiter * can't use a local variable to cache it. 179b660a84bSStefan Reiter */ 180b660a84bSStefan Reiter aio_context_acquire(job->aio_context); 181b660a84bSStefan Reiter job_unref(job); 1827eaa8fb5SKevin Wolf return rc; 1837eaa8fb5SKevin Wolf } 1847eaa8fb5SKevin Wolf 185456273b0SKevin Wolf bool job_is_internal(Job *job) 1861dac83f1SKevin Wolf { 1871dac83f1SKevin Wolf return (job->id == NULL); 1881dac83f1SKevin Wolf } 1891dac83f1SKevin Wolf 1902e1795b5SKevin Wolf static void job_state_transition(Job *job, JobStatus s1) 191a50c2ab8SKevin Wolf { 192a50c2ab8SKevin Wolf JobStatus s0 = job->status; 193c2032289SLiam Merwick assert(s1 >= 0 && s1 < JOB_STATUS__MAX); 1944ad35181SKevin Wolf trace_job_state_transition(job, job->ret, 195a50c2ab8SKevin Wolf JobSTT[s0][s1] ? "allowed" : "disallowed", 196a50c2ab8SKevin Wolf JobStatus_str(s0), JobStatus_str(s1)); 197a50c2ab8SKevin Wolf assert(JobSTT[s0][s1]); 198a50c2ab8SKevin Wolf job->status = s1; 1991dac83f1SKevin Wolf 2001dac83f1SKevin Wolf if (!job_is_internal(job) && s1 != s0) { 2013ab72385SPeter Xu qapi_event_send_job_status_change(job->id, job->status); 2021dac83f1SKevin Wolf } 203a50c2ab8SKevin Wolf } 204a50c2ab8SKevin Wolf 205a50c2ab8SKevin Wolf int job_apply_verb(Job *job, JobVerb verb, Error **errp) 206a50c2ab8SKevin Wolf { 207a50c2ab8SKevin Wolf JobStatus s0 = job->status; 208c2032289SLiam Merwick assert(verb >= 0 && verb < JOB_VERB__MAX); 209a50c2ab8SKevin Wolf trace_job_apply_verb(job, JobStatus_str(s0), JobVerb_str(verb), 210a50c2ab8SKevin Wolf JobVerbTable[verb][s0] ? "allowed" : "prohibited"); 211a50c2ab8SKevin Wolf if (JobVerbTable[verb][s0]) { 212a50c2ab8SKevin Wolf return 0; 213a50c2ab8SKevin Wolf } 214a50c2ab8SKevin Wolf error_setg(errp, "Job '%s' in state '%s' cannot accept command verb '%s'", 215a50c2ab8SKevin Wolf job->id, JobStatus_str(s0), JobVerb_str(verb)); 216a50c2ab8SKevin Wolf return -EPERM; 217a50c2ab8SKevin Wolf } 218a50c2ab8SKevin Wolf 219252291eaSKevin Wolf JobType job_type(const Job *job) 220252291eaSKevin Wolf { 221252291eaSKevin Wolf return job->driver->job_type; 222252291eaSKevin Wolf } 223252291eaSKevin Wolf 224252291eaSKevin Wolf const char *job_type_str(const Job *job) 225252291eaSKevin Wolf { 226252291eaSKevin Wolf return JobType_str(job_type(job)); 227252291eaSKevin Wolf } 228252291eaSKevin Wolf 229daa7f2f9SKevin Wolf bool job_is_cancelled(Job *job) 230daa7f2f9SKevin Wolf { 231a640fa0eSHanna Reitz /* force_cancel may be true only if cancelled is true, too */ 232a640fa0eSHanna Reitz assert(job->cancelled || !job->force_cancel); 233a640fa0eSHanna Reitz return job->force_cancel; 23408b83bffSHanna Reitz } 23508b83bffSHanna Reitz 23608b83bffSHanna Reitz bool job_cancel_requested(Job *job) 23708b83bffSHanna Reitz { 238daa7f2f9SKevin Wolf return job->cancelled; 239daa7f2f9SKevin Wolf } 240daa7f2f9SKevin Wolf 241df956ae2SKevin Wolf bool job_is_ready(Job *job) 242df956ae2SKevin Wolf { 243df956ae2SKevin Wolf switch (job->status) { 244df956ae2SKevin Wolf case JOB_STATUS_UNDEFINED: 245df956ae2SKevin Wolf case JOB_STATUS_CREATED: 246df956ae2SKevin Wolf case JOB_STATUS_RUNNING: 247df956ae2SKevin Wolf case JOB_STATUS_PAUSED: 248df956ae2SKevin Wolf case JOB_STATUS_WAITING: 249df956ae2SKevin Wolf case JOB_STATUS_PENDING: 250df956ae2SKevin Wolf case JOB_STATUS_ABORTING: 251df956ae2SKevin Wolf case JOB_STATUS_CONCLUDED: 252df956ae2SKevin Wolf case JOB_STATUS_NULL: 253df956ae2SKevin Wolf return false; 254df956ae2SKevin Wolf case JOB_STATUS_READY: 255df956ae2SKevin Wolf case JOB_STATUS_STANDBY: 256df956ae2SKevin Wolf return true; 257df956ae2SKevin Wolf default: 258df956ae2SKevin Wolf g_assert_not_reached(); 259df956ae2SKevin Wolf } 260df956ae2SKevin Wolf return false; 261df956ae2SKevin Wolf } 262df956ae2SKevin Wolf 263dbe5e6c1SKevin Wolf bool job_is_completed(Job *job) 264dbe5e6c1SKevin Wolf { 265dbe5e6c1SKevin Wolf switch (job->status) { 266dbe5e6c1SKevin Wolf case JOB_STATUS_UNDEFINED: 267dbe5e6c1SKevin Wolf case JOB_STATUS_CREATED: 268dbe5e6c1SKevin Wolf case JOB_STATUS_RUNNING: 269dbe5e6c1SKevin Wolf case JOB_STATUS_PAUSED: 270dbe5e6c1SKevin Wolf case JOB_STATUS_READY: 271dbe5e6c1SKevin Wolf case JOB_STATUS_STANDBY: 272dbe5e6c1SKevin Wolf return false; 273dbe5e6c1SKevin Wolf case JOB_STATUS_WAITING: 274dbe5e6c1SKevin Wolf case JOB_STATUS_PENDING: 275dbe5e6c1SKevin Wolf case JOB_STATUS_ABORTING: 276dbe5e6c1SKevin Wolf case JOB_STATUS_CONCLUDED: 277dbe5e6c1SKevin Wolf case JOB_STATUS_NULL: 278dbe5e6c1SKevin Wolf return true; 279dbe5e6c1SKevin Wolf default: 280dbe5e6c1SKevin Wolf g_assert_not_reached(); 281dbe5e6c1SKevin Wolf } 282dbe5e6c1SKevin Wolf return false; 283dbe5e6c1SKevin Wolf } 284dbe5e6c1SKevin Wolf 2853d70ff53SKevin Wolf static bool job_started(Job *job) 286da01ff7fSKevin Wolf { 287da01ff7fSKevin Wolf return job->co; 288da01ff7fSKevin Wolf } 289da01ff7fSKevin Wolf 290198c49ccSKevin Wolf static bool job_should_pause(Job *job) 291da01ff7fSKevin Wolf { 292da01ff7fSKevin Wolf return job->pause_count > 0; 293da01ff7fSKevin Wolf } 294da01ff7fSKevin Wolf 295e7c1d78bSKevin Wolf Job *job_next(Job *job) 296e7c1d78bSKevin Wolf { 297e7c1d78bSKevin Wolf if (!job) { 298e7c1d78bSKevin Wolf return QLIST_FIRST(&jobs); 299e7c1d78bSKevin Wolf } 300e7c1d78bSKevin Wolf return QLIST_NEXT(job, job_list); 301e7c1d78bSKevin Wolf } 302e7c1d78bSKevin Wolf 303e7c1d78bSKevin Wolf Job *job_get(const char *id) 304e7c1d78bSKevin Wolf { 305e7c1d78bSKevin Wolf Job *job; 306e7c1d78bSKevin Wolf 307e7c1d78bSKevin Wolf QLIST_FOREACH(job, &jobs, job_list) { 308e7c1d78bSKevin Wolf if (job->id && !strcmp(id, job->id)) { 309e7c1d78bSKevin Wolf return job; 310e7c1d78bSKevin Wolf } 311e7c1d78bSKevin Wolf } 312e7c1d78bSKevin Wolf 313e7c1d78bSKevin Wolf return NULL; 314e7c1d78bSKevin Wolf } 315e7c1d78bSKevin Wolf 3165d43e86eSKevin Wolf static void job_sleep_timer_cb(void *opaque) 3175d43e86eSKevin Wolf { 3185d43e86eSKevin Wolf Job *job = opaque; 3195d43e86eSKevin Wolf 3205d43e86eSKevin Wolf job_enter(job); 3215d43e86eSKevin Wolf } 3225d43e86eSKevin Wolf 3237eaa8fb5SKevin Wolf void *job_create(const char *job_id, const JobDriver *driver, JobTxn *txn, 3247eaa8fb5SKevin Wolf AioContext *ctx, int flags, BlockCompletionFunc *cb, 3257eaa8fb5SKevin Wolf void *opaque, Error **errp) 32633e9e9bdSKevin Wolf { 32733e9e9bdSKevin Wolf Job *job; 32833e9e9bdSKevin Wolf 32933e9e9bdSKevin Wolf if (job_id) { 330bb02b65cSKevin Wolf if (flags & JOB_INTERNAL) { 331bb02b65cSKevin Wolf error_setg(errp, "Cannot specify job ID for internal job"); 332bb02b65cSKevin Wolf return NULL; 333bb02b65cSKevin Wolf } 33433e9e9bdSKevin Wolf if (!id_wellformed(job_id)) { 33533e9e9bdSKevin Wolf error_setg(errp, "Invalid job ID '%s'", job_id); 33633e9e9bdSKevin Wolf return NULL; 33733e9e9bdSKevin Wolf } 338e7c1d78bSKevin Wolf if (job_get(job_id)) { 339e7c1d78bSKevin Wolf error_setg(errp, "Job ID '%s' already in use", job_id); 340e7c1d78bSKevin Wolf return NULL; 341e7c1d78bSKevin Wolf } 342bb02b65cSKevin Wolf } else if (!(flags & JOB_INTERNAL)) { 343bb02b65cSKevin Wolf error_setg(errp, "An explicit job ID is required"); 344bb02b65cSKevin Wolf return NULL; 34533e9e9bdSKevin Wolf } 34633e9e9bdSKevin Wolf 34733e9e9bdSKevin Wolf job = g_malloc0(driver->instance_size); 34833e9e9bdSKevin Wolf job->driver = driver; 34933e9e9bdSKevin Wolf job->id = g_strdup(job_id); 35080fa2c75SKevin Wolf job->refcnt = 1; 35108be6fe2SKevin Wolf job->aio_context = ctx; 352da01ff7fSKevin Wolf job->busy = false; 353da01ff7fSKevin Wolf job->paused = true; 354da01ff7fSKevin Wolf job->pause_count = 1; 355bb02b65cSKevin Wolf job->auto_finalize = !(flags & JOB_MANUAL_FINALIZE); 356bb02b65cSKevin Wolf job->auto_dismiss = !(flags & JOB_MANUAL_DISMISS); 3574ad35181SKevin Wolf job->cb = cb; 3584ad35181SKevin Wolf job->opaque = opaque; 35933e9e9bdSKevin Wolf 360a7b4f8fcSEmanuele Giuseppe Esposito progress_init(&job->progress); 361a7b4f8fcSEmanuele Giuseppe Esposito 362139a9f02SKevin Wolf notifier_list_init(&job->on_finalize_cancelled); 363139a9f02SKevin Wolf notifier_list_init(&job->on_finalize_completed); 364139a9f02SKevin Wolf notifier_list_init(&job->on_pending); 3652e1795b5SKevin Wolf notifier_list_init(&job->on_ready); 366252f4091SEmanuele Giuseppe Esposito notifier_list_init(&job->on_idle); 367139a9f02SKevin Wolf 368a50c2ab8SKevin Wolf job_state_transition(job, JOB_STATUS_CREATED); 3695d43e86eSKevin Wolf aio_timer_init(qemu_get_aio_context(), &job->sleep_timer, 3705d43e86eSKevin Wolf QEMU_CLOCK_REALTIME, SCALE_NS, 3715d43e86eSKevin Wolf job_sleep_timer_cb, job); 372a50c2ab8SKevin Wolf 373e7c1d78bSKevin Wolf QLIST_INSERT_HEAD(&jobs, job, job_list); 374e7c1d78bSKevin Wolf 3757eaa8fb5SKevin Wolf /* Single jobs are modeled as single-job transactions for sake of 3767eaa8fb5SKevin Wolf * consolidating the job management logic */ 3777eaa8fb5SKevin Wolf if (!txn) { 3787eaa8fb5SKevin Wolf txn = job_txn_new(); 3797eaa8fb5SKevin Wolf job_txn_add_job(txn, job); 3807eaa8fb5SKevin Wolf job_txn_unref(txn); 3817eaa8fb5SKevin Wolf } else { 3827eaa8fb5SKevin Wolf job_txn_add_job(txn, job); 3837eaa8fb5SKevin Wolf } 3847eaa8fb5SKevin Wolf 38533e9e9bdSKevin Wolf return job; 38633e9e9bdSKevin Wolf } 387fd61a701SKevin Wolf 38880fa2c75SKevin Wolf void job_ref(Job *job) 389fd61a701SKevin Wolf { 39080fa2c75SKevin Wolf ++job->refcnt; 39180fa2c75SKevin Wolf } 39280fa2c75SKevin Wolf 39380fa2c75SKevin Wolf void job_unref(Job *job) 39480fa2c75SKevin Wolf { 395c70b8031SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 396c70b8031SEmanuele Giuseppe Esposito 39780fa2c75SKevin Wolf if (--job->refcnt == 0) { 39880fa2c75SKevin Wolf assert(job->status == JOB_STATUS_NULL); 3995d43e86eSKevin Wolf assert(!timer_pending(&job->sleep_timer)); 4007eaa8fb5SKevin Wolf assert(!job->txn); 40180fa2c75SKevin Wolf 40280fa2c75SKevin Wolf if (job->driver->free) { 40380fa2c75SKevin Wolf job->driver->free(job); 40480fa2c75SKevin Wolf } 40580fa2c75SKevin Wolf 406e7c1d78bSKevin Wolf QLIST_REMOVE(job, job_list); 407e7c1d78bSKevin Wolf 408a7b4f8fcSEmanuele Giuseppe Esposito progress_destroy(&job->progress); 4093d1f8b07SJohn Snow error_free(job->err); 410fd61a701SKevin Wolf g_free(job->id); 411fd61a701SKevin Wolf g_free(job); 412fd61a701SKevin Wolf } 41380fa2c75SKevin Wolf } 4141908a559SKevin Wolf 41530a5c887SKevin Wolf void job_progress_update(Job *job, uint64_t done) 41630a5c887SKevin Wolf { 41701fe1ca9SVladimir Sementsov-Ogievskiy progress_work_done(&job->progress, done); 41830a5c887SKevin Wolf } 41930a5c887SKevin Wolf 42030a5c887SKevin Wolf void job_progress_set_remaining(Job *job, uint64_t remaining) 42130a5c887SKevin Wolf { 42201fe1ca9SVladimir Sementsov-Ogievskiy progress_set_remaining(&job->progress, remaining); 42330a5c887SKevin Wolf } 42430a5c887SKevin Wolf 42562f13600SMax Reitz void job_progress_increase_remaining(Job *job, uint64_t delta) 42662f13600SMax Reitz { 42701fe1ca9SVladimir Sementsov-Ogievskiy progress_increase_remaining(&job->progress, delta); 42862f13600SMax Reitz } 42962f13600SMax Reitz 430139a9f02SKevin Wolf void job_event_cancelled(Job *job) 431139a9f02SKevin Wolf { 432139a9f02SKevin Wolf notifier_list_notify(&job->on_finalize_cancelled, job); 433139a9f02SKevin Wolf } 434139a9f02SKevin Wolf 435139a9f02SKevin Wolf void job_event_completed(Job *job) 436139a9f02SKevin Wolf { 437139a9f02SKevin Wolf notifier_list_notify(&job->on_finalize_completed, job); 438139a9f02SKevin Wolf } 439139a9f02SKevin Wolf 4407eaa8fb5SKevin Wolf static void job_event_pending(Job *job) 441139a9f02SKevin Wolf { 442139a9f02SKevin Wolf notifier_list_notify(&job->on_pending, job); 443139a9f02SKevin Wolf } 444139a9f02SKevin Wolf 4452e1795b5SKevin Wolf static void job_event_ready(Job *job) 4462e1795b5SKevin Wolf { 4472e1795b5SKevin Wolf notifier_list_notify(&job->on_ready, job); 4482e1795b5SKevin Wolf } 4492e1795b5SKevin Wolf 45034dc97b9SKevin Wolf static void job_event_idle(Job *job) 45134dc97b9SKevin Wolf { 45234dc97b9SKevin Wolf notifier_list_notify(&job->on_idle, job); 45334dc97b9SKevin Wolf } 45434dc97b9SKevin Wolf 455da01ff7fSKevin Wolf void job_enter_cond(Job *job, bool(*fn)(Job *job)) 456da01ff7fSKevin Wolf { 457da01ff7fSKevin Wolf if (!job_started(job)) { 458da01ff7fSKevin Wolf return; 459da01ff7fSKevin Wolf } 460da01ff7fSKevin Wolf if (job->deferred_to_main_loop) { 461da01ff7fSKevin Wolf return; 462da01ff7fSKevin Wolf } 463da01ff7fSKevin Wolf 46455c5a25aSEmanuele Giuseppe Esposito real_job_lock(); 465da01ff7fSKevin Wolf if (job->busy) { 46655c5a25aSEmanuele Giuseppe Esposito real_job_unlock(); 467da01ff7fSKevin Wolf return; 468da01ff7fSKevin Wolf } 469da01ff7fSKevin Wolf 470da01ff7fSKevin Wolf if (fn && !fn(job)) { 47155c5a25aSEmanuele Giuseppe Esposito real_job_unlock(); 472da01ff7fSKevin Wolf return; 473da01ff7fSKevin Wolf } 474da01ff7fSKevin Wolf 475da01ff7fSKevin Wolf assert(!job->deferred_to_main_loop); 476da01ff7fSKevin Wolf timer_del(&job->sleep_timer); 477da01ff7fSKevin Wolf job->busy = true; 47855c5a25aSEmanuele Giuseppe Esposito real_job_unlock(); 47913726123SKevin Wolf aio_co_enter(job->aio_context, job->co); 480da01ff7fSKevin Wolf } 481da01ff7fSKevin Wolf 4825d43e86eSKevin Wolf void job_enter(Job *job) 4835d43e86eSKevin Wolf { 4845d43e86eSKevin Wolf job_enter_cond(job, NULL); 4855d43e86eSKevin Wolf } 4865d43e86eSKevin Wolf 487da01ff7fSKevin Wolf /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds. 4883d70ff53SKevin Wolf * Reentering the job coroutine with job_enter() before the timer has expired 4893d70ff53SKevin Wolf * is allowed and cancels the timer. 490da01ff7fSKevin Wolf * 4913d70ff53SKevin Wolf * If @ns is (uint64_t) -1, no timer is scheduled and job_enter() must be 492da01ff7fSKevin Wolf * called explicitly. */ 493198c49ccSKevin Wolf static void coroutine_fn job_do_yield(Job *job, uint64_t ns) 494da01ff7fSKevin Wolf { 49555c5a25aSEmanuele Giuseppe Esposito real_job_lock(); 496da01ff7fSKevin Wolf if (ns != -1) { 497da01ff7fSKevin Wolf timer_mod(&job->sleep_timer, ns); 498da01ff7fSKevin Wolf } 499da01ff7fSKevin Wolf job->busy = false; 50034dc97b9SKevin Wolf job_event_idle(job); 50155c5a25aSEmanuele Giuseppe Esposito real_job_unlock(); 502da01ff7fSKevin Wolf qemu_coroutine_yield(); 503da01ff7fSKevin Wolf 504da01ff7fSKevin Wolf /* Set by job_enter_cond() before re-entering the coroutine. */ 505da01ff7fSKevin Wolf assert(job->busy); 506da01ff7fSKevin Wolf } 507da01ff7fSKevin Wolf 508da01ff7fSKevin Wolf void coroutine_fn job_pause_point(Job *job) 509da01ff7fSKevin Wolf { 510da01ff7fSKevin Wolf assert(job && job_started(job)); 511da01ff7fSKevin Wolf 512da01ff7fSKevin Wolf if (!job_should_pause(job)) { 513da01ff7fSKevin Wolf return; 514da01ff7fSKevin Wolf } 515da01ff7fSKevin Wolf if (job_is_cancelled(job)) { 516da01ff7fSKevin Wolf return; 517da01ff7fSKevin Wolf } 518da01ff7fSKevin Wolf 519da01ff7fSKevin Wolf if (job->driver->pause) { 520da01ff7fSKevin Wolf job->driver->pause(job); 521da01ff7fSKevin Wolf } 522da01ff7fSKevin Wolf 523da01ff7fSKevin Wolf if (job_should_pause(job) && !job_is_cancelled(job)) { 524da01ff7fSKevin Wolf JobStatus status = job->status; 525da01ff7fSKevin Wolf job_state_transition(job, status == JOB_STATUS_READY 526da01ff7fSKevin Wolf ? JOB_STATUS_STANDBY 527da01ff7fSKevin Wolf : JOB_STATUS_PAUSED); 528da01ff7fSKevin Wolf job->paused = true; 529da01ff7fSKevin Wolf job_do_yield(job, -1); 530da01ff7fSKevin Wolf job->paused = false; 531da01ff7fSKevin Wolf job_state_transition(job, status); 532da01ff7fSKevin Wolf } 533da01ff7fSKevin Wolf 534da01ff7fSKevin Wolf if (job->driver->resume) { 535da01ff7fSKevin Wolf job->driver->resume(job); 536da01ff7fSKevin Wolf } 537da01ff7fSKevin Wolf } 538da01ff7fSKevin Wolf 53906753a07SPaolo Bonzini void coroutine_fn job_yield(Job *job) 540198c49ccSKevin Wolf { 541198c49ccSKevin Wolf assert(job->busy); 542198c49ccSKevin Wolf 543198c49ccSKevin Wolf /* Check cancellation *before* setting busy = false, too! */ 544198c49ccSKevin Wolf if (job_is_cancelled(job)) { 545198c49ccSKevin Wolf return; 546198c49ccSKevin Wolf } 547198c49ccSKevin Wolf 548198c49ccSKevin Wolf if (!job_should_pause(job)) { 549198c49ccSKevin Wolf job_do_yield(job, -1); 550198c49ccSKevin Wolf } 551198c49ccSKevin Wolf 552198c49ccSKevin Wolf job_pause_point(job); 553198c49ccSKevin Wolf } 554198c49ccSKevin Wolf 5555d43e86eSKevin Wolf void coroutine_fn job_sleep_ns(Job *job, int64_t ns) 5565d43e86eSKevin Wolf { 5575d43e86eSKevin Wolf assert(job->busy); 5585d43e86eSKevin Wolf 5595d43e86eSKevin Wolf /* Check cancellation *before* setting busy = false, too! */ 5605d43e86eSKevin Wolf if (job_is_cancelled(job)) { 5615d43e86eSKevin Wolf return; 5625d43e86eSKevin Wolf } 5635d43e86eSKevin Wolf 5645d43e86eSKevin Wolf if (!job_should_pause(job)) { 5655d43e86eSKevin Wolf job_do_yield(job, qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + ns); 5665d43e86eSKevin Wolf } 5675d43e86eSKevin Wolf 5685d43e86eSKevin Wolf job_pause_point(job); 5695d43e86eSKevin Wolf } 5705d43e86eSKevin Wolf 571b15de828SKevin Wolf /* Assumes the block_job_mutex is held */ 572b15de828SKevin Wolf static bool job_timer_not_pending(Job *job) 573b15de828SKevin Wolf { 574b15de828SKevin Wolf return !timer_pending(&job->sleep_timer); 575b15de828SKevin Wolf } 576b15de828SKevin Wolf 577b15de828SKevin Wolf void job_pause(Job *job) 578b15de828SKevin Wolf { 579b15de828SKevin Wolf job->pause_count++; 5803ee1483bSVladimir Sementsov-Ogievskiy if (!job->paused) { 5813ee1483bSVladimir Sementsov-Ogievskiy job_enter(job); 5823ee1483bSVladimir Sementsov-Ogievskiy } 583b15de828SKevin Wolf } 584b15de828SKevin Wolf 585b15de828SKevin Wolf void job_resume(Job *job) 586b15de828SKevin Wolf { 587b15de828SKevin Wolf assert(job->pause_count > 0); 588b15de828SKevin Wolf job->pause_count--; 589b15de828SKevin Wolf if (job->pause_count) { 590b15de828SKevin Wolf return; 591b15de828SKevin Wolf } 592b15de828SKevin Wolf 593b15de828SKevin Wolf /* kick only if no timer is pending */ 594b15de828SKevin Wolf job_enter_cond(job, job_timer_not_pending); 595b15de828SKevin Wolf } 596b15de828SKevin Wolf 597b15de828SKevin Wolf void job_user_pause(Job *job, Error **errp) 598b15de828SKevin Wolf { 599b15de828SKevin Wolf if (job_apply_verb(job, JOB_VERB_PAUSE, errp)) { 600b15de828SKevin Wolf return; 601b15de828SKevin Wolf } 602b15de828SKevin Wolf if (job->user_paused) { 603b15de828SKevin Wolf error_setg(errp, "Job is already paused"); 604b15de828SKevin Wolf return; 605b15de828SKevin Wolf } 606b15de828SKevin Wolf job->user_paused = true; 607b15de828SKevin Wolf job_pause(job); 608b15de828SKevin Wolf } 609b15de828SKevin Wolf 610b15de828SKevin Wolf bool job_user_paused(Job *job) 611b15de828SKevin Wolf { 612b15de828SKevin Wolf return job->user_paused; 613b15de828SKevin Wolf } 614b15de828SKevin Wolf 615b15de828SKevin Wolf void job_user_resume(Job *job, Error **errp) 616b15de828SKevin Wolf { 617b15de828SKevin Wolf assert(job); 618c70b8031SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 619b15de828SKevin Wolf if (!job->user_paused || job->pause_count <= 0) { 620b15de828SKevin Wolf error_setg(errp, "Can't resume a job that was not paused"); 621b15de828SKevin Wolf return; 622b15de828SKevin Wolf } 623b15de828SKevin Wolf if (job_apply_verb(job, JOB_VERB_RESUME, errp)) { 624b15de828SKevin Wolf return; 625b15de828SKevin Wolf } 626b15de828SKevin Wolf if (job->driver->user_resume) { 627b15de828SKevin Wolf job->driver->user_resume(job); 628b15de828SKevin Wolf } 629b15de828SKevin Wolf job->user_paused = false; 630b15de828SKevin Wolf job_resume(job); 631b15de828SKevin Wolf } 632b15de828SKevin Wolf 6335f9a6a08SKevin Wolf static void job_do_dismiss(Job *job) 6344ad35181SKevin Wolf { 6354ad35181SKevin Wolf assert(job); 6364ad35181SKevin Wolf job->busy = false; 6374ad35181SKevin Wolf job->paused = false; 6384ad35181SKevin Wolf job->deferred_to_main_loop = true; 6394ad35181SKevin Wolf 6407eaa8fb5SKevin Wolf job_txn_del_job(job); 6414ad35181SKevin Wolf 6424ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_NULL); 6434ad35181SKevin Wolf job_unref(job); 6444ad35181SKevin Wolf } 6454ad35181SKevin Wolf 6465f9a6a08SKevin Wolf void job_dismiss(Job **jobptr, Error **errp) 6475f9a6a08SKevin Wolf { 6485f9a6a08SKevin Wolf Job *job = *jobptr; 6495f9a6a08SKevin Wolf /* similarly to _complete, this is QMP-interface only. */ 6505f9a6a08SKevin Wolf assert(job->id); 6515f9a6a08SKevin Wolf if (job_apply_verb(job, JOB_VERB_DISMISS, errp)) { 6525f9a6a08SKevin Wolf return; 6535f9a6a08SKevin Wolf } 6545f9a6a08SKevin Wolf 6555f9a6a08SKevin Wolf job_do_dismiss(job); 6565f9a6a08SKevin Wolf *jobptr = NULL; 6575f9a6a08SKevin Wolf } 6585f9a6a08SKevin Wolf 6594ad35181SKevin Wolf void job_early_fail(Job *job) 6604ad35181SKevin Wolf { 6614ad35181SKevin Wolf assert(job->status == JOB_STATUS_CREATED); 6624ad35181SKevin Wolf job_do_dismiss(job); 6634ad35181SKevin Wolf } 6644ad35181SKevin Wolf 6654ad35181SKevin Wolf static void job_conclude(Job *job) 6664ad35181SKevin Wolf { 6674ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_CONCLUDED); 6684ad35181SKevin Wolf if (job->auto_dismiss || !job_started(job)) { 6694ad35181SKevin Wolf job_do_dismiss(job); 6704ad35181SKevin Wolf } 6714ad35181SKevin Wolf } 6724ad35181SKevin Wolf 6733d70ff53SKevin Wolf static void job_update_rc(Job *job) 6744ad35181SKevin Wolf { 6754ad35181SKevin Wolf if (!job->ret && job_is_cancelled(job)) { 6764ad35181SKevin Wolf job->ret = -ECANCELED; 6774ad35181SKevin Wolf } 6784ad35181SKevin Wolf if (job->ret) { 6793d1f8b07SJohn Snow if (!job->err) { 6803d1f8b07SJohn Snow error_setg(&job->err, "%s", strerror(-job->ret)); 6811266c9b9SKevin Wolf } 6824ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_ABORTING); 6834ad35181SKevin Wolf } 6844ad35181SKevin Wolf } 6854ad35181SKevin Wolf 6864ad35181SKevin Wolf static void job_commit(Job *job) 6874ad35181SKevin Wolf { 6884ad35181SKevin Wolf assert(!job->ret); 689c70b8031SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 6904ad35181SKevin Wolf if (job->driver->commit) { 6914ad35181SKevin Wolf job->driver->commit(job); 6924ad35181SKevin Wolf } 6934ad35181SKevin Wolf } 6944ad35181SKevin Wolf 6954ad35181SKevin Wolf static void job_abort(Job *job) 6964ad35181SKevin Wolf { 6974ad35181SKevin Wolf assert(job->ret); 698c70b8031SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 6994ad35181SKevin Wolf if (job->driver->abort) { 7004ad35181SKevin Wolf job->driver->abort(job); 7014ad35181SKevin Wolf } 7024ad35181SKevin Wolf } 7034ad35181SKevin Wolf 7044ad35181SKevin Wolf static void job_clean(Job *job) 7054ad35181SKevin Wolf { 706c70b8031SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 7074ad35181SKevin Wolf if (job->driver->clean) { 7084ad35181SKevin Wolf job->driver->clean(job); 7094ad35181SKevin Wolf } 7104ad35181SKevin Wolf } 7114ad35181SKevin Wolf 7127eaa8fb5SKevin Wolf static int job_finalize_single(Job *job) 7134ad35181SKevin Wolf { 7144ad35181SKevin Wolf assert(job_is_completed(job)); 7154ad35181SKevin Wolf 7164ad35181SKevin Wolf /* Ensure abort is called for late-transactional failures */ 7174ad35181SKevin Wolf job_update_rc(job); 7184ad35181SKevin Wolf 7194ad35181SKevin Wolf if (!job->ret) { 7204ad35181SKevin Wolf job_commit(job); 7214ad35181SKevin Wolf } else { 7224ad35181SKevin Wolf job_abort(job); 7234ad35181SKevin Wolf } 7244ad35181SKevin Wolf job_clean(job); 7254ad35181SKevin Wolf 7264ad35181SKevin Wolf if (job->cb) { 7274ad35181SKevin Wolf job->cb(job->opaque, job->ret); 7284ad35181SKevin Wolf } 7294ad35181SKevin Wolf 7304ad35181SKevin Wolf /* Emit events only if we actually started */ 7314ad35181SKevin Wolf if (job_started(job)) { 7324ad35181SKevin Wolf if (job_is_cancelled(job)) { 7334ad35181SKevin Wolf job_event_cancelled(job); 7344ad35181SKevin Wolf } else { 7354ad35181SKevin Wolf job_event_completed(job); 7364ad35181SKevin Wolf } 7374ad35181SKevin Wolf } 7384ad35181SKevin Wolf 7397eaa8fb5SKevin Wolf job_txn_del_job(job); 7404ad35181SKevin Wolf job_conclude(job); 7414ad35181SKevin Wolf return 0; 7424ad35181SKevin Wolf } 7434ad35181SKevin Wolf 7443d70ff53SKevin Wolf static void job_cancel_async(Job *job, bool force) 7457eaa8fb5SKevin Wolf { 746c70b8031SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 7479820933bSVladimir Sementsov-Ogievskiy if (job->driver->cancel) { 74873895f38SHanna Reitz force = job->driver->cancel(job, force); 74973895f38SHanna Reitz } else { 75073895f38SHanna Reitz /* No .cancel() means the job will behave as if force-cancelled */ 75173895f38SHanna Reitz force = true; 7529820933bSVladimir Sementsov-Ogievskiy } 75373895f38SHanna Reitz 7547eaa8fb5SKevin Wolf if (job->user_paused) { 7557eaa8fb5SKevin Wolf /* Do not call job_enter here, the caller will handle it. */ 7567eaa8fb5SKevin Wolf if (job->driver->user_resume) { 7577eaa8fb5SKevin Wolf job->driver->user_resume(job); 7587eaa8fb5SKevin Wolf } 759e321c059SJeff Cody job->user_paused = false; 7607eaa8fb5SKevin Wolf assert(job->pause_count > 0); 7617eaa8fb5SKevin Wolf job->pause_count--; 7627eaa8fb5SKevin Wolf } 763401dd096SHanna Reitz 764401dd096SHanna Reitz /* 765401dd096SHanna Reitz * Ignore soft cancel requests after the job is already done 766401dd096SHanna Reitz * (We will still invoke job->driver->cancel() above, but if the 767401dd096SHanna Reitz * job driver supports soft cancelling and the job is done, that 768401dd096SHanna Reitz * should be a no-op, too. We still call it so it can override 769401dd096SHanna Reitz * @force.) 770401dd096SHanna Reitz */ 771401dd096SHanna Reitz if (force || !job->deferred_to_main_loop) { 7727eaa8fb5SKevin Wolf job->cancelled = true; 7737eaa8fb5SKevin Wolf /* To prevent 'force == false' overriding a previous 'force == true' */ 7747eaa8fb5SKevin Wolf job->force_cancel |= force; 7757eaa8fb5SKevin Wolf } 776401dd096SHanna Reitz } 7777eaa8fb5SKevin Wolf 7783d70ff53SKevin Wolf static void job_completed_txn_abort(Job *job) 7797eaa8fb5SKevin Wolf { 7807eaa8fb5SKevin Wolf AioContext *ctx; 7817eaa8fb5SKevin Wolf JobTxn *txn = job->txn; 7827eaa8fb5SKevin Wolf Job *other_job; 7837eaa8fb5SKevin Wolf 7847eaa8fb5SKevin Wolf if (txn->aborting) { 7857eaa8fb5SKevin Wolf /* 7867eaa8fb5SKevin Wolf * We are cancelled by another job, which will handle everything. 7877eaa8fb5SKevin Wolf */ 7887eaa8fb5SKevin Wolf return; 7897eaa8fb5SKevin Wolf } 7907eaa8fb5SKevin Wolf txn->aborting = true; 7917eaa8fb5SKevin Wolf job_txn_ref(txn); 7927eaa8fb5SKevin Wolf 793d4311314SHanna Reitz /* 794d4311314SHanna Reitz * We can only hold the single job's AioContext lock while calling 795644f3a29SKevin Wolf * job_finalize_single() because the finalization callbacks can involve 796d4311314SHanna Reitz * calls of AIO_WAIT_WHILE(), which could deadlock otherwise. 797d4311314SHanna Reitz * Note that the job's AioContext may change when it is finalized. 798d4311314SHanna Reitz */ 799d4311314SHanna Reitz job_ref(job); 800d4311314SHanna Reitz aio_context_release(job->aio_context); 8017eaa8fb5SKevin Wolf 8027eaa8fb5SKevin Wolf /* Other jobs are effectively cancelled by us, set the status for 8037eaa8fb5SKevin Wolf * them; this job, however, may or may not be cancelled, depending 8047eaa8fb5SKevin Wolf * on the caller, so leave it. */ 8057eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 8067eaa8fb5SKevin Wolf if (other_job != job) { 807644f3a29SKevin Wolf ctx = other_job->aio_context; 808644f3a29SKevin Wolf aio_context_acquire(ctx); 8091d4a43e9SHanna Reitz /* 8101d4a43e9SHanna Reitz * This is a transaction: If one job failed, no result will matter. 8111d4a43e9SHanna Reitz * Therefore, pass force=true to terminate all other jobs as quickly 8121d4a43e9SHanna Reitz * as possible. 8131d4a43e9SHanna Reitz */ 8141d4a43e9SHanna Reitz job_cancel_async(other_job, true); 815644f3a29SKevin Wolf aio_context_release(ctx); 8167eaa8fb5SKevin Wolf } 8177eaa8fb5SKevin Wolf } 8187eaa8fb5SKevin Wolf while (!QLIST_EMPTY(&txn->jobs)) { 8197eaa8fb5SKevin Wolf other_job = QLIST_FIRST(&txn->jobs); 820d4311314SHanna Reitz /* 821d4311314SHanna Reitz * The job's AioContext may change, so store it in @ctx so we 822d4311314SHanna Reitz * release the same context that we have acquired before. 823d4311314SHanna Reitz */ 8247eaa8fb5SKevin Wolf ctx = other_job->aio_context; 825644f3a29SKevin Wolf aio_context_acquire(ctx); 8267eaa8fb5SKevin Wolf if (!job_is_completed(other_job)) { 82708b83bffSHanna Reitz assert(job_cancel_requested(other_job)); 8287eaa8fb5SKevin Wolf job_finish_sync(other_job, NULL, NULL); 8297eaa8fb5SKevin Wolf } 8307eaa8fb5SKevin Wolf job_finalize_single(other_job); 8317eaa8fb5SKevin Wolf aio_context_release(ctx); 8327eaa8fb5SKevin Wolf } 8337eaa8fb5SKevin Wolf 834d4311314SHanna Reitz /* 835d4311314SHanna Reitz * Use job_ref()/job_unref() so we can read the AioContext here 836d4311314SHanna Reitz * even if the job went away during job_finalize_single(). 837d4311314SHanna Reitz */ 838d4311314SHanna Reitz aio_context_acquire(job->aio_context); 839d4311314SHanna Reitz job_unref(job); 840644f3a29SKevin Wolf 8417eaa8fb5SKevin Wolf job_txn_unref(txn); 8427eaa8fb5SKevin Wolf } 8437eaa8fb5SKevin Wolf 8447eaa8fb5SKevin Wolf static int job_prepare(Job *job) 8457eaa8fb5SKevin Wolf { 846c70b8031SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 8477eaa8fb5SKevin Wolf if (job->ret == 0 && job->driver->prepare) { 8487eaa8fb5SKevin Wolf job->ret = job->driver->prepare(job); 8491266c9b9SKevin Wolf job_update_rc(job); 8507eaa8fb5SKevin Wolf } 8517eaa8fb5SKevin Wolf return job->ret; 8527eaa8fb5SKevin Wolf } 8537eaa8fb5SKevin Wolf 8547eaa8fb5SKevin Wolf static int job_needs_finalize(Job *job) 8557eaa8fb5SKevin Wolf { 8567eaa8fb5SKevin Wolf return !job->auto_finalize; 8577eaa8fb5SKevin Wolf } 8587eaa8fb5SKevin Wolf 8597eaa8fb5SKevin Wolf static void job_do_finalize(Job *job) 8607eaa8fb5SKevin Wolf { 8617eaa8fb5SKevin Wolf int rc; 8627eaa8fb5SKevin Wolf assert(job && job->txn); 8637eaa8fb5SKevin Wolf 8647eaa8fb5SKevin Wolf /* prepare the transaction to complete */ 865b660a84bSStefan Reiter rc = job_txn_apply(job, job_prepare); 8667eaa8fb5SKevin Wolf if (rc) { 8677eaa8fb5SKevin Wolf job_completed_txn_abort(job); 8687eaa8fb5SKevin Wolf } else { 869b660a84bSStefan Reiter job_txn_apply(job, job_finalize_single); 8707eaa8fb5SKevin Wolf } 8717eaa8fb5SKevin Wolf } 8727eaa8fb5SKevin Wolf 8737eaa8fb5SKevin Wolf void job_finalize(Job *job, Error **errp) 8747eaa8fb5SKevin Wolf { 8757eaa8fb5SKevin Wolf assert(job && job->id); 8767eaa8fb5SKevin Wolf if (job_apply_verb(job, JOB_VERB_FINALIZE, errp)) { 8777eaa8fb5SKevin Wolf return; 8787eaa8fb5SKevin Wolf } 8797eaa8fb5SKevin Wolf job_do_finalize(job); 8807eaa8fb5SKevin Wolf } 8817eaa8fb5SKevin Wolf 8827eaa8fb5SKevin Wolf static int job_transition_to_pending(Job *job) 8837eaa8fb5SKevin Wolf { 8847eaa8fb5SKevin Wolf job_state_transition(job, JOB_STATUS_PENDING); 8857eaa8fb5SKevin Wolf if (!job->auto_finalize) { 8867eaa8fb5SKevin Wolf job_event_pending(job); 8877eaa8fb5SKevin Wolf } 8887eaa8fb5SKevin Wolf return 0; 8897eaa8fb5SKevin Wolf } 8907eaa8fb5SKevin Wolf 8912e1795b5SKevin Wolf void job_transition_to_ready(Job *job) 8922e1795b5SKevin Wolf { 8932e1795b5SKevin Wolf job_state_transition(job, JOB_STATUS_READY); 8942e1795b5SKevin Wolf job_event_ready(job); 8952e1795b5SKevin Wolf } 8962e1795b5SKevin Wolf 8973d70ff53SKevin Wolf static void job_completed_txn_success(Job *job) 8987eaa8fb5SKevin Wolf { 8997eaa8fb5SKevin Wolf JobTxn *txn = job->txn; 9007eaa8fb5SKevin Wolf Job *other_job; 9017eaa8fb5SKevin Wolf 9027eaa8fb5SKevin Wolf job_state_transition(job, JOB_STATUS_WAITING); 9037eaa8fb5SKevin Wolf 9047eaa8fb5SKevin Wolf /* 9057eaa8fb5SKevin Wolf * Successful completion, see if there are other running jobs in this 9067eaa8fb5SKevin Wolf * txn. 9077eaa8fb5SKevin Wolf */ 9087eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 9097eaa8fb5SKevin Wolf if (!job_is_completed(other_job)) { 9107eaa8fb5SKevin Wolf return; 9117eaa8fb5SKevin Wolf } 9127eaa8fb5SKevin Wolf assert(other_job->ret == 0); 9137eaa8fb5SKevin Wolf } 9147eaa8fb5SKevin Wolf 915b660a84bSStefan Reiter job_txn_apply(job, job_transition_to_pending); 9167eaa8fb5SKevin Wolf 9177eaa8fb5SKevin Wolf /* If no jobs need manual finalization, automatically do so */ 918b660a84bSStefan Reiter if (job_txn_apply(job, job_needs_finalize) == 0) { 9197eaa8fb5SKevin Wolf job_do_finalize(job); 9207eaa8fb5SKevin Wolf } 9217eaa8fb5SKevin Wolf } 9227eaa8fb5SKevin Wolf 923404ff28dSJohn Snow static void job_completed(Job *job) 9243d70ff53SKevin Wolf { 9253d70ff53SKevin Wolf assert(job && job->txn && !job_is_completed(job)); 9261266c9b9SKevin Wolf 9273d70ff53SKevin Wolf job_update_rc(job); 928404ff28dSJohn Snow trace_job_completed(job, job->ret); 9293d70ff53SKevin Wolf if (job->ret) { 9303d70ff53SKevin Wolf job_completed_txn_abort(job); 9313d70ff53SKevin Wolf } else { 9323d70ff53SKevin Wolf job_completed_txn_success(job); 9333d70ff53SKevin Wolf } 9343d70ff53SKevin Wolf } 9353d70ff53SKevin Wolf 936ccbfb331SJohn Snow /** Useful only as a type shim for aio_bh_schedule_oneshot. */ 937ccbfb331SJohn Snow static void job_exit(void *opaque) 938ccbfb331SJohn Snow { 939ccbfb331SJohn Snow Job *job = (Job *)opaque; 940b660a84bSStefan Reiter AioContext *ctx; 941d1756c78SKevin Wolf 942b660a84bSStefan Reiter job_ref(job); 943b660a84bSStefan Reiter aio_context_acquire(job->aio_context); 944b5a7a057SKevin Wolf 945b5a7a057SKevin Wolf /* This is a lie, we're not quiescent, but still doing the completion 946b5a7a057SKevin Wolf * callbacks. However, completion callbacks tend to involve operations that 947b5a7a057SKevin Wolf * drain block nodes, and if .drained_poll still returned true, we would 948b5a7a057SKevin Wolf * deadlock. */ 949b5a7a057SKevin Wolf job->busy = false; 950b5a7a057SKevin Wolf job_event_idle(job); 951b5a7a057SKevin Wolf 952ccbfb331SJohn Snow job_completed(job); 953b5a7a057SKevin Wolf 954b660a84bSStefan Reiter /* 955b660a84bSStefan Reiter * Note that calling job_completed can move the job to a different 956b660a84bSStefan Reiter * aio_context, so we cannot cache from above. job_txn_apply takes care of 957b660a84bSStefan Reiter * acquiring the new lock, and we ref/unref to avoid job_completed freeing 958b660a84bSStefan Reiter * the job underneath us. 959b660a84bSStefan Reiter */ 960b660a84bSStefan Reiter ctx = job->aio_context; 961b660a84bSStefan Reiter job_unref(job); 962d1756c78SKevin Wolf aio_context_release(ctx); 963ccbfb331SJohn Snow } 964ccbfb331SJohn Snow 965ccbfb331SJohn Snow /** 966ccbfb331SJohn Snow * All jobs must allow a pause point before entering their job proper. This 967ccbfb331SJohn Snow * ensures that jobs can be paused prior to being started, then resumed later. 968ccbfb331SJohn Snow */ 969ccbfb331SJohn Snow static void coroutine_fn job_co_entry(void *opaque) 970ccbfb331SJohn Snow { 971ccbfb331SJohn Snow Job *job = opaque; 972ccbfb331SJohn Snow 973ccbfb331SJohn Snow assert(job && job->driver && job->driver->run); 974c70b8031SEmanuele Giuseppe Esposito assert(job->aio_context == qemu_get_current_aio_context()); 975ccbfb331SJohn Snow job_pause_point(job); 976ccbfb331SJohn Snow job->ret = job->driver->run(job, &job->err); 977ccbfb331SJohn Snow job->deferred_to_main_loop = true; 978b5a7a057SKevin Wolf job->busy = true; 979ccbfb331SJohn Snow aio_bh_schedule_oneshot(qemu_get_aio_context(), job_exit, job); 980ccbfb331SJohn Snow } 981ccbfb331SJohn Snow 982ccbfb331SJohn Snow void job_start(Job *job) 983ccbfb331SJohn Snow { 984ccbfb331SJohn Snow assert(job && !job_started(job) && job->paused && 985ccbfb331SJohn Snow job->driver && job->driver->run); 986ccbfb331SJohn Snow job->co = qemu_coroutine_create(job_co_entry, job); 987ccbfb331SJohn Snow job->pause_count--; 988ccbfb331SJohn Snow job->busy = true; 989ccbfb331SJohn Snow job->paused = false; 990ccbfb331SJohn Snow job_state_transition(job, JOB_STATUS_RUNNING); 991ccbfb331SJohn Snow aio_co_enter(job->aio_context, job->co); 992ccbfb331SJohn Snow } 993ccbfb331SJohn Snow 9943d70ff53SKevin Wolf void job_cancel(Job *job, bool force) 9953d70ff53SKevin Wolf { 9963d70ff53SKevin Wolf if (job->status == JOB_STATUS_CONCLUDED) { 9973d70ff53SKevin Wolf job_do_dismiss(job); 9983d70ff53SKevin Wolf return; 9993d70ff53SKevin Wolf } 10003d70ff53SKevin Wolf job_cancel_async(job, force); 10013d70ff53SKevin Wolf if (!job_started(job)) { 1002404ff28dSJohn Snow job_completed(job); 10033d70ff53SKevin Wolf } else if (job->deferred_to_main_loop) { 1004401dd096SHanna Reitz /* 1005401dd096SHanna Reitz * job_cancel_async() ignores soft-cancel requests for jobs 1006401dd096SHanna Reitz * that are already done (i.e. deferred to the main loop). We 1007401dd096SHanna Reitz * have to check again whether the job is really cancelled. 100808b83bffSHanna Reitz * (job_cancel_requested() and job_is_cancelled() are equivalent 100908b83bffSHanna Reitz * here, because job_cancel_async() will make soft-cancel 101008b83bffSHanna Reitz * requests no-ops when deferred_to_main_loop is true. We 101108b83bffSHanna Reitz * choose to call job_is_cancelled() to show that we invoke 101208b83bffSHanna Reitz * job_completed_txn_abort() only for force-cancelled jobs.) 1013401dd096SHanna Reitz */ 1014401dd096SHanna Reitz if (job_is_cancelled(job)) { 10153d70ff53SKevin Wolf job_completed_txn_abort(job); 1016401dd096SHanna Reitz } 10173d70ff53SKevin Wolf } else { 10183d70ff53SKevin Wolf job_enter(job); 10193d70ff53SKevin Wolf } 10203d70ff53SKevin Wolf } 10213d70ff53SKevin Wolf 10223d70ff53SKevin Wolf void job_user_cancel(Job *job, bool force, Error **errp) 10233d70ff53SKevin Wolf { 10243d70ff53SKevin Wolf if (job_apply_verb(job, JOB_VERB_CANCEL, errp)) { 10253d70ff53SKevin Wolf return; 10263d70ff53SKevin Wolf } 10273d70ff53SKevin Wolf job_cancel(job, force); 10283d70ff53SKevin Wolf } 10293d70ff53SKevin Wolf 10303d70ff53SKevin Wolf /* A wrapper around job_cancel() taking an Error ** parameter so it may be 10313d70ff53SKevin Wolf * used with job_finish_sync() without the need for (rather nasty) function 10323d70ff53SKevin Wolf * pointer casts there. */ 10333d70ff53SKevin Wolf static void job_cancel_err(Job *job, Error **errp) 10343d70ff53SKevin Wolf { 10353d70ff53SKevin Wolf job_cancel(job, false); 10363d70ff53SKevin Wolf } 10373d70ff53SKevin Wolf 10384cfb3f05SHanna Reitz /** 10394cfb3f05SHanna Reitz * Same as job_cancel_err(), but force-cancel. 10404cfb3f05SHanna Reitz */ 10414cfb3f05SHanna Reitz static void job_force_cancel_err(Job *job, Error **errp) 10423d70ff53SKevin Wolf { 10434cfb3f05SHanna Reitz job_cancel(job, true); 10444cfb3f05SHanna Reitz } 10454cfb3f05SHanna Reitz 10464cfb3f05SHanna Reitz int job_cancel_sync(Job *job, bool force) 10474cfb3f05SHanna Reitz { 10484cfb3f05SHanna Reitz if (force) { 10494cfb3f05SHanna Reitz return job_finish_sync(job, &job_force_cancel_err, NULL); 10504cfb3f05SHanna Reitz } else { 10513d70ff53SKevin Wolf return job_finish_sync(job, &job_cancel_err, NULL); 10523d70ff53SKevin Wolf } 10534cfb3f05SHanna Reitz } 10543d70ff53SKevin Wolf 10553d70ff53SKevin Wolf void job_cancel_sync_all(void) 10563d70ff53SKevin Wolf { 10573d70ff53SKevin Wolf Job *job; 10583d70ff53SKevin Wolf AioContext *aio_context; 10593d70ff53SKevin Wolf 10603d70ff53SKevin Wolf while ((job = job_next(NULL))) { 10613d70ff53SKevin Wolf aio_context = job->aio_context; 10623d70ff53SKevin Wolf aio_context_acquire(aio_context); 10634cfb3f05SHanna Reitz job_cancel_sync(job, true); 10643d70ff53SKevin Wolf aio_context_release(aio_context); 10653d70ff53SKevin Wolf } 10663d70ff53SKevin Wolf } 10673d70ff53SKevin Wolf 10683d70ff53SKevin Wolf int job_complete_sync(Job *job, Error **errp) 10693d70ff53SKevin Wolf { 10703d70ff53SKevin Wolf return job_finish_sync(job, job_complete, errp); 10713d70ff53SKevin Wolf } 10723d70ff53SKevin Wolf 10733453d972SKevin Wolf void job_complete(Job *job, Error **errp) 10743453d972SKevin Wolf { 10753453d972SKevin Wolf /* Should not be reachable via external interface for internal jobs */ 10763453d972SKevin Wolf assert(job->id); 1077c70b8031SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 10783453d972SKevin Wolf if (job_apply_verb(job, JOB_VERB_COMPLETE, errp)) { 10793453d972SKevin Wolf return; 10803453d972SKevin Wolf } 108108b83bffSHanna Reitz if (job_cancel_requested(job) || !job->driver->complete) { 10823453d972SKevin Wolf error_setg(errp, "The active block job '%s' cannot be completed", 10833453d972SKevin Wolf job->id); 10843453d972SKevin Wolf return; 10853453d972SKevin Wolf } 10863453d972SKevin Wolf 10873453d972SKevin Wolf job->driver->complete(job, errp); 10883453d972SKevin Wolf } 10893453d972SKevin Wolf 10906a74c075SKevin Wolf int job_finish_sync(Job *job, void (*finish)(Job *, Error **errp), Error **errp) 10916a74c075SKevin Wolf { 10926a74c075SKevin Wolf Error *local_err = NULL; 10936a74c075SKevin Wolf int ret; 10946a74c075SKevin Wolf 10956a74c075SKevin Wolf job_ref(job); 10966a74c075SKevin Wolf 10976a74c075SKevin Wolf if (finish) { 10986a74c075SKevin Wolf finish(job, &local_err); 10996a74c075SKevin Wolf } 11006a74c075SKevin Wolf if (local_err) { 11016a74c075SKevin Wolf error_propagate(errp, local_err); 11026a74c075SKevin Wolf job_unref(job); 11036a74c075SKevin Wolf return -EBUSY; 11046a74c075SKevin Wolf } 1105de0fbe64SKevin Wolf 1106cfe29d82SKevin Wolf AIO_WAIT_WHILE(job->aio_context, 1107bb0c9409SVladimir Sementsov-Ogievskiy (job_enter(job), !job_is_completed(job))); 1108de0fbe64SKevin Wolf 11096a74c075SKevin Wolf ret = (job_is_cancelled(job) && job->ret == 0) ? -ECANCELED : job->ret; 11106a74c075SKevin Wolf job_unref(job); 11116a74c075SKevin Wolf return ret; 11126a74c075SKevin Wolf } 1113