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