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