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