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