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