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