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-common.h"
  25 #include "qemu/ctype.h"
  26 #include "qemu/cutils.h"
  27 #include "qapi/error.h"
  28 #include "qapi/qmp/json-parser.h"
  29 #include "qapi/qmp/qdict.h"
  30 #include "qapi/qmp/qjson.h"
  31 #include "qapi/qmp/qlist.h"
  32 #include "qapi/qmp/qstring.h"
  33
  34 #define MAX_IRQ 256
  35 #define SOCKET_TIMEOUT 50
  36 #define SOCKET_MAX_FDS 16
  37
  38 struct QTestState
  39 {
  40     int fd;
  41     int qmp_fd;
  42     pid_t qemu_pid;  /* our child QEMU process */
  43     int wstatus;
  44     bool big_endian;
  45     bool irq_level[MAX_IRQ];
  46     GString *rx;
  47 };
  48
  49 static GHookList abrt_hooks;
  50 static struct sigaction sigact_old;
  51
  52 static int qtest_query_target_endianness(QTestState *s);
  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_cmpint(sock, !=, -1);
  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_cmpint(ret, !=, -1);
  71     ret = listen(sock, 1);
  72     g_assert_cmpint(ret, !=, -1);
  73
  74     return sock;
  75 }
  76
  77 static int socket_accept(int sock)
  78 {
  79     struct sockaddr_un addr;
  80     socklen_t addrlen;
  81     int ret;
  82     struct timeval timeout = { .tv_sec = SOCKET_TIMEOUT,
  83                                .tv_usec = 0 };
  84
  85     setsockopt(sock, SOL_SOCKET, SO_RCVTIMEO, (void *)&timeout,
  86                sizeof(timeout));
  87
  88     do {
  89         addrlen = sizeof(addr);
  90         ret = accept(sock, (struct sockaddr *)&addr, &addrlen);
  91     } while (ret == -1 && errno == EINTR);
  92     if (ret == -1) {
  93         fprintf(stderr, "%s failed: %s\n", __func__, strerror(errno));
  94     }
  95     close(sock);
  96
  97     return ret;
  98 }
  99
 100 bool qtest_probe_child(QTestState *s)
 101 {
 102     pid_t pid = s->qemu_pid;
 103
 104     if (pid != -1) {
 105         pid = waitpid(pid, &s->wstatus, WNOHANG);
 106         if (pid == 0) {
 107             return true;
 108         }
 109         s->qemu_pid = -1;
 110     }
 111     return false;
 112 }
 113
 114 static void kill_qemu(QTestState *s)
 115 {
 116     pid_t pid = s->qemu_pid;
 117     int wstatus;
 118
 119     /* Skip wait if qtest_probe_child already reaped.  */
 120     if (pid != -1) {
 121         kill(pid, SIGTERM);
 122         TFR(pid = waitpid(s->qemu_pid, &s->wstatus, 0));
 123         assert(pid == s->qemu_pid);
 124     }
 125
 126     /*
 127      * We expect qemu to exit with status 0; anything else is
 128      * fishy and should be logged with as much detail as possible.
 129      */
 130     wstatus = s->wstatus;
 131     if (wstatus) {
 132         if (WIFEXITED(wstatus)) {
 133             fprintf(stderr, "%s:%d: kill_qemu() tried to terminate QEMU "
 134                     "process but encountered exit status %d\n",
 135                     __FILE__, __LINE__, WEXITSTATUS(wstatus));
 136         } else if (WIFSIGNALED(wstatus)) {
 137             int sig = WTERMSIG(wstatus);
 138             const char *signame = strsignal(sig) ?: "unknown ???";
 139             const char *dump = WCOREDUMP(wstatus) ? " (core dumped)" : "";
 140
 141             fprintf(stderr, "%s:%d: kill_qemu() detected QEMU death "
 142                     "from signal %d (%s)%s\n",
 143                     __FILE__, __LINE__, sig, signame, dump);
 144         }
 145         abort();
 146     }
 147 }
 148
 149 static void kill_qemu_hook_func(void *s)
 150 {
 151     kill_qemu(s);
 152 }
 153
 154 static void sigabrt_handler(int signo)
 155 {
 156     g_hook_list_invoke(&abrt_hooks, FALSE);
 157 }
 158
 159 static void setup_sigabrt_handler(void)
 160 {
 161     struct sigaction sigact;
 162
 163     /* Catch SIGABRT to clean up on g_assert() failure */
 164     sigact = (struct sigaction){
 165         .sa_handler = sigabrt_handler,
 166         .sa_flags = SA_RESETHAND,
 167     };
 168     sigemptyset(&sigact.sa_mask);
 169     sigaction(SIGABRT, &sigact, &sigact_old);
 170 }
 171
 172 static void cleanup_sigabrt_handler(void)
 173 {
 174     sigaction(SIGABRT, &sigact_old, NULL);
 175 }
 176
 177 void qtest_add_abrt_handler(GHookFunc fn, const void *data)
 178 {
 179     GHook *hook;
 180
 181     /* Only install SIGABRT handler once */
 182     if (!abrt_hooks.is_setup) {
 183         g_hook_list_init(&abrt_hooks, sizeof(GHook));
 184     }
 185     setup_sigabrt_handler();
 186
 187     hook = g_hook_alloc(&abrt_hooks);
 188     hook->func = fn;
 189     hook->data = (void *)data;
 190
 191     g_hook_prepend(&abrt_hooks, hook);
 192 }
 193
 194 static const char *qtest_qemu_binary(void)
 195 {
 196     const char *qemu_bin;
 197
 198     qemu_bin = getenv("QTEST_QEMU_BINARY");
 199     if (!qemu_bin) {
 200         fprintf(stderr, "Environment variable QTEST_QEMU_BINARY required\n");
 201         exit(1);
 202     }
 203
 204     return qemu_bin;
 205 }
 206
 207 QTestState *qtest_init_without_qmp_handshake(const char *extra_args)
 208 {
 209     QTestState *s;
 210     int sock, qmpsock, i;
 211     gchar *socket_path;
 212     gchar *qmp_socket_path;
 213     gchar *command;
 214     const char *qemu_binary = qtest_qemu_binary();
 215
 216     s = g_new(QTestState, 1);
 217
 218     socket_path = g_strdup_printf("/tmp/qtest-%d.sock", getpid());
 219     qmp_socket_path = g_strdup_printf("/tmp/qtest-%d.qmp", getpid());
 220
 221     /* It's possible that if an earlier test run crashed it might
 222      * have left a stale unix socket lying around. Delete any
 223      * stale old socket to avoid spurious test failures with
 224      * tests/libqtest.c:70:init_socket: assertion failed (ret != -1): (-1 != -1)
 225      */
 226     unlink(socket_path);
 227     unlink(qmp_socket_path);
 228
 229     sock = init_socket(socket_path);
 230     qmpsock = init_socket(qmp_socket_path);
 231
 232     qtest_add_abrt_handler(kill_qemu_hook_func, s);
 233
 234     command = g_strdup_printf("exec %s "
 235                               "-qtest unix:%s "
 236                               "-qtest-log %s "
 237                               "-chardev socket,path=%s,id=char0 "
 238                               "-mon chardev=char0,mode=control "
 239                               "-machine accel=qtest "
 240                               "-display none "
 241                               "%s", qemu_binary, socket_path,
 242                               getenv("QTEST_LOG") ? "/dev/fd/2" : "/dev/null",
 243                               qmp_socket_path,
 244                               extra_args ?: "");
 245
 246     g_test_message("starting QEMU: %s", command);
 247
 248     s->wstatus = 0;
 249     s->qemu_pid = fork();
 250     if (s->qemu_pid == 0) {
 251         setenv("QEMU_AUDIO_DRV", "none", true);
 252         execlp("/bin/sh", "sh", "-c", command, NULL);
 253         exit(1);
 254     }
 255
 256     g_free(command);
 257     s->fd = socket_accept(sock);
 258     if (s->fd >= 0) {
 259         s->qmp_fd = socket_accept(qmpsock);
 260     }
 261     unlink(socket_path);
 262     unlink(qmp_socket_path);
 263     g_free(socket_path);
 264     g_free(qmp_socket_path);
 265
 266     g_assert(s->fd >= 0 && s->qmp_fd >= 0);
 267
 268     s->rx = g_string_new("");
 269     for (i = 0; i < MAX_IRQ; i++) {
 270         s->irq_level[i] = false;
 271     }
 272
 273     if (getenv("QTEST_STOP")) {
 274         kill(s->qemu_pid, SIGSTOP);
 275     }
 276
 277     /* ask endianness of the target */
 278
 279     s->big_endian = qtest_query_target_endianness(s);
 280
 281     return s;
 282 }
 283
 284 QTestState *qtest_init(const char *extra_args)
 285 {
 286     QTestState *s = qtest_init_without_qmp_handshake(extra_args);
 287     QDict *greeting;
 288
 289     /* Read the QMP greeting and then do the handshake */
 290     greeting = qtest_qmp_receive(s);
 291     qobject_unref(greeting);
 292     qobject_unref(qtest_qmp(s, "{ 'execute': 'qmp_capabilities' }"));
 293
 294     return s;
 295 }
 296
 297 QTestState *qtest_vinitf(const char *fmt, va_list ap)
 298 {
 299     char *args = g_strdup_vprintf(fmt, ap);
 300     QTestState *s;
 301
 302     s = qtest_init(args);
 303     g_free(args);
 304     return s;
 305 }
 306
 307 QTestState *qtest_initf(const char *fmt, ...)
 308 {
 309     va_list ap;
 310     QTestState *s;
 311
 312     va_start(ap, fmt);
 313     s = qtest_vinitf(fmt, ap);
 314     va_end(ap);
 315     return s;
 316 }
 317
 318 QTestState *qtest_init_with_serial(const char *extra_args, int *sock_fd)
 319 {
 320     int sock_fd_init;
 321     char *sock_path, sock_dir[] = "/tmp/qtest-serial-XXXXXX";
 322     QTestState *qts;
 323
 324     g_assert_true(mkdtemp(sock_dir) != NULL);
 325     sock_path = g_strdup_printf("%s/sock", sock_dir);
 326
 327     sock_fd_init = init_socket(sock_path);
 328
 329     qts = qtest_initf("-chardev socket,id=s0,path=%s -serial chardev:s0 %s",
 330                       sock_path, extra_args);
 331
 332     *sock_fd = socket_accept(sock_fd_init);
 333
 334     unlink(sock_path);
 335     g_free(sock_path);
 336     rmdir(sock_dir);
 337
 338     g_assert_true(*sock_fd >= 0);
 339
 340     return qts;
 341 }
 342
 343 void qtest_quit(QTestState *s)
 344 {
 345     g_hook_destroy_link(&abrt_hooks, g_hook_find_data(&abrt_hooks, TRUE, s));
 346
 347     /* Uninstall SIGABRT handler on last instance */
 348     cleanup_sigabrt_handler();
 349
 350     kill_qemu(s);
 351     close(s->fd);
 352     close(s->qmp_fd);
 353     g_string_free(s->rx, true);
 354     g_free(s);
 355 }
 356
 357 static void socket_send(int fd, const char *buf, size_t size)
 358 {
 359     size_t offset;
 360
 361     offset = 0;
 362     while (offset < size) {
 363         ssize_t len;
 364
 365         len = write(fd, buf + offset, size - offset);
 366         if (len == -1 && errno == EINTR) {
 367             continue;
 368         }
 369
 370         g_assert_cmpint(len, >, 0);
 371
 372         offset += len;
 373     }
 374 }
 375
 376 static void socket_sendf(int fd, const char *fmt, va_list ap)
 377 {
 378     gchar *str = g_strdup_vprintf(fmt, ap);
 379     size_t size = strlen(str);
 380
 381     socket_send(fd, str, size);
 382     g_free(str);
 383 }
 384
 385 static void GCC_FMT_ATTR(2, 3) qtest_sendf(QTestState *s, const char *fmt, ...)
 386 {
 387     va_list ap;
 388
 389     va_start(ap, fmt);
 390     socket_sendf(s->fd, fmt, ap);
 391     va_end(ap);
 392 }
 393
 394 /* Sends a message and file descriptors to the socket.
 395  * It's needed for qmp-commands like getfd/add-fd */
 396 static void socket_send_fds(int socket_fd, int *fds, size_t fds_num,
 397                             const char *buf, size_t buf_size)
 398 {
 399     ssize_t ret;
 400     struct msghdr msg = { 0 };
 401     char control[CMSG_SPACE(sizeof(int) * SOCKET_MAX_FDS)] = { 0 };
 402     size_t fdsize = sizeof(int) * fds_num;
 403     struct cmsghdr *cmsg;
 404     struct iovec iov = { .iov_base = (char *)buf, .iov_len = buf_size };
 405
 406     msg.msg_iov = &iov;
 407     msg.msg_iovlen = 1;
 408
 409     if (fds && fds_num > 0) {
 410         g_assert_cmpuint(fds_num, <, SOCKET_MAX_FDS);
 411
 412         msg.msg_control = control;
 413         msg.msg_controllen = CMSG_SPACE(fdsize);
 414
 415         cmsg = CMSG_FIRSTHDR(&msg);
 416         cmsg->cmsg_len = CMSG_LEN(fdsize);
 417         cmsg->cmsg_level = SOL_SOCKET;
 418         cmsg->cmsg_type = SCM_RIGHTS;
 419         memcpy(CMSG_DATA(cmsg), fds, fdsize);
 420     }
 421
 422     do {
 423         ret = sendmsg(socket_fd, &msg, 0);
 424     } while (ret < 0 && errno == EINTR);
 425     g_assert_cmpint(ret, >, 0);
 426 }
 427
 428 static GString *qtest_recv_line(QTestState *s)
 429 {
 430     GString *line;
 431     size_t offset;
 432     char *eol;
 433
 434     while ((eol = strchr(s->rx->str, '\n')) == NULL) {
 435         ssize_t len;
 436         char buffer[1024];
 437
 438         len = read(s->fd, buffer, sizeof(buffer));
 439         if (len == -1 && errno == EINTR) {
 440             continue;
 441         }
 442
 443         if (len == -1 || len == 0) {
 444             fprintf(stderr, "Broken pipe\n");
 445             abort();
 446         }
 447
 448         g_string_append_len(s->rx, buffer, len);
 449     }
 450
 451     offset = eol - s->rx->str;
 452     line = g_string_new_len(s->rx->str, offset);
 453     g_string_erase(s->rx, 0, offset + 1);
 454
 455     return line;
 456 }
 457
 458 static gchar **qtest_rsp(QTestState *s, int expected_args)
 459 {
 460     GString *line;
 461     gchar **words;
 462     int i;
 463
 464 redo:
 465     line = qtest_recv_line(s);
 466     words = g_strsplit(line->str, " ", 0);
 467     g_string_free(line, TRUE);
 468
 469     if (strcmp(words[0], "IRQ") == 0) {
 470         long irq;
 471         int ret;
 472
 473         g_assert(words[1] != NULL);
 474         g_assert(words[2] != NULL);
 475
 476         ret = qemu_strtol(words[2], NULL, 0, &irq);
 477         g_assert(!ret);
 478         g_assert_cmpint(irq, >=, 0);
 479         g_assert_cmpint(irq, <, MAX_IRQ);
 480
 481         if (strcmp(words[1], "raise") == 0) {
 482             s->irq_level[irq] = true;
 483         } else {
 484             s->irq_level[irq] = false;
 485         }
 486
 487         g_strfreev(words);
 488         goto redo;
 489     }
 490
 491     g_assert(words[0] != NULL);
 492     g_assert_cmpstr(words[0], ==, "OK");
 493
 494     if (expected_args) {
 495         for (i = 0; i < expected_args; i++) {
 496             g_assert(words[i] != NULL);
 497         }
 498     } else {
 499         g_strfreev(words);
 500     }
 501
 502     return words;
 503 }
 504
 505 static int qtest_query_target_endianness(QTestState *s)
 506 {
 507     gchar **args;
 508     int big_endian;
 509
 510     qtest_sendf(s, "endianness\n");
 511     args = qtest_rsp(s, 1);
 512     g_assert(strcmp(args[1], "big") == 0 || strcmp(args[1], "little") == 0);
 513     big_endian = strcmp(args[1], "big") == 0;
 514     g_strfreev(args);
 515
 516     return big_endian;
 517 }
 518
 519 typedef struct {
 520     JSONMessageParser parser;
 521     QDict *response;
 522 } QMPResponseParser;
 523
 524 static void qmp_response(void *opaque, QObject *obj, Error *err)
 525 {
 526     QMPResponseParser *qmp = opaque;
 527
 528     assert(!obj != !err);
 529
 530     if (err) {
 531         error_prepend(&err, "QMP JSON response parsing failed: ");
 532         error_report_err(err);
 533         abort();
 534     }
 535
 536     g_assert(!qmp->response);
 537     qmp->response = qobject_to(QDict, obj);
 538     g_assert(qmp->response);
 539 }
 540
 541 QDict *qmp_fd_receive(int fd)
 542 {
 543     QMPResponseParser qmp;
 544     bool log = getenv("QTEST_LOG") != NULL;
 545
 546     qmp.response = NULL;
 547     json_message_parser_init(&qmp.parser, qmp_response, &qmp, NULL);
 548     while (!qmp.response) {
 549         ssize_t len;
 550         char c;
 551
 552         len = read(fd, &c, 1);
 553         if (len == -1 && errno == EINTR) {
 554             continue;
 555         }
 556
 557         if (len == -1 || len == 0) {
 558             fprintf(stderr, "Broken pipe\n");
 559             abort();
 560         }
 561
 562         if (log) {
 563             len = write(2, &c, 1);
 564         }
 565         json_message_parser_feed(&qmp.parser, &c, 1);
 566     }
 567     json_message_parser_destroy(&qmp.parser);
 568
 569     return qmp.response;
 570 }
 571
 572 QDict *qtest_qmp_receive(QTestState *s)
 573 {
 574     return qmp_fd_receive(s->qmp_fd);
 575 }
 576
 577 /**
 578  * Allow users to send a message without waiting for the reply,
 579  * in the case that they choose to discard all replies up until
 580  * a particular EVENT is received.
 581  */
 582 void qmp_fd_vsend_fds(int fd, int *fds, size_t fds_num,
 583                       const char *fmt, va_list ap)
 584 {
 585     QObject *qobj;
 586
 587     /* Going through qobject ensures we escape strings properly */
 588     qobj = qobject_from_vjsonf_nofail(fmt, ap);
 589
 590     /* No need to send anything for an empty QObject.  */
 591     if (qobj) {
 592         int log = getenv("QTEST_LOG") != NULL;
 593         QString *qstr = qobject_to_json(qobj);
 594         const char *str;
 595
 596         /*
 597          * BUG: QMP doesn't react to input until it sees a newline, an
 598          * object, or an array.  Work-around: give it a newline.
 599          */
 600         qstring_append_chr(qstr, '\n');
 601         str = qstring_get_str(qstr);
 602
 603         if (log) {
 604             fprintf(stderr, "%s", str);
 605         }
 606         /* Send QMP request */
 607         if (fds && fds_num > 0) {
 608             socket_send_fds(fd, fds, fds_num, str, qstring_get_length(qstr));
 609         } else {
 610             socket_send(fd, str, qstring_get_length(qstr));
 611         }
 612
 613         qobject_unref(qstr);
 614         qobject_unref(qobj);
 615     }
 616 }
 617
 618 void qmp_fd_vsend(int fd, const char *fmt, va_list ap)
 619 {
 620     qmp_fd_vsend_fds(fd, NULL, 0, fmt, ap);
 621 }
 622
 623 void qtest_qmp_vsend_fds(QTestState *s, int *fds, size_t fds_num,
 624                          const char *fmt, va_list ap)
 625 {
 626     qmp_fd_vsend_fds(s->qmp_fd, fds, fds_num, fmt, ap);
 627 }
 628
 629 void qtest_qmp_vsend(QTestState *s, const char *fmt, va_list ap)
 630 {
 631     qmp_fd_vsend_fds(s->qmp_fd, NULL, 0, fmt, ap);
 632 }
 633
 634 QDict *qmp_fdv(int fd, const char *fmt, va_list ap)
 635 {
 636     qmp_fd_vsend_fds(fd, NULL, 0, fmt, ap);
 637
 638     return qmp_fd_receive(fd);
 639 }
 640
 641 QDict *qtest_vqmp_fds(QTestState *s, int *fds, size_t fds_num,
 642                       const char *fmt, va_list ap)
 643 {
 644     qtest_qmp_vsend_fds(s, fds, fds_num, fmt, ap);
 645
 646     /* Receive reply */
 647     return qtest_qmp_receive(s);
 648 }
 649
 650 QDict *qtest_vqmp(QTestState *s, const char *fmt, va_list ap)
 651 {
 652     qtest_qmp_vsend(s, fmt, ap);
 653
 654     /* Receive reply */
 655     return qtest_qmp_receive(s);
 656 }
 657
 658 QDict *qmp_fd(int fd, const char *fmt, ...)
 659 {
 660     va_list ap;
 661     QDict *response;
 662
 663     va_start(ap, fmt);
 664     response = qmp_fdv(fd, fmt, ap);
 665     va_end(ap);
 666     return response;
 667 }
 668
 669 void qmp_fd_send(int fd, const char *fmt, ...)
 670 {
 671     va_list ap;
 672
 673     va_start(ap, fmt);
 674     qmp_fd_vsend(fd, fmt, ap);
 675     va_end(ap);
 676 }
 677
 678 QDict *qtest_qmp_fds(QTestState *s, int *fds, size_t fds_num,
 679                      const char *fmt, ...)
 680 {
 681     va_list ap;
 682     QDict *response;
 683
 684     va_start(ap, fmt);
 685     response = qtest_vqmp_fds(s, fds, fds_num, fmt, ap);
 686     va_end(ap);
 687     return response;
 688 }
 689
 690 QDict *qtest_qmp(QTestState *s, const char *fmt, ...)
 691 {
 692     va_list ap;
 693     QDict *response;
 694
 695     va_start(ap, fmt);
 696     response = qtest_vqmp(s, fmt, ap);
 697     va_end(ap);
 698     return response;
 699 }
 700
 701 void qtest_qmp_send(QTestState *s, const char *fmt, ...)
 702 {
 703     va_list ap;
 704
 705     va_start(ap, fmt);
 706     qtest_qmp_vsend(s, fmt, ap);
 707     va_end(ap);
 708 }
 709
 710 void qmp_fd_vsend_raw(int fd, const char *fmt, va_list ap)
 711 {
 712     bool log = getenv("QTEST_LOG") != NULL;
 713     char *str = g_strdup_vprintf(fmt, ap);
 714
 715     if (log) {
 716         fprintf(stderr, "%s", str);
 717     }
 718     socket_send(fd, str, strlen(str));
 719     g_free(str);
 720 }
 721
 722 void qmp_fd_send_raw(int fd, const char *fmt, ...)
 723 {
 724     va_list ap;
 725
 726     va_start(ap, fmt);
 727     qmp_fd_vsend_raw(fd, fmt, ap);
 728     va_end(ap);
 729 }
 730
 731 void qtest_qmp_send_raw(QTestState *s, const char *fmt, ...)
 732 {
 733     va_list ap;
 734
 735     va_start(ap, fmt);
 736     qmp_fd_vsend_raw(s->qmp_fd, fmt, ap);
 737     va_end(ap);
 738 }
 739
 740 QDict *qtest_qmp_eventwait_ref(QTestState *s, const char *event)
 741 {
 742     QDict *response;
 743
 744     for (;;) {
 745         response = qtest_qmp_receive(s);
 746         if ((qdict_haskey(response, "event")) &&
 747             (strcmp(qdict_get_str(response, "event"), event) == 0)) {
 748             return response;
 749         }
 750         qobject_unref(response);
 751     }
 752 }
 753
 754 void qtest_qmp_eventwait(QTestState *s, const char *event)
 755 {
 756     QDict *response;
 757
 758     response = qtest_qmp_eventwait_ref(s, event);
 759     qobject_unref(response);
 760 }
 761
 762 char *qtest_vhmp(QTestState *s, const char *fmt, va_list ap)
 763 {
 764     char *cmd;
 765     QDict *resp;
 766     char *ret;
 767
 768     cmd = g_strdup_vprintf(fmt, ap);
 769     resp = qtest_qmp(s, "{'execute': 'human-monitor-command',"
 770                      " 'arguments': {'command-line': %s}}",
 771                      cmd);
 772     ret = g_strdup(qdict_get_try_str(resp, "return"));
 773     while (ret == NULL && qdict_get_try_str(resp, "event")) {
 774         /* Ignore asynchronous QMP events */
 775         qobject_unref(resp);
 776         resp = qtest_qmp_receive(s);
 777         ret = g_strdup(qdict_get_try_str(resp, "return"));
 778     }
 779     g_assert(ret);
 780     qobject_unref(resp);
 781     g_free(cmd);
 782     return ret;
 783 }
 784
 785 char *qtest_hmp(QTestState *s, const char *fmt, ...)
 786 {
 787     va_list ap;
 788     char *ret;
 789
 790     va_start(ap, fmt);
 791     ret = qtest_vhmp(s, fmt, ap);
 792     va_end(ap);
 793     return ret;
 794 }
 795
 796 const char *qtest_get_arch(void)
 797 {
 798     const char *qemu = qtest_qemu_binary();
 799     const char *end = strrchr(qemu, '/');
 800
 801     return end + strlen("/qemu-system-");
 802 }
 803
 804 bool qtest_get_irq(QTestState *s, int num)
 805 {
 806     /* dummy operation in order to make sure irq is up to date */
 807     qtest_inb(s, 0);
 808
 809     return s->irq_level[num];
 810 }
 811
 812 void qtest_module_load(QTestState *s, const char *prefix, const char *libname)
 813 {
 814     qtest_sendf(s, "module_load %s %s\n", prefix, libname);
 815     qtest_rsp(s, 0);
 816 }
 817
 818 static int64_t qtest_clock_rsp(QTestState *s)
 819 {
 820     gchar **words;
 821     int64_t clock;
 822     words = qtest_rsp(s, 2);
 823     clock = g_ascii_strtoll(words[1], NULL, 0);
 824     g_strfreev(words);
 825     return clock;
 826 }
 827
 828 int64_t qtest_clock_step_next(QTestState *s)
 829 {
 830     qtest_sendf(s, "clock_step\n");
 831     return qtest_clock_rsp(s);
 832 }
 833
 834 int64_t qtest_clock_step(QTestState *s, int64_t step)
 835 {
 836     qtest_sendf(s, "clock_step %"PRIi64"\n", step);
 837     return qtest_clock_rsp(s);
 838 }
 839
 840 int64_t qtest_clock_set(QTestState *s, int64_t val)
 841 {
 842     qtest_sendf(s, "clock_set %"PRIi64"\n", val);
 843     return qtest_clock_rsp(s);
 844 }
 845
 846 void qtest_irq_intercept_out(QTestState *s, const char *qom_path)
 847 {
 848     qtest_sendf(s, "irq_intercept_out %s\n", qom_path);
 849     qtest_rsp(s, 0);
 850 }
 851
 852 void qtest_irq_intercept_in(QTestState *s, const char *qom_path)
 853 {
 854     qtest_sendf(s, "irq_intercept_in %s\n", qom_path);
 855     qtest_rsp(s, 0);
 856 }
 857
 858 void qtest_set_irq_in(QTestState *s, const char *qom_path, const char *name,
 859                       int num, int level)
 860 {
 861     if (!name) {
 862         name = "unnamed-gpio-in";
 863     }
 864     qtest_sendf(s, "set_irq_in %s %s %d %d\n", qom_path, name, num, level);
 865     qtest_rsp(s, 0);
 866 }
 867
 868 static void qtest_out(QTestState *s, const char *cmd, uint16_t addr, uint32_t value)
 869 {
 870     qtest_sendf(s, "%s 0x%x 0x%x\n", cmd, addr, value);
 871     qtest_rsp(s, 0);
 872 }
 873
 874 void qtest_outb(QTestState *s, uint16_t addr, uint8_t value)
 875 {
 876     qtest_out(s, "outb", addr, value);
 877 }
 878
 879 void qtest_outw(QTestState *s, uint16_t addr, uint16_t value)
 880 {
 881     qtest_out(s, "outw", addr, value);
 882 }
 883
 884 void qtest_outl(QTestState *s, uint16_t addr, uint32_t value)
 885 {
 886     qtest_out(s, "outl", addr, value);
 887 }
 888
 889 static uint32_t qtest_in(QTestState *s, const char *cmd, uint16_t addr)
 890 {
 891     gchar **args;
 892     int ret;
 893     unsigned long value;
 894
 895     qtest_sendf(s, "%s 0x%x\n", cmd, addr);
 896     args = qtest_rsp(s, 2);
 897     ret = qemu_strtoul(args[1], NULL, 0, &value);
 898     g_assert(!ret && value <= UINT32_MAX);
 899     g_strfreev(args);
 900
 901     return value;
 902 }
 903
 904 uint8_t qtest_inb(QTestState *s, uint16_t addr)
 905 {
 906     return qtest_in(s, "inb", addr);
 907 }
 908
 909 uint16_t qtest_inw(QTestState *s, uint16_t addr)
 910 {
 911     return qtest_in(s, "inw", addr);
 912 }
 913
 914 uint32_t qtest_inl(QTestState *s, uint16_t addr)
 915 {
 916     return qtest_in(s, "inl", addr);
 917 }
 918
 919 static void qtest_write(QTestState *s, const char *cmd, uint64_t addr,
 920                         uint64_t value)
 921 {
 922     qtest_sendf(s, "%s 0x%" PRIx64 " 0x%" PRIx64 "\n", cmd, addr, value);
 923     qtest_rsp(s, 0);
 924 }
 925
 926 void qtest_writeb(QTestState *s, uint64_t addr, uint8_t value)
 927 {
 928     qtest_write(s, "writeb", addr, value);
 929 }
 930
 931 void qtest_writew(QTestState *s, uint64_t addr, uint16_t value)
 932 {
 933     qtest_write(s, "writew", addr, value);
 934 }
 935
 936 void qtest_writel(QTestState *s, uint64_t addr, uint32_t value)
 937 {
 938     qtest_write(s, "writel", addr, value);
 939 }
 940
 941 void qtest_writeq(QTestState *s, uint64_t addr, uint64_t value)
 942 {
 943     qtest_write(s, "writeq", addr, value);
 944 }
 945
 946 static uint64_t qtest_read(QTestState *s, const char *cmd, uint64_t addr)
 947 {
 948     gchar **args;
 949     int ret;
 950     uint64_t value;
 951
 952     qtest_sendf(s, "%s 0x%" PRIx64 "\n", cmd, addr);
 953     args = qtest_rsp(s, 2);
 954     ret = qemu_strtou64(args[1], NULL, 0, &value);
 955     g_assert(!ret);
 956     g_strfreev(args);
 957
 958     return value;
 959 }
 960
 961 uint8_t qtest_readb(QTestState *s, uint64_t addr)
 962 {
 963     return qtest_read(s, "readb", addr);
 964 }
 965
 966 uint16_t qtest_readw(QTestState *s, uint64_t addr)
 967 {
 968     return qtest_read(s, "readw", addr);
 969 }
 970
 971 uint32_t qtest_readl(QTestState *s, uint64_t addr)
 972 {
 973     return qtest_read(s, "readl", addr);
 974 }
 975
 976 uint64_t qtest_readq(QTestState *s, uint64_t addr)
 977 {
 978     return qtest_read(s, "readq", addr);
 979 }
 980
 981 static int hex2nib(char ch)
 982 {
 983     if (ch >= '0' && ch <= '9') {
 984         return ch - '0';
 985     } else if (ch >= 'a' && ch <= 'f') {
 986         return 10 + (ch - 'a');
 987     } else if (ch >= 'A' && ch <= 'F') {
 988         return 10 + (ch - 'a');
 989     } else {
 990         return -1;
 991     }
 992 }
 993
 994 void qtest_memread(QTestState *s, uint64_t addr, void *data, size_t size)
 995 {
 996     uint8_t *ptr = data;
 997     gchar **args;
 998     size_t i;
 999
1000     if (!size) {
1001         return;
1002     }
1003
1004     qtest_sendf(s, "read 0x%" PRIx64 " 0x%zx\n", addr, size);
1005     args = qtest_rsp(s, 2);
1006
1007     for (i = 0; i < size; i++) {
1008         ptr[i] = hex2nib(args[1][2 + (i * 2)]) << 4;
1009         ptr[i] |= hex2nib(args[1][2 + (i * 2) + 1]);
1010     }
1011
1012     g_strfreev(args);
1013 }
1014
1015 uint64_t qtest_rtas_call(QTestState *s, const char *name,
1016                          uint32_t nargs, uint64_t args,
1017                          uint32_t nret, uint64_t ret)
1018 {
1019     qtest_sendf(s, "rtas %s %u 0x%"PRIx64" %u 0x%"PRIx64"\n",
1020                 name, nargs, args, nret, ret);
1021     qtest_rsp(s, 0);
1022     return 0;
1023 }
1024
1025 void qtest_add_func(const char *str, void (*fn)(void))
1026 {
1027     gchar *path = g_strdup_printf("/%s/%s", qtest_get_arch(), str);
1028     g_test_add_func(path, fn);
1029     g_free(path);
1030 }
1031
1032 void qtest_add_data_func_full(const char *str, void *data,
1033                               void (*fn)(const void *),
1034                               GDestroyNotify data_free_func)
1035 {
1036     gchar *path = g_strdup_printf("/%s/%s", qtest_get_arch(), str);
1037     g_test_add_data_func_full(path, data, fn, data_free_func);
1038     g_free(path);
1039 }
1040
1041 void qtest_add_data_func(const char *str, const void *data,
1042                          void (*fn)(const void *))
1043 {
1044     gchar *path = g_strdup_printf("/%s/%s", qtest_get_arch(), str);
1045     g_test_add_data_func(path, data, fn);
1046     g_free(path);
1047 }
1048
1049 void qtest_bufwrite(QTestState *s, uint64_t addr, const void *data, size_t size)
1050 {
1051     gchar *bdata;
1052
1053     bdata = g_base64_encode(data, size);
1054     qtest_sendf(s, "b64write 0x%" PRIx64 " 0x%zx ", addr, size);
1055     socket_send(s->fd, bdata, strlen(bdata));
1056     socket_send(s->fd, "\n", 1);
1057     qtest_rsp(s, 0);
1058     g_free(bdata);
1059 }
1060
1061 void qtest_bufread(QTestState *s, uint64_t addr, void *data, size_t size)
1062 {
1063     gchar **args;
1064     size_t len;
1065
1066     qtest_sendf(s, "b64read 0x%" PRIx64 " 0x%zx\n", addr, size);
1067     args = qtest_rsp(s, 2);
1068
1069     g_base64_decode_inplace(args[1], &len);
1070     if (size != len) {
1071         fprintf(stderr, "bufread: asked for %zu bytes but decoded %zu\n",
1072                 size, len);
1073         len = MIN(len, size);
1074     }
1075
1076     memcpy(data, args[1], len);
1077     g_strfreev(args);
1078 }
1079
1080 void qtest_memwrite(QTestState *s, uint64_t addr, const void *data, size_t size)
1081 {
1082     const uint8_t *ptr = data;
1083     size_t i;
1084     char *enc;
1085
1086     if (!size) {
1087         return;
1088     }
1089
1090     enc = g_malloc(2 * size + 1);
1091
1092     for (i = 0; i < size; i++) {
1093         sprintf(&enc[i * 2], "%02x", ptr[i]);
1094     }
1095
1096     qtest_sendf(s, "write 0x%" PRIx64 " 0x%zx 0x%s\n", addr, size, enc);
1097     qtest_rsp(s, 0);
1098     g_free(enc);
1099 }
1100
1101 void qtest_memset(QTestState *s, uint64_t addr, uint8_t pattern, size_t size)
1102 {
1103     qtest_sendf(s, "memset 0x%" PRIx64 " 0x%zx 0x%02x\n", addr, size, pattern);
1104     qtest_rsp(s, 0);
1105 }
1106
1107 void qtest_qmp_assert_success(QTestState *qts, const char *fmt, ...)
1108 {
1109     va_list ap;
1110     QDict *response;
1111
1112     va_start(ap, fmt);
1113     response = qtest_vqmp(qts, fmt, ap);
1114     va_end(ap);
1115
1116     g_assert(response);
1117     if (!qdict_haskey(response, "return")) {
1118         QString *s = qobject_to_json_pretty(QOBJECT(response));
1119         g_test_message("%s", qstring_get_str(s));
1120         qobject_unref(s);
1121     }
1122     g_assert(qdict_haskey(response, "return"));
1123     qobject_unref(response);
1124 }
1125
1126 bool qtest_big_endian(QTestState *s)
1127 {
1128     return s->big_endian;
1129 }
1130
1131 static bool qtest_check_machine_version(const char *mname, const char *basename,
1132                                         int major, int minor)
1133 {
1134     char *newname;
1135     bool is_equal;
1136
1137     newname = g_strdup_printf("%s-%i.%i", basename, major, minor);
1138     is_equal = g_str_equal(mname, newname);
1139     g_free(newname);
1140
1141     return is_equal;
1142 }
1143
1144 static bool qtest_is_old_versioned_machine(const char *mname)
1145 {
1146     const char *dash = strrchr(mname, '-');
1147     const char *dot = strrchr(mname, '.');
1148     const char *chr;
1149     char *bname;
1150     const int major = QEMU_VERSION_MAJOR;
1151     const int minor = QEMU_VERSION_MINOR;
1152     bool res = false;
1153
1154     if (dash && dot && dot > dash) {
1155         for (chr = dash + 1; *chr; chr++) {
1156             if (!qemu_isdigit(*chr) && *chr != '.') {
1157                 return false;
1158             }
1159         }
1160         /*
1161          * Now check if it is one of the latest versions. Check major + 1
1162          * and minor + 1 versions as well, since they might already exist
1163          * in the development branch.
1164          */
1165         bname = g_strdup(mname);
1166         bname[dash - mname] = 0;
1167         res = !qtest_check_machine_version(mname, bname, major + 1, 0) &&
1168               !qtest_check_machine_version(mname, bname, major, minor + 1) &&
1169               !qtest_check_machine_version(mname, bname, major, minor);
1170         g_free(bname);
1171     }
1172
1173     return res;
1174 }
1175
1176 void qtest_cb_for_every_machine(void (*cb)(const char *machine),
1177                                 bool skip_old_versioned)
1178 {
1179     QDict *response, *minfo;
1180     QList *list;
1181     const QListEntry *p;
1182     QObject *qobj;
1183     QString *qstr;
1184     const char *mname;
1185     QTestState *qts;
1186
1187     qts = qtest_init("-machine none");
1188     response = qtest_qmp(qts, "{ 'execute': 'query-machines' }");
1189     g_assert(response);
1190     list = qdict_get_qlist(response, "return");
1191     g_assert(list);
1192
1193     for (p = qlist_first(list); p; p = qlist_next(p)) {
1194         minfo = qobject_to(QDict, qlist_entry_obj(p));
1195         g_assert(minfo);
1196         qobj = qdict_get(minfo, "name");
1197         g_assert(qobj);
1198         qstr = qobject_to(QString, qobj);
1199         g_assert(qstr);
1200         mname = qstring_get_str(qstr);
1201         if (!skip_old_versioned || !qtest_is_old_versioned_machine(mname)) {
1202             cb(mname);
1203         }
1204     }
1205
1206     qtest_quit(qts);
1207     qobject_unref(response);
1208 }
1209
1210 QDict *qtest_qmp_receive_success(QTestState *s,
1211                                  void (*event_cb)(void *opaque,
1212                                                   const char *event,
1213                                                   QDict *data),
1214                                  void *opaque)
1215 {
1216     QDict *response, *ret, *data;
1217     const char *event;
1218
1219     for (;;) {
1220         response = qtest_qmp_receive(s);
1221         g_assert(!qdict_haskey(response, "error"));
1222         ret = qdict_get_qdict(response, "return");
1223         if (ret) {
1224             break;
1225         }
1226         event = qdict_get_str(response, "event");
1227         data = qdict_get_qdict(response, "data");
1228         if (event_cb) {
1229             event_cb(opaque, event, data);
1230         }
1231         qobject_unref(response);
1232     }
1233
1234     qobject_ref(ret);
1235     qobject_unref(response);
1236     return ret;
1237 }
1238
1239 /*
1240  * Generic hot-plugging test via the device_add QMP command.
1241  */
1242 void qtest_qmp_device_add(QTestState *qts, const char *driver, const char *id,
1243                           const char *fmt, ...)
1244 {
1245     QDict *args, *response;
1246     va_list ap;
1247
1248     va_start(ap, fmt);
1249     args = qdict_from_vjsonf_nofail(fmt, ap);
1250     va_end(ap);
1251
1252     g_assert(!qdict_haskey(args, "driver") && !qdict_haskey(args, "id"));
1253     qdict_put_str(args, "driver", driver);
1254     qdict_put_str(args, "id", id);
1255
1256     response = qtest_qmp(qts, "{'execute': 'device_add', 'arguments': %p}",
1257                          args);
1258     g_assert(response);
1259     g_assert(!qdict_haskey(response, "event")); /* We don't expect any events */
1260     g_assert(!qdict_haskey(response, "error"));
1261     qobject_unref(response);
1262 }
1263
1264 static void device_deleted_cb(void *opaque, const char *name, QDict *data)
1265 {
1266     bool *got_event = opaque;
1267
1268     g_assert_cmpstr(name, ==, "DEVICE_DELETED");
1269     *got_event = true;
1270 }
1271
1272 /*
1273  * Generic hot-unplugging test via the device_del QMP command.
1274  * Device deletion will get one response and one event. For example:
1275  *
1276  * {'execute': 'device_del','arguments': { 'id': 'scsi-hd'}}
1277  *
1278  * will get this one:
1279  *
1280  * {"timestamp": {"seconds": 1505289667, "microseconds": 569862},
1281  *  "event": "DEVICE_DELETED", "data": {"device": "scsi-hd",
1282  *  "path": "/machine/peripheral/scsi-hd"}}
1283  *
1284  * and this one:
1285  *
1286  * {"return": {}}
1287  *
1288  * But the order of arrival may vary - so we've got to detect both.
1289  */
1290 void qtest_qmp_device_del(QTestState *qts, const char *id)
1291 {
1292     bool got_event = false;
1293     QDict *rsp;
1294
1295     qtest_qmp_send(qts, "{'execute': 'device_del', 'arguments': {'id': %s}}",
1296                    id);
1297     rsp = qtest_qmp_receive_success(qts, device_deleted_cb, &got_event);
1298     qobject_unref(rsp);
1299     if (!got_event) {
1300         rsp = qtest_qmp_receive(qts);
1301         g_assert_cmpstr(qdict_get_try_str(rsp, "event"),
1302                         ==, "DEVICE_DELETED");
1303         qobject_unref(rsp);
1304     }
1305 }
1306
1307 bool qmp_rsp_is_err(QDict *rsp)
1308 {
1309     QDict *error = qdict_get_qdict(rsp, "error");
1310     qobject_unref(rsp);
1311     return !!error;
1312 }
1313
1314 void qmp_assert_error_class(QDict *rsp, const char *class)
1315 {
1316     QDict *error = qdict_get_qdict(rsp, "error");
1317
1318     g_assert_cmpstr(qdict_get_try_str(error, "class"), ==, class);
1319     g_assert_nonnull(qdict_get_try_str(error, "desc"));
1320     g_assert(!qdict_haskey(rsp, "return"));
1321
1322     qobject_unref(rsp);
1323 }