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