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