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