lib/util.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
   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 extern const char *program_name;
  57
  58 /* Returns the number of elements in ARRAY. */
  59 #define ARRAY_SIZE(ARRAY) (sizeof ARRAY / sizeof *ARRAY)
  60
  61 /* Returns X / Y, rounding up.  X must be nonnegative to round correctly. */
  62 #define DIV_ROUND_UP(X, Y) (((X) + ((Y) - 1)) / (Y))
  63
  64 /* Returns X rounded up to the nearest multiple of Y. */
  65 #define ROUND_UP(X, Y) (DIV_ROUND_UP(X, Y) * (Y))
  66
  67 /* Returns X rounded down to the nearest multiple of Y. */
  68 #define ROUND_DOWN(X, Y) ((X) / (Y) * (Y))
  69
  70 /* Returns true if X is a power of 2, otherwise false. */
  71 #define IS_POW2(X) ((X) && !((X) & ((X) - 1)))
  72
  73 #ifndef MIN
  74 #define MIN(X, Y) ((X) < (Y) ? (X) : (Y))
  75 #endif
  76
  77 #ifndef MAX
  78 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
  79 #endif
  80
  81 #define NOT_REACHED() abort()
  82
  83 /* Expands to a string that looks like "<file>:<line>", e.g. "tmp.c:10".
  84  *
  85  * See http://c-faq.com/ansi/stringize.html for an explanation of STRINGIZE and
  86  * STRINGIZE2. */
  87 #define SOURCE_LOCATOR __FILE__ ":" STRINGIZE(__LINE__)
  88 #define STRINGIZE(ARG) STRINGIZE2(ARG)
  89 #define STRINGIZE2(ARG) #ARG
  90
  91 /* Given a pointer-typed lvalue OBJECT, expands to a pointer type that may be
  92  * assigned to OBJECT. */
  93 #ifdef __GNUC__
  94 #define OVS_TYPEOF(OBJECT) typeof(OBJECT)
  95 #else
  96 #define OVS_TYPEOF(OBJECT) void *
  97 #endif
  98
  99 /* Given OBJECT of type pointer-to-structure, expands to the offset of MEMBER
 100  * within an instance of the structure.
 101  *
 102  * The GCC-specific version avoids the technicality of undefined behavior if
 103  * OBJECT is null, invalid, or not yet initialized.  This makes some static
 104  * checkers (like Coverity) happier.  But the non-GCC version does not actually
 105  * dereference any pointer, so it would be surprising for it to cause any
 106  * problems in practice.
 107  */
 108 #ifdef __GNUC__
 109 #define OBJECT_OFFSETOF(OBJECT, MEMBER) offsetof(typeof(*(OBJECT)), MEMBER)
 110 #else
 111 #define OBJECT_OFFSETOF(OBJECT, MEMBER) \
 112     ((char *) &(OBJECT)->MEMBER - (char *) (OBJECT))
 113 #endif
 114
 115 /* Given POINTER, the address of the given MEMBER in a STRUCT object, returns
 116    the STRUCT object. */
 117 #define CONTAINER_OF(POINTER, STRUCT, MEMBER)                           \
 118         ((STRUCT *) (void *) ((char *) (POINTER) - offsetof (STRUCT, MEMBER)))
 119
 120 /* Given POINTER, the address of the given MEMBER within an object of the type
 121  * that that OBJECT points to, returns OBJECT as an assignment-compatible
 122  * pointer type (either the correct pointer type or "void *").  OBJECT must be
 123  * an lvalue.
 124  *
 125  * This is the same as CONTAINER_OF except that it infers the structure type
 126  * from the type of '*OBJECT'. */
 127 #define OBJECT_CONTAINING(POINTER, OBJECT, MEMBER)                      \
 128     ((OVS_TYPEOF(OBJECT)) (void *)                                      \
 129      ((char *) (POINTER) - OBJECT_OFFSETOF(OBJECT, MEMBER)))
 130
 131 /* Given POINTER, the address of the given MEMBER within an object of the type
 132  * that that OBJECT points to, assigns the address of the outer object to
 133  * OBJECT, which must be an lvalue.
 134  *
 135  * Evaluates to 1. */
 136 #define ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER) \
 137     ((OBJECT) = OBJECT_CONTAINING(POINTER, OBJECT, MEMBER), 1)
 138
 139 #ifdef  __cplusplus
 140 extern "C" {
 141 #endif
 142
 143 void set_program_name(const char *);
 144
 145 void ovs_print_version(char *date, char *time,
 146                        uint8_t min_ofp, uint8_t max_ofp);
 147 #define OVS_PRINT_VERSION(min_ofp, max_ofp) \
 148         ovs_print_version(__DATE__, __TIME__, (min_ofp), (max_ofp))
 149
 150 void out_of_memory(void) NO_RETURN;
 151 void *xmalloc(size_t) MALLOC_LIKE;
 152 void *xcalloc(size_t, size_t) MALLOC_LIKE;
 153 void *xzalloc(size_t) MALLOC_LIKE;
 154 void *xrealloc(void *, size_t);
 155 void *xmemdup(const void *, size_t) MALLOC_LIKE;
 156 char *xmemdup0(const char *, size_t) MALLOC_LIKE;
 157 char *xstrdup(const char *) MALLOC_LIKE;
 158 char *xasprintf(const char *format, ...) PRINTF_FORMAT(1, 2) MALLOC_LIKE;
 159 char *xvasprintf(const char *format, va_list) PRINTF_FORMAT(1, 0) MALLOC_LIKE;
 160 void *x2nrealloc(void *p, size_t *n, size_t s);
 161
 162 void ovs_strlcpy(char *dst, const char *src, size_t size);
 163 void ovs_strzcpy(char *dst, const char *src, size_t size);
 164
 165 void ovs_abort(int err_no, const char *format, ...)
 166     PRINTF_FORMAT(2, 3) NO_RETURN;
 167 void ovs_fatal(int err_no, const char *format, ...)
 168     PRINTF_FORMAT(2, 3) NO_RETURN;
 169 void ovs_fatal_valist(int err_no, const char *format, va_list)
 170     PRINTF_FORMAT(2, 0) NO_RETURN;
 171 void ovs_error(int err_no, const char *format, ...) PRINTF_FORMAT(2, 3);
 172 void ovs_error_valist(int err_no, const char *format, va_list)
 173     PRINTF_FORMAT(2, 0);
 174 const char *ovs_retval_to_string(int);
 175 void ovs_hex_dump(FILE *, const void *, size_t, uintptr_t offset, bool ascii);
 176
 177 bool str_to_int(const char *, int base, int *);
 178 bool str_to_long(const char *, int base, long *);
 179 bool str_to_llong(const char *, int base, long long *);
 180 bool str_to_uint(const char *, int base, unsigned int *);
 181 bool str_to_ulong(const char *, int base, unsigned long *);
 182 bool str_to_ullong(const char *, int base, unsigned long long *);
 183
 184 bool str_to_double(const char *, double *);
 185
 186 int hexit_value(int c);
 187 unsigned int hexits_value(const char *s, size_t n, bool *ok);
 188
 189 const char *english_list_delimiter(size_t index, size_t total);
 190
 191 char *get_cwd(void);
 192 char *dir_name(const char *file_name);
 193 char *base_name(const char *file_name);
 194 char *abs_file_name(const char *dir, const char *file_name);
 195
 196 void ignore(bool x OVS_UNUSED);
 197
 198 #ifdef  __cplusplus
 199 }
 200 #endif
 201
 202 #endif /* util.h */