tests/libqtest.c

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