xref: /src/lib/libnetbsd/sys/cdefs.h (revision db5344a7445f1a796bc3cacd32a46e88e3e589a7)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 2012 SRI International
5  * Copyright (c) 1992, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 #ifndef _LIBNETBSD_SYS_CDEFS_H_
34 #define _LIBNETBSD_SYS_CDEFS_H_
35 
36 #include_next <sys/cdefs.h>
37 
38 #ifndef __dead
39 #ifdef __dead2
40 #define __dead __dead2
41 #else
42 #define __dead
43 #endif
44 #endif /* !__dead */
45 
46 /*
47  * The __CONCAT macro is used to concatenate parts of symbol names, e.g.
48  * with "#define OLD(foo) __CONCAT(old,foo)", OLD(foo) produces oldfoo.
49  * The __CONCAT macro is a bit tricky -- make sure you don't put spaces
50  * in between its arguments.  __CONCAT can also concatenate double-quoted
51  * strings produced by the __STRING macro, but this only works with ANSI C.
52  */
53 
54 #define	___STRING(x)	__STRING(x)
55 #define	___CONCAT(x,y)	__CONCAT(x,y)
56 
57 /*
58  * Compile Time Assertion.
59  */
60 #ifdef __COUNTER__
61 #define	__CTASSERT(x)		__CTASSERT0(x, __ctassert, __COUNTER__)
62 #else
63 #define	__CTASSERT(x)		__CTASSERT99(x, __INCLUDE_LEVEL__, __LINE__)
64 #define	__CTASSERT99(x, a, b)	__CTASSERT0(x, __CONCAT(__ctassert,a), \
65 					       __CONCAT(_,b))
66 #endif
67 #define	__CTASSERT0(x, y, z)	__CTASSERT1(x, y, z)
68 #define	__CTASSERT1(x, y, z)	\
69 	struct y ## z ## _struct { \
70 		unsigned int y ## z : /*CONSTCOND*/(x) ? 1 : -1; \
71 	}
72 
73 /*
74  * The following macro is used to remove const cast-away warnings
75  * from gcc -Wcast-qual; it should be used with caution because it
76  * can hide valid errors; in particular most valid uses are in
77  * situations where the API requires it, not to cast away string
78  * constants. We don't use *intptr_t on purpose here and we are
79  * explicit about unsigned long so that we don't have additional
80  * dependencies.
81  */
82 #define __UNCONST(a)	((void *)(unsigned long)(const void *)(a))
83 
84 /*
85  * Return the number of elements in a statically-allocated array,
86  * __x.
87  */
88 #define	__arraycount(__x)	(sizeof(__x) / sizeof(__x[0]))
89 
90 /* __BIT(n): nth bit, where __BIT(0) == 0x1. */
91 #define	__BIT(__n)	\
92     (((uintmax_t)(__n) >= NBBY * sizeof(uintmax_t)) ? 0 : \
93     ((uintmax_t)1 << (uintmax_t)((__n) & (NBBY * sizeof(uintmax_t) - 1))))
94 
95 /* __BITS(m, n): bits m through n, m < n. */
96 #define	__BITS(__m, __n)	\
97 	((__BIT(MAX((__m), (__n)) + 1) - 1) ^ (__BIT(MIN((__m), (__n))) - 1))
98 
99 /*
100  * To be used when an empty body is required like:
101  *
102  * #ifdef DEBUG
103  * # define dprintf(a) printf(a)
104  * #else
105  * # define dprintf(a) __nothing
106  * #endif
107  *
108  * We use ((void)0) instead of do {} while (0) so that it
109  * works on , expressions.
110  */
111 #define __nothing	(/*LINTED*/(void)0)
112 
113 #define __negative_p(x) (!((x) > 0) && ((x) != 0))
114 
115 #define __type_min_s(t) ((t)((1ULL << (sizeof(t) * __CHAR_BIT__ - 1))))
116 #define __type_max_s(t) ((t)~((1ULL << (sizeof(t) * __CHAR_BIT__ - 1))))
117 #define __type_min_u(t) ((t)0ULL)
118 #define __type_max_u(t) ((t)~0ULL)
119 #define __type_is_signed(t) (/*LINTED*/__type_min_s(t) + (t)1 < (t)1)
120 #define __type_min(t) (__type_is_signed(t) ? __type_min_s(t) : __type_min_u(t))
121 #define __type_max(t) (__type_is_signed(t) ? __type_max_s(t) : __type_max_u(t))
122 
123 
124 #define __type_fit_u(t, a)						      \
125 	(/*LINTED*/!__negative_p(a) &&					      \
126 	    ((__UINTMAX_TYPE__)((a) + __zeroull()) <=			      \
127 		(__UINTMAX_TYPE__)__type_max_u(t)))
128 
129 #define __type_fit_s(t, a)						      \
130 	(/*LINTED*/__negative_p(a)					      \
131 	    ? ((__INTMAX_TYPE__)((a) + __zeroll()) >=			      \
132 		(__INTMAX_TYPE__)__type_min_s(t))			      \
133 	    : ((__INTMAX_TYPE__)((a) + __zeroll()) >= (__INTMAX_TYPE__)0 &&   \
134 		((__INTMAX_TYPE__)((a) + __zeroll()) <=			      \
135 		    (__INTMAX_TYPE__)__type_max_s(t))))
136 
137 /*
138  * return true if value 'a' fits in type 't'
139  */
140 #define __type_fit(t, a) (__type_is_signed(t) ? \
141     __type_fit_s(t, a) : __type_fit_u(t, a))
142 
143 #endif /* _LIBNETBSD_SYS_CDEFS_H_ */
144