335950b76b5c949a3be38a7f1e9c74d68e513f3d
[paraslash.git] / error.h
1 /*
2 * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
3 *
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.
8 *
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.
13 *
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.
17 */
18
19 /** \file error.h list of error messages for all subsystems */
20
21 /** \cond list of all subsystems that support the shiny new error facility */
22 enum para_subsystem {SS_RECV,
23 SS_NET, SS_ORTP_RECV, SS_AUDIOD, SS_EXEC, SS_CLOSE_ON_FORK, SS_SIGNAL,
24 SS_STRING, SS_DAEMON, SS_STAT, SS_TIME, SS_GRAB_CLIENT, SS_HTTP_RECV,
25 SS_RECV_COMMON, SS_FILTER_CHAIN, SS_WAV, SS_COMPRESS, SS_OGGDEC, SS_FILTER,
26 SS_COMMAND, SS_RANDOM_SELECTOR, SS_PLAYLIST_SELECTOR, SS_CRYPT,
27 SS_HTTP_SEND, SS_ORTP_SEND, SS_DB, SS_OGG,
28 SS_MP3, SS_MP3DEC, SS_SERVER, SS_AFS, SS_MYSQL_SELECTOR,
29 SS_IPC, SS_RINGBUFFER};
30 #define NUM_SS (SS_RINGBUFFER + 1)
31 extern const char **para_errlist[];
32 /** \endcond */
33
34 #define NET_ERRORS \
35 PARA_ERROR(SEND, "send error"), \
36 PARA_ERROR(RECV, "receive error"), \
37 PARA_ERROR(SOCKET, "socket error"), \
38 PARA_ERROR(CONNECT, "connect error"), \
39 PARA_ERROR(ACCEPT, "accept error"), \
40 PARA_ERROR(SETSOCKOPT, "failed to set socket options"), \
41 PARA_ERROR(BIND, "bind error"), \
42 PARA_ERROR(NAME_TOO_LONG, "name too long for struct sockaddr_un"), \
43 PARA_ERROR(CHMOD, "failed to set socket mode"), \
44 PARA_ERROR(SENDMSG, "sendmsg() failed"), \
45 PARA_ERROR(RECVMSG, "recvmsg() failed"), \
46 PARA_ERROR(SCM_CREDENTIALS, "did not receive SCM credentials"), \
47 PARA_ERROR(LISTEN, "listen error"), \
48 PARA_ERROR(RECV_PATTERN, "did not receive expected pattern"), \
49 PARA_ERROR(HOST_INFO, "gethostbyname() failed"), \
50
51
52 #define ORTP_RECV_ERRORS \
53 PARA_ERROR(MSG_TO_BUF, "failed to extract rtp packet"), \
54 PARA_ERROR(ORTP_SYNTAX, "ottp syntax error"), \
55 PARA_ERROR(TOO_MANY_BAD_CHUNKS, "too many consecutive bad chunks"), \
56 PARA_ERROR(INVALID_HEADER, "invalid header packet"), \
57 PARA_ERROR(OVERRUN, "outout buffer overrun"), \
58
59
60 #define HTTP_RECV_ERRORS \
61 PARA_ERROR(SEND_HTTP_REQUEST, "failed to send http request"), \
62 PARA_ERROR(MISSING_OK, "did not receive OK message from peer"), \
63 PARA_ERROR(HTTP_RECV_BUF, "did not receive buffer")
64
65
66 #define RECV_ERRORS \
67 PARA_ERROR(RECV_SELECT, "recv select error"), \
68 PARA_ERROR(WRITE_STDOUT, "stdout write error"), \
69
70
71 #define RECV_COMMON_ERRORS \
72 PARA_ERROR(RECV_SYNTAX, "recv syntax error"), \
73
74
75 #define AUDIOD_ERRORS \
76 PARA_ERROR(WRITE_AUDIO_DATA, "failed to write audio data"), \
77 PARA_ERROR(NO_MORE_SLOTS, "no more empty slots"), \
78 PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
79 PARA_ERROR(UNSUPPORTED_AUDIO_FORMAT, "given audio format not supported"), \
80 PARA_ERROR(CLIENT_WRITE, "client write error"), \
81 PARA_ERROR(UCRED_PERM, "permission denied"), \
82 PARA_ERROR(INVALID_AUDIOD_CMD, "invalid command"), \
83
84
85 #define FILTER_CHAIN_ERRORS \
86 PARA_ERROR(UNSUPPORTED_FILTER, "given filter not supported"), \
87 PARA_ERROR(BAD_FILTER_OPTIONS, "invalid filter option given"), \
88
89
90 #define STAT_ERRORS \
91 PARA_ERROR(TOO_MANY_CLIENTS, "maximal number of stat clients exceeded"), \
92 PARA_ERROR(UNKNOWN_STAT_ITEM, "status item not recognized"), \
93
94
95 #define OGGDEC_ERRORS \
96 PARA_ERROR(OGGDEC_READ, "read from media returned an error"), \
97 PARA_ERROR(OGGDEC_NOTVORBIS, "bitstream is not vorbis data"), \
98 PARA_ERROR(OGGDEC_VERSION, "vorbis version mismatch"), \
99 PARA_ERROR(OGGDEC_BADHEADER, "invalid vorbis bitstream header"), \
100 PARA_ERROR(OGGDEC_FAULT, "bug or heap/stack corruption"), \
101 PARA_ERROR(OGGDEC_BADLINK, "invalid stream section or requested link corrupt"), \
102
103
104 #define GRAB_CLIENT_ERRORS \
105 PARA_ERROR(PEDANTIC_GRAB, "fd not ready and pedantic grab requested"), \
106 PARA_ERROR(GC_WRITE, "grab client write error"), \
107 PARA_ERROR(INVALID_GRAB_MODE, "invalid grab client mode"), \
108 PARA_ERROR(BAD_GC_SLOT, "invalid slot requested by grab client"), \
109 PARA_ERROR(BAD_GC_FILTER_NUM, "invalid filter number given"), \
110 PARA_ERROR(GC_SYNTAX, "grab client syntax error"), \
111 PARA_ERROR(GC_HELP_GIVEN, ""), /* not really an error */ \
112
113
114 #define MP3DEC_ERRORS \
115 PARA_ERROR(MAD_FRAME_DECODE, "mad frame decode error"), \
116 PARA_ERROR(MP3DEC_OVERRUN, "mp3 output buffer overrun"), \
117
118
119 #define FILTER_ERRORS \
120 PARA_ERROR(NO_FILTERS, "at least one filter must be given"), \
121 PARA_ERROR(FILTER_SYNTAX, "syntax error"), \
122
123
124 #define SIGNAL_ERRORS \
125 PARA_ERROR(SIGNAL_SIG_ERR, "signal() retured SIG_ERR"), \
126 PARA_ERROR(SIGNAL_READ, "read error from signal pipe"), \
127 PARA_ERROR(WAITPID, "waitpid error"), \
128
129
130 #define STRING_ERRORS \
131 PARA_ERROR(MKSTEMP, "mkstemp error: unable to create tmp file"), \
132 PARA_ERROR(FCHMOD, "fchmod error: can not set mode"), \
133
134
135 #define EXEC_ERRORS \
136 PARA_ERROR(DUP_PIPE, "exec error: can not create pipe"), \
137 PARA_ERROR(NULL_OPEN, "can not open /dev/null"), \
138
139
140 #define MP3_ERRORS \
141 PARA_ERROR(FREAD, "fread error"), \
142 PARA_ERROR(FSEEK, "fseek error"), \
143 PARA_ERROR(FRAME, "invalid mp3 frame"), \
144 PARA_ERROR(FRAME_LENGTH, "invalid frame length"), \
145 PARA_ERROR(MP3_NO_FILE, "invalid mp3 file pointer"), \
146 PARA_ERROR(MP3_INFO, "could not read mp3 info"), \
147 PARA_ERROR(MP3_REPOS, "mp3 repositioning error"), \
148 PARA_ERROR(HEADER_FREQ, "invalid header frequency"), \
149 PARA_ERROR(HEADER_BITRATE, "invalid header bitrate"), \
150
151
152 #define OGG_ERRORS \
153 PARA_ERROR(OGG_READ, "ogg read error"), \
154 PARA_ERROR(SYNC_PAGEOUT, "ogg sync page-out error (no ogg file?)"), \
155 PARA_ERROR(STREAM_PAGEIN, "ogg stream page-in error (first page)"), \
156 PARA_ERROR(STREAM_PACKETOUT, "ogg stream packet-out error (first packet)"), \
157 PARA_ERROR(VORBIS, "vorbis synthesis header-in error (not vorbis?)"), \
158 PARA_ERROR(OGG_NO_FILE, "invalid ogg file pointer"), \
159 PARA_ERROR(OGG_OPEN, "ov_open error"), \
160 PARA_ERROR(OGG_INFO, "ov_info error"), \
161 PARA_ERROR(OGG_REPOS, "ogg repositioning error"), \
162
163
164 #define AFS_ERRORS \
165 PARA_ERROR(AUDIO_FORMAT, "audio format not recognized"), \
166 PARA_ERROR(FSTAT, "failed to fstat() audio file"), \
167
168
169 #define DB_ERRORS \
170 PARA_ERROR(GETCWD, "can not get current working directory"), \
171 PARA_ERROR(CHDIR, "can not change directory"), \
172 PARA_ERROR(OPENDIR, "can not open directory"), \
173 PARA_ERROR(LSTAT, "lstat error"), \
174
175
176 #define CRYPT_ERRORS \
177 PARA_ERROR(PRIVATE_KEY, "can not read private key"), \
178 PARA_ERROR(PUBLIC_KEY, "can not read public key"), \
179 PARA_ERROR(RSA, "RSA error"), \
180 PARA_ERROR(ENCRYPT, "encrypt error"), \
181 PARA_ERROR(DECRYPT, "decrypt error"), \
182 PARA_ERROR(CHALLENGE, "failed to read challenge"), \
183
184
185 #define HTTP_SEND_ERRORS \
186 PARA_ERROR(QUEUE, "packet queue overrun"), \
187 PARA_ERROR(WRITE_OK, "can not check whether fd is writable"), \
188
189
190 #define RANDOM_SELECTOR_ERRORS \
191 PARA_ERROR(FILE_COUNT, "audio file count exceeded"), \
192 PARA_ERROR(NOTHING_FOUND, "no audio files found"), \
193
194
195 #define MYSQL_SELECTOR_ERRORS \
196 PARA_ERROR(MYSQL_SYNTAX, "mysql syntax error"), \
197 PARA_ERROR(NOTCONN, "not connected to mysql server"), \
198 PARA_ERROR(TOOBIG, "mysql: file too large"), \
199 PARA_ERROR(NAMETOOLONG, "mysql: name too long"), \
200 PARA_ERROR(QFAILED, "mysql query failed"), \
201 PARA_ERROR(NOROW, "row is NULL"), \
202 PARA_ERROR(NOATTS, "can not get attributes from mysql table"), \
203 PARA_ERROR(NORESULT, "error while fetching mysql result"), \
204 PARA_ERROR(EMPTY_RESULT, "result is empty"), \
205 PARA_ERROR(ESCAPE, "can not escape string"), \
206 PARA_ERROR(GET_AUDIO_FILE, "can not get current audio file"), \
207 PARA_ERROR(GET_STREAM, "can not get current stream"), \
208 PARA_ERROR(NO_STREAM, "no such stream"), \
209 PARA_ERROR(GET_QUERY, "can not get query for specified stream"), \
210 PARA_ERROR(TMPFILE, "error while writing temporary file"), \
211 PARA_ERROR(META, "can not get meta data"), \
212 PARA_ERROR(MYSQL_INIT, "can not initialize mysql connection"), \
213 PARA_ERROR(NO_MYSQL_PASSWD, "fatal: no mysql passord given"), \
214 PARA_ERROR(NO_AF_DIR, "fatal: audio file directory not given"), \
215
216
217 #define COMMAND_ERRORS \
218 PARA_ERROR(COMMAND_SYNTAX, "syntax error in command"), \
219 PARA_ERROR(AUTH, "did not receive auth request"), \
220 PARA_ERROR(BAD_SELECTOR, "no such audio file selector"), \
221 PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
222 PARA_ERROR(BAD_CMD, "invalid command"), \
223 PARA_ERROR(PERM, "permission denied"), \
224 PARA_ERROR(USERLIST, "failed to open user list file"), \
225 PARA_ERROR(BAD_USER, "you don't exist. Go away."), \
226 PARA_ERROR(LOCK, "lock error"), \
227 PARA_ERROR(SENDER_CMD, "command not supported by this sender"), \
228
229 #define PLAYLIST_SELECTOR_ERRORS \
230 PARA_ERROR(LOAD_PLAYLIST, "failed to load playlist"), \
231
232
233 #define IPC_ERRORS \
234 PARA_ERROR(SEM_GET, "failed to create semaphore"), \
235 PARA_ERROR(SEM_REMOVE, "can not remove semaphore"), \
236 PARA_ERROR(SHM_GET, "failed to allocate shared memory area"), \
237 PARA_ERROR(SHM_DESTROY, "failed to destroy shared memory area"), \
238 PARA_ERROR(SHM_ATTACH, "can not attach shared memory area"), \
239 PARA_ERROR(SHM_DETACH, "can not detach shared memory area"), \
240
241 /* these do not need error handling (yet) */
242 #define SERVER_ERRORS
243 #define WAV_ERRORS
244 #define COMPRESS_ERRORS
245 #define TIME_ERRORS
246 #define CLOSE_ON_FORK_ERRORS
247 #define DAEMON_ERRORS
248 #define ORTP_SEND_ERRORS
249 #define RINGBUFFER_ERRORS
250
251
252 /**
253 * the subsystem shift
254 *
255 * 255 error codes ought to be enough for every subsystem. Use the higher bits
256 * of the return value to encode the subsystem number
257 */
258 #define SS_SHIFT 8
259
260 /**
261 * compute the subsystem offset
262 *
263 * It is given by x * 2**8 where \a x is the subsystem number
264 */
265 #define SS_OFFSET(ss) (SS_ ## ss << SS_SHIFT)
266
267 /**
268 * make the enum of all errors of one subsystem
269 *
270 * As zero should not be an error, we define a dummy enum entry with value
271 * 2**ss. That lets the real errors start at 2**ss + 1.
272 */
273 #define SS_ENUM(ss) enum {\
274 E_ ## ss ## _DUMMY = SS_OFFSET(ss), \
275 ss ## _ERRORS}
276
277 /**
278 * determine the subsystem number from the error number
279 *
280 * Easy, it's just \a num / 2**8.
281 */
282 #define ERRNUM_TO_SS(num) ((num) >> SS_SHIFT)
283
284 /**
285 * determine the index of an error number
286 *
287 * Also easy: It's the lower 8 bits of num - 1.
288 */
289 #define ERRNUM_TO_INDEX(num) (((1 << SS_SHIFT) - 1) & ((num) - 1))
290
291 /**
292 * paraslash's version of strerror(3)
293 *
294 * expands to the error text of \a num (a string constant).
295 */
296 #define PARA_STRERROR(num) para_errlist[ERRNUM_TO_SS(num)] [ERRNUM_TO_INDEX(num)]
297
298 /**
299 * define the error list for one subsystem
300 *
301 * Used by macros in config.h (generated by configure)
302 */
303 #define DEFINE_ERRLIST(ss) const char * ss ## _ERRLIST[] = {ss ## _ERRORS}
304
305 /**
306 * activate errors for one subsystem.
307 *
308 * Each executable needs only the error lists of those subssystems it is actually
309 * linked with. We always reserve zeroed-out space for NUM_SS char ** pointers, but
310 * only init those of the needed subsystems. This macro is used by macros in config.h
311 * (generated by configure).
312 */
313 #define PARA_ERRLIST(ss) [SS_ ## ss] = ss ## _ERRLIST
314
315 /**
316 * This is temporarily defined to expand to its second argument (prefixed by
317 * 'E_') and gets later redefined to expand to the error text only
318 */
319 #define PARA_ERROR(err, msg) E_ ## err
320
321 /** \cond popcorn time */
322 SS_ENUM(ORTP_RECV);
323 SS_ENUM(NET);
324 SS_ENUM(RECV);
325 SS_ENUM(AUDIOD);
326 SS_ENUM(EXEC);
327 SS_ENUM(CLOSE_ON_FORK);
328 SS_ENUM(SIGNAL);
329 SS_ENUM(STRING);
330 SS_ENUM(DAEMON);
331 SS_ENUM(STAT);
332 SS_ENUM(TIME);
333 SS_ENUM(GRAB_CLIENT);
334 SS_ENUM(HTTP_RECV);
335 SS_ENUM(RECV_COMMON);
336 SS_ENUM(FILTER_CHAIN);
337 SS_ENUM(WAV);
338 SS_ENUM(COMPRESS);
339 SS_ENUM(OGGDEC);
340 SS_ENUM(MP3DEC);
341 SS_ENUM(FILTER);
342 SS_ENUM(MP3);
343 SS_ENUM(OGG);
344 SS_ENUM(SERVER);
345 SS_ENUM(AFS);
346 SS_ENUM(COMMAND);
347 SS_ENUM(RANDOM_SELECTOR);
348 SS_ENUM(PLAYLIST_SELECTOR);
349 SS_ENUM(CRYPT);
350 SS_ENUM(HTTP_SEND);
351 SS_ENUM(ORTP_SEND);
352 SS_ENUM(DB);
353 SS_ENUM(MYSQL_SELECTOR);
354 SS_ENUM(IPC);
355 SS_ENUM(RINGBUFFER);
356 /** \endcond */
357 #undef PARA_ERROR
358 /* rest of the world only sees the error text */
359 #define PARA_ERROR(err, msg) msg