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 const 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 #define CACHE_LINE_SIZE 64      /* Correct for most CPUs. */
 155
 156 static inline void
 157 ovs_prefetch_range(const void *start, size_t size)
 158 {
 159     const char *addr = (const char *)start;
 160     size_t ofs;
 161
 162     for (ofs = 0; ofs < size; ofs += CACHE_LINE_SIZE) {
 163         OVS_PREFETCH(addr + ofs);
 164     }
 165 }
 166
 167 #ifndef MIN
 168 #define MIN(X, Y) ((X) < (Y) ? (X) : (Y))
 169 #endif
 170
 171 #ifndef MAX
 172 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
 173 #endif
 174
 175 #define OVS_NOT_REACHED() abort()
 176
 177 /* Expands to a string that looks like "<file>:<line>", e.g. "tmp.c:10".
 178  *
 179  * See http://c-faq.com/ansi/stringize.html for an explanation of STRINGIZE and
 180  * STRINGIZE2. */
 181 #define SOURCE_LOCATOR __FILE__ ":" STRINGIZE(__LINE__)
 182 #define STRINGIZE(ARG) STRINGIZE2(ARG)
 183 #define STRINGIZE2(ARG) #ARG
 184
 185 /* Given a pointer-typed lvalue OBJECT, expands to a pointer type that may be
 186  * assigned to OBJECT. */
 187 #ifdef __GNUC__
 188 #define OVS_TYPEOF(OBJECT) typeof(OBJECT)
 189 #else
 190 #define OVS_TYPEOF(OBJECT) void *
 191 #endif
 192
 193 /* Given OBJECT of type pointer-to-structure, expands to the offset of MEMBER
 194  * within an instance of the structure.
 195  *
 196  * The GCC-specific version avoids the technicality of undefined behavior if
 197  * OBJECT is null, invalid, or not yet initialized.  This makes some static
 198  * checkers (like Coverity) happier.  But the non-GCC version does not actually
 199  * dereference any pointer, so it would be surprising for it to cause any
 200  * problems in practice.
 201  */
 202 #ifdef __GNUC__
 203 #define OBJECT_OFFSETOF(OBJECT, MEMBER) offsetof(typeof(*(OBJECT)), MEMBER)
 204 #else
 205 #define OBJECT_OFFSETOF(OBJECT, MEMBER) \
 206     ((char *) &(OBJECT)->MEMBER - (char *) (OBJECT))
 207 #endif
 208
 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)))
 213
 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
 217  * an lvalue.
 218  *
 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)))
 224
 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.
 228  *
 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)
 232
 233 /* Given ATTR, and TYPE, cast the ATTR to TYPE by first casting ATTR to
 234  * (void *). This is to suppress the alignment warning issued by clang. */
 235 #define ALIGNED_CAST(TYPE, ATTR) ((TYPE) (void *) (ATTR))
 236
 237 /* Use "%"PRIuSIZE to format size_t with printf(). */
 238 #ifdef _WIN32
 239 #define PRIdSIZE "Id"
 240 #define PRIiSIZE "Ii"
 241 #define PRIoSIZE "Io"
 242 #define PRIuSIZE "Iu"
 243 #define PRIxSIZE "Ix"
 244 #define PRIXSIZE "IX"
 245 #else
 246 #define PRIdSIZE "zd"
 247 #define PRIiSIZE "zi"
 248 #define PRIoSIZE "zo"
 249 #define PRIuSIZE "zu"
 250 #define PRIxSIZE "zx"
 251 #define PRIXSIZE "zX"
 252 #endif
 253
 254 #ifdef  __cplusplus
 255 extern "C" {
 256 #endif
 257
 258 void set_program_name__(const char *name, const char *version,
 259                         const char *date, const char *time);
 260 #define set_program_name(name) \
 261         set_program_name__(name, VERSION, __DATE__, __TIME__)
 262
 263 const char *get_subprogram_name(void);
 264 void set_subprogram_name(const char *format, ...) PRINTF_FORMAT(1, 2);
 265
 266 const char *get_program_version(void);
 267 void ovs_print_version(uint8_t min_ofp, uint8_t max_ofp);
 268
 269 void out_of_memory(void) NO_RETURN;
 270 void *xmalloc(size_t) MALLOC_LIKE;
 271 void *xcalloc(size_t, size_t) MALLOC_LIKE;
 272 void *xzalloc(size_t) MALLOC_LIKE;
 273 void *xrealloc(void *, size_t);
 274 void *xmemdup(const void *, size_t) MALLOC_LIKE;
 275 char *xmemdup0(const char *, size_t) MALLOC_LIKE;
 276 char *xstrdup(const char *) MALLOC_LIKE;
 277 char *xasprintf(const char *format, ...) PRINTF_FORMAT(1, 2) MALLOC_LIKE;
 278 char *xvasprintf(const char *format, va_list) PRINTF_FORMAT(1, 0) MALLOC_LIKE;
 279 void *x2nrealloc(void *p, size_t *n, size_t s);
 280
 281 void *xmalloc_cacheline(size_t) MALLOC_LIKE;
 282 void *xzalloc_cacheline(size_t) MALLOC_LIKE;
 283 void free_cacheline(void *);
 284
 285 void ovs_strlcpy(char *dst, const char *src, size_t size);
 286 void ovs_strzcpy(char *dst, const char *src, size_t size);
 287
 288 void ovs_abort(int err_no, const char *format, ...)
 289     PRINTF_FORMAT(2, 3) NO_RETURN;
 290 void ovs_abort_valist(int err_no, const char *format, va_list)
 291     PRINTF_FORMAT(2, 0) NO_RETURN;
 292 void ovs_fatal(int err_no, const char *format, ...)
 293     PRINTF_FORMAT(2, 3) NO_RETURN;
 294 void ovs_fatal_valist(int err_no, const char *format, va_list)
 295     PRINTF_FORMAT(2, 0) NO_RETURN;
 296 void ovs_error(int err_no, const char *format, ...) PRINTF_FORMAT(2, 3);
 297 void ovs_error_valist(int err_no, const char *format, va_list)
 298     PRINTF_FORMAT(2, 0);
 299 const char *ovs_retval_to_string(int);
 300 const char *ovs_strerror(int);
 301 void ovs_hex_dump(FILE *, const void *, size_t, uintptr_t offset, bool ascii);
 302
 303 bool str_to_int(const char *, int base, int *);
 304 bool str_to_long(const char *, int base, long *);
 305 bool str_to_llong(const char *, int base, long long *);
 306 bool str_to_uint(const char *, int base, unsigned int *);
 307
 308 bool ovs_scan(const char *s, const char *format, ...) SCANF_FORMAT(2, 3);
 309
 310 bool str_to_double(const char *, double *);
 311
 312 int hexit_value(int c);
 313 unsigned int hexits_value(const char *s, size_t n, bool *ok);
 314
 315 const char *english_list_delimiter(size_t index, size_t total);
 316
 317 char *get_cwd(void);
 318 char *dir_name(const char *file_name);
 319 char *base_name(const char *file_name);
 320 char *abs_file_name(const char *dir, const char *file_name);
 321
 322 char *follow_symlinks(const char *filename);
 323
 324 void ignore(bool x OVS_UNUSED);
 325 \f
 326 /* Bitwise tests. */
 327
 328 /* Returns the number of trailing 0-bits in 'n'.  Undefined if 'n' == 0. */
 329 #if __GNUC__ >= 4
 330 static inline int
 331 raw_ctz(uint64_t n)
 332 {
 333     /* With GCC 4.7 on 32-bit x86, if a 32-bit integer is passed as 'n', using
 334      * a plain __builtin_ctzll() here always generates an out-of-line function
 335      * call.  The test below helps it to emit a single 'bsf' instruction. */
 336     return (__builtin_constant_p(n <= UINT32_MAX) && n <= UINT32_MAX
 337             ? __builtin_ctz(n)
 338             : __builtin_ctzll(n));
 339 }
 340
 341 static inline int
 342 raw_clz64(uint64_t n)
 343 {
 344     return __builtin_clzll(n);
 345 }
 346 #else
 347 /* Defined in util.c. */
 348 int raw_ctz(uint64_t n);
 349 int raw_clz64(uint64_t n);
 350 #endif
 351
 352 /* Returns the number of trailing 0-bits in 'n', or 32 if 'n' is 0. */
 353 static inline int
 354 ctz32(uint32_t n)
 355 {
 356     return n ? raw_ctz(n) : 32;
 357 }
 358
 359 /* Returns the number of trailing 0-bits in 'n', or 64 if 'n' is 0. */
 360 static inline int
 361 ctz64(uint64_t n)
 362 {
 363     return n ? raw_ctz(n) : 64;
 364 }
 365
 366 /* Returns the number of leading 0-bits in 'n', or 32 if 'n' is 0. */
 367 static inline int
 368 clz32(uint32_t n)
 369 {
 370     return n ? raw_clz64(n) - 32 : 32;
 371 }
 372
 373 /* Returns the number of leading 0-bits in 'n', or 64 if 'n' is 0. */
 374 static inline int
 375 clz64(uint64_t n)
 376 {
 377     return n ? raw_clz64(n) : 64;
 378 }
 379
 380 /* Given a word 'n', calculates floor(log_2('n')).  This is equivalent
 381  * to finding the bit position of the most significant one bit in 'n'.  It is
 382  * an error to call this function with 'n' == 0. */
 383 static inline int
 384 log_2_floor(uint64_t n)
 385 {
 386     return 63 - raw_clz64(n);
 387 }
 388
 389 /* Given a word 'n', calculates ceil(log_2('n')).  It is an error to
 390  * call this function with 'n' == 0. */
 391 static inline int
 392 log_2_ceil(uint64_t n)
 393 {
 394     return log_2_floor(n) + !is_pow2(n);
 395 }
 396
 397 /* unsigned int count_1bits(uint64_t x):
 398  *
 399  * Returns the number of 1-bits in 'x', between 0 and 64 inclusive. */
 400 #if UINTPTR_MAX == UINT64_MAX
 401 static inline unsigned int
 402 count_1bits(uint64_t x)
 403 {
 404 #if __GNUC__ >= 4 && __POPCNT__
 405     return __builtin_popcountll(x);
 406 #else
 407     /* This portable implementation is the fastest one we know of for 64
 408      * bits, and about 3x faster than GCC 4.7 __builtin_popcountll(). */
 409     const uint64_t h55 = UINT64_C(0x5555555555555555);
 410     const uint64_t h33 = UINT64_C(0x3333333333333333);
 411     const uint64_t h0F = UINT64_C(0x0F0F0F0F0F0F0F0F);
 412     const uint64_t h01 = UINT64_C(0x0101010101010101);
 413     x -= (x >> 1) & h55;               /* Count of each 2 bits in-place. */
 414     x = (x & h33) + ((x >> 2) & h33);  /* Count of each 4 bits in-place. */
 415     x = (x + (x >> 4)) & h0F;          /* Count of each 8 bits in-place. */
 416     return (x * h01) >> 56;            /* Sum of all bytes. */
 417 #endif
 418 }
 419 #else /* Not 64-bit. */
 420 #if __GNUC__ >= 4 && __POPCNT__
 421 static inline unsigned int
 422 count_1bits_32__(uint32_t x)
 423 {
 424     return __builtin_popcount(x);
 425 }
 426 #else
 427 #define NEED_COUNT_1BITS_8 1
 428 extern const uint8_t count_1bits_8[256];
 429 static inline unsigned int
 430 count_1bits_32__(uint32_t x)
 431 {
 432     /* This portable implementation is the fastest one we know of for 32 bits,
 433      * and faster than GCC __builtin_popcount(). */
 434     return (count_1bits_8[x & 0xff] +
 435             count_1bits_8[(x >> 8) & 0xff] +
 436             count_1bits_8[(x >> 16) & 0xff] +
 437             count_1bits_8[x >> 24]);
 438 }
 439 #endif
 440 static inline unsigned int
 441 count_1bits(uint64_t x)
 442 {
 443     return count_1bits_32__(x) + count_1bits_32__(x >> 32);
 444 }
 445 #endif
 446
 447 /* Returns the rightmost 1-bit in 'x' (e.g. 01011000 => 00001000), or 0 if 'x'
 448  * is 0. */
 449 static inline uintmax_t
 450 rightmost_1bit(uintmax_t x)
 451 {
 452     return x & -x;
 453 }
 454
 455 /* Returns 'x' with its rightmost 1-bit changed to a zero (e.g. 01011000 =>
 456  * 01010000), or 0 if 'x' is 0. */
 457 static inline uintmax_t
 458 zero_rightmost_1bit(uintmax_t x)
 459 {
 460     return x & (x - 1);
 461 }
 462
 463 /* Returns the index of the rightmost 1-bit in 'x' (e.g. 01011000 => 3), or 32
 464  * if 'x' is 0.
 465  *
 466  * Unlike the other functions for rightmost 1-bits, this function only works
 467  * with 32-bit integers. */
 468 static inline uint32_t
 469 rightmost_1bit_idx(uint32_t x)
 470 {
 471     return ctz32(x);
 472 }
 473
 474 /* Returns the index of the leftmost 1-bit in 'x' (e.g. 01011000 => 6), or 32
 475  * if 'x' is 0.
 476  *
 477  * This function only works with 32-bit integers. */
 478 static inline uint32_t
 479 leftmost_1bit_idx(uint32_t x)
 480 {
 481     return x ? log_2_floor(x) : 32;
 482 }
 483 \f
 484 bool is_all_zeros(const uint8_t *, size_t);
 485 bool is_all_ones(const uint8_t *, size_t);
 486 void bitwise_copy(const void *src, unsigned int src_len, unsigned int src_ofs,
 487                   void *dst, unsigned int dst_len, unsigned int dst_ofs,
 488                   unsigned int n_bits);
 489 void bitwise_zero(void *dst_, unsigned int dst_len, unsigned dst_ofs,
 490                   unsigned int n_bits);
 491 void bitwise_one(void *dst_, unsigned int dst_len, unsigned dst_ofs,
 492                  unsigned int n_bits);
 493 bool bitwise_is_all_zeros(const void *, unsigned int len, unsigned int ofs,
 494                           unsigned int n_bits);
 495 void bitwise_put(uint64_t value,
 496                  void *dst, unsigned int dst_len, unsigned int dst_ofs,
 497                  unsigned int n_bits);
 498 uint64_t bitwise_get(const void *src, unsigned int src_len,
 499                      unsigned int src_ofs, unsigned int n_bits);
 500
 501 void xsleep(unsigned int seconds);
 502
 503 #ifdef _WIN32
 504 \f
 505 char *ovs_format_message(int error);
 506 char *ovs_lasterror_to_string(void);
 507 int ftruncate(int fd, off_t length);
 508 #endif
 509
 510 #ifdef  __cplusplus
 511 }
 512 #endif
 513
 514 #endif /* util.h */