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