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 */
72 /* these do not need error handling (yet) */
75 #define COMPRESS_ERRORS
77 #define CLOSE_ON_FORK_ERRORS
79 #define ORTP_SEND_ERRORS
81 #define RINGBUFFER_ERRORS
84 extern const char **para_errlist[];
88 PARA_ERROR(SEND, "send error"), \
89 PARA_ERROR(RECV, "receive error"), \
90 PARA_ERROR(SOCKET, "socket error"), \
91 PARA_ERROR(CONNECT, "connect error"), \
92 PARA_ERROR(ACCEPT, "accept error"), \
93 PARA_ERROR(SETSOCKOPT, "failed to set socket options"), \
94 PARA_ERROR(BIND, "bind error"), \
95 PARA_ERROR(NAME_TOO_LONG, "name too long for struct sockaddr_un"), \
96 PARA_ERROR(CHMOD, "failed to set socket mode"), \
97 PARA_ERROR(SENDMSG, "sendmsg() failed"), \
98 PARA_ERROR(RECVMSG, "recvmsg() failed"), \
99 PARA_ERROR(SCM_CREDENTIALS, "did not receive SCM credentials"), \
100 PARA_ERROR(LISTEN, "listen error"), \
101 PARA_ERROR(RECV_PATTERN, "did not receive expected pattern"), \
102 PARA_ERROR(HOST_INFO, "gethostbyname() failed"), \
105 #define ORTP_RECV_ERRORS \
106 PARA_ERROR(MSG_TO_BUF, "failed to extract rtp packet"), \
107 PARA_ERROR(ORTP_SYNTAX, "ottp syntax error"), \
108 PARA_ERROR(TOO_MANY_BAD_CHUNKS, "too many consecutive bad chunks"), \
109 PARA_ERROR(INVALID_HEADER, "invalid header packet"), \
110 PARA_ERROR(OVERRUN, "outout buffer overrun"), \
113 #define HTTP_RECV_ERRORS \
114 PARA_ERROR(SEND_HTTP_REQUEST, "failed to send http request"), \
115 PARA_ERROR(MISSING_OK, "did not receive OK message from peer"), \
116 PARA_ERROR(HTTP_RECV_BUF, "did not receive buffer")
119 #define RECV_ERRORS \
120 PARA_ERROR(RECV_SELECT, "recv select error"), \
121 PARA_ERROR(WRITE_STDOUT, "stdout write error"), \
124 #define RECV_COMMON_ERRORS \
125 PARA_ERROR(RECV_SYNTAX, "recv syntax error"), \
128 #define AUDIOD_ERRORS \
129 PARA_ERROR(WRITE_AUDIO_DATA, "failed to write audio data"), \
130 PARA_ERROR(NO_MORE_SLOTS, "no more empty slots"), \
131 PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
132 PARA_ERROR(UNSUPPORTED_AUDIO_FORMAT, "given audio format not supported"), \
133 PARA_ERROR(CLIENT_WRITE, "client write error"), \
134 PARA_ERROR(UCRED_PERM, "permission denied"), \
135 PARA_ERROR(INVALID_AUDIOD_CMD, "invalid command"), \
138 #define FILTER_CHAIN_ERRORS \
139 PARA_ERROR(UNSUPPORTED_FILTER, "given filter not supported"), \
140 PARA_ERROR(BAD_FILTER_OPTIONS, "invalid filter option given"), \
143 #define STAT_ERRORS \
144 PARA_ERROR(TOO_MANY_CLIENTS, "maximal number of stat clients exceeded"), \
145 PARA_ERROR(UNKNOWN_STAT_ITEM, "status item not recognized"), \
148 #define OGGDEC_ERRORS \
149 PARA_ERROR(OGGDEC_READ, "read from media returned an error"), \
150 PARA_ERROR(OGGDEC_NOTVORBIS, "bitstream is not vorbis data"), \
151 PARA_ERROR(OGGDEC_VERSION, "vorbis version mismatch"), \
152 PARA_ERROR(OGGDEC_BADHEADER, "invalid vorbis bitstream header"), \
153 PARA_ERROR(OGGDEC_FAULT, "bug or heap/stack corruption"), \
154 PARA_ERROR(OGGDEC_BADLINK, "invalid stream section or requested link corrupt"), \
157 #define GRAB_CLIENT_ERRORS \
158 PARA_ERROR(PEDANTIC_GRAB, "fd not ready and pedantic grab requested"), \
159 PARA_ERROR(GC_WRITE, "grab client write error"), \
160 PARA_ERROR(BAD_GC_SLOT, "invalid slot requested by grab client"), \
161 PARA_ERROR(BAD_GC_FILTER_NUM, "invalid filter number given"), \
162 PARA_ERROR(GC_SYNTAX, "grab client syntax error"), \
163 PARA_ERROR(GC_HELP_GIVEN, ""), /* not really an error */ \
164 PARA_ERROR(GC_VERSION_GIVEN, ""), /* not really an error */ \
167 #define MP3DEC_ERRORS \
168 PARA_ERROR(MAD_FRAME_DECODE, "mad frame decode error"), \
169 PARA_ERROR(MP3DEC_OVERRUN, "mp3 output buffer overrun"), \
172 #define FILTER_ERRORS \
173 PARA_ERROR(NO_FILTERS, "at least one filter must be given"), \
174 PARA_ERROR(FILTER_SYNTAX, "syntax error"), \
177 #define SIGNAL_ERRORS \
178 PARA_ERROR(SIGNAL_SIG_ERR, "signal() retured SIG_ERR"), \
179 PARA_ERROR(SIGNAL_READ, "read error from signal pipe"), \
180 PARA_ERROR(WAITPID, "waitpid error"), \
181 PARA_ERROR(SIGNAL_PIPE, "failed to setup signal pipe"), \
184 #define STRING_ERRORS \
185 PARA_ERROR(MKSTEMP, "mkstemp error: unable to create tmp file"), \
186 PARA_ERROR(FCHMOD, "fchmod error: can not set mode"), \
189 #define EXEC_ERRORS \
190 PARA_ERROR(DUP_PIPE, "exec error: can not create pipe"), \
191 PARA_ERROR(NULL_OPEN, "can not open /dev/null"), \
194 #define MP3_AFH_ERRORS \
195 PARA_ERROR(FREAD, "fread error"), \
196 PARA_ERROR(FSEEK, "fseek error"), \
197 PARA_ERROR(FRAME, "invalid mp3 frame"), \
198 PARA_ERROR(FRAME_LENGTH, "invalid frame length"), \
199 PARA_ERROR(MP3_NO_FILE, "invalid mp3 file pointer"), \
200 PARA_ERROR(MP3_INFO, "could not read mp3 info"), \
201 PARA_ERROR(MP3_REPOS, "mp3 repositioning error"), \
202 PARA_ERROR(HEADER_FREQ, "invalid header frequency"), \
203 PARA_ERROR(HEADER_BITRATE, "invalid header bitrate"), \
206 #define AAC_AFH_ERRORS \
207 PARA_ERROR(AAC_REPOS, "aac repositioning error"), \
208 PARA_ERROR(AAC_READ, "aac read error"), \
209 PARA_ERROR(STSZ, "did not find stcz atom"), \
210 PARA_ERROR(MP4ASC, "audio spec config error"), \
213 #define AAC_COMMON_ERRORS \
214 PARA_ERROR(AAC_BUF, "invalid buffer"), \
215 PARA_ERROR(ESDS, "did not find esds atom"), \
216 PARA_ERROR(STCO, "did not find stco atom"), \
219 #define OGG_AFH_ERRORS \
220 PARA_ERROR(OGG_READ, "ogg read error"), \
221 PARA_ERROR(SYNC_PAGEOUT, "ogg sync page-out error (no ogg file?)"), \
222 PARA_ERROR(STREAM_PAGEIN, "ogg stream page-in error (first page)"), \
223 PARA_ERROR(STREAM_PACKETOUT, "ogg stream packet-out error (first packet)"), \
224 PARA_ERROR(VORBIS, "vorbis synthesis header-in error (not vorbis?)"), \
225 PARA_ERROR(OGG_NO_FILE, "invalid ogg file pointer"), \
226 PARA_ERROR(OGG_OPEN, "ov_open error"), \
227 PARA_ERROR(OGG_INFO, "ov_info error"), \
228 PARA_ERROR(OGG_REPOS, "ogg repositioning error"), \
232 PARA_ERROR(AUDIO_FORMAT, "audio format not recognized"), \
233 PARA_ERROR(FSTAT, "failed to fstat() audio file"), \
237 PARA_ERROR(GETCWD, "can not get current working directory"), \
238 PARA_ERROR(CHDIR, "can not change directory"), \
239 PARA_ERROR(OPENDIR, "can not open directory"), \
240 PARA_ERROR(LSTAT, "lstat error"), \
243 #define CRYPT_ERRORS \
244 PARA_ERROR(PRIVATE_KEY, "can not read private key"), \
245 PARA_ERROR(PUBLIC_KEY, "can not read public key"), \
246 PARA_ERROR(RSA, "RSA error"), \
247 PARA_ERROR(ENCRYPT, "encrypt error"), \
248 PARA_ERROR(DECRYPT, "decrypt error"), \
249 PARA_ERROR(CHALLENGE, "failed to read challenge"), \
252 #define HTTP_SEND_ERRORS \
253 PARA_ERROR(QUEUE, "packet queue overrun"), \
254 PARA_ERROR(WRITE_OK, "can not check whether fd is writable"), \
257 #define RANDOM_SELECTOR_ERRORS \
258 PARA_ERROR(FILE_COUNT, "audio file count exceeded"), \
259 PARA_ERROR(NOTHING_FOUND, "no audio files found"), \
262 #define MYSQL_SELECTOR_ERRORS \
263 PARA_ERROR(MYSQL_SYNTAX, "mysql syntax error"), \
264 PARA_ERROR(NOTCONN, "not connected to mysql server"), \
265 PARA_ERROR(TOOBIG, "mysql: file too large"), \
266 PARA_ERROR(NAMETOOLONG, "mysql: name too long"), \
267 PARA_ERROR(QFAILED, "mysql query failed"), \
268 PARA_ERROR(NOROW, "row is NULL"), \
269 PARA_ERROR(NOATTS, "can not get attributes from mysql table"), \
270 PARA_ERROR(NORESULT, "error while fetching mysql result"), \
271 PARA_ERROR(EMPTY_RESULT, "result is empty"), \
272 PARA_ERROR(ESCAPE, "can not escape string"), \
273 PARA_ERROR(GET_AUDIO_FILE, "can not get current audio file"), \
274 PARA_ERROR(GET_STREAM, "can not get current stream"), \
275 PARA_ERROR(NO_STREAM, "no such stream"), \
276 PARA_ERROR(AUDIO_FILE, "no such audio file"), \
277 PARA_ERROR(GET_QUERY, "can not get query for specified stream"), \
278 PARA_ERROR(TMPFILE, "error while writing temporary file"), \
279 PARA_ERROR(META, "can not get meta data"), \
280 PARA_ERROR(MYSQL_INIT, "can not initialize mysql connection"), \
281 PARA_ERROR(NO_MYSQL_PASSWD, "fatal: no mysql passord given"), \
282 PARA_ERROR(NO_AF_DIR, "fatal: audio file directory not given"), \
285 #define COMMAND_ERRORS \
286 PARA_ERROR(COMMAND_SYNTAX, "syntax error in command"), \
287 PARA_ERROR(AUTH, "did not receive auth request"), \
288 PARA_ERROR(BAD_SELECTOR, "no such audio file selector"), \
289 PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
290 PARA_ERROR(BAD_CMD, "invalid command"), \
291 PARA_ERROR(PERM, "permission denied"), \
292 PARA_ERROR(USERLIST, "failed to open user list file"), \
293 PARA_ERROR(BAD_USER, "you don't exist. Go away."), \
294 PARA_ERROR(LOCK, "lock error"), \
295 PARA_ERROR(SENDER_CMD, "command not supported by this sender"), \
298 #define PLAYLIST_SELECTOR_ERRORS \
299 PARA_ERROR(LOAD_PLAYLIST, "failed to load playlist"), \
303 PARA_ERROR(SEM_GET, "failed to create semaphore"), \
304 PARA_ERROR(SEM_REMOVE, "can not remove semaphore"), \
305 PARA_ERROR(SHM_GET, "failed to allocate shared memory area"), \
306 PARA_ERROR(SHM_DESTROY, "failed to destroy shared memory area"), \
307 PARA_ERROR(SHM_ATTACH, "can not attach shared memory area"), \
308 PARA_ERROR(SHM_DETACH, "can not detach shared memory area"), \
311 #define DCCP_ERRORS \
312 PARA_ERROR(DCCP_SOCKET, "can not create dccp socket"), \
313 PARA_ERROR(DCCP_PACKET_SIZE, "failed to set dccp packet size"), \
314 PARA_ERROR(DCCP_SERVICE, "could not get service code"), \
317 #define DCCP_RECV_ERRORS \
318 PARA_ERROR(ADDR_INFO, "getaddrinfo error"), \
319 PARA_ERROR(DCCP_OVERRUN, "dccp output buffer buffer overrun"), \
320 PARA_ERROR(DCCP_CONNECT, "dccp connect error"), \
322 #define DCCP_SEND_ERRORS \
323 PARA_ERROR(DCCP_BIND, "dccp bind error"), \
324 PARA_ERROR(DCCP_LISTEN, "dccp listen error"), \
325 PARA_ERROR(DCCP_WRITE, "dccp write error"), \
328 PARA_ERROR(F_GETFL, "failed to get fd flags"), \
329 PARA_ERROR(F_SETFL, "failed to set fd flags"), \
332 #define WRITE_ERRORS \
333 PARA_ERROR(READ_HDR, "failed to read audio file header"), \
334 PARA_ERROR(READ_STDIN, "failed to read from stdin"), \
335 PARA_ERROR(WRITE_SYNTAX, "para_write syntax error"), \
336 PARA_ERROR(WRITE_OVERRUN, "buffer overrun"), \
337 PARA_ERROR(PREMATURE_END, "premature end of audio file"), \
340 #define ALSA_WRITER_ERRORS \
341 PARA_ERROR(BROKEN_CONF, "Broken alsa configuration"), \
342 PARA_ERROR(ACCESS_TYPE, "alsa access type not available"), \
343 PARA_ERROR(SAMPLE_FORMAT, "sample format not available"), \
344 PARA_ERROR(CHANNEL_COUNT, "channels count not available"), \
345 PARA_ERROR(HW_PARAMS, "unable to install hw params"), \
346 PARA_ERROR(SW_PARAMS, "unable to install sw params"), \
347 PARA_ERROR(BAD_PERIOD, "can not use period equal to buffer size"), \
348 PARA_ERROR(GET_XFER, "unable to obtain xfer align"), \
349 PARA_ERROR(SET_XFER, "snd_pcm_sw_params_set_xfer_align() failed"), \
350 PARA_ERROR(ALSA_WRITE, "alsa write error"), \
351 PARA_ERROR(PCM_OPEN, "unable to open pcm"), \
352 PARA_ERROR(SND_PCM_INFO, "pcm info error"), \
353 PARA_ERROR(GET_BUFFER_TIME, "snd_pcm_hw_params_get_buffer_time_max() failed"), \
354 PARA_ERROR(SET_BUFFER_TIME, "snd_pcm_hw_params_set_buffer_time_near() failed"), \
355 PARA_ERROR(SET_RATE, "snd_pcm_hw_params_set_rate_near failed"), \
356 PARA_ERROR(START_THRESHOLD, "snd_pcm_sw_params_set_start_threshold() failed"), \
357 PARA_ERROR(STOP_THRESHOLD, "snd_pcm_sw_params_set_stop_threshold() failed"), \
358 PARA_ERROR(ALSA_LOG, "snd_output_stdio_attach() failed"), \
361 #define FILE_WRITER_ERRORS \
362 PARA_ERROR(FW_WRITE, "file writer write error"), \
363 PARA_ERROR(FW_OPEN, "file writer: can not open output file"), \
366 #define WRITE_COMMON_ERRORS \
367 PARA_ERROR(WRITE_COMMON_SYNTAX, "syntax error in write option"), \
370 #define AACDEC_ERRORS \
371 PARA_ERROR(AACDEC_INIT, "failed to init aac decoder"), \
372 PARA_ERROR(AAC_DECODE, "aac decode error"), \
375 * the subsystem shift
377 * 255 error codes ought to be enough for every subsystem. Use the higher bits
378 * of the return value to encode the subsystem number
383 * compute the subsystem offset
385 * It is given by x * 2**8 where \a x is the subsystem number
387 #define SS_OFFSET(ss) (SS_ ## ss << SS_SHIFT)
390 * make the enum of all errors of one subsystem
392 * As zero should not be an error, we define a dummy enum entry with value
393 * 2**ss. That lets the real errors start at 2**ss + 1.
395 #define SS_ENUM(ss) enum {\
396 E_ ## ss ## _DUMMY = SS_OFFSET(ss), \
400 * determine the subsystem number from the error number
402 * Easy, it's just \a num / 2**8.
404 #define ERRNUM_TO_SS(num) ((num) >> SS_SHIFT)
407 * determine the index of an error number
409 * Also easy: It's the lower 8 bits of num.
411 #define ERRNUM_TO_INDEX(num) (((1 << SS_SHIFT) - 1) & (num))
414 * paraslash's version of strerror(3)
416 * expands to the error text of \a num (a string constant).
418 #define PARA_STRERROR(num) para_errlist[ERRNUM_TO_SS(num)] [ERRNUM_TO_INDEX(num)]
421 * define the error list for one subsystem
423 * The first entry (index 0) is always the name of the subsystem
424 * Used by macros in config.h (generated by configure)
426 #define DEFINE_ERRLIST(ss) const char * ss ## _ERRLIST[] = {#ss, ss ## _ERRORS}
429 * activate errors for one subsystem.
431 * Each executable needs only the error lists of those subssystems it is
432 * actually linked with. We always reserve space for NUM_SS char ** pointers,
433 * but only init those of the needed subsystems. This macro is used by macros
434 * in config.h (generated by configure).
436 #define PARA_ERRLIST(ss) [SS_ ## ss] = ss ## _ERRLIST
439 * This is temporarily defined to expand to its first argument (prefixed by
440 * 'E_') and gets later redefined to expand to the error text only
442 #define PARA_ERROR(err, msg) E_ ## err
444 #define SS_NAME(ss) para_errlist[ss]? para_errlist[ss][0] : ""
446 /** \cond popcorn time */
451 SS_ENUM(CLOSE_ON_FORK);
461 SS_ENUM(GRAB_CLIENT);
463 SS_ENUM(RECV_COMMON);
464 SS_ENUM(FILTER_CHAIN);
476 SS_ENUM(RANDOM_SELECTOR);
477 SS_ENUM(PLAYLIST_SELECTOR);
482 SS_ENUM(MYSQL_SELECTOR);
489 SS_ENUM(WRITE_COMMON);
490 SS_ENUM(ALSA_WRITER);
491 SS_ENUM(FILE_WRITER);
495 /* rest of the world only sees the error text */
496 #define PARA_ERROR(err, msg) msg