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