-/*
- * Copyright (C) 2006 Andre Noll <maan@tuebingen.mpg.de>
- *
- * Licensed under the GPL v2. For licencing details see COPYING.
- */
+/* Copyright (C) 2006 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
/** \file error.h List of error codes and messages. */
+/** \cond para_error */
/** Codes and messages. */
#define PARA_ERRORS \
+ PARA_ERROR(SUCCESS, "success"), \
PARA_ERROR(AACDEC_INIT, "failed to init aac decoder"), \
PARA_ERROR(AAC_DECODE, "aac decode error"), \
PARA_ERROR(ACL_PERM, "access denied by acl"), \
PARA_ERROR(AFS_SHORT_READ, "short read from afs socket"), \
PARA_ERROR(AFS_SIGNAL, "afs caught deadly signal"), \
PARA_ERROR(AFS_SOCKET, "afs socket not writable"), \
- PARA_ERROR(AFS_SYNTAX, "afs syntax error"), \
- PARA_ERROR(AFT_SYNTAX, "audio file table syntax error"), \
PARA_ERROR(ALSA, "alsa error"), \
PARA_ERROR(ALSA_MIX_GET_VAL, "could not read control element state"), \
PARA_ERROR(ALSA_MIX_OPEN, "could not open mixer"), \
PARA_ERROR(ALSA_MIX_RANGE, "value control element out of range"), \
PARA_ERROR(ALSA_MIX_SET_VAL, "could not set control element state"), \
- PARA_ERROR(AMP_EOF, "amp: end of file"), \
PARA_ERROR(AMP_ZERO_AMP, "no amplification necessary"), \
PARA_ERROR(AO_APPEND_OPTION, "ao append option: memory allocation failure"), \
PARA_ERROR(AO_BAD_DRIVER, "ao: invalid driver"), \
PARA_ERROR(AO_BAD_OPTION, "ao option is not of type key:value"), \
- PARA_ERROR(AO_BAD_SAMPLE_FORMAT, "ao: unsigned sample formats not supported"), \
PARA_ERROR(AO_DEFAULT_DRIVER, "ao: no usable output device"), \
- PARA_ERROR(AO_EOF, "ao: end of file"), \
PARA_ERROR(AO_FILE_NOT_SUPP, "ao: file io drivers not supported"), \
PARA_ERROR(AO_OPEN_LIVE, "ao: could not open audio device"), \
PARA_ERROR(AO_PLAY, "ao_play() failed"), \
PARA_ERROR(AO_PTHREAD, "pthread error"), \
- PARA_ERROR(ARG_NOT_FOUND, "argument not found in arg vector"), \
PARA_ERROR(ASN1_PARSE, "could not parse ASN.1 key"), \
PARA_ERROR(ATOI_JUNK_AT_END, "further characters after number"), \
PARA_ERROR(ATOI_NO_DIGITS, "no digits found in string"), \
PARA_ERROR(ATOI_OVERFLOW, "value too large"), \
PARA_ERROR(ATTR_SYNTAX, "attribute syntax error"), \
PARA_ERROR(ATT_TABLE_FULL, "no more space left in attribute table"), \
- PARA_ERROR(AUDIOC_EOF, "audioc: end of file"), \
PARA_ERROR(AUDIOD_OFF, "audiod switched off"), \
PARA_ERROR(AUDIOD_SIGNAL, "caught deadly signal"), \
PARA_ERROR(AUDIOD_TERM, "terminating on user request"), \
PARA_ERROR(BAD_CT, "invalid chunk table or bad FEC configuration"), \
PARA_ERROR(BAD_FEATURE, "invalid feature request"), \
PARA_ERROR(BAD_FEC_HEADER, "invalid fec header"), \
- PARA_ERROR(BAD_LL, "invalid loglevel"), \
+ PARA_ERROR(BAD_MOP, "invalid mood or playlist"), \
PARA_ERROR(BAD_PATH, "invalid path"), \
PARA_ERROR(BAD_PRIVATE_KEY, "invalid private key"), \
PARA_ERROR(BAD_SAMPLE_FORMAT, "sample format not supported"), \
PARA_ERROR(BIGNUM, "bignum error"), \
PARA_ERROR(BLINDING, "failed to activate key blinding"), \
PARA_ERROR(BLOB_SYNTAX, "blob syntax error"), \
- PARA_ERROR(BTR_EOF, "buffer tree: end of file"), \
PARA_ERROR(BTR_NAVAIL, "btr node: value currently unavailable"), \
PARA_ERROR(BTR_NO_CHILD, "btr node has no children"), \
+ PARA_ERROR(CHILD_CONTEXT, "now running in child context"), \
PARA_ERROR(CHMOD, "failed to set socket mode"), \
PARA_ERROR(CLIENT_SYNTAX, "syntax error"), \
PARA_ERROR(CLIENT_WRITE, "client write error"), \
PARA_ERROR(COMMAND_SYNTAX, "syntax error in command"), \
- PARA_ERROR(COMPRESS_EOF, "compress: end of file"), \
PARA_ERROR(CREATE_OPUS_DECODER, "could not create opus decoder"), \
PARA_ERROR(DCCP_OVERRUN, "dccp output buffer buffer overrun"), \
PARA_ERROR(DECRYPT, "decrypt error"), \
PARA_ERROR(EMPTY, "file is empty"), \
PARA_ERROR(ENCRYPT, "encrypt error"), \
PARA_ERROR(EOF, "end of file"), \
+ PARA_ERROR(EOP, "end of playlist"), \
PARA_ERROR(FEC_BAD_IDX, "invalid index vector"), \
- PARA_ERROR(FECDEC_EOF, "received eof packet"), \
PARA_ERROR(FECDEC_OVERRUN, "fecdec output buffer overrun"), \
PARA_ERROR(FEC_PARMS, "invalid fec parameters"), \
PARA_ERROR(FEC_PIVOT, "pivot column not found"), \
PARA_ERROR(FLAC_CHAIN_READ, "could not read meta chain"), \
PARA_ERROR(FLACDEC_DECODER_ALLOC, "could not allocate stream decoder"), \
PARA_ERROR(FLACDEC_DECODER_INIT, "could not init stream decoder"), \
- PARA_ERROR(FLACDEC_EOF, "flacdec encountered end of file condition"), \
PARA_ERROR(FLAC_DECODE_POS, "could not get decode position"), \
PARA_ERROR(FLAC_ITER_ALLOC, "could not allocate meta iterator"), \
PARA_ERROR(FLAC_REPLACE_COMMENT, "could not replace vorbis comment"), \
PARA_ERROR(HEADER_BITRATE, "invalid header bitrate"), \
PARA_ERROR(HEADER_FREQ, "invalid header frequency"), \
PARA_ERROR(HTTP_RECV_OVERRUN, "http_recv: output buffer overrun"), \
- PARA_ERROR(I9E_EOF, "end of input"), \
PARA_ERROR(I9E_SETUPTERM, "failed to set up terminal"), \
PARA_ERROR(I9E_TERM_RQ, "received termination request"), \
PARA_ERROR(ID3_ATTACH, "could not attach id3 frame"), \
PARA_ERROR(MAKESOCK, "makesock error"), \
PARA_ERROR(MAX_CLIENTS, "maximal number of clients exceeded"), \
PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
- PARA_ERROR(MOOD_SYNTAX, "mood syntax error"), \
+ PARA_ERROR(MOOD_PARSE, "mood parse error"), \
PARA_ERROR(MP3DEC_CORRUPT, "too many corrupt frames"), \
- PARA_ERROR(MP3DEC_EOF, "mp3dec: end of file"), \
PARA_ERROR(MP3_INFO, "could not read mp3 info"), \
- PARA_ERROR(MP4FF_BAD_CHANNEL_COUNT, "mp4ff: invalid number of channels"), \
- PARA_ERROR(MP4FF_BAD_SAMPLE, "mp4ff: invalid sample number"), \
- PARA_ERROR(MP4FF_BAD_SAMPLERATE, "mp4ff: invalid sample rate"), \
- PARA_ERROR(MP4FF_BAD_SAMPLE_COUNT, "mp4ff: invalid number of samples"), \
- PARA_ERROR(MP4FF_META_READ, "mp4ff: could not read mp4 metadata"), \
- PARA_ERROR(MP4FF_META_WRITE, "mp4ff: could not update mp4 metadata"), \
- PARA_ERROR(MP4FF_OPEN, "mp4ff: open failed"), \
- PARA_ERROR(MP4FF_TRACK, "mp4fF: no audio track"), \
+ PARA_ERROR(MP4_READ, "mp4: read error or unexpected end of file"), \
+ PARA_ERROR(MP4_CORRUPT, "invalid/corrupt mp4 file"), \
+ PARA_ERROR(MP4_BAD_SAMPLE, "mp4: invalid sample number"), \
+ PARA_ERROR(MP4_BAD_SAMPLERATE, "mp4: invalid sample rate"), \
+ PARA_ERROR(MP4_BAD_SAMPLE_COUNT, "mp4: invalid number of samples"), \
+ PARA_ERROR(MP4_TRACK, "mp4: no audio track"), \
+ PARA_ERROR(MP4_MISSING_ATOM, "mp4: essential atom not found"), \
PARA_ERROR(MPI_SCAN, "could not scan multi-precision integer"), \
PARA_ERROR(NAME_TOO_LONG, "name too long for struct sockaddr_un"), \
PARA_ERROR(NO_AFHI, "audio format handler info required"), \
PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
PARA_ERROR(NOFD, "did not receive open fd from afs"), \
PARA_ERROR(NO_MATCH, "no matches"), \
- PARA_ERROR(NO_MOOD, "no mood available"), \
PARA_ERROR(NO_MORE_SLOTS, "no more empty slots"), \
PARA_ERROR(NOT_PLAYING, "not playing"), \
PARA_ERROR(NO_VALID_FILES, "no valid file found in playlist"), \
PARA_ERROR(OGGDEC_VERSION, "vorbis version mismatch"), \
PARA_ERROR(OGG_EMPTY, "no ogg pages found"), \
PARA_ERROR(OGG_PACKET_IN, "ogg_stream_packetin() failed"), \
- PARA_ERROR(OGG_STREAM_FLUSH, "ogg_stream_flush() failed"), \
PARA_ERROR(OGG_SYNC, "internal ogg storage overflow"), \
+ PARA_ERROR(OPENSSH_PARSE, "could not parse openssh private key"), \
PARA_ERROR(OPUS_COMMENT, "invalid or corrupted opus comment"), \
PARA_ERROR(OPUS_DECODE, "opus decode error"), \
PARA_ERROR(OPUS_HEADER, "invalid opus header"), \
PARA_ERROR(OPUS_SET_GAIN, "opus: could not set gain"), \
PARA_ERROR(PATH_FOUND, ""), /* not really an error */ \
- PARA_ERROR(PERM, "permission denied"), \
PARA_ERROR(PLAYLIST_EMPTY, "attempted to load empty playlist"), \
- PARA_ERROR(PLAYLIST_LOADED, ""), /* not really an error */ \
PARA_ERROR(PREBUFFER_SUCCESS, "prebuffering complete"), \
PARA_ERROR(PRIVATE_KEY, "can not read private key"), \
PARA_ERROR(QUEUE, "packet queue overrun"), \
PARA_ERROR(READ_PATTERN, "did not read expected pattern"), \
- PARA_ERROR(RECV_EOF, "end of file"), \
PARA_ERROR(RECVMSG, "recvmsg() failed"), \
PARA_ERROR(REGEX, "regular expression error"), \
- PARA_ERROR(RESAMPLE_EOF, "resample filter: end of file"), \
PARA_ERROR(RSA, "RSA error"), \
PARA_ERROR(RSA_DECODE, "RSA decoding error"), \
PARA_ERROR(SB_PACKET_SIZE, "invalid sideband packet size or protocol error"), \
PARA_ERROR(SERVER_CMD_FAILURE, "command failed"), \
PARA_ERROR(SERVER_CMD_SUCCESS, "command terminated successfully"), \
PARA_ERROR(SERVER_CRASH, "para_server crashed -- can not live without it"), \
- PARA_ERROR(SERVER_EOF, "connection closed by para_server"), \
PARA_ERROR(SEXP_BUILD, "could not build S-expression"), \
PARA_ERROR(SEXP_DECRYPT, "could not decrypt S-expression"), \
PARA_ERROR(SEXP_ENCRYPT, "could not encrypt S-expression"), \
PARA_ERROR(TARGET_EXISTS, "requested target is already present"),\
PARA_ERROR(TARGET_NOT_FOUND, "requested target not found"), \
PARA_ERROR(TASK_STARTED, "task started"), \
+ PARA_ERROR(DEADLY_SIGNAL, "termination request by signal"), \
PARA_ERROR(TOO_MANY_CLIENTS, "maximal number of stat clients exceeded"), \
PARA_ERROR(UCRED_PERM, "permission denied"), \
PARA_ERROR(UDP_OVERRUN, "output buffer overrun"), \
PARA_ERROR(VORBIS_COMMENTHEADER, "could not create vorbis comment header"), \
PARA_ERROR(VORBIS, "vorbis synthesis header-in error (not vorbis?)"), \
PARA_ERROR(WAV_BAD_FC, "invalid filter configuration"), \
- PARA_ERROR(WAV_EOF, "wav filter: end of file"), \
PARA_ERROR(WAV_SUCCESS, "successfully wrote wav header"), \
PARA_ERROR(WMA_BAD_PARAMS, "invalid WMA parameters"), \
PARA_ERROR(WMA_BAD_SUPERFRAME, "invalid superframe"), \
PARA_ERROR(WMA_BLOCK_SIZE, "invalid block size"), \
- PARA_ERROR(WMADEC_EOF, "wmadec: end of file"), \
PARA_ERROR(WMA_NO_GUID, "audio stream guid not found"), \
PARA_ERROR(WMA_OUTPUT_SPACE, "insufficient output space"), \
- PARA_ERROR(WRITE_COMMON_EOF, "end of file"), \
/**
* This is temporarily defined to expand to its first argument (prefixed by
* 'E_') and gets later redefined to expand to the error text only
*/
#define PARA_ERROR(err, msg) E_ ## err
+/**
+ * Numeric error codes.
+ *
+ * Public functions which can fail return the negated value of one of the
+ * constants defined here to indicate the cause of the error.
+ *
+ * \sa \ref para_strerror().
+ */
enum para_error_codes {PARA_ERRORS};
#undef PARA_ERROR
#define PARA_ERROR(err, msg) msg
-/** Array of error strings. */
+/** All .c files need the declararation of the array of error strings. */
extern const char * const para_errlist[];
+/** Exactly one .c file per executable must define the array. */
#define DEFINE_PARA_ERRLIST const char * const para_errlist[] = {PARA_ERRORS}
+/** \endcond para_error */
/**
* This bit indicates whether a number is considered a system error number
*/
#define SYSTEM_ERROR_BIT 30
-/**
- * Like the SYSTEM_ERROR_BIT, but indicates an error from the osl library.
- */
+/** Like SYSTEM_ERROR_BIT, but for errors from the osl library. */
#define OSL_ERROR_BIT 29
+/** Like SYSTEM_ERROR_BIT, but for errors from the lopsub library. */
#define LLS_ERROR_BIT 28
/** Check whether the system error bit is set. */
*/
_static_inline_ const char *para_strerror(int num)
{
+ unsigned idx = num & ~((1U << OSL_ERROR_BIT) | (1U << LLS_ERROR_BIT)
+ | (1U << SYSTEM_ERROR_BIT));
assert(num > 0);
if (IS_OSL_ERROR(num)) {
assert(weak_osl_strerror);
- return weak_osl_strerror(num & ~(1U << OSL_ERROR_BIT));
+ return weak_osl_strerror(idx);
}
if (IS_LLS_ERROR(num)) {
assert(weak_lls_strerror);
- return weak_lls_strerror(num & ~(1U << LLS_ERROR_BIT));
+ return weak_lls_strerror(idx);
}
if (IS_SYSTEM_ERROR(num))
- return strerror(num & ~(1U << SYSTEM_ERROR_BIT));
- return para_errlist[num];
+ return strerror(idx);
+ return para_errlist[idx];
}
/**
/**
* Wrapper for lopsub library calls.
*
- * \param ret See osl().
- * \return See osl().
+ * \param ret See \ref osl().
+ * \return See \ref osl().
*/
_static_inline_ int lls(int ret)
{
projects / paraslash.git / blobdiff