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     },
  25 };
  26
  27 static void block_job_cb(void *opaque, int ret)
  28 {
  29 }
  30
  31 static BlockJob *mk_job(BlockBackend *blk, const char *id,
  32                         const BlockJobDriver *drv, bool should_succeed,
  33                         int flags)
  34 {
  35     BlockJob *job;
  36     Error *errp = NULL;
  37
  38     job = block_job_create(id, drv, NULL, blk_bs(blk),
  39                            0, BLK_PERM_ALL, 0, flags, block_job_cb,
  40                            NULL, &errp);
  41     if (should_succeed) {
  42         g_assert_null(errp);
  43         g_assert_nonnull(job);
  44         if (id) {
  45             g_assert_cmpstr(job->job.id, ==, id);
  46         } else {
  47             g_assert_cmpstr(job->job.id, ==, blk_name(blk));
  48         }
  49     } else {
  50         g_assert_nonnull(errp);
  51         g_assert_null(job);
  52         error_free(errp);
  53     }
  54
  55     return job;
  56 }
  57
  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,
  62                   should_succeed, JOB_DEFAULT);
  63 }
  64
  65 /* This creates a BlockBackend (optionally with a name) with a
  66  * BlockDriverState inserted. */
  67 static BlockBackend *create_blk(const char *name)
  68 {
  69     /* No I/O is performed on this device */
  70     BlockBackend *blk = blk_new(0, BLK_PERM_ALL);
  71     BlockDriverState *bs;
  72
  73     bs = bdrv_open("null-co://", NULL, NULL, 0, &error_abort);
  74     g_assert_nonnull(bs);
  75
  76     blk_insert_bs(blk, bs, &error_abort);
  77     bdrv_unref(bs);
  78
  79     if (name) {
  80         Error *errp = NULL;
  81         monitor_add_blk(blk, name, &errp);
  82         g_assert_null(errp);
  83     }
  84
  85     return blk;
  86 }
  87
  88 /* This destroys the backend */
  89 static void destroy_blk(BlockBackend *blk)
  90 {
  91     if (blk_name(blk)[0] != '\0') {
  92         monitor_remove_blk(blk);
  93     }
  94
  95     blk_remove_bs(blk);
  96     blk_unref(blk);
  97 }
  98
  99 static void test_job_ids(void)
 100 {
 101     BlockBackend *blk[3];
 102     BlockJob *job[3];
 103
 104     blk[0] = create_blk(NULL);
 105     blk[1] = create_blk("drive1");
 106     blk[2] = create_blk("drive2");
 107
 108     /* No job ID provided and the block backend has no name */
 109     job[0] = do_test_id(blk[0], NULL, false);
 110
 111     /* These are all invalid job IDs */
 112     job[0] = do_test_id(blk[0], "0id", false);
 113     job[0] = do_test_id(blk[0], "",    false);
 114     job[0] = do_test_id(blk[0], "   ", false);
 115     job[0] = do_test_id(blk[0], "123", false);
 116     job[0] = do_test_id(blk[0], "_id", 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
 121     /* This one is valid */
 122     job[0] = do_test_id(blk[0], "id0", true);
 123
 124     /* We cannot have two jobs in the same BDS */
 125     do_test_id(blk[0], "id1", false);
 126
 127     /* Duplicate job IDs are not allowed */
 128     job[1] = do_test_id(blk[1], "id0", false);
 129
 130     /* But once job[0] finishes we can reuse its ID */
 131     job_early_fail(&job[0]->job);
 132     job[1] = do_test_id(blk[1], "id0", true);
 133
 134     /* No job ID specified, defaults to the backend name ('drive1') */
 135     job_early_fail(&job[1]->job);
 136     job[1] = do_test_id(blk[1], NULL, true);
 137
 138     /* Duplicate job ID */
 139     job[2] = do_test_id(blk[2], "drive1", false);
 140
 141     /* The ID of job[2] would default to 'drive2' but it is already in use */
 142     job[0] = do_test_id(blk[0], "drive2", true);
 143     job[2] = do_test_id(blk[2], NULL, false);
 144
 145     /* This one is valid */
 146     job[2] = do_test_id(blk[2], "id_2", true);
 147
 148     job_early_fail(&job[0]->job);
 149     job_early_fail(&job[1]->job);
 150     job_early_fail(&job[2]->job);
 151
 152     destroy_blk(blk[0]);
 153     destroy_blk(blk[1]);
 154     destroy_blk(blk[2]);
 155 }
 156
 157 typedef struct CancelJob {
 158     BlockJob common;
 159     BlockBackend *blk;
 160     bool should_converge;
 161     bool should_complete;
 162     bool completed;
 163 } CancelJob;
 164
 165 static void cancel_job_completed(Job *job, void *opaque)
 166 {
 167     BlockJob *bjob = container_of(job, BlockJob, job);
 168     CancelJob *s = opaque;
 169     s->completed = true;
 170     block_job_completed(bjob, 0);
 171 }
 172
 173 static void cancel_job_complete(BlockJob *job, Error **errp)
 174 {
 175     CancelJob *s = container_of(job, CancelJob, common);
 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) {
 184         if (job_is_cancelled(&s->common.job)) {
 185             goto defer;
 186         }
 187
 188         if (!s->common.ready && s->should_converge) {
 189             block_job_event_ready(&s->common);
 190         }
 191
 192         job_sleep_ns(&s->common.job, 100000);
 193     }
 194
 195  defer:
 196     job_defer_to_main_loop(&s->common.job, cancel_job_completed, s);
 197 }
 198
 199 static const BlockJobDriver test_cancel_driver = {
 200     .job_driver = {
 201         .instance_size = sizeof(CancelJob),
 202         .free          = block_job_free,
 203         .user_resume   = block_job_user_resume,
 204         .start         = cancel_job_start,
 205     },
 206     .complete      = cancel_job_complete,
 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     block_job_cancel_sync(job);
 234     if (sts != JOB_STATUS_CREATED && sts != JOB_STATUS_CONCLUDED) {
 235         BlockJob *dummy = job;
 236         block_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     block_job_enter(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     block_job_enter(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     block_job_enter(job);
 311     assert(job->job.status == JOB_STATUS_READY);
 312
 313     job_user_pause(&job->job, &error_abort);
 314     block_job_enter(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     block_job_enter(job);
 332     assert(job->job.status == JOB_STATUS_READY);
 333
 334     block_job_complete(job, &error_abort);
 335     block_job_enter(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     block_job_enter(job);
 356     assert(job->job.status == JOB_STATUS_READY);
 357
 358     block_job_complete(job, &error_abort);
 359     block_job_enter(job);
 360     while (!s->completed) {
 361         aio_poll(qemu_get_aio_context(), true);
 362     }
 363     assert(job->job.status == JOB_STATUS_PENDING);
 364
 365     block_job_finalize(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 }