1 /*
2 * copyright (c) 2010 Michael Niedermayer <michaelni@gmx.at>
3 *
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21 /**
22 * @file
23 * simple assert() macros that are a bit more flexible than ISO C assert().
24 * @author Michael Niedermayer <michaelni@gmx.at>
25 */
26
27 #ifndef AVUTIL_AVASSERT_H
28 #define AVUTIL_AVASSERT_H
29
30 #include <stdlib.h>
31 #ifdef HAVE_AV_CONFIG_H
32 # include "config.h"
33 #endif
37
38 /**
39 * assert() equivalent, that is always enabled.
40 */
41 #define av_assert0(cond) do { \
42 if (!(cond)) { \
43 av_log(NULL, AV_LOG_PANIC, "Assertion %s failed at %s:%d\n", \
44 AV_STRINGIFY(cond), __FILE__, __LINE__); \
45 abort(); \
46 } \
47 } while (0)
48
49
50 /**
51 * assert() equivalent, that does not lie in speed critical code.
52 * These asserts() thus can be enabled without fearing speed loss.
53 */
54 #if defined(ASSERT_LEVEL) && ASSERT_LEVEL > 0
55 #define av_assert1(cond) av_assert0(cond)
56 #else
57 #define av_assert1(cond) ((void)0)
58 #endif
59
60
61 /**
62 * assert() equivalent, that does lie in speed critical code.
63 */
64 #if defined(ASSERT_LEVEL) && ASSERT_LEVEL > 1
65 #define av_assert2(cond) av_assert0(cond)
66 #define av_assert2_fpu() av_assert0_fpu()
67 #else
68 #define av_assert2(cond) ((void)0)
69 #define av_assert2_fpu() ((void)0)
70 #endif
71
72 /**
73 * Assert that floating point operations can be executed.
74 *
75 * This will av_assert0() that the cpu is not in MMX state on X86
76 */
78
79 /**
80 * Asserts that are used as compiler optimization hints depending
81 * upon ASSERT_LEVEL and NBDEBUG.
82 *
83 * Undefined behaviour occurs if execution reaches a point marked
84 * with av_unreachable() or if a condition used with av_assume()
85 * is false.
86 *
87 * The condition used with av_assume() should not have side-effects
88 * and should be visible to the compiler.
89 */
90 #if defined(ASSERT_LEVEL) ? ASSERT_LEVEL > 0 : !defined(HAVE_AV_CONFIG_H) && !defined(NDEBUG)
91 #define av_unreachable(msg) \
92 do { \
93 av_log(NULL, AV_LOG_PANIC, \
94 "Reached supposedly unreachable code at %s:%d: %s\n", \
95 __FILE__, __LINE__, msg); \
96 abort(); \
97 } while (0)
98 #define av_assume(cond) av_assert0(cond)
99 #else
100 #if AV_GCC_VERSION_AT_LEAST(4, 5) || AV_HAS_BUILTIN(__builtin_unreachable)
101 #define av_unreachable(msg) __builtin_unreachable()
102 #elif defined(_MSC_VER)
103 #define av_unreachable(msg) __assume(0)
104 #elif __STDC_VERSION__ >= 202311L
105 #include <stddef.h>
106 #define av_unreachable(msg) unreachable()
107 #else
108 #define av_unreachable(msg) ((void)0)
109 #endif
110
111 #define av_assume(cond) do { \
112 if (!(cond)) \
113 av_unreachable(); \
114 } while (0)
115 #endif
116
117 #endif /* AVUTIL_AVASSERT_H */