X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=error.h;h=300b54e4a357cc70e82dfef71bd73c1517cc0d25;hp=083582f8093c3793406d0eab4b148b6b49becd1b;hb=b17c70f1f96ca624064dd5202c54be55ed4d71c6;hpb=49c5a95ab4ca28d13c6faff59110447aeb0099a5;ds=inline diff --git a/error.h b/error.h index 083582f8..300b54e4 100644 --- a/error.h +++ b/error.h @@ -1,19 +1,18 @@ /* - * Copyright (C) 2006-2007 Andre Noll + * Copyright (C) 2006-2008 Andre Noll * * Licensed under the GPL v2. For licencing details see COPYING. */ -/** \file error.h list of error messages for all subsystems */ +/** \file error.h List of error messages for all subsystems. */ /** \cond */ -/* list of all subsystems that use paraslash's error facility */ +/* List of all subsystems that use paraslash's error facility. */ DEFINE_ERRLIST_OBJECT_ENUM; /* these do not need error handling (yet) */ #define SERVER_ERRORS -#define CLIENT_ERRORS #define WAV_ERRORS #define COMPRESS_ERRORS #define TIME_ERRORS @@ -24,11 +23,35 @@ DEFINE_ERRLIST_OBJECT_ENUM; #define RINGBUFFER_ERRORS #define SCORE_ERRORS #define SHA1_ERRORS +#define RBTREE_ERRORS #define RECV_ERRORS -#define AFH_COMMON_ERRORS +#define SEND_COMMON_ERRORS +#define STDOUT_ERRORS + extern const char **para_errlist[]; +#define FADE_ERRORS \ + PARA_ERROR(FADE_SYNTAX, "fade syntax error"), \ + + +#define CLIENT_ERRORS \ + PARA_ERROR(TASK_STARTED, "task started"), \ + + +#define AFH_ERRORS \ + PARA_ERROR(AFH_SYNTAX, "afh syntax error"), \ + PARA_ERROR(AFH_SHORT_WRITE, "afh short write"), \ + + +#define AFH_COMMON_ERRORS \ + PARA_ERROR(AUDIO_FORMAT, "audio format not recognized"), \ + + +#define ACL_ERRORS \ + PARA_ERROR(ACL_PERM, "access denied by acl"), \ + + #define FSCK_ERRORS \ PARA_ERROR(FSCK_SYNTAX, "fsck syntax error"), \ PARA_ERROR(RANGE_VIOLATION, "range violation detected, very bad"), \ @@ -54,7 +77,6 @@ extern const char **para_errlist[]; PARA_ERROR(ALREADY_MAPPED, "file already mapped"), \ PARA_ERROR(BAD_SIZE, "invalid size specified"), \ PARA_ERROR(TRUNC, "failed to truncate file"), \ - PARA_ERROR(UNLINK, "failed to remove 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"), \ @@ -63,21 +85,17 @@ extern const char **para_errlist[]; PARA_ERROR(INDEX_CORRUPTION, "index corruption detected"), \ PARA_ERROR(INVALID_OBJECT, "reference to invalid object"), \ PARA_ERROR(STAT, "can not stat file"), \ - PARA_ERROR(FSTAT, "fstat error"), \ - PARA_ERROR(RENAME, "rename failed"), \ 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 suppoerted"), \ + 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 RBTREE_ERRORS \ - #define AFS_ERRORS \ PARA_ERROR(BAD_TABLE_NAME, "invalid table"), \ @@ -85,20 +103,20 @@ extern const char **para_errlist[]; PARA_ERROR(AFS_SYNTAX, "afs syntax error"), \ PARA_ERROR(AFS_SIGNAL, "afs caught deadly signal"), \ PARA_ERROR(AFS_SOCKET, "afs socket not writable"), \ - PARA_ERROR(AFS_PARENT_DIED, "fatal: server process terminated"), \ PARA_ERROR(AFS_SHORT_READ, "short read from afs socket"), \ #define MOOD_ERRORS \ PARA_ERROR(MOOD_SYNTAX, "mood syntax error"), \ PARA_ERROR(NO_MOOD, "no mood available"), \ - PARA_ERROR(MOOD_LOADED, "mood loaded"), \ - PARA_ERROR(NOT_ADMISSIBLE, "file is not admussible"), \ + PARA_ERROR(NOT_ADMISSIBLE, "file is not admissible"), \ #define ATTRIBUTE_ERRORS \ PARA_ERROR(ATTR_SYNTAX, "attribute syntax error"), \ PARA_ERROR(NO_ATTRIBUTES, "no attributes defined yet"), \ + PARA_ERROR(ATT_TABLE_FULL, "no more space left in attribute table"), \ + #define BLOB_ERRORS \ PARA_ERROR(BLOB_SYNTAX, "blob syntax error"), \ @@ -106,14 +124,13 @@ extern const char **para_errlist[]; #define PLAYLIST_ERRORS \ - PARA_ERROR(NO_PLAYLIST, "no valid playlist found"), \ PARA_ERROR(PLAYLIST_LOADED, ""), /* not really an error */ \ PARA_ERROR(PATH_FOUND, ""), /* not really an error */ \ PARA_ERROR(PLAYLIST_EMPTY, "attempted to load empty playlist"), \ #define AFT_ERRORS \ - PARA_ERROR(BAD_AFSI, "invaid afs info"), \ + PARA_ERROR(BAD_AFSI, "invaiid afs info"), \ PARA_ERROR(LOCALTIME, "localtime() failed"), \ PARA_ERROR(STRFTIME, "strftime() failed"), \ PARA_ERROR(BAD_PATH, "invalid path"), \ @@ -145,36 +162,29 @@ extern const char **para_errlist[]; 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(TASK_KILLED, "task killed"), \ + PARA_ERROR(TASK_UNREGISTERED, "task has been unscheduled"), \ 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 \ - PARA_ERROR(CONNECT, "connect error"), \ PARA_ERROR(NAME_TOO_LONG, "name too long for struct sockaddr_un"), \ + PARA_ERROR(ADDRESS_LOOKUP, "address lookup / socket creation failed"), \ PARA_ERROR(CHMOD, "failed to set socket mode"), \ PARA_ERROR(SENDMSG, "sendmsg() failed"), \ PARA_ERROR(RECVMSG, "recvmsg() failed"), \ @@ -184,26 +194,29 @@ extern const char **para_errlist[]; #define ORTP_RECV_ERRORS \ PARA_ERROR(MSG_TO_BUF, "failed to extract rtp packet"), \ - PARA_ERROR(ORTP_SYNTAX, "ottp syntax error"), \ + PARA_ERROR(ORTP_SYNTAX, "ortp syntax error"), \ 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(OVERRUN, "output buffer overrun"), \ PARA_ERROR(ORTP_RECV_EOF, "ortp_recv: end of file"), \ #define HTTP_RECV_ERRORS \ - PARA_ERROR(HTTP_RECV_EOF, "http_recv: end of file"), \ - PARA_ERROR(HTTP_RECV_OVERRUN, "http_recv: outout buffer overrun"), \ + PARA_ERROR(HTTP_RECV_OVERRUN, "http_recv: output buffer overrun"), \ + #define RECV_COMMON_ERRORS \ PARA_ERROR(RECV_SYNTAX, "recv syntax error"), \ + PARA_ERROR(RECV_EOF, "end of file"), \ #define AUDIOD_ERRORS \ 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"), \ + PARA_ERROR(NOT_PLAYING, "not playing"), \ + PARA_ERROR(AUDIOD_OFF, "audiod switched off"), \ + PARA_ERROR(STATUS_TIMEOUT, "timeout reading server status"), \ #define AUDIOD_COMMAND_ERRORS \ @@ -254,13 +267,10 @@ extern const char **para_errlist[]; #define SIGNAL_ERRORS \ - PARA_ERROR(SIGNAL_SIG_ERR, "signal() retured SIG_ERR"), \ - PARA_ERROR(SIGNAL_READ, "read error from signal pipe"), \ + PARA_ERROR(SIGNAL_SIG_ERR, "signal() returned SIG_ERR"), \ #define STRING_ERRORS \ - PARA_ERROR(MKSTEMP, "mkstemp error: unable to create tmp file"), \ - PARA_ERROR(FCHMOD, "fchmod error: can not set mode"), \ PARA_ERROR(ATOI_OVERFLOW, "value too large"), \ PARA_ERROR(STRTOLL, "unknown strtoll error"), \ PARA_ERROR(ATOI_NO_DIGITS, "no digits found in string"), \ @@ -269,7 +279,6 @@ extern const char **para_errlist[]; #define EXEC_ERRORS \ PARA_ERROR(DUP_PIPE, "exec error: can not create pipe"), \ - PARA_ERROR(NULL_OPEN, "can not open /dev/null"), \ #define MP3_AFH_ERRORS \ @@ -304,10 +313,7 @@ extern const char **para_errlist[]; #define VSS_ERRORS \ - PARA_ERROR(BAD_AUDIO_FILE_SUFFIX, "unknown suffix"), \ - PARA_ERROR(AUDIO_FORMAT, "audio format not recognized"), \ PARA_ERROR(CHUNK, "unable to get chunk"), \ - PARA_ERROR(SHORT_AFS_READ, "short read from afs socket"), \ PARA_ERROR(NOFD, "did not receive open fd from afs"), \ @@ -321,14 +327,12 @@ extern const char **para_errlist[]; #define HTTP_SEND_ERRORS \ - PARA_ERROR(WRITE_OK, "can not check whether fd is writable"), \ - PARA_ERROR(SEND_QUEUED_CHUNK, "failed to send queued chunk"), \ + PARA_ERROR(MAX_CLIENTS, "maximal number of clients exceeded"), \ #define COMMAND_ERRORS \ PARA_ERROR(COMMAND_SYNTAX, "syntax error in command"), \ PARA_ERROR(AUTH, "did not receive auth request"), \ - PARA_ERROR(BAD_SELECTOR, "no such audio file selector"), \ PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \ PARA_ERROR(BAD_CMD, "invalid command"), \ PARA_ERROR(PERM, "permission denied"), \ @@ -347,36 +351,21 @@ extern const char **para_errlist[]; PARA_ERROR(SHM_DETACH, "can not detach shared memory area"), \ -#define DCCP_ERRORS \ - PARA_ERROR(DCCP_SOCKET, "can not create dccp socket"), \ - - #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 \ - PARA_ERROR(DCCP_BIND, "dccp bind error"), \ - PARA_ERROR(DCCP_LISTEN, "dccp listen error"), \ - PARA_ERROR(DCCP_WRITE, "dccp write error"), \ #define FD_ERRORS \ PARA_ERROR(FGETS, "fgets error"), \ - PARA_ERROR(CHDIR, "failed to change directory"), \ - PARA_ERROR(OPEN, "failed to open file"), \ - PARA_ERROR(CHDIR_PERM, "insufficient permissions to chdir"), \ PARA_ERROR(EMPTY, "file empty"), \ PARA_ERROR(MMAP, "mmap error"), \ - PARA_ERROR(MUNMAP, "munmap failed"), \ #define WRITE_ERRORS \ PARA_ERROR(WRITE_SYNTAX, "para_write syntax error"), \ - 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"), \ @@ -391,8 +380,6 @@ extern const char **para_errlist[]; 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(GET_XFER, "unable to obtain xfer align"), \ - PARA_ERROR(SET_XFER, "snd_pcm_sw_params_set_xfer_align() failed"), \ PARA_ERROR(ALSA_WRITE, "alsa write error"), \ PARA_ERROR(PCM_OPEN, "unable to open pcm"), \ PARA_ERROR(SND_PCM_INFO, "pcm info error"), \ @@ -411,7 +398,6 @@ 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 \ @@ -423,25 +409,26 @@ extern const char **para_errlist[]; #define CHUNK_QUEUE_ERRORS \ PARA_ERROR(QUEUE, "packet queue overrun"), \ + /** \endcond */ /** - * the subsystem shift + * The subsystem shift. * * 255 error codes ought to be enough for every subsystem. Use the higher bits - * of the return value to encode the subsystem number + * of the return value to encode the subsystem number. */ #define SS_SHIFT 8 /** - * compute the subsystem offset + * Compute the subsystem offset. * - * It is given by x * 2**8 where \a x is the subsystem number + * It is given by x * 2**8 where \a x is the subsystem number. */ #define SS_OFFSET(ss) (SS_ ## ss << SS_SHIFT) /** - * make the enum of all errors of one subsystem + * Make the enum of all errors of one subsystem. * * As zero should not be an error, we define a dummy enum entry with value * 2**ss. That lets the real errors start at 2**ss + 1. @@ -451,53 +438,74 @@ extern const char **para_errlist[]; ss ## _ERRORS} /** - * determine the subsystem number from the error number + * Determine the subsystem number from the error number. * * Easy, it's just \a num / 2**8. */ #define ERRNUM_TO_SS(num) ((num) >> SS_SHIFT) /** - * determine the index of an error number + * Determine the index of an error number. * * Also easy: It's the lower 8 bits of num. */ #define ERRNUM_TO_INDEX(num) (((1 << SS_SHIFT) - 1) & (num)) +/** + * This bit indicates whether a number is considered a system error number + * If yes, the system errno is just the result of clearing this bit from + * the given number. + */ #define SYSTEM_ERROR_BIT 30 +/** Check whether the system error bit is set. */ #define IS_SYSTEM_ERROR(num) (!!((num) & (1 << SYSTEM_ERROR_BIT))) +/** Set the system error bit for the given number. */ #define ERRNO_TO_PARA_ERROR(num) ((num) | (1 << SYSTEM_ERROR_BIT)) -static inline int is_errno(int val, int _errno) +/** Check whether a given number is a system error number. + * + * \param num The value to be checked. + * \param _errno The system error number. + * + * \return True if \a num is paraslash's representation of the system + * error identified by \a _errno. + */ +_static_inline_ int is_errno(int num, int _errno) { - assert(val > 0 && _errno > 0); - return ERRNO_TO_PARA_ERROR(_errno) == val; + assert(num > 0 && _errno > 0); + return ERRNO_TO_PARA_ERROR(_errno) == num; } /** - * paraslash's version of strerror(3) + * Paraslash's version of strerror(3). + * + * \param num The error number. * - * expands to the error text of \a num (a string constant). + * \return The error text of \a num. */ -#define PARA_STRERROR(num) IS_SYSTEM_ERROR(num)? \ - strerror((num) & ((1 << SYSTEM_ERROR_BIT) - 1)) : \ - para_errlist[ERRNUM_TO_SS(num)] [ERRNUM_TO_INDEX(num)] - +_static_inline_ const char *para_strerror(int num) +{ + assert(num > 0); + 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)]; +} /** - * define the error list for one subsystem + * Define the error list for one subsystem. # * The first entry (index 0) is always the name of the subsystem - * Used by macros in config.h (generated by configure) + * Used by macros in config.h (generated by configure). */ #define DEFINE_ERRLIST(ss) const char * ss ## _ERRLIST[] = {#ss, ss ## _ERRORS} /** - * activate errors for one subsystem. + * Activate errors for one subsystem. * - * Each executable needs only the error lists of those subssystems it is - * actually linked with. We always reserve space for NUM_SS char ** pointers, + * Each executable needs only the error lists of those subsystems it is + * actually linked with. We always reserve space for NUM_SS char pointers, * but only init those of the needed subsystems. This macro is used by macros * in config.h (generated by configure). */ @@ -510,5 +518,5 @@ static inline int is_errno(int val, int _errno) #define PARA_ERROR(err, msg) E_ ## err #include "error2.h" #undef PARA_ERROR -/* rest of the world only sees the error text */ +/* Rest of the world only sees the error text. */ #define PARA_ERROR(err, msg) msg