stream-ssl: Add support for Windows platform.
[sliver-openvswitch.git] / lib / util.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 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 <limits.h>
21 #include <stdarg.h>
22 #include <stdbool.h>
23 #include <stddef.h>
24 #include <stdint.h>
25 #include <stdio.h>
26 #include <stdlib.h>
27 #include <string.h>
28 #include "compiler.h"
29 #include "openvswitch/types.h"
30
31 #ifndef va_copy
32 #ifdef __va_copy
33 #define va_copy __va_copy
34 #else
35 #define va_copy(dst, src) ((dst) = (src))
36 #endif
37 #endif
38
39 #ifdef __CHECKER__
40 #define BUILD_ASSERT(EXPR) ((void) 0)
41 #define BUILD_ASSERT_DECL(EXPR) extern int (*build_assert(void))[1]
42 #elif !defined(__cplusplus)
43 /* Build-time assertion building block. */
44 #define BUILD_ASSERT__(EXPR) \
45         sizeof(struct { unsigned int build_assert_failed : (EXPR) ? 1 : -1; })
46
47 /* Build-time assertion for use in a statement context. */
48 #define BUILD_ASSERT(EXPR) (void) BUILD_ASSERT__(EXPR)
49
50 /* Build-time assertion for use in a declaration context. */
51 #define BUILD_ASSERT_DECL(EXPR) \
52         extern int (*build_assert(void))[BUILD_ASSERT__(EXPR)]
53 #else /* __cplusplus */
54 #include <boost/static_assert.hpp>
55 #define BUILD_ASSERT BOOST_STATIC_ASSERT
56 #define BUILD_ASSERT_DECL BOOST_STATIC_ASSERT
57 #endif /* __cplusplus */
58
59 #ifdef __GNUC__
60 #define BUILD_ASSERT_GCCONLY(EXPR) BUILD_ASSERT(EXPR)
61 #define BUILD_ASSERT_DECL_GCCONLY(EXPR) BUILD_ASSERT_DECL(EXPR)
62 #else
63 #define BUILD_ASSERT_GCCONLY(EXPR) ((void) 0)
64 #define BUILD_ASSERT_DECL_GCCONLY(EXPR) ((void) 0)
65 #endif
66
67 /* Like the standard assert macro, except:
68  *
69  *   - Writes the failure message to the log.
70  *
71  *   - Not affected by NDEBUG. */
72 #define ovs_assert(CONDITION)                                           \
73     if (!OVS_LIKELY(CONDITION)) {                                       \
74         ovs_assert_failure(SOURCE_LOCATOR, __func__, #CONDITION);       \
75     }
76 void ovs_assert_failure(const char *, const char *, const char *) NO_RETURN;
77
78 /* Casts 'pointer' to 'type' and issues a compiler warning if the cast changes
79  * anything other than an outermost "const" or "volatile" qualifier.
80  *
81  * The cast to int is present only to suppress an "expression using sizeof
82  * bool" warning from "sparse" (see
83  * http://permalink.gmane.org/gmane.comp.parsers.sparse/2967). */
84 #define CONST_CAST(TYPE, POINTER)                               \
85     ((void) sizeof ((int) ((POINTER) == (TYPE) (POINTER))),     \
86      (TYPE) (POINTER))
87
88 extern const char *program_name;
89
90 #define __ARRAY_SIZE_NOCHECK(ARRAY) (sizeof(ARRAY) / sizeof((ARRAY)[0]))
91 #ifdef __GNUC__
92 /* return 0 for array types, 1 otherwise */
93 #define __ARRAY_CHECK(ARRAY)                                    \
94     !__builtin_types_compatible_p(typeof(ARRAY), typeof(&ARRAY[0]))
95
96 /* compile-time fail if not array */
97 #define __ARRAY_FAIL(ARRAY) (sizeof(char[-2*!__ARRAY_CHECK(ARRAY)]))
98 #define __ARRAY_SIZE(ARRAY)                                     \
99     __builtin_choose_expr(__ARRAY_CHECK(ARRAY),                 \
100         __ARRAY_SIZE_NOCHECK(ARRAY), __ARRAY_FAIL(ARRAY))
101 #else
102 #define __ARRAY_SIZE(ARRAY) __ARRAY_SIZE_NOCHECK(ARRAY)
103 #endif
104
105 /* Returns the number of elements in ARRAY. */
106 #define ARRAY_SIZE(ARRAY) __ARRAY_SIZE(ARRAY)
107
108 /* Returns X / Y, rounding up.  X must be nonnegative to round correctly. */
109 #define DIV_ROUND_UP(X, Y) (((X) + ((Y) - 1)) / (Y))
110
111 /* Returns X rounded up to the nearest multiple of Y. */
112 #define ROUND_UP(X, Y) (DIV_ROUND_UP(X, Y) * (Y))
113
114 /* Returns X rounded down to the nearest multiple of Y. */
115 #define ROUND_DOWN(X, Y) ((X) / (Y) * (Y))
116
117 /* Returns true if X is a power of 2, otherwise false. */
118 #define IS_POW2(X) ((X) && !((X) & ((X) - 1)))
119
120 static inline bool
121 is_pow2(uintmax_t x)
122 {
123     return IS_POW2(x);
124 }
125
126 /* Returns X rounded up to a power of 2.  X must be a constant expression. */
127 #define ROUND_UP_POW2(X) RUP2__(X)
128 #define RUP2__(X) (RUP2_1(X) + 1)
129 #define RUP2_1(X) (RUP2_2(X) | (RUP2_2(X) >> 16))
130 #define RUP2_2(X) (RUP2_3(X) | (RUP2_3(X) >> 8))
131 #define RUP2_3(X) (RUP2_4(X) | (RUP2_4(X) >> 4))
132 #define RUP2_4(X) (RUP2_5(X) | (RUP2_5(X) >> 2))
133 #define RUP2_5(X) (RUP2_6(X) | (RUP2_6(X) >> 1))
134 #define RUP2_6(X) ((X) - 1)
135
136 /* Returns X rounded down to a power of 2.  X must be a constant expression. */
137 #define ROUND_DOWN_POW2(X) RDP2__(X)
138 #define RDP2__(X) (RDP2_1(X) - (RDP2_1(X) >> 1))
139 #define RDP2_1(X) (RDP2_2(X) | (RDP2_2(X) >> 16))
140 #define RDP2_2(X) (RDP2_3(X) | (RDP2_3(X) >> 8))
141 #define RDP2_3(X) (RDP2_4(X) | (RDP2_4(X) >> 4))
142 #define RDP2_4(X) (RDP2_5(X) | (RDP2_5(X) >> 2))
143 #define RDP2_5(X) (      (X) | (      (X) >> 1))
144
145 #ifndef MIN
146 #define MIN(X, Y) ((X) < (Y) ? (X) : (Y))
147 #endif
148
149 #ifndef MAX
150 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
151 #endif
152
153 #define OVS_NOT_REACHED() abort()
154
155 /* Expands to a string that looks like "<file>:<line>", e.g. "tmp.c:10".
156  *
157  * See http://c-faq.com/ansi/stringize.html for an explanation of STRINGIZE and
158  * STRINGIZE2. */
159 #define SOURCE_LOCATOR __FILE__ ":" STRINGIZE(__LINE__)
160 #define STRINGIZE(ARG) STRINGIZE2(ARG)
161 #define STRINGIZE2(ARG) #ARG
162
163 /* Given a pointer-typed lvalue OBJECT, expands to a pointer type that may be
164  * assigned to OBJECT. */
165 #ifdef __GNUC__
166 #define OVS_TYPEOF(OBJECT) typeof(OBJECT)
167 #else
168 #define OVS_TYPEOF(OBJECT) void *
169 #endif
170
171 /* Given OBJECT of type pointer-to-structure, expands to the offset of MEMBER
172  * within an instance of the structure.
173  *
174  * The GCC-specific version avoids the technicality of undefined behavior if
175  * OBJECT is null, invalid, or not yet initialized.  This makes some static
176  * checkers (like Coverity) happier.  But the non-GCC version does not actually
177  * dereference any pointer, so it would be surprising for it to cause any
178  * problems in practice.
179  */
180 #ifdef __GNUC__
181 #define OBJECT_OFFSETOF(OBJECT, MEMBER) offsetof(typeof(*(OBJECT)), MEMBER)
182 #else
183 #define OBJECT_OFFSETOF(OBJECT, MEMBER) \
184     ((char *) &(OBJECT)->MEMBER - (char *) (OBJECT))
185 #endif
186
187 /* Given POINTER, the address of the given MEMBER in a STRUCT object, returns
188    the STRUCT object. */
189 #define CONTAINER_OF(POINTER, STRUCT, MEMBER)                           \
190         ((STRUCT *) (void *) ((char *) (POINTER) - offsetof (STRUCT, MEMBER)))
191
192 /* Given POINTER, the address of the given MEMBER within an object of the type
193  * that that OBJECT points to, returns OBJECT as an assignment-compatible
194  * pointer type (either the correct pointer type or "void *").  OBJECT must be
195  * an lvalue.
196  *
197  * This is the same as CONTAINER_OF except that it infers the structure type
198  * from the type of '*OBJECT'. */
199 #define OBJECT_CONTAINING(POINTER, OBJECT, MEMBER)                      \
200     ((OVS_TYPEOF(OBJECT)) (void *)                                      \
201      ((char *) (POINTER) - OBJECT_OFFSETOF(OBJECT, MEMBER)))
202
203 /* Given POINTER, the address of the given MEMBER within an object of the type
204  * that that OBJECT points to, assigns the address of the outer object to
205  * OBJECT, which must be an lvalue.
206  *
207  * Evaluates to (void) 0 as the result is not to be used. */
208 #define ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER) \
209     ((OBJECT) = OBJECT_CONTAINING(POINTER, OBJECT, MEMBER), (void) 0)
210
211 /* Given ATTR, and TYPE, cast the ATTR to TYPE by first casting ATTR to
212  * (void *). This is to suppress the alignment warning issued by clang. */
213 #define ALIGNED_CAST(TYPE, ATTR) ((TYPE) (void *) (ATTR))
214
215 /* Use "%"PRIuSIZE to format size_t with printf(). */
216 #ifdef _WIN32
217 #define PRIdSIZE "Id"
218 #define PRIiSIZE "Ii"
219 #define PRIoSIZE "Io"
220 #define PRIuSIZE "Iu"
221 #define PRIxSIZE "Ix"
222 #define PRIXSIZE "IX"
223 #else
224 #define PRIdSIZE "zd"
225 #define PRIiSIZE "zi"
226 #define PRIoSIZE "zo"
227 #define PRIuSIZE "zu"
228 #define PRIxSIZE "zx"
229 #define PRIXSIZE "zX"
230 #endif
231
232 #ifdef  __cplusplus
233 extern "C" {
234 #endif
235
236 void set_program_name__(const char *name, const char *version,
237                         const char *date, const char *time);
238 #define set_program_name(name) \
239         set_program_name__(name, VERSION, __DATE__, __TIME__)
240
241 const char *get_subprogram_name(void);
242 void set_subprogram_name(const char *format, ...) PRINTF_FORMAT(1, 2);
243
244 const char *get_program_version(void);
245 void ovs_print_version(uint8_t min_ofp, uint8_t max_ofp);
246
247 void out_of_memory(void) NO_RETURN;
248 void *xmalloc(size_t) MALLOC_LIKE;
249 void *xcalloc(size_t, size_t) MALLOC_LIKE;
250 void *xzalloc(size_t) MALLOC_LIKE;
251 void *xrealloc(void *, size_t);
252 void *xmemdup(const void *, size_t) MALLOC_LIKE;
253 char *xmemdup0(const char *, size_t) MALLOC_LIKE;
254 char *xstrdup(const char *) MALLOC_LIKE;
255 char *xasprintf(const char *format, ...) PRINTF_FORMAT(1, 2) MALLOC_LIKE;
256 char *xvasprintf(const char *format, va_list) PRINTF_FORMAT(1, 0) MALLOC_LIKE;
257 void *x2nrealloc(void *p, size_t *n, size_t s);
258
259 void ovs_strlcpy(char *dst, const char *src, size_t size);
260 void ovs_strzcpy(char *dst, const char *src, size_t size);
261
262 void ovs_abort(int err_no, const char *format, ...)
263     PRINTF_FORMAT(2, 3) NO_RETURN;
264 void ovs_abort_valist(int err_no, const char *format, va_list)
265     PRINTF_FORMAT(2, 0) NO_RETURN;
266 void ovs_fatal(int err_no, const char *format, ...)
267     PRINTF_FORMAT(2, 3) NO_RETURN;
268 void ovs_fatal_valist(int err_no, const char *format, va_list)
269     PRINTF_FORMAT(2, 0) NO_RETURN;
270 void ovs_error(int err_no, const char *format, ...) PRINTF_FORMAT(2, 3);
271 void ovs_error_valist(int err_no, const char *format, va_list)
272     PRINTF_FORMAT(2, 0);
273 const char *ovs_retval_to_string(int);
274 const char *ovs_strerror(int);
275 void ovs_hex_dump(FILE *, const void *, size_t, uintptr_t offset, bool ascii);
276
277 bool str_to_int(const char *, int base, int *);
278 bool str_to_long(const char *, int base, long *);
279 bool str_to_llong(const char *, int base, long long *);
280
281 static inline bool
282 str_to_uint(const char *s, int base, unsigned int *u)
283 {
284     return str_to_int(s, base, (int *) u);
285 }
286
287 static inline bool
288 str_to_ulong(const char *s, int base, unsigned long *ul)
289 {
290     return str_to_long(s, base, (long *) ul);
291 }
292
293 static inline bool
294 str_to_ullong(const char *s, int base, unsigned long long *ull)
295 {
296     return str_to_llong(s, base, (long long *) ull);
297 }
298
299 bool ovs_scan(const char *s, const char *format, ...) SCANF_FORMAT(2, 3);
300
301 bool str_to_double(const char *, double *);
302
303 int hexit_value(int c);
304 unsigned int hexits_value(const char *s, size_t n, bool *ok);
305
306 const char *english_list_delimiter(size_t index, size_t total);
307
308 char *get_cwd(void);
309 char *dir_name(const char *file_name);
310 char *base_name(const char *file_name);
311 char *abs_file_name(const char *dir, const char *file_name);
312
313 char *xreadlink(const char *filename);
314 char *follow_symlinks(const char *filename);
315
316 void ignore(bool x OVS_UNUSED);
317 \f
318 /* Bitwise tests. */
319
320 /* Returns the number of trailing 0-bits in 'n'.  Undefined if 'n' == 0. */
321 #if __GNUC__ >= 4
322 static inline int
323 raw_ctz(uint64_t n)
324 {
325     /* With GCC 4.7 on 32-bit x86, if a 32-bit integer is passed as 'n', using
326      * a plain __builtin_ctzll() here always generates an out-of-line function
327      * call.  The test below helps it to emit a single 'bsf' instruction. */
328     return (__builtin_constant_p(n <= UINT32_MAX) && n <= UINT32_MAX
329             ? __builtin_ctz(n)
330             : __builtin_ctzll(n));
331 }
332
333 static inline int
334 raw_clz64(uint64_t n)
335 {
336     return __builtin_clzll(n);
337 }
338 #else
339 /* Defined in util.c. */
340 int raw_ctz(uint64_t n);
341 int raw_clz64(uint64_t n);
342 #endif
343
344 /* Returns the number of trailing 0-bits in 'n', or 32 if 'n' is 0. */
345 static inline int
346 ctz32(uint32_t n)
347 {
348     return n ? raw_ctz(n) : 32;
349 }
350
351 /* Returns the number of trailing 0-bits in 'n', or 64 if 'n' is 0. */
352 static inline int
353 ctz64(uint64_t n)
354 {
355     return n ? raw_ctz(n) : 64;
356 }
357
358 /* Returns the number of leading 0-bits in 'n', or 32 if 'n' is 0. */
359 static inline int
360 clz32(uint32_t n)
361 {
362     return n ? raw_clz64(n) - 32 : 32;
363 }
364
365 /* Returns the number of leading 0-bits in 'n', or 64 if 'n' is 0. */
366 static inline int
367 clz64(uint64_t n)
368 {
369     return n ? raw_clz64(n) : 64;
370 }
371
372 /* Given a word 'n', calculates floor(log_2('n')).  This is equivalent
373  * to finding the bit position of the most significant one bit in 'n'.  It is
374  * an error to call this function with 'n' == 0. */
375 static inline int
376 log_2_floor(uint64_t n)
377 {
378     return 63 - raw_clz64(n);
379 }
380
381 /* Given a word 'n', calculates ceil(log_2('n')).  It is an error to
382  * call this function with 'n' == 0. */
383 static inline int
384 log_2_ceil(uint64_t n)
385 {
386     return log_2_floor(n) + !is_pow2(n);
387 }
388
389 /* unsigned int count_1bits(uint64_t x):
390  *
391  * Returns the number of 1-bits in 'x', between 0 and 64 inclusive. */
392 #if UINTPTR_MAX == UINT64_MAX
393 static inline unsigned int
394 count_1bits(uint64_t x)
395 {
396 #if __GNUC__ >= 4 && __POPCNT__
397     return __builtin_popcountll(x);
398 #else
399     /* This portable implementation is the fastest one we know of for 64
400      * bits, and about 3x faster than GCC 4.7 __builtin_popcountll(). */
401     const uint64_t h55 = UINT64_C(0x5555555555555555);
402     const uint64_t h33 = UINT64_C(0x3333333333333333);
403     const uint64_t h0F = UINT64_C(0x0F0F0F0F0F0F0F0F);
404     const uint64_t h01 = UINT64_C(0x0101010101010101);
405     x -= (x >> 1) & h55;               /* Count of each 2 bits in-place. */
406     x = (x & h33) + ((x >> 2) & h33);  /* Count of each 4 bits in-place. */
407     x = (x + (x >> 4)) & h0F;          /* Count of each 8 bits in-place. */
408     return (x * h01) >> 56;            /* Sum of all bytes. */
409 #endif
410 }
411 #else /* Not 64-bit. */
412 #if __GNUC__ >= 4 && __POPCNT__
413 static inline unsigned int
414 count_1bits_32__(uint32_t x)
415 {
416     return __builtin_popcount(x);
417 }
418 #else
419 #define NEED_COUNT_1BITS_8 1
420 extern const uint8_t count_1bits_8[256];
421 static inline unsigned int
422 count_1bits_32__(uint32_t x)
423 {
424     /* This portable implementation is the fastest one we know of for 32 bits,
425      * and faster than GCC __builtin_popcount(). */
426     return (count_1bits_8[x & 0xff] +
427             count_1bits_8[(x >> 8) & 0xff] +
428             count_1bits_8[(x >> 16) & 0xff] +
429             count_1bits_8[x >> 24]);
430 }
431 #endif
432 static inline unsigned int
433 count_1bits(uint64_t x)
434 {
435     return count_1bits_32__(x) + count_1bits_32__(x >> 32);
436 }
437 #endif
438
439 /* Returns the rightmost 1-bit in 'x' (e.g. 01011000 => 00001000), or 0 if 'x'
440  * is 0. */
441 static inline uintmax_t
442 rightmost_1bit(uintmax_t x)
443 {
444     return x & -x;
445 }
446
447 /* Returns 'x' with its rightmost 1-bit changed to a zero (e.g. 01011000 =>
448  * 01010000), or 0 if 'x' is 0. */
449 static inline uintmax_t
450 zero_rightmost_1bit(uintmax_t x)
451 {
452     return x & (x - 1);
453 }
454
455 /* Returns the index of the rightmost 1-bit in 'x' (e.g. 01011000 => 3), or 32
456  * if 'x' is 0.
457  *
458  * Unlike the other functions for rightmost 1-bits, this function only works
459  * with 32-bit integers. */
460 static inline uint32_t
461 rightmost_1bit_idx(uint32_t x)
462 {
463     return ctz32(x);
464 }
465
466 /* Returns the index of the leftmost 1-bit in 'x' (e.g. 01011000 => 6), or 32
467  * if 'x' is 0.
468  *
469  * This function only works with 32-bit integers. */
470 static inline uint32_t
471 leftmost_1bit_idx(uint32_t x)
472 {
473     return x ? log_2_floor(x) : 32;
474 }
475 \f
476 bool is_all_zeros(const uint8_t *, size_t);
477 bool is_all_ones(const uint8_t *, size_t);
478 void bitwise_copy(const void *src, unsigned int src_len, unsigned int src_ofs,
479                   void *dst, unsigned int dst_len, unsigned int dst_ofs,
480                   unsigned int n_bits);
481 void bitwise_zero(void *dst_, unsigned int dst_len, unsigned dst_ofs,
482                   unsigned int n_bits);
483 void bitwise_one(void *dst_, unsigned int dst_len, unsigned dst_ofs,
484                  unsigned int n_bits);
485 bool bitwise_is_all_zeros(const void *, unsigned int len, unsigned int ofs,
486                           unsigned int n_bits);
487 void bitwise_put(uint64_t value,
488                  void *dst, unsigned int dst_len, unsigned int dst_ofs,
489                  unsigned int n_bits);
490 uint64_t bitwise_get(const void *src, unsigned int src_len,
491                      unsigned int src_ofs, unsigned int n_bits);
492
493 #ifdef _WIN32
494 \f
495 char *ovs_lasterror_to_string(void);
496 #endif
497
498 #ifdef  __cplusplus
499 }
500 #endif
501
502 #endif /* util.h */