Merge branch 't/allow_zero_btr_add'
[paraslash.git] / error.h
1 /*
2 * Copyright (C) 2006-2013 Andre Noll <maan@systemlinux.org>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file error.h List of error messages for all subsystems. */
8
9 /** \cond errors */
10
11 /* List of all subsystems that use paraslash's error facility. */
12 DEFINE_ERRLIST_OBJECT_ENUM;
13
14 /* these do not need error handling (yet) */
15 #define SERVER_ERRORS
16 #define TIME_ERRORS
17 #define CLOSE_ON_FORK_ERRORS
18 #define DAEMON_ERRORS
19 #define GUI_ERRORS
20 #define GUI_THEME_ERRORS
21 #define RINGBUFFER_ERRORS
22 #define SCORE_ERRORS
23 #define RBTREE_ERRORS
24 #define RECV_ERRORS
25 #define IPC_ERRORS
26 #define DCCP_SEND_ERRORS
27 #define HTTP_SEND_ERRORS
28 #define GGO_ERRORS
29 #define COLOR_ERRORS
30 #define SIGNAL_ERRORS
31 #define FADE_ERRORS
32 #define STDOUT_ERRORS
33 #define FILE_WRITE_ERRORS
34 #define STDIN_ERRORS
35 #define WRITE_ERRORS
36 #define CHECK_WAV_ERRORS
37
38 extern const char **para_errlist[];
39
40 #define OSS_MIX_ERRORS \
41 PARA_ERROR(OSS_MIXER_CHANNEL, "invalid mixer channel"), \
42
43 #define ALSA_MIX_ERRORS \
44 PARA_ERROR(ALSA_MIX_OPEN, "could not open mixer"), \
45 PARA_ERROR(ALSA_MIX_BAD_ELEM, "invalid/unsupported control element"), \
46 PARA_ERROR(ALSA_MIX_GET_VAL, "could not read control element state"), \
47 PARA_ERROR(ALSA_MIX_SET_VAL, "could not set control element state"), \
48
49
50 #define RESAMPLE_FILTER_ERRORS \
51 PARA_ERROR(RESAMPLE_EOF, "resample filter: end of file"), \
52 PARA_ERROR(LIBSAMPLERATE, "secret rabbit code error"), \
53
54
55 #define SIDEBAND_ERRORS \
56 PARA_ERROR(BAD_BAND, "invalid or unexpected band designator"), \
57 PARA_ERROR(SB_PACKET_SIZE, "invalid sideband packet size or protocol error"), \
58
59
60 #define PLAY_ERRORS \
61 PARA_ERROR(PLAY_SYNTAX, "para_play: syntax error"), \
62 PARA_ERROR(NO_VALID_FILES, "no valid file found in playlist"), \
63 PARA_ERROR(TERM_RQ, "user termination request"), \
64 PARA_ERROR(BAD_PLAY_CMD, "invalid command"), \
65
66
67 #define FLACDEC_FILTER_ERRORS \
68 PARA_ERROR(FLACDEC_DECODER_ALLOC, "could not allocate stream decoder"), \
69 PARA_ERROR(FLACDEC_DECODER_INIT, "could not init stream decoder"), \
70 PARA_ERROR(FLACDEC_EOF, "flacdec encountered end of file condition"), \
71
72
73 #define FLAC_AFH_ERRORS \
74 PARA_ERROR(FLAC_CHAIN_ALLOC, "could not create metadata chain"), \
75 PARA_ERROR(FLAC_CHAIN_READ, "could not read meta chain"), \
76 PARA_ERROR(FLAC_ITER_ALLOC, "could not allocate meta iterator"), \
77 PARA_ERROR(FLAC_VARBLOCK, "variable blocksize not supported"), \
78 PARA_ERROR(FLAC_AFH_DECODER_ALLOC, "could not allocate stream decoder"), \
79 PARA_ERROR(FLAC_AFH_DECODER_INIT, "could not init stream decoder"), \
80 PARA_ERROR(FLAC_SKIP_META, "could not skip metadata"), \
81 PARA_ERROR(FLAC_DECODE_POS, "could not get decode position"), \
82 PARA_ERROR(FLAC_STREAMINFO, "could not read stream info meta block"), \
83
84
85 #define AFH_RECV_ERRORS \
86 PARA_ERROR(AFH_RECV_BAD_FILENAME, "invalid file name"), \
87
88
89 #define OGG_AFH_COMMON_ERRORS \
90 PARA_ERROR(STREAM_PACKETOUT, "ogg stream packet-out error (first packet)"), \
91 PARA_ERROR(SYNC_PAGEOUT, "ogg sync page-out error (no ogg file?)"), \
92 PARA_ERROR(STREAM_PAGEIN, "ogg stream page-in error (first page)"), \
93 PARA_ERROR(OGG_SYNC, "internal ogg storage overflow"), \
94 PARA_ERROR(OGG_EMPTY, "no ogg pages found"), \
95
96
97 #define SPX_AFH_ERRORS \
98 PARA_ERROR(SPX_COMMENT, "invalid speex comment"), \
99
100
101 #define SPX_COMMON_ERRORS \
102 PARA_ERROR(SPX_HEADER, "can not read speex header"), \
103 PARA_ERROR(SPX_HEADER_MODE, "invalid speex mode in header"), \
104 PARA_ERROR(SPX_VERSION, "incompatible speex bit stream version"), \
105 PARA_ERROR(SPX_DECODER_INIT, "speex decoder initialization failed"), \
106 PARA_ERROR(SPX_CTL_BAD_RQ, "speex_decoder_ctl: invalid request"), \
107 PARA_ERROR(SPX_CTL_INVAL, "speex_decoder_ctl: invalid argument"), \
108
109 #define SPXDEC_FILTER_ERRORS \
110 PARA_ERROR(SPX_DECODE, "speex decoding error"), \
111 PARA_ERROR(SPX_DECODE_OVERFLOW, "speex decoding overflow"), \
112 PARA_ERROR(SPX_EOS, "speex: end of stream"), \
113
114 #define BUFFER_TREE_ERRORS \
115 PARA_ERROR(BTR_EOF, "buffer tree: end of file"), \
116 PARA_ERROR(BTR_NO_CHILD, "btr node has no children"), \
117 PARA_ERROR(BTR_NAVAIL, "btr node: value currently unavailable"), \
118
119
120 #define BITSTREAM_ERRORS \
121 PARA_ERROR(VLC, "invalid vlc code"), \
122
123
124 #define WMA_AFH_ERRORS \
125 PARA_ERROR(NO_WMA, "asf/wma format not recognized"), \
126
127
128 #define WMA_COMMON_ERRORS \
129 PARA_ERROR(WMA_NO_GUID, "audio stream guid not found"), \
130
131
132 #define WMADEC_FILTER_ERRORS \
133 PARA_ERROR(WMA_BAD_PARAMS, "invalid WMA parameters"), \
134 PARA_ERROR(WMA_OUTPUT_SPACE, "insufficient output space"), \
135 PARA_ERROR(WMA_BAD_SUPERFRAME, "invalid superframe"), \
136 PARA_ERROR(WMA_BLOCK_SIZE, "invalid block size"), \
137 PARA_ERROR(INCOHERENT_BLOCK_LEN, "incoherent block length"), \
138 PARA_ERROR(WMADEC_EOF, "wmadec: end of file"), \
139
140
141 #define IMDCT_ERRORS \
142 PARA_ERROR(FFT_BAD_PARAMS, "invalid params for fft"), \
143
144
145 #define PREBUFFER_FILTER_ERRORS \
146 PARA_ERROR(PREBUFFER_SYNTAX, "syntax error in prebuffer filter config"), \
147 PARA_ERROR(PREBUFFER_SUCCESS, "prebuffering complete"), \
148
149
150 #define OSS_WRITE_ERRORS \
151 PARA_ERROR(BAD_SAMPLE_FORMAT, "sample format not supported"), \
152 PARA_ERROR(BAD_CHANNEL_COUNT, "channel count not supported"), \
153 PARA_ERROR(BAD_SAMPLERATE, "sample rate not supported"), \
154
155
156 #define AO_WRITE_ERRORS \
157 PARA_ERROR(AO_DEFAULT_DRIVER, "ao: no usable output device"), \
158 PARA_ERROR(AO_BAD_DRIVER, "ao: invalid driver"), \
159 PARA_ERROR(AO_BAD_OPTION, "ao option is not of type key:value"), \
160 PARA_ERROR(AO_APPEND_OPTION, "ao append option: memory allocation failure"), \
161 PARA_ERROR(AO_OPEN_LIVE, "ao: could not open audio device"), \
162 PARA_ERROR(AO_FILE_NOT_SUPP, "ao: file io drivers not supported"), \
163 PARA_ERROR(AO_PLAY, "ao_play() failed"), \
164 PARA_ERROR(AO_BAD_SAMPLE_FORMAT, "ao: unsigned sample formats not supported"), \
165 PARA_ERROR(AO_PTHREAD, "pthread error"), \
166
167
168 #define COMPRESS_FILTER_ERRORS \
169 PARA_ERROR(COMPRESS_SYNTAX, "syntax error in compress filter config"), \
170 PARA_ERROR(COMPRESS_EOF, "compress: end of file"), \
171
172
173 #define WAV_FILTER_ERRORS \
174 PARA_ERROR(WAV_BAD_FC, "invalid filter configuration"), \
175 PARA_ERROR(WAV_EOF, "wav filter: end of file"), \
176 PARA_ERROR(WAV_SUCCESS, "successfully wrote wav header"), \
177
178
179 #define FEC_ERRORS \
180 PARA_ERROR(FEC_BAD_IDX, "invalid index vector"), \
181 PARA_ERROR(FEC_SINGULAR, "unexpected singular matrix"), \
182 PARA_ERROR(FEC_PIVOT, "pivot column not found"), \
183 PARA_ERROR(FEC_PARMS, "invalid fec parameters"), \
184
185
186 #define FECDEC_FILTER_ERRORS \
187 PARA_ERROR(BAD_FEC_HEADER, "invalid fec header"), \
188 PARA_ERROR(BAD_SLICE_SIZE, "slice size zero or too large"), \
189 PARA_ERROR(BAD_SLICE_NUM, "invalid slice number"), \
190 PARA_ERROR(FECDEC_OVERRUN, "fecdec output buffer overrun"), \
191 PARA_ERROR(FECDEC_EOF, "received eof packet"), \
192
193
194 #define AMP_FILTER_ERRORS \
195 PARA_ERROR(AMP_SYNTAX, "syntax error in amp filter config"), \
196 PARA_ERROR(AMP_ZERO_AMP, "no amplification necessary"), \
197 PARA_ERROR(AMP_EOF, "amp: end of file"), \
198
199
200 #define SEND_COMMON_ERRORS \
201 PARA_ERROR(MAX_CLIENTS, "maximal number of clients exceeded"), \
202
203
204 #define CLIENT_ERRORS \
205 PARA_ERROR(TASK_STARTED, "task started"), \
206
207
208 #define AFH_ERRORS \
209 PARA_ERROR(AFH_SYNTAX, "afh syntax error"), \
210 PARA_ERROR(AFH_SHORT_WRITE, "afh short write"), \
211
212
213 #define AFH_COMMON_ERRORS \
214 PARA_ERROR(AUDIO_FORMAT, "audio format not recognized"), \
215
216
217 #define ACL_ERRORS \
218 PARA_ERROR(ACL_PERM, "access denied by acl"), \
219
220
221 #define AFS_ERRORS \
222 PARA_ERROR(BAD_TABLE_NAME, "invalid table"), \
223 PARA_ERROR(AFS_SYNTAX, "afs syntax error"), \
224 PARA_ERROR(AFS_SIGNAL, "afs caught deadly signal"), \
225 PARA_ERROR(AFS_SOCKET, "afs socket not writable"), \
226
227
228 #define MOOD_ERRORS \
229 PARA_ERROR(NO_MOOD, "no mood available"), \
230 PARA_ERROR(DUMMY_ROW, "attempted to access blob dummy object"), \
231
232
233 #define MM_ERRORS \
234 PARA_ERROR(MOOD_SYNTAX, "mood syntax error"), \
235
236
237 #define ATTRIBUTE_ERRORS \
238 PARA_ERROR(ATTR_SYNTAX, "attribute syntax error"), \
239 PARA_ERROR(NO_ATTRIBUTES, "no attributes defined yet"), \
240 PARA_ERROR(ATT_TABLE_FULL, "no more space left in attribute table"), \
241
242
243 #define BLOB_ERRORS \
244 PARA_ERROR(BLOB_SYNTAX, "blob syntax error"), \
245 PARA_ERROR(INPUT_TOO_LARGE, "input too large for stdin command"), \
246
247
248 #define PLAYLIST_ERRORS \
249 PARA_ERROR(PLAYLIST_LOADED, ""), /* not really an error */ \
250 PARA_ERROR(PATH_FOUND, ""), /* not really an error */ \
251 PARA_ERROR(PLAYLIST_EMPTY, "attempted to load empty playlist"), \
252
253
254 #define AFT_ERRORS \
255 PARA_ERROR(BAD_AFSI, "invaiid afs info"), \
256 PARA_ERROR(LOCALTIME, "localtime() failed"), \
257 PARA_ERROR(STRFTIME, "strftime() failed"), \
258 PARA_ERROR(BAD_PATH, "invalid path"), \
259 PARA_ERROR(BAD_SORT, "invalid sorting method"), \
260 PARA_ERROR(FNMATCH, "fnmatch error"), \
261 PARA_ERROR(NO_AFHI, "audio format handler info required"), \
262 PARA_ERROR(AFT_SYNTAX, "audio file table syntax error"), \
263 PARA_ERROR(HASH_MISMATCH, "hash mismatch, consider re-add"), \
264
265
266 #define USER_LIST_ERRORS \
267 PARA_ERROR(USERLIST, "failed to open user list file"), \
268
269
270 #define OSX_WRITE_ERRORS \
271 PARA_ERROR(STREAM_FORMAT, "could not set stream format"), \
272 PARA_ERROR(ADD_CALLBACK, "can not add callback"), \
273 PARA_ERROR(OPEN_COMP, "OpenAComponent() error"), \
274 PARA_ERROR(UNIT_INIT, "AudioUnitInitialize() error"), \
275 PARA_ERROR(UNIT_START, "AudioUnitStart() error"), \
276 PARA_ERROR(DEFAULT_COMP, "can not find default audio output component"), \
277
278
279 #define AUDIOC_ERRORS \
280 PARA_ERROR(AUDIOC_SYNTAX, "audioc syntax error"), \
281 PARA_ERROR(AUDIOC_EOF, "audioc: end of file"), \
282
283
284 #define CLIENT_COMMON_ERRORS \
285 PARA_ERROR(CLIENT_SYNTAX, "syntax error"), \
286 PARA_ERROR(NO_CONFIG, "config file not found"), \
287 PARA_ERROR(BAD_CONFIG, "syntax error in config file"), \
288 PARA_ERROR(CLIENT_AUTH, "authentication failed"), \
289 PARA_ERROR(SERVER_EOF, "connection closed by para_server"), \
290 PARA_ERROR(SERVER_CMD_SUCCESS, "command terminated successfully"), \
291 PARA_ERROR(SERVER_CMD_FAILURE, "command failed"), \
292
293
294 #define SCHED_ERRORS \
295 PARA_ERROR(NOT_INITIALIZED, "scheduler not yet initialized"), \
296 PARA_ERROR(SCHED_SHUTDOWN, "scheduler was shut down"), \
297
298
299 #define NET_ERRORS \
300 PARA_ERROR(NAME_TOO_LONG, "name too long for struct sockaddr_un"), \
301 PARA_ERROR(ADDRESS_LOOKUP, "can not resolve requested address"),\
302 PARA_ERROR(CHMOD, "failed to set socket mode"), \
303 PARA_ERROR(SENDMSG, "sendmsg() failed"), \
304 PARA_ERROR(RECVMSG, "recvmsg() failed"), \
305 PARA_ERROR(SCM_CREDENTIALS, "did not receive SCM credentials"), \
306 PARA_ERROR(MAKESOCK, "makesock error"), \
307
308
309 #define UDP_RECV_ERRORS \
310 PARA_ERROR(UDP_SYNTAX, "udp_recv syntax error"), \
311 PARA_ERROR(UDP_OVERRUN, "output buffer overrun"), \
312
313
314 #define UDP_SEND_ERRORS \
315 PARA_ERROR(TARGET_EXISTS, "requested target is already present"),\
316 PARA_ERROR(TARGET_NOT_FOUND, "requested target not found")
317
318
319 #define HTTP_RECV_ERRORS \
320 PARA_ERROR(HTTP_RECV_OVERRUN, "http_recv: output buffer overrun"), \
321
322
323 #define RECV_COMMON_ERRORS \
324 PARA_ERROR(RECV_SYNTAX, "recv syntax error"), \
325 PARA_ERROR(RECV_EOF, "end of file"), \
326
327
328 #define AUDIOD_ERRORS \
329 PARA_ERROR(NO_MORE_SLOTS, "no more empty slots"), \
330 PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
331 PARA_ERROR(UNSUPPORTED_AUDIO_FORMAT, "given audio format not supported"), \
332 PARA_ERROR(NOT_PLAYING, "not playing"), \
333 PARA_ERROR(AUDIOD_OFF, "audiod switched off"), \
334 PARA_ERROR(STATUS_TIMEOUT, "timeout reading server status"), \
335
336
337 #define AUDIOD_COMMAND_ERRORS \
338 PARA_ERROR(CLIENT_WRITE, "client write error"), \
339 PARA_ERROR(UCRED_PERM, "permission denied"), \
340 PARA_ERROR(INVALID_AUDIOD_CMD, "invalid command"), \
341 PARA_ERROR(TOO_MANY_CLIENTS, "maximal number of stat clients exceeded"), \
342 PARA_ERROR(UNKNOWN_STAT_ITEM, "status item not recognized"), \
343
344
345 #define FILTER_COMMON_ERRORS \
346 PARA_ERROR(BAD_FILTER_OPTIONS, "invalid filter option given"), \
347 PARA_ERROR(UNSUPPORTED_FILTER, "given filter not supported"), \
348
349
350 #define STAT_ERRORS \
351 PARA_ERROR(STAT_ITEM_PARSE, "failed to parse status item"), \
352
353
354 #define OGGDEC_FILTER_ERRORS \
355 PARA_ERROR(OGGDEC_READ, "read from media returned an error"), \
356 PARA_ERROR(OGGDEC_NOTVORBIS, "bitstream is not vorbis data"), \
357 PARA_ERROR(OGGDEC_VERSION, "vorbis version mismatch"), \
358 PARA_ERROR(OGGDEC_BADHEADER, "invalid vorbis bitstream header"), \
359 PARA_ERROR(OGGDEC_FAULT, "bug or heap/stack corruption"), \
360 PARA_ERROR(OGGDEC_BADLINK, "invalid stream section or requested link corrupt"), \
361
362
363 #define GRAB_CLIENT_ERRORS \
364 PARA_ERROR(GC_WRITE, "grab client write error"), \
365 PARA_ERROR(GC_SYNTAX, "grab client syntax error"), \
366
367
368 #define MP3DEC_FILTER_ERRORS \
369 PARA_ERROR(MAD_FRAME_DECODE, "mad frame decode error"), \
370 PARA_ERROR(MP3DEC_SYNTAX, "syntax error in mp3dec config"), \
371 PARA_ERROR(MP3DEC_EOF, "mp3dec: end of file"), \
372 PARA_ERROR(MP3DEC_CORRUPT, "too many corrupt frames"), \
373
374
375 #define FILTER_ERRORS \
376 PARA_ERROR(NO_FILTERS, "at least one filter must be given"), \
377 PARA_ERROR(FILTER_SYNTAX, "syntax error"), \
378
379
380 #define STRING_ERRORS \
381 PARA_ERROR(ATOI_OVERFLOW, "value too large"), \
382 PARA_ERROR(STRTOLL, "unknown strtoll error"), \
383 PARA_ERROR(ATOI_NO_DIGITS, "no digits found in string"), \
384 PARA_ERROR(ATOI_JUNK_AT_END, "further characters after number"), \
385 PARA_ERROR(SIZE_PREFIX, "bad size prefix"), \
386 PARA_ERROR(REGEX, "regular expression error"), \
387 PARA_ERROR(ARG_NOT_FOUND, "argument not found in arg vector"), \
388
389
390 #define EXEC_ERRORS \
391 PARA_ERROR(DUP_PIPE, "exec error: can not create pipe"), \
392
393
394 #define MP3_AFH_ERRORS \
395 PARA_ERROR(FRAME, "invalid mp3 frame"), \
396 PARA_ERROR(FRAME_LENGTH, "invalid frame length"), \
397 PARA_ERROR(MP3_INFO, "could not read mp3 info"), \
398 PARA_ERROR(HEADER_FREQ, "invalid header frequency"), \
399 PARA_ERROR(HEADER_BITRATE, "invalid header bitrate"), \
400
401
402 #define AAC_AFH_ERRORS \
403 PARA_ERROR(STSZ, "did not find stcz atom"), \
404 PARA_ERROR(MP4ASC, "audio spec config error"), \
405 PARA_ERROR(AAC_AFH_INIT, "failed to init aac decoder"), \
406
407
408 #define AAC_COMMON_ERRORS \
409 PARA_ERROR(ESDS, "did not find esds atom"), \
410 PARA_ERROR(STCO, "did not find stco atom"), \
411
412
413 #define OGG_AFH_ERRORS \
414 PARA_ERROR(VORBIS, "vorbis synthesis header-in error (not vorbis?)"), \
415 PARA_ERROR(OGG_PACKET_IN, "ogg_stream_packetin() failed"), \
416 PARA_ERROR(OGG_STREAM_FLUSH, "ogg_stream_flush() failed"), \
417
418
419 #define VSS_ERRORS \
420 PARA_ERROR(NOFD, "did not receive open fd from afs"), \
421 PARA_ERROR(BAD_CT, "invalid chunk table or bad FEC configuration"), \
422 PARA_ERROR(AFS_SHORT_READ, "short read from afs socket"), \
423
424
425 #define CRYPT_COMMON_ERRORS \
426 PARA_ERROR(SSH_KEY_HEADER, "ssh key header not found"), \
427 PARA_ERROR(BASE64, "failed to base64-decode ssh public key"), \
428 PARA_ERROR(KEY_PERM, "unprotected private key"), \
429
430
431 #define CRYPT_ERRORS \
432 PARA_ERROR(PRIVATE_KEY, "can not read private key"), \
433 PARA_ERROR(PUBLIC_KEY, "can not read public key"), \
434 PARA_ERROR(RSA, "RSA error"), \
435 PARA_ERROR(ENCRYPT, "encrypt error"), \
436 PARA_ERROR(DECRYPT, "decrypt error"), \
437 PARA_ERROR(BLINDING, "failed to activate key blinding"), \
438 PARA_ERROR(BIGNUM, "bignum error"), \
439
440 #define GCRYPT_ERRORS \
441 PARA_ERROR(MPI_SCAN, "could not scan multi-precision integer"), \
442 PARA_ERROR(MPI_PRINT, "could not convert multi-precision integer"), \
443 PARA_ERROR(SEXP_FIND, "could not find sublist in S-expression"), \
444 PARA_ERROR(SEXP_BUILD, "could not build S-expression"), \
445 PARA_ERROR(SEXP_ENCRYPT, "could not encrypt S-expression"), \
446 PARA_ERROR(SEXP_DECRYPT, "could not decrypt S-expression"), \
447 PARA_ERROR(MD_OPEN, "could not open message digest object"), \
448 PARA_ERROR(CIPHER_OPEN, "could not create stream cipher handle"), \
449 PARA_ERROR(BAD_PRIVATE_KEY, "invalid private key"), \
450 PARA_ERROR(KEY_MARKER, "invalid/missing key header or footer"), \
451 PARA_ERROR(ASN1_PARSE, "could not parse ASN.1 key"), \
452 PARA_ERROR(SSH_PARSE, "could not parse ssh public key"), \
453 PARA_ERROR(OEAP, "error during oeap (un)padding"), \
454
455
456 #define COMMAND_ERRORS \
457 PARA_ERROR(COMMAND_SYNTAX, "syntax error in command"), \
458 PARA_ERROR(AUTH_REQUEST, "did not receive auth request"), \
459 PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
460 PARA_ERROR(BAD_CMD, "invalid command"), \
461 PARA_ERROR(PERM, "permission denied"), \
462 PARA_ERROR(LOCK, "lock error"), \
463 PARA_ERROR(SENDER_CMD, "command not supported by this sender"), \
464 PARA_ERROR(SERVER_CRASH, "para_server crashed -- can not live without it"), \
465 PARA_ERROR(BAD_USER, "auth request for invalid user"), \
466 PARA_ERROR(BAD_FEATURE, "request for unknown or invalid feature"), \
467 PARA_ERROR(BAD_AUTH, "authentication failure"), \
468
469
470 #define DCCP_RECV_ERRORS \
471 PARA_ERROR(DCCP_OVERRUN, "dccp output buffer buffer overrun"), \
472
473
474 #define FD_ERRORS \
475 PARA_ERROR(FGETS, "fgets error"), \
476 PARA_ERROR(EOF, "end of file"), \
477 PARA_ERROR(READ_PATTERN, "did not read expected pattern"), \
478 PARA_ERROR(SHORT_WRITE, "unexpected short write"), \
479 PARA_ERROR(EMPTY, "file is empty"), \
480
481
482 #define ALSA_WRITE_ERRORS \
483 PARA_ERROR(ALSA, "alsa error"), \
484
485
486 #define WRITE_COMMON_ERRORS \
487 PARA_ERROR(WRITE_COMMON_EOF, "end of file"), \
488
489
490 #define AACDEC_FILTER_ERRORS \
491 PARA_ERROR(AACDEC_INIT, "failed to init aac decoder"), \
492 PARA_ERROR(AAC_DECODE, "aac decode error"), \
493
494
495 #define CHUNK_QUEUE_ERRORS \
496 PARA_ERROR(QUEUE, "packet queue overrun"), \
497
498
499 #define INTERACTIVE_ERRORS \
500 PARA_ERROR(I9E_EOF, "end of input"), \
501 PARA_ERROR(I9E_SETUPTERM, "failed to set up terminal"), \
502 PARA_ERROR(I9E_TERM_RQ, "received termination request"), \
503
504 /** \endcond errors */
505
506 /**
507 * The subsystem shift.
508 *
509 * 255 error codes ought to be enough for every subsystem. Use the higher bits
510 * of the return value to encode the subsystem number.
511 */
512 #define SS_SHIFT 8
513
514 /**
515 * Compute the subsystem offset.
516 *
517 * It is given by x * 2**8 where \a x is the subsystem number.
518 */
519 #define SS_OFFSET(ss) (SS_ ## ss << SS_SHIFT)
520
521 /**
522 * Make the enum of all errors of one subsystem.
523 *
524 * As zero should not be an error, we define a dummy enum entry with value
525 * 2**ss. That lets the real errors start at 2**ss + 1.
526 */
527 #define SS_ENUM(ss) enum {\
528 E_ ## ss ## _DUMMY = SS_OFFSET(ss), \
529 ss ## _ERRORS}
530
531 /**
532 * Determine the subsystem number from the error number.
533 *
534 * Easy, it's just \a num / 2**8.
535 */
536 #define ERRNUM_TO_SS(num) ((num) >> SS_SHIFT)
537
538 /**
539 * Determine the index of an error number.
540 *
541 * Also easy: It's the lower 8 bits of num.
542 */
543 #define ERRNUM_TO_INDEX(num) (((1 << SS_SHIFT) - 1) & (num))
544
545 /**
546 * This bit indicates whether a number is considered a system error number
547 * If yes, the system errno is just the result of clearing this bit from
548 * the given number.
549 */
550 #define SYSTEM_ERROR_BIT 30
551
552 /**
553 * Like the SYSTEM_ERROR_BIT, but indicates an error from the osl library.
554 */
555 #define OSL_ERROR_BIT 29
556
557 /** Check whether the system error bit is set. */
558 #define IS_SYSTEM_ERROR(num) (!!((num) & (1 << SYSTEM_ERROR_BIT)))
559
560 /** Check whether the osl error bit is set. */
561 #define IS_OSL_ERROR(num) (!!((num) & (1 << OSL_ERROR_BIT)))
562
563 /** Set the system error bit for the given number. */
564 #define ERRNO_TO_PARA_ERROR(num) ((num) | (1 << SYSTEM_ERROR_BIT))
565
566 /** Set the osl error bit for the given number. */
567 #define OSL_ERRNO_TO_PARA_ERROR(num) ((num) | (1 << OSL_ERROR_BIT))
568
569 /** Check whether a given number is a system error number.
570 *
571 * \param num The value to be checked.
572 * \param _errno The system error number.
573 *
574 * \return True if \a num is paraslash's representation of the system
575 * error identified by \a _errno.
576 */
577 _static_inline_ int is_errno(int num, int _errno)
578 {
579 assert(num > 0 && _errno > 0);
580 return ERRNO_TO_PARA_ERROR(_errno) == num;
581 }
582
583 /**
584 * Paraslash's version of strerror(3).
585 *
586 * \param num The error number.
587 *
588 * \return The error text of \a num.
589 */
590 _static_inline_ const char *para_strerror(int num)
591 {
592 assert(num > 0);
593 #ifdef _OSL_H
594 if (IS_OSL_ERROR(num))
595 return osl_strerror(num & ((1 << OSL_ERROR_BIT) - 1));
596 #endif
597 if (IS_SYSTEM_ERROR(num))
598 return strerror(num & ((1 << SYSTEM_ERROR_BIT) - 1));
599 return para_errlist[ERRNUM_TO_SS(num)][ERRNUM_TO_INDEX(num)];
600 }
601
602 /**
603 * Wrapper for osl library calls.
604 *
605 * \param ret The return value of an osl library function.
606 *
607 * This should be used for all calls to osl functions that return an osl error
608 * code. It changes the return value appropriately so that it can be used for
609 * printing the correct error message vi para_strerror().
610 *
611 * \return \a ret if \a ret >= 0, a paraslash error code otherwise.
612 */
613 _static_inline_ int osl(int ret)
614 {
615 if (ret >= 0)
616 return ret;
617 return -OSL_ERRNO_TO_PARA_ERROR(-ret);
618 }
619
620 /**
621 * Define the error list for one subsystem.
622 #
623 * The first entry (index 0) is always the name of the subsystem
624 * Used by macros in config.h (generated by configure).
625 */
626 #define DEFINE_ERRLIST(ss) const char * ss ## _ERRLIST[] = {#ss, ss ## _ERRORS}
627
628 /**
629 * Activate errors for one subsystem.
630 *
631 * Each executable needs only the error lists of those subsystems it is
632 * actually linked with. We always reserve space for NUM_SS char pointers,
633 * but only init those of the needed subsystems. This macro is used by macros
634 * in config.h (generated by configure).
635 */
636 #define PARA_ERRLIST(ss) [SS_ ## ss] = ss ## _ERRLIST
637
638 /**
639 * This is temporarily defined to expand to its first argument (prefixed by
640 * 'E_') and gets later redefined to expand to the error text only
641 */
642 #define PARA_ERROR(err, msg) E_ ## err
643 #include "error2.h"
644 #undef PARA_ERROR
645 /* Rest of the world only sees the error text. */
646 #define PARA_ERROR(err, msg) msg