2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
29 #include "openvswitch/types.h"
33 #define va_copy __va_copy
35 #define va_copy(dst, src) ((dst) = (src))
40 #define BUILD_ASSERT(EXPR) ((void) 0)
41 #define BUILD_ASSERT_DECL(EXPR) extern int (*build_assert(void))[1]
42 #elif !defined(__cplusplus)
43 /* Build-time assertion building block. */
44 #define BUILD_ASSERT__(EXPR) \
45 sizeof(struct { unsigned int build_assert_failed : (EXPR) ? 1 : -1; })
47 /* Build-time assertion for use in a statement context. */
48 #define BUILD_ASSERT(EXPR) (void) BUILD_ASSERT__(EXPR)
50 /* Build-time assertion for use in a declaration context. */
51 #define BUILD_ASSERT_DECL(EXPR) \
52 extern int (*build_assert(void))[BUILD_ASSERT__(EXPR)]
53 #else /* __cplusplus */
54 #include <boost/static_assert.hpp>
55 #define BUILD_ASSERT BOOST_STATIC_ASSERT
56 #define BUILD_ASSERT_DECL BOOST_STATIC_ASSERT
57 #endif /* __cplusplus */
60 #define BUILD_ASSERT_GCCONLY(EXPR) BUILD_ASSERT(EXPR)
61 #define BUILD_ASSERT_DECL_GCCONLY(EXPR) BUILD_ASSERT_DECL(EXPR)
63 #define BUILD_ASSERT_GCCONLY(EXPR) ((void) 0)
64 #define BUILD_ASSERT_DECL_GCCONLY(EXPR) ((void) 0)
67 /* Like the standard assert macro, except:
69 * - Writes the failure message to the log.
71 * - Not affected by NDEBUG. */
72 #define ovs_assert(CONDITION) \
73 if (!OVS_LIKELY(CONDITION)) { \
74 ovs_assert_failure(SOURCE_LOCATOR, __func__, #CONDITION); \
76 void ovs_assert_failure(const char *, const char *, const char *) NO_RETURN;
78 /* Casts 'pointer' to 'type' and issues a compiler warning if the cast changes
79 * anything other than an outermost "const" or "volatile" qualifier.
81 * The cast to int is present only to suppress an "expression using sizeof
82 * bool" warning from "sparse" (see
83 * http://permalink.gmane.org/gmane.comp.parsers.sparse/2967). */
84 #define CONST_CAST(TYPE, POINTER) \
85 ((void) sizeof ((int) ((POINTER) == (TYPE) (POINTER))), \
88 extern const char *program_name;
90 #define __ARRAY_SIZE_NOCHECK(ARRAY) (sizeof(ARRAY) / sizeof((ARRAY)[0]))
92 /* return 0 for array types, 1 otherwise */
93 #define __ARRAY_CHECK(ARRAY) \
94 !__builtin_types_compatible_p(typeof(ARRAY), typeof(&ARRAY[0]))
96 /* compile-time fail if not array */
97 #define __ARRAY_FAIL(ARRAY) (sizeof(char[-2*!__ARRAY_CHECK(ARRAY)]))
98 #define __ARRAY_SIZE(ARRAY) \
99 __builtin_choose_expr(__ARRAY_CHECK(ARRAY), \
100 __ARRAY_SIZE_NOCHECK(ARRAY), __ARRAY_FAIL(ARRAY))
102 #define __ARRAY_SIZE(ARRAY) __ARRAY_SIZE_NOCHECK(ARRAY)
105 /* Returns the number of elements in ARRAY. */
106 #define ARRAY_SIZE(ARRAY) __ARRAY_SIZE(ARRAY)
108 /* Returns X / Y, rounding up. X must be nonnegative to round correctly. */
109 #define DIV_ROUND_UP(X, Y) (((X) + ((Y) - 1)) / (Y))
111 /* Returns X rounded up to the nearest multiple of Y. */
112 #define ROUND_UP(X, Y) (DIV_ROUND_UP(X, Y) * (Y))
114 /* Returns X rounded down to the nearest multiple of Y. */
115 #define ROUND_DOWN(X, Y) ((X) / (Y) * (Y))
117 /* Returns true if X is a power of 2, otherwise false. */
118 #define IS_POW2(X) ((X) && !((X) & ((X) - 1)))
126 /* Returns X rounded up to a power of 2. X must be a constant expression. */
127 #define ROUND_UP_POW2(X) RUP2__(X)
128 #define RUP2__(X) (RUP2_1(X) + 1)
129 #define RUP2_1(X) (RUP2_2(X) | (RUP2_2(X) >> 16))
130 #define RUP2_2(X) (RUP2_3(X) | (RUP2_3(X) >> 8))
131 #define RUP2_3(X) (RUP2_4(X) | (RUP2_4(X) >> 4))
132 #define RUP2_4(X) (RUP2_5(X) | (RUP2_5(X) >> 2))
133 #define RUP2_5(X) (RUP2_6(X) | (RUP2_6(X) >> 1))
134 #define RUP2_6(X) ((X) - 1)
136 /* Returns X rounded down to a power of 2. X must be a constant expression. */
137 #define ROUND_DOWN_POW2(X) RDP2__(X)
138 #define RDP2__(X) (RDP2_1(X) - (RDP2_1(X) >> 1))
139 #define RDP2_1(X) (RDP2_2(X) | (RDP2_2(X) >> 16))
140 #define RDP2_2(X) (RDP2_3(X) | (RDP2_3(X) >> 8))
141 #define RDP2_3(X) (RDP2_4(X) | (RDP2_4(X) >> 4))
142 #define RDP2_4(X) (RDP2_5(X) | (RDP2_5(X) >> 2))
143 #define RDP2_5(X) ( (X) | ( (X) >> 1))
146 #define MIN(X, Y) ((X) < (Y) ? (X) : (Y))
150 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
153 #define NOT_REACHED() abort()
155 /* Expands to a string that looks like "<file>:<line>", e.g. "tmp.c:10".
157 * See http://c-faq.com/ansi/stringize.html for an explanation of STRINGIZE and
159 #define SOURCE_LOCATOR __FILE__ ":" STRINGIZE(__LINE__)
160 #define STRINGIZE(ARG) STRINGIZE2(ARG)
161 #define STRINGIZE2(ARG) #ARG
163 /* Given a pointer-typed lvalue OBJECT, expands to a pointer type that may be
164 * assigned to OBJECT. */
166 #define OVS_TYPEOF(OBJECT) typeof(OBJECT)
168 #define OVS_TYPEOF(OBJECT) void *
171 /* Given OBJECT of type pointer-to-structure, expands to the offset of MEMBER
172 * within an instance of the structure.
174 * The GCC-specific version avoids the technicality of undefined behavior if
175 * OBJECT is null, invalid, or not yet initialized. This makes some static
176 * checkers (like Coverity) happier. But the non-GCC version does not actually
177 * dereference any pointer, so it would be surprising for it to cause any
178 * problems in practice.
181 #define OBJECT_OFFSETOF(OBJECT, MEMBER) offsetof(typeof(*(OBJECT)), MEMBER)
183 #define OBJECT_OFFSETOF(OBJECT, MEMBER) \
184 ((char *) &(OBJECT)->MEMBER - (char *) (OBJECT))
187 /* Given POINTER, the address of the given MEMBER in a STRUCT object, returns
188 the STRUCT object. */
189 #define CONTAINER_OF(POINTER, STRUCT, MEMBER) \
190 ((STRUCT *) (void *) ((char *) (POINTER) - offsetof (STRUCT, MEMBER)))
192 /* Given POINTER, the address of the given MEMBER within an object of the type
193 * that that OBJECT points to, returns OBJECT as an assignment-compatible
194 * pointer type (either the correct pointer type or "void *"). OBJECT must be
197 * This is the same as CONTAINER_OF except that it infers the structure type
198 * from the type of '*OBJECT'. */
199 #define OBJECT_CONTAINING(POINTER, OBJECT, MEMBER) \
200 ((OVS_TYPEOF(OBJECT)) (void *) \
201 ((char *) (POINTER) - OBJECT_OFFSETOF(OBJECT, MEMBER)))
203 /* Given POINTER, the address of the given MEMBER within an object of the type
204 * that that OBJECT points to, assigns the address of the outer object to
205 * OBJECT, which must be an lvalue.
207 * Evaluates to (void) 0 as the result is not to be used. */
208 #define ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER) \
209 ((OBJECT) = OBJECT_CONTAINING(POINTER, OBJECT, MEMBER), (void) 0)
211 /* Given ATTR, and TYPE, cast the ATTR to TYPE by first casting ATTR to
212 * (void *). This is to suppress the alignment warning issued by clang. */
213 #define ALIGNED_CAST(TYPE, ATTR) ((TYPE) (void *) (ATTR))
219 void set_program_name__(const char *name, const char *version,
220 const char *date, const char *time);
221 #define set_program_name(name) \
222 set_program_name__(name, VERSION, __DATE__, __TIME__)
224 const char *get_subprogram_name(void);
225 void set_subprogram_name(const char *format, ...) PRINTF_FORMAT(1, 2);
227 const char *get_program_version(void);
228 void ovs_print_version(uint8_t min_ofp, uint8_t max_ofp);
230 void out_of_memory(void) NO_RETURN;
231 void *xmalloc(size_t) MALLOC_LIKE;
232 void *xcalloc(size_t, size_t) MALLOC_LIKE;
233 void *xzalloc(size_t) MALLOC_LIKE;
234 void *xrealloc(void *, size_t);
235 void *xmemdup(const void *, size_t) MALLOC_LIKE;
236 char *xmemdup0(const char *, size_t) MALLOC_LIKE;
237 char *xstrdup(const char *) MALLOC_LIKE;
238 char *xasprintf(const char *format, ...) PRINTF_FORMAT(1, 2) MALLOC_LIKE;
239 char *xvasprintf(const char *format, va_list) PRINTF_FORMAT(1, 0) MALLOC_LIKE;
240 void *x2nrealloc(void *p, size_t *n, size_t s);
242 void ovs_strlcpy(char *dst, const char *src, size_t size);
243 void ovs_strzcpy(char *dst, const char *src, size_t size);
245 void ovs_abort(int err_no, const char *format, ...)
246 PRINTF_FORMAT(2, 3) NO_RETURN;
247 void ovs_abort_valist(int err_no, const char *format, va_list)
248 PRINTF_FORMAT(2, 0) NO_RETURN;
249 void ovs_fatal(int err_no, const char *format, ...)
250 PRINTF_FORMAT(2, 3) NO_RETURN;
251 void ovs_fatal_valist(int err_no, const char *format, va_list)
252 PRINTF_FORMAT(2, 0) NO_RETURN;
253 void ovs_error(int err_no, const char *format, ...) PRINTF_FORMAT(2, 3);
254 void ovs_error_valist(int err_no, const char *format, va_list)
256 const char *ovs_retval_to_string(int);
257 const char *ovs_strerror(int);
258 void ovs_hex_dump(FILE *, const void *, size_t, uintptr_t offset, bool ascii);
260 bool str_to_int(const char *, int base, int *);
261 bool str_to_long(const char *, int base, long *);
262 bool str_to_llong(const char *, int base, long long *);
263 bool str_to_uint(const char *, int base, unsigned int *);
264 bool str_to_ulong(const char *, int base, unsigned long *);
265 bool str_to_ullong(const char *, int base, unsigned long long *);
267 bool str_to_double(const char *, double *);
269 int hexit_value(int c);
270 unsigned int hexits_value(const char *s, size_t n, bool *ok);
272 const char *english_list_delimiter(size_t index, size_t total);
275 char *dir_name(const char *file_name);
276 char *base_name(const char *file_name);
277 char *abs_file_name(const char *dir, const char *file_name);
279 char *xreadlink(const char *filename);
280 char *follow_symlinks(const char *filename);
282 void ignore(bool x OVS_UNUSED);
286 /* Returns the number of trailing 0-bits in 'n'. Undefined if 'n' == 0.
288 * This compiles to a single machine instruction ("bsf") with GCC on x86. */
289 #if !defined(UINT_MAX) || !defined(UINT32_MAX)
290 #error "Someone screwed up the #includes."
291 #elif __GNUC__ >= 4 && UINT_MAX == UINT32_MAX
295 return __builtin_ctz(n);
298 /* Defined in util.c. */
299 int raw_ctz(uint32_t n);
302 /* Returns the number of trailing 0-bits in 'n', or 32 if 'n' is 0. */
306 return n ? raw_ctz(n) : 32;
309 int log_2_floor(uint32_t);
310 int log_2_ceil(uint32_t);
311 unsigned int popcount(uint32_t);
313 /* Returns the rightmost 1-bit in 'x' (e.g. 01011000 => 00001000), or 0 if 'x'
315 static inline uintmax_t
316 rightmost_1bit(uintmax_t x)
321 /* Returns 'x' with its rightmost 1-bit changed to a zero (e.g. 01011000 =>
322 * 01010000), or 0 if 'x' is 0. */
323 static inline uintmax_t
324 zero_rightmost_1bit(uintmax_t x)
329 /* Returns the index of the rightmost 1-bit in 'x' (e.g. 01011000 => 3), or 32
332 * Unlike the other functions for rightmost 1-bits, this function only works
333 * with 32-bit integers. */
334 static inline uint32_t
335 rightmost_1bit_idx(uint32_t x)
337 return x ? ctz(x) : 32;
340 /* Returns the index of the rightmost 1-bit in 'x' (e.g. 01011000 => 6), or 32
343 * This function only works with 32-bit integers. */
344 static inline uint32_t
345 leftmost_1bit_idx(uint32_t x)
347 return x ? log_2_floor(x) : 32;
350 bool is_all_zeros(const uint8_t *, size_t);
351 bool is_all_ones(const uint8_t *, size_t);
352 void bitwise_copy(const void *src, unsigned int src_len, unsigned int src_ofs,
353 void *dst, unsigned int dst_len, unsigned int dst_ofs,
354 unsigned int n_bits);
355 void bitwise_zero(void *dst_, unsigned int dst_len, unsigned dst_ofs,
356 unsigned int n_bits);
357 void bitwise_one(void *dst_, unsigned int dst_len, unsigned dst_ofs,
358 unsigned int n_bits);
359 bool bitwise_is_all_zeros(const void *, unsigned int len, unsigned int ofs,
360 unsigned int n_bits);
361 void bitwise_put(uint64_t value,
362 void *dst, unsigned int dst_len, unsigned int dst_ofs,
363 unsigned int n_bits);
364 uint64_t bitwise_get(const void *src, unsigned int src_len,
365 unsigned int src_ofs, unsigned int n_bits);