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" 3333e9e9bdSKevin Wolf 34e7c1d78bSKevin Wolf static QLIST_HEAD(, Job) jobs = QLIST_HEAD_INITIALIZER(jobs); 35e7c1d78bSKevin Wolf 36a50c2ab8SKevin Wolf /* Job State Transition Table */ 37a50c2ab8SKevin Wolf bool JobSTT[JOB_STATUS__MAX][JOB_STATUS__MAX] = { 38a50c2ab8SKevin Wolf /* U, C, R, P, Y, S, W, D, X, E, N */ 39a50c2ab8SKevin Wolf /* U: */ [JOB_STATUS_UNDEFINED] = {0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0}, 40a50c2ab8SKevin Wolf /* C: */ [JOB_STATUS_CREATED] = {0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 1}, 41a50c2ab8SKevin Wolf /* R: */ [JOB_STATUS_RUNNING] = {0, 0, 0, 1, 1, 0, 1, 0, 1, 0, 0}, 42a50c2ab8SKevin Wolf /* P: */ [JOB_STATUS_PAUSED] = {0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0}, 43a50c2ab8SKevin Wolf /* Y: */ [JOB_STATUS_READY] = {0, 0, 0, 0, 0, 1, 1, 0, 1, 0, 0}, 44a50c2ab8SKevin Wolf /* S: */ [JOB_STATUS_STANDBY] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0}, 45a50c2ab8SKevin Wolf /* W: */ [JOB_STATUS_WAITING] = {0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0}, 46a50c2ab8SKevin Wolf /* D: */ [JOB_STATUS_PENDING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, 47a50c2ab8SKevin Wolf /* X: */ [JOB_STATUS_ABORTING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, 48a50c2ab8SKevin Wolf /* E: */ [JOB_STATUS_CONCLUDED] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}, 49a50c2ab8SKevin Wolf /* N: */ [JOB_STATUS_NULL] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}, 50a50c2ab8SKevin Wolf }; 51a50c2ab8SKevin Wolf 52a50c2ab8SKevin Wolf bool JobVerbTable[JOB_VERB__MAX][JOB_STATUS__MAX] = { 53a50c2ab8SKevin Wolf /* U, C, R, P, Y, S, W, D, X, E, N */ 54a50c2ab8SKevin Wolf [JOB_VERB_CANCEL] = {0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0}, 55a50c2ab8SKevin Wolf [JOB_VERB_PAUSE] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 56a50c2ab8SKevin Wolf [JOB_VERB_RESUME] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 57a50c2ab8SKevin Wolf [JOB_VERB_SET_SPEED] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, 58a50c2ab8SKevin Wolf [JOB_VERB_COMPLETE] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0}, 59a50c2ab8SKevin Wolf [JOB_VERB_FINALIZE] = {0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0}, 60a50c2ab8SKevin Wolf [JOB_VERB_DISMISS] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0}, 61a50c2ab8SKevin Wolf }; 62a50c2ab8SKevin Wolf 637eaa8fb5SKevin Wolf /* Transactional group of jobs */ 647eaa8fb5SKevin Wolf struct JobTxn { 657eaa8fb5SKevin Wolf 667eaa8fb5SKevin Wolf /* Is this txn being cancelled? */ 677eaa8fb5SKevin Wolf bool aborting; 687eaa8fb5SKevin Wolf 697eaa8fb5SKevin Wolf /* List of jobs */ 707eaa8fb5SKevin Wolf QLIST_HEAD(, Job) jobs; 717eaa8fb5SKevin Wolf 727eaa8fb5SKevin Wolf /* Reference count */ 737eaa8fb5SKevin Wolf int refcnt; 747eaa8fb5SKevin Wolf }; 757eaa8fb5SKevin Wolf 76da01ff7fSKevin Wolf /* Right now, this mutex is only needed to synchronize accesses to job->busy 77da01ff7fSKevin Wolf * and job->sleep_timer, such as concurrent calls to job_do_yield and 78da01ff7fSKevin Wolf * job_enter. */ 79da01ff7fSKevin Wolf static QemuMutex job_mutex; 80da01ff7fSKevin Wolf 81da01ff7fSKevin Wolf static void job_lock(void) 82da01ff7fSKevin Wolf { 83da01ff7fSKevin Wolf qemu_mutex_lock(&job_mutex); 84da01ff7fSKevin Wolf } 85da01ff7fSKevin Wolf 86da01ff7fSKevin Wolf static void job_unlock(void) 87da01ff7fSKevin Wolf { 88da01ff7fSKevin Wolf qemu_mutex_unlock(&job_mutex); 89da01ff7fSKevin Wolf } 90da01ff7fSKevin Wolf 91da01ff7fSKevin Wolf static void __attribute__((__constructor__)) job_init(void) 92da01ff7fSKevin Wolf { 93da01ff7fSKevin Wolf qemu_mutex_init(&job_mutex); 94da01ff7fSKevin Wolf } 95da01ff7fSKevin Wolf 967eaa8fb5SKevin Wolf JobTxn *job_txn_new(void) 977eaa8fb5SKevin Wolf { 987eaa8fb5SKevin Wolf JobTxn *txn = g_new0(JobTxn, 1); 997eaa8fb5SKevin Wolf QLIST_INIT(&txn->jobs); 1007eaa8fb5SKevin Wolf txn->refcnt = 1; 1017eaa8fb5SKevin Wolf return txn; 1027eaa8fb5SKevin Wolf } 1037eaa8fb5SKevin Wolf 1047eaa8fb5SKevin Wolf static void job_txn_ref(JobTxn *txn) 1057eaa8fb5SKevin Wolf { 1067eaa8fb5SKevin Wolf txn->refcnt++; 1077eaa8fb5SKevin Wolf } 1087eaa8fb5SKevin Wolf 1097eaa8fb5SKevin Wolf void job_txn_unref(JobTxn *txn) 1107eaa8fb5SKevin Wolf { 1117eaa8fb5SKevin Wolf if (txn && --txn->refcnt == 0) { 1127eaa8fb5SKevin Wolf g_free(txn); 1137eaa8fb5SKevin Wolf } 1147eaa8fb5SKevin Wolf } 1157eaa8fb5SKevin Wolf 1167eaa8fb5SKevin Wolf void job_txn_add_job(JobTxn *txn, Job *job) 1177eaa8fb5SKevin Wolf { 1187eaa8fb5SKevin Wolf if (!txn) { 1197eaa8fb5SKevin Wolf return; 1207eaa8fb5SKevin Wolf } 1217eaa8fb5SKevin Wolf 1227eaa8fb5SKevin Wolf assert(!job->txn); 1237eaa8fb5SKevin Wolf job->txn = txn; 1247eaa8fb5SKevin Wolf 1257eaa8fb5SKevin Wolf QLIST_INSERT_HEAD(&txn->jobs, job, txn_list); 1267eaa8fb5SKevin Wolf job_txn_ref(txn); 1277eaa8fb5SKevin Wolf } 1287eaa8fb5SKevin Wolf 1297eaa8fb5SKevin Wolf static void job_txn_del_job(Job *job) 1307eaa8fb5SKevin Wolf { 1317eaa8fb5SKevin Wolf if (job->txn) { 1327eaa8fb5SKevin Wolf QLIST_REMOVE(job, txn_list); 1337eaa8fb5SKevin Wolf job_txn_unref(job->txn); 1347eaa8fb5SKevin Wolf job->txn = NULL; 1357eaa8fb5SKevin Wolf } 1367eaa8fb5SKevin Wolf } 1377eaa8fb5SKevin Wolf 1387eaa8fb5SKevin Wolf static int job_txn_apply(JobTxn *txn, int fn(Job *), bool lock) 1397eaa8fb5SKevin Wolf { 1407eaa8fb5SKevin Wolf AioContext *ctx; 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 if (lock) { 1467eaa8fb5SKevin Wolf ctx = job->aio_context; 1477eaa8fb5SKevin Wolf aio_context_acquire(ctx); 1487eaa8fb5SKevin Wolf } 1497eaa8fb5SKevin Wolf rc = fn(job); 1507eaa8fb5SKevin Wolf if (lock) { 1517eaa8fb5SKevin Wolf aio_context_release(ctx); 1527eaa8fb5SKevin Wolf } 1537eaa8fb5SKevin Wolf if (rc) { 1547eaa8fb5SKevin Wolf break; 1557eaa8fb5SKevin Wolf } 1567eaa8fb5SKevin Wolf } 1577eaa8fb5SKevin Wolf return rc; 1587eaa8fb5SKevin Wolf } 1597eaa8fb5SKevin Wolf 1602e1795b5SKevin Wolf static void job_state_transition(Job *job, JobStatus s1) 161a50c2ab8SKevin Wolf { 162a50c2ab8SKevin Wolf JobStatus s0 = job->status; 163a50c2ab8SKevin Wolf assert(s1 >= 0 && s1 <= JOB_STATUS__MAX); 1644ad35181SKevin Wolf trace_job_state_transition(job, job->ret, 165a50c2ab8SKevin Wolf JobSTT[s0][s1] ? "allowed" : "disallowed", 166a50c2ab8SKevin Wolf JobStatus_str(s0), JobStatus_str(s1)); 167a50c2ab8SKevin Wolf assert(JobSTT[s0][s1]); 168a50c2ab8SKevin Wolf job->status = s1; 169a50c2ab8SKevin Wolf } 170a50c2ab8SKevin Wolf 171a50c2ab8SKevin Wolf int job_apply_verb(Job *job, JobVerb verb, Error **errp) 172a50c2ab8SKevin Wolf { 173a50c2ab8SKevin Wolf JobStatus s0 = job->status; 174a50c2ab8SKevin Wolf assert(verb >= 0 && verb <= JOB_VERB__MAX); 175a50c2ab8SKevin Wolf trace_job_apply_verb(job, JobStatus_str(s0), JobVerb_str(verb), 176a50c2ab8SKevin Wolf JobVerbTable[verb][s0] ? "allowed" : "prohibited"); 177a50c2ab8SKevin Wolf if (JobVerbTable[verb][s0]) { 178a50c2ab8SKevin Wolf return 0; 179a50c2ab8SKevin Wolf } 180a50c2ab8SKevin Wolf error_setg(errp, "Job '%s' in state '%s' cannot accept command verb '%s'", 181a50c2ab8SKevin Wolf job->id, JobStatus_str(s0), JobVerb_str(verb)); 182a50c2ab8SKevin Wolf return -EPERM; 183a50c2ab8SKevin Wolf } 184a50c2ab8SKevin Wolf 185252291eaSKevin Wolf JobType job_type(const Job *job) 186252291eaSKevin Wolf { 187252291eaSKevin Wolf return job->driver->job_type; 188252291eaSKevin Wolf } 189252291eaSKevin Wolf 190252291eaSKevin Wolf const char *job_type_str(const Job *job) 191252291eaSKevin Wolf { 192252291eaSKevin Wolf return JobType_str(job_type(job)); 193252291eaSKevin Wolf } 194252291eaSKevin Wolf 195daa7f2f9SKevin Wolf bool job_is_cancelled(Job *job) 196daa7f2f9SKevin Wolf { 197daa7f2f9SKevin Wolf return job->cancelled; 198daa7f2f9SKevin Wolf } 199daa7f2f9SKevin Wolf 200df956ae2SKevin Wolf bool job_is_ready(Job *job) 201df956ae2SKevin Wolf { 202df956ae2SKevin Wolf switch (job->status) { 203df956ae2SKevin Wolf case JOB_STATUS_UNDEFINED: 204df956ae2SKevin Wolf case JOB_STATUS_CREATED: 205df956ae2SKevin Wolf case JOB_STATUS_RUNNING: 206df956ae2SKevin Wolf case JOB_STATUS_PAUSED: 207df956ae2SKevin Wolf case JOB_STATUS_WAITING: 208df956ae2SKevin Wolf case JOB_STATUS_PENDING: 209df956ae2SKevin Wolf case JOB_STATUS_ABORTING: 210df956ae2SKevin Wolf case JOB_STATUS_CONCLUDED: 211df956ae2SKevin Wolf case JOB_STATUS_NULL: 212df956ae2SKevin Wolf return false; 213df956ae2SKevin Wolf case JOB_STATUS_READY: 214df956ae2SKevin Wolf case JOB_STATUS_STANDBY: 215df956ae2SKevin Wolf return true; 216df956ae2SKevin Wolf default: 217df956ae2SKevin Wolf g_assert_not_reached(); 218df956ae2SKevin Wolf } 219df956ae2SKevin Wolf return false; 220df956ae2SKevin Wolf } 221df956ae2SKevin Wolf 222dbe5e6c1SKevin Wolf bool job_is_completed(Job *job) 223dbe5e6c1SKevin Wolf { 224dbe5e6c1SKevin Wolf switch (job->status) { 225dbe5e6c1SKevin Wolf case JOB_STATUS_UNDEFINED: 226dbe5e6c1SKevin Wolf case JOB_STATUS_CREATED: 227dbe5e6c1SKevin Wolf case JOB_STATUS_RUNNING: 228dbe5e6c1SKevin Wolf case JOB_STATUS_PAUSED: 229dbe5e6c1SKevin Wolf case JOB_STATUS_READY: 230dbe5e6c1SKevin Wolf case JOB_STATUS_STANDBY: 231dbe5e6c1SKevin Wolf return false; 232dbe5e6c1SKevin Wolf case JOB_STATUS_WAITING: 233dbe5e6c1SKevin Wolf case JOB_STATUS_PENDING: 234dbe5e6c1SKevin Wolf case JOB_STATUS_ABORTING: 235dbe5e6c1SKevin Wolf case JOB_STATUS_CONCLUDED: 236dbe5e6c1SKevin Wolf case JOB_STATUS_NULL: 237dbe5e6c1SKevin Wolf return true; 238dbe5e6c1SKevin Wolf default: 239dbe5e6c1SKevin Wolf g_assert_not_reached(); 240dbe5e6c1SKevin Wolf } 241dbe5e6c1SKevin Wolf return false; 242dbe5e6c1SKevin Wolf } 243dbe5e6c1SKevin Wolf 2443d70ff53SKevin Wolf static bool job_started(Job *job) 245da01ff7fSKevin Wolf { 246da01ff7fSKevin Wolf return job->co; 247da01ff7fSKevin Wolf } 248da01ff7fSKevin Wolf 249198c49ccSKevin Wolf static bool job_should_pause(Job *job) 250da01ff7fSKevin Wolf { 251da01ff7fSKevin Wolf return job->pause_count > 0; 252da01ff7fSKevin Wolf } 253da01ff7fSKevin Wolf 254e7c1d78bSKevin Wolf Job *job_next(Job *job) 255e7c1d78bSKevin Wolf { 256e7c1d78bSKevin Wolf if (!job) { 257e7c1d78bSKevin Wolf return QLIST_FIRST(&jobs); 258e7c1d78bSKevin Wolf } 259e7c1d78bSKevin Wolf return QLIST_NEXT(job, job_list); 260e7c1d78bSKevin Wolf } 261e7c1d78bSKevin Wolf 262e7c1d78bSKevin Wolf Job *job_get(const char *id) 263e7c1d78bSKevin Wolf { 264e7c1d78bSKevin Wolf Job *job; 265e7c1d78bSKevin Wolf 266e7c1d78bSKevin Wolf QLIST_FOREACH(job, &jobs, job_list) { 267e7c1d78bSKevin Wolf if (job->id && !strcmp(id, job->id)) { 268e7c1d78bSKevin Wolf return job; 269e7c1d78bSKevin Wolf } 270e7c1d78bSKevin Wolf } 271e7c1d78bSKevin Wolf 272e7c1d78bSKevin Wolf return NULL; 273e7c1d78bSKevin Wolf } 274e7c1d78bSKevin Wolf 2755d43e86eSKevin Wolf static void job_sleep_timer_cb(void *opaque) 2765d43e86eSKevin Wolf { 2775d43e86eSKevin Wolf Job *job = opaque; 2785d43e86eSKevin Wolf 2795d43e86eSKevin Wolf job_enter(job); 2805d43e86eSKevin Wolf } 2815d43e86eSKevin Wolf 2827eaa8fb5SKevin Wolf void *job_create(const char *job_id, const JobDriver *driver, JobTxn *txn, 2837eaa8fb5SKevin Wolf AioContext *ctx, int flags, BlockCompletionFunc *cb, 2847eaa8fb5SKevin Wolf void *opaque, Error **errp) 28533e9e9bdSKevin Wolf { 28633e9e9bdSKevin Wolf Job *job; 28733e9e9bdSKevin Wolf 28833e9e9bdSKevin Wolf if (job_id) { 289bb02b65cSKevin Wolf if (flags & JOB_INTERNAL) { 290bb02b65cSKevin Wolf error_setg(errp, "Cannot specify job ID for internal job"); 291bb02b65cSKevin Wolf return NULL; 292bb02b65cSKevin Wolf } 29333e9e9bdSKevin Wolf if (!id_wellformed(job_id)) { 29433e9e9bdSKevin Wolf error_setg(errp, "Invalid job ID '%s'", job_id); 29533e9e9bdSKevin Wolf return NULL; 29633e9e9bdSKevin Wolf } 297e7c1d78bSKevin Wolf if (job_get(job_id)) { 298e7c1d78bSKevin Wolf error_setg(errp, "Job ID '%s' already in use", job_id); 299e7c1d78bSKevin Wolf return NULL; 300e7c1d78bSKevin Wolf } 301bb02b65cSKevin Wolf } else if (!(flags & JOB_INTERNAL)) { 302bb02b65cSKevin Wolf error_setg(errp, "An explicit job ID is required"); 303bb02b65cSKevin Wolf return NULL; 30433e9e9bdSKevin Wolf } 30533e9e9bdSKevin Wolf 30633e9e9bdSKevin Wolf job = g_malloc0(driver->instance_size); 30733e9e9bdSKevin Wolf job->driver = driver; 30833e9e9bdSKevin Wolf job->id = g_strdup(job_id); 30980fa2c75SKevin Wolf job->refcnt = 1; 31008be6fe2SKevin Wolf job->aio_context = ctx; 311da01ff7fSKevin Wolf job->busy = false; 312da01ff7fSKevin Wolf job->paused = true; 313da01ff7fSKevin Wolf job->pause_count = 1; 314bb02b65cSKevin Wolf job->auto_finalize = !(flags & JOB_MANUAL_FINALIZE); 315bb02b65cSKevin Wolf job->auto_dismiss = !(flags & JOB_MANUAL_DISMISS); 3164ad35181SKevin Wolf job->cb = cb; 3174ad35181SKevin Wolf job->opaque = opaque; 31833e9e9bdSKevin Wolf 319139a9f02SKevin Wolf notifier_list_init(&job->on_finalize_cancelled); 320139a9f02SKevin Wolf notifier_list_init(&job->on_finalize_completed); 321139a9f02SKevin Wolf notifier_list_init(&job->on_pending); 3222e1795b5SKevin Wolf notifier_list_init(&job->on_ready); 323139a9f02SKevin Wolf 324a50c2ab8SKevin Wolf job_state_transition(job, JOB_STATUS_CREATED); 3255d43e86eSKevin Wolf aio_timer_init(qemu_get_aio_context(), &job->sleep_timer, 3265d43e86eSKevin Wolf QEMU_CLOCK_REALTIME, SCALE_NS, 3275d43e86eSKevin Wolf job_sleep_timer_cb, job); 328a50c2ab8SKevin Wolf 329e7c1d78bSKevin Wolf QLIST_INSERT_HEAD(&jobs, job, job_list); 330e7c1d78bSKevin Wolf 3317eaa8fb5SKevin Wolf /* Single jobs are modeled as single-job transactions for sake of 3327eaa8fb5SKevin Wolf * consolidating the job management logic */ 3337eaa8fb5SKevin Wolf if (!txn) { 3347eaa8fb5SKevin Wolf txn = job_txn_new(); 3357eaa8fb5SKevin Wolf job_txn_add_job(txn, job); 3367eaa8fb5SKevin Wolf job_txn_unref(txn); 3377eaa8fb5SKevin Wolf } else { 3387eaa8fb5SKevin Wolf job_txn_add_job(txn, job); 3397eaa8fb5SKevin Wolf } 3407eaa8fb5SKevin Wolf 34133e9e9bdSKevin Wolf return job; 34233e9e9bdSKevin Wolf } 343fd61a701SKevin Wolf 34480fa2c75SKevin Wolf void job_ref(Job *job) 345fd61a701SKevin Wolf { 34680fa2c75SKevin Wolf ++job->refcnt; 34780fa2c75SKevin Wolf } 34880fa2c75SKevin Wolf 34980fa2c75SKevin Wolf void job_unref(Job *job) 35080fa2c75SKevin Wolf { 35180fa2c75SKevin Wolf if (--job->refcnt == 0) { 35280fa2c75SKevin Wolf assert(job->status == JOB_STATUS_NULL); 3535d43e86eSKevin Wolf assert(!timer_pending(&job->sleep_timer)); 3547eaa8fb5SKevin Wolf assert(!job->txn); 35580fa2c75SKevin Wolf 35680fa2c75SKevin Wolf if (job->driver->free) { 35780fa2c75SKevin Wolf job->driver->free(job); 35880fa2c75SKevin Wolf } 35980fa2c75SKevin Wolf 360e7c1d78bSKevin Wolf QLIST_REMOVE(job, job_list); 361e7c1d78bSKevin Wolf 362fd61a701SKevin Wolf g_free(job->id); 363fd61a701SKevin Wolf g_free(job); 364fd61a701SKevin Wolf } 36580fa2c75SKevin Wolf } 3661908a559SKevin Wolf 367*30a5c887SKevin Wolf void job_progress_update(Job *job, uint64_t done) 368*30a5c887SKevin Wolf { 369*30a5c887SKevin Wolf job->progress_current += done; 370*30a5c887SKevin Wolf } 371*30a5c887SKevin Wolf 372*30a5c887SKevin Wolf void job_progress_set_remaining(Job *job, uint64_t remaining) 373*30a5c887SKevin Wolf { 374*30a5c887SKevin Wolf job->progress_total = job->progress_current + remaining; 375*30a5c887SKevin Wolf } 376*30a5c887SKevin Wolf 377139a9f02SKevin Wolf void job_event_cancelled(Job *job) 378139a9f02SKevin Wolf { 379139a9f02SKevin Wolf notifier_list_notify(&job->on_finalize_cancelled, job); 380139a9f02SKevin Wolf } 381139a9f02SKevin Wolf 382139a9f02SKevin Wolf void job_event_completed(Job *job) 383139a9f02SKevin Wolf { 384139a9f02SKevin Wolf notifier_list_notify(&job->on_finalize_completed, job); 385139a9f02SKevin Wolf } 386139a9f02SKevin Wolf 3877eaa8fb5SKevin Wolf static void job_event_pending(Job *job) 388139a9f02SKevin Wolf { 389139a9f02SKevin Wolf notifier_list_notify(&job->on_pending, job); 390139a9f02SKevin Wolf } 391139a9f02SKevin Wolf 3922e1795b5SKevin Wolf static void job_event_ready(Job *job) 3932e1795b5SKevin Wolf { 3942e1795b5SKevin Wolf notifier_list_notify(&job->on_ready, job); 3952e1795b5SKevin Wolf } 3962e1795b5SKevin Wolf 397da01ff7fSKevin Wolf void job_enter_cond(Job *job, bool(*fn)(Job *job)) 398da01ff7fSKevin Wolf { 399da01ff7fSKevin Wolf if (!job_started(job)) { 400da01ff7fSKevin Wolf return; 401da01ff7fSKevin Wolf } 402da01ff7fSKevin Wolf if (job->deferred_to_main_loop) { 403da01ff7fSKevin Wolf return; 404da01ff7fSKevin Wolf } 405da01ff7fSKevin Wolf 406da01ff7fSKevin Wolf job_lock(); 407da01ff7fSKevin Wolf if (job->busy) { 408da01ff7fSKevin Wolf job_unlock(); 409da01ff7fSKevin Wolf return; 410da01ff7fSKevin Wolf } 411da01ff7fSKevin Wolf 412da01ff7fSKevin Wolf if (fn && !fn(job)) { 413da01ff7fSKevin Wolf job_unlock(); 414da01ff7fSKevin Wolf return; 415da01ff7fSKevin Wolf } 416da01ff7fSKevin Wolf 417da01ff7fSKevin Wolf assert(!job->deferred_to_main_loop); 418da01ff7fSKevin Wolf timer_del(&job->sleep_timer); 419da01ff7fSKevin Wolf job->busy = true; 420da01ff7fSKevin Wolf job_unlock(); 421da01ff7fSKevin Wolf aio_co_wake(job->co); 422da01ff7fSKevin Wolf } 423da01ff7fSKevin Wolf 4245d43e86eSKevin Wolf void job_enter(Job *job) 4255d43e86eSKevin Wolf { 4265d43e86eSKevin Wolf job_enter_cond(job, NULL); 4275d43e86eSKevin Wolf } 4285d43e86eSKevin Wolf 429da01ff7fSKevin Wolf /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds. 4303d70ff53SKevin Wolf * Reentering the job coroutine with job_enter() before the timer has expired 4313d70ff53SKevin Wolf * is allowed and cancels the timer. 432da01ff7fSKevin Wolf * 4333d70ff53SKevin Wolf * If @ns is (uint64_t) -1, no timer is scheduled and job_enter() must be 434da01ff7fSKevin Wolf * called explicitly. */ 435198c49ccSKevin Wolf static void coroutine_fn job_do_yield(Job *job, uint64_t ns) 436da01ff7fSKevin Wolf { 437da01ff7fSKevin Wolf job_lock(); 438da01ff7fSKevin Wolf if (ns != -1) { 439da01ff7fSKevin Wolf timer_mod(&job->sleep_timer, ns); 440da01ff7fSKevin Wolf } 441da01ff7fSKevin Wolf job->busy = false; 442da01ff7fSKevin Wolf job_unlock(); 443da01ff7fSKevin Wolf qemu_coroutine_yield(); 444da01ff7fSKevin Wolf 445da01ff7fSKevin Wolf /* Set by job_enter_cond() before re-entering the coroutine. */ 446da01ff7fSKevin Wolf assert(job->busy); 447da01ff7fSKevin Wolf } 448da01ff7fSKevin Wolf 449da01ff7fSKevin Wolf void coroutine_fn job_pause_point(Job *job) 450da01ff7fSKevin Wolf { 451da01ff7fSKevin Wolf assert(job && job_started(job)); 452da01ff7fSKevin Wolf 453da01ff7fSKevin Wolf if (!job_should_pause(job)) { 454da01ff7fSKevin Wolf return; 455da01ff7fSKevin Wolf } 456da01ff7fSKevin Wolf if (job_is_cancelled(job)) { 457da01ff7fSKevin Wolf return; 458da01ff7fSKevin Wolf } 459da01ff7fSKevin Wolf 460da01ff7fSKevin Wolf if (job->driver->pause) { 461da01ff7fSKevin Wolf job->driver->pause(job); 462da01ff7fSKevin Wolf } 463da01ff7fSKevin Wolf 464da01ff7fSKevin Wolf if (job_should_pause(job) && !job_is_cancelled(job)) { 465da01ff7fSKevin Wolf JobStatus status = job->status; 466da01ff7fSKevin Wolf job_state_transition(job, status == JOB_STATUS_READY 467da01ff7fSKevin Wolf ? JOB_STATUS_STANDBY 468da01ff7fSKevin Wolf : JOB_STATUS_PAUSED); 469da01ff7fSKevin Wolf job->paused = true; 470da01ff7fSKevin Wolf job_do_yield(job, -1); 471da01ff7fSKevin Wolf job->paused = false; 472da01ff7fSKevin Wolf job_state_transition(job, status); 473da01ff7fSKevin Wolf } 474da01ff7fSKevin Wolf 475da01ff7fSKevin Wolf if (job->driver->resume) { 476da01ff7fSKevin Wolf job->driver->resume(job); 477da01ff7fSKevin Wolf } 478da01ff7fSKevin Wolf } 479da01ff7fSKevin Wolf 480198c49ccSKevin Wolf void job_yield(Job *job) 481198c49ccSKevin Wolf { 482198c49ccSKevin Wolf assert(job->busy); 483198c49ccSKevin Wolf 484198c49ccSKevin Wolf /* Check cancellation *before* setting busy = false, too! */ 485198c49ccSKevin Wolf if (job_is_cancelled(job)) { 486198c49ccSKevin Wolf return; 487198c49ccSKevin Wolf } 488198c49ccSKevin Wolf 489198c49ccSKevin Wolf if (!job_should_pause(job)) { 490198c49ccSKevin Wolf job_do_yield(job, -1); 491198c49ccSKevin Wolf } 492198c49ccSKevin Wolf 493198c49ccSKevin Wolf job_pause_point(job); 494198c49ccSKevin Wolf } 495198c49ccSKevin Wolf 4965d43e86eSKevin Wolf void coroutine_fn job_sleep_ns(Job *job, int64_t ns) 4975d43e86eSKevin Wolf { 4985d43e86eSKevin Wolf assert(job->busy); 4995d43e86eSKevin Wolf 5005d43e86eSKevin Wolf /* Check cancellation *before* setting busy = false, too! */ 5015d43e86eSKevin Wolf if (job_is_cancelled(job)) { 5025d43e86eSKevin Wolf return; 5035d43e86eSKevin Wolf } 5045d43e86eSKevin Wolf 5055d43e86eSKevin Wolf if (!job_should_pause(job)) { 5065d43e86eSKevin Wolf job_do_yield(job, qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + ns); 5075d43e86eSKevin Wolf } 5085d43e86eSKevin Wolf 5095d43e86eSKevin Wolf job_pause_point(job); 5105d43e86eSKevin Wolf } 5115d43e86eSKevin Wolf 512b69f777dSKevin Wolf void job_drain(Job *job) 513b69f777dSKevin Wolf { 514b69f777dSKevin Wolf /* If job is !busy this kicks it into the next pause point. */ 515b69f777dSKevin Wolf job_enter(job); 516b69f777dSKevin Wolf 517b69f777dSKevin Wolf if (job->driver->drain) { 518b69f777dSKevin Wolf job->driver->drain(job); 519b69f777dSKevin Wolf } 520b69f777dSKevin Wolf } 521b69f777dSKevin Wolf 522b69f777dSKevin Wolf 523da01ff7fSKevin Wolf /** 524da01ff7fSKevin Wolf * All jobs must allow a pause point before entering their job proper. This 525da01ff7fSKevin Wolf * ensures that jobs can be paused prior to being started, then resumed later. 526da01ff7fSKevin Wolf */ 527da01ff7fSKevin Wolf static void coroutine_fn job_co_entry(void *opaque) 528da01ff7fSKevin Wolf { 529da01ff7fSKevin Wolf Job *job = opaque; 530da01ff7fSKevin Wolf 531da01ff7fSKevin Wolf assert(job && job->driver && job->driver->start); 532da01ff7fSKevin Wolf job_pause_point(job); 533da01ff7fSKevin Wolf job->driver->start(job); 534da01ff7fSKevin Wolf } 535da01ff7fSKevin Wolf 536da01ff7fSKevin Wolf 537da01ff7fSKevin Wolf void job_start(Job *job) 538da01ff7fSKevin Wolf { 539da01ff7fSKevin Wolf assert(job && !job_started(job) && job->paused && 540da01ff7fSKevin Wolf job->driver && job->driver->start); 541da01ff7fSKevin Wolf job->co = qemu_coroutine_create(job_co_entry, job); 542da01ff7fSKevin Wolf job->pause_count--; 543da01ff7fSKevin Wolf job->busy = true; 544da01ff7fSKevin Wolf job->paused = false; 545da01ff7fSKevin Wolf job_state_transition(job, JOB_STATUS_RUNNING); 546da01ff7fSKevin Wolf aio_co_enter(job->aio_context, job->co); 547da01ff7fSKevin Wolf } 548da01ff7fSKevin Wolf 549b15de828SKevin Wolf /* Assumes the block_job_mutex is held */ 550b15de828SKevin Wolf static bool job_timer_not_pending(Job *job) 551b15de828SKevin Wolf { 552b15de828SKevin Wolf return !timer_pending(&job->sleep_timer); 553b15de828SKevin Wolf } 554b15de828SKevin Wolf 555b15de828SKevin Wolf void job_pause(Job *job) 556b15de828SKevin Wolf { 557b15de828SKevin Wolf job->pause_count++; 558b15de828SKevin Wolf } 559b15de828SKevin Wolf 560b15de828SKevin Wolf void job_resume(Job *job) 561b15de828SKevin Wolf { 562b15de828SKevin Wolf assert(job->pause_count > 0); 563b15de828SKevin Wolf job->pause_count--; 564b15de828SKevin Wolf if (job->pause_count) { 565b15de828SKevin Wolf return; 566b15de828SKevin Wolf } 567b15de828SKevin Wolf 568b15de828SKevin Wolf /* kick only if no timer is pending */ 569b15de828SKevin Wolf job_enter_cond(job, job_timer_not_pending); 570b15de828SKevin Wolf } 571b15de828SKevin Wolf 572b15de828SKevin Wolf void job_user_pause(Job *job, Error **errp) 573b15de828SKevin Wolf { 574b15de828SKevin Wolf if (job_apply_verb(job, JOB_VERB_PAUSE, errp)) { 575b15de828SKevin Wolf return; 576b15de828SKevin Wolf } 577b15de828SKevin Wolf if (job->user_paused) { 578b15de828SKevin Wolf error_setg(errp, "Job is already paused"); 579b15de828SKevin Wolf return; 580b15de828SKevin Wolf } 581b15de828SKevin Wolf job->user_paused = true; 582b15de828SKevin Wolf job_pause(job); 583b15de828SKevin Wolf } 584b15de828SKevin Wolf 585b15de828SKevin Wolf bool job_user_paused(Job *job) 586b15de828SKevin Wolf { 587b15de828SKevin Wolf return job->user_paused; 588b15de828SKevin Wolf } 589b15de828SKevin Wolf 590b15de828SKevin Wolf void job_user_resume(Job *job, Error **errp) 591b15de828SKevin Wolf { 592b15de828SKevin Wolf assert(job); 593b15de828SKevin Wolf if (!job->user_paused || job->pause_count <= 0) { 594b15de828SKevin Wolf error_setg(errp, "Can't resume a job that was not paused"); 595b15de828SKevin Wolf return; 596b15de828SKevin Wolf } 597b15de828SKevin Wolf if (job_apply_verb(job, JOB_VERB_RESUME, errp)) { 598b15de828SKevin Wolf return; 599b15de828SKevin Wolf } 600b15de828SKevin Wolf if (job->driver->user_resume) { 601b15de828SKevin Wolf job->driver->user_resume(job); 602b15de828SKevin Wolf } 603b15de828SKevin Wolf job->user_paused = false; 604b15de828SKevin Wolf job_resume(job); 605b15de828SKevin Wolf } 606b15de828SKevin Wolf 6075f9a6a08SKevin Wolf static void job_do_dismiss(Job *job) 6084ad35181SKevin Wolf { 6094ad35181SKevin Wolf assert(job); 6104ad35181SKevin Wolf job->busy = false; 6114ad35181SKevin Wolf job->paused = false; 6124ad35181SKevin Wolf job->deferred_to_main_loop = true; 6134ad35181SKevin Wolf 6147eaa8fb5SKevin Wolf job_txn_del_job(job); 6154ad35181SKevin Wolf 6164ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_NULL); 6174ad35181SKevin Wolf job_unref(job); 6184ad35181SKevin Wolf } 6194ad35181SKevin Wolf 6205f9a6a08SKevin Wolf void job_dismiss(Job **jobptr, Error **errp) 6215f9a6a08SKevin Wolf { 6225f9a6a08SKevin Wolf Job *job = *jobptr; 6235f9a6a08SKevin Wolf /* similarly to _complete, this is QMP-interface only. */ 6245f9a6a08SKevin Wolf assert(job->id); 6255f9a6a08SKevin Wolf if (job_apply_verb(job, JOB_VERB_DISMISS, errp)) { 6265f9a6a08SKevin Wolf return; 6275f9a6a08SKevin Wolf } 6285f9a6a08SKevin Wolf 6295f9a6a08SKevin Wolf job_do_dismiss(job); 6305f9a6a08SKevin Wolf *jobptr = NULL; 6315f9a6a08SKevin Wolf } 6325f9a6a08SKevin Wolf 6334ad35181SKevin Wolf void job_early_fail(Job *job) 6344ad35181SKevin Wolf { 6354ad35181SKevin Wolf assert(job->status == JOB_STATUS_CREATED); 6364ad35181SKevin Wolf job_do_dismiss(job); 6374ad35181SKevin Wolf } 6384ad35181SKevin Wolf 6394ad35181SKevin Wolf static void job_conclude(Job *job) 6404ad35181SKevin Wolf { 6414ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_CONCLUDED); 6424ad35181SKevin Wolf if (job->auto_dismiss || !job_started(job)) { 6434ad35181SKevin Wolf job_do_dismiss(job); 6444ad35181SKevin Wolf } 6454ad35181SKevin Wolf } 6464ad35181SKevin Wolf 6473d70ff53SKevin Wolf static void job_update_rc(Job *job) 6484ad35181SKevin Wolf { 6494ad35181SKevin Wolf if (!job->ret && job_is_cancelled(job)) { 6504ad35181SKevin Wolf job->ret = -ECANCELED; 6514ad35181SKevin Wolf } 6524ad35181SKevin Wolf if (job->ret) { 6534ad35181SKevin Wolf job_state_transition(job, JOB_STATUS_ABORTING); 6544ad35181SKevin Wolf } 6554ad35181SKevin Wolf } 6564ad35181SKevin Wolf 6574ad35181SKevin Wolf static void job_commit(Job *job) 6584ad35181SKevin Wolf { 6594ad35181SKevin Wolf assert(!job->ret); 6604ad35181SKevin Wolf if (job->driver->commit) { 6614ad35181SKevin Wolf job->driver->commit(job); 6624ad35181SKevin Wolf } 6634ad35181SKevin Wolf } 6644ad35181SKevin Wolf 6654ad35181SKevin Wolf static void job_abort(Job *job) 6664ad35181SKevin Wolf { 6674ad35181SKevin Wolf assert(job->ret); 6684ad35181SKevin Wolf if (job->driver->abort) { 6694ad35181SKevin Wolf job->driver->abort(job); 6704ad35181SKevin Wolf } 6714ad35181SKevin Wolf } 6724ad35181SKevin Wolf 6734ad35181SKevin Wolf static void job_clean(Job *job) 6744ad35181SKevin Wolf { 6754ad35181SKevin Wolf if (job->driver->clean) { 6764ad35181SKevin Wolf job->driver->clean(job); 6774ad35181SKevin Wolf } 6784ad35181SKevin Wolf } 6794ad35181SKevin Wolf 6807eaa8fb5SKevin Wolf static int job_finalize_single(Job *job) 6814ad35181SKevin Wolf { 6824ad35181SKevin Wolf assert(job_is_completed(job)); 6834ad35181SKevin Wolf 6844ad35181SKevin Wolf /* Ensure abort is called for late-transactional failures */ 6854ad35181SKevin Wolf job_update_rc(job); 6864ad35181SKevin Wolf 6874ad35181SKevin Wolf if (!job->ret) { 6884ad35181SKevin Wolf job_commit(job); 6894ad35181SKevin Wolf } else { 6904ad35181SKevin Wolf job_abort(job); 6914ad35181SKevin Wolf } 6924ad35181SKevin Wolf job_clean(job); 6934ad35181SKevin Wolf 6944ad35181SKevin Wolf if (job->cb) { 6954ad35181SKevin Wolf job->cb(job->opaque, job->ret); 6964ad35181SKevin Wolf } 6974ad35181SKevin Wolf 6984ad35181SKevin Wolf /* Emit events only if we actually started */ 6994ad35181SKevin Wolf if (job_started(job)) { 7004ad35181SKevin Wolf if (job_is_cancelled(job)) { 7014ad35181SKevin Wolf job_event_cancelled(job); 7024ad35181SKevin Wolf } else { 7034ad35181SKevin Wolf job_event_completed(job); 7044ad35181SKevin Wolf } 7054ad35181SKevin Wolf } 7064ad35181SKevin Wolf 7077eaa8fb5SKevin Wolf job_txn_del_job(job); 7084ad35181SKevin Wolf job_conclude(job); 7094ad35181SKevin Wolf return 0; 7104ad35181SKevin Wolf } 7114ad35181SKevin Wolf 7123d70ff53SKevin Wolf static void job_cancel_async(Job *job, bool force) 7137eaa8fb5SKevin Wolf { 7147eaa8fb5SKevin Wolf if (job->user_paused) { 7157eaa8fb5SKevin Wolf /* Do not call job_enter here, the caller will handle it. */ 7167eaa8fb5SKevin Wolf job->user_paused = false; 7177eaa8fb5SKevin Wolf if (job->driver->user_resume) { 7187eaa8fb5SKevin Wolf job->driver->user_resume(job); 7197eaa8fb5SKevin Wolf } 7207eaa8fb5SKevin Wolf assert(job->pause_count > 0); 7217eaa8fb5SKevin Wolf job->pause_count--; 7227eaa8fb5SKevin Wolf } 7237eaa8fb5SKevin Wolf job->cancelled = true; 7247eaa8fb5SKevin Wolf /* To prevent 'force == false' overriding a previous 'force == true' */ 7257eaa8fb5SKevin Wolf job->force_cancel |= force; 7267eaa8fb5SKevin Wolf } 7277eaa8fb5SKevin Wolf 7283d70ff53SKevin Wolf static void job_completed_txn_abort(Job *job) 7297eaa8fb5SKevin Wolf { 7307eaa8fb5SKevin Wolf AioContext *ctx; 7317eaa8fb5SKevin Wolf JobTxn *txn = job->txn; 7327eaa8fb5SKevin Wolf Job *other_job; 7337eaa8fb5SKevin Wolf 7347eaa8fb5SKevin Wolf if (txn->aborting) { 7357eaa8fb5SKevin Wolf /* 7367eaa8fb5SKevin Wolf * We are cancelled by another job, which will handle everything. 7377eaa8fb5SKevin Wolf */ 7387eaa8fb5SKevin Wolf return; 7397eaa8fb5SKevin Wolf } 7407eaa8fb5SKevin Wolf txn->aborting = true; 7417eaa8fb5SKevin Wolf job_txn_ref(txn); 7427eaa8fb5SKevin Wolf 7437eaa8fb5SKevin Wolf /* We are the first failed job. Cancel other jobs. */ 7447eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 7457eaa8fb5SKevin Wolf ctx = other_job->aio_context; 7467eaa8fb5SKevin Wolf aio_context_acquire(ctx); 7477eaa8fb5SKevin Wolf } 7487eaa8fb5SKevin Wolf 7497eaa8fb5SKevin Wolf /* Other jobs are effectively cancelled by us, set the status for 7507eaa8fb5SKevin Wolf * them; this job, however, may or may not be cancelled, depending 7517eaa8fb5SKevin Wolf * on the caller, so leave it. */ 7527eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 7537eaa8fb5SKevin Wolf if (other_job != job) { 7547eaa8fb5SKevin Wolf job_cancel_async(other_job, false); 7557eaa8fb5SKevin Wolf } 7567eaa8fb5SKevin Wolf } 7577eaa8fb5SKevin Wolf while (!QLIST_EMPTY(&txn->jobs)) { 7587eaa8fb5SKevin Wolf other_job = QLIST_FIRST(&txn->jobs); 7597eaa8fb5SKevin Wolf ctx = other_job->aio_context; 7607eaa8fb5SKevin Wolf if (!job_is_completed(other_job)) { 7617eaa8fb5SKevin Wolf assert(job_is_cancelled(other_job)); 7627eaa8fb5SKevin Wolf job_finish_sync(other_job, NULL, NULL); 7637eaa8fb5SKevin Wolf } 7647eaa8fb5SKevin Wolf job_finalize_single(other_job); 7657eaa8fb5SKevin Wolf aio_context_release(ctx); 7667eaa8fb5SKevin Wolf } 7677eaa8fb5SKevin Wolf 7687eaa8fb5SKevin Wolf job_txn_unref(txn); 7697eaa8fb5SKevin Wolf } 7707eaa8fb5SKevin Wolf 7717eaa8fb5SKevin Wolf static int job_prepare(Job *job) 7727eaa8fb5SKevin Wolf { 7737eaa8fb5SKevin Wolf if (job->ret == 0 && job->driver->prepare) { 7747eaa8fb5SKevin Wolf job->ret = job->driver->prepare(job); 7757eaa8fb5SKevin Wolf } 7767eaa8fb5SKevin Wolf return job->ret; 7777eaa8fb5SKevin Wolf } 7787eaa8fb5SKevin Wolf 7797eaa8fb5SKevin Wolf static int job_needs_finalize(Job *job) 7807eaa8fb5SKevin Wolf { 7817eaa8fb5SKevin Wolf return !job->auto_finalize; 7827eaa8fb5SKevin Wolf } 7837eaa8fb5SKevin Wolf 7847eaa8fb5SKevin Wolf static void job_do_finalize(Job *job) 7857eaa8fb5SKevin Wolf { 7867eaa8fb5SKevin Wolf int rc; 7877eaa8fb5SKevin Wolf assert(job && job->txn); 7887eaa8fb5SKevin Wolf 7897eaa8fb5SKevin Wolf /* prepare the transaction to complete */ 7907eaa8fb5SKevin Wolf rc = job_txn_apply(job->txn, job_prepare, true); 7917eaa8fb5SKevin Wolf if (rc) { 7927eaa8fb5SKevin Wolf job_completed_txn_abort(job); 7937eaa8fb5SKevin Wolf } else { 7947eaa8fb5SKevin Wolf job_txn_apply(job->txn, job_finalize_single, true); 7957eaa8fb5SKevin Wolf } 7967eaa8fb5SKevin Wolf } 7977eaa8fb5SKevin Wolf 7987eaa8fb5SKevin Wolf void job_finalize(Job *job, Error **errp) 7997eaa8fb5SKevin Wolf { 8007eaa8fb5SKevin Wolf assert(job && job->id); 8017eaa8fb5SKevin Wolf if (job_apply_verb(job, JOB_VERB_FINALIZE, errp)) { 8027eaa8fb5SKevin Wolf return; 8037eaa8fb5SKevin Wolf } 8047eaa8fb5SKevin Wolf job_do_finalize(job); 8057eaa8fb5SKevin Wolf } 8067eaa8fb5SKevin Wolf 8077eaa8fb5SKevin Wolf static int job_transition_to_pending(Job *job) 8087eaa8fb5SKevin Wolf { 8097eaa8fb5SKevin Wolf job_state_transition(job, JOB_STATUS_PENDING); 8107eaa8fb5SKevin Wolf if (!job->auto_finalize) { 8117eaa8fb5SKevin Wolf job_event_pending(job); 8127eaa8fb5SKevin Wolf } 8137eaa8fb5SKevin Wolf return 0; 8147eaa8fb5SKevin Wolf } 8157eaa8fb5SKevin Wolf 8162e1795b5SKevin Wolf void job_transition_to_ready(Job *job) 8172e1795b5SKevin Wolf { 8182e1795b5SKevin Wolf job_state_transition(job, JOB_STATUS_READY); 8192e1795b5SKevin Wolf job_event_ready(job); 8202e1795b5SKevin Wolf } 8212e1795b5SKevin Wolf 8223d70ff53SKevin Wolf static void job_completed_txn_success(Job *job) 8237eaa8fb5SKevin Wolf { 8247eaa8fb5SKevin Wolf JobTxn *txn = job->txn; 8257eaa8fb5SKevin Wolf Job *other_job; 8267eaa8fb5SKevin Wolf 8277eaa8fb5SKevin Wolf job_state_transition(job, JOB_STATUS_WAITING); 8287eaa8fb5SKevin Wolf 8297eaa8fb5SKevin Wolf /* 8307eaa8fb5SKevin Wolf * Successful completion, see if there are other running jobs in this 8317eaa8fb5SKevin Wolf * txn. 8327eaa8fb5SKevin Wolf */ 8337eaa8fb5SKevin Wolf QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 8347eaa8fb5SKevin Wolf if (!job_is_completed(other_job)) { 8357eaa8fb5SKevin Wolf return; 8367eaa8fb5SKevin Wolf } 8377eaa8fb5SKevin Wolf assert(other_job->ret == 0); 8387eaa8fb5SKevin Wolf } 8397eaa8fb5SKevin Wolf 8407eaa8fb5SKevin Wolf job_txn_apply(txn, job_transition_to_pending, false); 8417eaa8fb5SKevin Wolf 8427eaa8fb5SKevin Wolf /* If no jobs need manual finalization, automatically do so */ 8437eaa8fb5SKevin Wolf if (job_txn_apply(txn, job_needs_finalize, false) == 0) { 8447eaa8fb5SKevin Wolf job_do_finalize(job); 8457eaa8fb5SKevin Wolf } 8467eaa8fb5SKevin Wolf } 8477eaa8fb5SKevin Wolf 8483d70ff53SKevin Wolf void job_completed(Job *job, int ret) 8493d70ff53SKevin Wolf { 8503d70ff53SKevin Wolf assert(job && job->txn && !job_is_completed(job)); 8513d70ff53SKevin Wolf job->ret = ret; 8523d70ff53SKevin Wolf job_update_rc(job); 8533d70ff53SKevin Wolf trace_job_completed(job, ret, job->ret); 8543d70ff53SKevin Wolf if (job->ret) { 8553d70ff53SKevin Wolf job_completed_txn_abort(job); 8563d70ff53SKevin Wolf } else { 8573d70ff53SKevin Wolf job_completed_txn_success(job); 8583d70ff53SKevin Wolf } 8593d70ff53SKevin Wolf } 8603d70ff53SKevin Wolf 8613d70ff53SKevin Wolf void job_cancel(Job *job, bool force) 8623d70ff53SKevin Wolf { 8633d70ff53SKevin Wolf if (job->status == JOB_STATUS_CONCLUDED) { 8643d70ff53SKevin Wolf job_do_dismiss(job); 8653d70ff53SKevin Wolf return; 8663d70ff53SKevin Wolf } 8673d70ff53SKevin Wolf job_cancel_async(job, force); 8683d70ff53SKevin Wolf if (!job_started(job)) { 8693d70ff53SKevin Wolf job_completed(job, -ECANCELED); 8703d70ff53SKevin Wolf } else if (job->deferred_to_main_loop) { 8713d70ff53SKevin Wolf job_completed_txn_abort(job); 8723d70ff53SKevin Wolf } else { 8733d70ff53SKevin Wolf job_enter(job); 8743d70ff53SKevin Wolf } 8753d70ff53SKevin Wolf } 8763d70ff53SKevin Wolf 8773d70ff53SKevin Wolf void job_user_cancel(Job *job, bool force, Error **errp) 8783d70ff53SKevin Wolf { 8793d70ff53SKevin Wolf if (job_apply_verb(job, JOB_VERB_CANCEL, errp)) { 8803d70ff53SKevin Wolf return; 8813d70ff53SKevin Wolf } 8823d70ff53SKevin Wolf job_cancel(job, force); 8833d70ff53SKevin Wolf } 8843d70ff53SKevin Wolf 8853d70ff53SKevin Wolf /* A wrapper around job_cancel() taking an Error ** parameter so it may be 8863d70ff53SKevin Wolf * used with job_finish_sync() without the need for (rather nasty) function 8873d70ff53SKevin Wolf * pointer casts there. */ 8883d70ff53SKevin Wolf static void job_cancel_err(Job *job, Error **errp) 8893d70ff53SKevin Wolf { 8903d70ff53SKevin Wolf job_cancel(job, false); 8913d70ff53SKevin Wolf } 8923d70ff53SKevin Wolf 8933d70ff53SKevin Wolf int job_cancel_sync(Job *job) 8943d70ff53SKevin Wolf { 8953d70ff53SKevin Wolf return job_finish_sync(job, &job_cancel_err, NULL); 8963d70ff53SKevin Wolf } 8973d70ff53SKevin Wolf 8983d70ff53SKevin Wolf void job_cancel_sync_all(void) 8993d70ff53SKevin Wolf { 9003d70ff53SKevin Wolf Job *job; 9013d70ff53SKevin Wolf AioContext *aio_context; 9023d70ff53SKevin Wolf 9033d70ff53SKevin Wolf while ((job = job_next(NULL))) { 9043d70ff53SKevin Wolf aio_context = job->aio_context; 9053d70ff53SKevin Wolf aio_context_acquire(aio_context); 9063d70ff53SKevin Wolf job_cancel_sync(job); 9073d70ff53SKevin Wolf aio_context_release(aio_context); 9083d70ff53SKevin Wolf } 9093d70ff53SKevin Wolf } 9103d70ff53SKevin Wolf 9113d70ff53SKevin Wolf int job_complete_sync(Job *job, Error **errp) 9123d70ff53SKevin Wolf { 9133d70ff53SKevin Wolf return job_finish_sync(job, job_complete, errp); 9143d70ff53SKevin Wolf } 9153d70ff53SKevin Wolf 9163453d972SKevin Wolf void job_complete(Job *job, Error **errp) 9173453d972SKevin Wolf { 9183453d972SKevin Wolf /* Should not be reachable via external interface for internal jobs */ 9193453d972SKevin Wolf assert(job->id); 9203453d972SKevin Wolf if (job_apply_verb(job, JOB_VERB_COMPLETE, errp)) { 9213453d972SKevin Wolf return; 9223453d972SKevin Wolf } 9233453d972SKevin Wolf if (job->pause_count || job_is_cancelled(job) || !job->driver->complete) { 9243453d972SKevin Wolf error_setg(errp, "The active block job '%s' cannot be completed", 9253453d972SKevin Wolf job->id); 9263453d972SKevin Wolf return; 9273453d972SKevin Wolf } 9283453d972SKevin Wolf 9293453d972SKevin Wolf job->driver->complete(job, errp); 9303453d972SKevin Wolf } 9313453d972SKevin Wolf 932b15de828SKevin Wolf 9331908a559SKevin Wolf typedef struct { 9341908a559SKevin Wolf Job *job; 9351908a559SKevin Wolf JobDeferToMainLoopFn *fn; 9361908a559SKevin Wolf void *opaque; 9371908a559SKevin Wolf } JobDeferToMainLoopData; 9381908a559SKevin Wolf 9391908a559SKevin Wolf static void job_defer_to_main_loop_bh(void *opaque) 9401908a559SKevin Wolf { 9411908a559SKevin Wolf JobDeferToMainLoopData *data = opaque; 9421908a559SKevin Wolf Job *job = data->job; 9431908a559SKevin Wolf AioContext *aio_context = job->aio_context; 9441908a559SKevin Wolf 9451908a559SKevin Wolf aio_context_acquire(aio_context); 9461908a559SKevin Wolf data->fn(data->job, data->opaque); 9471908a559SKevin Wolf aio_context_release(aio_context); 9481908a559SKevin Wolf 9491908a559SKevin Wolf g_free(data); 9501908a559SKevin Wolf } 9511908a559SKevin Wolf 9521908a559SKevin Wolf void job_defer_to_main_loop(Job *job, JobDeferToMainLoopFn *fn, void *opaque) 9531908a559SKevin Wolf { 9541908a559SKevin Wolf JobDeferToMainLoopData *data = g_malloc(sizeof(*data)); 9551908a559SKevin Wolf data->job = job; 9561908a559SKevin Wolf data->fn = fn; 9571908a559SKevin Wolf data->opaque = opaque; 9581908a559SKevin Wolf job->deferred_to_main_loop = true; 9591908a559SKevin Wolf 9601908a559SKevin Wolf aio_bh_schedule_oneshot(qemu_get_aio_context(), 9611908a559SKevin Wolf job_defer_to_main_loop_bh, data); 9621908a559SKevin Wolf } 9636a74c075SKevin Wolf 9646a74c075SKevin Wolf int job_finish_sync(Job *job, void (*finish)(Job *, Error **errp), Error **errp) 9656a74c075SKevin Wolf { 9666a74c075SKevin Wolf Error *local_err = NULL; 9676a74c075SKevin Wolf int ret; 9686a74c075SKevin Wolf 9696a74c075SKevin Wolf job_ref(job); 9706a74c075SKevin Wolf 9716a74c075SKevin Wolf if (finish) { 9726a74c075SKevin Wolf finish(job, &local_err); 9736a74c075SKevin Wolf } 9746a74c075SKevin Wolf if (local_err) { 9756a74c075SKevin Wolf error_propagate(errp, local_err); 9766a74c075SKevin Wolf job_unref(job); 9776a74c075SKevin Wolf return -EBUSY; 9786a74c075SKevin Wolf } 9796a74c075SKevin Wolf /* job_drain calls job_enter, and it should be enough to induce progress 9806a74c075SKevin Wolf * until the job completes or moves to the main thread. */ 9816a74c075SKevin Wolf while (!job->deferred_to_main_loop && !job_is_completed(job)) { 9826a74c075SKevin Wolf job_drain(job); 9836a74c075SKevin Wolf } 9846a74c075SKevin Wolf while (!job_is_completed(job)) { 9856a74c075SKevin Wolf aio_poll(qemu_get_aio_context(), true); 9866a74c075SKevin Wolf } 9876a74c075SKevin Wolf ret = (job_is_cancelled(job) && job->ret == 0) ? -ECANCELED : job->ret; 9886a74c075SKevin Wolf job_unref(job); 9896a74c075SKevin Wolf return ret; 9906a74c075SKevin Wolf } 991