Merge branch 'refs/heads/t/logo-0.6'
[paraslash.git] / error.h
1 /*
2  * Copyright (C) 2006 Andre Noll <maan@tuebingen.mpg.de>
3  *
4  * Licensed under the GPL v2. For licencing details see COPYING.
5  */
6
7 /** \file error.h List of error codes and messages. */
8
9 /** Codes and messages. */
10 #define PARA_ERRORS \
11         PARA_ERROR(AACDEC_INIT, "failed to init aac decoder"), \
12         PARA_ERROR(AAC_DECODE, "aac decode error"), \
13         PARA_ERROR(ACL_PERM, "access denied by acl"), \
14         PARA_ERROR(ADDRESS_LOOKUP, "can not resolve requested address"),\
15         PARA_ERROR(AFH_RECV_BAD_FILENAME, "no file name given"), \
16         PARA_ERROR(AFS_SHORT_READ, "short read from afs socket"), \
17         PARA_ERROR(AFS_SIGNAL, "afs caught deadly signal"), \
18         PARA_ERROR(AFS_SOCKET, "afs socket not writable"), \
19         PARA_ERROR(AFS_SYNTAX, "afs syntax error"), \
20         PARA_ERROR(AFT_SYNTAX, "audio file table syntax error"), \
21         PARA_ERROR(ALSA, "alsa error"), \
22         PARA_ERROR(ALSA_MIX_GET_VAL, "could not read control element state"), \
23         PARA_ERROR(ALSA_MIX_OPEN, "could not open mixer"), \
24         PARA_ERROR(ALSA_MIX_RANGE, "value control element out of range"), \
25         PARA_ERROR(ALSA_MIX_SET_VAL, "could not set control element state"), \
26         PARA_ERROR(AMP_EOF, "amp: end of file"), \
27         PARA_ERROR(AMP_ZERO_AMP, "no amplification necessary"), \
28         PARA_ERROR(AO_APPEND_OPTION, "ao append option: memory allocation failure"), \
29         PARA_ERROR(AO_BAD_DRIVER, "ao: invalid driver"), \
30         PARA_ERROR(AO_BAD_OPTION, "ao option is not of type key:value"), \
31         PARA_ERROR(AO_BAD_SAMPLE_FORMAT, "ao: unsigned sample formats not supported"), \
32         PARA_ERROR(AO_DEFAULT_DRIVER, "ao: no usable output device"), \
33         PARA_ERROR(AO_EOF, "ao: end of file"), \
34         PARA_ERROR(AO_FILE_NOT_SUPP, "ao: file io drivers not supported"), \
35         PARA_ERROR(AO_OPEN_LIVE, "ao: could not open audio device"), \
36         PARA_ERROR(AO_PLAY, "ao_play() failed"), \
37         PARA_ERROR(AO_PTHREAD, "pthread error"), \
38         PARA_ERROR(ARG_NOT_FOUND, "argument not found in arg vector"), \
39         PARA_ERROR(ASN1_PARSE, "could not parse ASN.1 key"), \
40         PARA_ERROR(ATOI_JUNK_AT_END, "further characters after number"), \
41         PARA_ERROR(ATOI_NO_DIGITS, "no digits found in string"), \
42         PARA_ERROR(ATOI_OVERFLOW, "value too large"), \
43         PARA_ERROR(ATTR_SYNTAX, "attribute syntax error"), \
44         PARA_ERROR(ATT_TABLE_FULL, "no more space left in attribute table"), \
45         PARA_ERROR(AUDIOC_EOF, "audioc: end of file"), \
46         PARA_ERROR(AUDIOD_OFF, "audiod switched off"), \
47         PARA_ERROR(AUDIOD_SIGNAL, "caught deadly signal"), \
48         PARA_ERROR(AUDIOD_TERM, "terminating on user request"), \
49         PARA_ERROR(AUDIO_FORMAT, "audio format not recognized"), \
50         PARA_ERROR(AUTH_REQUEST, "did not receive auth request"), \
51         PARA_ERROR(BAD_AFSI, "invalid afs info"), \
52         PARA_ERROR(BAD_ASF_FILE_PROPS, "invalid ASF file properties"), \
53         PARA_ERROR(BAD_AUTH, "authentication failure"), \
54         PARA_ERROR(BAD_BAND, "invalid or unexpected band designator"), \
55         PARA_ERROR(BAD_CHANNEL_COUNT, "channel count not supported"), \
56         PARA_ERROR(BAD_CHANNEL, "invalid channel"), \
57         PARA_ERROR(BAD_CT, "invalid chunk table or bad FEC configuration"), \
58         PARA_ERROR(BAD_FEATURE, "invalid feature request"), \
59         PARA_ERROR(BAD_FEC_HEADER, "invalid fec header"), \
60         PARA_ERROR(BAD_LL, "invalid loglevel"), \
61         PARA_ERROR(BAD_PATH, "invalid path"), \
62         PARA_ERROR(BAD_PRIVATE_KEY, "invalid private key"), \
63         PARA_ERROR(BAD_SAMPLE_FORMAT, "sample format not supported"), \
64         PARA_ERROR(BAD_SAMPLERATE, "sample rate not supported"), \
65         PARA_ERROR(BAD_SLICE_NUM, "invalid slice number"), \
66         PARA_ERROR(BAD_SLICE_SIZE, "slice size zero or too large"), \
67         PARA_ERROR(BAD_SORT, "invalid sorting method"), \
68         PARA_ERROR(BAD_TABLE_NAME, "invalid table"), \
69         PARA_ERROR(BAD_USER, "auth request for invalid user"), \
70         PARA_ERROR(BASE64, "failed to base64-decode ssh public key"), \
71         PARA_ERROR(BIGNUM, "bignum error"), \
72         PARA_ERROR(BLINDING, "failed to activate key blinding"), \
73         PARA_ERROR(BLOB_SYNTAX, "blob syntax error"), \
74         PARA_ERROR(BTR_EOF, "buffer tree: end of file"), \
75         PARA_ERROR(BTR_NAVAIL, "btr node: value currently unavailable"), \
76         PARA_ERROR(BTR_NO_CHILD, "btr node has no children"), \
77         PARA_ERROR(CHMOD, "failed to set socket mode"), \
78         PARA_ERROR(CLIENT_SYNTAX, "syntax error"), \
79         PARA_ERROR(CLIENT_WRITE, "client write error"), \
80         PARA_ERROR(COMMAND_SYNTAX, "syntax error in command"), \
81         PARA_ERROR(COMPRESS_EOF, "compress: end of file"), \
82         PARA_ERROR(CREATE_OPUS_DECODER, "could not create opus decoder"), \
83         PARA_ERROR(DCCP_OVERRUN, "dccp output buffer buffer overrun"), \
84         PARA_ERROR(DECRYPT, "decrypt error"), \
85         PARA_ERROR(DUMMY_ROW, "attempted to access blob dummy object"), \
86         PARA_ERROR(DUP_PIPE, "exec error: can not create pipe"), \
87         PARA_ERROR(EMPTY, "file is empty"), \
88         PARA_ERROR(ENCRYPT, "encrypt error"), \
89         PARA_ERROR(EOF, "end of file"), \
90         PARA_ERROR(FEC_BAD_IDX, "invalid index vector"), \
91         PARA_ERROR(FECDEC_EOF, "received eof packet"), \
92         PARA_ERROR(FECDEC_OVERRUN, "fecdec output buffer overrun"), \
93         PARA_ERROR(FEC_PARMS, "invalid fec parameters"), \
94         PARA_ERROR(FEC_PIVOT, "pivot column not found"), \
95         PARA_ERROR(FEC_SINGULAR, "unexpected singular matrix"), \
96         PARA_ERROR(FFT_BAD_PARAMS, "invalid params for fft"), \
97         PARA_ERROR(FGETS, "fgets error"), \
98         PARA_ERROR(FLAC_AFH_DECODER_ALLOC, "could not allocate stream decoder"), \
99         PARA_ERROR(FLAC_AFH_DECODER_INIT, "could not init stream decoder"), \
100         PARA_ERROR(FLAC_CHAIN_ALLOC, "could not create metadata chain"), \
101         PARA_ERROR(FLAC_CHAIN_READ, "could not read meta chain"), \
102         PARA_ERROR(FLACDEC_DECODER_ALLOC, "could not allocate stream decoder"), \
103         PARA_ERROR(FLACDEC_DECODER_INIT, "could not init stream decoder"), \
104         PARA_ERROR(FLACDEC_EOF, "flacdec encountered end of file condition"), \
105         PARA_ERROR(FLAC_DECODE_POS, "could not get decode position"), \
106         PARA_ERROR(FLAC_ITER_ALLOC, "could not allocate meta iterator"), \
107         PARA_ERROR(FLAC_REPLACE_COMMENT, "could not replace vorbis comment"), \
108         PARA_ERROR(FLAC_SKIP_META, "could not skip metadata"), \
109         PARA_ERROR(FLAC_STREAMINFO, "could not read stream info meta block"), \
110         PARA_ERROR(FLAC_VARBLOCK, "variable blocksize not supported"), \
111         PARA_ERROR(FLAC_WRITE_CHAIN, "failed to write metadata chain"), \
112         PARA_ERROR(FNMATCH, "fnmatch error"), \
113         PARA_ERROR(FRAME, "invalid mp3 frame"), \
114         PARA_ERROR(FRAME_LENGTH, "invalid frame length"), \
115         PARA_ERROR(GC_SYNTAX, "grab client syntax error"), \
116         PARA_ERROR(GC_WRITE, "grab client write error"), \
117         PARA_ERROR(GUI_SIGCHLD, "received SIGCHLD"), \
118         PARA_ERROR(HASH_MISMATCH, "hash mismatch, consider re-add"), \
119         PARA_ERROR(HEADER_BITRATE, "invalid header bitrate"), \
120         PARA_ERROR(HEADER_FREQ, "invalid header frequency"), \
121         PARA_ERROR(HTTP_RECV_OVERRUN, "http_recv: output buffer overrun"), \
122         PARA_ERROR(I9E_EOF, "end of input"), \
123         PARA_ERROR(I9E_SETUPTERM, "failed to set up terminal"), \
124         PARA_ERROR(I9E_TERM_RQ, "received termination request"), \
125         PARA_ERROR(ID3_ATTACH, "could not attach id3 frame"), \
126         PARA_ERROR(ID3_DETACH, "could not detach id3 frame"), \
127         PARA_ERROR(ID3_SETENCODING, "could not set id3 text encoding field"), \
128         PARA_ERROR(ID3_SETSTRING, "could not set id3 string field"), \
129         PARA_ERROR(INCOHERENT_BLOCK_LEN, "incoherent block length"), \
130         PARA_ERROR(KEY_MARKER, "invalid/missing key header or footer"), \
131         PARA_ERROR(KEY_PERM, "unprotected private key"), \
132         PARA_ERROR(LIBSAMPLERATE, "secret rabbit code error"), \
133         PARA_ERROR(LOCALTIME, "localtime() failed"), \
134         PARA_ERROR(LOCK, "lock error"), \
135         PARA_ERROR(MAD_FRAME_DECODE, "mad frame decode error"), \
136         PARA_ERROR(MAKESOCK, "makesock error"), \
137         PARA_ERROR(MAX_CLIENTS, "maximal number of clients exceeded"), \
138         PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
139         PARA_ERROR(MOOD_SYNTAX, "mood syntax error"), \
140         PARA_ERROR(MP3DEC_CORRUPT, "too many corrupt frames"), \
141         PARA_ERROR(MP3DEC_EOF, "mp3dec: end of file"), \
142         PARA_ERROR(MP3_INFO, "could not read mp3 info"), \
143         PARA_ERROR(MP4FF_BAD_CHANNEL_COUNT, "mp4ff: invalid number of channels"), \
144         PARA_ERROR(MP4FF_BAD_SAMPLE, "mp4ff: invalid sample number"), \
145         PARA_ERROR(MP4FF_BAD_SAMPLERATE, "mp4ff: invalid sample rate"), \
146         PARA_ERROR(MP4FF_BAD_SAMPLE_COUNT, "mp4ff: invalid number of samples"), \
147         PARA_ERROR(MP4FF_META_READ, "mp4ff: could not read mp4 metadata"), \
148         PARA_ERROR(MP4FF_META_WRITE, "mp4ff: could not update mp4 metadata"), \
149         PARA_ERROR(MP4FF_OPEN, "mp4ff: open failed"), \
150         PARA_ERROR(MP4FF_TRACK, "mp4fF: no audio track"), \
151         PARA_ERROR(MPI_PRINT, "could not convert multi-precision integer"), \
152         PARA_ERROR(MPI_SCAN, "could not scan multi-precision integer"), \
153         PARA_ERROR(NAME_TOO_LONG, "name too long for struct sockaddr_un"), \
154         PARA_ERROR(NO_AFHI, "audio format handler info required"), \
155         PARA_ERROR(NO_ATTRIBUTES, "no attributes defined yet"), \
156         PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
157         PARA_ERROR(NOFD, "did not receive open fd from afs"), \
158         PARA_ERROR(NO_MATCH, "no matches"), \
159         PARA_ERROR(NO_MOOD, "no mood available"), \
160         PARA_ERROR(NO_MORE_SLOTS, "no more empty slots"), \
161         PARA_ERROR(NOT_PLAYING, "not playing"), \
162         PARA_ERROR(NO_VALID_FILES, "no valid file found in playlist"), \
163         PARA_ERROR(NO_WMA, "asf/wma format not recognized"), \
164         PARA_ERROR(OGGDEC_BADHEADER, "invalid vorbis bitstream header"), \
165         PARA_ERROR(OGGDEC_BADLINK, "invalid stream section or requested link corrupt"), \
166         PARA_ERROR(OGGDEC_FAULT, "bug or heap/stack corruption"), \
167         PARA_ERROR(OGGDEC_NOTVORBIS, "bitstream is not vorbis data"), \
168         PARA_ERROR(OGGDEC_READ, "read from media returned an error"), \
169         PARA_ERROR(OGGDEC_VERSION, "vorbis version mismatch"), \
170         PARA_ERROR(OGG_EMPTY, "no ogg pages found"), \
171         PARA_ERROR(OGG_PACKET_IN, "ogg_stream_packetin() failed"), \
172         PARA_ERROR(OGG_STREAM_FLUSH, "ogg_stream_flush() failed"), \
173         PARA_ERROR(OGG_SYNC, "internal ogg storage overflow"), \
174         PARA_ERROR(OPUS_COMMENT, "invalid or corrupted opus comment"), \
175         PARA_ERROR(OPUS_DECODE, "opus decode error"), \
176         PARA_ERROR(OPUS_HEADER, "invalid opus header"), \
177         PARA_ERROR(OPUS_SET_GAIN, "opus: could not set gain"), \
178         PARA_ERROR(PATH_FOUND, ""), /* not really an error */ \
179         PARA_ERROR(PERM, "permission denied"), \
180         PARA_ERROR(PLAYLIST_EMPTY, "attempted to load empty playlist"), \
181         PARA_ERROR(PLAYLIST_LOADED, ""), /* not really an error */ \
182         PARA_ERROR(PREBUFFER_SUCCESS, "prebuffering complete"), \
183         PARA_ERROR(PRIVATE_KEY, "can not read private key"), \
184         PARA_ERROR(QUEUE, "packet queue overrun"), \
185         PARA_ERROR(READ_PATTERN, "did not read expected pattern"), \
186         PARA_ERROR(RECV_EOF, "end of file"), \
187         PARA_ERROR(RECVMSG, "recvmsg() failed"), \
188         PARA_ERROR(REGEX, "regular expression error"), \
189         PARA_ERROR(RESAMPLE_EOF, "resample filter: end of file"), \
190         PARA_ERROR(RSA, "RSA error"), \
191         PARA_ERROR(RSA_DECODE, "RSA decoding error"), \
192         PARA_ERROR(SB_PACKET_SIZE, "invalid sideband packet size or protocol error"), \
193         PARA_ERROR(SCM_CREDENTIALS, "did not receive SCM credentials"), \
194         PARA_ERROR(SENDER_CMD, "command not supported by this sender"), \
195         PARA_ERROR(SENDMSG, "sendmsg() failed"), \
196         PARA_ERROR(SERVER_CMD_FAILURE, "command failed"), \
197         PARA_ERROR(SERVER_CMD_SUCCESS, "command terminated successfully"), \
198         PARA_ERROR(SERVER_CRASH, "para_server crashed -- can not live without it"), \
199         PARA_ERROR(SERVER_EOF, "connection closed by para_server"), \
200         PARA_ERROR(SEXP_BUILD, "could not build S-expression"), \
201         PARA_ERROR(SEXP_DECRYPT, "could not decrypt S-expression"), \
202         PARA_ERROR(SEXP_ENCRYPT, "could not encrypt S-expression"), \
203         PARA_ERROR(SEXP_FIND, "could not find sublist in S-expression"), \
204         PARA_ERROR(SHORT_WRITE, "unexpected short write"), \
205         PARA_ERROR(SIZE_PREFIX, "bad size prefix"), \
206         PARA_ERROR(SPX_COMMENT, "invalid speex comment"), \
207         PARA_ERROR(SPX_CTL_BAD_RQ, "speex_decoder_ctl: invalid request"), \
208         PARA_ERROR(SPX_CTL_INVAL, "speex_decoder_ctl: invalid argument"), \
209         PARA_ERROR(SPX_DECODE_OVERFLOW, "speex decoding overflow"), \
210         PARA_ERROR(SPX_DECODER_INIT, "speex decoder initialization failed"), \
211         PARA_ERROR(SPX_DECODE, "speex decoding error"), \
212         PARA_ERROR(SPX_EOS, "speex: end of stream"), \
213         PARA_ERROR(SPX_HEADER, "can not read speex header"), \
214         PARA_ERROR(SPX_HEADER_MODE, "invalid speex mode in header"), \
215         PARA_ERROR(SPX_VERSION, "incompatible speex bit stream version"), \
216         PARA_ERROR(SSH_KEY_HEADER, "ssh key header not found"), \
217         PARA_ERROR(SSH_PARSE, "could not parse ssh public key"), \
218         PARA_ERROR(STAT_ITEM_PARSE, "failed to parse status item"), \
219         PARA_ERROR(STATUS_TIMEOUT, "status item timeout"), \
220         PARA_ERROR(STREAM_PACKETIN, "ogg stream packet-in error"), \
221         PARA_ERROR(STREAM_PACKETOUT, "ogg stream packet-out error"), \
222         PARA_ERROR(STREAM_PAGEIN, "ogg stream page-in error"), \
223         PARA_ERROR(STREAM_PAGEOUT, "ogg stream page-out error"), \
224         PARA_ERROR(STRFTIME, "strftime() failed"), \
225         PARA_ERROR(SYNC_COMPLETE, "all buddies in sync"), \
226         PARA_ERROR(SYNC_LISTEN_FD, "no fd to listen on"), \
227         PARA_ERROR(SYNC_PAGEOUT, "ogg sync page-out error (no ogg file?)"), \
228         PARA_ERROR(TARGET_EXISTS, "requested target is already present"),\
229         PARA_ERROR(TARGET_NOT_FOUND, "requested target not found"), \
230         PARA_ERROR(TASK_STARTED, "task started"), \
231         PARA_ERROR(TOO_MANY_CLIENTS, "maximal number of stat clients exceeded"), \
232         PARA_ERROR(UCRED_PERM, "permission denied"), \
233         PARA_ERROR(UDP_OVERRUN, "output buffer overrun"), \
234         PARA_ERROR(UNKNOWN_STAT_ITEM, "status item not recognized"), \
235         PARA_ERROR(UNSUPPORTED_AUDIO_FORMAT, "given audio format not supported"), \
236         PARA_ERROR(UNSUPPORTED_FILTER, "given filter not supported"), \
237         PARA_ERROR(USERLIST, "failed to open user list file"), \
238         PARA_ERROR(VLC, "invalid vlc code"), \
239         PARA_ERROR(VORBIS_COMMENTHEADER, "could not create vorbis comment header"), \
240         PARA_ERROR(VORBIS, "vorbis synthesis header-in error (not vorbis?)"), \
241         PARA_ERROR(WAV_BAD_FC, "invalid filter configuration"), \
242         PARA_ERROR(WAV_EOF, "wav filter: end of file"), \
243         PARA_ERROR(WAV_SUCCESS, "successfully wrote wav header"), \
244         PARA_ERROR(WMA_BAD_PARAMS, "invalid WMA parameters"), \
245         PARA_ERROR(WMA_BAD_SUPERFRAME, "invalid superframe"), \
246         PARA_ERROR(WMA_BLOCK_SIZE, "invalid block size"), \
247         PARA_ERROR(WMADEC_EOF, "wmadec: end of file"), \
248         PARA_ERROR(WMA_NO_GUID, "audio stream guid not found"), \
249         PARA_ERROR(WMA_OUTPUT_SPACE, "insufficient output space"), \
250         PARA_ERROR(WRITE_COMMON_EOF, "end of file"), \
251
252 /**
253  * This is temporarily defined to expand to its first argument (prefixed by
254  * 'E_') and gets later redefined to expand to the error text only
255  */
256 #define PARA_ERROR(err, msg) E_ ## err
257 enum para_error_codes {PARA_ERRORS};
258 #undef PARA_ERROR
259 #define PARA_ERROR(err, msg) msg
260 /** Array of error strings. */
261 extern const char * const para_errlist[];
262 #define DEFINE_PARA_ERRLIST const char * const para_errlist[] = {PARA_ERRORS}
263
264 /**
265  * This bit indicates whether a number is considered a system error number
266  * If yes, the system errno is just the result of clearing this bit from
267  * the given number.
268  */
269 #define SYSTEM_ERROR_BIT 30
270
271 /**
272  * Like the SYSTEM_ERROR_BIT, but indicates an error from the osl library.
273  */
274 #define OSL_ERROR_BIT 29
275
276 #define LLS_ERROR_BIT 28
277
278 /** Check whether the system error bit is set. */
279 #define IS_SYSTEM_ERROR(num) (!!((num) & (1 << SYSTEM_ERROR_BIT)))
280
281 /** Check whether the osl error bit is set. */
282 #define IS_OSL_ERROR(num) (!!((num) & (1 << OSL_ERROR_BIT)))
283
284 /** Check whether the lopsub error bit is set. */
285 #define IS_LLS_ERROR(num) (!!((num) & (1 << LLS_ERROR_BIT)))
286
287 /** Set the system error bit for the given number. */
288 #define ERRNO_TO_PARA_ERROR(num) ((num) | (1 << SYSTEM_ERROR_BIT))
289
290 /** Set the osl error bit for the given number. */
291 #define OSL_ERRNO_TO_PARA_ERROR(num) ((num) | (1 << OSL_ERROR_BIT))
292
293 /** Set the lopsub error bit for the error code. */
294 #define LLS_ERRNO_TO_PARA_ERROR(num) ((num) | (1 << LLS_ERROR_BIT))
295
296 static const char *weak_osl_strerror(int) __attribute__ ((weakref("osl_strerror")));
297 static const char *weak_lls_strerror(int) __attribute__ ((weakref("lls_strerror")));
298 /**
299  * Paraslash's version of strerror(3).
300  *
301  * \param num The error number.
302  *
303  * \return The error text of \a num.
304  */
305 _static_inline_ const char *para_strerror(int num)
306 {
307         assert(num > 0);
308         if (IS_OSL_ERROR(num)) {
309                 assert(weak_osl_strerror);
310                 return weak_osl_strerror(num & ~(1U << OSL_ERROR_BIT));
311         }
312         if (IS_LLS_ERROR(num)) {
313                 assert(weak_lls_strerror);
314                 return weak_lls_strerror(num & ~(1U << LLS_ERROR_BIT));
315         }
316         if (IS_SYSTEM_ERROR(num))
317                 return strerror(num & ~(1U << SYSTEM_ERROR_BIT));
318         return para_errlist[num];
319 }
320
321 /**
322  * Wrapper for osl library calls.
323  *
324  * \param ret The return value of an osl library function.
325  *
326  * This should be used for all calls to osl functions that return an osl error
327  * code. It changes the return value appropriately so that it can be used for
328  * printing the correct error message with para_strerror().
329  *
330  * \return \a ret if \a ret >= 0, a paraslash error code otherwise.
331  */
332 _static_inline_ int osl(int ret)
333 {
334         if (ret >= 0)
335                 return ret;
336         return -OSL_ERRNO_TO_PARA_ERROR(-ret);
337 }
338
339 /**
340  * Wrapper for lopsub library calls.
341  *
342  * \param ret See osl().
343  * \return See osl().
344  */
345 _static_inline_ int lls(int ret)
346 {
347         if (ret >= 0)
348                 return ret;
349         return -LLS_ERRNO_TO_PARA_ERROR(-ret);
350 }