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