lib/util.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 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 <inttypes.h>
  21 #include <limits.h>
  22 #include <stdarg.h>
  23 #include <stdbool.h>
  24 #include <stddef.h>
  25 #include <stdint.h>
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include "compiler.h"
  30 #include "openvswitch/types.h"
  31
  32 #ifndef va_copy
  33 #ifdef __va_copy
  34 #define va_copy __va_copy
  35 #else
  36 #define va_copy(dst, src) ((dst) = (src))
  37 #endif
  38 #endif
  39
  40 #ifdef __CHECKER__
  41 #define BUILD_ASSERT(EXPR) ((void) 0)
  42 #define BUILD_ASSERT_DECL(EXPR) extern int (*build_assert(void))[1]
  43 #elif !defined(__cplusplus)
  44 /* Build-time assertion building block. */
  45 #define BUILD_ASSERT__(EXPR) \
  46         sizeof(struct { unsigned int build_assert_failed : (EXPR) ? 1 : -1; })
  47
  48 /* Build-time assertion for use in a statement context. */
  49 #define BUILD_ASSERT(EXPR) (void) BUILD_ASSERT__(EXPR)
  50
  51 /* Build-time assertion for use in a declaration context. */
  52 #define BUILD_ASSERT_DECL(EXPR) \
  53         extern int (*build_assert(void))[BUILD_ASSERT__(EXPR)]
  54 #else /* __cplusplus */
  55 #include <boost/static_assert.hpp>
  56 #define BUILD_ASSERT BOOST_STATIC_ASSERT
  57 #define BUILD_ASSERT_DECL BOOST_STATIC_ASSERT
  58 #endif /* __cplusplus */
  59
  60 #ifdef __GNUC__
  61 #define BUILD_ASSERT_GCCONLY(EXPR) BUILD_ASSERT(EXPR)
  62 #define BUILD_ASSERT_DECL_GCCONLY(EXPR) BUILD_ASSERT_DECL(EXPR)
  63 #else
  64 #define BUILD_ASSERT_GCCONLY(EXPR) ((void) 0)
  65 #define BUILD_ASSERT_DECL_GCCONLY(EXPR) ((void) 0)
  66 #endif
  67
  68 /* Like the standard assert macro, except:
  69  *
  70  *   - Writes the failure message to the log.
  71  *
  72  *   - Not affected by NDEBUG. */
  73 #define ovs_assert(CONDITION)                                           \
  74     if (!OVS_LIKELY(CONDITION)) {                                       \
  75         ovs_assert_failure(SOURCE_LOCATOR, __func__, #CONDITION);       \
  76     }
  77 void ovs_assert_failure(const char *, const char *, const char *) NO_RETURN;
  78
  79 /* Casts 'pointer' to 'type' and issues a compiler warning if the cast changes
  80  * anything other than an outermost "const" or "volatile" qualifier.
  81  *
  82  * The cast to int is present only to suppress an "expression using sizeof
  83  * bool" warning from "sparse" (see
  84  * http://permalink.gmane.org/gmane.comp.parsers.sparse/2967). */
  85 #define CONST_CAST(TYPE, POINTER)                               \
  86     ((void) sizeof ((int) ((POINTER) == (TYPE) (POINTER))),     \
  87      (TYPE) (POINTER))
  88
  89 extern char *program_name;
  90
  91 #define __ARRAY_SIZE_NOCHECK(ARRAY) (sizeof(ARRAY) / sizeof((ARRAY)[0]))
  92 #ifdef __GNUC__
  93 /* return 0 for array types, 1 otherwise */
  94 #define __ARRAY_CHECK(ARRAY)                                    \
  95     !__builtin_types_compatible_p(typeof(ARRAY), typeof(&ARRAY[0]))
  96
  97 /* compile-time fail if not array */
  98 #define __ARRAY_FAIL(ARRAY) (sizeof(char[-2*!__ARRAY_CHECK(ARRAY)]))
  99 #define __ARRAY_SIZE(ARRAY)                                     \
 100     __builtin_choose_expr(__ARRAY_CHECK(ARRAY),                 \
 101         __ARRAY_SIZE_NOCHECK(ARRAY), __ARRAY_FAIL(ARRAY))
 102 #else
 103 #define __ARRAY_SIZE(ARRAY) __ARRAY_SIZE_NOCHECK(ARRAY)
 104 #endif
 105
 106 /* Returns the number of elements in ARRAY. */
 107 #define ARRAY_SIZE(ARRAY) __ARRAY_SIZE(ARRAY)
 108
 109 /* Returns X / Y, rounding up.  X must be nonnegative to round correctly. */
 110 #define DIV_ROUND_UP(X, Y) (((X) + ((Y) - 1)) / (Y))
 111
 112 /* Returns X rounded up to the nearest multiple of Y. */
 113 #define ROUND_UP(X, Y) (DIV_ROUND_UP(X, Y) * (Y))
 114
 115 /* Returns the least number that, when added to X, yields a multiple of Y. */
 116 #define PAD_SIZE(X, Y) (ROUND_UP(X, Y) - (X))
 117
 118 /* Returns X rounded down to the nearest multiple of Y. */
 119 #define ROUND_DOWN(X, Y) ((X) / (Y) * (Y))
 120
 121 /* Returns true if X is a power of 2, otherwise false. */
 122 #define IS_POW2(X) ((X) && !((X) & ((X) - 1)))
 123
 124 static inline bool
 125 is_pow2(uintmax_t x)
 126 {
 127     return IS_POW2(x);
 128 }
 129
 130 /* Returns X rounded up to a power of 2.  X must be a constant expression. */
 131 #define ROUND_UP_POW2(X) RUP2__(X)
 132 #define RUP2__(X) (RUP2_1(X) + 1)
 133 #define RUP2_1(X) (RUP2_2(X) | (RUP2_2(X) >> 16))
 134 #define RUP2_2(X) (RUP2_3(X) | (RUP2_3(X) >> 8))
 135 #define RUP2_3(X) (RUP2_4(X) | (RUP2_4(X) >> 4))
 136 #define RUP2_4(X) (RUP2_5(X) | (RUP2_5(X) >> 2))
 137 #define RUP2_5(X) (RUP2_6(X) | (RUP2_6(X) >> 1))
 138 #define RUP2_6(X) ((X) - 1)
 139
 140 /* Returns X rounded down to a power of 2.  X must be a constant expression. */
 141 #define ROUND_DOWN_POW2(X) RDP2__(X)
 142 #define RDP2__(X) (RDP2_1(X) - (RDP2_1(X) >> 1))
 143 #define RDP2_1(X) (RDP2_2(X) | (RDP2_2(X) >> 16))
 144 #define RDP2_2(X) (RDP2_3(X) | (RDP2_3(X) >> 8))
 145 #define RDP2_3(X) (RDP2_4(X) | (RDP2_4(X) >> 4))
 146 #define RDP2_4(X) (RDP2_5(X) | (RDP2_5(X) >> 2))
 147 #define RDP2_5(X) (      (X) | (      (X) >> 1))
 148
 149 /* This system's cache line size, in bytes.
 150  * Being wrong hurts performance but not correctness. */
 151 #define CACHE_LINE_SIZE 64
 152 BUILD_ASSERT_DECL(IS_POW2(CACHE_LINE_SIZE));
 153
 154 static inline void
 155 ovs_prefetch_range(const void *start, size_t size)
 156 {
 157     const char *addr = (const char *)start;
 158     size_t ofs;
 159
 160     for (ofs = 0; ofs < size; ofs += CACHE_LINE_SIZE) {
 161         OVS_PREFETCH(addr + ofs);
 162     }
 163 }
 164
 165 #ifndef MIN
 166 #define MIN(X, Y) ((X) < (Y) ? (X) : (Y))
 167 #endif
 168
 169 #ifndef MAX
 170 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
 171 #endif
 172
 173 #define OVS_NOT_REACHED() abort()
 174
 175 /* Expands to a string that looks like "<file>:<line>", e.g. "tmp.c:10".
 176  *
 177  * See http://c-faq.com/ansi/stringize.html for an explanation of STRINGIZE and
 178  * STRINGIZE2. */
 179 #define SOURCE_LOCATOR __FILE__ ":" STRINGIZE(__LINE__)
 180 #define STRINGIZE(ARG) STRINGIZE2(ARG)
 181 #define STRINGIZE2(ARG) #ARG
 182
 183 /* Given a pointer-typed lvalue OBJECT, expands to a pointer type that may be
 184  * assigned to OBJECT. */
 185 #ifdef __GNUC__
 186 #define OVS_TYPEOF(OBJECT) typeof(OBJECT)
 187 #else
 188 #define OVS_TYPEOF(OBJECT) void *
 189 #endif
 190
 191 /* Given OBJECT of type pointer-to-structure, expands to the offset of MEMBER
 192  * within an instance of the structure.
 193  *
 194  * The GCC-specific version avoids the technicality of undefined behavior if
 195  * OBJECT is null, invalid, or not yet initialized.  This makes some static
 196  * checkers (like Coverity) happier.  But the non-GCC version does not actually
 197  * dereference any pointer, so it would be surprising for it to cause any
 198  * problems in practice.
 199  */
 200 #ifdef __GNUC__
 201 #define OBJECT_OFFSETOF(OBJECT, MEMBER) offsetof(typeof(*(OBJECT)), MEMBER)
 202 #else
 203 #define OBJECT_OFFSETOF(OBJECT, MEMBER) \
 204     ((char *) &(OBJECT)->MEMBER - (char *) (OBJECT))
 205 #endif
 206
 207 /* Given POINTER, the address of the given MEMBER in a STRUCT object, returns
 208    the STRUCT object. */
 209 #define CONTAINER_OF(POINTER, STRUCT, MEMBER)                           \
 210         ((STRUCT *) (void *) ((char *) (POINTER) - offsetof (STRUCT, MEMBER)))
 211
 212 /* Given POINTER, the address of the given MEMBER within an object of the type
 213  * that that OBJECT points to, returns OBJECT as an assignment-compatible
 214  * pointer type (either the correct pointer type or "void *").  OBJECT must be
 215  * an lvalue.
 216  *
 217  * This is the same as CONTAINER_OF except that it infers the structure type
 218  * from the type of '*OBJECT'. */
 219 #define OBJECT_CONTAINING(POINTER, OBJECT, MEMBER)                      \
 220     ((OVS_TYPEOF(OBJECT)) (void *)                                      \
 221      ((char *) (POINTER) - OBJECT_OFFSETOF(OBJECT, MEMBER)))
 222
 223 /* Given POINTER, the address of the given MEMBER within an object of the type
 224  * that that OBJECT points to, assigns the address of the outer object to
 225  * OBJECT, which must be an lvalue.
 226  *
 227  * Evaluates to (void) 0 as the result is not to be used. */
 228 #define ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER) \
 229     ((OBJECT) = OBJECT_CONTAINING(POINTER, OBJECT, MEMBER), (void) 0)
 230
 231 /* As explained in the comment above OBJECT_OFFSETOF(), non-GNUC compilers
 232  * like MSVC will complain about un-initialized variables if OBJECT
 233  * hasn't already been initialized. To prevent such warnings, INIT_CONTAINER()
 234  * can be used as a wrapper around ASSIGN_CONTAINER. */
 235 #define INIT_CONTAINER(OBJECT, POINTER, MEMBER) \
 236     ((OBJECT) = NULL, ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER))
 237
 238 /* Given ATTR, and TYPE, cast the ATTR to TYPE by first casting ATTR to
 239  * (void *). This is to suppress the alignment warning issued by clang. */
 240 #define ALIGNED_CAST(TYPE, ATTR) ((TYPE) (void *) (ATTR))
 241
 242 /* Use "%"PRIuSIZE to format size_t with printf(). */
 243 #ifdef _WIN32
 244 #define PRIdSIZE "Id"
 245 #define PRIiSIZE "Ii"
 246 #define PRIoSIZE "Io"
 247 #define PRIuSIZE "Iu"
 248 #define PRIxSIZE "Ix"
 249 #define PRIXSIZE "IX"
 250 #else
 251 #define PRIdSIZE "zd"
 252 #define PRIiSIZE "zi"
 253 #define PRIoSIZE "zo"
 254 #define PRIuSIZE "zu"
 255 #define PRIxSIZE "zx"
 256 #define PRIXSIZE "zX"
 257 #endif
 258
 259 #ifndef _WIN32
 260 typedef uint32_t HANDLE;
 261 #endif
 262
 263 #ifdef  __cplusplus
 264 extern "C" {
 265 #endif
 266
 267 void set_program_name__(const char *name, const char *version,
 268                         const char *date, const char *time);
 269 #define set_program_name(name) \
 270         set_program_name__(name, VERSION, __DATE__, __TIME__)
 271
 272 const char *get_subprogram_name(void);
 273 void set_subprogram_name(const char *format, ...) PRINTF_FORMAT(1, 2);
 274
 275 const char *get_program_version(void);
 276 void ovs_print_version(uint8_t min_ofp, uint8_t max_ofp);
 277
 278 void out_of_memory(void) NO_RETURN;
 279 void *xmalloc(size_t) MALLOC_LIKE;
 280 void *xcalloc(size_t, size_t) MALLOC_LIKE;
 281 void *xzalloc(size_t) MALLOC_LIKE;
 282 void *xrealloc(void *, size_t);
 283 void *xmemdup(const void *, size_t) MALLOC_LIKE;
 284 char *xmemdup0(const char *, size_t) MALLOC_LIKE;
 285 char *xstrdup(const char *) MALLOC_LIKE;
 286 char *xasprintf(const char *format, ...) PRINTF_FORMAT(1, 2) MALLOC_LIKE;
 287 char *xvasprintf(const char *format, va_list) PRINTF_FORMAT(1, 0) MALLOC_LIKE;
 288 void *x2nrealloc(void *p, size_t *n, size_t s);
 289
 290 void *xmalloc_cacheline(size_t) MALLOC_LIKE;
 291 void *xzalloc_cacheline(size_t) MALLOC_LIKE;
 292 void free_cacheline(void *);
 293
 294 void ovs_strlcpy(char *dst, const char *src, size_t size);
 295 void ovs_strzcpy(char *dst, const char *src, size_t size);
 296
 297 void ovs_abort(int err_no, const char *format, ...)
 298     PRINTF_FORMAT(2, 3) NO_RETURN;
 299 void ovs_abort_valist(int err_no, const char *format, va_list)
 300     PRINTF_FORMAT(2, 0) NO_RETURN;
 301 void ovs_fatal(int err_no, const char *format, ...)
 302     PRINTF_FORMAT(2, 3) NO_RETURN;
 303 void ovs_fatal_valist(int err_no, const char *format, va_list)
 304     PRINTF_FORMAT(2, 0) NO_RETURN;
 305 void ovs_error(int err_no, const char *format, ...) PRINTF_FORMAT(2, 3);
 306 void ovs_error_valist(int err_no, const char *format, va_list)
 307     PRINTF_FORMAT(2, 0);
 308 const char *ovs_retval_to_string(int);
 309 const char *ovs_strerror(int);
 310 void ovs_hex_dump(FILE *, const void *, size_t, uintptr_t offset, bool ascii);
 311
 312 bool str_to_int(const char *, int base, int *);
 313 bool str_to_long(const char *, int base, long *);
 314 bool str_to_llong(const char *, int base, long long *);
 315 bool str_to_uint(const char *, int base, unsigned int *);
 316
 317 bool ovs_scan(const char *s, const char *format, ...) SCANF_FORMAT(2, 3);
 318
 319 bool str_to_double(const char *, double *);
 320
 321 int hexit_value(int c);
 322 unsigned int hexits_value(const char *s, size_t n, bool *ok);
 323
 324 const char *english_list_delimiter(size_t index, size_t total);
 325
 326 char *get_cwd(void);
 327 #ifndef _WIN32
 328 char *dir_name(const char *file_name);
 329 char *base_name(const char *file_name);
 330 #endif
 331 char *abs_file_name(const char *dir, const char *file_name);
 332
 333 char *follow_symlinks(const char *filename);
 334
 335 void ignore(bool x OVS_UNUSED);
 336 \f
 337 /* Bitwise tests. */
 338
 339 /* Returns the number of trailing 0-bits in 'n'.  Undefined if 'n' == 0. */
 340 #if __GNUC__ >= 4
 341 static inline int
 342 raw_ctz(uint64_t n)
 343 {
 344     /* With GCC 4.7 on 32-bit x86, if a 32-bit integer is passed as 'n', using
 345      * a plain __builtin_ctzll() here always generates an out-of-line function
 346      * call.  The test below helps it to emit a single 'bsf' instruction. */
 347     return (__builtin_constant_p(n <= UINT32_MAX) && n <= UINT32_MAX
 348             ? __builtin_ctz(n)
 349             : __builtin_ctzll(n));
 350 }
 351
 352 static inline int
 353 raw_clz64(uint64_t n)
 354 {
 355     return __builtin_clzll(n);
 356 }
 357 #else
 358 /* Defined in util.c. */
 359 int raw_ctz(uint64_t n);
 360 int raw_clz64(uint64_t n);
 361 #endif
 362
 363 /* Returns the number of trailing 0-bits in 'n', or 32 if 'n' is 0. */
 364 static inline int
 365 ctz32(uint32_t n)
 366 {
 367     return n ? raw_ctz(n) : 32;
 368 }
 369
 370 /* Returns the number of trailing 0-bits in 'n', or 64 if 'n' is 0. */
 371 static inline int
 372 ctz64(uint64_t n)
 373 {
 374     return n ? raw_ctz(n) : 64;
 375 }
 376
 377 /* Returns the number of leading 0-bits in 'n', or 32 if 'n' is 0. */
 378 static inline int
 379 clz32(uint32_t n)
 380 {
 381     return n ? raw_clz64(n) - 32 : 32;
 382 }
 383
 384 /* Returns the number of leading 0-bits in 'n', or 64 if 'n' is 0. */
 385 static inline int
 386 clz64(uint64_t n)
 387 {
 388     return n ? raw_clz64(n) : 64;
 389 }
 390
 391 /* Given a word 'n', calculates floor(log_2('n')).  This is equivalent
 392  * to finding the bit position of the most significant one bit in 'n'.  It is
 393  * an error to call this function with 'n' == 0. */
 394 static inline int
 395 log_2_floor(uint64_t n)
 396 {
 397     return 63 - raw_clz64(n);
 398 }
 399
 400 /* Given a word 'n', calculates ceil(log_2('n')).  It is an error to
 401  * call this function with 'n' == 0. */
 402 static inline int
 403 log_2_ceil(uint64_t n)
 404 {
 405     return log_2_floor(n) + !is_pow2(n);
 406 }
 407
 408 /* unsigned int count_1bits(uint64_t x):
 409  *
 410  * Returns the number of 1-bits in 'x', between 0 and 64 inclusive. */
 411 #if UINTPTR_MAX == UINT64_MAX
 412 static inline unsigned int
 413 count_1bits(uint64_t x)
 414 {
 415 #if __GNUC__ >= 4 && __POPCNT__
 416     return __builtin_popcountll(x);
 417 #else
 418     /* This portable implementation is the fastest one we know of for 64
 419      * bits, and about 3x faster than GCC 4.7 __builtin_popcountll(). */
 420     const uint64_t h55 = UINT64_C(0x5555555555555555);
 421     const uint64_t h33 = UINT64_C(0x3333333333333333);
 422     const uint64_t h0F = UINT64_C(0x0F0F0F0F0F0F0F0F);
 423     const uint64_t h01 = UINT64_C(0x0101010101010101);
 424     x -= (x >> 1) & h55;               /* Count of each 2 bits in-place. */
 425     x = (x & h33) + ((x >> 2) & h33);  /* Count of each 4 bits in-place. */
 426     x = (x + (x >> 4)) & h0F;          /* Count of each 8 bits in-place. */
 427     return (x * h01) >> 56;            /* Sum of all bytes. */
 428 #endif
 429 }
 430 #else /* Not 64-bit. */
 431 #if __GNUC__ >= 4 && __POPCNT__
 432 static inline unsigned int
 433 count_1bits_32__(uint32_t x)
 434 {
 435     return __builtin_popcount(x);
 436 }
 437 #else
 438 #define NEED_COUNT_1BITS_8 1
 439 extern const uint8_t count_1bits_8[256];
 440 static inline unsigned int
 441 count_1bits_32__(uint32_t x)
 442 {
 443     /* This portable implementation is the fastest one we know of for 32 bits,
 444      * and faster than GCC __builtin_popcount(). */
 445     return (count_1bits_8[x & 0xff] +
 446             count_1bits_8[(x >> 8) & 0xff] +
 447             count_1bits_8[(x >> 16) & 0xff] +
 448             count_1bits_8[x >> 24]);
 449 }
 450 #endif
 451 static inline unsigned int
 452 count_1bits(uint64_t x)
 453 {
 454     return count_1bits_32__(x) + count_1bits_32__(x >> 32);
 455 }
 456 #endif
 457
 458 /* Returns the rightmost 1-bit in 'x' (e.g. 01011000 => 00001000), or 0 if 'x'
 459  * is 0. */
 460 static inline uintmax_t
 461 rightmost_1bit(uintmax_t x)
 462 {
 463     return x & -x;
 464 }
 465
 466 /* Returns 'x' with its rightmost 1-bit changed to a zero (e.g. 01011000 =>
 467  * 01010000), or 0 if 'x' is 0. */
 468 static inline uintmax_t
 469 zero_rightmost_1bit(uintmax_t x)
 470 {
 471     return x & (x - 1);
 472 }
 473
 474 /* Returns the index of the rightmost 1-bit in 'x' (e.g. 01011000 => 3), or 32
 475  * if 'x' is 0.
 476  *
 477  * Unlike the other functions for rightmost 1-bits, this function only works
 478  * with 32-bit integers. */
 479 static inline uint32_t
 480 rightmost_1bit_idx(uint32_t x)
 481 {
 482     return ctz32(x);
 483 }
 484
 485 /* Returns the index of the leftmost 1-bit in 'x' (e.g. 01011000 => 6), or 32
 486  * if 'x' is 0.
 487  *
 488  * This function only works with 32-bit integers. */
 489 static inline uint32_t
 490 leftmost_1bit_idx(uint32_t x)
 491 {
 492     return x ? log_2_floor(x) : 32;
 493 }
 494 \f
 495 bool is_all_zeros(const void *, size_t);
 496 bool is_all_ones(const void *, size_t);
 497 void bitwise_copy(const void *src, unsigned int src_len, unsigned int src_ofs,
 498                   void *dst, unsigned int dst_len, unsigned int dst_ofs,
 499                   unsigned int n_bits);
 500 void bitwise_zero(void *dst_, unsigned int dst_len, unsigned dst_ofs,
 501                   unsigned int n_bits);
 502 void bitwise_one(void *dst_, unsigned int dst_len, unsigned dst_ofs,
 503                  unsigned int n_bits);
 504 bool bitwise_is_all_zeros(const void *, unsigned int len, unsigned int ofs,
 505                           unsigned int n_bits);
 506 void bitwise_put(uint64_t value,
 507                  void *dst, unsigned int dst_len, unsigned int dst_ofs,
 508                  unsigned int n_bits);
 509 uint64_t bitwise_get(const void *src, unsigned int src_len,
 510                      unsigned int src_ofs, unsigned int n_bits);
 511
 512 void xsleep(unsigned int seconds);
 513
 514 #ifdef _WIN32
 515 \f
 516 char *ovs_format_message(int error);
 517 char *ovs_lasterror_to_string(void);
 518 int ftruncate(int fd, off_t length);
 519 #endif
 520
 521 #ifdef  __cplusplus
 522 }
 523 #endif
 524
 525 #endif /* util.h */