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 "qemu/osdep.h"
  18
  19 #include <sys/socket.h>
  20 #include <sys/wait.h>
  21 #include <sys/un.h>
  22
  23 #include "libqtest.h"
  24 #include "qemu/cutils.h"
  25 #include "qapi/error.h"
  26 #include "qapi/qmp/json-parser.h"
  27 #include "qapi/qmp/json-streamer.h"
  28 #include "qapi/qmp/qdict.h"
  29 #include "qapi/qmp/qjson.h"
  30 #include "qapi/qmp/qlist.h"
  31 #include "qapi/qmp/qstring.h"
  32
  33 #define MAX_IRQ 256
  34 #define SOCKET_TIMEOUT 50
  35
  36 QTestState *global_qtest;
  37
  38 struct QTestState
  39 {
  40     int fd;
  41     int qmp_fd;
  42     bool irq_level[MAX_IRQ];
  43     GString *rx;
  44     pid_t qemu_pid;  /* our child QEMU process */
  45     bool big_endian;
  46 };
  47
  48 static GHookList abrt_hooks;
  49 static struct sigaction sigact_old;
  50
  51 #define g_assert_no_errno(ret) do { \
  52     g_assert_cmpint(ret, !=, -1); \
  53 } while (0)
  54
  55 static int qtest_query_target_endianness(QTestState *s);
  56
  57 static int init_socket(const char *socket_path)
  58 {
  59     struct sockaddr_un addr;
  60     int sock;
  61     int ret;
  62
  63     sock = socket(PF_UNIX, SOCK_STREAM, 0);
  64     g_assert_no_errno(sock);
  65
  66     addr.sun_family = AF_UNIX;
  67     snprintf(addr.sun_path, sizeof(addr.sun_path), "%s", socket_path);
  68     qemu_set_cloexec(sock);
  69
  70     do {
  71         ret = bind(sock, (struct sockaddr *)&addr, sizeof(addr));
  72     } while (ret == -1 && errno == EINTR);
  73     g_assert_no_errno(ret);
  74     ret = listen(sock, 1);
  75     g_assert_no_errno(ret);
  76
  77     return sock;
  78 }
  79
  80 static int socket_accept(int sock)
  81 {
  82     struct sockaddr_un addr;
  83     socklen_t addrlen;
  84     int ret;
  85     struct timeval timeout = { .tv_sec = SOCKET_TIMEOUT,
  86                                .tv_usec = 0 };
  87
  88     setsockopt(sock, SOL_SOCKET, SO_RCVTIMEO, (void *)&timeout,
  89                sizeof(timeout));
  90
  91     do {
  92         addrlen = sizeof(addr);
  93         ret = accept(sock, (struct sockaddr *)&addr, &addrlen);
  94     } while (ret == -1 && errno == EINTR);
  95     if (ret == -1) {
  96         fprintf(stderr, "%s failed: %s\n", __func__, strerror(errno));
  97     }
  98     close(sock);
  99
 100     return ret;
 101 }
 102
 103 static void kill_qemu(QTestState *s)
 104 {
 105     if (s->qemu_pid != -1) {
 106         kill(s->qemu_pid, SIGTERM);
 107         waitpid(s->qemu_pid, NULL, 0);
 108     }
 109 }
 110
 111 static void kill_qemu_hook_func(void *s)
 112 {
 113     kill_qemu(s);
 114 }
 115
 116 static void sigabrt_handler(int signo)
 117 {
 118     g_hook_list_invoke(&abrt_hooks, FALSE);
 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 void qtest_add_abrt_handler(GHookFunc fn, const void *data)
 140 {
 141     GHook *hook;
 142
 143     /* Only install SIGABRT handler once */
 144     if (!abrt_hooks.is_setup) {
 145         g_hook_list_init(&abrt_hooks, sizeof(GHook));
 146     }
 147     setup_sigabrt_handler();
 148
 149     hook = g_hook_alloc(&abrt_hooks);
 150     hook->func = fn;
 151     hook->data = (void *)data;
 152
 153     g_hook_prepend(&abrt_hooks, hook);
 154 }
 155
 156 static const char *qtest_qemu_binary(void)
 157 {
 158     const char *qemu_bin;
 159
 160     qemu_bin = getenv("QTEST_QEMU_BINARY");
 161     if (!qemu_bin) {
 162         fprintf(stderr, "Environment variable QTEST_QEMU_BINARY required\n");
 163         exit(1);
 164     }
 165
 166     return qemu_bin;
 167 }
 168
 169 QTestState *qtest_init_without_qmp_handshake(const char *extra_args)
 170 {
 171     QTestState *s;
 172     int sock, qmpsock, i;
 173     gchar *socket_path;
 174     gchar *qmp_socket_path;
 175     gchar *command;
 176     const char *qemu_binary = qtest_qemu_binary();
 177
 178     s = g_new(QTestState, 1);
 179
 180     socket_path = g_strdup_printf("/tmp/qtest-%d.sock", getpid());
 181     qmp_socket_path = g_strdup_printf("/tmp/qtest-%d.qmp", getpid());
 182
 183     /* It's possible that if an earlier test run crashed it might
 184      * have left a stale unix socket lying around. Delete any
 185      * stale old socket to avoid spurious test failures with
 186      * tests/libqtest.c:70:init_socket: assertion failed (ret != -1): (-1 != -1)
 187      */
 188     unlink(socket_path);
 189     unlink(qmp_socket_path);
 190
 191     sock = init_socket(socket_path);
 192     qmpsock = init_socket(qmp_socket_path);
 193
 194     qtest_add_abrt_handler(kill_qemu_hook_func, s);
 195
 196     s->qemu_pid = fork();
 197     if (s->qemu_pid == 0) {
 198         setenv("QEMU_AUDIO_DRV", "none", true);
 199         command = g_strdup_printf("exec %s "
 200                                   "-qtest unix:%s,nowait "
 201                                   "-qtest-log %s "
 202                                   "-qmp unix:%s,nowait "
 203                                   "-machine accel=qtest "
 204                                   "-display none "
 205                                   "%s", qemu_binary, socket_path,
 206                                   getenv("QTEST_LOG") ? "/dev/fd/2" : "/dev/null",
 207                                   qmp_socket_path,
 208                                   extra_args ?: "");
 209         execlp("/bin/sh", "sh", "-c", command, NULL);
 210         exit(1);
 211     }
 212
 213     s->fd = socket_accept(sock);
 214     if (s->fd >= 0) {
 215         s->qmp_fd = socket_accept(qmpsock);
 216     }
 217     unlink(socket_path);
 218     unlink(qmp_socket_path);
 219     g_free(socket_path);
 220     g_free(qmp_socket_path);
 221
 222     g_assert(s->fd >= 0 && s->qmp_fd >= 0);
 223
 224     s->rx = g_string_new("");
 225     for (i = 0; i < MAX_IRQ; i++) {
 226         s->irq_level[i] = false;
 227     }
 228
 229     if (getenv("QTEST_STOP")) {
 230         kill(s->qemu_pid, SIGSTOP);
 231     }
 232
 233     /* ask endianness of the target */
 234
 235     s->big_endian = qtest_query_target_endianness(s);
 236
 237     return s;
 238 }
 239
 240 QTestState *qtest_init(const char *extra_args)
 241 {
 242     QTestState *s = qtest_init_without_qmp_handshake(extra_args);
 243
 244     /* Read the QMP greeting and then do the handshake */
 245     qtest_qmp_discard_response(s, "");
 246     qtest_qmp_discard_response(s, "{ 'execute': 'qmp_capabilities' }");
 247
 248     return s;
 249 }
 250
 251 QTestState *qtest_vstartf(const char *fmt, va_list ap)
 252 {
 253     char *args = g_strdup_vprintf(fmt, ap);
 254     QTestState *s;
 255
 256     s = qtest_start(args);
 257     g_free(args);
 258     global_qtest = NULL;
 259     return s;
 260 }
 261
 262 QTestState *qtest_startf(const char *fmt, ...)
 263 {
 264     va_list ap;
 265     QTestState *s;
 266
 267     va_start(ap, fmt);
 268     s = qtest_vstartf(fmt, ap);
 269     va_end(ap);
 270     return s;
 271 }
 272
 273 void qtest_quit(QTestState *s)
 274 {
 275     g_hook_destroy_link(&abrt_hooks, g_hook_find_data(&abrt_hooks, TRUE, s));
 276
 277     /* Uninstall SIGABRT handler on last instance */
 278     cleanup_sigabrt_handler();
 279
 280     kill_qemu(s);
 281     close(s->fd);
 282     close(s->qmp_fd);
 283     g_string_free(s->rx, true);
 284     g_free(s);
 285 }
 286
 287 static void socket_send(int fd, const char *buf, size_t size)
 288 {
 289     size_t offset;
 290
 291     offset = 0;
 292     while (offset < size) {
 293         ssize_t len;
 294
 295         len = write(fd, buf + offset, size - offset);
 296         if (len == -1 && errno == EINTR) {
 297             continue;
 298         }
 299
 300         g_assert_no_errno(len);
 301         g_assert_cmpint(len, >, 0);
 302
 303         offset += len;
 304     }
 305 }
 306
 307 static void socket_sendf(int fd, const char *fmt, va_list ap)
 308 {
 309     gchar *str = g_strdup_vprintf(fmt, ap);
 310     size_t size = strlen(str);
 311
 312     socket_send(fd, str, size);
 313     g_free(str);
 314 }
 315
 316 static void GCC_FMT_ATTR(2, 3) qtest_sendf(QTestState *s, const char *fmt, ...)
 317 {
 318     va_list ap;
 319
 320     va_start(ap, fmt);
 321     socket_sendf(s->fd, fmt, ap);
 322     va_end(ap);
 323 }
 324
 325 static GString *qtest_recv_line(QTestState *s)
 326 {
 327     GString *line;
 328     size_t offset;
 329     char *eol;
 330
 331     while ((eol = strchr(s->rx->str, '\n')) == NULL) {
 332         ssize_t len;
 333         char buffer[1024];
 334
 335         len = read(s->fd, buffer, sizeof(buffer));
 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         g_string_append_len(s->rx, buffer, len);
 346     }
 347
 348     offset = eol - s->rx->str;
 349     line = g_string_new_len(s->rx->str, offset);
 350     g_string_erase(s->rx, 0, offset + 1);
 351
 352     return line;
 353 }
 354
 355 static gchar **qtest_rsp(QTestState *s, int expected_args)
 356 {
 357     GString *line;
 358     gchar **words;
 359     int i;
 360
 361 redo:
 362     line = qtest_recv_line(s);
 363     words = g_strsplit(line->str, " ", 0);
 364     g_string_free(line, TRUE);
 365
 366     if (strcmp(words[0], "IRQ") == 0) {
 367         long irq;
 368         int ret;
 369
 370         g_assert(words[1] != NULL);
 371         g_assert(words[2] != NULL);
 372
 373         ret = qemu_strtol(words[2], NULL, 0, &irq);
 374         g_assert(!ret);
 375         g_assert_cmpint(irq, >=, 0);
 376         g_assert_cmpint(irq, <, MAX_IRQ);
 377
 378         if (strcmp(words[1], "raise") == 0) {
 379             s->irq_level[irq] = true;
 380         } else {
 381             s->irq_level[irq] = false;
 382         }
 383
 384         g_strfreev(words);
 385         goto redo;
 386     }
 387
 388     g_assert(words[0] != NULL);
 389     g_assert_cmpstr(words[0], ==, "OK");
 390
 391     if (expected_args) {
 392         for (i = 0; i < expected_args; i++) {
 393             g_assert(words[i] != NULL);
 394         }
 395     } else {
 396         g_strfreev(words);
 397     }
 398
 399     return words;
 400 }
 401
 402 static int qtest_query_target_endianness(QTestState *s)
 403 {
 404     gchar **args;
 405     int big_endian;
 406
 407     qtest_sendf(s, "endianness\n");
 408     args = qtest_rsp(s, 1);
 409     g_assert(strcmp(args[1], "big") == 0 || strcmp(args[1], "little") == 0);
 410     big_endian = strcmp(args[1], "big") == 0;
 411     g_strfreev(args);
 412
 413     return big_endian;
 414 }
 415
 416 typedef struct {
 417     JSONMessageParser parser;
 418     QDict *response;
 419 } QMPResponseParser;
 420
 421 static void qmp_response(JSONMessageParser *parser, GQueue *tokens)
 422 {
 423     QMPResponseParser *qmp = container_of(parser, QMPResponseParser, parser);
 424     QObject *obj;
 425
 426     obj = json_parser_parse(tokens, NULL);
 427     if (!obj) {
 428         fprintf(stderr, "QMP JSON response parsing failed\n");
 429         exit(1);
 430     }
 431
 432     g_assert(!qmp->response);
 433     qmp->response = qobject_to_qdict(obj);
 434     g_assert(qmp->response);
 435 }
 436
 437 QDict *qmp_fd_receive(int fd)
 438 {
 439     QMPResponseParser qmp;
 440     bool log = getenv("QTEST_LOG") != NULL;
 441
 442     qmp.response = NULL;
 443     json_message_parser_init(&qmp.parser, qmp_response);
 444     while (!qmp.response) {
 445         ssize_t len;
 446         char c;
 447
 448         len = read(fd, &c, 1);
 449         if (len == -1 && errno == EINTR) {
 450             continue;
 451         }
 452
 453         if (len == -1 || len == 0) {
 454             fprintf(stderr, "Broken pipe\n");
 455             exit(1);
 456         }
 457
 458         if (log) {
 459             len = write(2, &c, 1);
 460         }
 461         json_message_parser_feed(&qmp.parser, &c, 1);
 462     }
 463     json_message_parser_destroy(&qmp.parser);
 464
 465     return qmp.response;
 466 }
 467
 468 QDict *qtest_qmp_receive(QTestState *s)
 469 {
 470     return qmp_fd_receive(s->qmp_fd);
 471 }
 472
 473 /**
 474  * Allow users to send a message without waiting for the reply,
 475  * in the case that they choose to discard all replies up until
 476  * a particular EVENT is received.
 477  */
 478 void qmp_fd_sendv(int fd, const char *fmt, va_list ap)
 479 {
 480     va_list ap_copy;
 481     QObject *qobj;
 482
 483     /* qobject_from_jsonv() silently eats leading 0xff as invalid
 484      * JSON, but we want to test sending them over the wire to force
 485      * resyncs */
 486     if (*fmt == '\377') {
 487         socket_send(fd, fmt, 1);
 488         fmt++;
 489     }
 490
 491     /* Going through qobject ensures we escape strings properly.
 492      * This seemingly unnecessary copy is required in case va_list
 493      * is an array type.
 494      */
 495     va_copy(ap_copy, ap);
 496     qobj = qobject_from_jsonv(fmt, &ap_copy, &error_abort);
 497     va_end(ap_copy);
 498
 499     /* No need to send anything for an empty QObject.  */
 500     if (qobj) {
 501         int log = getenv("QTEST_LOG") != NULL;
 502         QString *qstr = qobject_to_json(qobj);
 503         const char *str;
 504
 505         /*
 506          * BUG: QMP doesn't react to input until it sees a newline, an
 507          * object, or an array.  Work-around: give it a newline.
 508          */
 509         qstring_append_chr(qstr, '\n');
 510         str = qstring_get_str(qstr);
 511
 512         if (log) {
 513             fprintf(stderr, "%s", str);
 514         }
 515         /* Send QMP request */
 516         socket_send(fd, str, qstring_get_length(qstr));
 517
 518         QDECREF(qstr);
 519         qobject_decref(qobj);
 520     }
 521 }
 522
 523 void qtest_async_qmpv(QTestState *s, const char *fmt, va_list ap)
 524 {
 525     qmp_fd_sendv(s->qmp_fd, fmt, ap);
 526 }
 527
 528 QDict *qmp_fdv(int fd, const char *fmt, va_list ap)
 529 {
 530     qmp_fd_sendv(fd, fmt, ap);
 531
 532     return qmp_fd_receive(fd);
 533 }
 534
 535 QDict *qtest_qmpv(QTestState *s, const char *fmt, va_list ap)
 536 {
 537     qtest_async_qmpv(s, fmt, ap);
 538
 539     /* Receive reply */
 540     return qtest_qmp_receive(s);
 541 }
 542
 543 QDict *qmp_fd(int fd, const char *fmt, ...)
 544 {
 545     va_list ap;
 546     QDict *response;
 547
 548     va_start(ap, fmt);
 549     response = qmp_fdv(fd, fmt, ap);
 550     va_end(ap);
 551     return response;
 552 }
 553
 554 void qmp_fd_send(int fd, const char *fmt, ...)
 555 {
 556     va_list ap;
 557
 558     va_start(ap, fmt);
 559     qmp_fd_sendv(fd, fmt, ap);
 560     va_end(ap);
 561 }
 562
 563 QDict *qtest_qmp(QTestState *s, const char *fmt, ...)
 564 {
 565     va_list ap;
 566     QDict *response;
 567
 568     va_start(ap, fmt);
 569     response = qtest_qmpv(s, fmt, ap);
 570     va_end(ap);
 571     return response;
 572 }
 573
 574 void qtest_async_qmp(QTestState *s, const char *fmt, ...)
 575 {
 576     va_list ap;
 577
 578     va_start(ap, fmt);
 579     qtest_async_qmpv(s, fmt, ap);
 580     va_end(ap);
 581 }
 582
 583 void qtest_qmpv_discard_response(QTestState *s, const char *fmt, va_list ap)
 584 {
 585     QDict *response = qtest_qmpv(s, fmt, ap);
 586     QDECREF(response);
 587 }
 588
 589 void qtest_qmp_discard_response(QTestState *s, const char *fmt, ...)
 590 {
 591     va_list ap;
 592     QDict *response;
 593
 594     va_start(ap, fmt);
 595     response = qtest_qmpv(s, fmt, ap);
 596     va_end(ap);
 597     QDECREF(response);
 598 }
 599
 600 QDict *qtest_qmp_eventwait_ref(QTestState *s, const char *event)
 601 {
 602     QDict *response;
 603
 604     for (;;) {
 605         response = qtest_qmp_receive(s);
 606         if ((qdict_haskey(response, "event")) &&
 607             (strcmp(qdict_get_str(response, "event"), event) == 0)) {
 608             return response;
 609         }
 610         QDECREF(response);
 611     }
 612 }
 613
 614 void qtest_qmp_eventwait(QTestState *s, const char *event)
 615 {
 616     QDict *response;
 617
 618     response = qtest_qmp_eventwait_ref(s, event);
 619     QDECREF(response);
 620 }
 621
 622 char *qtest_hmpv(QTestState *s, const char *fmt, va_list ap)
 623 {
 624     char *cmd;
 625     QDict *resp;
 626     char *ret;
 627
 628     cmd = g_strdup_vprintf(fmt, ap);
 629     resp = qtest_qmp(s, "{'execute': 'human-monitor-command',"
 630                      " 'arguments': {'command-line': %s}}",
 631                      cmd);
 632     ret = g_strdup(qdict_get_try_str(resp, "return"));
 633     while (ret == NULL && qdict_get_try_str(resp, "event")) {
 634         /* Ignore asynchronous QMP events */
 635         QDECREF(resp);
 636         resp = qtest_qmp_receive(s);
 637         ret = g_strdup(qdict_get_try_str(resp, "return"));
 638     }
 639     g_assert(ret);
 640     QDECREF(resp);
 641     g_free(cmd);
 642     return ret;
 643 }
 644
 645 char *qtest_hmp(QTestState *s, const char *fmt, ...)
 646 {
 647     va_list ap;
 648     char *ret;
 649
 650     va_start(ap, fmt);
 651     ret = qtest_hmpv(s, fmt, ap);
 652     va_end(ap);
 653     return ret;
 654 }
 655
 656 const char *qtest_get_arch(void)
 657 {
 658     const char *qemu = qtest_qemu_binary();
 659     const char *end = strrchr(qemu, '/');
 660
 661     return end + strlen("/qemu-system-");
 662 }
 663
 664 bool qtest_get_irq(QTestState *s, int num)
 665 {
 666     /* dummy operation in order to make sure irq is up to date */
 667     qtest_inb(s, 0);
 668
 669     return s->irq_level[num];
 670 }
 671
 672 static int64_t qtest_clock_rsp(QTestState *s)
 673 {
 674     gchar **words;
 675     int64_t clock;
 676     words = qtest_rsp(s, 2);
 677     clock = g_ascii_strtoll(words[1], NULL, 0);
 678     g_strfreev(words);
 679     return clock;
 680 }
 681
 682 int64_t qtest_clock_step_next(QTestState *s)
 683 {
 684     qtest_sendf(s, "clock_step\n");
 685     return qtest_clock_rsp(s);
 686 }
 687
 688 int64_t qtest_clock_step(QTestState *s, int64_t step)
 689 {
 690     qtest_sendf(s, "clock_step %"PRIi64"\n", step);
 691     return qtest_clock_rsp(s);
 692 }
 693
 694 int64_t qtest_clock_set(QTestState *s, int64_t val)
 695 {
 696     qtest_sendf(s, "clock_set %"PRIi64"\n", val);
 697     return qtest_clock_rsp(s);
 698 }
 699
 700 void qtest_irq_intercept_out(QTestState *s, const char *qom_path)
 701 {
 702     qtest_sendf(s, "irq_intercept_out %s\n", qom_path);
 703     qtest_rsp(s, 0);
 704 }
 705
 706 void qtest_irq_intercept_in(QTestState *s, const char *qom_path)
 707 {
 708     qtest_sendf(s, "irq_intercept_in %s\n", qom_path);
 709     qtest_rsp(s, 0);
 710 }
 711
 712 static void qtest_out(QTestState *s, const char *cmd, uint16_t addr, uint32_t value)
 713 {
 714     qtest_sendf(s, "%s 0x%x 0x%x\n", cmd, addr, value);
 715     qtest_rsp(s, 0);
 716 }
 717
 718 void qtest_outb(QTestState *s, uint16_t addr, uint8_t value)
 719 {
 720     qtest_out(s, "outb", addr, value);
 721 }
 722
 723 void qtest_outw(QTestState *s, uint16_t addr, uint16_t value)
 724 {
 725     qtest_out(s, "outw", addr, value);
 726 }
 727
 728 void qtest_outl(QTestState *s, uint16_t addr, uint32_t value)
 729 {
 730     qtest_out(s, "outl", addr, value);
 731 }
 732
 733 static uint32_t qtest_in(QTestState *s, const char *cmd, uint16_t addr)
 734 {
 735     gchar **args;
 736     int ret;
 737     unsigned long value;
 738
 739     qtest_sendf(s, "%s 0x%x\n", cmd, addr);
 740     args = qtest_rsp(s, 2);
 741     ret = qemu_strtoul(args[1], NULL, 0, &value);
 742     g_assert(!ret && value <= UINT32_MAX);
 743     g_strfreev(args);
 744
 745     return value;
 746 }
 747
 748 uint8_t qtest_inb(QTestState *s, uint16_t addr)
 749 {
 750     return qtest_in(s, "inb", addr);
 751 }
 752
 753 uint16_t qtest_inw(QTestState *s, uint16_t addr)
 754 {
 755     return qtest_in(s, "inw", addr);
 756 }
 757
 758 uint32_t qtest_inl(QTestState *s, uint16_t addr)
 759 {
 760     return qtest_in(s, "inl", addr);
 761 }
 762
 763 static void qtest_write(QTestState *s, const char *cmd, uint64_t addr,
 764                         uint64_t value)
 765 {
 766     qtest_sendf(s, "%s 0x%" PRIx64 " 0x%" PRIx64 "\n", cmd, addr, value);
 767     qtest_rsp(s, 0);
 768 }
 769
 770 void qtest_writeb(QTestState *s, uint64_t addr, uint8_t value)
 771 {
 772     qtest_write(s, "writeb", addr, value);
 773 }
 774
 775 void qtest_writew(QTestState *s, uint64_t addr, uint16_t value)
 776 {
 777     qtest_write(s, "writew", addr, value);
 778 }
 779
 780 void qtest_writel(QTestState *s, uint64_t addr, uint32_t value)
 781 {
 782     qtest_write(s, "writel", addr, value);
 783 }
 784
 785 void qtest_writeq(QTestState *s, uint64_t addr, uint64_t value)
 786 {
 787     qtest_write(s, "writeq", addr, value);
 788 }
 789
 790 static uint64_t qtest_read(QTestState *s, const char *cmd, uint64_t addr)
 791 {
 792     gchar **args;
 793     int ret;
 794     uint64_t value;
 795
 796     qtest_sendf(s, "%s 0x%" PRIx64 "\n", cmd, addr);
 797     args = qtest_rsp(s, 2);
 798     ret = qemu_strtou64(args[1], NULL, 0, &value);
 799     g_assert(!ret);
 800     g_strfreev(args);
 801
 802     return value;
 803 }
 804
 805 uint8_t qtest_readb(QTestState *s, uint64_t addr)
 806 {
 807     return qtest_read(s, "readb", addr);
 808 }
 809
 810 uint16_t qtest_readw(QTestState *s, uint64_t addr)
 811 {
 812     return qtest_read(s, "readw", addr);
 813 }
 814
 815 uint32_t qtest_readl(QTestState *s, uint64_t addr)
 816 {
 817     return qtest_read(s, "readl", addr);
 818 }
 819
 820 uint64_t qtest_readq(QTestState *s, uint64_t addr)
 821 {
 822     return qtest_read(s, "readq", addr);
 823 }
 824
 825 static int hex2nib(char ch)
 826 {
 827     if (ch >= '0' && ch <= '9') {
 828         return ch - '0';
 829     } else if (ch >= 'a' && ch <= 'f') {
 830         return 10 + (ch - 'a');
 831     } else if (ch >= 'A' && ch <= 'F') {
 832         return 10 + (ch - 'a');
 833     } else {
 834         return -1;
 835     }
 836 }
 837
 838 void qtest_memread(QTestState *s, uint64_t addr, void *data, size_t size)
 839 {
 840     uint8_t *ptr = data;
 841     gchar **args;
 842     size_t i;
 843
 844     if (!size) {
 845         return;
 846     }
 847
 848     qtest_sendf(s, "read 0x%" PRIx64 " 0x%zx\n", addr, size);
 849     args = qtest_rsp(s, 2);
 850
 851     for (i = 0; i < size; i++) {
 852         ptr[i] = hex2nib(args[1][2 + (i * 2)]) << 4;
 853         ptr[i] |= hex2nib(args[1][2 + (i * 2) + 1]);
 854     }
 855
 856     g_strfreev(args);
 857 }
 858
 859 uint64_t qtest_rtas_call(QTestState *s, const char *name,
 860                          uint32_t nargs, uint64_t args,
 861                          uint32_t nret, uint64_t ret)
 862 {
 863     qtest_sendf(s, "rtas %s %u 0x%"PRIx64" %u 0x%"PRIx64"\n",
 864                 name, nargs, args, nret, ret);
 865     qtest_rsp(s, 0);
 866     return 0;
 867 }
 868
 869 void qtest_add_func(const char *str, void (*fn)(void))
 870 {
 871     gchar *path = g_strdup_printf("/%s/%s", qtest_get_arch(), str);
 872     g_test_add_func(path, fn);
 873     g_free(path);
 874 }
 875
 876 void qtest_add_data_func_full(const char *str, void *data,
 877                               void (*fn)(const void *),
 878                               GDestroyNotify data_free_func)
 879 {
 880     gchar *path = g_strdup_printf("/%s/%s", qtest_get_arch(), str);
 881     g_test_add_data_func_full(path, data, fn, data_free_func);
 882     g_free(path);
 883 }
 884
 885 void qtest_add_data_func(const char *str, const void *data,
 886                          void (*fn)(const void *))
 887 {
 888     gchar *path = g_strdup_printf("/%s/%s", qtest_get_arch(), str);
 889     g_test_add_data_func(path, data, fn);
 890     g_free(path);
 891 }
 892
 893 void qtest_bufwrite(QTestState *s, uint64_t addr, const void *data, size_t size)
 894 {
 895     gchar *bdata;
 896
 897     bdata = g_base64_encode(data, size);
 898     qtest_sendf(s, "b64write 0x%" PRIx64 " 0x%zx ", addr, size);
 899     socket_send(s->fd, bdata, strlen(bdata));
 900     socket_send(s->fd, "\n", 1);
 901     qtest_rsp(s, 0);
 902     g_free(bdata);
 903 }
 904
 905 void qtest_bufread(QTestState *s, uint64_t addr, void *data, size_t size)
 906 {
 907     gchar **args;
 908     size_t len;
 909
 910     qtest_sendf(s, "b64read 0x%" PRIx64 " 0x%zx\n", addr, size);
 911     args = qtest_rsp(s, 2);
 912
 913     g_base64_decode_inplace(args[1], &len);
 914     if (size != len) {
 915         fprintf(stderr, "bufread: asked for %zu bytes but decoded %zu\n",
 916                 size, len);
 917         len = MIN(len, size);
 918     }
 919
 920     memcpy(data, args[1], len);
 921     g_strfreev(args);
 922 }
 923
 924 void qtest_memwrite(QTestState *s, uint64_t addr, const void *data, size_t size)
 925 {
 926     const uint8_t *ptr = data;
 927     size_t i;
 928     char *enc;
 929
 930     if (!size) {
 931         return;
 932     }
 933
 934     enc = g_malloc(2 * size + 1);
 935
 936     for (i = 0; i < size; i++) {
 937         sprintf(&enc[i * 2], "%02x", ptr[i]);
 938     }
 939
 940     qtest_sendf(s, "write 0x%" PRIx64 " 0x%zx 0x%s\n", addr, size, enc);
 941     qtest_rsp(s, 0);
 942     g_free(enc);
 943 }
 944
 945 void qtest_memset(QTestState *s, uint64_t addr, uint8_t pattern, size_t size)
 946 {
 947     qtest_sendf(s, "memset 0x%" PRIx64 " 0x%zx 0x%02x\n", addr, size, pattern);
 948     qtest_rsp(s, 0);
 949 }
 950
 951 QDict *qmp(const char *fmt, ...)
 952 {
 953     va_list ap;
 954     QDict *response;
 955
 956     va_start(ap, fmt);
 957     response = qtest_qmpv(global_qtest, fmt, ap);
 958     va_end(ap);
 959     return response;
 960 }
 961
 962 void qmp_async(const char *fmt, ...)
 963 {
 964     va_list ap;
 965
 966     va_start(ap, fmt);
 967     qtest_async_qmpv(global_qtest, fmt, ap);
 968     va_end(ap);
 969 }
 970
 971 void qmp_discard_response(const char *fmt, ...)
 972 {
 973     va_list ap;
 974
 975     va_start(ap, fmt);
 976     qtest_qmpv_discard_response(global_qtest, fmt, ap);
 977     va_end(ap);
 978 }
 979 char *hmp(const char *fmt, ...)
 980 {
 981     va_list ap;
 982     char *ret;
 983
 984     va_start(ap, fmt);
 985     ret = qtest_hmpv(global_qtest, fmt, ap);
 986     va_end(ap);
 987     return ret;
 988 }
 989
 990 bool qtest_big_endian(QTestState *s)
 991 {
 992     return s->big_endian;
 993 }
 994
 995 void qtest_cb_for_every_machine(void (*cb)(const char *machine))
 996 {
 997     QDict *response, *minfo;
 998     QList *list;
 999     const QListEntry *p;
1000     QObject *qobj;
1001     QString *qstr;
1002     const char *mname;
1003
1004     qtest_start("-machine none");
1005     response = qmp("{ 'execute': 'query-machines' }");
1006     g_assert(response);
1007     list = qdict_get_qlist(response, "return");
1008     g_assert(list);
1009
1010     for (p = qlist_first(list); p; p = qlist_next(p)) {
1011         minfo = qobject_to_qdict(qlist_entry_obj(p));
1012         g_assert(minfo);
1013         qobj = qdict_get(minfo, "name");
1014         g_assert(qobj);
1015         qstr = qobject_to_qstring(qobj);
1016         g_assert(qstr);
1017         mname = qstring_get_str(qstr);
1018         cb(mname);
1019     }
1020
1021     qtest_end();
1022     QDECREF(response);
1023 }
1024
1025 /*
1026  * Generic hot-plugging test via the device_add QMP command.
1027  */
1028 void qtest_qmp_device_add(const char *driver, const char *id, const char *fmt,
1029                           ...)
1030 {
1031     QDict *response;
1032     char *cmd, *opts = NULL;
1033     va_list va;
1034
1035     if (fmt) {
1036         va_start(va, fmt);
1037         opts = g_strdup_vprintf(fmt, va);
1038         va_end(va);
1039     }
1040
1041     cmd = g_strdup_printf("{'execute': 'device_add',"
1042                           " 'arguments': { 'driver': '%s', 'id': '%s'%s%s }}",
1043                           driver, id, opts ? ", " : "", opts ? opts : "");
1044     g_free(opts);
1045
1046     response = qmp(cmd);
1047     g_free(cmd);
1048     g_assert(response);
1049     g_assert(!qdict_haskey(response, "event")); /* We don't expect any events */
1050     g_assert(!qdict_haskey(response, "error"));
1051     QDECREF(response);
1052 }
1053
1054 /*
1055  * Generic hot-unplugging test via the device_del QMP command.
1056  * Device deletion will get one response and one event. For example:
1057  *
1058  * {'execute': 'device_del','arguments': { 'id': 'scsi-hd'}}
1059  *
1060  * will get this one:
1061  *
1062  * {"timestamp": {"seconds": 1505289667, "microseconds": 569862},
1063  *  "event": "DEVICE_DELETED", "data": {"device": "scsi-hd",
1064  *  "path": "/machine/peripheral/scsi-hd"}}
1065  *
1066  * and this one:
1067  *
1068  * {"return": {}}
1069  *
1070  * But the order of arrival may vary - so we've got to detect both.
1071  */
1072 void qtest_qmp_device_del(const char *id)
1073 {
1074     QDict *response1, *response2, *event = NULL;
1075     char *cmd;
1076
1077     cmd = g_strdup_printf("{'execute': 'device_del',"
1078                           " 'arguments': { 'id': '%s' }}", id);
1079     response1 = qmp(cmd);
1080     g_free(cmd);
1081     g_assert(response1);
1082     g_assert(!qdict_haskey(response1, "error"));
1083
1084     response2 = qmp("");
1085     g_assert(response2);
1086     g_assert(!qdict_haskey(response2, "error"));
1087
1088     if (qdict_haskey(response1, "event")) {
1089         event = response1;
1090     } else if (qdict_haskey(response2, "event")) {
1091         event = response2;
1092     }
1093     g_assert(event);
1094     g_assert_cmpstr(qdict_get_str(event, "event"), ==, "DEVICE_DELETED");
1095
1096     QDECREF(response1);
1097     QDECREF(response2);
1098 }