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 {
  23         SS_RECV,
  24         SS_NET,
  25         SS_ORTP_RECV,
  26         SS_AUDIOD,
  27         SS_EXEC,
  28         SS_CLOSE_ON_FORK,
  29         SS_SIGNAL,
  30         SS_STRING,
  31         SS_DAEMON,
  32         SS_STAT,
  33         SS_TIME,
  34         SS_GRAB_CLIENT,
  35         SS_HTTP_RECV,
  36         SS_RECV_COMMON,
  37         SS_FILTER_CHAIN,
  38         SS_WAV,
  39         SS_COMPRESS,
  40         SS_OGGDEC,
  41         SS_FILTER,
  42         SS_COMMAND,
  43         SS_RANDOM_SELECTOR,
  44         SS_PLAYLIST_SELECTOR,
  45         SS_CRYPT,
  46         SS_HTTP_SEND,
  47         SS_ORTP_SEND,
  48         SS_DB,
  49         SS_OGG,
  50         SS_MP3,
  51         SS_MP3DEC,
  52         SS_SERVER,
  53         SS_AFS,
  54         SS_MYSQL_SELECTOR,
  55         SS_IPC,
  56         SS_DCCP,
  57         SS_DCCP_RECV,
  58         SS_DCCP_SEND,
  59         SS_FD,
  60         SS_GUI,
  61         SS_WRITE,
  62         SS_WRITE_COMMON,
  63         SS_ALSA_WRITER,
  64         SS_FILE_WRITER,
  65         SS_RINGBUFFER};
  66
  67 #define NUM_SS (SS_RINGBUFFER + 1)
  68 extern const char **para_errlist[];
  69 /** \endcond */
  70
  71 #define NET_ERRORS \
  72         PARA_ERROR(SEND, "send error"), \
  73         PARA_ERROR(RECV, "receive error"), \
  74         PARA_ERROR(SOCKET, "socket error"), \
  75         PARA_ERROR(CONNECT, "connect error"), \
  76         PARA_ERROR(ACCEPT, "accept error"), \
  77         PARA_ERROR(SETSOCKOPT, "failed to set socket options"), \
  78         PARA_ERROR(BIND, "bind error"), \
  79         PARA_ERROR(NAME_TOO_LONG, "name too long for struct sockaddr_un"), \
  80         PARA_ERROR(CHMOD, "failed to set socket mode"), \
  81         PARA_ERROR(SENDMSG, "sendmsg() failed"), \
  82         PARA_ERROR(RECVMSG, "recvmsg() failed"), \
  83         PARA_ERROR(SCM_CREDENTIALS, "did not receive SCM credentials"), \
  84         PARA_ERROR(LISTEN, "listen error"), \
  85         PARA_ERROR(RECV_PATTERN, "did not receive expected pattern"), \
  86         PARA_ERROR(HOST_INFO, "gethostbyname() failed"), \
  87
  88
  89 #define ORTP_RECV_ERRORS \
  90         PARA_ERROR(MSG_TO_BUF, "failed to extract rtp packet"), \
  91         PARA_ERROR(ORTP_SYNTAX, "ottp syntax error"), \
  92         PARA_ERROR(TOO_MANY_BAD_CHUNKS, "too many consecutive bad chunks"), \
  93         PARA_ERROR(INVALID_HEADER, "invalid header packet"), \
  94         PARA_ERROR(OVERRUN, "outout buffer overrun"), \
  95
  96
  97 #define HTTP_RECV_ERRORS \
  98         PARA_ERROR(SEND_HTTP_REQUEST, "failed to send http request"), \
  99         PARA_ERROR(MISSING_OK, "did not receive OK message from peer"), \
 100         PARA_ERROR(HTTP_RECV_BUF, "did not receive buffer")
 101
 102
 103 #define RECV_ERRORS \
 104         PARA_ERROR(RECV_SELECT, "recv select error"), \
 105         PARA_ERROR(WRITE_STDOUT, "stdout write error"), \
 106
 107
 108 #define RECV_COMMON_ERRORS \
 109         PARA_ERROR(RECV_SYNTAX, "recv syntax error"), \
 110
 111
 112 #define AUDIOD_ERRORS \
 113         PARA_ERROR(WRITE_AUDIO_DATA, "failed to write audio data"), \
 114         PARA_ERROR(NO_MORE_SLOTS, "no more empty slots"), \
 115         PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
 116         PARA_ERROR(UNSUPPORTED_AUDIO_FORMAT, "given audio format not supported"), \
 117         PARA_ERROR(CLIENT_WRITE, "client write error"), \
 118         PARA_ERROR(UCRED_PERM, "permission denied"), \
 119         PARA_ERROR(INVALID_AUDIOD_CMD, "invalid command"), \
 120
 121
 122 #define FILTER_CHAIN_ERRORS \
 123         PARA_ERROR(UNSUPPORTED_FILTER, "given filter not supported"), \
 124         PARA_ERROR(BAD_FILTER_OPTIONS, "invalid filter option given"), \
 125
 126
 127 #define STAT_ERRORS \
 128         PARA_ERROR(TOO_MANY_CLIENTS, "maximal number of stat clients exceeded"), \
 129         PARA_ERROR(UNKNOWN_STAT_ITEM, "status item not recognized"), \
 130
 131
 132 #define OGGDEC_ERRORS \
 133         PARA_ERROR(OGGDEC_READ, "read from media returned an error"), \
 134         PARA_ERROR(OGGDEC_NOTVORBIS, "bitstream is not vorbis data"), \
 135         PARA_ERROR(OGGDEC_VERSION, "vorbis version mismatch"), \
 136         PARA_ERROR(OGGDEC_BADHEADER, "invalid vorbis bitstream header"), \
 137         PARA_ERROR(OGGDEC_FAULT, "bug or heap/stack corruption"), \
 138         PARA_ERROR(OGGDEC_BADLINK, "invalid stream section or requested link corrupt"), \
 139
 140
 141 #define GRAB_CLIENT_ERRORS \
 142         PARA_ERROR(PEDANTIC_GRAB, "fd not ready and pedantic grab requested"), \
 143         PARA_ERROR(GC_WRITE, "grab client write error"), \
 144         PARA_ERROR(BAD_GC_SLOT, "invalid slot requested by grab client"), \
 145         PARA_ERROR(BAD_GC_FILTER_NUM, "invalid filter number given"), \
 146         PARA_ERROR(GC_SYNTAX, "grab client syntax error"), \
 147         PARA_ERROR(GC_HELP_GIVEN, ""), /* not really an error */ \
 148         PARA_ERROR(GC_VERSION_GIVEN, ""), /* not really an error */ \
 149
 150
 151 #define MP3DEC_ERRORS \
 152         PARA_ERROR(MAD_FRAME_DECODE, "mad frame decode error"), \
 153         PARA_ERROR(MP3DEC_OVERRUN, "mp3 output buffer overrun"), \
 154
 155
 156 #define FILTER_ERRORS \
 157         PARA_ERROR(NO_FILTERS, "at least one filter must be given"), \
 158         PARA_ERROR(FILTER_SYNTAX, "syntax error"), \
 159
 160
 161 #define SIGNAL_ERRORS \
 162         PARA_ERROR(SIGNAL_SIG_ERR, "signal() retured SIG_ERR"), \
 163         PARA_ERROR(SIGNAL_READ, "read error from signal pipe"), \
 164         PARA_ERROR(WAITPID, "waitpid error"), \
 165         PARA_ERROR(SIGNAL_PIPE, "failed to setup signal pipe"), \
 166
 167
 168 #define STRING_ERRORS \
 169         PARA_ERROR(MKSTEMP, "mkstemp error: unable to create tmp file"), \
 170         PARA_ERROR(FCHMOD, "fchmod error: can not set mode"), \
 171
 172
 173 #define EXEC_ERRORS \
 174         PARA_ERROR(DUP_PIPE, "exec error: can not create pipe"), \
 175         PARA_ERROR(NULL_OPEN, "can not open /dev/null"), \
 176
 177
 178 #define MP3_ERRORS \
 179         PARA_ERROR(FREAD, "fread error"), \
 180         PARA_ERROR(FSEEK, "fseek error"), \
 181         PARA_ERROR(FRAME, "invalid mp3 frame"), \
 182         PARA_ERROR(FRAME_LENGTH, "invalid frame length"), \
 183         PARA_ERROR(MP3_NO_FILE, "invalid mp3 file pointer"), \
 184         PARA_ERROR(MP3_INFO, "could not read mp3 info"), \
 185         PARA_ERROR(MP3_REPOS, "mp3 repositioning error"), \
 186         PARA_ERROR(HEADER_FREQ, "invalid header frequency"), \
 187         PARA_ERROR(HEADER_BITRATE, "invalid header bitrate"), \
 188
 189
 190 #define OGG_ERRORS \
 191         PARA_ERROR(OGG_READ, "ogg read error"), \
 192         PARA_ERROR(SYNC_PAGEOUT, "ogg sync page-out error (no ogg file?)"), \
 193         PARA_ERROR(STREAM_PAGEIN, "ogg stream page-in error (first page)"), \
 194         PARA_ERROR(STREAM_PACKETOUT, "ogg stream packet-out error (first packet)"), \
 195         PARA_ERROR(VORBIS, "vorbis synthesis header-in error (not vorbis?)"), \
 196         PARA_ERROR(OGG_NO_FILE, "invalid ogg file pointer"), \
 197         PARA_ERROR(OGG_OPEN, "ov_open error"), \
 198         PARA_ERROR(OGG_INFO, "ov_info error"), \
 199         PARA_ERROR(OGG_REPOS, "ogg repositioning error"), \
 200
 201
 202 #define AFS_ERRORS \
 203         PARA_ERROR(AUDIO_FORMAT, "audio format not recognized"), \
 204         PARA_ERROR(FSTAT, "failed to fstat() audio file"), \
 205
 206
 207 #define DB_ERRORS \
 208         PARA_ERROR(GETCWD, "can not get current working directory"), \
 209         PARA_ERROR(CHDIR, "can not change directory"), \
 210         PARA_ERROR(OPENDIR, "can not open directory"), \
 211         PARA_ERROR(LSTAT, "lstat error"), \
 212
 213
 214 #define CRYPT_ERRORS \
 215         PARA_ERROR(PRIVATE_KEY, "can not read private key"), \
 216         PARA_ERROR(PUBLIC_KEY, "can not read public key"), \
 217         PARA_ERROR(RSA, "RSA error"), \
 218         PARA_ERROR(ENCRYPT, "encrypt error"), \
 219         PARA_ERROR(DECRYPT, "decrypt error"), \
 220         PARA_ERROR(CHALLENGE, "failed to read challenge"), \
 221
 222
 223 #define HTTP_SEND_ERRORS \
 224         PARA_ERROR(QUEUE, "packet queue overrun"), \
 225         PARA_ERROR(WRITE_OK, "can not check whether fd is writable"), \
 226
 227
 228 #define RANDOM_SELECTOR_ERRORS \
 229         PARA_ERROR(FILE_COUNT, "audio file count exceeded"), \
 230         PARA_ERROR(NOTHING_FOUND, "no audio files found"), \
 231
 232
 233 #define MYSQL_SELECTOR_ERRORS \
 234         PARA_ERROR(MYSQL_SYNTAX, "mysql syntax error"), \
 235         PARA_ERROR(NOTCONN, "not connected to mysql server"), \
 236         PARA_ERROR(TOOBIG, "mysql: file too large"), \
 237         PARA_ERROR(NAMETOOLONG, "mysql: name too long"), \
 238         PARA_ERROR(QFAILED, "mysql query failed"), \
 239         PARA_ERROR(NOROW, "row is NULL"), \
 240         PARA_ERROR(NOATTS, "can not get attributes from mysql table"), \
 241         PARA_ERROR(NORESULT, "error while fetching mysql result"), \
 242         PARA_ERROR(EMPTY_RESULT, "result is empty"), \
 243         PARA_ERROR(ESCAPE, "can not escape string"), \
 244         PARA_ERROR(GET_AUDIO_FILE, "can not get current audio file"), \
 245         PARA_ERROR(GET_STREAM, "can not get current stream"), \
 246         PARA_ERROR(NO_STREAM, "no such stream"), \
 247         PARA_ERROR(AUDIO_FILE, "no such audio file"), \
 248         PARA_ERROR(GET_QUERY, "can not get query for specified stream"), \
 249         PARA_ERROR(TMPFILE, "error while writing temporary file"), \
 250         PARA_ERROR(META, "can not get meta data"), \
 251         PARA_ERROR(MYSQL_INIT, "can not initialize mysql connection"), \
 252         PARA_ERROR(NO_MYSQL_PASSWD, "fatal: no mysql passord given"), \
 253         PARA_ERROR(NO_AF_DIR, "fatal: audio file directory not given"), \
 254
 255
 256 #define COMMAND_ERRORS \
 257         PARA_ERROR(COMMAND_SYNTAX, "syntax error in command"), \
 258         PARA_ERROR(AUTH, "did not receive auth request"), \
 259         PARA_ERROR(BAD_SELECTOR, "no such audio file selector"), \
 260         PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
 261         PARA_ERROR(BAD_CMD, "invalid command"), \
 262         PARA_ERROR(PERM, "permission denied"), \
 263         PARA_ERROR(USERLIST, "failed to open user list file"), \
 264         PARA_ERROR(BAD_USER, "you don't exist. Go away."), \
 265         PARA_ERROR(LOCK, "lock error"), \
 266         PARA_ERROR(SENDER_CMD, "command not supported by this sender"), \
 267
 268 #define PLAYLIST_SELECTOR_ERRORS \
 269         PARA_ERROR(LOAD_PLAYLIST, "failed to load playlist"), \
 270
 271
 272 #define IPC_ERRORS \
 273         PARA_ERROR(SEM_GET, "failed to create semaphore"), \
 274         PARA_ERROR(SEM_REMOVE, "can not remove semaphore"), \
 275         PARA_ERROR(SHM_GET, "failed to allocate shared memory area"), \
 276         PARA_ERROR(SHM_DESTROY, "failed to destroy shared memory area"), \
 277         PARA_ERROR(SHM_ATTACH, "can not attach shared memory area"), \
 278         PARA_ERROR(SHM_DETACH, "can not detach shared memory area"), \
 279
 280
 281 #define DCCP_ERRORS \
 282         PARA_ERROR(DCCP_SOCKET, "can not create dccp socket"), \
 283         PARA_ERROR(DCCP_PACKET_SIZE, "failed to set dccp packet size"), \
 284         PARA_ERROR(DCCP_SERVICE, "could not get service code"), \
 285
 286
 287 #define DCCP_RECV_ERRORS \
 288         PARA_ERROR(ADDR_INFO, "getaddrinfo error"), \
 289         PARA_ERROR(DCCP_OVERRUN, "dccp output buffer buffer overrun"), \
 290         PARA_ERROR(DCCP_CONNECT, "dccp connect error"), \
 291
 292 #define DCCP_SEND_ERRORS \
 293         PARA_ERROR(DCCP_BIND, "dccp bind error"), \
 294         PARA_ERROR(DCCP_LISTEN, "dccp listen error"), \
 295         PARA_ERROR(DCCP_WRITE, "dccp write error"), \
 296
 297 #define FD_ERRORS \
 298         PARA_ERROR(F_GETFL, "failed to get fd flags"), \
 299         PARA_ERROR(F_SETFL, "failed to set fd flags"), \
 300
 301
 302 #define WRITE_ERRORS \
 303         PARA_ERROR(READ_HDR, "failed to read audio file header"), \
 304         PARA_ERROR(READ_STDIN, "failed to read from stdin"), \
 305         PARA_ERROR(WRITE_SYNTAX, "para_write syntax error"), \
 306         PARA_ERROR(WRITE_OVERRUN, "buffer overrun"), \
 307         PARA_ERROR(LIST_WRITERS_GIVEN, ""), \
 308         PARA_ERROR(PREMATURE_END, "premature end of audio file"), \
 309
 310
 311 #define ALSA_WRITER_ERRORS \
 312         PARA_ERROR(BROKEN_CONF, "Broken alsa configuration"), \
 313         PARA_ERROR(ACCESS_TYPE, "alsa access type not available"), \
 314         PARA_ERROR(SAMPLE_FORMAT, "sample format not available"), \
 315         PARA_ERROR(CHANNEL_COUNT, "channels count not available"), \
 316         PARA_ERROR(HW_PARAMS, "unable to install hw params"), \
 317         PARA_ERROR(SW_PARAMS, "unable to install sw params"), \
 318         PARA_ERROR(BAD_PERIOD, "can not use period equal to buffer size"), \
 319         PARA_ERROR(GET_XFER, "unable to obtain xfer align"), \
 320         PARA_ERROR(SET_XFER, "snd_pcm_sw_params_set_xfer_align() failed"), \
 321         PARA_ERROR(ALSA_WRITE, "alsa write error"), \
 322         PARA_ERROR(PCM_OPEN, "unable to open pcm"), \
 323         PARA_ERROR(SND_PCM_INFO, "pcm info error"), \
 324         PARA_ERROR(GET_BUFFER_TIME, "snd_pcm_hw_params_get_buffer_time_max() failed"), \
 325         PARA_ERROR(SET_BUFFER_TIME, "snd_pcm_hw_params_set_buffer_time_near() failed"), \
 326         PARA_ERROR(SET_RATE, "snd_pcm_hw_params_set_rate_near failed"), \
 327         PARA_ERROR(START_THRESHOLD, "snd_pcm_sw_params_set_start_threshold() failed"), \
 328         PARA_ERROR(STOP_THRESHOLD, "snd_pcm_sw_params_set_stop_threshold() failed"), \
 329         PARA_ERROR(ALSA_LOG, "snd_output_stdio_attach() failed"), \
 330
 331
 332 #define FILE_WRITER_ERRORS \
 333         PARA_ERROR(FW_WRITE, "file writer write error"), \
 334         PARA_ERROR(FW_OPEN, "file writer: can not open output file"), \
 335
 336 #define WRITE_COMMON_ERRORS \
 337         PARA_ERROR(WRITE_COMMON_SYNTAX, "syntax error in write option"), \
 338
 339
 340 /* these do not need error handling (yet) */
 341 #define SERVER_ERRORS
 342 #define WAV_ERRORS
 343 #define COMPRESS_ERRORS
 344 #define TIME_ERRORS
 345 #define CLOSE_ON_FORK_ERRORS
 346 #define DAEMON_ERRORS
 347 #define ORTP_SEND_ERRORS
 348 #define GUI_ERRORS
 349 #define RINGBUFFER_ERRORS
 350
 351
 352 /**
 353  * the subsystem shift
 354  *
 355  * 255 error codes ought to be enough for every subsystem. Use the higher bits
 356  * of the return value to encode the subsystem number
 357  */
 358 #define SS_SHIFT 8
 359
 360 /**
 361  * compute the subsystem offset
 362  *
 363  * It is given by x * 2**8 where \a x is the subsystem number
 364  */
 365 #define SS_OFFSET(ss) (SS_ ## ss << SS_SHIFT)
 366
 367 /**
 368  * make the enum of all errors of one subsystem
 369  *
 370  * As zero should not be an error, we define a dummy enum entry with value
 371  * 2**ss. That lets the real errors start at 2**ss + 1.
 372  */
 373 #define SS_ENUM(ss) enum {\
 374         E_ ## ss ## _DUMMY = SS_OFFSET(ss), \
 375         ss ## _ERRORS}
 376
 377 /**
 378  * determine the subsystem number from the error number
 379  *
 380  * Easy, it's just \a num / 2**8.
 381  */
 382 #define ERRNUM_TO_SS(num) ((num) >> SS_SHIFT)
 383
 384 /**
 385  * determine the index of an error number
 386  *
 387  * Also easy: It's the lower 8 bits of num - 1.
 388  */
 389 #define ERRNUM_TO_INDEX(num) (((1 << SS_SHIFT) - 1) & ((num) - 1))
 390
 391 /**
 392  * paraslash's version of strerror(3)
 393  *
 394  * expands to the error text of \a num (a string constant).
 395  */
 396 #define PARA_STRERROR(num) para_errlist[ERRNUM_TO_SS(num)] [ERRNUM_TO_INDEX(num)]
 397
 398 /**
 399  * define the error list for one subsystem
 400  *
 401  * Used by macros in config.h (generated by configure)
 402  */
 403 #define DEFINE_ERRLIST(ss) const char * ss ## _ERRLIST[] = {ss ## _ERRORS}
 404
 405 /**
 406  * activate errors for one subsystem.
 407  *
 408  * Each executable needs only the error lists of those subssystems it is actually
 409  * linked with. We always reserve zeroed-out space for NUM_SS char ** pointers, but
 410  * only init those of the needed subsystems. This macro is used by macros in config.h
 411  * (generated by configure).
 412  */
 413 #define PARA_ERRLIST(ss) [SS_ ## ss] = ss ## _ERRLIST
 414
 415 /**
 416  * This is temporarily defined to expand to its second argument (prefixed by
 417  * 'E_') and gets later redefined to expand to the error text only
 418  */
 419 #define PARA_ERROR(err, msg) E_ ## err
 420
 421 /** \cond popcorn time */
 422 SS_ENUM(ORTP_RECV);
 423 SS_ENUM(NET);
 424 SS_ENUM(RECV);
 425 SS_ENUM(AUDIOD);
 426 SS_ENUM(EXEC);
 427 SS_ENUM(CLOSE_ON_FORK);
 428 SS_ENUM(SIGNAL);
 429 SS_ENUM(STRING);
 430 SS_ENUM(DAEMON);
 431 SS_ENUM(STAT);
 432 SS_ENUM(TIME);
 433 SS_ENUM(GRAB_CLIENT);
 434 SS_ENUM(HTTP_RECV);
 435 SS_ENUM(RECV_COMMON);
 436 SS_ENUM(FILTER_CHAIN);
 437 SS_ENUM(WAV);
 438 SS_ENUM(COMPRESS);
 439 SS_ENUM(OGGDEC);
 440 SS_ENUM(MP3DEC);
 441 SS_ENUM(FILTER);
 442 SS_ENUM(MP3);
 443 SS_ENUM(OGG);
 444 SS_ENUM(SERVER);
 445 SS_ENUM(AFS);
 446 SS_ENUM(COMMAND);
 447 SS_ENUM(RANDOM_SELECTOR);
 448 SS_ENUM(PLAYLIST_SELECTOR);
 449 SS_ENUM(CRYPT);
 450 SS_ENUM(HTTP_SEND);
 451 SS_ENUM(ORTP_SEND);
 452 SS_ENUM(DB);
 453 SS_ENUM(MYSQL_SELECTOR);
 454 SS_ENUM(IPC);
 455 SS_ENUM(DCCP);
 456 SS_ENUM(DCCP_RECV);
 457 SS_ENUM(DCCP_SEND);
 458 SS_ENUM(FD);
 459 SS_ENUM(GUI);
 460 SS_ENUM(WRITE);
 461 SS_ENUM(WRITE_COMMON);
 462 SS_ENUM(ALSA_WRITER);
 463 SS_ENUM(FILE_WRITER);
 464 SS_ENUM(RINGBUFFER);
 465 /** \endcond */
 466 #undef PARA_ERROR
 467 /* rest of the world only sees the error text */
 468 #define PARA_ERROR(err, msg) msg