4208ae6a9083a0e2e3a956c163808db1b72a761f
[paraslash.git] / para.h
1 /*
2 * Copyright (C) 1997-2013 Andre Noll <maan@systemlinux.org>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file para.h global paraslash definitions */
8
9 #include "config.h"
10
11 #include <sys/stat.h>
12 #include <fcntl.h>
13 #include <sys/wait.h>
14 #include <stdio.h>
15 #include <stdlib.h>
16 #include <time.h> /* time(), localtime() */
17 #include <unistd.h>
18 #include <errno.h>
19 #include <limits.h>
20 #include <stdarg.h>
21 #include <ctype.h>
22 #include <netinet/in.h>
23 #include <arpa/inet.h>
24 #include <sys/socket.h>
25 #include <sys/un.h> /* needed by create_pf_socket */
26 #include <string.h>
27 #include <assert.h>
28 #include <stdbool.h>
29 #include "gcc-compat.h"
30
31 /** used in various contexts */
32 #define MAXLINE 255
33
34 /** Compute the minimum of \a x and \a y. */
35 #define PARA_MIN(x, y) ({ \
36 typeof(x) _min1 = (x); \
37 typeof(y) _min2 = (y); \
38 (void) (&_min1 == &_min2); \
39 _min1 < _min2 ? _min1 : _min2; })
40
41 /** Compute the maximum of \a x and \a y. */
42 #define PARA_MAX(x, y) ({ \
43 typeof(x) _max1 = (x); \
44 typeof(y) _max2 = (y); \
45 (void) (&_max1 == &_max2); \
46 _max1 < _max2 ? _max2 : _max1; })
47
48 /** Compute the absolute value of \a x. */
49 #define PARA_ABS(x) ({ \
50 typeof(x) _x = (x); \
51 _x > 0? _x : -_x; })
52
53
54 extern __printf_2_3 void (*para_log)(int, const char*, ...);
55 /**
56 * Define a standard log function that always writes to stderr.
57 *
58 * \param funcname The name of the function to be defined.
59 *
60 * \param loglevel_barrier If the loglevel of the current message
61 * is less than that, the message is going to be ignored.
62 *
63 */
64 #define DEFINE_STDERR_LOGGER(funcname, loglevel_barrier) \
65 __printf_2_3 void funcname(int ll, const char* fmt,...) \
66 { \
67 va_list argp; \
68 if (ll < loglevel_barrier) \
69 return; \
70 va_start(argp, fmt); \
71 vfprintf(stderr, fmt, argp); \
72 va_end(argp); \
73 }
74 /**
75 * Define the standard log function and activate it.
76 *
77 * \param loglevel_barrier See \ref DEFINE_STDERR_LOGGER.
78 */
79 #define INIT_STDERR_LOGGING(loglevel_barrier) \
80 DEFINE_STDERR_LOGGER(stderr_log, loglevel_barrier); \
81 __printf_2_3 void (*para_log)(int, const char*, ...) = stderr_log;
82
83 /** Sent by para_client to initiate the authentication procedure. */
84 #define AUTH_REQUEST_MSG "auth rsa "
85 /** Sent by para_server for commands that expect a data file. */
86 #define AWAITING_DATA_MSG "\nAwaiting Data."
87 /** Sent by para_server if authentication was successful. */
88 #define PROCEED_MSG "Proceed."
89 /** Length of the \p PROCEED_MSG string. */
90 #define PROCEED_MSG_LEN strlen(PROCEED_MSG)
91 /** Sent by para_client to indicate the end of the command line. */
92 #define EOC_MSG "\nEnd of Command."
93
94 /* exec */
95 int para_exec_cmdline_pid(pid_t *pid, const char *cmdline, int *fds);
96
97 /* time */
98 int tv_diff(const struct timeval *b, const struct timeval *a, struct timeval *diff);
99 long unsigned tv2ms(const struct timeval*);
100 void d2tv(double, struct timeval*);
101 void tv_add(const struct timeval*, const struct timeval *, struct timeval *);
102 void tv_scale(const unsigned long, const struct timeval *, struct timeval *);
103 void tv_divide(const unsigned long divisor, const struct timeval *tv,
104 struct timeval *result);
105 int tv_convex_combination(const long a, const struct timeval *tv1,
106 const long b, const struct timeval *tv2,
107 struct timeval *result);
108 void ms2tv(const long unsigned n, struct timeval *tv);
109 void compute_chunk_time(long unsigned chunk_num,
110 struct timeval *chunk_tv, struct timeval *stream_start,
111 struct timeval *result);
112
113 /** The enum of all status items. */
114 enum status_items {STATUS_ITEM_ENUM NUM_STAT_ITEMS};
115 extern const char *status_item_list[];
116 /** Loop over each status item. */
117 #define FOR_EACH_STATUS_ITEM(i) for (i = 0; i < NUM_STAT_ITEMS; i++)
118 int for_each_stat_item(char *item_buf, size_t num_bytes,
119 int (*item_handler)(int, char *));
120
121
122 /**
123 * Return a random non-negative integer in an interval.
124 *
125 * \param max Determines maximal possible return value.
126 *
127 * \return An integer between zero and \p max - 1, inclusively.
128 */
129 _static_inline_ long int para_random(unsigned max)
130 {
131 return ((max + 0.0) * (random() / (RAND_MAX + 1.0)));
132 }
133
134 /**
135 * Simple sanity check for I/O vectors.
136 *
137 * \param iov Pointer to the I/O vector to check.
138 *
139 * \return True if \a iov points to a non-empty buffer.
140 */
141 _static_inline_ bool iov_valid(const struct iovec *iov)
142 {
143 return iov && iov->iov_len > 0 && iov->iov_base;
144 }
145
146 /** Round up x to next multiple of y. */
147 #define ROUND_UP(x, y) ({ \
148 const typeof(y) _divisor = y; \
149 ((x) + _divisor - 1) / _divisor * _divisor; })
150
151 /** Round down x to multiple of y. */
152 #define ROUND_DOWN(x, y) ({ \
153 const typeof(y) _divisor = y; \
154 (x) / _divisor * _divisor; })
155
156 /** Divide and round up to next integer. */
157 #define DIV_ROUND_UP(x, y) ({ \
158 typeof(y) _divisor = y; \
159 ((x) + _divisor - 1) / _divisor; })
160
161 /**
162 * Assert a build-time dependency, as an expression.
163 *
164 * \param cond The compile-time condition which must be true.
165 *
166 * Compilation will fail if the condition isn't true, or can't be evaluated by
167 * the compiler. This can be used in an expression: its value is "0".
168 *
169 * Taken from ccan.
170 */
171 #define EXPR_BUILD_ASSERT(cond) (sizeof(char [1 - 2 * !(cond)]) - 1)
172
173 /** &a[0] degrades to a pointer: a different type from an array */
174 #define _array_size_chk(arr) EXPR_BUILD_ASSERT(\
175 !__builtin_types_compatible_p(typeof(arr), typeof(&(arr)[0])))
176 /** Get the size of an array */
177 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + _array_size_chk(arr))
178
179 /**
180 * Wrapper for isspace.
181 * NetBSD needs this.
182 */
183 /*
184 * The values should be cast to an unsigned char first, then to int.
185 * Why? Because the isdigit (as do all other is/to functions/macros)
186 * expect a number from 0 upto and including 255 as their (int) argument.
187 * Because char is signed on most systems, casting it to int immediately
188 * gives the functions an argument between -128 and 127 (inclusive),
189 * which they will use as an array index, and which will thus fail
190 * horribly for characters which have their most significant bit set.
191 */
192 #define para_isspace(c) isspace((int)(unsigned char)(c))
193
194 /** Data that indicates an eof-condition for a fec-encoded stream. */
195 #define FEC_EOF_PACKET "\xec\x0d\xcc\xfe\0\0\0\0" \
196 "\0\0\0\0\0\0\0\0" "\0\0\0\0\0\0\0\0" "\0\0\0\0\0\0\0\0"
197 /** The number of bytes of the \a FEC_EOF_PACKET. */
198 #define FEC_EOF_PACKET_LEN 32
199
200 /** Used to avoid a shortcoming in vim's syntax highlighting. */
201 #define EMBRACE(...) { __VA_ARGS__}
202
203 /** A nice cup of STFU for Mr gcc. */
204 #define do_nothing do {/* nothing */} while (0)
205
206 /**
207 * The sample formats supported by paraslash.
208 *
209 * It may be determined by one of the following sources:
210 *
211 * 1. The decoding filter (para_audiod only). In this case, it is always
212 * \p SF_S16_LE which is the canonical format used within decoders.
213 *
214 * 2. The wav header (para_write only).
215 *
216 * 3. The --format option of para_write.
217 */
218 #define SAMPLE_FORMATS \
219 SAMPLE_FORMAT(SF_S8, "8 bit signed"), \
220 SAMPLE_FORMAT(SF_U8, "8 bit unsigned"), \
221 SAMPLE_FORMAT(SF_S16_LE, "16 bit signed, little endian"), \
222 SAMPLE_FORMAT(SF_S16_BE, "16 bit signed, big endian"), \
223 SAMPLE_FORMAT(SF_U16_LE, "16 bit unsigned, little endian"), \
224 SAMPLE_FORMAT(SF_U16_BE, "16 bit unsigned, big endian"), \
225
226 /** \cond sample_format */
227 #define SAMPLE_FORMAT(a, b) a
228 enum sample_format {SAMPLE_FORMATS};
229 #undef SAMPLE_FORMAT
230 #define SAMPLE_FORMAT(a, b) b
231 /** \endcond sample_format */
232
233 /** Debug loglevel, gets really noisy. */
234 #define LL_DEBUG 0
235 /** Still noisy, but won't fill your disk. */
236 #define LL_INFO 1
237 /** Normal, but significant event. */
238 #define LL_NOTICE 2
239 /** Unexpected event that can be handled. */
240 #define LL_WARNING 3
241 /** Unhandled error condition. */
242 #define LL_ERROR 4
243 /** System might be unreliable. */
244 #define LL_CRIT 5
245 /** Last message before exit. */
246 #define LL_EMERG 6
247 /** Number of all loglevels. */
248 #define NUM_LOGLEVELS 7
249
250 /** Log messages with lower priority than that will not be compiled in. */
251 #define COMPILE_TIME_LOGLEVEL 0
252
253 /** \cond log */
254 #if LL_DEBUG >= COMPILE_TIME_LOGLEVEL
255 #define PARA_DEBUG_LOG(f,...) para_log(LL_DEBUG, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
256 #else
257 #define PARA_DEBUG_LOG(...) do {;} while (0)
258 #endif
259
260 #if LL_INFO >= COMPILE_TIME_LOGLEVEL
261 #define PARA_INFO_LOG(f,...) para_log(LL_INFO, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
262 #else
263 #define PARA_INFO_LOG(...) do {;} while (0)
264 #endif
265
266 #if LL_NOTICE >= COMPILE_TIME_LOGLEVEL
267 #define PARA_NOTICE_LOG(f,...) para_log(LL_NOTICE, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
268 #else
269 #define PARA_NOTICE_LOG(...) do {;} while (0)
270 #endif
271
272 #if LL_WARNING >= COMPILE_TIME_LOGLEVEL
273 #define PARA_WARNING_LOG(f,...) para_log(LL_WARNING, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
274 #else
275 #define PARA_WARNING_LOG(...) do {;} while (0)
276 #endif
277
278 #if LL_ERROR >= COMPILE_TIME_LOGLEVEL
279 #define PARA_ERROR_LOG(f,...) para_log(LL_ERROR, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
280 #else
281 #define PARA_ERROR_LOG(...) do {;} while (0)
282 #endif
283
284 #if LL_CRIT >= COMPILE_TIME_LOGLEVEL
285 #define PARA_CRIT_LOG(f,...) para_log(LL_CRIT, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
286 #else
287 #define PARA_CRIT_LOG(...) do {;} while (0)
288 #endif
289
290 #if LL_EMERG >= COMPILE_TIME_LOGLEVEL
291 #define PARA_EMERG_LOG(f,...) para_log(LL_EMERG, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
292 #else
293 #define PARA_EMERG_LOG(...)
294 #endif
295 /** \endcond log */