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         setenv("QEMU_AUDIO_DRV", "none", true);
 169         command = g_strdup_printf("exec %s "
 170                                   "-qtest unix:%s,nowait "
 171                                   "-qtest-log %s "
 172                                   "-qmp unix:%s,nowait "
 173                                   "-machine accel=qtest "
 174                                   "-display none "
 175                                   "%s", qemu_binary, socket_path,
 176                                   getenv("QTEST_LOG") ? "/dev/fd/2" : "/dev/null",
 177                                   qmp_socket_path,
 178                                   extra_args ?: "");
 179         execlp("/bin/sh", "sh", "-c", command, NULL);
 180         exit(1);
 181     }
 182
 183     s->fd = socket_accept(sock);
 184     if (s->fd >= 0) {
 185         s->qmp_fd = socket_accept(qmpsock);
 186     }
 187     unlink(socket_path);
 188     unlink(qmp_socket_path);
 189     g_free(socket_path);
 190     g_free(qmp_socket_path);
 191
 192     g_assert(s->fd >= 0 && s->qmp_fd >= 0);
 193
 194     s->rx = g_string_new("");
 195     for (i = 0; i < MAX_IRQ; i++) {
 196         s->irq_level[i] = false;
 197     }
 198
 199     /* Read the QMP greeting and then do the handshake */
 200     qtest_qmp_discard_response(s, "");
 201     qtest_qmp_discard_response(s, "{ 'execute': 'qmp_capabilities' }");
 202
 203     if (getenv("QTEST_STOP")) {
 204         kill(s->qemu_pid, SIGSTOP);
 205     }
 206
 207     return s;
 208 }
 209
 210 void qtest_quit(QTestState *s)
 211 {
 212     /* Uninstall SIGABRT handler on last instance */
 213     if (qtest_instances && !qtest_instances->next) {
 214         cleanup_sigabrt_handler();
 215     }
 216
 217     qtest_instances = g_list_remove(qtest_instances, s);
 218
 219     kill_qemu(s);
 220     close(s->fd);
 221     close(s->qmp_fd);
 222     g_string_free(s->rx, true);
 223     g_free(s);
 224 }
 225
 226 static void socket_send(int fd, const char *buf, size_t size)
 227 {
 228     size_t offset;
 229
 230     offset = 0;
 231     while (offset < size) {
 232         ssize_t len;
 233
 234         len = write(fd, buf + offset, size - offset);
 235         if (len == -1 && errno == EINTR) {
 236             continue;
 237         }
 238
 239         g_assert_no_errno(len);
 240         g_assert_cmpint(len, >, 0);
 241
 242         offset += len;
 243     }
 244 }
 245
 246 static void socket_sendf(int fd, const char *fmt, va_list ap)
 247 {
 248     gchar *str = g_strdup_vprintf(fmt, ap);
 249     size_t size = strlen(str);
 250
 251     socket_send(fd, str, size);
 252     g_free(str);
 253 }
 254
 255 static void GCC_FMT_ATTR(2, 3) qtest_sendf(QTestState *s, const char *fmt, ...)
 256 {
 257     va_list ap;
 258
 259     va_start(ap, fmt);
 260     socket_sendf(s->fd, fmt, ap);
 261     va_end(ap);
 262 }
 263
 264 static GString *qtest_recv_line(QTestState *s)
 265 {
 266     GString *line;
 267     size_t offset;
 268     char *eol;
 269
 270     while ((eol = strchr(s->rx->str, '\n')) == NULL) {
 271         ssize_t len;
 272         char buffer[1024];
 273
 274         len = read(s->fd, buffer, sizeof(buffer));
 275         if (len == -1 && errno == EINTR) {
 276             continue;
 277         }
 278
 279         if (len == -1 || len == 0) {
 280             fprintf(stderr, "Broken pipe\n");
 281             exit(1);
 282         }
 283
 284         g_string_append_len(s->rx, buffer, len);
 285     }
 286
 287     offset = eol - s->rx->str;
 288     line = g_string_new_len(s->rx->str, offset);
 289     g_string_erase(s->rx, 0, offset + 1);
 290
 291     return line;
 292 }
 293
 294 static gchar **qtest_rsp(QTestState *s, int expected_args)
 295 {
 296     GString *line;
 297     gchar **words;
 298     int i;
 299
 300 redo:
 301     line = qtest_recv_line(s);
 302     words = g_strsplit(line->str, " ", 0);
 303     g_string_free(line, TRUE);
 304
 305     if (strcmp(words[0], "IRQ") == 0) {
 306         int irq;
 307
 308         g_assert(words[1] != NULL);
 309         g_assert(words[2] != NULL);
 310
 311         irq = strtoul(words[2], NULL, 0);
 312         g_assert_cmpint(irq, >=, 0);
 313         g_assert_cmpint(irq, <, MAX_IRQ);
 314
 315         if (strcmp(words[1], "raise") == 0) {
 316             s->irq_level[irq] = true;
 317         } else {
 318             s->irq_level[irq] = false;
 319         }
 320
 321         g_strfreev(words);
 322         goto redo;
 323     }
 324
 325     g_assert(words[0] != NULL);
 326     g_assert_cmpstr(words[0], ==, "OK");
 327
 328     if (expected_args) {
 329         for (i = 0; i < expected_args; i++) {
 330             g_assert(words[i] != NULL);
 331         }
 332     } else {
 333         g_strfreev(words);
 334     }
 335
 336     return words;
 337 }
 338
 339 typedef struct {
 340     JSONMessageParser parser;
 341     QDict *response;
 342 } QMPResponseParser;
 343
 344 static void qmp_response(JSONMessageParser *parser, QList *tokens)
 345 {
 346     QMPResponseParser *qmp = container_of(parser, QMPResponseParser, parser);
 347     QObject *obj;
 348
 349     obj = json_parser_parse(tokens, NULL);
 350     if (!obj) {
 351         fprintf(stderr, "QMP JSON response parsing failed\n");
 352         exit(1);
 353     }
 354
 355     g_assert(qobject_type(obj) == QTYPE_QDICT);
 356     g_assert(!qmp->response);
 357     qmp->response = (QDict *)obj;
 358 }
 359
 360 QDict *qtest_qmp_receive(QTestState *s)
 361 {
 362     QMPResponseParser qmp;
 363     bool log = getenv("QTEST_LOG") != NULL;
 364
 365     qmp.response = NULL;
 366     json_message_parser_init(&qmp.parser, qmp_response);
 367     while (!qmp.response) {
 368         ssize_t len;
 369         char c;
 370
 371         len = read(s->qmp_fd, &c, 1);
 372         if (len == -1 && errno == EINTR) {
 373             continue;
 374         }
 375
 376         if (len == -1 || len == 0) {
 377             fprintf(stderr, "Broken pipe\n");
 378             exit(1);
 379         }
 380
 381         if (log) {
 382             len = write(2, &c, 1);
 383         }
 384         json_message_parser_feed(&qmp.parser, &c, 1);
 385     }
 386     json_message_parser_destroy(&qmp.parser);
 387
 388     return qmp.response;
 389 }
 390
 391 QDict *qtest_qmpv(QTestState *s, const char *fmt, va_list ap)
 392 {
 393     va_list ap_copy;
 394     QObject *qobj;
 395
 396     /* Going through qobject ensures we escape strings properly.
 397      * This seemingly unnecessary copy is required in case va_list
 398      * is an array type.
 399      */
 400     va_copy(ap_copy, ap);
 401     qobj = qobject_from_jsonv(fmt, &ap_copy);
 402     va_end(ap_copy);
 403
 404     /* No need to send anything for an empty QObject.  */
 405     if (qobj) {
 406         int log = getenv("QTEST_LOG") != NULL;
 407         QString *qstr = qobject_to_json(qobj);
 408         const char *str = qstring_get_str(qstr);
 409         size_t size = qstring_get_length(qstr);
 410
 411         if (log) {
 412             fprintf(stderr, "%s", str);
 413         }
 414         /* Send QMP request */
 415         socket_send(s->qmp_fd, str, size);
 416
 417         QDECREF(qstr);
 418         qobject_decref(qobj);
 419     }
 420
 421     /* Receive reply */
 422     return qtest_qmp_receive(s);
 423 }
 424
 425 QDict *qtest_qmp(QTestState *s, const char *fmt, ...)
 426 {
 427     va_list ap;
 428     QDict *response;
 429
 430     va_start(ap, fmt);
 431     response = qtest_qmpv(s, fmt, ap);
 432     va_end(ap);
 433     return response;
 434 }
 435
 436 void qtest_qmpv_discard_response(QTestState *s, const char *fmt, va_list ap)
 437 {
 438     QDict *response = qtest_qmpv(s, fmt, ap);
 439     QDECREF(response);
 440 }
 441
 442 void qtest_qmp_discard_response(QTestState *s, const char *fmt, ...)
 443 {
 444     va_list ap;
 445     QDict *response;
 446
 447     va_start(ap, fmt);
 448     response = qtest_qmpv(s, fmt, ap);
 449     va_end(ap);
 450     QDECREF(response);
 451 }
 452
 453 const char *qtest_get_arch(void)
 454 {
 455     const char *qemu = getenv("QTEST_QEMU_BINARY");
 456     const char *end = strrchr(qemu, '/');
 457
 458     return end + strlen("/qemu-system-");
 459 }
 460
 461 bool qtest_get_irq(QTestState *s, int num)
 462 {
 463     /* dummy operation in order to make sure irq is up to date */
 464     qtest_inb(s, 0);
 465
 466     return s->irq_level[num];
 467 }
 468
 469 static int64_t qtest_clock_rsp(QTestState *s)
 470 {
 471     gchar **words;
 472     int64_t clock;
 473     words = qtest_rsp(s, 2);
 474     clock = g_ascii_strtoll(words[1], NULL, 0);
 475     g_strfreev(words);
 476     return clock;
 477 }
 478
 479 int64_t qtest_clock_step_next(QTestState *s)
 480 {
 481     qtest_sendf(s, "clock_step\n");
 482     return qtest_clock_rsp(s);
 483 }
 484
 485 int64_t qtest_clock_step(QTestState *s, int64_t step)
 486 {
 487     qtest_sendf(s, "clock_step %"PRIi64"\n", step);
 488     return qtest_clock_rsp(s);
 489 }
 490
 491 int64_t qtest_clock_set(QTestState *s, int64_t val)
 492 {
 493     qtest_sendf(s, "clock_set %"PRIi64"\n", val);
 494     return qtest_clock_rsp(s);
 495 }
 496
 497 void qtest_irq_intercept_out(QTestState *s, const char *qom_path)
 498 {
 499     qtest_sendf(s, "irq_intercept_out %s\n", qom_path);
 500     qtest_rsp(s, 0);
 501 }
 502
 503 void qtest_irq_intercept_in(QTestState *s, const char *qom_path)
 504 {
 505     qtest_sendf(s, "irq_intercept_in %s\n", qom_path);
 506     qtest_rsp(s, 0);
 507 }
 508
 509 static void qtest_out(QTestState *s, const char *cmd, uint16_t addr, uint32_t value)
 510 {
 511     qtest_sendf(s, "%s 0x%x 0x%x\n", cmd, addr, value);
 512     qtest_rsp(s, 0);
 513 }
 514
 515 void qtest_outb(QTestState *s, uint16_t addr, uint8_t value)
 516 {
 517     qtest_out(s, "outb", addr, value);
 518 }
 519
 520 void qtest_outw(QTestState *s, uint16_t addr, uint16_t value)
 521 {
 522     qtest_out(s, "outw", addr, value);
 523 }
 524
 525 void qtest_outl(QTestState *s, uint16_t addr, uint32_t value)
 526 {
 527     qtest_out(s, "outl", addr, value);
 528 }
 529
 530 static uint32_t qtest_in(QTestState *s, const char *cmd, uint16_t addr)
 531 {
 532     gchar **args;
 533     uint32_t value;
 534
 535     qtest_sendf(s, "%s 0x%x\n", cmd, addr);
 536     args = qtest_rsp(s, 2);
 537     value = strtoul(args[1], NULL, 0);
 538     g_strfreev(args);
 539
 540     return value;
 541 }
 542
 543 uint8_t qtest_inb(QTestState *s, uint16_t addr)
 544 {
 545     return qtest_in(s, "inb", addr);
 546 }
 547
 548 uint16_t qtest_inw(QTestState *s, uint16_t addr)
 549 {
 550     return qtest_in(s, "inw", addr);
 551 }
 552
 553 uint32_t qtest_inl(QTestState *s, uint16_t addr)
 554 {
 555     return qtest_in(s, "inl", addr);
 556 }
 557
 558 static void qtest_write(QTestState *s, const char *cmd, uint64_t addr,
 559                         uint64_t value)
 560 {
 561     qtest_sendf(s, "%s 0x%" PRIx64 " 0x%" PRIx64 "\n", cmd, addr, value);
 562     qtest_rsp(s, 0);
 563 }
 564
 565 void qtest_writeb(QTestState *s, uint64_t addr, uint8_t value)
 566 {
 567     qtest_write(s, "writeb", addr, value);
 568 }
 569
 570 void qtest_writew(QTestState *s, uint64_t addr, uint16_t value)
 571 {
 572     qtest_write(s, "writew", addr, value);
 573 }
 574
 575 void qtest_writel(QTestState *s, uint64_t addr, uint32_t value)
 576 {
 577     qtest_write(s, "writel", addr, value);
 578 }
 579
 580 void qtest_writeq(QTestState *s, uint64_t addr, uint64_t value)
 581 {
 582     qtest_write(s, "writeq", addr, value);
 583 }
 584
 585 static uint64_t qtest_read(QTestState *s, const char *cmd, uint64_t addr)
 586 {
 587     gchar **args;
 588     uint64_t value;
 589
 590     qtest_sendf(s, "%s 0x%" PRIx64 "\n", cmd, addr);
 591     args = qtest_rsp(s, 2);
 592     value = strtoull(args[1], NULL, 0);
 593     g_strfreev(args);
 594
 595     return value;
 596 }
 597
 598 uint8_t qtest_readb(QTestState *s, uint64_t addr)
 599 {
 600     return qtest_read(s, "readb", addr);
 601 }
 602
 603 uint16_t qtest_readw(QTestState *s, uint64_t addr)
 604 {
 605     return qtest_read(s, "readw", addr);
 606 }
 607
 608 uint32_t qtest_readl(QTestState *s, uint64_t addr)
 609 {
 610     return qtest_read(s, "readl", addr);
 611 }
 612
 613 uint64_t qtest_readq(QTestState *s, uint64_t addr)
 614 {
 615     return qtest_read(s, "readq", addr);
 616 }
 617
 618 static int hex2nib(char ch)
 619 {
 620     if (ch >= '0' && ch <= '9') {
 621         return ch - '0';
 622     } else if (ch >= 'a' && ch <= 'f') {
 623         return 10 + (ch - 'a');
 624     } else if (ch >= 'A' && ch <= 'F') {
 625         return 10 + (ch - 'a');
 626     } else {
 627         return -1;
 628     }
 629 }
 630
 631 void qtest_memread(QTestState *s, uint64_t addr, void *data, size_t size)
 632 {
 633     uint8_t *ptr = data;
 634     gchar **args;
 635     size_t i;
 636
 637     qtest_sendf(s, "read 0x%" PRIx64 " 0x%zx\n", addr, size);
 638     args = qtest_rsp(s, 2);
 639
 640     for (i = 0; i < size; i++) {
 641         ptr[i] = hex2nib(args[1][2 + (i * 2)]) << 4;
 642         ptr[i] |= hex2nib(args[1][2 + (i * 2) + 1]);
 643     }
 644
 645     g_strfreev(args);
 646 }
 647
 648 void qtest_add_func(const char *str, void (*fn))
 649 {
 650     gchar *path = g_strdup_printf("/%s/%s", qtest_get_arch(), str);
 651     g_test_add_func(path, fn);
 652     g_free(path);
 653 }
 654
 655 void qtest_memwrite(QTestState *s, uint64_t addr, const void *data, size_t size)
 656 {
 657     const uint8_t *ptr = data;
 658     size_t i;
 659
 660     qtest_sendf(s, "write 0x%" PRIx64 " 0x%zx 0x", addr, size);
 661     for (i = 0; i < size; i++) {
 662         qtest_sendf(s, "%02x", ptr[i]);
 663     }
 664     qtest_sendf(s, "\n");
 665     qtest_rsp(s, 0);
 666 }
 667
 668 void qtest_memset(QTestState *s, uint64_t addr, uint8_t pattern, size_t size)
 669 {
 670     size_t i;
 671
 672     qtest_sendf(s, "write 0x%" PRIx64 " 0x%zx 0x", addr, size);
 673     for (i = 0; i < size; i++) {
 674         qtest_sendf(s, "%02x", pattern);
 675     }
 676     qtest_sendf(s, "\n");
 677     qtest_rsp(s, 0);
 678 }
 679
 680 QDict *qmp(const char *fmt, ...)
 681 {
 682     va_list ap;
 683     QDict *response;
 684
 685     va_start(ap, fmt);
 686     response = qtest_qmpv(global_qtest, fmt, ap);
 687     va_end(ap);
 688     return response;
 689 }
 690
 691 void qmp_discard_response(const char *fmt, ...)
 692 {
 693     va_list ap;
 694
 695     va_start(ap, fmt);
 696     qtest_qmpv_discard_response(global_qtest, fmt, ap);
 697     va_end(ap);
 698 }
 699
 700 bool qtest_big_endian(void)
 701 {
 702     const char *arch = qtest_get_arch();
 703     int i;
 704
 705     static const struct {
 706         const char *arch;
 707         bool big_endian;
 708     } endianness[] = {
 709         { "aarch64", false },
 710         { "alpha", false },
 711         { "arm", false },
 712         { "cris", false },
 713         { "i386", false },
 714         { "lm32", true },
 715         { "m68k", true },
 716         { "microblaze", true },
 717         { "microblazeel", false },
 718         { "mips", true },
 719         { "mips64", true },
 720         { "mips64el", false },
 721         { "mipsel", false },
 722         { "moxie", true },
 723         { "or32", true },
 724         { "ppc", true },
 725         { "ppc64", true },
 726         { "ppcemb", true },
 727         { "s390x", true },
 728         { "sh4", false },
 729         { "sh4eb", true },
 730         { "sparc", true },
 731         { "sparc64", true },
 732         { "unicore32", false },
 733         { "x86_64", false },
 734         { "xtensa", false },
 735         { "xtensaeb", true },
 736         {},
 737     };
 738
 739     for (i = 0; endianness[i].arch; i++) {
 740         if (strcmp(endianness[i].arch, arch) == 0) {
 741             return endianness[i].big_endian;
 742         }
 743     }
 744
 745     return false;
 746 }