tests/test-blockjob.c

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