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