tests/libqtest.c.orig

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