2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 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.
20 #include <arpa/inet.h>
31 #include "openvswitch/types.h"
32 #include "openvswitch/util.h"
36 #define va_copy __va_copy
38 #define va_copy(dst, src) ((dst) = (src))
43 #define BUILD_ASSERT(EXPR) ((void) 0)
44 #define BUILD_ASSERT_DECL(EXPR) extern int (*build_assert(void))[1]
45 #elif !defined(__cplusplus)
46 /* Build-time assertion building block. */
47 #define BUILD_ASSERT__(EXPR) \
48 sizeof(struct { unsigned int build_assert_failed : (EXPR) ? 1 : -1; })
50 /* Build-time assertion for use in a statement context. */
51 #define BUILD_ASSERT(EXPR) (void) BUILD_ASSERT__(EXPR)
53 /* Build-time assertion for use in a declaration context. */
54 #define BUILD_ASSERT_DECL(EXPR) \
55 extern int (*build_assert(void))[BUILD_ASSERT__(EXPR)]
56 #else /* __cplusplus */
57 #include <boost/static_assert.hpp>
58 #define BUILD_ASSERT BOOST_STATIC_ASSERT
59 #define BUILD_ASSERT_DECL BOOST_STATIC_ASSERT
60 #endif /* __cplusplus */
63 #define BUILD_ASSERT_GCCONLY(EXPR) BUILD_ASSERT(EXPR)
64 #define BUILD_ASSERT_DECL_GCCONLY(EXPR) BUILD_ASSERT_DECL(EXPR)
66 #define BUILD_ASSERT_GCCONLY(EXPR) ((void) 0)
67 #define BUILD_ASSERT_DECL_GCCONLY(EXPR) ((void) 0)
70 /* Like the standard assert macro, except writes the failure message to the
73 #define ovs_assert(CONDITION) \
74 if (!OVS_LIKELY(CONDITION)) { \
75 ovs_assert_failure(OVS_SOURCE_LOCATOR, __func__, #CONDITION); \
78 #define ovs_assert(CONDITION) ((void) (CONDITION))
80 OVS_NO_RETURN void ovs_assert_failure(const char *, const char *, const char *);
82 /* Casts 'pointer' to 'type' and issues a compiler warning if the cast changes
83 * anything other than an outermost "const" or "volatile" qualifier.
85 * The cast to int is present only to suppress an "expression using sizeof
86 * bool" warning from "sparse" (see
87 * http://permalink.gmane.org/gmane.comp.parsers.sparse/2967). */
88 #define CONST_CAST(TYPE, POINTER) \
89 ((void) sizeof ((int) ((POINTER) == (TYPE) (POINTER))), \
92 extern char *program_name;
94 #define __ARRAY_SIZE_NOCHECK(ARRAY) (sizeof(ARRAY) / sizeof((ARRAY)[0]))
96 /* return 0 for array types, 1 otherwise */
97 #define __ARRAY_CHECK(ARRAY) \
98 !__builtin_types_compatible_p(typeof(ARRAY), typeof(&ARRAY[0]))
100 /* compile-time fail if not array */
101 #define __ARRAY_FAIL(ARRAY) (sizeof(char[-2*!__ARRAY_CHECK(ARRAY)]))
102 #define __ARRAY_SIZE(ARRAY) \
103 __builtin_choose_expr(__ARRAY_CHECK(ARRAY), \
104 __ARRAY_SIZE_NOCHECK(ARRAY), __ARRAY_FAIL(ARRAY))
106 #define __ARRAY_SIZE(ARRAY) __ARRAY_SIZE_NOCHECK(ARRAY)
109 /* Returns the number of elements in ARRAY. */
110 #define ARRAY_SIZE(ARRAY) __ARRAY_SIZE(ARRAY)
112 /* Returns X / Y, rounding up. X must be nonnegative to round correctly. */
113 #define DIV_ROUND_UP(X, Y) (((X) + ((Y) - 1)) / (Y))
115 /* Returns X rounded up to the nearest multiple of Y. */
116 #define ROUND_UP(X, Y) (DIV_ROUND_UP(X, Y) * (Y))
118 /* Returns the least number that, when added to X, yields a multiple of Y. */
119 #define PAD_SIZE(X, Y) (ROUND_UP(X, Y) - (X))
121 /* Returns X rounded down to the nearest multiple of Y. */
122 #define ROUND_DOWN(X, Y) ((X) / (Y) * (Y))
124 /* Returns true if X is a power of 2, otherwise false. */
125 #define IS_POW2(X) ((X) && !((X) & ((X) - 1)))
133 /* Returns X rounded up to a power of 2. X must be a constant expression. */
134 #define ROUND_UP_POW2(X) RUP2__(X)
135 #define RUP2__(X) (RUP2_1(X) + 1)
136 #define RUP2_1(X) (RUP2_2(X) | (RUP2_2(X) >> 16))
137 #define RUP2_2(X) (RUP2_3(X) | (RUP2_3(X) >> 8))
138 #define RUP2_3(X) (RUP2_4(X) | (RUP2_4(X) >> 4))
139 #define RUP2_4(X) (RUP2_5(X) | (RUP2_5(X) >> 2))
140 #define RUP2_5(X) (RUP2_6(X) | (RUP2_6(X) >> 1))
141 #define RUP2_6(X) ((X) - 1)
143 /* Returns X rounded down to a power of 2. X must be a constant expression. */
144 #define ROUND_DOWN_POW2(X) RDP2__(X)
145 #define RDP2__(X) (RDP2_1(X) - (RDP2_1(X) >> 1))
146 #define RDP2_1(X) (RDP2_2(X) | (RDP2_2(X) >> 16))
147 #define RDP2_2(X) (RDP2_3(X) | (RDP2_3(X) >> 8))
148 #define RDP2_3(X) (RDP2_4(X) | (RDP2_4(X) >> 4))
149 #define RDP2_4(X) (RDP2_5(X) | (RDP2_5(X) >> 2))
150 #define RDP2_5(X) ( (X) | ( (X) >> 1))
152 /* This system's cache line size, in bytes.
153 * Being wrong hurts performance but not correctness. */
154 #define CACHE_LINE_SIZE 64
155 BUILD_ASSERT_DECL(IS_POW2(CACHE_LINE_SIZE));
158 ovs_prefetch_range(const void *start, size_t size)
160 const char *addr = (const char *)start;
163 for (ofs = 0; ofs < size; ofs += CACHE_LINE_SIZE) {
164 OVS_PREFETCH(addr + ofs);
169 #define MIN(X, Y) ((X) < (Y) ? (X) : (Y))
173 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
176 #define OVS_NOT_REACHED() abort()
178 /* Given a pointer-typed lvalue OBJECT, expands to a pointer type that may be
179 * assigned to OBJECT. */
181 #define OVS_TYPEOF(OBJECT) typeof(OBJECT)
183 #define OVS_TYPEOF(OBJECT) void *
186 /* Given OBJECT of type pointer-to-structure, expands to the offset of MEMBER
187 * within an instance of the structure.
189 * The GCC-specific version avoids the technicality of undefined behavior if
190 * OBJECT is null, invalid, or not yet initialized. This makes some static
191 * checkers (like Coverity) happier. But the non-GCC version does not actually
192 * dereference any pointer, so it would be surprising for it to cause any
193 * problems in practice.
196 #define OBJECT_OFFSETOF(OBJECT, MEMBER) offsetof(typeof(*(OBJECT)), MEMBER)
198 #define OBJECT_OFFSETOF(OBJECT, MEMBER) \
199 ((char *) &(OBJECT)->MEMBER - (char *) (OBJECT))
202 /* Given POINTER, the address of the given MEMBER in a STRUCT object, returns
203 the STRUCT object. */
204 #define CONTAINER_OF(POINTER, STRUCT, MEMBER) \
205 ((STRUCT *) (void *) ((char *) (POINTER) - offsetof (STRUCT, MEMBER)))
207 /* Given POINTER, the address of the given MEMBER within an object of the type
208 * that that OBJECT points to, returns OBJECT as an assignment-compatible
209 * pointer type (either the correct pointer type or "void *"). OBJECT must be
212 * This is the same as CONTAINER_OF except that it infers the structure type
213 * from the type of '*OBJECT'. */
214 #define OBJECT_CONTAINING(POINTER, OBJECT, MEMBER) \
215 ((OVS_TYPEOF(OBJECT)) (void *) \
216 ((char *) (POINTER) - OBJECT_OFFSETOF(OBJECT, MEMBER)))
218 /* Given POINTER, the address of the given MEMBER within an object of the type
219 * that that OBJECT points to, assigns the address of the outer object to
220 * OBJECT, which must be an lvalue.
222 * Evaluates to (void) 0 as the result is not to be used. */
223 #define ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER) \
224 ((OBJECT) = OBJECT_CONTAINING(POINTER, OBJECT, MEMBER), (void) 0)
226 /* As explained in the comment above OBJECT_OFFSETOF(), non-GNUC compilers
227 * like MSVC will complain about un-initialized variables if OBJECT
228 * hasn't already been initialized. To prevent such warnings, INIT_CONTAINER()
229 * can be used as a wrapper around ASSIGN_CONTAINER. */
230 #define INIT_CONTAINER(OBJECT, POINTER, MEMBER) \
231 ((OBJECT) = NULL, ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER))
233 /* Given ATTR, and TYPE, cast the ATTR to TYPE by first casting ATTR to
234 * (void *). This is to suppress the alignment warning issued by clang. */
235 #define ALIGNED_CAST(TYPE, ATTR) ((TYPE) (void *) (ATTR))
237 /* Use "%"PRIuSIZE to format size_t with printf(). */
239 #define PRIdSIZE "Id"
240 #define PRIiSIZE "Ii"
241 #define PRIoSIZE "Io"
242 #define PRIuSIZE "Iu"
243 #define PRIxSIZE "Ix"
244 #define PRIXSIZE "IX"
246 #define PRIdSIZE "zd"
247 #define PRIiSIZE "zi"
248 #define PRIoSIZE "zo"
249 #define PRIuSIZE "zu"
250 #define PRIxSIZE "zx"
251 #define PRIXSIZE "zX"
255 typedef uint32_t HANDLE;
262 #define set_program_name(name) \
263 ovs_set_program_name(name, OVS_PACKAGE_VERSION)
265 const char *get_subprogram_name(void);
266 void set_subprogram_name(const char *format, ...) OVS_PRINTF_FORMAT(1, 2);
268 void ovs_print_version(uint8_t min_ofp, uint8_t max_ofp);
270 OVS_NO_RETURN void out_of_memory(void);
271 void *xmalloc(size_t) MALLOC_LIKE;
272 void *xcalloc(size_t, size_t) MALLOC_LIKE;
273 void *xzalloc(size_t) MALLOC_LIKE;
274 void *xrealloc(void *, size_t);
275 void *xmemdup(const void *, size_t) MALLOC_LIKE;
276 char *xmemdup0(const char *, size_t) MALLOC_LIKE;
277 char *xstrdup(const char *) MALLOC_LIKE;
278 char *xasprintf(const char *format, ...) OVS_PRINTF_FORMAT(1, 2) MALLOC_LIKE;
279 char *xvasprintf(const char *format, va_list) OVS_PRINTF_FORMAT(1, 0) MALLOC_LIKE;
280 void *x2nrealloc(void *p, size_t *n, size_t s);
282 void *xmalloc_cacheline(size_t) MALLOC_LIKE;
283 void *xzalloc_cacheline(size_t) MALLOC_LIKE;
284 void free_cacheline(void *);
286 void ovs_strlcpy(char *dst, const char *src, size_t size);
287 void ovs_strzcpy(char *dst, const char *src, size_t size);
289 OVS_NO_RETURN void ovs_abort(int err_no, const char *format, ...)
290 OVS_PRINTF_FORMAT(2, 3);
291 OVS_NO_RETURN void ovs_abort_valist(int err_no, const char *format, va_list)
292 OVS_PRINTF_FORMAT(2, 0);
293 OVS_NO_RETURN void ovs_fatal(int err_no, const char *format, ...)
294 OVS_PRINTF_FORMAT(2, 3);
295 OVS_NO_RETURN void ovs_fatal_valist(int err_no, const char *format, va_list)
296 OVS_PRINTF_FORMAT(2, 0);
297 void ovs_error(int err_no, const char *format, ...) OVS_PRINTF_FORMAT(2, 3);
298 void ovs_error_valist(int err_no, const char *format, va_list)
299 OVS_PRINTF_FORMAT(2, 0);
300 const char *ovs_retval_to_string(int);
301 const char *ovs_strerror(int);
302 void ovs_hex_dump(FILE *, const void *, size_t, uintptr_t offset, bool ascii);
304 bool str_to_int(const char *, int base, int *);
305 bool str_to_long(const char *, int base, long *);
306 bool str_to_llong(const char *, int base, long long *);
307 bool str_to_uint(const char *, int base, unsigned int *);
309 bool ovs_scan(const char *s, const char *format, ...) OVS_SCANF_FORMAT(2, 3);
310 bool ovs_scan_len(const char *s, int *n, const char *format, ...);
312 bool str_to_double(const char *, double *);
314 int hexit_value(int c);
315 uintmax_t hexits_value(const char *s, size_t n, bool *ok);
317 const char *english_list_delimiter(size_t index, size_t total);
321 char *dir_name(const char *file_name);
322 char *base_name(const char *file_name);
324 char *abs_file_name(const char *dir, const char *file_name);
326 char *follow_symlinks(const char *filename);
328 void ignore(bool x OVS_UNUSED);
332 /* Returns the number of trailing 0-bits in 'n'. Undefined if 'n' == 0. */
337 /* With GCC 4.7 on 32-bit x86, if a 32-bit integer is passed as 'n', using
338 * a plain __builtin_ctzll() here always generates an out-of-line function
339 * call. The test below helps it to emit a single 'bsf' instruction. */
340 return (__builtin_constant_p(n <= UINT32_MAX) && n <= UINT32_MAX
342 : __builtin_ctzll(n));
346 raw_clz64(uint64_t n)
348 return __builtin_clzll(n);
356 _BitScanForward64(&r, n);
359 unsigned long low = n, high, r = 0;
360 if (_BitScanForward(&r, low)) {
364 _BitScanForward(&r, high);
370 raw_clz64(uint64_t n)
374 _BitScanReverse64(&r, n);
377 unsigned long low, high = n >> 32, r = 0;
378 if (_BitScanReverse(&r, high)) {
382 _BitScanReverse(&r, low);
387 /* Defined in util.c. */
388 int raw_ctz(uint64_t n);
389 int raw_clz64(uint64_t n);
392 /* Returns the number of trailing 0-bits in 'n', or 32 if 'n' is 0. */
396 return n ? raw_ctz(n) : 32;
399 /* Returns the number of trailing 0-bits in 'n', or 64 if 'n' is 0. */
403 return n ? raw_ctz(n) : 64;
406 /* Returns the number of leading 0-bits in 'n', or 32 if 'n' is 0. */
410 return n ? raw_clz64(n) - 32 : 32;
413 /* Returns the number of leading 0-bits in 'n', or 64 if 'n' is 0. */
417 return n ? raw_clz64(n) : 64;
420 /* Given a word 'n', calculates floor(log_2('n')). This is equivalent
421 * to finding the bit position of the most significant one bit in 'n'. It is
422 * an error to call this function with 'n' == 0. */
424 log_2_floor(uint64_t n)
426 return 63 - raw_clz64(n);
429 /* Given a word 'n', calculates ceil(log_2('n')). It is an error to
430 * call this function with 'n' == 0. */
432 log_2_ceil(uint64_t n)
434 return log_2_floor(n) + !is_pow2(n);
437 /* unsigned int count_1bits(uint64_t x):
439 * Returns the number of 1-bits in 'x', between 0 and 64 inclusive. */
440 #if UINTPTR_MAX == UINT64_MAX
441 static inline unsigned int
442 count_1bits(uint64_t x)
444 #if __GNUC__ >= 4 && __POPCNT__
445 return __builtin_popcountll(x);
447 /* This portable implementation is the fastest one we know of for 64
448 * bits, and about 3x faster than GCC 4.7 __builtin_popcountll(). */
449 const uint64_t h55 = UINT64_C(0x5555555555555555);
450 const uint64_t h33 = UINT64_C(0x3333333333333333);
451 const uint64_t h0F = UINT64_C(0x0F0F0F0F0F0F0F0F);
452 const uint64_t h01 = UINT64_C(0x0101010101010101);
453 x -= (x >> 1) & h55; /* Count of each 2 bits in-place. */
454 x = (x & h33) + ((x >> 2) & h33); /* Count of each 4 bits in-place. */
455 x = (x + (x >> 4)) & h0F; /* Count of each 8 bits in-place. */
456 return (x * h01) >> 56; /* Sum of all bytes. */
459 #else /* Not 64-bit. */
460 #if __GNUC__ >= 4 && __POPCNT__
461 static inline unsigned int
462 count_1bits_32__(uint32_t x)
464 return __builtin_popcount(x);
467 #define NEED_COUNT_1BITS_8 1
468 extern const uint8_t count_1bits_8[256];
469 static inline unsigned int
470 count_1bits_32__(uint32_t x)
472 /* This portable implementation is the fastest one we know of for 32 bits,
473 * and faster than GCC __builtin_popcount(). */
474 return (count_1bits_8[x & 0xff] +
475 count_1bits_8[(x >> 8) & 0xff] +
476 count_1bits_8[(x >> 16) & 0xff] +
477 count_1bits_8[x >> 24]);
480 static inline unsigned int
481 count_1bits(uint64_t x)
483 return count_1bits_32__(x) + count_1bits_32__(x >> 32);
487 /* Returns the rightmost 1-bit in 'x' (e.g. 01011000 => 00001000), or 0 if 'x'
489 static inline uintmax_t
490 rightmost_1bit(uintmax_t x)
495 /* Returns 'x' with its rightmost 1-bit changed to a zero (e.g. 01011000 =>
496 * 01010000), or 0 if 'x' is 0. */
497 static inline uintmax_t
498 zero_rightmost_1bit(uintmax_t x)
503 /* Returns the index of the rightmost 1-bit in 'x' (e.g. 01011000 => 3), or 32
506 * Unlike the other functions for rightmost 1-bits, this function only works
507 * with 32-bit integers. */
509 rightmost_1bit_idx(uint32_t x)
514 /* Returns the index of the leftmost 1-bit in 'x' (e.g. 01011000 => 6), or 32
517 * This function only works with 32-bit integers. */
518 static inline uint32_t
519 leftmost_1bit_idx(uint32_t x)
521 return x ? log_2_floor(x) : 32;
524 /* Return a ovs_be32 prefix in network byte order with 'plen' highest bits set.
525 * Shift with 32 is undefined behavior, but we rather use 64-bit shift than
527 static inline ovs_be32 be32_prefix_mask(int plen)
529 return htonl((uint64_t)UINT32_MAX << (32 - plen));
532 bool is_all_zeros(const void *, size_t);
533 bool is_all_ones(const void *, size_t);
534 void bitwise_copy(const void *src, unsigned int src_len, unsigned int src_ofs,
535 void *dst, unsigned int dst_len, unsigned int dst_ofs,
536 unsigned int n_bits);
537 void bitwise_zero(void *dst_, unsigned int dst_len, unsigned dst_ofs,
538 unsigned int n_bits);
539 void bitwise_one(void *dst_, unsigned int dst_len, unsigned dst_ofs,
540 unsigned int n_bits);
541 bool bitwise_is_all_zeros(const void *, unsigned int len, unsigned int ofs,
542 unsigned int n_bits);
543 unsigned int bitwise_scan(const void *, unsigned int len,
544 bool target, unsigned int start, unsigned int end);
545 int bitwise_rscan(const void *, unsigned int len, bool target,
547 void bitwise_put(uint64_t value,
548 void *dst, unsigned int dst_len, unsigned int dst_ofs,
549 unsigned int n_bits);
550 uint64_t bitwise_get(const void *src, unsigned int src_len,
551 unsigned int src_ofs, unsigned int n_bits);
552 bool bitwise_get_bit(const void *src, unsigned int len, unsigned int ofs);
553 void bitwise_put0(void *dst, unsigned int len, unsigned int ofs);
554 void bitwise_put1(void *dst, unsigned int len, unsigned int ofs);
555 void bitwise_put_bit(void *dst, unsigned int len, unsigned int ofs, bool);
556 void bitwise_toggle_bit(void *dst, unsigned int len, unsigned int ofs);
558 void xsleep(unsigned int seconds);
562 char *ovs_format_message(int error);
563 char *ovs_lasterror_to_string(void);
564 int ftruncate(int fd, off_t length);