First draft of the dccp sender/receiver pair.
[paraslash.git] / error.h
1 /*
2 * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
17 */
18
19 /** \file error.h list of error messages for all subsystems */
20
21 /** \cond list of all subsystems that support the shiny new error facility */
22 enum para_subsystem {SS_RECV,
23 SS_NET, SS_ORTP_RECV, SS_AUDIOD, SS_EXEC, SS_CLOSE_ON_FORK, SS_SIGNAL,
24 SS_STRING, SS_DAEMON, SS_STAT, SS_TIME, SS_GRAB_CLIENT, SS_HTTP_RECV,
25 SS_RECV_COMMON, SS_FILTER_CHAIN, SS_WAV, SS_COMPRESS, SS_OGGDEC, SS_FILTER,
26 SS_COMMAND, SS_RANDOM_DBTOOL, SS_PLM_DBTOOL, SS_CRYPT, SS_HTTP_SEND, SS_ORTP_SEND, SS_DB, SS_OGG,
27 SS_MP3, SS_MP3DEC, SS_SERVER, SS_AFS, SS_MYSQL, SS_IPC, SS_DCCP, SS_DCCP_RECV,
28 SS_DCCP_SEND, SS_RINGBUFFER};
29 #define NUM_SS (SS_RINGBUFFER + 1)
30 extern const char **para_errlist[];
31 /** \endcond */
32
33 #define NET_ERRORS \
34 PARA_ERROR(SEND, "send error"), \
35 PARA_ERROR(RECV, "receive error"), \
36 PARA_ERROR(SOCKET, "socket error"), \
37 PARA_ERROR(CONNECT, "connect error"), \
38 PARA_ERROR(ACCEPT, "accept error"), \
39 PARA_ERROR(SETSOCKOPT, "failed to set socket options"), \
40 PARA_ERROR(BIND, "bind error"), \
41 PARA_ERROR(NAME_TOO_LONG, "name too long for struct sockaddr_un"), \
42 PARA_ERROR(CHMOD, "failed to set socket mode"), \
43 PARA_ERROR(SENDMSG, "sendmsg() failed"), \
44 PARA_ERROR(RECVMSG, "recvmsg() failed"), \
45 PARA_ERROR(SCM_CREDENTIALS, "did not receive SCM credentials"), \
46 PARA_ERROR(LISTEN, "listen error"), \
47 PARA_ERROR(RECV_PATTERN, "did not receive expected pattern"), \
48 PARA_ERROR(HOST_INFO, "gethostbyname() failed"), \
49
50
51 #define ORTP_RECV_ERRORS \
52 PARA_ERROR(MSG_TO_BUF, "failed to extract rtp packet"), \
53 PARA_ERROR(ORTP_SYNTAX, "ottp syntax error"), \
54 PARA_ERROR(TOO_MANY_BAD_CHUNKS, "too many consecutive bad chunks"), \
55 PARA_ERROR(INVALID_HEADER, "invalid header packet"), \
56 PARA_ERROR(OVERRUN, "outout buffer overrun"), \
57
58
59 #define HTTP_RECV_ERRORS \
60 PARA_ERROR(SEND_HTTP_REQUEST, "failed to send http request"), \
61 PARA_ERROR(MISSING_OK, "did not receive OK message from peer"), \
62 PARA_ERROR(HTTP_RECV_BUF, "did not receive buffer")
63
64
65 #define RECV_ERRORS \
66 PARA_ERROR(RECV_SELECT, "recv select error"), \
67 PARA_ERROR(WRITE_STDOUT, "stdout write error"), \
68
69
70 #define RECV_COMMON_ERRORS \
71 PARA_ERROR(RECV_SYNTAX, "recv syntax error"), \
72
73
74 #define AUDIOD_ERRORS \
75 PARA_ERROR(WRITE_AUDIO_DATA, "failed to write audio data"), \
76 PARA_ERROR(NO_MORE_SLOTS, "no more empty slots"), \
77 PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
78 PARA_ERROR(UNSUPPORTED_AUDIO_FORMAT, "given audio format not supported"), \
79 PARA_ERROR(CLIENT_WRITE, "client write error"), \
80 PARA_ERROR(UCRED_PERM, "permission denied"), \
81 PARA_ERROR(INVALID_AUDIOD_CMD, "invalid command"), \
82
83
84 #define FILTER_CHAIN_ERRORS \
85 PARA_ERROR(UNSUPPORTED_FILTER, "given filter not supported"), \
86 PARA_ERROR(BAD_FILTER_OPTIONS, "invalid filter option given"), \
87
88
89 #define STAT_ERRORS \
90 PARA_ERROR(TOO_MANY_CLIENTS, "maximal number of stat clients exceeded"), \
91 PARA_ERROR(UNKNOWN_STAT_ITEM, "status item not recognized"), \
92
93
94 #define OGGDEC_ERRORS \
95 PARA_ERROR(OGGDEC_READ, "read from media returned an error"), \
96 PARA_ERROR(OGGDEC_NOTVORBIS, "bitstream is not vorbis data"), \
97 PARA_ERROR(OGGDEC_VERSION, "vorbis version mismatch"), \
98 PARA_ERROR(OGGDEC_BADHEADER, "invalid vorbis bitstream header"), \
99 PARA_ERROR(OGGDEC_FAULT, "bug or heap/stack corruption"), \
100 PARA_ERROR(OGGDEC_BADLINK, "invalid stream section or requested link corrupt"), \
101
102
103 #define GRAB_CLIENT_ERRORS \
104 PARA_ERROR(PEDANTIC_GRAB, "fd not ready and pedantic grab requested"), \
105 PARA_ERROR(GC_WRITE, "grab client write error"), \
106 PARA_ERROR(INVALID_GRAB_MODE, "invalid grab client mode"), \
107 PARA_ERROR(BAD_GC_SLOT, "invalid slot requested by grab client"), \
108 PARA_ERROR(BAD_GC_FILTER_NUM, "invalid filter number given"), \
109 PARA_ERROR(GC_SYNTAX, "grab client syntax error"), \
110 PARA_ERROR(GC_HELP_GIVEN, ""), /* not really an error */ \
111
112
113 #define MP3DEC_ERRORS \
114 PARA_ERROR(MAD_FRAME_DECODE, "mad frame decode error"), \
115 PARA_ERROR(MP3DEC_OVERRUN, "mp3 output buffer overrun"), \
116
117
118 #define FILTER_ERRORS \
119 PARA_ERROR(NO_FILTERS, "at least one filter must be given"), \
120 PARA_ERROR(FILTER_SYNTAX, "syntax error"), \
121
122
123 #define SIGNAL_ERRORS \
124 PARA_ERROR(SIGNAL_SIG_ERR, "signal() retured SIG_ERR"), \
125 PARA_ERROR(SIGNAL_READ, "read error from signal pipe"), \
126 PARA_ERROR(WAITPID, "waitpid error"), \
127
128
129 #define STRING_ERRORS \
130 PARA_ERROR(MKSTEMP, "mkstemp error: unable to create tmp file"), \
131 PARA_ERROR(FCHMOD, "fchmod error: can not set mode"), \
132
133
134 #define EXEC_ERRORS \
135 PARA_ERROR(DUP_PIPE, "exec error: can not create pipe"), \
136 PARA_ERROR(NULL_OPEN, "can not open /dev/null"), \
137
138
139 #define MP3_ERRORS \
140 PARA_ERROR(FREAD, "fread error"), \
141 PARA_ERROR(FSEEK, "fseek error"), \
142 PARA_ERROR(FRAME, "invalid mp3 frame"), \
143 PARA_ERROR(FRAME_LENGTH, "invalid frame length"), \
144 PARA_ERROR(MP3_NO_FILE, "invalid mp3 file pointer"), \
145 PARA_ERROR(MP3_INFO, "could not read mp3 info"), \
146 PARA_ERROR(MP3_REPOS, "mp3 repositioning error"), \
147 PARA_ERROR(HEADER_FREQ, "invalid header frequency"), \
148 PARA_ERROR(HEADER_BITRATE, "invalid header bitrate"), \
149
150
151 #define OGG_ERRORS \
152 PARA_ERROR(OGG_READ, "ogg read error"), \
153 PARA_ERROR(SYNC_PAGEOUT, "ogg sync page-out error (no ogg file?)"), \
154 PARA_ERROR(STREAM_PAGEIN, "ogg stream page-in error (first page)"), \
155 PARA_ERROR(STREAM_PACKETOUT, "ogg stream packet-out error (first packet)"), \
156 PARA_ERROR(VORBIS, "vorbis synthesis header-in error (not vorbis?)"), \
157 PARA_ERROR(OGG_NO_FILE, "invalid ogg file pointer"), \
158 PARA_ERROR(OGG_OPEN, "ov_open error"), \
159 PARA_ERROR(OGG_INFO, "ov_info error"), \
160 PARA_ERROR(OGG_REPOS, "ogg repositioning error"), \
161
162
163 #define AFS_ERRORS \
164 PARA_ERROR(AUDIO_FORMAT, "audio format not recognized"), \
165 PARA_ERROR(FSTAT, "failed to fstat() audio file"), \
166
167
168 #define DB_ERRORS \
169 PARA_ERROR(GETCWD, "can not get current working directory"), \
170 PARA_ERROR(CHDIR, "can not change directory"), \
171 PARA_ERROR(OPENDIR, "can not open directory"), \
172 PARA_ERROR(LSTAT, "lstat error"), \
173
174
175 #define CRYPT_ERRORS \
176 PARA_ERROR(PRIVATE_KEY, "can not read private key"), \
177 PARA_ERROR(PUBLIC_KEY, "can not read public key"), \
178 PARA_ERROR(RSA, "RSA error"), \
179 PARA_ERROR(ENCRYPT, "encrypt error"), \
180 PARA_ERROR(DECRYPT, "decrypt error"), \
181 PARA_ERROR(CHALLENGE, "failed to read challenge"), \
182
183
184 #define HTTP_SEND_ERRORS \
185 PARA_ERROR(QUEUE, "packet queue overrun"), \
186 PARA_ERROR(WRITE_OK, "can not check whether fd is writable"), \
187
188
189 #define RANDOM_DBTOOL_ERRORS \
190 PARA_ERROR(FILE_COUNT, "audio file count exceeded"), \
191 PARA_ERROR(NOTHING_FOUND, "no audio files found"), \
192
193
194 #define MYSQL_ERRORS \
195 PARA_ERROR(MYSQL_SYNTAX, "mysql syntax error"), \
196 PARA_ERROR(NOTCONN, "not connected to mysql server"), \
197 PARA_ERROR(TOOBIG, "mysql: file too large"), \
198 PARA_ERROR(NAMETOOLONG, "mysql: name too long"), \
199 PARA_ERROR(QFAILED, "mysql query failed"), \
200 PARA_ERROR(NOROW, "row is NULL"), \
201 PARA_ERROR(NOATTS, "can not get attributes from mysql table"), \
202 PARA_ERROR(NORESULT, "error while fetching mysql result"), \
203 PARA_ERROR(EMPTY_RESULT, "result is empty"), \
204 PARA_ERROR(ESCAPE, "can not escape string"), \
205 PARA_ERROR(GET_AUDIO_FILE, "can not get current audio file"), \
206 PARA_ERROR(GET_STREAM, "can not get current stream"), \
207 PARA_ERROR(NO_STREAM, "no such stream"), \
208 PARA_ERROR(GET_QUERY, "can not get query for specified stream"), \
209 PARA_ERROR(TMPFILE, "error while writing temporary file"), \
210 PARA_ERROR(META, "can not get meta data"), \
211 PARA_ERROR(MYSQL_INIT, "can not initialize mysql connection"), \
212 PARA_ERROR(NO_MYSQL_PASSWD, "fatal: no mysql passord given"), \
213 PARA_ERROR(NO_AF_DIR, "fatal: audio file directory not given"), \
214
215
216 #define COMMAND_ERRORS \
217 PARA_ERROR(COMMAND_SYNTAX, "syntax error in command"), \
218 PARA_ERROR(AUTH, "did not receive auth request"), \
219 PARA_ERROR(BAD_DBTOOL, "no such database tool"), \
220 PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
221 PARA_ERROR(BAD_CMD, "invalid command"), \
222 PARA_ERROR(PERM, "permission denied"), \
223 PARA_ERROR(USERLIST, "failed to open user list file"), \
224 PARA_ERROR(BAD_USER, "you don't exist. Go away."), \
225 PARA_ERROR(LOCK, "lock error"), \
226 PARA_ERROR(SENDER_CMD, "command not supported by this sender"), \
227
228 #define PLM_DBTOOL_ERRORS \
229 PARA_ERROR(LOAD_PLAYLIST, "failed to load playlist"), \
230
231
232 #define IPC_ERRORS \
233 PARA_ERROR(SEM_GET, "failed to create semaphore"), \
234 PARA_ERROR(SEM_REMOVE, "can not remove semaphore"), \
235 PARA_ERROR(SHM_GET, "failed to allocate shared memory area"), \
236 PARA_ERROR(SHM_DESTROY, "failed to destroy shared memory area"), \
237 PARA_ERROR(SHM_ATTACH, "can not attach shared memory area"), \
238 PARA_ERROR(SHM_DETACH, "can not detach shared memory area"), \
239
240
241 #define DCCP_ERRORS \
242 PARA_ERROR(DCCP_SOCKET, "can not create dccp socket"), \
243 PARA_ERROR(DCCP_PACKET_SIZE, "failed to set dccp packet size"), \
244 PARA_ERROR(DCCP_SERVICE, "could not get service code"), \
245
246
247 #define DCCP_RECV_ERRORS \
248 PARA_ERROR(ADDR_INFO, "getaddrinfo error"), \
249 PARA_ERROR(DCCP_OVERRUN, "dccp output buffer buffer overrun"), \
250 PARA_ERROR(DCCP_CONNECT, "dccp connect error"), \
251
252 #define DCCP_SEND_ERRORS \
253 PARA_ERROR(DCCP_BIND, "dccp bind error"), \
254 PARA_ERROR(DCCP_LISTEN, "dccp listen error"), \
255
256
257 /* these do not need error handling (yet) */
258 #define SERVER_ERRORS
259 #define WAV_ERRORS
260 #define COMPRESS_ERRORS
261 #define TIME_ERRORS
262 #define CLOSE_ON_FORK_ERRORS
263 #define DAEMON_ERRORS
264 #define ORTP_SEND_ERRORS
265 #define RINGBUFFER_ERRORS
266
267
268 /**
269 * the subsystem shift
270 *
271 * 255 error codes ought to be enough for every subsystem. Use the higher bits
272 * of the return value to encode the subsystem number
273 */
274 #define SS_SHIFT 8
275
276 /**
277 * compute the subsystem offset
278 *
279 * It is given by x * 2**8 where \a x is the subsystem number
280 */
281 #define SS_OFFSET(ss) (SS_ ## ss << SS_SHIFT)
282
283 /**
284 * make the enum of all errors of one subsystem
285 *
286 * As zero should not be an error, we define a dummy enum entry with value
287 * 2**ss. That lets the real errors start at 2**ss + 1.
288 */
289 #define SS_ENUM(ss) enum {\
290 E_ ## ss ## _DUMMY = SS_OFFSET(ss), \
291 ss ## _ERRORS}
292
293 /**
294 * determine the subsystem number from the error number
295 *
296 * Easy, it's just \a num / 2**8.
297 */
298 #define ERRNUM_TO_SS(num) ((num) >> SS_SHIFT)
299
300 /**
301 * determine the index of an error number
302 *
303 * Also easy: It's the lower 8 bits of num - 1.
304 */
305 #define ERRNUM_TO_INDEX(num) (((1 << SS_SHIFT) - 1) & ((num) - 1))
306
307 /**
308 * paraslash's version of strerror(3)
309 *
310 * expands to the error text of \a num (a string constant).
311 */
312 #define PARA_STRERROR(num) para_errlist[ERRNUM_TO_SS(num)] [ERRNUM_TO_INDEX(num)]
313
314 /**
315 * define the error list for one subsystem
316 *
317 * Used by macros in config.h (generated by configure)
318 */
319 #define DEFINE_ERRLIST(ss) const char * ss ## _ERRLIST[] = {ss ## _ERRORS}
320
321 /**
322 * activate errors for one subsystem.
323 *
324 * Each executable needs only the error lists of those subssystems it is actually
325 * linked with. We always reserve zeroed-out space for NUM_SS char ** pointers, but
326 * only init those of the needed subsystems. This macro is used by macros in config.h
327 * (generated by configure).
328 */
329 #define PARA_ERRLIST(ss) [SS_ ## ss] = ss ## _ERRLIST
330
331 /**
332 * This is temporarily defined to expand to its second argument (prefixed by
333 * 'E_') and gets later redefined to expand to the error text only
334 */
335 #define PARA_ERROR(err, msg) E_ ## err
336
337 /** \cond popcorn time */
338 SS_ENUM(ORTP_RECV);
339 SS_ENUM(NET);
340 SS_ENUM(RECV);
341 SS_ENUM(AUDIOD);
342 SS_ENUM(EXEC);
343 SS_ENUM(CLOSE_ON_FORK);
344 SS_ENUM(SIGNAL);
345 SS_ENUM(STRING);
346 SS_ENUM(DAEMON);
347 SS_ENUM(STAT);
348 SS_ENUM(TIME);
349 SS_ENUM(GRAB_CLIENT);
350 SS_ENUM(HTTP_RECV);
351 SS_ENUM(RECV_COMMON);
352 SS_ENUM(FILTER_CHAIN);
353 SS_ENUM(WAV);
354 SS_ENUM(COMPRESS);
355 SS_ENUM(OGGDEC);
356 SS_ENUM(MP3DEC);
357 SS_ENUM(FILTER);
358 SS_ENUM(MP3);
359 SS_ENUM(OGG);
360 SS_ENUM(SERVER);
361 SS_ENUM(AFS);
362 SS_ENUM(COMMAND);
363 SS_ENUM(RANDOM_DBTOOL);
364 SS_ENUM(PLM_DBTOOL);
365 SS_ENUM(CRYPT);
366 SS_ENUM(HTTP_SEND);
367 SS_ENUM(ORTP_SEND);
368 SS_ENUM(DB);
369 SS_ENUM(MYSQL);
370 SS_ENUM(IPC);
371 SS_ENUM(DCCP);
372 SS_ENUM(DCCP_RECV);
373 SS_ENUM(DCCP_SEND);
374 SS_ENUM(RINGBUFFER);
375 /** \endcond */
376 #undef PARA_ERROR
377 /* rest of the world only sees the error text */
378 #define PARA_ERROR(err, msg) msg