xref: /qemu/blockjob.c (revision 4ad35181)
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"
31c9de4050SJohn Snow #include "block/trace.h"
32373340b2SMax Reitz #include "sysemu/block-backend.h"
33e688df6bSMarkus Armbruster #include "qapi/error.h"
349af23989SMarkus Armbruster #include "qapi/qapi-events-block-core.h"
35cc7a8ea7SMarkus Armbruster #include "qapi/qmp/qerror.h"
3610817bf0SDaniel P. Berrange #include "qemu/coroutine.h"
371de7afc9SPaolo Bonzini #include "qemu/timer.h"
382f0c9fe6SPaolo Bonzini 
39c55a832fSFam Zheng /* Transactional group of block jobs */
40c55a832fSFam Zheng struct BlockJobTxn {
41c55a832fSFam Zheng 
42c55a832fSFam Zheng     /* Is this txn being cancelled? */
43c55a832fSFam Zheng     bool aborting;
44c55a832fSFam Zheng 
45c55a832fSFam Zheng     /* List of jobs */
46c55a832fSFam Zheng     QLIST_HEAD(, BlockJob) jobs;
47c55a832fSFam Zheng 
48c55a832fSFam Zheng     /* Reference count */
49c55a832fSFam Zheng     int refcnt;
50c55a832fSFam Zheng };
51c55a832fSFam Zheng 
5288691b37SPaolo Bonzini /*
5388691b37SPaolo Bonzini  * The block job API is composed of two categories of functions.
5488691b37SPaolo Bonzini  *
5588691b37SPaolo Bonzini  * The first includes functions used by the monitor.  The monitor is
5688691b37SPaolo Bonzini  * peculiar in that it accesses the block job list with block_job_get, and
5788691b37SPaolo Bonzini  * therefore needs consistency across block_job_get and the actual operation
5888691b37SPaolo Bonzini  * (e.g. block_job_set_speed).  The consistency is achieved with
5988691b37SPaolo Bonzini  * aio_context_acquire/release.  These functions are declared in blockjob.h.
6088691b37SPaolo Bonzini  *
6188691b37SPaolo Bonzini  * The second includes functions used by the block job drivers and sometimes
6288691b37SPaolo Bonzini  * by the core block layer.  These do not care about locking, because the
6388691b37SPaolo Bonzini  * whole coroutine runs under the AioContext lock, and are declared in
6488691b37SPaolo Bonzini  * blockjob_int.h.
6588691b37SPaolo Bonzini  */
6688691b37SPaolo Bonzini 
67e7c1d78bSKevin Wolf static bool is_block_job(Job *job)
68a7112795SAlberto Garcia {
69e7c1d78bSKevin Wolf     return job_type(job) == JOB_TYPE_BACKUP ||
70e7c1d78bSKevin Wolf            job_type(job) == JOB_TYPE_COMMIT ||
71e7c1d78bSKevin Wolf            job_type(job) == JOB_TYPE_MIRROR ||
72e7c1d78bSKevin Wolf            job_type(job) == JOB_TYPE_STREAM;
73a7112795SAlberto Garcia }
74e7c1d78bSKevin Wolf 
75e7c1d78bSKevin Wolf BlockJob *block_job_next(BlockJob *bjob)
76e7c1d78bSKevin Wolf {
77e7c1d78bSKevin Wolf     Job *job = bjob ? &bjob->job : NULL;
78e7c1d78bSKevin Wolf 
79e7c1d78bSKevin Wolf     do {
80e7c1d78bSKevin Wolf         job = job_next(job);
81e7c1d78bSKevin Wolf     } while (job && !is_block_job(job));
82e7c1d78bSKevin Wolf 
83e7c1d78bSKevin Wolf     return job ? container_of(job, BlockJob, job) : NULL;
84a7112795SAlberto Garcia }
85a7112795SAlberto Garcia 
86ffb1f10cSAlberto Garcia BlockJob *block_job_get(const char *id)
87ffb1f10cSAlberto Garcia {
88e7c1d78bSKevin Wolf     Job *job = job_get(id);
89ffb1f10cSAlberto Garcia 
90e7c1d78bSKevin Wolf     if (job && is_block_job(job)) {
91e7c1d78bSKevin Wolf         return container_of(job, BlockJob, job);
92e7c1d78bSKevin Wolf     } else {
93ffb1f10cSAlberto Garcia         return NULL;
94ffb1f10cSAlberto Garcia     }
95e7c1d78bSKevin Wolf }
96ffb1f10cSAlberto Garcia 
97c8ab5c2dSPaolo Bonzini BlockJobTxn *block_job_txn_new(void)
98c8ab5c2dSPaolo Bonzini {
99c8ab5c2dSPaolo Bonzini     BlockJobTxn *txn = g_new0(BlockJobTxn, 1);
100c8ab5c2dSPaolo Bonzini     QLIST_INIT(&txn->jobs);
101c8ab5c2dSPaolo Bonzini     txn->refcnt = 1;
102c8ab5c2dSPaolo Bonzini     return txn;
103c8ab5c2dSPaolo Bonzini }
104c8ab5c2dSPaolo Bonzini 
105c8ab5c2dSPaolo Bonzini static void block_job_txn_ref(BlockJobTxn *txn)
106c8ab5c2dSPaolo Bonzini {
107c8ab5c2dSPaolo Bonzini     txn->refcnt++;
108c8ab5c2dSPaolo Bonzini }
109c8ab5c2dSPaolo Bonzini 
110c8ab5c2dSPaolo Bonzini void block_job_txn_unref(BlockJobTxn *txn)
111c8ab5c2dSPaolo Bonzini {
112c8ab5c2dSPaolo Bonzini     if (txn && --txn->refcnt == 0) {
113c8ab5c2dSPaolo Bonzini         g_free(txn);
114c8ab5c2dSPaolo Bonzini     }
115c8ab5c2dSPaolo Bonzini }
116c8ab5c2dSPaolo Bonzini 
117c8ab5c2dSPaolo Bonzini void block_job_txn_add_job(BlockJobTxn *txn, BlockJob *job)
118c8ab5c2dSPaolo Bonzini {
119c8ab5c2dSPaolo Bonzini     if (!txn) {
120c8ab5c2dSPaolo Bonzini         return;
121c8ab5c2dSPaolo Bonzini     }
122c8ab5c2dSPaolo Bonzini 
123c8ab5c2dSPaolo Bonzini     assert(!job->txn);
124c8ab5c2dSPaolo Bonzini     job->txn = txn;
125c8ab5c2dSPaolo Bonzini 
126c8ab5c2dSPaolo Bonzini     QLIST_INSERT_HEAD(&txn->jobs, job, txn_list);
127c8ab5c2dSPaolo Bonzini     block_job_txn_ref(txn);
128c8ab5c2dSPaolo Bonzini }
129c8ab5c2dSPaolo Bonzini 
130*4ad35181SKevin Wolf void block_job_txn_del_job(BlockJob *job)
131a865cebbSMarc-André Lureau {
132a865cebbSMarc-André Lureau     if (job->txn) {
133a865cebbSMarc-André Lureau         QLIST_REMOVE(job, txn_list);
134a865cebbSMarc-André Lureau         block_job_txn_unref(job->txn);
135a865cebbSMarc-André Lureau         job->txn = NULL;
136a865cebbSMarc-André Lureau     }
137a865cebbSMarc-André Lureau }
138a865cebbSMarc-André Lureau 
13905b0d8e3SPaolo Bonzini static void block_job_attached_aio_context(AioContext *new_context,
14005b0d8e3SPaolo Bonzini                                            void *opaque);
14105b0d8e3SPaolo Bonzini static void block_job_detach_aio_context(void *opaque);
14205b0d8e3SPaolo Bonzini 
14380fa2c75SKevin Wolf void block_job_free(Job *job)
14405b0d8e3SPaolo Bonzini {
14580fa2c75SKevin Wolf     BlockJob *bjob = container_of(job, BlockJob, job);
14680fa2c75SKevin Wolf     BlockDriverState *bs = blk_bs(bjob->blk);
14780fa2c75SKevin Wolf 
14880fa2c75SKevin Wolf     assert(!bjob->txn);
14980fa2c75SKevin Wolf 
15005b0d8e3SPaolo Bonzini     bs->job = NULL;
15180fa2c75SKevin Wolf     block_job_remove_all_bdrv(bjob);
15280fa2c75SKevin Wolf     blk_remove_aio_context_notifier(bjob->blk,
15305b0d8e3SPaolo Bonzini                                     block_job_attached_aio_context,
15480fa2c75SKevin Wolf                                     block_job_detach_aio_context, bjob);
15580fa2c75SKevin Wolf     blk_unref(bjob->blk);
15680fa2c75SKevin Wolf     error_free(bjob->blocker);
15705b0d8e3SPaolo Bonzini }
15805b0d8e3SPaolo Bonzini 
159463e0be1SStefan Hajnoczi static void block_job_attached_aio_context(AioContext *new_context,
160463e0be1SStefan Hajnoczi                                            void *opaque)
161463e0be1SStefan Hajnoczi {
162463e0be1SStefan Hajnoczi     BlockJob *job = opaque;
163463e0be1SStefan Hajnoczi 
16408be6fe2SKevin Wolf     job->job.aio_context = new_context;
165463e0be1SStefan Hajnoczi     if (job->driver->attached_aio_context) {
166463e0be1SStefan Hajnoczi         job->driver->attached_aio_context(job, new_context);
167463e0be1SStefan Hajnoczi     }
168463e0be1SStefan Hajnoczi 
169b15de828SKevin Wolf     job_resume(&job->job);
170463e0be1SStefan Hajnoczi }
171463e0be1SStefan Hajnoczi 
172bae8196dSPaolo Bonzini static void block_job_drain(BlockJob *job)
173bae8196dSPaolo Bonzini {
174da01ff7fSKevin Wolf     /* If job is !job->job.busy this kicks it into the next pause point. */
175bae8196dSPaolo Bonzini     block_job_enter(job);
176bae8196dSPaolo Bonzini 
177bae8196dSPaolo Bonzini     blk_drain(job->blk);
178bae8196dSPaolo Bonzini     if (job->driver->drain) {
179bae8196dSPaolo Bonzini         job->driver->drain(job);
180bae8196dSPaolo Bonzini     }
181bae8196dSPaolo Bonzini }
182bae8196dSPaolo Bonzini 
183463e0be1SStefan Hajnoczi static void block_job_detach_aio_context(void *opaque)
184463e0be1SStefan Hajnoczi {
185463e0be1SStefan Hajnoczi     BlockJob *job = opaque;
186463e0be1SStefan Hajnoczi 
187463e0be1SStefan Hajnoczi     /* In case the job terminates during aio_poll()... */
18880fa2c75SKevin Wolf     job_ref(&job->job);
189463e0be1SStefan Hajnoczi 
190b15de828SKevin Wolf     job_pause(&job->job);
191463e0be1SStefan Hajnoczi 
192dbe5e6c1SKevin Wolf     while (!job->job.paused && !job_is_completed(&job->job)) {
193bae8196dSPaolo Bonzini         block_job_drain(job);
194463e0be1SStefan Hajnoczi     }
195463e0be1SStefan Hajnoczi 
19608be6fe2SKevin Wolf     job->job.aio_context = NULL;
19780fa2c75SKevin Wolf     job_unref(&job->job);
198463e0be1SStefan Hajnoczi }
199463e0be1SStefan Hajnoczi 
200f321dcb5SPaolo Bonzini static char *child_job_get_parent_desc(BdrvChild *c)
201f321dcb5SPaolo Bonzini {
202f321dcb5SPaolo Bonzini     BlockJob *job = c->opaque;
203252291eaSKevin Wolf     return g_strdup_printf("%s job '%s'", job_type_str(&job->job), job->job.id);
204f321dcb5SPaolo Bonzini }
205f321dcb5SPaolo Bonzini 
206ad90febaSKevin Wolf static void child_job_drained_begin(BdrvChild *c)
207f321dcb5SPaolo Bonzini {
208ad90febaSKevin Wolf     BlockJob *job = c->opaque;
209b15de828SKevin Wolf     job_pause(&job->job);
210f321dcb5SPaolo Bonzini }
211f321dcb5SPaolo Bonzini 
212ad90febaSKevin Wolf static void child_job_drained_end(BdrvChild *c)
213f321dcb5SPaolo Bonzini {
214ad90febaSKevin Wolf     BlockJob *job = c->opaque;
215b15de828SKevin Wolf     job_resume(&job->job);
216f321dcb5SPaolo Bonzini }
217f321dcb5SPaolo Bonzini 
218ad90febaSKevin Wolf static const BdrvChildRole child_job = {
219ad90febaSKevin Wolf     .get_parent_desc    = child_job_get_parent_desc,
220ad90febaSKevin Wolf     .drained_begin      = child_job_drained_begin,
221ad90febaSKevin Wolf     .drained_end        = child_job_drained_end,
222ad90febaSKevin Wolf     .stay_at_node       = true,
223f321dcb5SPaolo Bonzini };
224f321dcb5SPaolo Bonzini 
225bbc02b90SKevin Wolf void block_job_remove_all_bdrv(BlockJob *job)
226bbc02b90SKevin Wolf {
227bbc02b90SKevin Wolf     GSList *l;
228bbc02b90SKevin Wolf     for (l = job->nodes; l; l = l->next) {
229bbc02b90SKevin Wolf         BdrvChild *c = l->data;
230bbc02b90SKevin Wolf         bdrv_op_unblock_all(c->bs, job->blocker);
231bbc02b90SKevin Wolf         bdrv_root_unref_child(c);
232bbc02b90SKevin Wolf     }
233bbc02b90SKevin Wolf     g_slist_free(job->nodes);
234bbc02b90SKevin Wolf     job->nodes = NULL;
235bbc02b90SKevin Wolf }
236bbc02b90SKevin Wolf 
23776d554e2SKevin Wolf int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs,
23876d554e2SKevin Wolf                        uint64_t perm, uint64_t shared_perm, Error **errp)
23923d402d4SAlberto Garcia {
24076d554e2SKevin Wolf     BdrvChild *c;
24176d554e2SKevin Wolf 
24276d554e2SKevin Wolf     c = bdrv_root_attach_child(bs, name, &child_job, perm, shared_perm,
24376d554e2SKevin Wolf                                job, errp);
24476d554e2SKevin Wolf     if (c == NULL) {
24576d554e2SKevin Wolf         return -EPERM;
24676d554e2SKevin Wolf     }
24776d554e2SKevin Wolf 
24876d554e2SKevin Wolf     job->nodes = g_slist_prepend(job->nodes, c);
24923d402d4SAlberto Garcia     bdrv_ref(bs);
25023d402d4SAlberto Garcia     bdrv_op_block_all(bs, job->blocker);
25176d554e2SKevin Wolf 
25276d554e2SKevin Wolf     return 0;
25323d402d4SAlberto Garcia }
25423d402d4SAlberto Garcia 
255559b935fSJohn Snow bool block_job_is_internal(BlockJob *job)
256559b935fSJohn Snow {
25733e9e9bdSKevin Wolf     return (job->job.id == NULL);
258559b935fSJohn Snow }
259559b935fSJohn Snow 
260bd21935bSKevin Wolf const BlockJobDriver *block_job_driver(BlockJob *job)
261bd21935bSKevin Wolf {
262bd21935bSKevin Wolf     return job->driver;
263bd21935bSKevin Wolf }
264bd21935bSKevin Wolf 
2652da4617aSJohn Snow static int block_job_prepare(BlockJob *job)
2662da4617aSJohn Snow {
267*4ad35181SKevin Wolf     if (job->job.ret == 0 && job->driver->prepare) {
268*4ad35181SKevin Wolf         job->job.ret = job->driver->prepare(job);
2692da4617aSJohn Snow     }
270*4ad35181SKevin Wolf     return job->job.ret;
271c55a832fSFam Zheng }
272c55a832fSFam Zheng 
273b76e4458SLiang Li static void block_job_cancel_async(BlockJob *job, bool force)
2744c241cf5SPaolo Bonzini {
2754c241cf5SPaolo Bonzini     if (job->iostatus != BLOCK_DEVICE_IO_STATUS_OK) {
2764c241cf5SPaolo Bonzini         block_job_iostatus_reset(job);
2774c241cf5SPaolo Bonzini     }
278b15de828SKevin Wolf     if (job->job.user_paused) {
2794c241cf5SPaolo Bonzini         /* Do not call block_job_enter here, the caller will handle it.  */
280b15de828SKevin Wolf         job->job.user_paused = false;
281da01ff7fSKevin Wolf         job->job.pause_count--;
2824c241cf5SPaolo Bonzini     }
283daa7f2f9SKevin Wolf     job->job.cancelled = true;
284b76e4458SLiang Li     /* To prevent 'force == false' overriding a previous 'force == true' */
285b76e4458SLiang Li     job->force |= force;
2864c241cf5SPaolo Bonzini }
2874c241cf5SPaolo Bonzini 
2885f241594SJohn Snow static int block_job_txn_apply(BlockJobTxn *txn, int fn(BlockJob *), bool lock)
289efe4d4b7SJohn Snow {
290efe4d4b7SJohn Snow     AioContext *ctx;
291efe4d4b7SJohn Snow     BlockJob *job, *next;
2922da4617aSJohn Snow     int rc = 0;
293efe4d4b7SJohn Snow 
294efe4d4b7SJohn Snow     QLIST_FOREACH_SAFE(job, &txn->jobs, txn_list, next) {
2955f241594SJohn Snow         if (lock) {
296efe4d4b7SJohn Snow             ctx = blk_get_aio_context(job->blk);
297efe4d4b7SJohn Snow             aio_context_acquire(ctx);
2985f241594SJohn Snow         }
2992da4617aSJohn Snow         rc = fn(job);
3005f241594SJohn Snow         if (lock) {
301efe4d4b7SJohn Snow             aio_context_release(ctx);
3025f241594SJohn Snow         }
3032da4617aSJohn Snow         if (rc) {
3042da4617aSJohn Snow             break;
305efe4d4b7SJohn Snow         }
306efe4d4b7SJohn Snow     }
3072da4617aSJohn Snow     return rc;
3082da4617aSJohn Snow }
309efe4d4b7SJohn Snow 
310c8ab5c2dSPaolo Bonzini static int block_job_finish_sync(BlockJob *job,
311c8ab5c2dSPaolo Bonzini                                  void (*finish)(BlockJob *, Error **errp),
312c8ab5c2dSPaolo Bonzini                                  Error **errp)
313c8ab5c2dSPaolo Bonzini {
314c8ab5c2dSPaolo Bonzini     Error *local_err = NULL;
315c8ab5c2dSPaolo Bonzini     int ret;
316c8ab5c2dSPaolo Bonzini 
317c8ab5c2dSPaolo Bonzini     assert(blk_bs(job->blk)->job == job);
318c8ab5c2dSPaolo Bonzini 
31980fa2c75SKevin Wolf     job_ref(&job->job);
320c8ab5c2dSPaolo Bonzini 
3214fb588e9SPaolo Bonzini     if (finish) {
322c8ab5c2dSPaolo Bonzini         finish(job, &local_err);
3234fb588e9SPaolo Bonzini     }
324c8ab5c2dSPaolo Bonzini     if (local_err) {
325c8ab5c2dSPaolo Bonzini         error_propagate(errp, local_err);
32680fa2c75SKevin Wolf         job_unref(&job->job);
327c8ab5c2dSPaolo Bonzini         return -EBUSY;
328c8ab5c2dSPaolo Bonzini     }
329c8ab5c2dSPaolo Bonzini     /* block_job_drain calls block_job_enter, and it should be enough to
330c8ab5c2dSPaolo Bonzini      * induce progress until the job completes or moves to the main thread.
331c8ab5c2dSPaolo Bonzini     */
332dbe5e6c1SKevin Wolf     while (!job->job.deferred_to_main_loop && !job_is_completed(&job->job)) {
333c8ab5c2dSPaolo Bonzini         block_job_drain(job);
334c8ab5c2dSPaolo Bonzini     }
335dbe5e6c1SKevin Wolf     while (!job_is_completed(&job->job)) {
336c8ab5c2dSPaolo Bonzini         aio_poll(qemu_get_aio_context(), true);
337c8ab5c2dSPaolo Bonzini     }
338*4ad35181SKevin Wolf     ret = (job_is_cancelled(&job->job) && job->job.ret == 0)
339*4ad35181SKevin Wolf           ? -ECANCELED : job->job.ret;
34080fa2c75SKevin Wolf     job_unref(&job->job);
341c8ab5c2dSPaolo Bonzini     return ret;
342c8ab5c2dSPaolo Bonzini }
343c8ab5c2dSPaolo Bonzini 
344c55a832fSFam Zheng static void block_job_completed_txn_abort(BlockJob *job)
345c55a832fSFam Zheng {
346c55a832fSFam Zheng     AioContext *ctx;
347c55a832fSFam Zheng     BlockJobTxn *txn = job->txn;
3484fb588e9SPaolo Bonzini     BlockJob *other_job;
349c55a832fSFam Zheng 
350c55a832fSFam Zheng     if (txn->aborting) {
351c55a832fSFam Zheng         /*
352c55a832fSFam Zheng          * We are cancelled by another job, which will handle everything.
353c55a832fSFam Zheng          */
354c55a832fSFam Zheng         return;
355c55a832fSFam Zheng     }
356c55a832fSFam Zheng     txn->aborting = true;
3574fb588e9SPaolo Bonzini     block_job_txn_ref(txn);
3584fb588e9SPaolo Bonzini 
359c55a832fSFam Zheng     /* We are the first failed job. Cancel other jobs. */
360c55a832fSFam Zheng     QLIST_FOREACH(other_job, &txn->jobs, txn_list) {
361b6d2e599SKevin Wolf         ctx = blk_get_aio_context(other_job->blk);
362c55a832fSFam Zheng         aio_context_acquire(ctx);
363c55a832fSFam Zheng     }
3644fb588e9SPaolo Bonzini 
3654fb588e9SPaolo Bonzini     /* Other jobs are effectively cancelled by us, set the status for
366c55a832fSFam Zheng      * them; this job, however, may or may not be cancelled, depending
367c55a832fSFam Zheng      * on the caller, so leave it. */
3684fb588e9SPaolo Bonzini     QLIST_FOREACH(other_job, &txn->jobs, txn_list) {
369c55a832fSFam Zheng         if (other_job != job) {
370b76e4458SLiang Li             block_job_cancel_async(other_job, false);
371c55a832fSFam Zheng         }
372c55a832fSFam Zheng     }
3734fb588e9SPaolo Bonzini     while (!QLIST_EMPTY(&txn->jobs)) {
3744fb588e9SPaolo Bonzini         other_job = QLIST_FIRST(&txn->jobs);
375b6d2e599SKevin Wolf         ctx = blk_get_aio_context(other_job->blk);
376dbe5e6c1SKevin Wolf         if (!job_is_completed(&other_job->job)) {
377daa7f2f9SKevin Wolf             assert(job_is_cancelled(&other_job->job));
3784fb588e9SPaolo Bonzini             block_job_finish_sync(other_job, NULL, NULL);
3794fb588e9SPaolo Bonzini         }
380*4ad35181SKevin Wolf         job_finalize_single(&other_job->job);
381c55a832fSFam Zheng         aio_context_release(ctx);
382c55a832fSFam Zheng     }
3834fb588e9SPaolo Bonzini 
3844fb588e9SPaolo Bonzini     block_job_txn_unref(txn);
385c55a832fSFam Zheng }
386c55a832fSFam Zheng 
38711b61fbcSJohn Snow static int block_job_needs_finalize(BlockJob *job)
38811b61fbcSJohn Snow {
389bb02b65cSKevin Wolf     return !job->job.auto_finalize;
39011b61fbcSJohn Snow }
39111b61fbcSJohn Snow 
392*4ad35181SKevin Wolf static int block_job_finalize_single(BlockJob *job)
393*4ad35181SKevin Wolf {
394*4ad35181SKevin Wolf     return job_finalize_single(&job->job);
395*4ad35181SKevin Wolf }
396*4ad35181SKevin Wolf 
39711b61fbcSJohn Snow static void block_job_do_finalize(BlockJob *job)
39811b61fbcSJohn Snow {
39911b61fbcSJohn Snow     int rc;
40011b61fbcSJohn Snow     assert(job && job->txn);
40111b61fbcSJohn Snow 
40211b61fbcSJohn Snow     /* prepare the transaction to complete */
40311b61fbcSJohn Snow     rc = block_job_txn_apply(job->txn, block_job_prepare, true);
40411b61fbcSJohn Snow     if (rc) {
40511b61fbcSJohn Snow         block_job_completed_txn_abort(job);
40611b61fbcSJohn Snow     } else {
40711b61fbcSJohn Snow         block_job_txn_apply(job->txn, block_job_finalize_single, true);
40811b61fbcSJohn Snow     }
40911b61fbcSJohn Snow }
41011b61fbcSJohn Snow 
4115d4f3769SKevin Wolf static int block_job_transition_to_pending(BlockJob *job)
4125d4f3769SKevin Wolf {
4135d4f3769SKevin Wolf     job_state_transition(&job->job, JOB_STATUS_PENDING);
4145d4f3769SKevin Wolf     if (!job->job.auto_finalize) {
415139a9f02SKevin Wolf         job_event_pending(&job->job);
4165d4f3769SKevin Wolf     }
4175d4f3769SKevin Wolf     return 0;
4185d4f3769SKevin Wolf }
4195d4f3769SKevin Wolf 
420c55a832fSFam Zheng static void block_job_completed_txn_success(BlockJob *job)
421c55a832fSFam Zheng {
422c55a832fSFam Zheng     BlockJobTxn *txn = job->txn;
423efe4d4b7SJohn Snow     BlockJob *other_job;
4242da4617aSJohn Snow 
425a50c2ab8SKevin Wolf     job_state_transition(&job->job, JOB_STATUS_WAITING);
426e8af5686SJohn Snow 
427c55a832fSFam Zheng     /*
428c55a832fSFam Zheng      * Successful completion, see if there are other running jobs in this
429c55a832fSFam Zheng      * txn.
430c55a832fSFam Zheng      */
431c55a832fSFam Zheng     QLIST_FOREACH(other_job, &txn->jobs, txn_list) {
432dbe5e6c1SKevin Wolf         if (!job_is_completed(&other_job->job)) {
433c55a832fSFam Zheng             return;
434c55a832fSFam Zheng         }
435*4ad35181SKevin Wolf         assert(other_job->job.ret == 0);
436c55a832fSFam Zheng     }
4372da4617aSJohn Snow 
4385d4f3769SKevin Wolf     block_job_txn_apply(txn, block_job_transition_to_pending, false);
43911b61fbcSJohn Snow 
44011b61fbcSJohn Snow     /* If no jobs need manual finalization, automatically do so */
44111b61fbcSJohn Snow     if (block_job_txn_apply(txn, block_job_needs_finalize, false) == 0) {
44211b61fbcSJohn Snow         block_job_do_finalize(job);
44311b61fbcSJohn Snow     }
444c55a832fSFam Zheng }
445c55a832fSFam Zheng 
446da01ff7fSKevin Wolf /* Assumes the job_mutex is held */
447da01ff7fSKevin Wolf static bool job_timer_pending(Job *job)
448da01ff7fSKevin Wolf {
449da01ff7fSKevin Wolf     return timer_pending(&job->sleep_timer);
450da01ff7fSKevin Wolf }
451da01ff7fSKevin Wolf 
4522f0c9fe6SPaolo Bonzini void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp)
4532f0c9fe6SPaolo Bonzini {
454aa9ef2e6SJohn Snow     int64_t old_speed = job->speed;
4552f0c9fe6SPaolo Bonzini 
456a50c2ab8SKevin Wolf     if (job_apply_verb(&job->job, JOB_VERB_SET_SPEED, errp)) {
4570ec4dfb8SJohn Snow         return;
4580ec4dfb8SJohn Snow     }
45918bb6928SKevin Wolf     if (speed < 0) {
46018bb6928SKevin Wolf         error_setg(errp, QERR_INVALID_PARAMETER, "speed");
4612f0c9fe6SPaolo Bonzini         return;
4622f0c9fe6SPaolo Bonzini     }
4632f0c9fe6SPaolo Bonzini 
46418bb6928SKevin Wolf     ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME);
46518bb6928SKevin Wolf 
4662f0c9fe6SPaolo Bonzini     job->speed = speed;
467d4fce188SJohn Snow     if (speed && speed <= old_speed) {
468aa9ef2e6SJohn Snow         return;
469aa9ef2e6SJohn Snow     }
470aa9ef2e6SJohn Snow 
471aa9ef2e6SJohn Snow     /* kick only if a timer is pending */
472da01ff7fSKevin Wolf     job_enter_cond(&job->job, job_timer_pending);
4732f0c9fe6SPaolo Bonzini }
4742f0c9fe6SPaolo Bonzini 
475dee81d51SKevin Wolf int64_t block_job_ratelimit_get_delay(BlockJob *job, uint64_t n)
476dee81d51SKevin Wolf {
477dee81d51SKevin Wolf     if (!job->speed) {
478dee81d51SKevin Wolf         return 0;
479dee81d51SKevin Wolf     }
480dee81d51SKevin Wolf 
481dee81d51SKevin Wolf     return ratelimit_calculate_delay(&job->limit, n);
482dee81d51SKevin Wolf }
483dee81d51SKevin Wolf 
484aeae883bSPaolo Bonzini void block_job_complete(BlockJob *job, Error **errp)
485aeae883bSPaolo Bonzini {
486559b935fSJohn Snow     /* Should not be reachable via external interface for internal jobs */
48733e9e9bdSKevin Wolf     assert(job->job.id);
488a50c2ab8SKevin Wolf     if (job_apply_verb(&job->job, JOB_VERB_COMPLETE, errp)) {
4890ec4dfb8SJohn Snow         return;
4900ec4dfb8SJohn Snow     }
491da01ff7fSKevin Wolf     if (job->job.pause_count || job_is_cancelled(&job->job) ||
492daa7f2f9SKevin Wolf         !job->driver->complete)
493daa7f2f9SKevin Wolf     {
4949df229c3SAlberto Garcia         error_setg(errp, "The active block job '%s' cannot be completed",
49533e9e9bdSKevin Wolf                    job->job.id);
496aeae883bSPaolo Bonzini         return;
497aeae883bSPaolo Bonzini     }
498aeae883bSPaolo Bonzini 
4993fc4b10aSFam Zheng     job->driver->complete(job, errp);
500aeae883bSPaolo Bonzini }
501aeae883bSPaolo Bonzini 
50211b61fbcSJohn Snow void block_job_finalize(BlockJob *job, Error **errp)
50311b61fbcSJohn Snow {
50433e9e9bdSKevin Wolf     assert(job && job->job.id);
505a50c2ab8SKevin Wolf     if (job_apply_verb(&job->job, JOB_VERB_FINALIZE, errp)) {
50611b61fbcSJohn Snow         return;
50711b61fbcSJohn Snow     }
50811b61fbcSJohn Snow     block_job_do_finalize(job);
50911b61fbcSJohn Snow }
51011b61fbcSJohn Snow 
51175f71059SJohn Snow void block_job_dismiss(BlockJob **jobptr, Error **errp)
51275f71059SJohn Snow {
51375f71059SJohn Snow     BlockJob *job = *jobptr;
51475f71059SJohn Snow     /* similarly to _complete, this is QMP-interface only. */
51533e9e9bdSKevin Wolf     assert(job->job.id);
516a50c2ab8SKevin Wolf     if (job_apply_verb(&job->job, JOB_VERB_DISMISS, errp)) {
51775f71059SJohn Snow         return;
51875f71059SJohn Snow     }
51975f71059SJohn Snow 
520*4ad35181SKevin Wolf     job_do_dismiss(&job->job);
52175f71059SJohn Snow     *jobptr = NULL;
52275f71059SJohn Snow }
52375f71059SJohn Snow 
524b76e4458SLiang Li void block_job_cancel(BlockJob *job, bool force)
5258acc72a4SPaolo Bonzini {
526a50c2ab8SKevin Wolf     if (job->job.status == JOB_STATUS_CONCLUDED) {
527*4ad35181SKevin Wolf         job_do_dismiss(&job->job);
52811b61fbcSJohn Snow         return;
52911b61fbcSJohn Snow     }
530b76e4458SLiang Li     block_job_cancel_async(job, force);
531da01ff7fSKevin Wolf     if (!job_started(&job->job)) {
5325ccac6f1SJohn Snow         block_job_completed(job, -ECANCELED);
5331908a559SKevin Wolf     } else if (job->job.deferred_to_main_loop) {
53411b61fbcSJohn Snow         block_job_completed_txn_abort(job);
53511b61fbcSJohn Snow     } else {
53611b61fbcSJohn Snow         block_job_enter(job);
5375ccac6f1SJohn Snow     }
5388acc72a4SPaolo Bonzini }
5398acc72a4SPaolo Bonzini 
540b76e4458SLiang Li void block_job_user_cancel(BlockJob *job, bool force, Error **errp)
5410ec4dfb8SJohn Snow {
542a50c2ab8SKevin Wolf     if (job_apply_verb(&job->job, JOB_VERB_CANCEL, errp)) {
5430ec4dfb8SJohn Snow         return;
5440ec4dfb8SJohn Snow     }
545b76e4458SLiang Li     block_job_cancel(job, force);
5460ec4dfb8SJohn Snow }
5470ec4dfb8SJohn Snow 
548345f9e1bSMax Reitz /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be
549345f9e1bSMax Reitz  * used with block_job_finish_sync() without the need for (rather nasty)
550345f9e1bSMax Reitz  * function pointer casts there. */
551345f9e1bSMax Reitz static void block_job_cancel_err(BlockJob *job, Error **errp)
552345f9e1bSMax Reitz {
553b76e4458SLiang Li     block_job_cancel(job, false);
554345f9e1bSMax Reitz }
555345f9e1bSMax Reitz 
556345f9e1bSMax Reitz int block_job_cancel_sync(BlockJob *job)
557345f9e1bSMax Reitz {
558345f9e1bSMax Reitz     return block_job_finish_sync(job, &block_job_cancel_err, NULL);
559345f9e1bSMax Reitz }
560345f9e1bSMax Reitz 
561a1a2af07SKevin Wolf void block_job_cancel_sync_all(void)
562a1a2af07SKevin Wolf {
563a1a2af07SKevin Wolf     BlockJob *job;
564a1a2af07SKevin Wolf     AioContext *aio_context;
565a1a2af07SKevin Wolf 
566e7c1d78bSKevin Wolf     while ((job = block_job_next(NULL))) {
567b6d2e599SKevin Wolf         aio_context = blk_get_aio_context(job->blk);
568a1a2af07SKevin Wolf         aio_context_acquire(aio_context);
569a1a2af07SKevin Wolf         block_job_cancel_sync(job);
570a1a2af07SKevin Wolf         aio_context_release(aio_context);
571a1a2af07SKevin Wolf     }
572a1a2af07SKevin Wolf }
573a1a2af07SKevin Wolf 
574345f9e1bSMax Reitz int block_job_complete_sync(BlockJob *job, Error **errp)
575345f9e1bSMax Reitz {
576345f9e1bSMax Reitz     return block_job_finish_sync(job, &block_job_complete, errp);
577345f9e1bSMax Reitz }
578345f9e1bSMax Reitz 
57905df8a6aSKevin Wolf void block_job_progress_update(BlockJob *job, uint64_t done)
58005df8a6aSKevin Wolf {
58105df8a6aSKevin Wolf     job->offset += done;
58205df8a6aSKevin Wolf }
58305df8a6aSKevin Wolf 
58405df8a6aSKevin Wolf void block_job_progress_set_remaining(BlockJob *job, uint64_t remaining)
58505df8a6aSKevin Wolf {
58605df8a6aSKevin Wolf     job->len = job->offset + remaining;
58705df8a6aSKevin Wolf }
58805df8a6aSKevin Wolf 
589559b935fSJohn Snow BlockJobInfo *block_job_query(BlockJob *job, Error **errp)
59030e628b7SPaolo Bonzini {
591559b935fSJohn Snow     BlockJobInfo *info;
592559b935fSJohn Snow 
593559b935fSJohn Snow     if (block_job_is_internal(job)) {
594559b935fSJohn Snow         error_setg(errp, "Cannot query QEMU internal jobs");
595559b935fSJohn Snow         return NULL;
596559b935fSJohn Snow     }
597559b935fSJohn Snow     info = g_new0(BlockJobInfo, 1);
598252291eaSKevin Wolf     info->type      = g_strdup(job_type_str(&job->job));
59933e9e9bdSKevin Wolf     info->device    = g_strdup(job->job.id);
60030e628b7SPaolo Bonzini     info->len       = job->len;
601da01ff7fSKevin Wolf     info->busy      = atomic_read(&job->job.busy);
602da01ff7fSKevin Wolf     info->paused    = job->job.pause_count > 0;
60330e628b7SPaolo Bonzini     info->offset    = job->offset;
60430e628b7SPaolo Bonzini     info->speed     = job->speed;
60532c81a4aSPaolo Bonzini     info->io_status = job->iostatus;
606ef6dbf1eSMax Reitz     info->ready     = job->ready;
607a50c2ab8SKevin Wolf     info->status    = job->job.status;
608bb02b65cSKevin Wolf     info->auto_finalize = job->job.auto_finalize;
609bb02b65cSKevin Wolf     info->auto_dismiss  = job->job.auto_dismiss;
610*4ad35181SKevin Wolf     info->has_error = job->job.ret != 0;
611*4ad35181SKevin Wolf     info->error     = job->job.ret ? g_strdup(strerror(-job->job.ret)) : NULL;
61230e628b7SPaolo Bonzini     return info;
61330e628b7SPaolo Bonzini }
61432c81a4aSPaolo Bonzini 
61532c81a4aSPaolo Bonzini static void block_job_iostatus_set_err(BlockJob *job, int error)
61632c81a4aSPaolo Bonzini {
61732c81a4aSPaolo Bonzini     if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
61832c81a4aSPaolo Bonzini         job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
61932c81a4aSPaolo Bonzini                                           BLOCK_DEVICE_IO_STATUS_FAILED;
62032c81a4aSPaolo Bonzini     }
62132c81a4aSPaolo Bonzini }
62232c81a4aSPaolo Bonzini 
623139a9f02SKevin Wolf static void block_job_event_cancelled(Notifier *n, void *opaque)
624a66a2a36SPaolo Bonzini {
625139a9f02SKevin Wolf     BlockJob *job = opaque;
626139a9f02SKevin Wolf 
627559b935fSJohn Snow     if (block_job_is_internal(job)) {
628559b935fSJohn Snow         return;
629559b935fSJohn Snow     }
630559b935fSJohn Snow 
631252291eaSKevin Wolf     qapi_event_send_block_job_cancelled(job_type(&job->job),
63233e9e9bdSKevin Wolf                                         job->job.id,
633a66a2a36SPaolo Bonzini                                         job->len,
634a66a2a36SPaolo Bonzini                                         job->offset,
635bcada37bSWenchao Xia                                         job->speed,
636bcada37bSWenchao Xia                                         &error_abort);
637a66a2a36SPaolo Bonzini }
638a66a2a36SPaolo Bonzini 
639139a9f02SKevin Wolf static void block_job_event_completed(Notifier *n, void *opaque)
640a66a2a36SPaolo Bonzini {
641139a9f02SKevin Wolf     BlockJob *job = opaque;
642139a9f02SKevin Wolf     const char *msg = NULL;
643139a9f02SKevin Wolf 
644559b935fSJohn Snow     if (block_job_is_internal(job)) {
645559b935fSJohn Snow         return;
646559b935fSJohn Snow     }
647559b935fSJohn Snow 
648*4ad35181SKevin Wolf     if (job->job.ret < 0) {
649*4ad35181SKevin Wolf         msg = strerror(-job->job.ret);
650139a9f02SKevin Wolf     }
651139a9f02SKevin Wolf 
652252291eaSKevin Wolf     qapi_event_send_block_job_completed(job_type(&job->job),
65333e9e9bdSKevin Wolf                                         job->job.id,
654bcada37bSWenchao Xia                                         job->len,
655bcada37bSWenchao Xia                                         job->offset,
656bcada37bSWenchao Xia                                         job->speed,
657bcada37bSWenchao Xia                                         !!msg,
658bcada37bSWenchao Xia                                         msg,
659bcada37bSWenchao Xia                                         &error_abort);
660bcada37bSWenchao Xia }
661bcada37bSWenchao Xia 
662139a9f02SKevin Wolf static void block_job_event_pending(Notifier *n, void *opaque)
6635f241594SJohn Snow {
664139a9f02SKevin Wolf     BlockJob *job = opaque;
665139a9f02SKevin Wolf 
6665d4f3769SKevin Wolf     if (block_job_is_internal(job)) {
6675d4f3769SKevin Wolf         return;
6685d4f3769SKevin Wolf     }
6695d4f3769SKevin Wolf 
670252291eaSKevin Wolf     qapi_event_send_block_job_pending(job_type(&job->job),
67133e9e9bdSKevin Wolf                                       job->job.id,
6725f241594SJohn Snow                                       &error_abort);
6735f241594SJohn Snow }
6745f241594SJohn Snow 
67588691b37SPaolo Bonzini /*
67688691b37SPaolo Bonzini  * API for block job drivers and the block layer.  These functions are
67788691b37SPaolo Bonzini  * declared in blockjob_int.h.
67888691b37SPaolo Bonzini  */
67988691b37SPaolo Bonzini 
68088691b37SPaolo Bonzini void *block_job_create(const char *job_id, const BlockJobDriver *driver,
68175859b94SJohn Snow                        BlockJobTxn *txn, BlockDriverState *bs, uint64_t perm,
68288691b37SPaolo Bonzini                        uint64_t shared_perm, int64_t speed, int flags,
68388691b37SPaolo Bonzini                        BlockCompletionFunc *cb, void *opaque, Error **errp)
68488691b37SPaolo Bonzini {
68588691b37SPaolo Bonzini     BlockBackend *blk;
68688691b37SPaolo Bonzini     BlockJob *job;
68788691b37SPaolo Bonzini     int ret;
68888691b37SPaolo Bonzini 
68988691b37SPaolo Bonzini     if (bs->job) {
69088691b37SPaolo Bonzini         error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs));
69188691b37SPaolo Bonzini         return NULL;
69288691b37SPaolo Bonzini     }
69388691b37SPaolo Bonzini 
694bb02b65cSKevin Wolf     if (job_id == NULL && !(flags & JOB_INTERNAL)) {
69588691b37SPaolo Bonzini         job_id = bdrv_get_device_name(bs);
69688691b37SPaolo Bonzini     }
69788691b37SPaolo Bonzini 
69888691b37SPaolo Bonzini     blk = blk_new(perm, shared_perm);
69988691b37SPaolo Bonzini     ret = blk_insert_bs(blk, bs, errp);
70088691b37SPaolo Bonzini     if (ret < 0) {
70188691b37SPaolo Bonzini         blk_unref(blk);
70288691b37SPaolo Bonzini         return NULL;
70388691b37SPaolo Bonzini     }
70488691b37SPaolo Bonzini 
70508be6fe2SKevin Wolf     job = job_create(job_id, &driver->job_driver, blk_get_aio_context(blk),
706*4ad35181SKevin Wolf                      flags, cb, opaque, errp);
70733e9e9bdSKevin Wolf     if (job == NULL) {
70833e9e9bdSKevin Wolf         blk_unref(blk);
70933e9e9bdSKevin Wolf         return NULL;
71033e9e9bdSKevin Wolf     }
71133e9e9bdSKevin Wolf 
712e7c1d78bSKevin Wolf     assert(is_block_job(&job->job));
71380fa2c75SKevin Wolf     assert(job->job.driver->free == &block_job_free);
714b15de828SKevin Wolf     assert(job->job.driver->user_resume == &block_job_user_resume);
715e7c1d78bSKevin Wolf 
71688691b37SPaolo Bonzini     job->driver        = driver;
71788691b37SPaolo Bonzini     job->blk           = blk;
71888691b37SPaolo Bonzini 
719139a9f02SKevin Wolf     job->finalize_cancelled_notifier.notify = block_job_event_cancelled;
720139a9f02SKevin Wolf     job->finalize_completed_notifier.notify = block_job_event_completed;
721139a9f02SKevin Wolf     job->pending_notifier.notify = block_job_event_pending;
722139a9f02SKevin Wolf 
723139a9f02SKevin Wolf     notifier_list_add(&job->job.on_finalize_cancelled,
724139a9f02SKevin Wolf                       &job->finalize_cancelled_notifier);
725139a9f02SKevin Wolf     notifier_list_add(&job->job.on_finalize_completed,
726139a9f02SKevin Wolf                       &job->finalize_completed_notifier);
727139a9f02SKevin Wolf     notifier_list_add(&job->job.on_pending, &job->pending_notifier);
728139a9f02SKevin Wolf 
72988691b37SPaolo Bonzini     error_setg(&job->blocker, "block device is in use by block job: %s",
730252291eaSKevin Wolf                job_type_str(&job->job));
73188691b37SPaolo Bonzini     block_job_add_bdrv(job, "main node", bs, 0, BLK_PERM_ALL, &error_abort);
73288691b37SPaolo Bonzini     bs->job = job;
73388691b37SPaolo Bonzini 
73488691b37SPaolo Bonzini     bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker);
73588691b37SPaolo Bonzini 
73688691b37SPaolo Bonzini     blk_add_aio_context_notifier(blk, block_job_attached_aio_context,
73788691b37SPaolo Bonzini                                  block_job_detach_aio_context, job);
73888691b37SPaolo Bonzini 
73988691b37SPaolo Bonzini     /* Only set speed when necessary to avoid NotSupported error */
74088691b37SPaolo Bonzini     if (speed != 0) {
74188691b37SPaolo Bonzini         Error *local_err = NULL;
74288691b37SPaolo Bonzini 
74388691b37SPaolo Bonzini         block_job_set_speed(job, speed, &local_err);
74488691b37SPaolo Bonzini         if (local_err) {
745*4ad35181SKevin Wolf             job_early_fail(&job->job);
74688691b37SPaolo Bonzini             error_propagate(errp, local_err);
74788691b37SPaolo Bonzini             return NULL;
74888691b37SPaolo Bonzini         }
74988691b37SPaolo Bonzini     }
75075859b94SJohn Snow 
75175859b94SJohn Snow     /* Single jobs are modeled as single-job transactions for sake of
75275859b94SJohn Snow      * consolidating the job management logic */
75375859b94SJohn Snow     if (!txn) {
75475859b94SJohn Snow         txn = block_job_txn_new();
75575859b94SJohn Snow         block_job_txn_add_job(txn, job);
75675859b94SJohn Snow         block_job_txn_unref(txn);
75775859b94SJohn Snow     } else {
75875859b94SJohn Snow         block_job_txn_add_job(txn, job);
75975859b94SJohn Snow     }
76075859b94SJohn Snow 
76188691b37SPaolo Bonzini     return job;
76288691b37SPaolo Bonzini }
76388691b37SPaolo Bonzini 
76488691b37SPaolo Bonzini void block_job_completed(BlockJob *job, int ret)
76588691b37SPaolo Bonzini {
766dbe5e6c1SKevin Wolf     assert(job && job->txn && !job_is_completed(&job->job));
76788691b37SPaolo Bonzini     assert(blk_bs(job->blk)->job == job);
768*4ad35181SKevin Wolf     job->job.ret = ret;
769*4ad35181SKevin Wolf     job_update_rc(&job->job);
770*4ad35181SKevin Wolf     trace_block_job_completed(job, ret, job->job.ret);
771*4ad35181SKevin Wolf     if (job->job.ret) {
77288691b37SPaolo Bonzini         block_job_completed_txn_abort(job);
77388691b37SPaolo Bonzini     } else {
77488691b37SPaolo Bonzini         block_job_completed_txn_success(job);
77588691b37SPaolo Bonzini     }
77688691b37SPaolo Bonzini }
77788691b37SPaolo Bonzini 
778aa9ef2e6SJohn Snow void block_job_enter(BlockJob *job)
779aa9ef2e6SJohn Snow {
780da01ff7fSKevin Wolf     job_enter_cond(&job->job, NULL);
781aa9ef2e6SJohn Snow }
782aa9ef2e6SJohn Snow 
78388691b37SPaolo Bonzini void block_job_yield(BlockJob *job)
78488691b37SPaolo Bonzini {
785da01ff7fSKevin Wolf     assert(job->job.busy);
78688691b37SPaolo Bonzini 
78788691b37SPaolo Bonzini     /* Check cancellation *before* setting busy = false, too!  */
788daa7f2f9SKevin Wolf     if (job_is_cancelled(&job->job)) {
78988691b37SPaolo Bonzini         return;
79088691b37SPaolo Bonzini     }
79188691b37SPaolo Bonzini 
792da01ff7fSKevin Wolf     if (!job_should_pause(&job->job)) {
793da01ff7fSKevin Wolf         job_do_yield(&job->job, -1);
79488691b37SPaolo Bonzini     }
79588691b37SPaolo Bonzini 
796da01ff7fSKevin Wolf     job_pause_point(&job->job);
79788691b37SPaolo Bonzini }
79888691b37SPaolo Bonzini 
7992caf63a9SPaolo Bonzini void block_job_iostatus_reset(BlockJob *job)
8002caf63a9SPaolo Bonzini {
8014c241cf5SPaolo Bonzini     if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
8024c241cf5SPaolo Bonzini         return;
8034c241cf5SPaolo Bonzini     }
804b15de828SKevin Wolf     assert(job->job.user_paused && job->job.pause_count > 0);
8052caf63a9SPaolo Bonzini     job->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
8062caf63a9SPaolo Bonzini }
8072caf63a9SPaolo Bonzini 
808b15de828SKevin Wolf void block_job_user_resume(Job *job)
809b15de828SKevin Wolf {
810b15de828SKevin Wolf     BlockJob *bjob = container_of(job, BlockJob, job);
811b15de828SKevin Wolf     block_job_iostatus_reset(bjob);
812b15de828SKevin Wolf }
813b15de828SKevin Wolf 
814bcada37bSWenchao Xia void block_job_event_ready(BlockJob *job)
815bcada37bSWenchao Xia {
816a50c2ab8SKevin Wolf     job_state_transition(&job->job, JOB_STATUS_READY);
817ef6dbf1eSMax Reitz     job->ready = true;
818ef6dbf1eSMax Reitz 
819559b935fSJohn Snow     if (block_job_is_internal(job)) {
820559b935fSJohn Snow         return;
821559b935fSJohn Snow     }
822559b935fSJohn Snow 
823252291eaSKevin Wolf     qapi_event_send_block_job_ready(job_type(&job->job),
82433e9e9bdSKevin Wolf                                     job->job.id,
825518848a2SMarkus Armbruster                                     job->len,
826518848a2SMarkus Armbruster                                     job->offset,
827518848a2SMarkus Armbruster                                     job->speed, &error_abort);
828a66a2a36SPaolo Bonzini }
829a66a2a36SPaolo Bonzini 
83081e254dcSKevin Wolf BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err,
83132c81a4aSPaolo Bonzini                                         int is_read, int error)
83232c81a4aSPaolo Bonzini {
83332c81a4aSPaolo Bonzini     BlockErrorAction action;
83432c81a4aSPaolo Bonzini 
83532c81a4aSPaolo Bonzini     switch (on_err) {
83632c81a4aSPaolo Bonzini     case BLOCKDEV_ON_ERROR_ENOSPC:
8378c398252SKevin Wolf     case BLOCKDEV_ON_ERROR_AUTO:
838a589569fSWenchao Xia         action = (error == ENOSPC) ?
839a589569fSWenchao Xia                  BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT;
84032c81a4aSPaolo Bonzini         break;
84132c81a4aSPaolo Bonzini     case BLOCKDEV_ON_ERROR_STOP:
842a589569fSWenchao Xia         action = BLOCK_ERROR_ACTION_STOP;
84332c81a4aSPaolo Bonzini         break;
84432c81a4aSPaolo Bonzini     case BLOCKDEV_ON_ERROR_REPORT:
845a589569fSWenchao Xia         action = BLOCK_ERROR_ACTION_REPORT;
84632c81a4aSPaolo Bonzini         break;
84732c81a4aSPaolo Bonzini     case BLOCKDEV_ON_ERROR_IGNORE:
848a589569fSWenchao Xia         action = BLOCK_ERROR_ACTION_IGNORE;
84932c81a4aSPaolo Bonzini         break;
85032c81a4aSPaolo Bonzini     default:
85132c81a4aSPaolo Bonzini         abort();
85232c81a4aSPaolo Bonzini     }
853559b935fSJohn Snow     if (!block_job_is_internal(job)) {
85433e9e9bdSKevin Wolf         qapi_event_send_block_job_error(job->job.id,
8555a2d2cbdSWenchao Xia                                         is_read ? IO_OPERATION_TYPE_READ :
8565a2d2cbdSWenchao Xia                                         IO_OPERATION_TYPE_WRITE,
8575a2d2cbdSWenchao Xia                                         action, &error_abort);
858559b935fSJohn Snow     }
859a589569fSWenchao Xia     if (action == BLOCK_ERROR_ACTION_STOP) {
860b15de828SKevin Wolf         job_pause(&job->job);
861751ebd76SFam Zheng         /* make the pause user visible, which will be resumed from QMP. */
862b15de828SKevin Wolf         job->job.user_paused = true;
86332c81a4aSPaolo Bonzini         block_job_iostatus_set_err(job, error);
86432c81a4aSPaolo Bonzini     }
86532c81a4aSPaolo Bonzini     return action;
86632c81a4aSPaolo Bonzini }
867