xref: /qemu/blockjob.c (revision bb02b65c)
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 
398254b6d9SJohn Snow static void block_job_event_cancelled(BlockJob *job);
408254b6d9SJohn Snow static void block_job_event_completed(BlockJob *job, const char *msg);
415f241594SJohn Snow static int block_job_event_pending(BlockJob *job);
428254b6d9SJohn Snow 
43c55a832fSFam Zheng /* Transactional group of block jobs */
44c55a832fSFam Zheng struct BlockJobTxn {
45c55a832fSFam Zheng 
46c55a832fSFam Zheng     /* Is this txn being cancelled? */
47c55a832fSFam Zheng     bool aborting;
48c55a832fSFam Zheng 
49c55a832fSFam Zheng     /* List of jobs */
50c55a832fSFam Zheng     QLIST_HEAD(, BlockJob) jobs;
51c55a832fSFam Zheng 
52c55a832fSFam Zheng     /* Reference count */
53c55a832fSFam Zheng     int refcnt;
54c55a832fSFam Zheng };
55c55a832fSFam Zheng 
5688691b37SPaolo Bonzini /*
5788691b37SPaolo Bonzini  * The block job API is composed of two categories of functions.
5888691b37SPaolo Bonzini  *
5988691b37SPaolo Bonzini  * The first includes functions used by the monitor.  The monitor is
6088691b37SPaolo Bonzini  * peculiar in that it accesses the block job list with block_job_get, and
6188691b37SPaolo Bonzini  * therefore needs consistency across block_job_get and the actual operation
6288691b37SPaolo Bonzini  * (e.g. block_job_set_speed).  The consistency is achieved with
6388691b37SPaolo Bonzini  * aio_context_acquire/release.  These functions are declared in blockjob.h.
6488691b37SPaolo Bonzini  *
6588691b37SPaolo Bonzini  * The second includes functions used by the block job drivers and sometimes
6688691b37SPaolo Bonzini  * by the core block layer.  These do not care about locking, because the
6788691b37SPaolo Bonzini  * whole coroutine runs under the AioContext lock, and are declared in
6888691b37SPaolo Bonzini  * blockjob_int.h.
6988691b37SPaolo Bonzini  */
7088691b37SPaolo Bonzini 
71e7c1d78bSKevin Wolf static bool is_block_job(Job *job)
72a7112795SAlberto Garcia {
73e7c1d78bSKevin Wolf     return job_type(job) == JOB_TYPE_BACKUP ||
74e7c1d78bSKevin Wolf            job_type(job) == JOB_TYPE_COMMIT ||
75e7c1d78bSKevin Wolf            job_type(job) == JOB_TYPE_MIRROR ||
76e7c1d78bSKevin Wolf            job_type(job) == JOB_TYPE_STREAM;
77a7112795SAlberto Garcia }
78e7c1d78bSKevin Wolf 
79e7c1d78bSKevin Wolf BlockJob *block_job_next(BlockJob *bjob)
80e7c1d78bSKevin Wolf {
81e7c1d78bSKevin Wolf     Job *job = bjob ? &bjob->job : NULL;
82e7c1d78bSKevin Wolf 
83e7c1d78bSKevin Wolf     do {
84e7c1d78bSKevin Wolf         job = job_next(job);
85e7c1d78bSKevin Wolf     } while (job && !is_block_job(job));
86e7c1d78bSKevin Wolf 
87e7c1d78bSKevin Wolf     return job ? container_of(job, BlockJob, job) : NULL;
88a7112795SAlberto Garcia }
89a7112795SAlberto Garcia 
90ffb1f10cSAlberto Garcia BlockJob *block_job_get(const char *id)
91ffb1f10cSAlberto Garcia {
92e7c1d78bSKevin Wolf     Job *job = job_get(id);
93ffb1f10cSAlberto Garcia 
94e7c1d78bSKevin Wolf     if (job && is_block_job(job)) {
95e7c1d78bSKevin Wolf         return container_of(job, BlockJob, job);
96e7c1d78bSKevin Wolf     } else {
97ffb1f10cSAlberto Garcia         return NULL;
98ffb1f10cSAlberto Garcia     }
99e7c1d78bSKevin Wolf }
100ffb1f10cSAlberto Garcia 
101c8ab5c2dSPaolo Bonzini BlockJobTxn *block_job_txn_new(void)
102c8ab5c2dSPaolo Bonzini {
103c8ab5c2dSPaolo Bonzini     BlockJobTxn *txn = g_new0(BlockJobTxn, 1);
104c8ab5c2dSPaolo Bonzini     QLIST_INIT(&txn->jobs);
105c8ab5c2dSPaolo Bonzini     txn->refcnt = 1;
106c8ab5c2dSPaolo Bonzini     return txn;
107c8ab5c2dSPaolo Bonzini }
108c8ab5c2dSPaolo Bonzini 
109c8ab5c2dSPaolo Bonzini static void block_job_txn_ref(BlockJobTxn *txn)
110c8ab5c2dSPaolo Bonzini {
111c8ab5c2dSPaolo Bonzini     txn->refcnt++;
112c8ab5c2dSPaolo Bonzini }
113c8ab5c2dSPaolo Bonzini 
114c8ab5c2dSPaolo Bonzini void block_job_txn_unref(BlockJobTxn *txn)
115c8ab5c2dSPaolo Bonzini {
116c8ab5c2dSPaolo Bonzini     if (txn && --txn->refcnt == 0) {
117c8ab5c2dSPaolo Bonzini         g_free(txn);
118c8ab5c2dSPaolo Bonzini     }
119c8ab5c2dSPaolo Bonzini }
120c8ab5c2dSPaolo Bonzini 
121c8ab5c2dSPaolo Bonzini void block_job_txn_add_job(BlockJobTxn *txn, BlockJob *job)
122c8ab5c2dSPaolo Bonzini {
123c8ab5c2dSPaolo Bonzini     if (!txn) {
124c8ab5c2dSPaolo Bonzini         return;
125c8ab5c2dSPaolo Bonzini     }
126c8ab5c2dSPaolo Bonzini 
127c8ab5c2dSPaolo Bonzini     assert(!job->txn);
128c8ab5c2dSPaolo Bonzini     job->txn = txn;
129c8ab5c2dSPaolo Bonzini 
130c8ab5c2dSPaolo Bonzini     QLIST_INSERT_HEAD(&txn->jobs, job, txn_list);
131c8ab5c2dSPaolo Bonzini     block_job_txn_ref(txn);
132c8ab5c2dSPaolo Bonzini }
133c8ab5c2dSPaolo Bonzini 
134a865cebbSMarc-André Lureau static void block_job_txn_del_job(BlockJob *job)
135a865cebbSMarc-André Lureau {
136a865cebbSMarc-André Lureau     if (job->txn) {
137a865cebbSMarc-André Lureau         QLIST_REMOVE(job, txn_list);
138a865cebbSMarc-André Lureau         block_job_txn_unref(job->txn);
139a865cebbSMarc-André Lureau         job->txn = NULL;
140a865cebbSMarc-André Lureau     }
141a865cebbSMarc-André Lureau }
142a865cebbSMarc-André Lureau 
14305b0d8e3SPaolo Bonzini static void block_job_attached_aio_context(AioContext *new_context,
14405b0d8e3SPaolo Bonzini                                            void *opaque);
14505b0d8e3SPaolo Bonzini static void block_job_detach_aio_context(void *opaque);
14605b0d8e3SPaolo Bonzini 
14780fa2c75SKevin Wolf void block_job_free(Job *job)
14805b0d8e3SPaolo Bonzini {
14980fa2c75SKevin Wolf     BlockJob *bjob = container_of(job, BlockJob, job);
15080fa2c75SKevin Wolf     BlockDriverState *bs = blk_bs(bjob->blk);
15180fa2c75SKevin Wolf 
15280fa2c75SKevin Wolf     assert(!bjob->txn);
15380fa2c75SKevin Wolf 
15405b0d8e3SPaolo Bonzini     bs->job = NULL;
15580fa2c75SKevin Wolf     block_job_remove_all_bdrv(bjob);
15680fa2c75SKevin Wolf     blk_remove_aio_context_notifier(bjob->blk,
15705b0d8e3SPaolo Bonzini                                     block_job_attached_aio_context,
15880fa2c75SKevin Wolf                                     block_job_detach_aio_context, bjob);
15980fa2c75SKevin Wolf     blk_unref(bjob->blk);
16080fa2c75SKevin Wolf     error_free(bjob->blocker);
16105b0d8e3SPaolo Bonzini }
16205b0d8e3SPaolo Bonzini 
163463e0be1SStefan Hajnoczi static void block_job_attached_aio_context(AioContext *new_context,
164463e0be1SStefan Hajnoczi                                            void *opaque)
165463e0be1SStefan Hajnoczi {
166463e0be1SStefan Hajnoczi     BlockJob *job = opaque;
167463e0be1SStefan Hajnoczi 
16808be6fe2SKevin Wolf     job->job.aio_context = new_context;
169463e0be1SStefan Hajnoczi     if (job->driver->attached_aio_context) {
170463e0be1SStefan Hajnoczi         job->driver->attached_aio_context(job, new_context);
171463e0be1SStefan Hajnoczi     }
172463e0be1SStefan Hajnoczi 
173b15de828SKevin Wolf     job_resume(&job->job);
174463e0be1SStefan Hajnoczi }
175463e0be1SStefan Hajnoczi 
176bae8196dSPaolo Bonzini static void block_job_drain(BlockJob *job)
177bae8196dSPaolo Bonzini {
178da01ff7fSKevin Wolf     /* If job is !job->job.busy this kicks it into the next pause point. */
179bae8196dSPaolo Bonzini     block_job_enter(job);
180bae8196dSPaolo Bonzini 
181bae8196dSPaolo Bonzini     blk_drain(job->blk);
182bae8196dSPaolo Bonzini     if (job->driver->drain) {
183bae8196dSPaolo Bonzini         job->driver->drain(job);
184bae8196dSPaolo Bonzini     }
185bae8196dSPaolo Bonzini }
186bae8196dSPaolo Bonzini 
187463e0be1SStefan Hajnoczi static void block_job_detach_aio_context(void *opaque)
188463e0be1SStefan Hajnoczi {
189463e0be1SStefan Hajnoczi     BlockJob *job = opaque;
190463e0be1SStefan Hajnoczi 
191463e0be1SStefan Hajnoczi     /* In case the job terminates during aio_poll()... */
19280fa2c75SKevin Wolf     job_ref(&job->job);
193463e0be1SStefan Hajnoczi 
194b15de828SKevin Wolf     job_pause(&job->job);
195463e0be1SStefan Hajnoczi 
196dbe5e6c1SKevin Wolf     while (!job->job.paused && !job_is_completed(&job->job)) {
197bae8196dSPaolo Bonzini         block_job_drain(job);
198463e0be1SStefan Hajnoczi     }
199463e0be1SStefan Hajnoczi 
20008be6fe2SKevin Wolf     job->job.aio_context = NULL;
20180fa2c75SKevin Wolf     job_unref(&job->job);
202463e0be1SStefan Hajnoczi }
203463e0be1SStefan Hajnoczi 
204f321dcb5SPaolo Bonzini static char *child_job_get_parent_desc(BdrvChild *c)
205f321dcb5SPaolo Bonzini {
206f321dcb5SPaolo Bonzini     BlockJob *job = c->opaque;
207252291eaSKevin Wolf     return g_strdup_printf("%s job '%s'", job_type_str(&job->job), job->job.id);
208f321dcb5SPaolo Bonzini }
209f321dcb5SPaolo Bonzini 
210ad90febaSKevin Wolf static void child_job_drained_begin(BdrvChild *c)
211f321dcb5SPaolo Bonzini {
212ad90febaSKevin Wolf     BlockJob *job = c->opaque;
213b15de828SKevin Wolf     job_pause(&job->job);
214f321dcb5SPaolo Bonzini }
215f321dcb5SPaolo Bonzini 
216ad90febaSKevin Wolf static void child_job_drained_end(BdrvChild *c)
217f321dcb5SPaolo Bonzini {
218ad90febaSKevin Wolf     BlockJob *job = c->opaque;
219b15de828SKevin Wolf     job_resume(&job->job);
220f321dcb5SPaolo Bonzini }
221f321dcb5SPaolo Bonzini 
222ad90febaSKevin Wolf static const BdrvChildRole child_job = {
223ad90febaSKevin Wolf     .get_parent_desc    = child_job_get_parent_desc,
224ad90febaSKevin Wolf     .drained_begin      = child_job_drained_begin,
225ad90febaSKevin Wolf     .drained_end        = child_job_drained_end,
226ad90febaSKevin Wolf     .stay_at_node       = true,
227f321dcb5SPaolo Bonzini };
228f321dcb5SPaolo Bonzini 
229bbc02b90SKevin Wolf void block_job_remove_all_bdrv(BlockJob *job)
230bbc02b90SKevin Wolf {
231bbc02b90SKevin Wolf     GSList *l;
232bbc02b90SKevin Wolf     for (l = job->nodes; l; l = l->next) {
233bbc02b90SKevin Wolf         BdrvChild *c = l->data;
234bbc02b90SKevin Wolf         bdrv_op_unblock_all(c->bs, job->blocker);
235bbc02b90SKevin Wolf         bdrv_root_unref_child(c);
236bbc02b90SKevin Wolf     }
237bbc02b90SKevin Wolf     g_slist_free(job->nodes);
238bbc02b90SKevin Wolf     job->nodes = NULL;
239bbc02b90SKevin Wolf }
240bbc02b90SKevin Wolf 
24176d554e2SKevin Wolf int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs,
24276d554e2SKevin Wolf                        uint64_t perm, uint64_t shared_perm, Error **errp)
24323d402d4SAlberto Garcia {
24476d554e2SKevin Wolf     BdrvChild *c;
24576d554e2SKevin Wolf 
24676d554e2SKevin Wolf     c = bdrv_root_attach_child(bs, name, &child_job, perm, shared_perm,
24776d554e2SKevin Wolf                                job, errp);
24876d554e2SKevin Wolf     if (c == NULL) {
24976d554e2SKevin Wolf         return -EPERM;
25076d554e2SKevin Wolf     }
25176d554e2SKevin Wolf 
25276d554e2SKevin Wolf     job->nodes = g_slist_prepend(job->nodes, c);
25323d402d4SAlberto Garcia     bdrv_ref(bs);
25423d402d4SAlberto Garcia     bdrv_op_block_all(bs, job->blocker);
25576d554e2SKevin Wolf 
25676d554e2SKevin Wolf     return 0;
25723d402d4SAlberto Garcia }
25823d402d4SAlberto Garcia 
259559b935fSJohn Snow bool block_job_is_internal(BlockJob *job)
260559b935fSJohn Snow {
26133e9e9bdSKevin Wolf     return (job->job.id == NULL);
262559b935fSJohn Snow }
263559b935fSJohn Snow 
264bd21935bSKevin Wolf const BlockJobDriver *block_job_driver(BlockJob *job)
265bd21935bSKevin Wolf {
266bd21935bSKevin Wolf     return job->driver;
267bd21935bSKevin Wolf }
268bd21935bSKevin Wolf 
2693925cd3bSJohn Snow static void block_job_decommission(BlockJob *job)
2703925cd3bSJohn Snow {
2713925cd3bSJohn Snow     assert(job);
272da01ff7fSKevin Wolf     job->job.busy = false;
273da01ff7fSKevin Wolf     job->job.paused = false;
2741908a559SKevin Wolf     job->job.deferred_to_main_loop = true;
275a865cebbSMarc-André Lureau     block_job_txn_del_job(job);
276a50c2ab8SKevin Wolf     job_state_transition(&job->job, JOB_STATUS_NULL);
27780fa2c75SKevin Wolf     job_unref(&job->job);
2783925cd3bSJohn Snow }
2793925cd3bSJohn Snow 
28075f71059SJohn Snow static void block_job_do_dismiss(BlockJob *job)
28175f71059SJohn Snow {
28275f71059SJohn Snow     block_job_decommission(job);
28375f71059SJohn Snow }
28475f71059SJohn Snow 
285e0cf0364SJohn Snow static void block_job_conclude(BlockJob *job)
286e0cf0364SJohn Snow {
287a50c2ab8SKevin Wolf     job_state_transition(&job->job, JOB_STATUS_CONCLUDED);
288*bb02b65cSKevin Wolf     if (job->job.auto_dismiss || !job_started(&job->job)) {
28975f71059SJohn Snow         block_job_do_dismiss(job);
29075f71059SJohn Snow     }
291e0cf0364SJohn Snow }
292e0cf0364SJohn Snow 
29335d6b368SJohn Snow static void block_job_update_rc(BlockJob *job)
29435d6b368SJohn Snow {
295daa7f2f9SKevin Wolf     if (!job->ret && job_is_cancelled(&job->job)) {
29635d6b368SJohn Snow         job->ret = -ECANCELED;
29735d6b368SJohn Snow     }
29835d6b368SJohn Snow     if (job->ret) {
299a50c2ab8SKevin Wolf         job_state_transition(&job->job, JOB_STATUS_ABORTING);
30035d6b368SJohn Snow     }
30135d6b368SJohn Snow }
30235d6b368SJohn Snow 
3032da4617aSJohn Snow static int block_job_prepare(BlockJob *job)
3042da4617aSJohn Snow {
3052da4617aSJohn Snow     if (job->ret == 0 && job->driver->prepare) {
3062da4617aSJohn Snow         job->ret = job->driver->prepare(job);
3072da4617aSJohn Snow     }
3082da4617aSJohn Snow     return job->ret;
3092da4617aSJohn Snow }
3102da4617aSJohn Snow 
31143628d93SJohn Snow static void block_job_commit(BlockJob *job)
31243628d93SJohn Snow {
31343628d93SJohn Snow     assert(!job->ret);
31443628d93SJohn Snow     if (job->driver->commit) {
31543628d93SJohn Snow         job->driver->commit(job);
31643628d93SJohn Snow     }
31743628d93SJohn Snow }
31843628d93SJohn Snow 
31943628d93SJohn Snow static void block_job_abort(BlockJob *job)
32043628d93SJohn Snow {
32143628d93SJohn Snow     assert(job->ret);
32243628d93SJohn Snow     if (job->driver->abort) {
32343628d93SJohn Snow         job->driver->abort(job);
32443628d93SJohn Snow     }
32543628d93SJohn Snow }
32643628d93SJohn Snow 
32743628d93SJohn Snow static void block_job_clean(BlockJob *job)
32843628d93SJohn Snow {
32943628d93SJohn Snow     if (job->driver->clean) {
33043628d93SJohn Snow         job->driver->clean(job);
33143628d93SJohn Snow     }
33243628d93SJohn Snow }
33343628d93SJohn Snow 
33411b61fbcSJohn Snow static int block_job_finalize_single(BlockJob *job)
335c55a832fSFam Zheng {
336dbe5e6c1SKevin Wolf     assert(job_is_completed(&job->job));
3374fb588e9SPaolo Bonzini 
33835d6b368SJohn Snow     /* Ensure abort is called for late-transactional failures */
33935d6b368SJohn Snow     block_job_update_rc(job);
34010a3fbb0SJohn Snow 
341c55a832fSFam Zheng     if (!job->ret) {
34243628d93SJohn Snow         block_job_commit(job);
343c55a832fSFam Zheng     } else {
34443628d93SJohn Snow         block_job_abort(job);
345c55a832fSFam Zheng     }
34643628d93SJohn Snow     block_job_clean(job);
3478254b6d9SJohn Snow 
3488254b6d9SJohn Snow     if (job->cb) {
349c55a832fSFam Zheng         job->cb(job->opaque, job->ret);
3508254b6d9SJohn Snow     }
3515ccac6f1SJohn Snow 
3525ccac6f1SJohn Snow     /* Emit events only if we actually started */
353da01ff7fSKevin Wolf     if (job_started(&job->job)) {
354daa7f2f9SKevin Wolf         if (job_is_cancelled(&job->job)) {
3558254b6d9SJohn Snow             block_job_event_cancelled(job);
3568254b6d9SJohn Snow         } else {
3578254b6d9SJohn Snow             const char *msg = NULL;
3588254b6d9SJohn Snow             if (job->ret < 0) {
3598254b6d9SJohn Snow                 msg = strerror(-job->ret);
3608254b6d9SJohn Snow             }
3618254b6d9SJohn Snow             block_job_event_completed(job, msg);
3628254b6d9SJohn Snow         }
3635ccac6f1SJohn Snow     }
3648254b6d9SJohn Snow 
365a865cebbSMarc-André Lureau     block_job_txn_del_job(job);
366e0cf0364SJohn Snow     block_job_conclude(job);
3672da4617aSJohn Snow     return 0;
368c55a832fSFam Zheng }
369c55a832fSFam Zheng 
370b76e4458SLiang Li static void block_job_cancel_async(BlockJob *job, bool force)
3714c241cf5SPaolo Bonzini {
3724c241cf5SPaolo Bonzini     if (job->iostatus != BLOCK_DEVICE_IO_STATUS_OK) {
3734c241cf5SPaolo Bonzini         block_job_iostatus_reset(job);
3744c241cf5SPaolo Bonzini     }
375b15de828SKevin Wolf     if (job->job.user_paused) {
3764c241cf5SPaolo Bonzini         /* Do not call block_job_enter here, the caller will handle it.  */
377b15de828SKevin Wolf         job->job.user_paused = false;
378da01ff7fSKevin Wolf         job->job.pause_count--;
3794c241cf5SPaolo Bonzini     }
380daa7f2f9SKevin Wolf     job->job.cancelled = true;
381b76e4458SLiang Li     /* To prevent 'force == false' overriding a previous 'force == true' */
382b76e4458SLiang Li     job->force |= force;
3834c241cf5SPaolo Bonzini }
3844c241cf5SPaolo Bonzini 
3855f241594SJohn Snow static int block_job_txn_apply(BlockJobTxn *txn, int fn(BlockJob *), bool lock)
386efe4d4b7SJohn Snow {
387efe4d4b7SJohn Snow     AioContext *ctx;
388efe4d4b7SJohn Snow     BlockJob *job, *next;
3892da4617aSJohn Snow     int rc = 0;
390efe4d4b7SJohn Snow 
391efe4d4b7SJohn Snow     QLIST_FOREACH_SAFE(job, &txn->jobs, txn_list, next) {
3925f241594SJohn Snow         if (lock) {
393efe4d4b7SJohn Snow             ctx = blk_get_aio_context(job->blk);
394efe4d4b7SJohn Snow             aio_context_acquire(ctx);
3955f241594SJohn Snow         }
3962da4617aSJohn Snow         rc = fn(job);
3975f241594SJohn Snow         if (lock) {
398efe4d4b7SJohn Snow             aio_context_release(ctx);
3995f241594SJohn Snow         }
4002da4617aSJohn Snow         if (rc) {
4012da4617aSJohn Snow             break;
402efe4d4b7SJohn Snow         }
403efe4d4b7SJohn Snow     }
4042da4617aSJohn Snow     return rc;
4052da4617aSJohn Snow }
406efe4d4b7SJohn Snow 
407c8ab5c2dSPaolo Bonzini static int block_job_finish_sync(BlockJob *job,
408c8ab5c2dSPaolo Bonzini                                  void (*finish)(BlockJob *, Error **errp),
409c8ab5c2dSPaolo Bonzini                                  Error **errp)
410c8ab5c2dSPaolo Bonzini {
411c8ab5c2dSPaolo Bonzini     Error *local_err = NULL;
412c8ab5c2dSPaolo Bonzini     int ret;
413c8ab5c2dSPaolo Bonzini 
414c8ab5c2dSPaolo Bonzini     assert(blk_bs(job->blk)->job == job);
415c8ab5c2dSPaolo Bonzini 
41680fa2c75SKevin Wolf     job_ref(&job->job);
417c8ab5c2dSPaolo Bonzini 
4184fb588e9SPaolo Bonzini     if (finish) {
419c8ab5c2dSPaolo Bonzini         finish(job, &local_err);
4204fb588e9SPaolo Bonzini     }
421c8ab5c2dSPaolo Bonzini     if (local_err) {
422c8ab5c2dSPaolo Bonzini         error_propagate(errp, local_err);
42380fa2c75SKevin Wolf         job_unref(&job->job);
424c8ab5c2dSPaolo Bonzini         return -EBUSY;
425c8ab5c2dSPaolo Bonzini     }
426c8ab5c2dSPaolo Bonzini     /* block_job_drain calls block_job_enter, and it should be enough to
427c8ab5c2dSPaolo Bonzini      * induce progress until the job completes or moves to the main thread.
428c8ab5c2dSPaolo Bonzini     */
429dbe5e6c1SKevin Wolf     while (!job->job.deferred_to_main_loop && !job_is_completed(&job->job)) {
430c8ab5c2dSPaolo Bonzini         block_job_drain(job);
431c8ab5c2dSPaolo Bonzini     }
432dbe5e6c1SKevin Wolf     while (!job_is_completed(&job->job)) {
433c8ab5c2dSPaolo Bonzini         aio_poll(qemu_get_aio_context(), true);
434c8ab5c2dSPaolo Bonzini     }
435daa7f2f9SKevin Wolf     ret = (job_is_cancelled(&job->job) && job->ret == 0)
436daa7f2f9SKevin Wolf           ? -ECANCELED : job->ret;
43780fa2c75SKevin Wolf     job_unref(&job->job);
438c8ab5c2dSPaolo Bonzini     return ret;
439c8ab5c2dSPaolo Bonzini }
440c8ab5c2dSPaolo Bonzini 
441c55a832fSFam Zheng static void block_job_completed_txn_abort(BlockJob *job)
442c55a832fSFam Zheng {
443c55a832fSFam Zheng     AioContext *ctx;
444c55a832fSFam Zheng     BlockJobTxn *txn = job->txn;
4454fb588e9SPaolo Bonzini     BlockJob *other_job;
446c55a832fSFam Zheng 
447c55a832fSFam Zheng     if (txn->aborting) {
448c55a832fSFam Zheng         /*
449c55a832fSFam Zheng          * We are cancelled by another job, which will handle everything.
450c55a832fSFam Zheng          */
451c55a832fSFam Zheng         return;
452c55a832fSFam Zheng     }
453c55a832fSFam Zheng     txn->aborting = true;
4544fb588e9SPaolo Bonzini     block_job_txn_ref(txn);
4554fb588e9SPaolo Bonzini 
456c55a832fSFam Zheng     /* We are the first failed job. Cancel other jobs. */
457c55a832fSFam Zheng     QLIST_FOREACH(other_job, &txn->jobs, txn_list) {
458b6d2e599SKevin Wolf         ctx = blk_get_aio_context(other_job->blk);
459c55a832fSFam Zheng         aio_context_acquire(ctx);
460c55a832fSFam Zheng     }
4614fb588e9SPaolo Bonzini 
4624fb588e9SPaolo Bonzini     /* Other jobs are effectively cancelled by us, set the status for
463c55a832fSFam Zheng      * them; this job, however, may or may not be cancelled, depending
464c55a832fSFam Zheng      * on the caller, so leave it. */
4654fb588e9SPaolo Bonzini     QLIST_FOREACH(other_job, &txn->jobs, txn_list) {
466c55a832fSFam Zheng         if (other_job != job) {
467b76e4458SLiang Li             block_job_cancel_async(other_job, false);
468c55a832fSFam Zheng         }
469c55a832fSFam Zheng     }
4704fb588e9SPaolo Bonzini     while (!QLIST_EMPTY(&txn->jobs)) {
4714fb588e9SPaolo Bonzini         other_job = QLIST_FIRST(&txn->jobs);
472b6d2e599SKevin Wolf         ctx = blk_get_aio_context(other_job->blk);
473dbe5e6c1SKevin Wolf         if (!job_is_completed(&other_job->job)) {
474daa7f2f9SKevin Wolf             assert(job_is_cancelled(&other_job->job));
4754fb588e9SPaolo Bonzini             block_job_finish_sync(other_job, NULL, NULL);
4764fb588e9SPaolo Bonzini         }
47711b61fbcSJohn Snow         block_job_finalize_single(other_job);
478c55a832fSFam Zheng         aio_context_release(ctx);
479c55a832fSFam Zheng     }
4804fb588e9SPaolo Bonzini 
4814fb588e9SPaolo Bonzini     block_job_txn_unref(txn);
482c55a832fSFam Zheng }
483c55a832fSFam Zheng 
48411b61fbcSJohn Snow static int block_job_needs_finalize(BlockJob *job)
48511b61fbcSJohn Snow {
486*bb02b65cSKevin Wolf     return !job->job.auto_finalize;
48711b61fbcSJohn Snow }
48811b61fbcSJohn Snow 
48911b61fbcSJohn Snow static void block_job_do_finalize(BlockJob *job)
49011b61fbcSJohn Snow {
49111b61fbcSJohn Snow     int rc;
49211b61fbcSJohn Snow     assert(job && job->txn);
49311b61fbcSJohn Snow 
49411b61fbcSJohn Snow     /* prepare the transaction to complete */
49511b61fbcSJohn Snow     rc = block_job_txn_apply(job->txn, block_job_prepare, true);
49611b61fbcSJohn Snow     if (rc) {
49711b61fbcSJohn Snow         block_job_completed_txn_abort(job);
49811b61fbcSJohn Snow     } else {
49911b61fbcSJohn Snow         block_job_txn_apply(job->txn, block_job_finalize_single, true);
50011b61fbcSJohn Snow     }
50111b61fbcSJohn Snow }
50211b61fbcSJohn Snow 
503c55a832fSFam Zheng static void block_job_completed_txn_success(BlockJob *job)
504c55a832fSFam Zheng {
505c55a832fSFam Zheng     BlockJobTxn *txn = job->txn;
506efe4d4b7SJohn Snow     BlockJob *other_job;
5072da4617aSJohn Snow 
508a50c2ab8SKevin Wolf     job_state_transition(&job->job, JOB_STATUS_WAITING);
509e8af5686SJohn Snow 
510c55a832fSFam Zheng     /*
511c55a832fSFam Zheng      * Successful completion, see if there are other running jobs in this
512c55a832fSFam Zheng      * txn.
513c55a832fSFam Zheng      */
514c55a832fSFam Zheng     QLIST_FOREACH(other_job, &txn->jobs, txn_list) {
515dbe5e6c1SKevin Wolf         if (!job_is_completed(&other_job->job)) {
516c55a832fSFam Zheng             return;
517c55a832fSFam Zheng         }
518efe4d4b7SJohn Snow         assert(other_job->ret == 0);
519c55a832fSFam Zheng     }
5202da4617aSJohn Snow 
5215f241594SJohn Snow     block_job_txn_apply(txn, block_job_event_pending, false);
52211b61fbcSJohn Snow 
52311b61fbcSJohn Snow     /* If no jobs need manual finalization, automatically do so */
52411b61fbcSJohn Snow     if (block_job_txn_apply(txn, block_job_needs_finalize, false) == 0) {
52511b61fbcSJohn Snow         block_job_do_finalize(job);
52611b61fbcSJohn Snow     }
527c55a832fSFam Zheng }
528c55a832fSFam Zheng 
529da01ff7fSKevin Wolf /* Assumes the job_mutex is held */
530da01ff7fSKevin Wolf static bool job_timer_pending(Job *job)
531da01ff7fSKevin Wolf {
532da01ff7fSKevin Wolf     return timer_pending(&job->sleep_timer);
533da01ff7fSKevin Wolf }
534da01ff7fSKevin Wolf 
5352f0c9fe6SPaolo Bonzini void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp)
5362f0c9fe6SPaolo Bonzini {
537aa9ef2e6SJohn Snow     int64_t old_speed = job->speed;
5382f0c9fe6SPaolo Bonzini 
539a50c2ab8SKevin Wolf     if (job_apply_verb(&job->job, JOB_VERB_SET_SPEED, errp)) {
5400ec4dfb8SJohn Snow         return;
5410ec4dfb8SJohn Snow     }
54218bb6928SKevin Wolf     if (speed < 0) {
54318bb6928SKevin Wolf         error_setg(errp, QERR_INVALID_PARAMETER, "speed");
5442f0c9fe6SPaolo Bonzini         return;
5452f0c9fe6SPaolo Bonzini     }
5462f0c9fe6SPaolo Bonzini 
54718bb6928SKevin Wolf     ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME);
54818bb6928SKevin Wolf 
5492f0c9fe6SPaolo Bonzini     job->speed = speed;
550d4fce188SJohn Snow     if (speed && speed <= old_speed) {
551aa9ef2e6SJohn Snow         return;
552aa9ef2e6SJohn Snow     }
553aa9ef2e6SJohn Snow 
554aa9ef2e6SJohn Snow     /* kick only if a timer is pending */
555da01ff7fSKevin Wolf     job_enter_cond(&job->job, job_timer_pending);
5562f0c9fe6SPaolo Bonzini }
5572f0c9fe6SPaolo Bonzini 
558dee81d51SKevin Wolf int64_t block_job_ratelimit_get_delay(BlockJob *job, uint64_t n)
559dee81d51SKevin Wolf {
560dee81d51SKevin Wolf     if (!job->speed) {
561dee81d51SKevin Wolf         return 0;
562dee81d51SKevin Wolf     }
563dee81d51SKevin Wolf 
564dee81d51SKevin Wolf     return ratelimit_calculate_delay(&job->limit, n);
565dee81d51SKevin Wolf }
566dee81d51SKevin Wolf 
567aeae883bSPaolo Bonzini void block_job_complete(BlockJob *job, Error **errp)
568aeae883bSPaolo Bonzini {
569559b935fSJohn Snow     /* Should not be reachable via external interface for internal jobs */
57033e9e9bdSKevin Wolf     assert(job->job.id);
571a50c2ab8SKevin Wolf     if (job_apply_verb(&job->job, JOB_VERB_COMPLETE, errp)) {
5720ec4dfb8SJohn Snow         return;
5730ec4dfb8SJohn Snow     }
574da01ff7fSKevin Wolf     if (job->job.pause_count || job_is_cancelled(&job->job) ||
575daa7f2f9SKevin Wolf         !job->driver->complete)
576daa7f2f9SKevin Wolf     {
5779df229c3SAlberto Garcia         error_setg(errp, "The active block job '%s' cannot be completed",
57833e9e9bdSKevin Wolf                    job->job.id);
579aeae883bSPaolo Bonzini         return;
580aeae883bSPaolo Bonzini     }
581aeae883bSPaolo Bonzini 
5823fc4b10aSFam Zheng     job->driver->complete(job, errp);
583aeae883bSPaolo Bonzini }
584aeae883bSPaolo Bonzini 
58511b61fbcSJohn Snow void block_job_finalize(BlockJob *job, Error **errp)
58611b61fbcSJohn Snow {
58733e9e9bdSKevin Wolf     assert(job && job->job.id);
588a50c2ab8SKevin Wolf     if (job_apply_verb(&job->job, JOB_VERB_FINALIZE, errp)) {
58911b61fbcSJohn Snow         return;
59011b61fbcSJohn Snow     }
59111b61fbcSJohn Snow     block_job_do_finalize(job);
59211b61fbcSJohn Snow }
59311b61fbcSJohn Snow 
59475f71059SJohn Snow void block_job_dismiss(BlockJob **jobptr, Error **errp)
59575f71059SJohn Snow {
59675f71059SJohn Snow     BlockJob *job = *jobptr;
59775f71059SJohn Snow     /* similarly to _complete, this is QMP-interface only. */
59833e9e9bdSKevin Wolf     assert(job->job.id);
599a50c2ab8SKevin Wolf     if (job_apply_verb(&job->job, JOB_VERB_DISMISS, errp)) {
60075f71059SJohn Snow         return;
60175f71059SJohn Snow     }
60275f71059SJohn Snow 
60375f71059SJohn Snow     block_job_do_dismiss(job);
60475f71059SJohn Snow     *jobptr = NULL;
60575f71059SJohn Snow }
60675f71059SJohn Snow 
607b76e4458SLiang Li void block_job_cancel(BlockJob *job, bool force)
6088acc72a4SPaolo Bonzini {
609a50c2ab8SKevin Wolf     if (job->job.status == JOB_STATUS_CONCLUDED) {
61075f71059SJohn Snow         block_job_do_dismiss(job);
61111b61fbcSJohn Snow         return;
61211b61fbcSJohn Snow     }
613b76e4458SLiang Li     block_job_cancel_async(job, force);
614da01ff7fSKevin Wolf     if (!job_started(&job->job)) {
6155ccac6f1SJohn Snow         block_job_completed(job, -ECANCELED);
6161908a559SKevin Wolf     } else if (job->job.deferred_to_main_loop) {
61711b61fbcSJohn Snow         block_job_completed_txn_abort(job);
61811b61fbcSJohn Snow     } else {
61911b61fbcSJohn Snow         block_job_enter(job);
6205ccac6f1SJohn Snow     }
6218acc72a4SPaolo Bonzini }
6228acc72a4SPaolo Bonzini 
623b76e4458SLiang Li void block_job_user_cancel(BlockJob *job, bool force, Error **errp)
6240ec4dfb8SJohn Snow {
625a50c2ab8SKevin Wolf     if (job_apply_verb(&job->job, JOB_VERB_CANCEL, errp)) {
6260ec4dfb8SJohn Snow         return;
6270ec4dfb8SJohn Snow     }
628b76e4458SLiang Li     block_job_cancel(job, force);
6290ec4dfb8SJohn Snow }
6300ec4dfb8SJohn Snow 
631345f9e1bSMax Reitz /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be
632345f9e1bSMax Reitz  * used with block_job_finish_sync() without the need for (rather nasty)
633345f9e1bSMax Reitz  * function pointer casts there. */
634345f9e1bSMax Reitz static void block_job_cancel_err(BlockJob *job, Error **errp)
635345f9e1bSMax Reitz {
636b76e4458SLiang Li     block_job_cancel(job, false);
637345f9e1bSMax Reitz }
638345f9e1bSMax Reitz 
639345f9e1bSMax Reitz int block_job_cancel_sync(BlockJob *job)
640345f9e1bSMax Reitz {
641345f9e1bSMax Reitz     return block_job_finish_sync(job, &block_job_cancel_err, NULL);
642345f9e1bSMax Reitz }
643345f9e1bSMax Reitz 
644a1a2af07SKevin Wolf void block_job_cancel_sync_all(void)
645a1a2af07SKevin Wolf {
646a1a2af07SKevin Wolf     BlockJob *job;
647a1a2af07SKevin Wolf     AioContext *aio_context;
648a1a2af07SKevin Wolf 
649e7c1d78bSKevin Wolf     while ((job = block_job_next(NULL))) {
650b6d2e599SKevin Wolf         aio_context = blk_get_aio_context(job->blk);
651a1a2af07SKevin Wolf         aio_context_acquire(aio_context);
652a1a2af07SKevin Wolf         block_job_cancel_sync(job);
653a1a2af07SKevin Wolf         aio_context_release(aio_context);
654a1a2af07SKevin Wolf     }
655a1a2af07SKevin Wolf }
656a1a2af07SKevin Wolf 
657345f9e1bSMax Reitz int block_job_complete_sync(BlockJob *job, Error **errp)
658345f9e1bSMax Reitz {
659345f9e1bSMax Reitz     return block_job_finish_sync(job, &block_job_complete, errp);
660345f9e1bSMax Reitz }
661345f9e1bSMax Reitz 
66205df8a6aSKevin Wolf void block_job_progress_update(BlockJob *job, uint64_t done)
66305df8a6aSKevin Wolf {
66405df8a6aSKevin Wolf     job->offset += done;
66505df8a6aSKevin Wolf }
66605df8a6aSKevin Wolf 
66705df8a6aSKevin Wolf void block_job_progress_set_remaining(BlockJob *job, uint64_t remaining)
66805df8a6aSKevin Wolf {
66905df8a6aSKevin Wolf     job->len = job->offset + remaining;
67005df8a6aSKevin Wolf }
67105df8a6aSKevin Wolf 
672559b935fSJohn Snow BlockJobInfo *block_job_query(BlockJob *job, Error **errp)
67330e628b7SPaolo Bonzini {
674559b935fSJohn Snow     BlockJobInfo *info;
675559b935fSJohn Snow 
676559b935fSJohn Snow     if (block_job_is_internal(job)) {
677559b935fSJohn Snow         error_setg(errp, "Cannot query QEMU internal jobs");
678559b935fSJohn Snow         return NULL;
679559b935fSJohn Snow     }
680559b935fSJohn Snow     info = g_new0(BlockJobInfo, 1);
681252291eaSKevin Wolf     info->type      = g_strdup(job_type_str(&job->job));
68233e9e9bdSKevin Wolf     info->device    = g_strdup(job->job.id);
68330e628b7SPaolo Bonzini     info->len       = job->len;
684da01ff7fSKevin Wolf     info->busy      = atomic_read(&job->job.busy);
685da01ff7fSKevin Wolf     info->paused    = job->job.pause_count > 0;
68630e628b7SPaolo Bonzini     info->offset    = job->offset;
68730e628b7SPaolo Bonzini     info->speed     = job->speed;
68832c81a4aSPaolo Bonzini     info->io_status = job->iostatus;
689ef6dbf1eSMax Reitz     info->ready     = job->ready;
690a50c2ab8SKevin Wolf     info->status    = job->job.status;
691*bb02b65cSKevin Wolf     info->auto_finalize = job->job.auto_finalize;
692*bb02b65cSKevin Wolf     info->auto_dismiss  = job->job.auto_dismiss;
693ab9ba614SJohn Snow     info->has_error = job->ret != 0;
694ab9ba614SJohn Snow     info->error     = job->ret ? g_strdup(strerror(-job->ret)) : NULL;
69530e628b7SPaolo Bonzini     return info;
69630e628b7SPaolo Bonzini }
69732c81a4aSPaolo Bonzini 
69832c81a4aSPaolo Bonzini static void block_job_iostatus_set_err(BlockJob *job, int error)
69932c81a4aSPaolo Bonzini {
70032c81a4aSPaolo Bonzini     if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
70132c81a4aSPaolo Bonzini         job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
70232c81a4aSPaolo Bonzini                                           BLOCK_DEVICE_IO_STATUS_FAILED;
70332c81a4aSPaolo Bonzini     }
70432c81a4aSPaolo Bonzini }
70532c81a4aSPaolo Bonzini 
7068254b6d9SJohn Snow static void block_job_event_cancelled(BlockJob *job)
707a66a2a36SPaolo Bonzini {
708559b935fSJohn Snow     if (block_job_is_internal(job)) {
709559b935fSJohn Snow         return;
710559b935fSJohn Snow     }
711559b935fSJohn Snow 
712252291eaSKevin Wolf     qapi_event_send_block_job_cancelled(job_type(&job->job),
71333e9e9bdSKevin Wolf                                         job->job.id,
714a66a2a36SPaolo Bonzini                                         job->len,
715a66a2a36SPaolo Bonzini                                         job->offset,
716bcada37bSWenchao Xia                                         job->speed,
717bcada37bSWenchao Xia                                         &error_abort);
718a66a2a36SPaolo Bonzini }
719a66a2a36SPaolo Bonzini 
7208254b6d9SJohn Snow static void block_job_event_completed(BlockJob *job, const char *msg)
721a66a2a36SPaolo Bonzini {
722559b935fSJohn Snow     if (block_job_is_internal(job)) {
723559b935fSJohn Snow         return;
724559b935fSJohn Snow     }
725559b935fSJohn Snow 
726252291eaSKevin Wolf     qapi_event_send_block_job_completed(job_type(&job->job),
72733e9e9bdSKevin Wolf                                         job->job.id,
728bcada37bSWenchao Xia                                         job->len,
729bcada37bSWenchao Xia                                         job->offset,
730bcada37bSWenchao Xia                                         job->speed,
731bcada37bSWenchao Xia                                         !!msg,
732bcada37bSWenchao Xia                                         msg,
733bcada37bSWenchao Xia                                         &error_abort);
734bcada37bSWenchao Xia }
735bcada37bSWenchao Xia 
7365f241594SJohn Snow static int block_job_event_pending(BlockJob *job)
7375f241594SJohn Snow {
738a50c2ab8SKevin Wolf     job_state_transition(&job->job, JOB_STATUS_PENDING);
739*bb02b65cSKevin Wolf     if (!job->job.auto_finalize && !block_job_is_internal(job)) {
740252291eaSKevin Wolf         qapi_event_send_block_job_pending(job_type(&job->job),
74133e9e9bdSKevin Wolf                                           job->job.id,
7425f241594SJohn Snow                                           &error_abort);
7435f241594SJohn Snow     }
7445f241594SJohn Snow     return 0;
7455f241594SJohn Snow }
7465f241594SJohn Snow 
74788691b37SPaolo Bonzini /*
74888691b37SPaolo Bonzini  * API for block job drivers and the block layer.  These functions are
74988691b37SPaolo Bonzini  * declared in blockjob_int.h.
75088691b37SPaolo Bonzini  */
75188691b37SPaolo Bonzini 
75288691b37SPaolo Bonzini void *block_job_create(const char *job_id, const BlockJobDriver *driver,
75375859b94SJohn Snow                        BlockJobTxn *txn, BlockDriverState *bs, uint64_t perm,
75488691b37SPaolo Bonzini                        uint64_t shared_perm, int64_t speed, int flags,
75588691b37SPaolo Bonzini                        BlockCompletionFunc *cb, void *opaque, Error **errp)
75688691b37SPaolo Bonzini {
75788691b37SPaolo Bonzini     BlockBackend *blk;
75888691b37SPaolo Bonzini     BlockJob *job;
75988691b37SPaolo Bonzini     int ret;
76088691b37SPaolo Bonzini 
76188691b37SPaolo Bonzini     if (bs->job) {
76288691b37SPaolo Bonzini         error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs));
76388691b37SPaolo Bonzini         return NULL;
76488691b37SPaolo Bonzini     }
76588691b37SPaolo Bonzini 
766*bb02b65cSKevin Wolf     if (job_id == NULL && !(flags & JOB_INTERNAL)) {
76788691b37SPaolo Bonzini         job_id = bdrv_get_device_name(bs);
76888691b37SPaolo Bonzini     }
76988691b37SPaolo Bonzini 
77088691b37SPaolo Bonzini     blk = blk_new(perm, shared_perm);
77188691b37SPaolo Bonzini     ret = blk_insert_bs(blk, bs, errp);
77288691b37SPaolo Bonzini     if (ret < 0) {
77388691b37SPaolo Bonzini         blk_unref(blk);
77488691b37SPaolo Bonzini         return NULL;
77588691b37SPaolo Bonzini     }
77688691b37SPaolo Bonzini 
77708be6fe2SKevin Wolf     job = job_create(job_id, &driver->job_driver, blk_get_aio_context(blk),
778*bb02b65cSKevin Wolf                      flags, errp);
77933e9e9bdSKevin Wolf     if (job == NULL) {
78033e9e9bdSKevin Wolf         blk_unref(blk);
78133e9e9bdSKevin Wolf         return NULL;
78233e9e9bdSKevin Wolf     }
78333e9e9bdSKevin Wolf 
784e7c1d78bSKevin Wolf     assert(is_block_job(&job->job));
78580fa2c75SKevin Wolf     assert(job->job.driver->free == &block_job_free);
786b15de828SKevin Wolf     assert(job->job.driver->user_resume == &block_job_user_resume);
787e7c1d78bSKevin Wolf 
78888691b37SPaolo Bonzini     job->driver        = driver;
78988691b37SPaolo Bonzini     job->blk           = blk;
79088691b37SPaolo Bonzini     job->cb            = cb;
79188691b37SPaolo Bonzini     job->opaque        = opaque;
79288691b37SPaolo Bonzini 
79388691b37SPaolo Bonzini     error_setg(&job->blocker, "block device is in use by block job: %s",
794252291eaSKevin Wolf                job_type_str(&job->job));
79588691b37SPaolo Bonzini     block_job_add_bdrv(job, "main node", bs, 0, BLK_PERM_ALL, &error_abort);
79688691b37SPaolo Bonzini     bs->job = job;
79788691b37SPaolo Bonzini 
79888691b37SPaolo Bonzini     bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker);
79988691b37SPaolo Bonzini 
80088691b37SPaolo Bonzini     blk_add_aio_context_notifier(blk, block_job_attached_aio_context,
80188691b37SPaolo Bonzini                                  block_job_detach_aio_context, job);
80288691b37SPaolo Bonzini 
80388691b37SPaolo Bonzini     /* Only set speed when necessary to avoid NotSupported error */
80488691b37SPaolo Bonzini     if (speed != 0) {
80588691b37SPaolo Bonzini         Error *local_err = NULL;
80688691b37SPaolo Bonzini 
80788691b37SPaolo Bonzini         block_job_set_speed(job, speed, &local_err);
80888691b37SPaolo Bonzini         if (local_err) {
8093925cd3bSJohn Snow             block_job_early_fail(job);
81088691b37SPaolo Bonzini             error_propagate(errp, local_err);
81188691b37SPaolo Bonzini             return NULL;
81288691b37SPaolo Bonzini         }
81388691b37SPaolo Bonzini     }
81475859b94SJohn Snow 
81575859b94SJohn Snow     /* Single jobs are modeled as single-job transactions for sake of
81675859b94SJohn Snow      * consolidating the job management logic */
81775859b94SJohn Snow     if (!txn) {
81875859b94SJohn Snow         txn = block_job_txn_new();
81975859b94SJohn Snow         block_job_txn_add_job(txn, job);
82075859b94SJohn Snow         block_job_txn_unref(txn);
82175859b94SJohn Snow     } else {
82275859b94SJohn Snow         block_job_txn_add_job(txn, job);
82375859b94SJohn Snow     }
82475859b94SJohn Snow 
82588691b37SPaolo Bonzini     return job;
82688691b37SPaolo Bonzini }
82788691b37SPaolo Bonzini 
82888691b37SPaolo Bonzini void block_job_early_fail(BlockJob *job)
82988691b37SPaolo Bonzini {
830a50c2ab8SKevin Wolf     assert(job->job.status == JOB_STATUS_CREATED);
8313925cd3bSJohn Snow     block_job_decommission(job);
83288691b37SPaolo Bonzini }
83388691b37SPaolo Bonzini 
83488691b37SPaolo Bonzini void block_job_completed(BlockJob *job, int ret)
83588691b37SPaolo Bonzini {
836dbe5e6c1SKevin Wolf     assert(job && job->txn && !job_is_completed(&job->job));
83788691b37SPaolo Bonzini     assert(blk_bs(job->blk)->job == job);
83888691b37SPaolo Bonzini     job->ret = ret;
83935d6b368SJohn Snow     block_job_update_rc(job);
84035d6b368SJohn Snow     trace_block_job_completed(job, ret, job->ret);
84135d6b368SJohn Snow     if (job->ret) {
84288691b37SPaolo Bonzini         block_job_completed_txn_abort(job);
84388691b37SPaolo Bonzini     } else {
84488691b37SPaolo Bonzini         block_job_completed_txn_success(job);
84588691b37SPaolo Bonzini     }
84688691b37SPaolo Bonzini }
84788691b37SPaolo Bonzini 
848aa9ef2e6SJohn Snow void block_job_enter(BlockJob *job)
849aa9ef2e6SJohn Snow {
850da01ff7fSKevin Wolf     job_enter_cond(&job->job, NULL);
851aa9ef2e6SJohn Snow }
852aa9ef2e6SJohn Snow 
85388691b37SPaolo Bonzini void block_job_yield(BlockJob *job)
85488691b37SPaolo Bonzini {
855da01ff7fSKevin Wolf     assert(job->job.busy);
85688691b37SPaolo Bonzini 
85788691b37SPaolo Bonzini     /* Check cancellation *before* setting busy = false, too!  */
858daa7f2f9SKevin Wolf     if (job_is_cancelled(&job->job)) {
85988691b37SPaolo Bonzini         return;
86088691b37SPaolo Bonzini     }
86188691b37SPaolo Bonzini 
862da01ff7fSKevin Wolf     if (!job_should_pause(&job->job)) {
863da01ff7fSKevin Wolf         job_do_yield(&job->job, -1);
86488691b37SPaolo Bonzini     }
86588691b37SPaolo Bonzini 
866da01ff7fSKevin Wolf     job_pause_point(&job->job);
86788691b37SPaolo Bonzini }
86888691b37SPaolo Bonzini 
8692caf63a9SPaolo Bonzini void block_job_iostatus_reset(BlockJob *job)
8702caf63a9SPaolo Bonzini {
8714c241cf5SPaolo Bonzini     if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
8724c241cf5SPaolo Bonzini         return;
8734c241cf5SPaolo Bonzini     }
874b15de828SKevin Wolf     assert(job->job.user_paused && job->job.pause_count > 0);
8752caf63a9SPaolo Bonzini     job->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
8762caf63a9SPaolo Bonzini }
8772caf63a9SPaolo Bonzini 
878b15de828SKevin Wolf void block_job_user_resume(Job *job)
879b15de828SKevin Wolf {
880b15de828SKevin Wolf     BlockJob *bjob = container_of(job, BlockJob, job);
881b15de828SKevin Wolf     block_job_iostatus_reset(bjob);
882b15de828SKevin Wolf }
883b15de828SKevin Wolf 
884bcada37bSWenchao Xia void block_job_event_ready(BlockJob *job)
885bcada37bSWenchao Xia {
886a50c2ab8SKevin Wolf     job_state_transition(&job->job, JOB_STATUS_READY);
887ef6dbf1eSMax Reitz     job->ready = true;
888ef6dbf1eSMax Reitz 
889559b935fSJohn Snow     if (block_job_is_internal(job)) {
890559b935fSJohn Snow         return;
891559b935fSJohn Snow     }
892559b935fSJohn Snow 
893252291eaSKevin Wolf     qapi_event_send_block_job_ready(job_type(&job->job),
89433e9e9bdSKevin Wolf                                     job->job.id,
895518848a2SMarkus Armbruster                                     job->len,
896518848a2SMarkus Armbruster                                     job->offset,
897518848a2SMarkus Armbruster                                     job->speed, &error_abort);
898a66a2a36SPaolo Bonzini }
899a66a2a36SPaolo Bonzini 
90081e254dcSKevin Wolf BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err,
90132c81a4aSPaolo Bonzini                                         int is_read, int error)
90232c81a4aSPaolo Bonzini {
90332c81a4aSPaolo Bonzini     BlockErrorAction action;
90432c81a4aSPaolo Bonzini 
90532c81a4aSPaolo Bonzini     switch (on_err) {
90632c81a4aSPaolo Bonzini     case BLOCKDEV_ON_ERROR_ENOSPC:
9078c398252SKevin Wolf     case BLOCKDEV_ON_ERROR_AUTO:
908a589569fSWenchao Xia         action = (error == ENOSPC) ?
909a589569fSWenchao Xia                  BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT;
91032c81a4aSPaolo Bonzini         break;
91132c81a4aSPaolo Bonzini     case BLOCKDEV_ON_ERROR_STOP:
912a589569fSWenchao Xia         action = BLOCK_ERROR_ACTION_STOP;
91332c81a4aSPaolo Bonzini         break;
91432c81a4aSPaolo Bonzini     case BLOCKDEV_ON_ERROR_REPORT:
915a589569fSWenchao Xia         action = BLOCK_ERROR_ACTION_REPORT;
91632c81a4aSPaolo Bonzini         break;
91732c81a4aSPaolo Bonzini     case BLOCKDEV_ON_ERROR_IGNORE:
918a589569fSWenchao Xia         action = BLOCK_ERROR_ACTION_IGNORE;
91932c81a4aSPaolo Bonzini         break;
92032c81a4aSPaolo Bonzini     default:
92132c81a4aSPaolo Bonzini         abort();
92232c81a4aSPaolo Bonzini     }
923559b935fSJohn Snow     if (!block_job_is_internal(job)) {
92433e9e9bdSKevin Wolf         qapi_event_send_block_job_error(job->job.id,
9255a2d2cbdSWenchao Xia                                         is_read ? IO_OPERATION_TYPE_READ :
9265a2d2cbdSWenchao Xia                                         IO_OPERATION_TYPE_WRITE,
9275a2d2cbdSWenchao Xia                                         action, &error_abort);
928559b935fSJohn Snow     }
929a589569fSWenchao Xia     if (action == BLOCK_ERROR_ACTION_STOP) {
930b15de828SKevin Wolf         job_pause(&job->job);
931751ebd76SFam Zheng         /* make the pause user visible, which will be resumed from QMP. */
932b15de828SKevin Wolf         job->job.user_paused = true;
93332c81a4aSPaolo Bonzini         block_job_iostatus_set_err(job, error);
93432c81a4aSPaolo Bonzini     }
93532c81a4aSPaolo Bonzini     return action;
93632c81a4aSPaolo Bonzini }
937