net.c: Improve documentation of struct crypt_data.
[paraslash.git] / error.h
diff --git a/error.h b/error.h
index 84f4279..c0888aa 100644 (file)
--- a/error.h
+++ b/error.h
@@ -1,25 +1,14 @@
 /*
- * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2007 Andre Noll <maan@systemlinux.org>
  *
- *     This program is free software; you can redistribute it and/or modify
- *     it under the terms of the GNU General Public License as published by
- *     the Free Software Foundation; either version 2 of the License, or
- *     (at your option) any later version.
- *
- *     This program is distributed in the hope that it will be useful,
- *     but WITHOUT ANY WARRANTY; without even the implied warranty of
- *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *     GNU General Public License for more details.
- *
- *     You should have received a copy of the GNU General Public License
- *     along with this program; if not, write to the Free Software
- *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
 /** \file error.h list of error messages for all subsystems */
 
 /** \cond list of all subsystems that support the shiny error facility */
 enum para_subsystem {
+       SS_CLIENT,
        SS_GUI,
        SS_TIME,
        SS_WAV,
@@ -31,10 +20,14 @@ enum para_subsystem {
        SS_RECV,
        SS_NET,
        SS_ORTP_RECV,
+       SS_CLIENT_COMMON,
+       SS_AUDIOC,
+       SS_SCHED,
        SS_AUDIOD,
+       SS_AUDIOD_COMMAND,
        SS_EXEC,
-       SS_SCHED,
        SS_STDIN,
+       SS_STDOUT,
        SS_SIGNAL,
        SS_STRING,
        SS_STAT,
@@ -50,7 +43,7 @@ enum para_subsystem {
        SS_CRYPT,
        SS_HTTP_SEND,
        SS_ORTP_SEND,
-       SS_DB,
+       SS_AFS,
        SS_OGG_AFH,
        SS_MP3_AFH,
        SS_AAC_AFH,
@@ -58,7 +51,7 @@ enum para_subsystem {
        SS_AACDEC,
        SS_AAC_COMMON,
        SS_SERVER,
-       SS_AFS,
+       SS_VSS,
        SS_MYSQL_SELECTOR,
        SS_IPC,
        SS_DCCP,
@@ -66,13 +59,17 @@ enum para_subsystem {
        SS_FD,
        SS_WRITE,
        SS_WRITE_COMMON,
-       SS_ALSA_WRITER,
-       SS_FILE_WRITER,
+       SS_ALSA_WRITE,
+       SS_FILE_WRITE,
+       SS_OSX_WRITE,
+       SS_USER_LIST,
+       SS_CHUNK_QUEUE,
        NUM_SS
 };
 
 /* these do not need error handling (yet) */
 #define SERVER_ERRORS
+#define CLIENT_ERRORS
 #define WAV_ERRORS
 #define COMPRESS_ERRORS
 #define TIME_ERRORS
@@ -83,18 +80,57 @@ enum para_subsystem {
 #define RINGBUFFER_ERRORS
 
 
+
 extern const char **para_errlist[];
 /** \endcond */
 
-#define STDIN_ERRORS \
-       PARA_ERROR(STDIN_READ, "failed to read from stdin"), \
+#define USER_LIST_ERRORS \
+       PARA_ERROR(USERLIST, "failed to open user list file"), \
+
+
+#define OSX_WRITE_ERRORS \
+       PARA_ERROR(STREAM_FORMAT, "could not set stream format"), \
+       PARA_ERROR(ADD_CALLBACK, "can not add callback"), \
+       PARA_ERROR(OPEN_COMP, "OpenAComponent() error"), \
+       PARA_ERROR(UNIT_INIT, "AudioUnitInitialize() error"), \
+       PARA_ERROR(UNIT_START, "AudioUnitStart() error"), \
+       PARA_ERROR(DEFAULT_COMP, "can not find default audio output component"), \
+
+
+#define AUDIOC_ERRORS \
+       PARA_ERROR(AUDIOC_SYNTAX, "audioc syntax error"), \
+       PARA_ERROR(AUDIOC_READ, "audioc read error"), \
+       PARA_ERROR(AUDIOC_WRITE, "audioc write error"), \
+       PARA_ERROR(INIT_SOCK_ADDR, "can not init socket"), \
+       PARA_ERROR(AUDIOC_CONNECT, "audioc connect error"), \
+       PARA_ERROR(AUDIOC_OVERRUN, "audioc buffer overrun"), \
+
+
+
+#define CLIENT_COMMON_ERRORS \
+       PARA_ERROR(CLIENT_SYNTAX, "syntax error"), \
+       PARA_ERROR(INVALID_CHALLENGE, "did not receive valid challenge"), \
+       PARA_ERROR(NO_CONFIG, "config file not found"), \
+       PARA_ERROR(CLIENT_AUTH, "authentication failed"), \
+       PARA_ERROR(SERVER_EOF, "connection closed by para_server"), \
+       PARA_ERROR(INPUT_EOF, "end of input"), \
+       PARA_ERROR(HANDSHAKE_COMPLETE, ""), /* not really an error */ \
 
 
 #define SCHED_ERRORS \
-       PARA_ERROR(PRE_EOF, "pre_select returned zero"), \
-       PARA_ERROR(POST_EOF, "post_select returned zero"), \
+       PARA_ERROR(TASK_KILLED, "task killed"), \
+       PARA_ERROR(NO_SUCH_TASK, "task not found"), \
+       PARA_ERROR(NOT_INITIALIZED, "scheduler not yet initialized"), \
+
+
+#define STDIN_ERRORS \
+       PARA_ERROR(STDIN_READ, "failed to read from stdin"), \
+       PARA_ERROR(STDIN_EOF, "end of file"), \
 
 
+#define STDOUT_ERRORS \
+       PARA_ERROR(STDOUT_WRITE, "failed to write to stdout"), \
+       PARA_ERROR(STDOUT_EOF, "end of file"), \
 
 
 #define NET_ERRORS \
@@ -121,29 +157,31 @@ extern const char **para_errlist[];
        PARA_ERROR(TOO_MANY_BAD_CHUNKS, "too many consecutive bad chunks"), \
        PARA_ERROR(INVALID_HEADER, "invalid header packet"), \
        PARA_ERROR(OVERRUN, "outout buffer overrun"), \
+       PARA_ERROR(ORTP_RECV_EOF, "ortp_recv: end of file"), \
 
 
 #define HTTP_RECV_ERRORS \
-       PARA_ERROR(SEND_HTTP_REQUEST, "failed to send http request"), \
-       PARA_ERROR(MISSING_OK, "did not receive OK message from peer"), \
-       PARA_ERROR(HTTP_RECV_BUF, "did not receive buffer")
+       PARA_ERROR(HTTP_RECV_EOF, "http_recv: end of file"), \
+       PARA_ERROR(HTTP_RECV_OVERRUN, "http_recv: outout buffer overrun"), \
 
 
 #define RECV_ERRORS \
-       PARA_ERROR(RECV_SELECT, "recv select error"), \
-       PARA_ERROR(WRITE_STDOUT, "stdout write error"), \
+       PARA_ERROR(RECV_SYNTAX, "recv syntax error"), \
 
 
 #define RECV_COMMON_ERRORS \
-       PARA_ERROR(RECV_SYNTAX, "recv syntax error"), \
 
 
 #define AUDIOD_ERRORS \
-       PARA_ERROR(WRITE_AUDIO_DATA, "failed to write audio data"), \
        PARA_ERROR(NO_MORE_SLOTS, "no more empty slots"), \
        PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
        PARA_ERROR(UNSUPPORTED_AUDIO_FORMAT, "given audio format not supported"), \
+       PARA_ERROR(SIGNAL_CAUGHT, "caught signal"), \
+
+
+#define AUDIOD_COMMAND_ERRORS \
        PARA_ERROR(CLIENT_WRITE, "client write error"), \
+       PARA_ERROR(AUDIOD_SYNTAX, "syntax error"), \
        PARA_ERROR(UCRED_PERM, "permission denied"), \
        PARA_ERROR(INVALID_AUDIOD_CMD, "invalid command"), \
 
@@ -151,6 +189,7 @@ extern const char **para_errlist[];
 #define FILTER_CHAIN_ERRORS \
        PARA_ERROR(UNSUPPORTED_FILTER, "given filter not supported"), \
        PARA_ERROR(BAD_FILTER_OPTIONS, "invalid filter option given"), \
+       PARA_ERROR(FC_EOF, "filter chain: eof"), \
 
 
 #define STAT_ERRORS \
@@ -205,26 +244,20 @@ extern const char **para_errlist[];
 
 
 #define MP3_AFH_ERRORS \
-       PARA_ERROR(FREAD, "fread error"), \
-       PARA_ERROR(FSEEK, "fseek error"), \
        PARA_ERROR(FRAME, "invalid mp3 frame"), \
        PARA_ERROR(FRAME_LENGTH, "invalid frame length"), \
-       PARA_ERROR(MP3_NO_FILE, "invalid mp3 file pointer"), \
        PARA_ERROR(MP3_INFO, "could not read mp3 info"), \
-       PARA_ERROR(MP3_REPOS, "mp3 repositioning error"), \
        PARA_ERROR(HEADER_FREQ, "invalid header frequency"), \
        PARA_ERROR(HEADER_BITRATE, "invalid header bitrate"), \
 
 
 #define AAC_AFH_ERRORS \
-       PARA_ERROR(AAC_REPOS, "aac repositioning error"), \
-       PARA_ERROR(AAC_READ, "aac read error"), \
        PARA_ERROR(STSZ, "did not find stcz atom"), \
        PARA_ERROR(MP4ASC, "audio spec config error"), \
+       PARA_ERROR(AAC_AFH_INIT, "failed to init aac decoder"), \
 
 
 #define AAC_COMMON_ERRORS \
-       PARA_ERROR(AAC_BUF, "invalid buffer"), \
        PARA_ERROR(ESDS, "did not find esds atom"), \
        PARA_ERROR(STCO, "did not find stco atom"), \
 
@@ -235,18 +268,18 @@ extern const char **para_errlist[];
        PARA_ERROR(STREAM_PAGEIN, "ogg stream page-in error (first page)"), \
        PARA_ERROR(STREAM_PACKETOUT, "ogg stream packet-out error (first packet)"), \
        PARA_ERROR(VORBIS, "vorbis synthesis header-in error (not vorbis?)"), \
-       PARA_ERROR(OGG_NO_FILE, "invalid ogg file pointer"), \
-       PARA_ERROR(OGG_OPEN, "ov_open error"), \
        PARA_ERROR(OGG_INFO, "ov_info error"), \
-       PARA_ERROR(OGG_REPOS, "ogg repositioning error"), \
+       PARA_ERROR(OGG_VERSION, "unsupported ogg version"), \
+       PARA_ERROR(OGG_BAD_HEADER, "invalid ogg vorbis header"), \
+       PARA_ERROR(OGG_UNKNOWN_ERROR, "unknown ogg vorbis error"), \
 
 
-#define AFS_ERRORS \
+#define VSS_ERRORS \
        PARA_ERROR(AUDIO_FORMAT, "audio format not recognized"), \
-       PARA_ERROR(FSTAT, "failed to fstat() audio file"), \
+       PARA_ERROR(CHUNK, "unable to get chunk"), \
 
 
-#define DB_ERRORS \
+#define AFS_ERRORS \
        PARA_ERROR(GETCWD, "can not get current working directory"), \
        PARA_ERROR(CHDIR, "can not change directory"), \
        PARA_ERROR(OPENDIR, "can not open directory"), \
@@ -263,12 +296,11 @@ extern const char **para_errlist[];
 
 
 #define HTTP_SEND_ERRORS \
-       PARA_ERROR(QUEUE, "packet queue overrun"), \
        PARA_ERROR(WRITE_OK, "can not check whether fd is writable"), \
+       PARA_ERROR(SEND_QUEUED_CHUNK, "failed to send queued chunk"), \
 
 
 #define RANDOM_SELECTOR_ERRORS \
-       PARA_ERROR(FILE_COUNT, "audio file count exceeded"), \
        PARA_ERROR(NOTHING_FOUND, "no audio files found"), \
 
 
@@ -302,10 +334,10 @@ extern const char **para_errlist[];
        PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
        PARA_ERROR(BAD_CMD, "invalid command"), \
        PARA_ERROR(PERM, "permission denied"), \
-       PARA_ERROR(USERLIST, "failed to open user list file"), \
-       PARA_ERROR(BAD_USER, "you don't exist. Go away."), \
        PARA_ERROR(LOCK, "lock error"), \
        PARA_ERROR(SENDER_CMD, "command not supported by this sender"), \
+       PARA_ERROR(SERVER_CRASH, "para_server crashed -- can not live without it"), \
+       PARA_ERROR(BAD_USER, "you don't exist. Go away."), \
 
 
 #define PLAYLIST_SELECTOR_ERRORS \
@@ -323,14 +355,13 @@ extern const char **para_errlist[];
 
 #define DCCP_ERRORS \
        PARA_ERROR(DCCP_SOCKET, "can not create dccp socket"), \
-       PARA_ERROR(DCCP_PACKET_SIZE, "failed to set dccp packet size"), \
-       PARA_ERROR(DCCP_SERVICE, "could not get service code"), \
 
 
 #define DCCP_RECV_ERRORS \
        PARA_ERROR(ADDR_INFO, "getaddrinfo error"), \
        PARA_ERROR(DCCP_OVERRUN, "dccp output buffer buffer overrun"), \
        PARA_ERROR(DCCP_CONNECT, "dccp connect error"), \
+       PARA_ERROR(DCCP_RECV_EOF, "dccp_recv: end of file"), \
 
 
 #define DCCP_SEND_ERRORS \
@@ -342,19 +373,19 @@ extern const char **para_errlist[];
 #define FD_ERRORS \
        PARA_ERROR(F_GETFL, "failed to get fd flags"), \
        PARA_ERROR(F_SETFL, "failed to set fd flags"), \
+       PARA_ERROR(FGETS, "fgets error"), \
 
 
 #define WRITE_ERRORS \
-       PARA_ERROR(READ_HDR, "failed to read audio file header"), \
-       PARA_ERROR(READ_STDIN, "failed to read from stdin"), \
        PARA_ERROR(WRITE_SYNTAX, "para_write syntax error"), \
-       PARA_ERROR(WRITE_OVERRUN, "buffer overrun"), \
        PARA_ERROR(PREMATURE_END, "premature end of audio file"), \
        PARA_ERROR(NO_WAV_HEADER, "wave header not found"), \
+       PARA_ERROR(WAV_HEADER_SUCCESS, "successfully read wave header"), \
        PARA_ERROR(NO_DELAY, "no initial delay"), \
+       PARA_ERROR(DELAY_TIMEOUT, "initial delay timeout"), \
 
 
-#define ALSA_WRITER_ERRORS \
+#define ALSA_WRITE_ERRORS \
        PARA_ERROR(BROKEN_CONF, "Broken alsa configuration"), \
        PARA_ERROR(ACCESS_TYPE, "alsa access type not available"), \
        PARA_ERROR(SAMPLE_FORMAT, "sample format not available"), \
@@ -372,10 +403,9 @@ extern const char **para_errlist[];
        PARA_ERROR(SET_RATE, "snd_pcm_hw_params_set_rate_near failed"), \
        PARA_ERROR(START_THRESHOLD, "snd_pcm_sw_params_set_start_threshold() failed"), \
        PARA_ERROR(STOP_THRESHOLD, "snd_pcm_sw_params_set_stop_threshold() failed"), \
-       PARA_ERROR(ALSA_LOG, "snd_output_stdio_attach() failed"), \
 
 
-#define FILE_WRITER_ERRORS \
+#define FILE_WRITE_ERRORS \
        PARA_ERROR(FW_WRITE, "file writer write error"), \
        PARA_ERROR(FW_OPEN, "file writer: can not open output file"), \
        PARA_ERROR(FW_NO_FILE, "task started without open file"), \
@@ -383,11 +413,17 @@ extern const char **para_errlist[];
 
 #define WRITE_COMMON_ERRORS \
        PARA_ERROR(WRITE_COMMON_SYNTAX, "syntax error in write option"), \
+       PARA_ERROR(WNG_EOF, "wng: end of file"), \
 
 
 #define AACDEC_ERRORS \
        PARA_ERROR(AACDEC_INIT, "failed to init aac decoder"), \
        PARA_ERROR(AAC_DECODE, "aac decode error"), \
+       PARA_ERROR(AAC_OVERRUN, "aac output buffer overrun"), \
+
+
+#define CHUNK_QUEUE_ERRORS \
+       PARA_ERROR(QUEUE, "packet queue overrun"), \
 
 
 /**
@@ -460,12 +496,13 @@ extern const char **para_errlist[];
  */
 #define PARA_ERROR(err, msg) E_ ## err
 
-#define SS_NAME(ss) para_errlist[ss]? para_errlist[ss][0] : ""
+// #define SS_NAME(ss) para_errlist[ss]? para_errlist[ss][0] : ""
 
 /** \cond popcorn time */
 SS_ENUM(GUI);
 SS_ENUM(SCHED);
 SS_ENUM(STDIN);
+SS_ENUM(STDOUT);
 SS_ENUM(WAV);
 SS_ENUM(COMPRESS);
 SS_ENUM(TIME);
@@ -474,6 +511,7 @@ SS_ENUM(ORTP_RECV);
 SS_ENUM(NET);
 SS_ENUM(RECV);
 SS_ENUM(AUDIOD);
+SS_ENUM(AUDIOD_COMMAND);
 SS_ENUM(EXEC);
 SS_ENUM(SIGNAL);
 SS_ENUM(STRING);
@@ -492,14 +530,14 @@ SS_ENUM(OGG_AFH);
 SS_ENUM(AAC_AFH);
 SS_ENUM(AAC_COMMON);
 SS_ENUM(SERVER);
-SS_ENUM(AFS);
+SS_ENUM(VSS);
 SS_ENUM(COMMAND);
 SS_ENUM(RANDOM_SELECTOR);
 SS_ENUM(PLAYLIST_SELECTOR);
 SS_ENUM(CRYPT);
 SS_ENUM(HTTP_SEND);
 SS_ENUM(ORTP_SEND);
-SS_ENUM(DB);
+SS_ENUM(AFS);
 SS_ENUM(MYSQL_SELECTOR);
 SS_ENUM(IPC);
 SS_ENUM(DCCP);
@@ -508,9 +546,15 @@ SS_ENUM(DCCP_SEND);
 SS_ENUM(FD);
 SS_ENUM(WRITE);
 SS_ENUM(WRITE_COMMON);
-SS_ENUM(ALSA_WRITER);
-SS_ENUM(FILE_WRITER);
+SS_ENUM(ALSA_WRITE);
+SS_ENUM(FILE_WRITE);
+SS_ENUM(OSX_WRITE);
 SS_ENUM(RINGBUFFER);
+SS_ENUM(CLIENT);
+SS_ENUM(CLIENT_COMMON);
+SS_ENUM(AUDIOC);
+SS_ENUM(USER_LIST);
+SS_ENUM(CHUNK_QUEUE);
 /** \endcond */
 #undef PARA_ERROR
 /* rest of the world only sees the error text */