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 63*da01ff7fSKevin Wolf /* Right now, this mutex is only needed to synchronize accesses to job->busy 64*da01ff7fSKevin Wolf * and job->sleep_timer, such as concurrent calls to job_do_yield and 65*da01ff7fSKevin Wolf * job_enter. */ 66*da01ff7fSKevin Wolf static QemuMutex job_mutex; 67*da01ff7fSKevin Wolf 68*da01ff7fSKevin Wolf static void job_lock(void) 69*da01ff7fSKevin Wolf { 70*da01ff7fSKevin Wolf qemu_mutex_lock(&job_mutex); 71*da01ff7fSKevin Wolf } 72*da01ff7fSKevin Wolf 73*da01ff7fSKevin Wolf static void job_unlock(void) 74*da01ff7fSKevin Wolf { 75*da01ff7fSKevin Wolf qemu_mutex_unlock(&job_mutex); 76*da01ff7fSKevin Wolf } 77*da01ff7fSKevin Wolf 78*da01ff7fSKevin Wolf static void __attribute__((__constructor__)) job_init(void) 79*da01ff7fSKevin Wolf { 80*da01ff7fSKevin Wolf qemu_mutex_init(&job_mutex); 81*da01ff7fSKevin Wolf } 82*da01ff7fSKevin Wolf 83a50c2ab8SKevin Wolf /* TODO Make static once the whole state machine is in job.c */ 84a50c2ab8SKevin Wolf void job_state_transition(Job *job, JobStatus s1) 85a50c2ab8SKevin Wolf { 86a50c2ab8SKevin Wolf JobStatus s0 = job->status; 87a50c2ab8SKevin Wolf assert(s1 >= 0 && s1 <= JOB_STATUS__MAX); 88a50c2ab8SKevin Wolf trace_job_state_transition(job, /* TODO re-enable: job->ret */ 0, 89a50c2ab8SKevin Wolf JobSTT[s0][s1] ? "allowed" : "disallowed", 90a50c2ab8SKevin Wolf JobStatus_str(s0), JobStatus_str(s1)); 91a50c2ab8SKevin Wolf assert(JobSTT[s0][s1]); 92a50c2ab8SKevin Wolf job->status = s1; 93a50c2ab8SKevin Wolf } 94a50c2ab8SKevin Wolf 95a50c2ab8SKevin Wolf int job_apply_verb(Job *job, JobVerb verb, Error **errp) 96a50c2ab8SKevin Wolf { 97a50c2ab8SKevin Wolf JobStatus s0 = job->status; 98a50c2ab8SKevin Wolf assert(verb >= 0 && verb <= JOB_VERB__MAX); 99a50c2ab8SKevin Wolf trace_job_apply_verb(job, JobStatus_str(s0), JobVerb_str(verb), 100a50c2ab8SKevin Wolf JobVerbTable[verb][s0] ? "allowed" : "prohibited"); 101a50c2ab8SKevin Wolf if (JobVerbTable[verb][s0]) { 102a50c2ab8SKevin Wolf return 0; 103a50c2ab8SKevin Wolf } 104a50c2ab8SKevin Wolf error_setg(errp, "Job '%s' in state '%s' cannot accept command verb '%s'", 105a50c2ab8SKevin Wolf job->id, JobStatus_str(s0), JobVerb_str(verb)); 106a50c2ab8SKevin Wolf return -EPERM; 107a50c2ab8SKevin Wolf } 108a50c2ab8SKevin Wolf 109252291eaSKevin Wolf JobType job_type(const Job *job) 110252291eaSKevin Wolf { 111252291eaSKevin Wolf return job->driver->job_type; 112252291eaSKevin Wolf } 113252291eaSKevin Wolf 114252291eaSKevin Wolf const char *job_type_str(const Job *job) 115252291eaSKevin Wolf { 116252291eaSKevin Wolf return JobType_str(job_type(job)); 117252291eaSKevin Wolf } 118252291eaSKevin Wolf 119daa7f2f9SKevin Wolf bool job_is_cancelled(Job *job) 120daa7f2f9SKevin Wolf { 121daa7f2f9SKevin Wolf return job->cancelled; 122daa7f2f9SKevin Wolf } 123daa7f2f9SKevin Wolf 124*da01ff7fSKevin Wolf bool job_started(Job *job) 125*da01ff7fSKevin Wolf { 126*da01ff7fSKevin Wolf return job->co; 127*da01ff7fSKevin Wolf } 128*da01ff7fSKevin Wolf 129*da01ff7fSKevin Wolf bool job_should_pause(Job *job) 130*da01ff7fSKevin Wolf { 131*da01ff7fSKevin Wolf return job->pause_count > 0; 132*da01ff7fSKevin Wolf } 133*da01ff7fSKevin Wolf 134e7c1d78bSKevin Wolf Job *job_next(Job *job) 135e7c1d78bSKevin Wolf { 136e7c1d78bSKevin Wolf if (!job) { 137e7c1d78bSKevin Wolf return QLIST_FIRST(&jobs); 138e7c1d78bSKevin Wolf } 139e7c1d78bSKevin Wolf return QLIST_NEXT(job, job_list); 140e7c1d78bSKevin Wolf } 141e7c1d78bSKevin Wolf 142e7c1d78bSKevin Wolf Job *job_get(const char *id) 143e7c1d78bSKevin Wolf { 144e7c1d78bSKevin Wolf Job *job; 145e7c1d78bSKevin Wolf 146e7c1d78bSKevin Wolf QLIST_FOREACH(job, &jobs, job_list) { 147e7c1d78bSKevin Wolf if (job->id && !strcmp(id, job->id)) { 148e7c1d78bSKevin Wolf return job; 149e7c1d78bSKevin Wolf } 150e7c1d78bSKevin Wolf } 151e7c1d78bSKevin Wolf 152e7c1d78bSKevin Wolf return NULL; 153e7c1d78bSKevin Wolf } 154e7c1d78bSKevin Wolf 15508be6fe2SKevin Wolf void *job_create(const char *job_id, const JobDriver *driver, AioContext *ctx, 15608be6fe2SKevin Wolf Error **errp) 15733e9e9bdSKevin Wolf { 15833e9e9bdSKevin Wolf Job *job; 15933e9e9bdSKevin Wolf 16033e9e9bdSKevin Wolf if (job_id) { 16133e9e9bdSKevin Wolf if (!id_wellformed(job_id)) { 16233e9e9bdSKevin Wolf error_setg(errp, "Invalid job ID '%s'", job_id); 16333e9e9bdSKevin Wolf return NULL; 16433e9e9bdSKevin Wolf } 165e7c1d78bSKevin Wolf if (job_get(job_id)) { 166e7c1d78bSKevin Wolf error_setg(errp, "Job ID '%s' already in use", job_id); 167e7c1d78bSKevin Wolf return NULL; 168e7c1d78bSKevin Wolf } 16933e9e9bdSKevin Wolf } 17033e9e9bdSKevin Wolf 17133e9e9bdSKevin Wolf job = g_malloc0(driver->instance_size); 17233e9e9bdSKevin Wolf job->driver = driver; 17333e9e9bdSKevin Wolf job->id = g_strdup(job_id); 17480fa2c75SKevin Wolf job->refcnt = 1; 17508be6fe2SKevin Wolf job->aio_context = ctx; 176*da01ff7fSKevin Wolf job->busy = false; 177*da01ff7fSKevin Wolf job->paused = true; 178*da01ff7fSKevin Wolf job->pause_count = 1; 17933e9e9bdSKevin Wolf 180a50c2ab8SKevin Wolf job_state_transition(job, JOB_STATUS_CREATED); 181a50c2ab8SKevin Wolf 182e7c1d78bSKevin Wolf QLIST_INSERT_HEAD(&jobs, job, job_list); 183e7c1d78bSKevin Wolf 18433e9e9bdSKevin Wolf return job; 18533e9e9bdSKevin Wolf } 186fd61a701SKevin Wolf 18780fa2c75SKevin Wolf void job_ref(Job *job) 188fd61a701SKevin Wolf { 18980fa2c75SKevin Wolf ++job->refcnt; 19080fa2c75SKevin Wolf } 19180fa2c75SKevin Wolf 19280fa2c75SKevin Wolf void job_unref(Job *job) 19380fa2c75SKevin Wolf { 19480fa2c75SKevin Wolf if (--job->refcnt == 0) { 19580fa2c75SKevin Wolf assert(job->status == JOB_STATUS_NULL); 19680fa2c75SKevin Wolf 19780fa2c75SKevin Wolf if (job->driver->free) { 19880fa2c75SKevin Wolf job->driver->free(job); 19980fa2c75SKevin Wolf } 20080fa2c75SKevin Wolf 201e7c1d78bSKevin Wolf QLIST_REMOVE(job, job_list); 202e7c1d78bSKevin Wolf 203fd61a701SKevin Wolf g_free(job->id); 204fd61a701SKevin Wolf g_free(job); 205fd61a701SKevin Wolf } 20680fa2c75SKevin Wolf } 2071908a559SKevin Wolf 208*da01ff7fSKevin Wolf void job_enter_cond(Job *job, bool(*fn)(Job *job)) 209*da01ff7fSKevin Wolf { 210*da01ff7fSKevin Wolf if (!job_started(job)) { 211*da01ff7fSKevin Wolf return; 212*da01ff7fSKevin Wolf } 213*da01ff7fSKevin Wolf if (job->deferred_to_main_loop) { 214*da01ff7fSKevin Wolf return; 215*da01ff7fSKevin Wolf } 216*da01ff7fSKevin Wolf 217*da01ff7fSKevin Wolf job_lock(); 218*da01ff7fSKevin Wolf if (job->busy) { 219*da01ff7fSKevin Wolf job_unlock(); 220*da01ff7fSKevin Wolf return; 221*da01ff7fSKevin Wolf } 222*da01ff7fSKevin Wolf 223*da01ff7fSKevin Wolf if (fn && !fn(job)) { 224*da01ff7fSKevin Wolf job_unlock(); 225*da01ff7fSKevin Wolf return; 226*da01ff7fSKevin Wolf } 227*da01ff7fSKevin Wolf 228*da01ff7fSKevin Wolf assert(!job->deferred_to_main_loop); 229*da01ff7fSKevin Wolf timer_del(&job->sleep_timer); 230*da01ff7fSKevin Wolf job->busy = true; 231*da01ff7fSKevin Wolf job_unlock(); 232*da01ff7fSKevin Wolf aio_co_wake(job->co); 233*da01ff7fSKevin Wolf } 234*da01ff7fSKevin Wolf 235*da01ff7fSKevin Wolf /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds. 236*da01ff7fSKevin Wolf * Reentering the job coroutine with block_job_enter() before the timer has 237*da01ff7fSKevin Wolf * expired is allowed and cancels the timer. 238*da01ff7fSKevin Wolf * 239*da01ff7fSKevin Wolf * If @ns is (uint64_t) -1, no timer is scheduled and block_job_enter() must be 240*da01ff7fSKevin Wolf * called explicitly. */ 241*da01ff7fSKevin Wolf void coroutine_fn job_do_yield(Job *job, uint64_t ns) 242*da01ff7fSKevin Wolf { 243*da01ff7fSKevin Wolf job_lock(); 244*da01ff7fSKevin Wolf if (ns != -1) { 245*da01ff7fSKevin Wolf timer_mod(&job->sleep_timer, ns); 246*da01ff7fSKevin Wolf } 247*da01ff7fSKevin Wolf job->busy = false; 248*da01ff7fSKevin Wolf job_unlock(); 249*da01ff7fSKevin Wolf qemu_coroutine_yield(); 250*da01ff7fSKevin Wolf 251*da01ff7fSKevin Wolf /* Set by job_enter_cond() before re-entering the coroutine. */ 252*da01ff7fSKevin Wolf assert(job->busy); 253*da01ff7fSKevin Wolf } 254*da01ff7fSKevin Wolf 255*da01ff7fSKevin Wolf void coroutine_fn job_pause_point(Job *job) 256*da01ff7fSKevin Wolf { 257*da01ff7fSKevin Wolf assert(job && job_started(job)); 258*da01ff7fSKevin Wolf 259*da01ff7fSKevin Wolf if (!job_should_pause(job)) { 260*da01ff7fSKevin Wolf return; 261*da01ff7fSKevin Wolf } 262*da01ff7fSKevin Wolf if (job_is_cancelled(job)) { 263*da01ff7fSKevin Wolf return; 264*da01ff7fSKevin Wolf } 265*da01ff7fSKevin Wolf 266*da01ff7fSKevin Wolf if (job->driver->pause) { 267*da01ff7fSKevin Wolf job->driver->pause(job); 268*da01ff7fSKevin Wolf } 269*da01ff7fSKevin Wolf 270*da01ff7fSKevin Wolf if (job_should_pause(job) && !job_is_cancelled(job)) { 271*da01ff7fSKevin Wolf JobStatus status = job->status; 272*da01ff7fSKevin Wolf job_state_transition(job, status == JOB_STATUS_READY 273*da01ff7fSKevin Wolf ? JOB_STATUS_STANDBY 274*da01ff7fSKevin Wolf : JOB_STATUS_PAUSED); 275*da01ff7fSKevin Wolf job->paused = true; 276*da01ff7fSKevin Wolf job_do_yield(job, -1); 277*da01ff7fSKevin Wolf job->paused = false; 278*da01ff7fSKevin Wolf job_state_transition(job, status); 279*da01ff7fSKevin Wolf } 280*da01ff7fSKevin Wolf 281*da01ff7fSKevin Wolf if (job->driver->resume) { 282*da01ff7fSKevin Wolf job->driver->resume(job); 283*da01ff7fSKevin Wolf } 284*da01ff7fSKevin Wolf } 285*da01ff7fSKevin Wolf 286*da01ff7fSKevin Wolf /** 287*da01ff7fSKevin Wolf * All jobs must allow a pause point before entering their job proper. This 288*da01ff7fSKevin Wolf * ensures that jobs can be paused prior to being started, then resumed later. 289*da01ff7fSKevin Wolf */ 290*da01ff7fSKevin Wolf static void coroutine_fn job_co_entry(void *opaque) 291*da01ff7fSKevin Wolf { 292*da01ff7fSKevin Wolf Job *job = opaque; 293*da01ff7fSKevin Wolf 294*da01ff7fSKevin Wolf assert(job && job->driver && job->driver->start); 295*da01ff7fSKevin Wolf job_pause_point(job); 296*da01ff7fSKevin Wolf job->driver->start(job); 297*da01ff7fSKevin Wolf } 298*da01ff7fSKevin Wolf 299*da01ff7fSKevin Wolf 300*da01ff7fSKevin Wolf void job_start(Job *job) 301*da01ff7fSKevin Wolf { 302*da01ff7fSKevin Wolf assert(job && !job_started(job) && job->paused && 303*da01ff7fSKevin Wolf job->driver && job->driver->start); 304*da01ff7fSKevin Wolf job->co = qemu_coroutine_create(job_co_entry, job); 305*da01ff7fSKevin Wolf job->pause_count--; 306*da01ff7fSKevin Wolf job->busy = true; 307*da01ff7fSKevin Wolf job->paused = false; 308*da01ff7fSKevin Wolf job_state_transition(job, JOB_STATUS_RUNNING); 309*da01ff7fSKevin Wolf aio_co_enter(job->aio_context, job->co); 310*da01ff7fSKevin Wolf } 311*da01ff7fSKevin Wolf 3121908a559SKevin Wolf typedef struct { 3131908a559SKevin Wolf Job *job; 3141908a559SKevin Wolf JobDeferToMainLoopFn *fn; 3151908a559SKevin Wolf void *opaque; 3161908a559SKevin Wolf } JobDeferToMainLoopData; 3171908a559SKevin Wolf 3181908a559SKevin Wolf static void job_defer_to_main_loop_bh(void *opaque) 3191908a559SKevin Wolf { 3201908a559SKevin Wolf JobDeferToMainLoopData *data = opaque; 3211908a559SKevin Wolf Job *job = data->job; 3221908a559SKevin Wolf AioContext *aio_context = job->aio_context; 3231908a559SKevin Wolf 3241908a559SKevin Wolf aio_context_acquire(aio_context); 3251908a559SKevin Wolf data->fn(data->job, data->opaque); 3261908a559SKevin Wolf aio_context_release(aio_context); 3271908a559SKevin Wolf 3281908a559SKevin Wolf g_free(data); 3291908a559SKevin Wolf } 3301908a559SKevin Wolf 3311908a559SKevin Wolf void job_defer_to_main_loop(Job *job, JobDeferToMainLoopFn *fn, void *opaque) 3321908a559SKevin Wolf { 3331908a559SKevin Wolf JobDeferToMainLoopData *data = g_malloc(sizeof(*data)); 3341908a559SKevin Wolf data->job = job; 3351908a559SKevin Wolf data->fn = fn; 3361908a559SKevin Wolf data->opaque = opaque; 3371908a559SKevin Wolf job->deferred_to_main_loop = true; 3381908a559SKevin Wolf 3391908a559SKevin Wolf aio_bh_schedule_oneshot(qemu_get_aio_context(), 3401908a559SKevin Wolf job_defer_to_main_loop_bh, data); 3411908a559SKevin Wolf } 342