133e9e9bdSKevin Wolf /* 233e9e9bdSKevin Wolf * Background jobs (long-running operations) 333e9e9bdSKevin Wolf * 433e9e9bdSKevin Wolf * Copyright (c) 2011 IBM Corp. 533e9e9bdSKevin Wolf * Copyright (c) 2012, 2018 Red Hat, Inc. 633e9e9bdSKevin Wolf * 733e9e9bdSKevin Wolf * Permission is hereby granted, free of charge, to any person obtaining a copy 833e9e9bdSKevin Wolf * of this software and associated documentation files (the "Software"), to deal 933e9e9bdSKevin Wolf * in the Software without restriction, including without limitation the rights 1033e9e9bdSKevin Wolf * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 1133e9e9bdSKevin Wolf * copies of the Software, and to permit persons to whom the Software is 1233e9e9bdSKevin Wolf * furnished to do so, subject to the following conditions: 1333e9e9bdSKevin Wolf * 1433e9e9bdSKevin Wolf * The above copyright notice and this permission notice shall be included in 1533e9e9bdSKevin Wolf * all copies or substantial portions of the Software. 1633e9e9bdSKevin Wolf * 1733e9e9bdSKevin Wolf * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 1833e9e9bdSKevin Wolf * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 1933e9e9bdSKevin Wolf * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 2033e9e9bdSKevin Wolf * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 2133e9e9bdSKevin Wolf * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 2233e9e9bdSKevin Wolf * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 2333e9e9bdSKevin Wolf * THE SOFTWARE. 2433e9e9bdSKevin Wolf */ 2533e9e9bdSKevin Wolf 2633e9e9bdSKevin Wolf #include "qemu/osdep.h" 2733e9e9bdSKevin Wolf #include "qemu-common.h" 2833e9e9bdSKevin Wolf #include "qapi/error.h" 2933e9e9bdSKevin Wolf #include "qemu/job.h" 3033e9e9bdSKevin Wolf #include "qemu/id.h" 311908a559SKevin Wolf #include "qemu/main-loop.h" 32a50c2ab8SKevin Wolf #include "trace-root.h" 331dac83f1SKevin Wolf #include "qapi/qapi-events-job.h" 3433e9e9bdSKevin Wolf 35e7c1d78bSKevin Wolf static QLIST_HEAD(, Job) jobs = QLIST_HEAD_INITIALIZER(jobs); 36e7c1d78bSKevin Wolf 37a50c2ab8SKevin Wolf /* Job State Transition Table */ 38a50c2ab8SKevin Wolf bool JobSTT[JOB_STATUS__MAX][JOB_STATUS__MAX] = { 39a50c2ab8SKevin Wolf /* U, C, R, P, Y, S, W, D, X, E, N */ 40a50c2ab8SKevin Wolf /* U: */ [JOB_STATUS_UNDEFINED] = {0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0}, 41a50c2ab8SKevin Wolf /* C: */ [JOB_STATUS_CREATED] = {0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 1}, 42a50c2ab8SKevin Wolf /* R: */ [JOB_STATUS_RUNNING] = {0, 0, 0, 1, 1, 0, 1, 0, 1, 0, 0}, 43a50c2ab8SKevin Wolf /* P: */ [JOB_STATUS_PAUSED] = {0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0}, 44a50c2ab8SKevin Wolf /* Y: */ [JOB_STATUS_READY] = {0, 0, 0, 0, 0, 1, 1, 0, 1, 0, 0}, 45a50c2ab8SKevin Wolf /* S: */ [JOB_STATUS_STANDBY] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0}, 46a50c2ab8SKevin Wolf /* W: */ [JOB_STATUS_WAITING] = {0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0}, 47a50c2ab8SKevin Wolf /* D: */ [JOB_STATUS_PENDING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, 48a50c2ab8SKevin Wolf /* X: */ [JOB_STATUS_ABORTING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, 49a50c2ab8SKevin Wolf /* E: */ [JOB_STATUS_CONCLUDED] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}, 50a50c2ab8SKevin Wolf /* N: */ [JOB_STATUS_NULL] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}, 51a50c2ab8SKevin Wolf }; 52a50c2ab8SKevin Wolf 53a50c2ab8SKevin Wolf bool JobVerbTable[JOB_VERB__MAX][JOB_STATUS__MAX] = { 54a50c2ab8SKevin Wolf /* U, C, R, P, Y, S, W, D, X, E, N */ 55a50c2ab8SKevin Wolf [JOB_VERB_CANCEL] = {0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0}, 56a50c2ab8SKevin Wolf [JOB_VERB_PAUSE] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 57a50c2ab8SKevin Wolf [JOB_VERB_RESUME] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 58a50c2ab8SKevin Wolf [JOB_VERB_SET_SPEED] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 59a50c2ab8SKevin Wolf [JOB_VERB_COMPLETE] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0}, 60a50c2ab8SKevin Wolf [JOB_VERB_FINALIZE] = {0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0}, 61a50c2ab8SKevin Wolf [JOB_VERB_DISMISS] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0}, 62a50c2ab8SKevin Wolf }; 63a50c2ab8SKevin Wolf 647eaa8fb5SKevin Wolf /* Transactional group of jobs */ 657eaa8fb5SKevin Wolf struct JobTxn { 667eaa8fb5SKevin Wolf 677eaa8fb5SKevin Wolf /* Is this txn being cancelled? */ 687eaa8fb5SKevin Wolf bool aborting; 697eaa8fb5SKevin Wolf 707eaa8fb5SKevin Wolf /* List of jobs */ 717eaa8fb5SKevin Wolf QLIST_HEAD(, Job) jobs; 727eaa8fb5SKevin Wolf 737eaa8fb5SKevin Wolf /* Reference count */ 747eaa8fb5SKevin Wolf int refcnt; 757eaa8fb5SKevin Wolf }; 767eaa8fb5SKevin Wolf 77da01ff7fSKevin Wolf /* Right now, this mutex is only needed to synchronize accesses to job->busy 78da01ff7fSKevin Wolf * and job->sleep_timer, such as concurrent calls to job_do_yield and 79da01ff7fSKevin Wolf * job_enter. */ 80da01ff7fSKevin Wolf static QemuMutex job_mutex; 81da01ff7fSKevin Wolf 82da01ff7fSKevin Wolf static void job_lock(void) 83da01ff7fSKevin Wolf { 84da01ff7fSKevin Wolf qemu_mutex_lock(&job_mutex); 85da01ff7fSKevin Wolf } 86da01ff7fSKevin Wolf 87da01ff7fSKevin Wolf static void job_unlock(void) 88da01ff7fSKevin Wolf { 89da01ff7fSKevin Wolf qemu_mutex_unlock(&job_mutex); 90da01ff7fSKevin Wolf } 91da01ff7fSKevin Wolf 92da01ff7fSKevin Wolf static void __attribute__((__constructor__)) job_init(void) 93da01ff7fSKevin Wolf { 94da01ff7fSKevin Wolf qemu_mutex_init(&job_mutex); 95da01ff7fSKevin Wolf } 96da01ff7fSKevin Wolf 977eaa8fb5SKevin Wolf JobTxn *job_txn_new(void) 987eaa8fb5SKevin Wolf { 997eaa8fb5SKevin Wolf JobTxn *txn = g_new0(JobTxn, 1); 1007eaa8fb5SKevin Wolf QLIST_INIT(&txn->jobs); 1017eaa8fb5SKevin Wolf txn->refcnt = 1; 1027eaa8fb5SKevin Wolf return txn; 1037eaa8fb5SKevin Wolf } 1047eaa8fb5SKevin Wolf 1057eaa8fb5SKevin Wolf static void job_txn_ref(JobTxn *txn) 1067eaa8fb5SKevin Wolf { 1077eaa8fb5SKevin Wolf txn->refcnt++; 1087eaa8fb5SKevin Wolf } 1097eaa8fb5SKevin Wolf 1107eaa8fb5SKevin Wolf void job_txn_unref(JobTxn *txn) 1117eaa8fb5SKevin Wolf { 1127eaa8fb5SKevin Wolf if (txn && --txn->refcnt == 0) { 1137eaa8fb5SKevin Wolf g_free(txn); 1147eaa8fb5SKevin Wolf } 1157eaa8fb5SKevin Wolf } 1167eaa8fb5SKevin Wolf 1177eaa8fb5SKevin Wolf void job_txn_add_job(JobTxn *txn, Job *job) 1187eaa8fb5SKevin Wolf { 1197eaa8fb5SKevin Wolf if (!txn) { 1207eaa8fb5SKevin Wolf return; 1217eaa8fb5SKevin Wolf } 1227eaa8fb5SKevin Wolf 1237eaa8fb5SKevin Wolf assert(!job->txn); 1247eaa8fb5SKevin Wolf job->txn = txn; 1257eaa8fb5SKevin Wolf 1267eaa8fb5SKevin Wolf QLIST_INSERT_HEAD(&txn->jobs, job, txn_list); 1277eaa8fb5SKevin Wolf job_txn_ref(txn); 1287eaa8fb5SKevin Wolf } 1297eaa8fb5SKevin Wolf 1307eaa8fb5SKevin Wolf static void job_txn_del_job(Job *job) 1317eaa8fb5SKevin Wolf { 1327eaa8fb5SKevin Wolf if (job->txn) { 1337eaa8fb5SKevin Wolf QLIST_REMOVE(job, txn_list); 1347eaa8fb5SKevin Wolf job_txn_unref(job->txn); 1357eaa8fb5SKevin Wolf job->txn = NULL; 1367eaa8fb5SKevin Wolf } 1377eaa8fb5SKevin Wolf } 1387eaa8fb5SKevin Wolf 1397eaa8fb5SKevin Wolf static int job_txn_apply(JobTxn *txn, int fn(Job *), bool lock) 1407eaa8fb5SKevin Wolf { 1417eaa8fb5SKevin Wolf AioContext *ctx; 1427eaa8fb5SKevin Wolf Job *job, *next; 1437eaa8fb5SKevin Wolf int rc = 0; 1447eaa8fb5SKevin Wolf 1457eaa8fb5SKevin Wolf QLIST_FOREACH_SAFE(job, &txn->jobs, txn_list, next) { 1467eaa8fb5SKevin Wolf if (lock) { 1477eaa8fb5SKevin Wolf ctx = job->aio_context; 1487eaa8fb5SKevin Wolf aio_context_acquire(ctx); 1497eaa8fb5SKevin Wolf } 1507eaa8fb5SKevin Wolf rc = fn(job); 1517eaa8fb5SKevin Wolf if (lock) { 1527eaa8fb5SKevin Wolf aio_context_release(ctx); 1537eaa8fb5SKevin Wolf } 1547eaa8fb5SKevin Wolf if (rc) { 1557eaa8fb5SKevin Wolf break; 1567eaa8fb5SKevin Wolf } 1577eaa8fb5SKevin Wolf } 1587eaa8fb5SKevin Wolf return rc; 1597eaa8fb5SKevin Wolf } 1607eaa8fb5SKevin Wolf 161456273b0SKevin Wolf bool job_is_internal(Job *job) 1621dac83f1SKevin Wolf { 1631dac83f1SKevin Wolf return (job->id == NULL); 1641dac83f1SKevin Wolf } 1651dac83f1SKevin Wolf 1662e1795b5SKevin Wolf static void job_state_transition(Job *job, JobStatus s1) 167a50c2ab8SKevin Wolf { 168a50c2ab8SKevin Wolf JobStatus s0 = job->status; 169a50c2ab8SKevin Wolf assert(s1 >= 0 && s1 <= JOB_STATUS__MAX); 1704ad35181SKevin Wolf trace_job_state_transition(job, job->ret, 171a50c2ab8SKevin Wolf JobSTT[s0][s1] ? "allowed" : "disallowed", 172a50c2ab8SKevin Wolf JobStatus_str(s0), JobStatus_str(s1)); 173a50c2ab8SKevin Wolf assert(JobSTT[s0][s1]); 174a50c2ab8SKevin Wolf job->status = s1; 1751dac83f1SKevin Wolf 1761dac83f1SKevin Wolf if (!job_is_internal(job) && s1 != s0) { 1771dac83f1SKevin Wolf qapi_event_send_job_status_change(job->id, job->status, &error_abort); 1781dac83f1SKevin Wolf } 179a50c2ab8SKevin Wolf } 180a50c2ab8SKevin Wolf 181a50c2ab8SKevin Wolf int job_apply_verb(Job *job, JobVerb verb, Error **errp) 182a50c2ab8SKevin Wolf { 183a50c2ab8SKevin Wolf JobStatus s0 = job->status; 184a50c2ab8SKevin Wolf assert(verb >= 0 && verb <= JOB_VERB__MAX); 185a50c2ab8SKevin Wolf trace_job_apply_verb(job, JobStatus_str(s0), JobVerb_str(verb), 186a50c2ab8SKevin Wolf JobVerbTable[verb][s0] ? "allowed" : "prohibited"); 187a50c2ab8SKevin Wolf if (JobVerbTable[verb][s0]) { 188a50c2ab8SKevin Wolf return 0; 189a50c2ab8SKevin Wolf } 190a50c2ab8SKevin Wolf error_setg(errp, "Job '%s' in state '%s' cannot accept command verb '%s'", 191a50c2ab8SKevin Wolf job->id, JobStatus_str(s0), JobVerb_str(verb)); 192a50c2ab8SKevin Wolf return -EPERM; 193a50c2ab8SKevin Wolf } 194a50c2ab8SKevin Wolf 195252291eaSKevin Wolf JobType job_type(const Job *job) 196252291eaSKevin Wolf { 197252291eaSKevin Wolf return job->driver->job_type; 198252291eaSKevin Wolf } 199252291eaSKevin Wolf 200252291eaSKevin Wolf const char *job_type_str(const Job *job) 201252291eaSKevin Wolf { 202252291eaSKevin Wolf return JobType_str(job_type(job)); 203252291eaSKevin Wolf } 204252291eaSKevin Wolf 205daa7f2f9SKevin Wolf bool job_is_cancelled(Job *job) 206daa7f2f9SKevin Wolf { 207daa7f2f9SKevin Wolf return job->cancelled; 208daa7f2f9SKevin Wolf } 209daa7f2f9SKevin Wolf 210df956ae2SKevin Wolf bool job_is_ready(Job *job) 211df956ae2SKevin Wolf { 212df956ae2SKevin Wolf switch (job->status) { 213df956ae2SKevin Wolf case JOB_STATUS_UNDEFINED: 214df956ae2SKevin Wolf case JOB_STATUS_CREATED: 215df956ae2SKevin Wolf case JOB_STATUS_RUNNING: 216df956ae2SKevin Wolf case JOB_STATUS_PAUSED: 217df956ae2SKevin Wolf case JOB_STATUS_WAITING: 218df956ae2SKevin Wolf case JOB_STATUS_PENDING: 219df956ae2SKevin Wolf case JOB_STATUS_ABORTING: 220df956ae2SKevin Wolf case JOB_STATUS_CONCLUDED: 221df956ae2SKevin Wolf case JOB_STATUS_NULL: 222df956ae2SKevin Wolf return false; 223df956ae2SKevin Wolf case JOB_STATUS_READY: 224df956ae2SKevin Wolf case JOB_STATUS_STANDBY: 225df956ae2SKevin Wolf return true; 226df956ae2SKevin Wolf default: 227df956ae2SKevin Wolf g_assert_not_reached(); 228df956ae2SKevin Wolf } 229df956ae2SKevin Wolf return false; 230df956ae2SKevin Wolf } 231df956ae2SKevin Wolf 232dbe5e6c1SKevin Wolf bool job_is_completed(Job *job) 233dbe5e6c1SKevin Wolf { 234dbe5e6c1SKevin Wolf switch (job->status) { 235dbe5e6c1SKevin Wolf case JOB_STATUS_UNDEFINED: 236dbe5e6c1SKevin Wolf case JOB_STATUS_CREATED: 237dbe5e6c1SKevin Wolf case JOB_STATUS_RUNNING: 238dbe5e6c1SKevin Wolf case JOB_STATUS_PAUSED: 239dbe5e6c1SKevin Wolf case JOB_STATUS_READY: 240dbe5e6c1SKevin Wolf case JOB_STATUS_STANDBY: 241dbe5e6c1SKevin Wolf return false; 242dbe5e6c1SKevin Wolf case JOB_STATUS_WAITING: 243dbe5e6c1SKevin Wolf case JOB_STATUS_PENDING: 244dbe5e6c1SKevin Wolf case JOB_STATUS_ABORTING: 245dbe5e6c1SKevin Wolf case JOB_STATUS_CONCLUDED: 246dbe5e6c1SKevin Wolf case JOB_STATUS_NULL: 247dbe5e6c1SKevin Wolf return true; 248dbe5e6c1SKevin Wolf default: 249dbe5e6c1SKevin Wolf g_assert_not_reached(); 250dbe5e6c1SKevin Wolf } 251dbe5e6c1SKevin Wolf return false; 252dbe5e6c1SKevin Wolf } 253dbe5e6c1SKevin Wolf 2543d70ff53SKevin Wolf static bool job_started(Job *job) 255da01ff7fSKevin Wolf { 256da01ff7fSKevin Wolf return job->co; 257da01ff7fSKevin Wolf } 258da01ff7fSKevin Wolf 259198c49ccSKevin Wolf static bool job_should_pause(Job *job) 260da01ff7fSKevin Wolf { 261da01ff7fSKevin Wolf return job->pause_count > 0; 262da01ff7fSKevin Wolf } 263da01ff7fSKevin Wolf 264e7c1d78bSKevin Wolf Job *job_next(Job *job) 265e7c1d78bSKevin Wolf { 266e7c1d78bSKevin Wolf if (!job) { 267e7c1d78bSKevin Wolf return QLIST_FIRST(&jobs); 268e7c1d78bSKevin Wolf } 269e7c1d78bSKevin Wolf return QLIST_NEXT(job, job_list); 270e7c1d78bSKevin Wolf } 271e7c1d78bSKevin Wolf 272e7c1d78bSKevin Wolf Job *job_get(const char *id) 273e7c1d78bSKevin Wolf { 274e7c1d78bSKevin Wolf Job *job; 275e7c1d78bSKevin Wolf 276e7c1d78bSKevin Wolf QLIST_FOREACH(job, &jobs, job_list) { 277e7c1d78bSKevin Wolf if (job->id && !strcmp(id, job->id)) { 278e7c1d78bSKevin Wolf return job; 279e7c1d78bSKevin Wolf } 280e7c1d78bSKevin Wolf } 281e7c1d78bSKevin Wolf 282e7c1d78bSKevin Wolf return NULL; 283e7c1d78bSKevin Wolf } 284e7c1d78bSKevin Wolf 2855d43e86eSKevin Wolf static void job_sleep_timer_cb(void *opaque) 2865d43e86eSKevin Wolf { 2875d43e86eSKevin Wolf Job *job = opaque; 2885d43e86eSKevin Wolf 2895d43e86eSKevin Wolf job_enter(job); 2905d43e86eSKevin Wolf } 2915d43e86eSKevin Wolf 2927eaa8fb5SKevin Wolf void *job_create(const char *job_id, const JobDriver *driver, JobTxn *txn, 2937eaa8fb5SKevin Wolf AioContext *ctx, int flags, BlockCompletionFunc *cb, 2947eaa8fb5SKevin Wolf void *opaque, Error **errp) 29533e9e9bdSKevin Wolf { 29633e9e9bdSKevin Wolf Job *job; 29733e9e9bdSKevin Wolf 29833e9e9bdSKevin Wolf if (job_id) { 299bb02b65cSKevin Wolf if (flags & JOB_INTERNAL) { 300bb02b65cSKevin Wolf error_setg(errp, "Cannot specify job ID for internal job"); 301bb02b65cSKevin Wolf return NULL; 302bb02b65cSKevin Wolf } 30333e9e9bdSKevin Wolf if (!id_wellformed(job_id)) { 30433e9e9bdSKevin Wolf error_setg(errp, "Invalid job ID '%s'", job_id); 30533e9e9bdSKevin Wolf return NULL; 30633e9e9bdSKevin Wolf } 307e7c1d78bSKevin Wolf if (job_get(job_id)) { 308e7c1d78bSKevin Wolf error_setg(errp, "Job ID '%s' already in use", job_id); 309e7c1d78bSKevin Wolf return NULL; 310e7c1d78bSKevin Wolf } 311bb02b65cSKevin Wolf } else if (!(flags & JOB_INTERNAL)) { 312bb02b65cSKevin Wolf error_setg(errp, "An explicit job ID is required"); 313bb02b65cSKevin Wolf return NULL; 31433e9e9bdSKevin Wolf } 31533e9e9bdSKevin Wolf 31633e9e9bdSKevin Wolf job = g_malloc0(driver->instance_size); 31733e9e9bdSKevin Wolf job->driver = driver; 31833e9e9bdSKevin Wolf job->id = g_strdup(job_id); 31980fa2c75SKevin Wolf job->refcnt = 1; 32008be6fe2SKevin Wolf job->aio_context = ctx; 321da01ff7fSKevin Wolf job->busy = false; 322da01ff7fSKevin Wolf job->paused = true; 323da01ff7fSKevin Wolf job->pause_count = 1; 324bb02b65cSKevin Wolf job->auto_finalize = !(flags & JOB_MANUAL_FINALIZE); 325bb02b65cSKevin Wolf job->auto_dismiss = !(flags & JOB_MANUAL_DISMISS); 3264ad35181SKevin Wolf job->cb = cb; 3274ad35181SKevin Wolf job->opaque = opaque; 32833e9e9bdSKevin Wolf 329139a9f02SKevin Wolf notifier_list_init(&job->on_finalize_cancelled); 330139a9f02SKevin Wolf notifier_list_init(&job->on_finalize_completed); 331139a9f02SKevin Wolf notifier_list_init(&job->on_pending); 3322e1795b5SKevin Wolf notifier_list_init(&job->on_ready); 333139a9f02SKevin Wolf 334a50c2ab8SKevin Wolf job_state_transition(job, JOB_STATUS_CREATED); 3355d43e86eSKevin Wolf aio_timer_init(qemu_get_aio_context(), &job->sleep_timer, 3365d43e86eSKevin Wolf QEMU_CLOCK_REALTIME, SCALE_NS, 3375d43e86eSKevin Wolf job_sleep_timer_cb, job); 338a50c2ab8SKevin Wolf 339e7c1d78bSKevin Wolf QLIST_INSERT_HEAD(&jobs, job, job_list); 340e7c1d78bSKevin Wolf 3417eaa8fb5SKevin Wolf /* Single jobs are modeled as single-job transactions for sake of 3427eaa8fb5SKevin Wolf * consolidating the job management logic */ 3437eaa8fb5SKevin Wolf if (!txn) { 3447eaa8fb5SKevin Wolf txn = job_txn_new(); 3457eaa8fb5SKevin Wolf job_txn_add_job(txn, job); 3467eaa8fb5SKevin Wolf job_txn_unref(txn); 3477eaa8fb5SKevin Wolf } else { 3487eaa8fb5SKevin Wolf job_txn_add_job(txn, job); 3497eaa8fb5SKevin Wolf } 3507eaa8fb5SKevin Wolf 35133e9e9bdSKevin Wolf return job; 35233e9e9bdSKevin Wolf } 353fd61a701SKevin Wolf 35480fa2c75SKevin Wolf void job_ref(Job *job) 355fd61a701SKevin Wolf { 35680fa2c75SKevin Wolf ++job->refcnt; 35780fa2c75SKevin Wolf } 35880fa2c75SKevin Wolf 35980fa2c75SKevin Wolf void job_unref(Job *job) 36080fa2c75SKevin Wolf { 36180fa2c75SKevin Wolf if (--job->refcnt == 0) { 36280fa2c75SKevin Wolf assert(job->status == JOB_STATUS_NULL); 3635d43e86eSKevin Wolf assert(!timer_pending(&job->sleep_timer)); 3647eaa8fb5SKevin Wolf assert(!job->txn); 36580fa2c75SKevin Wolf 36680fa2c75SKevin Wolf if (job->driver->free) { 36780fa2c75SKevin Wolf job->driver->free(job); 36880fa2c75SKevin Wolf } 36980fa2c75SKevin Wolf 370e7c1d78bSKevin Wolf QLIST_REMOVE(job, job_list); 371e7c1d78bSKevin Wolf 3723d1f8b07SJohn Snow error_free(job->err); 373fd61a701SKevin Wolf g_free(job->id); 374fd61a701SKevin Wolf g_free(job); 375fd61a701SKevin Wolf } 37680fa2c75SKevin Wolf } 3771908a559SKevin Wolf 37830a5c887SKevin Wolf void job_progress_update(Job *job, uint64_t done) 37930a5c887SKevin Wolf { 38030a5c887SKevin Wolf job->progress_current += done; 38130a5c887SKevin Wolf } 38230a5c887SKevin Wolf 38330a5c887SKevin Wolf void job_progress_set_remaining(Job *job, uint64_t remaining) 38430a5c887SKevin Wolf { 38530a5c887SKevin Wolf job->progress_total = job->progress_current + remaining; 38630a5c887SKevin Wolf } 38730a5c887SKevin Wolf 38862f13600SMax Reitz void job_progress_increase_remaining(Job *job, uint64_t delta) 38962f13600SMax Reitz { 39062f13600SMax Reitz job->progress_total += delta; 39162f13600SMax Reitz } 39262f13600SMax Reitz 393139a9f02SKevin Wolf void job_event_cancelled(Job *job) 394139a9f02SKevin Wolf { 395139a9f02SKevin Wolf notifier_list_notify(&job->on_finalize_cancelled, job); 396139a9f02SKevin Wolf } 397139a9f02SKevin Wolf 398139a9f02SKevin Wolf void job_event_completed(Job *job) 399139a9f02SKevin Wolf { 400139a9f02SKevin Wolf notifier_list_notify(&job->on_finalize_completed, job); 401139a9f02SKevin Wolf } 402139a9f02SKevin Wolf 4037eaa8fb5SKevin Wolf static void job_event_pending(Job *job) 404139a9f02SKevin Wolf { 405139a9f02SKevin Wolf notifier_list_notify(&job->on_pending, job); 406139a9f02SKevin Wolf } 407139a9f02SKevin Wolf 4082e1795b5SKevin Wolf static void job_event_ready(Job *job) 4092e1795b5SKevin Wolf { 4102e1795b5SKevin Wolf notifier_list_notify(&job->on_ready, job); 4112e1795b5SKevin Wolf } 4122e1795b5SKevin Wolf 413da01ff7fSKevin Wolf void job_enter_cond(Job *job, bool(*fn)(Job *job)) 414da01ff7fSKevin Wolf { 415da01ff7fSKevin Wolf if (!job_started(job)) { 416da01ff7fSKevin Wolf return; 417da01ff7fSKevin Wolf } 418da01ff7fSKevin Wolf if (job->deferred_to_main_loop) { 419da01ff7fSKevin Wolf return; 420da01ff7fSKevin Wolf } 421da01ff7fSKevin Wolf 422da01ff7fSKevin Wolf job_lock(); 423da01ff7fSKevin Wolf if (job->busy) { 424da01ff7fSKevin Wolf job_unlock(); 425da01ff7fSKevin Wolf return; 426da01ff7fSKevin Wolf } 427da01ff7fSKevin Wolf 428da01ff7fSKevin Wolf if (fn && !fn(job)) { 429da01ff7fSKevin Wolf job_unlock(); 430da01ff7fSKevin Wolf return; 431da01ff7fSKevin Wolf } 432da01ff7fSKevin Wolf 433da01ff7fSKevin Wolf assert(!job->deferred_to_main_loop); 434da01ff7fSKevin Wolf timer_del(&job->sleep_timer); 435da01ff7fSKevin Wolf job->busy = true; 436da01ff7fSKevin Wolf job_unlock(); 437da01ff7fSKevin Wolf aio_co_wake(job->co); 438da01ff7fSKevin Wolf } 439da01ff7fSKevin Wolf 4405d43e86eSKevin Wolf void job_enter(Job *job) 4415d43e86eSKevin Wolf { 4425d43e86eSKevin Wolf job_enter_cond(job, NULL); 4435d43e86eSKevin Wolf } 4445d43e86eSKevin Wolf 445da01ff7fSKevin Wolf /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds. 4463d70ff53SKevin Wolf * Reentering the job coroutine with job_enter() before the timer has expired 4473d70ff53SKevin Wolf * is allowed and cancels the timer. 448da01ff7fSKevin Wolf * 4493d70ff53SKevin Wolf * If @ns is (uint64_t) -1, no timer is scheduled and job_enter() must be 450da01ff7fSKevin Wolf * called explicitly. */ 451198c49ccSKevin Wolf static void coroutine_fn job_do_yield(Job *job, uint64_t ns) 452da01ff7fSKevin Wolf { 453da01ff7fSKevin Wolf job_lock(); 454da01ff7fSKevin Wolf if (ns != -1) { 455da01ff7fSKevin Wolf timer_mod(&job->sleep_timer, ns); 456da01ff7fSKevin Wolf } 457da01ff7fSKevin Wolf job->busy = false; 458da01ff7fSKevin Wolf job_unlock(); 459da01ff7fSKevin Wolf qemu_coroutine_yield(); 460da01ff7fSKevin Wolf 461da01ff7fSKevin Wolf /* Set by job_enter_cond() before re-entering the coroutine. */ 462da01ff7fSKevin Wolf assert(job->busy); 463da01ff7fSKevin Wolf } 464da01ff7fSKevin Wolf 465da01ff7fSKevin Wolf void coroutine_fn job_pause_point(Job *job) 466da01ff7fSKevin Wolf { 467da01ff7fSKevin Wolf assert(job && job_started(job)); 468da01ff7fSKevin Wolf 469da01ff7fSKevin Wolf if (!job_should_pause(job)) { 470da01ff7fSKevin Wolf return; 471da01ff7fSKevin Wolf } 472da01ff7fSKevin Wolf if (job_is_cancelled(job)) { 473da01ff7fSKevin Wolf return; 474da01ff7fSKevin Wolf } 475da01ff7fSKevin Wolf 476da01ff7fSKevin Wolf if (job->driver->pause) { 477da01ff7fSKevin Wolf job->driver->pause(job); 478da01ff7fSKevin Wolf } 479da01ff7fSKevin Wolf 480da01ff7fSKevin Wolf if (job_should_pause(job) && !job_is_cancelled(job)) { 481da01ff7fSKevin Wolf JobStatus status = job->status; 482da01ff7fSKevin Wolf job_state_transition(job, status == JOB_STATUS_READY 483da01ff7fSKevin Wolf ? JOB_STATUS_STANDBY 484da01ff7fSKevin Wolf : JOB_STATUS_PAUSED); 485da01ff7fSKevin Wolf job->paused = true; 486da01ff7fSKevin Wolf job_do_yield(job, -1); 487da01ff7fSKevin Wolf job->paused = false; 488da01ff7fSKevin Wolf job_state_transition(job, status); 489da01ff7fSKevin Wolf } 490da01ff7fSKevin Wolf 491da01ff7fSKevin Wolf if (job->driver->resume) { 492da01ff7fSKevin Wolf job->driver->resume(job); 493da01ff7fSKevin Wolf } 494da01ff7fSKevin Wolf } 495da01ff7fSKevin Wolf 496198c49ccSKevin Wolf void job_yield(Job *job) 497198c49ccSKevin Wolf { 498198c49ccSKevin Wolf assert(job->busy); 499198c49ccSKevin Wolf 500198c49ccSKevin Wolf /* Check cancellation *before* setting busy = false, too! */ 501198c49ccSKevin Wolf if (job_is_cancelled(job)) { 502198c49ccSKevin Wolf return; 503198c49ccSKevin Wolf } 504198c49ccSKevin Wolf 505198c49ccSKevin Wolf if (!job_should_pause(job)) { 506198c49ccSKevin Wolf job_do_yield(job, -1); 507198c49ccSKevin Wolf } 508198c49ccSKevin Wolf 509198c49ccSKevin Wolf job_pause_point(job); 510198c49ccSKevin Wolf } 511198c49ccSKevin Wolf 5125d43e86eSKevin Wolf void coroutine_fn job_sleep_ns(Job *job, int64_t ns) 5135d43e86eSKevin Wolf { 5145d43e86eSKevin Wolf assert(job->busy); 5155d43e86eSKevin Wolf 5165d43e86eSKevin Wolf /* Check cancellation *before* setting busy = false, too! */ 5175d43e86eSKevin Wolf if (job_is_cancelled(job)) { 5185d43e86eSKevin Wolf return; 5195d43e86eSKevin Wolf } 5205d43e86eSKevin Wolf 5215d43e86eSKevin Wolf if (!job_should_pause(job)) { 5225d43e86eSKevin Wolf job_do_yield(job, qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + ns); 5235d43e86eSKevin Wolf } 5245d43e86eSKevin Wolf 5255d43e86eSKevin Wolf job_pause_point(job); 5265d43e86eSKevin Wolf } 5275d43e86eSKevin Wolf 528b69f777dSKevin Wolf void job_drain(Job *job) 529b69f777dSKevin Wolf { 530b69f777dSKevin Wolf /* If job is !busy this kicks it into the next pause point. */ 531b69f777dSKevin Wolf job_enter(job); 532b69f777dSKevin Wolf 533b69f777dSKevin Wolf if (job->driver->drain) { 534b69f777dSKevin Wolf job->driver->drain(job); 535b69f777dSKevin Wolf } 536b69f777dSKevin Wolf } 537b69f777dSKevin Wolf 538*404ff28dSJohn Snow static void job_completed(Job *job); 539*404ff28dSJohn Snow 54000359a71SJohn Snow static void job_exit(void *opaque) 54100359a71SJohn Snow { 54200359a71SJohn Snow Job *job = (Job *)opaque; 54300359a71SJohn Snow AioContext *aio_context = job->aio_context; 54400359a71SJohn Snow 54500359a71SJohn Snow if (job->driver->exit) { 54600359a71SJohn Snow aio_context_acquire(aio_context); 54700359a71SJohn Snow job->driver->exit(job); 54800359a71SJohn Snow aio_context_release(aio_context); 54900359a71SJohn Snow } 550*404ff28dSJohn Snow job_completed(job); 55100359a71SJohn Snow } 552b69f777dSKevin Wolf 553da01ff7fSKevin Wolf /** 554da01ff7fSKevin Wolf * All jobs must allow a pause point before entering their job proper. This 555da01ff7fSKevin Wolf * ensures that jobs can be paused prior to being started, then resumed later. 556da01ff7fSKevin Wolf */ 557da01ff7fSKevin Wolf static void coroutine_fn job_co_entry(void *opaque) 558da01ff7fSKevin Wolf { 559da01ff7fSKevin Wolf Job *job = opaque; 560da01ff7fSKevin Wolf 561f67432a2SJohn Snow assert(job && job->driver && job->driver->run); 562da01ff7fSKevin Wolf job_pause_point(job); 5633d1f8b07SJohn Snow job->ret = job->driver->run(job, &job->err); 56400359a71SJohn Snow if (!job->deferred_to_main_loop) { 56500359a71SJohn Snow job->deferred_to_main_loop = true; 56600359a71SJohn Snow aio_bh_schedule_oneshot(qemu_get_aio_context(), 56700359a71SJohn Snow job_exit, 56800359a71SJohn Snow job); 56900359a71SJohn Snow } 570da01ff7fSKevin Wolf } 571da01ff7fSKevin Wolf 572da01ff7fSKevin Wolf 573da01ff7fSKevin Wolf void job_start(Job *job) 574da01ff7fSKevin Wolf { 575da01ff7fSKevin Wolf assert(job && !job_started(job) && job->paused && 576f67432a2SJohn Snow job->driver && job->driver->run); 577da01ff7fSKevin Wolf job->co = qemu_coroutine_create(job_co_entry, job); 578da01ff7fSKevin Wolf job->pause_count--; 579da01ff7fSKevin Wolf job->busy = true; 580da01ff7fSKevin Wolf job->paused = false; 581da01ff7fSKevin Wolf job_state_transition(job, JOB_STATUS_RUNNING); 582da01ff7fSKevin Wolf aio_co_enter(job->aio_context, job->co); 583da01ff7fSKevin Wolf } 584da01ff7fSKevin Wolf 585b15de828SKevin Wolf /* Assumes the block_job_mutex is held */ 586b15de828SKevin Wolf static bool job_timer_not_pending(Job *job) 587b15de828SKevin Wolf { 588b15de828SKevin Wolf return !timer_pending(&job->sleep_timer); 589b15de828SKevin Wolf } 590b15de828SKevin Wolf 591b15de828SKevin Wolf void job_pause(Job *job) 592b15de828SKevin Wolf { 593b15de828SKevin Wolf job->pause_count++; 594b15de828SKevin Wolf } 595b15de828SKevin Wolf 596b15de828SKevin Wolf void job_resume(Job *job) 597b15de828SKevin Wolf { 598b15de828SKevin Wolf assert(job->pause_count > 0); 599b15de828SKevin Wolf job->pause_count--; 600b15de828SKevin Wolf if (job->pause_count) { 601b15de828SKevin Wolf return; 602b15de828SKevin Wolf } 603b15de828SKevin Wolf 604b15de828SKevin Wolf /* kick only if no timer is pending */ 605b15de828SKevin Wolf job_enter_cond(job, job_timer_not_pending); 606b15de828SKevin Wolf } 607b15de828SKevin Wolf 608b15de828SKevin Wolf void job_user_pause(Job *job, Error **errp) 609b15de828SKevin Wolf { 610b15de828SKevin Wolf if (job_apply_verb(job, JOB_VERB_PAUSE, errp)) { 611b15de828SKevin Wolf return; 612b15de828SKevin Wolf } 613b15de828SKevin Wolf if (job->user_paused) { 614b15de828SKevin Wolf error_setg(errp, "Job is already paused"); 615b15de828SKevin Wolf return; 616b15de828SKevin Wolf } 617b15de828SKevin Wolf job->user_paused = true; 618b15de828SKevin Wolf job_pause(job); 619b15de828SKevin Wolf } 620b15de828SKevin Wolf 621b15de828SKevin Wolf bool job_user_paused(Job *job) 622b15de828SKevin Wolf { 623b15de828SKevin Wolf return job->user_paused; 624b15de828SKevin Wolf } 625b15de828SKevin Wolf 626b15de828SKevin Wolf void job_user_resume(Job *job, Error **errp) 627b15de828SKevin Wolf { 628b15de828SKevin Wolf assert(job); 629b15de828SKevin Wolf if (!job->user_paused || job->pause_count <= 0) { 630b15de828SKevin Wolf error_setg(errp, "Can't resume a job that was not paused"); 631b15de828SKevin Wolf return; 632b15de828SKevin Wolf } 633b15de828SKevin Wolf if (job_apply_verb(job, JOB_VERB_RESUME, errp)) { 634b15de828SKevin Wolf return; 635b15de828SKevin Wolf } 636b15de828SKevin Wolf if (job->driver->user_resume) { 637b15de828SKevin Wolf job->driver->user_resume(job); 638b15de828SKevin Wolf } 639b15de828SKevin Wolf job->user_paused = false; 640b15de828SKevin Wolf job_resume(job); 641b15de828SKevin Wolf } 642b15de828SKevin Wolf 6435f9a6a08SKevin Wolf static void job_do_dismiss(Job *job) 6444ad35181SKevin Wolf { 6454ad35181SKevin Wolf assert(job); 6464ad35181SKevin Wolf job->busy = false; 6474ad35181SKevin Wolf job->paused = false; 6484ad35181SKevin Wolf job->deferred_to_main_loop = true; 6494ad35181SKevin Wolf 6507eaa8fb5SKevin Wolf job_txn_del_job(job); 6514ad35181SKevin Wolf 6524ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_NULL); 6534ad35181SKevin Wolf job_unref(job); 6544ad35181SKevin Wolf } 6554ad35181SKevin Wolf 6565f9a6a08SKevin Wolf void job_dismiss(Job **jobptr, Error **errp) 6575f9a6a08SKevin Wolf { 6585f9a6a08SKevin Wolf Job *job = *jobptr; 6595f9a6a08SKevin Wolf /* similarly to _complete, this is QMP-interface only. */ 6605f9a6a08SKevin Wolf assert(job->id); 6615f9a6a08SKevin Wolf if (job_apply_verb(job, JOB_VERB_DISMISS, errp)) { 6625f9a6a08SKevin Wolf return; 6635f9a6a08SKevin Wolf } 6645f9a6a08SKevin Wolf 6655f9a6a08SKevin Wolf job_do_dismiss(job); 6665f9a6a08SKevin Wolf *jobptr = NULL; 6675f9a6a08SKevin Wolf } 6685f9a6a08SKevin Wolf 6694ad35181SKevin Wolf void job_early_fail(Job *job) 6704ad35181SKevin Wolf { 6714ad35181SKevin Wolf assert(job->status == JOB_STATUS_CREATED); 6724ad35181SKevin Wolf job_do_dismiss(job); 6734ad35181SKevin Wolf } 6744ad35181SKevin Wolf 6754ad35181SKevin Wolf static void job_conclude(Job *job) 6764ad35181SKevin Wolf { 6774ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_CONCLUDED); 6784ad35181SKevin Wolf if (job->auto_dismiss || !job_started(job)) { 6794ad35181SKevin Wolf job_do_dismiss(job); 6804ad35181SKevin Wolf } 6814ad35181SKevin Wolf } 6824ad35181SKevin Wolf 6833d70ff53SKevin Wolf static void job_update_rc(Job *job) 6844ad35181SKevin Wolf { 6854ad35181SKevin Wolf if (!job->ret && job_is_cancelled(job)) { 6864ad35181SKevin Wolf job->ret = -ECANCELED; 6874ad35181SKevin Wolf } 6884ad35181SKevin Wolf if (job->ret) { 6893d1f8b07SJohn Snow if (!job->err) { 6903d1f8b07SJohn Snow error_setg(&job->err, "%s", strerror(-job->ret)); 6911266c9b9SKevin Wolf } 6924ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_ABORTING); 6934ad35181SKevin Wolf } 6944ad35181SKevin Wolf } 6954ad35181SKevin Wolf 6964ad35181SKevin Wolf static void job_commit(Job *job) 6974ad35181SKevin Wolf { 6984ad35181SKevin Wolf assert(!job->ret); 6994ad35181SKevin Wolf if (job->driver->commit) { 7004ad35181SKevin Wolf job->driver->commit(job); 7014ad35181SKevin Wolf } 7024ad35181SKevin Wolf } 7034ad35181SKevin Wolf 7044ad35181SKevin Wolf static void job_abort(Job *job) 7054ad35181SKevin Wolf { 7064ad35181SKevin Wolf assert(job->ret); 7074ad35181SKevin Wolf if (job->driver->abort) { 7084ad35181SKevin Wolf job->driver->abort(job); 7094ad35181SKevin Wolf } 7104ad35181SKevin Wolf } 7114ad35181SKevin Wolf 7124ad35181SKevin Wolf static void job_clean(Job *job) 7134ad35181SKevin Wolf { 7144ad35181SKevin Wolf if (job->driver->clean) { 7154ad35181SKevin Wolf job->driver->clean(job); 7164ad35181SKevin Wolf } 7174ad35181SKevin Wolf } 7184ad35181SKevin Wolf 7197eaa8fb5SKevin Wolf static int job_finalize_single(Job *job) 7204ad35181SKevin Wolf { 7214ad35181SKevin Wolf assert(job_is_completed(job)); 7224ad35181SKevin Wolf 7234ad35181SKevin Wolf /* Ensure abort is called for late-transactional failures */ 7244ad35181SKevin Wolf job_update_rc(job); 7254ad35181SKevin Wolf 7264ad35181SKevin Wolf if (!job->ret) { 7274ad35181SKevin Wolf job_commit(job); 7284ad35181SKevin Wolf } else { 7294ad35181SKevin Wolf job_abort(job); 7304ad35181SKevin Wolf } 7314ad35181SKevin Wolf job_clean(job); 7324ad35181SKevin Wolf 7334ad35181SKevin Wolf if (job->cb) { 7344ad35181SKevin Wolf job->cb(job->opaque, job->ret); 7354ad35181SKevin Wolf } 7364ad35181SKevin Wolf 7374ad35181SKevin Wolf /* Emit events only if we actually started */ 7384ad35181SKevin Wolf if (job_started(job)) { 7394ad35181SKevin Wolf if (job_is_cancelled(job)) { 7404ad35181SKevin Wolf job_event_cancelled(job); 7414ad35181SKevin Wolf } else { 7424ad35181SKevin Wolf job_event_completed(job); 7434ad35181SKevin Wolf } 7444ad35181SKevin Wolf } 7454ad35181SKevin Wolf 7467eaa8fb5SKevin Wolf job_txn_del_job(job); 7474ad35181SKevin Wolf job_conclude(job); 7484ad35181SKevin Wolf return 0; 7494ad35181SKevin Wolf } 7504ad35181SKevin Wolf 7513d70ff53SKevin Wolf static void job_cancel_async(Job *job, bool force) 7527eaa8fb5SKevin Wolf { 7537eaa8fb5SKevin Wolf if (job->user_paused) { 7547eaa8fb5SKevin Wolf /* Do not call job_enter here, the caller will handle it. */ 7557eaa8fb5SKevin Wolf if (job->driver->user_resume) { 7567eaa8fb5SKevin Wolf job->driver->user_resume(job); 7577eaa8fb5SKevin Wolf } 758e321c059SJeff Cody job->user_paused = false; 7597eaa8fb5SKevin Wolf assert(job->pause_count > 0); 7607eaa8fb5SKevin Wolf job->pause_count--; 7617eaa8fb5SKevin Wolf } 7627eaa8fb5SKevin Wolf job->cancelled = true; 7637eaa8fb5SKevin Wolf /* To prevent 'force == false' overriding a previous 'force == true' */ 7647eaa8fb5SKevin Wolf job->force_cancel |= force; 7657eaa8fb5SKevin Wolf } 7667eaa8fb5SKevin Wolf 7673d70ff53SKevin Wolf static void job_completed_txn_abort(Job *job) 7687eaa8fb5SKevin Wolf { 7697eaa8fb5SKevin Wolf AioContext *ctx; 7707eaa8fb5SKevin Wolf JobTxn *txn = job->txn; 7717eaa8fb5SKevin Wolf Job *other_job; 7727eaa8fb5SKevin Wolf 7737eaa8fb5SKevin Wolf if (txn->aborting) { 7747eaa8fb5SKevin Wolf /* 7757eaa8fb5SKevin Wolf * We are cancelled by another job, which will handle everything. 7767eaa8fb5SKevin Wolf */ 7777eaa8fb5SKevin Wolf return; 7787eaa8fb5SKevin Wolf } 7797eaa8fb5SKevin Wolf txn->aborting = true; 7807eaa8fb5SKevin Wolf job_txn_ref(txn); 7817eaa8fb5SKevin Wolf 7827eaa8fb5SKevin Wolf /* We are the first failed job. Cancel other jobs. */ 7837eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 7847eaa8fb5SKevin Wolf ctx = other_job->aio_context; 7857eaa8fb5SKevin Wolf aio_context_acquire(ctx); 7867eaa8fb5SKevin Wolf } 7877eaa8fb5SKevin Wolf 7887eaa8fb5SKevin Wolf /* Other jobs are effectively cancelled by us, set the status for 7897eaa8fb5SKevin Wolf * them; this job, however, may or may not be cancelled, depending 7907eaa8fb5SKevin Wolf * on the caller, so leave it. */ 7917eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 7927eaa8fb5SKevin Wolf if (other_job != job) { 7937eaa8fb5SKevin Wolf job_cancel_async(other_job, false); 7947eaa8fb5SKevin Wolf } 7957eaa8fb5SKevin Wolf } 7967eaa8fb5SKevin Wolf while (!QLIST_EMPTY(&txn->jobs)) { 7977eaa8fb5SKevin Wolf other_job = QLIST_FIRST(&txn->jobs); 7987eaa8fb5SKevin Wolf ctx = other_job->aio_context; 7997eaa8fb5SKevin Wolf if (!job_is_completed(other_job)) { 8007eaa8fb5SKevin Wolf assert(job_is_cancelled(other_job)); 8017eaa8fb5SKevin Wolf job_finish_sync(other_job, NULL, NULL); 8027eaa8fb5SKevin Wolf } 8037eaa8fb5SKevin Wolf job_finalize_single(other_job); 8047eaa8fb5SKevin Wolf aio_context_release(ctx); 8057eaa8fb5SKevin Wolf } 8067eaa8fb5SKevin Wolf 8077eaa8fb5SKevin Wolf job_txn_unref(txn); 8087eaa8fb5SKevin Wolf } 8097eaa8fb5SKevin Wolf 8107eaa8fb5SKevin Wolf static int job_prepare(Job *job) 8117eaa8fb5SKevin Wolf { 8127eaa8fb5SKevin Wolf if (job->ret == 0 && job->driver->prepare) { 8137eaa8fb5SKevin Wolf job->ret = job->driver->prepare(job); 8141266c9b9SKevin Wolf job_update_rc(job); 8157eaa8fb5SKevin Wolf } 8167eaa8fb5SKevin Wolf return job->ret; 8177eaa8fb5SKevin Wolf } 8187eaa8fb5SKevin Wolf 8197eaa8fb5SKevin Wolf static int job_needs_finalize(Job *job) 8207eaa8fb5SKevin Wolf { 8217eaa8fb5SKevin Wolf return !job->auto_finalize; 8227eaa8fb5SKevin Wolf } 8237eaa8fb5SKevin Wolf 8247eaa8fb5SKevin Wolf static void job_do_finalize(Job *job) 8257eaa8fb5SKevin Wolf { 8267eaa8fb5SKevin Wolf int rc; 8277eaa8fb5SKevin Wolf assert(job && job->txn); 8287eaa8fb5SKevin Wolf 8297eaa8fb5SKevin Wolf /* prepare the transaction to complete */ 8307eaa8fb5SKevin Wolf rc = job_txn_apply(job->txn, job_prepare, true); 8317eaa8fb5SKevin Wolf if (rc) { 8327eaa8fb5SKevin Wolf job_completed_txn_abort(job); 8337eaa8fb5SKevin Wolf } else { 8347eaa8fb5SKevin Wolf job_txn_apply(job->txn, job_finalize_single, true); 8357eaa8fb5SKevin Wolf } 8367eaa8fb5SKevin Wolf } 8377eaa8fb5SKevin Wolf 8387eaa8fb5SKevin Wolf void job_finalize(Job *job, Error **errp) 8397eaa8fb5SKevin Wolf { 8407eaa8fb5SKevin Wolf assert(job && job->id); 8417eaa8fb5SKevin Wolf if (job_apply_verb(job, JOB_VERB_FINALIZE, errp)) { 8427eaa8fb5SKevin Wolf return; 8437eaa8fb5SKevin Wolf } 8447eaa8fb5SKevin Wolf job_do_finalize(job); 8457eaa8fb5SKevin Wolf } 8467eaa8fb5SKevin Wolf 8477eaa8fb5SKevin Wolf static int job_transition_to_pending(Job *job) 8487eaa8fb5SKevin Wolf { 8497eaa8fb5SKevin Wolf job_state_transition(job, JOB_STATUS_PENDING); 8507eaa8fb5SKevin Wolf if (!job->auto_finalize) { 8517eaa8fb5SKevin Wolf job_event_pending(job); 8527eaa8fb5SKevin Wolf } 8537eaa8fb5SKevin Wolf return 0; 8547eaa8fb5SKevin Wolf } 8557eaa8fb5SKevin Wolf 8562e1795b5SKevin Wolf void job_transition_to_ready(Job *job) 8572e1795b5SKevin Wolf { 8582e1795b5SKevin Wolf job_state_transition(job, JOB_STATUS_READY); 8592e1795b5SKevin Wolf job_event_ready(job); 8602e1795b5SKevin Wolf } 8612e1795b5SKevin Wolf 8623d70ff53SKevin Wolf static void job_completed_txn_success(Job *job) 8637eaa8fb5SKevin Wolf { 8647eaa8fb5SKevin Wolf JobTxn *txn = job->txn; 8657eaa8fb5SKevin Wolf Job *other_job; 8667eaa8fb5SKevin Wolf 8677eaa8fb5SKevin Wolf job_state_transition(job, JOB_STATUS_WAITING); 8687eaa8fb5SKevin Wolf 8697eaa8fb5SKevin Wolf /* 8707eaa8fb5SKevin Wolf * Successful completion, see if there are other running jobs in this 8717eaa8fb5SKevin Wolf * txn. 8727eaa8fb5SKevin Wolf */ 8737eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 8747eaa8fb5SKevin Wolf if (!job_is_completed(other_job)) { 8757eaa8fb5SKevin Wolf return; 8767eaa8fb5SKevin Wolf } 8777eaa8fb5SKevin Wolf assert(other_job->ret == 0); 8787eaa8fb5SKevin Wolf } 8797eaa8fb5SKevin Wolf 8807eaa8fb5SKevin Wolf job_txn_apply(txn, job_transition_to_pending, false); 8817eaa8fb5SKevin Wolf 8827eaa8fb5SKevin Wolf /* If no jobs need manual finalization, automatically do so */ 8837eaa8fb5SKevin Wolf if (job_txn_apply(txn, job_needs_finalize, false) == 0) { 8847eaa8fb5SKevin Wolf job_do_finalize(job); 8857eaa8fb5SKevin Wolf } 8867eaa8fb5SKevin Wolf } 8877eaa8fb5SKevin Wolf 888*404ff28dSJohn Snow static void job_completed(Job *job) 8893d70ff53SKevin Wolf { 8903d70ff53SKevin Wolf assert(job && job->txn && !job_is_completed(job)); 8911266c9b9SKevin Wolf 8923d70ff53SKevin Wolf job_update_rc(job); 893*404ff28dSJohn Snow trace_job_completed(job, job->ret); 8943d70ff53SKevin Wolf if (job->ret) { 8953d70ff53SKevin Wolf job_completed_txn_abort(job); 8963d70ff53SKevin Wolf } else { 8973d70ff53SKevin Wolf job_completed_txn_success(job); 8983d70ff53SKevin Wolf } 8993d70ff53SKevin Wolf } 9003d70ff53SKevin Wolf 9013d70ff53SKevin Wolf void job_cancel(Job *job, bool force) 9023d70ff53SKevin Wolf { 9033d70ff53SKevin Wolf if (job->status == JOB_STATUS_CONCLUDED) { 9043d70ff53SKevin Wolf job_do_dismiss(job); 9053d70ff53SKevin Wolf return; 9063d70ff53SKevin Wolf } 9073d70ff53SKevin Wolf job_cancel_async(job, force); 9083d70ff53SKevin Wolf if (!job_started(job)) { 909*404ff28dSJohn Snow job_completed(job); 9103d70ff53SKevin Wolf } else if (job->deferred_to_main_loop) { 9113d70ff53SKevin Wolf job_completed_txn_abort(job); 9123d70ff53SKevin Wolf } else { 9133d70ff53SKevin Wolf job_enter(job); 9143d70ff53SKevin Wolf } 9153d70ff53SKevin Wolf } 9163d70ff53SKevin Wolf 9173d70ff53SKevin Wolf void job_user_cancel(Job *job, bool force, Error **errp) 9183d70ff53SKevin Wolf { 9193d70ff53SKevin Wolf if (job_apply_verb(job, JOB_VERB_CANCEL, errp)) { 9203d70ff53SKevin Wolf return; 9213d70ff53SKevin Wolf } 9223d70ff53SKevin Wolf job_cancel(job, force); 9233d70ff53SKevin Wolf } 9243d70ff53SKevin Wolf 9253d70ff53SKevin Wolf /* A wrapper around job_cancel() taking an Error ** parameter so it may be 9263d70ff53SKevin Wolf * used with job_finish_sync() without the need for (rather nasty) function 9273d70ff53SKevin Wolf * pointer casts there. */ 9283d70ff53SKevin Wolf static void job_cancel_err(Job *job, Error **errp) 9293d70ff53SKevin Wolf { 9303d70ff53SKevin Wolf job_cancel(job, false); 9313d70ff53SKevin Wolf } 9323d70ff53SKevin Wolf 9333d70ff53SKevin Wolf int job_cancel_sync(Job *job) 9343d70ff53SKevin Wolf { 9353d70ff53SKevin Wolf return job_finish_sync(job, &job_cancel_err, NULL); 9363d70ff53SKevin Wolf } 9373d70ff53SKevin Wolf 9383d70ff53SKevin Wolf void job_cancel_sync_all(void) 9393d70ff53SKevin Wolf { 9403d70ff53SKevin Wolf Job *job; 9413d70ff53SKevin Wolf AioContext *aio_context; 9423d70ff53SKevin Wolf 9433d70ff53SKevin Wolf while ((job = job_next(NULL))) { 9443d70ff53SKevin Wolf aio_context = job->aio_context; 9453d70ff53SKevin Wolf aio_context_acquire(aio_context); 9463d70ff53SKevin Wolf job_cancel_sync(job); 9473d70ff53SKevin Wolf aio_context_release(aio_context); 9483d70ff53SKevin Wolf } 9493d70ff53SKevin Wolf } 9503d70ff53SKevin Wolf 9513d70ff53SKevin Wolf int job_complete_sync(Job *job, Error **errp) 9523d70ff53SKevin Wolf { 9533d70ff53SKevin Wolf return job_finish_sync(job, job_complete, errp); 9543d70ff53SKevin Wolf } 9553d70ff53SKevin Wolf 9563453d972SKevin Wolf void job_complete(Job *job, Error **errp) 9573453d972SKevin Wolf { 9583453d972SKevin Wolf /* Should not be reachable via external interface for internal jobs */ 9593453d972SKevin Wolf assert(job->id); 9603453d972SKevin Wolf if (job_apply_verb(job, JOB_VERB_COMPLETE, errp)) { 9613453d972SKevin Wolf return; 9623453d972SKevin Wolf } 9633453d972SKevin Wolf if (job->pause_count || job_is_cancelled(job) || !job->driver->complete) { 9643453d972SKevin Wolf error_setg(errp, "The active block job '%s' cannot be completed", 9653453d972SKevin Wolf job->id); 9663453d972SKevin Wolf return; 9673453d972SKevin Wolf } 9683453d972SKevin Wolf 9693453d972SKevin Wolf job->driver->complete(job, errp); 9703453d972SKevin Wolf } 9713453d972SKevin Wolf 972b15de828SKevin Wolf 9731908a559SKevin Wolf typedef struct { 9741908a559SKevin Wolf Job *job; 9751908a559SKevin Wolf JobDeferToMainLoopFn *fn; 9761908a559SKevin Wolf void *opaque; 9771908a559SKevin Wolf } JobDeferToMainLoopData; 9781908a559SKevin Wolf 9791908a559SKevin Wolf static void job_defer_to_main_loop_bh(void *opaque) 9801908a559SKevin Wolf { 9811908a559SKevin Wolf JobDeferToMainLoopData *data = opaque; 9821908a559SKevin Wolf Job *job = data->job; 9831908a559SKevin Wolf AioContext *aio_context = job->aio_context; 9841908a559SKevin Wolf 9851908a559SKevin Wolf aio_context_acquire(aio_context); 9861908a559SKevin Wolf data->fn(data->job, data->opaque); 9871908a559SKevin Wolf aio_context_release(aio_context); 9881908a559SKevin Wolf 9891908a559SKevin Wolf g_free(data); 9901908a559SKevin Wolf } 9911908a559SKevin Wolf 9921908a559SKevin Wolf void job_defer_to_main_loop(Job *job, JobDeferToMainLoopFn *fn, void *opaque) 9931908a559SKevin Wolf { 9941908a559SKevin Wolf JobDeferToMainLoopData *data = g_malloc(sizeof(*data)); 9951908a559SKevin Wolf data->job = job; 9961908a559SKevin Wolf data->fn = fn; 9971908a559SKevin Wolf data->opaque = opaque; 9981908a559SKevin Wolf job->deferred_to_main_loop = true; 9991908a559SKevin Wolf 10001908a559SKevin Wolf aio_bh_schedule_oneshot(qemu_get_aio_context(), 10011908a559SKevin Wolf job_defer_to_main_loop_bh, data); 10021908a559SKevin Wolf } 10036a74c075SKevin Wolf 10046a74c075SKevin Wolf int job_finish_sync(Job *job, void (*finish)(Job *, Error **errp), Error **errp) 10056a74c075SKevin Wolf { 10066a74c075SKevin Wolf Error *local_err = NULL; 10076a74c075SKevin Wolf int ret; 10086a74c075SKevin Wolf 10096a74c075SKevin Wolf job_ref(job); 10106a74c075SKevin Wolf 10116a74c075SKevin Wolf if (finish) { 10126a74c075SKevin Wolf finish(job, &local_err); 10136a74c075SKevin Wolf } 10146a74c075SKevin Wolf if (local_err) { 10156a74c075SKevin Wolf error_propagate(errp, local_err); 10166a74c075SKevin Wolf job_unref(job); 10176a74c075SKevin Wolf return -EBUSY; 10186a74c075SKevin Wolf } 10196a74c075SKevin Wolf /* job_drain calls job_enter, and it should be enough to induce progress 10206a74c075SKevin Wolf * until the job completes or moves to the main thread. */ 10216a74c075SKevin Wolf while (!job->deferred_to_main_loop && !job_is_completed(job)) { 10226a74c075SKevin Wolf job_drain(job); 10236a74c075SKevin Wolf } 10246a74c075SKevin Wolf while (!job_is_completed(job)) { 10256a74c075SKevin Wolf aio_poll(qemu_get_aio_context(), true); 10266a74c075SKevin Wolf } 10276a74c075SKevin Wolf ret = (job_is_cancelled(job) && job->ret == 0) ? -ECANCELED : job->ret; 10286a74c075SKevin Wolf job_unref(job); 10296a74c075SKevin Wolf return ret; 10306a74c075SKevin Wolf } 1031