lib/util.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
   3  *
   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:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 #ifndef UTIL_H
  18 #define UTIL_H 1
  19
  20 #include <arpa/inet.h>
  21 #include <inttypes.h>
  22 #include <limits.h>
  23 #include <stdarg.h>
  24 #include <stdbool.h>
  25 #include <stddef.h>
  26 #include <stdint.h>
  27 #include <stdio.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30 #include "compiler.h"
  31 #include "openvswitch/types.h"
  32 #include "openvswitch/util.h"
  33
  34 #ifndef va_copy
  35 #ifdef __va_copy
  36 #define va_copy __va_copy
  37 #else
  38 #define va_copy(dst, src) ((dst) = (src))
  39 #endif
  40 #endif
  41
  42 #ifdef __CHECKER__
  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; })
  49
  50 /* Build-time assertion for use in a statement context. */
  51 #define BUILD_ASSERT(EXPR) (void) BUILD_ASSERT__(EXPR)
  52
  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 */
  61
  62 #ifdef __GNUC__
  63 #define BUILD_ASSERT_GCCONLY(EXPR) BUILD_ASSERT(EXPR)
  64 #define BUILD_ASSERT_DECL_GCCONLY(EXPR) BUILD_ASSERT_DECL(EXPR)
  65 #else
  66 #define BUILD_ASSERT_GCCONLY(EXPR) ((void) 0)
  67 #define BUILD_ASSERT_DECL_GCCONLY(EXPR) ((void) 0)
  68 #endif
  69
  70 /* Like the standard assert macro, except writes the failure message to the
  71  * log. */
  72 #ifndef NDEBUG
  73 #define ovs_assert(CONDITION)                                           \
  74     if (!OVS_LIKELY(CONDITION)) {                                       \
  75         ovs_assert_failure(OVS_SOURCE_LOCATOR, __func__, #CONDITION);       \
  76     }
  77 #else
  78 #define ovs_assert(CONDITION) ((void) (CONDITION))
  79 #endif
  80 OVS_NO_RETURN void ovs_assert_failure(const char *, const char *, const char *);
  81
  82 /* Casts 'pointer' to 'type' and issues a compiler warning if the cast changes
  83  * anything other than an outermost "const" or "volatile" qualifier.
  84  *
  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))),     \
  90      (TYPE) (POINTER))
  91
  92 extern char *program_name;
  93
  94 #define __ARRAY_SIZE_NOCHECK(ARRAY) (sizeof(ARRAY) / sizeof((ARRAY)[0]))
  95 #ifdef __GNUC__
  96 /* return 0 for array types, 1 otherwise */
  97 #define __ARRAY_CHECK(ARRAY)                                    \
  98     !__builtin_types_compatible_p(typeof(ARRAY), typeof(&ARRAY[0]))
  99
 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))
 105 #else
 106 #define __ARRAY_SIZE(ARRAY) __ARRAY_SIZE_NOCHECK(ARRAY)
 107 #endif
 108
 109 /* Returns the number of elements in ARRAY. */
 110 #define ARRAY_SIZE(ARRAY) __ARRAY_SIZE(ARRAY)
 111
 112 /* Returns X / Y, rounding up.  X must be nonnegative to round correctly. */
 113 #define DIV_ROUND_UP(X, Y) (((X) + ((Y) - 1)) / (Y))
 114
 115 /* Returns X rounded up to the nearest multiple of Y. */
 116 #define ROUND_UP(X, Y) (DIV_ROUND_UP(X, Y) * (Y))
 117
 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))
 120
 121 /* Returns X rounded down to the nearest multiple of Y. */
 122 #define ROUND_DOWN(X, Y) ((X) / (Y) * (Y))
 123
 124 /* Returns true if X is a power of 2, otherwise false. */
 125 #define IS_POW2(X) ((X) && !((X) & ((X) - 1)))
 126
 127 static inline bool
 128 is_pow2(uintmax_t x)
 129 {
 130     return IS_POW2(x);
 131 }
 132
 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)
 142
 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))
 151
 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));
 156
 157 static inline void
 158 ovs_prefetch_range(const void *start, size_t size)
 159 {
 160     const char *addr = (const char *)start;
 161     size_t ofs;
 162
 163     for (ofs = 0; ofs < size; ofs += CACHE_LINE_SIZE) {
 164         OVS_PREFETCH(addr + ofs);
 165     }
 166 }
 167
 168 #ifndef MIN
 169 #define MIN(X, Y) ((X) < (Y) ? (X) : (Y))
 170 #endif
 171
 172 #ifndef MAX
 173 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
 174 #endif
 175
 176 #define OVS_NOT_REACHED() abort()
 177
 178 /* Given a pointer-typed lvalue OBJECT, expands to a pointer type that may be
 179  * assigned to OBJECT. */
 180 #ifdef __GNUC__
 181 #define OVS_TYPEOF(OBJECT) typeof(OBJECT)
 182 #else
 183 #define OVS_TYPEOF(OBJECT) void *
 184 #endif
 185
 186 /* Given OBJECT of type pointer-to-structure, expands to the offset of MEMBER
 187  * within an instance of the structure.
 188  *
 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.
 194  */
 195 #ifdef __GNUC__
 196 #define OBJECT_OFFSETOF(OBJECT, MEMBER) offsetof(typeof(*(OBJECT)), MEMBER)
 197 #else
 198 #define OBJECT_OFFSETOF(OBJECT, MEMBER) \
 199     ((char *) &(OBJECT)->MEMBER - (char *) (OBJECT))
 200 #endif
 201
 202 /* Yields the size of MEMBER within STRUCT. */
 203 #define MEMBER_SIZEOF(STRUCT, MEMBER) (sizeof(((STRUCT *) NULL)->MEMBER))
 204
 205 /* Given POINTER, the address of the given MEMBER in a STRUCT object, returns
 206    the STRUCT object. */
 207 #define CONTAINER_OF(POINTER, STRUCT, MEMBER)                           \
 208         ((STRUCT *) (void *) ((char *) (POINTER) - offsetof (STRUCT, MEMBER)))
 209
 210 /* Given POINTER, the address of the given MEMBER within an object of the type
 211  * that that OBJECT points to, returns OBJECT as an assignment-compatible
 212  * pointer type (either the correct pointer type or "void *").  OBJECT must be
 213  * an lvalue.
 214  *
 215  * This is the same as CONTAINER_OF except that it infers the structure type
 216  * from the type of '*OBJECT'. */
 217 #define OBJECT_CONTAINING(POINTER, OBJECT, MEMBER)                      \
 218     ((OVS_TYPEOF(OBJECT)) (void *)                                      \
 219      ((char *) (POINTER) - OBJECT_OFFSETOF(OBJECT, MEMBER)))
 220
 221 /* Given POINTER, the address of the given MEMBER within an object of the type
 222  * that that OBJECT points to, assigns the address of the outer object to
 223  * OBJECT, which must be an lvalue.
 224  *
 225  * Evaluates to (void) 0 as the result is not to be used. */
 226 #define ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER) \
 227     ((OBJECT) = OBJECT_CONTAINING(POINTER, OBJECT, MEMBER), (void) 0)
 228
 229 /* As explained in the comment above OBJECT_OFFSETOF(), non-GNUC compilers
 230  * like MSVC will complain about un-initialized variables if OBJECT
 231  * hasn't already been initialized. To prevent such warnings, INIT_CONTAINER()
 232  * can be used as a wrapper around ASSIGN_CONTAINER. */
 233 #define INIT_CONTAINER(OBJECT, POINTER, MEMBER) \
 234     ((OBJECT) = NULL, ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER))
 235
 236 /* Given ATTR, and TYPE, cast the ATTR to TYPE by first casting ATTR to
 237  * (void *). This is to suppress the alignment warning issued by clang. */
 238 #define ALIGNED_CAST(TYPE, ATTR) ((TYPE) (void *) (ATTR))
 239
 240 /* Use "%"PRIuSIZE to format size_t with printf(). */
 241 #ifdef _WIN32
 242 #define PRIdSIZE "Id"
 243 #define PRIiSIZE "Ii"
 244 #define PRIoSIZE "Io"
 245 #define PRIuSIZE "Iu"
 246 #define PRIxSIZE "Ix"
 247 #define PRIXSIZE "IX"
 248 #else
 249 #define PRIdSIZE "zd"
 250 #define PRIiSIZE "zi"
 251 #define PRIoSIZE "zo"
 252 #define PRIuSIZE "zu"
 253 #define PRIxSIZE "zx"
 254 #define PRIXSIZE "zX"
 255 #endif
 256
 257 #ifndef _WIN32
 258 typedef uint32_t HANDLE;
 259 #endif
 260
 261 #ifdef  __cplusplus
 262 extern "C" {
 263 #endif
 264
 265 #define set_program_name(name) \
 266         ovs_set_program_name(name, OVS_PACKAGE_VERSION)
 267
 268 const char *get_subprogram_name(void);
 269     void set_subprogram_name(const char *);
 270
 271 void ovs_print_version(uint8_t min_ofp, uint8_t max_ofp);
 272
 273 OVS_NO_RETURN void out_of_memory(void);
 274 void *xmalloc(size_t) MALLOC_LIKE;
 275 void *xcalloc(size_t, size_t) MALLOC_LIKE;
 276 void *xzalloc(size_t) MALLOC_LIKE;
 277 void *xrealloc(void *, size_t);
 278 void *xmemdup(const void *, size_t) MALLOC_LIKE;
 279 char *xmemdup0(const char *, size_t) MALLOC_LIKE;
 280 char *xstrdup(const char *) MALLOC_LIKE;
 281 char *xasprintf(const char *format, ...) OVS_PRINTF_FORMAT(1, 2) MALLOC_LIKE;
 282 char *xvasprintf(const char *format, va_list) OVS_PRINTF_FORMAT(1, 0) MALLOC_LIKE;
 283 void *x2nrealloc(void *p, size_t *n, size_t s);
 284
 285 void *xmalloc_cacheline(size_t) MALLOC_LIKE;
 286 void *xzalloc_cacheline(size_t) MALLOC_LIKE;
 287 void free_cacheline(void *);
 288
 289 void ovs_strlcpy(char *dst, const char *src, size_t size);
 290 void ovs_strzcpy(char *dst, const char *src, size_t size);
 291
 292 OVS_NO_RETURN void ovs_abort(int err_no, const char *format, ...)
 293     OVS_PRINTF_FORMAT(2, 3);
 294 OVS_NO_RETURN void ovs_abort_valist(int err_no, const char *format, va_list)
 295     OVS_PRINTF_FORMAT(2, 0);
 296 OVS_NO_RETURN void ovs_fatal(int err_no, const char *format, ...)
 297     OVS_PRINTF_FORMAT(2, 3);
 298 OVS_NO_RETURN void ovs_fatal_valist(int err_no, const char *format, va_list)
 299     OVS_PRINTF_FORMAT(2, 0);
 300 void ovs_error(int err_no, const char *format, ...) OVS_PRINTF_FORMAT(2, 3);
 301 void ovs_error_valist(int err_no, const char *format, va_list)
 302     OVS_PRINTF_FORMAT(2, 0);
 303 const char *ovs_retval_to_string(int);
 304 const char *ovs_strerror(int);
 305 void ovs_hex_dump(FILE *, const void *, size_t, uintptr_t offset, bool ascii);
 306
 307 bool str_to_int(const char *, int base, int *);
 308 bool str_to_long(const char *, int base, long *);
 309 bool str_to_llong(const char *, int base, long long *);
 310 bool str_to_uint(const char *, int base, unsigned int *);
 311
 312 bool ovs_scan(const char *s, const char *format, ...) OVS_SCANF_FORMAT(2, 3);
 313 bool ovs_scan_len(const char *s, int *n, const char *format, ...);
 314
 315 bool str_to_double(const char *, double *);
 316
 317 int hexit_value(int c);
 318 uintmax_t hexits_value(const char *s, size_t n, bool *ok);
 319
 320 int parse_int_string(const char *s, uint8_t *valuep, int field_width,
 321                      char **tail);
 322
 323 const char *english_list_delimiter(size_t index, size_t total);
 324
 325 char *get_cwd(void);
 326 #ifndef _WIN32
 327 char *dir_name(const char *file_name);
 328 char *base_name(const char *file_name);
 329 #endif
 330 char *abs_file_name(const char *dir, const char *file_name);
 331
 332 char *follow_symlinks(const char *filename);
 333
 334 void ignore(bool x OVS_UNUSED);
 335 \f
 336 /* Bitwise tests. */
 337
 338 /* Returns the number of trailing 0-bits in 'n'.  Undefined if 'n' == 0. */
 339 #if __GNUC__ >= 4
 340 static inline int
 341 raw_ctz(uint64_t n)
 342 {
 343     /* With GCC 4.7 on 32-bit x86, if a 32-bit integer is passed as 'n', using
 344      * a plain __builtin_ctzll() here always generates an out-of-line function
 345      * call.  The test below helps it to emit a single 'bsf' instruction. */
 346     return (__builtin_constant_p(n <= UINT32_MAX) && n <= UINT32_MAX
 347             ? __builtin_ctz(n)
 348             : __builtin_ctzll(n));
 349 }
 350
 351 static inline int
 352 raw_clz64(uint64_t n)
 353 {
 354     return __builtin_clzll(n);
 355 }
 356 #elif _MSC_VER
 357 static inline int
 358 raw_ctz(uint64_t n)
 359 {
 360 #ifdef _WIN64
 361     unsigned long r = 0;
 362     _BitScanForward64(&r, n);
 363     return r;
 364 #else
 365     unsigned long low = n, high, r = 0;
 366     if (_BitScanForward(&r, low)) {
 367         return r;
 368     }
 369     high = n >> 32;
 370     _BitScanForward(&r, high);
 371     return r + 32;
 372 #endif
 373 }
 374
 375 static inline int
 376 raw_clz64(uint64_t n)
 377 {
 378 #ifdef _WIN64
 379     unsigned long r = 0;
 380     _BitScanReverse64(&r, n);
 381     return 63 - r;
 382 #else
 383     unsigned long low, high = n >> 32, r = 0;
 384     if (_BitScanReverse(&r, high)) {
 385         return 31 - r;
 386     }
 387     low = n;
 388     _BitScanReverse(&r, low);
 389     return 63 - r;
 390 #endif
 391 }
 392 #else
 393 /* Defined in util.c. */
 394 int raw_ctz(uint64_t n);
 395 int raw_clz64(uint64_t n);
 396 #endif
 397
 398 /* Returns the number of trailing 0-bits in 'n', or 32 if 'n' is 0. */
 399 static inline int
 400 ctz32(uint32_t n)
 401 {
 402     return n ? raw_ctz(n) : 32;
 403 }
 404
 405 /* Returns the number of trailing 0-bits in 'n', or 64 if 'n' is 0. */
 406 static inline int
 407 ctz64(uint64_t n)
 408 {
 409     return n ? raw_ctz(n) : 64;
 410 }
 411
 412 /* Returns the number of leading 0-bits in 'n', or 32 if 'n' is 0. */
 413 static inline int
 414 clz32(uint32_t n)
 415 {
 416     return n ? raw_clz64(n) - 32 : 32;
 417 }
 418
 419 /* Returns the number of leading 0-bits in 'n', or 64 if 'n' is 0. */
 420 static inline int
 421 clz64(uint64_t n)
 422 {
 423     return n ? raw_clz64(n) : 64;
 424 }
 425
 426 /* Given a word 'n', calculates floor(log_2('n')).  This is equivalent
 427  * to finding the bit position of the most significant one bit in 'n'.  It is
 428  * an error to call this function with 'n' == 0. */
 429 static inline int
 430 log_2_floor(uint64_t n)
 431 {
 432     return 63 - raw_clz64(n);
 433 }
 434
 435 /* Given a word 'n', calculates ceil(log_2('n')).  It is an error to
 436  * call this function with 'n' == 0. */
 437 static inline int
 438 log_2_ceil(uint64_t n)
 439 {
 440     return log_2_floor(n) + !is_pow2(n);
 441 }
 442
 443 /* unsigned int count_1bits(uint64_t x):
 444  *
 445  * Returns the number of 1-bits in 'x', between 0 and 64 inclusive. */
 446 #if UINTPTR_MAX == UINT64_MAX
 447 static inline unsigned int
 448 count_1bits(uint64_t x)
 449 {
 450 #if __GNUC__ >= 4 && __POPCNT__
 451     return __builtin_popcountll(x);
 452 #else
 453     /* This portable implementation is the fastest one we know of for 64
 454      * bits, and about 3x faster than GCC 4.7 __builtin_popcountll(). */
 455     const uint64_t h55 = UINT64_C(0x5555555555555555);
 456     const uint64_t h33 = UINT64_C(0x3333333333333333);
 457     const uint64_t h0F = UINT64_C(0x0F0F0F0F0F0F0F0F);
 458     const uint64_t h01 = UINT64_C(0x0101010101010101);
 459     x -= (x >> 1) & h55;               /* Count of each 2 bits in-place. */
 460     x = (x & h33) + ((x >> 2) & h33);  /* Count of each 4 bits in-place. */
 461     x = (x + (x >> 4)) & h0F;          /* Count of each 8 bits in-place. */
 462     return (x * h01) >> 56;            /* Sum of all bytes. */
 463 #endif
 464 }
 465 #else /* Not 64-bit. */
 466 #if __GNUC__ >= 4 && __POPCNT__
 467 static inline unsigned int
 468 count_1bits_32__(uint32_t x)
 469 {
 470     return __builtin_popcount(x);
 471 }
 472 #else
 473 #define NEED_COUNT_1BITS_8 1
 474 extern const uint8_t count_1bits_8[256];
 475 static inline unsigned int
 476 count_1bits_32__(uint32_t x)
 477 {
 478     /* This portable implementation is the fastest one we know of for 32 bits,
 479      * and faster than GCC __builtin_popcount(). */
 480     return (count_1bits_8[x & 0xff] +
 481             count_1bits_8[(x >> 8) & 0xff] +
 482             count_1bits_8[(x >> 16) & 0xff] +
 483             count_1bits_8[x >> 24]);
 484 }
 485 #endif
 486 static inline unsigned int
 487 count_1bits(uint64_t x)
 488 {
 489     return count_1bits_32__(x) + count_1bits_32__(x >> 32);
 490 }
 491 #endif
 492
 493 /* Returns the rightmost 1-bit in 'x' (e.g. 01011000 => 00001000), or 0 if 'x'
 494  * is 0. */
 495 static inline uintmax_t
 496 rightmost_1bit(uintmax_t x)
 497 {
 498     return x & -x;
 499 }
 500
 501 /* Returns 'x' with its rightmost 1-bit changed to a zero (e.g. 01011000 =>
 502  * 01010000), or 0 if 'x' is 0. */
 503 static inline uintmax_t
 504 zero_rightmost_1bit(uintmax_t x)
 505 {
 506     return x & (x - 1);
 507 }
 508
 509 /* Returns the index of the rightmost 1-bit in 'x' (e.g. 01011000 => 3), or an
 510  * undefined value if 'x' is 0. */
 511 static inline int
 512 rightmost_1bit_idx(uint64_t x)
 513 {
 514     return ctz64(x);
 515 }
 516
 517 /* Returns the index of the leftmost 1-bit in 'x' (e.g. 01011000 => 6), or an
 518  * undefined value if 'x' is 0. */
 519 static inline uint32_t
 520 leftmost_1bit_idx(uint64_t x)
 521 {
 522     return log_2_floor(x);
 523 }
 524
 525 /* Return a ovs_be32 prefix in network byte order with 'plen' highest bits set.
 526  * Shift with 32 is undefined behavior, but we rather use 64-bit shift than
 527  * compare. */
 528 static inline ovs_be32 be32_prefix_mask(int plen)
 529 {
 530     return htonl((uint64_t)UINT32_MAX << (32 - plen));
 531 }
 532 \f
 533 bool is_all_zeros(const void *, size_t);
 534 bool is_all_ones(const void *, size_t);
 535 void bitwise_copy(const void *src, unsigned int src_len, unsigned int src_ofs,
 536                   void *dst, unsigned int dst_len, unsigned int dst_ofs,
 537                   unsigned int n_bits);
 538 void bitwise_zero(void *dst_, unsigned int dst_len, unsigned dst_ofs,
 539                   unsigned int n_bits);
 540 void bitwise_one(void *dst_, unsigned int dst_len, unsigned dst_ofs,
 541                  unsigned int n_bits);
 542 bool bitwise_is_all_zeros(const void *, unsigned int len, unsigned int ofs,
 543                           unsigned int n_bits);
 544 unsigned int bitwise_scan(const void *, unsigned int len,
 545                           bool target, unsigned int start, unsigned int end);
 546 int bitwise_rscan(const void *, unsigned int len, bool target,
 547                   int start, int end);
 548 void bitwise_put(uint64_t value,
 549                  void *dst, unsigned int dst_len, unsigned int dst_ofs,
 550                  unsigned int n_bits);
 551 uint64_t bitwise_get(const void *src, unsigned int src_len,
 552                      unsigned int src_ofs, unsigned int n_bits);
 553 bool bitwise_get_bit(const void *src, unsigned int len, unsigned int ofs);
 554 void bitwise_put0(void *dst, unsigned int len, unsigned int ofs);
 555 void bitwise_put1(void *dst, unsigned int len, unsigned int ofs);
 556 void bitwise_put_bit(void *dst, unsigned int len, unsigned int ofs, bool);
 557 void bitwise_toggle_bit(void *dst, unsigned int len, unsigned int ofs);
 558
 559 /* Returns non-zero if the parameters have equal value. */
 560 static inline int
 561 ovs_u128_equals(const ovs_u128 *a, const ovs_u128 *b)
 562 {
 563     return (a->u64.hi == b->u64.hi) && (a->u64.lo == b->u64.lo);
 564 }
 565
 566 /* Returns true if 'val' is 0. */
 567 static inline bool
 568 ovs_u128_is_zero(const ovs_u128 *val)
 569 {
 570     return !(val->u64.hi || val->u64.lo);
 571 }
 572
 573 /* Returns true if 'val' is all ones. */
 574 static inline bool
 575 ovs_u128_is_ones(const ovs_u128 *val)
 576 {
 577     return ovs_u128_equals(val, &OVS_U128_MAX);
 578 }
 579
 580 /* Returns non-zero if the parameters have equal value. */
 581 static inline int
 582 ovs_be128_equals(const ovs_be128 *a, const ovs_be128 *b)
 583 {
 584     return (a->be64.hi == b->be64.hi) && (a->be64.lo == b->be64.lo);
 585 }
 586
 587 /* Returns true if 'val' is 0. */
 588 static inline bool
 589 ovs_be128_is_zero(const ovs_be128 *val)
 590 {
 591     return !(val->be64.hi || val->be64.lo);
 592 }
 593
 594 void xsleep(unsigned int seconds);
 595
 596 #ifdef _WIN32
 597 \f
 598 char *ovs_format_message(int error);
 599 char *ovs_lasterror_to_string(void);
 600 int ftruncate(int fd, off_t length);
 601 #endif
 602
 603 #ifdef  __cplusplus
 604 }
 605 #endif
 606
 607 #endif /* util.h */