4 * Copyright IBM, Corp. 2011
9 * This work is licensed under the terms of the GNU GPL, version 2 or later.
10 * See the COPYING file in the top-level directory.
14 #include "qemu/osdep.h"
15 #include "qapi/error.h"
16 #include "qemu-common.h"
18 #include "sysemu/qtest.h"
20 #include "chardev/char-fe.h"
21 #include "exec/ioport.h"
22 #include "exec/memory.h"
24 #include "sysemu/accel.h"
25 #include "sysemu/sysemu.h"
26 #include "sysemu/cpus.h"
27 #include "qemu/config-file.h"
28 #include "qemu/option.h"
29 #include "qemu/error-report.h"
30 #include "qemu/cutils.h"
32 #include "hw/ppc/spapr_rtas.h"
39 static DeviceState *irq_intercept_dev;
40 static FILE *qtest_log_fp;
41 static CharBackend qtest_chr;
42 static GString *inbuf;
43 static int irq_levels[MAX_IRQ];
44 static qemu_timeval start_time;
45 static bool qtest_opened;
47 #define FMT_timeval "%ld.%06ld"
52 * Line based protocol, request/response based. Server can send async messages
53 * so clients should always handle many async messages before the response
60 * The qtest client is completely in charge of the QEMU_CLOCK_VIRTUAL. qtest commands
61 * let you adjust the value of the clock (monotonically). All the commands
62 * return the current value of the clock in nanoseconds.
67 * Advance the clock to the next deadline. Useful when waiting for
68 * asynchronous events.
73 * Advance the clock by NS nanoseconds.
78 * Advance the clock to NS nanoseconds (do nothing if it's already past).
80 * PIO and memory access:
100 * > writeb ADDR VALUE
103 * > writew ADDR VALUE
106 * > writel ADDR VALUE
109 * > writeq ADDR VALUE
127 * > write ADDR SIZE DATA
130 * > b64read ADDR SIZE
133 * > b64write ADDR SIZE B64_DATA
136 * > memset ADDR SIZE VALUE
139 * ADDR, SIZE, VALUE are all integers parsed with strtoul() with a base of 0.
140 * For 'memset' a zero size is permitted and does nothing.
142 * DATA is an arbitrarily long hex number prefixed with '0x'. If it's smaller
143 * than the expected size, the value will be zero filled at the end of the data
146 * B64_DATA is an arbitrarily long base64 encoded string.
147 * If the sizes do not match, the data will be truncated.
151 * > irq_intercept_in QOM-PATH
154 * > irq_intercept_out QOM-PATH
157 * Attach to the gpio-in (resp. gpio-out) pins exported by the device at
158 * QOM-PATH. When the pin is triggered, one of the following async messages
159 * will be printed to the qtest stream:
164 * where NUM is an IRQ number. For the PC, interrupts can be intercepted
165 * simply with "irq_intercept_in ioapic" (note that IRQ0 comes out with
166 * NUM=0 even though it is remapped to GSI 2).
169 static int hex2nib(char ch)
171 if (ch >= '0' && ch <= '9') {
173 } else if (ch >= 'a' && ch <= 'f') {
174 return 10 + (ch - 'a');
175 } else if (ch >= 'A' && ch <= 'F') {
176 return 10 + (ch - 'A');
182 static void qtest_get_time(qemu_timeval *tv)
184 qemu_gettimeofday(tv);
185 tv->tv_sec -= start_time.tv_sec;
186 tv->tv_usec -= start_time.tv_usec;
187 if (tv->tv_usec < 0) {
188 tv->tv_usec += 1000000;
193 static void qtest_send_prefix(CharBackend *chr)
197 if (!qtest_log_fp || !qtest_opened) {
202 fprintf(qtest_log_fp, "[S +" FMT_timeval "] ",
203 (long) tv.tv_sec, (long) tv.tv_usec);
206 static void GCC_FMT_ATTR(1, 2) qtest_log_send(const char *fmt, ...)
210 if (!qtest_log_fp || !qtest_opened) {
214 qtest_send_prefix(NULL);
217 vfprintf(qtest_log_fp, fmt, ap);
221 static void do_qtest_send(CharBackend *chr, const char *str, size_t len)
223 qemu_chr_fe_write_all(chr, (uint8_t *)str, len);
224 if (qtest_log_fp && qtest_opened) {
225 fprintf(qtest_log_fp, "%s", str);
229 static void qtest_send(CharBackend *chr, const char *str)
231 do_qtest_send(chr, str, strlen(str));
234 static void GCC_FMT_ATTR(2, 3) qtest_sendf(CharBackend *chr,
235 const char *fmt, ...)
241 buffer = g_strdup_vprintf(fmt, ap);
242 qtest_send(chr, buffer);
247 static void qtest_irq_handler(void *opaque, int n, int level)
249 qemu_irq old_irq = *(qemu_irq *)opaque;
250 qemu_set_irq(old_irq, level);
252 if (irq_levels[n] != level) {
253 CharBackend *chr = &qtest_chr;
254 irq_levels[n] = level;
255 qtest_send_prefix(chr);
256 qtest_sendf(chr, "IRQ %s %d\n",
257 level ? "raise" : "lower", n);
261 static void qtest_process_command(CharBackend *chr, gchar **words)
263 const gchar *command;
274 fprintf(qtest_log_fp, "[R +" FMT_timeval "]",
275 (long) tv.tv_sec, (long) tv.tv_usec);
276 for (i = 0; words[i]; i++) {
277 fprintf(qtest_log_fp, " %s", words[i]);
279 fprintf(qtest_log_fp, "\n");
283 if (strcmp(words[0], "irq_intercept_out") == 0
284 || strcmp(words[0], "irq_intercept_in") == 0) {
289 dev = DEVICE(object_resolve_path(words[1], NULL));
291 qtest_send_prefix(chr);
292 qtest_send(chr, "FAIL Unknown device\n");
296 if (irq_intercept_dev) {
297 qtest_send_prefix(chr);
298 if (irq_intercept_dev != dev) {
299 qtest_send(chr, "FAIL IRQ intercept already enabled\n");
301 qtest_send(chr, "OK\n");
306 QLIST_FOREACH(ngl, &dev->gpios, node) {
307 /* We don't support intercept of named GPIOs yet */
311 if (words[0][14] == 'o') {
313 for (i = 0; i < ngl->num_out; ++i) {
314 qemu_irq *disconnected = g_new0(qemu_irq, 1);
315 qemu_irq icpt = qemu_allocate_irq(qtest_irq_handler,
318 *disconnected = qdev_intercept_gpio_out(dev, icpt,
322 qemu_irq_intercept_in(ngl->in, qtest_irq_handler,
326 irq_intercept_dev = dev;
327 qtest_send_prefix(chr);
328 qtest_send(chr, "OK\n");
330 } else if (strcmp(words[0], "outb") == 0 ||
331 strcmp(words[0], "outw") == 0 ||
332 strcmp(words[0], "outl") == 0) {
337 g_assert(words[1] && words[2]);
338 ret = qemu_strtoul(words[1], NULL, 0, &addr);
340 ret = qemu_strtoul(words[2], NULL, 0, &value);
342 g_assert(addr <= 0xffff);
344 if (words[0][3] == 'b') {
345 cpu_outb(addr, value);
346 } else if (words[0][3] == 'w') {
347 cpu_outw(addr, value);
348 } else if (words[0][3] == 'l') {
349 cpu_outl(addr, value);
351 qtest_send_prefix(chr);
352 qtest_send(chr, "OK\n");
353 } else if (strcmp(words[0], "inb") == 0 ||
354 strcmp(words[0], "inw") == 0 ||
355 strcmp(words[0], "inl") == 0) {
357 uint32_t value = -1U;
361 ret = qemu_strtoul(words[1], NULL, 0, &addr);
363 g_assert(addr <= 0xffff);
365 if (words[0][2] == 'b') {
366 value = cpu_inb(addr);
367 } else if (words[0][2] == 'w') {
368 value = cpu_inw(addr);
369 } else if (words[0][2] == 'l') {
370 value = cpu_inl(addr);
372 qtest_send_prefix(chr);
373 qtest_sendf(chr, "OK 0x%04x\n", value);
374 } else if (strcmp(words[0], "writeb") == 0 ||
375 strcmp(words[0], "writew") == 0 ||
376 strcmp(words[0], "writel") == 0 ||
377 strcmp(words[0], "writeq") == 0) {
382 g_assert(words[1] && words[2]);
383 ret = qemu_strtou64(words[1], NULL, 0, &addr);
385 ret = qemu_strtou64(words[2], NULL, 0, &value);
388 if (words[0][5] == 'b') {
389 uint8_t data = value;
390 address_space_rw(first_cpu->as, addr, MEMTXATTRS_UNSPECIFIED,
392 } else if (words[0][5] == 'w') {
393 uint16_t data = value;
395 address_space_rw(first_cpu->as, addr, MEMTXATTRS_UNSPECIFIED,
396 (uint8_t *) &data, 2, true);
397 } else if (words[0][5] == 'l') {
398 uint32_t data = value;
400 address_space_rw(first_cpu->as, addr, MEMTXATTRS_UNSPECIFIED,
401 (uint8_t *) &data, 4, true);
402 } else if (words[0][5] == 'q') {
403 uint64_t data = value;
405 address_space_rw(first_cpu->as, addr, MEMTXATTRS_UNSPECIFIED,
406 (uint8_t *) &data, 8, true);
408 qtest_send_prefix(chr);
409 qtest_send(chr, "OK\n");
410 } else if (strcmp(words[0], "readb") == 0 ||
411 strcmp(words[0], "readw") == 0 ||
412 strcmp(words[0], "readl") == 0 ||
413 strcmp(words[0], "readq") == 0) {
415 uint64_t value = UINT64_C(-1);
419 ret = qemu_strtou64(words[1], NULL, 0, &addr);
422 if (words[0][4] == 'b') {
424 address_space_rw(first_cpu->as, addr, MEMTXATTRS_UNSPECIFIED,
427 } else if (words[0][4] == 'w') {
429 address_space_rw(first_cpu->as, addr, MEMTXATTRS_UNSPECIFIED,
430 (uint8_t *) &data, 2, false);
431 value = tswap16(data);
432 } else if (words[0][4] == 'l') {
434 address_space_rw(first_cpu->as, addr, MEMTXATTRS_UNSPECIFIED,
435 (uint8_t *) &data, 4, false);
436 value = tswap32(data);
437 } else if (words[0][4] == 'q') {
438 address_space_rw(first_cpu->as, addr, MEMTXATTRS_UNSPECIFIED,
439 (uint8_t *) &value, 8, false);
442 qtest_send_prefix(chr);
443 qtest_sendf(chr, "OK 0x%016" PRIx64 "\n", value);
444 } else if (strcmp(words[0], "read") == 0) {
445 uint64_t addr, len, i;
450 g_assert(words[1] && words[2]);
451 ret = qemu_strtou64(words[1], NULL, 0, &addr);
453 ret = qemu_strtou64(words[2], NULL, 0, &len);
455 /* We'd send garbage to libqtest if len is 0 */
458 data = g_malloc(len);
459 address_space_rw(first_cpu->as, addr, MEMTXATTRS_UNSPECIFIED,
462 enc = g_malloc(2 * len + 1);
463 for (i = 0; i < len; i++) {
464 sprintf(&enc[i * 2], "%02x", data[i]);
467 qtest_send_prefix(chr);
468 qtest_sendf(chr, "OK 0x%s\n", enc);
472 } else if (strcmp(words[0], "b64read") == 0) {
478 g_assert(words[1] && words[2]);
479 ret = qemu_strtou64(words[1], NULL, 0, &addr);
481 ret = qemu_strtou64(words[2], NULL, 0, &len);
484 data = g_malloc(len);
485 address_space_rw(first_cpu->as, addr, MEMTXATTRS_UNSPECIFIED,
487 b64_data = g_base64_encode(data, len);
488 qtest_send_prefix(chr);
489 qtest_sendf(chr, "OK %s\n", b64_data);
493 } else if (strcmp(words[0], "write") == 0) {
494 uint64_t addr, len, i;
499 g_assert(words[1] && words[2] && words[3]);
500 ret = qemu_strtou64(words[1], NULL, 0, &addr);
502 ret = qemu_strtou64(words[2], NULL, 0, &len);
505 data_len = strlen(words[3]);
507 qtest_send(chr, "ERR invalid argument size\n");
511 data = g_malloc(len);
512 for (i = 0; i < len; i++) {
513 if ((i * 2 + 4) <= data_len) {
514 data[i] = hex2nib(words[3][i * 2 + 2]) << 4;
515 data[i] |= hex2nib(words[3][i * 2 + 3]);
520 address_space_rw(first_cpu->as, addr, MEMTXATTRS_UNSPECIFIED,
524 qtest_send_prefix(chr);
525 qtest_send(chr, "OK\n");
526 } else if (strcmp(words[0], "memset") == 0) {
529 unsigned long pattern;
532 g_assert(words[1] && words[2] && words[3]);
533 ret = qemu_strtou64(words[1], NULL, 0, &addr);
535 ret = qemu_strtou64(words[2], NULL, 0, &len);
537 ret = qemu_strtoul(words[3], NULL, 0, &pattern);
541 data = g_malloc(len);
542 memset(data, pattern, len);
543 address_space_rw(first_cpu->as, addr, MEMTXATTRS_UNSPECIFIED,
548 qtest_send_prefix(chr);
549 qtest_send(chr, "OK\n");
550 } else if (strcmp(words[0], "b64write") == 0) {
557 g_assert(words[1] && words[2] && words[3]);
558 ret = qemu_strtou64(words[1], NULL, 0, &addr);
560 ret = qemu_strtou64(words[2], NULL, 0, &len);
563 data_len = strlen(words[3]);
565 qtest_send(chr, "ERR invalid argument size\n");
569 data = g_base64_decode_inplace(words[3], &out_len);
570 if (out_len != len) {
571 qtest_log_send("b64write: data length mismatch (told %"PRIu64", "
574 out_len = MIN(out_len, len);
577 address_space_rw(first_cpu->as, addr, MEMTXATTRS_UNSPECIFIED,
580 qtest_send_prefix(chr);
581 qtest_send(chr, "OK\n");
582 } else if (strcmp(words[0], "endianness") == 0) {
583 qtest_send_prefix(chr);
584 #if defined(TARGET_WORDS_BIGENDIAN)
585 qtest_sendf(chr, "OK big\n");
587 qtest_sendf(chr, "OK little\n");
590 } else if (strcmp(words[0], "rtas") == 0) {
591 uint64_t res, args, ret;
592 unsigned long nargs, nret;
595 rc = qemu_strtoul(words[2], NULL, 0, &nargs);
597 rc = qemu_strtou64(words[3], NULL, 0, &args);
599 rc = qemu_strtoul(words[4], NULL, 0, &nret);
601 rc = qemu_strtou64(words[5], NULL, 0, &ret);
603 res = qtest_rtas_call(words[1], nargs, args, nret, ret);
605 qtest_send_prefix(chr);
606 qtest_sendf(chr, "OK %"PRIu64"\n", res);
608 } else if (qtest_enabled() && strcmp(words[0], "clock_step") == 0) {
612 int ret = qemu_strtoi64(words[1], NULL, 0, &ns);
615 ns = qemu_clock_deadline_ns_all(QEMU_CLOCK_VIRTUAL);
617 qtest_clock_warp(qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) + ns);
618 qtest_send_prefix(chr);
619 qtest_sendf(chr, "OK %"PRIi64"\n",
620 (int64_t)qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL));
621 } else if (qtest_enabled() && strcmp(words[0], "clock_set") == 0) {
626 ret = qemu_strtoi64(words[1], NULL, 0, &ns);
628 qtest_clock_warp(ns);
629 qtest_send_prefix(chr);
630 qtest_sendf(chr, "OK %"PRIi64"\n",
631 (int64_t)qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL));
633 qtest_send_prefix(chr);
634 qtest_sendf(chr, "FAIL Unknown command '%s'\n", words[0]);
638 static void qtest_process_inbuf(CharBackend *chr, GString *inbuf)
642 while ((end = strchr(inbuf->str, '\n')) != NULL) {
647 offset = end - inbuf->str;
649 cmd = g_string_new_len(inbuf->str, offset);
650 g_string_erase(inbuf, 0, offset + 1);
652 words = g_strsplit(cmd->str, " ", 0);
653 qtest_process_command(chr, words);
656 g_string_free(cmd, TRUE);
660 static void qtest_read(void *opaque, const uint8_t *buf, int size)
662 CharBackend *chr = opaque;
664 g_string_append_len(inbuf, (const gchar *)buf, size);
665 qtest_process_inbuf(chr, inbuf);
668 static int qtest_can_read(void *opaque)
673 static void qtest_event(void *opaque, int event)
678 case CHR_EVENT_OPENED:
680 * We used to call qemu_system_reset() here, hoping we could
681 * use the same process for multiple tests that way. Never
682 * used. Injects an extra reset even when it's not used, and
683 * that can mess up tests, e.g. -boot once.
685 for (i = 0; i < ARRAY_SIZE(irq_levels); i++) {
688 qemu_gettimeofday(&start_time);
691 fprintf(qtest_log_fp, "[I " FMT_timeval "] OPENED\n",
692 (long) start_time.tv_sec, (long) start_time.tv_usec);
695 case CHR_EVENT_CLOSED:
696 qtest_opened = false;
700 fprintf(qtest_log_fp, "[I +" FMT_timeval "] CLOSED\n",
701 (long) tv.tv_sec, (long) tv.tv_usec);
709 static int qtest_init_accel(MachineState *ms)
711 QemuOpts *opts = qemu_opts_create(qemu_find_opts("icount"), NULL, 0,
713 qemu_opt_set(opts, "shift", "0", &error_abort);
714 configure_icount(opts, &error_abort);
719 void qtest_init(const char *qtest_chrdev, const char *qtest_log, Error **errp)
723 chr = qemu_chr_new("qtest", qtest_chrdev);
726 error_setg(errp, "Failed to initialize device for qtest: \"%s\"",
732 if (strcmp(qtest_log, "none") != 0) {
733 qtest_log_fp = fopen(qtest_log, "w+");
736 qtest_log_fp = stderr;
739 qemu_chr_fe_init(&qtest_chr, chr, errp);
740 qemu_chr_fe_set_handlers(&qtest_chr, qtest_can_read, qtest_read,
741 qtest_event, NULL, &qtest_chr, NULL, true);
742 qemu_chr_fe_set_echo(&qtest_chr, true);
744 inbuf = g_string_new("");
747 bool qtest_driver(void)
749 return qtest_chr.chr != NULL;
752 static void qtest_accel_class_init(ObjectClass *oc, void *data)
754 AccelClass *ac = ACCEL_CLASS(oc);
756 ac->available = qtest_available;
757 ac->init_machine = qtest_init_accel;
758 ac->allowed = &qtest_allowed;
761 #define TYPE_QTEST_ACCEL ACCEL_CLASS_NAME("qtest")
763 static const TypeInfo qtest_accel_type = {
764 .name = TYPE_QTEST_ACCEL,
765 .parent = TYPE_ACCEL,
766 .class_init = qtest_accel_class_init,
769 static void qtest_type_init(void)
771 type_register_static(&qtest_accel_type);
774 type_init(qtest_type_init);