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