At most a bit of comment of function declaration movement for more
polish. One tricky bit is to #ifdef out (only for gtkdoc of course)
the struct option; forward declaration - gtkdoc needlessly lists it.
FIXME: The struct documentation for igt_helper_process somehow doesn't
get picked up ... Same issue seems to be with the igt_log_level enum,
I've shoveled the relevant documentation into igt_log in free-form for
now.
Signed-off-by: Daniel Vetter <daniel.vetter@xxxxxxxx>
---
lib/igt_core.c | 197 +++++++++++++++++++++++++++++++++++---
lib/igt_core.h | 298 +++++++++++++++++++++++++++++++++++++++++++--------------
2 files changed, 412 insertions(+), 83 deletions(-)
diff --git a/lib/igt_core.c b/lib/igt_core.c
index 27c159c69ae8..13259b611c23 100644
--- a/lib/igt_core.c
+++ b/lib/igt_core.c
@@ -72,6 +72,17 @@
* result propagation. Other generally useful functionality includes optional
* structure logging infrastructure and some support code for running reduced
* test set on in simulated hardware environments.
+ *
+ * When writing tests with subtests it is extremely important that nothing
+ * interferes with the subtest enumeration. In i-g-t subtests are enumerated at
+ * runtime, which allows powerful testcase enumeration. But it makes subtest
+ * enumeration a bit more tricky since the test code needs to be careful to
+ * never run any code which might fail (like trying to do privileged operations
+ * or opening device driver nodes).
+ *
+ * To allow this i-g-t provides #igt_fixture code blocks for setup code outside
+ * of subtests and automatically skips the subtest code blocks themselves. For
+ * special cases igt_only_list_subtests() is also provided.
*/
static unsigned int exit_handler_count;
@@ -165,6 +176,25 @@ static void oom_adjust_for_doom(void)
igt_assert(write(fd, always_kill, sizeof(always_kill)) == sizeof(always_kill));
}
+/**
+ * igt_subtest_init_parse_opts:
+ * @argc: argc from the test's main()
+ * @argv: argv from the test's main()
+ * @extra_short_opts: getopt_long() compliant list with additional short options
+ * @extra_long_opts: getopt_long() compliant list with additional long options
+ * @help_str: help string for the additional options
+ * @extra_opt_handler: handler for the additional options
+ *
+ * This function handles the subtest related cmdline options and allows an
+ * arbitrary set of additional options. This is useful for tests which have
+ * additional knobs to tune when run manually like the number of rounds execute
+ * or the size of the allocated buffer objects.
+ *
+ * Tests without special needs should just use igt_subtest_init() or use
+ * #igt_main directly instead of their own main() function.
+ *
+ * Returns: Forwards any option parsing errors from getopt_long.
+ */
int igt_subtest_init_parse_opts(int argc, char **argv,
const char *extra_short_opts,
struct option *extra_long_opts,
@@ -274,6 +304,19 @@ static void common_init(void)
igt_log_level = IGT_LOG_NONE;
}
+/**
+ * igt_subtest_init:
+ * @argc: argc from the test's main()
+ * @argv: argv from the test's main()
+ *
+ * This initializes the for tests with subtests without the need for additional
+ * cmdline options. It is just a simplified version of
+ * igt_subtest_init_parse_opts().
+ *
+ * If there's not a reason to the contrary it's less error prone to just use an
+ * #igt_main block instead of stitching the tests's main() function together
+ * manually.
+ */
void igt_subtest_init(int argc, char **argv)
{
int ret;
@@ -292,6 +335,15 @@ void igt_subtest_init(int argc, char **argv)
common_init();
}
+/**
+ * igt_simple_init:
+ *
+ * This initializes a simple test without any support for subtests.
+ *
+ * If there's not a reason to the contrary it's less error prone to just use an
+ * #igt_simple_main block instead of stitching the tests's main() function together
+ * manually.
+ */
void igt_simple_init(void)
{
print_version();
@@ -330,11 +382,23 @@ bool __igt_run_subtest(const char *subtest_name)
return (in_subtest = subtest_name);
}
+/**
+ * igt_subtest_name:
+ *
+ * Returns: The name of the currently executed subtest or NULL if called from
+ * outside a subtest block.
+ */
const char *igt_subtest_name(void)
{
return in_subtest;
}
+/**
+ * igt_only_list_subtests:
+ *
+ * Returns: Returns true if only subtest should be listed and any setup code
+ * must be skipped, false otherwise.
+ */
bool igt_only_list_subtests(void)
{
return list_subtests;
@@ -353,6 +417,20 @@ static void exit_subtest(const char *result)
longjmp(igt_subtest_jmpbuf, 1);
}
+/**
+ * igt_skip:
+ * @f: format string
+ * @...: optional arguments used in the format string
+ *
+ * Subtest aware test skipping. The format string is printed to stderr as the
+ * reason why the test skipped.
+ *
+ * For tests with subtests this will either bail out of the current subtest or
+ * mark all subsequent subtests as SKIP (presuming some global setup code
+ * failed).
+ *
+ * For normal tests without subtest it will directly exit.
+ */
void igt_skip(const char *f, ...)
{
va_list args;
@@ -407,6 +485,14 @@ void __igt_skip_check(const char *file, const int line,
}
}
+/**
+ * igt_success:
+ *
+ * Complete a (subtest) as successfull
+ *
+ * This bails out of a subtests and marks it as successful. For global tests it
+ * it won't bail out of anything.
+ */
void igt_success(void)
{
succeeded_one = true;
@@ -414,6 +500,21 @@ void igt_success(void)
exit_subtest("SUCCESS");
}
+/**
+ * igt_fail:
+ * @exitcode: exitcode
+ *
+ * Fail a testcase. The exitcode is used as the exit code of the test process.
+ * It may not be 0 (which indicates success) or 77 (which indicates a skipped
+ * test).
+ *
+ * For tests with subtests this will either bail out of the current subtest or
+ * mark all subsequent subtests as FAIL (presuming some global setup code
+ * failed).
+ *
+ * For normal tests without subtest it will directly exit with the given
+ * exitcode.
+ */
void igt_fail(int exitcode)
{
assert(exitcode != 0 && exitcode != 77);
@@ -473,6 +574,21 @@ void __igt_fail_assert(int exitcode, const char *file,
igt_fail(exitcode);
}
+/**
+ * igt_exit:
+ *
+ * exit() for both types (simple and with subtests) of i-g-t tests.
+ *
+ * This will exit the test with the right exit code when subtests have been
+ * skipped. For normal tests it exits with a successful exit code, presuming
+ * everything has worked out. For subtests it also checks that at least one
+ * subtest has been run (save when only listing subtests.
+ *
+ * It is an error to normally exit a test with subtests without calling
+ * igt_exit() - without it the result reporting will be wrong. To avoid such
+ * issues it is highly recommended to use #igt_main instead of a hand-rolled
+ * main() function.
+ */
void igt_exit(void)
{
igt_exit_called = true;
@@ -562,6 +678,13 @@ bool __igt_fork_helper(struct igt_helper_process *proc)
}
+/**
+ * igt_stop_helper:
+ * @proc: #igt_helper_process structure
+ *
+ * Terminates a helper process. It is an error to call this on a helper process
+ * which hasn't been spawned yet.
+ */
void igt_stop_helper(struct igt_helper_process *proc)
{
int status, ret;
@@ -583,6 +706,13 @@ void igt_stop_helper(struct igt_helper_process *proc)
helper_process_count--;
}
+/**
+ * igt_wait_helper:
+ * @proc: #igt_helper_process structure
+ *
+ * Joins a helper process. It is an error to call this on a helper process which
+ * hasn't been spawned yet.
+ */
void igt_wait_helper(struct igt_helper_process *proc)
{
int status;
@@ -656,9 +786,15 @@ bool __igt_fork(void)
/**
* igt_waitchildren:
*
- * Wait for all children forked with igt_fork
+ * Wait for all children forked with igt_fork.
*
* The magic here is that exit codes from children will be correctly propagated
+ * to the main thread, including the relevant exitcode if a child thread failed.
+ * Of course if multiple children failed with differen exitcodes the resulting
+ * exitcode will be non-deterministic.
+ *
+ * Note that igt_skip() will not be forwarded, feature tests need to be done
+ * before spawning threads with igt_fork().
*/
void igt_waitchildren(void)
{
@@ -773,7 +909,10 @@ static void fatal_sig_handler(int sig)
syscall(SYS_tgkill, pid, tid, sig);
}
-/*
+/**
+ * igt_install_exit_handler:
+ * @fn: exit handler function
+ *
* Set a handler that will be called either when the process calls exit() or
* returns from the main function, or one of the signals in 'handled_signals'
* is raised. MAX_EXIT_HANDLERS handlers can be installed, each of which will
@@ -782,7 +921,10 @@ static void fatal_sig_handler(int sig)
* original signal disposition after all handlers returned.
*
* The handler will be passed the signal number if called due to a signal, or
- * 0 otherwise.
+ * 0 otherwise. Exit handlers can also be used from test children spawned with
+ * igt_fork(), but not from within helper processes spawned with
+ * igt_helper_process(). The list of exit handlers is reset when forking to
+ * avoid issues with children cleanup up the parent's state too early.
*/
void igt_install_exit_handler(igt_exit_handler_t fn)
{
@@ -817,6 +959,12 @@ err:
igt_assert_f(0, "failed to install the signal handler\n");
}
+/**
+ * igt_disable_exit_handler:
+ *
+ * Temporarily disable all exit handlers. Useful for library code doing tricky
+ * things.
+ */
void igt_disable_exit_handler(void)
{
sigset_t set;
@@ -837,6 +985,12 @@ void igt_disable_exit_handler(void)
exit_handler_disabled = true;
}
+/**
+ * igt_enable_exit_handler:
+ *
+ * Re-enable all exit handlers temporarily disabled with
+ * igt_disable_exit_handler().
+ */
void igt_enable_exit_handler(void)
{
if (!exit_handler_disabled)
@@ -851,6 +1005,16 @@ void igt_enable_exit_handler(void)
}
/* simulation enviroment support */
+
+/**
+ * igt_run_in_simulation:
+ *
+ * This function can be used to select a reduced test set when running in
+ * simulation enviroments. This i-g-t mode is selected by setting the
+ * INTEL_SIMULATION enviroment variable to 1.
+ *
+ * Returns: True when run in simulation mode, false otherwise.
+ */
bool igt_run_in_simulation(void)
{
static int simulation = -1;
@@ -864,13 +1028,8 @@ bool igt_run_in_simulation(void)
/**
* igt_skip_on_simulation:
*
- * Skip tests when INTEL_SIMULATION env war is set
- *
- * Skip the test when running on simulation (and that's relevant only when
- * we're not in the mode where we list the subtests).
- *
- * This function is subtest aware (since it uses igt_skip) and so can be used to
- * skip specific subtests or all subsequent subtests.
+ * Skip tests when INTEL_SIMULATION environment variable is set. It uses
+ * igt_skip() internally and hence is fully subtest aware.
*/
void igt_skip_on_simulation(void)
{
@@ -881,6 +1040,23 @@ void igt_skip_on_simulation(void)
}
/* structured logging */
+
+/**
+ * igt_log:
+ * @level: #igt_log_level
+ * @format: format string
+ * @...: optional arguments used in the format string
+ *
+ * This is the generic structure logging helper function. i-g-t testcase should
+ * output all normal message to stdout. Warning level message should be printed
+ * to stderr and the test runner should treat this as an intermediate result
+ * between SUCESS and FAILURE.
+ *
+ * The log level can be set through the IGT_LOG_LEVEL enviroment variable with
+ * values "debug", "info", "warn" and "none". By default verbose debug message
+ * are disabled. "none" completely disables all output and is not recommended
+ * since crucial issues only reported at the IGT_LOG_WARN level are ignored.
+ */
void igt_log(enum igt_log_level level, const char *format, ...)
{
va_list args;
@@ -898,4 +1074,3 @@ void igt_log(enum igt_log_level level, const char *format, ...)
vprintf(format, args);
va_end(args);
}
-
diff --git a/lib/igt_core.h b/lib/igt_core.h
index 1ec0bfcb883d..0e3d7be00d1e 100644
--- a/lib/igt_core.h
+++ b/lib/igt_core.h
@@ -30,8 +30,6 @@
#ifndef IGT_CORE_H
#define IGT_CORE_H
-bool igt_only_list_subtests(void);
-
bool __igt_fixture(void);
void __igt_fixture_complete(void);
void __igt_fixture_end(void) __attribute__((noreturn));
@@ -56,25 +54,42 @@ void __igt_fixture_end(void) __attribute__((noreturn));
jmp_buf igt_subtest_jmpbuf;
void igt_subtest_init(int argc, char **argv);
typedef int (*igt_opt_handler_t)(int opt, int opt_index);
+#ifndef __GTK_DOC_IGNORE__ /* gtkdoc wants to document this forward decl */
struct option;
+#endif
int igt_subtest_init_parse_opts(int argc, char **argv,
const char *extra_short_opts,
struct option *extra_long_opts,
const char *help_str,
- igt_opt_handler_t opt_handler);
+ igt_opt_handler_t extra_opt_handler);
bool __igt_run_subtest(const char *subtest_name);
+#define __igt_tokencat2(x, y) x ## y
+
+/**
+ * igt_tokencat:
+ * @x: first variable
+ * @y: second variable
+ *
+ * C preprocessor helper to concatenate two variables while properly expanding
+ * them.
+ */
+#define igt_tokencat(x, y) __igt_tokencat2(x, y)
+
/**
* igt_subtest:
+ * @name: name of the subtest
*
- * Denote a subtest code block
+ * This is a magic control flow block which denotes a subtest code block. Within
+ * that codeblock igt_skip|success will only bail out of the subtest. The _f
+ * variant accepts a printf format string, which is useful for constructing
+ * combinatorial tests.
*
- * Magic control flow which denotes a subtest code block. Within that codeblock
- * igt_skip|success will only bail out of the subtest. The _f variant accepts a
- * printf format string, which is useful for constructing combinatorial tests.
+ * This is a simpler version of igt_subtest_f()
*/
-#define igt_tokencat2(x, y) x ## y
-#define igt_tokencat(x, y) igt_tokencat2(x, y)
+#define igt_subtest(name) for (; __igt_run_subtest((name)) && \
+ (setjmp(igt_subtest_jmpbuf) == 0); \
+ igt_success())
#define __igt_subtest_f(tmp, format...) \
for (char tmp [256]; \
snprintf( tmp , sizeof( tmp ), \
@@ -85,18 +100,29 @@ bool __igt_run_subtest(const char *subtest_name);
/**
* igt_subtest_f:
- * @...: format string
+ * @...: format string and optional arguments
*
- * Denote a subtest code block
+ * This is a magic control flow block which denotes a subtest code block. Within
+ * that codeblock igt_skip|success will only bail out of the subtest. The _f
+ * variant accepts a printf format string, which is useful for constructing
+ * combinatorial tests.
*
- * Like #igt_subtest, but also accepts a printf format string
+ * Like igt_subtest(), but also accepts a printf format string instead of a
+ * static string.
*/
#define igt_subtest_f(f...) \
__igt_subtest_f(igt_tokencat(__tmpchar, __LINE__), f)
-#define igt_subtest(name) for (; __igt_run_subtest((name)) && \
- (setjmp(igt_subtest_jmpbuf) == 0); \
- igt_success())
+
const char *igt_subtest_name(void);
+bool igt_only_list_subtests(void);
+
+/**
+ * igt_main:
+ *
+ * This is a magic control flow block used instead of a main() function for
+ * tests with subtests. Open-coding the main() function is only recommended if
+ * the test needs to parse additional cmdline arguments of its own.
+ */
#define igt_main \
static void igt_tokencat(__real_main, __LINE__)(void); \
int main(int argc, char **argv) { \
@@ -112,6 +138,14 @@ const char *igt_subtest_name(void);
* Init for simple tests without subtests
*/
void igt_simple_init(void);
+
+/**
+ * igt_simple_main:
+ *
+ * This is a magic control flow block used instead of a main() function for
+ * simple tests. Open-coding the main() function is only recommended if
+ * the test needs to parse additional cmdline arguments of its own.
+ */
#define igt_simple_main \
static void igt_tokencat(__real_main, __LINE__)(void); \
int main(int argc, char **argv) { \
@@ -121,62 +155,27 @@ void igt_simple_init(void);
} \
static void igt_tokencat(__real_main, __LINE__)(void) \
-/**
- * igt_skip:
- *
- * Subtest aware test skipping
- *
- * For tests with subtests this will either bail out of the current subtest or
- * mark all subsequent subtests as SKIP (in case some global setup code failed).
- *
- * For normal tests without subtest it will directly exit.
- */
__attribute__((format(printf, 1, 2)))
void igt_skip(const char *f, ...) __attribute__((noreturn));
__attribute__((format(printf, 5, 6)))
void __igt_skip_check(const char *file, const int line,
const char *func, const char *check,
const char *format, ...) __attribute__((noreturn));
-/**
- * igt_success:
- *
- * Complete a (subtest) as successfull
- *
- * This bails out of a subtests and marks it as successful. For global tests it
- * it won't bail out of anything.
- */
void igt_success(void);
-/**
- * igt_fail:
- *
- * Fail a testcase
- *
- * For subtest it just bails out of the subtest, when run in global context it
- * will exit. Note that it won't attempt to keep on running further tests,
- * presuming that some mandatory setup failed.
- */
void igt_fail(int exitcode) __attribute__((noreturn));
__attribute__((format(printf, 6, 7)))
void __igt_fail_assert(int exitcode, const char *file,
const int line, const char *func, const char *assertion,
const char *format, ...)
__attribute__((noreturn));
-/**
- * igt_exit:
- *
- * exit() for igts
- *
- * This will exit the test with the right exit code when subtests have been
- * skipped. For normal tests it exits with a successful exit code, presuming
- * everything has worked out. For subtests it also checks that at least one
- * subtest has been run (save when only listing subtests.
- */
void igt_exit(void) __attribute__((noreturn));
+
/**
* igt_assert:
+ * @expr: condition to test
*
- * Fails (sub-)test if a condition is not met
+ * Fails (sub-)test if the condition is not met
*
* Should be used everywhere where a test checks results.
*/
@@ -184,14 +183,36 @@ void igt_exit(void) __attribute__((noreturn));
do { if (!(expr)) \
__igt_fail_assert(99, __FILE__, __LINE__, __func__, #expr , NULL); \
} while (0)
+
+/**
+ * igt_assert_f:
+ * @expr: condition to test
+ * @...: format string and optional arguments
+ *
+ * Fails (sub-)test if the condition is not met
+ *
+ * Should be used everywhere where a test checks results.
+ *
+ * In addition to the plain igt_assert() helper this allows to print additional
+ * information to help debugging test failures.
+ */
#define igt_assert_f(expr, f...) \
do { if (!(expr)) \
__igt_fail_assert(99, __FILE__, __LINE__, __func__, #expr , f); \
} while (0)
+
/**
- * igt_assert_cmptint:
+ * igt_assert_cmpint:
+ * @n1: first value
+ * @cmp: compare operator
+ * @n2: second value
+ *
+ * Fails (sub-)test if the condition is not met
+ *
+ * Should be used everywhere where a test compares two integer values.
*
- * Like #igt_assert, but displays the values being compared on failure.
+ * Like igt_assert(), but displays the values being compared on failure instead
+ * of simply printing the stringified expression.
*/
#define igt_assert_cmpint(n1, cmp, n2) \
do { \
@@ -204,18 +225,61 @@ void igt_exit(void) __attribute__((noreturn));
/**
* igt_require:
+ * @expr: condition to test
*
- * Skip a (sub-)test if a condition is not met
+ * Skip a (sub-)test if a condition is not met.
*
- * This is useful to streamline the skip logic since it allows for a more flat
- * code control flow.
+ * Should be used everywhere where a test checks results to decide about
+ * skipping. This is useful to streamline the skip logic since it allows for a more flat
+ * code control flow, similar to igt_assert()
*/
#define igt_require(expr) igt_skip_on(!(expr))
+
+/**
+ * igt_skip_on:
+ * @expr: condition to test
+ *
+ * Skip a (sub-)test if a condition is met.
+ *
+ * Should be used everywhere where a test checks results to decide about
+ * skipping. This is useful to streamline the skip logic since it allows for a more flat
+ * code control flow, similar to igt_assert()
+ */
#define igt_skip_on(expr) \
do { if ((expr)) \
__igt_skip_check(__FILE__, __LINE__, __func__, #expr , NULL); \
} while (0)
+
+/**
+ * igt_require_f:
+ * @expr: condition to test
+ * @...: format string and optional arguments
+ *
+ * Skip a (sub-)test if a condition is not met.
+ *
+ * Should be used everywhere where a test checks results to decide about
+ * skipping. This is useful to streamline the skip logic since it allows for a more flat
+ * code control flow, similar to igt_assert()
+ *
+ * In addition to the plain igt_require() helper this allows to print additional
+ * information to help debugging test failures.
+ */
#define igt_require_f(expr, f...) igt_skip_on_f(!(expr), f)
+
+/**
+ * igt_skip_on_f:
+ * @expr: condition to test
+ * @...: format string and optional arguments
+ *
+ * Skip a (sub-)test if a condition is met.
+ *
+ * Should be used everywhere where a test checks results to decide about
+ * skipping. This is useful to streamline the skip logic since it allows for a more flat
+ * code control flow, similar to igt_assert()
+ *
+ * In addition to the plain igt_skip_on() helper this allows to print additional
+ * information to help debugging test failures.
+ */
#define igt_skip_on_f(expr, f...) \
do { if ((expr)) \
__igt_skip_check(__FILE__, __LINE__, __func__, #expr , f); \
@@ -223,21 +287,37 @@ void igt_exit(void) __attribute__((noreturn));
/* fork support code */
bool __igt_fork(void);
+
/**
* igt_fork:
* @child: name of the int variable with the child number
* @num_children: number of children to fork
*
- * Fork parallel test threads with fork()
+ * This is a magic control flow block which spawns parallel test threads with
+ * fork().
+ *
+ * The test children execute in parallel to the main test thread. Joining all
+ * test threads should be done with igt_waitchildren to ensure that the exit
+ * codes of all children are properly reflected in the test status.
*
- * Joining all test threads should be done with igt_waitchildren to ensure that
- * the exit codes of all children are properly reflected in the test status.
+ * Note that igt_skip() will not be forwarded, feature tests need to be done
+ * before spawning threads with igt_fork().
*/
#define igt_fork(child, num_children) \
for (int child = 0; child < (num_children); child++) \
for (; __igt_fork(); exit(0))
void igt_waitchildren(void);
+/**
+ * igt_helper_process_t:
+ * @running: indicates whether the process is currently running
+ * @use_SIGKILL: whether the helper should be terminated with SIGKILL or SIGQUIT
+ * @pid: pid of the helper if @running is true
+ * @id: internal id
+ *
+ * Tracking structure for helper processes. Users of the i-g-t library should
+ * only set @use_SIGKILL directly.
+ */
struct igt_helper_process {
bool running;
bool use_SIGKILL;
@@ -245,12 +325,40 @@ struct igt_helper_process {
int id;
};
bool __igt_fork_helper(struct igt_helper_process *proc);
-void igt_stop_helper(struct igt_helper_process *proc);
-void igt_wait_helper(struct igt_helper_process *proc);
+
+/**
+ * igt_fork_helper:
+ * @proc: #igt_helper_process structure
+ *
+ * This is a magic control flow block which denotes an asynchronous helper
+ * process block. The difference compared to igt_fork() is that failures from
+ * the child process will not be forwarded, making this construct more suitable
+ * for background processes. Common use cases are regular interference of the
+ * main test thread through e.g. sending signals or evicting objects through
+ * debugfs. Through the explicit #igt_helper_process they can also be controlled
+ * in a more fine-grained way than test children spawned through igt_fork().
+ *
+ * For tests with subtest helper process can be started outside of a
+ * #igt_subtest block.
+ *
+ * Calling igt_wait_helper() joins a helper process and igt_stop_helper()
+ * forcefully terminates it.
+ */
#define igt_fork_helper(proc) \
for (; __igt_fork_helper(proc); exit(0))
+void igt_wait_helper(struct igt_helper_process *proc);
+void igt_stop_helper(struct igt_helper_process *proc);
/* exit handler code */
+
+/**
+ * igt_exit_handler_t:
+ * @sig: Signal number which caused the exit or 0.
+ *
+ * Exit handler type used by igt_install_exit_handler(). Note that exit handlers
+ * can potentially be run from signal handling contexts, the @sig parameter can
+ * be used to figure this out and act accordingly.
+ */
typedef void (*igt_exit_handler_t)(int sig);
/* reliable atexit helpers, also work when killed by a signal (if possible) */
@@ -260,18 +368,16 @@ void igt_disable_exit_handler(void);
/* helpers to automatically reduce test runtime in simulation */
bool igt_run_in_simulation(void);
-#define SLOW_QUICK(slow,quick) (igt_run_in_simulation() ? (quick) : (slow))
/**
- * igt_skip_on_simulation:
- *
- * Skip tests when INTEL_SIMULATION env war is set
+ * SLOW_QUICK:
+ * @slow: value in simulation mode
+ * @quick: value in normal mode
*
- * Skip the test when running on simulation (and that's relevant only when
- * we're not in the mode where we list the subtests).
- *
- * This function is subtest aware (since it uses igt_skip) and so can be used to
- * skip specific subtests or all subsequent subtests.
+ * Simple macro to select between two values (e.g. number of test rounds or test
+ * buffer size) depending upon whether i-g-t is run in simulation mode or not.
*/
+#define SLOW_QUICK(slow,quick) (igt_run_in_simulation() ? (quick) : (slow))
+
void igt_skip_on_simulation(void);
/* structured logging */
@@ -283,16 +389,64 @@ enum igt_log_level {
};
__attribute__((format(printf, 2, 3)))
void igt_log(enum igt_log_level level, const char *format, ...);
+
+/**
+ * igt_debug:
+ * @...: format string and optional arguments
+ *
+ * Wrapper for igt_log for message at the IGT_LOG_DEBUG level.
+ */
#define igt_debug(f...) igt_log(IGT_LOG_DEBUG, f)
+
+/**
+ * igt_info:
+ * @...: format string and optional arguments
+ *
+ * Wrapper for igt_log for message at the IGT_LOG_INFO level.
+ */
#define igt_info(f...) igt_log(IGT_LOG_INFO, f)
+
+/**
+ * igt_warn:
+ * @...: format string and optional arguments
+ *
+ * Wrapper for igt_log for message at the IGT_LOG_WARN level.
+ */
#define igt_warn(f...) igt_log(IGT_LOG_WARN, f)
extern enum igt_log_level igt_log_level;
+/**
+ * igt_warn_on:
+ * @condition: condition to test
+ *
+ * Print a IGT_LOG_WARN level message if a condition is not met.
+ *
+ * Should be used everywhere where a test checks results to decide about
+ * printing warnings. This is useful to streamline the test logic since it
+ * allows for a more flat code control flow, similar to igt_assert()
+ */
#define igt_warn_on(condition) do {\
if (condition) \
igt_warn("Warning on condition %s in fucntion %s, file %s:%i\n", \
#condition, __func__, __FILE__, __LINE__); \
} while (0)
+
+/**
+ * igt_warn_on_f:
+ * @condition: condition to test
+ * @...: format string and optional arguments
+ *
+ * Skip a (sub-)test if a condition is not met.
+ *
+ * Print a IGT_LOG_WARN level message if a condition is not met.
+ *
+ * Should be used everywhere where a test checks results to decide about
+ * printing warnings. This is useful to streamline the test logic since it
+ * allows for a more flat code control flow, similar to igt_assert()
+ *
+ * In addition to the plain igt_warn_on_f() helper this allows to print
+ * additional information (again as warnings) to help debugging test failures.
+ */
#define igt_warn_on_f(condition, f...) do {\
if (condition) {\
igt_warn("Warning on condition %s in fucntion %s, file %s:%i\n", \
--
1.8.5.2
_______________________________________________
Intel-gfx mailing list
Intel-gfx@xxxxxxxxxxxxxxxxxxxxx
http://lists.freedesktop.org/mailman/listinfo/intel-gfx
