]> git.proxmox.com Git - mirror_qemu.git/blame - tests/test-blockjob.c
job: Move .complete callback to Job
[mirror_qemu.git] / tests / test-blockjob.c
CommitLineData
9ef8112a
AG
1/*
2 * Blockjob tests
3 *
4 * Copyright Igalia, S.L. 2016
5 *
6 * Authors:
7 * Alberto Garcia <berto@igalia.com>
8 *
9 * This work is licensed under the terms of the GNU LGPL, version 2 or later.
10 * See the COPYING.LIB file in the top-level directory.
11 */
12
13#include "qemu/osdep.h"
14#include "qapi/error.h"
15#include "qemu/main-loop.h"
c87621ea 16#include "block/blockjob_int.h"
9ef8112a
AG
17#include "sysemu/block-backend.h"
18
19static const BlockJobDriver test_block_job_driver = {
33e9e9bd
KW
20 .job_driver = {
21 .instance_size = sizeof(BlockJob),
80fa2c75 22 .free = block_job_free,
b15de828 23 .user_resume = block_job_user_resume,
b69f777d 24 .drain = block_job_drain,
33e9e9bd 25 },
9ef8112a
AG
26};
27
28static void block_job_cb(void *opaque, int ret)
29{
30}
31
fb367e03
JS
32static BlockJob *mk_job(BlockBackend *blk, const char *id,
33 const BlockJobDriver *drv, bool should_succeed,
34 int flags)
9ef8112a
AG
35{
36 BlockJob *job;
37 Error *errp = NULL;
38
fb367e03
JS
39 job = block_job_create(id, drv, NULL, blk_bs(blk),
40 0, BLK_PERM_ALL, 0, flags, block_job_cb,
c6cc12bf 41 NULL, &errp);
9ef8112a
AG
42 if (should_succeed) {
43 g_assert_null(errp);
44 g_assert_nonnull(job);
45 if (id) {
33e9e9bd 46 g_assert_cmpstr(job->job.id, ==, id);
9ef8112a 47 } else {
33e9e9bd 48 g_assert_cmpstr(job->job.id, ==, blk_name(blk));
9ef8112a
AG
49 }
50 } else {
51 g_assert_nonnull(errp);
52 g_assert_null(job);
53 error_free(errp);
54 }
55
56 return job;
57}
58
fb367e03
JS
59static BlockJob *do_test_id(BlockBackend *blk, const char *id,
60 bool should_succeed)
61{
62 return mk_job(blk, id, &test_block_job_driver,
bb02b65c 63 should_succeed, JOB_DEFAULT);
fb367e03
JS
64}
65
9ef8112a
AG
66/* This creates a BlockBackend (optionally with a name) with a
67 * BlockDriverState inserted. */
68static BlockBackend *create_blk(const char *name)
69{
2807c0cd 70 /* No I/O is performed on this device */
6d0eb64d 71 BlockBackend *blk = blk_new(0, BLK_PERM_ALL);
d185cf0e
KW
72 BlockDriverState *bs;
73
74 bs = bdrv_open("null-co://", NULL, NULL, 0, &error_abort);
75 g_assert_nonnull(bs);
9ef8112a 76
d7086422 77 blk_insert_bs(blk, bs, &error_abort);
9ef8112a
AG
78 bdrv_unref(bs);
79
80 if (name) {
81 Error *errp = NULL;
82 monitor_add_blk(blk, name, &errp);
83 g_assert_null(errp);
84 }
85
86 return blk;
87}
88
89/* This destroys the backend */
90static void destroy_blk(BlockBackend *blk)
91{
92 if (blk_name(blk)[0] != '\0') {
93 monitor_remove_blk(blk);
94 }
95
96 blk_remove_bs(blk);
97 blk_unref(blk);
98}
99
100static void test_job_ids(void)
101{
102 BlockBackend *blk[3];
103 BlockJob *job[3];
104
105 blk[0] = create_blk(NULL);
106 blk[1] = create_blk("drive1");
107 blk[2] = create_blk("drive2");
108
109 /* No job ID provided and the block backend has no name */
110 job[0] = do_test_id(blk[0], NULL, false);
111
112 /* These are all invalid job IDs */
113 job[0] = do_test_id(blk[0], "0id", false);
114 job[0] = do_test_id(blk[0], "", false);
115 job[0] = do_test_id(blk[0], " ", false);
116 job[0] = do_test_id(blk[0], "123", false);
117 job[0] = do_test_id(blk[0], "_id", false);
118 job[0] = do_test_id(blk[0], "-id", false);
119 job[0] = do_test_id(blk[0], ".id", false);
120 job[0] = do_test_id(blk[0], "#id", false);
121
122 /* This one is valid */
123 job[0] = do_test_id(blk[0], "id0", true);
124
125 /* We cannot have two jobs in the same BDS */
126 do_test_id(blk[0], "id1", false);
127
128 /* Duplicate job IDs are not allowed */
129 job[1] = do_test_id(blk[1], "id0", false);
130
131 /* But once job[0] finishes we can reuse its ID */
4ad35181 132 job_early_fail(&job[0]->job);
9ef8112a
AG
133 job[1] = do_test_id(blk[1], "id0", true);
134
135 /* No job ID specified, defaults to the backend name ('drive1') */
4ad35181 136 job_early_fail(&job[1]->job);
9ef8112a
AG
137 job[1] = do_test_id(blk[1], NULL, true);
138
139 /* Duplicate job ID */
140 job[2] = do_test_id(blk[2], "drive1", false);
141
142 /* The ID of job[2] would default to 'drive2' but it is already in use */
143 job[0] = do_test_id(blk[0], "drive2", true);
144 job[2] = do_test_id(blk[2], NULL, false);
145
146 /* This one is valid */
147 job[2] = do_test_id(blk[2], "id_2", true);
148
4ad35181
KW
149 job_early_fail(&job[0]->job);
150 job_early_fail(&job[1]->job);
151 job_early_fail(&job[2]->job);
9ef8112a
AG
152
153 destroy_blk(blk[0]);
154 destroy_blk(blk[1]);
155 destroy_blk(blk[2]);
156}
157
fb367e03
JS
158typedef struct CancelJob {
159 BlockJob common;
160 BlockBackend *blk;
161 bool should_converge;
162 bool should_complete;
163 bool completed;
164} CancelJob;
165
1908a559 166static void cancel_job_completed(Job *job, void *opaque)
fb367e03 167{
1908a559 168 BlockJob *bjob = container_of(job, BlockJob, job);
fb367e03
JS
169 CancelJob *s = opaque;
170 s->completed = true;
1908a559 171 block_job_completed(bjob, 0);
fb367e03
JS
172}
173
3453d972 174static void cancel_job_complete(Job *job, Error **errp)
fb367e03 175{
3453d972 176 CancelJob *s = container_of(job, CancelJob, common.job);
fb367e03
JS
177 s->should_complete = true;
178}
179
180static void coroutine_fn cancel_job_start(void *opaque)
181{
182 CancelJob *s = opaque;
183
184 while (!s->should_complete) {
daa7f2f9 185 if (job_is_cancelled(&s->common.job)) {
fb367e03
JS
186 goto defer;
187 }
188
189 if (!s->common.ready && s->should_converge) {
190 block_job_event_ready(&s->common);
191 }
192
5d43e86e 193 job_sleep_ns(&s->common.job, 100000);
fb367e03
JS
194 }
195
196 defer:
1908a559 197 job_defer_to_main_loop(&s->common.job, cancel_job_completed, s);
fb367e03
JS
198}
199
200static const BlockJobDriver test_cancel_driver = {
33e9e9bd
KW
201 .job_driver = {
202 .instance_size = sizeof(CancelJob),
80fa2c75 203 .free = block_job_free,
b15de828 204 .user_resume = block_job_user_resume,
b69f777d 205 .drain = block_job_drain,
da01ff7f 206 .start = cancel_job_start,
3453d972 207 .complete = cancel_job_complete,
33e9e9bd 208 },
fb367e03
JS
209};
210
211static CancelJob *create_common(BlockJob **pjob)
212{
213 BlockBackend *blk;
214 BlockJob *job;
215 CancelJob *s;
216
217 blk = create_blk(NULL);
218 job = mk_job(blk, "Steve", &test_cancel_driver, true,
bb02b65c 219 JOB_MANUAL_FINALIZE | JOB_MANUAL_DISMISS);
80fa2c75 220 job_ref(&job->job);
a50c2ab8 221 assert(job->job.status == JOB_STATUS_CREATED);
fb367e03
JS
222 s = container_of(job, CancelJob, common);
223 s->blk = blk;
224
225 *pjob = job;
226 return s;
227}
228
229static void cancel_common(CancelJob *s)
230{
231 BlockJob *job = &s->common;
232 BlockBackend *blk = s->blk;
a50c2ab8 233 JobStatus sts = job->job.status;
fb367e03
JS
234
235 block_job_cancel_sync(job);
a50c2ab8 236 if (sts != JOB_STATUS_CREATED && sts != JOB_STATUS_CONCLUDED) {
fb367e03
JS
237 BlockJob *dummy = job;
238 block_job_dismiss(&dummy, &error_abort);
239 }
a50c2ab8 240 assert(job->job.status == JOB_STATUS_NULL);
80fa2c75 241 job_unref(&job->job);
fb367e03
JS
242 destroy_blk(blk);
243}
244
245static void test_cancel_created(void)
246{
247 BlockJob *job;
248 CancelJob *s;
249
250 s = create_common(&job);
251 cancel_common(s);
252}
253
254static void test_cancel_running(void)
255{
256 BlockJob *job;
257 CancelJob *s;
258
259 s = create_common(&job);
260
da01ff7f 261 job_start(&job->job);
a50c2ab8 262 assert(job->job.status == JOB_STATUS_RUNNING);
fb367e03
JS
263
264 cancel_common(s);
265}
266
267static void test_cancel_paused(void)
268{
269 BlockJob *job;
270 CancelJob *s;
271
272 s = create_common(&job);
273
da01ff7f 274 job_start(&job->job);
a50c2ab8 275 assert(job->job.status == JOB_STATUS_RUNNING);
fb367e03 276
b15de828 277 job_user_pause(&job->job, &error_abort);
fb367e03 278 block_job_enter(job);
a50c2ab8 279 assert(job->job.status == JOB_STATUS_PAUSED);
fb367e03
JS
280
281 cancel_common(s);
282}
283
284static void test_cancel_ready(void)
285{
286 BlockJob *job;
287 CancelJob *s;
288
289 s = create_common(&job);
290
da01ff7f 291 job_start(&job->job);
a50c2ab8 292 assert(job->job.status == JOB_STATUS_RUNNING);
fb367e03
JS
293
294 s->should_converge = true;
295 block_job_enter(job);
a50c2ab8 296 assert(job->job.status == JOB_STATUS_READY);
fb367e03
JS
297
298 cancel_common(s);
299}
300
301static void test_cancel_standby(void)
302{
303 BlockJob *job;
304 CancelJob *s;
305
306 s = create_common(&job);
307
da01ff7f 308 job_start(&job->job);
a50c2ab8 309 assert(job->job.status == JOB_STATUS_RUNNING);
fb367e03
JS
310
311 s->should_converge = true;
312 block_job_enter(job);
a50c2ab8 313 assert(job->job.status == JOB_STATUS_READY);
fb367e03 314
b15de828 315 job_user_pause(&job->job, &error_abort);
fb367e03 316 block_job_enter(job);
a50c2ab8 317 assert(job->job.status == JOB_STATUS_STANDBY);
fb367e03
JS
318
319 cancel_common(s);
320}
321
322static void test_cancel_pending(void)
323{
324 BlockJob *job;
325 CancelJob *s;
326
327 s = create_common(&job);
328
da01ff7f 329 job_start(&job->job);
a50c2ab8 330 assert(job->job.status == JOB_STATUS_RUNNING);
fb367e03
JS
331
332 s->should_converge = true;
333 block_job_enter(job);
a50c2ab8 334 assert(job->job.status == JOB_STATUS_READY);
fb367e03 335
3453d972 336 job_complete(&job->job, &error_abort);
fb367e03
JS
337 block_job_enter(job);
338 while (!s->completed) {
339 aio_poll(qemu_get_aio_context(), true);
340 }
a50c2ab8 341 assert(job->job.status == JOB_STATUS_PENDING);
fb367e03
JS
342
343 cancel_common(s);
344}
345
346static void test_cancel_concluded(void)
347{
348 BlockJob *job;
349 CancelJob *s;
350
351 s = create_common(&job);
352
da01ff7f 353 job_start(&job->job);
a50c2ab8 354 assert(job->job.status == JOB_STATUS_RUNNING);
fb367e03
JS
355
356 s->should_converge = true;
357 block_job_enter(job);
a50c2ab8 358 assert(job->job.status == JOB_STATUS_READY);
fb367e03 359
3453d972 360 job_complete(&job->job, &error_abort);
fb367e03
JS
361 block_job_enter(job);
362 while (!s->completed) {
363 aio_poll(qemu_get_aio_context(), true);
364 }
a50c2ab8 365 assert(job->job.status == JOB_STATUS_PENDING);
fb367e03
JS
366
367 block_job_finalize(job, &error_abort);
a50c2ab8 368 assert(job->job.status == JOB_STATUS_CONCLUDED);
fb367e03
JS
369
370 cancel_common(s);
371}
372
9ef8112a
AG
373int main(int argc, char **argv)
374{
375 qemu_init_main_loop(&error_abort);
d185cf0e 376 bdrv_init();
9ef8112a
AG
377
378 g_test_init(&argc, &argv, NULL);
379 g_test_add_func("/blockjob/ids", test_job_ids);
fb367e03
JS
380 g_test_add_func("/blockjob/cancel/created", test_cancel_created);
381 g_test_add_func("/blockjob/cancel/running", test_cancel_running);
382 g_test_add_func("/blockjob/cancel/paused", test_cancel_paused);
383 g_test_add_func("/blockjob/cancel/ready", test_cancel_ready);
384 g_test_add_func("/blockjob/cancel/standby", test_cancel_standby);
385 g_test_add_func("/blockjob/cancel/pending", test_cancel_pending);
386 g_test_add_func("/blockjob/cancel/concluded", test_cancel_concluded);
9ef8112a
AG
387 return g_test_run();
388}