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