utils: Provide a fallback for sigwaitinfo() if needed
[strongswan.git] / src / libstrongswan / utils / utils.h
1 /*
2 * Copyright (C) 2008-2015 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 # include <signal.h>
42 #endif
43
44 #include "utils/types.h"
45 #include "enum.h"
46 #include "utils/atomics.h"
47 #include "utils/align.h"
48 #include "utils/byteorder.h"
49 #include "utils/string.h"
50 #include "utils/memory.h"
51 #include "utils/strerror.h"
52 #include "utils/status.h"
53 #include "utils/object.h"
54 #include "utils/path.h"
55 #include "utils/time.h"
56 #include "utils/tty.h"
57 #ifdef __APPLE__
58 # include "compat/apple.h"
59 #endif
60 #ifdef __ANDROID__
61 # include "compat/android.h"
62 #endif
63
64 /**
65 * Initialize utility functions
66 */
67 void utils_init();
68
69 /**
70 * Deinitialize utility functions
71 */
72 void utils_deinit();
73
74 /**
75 * strongSwan program return codes
76 */
77 #define SS_RC_LIBSTRONGSWAN_INTEGRITY 64
78 #define SS_RC_DAEMON_INTEGRITY 65
79 #define SS_RC_INITIALIZATION_FAILED 66
80
81 #define SS_RC_FIRST SS_RC_LIBSTRONGSWAN_INTEGRITY
82 #define SS_RC_LAST SS_RC_INITIALIZATION_FAILED
83
84 /**
85 * Number of bits in a byte
86 */
87 #define BITS_PER_BYTE 8
88
89 /**
90 * Default length for various auxiliary text buffers
91 */
92 #define BUF_LEN 512
93
94 /**
95 * Build assertion macro for integer expressions, evaluates to 0
96 */
97 #define BUILD_ASSERT(x) (sizeof(char[(x) ? 0 : -1]))
98
99 /**
100 * Build time check to assert a is an array, evaluates to 0
101 *
102 * The address of an array element has a pointer type, which is not compatible
103 * to the array type.
104 */
105 #define BUILD_ASSERT_ARRAY(a) \
106 BUILD_ASSERT(!__builtin_types_compatible_p(typeof(a), typeof(&(a)[0])))
107
108 /**
109 * Debug macro to follow control flow
110 */
111 #define POS printf("%s, line %d\n", __FILE__, __LINE__)
112
113 /**
114 * This macro allows counting the number of arguments passed to a macro.
115 * Combined with the VA_ARGS_DISPATCH() macro this can be used to implement
116 * macro overloading based on the number of arguments.
117 * 0 to 10 arguments are currently supported.
118 */
119 #define VA_ARGS_NUM(...) _VA_ARGS_NUM(0,##__VA_ARGS__,10,9,8,7,6,5,4,3,2,1,0)
120 #define _VA_ARGS_NUM(_0,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,NUM,...) NUM
121
122 /**
123 * This macro can be used to dispatch a macro call based on the number of given
124 * arguments, for instance:
125 *
126 * @code
127 * #define MY_MACRO(...) VA_ARGS_DISPATCH(MY_MACRO, __VA_ARGS__)(__VA_ARGS__)
128 * #define MY_MACRO1(arg) one_arg(arg)
129 * #define MY_MACRO2(arg1,arg2) two_args(arg1,arg2)
130 * @endcode
131 *
132 * MY_MACRO() can now be called with either one or two arguments, which will
133 * resolve to one_arg(arg) or two_args(arg1,arg2), respectively.
134 */
135 #define VA_ARGS_DISPATCH(func, ...) _VA_ARGS_DISPATCH(func, VA_ARGS_NUM(__VA_ARGS__))
136 #define _VA_ARGS_DISPATCH(func, num) __VA_ARGS_DISPATCH(func, num)
137 #define __VA_ARGS_DISPATCH(func, num) func ## num
138
139 /**
140 * Macro to allocate a sized type.
141 */
142 #define malloc_thing(thing) ((thing*)malloc(sizeof(thing)))
143
144 /**
145 * Get the number of elements in an array
146 */
147 #define countof(array) (sizeof(array)/sizeof((array)[0]) \
148 + BUILD_ASSERT_ARRAY(array))
149
150 /**
151 * Ignore result of functions tagged with warn_unused_result attributes
152 */
153 #define ignore_result(call) { if(call){}; }
154
155 #if !defined(HAVE_SIGWAITINFO) && !defined(WIN32)
156 /**
157 * Block and wait for a set of signals
158 *
159 * We don't replicate the functionality of siginfo_t. If info is not NULL
160 * -1 is returend and errno is set to EINVAL.
161 *
162 * @param set set of signals to wait for
163 * @param info must be NULL
164 */
165 int sigwaitinfo(const sigset_t *set, void *info);
166 #endif
167
168 /**
169 * Portable function to wait for SIGINT/SIGTERM (or equivalent).
170 */
171 void wait_sigint();
172
173 #ifndef HAVE_CLOSEFROM
174 /**
175 * Close open file descriptors greater than or equal to lowfd.
176 *
177 * @param lowfd start closing file descriptors from here
178 */
179 void closefrom(int lowfd);
180 #endif
181
182 /**
183 * returns null
184 */
185 void *return_null();
186
187 /**
188 * No-Operation function
189 */
190 void nop();
191
192 /**
193 * returns TRUE
194 */
195 bool return_true();
196
197 /**
198 * returns FALSE
199 */
200 bool return_false();
201
202 #endif /** UTILS_H_ @}*/