docs/xtf/common_2setup_8c_source.html

 #include <xtf/compiler.h>
 #include <xtf/hypercall.h>
 #include <xtf/framework.h>
 #include <xtf/test.h>
 #include <xtf/console.h>
 #include <xtf/report.h>

 void __noreturn xtf_main(void)
 {
     arch_setup();

     printk("--- Xen Test Framework ---\n");
     printk("Environment: %s\n", environment_description);
     printk("%s\n", test_title);

     test_setup();

     if ( !xtf_status_reported() )
     {
         test_main();
     }

     /* Report status and exit. */
     xtf_exit();
 }

 static void __maybe_unused build_assertions(void)
 {
     BUILD_BUG_ON(BITS_PER_LONG != 32 &&
                  BITS_PER_LONG != 64);
 }

 /*
  * Local variables:
  * mode: C
  * c-file-style: "BSD"
  * c-basic-offset: 4
  * tab-width: 4
  * indent-tabs-mode: nil
  * End:
  */
test.h
API for tests.

__noreturn
#define __noreturn
Definition: compiler.h:10

framework.h
Interfaces used by common code, needing to be implemented by arch/environment specific code...

xtf_exit
void xtf_exit(void)
Exit the test early.
Definition: report.c:124

printk
void printk(const char *fmt,...)
Definition: console.c:134

compiler.h

arch_setup
void arch_setup(void)
Definition: setup.c:246

test_setup
void test_setup(void)
Definition: setup.c:289

xtf_main
void xtf_main(void)
Entry point into C.
Definition: setup.c:20

console.h

hypercall.h

environment_description
const char environment_description[]
Definition: setup.c:30

test_main
void test_main(void)
To be implemented by each test, as its entry point.
Definition: main.c:137

build_assertions
static void build_assertions(void)
Some basic assertions about the compile environment.
Definition: setup.c:42

BITS_PER_LONG
#define BITS_PER_LONG
Definition: limits.h:12

test_title
const char test_title[]
The title of the test.
Definition: main.c:14

BUILD_BUG_ON
#define BUILD_BUG_ON(cond)
Definition: lib.h:24

__maybe_unused
#define __maybe_unused
Definition: compiler.h:13

xtf_status_reported
bool xtf_status_reported(void)
Query whether a status has already been reported.
Definition: report.c:119

report.h
API for reporting test status.