tests/libqtest.h

   1 /*
   2  * QTest
   3  *
   4  * Copyright IBM, Corp. 2012
   5  * Copyright Red Hat, Inc. 2012
   6  * Copyright SUSE LINUX Products GmbH 2013
   7  *
   8  * Authors:
   9  *  Anthony Liguori   <aliguori@us.ibm.com>
  10  *  Paolo Bonzini     <pbonzini@redhat.com>
  11  *  Andreas Färber    <afaerber@suse.de>
  12  *
  13  * This work is licensed under the terms of the GNU GPL, version 2 or later.
  14  * See the COPYING file in the top-level directory.
  15  *
  16  */
  17 #ifndef LIBQTEST_H
  18 #define LIBQTEST_H
  19
  20 #include <stddef.h>
  21 #include <stdint.h>
  22 #include <stdbool.h>
  23 #include <stdarg.h>
  24 #include <sys/types.h>
  25 #include "qapi/qmp/qdict.h"
  26 #include "glib-compat.h"
  27
  28 typedef struct QTestState QTestState;
  29
  30 extern QTestState *global_qtest;
  31
  32 /**
  33  * qtest_init:
  34  * @extra_args: other arguments to pass to QEMU.
  35  *
  36  * Returns: #QTestState instance.
  37  */
  38 QTestState *qtest_init(const char *extra_args);
  39
  40 /**
  41  * qtest_quit:
  42  * @s: #QTestState instance to operate on.
  43  *
  44  * Shut down the QEMU process associated to @s.
  45  */
  46 void qtest_quit(QTestState *s);
  47
  48 /**
  49  * qtest_qmp_discard_response:
  50  * @s: #QTestState instance to operate on.
  51  * @fmt...: QMP message to send to qemu
  52  *
  53  * Sends a QMP message to QEMU and consumes the response.
  54  */
  55 void qtest_qmp_discard_response(QTestState *s, const char *fmt, ...);
  56
  57 /**
  58  * qtest_qmp:
  59  * @s: #QTestState instance to operate on.
  60  * @fmt...: QMP message to send to qemu
  61  *
  62  * Sends a QMP message to QEMU and returns the response.
  63  */
  64 QDict *qtest_qmp(QTestState *s, const char *fmt, ...);
  65
  66 /**
  67  * qtest_async_qmp:
  68  * @s: #QTestState instance to operate on.
  69  * @fmt...: QMP message to send to qemu
  70  *
  71  * Sends a QMP message to QEMU and leaves the response in the stream.
  72  */
  73 void qtest_async_qmp(QTestState *s, const char *fmt, ...);
  74
  75 /**
  76  * qtest_qmpv_discard_response:
  77  * @s: #QTestState instance to operate on.
  78  * @fmt: QMP message to send to QEMU
  79  * @ap: QMP message arguments
  80  *
  81  * Sends a QMP message to QEMU and consumes the response.
  82  */
  83 void qtest_qmpv_discard_response(QTestState *s, const char *fmt, va_list ap);
  84
  85 /**
  86  * qtest_qmpv:
  87  * @s: #QTestState instance to operate on.
  88  * @fmt: QMP message to send to QEMU
  89  * @ap: QMP message arguments
  90  *
  91  * Sends a QMP message to QEMU and returns the response.
  92  */
  93 QDict *qtest_qmpv(QTestState *s, const char *fmt, va_list ap);
  94
  95 /**
  96  * qtest_async_qmpv:
  97  * @s: #QTestState instance to operate on.
  98  * @fmt: QMP message to send to QEMU
  99  * @ap: QMP message arguments
 100  *
 101  * Sends a QMP message to QEMU and leaves the response in the stream.
 102  */
 103 void qtest_async_qmpv(QTestState *s, const char *fmt, va_list ap);
 104
 105 /**
 106  * qtest_receive:
 107  * @s: #QTestState instance to operate on.
 108  *
 109  * Reads a QMP message from QEMU and returns the response.
 110  */
 111 QDict *qtest_qmp_receive(QTestState *s);
 112
 113 /**
 114  * qtest_qmp_eventwait:
 115  * @s: #QTestState instance to operate on.
 116  * @s: #event event to wait for.
 117  *
 118  * Continuosly polls for QMP responses until it receives the desired event.
 119  */
 120 void qtest_qmp_eventwait(QTestState *s, const char *event);
 121
 122 /**
 123  * qtest_hmpv:
 124  * @s: #QTestState instance to operate on.
 125  * @fmt...: HMP command to send to QEMU
 126  *
 127  * Send HMP command to QEMU via QMP's human-monitor-command.
 128  *
 129  * Returns: the command's output.  The caller should g_free() it.
 130  */
 131 char *qtest_hmp(QTestState *s, const char *fmt, ...);
 132
 133 /**
 134  * qtest_hmpv:
 135  * @s: #QTestState instance to operate on.
 136  * @fmt: HMP command to send to QEMU
 137  * @ap: HMP command arguments
 138  *
 139  * Send HMP command to QEMU via QMP's human-monitor-command.
 140  *
 141  * Returns: the command's output.  The caller should g_free() it.
 142  */
 143 char *qtest_hmpv(QTestState *s, const char *fmt, va_list ap);
 144
 145 /**
 146  * qtest_get_irq:
 147  * @s: #QTestState instance to operate on.
 148  * @num: Interrupt to observe.
 149  *
 150  * Returns: The level of the @num interrupt.
 151  */
 152 bool qtest_get_irq(QTestState *s, int num);
 153
 154 /**
 155  * qtest_irq_intercept_in:
 156  * @s: #QTestState instance to operate on.
 157  * @string: QOM path of a device.
 158  *
 159  * Associate qtest irqs with the GPIO-in pins of the device
 160  * whose path is specified by @string.
 161  */
 162 void qtest_irq_intercept_in(QTestState *s, const char *string);
 163
 164 /**
 165  * qtest_irq_intercept_out:
 166  * @s: #QTestState instance to operate on.
 167  * @string: QOM path of a device.
 168  *
 169  * Associate qtest irqs with the GPIO-out pins of the device
 170  * whose path is specified by @string.
 171  */
 172 void qtest_irq_intercept_out(QTestState *s, const char *string);
 173
 174 /**
 175  * qtest_outb:
 176  * @s: #QTestState instance to operate on.
 177  * @addr: I/O port to write to.
 178  * @value: Value being written.
 179  *
 180  * Write an 8-bit value to an I/O port.
 181  */
 182 void qtest_outb(QTestState *s, uint16_t addr, uint8_t value);
 183
 184 /**
 185  * qtest_outw:
 186  * @s: #QTestState instance to operate on.
 187  * @addr: I/O port to write to.
 188  * @value: Value being written.
 189  *
 190  * Write a 16-bit value to an I/O port.
 191  */
 192 void qtest_outw(QTestState *s, uint16_t addr, uint16_t value);
 193
 194 /**
 195  * qtest_outl:
 196  * @s: #QTestState instance to operate on.
 197  * @addr: I/O port to write to.
 198  * @value: Value being written.
 199  *
 200  * Write a 32-bit value to an I/O port.
 201  */
 202 void qtest_outl(QTestState *s, uint16_t addr, uint32_t value);
 203
 204 /**
 205  * qtest_inb:
 206  * @s: #QTestState instance to operate on.
 207  * @addr: I/O port to read from.
 208  *
 209  * Returns an 8-bit value from an I/O port.
 210  */
 211 uint8_t qtest_inb(QTestState *s, uint16_t addr);
 212
 213 /**
 214  * qtest_inw:
 215  * @s: #QTestState instance to operate on.
 216  * @addr: I/O port to read from.
 217  *
 218  * Returns a 16-bit value from an I/O port.
 219  */
 220 uint16_t qtest_inw(QTestState *s, uint16_t addr);
 221
 222 /**
 223  * qtest_inl:
 224  * @s: #QTestState instance to operate on.
 225  * @addr: I/O port to read from.
 226  *
 227  * Returns a 32-bit value from an I/O port.
 228  */
 229 uint32_t qtest_inl(QTestState *s, uint16_t addr);
 230
 231 /**
 232  * qtest_writeb:
 233  * @s: #QTestState instance to operate on.
 234  * @addr: Guest address to write to.
 235  * @value: Value being written.
 236  *
 237  * Writes an 8-bit value to memory.
 238  */
 239 void qtest_writeb(QTestState *s, uint64_t addr, uint8_t value);
 240
 241 /**
 242  * qtest_writew:
 243  * @s: #QTestState instance to operate on.
 244  * @addr: Guest address to write to.
 245  * @value: Value being written.
 246  *
 247  * Writes a 16-bit value to memory.
 248  */
 249 void qtest_writew(QTestState *s, uint64_t addr, uint16_t value);
 250
 251 /**
 252  * qtest_writel:
 253  * @s: #QTestState instance to operate on.
 254  * @addr: Guest address to write to.
 255  * @value: Value being written.
 256  *
 257  * Writes a 32-bit value to memory.
 258  */
 259 void qtest_writel(QTestState *s, uint64_t addr, uint32_t value);
 260
 261 /**
 262  * qtest_writeq:
 263  * @s: #QTestState instance to operate on.
 264  * @addr: Guest address to write to.
 265  * @value: Value being written.
 266  *
 267  * Writes a 64-bit value to memory.
 268  */
 269 void qtest_writeq(QTestState *s, uint64_t addr, uint64_t value);
 270
 271 /**
 272  * qtest_readb:
 273  * @s: #QTestState instance to operate on.
 274  * @addr: Guest address to read from.
 275  *
 276  * Reads an 8-bit value from memory.
 277  *
 278  * Returns: Value read.
 279  */
 280 uint8_t qtest_readb(QTestState *s, uint64_t addr);
 281
 282 /**
 283  * qtest_readw:
 284  * @s: #QTestState instance to operate on.
 285  * @addr: Guest address to read from.
 286  *
 287  * Reads a 16-bit value from memory.
 288  *
 289  * Returns: Value read.
 290  */
 291 uint16_t qtest_readw(QTestState *s, uint64_t addr);
 292
 293 /**
 294  * qtest_readl:
 295  * @s: #QTestState instance to operate on.
 296  * @addr: Guest address to read from.
 297  *
 298  * Reads a 32-bit value from memory.
 299  *
 300  * Returns: Value read.
 301  */
 302 uint32_t qtest_readl(QTestState *s, uint64_t addr);
 303
 304 /**
 305  * qtest_readq:
 306  * @s: #QTestState instance to operate on.
 307  * @addr: Guest address to read from.
 308  *
 309  * Reads a 64-bit value from memory.
 310  *
 311  * Returns: Value read.
 312  */
 313 uint64_t qtest_readq(QTestState *s, uint64_t addr);
 314
 315 /**
 316  * qtest_memread:
 317  * @s: #QTestState instance to operate on.
 318  * @addr: Guest address to read from.
 319  * @data: Pointer to where memory contents will be stored.
 320  * @size: Number of bytes to read.
 321  *
 322  * Read guest memory into a buffer.
 323  */
 324 void qtest_memread(QTestState *s, uint64_t addr, void *data, size_t size);
 325
 326 /**
 327  * qtest_bufread:
 328  * @s: #QTestState instance to operate on.
 329  * @addr: Guest address to read from.
 330  * @data: Pointer to where memory contents will be stored.
 331  * @size: Number of bytes to read.
 332  *
 333  * Read guest memory into a buffer and receive using a base64 encoding.
 334  */
 335 void qtest_bufread(QTestState *s, uint64_t addr, void *data, size_t size);
 336
 337 /**
 338  * qtest_memwrite:
 339  * @s: #QTestState instance to operate on.
 340  * @addr: Guest address to write to.
 341  * @data: Pointer to the bytes that will be written to guest memory.
 342  * @size: Number of bytes to write.
 343  *
 344  * Write a buffer to guest memory.
 345  */
 346 void qtest_memwrite(QTestState *s, uint64_t addr, const void *data, size_t size);
 347
 348 /**
 349  * qtest_bufwrite:
 350  * @s: #QTestState instance to operate on.
 351  * @addr: Guest address to write to.
 352  * @data: Pointer to the bytes that will be written to guest memory.
 353  * @size: Number of bytes to write.
 354  *
 355  * Write a buffer to guest memory and transmit using a base64 encoding.
 356  */
 357 void qtest_bufwrite(QTestState *s, uint64_t addr,
 358                     const void *data, size_t size);
 359
 360 /**
 361  * qtest_memset:
 362  * @s: #QTestState instance to operate on.
 363  * @addr: Guest address to write to.
 364  * @patt: Byte pattern to fill the guest memory region with.
 365  * @size: Number of bytes to write.
 366  *
 367  * Write a pattern to guest memory.
 368  */
 369 void qtest_memset(QTestState *s, uint64_t addr, uint8_t patt, size_t size);
 370
 371 /**
 372  * qtest_clock_step_next:
 373  * @s: #QTestState instance to operate on.
 374  *
 375  * Advance the QEMU_CLOCK_VIRTUAL to the next deadline.
 376  *
 377  * Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds.
 378  */
 379 int64_t qtest_clock_step_next(QTestState *s);
 380
 381 /**
 382  * qtest_clock_step:
 383  * @s: QTestState instance to operate on.
 384  * @step: Number of nanoseconds to advance the clock by.
 385  *
 386  * Advance the QEMU_CLOCK_VIRTUAL by @step nanoseconds.
 387  *
 388  * Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds.
 389  */
 390 int64_t qtest_clock_step(QTestState *s, int64_t step);
 391
 392 /**
 393  * qtest_clock_set:
 394  * @s: QTestState instance to operate on.
 395  * @val: Nanoseconds value to advance the clock to.
 396  *
 397  * Advance the QEMU_CLOCK_VIRTUAL to @val nanoseconds since the VM was launched.
 398  *
 399  * Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds.
 400  */
 401 int64_t qtest_clock_set(QTestState *s, int64_t val);
 402
 403 /**
 404  * qtest_get_arch:
 405  *
 406  * Returns: The architecture for the QEMU executable under test.
 407  */
 408 const char *qtest_get_arch(void);
 409
 410 /**
 411  * qtest_add_func:
 412  * @str: Test case path.
 413  * @fn: Test case function
 414  *
 415  * Add a GTester testcase with the given name and function.
 416  * The path is prefixed with the architecture under test, as
 417  * returned by qtest_get_arch().
 418  */
 419 void qtest_add_func(const char *str, void (*fn));
 420
 421 /**
 422  * qtest_add_data_func:
 423  * @str: Test case path.
 424  * @data: Test case data
 425  * @fn: Test case function
 426  *
 427  * Add a GTester testcase with the given name, data and function.
 428  * The path is prefixed with the architecture under test, as
 429  * returned by qtest_get_arch().
 430  */
 431 void qtest_add_data_func(const char *str, const void *data, void (*fn));
 432
 433 /**
 434  * qtest_add:
 435  * @testpath: Test case path
 436  * @Fixture: Fixture type
 437  * @tdata: Test case data
 438  * @fsetup: Test case setup function
 439  * @ftest: Test case function
 440  * @fteardown: Test case teardown function
 441  *
 442  * Add a GTester testcase with the given name, data and functions.
 443  * The path is prefixed with the architecture under test, as
 444  * returned by qtest_get_arch().
 445  */
 446 #define qtest_add(testpath, Fixture, tdata, fsetup, ftest, fteardown) \
 447     do { \
 448         char *path = g_strdup_printf("/%s/%s", qtest_get_arch(), testpath); \
 449         g_test_add(path, Fixture, tdata, fsetup, ftest, fteardown); \
 450         g_free(path); \
 451     } while (0)
 452
 453 /**
 454  * qtest_start:
 455  * @args: other arguments to pass to QEMU
 456  *
 457  * Start QEMU and assign the resulting #QTestState to a global variable.
 458  * The global variable is used by "shortcut" functions documented below.
 459  *
 460  * Returns: #QTestState instance.
 461  */
 462 static inline QTestState *qtest_start(const char *args)
 463 {
 464     global_qtest = qtest_init(args);
 465     return global_qtest;
 466 }
 467
 468 /**
 469  * qtest_end:
 470  *
 471  * Shut down the QEMU process started by qtest_start().
 472  */
 473 static inline void qtest_end(void)
 474 {
 475     qtest_quit(global_qtest);
 476     global_qtest = NULL;
 477 }
 478
 479 /**
 480  * qmp:
 481  * @fmt...: QMP message to send to qemu
 482  *
 483  * Sends a QMP message to QEMU and returns the response.
 484  */
 485 QDict *qmp(const char *fmt, ...);
 486
 487 /**
 488  * qmp_async:
 489  * @fmt...: QMP message to send to qemu
 490  *
 491  * Sends a QMP message to QEMU and leaves the response in the stream.
 492  */
 493 void qmp_async(const char *fmt, ...);
 494
 495 /**
 496  * qmp_discard_response:
 497  * @fmt...: QMP message to send to qemu
 498  *
 499  * Sends a QMP message to QEMU and consumes the response.
 500  */
 501 void qmp_discard_response(const char *fmt, ...);
 502
 503 /**
 504  * qmp_receive:
 505  *
 506  * Reads a QMP message from QEMU and returns the response.
 507  */
 508 static inline QDict *qmp_receive(void)
 509 {
 510     return qtest_qmp_receive(global_qtest);
 511 }
 512
 513 /**
 514  * qmp_eventwait:
 515  * @s: #event event to wait for.
 516  *
 517  * Continuosly polls for QMP responses until it receives the desired event.
 518  */
 519 static inline void qmp_eventwait(const char *event)
 520 {
 521     return qtest_qmp_eventwait(global_qtest, event);
 522 }
 523
 524 /**
 525  * hmp:
 526  * @fmt...: HMP command to send to QEMU
 527  *
 528  * Send HMP command to QEMU via QMP's human-monitor-command.
 529  *
 530  * Returns: the command's output.  The caller should g_free() it.
 531  */
 532 char *hmp(const char *fmt, ...);
 533
 534 /**
 535  * get_irq:
 536  * @num: Interrupt to observe.
 537  *
 538  * Returns: The level of the @num interrupt.
 539  */
 540 static inline bool get_irq(int num)
 541 {
 542     return qtest_get_irq(global_qtest, num);
 543 }
 544
 545 /**
 546  * irq_intercept_in:
 547  * @string: QOM path of a device.
 548  *
 549  * Associate qtest irqs with the GPIO-in pins of the device
 550  * whose path is specified by @string.
 551  */
 552 static inline void irq_intercept_in(const char *string)
 553 {
 554     qtest_irq_intercept_in(global_qtest, string);
 555 }
 556
 557 /**
 558  * qtest_irq_intercept_out:
 559  * @string: QOM path of a device.
 560  *
 561  * Associate qtest irqs with the GPIO-out pins of the device
 562  * whose path is specified by @string.
 563  */
 564 static inline void irq_intercept_out(const char *string)
 565 {
 566     qtest_irq_intercept_out(global_qtest, string);
 567 }
 568
 569 /**
 570  * outb:
 571  * @addr: I/O port to write to.
 572  * @value: Value being written.
 573  *
 574  * Write an 8-bit value to an I/O port.
 575  */
 576 static inline void outb(uint16_t addr, uint8_t value)
 577 {
 578     qtest_outb(global_qtest, addr, value);
 579 }
 580
 581 /**
 582  * outw:
 583  * @addr: I/O port to write to.
 584  * @value: Value being written.
 585  *
 586  * Write a 16-bit value to an I/O port.
 587  */
 588 static inline void outw(uint16_t addr, uint16_t value)
 589 {
 590     qtest_outw(global_qtest, addr, value);
 591 }
 592
 593 /**
 594  * outl:
 595  * @addr: I/O port to write to.
 596  * @value: Value being written.
 597  *
 598  * Write a 32-bit value to an I/O port.
 599  */
 600 static inline void outl(uint16_t addr, uint32_t value)
 601 {
 602     qtest_outl(global_qtest, addr, value);
 603 }
 604
 605 /**
 606  * inb:
 607  * @addr: I/O port to read from.
 608  *
 609  * Reads an 8-bit value from an I/O port.
 610  *
 611  * Returns: Value read.
 612  */
 613 static inline uint8_t inb(uint16_t addr)
 614 {
 615     return qtest_inb(global_qtest, addr);
 616 }
 617
 618 /**
 619  * inw:
 620  * @addr: I/O port to read from.
 621  *
 622  * Reads a 16-bit value from an I/O port.
 623  *
 624  * Returns: Value read.
 625  */
 626 static inline uint16_t inw(uint16_t addr)
 627 {
 628     return qtest_inw(global_qtest, addr);
 629 }
 630
 631 /**
 632  * inl:
 633  * @addr: I/O port to read from.
 634  *
 635  * Reads a 32-bit value from an I/O port.
 636  *
 637  * Returns: Value read.
 638  */
 639 static inline uint32_t inl(uint16_t addr)
 640 {
 641     return qtest_inl(global_qtest, addr);
 642 }
 643
 644 /**
 645  * writeb:
 646  * @addr: Guest address to write to.
 647  * @value: Value being written.
 648  *
 649  * Writes an 8-bit value to guest memory.
 650  */
 651 static inline void writeb(uint64_t addr, uint8_t value)
 652 {
 653     qtest_writeb(global_qtest, addr, value);
 654 }
 655
 656 /**
 657  * writew:
 658  * @addr: Guest address to write to.
 659  * @value: Value being written.
 660  *
 661  * Writes a 16-bit value to guest memory.
 662  */
 663 static inline void writew(uint64_t addr, uint16_t value)
 664 {
 665     qtest_writew(global_qtest, addr, value);
 666 }
 667
 668 /**
 669  * writel:
 670  * @addr: Guest address to write to.
 671  * @value: Value being written.
 672  *
 673  * Writes a 32-bit value to guest memory.
 674  */
 675 static inline void writel(uint64_t addr, uint32_t value)
 676 {
 677     qtest_writel(global_qtest, addr, value);
 678 }
 679
 680 /**
 681  * writeq:
 682  * @addr: Guest address to write to.
 683  * @value: Value being written.
 684  *
 685  * Writes a 64-bit value to guest memory.
 686  */
 687 static inline void writeq(uint64_t addr, uint64_t value)
 688 {
 689     qtest_writeq(global_qtest, addr, value);
 690 }
 691
 692 /**
 693  * readb:
 694  * @addr: Guest address to read from.
 695  *
 696  * Reads an 8-bit value from guest memory.
 697  *
 698  * Returns: Value read.
 699  */
 700 static inline uint8_t readb(uint64_t addr)
 701 {
 702     return qtest_readb(global_qtest, addr);
 703 }
 704
 705 /**
 706  * readw:
 707  * @addr: Guest address to read from.
 708  *
 709  * Reads a 16-bit value from guest memory.
 710  *
 711  * Returns: Value read.
 712  */
 713 static inline uint16_t readw(uint64_t addr)
 714 {
 715     return qtest_readw(global_qtest, addr);
 716 }
 717
 718 /**
 719  * readl:
 720  * @addr: Guest address to read from.
 721  *
 722  * Reads a 32-bit value from guest memory.
 723  *
 724  * Returns: Value read.
 725  */
 726 static inline uint32_t readl(uint64_t addr)
 727 {
 728     return qtest_readl(global_qtest, addr);
 729 }
 730
 731 /**
 732  * readq:
 733  * @addr: Guest address to read from.
 734  *
 735  * Reads a 64-bit value from guest memory.
 736  *
 737  * Returns: Value read.
 738  */
 739 static inline uint64_t readq(uint64_t addr)
 740 {
 741     return qtest_readq(global_qtest, addr);
 742 }
 743
 744 /**
 745  * memread:
 746  * @addr: Guest address to read from.
 747  * @data: Pointer to where memory contents will be stored.
 748  * @size: Number of bytes to read.
 749  *
 750  * Read guest memory into a buffer.
 751  */
 752 static inline void memread(uint64_t addr, void *data, size_t size)
 753 {
 754     qtest_memread(global_qtest, addr, data, size);
 755 }
 756
 757 /**
 758  * bufread:
 759  * @addr: Guest address to read from.
 760  * @data: Pointer to where memory contents will be stored.
 761  * @size: Number of bytes to read.
 762  *
 763  * Read guest memory into a buffer, receive using a base64 encoding.
 764  */
 765 static inline void bufread(uint64_t addr, void *data, size_t size)
 766 {
 767     qtest_bufread(global_qtest, addr, data, size);
 768 }
 769
 770 /**
 771  * memwrite:
 772  * @addr: Guest address to write to.
 773  * @data: Pointer to the bytes that will be written to guest memory.
 774  * @size: Number of bytes to write.
 775  *
 776  * Write a buffer to guest memory.
 777  */
 778 static inline void memwrite(uint64_t addr, const void *data, size_t size)
 779 {
 780     qtest_memwrite(global_qtest, addr, data, size);
 781 }
 782
 783 /**
 784  * bufwrite:
 785  * @addr: Guest address to write to.
 786  * @data: Pointer to the bytes that will be written to guest memory.
 787  * @size: Number of bytes to write.
 788  *
 789  * Write a buffer to guest memory, transmit using a base64 encoding.
 790  */
 791 static inline void bufwrite(uint64_t addr, const void *data, size_t size)
 792 {
 793     qtest_bufwrite(global_qtest, addr, data, size);
 794 }
 795
 796 /**
 797  * qmemset:
 798  * @addr: Guest address to write to.
 799  * @patt: Byte pattern to fill the guest memory region with.
 800  * @size: Number of bytes to write.
 801  *
 802  * Write a pattern to guest memory.
 803  */
 804 static inline void qmemset(uint64_t addr, uint8_t patt, size_t size)
 805 {
 806     qtest_memset(global_qtest, addr, patt, size);
 807 }
 808
 809 /**
 810  * clock_step_next:
 811  *
 812  * Advance the QEMU_CLOCK_VIRTUAL to the next deadline.
 813  *
 814  * Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds.
 815  */
 816 static inline int64_t clock_step_next(void)
 817 {
 818     return qtest_clock_step_next(global_qtest);
 819 }
 820
 821 /**
 822  * clock_step:
 823  * @step: Number of nanoseconds to advance the clock by.
 824  *
 825  * Advance the QEMU_CLOCK_VIRTUAL by @step nanoseconds.
 826  *
 827  * Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds.
 828  */
 829 static inline int64_t clock_step(int64_t step)
 830 {
 831     return qtest_clock_step(global_qtest, step);
 832 }
 833
 834 /**
 835  * clock_set:
 836  * @val: Nanoseconds value to advance the clock to.
 837  *
 838  * Advance the QEMU_CLOCK_VIRTUAL to @val nanoseconds since the VM was launched.
 839  *
 840  * Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds.
 841  */
 842 static inline int64_t clock_set(int64_t val)
 843 {
 844     return qtest_clock_set(global_qtest, val);
 845 }
 846
 847 /**
 848  * qtest_big_endian:
 849  *
 850  * Returns: True if the architecture under test has a big endian configuration.
 851  */
 852 bool qtest_big_endian(void);
 853
 854 #endif