/* * QTest * * Copyright IBM, Corp. 2012 * Copyright Red Hat, Inc. 2012 * Copyright SUSE LINUX Products GmbH 2013 * * Authors: * Anthony Liguori <aliguori@us.ibm.com> * Paolo Bonzini <pbonzini@redhat.com> * Andreas Färber <afaerber@suse.de> * * 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 #include <stddef.h> #include <stdint.h> #include <stdbool.h> #include <stdarg.h> #include <sys/types.h> #include "qapi/qmp/qdict.h" #include "glib-compat.h" typedef struct QTestState QTestState; extern QTestState *global_qtest; /** * qtest_init: * @extra_args: other arguments to pass to QEMU. * * Returns: #QTestState instance. */ QTestState *qtest_init(const char *extra_args); /** * qtest_quit: * @s: #QTestState instance to operate on. * * Shut down the QEMU process associated to @s. */ void qtest_quit(QTestState *s); /** * qtest_qmp_discard_response: * @s: #QTestState instance to operate on. * @fmt...: QMP message to send to qemu * * Sends a QMP message to QEMU and consumes the response. */ void qtest_qmp_discard_response(QTestState *s, const char *fmt, ...); /** * qtest_qmp: * @s: #QTestState instance to operate on. * @fmt...: QMP message to send to qemu * * Sends a QMP message to QEMU and returns the response. */ QDict *qtest_qmp(QTestState *s, const char *fmt, ...); /** * qtest_async_qmp: * @s: #QTestState instance to operate on. * @fmt...: QMP message to send to qemu * * Sends a QMP message to QEMU and leaves the response in the stream. */ void qtest_async_qmp(QTestState *s, const char *fmt, ...); /** * qtest_qmpv_discard_response: * @s: #QTestState instance to operate on. * @fmt: QMP message to send to QEMU * @ap: QMP message arguments * * Sends a QMP message to QEMU and consumes the response. */ void qtest_qmpv_discard_response(QTestState *s, const char *fmt, va_list ap); /** * qtest_qmpv: * @s: #QTestState instance to operate on. * @fmt: QMP message to send to QEMU * @ap: QMP message arguments * * Sends a QMP message to QEMU and returns the response. */ QDict *qtest_qmpv(QTestState *s, const char *fmt, va_list ap); /** * qtest_async_qmpv: * @s: #QTestState instance to operate on. * @fmt: QMP message to send to QEMU * @ap: QMP message arguments * * Sends a QMP message to QEMU and leaves the response in the stream. */ void qtest_async_qmpv(QTestState *s, const char *fmt, va_list ap); /** * qtest_receive: * @s: #QTestState instance to operate on. * * Reads a QMP message from QEMU and returns the response. */ QDict *qtest_qmp_receive(QTestState *s); /** * qtest_qmp_eventwait: * @s: #QTestState instance to operate on. * @s: #event event to wait for. * * Continuosly polls for QMP responses until it receives the desired event. */ void qtest_qmp_eventwait(QTestState *s, const char *event); /** * qtest_hmpv: * @s: #QTestState instance to operate on. * @fmt...: HMP command to send to QEMU * * Send HMP command to QEMU via QMP's human-monitor-command. * * Returns: the command's output. The caller should g_free() it. */ char *qtest_hmp(QTestState *s, const char *fmt, ...); /** * qtest_hmpv: * @s: #QTestState instance to operate on. * @fmt: HMP command to send to QEMU * @ap: HMP command arguments * * Send HMP command to QEMU via QMP's human-monitor-command. * * Returns: the command's output. The caller should g_free() it. */ char *qtest_hmpv(QTestState *s, const char *fmt, va_list ap); /** * qtest_get_irq: * @s: #QTestState instance to operate on. * @num: Interrupt to observe. * * Returns: The level of the @num interrupt. */ bool qtest_get_irq(QTestState *s, int num); /** * qtest_irq_intercept_in: * @s: #QTestState instance to operate on. * @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: * @s: #QTestState instance to operate on. * @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); /** * qtest_outb: * @s: #QTestState instance to operate on. * @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: * @s: #QTestState instance to operate on. * @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: * @s: #QTestState instance to operate on. * @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: * @s: #QTestState instance to operate on. * @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: * @s: #QTestState instance to operate on. * @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: * @s: #QTestState instance to operate on. * @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); /** * 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); /** * qtest_memread: * @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. */ void qtest_memread(QTestState *s, uint64_t addr, void *data, size_t size); /** * 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); /** * qtest_memwrite: * @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. */ void qtest_memwrite(QTestState *s, uint64_t addr, const void *data, size_t size); /** * 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); /** * 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); /** * qtest_clock_step_next: * @s: #QTestState instance to operate on. * * Advance the QEMU_CLOCK_VIRTUAL to the next deadline. * * Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds. */ 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. * * Advance the QEMU_CLOCK_VIRTUAL by @step nanoseconds. * * Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds. */ 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. * * Advance the QEMU_CLOCK_VIRTUAL to @val nanoseconds since the VM was launched. * * Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds. */ int64_t qtest_clock_set(QTestState *s, int64_t val); /** * qtest_get_arch: * * Returns: The architecture for the QEMU executable under test. */ const char *qtest_get_arch(void); /** * 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 * returned by qtest_get_arch(). */ void qtest_add_func(const char *str, void (*fn)(void)); /** * 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(). */ void qtest_add_data_func(const char *str, const void *data, void (*fn)(const void *)); /** * 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) void qtest_add_abrt_handler(GHookFunc fn, const void *data); /** * qtest_start: * @args: other arguments to pass to QEMU * * Start QEMU and assign the resulting #QTestState to a global variable. * The global variable is used by "shortcut" functions documented below. * * Returns: #QTestState instance. */ static inline QTestState *qtest_start(const char *args) { global_qtest = qtest_init(args); return global_qtest; } /** * qtest_end: * * Shut down the QEMU process started by qtest_start(). */ static inline void qtest_end(void) { qtest_quit(global_qtest); global_qtest = NULL; } /** * qmp: * @fmt...: QMP message to send to qemu * * Sends a QMP message to QEMU and returns the response. */ QDict *qmp(const char *fmt, ...); /** * qmp_async: * @fmt...: QMP message to send to qemu * * Sends a QMP message to QEMU and leaves the response in the stream. */ void qmp_async(const char *fmt, ...); /** * qmp_discard_response: * @fmt...: QMP message to send to qemu * * Sends a QMP message to QEMU and consumes the response. */ void qmp_discard_response(const char *fmt, ...); /** * qmp_receive: * * Reads a QMP message from QEMU and returns the response. */ static inline QDict *qmp_receive(void) { return qtest_qmp_receive(global_qtest); } /** * qmp_eventwait: * @s: #event event to wait for. * * Continuosly polls for QMP responses until it receives the desired event. */ static inline void qmp_eventwait(const char *event) { return qtest_qmp_eventwait(global_qtest, event); } /** * hmp: * @fmt...: HMP command to send to QEMU * * Send HMP command to QEMU via QMP's human-monitor-command. * * Returns: the command's output. The caller should g_free() it. */ char *hmp(const char *fmt, ...); /** * get_irq: * @num: Interrupt to observe. * * Returns: The level of the @num interrupt. */ static inline bool get_irq(int num) { return qtest_get_irq(global_qtest, num); } /** * irq_intercept_in: * @string: QOM path of a device. * * Associate qtest irqs with the GPIO-in pins of the device * whose path is specified by @string. */ static inline void irq_intercept_in(const char *string) { qtest_irq_intercept_in(global_qtest, string); } /** * qtest_irq_intercept_out: * @string: QOM path of a device. * * Associate qtest irqs with the GPIO-out pins of the device * whose path is specified by @string. */ static inline void irq_intercept_out(const char *string) { qtest_irq_intercept_out(global_qtest, string); } /** * outb: * @addr: I/O port to write to. * @value: Value being written. * * Write an 8-bit value to an I/O port. */ static inline void outb(uint16_t addr, uint8_t value) { qtest_outb(global_qtest, addr, value); } /** * outw: * @addr: I/O port to write to. * @value: Value being written. * * Write a 16-bit value to an I/O port. */ static inline void outw(uint16_t addr, uint16_t value) { qtest_outw(global_qtest, addr, value); } /** * outl: * @addr: I/O port to write to. * @value: Value being written. * * Write a 32-bit value to an I/O port. */ static inline void outl(uint16_t addr, uint32_t value) { qtest_outl(global_qtest, addr, value); } /** * inb: * @addr: I/O port to read from. * * Reads an 8-bit value from an I/O port. * * Returns: Value read. */ static inline uint8_t inb(uint16_t addr) { return qtest_inb(global_qtest, addr); } /** * inw: * @addr: I/O port to read from. * * Reads a 16-bit value from an I/O port. * * Returns: Value read. */ static inline uint16_t inw(uint16_t addr) { return qtest_inw(global_qtest, addr); } /** * inl: * @addr: I/O port to read from. * * Reads a 32-bit value from an I/O port. * * Returns: Value read. */ static inline uint32_t inl(uint16_t addr) { return qtest_inl(global_qtest, addr); } /** * writeb: * @addr: Guest address to write to. * @value: Value being written. * * Writes an 8-bit value to guest memory. */ static inline void writeb(uint64_t addr, uint8_t value) { qtest_writeb(global_qtest, addr, value); } /** * writew: * @addr: Guest address to write to. * @value: Value being written. * * Writes a 16-bit value to guest memory. */ static inline void writew(uint64_t addr, uint16_t value) { qtest_writew(global_qtest, addr, value); } /** * writel: * @addr: Guest address to write to. * @value: Value being written. * * Writes a 32-bit value to guest memory. */ static inline void writel(uint64_t addr, uint32_t value) { qtest_writel(global_qtest, addr, value); } /** * writeq: * @addr: Guest address to write to. * @value: Value being written. * * Writes a 64-bit value to guest memory. */ static inline void writeq(uint64_t addr, uint64_t value) { qtest_writeq(global_qtest, addr, value); } /** * readb: * @addr: Guest address to read from. * * Reads an 8-bit value from guest memory. * * Returns: Value read. */ static inline uint8_t readb(uint64_t addr) { return qtest_readb(global_qtest, addr); } /** * readw: * @addr: Guest address to read from. * * Reads a 16-bit value from guest memory. * * Returns: Value read. */ static inline uint16_t readw(uint64_t addr) { return qtest_readw(global_qtest, addr); } /** * readl: * @addr: Guest address to read from. * * Reads a 32-bit value from guest memory. * * Returns: Value read. */ static inline uint32_t readl(uint64_t addr) { return qtest_readl(global_qtest, addr); } /** * readq: * @addr: Guest address to read from. * * Reads a 64-bit value from guest memory. * * Returns: Value read. */ static inline uint64_t readq(uint64_t addr) { return qtest_readq(global_qtest, addr); } /** * memread: * @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. */ static inline void memread(uint64_t addr, void *data, size_t size) { qtest_memread(global_qtest, addr, data, size); } /** * bufread: * @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, receive using a base64 encoding. */ static inline void bufread(uint64_t addr, void *data, size_t size) { qtest_bufread(global_qtest, addr, data, size); } /** * memwrite: * @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. */ static inline void memwrite(uint64_t addr, const void *data, size_t size) { qtest_memwrite(global_qtest, addr, data, size); } /** * bufwrite: * @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, transmit using a base64 encoding. */ static inline void bufwrite(uint64_t addr, const void *data, size_t size) { qtest_bufwrite(global_qtest, addr, data, size); } /** * qmemset: * @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. */ static inline void qmemset(uint64_t addr, uint8_t patt, size_t size) { qtest_memset(global_qtest, addr, patt, size); } /** * clock_step_next: * * Advance the QEMU_CLOCK_VIRTUAL to the next deadline. * * Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds. */ static inline int64_t clock_step_next(void) { return qtest_clock_step_next(global_qtest); } /** * clock_step: * @step: Number of nanoseconds to advance the clock by. * * Advance the QEMU_CLOCK_VIRTUAL by @step nanoseconds. * * Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds. */ static inline int64_t clock_step(int64_t step) { return qtest_clock_step(global_qtest, step); } /** * clock_set: * @val: Nanoseconds value to advance the clock to. * * Advance the QEMU_CLOCK_VIRTUAL to @val nanoseconds since the VM was launched. * * Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds. */ static inline int64_t clock_set(int64_t val) { return qtest_clock_set(global_qtest, val); } /** * qtest_big_endian: * * Returns: True if the architecture under test has a big endian configuration. */ bool qtest_big_endian(void); QDict *qmp_fd_receive(int fd); void qmp_fd_sendv(int fd, const char *fmt, va_list ap); void qmp_fd_send(int fd, const char *fmt, ...); QDict *qmp_fdv(int fd, const char *fmt, va_list ap); QDict *qmp_fd(int fd, const char *fmt, ...); #endif