tests/virtio-9p-test.c

   1 /*
   2  * QTest testcase for VirtIO 9P
   3  *
   4  * Copyright (c) 2014 SUSE LINUX Products GmbH
   5  *
   6  * This work is licensed under the terms of the GNU GPL, version 2 or later.
   7  * See the COPYING file in the top-level directory.
   8  */
   9
  10 #include "qemu/osdep.h"
  11 #include "libqtest.h"
  12 #include "qemu-common.h"
  13 #include "libqos/libqos-pc.h"
  14 #include "libqos/libqos-spapr.h"
  15 #include "libqos/virtio.h"
  16 #include "libqos/virtio-pci.h"
  17 #include "standard-headers/linux/virtio_ids.h"
  18 #include "standard-headers/linux/virtio_pci.h"
  19 #include "hw/9pfs/9p.h"
  20 #include "hw/9pfs/9p-synth.h"
  21
  22 #define QVIRTIO_9P_TIMEOUT_US (10 * 1000 * 1000)
  23
  24 static const char mount_tag[] = "qtest";
  25
  26 typedef struct {
  27     QVirtioDevice *dev;
  28     QOSState *qs;
  29     QVirtQueue *vq;
  30 } QVirtIO9P;
  31
  32 static QVirtIO9P *qvirtio_9p_start(const char *driver)
  33 {
  34     const char *arch = qtest_get_arch();
  35     const char *cmd = "-fsdev synth,id=fsdev0 "
  36                       "-device %s,fsdev=fsdev0,mount_tag=%s";
  37     QVirtIO9P *v9p = g_new0(QVirtIO9P, 1);
  38
  39     if (strcmp(arch, "i386") == 0 || strcmp(arch, "x86_64") == 0) {
  40         v9p->qs = qtest_pc_boot(cmd, driver, mount_tag);
  41     } else if (strcmp(arch, "ppc64") == 0) {
  42         v9p->qs = qtest_spapr_boot(cmd, driver, mount_tag);
  43     } else {
  44         g_printerr("virtio-9p tests are only available on x86 or ppc64\n");
  45         exit(EXIT_FAILURE);
  46     }
  47
  48     return v9p;
  49 }
  50
  51 static void qvirtio_9p_stop(QVirtIO9P *v9p)
  52 {
  53     qtest_shutdown(v9p->qs);
  54     g_free(v9p);
  55 }
  56
  57 static QVirtIO9P *qvirtio_9p_pci_start(void)
  58 {
  59     QVirtIO9P *v9p = qvirtio_9p_start("virtio-9p-pci");
  60     QVirtioPCIDevice *dev = qvirtio_pci_device_find(v9p->qs->pcibus,
  61                                                     VIRTIO_ID_9P);
  62     g_assert_nonnull(dev);
  63     g_assert_cmphex(dev->vdev.device_type, ==, VIRTIO_ID_9P);
  64     v9p->dev = (QVirtioDevice *) dev;
  65
  66     qvirtio_pci_device_enable(dev);
  67     qvirtio_reset(v9p->dev);
  68     qvirtio_set_acknowledge(v9p->dev);
  69     qvirtio_set_driver(v9p->dev);
  70
  71     v9p->vq = qvirtqueue_setup(v9p->dev, v9p->qs->alloc, 0);
  72
  73     qvirtio_set_driver_ok(v9p->dev);
  74
  75     return v9p;
  76 }
  77
  78 static void qvirtio_9p_pci_stop(QVirtIO9P *v9p)
  79 {
  80     qvirtqueue_cleanup(v9p->dev->bus, v9p->vq, v9p->qs->alloc);
  81     qvirtio_pci_device_disable(container_of(v9p->dev, QVirtioPCIDevice, vdev));
  82     qvirtio_pci_device_free((QVirtioPCIDevice *)v9p->dev);
  83     qvirtio_9p_stop(v9p);
  84 }
  85
  86 static void pci_config(QVirtIO9P *v9p)
  87 {
  88     size_t tag_len = qvirtio_config_readw(v9p->dev, 0);
  89     char *tag;
  90     int i;
  91
  92     g_assert_cmpint(tag_len, ==, strlen(mount_tag));
  93
  94     tag = g_malloc(tag_len);
  95     for (i = 0; i < tag_len; i++) {
  96         tag[i] = qvirtio_config_readb(v9p->dev, i + 2);
  97     }
  98     g_assert_cmpmem(tag, tag_len, mount_tag, tag_len);
  99     g_free(tag);
 100 }
 101
 102 #define P9_MAX_SIZE 4096 /* Max size of a T-message or R-message */
 103
 104 typedef struct {
 105     QVirtIO9P *v9p;
 106     uint16_t tag;
 107     uint64_t t_msg;
 108     uint32_t t_size;
 109     uint64_t r_msg;
 110     /* No r_size, it is hardcoded to P9_MAX_SIZE */
 111     size_t t_off;
 112     size_t r_off;
 113     uint32_t free_head;
 114 } P9Req;
 115
 116 static void v9fs_memwrite(P9Req *req, const void *addr, size_t len)
 117 {
 118     memwrite(req->t_msg + req->t_off, addr, len);
 119     req->t_off += len;
 120 }
 121
 122 static void v9fs_memskip(P9Req *req, size_t len)
 123 {
 124     req->r_off += len;
 125 }
 126
 127 static void v9fs_memread(P9Req *req, void *addr, size_t len)
 128 {
 129     memread(req->r_msg + req->r_off, addr, len);
 130     req->r_off += len;
 131 }
 132
 133 static void v9fs_uint16_write(P9Req *req, uint16_t val)
 134 {
 135     uint16_t le_val = cpu_to_le16(val);
 136
 137     v9fs_memwrite(req, &le_val, 2);
 138 }
 139
 140 static void v9fs_uint16_read(P9Req *req, uint16_t *val)
 141 {
 142     v9fs_memread(req, val, 2);
 143     le16_to_cpus(val);
 144 }
 145
 146 static void v9fs_uint32_write(P9Req *req, uint32_t val)
 147 {
 148     uint32_t le_val = cpu_to_le32(val);
 149
 150     v9fs_memwrite(req, &le_val, 4);
 151 }
 152
 153 static void v9fs_uint64_write(P9Req *req, uint64_t val)
 154 {
 155     uint64_t le_val = cpu_to_le64(val);
 156
 157     v9fs_memwrite(req, &le_val, 8);
 158 }
 159
 160 static void v9fs_uint32_read(P9Req *req, uint32_t *val)
 161 {
 162     v9fs_memread(req, val, 4);
 163     le32_to_cpus(val);
 164 }
 165
 166 /* len[2] string[len] */
 167 static uint16_t v9fs_string_size(const char *string)
 168 {
 169     size_t len = strlen(string);
 170
 171     g_assert_cmpint(len, <=, UINT16_MAX);
 172
 173     return 2 + len;
 174 }
 175
 176 static void v9fs_string_write(P9Req *req, const char *string)
 177 {
 178     int len = strlen(string);
 179
 180     g_assert_cmpint(len, <=, UINT16_MAX);
 181
 182     v9fs_uint16_write(req, (uint16_t) len);
 183     v9fs_memwrite(req, string, len);
 184 }
 185
 186 static void v9fs_string_read(P9Req *req, uint16_t *len, char **string)
 187 {
 188     uint16_t local_len;
 189
 190     v9fs_uint16_read(req, &local_len);
 191     if (len) {
 192         *len = local_len;
 193     }
 194     if (string) {
 195         *string = g_malloc(local_len);
 196         v9fs_memread(req, *string, local_len);
 197     } else {
 198         v9fs_memskip(req, local_len);
 199     }
 200 }
 201
 202  typedef struct {
 203     uint32_t size;
 204     uint8_t id;
 205     uint16_t tag;
 206 } QEMU_PACKED P9Hdr;
 207
 208 static P9Req *v9fs_req_init(QVirtIO9P *v9p, uint32_t size, uint8_t id,
 209                             uint16_t tag)
 210 {
 211     P9Req *req = g_new0(P9Req, 1);
 212     uint32_t t_size = 7 + size; /* 9P header has well-known size of 7 bytes */
 213     P9Hdr hdr = {
 214         .size = cpu_to_le32(t_size),
 215         .id = id,
 216         .tag = cpu_to_le16(tag)
 217     };
 218
 219     g_assert_cmpint(t_size, <=, P9_MAX_SIZE);
 220
 221     req->v9p = v9p;
 222     req->t_size = t_size;
 223     req->t_msg = guest_alloc(v9p->qs->alloc, req->t_size);
 224     v9fs_memwrite(req, &hdr, 7);
 225     req->tag = tag;
 226     return req;
 227 }
 228
 229 static void v9fs_req_send(P9Req *req)
 230 {
 231     QVirtIO9P *v9p = req->v9p;
 232
 233     req->r_msg = guest_alloc(v9p->qs->alloc, P9_MAX_SIZE);
 234     req->free_head = qvirtqueue_add(v9p->vq, req->t_msg, req->t_size, false,
 235                                     true);
 236     qvirtqueue_add(v9p->vq, req->r_msg, P9_MAX_SIZE, true, false);
 237     qvirtqueue_kick(v9p->dev, v9p->vq, req->free_head);
 238     req->t_off = 0;
 239 }
 240
 241 static const char *rmessage_name(uint8_t id)
 242 {
 243     return
 244         id == P9_RLERROR ? "RLERROR" :
 245         id == P9_RVERSION ? "RVERSION" :
 246         id == P9_RATTACH ? "RATTACH" :
 247         id == P9_RWALK ? "RWALK" :
 248         id == P9_RLOPEN ? "RLOPEN" :
 249         id == P9_RWRITE ? "RWRITE" :
 250         "<unknown>";
 251 }
 252
 253 static void v9fs_req_wait_for_reply(P9Req *req)
 254 {
 255     QVirtIO9P *v9p = req->v9p;
 256
 257     qvirtio_wait_used_elem(v9p->dev, v9p->vq, req->free_head,
 258                            QVIRTIO_9P_TIMEOUT_US);
 259 }
 260
 261 static void v9fs_req_recv(P9Req *req, uint8_t id)
 262 {
 263     P9Hdr hdr;
 264
 265     v9fs_memread(req, &hdr, 7);
 266     hdr.size = ldl_le_p(&hdr.size);
 267     hdr.tag = lduw_le_p(&hdr.tag);
 268
 269     g_assert_cmpint(hdr.size, >=, 7);
 270     g_assert_cmpint(hdr.size, <=, P9_MAX_SIZE);
 271     g_assert_cmpint(hdr.tag, ==, req->tag);
 272
 273     if (hdr.id != id) {
 274         g_printerr("Received response %d (%s) instead of %d (%s)\n",
 275                    hdr.id, rmessage_name(hdr.id), id, rmessage_name(id));
 276
 277         if (hdr.id == P9_RLERROR) {
 278             uint32_t err;
 279             v9fs_uint32_read(req, &err);
 280             g_printerr("Rlerror has errno %d (%s)\n", err, strerror(err));
 281         }
 282     }
 283     g_assert_cmpint(hdr.id, ==, id);
 284 }
 285
 286 static void v9fs_req_free(P9Req *req)
 287 {
 288     QVirtIO9P *v9p = req->v9p;
 289
 290     guest_free(v9p->qs->alloc, req->t_msg);
 291     guest_free(v9p->qs->alloc, req->r_msg);
 292     g_free(req);
 293 }
 294
 295 /* size[4] Rlerror tag[2] ecode[4] */
 296 static void v9fs_rlerror(P9Req *req, uint32_t *err)
 297 {
 298     v9fs_req_recv(req, P9_RLERROR);
 299     v9fs_uint32_read(req, err);
 300     v9fs_req_free(req);
 301 }
 302
 303 /* size[4] Tversion tag[2] msize[4] version[s] */
 304 static P9Req *v9fs_tversion(QVirtIO9P *v9p, uint32_t msize, const char *version,
 305                             uint16_t tag)
 306 {
 307     P9Req *req = v9fs_req_init(v9p, 4 + v9fs_string_size(version), P9_TVERSION,
 308                                tag);
 309
 310     v9fs_uint32_write(req, msize);
 311     v9fs_string_write(req, version);
 312     v9fs_req_send(req);
 313     return req;
 314 }
 315
 316 /* size[4] Rversion tag[2] msize[4] version[s] */
 317 static void v9fs_rversion(P9Req *req, uint16_t *len, char **version)
 318 {
 319     uint32_t msize;
 320
 321     v9fs_req_recv(req, P9_RVERSION);
 322     v9fs_uint32_read(req, &msize);
 323
 324     g_assert_cmpint(msize, ==, P9_MAX_SIZE);
 325
 326     if (len || version) {
 327         v9fs_string_read(req, len, version);
 328     }
 329
 330     v9fs_req_free(req);
 331 }
 332
 333 /* size[4] Tattach tag[2] fid[4] afid[4] uname[s] aname[s] n_uname[4] */
 334 static P9Req *v9fs_tattach(QVirtIO9P *v9p, uint32_t fid, uint32_t n_uname,
 335                            uint16_t tag)
 336 {
 337     const char *uname = ""; /* ignored by QEMU */
 338     const char *aname = ""; /* ignored by QEMU */
 339     P9Req *req = v9fs_req_init(v9p, 4 + 4 + 2 + 2 + 4, P9_TATTACH, tag);
 340
 341     v9fs_uint32_write(req, fid);
 342     v9fs_uint32_write(req, P9_NOFID);
 343     v9fs_string_write(req, uname);
 344     v9fs_string_write(req, aname);
 345     v9fs_uint32_write(req, n_uname);
 346     v9fs_req_send(req);
 347     return req;
 348 }
 349
 350 typedef char v9fs_qid[13];
 351
 352 /* size[4] Rattach tag[2] qid[13] */
 353 static void v9fs_rattach(P9Req *req, v9fs_qid *qid)
 354 {
 355     v9fs_req_recv(req, P9_RATTACH);
 356     if (qid) {
 357         v9fs_memread(req, qid, 13);
 358     }
 359     v9fs_req_free(req);
 360 }
 361
 362 /* size[4] Twalk tag[2] fid[4] newfid[4] nwname[2] nwname*(wname[s]) */
 363 static P9Req *v9fs_twalk(QVirtIO9P *v9p, uint32_t fid, uint32_t newfid,
 364                          uint16_t nwname, char *const wnames[], uint16_t tag)
 365 {
 366     P9Req *req;
 367     int i;
 368     uint32_t size = 4 + 4 + 2;
 369
 370     for (i = 0; i < nwname; i++) {
 371         size += v9fs_string_size(wnames[i]);
 372     }
 373     req = v9fs_req_init(v9p,  size, P9_TWALK, tag);
 374     v9fs_uint32_write(req, fid);
 375     v9fs_uint32_write(req, newfid);
 376     v9fs_uint16_write(req, nwname);
 377     for (i = 0; i < nwname; i++) {
 378         v9fs_string_write(req, wnames[i]);
 379     }
 380     v9fs_req_send(req);
 381     return req;
 382 }
 383
 384 /* size[4] Rwalk tag[2] nwqid[2] nwqid*(wqid[13]) */
 385 static void v9fs_rwalk(P9Req *req, uint16_t *nwqid, v9fs_qid **wqid)
 386 {
 387     uint16_t local_nwqid;
 388
 389     v9fs_req_recv(req, P9_RWALK);
 390     v9fs_uint16_read(req, &local_nwqid);
 391     if (nwqid) {
 392         *nwqid = local_nwqid;
 393     }
 394     if (wqid) {
 395         *wqid = g_malloc(local_nwqid * 13);
 396         v9fs_memread(req, *wqid, local_nwqid * 13);
 397     }
 398     v9fs_req_free(req);
 399 }
 400
 401 /* size[4] Tlopen tag[2] fid[4] flags[4] */
 402 static P9Req *v9fs_tlopen(QVirtIO9P *v9p, uint32_t fid, uint32_t flags,
 403                           uint16_t tag)
 404 {
 405     P9Req *req;
 406
 407     req = v9fs_req_init(v9p,  4 + 4, P9_TLOPEN, tag);
 408     v9fs_uint32_write(req, fid);
 409     v9fs_uint32_write(req, flags);
 410     v9fs_req_send(req);
 411     return req;
 412 }
 413
 414 /* size[4] Rlopen tag[2] qid[13] iounit[4] */
 415 static void v9fs_rlopen(P9Req *req, v9fs_qid *qid, uint32_t *iounit)
 416 {
 417     v9fs_req_recv(req, P9_RLOPEN);
 418     if (qid) {
 419         v9fs_memread(req, qid, 13);
 420     } else {
 421         v9fs_memskip(req, 13);
 422     }
 423     if (iounit) {
 424         v9fs_uint32_read(req, iounit);
 425     }
 426     v9fs_req_free(req);
 427 }
 428
 429 /* size[4] Twrite tag[2] fid[4] offset[8] count[4] data[count] */
 430 static P9Req *v9fs_twrite(QVirtIO9P *v9p, uint32_t fid, uint64_t offset,
 431                           uint32_t count, const void *data, uint16_t tag)
 432 {
 433     P9Req *req;
 434     uint32_t body_size = 4 + 8 + 4;
 435
 436     g_assert_cmpint(body_size, <=, UINT32_MAX - count);
 437     body_size += count;
 438     req = v9fs_req_init(v9p,  body_size, P9_TWRITE, tag);
 439     v9fs_uint32_write(req, fid);
 440     v9fs_uint64_write(req, offset);
 441     v9fs_uint32_write(req, count);
 442     v9fs_memwrite(req, data, count);
 443     v9fs_req_send(req);
 444     return req;
 445 }
 446
 447 /* size[4] Rwrite tag[2] count[4] */
 448 static void v9fs_rwrite(P9Req *req, uint32_t *count)
 449 {
 450     v9fs_req_recv(req, P9_RWRITE);
 451     if (count) {
 452         v9fs_uint32_read(req, count);
 453     }
 454     v9fs_req_free(req);
 455 }
 456
 457 static void fs_version(QVirtIO9P *v9p)
 458 {
 459     const char *version = "9P2000.L";
 460     uint16_t server_len;
 461     char *server_version;
 462     P9Req *req;
 463
 464     req = v9fs_tversion(v9p, P9_MAX_SIZE, version, P9_NOTAG);
 465     v9fs_req_wait_for_reply(req);
 466     v9fs_rversion(req, &server_len, &server_version);
 467
 468     g_assert_cmpmem(server_version, server_len, version, strlen(version));
 469
 470     g_free(server_version);
 471 }
 472
 473 static void fs_attach(QVirtIO9P *v9p)
 474 {
 475     P9Req *req;
 476
 477     fs_version(v9p);
 478     req = v9fs_tattach(v9p, 0, getuid(), 0);
 479     v9fs_req_wait_for_reply(req);
 480     v9fs_rattach(req, NULL);
 481 }
 482
 483 static void fs_walk(QVirtIO9P *v9p)
 484 {
 485     char *wnames[P9_MAXWELEM];
 486     uint16_t nwqid;
 487     v9fs_qid *wqid;
 488     int i;
 489     P9Req *req;
 490
 491     for (i = 0; i < P9_MAXWELEM; i++) {
 492         wnames[i] = g_strdup_printf(QTEST_V9FS_SYNTH_WALK_FILE, i);
 493     }
 494
 495     fs_attach(v9p);
 496     req = v9fs_twalk(v9p, 0, 1, P9_MAXWELEM, wnames, 0);
 497     v9fs_req_wait_for_reply(req);
 498     v9fs_rwalk(req, &nwqid, &wqid);
 499
 500     g_assert_cmpint(nwqid, ==, P9_MAXWELEM);
 501
 502     for (i = 0; i < P9_MAXWELEM; i++) {
 503         g_free(wnames[i]);
 504     }
 505
 506     g_free(wqid);
 507 }
 508
 509 static void fs_walk_no_slash(QVirtIO9P *v9p)
 510 {
 511     char *const wnames[] = { g_strdup(" /") };
 512     P9Req *req;
 513     uint32_t err;
 514
 515     fs_attach(v9p);
 516     req = v9fs_twalk(v9p, 0, 1, 1, wnames, 0);
 517     v9fs_req_wait_for_reply(req);
 518     v9fs_rlerror(req, &err);
 519
 520     g_assert_cmpint(err, ==, ENOENT);
 521
 522     g_free(wnames[0]);
 523 }
 524
 525 static void fs_walk_dotdot(QVirtIO9P *v9p)
 526 {
 527     char *const wnames[] = { g_strdup("..") };
 528     v9fs_qid root_qid, *wqid;
 529     P9Req *req;
 530
 531     fs_version(v9p);
 532     req = v9fs_tattach(v9p, 0, getuid(), 0);
 533     v9fs_req_wait_for_reply(req);
 534     v9fs_rattach(req, &root_qid);
 535
 536     req = v9fs_twalk(v9p, 0, 1, 1, wnames, 0);
 537     v9fs_req_wait_for_reply(req);
 538     v9fs_rwalk(req, NULL, &wqid); /* We now we'll get one qid */
 539
 540     g_assert_cmpmem(&root_qid, 13, wqid[0], 13);
 541
 542     g_free(wqid);
 543     g_free(wnames[0]);
 544 }
 545
 546 static void fs_lopen(QVirtIO9P *v9p)
 547 {
 548     char *const wnames[] = { g_strdup(QTEST_V9FS_SYNTH_LOPEN_FILE) };
 549     P9Req *req;
 550
 551     fs_attach(v9p);
 552     req = v9fs_twalk(v9p, 0, 1, 1, wnames, 0);
 553     v9fs_req_wait_for_reply(req);
 554     v9fs_rwalk(req, NULL, NULL);
 555
 556     req = v9fs_tlopen(v9p, 1, O_WRONLY, 0);
 557     v9fs_req_wait_for_reply(req);
 558     v9fs_rlopen(req, NULL, NULL);
 559
 560     g_free(wnames[0]);
 561 }
 562
 563 static void fs_write(QVirtIO9P *v9p)
 564 {
 565     static const uint32_t write_count = P9_MAX_SIZE / 2;
 566     char *const wnames[] = { g_strdup(QTEST_V9FS_SYNTH_WRITE_FILE) };
 567     char *buf = g_malloc0(write_count);
 568     uint32_t count;
 569     P9Req *req;
 570
 571     fs_attach(v9p);
 572     req = v9fs_twalk(v9p, 0, 1, 1, wnames, 0);
 573     v9fs_req_wait_for_reply(req);
 574     v9fs_rwalk(req, NULL, NULL);
 575
 576     req = v9fs_tlopen(v9p, 1, O_WRONLY, 0);
 577     v9fs_req_wait_for_reply(req);
 578     v9fs_rlopen(req, NULL, NULL);
 579
 580     req = v9fs_twrite(v9p, 1, 0, write_count, buf, 0);
 581     v9fs_req_wait_for_reply(req);
 582     v9fs_rwrite(req, &count);
 583     g_assert_cmpint(count, ==, write_count);
 584
 585     g_free(buf);
 586     g_free(wnames[0]);
 587 }
 588
 589 typedef void (*v9fs_test_fn)(QVirtIO9P *v9p);
 590
 591 static void v9fs_run_pci_test(gconstpointer data)
 592 {
 593     v9fs_test_fn fn = data;
 594     QVirtIO9P *v9p = qvirtio_9p_pci_start();
 595
 596     if (fn) {
 597         fn(v9p);
 598     }
 599     qvirtio_9p_pci_stop(v9p);
 600 }
 601
 602 static void v9fs_qtest_pci_add(const char *path, v9fs_test_fn fn)
 603 {
 604     qtest_add_data_func(path, fn, v9fs_run_pci_test);
 605 }
 606
 607 int main(int argc, char **argv)
 608 {
 609     g_test_init(&argc, &argv, NULL);
 610     v9fs_qtest_pci_add("/virtio/9p/pci/nop", NULL);
 611     v9fs_qtest_pci_add("/virtio/9p/pci/config", pci_config);
 612     v9fs_qtest_pci_add("/virtio/9p/pci/fs/version/basic", fs_version);
 613     v9fs_qtest_pci_add("/virtio/9p/pci/fs/attach/basic", fs_attach);
 614     v9fs_qtest_pci_add("/virtio/9p/pci/fs/walk/basic", fs_walk);
 615     v9fs_qtest_pci_add("/virtio/9p/pci/fs/walk/no_slash", fs_walk_no_slash);
 616     v9fs_qtest_pci_add("/virtio/9p/pci/fs/walk/dotdot_from_root",
 617                        fs_walk_dotdot);
 618     v9fs_qtest_pci_add("/virtio/9p/pci/fs/lopen/basic", fs_lopen);
 619     v9fs_qtest_pci_add("/virtio/9p/pci/fs/write/basic", fs_write);
 620
 621     return g_test_run();
 622 }