]>
Commit | Line | Data |
---|---|---|
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 | ||
19 | static 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 | ||
28 | static void block_job_cb(void *opaque, int ret) | |
29 | { | |
30 | } | |
31 | ||
fb367e03 JS |
32 | static 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 |
59 | static 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. */ | |
68 | static 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 */ | |
90 | static 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 | ||
100 | static 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 |
158 | typedef struct CancelJob { |
159 | BlockJob common; | |
160 | BlockBackend *blk; | |
161 | bool should_converge; | |
162 | bool should_complete; | |
163 | bool completed; | |
164 | } CancelJob; | |
165 | ||
1908a559 | 166 | static void cancel_job_completed(Job *job, void *opaque) |
fb367e03 JS |
167 | { |
168 | CancelJob *s = opaque; | |
169 | s->completed = true; | |
1266c9b9 | 170 | job_completed(job, 0, NULL); |
fb367e03 JS |
171 | } |
172 | ||
3453d972 | 173 | static void cancel_job_complete(Job *job, Error **errp) |
fb367e03 | 174 | { |
3453d972 | 175 | CancelJob *s = container_of(job, CancelJob, common.job); |
fb367e03 JS |
176 | s->should_complete = true; |
177 | } | |
178 | ||
179 | static void coroutine_fn cancel_job_start(void *opaque) | |
180 | { | |
181 | CancelJob *s = opaque; | |
182 | ||
183 | while (!s->should_complete) { | |
daa7f2f9 | 184 | if (job_is_cancelled(&s->common.job)) { |
fb367e03 JS |
185 | goto defer; |
186 | } | |
187 | ||
df956ae2 | 188 | if (!job_is_ready(&s->common.job) && s->should_converge) { |
2e1795b5 | 189 | job_transition_to_ready(&s->common.job); |
fb367e03 JS |
190 | } |
191 | ||
5d43e86e | 192 | job_sleep_ns(&s->common.job, 100000); |
fb367e03 JS |
193 | } |
194 | ||
195 | defer: | |
1908a559 | 196 | job_defer_to_main_loop(&s->common.job, cancel_job_completed, s); |
fb367e03 JS |
197 | } |
198 | ||
199 | static const BlockJobDriver test_cancel_driver = { | |
33e9e9bd KW |
200 | .job_driver = { |
201 | .instance_size = sizeof(CancelJob), | |
80fa2c75 | 202 | .free = block_job_free, |
b15de828 | 203 | .user_resume = block_job_user_resume, |
b69f777d | 204 | .drain = block_job_drain, |
da01ff7f | 205 | .start = cancel_job_start, |
3453d972 | 206 | .complete = cancel_job_complete, |
33e9e9bd | 207 | }, |
fb367e03 JS |
208 | }; |
209 | ||
210 | static CancelJob *create_common(BlockJob **pjob) | |
211 | { | |
212 | BlockBackend *blk; | |
213 | BlockJob *job; | |
214 | CancelJob *s; | |
215 | ||
216 | blk = create_blk(NULL); | |
217 | job = mk_job(blk, "Steve", &test_cancel_driver, true, | |
bb02b65c | 218 | JOB_MANUAL_FINALIZE | JOB_MANUAL_DISMISS); |
80fa2c75 | 219 | job_ref(&job->job); |
a50c2ab8 | 220 | assert(job->job.status == JOB_STATUS_CREATED); |
fb367e03 JS |
221 | s = container_of(job, CancelJob, common); |
222 | s->blk = blk; | |
223 | ||
224 | *pjob = job; | |
225 | return s; | |
226 | } | |
227 | ||
228 | static void cancel_common(CancelJob *s) | |
229 | { | |
230 | BlockJob *job = &s->common; | |
231 | BlockBackend *blk = s->blk; | |
a50c2ab8 | 232 | JobStatus sts = job->job.status; |
fb367e03 | 233 | |
3d70ff53 | 234 | job_cancel_sync(&job->job); |
a50c2ab8 | 235 | if (sts != JOB_STATUS_CREATED && sts != JOB_STATUS_CONCLUDED) { |
5f9a6a08 KW |
236 | Job *dummy = &job->job; |
237 | job_dismiss(&dummy, &error_abort); | |
fb367e03 | 238 | } |
a50c2ab8 | 239 | assert(job->job.status == JOB_STATUS_NULL); |
80fa2c75 | 240 | job_unref(&job->job); |
fb367e03 JS |
241 | destroy_blk(blk); |
242 | } | |
243 | ||
244 | static void test_cancel_created(void) | |
245 | { | |
246 | BlockJob *job; | |
247 | CancelJob *s; | |
248 | ||
249 | s = create_common(&job); | |
250 | cancel_common(s); | |
251 | } | |
252 | ||
253 | static void test_cancel_running(void) | |
254 | { | |
255 | BlockJob *job; | |
256 | CancelJob *s; | |
257 | ||
258 | s = create_common(&job); | |
259 | ||
da01ff7f | 260 | job_start(&job->job); |
a50c2ab8 | 261 | assert(job->job.status == JOB_STATUS_RUNNING); |
fb367e03 JS |
262 | |
263 | cancel_common(s); | |
264 | } | |
265 | ||
266 | static void test_cancel_paused(void) | |
267 | { | |
268 | BlockJob *job; | |
269 | CancelJob *s; | |
270 | ||
271 | s = create_common(&job); | |
272 | ||
da01ff7f | 273 | job_start(&job->job); |
a50c2ab8 | 274 | assert(job->job.status == JOB_STATUS_RUNNING); |
fb367e03 | 275 | |
b15de828 | 276 | job_user_pause(&job->job, &error_abort); |
3d70ff53 | 277 | job_enter(&job->job); |
a50c2ab8 | 278 | assert(job->job.status == JOB_STATUS_PAUSED); |
fb367e03 JS |
279 | |
280 | cancel_common(s); | |
281 | } | |
282 | ||
283 | static void test_cancel_ready(void) | |
284 | { | |
285 | BlockJob *job; | |
286 | CancelJob *s; | |
287 | ||
288 | s = create_common(&job); | |
289 | ||
da01ff7f | 290 | job_start(&job->job); |
a50c2ab8 | 291 | assert(job->job.status == JOB_STATUS_RUNNING); |
fb367e03 JS |
292 | |
293 | s->should_converge = true; | |
3d70ff53 | 294 | job_enter(&job->job); |
a50c2ab8 | 295 | assert(job->job.status == JOB_STATUS_READY); |
fb367e03 JS |
296 | |
297 | cancel_common(s); | |
298 | } | |
299 | ||
300 | static void test_cancel_standby(void) | |
301 | { | |
302 | BlockJob *job; | |
303 | CancelJob *s; | |
304 | ||
305 | s = create_common(&job); | |
306 | ||
da01ff7f | 307 | job_start(&job->job); |
a50c2ab8 | 308 | assert(job->job.status == JOB_STATUS_RUNNING); |
fb367e03 JS |
309 | |
310 | s->should_converge = true; | |
3d70ff53 | 311 | job_enter(&job->job); |
a50c2ab8 | 312 | assert(job->job.status == JOB_STATUS_READY); |
fb367e03 | 313 | |
b15de828 | 314 | job_user_pause(&job->job, &error_abort); |
3d70ff53 | 315 | job_enter(&job->job); |
a50c2ab8 | 316 | assert(job->job.status == JOB_STATUS_STANDBY); |
fb367e03 JS |
317 | |
318 | cancel_common(s); | |
319 | } | |
320 | ||
321 | static void test_cancel_pending(void) | |
322 | { | |
323 | BlockJob *job; | |
324 | CancelJob *s; | |
325 | ||
326 | s = create_common(&job); | |
327 | ||
da01ff7f | 328 | job_start(&job->job); |
a50c2ab8 | 329 | assert(job->job.status == JOB_STATUS_RUNNING); |
fb367e03 JS |
330 | |
331 | s->should_converge = true; | |
3d70ff53 | 332 | job_enter(&job->job); |
a50c2ab8 | 333 | assert(job->job.status == JOB_STATUS_READY); |
fb367e03 | 334 | |
3453d972 | 335 | job_complete(&job->job, &error_abort); |
3d70ff53 | 336 | job_enter(&job->job); |
fb367e03 JS |
337 | while (!s->completed) { |
338 | aio_poll(qemu_get_aio_context(), true); | |
339 | } | |
a50c2ab8 | 340 | assert(job->job.status == JOB_STATUS_PENDING); |
fb367e03 JS |
341 | |
342 | cancel_common(s); | |
343 | } | |
344 | ||
345 | static void test_cancel_concluded(void) | |
346 | { | |
347 | BlockJob *job; | |
348 | CancelJob *s; | |
349 | ||
350 | s = create_common(&job); | |
351 | ||
da01ff7f | 352 | job_start(&job->job); |
a50c2ab8 | 353 | assert(job->job.status == JOB_STATUS_RUNNING); |
fb367e03 JS |
354 | |
355 | s->should_converge = true; | |
3d70ff53 | 356 | job_enter(&job->job); |
a50c2ab8 | 357 | assert(job->job.status == JOB_STATUS_READY); |
fb367e03 | 358 | |
3453d972 | 359 | job_complete(&job->job, &error_abort); |
3d70ff53 | 360 | job_enter(&job->job); |
fb367e03 JS |
361 | while (!s->completed) { |
362 | aio_poll(qemu_get_aio_context(), true); | |
363 | } | |
a50c2ab8 | 364 | assert(job->job.status == JOB_STATUS_PENDING); |
fb367e03 | 365 | |
7eaa8fb5 | 366 | job_finalize(&job->job, &error_abort); |
a50c2ab8 | 367 | assert(job->job.status == JOB_STATUS_CONCLUDED); |
fb367e03 JS |
368 | |
369 | cancel_common(s); | |
370 | } | |
371 | ||
9ef8112a AG |
372 | int main(int argc, char **argv) |
373 | { | |
374 | qemu_init_main_loop(&error_abort); | |
d185cf0e | 375 | bdrv_init(); |
9ef8112a AG |
376 | |
377 | g_test_init(&argc, &argv, NULL); | |
378 | g_test_add_func("/blockjob/ids", test_job_ids); | |
fb367e03 JS |
379 | g_test_add_func("/blockjob/cancel/created", test_cancel_created); |
380 | g_test_add_func("/blockjob/cancel/running", test_cancel_running); | |
381 | g_test_add_func("/blockjob/cancel/paused", test_cancel_paused); | |
382 | g_test_add_func("/blockjob/cancel/ready", test_cancel_ready); | |
383 | g_test_add_func("/blockjob/cancel/standby", test_cancel_standby); | |
384 | g_test_add_func("/blockjob/cancel/pending", test_cancel_pending); | |
385 | g_test_add_func("/blockjob/cancel/concluded", test_cancel_concluded); | |
9ef8112a AG |
386 | return g_test_run(); |
387 | } |