2012-03-28 15:42:05 +02:00
|
|
|
/*
|
|
|
|
* QTest
|
|
|
|
*
|
|
|
|
* Copyright IBM, Corp. 2012
|
|
|
|
* Copyright Red Hat, Inc. 2012
|
2013-02-16 22:44:03 +01:00
|
|
|
* Copyright SUSE LINUX Products GmbH 2013
|
2012-03-28 15:42:05 +02:00
|
|
|
*
|
|
|
|
* Authors:
|
|
|
|
* Anthony Liguori <aliguori@us.ibm.com>
|
|
|
|
* Paolo Bonzini <pbonzini@redhat.com>
|
2013-02-16 22:44:03 +01:00
|
|
|
* Andreas Färber <afaerber@suse.de>
|
2012-03-28 15:42:05 +02:00
|
|
|
*
|
|
|
|
* This work is licensed under the terms of the GNU GPL, version 2 or later.
|
|
|
|
* See the COPYING file in the top-level directory.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
#ifndef LIBQTEST_H
|
|
|
|
#define LIBQTEST_H
|
|
|
|
|
2018-11-29 12:51:08 +01:00
|
|
|
#include "qapi/qmp/qobject.h"
|
|
|
|
#include "qapi/qmp/qdict.h"
|
2022-03-30 11:34:11 +02:00
|
|
|
#include "libqmp.h"
|
2018-11-29 12:51:08 +01:00
|
|
|
|
2012-03-28 15:42:05 +02:00
|
|
|
typedef struct QTestState QTestState;
|
|
|
|
|
2017-10-18 16:20:27 +02:00
|
|
|
/**
|
2018-08-06 08:53:43 +02:00
|
|
|
* qtest_initf:
|
2020-10-05 22:52:28 +02:00
|
|
|
* @fmt: Format for creating other arguments to pass to QEMU, formatted
|
2017-10-18 16:20:27 +02:00
|
|
|
* like sprintf().
|
|
|
|
*
|
2019-05-13 17:45:09 +02:00
|
|
|
* Convenience wrapper around qtest_init().
|
2017-10-18 16:20:27 +02:00
|
|
|
*
|
|
|
|
* Returns: #QTestState instance.
|
|
|
|
*/
|
2022-02-20 17:39:25 +01:00
|
|
|
QTestState *qtest_initf(const char *fmt, ...) G_GNUC_PRINTF(1, 2);
|
2017-10-18 16:20:27 +02:00
|
|
|
|
|
|
|
/**
|
2018-08-06 08:53:43 +02:00
|
|
|
* qtest_vinitf:
|
2017-10-18 16:20:27 +02:00
|
|
|
* @fmt: Format for creating other arguments to pass to QEMU, formatted
|
|
|
|
* like vsprintf().
|
|
|
|
* @ap: Format arguments.
|
|
|
|
*
|
2019-05-13 17:45:09 +02:00
|
|
|
* Convenience wrapper around qtest_init().
|
2017-10-18 16:20:27 +02:00
|
|
|
*
|
|
|
|
* Returns: #QTestState instance.
|
|
|
|
*/
|
2022-02-20 17:39:25 +01:00
|
|
|
QTestState *qtest_vinitf(const char *fmt, va_list ap) G_GNUC_PRINTF(1, 0);
|
2017-10-18 16:20:27 +02:00
|
|
|
|
2012-03-28 15:42:05 +02:00
|
|
|
/**
|
|
|
|
* qtest_init:
|
2018-08-06 08:53:43 +02:00
|
|
|
* @extra_args: other arguments to pass to QEMU. CAUTION: these
|
|
|
|
* arguments are subject to word splitting and shell evaluation.
|
2013-02-16 22:44:01 +01:00
|
|
|
*
|
|
|
|
* Returns: #QTestState instance.
|
2012-03-28 15:42:05 +02:00
|
|
|
*/
|
|
|
|
QTestState *qtest_init(const char *extra_args);
|
|
|
|
|
2017-03-03 13:32:23 +01:00
|
|
|
/**
|
|
|
|
* qtest_init_without_qmp_handshake:
|
2018-03-27 03:36:19 +02:00
|
|
|
* @extra_args: other arguments to pass to QEMU. CAUTION: these
|
|
|
|
* arguments are subject to word splitting and shell evaluation.
|
2017-03-03 13:32:23 +01:00
|
|
|
*
|
|
|
|
* Returns: #QTestState instance.
|
|
|
|
*/
|
2018-10-09 08:27:16 +02:00
|
|
|
QTestState *qtest_init_without_qmp_handshake(const char *extra_args);
|
2017-03-03 13:32:23 +01:00
|
|
|
|
2019-01-29 12:46:04 +01:00
|
|
|
/**
|
|
|
|
* qtest_init_with_serial:
|
|
|
|
* @extra_args: other arguments to pass to QEMU. CAUTION: these
|
|
|
|
* arguments are subject to word splitting and shell evaluation.
|
|
|
|
* @sock_fd: pointer to store the socket file descriptor for
|
|
|
|
* connection with serial.
|
|
|
|
*
|
|
|
|
* Returns: #QTestState instance.
|
|
|
|
*/
|
|
|
|
QTestState *qtest_init_with_serial(const char *extra_args, int *sock_fd);
|
|
|
|
|
2021-02-23 15:46:44 +01:00
|
|
|
/**
|
|
|
|
* qtest_kill_qemu:
|
|
|
|
* @s: #QTestState instance to operate on.
|
|
|
|
*
|
|
|
|
* Kill the QEMU process and wait for it to terminate. It is safe to call this
|
|
|
|
* function multiple times. Normally qtest_quit() is used instead because it
|
|
|
|
* also frees QTestState. Use qtest_kill_qemu() when you just want to kill QEMU
|
|
|
|
* and qtest_quit() will be called later.
|
|
|
|
*/
|
|
|
|
void qtest_kill_qemu(QTestState *s);
|
|
|
|
|
2012-03-28 15:42:05 +02:00
|
|
|
/**
|
|
|
|
* qtest_quit:
|
2013-02-16 22:44:01 +01:00
|
|
|
* @s: #QTestState instance to operate on.
|
2012-03-28 15:42:05 +02:00
|
|
|
*
|
|
|
|
* Shut down the QEMU process associated to @s.
|
|
|
|
*/
|
|
|
|
void qtest_quit(QTestState *s);
|
|
|
|
|
2019-05-28 11:16:33 +02:00
|
|
|
/**
|
|
|
|
* qtest_qmp_fds:
|
|
|
|
* @s: #QTestState instance to operate on.
|
|
|
|
* @fds: array of file descriptors
|
|
|
|
* @fds_num: number of elements in @fds
|
2020-10-05 22:52:28 +02:00
|
|
|
* @fmt: QMP message to send to qemu, formatted like
|
2020-11-09 17:26:21 +01:00
|
|
|
* qobject_from_jsonf_nofail(). See parse_interpolation() for what's
|
2019-05-28 11:16:33 +02:00
|
|
|
* supported after '%'.
|
|
|
|
*
|
|
|
|
* Sends a QMP message to QEMU with fds and returns the response.
|
|
|
|
*/
|
|
|
|
QDict *qtest_qmp_fds(QTestState *s, int *fds, size_t fds_num,
|
|
|
|
const char *fmt, ...)
|
2022-02-20 17:39:25 +01:00
|
|
|
G_GNUC_PRINTF(4, 5);
|
2019-05-28 11:16:33 +02:00
|
|
|
|
2013-10-30 14:54:33 +01:00
|
|
|
/**
|
|
|
|
* qtest_qmp:
|
|
|
|
* @s: #QTestState instance to operate on.
|
2020-10-05 22:52:28 +02:00
|
|
|
* @fmt: QMP message to send to qemu, formatted like
|
2020-11-09 17:26:21 +01:00
|
|
|
* qobject_from_jsonf_nofail(). See parse_interpolation() for what's
|
2018-08-06 08:53:27 +02:00
|
|
|
* supported after '%'.
|
2013-10-30 14:54:33 +01:00
|
|
|
*
|
|
|
|
* Sends a QMP message to QEMU and returns the response.
|
|
|
|
*/
|
2018-08-06 08:53:42 +02:00
|
|
|
QDict *qtest_qmp(QTestState *s, const char *fmt, ...)
|
2022-02-20 17:39:25 +01:00
|
|
|
G_GNUC_PRINTF(2, 3);
|
2013-10-30 14:54:33 +01:00
|
|
|
|
2015-04-28 21:27:51 +02:00
|
|
|
/**
|
2018-08-06 08:53:22 +02:00
|
|
|
* qtest_qmp_send:
|
2015-04-28 21:27:51 +02:00
|
|
|
* @s: #QTestState instance to operate on.
|
2020-10-05 22:52:28 +02:00
|
|
|
* @fmt: QMP message to send to qemu, formatted like
|
2020-11-09 17:26:21 +01:00
|
|
|
* qobject_from_jsonf_nofail(). See parse_interpolation() for what's
|
2018-08-06 08:53:27 +02:00
|
|
|
* supported after '%'.
|
2015-04-28 21:27:51 +02:00
|
|
|
*
|
|
|
|
* Sends a QMP message to QEMU and leaves the response in the stream.
|
|
|
|
*/
|
2018-08-06 08:53:42 +02:00
|
|
|
void qtest_qmp_send(QTestState *s, const char *fmt, ...)
|
2022-02-20 17:39:25 +01:00
|
|
|
G_GNUC_PRINTF(2, 3);
|
2015-04-28 21:27:51 +02:00
|
|
|
|
2018-08-23 18:39:33 +02:00
|
|
|
/**
|
|
|
|
* qtest_qmp_send_raw:
|
|
|
|
* @s: #QTestState instance to operate on.
|
2020-10-05 22:52:28 +02:00
|
|
|
* @fmt: text to send, formatted like sprintf()
|
2018-08-23 18:39:33 +02:00
|
|
|
*
|
|
|
|
* Sends text to the QMP monitor verbatim. Need not be valid JSON;
|
|
|
|
* this is useful for negative tests.
|
|
|
|
*/
|
|
|
|
void qtest_qmp_send_raw(QTestState *s, const char *fmt, ...)
|
2022-02-20 17:39:25 +01:00
|
|
|
G_GNUC_PRINTF(2, 3);
|
2018-08-23 18:39:33 +02:00
|
|
|
|
2021-02-23 15:46:43 +01:00
|
|
|
/**
|
|
|
|
* qtest_socket_server:
|
|
|
|
* @socket_path: the UNIX domain socket path
|
|
|
|
*
|
|
|
|
* Create and return a listen socket file descriptor, or abort on failure.
|
|
|
|
*/
|
|
|
|
int qtest_socket_server(const char *socket_path);
|
|
|
|
|
2013-10-30 14:54:33 +01:00
|
|
|
/**
|
2019-05-28 11:16:33 +02:00
|
|
|
* qtest_vqmp_fds:
|
|
|
|
* @s: #QTestState instance to operate on.
|
|
|
|
* @fds: array of file descriptors
|
|
|
|
* @fds_num: number of elements in @fds
|
|
|
|
* @fmt: QMP message to send to QEMU, formatted like
|
2020-11-09 17:26:21 +01:00
|
|
|
* qobject_from_jsonf_nofail(). See parse_interpolation() for what's
|
2019-05-28 11:16:33 +02:00
|
|
|
* supported after '%'.
|
|
|
|
* @ap: QMP message arguments
|
|
|
|
*
|
|
|
|
* Sends a QMP message to QEMU with fds and returns the response.
|
|
|
|
*/
|
|
|
|
QDict *qtest_vqmp_fds(QTestState *s, int *fds, size_t fds_num,
|
|
|
|
const char *fmt, va_list ap)
|
2022-02-20 17:39:25 +01:00
|
|
|
G_GNUC_PRINTF(4, 0);
|
2019-05-28 11:16:33 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* qtest_vqmp:
|
2013-10-30 14:54:33 +01:00
|
|
|
* @s: #QTestState instance to operate on.
|
2018-08-06 08:53:26 +02:00
|
|
|
* @fmt: QMP message to send to QEMU, formatted like
|
2020-11-09 17:26:21 +01:00
|
|
|
* qobject_from_jsonf_nofail(). See parse_interpolation() for what's
|
2018-08-06 08:53:27 +02:00
|
|
|
* supported after '%'.
|
2013-10-30 14:54:33 +01:00
|
|
|
* @ap: QMP message arguments
|
|
|
|
*
|
|
|
|
* Sends a QMP message to QEMU and returns the response.
|
|
|
|
*/
|
2018-08-06 08:53:44 +02:00
|
|
|
QDict *qtest_vqmp(QTestState *s, const char *fmt, va_list ap)
|
2022-02-20 17:39:25 +01:00
|
|
|
G_GNUC_PRINTF(2, 0);
|
2013-10-30 14:54:33 +01:00
|
|
|
|
2019-05-28 11:16:33 +02:00
|
|
|
/**
|
|
|
|
* qtest_qmp_vsend_fds:
|
|
|
|
* @s: #QTestState instance to operate on.
|
|
|
|
* @fds: array of file descriptors
|
|
|
|
* @fds_num: number of elements in @fds
|
|
|
|
* @fmt: QMP message to send to QEMU, formatted like
|
2020-11-09 17:26:21 +01:00
|
|
|
* qobject_from_jsonf_nofail(). See parse_interpolation() for what's
|
2019-05-28 11:16:33 +02:00
|
|
|
* supported after '%'.
|
|
|
|
* @ap: QMP message arguments
|
|
|
|
*
|
|
|
|
* Sends a QMP message to QEMU and leaves the response in the stream.
|
|
|
|
*/
|
|
|
|
void qtest_qmp_vsend_fds(QTestState *s, int *fds, size_t fds_num,
|
|
|
|
const char *fmt, va_list ap)
|
2022-02-20 17:39:25 +01:00
|
|
|
G_GNUC_PRINTF(4, 0);
|
2019-05-28 11:16:33 +02:00
|
|
|
|
2015-04-28 21:27:51 +02:00
|
|
|
/**
|
2018-08-06 08:53:22 +02:00
|
|
|
* qtest_qmp_vsend:
|
2015-04-28 21:27:51 +02:00
|
|
|
* @s: #QTestState instance to operate on.
|
2018-08-06 08:53:26 +02:00
|
|
|
* @fmt: QMP message to send to QEMU, formatted like
|
2020-11-09 17:26:21 +01:00
|
|
|
* qobject_from_jsonf_nofail(). See parse_interpolation() for what's
|
2018-08-06 08:53:27 +02:00
|
|
|
* supported after '%'.
|
2015-04-28 21:27:51 +02:00
|
|
|
* @ap: QMP message arguments
|
|
|
|
*
|
|
|
|
* Sends a QMP message to QEMU and leaves the response in the stream.
|
|
|
|
*/
|
2018-08-06 08:53:42 +02:00
|
|
|
void qtest_qmp_vsend(QTestState *s, const char *fmt, va_list ap)
|
2022-02-20 17:39:25 +01:00
|
|
|
G_GNUC_PRINTF(2, 0);
|
2015-04-28 21:27:51 +02:00
|
|
|
|
2014-02-21 20:55:30 +01:00
|
|
|
/**
|
2020-10-06 14:38:52 +02:00
|
|
|
* qtest_qmp_receive_dict:
|
2014-02-21 20:55:30 +01:00
|
|
|
* @s: #QTestState instance to operate on.
|
|
|
|
*
|
|
|
|
* Reads a QMP message from QEMU and returns the response.
|
|
|
|
*/
|
2020-10-06 14:38:52 +02:00
|
|
|
QDict *qtest_qmp_receive_dict(QTestState *s);
|
2014-02-21 20:55:30 +01:00
|
|
|
|
2020-10-06 14:38:53 +02:00
|
|
|
/**
|
|
|
|
* qtest_qmp_receive:
|
|
|
|
* @s: #QTestState instance to operate on.
|
|
|
|
*
|
|
|
|
* Reads a QMP message from QEMU and returns the response.
|
|
|
|
* Buffers all the events received meanwhile, until a
|
|
|
|
* call to qtest_qmp_eventwait
|
|
|
|
*/
|
|
|
|
QDict *qtest_qmp_receive(QTestState *s);
|
|
|
|
|
2015-04-28 21:27:51 +02:00
|
|
|
/**
|
|
|
|
* qtest_qmp_eventwait:
|
|
|
|
* @s: #QTestState instance to operate on.
|
2020-10-05 22:52:28 +02:00
|
|
|
* @event: event to wait for.
|
2015-04-28 21:27:51 +02:00
|
|
|
*
|
2017-08-03 03:08:33 +02:00
|
|
|
* Continuously polls for QMP responses until it receives the desired event.
|
2015-04-28 21:27:51 +02:00
|
|
|
*/
|
|
|
|
void qtest_qmp_eventwait(QTestState *s, const char *event);
|
|
|
|
|
2016-11-14 17:15:54 +01:00
|
|
|
/**
|
|
|
|
* qtest_qmp_eventwait_ref:
|
|
|
|
* @s: #QTestState instance to operate on.
|
2020-10-05 22:52:28 +02:00
|
|
|
* @event: event to wait for.
|
2016-11-14 17:15:54 +01:00
|
|
|
*
|
2017-08-03 03:08:33 +02:00
|
|
|
* Continuously polls for QMP responses until it receives the desired event.
|
2016-11-14 17:15:54 +01:00
|
|
|
* Returns a copy of the event for further investigation.
|
|
|
|
*/
|
|
|
|
QDict *qtest_qmp_eventwait_ref(QTestState *s, const char *event);
|
|
|
|
|
2020-10-06 14:38:53 +02:00
|
|
|
/**
|
|
|
|
* qtest_qmp_event_ref:
|
|
|
|
* @s: #QTestState instance to operate on.
|
|
|
|
* @event: event to return.
|
|
|
|
*
|
|
|
|
* Removes non-matching events from the buffer that was set by
|
|
|
|
* qtest_qmp_receive, until an event bearing the given name is found,
|
|
|
|
* and returns it.
|
|
|
|
* If no event matches, clears the buffer and returns NULL.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
QDict *qtest_qmp_event_ref(QTestState *s, const char *event);
|
|
|
|
|
2015-10-01 10:59:55 +02:00
|
|
|
/**
|
2017-03-30 09:50:05 +02:00
|
|
|
* qtest_hmp:
|
2015-10-01 10:59:55 +02:00
|
|
|
* @s: #QTestState instance to operate on.
|
2020-10-05 22:52:28 +02:00
|
|
|
* @fmt: HMP command to send to QEMU, formats arguments like sprintf().
|
2015-10-01 10:59:55 +02:00
|
|
|
*
|
|
|
|
* Send HMP command to QEMU via QMP's human-monitor-command.
|
2017-03-30 09:50:05 +02:00
|
|
|
* QMP events are discarded.
|
2015-10-01 10:59:55 +02:00
|
|
|
*
|
|
|
|
* Returns: the command's output. The caller should g_free() it.
|
|
|
|
*/
|
2022-02-20 17:39:25 +01:00
|
|
|
char *qtest_hmp(QTestState *s, const char *fmt, ...) G_GNUC_PRINTF(2, 3);
|
2015-10-01 10:59:55 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* qtest_hmpv:
|
|
|
|
* @s: #QTestState instance to operate on.
|
2018-08-06 08:53:26 +02:00
|
|
|
* @fmt: HMP command to send to QEMU, formats arguments like vsprintf().
|
2015-10-01 10:59:55 +02:00
|
|
|
* @ap: HMP command arguments
|
|
|
|
*
|
|
|
|
* Send HMP command to QEMU via QMP's human-monitor-command.
|
2017-03-30 09:50:05 +02:00
|
|
|
* QMP events are discarded.
|
2015-10-01 10:59:55 +02:00
|
|
|
*
|
|
|
|
* Returns: the command's output. The caller should g_free() it.
|
|
|
|
*/
|
2018-08-06 08:53:44 +02:00
|
|
|
char *qtest_vhmp(QTestState *s, const char *fmt, va_list ap)
|
2022-02-20 17:39:25 +01:00
|
|
|
G_GNUC_PRINTF(2, 0);
|
2015-10-01 10:59:55 +02:00
|
|
|
|
2019-07-22 20:51:40 +02:00
|
|
|
void qtest_module_load(QTestState *s, const char *prefix, const char *libname);
|
|
|
|
|
2012-03-28 15:42:05 +02:00
|
|
|
/**
|
|
|
|
* qtest_get_irq:
|
2013-02-16 22:44:01 +01:00
|
|
|
* @s: #QTestState instance to operate on.
|
2012-03-28 15:42:05 +02:00
|
|
|
* @num: Interrupt to observe.
|
|
|
|
*
|
2013-02-16 22:44:01 +01:00
|
|
|
* Returns: The level of the @num interrupt.
|
2012-03-28 15:42:05 +02:00
|
|
|
*/
|
|
|
|
bool qtest_get_irq(QTestState *s, int num);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* qtest_irq_intercept_in:
|
2013-02-16 22:44:01 +01:00
|
|
|
* @s: #QTestState instance to operate on.
|
2012-03-28 15:42:05 +02:00
|
|
|
* @string: QOM path of a device.
|
|
|
|
*
|
|
|
|
* Associate qtest irqs with the GPIO-in pins of the device
|
|
|
|
* whose path is specified by @string.
|
|
|
|
*/
|
|
|
|
void qtest_irq_intercept_in(QTestState *s, const char *string);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* qtest_irq_intercept_out:
|
2013-02-16 22:44:01 +01:00
|
|
|
* @s: #QTestState instance to operate on.
|
2012-03-28 15:42:05 +02:00
|
|
|
* @string: QOM path of a device.
|
|
|
|
*
|
|
|
|
* Associate qtest irqs with the GPIO-out pins of the device
|
|
|
|
* whose path is specified by @string.
|
|
|
|
*/
|
|
|
|
void qtest_irq_intercept_out(QTestState *s, const char *string);
|
|
|
|
|
2019-01-07 16:23:47 +01:00
|
|
|
/**
|
|
|
|
* qtest_set_irq_in:
|
|
|
|
* @s: QTestState instance to operate on.
|
|
|
|
* @string: QOM path of a device
|
|
|
|
* @name: IRQ name
|
|
|
|
* @irq: IRQ number
|
|
|
|
* @level: IRQ level
|
|
|
|
*
|
|
|
|
* Force given device/irq GPIO-in pin to the given level.
|
|
|
|
*/
|
|
|
|
void qtest_set_irq_in(QTestState *s, const char *string, const char *name,
|
|
|
|
int irq, int level);
|
|
|
|
|
2012-03-28 15:42:05 +02:00
|
|
|
/**
|
|
|
|
* qtest_outb:
|
2013-02-16 22:44:01 +01:00
|
|
|
* @s: #QTestState instance to operate on.
|
2012-03-28 15:42:05 +02:00
|
|
|
* @addr: I/O port to write to.
|
|
|
|
* @value: Value being written.
|
|
|
|
*
|
|
|
|
* Write an 8-bit value to an I/O port.
|
|
|
|
*/
|
|
|
|
void qtest_outb(QTestState *s, uint16_t addr, uint8_t value);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* qtest_outw:
|
2013-02-16 22:44:01 +01:00
|
|
|
* @s: #QTestState instance to operate on.
|
2012-03-28 15:42:05 +02:00
|
|
|
* @addr: I/O port to write to.
|
|
|
|
* @value: Value being written.
|
|
|
|
*
|
|
|
|
* Write a 16-bit value to an I/O port.
|
|
|
|
*/
|
|
|
|
void qtest_outw(QTestState *s, uint16_t addr, uint16_t value);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* qtest_outl:
|
2013-02-16 22:44:01 +01:00
|
|
|
* @s: #QTestState instance to operate on.
|
2012-03-28 15:42:05 +02:00
|
|
|
* @addr: I/O port to write to.
|
|
|
|
* @value: Value being written.
|
|
|
|
*
|
|
|
|
* Write a 32-bit value to an I/O port.
|
|
|
|
*/
|
|
|
|
void qtest_outl(QTestState *s, uint16_t addr, uint32_t value);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* qtest_inb:
|
2013-02-16 22:44:01 +01:00
|
|
|
* @s: #QTestState instance to operate on.
|
2012-03-28 15:42:05 +02:00
|
|
|
* @addr: I/O port to read from.
|
|
|
|
*
|
|
|
|
* Returns an 8-bit value from an I/O port.
|
|
|
|
*/
|
|
|
|
uint8_t qtest_inb(QTestState *s, uint16_t addr);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* qtest_inw:
|
2013-02-16 22:44:01 +01:00
|
|
|
* @s: #QTestState instance to operate on.
|
2012-03-28 15:42:05 +02:00
|
|
|
* @addr: I/O port to read from.
|
|
|
|
*
|
|
|
|
* Returns a 16-bit value from an I/O port.
|
|
|
|
*/
|
|
|
|
uint16_t qtest_inw(QTestState *s, uint16_t addr);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* qtest_inl:
|
2013-02-16 22:44:01 +01:00
|
|
|
* @s: #QTestState instance to operate on.
|
2012-03-28 15:42:05 +02:00
|
|
|
* @addr: I/O port to read from.
|
|
|
|
*
|
|
|
|
* Returns a 32-bit value from an I/O port.
|
|
|
|
*/
|
|
|
|
uint32_t qtest_inl(QTestState *s, uint16_t addr);
|
|
|
|
|
2013-02-16 22:44:03 +01:00
|
|
|
/**
|
|
|
|
* qtest_writeb:
|
|
|
|
* @s: #QTestState instance to operate on.
|
|
|
|
* @addr: Guest address to write to.
|
|
|
|
* @value: Value being written.
|
|
|
|
*
|
|
|
|
* Writes an 8-bit value to memory.
|
|
|
|
*/
|
|
|
|
void qtest_writeb(QTestState *s, uint64_t addr, uint8_t value);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* qtest_writew:
|
|
|
|
* @s: #QTestState instance to operate on.
|
|
|
|
* @addr: Guest address to write to.
|
|
|
|
* @value: Value being written.
|
|
|
|
*
|
|
|
|
* Writes a 16-bit value to memory.
|
|
|
|
*/
|
|
|
|
void qtest_writew(QTestState *s, uint64_t addr, uint16_t value);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* qtest_writel:
|
|
|
|
* @s: #QTestState instance to operate on.
|
|
|
|
* @addr: Guest address to write to.
|
|
|
|
* @value: Value being written.
|
|
|
|
*
|
|
|
|
* Writes a 32-bit value to memory.
|
|
|
|
*/
|
|
|
|
void qtest_writel(QTestState *s, uint64_t addr, uint32_t value);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* qtest_writeq:
|
|
|
|
* @s: #QTestState instance to operate on.
|
|
|
|
* @addr: Guest address to write to.
|
|
|
|
* @value: Value being written.
|
|
|
|
*
|
|
|
|
* Writes a 64-bit value to memory.
|
|
|
|
*/
|
|
|
|
void qtest_writeq(QTestState *s, uint64_t addr, uint64_t value);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* qtest_readb:
|
|
|
|
* @s: #QTestState instance to operate on.
|
|
|
|
* @addr: Guest address to read from.
|
|
|
|
*
|
|
|
|
* Reads an 8-bit value from memory.
|
|
|
|
*
|
|
|
|
* Returns: Value read.
|
|
|
|
*/
|
|
|
|
uint8_t qtest_readb(QTestState *s, uint64_t addr);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* qtest_readw:
|
|
|
|
* @s: #QTestState instance to operate on.
|
|
|
|
* @addr: Guest address to read from.
|
|
|
|
*
|
|
|
|
* Reads a 16-bit value from memory.
|
|
|
|
*
|
|
|
|
* Returns: Value read.
|
|
|
|
*/
|
|
|
|
uint16_t qtest_readw(QTestState *s, uint64_t addr);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* qtest_readl:
|
|
|
|
* @s: #QTestState instance to operate on.
|
|
|
|
* @addr: Guest address to read from.
|
|
|
|
*
|
|
|
|
* Reads a 32-bit value from memory.
|
|
|
|
*
|
|
|
|
* Returns: Value read.
|
|
|
|
*/
|
|
|
|
uint32_t qtest_readl(QTestState *s, uint64_t addr);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* qtest_readq:
|
|
|
|
* @s: #QTestState instance to operate on.
|
|
|
|
* @addr: Guest address to read from.
|
|
|
|
*
|
|
|
|
* Reads a 64-bit value from memory.
|
|
|
|
*
|
|
|
|
* Returns: Value read.
|
|
|
|
*/
|
|
|
|
uint64_t qtest_readq(QTestState *s, uint64_t addr);
|
|
|
|
|
2012-03-28 15:42:05 +02:00
|
|
|
/**
|
|
|
|
* qtest_memread:
|
2013-02-16 22:44:01 +01:00
|
|
|
* @s: #QTestState instance to operate on.
|
2012-03-28 15:42:05 +02:00
|
|
|
* @addr: Guest address to read from.
|
|
|
|
* @data: Pointer to where memory contents will be stored.
|
|
|
|
* @size: Number of bytes to read.
|
|
|
|
*
|
|
|
|
* Read guest memory into a buffer.
|
|
|
|
*/
|
|
|
|
void qtest_memread(QTestState *s, uint64_t addr, void *data, size_t size);
|
|
|
|
|
2016-09-13 14:52:45 +02:00
|
|
|
/**
|
|
|
|
* qtest_rtas_call:
|
|
|
|
* @s: #QTestState instance to operate on.
|
|
|
|
* @name: name of the command to call.
|
|
|
|
* @nargs: Number of args.
|
|
|
|
* @args: Guest address to read args from.
|
|
|
|
* @nret: Number of return value.
|
|
|
|
* @ret: Guest address to write return values to.
|
|
|
|
*
|
|
|
|
* Call an RTAS function
|
|
|
|
*/
|
|
|
|
uint64_t qtest_rtas_call(QTestState *s, const char *name,
|
|
|
|
uint32_t nargs, uint64_t args,
|
|
|
|
uint32_t nret, uint64_t ret);
|
|
|
|
|
2015-05-22 20:13:44 +02:00
|
|
|
/**
|
|
|
|
* qtest_bufread:
|
|
|
|
* @s: #QTestState instance to operate on.
|
|
|
|
* @addr: Guest address to read from.
|
|
|
|
* @data: Pointer to where memory contents will be stored.
|
|
|
|
* @size: Number of bytes to read.
|
|
|
|
*
|
|
|
|
* Read guest memory into a buffer and receive using a base64 encoding.
|
|
|
|
*/
|
|
|
|
void qtest_bufread(QTestState *s, uint64_t addr, void *data, size_t size);
|
|
|
|
|
2012-03-28 15:42:05 +02:00
|
|
|
/**
|
|
|
|
* qtest_memwrite:
|
2013-02-16 22:44:01 +01:00
|
|
|
* @s: #QTestState instance to operate on.
|
2012-03-28 15:42:05 +02:00
|
|
|
* @addr: Guest address to write to.
|
|
|
|
* @data: Pointer to the bytes that will be written to guest memory.
|
|
|
|
* @size: Number of bytes to write.
|
|
|
|
*
|
|
|
|
* Write a buffer to guest memory.
|
|
|
|
*/
|
|
|
|
void qtest_memwrite(QTestState *s, uint64_t addr, const void *data, size_t size);
|
|
|
|
|
2015-05-22 20:13:44 +02:00
|
|
|
/**
|
|
|
|
* qtest_bufwrite:
|
|
|
|
* @s: #QTestState instance to operate on.
|
|
|
|
* @addr: Guest address to write to.
|
|
|
|
* @data: Pointer to the bytes that will be written to guest memory.
|
|
|
|
* @size: Number of bytes to write.
|
|
|
|
*
|
|
|
|
* Write a buffer to guest memory and transmit using a base64 encoding.
|
|
|
|
*/
|
|
|
|
void qtest_bufwrite(QTestState *s, uint64_t addr,
|
|
|
|
const void *data, size_t size);
|
|
|
|
|
2014-08-04 23:11:20 +02:00
|
|
|
/**
|
|
|
|
* qtest_memset:
|
|
|
|
* @s: #QTestState instance to operate on.
|
|
|
|
* @addr: Guest address to write to.
|
|
|
|
* @patt: Byte pattern to fill the guest memory region with.
|
|
|
|
* @size: Number of bytes to write.
|
|
|
|
*
|
|
|
|
* Write a pattern to guest memory.
|
|
|
|
*/
|
|
|
|
void qtest_memset(QTestState *s, uint64_t addr, uint8_t patt, size_t size);
|
|
|
|
|
2012-03-28 15:42:05 +02:00
|
|
|
/**
|
|
|
|
* qtest_clock_step_next:
|
2013-02-16 22:44:01 +01:00
|
|
|
* @s: #QTestState instance to operate on.
|
|
|
|
*
|
2013-08-21 17:03:08 +02:00
|
|
|
* Advance the QEMU_CLOCK_VIRTUAL to the next deadline.
|
2012-03-28 15:42:05 +02:00
|
|
|
*
|
2013-08-21 17:03:08 +02:00
|
|
|
* Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds.
|
2012-03-28 15:42:05 +02:00
|
|
|
*/
|
|
|
|
int64_t qtest_clock_step_next(QTestState *s);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* qtest_clock_step:
|
|
|
|
* @s: QTestState instance to operate on.
|
|
|
|
* @step: Number of nanoseconds to advance the clock by.
|
|
|
|
*
|
2013-08-21 17:03:08 +02:00
|
|
|
* Advance the QEMU_CLOCK_VIRTUAL by @step nanoseconds.
|
2013-02-16 22:44:01 +01:00
|
|
|
*
|
2013-08-21 17:03:08 +02:00
|
|
|
* Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds.
|
2012-03-28 15:42:05 +02:00
|
|
|
*/
|
|
|
|
int64_t qtest_clock_step(QTestState *s, int64_t step);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* qtest_clock_set:
|
|
|
|
* @s: QTestState instance to operate on.
|
|
|
|
* @val: Nanoseconds value to advance the clock to.
|
|
|
|
*
|
2013-08-21 17:03:08 +02:00
|
|
|
* Advance the QEMU_CLOCK_VIRTUAL to @val nanoseconds since the VM was launched.
|
2013-02-16 22:44:01 +01:00
|
|
|
*
|
2013-08-21 17:03:08 +02:00
|
|
|
* Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds.
|
2012-03-28 15:42:05 +02:00
|
|
|
*/
|
|
|
|
int64_t qtest_clock_set(QTestState *s, int64_t val);
|
|
|
|
|
2016-10-07 12:14:27 +02:00
|
|
|
/**
|
|
|
|
* qtest_big_endian:
|
|
|
|
* @s: QTestState instance to operate on.
|
|
|
|
*
|
|
|
|
* Returns: True if the architecture under test has a big endian configuration.
|
|
|
|
*/
|
|
|
|
bool qtest_big_endian(QTestState *s);
|
|
|
|
|
2012-03-28 15:42:05 +02:00
|
|
|
/**
|
|
|
|
* qtest_get_arch:
|
|
|
|
*
|
2013-02-16 22:44:01 +01:00
|
|
|
* Returns: The architecture for the QEMU executable under test.
|
2012-03-28 15:42:05 +02:00
|
|
|
*/
|
|
|
|
const char *qtest_get_arch(void);
|
|
|
|
|
2021-09-02 13:35:38 +02:00
|
|
|
/**
|
|
|
|
* qtest_has_accel:
|
|
|
|
* @accel_name: Accelerator name to check for.
|
|
|
|
*
|
|
|
|
* Returns: true if the accelerator is built in.
|
|
|
|
*/
|
|
|
|
bool qtest_has_accel(const char *accel_name);
|
|
|
|
|
2012-03-28 15:42:05 +02:00
|
|
|
/**
|
|
|
|
* qtest_add_func:
|
|
|
|
* @str: Test case path.
|
|
|
|
* @fn: Test case function
|
|
|
|
*
|
|
|
|
* Add a GTester testcase with the given name and function.
|
|
|
|
* The path is prefixed with the architecture under test, as
|
2013-02-16 22:44:01 +01:00
|
|
|
* returned by qtest_get_arch().
|
2012-03-28 15:42:05 +02:00
|
|
|
*/
|
2015-12-02 21:20:33 +01:00
|
|
|
void qtest_add_func(const char *str, void (*fn)(void));
|
2012-03-28 15:42:05 +02:00
|
|
|
|
2015-03-24 19:33:34 +01:00
|
|
|
/**
|
|
|
|
* qtest_add_data_func:
|
|
|
|
* @str: Test case path.
|
|
|
|
* @data: Test case data
|
|
|
|
* @fn: Test case function
|
|
|
|
*
|
|
|
|
* Add a GTester testcase with the given name, data and function.
|
|
|
|
* The path is prefixed with the architecture under test, as
|
|
|
|
* returned by qtest_get_arch().
|
|
|
|
*/
|
2015-12-02 21:20:33 +01:00
|
|
|
void qtest_add_data_func(const char *str, const void *data,
|
|
|
|
void (*fn)(const void *));
|
2015-03-24 19:33:34 +01:00
|
|
|
|
2016-07-19 13:42:01 +02:00
|
|
|
/**
|
|
|
|
* qtest_add_data_func_full:
|
|
|
|
* @str: Test case path.
|
|
|
|
* @data: Test case data
|
|
|
|
* @fn: Test case function
|
|
|
|
* @data_free_func: GDestroyNotify for data
|
|
|
|
*
|
|
|
|
* Add a GTester testcase with the given name, data and function.
|
|
|
|
* The path is prefixed with the architecture under test, as
|
|
|
|
* returned by qtest_get_arch().
|
|
|
|
*
|
|
|
|
* @data is passed to @data_free_func() on test completion.
|
|
|
|
*/
|
|
|
|
void qtest_add_data_func_full(const char *str, void *data,
|
|
|
|
void (*fn)(const void *),
|
|
|
|
GDestroyNotify data_free_func);
|
|
|
|
|
2015-03-25 16:52:45 +01:00
|
|
|
/**
|
|
|
|
* qtest_add:
|
|
|
|
* @testpath: Test case path
|
|
|
|
* @Fixture: Fixture type
|
|
|
|
* @tdata: Test case data
|
|
|
|
* @fsetup: Test case setup function
|
|
|
|
* @ftest: Test case function
|
|
|
|
* @fteardown: Test case teardown function
|
|
|
|
*
|
|
|
|
* Add a GTester testcase with the given name, data and functions.
|
|
|
|
* The path is prefixed with the architecture under test, as
|
|
|
|
* returned by qtest_get_arch().
|
|
|
|
*/
|
|
|
|
#define qtest_add(testpath, Fixture, tdata, fsetup, ftest, fteardown) \
|
|
|
|
do { \
|
|
|
|
char *path = g_strdup_printf("/%s/%s", qtest_get_arch(), testpath); \
|
|
|
|
g_test_add(path, Fixture, tdata, fsetup, ftest, fteardown); \
|
|
|
|
g_free(path); \
|
|
|
|
} while (0)
|
|
|
|
|
2021-02-23 15:46:45 +01:00
|
|
|
/**
|
|
|
|
* qtest_add_abrt_handler:
|
|
|
|
* @fn: Handler function
|
|
|
|
* @data: Argument that is passed to the handler
|
|
|
|
*
|
|
|
|
* Add a handler function that is invoked on SIGABRT. This can be used to
|
|
|
|
* terminate processes and perform other cleanup. The handler can be removed
|
|
|
|
* with qtest_remove_abrt_handler().
|
|
|
|
*/
|
2015-12-02 21:20:33 +01:00
|
|
|
void qtest_add_abrt_handler(GHookFunc fn, const void *data);
|
2015-06-19 18:45:14 +02:00
|
|
|
|
2021-02-23 15:46:45 +01:00
|
|
|
/**
|
|
|
|
* qtest_remove_abrt_handler:
|
|
|
|
* @data: Argument previously passed to qtest_add_abrt_handler()
|
|
|
|
*
|
|
|
|
* Remove an abrt handler that was previously added with
|
|
|
|
* qtest_add_abrt_handler().
|
|
|
|
*/
|
|
|
|
void qtest_remove_abrt_handler(void *data);
|
|
|
|
|
2015-04-28 21:27:51 +02:00
|
|
|
/**
|
2019-07-23 21:22:39 +02:00
|
|
|
* qtest_qmp_assert_success:
|
|
|
|
* @qts: QTestState instance to operate on
|
2020-10-05 22:52:28 +02:00
|
|
|
* @fmt: QMP message to send to qemu, formatted like
|
2020-11-09 17:26:21 +01:00
|
|
|
* qobject_from_jsonf_nofail(). See parse_interpolation() for what's
|
2019-05-08 11:58:45 +02:00
|
|
|
* supported after '%'.
|
|
|
|
*
|
|
|
|
* Sends a QMP message to QEMU and asserts that a 'return' key is present in
|
|
|
|
* the response.
|
|
|
|
*/
|
2019-07-23 21:22:39 +02:00
|
|
|
void qtest_qmp_assert_success(QTestState *qts, const char *fmt, ...)
|
2022-02-20 17:39:25 +01:00
|
|
|
G_GNUC_PRINTF(2, 3);
|
2019-05-08 11:58:45 +02:00
|
|
|
|
2017-03-30 09:50:06 +02:00
|
|
|
/**
|
|
|
|
* qtest_cb_for_every_machine:
|
|
|
|
* @cb: Pointer to the callback function
|
2018-08-16 13:35:55 +02:00
|
|
|
* @skip_old_versioned: true if versioned old machine types should be skipped
|
2017-03-30 09:50:06 +02:00
|
|
|
*
|
|
|
|
* Call a callback function for every name of all available machines.
|
|
|
|
*/
|
2018-08-16 13:35:55 +02:00
|
|
|
void qtest_cb_for_every_machine(void (*cb)(const char *machine),
|
|
|
|
bool skip_old_versioned);
|
2017-03-30 09:50:06 +02:00
|
|
|
|
2021-12-01 11:43:47 +01:00
|
|
|
/**
|
|
|
|
* qtest_has_machine:
|
|
|
|
* @machine: The machine to look for
|
|
|
|
*
|
|
|
|
* Returns: true if the machine is available in the target binary.
|
|
|
|
*/
|
|
|
|
bool qtest_has_machine(const char *machine);
|
|
|
|
|
2021-12-20 09:10:51 +01:00
|
|
|
/**
|
|
|
|
* qtest_has_device:
|
|
|
|
* @device: The device to look for
|
|
|
|
*
|
|
|
|
* Returns: true if the device is available in the target binary.
|
|
|
|
*/
|
|
|
|
bool qtest_has_device(const char *device);
|
|
|
|
|
2019-08-30 13:07:22 +02:00
|
|
|
/**
|
|
|
|
* qtest_qmp_device_add_qdict:
|
|
|
|
* @qts: QTestState instance to operate on
|
|
|
|
* @drv: Name of the device that should be added
|
|
|
|
* @arguments: QDict with properties for the device to intialize
|
|
|
|
*
|
|
|
|
* Generic hot-plugging test via the device_add QMP command with properties
|
|
|
|
* supplied in form of QDict. Use NULL for empty properties list.
|
|
|
|
*/
|
|
|
|
void qtest_qmp_device_add_qdict(QTestState *qts, const char *drv,
|
|
|
|
const QDict *arguments);
|
|
|
|
|
2017-08-15 08:58:54 +02:00
|
|
|
/**
|
|
|
|
* qtest_qmp_device_add:
|
2019-07-22 17:10:55 +02:00
|
|
|
* @qts: QTestState instance to operate on
|
2017-08-15 08:58:54 +02:00
|
|
|
* @driver: Name of the device that should be added
|
|
|
|
* @id: Identification string
|
2020-10-05 22:52:28 +02:00
|
|
|
* @fmt: QMP message to send to qemu, formatted like
|
2020-11-09 17:26:21 +01:00
|
|
|
* qobject_from_jsonf_nofail(). See parse_interpolation() for what's
|
2018-08-06 08:53:35 +02:00
|
|
|
* supported after '%'.
|
2017-08-15 08:58:54 +02:00
|
|
|
*
|
|
|
|
* Generic hot-plugging test via the device_add QMP command.
|
|
|
|
*/
|
2019-07-22 17:10:55 +02:00
|
|
|
void qtest_qmp_device_add(QTestState *qts, const char *driver, const char *id,
|
2022-02-20 17:39:25 +01:00
|
|
|
const char *fmt, ...) G_GNUC_PRINTF(4, 5);
|
2017-08-15 08:58:54 +02:00
|
|
|
|
2021-10-06 23:07:30 +02:00
|
|
|
/**
|
|
|
|
* qtest_qmp_add_client:
|
|
|
|
* @qts: QTestState instance to operate on
|
|
|
|
* @protocol: the protocol to add to
|
|
|
|
* @fd: the client file-descriptor
|
|
|
|
*
|
|
|
|
* Call QMP ``getfd`` followed by ``add_client`` with the given @fd.
|
|
|
|
*/
|
|
|
|
void qtest_qmp_add_client(QTestState *qts, const char *protocol, int fd);
|
|
|
|
|
2017-08-15 08:58:54 +02:00
|
|
|
/**
|
|
|
|
* qtest_qmp_device_del:
|
2019-07-22 17:10:55 +02:00
|
|
|
* @qts: QTestState instance to operate on
|
2017-08-15 08:58:54 +02:00
|
|
|
* @id: Identification string
|
|
|
|
*
|
|
|
|
* Generic hot-unplugging test via the device_del QMP command.
|
|
|
|
*/
|
2019-07-22 17:10:55 +02:00
|
|
|
void qtest_qmp_device_del(QTestState *qts, const char *id);
|
2017-08-15 08:58:54 +02:00
|
|
|
|
2018-12-17 04:58:16 +01:00
|
|
|
/**
|
|
|
|
* qtest_probe_child:
|
|
|
|
* @s: QTestState instance to operate on.
|
|
|
|
*
|
|
|
|
* Returns: true if the child is still alive.
|
|
|
|
*/
|
|
|
|
bool qtest_probe_child(QTestState *s);
|
|
|
|
|
2019-09-03 18:22:45 +02:00
|
|
|
/**
|
|
|
|
* qtest_set_expected_status:
|
|
|
|
* @s: QTestState instance to operate on.
|
|
|
|
* @status: an expected exit status.
|
|
|
|
*
|
|
|
|
* Set expected exit status of the child.
|
|
|
|
*/
|
|
|
|
void qtest_set_expected_status(QTestState *s, int status);
|
|
|
|
|
2020-02-20 05:11:03 +01:00
|
|
|
QTestState *qtest_inproc_init(QTestState **s, bool log, const char* arch,
|
|
|
|
void (*send)(void*, const char*));
|
|
|
|
|
|
|
|
void qtest_client_inproc_recv(void *opaque, const char *str);
|
2012-03-28 15:42:05 +02:00
|
|
|
#endif
|