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