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