tests/libqtest.c

   1 /*
   2  * QTest
   3  *
   4  * Copyright IBM, Corp. 2012
   5  * Copyright Red Hat, Inc. 2012
   6  * Copyright SUSE LINUX Products GmbH 2013
   7  *
   8  * Authors:
   9  *  Anthony Liguori   <aliguori@us.ibm.com>
  10  *  Paolo Bonzini     <pbonzini@redhat.com>
  11  *  Andreas Färber    <afaerber@suse.de>
  12  *
  13  * This work is licensed under the terms of the GNU GPL, version 2 or later.
  14  * See the COPYING file in the top-level directory.
  15  *
  16  */
  17 #include "libqtest.h"
  18
  19 #include <glib.h>
  20 #include <sys/types.h>
  21 #include <sys/socket.h>
  22 #include <sys/wait.h>
  23 #include <sys/un.h>
  24 #include <inttypes.h>
  25 #include <errno.h>
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <unistd.h>
  29 #include <string.h>
  30
  31 #include "qemu/compiler.h"
  32 #include "qemu/osdep.h"
  33 #include "qapi/qmp/json-parser.h"
  34 #include "qapi/qmp/json-streamer.h"
  35 #include "qapi/qmp/qjson.h"
  36
  37 #define MAX_IRQ 256
  38 #define SOCKET_TIMEOUT 5
  39
  40 QTestState *global_qtest;
  41
  42 struct QTestState
  43 {
  44     int fd;
  45     int qmp_fd;
  46     bool irq_level[MAX_IRQ];
  47     GString *rx;
  48     pid_t qemu_pid;  /* our child QEMU process */
  49     struct sigaction sigact_old; /* restored on exit */
  50 };
  51
  52 static GList *qtest_instances;
  53 static struct sigaction sigact_old;
  54
  55 #define g_assert_no_errno(ret) do { \
  56     g_assert_cmpint(ret, !=, -1); \
  57 } while (0)
  58
  59 static int init_socket(const char *socket_path)
  60 {
  61     struct sockaddr_un addr;
  62     int sock;
  63     int ret;
  64
  65     sock = socket(PF_UNIX, SOCK_STREAM, 0);
  66     g_assert_no_errno(sock);
  67
  68     addr.sun_family = AF_UNIX;
  69     snprintf(addr.sun_path, sizeof(addr.sun_path), "%s", socket_path);
  70     qemu_set_cloexec(sock);
  71
  72     do {
  73         ret = bind(sock, (struct sockaddr *)&addr, sizeof(addr));
  74     } while (ret == -1 && errno == EINTR);
  75     g_assert_no_errno(ret);
  76     ret = listen(sock, 1);
  77     g_assert_no_errno(ret);
  78
  79     return sock;
  80 }
  81
  82 static int socket_accept(int sock)
  83 {
  84     struct sockaddr_un addr;
  85     socklen_t addrlen;
  86     int ret;
  87     struct timeval timeout = { .tv_sec = SOCKET_TIMEOUT,
  88                                .tv_usec = 0 };
  89
  90     setsockopt(sock, SOL_SOCKET, SO_RCVTIMEO, (void *)&timeout,
  91                sizeof(timeout));
  92
  93     do {
  94         addrlen = sizeof(addr);
  95         ret = accept(sock, (struct sockaddr *)&addr, &addrlen);
  96     } while (ret == -1 && errno == EINTR);
  97     if (ret == -1) {
  98         fprintf(stderr, "%s failed: %s\n", __func__, strerror(errno));
  99     }
 100     close(sock);
 101
 102     return ret;
 103 }
 104
 105 static void kill_qemu(QTestState *s)
 106 {
 107     if (s->qemu_pid != -1) {
 108         kill(s->qemu_pid, SIGTERM);
 109         waitpid(s->qemu_pid, NULL, 0);
 110     }
 111 }
 112
 113 static void sigabrt_handler(int signo)
 114 {
 115     GList *elem;
 116     for (elem = qtest_instances; elem; elem = elem->next) {
 117         kill_qemu(elem->data);
 118     }
 119 }
 120
 121 static void setup_sigabrt_handler(void)
 122 {
 123     struct sigaction sigact;
 124
 125     /* Catch SIGABRT to clean up on g_assert() failure */
 126     sigact = (struct sigaction){
 127         .sa_handler = sigabrt_handler,
 128         .sa_flags = SA_RESETHAND,
 129     };
 130     sigemptyset(&sigact.sa_mask);
 131     sigaction(SIGABRT, &sigact, &sigact_old);
 132 }
 133
 134 static void cleanup_sigabrt_handler(void)
 135 {
 136     sigaction(SIGABRT, &sigact_old, NULL);
 137 }
 138
 139 QTestState *qtest_init(const char *extra_args)
 140 {
 141     QTestState *s;
 142     int sock, qmpsock, i;
 143     gchar *socket_path;
 144     gchar *qmp_socket_path;
 145     gchar *command;
 146     const char *qemu_binary;
 147
 148     qemu_binary = getenv("QTEST_QEMU_BINARY");
 149     g_assert(qemu_binary != NULL);
 150
 151     s = g_malloc(sizeof(*s));
 152
 153     socket_path = g_strdup_printf("/tmp/qtest-%d.sock", getpid());
 154     qmp_socket_path = g_strdup_printf("/tmp/qtest-%d.qmp", getpid());
 155
 156     sock = init_socket(socket_path);
 157     qmpsock = init_socket(qmp_socket_path);
 158
 159     /* Only install SIGABRT handler once */
 160     if (!qtest_instances) {
 161         setup_sigabrt_handler();
 162     }
 163
 164     qtest_instances = g_list_prepend(qtest_instances, s);
 165
 166     s->qemu_pid = fork();
 167     if (s->qemu_pid == 0) {
 168         command = g_strdup_printf("exec %s "
 169                                   "-qtest unix:%s,nowait "
 170                                   "-qtest-log %s "
 171                                   "-qmp unix:%s,nowait "
 172                                   "-machine accel=qtest "
 173                                   "-display none "
 174                                   "%s", qemu_binary, socket_path,
 175                                   getenv("QTEST_LOG") ? "/dev/fd/2" : "/dev/null",
 176                                   qmp_socket_path,
 177                                   extra_args ?: "");
 178         execlp("/bin/sh", "sh", "-c", command, NULL);
 179         exit(1);
 180     }
 181
 182     s->fd = socket_accept(sock);
 183     if (s->fd >= 0) {
 184         s->qmp_fd = socket_accept(qmpsock);
 185     }
 186     unlink(socket_path);
 187     unlink(qmp_socket_path);
 188     g_free(socket_path);
 189     g_free(qmp_socket_path);
 190
 191     g_assert(s->fd >= 0 && s->qmp_fd >= 0);
 192
 193     s->rx = g_string_new("");
 194     for (i = 0; i < MAX_IRQ; i++) {
 195         s->irq_level[i] = false;
 196     }
 197
 198     /* Read the QMP greeting and then do the handshake */
 199     qtest_qmp_discard_response(s, "");
 200     qtest_qmp_discard_response(s, "{ 'execute': 'qmp_capabilities' }");
 201
 202     if (getenv("QTEST_STOP")) {
 203         kill(s->qemu_pid, SIGSTOP);
 204     }
 205
 206     return s;
 207 }
 208
 209 void qtest_quit(QTestState *s)
 210 {
 211     /* Uninstall SIGABRT handler on last instance */
 212     if (qtest_instances && !qtest_instances->next) {
 213         cleanup_sigabrt_handler();
 214     }
 215
 216     qtest_instances = g_list_remove(qtest_instances, s);
 217
 218     kill_qemu(s);
 219     close(s->fd);
 220     close(s->qmp_fd);
 221     g_string_free(s->rx, true);
 222     g_free(s);
 223 }
 224
 225 static void socket_send(int fd, const char *buf, size_t size)
 226 {
 227     size_t offset;
 228
 229     offset = 0;
 230     while (offset < size) {
 231         ssize_t len;
 232
 233         len = write(fd, buf + offset, size - offset);
 234         if (len == -1 && errno == EINTR) {
 235             continue;
 236         }
 237
 238         g_assert_no_errno(len);
 239         g_assert_cmpint(len, >, 0);
 240
 241         offset += len;
 242     }
 243 }
 244
 245 static void socket_sendf(int fd, const char *fmt, va_list ap)
 246 {
 247     gchar *str = g_strdup_vprintf(fmt, ap);
 248     size_t size = strlen(str);
 249
 250     socket_send(fd, str, size);
 251     g_free(str);
 252 }
 253
 254 static void GCC_FMT_ATTR(2, 3) qtest_sendf(QTestState *s, const char *fmt, ...)
 255 {
 256     va_list ap;
 257
 258     va_start(ap, fmt);
 259     socket_sendf(s->fd, fmt, ap);
 260     va_end(ap);
 261 }
 262
 263 static GString *qtest_recv_line(QTestState *s)
 264 {
 265     GString *line;
 266     size_t offset;
 267     char *eol;
 268
 269     while ((eol = strchr(s->rx->str, '\n')) == NULL) {
 270         ssize_t len;
 271         char buffer[1024];
 272
 273         len = read(s->fd, buffer, sizeof(buffer));
 274         if (len == -1 && errno == EINTR) {
 275             continue;
 276         }
 277
 278         if (len == -1 || len == 0) {
 279             fprintf(stderr, "Broken pipe\n");
 280             exit(1);
 281         }
 282
 283         g_string_append_len(s->rx, buffer, len);
 284     }
 285
 286     offset = eol - s->rx->str;
 287     line = g_string_new_len(s->rx->str, offset);
 288     g_string_erase(s->rx, 0, offset + 1);
 289
 290     return line;
 291 }
 292
 293 static gchar **qtest_rsp(QTestState *s, int expected_args)
 294 {
 295     GString *line;
 296     gchar **words;
 297     int i;
 298
 299 redo:
 300     line = qtest_recv_line(s);
 301     words = g_strsplit(line->str, " ", 0);
 302     g_string_free(line, TRUE);
 303
 304     if (strcmp(words[0], "IRQ") == 0) {
 305         int irq;
 306
 307         g_assert(words[1] != NULL);
 308         g_assert(words[2] != NULL);
 309
 310         irq = strtoul(words[2], NULL, 0);
 311         g_assert_cmpint(irq, >=, 0);
 312         g_assert_cmpint(irq, <, MAX_IRQ);
 313
 314         if (strcmp(words[1], "raise") == 0) {
 315             s->irq_level[irq] = true;
 316         } else {
 317             s->irq_level[irq] = false;
 318         }
 319
 320         g_strfreev(words);
 321         goto redo;
 322     }
 323
 324     g_assert(words[0] != NULL);
 325     g_assert_cmpstr(words[0], ==, "OK");
 326
 327     if (expected_args) {
 328         for (i = 0; i < expected_args; i++) {
 329             g_assert(words[i] != NULL);
 330         }
 331     } else {
 332         g_strfreev(words);
 333     }
 334
 335     return words;
 336 }
 337
 338 typedef struct {
 339     JSONMessageParser parser;
 340     QDict *response;
 341 } QMPResponseParser;
 342
 343 static void qmp_response(JSONMessageParser *parser, QList *tokens)
 344 {
 345     QMPResponseParser *qmp = container_of(parser, QMPResponseParser, parser);
 346     QObject *obj;
 347
 348     obj = json_parser_parse(tokens, NULL);
 349     if (!obj) {
 350         fprintf(stderr, "QMP JSON response parsing failed\n");
 351         exit(1);
 352     }
 353
 354     g_assert(qobject_type(obj) == QTYPE_QDICT);
 355     g_assert(!qmp->response);
 356     qmp->response = (QDict *)obj;
 357 }
 358
 359 QDict *qtest_qmp_receive(QTestState *s)
 360 {
 361     QMPResponseParser qmp;
 362     bool log = getenv("QTEST_LOG") != NULL;
 363
 364     qmp.response = NULL;
 365     json_message_parser_init(&qmp.parser, qmp_response);
 366     while (!qmp.response) {
 367         ssize_t len;
 368         char c;
 369
 370         len = read(s->qmp_fd, &c, 1);
 371         if (len == -1 && errno == EINTR) {
 372             continue;
 373         }
 374
 375         if (len == -1 || len == 0) {
 376             fprintf(stderr, "Broken pipe\n");
 377             exit(1);
 378         }
 379
 380         if (log) {
 381             len = write(2, &c, 1);
 382         }
 383         json_message_parser_feed(&qmp.parser, &c, 1);
 384     }
 385     json_message_parser_destroy(&qmp.parser);
 386
 387     return qmp.response;
 388 }
 389
 390 QDict *qtest_qmpv(QTestState *s, const char *fmt, va_list ap)
 391 {
 392     va_list ap_copy;
 393     QObject *qobj;
 394
 395     /* Going through qobject ensures we escape strings properly.
 396      * This seemingly unnecessary copy is required in case va_list
 397      * is an array type.
 398      */
 399     va_copy(ap_copy, ap);
 400     qobj = qobject_from_jsonv(fmt, &ap_copy);
 401     va_end(ap_copy);
 402
 403     /* No need to send anything for an empty QObject.  */
 404     if (qobj) {
 405         int log = getenv("QTEST_LOG") != NULL;
 406         QString *qstr = qobject_to_json(qobj);
 407         const char *str = qstring_get_str(qstr);
 408         size_t size = qstring_get_length(qstr);
 409
 410         if (log) {
 411             fprintf(stderr, "%s", str);
 412         }
 413         /* Send QMP request */
 414         socket_send(s->qmp_fd, str, size);
 415
 416         QDECREF(qstr);
 417         qobject_decref(qobj);
 418     }
 419
 420     /* Receive reply */
 421     return qtest_qmp_receive(s);
 422 }
 423
 424 QDict *qtest_qmp(QTestState *s, const char *fmt, ...)
 425 {
 426     va_list ap;
 427     QDict *response;
 428
 429     va_start(ap, fmt);
 430     response = qtest_qmpv(s, fmt, ap);
 431     va_end(ap);
 432     return response;
 433 }
 434
 435 void qtest_qmpv_discard_response(QTestState *s, const char *fmt, va_list ap)
 436 {
 437     QDict *response = qtest_qmpv(s, fmt, ap);
 438     QDECREF(response);
 439 }
 440
 441 void qtest_qmp_discard_response(QTestState *s, const char *fmt, ...)
 442 {
 443     va_list ap;
 444     QDict *response;
 445
 446     va_start(ap, fmt);
 447     response = qtest_qmpv(s, fmt, ap);
 448     va_end(ap);
 449     QDECREF(response);
 450 }
 451
 452 const char *qtest_get_arch(void)
 453 {
 454     const char *qemu = getenv("QTEST_QEMU_BINARY");
 455     const char *end = strrchr(qemu, '/');
 456
 457     return end + strlen("/qemu-system-");
 458 }
 459
 460 bool qtest_get_irq(QTestState *s, int num)
 461 {
 462     /* dummy operation in order to make sure irq is up to date */
 463     qtest_inb(s, 0);
 464
 465     return s->irq_level[num];
 466 }
 467
 468 static int64_t qtest_clock_rsp(QTestState *s)
 469 {
 470     gchar **words;
 471     int64_t clock;
 472     words = qtest_rsp(s, 2);
 473     clock = g_ascii_strtoll(words[1], NULL, 0);
 474     g_strfreev(words);
 475     return clock;
 476 }
 477
 478 int64_t qtest_clock_step_next(QTestState *s)
 479 {
 480     qtest_sendf(s, "clock_step\n");
 481     return qtest_clock_rsp(s);
 482 }
 483
 484 int64_t qtest_clock_step(QTestState *s, int64_t step)
 485 {
 486     qtest_sendf(s, "clock_step %"PRIi64"\n", step);
 487     return qtest_clock_rsp(s);
 488 }
 489
 490 int64_t qtest_clock_set(QTestState *s, int64_t val)
 491 {
 492     qtest_sendf(s, "clock_set %"PRIi64"\n", val);
 493     return qtest_clock_rsp(s);
 494 }
 495
 496 void qtest_irq_intercept_out(QTestState *s, const char *qom_path)
 497 {
 498     qtest_sendf(s, "irq_intercept_out %s\n", qom_path);
 499     qtest_rsp(s, 0);
 500 }
 501
 502 void qtest_irq_intercept_in(QTestState *s, const char *qom_path)
 503 {
 504     qtest_sendf(s, "irq_intercept_in %s\n", qom_path);
 505     qtest_rsp(s, 0);
 506 }
 507
 508 static void qtest_out(QTestState *s, const char *cmd, uint16_t addr, uint32_t value)
 509 {
 510     qtest_sendf(s, "%s 0x%x 0x%x\n", cmd, addr, value);
 511     qtest_rsp(s, 0);
 512 }
 513
 514 void qtest_outb(QTestState *s, uint16_t addr, uint8_t value)
 515 {
 516     qtest_out(s, "outb", addr, value);
 517 }
 518
 519 void qtest_outw(QTestState *s, uint16_t addr, uint16_t value)
 520 {
 521     qtest_out(s, "outw", addr, value);
 522 }
 523
 524 void qtest_outl(QTestState *s, uint16_t addr, uint32_t value)
 525 {
 526     qtest_out(s, "outl", addr, value);
 527 }
 528
 529 static uint32_t qtest_in(QTestState *s, const char *cmd, uint16_t addr)
 530 {
 531     gchar **args;
 532     uint32_t value;
 533
 534     qtest_sendf(s, "%s 0x%x\n", cmd, addr);
 535     args = qtest_rsp(s, 2);
 536     value = strtoul(args[1], NULL, 0);
 537     g_strfreev(args);
 538
 539     return value;
 540 }
 541
 542 uint8_t qtest_inb(QTestState *s, uint16_t addr)
 543 {
 544     return qtest_in(s, "inb", addr);
 545 }
 546
 547 uint16_t qtest_inw(QTestState *s, uint16_t addr)
 548 {
 549     return qtest_in(s, "inw", addr);
 550 }
 551
 552 uint32_t qtest_inl(QTestState *s, uint16_t addr)
 553 {
 554     return qtest_in(s, "inl", addr);
 555 }
 556
 557 static void qtest_write(QTestState *s, const char *cmd, uint64_t addr,
 558                         uint64_t value)
 559 {
 560     qtest_sendf(s, "%s 0x%" PRIx64 " 0x%" PRIx64 "\n", cmd, addr, value);
 561     qtest_rsp(s, 0);
 562 }
 563
 564 void qtest_writeb(QTestState *s, uint64_t addr, uint8_t value)
 565 {
 566     qtest_write(s, "writeb", addr, value);
 567 }
 568
 569 void qtest_writew(QTestState *s, uint64_t addr, uint16_t value)
 570 {
 571     qtest_write(s, "writew", addr, value);
 572 }
 573
 574 void qtest_writel(QTestState *s, uint64_t addr, uint32_t value)
 575 {
 576     qtest_write(s, "writel", addr, value);
 577 }
 578
 579 void qtest_writeq(QTestState *s, uint64_t addr, uint64_t value)
 580 {
 581     qtest_write(s, "writeq", addr, value);
 582 }
 583
 584 static uint64_t qtest_read(QTestState *s, const char *cmd, uint64_t addr)
 585 {
 586     gchar **args;
 587     uint64_t value;
 588
 589     qtest_sendf(s, "%s 0x%" PRIx64 "\n", cmd, addr);
 590     args = qtest_rsp(s, 2);
 591     value = strtoull(args[1], NULL, 0);
 592     g_strfreev(args);
 593
 594     return value;
 595 }
 596
 597 uint8_t qtest_readb(QTestState *s, uint64_t addr)
 598 {
 599     return qtest_read(s, "readb", addr);
 600 }
 601
 602 uint16_t qtest_readw(QTestState *s, uint64_t addr)
 603 {
 604     return qtest_read(s, "readw", addr);
 605 }
 606
 607 uint32_t qtest_readl(QTestState *s, uint64_t addr)
 608 {
 609     return qtest_read(s, "readl", addr);
 610 }
 611
 612 uint64_t qtest_readq(QTestState *s, uint64_t addr)
 613 {
 614     return qtest_read(s, "readq", addr);
 615 }
 616
 617 static int hex2nib(char ch)
 618 {
 619     if (ch >= '0' && ch <= '9') {
 620         return ch - '0';
 621     } else if (ch >= 'a' && ch <= 'f') {
 622         return 10 + (ch - 'a');
 623     } else if (ch >= 'A' && ch <= 'F') {
 624         return 10 + (ch - 'a');
 625     } else {
 626         return -1;
 627     }
 628 }
 629
 630 void qtest_memread(QTestState *s, uint64_t addr, void *data, size_t size)
 631 {
 632     uint8_t *ptr = data;
 633     gchar **args;
 634     size_t i;
 635
 636     qtest_sendf(s, "read 0x%" PRIx64 " 0x%zx\n", addr, size);
 637     args = qtest_rsp(s, 2);
 638
 639     for (i = 0; i < size; i++) {
 640         ptr[i] = hex2nib(args[1][2 + (i * 2)]) << 4;
 641         ptr[i] |= hex2nib(args[1][2 + (i * 2) + 1]);
 642     }
 643
 644     g_strfreev(args);
 645 }
 646
 647 void qtest_add_func(const char *str, void (*fn))
 648 {
 649     gchar *path = g_strdup_printf("/%s/%s", qtest_get_arch(), str);
 650     g_test_add_func(path, fn);
 651     g_free(path);
 652 }
 653
 654 void qtest_memwrite(QTestState *s, uint64_t addr, const void *data, size_t size)
 655 {
 656     const uint8_t *ptr = data;
 657     size_t i;
 658
 659     qtest_sendf(s, "write 0x%" PRIx64 " 0x%zx 0x", addr, size);
 660     for (i = 0; i < size; i++) {
 661         qtest_sendf(s, "%02x", ptr[i]);
 662     }
 663     qtest_sendf(s, "\n");
 664     qtest_rsp(s, 0);
 665 }
 666
 667 void qtest_memset(QTestState *s, uint64_t addr, uint8_t pattern, size_t size)
 668 {
 669     size_t i;
 670
 671     qtest_sendf(s, "write 0x%" PRIx64 " 0x%zx 0x", addr, size);
 672     for (i = 0; i < size; i++) {
 673         qtest_sendf(s, "%02x", pattern);
 674     }
 675     qtest_sendf(s, "\n");
 676     qtest_rsp(s, 0);
 677 }
 678
 679 QDict *qmp(const char *fmt, ...)
 680 {
 681     va_list ap;
 682     QDict *response;
 683
 684     va_start(ap, fmt);
 685     response = qtest_qmpv(global_qtest, fmt, ap);
 686     va_end(ap);
 687     return response;
 688 }
 689
 690 void qmp_discard_response(const char *fmt, ...)
 691 {
 692     va_list ap;
 693
 694     va_start(ap, fmt);
 695     qtest_qmpv_discard_response(global_qtest, fmt, ap);
 696     va_end(ap);
 697 }