mirror of
https://git.proxmox.com/git/mirror_zfs.git
synced 2024-12-26 19:19:32 +03:00
55d7afa4ad
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 <behlendorf1@llnl.gov> Reviewed-by: Ryan Moeller <ryan@iXsystems.com> Signed-off-by: Richard Yao <richard.yao@alumni.stonybrook.edu> Closes #13902
163 lines
5.1 KiB
C
163 lines
5.1 KiB
C
/*
|
|
* CDDL HEADER START
|
|
*
|
|
* The contents of this file are subject to the terms of the
|
|
* Common Development and Distribution License, Version 1.0 only
|
|
* (the "License"). You may not use this file except in compliance
|
|
* with the License.
|
|
*
|
|
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
|
|
* or https://opensource.org/licenses/CDDL-1.0.
|
|
* See the License for the specific language governing permissions
|
|
* and limitations under the License.
|
|
*
|
|
* When distributing Covered Code, include this CDDL HEADER in each
|
|
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
|
|
* If applicable, add the following below this CDDL HEADER, with the
|
|
* fields enclosed by brackets "[]" replaced with your own identifying
|
|
* information: Portions Copyright [yyyy] [name of copyright owner]
|
|
*
|
|
* CDDL HEADER END
|
|
*/
|
|
/*
|
|
* Copyright 2007 Sun Microsystems, Inc. All rights reserved.
|
|
* Use is subject to license terms.
|
|
*/
|
|
|
|
#include_next <assert.h>
|
|
|
|
#ifndef _LIBSPL_ASSERT_H
|
|
#define _LIBSPL_ASSERT_H
|
|
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
#include <stdarg.h>
|
|
#include <sys/types.h>
|
|
|
|
/* Workaround for non-Clang compilers */
|
|
#ifndef __has_feature
|
|
#define __has_feature(x) 0
|
|
#endif
|
|
|
|
/* We need to workaround libspl_set_assert_ok() that we have for zdb */
|
|
#if __has_feature(attribute_analyzer_noreturn) || defined(__COVERITY__)
|
|
#define NORETURN __attribute__((__noreturn__))
|
|
#else
|
|
#define NORETURN
|
|
#endif
|
|
|
|
/* Set to non-zero to avoid abort()ing on an assertion failure */
|
|
extern void libspl_set_assert_ok(boolean_t val);
|
|
|
|
/* printf version of libspl_assert */
|
|
extern void libspl_assertf(const char *file, const char *func, int line,
|
|
const char *format, ...) NORETURN __attribute__((format(printf, 4, 5)));
|
|
|
|
static inline int
|
|
libspl_assert(const char *buf, const char *file, const char *func, int line)
|
|
{
|
|
libspl_assertf(file, func, line, "%s", buf);
|
|
return (0);
|
|
}
|
|
|
|
#ifdef verify
|
|
#undef verify
|
|
#endif
|
|
|
|
#define VERIFY(cond) \
|
|
(void) ((!(cond)) && \
|
|
libspl_assert(#cond, __FILE__, __FUNCTION__, __LINE__))
|
|
#define verify(cond) \
|
|
(void) ((!(cond)) && \
|
|
libspl_assert(#cond, __FILE__, __FUNCTION__, __LINE__))
|
|
|
|
#define VERIFY3B(LEFT, OP, RIGHT) \
|
|
do { \
|
|
const boolean_t __left = (boolean_t)(LEFT); \
|
|
const boolean_t __right = (boolean_t)(RIGHT); \
|
|
if (!(__left OP __right)) \
|
|
libspl_assertf(__FILE__, __FUNCTION__, __LINE__, \
|
|
"%s %s %s (0x%llx %s 0x%llx)", #LEFT, #OP, #RIGHT, \
|
|
(u_longlong_t)__left, #OP, (u_longlong_t)__right); \
|
|
} while (0)
|
|
|
|
#define VERIFY3S(LEFT, OP, RIGHT) \
|
|
do { \
|
|
const int64_t __left = (int64_t)(LEFT); \
|
|
const int64_t __right = (int64_t)(RIGHT); \
|
|
if (!(__left OP __right)) \
|
|
libspl_assertf(__FILE__, __FUNCTION__, __LINE__, \
|
|
"%s %s %s (0x%llx %s 0x%llx)", #LEFT, #OP, #RIGHT, \
|
|
(u_longlong_t)__left, #OP, (u_longlong_t)__right); \
|
|
} while (0)
|
|
|
|
#define VERIFY3U(LEFT, OP, RIGHT) \
|
|
do { \
|
|
const uint64_t __left = (uint64_t)(LEFT); \
|
|
const uint64_t __right = (uint64_t)(RIGHT); \
|
|
if (!(__left OP __right)) \
|
|
libspl_assertf(__FILE__, __FUNCTION__, __LINE__, \
|
|
"%s %s %s (0x%llx %s 0x%llx)", #LEFT, #OP, #RIGHT, \
|
|
(u_longlong_t)__left, #OP, (u_longlong_t)__right); \
|
|
} while (0)
|
|
|
|
#define VERIFY3P(LEFT, OP, RIGHT) \
|
|
do { \
|
|
const uintptr_t __left = (uintptr_t)(LEFT); \
|
|
const uintptr_t __right = (uintptr_t)(RIGHT); \
|
|
if (!(__left OP __right)) \
|
|
libspl_assertf(__FILE__, __FUNCTION__, __LINE__, \
|
|
"%s %s %s (0x%llx %s 0x%llx)", #LEFT, #OP, #RIGHT, \
|
|
(u_longlong_t)__left, #OP, (u_longlong_t)__right); \
|
|
} while (0)
|
|
|
|
#define VERIFY0(LEFT) \
|
|
do { \
|
|
const uint64_t __left = (uint64_t)(LEFT); \
|
|
if (!(__left == 0)) \
|
|
libspl_assertf(__FILE__, __FUNCTION__, __LINE__, \
|
|
"%s == 0 (0x%llx == 0)", #LEFT, \
|
|
(u_longlong_t)__left); \
|
|
} while (0)
|
|
|
|
#ifdef assert
|
|
#undef assert
|
|
#endif
|
|
|
|
#ifdef NDEBUG
|
|
#define ASSERT3B(x, y, z) \
|
|
((void) sizeof ((uintptr_t)(x)), (void) sizeof ((uintptr_t)(z)))
|
|
#define ASSERT3S(x, y, z) \
|
|
((void) sizeof ((uintptr_t)(x)), (void) sizeof ((uintptr_t)(z)))
|
|
#define ASSERT3U(x, y, z) \
|
|
((void) sizeof ((uintptr_t)(x)), (void) sizeof ((uintptr_t)(z)))
|
|
#define ASSERT3P(x, y, z) \
|
|
((void) sizeof ((uintptr_t)(x)), (void) sizeof ((uintptr_t)(z)))
|
|
#define ASSERT0(x) ((void) sizeof ((uintptr_t)(x)))
|
|
#define ASSERT(x) ((void) sizeof ((uintptr_t)(x)))
|
|
#define assert(x) ((void) sizeof ((uintptr_t)(x)))
|
|
#define IMPLY(A, B) \
|
|
((void) sizeof ((uintptr_t)(A)), (void) sizeof ((uintptr_t)(B)))
|
|
#define EQUIV(A, B) \
|
|
((void) sizeof ((uintptr_t)(A)), (void) sizeof ((uintptr_t)(B)))
|
|
#else
|
|
#define ASSERT3B VERIFY3B
|
|
#define ASSERT3S VERIFY3S
|
|
#define ASSERT3U VERIFY3U
|
|
#define ASSERT3P VERIFY3P
|
|
#define ASSERT0 VERIFY0
|
|
#define ASSERT VERIFY
|
|
#define assert VERIFY
|
|
#define IMPLY(A, B) \
|
|
((void)(((!(A)) || (B)) || \
|
|
libspl_assert("(" #A ") implies (" #B ")", \
|
|
__FILE__, __FUNCTION__, __LINE__)))
|
|
#define EQUIV(A, B) \
|
|
((void)((!!(A) == !!(B)) || \
|
|
libspl_assert("(" #A ") is equivalent to (" #B ")", \
|
|
__FILE__, __FUNCTION__, __LINE__)))
|
|
|
|
#endif /* NDEBUG */
|
|
|
|
#endif /* _LIBSPL_ASSERT_H */
|