2 * Copyright (C) 2006-2009 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file error.h List of error messages for all subsystems. */
11 /* List of all subsystems that use paraslash's error facility. */
12 DEFINE_ERRLIST_OBJECT_ENUM;
14 /* these do not need error handling (yet) */
17 #define CLOSE_ON_FORK_ERRORS
19 #define UDP_SEND_ERRORS
21 #define RINGBUFFER_ERRORS
27 #define DCCP_SEND_ERRORS
28 #define HTTP_SEND_ERRORS
33 #define SERVER_COMMAND_LIST_ERRORS
34 #define AFS_COMMAND_LIST_ERRORS
35 #define AUDIOD_COMMAND_LIST_ERRORS
37 #define FILE_WRITE_ERRORS
40 extern const char **para_errlist[];
42 #define BUFFER_TREE_ERRORS \
43 PARA_ERROR(BTR_EOF, "buffer tree: end of file"), \
44 PARA_ERROR(BTR_NO_CHILD, "btr node has no children"), \
45 PARA_ERROR(BTR_NAVAIL, "btr node: value currently unavailable"), \
49 #define BITSTREAM_ERRORS \
50 PARA_ERROR(VLC, "invalid vlc code"), \
53 #define WMA_AFH_ERRORS \
54 PARA_ERROR(NO_WMA, "asf/wma format not recognized"), \
57 #define WMA_COMMON_ERRORS \
58 PARA_ERROR(WMA_NO_GUID, "audio stream guid not found"), \
61 #define WMADEC_FILTER_ERRORS \
62 PARA_ERROR(WMA_BAD_PARAMS, "invalid WMA parameters"), \
63 PARA_ERROR(WMA_OUTPUT_SPACE, "insufficient output space"), \
64 PARA_ERROR(WMA_BAD_SUPERFRAME, "invalid superframe"), \
65 PARA_ERROR(WMA_BLOCK_SIZE, "invalid block size"), \
66 PARA_ERROR(INCOHERENT_BLOCK_LEN, "incoherent block length"), \
67 PARA_ERROR(WMADEC_EOF, "wmadec: end of file"), \
70 #define IMDCT_ERRORS \
71 PARA_ERROR(FFT_BAD_PARAMS, "invalid params for fft"), \
74 #define PREBUFFER_FILTER_ERRORS \
75 PARA_ERROR(PREBUFFER_SYNTAX, "syntax error in prebuffer filter config"), \
76 PARA_ERROR(PREBUFFER_SUCCESS, "prebuffering complete"), \
79 #define OSS_WRITE_ERRORS \
80 PARA_ERROR(BAD_SAMPLE_FORMAT, "sample format not supported"), \
81 PARA_ERROR(BAD_CHANNEL_COUNT, "channel count not supported"), \
82 PARA_ERROR(BAD_SAMPLERATE, "sample rate not supported"), \
83 PARA_ERROR(OSS_EOF, "oss: end of file"), \
86 #define COMPRESS_FILTER_ERRORS \
87 PARA_ERROR(COMPRESS_SYNTAX, "syntax error in compress filter config"), \
88 PARA_ERROR(COMPRESS_EOF, "compress: end of file"), \
91 #define WAV_FILTER_ERRORS \
92 PARA_ERROR(WAV_BAD_FC, "invalid filter chain configuration"), \
93 PARA_ERROR(WAV_EOF, "wav filter: end of file"), \
94 PARA_ERROR(WAV_SUCCESS, "successfully wrote wav header"), \
98 PARA_ERROR(FEC_BAD_IDX, "invalid index vector"), \
99 PARA_ERROR(FEC_SINGULAR, "unexpected singular matrix"), \
100 PARA_ERROR(FEC_PIVOT, "pivot column not found"), \
101 PARA_ERROR(FEC_PARMS, "invalid fec parameters"), \
104 #define FECDEC_FILTER_ERRORS \
105 PARA_ERROR(BAD_FEC_HEADER, "invalid fec header"), \
106 PARA_ERROR(BAD_SLICE_SIZE, "slice size zero or too large"), \
107 PARA_ERROR(BAD_SLICE_NUM, "invalid slice number"), \
108 PARA_ERROR(FECDEC_OVERRUN, "fecdec output buffer overrun"), \
109 PARA_ERROR(FECDEC_EOF, "received eof packet"), \
112 #define AMP_FILTER_ERRORS \
113 PARA_ERROR(AMP_SYNTAX, "syntax error in amp filter config"), \
114 PARA_ERROR(AMP_ZERO_AMP, "no amplification necessary"), \
115 PARA_ERROR(AMP_EOF, "amp: end of file"), \
118 #define SEND_COMMON_ERRORS \
119 PARA_ERROR(MAX_CLIENTS, "maximal number of clients exceeded"), \
122 #define CLIENT_ERRORS \
123 PARA_ERROR(TASK_STARTED, "task started"), \
127 PARA_ERROR(AFH_SYNTAX, "afh syntax error"), \
128 PARA_ERROR(AFH_SHORT_WRITE, "afh short write"), \
131 #define AFH_COMMON_ERRORS \
132 PARA_ERROR(AUDIO_FORMAT, "audio format not recognized"), \
136 PARA_ERROR(ACL_PERM, "access denied by acl"), \
140 PARA_ERROR(BAD_TABLE_NAME, "invalid table"), \
141 PARA_ERROR(AFS_SYNTAX, "afs syntax error"), \
142 PARA_ERROR(AFS_SIGNAL, "afs caught deadly signal"), \
143 PARA_ERROR(AFS_SOCKET, "afs socket not writable"), \
146 #define MOOD_ERRORS \
147 PARA_ERROR(NO_MOOD, "no mood available"), \
148 PARA_ERROR(DUMMY_ROW, "attempted to access blob dummy object"), \
152 PARA_ERROR(MOOD_SYNTAX, "mood syntax error"), \
155 #define ATTRIBUTE_ERRORS \
156 PARA_ERROR(ATTR_SYNTAX, "attribute syntax error"), \
157 PARA_ERROR(NO_ATTRIBUTES, "no attributes defined yet"), \
158 PARA_ERROR(ATT_TABLE_FULL, "no more space left in attribute table"), \
161 #define BLOB_ERRORS \
162 PARA_ERROR(BLOB_SYNTAX, "blob syntax error"), \
163 PARA_ERROR(INPUT_TOO_LARGE, "input too large for stdin command"), \
166 #define PLAYLIST_ERRORS \
167 PARA_ERROR(PLAYLIST_LOADED, ""), /* not really an error */ \
168 PARA_ERROR(PATH_FOUND, ""), /* not really an error */ \
169 PARA_ERROR(PLAYLIST_EMPTY, "attempted to load empty playlist"), \
173 PARA_ERROR(BAD_AFSI, "invaiid afs info"), \
174 PARA_ERROR(LOCALTIME, "localtime() failed"), \
175 PARA_ERROR(STRFTIME, "strftime() failed"), \
176 PARA_ERROR(BAD_PATH, "invalid path"), \
177 PARA_ERROR(BAD_SORT, "invalid sorting method"), \
178 PARA_ERROR(FNMATCH, "fnmatch error"), \
179 PARA_ERROR(NO_AFHI, "audio format handler info required"), \
180 PARA_ERROR(AFT_SYNTAX, "audio file table syntax error"), \
181 PARA_ERROR(HASH_MISMATCH, "hash mismatch, consider re-add"), \
184 #define USER_LIST_ERRORS \
185 PARA_ERROR(USERLIST, "failed to open user list file"), \
188 #define OSX_WRITE_ERRORS \
189 PARA_ERROR(STREAM_FORMAT, "could not set stream format"), \
190 PARA_ERROR(ADD_CALLBACK, "can not add callback"), \
191 PARA_ERROR(OPEN_COMP, "OpenAComponent() error"), \
192 PARA_ERROR(UNIT_INIT, "AudioUnitInitialize() error"), \
193 PARA_ERROR(UNIT_START, "AudioUnitStart() error"), \
194 PARA_ERROR(DEFAULT_COMP, "can not find default audio output component"), \
197 #define AUDIOC_ERRORS \
198 PARA_ERROR(AUDIOC_SYNTAX, "audioc syntax error"), \
199 PARA_ERROR(AUDIOC_READ, "audioc read error"), \
200 PARA_ERROR(AUDIOC_WRITE, "audioc write error"), \
201 PARA_ERROR(AUDIOC_OVERRUN, "audioc buffer overrun"), \
204 #define CLIENT_COMMON_ERRORS \
205 PARA_ERROR(CLIENT_SYNTAX, "syntax error"), \
206 PARA_ERROR(NO_CONFIG, "config file not found"), \
207 PARA_ERROR(BAD_CONFIG, "syntax error in config file"), \
208 PARA_ERROR(CLIENT_AUTH, "authentication failed"), \
209 PARA_ERROR(SERVER_EOF, "connection closed by para_server"), \
212 #define SCHED_ERRORS \
213 PARA_ERROR(TASK_KILLED, "task killed"), \
214 PARA_ERROR(TASK_UNREGISTERED, "task has been unscheduled"), \
215 PARA_ERROR(NO_SUCH_TASK, "task not found"), \
216 PARA_ERROR(NOT_INITIALIZED, "scheduler not yet initialized"), \
219 #define STDIN_ERRORS \
220 PARA_ERROR(STDIN_EOF, "end of file"), \
225 PARA_ERROR(NAME_TOO_LONG, "name too long for struct sockaddr_un"), \
226 PARA_ERROR(ADDRESS_LOOKUP, "address lookup / socket creation failed"), \
227 PARA_ERROR(CHMOD, "failed to set socket mode"), \
228 PARA_ERROR(SENDMSG, "sendmsg() failed"), \
229 PARA_ERROR(RECVMSG, "recvmsg() failed"), \
230 PARA_ERROR(SCM_CREDENTIALS, "did not receive SCM credentials"), \
231 PARA_ERROR(RECV_PATTERN, "did not receive expected pattern"), \
234 #define UDP_RECV_ERRORS \
235 PARA_ERROR(UDP_SYNTAX, "udp_recv syntax error"), \
236 PARA_ERROR(UDP_OVERRUN, "output buffer overrun"), \
239 #define HTTP_RECV_ERRORS \
240 PARA_ERROR(HTTP_RECV_OVERRUN, "http_recv: output buffer overrun"), \
243 #define RECV_COMMON_ERRORS \
244 PARA_ERROR(RECV_SYNTAX, "recv syntax error"), \
245 PARA_ERROR(RECV_EOF, "end of file"), \
248 #define AUDIOD_ERRORS \
249 PARA_ERROR(NO_MORE_SLOTS, "no more empty slots"), \
250 PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
251 PARA_ERROR(UNSUPPORTED_AUDIO_FORMAT, "given audio format not supported"), \
252 PARA_ERROR(NOT_PLAYING, "not playing"), \
253 PARA_ERROR(AUDIOD_OFF, "audiod switched off"), \
254 PARA_ERROR(STATUS_TIMEOUT, "timeout reading server status"), \
257 #define AUDIOD_COMMAND_ERRORS \
258 PARA_ERROR(CLIENT_WRITE, "client write error"), \
259 PARA_ERROR(AUDIOD_SYNTAX, "syntax error"), \
260 PARA_ERROR(UCRED_PERM, "permission denied"), \
261 PARA_ERROR(INVALID_AUDIOD_CMD, "invalid command"), \
262 PARA_ERROR(TOO_MANY_CLIENTS, "maximal number of stat clients exceeded"), \
263 PARA_ERROR(UNKNOWN_STAT_ITEM, "status item not recognized"), \
266 #define FILTER_COMMON_ERRORS \
267 PARA_ERROR(BAD_FILTER_OPTIONS, "invalid filter option given"), \
268 PARA_ERROR(UNSUPPORTED_FILTER, "given filter not supported"), \
271 #define STAT_ERRORS \
272 PARA_ERROR(STAT_ITEM_PARSE, "failed to parse status item"), \
275 #define OGGDEC_FILTER_ERRORS \
276 PARA_ERROR(OGGDEC_READ, "read from media returned an error"), \
277 PARA_ERROR(OGGDEC_NOTVORBIS, "bitstream is not vorbis data"), \
278 PARA_ERROR(OGGDEC_VERSION, "vorbis version mismatch"), \
279 PARA_ERROR(OGGDEC_BADHEADER, "invalid vorbis bitstream header"), \
280 PARA_ERROR(OGGDEC_FAULT, "bug or heap/stack corruption"), \
281 PARA_ERROR(OGGDEC_BADLINK, "invalid stream section or requested link corrupt"), \
282 PARA_ERROR(OGGDEC_SYNTAX, "syntax error in oggdec config"), \
283 PARA_ERROR(OGGDEC_EOF, "oggdec: end of file"), \
286 #define GRAB_CLIENT_ERRORS \
287 PARA_ERROR(GC_WRITE, "grab client write error"), \
288 PARA_ERROR(GC_SYNTAX, "grab client syntax error"), \
291 #define MP3DEC_FILTER_ERRORS \
292 PARA_ERROR(MAD_FRAME_DECODE, "mad frame decode error"), \
293 PARA_ERROR(MP3DEC_SYNTAX, "syntax error in mp3dec config"), \
294 PARA_ERROR(MP3DEC_EOF, "mp3dec: end of file"), \
297 #define FILTER_ERRORS \
298 PARA_ERROR(NO_FILTERS, "at least one filter must be given"), \
299 PARA_ERROR(FILTER_SYNTAX, "syntax error"), \
302 #define STRING_ERRORS \
303 PARA_ERROR(ATOI_OVERFLOW, "value too large"), \
304 PARA_ERROR(STRTOLL, "unknown strtoll error"), \
305 PARA_ERROR(ATOI_NO_DIGITS, "no digits found in string"), \
306 PARA_ERROR(ATOI_JUNK_AT_END, "further characters after number"), \
307 PARA_ERROR(SIZE_PREFIX, "bad size prefix"), \
308 PARA_ERROR(REGEX, "regular expression error") \
311 #define EXEC_ERRORS \
312 PARA_ERROR(DUP_PIPE, "exec error: can not create pipe"), \
315 #define MP3_AFH_ERRORS \
316 PARA_ERROR(FRAME, "invalid mp3 frame"), \
317 PARA_ERROR(FRAME_LENGTH, "invalid frame length"), \
318 PARA_ERROR(MP3_INFO, "could not read mp3 info"), \
319 PARA_ERROR(HEADER_FREQ, "invalid header frequency"), \
320 PARA_ERROR(HEADER_BITRATE, "invalid header bitrate"), \
323 #define AAC_AFH_ERRORS \
324 PARA_ERROR(STSZ, "did not find stcz atom"), \
325 PARA_ERROR(MP4ASC, "audio spec config error"), \
326 PARA_ERROR(AAC_AFH_INIT, "failed to init aac decoder"), \
329 #define AAC_COMMON_ERRORS \
330 PARA_ERROR(ESDS, "did not find esds atom"), \
331 PARA_ERROR(STCO, "did not find stco atom"), \
334 #define OGG_AFH_ERRORS \
335 PARA_ERROR(SYNC_PAGEOUT, "ogg sync page-out error (no ogg file?)"), \
336 PARA_ERROR(STREAM_PAGEIN, "ogg stream page-in error (first page)"), \
337 PARA_ERROR(STREAM_PACKETOUT, "ogg stream packet-out error (first packet)"), \
338 PARA_ERROR(VORBIS, "vorbis synthesis header-in error (not vorbis?)"), \
339 PARA_ERROR(OGG_SYNC, "internal ogg storage overflow"), \
340 PARA_ERROR(OGG_EMPTY, "no ogg pages found"), \
344 PARA_ERROR(NOFD, "did not receive open fd from afs"), \
345 PARA_ERROR(BAD_CT, "invalid chunk table or bad FEC configuration"), \
346 PARA_ERROR(AFS_SHORT_READ, "short read from afs socket"), \
349 #define CRYPT_ERRORS \
350 PARA_ERROR(PRIVATE_KEY, "can not read private key"), \
351 PARA_ERROR(PUBLIC_KEY, "can not read public key"), \
352 PARA_ERROR(RSA, "RSA error"), \
353 PARA_ERROR(ENCRYPT, "encrypt error"), \
354 PARA_ERROR(DECRYPT, "decrypt error"), \
355 PARA_ERROR(BLINDING, "failed to activate key blinding"), \
356 PARA_ERROR(KEY_PERM, "unprotected private key"), \
359 #define COMMAND_ERRORS \
360 PARA_ERROR(COMMAND_SYNTAX, "syntax error in command"), \
361 PARA_ERROR(AUTH_REQUEST, "did not receive auth request"), \
362 PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
363 PARA_ERROR(BAD_CMD, "invalid command"), \
364 PARA_ERROR(PERM, "permission denied"), \
365 PARA_ERROR(LOCK, "lock error"), \
366 PARA_ERROR(SENDER_CMD, "command not supported by this sender"), \
367 PARA_ERROR(SERVER_CRASH, "para_server crashed -- can not live without it"), \
368 PARA_ERROR(BAD_USER, "auth request for invalid user"), \
369 PARA_ERROR(BAD_AUTH, "authentication failure"), \
372 #define DCCP_RECV_ERRORS \
373 PARA_ERROR(DCCP_OVERRUN, "dccp output buffer buffer overrun"), \
377 PARA_ERROR(FGETS, "fgets error"), \
380 #define WRITE_ERRORS \
381 PARA_ERROR(WRITE_SYNTAX, "para_write syntax error"), \
382 PARA_ERROR(NO_WAV_HEADER, "wave header not found"), \
385 #define ALSA_WRITE_ERRORS \
386 PARA_ERROR(BROKEN_CONF, "Broken alsa configuration"), \
387 PARA_ERROR(ACCESS_TYPE, "alsa access type not available"), \
388 PARA_ERROR(SAMPLE_FORMAT, "sample format not available"), \
389 PARA_ERROR(CHANNEL_COUNT, "channels count not available"), \
390 PARA_ERROR(HW_PARAMS, "unable to install hw params"), \
391 PARA_ERROR(BAD_PERIOD, "can not use period equal to buffer size"), \
392 PARA_ERROR(ALSA_WRITE, "alsa write error"), \
393 PARA_ERROR(PCM_OPEN, "unable to open pcm"), \
394 PARA_ERROR(PHYSICAL_WIDTH, "unable to determine bytes per frame"), \
395 PARA_ERROR(GET_BUFFER_TIME, "snd_pcm_hw_params_get_buffer_time_max() failed"), \
396 PARA_ERROR(SET_BUFFER_TIME, "snd_pcm_hw_params_set_buffer_time_near() failed"), \
397 PARA_ERROR(SET_RATE, "snd_pcm_hw_params_set_rate_near failed"), \
398 PARA_ERROR(START_THRESHOLD, "snd_pcm_sw_params_set_start_threshold() failed"), \
399 PARA_ERROR(STOP_THRESHOLD, "snd_pcm_sw_params_set_stop_threshold() failed"), \
400 PARA_ERROR(ALSA_EOF, "alsa: end of file"), \
404 #define WRITE_COMMON_ERRORS \
405 PARA_ERROR(WRITE_COMMON_SYNTAX, "syntax error in write option"), \
408 #define AACDEC_FILTER_ERRORS \
409 PARA_ERROR(AACDEC_INIT, "failed to init aac decoder"), \
410 PARA_ERROR(AAC_DECODE, "aac decode error"), \
413 #define CHUNK_QUEUE_ERRORS \
414 PARA_ERROR(QUEUE, "packet queue overrun"), \
420 * The subsystem shift.
422 * 255 error codes ought to be enough for every subsystem. Use the higher bits
423 * of the return value to encode the subsystem number.
428 * Compute the subsystem offset.
430 * It is given by x * 2**8 where \a x is the subsystem number.
432 #define SS_OFFSET(ss) (SS_ ## ss << SS_SHIFT)
435 * Make the enum of all errors of one subsystem.
437 * As zero should not be an error, we define a dummy enum entry with value
438 * 2**ss. That lets the real errors start at 2**ss + 1.
440 #define SS_ENUM(ss) enum {\
441 E_ ## ss ## _DUMMY = SS_OFFSET(ss), \
445 * Determine the subsystem number from the error number.
447 * Easy, it's just \a num / 2**8.
449 #define ERRNUM_TO_SS(num) ((num) >> SS_SHIFT)
452 * Determine the index of an error number.
454 * Also easy: It's the lower 8 bits of num.
456 #define ERRNUM_TO_INDEX(num) (((1 << SS_SHIFT) - 1) & (num))
459 * This bit indicates whether a number is considered a system error number
460 * If yes, the system errno is just the result of clearing this bit from
463 #define SYSTEM_ERROR_BIT 30
466 * Like the SYSTEM_ERROR_BIT, but indicates an error from the osl library.
468 #define OSL_ERROR_BIT 29
470 /** Check whether the system error bit is set. */
471 #define IS_SYSTEM_ERROR(num) (!!((num) & (1 << SYSTEM_ERROR_BIT)))
473 /** Check whether the osl error bit is set. */
474 #define IS_OSL_ERROR(num) (!!((num) & (1 << OSL_ERROR_BIT)))
476 /** Set the system error bit for the given number. */
477 #define ERRNO_TO_PARA_ERROR(num) ((num) | (1 << SYSTEM_ERROR_BIT))
479 /** Set the osl error bit for the given number. */
480 #define OSL_ERRNO_TO_PARA_ERROR(num) ((num) | (1 << OSL_ERROR_BIT))
482 /** Check whether a given number is a system error number.
484 * \param num The value to be checked.
485 * \param _errno The system error number.
487 * \return True if \a num is paraslash's representation of the system
488 * error identified by \a _errno.
490 _static_inline_ int is_errno(int num, int _errno)
492 assert(num > 0 && _errno > 0);
493 return ERRNO_TO_PARA_ERROR(_errno) == num;
497 * Paraslash's version of strerror(3).
499 * \param num The error number.
501 * \return The error text of \a num.
503 _static_inline_ const char *para_strerror(int num)
507 if (IS_OSL_ERROR(num))
508 return osl_strerror(num & ((1 << OSL_ERROR_BIT) - 1));
510 if (IS_SYSTEM_ERROR(num))
511 return strerror(num & ((1 << SYSTEM_ERROR_BIT) - 1));
512 return para_errlist[ERRNUM_TO_SS(num)][ERRNUM_TO_INDEX(num)];
516 * Wrapper for osl library calls.
518 * \param ret The return value of an osl library function.
520 * This should be used for all calls to osl functions that return an osl error
521 * code. It changes the return value appropriately so that it can be used for
522 * printing the correct error message vi para_strerror().
524 * \return \a ret if \a ret >= 0, a paraslash error code otherwise.
526 _static_inline_ int osl(int ret)
530 return -OSL_ERRNO_TO_PARA_ERROR(-ret);
534 * Define the error list for one subsystem.
536 * The first entry (index 0) is always the name of the subsystem
537 * Used by macros in config.h (generated by configure).
539 #define DEFINE_ERRLIST(ss) const char * ss ## _ERRLIST[] = {#ss, ss ## _ERRORS}
542 * Activate errors for one subsystem.
544 * Each executable needs only the error lists of those subsystems it is
545 * actually linked with. We always reserve space for NUM_SS char pointers,
546 * but only init those of the needed subsystems. This macro is used by macros
547 * in config.h (generated by configure).
549 #define PARA_ERRLIST(ss) [SS_ ## ss] = ss ## _ERRLIST
552 * This is temporarily defined to expand to its first argument (prefixed by
553 * 'E_') and gets later redefined to expand to the error text only
555 #define PARA_ERROR(err, msg) E_ ## err
558 /* Rest of the world only sees the error text. */
559 #define PARA_ERROR(err, msg) msg