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