tests/test-blockjob-txn.c

   1 /*
   2  * Blockjob transactions tests
   3  *
   4  * Copyright Red Hat, Inc. 2015
   5  *
   6  * Authors:
   7  *  Stefan Hajnoczi    <stefanha@redhat.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 typedef struct {
  20     BlockJob common;
  21     unsigned int iterations;
  22     bool use_timer;
  23     int rc;
  24     int *result;
  25 } TestBlockJob;
  26
  27 static void test_block_job_complete(Job *job, void *opaque)
  28 {
  29     BlockJob *bjob = container_of(job, BlockJob, job);
  30     BlockDriverState *bs = blk_bs(bjob->blk);
  31     int rc = (intptr_t)opaque;
  32
  33     if (job_is_cancelled(job)) {
  34         rc = -ECANCELED;
  35     }
  36
  37     job_completed(job, rc, NULL);
  38     bdrv_unref(bs);
  39 }
  40
  41 static void coroutine_fn test_block_job_run(void *opaque)
  42 {
  43     TestBlockJob *s = opaque;
  44     BlockJob *job = &s->common;
  45
  46     while (s->iterations--) {
  47         if (s->use_timer) {
  48             job_sleep_ns(&job->job, 0);
  49         } else {
  50             job_yield(&job->job);
  51         }
  52
  53         if (job_is_cancelled(&job->job)) {
  54             break;
  55         }
  56     }
  57
  58     job_defer_to_main_loop(&job->job, test_block_job_complete,
  59                            (void *)(intptr_t)s->rc);
  60 }
  61
  62 typedef struct {
  63     TestBlockJob *job;
  64     int *result;
  65 } TestBlockJobCBData;
  66
  67 static void test_block_job_cb(void *opaque, int ret)
  68 {
  69     TestBlockJobCBData *data = opaque;
  70     if (!ret && job_is_cancelled(&data->job->common.job)) {
  71         ret = -ECANCELED;
  72     }
  73     *data->result = ret;
  74     g_free(data);
  75 }
  76
  77 static const BlockJobDriver test_block_job_driver = {
  78     .job_driver = {
  79         .instance_size = sizeof(TestBlockJob),
  80         .free          = block_job_free,
  81         .user_resume   = block_job_user_resume,
  82         .drain         = block_job_drain,
  83         .start         = test_block_job_run,
  84     },
  85 };
  86
  87 /* Create a block job that completes with a given return code after a given
  88  * number of event loop iterations.  The return code is stored in the given
  89  * result pointer.
  90  *
  91  * The event loop iterations can either be handled automatically with a 0 delay
  92  * timer, or they can be stepped manually by entering the coroutine.
  93  */
  94 static BlockJob *test_block_job_start(unsigned int iterations,
  95                                       bool use_timer,
  96                                       int rc, int *result, JobTxn *txn)
  97 {
  98     BlockDriverState *bs;
  99     TestBlockJob *s;
 100     TestBlockJobCBData *data;
 101     static unsigned counter;
 102     char job_id[24];
 103
 104     data = g_new0(TestBlockJobCBData, 1);
 105
 106     bs = bdrv_open("null-co://", NULL, NULL, 0, &error_abort);
 107     g_assert_nonnull(bs);
 108
 109     snprintf(job_id, sizeof(job_id), "job%u", counter++);
 110     s = block_job_create(job_id, &test_block_job_driver, txn, bs,
 111                          0, BLK_PERM_ALL, 0, JOB_DEFAULT,
 112                          test_block_job_cb, data, &error_abort);
 113     s->iterations = iterations;
 114     s->use_timer = use_timer;
 115     s->rc = rc;
 116     s->result = result;
 117     data->job = s;
 118     data->result = result;
 119     return &s->common;
 120 }
 121
 122 static void test_single_job(int expected)
 123 {
 124     BlockJob *job;
 125     JobTxn *txn;
 126     int result = -EINPROGRESS;
 127
 128     txn = job_txn_new();
 129     job = test_block_job_start(1, true, expected, &result, txn);
 130     job_start(&job->job);
 131
 132     if (expected == -ECANCELED) {
 133         job_cancel(&job->job, false);
 134     }
 135
 136     while (result == -EINPROGRESS) {
 137         aio_poll(qemu_get_aio_context(), true);
 138     }
 139     g_assert_cmpint(result, ==, expected);
 140
 141     job_txn_unref(txn);
 142 }
 143
 144 static void test_single_job_success(void)
 145 {
 146     test_single_job(0);
 147 }
 148
 149 static void test_single_job_failure(void)
 150 {
 151     test_single_job(-EIO);
 152 }
 153
 154 static void test_single_job_cancel(void)
 155 {
 156     test_single_job(-ECANCELED);
 157 }
 158
 159 static void test_pair_jobs(int expected1, int expected2)
 160 {
 161     BlockJob *job1;
 162     BlockJob *job2;
 163     JobTxn *txn;
 164     int result1 = -EINPROGRESS;
 165     int result2 = -EINPROGRESS;
 166
 167     txn = job_txn_new();
 168     job1 = test_block_job_start(1, true, expected1, &result1, txn);
 169     job2 = test_block_job_start(2, true, expected2, &result2, txn);
 170     job_start(&job1->job);
 171     job_start(&job2->job);
 172
 173     /* Release our reference now to trigger as many nice
 174      * use-after-free bugs as possible.
 175      */
 176     job_txn_unref(txn);
 177
 178     if (expected1 == -ECANCELED) {
 179         job_cancel(&job1->job, false);
 180     }
 181     if (expected2 == -ECANCELED) {
 182         job_cancel(&job2->job, false);
 183     }
 184
 185     while (result1 == -EINPROGRESS || result2 == -EINPROGRESS) {
 186         aio_poll(qemu_get_aio_context(), true);
 187     }
 188
 189     /* Failure or cancellation of one job cancels the other job */
 190     if (expected1 != 0) {
 191         expected2 = -ECANCELED;
 192     } else if (expected2 != 0) {
 193         expected1 = -ECANCELED;
 194     }
 195
 196     g_assert_cmpint(result1, ==, expected1);
 197     g_assert_cmpint(result2, ==, expected2);
 198 }
 199
 200 static void test_pair_jobs_success(void)
 201 {
 202     test_pair_jobs(0, 0);
 203 }
 204
 205 static void test_pair_jobs_failure(void)
 206 {
 207     /* Test both orderings.  The two jobs run for a different number of
 208      * iterations so the code path is different depending on which job fails
 209      * first.
 210      */
 211     test_pair_jobs(-EIO, 0);
 212     test_pair_jobs(0, -EIO);
 213 }
 214
 215 static void test_pair_jobs_cancel(void)
 216 {
 217     test_pair_jobs(-ECANCELED, 0);
 218     test_pair_jobs(0, -ECANCELED);
 219 }
 220
 221 static void test_pair_jobs_fail_cancel_race(void)
 222 {
 223     BlockJob *job1;
 224     BlockJob *job2;
 225     JobTxn *txn;
 226     int result1 = -EINPROGRESS;
 227     int result2 = -EINPROGRESS;
 228
 229     txn = job_txn_new();
 230     job1 = test_block_job_start(1, true, -ECANCELED, &result1, txn);
 231     job2 = test_block_job_start(2, false, 0, &result2, txn);
 232     job_start(&job1->job);
 233     job_start(&job2->job);
 234
 235     job_cancel(&job1->job, false);
 236
 237     /* Now make job2 finish before the main loop kicks jobs.  This simulates
 238      * the race between a pending kick and another job completing.
 239      */
 240     job_enter(&job2->job);
 241     job_enter(&job2->job);
 242
 243     while (result1 == -EINPROGRESS || result2 == -EINPROGRESS) {
 244         aio_poll(qemu_get_aio_context(), true);
 245     }
 246
 247     g_assert_cmpint(result1, ==, -ECANCELED);
 248     g_assert_cmpint(result2, ==, -ECANCELED);
 249
 250     job_txn_unref(txn);
 251 }
 252
 253 int main(int argc, char **argv)
 254 {
 255     qemu_init_main_loop(&error_abort);
 256     bdrv_init();
 257
 258     g_test_init(&argc, &argv, NULL);
 259     g_test_add_func("/single/success", test_single_job_success);
 260     g_test_add_func("/single/failure", test_single_job_failure);
 261     g_test_add_func("/single/cancel", test_single_job_cancel);
 262     g_test_add_func("/pair/success", test_pair_jobs_success);
 263     g_test_add_func("/pair/failure", test_pair_jobs_failure);
 264     g_test_add_func("/pair/cancel", test_pair_jobs_cancel);
 265     g_test_add_func("/pair/fail-cancel-race", test_pair_jobs_fail_cancel_race);
 266     return g_test_run();
 267 }