2 * Copyright (C) 2006-2008 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 COMPRESS_ERRORS
19 #define CLOSE_ON_FORK_ERRORS
21 #define ORTP_SEND_ERRORS
23 #define RINGBUFFER_ERRORS
28 #define SEND_COMMON_ERRORS
33 extern const char **para_errlist[];
36 PARA_ERROR(FADE_SYNTAX, "fade syntax error"), \
39 #define CLIENT_ERRORS \
40 PARA_ERROR(TASK_STARTED, "task started"), \
44 PARA_ERROR(AFH_SYNTAX, "afh syntax error"), \
45 PARA_ERROR(AFH_SHORT_WRITE, "afh short write"), \
48 #define AFH_COMMON_ERRORS \
49 PARA_ERROR(AUDIO_FORMAT, "audio format not recognized"), \
53 PARA_ERROR(ACL_PERM, "access denied by acl"), \
57 PARA_ERROR(FSCK_SYNTAX, "fsck syntax error"), \
58 PARA_ERROR(RANGE_VIOLATION, "range violation detected, very bad"), \
59 PARA_ERROR(NOT_A_REGULAR_FILE, "not a regular file"), \
63 PARA_ERROR(BAD_DB_DIR, "invalid database directory"), \
64 PARA_ERROR(NO_COLUMN_DESC, "missing column description"), \
65 PARA_ERROR(BAD_NAME, "invalid name for a column/table"), \
66 PARA_ERROR(BAD_STORAGE_TYPE, "invalid storage type"), \
67 PARA_ERROR(BAD_STORAGE_FLAGS, "invalid storage flags"), \
68 PARA_ERROR(NO_COLUMN_NAME, "missing column name"), \
69 PARA_ERROR(NO_COLUMNS, "at least one column required"), \
70 PARA_ERROR(BAD_COLUMN_NAME, "invalid name for a table column"), \
71 PARA_ERROR(NO_UNIQUE_RBTREE_COLUMN, "need at least one mapped column with OSL_UNIQE and OSL_RBTREE OSL"), \
72 PARA_ERROR(NO_RBTREE_COL, "at least one column needs an rbtree"), \
73 PARA_ERROR(DUPLICATE_COL_NAME, "column name given twice"), \
74 PARA_ERROR(BAD_STORAGE_SIZE, "invalid storage size"), \
75 PARA_ERROR(NO_COMPARE_FUNC, "missing compare function"), \
76 PARA_ERROR(BAD_DATA_SIZE, "wrong data size for fixed-size column"), \
77 PARA_ERROR(NOT_MAPPED, "file not mapped"), \
78 PARA_ERROR(ALREADY_MAPPED, "file already mapped"), \
79 PARA_ERROR(BAD_SIZE, "invalid size specified"), \
80 PARA_ERROR(TRUNC, "failed to truncate file"), \
81 PARA_ERROR(BAD_TABLE, "table not open"), \
82 PARA_ERROR(BAD_TABLE_DESC, "invalid table description"), \
83 PARA_ERROR(RB_KEY_EXISTS, "key already exists in rbtree"), \
84 PARA_ERROR(RB_KEY_NOT_FOUND, "key not found in rbtree"), \
85 PARA_ERROR(BAD_ROW_NUM, "invalid row number"), \
86 PARA_ERROR(INDEX_CORRUPTION, "index corruption detected"), \
87 PARA_ERROR(INVALID_OBJECT, "reference to invalid object"), \
88 PARA_ERROR(STAT, "can not stat file"), \
89 PARA_ERROR(WRITE, "write error"), \
90 PARA_ERROR(LSEEK, "lseek error"), \
91 PARA_ERROR(BUSY, "table is busy"), \
92 PARA_ERROR(SHORT_TABLE, "table too short"), \
93 PARA_ERROR(NO_MAGIC, "missing table header magic"), \
94 PARA_ERROR(VERSION_MISMATCH, "table version not supported"), \
95 PARA_ERROR(BAD_COLUMN_NUM, "invalid column number"), \
96 PARA_ERROR(BAD_TABLE_FLAGS, "invalid flags in table description"), \
97 PARA_ERROR(BAD_ROW, "invalid row"), \
102 PARA_ERROR(BAD_TABLE_NAME, "invalid table"), \
103 PARA_ERROR(INPUT_TOO_LARGE, "input too large for stdin command"), \
104 PARA_ERROR(AFS_SYNTAX, "afs syntax error"), \
105 PARA_ERROR(AFS_SIGNAL, "afs caught deadly signal"), \
106 PARA_ERROR(AFS_SOCKET, "afs socket not writable"), \
107 PARA_ERROR(AFS_SHORT_READ, "short read from afs socket"), \
110 #define MOOD_ERRORS \
111 PARA_ERROR(MOOD_SYNTAX, "mood syntax error"), \
112 PARA_ERROR(NO_MOOD, "no mood available"), \
113 PARA_ERROR(NOT_ADMISSIBLE, "file is not admissible"), \
116 #define ATTRIBUTE_ERRORS \
117 PARA_ERROR(ATTR_SYNTAX, "attribute syntax error"), \
118 PARA_ERROR(NO_ATTRIBUTES, "no attributes defined yet"), \
119 PARA_ERROR(ATT_TABLE_FULL, "no more space left in attribute table"), \
122 #define BLOB_ERRORS \
123 PARA_ERROR(BLOB_SYNTAX, "blob syntax error"), \
124 PARA_ERROR(DUMMY_ROW, "attempted to access blob dummy object"), \
127 #define PLAYLIST_ERRORS \
128 PARA_ERROR(PLAYLIST_LOADED, ""), /* not really an error */ \
129 PARA_ERROR(PATH_FOUND, ""), /* not really an error */ \
130 PARA_ERROR(PLAYLIST_EMPTY, "attempted to load empty playlist"), \
134 PARA_ERROR(BAD_AFSI, "invaiid afs info"), \
135 PARA_ERROR(LOCALTIME, "localtime() failed"), \
136 PARA_ERROR(STRFTIME, "strftime() failed"), \
137 PARA_ERROR(BAD_PATH, "invalid path"), \
138 PARA_ERROR(BAD_SORT, "invalid sorting method"), \
139 PARA_ERROR(FNMATCH, "fnmatch error"), \
140 PARA_ERROR(NO_MATCH, "no matches"), \
141 PARA_ERROR(NO_AFHI, "audio format handler info required"), \
142 PARA_ERROR(AFT_SYNTAX, "audio file table syntax error"), \
143 PARA_ERROR(HASH_MISMATCH, "hash mismatch, consider re-add"), \
146 #define USER_LIST_ERRORS \
147 PARA_ERROR(USERLIST, "failed to open user list file"), \
150 #define OSX_WRITE_ERRORS \
151 PARA_ERROR(STREAM_FORMAT, "could not set stream format"), \
152 PARA_ERROR(ADD_CALLBACK, "can not add callback"), \
153 PARA_ERROR(OPEN_COMP, "OpenAComponent() error"), \
154 PARA_ERROR(UNIT_INIT, "AudioUnitInitialize() error"), \
155 PARA_ERROR(UNIT_START, "AudioUnitStart() error"), \
156 PARA_ERROR(DEFAULT_COMP, "can not find default audio output component"), \
159 #define AUDIOC_ERRORS \
160 PARA_ERROR(AUDIOC_SYNTAX, "audioc syntax error"), \
161 PARA_ERROR(AUDIOC_READ, "audioc read error"), \
162 PARA_ERROR(AUDIOC_WRITE, "audioc write error"), \
163 PARA_ERROR(AUDIOC_OVERRUN, "audioc buffer overrun"), \
166 #define CLIENT_COMMON_ERRORS \
167 PARA_ERROR(CLIENT_SYNTAX, "syntax error"), \
168 PARA_ERROR(INVALID_CHALLENGE, "did not receive valid challenge"), \
169 PARA_ERROR(NO_CONFIG, "config file not found"), \
170 PARA_ERROR(CLIENT_AUTH, "authentication failed"), \
171 PARA_ERROR(SERVER_EOF, "connection closed by para_server"), \
174 #define SCHED_ERRORS \
175 PARA_ERROR(TASK_KILLED, "task killed"), \
176 PARA_ERROR(TASK_UNREGISTERED, "task has been unscheduled"), \
177 PARA_ERROR(NO_SUCH_TASK, "task not found"), \
178 PARA_ERROR(NOT_INITIALIZED, "scheduler not yet initialized"), \
181 #define STDIN_ERRORS \
182 PARA_ERROR(STDIN_EOF, "end of file"), \
187 PARA_ERROR(NAME_TOO_LONG, "name too long for struct sockaddr_un"), \
188 PARA_ERROR(ADDRESS_LOOKUP, "address lookup / socket creation failed"), \
189 PARA_ERROR(CHMOD, "failed to set socket mode"), \
190 PARA_ERROR(SENDMSG, "sendmsg() failed"), \
191 PARA_ERROR(RECVMSG, "recvmsg() failed"), \
192 PARA_ERROR(SCM_CREDENTIALS, "did not receive SCM credentials"), \
193 PARA_ERROR(RECV_PATTERN, "did not receive expected pattern"), \
196 #define ORTP_RECV_ERRORS \
197 PARA_ERROR(MSG_TO_BUF, "failed to extract rtp packet"), \
198 PARA_ERROR(ORTP_SYNTAX, "ortp syntax error"), \
199 PARA_ERROR(TOO_MANY_BAD_CHUNKS, "too many consecutive bad chunks"), \
200 PARA_ERROR(INVALID_HEADER, "invalid header packet"), \
201 PARA_ERROR(OVERRUN, "output buffer overrun"), \
202 PARA_ERROR(ORTP_RECV_EOF, "ortp_recv: end of file"), \
205 #define HTTP_RECV_ERRORS \
206 PARA_ERROR(HTTP_RECV_OVERRUN, "http_recv: output buffer overrun"), \
209 #define RECV_COMMON_ERRORS \
210 PARA_ERROR(RECV_SYNTAX, "recv syntax error"), \
211 PARA_ERROR(RECV_EOF, "end of file"), \
214 #define AUDIOD_ERRORS \
215 PARA_ERROR(NO_MORE_SLOTS, "no more empty slots"), \
216 PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
217 PARA_ERROR(UNSUPPORTED_AUDIO_FORMAT, "given audio format not supported"), \
218 PARA_ERROR(NOT_PLAYING, "not playing"), \
219 PARA_ERROR(AUDIOD_OFF, "audiod switched off"), \
220 PARA_ERROR(STATUS_TIMEOUT, "timeout reading server status"), \
223 #define AUDIOD_COMMAND_ERRORS \
224 PARA_ERROR(CLIENT_WRITE, "client write error"), \
225 PARA_ERROR(AUDIOD_SYNTAX, "syntax error"), \
226 PARA_ERROR(UCRED_PERM, "permission denied"), \
227 PARA_ERROR(INVALID_AUDIOD_CMD, "invalid command"), \
230 #define FILTER_CHAIN_ERRORS \
231 PARA_ERROR(UNSUPPORTED_FILTER, "given filter not supported"), \
232 PARA_ERROR(BAD_FILTER_OPTIONS, "invalid filter option given"), \
233 PARA_ERROR(FC_EOF, "filter chain: eof"), \
236 #define STAT_ERRORS \
237 PARA_ERROR(TOO_MANY_CLIENTS, "maximal number of stat clients exceeded"), \
238 PARA_ERROR(UNKNOWN_STAT_ITEM, "status item not recognized"), \
241 #define OGGDEC_ERRORS \
242 PARA_ERROR(OGGDEC_READ, "read from media returned an error"), \
243 PARA_ERROR(OGGDEC_NOTVORBIS, "bitstream is not vorbis data"), \
244 PARA_ERROR(OGGDEC_VERSION, "vorbis version mismatch"), \
245 PARA_ERROR(OGGDEC_BADHEADER, "invalid vorbis bitstream header"), \
246 PARA_ERROR(OGGDEC_FAULT, "bug or heap/stack corruption"), \
247 PARA_ERROR(OGGDEC_BADLINK, "invalid stream section or requested link corrupt"), \
250 #define GRAB_CLIENT_ERRORS \
251 PARA_ERROR(PEDANTIC_GRAB, "fd not ready and pedantic grab requested"), \
252 PARA_ERROR(GC_WRITE, "grab client write error"), \
253 PARA_ERROR(BAD_GC_SLOT, "invalid slot requested by grab client"), \
254 PARA_ERROR(BAD_GC_FILTER_NUM, "invalid filter number given"), \
255 PARA_ERROR(GC_SYNTAX, "grab client syntax error"), \
256 PARA_ERROR(GC_HELP_GIVEN, ""), /* not really an error */ \
257 PARA_ERROR(GC_VERSION_GIVEN, ""), /* not really an error */ \
260 #define MP3DEC_ERRORS \
261 PARA_ERROR(MAD_FRAME_DECODE, "mad frame decode error"), \
262 PARA_ERROR(MP3DEC_OVERRUN, "mp3 output buffer overrun"), \
265 #define FILTER_ERRORS \
266 PARA_ERROR(NO_FILTERS, "at least one filter must be given"), \
267 PARA_ERROR(FILTER_SYNTAX, "syntax error"), \
270 #define SIGNAL_ERRORS \
271 PARA_ERROR(SIGNAL_SIG_ERR, "signal() returned SIG_ERR"), \
274 #define STRING_ERRORS \
275 PARA_ERROR(ATOI_OVERFLOW, "value too large"), \
276 PARA_ERROR(STRTOLL, "unknown strtoll error"), \
277 PARA_ERROR(ATOI_NO_DIGITS, "no digits found in string"), \
278 PARA_ERROR(ATOI_JUNK_AT_END, "further characters after number"), \
281 #define EXEC_ERRORS \
282 PARA_ERROR(DUP_PIPE, "exec error: can not create pipe"), \
285 #define MP3_AFH_ERRORS \
286 PARA_ERROR(FRAME, "invalid mp3 frame"), \
287 PARA_ERROR(FRAME_LENGTH, "invalid frame length"), \
288 PARA_ERROR(MP3_INFO, "could not read mp3 info"), \
289 PARA_ERROR(HEADER_FREQ, "invalid header frequency"), \
290 PARA_ERROR(HEADER_BITRATE, "invalid header bitrate"), \
293 #define AAC_AFH_ERRORS \
294 PARA_ERROR(STSZ, "did not find stcz atom"), \
295 PARA_ERROR(MP4ASC, "audio spec config error"), \
296 PARA_ERROR(AAC_AFH_INIT, "failed to init aac decoder"), \
299 #define AAC_COMMON_ERRORS \
300 PARA_ERROR(ESDS, "did not find esds atom"), \
301 PARA_ERROR(STCO, "did not find stco atom"), \
304 #define OGG_AFH_ERRORS \
305 PARA_ERROR(OGG_READ, "ogg read error"), \
306 PARA_ERROR(SYNC_PAGEOUT, "ogg sync page-out error (no ogg file?)"), \
307 PARA_ERROR(STREAM_PAGEIN, "ogg stream page-in error (first page)"), \
308 PARA_ERROR(STREAM_PACKETOUT, "ogg stream packet-out error (first packet)"), \
309 PARA_ERROR(VORBIS, "vorbis synthesis header-in error (not vorbis?)"), \
310 PARA_ERROR(OGG_INFO, "ov_info error"), \
311 PARA_ERROR(OGG_VERSION, "unsupported ogg version"), \
312 PARA_ERROR(OGG_BAD_HEADER, "invalid ogg vorbis header"), \
313 PARA_ERROR(OGG_UNKNOWN_ERROR, "unknown ogg vorbis error"), \
317 PARA_ERROR(CHUNK, "unable to get chunk"), \
318 PARA_ERROR(NOFD, "did not receive open fd from afs"), \
321 #define CRYPT_ERRORS \
322 PARA_ERROR(PRIVATE_KEY, "can not read private key"), \
323 PARA_ERROR(PUBLIC_KEY, "can not read public key"), \
324 PARA_ERROR(RSA, "RSA error"), \
325 PARA_ERROR(ENCRYPT, "encrypt error"), \
326 PARA_ERROR(DECRYPT, "decrypt error"), \
327 PARA_ERROR(CHALLENGE, "failed to read challenge"), \
330 #define HTTP_SEND_ERRORS \
331 PARA_ERROR(MAX_CLIENTS, "maximal number of clients exceeded"), \
334 #define COMMAND_ERRORS \
335 PARA_ERROR(COMMAND_SYNTAX, "syntax error in command"), \
336 PARA_ERROR(AUTH, "did not receive auth request"), \
337 PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
338 PARA_ERROR(BAD_CMD, "invalid command"), \
339 PARA_ERROR(PERM, "permission denied"), \
340 PARA_ERROR(LOCK, "lock error"), \
341 PARA_ERROR(SENDER_CMD, "command not supported by this sender"), \
342 PARA_ERROR(SERVER_CRASH, "para_server crashed -- can not live without it"), \
343 PARA_ERROR(BAD_USER, "you don't exist. Go away."), \
346 #define DCCP_RECV_ERRORS \
347 PARA_ERROR(DCCP_OVERRUN, "dccp output buffer buffer overrun"), \
350 #define DCCP_SEND_ERRORS \
354 PARA_ERROR(FGETS, "fgets error"), \
355 PARA_ERROR(EMPTY, "file empty"), \
356 PARA_ERROR(MMAP, "mmap error"), \
359 #define WRITE_ERRORS \
360 PARA_ERROR(WRITE_SYNTAX, "para_write syntax error"), \
361 PARA_ERROR(NO_WAV_HEADER, "wave header not found"), \
362 PARA_ERROR(WAV_HEADER_SUCCESS, "successfully read wave header"), \
363 PARA_ERROR(NO_DELAY, "no initial delay"), \
364 PARA_ERROR(DELAY_TIMEOUT, "initial delay timeout"), \
367 #define ALSA_WRITE_ERRORS \
368 PARA_ERROR(BROKEN_CONF, "Broken alsa configuration"), \
369 PARA_ERROR(ACCESS_TYPE, "alsa access type not available"), \
370 PARA_ERROR(SAMPLE_FORMAT, "sample format not available"), \
371 PARA_ERROR(CHANNEL_COUNT, "channels count not available"), \
372 PARA_ERROR(HW_PARAMS, "unable to install hw params"), \
373 PARA_ERROR(SW_PARAMS, "unable to install sw params"), \
374 PARA_ERROR(BAD_PERIOD, "can not use period equal to buffer size"), \
375 PARA_ERROR(ALSA_WRITE, "alsa write error"), \
376 PARA_ERROR(PCM_OPEN, "unable to open pcm"), \
377 PARA_ERROR(SND_PCM_INFO, "pcm info error"), \
378 PARA_ERROR(GET_BUFFER_TIME, "snd_pcm_hw_params_get_buffer_time_max() failed"), \
379 PARA_ERROR(SET_BUFFER_TIME, "snd_pcm_hw_params_set_buffer_time_near() failed"), \
380 PARA_ERROR(SET_RATE, "snd_pcm_hw_params_set_rate_near failed"), \
381 PARA_ERROR(START_THRESHOLD, "snd_pcm_sw_params_set_start_threshold() failed"), \
382 PARA_ERROR(STOP_THRESHOLD, "snd_pcm_sw_params_set_stop_threshold() failed"), \
385 #define FILE_WRITE_ERRORS \
386 PARA_ERROR(FW_WRITE, "file writer write error"), \
387 PARA_ERROR(FW_OPEN, "file writer: can not open output file"), \
388 PARA_ERROR(FW_NO_FILE, "task started without open file"), \
391 #define WRITE_COMMON_ERRORS \
392 PARA_ERROR(WRITE_COMMON_SYNTAX, "syntax error in write option"), \
395 #define AACDEC_ERRORS \
396 PARA_ERROR(AACDEC_INIT, "failed to init aac decoder"), \
397 PARA_ERROR(AAC_DECODE, "aac decode error"), \
398 PARA_ERROR(AAC_OVERRUN, "aac output buffer overrun"), \
401 #define CHUNK_QUEUE_ERRORS \
402 PARA_ERROR(QUEUE, "packet queue overrun"), \
408 * The subsystem shift.
410 * 255 error codes ought to be enough for every subsystem. Use the higher bits
411 * of the return value to encode the subsystem number.
416 * Compute the subsystem offset.
418 * It is given by x * 2**8 where \a x is the subsystem number.
420 #define SS_OFFSET(ss) (SS_ ## ss << SS_SHIFT)
423 * Make the enum of all errors of one subsystem.
425 * As zero should not be an error, we define a dummy enum entry with value
426 * 2**ss. That lets the real errors start at 2**ss + 1.
428 #define SS_ENUM(ss) enum {\
429 E_ ## ss ## _DUMMY = SS_OFFSET(ss), \
433 * Determine the subsystem number from the error number.
435 * Easy, it's just \a num / 2**8.
437 #define ERRNUM_TO_SS(num) ((num) >> SS_SHIFT)
440 * Determine the index of an error number.
442 * Also easy: It's the lower 8 bits of num.
444 #define ERRNUM_TO_INDEX(num) (((1 << SS_SHIFT) - 1) & (num))
447 * This bit indicates whether a number is considered a system error number
448 * If yes, the system errno is just the result of clearing this bit from
451 #define SYSTEM_ERROR_BIT 30
453 /** Check whether the system error bit is set. */
454 #define IS_SYSTEM_ERROR(num) (!!((num) & (1 << SYSTEM_ERROR_BIT)))
456 /** Set the system error bit for the given number. */
457 #define ERRNO_TO_PARA_ERROR(num) ((num) | (1 << SYSTEM_ERROR_BIT))
459 /** Check whether a given number is a system error number.
461 * \param num The value to be checked.
462 * \param _errno The system error number.
464 * \return True if \a num is paraslash's representation of the system
465 * error identified by \a _errno.
467 _static_inline_ int is_errno(int num, int _errno)
469 assert(num > 0 && _errno > 0);
470 return ERRNO_TO_PARA_ERROR(_errno) == num;
474 * Paraslash's version of strerror(3).
476 * \param num The error number.
478 * \return The error text of \a num.
480 _static_inline_ const char *para_strerror(int num)
483 if (IS_SYSTEM_ERROR(num))
484 return strerror((num) & ((1 << SYSTEM_ERROR_BIT) - 1));
486 return para_errlist[ERRNUM_TO_SS(num)][ERRNUM_TO_INDEX(num)];
489 * Define the error list for one subsystem.
491 * The first entry (index 0) is always the name of the subsystem
492 * Used by macros in config.h (generated by configure).
494 #define DEFINE_ERRLIST(ss) const char * ss ## _ERRLIST[] = {#ss, ss ## _ERRORS}
497 * Activate errors for one subsystem.
499 * Each executable needs only the error lists of those subsystems it is
500 * actually linked with. We always reserve space for NUM_SS char pointers,
501 * but only init those of the needed subsystems. This macro is used by macros
502 * in config.h (generated by configure).
504 #define PARA_ERRLIST(ss) [SS_ ## ss] = ss ## _ERRLIST
507 * This is temporarily defined to expand to its first argument (prefixed by
508 * 'E_') and gets later redefined to expand to the error text only
510 #define PARA_ERROR(err, msg) E_ ## err
513 /* Rest of the world only sees the error text. */
514 #define PARA_ERROR(err, msg) msg