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_qmpv_discard_response:
  68  * @s: #QTestState instance to operate on.
  69  * @fmt: QMP message to send to QEMU
  70  * @ap: QMP message arguments
  71  *
  72  * Sends a QMP message to QEMU and consumes the response.
  73  */
  74 void qtest_qmpv_discard_response(QTestState *s, const char *fmt, va_list ap);
  75
  76 /**
  77  * qtest_qmpv:
  78  * @s: #QTestState instance to operate on.
  79  * @fmt: QMP message to send to QEMU
  80  * @ap: QMP message arguments
  81  *
  82  * Sends a QMP message to QEMU and returns the response.
  83  */
  84 QDict *qtest_qmpv(QTestState *s, const char *fmt, va_list ap);
  85
  86 /**
  87  * qtest_receive:
  88  * @s: #QTestState instance to operate on.
  89  *
  90  * Reads a QMP message from QEMU and returns the response.
  91  */
  92 QDict *qtest_qmp_receive(QTestState *s);
  93
  94 /**
  95  * qtest_get_irq:
  96  * @s: #QTestState instance to operate on.
  97  * @num: Interrupt to observe.
  98  *
  99  * Returns: The level of the @num interrupt.
 100  */
 101 bool qtest_get_irq(QTestState *s, int num);
 102
 103 /**
 104  * qtest_irq_intercept_in:
 105  * @s: #QTestState instance to operate on.
 106  * @string: QOM path of a device.
 107  *
 108  * Associate qtest irqs with the GPIO-in pins of the device
 109  * whose path is specified by @string.
 110  */
 111 void qtest_irq_intercept_in(QTestState *s, const char *string);
 112
 113 /**
 114  * qtest_irq_intercept_out:
 115  * @s: #QTestState instance to operate on.
 116  * @string: QOM path of a device.
 117  *
 118  * Associate qtest irqs with the GPIO-out pins of the device
 119  * whose path is specified by @string.
 120  */
 121 void qtest_irq_intercept_out(QTestState *s, const char *string);
 122
 123 /**
 124  * qtest_outb:
 125  * @s: #QTestState instance to operate on.
 126  * @addr: I/O port to write to.
 127  * @value: Value being written.
 128  *
 129  * Write an 8-bit value to an I/O port.
 130  */
 131 void qtest_outb(QTestState *s, uint16_t addr, uint8_t value);
 132
 133 /**
 134  * qtest_outw:
 135  * @s: #QTestState instance to operate on.
 136  * @addr: I/O port to write to.
 137  * @value: Value being written.
 138  *
 139  * Write a 16-bit value to an I/O port.
 140  */
 141 void qtest_outw(QTestState *s, uint16_t addr, uint16_t value);
 142
 143 /**
 144  * qtest_outl:
 145  * @s: #QTestState instance to operate on.
 146  * @addr: I/O port to write to.
 147  * @value: Value being written.
 148  *
 149  * Write a 32-bit value to an I/O port.
 150  */
 151 void qtest_outl(QTestState *s, uint16_t addr, uint32_t value);
 152
 153 /**
 154  * qtest_inb:
 155  * @s: #QTestState instance to operate on.
 156  * @addr: I/O port to read from.
 157  *
 158  * Returns an 8-bit value from an I/O port.
 159  */
 160 uint8_t qtest_inb(QTestState *s, uint16_t addr);
 161
 162 /**
 163  * qtest_inw:
 164  * @s: #QTestState instance to operate on.
 165  * @addr: I/O port to read from.
 166  *
 167  * Returns a 16-bit value from an I/O port.
 168  */
 169 uint16_t qtest_inw(QTestState *s, uint16_t addr);
 170
 171 /**
 172  * qtest_inl:
 173  * @s: #QTestState instance to operate on.
 174  * @addr: I/O port to read from.
 175  *
 176  * Returns a 32-bit value from an I/O port.
 177  */
 178 uint32_t qtest_inl(QTestState *s, uint16_t addr);
 179
 180 /**
 181  * qtest_writeb:
 182  * @s: #QTestState instance to operate on.
 183  * @addr: Guest address to write to.
 184  * @value: Value being written.
 185  *
 186  * Writes an 8-bit value to memory.
 187  */
 188 void qtest_writeb(QTestState *s, uint64_t addr, uint8_t value);
 189
 190 /**
 191  * qtest_writew:
 192  * @s: #QTestState instance to operate on.
 193  * @addr: Guest address to write to.
 194  * @value: Value being written.
 195  *
 196  * Writes a 16-bit value to memory.
 197  */
 198 void qtest_writew(QTestState *s, uint64_t addr, uint16_t value);
 199
 200 /**
 201  * qtest_writel:
 202  * @s: #QTestState instance to operate on.
 203  * @addr: Guest address to write to.
 204  * @value: Value being written.
 205  *
 206  * Writes a 32-bit value to memory.
 207  */
 208 void qtest_writel(QTestState *s, uint64_t addr, uint32_t value);
 209
 210 /**
 211  * qtest_writeq:
 212  * @s: #QTestState instance to operate on.
 213  * @addr: Guest address to write to.
 214  * @value: Value being written.
 215  *
 216  * Writes a 64-bit value to memory.
 217  */
 218 void qtest_writeq(QTestState *s, uint64_t addr, uint64_t value);
 219
 220 /**
 221  * qtest_readb:
 222  * @s: #QTestState instance to operate on.
 223  * @addr: Guest address to read from.
 224  *
 225  * Reads an 8-bit value from memory.
 226  *
 227  * Returns: Value read.
 228  */
 229 uint8_t qtest_readb(QTestState *s, uint64_t addr);
 230
 231 /**
 232  * qtest_readw:
 233  * @s: #QTestState instance to operate on.
 234  * @addr: Guest address to read from.
 235  *
 236  * Reads a 16-bit value from memory.
 237  *
 238  * Returns: Value read.
 239  */
 240 uint16_t qtest_readw(QTestState *s, uint64_t addr);
 241
 242 /**
 243  * qtest_readl:
 244  * @s: #QTestState instance to operate on.
 245  * @addr: Guest address to read from.
 246  *
 247  * Reads a 32-bit value from memory.
 248  *
 249  * Returns: Value read.
 250  */
 251 uint32_t qtest_readl(QTestState *s, uint64_t addr);
 252
 253 /**
 254  * qtest_readq:
 255  * @s: #QTestState instance to operate on.
 256  * @addr: Guest address to read from.
 257  *
 258  * Reads a 64-bit value from memory.
 259  *
 260  * Returns: Value read.
 261  */
 262 uint64_t qtest_readq(QTestState *s, uint64_t addr);
 263
 264 /**
 265  * qtest_memread:
 266  * @s: #QTestState instance to operate on.
 267  * @addr: Guest address to read from.
 268  * @data: Pointer to where memory contents will be stored.
 269  * @size: Number of bytes to read.
 270  *
 271  * Read guest memory into a buffer.
 272  */
 273 void qtest_memread(QTestState *s, uint64_t addr, void *data, size_t size);
 274
 275 /**
 276  * qtest_memwrite:
 277  * @s: #QTestState instance to operate on.
 278  * @addr: Guest address to write to.
 279  * @data: Pointer to the bytes that will be written to guest memory.
 280  * @size: Number of bytes to write.
 281  *
 282  * Write a buffer to guest memory.
 283  */
 284 void qtest_memwrite(QTestState *s, uint64_t addr, const void *data, size_t size);
 285
 286 /**
 287  * qtest_memset:
 288  * @s: #QTestState instance to operate on.
 289  * @addr: Guest address to write to.
 290  * @patt: Byte pattern to fill the guest memory region with.
 291  * @size: Number of bytes to write.
 292  *
 293  * Write a pattern to guest memory.
 294  */
 295 void qtest_memset(QTestState *s, uint64_t addr, uint8_t patt, size_t size);
 296
 297 /**
 298  * qtest_clock_step_next:
 299  * @s: #QTestState instance to operate on.
 300  *
 301  * Advance the QEMU_CLOCK_VIRTUAL to the next deadline.
 302  *
 303  * Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds.
 304  */
 305 int64_t qtest_clock_step_next(QTestState *s);
 306
 307 /**
 308  * qtest_clock_step:
 309  * @s: QTestState instance to operate on.
 310  * @step: Number of nanoseconds to advance the clock by.
 311  *
 312  * Advance the QEMU_CLOCK_VIRTUAL by @step nanoseconds.
 313  *
 314  * Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds.
 315  */
 316 int64_t qtest_clock_step(QTestState *s, int64_t step);
 317
 318 /**
 319  * qtest_clock_set:
 320  * @s: QTestState instance to operate on.
 321  * @val: Nanoseconds value to advance the clock to.
 322  *
 323  * Advance the QEMU_CLOCK_VIRTUAL to @val nanoseconds since the VM was launched.
 324  *
 325  * Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds.
 326  */
 327 int64_t qtest_clock_set(QTestState *s, int64_t val);
 328
 329 /**
 330  * qtest_get_arch:
 331  *
 332  * Returns: The architecture for the QEMU executable under test.
 333  */
 334 const char *qtest_get_arch(void);
 335
 336 /**
 337  * qtest_add_func:
 338  * @str: Test case path.
 339  * @fn: Test case function
 340  *
 341  * Add a GTester testcase with the given name and function.
 342  * The path is prefixed with the architecture under test, as
 343  * returned by qtest_get_arch().
 344  */
 345 void qtest_add_func(const char *str, void (*fn));
 346
 347 /**
 348  * qtest_add_data_func:
 349  * @str: Test case path.
 350  * @data: Test case data
 351  * @fn: Test case function
 352  *
 353  * Add a GTester testcase with the given name, data and function.
 354  * The path is prefixed with the architecture under test, as
 355  * returned by qtest_get_arch().
 356  */
 357 void qtest_add_data_func(const char *str, const void *data, void (*fn));
 358
 359 /**
 360  * qtest_add:
 361  * @testpath: Test case path
 362  * @Fixture: Fixture type
 363  * @tdata: Test case data
 364  * @fsetup: Test case setup function
 365  * @ftest: Test case function
 366  * @fteardown: Test case teardown function
 367  *
 368  * Add a GTester testcase with the given name, data and functions.
 369  * The path is prefixed with the architecture under test, as
 370  * returned by qtest_get_arch().
 371  */
 372 #define qtest_add(testpath, Fixture, tdata, fsetup, ftest, fteardown) \
 373     do { \
 374         char *path = g_strdup_printf("/%s/%s", qtest_get_arch(), testpath); \
 375         g_test_add(path, Fixture, tdata, fsetup, ftest, fteardown); \
 376         g_free(path); \
 377     } while (0)
 378
 379 /**
 380  * qtest_start:
 381  * @args: other arguments to pass to QEMU
 382  *
 383  * Start QEMU and assign the resulting #QTestState to a global variable.
 384  * The global variable is used by "shortcut" functions documented below.
 385  *
 386  * Returns: #QTestState instance.
 387  */
 388 static inline QTestState *qtest_start(const char *args)
 389 {
 390     global_qtest = qtest_init(args);
 391     return global_qtest;
 392 }
 393
 394 /**
 395  * qtest_end:
 396  *
 397  * Shut down the QEMU process started by qtest_start().
 398  */
 399 static inline void qtest_end(void)
 400 {
 401     qtest_quit(global_qtest);
 402     global_qtest = NULL;
 403 }
 404
 405 /**
 406  * qmp:
 407  * @fmt...: QMP message to send to qemu
 408  *
 409  * Sends a QMP message to QEMU and returns the response.
 410  */
 411 QDict *qmp(const char *fmt, ...);
 412
 413 /**
 414  * qmp_discard_response:
 415  * @fmt...: QMP message to send to qemu
 416  *
 417  * Sends a QMP message to QEMU and consumes the response.
 418  */
 419 void qmp_discard_response(const char *fmt, ...);
 420
 421 /**
 422  * qmp_receive:
 423  *
 424  * Reads a QMP message from QEMU and returns the response.
 425  */
 426 static inline QDict *qmp_receive(void)
 427 {
 428     return qtest_qmp_receive(global_qtest);
 429 }
 430
 431 /**
 432  * get_irq:
 433  * @num: Interrupt to observe.
 434  *
 435  * Returns: The level of the @num interrupt.
 436  */
 437 static inline bool get_irq(int num)
 438 {
 439     return qtest_get_irq(global_qtest, num);
 440 }
 441
 442 /**
 443  * irq_intercept_in:
 444  * @string: QOM path of a device.
 445  *
 446  * Associate qtest irqs with the GPIO-in pins of the device
 447  * whose path is specified by @string.
 448  */
 449 static inline void irq_intercept_in(const char *string)
 450 {
 451     qtest_irq_intercept_in(global_qtest, string);
 452 }
 453
 454 /**
 455  * qtest_irq_intercept_out:
 456  * @string: QOM path of a device.
 457  *
 458  * Associate qtest irqs with the GPIO-out pins of the device
 459  * whose path is specified by @string.
 460  */
 461 static inline void irq_intercept_out(const char *string)
 462 {
 463     qtest_irq_intercept_out(global_qtest, string);
 464 }
 465
 466 /**
 467  * outb:
 468  * @addr: I/O port to write to.
 469  * @value: Value being written.
 470  *
 471  * Write an 8-bit value to an I/O port.
 472  */
 473 static inline void outb(uint16_t addr, uint8_t value)
 474 {
 475     qtest_outb(global_qtest, addr, value);
 476 }
 477
 478 /**
 479  * outw:
 480  * @addr: I/O port to write to.
 481  * @value: Value being written.
 482  *
 483  * Write a 16-bit value to an I/O port.
 484  */
 485 static inline void outw(uint16_t addr, uint16_t value)
 486 {
 487     qtest_outw(global_qtest, addr, value);
 488 }
 489
 490 /**
 491  * outl:
 492  * @addr: I/O port to write to.
 493  * @value: Value being written.
 494  *
 495  * Write a 32-bit value to an I/O port.
 496  */
 497 static inline void outl(uint16_t addr, uint32_t value)
 498 {
 499     qtest_outl(global_qtest, addr, value);
 500 }
 501
 502 /**
 503  * inb:
 504  * @addr: I/O port to read from.
 505  *
 506  * Reads an 8-bit value from an I/O port.
 507  *
 508  * Returns: Value read.
 509  */
 510 static inline uint8_t inb(uint16_t addr)
 511 {
 512     return qtest_inb(global_qtest, addr);
 513 }
 514
 515 /**
 516  * inw:
 517  * @addr: I/O port to read from.
 518  *
 519  * Reads a 16-bit value from an I/O port.
 520  *
 521  * Returns: Value read.
 522  */
 523 static inline uint16_t inw(uint16_t addr)
 524 {
 525     return qtest_inw(global_qtest, addr);
 526 }
 527
 528 /**
 529  * inl:
 530  * @addr: I/O port to read from.
 531  *
 532  * Reads a 32-bit value from an I/O port.
 533  *
 534  * Returns: Value read.
 535  */
 536 static inline uint32_t inl(uint16_t addr)
 537 {
 538     return qtest_inl(global_qtest, addr);
 539 }
 540
 541 /**
 542  * writeb:
 543  * @addr: Guest address to write to.
 544  * @value: Value being written.
 545  *
 546  * Writes an 8-bit value to guest memory.
 547  */
 548 static inline void writeb(uint64_t addr, uint8_t value)
 549 {
 550     qtest_writeb(global_qtest, addr, value);
 551 }
 552
 553 /**
 554  * writew:
 555  * @addr: Guest address to write to.
 556  * @value: Value being written.
 557  *
 558  * Writes a 16-bit value to guest memory.
 559  */
 560 static inline void writew(uint64_t addr, uint16_t value)
 561 {
 562     qtest_writew(global_qtest, addr, value);
 563 }
 564
 565 /**
 566  * writel:
 567  * @addr: Guest address to write to.
 568  * @value: Value being written.
 569  *
 570  * Writes a 32-bit value to guest memory.
 571  */
 572 static inline void writel(uint64_t addr, uint32_t value)
 573 {
 574     qtest_writel(global_qtest, addr, value);
 575 }
 576
 577 /**
 578  * writeq:
 579  * @addr: Guest address to write to.
 580  * @value: Value being written.
 581  *
 582  * Writes a 64-bit value to guest memory.
 583  */
 584 static inline void writeq(uint64_t addr, uint64_t value)
 585 {
 586     qtest_writeq(global_qtest, addr, value);
 587 }
 588
 589 /**
 590  * readb:
 591  * @addr: Guest address to read from.
 592  *
 593  * Reads an 8-bit value from guest memory.
 594  *
 595  * Returns: Value read.
 596  */
 597 static inline uint8_t readb(uint64_t addr)
 598 {
 599     return qtest_readb(global_qtest, addr);
 600 }
 601
 602 /**
 603  * readw:
 604  * @addr: Guest address to read from.
 605  *
 606  * Reads a 16-bit value from guest memory.
 607  *
 608  * Returns: Value read.
 609  */
 610 static inline uint16_t readw(uint64_t addr)
 611 {
 612     return qtest_readw(global_qtest, addr);
 613 }
 614
 615 /**
 616  * readl:
 617  * @addr: Guest address to read from.
 618  *
 619  * Reads a 32-bit value from guest memory.
 620  *
 621  * Returns: Value read.
 622  */
 623 static inline uint32_t readl(uint64_t addr)
 624 {
 625     return qtest_readl(global_qtest, addr);
 626 }
 627
 628 /**
 629  * readq:
 630  * @addr: Guest address to read from.
 631  *
 632  * Reads a 64-bit value from guest memory.
 633  *
 634  * Returns: Value read.
 635  */
 636 static inline uint64_t readq(uint64_t addr)
 637 {
 638     return qtest_readq(global_qtest, addr);
 639 }
 640
 641 /**
 642  * memread:
 643  * @addr: Guest address to read from.
 644  * @data: Pointer to where memory contents will be stored.
 645  * @size: Number of bytes to read.
 646  *
 647  * Read guest memory into a buffer.
 648  */
 649 static inline void memread(uint64_t addr, void *data, size_t size)
 650 {
 651     qtest_memread(global_qtest, addr, data, size);
 652 }
 653
 654 /**
 655  * memwrite:
 656  * @addr: Guest address to write to.
 657  * @data: Pointer to the bytes that will be written to guest memory.
 658  * @size: Number of bytes to write.
 659  *
 660  * Write a buffer to guest memory.
 661  */
 662 static inline void memwrite(uint64_t addr, const void *data, size_t size)
 663 {
 664     qtest_memwrite(global_qtest, addr, data, size);
 665 }
 666
 667 /**
 668  * qmemset:
 669  * @addr: Guest address to write to.
 670  * @patt: Byte pattern to fill the guest memory region with.
 671  * @size: Number of bytes to write.
 672  *
 673  * Write a pattern to guest memory.
 674  */
 675 static inline void qmemset(uint64_t addr, uint8_t patt, size_t size)
 676 {
 677     qtest_memset(global_qtest, addr, patt, size);
 678 }
 679
 680 /**
 681  * clock_step_next:
 682  *
 683  * Advance the QEMU_CLOCK_VIRTUAL to the next deadline.
 684  *
 685  * Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds.
 686  */
 687 static inline int64_t clock_step_next(void)
 688 {
 689     return qtest_clock_step_next(global_qtest);
 690 }
 691
 692 /**
 693  * clock_step:
 694  * @step: Number of nanoseconds to advance the clock by.
 695  *
 696  * Advance the QEMU_CLOCK_VIRTUAL by @step nanoseconds.
 697  *
 698  * Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds.
 699  */
 700 static inline int64_t clock_step(int64_t step)
 701 {
 702     return qtest_clock_step(global_qtest, step);
 703 }
 704
 705 /**
 706  * clock_set:
 707  * @val: Nanoseconds value to advance the clock to.
 708  *
 709  * Advance the QEMU_CLOCK_VIRTUAL to @val nanoseconds since the VM was launched.
 710  *
 711  * Returns: The current value of the QEMU_CLOCK_VIRTUAL in nanoseconds.
 712  */
 713 static inline int64_t clock_set(int64_t val)
 714 {
 715     return qtest_clock_set(global_qtest, val);
 716 }
 717
 718 /**
 719  * qtest_big_endian:
 720  *
 721  * Returns: True if the architecture under test has a big endian configuration.
 722  */
 723 bool qtest_big_endian(void);
 724
 725 #endif