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