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/cutils.h"
  26 #include "qapi/error.h"
  27 #include "qapi/qmp/json-parser.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     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 static GString *qtest_recv_line(QTestState *s)
 395 {
 396     GString *line;
 397     size_t offset;
 398     char *eol;
 399
 400     while ((eol = strchr(s->rx->str, '\n')) == NULL) {
 401         ssize_t len;
 402         char buffer[1024];
 403
 404         len = read(s->fd, buffer, sizeof(buffer));
 405         if (len == -1 && errno == EINTR) {
 406             continue;
 407         }
 408
 409         if (len == -1 || len == 0) {
 410             fprintf(stderr, "Broken pipe\n");
 411             abort();
 412         }
 413
 414         g_string_append_len(s->rx, buffer, len);
 415     }
 416
 417     offset = eol - s->rx->str;
 418     line = g_string_new_len(s->rx->str, offset);
 419     g_string_erase(s->rx, 0, offset + 1);
 420
 421     return line;
 422 }
 423
 424 static gchar **qtest_rsp(QTestState *s, int expected_args)
 425 {
 426     GString *line;
 427     gchar **words;
 428     int i;
 429
 430 redo:
 431     line = qtest_recv_line(s);
 432     words = g_strsplit(line->str, " ", 0);
 433     g_string_free(line, TRUE);
 434
 435     if (strcmp(words[0], "IRQ") == 0) {
 436         long irq;
 437         int ret;
 438
 439         g_assert(words[1] != NULL);
 440         g_assert(words[2] != NULL);
 441
 442         ret = qemu_strtol(words[2], NULL, 0, &irq);
 443         g_assert(!ret);
 444         g_assert_cmpint(irq, >=, 0);
 445         g_assert_cmpint(irq, <, MAX_IRQ);
 446
 447         if (strcmp(words[1], "raise") == 0) {
 448             s->irq_level[irq] = true;
 449         } else {
 450             s->irq_level[irq] = false;
 451         }
 452
 453         g_strfreev(words);
 454         goto redo;
 455     }
 456
 457     g_assert(words[0] != NULL);
 458     g_assert_cmpstr(words[0], ==, "OK");
 459
 460     if (expected_args) {
 461         for (i = 0; i < expected_args; i++) {
 462             g_assert(words[i] != NULL);
 463         }
 464     } else {
 465         g_strfreev(words);
 466     }
 467
 468     return words;
 469 }
 470
 471 static int qtest_query_target_endianness(QTestState *s)
 472 {
 473     gchar **args;
 474     int big_endian;
 475
 476     qtest_sendf(s, "endianness\n");
 477     args = qtest_rsp(s, 1);
 478     g_assert(strcmp(args[1], "big") == 0 || strcmp(args[1], "little") == 0);
 479     big_endian = strcmp(args[1], "big") == 0;
 480     g_strfreev(args);
 481
 482     return big_endian;
 483 }
 484
 485 typedef struct {
 486     JSONMessageParser parser;
 487     QDict *response;
 488 } QMPResponseParser;
 489
 490 static void qmp_response(void *opaque, QObject *obj, Error *err)
 491 {
 492     QMPResponseParser *qmp = opaque;
 493
 494     assert(!obj != !err);
 495
 496     if (err) {
 497         error_prepend(&err, "QMP JSON response parsing failed: ");
 498         error_report_err(err);
 499         abort();
 500     }
 501
 502     g_assert(!qmp->response);
 503     qmp->response = qobject_to(QDict, obj);
 504     g_assert(qmp->response);
 505 }
 506
 507 QDict *qmp_fd_receive(int fd)
 508 {
 509     QMPResponseParser qmp;
 510     bool log = getenv("QTEST_LOG") != NULL;
 511
 512     qmp.response = NULL;
 513     json_message_parser_init(&qmp.parser, qmp_response, &qmp, NULL);
 514     while (!qmp.response) {
 515         ssize_t len;
 516         char c;
 517
 518         len = read(fd, &c, 1);
 519         if (len == -1 && errno == EINTR) {
 520             continue;
 521         }
 522
 523         if (len == -1 || len == 0) {
 524             fprintf(stderr, "Broken pipe\n");
 525             abort();
 526         }
 527
 528         if (log) {
 529             len = write(2, &c, 1);
 530         }
 531         json_message_parser_feed(&qmp.parser, &c, 1);
 532     }
 533     json_message_parser_destroy(&qmp.parser);
 534
 535     return qmp.response;
 536 }
 537
 538 QDict *qtest_qmp_receive(QTestState *s)
 539 {
 540     return qmp_fd_receive(s->qmp_fd);
 541 }
 542
 543 /**
 544  * Allow users to send a message without waiting for the reply,
 545  * in the case that they choose to discard all replies up until
 546  * a particular EVENT is received.
 547  */
 548 void qmp_fd_vsend(int fd, const char *fmt, va_list ap)
 549 {
 550     QObject *qobj;
 551
 552     /* Going through qobject ensures we escape strings properly */
 553     qobj = qobject_from_vjsonf_nofail(fmt, ap);
 554
 555     /* No need to send anything for an empty QObject.  */
 556     if (qobj) {
 557         int log = getenv("QTEST_LOG") != NULL;
 558         QString *qstr = qobject_to_json(qobj);
 559         const char *str;
 560
 561         /*
 562          * BUG: QMP doesn't react to input until it sees a newline, an
 563          * object, or an array.  Work-around: give it a newline.
 564          */
 565         qstring_append_chr(qstr, '\n');
 566         str = qstring_get_str(qstr);
 567
 568         if (log) {
 569             fprintf(stderr, "%s", str);
 570         }
 571         /* Send QMP request */
 572         socket_send(fd, str, qstring_get_length(qstr));
 573
 574         qobject_unref(qstr);
 575         qobject_unref(qobj);
 576     }
 577 }
 578
 579 void qtest_qmp_vsend(QTestState *s, const char *fmt, va_list ap)
 580 {
 581     qmp_fd_vsend(s->qmp_fd, fmt, ap);
 582 }
 583
 584 QDict *qmp_fdv(int fd, const char *fmt, va_list ap)
 585 {
 586     qmp_fd_vsend(fd, fmt, ap);
 587
 588     return qmp_fd_receive(fd);
 589 }
 590
 591 QDict *qtest_vqmp(QTestState *s, const char *fmt, va_list ap)
 592 {
 593     qtest_qmp_vsend(s, fmt, ap);
 594
 595     /* Receive reply */
 596     return qtest_qmp_receive(s);
 597 }
 598
 599 QDict *qmp_fd(int fd, const char *fmt, ...)
 600 {
 601     va_list ap;
 602     QDict *response;
 603
 604     va_start(ap, fmt);
 605     response = qmp_fdv(fd, fmt, ap);
 606     va_end(ap);
 607     return response;
 608 }
 609
 610 void qmp_fd_send(int fd, const char *fmt, ...)
 611 {
 612     va_list ap;
 613
 614     va_start(ap, fmt);
 615     qmp_fd_vsend(fd, fmt, ap);
 616     va_end(ap);
 617 }
 618
 619 QDict *qtest_qmp(QTestState *s, const char *fmt, ...)
 620 {
 621     va_list ap;
 622     QDict *response;
 623
 624     va_start(ap, fmt);
 625     response = qtest_vqmp(s, fmt, ap);
 626     va_end(ap);
 627     return response;
 628 }
 629
 630 void qtest_qmp_send(QTestState *s, const char *fmt, ...)
 631 {
 632     va_list ap;
 633
 634     va_start(ap, fmt);
 635     qtest_qmp_vsend(s, fmt, ap);
 636     va_end(ap);
 637 }
 638
 639 void qmp_fd_vsend_raw(int fd, const char *fmt, va_list ap)
 640 {
 641     bool log = getenv("QTEST_LOG") != NULL;
 642     char *str = g_strdup_vprintf(fmt, ap);
 643
 644     if (log) {
 645         fprintf(stderr, "%s", str);
 646     }
 647     socket_send(fd, str, strlen(str));
 648     g_free(str);
 649 }
 650
 651 void qmp_fd_send_raw(int fd, const char *fmt, ...)
 652 {
 653     va_list ap;
 654
 655     va_start(ap, fmt);
 656     qmp_fd_vsend_raw(fd, fmt, ap);
 657     va_end(ap);
 658 }
 659
 660 void qtest_qmp_send_raw(QTestState *s, const char *fmt, ...)
 661 {
 662     va_list ap;
 663
 664     va_start(ap, fmt);
 665     qmp_fd_vsend_raw(s->qmp_fd, fmt, ap);
 666     va_end(ap);
 667 }
 668
 669 QDict *qtest_qmp_eventwait_ref(QTestState *s, const char *event)
 670 {
 671     QDict *response;
 672
 673     for (;;) {
 674         response = qtest_qmp_receive(s);
 675         if ((qdict_haskey(response, "event")) &&
 676             (strcmp(qdict_get_str(response, "event"), event) == 0)) {
 677             return response;
 678         }
 679         qobject_unref(response);
 680     }
 681 }
 682
 683 void qtest_qmp_eventwait(QTestState *s, const char *event)
 684 {
 685     QDict *response;
 686
 687     response = qtest_qmp_eventwait_ref(s, event);
 688     qobject_unref(response);
 689 }
 690
 691 char *qtest_vhmp(QTestState *s, const char *fmt, va_list ap)
 692 {
 693     char *cmd;
 694     QDict *resp;
 695     char *ret;
 696
 697     cmd = g_strdup_vprintf(fmt, ap);
 698     resp = qtest_qmp(s, "{'execute': 'human-monitor-command',"
 699                      " 'arguments': {'command-line': %s}}",
 700                      cmd);
 701     ret = g_strdup(qdict_get_try_str(resp, "return"));
 702     while (ret == NULL && qdict_get_try_str(resp, "event")) {
 703         /* Ignore asynchronous QMP events */
 704         qobject_unref(resp);
 705         resp = qtest_qmp_receive(s);
 706         ret = g_strdup(qdict_get_try_str(resp, "return"));
 707     }
 708     g_assert(ret);
 709     qobject_unref(resp);
 710     g_free(cmd);
 711     return ret;
 712 }
 713
 714 char *qtest_hmp(QTestState *s, const char *fmt, ...)
 715 {
 716     va_list ap;
 717     char *ret;
 718
 719     va_start(ap, fmt);
 720     ret = qtest_vhmp(s, fmt, ap);
 721     va_end(ap);
 722     return ret;
 723 }
 724
 725 const char *qtest_get_arch(void)
 726 {
 727     const char *qemu = qtest_qemu_binary();
 728     const char *end = strrchr(qemu, '/');
 729
 730     return end + strlen("/qemu-system-");
 731 }
 732
 733 bool qtest_get_irq(QTestState *s, int num)
 734 {
 735     /* dummy operation in order to make sure irq is up to date */
 736     qtest_inb(s, 0);
 737
 738     return s->irq_level[num];
 739 }
 740
 741 static int64_t qtest_clock_rsp(QTestState *s)
 742 {
 743     gchar **words;
 744     int64_t clock;
 745     words = qtest_rsp(s, 2);
 746     clock = g_ascii_strtoll(words[1], NULL, 0);
 747     g_strfreev(words);
 748     return clock;
 749 }
 750
 751 int64_t qtest_clock_step_next(QTestState *s)
 752 {
 753     qtest_sendf(s, "clock_step\n");
 754     return qtest_clock_rsp(s);
 755 }
 756
 757 int64_t qtest_clock_step(QTestState *s, int64_t step)
 758 {
 759     qtest_sendf(s, "clock_step %"PRIi64"\n", step);
 760     return qtest_clock_rsp(s);
 761 }
 762
 763 int64_t qtest_clock_set(QTestState *s, int64_t val)
 764 {
 765     qtest_sendf(s, "clock_set %"PRIi64"\n", val);
 766     return qtest_clock_rsp(s);
 767 }
 768
 769 void qtest_irq_intercept_out(QTestState *s, const char *qom_path)
 770 {
 771     qtest_sendf(s, "irq_intercept_out %s\n", qom_path);
 772     qtest_rsp(s, 0);
 773 }
 774
 775 void qtest_irq_intercept_in(QTestState *s, const char *qom_path)
 776 {
 777     qtest_sendf(s, "irq_intercept_in %s\n", qom_path);
 778     qtest_rsp(s, 0);
 779 }
 780
 781 void qtest_set_irq_in(QTestState *s, const char *qom_path, const char *name,
 782                       int num, int level)
 783 {
 784     if (!name) {
 785         name = "unnamed-gpio-in";
 786     }
 787     qtest_sendf(s, "set_irq_in %s %s %d %d\n", qom_path, name, num, level);
 788     qtest_rsp(s, 0);
 789 }
 790
 791 static void qtest_out(QTestState *s, const char *cmd, uint16_t addr, uint32_t value)
 792 {
 793     qtest_sendf(s, "%s 0x%x 0x%x\n", cmd, addr, value);
 794     qtest_rsp(s, 0);
 795 }
 796
 797 void qtest_outb(QTestState *s, uint16_t addr, uint8_t value)
 798 {
 799     qtest_out(s, "outb", addr, value);
 800 }
 801
 802 void qtest_outw(QTestState *s, uint16_t addr, uint16_t value)
 803 {
 804     qtest_out(s, "outw", addr, value);
 805 }
 806
 807 void qtest_outl(QTestState *s, uint16_t addr, uint32_t value)
 808 {
 809     qtest_out(s, "outl", addr, value);
 810 }
 811
 812 static uint32_t qtest_in(QTestState *s, const char *cmd, uint16_t addr)
 813 {
 814     gchar **args;
 815     int ret;
 816     unsigned long value;
 817
 818     qtest_sendf(s, "%s 0x%x\n", cmd, addr);
 819     args = qtest_rsp(s, 2);
 820     ret = qemu_strtoul(args[1], NULL, 0, &value);
 821     g_assert(!ret && value <= UINT32_MAX);
 822     g_strfreev(args);
 823
 824     return value;
 825 }
 826
 827 uint8_t qtest_inb(QTestState *s, uint16_t addr)
 828 {
 829     return qtest_in(s, "inb", addr);
 830 }
 831
 832 uint16_t qtest_inw(QTestState *s, uint16_t addr)
 833 {
 834     return qtest_in(s, "inw", addr);
 835 }
 836
 837 uint32_t qtest_inl(QTestState *s, uint16_t addr)
 838 {
 839     return qtest_in(s, "inl", addr);
 840 }
 841
 842 static void qtest_write(QTestState *s, const char *cmd, uint64_t addr,
 843                         uint64_t value)
 844 {
 845     qtest_sendf(s, "%s 0x%" PRIx64 " 0x%" PRIx64 "\n", cmd, addr, value);
 846     qtest_rsp(s, 0);
 847 }
 848
 849 void qtest_writeb(QTestState *s, uint64_t addr, uint8_t value)
 850 {
 851     qtest_write(s, "writeb", addr, value);
 852 }
 853
 854 void qtest_writew(QTestState *s, uint64_t addr, uint16_t value)
 855 {
 856     qtest_write(s, "writew", addr, value);
 857 }
 858
 859 void qtest_writel(QTestState *s, uint64_t addr, uint32_t value)
 860 {
 861     qtest_write(s, "writel", addr, value);
 862 }
 863
 864 void qtest_writeq(QTestState *s, uint64_t addr, uint64_t value)
 865 {
 866     qtest_write(s, "writeq", addr, value);
 867 }
 868
 869 static uint64_t qtest_read(QTestState *s, const char *cmd, uint64_t addr)
 870 {
 871     gchar **args;
 872     int ret;
 873     uint64_t value;
 874
 875     qtest_sendf(s, "%s 0x%" PRIx64 "\n", cmd, addr);
 876     args = qtest_rsp(s, 2);
 877     ret = qemu_strtou64(args[1], NULL, 0, &value);
 878     g_assert(!ret);
 879     g_strfreev(args);
 880
 881     return value;
 882 }
 883
 884 uint8_t qtest_readb(QTestState *s, uint64_t addr)
 885 {
 886     return qtest_read(s, "readb", addr);
 887 }
 888
 889 uint16_t qtest_readw(QTestState *s, uint64_t addr)
 890 {
 891     return qtest_read(s, "readw", addr);
 892 }
 893
 894 uint32_t qtest_readl(QTestState *s, uint64_t addr)
 895 {
 896     return qtest_read(s, "readl", addr);
 897 }
 898
 899 uint64_t qtest_readq(QTestState *s, uint64_t addr)
 900 {
 901     return qtest_read(s, "readq", addr);
 902 }
 903
 904 static int hex2nib(char ch)
 905 {
 906     if (ch >= '0' && ch <= '9') {
 907         return ch - '0';
 908     } else if (ch >= 'a' && ch <= 'f') {
 909         return 10 + (ch - 'a');
 910     } else if (ch >= 'A' && ch <= 'F') {
 911         return 10 + (ch - 'a');
 912     } else {
 913         return -1;
 914     }
 915 }
 916
 917 void qtest_memread(QTestState *s, uint64_t addr, void *data, size_t size)
 918 {
 919     uint8_t *ptr = data;
 920     gchar **args;
 921     size_t i;
 922
 923     if (!size) {
 924         return;
 925     }
 926
 927     qtest_sendf(s, "read 0x%" PRIx64 " 0x%zx\n", addr, size);
 928     args = qtest_rsp(s, 2);
 929
 930     for (i = 0; i < size; i++) {
 931         ptr[i] = hex2nib(args[1][2 + (i * 2)]) << 4;
 932         ptr[i] |= hex2nib(args[1][2 + (i * 2) + 1]);
 933     }
 934
 935     g_strfreev(args);
 936 }
 937
 938 uint64_t qtest_rtas_call(QTestState *s, const char *name,
 939                          uint32_t nargs, uint64_t args,
 940                          uint32_t nret, uint64_t ret)
 941 {
 942     qtest_sendf(s, "rtas %s %u 0x%"PRIx64" %u 0x%"PRIx64"\n",
 943                 name, nargs, args, nret, ret);
 944     qtest_rsp(s, 0);
 945     return 0;
 946 }
 947
 948 void qtest_add_func(const char *str, void (*fn)(void))
 949 {
 950     gchar *path = g_strdup_printf("/%s/%s", qtest_get_arch(), str);
 951     g_test_add_func(path, fn);
 952     g_free(path);
 953 }
 954
 955 void qtest_add_data_func_full(const char *str, void *data,
 956                               void (*fn)(const void *),
 957                               GDestroyNotify data_free_func)
 958 {
 959     gchar *path = g_strdup_printf("/%s/%s", qtest_get_arch(), str);
 960     g_test_add_data_func_full(path, data, fn, data_free_func);
 961     g_free(path);
 962 }
 963
 964 void qtest_add_data_func(const char *str, const void *data,
 965                          void (*fn)(const void *))
 966 {
 967     gchar *path = g_strdup_printf("/%s/%s", qtest_get_arch(), str);
 968     g_test_add_data_func(path, data, fn);
 969     g_free(path);
 970 }
 971
 972 void qtest_bufwrite(QTestState *s, uint64_t addr, const void *data, size_t size)
 973 {
 974     gchar *bdata;
 975
 976     bdata = g_base64_encode(data, size);
 977     qtest_sendf(s, "b64write 0x%" PRIx64 " 0x%zx ", addr, size);
 978     socket_send(s->fd, bdata, strlen(bdata));
 979     socket_send(s->fd, "\n", 1);
 980     qtest_rsp(s, 0);
 981     g_free(bdata);
 982 }
 983
 984 void qtest_bufread(QTestState *s, uint64_t addr, void *data, size_t size)
 985 {
 986     gchar **args;
 987     size_t len;
 988
 989     qtest_sendf(s, "b64read 0x%" PRIx64 " 0x%zx\n", addr, size);
 990     args = qtest_rsp(s, 2);
 991
 992     g_base64_decode_inplace(args[1], &len);
 993     if (size != len) {
 994         fprintf(stderr, "bufread: asked for %zu bytes but decoded %zu\n",
 995                 size, len);
 996         len = MIN(len, size);
 997     }
 998
 999     memcpy(data, args[1], len);
1000     g_strfreev(args);
1001 }
1002
1003 void qtest_memwrite(QTestState *s, uint64_t addr, const void *data, size_t size)
1004 {
1005     const uint8_t *ptr = data;
1006     size_t i;
1007     char *enc;
1008
1009     if (!size) {
1010         return;
1011     }
1012
1013     enc = g_malloc(2 * size + 1);
1014
1015     for (i = 0; i < size; i++) {
1016         sprintf(&enc[i * 2], "%02x", ptr[i]);
1017     }
1018
1019     qtest_sendf(s, "write 0x%" PRIx64 " 0x%zx 0x%s\n", addr, size, enc);
1020     qtest_rsp(s, 0);
1021     g_free(enc);
1022 }
1023
1024 void qtest_memset(QTestState *s, uint64_t addr, uint8_t pattern, size_t size)
1025 {
1026     qtest_sendf(s, "memset 0x%" PRIx64 " 0x%zx 0x%02x\n", addr, size, pattern);
1027     qtest_rsp(s, 0);
1028 }
1029
1030 QDict *qmp(const char *fmt, ...)
1031 {
1032     va_list ap;
1033     QDict *response;
1034
1035     va_start(ap, fmt);
1036     response = qtest_vqmp(global_qtest, fmt, ap);
1037     va_end(ap);
1038     return response;
1039 }
1040
1041 char *hmp(const char *fmt, ...)
1042 {
1043     va_list ap;
1044     char *ret;
1045
1046     va_start(ap, fmt);
1047     ret = qtest_vhmp(global_qtest, fmt, ap);
1048     va_end(ap);
1049     return ret;
1050 }
1051
1052 bool qtest_big_endian(QTestState *s)
1053 {
1054     return s->big_endian;
1055 }
1056
1057 static bool qtest_check_machine_version(const char *mname, const char *basename,
1058                                         int major, int minor)
1059 {
1060     char *newname;
1061     bool is_equal;
1062
1063     newname = g_strdup_printf("%s-%i.%i", basename, major, minor);
1064     is_equal = g_str_equal(mname, newname);
1065     g_free(newname);
1066
1067     return is_equal;
1068 }
1069
1070 static bool qtest_is_old_versioned_machine(const char *mname)
1071 {
1072     const char *dash = strrchr(mname, '-');
1073     const char *dot = strrchr(mname, '.');
1074     const char *chr;
1075     char *bname;
1076     const int major = QEMU_VERSION_MAJOR;
1077     const int minor = QEMU_VERSION_MINOR;
1078     bool res = false;
1079
1080     if (dash && dot && dot > dash) {
1081         for (chr = dash + 1; *chr; chr++) {
1082             if (!qemu_isdigit(*chr) && *chr != '.') {
1083                 return false;
1084             }
1085         }
1086         /*
1087          * Now check if it is one of the latest versions. Check major + 1
1088          * and minor + 1 versions as well, since they might already exist
1089          * in the development branch.
1090          */
1091         bname = g_strdup(mname);
1092         bname[dash - mname] = 0;
1093         res = !qtest_check_machine_version(mname, bname, major + 1, 0) &&
1094               !qtest_check_machine_version(mname, bname, major, minor + 1) &&
1095               !qtest_check_machine_version(mname, bname, major, minor);
1096         g_free(bname);
1097     }
1098
1099     return res;
1100 }
1101
1102 void qtest_cb_for_every_machine(void (*cb)(const char *machine),
1103                                 bool skip_old_versioned)
1104 {
1105     QDict *response, *minfo;
1106     QList *list;
1107     const QListEntry *p;
1108     QObject *qobj;
1109     QString *qstr;
1110     const char *mname;
1111
1112     qtest_start("-machine none");
1113     response = qmp("{ 'execute': 'query-machines' }");
1114     g_assert(response);
1115     list = qdict_get_qlist(response, "return");
1116     g_assert(list);
1117
1118     for (p = qlist_first(list); p; p = qlist_next(p)) {
1119         minfo = qobject_to(QDict, qlist_entry_obj(p));
1120         g_assert(minfo);
1121         qobj = qdict_get(minfo, "name");
1122         g_assert(qobj);
1123         qstr = qobject_to(QString, qobj);
1124         g_assert(qstr);
1125         mname = qstring_get_str(qstr);
1126         if (!skip_old_versioned || !qtest_is_old_versioned_machine(mname)) {
1127             cb(mname);
1128         }
1129     }
1130
1131     qtest_end();
1132     qobject_unref(response);
1133 }
1134
1135 QDict *qtest_qmp_receive_success(QTestState *s,
1136                                  void (*event_cb)(void *opaque,
1137                                                   const char *event,
1138                                                   QDict *data),
1139                                  void *opaque)
1140 {
1141     QDict *response, *ret, *data;
1142     const char *event;
1143
1144     for (;;) {
1145         response = qtest_qmp_receive(s);
1146         g_assert(!qdict_haskey(response, "error"));
1147         ret = qdict_get_qdict(response, "return");
1148         if (ret) {
1149             break;
1150         }
1151         event = qdict_get_str(response, "event");
1152         data = qdict_get_qdict(response, "data");
1153         if (event_cb) {
1154             event_cb(opaque, event, data);
1155         }
1156         qobject_unref(response);
1157     }
1158
1159     qobject_ref(ret);
1160     qobject_unref(response);
1161     return ret;
1162 }
1163
1164 /*
1165  * Generic hot-plugging test via the device_add QMP command.
1166  */
1167 void qtest_qmp_device_add(const char *driver, const char *id,
1168                           const char *fmt, ...)
1169 {
1170     QDict *args, *response;
1171     va_list ap;
1172
1173     va_start(ap, fmt);
1174     args = qdict_from_vjsonf_nofail(fmt, ap);
1175     va_end(ap);
1176
1177     g_assert(!qdict_haskey(args, "driver") && !qdict_haskey(args, "id"));
1178     qdict_put_str(args, "driver", driver);
1179     qdict_put_str(args, "id", id);
1180
1181     response = qmp("{'execute': 'device_add', 'arguments': %p}", args);
1182     g_assert(response);
1183     g_assert(!qdict_haskey(response, "event")); /* We don't expect any events */
1184     g_assert(!qdict_haskey(response, "error"));
1185     qobject_unref(response);
1186 }
1187
1188 static void device_deleted_cb(void *opaque, const char *name, QDict *data)
1189 {
1190     bool *got_event = opaque;
1191
1192     g_assert_cmpstr(name, ==, "DEVICE_DELETED");
1193     *got_event = true;
1194 }
1195
1196 /*
1197  * Generic hot-unplugging test via the device_del QMP command.
1198  * Device deletion will get one response and one event. For example:
1199  *
1200  * {'execute': 'device_del','arguments': { 'id': 'scsi-hd'}}
1201  *
1202  * will get this one:
1203  *
1204  * {"timestamp": {"seconds": 1505289667, "microseconds": 569862},
1205  *  "event": "DEVICE_DELETED", "data": {"device": "scsi-hd",
1206  *  "path": "/machine/peripheral/scsi-hd"}}
1207  *
1208  * and this one:
1209  *
1210  * {"return": {}}
1211  *
1212  * But the order of arrival may vary - so we've got to detect both.
1213  */
1214 void qtest_qmp_device_del(const char *id)
1215 {
1216     bool got_event = false;
1217     QDict *rsp;
1218
1219     qtest_qmp_send(global_qtest,
1220                    "{'execute': 'device_del', 'arguments': {'id': %s}}",
1221                    id);
1222     rsp = qtest_qmp_receive_success(global_qtest, device_deleted_cb,
1223                                     &got_event);
1224     qobject_unref(rsp);
1225     if (!got_event) {
1226         rsp = qtest_qmp_receive(global_qtest);
1227         g_assert_cmpstr(qdict_get_try_str(rsp, "event"),
1228                         ==, "DEVICE_DELETED");
1229         qobject_unref(rsp);
1230     }
1231 }
1232
1233 bool qmp_rsp_is_err(QDict *rsp)
1234 {
1235     QDict *error = qdict_get_qdict(rsp, "error");
1236     qobject_unref(rsp);
1237     return !!error;
1238 }
1239
1240 void qmp_assert_error_class(QDict *rsp, const char *class)
1241 {
1242     QDict *error = qdict_get_qdict(rsp, "error");
1243
1244     g_assert_cmpstr(qdict_get_try_str(error, "class"), ==, class);
1245     g_assert_nonnull(qdict_get_try_str(error, "desc"));
1246     g_assert(!qdict_haskey(rsp, "return"));
1247
1248     qobject_unref(rsp);
1249 }