tests/test-blockjob.c

   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"
  16 #include "block/blockjob_int.h"
  17 #include "sysemu/block-backend.h"
  18
  19 static const BlockJobDriver test_block_job_driver = {
  20     .job_driver = {
  21         .instance_size = sizeof(BlockJob),
  22         .free          = block_job_free,
  23         .user_resume   = block_job_user_resume,
  24         .drain         = block_job_drain,
  25     },
  26 };
  27
  28 static void block_job_cb(void *opaque, int ret)
  29 {
  30 }
  31
  32 static BlockJob *mk_job(BlockBackend *blk, const char *id,
  33                         const BlockJobDriver *drv, bool should_succeed,
  34                         int flags)
  35 {
  36     BlockJob *job;
  37     Error *errp = NULL;
  38
  39     job = block_job_create(id, drv, NULL, blk_bs(blk),
  40                            0, BLK_PERM_ALL, 0, flags, block_job_cb,
  41                            NULL, &errp);
  42     if (should_succeed) {
  43         g_assert_null(errp);
  44         g_assert_nonnull(job);
  45         if (id) {
  46             g_assert_cmpstr(job->job.id, ==, id);
  47         } else {
  48             g_assert_cmpstr(job->job.id, ==, blk_name(blk));
  49         }
  50     } else {
  51         g_assert_nonnull(errp);
  52         g_assert_null(job);
  53         error_free(errp);
  54     }
  55
  56     return job;
  57 }
  58
  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,
  63                   should_succeed, JOB_DEFAULT);
  64 }
  65
  66 /* This creates a BlockBackend (optionally with a name) with a
  67  * BlockDriverState inserted. */
  68 static BlockBackend *create_blk(const char *name)
  69 {
  70     /* No I/O is performed on this device */
  71     BlockBackend *blk = blk_new(0, BLK_PERM_ALL);
  72     BlockDriverState *bs;
  73
  74     bs = bdrv_open("null-co://", NULL, NULL, 0, &error_abort);
  75     g_assert_nonnull(bs);
  76
  77     blk_insert_bs(blk, bs, &error_abort);
  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 */
 132     job_early_fail(&job[0]->job);
 133     job[1] = do_test_id(blk[1], "id0", true);
 134
 135     /* No job ID specified, defaults to the backend name ('drive1') */
 136     job_early_fail(&job[1]->job);
 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
 149     job_early_fail(&job[0]->job);
 150     job_early_fail(&job[1]->job);
 151     job_early_fail(&job[2]->job);
 152
 153     destroy_blk(blk[0]);
 154     destroy_blk(blk[1]);
 155     destroy_blk(blk[2]);
 156 }
 157
 158 typedef struct CancelJob {
 159     BlockJob common;
 160     BlockBackend *blk;
 161     bool should_converge;
 162     bool should_complete;
 163     bool completed;
 164 } CancelJob;
 165
 166 static void cancel_job_exit(Job *job)
 167 {
 168     CancelJob *s = container_of(job, CancelJob, common.job);
 169     s->completed = true;
 170 }
 171
 172 static void cancel_job_complete(Job *job, Error **errp)
 173 {
 174     CancelJob *s = container_of(job, CancelJob, common.job);
 175     s->should_complete = true;
 176 }
 177
 178 static int coroutine_fn cancel_job_run(Job *job, Error **errp)
 179 {
 180     CancelJob *s = container_of(job, CancelJob, common.job);
 181
 182     while (!s->should_complete) {
 183         if (job_is_cancelled(&s->common.job)) {
 184             return 0;
 185         }
 186
 187         if (!job_is_ready(&s->common.job) && s->should_converge) {
 188             job_transition_to_ready(&s->common.job);
 189         }
 190
 191         job_sleep_ns(&s->common.job, 100000);
 192     }
 193
 194     return 0;
 195 }
 196
 197 static const BlockJobDriver test_cancel_driver = {
 198     .job_driver = {
 199         .instance_size = sizeof(CancelJob),
 200         .free          = block_job_free,
 201         .user_resume   = block_job_user_resume,
 202         .drain         = block_job_drain,
 203         .run           = cancel_job_run,
 204         .exit          = cancel_job_exit,
 205         .complete      = cancel_job_complete,
 206     },
 207 };
 208
 209 static CancelJob *create_common(BlockJob **pjob)
 210 {
 211     BlockBackend *blk;
 212     BlockJob *job;
 213     CancelJob *s;
 214
 215     blk = create_blk(NULL);
 216     job = mk_job(blk, "Steve", &test_cancel_driver, true,
 217                  JOB_MANUAL_FINALIZE | JOB_MANUAL_DISMISS);
 218     job_ref(&job->job);
 219     assert(job->job.status == JOB_STATUS_CREATED);
 220     s = container_of(job, CancelJob, common);
 221     s->blk = blk;
 222
 223     *pjob = job;
 224     return s;
 225 }
 226
 227 static void cancel_common(CancelJob *s)
 228 {
 229     BlockJob *job = &s->common;
 230     BlockBackend *blk = s->blk;
 231     JobStatus sts = job->job.status;
 232
 233     job_cancel_sync(&job->job);
 234     if (sts != JOB_STATUS_CREATED && sts != JOB_STATUS_CONCLUDED) {
 235         Job *dummy = &job->job;
 236         job_dismiss(&dummy, &error_abort);
 237     }
 238     assert(job->job.status == JOB_STATUS_NULL);
 239     job_unref(&job->job);
 240     destroy_blk(blk);
 241 }
 242
 243 static void test_cancel_created(void)
 244 {
 245     BlockJob *job;
 246     CancelJob *s;
 247
 248     s = create_common(&job);
 249     cancel_common(s);
 250 }
 251
 252 static void test_cancel_running(void)
 253 {
 254     BlockJob *job;
 255     CancelJob *s;
 256
 257     s = create_common(&job);
 258
 259     job_start(&job->job);
 260     assert(job->job.status == JOB_STATUS_RUNNING);
 261
 262     cancel_common(s);
 263 }
 264
 265 static void test_cancel_paused(void)
 266 {
 267     BlockJob *job;
 268     CancelJob *s;
 269
 270     s = create_common(&job);
 271
 272     job_start(&job->job);
 273     assert(job->job.status == JOB_STATUS_RUNNING);
 274
 275     job_user_pause(&job->job, &error_abort);
 276     job_enter(&job->job);
 277     assert(job->job.status == JOB_STATUS_PAUSED);
 278
 279     cancel_common(s);
 280 }
 281
 282 static void test_cancel_ready(void)
 283 {
 284     BlockJob *job;
 285     CancelJob *s;
 286
 287     s = create_common(&job);
 288
 289     job_start(&job->job);
 290     assert(job->job.status == JOB_STATUS_RUNNING);
 291
 292     s->should_converge = true;
 293     job_enter(&job->job);
 294     assert(job->job.status == JOB_STATUS_READY);
 295
 296     cancel_common(s);
 297 }
 298
 299 static void test_cancel_standby(void)
 300 {
 301     BlockJob *job;
 302     CancelJob *s;
 303
 304     s = create_common(&job);
 305
 306     job_start(&job->job);
 307     assert(job->job.status == JOB_STATUS_RUNNING);
 308
 309     s->should_converge = true;
 310     job_enter(&job->job);
 311     assert(job->job.status == JOB_STATUS_READY);
 312
 313     job_user_pause(&job->job, &error_abort);
 314     job_enter(&job->job);
 315     assert(job->job.status == JOB_STATUS_STANDBY);
 316
 317     cancel_common(s);
 318 }
 319
 320 static void test_cancel_pending(void)
 321 {
 322     BlockJob *job;
 323     CancelJob *s;
 324
 325     s = create_common(&job);
 326
 327     job_start(&job->job);
 328     assert(job->job.status == JOB_STATUS_RUNNING);
 329
 330     s->should_converge = true;
 331     job_enter(&job->job);
 332     assert(job->job.status == JOB_STATUS_READY);
 333
 334     job_complete(&job->job, &error_abort);
 335     job_enter(&job->job);
 336     while (!s->completed) {
 337         aio_poll(qemu_get_aio_context(), true);
 338     }
 339     assert(job->job.status == JOB_STATUS_PENDING);
 340
 341     cancel_common(s);
 342 }
 343
 344 static void test_cancel_concluded(void)
 345 {
 346     BlockJob *job;
 347     CancelJob *s;
 348
 349     s = create_common(&job);
 350
 351     job_start(&job->job);
 352     assert(job->job.status == JOB_STATUS_RUNNING);
 353
 354     s->should_converge = true;
 355     job_enter(&job->job);
 356     assert(job->job.status == JOB_STATUS_READY);
 357
 358     job_complete(&job->job, &error_abort);
 359     job_enter(&job->job);
 360     while (!s->completed) {
 361         aio_poll(qemu_get_aio_context(), true);
 362     }
 363     assert(job->job.status == JOB_STATUS_PENDING);
 364
 365     job_finalize(&job->job, &error_abort);
 366     assert(job->job.status == JOB_STATUS_CONCLUDED);
 367
 368     cancel_common(s);
 369 }
 370
 371 int main(int argc, char **argv)
 372 {
 373     qemu_init_main_loop(&error_abort);
 374     bdrv_init();
 375
 376     g_test_init(&argc, &argv, NULL);
 377     g_test_add_func("/blockjob/ids", test_job_ids);
 378     g_test_add_func("/blockjob/cancel/created", test_cancel_created);
 379     g_test_add_func("/blockjob/cancel/running", test_cancel_running);
 380     g_test_add_func("/blockjob/cancel/paused", test_cancel_paused);
 381     g_test_add_func("/blockjob/cancel/ready", test_cancel_ready);
 382     g_test_add_func("/blockjob/cancel/standby", test_cancel_standby);
 383     g_test_add_func("/blockjob/cancel/pending", test_cancel_pending);
 384     g_test_add_func("/blockjob/cancel/concluded", test_cancel_concluded);
 385     return g_test_run();
 386 }