2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
31 #define va_copy __va_copy
33 #define va_copy(dst, src) ((dst) = (src))
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; })
45 /* Build-time assertion for use in a statement context. */
46 #define BUILD_ASSERT(EXPR) (void) BUILD_ASSERT__(EXPR)
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 */
58 #define BUILD_ASSERT_GCCONLY(EXPR) BUILD_ASSERT(EXPR)
59 #define BUILD_ASSERT_DECL_GCCONLY(EXPR) BUILD_ASSERT_DECL(EXPR)
61 #define BUILD_ASSERT_GCCONLY(EXPR) ((void) 0)
62 #define BUILD_ASSERT_DECL_GCCONLY(EXPR) ((void) 0)
65 /* Casts 'pointer' to 'type' and issues a compiler warning if the cast changes
66 * anything other than an outermost "const" or "volatile" qualifier.
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))), \
75 extern const char *program_name;
76 extern const char *subprogram_name;
78 /* Returns the number of elements in ARRAY. */
79 #define ARRAY_SIZE(ARRAY) (sizeof ARRAY / sizeof *ARRAY)
81 /* Returns X / Y, rounding up. X must be nonnegative to round correctly. */
82 #define DIV_ROUND_UP(X, Y) (((X) + ((Y) - 1)) / (Y))
84 /* Returns X rounded up to the nearest multiple of Y. */
85 #define ROUND_UP(X, Y) (DIV_ROUND_UP(X, Y) * (Y))
87 /* Returns X rounded down to the nearest multiple of Y. */
88 #define ROUND_DOWN(X, Y) ((X) / (Y) * (Y))
90 /* Returns true if X is a power of 2, otherwise false. */
91 #define IS_POW2(X) ((X) && !((X) & ((X) - 1)))
100 #define MIN(X, Y) ((X) < (Y) ? (X) : (Y))
104 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
107 #define NOT_REACHED() abort()
109 /* Expands to a string that looks like "<file>:<line>", e.g. "tmp.c:10".
111 * See http://c-faq.com/ansi/stringize.html for an explanation of STRINGIZE and
113 #define SOURCE_LOCATOR __FILE__ ":" STRINGIZE(__LINE__)
114 #define STRINGIZE(ARG) STRINGIZE2(ARG)
115 #define STRINGIZE2(ARG) #ARG
117 /* Given a pointer-typed lvalue OBJECT, expands to a pointer type that may be
118 * assigned to OBJECT. */
120 #define OVS_TYPEOF(OBJECT) typeof(OBJECT)
122 #define OVS_TYPEOF(OBJECT) void *
125 /* Given OBJECT of type pointer-to-structure, expands to the offset of MEMBER
126 * within an instance of the structure.
128 * The GCC-specific version avoids the technicality of undefined behavior if
129 * OBJECT is null, invalid, or not yet initialized. This makes some static
130 * checkers (like Coverity) happier. But the non-GCC version does not actually
131 * dereference any pointer, so it would be surprising for it to cause any
132 * problems in practice.
135 #define OBJECT_OFFSETOF(OBJECT, MEMBER) offsetof(typeof(*(OBJECT)), MEMBER)
137 #define OBJECT_OFFSETOF(OBJECT, MEMBER) \
138 ((char *) &(OBJECT)->MEMBER - (char *) (OBJECT))
141 /* Given POINTER, the address of the given MEMBER in a STRUCT object, returns
142 the STRUCT object. */
143 #define CONTAINER_OF(POINTER, STRUCT, MEMBER) \
144 ((STRUCT *) (void *) ((char *) (POINTER) - offsetof (STRUCT, MEMBER)))
146 /* Given POINTER, the address of the given MEMBER within an object of the type
147 * that that OBJECT points to, returns OBJECT as an assignment-compatible
148 * pointer type (either the correct pointer type or "void *"). OBJECT must be
151 * This is the same as CONTAINER_OF except that it infers the structure type
152 * from the type of '*OBJECT'. */
153 #define OBJECT_CONTAINING(POINTER, OBJECT, MEMBER) \
154 ((OVS_TYPEOF(OBJECT)) (void *) \
155 ((char *) (POINTER) - OBJECT_OFFSETOF(OBJECT, MEMBER)))
157 /* Given POINTER, the address of the given MEMBER within an object of the type
158 * that that OBJECT points to, assigns the address of the outer object to
159 * OBJECT, which must be an lvalue.
162 #define ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER) \
163 ((OBJECT) = OBJECT_CONTAINING(POINTER, OBJECT, MEMBER), 1)
169 void set_program_name__(const char *name, const char *version,
170 const char *date, const char *time);
171 #define set_program_name(name) \
172 set_program_name__(name, VERSION, __DATE__, __TIME__)
174 const char *get_program_version(void);
175 void ovs_print_version(uint8_t min_ofp, uint8_t max_ofp);
177 void out_of_memory(void) NO_RETURN;
178 void *xmalloc(size_t) MALLOC_LIKE;
179 void *xcalloc(size_t, size_t) MALLOC_LIKE;
180 void *xzalloc(size_t) MALLOC_LIKE;
181 void *xrealloc(void *, size_t);
182 void *xmemdup(const void *, size_t) MALLOC_LIKE;
183 char *xmemdup0(const char *, size_t) MALLOC_LIKE;
184 char *xstrdup(const char *) MALLOC_LIKE;
185 char *xasprintf(const char *format, ...) PRINTF_FORMAT(1, 2) MALLOC_LIKE;
186 char *xvasprintf(const char *format, va_list) PRINTF_FORMAT(1, 0) MALLOC_LIKE;
187 void *x2nrealloc(void *p, size_t *n, size_t s);
189 void ovs_strlcpy(char *dst, const char *src, size_t size);
190 void ovs_strzcpy(char *dst, const char *src, size_t size);
192 void ovs_abort(int err_no, const char *format, ...)
193 PRINTF_FORMAT(2, 3) NO_RETURN;
194 void ovs_abort_valist(int err_no, const char *format, va_list)
195 PRINTF_FORMAT(2, 0) NO_RETURN;
196 void ovs_fatal(int err_no, const char *format, ...)
197 PRINTF_FORMAT(2, 3) NO_RETURN;
198 void ovs_fatal_valist(int err_no, const char *format, va_list)
199 PRINTF_FORMAT(2, 0) NO_RETURN;
200 void ovs_error(int err_no, const char *format, ...) PRINTF_FORMAT(2, 3);
201 void ovs_error_valist(int err_no, const char *format, va_list)
203 const char *ovs_retval_to_string(int);
204 void ovs_hex_dump(FILE *, const void *, size_t, uintptr_t offset, bool ascii);
206 bool str_to_int(const char *, int base, int *);
207 bool str_to_long(const char *, int base, long *);
208 bool str_to_llong(const char *, int base, long long *);
209 bool str_to_uint(const char *, int base, unsigned int *);
210 bool str_to_ulong(const char *, int base, unsigned long *);
211 bool str_to_ullong(const char *, int base, unsigned long long *);
213 bool str_to_double(const char *, double *);
215 int hexit_value(int c);
216 unsigned int hexits_value(const char *s, size_t n, bool *ok);
218 const char *english_list_delimiter(size_t index, size_t total);
221 char *dir_name(const char *file_name);
222 char *base_name(const char *file_name);
223 char *abs_file_name(const char *dir, const char *file_name);
225 char *xreadlink(const char *filename);
226 char *follow_symlinks(const char *filename);
228 void ignore(bool x OVS_UNUSED);
232 /* Returns the number of trailing 0-bits in 'n'. Undefined if 'n' == 0.
234 * This compiles to a single machine instruction ("bsf") with GCC on x86. */
235 #if !defined(UINT_MAX) || !defined(UINT32_MAX)
236 #error "Someone screwed up the #includes."
237 #elif __GNUC__ >= 4 && UINT_MAX == UINT32_MAX
241 return __builtin_ctz(n);
244 /* Defined in util.c. */
245 int raw_ctz(uint32_t n);
248 /* Returns the number of trailing 0-bits in 'n', or 32 if 'n' is 0. */
252 return n ? raw_ctz(n) : 32;
255 int log_2_floor(uint32_t);
256 int log_2_ceil(uint32_t);
257 int popcount(uint32_t);
259 /* Returns the rightmost 1-bit in 'x' (e.g. 01011000 => 00001000), or 0 if 'x'
261 static inline uintmax_t
262 rightmost_1bit(uintmax_t x)
267 /* Returns 'x' with its rightmost 1-bit changed to a zero (e.g. 01011000 =>
268 * 01010000), or 0 if 'x' is 0. */
269 static inline uintmax_t
270 zero_rightmost_1bit(uintmax_t x)
275 /* Returns the index of the rightmost 1-bit in 'x' (e.g. 01011000 => 3), or 32
278 * Unlike the other functions for rightmost 1-bits, this function only works
279 * with 32-bit integers. */
280 static inline uint32_t
281 rightmost_1bit_idx(uint32_t x)
283 return x ? ctz(x) : 32;
286 /* Returns the index of the rightmost 1-bit in 'x' (e.g. 01011000 => 6), or 32
289 * This function only works with 32-bit integers. */
290 static inline uint32_t
291 leftmost_1bit_idx(uint32_t x)
293 return x ? log_2_floor(x) : 32;
296 bool is_all_zeros(const uint8_t *, size_t);
297 bool is_all_ones(const uint8_t *, size_t);
298 void bitwise_copy(const void *src, unsigned int src_len, unsigned int src_ofs,
299 void *dst, unsigned int dst_len, unsigned int dst_ofs,
300 unsigned int n_bits);
301 void bitwise_zero(void *dst_, unsigned int dst_len, unsigned dst_ofs,
302 unsigned int n_bits);
303 void bitwise_one(void *dst_, unsigned int dst_len, unsigned dst_ofs,
304 unsigned int n_bits);
305 bool bitwise_is_all_zeros(const void *, unsigned int len, unsigned int ofs,
306 unsigned int n_bits);
307 void bitwise_put(uint64_t value,
308 void *dst, unsigned int dst_len, unsigned int dst_ofs,
309 unsigned int n_bits);
310 uint64_t bitwise_get(const void *src, unsigned int src_len,
311 unsigned int src_ofs, unsigned int n_bits);