lib/util.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 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 <stdio.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include "compiler.h"
  28 #include "openvswitch/util.h"
  29
  30 extern char *program_name;
  31
  32 #define __ARRAY_SIZE_NOCHECK(ARRAY) (sizeof(ARRAY) / sizeof((ARRAY)[0]))
  33 #ifdef __GNUC__
  34 /* return 0 for array types, 1 otherwise */
  35 #define __ARRAY_CHECK(ARRAY)                                    \
  36     !__builtin_types_compatible_p(typeof(ARRAY), typeof(&ARRAY[0]))
  37
  38 /* compile-time fail if not array */
  39 #define __ARRAY_FAIL(ARRAY) (sizeof(char[-2*!__ARRAY_CHECK(ARRAY)]))
  40 #define __ARRAY_SIZE(ARRAY)                                     \
  41     __builtin_choose_expr(__ARRAY_CHECK(ARRAY),                 \
  42         __ARRAY_SIZE_NOCHECK(ARRAY), __ARRAY_FAIL(ARRAY))
  43 #else
  44 #define __ARRAY_SIZE(ARRAY) __ARRAY_SIZE_NOCHECK(ARRAY)
  45 #endif
  46
  47
  48 /* This system's cache line size, in bytes.
  49  * Being wrong hurts performance but not correctness. */
  50 #define CACHE_LINE_SIZE 64
  51 BUILD_ASSERT_DECL(IS_POW2(CACHE_LINE_SIZE));
  52
  53 static inline void
  54 ovs_prefetch_range(const void *start, size_t size)
  55 {
  56     const char *addr = (const char *)start;
  57     size_t ofs;
  58
  59     for (ofs = 0; ofs < size; ofs += CACHE_LINE_SIZE) {
  60         OVS_PREFETCH(addr + ofs);
  61     }
  62 }
  63
  64 #ifndef MIN
  65 #define MIN(X, Y) ((X) < (Y) ? (X) : (Y))
  66 #endif
  67
  68 #ifndef MAX
  69 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
  70 #endif
  71
  72 #define OVS_NOT_REACHED() abort()
  73
  74 /* Use "%"PRIuSIZE to format size_t with printf(). */
  75 #ifdef _WIN32
  76 #define PRIdSIZE "Id"
  77 #define PRIiSIZE "Ii"
  78 #define PRIoSIZE "Io"
  79 #define PRIuSIZE "Iu"
  80 #define PRIxSIZE "Ix"
  81 #define PRIXSIZE "IX"
  82 #else
  83 #define PRIdSIZE "zd"
  84 #define PRIiSIZE "zi"
  85 #define PRIoSIZE "zo"
  86 #define PRIuSIZE "zu"
  87 #define PRIxSIZE "zx"
  88 #define PRIXSIZE "zX"
  89 #endif
  90
  91 #ifndef _WIN32
  92 typedef uint32_t HANDLE;
  93 #endif
  94
  95 #ifdef  __cplusplus
  96 extern "C" {
  97 #endif
  98
  99 #define set_program_name(name) \
 100         ovs_set_program_name(name, OVS_PACKAGE_VERSION)
 101
 102 const char *get_subprogram_name(void);
 103     void set_subprogram_name(const char *);
 104
 105 void ovs_print_version(uint8_t min_ofp, uint8_t max_ofp);
 106
 107 OVS_NO_RETURN void out_of_memory(void);
 108 void *xmalloc(size_t) MALLOC_LIKE;
 109 void *xcalloc(size_t, size_t) MALLOC_LIKE;
 110 void *xzalloc(size_t) MALLOC_LIKE;
 111 void *xrealloc(void *, size_t);
 112 void *xmemdup(const void *, size_t) MALLOC_LIKE;
 113 char *xmemdup0(const char *, size_t) MALLOC_LIKE;
 114 char *xstrdup(const char *) MALLOC_LIKE;
 115 char *xasprintf(const char *format, ...) OVS_PRINTF_FORMAT(1, 2) MALLOC_LIKE;
 116 char *xvasprintf(const char *format, va_list) OVS_PRINTF_FORMAT(1, 0) MALLOC_LIKE;
 117 void *x2nrealloc(void *p, size_t *n, size_t s);
 118
 119 void *xmalloc_cacheline(size_t) MALLOC_LIKE;
 120 void *xzalloc_cacheline(size_t) MALLOC_LIKE;
 121 void free_cacheline(void *);
 122
 123 void ovs_strlcpy(char *dst, const char *src, size_t size);
 124 void ovs_strzcpy(char *dst, const char *src, size_t size);
 125
 126 OVS_NO_RETURN void ovs_abort(int err_no, const char *format, ...)
 127     OVS_PRINTF_FORMAT(2, 3);
 128 OVS_NO_RETURN void ovs_abort_valist(int err_no, const char *format, va_list)
 129     OVS_PRINTF_FORMAT(2, 0);
 130 OVS_NO_RETURN void ovs_fatal(int err_no, const char *format, ...)
 131     OVS_PRINTF_FORMAT(2, 3);
 132 OVS_NO_RETURN void ovs_fatal_valist(int err_no, const char *format, va_list)
 133     OVS_PRINTF_FORMAT(2, 0);
 134 void ovs_error(int err_no, const char *format, ...) OVS_PRINTF_FORMAT(2, 3);
 135 void ovs_error_valist(int err_no, const char *format, va_list)
 136     OVS_PRINTF_FORMAT(2, 0);
 137 const char *ovs_retval_to_string(int);
 138 const char *ovs_strerror(int);
 139 void ovs_hex_dump(FILE *, const void *, size_t, uintptr_t offset, bool ascii);
 140
 141 bool str_to_int(const char *, int base, int *);
 142 bool str_to_long(const char *, int base, long *);
 143 bool str_to_llong(const char *, int base, long long *);
 144 bool str_to_uint(const char *, int base, unsigned int *);
 145
 146 bool ovs_scan(const char *s, const char *format, ...) OVS_SCANF_FORMAT(2, 3);
 147 bool ovs_scan_len(const char *s, int *n, const char *format, ...);
 148
 149 bool str_to_double(const char *, double *);
 150
 151 int hexit_value(int c);
 152 uintmax_t hexits_value(const char *s, size_t n, bool *ok);
 153
 154 int parse_int_string(const char *s, uint8_t *valuep, int field_width,
 155                      char **tail);
 156
 157 const char *english_list_delimiter(size_t index, size_t total);
 158
 159 char *get_cwd(void);
 160 #ifndef _WIN32
 161 char *dir_name(const char *file_name);
 162 char *base_name(const char *file_name);
 163 #endif
 164 char *abs_file_name(const char *dir, const char *file_name);
 165
 166 char *follow_symlinks(const char *filename);
 167
 168 void ignore(bool x OVS_UNUSED);
 169 \f
 170 /* Bitwise tests. */
 171
 172 /* Returns the number of trailing 0-bits in 'n'.  Undefined if 'n' == 0. */
 173 #if __GNUC__ >= 4
 174 static inline int
 175 raw_ctz(uint64_t n)
 176 {
 177     /* With GCC 4.7 on 32-bit x86, if a 32-bit integer is passed as 'n', using
 178      * a plain __builtin_ctzll() here always generates an out-of-line function
 179      * call.  The test below helps it to emit a single 'bsf' instruction. */
 180     return (__builtin_constant_p(n <= UINT32_MAX) && n <= UINT32_MAX
 181             ? __builtin_ctz(n)
 182             : __builtin_ctzll(n));
 183 }
 184
 185 static inline int
 186 raw_clz64(uint64_t n)
 187 {
 188     return __builtin_clzll(n);
 189 }
 190 #elif _MSC_VER
 191 static inline int
 192 raw_ctz(uint64_t n)
 193 {
 194 #ifdef _WIN64
 195     unsigned long r = 0;
 196     _BitScanForward64(&r, n);
 197     return r;
 198 #else
 199     unsigned long low = n, high, r = 0;
 200     if (_BitScanForward(&r, low)) {
 201         return r;
 202     }
 203     high = n >> 32;
 204     _BitScanForward(&r, high);
 205     return r + 32;
 206 #endif
 207 }
 208
 209 static inline int
 210 raw_clz64(uint64_t n)
 211 {
 212 #ifdef _WIN64
 213     unsigned long r = 0;
 214     _BitScanReverse64(&r, n);
 215     return 63 - r;
 216 #else
 217     unsigned long low, high = n >> 32, r = 0;
 218     if (_BitScanReverse(&r, high)) {
 219         return 31 - r;
 220     }
 221     low = n;
 222     _BitScanReverse(&r, low);
 223     return 63 - r;
 224 #endif
 225 }
 226 #else
 227 /* Defined in util.c. */
 228 int raw_ctz(uint64_t n);
 229 int raw_clz64(uint64_t n);
 230 #endif
 231
 232 /* Returns the number of trailing 0-bits in 'n', or 32 if 'n' is 0. */
 233 static inline int
 234 ctz32(uint32_t n)
 235 {
 236     return n ? raw_ctz(n) : 32;
 237 }
 238
 239 /* Returns the number of trailing 0-bits in 'n', or 64 if 'n' is 0. */
 240 static inline int
 241 ctz64(uint64_t n)
 242 {
 243     return n ? raw_ctz(n) : 64;
 244 }
 245
 246 /* Returns the number of leading 0-bits in 'n', or 32 if 'n' is 0. */
 247 static inline int
 248 clz32(uint32_t n)
 249 {
 250     return n ? raw_clz64(n) - 32 : 32;
 251 }
 252
 253 /* Returns the number of leading 0-bits in 'n', or 64 if 'n' is 0. */
 254 static inline int
 255 clz64(uint64_t n)
 256 {
 257     return n ? raw_clz64(n) : 64;
 258 }
 259
 260 /* Given a word 'n', calculates floor(log_2('n')).  This is equivalent
 261  * to finding the bit position of the most significant one bit in 'n'.  It is
 262  * an error to call this function with 'n' == 0. */
 263 static inline int
 264 log_2_floor(uint64_t n)
 265 {
 266     return 63 - raw_clz64(n);
 267 }
 268
 269 /* Given a word 'n', calculates ceil(log_2('n')).  It is an error to
 270  * call this function with 'n' == 0. */
 271 static inline int
 272 log_2_ceil(uint64_t n)
 273 {
 274     return log_2_floor(n) + !is_pow2(n);
 275 }
 276
 277 /* unsigned int count_1bits(uint64_t x):
 278  *
 279  * Returns the number of 1-bits in 'x', between 0 and 64 inclusive. */
 280 #if UINTPTR_MAX == UINT64_MAX
 281 static inline unsigned int
 282 count_1bits(uint64_t x)
 283 {
 284 #if __GNUC__ >= 4 && __POPCNT__
 285     return __builtin_popcountll(x);
 286 #else
 287     /* This portable implementation is the fastest one we know of for 64
 288      * bits, and about 3x faster than GCC 4.7 __builtin_popcountll(). */
 289     const uint64_t h55 = UINT64_C(0x5555555555555555);
 290     const uint64_t h33 = UINT64_C(0x3333333333333333);
 291     const uint64_t h0F = UINT64_C(0x0F0F0F0F0F0F0F0F);
 292     const uint64_t h01 = UINT64_C(0x0101010101010101);
 293     x -= (x >> 1) & h55;               /* Count of each 2 bits in-place. */
 294     x = (x & h33) + ((x >> 2) & h33);  /* Count of each 4 bits in-place. */
 295     x = (x + (x >> 4)) & h0F;          /* Count of each 8 bits in-place. */
 296     return (x * h01) >> 56;            /* Sum of all bytes. */
 297 #endif
 298 }
 299 #else /* Not 64-bit. */
 300 #if __GNUC__ >= 4 && __POPCNT__
 301 static inline unsigned int
 302 count_1bits_32__(uint32_t x)
 303 {
 304     return __builtin_popcount(x);
 305 }
 306 #else
 307 #define NEED_COUNT_1BITS_8 1
 308 extern const uint8_t count_1bits_8[256];
 309 static inline unsigned int
 310 count_1bits_32__(uint32_t x)
 311 {
 312     /* This portable implementation is the fastest one we know of for 32 bits,
 313      * and faster than GCC __builtin_popcount(). */
 314     return (count_1bits_8[x & 0xff] +
 315             count_1bits_8[(x >> 8) & 0xff] +
 316             count_1bits_8[(x >> 16) & 0xff] +
 317             count_1bits_8[x >> 24]);
 318 }
 319 #endif
 320 static inline unsigned int
 321 count_1bits(uint64_t x)
 322 {
 323     return count_1bits_32__(x) + count_1bits_32__(x >> 32);
 324 }
 325 #endif
 326
 327 /* Returns the rightmost 1-bit in 'x' (e.g. 01011000 => 00001000), or 0 if 'x'
 328  * is 0. */
 329 static inline uintmax_t
 330 rightmost_1bit(uintmax_t x)
 331 {
 332     return x & -x;
 333 }
 334
 335 /* Returns 'x' with its rightmost 1-bit changed to a zero (e.g. 01011000 =>
 336  * 01010000), or 0 if 'x' is 0. */
 337 static inline uintmax_t
 338 zero_rightmost_1bit(uintmax_t x)
 339 {
 340     return x & (x - 1);
 341 }
 342
 343 /* Returns the index of the rightmost 1-bit in 'x' (e.g. 01011000 => 3), or an
 344  * undefined value if 'x' is 0. */
 345 static inline int
 346 rightmost_1bit_idx(uint64_t x)
 347 {
 348     return ctz64(x);
 349 }
 350
 351 /* Returns the index of the leftmost 1-bit in 'x' (e.g. 01011000 => 6), or an
 352  * undefined value if 'x' is 0. */
 353 static inline uint32_t
 354 leftmost_1bit_idx(uint64_t x)
 355 {
 356     return log_2_floor(x);
 357 }
 358
 359 /* Return a ovs_be32 prefix in network byte order with 'plen' highest bits set.
 360  * Shift with 32 is undefined behavior, but we rather use 64-bit shift than
 361  * compare. */
 362 static inline ovs_be32 be32_prefix_mask(int plen)
 363 {
 364     return htonl((uint64_t)UINT32_MAX << (32 - plen));
 365 }
 366 \f
 367 bool is_all_zeros(const void *, size_t);
 368 bool is_all_ones(const void *, size_t);
 369 void bitwise_copy(const void *src, unsigned int src_len, unsigned int src_ofs,
 370                   void *dst, unsigned int dst_len, unsigned int dst_ofs,
 371                   unsigned int n_bits);
 372 void bitwise_zero(void *dst_, unsigned int dst_len, unsigned dst_ofs,
 373                   unsigned int n_bits);
 374 void bitwise_one(void *dst_, unsigned int dst_len, unsigned dst_ofs,
 375                  unsigned int n_bits);
 376 bool bitwise_is_all_zeros(const void *, unsigned int len, unsigned int ofs,
 377                           unsigned int n_bits);
 378 unsigned int bitwise_scan(const void *, unsigned int len,
 379                           bool target, unsigned int start, unsigned int end);
 380 int bitwise_rscan(const void *, unsigned int len, bool target,
 381                   int start, int end);
 382 void bitwise_put(uint64_t value,
 383                  void *dst, unsigned int dst_len, unsigned int dst_ofs,
 384                  unsigned int n_bits);
 385 uint64_t bitwise_get(const void *src, unsigned int src_len,
 386                      unsigned int src_ofs, unsigned int n_bits);
 387 bool bitwise_get_bit(const void *src, unsigned int len, unsigned int ofs);
 388 void bitwise_put0(void *dst, unsigned int len, unsigned int ofs);
 389 void bitwise_put1(void *dst, unsigned int len, unsigned int ofs);
 390 void bitwise_put_bit(void *dst, unsigned int len, unsigned int ofs, bool);
 391 void bitwise_toggle_bit(void *dst, unsigned int len, unsigned int ofs);
 392
 393 /* Returns non-zero if the parameters have equal value. */
 394 static inline int
 395 ovs_u128_equals(const ovs_u128 a, const ovs_u128 b)
 396 {
 397     return (a.u64.hi == b.u64.hi) && (a.u64.lo == b.u64.lo);
 398 }
 399
 400 /* Returns true if 'val' is 0. */
 401 static inline bool
 402 ovs_u128_is_zero(const ovs_u128 val)
 403 {
 404     return !(val.u64.hi || val.u64.lo);
 405 }
 406
 407 /* Returns true if 'val' is all ones. */
 408 static inline bool
 409 ovs_u128_is_ones(const ovs_u128 val)
 410 {
 411     return ovs_u128_equals(val, OVS_U128_MAX);
 412 }
 413
 414 /* Returns non-zero if the parameters have equal value. */
 415 static inline int
 416 ovs_be128_equals(const ovs_be128 a, const ovs_be128 b)
 417 {
 418     return (a.be64.hi == b.be64.hi) && (a.be64.lo == b.be64.lo);
 419 }
 420
 421 /* Returns true if 'val' is 0. */
 422 static inline bool
 423 ovs_be128_is_zero(const ovs_be128 val)
 424 {
 425     return !(val.be64.hi || val.be64.lo);
 426 }
 427
 428 static inline ovs_u128
 429 ovs_u128_and(const ovs_u128 a, const ovs_u128 b)
 430 {
 431     ovs_u128 dst;
 432
 433     dst.u64.hi = a.u64.hi & b.u64.hi;
 434     dst.u64.lo = a.u64.lo & b.u64.lo;
 435
 436     return dst;
 437 }
 438
 439 void xsleep(unsigned int seconds);
 440
 441 bool is_stdout_a_tty(void);
 442
 443 #ifdef _WIN32
 444 \f
 445 char *ovs_format_message(int error);
 446 char *ovs_lasterror_to_string(void);
 447 int ftruncate(int fd, off_t length);
 448 #endif
 449
 450 #ifdef  __cplusplus
 451 }
 452 #endif
 453
 454 #endif /* util.h */