error.h

   1 /*
   2  * Copyright (C) 2006-2007 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 error facility */
  22 enum para_subsystem {
  23         SS_CLIENT,
  24         SS_GUI,
  25         SS_TIME,
  26         SS_WAV,
  27         SS_COMPRESS,
  28         SS_CLOSE_ON_FORK,
  29         SS_DAEMON,
  30         SS_DCCP_SEND,
  31         SS_RINGBUFFER,
  32         SS_RECV,
  33         SS_NET,
  34         SS_ORTP_RECV,
  35         SS_CLIENT_COMMON,
  36         SS_AUDIOC,
  37         SS_SCHED,
  38         SS_AUDIOD,
  39         SS_AUDIOD_COMMAND,
  40         SS_EXEC,
  41         SS_STDIN,
  42         SS_STDOUT,
  43         SS_SIGNAL,
  44         SS_STRING,
  45         SS_STAT,
  46         SS_GRAB_CLIENT,
  47         SS_HTTP_RECV,
  48         SS_RECV_COMMON,
  49         SS_FILTER_CHAIN,
  50         SS_OGGDEC,
  51         SS_FILTER,
  52         SS_COMMAND,
  53         SS_RANDOM_SELECTOR,
  54         SS_PLAYLIST_SELECTOR,
  55         SS_CRYPT,
  56         SS_HTTP_SEND,
  57         SS_ORTP_SEND,
  58         SS_DB,
  59         SS_OGG_AFH,
  60         SS_MP3_AFH,
  61         SS_AAC_AFH,
  62         SS_MP3DEC,
  63         SS_AACDEC,
  64         SS_AAC_COMMON,
  65         SS_SERVER,
  66         SS_VSS,
  67         SS_MYSQL_SELECTOR,
  68         SS_IPC,
  69         SS_DCCP,
  70         SS_DCCP_RECV,
  71         SS_FD,
  72         SS_WRITE,
  73         SS_WRITE_COMMON,
  74         SS_ALSA_WRITE,
  75         SS_FILE_WRITE,
  76         SS_OSX_WRITE,
  77         SS_USER_LIST,
  78         NUM_SS
  79 };
  80
  81 /* these do not need error handling (yet) */
  82 #define SERVER_ERRORS
  83 #define CLIENT_ERRORS
  84 #define WAV_ERRORS
  85 #define COMPRESS_ERRORS
  86 #define TIME_ERRORS
  87 #define CLOSE_ON_FORK_ERRORS
  88 #define DAEMON_ERRORS
  89 #define ORTP_SEND_ERRORS
  90 #define GUI_ERRORS
  91 #define RINGBUFFER_ERRORS
  92
  93
  94
  95 extern const char **para_errlist[];
  96 /** \endcond */
  97
  98 #define USER_LIST_ERRORS \
  99         PARA_ERROR(USERLIST, "failed to open user list file"), \
 100         PARA_ERROR(BAD_USER, "you don't exist. Go away."), \
 101
 102
 103 #define OSX_WRITE_ERRORS \
 104         PARA_ERROR(STREAM_FORMAT, "could not set stream format"), \
 105         PARA_ERROR(ADD_CALLBACK, "can not add callback"), \
 106         PARA_ERROR(READ_STDIN, "failed to read from stdin"), \
 107         PARA_ERROR(OPEN_COMP, "OpenAComponent() error"), \
 108         PARA_ERROR(UNIT_INIT, "AudioUnitInitialize() error"), \
 109         PARA_ERROR(UNIT_START, "AudioUnitStart() error"), \
 110         PARA_ERROR(DEFAULT_COMP, "can not find default audio output component"), \
 111
 112
 113 #define AUDIOC_ERRORS \
 114         PARA_ERROR(AUDIOC_SYNTAX, "audioc syntax error"), \
 115         PARA_ERROR(AUDIOC_READ, "audioc read error"), \
 116         PARA_ERROR(AUDIOC_WRITE, "audioc write error"), \
 117         PARA_ERROR(INIT_SOCK_ADDR, "can not init socket"), \
 118         PARA_ERROR(AUDIOC_CONNECT, "audioc connect error"), \
 119         PARA_ERROR(AUDIOC_OVERRUN, "audioc buffer overrun"), \
 120
 121
 122
 123
 124 #define CLIENT_COMMON_ERRORS \
 125         PARA_ERROR(CLIENT_SYNTAX, "syntax error"), \
 126         PARA_ERROR(INVALID_CHALLENGE, "did not receive valid challenge"), \
 127         PARA_ERROR(NO_CONFIG, "config file not found"), \
 128         PARA_ERROR(CLIENT_AUTH, "authentication failed"), \
 129         PARA_ERROR(SERVER_EOF, "connection closed by para_server"), \
 130         PARA_ERROR(INPUT_EOF, "end of input"), \
 131         PARA_ERROR(HANDSHAKE_COMPLETE, ""), /* not really an error */ \
 132
 133
 134 #define SCHED_ERRORS \
 135         PARA_ERROR(TASK_KILLED, "task killed"), \
 136         PARA_ERROR(NO_SUCH_TASK, "task not found"), \
 137         PARA_ERROR(NOT_INITIALIZED, "scheduler not yet initialized"), \
 138
 139
 140 #define STDIN_ERRORS \
 141         PARA_ERROR(STDIN_READ, "failed to read from stdin"), \
 142         PARA_ERROR(STDIN_EOF, "end of file"), \
 143
 144
 145 #define STDOUT_ERRORS \
 146         PARA_ERROR(STDOUT_WRITE, "failed to write to stdout"), \
 147         PARA_ERROR(STDOUT_EOF, "end of file"), \
 148
 149
 150 #define NET_ERRORS \
 151         PARA_ERROR(SEND, "send error"), \
 152         PARA_ERROR(RECV, "receive error"), \
 153         PARA_ERROR(SOCKET, "socket error"), \
 154         PARA_ERROR(CONNECT, "connect error"), \
 155         PARA_ERROR(ACCEPT, "accept error"), \
 156         PARA_ERROR(SETSOCKOPT, "failed to set socket options"), \
 157         PARA_ERROR(BIND, "bind error"), \
 158         PARA_ERROR(NAME_TOO_LONG, "name too long for struct sockaddr_un"), \
 159         PARA_ERROR(CHMOD, "failed to set socket mode"), \
 160         PARA_ERROR(SENDMSG, "sendmsg() failed"), \
 161         PARA_ERROR(RECVMSG, "recvmsg() failed"), \
 162         PARA_ERROR(SCM_CREDENTIALS, "did not receive SCM credentials"), \
 163         PARA_ERROR(LISTEN, "listen error"), \
 164         PARA_ERROR(RECV_PATTERN, "did not receive expected pattern"), \
 165         PARA_ERROR(HOST_INFO, "gethostbyname() failed"), \
 166
 167
 168 #define ORTP_RECV_ERRORS \
 169         PARA_ERROR(MSG_TO_BUF, "failed to extract rtp packet"), \
 170         PARA_ERROR(ORTP_SYNTAX, "ottp syntax error"), \
 171         PARA_ERROR(TOO_MANY_BAD_CHUNKS, "too many consecutive bad chunks"), \
 172         PARA_ERROR(INVALID_HEADER, "invalid header packet"), \
 173         PARA_ERROR(OVERRUN, "outout buffer overrun"), \
 174         PARA_ERROR(ORTP_RECV_EOF, "ortp_recv: end of file"), \
 175
 176
 177 #define HTTP_RECV_ERRORS \
 178         PARA_ERROR(SEND_HTTP_REQUEST, "failed to send http request"), \
 179         PARA_ERROR(MISSING_OK, "did not receive OK message from peer"), \
 180         PARA_ERROR(HTTP_RECV_BUF, "did not receive buffer"), \
 181         PARA_ERROR(HTTP_RECV_EOF, "http_recv: end of file"), \
 182
 183
 184 #define RECV_ERRORS \
 185         PARA_ERROR(RECV_SELECT, "recv select error"), \
 186         PARA_ERROR(WRITE_STDOUT, "stdout write error"), \
 187
 188
 189 #define RECV_COMMON_ERRORS \
 190         PARA_ERROR(RECV_SYNTAX, "recv syntax error"), \
 191
 192
 193 #define AUDIOD_ERRORS \
 194         PARA_ERROR(WRITE_AUDIO_DATA, "failed to write audio data"), \
 195         PARA_ERROR(NO_MORE_SLOTS, "no more empty slots"), \
 196         PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
 197         PARA_ERROR(UNSUPPORTED_AUDIO_FORMAT, "given audio format not supported"), \
 198         PARA_ERROR(STATUS_EOF, "server closed status connection"), \
 199
 200
 201 #define AUDIOD_COMMAND_ERRORS \
 202         PARA_ERROR(CLIENT_WRITE, "client write error"), \
 203         PARA_ERROR(AUDIOD_SYNTAX, "syntax error"), \
 204         PARA_ERROR(UCRED_PERM, "permission denied"), \
 205         PARA_ERROR(INVALID_AUDIOD_CMD, "invalid command"), \
 206
 207
 208 #define FILTER_CHAIN_ERRORS \
 209         PARA_ERROR(UNSUPPORTED_FILTER, "given filter not supported"), \
 210         PARA_ERROR(BAD_FILTER_OPTIONS, "invalid filter option given"), \
 211         PARA_ERROR(FC_EOF, "filter chain: eof"), \
 212
 213
 214 #define STAT_ERRORS \
 215         PARA_ERROR(TOO_MANY_CLIENTS, "maximal number of stat clients exceeded"), \
 216         PARA_ERROR(UNKNOWN_STAT_ITEM, "status item not recognized"), \
 217
 218
 219 #define OGGDEC_ERRORS \
 220         PARA_ERROR(OGGDEC_READ, "read from media returned an error"), \
 221         PARA_ERROR(OGGDEC_NOTVORBIS, "bitstream is not vorbis data"), \
 222         PARA_ERROR(OGGDEC_VERSION, "vorbis version mismatch"), \
 223         PARA_ERROR(OGGDEC_BADHEADER, "invalid vorbis bitstream header"), \
 224         PARA_ERROR(OGGDEC_FAULT, "bug or heap/stack corruption"), \
 225         PARA_ERROR(OGGDEC_BADLINK, "invalid stream section or requested link corrupt"), \
 226
 227
 228 #define GRAB_CLIENT_ERRORS \
 229         PARA_ERROR(PEDANTIC_GRAB, "fd not ready and pedantic grab requested"), \
 230         PARA_ERROR(GC_WRITE, "grab client write error"), \
 231         PARA_ERROR(BAD_GC_SLOT, "invalid slot requested by grab client"), \
 232         PARA_ERROR(BAD_GC_FILTER_NUM, "invalid filter number given"), \
 233         PARA_ERROR(GC_SYNTAX, "grab client syntax error"), \
 234         PARA_ERROR(GC_HELP_GIVEN, ""), /* not really an error */ \
 235         PARA_ERROR(GC_VERSION_GIVEN, ""), /* not really an error */ \
 236
 237
 238 #define MP3DEC_ERRORS \
 239         PARA_ERROR(MAD_FRAME_DECODE, "mad frame decode error"), \
 240         PARA_ERROR(MP3DEC_OVERRUN, "mp3 output buffer overrun"), \
 241
 242
 243 #define FILTER_ERRORS \
 244         PARA_ERROR(NO_FILTERS, "at least one filter must be given"), \
 245         PARA_ERROR(FILTER_SYNTAX, "syntax error"), \
 246
 247
 248 #define SIGNAL_ERRORS \
 249         PARA_ERROR(SIGNAL_SIG_ERR, "signal() retured SIG_ERR"), \
 250         PARA_ERROR(SIGNAL_READ, "read error from signal pipe"), \
 251         PARA_ERROR(WAITPID, "waitpid error"), \
 252         PARA_ERROR(SIGNAL_PIPE, "failed to setup signal pipe"), \
 253         PARA_ERROR(SIGNAL_CAUGHT, "caught signal"), \
 254
 255
 256 #define STRING_ERRORS \
 257         PARA_ERROR(MKSTEMP, "mkstemp error: unable to create tmp file"), \
 258         PARA_ERROR(FCHMOD, "fchmod error: can not set mode"), \
 259
 260
 261 #define EXEC_ERRORS \
 262         PARA_ERROR(DUP_PIPE, "exec error: can not create pipe"), \
 263         PARA_ERROR(NULL_OPEN, "can not open /dev/null"), \
 264
 265
 266 #define MP3_AFH_ERRORS \
 267         PARA_ERROR(FREAD, "fread error"), \
 268         PARA_ERROR(FSEEK, "fseek error"), \
 269         PARA_ERROR(FRAME, "invalid mp3 frame"), \
 270         PARA_ERROR(FRAME_LENGTH, "invalid frame length"), \
 271         PARA_ERROR(MP3_NO_FILE, "invalid mp3 file pointer"), \
 272         PARA_ERROR(MP3_INFO, "could not read mp3 info"), \
 273         PARA_ERROR(MP3_REPOS, "mp3 repositioning error"), \
 274         PARA_ERROR(HEADER_FREQ, "invalid header frequency"), \
 275         PARA_ERROR(HEADER_BITRATE, "invalid header bitrate"), \
 276
 277
 278 #define AAC_AFH_ERRORS \
 279         PARA_ERROR(AAC_REPOS, "aac repositioning error"), \
 280         PARA_ERROR(AAC_READ, "aac read error"), \
 281         PARA_ERROR(STSZ, "did not find stcz atom"), \
 282         PARA_ERROR(MP4ASC, "audio spec config error"), \
 283         PARA_ERROR(AAC_OVERRUN, "aac output buffer overrun"), \
 284
 285
 286 #define AAC_COMMON_ERRORS \
 287         PARA_ERROR(ESDS, "did not find esds atom"), \
 288         PARA_ERROR(STCO, "did not find stco atom"), \
 289
 290
 291 #define OGG_AFH_ERRORS \
 292         PARA_ERROR(OGG_READ, "ogg read error"), \
 293         PARA_ERROR(SYNC_PAGEOUT, "ogg sync page-out error (no ogg file?)"), \
 294         PARA_ERROR(STREAM_PAGEIN, "ogg stream page-in error (first page)"), \
 295         PARA_ERROR(STREAM_PACKETOUT, "ogg stream packet-out error (first packet)"), \
 296         PARA_ERROR(VORBIS, "vorbis synthesis header-in error (not vorbis?)"), \
 297         PARA_ERROR(OGG_NO_FILE, "invalid ogg file pointer"), \
 298         PARA_ERROR(OGG_OPEN, "ov_open error"), \
 299         PARA_ERROR(OGG_INFO, "ov_info error"), \
 300         PARA_ERROR(OGG_REPOS, "ogg repositioning error"), \
 301
 302
 303 #define VSS_ERRORS \
 304         PARA_ERROR(AUDIO_FORMAT, "audio format not recognized"), \
 305         PARA_ERROR(FSTAT, "failed to fstat() audio file"), \
 306
 307
 308 #define DB_ERRORS \
 309         PARA_ERROR(GETCWD, "can not get current working directory"), \
 310         PARA_ERROR(CHDIR, "can not change directory"), \
 311         PARA_ERROR(OPENDIR, "can not open directory"), \
 312         PARA_ERROR(LSTAT, "lstat error"), \
 313
 314
 315 #define CRYPT_ERRORS \
 316         PARA_ERROR(PRIVATE_KEY, "can not read private key"), \
 317         PARA_ERROR(PUBLIC_KEY, "can not read public key"), \
 318         PARA_ERROR(RSA, "RSA error"), \
 319         PARA_ERROR(ENCRYPT, "encrypt error"), \
 320         PARA_ERROR(DECRYPT, "decrypt error"), \
 321         PARA_ERROR(CHALLENGE, "failed to read challenge"), \
 322
 323
 324 #define HTTP_SEND_ERRORS \
 325         PARA_ERROR(QUEUE, "packet queue overrun"), \
 326         PARA_ERROR(WRITE_OK, "can not check whether fd is writable"), \
 327
 328
 329 #define RANDOM_SELECTOR_ERRORS \
 330         PARA_ERROR(NOTHING_FOUND, "no audio files found"), \
 331
 332
 333 #define MYSQL_SELECTOR_ERRORS \
 334         PARA_ERROR(MYSQL_SYNTAX, "mysql syntax error"), \
 335         PARA_ERROR(NOTCONN, "not connected to mysql server"), \
 336         PARA_ERROR(TOOBIG, "mysql: file too large"), \
 337         PARA_ERROR(NAMETOOLONG, "mysql: name too long"), \
 338         PARA_ERROR(QFAILED, "mysql query failed"), \
 339         PARA_ERROR(NOROW, "row is NULL"), \
 340         PARA_ERROR(NOATTS, "can not get attributes from mysql table"), \
 341         PARA_ERROR(NORESULT, "error while fetching mysql result"), \
 342         PARA_ERROR(EMPTY_RESULT, "result is empty"), \
 343         PARA_ERROR(ESCAPE, "can not escape string"), \
 344         PARA_ERROR(GET_AUDIO_FILE, "can not get current audio file"), \
 345         PARA_ERROR(GET_STREAM, "can not get current stream"), \
 346         PARA_ERROR(NO_STREAM, "no such stream"), \
 347         PARA_ERROR(AUDIO_FILE, "no such audio file"), \
 348         PARA_ERROR(GET_QUERY, "can not get query for specified stream"), \
 349         PARA_ERROR(TMPFILE, "error while writing temporary file"), \
 350         PARA_ERROR(META, "can not get meta data"), \
 351         PARA_ERROR(MYSQL_INIT, "can not initialize mysql connection"), \
 352         PARA_ERROR(NO_MYSQL_PASSWD, "fatal: no mysql passord given"), \
 353         PARA_ERROR(NO_AF_DIR, "fatal: audio file directory not given"), \
 354
 355
 356 #define COMMAND_ERRORS \
 357         PARA_ERROR(COMMAND_SYNTAX, "syntax error in command"), \
 358         PARA_ERROR(AUTH, "did not receive auth request"), \
 359         PARA_ERROR(BAD_SELECTOR, "no such audio file selector"), \
 360         PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
 361         PARA_ERROR(BAD_CMD, "invalid command"), \
 362         PARA_ERROR(PERM, "permission denied"), \
 363         PARA_ERROR(LOCK, "lock error"), \
 364         PARA_ERROR(SENDER_CMD, "command not supported by this sender"), \
 365         PARA_ERROR(SERVER_CRASH, "para_server crashed -- can not live without it"), \
 366
 367
 368 #define PLAYLIST_SELECTOR_ERRORS \
 369         PARA_ERROR(LOAD_PLAYLIST, "failed to load playlist"), \
 370
 371
 372 #define IPC_ERRORS \
 373         PARA_ERROR(SEM_GET, "failed to create semaphore"), \
 374         PARA_ERROR(SEM_REMOVE, "can not remove semaphore"), \
 375         PARA_ERROR(SHM_GET, "failed to allocate shared memory area"), \
 376         PARA_ERROR(SHM_DESTROY, "failed to destroy shared memory area"), \
 377         PARA_ERROR(SHM_ATTACH, "can not attach shared memory area"), \
 378         PARA_ERROR(SHM_DETACH, "can not detach shared memory area"), \
 379
 380
 381 #define DCCP_ERRORS \
 382         PARA_ERROR(DCCP_SOCKET, "can not create dccp socket"), \
 383         PARA_ERROR(DCCP_PACKET_SIZE, "failed to set dccp packet size"), \
 384         PARA_ERROR(DCCP_SERVICE, "could not get service code"), \
 385         PARA_ERROR(DCCP_RECV_EOF, "dccp_recv: end of file"), \
 386
 387
 388 #define DCCP_RECV_ERRORS \
 389         PARA_ERROR(ADDR_INFO, "getaddrinfo error"), \
 390         PARA_ERROR(DCCP_OVERRUN, "dccp output buffer buffer overrun"), \
 391         PARA_ERROR(DCCP_CONNECT, "dccp connect error"), \
 392
 393
 394 #define DCCP_SEND_ERRORS \
 395         PARA_ERROR(DCCP_BIND, "dccp bind error"), \
 396         PARA_ERROR(DCCP_LISTEN, "dccp listen error"), \
 397         PARA_ERROR(DCCP_WRITE, "dccp write error"), \
 398
 399
 400 #define FD_ERRORS \
 401         PARA_ERROR(F_GETFL, "failed to get fd flags"), \
 402         PARA_ERROR(F_SETFL, "failed to set fd flags"), \
 403         PARA_ERROR(FGETS, "fgets error"), \
 404
 405
 406 #define WRITE_ERRORS \
 407         PARA_ERROR(WRITE_SYNTAX, "para_write syntax error"), \
 408         PARA_ERROR(PREMATURE_END, "premature end of audio file"), \
 409         PARA_ERROR(NO_WAV_HEADER, "wave header not found"), \
 410         PARA_ERROR(WAV_HEADER_SUCCESS, "successfully read wave header"), \
 411         PARA_ERROR(NO_DELAY, "no initial delay"), \
 412         PARA_ERROR(DELAY_TIMEOUT, "initial delay timeout"), \
 413
 414
 415 #define ALSA_WRITE_ERRORS \
 416         PARA_ERROR(BROKEN_CONF, "Broken alsa configuration"), \
 417         PARA_ERROR(ACCESS_TYPE, "alsa access type not available"), \
 418         PARA_ERROR(SAMPLE_FORMAT, "sample format not available"), \
 419         PARA_ERROR(CHANNEL_COUNT, "channels count not available"), \
 420         PARA_ERROR(HW_PARAMS, "unable to install hw params"), \
 421         PARA_ERROR(SW_PARAMS, "unable to install sw params"), \
 422         PARA_ERROR(BAD_PERIOD, "can not use period equal to buffer size"), \
 423         PARA_ERROR(GET_XFER, "unable to obtain xfer align"), \
 424         PARA_ERROR(SET_XFER, "snd_pcm_sw_params_set_xfer_align() failed"), \
 425         PARA_ERROR(ALSA_WRITE, "alsa write error"), \
 426         PARA_ERROR(PCM_OPEN, "unable to open pcm"), \
 427         PARA_ERROR(SND_PCM_INFO, "pcm info error"), \
 428         PARA_ERROR(GET_BUFFER_TIME, "snd_pcm_hw_params_get_buffer_time_max() failed"), \
 429         PARA_ERROR(SET_BUFFER_TIME, "snd_pcm_hw_params_set_buffer_time_near() failed"), \
 430         PARA_ERROR(SET_RATE, "snd_pcm_hw_params_set_rate_near failed"), \
 431         PARA_ERROR(START_THRESHOLD, "snd_pcm_sw_params_set_start_threshold() failed"), \
 432         PARA_ERROR(STOP_THRESHOLD, "snd_pcm_sw_params_set_stop_threshold() failed"), \
 433
 434
 435 #define FILE_WRITE_ERRORS \
 436         PARA_ERROR(FW_WRITE, "file writer write error"), \
 437         PARA_ERROR(FW_OPEN, "file writer: can not open output file"), \
 438         PARA_ERROR(FW_NO_FILE, "task started without open file"), \
 439
 440
 441 #define WRITE_COMMON_ERRORS \
 442         PARA_ERROR(WRITE_COMMON_SYNTAX, "syntax error in write option"), \
 443         PARA_ERROR(WNG_EOF, "wng: end of file"), \
 444
 445
 446 #define AACDEC_ERRORS \
 447         PARA_ERROR(AACDEC_INIT, "failed to init aac decoder"), \
 448         PARA_ERROR(AAC_DECODE, "aac decode error"), \
 449
 450
 451 /**
 452  * the subsystem shift
 453  *
 454  * 255 error codes ought to be enough for every subsystem. Use the higher bits
 455  * of the return value to encode the subsystem number
 456  */
 457 #define SS_SHIFT 8
 458
 459 /**
 460  * compute the subsystem offset
 461  *
 462  * It is given by x * 2**8 where \a x is the subsystem number
 463  */
 464 #define SS_OFFSET(ss) (SS_ ## ss << SS_SHIFT)
 465
 466 /**
 467  * make the enum of all errors of one subsystem
 468  *
 469  * As zero should not be an error, we define a dummy enum entry with value
 470  * 2**ss. That lets the real errors start at 2**ss + 1.
 471  */
 472 #define SS_ENUM(ss) enum {\
 473         E_ ## ss ## _DUMMY = SS_OFFSET(ss), \
 474         ss ## _ERRORS}
 475
 476 /**
 477  * determine the subsystem number from the error number
 478  *
 479  * Easy, it's just \a num / 2**8.
 480  */
 481 #define ERRNUM_TO_SS(num) ((num) >> SS_SHIFT)
 482
 483 /**
 484  * determine the index of an error number
 485  *
 486  * Also easy: It's the lower 8 bits of num.
 487  */
 488 #define ERRNUM_TO_INDEX(num) (((1 << SS_SHIFT) - 1) & (num))
 489
 490 /**
 491  * paraslash's version of strerror(3)
 492  *
 493  * expands to the error text of \a num (a string constant).
 494  */
 495 #define PARA_STRERROR(num) para_errlist[ERRNUM_TO_SS(num)] [ERRNUM_TO_INDEX(num)]
 496
 497 /**
 498  * define the error list for one subsystem
 499  #
 500  * The first entry (index 0) is always the name of the subsystem
 501  * Used by macros in config.h (generated by configure)
 502  */
 503 #define DEFINE_ERRLIST(ss) const char * ss ## _ERRLIST[] = {#ss, ss ## _ERRORS}
 504
 505 /**
 506  * activate errors for one subsystem.
 507  *
 508  * Each executable needs only the error lists of those subssystems it is
 509  * actually linked with. We always reserve space for NUM_SS char ** pointers,
 510  * but only init those of the needed subsystems. This macro is used by macros
 511  * in config.h (generated by configure).
 512  */
 513 #define PARA_ERRLIST(ss) [SS_ ## ss] = ss ## _ERRLIST
 514
 515 /**
 516  * This is temporarily defined to expand to its first argument (prefixed by
 517  * 'E_') and gets later redefined to expand to the error text only
 518  */
 519 #define PARA_ERROR(err, msg) E_ ## err
 520
 521 #define SS_NAME(ss) para_errlist[ss]? para_errlist[ss][0] : ""
 522
 523 /** \cond popcorn time */
 524 SS_ENUM(GUI);
 525 SS_ENUM(SCHED);
 526 SS_ENUM(STDIN);
 527 SS_ENUM(STDOUT);
 528 SS_ENUM(WAV);
 529 SS_ENUM(COMPRESS);
 530 SS_ENUM(TIME);
 531 SS_ENUM(CLOSE_ON_FORK);
 532 SS_ENUM(ORTP_RECV);
 533 SS_ENUM(NET);
 534 SS_ENUM(RECV);
 535 SS_ENUM(AUDIOD);
 536 SS_ENUM(AUDIOD_COMMAND);
 537 SS_ENUM(EXEC);
 538 SS_ENUM(SIGNAL);
 539 SS_ENUM(STRING);
 540 SS_ENUM(DAEMON);
 541 SS_ENUM(STAT);
 542 SS_ENUM(GRAB_CLIENT);
 543 SS_ENUM(HTTP_RECV);
 544 SS_ENUM(RECV_COMMON);
 545 SS_ENUM(FILTER_CHAIN);
 546 SS_ENUM(OGGDEC);
 547 SS_ENUM(MP3DEC);
 548 SS_ENUM(AACDEC);
 549 SS_ENUM(FILTER);
 550 SS_ENUM(MP3_AFH);
 551 SS_ENUM(OGG_AFH);
 552 SS_ENUM(AAC_AFH);
 553 SS_ENUM(AAC_COMMON);
 554 SS_ENUM(SERVER);
 555 SS_ENUM(VSS);
 556 SS_ENUM(COMMAND);
 557 SS_ENUM(RANDOM_SELECTOR);
 558 SS_ENUM(PLAYLIST_SELECTOR);
 559 SS_ENUM(CRYPT);
 560 SS_ENUM(HTTP_SEND);
 561 SS_ENUM(ORTP_SEND);
 562 SS_ENUM(DB);
 563 SS_ENUM(MYSQL_SELECTOR);
 564 SS_ENUM(IPC);
 565 SS_ENUM(DCCP);
 566 SS_ENUM(DCCP_RECV);
 567 SS_ENUM(DCCP_SEND);
 568 SS_ENUM(FD);
 569 SS_ENUM(WRITE);
 570 SS_ENUM(WRITE_COMMON);
 571 SS_ENUM(ALSA_WRITE);
 572 SS_ENUM(FILE_WRITE);
 573 SS_ENUM(OSX_WRITE);
 574 SS_ENUM(RINGBUFFER);
 575 SS_ENUM(CLIENT);
 576 SS_ENUM(CLIENT_COMMON);
 577 SS_ENUM(AUDIOC);
 578 SS_ENUM(USER_LIST);
 579 /** \endcond */
 580 #undef PARA_ERROR
 581 /* rest of the world only sees the error text */
 582 #define PARA_ERROR(err, msg) msg