1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26#include "qemu/osdep.h"
27#include "qemu-common.h"
28#include "block/block.h"
29#include "block/blockjob_int.h"
30#include "block/block_int.h"
31#include "block/trace.h"
32#include "sysemu/block-backend.h"
33#include "qapi/error.h"
34#include "qapi/qapi-events-block-core.h"
35#include "qapi/qmp/qerror.h"
36#include "qemu/coroutine.h"
37#include "qemu/timer.h"
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54static bool is_block_job(Job *job)
55{
56 return job_type(job) == JOB_TYPE_BACKUP ||
57 job_type(job) == JOB_TYPE_COMMIT ||
58 job_type(job) == JOB_TYPE_MIRROR ||
59 job_type(job) == JOB_TYPE_STREAM;
60}
61
62BlockJob *block_job_next(BlockJob *bjob)
63{
64 Job *job = bjob ? &bjob->job : NULL;
65
66 do {
67 job = job_next(job);
68 } while (job && !is_block_job(job));
69
70 return job ? container_of(job, BlockJob, job) : NULL;
71}
72
73BlockJob *block_job_get(const char *id)
74{
75 Job *job = job_get(id);
76
77 if (job && is_block_job(job)) {
78 return container_of(job, BlockJob, job);
79 } else {
80 return NULL;
81 }
82}
83
84static void block_job_attached_aio_context(AioContext *new_context,
85 void *opaque);
86static void block_job_detach_aio_context(void *opaque);
87
88void block_job_free(Job *job)
89{
90 BlockJob *bjob = container_of(job, BlockJob, job);
91 BlockDriverState *bs = blk_bs(bjob->blk);
92
93 bs->job = NULL;
94 block_job_remove_all_bdrv(bjob);
95 blk_remove_aio_context_notifier(bjob->blk,
96 block_job_attached_aio_context,
97 block_job_detach_aio_context, bjob);
98 blk_unref(bjob->blk);
99 error_free(bjob->blocker);
100}
101
102static void block_job_attached_aio_context(AioContext *new_context,
103 void *opaque)
104{
105 BlockJob *job = opaque;
106 const JobDriver *drv = job->job.driver;
107 BlockJobDriver *bjdrv = container_of(drv, BlockJobDriver, job_driver);
108
109 job->job.aio_context = new_context;
110 if (bjdrv->attached_aio_context) {
111 bjdrv->attached_aio_context(job, new_context);
112 }
113
114 job_resume(&job->job);
115}
116
117void block_job_drain(Job *job)
118{
119 BlockJob *bjob = container_of(job, BlockJob, job);
120 const JobDriver *drv = job->driver;
121 BlockJobDriver *bjdrv = container_of(drv, BlockJobDriver, job_driver);
122
123 blk_drain(bjob->blk);
124 if (bjdrv->drain) {
125 bjdrv->drain(bjob);
126 }
127}
128
129static void block_job_detach_aio_context(void *opaque)
130{
131 BlockJob *job = opaque;
132
133
134 job_ref(&job->job);
135
136 job_pause(&job->job);
137
138 while (!job->job.paused && !job_is_completed(&job->job)) {
139 job_drain(&job->job);
140 }
141
142 job->job.aio_context = NULL;
143 job_unref(&job->job);
144}
145
146static char *child_job_get_parent_desc(BdrvChild *c)
147{
148 BlockJob *job = c->opaque;
149 return g_strdup_printf("%s job '%s'", job_type_str(&job->job), job->job.id);
150}
151
152static void child_job_drained_begin(BdrvChild *c)
153{
154 BlockJob *job = c->opaque;
155 job_pause(&job->job);
156}
157
158static bool child_job_drained_poll(BdrvChild *c)
159{
160 BlockJob *bjob = c->opaque;
161 Job *job = &bjob->job;
162 const BlockJobDriver *drv = block_job_driver(bjob);
163
164
165
166
167 if (!job->busy || job_is_completed(job)) {
168 return false;
169 }
170
171
172
173 if (drv->drained_poll) {
174 return drv->drained_poll(bjob);
175 } else {
176 return true;
177 }
178}
179
180static void child_job_drained_end(BdrvChild *c)
181{
182 BlockJob *job = c->opaque;
183 job_resume(&job->job);
184}
185
186static const BdrvChildRole child_job = {
187 .get_parent_desc = child_job_get_parent_desc,
188 .drained_begin = child_job_drained_begin,
189 .drained_poll = child_job_drained_poll,
190 .drained_end = child_job_drained_end,
191 .stay_at_node = true,
192};
193
194void block_job_remove_all_bdrv(BlockJob *job)
195{
196
197
198
199
200
201
202 while (job->nodes) {
203 GSList *l = job->nodes;
204 BdrvChild *c = l->data;
205
206 job->nodes = l->next;
207
208 bdrv_op_unblock_all(c->bs, job->blocker);
209 bdrv_root_unref_child(c);
210
211 g_slist_free_1(l);
212 }
213}
214
215int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs,
216 uint64_t perm, uint64_t shared_perm, Error **errp)
217{
218 BdrvChild *c;
219
220 c = bdrv_root_attach_child(bs, name, &child_job, perm, shared_perm,
221 job, errp);
222 if (c == NULL) {
223 return -EPERM;
224 }
225
226 job->nodes = g_slist_prepend(job->nodes, c);
227 bdrv_ref(bs);
228 bdrv_op_block_all(bs, job->blocker);
229
230 return 0;
231}
232
233static void block_job_on_idle(Notifier *n, void *opaque)
234{
235 aio_wait_kick();
236}
237
238bool block_job_is_internal(BlockJob *job)
239{
240 return (job->job.id == NULL);
241}
242
243const BlockJobDriver *block_job_driver(BlockJob *job)
244{
245 return container_of(job->job.driver, BlockJobDriver, job_driver);
246}
247
248
249static bool job_timer_pending(Job *job)
250{
251 return timer_pending(&job->sleep_timer);
252}
253
254void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp)
255{
256 int64_t old_speed = job->speed;
257
258 if (job_apply_verb(&job->job, JOB_VERB_SET_SPEED, errp)) {
259 return;
260 }
261 if (speed < 0) {
262 error_setg(errp, QERR_INVALID_PARAMETER, "speed");
263 return;
264 }
265
266 ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME);
267
268 job->speed = speed;
269 if (speed && speed <= old_speed) {
270 return;
271 }
272
273
274 job_enter_cond(&job->job, job_timer_pending);
275}
276
277int64_t block_job_ratelimit_get_delay(BlockJob *job, uint64_t n)
278{
279 if (!job->speed) {
280 return 0;
281 }
282
283 return ratelimit_calculate_delay(&job->limit, n);
284}
285
286BlockJobInfo *block_job_query(BlockJob *job, Error **errp)
287{
288 BlockJobInfo *info;
289
290 if (block_job_is_internal(job)) {
291 error_setg(errp, "Cannot query QEMU internal jobs");
292 return NULL;
293 }
294 info = g_new0(BlockJobInfo, 1);
295 info->type = g_strdup(job_type_str(&job->job));
296 info->device = g_strdup(job->job.id);
297 info->busy = atomic_read(&job->job.busy);
298 info->paused = job->job.pause_count > 0;
299 info->offset = job->job.progress_current;
300 info->len = job->job.progress_total;
301 info->speed = job->speed;
302 info->io_status = job->iostatus;
303 info->ready = job_is_ready(&job->job),
304 info->status = job->job.status;
305 info->auto_finalize = job->job.auto_finalize;
306 info->auto_dismiss = job->job.auto_dismiss;
307 info->has_error = job->job.ret != 0;
308 info->error = job->job.ret ? g_strdup(strerror(-job->job.ret)) : NULL;
309 return info;
310}
311
312static void block_job_iostatus_set_err(BlockJob *job, int error)
313{
314 if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
315 job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
316 BLOCK_DEVICE_IO_STATUS_FAILED;
317 }
318}
319
320static void block_job_event_cancelled(Notifier *n, void *opaque)
321{
322 BlockJob *job = opaque;
323
324 if (block_job_is_internal(job)) {
325 return;
326 }
327
328 qapi_event_send_block_job_cancelled(job_type(&job->job),
329 job->job.id,
330 job->job.progress_total,
331 job->job.progress_current,
332 job->speed);
333}
334
335static void block_job_event_completed(Notifier *n, void *opaque)
336{
337 BlockJob *job = opaque;
338 const char *msg = NULL;
339
340 if (block_job_is_internal(job)) {
341 return;
342 }
343
344 if (job->job.ret < 0) {
345 msg = strerror(-job->job.ret);
346 }
347
348 qapi_event_send_block_job_completed(job_type(&job->job),
349 job->job.id,
350 job->job.progress_total,
351 job->job.progress_current,
352 job->speed,
353 !!msg,
354 msg);
355}
356
357static void block_job_event_pending(Notifier *n, void *opaque)
358{
359 BlockJob *job = opaque;
360
361 if (block_job_is_internal(job)) {
362 return;
363 }
364
365 qapi_event_send_block_job_pending(job_type(&job->job),
366 job->job.id);
367}
368
369static void block_job_event_ready(Notifier *n, void *opaque)
370{
371 BlockJob *job = opaque;
372
373 if (block_job_is_internal(job)) {
374 return;
375 }
376
377 qapi_event_send_block_job_ready(job_type(&job->job),
378 job->job.id,
379 job->job.progress_total,
380 job->job.progress_current,
381 job->speed);
382}
383
384
385
386
387
388
389
390void *block_job_create(const char *job_id, const BlockJobDriver *driver,
391 JobTxn *txn, BlockDriverState *bs, uint64_t perm,
392 uint64_t shared_perm, int64_t speed, int flags,
393 BlockCompletionFunc *cb, void *opaque, Error **errp)
394{
395 BlockBackend *blk;
396 BlockJob *job;
397 int ret;
398
399 if (bs->job) {
400 error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs));
401 return NULL;
402 }
403
404 if (job_id == NULL && !(flags & JOB_INTERNAL)) {
405 job_id = bdrv_get_device_name(bs);
406 }
407
408 blk = blk_new(perm, shared_perm);
409 ret = blk_insert_bs(blk, bs, errp);
410 if (ret < 0) {
411 blk_unref(blk);
412 return NULL;
413 }
414
415 job = job_create(job_id, &driver->job_driver, txn, blk_get_aio_context(blk),
416 flags, cb, opaque, errp);
417 if (job == NULL) {
418 blk_unref(blk);
419 return NULL;
420 }
421
422 assert(is_block_job(&job->job));
423 assert(job->job.driver->free == &block_job_free);
424 assert(job->job.driver->user_resume == &block_job_user_resume);
425 assert(job->job.driver->drain == &block_job_drain);
426
427 job->blk = blk;
428
429 job->finalize_cancelled_notifier.notify = block_job_event_cancelled;
430 job->finalize_completed_notifier.notify = block_job_event_completed;
431 job->pending_notifier.notify = block_job_event_pending;
432 job->ready_notifier.notify = block_job_event_ready;
433 job->idle_notifier.notify = block_job_on_idle;
434
435 notifier_list_add(&job->job.on_finalize_cancelled,
436 &job->finalize_cancelled_notifier);
437 notifier_list_add(&job->job.on_finalize_completed,
438 &job->finalize_completed_notifier);
439 notifier_list_add(&job->job.on_pending, &job->pending_notifier);
440 notifier_list_add(&job->job.on_ready, &job->ready_notifier);
441 notifier_list_add(&job->job.on_idle, &job->idle_notifier);
442
443 error_setg(&job->blocker, "block device is in use by block job: %s",
444 job_type_str(&job->job));
445 block_job_add_bdrv(job, "main node", bs, 0, BLK_PERM_ALL, &error_abort);
446 bs->job = job;
447
448 bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker);
449
450 blk_add_aio_context_notifier(blk, block_job_attached_aio_context,
451 block_job_detach_aio_context, job);
452
453
454 if (speed != 0) {
455 Error *local_err = NULL;
456
457 block_job_set_speed(job, speed, &local_err);
458 if (local_err) {
459 job_early_fail(&job->job);
460 error_propagate(errp, local_err);
461 return NULL;
462 }
463 }
464
465 return job;
466}
467
468void block_job_iostatus_reset(BlockJob *job)
469{
470 if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
471 return;
472 }
473 assert(job->job.user_paused && job->job.pause_count > 0);
474 job->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
475}
476
477void block_job_user_resume(Job *job)
478{
479 BlockJob *bjob = container_of(job, BlockJob, job);
480 block_job_iostatus_reset(bjob);
481}
482
483BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err,
484 int is_read, int error)
485{
486 BlockErrorAction action;
487
488 switch (on_err) {
489 case BLOCKDEV_ON_ERROR_ENOSPC:
490 case BLOCKDEV_ON_ERROR_AUTO:
491 action = (error == ENOSPC) ?
492 BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT;
493 break;
494 case BLOCKDEV_ON_ERROR_STOP:
495 action = BLOCK_ERROR_ACTION_STOP;
496 break;
497 case BLOCKDEV_ON_ERROR_REPORT:
498 action = BLOCK_ERROR_ACTION_REPORT;
499 break;
500 case BLOCKDEV_ON_ERROR_IGNORE:
501 action = BLOCK_ERROR_ACTION_IGNORE;
502 break;
503 default:
504 abort();
505 }
506 if (!block_job_is_internal(job)) {
507 qapi_event_send_block_job_error(job->job.id,
508 is_read ? IO_OPERATION_TYPE_READ :
509 IO_OPERATION_TYPE_WRITE,
510 action);
511 }
512 if (action == BLOCK_ERROR_ACTION_STOP) {
513 if (!job->job.user_paused) {
514 job_pause(&job->job);
515
516 job->job.user_paused = true;
517 }
518 block_job_iostatus_set_err(job, error);
519 }
520 return action;
521}
522