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 /* Yields the size of MEMBER within STRUCT. */
203 #define MEMBER_SIZEOF(STRUCT, MEMBER) (sizeof(((STRUCT *) NULL)->MEMBER))
205 /* Yields the offset of the end of MEMBER within STRUCT. */
206 #define OFFSETOFEND(STRUCT, MEMBER) \
207 (offsetof(STRUCT, MEMBER) + MEMBER_SIZEOF(STRUCT, MEMBER))
209 /* Given POINTER, the address of the given MEMBER in a STRUCT object, returns
210 the STRUCT object. */
211 #define CONTAINER_OF(POINTER, STRUCT, MEMBER) \
212 ((STRUCT *) (void *) ((char *) (POINTER) - offsetof (STRUCT, MEMBER)))
214 /* Given POINTER, the address of the given MEMBER within an object of the type
215 * that that OBJECT points to, returns OBJECT as an assignment-compatible
216 * pointer type (either the correct pointer type or "void *"). OBJECT must be
219 * This is the same as CONTAINER_OF except that it infers the structure type
220 * from the type of '*OBJECT'. */
221 #define OBJECT_CONTAINING(POINTER, OBJECT, MEMBER) \
222 ((OVS_TYPEOF(OBJECT)) (void *) \
223 ((char *) (POINTER) - OBJECT_OFFSETOF(OBJECT, MEMBER)))
225 /* Given POINTER, the address of the given MEMBER within an object of the type
226 * that that OBJECT points to, assigns the address of the outer object to
227 * OBJECT, which must be an lvalue.
229 * Evaluates to (void) 0 as the result is not to be used. */
230 #define ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER) \
231 ((OBJECT) = OBJECT_CONTAINING(POINTER, OBJECT, MEMBER), (void) 0)
233 /* As explained in the comment above OBJECT_OFFSETOF(), non-GNUC compilers
234 * like MSVC will complain about un-initialized variables if OBJECT
235 * hasn't already been initialized. To prevent such warnings, INIT_CONTAINER()
236 * can be used as a wrapper around ASSIGN_CONTAINER. */
237 #define INIT_CONTAINER(OBJECT, POINTER, MEMBER) \
238 ((OBJECT) = NULL, ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER))
240 /* Given ATTR, and TYPE, cast the ATTR to TYPE by first casting ATTR to
241 * (void *). This is to suppress the alignment warning issued by clang. */
242 #define ALIGNED_CAST(TYPE, ATTR) ((TYPE) (void *) (ATTR))
244 /* Use "%"PRIuSIZE to format size_t with printf(). */
246 #define PRIdSIZE "Id"
247 #define PRIiSIZE "Ii"
248 #define PRIoSIZE "Io"
249 #define PRIuSIZE "Iu"
250 #define PRIxSIZE "Ix"
251 #define PRIXSIZE "IX"
253 #define PRIdSIZE "zd"
254 #define PRIiSIZE "zi"
255 #define PRIoSIZE "zo"
256 #define PRIuSIZE "zu"
257 #define PRIxSIZE "zx"
258 #define PRIXSIZE "zX"
262 typedef uint32_t HANDLE;
269 #define set_program_name(name) \
270 ovs_set_program_name(name, OVS_PACKAGE_VERSION)
272 const char *get_subprogram_name(void);
273 void set_subprogram_name(const char *);
275 void ovs_print_version(uint8_t min_ofp, uint8_t max_ofp);
277 OVS_NO_RETURN void out_of_memory(void);
278 void *xmalloc(size_t) MALLOC_LIKE;
279 void *xcalloc(size_t, size_t) MALLOC_LIKE;
280 void *xzalloc(size_t) MALLOC_LIKE;
281 void *xrealloc(void *, size_t);
282 void *xmemdup(const void *, size_t) MALLOC_LIKE;
283 char *xmemdup0(const char *, size_t) MALLOC_LIKE;
284 char *xstrdup(const char *) MALLOC_LIKE;
285 char *xasprintf(const char *format, ...) OVS_PRINTF_FORMAT(1, 2) MALLOC_LIKE;
286 char *xvasprintf(const char *format, va_list) OVS_PRINTF_FORMAT(1, 0) MALLOC_LIKE;
287 void *x2nrealloc(void *p, size_t *n, size_t s);
289 void *xmalloc_cacheline(size_t) MALLOC_LIKE;
290 void *xzalloc_cacheline(size_t) MALLOC_LIKE;
291 void free_cacheline(void *);
293 void ovs_strlcpy(char *dst, const char *src, size_t size);
294 void ovs_strzcpy(char *dst, const char *src, size_t size);
296 OVS_NO_RETURN void ovs_abort(int err_no, const char *format, ...)
297 OVS_PRINTF_FORMAT(2, 3);
298 OVS_NO_RETURN void ovs_abort_valist(int err_no, const char *format, va_list)
299 OVS_PRINTF_FORMAT(2, 0);
300 OVS_NO_RETURN void ovs_fatal(int err_no, const char *format, ...)
301 OVS_PRINTF_FORMAT(2, 3);
302 OVS_NO_RETURN void ovs_fatal_valist(int err_no, const char *format, va_list)
303 OVS_PRINTF_FORMAT(2, 0);
304 void ovs_error(int err_no, const char *format, ...) OVS_PRINTF_FORMAT(2, 3);
305 void ovs_error_valist(int err_no, const char *format, va_list)
306 OVS_PRINTF_FORMAT(2, 0);
307 const char *ovs_retval_to_string(int);
308 const char *ovs_strerror(int);
309 void ovs_hex_dump(FILE *, const void *, size_t, uintptr_t offset, bool ascii);
311 bool str_to_int(const char *, int base, int *);
312 bool str_to_long(const char *, int base, long *);
313 bool str_to_llong(const char *, int base, long long *);
314 bool str_to_uint(const char *, int base, unsigned int *);
316 bool ovs_scan(const char *s, const char *format, ...) OVS_SCANF_FORMAT(2, 3);
317 bool ovs_scan_len(const char *s, int *n, const char *format, ...);
319 bool str_to_double(const char *, double *);
321 int hexit_value(int c);
322 uintmax_t hexits_value(const char *s, size_t n, bool *ok);
324 int parse_int_string(const char *s, uint8_t *valuep, int field_width,
327 const char *english_list_delimiter(size_t index, size_t total);
331 char *dir_name(const char *file_name);
332 char *base_name(const char *file_name);
334 char *abs_file_name(const char *dir, const char *file_name);
336 char *follow_symlinks(const char *filename);
338 void ignore(bool x OVS_UNUSED);
342 /* Returns the number of trailing 0-bits in 'n'. Undefined if 'n' == 0. */
347 /* With GCC 4.7 on 32-bit x86, if a 32-bit integer is passed as 'n', using
348 * a plain __builtin_ctzll() here always generates an out-of-line function
349 * call. The test below helps it to emit a single 'bsf' instruction. */
350 return (__builtin_constant_p(n <= UINT32_MAX) && n <= UINT32_MAX
352 : __builtin_ctzll(n));
356 raw_clz64(uint64_t n)
358 return __builtin_clzll(n);
366 _BitScanForward64(&r, n);
369 unsigned long low = n, high, r = 0;
370 if (_BitScanForward(&r, low)) {
374 _BitScanForward(&r, high);
380 raw_clz64(uint64_t n)
384 _BitScanReverse64(&r, n);
387 unsigned long low, high = n >> 32, r = 0;
388 if (_BitScanReverse(&r, high)) {
392 _BitScanReverse(&r, low);
397 /* Defined in util.c. */
398 int raw_ctz(uint64_t n);
399 int raw_clz64(uint64_t n);
402 /* Returns the number of trailing 0-bits in 'n', or 32 if 'n' is 0. */
406 return n ? raw_ctz(n) : 32;
409 /* Returns the number of trailing 0-bits in 'n', or 64 if 'n' is 0. */
413 return n ? raw_ctz(n) : 64;
416 /* Returns the number of leading 0-bits in 'n', or 32 if 'n' is 0. */
420 return n ? raw_clz64(n) - 32 : 32;
423 /* Returns the number of leading 0-bits in 'n', or 64 if 'n' is 0. */
427 return n ? raw_clz64(n) : 64;
430 /* Given a word 'n', calculates floor(log_2('n')). This is equivalent
431 * to finding the bit position of the most significant one bit in 'n'. It is
432 * an error to call this function with 'n' == 0. */
434 log_2_floor(uint64_t n)
436 return 63 - raw_clz64(n);
439 /* Given a word 'n', calculates ceil(log_2('n')). It is an error to
440 * call this function with 'n' == 0. */
442 log_2_ceil(uint64_t n)
444 return log_2_floor(n) + !is_pow2(n);
447 /* unsigned int count_1bits(uint64_t x):
449 * Returns the number of 1-bits in 'x', between 0 and 64 inclusive. */
450 #if UINTPTR_MAX == UINT64_MAX
451 static inline unsigned int
452 count_1bits(uint64_t x)
454 #if __GNUC__ >= 4 && __POPCNT__
455 return __builtin_popcountll(x);
457 /* This portable implementation is the fastest one we know of for 64
458 * bits, and about 3x faster than GCC 4.7 __builtin_popcountll(). */
459 const uint64_t h55 = UINT64_C(0x5555555555555555);
460 const uint64_t h33 = UINT64_C(0x3333333333333333);
461 const uint64_t h0F = UINT64_C(0x0F0F0F0F0F0F0F0F);
462 const uint64_t h01 = UINT64_C(0x0101010101010101);
463 x -= (x >> 1) & h55; /* Count of each 2 bits in-place. */
464 x = (x & h33) + ((x >> 2) & h33); /* Count of each 4 bits in-place. */
465 x = (x + (x >> 4)) & h0F; /* Count of each 8 bits in-place. */
466 return (x * h01) >> 56; /* Sum of all bytes. */
469 #else /* Not 64-bit. */
470 #if __GNUC__ >= 4 && __POPCNT__
471 static inline unsigned int
472 count_1bits_32__(uint32_t x)
474 return __builtin_popcount(x);
477 #define NEED_COUNT_1BITS_8 1
478 extern const uint8_t count_1bits_8[256];
479 static inline unsigned int
480 count_1bits_32__(uint32_t x)
482 /* This portable implementation is the fastest one we know of for 32 bits,
483 * and faster than GCC __builtin_popcount(). */
484 return (count_1bits_8[x & 0xff] +
485 count_1bits_8[(x >> 8) & 0xff] +
486 count_1bits_8[(x >> 16) & 0xff] +
487 count_1bits_8[x >> 24]);
490 static inline unsigned int
491 count_1bits(uint64_t x)
493 return count_1bits_32__(x) + count_1bits_32__(x >> 32);
497 /* Returns the rightmost 1-bit in 'x' (e.g. 01011000 => 00001000), or 0 if 'x'
499 static inline uintmax_t
500 rightmost_1bit(uintmax_t x)
505 /* Returns 'x' with its rightmost 1-bit changed to a zero (e.g. 01011000 =>
506 * 01010000), or 0 if 'x' is 0. */
507 static inline uintmax_t
508 zero_rightmost_1bit(uintmax_t x)
513 /* Returns the index of the rightmost 1-bit in 'x' (e.g. 01011000 => 3), or an
514 * undefined value if 'x' is 0. */
516 rightmost_1bit_idx(uint64_t x)
521 /* Returns the index of the leftmost 1-bit in 'x' (e.g. 01011000 => 6), or an
522 * undefined value if 'x' is 0. */
523 static inline uint32_t
524 leftmost_1bit_idx(uint64_t x)
526 return log_2_floor(x);
529 /* Return a ovs_be32 prefix in network byte order with 'plen' highest bits set.
530 * Shift with 32 is undefined behavior, but we rather use 64-bit shift than
532 static inline ovs_be32 be32_prefix_mask(int plen)
534 return htonl((uint64_t)UINT32_MAX << (32 - plen));
537 bool is_all_zeros(const void *, size_t);
538 bool is_all_ones(const void *, size_t);
539 void bitwise_copy(const void *src, unsigned int src_len, unsigned int src_ofs,
540 void *dst, unsigned int dst_len, unsigned int dst_ofs,
541 unsigned int n_bits);
542 void bitwise_zero(void *dst_, unsigned int dst_len, unsigned dst_ofs,
543 unsigned int n_bits);
544 void bitwise_one(void *dst_, unsigned int dst_len, unsigned dst_ofs,
545 unsigned int n_bits);
546 bool bitwise_is_all_zeros(const void *, unsigned int len, unsigned int ofs,
547 unsigned int n_bits);
548 unsigned int bitwise_scan(const void *, unsigned int len,
549 bool target, unsigned int start, unsigned int end);
550 int bitwise_rscan(const void *, unsigned int len, bool target,
552 void bitwise_put(uint64_t value,
553 void *dst, unsigned int dst_len, unsigned int dst_ofs,
554 unsigned int n_bits);
555 uint64_t bitwise_get(const void *src, unsigned int src_len,
556 unsigned int src_ofs, unsigned int n_bits);
557 bool bitwise_get_bit(const void *src, unsigned int len, unsigned int ofs);
558 void bitwise_put0(void *dst, unsigned int len, unsigned int ofs);
559 void bitwise_put1(void *dst, unsigned int len, unsigned int ofs);
560 void bitwise_put_bit(void *dst, unsigned int len, unsigned int ofs, bool);
561 void bitwise_toggle_bit(void *dst, unsigned int len, unsigned int ofs);
563 /* Returns non-zero if the parameters have equal value. */
565 ovs_u128_equals(const ovs_u128 *a, const ovs_u128 *b)
567 return (a->u64.hi == b->u64.hi) && (a->u64.lo == b->u64.lo);
570 /* Returns true if 'val' is 0. */
572 ovs_u128_is_zero(const ovs_u128 *val)
574 return !(val->u64.hi || val->u64.lo);
577 /* Returns true if 'val' is all ones. */
579 ovs_u128_is_ones(const ovs_u128 *val)
581 return ovs_u128_equals(val, &OVS_U128_MAX);
584 /* Returns non-zero if the parameters have equal value. */
586 ovs_be128_equals(const ovs_be128 *a, const ovs_be128 *b)
588 return (a->be64.hi == b->be64.hi) && (a->be64.lo == b->be64.lo);
591 /* Returns true if 'val' is 0. */
593 ovs_be128_is_zero(const ovs_be128 *val)
595 return !(val->be64.hi || val->be64.lo);
598 void xsleep(unsigned int seconds);
602 char *ovs_format_message(int error);
603 char *ovs_lasterror_to_string(void);
604 int ftruncate(int fd, off_t length);