aboutsummaryrefslogtreecommitdiffstats
path: root/include/libuutil_impl.h
diff options
context:
space:
mode:
authorRichard Yao <[email protected]>2022-09-30 18:30:12 -0400
committerGitHub <[email protected]>2022-09-30 15:30:12 -0700
commit55d7afa4adbb4ca569e9c4477a7d121f4dc0bfbd (patch)
tree25df8f99b24895d7fbf8aa44790068fa852600f7 /include/libuutil_impl.h
parentdee8934e8fcd002eb826cf29aa453632d634b826 (diff)
Reduce false positives from Static Analyzers
Both Clang's Static Analyzer and Synopsys' Coverity would ignore assertions. Following Clang's advice, we annotate our assertions: https://clang-analyzer.llvm.org/annotations.html#custom_assertions This makes both Clang's Static Analyzer and Coverity properly identify assertions. This change reduced Clang's reported defects from 246 to 180. It also reduced the false positives reported by Coverityi by 10, while enabling Coverity to find 9 more defects that previously were false negatives. A couple examples of this would be CID-1524417 and CID-1524423. After submitting a build to coverity with the modified assertions, CID-1524417 disappeared while the report for CID-1524423 no longer claimed that the assertion tripped. Coincidentally, it turns out that it is possible to more accurately annotate our headers than the Coverity modelling file permits in the case of format strings. Since we can do that and this patch annotates headers whenever `__coverity_panic__()` would have been used in the model file, we drop all models that use `__coverity_panic__()` from the model file. Upon seeing the success in eliminating false positives involving assertions, it occurred to me that we could also modify our headers to eliminate coverity's false positives involving byte swaps. We now have coverity specific byteswap macros, that do nothing, to disable Coverity's false positives when we do byte swaps. This allowed us to also drop the byteswap definitions from the model file. Lastly, a model file update has been done beyond the mentioned deletions: * The definitions of `umem_alloc_aligned()`, `umem_alloc()` andi `umem_zalloc()` were originally implemented in a way that was intended to inform coverity that when KM_SLEEP has been passed these functions, they do not return NULL. A small error in how this was done was found, so we correct it. * Definitions for umem_cache_alloc() and umem_cache_free() have been added. In practice, no false positives were avoided by making these changes, but in the interest of correctness from future coverity builds, we make them anyway. Reviewed-by: Brian Behlendorf <[email protected]> Reviewed-by: Ryan Moeller <[email protected]> Signed-off-by: Richard Yao <[email protected]> Closes #13902
Diffstat (limited to 'include/libuutil_impl.h')
-rw-r--r--include/libuutil_impl.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/include/libuutil_impl.h b/include/libuutil_impl.h
index b9907447a..7aa8f0ced 100644
--- a/include/libuutil_impl.h
+++ b/include/libuutil_impl.h
@@ -42,7 +42,8 @@ extern "C" {
void uu_set_error(uint_t);
-void uu_panic(const char *format, ...) __attribute__((format(printf, 1, 2)));
+__attribute__((format(printf, 1, 2), __noreturn__))
+void uu_panic(const char *format, ...);
/*