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.
30 #define va_copy __va_copy
32 #define va_copy(dst, src) ((dst) = (src))
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; })
44 /* Build-time assertion for use in a statement context. */
45 #define BUILD_ASSERT(EXPR) (void) BUILD_ASSERT__(EXPR)
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 */
57 #define BUILD_ASSERT_GCCONLY(EXPR) BUILD_ASSERT(EXPR)
58 #define BUILD_ASSERT_DECL_GCCONLY(EXPR) BUILD_ASSERT_DECL(EXPR)
60 #define BUILD_ASSERT_GCCONLY(EXPR) ((void) 0)
61 #define BUILD_ASSERT_DECL_GCCONLY(EXPR) ((void) 0)
64 extern const char *program_name;
66 /* Returns the number of elements in ARRAY. */
67 #define ARRAY_SIZE(ARRAY) (sizeof ARRAY / sizeof *ARRAY)
69 /* Returns X / Y, rounding up. X must be nonnegative to round correctly. */
70 #define DIV_ROUND_UP(X, Y) (((X) + ((Y) - 1)) / (Y))
72 /* Returns X rounded up to the nearest multiple of Y. */
73 #define ROUND_UP(X, Y) (DIV_ROUND_UP(X, Y) * (Y))
75 /* Returns X rounded down to the nearest multiple of Y. */
76 #define ROUND_DOWN(X, Y) ((X) / (Y) * (Y))
78 /* Returns true if X is a power of 2, otherwise false. */
79 #define IS_POW2(X) ((X) && !((X) & ((X) - 1)))
87 /* Returns the rightmost 1-bit in 'x' (e.g. 01011000 => 00001000), or 0 if 'x'
89 static inline uintmax_t
90 rightmost_1bit(uintmax_t x)
96 #define MIN(X, Y) ((X) < (Y) ? (X) : (Y))
100 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
103 #define NOT_REACHED() abort()
105 /* Expands to a string that looks like "<file>:<line>", e.g. "tmp.c:10".
107 * See http://c-faq.com/ansi/stringize.html for an explanation of STRINGIZE and
109 #define SOURCE_LOCATOR __FILE__ ":" STRINGIZE(__LINE__)
110 #define STRINGIZE(ARG) STRINGIZE2(ARG)
111 #define STRINGIZE2(ARG) #ARG
113 /* Given a pointer-typed lvalue OBJECT, expands to a pointer type that may be
114 * assigned to OBJECT. */
116 #define OVS_TYPEOF(OBJECT) typeof(OBJECT)
118 #define OVS_TYPEOF(OBJECT) void *
121 /* Given OBJECT of type pointer-to-structure, expands to the offset of MEMBER
122 * within an instance of the structure.
124 * The GCC-specific version avoids the technicality of undefined behavior if
125 * OBJECT is null, invalid, or not yet initialized. This makes some static
126 * checkers (like Coverity) happier. But the non-GCC version does not actually
127 * dereference any pointer, so it would be surprising for it to cause any
128 * problems in practice.
131 #define OBJECT_OFFSETOF(OBJECT, MEMBER) offsetof(typeof(*(OBJECT)), MEMBER)
133 #define OBJECT_OFFSETOF(OBJECT, MEMBER) \
134 ((char *) &(OBJECT)->MEMBER - (char *) (OBJECT))
137 /* Given POINTER, the address of the given MEMBER in a STRUCT object, returns
138 the STRUCT object. */
139 #define CONTAINER_OF(POINTER, STRUCT, MEMBER) \
140 ((STRUCT *) (void *) ((char *) (POINTER) - offsetof (STRUCT, MEMBER)))
142 /* Given POINTER, the address of the given MEMBER within an object of the type
143 * that that OBJECT points to, returns OBJECT as an assignment-compatible
144 * pointer type (either the correct pointer type or "void *"). OBJECT must be
147 * This is the same as CONTAINER_OF except that it infers the structure type
148 * from the type of '*OBJECT'. */
149 #define OBJECT_CONTAINING(POINTER, OBJECT, MEMBER) \
150 ((OVS_TYPEOF(OBJECT)) (void *) \
151 ((char *) (POINTER) - OBJECT_OFFSETOF(OBJECT, MEMBER)))
153 /* Given POINTER, the address of the given MEMBER within an object of the type
154 * that that OBJECT points to, assigns the address of the outer object to
155 * OBJECT, which must be an lvalue.
158 #define ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER) \
159 ((OBJECT) = OBJECT_CONTAINING(POINTER, OBJECT, MEMBER), 1)
165 void set_program_name__(const char *name, const char *version,
166 const char *date, const char *time);
167 #define set_program_name(name) \
168 set_program_name__(name, VERSION, __DATE__, __TIME__)
170 const char *get_program_version(void);
171 void ovs_print_version(uint8_t min_ofp, uint8_t max_ofp);
173 void out_of_memory(void) NO_RETURN;
174 void *xmalloc(size_t) MALLOC_LIKE;
175 void *xcalloc(size_t, size_t) MALLOC_LIKE;
176 void *xzalloc(size_t) MALLOC_LIKE;
177 void *xrealloc(void *, size_t);
178 void *xmemdup(const void *, size_t) MALLOC_LIKE;
179 char *xmemdup0(const char *, size_t) MALLOC_LIKE;
180 char *xstrdup(const char *) MALLOC_LIKE;
181 char *xasprintf(const char *format, ...) PRINTF_FORMAT(1, 2) MALLOC_LIKE;
182 char *xvasprintf(const char *format, va_list) PRINTF_FORMAT(1, 0) MALLOC_LIKE;
183 void *x2nrealloc(void *p, size_t *n, size_t s);
185 void ovs_strlcpy(char *dst, const char *src, size_t size);
186 void ovs_strzcpy(char *dst, const char *src, size_t size);
188 void ovs_abort(int err_no, const char *format, ...)
189 PRINTF_FORMAT(2, 3) NO_RETURN;
190 void ovs_fatal(int err_no, const char *format, ...)
191 PRINTF_FORMAT(2, 3) NO_RETURN;
192 void ovs_fatal_valist(int err_no, const char *format, va_list)
193 PRINTF_FORMAT(2, 0) NO_RETURN;
194 void ovs_error(int err_no, const char *format, ...) PRINTF_FORMAT(2, 3);
195 void ovs_error_valist(int err_no, const char *format, va_list)
197 const char *ovs_retval_to_string(int);
198 void ovs_hex_dump(FILE *, const void *, size_t, uintptr_t offset, bool ascii);
200 bool str_to_int(const char *, int base, int *);
201 bool str_to_long(const char *, int base, long *);
202 bool str_to_llong(const char *, int base, long long *);
203 bool str_to_uint(const char *, int base, unsigned int *);
204 bool str_to_ulong(const char *, int base, unsigned long *);
205 bool str_to_ullong(const char *, int base, unsigned long long *);
207 bool str_to_double(const char *, double *);
209 int hexit_value(int c);
210 unsigned int hexits_value(const char *s, size_t n, bool *ok);
212 const char *english_list_delimiter(size_t index, size_t total);
215 char *dir_name(const char *file_name);
216 char *base_name(const char *file_name);
217 char *abs_file_name(const char *dir, const char *file_name);
219 void ignore(bool x OVS_UNUSED);
220 int log_2_floor(uint32_t);
221 int log_2_ceil(uint32_t);
224 bool is_all_zeros(const uint8_t *, size_t);
225 bool is_all_ones(const uint8_t *, size_t);
226 void bitwise_copy(const void *src, unsigned int src_len, unsigned int src_ofs,
227 void *dst, unsigned int dst_len, unsigned int dst_ofs,
228 unsigned int n_bits);
229 void bitwise_zero(void *dst_, unsigned int dst_len, unsigned dst_ofs,
230 unsigned int n_bits);
231 void bitwise_one(void *dst_, unsigned int dst_len, unsigned dst_ofs,
232 unsigned int n_bits);
233 bool bitwise_is_all_zeros(const void *, unsigned int len, unsigned int ofs,
234 unsigned int n_bits);
235 void bitwise_put(uint64_t value,
236 void *dst, unsigned int dst_len, unsigned int dst_ofs,
237 unsigned int n_bits);
238 uint64_t bitwise_get(const void *src, unsigned int src_len,
239 unsigned int src_ofs, unsigned int n_bits);