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" 32a50c2ab8SKevin Wolf #include "trace-root.h" 331dac83f1SKevin Wolf #include "qapi/qapi-events-job.h" 3433e9e9bdSKevin Wolf 35e7c1d78bSKevin Wolf static QLIST_HEAD(, Job) jobs = QLIST_HEAD_INITIALIZER(jobs); 36e7c1d78bSKevin Wolf 37a50c2ab8SKevin Wolf /* Job State Transition Table */ 38a50c2ab8SKevin Wolf bool JobSTT[JOB_STATUS__MAX][JOB_STATUS__MAX] = { 39a50c2ab8SKevin Wolf /* U, C, R, P, Y, S, W, D, X, E, N */ 40a50c2ab8SKevin Wolf /* U: */ [JOB_STATUS_UNDEFINED] = {0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0}, 41a50c2ab8SKevin Wolf /* C: */ [JOB_STATUS_CREATED] = {0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 1}, 42a50c2ab8SKevin Wolf /* R: */ [JOB_STATUS_RUNNING] = {0, 0, 0, 1, 1, 0, 1, 0, 1, 0, 0}, 43a50c2ab8SKevin Wolf /* P: */ [JOB_STATUS_PAUSED] = {0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0}, 44a50c2ab8SKevin Wolf /* Y: */ [JOB_STATUS_READY] = {0, 0, 0, 0, 0, 1, 1, 0, 1, 0, 0}, 45a50c2ab8SKevin Wolf /* S: */ [JOB_STATUS_STANDBY] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0}, 46a50c2ab8SKevin Wolf /* W: */ [JOB_STATUS_WAITING] = {0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0}, 47a50c2ab8SKevin Wolf /* D: */ [JOB_STATUS_PENDING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, 48a50c2ab8SKevin Wolf /* X: */ [JOB_STATUS_ABORTING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, 49a50c2ab8SKevin Wolf /* E: */ [JOB_STATUS_CONCLUDED] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}, 50a50c2ab8SKevin Wolf /* N: */ [JOB_STATUS_NULL] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}, 51a50c2ab8SKevin Wolf }; 52a50c2ab8SKevin Wolf 53a50c2ab8SKevin Wolf bool JobVerbTable[JOB_VERB__MAX][JOB_STATUS__MAX] = { 54a50c2ab8SKevin Wolf /* U, C, R, P, Y, S, W, D, X, E, N */ 55a50c2ab8SKevin Wolf [JOB_VERB_CANCEL] = {0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0}, 56a50c2ab8SKevin Wolf [JOB_VERB_PAUSE] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 57a50c2ab8SKevin Wolf [JOB_VERB_RESUME] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 58a50c2ab8SKevin Wolf [JOB_VERB_SET_SPEED] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 59a50c2ab8SKevin Wolf [JOB_VERB_COMPLETE] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0}, 60a50c2ab8SKevin Wolf [JOB_VERB_FINALIZE] = {0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0}, 61a50c2ab8SKevin Wolf [JOB_VERB_DISMISS] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0}, 62a50c2ab8SKevin Wolf }; 63a50c2ab8SKevin Wolf 647eaa8fb5SKevin Wolf /* Transactional group of jobs */ 657eaa8fb5SKevin Wolf struct JobTxn { 667eaa8fb5SKevin Wolf 677eaa8fb5SKevin Wolf /* Is this txn being cancelled? */ 687eaa8fb5SKevin Wolf bool aborting; 697eaa8fb5SKevin Wolf 707eaa8fb5SKevin Wolf /* List of jobs */ 717eaa8fb5SKevin Wolf QLIST_HEAD(, Job) jobs; 727eaa8fb5SKevin Wolf 737eaa8fb5SKevin Wolf /* Reference count */ 747eaa8fb5SKevin Wolf int refcnt; 757eaa8fb5SKevin Wolf }; 767eaa8fb5SKevin Wolf 77da01ff7fSKevin Wolf /* Right now, this mutex is only needed to synchronize accesses to job->busy 78da01ff7fSKevin Wolf * and job->sleep_timer, such as concurrent calls to job_do_yield and 79da01ff7fSKevin Wolf * job_enter. */ 80da01ff7fSKevin Wolf static QemuMutex job_mutex; 81da01ff7fSKevin Wolf 82da01ff7fSKevin Wolf static void job_lock(void) 83da01ff7fSKevin Wolf { 84da01ff7fSKevin Wolf qemu_mutex_lock(&job_mutex); 85da01ff7fSKevin Wolf } 86da01ff7fSKevin Wolf 87da01ff7fSKevin Wolf static void job_unlock(void) 88da01ff7fSKevin Wolf { 89da01ff7fSKevin Wolf qemu_mutex_unlock(&job_mutex); 90da01ff7fSKevin Wolf } 91da01ff7fSKevin Wolf 92da01ff7fSKevin Wolf static void __attribute__((__constructor__)) job_init(void) 93da01ff7fSKevin Wolf { 94da01ff7fSKevin Wolf qemu_mutex_init(&job_mutex); 95da01ff7fSKevin Wolf } 96da01ff7fSKevin Wolf 977eaa8fb5SKevin Wolf JobTxn *job_txn_new(void) 987eaa8fb5SKevin Wolf { 997eaa8fb5SKevin Wolf JobTxn *txn = g_new0(JobTxn, 1); 1007eaa8fb5SKevin Wolf QLIST_INIT(&txn->jobs); 1017eaa8fb5SKevin Wolf txn->refcnt = 1; 1027eaa8fb5SKevin Wolf return txn; 1037eaa8fb5SKevin Wolf } 1047eaa8fb5SKevin Wolf 1057eaa8fb5SKevin Wolf static void job_txn_ref(JobTxn *txn) 1067eaa8fb5SKevin Wolf { 1077eaa8fb5SKevin Wolf txn->refcnt++; 1087eaa8fb5SKevin Wolf } 1097eaa8fb5SKevin Wolf 1107eaa8fb5SKevin Wolf void job_txn_unref(JobTxn *txn) 1117eaa8fb5SKevin Wolf { 1127eaa8fb5SKevin Wolf if (txn && --txn->refcnt == 0) { 1137eaa8fb5SKevin Wolf g_free(txn); 1147eaa8fb5SKevin Wolf } 1157eaa8fb5SKevin Wolf } 1167eaa8fb5SKevin Wolf 1177eaa8fb5SKevin Wolf void job_txn_add_job(JobTxn *txn, Job *job) 1187eaa8fb5SKevin Wolf { 1197eaa8fb5SKevin Wolf if (!txn) { 1207eaa8fb5SKevin Wolf return; 1217eaa8fb5SKevin Wolf } 1227eaa8fb5SKevin Wolf 1237eaa8fb5SKevin Wolf assert(!job->txn); 1247eaa8fb5SKevin Wolf job->txn = txn; 1257eaa8fb5SKevin Wolf 1267eaa8fb5SKevin Wolf QLIST_INSERT_HEAD(&txn->jobs, job, txn_list); 1277eaa8fb5SKevin Wolf job_txn_ref(txn); 1287eaa8fb5SKevin Wolf } 1297eaa8fb5SKevin Wolf 1307eaa8fb5SKevin Wolf static void job_txn_del_job(Job *job) 1317eaa8fb5SKevin Wolf { 1327eaa8fb5SKevin Wolf if (job->txn) { 1337eaa8fb5SKevin Wolf QLIST_REMOVE(job, txn_list); 1347eaa8fb5SKevin Wolf job_txn_unref(job->txn); 1357eaa8fb5SKevin Wolf job->txn = NULL; 1367eaa8fb5SKevin Wolf } 1377eaa8fb5SKevin Wolf } 1387eaa8fb5SKevin Wolf 13949880165SFam Zheng static int job_txn_apply(JobTxn *txn, int fn(Job *)) 1407eaa8fb5SKevin Wolf { 1417eaa8fb5SKevin Wolf Job *job, *next; 1427eaa8fb5SKevin Wolf int rc = 0; 1437eaa8fb5SKevin Wolf 1447eaa8fb5SKevin Wolf QLIST_FOREACH_SAFE(job, &txn->jobs, txn_list, next) { 1457eaa8fb5SKevin Wolf rc = fn(job); 1467eaa8fb5SKevin Wolf if (rc) { 1477eaa8fb5SKevin Wolf break; 1487eaa8fb5SKevin Wolf } 1497eaa8fb5SKevin Wolf } 1507eaa8fb5SKevin Wolf return rc; 1517eaa8fb5SKevin Wolf } 1527eaa8fb5SKevin Wolf 153456273b0SKevin Wolf bool job_is_internal(Job *job) 1541dac83f1SKevin Wolf { 1551dac83f1SKevin Wolf return (job->id == NULL); 1561dac83f1SKevin Wolf } 1571dac83f1SKevin Wolf 1582e1795b5SKevin Wolf static void job_state_transition(Job *job, JobStatus s1) 159a50c2ab8SKevin Wolf { 160a50c2ab8SKevin Wolf JobStatus s0 = job->status; 161c2032289SLiam Merwick assert(s1 >= 0 && s1 < JOB_STATUS__MAX); 1624ad35181SKevin Wolf trace_job_state_transition(job, job->ret, 163a50c2ab8SKevin Wolf JobSTT[s0][s1] ? "allowed" : "disallowed", 164a50c2ab8SKevin Wolf JobStatus_str(s0), JobStatus_str(s1)); 165a50c2ab8SKevin Wolf assert(JobSTT[s0][s1]); 166a50c2ab8SKevin Wolf job->status = s1; 1671dac83f1SKevin Wolf 1681dac83f1SKevin Wolf if (!job_is_internal(job) && s1 != s0) { 1693ab72385SPeter Xu qapi_event_send_job_status_change(job->id, job->status); 1701dac83f1SKevin Wolf } 171a50c2ab8SKevin Wolf } 172a50c2ab8SKevin Wolf 173a50c2ab8SKevin Wolf int job_apply_verb(Job *job, JobVerb verb, Error **errp) 174a50c2ab8SKevin Wolf { 175a50c2ab8SKevin Wolf JobStatus s0 = job->status; 176c2032289SLiam Merwick assert(verb >= 0 && verb < JOB_VERB__MAX); 177a50c2ab8SKevin Wolf trace_job_apply_verb(job, JobStatus_str(s0), JobVerb_str(verb), 178a50c2ab8SKevin Wolf JobVerbTable[verb][s0] ? "allowed" : "prohibited"); 179a50c2ab8SKevin Wolf if (JobVerbTable[verb][s0]) { 180a50c2ab8SKevin Wolf return 0; 181a50c2ab8SKevin Wolf } 182a50c2ab8SKevin Wolf error_setg(errp, "Job '%s' in state '%s' cannot accept command verb '%s'", 183a50c2ab8SKevin Wolf job->id, JobStatus_str(s0), JobVerb_str(verb)); 184a50c2ab8SKevin Wolf return -EPERM; 185a50c2ab8SKevin Wolf } 186a50c2ab8SKevin Wolf 187252291eaSKevin Wolf JobType job_type(const Job *job) 188252291eaSKevin Wolf { 189252291eaSKevin Wolf return job->driver->job_type; 190252291eaSKevin Wolf } 191252291eaSKevin Wolf 192252291eaSKevin Wolf const char *job_type_str(const Job *job) 193252291eaSKevin Wolf { 194252291eaSKevin Wolf return JobType_str(job_type(job)); 195252291eaSKevin Wolf } 196252291eaSKevin Wolf 197daa7f2f9SKevin Wolf bool job_is_cancelled(Job *job) 198daa7f2f9SKevin Wolf { 199daa7f2f9SKevin Wolf return job->cancelled; 200daa7f2f9SKevin Wolf } 201daa7f2f9SKevin Wolf 202df956ae2SKevin Wolf bool job_is_ready(Job *job) 203df956ae2SKevin Wolf { 204df956ae2SKevin Wolf switch (job->status) { 205df956ae2SKevin Wolf case JOB_STATUS_UNDEFINED: 206df956ae2SKevin Wolf case JOB_STATUS_CREATED: 207df956ae2SKevin Wolf case JOB_STATUS_RUNNING: 208df956ae2SKevin Wolf case JOB_STATUS_PAUSED: 209df956ae2SKevin Wolf case JOB_STATUS_WAITING: 210df956ae2SKevin Wolf case JOB_STATUS_PENDING: 211df956ae2SKevin Wolf case JOB_STATUS_ABORTING: 212df956ae2SKevin Wolf case JOB_STATUS_CONCLUDED: 213df956ae2SKevin Wolf case JOB_STATUS_NULL: 214df956ae2SKevin Wolf return false; 215df956ae2SKevin Wolf case JOB_STATUS_READY: 216df956ae2SKevin Wolf case JOB_STATUS_STANDBY: 217df956ae2SKevin Wolf return true; 218df956ae2SKevin Wolf default: 219df956ae2SKevin Wolf g_assert_not_reached(); 220df956ae2SKevin Wolf } 221df956ae2SKevin Wolf return false; 222df956ae2SKevin Wolf } 223df956ae2SKevin Wolf 224dbe5e6c1SKevin Wolf bool job_is_completed(Job *job) 225dbe5e6c1SKevin Wolf { 226dbe5e6c1SKevin Wolf switch (job->status) { 227dbe5e6c1SKevin Wolf case JOB_STATUS_UNDEFINED: 228dbe5e6c1SKevin Wolf case JOB_STATUS_CREATED: 229dbe5e6c1SKevin Wolf case JOB_STATUS_RUNNING: 230dbe5e6c1SKevin Wolf case JOB_STATUS_PAUSED: 231dbe5e6c1SKevin Wolf case JOB_STATUS_READY: 232dbe5e6c1SKevin Wolf case JOB_STATUS_STANDBY: 233dbe5e6c1SKevin Wolf return false; 234dbe5e6c1SKevin Wolf case JOB_STATUS_WAITING: 235dbe5e6c1SKevin Wolf case JOB_STATUS_PENDING: 236dbe5e6c1SKevin Wolf case JOB_STATUS_ABORTING: 237dbe5e6c1SKevin Wolf case JOB_STATUS_CONCLUDED: 238dbe5e6c1SKevin Wolf case JOB_STATUS_NULL: 239dbe5e6c1SKevin Wolf return true; 240dbe5e6c1SKevin Wolf default: 241dbe5e6c1SKevin Wolf g_assert_not_reached(); 242dbe5e6c1SKevin Wolf } 243dbe5e6c1SKevin Wolf return false; 244dbe5e6c1SKevin Wolf } 245dbe5e6c1SKevin Wolf 2463d70ff53SKevin Wolf static bool job_started(Job *job) 247da01ff7fSKevin Wolf { 248da01ff7fSKevin Wolf return job->co; 249da01ff7fSKevin Wolf } 250da01ff7fSKevin Wolf 251198c49ccSKevin Wolf static bool job_should_pause(Job *job) 252da01ff7fSKevin Wolf { 253da01ff7fSKevin Wolf return job->pause_count > 0; 254da01ff7fSKevin Wolf } 255da01ff7fSKevin Wolf 256e7c1d78bSKevin Wolf Job *job_next(Job *job) 257e7c1d78bSKevin Wolf { 258e7c1d78bSKevin Wolf if (!job) { 259e7c1d78bSKevin Wolf return QLIST_FIRST(&jobs); 260e7c1d78bSKevin Wolf } 261e7c1d78bSKevin Wolf return QLIST_NEXT(job, job_list); 262e7c1d78bSKevin Wolf } 263e7c1d78bSKevin Wolf 264e7c1d78bSKevin Wolf Job *job_get(const char *id) 265e7c1d78bSKevin Wolf { 266e7c1d78bSKevin Wolf Job *job; 267e7c1d78bSKevin Wolf 268e7c1d78bSKevin Wolf QLIST_FOREACH(job, &jobs, job_list) { 269e7c1d78bSKevin Wolf if (job->id && !strcmp(id, job->id)) { 270e7c1d78bSKevin Wolf return job; 271e7c1d78bSKevin Wolf } 272e7c1d78bSKevin Wolf } 273e7c1d78bSKevin Wolf 274e7c1d78bSKevin Wolf return NULL; 275e7c1d78bSKevin Wolf } 276e7c1d78bSKevin Wolf 2775d43e86eSKevin Wolf static void job_sleep_timer_cb(void *opaque) 2785d43e86eSKevin Wolf { 2795d43e86eSKevin Wolf Job *job = opaque; 2805d43e86eSKevin Wolf 2815d43e86eSKevin Wolf job_enter(job); 2825d43e86eSKevin Wolf } 2835d43e86eSKevin Wolf 2847eaa8fb5SKevin Wolf void *job_create(const char *job_id, const JobDriver *driver, JobTxn *txn, 2857eaa8fb5SKevin Wolf AioContext *ctx, int flags, BlockCompletionFunc *cb, 2867eaa8fb5SKevin Wolf void *opaque, Error **errp) 28733e9e9bdSKevin Wolf { 28833e9e9bdSKevin Wolf Job *job; 28933e9e9bdSKevin Wolf 29033e9e9bdSKevin Wolf if (job_id) { 291bb02b65cSKevin Wolf if (flags & JOB_INTERNAL) { 292bb02b65cSKevin Wolf error_setg(errp, "Cannot specify job ID for internal job"); 293bb02b65cSKevin Wolf return NULL; 294bb02b65cSKevin Wolf } 29533e9e9bdSKevin Wolf if (!id_wellformed(job_id)) { 29633e9e9bdSKevin Wolf error_setg(errp, "Invalid job ID '%s'", job_id); 29733e9e9bdSKevin Wolf return NULL; 29833e9e9bdSKevin Wolf } 299e7c1d78bSKevin Wolf if (job_get(job_id)) { 300e7c1d78bSKevin Wolf error_setg(errp, "Job ID '%s' already in use", job_id); 301e7c1d78bSKevin Wolf return NULL; 302e7c1d78bSKevin Wolf } 303bb02b65cSKevin Wolf } else if (!(flags & JOB_INTERNAL)) { 304bb02b65cSKevin Wolf error_setg(errp, "An explicit job ID is required"); 305bb02b65cSKevin Wolf return NULL; 30633e9e9bdSKevin Wolf } 30733e9e9bdSKevin Wolf 30833e9e9bdSKevin Wolf job = g_malloc0(driver->instance_size); 30933e9e9bdSKevin Wolf job->driver = driver; 31033e9e9bdSKevin Wolf job->id = g_strdup(job_id); 31180fa2c75SKevin Wolf job->refcnt = 1; 31208be6fe2SKevin Wolf job->aio_context = ctx; 313da01ff7fSKevin Wolf job->busy = false; 314da01ff7fSKevin Wolf job->paused = true; 315da01ff7fSKevin Wolf job->pause_count = 1; 316bb02b65cSKevin Wolf job->auto_finalize = !(flags & JOB_MANUAL_FINALIZE); 317bb02b65cSKevin Wolf job->auto_dismiss = !(flags & JOB_MANUAL_DISMISS); 3184ad35181SKevin Wolf job->cb = cb; 3194ad35181SKevin Wolf job->opaque = opaque; 32033e9e9bdSKevin Wolf 321139a9f02SKevin Wolf notifier_list_init(&job->on_finalize_cancelled); 322139a9f02SKevin Wolf notifier_list_init(&job->on_finalize_completed); 323139a9f02SKevin Wolf notifier_list_init(&job->on_pending); 3242e1795b5SKevin Wolf notifier_list_init(&job->on_ready); 325139a9f02SKevin Wolf 326a50c2ab8SKevin Wolf job_state_transition(job, JOB_STATUS_CREATED); 3275d43e86eSKevin Wolf aio_timer_init(qemu_get_aio_context(), &job->sleep_timer, 3285d43e86eSKevin Wolf QEMU_CLOCK_REALTIME, SCALE_NS, 3295d43e86eSKevin Wolf job_sleep_timer_cb, job); 330a50c2ab8SKevin Wolf 331e7c1d78bSKevin Wolf QLIST_INSERT_HEAD(&jobs, job, job_list); 332e7c1d78bSKevin Wolf 3337eaa8fb5SKevin Wolf /* Single jobs are modeled as single-job transactions for sake of 3347eaa8fb5SKevin Wolf * consolidating the job management logic */ 3357eaa8fb5SKevin Wolf if (!txn) { 3367eaa8fb5SKevin Wolf txn = job_txn_new(); 3377eaa8fb5SKevin Wolf job_txn_add_job(txn, job); 3387eaa8fb5SKevin Wolf job_txn_unref(txn); 3397eaa8fb5SKevin Wolf } else { 3407eaa8fb5SKevin Wolf job_txn_add_job(txn, job); 3417eaa8fb5SKevin Wolf } 3427eaa8fb5SKevin Wolf 34333e9e9bdSKevin Wolf return job; 34433e9e9bdSKevin Wolf } 345fd61a701SKevin Wolf 34680fa2c75SKevin Wolf void job_ref(Job *job) 347fd61a701SKevin Wolf { 34880fa2c75SKevin Wolf ++job->refcnt; 34980fa2c75SKevin Wolf } 35080fa2c75SKevin Wolf 35180fa2c75SKevin Wolf void job_unref(Job *job) 35280fa2c75SKevin Wolf { 35380fa2c75SKevin Wolf if (--job->refcnt == 0) { 35480fa2c75SKevin Wolf assert(job->status == JOB_STATUS_NULL); 3555d43e86eSKevin Wolf assert(!timer_pending(&job->sleep_timer)); 3567eaa8fb5SKevin Wolf assert(!job->txn); 35780fa2c75SKevin Wolf 35880fa2c75SKevin Wolf if (job->driver->free) { 35980fa2c75SKevin Wolf job->driver->free(job); 36080fa2c75SKevin Wolf } 36180fa2c75SKevin Wolf 362e7c1d78bSKevin Wolf QLIST_REMOVE(job, job_list); 363e7c1d78bSKevin Wolf 3643d1f8b07SJohn Snow error_free(job->err); 365fd61a701SKevin Wolf g_free(job->id); 366fd61a701SKevin Wolf g_free(job); 367fd61a701SKevin Wolf } 36880fa2c75SKevin Wolf } 3691908a559SKevin Wolf 37030a5c887SKevin Wolf void job_progress_update(Job *job, uint64_t done) 37130a5c887SKevin Wolf { 372*01fe1ca9SVladimir Sementsov-Ogievskiy progress_work_done(&job->progress, done); 37330a5c887SKevin Wolf } 37430a5c887SKevin Wolf 37530a5c887SKevin Wolf void job_progress_set_remaining(Job *job, uint64_t remaining) 37630a5c887SKevin Wolf { 377*01fe1ca9SVladimir Sementsov-Ogievskiy progress_set_remaining(&job->progress, remaining); 37830a5c887SKevin Wolf } 37930a5c887SKevin Wolf 38062f13600SMax Reitz void job_progress_increase_remaining(Job *job, uint64_t delta) 38162f13600SMax Reitz { 382*01fe1ca9SVladimir Sementsov-Ogievskiy progress_increase_remaining(&job->progress, delta); 38362f13600SMax Reitz } 38462f13600SMax Reitz 385139a9f02SKevin Wolf void job_event_cancelled(Job *job) 386139a9f02SKevin Wolf { 387139a9f02SKevin Wolf notifier_list_notify(&job->on_finalize_cancelled, job); 388139a9f02SKevin Wolf } 389139a9f02SKevin Wolf 390139a9f02SKevin Wolf void job_event_completed(Job *job) 391139a9f02SKevin Wolf { 392139a9f02SKevin Wolf notifier_list_notify(&job->on_finalize_completed, job); 393139a9f02SKevin Wolf } 394139a9f02SKevin Wolf 3957eaa8fb5SKevin Wolf static void job_event_pending(Job *job) 396139a9f02SKevin Wolf { 397139a9f02SKevin Wolf notifier_list_notify(&job->on_pending, job); 398139a9f02SKevin Wolf } 399139a9f02SKevin Wolf 4002e1795b5SKevin Wolf static void job_event_ready(Job *job) 4012e1795b5SKevin Wolf { 4022e1795b5SKevin Wolf notifier_list_notify(&job->on_ready, job); 4032e1795b5SKevin Wolf } 4042e1795b5SKevin Wolf 40534dc97b9SKevin Wolf static void job_event_idle(Job *job) 40634dc97b9SKevin Wolf { 40734dc97b9SKevin Wolf notifier_list_notify(&job->on_idle, job); 40834dc97b9SKevin Wolf } 40934dc97b9SKevin Wolf 410da01ff7fSKevin Wolf void job_enter_cond(Job *job, bool(*fn)(Job *job)) 411da01ff7fSKevin Wolf { 412da01ff7fSKevin Wolf if (!job_started(job)) { 413da01ff7fSKevin Wolf return; 414da01ff7fSKevin Wolf } 415da01ff7fSKevin Wolf if (job->deferred_to_main_loop) { 416da01ff7fSKevin Wolf return; 417da01ff7fSKevin Wolf } 418da01ff7fSKevin Wolf 419da01ff7fSKevin Wolf job_lock(); 420da01ff7fSKevin Wolf if (job->busy) { 421da01ff7fSKevin Wolf job_unlock(); 422da01ff7fSKevin Wolf return; 423da01ff7fSKevin Wolf } 424da01ff7fSKevin Wolf 425da01ff7fSKevin Wolf if (fn && !fn(job)) { 426da01ff7fSKevin Wolf job_unlock(); 427da01ff7fSKevin Wolf return; 428da01ff7fSKevin Wolf } 429da01ff7fSKevin Wolf 430da01ff7fSKevin Wolf assert(!job->deferred_to_main_loop); 431da01ff7fSKevin Wolf timer_del(&job->sleep_timer); 432da01ff7fSKevin Wolf job->busy = true; 433da01ff7fSKevin Wolf job_unlock(); 43413726123SKevin Wolf aio_co_enter(job->aio_context, job->co); 435da01ff7fSKevin Wolf } 436da01ff7fSKevin Wolf 4375d43e86eSKevin Wolf void job_enter(Job *job) 4385d43e86eSKevin Wolf { 4395d43e86eSKevin Wolf job_enter_cond(job, NULL); 4405d43e86eSKevin Wolf } 4415d43e86eSKevin Wolf 442da01ff7fSKevin Wolf /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds. 4433d70ff53SKevin Wolf * Reentering the job coroutine with job_enter() before the timer has expired 4443d70ff53SKevin Wolf * is allowed and cancels the timer. 445da01ff7fSKevin Wolf * 4463d70ff53SKevin Wolf * If @ns is (uint64_t) -1, no timer is scheduled and job_enter() must be 447da01ff7fSKevin Wolf * called explicitly. */ 448198c49ccSKevin Wolf static void coroutine_fn job_do_yield(Job *job, uint64_t ns) 449da01ff7fSKevin Wolf { 450da01ff7fSKevin Wolf job_lock(); 451da01ff7fSKevin Wolf if (ns != -1) { 452da01ff7fSKevin Wolf timer_mod(&job->sleep_timer, ns); 453da01ff7fSKevin Wolf } 454da01ff7fSKevin Wolf job->busy = false; 45534dc97b9SKevin Wolf job_event_idle(job); 456da01ff7fSKevin Wolf job_unlock(); 457da01ff7fSKevin Wolf qemu_coroutine_yield(); 458da01ff7fSKevin Wolf 459da01ff7fSKevin Wolf /* Set by job_enter_cond() before re-entering the coroutine. */ 460da01ff7fSKevin Wolf assert(job->busy); 461da01ff7fSKevin Wolf } 462da01ff7fSKevin Wolf 463da01ff7fSKevin Wolf void coroutine_fn job_pause_point(Job *job) 464da01ff7fSKevin Wolf { 465da01ff7fSKevin Wolf assert(job && job_started(job)); 466da01ff7fSKevin Wolf 467da01ff7fSKevin Wolf if (!job_should_pause(job)) { 468da01ff7fSKevin Wolf return; 469da01ff7fSKevin Wolf } 470da01ff7fSKevin Wolf if (job_is_cancelled(job)) { 471da01ff7fSKevin Wolf return; 472da01ff7fSKevin Wolf } 473da01ff7fSKevin Wolf 474da01ff7fSKevin Wolf if (job->driver->pause) { 475da01ff7fSKevin Wolf job->driver->pause(job); 476da01ff7fSKevin Wolf } 477da01ff7fSKevin Wolf 478da01ff7fSKevin Wolf if (job_should_pause(job) && !job_is_cancelled(job)) { 479da01ff7fSKevin Wolf JobStatus status = job->status; 480da01ff7fSKevin Wolf job_state_transition(job, status == JOB_STATUS_READY 481da01ff7fSKevin Wolf ? JOB_STATUS_STANDBY 482da01ff7fSKevin Wolf : JOB_STATUS_PAUSED); 483da01ff7fSKevin Wolf job->paused = true; 484da01ff7fSKevin Wolf job_do_yield(job, -1); 485da01ff7fSKevin Wolf job->paused = false; 486da01ff7fSKevin Wolf job_state_transition(job, status); 487da01ff7fSKevin Wolf } 488da01ff7fSKevin Wolf 489da01ff7fSKevin Wolf if (job->driver->resume) { 490da01ff7fSKevin Wolf job->driver->resume(job); 491da01ff7fSKevin Wolf } 492da01ff7fSKevin Wolf } 493da01ff7fSKevin Wolf 494198c49ccSKevin Wolf void job_yield(Job *job) 495198c49ccSKevin Wolf { 496198c49ccSKevin Wolf assert(job->busy); 497198c49ccSKevin Wolf 498198c49ccSKevin Wolf /* Check cancellation *before* setting busy = false, too! */ 499198c49ccSKevin Wolf if (job_is_cancelled(job)) { 500198c49ccSKevin Wolf return; 501198c49ccSKevin Wolf } 502198c49ccSKevin Wolf 503198c49ccSKevin Wolf if (!job_should_pause(job)) { 504198c49ccSKevin Wolf job_do_yield(job, -1); 505198c49ccSKevin Wolf } 506198c49ccSKevin Wolf 507198c49ccSKevin Wolf job_pause_point(job); 508198c49ccSKevin Wolf } 509198c49ccSKevin Wolf 5105d43e86eSKevin Wolf void coroutine_fn job_sleep_ns(Job *job, int64_t ns) 5115d43e86eSKevin Wolf { 5125d43e86eSKevin Wolf assert(job->busy); 5135d43e86eSKevin Wolf 5145d43e86eSKevin Wolf /* Check cancellation *before* setting busy = false, too! */ 5155d43e86eSKevin Wolf if (job_is_cancelled(job)) { 5165d43e86eSKevin Wolf return; 5175d43e86eSKevin Wolf } 5185d43e86eSKevin Wolf 5195d43e86eSKevin Wolf if (!job_should_pause(job)) { 5205d43e86eSKevin Wolf job_do_yield(job, qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + ns); 5215d43e86eSKevin Wolf } 5225d43e86eSKevin Wolf 5235d43e86eSKevin Wolf job_pause_point(job); 5245d43e86eSKevin Wolf } 5255d43e86eSKevin Wolf 526b15de828SKevin Wolf /* Assumes the block_job_mutex is held */ 527b15de828SKevin Wolf static bool job_timer_not_pending(Job *job) 528b15de828SKevin Wolf { 529b15de828SKevin Wolf return !timer_pending(&job->sleep_timer); 530b15de828SKevin Wolf } 531b15de828SKevin Wolf 532b15de828SKevin Wolf void job_pause(Job *job) 533b15de828SKevin Wolf { 534b15de828SKevin Wolf job->pause_count++; 535b15de828SKevin Wolf } 536b15de828SKevin Wolf 537b15de828SKevin Wolf void job_resume(Job *job) 538b15de828SKevin Wolf { 539b15de828SKevin Wolf assert(job->pause_count > 0); 540b15de828SKevin Wolf job->pause_count--; 541b15de828SKevin Wolf if (job->pause_count) { 542b15de828SKevin Wolf return; 543b15de828SKevin Wolf } 544b15de828SKevin Wolf 545b15de828SKevin Wolf /* kick only if no timer is pending */ 546b15de828SKevin Wolf job_enter_cond(job, job_timer_not_pending); 547b15de828SKevin Wolf } 548b15de828SKevin Wolf 549b15de828SKevin Wolf void job_user_pause(Job *job, Error **errp) 550b15de828SKevin Wolf { 551b15de828SKevin Wolf if (job_apply_verb(job, JOB_VERB_PAUSE, errp)) { 552b15de828SKevin Wolf return; 553b15de828SKevin Wolf } 554b15de828SKevin Wolf if (job->user_paused) { 555b15de828SKevin Wolf error_setg(errp, "Job is already paused"); 556b15de828SKevin Wolf return; 557b15de828SKevin Wolf } 558b15de828SKevin Wolf job->user_paused = true; 559b15de828SKevin Wolf job_pause(job); 560b15de828SKevin Wolf } 561b15de828SKevin Wolf 562b15de828SKevin Wolf bool job_user_paused(Job *job) 563b15de828SKevin Wolf { 564b15de828SKevin Wolf return job->user_paused; 565b15de828SKevin Wolf } 566b15de828SKevin Wolf 567b15de828SKevin Wolf void job_user_resume(Job *job, Error **errp) 568b15de828SKevin Wolf { 569b15de828SKevin Wolf assert(job); 570b15de828SKevin Wolf if (!job->user_paused || job->pause_count <= 0) { 571b15de828SKevin Wolf error_setg(errp, "Can't resume a job that was not paused"); 572b15de828SKevin Wolf return; 573b15de828SKevin Wolf } 574b15de828SKevin Wolf if (job_apply_verb(job, JOB_VERB_RESUME, errp)) { 575b15de828SKevin Wolf return; 576b15de828SKevin Wolf } 577b15de828SKevin Wolf if (job->driver->user_resume) { 578b15de828SKevin Wolf job->driver->user_resume(job); 579b15de828SKevin Wolf } 580b15de828SKevin Wolf job->user_paused = false; 581b15de828SKevin Wolf job_resume(job); 582b15de828SKevin Wolf } 583b15de828SKevin Wolf 5845f9a6a08SKevin Wolf static void job_do_dismiss(Job *job) 5854ad35181SKevin Wolf { 5864ad35181SKevin Wolf assert(job); 5874ad35181SKevin Wolf job->busy = false; 5884ad35181SKevin Wolf job->paused = false; 5894ad35181SKevin Wolf job->deferred_to_main_loop = true; 5904ad35181SKevin Wolf 5917eaa8fb5SKevin Wolf job_txn_del_job(job); 5924ad35181SKevin Wolf 5934ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_NULL); 5944ad35181SKevin Wolf job_unref(job); 5954ad35181SKevin Wolf } 5964ad35181SKevin Wolf 5975f9a6a08SKevin Wolf void job_dismiss(Job **jobptr, Error **errp) 5985f9a6a08SKevin Wolf { 5995f9a6a08SKevin Wolf Job *job = *jobptr; 6005f9a6a08SKevin Wolf /* similarly to _complete, this is QMP-interface only. */ 6015f9a6a08SKevin Wolf assert(job->id); 6025f9a6a08SKevin Wolf if (job_apply_verb(job, JOB_VERB_DISMISS, errp)) { 6035f9a6a08SKevin Wolf return; 6045f9a6a08SKevin Wolf } 6055f9a6a08SKevin Wolf 6065f9a6a08SKevin Wolf job_do_dismiss(job); 6075f9a6a08SKevin Wolf *jobptr = NULL; 6085f9a6a08SKevin Wolf } 6095f9a6a08SKevin Wolf 6104ad35181SKevin Wolf void job_early_fail(Job *job) 6114ad35181SKevin Wolf { 6124ad35181SKevin Wolf assert(job->status == JOB_STATUS_CREATED); 6134ad35181SKevin Wolf job_do_dismiss(job); 6144ad35181SKevin Wolf } 6154ad35181SKevin Wolf 6164ad35181SKevin Wolf static void job_conclude(Job *job) 6174ad35181SKevin Wolf { 6184ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_CONCLUDED); 6194ad35181SKevin Wolf if (job->auto_dismiss || !job_started(job)) { 6204ad35181SKevin Wolf job_do_dismiss(job); 6214ad35181SKevin Wolf } 6224ad35181SKevin Wolf } 6234ad35181SKevin Wolf 6243d70ff53SKevin Wolf static void job_update_rc(Job *job) 6254ad35181SKevin Wolf { 6264ad35181SKevin Wolf if (!job->ret && job_is_cancelled(job)) { 6274ad35181SKevin Wolf job->ret = -ECANCELED; 6284ad35181SKevin Wolf } 6294ad35181SKevin Wolf if (job->ret) { 6303d1f8b07SJohn Snow if (!job->err) { 6313d1f8b07SJohn Snow error_setg(&job->err, "%s", strerror(-job->ret)); 6321266c9b9SKevin Wolf } 6334ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_ABORTING); 6344ad35181SKevin Wolf } 6354ad35181SKevin Wolf } 6364ad35181SKevin Wolf 6374ad35181SKevin Wolf static void job_commit(Job *job) 6384ad35181SKevin Wolf { 6394ad35181SKevin Wolf assert(!job->ret); 6404ad35181SKevin Wolf if (job->driver->commit) { 6414ad35181SKevin Wolf job->driver->commit(job); 6424ad35181SKevin Wolf } 6434ad35181SKevin Wolf } 6444ad35181SKevin Wolf 6454ad35181SKevin Wolf static void job_abort(Job *job) 6464ad35181SKevin Wolf { 6474ad35181SKevin Wolf assert(job->ret); 6484ad35181SKevin Wolf if (job->driver->abort) { 6494ad35181SKevin Wolf job->driver->abort(job); 6504ad35181SKevin Wolf } 6514ad35181SKevin Wolf } 6524ad35181SKevin Wolf 6534ad35181SKevin Wolf static void job_clean(Job *job) 6544ad35181SKevin Wolf { 6554ad35181SKevin Wolf if (job->driver->clean) { 6564ad35181SKevin Wolf job->driver->clean(job); 6574ad35181SKevin Wolf } 6584ad35181SKevin Wolf } 6594ad35181SKevin Wolf 6607eaa8fb5SKevin Wolf static int job_finalize_single(Job *job) 6614ad35181SKevin Wolf { 6624ad35181SKevin Wolf assert(job_is_completed(job)); 6634ad35181SKevin Wolf 6644ad35181SKevin Wolf /* Ensure abort is called for late-transactional failures */ 6654ad35181SKevin Wolf job_update_rc(job); 6664ad35181SKevin Wolf 6674ad35181SKevin Wolf if (!job->ret) { 6684ad35181SKevin Wolf job_commit(job); 6694ad35181SKevin Wolf } else { 6704ad35181SKevin Wolf job_abort(job); 6714ad35181SKevin Wolf } 6724ad35181SKevin Wolf job_clean(job); 6734ad35181SKevin Wolf 6744ad35181SKevin Wolf if (job->cb) { 6754ad35181SKevin Wolf job->cb(job->opaque, job->ret); 6764ad35181SKevin Wolf } 6774ad35181SKevin Wolf 6784ad35181SKevin Wolf /* Emit events only if we actually started */ 6794ad35181SKevin Wolf if (job_started(job)) { 6804ad35181SKevin Wolf if (job_is_cancelled(job)) { 6814ad35181SKevin Wolf job_event_cancelled(job); 6824ad35181SKevin Wolf } else { 6834ad35181SKevin Wolf job_event_completed(job); 6844ad35181SKevin Wolf } 6854ad35181SKevin Wolf } 6864ad35181SKevin Wolf 6877eaa8fb5SKevin Wolf job_txn_del_job(job); 6884ad35181SKevin Wolf job_conclude(job); 6894ad35181SKevin Wolf return 0; 6904ad35181SKevin Wolf } 6914ad35181SKevin Wolf 6923d70ff53SKevin Wolf static void job_cancel_async(Job *job, bool force) 6937eaa8fb5SKevin Wolf { 6947eaa8fb5SKevin Wolf if (job->user_paused) { 6957eaa8fb5SKevin Wolf /* Do not call job_enter here, the caller will handle it. */ 6967eaa8fb5SKevin Wolf if (job->driver->user_resume) { 6977eaa8fb5SKevin Wolf job->driver->user_resume(job); 6987eaa8fb5SKevin Wolf } 699e321c059SJeff Cody job->user_paused = false; 7007eaa8fb5SKevin Wolf assert(job->pause_count > 0); 7017eaa8fb5SKevin Wolf job->pause_count--; 7027eaa8fb5SKevin Wolf } 7037eaa8fb5SKevin Wolf job->cancelled = true; 7047eaa8fb5SKevin Wolf /* To prevent 'force == false' overriding a previous 'force == true' */ 7057eaa8fb5SKevin Wolf job->force_cancel |= force; 7067eaa8fb5SKevin Wolf } 7077eaa8fb5SKevin Wolf 7083d70ff53SKevin Wolf static void job_completed_txn_abort(Job *job) 7097eaa8fb5SKevin Wolf { 710644f3a29SKevin Wolf AioContext *outer_ctx = job->aio_context; 7117eaa8fb5SKevin Wolf AioContext *ctx; 7127eaa8fb5SKevin Wolf JobTxn *txn = job->txn; 7137eaa8fb5SKevin Wolf Job *other_job; 7147eaa8fb5SKevin Wolf 7157eaa8fb5SKevin Wolf if (txn->aborting) { 7167eaa8fb5SKevin Wolf /* 7177eaa8fb5SKevin Wolf * We are cancelled by another job, which will handle everything. 7187eaa8fb5SKevin Wolf */ 7197eaa8fb5SKevin Wolf return; 7207eaa8fb5SKevin Wolf } 7217eaa8fb5SKevin Wolf txn->aborting = true; 7227eaa8fb5SKevin Wolf job_txn_ref(txn); 7237eaa8fb5SKevin Wolf 724644f3a29SKevin Wolf /* We can only hold the single job's AioContext lock while calling 725644f3a29SKevin Wolf * job_finalize_single() because the finalization callbacks can involve 726644f3a29SKevin Wolf * calls of AIO_WAIT_WHILE(), which could deadlock otherwise. */ 727644f3a29SKevin Wolf aio_context_release(outer_ctx); 7287eaa8fb5SKevin Wolf 7297eaa8fb5SKevin Wolf /* Other jobs are effectively cancelled by us, set the status for 7307eaa8fb5SKevin Wolf * them; this job, however, may or may not be cancelled, depending 7317eaa8fb5SKevin Wolf * on the caller, so leave it. */ 7327eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 7337eaa8fb5SKevin Wolf if (other_job != job) { 734644f3a29SKevin Wolf ctx = other_job->aio_context; 735644f3a29SKevin Wolf aio_context_acquire(ctx); 7367eaa8fb5SKevin Wolf job_cancel_async(other_job, false); 737644f3a29SKevin Wolf aio_context_release(ctx); 7387eaa8fb5SKevin Wolf } 7397eaa8fb5SKevin Wolf } 7407eaa8fb5SKevin Wolf while (!QLIST_EMPTY(&txn->jobs)) { 7417eaa8fb5SKevin Wolf other_job = QLIST_FIRST(&txn->jobs); 7427eaa8fb5SKevin Wolf ctx = other_job->aio_context; 743644f3a29SKevin Wolf aio_context_acquire(ctx); 7447eaa8fb5SKevin Wolf if (!job_is_completed(other_job)) { 7457eaa8fb5SKevin Wolf assert(job_is_cancelled(other_job)); 7467eaa8fb5SKevin Wolf job_finish_sync(other_job, NULL, NULL); 7477eaa8fb5SKevin Wolf } 7487eaa8fb5SKevin Wolf job_finalize_single(other_job); 7497eaa8fb5SKevin Wolf aio_context_release(ctx); 7507eaa8fb5SKevin Wolf } 7517eaa8fb5SKevin Wolf 752644f3a29SKevin Wolf aio_context_acquire(outer_ctx); 753644f3a29SKevin Wolf 7547eaa8fb5SKevin Wolf job_txn_unref(txn); 7557eaa8fb5SKevin Wolf } 7567eaa8fb5SKevin Wolf 7577eaa8fb5SKevin Wolf static int job_prepare(Job *job) 7587eaa8fb5SKevin Wolf { 7597eaa8fb5SKevin Wolf if (job->ret == 0 && job->driver->prepare) { 7607eaa8fb5SKevin Wolf job->ret = job->driver->prepare(job); 7611266c9b9SKevin Wolf job_update_rc(job); 7627eaa8fb5SKevin Wolf } 7637eaa8fb5SKevin Wolf return job->ret; 7647eaa8fb5SKevin Wolf } 7657eaa8fb5SKevin Wolf 7667eaa8fb5SKevin Wolf static int job_needs_finalize(Job *job) 7677eaa8fb5SKevin Wolf { 7687eaa8fb5SKevin Wolf return !job->auto_finalize; 7697eaa8fb5SKevin Wolf } 7707eaa8fb5SKevin Wolf 7717eaa8fb5SKevin Wolf static void job_do_finalize(Job *job) 7727eaa8fb5SKevin Wolf { 7737eaa8fb5SKevin Wolf int rc; 7747eaa8fb5SKevin Wolf assert(job && job->txn); 7757eaa8fb5SKevin Wolf 7767eaa8fb5SKevin Wolf /* prepare the transaction to complete */ 77749880165SFam Zheng rc = job_txn_apply(job->txn, job_prepare); 7787eaa8fb5SKevin Wolf if (rc) { 7797eaa8fb5SKevin Wolf job_completed_txn_abort(job); 7807eaa8fb5SKevin Wolf } else { 78149880165SFam Zheng job_txn_apply(job->txn, job_finalize_single); 7827eaa8fb5SKevin Wolf } 7837eaa8fb5SKevin Wolf } 7847eaa8fb5SKevin Wolf 7857eaa8fb5SKevin Wolf void job_finalize(Job *job, Error **errp) 7867eaa8fb5SKevin Wolf { 7877eaa8fb5SKevin Wolf assert(job && job->id); 7887eaa8fb5SKevin Wolf if (job_apply_verb(job, JOB_VERB_FINALIZE, errp)) { 7897eaa8fb5SKevin Wolf return; 7907eaa8fb5SKevin Wolf } 7917eaa8fb5SKevin Wolf job_do_finalize(job); 7927eaa8fb5SKevin Wolf } 7937eaa8fb5SKevin Wolf 7947eaa8fb5SKevin Wolf static int job_transition_to_pending(Job *job) 7957eaa8fb5SKevin Wolf { 7967eaa8fb5SKevin Wolf job_state_transition(job, JOB_STATUS_PENDING); 7977eaa8fb5SKevin Wolf if (!job->auto_finalize) { 7987eaa8fb5SKevin Wolf job_event_pending(job); 7997eaa8fb5SKevin Wolf } 8007eaa8fb5SKevin Wolf return 0; 8017eaa8fb5SKevin Wolf } 8027eaa8fb5SKevin Wolf 8032e1795b5SKevin Wolf void job_transition_to_ready(Job *job) 8042e1795b5SKevin Wolf { 8052e1795b5SKevin Wolf job_state_transition(job, JOB_STATUS_READY); 8062e1795b5SKevin Wolf job_event_ready(job); 8072e1795b5SKevin Wolf } 8082e1795b5SKevin Wolf 8093d70ff53SKevin Wolf static void job_completed_txn_success(Job *job) 8107eaa8fb5SKevin Wolf { 8117eaa8fb5SKevin Wolf JobTxn *txn = job->txn; 8127eaa8fb5SKevin Wolf Job *other_job; 8137eaa8fb5SKevin Wolf 8147eaa8fb5SKevin Wolf job_state_transition(job, JOB_STATUS_WAITING); 8157eaa8fb5SKevin Wolf 8167eaa8fb5SKevin Wolf /* 8177eaa8fb5SKevin Wolf * Successful completion, see if there are other running jobs in this 8187eaa8fb5SKevin Wolf * txn. 8197eaa8fb5SKevin Wolf */ 8207eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 8217eaa8fb5SKevin Wolf if (!job_is_completed(other_job)) { 8227eaa8fb5SKevin Wolf return; 8237eaa8fb5SKevin Wolf } 8247eaa8fb5SKevin Wolf assert(other_job->ret == 0); 8257eaa8fb5SKevin Wolf } 8267eaa8fb5SKevin Wolf 82749880165SFam Zheng job_txn_apply(txn, job_transition_to_pending); 8287eaa8fb5SKevin Wolf 8297eaa8fb5SKevin Wolf /* If no jobs need manual finalization, automatically do so */ 83049880165SFam Zheng if (job_txn_apply(txn, job_needs_finalize) == 0) { 8317eaa8fb5SKevin Wolf job_do_finalize(job); 8327eaa8fb5SKevin Wolf } 8337eaa8fb5SKevin Wolf } 8347eaa8fb5SKevin Wolf 835404ff28dSJohn Snow static void job_completed(Job *job) 8363d70ff53SKevin Wolf { 8373d70ff53SKevin Wolf assert(job && job->txn && !job_is_completed(job)); 8381266c9b9SKevin Wolf 8393d70ff53SKevin Wolf job_update_rc(job); 840404ff28dSJohn Snow trace_job_completed(job, job->ret); 8413d70ff53SKevin Wolf if (job->ret) { 8423d70ff53SKevin Wolf job_completed_txn_abort(job); 8433d70ff53SKevin Wolf } else { 8443d70ff53SKevin Wolf job_completed_txn_success(job); 8453d70ff53SKevin Wolf } 8463d70ff53SKevin Wolf } 8473d70ff53SKevin Wolf 848ccbfb331SJohn Snow /** Useful only as a type shim for aio_bh_schedule_oneshot. */ 849ccbfb331SJohn Snow static void job_exit(void *opaque) 850ccbfb331SJohn Snow { 851ccbfb331SJohn Snow Job *job = (Job *)opaque; 852d1756c78SKevin Wolf AioContext *ctx = job->aio_context; 853d1756c78SKevin Wolf 854d1756c78SKevin Wolf aio_context_acquire(ctx); 855b5a7a057SKevin Wolf 856b5a7a057SKevin Wolf /* This is a lie, we're not quiescent, but still doing the completion 857b5a7a057SKevin Wolf * callbacks. However, completion callbacks tend to involve operations that 858b5a7a057SKevin Wolf * drain block nodes, and if .drained_poll still returned true, we would 859b5a7a057SKevin Wolf * deadlock. */ 860b5a7a057SKevin Wolf job->busy = false; 861b5a7a057SKevin Wolf job_event_idle(job); 862b5a7a057SKevin Wolf 863ccbfb331SJohn Snow job_completed(job); 864b5a7a057SKevin Wolf 865d1756c78SKevin Wolf aio_context_release(ctx); 866ccbfb331SJohn Snow } 867ccbfb331SJohn Snow 868ccbfb331SJohn Snow /** 869ccbfb331SJohn Snow * All jobs must allow a pause point before entering their job proper. This 870ccbfb331SJohn Snow * ensures that jobs can be paused prior to being started, then resumed later. 871ccbfb331SJohn Snow */ 872ccbfb331SJohn Snow static void coroutine_fn job_co_entry(void *opaque) 873ccbfb331SJohn Snow { 874ccbfb331SJohn Snow Job *job = opaque; 875ccbfb331SJohn Snow 876ccbfb331SJohn Snow assert(job && job->driver && job->driver->run); 877ccbfb331SJohn Snow job_pause_point(job); 878ccbfb331SJohn Snow job->ret = job->driver->run(job, &job->err); 879ccbfb331SJohn Snow job->deferred_to_main_loop = true; 880b5a7a057SKevin Wolf job->busy = true; 881ccbfb331SJohn Snow aio_bh_schedule_oneshot(qemu_get_aio_context(), job_exit, job); 882ccbfb331SJohn Snow } 883ccbfb331SJohn Snow 884ccbfb331SJohn Snow void job_start(Job *job) 885ccbfb331SJohn Snow { 886ccbfb331SJohn Snow assert(job && !job_started(job) && job->paused && 887ccbfb331SJohn Snow job->driver && job->driver->run); 888ccbfb331SJohn Snow job->co = qemu_coroutine_create(job_co_entry, job); 889ccbfb331SJohn Snow job->pause_count--; 890ccbfb331SJohn Snow job->busy = true; 891ccbfb331SJohn Snow job->paused = false; 892ccbfb331SJohn Snow job_state_transition(job, JOB_STATUS_RUNNING); 893ccbfb331SJohn Snow aio_co_enter(job->aio_context, job->co); 894ccbfb331SJohn Snow } 895ccbfb331SJohn Snow 8963d70ff53SKevin Wolf void job_cancel(Job *job, bool force) 8973d70ff53SKevin Wolf { 8983d70ff53SKevin Wolf if (job->status == JOB_STATUS_CONCLUDED) { 8993d70ff53SKevin Wolf job_do_dismiss(job); 9003d70ff53SKevin Wolf return; 9013d70ff53SKevin Wolf } 9023d70ff53SKevin Wolf job_cancel_async(job, force); 9033d70ff53SKevin Wolf if (!job_started(job)) { 904404ff28dSJohn Snow job_completed(job); 9053d70ff53SKevin Wolf } else if (job->deferred_to_main_loop) { 9063d70ff53SKevin Wolf job_completed_txn_abort(job); 9073d70ff53SKevin Wolf } else { 9083d70ff53SKevin Wolf job_enter(job); 9093d70ff53SKevin Wolf } 9103d70ff53SKevin Wolf } 9113d70ff53SKevin Wolf 9123d70ff53SKevin Wolf void job_user_cancel(Job *job, bool force, Error **errp) 9133d70ff53SKevin Wolf { 9143d70ff53SKevin Wolf if (job_apply_verb(job, JOB_VERB_CANCEL, errp)) { 9153d70ff53SKevin Wolf return; 9163d70ff53SKevin Wolf } 9173d70ff53SKevin Wolf job_cancel(job, force); 9183d70ff53SKevin Wolf } 9193d70ff53SKevin Wolf 9203d70ff53SKevin Wolf /* A wrapper around job_cancel() taking an Error ** parameter so it may be 9213d70ff53SKevin Wolf * used with job_finish_sync() without the need for (rather nasty) function 9223d70ff53SKevin Wolf * pointer casts there. */ 9233d70ff53SKevin Wolf static void job_cancel_err(Job *job, Error **errp) 9243d70ff53SKevin Wolf { 9253d70ff53SKevin Wolf job_cancel(job, false); 9263d70ff53SKevin Wolf } 9273d70ff53SKevin Wolf 9283d70ff53SKevin Wolf int job_cancel_sync(Job *job) 9293d70ff53SKevin Wolf { 9303d70ff53SKevin Wolf return job_finish_sync(job, &job_cancel_err, NULL); 9313d70ff53SKevin Wolf } 9323d70ff53SKevin Wolf 9333d70ff53SKevin Wolf void job_cancel_sync_all(void) 9343d70ff53SKevin Wolf { 9353d70ff53SKevin Wolf Job *job; 9363d70ff53SKevin Wolf AioContext *aio_context; 9373d70ff53SKevin Wolf 9383d70ff53SKevin Wolf while ((job = job_next(NULL))) { 9393d70ff53SKevin Wolf aio_context = job->aio_context; 9403d70ff53SKevin Wolf aio_context_acquire(aio_context); 9413d70ff53SKevin Wolf job_cancel_sync(job); 9423d70ff53SKevin Wolf aio_context_release(aio_context); 9433d70ff53SKevin Wolf } 9443d70ff53SKevin Wolf } 9453d70ff53SKevin Wolf 9463d70ff53SKevin Wolf int job_complete_sync(Job *job, Error **errp) 9473d70ff53SKevin Wolf { 9483d70ff53SKevin Wolf return job_finish_sync(job, job_complete, errp); 9493d70ff53SKevin Wolf } 9503d70ff53SKevin Wolf 9513453d972SKevin Wolf void job_complete(Job *job, Error **errp) 9523453d972SKevin Wolf { 9533453d972SKevin Wolf /* Should not be reachable via external interface for internal jobs */ 9543453d972SKevin Wolf assert(job->id); 9553453d972SKevin Wolf if (job_apply_verb(job, JOB_VERB_COMPLETE, errp)) { 9563453d972SKevin Wolf return; 9573453d972SKevin Wolf } 9583453d972SKevin Wolf if (job->pause_count || job_is_cancelled(job) || !job->driver->complete) { 9593453d972SKevin Wolf error_setg(errp, "The active block job '%s' cannot be completed", 9603453d972SKevin Wolf job->id); 9613453d972SKevin Wolf return; 9623453d972SKevin Wolf } 9633453d972SKevin Wolf 9643453d972SKevin Wolf job->driver->complete(job, errp); 9653453d972SKevin Wolf } 9663453d972SKevin Wolf 9676a74c075SKevin Wolf int job_finish_sync(Job *job, void (*finish)(Job *, Error **errp), Error **errp) 9686a74c075SKevin Wolf { 9696a74c075SKevin Wolf Error *local_err = NULL; 9706a74c075SKevin Wolf int ret; 9716a74c075SKevin Wolf 9726a74c075SKevin Wolf job_ref(job); 9736a74c075SKevin Wolf 9746a74c075SKevin Wolf if (finish) { 9756a74c075SKevin Wolf finish(job, &local_err); 9766a74c075SKevin Wolf } 9776a74c075SKevin Wolf if (local_err) { 9786a74c075SKevin Wolf error_propagate(errp, local_err); 9796a74c075SKevin Wolf job_unref(job); 9806a74c075SKevin Wolf return -EBUSY; 9816a74c075SKevin Wolf } 982de0fbe64SKevin Wolf 983cfe29d82SKevin Wolf AIO_WAIT_WHILE(job->aio_context, 984bb0c9409SVladimir Sementsov-Ogievskiy (job_enter(job), !job_is_completed(job))); 985de0fbe64SKevin Wolf 9866a74c075SKevin Wolf ret = (job_is_cancelled(job) && job->ret == 0) ? -ECANCELED : job->ret; 9876a74c075SKevin Wolf job_unref(job); 9886a74c075SKevin Wolf return ret; 9896a74c075SKevin Wolf } 990