2 * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
19 /** \file error.h list of error messages for all subsystems */
21 /** \cond list of all subsystems that support the shiny new error facility */
62 #define NUM_SS (SS_RINGBUFFER + 1)
63 extern const char **para_errlist[];
67 PARA_ERROR(SEND, "send error"), \
68 PARA_ERROR(RECV, "receive error"), \
69 PARA_ERROR(SOCKET, "socket error"), \
70 PARA_ERROR(CONNECT, "connect error"), \
71 PARA_ERROR(ACCEPT, "accept error"), \
72 PARA_ERROR(SETSOCKOPT, "failed to set socket options"), \
73 PARA_ERROR(BIND, "bind error"), \
74 PARA_ERROR(NAME_TOO_LONG, "name too long for struct sockaddr_un"), \
75 PARA_ERROR(CHMOD, "failed to set socket mode"), \
76 PARA_ERROR(SENDMSG, "sendmsg() failed"), \
77 PARA_ERROR(RECVMSG, "recvmsg() failed"), \
78 PARA_ERROR(SCM_CREDENTIALS, "did not receive SCM credentials"), \
79 PARA_ERROR(LISTEN, "listen error"), \
80 PARA_ERROR(RECV_PATTERN, "did not receive expected pattern"), \
81 PARA_ERROR(HOST_INFO, "gethostbyname() failed"), \
84 #define ORTP_RECV_ERRORS \
85 PARA_ERROR(MSG_TO_BUF, "failed to extract rtp packet"), \
86 PARA_ERROR(ORTP_SYNTAX, "ottp syntax error"), \
87 PARA_ERROR(TOO_MANY_BAD_CHUNKS, "too many consecutive bad chunks"), \
88 PARA_ERROR(INVALID_HEADER, "invalid header packet"), \
89 PARA_ERROR(OVERRUN, "outout buffer overrun"), \
92 #define HTTP_RECV_ERRORS \
93 PARA_ERROR(SEND_HTTP_REQUEST, "failed to send http request"), \
94 PARA_ERROR(MISSING_OK, "did not receive OK message from peer"), \
95 PARA_ERROR(HTTP_RECV_BUF, "did not receive buffer")
99 PARA_ERROR(RECV_SELECT, "recv select error"), \
100 PARA_ERROR(WRITE_STDOUT, "stdout write error"), \
103 #define RECV_COMMON_ERRORS \
104 PARA_ERROR(RECV_SYNTAX, "recv syntax error"), \
107 #define AUDIOD_ERRORS \
108 PARA_ERROR(WRITE_AUDIO_DATA, "failed to write audio data"), \
109 PARA_ERROR(NO_MORE_SLOTS, "no more empty slots"), \
110 PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
111 PARA_ERROR(UNSUPPORTED_AUDIO_FORMAT, "given audio format not supported"), \
112 PARA_ERROR(CLIENT_WRITE, "client write error"), \
113 PARA_ERROR(UCRED_PERM, "permission denied"), \
114 PARA_ERROR(INVALID_AUDIOD_CMD, "invalid command"), \
117 #define FILTER_CHAIN_ERRORS \
118 PARA_ERROR(UNSUPPORTED_FILTER, "given filter not supported"), \
119 PARA_ERROR(BAD_FILTER_OPTIONS, "invalid filter option given"), \
122 #define STAT_ERRORS \
123 PARA_ERROR(TOO_MANY_CLIENTS, "maximal number of stat clients exceeded"), \
124 PARA_ERROR(UNKNOWN_STAT_ITEM, "status item not recognized"), \
127 #define OGGDEC_ERRORS \
128 PARA_ERROR(OGGDEC_READ, "read from media returned an error"), \
129 PARA_ERROR(OGGDEC_NOTVORBIS, "bitstream is not vorbis data"), \
130 PARA_ERROR(OGGDEC_VERSION, "vorbis version mismatch"), \
131 PARA_ERROR(OGGDEC_BADHEADER, "invalid vorbis bitstream header"), \
132 PARA_ERROR(OGGDEC_FAULT, "bug or heap/stack corruption"), \
133 PARA_ERROR(OGGDEC_BADLINK, "invalid stream section or requested link corrupt"), \
136 #define GRAB_CLIENT_ERRORS \
137 PARA_ERROR(PEDANTIC_GRAB, "fd not ready and pedantic grab requested"), \
138 PARA_ERROR(GC_WRITE, "grab client write error"), \
139 PARA_ERROR(BAD_GC_SLOT, "invalid slot requested by grab client"), \
140 PARA_ERROR(BAD_GC_FILTER_NUM, "invalid filter number given"), \
141 PARA_ERROR(GC_SYNTAX, "grab client syntax error"), \
142 PARA_ERROR(GC_HELP_GIVEN, ""), /* not really an error */ \
143 PARA_ERROR(GC_VERSION_GIVEN, ""), /* not really an error */ \
146 #define MP3DEC_ERRORS \
147 PARA_ERROR(MAD_FRAME_DECODE, "mad frame decode error"), \
148 PARA_ERROR(MP3DEC_OVERRUN, "mp3 output buffer overrun"), \
151 #define FILTER_ERRORS \
152 PARA_ERROR(NO_FILTERS, "at least one filter must be given"), \
153 PARA_ERROR(FILTER_SYNTAX, "syntax error"), \
156 #define SIGNAL_ERRORS \
157 PARA_ERROR(SIGNAL_SIG_ERR, "signal() retured SIG_ERR"), \
158 PARA_ERROR(SIGNAL_READ, "read error from signal pipe"), \
159 PARA_ERROR(WAITPID, "waitpid error"), \
162 #define STRING_ERRORS \
163 PARA_ERROR(MKSTEMP, "mkstemp error: unable to create tmp file"), \
164 PARA_ERROR(FCHMOD, "fchmod error: can not set mode"), \
167 #define EXEC_ERRORS \
168 PARA_ERROR(DUP_PIPE, "exec error: can not create pipe"), \
169 PARA_ERROR(NULL_OPEN, "can not open /dev/null"), \
173 PARA_ERROR(FREAD, "fread error"), \
174 PARA_ERROR(FSEEK, "fseek error"), \
175 PARA_ERROR(FRAME, "invalid mp3 frame"), \
176 PARA_ERROR(FRAME_LENGTH, "invalid frame length"), \
177 PARA_ERROR(MP3_NO_FILE, "invalid mp3 file pointer"), \
178 PARA_ERROR(MP3_INFO, "could not read mp3 info"), \
179 PARA_ERROR(MP3_REPOS, "mp3 repositioning error"), \
180 PARA_ERROR(HEADER_FREQ, "invalid header frequency"), \
181 PARA_ERROR(HEADER_BITRATE, "invalid header bitrate"), \
185 PARA_ERROR(OGG_READ, "ogg read error"), \
186 PARA_ERROR(SYNC_PAGEOUT, "ogg sync page-out error (no ogg file?)"), \
187 PARA_ERROR(STREAM_PAGEIN, "ogg stream page-in error (first page)"), \
188 PARA_ERROR(STREAM_PACKETOUT, "ogg stream packet-out error (first packet)"), \
189 PARA_ERROR(VORBIS, "vorbis synthesis header-in error (not vorbis?)"), \
190 PARA_ERROR(OGG_NO_FILE, "invalid ogg file pointer"), \
191 PARA_ERROR(OGG_OPEN, "ov_open error"), \
192 PARA_ERROR(OGG_INFO, "ov_info error"), \
193 PARA_ERROR(OGG_REPOS, "ogg repositioning error"), \
197 PARA_ERROR(AUDIO_FORMAT, "audio format not recognized"), \
198 PARA_ERROR(FSTAT, "failed to fstat() audio file"), \
202 PARA_ERROR(GETCWD, "can not get current working directory"), \
203 PARA_ERROR(CHDIR, "can not change directory"), \
204 PARA_ERROR(OPENDIR, "can not open directory"), \
205 PARA_ERROR(LSTAT, "lstat error"), \
208 #define CRYPT_ERRORS \
209 PARA_ERROR(PRIVATE_KEY, "can not read private key"), \
210 PARA_ERROR(PUBLIC_KEY, "can not read public key"), \
211 PARA_ERROR(RSA, "RSA error"), \
212 PARA_ERROR(ENCRYPT, "encrypt error"), \
213 PARA_ERROR(DECRYPT, "decrypt error"), \
214 PARA_ERROR(CHALLENGE, "failed to read challenge"), \
217 #define HTTP_SEND_ERRORS \
218 PARA_ERROR(QUEUE, "packet queue overrun"), \
219 PARA_ERROR(WRITE_OK, "can not check whether fd is writable"), \
222 #define RANDOM_SELECTOR_ERRORS \
223 PARA_ERROR(FILE_COUNT, "audio file count exceeded"), \
224 PARA_ERROR(NOTHING_FOUND, "no audio files found"), \
227 #define MYSQL_SELECTOR_ERRORS \
228 PARA_ERROR(MYSQL_SYNTAX, "mysql syntax error"), \
229 PARA_ERROR(NOTCONN, "not connected to mysql server"), \
230 PARA_ERROR(TOOBIG, "mysql: file too large"), \
231 PARA_ERROR(NAMETOOLONG, "mysql: name too long"), \
232 PARA_ERROR(QFAILED, "mysql query failed"), \
233 PARA_ERROR(NOROW, "row is NULL"), \
234 PARA_ERROR(NOATTS, "can not get attributes from mysql table"), \
235 PARA_ERROR(NORESULT, "error while fetching mysql result"), \
236 PARA_ERROR(EMPTY_RESULT, "result is empty"), \
237 PARA_ERROR(ESCAPE, "can not escape string"), \
238 PARA_ERROR(GET_AUDIO_FILE, "can not get current audio file"), \
239 PARA_ERROR(GET_STREAM, "can not get current stream"), \
240 PARA_ERROR(NO_STREAM, "no such stream"), \
241 PARA_ERROR(GET_QUERY, "can not get query for specified stream"), \
242 PARA_ERROR(TMPFILE, "error while writing temporary file"), \
243 PARA_ERROR(META, "can not get meta data"), \
244 PARA_ERROR(MYSQL_INIT, "can not initialize mysql connection"), \
245 PARA_ERROR(NO_MYSQL_PASSWD, "fatal: no mysql passord given"), \
246 PARA_ERROR(NO_AF_DIR, "fatal: audio file directory not given"), \
249 #define COMMAND_ERRORS \
250 PARA_ERROR(COMMAND_SYNTAX, "syntax error in command"), \
251 PARA_ERROR(AUTH, "did not receive auth request"), \
252 PARA_ERROR(BAD_SELECTOR, "no such audio file selector"), \
253 PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
254 PARA_ERROR(BAD_CMD, "invalid command"), \
255 PARA_ERROR(PERM, "permission denied"), \
256 PARA_ERROR(USERLIST, "failed to open user list file"), \
257 PARA_ERROR(BAD_USER, "you don't exist. Go away."), \
258 PARA_ERROR(LOCK, "lock error"), \
259 PARA_ERROR(SENDER_CMD, "command not supported by this sender"), \
261 #define PLAYLIST_SELECTOR_ERRORS \
262 PARA_ERROR(LOAD_PLAYLIST, "failed to load playlist"), \
266 PARA_ERROR(SEM_GET, "failed to create semaphore"), \
267 PARA_ERROR(SEM_REMOVE, "can not remove semaphore"), \
268 PARA_ERROR(SHM_GET, "failed to allocate shared memory area"), \
269 PARA_ERROR(SHM_DESTROY, "failed to destroy shared memory area"), \
270 PARA_ERROR(SHM_ATTACH, "can not attach shared memory area"), \
271 PARA_ERROR(SHM_DETACH, "can not detach shared memory area"), \
274 #define DCCP_ERRORS \
275 PARA_ERROR(DCCP_SOCKET, "can not create dccp socket"), \
276 PARA_ERROR(DCCP_PACKET_SIZE, "failed to set dccp packet size"), \
277 PARA_ERROR(DCCP_SERVICE, "could not get service code"), \
280 #define DCCP_RECV_ERRORS \
281 PARA_ERROR(ADDR_INFO, "getaddrinfo error"), \
282 PARA_ERROR(DCCP_OVERRUN, "dccp output buffer buffer overrun"), \
283 PARA_ERROR(DCCP_CONNECT, "dccp connect error"), \
285 #define DCCP_SEND_ERRORS \
286 PARA_ERROR(DCCP_BIND, "dccp bind error"), \
287 PARA_ERROR(DCCP_LISTEN, "dccp listen error"), \
288 PARA_ERROR(DCCP_WRITE, "dccp write error"), \
291 /* these do not need error handling (yet) */
292 #define SERVER_ERRORS
294 #define COMPRESS_ERRORS
296 #define CLOSE_ON_FORK_ERRORS
297 #define DAEMON_ERRORS
298 #define ORTP_SEND_ERRORS
299 #define RINGBUFFER_ERRORS
304 * the subsystem shift
306 * 255 error codes ought to be enough for every subsystem. Use the higher bits
307 * of the return value to encode the subsystem number
312 * compute the subsystem offset
314 * It is given by x * 2**8 where \a x is the subsystem number
316 #define SS_OFFSET(ss) (SS_ ## ss << SS_SHIFT)
319 * make the enum of all errors of one subsystem
321 * As zero should not be an error, we define a dummy enum entry with value
322 * 2**ss. That lets the real errors start at 2**ss + 1.
324 #define SS_ENUM(ss) enum {\
325 E_ ## ss ## _DUMMY = SS_OFFSET(ss), \
329 * determine the subsystem number from the error number
331 * Easy, it's just \a num / 2**8.
333 #define ERRNUM_TO_SS(num) ((num) >> SS_SHIFT)
336 * determine the index of an error number
338 * Also easy: It's the lower 8 bits of num - 1.
340 #define ERRNUM_TO_INDEX(num) (((1 << SS_SHIFT) - 1) & ((num) - 1))
343 * paraslash's version of strerror(3)
345 * expands to the error text of \a num (a string constant).
347 #define PARA_STRERROR(num) para_errlist[ERRNUM_TO_SS(num)] [ERRNUM_TO_INDEX(num)]
350 * define the error list for one subsystem
352 * Used by macros in config.h (generated by configure)
354 #define DEFINE_ERRLIST(ss) const char * ss ## _ERRLIST[] = {ss ## _ERRORS}
357 * activate errors for one subsystem.
359 * Each executable needs only the error lists of those subssystems it is actually
360 * linked with. We always reserve zeroed-out space for NUM_SS char ** pointers, but
361 * only init those of the needed subsystems. This macro is used by macros in config.h
362 * (generated by configure).
364 #define PARA_ERRLIST(ss) [SS_ ## ss] = ss ## _ERRLIST
367 * This is temporarily defined to expand to its second argument (prefixed by
368 * 'E_') and gets later redefined to expand to the error text only
370 #define PARA_ERROR(err, msg) E_ ## err
372 /** \cond popcorn time */
378 SS_ENUM(CLOSE_ON_FORK);
384 SS_ENUM(GRAB_CLIENT);
386 SS_ENUM(RECV_COMMON);
387 SS_ENUM(FILTER_CHAIN);
398 SS_ENUM(RANDOM_SELECTOR);
399 SS_ENUM(PLAYLIST_SELECTOR);
404 SS_ENUM(MYSQL_SELECTOR);
413 /* rest of the world only sees the error text */
414 #define PARA_ERROR(err, msg) msg