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