]> git.ipfire.org Git - thirdparty/qemu.git/blame - tests/test-blockjob.c
tests/plugin: add instruction execution breakdown
[thirdparty/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 17#include "sysemu/block-backend.h"
ca1ef1e6 18#include "qapi/qmp/qdict.h"
9ef8112a
AG
19
20static const BlockJobDriver test_block_job_driver = {
33e9e9bd
KW
21 .job_driver = {
22 .instance_size = sizeof(BlockJob),
80fa2c75 23 .free = block_job_free,
b15de828 24 .user_resume = block_job_user_resume,
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 */
d861ab3a 71 BlockBackend *blk = blk_new(qemu_get_aio_context(), 0, BLK_PERM_ALL);
d185cf0e
KW
72 BlockDriverState *bs;
73
ca1ef1e6
AS
74 QDict *opt = qdict_new();
75 qdict_put_str(opt, "file.read-zeroes", "on");
76 bs = bdrv_open("null-co://", NULL, opt, 0, &error_abort);
d185cf0e 77 g_assert_nonnull(bs);
9ef8112a 78
d7086422 79 blk_insert_bs(blk, bs, &error_abort);
9ef8112a
AG
80 bdrv_unref(bs);
81
82 if (name) {
83 Error *errp = NULL;
84 monitor_add_blk(blk, name, &errp);
85 g_assert_null(errp);
86 }
87
88 return blk;
89}
90
91/* This destroys the backend */
92static void destroy_blk(BlockBackend *blk)
93{
94 if (blk_name(blk)[0] != '\0') {
95 monitor_remove_blk(blk);
96 }
97
98 blk_remove_bs(blk);
99 blk_unref(blk);
100}
101
102static void test_job_ids(void)
103{
104 BlockBackend *blk[3];
105 BlockJob *job[3];
106
107 blk[0] = create_blk(NULL);
108 blk[1] = create_blk("drive1");
109 blk[2] = create_blk("drive2");
110
111 /* No job ID provided and the block backend has no name */
112 job[0] = do_test_id(blk[0], NULL, false);
113
114 /* These are all invalid job IDs */
115 job[0] = do_test_id(blk[0], "0id", false);
116 job[0] = do_test_id(blk[0], "", false);
117 job[0] = do_test_id(blk[0], " ", false);
118 job[0] = do_test_id(blk[0], "123", false);
119 job[0] = do_test_id(blk[0], "_id", false);
120 job[0] = do_test_id(blk[0], "-id", false);
121 job[0] = do_test_id(blk[0], ".id", false);
122 job[0] = do_test_id(blk[0], "#id", false);
123
124 /* This one is valid */
125 job[0] = do_test_id(blk[0], "id0", true);
126
b23c580c
VSO
127 /* We can have two jobs in the same BDS */
128 job[1] = do_test_id(blk[0], "id1", true);
129 job_early_fail(&job[1]->job);
9ef8112a
AG
130
131 /* Duplicate job IDs are not allowed */
132 job[1] = do_test_id(blk[1], "id0", false);
133
134 /* But once job[0] finishes we can reuse its ID */
4ad35181 135 job_early_fail(&job[0]->job);
9ef8112a
AG
136 job[1] = do_test_id(blk[1], "id0", true);
137
138 /* No job ID specified, defaults to the backend name ('drive1') */
4ad35181 139 job_early_fail(&job[1]->job);
9ef8112a
AG
140 job[1] = do_test_id(blk[1], NULL, true);
141
142 /* Duplicate job ID */
143 job[2] = do_test_id(blk[2], "drive1", false);
144
145 /* The ID of job[2] would default to 'drive2' but it is already in use */
146 job[0] = do_test_id(blk[0], "drive2", true);
147 job[2] = do_test_id(blk[2], NULL, false);
148
149 /* This one is valid */
150 job[2] = do_test_id(blk[2], "id_2", true);
151
4ad35181
KW
152 job_early_fail(&job[0]->job);
153 job_early_fail(&job[1]->job);
154 job_early_fail(&job[2]->job);
9ef8112a
AG
155
156 destroy_blk(blk[0]);
157 destroy_blk(blk[1]);
158 destroy_blk(blk[2]);
159}
160
fb367e03
JS
161typedef struct CancelJob {
162 BlockJob common;
163 BlockBackend *blk;
164 bool should_converge;
165 bool should_complete;
fb367e03
JS
166} CancelJob;
167
3453d972 168static void cancel_job_complete(Job *job, Error **errp)
fb367e03 169{
3453d972 170 CancelJob *s = container_of(job, CancelJob, common.job);
fb367e03
JS
171 s->should_complete = true;
172}
173
f67432a2 174static int coroutine_fn cancel_job_run(Job *job, Error **errp)
fb367e03 175{
f67432a2 176 CancelJob *s = container_of(job, CancelJob, common.job);
fb367e03
JS
177
178 while (!s->should_complete) {
daa7f2f9 179 if (job_is_cancelled(&s->common.job)) {
eb23654d 180 return 0;
fb367e03
JS
181 }
182
df956ae2 183 if (!job_is_ready(&s->common.job) && s->should_converge) {
2e1795b5 184 job_transition_to_ready(&s->common.job);
fb367e03
JS
185 }
186
5d43e86e 187 job_sleep_ns(&s->common.job, 100000);
fb367e03
JS
188 }
189
f67432a2 190 return 0;
fb367e03
JS
191}
192
193static const BlockJobDriver test_cancel_driver = {
33e9e9bd
KW
194 .job_driver = {
195 .instance_size = sizeof(CancelJob),
80fa2c75 196 .free = block_job_free,
b15de828 197 .user_resume = block_job_user_resume,
f67432a2 198 .run = cancel_job_run,
3453d972 199 .complete = cancel_job_complete,
33e9e9bd 200 },
fb367e03
JS
201};
202
0cc4643b 203static CancelJob *create_common(Job **pjob)
fb367e03
JS
204{
205 BlockBackend *blk;
0cc4643b
JS
206 Job *job;
207 BlockJob *bjob;
fb367e03
JS
208 CancelJob *s;
209
210 blk = create_blk(NULL);
0cc4643b
JS
211 bjob = mk_job(blk, "Steve", &test_cancel_driver, true,
212 JOB_MANUAL_FINALIZE | JOB_MANUAL_DISMISS);
213 job = &bjob->job;
214 job_ref(job);
215 assert(job->status == JOB_STATUS_CREATED);
216 s = container_of(bjob, CancelJob, common);
fb367e03
JS
217 s->blk = blk;
218
219 *pjob = job;
220 return s;
221}
222
223static void cancel_common(CancelJob *s)
224{
225 BlockJob *job = &s->common;
226 BlockBackend *blk = s->blk;
a50c2ab8 227 JobStatus sts = job->job.status;
30c070a5
KW
228 AioContext *ctx;
229
230 ctx = job->job.aio_context;
231 aio_context_acquire(ctx);
fb367e03 232
3d70ff53 233 job_cancel_sync(&job->job);
a50c2ab8 234 if (sts != JOB_STATUS_CREATED && sts != JOB_STATUS_CONCLUDED) {
5f9a6a08
KW
235 Job *dummy = &job->job;
236 job_dismiss(&dummy, &error_abort);
fb367e03 237 }
a50c2ab8 238 assert(job->job.status == JOB_STATUS_NULL);
80fa2c75 239 job_unref(&job->job);
fb367e03 240 destroy_blk(blk);
30c070a5
KW
241
242 aio_context_release(ctx);
fb367e03
JS
243}
244
245static void test_cancel_created(void)
246{
0cc4643b 247 Job *job;
fb367e03
JS
248 CancelJob *s;
249
250 s = create_common(&job);
251 cancel_common(s);
252}
253
254static void test_cancel_running(void)
255{
0cc4643b 256 Job *job;
fb367e03
JS
257 CancelJob *s;
258
259 s = create_common(&job);
260
0cc4643b
JS
261 job_start(job);
262 assert(job->status == JOB_STATUS_RUNNING);
fb367e03
JS
263
264 cancel_common(s);
265}
266
267static void test_cancel_paused(void)
268{
0cc4643b 269 Job *job;
fb367e03
JS
270 CancelJob *s;
271
272 s = create_common(&job);
273
0cc4643b
JS
274 job_start(job);
275 assert(job->status == JOB_STATUS_RUNNING);
fb367e03 276
0cc4643b
JS
277 job_user_pause(job, &error_abort);
278 job_enter(job);
279 assert(job->status == JOB_STATUS_PAUSED);
fb367e03
JS
280
281 cancel_common(s);
282}
283
284static void test_cancel_ready(void)
285{
0cc4643b 286 Job *job;
fb367e03
JS
287 CancelJob *s;
288
289 s = create_common(&job);
290
0cc4643b
JS
291 job_start(job);
292 assert(job->status == JOB_STATUS_RUNNING);
fb367e03
JS
293
294 s->should_converge = true;
0cc4643b
JS
295 job_enter(job);
296 assert(job->status == JOB_STATUS_READY);
fb367e03
JS
297
298 cancel_common(s);
299}
300
301static void test_cancel_standby(void)
302{
0cc4643b 303 Job *job;
fb367e03
JS
304 CancelJob *s;
305
306 s = create_common(&job);
307
0cc4643b
JS
308 job_start(job);
309 assert(job->status == JOB_STATUS_RUNNING);
fb367e03
JS
310
311 s->should_converge = true;
0cc4643b
JS
312 job_enter(job);
313 assert(job->status == JOB_STATUS_READY);
fb367e03 314
0cc4643b
JS
315 job_user_pause(job, &error_abort);
316 job_enter(job);
317 assert(job->status == JOB_STATUS_STANDBY);
fb367e03
JS
318
319 cancel_common(s);
320}
321
322static void test_cancel_pending(void)
323{
0cc4643b 324 Job *job;
fb367e03
JS
325 CancelJob *s;
326
327 s = create_common(&job);
328
0cc4643b
JS
329 job_start(job);
330 assert(job->status == JOB_STATUS_RUNNING);
fb367e03
JS
331
332 s->should_converge = true;
0cc4643b
JS
333 job_enter(job);
334 assert(job->status == JOB_STATUS_READY);
fb367e03 335
0cc4643b
JS
336 job_complete(job, &error_abort);
337 job_enter(job);
977d26fd 338 while (!job->deferred_to_main_loop) {
fb367e03
JS
339 aio_poll(qemu_get_aio_context(), true);
340 }
977d26fd
JS
341 assert(job->status == JOB_STATUS_READY);
342 aio_poll(qemu_get_aio_context(), true);
0cc4643b 343 assert(job->status == JOB_STATUS_PENDING);
fb367e03
JS
344
345 cancel_common(s);
346}
347
348static void test_cancel_concluded(void)
349{
0cc4643b 350 Job *job;
fb367e03
JS
351 CancelJob *s;
352
353 s = create_common(&job);
354
0cc4643b
JS
355 job_start(job);
356 assert(job->status == JOB_STATUS_RUNNING);
fb367e03
JS
357
358 s->should_converge = true;
0cc4643b
JS
359 job_enter(job);
360 assert(job->status == JOB_STATUS_READY);
fb367e03 361
0cc4643b
JS
362 job_complete(job, &error_abort);
363 job_enter(job);
977d26fd 364 while (!job->deferred_to_main_loop) {
fb367e03
JS
365 aio_poll(qemu_get_aio_context(), true);
366 }
977d26fd
JS
367 assert(job->status == JOB_STATUS_READY);
368 aio_poll(qemu_get_aio_context(), true);
0cc4643b 369 assert(job->status == JOB_STATUS_PENDING);
fb367e03 370
0cc4643b
JS
371 job_finalize(job, &error_abort);
372 assert(job->status == JOB_STATUS_CONCLUDED);
fb367e03
JS
373
374 cancel_common(s);
375}
376
9ef8112a
AG
377int main(int argc, char **argv)
378{
379 qemu_init_main_loop(&error_abort);
d185cf0e 380 bdrv_init();
9ef8112a
AG
381
382 g_test_init(&argc, &argv, NULL);
383 g_test_add_func("/blockjob/ids", test_job_ids);
fb367e03
JS
384 g_test_add_func("/blockjob/cancel/created", test_cancel_created);
385 g_test_add_func("/blockjob/cancel/running", test_cancel_running);
386 g_test_add_func("/blockjob/cancel/paused", test_cancel_paused);
387 g_test_add_func("/blockjob/cancel/ready", test_cancel_ready);
388 g_test_add_func("/blockjob/cancel/standby", test_cancel_standby);
389 g_test_add_func("/blockjob/cancel/pending", test_cancel_pending);
390 g_test_add_func("/blockjob/cancel/concluded", test_cancel_concluded);
9ef8112a
AG
391 return g_test_run();
392}