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