029a3751826f4dc69731487277f8510df5174cc9
[strongswan.git] / src / libstrongswan / utils / utils.h
1 /*
2 * Copyright (C) 2008-2014 Tobias Brunner
3 * Copyright (C) 2008 Martin Willi
4 * Hochschule fuer Technik Rapperswil
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * for more details.
15 */
16
17 /**
18 * @defgroup utils_i utils
19 * @{ @ingroup utils
20 */
21
22 #ifndef UTILS_H_
23 #define UTILS_H_
24
25 #include <sys/types.h>
26 #include <stdlib.h>
27 #include <stddef.h>
28 #include <sys/time.h>
29 #include <string.h>
30
31 #ifdef WIN32
32 # include "compat/windows.h"
33 #else
34 # define _GNU_SOURCE
35 # include <arpa/inet.h>
36 # include <sys/socket.h>
37 # include <netdb.h>
38 # include <netinet/in.h>
39 # include <sched.h>
40 # include <poll.h>
41 #endif
42
43 /**
44 * strongSwan program return codes
45 */
46 #define SS_RC_LIBSTRONGSWAN_INTEGRITY 64
47 #define SS_RC_DAEMON_INTEGRITY 65
48 #define SS_RC_INITIALIZATION_FAILED 66
49
50 #define SS_RC_FIRST SS_RC_LIBSTRONGSWAN_INTEGRITY
51 #define SS_RC_LAST SS_RC_INITIALIZATION_FAILED
52
53 /**
54 * Number of bits in a byte
55 */
56 #define BITS_PER_BYTE 8
57
58 /**
59 * Default length for various auxiliary text buffers
60 */
61 #define BUF_LEN 512
62
63 /**
64 * Build assertion macro for integer expressions, evaluates to 0
65 */
66 #define BUILD_ASSERT(x) (sizeof(char[(x) ? 0 : -1]))
67
68 /**
69 * Build time check to assert a is an array, evaluates to 0
70 *
71 * The address of an array element has a pointer type, which is not compatible
72 * to the array type.
73 */
74 #define BUILD_ASSERT_ARRAY(a) \
75 BUILD_ASSERT(!__builtin_types_compatible_p(typeof(a), typeof(&(a)[0])))
76
77 /**
78 * General purpose boolean type.
79 */
80 #ifdef HAVE_STDBOOL_H
81 # include <stdbool.h>
82 #else
83 # ifndef HAVE__BOOL
84 # define _Bool signed char
85 # endif /* HAVE__BOOL */
86 # define bool _Bool
87 # define false 0
88 # define true 1
89 # define __bool_true_false_are_defined 1
90 #endif /* HAVE_STDBOOL_H */
91 #ifndef FALSE
92 # define FALSE false
93 #endif /* FALSE */
94 #ifndef TRUE
95 # define TRUE true
96 #endif /* TRUE */
97
98 #include "enum.h"
99 #include "utils/strerror.h"
100 #ifdef __APPLE__
101 # include "compat/apple.h"
102 #endif
103
104 /**
105 * Directory separator character in paths on this platform
106 */
107 #ifdef WIN32
108 # define DIRECTORY_SEPARATOR "\\"
109 #else
110 # define DIRECTORY_SEPARATOR "/"
111 #endif
112
113 /**
114 * Initialize utility functions
115 */
116 void utils_init();
117
118 /**
119 * Deinitialize utility functions
120 */
121 void utils_deinit();
122
123 /**
124 * Helper function that compares two strings for equality
125 */
126 static inline bool streq(const char *x, const char *y)
127 {
128 return strcmp(x, y) == 0;
129 }
130
131 /**
132 * Helper function that compares two strings for equality, length limited
133 */
134 static inline bool strneq(const char *x, const char *y, size_t len)
135 {
136 return strncmp(x, y, len) == 0;
137 }
138
139 /**
140 * Helper function that checks if a string starts with a given prefix
141 */
142 static inline bool strpfx(const char *x, const char *prefix)
143 {
144 return strneq(x, prefix, strlen(prefix));
145 }
146
147 /**
148 * Helper function that compares two strings for equality ignoring case
149 */
150 static inline bool strcaseeq(const char *x, const char *y)
151 {
152 return strcasecmp(x, y) == 0;
153 }
154
155 /**
156 * Helper function that compares two strings for equality ignoring case, length limited
157 */
158 static inline bool strncaseeq(const char *x, const char *y, size_t len)
159 {
160 return strncasecmp(x, y, len) == 0;
161 }
162
163 /**
164 * Helper function that checks if a string starts with a given prefix
165 */
166 static inline bool strcasepfx(const char *x, const char *prefix)
167 {
168 return strncaseeq(x, prefix, strlen(prefix));
169 }
170
171 /**
172 * NULL-safe strdup variant
173 */
174 static inline char *strdupnull(const char *s)
175 {
176 return s ? strdup(s) : NULL;
177 }
178
179 /**
180 * Helper function that compares two binary blobs for equality
181 */
182 static inline bool memeq(const void *x, const void *y, size_t len)
183 {
184 return memcmp(x, y, len) == 0;
185 }
186
187 /**
188 * Same as memeq(), but with a constant runtime, safe for cryptographic use.
189 */
190 bool memeq_const(const void *x, const void *y, size_t len);
191
192 /**
193 * Calling memcpy() with NULL pointers, even with n == 0, results in undefined
194 * behavior according to the C standard. This version is guaranteed to not
195 * access the pointers if n is 0.
196 */
197 static inline void *memcpy_noop(void *dst, const void *src, size_t n)
198 {
199 return n ? memcpy(dst, src, n) : dst;
200 }
201 #ifdef memcpy
202 # undef memcpy
203 #endif
204 #define memcpy(d,s,n) memcpy_noop(d,s,n)
205
206 /**
207 * Calling memmove() with NULL pointers, even with n == 0, results in undefined
208 * behavior according to the C standard. This version is guaranteed to not
209 * access the pointers if n is 0.
210 */
211 static inline void *memmove_noop(void *dst, const void *src, size_t n)
212 {
213 return n ? memmove(dst, src, n) : dst;
214 }
215 #ifdef memmove
216 # undef memmove
217 #endif
218 #define memmove(d,s,n) memmove_noop(d,s,n)
219
220 /**
221 * Calling memset() with a NULL pointer, even with n == 0, results in undefined
222 * behavior according to the C standard. This version is guaranteed to not
223 * access the pointer if n is 0.
224 */
225 static inline void *memset_noop(void *s, int c, size_t n)
226 {
227 return n ? memset(s, c, n) : s;
228 }
229 #ifdef memset
230 # undef memset
231 #endif
232 #define memset(s,c,n) memset_noop(s,c,n)
233
234 /**
235 * Macro gives back larger of two values.
236 */
237 #define max(x,y) ({ \
238 typeof(x) _x = (x); \
239 typeof(y) _y = (y); \
240 _x > _y ? _x : _y; })
241
242 /**
243 * Macro gives back smaller of two values.
244 */
245 #define min(x,y) ({ \
246 typeof(x) _x = (x); \
247 typeof(y) _y = (y); \
248 _x < _y ? _x : _y; })
249
250 /**
251 * Call destructor of an object, if object != NULL
252 */
253 #define DESTROY_IF(obj) if (obj) (obj)->destroy(obj)
254
255 /**
256 * Call offset destructor of an object, if object != NULL
257 */
258 #define DESTROY_OFFSET_IF(obj, offset) if (obj) obj->destroy_offset(obj, offset);
259
260 /**
261 * Call function destructor of an object, if object != NULL
262 */
263 #define DESTROY_FUNCTION_IF(obj, fn) if (obj) obj->destroy_function(obj, fn);
264
265 /**
266 * Debug macro to follow control flow
267 */
268 #define POS printf("%s, line %d\n", __FILE__, __LINE__)
269
270 /**
271 * Object allocation/initialization macro, using designated initializer.
272 */
273 #define INIT(this, ...) { (this) = malloc(sizeof(*(this))); \
274 *(this) = (typeof(*(this))){ __VA_ARGS__ }; }
275
276 /**
277 * Method declaration/definition macro, providing private and public interface.
278 *
279 * Defines a method name with this as first parameter and a return value ret,
280 * and an alias for this method with a _ prefix, having the this argument
281 * safely casted to the public interface iface.
282 * _name is provided a function pointer, but will get optimized out by GCC.
283 */
284 #define METHOD(iface, name, ret, this, ...) \
285 static ret name(union {iface *_public; this;} \
286 __attribute__((transparent_union)), ##__VA_ARGS__); \
287 static typeof(name) *_##name = (typeof(name)*)name; \
288 static ret name(this, ##__VA_ARGS__)
289
290 /**
291 * Same as METHOD(), but is defined for two public interfaces.
292 */
293 #define METHOD2(iface1, iface2, name, ret, this, ...) \
294 static ret name(union {iface1 *_public1; iface2 *_public2; this;} \
295 __attribute__((transparent_union)), ##__VA_ARGS__); \
296 static typeof(name) *_##name = (typeof(name)*)name; \
297 static ret name(this, ##__VA_ARGS__)
298
299 /**
300 * Callback declaration/definition macro, allowing casted first parameter.
301 *
302 * This is very similar to METHOD, but instead of casting the first parameter
303 * to a public interface, it uses a void*. This allows type safe definition
304 * of a callback function, while using the real type for the first parameter.
305 */
306 #define CALLBACK(name, ret, param1, ...) \
307 static ret _cb_##name(union {void *_generic; param1;} \
308 __attribute__((transparent_union)), ##__VA_ARGS__); \
309 static typeof(_cb_##name) *name = (typeof(_cb_##name)*)_cb_##name; \
310 static ret _cb_##name(param1, ##__VA_ARGS__)
311
312 /**
313 * This macro allows counting the number of arguments passed to a macro.
314 * Combined with the VA_ARGS_DISPATCH() macro this can be used to implement
315 * macro overloading based on the number of arguments.
316 * 0 to 10 arguments are currently supported.
317 */
318 #define VA_ARGS_NUM(...) _VA_ARGS_NUM(0,##__VA_ARGS__,10,9,8,7,6,5,4,3,2,1,0)
319 #define _VA_ARGS_NUM(_0,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,NUM,...) NUM
320
321 /**
322 * This macro can be used to dispatch a macro call based on the number of given
323 * arguments, for instance:
324 *
325 * @code
326 * #define MY_MACRO(...) VA_ARGS_DISPATCH(MY_MACRO, __VA_ARGS__)(__VA_ARGS__)
327 * #define MY_MACRO1(arg) one_arg(arg)
328 * #define MY_MACRO2(arg1,arg2) two_args(arg1,arg2)
329 * @endcode
330 *
331 * MY_MACRO() can now be called with either one or two arguments, which will
332 * resolve to one_arg(arg) or two_args(arg1,arg2), respectively.
333 */
334 #define VA_ARGS_DISPATCH(func, ...) _VA_ARGS_DISPATCH(func, VA_ARGS_NUM(__VA_ARGS__))
335 #define _VA_ARGS_DISPATCH(func, num) __VA_ARGS_DISPATCH(func, num)
336 #define __VA_ARGS_DISPATCH(func, num) func ## num
337
338 /**
339 * Architecture independent bitfield definition helpers (at least with GCC).
340 *
341 * Defines a bitfield with a type t and a fixed size of bitfield members, e.g.:
342 * BITFIELD2(u_int8_t,
343 * low: 4,
344 * high: 4,
345 * ) flags;
346 * The member defined first placed at bit 0.
347 */
348 #if BYTE_ORDER == LITTLE_ENDIAN
349 #define BITFIELD2(t, a, b,...) struct { t a; t b; __VA_ARGS__}
350 #define BITFIELD3(t, a, b, c,...) struct { t a; t b; t c; __VA_ARGS__}
351 #define BITFIELD4(t, a, b, c, d,...) struct { t a; t b; t c; t d; __VA_ARGS__}
352 #define BITFIELD5(t, a, b, c, d, e,...) struct { t a; t b; t c; t d; t e; __VA_ARGS__}
353 #elif BYTE_ORDER == BIG_ENDIAN
354 #define BITFIELD2(t, a, b,...) struct { t b; t a; __VA_ARGS__}
355 #define BITFIELD3(t, a, b, c,...) struct { t c; t b; t a; __VA_ARGS__}
356 #define BITFIELD4(t, a, b, c, d,...) struct { t d; t c; t b; t a; __VA_ARGS__}
357 #define BITFIELD5(t, a, b, c, d, e,...) struct { t e; t d; t c; t b; t a; __VA_ARGS__}
358 #endif
359
360 /**
361 * Macro to allocate a sized type.
362 */
363 #define malloc_thing(thing) ((thing*)malloc(sizeof(thing)))
364
365 /**
366 * Get the number of elements in an array
367 */
368 #define countof(array) (sizeof(array)/sizeof((array)[0]) \
369 + BUILD_ASSERT_ARRAY(array))
370
371 /**
372 * Ignore result of functions tagged with warn_unused_result attributes
373 */
374 #define ignore_result(call) { if(call){}; }
375
376 /**
377 * Assign a function as a class method
378 */
379 #define ASSIGN(method, function) (method = (typeof(method))function)
380
381 /**
382 * time_t not defined
383 */
384 #define UNDEFINED_TIME 0
385
386 /**
387 * Maximum time since epoch causing wrap-around on Jan 19 03:14:07 UTC 2038
388 */
389 #define TIME_32_BIT_SIGNED_MAX 0x7fffffff
390
391 /**
392 * define some missing fixed width int types on OpenSolaris.
393 * TODO: since the uintXX_t types are defined by the C99 standard we should
394 * probably use those anyway
395 */
396 #if defined __sun || defined WIN32
397 #include <stdint.h>
398 typedef uint8_t u_int8_t;
399 typedef uint16_t u_int16_t;
400 typedef uint32_t u_int32_t;
401 typedef uint64_t u_int64_t;
402 #endif
403
404 #ifdef HAVE_INT128
405 /**
406 * 128 bit wide signed integer, if supported
407 */
408 typedef __int128 int128_t;
409 /**
410 * 128 bit wide unsigned integer, if supported
411 */
412 typedef unsigned __int128 u_int128_t;
413
414 # define MAX_INT_TYPE int128_t
415 # define MAX_UINT_TYPE u_int128_t
416 #else
417 # define MAX_INT_TYPE int64_t
418 # define MAX_UINT_TYPE u_int64_t
419 #endif
420
421 typedef enum status_t status_t;
422
423 /**
424 * Return values of function calls.
425 */
426 enum status_t {
427 /**
428 * Call succeeded.
429 */
430 SUCCESS,
431
432 /**
433 * Call failed.
434 */
435 FAILED,
436
437 /**
438 * Out of resources.
439 */
440 OUT_OF_RES,
441
442 /**
443 * The suggested operation is already done
444 */
445 ALREADY_DONE,
446
447 /**
448 * Not supported.
449 */
450 NOT_SUPPORTED,
451
452 /**
453 * One of the arguments is invalid.
454 */
455 INVALID_ARG,
456
457 /**
458 * Something could not be found.
459 */
460 NOT_FOUND,
461
462 /**
463 * Error while parsing.
464 */
465 PARSE_ERROR,
466
467 /**
468 * Error while verifying.
469 */
470 VERIFY_ERROR,
471
472 /**
473 * Object in invalid state.
474 */
475 INVALID_STATE,
476
477 /**
478 * Destroy object which called method belongs to.
479 */
480 DESTROY_ME,
481
482 /**
483 * Another call to the method is required.
484 */
485 NEED_MORE,
486 };
487
488 /**
489 * enum_names for type status_t.
490 */
491 extern enum_name_t *status_names;
492
493 typedef enum tty_escape_t tty_escape_t;
494
495 /**
496 * Excape codes for tty colors
497 */
498 enum tty_escape_t {
499 /** text properties */
500 TTY_RESET,
501 TTY_BOLD,
502 TTY_UNDERLINE,
503 TTY_BLINKING,
504
505 /** foreground colors */
506 TTY_FG_BLACK,
507 TTY_FG_RED,
508 TTY_FG_GREEN,
509 TTY_FG_YELLOW,
510 TTY_FG_BLUE,
511 TTY_FG_MAGENTA,
512 TTY_FG_CYAN,
513 TTY_FG_WHITE,
514 TTY_FG_DEF,
515
516 /** background colors */
517 TTY_BG_BLACK,
518 TTY_BG_RED,
519 TTY_BG_GREEN,
520 TTY_BG_YELLOW,
521 TTY_BG_BLUE,
522 TTY_BG_MAGENTA,
523 TTY_BG_CYAN,
524 TTY_BG_WHITE,
525 TTY_BG_DEF,
526 };
527
528 /**
529 * Get the escape string for a given TTY color, empty string on non-tty fd
530 */
531 char* tty_escape_get(int fd, tty_escape_t escape);
532
533 /**
534 * deprecated pluto style return value:
535 * error message, NULL for success
536 */
537 typedef const char *err_t;
538
539 /**
540 * Handle struct timeval like an own type.
541 */
542 typedef struct timeval timeval_t;
543
544 /**
545 * Handle struct timespec like an own type.
546 */
547 typedef struct timespec timespec_t;
548
549 /**
550 * Handle struct chunk_t like an own type.
551 */
552 typedef struct sockaddr sockaddr_t;
553
554 /**
555 * Same as memcpy, but XORs src into dst instead of copy
556 */
557 void memxor(u_int8_t dest[], u_int8_t src[], size_t n);
558
559 /**
560 * Safely overwrite n bytes of memory at ptr with zero, non-inlining variant.
561 */
562 void memwipe_noinline(void *ptr, size_t n);
563
564 /**
565 * Safely overwrite n bytes of memory at ptr with zero, inlining variant.
566 */
567 static inline void memwipe_inline(void *ptr, size_t n)
568 {
569 volatile char *c = (volatile char*)ptr;
570 size_t m, i;
571
572 /* byte wise until long aligned */
573 for (i = 0; (uintptr_t)&c[i] % sizeof(long) && i < n; i++)
574 {
575 c[i] = 0;
576 }
577 /* word wise */
578 if (n >= sizeof(long))
579 {
580 for (m = n - sizeof(long); i <= m; i += sizeof(long))
581 {
582 *(volatile long*)&c[i] = 0;
583 }
584 }
585 /* byte wise of the rest */
586 for (; i < n; i++)
587 {
588 c[i] = 0;
589 }
590 }
591
592 /**
593 * Safely overwrite n bytes of memory at ptr with zero, auto-inlining variant.
594 */
595 static inline void memwipe(void *ptr, size_t n)
596 {
597 if (!ptr)
598 {
599 return;
600 }
601 if (__builtin_constant_p(n))
602 {
603 memwipe_inline(ptr, n);
604 }
605 else
606 {
607 memwipe_noinline(ptr, n);
608 }
609 }
610
611 /**
612 * A variant of strstr with the characteristics of memchr, where haystack is not
613 * a null-terminated string but simply a memory area of length n.
614 */
615 void *memstr(const void *haystack, const char *needle, size_t n);
616
617 /**
618 * Replacement for memrchr(3) if it is not provided by the C library.
619 *
620 * @param s start of the memory area to search
621 * @param c character to search
622 * @param n length of memory area to search
623 * @return pointer to the found character or NULL
624 */
625 void *utils_memrchr(const void *s, int c, size_t n);
626
627 #ifndef HAVE_MEMRCHR
628 #define memrchr(s,c,n) utils_memrchr(s,c,n)
629 #endif
630
631 /**
632 * Translates the characters in the given string, searching for characters
633 * in 'from' and mapping them to characters in 'to'.
634 * The two characters sets 'from' and 'to' must contain the same number of
635 * characters.
636 */
637 char *translate(char *str, const char *from, const char *to);
638
639 /**
640 * Replaces all occurrences of search in the given string with replace.
641 *
642 * Allocates memory only if anything is replaced in the string. The original
643 * string is also returned if any of the arguments are invalid (e.g. if search
644 * is empty or any of them are NULL).
645 *
646 * @param str original string
647 * @param search string to search for and replace
648 * @param replace string to replace found occurrences with
649 * @return allocated string, if anything got replaced, str otherwise
650 */
651 char *strreplace(const char *str, const char *search, const char *replace);
652
653 /**
654 * Portable function to wait for SIGINT/SIGTERM (or equivalent).
655 */
656 void wait_sigint();
657
658 /**
659 * Like dirname(3) returns the directory part of the given null-terminated
660 * pathname, up to but not including the final '/' (or '.' if no '/' is found).
661 * Trailing '/' are not counted as part of the pathname.
662 *
663 * The difference is that it does this in a thread-safe manner (i.e. it does not
664 * use static buffers) and does not modify the original path.
665 *
666 * @param path original pathname
667 * @return allocated directory component
668 */
669 char *path_dirname(const char *path);
670
671 /**
672 * Like basename(3) returns the filename part of the given null-terminated path,
673 * i.e. the part following the final '/' (or '.' if path is empty or NULL).
674 * Trailing '/' are not counted as part of the pathname.
675 *
676 * The difference is that it does this in a thread-safe manner (i.e. it does not
677 * use static buffers) and does not modify the original path.
678 *
679 * @param path original pathname
680 * @return allocated filename component
681 */
682 char *path_basename(const char *path);
683
684 /**
685 * Check if a given path is absolute.
686 *
687 * @param path path to check
688 * @return TRUE if absolute, FALSE if relative
689 */
690 bool path_absolute(const char *path);
691
692 /**
693 * Creates a directory and all required parent directories.
694 *
695 * @param path path to the new directory
696 * @param mode permissions of the new directory/directories
697 * @return TRUE on success
698 */
699 bool mkdir_p(const char *path, mode_t mode);
700
701 #ifndef HAVE_CLOSEFROM
702 /**
703 * Close open file descriptors greater than or equal to lowfd.
704 *
705 * @param lowfd start closing file descriptors from here
706 */
707 void closefrom(int lowfd);
708 #endif
709
710 /**
711 * Get a timestamp from a monotonic time source.
712 *
713 * While the time()/gettimeofday() functions are affected by leap seconds
714 * and system time changes, this function returns ever increasing monotonic
715 * time stamps.
716 *
717 * @param tv timeval struct receiving monotonic timestamps, or NULL
718 * @return monotonic timestamp in seconds
719 */
720 time_t time_monotonic(timeval_t *tv);
721
722 /**
723 * Add the given number of milliseconds to the given timeval struct
724 *
725 * @param tv timeval struct to modify
726 * @param ms number of milliseconds
727 */
728 static inline void timeval_add_ms(timeval_t *tv, u_int ms)
729 {
730 tv->tv_usec += ms * 1000;
731 while (tv->tv_usec >= 1000000 /* 1s */)
732 {
733 tv->tv_usec -= 1000000;
734 tv->tv_sec++;
735 }
736 }
737
738 /**
739 * returns null
740 */
741 void *return_null();
742
743 /**
744 * No-Operation function
745 */
746 void nop();
747
748 /**
749 * returns TRUE
750 */
751 bool return_true();
752
753 /**
754 * returns FALSE
755 */
756 bool return_false();
757
758 /**
759 * returns FAILED
760 */
761 status_t return_failed();
762
763 /**
764 * returns SUCCESS
765 */
766 status_t return_success();
767
768 /**
769 * Write a 16-bit host order value in network order to an unaligned address.
770 *
771 * @param host host order 16-bit value
772 * @param network unaligned address to write network order value to
773 */
774 static inline void htoun16(void *network, u_int16_t host)
775 {
776 char *unaligned = (char*)network;
777
778 host = htons(host);
779 memcpy(unaligned, &host, sizeof(host));
780 }
781
782 /**
783 * Write a 32-bit host order value in network order to an unaligned address.
784 *
785 * @param host host order 32-bit value
786 * @param network unaligned address to write network order value to
787 */
788 static inline void htoun32(void *network, u_int32_t host)
789 {
790 char *unaligned = (char*)network;
791
792 host = htonl(host);
793 memcpy((char*)unaligned, &host, sizeof(host));
794 }
795
796 /**
797 * Write a 64-bit host order value in network order to an unaligned address.
798 *
799 * @param host host order 64-bit value
800 * @param network unaligned address to write network order value to
801 */
802 static inline void htoun64(void *network, u_int64_t host)
803 {
804 char *unaligned = (char*)network;
805
806 #ifdef be64toh
807 host = htobe64(host);
808 memcpy((char*)unaligned, &host, sizeof(host));
809 #else
810 u_int32_t high_part, low_part;
811
812 high_part = host >> 32;
813 high_part = htonl(high_part);
814 low_part = host & 0xFFFFFFFFLL;
815 low_part = htonl(low_part);
816
817 memcpy(unaligned, &high_part, sizeof(high_part));
818 unaligned += sizeof(high_part);
819 memcpy(unaligned, &low_part, sizeof(low_part));
820 #endif
821 }
822
823 /**
824 * Read a 16-bit value in network order from an unaligned address to host order.
825 *
826 * @param network unaligned address to read network order value from
827 * @return host order value
828 */
829 static inline u_int16_t untoh16(void *network)
830 {
831 char *unaligned = (char*)network;
832 u_int16_t tmp;
833
834 memcpy(&tmp, unaligned, sizeof(tmp));
835 return ntohs(tmp);
836 }
837
838 /**
839 * Read a 32-bit value in network order from an unaligned address to host order.
840 *
841 * @param network unaligned address to read network order value from
842 * @return host order value
843 */
844 static inline u_int32_t untoh32(void *network)
845 {
846 char *unaligned = (char*)network;
847 u_int32_t tmp;
848
849 memcpy(&tmp, unaligned, sizeof(tmp));
850 return ntohl(tmp);
851 }
852
853 /**
854 * Read a 64-bit value in network order from an unaligned address to host order.
855 *
856 * @param network unaligned address to read network order value from
857 * @return host order value
858 */
859 static inline u_int64_t untoh64(void *network)
860 {
861 char *unaligned = (char*)network;
862
863 #ifdef be64toh
864 u_int64_t tmp;
865
866 memcpy(&tmp, unaligned, sizeof(tmp));
867 return be64toh(tmp);
868 #else
869 u_int32_t high_part, low_part;
870
871 memcpy(&high_part, unaligned, sizeof(high_part));
872 unaligned += sizeof(high_part);
873 memcpy(&low_part, unaligned, sizeof(low_part));
874
875 high_part = ntohl(high_part);
876 low_part = ntohl(low_part);
877
878 return (((u_int64_t)high_part) << 32) + low_part;
879 #endif
880 }
881
882 /**
883 * Get the padding required to make size a multiple of alignment
884 */
885 static inline size_t pad_len(size_t size, size_t alignment)
886 {
887 size_t remainder;
888
889 remainder = size % alignment;
890 return remainder ? alignment - remainder : 0;
891 }
892
893 /**
894 * Round up size to be multiple of alignment
895 */
896 static inline size_t round_up(size_t size, size_t alignment)
897 {
898 return size + pad_len(size, alignment);
899 }
900
901 /**
902 * Round down size to be a multiple of alignment
903 */
904 static inline size_t round_down(size_t size, size_t alignment)
905 {
906 return size - (size % alignment);
907 }
908
909 /**
910 * Special type to count references
911 */
912 typedef u_int refcount_t;
913
914 /* use __atomic* built-ins with GCC 4.7 and newer */
915 #ifdef __GNUC__
916 # if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 6))
917 # define HAVE_GCC_ATOMIC_OPERATIONS
918 # endif
919 #endif
920
921 #ifdef HAVE_GCC_ATOMIC_OPERATIONS
922
923 #define ref_get(ref) __atomic_add_fetch(ref, 1, __ATOMIC_RELAXED)
924 /* The relaxed memory model works fine for increments as these (usually) don't
925 * change the state of refcounted objects. But here we have to ensure that we
926 * free the right stuff if ref counted objects are mutable. So we have to sync
927 * with other threads that call ref_put(). It would be sufficient to use
928 * __ATOMIC_RELEASE here and then call __atomic_thread_fence() with
929 * __ATOMIC_ACQUIRE if we reach 0, but since we don't have control over the use
930 * of ref_put() we have to make sure. */
931 #define ref_put(ref) (!__atomic_sub_fetch(ref, 1, __ATOMIC_ACQ_REL))
932 #define ref_cur(ref) __atomic_load_n(ref, __ATOMIC_RELAXED)
933
934 #define _cas_impl(ptr, oldval, newval) ({ typeof(oldval) _old = oldval; \
935 __atomic_compare_exchange_n(ptr, &_old, newval, FALSE, \
936 __ATOMIC_SEQ_CST, __ATOMIC_RELAXED); })
937 #define cas_bool(ptr, oldval, newval) _cas_impl(ptr, oldval, newval)
938 #define cas_ptr(ptr, oldval, newval) _cas_impl(ptr, oldval, newval)
939
940 #elif defined(HAVE_GCC_SYNC_OPERATIONS)
941
942 #define ref_get(ref) __sync_add_and_fetch(ref, 1)
943 #define ref_put(ref) (!__sync_sub_and_fetch(ref, 1))
944 #define ref_cur(ref) __sync_fetch_and_add(ref, 0)
945
946 #define cas_bool(ptr, oldval, newval) \
947 (__sync_bool_compare_and_swap(ptr, oldval, newval))
948 #define cas_ptr(ptr, oldval, newval) \
949 (__sync_bool_compare_and_swap(ptr, oldval, newval))
950
951 #else /* !HAVE_GCC_ATOMIC_OPERATIONS && !HAVE_GCC_SYNC_OPERATIONS */
952
953 /**
954 * Get a new reference.
955 *
956 * Increments the reference counter atomically.
957 *
958 * @param ref pointer to ref counter
959 * @return new value of ref
960 */
961 refcount_t ref_get(refcount_t *ref);
962
963 /**
964 * Put back a unused reference.
965 *
966 * Decrements the reference counter atomically and
967 * says if more references available.
968 *
969 * @param ref pointer to ref counter
970 * @return TRUE if no more references counted
971 */
972 bool ref_put(refcount_t *ref);
973
974 /**
975 * Get the current value of the reference counter.
976 *
977 * @param ref pointer to ref counter
978 * @return current value of ref
979 */
980 refcount_t ref_cur(refcount_t *ref);
981
982 /**
983 * Atomically replace value of ptr with newval if it currently equals oldval.
984 *
985 * @param ptr pointer to variable
986 * @param oldval old value of the variable
987 * @param newval new value set if possible
988 * @return TRUE if value equaled oldval and newval was written
989 */
990 bool cas_bool(bool *ptr, bool oldval, bool newval);
991
992 /**
993 * Atomically replace value of ptr with newval if it currently equals oldval.
994 *
995 * @param ptr pointer to variable
996 * @param oldval old value of the variable
997 * @param newval new value set if possible
998 * @return TRUE if value equaled oldval and newval was written
999 */
1000 bool cas_ptr(void **ptr, void *oldval, void *newval);
1001
1002 #endif /* HAVE_GCC_ATOMIC_OPERATIONS */
1003
1004 #ifndef HAVE_FMEMOPEN
1005 # ifdef HAVE_FUNOPEN
1006 # define HAVE_FMEMOPEN
1007 # define HAVE_FMEMOPEN_FALLBACK
1008 # include <stdio.h>
1009 /**
1010 * fmemopen(3) fallback using BSD funopen.
1011 *
1012 * We could also provide one using fopencookie(), but should we have it we
1013 * most likely have fmemopen().
1014 *
1015 * fseek() is currently not supported.
1016 */
1017 FILE *fmemopen(void *buf, size_t size, const char *mode);
1018 # endif /* FUNOPEN */
1019 #endif /* FMEMOPEN */
1020
1021 /**
1022 * printf hook for time_t.
1023 *
1024 * Arguments are:
1025 * time_t* time, bool utc
1026 */
1027 int time_printf_hook(printf_hook_data_t *data, printf_hook_spec_t *spec,
1028 const void *const *args);
1029
1030 /**
1031 * printf hook for time_t deltas.
1032 *
1033 * Arguments are:
1034 * time_t* begin, time_t* end
1035 */
1036 int time_delta_printf_hook(printf_hook_data_t *data, printf_hook_spec_t *spec,
1037 const void *const *args);
1038
1039 /**
1040 * printf hook for memory areas.
1041 *
1042 * Arguments are:
1043 * u_char *ptr, u_int len
1044 */
1045 int mem_printf_hook(printf_hook_data_t *data, printf_hook_spec_t *spec,
1046 const void *const *args);
1047
1048 #endif /** UTILS_H_ @}*/