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