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