Debian Codegraph @

lib/verify.h

raw
1 /* Compile-time assert-like macros.
2
3 Copyright (C) 2005-2006, 2009-2024 Free Software Foundation, Inc.
4
5 This file is free software: you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as
7 published by the Free Software Foundation; either version 2.1 of the
8 License, or (at your option) any later version.
9
10 This file is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
14
15 You should have received a copy of the GNU Lesser General Public License
16 along with this program. If not, see <https://www.gnu.org/licenses/>. */
17
18 /* Written by Paul Eggert, Bruno Haible, and Jim Meyering. */
19
20 #ifndef _GL_VERIFY_H
21 #define _GL_VERIFY_H
22
23
24 /* Define _GL_HAVE__STATIC_ASSERT to 1 if _Static_assert (R, DIAGNOSTIC)
25 works as per C11. This is supported by GCC 4.6.0+ and by clang 4+.
26
27 Define _GL_HAVE__STATIC_ASSERT1 to 1 if _Static_assert (R) works as
28 per C23. This is supported by GCC 9.1+.
29
30 Support compilers claiming conformance to the relevant standard,
31 and also support GCC when not pedantic. If we were willing to slow
32 'configure' down we could also use it with other compilers, but
33 since this affects only the quality of diagnostics, why bother? */
34 #ifndef __cplusplus
35 # if (201112 <= __STDC_VERSION__ \
36 || (!defined __STRICT_ANSI__ \
37 && ((4 < __GNUC__ + (6 <= __GNUC_MINOR__) && !defined __clang__) \
38 || 5 <= __clang_major__)))
39 # define _GL_HAVE__STATIC_ASSERT 1
40 # endif
41 # if (202311 <= __STDC_VERSION__ \
42 || (!defined __STRICT_ANSI__ && 9 <= __GNUC__ && !defined __clang__))
43 # define _GL_HAVE__STATIC_ASSERT1 1
44 # endif
45 #endif
46
47 /* FreeBSD 9.1 <sys/cdefs.h>, included by <stddef.h> and lots of other
48 system headers, defines a conflicting _Static_assert that is no
49 better than ours; override it. */
50 #ifndef _GL_HAVE__STATIC_ASSERT
51 # include <stddef.h>
52 # undef _Static_assert
53 #endif
54
55 /* Each of these macros verifies that its argument R is nonzero. To
56 be portable, R should be an integer constant expression. Unlike
57 assert (R), there is no run-time overhead.
58
59 If _Static_assert works, verify (R) uses it directly. Similarly,
60 _GL_VERIFY_TRUE works by packaging a _Static_assert inside a struct
61 that is an operand of sizeof.
62
63 The code below uses several ideas for C++ compilers, and for C
64 compilers that do not support _Static_assert:
65
66 * The first step is ((R) ? 1 : -1). Given an expression R, of
67 integral or boolean or floating-point type, this yields an
68 expression of integral type, whose value is later verified to be
69 constant and nonnegative.
70
71 * Next this expression W is wrapped in a type
72 struct _gl_verify_type {
73 unsigned int _gl_verify_error_if_negative: W;
74 }.
75 If W is negative, this yields a compile-time error. No compiler can
76 deal with a bit-field of negative size.
77
78 One might think that an array size check would have the same
79 effect, that is, that the type struct { unsigned int dummy[W]; }
80 would work as well. However, inside a function, some compilers
81 (such as C++ compilers and GNU C) allow local parameters and
82 variables inside array size expressions. With these compilers,
83 an array size check would not properly diagnose this misuse of
84 the verify macro:
85
86 void function (int n) { verify (n < 0); }
87
88 * For the verify macro, the struct _gl_verify_type will need to
89 somehow be embedded into a declaration. To be portable, this
90 declaration must declare an object, a constant, a function, or a
91 typedef name. If the declared entity uses the type directly,
92 such as in
93
94 struct dummy {...};
95 typedef struct {...} dummy;
96 extern struct {...} *dummy;
97 extern void dummy (struct {...} *);
98 extern struct {...} *dummy (void);
99
100 two uses of the verify macro would yield colliding declarations
101 if the entity names are not disambiguated. A workaround is to
102 attach the current line number to the entity name:
103
104 #define _GL_CONCAT0(x, y) x##y
105 #define _GL_CONCAT(x, y) _GL_CONCAT0 (x, y)
106 extern struct {...} * _GL_CONCAT (dummy, __LINE__);
107
108 But this has the problem that two invocations of verify from
109 within the same macro would collide, since the __LINE__ value
110 would be the same for both invocations. (The GCC __COUNTER__
111 macro solves this problem, but is not portable.)
112
113 A solution is to use the sizeof operator. It yields a number,
114 getting rid of the identity of the type. Declarations like
115
116 extern int dummy [sizeof (struct {...})];
117 extern void dummy (int [sizeof (struct {...})]);
118 extern int (*dummy (void)) [sizeof (struct {...})];
119
120 can be repeated.
121
122 * Should the implementation use a named struct or an unnamed struct?
123 Which of the following alternatives can be used?
124
125 extern int dummy [sizeof (struct {...})];
126 extern int dummy [sizeof (struct _gl_verify_type {...})];
127 extern void dummy (int [sizeof (struct {...})]);
128 extern void dummy (int [sizeof (struct _gl_verify_type {...})]);
129 extern int (*dummy (void)) [sizeof (struct {...})];
130 extern int (*dummy (void)) [sizeof (struct _gl_verify_type {...})];
131
132 In the second and sixth case, the struct type is exported to the
133 outer scope; two such declarations therefore collide. GCC warns
134 about the first, third, and fourth cases. So the only remaining
135 possibility is the fifth case:
136
137 extern int (*dummy (void)) [sizeof (struct {...})];
138
139 * GCC warns about duplicate declarations of the dummy function if
140 -Wredundant-decls is used. GCC 4.3 and later have a builtin
141 __COUNTER__ macro that can let us generate unique identifiers for
142 each dummy function, to suppress this warning.
143
144 * This implementation exploits the fact that older versions of GCC,
145 which do not support _Static_assert, also do not warn about the
146 last declaration mentioned above.
147
148 * GCC warns if -Wnested-externs is enabled and 'verify' is used
149 within a function body; but inside a function, you can always
150 arrange to use verify_expr instead.
151
152 * In C++, any struct definition inside sizeof is invalid.
153 Use a template type to work around the problem. */
154
155 /* Concatenate two preprocessor tokens. */
156 #define _GL_CONCAT(x, y) _GL_CONCAT0 (x, y)
157 #define _GL_CONCAT0(x, y) x##y
158
159 /* _GL_COUNTER is an integer, preferably one that changes each time we
160 use it. Use __COUNTER__ if it works, falling back on __LINE__
161 otherwise. __LINE__ isn't perfect, but it's better than a
162 constant. */
163 #if defined __COUNTER__ && __COUNTER__ != __COUNTER__
164 # define _GL_COUNTER __COUNTER__
165 #else
166 # define _GL_COUNTER __LINE__
167 #endif
168
169 /* Generate a symbol with the given prefix, making it unique if
170 possible. */
171 #define _GL_GENSYM(prefix) _GL_CONCAT (prefix, _GL_COUNTER)
172
173 /* Verify requirement R at compile-time, as an integer constant expression
174 that returns 1. If R is false, fail at compile-time, preferably
175 with a diagnostic that includes the string-literal DIAGNOSTIC. */
176
177 #define _GL_VERIFY_TRUE(R, DIAGNOSTIC) \
178 (!!sizeof (_GL_VERIFY_TYPE (R, DIAGNOSTIC)))
179
180 #ifdef __cplusplus
181 # if !GNULIB_defined_struct__gl_verify_type
182 template <int w>
183 struct _gl_verify_type {
184 unsigned int _gl_verify_error_if_negative: w;
185 };
186 # define GNULIB_defined_struct__gl_verify_type 1
187 # endif
188 # define _GL_VERIFY_TYPE(R, DIAGNOSTIC) \
189 _gl_verify_type<(R) ? 1 : -1>
190 #elif defined _GL_HAVE__STATIC_ASSERT
191 # define _GL_VERIFY_TYPE(R, DIAGNOSTIC) \
192 struct { \
193 _Static_assert (R, DIAGNOSTIC); \
194 int _gl_dummy; \
195 }
196 #else
197 # define _GL_VERIFY_TYPE(R, DIAGNOSTIC) \
198 struct { unsigned int _gl_verify_error_if_negative: (R) ? 1 : -1; }
199 #endif
200
201 /* Verify requirement R at compile-time, as a declaration without a
202 trailing ';'. If R is false, fail at compile-time.
203
204 This macro requires three or more arguments but uses at most the first
205 two, so that the _Static_assert macro optionally defined below supports
206 both the C11 two-argument syntax and the C23 one-argument syntax.
207
208 Unfortunately, unlike C11, this implementation must appear as an
209 ordinary declaration, and cannot appear inside struct { ... }. */
210
211 #if 202311 <= __STDC_VERSION__ || 200410 <= __cpp_static_assert
212 # define _GL_VERIFY(R, DIAGNOSTIC, ...) static_assert (R, DIAGNOSTIC)
213 #elif defined _GL_HAVE__STATIC_ASSERT
214 # define _GL_VERIFY(R, DIAGNOSTIC, ...) _Static_assert (R, DIAGNOSTIC)
215 #else
216 # define _GL_VERIFY(R, DIAGNOSTIC, ...) \
217 extern int (*_GL_GENSYM (_gl_verify_function) (void)) \
218 [_GL_VERIFY_TRUE (R, DIAGNOSTIC)]
219 # if 4 < __GNUC__ + (6 <= __GNUC_MINOR__) && !defined __clang__
220 # pragma GCC diagnostic ignored "-Wnested-externs"
221 # endif
222 #endif
223
224 /* _GL_STATIC_ASSERT_H is defined if this code is copied into assert.h. */
225 #ifdef _GL_STATIC_ASSERT_H
226 /* Define _Static_assert if needed. */
227 /* With clang ≥ 3.8.0 in C++ mode, _Static_assert already works and accepts
228 1 or 2 arguments. We better don't override it, because clang's standard
229 C++ library uses static_assert inside classes in several places, and our
230 replacement via _GL_VERIFY does not work in these contexts. */
231 # if (defined __cplusplus && defined __clang__ \
232 && (4 <= __clang_major__ + (8 <= __clang_minor__)))
233 # if 5 <= __clang_major__
234 /* Avoid "warning: 'static_assert' with no message is a C++17 extension". */
235 # pragma clang diagnostic ignored "-Wc++17-extensions"
236 # else
237 /* Avoid "warning: static_assert with no message is a C++1z extension". */
238 # pragma clang diagnostic ignored "-Wc++1z-extensions"
239 # endif
240 # elif !defined _GL_HAVE__STATIC_ASSERT1 && !defined _Static_assert
241 # if !defined _MSC_VER || defined __clang__
242 # define _Static_assert(...) \
243 _GL_VERIFY (__VA_ARGS__, "static assertion failed", -)
244 # else
245 # if defined __cplusplus && _MSC_VER >= 1910
246 /* In MSVC 14.1 or newer, static_assert accepts one or two arguments,
247 but _Static_assert is not defined. */
248 # define _Static_assert static_assert
249 # else
250 /* Work around MSVC preprocessor incompatibility with ISO C; see
251 <https://stackoverflow.com/questions/5134523/>. */
252 # define _Static_assert(R, ...) \
253 _GL_VERIFY ((R), "static assertion failed", -)
254 # endif
255 # endif
256 # endif
257 /* Define static_assert if needed. */
258 # if (!defined static_assert \
259 && __STDC_VERSION__ < 202311 \
260 && (!defined __cplusplus \
261 || (__cpp_static_assert < 201411 \
262 && __GNUG__ < 6 && __clang_major__ < 6 && _MSC_VER < 1910)))
263 # if (defined __cplusplus && defined __GNUG__ && __GNUG__ < 6 \
264 && __cplusplus == 201103L && !defined __clang__)
265 /* g++ >= 4.7, < 6 with option -std=c++11 or -std=gnu++11 supports the
266 two-arguments static_assert but not the one-argument static_assert, and
267 it does not support _Static_assert.
268 We have to play preprocessor tricks to distinguish the two cases. */
269 # define _GL_SA1(a1) static_assert ((a1), "static assertion failed")
270 # define _GL_SA2 static_assert
271 # define _GL_SA3 static_assert
272 # define _GL_SA_PICK(x1,x2,x3,x4,...) x4
273 # define static_assert(...) _GL_SA_PICK(__VA_ARGS__,_GL_SA3,_GL_SA2,_GL_SA1) (__VA_ARGS__)
274 # elif defined __cplusplus && _MSC_VER >= 1900 && !defined __clang__
275 /* MSVC 14 in C++ mode supports the two-arguments static_assert but not
276 the one-argument static_assert, and it does not support _Static_assert.
277 We have to play preprocessor tricks to distinguish the two cases.
278 Since the MSVC preprocessor is not ISO C compliant (see above),
279 the solution is specific to MSVC. */
280 # define _GL_EXPAND(x) x
281 # define _GL_SA1(a1) static_assert ((a1), "static assertion failed")
282 # define _GL_SA2 static_assert
283 # define _GL_SA3 static_assert
284 # define _GL_SA_PICK(x1,x2,x3,x4,...) x4
285 # define static_assert(...) _GL_EXPAND(_GL_SA_PICK(__VA_ARGS__,_GL_SA3,_GL_SA2,_GL_SA1)) (__VA_ARGS__)
286 /* Avoid "fatal error C1189: #error: The C++ Standard Library forbids macroizing keywords." */
287 # define _ALLOW_KEYWORD_MACROS 1
288 # else
289 # define static_assert _Static_assert /* C11 requires this #define. */
290 # endif
291 # endif
292 #endif
293
294 /* @assert.h omit start@ */
295
296 #if defined __clang_major__ && __clang_major__ < 5
297 # define _GL_HAS_BUILTIN_TRAP 0
298 #elif 3 < __GNUC__ + (3 < __GNUC_MINOR__ + (4 <= __GNUC_PATCHLEVEL__))
299 # define _GL_HAS_BUILTIN_TRAP 1
300 #elif defined __has_builtin
301 # define _GL_HAS_BUILTIN_TRAP __has_builtin (__builtin_trap)
302 #else
303 # define _GL_HAS_BUILTIN_TRAP 0
304 #endif
305
306 #ifndef _GL_HAS_BUILTIN_UNREACHABLE
307 # if defined __clang_major__ && __clang_major__ < 5
308 # define _GL_HAS_BUILTIN_UNREACHABLE 0
309 # elif 4 < __GNUC__ + (5 <= __GNUC_MINOR__) && !defined __clang__
310 # define _GL_HAS_BUILTIN_UNREACHABLE 1
311 # elif defined __has_builtin
312 # define _GL_HAS_BUILTIN_UNREACHABLE __has_builtin (__builtin_unreachable)
313 # else
314 # define _GL_HAS_BUILTIN_UNREACHABLE 0
315 # endif
316 #endif
317
318 /* Each of these macros verifies that its argument R is nonzero. To
319 be portable, R should be an integer constant expression. Unlike
320 assert (R), there is no run-time overhead.
321
322 There are two macros, since no single macro can be used in all
323 contexts in C. verify_expr (R, E) is for scalar contexts, including
324 integer constant expression contexts. verify (R) is for declaration
325 contexts, e.g., the top level. */
326
327 /* Verify requirement R at compile-time. Return the value of the
328 expression E. */
329
330 #define verify_expr(R, E) \
331 (_GL_VERIFY_TRUE (R, "verify_expr (" #R ", " #E ")") ? (E) : (E))
332
333 /* Verify requirement R at compile-time, as a declaration without a
334 trailing ';'. verify (R) acts like static_assert (R) except that
335 it is portable to C11/C++14 and earlier, it can issue better
336 diagnostics, and its name is shorter and may be more convenient. */
337
338 #ifdef __PGI
339 /* PGI barfs if R is long. */
340 # define verify(R) _GL_VERIFY (R, "verify (...)", -)
341 #else
342 # define verify(R) _GL_VERIFY (R, "verify (" #R ")", -)
343 #endif
344
345 /* Assume that R always holds. Behavior is undefined if R is false,
346 fails to evaluate, or has side effects.
347
348 'assume (R)' is a directive from the programmer telling the
349 compiler that R is true so the compiler needn't generate code to
350 test R. This is why 'assume' is in verify.h: it's related to
351 static checking (in this case, static checking done by the
352 programmer), not dynamic checking.
353
354 'assume (R)' can affect compilation of all the code, not just code
355 that happens to be executed after the assume (R) is "executed".
356 For example, if the code mistakenly does 'assert (R); assume (R);'
357 the compiler is entitled to optimize away the 'assert (R)'.
358
359 Although assuming R can help a compiler generate better code or
360 diagnostics, performance can suffer if R uses hard-to-optimize
361 features such as function calls not inlined by the compiler.
362
363 Avoid Clang's __builtin_assume, as it breaks GNU Emacs master
364 as of 2020-08-23T21:09:[email protected]; see
365 <https://bugs.gnu.org/43152#71>. It's not known whether this breakage
366 is a Clang bug or an Emacs bug; play it safe for now. */
367
368 #if _GL_HAS_BUILTIN_UNREACHABLE
369 # define assume(R) ((R) ? (void) 0 : __builtin_unreachable ())
370 #elif 1200 <= _MSC_VER
371 # define assume(R) __assume (R)
372 #elif 202311 <= __STDC_VERSION__
373 # include <stddef.h>
374 # define assume(R) ((R) ? (void) 0 : unreachable ())
375 #elif (defined GCC_LINT || defined lint) && _GL_HAS_BUILTIN_TRAP
376 /* Doing it this way helps various packages when configured with
377 --enable-gcc-warnings, which compiles with -Dlint. It's nicer
378 if 'assume' silences warnings with GCC 3.4 through GCC 4.4.7 (2012). */
379 # define assume(R) ((R) ? (void) 0 : __builtin_trap ())
380 #else
381 /* Some older tools grok NOTREACHED, e.g., Oracle Studio 12.6 (2017). */
382 # define assume(R) ((R) ? (void) 0 : /*NOTREACHED*/ (void) 0)
383 #endif
384
385 /* @assert.h omit end@ */
386
387 #endif