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