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