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