2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 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 /* This is a void expression that issues a compiler error if POINTER cannot be
83 * compared for equality with the given pointer TYPE. This generally means
84 * that POINTER is a qualified or unqualified TYPE. However,
85 * BUILD_ASSERT_TYPE(POINTER, void *) will accept any pointer to object type,
86 * because any pointer to object can be compared for equality with "void *".
88 * POINTER can be any expression. The use of "sizeof" ensures that the
89 * expression is not actually evaluated, so that any side effects of the
90 * expression do not occur.
92 * The cast to int is present only to suppress an "expression using sizeof
93 * bool" warning from "sparse" (see
94 * http://permalink.gmane.org/gmane.comp.parsers.sparse/2967). */
95 #define BUILD_ASSERT_TYPE(POINTER, TYPE) \
96 ((void) sizeof ((int) ((POINTER) == (TYPE) (POINTER))))
98 /* Casts 'pointer' to 'type' and issues a compiler warning if the cast changes
99 * anything other than an outermost "const" or "volatile" qualifier.
101 * The cast to int is present only to suppress an "expression using sizeof
102 * bool" warning from "sparse" (see
103 * http://permalink.gmane.org/gmane.comp.parsers.sparse/2967). */
104 #define CONST_CAST(TYPE, POINTER) \
105 (BUILD_ASSERT_TYPE(POINTER, TYPE), \
108 extern char *program_name;
110 #define __ARRAY_SIZE_NOCHECK(ARRAY) (sizeof(ARRAY) / sizeof((ARRAY)[0]))
112 /* return 0 for array types, 1 otherwise */
113 #define __ARRAY_CHECK(ARRAY) \
114 !__builtin_types_compatible_p(typeof(ARRAY), typeof(&ARRAY[0]))
116 /* compile-time fail if not array */
117 #define __ARRAY_FAIL(ARRAY) (sizeof(char[-2*!__ARRAY_CHECK(ARRAY)]))
118 #define __ARRAY_SIZE(ARRAY) \
119 __builtin_choose_expr(__ARRAY_CHECK(ARRAY), \
120 __ARRAY_SIZE_NOCHECK(ARRAY), __ARRAY_FAIL(ARRAY))
122 #define __ARRAY_SIZE(ARRAY) __ARRAY_SIZE_NOCHECK(ARRAY)
125 /* Returns the number of elements in ARRAY. */
126 #define ARRAY_SIZE(ARRAY) __ARRAY_SIZE(ARRAY)
128 /* Returns X / Y, rounding up. X must be nonnegative to round correctly. */
129 #define DIV_ROUND_UP(X, Y) (((X) + ((Y) - 1)) / (Y))
131 /* Returns X rounded up to the nearest multiple of Y. */
132 #define ROUND_UP(X, Y) (DIV_ROUND_UP(X, Y) * (Y))
134 /* Returns the least number that, when added to X, yields a multiple of Y. */
135 #define PAD_SIZE(X, Y) (ROUND_UP(X, Y) - (X))
137 /* Returns X rounded down to the nearest multiple of Y. */
138 #define ROUND_DOWN(X, Y) ((X) / (Y) * (Y))
140 /* Returns true if X is a power of 2, otherwise false. */
141 #define IS_POW2(X) ((X) && !((X) & ((X) - 1)))
149 /* Returns X rounded up to a power of 2. X must be a constant expression. */
150 #define ROUND_UP_POW2(X) RUP2__(X)
151 #define RUP2__(X) (RUP2_1(X) + 1)
152 #define RUP2_1(X) (RUP2_2(X) | (RUP2_2(X) >> 16))
153 #define RUP2_2(X) (RUP2_3(X) | (RUP2_3(X) >> 8))
154 #define RUP2_3(X) (RUP2_4(X) | (RUP2_4(X) >> 4))
155 #define RUP2_4(X) (RUP2_5(X) | (RUP2_5(X) >> 2))
156 #define RUP2_5(X) (RUP2_6(X) | (RUP2_6(X) >> 1))
157 #define RUP2_6(X) ((X) - 1)
159 /* Returns X rounded down to a power of 2. X must be a constant expression. */
160 #define ROUND_DOWN_POW2(X) RDP2__(X)
161 #define RDP2__(X) (RDP2_1(X) - (RDP2_1(X) >> 1))
162 #define RDP2_1(X) (RDP2_2(X) | (RDP2_2(X) >> 16))
163 #define RDP2_2(X) (RDP2_3(X) | (RDP2_3(X) >> 8))
164 #define RDP2_3(X) (RDP2_4(X) | (RDP2_4(X) >> 4))
165 #define RDP2_4(X) (RDP2_5(X) | (RDP2_5(X) >> 2))
166 #define RDP2_5(X) ( (X) | ( (X) >> 1))
168 /* This system's cache line size, in bytes.
169 * Being wrong hurts performance but not correctness. */
170 #define CACHE_LINE_SIZE 64
171 BUILD_ASSERT_DECL(IS_POW2(CACHE_LINE_SIZE));
174 ovs_prefetch_range(const void *start, size_t size)
176 const char *addr = (const char *)start;
179 for (ofs = 0; ofs < size; ofs += CACHE_LINE_SIZE) {
180 OVS_PREFETCH(addr + ofs);
185 #define MIN(X, Y) ((X) < (Y) ? (X) : (Y))
189 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
192 #define OVS_NOT_REACHED() abort()
194 /* Given a pointer-typed lvalue OBJECT, expands to a pointer type that may be
195 * assigned to OBJECT. */
197 #define OVS_TYPEOF(OBJECT) typeof(OBJECT)
199 #define OVS_TYPEOF(OBJECT) void *
202 /* Given OBJECT of type pointer-to-structure, expands to the offset of MEMBER
203 * within an instance of the structure.
205 * The GCC-specific version avoids the technicality of undefined behavior if
206 * OBJECT is null, invalid, or not yet initialized. This makes some static
207 * checkers (like Coverity) happier. But the non-GCC version does not actually
208 * dereference any pointer, so it would be surprising for it to cause any
209 * problems in practice.
212 #define OBJECT_OFFSETOF(OBJECT, MEMBER) offsetof(typeof(*(OBJECT)), MEMBER)
214 #define OBJECT_OFFSETOF(OBJECT, MEMBER) \
215 ((char *) &(OBJECT)->MEMBER - (char *) (OBJECT))
218 /* Yields the size of MEMBER within STRUCT. */
219 #define MEMBER_SIZEOF(STRUCT, MEMBER) (sizeof(((STRUCT *) NULL)->MEMBER))
221 /* Yields the offset of the end of MEMBER within STRUCT. */
222 #define OFFSETOFEND(STRUCT, MEMBER) \
223 (offsetof(STRUCT, MEMBER) + MEMBER_SIZEOF(STRUCT, MEMBER))
225 /* Given POINTER, the address of the given MEMBER in a STRUCT object, returns
226 the STRUCT object. */
227 #define CONTAINER_OF(POINTER, STRUCT, MEMBER) \
228 ((STRUCT *) (void *) ((char *) (POINTER) - offsetof (STRUCT, MEMBER)))
230 /* Given POINTER, the address of the given MEMBER within an object of the type
231 * that that OBJECT points to, returns OBJECT as an assignment-compatible
232 * pointer type (either the correct pointer type or "void *"). OBJECT must be
235 * This is the same as CONTAINER_OF except that it infers the structure type
236 * from the type of '*OBJECT'. */
237 #define OBJECT_CONTAINING(POINTER, OBJECT, MEMBER) \
238 ((OVS_TYPEOF(OBJECT)) (void *) \
239 ((char *) (POINTER) - OBJECT_OFFSETOF(OBJECT, MEMBER)))
241 /* Given POINTER, the address of the given MEMBER within an object of the type
242 * that that OBJECT points to, assigns the address of the outer object to
243 * OBJECT, which must be an lvalue.
245 * Evaluates to (void) 0 as the result is not to be used. */
246 #define ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER) \
247 ((OBJECT) = OBJECT_CONTAINING(POINTER, OBJECT, MEMBER), (void) 0)
249 /* As explained in the comment above OBJECT_OFFSETOF(), non-GNUC compilers
250 * like MSVC will complain about un-initialized variables if OBJECT
251 * hasn't already been initialized. To prevent such warnings, INIT_CONTAINER()
252 * can be used as a wrapper around ASSIGN_CONTAINER. */
253 #define INIT_CONTAINER(OBJECT, POINTER, MEMBER) \
254 ((OBJECT) = NULL, ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER))
256 /* Given ATTR, and TYPE, cast the ATTR to TYPE by first casting ATTR to
257 * (void *). This is to suppress the alignment warning issued by clang. */
258 #define ALIGNED_CAST(TYPE, ATTR) ((TYPE) (void *) (ATTR))
260 /* Use "%"PRIuSIZE to format size_t with printf(). */
262 #define PRIdSIZE "Id"
263 #define PRIiSIZE "Ii"
264 #define PRIoSIZE "Io"
265 #define PRIuSIZE "Iu"
266 #define PRIxSIZE "Ix"
267 #define PRIXSIZE "IX"
269 #define PRIdSIZE "zd"
270 #define PRIiSIZE "zi"
271 #define PRIoSIZE "zo"
272 #define PRIuSIZE "zu"
273 #define PRIxSIZE "zx"
274 #define PRIXSIZE "zX"
278 typedef uint32_t HANDLE;
285 #define set_program_name(name) \
286 ovs_set_program_name(name, OVS_PACKAGE_VERSION)
288 const char *get_subprogram_name(void);
289 void set_subprogram_name(const char *);
291 void ovs_print_version(uint8_t min_ofp, uint8_t max_ofp);
293 OVS_NO_RETURN void out_of_memory(void);
294 void *xmalloc(size_t) MALLOC_LIKE;
295 void *xcalloc(size_t, size_t) MALLOC_LIKE;
296 void *xzalloc(size_t) MALLOC_LIKE;
297 void *xrealloc(void *, size_t);
298 void *xmemdup(const void *, size_t) MALLOC_LIKE;
299 char *xmemdup0(const char *, size_t) MALLOC_LIKE;
300 char *xstrdup(const char *) MALLOC_LIKE;
301 char *xasprintf(const char *format, ...) OVS_PRINTF_FORMAT(1, 2) MALLOC_LIKE;
302 char *xvasprintf(const char *format, va_list) OVS_PRINTF_FORMAT(1, 0) MALLOC_LIKE;
303 void *x2nrealloc(void *p, size_t *n, size_t s);
305 void *xmalloc_cacheline(size_t) MALLOC_LIKE;
306 void *xzalloc_cacheline(size_t) MALLOC_LIKE;
307 void free_cacheline(void *);
309 void ovs_strlcpy(char *dst, const char *src, size_t size);
310 void ovs_strzcpy(char *dst, const char *src, size_t size);
312 OVS_NO_RETURN void ovs_abort(int err_no, const char *format, ...)
313 OVS_PRINTF_FORMAT(2, 3);
314 OVS_NO_RETURN void ovs_abort_valist(int err_no, const char *format, va_list)
315 OVS_PRINTF_FORMAT(2, 0);
316 OVS_NO_RETURN void ovs_fatal(int err_no, const char *format, ...)
317 OVS_PRINTF_FORMAT(2, 3);
318 OVS_NO_RETURN void ovs_fatal_valist(int err_no, const char *format, va_list)
319 OVS_PRINTF_FORMAT(2, 0);
320 void ovs_error(int err_no, const char *format, ...) OVS_PRINTF_FORMAT(2, 3);
321 void ovs_error_valist(int err_no, const char *format, va_list)
322 OVS_PRINTF_FORMAT(2, 0);
323 const char *ovs_retval_to_string(int);
324 const char *ovs_strerror(int);
325 void ovs_hex_dump(FILE *, const void *, size_t, uintptr_t offset, bool ascii);
327 bool str_to_int(const char *, int base, int *);
328 bool str_to_long(const char *, int base, long *);
329 bool str_to_llong(const char *, int base, long long *);
330 bool str_to_uint(const char *, int base, unsigned int *);
332 bool ovs_scan(const char *s, const char *format, ...) OVS_SCANF_FORMAT(2, 3);
333 bool ovs_scan_len(const char *s, int *n, const char *format, ...);
335 bool str_to_double(const char *, double *);
337 int hexit_value(int c);
338 uintmax_t hexits_value(const char *s, size_t n, bool *ok);
340 int parse_int_string(const char *s, uint8_t *valuep, int field_width,
343 const char *english_list_delimiter(size_t index, size_t total);
347 char *dir_name(const char *file_name);
348 char *base_name(const char *file_name);
350 char *abs_file_name(const char *dir, const char *file_name);
352 char *follow_symlinks(const char *filename);
354 void ignore(bool x OVS_UNUSED);
358 /* Returns the number of trailing 0-bits in 'n'. Undefined if 'n' == 0. */
363 /* With GCC 4.7 on 32-bit x86, if a 32-bit integer is passed as 'n', using
364 * a plain __builtin_ctzll() here always generates an out-of-line function
365 * call. The test below helps it to emit a single 'bsf' instruction. */
366 return (__builtin_constant_p(n <= UINT32_MAX) && n <= UINT32_MAX
368 : __builtin_ctzll(n));
372 raw_clz64(uint64_t n)
374 return __builtin_clzll(n);
382 _BitScanForward64(&r, n);
385 unsigned long low = n, high, r = 0;
386 if (_BitScanForward(&r, low)) {
390 _BitScanForward(&r, high);
396 raw_clz64(uint64_t n)
400 _BitScanReverse64(&r, n);
403 unsigned long low, high = n >> 32, r = 0;
404 if (_BitScanReverse(&r, high)) {
408 _BitScanReverse(&r, low);
413 /* Defined in util.c. */
414 int raw_ctz(uint64_t n);
415 int raw_clz64(uint64_t n);
418 /* Returns the number of trailing 0-bits in 'n', or 32 if 'n' is 0. */
422 return n ? raw_ctz(n) : 32;
425 /* Returns the number of trailing 0-bits in 'n', or 64 if 'n' is 0. */
429 return n ? raw_ctz(n) : 64;
432 /* Returns the number of leading 0-bits in 'n', or 32 if 'n' is 0. */
436 return n ? raw_clz64(n) - 32 : 32;
439 /* Returns the number of leading 0-bits in 'n', or 64 if 'n' is 0. */
443 return n ? raw_clz64(n) : 64;
446 /* Given a word 'n', calculates floor(log_2('n')). This is equivalent
447 * to finding the bit position of the most significant one bit in 'n'. It is
448 * an error to call this function with 'n' == 0. */
450 log_2_floor(uint64_t n)
452 return 63 - raw_clz64(n);
455 /* Given a word 'n', calculates ceil(log_2('n')). It is an error to
456 * call this function with 'n' == 0. */
458 log_2_ceil(uint64_t n)
460 return log_2_floor(n) + !is_pow2(n);
463 /* unsigned int count_1bits(uint64_t x):
465 * Returns the number of 1-bits in 'x', between 0 and 64 inclusive. */
466 #if UINTPTR_MAX == UINT64_MAX
467 static inline unsigned int
468 count_1bits(uint64_t x)
470 #if __GNUC__ >= 4 && __POPCNT__
471 return __builtin_popcountll(x);
473 /* This portable implementation is the fastest one we know of for 64
474 * bits, and about 3x faster than GCC 4.7 __builtin_popcountll(). */
475 const uint64_t h55 = UINT64_C(0x5555555555555555);
476 const uint64_t h33 = UINT64_C(0x3333333333333333);
477 const uint64_t h0F = UINT64_C(0x0F0F0F0F0F0F0F0F);
478 const uint64_t h01 = UINT64_C(0x0101010101010101);
479 x -= (x >> 1) & h55; /* Count of each 2 bits in-place. */
480 x = (x & h33) + ((x >> 2) & h33); /* Count of each 4 bits in-place. */
481 x = (x + (x >> 4)) & h0F; /* Count of each 8 bits in-place. */
482 return (x * h01) >> 56; /* Sum of all bytes. */
485 #else /* Not 64-bit. */
486 #if __GNUC__ >= 4 && __POPCNT__
487 static inline unsigned int
488 count_1bits_32__(uint32_t x)
490 return __builtin_popcount(x);
493 #define NEED_COUNT_1BITS_8 1
494 extern const uint8_t count_1bits_8[256];
495 static inline unsigned int
496 count_1bits_32__(uint32_t x)
498 /* This portable implementation is the fastest one we know of for 32 bits,
499 * and faster than GCC __builtin_popcount(). */
500 return (count_1bits_8[x & 0xff] +
501 count_1bits_8[(x >> 8) & 0xff] +
502 count_1bits_8[(x >> 16) & 0xff] +
503 count_1bits_8[x >> 24]);
506 static inline unsigned int
507 count_1bits(uint64_t x)
509 return count_1bits_32__(x) + count_1bits_32__(x >> 32);
513 /* Returns the rightmost 1-bit in 'x' (e.g. 01011000 => 00001000), or 0 if 'x'
515 static inline uintmax_t
516 rightmost_1bit(uintmax_t x)
521 /* Returns 'x' with its rightmost 1-bit changed to a zero (e.g. 01011000 =>
522 * 01010000), or 0 if 'x' is 0. */
523 static inline uintmax_t
524 zero_rightmost_1bit(uintmax_t x)
529 /* Returns the index of the rightmost 1-bit in 'x' (e.g. 01011000 => 3), or an
530 * undefined value if 'x' is 0. */
532 rightmost_1bit_idx(uint64_t x)
537 /* Returns the index of the leftmost 1-bit in 'x' (e.g. 01011000 => 6), or an
538 * undefined value if 'x' is 0. */
539 static inline uint32_t
540 leftmost_1bit_idx(uint64_t x)
542 return log_2_floor(x);
545 /* Return a ovs_be32 prefix in network byte order with 'plen' highest bits set.
546 * Shift with 32 is undefined behavior, but we rather use 64-bit shift than
548 static inline ovs_be32 be32_prefix_mask(int plen)
550 return htonl((uint64_t)UINT32_MAX << (32 - plen));
553 bool is_all_zeros(const void *, size_t);
554 bool is_all_ones(const void *, size_t);
555 void bitwise_copy(const void *src, unsigned int src_len, unsigned int src_ofs,
556 void *dst, unsigned int dst_len, unsigned int dst_ofs,
557 unsigned int n_bits);
558 void bitwise_zero(void *dst_, unsigned int dst_len, unsigned dst_ofs,
559 unsigned int n_bits);
560 void bitwise_one(void *dst_, unsigned int dst_len, unsigned dst_ofs,
561 unsigned int n_bits);
562 bool bitwise_is_all_zeros(const void *, unsigned int len, unsigned int ofs,
563 unsigned int n_bits);
564 unsigned int bitwise_scan(const void *, unsigned int len,
565 bool target, unsigned int start, unsigned int end);
566 int bitwise_rscan(const void *, unsigned int len, bool target,
568 void bitwise_put(uint64_t value,
569 void *dst, unsigned int dst_len, unsigned int dst_ofs,
570 unsigned int n_bits);
571 uint64_t bitwise_get(const void *src, unsigned int src_len,
572 unsigned int src_ofs, unsigned int n_bits);
573 bool bitwise_get_bit(const void *src, unsigned int len, unsigned int ofs);
574 void bitwise_put0(void *dst, unsigned int len, unsigned int ofs);
575 void bitwise_put1(void *dst, unsigned int len, unsigned int ofs);
576 void bitwise_put_bit(void *dst, unsigned int len, unsigned int ofs, bool);
577 void bitwise_toggle_bit(void *dst, unsigned int len, unsigned int ofs);
579 /* Returns non-zero if the parameters have equal value. */
581 ovs_u128_equals(const ovs_u128 *a, const ovs_u128 *b)
583 return (a->u64.hi == b->u64.hi) && (a->u64.lo == b->u64.lo);
586 /* Returns true if 'val' is 0. */
588 ovs_u128_is_zero(const ovs_u128 *val)
590 return !(val->u64.hi || val->u64.lo);
593 /* Returns true if 'val' is all ones. */
595 ovs_u128_is_ones(const ovs_u128 *val)
597 return ovs_u128_equals(val, &OVS_U128_MAX);
600 /* Returns non-zero if the parameters have equal value. */
602 ovs_be128_equals(const ovs_be128 *a, const ovs_be128 *b)
604 return (a->be64.hi == b->be64.hi) && (a->be64.lo == b->be64.lo);
607 /* Returns true if 'val' is 0. */
609 ovs_be128_is_zero(const ovs_be128 *val)
611 return !(val->be64.hi || val->be64.lo);
614 void xsleep(unsigned int seconds);
618 char *ovs_format_message(int error);
619 char *ovs_lasterror_to_string(void);
620 int ftruncate(int fd, off_t length);