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 <stdarg.h>
  21 #include <stdbool.h>
  22 #include <stddef.h>
  23 #include <stdint.h>
  24 #include <stdio.h>
  25 #include <string.h>
  26 #include "compiler.h"
  27
  28 #ifndef va_copy
  29 #ifdef __va_copy
  30 #define va_copy __va_copy
  31 #else
  32 #define va_copy(dst, src) ((dst) = (src))
  33 #endif
  34 #endif
  35
  36 #ifdef __CHECKER__
  37 #define BUILD_ASSERT(EXPR) ((void) 0)
  38 #define BUILD_ASSERT_DECL(EXPR) extern int (*build_assert(void))[1]
  39 #elif !defined(__cplusplus)
  40 /* Build-time assertion building block. */
  41 #define BUILD_ASSERT__(EXPR) \
  42         sizeof(struct { unsigned int build_assert_failed : (EXPR) ? 1 : -1; })
  43
  44 /* Build-time assertion for use in a statement context. */
  45 #define BUILD_ASSERT(EXPR) (void) BUILD_ASSERT__(EXPR)
  46
  47 /* Build-time assertion for use in a declaration context. */
  48 #define BUILD_ASSERT_DECL(EXPR) \
  49         extern int (*build_assert(void))[BUILD_ASSERT__(EXPR)]
  50 #else /* __cplusplus */
  51 #include <boost/static_assert.hpp>
  52 #define BUILD_ASSERT BOOST_STATIC_ASSERT
  53 #define BUILD_ASSERT_DECL BOOST_STATIC_ASSERT
  54 #endif /* __cplusplus */
  55
  56 #ifdef __GNUC__
  57 #define BUILD_ASSERT_GCCONLY(EXPR) BUILD_ASSERT(EXPR)
  58 #define BUILD_ASSERT_DECL_GCCONLY(EXPR) BUILD_ASSERT_DECL(EXPR)
  59 #else
  60 #define BUILD_ASSERT_GCCONLY(EXPR) ((void) 0)
  61 #define BUILD_ASSERT_DECL_GCCONLY(EXPR) ((void) 0)
  62 #endif
  63
  64 extern const char *program_name;
  65 extern const char *subprogram_name;
  66
  67 /* Returns the number of elements in ARRAY. */
  68 #define ARRAY_SIZE(ARRAY) (sizeof ARRAY / sizeof *ARRAY)
  69
  70 /* Returns X / Y, rounding up.  X must be nonnegative to round correctly. */
  71 #define DIV_ROUND_UP(X, Y) (((X) + ((Y) - 1)) / (Y))
  72
  73 /* Returns X rounded up to the nearest multiple of Y. */
  74 #define ROUND_UP(X, Y) (DIV_ROUND_UP(X, Y) * (Y))
  75
  76 /* Returns X rounded down to the nearest multiple of Y. */
  77 #define ROUND_DOWN(X, Y) ((X) / (Y) * (Y))
  78
  79 /* Returns true if X is a power of 2, otherwise false. */
  80 #define IS_POW2(X) ((X) && !((X) & ((X) - 1)))
  81
  82 static inline bool
  83 is_pow2(uintmax_t x)
  84 {
  85     return IS_POW2(x);
  86 }
  87
  88 /* Returns the rightmost 1-bit in 'x' (e.g. 01011000 => 00001000), or 0 if 'x'
  89  * is 0. */
  90 static inline uintmax_t
  91 rightmost_1bit(uintmax_t x)
  92 {
  93     return x & -x;
  94 }
  95
  96 #ifndef MIN
  97 #define MIN(X, Y) ((X) < (Y) ? (X) : (Y))
  98 #endif
  99
 100 #ifndef MAX
 101 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
 102 #endif
 103
 104 #define NOT_REACHED() abort()
 105
 106 /* Expands to a string that looks like "<file>:<line>", e.g. "tmp.c:10".
 107  *
 108  * See http://c-faq.com/ansi/stringize.html for an explanation of STRINGIZE and
 109  * STRINGIZE2. */
 110 #define SOURCE_LOCATOR __FILE__ ":" STRINGIZE(__LINE__)
 111 #define STRINGIZE(ARG) STRINGIZE2(ARG)
 112 #define STRINGIZE2(ARG) #ARG
 113
 114 /* Given a pointer-typed lvalue OBJECT, expands to a pointer type that may be
 115  * assigned to OBJECT. */
 116 #ifdef __GNUC__
 117 #define OVS_TYPEOF(OBJECT) typeof(OBJECT)
 118 #else
 119 #define OVS_TYPEOF(OBJECT) void *
 120 #endif
 121
 122 /* Given OBJECT of type pointer-to-structure, expands to the offset of MEMBER
 123  * within an instance of the structure.
 124  *
 125  * The GCC-specific version avoids the technicality of undefined behavior if
 126  * OBJECT is null, invalid, or not yet initialized.  This makes some static
 127  * checkers (like Coverity) happier.  But the non-GCC version does not actually
 128  * dereference any pointer, so it would be surprising for it to cause any
 129  * problems in practice.
 130  */
 131 #ifdef __GNUC__
 132 #define OBJECT_OFFSETOF(OBJECT, MEMBER) offsetof(typeof(*(OBJECT)), MEMBER)
 133 #else
 134 #define OBJECT_OFFSETOF(OBJECT, MEMBER) \
 135     ((char *) &(OBJECT)->MEMBER - (char *) (OBJECT))
 136 #endif
 137
 138 /* Given POINTER, the address of the given MEMBER in a STRUCT object, returns
 139    the STRUCT object. */
 140 #define CONTAINER_OF(POINTER, STRUCT, MEMBER)                           \
 141         ((STRUCT *) (void *) ((char *) (POINTER) - offsetof (STRUCT, MEMBER)))
 142
 143 /* Given POINTER, the address of the given MEMBER within an object of the type
 144  * that that OBJECT points to, returns OBJECT as an assignment-compatible
 145  * pointer type (either the correct pointer type or "void *").  OBJECT must be
 146  * an lvalue.
 147  *
 148  * This is the same as CONTAINER_OF except that it infers the structure type
 149  * from the type of '*OBJECT'. */
 150 #define OBJECT_CONTAINING(POINTER, OBJECT, MEMBER)                      \
 151     ((OVS_TYPEOF(OBJECT)) (void *)                                      \
 152      ((char *) (POINTER) - OBJECT_OFFSETOF(OBJECT, MEMBER)))
 153
 154 /* Given POINTER, the address of the given MEMBER within an object of the type
 155  * that that OBJECT points to, assigns the address of the outer object to
 156  * OBJECT, which must be an lvalue.
 157  *
 158  * Evaluates to 1. */
 159 #define ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER) \
 160     ((OBJECT) = OBJECT_CONTAINING(POINTER, OBJECT, MEMBER), 1)
 161
 162 #ifdef  __cplusplus
 163 extern "C" {
 164 #endif
 165
 166 void set_program_name__(const char *name, const char *version,
 167                         const char *date, const char *time);
 168 #define set_program_name(name) \
 169         set_program_name__(name, VERSION, __DATE__, __TIME__)
 170
 171 const char *get_program_version(void);
 172 void ovs_print_version(uint8_t min_ofp, uint8_t max_ofp);
 173
 174 void out_of_memory(void) NO_RETURN;
 175 void *xmalloc(size_t) MALLOC_LIKE;
 176 void *xcalloc(size_t, size_t) MALLOC_LIKE;
 177 void *xzalloc(size_t) MALLOC_LIKE;
 178 void *xrealloc(void *, size_t);
 179 void *xmemdup(const void *, size_t) MALLOC_LIKE;
 180 char *xmemdup0(const char *, size_t) MALLOC_LIKE;
 181 char *xstrdup(const char *) MALLOC_LIKE;
 182 char *xasprintf(const char *format, ...) PRINTF_FORMAT(1, 2) MALLOC_LIKE;
 183 char *xvasprintf(const char *format, va_list) PRINTF_FORMAT(1, 0) MALLOC_LIKE;
 184 void *x2nrealloc(void *p, size_t *n, size_t s);
 185
 186 void ovs_strlcpy(char *dst, const char *src, size_t size);
 187 void ovs_strzcpy(char *dst, const char *src, size_t size);
 188
 189 void ovs_abort(int err_no, const char *format, ...)
 190     PRINTF_FORMAT(2, 3) NO_RETURN;
 191 void ovs_abort_valist(int err_no, const char *format, va_list)
 192     PRINTF_FORMAT(2, 0) NO_RETURN;
 193 void ovs_fatal(int err_no, const char *format, ...)
 194     PRINTF_FORMAT(2, 3) NO_RETURN;
 195 void ovs_fatal_valist(int err_no, const char *format, va_list)
 196     PRINTF_FORMAT(2, 0) NO_RETURN;
 197 void ovs_error(int err_no, const char *format, ...) PRINTF_FORMAT(2, 3);
 198 void ovs_error_valist(int err_no, const char *format, va_list)
 199     PRINTF_FORMAT(2, 0);
 200 const char *ovs_retval_to_string(int);
 201 void ovs_hex_dump(FILE *, const void *, size_t, uintptr_t offset, bool ascii);
 202
 203 bool str_to_int(const char *, int base, int *);
 204 bool str_to_long(const char *, int base, long *);
 205 bool str_to_llong(const char *, int base, long long *);
 206 bool str_to_uint(const char *, int base, unsigned int *);
 207 bool str_to_ulong(const char *, int base, unsigned long *);
 208 bool str_to_ullong(const char *, int base, unsigned long long *);
 209
 210 bool str_to_double(const char *, double *);
 211
 212 int hexit_value(int c);
 213 unsigned int hexits_value(const char *s, size_t n, bool *ok);
 214
 215 const char *english_list_delimiter(size_t index, size_t total);
 216
 217 char *get_cwd(void);
 218 char *dir_name(const char *file_name);
 219 char *base_name(const char *file_name);
 220 char *abs_file_name(const char *dir, const char *file_name);
 221
 222 void ignore(bool x OVS_UNUSED);
 223 int log_2_floor(uint32_t);
 224 int log_2_ceil(uint32_t);
 225 int ctz(uint32_t);
 226
 227 bool is_all_zeros(const uint8_t *, size_t);
 228 bool is_all_ones(const uint8_t *, size_t);
 229 void bitwise_copy(const void *src, unsigned int src_len, unsigned int src_ofs,
 230                   void *dst, unsigned int dst_len, unsigned int dst_ofs,
 231                   unsigned int n_bits);
 232 void bitwise_zero(void *dst_, unsigned int dst_len, unsigned dst_ofs,
 233                   unsigned int n_bits);
 234 void bitwise_one(void *dst_, unsigned int dst_len, unsigned dst_ofs,
 235                  unsigned int n_bits);
 236 bool bitwise_is_all_zeros(const void *, unsigned int len, unsigned int ofs,
 237                           unsigned int n_bits);
 238 void bitwise_put(uint64_t value,
 239                  void *dst, unsigned int dst_len, unsigned int dst_ofs,
 240                  unsigned int n_bits);
 241 uint64_t bitwise_get(const void *src, unsigned int src_len,
 242                      unsigned int src_ofs, unsigned int n_bits);
 243
 244 #ifdef  __cplusplus
 245 }
 246 #endif
 247
 248 #endif /* util.h */