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