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 /* Casts 'pointer' to 'type' and issues a compiler warning if the cast changes
  66  * anything other than an outermost "const" or "volatile" qualifier.
  67  *
  68  * The cast to int is present only to suppress an "expression using sizeof
  69  * bool" warning from "sparse" (see
  70  * http://permalink.gmane.org/gmane.comp.parsers.sparse/2967). */
  71 #define CONST_CAST(TYPE, POINTER)                               \
  72     ((void) sizeof ((int) ((POINTER) == (TYPE) (POINTER))),     \
  73      (TYPE) (POINTER))
  74
  75 extern const char *program_name;
  76 extern const char *subprogram_name;
  77
  78 /* Returns the number of elements in ARRAY. */
  79 #define ARRAY_SIZE(ARRAY) (sizeof ARRAY / sizeof *ARRAY)
  80
  81 /* Returns X / Y, rounding up.  X must be nonnegative to round correctly. */
  82 #define DIV_ROUND_UP(X, Y) (((X) + ((Y) - 1)) / (Y))
  83
  84 /* Returns X rounded up to the nearest multiple of Y. */
  85 #define ROUND_UP(X, Y) (DIV_ROUND_UP(X, Y) * (Y))
  86
  87 /* Returns X rounded down to the nearest multiple of Y. */
  88 #define ROUND_DOWN(X, Y) ((X) / (Y) * (Y))
  89
  90 /* Returns true if X is a power of 2, otherwise false. */
  91 #define IS_POW2(X) ((X) && !((X) & ((X) - 1)))
  92
  93 static inline bool
  94 is_pow2(uintmax_t x)
  95 {
  96     return IS_POW2(x);
  97 }
  98
  99 /* Returns the rightmost 1-bit in 'x' (e.g. 01011000 => 00001000), or 0 if 'x'
 100  * is 0. */
 101 static inline uintmax_t
 102 rightmost_1bit(uintmax_t x)
 103 {
 104     return x & -x;
 105 }
 106
 107 /* Returns 'x' with its rightmost 1-bit changed to a zero (e.g. 01011000 =>
 108  * 01010000), or 0 if 'x' is 0. */
 109 static inline uintmax_t
 110 zero_rightmost_1bit(uintmax_t x)
 111 {
 112     return x & (x - 1);
 113 }
 114
 115 #ifndef MIN
 116 #define MIN(X, Y) ((X) < (Y) ? (X) : (Y))
 117 #endif
 118
 119 #ifndef MAX
 120 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
 121 #endif
 122
 123 #define NOT_REACHED() abort()
 124
 125 /* Expands to a string that looks like "<file>:<line>", e.g. "tmp.c:10".
 126  *
 127  * See http://c-faq.com/ansi/stringize.html for an explanation of STRINGIZE and
 128  * STRINGIZE2. */
 129 #define SOURCE_LOCATOR __FILE__ ":" STRINGIZE(__LINE__)
 130 #define STRINGIZE(ARG) STRINGIZE2(ARG)
 131 #define STRINGIZE2(ARG) #ARG
 132
 133 /* Given a pointer-typed lvalue OBJECT, expands to a pointer type that may be
 134  * assigned to OBJECT. */
 135 #ifdef __GNUC__
 136 #define OVS_TYPEOF(OBJECT) typeof(OBJECT)
 137 #else
 138 #define OVS_TYPEOF(OBJECT) void *
 139 #endif
 140
 141 /* Given OBJECT of type pointer-to-structure, expands to the offset of MEMBER
 142  * within an instance of the structure.
 143  *
 144  * The GCC-specific version avoids the technicality of undefined behavior if
 145  * OBJECT is null, invalid, or not yet initialized.  This makes some static
 146  * checkers (like Coverity) happier.  But the non-GCC version does not actually
 147  * dereference any pointer, so it would be surprising for it to cause any
 148  * problems in practice.
 149  */
 150 #ifdef __GNUC__
 151 #define OBJECT_OFFSETOF(OBJECT, MEMBER) offsetof(typeof(*(OBJECT)), MEMBER)
 152 #else
 153 #define OBJECT_OFFSETOF(OBJECT, MEMBER) \
 154     ((char *) &(OBJECT)->MEMBER - (char *) (OBJECT))
 155 #endif
 156
 157 /* Given POINTER, the address of the given MEMBER in a STRUCT object, returns
 158    the STRUCT object. */
 159 #define CONTAINER_OF(POINTER, STRUCT, MEMBER)                           \
 160         ((STRUCT *) (void *) ((char *) (POINTER) - offsetof (STRUCT, MEMBER)))
 161
 162 /* Given POINTER, the address of the given MEMBER within an object of the type
 163  * that that OBJECT points to, returns OBJECT as an assignment-compatible
 164  * pointer type (either the correct pointer type or "void *").  OBJECT must be
 165  * an lvalue.
 166  *
 167  * This is the same as CONTAINER_OF except that it infers the structure type
 168  * from the type of '*OBJECT'. */
 169 #define OBJECT_CONTAINING(POINTER, OBJECT, MEMBER)                      \
 170     ((OVS_TYPEOF(OBJECT)) (void *)                                      \
 171      ((char *) (POINTER) - OBJECT_OFFSETOF(OBJECT, MEMBER)))
 172
 173 /* Given POINTER, the address of the given MEMBER within an object of the type
 174  * that that OBJECT points to, assigns the address of the outer object to
 175  * OBJECT, which must be an lvalue.
 176  *
 177  * Evaluates to 1. */
 178 #define ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER) \
 179     ((OBJECT) = OBJECT_CONTAINING(POINTER, OBJECT, MEMBER), 1)
 180
 181 #ifdef  __cplusplus
 182 extern "C" {
 183 #endif
 184
 185 void set_program_name__(const char *name, const char *version,
 186                         const char *date, const char *time);
 187 #define set_program_name(name) \
 188         set_program_name__(name, VERSION, __DATE__, __TIME__)
 189
 190 const char *get_program_version(void);
 191 void ovs_print_version(uint8_t min_ofp, uint8_t max_ofp);
 192
 193 void out_of_memory(void) NO_RETURN;
 194 void *xmalloc(size_t) MALLOC_LIKE;
 195 void *xcalloc(size_t, size_t) MALLOC_LIKE;
 196 void *xzalloc(size_t) MALLOC_LIKE;
 197 void *xrealloc(void *, size_t);
 198 void *xmemdup(const void *, size_t) MALLOC_LIKE;
 199 char *xmemdup0(const char *, size_t) MALLOC_LIKE;
 200 char *xstrdup(const char *) MALLOC_LIKE;
 201 char *xasprintf(const char *format, ...) PRINTF_FORMAT(1, 2) MALLOC_LIKE;
 202 char *xvasprintf(const char *format, va_list) PRINTF_FORMAT(1, 0) MALLOC_LIKE;
 203 void *x2nrealloc(void *p, size_t *n, size_t s);
 204
 205 void ovs_strlcpy(char *dst, const char *src, size_t size);
 206 void ovs_strzcpy(char *dst, const char *src, size_t size);
 207
 208 void ovs_abort(int err_no, const char *format, ...)
 209     PRINTF_FORMAT(2, 3) NO_RETURN;
 210 void ovs_abort_valist(int err_no, const char *format, va_list)
 211     PRINTF_FORMAT(2, 0) NO_RETURN;
 212 void ovs_fatal(int err_no, const char *format, ...)
 213     PRINTF_FORMAT(2, 3) NO_RETURN;
 214 void ovs_fatal_valist(int err_no, const char *format, va_list)
 215     PRINTF_FORMAT(2, 0) NO_RETURN;
 216 void ovs_error(int err_no, const char *format, ...) PRINTF_FORMAT(2, 3);
 217 void ovs_error_valist(int err_no, const char *format, va_list)
 218     PRINTF_FORMAT(2, 0);
 219 const char *ovs_retval_to_string(int);
 220 void ovs_hex_dump(FILE *, const void *, size_t, uintptr_t offset, bool ascii);
 221
 222 bool str_to_int(const char *, int base, int *);
 223 bool str_to_long(const char *, int base, long *);
 224 bool str_to_llong(const char *, int base, long long *);
 225 bool str_to_uint(const char *, int base, unsigned int *);
 226 bool str_to_ulong(const char *, int base, unsigned long *);
 227 bool str_to_ullong(const char *, int base, unsigned long long *);
 228
 229 bool str_to_double(const char *, double *);
 230
 231 int hexit_value(int c);
 232 unsigned int hexits_value(const char *s, size_t n, bool *ok);
 233
 234 const char *english_list_delimiter(size_t index, size_t total);
 235
 236 char *get_cwd(void);
 237 char *dir_name(const char *file_name);
 238 char *base_name(const char *file_name);
 239 char *abs_file_name(const char *dir, const char *file_name);
 240
 241 char *xreadlink(const char *filename);
 242 char *follow_symlinks(const char *filename);
 243
 244 void ignore(bool x OVS_UNUSED);
 245 int log_2_floor(uint32_t);
 246 int log_2_ceil(uint32_t);
 247 int ctz(uint32_t);
 248 int popcount(uint32_t);
 249
 250 bool is_all_zeros(const uint8_t *, size_t);
 251 bool is_all_ones(const uint8_t *, size_t);
 252 void bitwise_copy(const void *src, unsigned int src_len, unsigned int src_ofs,
 253                   void *dst, unsigned int dst_len, unsigned int dst_ofs,
 254                   unsigned int n_bits);
 255 void bitwise_zero(void *dst_, unsigned int dst_len, unsigned dst_ofs,
 256                   unsigned int n_bits);
 257 void bitwise_one(void *dst_, unsigned int dst_len, unsigned dst_ofs,
 258                  unsigned int n_bits);
 259 bool bitwise_is_all_zeros(const void *, unsigned int len, unsigned int ofs,
 260                           unsigned int n_bits);
 261 void bitwise_put(uint64_t value,
 262                  void *dst, unsigned int dst_len, unsigned int dst_ofs,
 263                  unsigned int n_bits);
 264 uint64_t bitwise_get(const void *src, unsigned int src_len,
 265                      unsigned int src_ofs, unsigned int n_bits);
 266
 267 #ifdef  __cplusplus
 268 }
 269 #endif
 270
 271 #endif /* util.h */