644c80440fe57148f344477076a72208662986a7
[paraslash.git] / error.h
1 /*
2  * Copyright (C) 2006-2008 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 CLIENT_ERRORS
17 #define WAV_ERRORS
18 #define COMPRESS_ERRORS
19 #define TIME_ERRORS
20 #define CLOSE_ON_FORK_ERRORS
21 #define DAEMON_ERRORS
22 #define ORTP_SEND_ERRORS
23 #define GUI_ERRORS
24 #define RINGBUFFER_ERRORS
25 #define SCORE_ERRORS
26 #define SHA1_ERRORS
27 #define AFH_COMMON_ERRORS
28 #define RBTREE_ERRORS
29 #define RECV_ERRORS
30 #define ACL_ERRORS
31 #define SEND_COMMON_ERRORS
32
33 extern const char **para_errlist[];
34
35 #define FSCK_ERRORS \
36         PARA_ERROR(FSCK_SYNTAX, "fsck syntax error"), \
37         PARA_ERROR(RANGE_VIOLATION, "range violation detected, very bad"), \
38         PARA_ERROR(NOT_A_REGULAR_FILE, "not a regular file"), \
39
40
41 #define OSL_ERRORS \
42         PARA_ERROR(BAD_DB_DIR, "invalid database directory"), \
43         PARA_ERROR(NO_COLUMN_DESC, "missing column description"), \
44         PARA_ERROR(BAD_NAME, "invalid name for a column/table"), \
45         PARA_ERROR(BAD_STORAGE_TYPE, "invalid storage type"), \
46         PARA_ERROR(BAD_STORAGE_FLAGS, "invalid storage flags"), \
47         PARA_ERROR(NO_COLUMN_NAME, "missing column name"), \
48         PARA_ERROR(NO_COLUMNS, "at least one column required"), \
49         PARA_ERROR(BAD_COLUMN_NAME, "invalid name for a table column"), \
50         PARA_ERROR(NO_UNIQUE_RBTREE_COLUMN, "need at least one mapped column with OSL_UNIQE and OSL_RBTREE OSL"), \
51         PARA_ERROR(NO_RBTREE_COL, "at least one column needs an rbtree"), \
52         PARA_ERROR(DUPLICATE_COL_NAME, "column name given twice"), \
53         PARA_ERROR(BAD_STORAGE_SIZE, "invalid storage size"), \
54         PARA_ERROR(NO_COMPARE_FUNC, "missing compare function"), \
55         PARA_ERROR(BAD_DATA_SIZE, "wrong data size for fixed-size column"), \
56         PARA_ERROR(NOT_MAPPED, "file not mapped"), \
57         PARA_ERROR(ALREADY_MAPPED, "file already mapped"), \
58         PARA_ERROR(BAD_SIZE, "invalid size specified"), \
59         PARA_ERROR(TRUNC, "failed to truncate file"), \
60         PARA_ERROR(BAD_TABLE, "table not open"), \
61         PARA_ERROR(BAD_TABLE_DESC, "invalid table description"), \
62         PARA_ERROR(RB_KEY_EXISTS, "key already exists in rbtree"), \
63         PARA_ERROR(RB_KEY_NOT_FOUND, "key not found in rbtree"), \
64         PARA_ERROR(BAD_ROW_NUM, "invalid row number"), \
65         PARA_ERROR(INDEX_CORRUPTION, "index corruption detected"), \
66         PARA_ERROR(INVALID_OBJECT, "reference to invalid object"), \
67         PARA_ERROR(STAT, "can not stat file"), \
68         PARA_ERROR(WRITE, "write error"), \
69         PARA_ERROR(LSEEK, "lseek error"), \
70         PARA_ERROR(BUSY, "table is busy"), \
71         PARA_ERROR(SHORT_TABLE, "table too short"), \
72         PARA_ERROR(NO_MAGIC, "missing table header magic"), \
73         PARA_ERROR(VERSION_MISMATCH, "table version not supported"), \
74         PARA_ERROR(BAD_COLUMN_NUM, "invalid column number"), \
75         PARA_ERROR(BAD_TABLE_FLAGS, "invalid flags in table description"), \
76         PARA_ERROR(BAD_ROW, "invalid row"), \
77
78
79
80 #define AFS_ERRORS \
81         PARA_ERROR(BAD_TABLE_NAME, "invalid table"), \
82         PARA_ERROR(INPUT_TOO_LARGE, "input too large for stdin command"), \
83         PARA_ERROR(AFS_SYNTAX, "afs syntax error"), \
84         PARA_ERROR(AFS_SIGNAL, "afs caught deadly signal"), \
85         PARA_ERROR(AFS_SOCKET, "afs socket not writable"), \
86         PARA_ERROR(AFS_PARENT_DIED, "fatal: server process terminated"), \
87         PARA_ERROR(AFS_SHORT_READ, "short read from afs socket"), \
88
89
90 #define MOOD_ERRORS \
91         PARA_ERROR(MOOD_SYNTAX, "mood syntax error"), \
92         PARA_ERROR(NO_MOOD, "no mood available"), \
93         PARA_ERROR(NOT_ADMISSIBLE, "file is not admissible"), \
94
95
96 #define ATTRIBUTE_ERRORS \
97         PARA_ERROR(ATTR_SYNTAX, "attribute syntax error"), \
98         PARA_ERROR(NO_ATTRIBUTES, "no attributes defined yet"), \
99         PARA_ERROR(ATT_TABLE_FULL, "no more space left in attribute table"), \
100
101
102 #define BLOB_ERRORS \
103         PARA_ERROR(BLOB_SYNTAX, "blob syntax error"), \
104         PARA_ERROR(DUMMY_ROW, "attempted to access blob dummy object"), \
105
106
107 #define PLAYLIST_ERRORS \
108         PARA_ERROR(PLAYLIST_LOADED, ""), /* not really an error */ \
109         PARA_ERROR(PATH_FOUND, ""), /* not really an error */ \
110         PARA_ERROR(PLAYLIST_EMPTY, "attempted to load empty playlist"), \
111
112
113 #define AFT_ERRORS \
114         PARA_ERROR(BAD_AFSI, "invaiid afs info"), \
115         PARA_ERROR(LOCALTIME, "localtime() failed"), \
116         PARA_ERROR(STRFTIME, "strftime() failed"), \
117         PARA_ERROR(BAD_PATH, "invalid path"), \
118         PARA_ERROR(BAD_SORT, "invalid sorting method"), \
119         PARA_ERROR(FNMATCH, "fnmatch error"), \
120         PARA_ERROR(NO_MATCH, "no matches"), \
121         PARA_ERROR(NO_AFHI, "audio format handler info required"), \
122         PARA_ERROR(AFT_SYNTAX, "audio file table syntax error"), \
123         PARA_ERROR(HASH_MISMATCH, "hash mismatch, consider re-add"), \
124
125
126 #define USER_LIST_ERRORS \
127         PARA_ERROR(USERLIST, "failed to open user list file"), \
128
129
130 #define OSX_WRITE_ERRORS \
131         PARA_ERROR(STREAM_FORMAT, "could not set stream format"), \
132         PARA_ERROR(ADD_CALLBACK, "can not add callback"), \
133         PARA_ERROR(OPEN_COMP, "OpenAComponent() error"), \
134         PARA_ERROR(UNIT_INIT, "AudioUnitInitialize() error"), \
135         PARA_ERROR(UNIT_START, "AudioUnitStart() error"), \
136         PARA_ERROR(DEFAULT_COMP, "can not find default audio output component"), \
137
138
139 #define AUDIOC_ERRORS \
140         PARA_ERROR(AUDIOC_SYNTAX, "audioc syntax error"), \
141         PARA_ERROR(AUDIOC_READ, "audioc read error"), \
142         PARA_ERROR(AUDIOC_WRITE, "audioc write error"), \
143         PARA_ERROR(AUDIOC_OVERRUN, "audioc buffer overrun"), \
144
145
146 #define CLIENT_COMMON_ERRORS \
147         PARA_ERROR(CLIENT_SYNTAX, "syntax error"), \
148         PARA_ERROR(INVALID_CHALLENGE, "did not receive valid challenge"), \
149         PARA_ERROR(NO_CONFIG, "config file not found"), \
150         PARA_ERROR(CLIENT_AUTH, "authentication failed"), \
151         PARA_ERROR(SERVER_EOF, "connection closed by para_server"), \
152         PARA_ERROR(HANDSHAKE_COMPLETE, ""), /* not really an error */ \
153
154
155 #define SCHED_ERRORS \
156         PARA_ERROR(TASK_KILLED, "task killed"), \
157         PARA_ERROR(NO_SUCH_TASK, "task not found"), \
158         PARA_ERROR(NOT_INITIALIZED, "scheduler not yet initialized"), \
159
160
161 #define STDIN_ERRORS \
162         PARA_ERROR(STDIN_READ, "failed to read from stdin"), \
163         PARA_ERROR(STDIN_EOF, "end of file"), \
164
165
166 #define STDOUT_ERRORS \
167         PARA_ERROR(STDOUT_WRITE, "failed to write to stdout"), \
168
169
170 #define NET_ERRORS \
171         PARA_ERROR(NAME_TOO_LONG, "name too long for struct sockaddr_un"), \
172         PARA_ERROR(ADDRESS_LOOKUP, "address lookup / socket creation failed"), \
173         PARA_ERROR(CHMOD, "failed to set socket mode"), \
174         PARA_ERROR(SENDMSG, "sendmsg() failed"), \
175         PARA_ERROR(RECVMSG, "recvmsg() failed"), \
176         PARA_ERROR(SCM_CREDENTIALS, "did not receive SCM credentials"), \
177         PARA_ERROR(RECV_PATTERN, "did not receive expected pattern"), \
178
179
180 #define ORTP_RECV_ERRORS \
181         PARA_ERROR(MSG_TO_BUF, "failed to extract rtp packet"), \
182         PARA_ERROR(ORTP_SYNTAX, "ortp syntax error"), \
183         PARA_ERROR(TOO_MANY_BAD_CHUNKS, "too many consecutive bad chunks"), \
184         PARA_ERROR(INVALID_HEADER, "invalid header packet"), \
185         PARA_ERROR(OVERRUN, "output buffer overrun"), \
186         PARA_ERROR(ORTP_RECV_EOF, "ortp_recv: end of file"), \
187
188
189 #define HTTP_RECV_ERRORS \
190         PARA_ERROR(HTTP_RECV_OVERRUN, "http_recv: output buffer overrun"), \
191
192
193 #define RECV_COMMON_ERRORS \
194         PARA_ERROR(RECV_SYNTAX, "recv syntax error"), \
195         PARA_ERROR(RECV_EOF, "end of file"), \
196
197
198 #define AUDIOD_ERRORS \
199         PARA_ERROR(NO_MORE_SLOTS, "no more empty slots"), \
200         PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
201         PARA_ERROR(UNSUPPORTED_AUDIO_FORMAT, "given audio format not supported"), \
202         PARA_ERROR(SIGNAL_CAUGHT, "caught signal"), \
203         PARA_ERROR(NOT_PLAYING, "not playing"), \
204
205
206 #define AUDIOD_COMMAND_ERRORS \
207         PARA_ERROR(CLIENT_WRITE, "client write error"), \
208         PARA_ERROR(AUDIOD_SYNTAX, "syntax error"), \
209         PARA_ERROR(UCRED_PERM, "permission denied"), \
210         PARA_ERROR(INVALID_AUDIOD_CMD, "invalid command"), \
211
212
213 #define FILTER_CHAIN_ERRORS \
214         PARA_ERROR(UNSUPPORTED_FILTER, "given filter not supported"), \
215         PARA_ERROR(BAD_FILTER_OPTIONS, "invalid filter option given"), \
216         PARA_ERROR(FC_EOF, "filter chain: eof"), \
217
218
219 #define STAT_ERRORS \
220         PARA_ERROR(TOO_MANY_CLIENTS, "maximal number of stat clients exceeded"), \
221         PARA_ERROR(UNKNOWN_STAT_ITEM, "status item not recognized"), \
222
223
224 #define OGGDEC_ERRORS \
225         PARA_ERROR(OGGDEC_READ, "read from media returned an error"), \
226         PARA_ERROR(OGGDEC_NOTVORBIS, "bitstream is not vorbis data"), \
227         PARA_ERROR(OGGDEC_VERSION, "vorbis version mismatch"), \
228         PARA_ERROR(OGGDEC_BADHEADER, "invalid vorbis bitstream header"), \
229         PARA_ERROR(OGGDEC_FAULT, "bug or heap/stack corruption"), \
230         PARA_ERROR(OGGDEC_BADLINK, "invalid stream section or requested link corrupt"), \
231
232
233 #define GRAB_CLIENT_ERRORS \
234         PARA_ERROR(PEDANTIC_GRAB, "fd not ready and pedantic grab requested"), \
235         PARA_ERROR(GC_WRITE, "grab client write error"), \
236         PARA_ERROR(BAD_GC_SLOT, "invalid slot requested by grab client"), \
237         PARA_ERROR(BAD_GC_FILTER_NUM, "invalid filter number given"), \
238         PARA_ERROR(GC_SYNTAX, "grab client syntax error"), \
239         PARA_ERROR(GC_HELP_GIVEN, ""), /* not really an error */ \
240         PARA_ERROR(GC_VERSION_GIVEN, ""), /* not really an error */ \
241
242
243 #define MP3DEC_ERRORS \
244         PARA_ERROR(MAD_FRAME_DECODE, "mad frame decode error"), \
245         PARA_ERROR(MP3DEC_OVERRUN, "mp3 output buffer overrun"), \
246
247
248 #define FILTER_ERRORS \
249         PARA_ERROR(NO_FILTERS, "at least one filter must be given"), \
250         PARA_ERROR(FILTER_SYNTAX, "syntax error"), \
251
252
253 #define SIGNAL_ERRORS \
254         PARA_ERROR(SIGNAL_SIG_ERR, "signal() returned SIG_ERR"), \
255         PARA_ERROR(SIGNAL_READ, "read error from signal pipe"), \
256
257
258 #define STRING_ERRORS \
259         PARA_ERROR(MKSTEMP, "mkstemp error: unable to create tmp file"), \
260         PARA_ERROR(FCHMOD, "fchmod error: can not set mode"), \
261         PARA_ERROR(ATOI_OVERFLOW, "value too large"), \
262         PARA_ERROR(STRTOLL, "unknown strtoll error"), \
263         PARA_ERROR(ATOI_NO_DIGITS, "no digits found in string"), \
264         PARA_ERROR(ATOI_JUNK_AT_END, "further characters after number"), \
265
266
267 #define EXEC_ERRORS \
268         PARA_ERROR(DUP_PIPE, "exec error: can not create pipe"), \
269         PARA_ERROR(NULL_OPEN, "can not open /dev/null"), \
270
271
272 #define MP3_AFH_ERRORS \
273         PARA_ERROR(FRAME, "invalid mp3 frame"), \
274         PARA_ERROR(FRAME_LENGTH, "invalid frame length"), \
275         PARA_ERROR(MP3_INFO, "could not read mp3 info"), \
276         PARA_ERROR(HEADER_FREQ, "invalid header frequency"), \
277         PARA_ERROR(HEADER_BITRATE, "invalid header bitrate"), \
278
279
280 #define AAC_AFH_ERRORS \
281         PARA_ERROR(STSZ, "did not find stcz atom"), \
282         PARA_ERROR(MP4ASC, "audio spec config error"), \
283         PARA_ERROR(AAC_AFH_INIT, "failed to init aac decoder"), \
284
285
286 #define AAC_COMMON_ERRORS \
287         PARA_ERROR(ESDS, "did not find esds atom"), \
288         PARA_ERROR(STCO, "did not find stco atom"), \
289
290
291 #define OGG_AFH_ERRORS \
292         PARA_ERROR(OGG_READ, "ogg read error"), \
293         PARA_ERROR(SYNC_PAGEOUT, "ogg sync page-out error (no ogg file?)"), \
294         PARA_ERROR(STREAM_PAGEIN, "ogg stream page-in error (first page)"), \
295         PARA_ERROR(STREAM_PACKETOUT, "ogg stream packet-out error (first packet)"), \
296         PARA_ERROR(VORBIS, "vorbis synthesis header-in error (not vorbis?)"), \
297         PARA_ERROR(OGG_INFO, "ov_info error"), \
298         PARA_ERROR(OGG_VERSION, "unsupported ogg version"), \
299         PARA_ERROR(OGG_BAD_HEADER, "invalid ogg vorbis header"), \
300         PARA_ERROR(OGG_UNKNOWN_ERROR, "unknown ogg vorbis error"), \
301
302
303 #define VSS_ERRORS \
304         PARA_ERROR(BAD_AUDIO_FILE_SUFFIX, "unknown suffix"), \
305         PARA_ERROR(AUDIO_FORMAT, "audio format not recognized"), \
306         PARA_ERROR(CHUNK, "unable to get chunk"), \
307         PARA_ERROR(SHORT_AFS_READ, "short read from afs socket"), \
308         PARA_ERROR(NOFD, "did not receive open fd from afs"), \
309
310
311 #define CRYPT_ERRORS \
312         PARA_ERROR(PRIVATE_KEY, "can not read private key"), \
313         PARA_ERROR(PUBLIC_KEY, "can not read public key"), \
314         PARA_ERROR(RSA, "RSA error"), \
315         PARA_ERROR(ENCRYPT, "encrypt error"), \
316         PARA_ERROR(DECRYPT, "decrypt error"), \
317         PARA_ERROR(CHALLENGE, "failed to read challenge"), \
318
319
320 #define HTTP_SEND_ERRORS \
321         PARA_ERROR(WRITE_OK, "can not check whether fd is writable"), \
322         PARA_ERROR(MAX_CLIENTS, "maximal number of clients exceeded"), \
323         PARA_ERROR(ACL_PERM, "access denied by acl"), \
324
325
326 #define COMMAND_ERRORS \
327         PARA_ERROR(COMMAND_SYNTAX, "syntax error in command"), \
328         PARA_ERROR(AUTH, "did not receive auth request"), \
329         PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
330         PARA_ERROR(BAD_CMD, "invalid command"), \
331         PARA_ERROR(PERM, "permission denied"), \
332         PARA_ERROR(LOCK, "lock error"), \
333         PARA_ERROR(SENDER_CMD, "command not supported by this sender"), \
334         PARA_ERROR(SERVER_CRASH, "para_server crashed -- can not live without it"), \
335         PARA_ERROR(BAD_USER, "you don't exist. Go away."), \
336
337
338 #define IPC_ERRORS \
339         PARA_ERROR(SEM_GET, "failed to create semaphore"), \
340         PARA_ERROR(SEM_REMOVE, "can not remove semaphore"), \
341         PARA_ERROR(SHM_GET, "failed to allocate shared memory area"), \
342         PARA_ERROR(SHM_DESTROY, "failed to destroy shared memory area"), \
343         PARA_ERROR(SHM_ATTACH, "can not attach shared memory area"), \
344         PARA_ERROR(SHM_DETACH, "can not detach shared memory area"), \
345
346
347 #define DCCP_RECV_ERRORS \
348         PARA_ERROR(DCCP_OVERRUN, "dccp output buffer buffer overrun"), \
349
350
351 #define DCCP_SEND_ERRORS \
352
353
354 #define FD_ERRORS \
355         PARA_ERROR(FGETS, "fgets error"), \
356         PARA_ERROR(EMPTY, "file empty"), \
357         PARA_ERROR(MMAP, "mmap error"), \
358         PARA_ERROR(MUNMAP, "munmap failed"), \
359
360
361 #define WRITE_ERRORS \
362         PARA_ERROR(WRITE_SYNTAX, "para_write syntax error"), \
363         PARA_ERROR(PREMATURE_END, "premature end of audio file"), \
364         PARA_ERROR(NO_WAV_HEADER, "wave header not found"), \
365         PARA_ERROR(WAV_HEADER_SUCCESS, "successfully read wave header"), \
366         PARA_ERROR(NO_DELAY, "no initial delay"), \
367         PARA_ERROR(DELAY_TIMEOUT, "initial delay timeout"), \
368
369
370 #define ALSA_WRITE_ERRORS \
371         PARA_ERROR(BROKEN_CONF, "Broken alsa configuration"), \
372         PARA_ERROR(ACCESS_TYPE, "alsa access type not available"), \
373         PARA_ERROR(SAMPLE_FORMAT, "sample format not available"), \
374         PARA_ERROR(CHANNEL_COUNT, "channels count not available"), \
375         PARA_ERROR(HW_PARAMS, "unable to install hw params"), \
376         PARA_ERROR(SW_PARAMS, "unable to install sw params"), \
377         PARA_ERROR(BAD_PERIOD, "can not use period equal to buffer size"), \
378         PARA_ERROR(GET_XFER, "unable to obtain xfer align"), \
379         PARA_ERROR(SET_XFER, "snd_pcm_sw_params_set_xfer_align() failed"), \
380         PARA_ERROR(ALSA_WRITE, "alsa write error"), \
381         PARA_ERROR(PCM_OPEN, "unable to open pcm"), \
382         PARA_ERROR(SND_PCM_INFO, "pcm info error"), \
383         PARA_ERROR(GET_BUFFER_TIME, "snd_pcm_hw_params_get_buffer_time_max() failed"), \
384         PARA_ERROR(SET_BUFFER_TIME, "snd_pcm_hw_params_set_buffer_time_near() failed"), \
385         PARA_ERROR(SET_RATE, "snd_pcm_hw_params_set_rate_near failed"), \
386         PARA_ERROR(START_THRESHOLD, "snd_pcm_sw_params_set_start_threshold() failed"), \
387         PARA_ERROR(STOP_THRESHOLD, "snd_pcm_sw_params_set_stop_threshold() failed"), \
388
389
390 #define FILE_WRITE_ERRORS \
391         PARA_ERROR(FW_WRITE, "file writer write error"), \
392         PARA_ERROR(FW_OPEN, "file writer: can not open output file"), \
393         PARA_ERROR(FW_NO_FILE, "task started without open file"), \
394
395
396 #define WRITE_COMMON_ERRORS \
397         PARA_ERROR(WRITE_COMMON_SYNTAX, "syntax error in write option"), \
398
399
400 #define AACDEC_ERRORS \
401         PARA_ERROR(AACDEC_INIT, "failed to init aac decoder"), \
402         PARA_ERROR(AAC_DECODE, "aac decode error"), \
403         PARA_ERROR(AAC_OVERRUN, "aac output buffer overrun"), \
404
405
406 #define CHUNK_QUEUE_ERRORS \
407         PARA_ERROR(QUEUE, "packet queue overrun"), \
408
409
410 /** \endcond */
411
412 /**
413  * The subsystem shift.
414  *
415  * 255 error codes ought to be enough for every subsystem. Use the higher bits
416  * of the return value to encode the subsystem number.
417  */
418 #define SS_SHIFT 8
419
420 /**
421  * Compute the subsystem offset.
422  *
423  * It is given by x * 2**8 where \a x is the subsystem number.
424  */
425 #define SS_OFFSET(ss) (SS_ ## ss << SS_SHIFT)
426
427 /**
428  * Make the enum of all errors of one subsystem.
429  *
430  * As zero should not be an error, we define a dummy enum entry with value
431  * 2**ss. That lets the real errors start at 2**ss + 1.
432  */
433 #define SS_ENUM(ss) enum {\
434         E_ ## ss ## _DUMMY = SS_OFFSET(ss), \
435         ss ## _ERRORS}
436
437 /**
438  * Determine the subsystem number from the error number.
439  *
440  * Easy, it's just \a num / 2**8.
441  */
442 #define ERRNUM_TO_SS(num) ((num) >> SS_SHIFT)
443
444 /**
445  * Determine the index of an error number.
446  *
447  * Also easy: It's the lower 8 bits of num.
448  */
449 #define ERRNUM_TO_INDEX(num) (((1 << SS_SHIFT) - 1) & (num))
450
451 /**
452  * This bit indicates whether a number is considered a system error number
453  * If yes, the system errno is just the result of clearing this bit from
454  * the given number.
455  */
456 #define SYSTEM_ERROR_BIT 30
457
458 /** Check whether the system error bit is set. */
459 #define IS_SYSTEM_ERROR(num) (!!((num) & (1 << SYSTEM_ERROR_BIT)))
460
461 /** Set the system error bit for the given number. */
462 #define ERRNO_TO_PARA_ERROR(num) ((num) | (1 << SYSTEM_ERROR_BIT))
463
464 /** Check whether a given number is a system error number.
465  *
466  * \param num The value to be checked.
467  * \param _errno The system error number.
468  *
469  * \return True if \a num is paraslash's representation of the system
470  * error identified by \a _errno.
471  */
472 _static_inline_ int is_errno(int num, int _errno)
473 {
474         assert(num > 0 && _errno > 0);
475         return ERRNO_TO_PARA_ERROR(_errno) == num;
476 }
477
478 /**
479  * Paraslash's version of strerror(3).
480  *
481  * \param num The error number.
482  *
483  * \return The error text of \a num.
484  */
485 _static_inline_ const char *para_strerror(int num)
486 {
487         assert(num > 0);
488         if (IS_SYSTEM_ERROR(num))
489                 return strerror((num) & ((1 << SYSTEM_ERROR_BIT) - 1));
490         else
491                 return para_errlist[ERRNUM_TO_SS(num)][ERRNUM_TO_INDEX(num)];
492 }
493 /**
494  * Define the error list for one subsystem.
495  #
496  * The first entry (index 0) is always the name of the subsystem
497  * Used by macros in config.h (generated by configure).
498  */
499 #define DEFINE_ERRLIST(ss) const char * ss ## _ERRLIST[] = {#ss, ss ## _ERRORS}
500
501 /**
502  * Activate errors for one subsystem.
503  *
504  * Each executable needs only the error lists of those subsystems it is
505  * actually linked with. We always reserve space for NUM_SS char pointers,
506  * but only init those of the needed subsystems. This macro is used by macros
507  * in config.h (generated by configure).
508  */
509 #define PARA_ERRLIST(ss) [SS_ ## ss] = ss ## _ERRLIST
510
511 /**
512  * This is temporarily defined to expand to its first argument (prefixed by
513  * 'E_') and gets later redefined to expand to the error text only
514  */
515 #define PARA_ERROR(err, msg) E_ ## err
516 #include "error2.h"
517 #undef PARA_ERROR
518 /* Rest of the world only sees the error text. */
519 #define PARA_ERROR(err, msg) msg