xref: /qemu/blockjob.c (revision fc24908e7d232b79c2a6f0363f52bda18dedb57b)
12f0c9fe6SPaolo Bonzini /*
22f0c9fe6SPaolo Bonzini  * QEMU System Emulator block driver
32f0c9fe6SPaolo Bonzini  *
42f0c9fe6SPaolo Bonzini  * Copyright (c) 2011 IBM Corp.
52f0c9fe6SPaolo Bonzini  * Copyright (c) 2012 Red Hat, Inc.
62f0c9fe6SPaolo Bonzini  *
72f0c9fe6SPaolo Bonzini  * Permission is hereby granted, free of charge, to any person obtaining a copy
82f0c9fe6SPaolo Bonzini  * of this software and associated documentation files (the "Software"), to deal
92f0c9fe6SPaolo Bonzini  * in the Software without restriction, including without limitation the rights
102f0c9fe6SPaolo Bonzini  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
112f0c9fe6SPaolo Bonzini  * copies of the Software, and to permit persons to whom the Software is
122f0c9fe6SPaolo Bonzini  * furnished to do so, subject to the following conditions:
132f0c9fe6SPaolo Bonzini  *
142f0c9fe6SPaolo Bonzini  * The above copyright notice and this permission notice shall be included in
152f0c9fe6SPaolo Bonzini  * all copies or substantial portions of the Software.
162f0c9fe6SPaolo Bonzini  *
172f0c9fe6SPaolo Bonzini  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
182f0c9fe6SPaolo Bonzini  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
192f0c9fe6SPaolo Bonzini  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
202f0c9fe6SPaolo Bonzini  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
212f0c9fe6SPaolo Bonzini  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
222f0c9fe6SPaolo Bonzini  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
232f0c9fe6SPaolo Bonzini  * THE SOFTWARE.
242f0c9fe6SPaolo Bonzini  */
252f0c9fe6SPaolo Bonzini 
26d38ea87aSPeter Maydell #include "qemu/osdep.h"
272f0c9fe6SPaolo Bonzini #include "qemu-common.h"
28737e150eSPaolo Bonzini #include "block/block.h"
29c87621eaSJohn Snow #include "block/blockjob_int.h"
30737e150eSPaolo Bonzini #include "block/block_int.h"
31373340b2SMax Reitz #include "sysemu/block-backend.h"
32cc7a8ea7SMarkus Armbruster #include "qapi/qmp/qerror.h"
337b1b5d19SPaolo Bonzini #include "qapi/qmp/qjson.h"
3410817bf0SDaniel P. Berrange #include "qemu/coroutine.h"
357f0317cfSAlberto Garcia #include "qemu/id.h"
362f0c9fe6SPaolo Bonzini #include "qmp-commands.h"
371de7afc9SPaolo Bonzini #include "qemu/timer.h"
385a2d2cbdSWenchao Xia #include "qapi-event.h"
392f0c9fe6SPaolo Bonzini 
40*fc24908eSPaolo Bonzini /* Right now, this mutex is only needed to synchronize accesses to job->busy
41*fc24908eSPaolo Bonzini  * and job->sleep_timer, such as concurrent calls to block_job_do_yield and
42*fc24908eSPaolo Bonzini  * block_job_enter. */
43*fc24908eSPaolo Bonzini static QemuMutex block_job_mutex;
44*fc24908eSPaolo Bonzini 
45*fc24908eSPaolo Bonzini static void block_job_lock(void)
46*fc24908eSPaolo Bonzini {
47*fc24908eSPaolo Bonzini     qemu_mutex_lock(&block_job_mutex);
48*fc24908eSPaolo Bonzini }
49*fc24908eSPaolo Bonzini 
50*fc24908eSPaolo Bonzini static void block_job_unlock(void)
51*fc24908eSPaolo Bonzini {
52*fc24908eSPaolo Bonzini     qemu_mutex_unlock(&block_job_mutex);
53*fc24908eSPaolo Bonzini }
54*fc24908eSPaolo Bonzini 
55*fc24908eSPaolo Bonzini static void __attribute__((__constructor__)) block_job_init(void)
56*fc24908eSPaolo Bonzini {
57*fc24908eSPaolo Bonzini     qemu_mutex_init(&block_job_mutex);
58*fc24908eSPaolo Bonzini }
59*fc24908eSPaolo Bonzini 
608254b6d9SJohn Snow static void block_job_event_cancelled(BlockJob *job);
618254b6d9SJohn Snow static void block_job_event_completed(BlockJob *job, const char *msg);
628254b6d9SJohn Snow 
63c55a832fSFam Zheng /* Transactional group of block jobs */
64c55a832fSFam Zheng struct BlockJobTxn {
65c55a832fSFam Zheng 
66c55a832fSFam Zheng     /* Is this txn being cancelled? */
67c55a832fSFam Zheng     bool aborting;
68c55a832fSFam Zheng 
69c55a832fSFam Zheng     /* List of jobs */
70c55a832fSFam Zheng     QLIST_HEAD(, BlockJob) jobs;
71c55a832fSFam Zheng 
72c55a832fSFam Zheng     /* Reference count */
73c55a832fSFam Zheng     int refcnt;
74c55a832fSFam Zheng };
75c55a832fSFam Zheng 
76a7112795SAlberto Garcia static QLIST_HEAD(, BlockJob) block_jobs = QLIST_HEAD_INITIALIZER(block_jobs);
77a7112795SAlberto Garcia 
7888691b37SPaolo Bonzini /*
7988691b37SPaolo Bonzini  * The block job API is composed of two categories of functions.
8088691b37SPaolo Bonzini  *
8188691b37SPaolo Bonzini  * The first includes functions used by the monitor.  The monitor is
8288691b37SPaolo Bonzini  * peculiar in that it accesses the block job list with block_job_get, and
8388691b37SPaolo Bonzini  * therefore needs consistency across block_job_get and the actual operation
8488691b37SPaolo Bonzini  * (e.g. block_job_set_speed).  The consistency is achieved with
8588691b37SPaolo Bonzini  * aio_context_acquire/release.  These functions are declared in blockjob.h.
8688691b37SPaolo Bonzini  *
8788691b37SPaolo Bonzini  * The second includes functions used by the block job drivers and sometimes
8888691b37SPaolo Bonzini  * by the core block layer.  These do not care about locking, because the
8988691b37SPaolo Bonzini  * whole coroutine runs under the AioContext lock, and are declared in
9088691b37SPaolo Bonzini  * blockjob_int.h.
9188691b37SPaolo Bonzini  */
9288691b37SPaolo Bonzini 
93a7112795SAlberto Garcia BlockJob *block_job_next(BlockJob *job)
94a7112795SAlberto Garcia {
95a7112795SAlberto Garcia     if (!job) {
96a7112795SAlberto Garcia         return QLIST_FIRST(&block_jobs);
97a7112795SAlberto Garcia     }
98a7112795SAlberto Garcia     return QLIST_NEXT(job, job_list);
99a7112795SAlberto Garcia }
100a7112795SAlberto Garcia 
101ffb1f10cSAlberto Garcia BlockJob *block_job_get(const char *id)
102ffb1f10cSAlberto Garcia {
103ffb1f10cSAlberto Garcia     BlockJob *job;
104ffb1f10cSAlberto Garcia 
105ffb1f10cSAlberto Garcia     QLIST_FOREACH(job, &block_jobs, job_list) {
106559b935fSJohn Snow         if (job->id && !strcmp(id, job->id)) {
107ffb1f10cSAlberto Garcia             return job;
108ffb1f10cSAlberto Garcia         }
109ffb1f10cSAlberto Garcia     }
110ffb1f10cSAlberto Garcia 
111ffb1f10cSAlberto Garcia     return NULL;
112ffb1f10cSAlberto Garcia }
113ffb1f10cSAlberto Garcia 
114c8ab5c2dSPaolo Bonzini BlockJobTxn *block_job_txn_new(void)
115c8ab5c2dSPaolo Bonzini {
116c8ab5c2dSPaolo Bonzini     BlockJobTxn *txn = g_new0(BlockJobTxn, 1);
117c8ab5c2dSPaolo Bonzini     QLIST_INIT(&txn->jobs);
118c8ab5c2dSPaolo Bonzini     txn->refcnt = 1;
119c8ab5c2dSPaolo Bonzini     return txn;
120c8ab5c2dSPaolo Bonzini }
121c8ab5c2dSPaolo Bonzini 
122c8ab5c2dSPaolo Bonzini static void block_job_txn_ref(BlockJobTxn *txn)
123c8ab5c2dSPaolo Bonzini {
124c8ab5c2dSPaolo Bonzini     txn->refcnt++;
125c8ab5c2dSPaolo Bonzini }
126c8ab5c2dSPaolo Bonzini 
127c8ab5c2dSPaolo Bonzini void block_job_txn_unref(BlockJobTxn *txn)
128c8ab5c2dSPaolo Bonzini {
129c8ab5c2dSPaolo Bonzini     if (txn && --txn->refcnt == 0) {
130c8ab5c2dSPaolo Bonzini         g_free(txn);
131c8ab5c2dSPaolo Bonzini     }
132c8ab5c2dSPaolo Bonzini }
133c8ab5c2dSPaolo Bonzini 
134c8ab5c2dSPaolo Bonzini void block_job_txn_add_job(BlockJobTxn *txn, BlockJob *job)
135c8ab5c2dSPaolo Bonzini {
136c8ab5c2dSPaolo Bonzini     if (!txn) {
137c8ab5c2dSPaolo Bonzini         return;
138c8ab5c2dSPaolo Bonzini     }
139c8ab5c2dSPaolo Bonzini 
140c8ab5c2dSPaolo Bonzini     assert(!job->txn);
141c8ab5c2dSPaolo Bonzini     job->txn = txn;
142c8ab5c2dSPaolo Bonzini 
143c8ab5c2dSPaolo Bonzini     QLIST_INSERT_HEAD(&txn->jobs, job, txn_list);
144c8ab5c2dSPaolo Bonzini     block_job_txn_ref(txn);
145c8ab5c2dSPaolo Bonzini }
146c8ab5c2dSPaolo Bonzini 
147f321dcb5SPaolo Bonzini static void block_job_pause(BlockJob *job)
148f321dcb5SPaolo Bonzini {
149f321dcb5SPaolo Bonzini     job->pause_count++;
150f321dcb5SPaolo Bonzini }
151f321dcb5SPaolo Bonzini 
152f321dcb5SPaolo Bonzini static void block_job_resume(BlockJob *job)
153f321dcb5SPaolo Bonzini {
154f321dcb5SPaolo Bonzini     assert(job->pause_count > 0);
155f321dcb5SPaolo Bonzini     job->pause_count--;
156f321dcb5SPaolo Bonzini     if (job->pause_count) {
157f321dcb5SPaolo Bonzini         return;
158f321dcb5SPaolo Bonzini     }
159f321dcb5SPaolo Bonzini     block_job_enter(job);
160f321dcb5SPaolo Bonzini }
161f321dcb5SPaolo Bonzini 
1624172a003Ssochin.jiang void block_job_ref(BlockJob *job)
16305b0d8e3SPaolo Bonzini {
16405b0d8e3SPaolo Bonzini     ++job->refcnt;
16505b0d8e3SPaolo Bonzini }
16605b0d8e3SPaolo Bonzini 
16705b0d8e3SPaolo Bonzini static void block_job_attached_aio_context(AioContext *new_context,
16805b0d8e3SPaolo Bonzini                                            void *opaque);
16905b0d8e3SPaolo Bonzini static void block_job_detach_aio_context(void *opaque);
17005b0d8e3SPaolo Bonzini 
1714172a003Ssochin.jiang void block_job_unref(BlockJob *job)
17205b0d8e3SPaolo Bonzini {
17305b0d8e3SPaolo Bonzini     if (--job->refcnt == 0) {
17405b0d8e3SPaolo Bonzini         BlockDriverState *bs = blk_bs(job->blk);
1750a3e155fSAlberto Garcia         QLIST_REMOVE(job, job_list);
17605b0d8e3SPaolo Bonzini         bs->job = NULL;
17705b0d8e3SPaolo Bonzini         block_job_remove_all_bdrv(job);
17805b0d8e3SPaolo Bonzini         blk_remove_aio_context_notifier(job->blk,
17905b0d8e3SPaolo Bonzini                                         block_job_attached_aio_context,
18005b0d8e3SPaolo Bonzini                                         block_job_detach_aio_context, job);
18105b0d8e3SPaolo Bonzini         blk_unref(job->blk);
18205b0d8e3SPaolo Bonzini         error_free(job->blocker);
18305b0d8e3SPaolo Bonzini         g_free(job->id);
184*fc24908eSPaolo Bonzini         assert(!timer_pending(&job->sleep_timer));
18505b0d8e3SPaolo Bonzini         g_free(job);
18605b0d8e3SPaolo Bonzini     }
18705b0d8e3SPaolo Bonzini }
18805b0d8e3SPaolo Bonzini 
189463e0be1SStefan Hajnoczi static void block_job_attached_aio_context(AioContext *new_context,
190463e0be1SStefan Hajnoczi                                            void *opaque)
191463e0be1SStefan Hajnoczi {
192463e0be1SStefan Hajnoczi     BlockJob *job = opaque;
193463e0be1SStefan Hajnoczi 
194463e0be1SStefan Hajnoczi     if (job->driver->attached_aio_context) {
195463e0be1SStefan Hajnoczi         job->driver->attached_aio_context(job, new_context);
196463e0be1SStefan Hajnoczi     }
197463e0be1SStefan Hajnoczi 
198463e0be1SStefan Hajnoczi     block_job_resume(job);
199463e0be1SStefan Hajnoczi }
200463e0be1SStefan Hajnoczi 
201bae8196dSPaolo Bonzini static void block_job_drain(BlockJob *job)
202bae8196dSPaolo Bonzini {
203bae8196dSPaolo Bonzini     /* If job is !job->busy this kicks it into the next pause point. */
204bae8196dSPaolo Bonzini     block_job_enter(job);
205bae8196dSPaolo Bonzini 
206bae8196dSPaolo Bonzini     blk_drain(job->blk);
207bae8196dSPaolo Bonzini     if (job->driver->drain) {
208bae8196dSPaolo Bonzini         job->driver->drain(job);
209bae8196dSPaolo Bonzini     }
210bae8196dSPaolo Bonzini }
211bae8196dSPaolo Bonzini 
212463e0be1SStefan Hajnoczi static void block_job_detach_aio_context(void *opaque)
213463e0be1SStefan Hajnoczi {
214463e0be1SStefan Hajnoczi     BlockJob *job = opaque;
215463e0be1SStefan Hajnoczi 
216463e0be1SStefan Hajnoczi     /* In case the job terminates during aio_poll()... */
217463e0be1SStefan Hajnoczi     block_job_ref(job);
218463e0be1SStefan Hajnoczi 
219463e0be1SStefan Hajnoczi     block_job_pause(job);
220463e0be1SStefan Hajnoczi 
221463e0be1SStefan Hajnoczi     while (!job->paused && !job->completed) {
222bae8196dSPaolo Bonzini         block_job_drain(job);
223463e0be1SStefan Hajnoczi     }
224463e0be1SStefan Hajnoczi 
225463e0be1SStefan Hajnoczi     block_job_unref(job);
226463e0be1SStefan Hajnoczi }
227463e0be1SStefan Hajnoczi 
228f321dcb5SPaolo Bonzini static char *child_job_get_parent_desc(BdrvChild *c)
229f321dcb5SPaolo Bonzini {
230f321dcb5SPaolo Bonzini     BlockJob *job = c->opaque;
231f321dcb5SPaolo Bonzini     return g_strdup_printf("%s job '%s'",
232977c736fSMarkus Armbruster                            BlockJobType_str(job->driver->job_type),
233f321dcb5SPaolo Bonzini                            job->id);
234f321dcb5SPaolo Bonzini }
235f321dcb5SPaolo Bonzini 
236f321dcb5SPaolo Bonzini static const BdrvChildRole child_job = {
237f321dcb5SPaolo Bonzini     .get_parent_desc    = child_job_get_parent_desc,
238f321dcb5SPaolo Bonzini     .stay_at_node       = true,
239f321dcb5SPaolo Bonzini };
240f321dcb5SPaolo Bonzini 
241f321dcb5SPaolo Bonzini static void block_job_drained_begin(void *opaque)
242f321dcb5SPaolo Bonzini {
243f321dcb5SPaolo Bonzini     BlockJob *job = opaque;
244f321dcb5SPaolo Bonzini     block_job_pause(job);
245f321dcb5SPaolo Bonzini }
246f321dcb5SPaolo Bonzini 
247f321dcb5SPaolo Bonzini static void block_job_drained_end(void *opaque)
248f321dcb5SPaolo Bonzini {
249f321dcb5SPaolo Bonzini     BlockJob *job = opaque;
250f321dcb5SPaolo Bonzini     block_job_resume(job);
251f321dcb5SPaolo Bonzini }
252f321dcb5SPaolo Bonzini 
253f321dcb5SPaolo Bonzini static const BlockDevOps block_job_dev_ops = {
254f321dcb5SPaolo Bonzini     .drained_begin = block_job_drained_begin,
255f321dcb5SPaolo Bonzini     .drained_end = block_job_drained_end,
256f321dcb5SPaolo Bonzini };
257f321dcb5SPaolo Bonzini 
258bbc02b90SKevin Wolf void block_job_remove_all_bdrv(BlockJob *job)
259bbc02b90SKevin Wolf {
260bbc02b90SKevin Wolf     GSList *l;
261bbc02b90SKevin Wolf     for (l = job->nodes; l; l = l->next) {
262bbc02b90SKevin Wolf         BdrvChild *c = l->data;
263bbc02b90SKevin Wolf         bdrv_op_unblock_all(c->bs, job->blocker);
264bbc02b90SKevin Wolf         bdrv_root_unref_child(c);
265bbc02b90SKevin Wolf     }
266bbc02b90SKevin Wolf     g_slist_free(job->nodes);
267bbc02b90SKevin Wolf     job->nodes = NULL;
268bbc02b90SKevin Wolf }
269bbc02b90SKevin Wolf 
27076d554e2SKevin Wolf int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs,
27176d554e2SKevin Wolf                        uint64_t perm, uint64_t shared_perm, Error **errp)
27223d402d4SAlberto Garcia {
27376d554e2SKevin Wolf     BdrvChild *c;
27476d554e2SKevin Wolf 
27576d554e2SKevin Wolf     c = bdrv_root_attach_child(bs, name, &child_job, perm, shared_perm,
27676d554e2SKevin Wolf                                job, errp);
27776d554e2SKevin Wolf     if (c == NULL) {
27876d554e2SKevin Wolf         return -EPERM;
27976d554e2SKevin Wolf     }
28076d554e2SKevin Wolf 
28176d554e2SKevin Wolf     job->nodes = g_slist_prepend(job->nodes, c);
28223d402d4SAlberto Garcia     bdrv_ref(bs);
28323d402d4SAlberto Garcia     bdrv_op_block_all(bs, job->blocker);
28476d554e2SKevin Wolf 
28576d554e2SKevin Wolf     return 0;
28623d402d4SAlberto Garcia }
28723d402d4SAlberto Garcia 
288559b935fSJohn Snow bool block_job_is_internal(BlockJob *job)
289559b935fSJohn Snow {
290559b935fSJohn Snow     return (job->id == NULL);
291559b935fSJohn Snow }
292559b935fSJohn Snow 
2935ccac6f1SJohn Snow static bool block_job_started(BlockJob *job)
2945ccac6f1SJohn Snow {
2955ccac6f1SJohn Snow     return job->co;
2965ccac6f1SJohn Snow }
2975ccac6f1SJohn Snow 
298e3796a24SJohn Snow /**
299e3796a24SJohn Snow  * All jobs must allow a pause point before entering their job proper. This
300e3796a24SJohn Snow  * ensures that jobs can be paused prior to being started, then resumed later.
301e3796a24SJohn Snow  */
302e3796a24SJohn Snow static void coroutine_fn block_job_co_entry(void *opaque)
303e3796a24SJohn Snow {
304e3796a24SJohn Snow     BlockJob *job = opaque;
305e3796a24SJohn Snow 
306e3796a24SJohn Snow     assert(job && job->driver && job->driver->start);
307e3796a24SJohn Snow     block_job_pause_point(job);
308e3796a24SJohn Snow     job->driver->start(job);
309e3796a24SJohn Snow }
310e3796a24SJohn Snow 
311*fc24908eSPaolo Bonzini static void block_job_sleep_timer_cb(void *opaque)
312*fc24908eSPaolo Bonzini {
313*fc24908eSPaolo Bonzini     BlockJob *job = opaque;
314*fc24908eSPaolo Bonzini 
315*fc24908eSPaolo Bonzini     block_job_enter(job);
316*fc24908eSPaolo Bonzini }
317*fc24908eSPaolo Bonzini 
3185ccac6f1SJohn Snow void block_job_start(BlockJob *job)
3195ccac6f1SJohn Snow {
3205ccac6f1SJohn Snow     assert(job && !block_job_started(job) && job->paused &&
321e3796a24SJohn Snow            job->driver && job->driver->start);
322e3796a24SJohn Snow     job->co = qemu_coroutine_create(block_job_co_entry, job);
323e3796a24SJohn Snow     job->pause_count--;
3245ccac6f1SJohn Snow     job->busy = true;
325e3796a24SJohn Snow     job->paused = false;
326aef4278cSFam Zheng     bdrv_coroutine_enter(blk_bs(job->blk), job->co);
3275ccac6f1SJohn Snow }
3285ccac6f1SJohn Snow 
329c55a832fSFam Zheng static void block_job_completed_single(BlockJob *job)
330c55a832fSFam Zheng {
3314fb588e9SPaolo Bonzini     assert(job->completed);
3324fb588e9SPaolo Bonzini 
333c55a832fSFam Zheng     if (!job->ret) {
334c55a832fSFam Zheng         if (job->driver->commit) {
335c55a832fSFam Zheng             job->driver->commit(job);
336c55a832fSFam Zheng         }
337c55a832fSFam Zheng     } else {
338c55a832fSFam Zheng         if (job->driver->abort) {
339c55a832fSFam Zheng             job->driver->abort(job);
340c55a832fSFam Zheng         }
341c55a832fSFam Zheng     }
342e8a40bf7SJohn Snow     if (job->driver->clean) {
343e8a40bf7SJohn Snow         job->driver->clean(job);
344e8a40bf7SJohn Snow     }
3458254b6d9SJohn Snow 
3468254b6d9SJohn Snow     if (job->cb) {
347c55a832fSFam Zheng         job->cb(job->opaque, job->ret);
3488254b6d9SJohn Snow     }
3495ccac6f1SJohn Snow 
3505ccac6f1SJohn Snow     /* Emit events only if we actually started */
3515ccac6f1SJohn Snow     if (block_job_started(job)) {
3528254b6d9SJohn Snow         if (block_job_is_cancelled(job)) {
3538254b6d9SJohn Snow             block_job_event_cancelled(job);
3548254b6d9SJohn Snow         } else {
3558254b6d9SJohn Snow             const char *msg = NULL;
3568254b6d9SJohn Snow             if (job->ret < 0) {
3578254b6d9SJohn Snow                 msg = strerror(-job->ret);
3588254b6d9SJohn Snow             }
3598254b6d9SJohn Snow             block_job_event_completed(job, msg);
3608254b6d9SJohn Snow         }
3615ccac6f1SJohn Snow     }
3628254b6d9SJohn Snow 
363c55a832fSFam Zheng     if (job->txn) {
3641e93b9fbSVladimir Sementsov-Ogievskiy         QLIST_REMOVE(job, txn_list);
365c55a832fSFam Zheng         block_job_txn_unref(job->txn);
366c55a832fSFam Zheng     }
367c55a832fSFam Zheng     block_job_unref(job);
368c55a832fSFam Zheng }
369c55a832fSFam Zheng 
3704c241cf5SPaolo Bonzini static void block_job_cancel_async(BlockJob *job)
3714c241cf5SPaolo Bonzini {
3724c241cf5SPaolo Bonzini     if (job->iostatus != BLOCK_DEVICE_IO_STATUS_OK) {
3734c241cf5SPaolo Bonzini         block_job_iostatus_reset(job);
3744c241cf5SPaolo Bonzini     }
3754c241cf5SPaolo Bonzini     if (job->user_paused) {
3764c241cf5SPaolo Bonzini         /* Do not call block_job_enter here, the caller will handle it.  */
3774c241cf5SPaolo Bonzini         job->user_paused = false;
3784c241cf5SPaolo Bonzini         job->pause_count--;
3794c241cf5SPaolo Bonzini     }
3804c241cf5SPaolo Bonzini     job->cancelled = true;
3814c241cf5SPaolo Bonzini }
3824c241cf5SPaolo Bonzini 
383c8ab5c2dSPaolo Bonzini static int block_job_finish_sync(BlockJob *job,
384c8ab5c2dSPaolo Bonzini                                  void (*finish)(BlockJob *, Error **errp),
385c8ab5c2dSPaolo Bonzini                                  Error **errp)
386c8ab5c2dSPaolo Bonzini {
387c8ab5c2dSPaolo Bonzini     Error *local_err = NULL;
388c8ab5c2dSPaolo Bonzini     int ret;
389c8ab5c2dSPaolo Bonzini 
390c8ab5c2dSPaolo Bonzini     assert(blk_bs(job->blk)->job == job);
391c8ab5c2dSPaolo Bonzini 
392c8ab5c2dSPaolo Bonzini     block_job_ref(job);
393c8ab5c2dSPaolo Bonzini 
3944fb588e9SPaolo Bonzini     if (finish) {
395c8ab5c2dSPaolo Bonzini         finish(job, &local_err);
3964fb588e9SPaolo Bonzini     }
397c8ab5c2dSPaolo Bonzini     if (local_err) {
398c8ab5c2dSPaolo Bonzini         error_propagate(errp, local_err);
399c8ab5c2dSPaolo Bonzini         block_job_unref(job);
400c8ab5c2dSPaolo Bonzini         return -EBUSY;
401c8ab5c2dSPaolo Bonzini     }
402c8ab5c2dSPaolo Bonzini     /* block_job_drain calls block_job_enter, and it should be enough to
403c8ab5c2dSPaolo Bonzini      * induce progress until the job completes or moves to the main thread.
404c8ab5c2dSPaolo Bonzini     */
405c8ab5c2dSPaolo Bonzini     while (!job->deferred_to_main_loop && !job->completed) {
406c8ab5c2dSPaolo Bonzini         block_job_drain(job);
407c8ab5c2dSPaolo Bonzini     }
408c8ab5c2dSPaolo Bonzini     while (!job->completed) {
409c8ab5c2dSPaolo Bonzini         aio_poll(qemu_get_aio_context(), true);
410c8ab5c2dSPaolo Bonzini     }
411c8ab5c2dSPaolo Bonzini     ret = (job->cancelled && job->ret == 0) ? -ECANCELED : job->ret;
412c8ab5c2dSPaolo Bonzini     block_job_unref(job);
413c8ab5c2dSPaolo Bonzini     return ret;
414c8ab5c2dSPaolo Bonzini }
415c8ab5c2dSPaolo Bonzini 
416c55a832fSFam Zheng static void block_job_completed_txn_abort(BlockJob *job)
417c55a832fSFam Zheng {
418c55a832fSFam Zheng     AioContext *ctx;
419c55a832fSFam Zheng     BlockJobTxn *txn = job->txn;
4204fb588e9SPaolo Bonzini     BlockJob *other_job;
421c55a832fSFam Zheng 
422c55a832fSFam Zheng     if (txn->aborting) {
423c55a832fSFam Zheng         /*
424c55a832fSFam Zheng          * We are cancelled by another job, which will handle everything.
425c55a832fSFam Zheng          */
426c55a832fSFam Zheng         return;
427c55a832fSFam Zheng     }
428c55a832fSFam Zheng     txn->aborting = true;
4294fb588e9SPaolo Bonzini     block_job_txn_ref(txn);
4304fb588e9SPaolo Bonzini 
431c55a832fSFam Zheng     /* We are the first failed job. Cancel other jobs. */
432c55a832fSFam Zheng     QLIST_FOREACH(other_job, &txn->jobs, txn_list) {
433b6d2e599SKevin Wolf         ctx = blk_get_aio_context(other_job->blk);
434c55a832fSFam Zheng         aio_context_acquire(ctx);
435c55a832fSFam Zheng     }
4364fb588e9SPaolo Bonzini 
4374fb588e9SPaolo Bonzini     /* Other jobs are effectively cancelled by us, set the status for
438c55a832fSFam Zheng      * them; this job, however, may or may not be cancelled, depending
439c55a832fSFam Zheng      * on the caller, so leave it. */
4404fb588e9SPaolo Bonzini     QLIST_FOREACH(other_job, &txn->jobs, txn_list) {
441c55a832fSFam Zheng         if (other_job != job) {
4424c241cf5SPaolo Bonzini             block_job_cancel_async(other_job);
443c55a832fSFam Zheng         }
444c55a832fSFam Zheng     }
4454fb588e9SPaolo Bonzini     while (!QLIST_EMPTY(&txn->jobs)) {
4464fb588e9SPaolo Bonzini         other_job = QLIST_FIRST(&txn->jobs);
447b6d2e599SKevin Wolf         ctx = blk_get_aio_context(other_job->blk);
4484fb588e9SPaolo Bonzini         if (!other_job->completed) {
4494fb588e9SPaolo Bonzini             assert(other_job->cancelled);
4504fb588e9SPaolo Bonzini             block_job_finish_sync(other_job, NULL, NULL);
4514fb588e9SPaolo Bonzini         }
452c55a832fSFam Zheng         block_job_completed_single(other_job);
453c55a832fSFam Zheng         aio_context_release(ctx);
454c55a832fSFam Zheng     }
4554fb588e9SPaolo Bonzini 
4564fb588e9SPaolo Bonzini     block_job_txn_unref(txn);
457c55a832fSFam Zheng }
458c55a832fSFam Zheng 
459c55a832fSFam Zheng static void block_job_completed_txn_success(BlockJob *job)
460c55a832fSFam Zheng {
461c55a832fSFam Zheng     AioContext *ctx;
462c55a832fSFam Zheng     BlockJobTxn *txn = job->txn;
463c55a832fSFam Zheng     BlockJob *other_job, *next;
464c55a832fSFam Zheng     /*
465c55a832fSFam Zheng      * Successful completion, see if there are other running jobs in this
466c55a832fSFam Zheng      * txn.
467c55a832fSFam Zheng      */
468c55a832fSFam Zheng     QLIST_FOREACH(other_job, &txn->jobs, txn_list) {
469c55a832fSFam Zheng         if (!other_job->completed) {
470c55a832fSFam Zheng             return;
471c55a832fSFam Zheng         }
472c55a832fSFam Zheng     }
473c55a832fSFam Zheng     /* We are the last completed job, commit the transaction. */
474c55a832fSFam Zheng     QLIST_FOREACH_SAFE(other_job, &txn->jobs, txn_list, next) {
475b6d2e599SKevin Wolf         ctx = blk_get_aio_context(other_job->blk);
476c55a832fSFam Zheng         aio_context_acquire(ctx);
477c55a832fSFam Zheng         assert(other_job->ret == 0);
478c55a832fSFam Zheng         block_job_completed_single(other_job);
479c55a832fSFam Zheng         aio_context_release(ctx);
480c55a832fSFam Zheng     }
481c55a832fSFam Zheng }
482c55a832fSFam Zheng 
4832f0c9fe6SPaolo Bonzini void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp)
4842f0c9fe6SPaolo Bonzini {
4852f0c9fe6SPaolo Bonzini     Error *local_err = NULL;
4862f0c9fe6SPaolo Bonzini 
4873fc4b10aSFam Zheng     if (!job->driver->set_speed) {
488c6bd8c70SMarkus Armbruster         error_setg(errp, QERR_UNSUPPORTED);
4892f0c9fe6SPaolo Bonzini         return;
4902f0c9fe6SPaolo Bonzini     }
4913fc4b10aSFam Zheng     job->driver->set_speed(job, speed, &local_err);
49284d18f06SMarkus Armbruster     if (local_err) {
4932f0c9fe6SPaolo Bonzini         error_propagate(errp, local_err);
4942f0c9fe6SPaolo Bonzini         return;
4952f0c9fe6SPaolo Bonzini     }
4962f0c9fe6SPaolo Bonzini 
4972f0c9fe6SPaolo Bonzini     job->speed = speed;
4982f0c9fe6SPaolo Bonzini }
4992f0c9fe6SPaolo Bonzini 
500aeae883bSPaolo Bonzini void block_job_complete(BlockJob *job, Error **errp)
501aeae883bSPaolo Bonzini {
502559b935fSJohn Snow     /* Should not be reachable via external interface for internal jobs */
503559b935fSJohn Snow     assert(job->id);
5045ccac6f1SJohn Snow     if (job->pause_count || job->cancelled ||
5055ccac6f1SJohn Snow         !block_job_started(job) || !job->driver->complete) {
5069df229c3SAlberto Garcia         error_setg(errp, "The active block job '%s' cannot be completed",
5079df229c3SAlberto Garcia                    job->id);
508aeae883bSPaolo Bonzini         return;
509aeae883bSPaolo Bonzini     }
510aeae883bSPaolo Bonzini 
5113fc4b10aSFam Zheng     job->driver->complete(job, errp);
512aeae883bSPaolo Bonzini }
513aeae883bSPaolo Bonzini 
5140df4ba58SJohn Snow void block_job_user_pause(BlockJob *job)
5150df4ba58SJohn Snow {
5160df4ba58SJohn Snow     job->user_paused = true;
5170df4ba58SJohn Snow     block_job_pause(job);
5180df4ba58SJohn Snow }
5190df4ba58SJohn Snow 
5200df4ba58SJohn Snow bool block_job_user_paused(BlockJob *job)
5210df4ba58SJohn Snow {
5226573d9c6SPaolo Bonzini     return job->user_paused;
5230df4ba58SJohn Snow }
5240df4ba58SJohn Snow 
5250df4ba58SJohn Snow void block_job_user_resume(BlockJob *job)
5260df4ba58SJohn Snow {
5270df4ba58SJohn Snow     if (job && job->user_paused && job->pause_count > 0) {
5282caf63a9SPaolo Bonzini         block_job_iostatus_reset(job);
5294c241cf5SPaolo Bonzini         job->user_paused = false;
5300df4ba58SJohn Snow         block_job_resume(job);
5310df4ba58SJohn Snow     }
5320df4ba58SJohn Snow }
5330df4ba58SJohn Snow 
5348acc72a4SPaolo Bonzini void block_job_cancel(BlockJob *job)
5358acc72a4SPaolo Bonzini {
5365ccac6f1SJohn Snow     if (block_job_started(job)) {
5374c241cf5SPaolo Bonzini         block_job_cancel_async(job);
538751ebd76SFam Zheng         block_job_enter(job);
5395ccac6f1SJohn Snow     } else {
5405ccac6f1SJohn Snow         block_job_completed(job, -ECANCELED);
5415ccac6f1SJohn Snow     }
5428acc72a4SPaolo Bonzini }
5438acc72a4SPaolo Bonzini 
544345f9e1bSMax Reitz /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be
545345f9e1bSMax Reitz  * used with block_job_finish_sync() without the need for (rather nasty)
546345f9e1bSMax Reitz  * function pointer casts there. */
547345f9e1bSMax Reitz static void block_job_cancel_err(BlockJob *job, Error **errp)
548345f9e1bSMax Reitz {
549345f9e1bSMax Reitz     block_job_cancel(job);
550345f9e1bSMax Reitz }
551345f9e1bSMax Reitz 
552345f9e1bSMax Reitz int block_job_cancel_sync(BlockJob *job)
553345f9e1bSMax Reitz {
554345f9e1bSMax Reitz     return block_job_finish_sync(job, &block_job_cancel_err, NULL);
555345f9e1bSMax Reitz }
556345f9e1bSMax Reitz 
557a1a2af07SKevin Wolf void block_job_cancel_sync_all(void)
558a1a2af07SKevin Wolf {
559a1a2af07SKevin Wolf     BlockJob *job;
560a1a2af07SKevin Wolf     AioContext *aio_context;
561a1a2af07SKevin Wolf 
562a1a2af07SKevin Wolf     while ((job = QLIST_FIRST(&block_jobs))) {
563b6d2e599SKevin Wolf         aio_context = blk_get_aio_context(job->blk);
564a1a2af07SKevin Wolf         aio_context_acquire(aio_context);
565a1a2af07SKevin Wolf         block_job_cancel_sync(job);
566a1a2af07SKevin Wolf         aio_context_release(aio_context);
567a1a2af07SKevin Wolf     }
568a1a2af07SKevin Wolf }
569a1a2af07SKevin Wolf 
570345f9e1bSMax Reitz int block_job_complete_sync(BlockJob *job, Error **errp)
571345f9e1bSMax Reitz {
572345f9e1bSMax Reitz     return block_job_finish_sync(job, &block_job_complete, errp);
573345f9e1bSMax Reitz }
574345f9e1bSMax Reitz 
575559b935fSJohn Snow BlockJobInfo *block_job_query(BlockJob *job, Error **errp)
57630e628b7SPaolo Bonzini {
577559b935fSJohn Snow     BlockJobInfo *info;
578559b935fSJohn Snow 
579559b935fSJohn Snow     if (block_job_is_internal(job)) {
580559b935fSJohn Snow         error_setg(errp, "Cannot query QEMU internal jobs");
581559b935fSJohn Snow         return NULL;
582559b935fSJohn Snow     }
583559b935fSJohn Snow     info = g_new0(BlockJobInfo, 1);
584977c736fSMarkus Armbruster     info->type      = g_strdup(BlockJobType_str(job->driver->job_type));
5858ccb9569SKevin Wolf     info->device    = g_strdup(job->id);
58630e628b7SPaolo Bonzini     info->len       = job->len;
587*fc24908eSPaolo Bonzini     info->busy      = atomic_read(&job->busy);
588751ebd76SFam Zheng     info->paused    = job->pause_count > 0;
58930e628b7SPaolo Bonzini     info->offset    = job->offset;
59030e628b7SPaolo Bonzini     info->speed     = job->speed;
59132c81a4aSPaolo Bonzini     info->io_status = job->iostatus;
592ef6dbf1eSMax Reitz     info->ready     = job->ready;
59330e628b7SPaolo Bonzini     return info;
59430e628b7SPaolo Bonzini }
59532c81a4aSPaolo Bonzini 
59632c81a4aSPaolo Bonzini static void block_job_iostatus_set_err(BlockJob *job, int error)
59732c81a4aSPaolo Bonzini {
59832c81a4aSPaolo Bonzini     if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
59932c81a4aSPaolo Bonzini         job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
60032c81a4aSPaolo Bonzini                                           BLOCK_DEVICE_IO_STATUS_FAILED;
60132c81a4aSPaolo Bonzini     }
60232c81a4aSPaolo Bonzini }
60332c81a4aSPaolo Bonzini 
6048254b6d9SJohn Snow static void block_job_event_cancelled(BlockJob *job)
605a66a2a36SPaolo Bonzini {
606559b935fSJohn Snow     if (block_job_is_internal(job)) {
607559b935fSJohn Snow         return;
608559b935fSJohn Snow     }
609559b935fSJohn Snow 
610bcada37bSWenchao Xia     qapi_event_send_block_job_cancelled(job->driver->job_type,
6118ccb9569SKevin Wolf                                         job->id,
612a66a2a36SPaolo Bonzini                                         job->len,
613a66a2a36SPaolo Bonzini                                         job->offset,
614bcada37bSWenchao Xia                                         job->speed,
615bcada37bSWenchao Xia                                         &error_abort);
616a66a2a36SPaolo Bonzini }
617a66a2a36SPaolo Bonzini 
6188254b6d9SJohn Snow static void block_job_event_completed(BlockJob *job, const char *msg)
619a66a2a36SPaolo Bonzini {
620559b935fSJohn Snow     if (block_job_is_internal(job)) {
621559b935fSJohn Snow         return;
622559b935fSJohn Snow     }
623559b935fSJohn Snow 
624bcada37bSWenchao Xia     qapi_event_send_block_job_completed(job->driver->job_type,
6258ccb9569SKevin Wolf                                         job->id,
626bcada37bSWenchao Xia                                         job->len,
627bcada37bSWenchao Xia                                         job->offset,
628bcada37bSWenchao Xia                                         job->speed,
629bcada37bSWenchao Xia                                         !!msg,
630bcada37bSWenchao Xia                                         msg,
631bcada37bSWenchao Xia                                         &error_abort);
632bcada37bSWenchao Xia }
633bcada37bSWenchao Xia 
63488691b37SPaolo Bonzini /*
63588691b37SPaolo Bonzini  * API for block job drivers and the block layer.  These functions are
63688691b37SPaolo Bonzini  * declared in blockjob_int.h.
63788691b37SPaolo Bonzini  */
63888691b37SPaolo Bonzini 
63988691b37SPaolo Bonzini void *block_job_create(const char *job_id, const BlockJobDriver *driver,
64088691b37SPaolo Bonzini                        BlockDriverState *bs, uint64_t perm,
64188691b37SPaolo Bonzini                        uint64_t shared_perm, int64_t speed, int flags,
64288691b37SPaolo Bonzini                        BlockCompletionFunc *cb, void *opaque, Error **errp)
64388691b37SPaolo Bonzini {
64488691b37SPaolo Bonzini     BlockBackend *blk;
64588691b37SPaolo Bonzini     BlockJob *job;
64688691b37SPaolo Bonzini     int ret;
64788691b37SPaolo Bonzini 
64888691b37SPaolo Bonzini     if (bs->job) {
64988691b37SPaolo Bonzini         error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs));
65088691b37SPaolo Bonzini         return NULL;
65188691b37SPaolo Bonzini     }
65288691b37SPaolo Bonzini 
65388691b37SPaolo Bonzini     if (job_id == NULL && !(flags & BLOCK_JOB_INTERNAL)) {
65488691b37SPaolo Bonzini         job_id = bdrv_get_device_name(bs);
65588691b37SPaolo Bonzini         if (!*job_id) {
65688691b37SPaolo Bonzini             error_setg(errp, "An explicit job ID is required for this node");
65788691b37SPaolo Bonzini             return NULL;
65888691b37SPaolo Bonzini         }
65988691b37SPaolo Bonzini     }
66088691b37SPaolo Bonzini 
66188691b37SPaolo Bonzini     if (job_id) {
66288691b37SPaolo Bonzini         if (flags & BLOCK_JOB_INTERNAL) {
66388691b37SPaolo Bonzini             error_setg(errp, "Cannot specify job ID for internal block job");
66488691b37SPaolo Bonzini             return NULL;
66588691b37SPaolo Bonzini         }
66688691b37SPaolo Bonzini 
66788691b37SPaolo Bonzini         if (!id_wellformed(job_id)) {
66888691b37SPaolo Bonzini             error_setg(errp, "Invalid job ID '%s'", job_id);
66988691b37SPaolo Bonzini             return NULL;
67088691b37SPaolo Bonzini         }
67188691b37SPaolo Bonzini 
67288691b37SPaolo Bonzini         if (block_job_get(job_id)) {
67388691b37SPaolo Bonzini             error_setg(errp, "Job ID '%s' already in use", job_id);
67488691b37SPaolo Bonzini             return NULL;
67588691b37SPaolo Bonzini         }
67688691b37SPaolo Bonzini     }
67788691b37SPaolo Bonzini 
67888691b37SPaolo Bonzini     blk = blk_new(perm, shared_perm);
67988691b37SPaolo Bonzini     ret = blk_insert_bs(blk, bs, errp);
68088691b37SPaolo Bonzini     if (ret < 0) {
68188691b37SPaolo Bonzini         blk_unref(blk);
68288691b37SPaolo Bonzini         return NULL;
68388691b37SPaolo Bonzini     }
68488691b37SPaolo Bonzini 
68588691b37SPaolo Bonzini     job = g_malloc0(driver->instance_size);
68688691b37SPaolo Bonzini     job->driver        = driver;
68788691b37SPaolo Bonzini     job->id            = g_strdup(job_id);
68888691b37SPaolo Bonzini     job->blk           = blk;
68988691b37SPaolo Bonzini     job->cb            = cb;
69088691b37SPaolo Bonzini     job->opaque        = opaque;
69188691b37SPaolo Bonzini     job->busy          = false;
69288691b37SPaolo Bonzini     job->paused        = true;
69388691b37SPaolo Bonzini     job->pause_count   = 1;
69488691b37SPaolo Bonzini     job->refcnt        = 1;
695*fc24908eSPaolo Bonzini     aio_timer_init(qemu_get_aio_context(), &job->sleep_timer,
696*fc24908eSPaolo Bonzini                    QEMU_CLOCK_REALTIME, SCALE_NS,
697*fc24908eSPaolo Bonzini                    block_job_sleep_timer_cb, job);
69888691b37SPaolo Bonzini 
69988691b37SPaolo Bonzini     error_setg(&job->blocker, "block device is in use by block job: %s",
700977c736fSMarkus Armbruster                BlockJobType_str(driver->job_type));
70188691b37SPaolo Bonzini     block_job_add_bdrv(job, "main node", bs, 0, BLK_PERM_ALL, &error_abort);
70288691b37SPaolo Bonzini     bs->job = job;
70388691b37SPaolo Bonzini 
70488691b37SPaolo Bonzini     blk_set_dev_ops(blk, &block_job_dev_ops, job);
70588691b37SPaolo Bonzini     bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker);
70688691b37SPaolo Bonzini 
70788691b37SPaolo Bonzini     QLIST_INSERT_HEAD(&block_jobs, job, job_list);
70888691b37SPaolo Bonzini 
70988691b37SPaolo Bonzini     blk_add_aio_context_notifier(blk, block_job_attached_aio_context,
71088691b37SPaolo Bonzini                                  block_job_detach_aio_context, job);
71188691b37SPaolo Bonzini 
71288691b37SPaolo Bonzini     /* Only set speed when necessary to avoid NotSupported error */
71388691b37SPaolo Bonzini     if (speed != 0) {
71488691b37SPaolo Bonzini         Error *local_err = NULL;
71588691b37SPaolo Bonzini 
71688691b37SPaolo Bonzini         block_job_set_speed(job, speed, &local_err);
71788691b37SPaolo Bonzini         if (local_err) {
71888691b37SPaolo Bonzini             block_job_unref(job);
71988691b37SPaolo Bonzini             error_propagate(errp, local_err);
72088691b37SPaolo Bonzini             return NULL;
72188691b37SPaolo Bonzini         }
72288691b37SPaolo Bonzini     }
72388691b37SPaolo Bonzini     return job;
72488691b37SPaolo Bonzini }
72588691b37SPaolo Bonzini 
726f321dcb5SPaolo Bonzini void block_job_pause_all(void)
727f321dcb5SPaolo Bonzini {
728f321dcb5SPaolo Bonzini     BlockJob *job = NULL;
729f321dcb5SPaolo Bonzini     while ((job = block_job_next(job))) {
730f321dcb5SPaolo Bonzini         AioContext *aio_context = blk_get_aio_context(job->blk);
731f321dcb5SPaolo Bonzini 
732f321dcb5SPaolo Bonzini         aio_context_acquire(aio_context);
733f321dcb5SPaolo Bonzini         block_job_pause(job);
734f321dcb5SPaolo Bonzini         aio_context_release(aio_context);
735f321dcb5SPaolo Bonzini     }
736f321dcb5SPaolo Bonzini }
737f321dcb5SPaolo Bonzini 
73888691b37SPaolo Bonzini void block_job_early_fail(BlockJob *job)
73988691b37SPaolo Bonzini {
74088691b37SPaolo Bonzini     block_job_unref(job);
74188691b37SPaolo Bonzini }
74288691b37SPaolo Bonzini 
74388691b37SPaolo Bonzini void block_job_completed(BlockJob *job, int ret)
74488691b37SPaolo Bonzini {
74588691b37SPaolo Bonzini     assert(blk_bs(job->blk)->job == job);
74688691b37SPaolo Bonzini     assert(!job->completed);
74788691b37SPaolo Bonzini     job->completed = true;
74888691b37SPaolo Bonzini     job->ret = ret;
74988691b37SPaolo Bonzini     if (!job->txn) {
75088691b37SPaolo Bonzini         block_job_completed_single(job);
75188691b37SPaolo Bonzini     } else if (ret < 0 || block_job_is_cancelled(job)) {
75288691b37SPaolo Bonzini         block_job_completed_txn_abort(job);
75388691b37SPaolo Bonzini     } else {
75488691b37SPaolo Bonzini         block_job_completed_txn_success(job);
75588691b37SPaolo Bonzini     }
75688691b37SPaolo Bonzini }
75788691b37SPaolo Bonzini 
75888691b37SPaolo Bonzini static bool block_job_should_pause(BlockJob *job)
75988691b37SPaolo Bonzini {
76088691b37SPaolo Bonzini     return job->pause_count > 0;
76188691b37SPaolo Bonzini }
76288691b37SPaolo Bonzini 
763*fc24908eSPaolo Bonzini /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds.
764*fc24908eSPaolo Bonzini  * Reentering the job coroutine with block_job_enter() before the timer has
765*fc24908eSPaolo Bonzini  * expired is allowed and cancels the timer.
766*fc24908eSPaolo Bonzini  *
767*fc24908eSPaolo Bonzini  * If @ns is (uint64_t) -1, no timer is scheduled and block_job_enter() must be
768*fc24908eSPaolo Bonzini  * called explicitly. */
769*fc24908eSPaolo Bonzini static void block_job_do_yield(BlockJob *job, uint64_t ns)
770356f59b8SPaolo Bonzini {
771*fc24908eSPaolo Bonzini     block_job_lock();
772*fc24908eSPaolo Bonzini     if (ns != -1) {
773*fc24908eSPaolo Bonzini         timer_mod(&job->sleep_timer, ns);
774*fc24908eSPaolo Bonzini     }
775356f59b8SPaolo Bonzini     job->busy = false;
776*fc24908eSPaolo Bonzini     block_job_unlock();
777356f59b8SPaolo Bonzini     qemu_coroutine_yield();
778356f59b8SPaolo Bonzini 
779356f59b8SPaolo Bonzini     /* Set by block_job_enter before re-entering the coroutine.  */
780356f59b8SPaolo Bonzini     assert(job->busy);
781356f59b8SPaolo Bonzini }
782356f59b8SPaolo Bonzini 
78388691b37SPaolo Bonzini void coroutine_fn block_job_pause_point(BlockJob *job)
78488691b37SPaolo Bonzini {
78588691b37SPaolo Bonzini     assert(job && block_job_started(job));
78688691b37SPaolo Bonzini 
78788691b37SPaolo Bonzini     if (!block_job_should_pause(job)) {
78888691b37SPaolo Bonzini         return;
78988691b37SPaolo Bonzini     }
79088691b37SPaolo Bonzini     if (block_job_is_cancelled(job)) {
79188691b37SPaolo Bonzini         return;
79288691b37SPaolo Bonzini     }
79388691b37SPaolo Bonzini 
79488691b37SPaolo Bonzini     if (job->driver->pause) {
79588691b37SPaolo Bonzini         job->driver->pause(job);
79688691b37SPaolo Bonzini     }
79788691b37SPaolo Bonzini 
79888691b37SPaolo Bonzini     if (block_job_should_pause(job) && !block_job_is_cancelled(job)) {
79988691b37SPaolo Bonzini         job->paused = true;
800*fc24908eSPaolo Bonzini         block_job_do_yield(job, -1);
80188691b37SPaolo Bonzini         job->paused = false;
80288691b37SPaolo Bonzini     }
80388691b37SPaolo Bonzini 
80488691b37SPaolo Bonzini     if (job->driver->resume) {
80588691b37SPaolo Bonzini         job->driver->resume(job);
80688691b37SPaolo Bonzini     }
80788691b37SPaolo Bonzini }
80888691b37SPaolo Bonzini 
809f321dcb5SPaolo Bonzini void block_job_resume_all(void)
810f321dcb5SPaolo Bonzini {
811f321dcb5SPaolo Bonzini     BlockJob *job = NULL;
812f321dcb5SPaolo Bonzini     while ((job = block_job_next(job))) {
813f321dcb5SPaolo Bonzini         AioContext *aio_context = blk_get_aio_context(job->blk);
814f321dcb5SPaolo Bonzini 
815f321dcb5SPaolo Bonzini         aio_context_acquire(aio_context);
816f321dcb5SPaolo Bonzini         block_job_resume(job);
817f321dcb5SPaolo Bonzini         aio_context_release(aio_context);
818f321dcb5SPaolo Bonzini     }
819f321dcb5SPaolo Bonzini }
820f321dcb5SPaolo Bonzini 
82188691b37SPaolo Bonzini void block_job_enter(BlockJob *job)
82288691b37SPaolo Bonzini {
823eb05e011SPaolo Bonzini     if (!block_job_started(job)) {
824eb05e011SPaolo Bonzini         return;
825eb05e011SPaolo Bonzini     }
826eb05e011SPaolo Bonzini     if (job->deferred_to_main_loop) {
827eb05e011SPaolo Bonzini         return;
828eb05e011SPaolo Bonzini     }
829eb05e011SPaolo Bonzini 
830*fc24908eSPaolo Bonzini     block_job_lock();
831356f59b8SPaolo Bonzini     if (job->busy) {
832*fc24908eSPaolo Bonzini         block_job_unlock();
833356f59b8SPaolo Bonzini         return;
83488691b37SPaolo Bonzini     }
835356f59b8SPaolo Bonzini 
836*fc24908eSPaolo Bonzini     assert(!job->deferred_to_main_loop);
837*fc24908eSPaolo Bonzini     timer_del(&job->sleep_timer);
838356f59b8SPaolo Bonzini     job->busy = true;
839*fc24908eSPaolo Bonzini     block_job_unlock();
840356f59b8SPaolo Bonzini     aio_co_wake(job->co);
84188691b37SPaolo Bonzini }
84288691b37SPaolo Bonzini 
84388691b37SPaolo Bonzini bool block_job_is_cancelled(BlockJob *job)
84488691b37SPaolo Bonzini {
84588691b37SPaolo Bonzini     return job->cancelled;
84688691b37SPaolo Bonzini }
84788691b37SPaolo Bonzini 
8485bf1d5a7SPaolo Bonzini void block_job_sleep_ns(BlockJob *job, int64_t ns)
84988691b37SPaolo Bonzini {
85088691b37SPaolo Bonzini     assert(job->busy);
85188691b37SPaolo Bonzini 
85288691b37SPaolo Bonzini     /* Check cancellation *before* setting busy = false, too!  */
85388691b37SPaolo Bonzini     if (block_job_is_cancelled(job)) {
85488691b37SPaolo Bonzini         return;
85588691b37SPaolo Bonzini     }
85688691b37SPaolo Bonzini 
85788691b37SPaolo Bonzini     if (!block_job_should_pause(job)) {
858*fc24908eSPaolo Bonzini         block_job_do_yield(job, qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + ns);
85988691b37SPaolo Bonzini     }
86088691b37SPaolo Bonzini 
86188691b37SPaolo Bonzini     block_job_pause_point(job);
86288691b37SPaolo Bonzini }
86388691b37SPaolo Bonzini 
86488691b37SPaolo Bonzini void block_job_yield(BlockJob *job)
86588691b37SPaolo Bonzini {
86688691b37SPaolo Bonzini     assert(job->busy);
86788691b37SPaolo Bonzini 
86888691b37SPaolo Bonzini     /* Check cancellation *before* setting busy = false, too!  */
86988691b37SPaolo Bonzini     if (block_job_is_cancelled(job)) {
87088691b37SPaolo Bonzini         return;
87188691b37SPaolo Bonzini     }
87288691b37SPaolo Bonzini 
87388691b37SPaolo Bonzini     if (!block_job_should_pause(job)) {
874*fc24908eSPaolo Bonzini         block_job_do_yield(job, -1);
87588691b37SPaolo Bonzini     }
87688691b37SPaolo Bonzini 
87788691b37SPaolo Bonzini     block_job_pause_point(job);
87888691b37SPaolo Bonzini }
87988691b37SPaolo Bonzini 
8802caf63a9SPaolo Bonzini void block_job_iostatus_reset(BlockJob *job)
8812caf63a9SPaolo Bonzini {
8824c241cf5SPaolo Bonzini     if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
8834c241cf5SPaolo Bonzini         return;
8844c241cf5SPaolo Bonzini     }
8854c241cf5SPaolo Bonzini     assert(job->user_paused && job->pause_count > 0);
8862caf63a9SPaolo Bonzini     job->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
8872caf63a9SPaolo Bonzini }
8882caf63a9SPaolo Bonzini 
889bcada37bSWenchao Xia void block_job_event_ready(BlockJob *job)
890bcada37bSWenchao Xia {
891ef6dbf1eSMax Reitz     job->ready = true;
892ef6dbf1eSMax Reitz 
893559b935fSJohn Snow     if (block_job_is_internal(job)) {
894559b935fSJohn Snow         return;
895559b935fSJohn Snow     }
896559b935fSJohn Snow 
897518848a2SMarkus Armbruster     qapi_event_send_block_job_ready(job->driver->job_type,
8988ccb9569SKevin Wolf                                     job->id,
899518848a2SMarkus Armbruster                                     job->len,
900518848a2SMarkus Armbruster                                     job->offset,
901518848a2SMarkus Armbruster                                     job->speed, &error_abort);
902a66a2a36SPaolo Bonzini }
903a66a2a36SPaolo Bonzini 
90481e254dcSKevin Wolf BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err,
90532c81a4aSPaolo Bonzini                                         int is_read, int error)
90632c81a4aSPaolo Bonzini {
90732c81a4aSPaolo Bonzini     BlockErrorAction action;
90832c81a4aSPaolo Bonzini 
90932c81a4aSPaolo Bonzini     switch (on_err) {
91032c81a4aSPaolo Bonzini     case BLOCKDEV_ON_ERROR_ENOSPC:
9118c398252SKevin Wolf     case BLOCKDEV_ON_ERROR_AUTO:
912a589569fSWenchao Xia         action = (error == ENOSPC) ?
913a589569fSWenchao Xia                  BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT;
91432c81a4aSPaolo Bonzini         break;
91532c81a4aSPaolo Bonzini     case BLOCKDEV_ON_ERROR_STOP:
916a589569fSWenchao Xia         action = BLOCK_ERROR_ACTION_STOP;
91732c81a4aSPaolo Bonzini         break;
91832c81a4aSPaolo Bonzini     case BLOCKDEV_ON_ERROR_REPORT:
919a589569fSWenchao Xia         action = BLOCK_ERROR_ACTION_REPORT;
92032c81a4aSPaolo Bonzini         break;
92132c81a4aSPaolo Bonzini     case BLOCKDEV_ON_ERROR_IGNORE:
922a589569fSWenchao Xia         action = BLOCK_ERROR_ACTION_IGNORE;
92332c81a4aSPaolo Bonzini         break;
92432c81a4aSPaolo Bonzini     default:
92532c81a4aSPaolo Bonzini         abort();
92632c81a4aSPaolo Bonzini     }
927559b935fSJohn Snow     if (!block_job_is_internal(job)) {
9288ccb9569SKevin Wolf         qapi_event_send_block_job_error(job->id,
9295a2d2cbdSWenchao Xia                                         is_read ? IO_OPERATION_TYPE_READ :
9305a2d2cbdSWenchao Xia                                         IO_OPERATION_TYPE_WRITE,
9315a2d2cbdSWenchao Xia                                         action, &error_abort);
932559b935fSJohn Snow     }
933a589569fSWenchao Xia     if (action == BLOCK_ERROR_ACTION_STOP) {
934751ebd76SFam Zheng         /* make the pause user visible, which will be resumed from QMP. */
9350df4ba58SJohn Snow         block_job_user_pause(job);
93632c81a4aSPaolo Bonzini         block_job_iostatus_set_err(job, error);
93732c81a4aSPaolo Bonzini     }
93832c81a4aSPaolo Bonzini     return action;
93932c81a4aSPaolo Bonzini }
940dec7d421SStefan Hajnoczi 
941dec7d421SStefan Hajnoczi typedef struct {
942dec7d421SStefan Hajnoczi     BlockJob *job;
943dec7d421SStefan Hajnoczi     AioContext *aio_context;
944dec7d421SStefan Hajnoczi     BlockJobDeferToMainLoopFn *fn;
945dec7d421SStefan Hajnoczi     void *opaque;
946dec7d421SStefan Hajnoczi } BlockJobDeferToMainLoopData;
947dec7d421SStefan Hajnoczi 
948dec7d421SStefan Hajnoczi static void block_job_defer_to_main_loop_bh(void *opaque)
949dec7d421SStefan Hajnoczi {
950dec7d421SStefan Hajnoczi     BlockJobDeferToMainLoopData *data = opaque;
951dec7d421SStefan Hajnoczi     AioContext *aio_context;
952dec7d421SStefan Hajnoczi 
953dec7d421SStefan Hajnoczi     /* Prevent race with block_job_defer_to_main_loop() */
954dec7d421SStefan Hajnoczi     aio_context_acquire(data->aio_context);
955dec7d421SStefan Hajnoczi 
956dec7d421SStefan Hajnoczi     /* Fetch BDS AioContext again, in case it has changed */
957b6d2e599SKevin Wolf     aio_context = blk_get_aio_context(data->job->blk);
958d79df2a2SPaolo Bonzini     if (aio_context != data->aio_context) {
959dec7d421SStefan Hajnoczi         aio_context_acquire(aio_context);
960d79df2a2SPaolo Bonzini     }
961dec7d421SStefan Hajnoczi 
962dec7d421SStefan Hajnoczi     data->fn(data->job, data->opaque);
963dec7d421SStefan Hajnoczi 
964d79df2a2SPaolo Bonzini     if (aio_context != data->aio_context) {
965dec7d421SStefan Hajnoczi         aio_context_release(aio_context);
966d79df2a2SPaolo Bonzini     }
967dec7d421SStefan Hajnoczi 
968dec7d421SStefan Hajnoczi     aio_context_release(data->aio_context);
969dec7d421SStefan Hajnoczi 
970dec7d421SStefan Hajnoczi     g_free(data);
971dec7d421SStefan Hajnoczi }
972dec7d421SStefan Hajnoczi 
973dec7d421SStefan Hajnoczi void block_job_defer_to_main_loop(BlockJob *job,
974dec7d421SStefan Hajnoczi                                   BlockJobDeferToMainLoopFn *fn,
975dec7d421SStefan Hajnoczi                                   void *opaque)
976dec7d421SStefan Hajnoczi {
977dec7d421SStefan Hajnoczi     BlockJobDeferToMainLoopData *data = g_malloc(sizeof(*data));
978dec7d421SStefan Hajnoczi     data->job = job;
979b6d2e599SKevin Wolf     data->aio_context = blk_get_aio_context(job->blk);
980dec7d421SStefan Hajnoczi     data->fn = fn;
981dec7d421SStefan Hajnoczi     data->opaque = opaque;
982794f0141SFam Zheng     job->deferred_to_main_loop = true;
983dec7d421SStefan Hajnoczi 
984fffb6e12SPaolo Bonzini     aio_bh_schedule_oneshot(qemu_get_aio_context(),
985fffb6e12SPaolo Bonzini                             block_job_defer_to_main_loop_bh, data);
986dec7d421SStefan Hajnoczi }
987