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