lib/util.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 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
  30 #ifndef va_copy
  31 #ifdef __va_copy
  32 #define va_copy __va_copy
  33 #else
  34 #define va_copy(dst, src) ((dst) = (src))
  35 #endif
  36 #endif
  37
  38 #ifdef __CHECKER__
  39 #define BUILD_ASSERT(EXPR) ((void) 0)
  40 #define BUILD_ASSERT_DECL(EXPR) extern int (*build_assert(void))[1]
  41 #elif !defined(__cplusplus)
  42 /* Build-time assertion building block. */
  43 #define BUILD_ASSERT__(EXPR) \
  44         sizeof(struct { unsigned int build_assert_failed : (EXPR) ? 1 : -1; })
  45
  46 /* Build-time assertion for use in a statement context. */
  47 #define BUILD_ASSERT(EXPR) (void) BUILD_ASSERT__(EXPR)
  48
  49 /* Build-time assertion for use in a declaration context. */
  50 #define BUILD_ASSERT_DECL(EXPR) \
  51         extern int (*build_assert(void))[BUILD_ASSERT__(EXPR)]
  52 #else /* __cplusplus */
  53 #include <boost/static_assert.hpp>
  54 #define BUILD_ASSERT BOOST_STATIC_ASSERT
  55 #define BUILD_ASSERT_DECL BOOST_STATIC_ASSERT
  56 #endif /* __cplusplus */
  57
  58 #ifdef __GNUC__
  59 #define BUILD_ASSERT_GCCONLY(EXPR) BUILD_ASSERT(EXPR)
  60 #define BUILD_ASSERT_DECL_GCCONLY(EXPR) BUILD_ASSERT_DECL(EXPR)
  61 #else
  62 #define BUILD_ASSERT_GCCONLY(EXPR) ((void) 0)
  63 #define BUILD_ASSERT_DECL_GCCONLY(EXPR) ((void) 0)
  64 #endif
  65
  66 /* Like the standard assert macro, except:
  67  *
  68  *   - Writes the failure message to the log.
  69  *
  70  *   - Not affected by NDEBUG. */
  71 #define ovs_assert(CONDITION)                                           \
  72     if (!OVS_LIKELY(CONDITION)) {                                       \
  73         ovs_assert_failure(SOURCE_LOCATOR, __func__, #CONDITION);       \
  74     }
  75 void ovs_assert_failure(const char *, const char *, const char *) NO_RETURN;
  76
  77 /* Casts 'pointer' to 'type' and issues a compiler warning if the cast changes
  78  * anything other than an outermost "const" or "volatile" qualifier.
  79  *
  80  * The cast to int is present only to suppress an "expression using sizeof
  81  * bool" warning from "sparse" (see
  82  * http://permalink.gmane.org/gmane.comp.parsers.sparse/2967). */
  83 #define CONST_CAST(TYPE, POINTER)                               \
  84     ((void) sizeof ((int) ((POINTER) == (TYPE) (POINTER))),     \
  85      (TYPE) (POINTER))
  86
  87 extern const char *program_name;
  88 extern const char *subprogram_name;
  89
  90 /* Returns the number of elements in ARRAY. */
  91 #define ARRAY_SIZE(ARRAY) (sizeof ARRAY / sizeof *ARRAY)
  92
  93 /* Returns X / Y, rounding up.  X must be nonnegative to round correctly. */
  94 #define DIV_ROUND_UP(X, Y) (((X) + ((Y) - 1)) / (Y))
  95
  96 /* Returns X rounded up to the nearest multiple of Y. */
  97 #define ROUND_UP(X, Y) (DIV_ROUND_UP(X, Y) * (Y))
  98
  99 /* Returns X rounded down to the nearest multiple of Y. */
 100 #define ROUND_DOWN(X, Y) ((X) / (Y) * (Y))
 101
 102 /* Returns true if X is a power of 2, otherwise false. */
 103 #define IS_POW2(X) ((X) && !((X) & ((X) - 1)))
 104
 105 static inline bool
 106 is_pow2(uintmax_t x)
 107 {
 108     return IS_POW2(x);
 109 }
 110
 111 #ifndef MIN
 112 #define MIN(X, Y) ((X) < (Y) ? (X) : (Y))
 113 #endif
 114
 115 #ifndef MAX
 116 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
 117 #endif
 118
 119 #define NOT_REACHED() abort()
 120
 121 /* Expands to a string that looks like "<file>:<line>", e.g. "tmp.c:10".
 122  *
 123  * See http://c-faq.com/ansi/stringize.html for an explanation of STRINGIZE and
 124  * STRINGIZE2. */
 125 #define SOURCE_LOCATOR __FILE__ ":" STRINGIZE(__LINE__)
 126 #define STRINGIZE(ARG) STRINGIZE2(ARG)
 127 #define STRINGIZE2(ARG) #ARG
 128
 129 /* Given a pointer-typed lvalue OBJECT, expands to a pointer type that may be
 130  * assigned to OBJECT. */
 131 #ifdef __GNUC__
 132 #define OVS_TYPEOF(OBJECT) typeof(OBJECT)
 133 #else
 134 #define OVS_TYPEOF(OBJECT) void *
 135 #endif
 136
 137 /* Given OBJECT of type pointer-to-structure, expands to the offset of MEMBER
 138  * within an instance of the structure.
 139  *
 140  * The GCC-specific version avoids the technicality of undefined behavior if
 141  * OBJECT is null, invalid, or not yet initialized.  This makes some static
 142  * checkers (like Coverity) happier.  But the non-GCC version does not actually
 143  * dereference any pointer, so it would be surprising for it to cause any
 144  * problems in practice.
 145  */
 146 #ifdef __GNUC__
 147 #define OBJECT_OFFSETOF(OBJECT, MEMBER) offsetof(typeof(*(OBJECT)), MEMBER)
 148 #else
 149 #define OBJECT_OFFSETOF(OBJECT, MEMBER) \
 150     ((char *) &(OBJECT)->MEMBER - (char *) (OBJECT))
 151 #endif
 152
 153 /* Given POINTER, the address of the given MEMBER in a STRUCT object, returns
 154    the STRUCT object. */
 155 #define CONTAINER_OF(POINTER, STRUCT, MEMBER)                           \
 156         ((STRUCT *) (void *) ((char *) (POINTER) - offsetof (STRUCT, MEMBER)))
 157
 158 /* Given POINTER, the address of the given MEMBER within an object of the type
 159  * that that OBJECT points to, returns OBJECT as an assignment-compatible
 160  * pointer type (either the correct pointer type or "void *").  OBJECT must be
 161  * an lvalue.
 162  *
 163  * This is the same as CONTAINER_OF except that it infers the structure type
 164  * from the type of '*OBJECT'. */
 165 #define OBJECT_CONTAINING(POINTER, OBJECT, MEMBER)                      \
 166     ((OVS_TYPEOF(OBJECT)) (void *)                                      \
 167      ((char *) (POINTER) - OBJECT_OFFSETOF(OBJECT, MEMBER)))
 168
 169 /* Given POINTER, the address of the given MEMBER within an object of the type
 170  * that that OBJECT points to, assigns the address of the outer object to
 171  * OBJECT, which must be an lvalue.
 172  *
 173  * Evaluates to 1. */
 174 #define ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER) \
 175     ((OBJECT) = OBJECT_CONTAINING(POINTER, OBJECT, MEMBER), 1)
 176
 177 #ifdef  __cplusplus
 178 extern "C" {
 179 #endif
 180
 181 void set_program_name__(const char *name, const char *version,
 182                         const char *date, const char *time);
 183 #define set_program_name(name) \
 184         set_program_name__(name, VERSION, __DATE__, __TIME__)
 185
 186 const char *get_program_version(void);
 187 void ovs_print_version(uint8_t min_ofp, uint8_t max_ofp);
 188
 189 void out_of_memory(void) NO_RETURN;
 190 void *xmalloc(size_t) MALLOC_LIKE;
 191 void *xcalloc(size_t, size_t) MALLOC_LIKE;
 192 void *xzalloc(size_t) MALLOC_LIKE;
 193 void *xrealloc(void *, size_t);
 194 void *xmemdup(const void *, size_t) MALLOC_LIKE;
 195 char *xmemdup0(const char *, size_t) MALLOC_LIKE;
 196 char *xstrdup(const char *) MALLOC_LIKE;
 197 char *xasprintf(const char *format, ...) PRINTF_FORMAT(1, 2) MALLOC_LIKE;
 198 char *xvasprintf(const char *format, va_list) PRINTF_FORMAT(1, 0) MALLOC_LIKE;
 199 void *x2nrealloc(void *p, size_t *n, size_t s);
 200
 201 void ovs_strlcpy(char *dst, const char *src, size_t size);
 202 void ovs_strzcpy(char *dst, const char *src, size_t size);
 203
 204 void ovs_abort(int err_no, const char *format, ...)
 205     PRINTF_FORMAT(2, 3) NO_RETURN;
 206 void ovs_abort_valist(int err_no, const char *format, va_list)
 207     PRINTF_FORMAT(2, 0) NO_RETURN;
 208 void ovs_fatal(int err_no, const char *format, ...)
 209     PRINTF_FORMAT(2, 3) NO_RETURN;
 210 void ovs_fatal_valist(int err_no, const char *format, va_list)
 211     PRINTF_FORMAT(2, 0) NO_RETURN;
 212 void ovs_error(int err_no, const char *format, ...) PRINTF_FORMAT(2, 3);
 213 void ovs_error_valist(int err_no, const char *format, va_list)
 214     PRINTF_FORMAT(2, 0);
 215 const char *ovs_retval_to_string(int);
 216 void ovs_hex_dump(FILE *, const void *, size_t, uintptr_t offset, bool ascii);
 217
 218 bool str_to_int(const char *, int base, int *);
 219 bool str_to_long(const char *, int base, long *);
 220 bool str_to_llong(const char *, int base, long long *);
 221 bool str_to_uint(const char *, int base, unsigned int *);
 222 bool str_to_ulong(const char *, int base, unsigned long *);
 223 bool str_to_ullong(const char *, int base, unsigned long long *);
 224
 225 bool str_to_double(const char *, double *);
 226
 227 int hexit_value(int c);
 228 unsigned int hexits_value(const char *s, size_t n, bool *ok);
 229
 230 const char *english_list_delimiter(size_t index, size_t total);
 231
 232 char *get_cwd(void);
 233 char *dir_name(const char *file_name);
 234 char *base_name(const char *file_name);
 235 char *abs_file_name(const char *dir, const char *file_name);
 236
 237 char *xreadlink(const char *filename);
 238 char *follow_symlinks(const char *filename);
 239
 240 void ignore(bool x OVS_UNUSED);
 241 \f
 242 /* Bitwise tests. */
 243
 244 /* Returns the number of trailing 0-bits in 'n'.  Undefined if 'n' == 0.
 245  *
 246  * This compiles to a single machine instruction ("bsf") with GCC on x86. */
 247 #if !defined(UINT_MAX) || !defined(UINT32_MAX)
 248 #error "Someone screwed up the #includes."
 249 #elif __GNUC__ >= 4 && UINT_MAX == UINT32_MAX
 250 static inline int
 251 raw_ctz(uint32_t n)
 252 {
 253     return __builtin_ctz(n);
 254 }
 255 #else
 256 /* Defined in util.c. */
 257 int raw_ctz(uint32_t n);
 258 #endif
 259
 260 /* Returns the number of trailing 0-bits in 'n', or 32 if 'n' is 0. */
 261 static inline int
 262 ctz(uint32_t n)
 263 {
 264     return n ? raw_ctz(n) : 32;
 265 }
 266
 267 int log_2_floor(uint32_t);
 268 int log_2_ceil(uint32_t);
 269 unsigned int popcount(uint32_t);
 270
 271 /* Returns the rightmost 1-bit in 'x' (e.g. 01011000 => 00001000), or 0 if 'x'
 272  * is 0. */
 273 static inline uintmax_t
 274 rightmost_1bit(uintmax_t x)
 275 {
 276     return x & -x;
 277 }
 278
 279 /* Returns 'x' with its rightmost 1-bit changed to a zero (e.g. 01011000 =>
 280  * 01010000), or 0 if 'x' is 0. */
 281 static inline uintmax_t
 282 zero_rightmost_1bit(uintmax_t x)
 283 {
 284     return x & (x - 1);
 285 }
 286
 287 /* Returns the index of the rightmost 1-bit in 'x' (e.g. 01011000 => 3), or 32
 288  * if 'x' is 0.
 289  *
 290  * Unlike the other functions for rightmost 1-bits, this function only works
 291  * with 32-bit integers. */
 292 static inline uint32_t
 293 rightmost_1bit_idx(uint32_t x)
 294 {
 295     return x ? ctz(x) : 32;
 296 }
 297
 298 /* Returns the index of the rightmost 1-bit in 'x' (e.g. 01011000 => 6), or 32
 299  * if 'x' is 0.
 300  *
 301  * This function only works with 32-bit integers. */
 302 static inline uint32_t
 303 leftmost_1bit_idx(uint32_t x)
 304 {
 305     return x ? log_2_floor(x) : 32;
 306 }
 307 \f
 308 bool is_all_zeros(const uint8_t *, size_t);
 309 bool is_all_ones(const uint8_t *, size_t);
 310 void bitwise_copy(const void *src, unsigned int src_len, unsigned int src_ofs,
 311                   void *dst, unsigned int dst_len, unsigned int dst_ofs,
 312                   unsigned int n_bits);
 313 void bitwise_zero(void *dst_, unsigned int dst_len, unsigned dst_ofs,
 314                   unsigned int n_bits);
 315 void bitwise_one(void *dst_, unsigned int dst_len, unsigned dst_ofs,
 316                  unsigned int n_bits);
 317 bool bitwise_is_all_zeros(const void *, unsigned int len, unsigned int ofs,
 318                           unsigned int n_bits);
 319 void bitwise_put(uint64_t value,
 320                  void *dst, unsigned int dst_len, unsigned int dst_ofs,
 321                  unsigned int n_bits);
 322 uint64_t bitwise_get(const void *src, unsigned int src_len,
 323                      unsigned int src_ofs, unsigned int n_bits);
 324
 325 #ifdef  __cplusplus
 326 }
 327 #endif
 328
 329 #endif /* util.h */