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   <[email protected]>
  10  *  Paolo Bonzini     <[email protected]>
  11  *  Andreas Färber    <[email protected]>
  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 "qemu/osdep.h"
  18 #include "libqtest.h"
  19
  20 #include <sys/socket.h>
  21 #include <sys/wait.h>
  22 #include <sys/un.h>
  23
  24 #include "qapi/qmp/json-parser.h"
  25 #include "qapi/qmp/json-streamer.h"
  26 #include "qapi/qmp/qjson.h"
  27
  28 #define MAX_IRQ 256
  29 #define SOCKET_TIMEOUT 50
  30
  31 QTestState *global_qtest;
  32
  33 struct QTestState
  34 {
  35     int fd;
  36     int qmp_fd;
  37     bool irq_level[MAX_IRQ];
  38     GString *rx;
  39     pid_t qemu_pid;  /* our child QEMU process */
  40     bool big_endian;
  41 };
  42
  43 static GHookList abrt_hooks;
  44 static GList *qtest_instances;
  45 static struct sigaction sigact_old;
  46
  47 #define g_assert_no_errno(ret) do { \
  48     g_assert_cmpint(ret, !=, -1); \
  49 } while (0)
  50
  51 static int qtest_query_target_endianness(QTestState *s);
  52
  53 static int init_socket(const char *socket_path)
  54 {
  55     struct sockaddr_un addr;
  56     int sock;
  57     int ret;
  58
  59     sock = socket(PF_UNIX, SOCK_STREAM, 0);
  60     g_assert_no_errno(sock);
  61
  62     addr.sun_family = AF_UNIX;
  63     snprintf(addr.sun_path, sizeof(addr.sun_path), "%s", socket_path);
  64     qemu_set_cloexec(sock);
  65
  66     do {
  67         ret = bind(sock, (struct sockaddr *)&addr, sizeof(addr));
  68     } while (ret == -1 && errno == EINTR);
  69     g_assert_no_errno(ret);
  70     ret = listen(sock, 1);
  71     g_assert_no_errno(ret);
  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     struct timeval timeout = { .tv_sec = SOCKET_TIMEOUT,
  82                                .tv_usec = 0 };
  83
  84     setsockopt(sock, SOL_SOCKET, SO_RCVTIMEO, (void *)&timeout,
  85                sizeof(timeout));
  86
  87     do {
  88         addrlen = sizeof(addr);
  89         ret = accept(sock, (struct sockaddr *)&addr, &addrlen);
  90     } while (ret == -1 && errno == EINTR);
  91     if (ret == -1) {
  92         fprintf(stderr, "%s failed: %s\n", __func__, strerror(errno));
  93     }
  94     close(sock);
  95
  96     return ret;
  97 }
  98
  99 static void kill_qemu(QTestState *s)
 100 {
 101     if (s->qemu_pid != -1) {
 102         kill(s->qemu_pid, SIGTERM);
 103         waitpid(s->qemu_pid, NULL, 0);
 104     }
 105 }
 106
 107 static void kill_qemu_hook_func(void *s)
 108 {
 109     kill_qemu(s);
 110 }
 111
 112 static void sigabrt_handler(int signo)
 113 {
 114     g_hook_list_invoke(&abrt_hooks, FALSE);
 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 void qtest_add_abrt_handler(GHookFunc fn, const void *data)
 136 {
 137     GHook *hook;
 138
 139     /* Only install SIGABRT handler once */
 140     if (!abrt_hooks.is_setup) {
 141         g_hook_list_init(&abrt_hooks, sizeof(GHook));
 142         setup_sigabrt_handler();
 143     }
 144
 145     hook = g_hook_alloc(&abrt_hooks);
 146     hook->func = fn;
 147     hook->data = (void *)data;
 148
 149     g_hook_prepend(&abrt_hooks, hook);
 150 }
 151
 152 QTestState *qtest_init(const char *extra_args)
 153 {
 154     QTestState *s;
 155     int sock, qmpsock, i;
 156     gchar *socket_path;
 157     gchar *qmp_socket_path;
 158     gchar *command;
 159     const char *qemu_binary;
 160
 161     qemu_binary = getenv("QTEST_QEMU_BINARY");
 162     g_assert(qemu_binary != NULL);
 163
 164     s = g_malloc(sizeof(*s));
 165
 166     socket_path = g_strdup_printf("/tmp/qtest-%d.sock", getpid());
 167     qmp_socket_path = g_strdup_printf("/tmp/qtest-%d.qmp", getpid());
 168
 169     sock = init_socket(socket_path);
 170     qmpsock = init_socket(qmp_socket_path);
 171
 172     qtest_add_abrt_handler(kill_qemu_hook_func, s);
 173
 174     s->qemu_pid = fork();
 175     if (s->qemu_pid == 0) {
 176         setenv("QEMU_AUDIO_DRV", "none", true);
 177         command = g_strdup_printf("exec %s "
 178                                   "-qtest unix:%s,nowait "
 179                                   "-qtest-log %s "
 180                                   "-qmp unix:%s,nowait "
 181                                   "-machine accel=qtest "
 182                                   "-display none "
 183                                   "%s", qemu_binary, socket_path,
 184                                   getenv("QTEST_LOG") ? "/dev/fd/2" : "/dev/null",
 185                                   qmp_socket_path,
 186                                   extra_args ?: "");
 187         execlp("/bin/sh", "sh", "-c", command, NULL);
 188         exit(1);
 189     }
 190
 191     s->fd = socket_accept(sock);
 192     if (s->fd >= 0) {
 193         s->qmp_fd = socket_accept(qmpsock);
 194     }
 195     unlink(socket_path);
 196     unlink(qmp_socket_path);
 197     g_free(socket_path);
 198     g_free(qmp_socket_path);
 199
 200     g_assert(s->fd >= 0 && s->qmp_fd >= 0);
 201
 202     s->rx = g_string_new("");
 203     for (i = 0; i < MAX_IRQ; i++) {
 204         s->irq_level[i] = false;
 205     }
 206
 207     /* Read the QMP greeting and then do the handshake */
 208     qtest_qmp_discard_response(s, "");
 209     qtest_qmp_discard_response(s, "{ 'execute': 'qmp_capabilities' }");
 210
 211     if (getenv("QTEST_STOP")) {
 212         kill(s->qemu_pid, SIGSTOP);
 213     }
 214
 215     /* ask endianness of the target */
 216
 217     s->big_endian = qtest_query_target_endianness(s);
 218
 219     return s;
 220 }
 221
 222 void qtest_quit(QTestState *s)
 223 {
 224     qtest_instances = g_list_remove(qtest_instances, s);
 225     g_hook_destroy_link(&abrt_hooks, g_hook_find_data(&abrt_hooks, TRUE, s));
 226
 227     /* Uninstall SIGABRT handler on last instance */
 228     if (!qtest_instances) {
 229         cleanup_sigabrt_handler();
 230     }
 231
 232     kill_qemu(s);
 233     close(s->fd);
 234     close(s->qmp_fd);
 235     g_string_free(s->rx, true);
 236     g_free(s);
 237 }
 238
 239 static void socket_send(int fd, const char *buf, size_t size)
 240 {
 241     size_t offset;
 242
 243     offset = 0;
 244     while (offset < size) {
 245         ssize_t len;
 246
 247         len = write(fd, buf + offset, size - offset);
 248         if (len == -1 && errno == EINTR) {
 249             continue;
 250         }
 251
 252         g_assert_no_errno(len);
 253         g_assert_cmpint(len, >, 0);
 254
 255         offset += len;
 256     }
 257 }
 258
 259 static void socket_sendf(int fd, const char *fmt, va_list ap)
 260 {
 261     gchar *str = g_strdup_vprintf(fmt, ap);
 262     size_t size = strlen(str);
 263
 264     socket_send(fd, str, size);
 265     g_free(str);
 266 }
 267
 268 static void GCC_FMT_ATTR(2, 3) qtest_sendf(QTestState *s, const char *fmt, ...)
 269 {
 270     va_list ap;
 271
 272     va_start(ap, fmt);
 273     socket_sendf(s->fd, fmt, ap);
 274     va_end(ap);
 275 }
 276
 277 static GString *qtest_recv_line(QTestState *s)
 278 {
 279     GString *line;
 280     size_t offset;
 281     char *eol;
 282
 283     while ((eol = strchr(s->rx->str, '\n')) == NULL) {
 284         ssize_t len;
 285         char buffer[1024];
 286
 287         len = read(s->fd, buffer, sizeof(buffer));
 288         if (len == -1 && errno == EINTR) {
 289             continue;
 290         }
 291
 292         if (len == -1 || len == 0) {
 293             fprintf(stderr, "Broken pipe\n");
 294             exit(1);
 295         }
 296
 297         g_string_append_len(s->rx, buffer, len);
 298     }
 299
 300     offset = eol - s->rx->str;
 301     line = g_string_new_len(s->rx->str, offset);
 302     g_string_erase(s->rx, 0, offset + 1);
 303
 304     return line;
 305 }
 306
 307 static gchar **qtest_rsp(QTestState *s, int expected_args)
 308 {
 309     GString *line;
 310     gchar **words;
 311     int i;
 312
 313 redo:
 314     line = qtest_recv_line(s);
 315     words = g_strsplit(line->str, " ", 0);
 316     g_string_free(line, TRUE);
 317
 318     if (strcmp(words[0], "IRQ") == 0) {
 319         int irq;
 320
 321         g_assert(words[1] != NULL);
 322         g_assert(words[2] != NULL);
 323
 324         irq = strtoul(words[2], NULL, 0);
 325         g_assert_cmpint(irq, >=, 0);
 326         g_assert_cmpint(irq, <, MAX_IRQ);
 327
 328         if (strcmp(words[1], "raise") == 0) {
 329             s->irq_level[irq] = true;
 330         } else {
 331             s->irq_level[irq] = false;
 332         }
 333
 334         g_strfreev(words);
 335         goto redo;
 336     }
 337
 338     g_assert(words[0] != NULL);
 339     g_assert_cmpstr(words[0], ==, "OK");
 340
 341     if (expected_args) {
 342         for (i = 0; i < expected_args; i++) {
 343             g_assert(words[i] != NULL);
 344         }
 345     } else {
 346         g_strfreev(words);
 347     }
 348
 349     return words;
 350 }
 351
 352 static int qtest_query_target_endianness(QTestState *s)
 353 {
 354     gchar **args;
 355     int big_endian;
 356
 357     qtest_sendf(s, "endianness\n");
 358     args = qtest_rsp(s, 1);
 359     g_assert(strcmp(args[1], "big") == 0 || strcmp(args[1], "little") == 0);
 360     big_endian = strcmp(args[1], "big") == 0;
 361     g_strfreev(args);
 362
 363     return big_endian;
 364 }
 365
 366 typedef struct {
 367     JSONMessageParser parser;
 368     QDict *response;
 369 } QMPResponseParser;
 370
 371 static void qmp_response(JSONMessageParser *parser, GQueue *tokens)
 372 {
 373     QMPResponseParser *qmp = container_of(parser, QMPResponseParser, parser);
 374     QObject *obj;
 375
 376     obj = json_parser_parse(tokens, NULL);
 377     if (!obj) {
 378         fprintf(stderr, "QMP JSON response parsing failed\n");
 379         exit(1);
 380     }
 381
 382     g_assert(qobject_type(obj) == QTYPE_QDICT);
 383     g_assert(!qmp->response);
 384     qmp->response = (QDict *)obj;
 385 }
 386
 387 QDict *qmp_fd_receive(int fd)
 388 {
 389     QMPResponseParser qmp;
 390     bool log = getenv("QTEST_LOG") != NULL;
 391
 392     qmp.response = NULL;
 393     json_message_parser_init(&qmp.parser, qmp_response);
 394     while (!qmp.response) {
 395         ssize_t len;
 396         char c;
 397
 398         len = read(fd, &c, 1);
 399         if (len == -1 && errno == EINTR) {
 400             continue;
 401         }
 402
 403         if (len == -1 || len == 0) {
 404             fprintf(stderr, "Broken pipe\n");
 405             exit(1);
 406         }
 407
 408         if (log) {
 409             len = write(2, &c, 1);
 410         }
 411         json_message_parser_feed(&qmp.parser, &c, 1);
 412     }
 413     json_message_parser_destroy(&qmp.parser);
 414
 415     return qmp.response;
 416 }
 417
 418 QDict *qtest_qmp_receive(QTestState *s)
 419 {
 420     return qmp_fd_receive(s->qmp_fd);
 421 }
 422
 423 /**
 424  * Allow users to send a message without waiting for the reply,
 425  * in the case that they choose to discard all replies up until
 426  * a particular EVENT is received.
 427  */
 428 void qmp_fd_sendv(int fd, const char *fmt, va_list ap)
 429 {
 430     va_list ap_copy;
 431     QObject *qobj;
 432
 433     /* Going through qobject ensures we escape strings properly.
 434      * This seemingly unnecessary copy is required in case va_list
 435      * is an array type.
 436      */
 437     va_copy(ap_copy, ap);
 438     qobj = qobject_from_jsonv(fmt, &ap_copy);
 439     va_end(ap_copy);
 440
 441     /* No need to send anything for an empty QObject.  */
 442     if (qobj) {
 443         int log = getenv("QTEST_LOG") != NULL;
 444         QString *qstr = qobject_to_json(qobj);
 445         const char *str = qstring_get_str(qstr);
 446         size_t size = qstring_get_length(qstr);
 447
 448         if (log) {
 449             fprintf(stderr, "%s", str);
 450         }
 451         /* Send QMP request */
 452         socket_send(fd, str, size);
 453
 454         QDECREF(qstr);
 455         qobject_decref(qobj);
 456     }
 457 }
 458
 459 void qtest_async_qmpv(QTestState *s, const char *fmt, va_list ap)
 460 {
 461     qmp_fd_sendv(s->qmp_fd, fmt, ap);
 462 }
 463
 464 QDict *qmp_fdv(int fd, const char *fmt, va_list ap)
 465 {
 466     qmp_fd_sendv(fd, fmt, ap);
 467
 468     return qmp_fd_receive(fd);
 469 }
 470
 471 QDict *qtest_qmpv(QTestState *s, const char *fmt, va_list ap)
 472 {
 473     qtest_async_qmpv(s, fmt, ap);
 474
 475     /* Receive reply */
 476     return qtest_qmp_receive(s);
 477 }
 478
 479 QDict *qmp_fd(int fd, const char *fmt, ...)
 480 {
 481     va_list ap;
 482     QDict *response;
 483
 484     va_start(ap, fmt);
 485     response = qmp_fdv(fd, fmt, ap);
 486     va_end(ap);
 487     return response;
 488 }
 489
 490 void qmp_fd_send(int fd, const char *fmt, ...)
 491 {
 492     va_list ap;
 493
 494     va_start(ap, fmt);
 495     qmp_fd_sendv(fd, fmt, ap);
 496     va_end(ap);
 497 }
 498
 499 QDict *qtest_qmp(QTestState *s, const char *fmt, ...)
 500 {
 501     va_list ap;
 502     QDict *response;
 503
 504     va_start(ap, fmt);
 505     response = qtest_qmpv(s, fmt, ap);
 506     va_end(ap);
 507     return response;
 508 }
 509
 510 void qtest_async_qmp(QTestState *s, const char *fmt, ...)
 511 {
 512     va_list ap;
 513
 514     va_start(ap, fmt);
 515     qtest_async_qmpv(s, fmt, ap);
 516     va_end(ap);
 517 }
 518
 519 void qtest_qmpv_discard_response(QTestState *s, const char *fmt, va_list ap)
 520 {
 521     QDict *response = qtest_qmpv(s, fmt, ap);
 522     QDECREF(response);
 523 }
 524
 525 void qtest_qmp_discard_response(QTestState *s, const char *fmt, ...)
 526 {
 527     va_list ap;
 528     QDict *response;
 529
 530     va_start(ap, fmt);
 531     response = qtest_qmpv(s, fmt, ap);
 532     va_end(ap);
 533     QDECREF(response);
 534 }
 535
 536 QDict *qtest_qmp_eventwait_ref(QTestState *s, const char *event)
 537 {
 538     QDict *response;
 539
 540     for (;;) {
 541         response = qtest_qmp_receive(s);
 542         if ((qdict_haskey(response, "event")) &&
 543             (strcmp(qdict_get_str(response, "event"), event) == 0)) {
 544             return response;
 545         }
 546         QDECREF(response);
 547     }
 548 }
 549
 550 void qtest_qmp_eventwait(QTestState *s, const char *event)
 551 {
 552     QDict *response;
 553
 554     response = qtest_qmp_eventwait_ref(s, event);
 555     QDECREF(response);
 556 }
 557
 558 char *qtest_hmpv(QTestState *s, const char *fmt, va_list ap)
 559 {
 560     char *cmd;
 561     QDict *resp;
 562     char *ret;
 563
 564     cmd = g_strdup_vprintf(fmt, ap);
 565     resp = qtest_qmp(s, "{'execute': 'human-monitor-command',"
 566                      " 'arguments': {'command-line': %s}}",
 567                      cmd);
 568     ret = g_strdup(qdict_get_try_str(resp, "return"));
 569     g_assert(ret);
 570     QDECREF(resp);
 571     g_free(cmd);
 572     return ret;
 573 }
 574
 575 char *qtest_hmp(QTestState *s, const char *fmt, ...)
 576 {
 577     va_list ap;
 578     char *ret;
 579
 580     va_start(ap, fmt);
 581     ret = qtest_hmpv(s, fmt, ap);
 582     va_end(ap);
 583     return ret;
 584 }
 585
 586 const char *qtest_get_arch(void)
 587 {
 588     const char *qemu = getenv("QTEST_QEMU_BINARY");
 589     g_assert(qemu != NULL);
 590     const char *end = strrchr(qemu, '/');
 591
 592     return end + strlen("/qemu-system-");
 593 }
 594
 595 bool qtest_get_irq(QTestState *s, int num)
 596 {
 597     /* dummy operation in order to make sure irq is up to date */
 598     qtest_inb(s, 0);
 599
 600     return s->irq_level[num];
 601 }
 602
 603 static int64_t qtest_clock_rsp(QTestState *s)
 604 {
 605     gchar **words;
 606     int64_t clock;
 607     words = qtest_rsp(s, 2);
 608     clock = g_ascii_strtoll(words[1], NULL, 0);
 609     g_strfreev(words);
 610     return clock;
 611 }
 612
 613 int64_t qtest_clock_step_next(QTestState *s)
 614 {
 615     qtest_sendf(s, "clock_step\n");
 616     return qtest_clock_rsp(s);
 617 }
 618
 619 int64_t qtest_clock_step(QTestState *s, int64_t step)
 620 {
 621     qtest_sendf(s, "clock_step %"PRIi64"\n", step);
 622     return qtest_clock_rsp(s);
 623 }
 624
 625 int64_t qtest_clock_set(QTestState *s, int64_t val)
 626 {
 627     qtest_sendf(s, "clock_set %"PRIi64"\n", val);
 628     return qtest_clock_rsp(s);
 629 }
 630
 631 void qtest_irq_intercept_out(QTestState *s, const char *qom_path)
 632 {
 633     qtest_sendf(s, "irq_intercept_out %s\n", qom_path);
 634     qtest_rsp(s, 0);
 635 }
 636
 637 void qtest_irq_intercept_in(QTestState *s, const char *qom_path)
 638 {
 639     qtest_sendf(s, "irq_intercept_in %s\n", qom_path);
 640     qtest_rsp(s, 0);
 641 }
 642
 643 static void qtest_out(QTestState *s, const char *cmd, uint16_t addr, uint32_t value)
 644 {
 645     qtest_sendf(s, "%s 0x%x 0x%x\n", cmd, addr, value);
 646     qtest_rsp(s, 0);
 647 }
 648
 649 void qtest_outb(QTestState *s, uint16_t addr, uint8_t value)
 650 {
 651     qtest_out(s, "outb", addr, value);
 652 }
 653
 654 void qtest_outw(QTestState *s, uint16_t addr, uint16_t value)
 655 {
 656     qtest_out(s, "outw", addr, value);
 657 }
 658
 659 void qtest_outl(QTestState *s, uint16_t addr, uint32_t value)
 660 {
 661     qtest_out(s, "outl", addr, value);
 662 }
 663
 664 static uint32_t qtest_in(QTestState *s, const char *cmd, uint16_t addr)
 665 {
 666     gchar **args;
 667     uint32_t value;
 668
 669     qtest_sendf(s, "%s 0x%x\n", cmd, addr);
 670     args = qtest_rsp(s, 2);
 671     value = strtoul(args[1], NULL, 0);
 672     g_strfreev(args);
 673
 674     return value;
 675 }
 676
 677 uint8_t qtest_inb(QTestState *s, uint16_t addr)
 678 {
 679     return qtest_in(s, "inb", addr);
 680 }
 681
 682 uint16_t qtest_inw(QTestState *s, uint16_t addr)
 683 {
 684     return qtest_in(s, "inw", addr);
 685 }
 686
 687 uint32_t qtest_inl(QTestState *s, uint16_t addr)
 688 {
 689     return qtest_in(s, "inl", addr);
 690 }
 691
 692 static void qtest_write(QTestState *s, const char *cmd, uint64_t addr,
 693                         uint64_t value)
 694 {
 695     qtest_sendf(s, "%s 0x%" PRIx64 " 0x%" PRIx64 "\n", cmd, addr, value);
 696     qtest_rsp(s, 0);
 697 }
 698
 699 void qtest_writeb(QTestState *s, uint64_t addr, uint8_t value)
 700 {
 701     qtest_write(s, "writeb", addr, value);
 702 }
 703
 704 void qtest_writew(QTestState *s, uint64_t addr, uint16_t value)
 705 {
 706     qtest_write(s, "writew", addr, value);
 707 }
 708
 709 void qtest_writel(QTestState *s, uint64_t addr, uint32_t value)
 710 {
 711     qtest_write(s, "writel", addr, value);
 712 }
 713
 714 void qtest_writeq(QTestState *s, uint64_t addr, uint64_t value)
 715 {
 716     qtest_write(s, "writeq", addr, value);
 717 }
 718
 719 static uint64_t qtest_read(QTestState *s, const char *cmd, uint64_t addr)
 720 {
 721     gchar **args;
 722     uint64_t value;
 723
 724     qtest_sendf(s, "%s 0x%" PRIx64 "\n", cmd, addr);
 725     args = qtest_rsp(s, 2);
 726     value = strtoull(args[1], NULL, 0);
 727     g_strfreev(args);
 728
 729     return value;
 730 }
 731
 732 uint8_t qtest_readb(QTestState *s, uint64_t addr)
 733 {
 734     return qtest_read(s, "readb", addr);
 735 }
 736
 737 uint16_t qtest_readw(QTestState *s, uint64_t addr)
 738 {
 739     return qtest_read(s, "readw", addr);
 740 }
 741
 742 uint32_t qtest_readl(QTestState *s, uint64_t addr)
 743 {
 744     return qtest_read(s, "readl", addr);
 745 }
 746
 747 uint64_t qtest_readq(QTestState *s, uint64_t addr)
 748 {
 749     return qtest_read(s, "readq", addr);
 750 }
 751
 752 static int hex2nib(char ch)
 753 {
 754     if (ch >= '0' && ch <= '9') {
 755         return ch - '0';
 756     } else if (ch >= 'a' && ch <= 'f') {
 757         return 10 + (ch - 'a');
 758     } else if (ch >= 'A' && ch <= 'F') {
 759         return 10 + (ch - 'a');
 760     } else {
 761         return -1;
 762     }
 763 }
 764
 765 void qtest_memread(QTestState *s, uint64_t addr, void *data, size_t size)
 766 {
 767     uint8_t *ptr = data;
 768     gchar **args;
 769     size_t i;
 770
 771     qtest_sendf(s, "read 0x%" PRIx64 " 0x%zx\n", addr, size);
 772     args = qtest_rsp(s, 2);
 773
 774     for (i = 0; i < size; i++) {
 775         ptr[i] = hex2nib(args[1][2 + (i * 2)]) << 4;
 776         ptr[i] |= hex2nib(args[1][2 + (i * 2) + 1]);
 777     }
 778
 779     g_strfreev(args);
 780 }
 781
 782 uint64_t qtest_rtas_call(QTestState *s, const char *name,
 783                          uint32_t nargs, uint64_t args,
 784                          uint32_t nret, uint64_t ret)
 785 {
 786     qtest_sendf(s, "rtas %s %u 0x%"PRIx64" %u 0x%"PRIx64"\n",
 787                 name, nargs, args, nret, ret);
 788     qtest_rsp(s, 0);
 789     return 0;
 790 }
 791
 792 void qtest_add_func(const char *str, void (*fn)(void))
 793 {
 794     gchar *path = g_strdup_printf("/%s/%s", qtest_get_arch(), str);
 795     g_test_add_func(path, fn);
 796     g_free(path);
 797 }
 798
 799 void qtest_add_data_func_full(const char *str, void *data,
 800                               void (*fn)(const void *),
 801                               GDestroyNotify data_free_func)
 802 {
 803     gchar *path = g_strdup_printf("/%s/%s", qtest_get_arch(), str);
 804 #if GLIB_CHECK_VERSION(2, 34, 0)
 805     g_test_add_data_func_full(path, data, fn, data_free_func);
 806 #elif GLIB_CHECK_VERSION(2, 26, 0)
 807     /* back-compat casts, remove this once we can require new-enough glib */
 808     g_test_add_vtable(path, 0, data, NULL,
 809                       (GTestFixtureFunc)fn, (GTestFixtureFunc) data_free_func);
 810 #else
 811     /* back-compat casts, remove this once we can require new-enough glib */
 812     g_test_add_vtable(path, 0, data, NULL,
 813                       (void (*)(void)) fn, (void (*)(void)) data_free_func);
 814 #endif
 815     g_free(path);
 816 }
 817
 818 void qtest_add_data_func(const char *str, const void *data,
 819                          void (*fn)(const void *))
 820 {
 821     gchar *path = g_strdup_printf("/%s/%s", qtest_get_arch(), str);
 822     g_test_add_data_func(path, data, fn);
 823     g_free(path);
 824 }
 825
 826 void qtest_bufwrite(QTestState *s, uint64_t addr, const void *data, size_t size)
 827 {
 828     gchar *bdata;
 829
 830     bdata = g_base64_encode(data, size);
 831     qtest_sendf(s, "b64write 0x%" PRIx64 " 0x%zx ", addr, size);
 832     socket_send(s->fd, bdata, strlen(bdata));
 833     socket_send(s->fd, "\n", 1);
 834     qtest_rsp(s, 0);
 835     g_free(bdata);
 836 }
 837
 838 void qtest_bufread(QTestState *s, uint64_t addr, void *data, size_t size)
 839 {
 840     gchar **args;
 841     size_t len;
 842
 843     qtest_sendf(s, "b64read 0x%" PRIx64 " 0x%zx\n", addr, size);
 844     args = qtest_rsp(s, 2);
 845
 846     g_base64_decode_inplace(args[1], &len);
 847     if (size != len) {
 848         fprintf(stderr, "bufread: asked for %zu bytes but decoded %zu\n",
 849                 size, len);
 850         len = MIN(len, size);
 851     }
 852
 853     memcpy(data, args[1], len);
 854     g_strfreev(args);
 855 }
 856
 857 void qtest_memwrite(QTestState *s, uint64_t addr, const void *data, size_t size)
 858 {
 859     const uint8_t *ptr = data;
 860     size_t i;
 861     char *enc = g_malloc(2 * size + 1);
 862
 863     for (i = 0; i < size; i++) {
 864         sprintf(&enc[i * 2], "%02x", ptr[i]);
 865     }
 866
 867     qtest_sendf(s, "write 0x%" PRIx64 " 0x%zx 0x%s\n", addr, size, enc);
 868     qtest_rsp(s, 0);
 869     g_free(enc);
 870 }
 871
 872 void qtest_memset(QTestState *s, uint64_t addr, uint8_t pattern, size_t size)
 873 {
 874     qtest_sendf(s, "memset 0x%" PRIx64 " 0x%zx 0x%02x\n", addr, size, pattern);
 875     qtest_rsp(s, 0);
 876 }
 877
 878 QDict *qmp(const char *fmt, ...)
 879 {
 880     va_list ap;
 881     QDict *response;
 882
 883     va_start(ap, fmt);
 884     response = qtest_qmpv(global_qtest, fmt, ap);
 885     va_end(ap);
 886     return response;
 887 }
 888
 889 void qmp_async(const char *fmt, ...)
 890 {
 891     va_list ap;
 892
 893     va_start(ap, fmt);
 894     qtest_async_qmpv(global_qtest, fmt, ap);
 895     va_end(ap);
 896 }
 897
 898 void qmp_discard_response(const char *fmt, ...)
 899 {
 900     va_list ap;
 901
 902     va_start(ap, fmt);
 903     qtest_qmpv_discard_response(global_qtest, fmt, ap);
 904     va_end(ap);
 905 }
 906 char *hmp(const char *fmt, ...)
 907 {
 908     va_list ap;
 909     char *ret;
 910
 911     va_start(ap, fmt);
 912     ret = qtest_hmpv(global_qtest, fmt, ap);
 913     va_end(ap);
 914     return ret;
 915 }
 916
 917 bool qtest_big_endian(QTestState *s)
 918 {
 919     return s->big_endian;
 920 }