lib: Help static analyzers figure out the execution flow
When running any kind of static analysis on IGT, one tends to drown in
warnings about using uninitialized variables in subtests, because
static analysis is unable to figure out that igt_fixture blocks are
always entered if a subtest block is entered. Aid the discovery of
correct execution flow by making static analysis always enter all
igt_fixture blocks and all subtest blocks.
Automatic discovery of static analyzers is done for Clang, Coverity
and Klocwork, using macros found by quick googling. For explicit
control on possible other analyzers, defining STATIC_ANALYSIS_BUILD=1
manually will activate this hack.
v2:
- Hack not needed for igt_subtest()
- Make sure igt_fixture is entered once instead of an infinite loop
v3:
- Rebase properly...
Signed-off-by: Petri Latvala <petri.latvala@intel.com>
Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
diff --git a/lib/igt_core.h b/lib/igt_core.h
index b80e170..6f8c385 100644
--- a/lib/igt_core.h
+++ b/lib/igt_core.h
@@ -46,6 +46,14 @@
#endif
+#ifndef STATIC_ANALYSIS_BUILD
+#if defined(__clang_analyzer__) || defined(__COVERITY__) || defined(__KLOCWORK__)
+#define STATIC_ANALYSIS_BUILD 1
+#else
+#define STATIC_ANALYSIS_BUILD 0
+#endif
+#endif
+
extern const char* __igt_test_description __attribute__((weak));
extern bool __igt_plain_output;
extern char *igt_frame_dump_path;
@@ -110,8 +118,9 @@
*/
#define igt_fixture for (volatile int igt_tokencat(__tmpint,__LINE__) = 0; \
igt_tokencat(__tmpint,__LINE__) < 1 && \
- __igt_fixture() && \
- (sigsetjmp(igt_subtest_jmpbuf, 1) == 0); \
+ (STATIC_ANALYSIS_BUILD || \
+ (__igt_fixture() && \
+ (sigsetjmp(igt_subtest_jmpbuf, 1) == 0))); \
igt_tokencat(__tmpint,__LINE__) ++, \
__igt_fixture_complete())