tests/libqtest.c

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