command_util: Generate properly documented command header files.
[paraslash.git] / error.h
diff --git a/error.h b/error.h
index 2a8a6b5..59d0321 100644 (file)
--- a/error.h
+++ b/error.h
@@ -13,7 +13,6 @@ DEFINE_ERRLIST_OBJECT_ENUM;
 
 /* these do not need error handling (yet) */
 #define SERVER_ERRORS
-#define WAV_FILTER_ERRORS
 #define TIME_ERRORS
 #define CLOSE_ON_FORK_ERRORS
 #define DAEMON_ERRORS
@@ -29,14 +28,44 @@ DEFINE_ERRLIST_OBJECT_ENUM;
 #define DCCP_SEND_ERRORS
 #define HTTP_SEND_ERRORS
 #define GGO_ERRORS
+#define COLOR_ERRORS
+#define SIGNAL_ERRORS
 
 
 extern const char **para_errlist[];
 
+#define PREBUFFER_FILTER_ERRORS \
+       PARA_ERROR(PREBUFFER_SYNTAX, "syntax error in prebuffer filter config"), \
+
+#define OSS_WRITE_ERRORS \
+       PARA_ERROR(BAD_SAMPLE_FORMAT, "sample format not supported"), \
+       PARA_ERROR(BAD_CHANNEL_COUNT, "channel count not supported"), \
+       PARA_ERROR(BAD_SAMPLERATE, "sample rate not supported"), \
+
+
 #define COMPRESS_FILTER_ERRORS \
        PARA_ERROR(COMPRESS_SYNTAX, "syntax error in compress filter config"), \
 
 
+#define WAV_FILTER_ERRORS \
+       PARA_ERROR(WAV_BAD_FC, "invalid filter chain configuration"), \
+
+
+#define FEC_ERRORS \
+       PARA_ERROR(FEC_BAD_IDX, "invalid index vector"), \
+       PARA_ERROR(FEC_SINGULAR, "unexpected singular matrix"), \
+       PARA_ERROR(FEC_PIVOT, "pivot column not found"), \
+       PARA_ERROR(FEC_PARMS, "invalid fec parameters"), \
+
+
+#define FECDEC_FILTER_ERRORS \
+       PARA_ERROR(BAD_FEC_HEADER, "invalid fec header"), \
+       PARA_ERROR(BAD_SLICE_SIZE, "slice size zero or too large"), \
+       PARA_ERROR(BAD_SLICE_NUM, "invalid slice number"), \
+       PARA_ERROR(FECDEC_OVERRUN, "fecdec output buffer overrun"), \
+       PARA_ERROR(FECDEC_EOF, "received eof packet"), \
+
+
 #define AMP_FILTER_ERRORS \
        PARA_ERROR(AMP_SYNTAX, "syntax error in amp filter config"), \
 
@@ -71,46 +100,6 @@ extern const char **para_errlist[];
        PARA_ERROR(RANGE_VIOLATION, "range violation detected, very bad"), \
        PARA_ERROR(NOT_A_REGULAR_FILE, "not a regular file"), \
 
-
-#define OSL_ERRORS \
-       PARA_ERROR(BAD_DB_DIR, "invalid database directory"), \
-       PARA_ERROR(NO_COLUMN_DESC, "missing column description"), \
-       PARA_ERROR(BAD_NAME, "invalid name for a column/table"), \
-       PARA_ERROR(BAD_STORAGE_TYPE, "invalid storage type"), \
-       PARA_ERROR(BAD_STORAGE_FLAGS, "invalid storage flags"), \
-       PARA_ERROR(NO_COLUMN_NAME, "missing column name"), \
-       PARA_ERROR(NO_COLUMNS, "at least one column required"), \
-       PARA_ERROR(BAD_COLUMN_NAME, "invalid name for a table column"), \
-       PARA_ERROR(NO_UNIQUE_RBTREE_COLUMN, "need at least one mapped column with OSL_UNIQE and OSL_RBTREE OSL"), \
-       PARA_ERROR(NO_RBTREE_COL, "at least one column needs an rbtree"), \
-       PARA_ERROR(DUPLICATE_COL_NAME, "column name given twice"), \
-       PARA_ERROR(BAD_STORAGE_SIZE, "invalid storage size"), \
-       PARA_ERROR(NO_COMPARE_FUNC, "missing compare function"), \
-       PARA_ERROR(BAD_DATA_SIZE, "wrong data size for fixed-size column"), \
-       PARA_ERROR(NOT_MAPPED, "file not mapped"), \
-       PARA_ERROR(ALREADY_MAPPED, "file already mapped"), \
-       PARA_ERROR(BAD_SIZE, "invalid size specified"), \
-       PARA_ERROR(TRUNC, "failed to truncate file"), \
-       PARA_ERROR(BAD_TABLE, "table not open"), \
-       PARA_ERROR(BAD_TABLE_DESC, "invalid table description"), \
-       PARA_ERROR(RB_KEY_EXISTS, "key already exists in rbtree"), \
-       PARA_ERROR(RB_KEY_NOT_FOUND, "key not found in rbtree"), \
-       PARA_ERROR(BAD_ROW_NUM, "invalid row number"), \
-       PARA_ERROR(INDEX_CORRUPTION, "index corruption detected"), \
-       PARA_ERROR(INVALID_OBJECT, "reference to invalid object"), \
-       PARA_ERROR(STAT, "can not stat file"), \
-       PARA_ERROR(WRITE, "write error"), \
-       PARA_ERROR(LSEEK, "lseek error"), \
-       PARA_ERROR(BUSY, "table is busy"), \
-       PARA_ERROR(SHORT_TABLE, "table too short"), \
-       PARA_ERROR(NO_MAGIC, "missing table header magic"), \
-       PARA_ERROR(VERSION_MISMATCH, "table version not supported"), \
-       PARA_ERROR(BAD_COLUMN_NUM, "invalid column number"), \
-       PARA_ERROR(BAD_TABLE_FLAGS, "invalid flags in table description"), \
-       PARA_ERROR(BAD_ROW, "invalid row"), \
-
-
-
 #define AFS_ERRORS \
        PARA_ERROR(BAD_TABLE_NAME, "invalid table"), \
        PARA_ERROR(INPUT_TOO_LARGE, "input too large for stdin command"), \
@@ -118,6 +107,7 @@ extern const char **para_errlist[];
        PARA_ERROR(AFS_SIGNAL, "afs caught deadly signal"), \
        PARA_ERROR(AFS_SOCKET, "afs socket not writable"), \
        PARA_ERROR(AFS_SHORT_READ, "short read from afs socket"), \
+       PARA_ERROR(OSL, "osl error"), \
 
 
 #define MOOD_ERRORS \
@@ -248,6 +238,7 @@ extern const char **para_errlist[];
 #define STAT_ERRORS \
        PARA_ERROR(TOO_MANY_CLIENTS, "maximal number of stat clients exceeded"), \
        PARA_ERROR(UNKNOWN_STAT_ITEM, "status item not recognized"), \
+       PARA_ERROR(STAT_ITEM_PARSE, "failed to parse status item"), \
 
 
 #define OGGDEC_FILTER_ERRORS \
@@ -281,15 +272,12 @@ extern const char **para_errlist[];
        PARA_ERROR(FILTER_SYNTAX, "syntax error"), \
 
 
-#define SIGNAL_ERRORS \
-       PARA_ERROR(SIGNAL_SIG_ERR, "signal() returned SIG_ERR"), \
-
-
 #define STRING_ERRORS \
        PARA_ERROR(ATOI_OVERFLOW, "value too large"), \
        PARA_ERROR(STRTOLL, "unknown strtoll error"), \
        PARA_ERROR(ATOI_NO_DIGITS, "no digits found in string"), \
        PARA_ERROR(ATOI_JUNK_AT_END, "further characters after number"), \
+       PARA_ERROR(SIZE_PREFIX, "bad size prefix") \
 
 
 #define EXEC_ERRORS \
@@ -329,6 +317,7 @@ extern const char **para_errlist[];
 
 #define VSS_ERRORS \
        PARA_ERROR(NOFD, "did not receive open fd from afs"), \
+       PARA_ERROR(BAD_CT, "invalid chunk table or bad FEC configuration")
 
 
 #define CRYPT_ERRORS \
@@ -342,14 +331,15 @@ extern const char **para_errlist[];
 
 #define COMMAND_ERRORS \
        PARA_ERROR(COMMAND_SYNTAX, "syntax error in command"), \
-       PARA_ERROR(AUTH, "did not receive auth request"), \
+       PARA_ERROR(AUTH_REQUEST, "did not receive auth request"), \
        PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
        PARA_ERROR(BAD_CMD, "invalid command"), \
        PARA_ERROR(PERM, "permission denied"), \
        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."), \
+       PARA_ERROR(BAD_USER, "auth request for invalid user"), \
+       PARA_ERROR(BAD_AUTH, "authentication failure"), \
 
 
 #define DCCP_RECV_ERRORS \
@@ -374,11 +364,10 @@ extern const char **para_errlist[];
        PARA_ERROR(SAMPLE_FORMAT, "sample format not available"), \
        PARA_ERROR(CHANNEL_COUNT, "channels count not available"), \
        PARA_ERROR(HW_PARAMS, "unable to install hw params"), \
-       PARA_ERROR(SW_PARAMS, "unable to install sw params"), \
        PARA_ERROR(BAD_PERIOD, "can not use period equal to buffer size"), \
        PARA_ERROR(ALSA_WRITE, "alsa write error"), \
        PARA_ERROR(PCM_OPEN, "unable to open pcm"), \
-       PARA_ERROR(SND_PCM_INFO, "pcm info error"), \
+       PARA_ERROR(PHYSICAL_WIDTH, "unable to determine bytes per frame"), \
        PARA_ERROR(GET_BUFFER_TIME, "snd_pcm_hw_params_get_buffer_time_max() failed"), \
        PARA_ERROR(SET_BUFFER_TIME, "snd_pcm_hw_params_set_buffer_time_near() failed"), \
        PARA_ERROR(SET_RATE, "snd_pcm_hw_params_set_rate_near failed"), \
@@ -454,12 +443,23 @@ extern const char **para_errlist[];
  */
 #define SYSTEM_ERROR_BIT 30
 
+/**
+ * Like the SYSTEM_ERROR_BIT, but indicates an error from the osl library.
+ */
+#define OSL_ERROR_BIT 29
+
 /** Check whether the system error bit is set. */
 #define IS_SYSTEM_ERROR(num) (!!((num) & (1 << SYSTEM_ERROR_BIT)))
 
+/** Check whether the osl error bit is set. */
+#define IS_OSL_ERROR(num) (!!((num) & (1 << OSL_ERROR_BIT)))
+
 /** Set the system error bit for the given number. */
 #define ERRNO_TO_PARA_ERROR(num) ((num) | (1 << SYSTEM_ERROR_BIT))
 
+/** Set the osl error bit for the given number. */
+#define OSL_ERRNO_TO_PARA_ERROR(num) ((num) | (1 << OSL_ERROR_BIT))
+
 /** Check whether a given number is a system error number.
  *
  * \param num The value to be checked.
@@ -484,11 +484,33 @@ _static_inline_ int is_errno(int num, int _errno)
 _static_inline_ const char *para_strerror(int num)
 {
        assert(num > 0);
+#ifdef _OSL_H
+       if (IS_OSL_ERROR(num))
+               return osl_strerror(num & ((1 << OSL_ERROR_BIT) - 1));
+#endif
        if (IS_SYSTEM_ERROR(num))
-               return strerror((num) & ((1 << SYSTEM_ERROR_BIT) - 1));
-       else
-               return para_errlist[ERRNUM_TO_SS(num)][ERRNUM_TO_INDEX(num)];
+               return strerror(num & ((1 << SYSTEM_ERROR_BIT) - 1));
+       return para_errlist[ERRNUM_TO_SS(num)][ERRNUM_TO_INDEX(num)];
+}
+
+/**
+ * Wrapper for osl library calls.
+ *
+ * \param ret The return value of an osl library function.
+ *
+ * This should be used for all calls to osl functions that return an osl error
+ * code. It changes the return value appropriately so that it can be used for
+ * printing the correct error message vi para_strerror().
+ *
+ * \return \a ret if \a ret >= 0, a paraslash error code otherwise.
+ */
+_static_inline_ int osl(int ret)
+{
+       if (ret >= 0)
+               return ret;
+       return -OSL_ERRNO_TO_PARA_ERROR(-ret);
 }
+
 /**
  * Define the error list for one subsystem.
  #