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