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