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