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