tests/qtest/libqtest.h

28  * @fmt: Format for creating other arguments to pass to QEMU, formatted
39  * @fmt: Format for creating other arguments to pass to QEMU, formatted
51  * @extra_args: other arguments to pass to QEMU.  CAUTION: these
52  * arguments are subject to word splitting and shell evaluation.
60  * @var: Environment variable from where to take the QEMU binary
61  * @extra_args: Other arguments to pass to QEMU.  CAUTION: these
62  * arguments are subject to word splitting and shell evaluation.
73  * @extra_args: other arguments to pass to QEMU.  CAUTION: these
74  * arguments are subject to word splitting and shell evaluation.
82  * @extra_args: other arguments to pass to QEMU.  CAUTION: these
83  * arguments are subject to word splitting and shell evaluation.
84  * @sock_fd: pointer to store the socket file descriptor for
93  * @s: #QTestState instance to operate on.
95  * Wait for the QEMU process to terminate. It is safe to call this function
102  * @s: #QTestState instance to operate on.
104  * Kill the QEMU process and wait for it to terminate. It is safe to call this
106  * also frees QTestState. Use qtest_kill_qemu() when you just want to kill QEMU
113  * @s: #QTestState instance to operate on.
115  * Shut down the QEMU process associated to @s.
122  * @s: #QTestState instance to operate on.
125  * @fmt: QMP message to send to qemu, formatted like
129  * Sends a QMP message to QEMU with fds and returns the response.
138  * @s: #QTestState instance to operate on.
139  * @fmt: QMP message to send to qemu, formatted like
143  * Sends a QMP message to QEMU and returns the response.
150  * @s: #QTestState instance to operate on.
151  * @fmt: QMP message to send to qemu, formatted like
155  * Sends a QMP message to QEMU and leaves the response in the stream.
162  * @s: #QTestState instance to operate on.
163  * @fmt: text to send, formatted like sprintf()
165  * Sends text to the QMP monitor verbatim.  Need not be valid JSON;
182  * @s: #QTestState instance to operate on.
185  * @fmt: QMP message to send to QEMU, formatted like
190  * Sends a QMP message to QEMU with fds and returns the response.
199  * @s: #QTestState instance to operate on.
200  * @fmt: QMP message to send to QEMU, formatted like
205  * Sends a QMP message to QEMU and returns the response.
213  * @s: #QTestState instance to operate on.
216  * @fmt: QMP message to send to QEMU, formatted like
221  * Sends a QMP message to QEMU and leaves the response in the stream.
230  * @s: #QTestState instance to operate on.
231  * @fmt: QMP message to send to QEMU, formatted like
236  * Sends a QMP message to QEMU and leaves the response in the stream.
243  * @s: #QTestState instance to operate on.
251  * @s: #QTestState instance to operate on.
257  * will be buffered until a call to one of the qtest_qmp_eventwait
275  * Return: true to consume the event, false to let it be queued
282  * @s: #QTestSTate instance to operate on
283  * @cb: callback to invoke for events
284  * @opaque: data to pass to @cb
286  * Register a callback to be invoked whenever an event arrives
293  * @s: #QTestState instance to operate on.
294  * @event: event to wait for.
305  * @s: #QTestState instance to operate on.
306  * @event: event to wait for.
319  * @s: #QTestState instance to operate on.
320  * @event: event to return.
332  * @s: #QTestState instance to operate on.
333  * @fmt: HMP command to send to QEMU, formats arguments like sprintf().
335  * Send HMP command to QEMU via QMP's human-monitor-command.
344  * @s: #QTestState instance to operate on.
345  * @fmt: HMP command to send to QEMU, formats arguments like vsprintf().
348  * Send HMP command to QEMU via QMP's human-monitor-command.
360  * @s: #QTestState instance to operate on.
361  * @num: Interrupt to observe.
369  * @s: #QTestState instance to operate on.
379  * @s: #QTestState instance to operate on.
389  * @s: #QTestState instance to operate on.
400  * @s: QTestState instance to operate on.
406  * Force given device/irq GPIO-in pin to the given level.
413  * @s: #QTestState instance to operate on.
414  * @addr: I/O port to write to.
417  * Write an 8-bit value to an I/O port.
423  * @s: #QTestState instance to operate on.
424  * @addr: I/O port to write to.
427  * Write a 16-bit value to an I/O port.
433  * @s: #QTestState instance to operate on.
434  * @addr: I/O port to write to.
437  * Write a 32-bit value to an I/O port.
443  * @s: #QTestState instance to operate on.
444  * @addr: I/O port to read from.
452  * @s: #QTestState instance to operate on.
453  * @addr: I/O port to read from.
461  * @s: #QTestState instance to operate on.
462  * @addr: I/O port to read from.
470  * @s: #QTestState instance to operate on.
471  * @addr: Guest address to write to.
474  * Writes an 8-bit value to memory.
480  * @s: #QTestState instance to operate on.
481  * @addr: Guest address to write to.
484  * Writes a 16-bit value to memory.
490  * @s: #QTestState instance to operate on.
491  * @addr: Guest address to write to.
494  * Writes a 32-bit value to memory.
500  * @s: #QTestState instance to operate on.
501  * @addr: Guest address to write to.
504  * Writes a 64-bit value to memory.
510  * @s: #QTestState instance to operate on.
511  * @addr: Guest address to read from.
521  * @s: #QTestState instance to operate on.
522  * @addr: Guest address to read from.
532  * @s: #QTestState instance to operate on.
533  * @addr: Guest address to read from.
543  * @s: #QTestState instance to operate on.
544  * @addr: Guest address to read from.
554  * @s: #QTestState instance to operate on.
555  * @addr: Guest address to read from.
556  * @data: Pointer to where memory contents will be stored.
557  * @size: Number of bytes to read.
565  * @s: #QTestState instance to operate on.
566  * @name: name of the command to call.
568  * @args: Guest address to read args from.
570  * @ret: Guest address to write return values to.
580  * @s: #QTestState instance to operate on.
581  * @addr: Guest address to read from.
582  * @data: Pointer to where memory contents will be stored.
583  * @size: Number of bytes to read.
591  * @s: #QTestState instance to operate on.
592  * @addr: Guest address to write to.
593  * @data: Pointer to the bytes that will be written to guest memory.
594  * @size: Number of bytes to write.
596  * Write a buffer to guest memory.
602  * @s: #QTestState instance to operate on.
603  * @addr: Guest address to write to.
604  * @data: Pointer to the bytes that will be written to guest memory.
605  * @size: Number of bytes to write.
607  * Write a buffer to guest memory and transmit using a base64 encoding.
614  * @s: #QTestState instance to operate on.
615  * @addr: Guest address to write to.
616  * @patt: Byte pattern to fill the guest memory region with.
617  * @size: Number of bytes to write.
619  * Write a pattern to guest memory.
625  * @s: #QTestState instance to operate on.
627  * Advance the QEMU_CLOCK_VIRTUAL to the next deadline.
635  * @s: QTestState instance to operate on.
636  * @step: Number of nanoseconds to advance the clock by.
646  * @s: QTestState instance to operate on.
647  * @val: Nanoseconds value to advance the clock to.
649  * Advance the QEMU_CLOCK_VIRTUAL to @val nanoseconds since the VM was launched.
657  * @s: QTestState instance to operate on.
672  * @accel_name: Accelerator name to check for.
713  * @data is passed to @data_free_func() on test completion.
742  * @data: Argument that is passed to the handler
744  * Add a handler function that is invoked on SIGABRT. This can be used to
752  * @data: Argument previously passed to qtest_add_abrt_handler()
761  * @qts: QTestState instance to operate on
762  * @fmt: QMP message to send to qemu, formatted like
767  * Sends a QMP message to QEMU, asserts that a 'return' key is present in
776  * @qts: QTestState instance to operate on
777  * @fmt: QMP message to send to qemu, formatted like
782  * Sends a QMP message to QEMU and asserts that a 'return' key is present in
792  * @qts: QTestState instance to operate on
793  * @fds: the file descriptors to send
794  * @nfds: number of @fds to send
795  * @fmt: QMP message to send to qemu, formatted like
800  * Sends a QMP message with file descriptors to QEMU,
810  * @qts: QTestState instance to operate on
811  * @fds: the file descriptors to send
812  * @nfds: number of @fds to send
813  * @fmt: QMP message to send to qemu, formatted like
818  * Sends a QMP message with file descriptors to QEMU and
828  * @qts: QTestState instance to operate on
829  * @fmt: QMP message to send to qemu, formatted like
833  * Sends a QMP message to QEMU, asserts that an 'error' key is present in
841  * @qts: QTestState instance to operate on
842  * @fmt: QMP message to send to qemu, formatted like
847  * Sends a QMP message to QEMU, asserts that an 'error' key is present in
856  * @qts: QTestState instance to operate on
857  * @fmt: QMP message to send to qemu, formatted like
861  * Sends a QMP message to QEMU, asserts that a 'return' key is present in
869  * @qts: QTestState instance to operate on
870  * @fmt: QMP message to send to qemu, formatted like
874  * Sends a QMP message to QEMU and asserts that a 'return' key is present in
883  * @qts: QTestState instance to operate on
884  * @fds: the file descriptors to send
885  * @nfds: number of @fds to send
886  * @fmt: QMP message to send to qemu, formatted like
890  * Sends a QMP message with file descriptors to QEMU,
900  * @qts: QTestState instance to operate on
901  * @fds: the file descriptors to send
902  * @nfds: number of @fds to send
903  * @fmt: QMP message to send to qemu, formatted like
907  * Sends a QMP message with file descriptors to QEMU and
917  * @cb: Pointer to the callback function
927  * @var: Environment variable from where to take the QEMU binary
928  * @alias: The alias to resolve
930  * Returns: the machine type corresponding to the alias if any,
937  * @machine: The machine to look for
945  * @var: Environment variable from where to take the QEMU binary
946  * @machine: The machine to look for
954  * @cpu: The cpu to look for
962  * @device: The device to look for
970  * @qts: QTestState instance to operate on
972  * @arguments: QDict with properties for the device to initialize
982  * @qts: QTestState instance to operate on
985  * @fmt: QMP message to send to qemu, formatted like
996  * @qts: QTestState instance to operate on
997  * @protocol: the protocol to add to
1007  * @qts: QTestState instance to operate on
1016  * @qts: QTestState instance to operate on
1026  * @s: QTestState instance to operate on.
1034  * @s: QTestState instance to operate on.
1048  * @s: QTestState instance to operate on.
1049  * @path: Path to the property being set.
1051  * @value: Value to set the property.
1060  * @s: QTestState instance to operate on.
1061  * @path: Path to the property being retrieved.
1070  * @s: QTestState instance to operate on.
1090  * environment variable must point to the qemu-img file.