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 "sysemu/qtest.h"
16 #include "sysemu/char.h"
17 #include "exec/ioport.h"
18 #include "exec/memory.h"
20 #include "sysemu/accel.h"
21 #include "sysemu/sysemu.h"
22 #include "sysemu/cpus.h"
23 #include "qemu/config-file.h"
24 #include "qemu/option.h"
25 #include "qemu/error-report.h"
31 static DeviceState *irq_intercept_dev;
32 static FILE *qtest_log_fp;
33 static CharDriverState *qtest_chr;
34 static GString *inbuf;
35 static int irq_levels[MAX_IRQ];
36 static qemu_timeval start_time;
37 static bool qtest_opened;
39 #define FMT_timeval "%ld.%06ld"
44 * Line based protocol, request/response based. Server can send async messages
45 * so clients should always handle many async messages before the response
52 * The qtest client is completely in charge of the QEMU_CLOCK_VIRTUAL. qtest commands
53 * let you adjust the value of the clock (monotonically). All the commands
54 * return the current value of the clock in nanoseconds.
59 * Advance the clock to the next deadline. Useful when waiting for
60 * asynchronous events.
65 * Advance the clock by NS nanoseconds.
70 * Advance the clock to NS nanoseconds (do nothing if it's already past).
72 * PIO and memory access:
101 * > writeq ADDR VALUE
119 * > write ADDR SIZE DATA
122 * > b64read ADDR SIZE
125 * > b64write ADDR SIZE B64_DATA
128 * > memset ADDR SIZE VALUE
131 * ADDR, SIZE, VALUE are all integers parsed with strtoul() with a base of 0.
133 * DATA is an arbitrarily long hex number prefixed with '0x'. If it's smaller
134 * than the expected size, the value will be zero filled at the end of the data
137 * B64_DATA is an arbitrarily long base64 encoded string.
138 * If the sizes do not match, the data will be truncated.
142 * > irq_intercept_in QOM-PATH
145 * > irq_intercept_out QOM-PATH
148 * Attach to the gpio-in (resp. gpio-out) pins exported by the device at
149 * QOM-PATH. When the pin is triggered, one of the following async messages
150 * will be printed to the qtest stream:
155 * where NUM is an IRQ number. For the PC, interrupts can be intercepted
156 * simply with "irq_intercept_in ioapic" (note that IRQ0 comes out with
157 * NUM=0 even though it is remapped to GSI 2).
160 static int hex2nib(char ch)
162 if (ch >= '0' && ch <= '9') {
164 } else if (ch >= 'a' && ch <= 'f') {
165 return 10 + (ch - 'a');
166 } else if (ch >= 'A' && ch <= 'F') {
167 return 10 + (ch - 'A');
173 static void qtest_get_time(qemu_timeval *tv)
175 qemu_gettimeofday(tv);
176 tv->tv_sec -= start_time.tv_sec;
177 tv->tv_usec -= start_time.tv_usec;
178 if (tv->tv_usec < 0) {
179 tv->tv_usec += 1000000;
184 static void qtest_send_prefix(CharDriverState *chr)
188 if (!qtest_log_fp || !qtest_opened) {
193 fprintf(qtest_log_fp, "[S +" FMT_timeval "] ",
194 (long) tv.tv_sec, (long) tv.tv_usec);
197 static void GCC_FMT_ATTR(1, 2) qtest_log_send(const char *fmt, ...)
201 if (!qtest_log_fp || !qtest_opened) {
205 qtest_send_prefix(NULL);
208 vfprintf(qtest_log_fp, fmt, ap);
212 static void do_qtest_send(CharDriverState *chr, const char *str, size_t len)
214 qemu_chr_fe_write_all(chr, (uint8_t *)str, len);
215 if (qtest_log_fp && qtest_opened) {
216 fprintf(qtest_log_fp, "%s", str);
220 static void qtest_send(CharDriverState *chr, const char *str)
222 do_qtest_send(chr, str, strlen(str));
225 static void GCC_FMT_ATTR(2, 3) qtest_sendf(CharDriverState *chr,
226 const char *fmt, ...)
232 buffer = g_strdup_vprintf(fmt, ap);
233 qtest_send(chr, buffer);
237 static void qtest_irq_handler(void *opaque, int n, int level)
239 qemu_irq old_irq = *(qemu_irq *)opaque;
240 qemu_set_irq(old_irq, level);
242 if (irq_levels[n] != level) {
243 CharDriverState *chr = qtest_chr;
244 irq_levels[n] = level;
245 qtest_send_prefix(chr);
246 qtest_sendf(chr, "IRQ %s %d\n",
247 level ? "raise" : "lower", n);
251 static void qtest_process_command(CharDriverState *chr, gchar **words)
253 const gchar *command;
264 fprintf(qtest_log_fp, "[R +" FMT_timeval "]",
265 (long) tv.tv_sec, (long) tv.tv_usec);
266 for (i = 0; words[i]; i++) {
267 fprintf(qtest_log_fp, " %s", words[i]);
269 fprintf(qtest_log_fp, "\n");
273 if (strcmp(words[0], "irq_intercept_out") == 0
274 || strcmp(words[0], "irq_intercept_in") == 0) {
279 dev = DEVICE(object_resolve_path(words[1], NULL));
281 qtest_send_prefix(chr);
282 qtest_send(chr, "FAIL Unknown device\n");
286 if (irq_intercept_dev) {
287 qtest_send_prefix(chr);
288 if (irq_intercept_dev != dev) {
289 qtest_send(chr, "FAIL IRQ intercept already enabled\n");
291 qtest_send(chr, "OK\n");
296 QLIST_FOREACH(ngl, &dev->gpios, node) {
297 /* We don't support intercept of named GPIOs yet */
301 if (words[0][14] == 'o') {
303 for (i = 0; i < ngl->num_out; ++i) {
304 qemu_irq *disconnected = g_new0(qemu_irq, 1);
305 qemu_irq icpt = qemu_allocate_irq(qtest_irq_handler,
308 *disconnected = qdev_intercept_gpio_out(dev, icpt,
312 qemu_irq_intercept_in(ngl->in, qtest_irq_handler,
316 irq_intercept_dev = dev;
317 qtest_send_prefix(chr);
318 qtest_send(chr, "OK\n");
320 } else if (strcmp(words[0], "outb") == 0 ||
321 strcmp(words[0], "outw") == 0 ||
322 strcmp(words[0], "outl") == 0) {
326 g_assert(words[1] && words[2]);
327 addr = strtoul(words[1], NULL, 0);
328 value = strtoul(words[2], NULL, 0);
330 if (words[0][3] == 'b') {
331 cpu_outb(addr, value);
332 } else if (words[0][3] == 'w') {
333 cpu_outw(addr, value);
334 } else if (words[0][3] == 'l') {
335 cpu_outl(addr, value);
337 qtest_send_prefix(chr);
338 qtest_send(chr, "OK\n");
339 } else if (strcmp(words[0], "inb") == 0 ||
340 strcmp(words[0], "inw") == 0 ||
341 strcmp(words[0], "inl") == 0) {
343 uint32_t value = -1U;
346 addr = strtoul(words[1], NULL, 0);
348 if (words[0][2] == 'b') {
349 value = cpu_inb(addr);
350 } else if (words[0][2] == 'w') {
351 value = cpu_inw(addr);
352 } else if (words[0][2] == 'l') {
353 value = cpu_inl(addr);
355 qtest_send_prefix(chr);
356 qtest_sendf(chr, "OK 0x%04x\n", value);
357 } else if (strcmp(words[0], "writeb") == 0 ||
358 strcmp(words[0], "writew") == 0 ||
359 strcmp(words[0], "writel") == 0 ||
360 strcmp(words[0], "writeq") == 0) {
364 g_assert(words[1] && words[2]);
365 addr = strtoull(words[1], NULL, 0);
366 value = strtoull(words[2], NULL, 0);
368 if (words[0][5] == 'b') {
369 uint8_t data = value;
370 cpu_physical_memory_write(addr, &data, 1);
371 } else if (words[0][5] == 'w') {
372 uint16_t data = value;
374 cpu_physical_memory_write(addr, &data, 2);
375 } else if (words[0][5] == 'l') {
376 uint32_t data = value;
378 cpu_physical_memory_write(addr, &data, 4);
379 } else if (words[0][5] == 'q') {
380 uint64_t data = value;
382 cpu_physical_memory_write(addr, &data, 8);
384 qtest_send_prefix(chr);
385 qtest_send(chr, "OK\n");
386 } else if (strcmp(words[0], "readb") == 0 ||
387 strcmp(words[0], "readw") == 0 ||
388 strcmp(words[0], "readl") == 0 ||
389 strcmp(words[0], "readq") == 0) {
391 uint64_t value = UINT64_C(-1);
394 addr = strtoull(words[1], NULL, 0);
396 if (words[0][4] == 'b') {
398 cpu_physical_memory_read(addr, &data, 1);
400 } else if (words[0][4] == 'w') {
402 cpu_physical_memory_read(addr, &data, 2);
403 value = tswap16(data);
404 } else if (words[0][4] == 'l') {
406 cpu_physical_memory_read(addr, &data, 4);
407 value = tswap32(data);
408 } else if (words[0][4] == 'q') {
409 cpu_physical_memory_read(addr, &value, 8);
412 qtest_send_prefix(chr);
413 qtest_sendf(chr, "OK 0x%016" PRIx64 "\n", value);
414 } else if (strcmp(words[0], "read") == 0) {
415 uint64_t addr, len, i;
419 g_assert(words[1] && words[2]);
420 addr = strtoull(words[1], NULL, 0);
421 len = strtoull(words[2], NULL, 0);
423 data = g_malloc(len);
424 cpu_physical_memory_read(addr, data, len);
426 enc = g_malloc(2 * len + 1);
427 for (i = 0; i < len; i++) {
428 sprintf(&enc[i * 2], "%02x", data[i]);
431 qtest_send_prefix(chr);
432 qtest_sendf(chr, "OK 0x%s\n", enc);
436 } else if (strcmp(words[0], "b64read") == 0) {
441 g_assert(words[1] && words[2]);
442 addr = strtoull(words[1], NULL, 0);
443 len = strtoull(words[2], NULL, 0);
445 data = g_malloc(len);
446 cpu_physical_memory_read(addr, data, len);
447 b64_data = g_base64_encode(data, len);
448 qtest_send_prefix(chr);
449 qtest_sendf(chr, "OK %s\n", b64_data);
453 } else if (strcmp(words[0], "write") == 0) {
454 uint64_t addr, len, i;
458 g_assert(words[1] && words[2] && words[3]);
459 addr = strtoull(words[1], NULL, 0);
460 len = strtoull(words[2], NULL, 0);
462 data_len = strlen(words[3]);
464 qtest_send(chr, "ERR invalid argument size\n");
468 data = g_malloc(len);
469 for (i = 0; i < len; i++) {
470 if ((i * 2 + 4) <= data_len) {
471 data[i] = hex2nib(words[3][i * 2 + 2]) << 4;
472 data[i] |= hex2nib(words[3][i * 2 + 3]);
477 cpu_physical_memory_write(addr, data, len);
480 qtest_send_prefix(chr);
481 qtest_send(chr, "OK\n");
482 } else if (strcmp(words[0], "memset") == 0) {
487 g_assert(words[1] && words[2] && words[3]);
488 addr = strtoull(words[1], NULL, 0);
489 len = strtoull(words[2], NULL, 0);
490 pattern = strtoull(words[3], NULL, 0);
492 data = g_malloc(len);
493 memset(data, pattern, len);
494 cpu_physical_memory_write(addr, data, len);
497 qtest_send_prefix(chr);
498 qtest_send(chr, "OK\n");
499 } else if (strcmp(words[0], "b64write") == 0) {
505 g_assert(words[1] && words[2] && words[3]);
506 addr = strtoull(words[1], NULL, 0);
507 len = strtoull(words[2], NULL, 0);
509 data_len = strlen(words[3]);
511 qtest_send(chr, "ERR invalid argument size\n");
515 data = g_base64_decode_inplace(words[3], &out_len);
516 if (out_len != len) {
517 qtest_log_send("b64write: data length mismatch (told %"PRIu64", "
520 out_len = MIN(out_len, len);
523 cpu_physical_memory_write(addr, data, out_len);
525 qtest_send_prefix(chr);
526 qtest_send(chr, "OK\n");
527 } else if (qtest_enabled() && strcmp(words[0], "clock_step") == 0) {
531 ns = strtoll(words[1], NULL, 0);
533 ns = qemu_clock_deadline_ns_all(QEMU_CLOCK_VIRTUAL);
535 qtest_clock_warp(qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) + ns);
536 qtest_send_prefix(chr);
537 qtest_sendf(chr, "OK %"PRIi64"\n",
538 (int64_t)qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL));
539 } else if (qtest_enabled() && strcmp(words[0], "clock_set") == 0) {
543 ns = strtoll(words[1], NULL, 0);
544 qtest_clock_warp(ns);
545 qtest_send_prefix(chr);
546 qtest_sendf(chr, "OK %"PRIi64"\n",
547 (int64_t)qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL));
549 qtest_send_prefix(chr);
550 qtest_sendf(chr, "FAIL Unknown command '%s'\n", words[0]);
554 static void qtest_process_inbuf(CharDriverState *chr, GString *inbuf)
558 while ((end = strchr(inbuf->str, '\n')) != NULL) {
563 offset = end - inbuf->str;
565 cmd = g_string_new_len(inbuf->str, offset);
566 g_string_erase(inbuf, 0, offset + 1);
568 words = g_strsplit(cmd->str, " ", 0);
569 qtest_process_command(chr, words);
572 g_string_free(cmd, TRUE);
576 static void qtest_read(void *opaque, const uint8_t *buf, int size)
578 CharDriverState *chr = opaque;
580 g_string_append_len(inbuf, (const gchar *)buf, size);
581 qtest_process_inbuf(chr, inbuf);
584 static int qtest_can_read(void *opaque)
589 static void qtest_event(void *opaque, int event)
594 case CHR_EVENT_OPENED:
596 * We used to call qemu_system_reset() here, hoping we could
597 * use the same process for multiple tests that way. Never
598 * used. Injects an extra reset even when it's not used, and
599 * that can mess up tests, e.g. -boot once.
601 for (i = 0; i < ARRAY_SIZE(irq_levels); i++) {
604 qemu_gettimeofday(&start_time);
607 fprintf(qtest_log_fp, "[I " FMT_timeval "] OPENED\n",
608 (long) start_time.tv_sec, (long) start_time.tv_usec);
611 case CHR_EVENT_CLOSED:
612 qtest_opened = false;
616 fprintf(qtest_log_fp, "[I +" FMT_timeval "] CLOSED\n",
617 (long) tv.tv_sec, (long) tv.tv_usec);
625 static int qtest_init_accel(MachineState *ms)
627 QemuOpts *opts = qemu_opts_create(qemu_find_opts("icount"), NULL, 0,
629 qemu_opt_set(opts, "shift", "0", &error_abort);
630 configure_icount(opts, &error_abort);
635 void qtest_init(const char *qtest_chrdev, const char *qtest_log, Error **errp)
637 CharDriverState *chr;
639 chr = qemu_chr_new("qtest", qtest_chrdev, NULL);
642 error_setg(errp, "Failed to initialize device for qtest: \"%s\"",
648 if (strcmp(qtest_log, "none") != 0) {
649 qtest_log_fp = fopen(qtest_log, "w+");
652 qtest_log_fp = stderr;
655 qemu_chr_add_handlers(chr, qtest_can_read, qtest_read, qtest_event, chr);
656 qemu_chr_fe_set_echo(chr, true);
658 inbuf = g_string_new("");
662 bool qtest_driver(void)
667 static void qtest_accel_class_init(ObjectClass *oc, void *data)
669 AccelClass *ac = ACCEL_CLASS(oc);
671 ac->available = qtest_available;
672 ac->init_machine = qtest_init_accel;
673 ac->allowed = &qtest_allowed;
676 #define TYPE_QTEST_ACCEL ACCEL_CLASS_NAME("qtest")
678 static const TypeInfo qtest_accel_type = {
679 .name = TYPE_QTEST_ACCEL,
680 .parent = TYPE_ACCEL,
681 .class_init = qtest_accel_class_init,
684 static void qtest_type_init(void)
686 type_register_static(&qtest_accel_type);
689 type_init(qtest_type_init);