2 * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
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.
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.
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.
19 /** \file error.h list of error messages for all subsystems */
21 /** \cond list of all subsystems that support the shiny error facility */
78 /* these do not need error handling (yet) */
81 #define COMPRESS_ERRORS
83 #define CLOSE_ON_FORK_ERRORS
85 #define ORTP_SEND_ERRORS
87 #define RINGBUFFER_ERRORS
91 extern const char **para_errlist[];
94 #define AUDIOC_ERRORS \
95 PARA_ERROR(AUDIOC_SYNTAX, "audioc syntax error"), \
96 PARA_ERROR(AUDIOC_READ, "audioc read error"), \
97 PARA_ERROR(AUDIOC_WRITE, "audioc write error"), \
98 PARA_ERROR(INIT_SOCK_ADDR, "can not init socket"), \
99 PARA_ERROR(AUDIOC_CONNECT, "audioc connect error"), \
100 PARA_ERROR(AUDIOC_OVERRUN, "audioc buffer overrun"), \
103 #define CLIENT_ERRORS \
104 PARA_ERROR(CLIENT_SYNTAX, "syntax error"), \
105 PARA_ERROR(INVALID_CHALLENGE, "did not receive valid challenge"), \
106 PARA_ERROR(CLIENT_AUTH, "authentication failed"), \
107 PARA_ERROR(SHORT_CLIENT_WRITE, "short client write"), \
108 PARA_ERROR(NO_CONFIG, "config file not found"), \
109 PARA_ERROR(SERVER_EOF, "connection closed by para_server"), \
110 PARA_ERROR(INPUT_EOF, "end of input"), \
111 PARA_ERROR(HANDSHAKE_COMPLETE, ""), /* not really an error */ \
114 #define SCHED_ERRORS \
115 PARA_ERROR(TASK_KILLED, "task killed"), \
116 PARA_ERROR(NO_SUCH_TASK, "task not found"), \
117 PARA_ERROR(NOT_INITIALIZED, "scheduler not yet initialized"), \
120 #define STDIN_ERRORS \
121 PARA_ERROR(STDIN_READ, "failed to read from stdin"), \
122 PARA_ERROR(STDIN_EOF, "end of file"), \
125 #define STDOUT_ERRORS \
126 PARA_ERROR(STDOUT_WRITE, "failed to write to stdout"), \
127 PARA_ERROR(STDOUT_EOF, "end of file"), \
131 PARA_ERROR(SEND, "send error"), \
132 PARA_ERROR(RECV, "receive error"), \
133 PARA_ERROR(SOCKET, "socket error"), \
134 PARA_ERROR(CONNECT, "connect error"), \
135 PARA_ERROR(ACCEPT, "accept error"), \
136 PARA_ERROR(SETSOCKOPT, "failed to set socket options"), \
137 PARA_ERROR(BIND, "bind error"), \
138 PARA_ERROR(NAME_TOO_LONG, "name too long for struct sockaddr_un"), \
139 PARA_ERROR(CHMOD, "failed to set socket mode"), \
140 PARA_ERROR(SENDMSG, "sendmsg() failed"), \
141 PARA_ERROR(RECVMSG, "recvmsg() failed"), \
142 PARA_ERROR(SCM_CREDENTIALS, "did not receive SCM credentials"), \
143 PARA_ERROR(LISTEN, "listen error"), \
144 PARA_ERROR(RECV_PATTERN, "did not receive expected pattern"), \
145 PARA_ERROR(HOST_INFO, "gethostbyname() failed"), \
148 #define ORTP_RECV_ERRORS \
149 PARA_ERROR(MSG_TO_BUF, "failed to extract rtp packet"), \
150 PARA_ERROR(ORTP_SYNTAX, "ottp syntax error"), \
151 PARA_ERROR(TOO_MANY_BAD_CHUNKS, "too many consecutive bad chunks"), \
152 PARA_ERROR(INVALID_HEADER, "invalid header packet"), \
153 PARA_ERROR(OVERRUN, "outout buffer overrun"), \
154 PARA_ERROR(ORTP_RECV_EOF, "ortp_recv: end of file"), \
157 #define HTTP_RECV_ERRORS \
158 PARA_ERROR(SEND_HTTP_REQUEST, "failed to send http request"), \
159 PARA_ERROR(MISSING_OK, "did not receive OK message from peer"), \
160 PARA_ERROR(HTTP_RECV_BUF, "did not receive buffer"), \
161 PARA_ERROR(HTTP_RECV_EOF, "http_recv: end of file"), \
164 #define RECV_ERRORS \
165 PARA_ERROR(RECV_SELECT, "recv select error"), \
166 PARA_ERROR(WRITE_STDOUT, "stdout write error"), \
169 #define RECV_COMMON_ERRORS \
170 PARA_ERROR(RECV_SYNTAX, "recv syntax error"), \
173 #define AUDIOD_ERRORS \
174 PARA_ERROR(WRITE_AUDIO_DATA, "failed to write audio data"), \
175 PARA_ERROR(NO_MORE_SLOTS, "no more empty slots"), \
176 PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
177 PARA_ERROR(UNSUPPORTED_AUDIO_FORMAT, "given audio format not supported"), \
178 PARA_ERROR(STATUS_EOF, "server closed status connection"), \
181 #define AUDIOD_COMMAND_ERRORS \
182 PARA_ERROR(CLIENT_WRITE, "client write error"), \
183 PARA_ERROR(AUDIOD_SYNTAX, "syntax error"), \
184 PARA_ERROR(UCRED_PERM, "permission denied"), \
185 PARA_ERROR(INVALID_AUDIOD_CMD, "invalid command"), \
188 #define FILTER_CHAIN_ERRORS \
189 PARA_ERROR(UNSUPPORTED_FILTER, "given filter not supported"), \
190 PARA_ERROR(BAD_FILTER_OPTIONS, "invalid filter option given"), \
191 PARA_ERROR(FC_EOF, "filter chain: eof"), \
194 #define STAT_ERRORS \
195 PARA_ERROR(TOO_MANY_CLIENTS, "maximal number of stat clients exceeded"), \
196 PARA_ERROR(UNKNOWN_STAT_ITEM, "status item not recognized"), \
199 #define OGGDEC_ERRORS \
200 PARA_ERROR(OGGDEC_READ, "read from media returned an error"), \
201 PARA_ERROR(OGGDEC_NOTVORBIS, "bitstream is not vorbis data"), \
202 PARA_ERROR(OGGDEC_VERSION, "vorbis version mismatch"), \
203 PARA_ERROR(OGGDEC_BADHEADER, "invalid vorbis bitstream header"), \
204 PARA_ERROR(OGGDEC_FAULT, "bug or heap/stack corruption"), \
205 PARA_ERROR(OGGDEC_BADLINK, "invalid stream section or requested link corrupt"), \
208 #define GRAB_CLIENT_ERRORS \
209 PARA_ERROR(PEDANTIC_GRAB, "fd not ready and pedantic grab requested"), \
210 PARA_ERROR(GC_WRITE, "grab client write error"), \
211 PARA_ERROR(BAD_GC_SLOT, "invalid slot requested by grab client"), \
212 PARA_ERROR(BAD_GC_FILTER_NUM, "invalid filter number given"), \
213 PARA_ERROR(GC_SYNTAX, "grab client syntax error"), \
214 PARA_ERROR(GC_HELP_GIVEN, ""), /* not really an error */ \
215 PARA_ERROR(GC_VERSION_GIVEN, ""), /* not really an error */ \
218 #define MP3DEC_ERRORS \
219 PARA_ERROR(MAD_FRAME_DECODE, "mad frame decode error"), \
220 PARA_ERROR(MP3DEC_OVERRUN, "mp3 output buffer overrun"), \
223 #define FILTER_ERRORS \
224 PARA_ERROR(NO_FILTERS, "at least one filter must be given"), \
225 PARA_ERROR(FILTER_SYNTAX, "syntax error"), \
228 #define SIGNAL_ERRORS \
229 PARA_ERROR(SIGNAL_SIG_ERR, "signal() retured SIG_ERR"), \
230 PARA_ERROR(SIGNAL_READ, "read error from signal pipe"), \
231 PARA_ERROR(WAITPID, "waitpid error"), \
232 PARA_ERROR(SIGNAL_PIPE, "failed to setup signal pipe"), \
233 PARA_ERROR(SIGNAL_CAUGHT, "caught signal"), \
236 #define STRING_ERRORS \
237 PARA_ERROR(MKSTEMP, "mkstemp error: unable to create tmp file"), \
238 PARA_ERROR(FCHMOD, "fchmod error: can not set mode"), \
241 #define EXEC_ERRORS \
242 PARA_ERROR(DUP_PIPE, "exec error: can not create pipe"), \
243 PARA_ERROR(NULL_OPEN, "can not open /dev/null"), \
246 #define MP3_AFH_ERRORS \
247 PARA_ERROR(FREAD, "fread error"), \
248 PARA_ERROR(FSEEK, "fseek error"), \
249 PARA_ERROR(FRAME, "invalid mp3 frame"), \
250 PARA_ERROR(FRAME_LENGTH, "invalid frame length"), \
251 PARA_ERROR(MP3_NO_FILE, "invalid mp3 file pointer"), \
252 PARA_ERROR(MP3_INFO, "could not read mp3 info"), \
253 PARA_ERROR(MP3_REPOS, "mp3 repositioning error"), \
254 PARA_ERROR(HEADER_FREQ, "invalid header frequency"), \
255 PARA_ERROR(HEADER_BITRATE, "invalid header bitrate"), \
258 #define AAC_AFH_ERRORS \
259 PARA_ERROR(AAC_REPOS, "aac repositioning error"), \
260 PARA_ERROR(AAC_READ, "aac read error"), \
261 PARA_ERROR(STSZ, "did not find stcz atom"), \
262 PARA_ERROR(MP4ASC, "audio spec config error"), \
263 PARA_ERROR(AAC_OVERRUN, "aac output buffer overrun"), \
266 #define AAC_COMMON_ERRORS \
267 PARA_ERROR(ESDS, "did not find esds atom"), \
268 PARA_ERROR(STCO, "did not find stco atom"), \
271 #define OGG_AFH_ERRORS \
272 PARA_ERROR(OGG_READ, "ogg read error"), \
273 PARA_ERROR(SYNC_PAGEOUT, "ogg sync page-out error (no ogg file?)"), \
274 PARA_ERROR(STREAM_PAGEIN, "ogg stream page-in error (first page)"), \
275 PARA_ERROR(STREAM_PACKETOUT, "ogg stream packet-out error (first packet)"), \
276 PARA_ERROR(VORBIS, "vorbis synthesis header-in error (not vorbis?)"), \
277 PARA_ERROR(OGG_NO_FILE, "invalid ogg file pointer"), \
278 PARA_ERROR(OGG_OPEN, "ov_open error"), \
279 PARA_ERROR(OGG_INFO, "ov_info error"), \
280 PARA_ERROR(OGG_REPOS, "ogg repositioning error"), \
284 PARA_ERROR(AUDIO_FORMAT, "audio format not recognized"), \
285 PARA_ERROR(FSTAT, "failed to fstat() audio file"), \
289 PARA_ERROR(GETCWD, "can not get current working directory"), \
290 PARA_ERROR(CHDIR, "can not change directory"), \
291 PARA_ERROR(OPENDIR, "can not open directory"), \
292 PARA_ERROR(LSTAT, "lstat error"), \
295 #define CRYPT_ERRORS \
296 PARA_ERROR(PRIVATE_KEY, "can not read private key"), \
297 PARA_ERROR(PUBLIC_KEY, "can not read public key"), \
298 PARA_ERROR(RSA, "RSA error"), \
299 PARA_ERROR(ENCRYPT, "encrypt error"), \
300 PARA_ERROR(DECRYPT, "decrypt error"), \
301 PARA_ERROR(CHALLENGE, "failed to read challenge"), \
304 #define HTTP_SEND_ERRORS \
305 PARA_ERROR(QUEUE, "packet queue overrun"), \
306 PARA_ERROR(WRITE_OK, "can not check whether fd is writable"), \
309 #define RANDOM_SELECTOR_ERRORS \
310 PARA_ERROR(FILE_COUNT, "audio file count exceeded"), \
311 PARA_ERROR(NOTHING_FOUND, "no audio files found"), \
314 #define MYSQL_SELECTOR_ERRORS \
315 PARA_ERROR(MYSQL_SYNTAX, "mysql syntax error"), \
316 PARA_ERROR(NOTCONN, "not connected to mysql server"), \
317 PARA_ERROR(TOOBIG, "mysql: file too large"), \
318 PARA_ERROR(NAMETOOLONG, "mysql: name too long"), \
319 PARA_ERROR(QFAILED, "mysql query failed"), \
320 PARA_ERROR(NOROW, "row is NULL"), \
321 PARA_ERROR(NOATTS, "can not get attributes from mysql table"), \
322 PARA_ERROR(NORESULT, "error while fetching mysql result"), \
323 PARA_ERROR(EMPTY_RESULT, "result is empty"), \
324 PARA_ERROR(ESCAPE, "can not escape string"), \
325 PARA_ERROR(GET_AUDIO_FILE, "can not get current audio file"), \
326 PARA_ERROR(GET_STREAM, "can not get current stream"), \
327 PARA_ERROR(NO_STREAM, "no such stream"), \
328 PARA_ERROR(AUDIO_FILE, "no such audio file"), \
329 PARA_ERROR(GET_QUERY, "can not get query for specified stream"), \
330 PARA_ERROR(TMPFILE, "error while writing temporary file"), \
331 PARA_ERROR(META, "can not get meta data"), \
332 PARA_ERROR(MYSQL_INIT, "can not initialize mysql connection"), \
333 PARA_ERROR(NO_MYSQL_PASSWD, "fatal: no mysql passord given"), \
334 PARA_ERROR(NO_AF_DIR, "fatal: audio file directory not given"), \
337 #define COMMAND_ERRORS \
338 PARA_ERROR(COMMAND_SYNTAX, "syntax error in command"), \
339 PARA_ERROR(AUTH, "did not receive auth request"), \
340 PARA_ERROR(BAD_SELECTOR, "no such audio file selector"), \
341 PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
342 PARA_ERROR(BAD_CMD, "invalid command"), \
343 PARA_ERROR(PERM, "permission denied"), \
344 PARA_ERROR(USERLIST, "failed to open user list file"), \
345 PARA_ERROR(BAD_USER, "you don't exist. Go away."), \
346 PARA_ERROR(LOCK, "lock error"), \
347 PARA_ERROR(SENDER_CMD, "command not supported by this sender"), \
350 #define PLAYLIST_SELECTOR_ERRORS \
351 PARA_ERROR(LOAD_PLAYLIST, "failed to load playlist"), \
355 PARA_ERROR(SEM_GET, "failed to create semaphore"), \
356 PARA_ERROR(SEM_REMOVE, "can not remove semaphore"), \
357 PARA_ERROR(SHM_GET, "failed to allocate shared memory area"), \
358 PARA_ERROR(SHM_DESTROY, "failed to destroy shared memory area"), \
359 PARA_ERROR(SHM_ATTACH, "can not attach shared memory area"), \
360 PARA_ERROR(SHM_DETACH, "can not detach shared memory area"), \
363 #define DCCP_ERRORS \
364 PARA_ERROR(DCCP_SOCKET, "can not create dccp socket"), \
365 PARA_ERROR(DCCP_PACKET_SIZE, "failed to set dccp packet size"), \
366 PARA_ERROR(DCCP_SERVICE, "could not get service code"), \
367 PARA_ERROR(DCCP_RECV_EOF, "dccp_recv: end of file"), \
370 #define DCCP_RECV_ERRORS \
371 PARA_ERROR(ADDR_INFO, "getaddrinfo error"), \
372 PARA_ERROR(DCCP_OVERRUN, "dccp output buffer buffer overrun"), \
373 PARA_ERROR(DCCP_CONNECT, "dccp connect error"), \
376 #define DCCP_SEND_ERRORS \
377 PARA_ERROR(DCCP_BIND, "dccp bind error"), \
378 PARA_ERROR(DCCP_LISTEN, "dccp listen error"), \
379 PARA_ERROR(DCCP_WRITE, "dccp write error"), \
383 PARA_ERROR(F_GETFL, "failed to get fd flags"), \
384 PARA_ERROR(F_SETFL, "failed to set fd flags"), \
387 #define WRITE_ERRORS \
388 PARA_ERROR(WRITE_SYNTAX, "para_write syntax error"), \
389 PARA_ERROR(PREMATURE_END, "premature end of audio file"), \
390 PARA_ERROR(NO_WAV_HEADER, "wave header not found"), \
391 PARA_ERROR(WAV_HEADER_SUCCESS, "successfully read wave header"), \
392 PARA_ERROR(NO_DELAY, "no initial delay"), \
393 PARA_ERROR(DELAY_TIMEOUT, "initial delay timeout"), \
396 #define ALSA_WRITER_ERRORS \
397 PARA_ERROR(BROKEN_CONF, "Broken alsa configuration"), \
398 PARA_ERROR(ACCESS_TYPE, "alsa access type not available"), \
399 PARA_ERROR(SAMPLE_FORMAT, "sample format not available"), \
400 PARA_ERROR(CHANNEL_COUNT, "channels count not available"), \
401 PARA_ERROR(HW_PARAMS, "unable to install hw params"), \
402 PARA_ERROR(SW_PARAMS, "unable to install sw params"), \
403 PARA_ERROR(BAD_PERIOD, "can not use period equal to buffer size"), \
404 PARA_ERROR(GET_XFER, "unable to obtain xfer align"), \
405 PARA_ERROR(SET_XFER, "snd_pcm_sw_params_set_xfer_align() failed"), \
406 PARA_ERROR(ALSA_WRITE, "alsa write error"), \
407 PARA_ERROR(PCM_OPEN, "unable to open pcm"), \
408 PARA_ERROR(SND_PCM_INFO, "pcm info error"), \
409 PARA_ERROR(GET_BUFFER_TIME, "snd_pcm_hw_params_get_buffer_time_max() failed"), \
410 PARA_ERROR(SET_BUFFER_TIME, "snd_pcm_hw_params_set_buffer_time_near() failed"), \
411 PARA_ERROR(SET_RATE, "snd_pcm_hw_params_set_rate_near failed"), \
412 PARA_ERROR(START_THRESHOLD, "snd_pcm_sw_params_set_start_threshold() failed"), \
413 PARA_ERROR(STOP_THRESHOLD, "snd_pcm_sw_params_set_stop_threshold() failed"), \
416 #define FILE_WRITER_ERRORS \
417 PARA_ERROR(FW_WRITE, "file writer write error"), \
418 PARA_ERROR(FW_OPEN, "file writer: can not open output file"), \
419 PARA_ERROR(FW_NO_FILE, "task started without open file"), \
422 #define WRITE_COMMON_ERRORS \
423 PARA_ERROR(WRITE_COMMON_SYNTAX, "syntax error in write option"), \
424 PARA_ERROR(WNG_EOF, "wng: end of file"), \
427 #define AACDEC_ERRORS \
428 PARA_ERROR(AACDEC_INIT, "failed to init aac decoder"), \
429 PARA_ERROR(AAC_DECODE, "aac decode error"), \
433 * the subsystem shift
435 * 255 error codes ought to be enough for every subsystem. Use the higher bits
436 * of the return value to encode the subsystem number
441 * compute the subsystem offset
443 * It is given by x * 2**8 where \a x is the subsystem number
445 #define SS_OFFSET(ss) (SS_ ## ss << SS_SHIFT)
448 * make the enum of all errors of one subsystem
450 * As zero should not be an error, we define a dummy enum entry with value
451 * 2**ss. That lets the real errors start at 2**ss + 1.
453 #define SS_ENUM(ss) enum {\
454 E_ ## ss ## _DUMMY = SS_OFFSET(ss), \
458 * determine the subsystem number from the error number
460 * Easy, it's just \a num / 2**8.
462 #define ERRNUM_TO_SS(num) ((num) >> SS_SHIFT)
465 * determine the index of an error number
467 * Also easy: It's the lower 8 bits of num.
469 #define ERRNUM_TO_INDEX(num) (((1 << SS_SHIFT) - 1) & (num))
472 * paraslash's version of strerror(3)
474 * expands to the error text of \a num (a string constant).
476 #define PARA_STRERROR(num) para_errlist[ERRNUM_TO_SS(num)] [ERRNUM_TO_INDEX(num)]
479 * define the error list for one subsystem
481 * The first entry (index 0) is always the name of the subsystem
482 * Used by macros in config.h (generated by configure)
484 #define DEFINE_ERRLIST(ss) const char * ss ## _ERRLIST[] = {#ss, ss ## _ERRORS}
487 * activate errors for one subsystem.
489 * Each executable needs only the error lists of those subssystems it is
490 * actually linked with. We always reserve space for NUM_SS char ** pointers,
491 * but only init those of the needed subsystems. This macro is used by macros
492 * in config.h (generated by configure).
494 #define PARA_ERRLIST(ss) [SS_ ## ss] = ss ## _ERRLIST
497 * This is temporarily defined to expand to its first argument (prefixed by
498 * 'E_') and gets later redefined to expand to the error text only
500 #define PARA_ERROR(err, msg) E_ ## err
502 #define SS_NAME(ss) para_errlist[ss]? para_errlist[ss][0] : ""
504 /** \cond popcorn time */
512 SS_ENUM(CLOSE_ON_FORK);
517 SS_ENUM(AUDIOD_COMMAND);
523 SS_ENUM(GRAB_CLIENT);
525 SS_ENUM(RECV_COMMON);
526 SS_ENUM(FILTER_CHAIN);
538 SS_ENUM(RANDOM_SELECTOR);
539 SS_ENUM(PLAYLIST_SELECTOR);
544 SS_ENUM(MYSQL_SELECTOR);
551 SS_ENUM(WRITE_COMMON);
552 SS_ENUM(ALSA_WRITER);
553 SS_ENUM(FILE_WRITER);
559 /* rest of the world only sees the error text */
560 #define PARA_ERROR(err, msg) msg