error.h

   1 /* Copyright (C) 2006 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
   2
   3 /** \file error.h List of error codes and messages. */
   4
   5 /** \cond para_error */
   6 /** Codes and messages. */
   7 #define PARA_ERRORS \
   8         PARA_ERROR(SUCCESS, "success"), \
   9         PARA_ERROR(AACDEC_INIT, "failed to init aac decoder"), \
  10         PARA_ERROR(AAC_DECODE, "aac decode error"), \
  11         PARA_ERROR(ACL_PERM, "access denied by acl"), \
  12         PARA_ERROR(ADDRESS_LOOKUP, "can not resolve requested address"),\
  13         PARA_ERROR(AFH_RECV_BAD_FILENAME, "no file name given"), \
  14         PARA_ERROR(AFS_SHORT_READ, "short read from afs socket"), \
  15         PARA_ERROR(AFS_SIGNAL, "afs caught deadly signal"), \
  16         PARA_ERROR(AFS_SOCKET, "afs socket not writable"), \
  17         PARA_ERROR(ALSA, "alsa error"), \
  18         PARA_ERROR(ALSA_MIX_GET_VAL, "could not read control element state"), \
  19         PARA_ERROR(ALSA_MIX_OPEN, "could not open mixer"), \
  20         PARA_ERROR(ALSA_MIX_RANGE, "value control element out of range"), \
  21         PARA_ERROR(ALSA_MIX_SET_VAL, "could not set control element state"), \
  22         PARA_ERROR(AMP_ZERO_AMP, "no amplification necessary"), \
  23         PARA_ERROR(AO_APPEND_OPTION, "ao append option: memory allocation failure"), \
  24         PARA_ERROR(AO_BAD_DRIVER, "ao: invalid driver"), \
  25         PARA_ERROR(AO_BAD_OPTION, "ao option is not of type key:value"), \
  26         PARA_ERROR(AO_DEFAULT_DRIVER, "ao: no usable output device"), \
  27         PARA_ERROR(AO_FILE_NOT_SUPP, "ao: file io drivers not supported"), \
  28         PARA_ERROR(AO_OPEN_LIVE, "ao: could not open audio device"), \
  29         PARA_ERROR(AO_PLAY, "ao_play() failed"), \
  30         PARA_ERROR(AO_PTHREAD, "pthread error"), \
  31         PARA_ERROR(ASN1_PARSE, "could not parse ASN.1 key"), \
  32         PARA_ERROR(ATOI_JUNK_AT_END, "further characters after number"), \
  33         PARA_ERROR(ATOI_NO_DIGITS, "no digits found in string"), \
  34         PARA_ERROR(ATOI_OVERFLOW, "value too large"), \
  35         PARA_ERROR(ATTR_SYNTAX, "attribute syntax error"), \
  36         PARA_ERROR(ATT_TABLE_FULL, "no more space left in attribute table"), \
  37         PARA_ERROR(AUDIOD_OFF, "audiod switched off"), \
  38         PARA_ERROR(AUDIOD_SIGNAL, "caught deadly signal"), \
  39         PARA_ERROR(AUDIOD_TERM, "terminating on user request"), \
  40         PARA_ERROR(AUDIO_FORMAT, "audio format not recognized"), \
  41         PARA_ERROR(AUTH_REQUEST, "did not receive auth request"), \
  42         PARA_ERROR(BAD_AFSI, "invalid afs info"), \
  43         PARA_ERROR(BAD_ASF_FILE_PROPS, "invalid ASF file properties"), \
  44         PARA_ERROR(BAD_AUTH, "authentication failure"), \
  45         PARA_ERROR(BAD_BAND, "invalid or unexpected band designator"), \
  46         PARA_ERROR(BAD_CHANNEL_COUNT, "channel count not supported"), \
  47         PARA_ERROR(BAD_CHANNEL, "invalid channel"), \
  48         PARA_ERROR(BAD_CT, "invalid chunk table or bad FEC configuration"), \
  49         PARA_ERROR(BAD_FEATURE, "invalid feature request"), \
  50         PARA_ERROR(BAD_FEC_HEADER, "invalid fec header"), \
  51         PARA_ERROR(BAD_MOP, "invalid mood or playlist"), \
  52         PARA_ERROR(BAD_PATH, "invalid path"), \
  53         PARA_ERROR(BAD_PRIVATE_KEY, "invalid private key"), \
  54         PARA_ERROR(BAD_SAMPLE_FORMAT, "sample format not supported"), \
  55         PARA_ERROR(BAD_SAMPLERATE, "sample rate not supported"), \
  56         PARA_ERROR(BAD_SLICE_NUM, "invalid slice number"), \
  57         PARA_ERROR(BAD_SLICE_SIZE, "slice size zero or too large"), \
  58         PARA_ERROR(BAD_SORT, "invalid sorting method"), \
  59         PARA_ERROR(BAD_TABLE_NAME, "invalid table"), \
  60         PARA_ERROR(BAD_USER, "auth request for invalid user"), \
  61         PARA_ERROR(BASE64, "failed to base64-decode ssh public key"), \
  62         PARA_ERROR(BIGNUM, "bignum error"), \
  63         PARA_ERROR(BLINDING, "failed to activate key blinding"), \
  64         PARA_ERROR(BLOB_SYNTAX, "blob syntax error"), \
  65         PARA_ERROR(BTR_NAVAIL, "btr node: value currently unavailable"), \
  66         PARA_ERROR(BTR_NO_CHILD, "btr node has no children"), \
  67         PARA_ERROR(CHILD_CONTEXT, "now running in child context"), \
  68         PARA_ERROR(CHMOD, "failed to set socket mode"), \
  69         PARA_ERROR(CLIENT_SYNTAX, "syntax error"), \
  70         PARA_ERROR(CLIENT_WRITE, "client write error"), \
  71         PARA_ERROR(COMMAND_SYNTAX, "syntax error in command"), \
  72         PARA_ERROR(CREATE_OPUS_DECODER, "could not create opus decoder"), \
  73         PARA_ERROR(DCCP_OVERRUN, "dccp output buffer buffer overrun"), \
  74         PARA_ERROR(DECRYPT, "decrypt error"), \
  75         PARA_ERROR(DUMMY_ROW, "attempted to access blob dummy object"), \
  76         PARA_ERROR(DUP_PIPE, "exec error: can not create pipe"), \
  77         PARA_ERROR(EMPTY, "file is empty"), \
  78         PARA_ERROR(ENCRYPT, "encrypt error"), \
  79         PARA_ERROR(EOF, "end of file"), \
  80         PARA_ERROR(EOP, "end of playlist"), \
  81         PARA_ERROR(FEC_BAD_IDX, "invalid index vector"), \
  82         PARA_ERROR(FECDEC_OVERRUN, "fecdec output buffer overrun"), \
  83         PARA_ERROR(FEC_PARMS, "invalid fec parameters"), \
  84         PARA_ERROR(FEC_PIVOT, "pivot column not found"), \
  85         PARA_ERROR(FEC_SINGULAR, "unexpected singular matrix"), \
  86         PARA_ERROR(FFT_BAD_PARAMS, "invalid params for fft"), \
  87         PARA_ERROR(FGETS, "fgets error"), \
  88         PARA_ERROR(FLAC_AFH_DECODER_ALLOC, "could not allocate stream decoder"), \
  89         PARA_ERROR(FLAC_AFH_DECODER_INIT, "could not init stream decoder"), \
  90         PARA_ERROR(FLAC_CHAIN_ALLOC, "could not create metadata chain"), \
  91         PARA_ERROR(FLAC_CHAIN_READ, "could not read meta chain"), \
  92         PARA_ERROR(FLACDEC_DECODER_ALLOC, "could not allocate stream decoder"), \
  93         PARA_ERROR(FLACDEC_DECODER_INIT, "could not init stream decoder"), \
  94         PARA_ERROR(FLAC_DECODE_POS, "could not get decode position"), \
  95         PARA_ERROR(FLAC_ITER_ALLOC, "could not allocate meta iterator"), \
  96         PARA_ERROR(FLAC_REPLACE_COMMENT, "could not replace vorbis comment"), \
  97         PARA_ERROR(FLAC_SKIP_META, "could not skip metadata"), \
  98         PARA_ERROR(FLAC_STREAMINFO, "could not read stream info meta block"), \
  99         PARA_ERROR(FLAC_VARBLOCK, "variable blocksize not supported"), \
 100         PARA_ERROR(FLAC_WRITE_CHAIN, "failed to write metadata chain"), \
 101         PARA_ERROR(FNMATCH, "fnmatch error"), \
 102         PARA_ERROR(FRAME, "invalid mp3 frame"), \
 103         PARA_ERROR(FRAME_LENGTH, "invalid frame length"), \
 104         PARA_ERROR(GC_SYNTAX, "grab client syntax error"), \
 105         PARA_ERROR(GC_WRITE, "grab client write error"), \
 106         PARA_ERROR(GUI_SIGCHLD, "received SIGCHLD"), \
 107         PARA_ERROR(HASH_MISMATCH, "hash mismatch, consider re-add"), \
 108         PARA_ERROR(HEADER_BITRATE, "invalid header bitrate"), \
 109         PARA_ERROR(HEADER_FREQ, "invalid header frequency"), \
 110         PARA_ERROR(HTTP_RECV_OVERRUN, "http_recv: output buffer overrun"), \
 111         PARA_ERROR(I9E_SETUPTERM, "failed to set up terminal"), \
 112         PARA_ERROR(I9E_TERM_RQ, "received termination request"), \
 113         PARA_ERROR(ID3_ATTACH, "could not attach id3 frame"), \
 114         PARA_ERROR(ID3_DETACH, "could not detach id3 frame"), \
 115         PARA_ERROR(ID3_SETENCODING, "could not set id3 text encoding field"), \
 116         PARA_ERROR(ID3_SETSTRING, "could not set id3 string field"), \
 117         PARA_ERROR(INCOHERENT_BLOCK_LEN, "incoherent block length"), \
 118         PARA_ERROR(KEY_MARKER, "invalid/missing key header or footer"), \
 119         PARA_ERROR(KEY_PERM, "unprotected private key"), \
 120         PARA_ERROR(LIBSAMPLERATE, "secret rabbit code error"), \
 121         PARA_ERROR(LOCALTIME, "localtime() failed"), \
 122         PARA_ERROR(LOCK, "lock error"), \
 123         PARA_ERROR(MAD_FRAME_DECODE, "mad frame decode error"), \
 124         PARA_ERROR(MAKESOCK, "makesock error"), \
 125         PARA_ERROR(MAX_CLIENTS, "maximal number of clients exceeded"), \
 126         PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
 127         PARA_ERROR(MOOD_PARSE, "mood parse error"), \
 128         PARA_ERROR(MP3DEC_CORRUPT, "too many corrupt frames"), \
 129         PARA_ERROR(MP3_INFO, "could not read mp3 info"), \
 130         PARA_ERROR(MP4_READ, "mp4: read error or unexpected end of file"), \
 131         PARA_ERROR(MP4_CORRUPT, "invalid/corrupt mp4 file"), \
 132         PARA_ERROR(MP4_BAD_SAMPLE, "mp4: invalid sample number"), \
 133         PARA_ERROR(MP4_BAD_SAMPLERATE, "mp4: invalid sample rate"), \
 134         PARA_ERROR(MP4_BAD_SAMPLE_COUNT, "mp4: invalid number of samples"), \
 135         PARA_ERROR(MP4_TRACK, "mp4: no audio track"), \
 136         PARA_ERROR(MP4_MISSING_ATOM, "mp4: essential atom not found"), \
 137         PARA_ERROR(MPI_SCAN, "could not scan multi-precision integer"), \
 138         PARA_ERROR(NAME_TOO_LONG, "name too long for struct sockaddr_un"), \
 139         PARA_ERROR(NO_AFHI, "audio format handler info required"), \
 140         PARA_ERROR(NO_ATTRIBUTES, "no attributes defined yet"), \
 141         PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
 142         PARA_ERROR(NOFD, "did not receive open fd from afs"), \
 143         PARA_ERROR(NO_MATCH, "no matches"), \
 144         PARA_ERROR(NO_MORE_SLOTS, "no more empty slots"), \
 145         PARA_ERROR(NOT_PLAYING, "not playing"), \
 146         PARA_ERROR(NO_VALID_FILES, "no valid file found in playlist"), \
 147         PARA_ERROR(NO_WMA, "asf/wma format not recognized"), \
 148         PARA_ERROR(OGGDEC_BADHEADER, "invalid vorbis bitstream header"), \
 149         PARA_ERROR(OGGDEC_BADLINK, "invalid stream section or requested link corrupt"), \
 150         PARA_ERROR(OGGDEC_FAULT, "bug or heap/stack corruption"), \
 151         PARA_ERROR(OGGDEC_NOTVORBIS, "bitstream is not vorbis data"), \
 152         PARA_ERROR(OGGDEC_READ, "read from media returned an error"), \
 153         PARA_ERROR(OGGDEC_VERSION, "vorbis version mismatch"), \
 154         PARA_ERROR(OGG_EMPTY, "no ogg pages found"), \
 155         PARA_ERROR(OGG_PACKET_IN, "ogg_stream_packetin() failed"), \
 156         PARA_ERROR(OGG_SYNC, "internal ogg storage overflow"), \
 157         PARA_ERROR(OPENSSH_PARSE, "could not parse openssh private key"), \
 158         PARA_ERROR(OPUS_COMMENT, "invalid or corrupted opus comment"), \
 159         PARA_ERROR(OPUS_DECODE, "opus decode error"), \
 160         PARA_ERROR(OPUS_HEADER, "invalid opus header"), \
 161         PARA_ERROR(OPUS_SET_GAIN, "opus: could not set gain"), \
 162         PARA_ERROR(PATH_FOUND, ""), /* not really an error */ \
 163         PARA_ERROR(PLAYLIST_EMPTY, "attempted to load empty playlist"), \
 164         PARA_ERROR(PREBUFFER_SUCCESS, "prebuffering complete"), \
 165         PARA_ERROR(PRIVATE_KEY, "can not read private key"), \
 166         PARA_ERROR(QUEUE, "packet queue overrun"), \
 167         PARA_ERROR(READ_PATTERN, "did not read expected pattern"), \
 168         PARA_ERROR(RECVMSG, "recvmsg() failed"), \
 169         PARA_ERROR(REGEX, "regular expression error"), \
 170         PARA_ERROR(RSA, "RSA error"), \
 171         PARA_ERROR(RSA_DECODE, "RSA decoding error"), \
 172         PARA_ERROR(SB_PACKET_SIZE, "invalid sideband packet size or protocol error"), \
 173         PARA_ERROR(SCM_CREDENTIALS, "did not receive SCM credentials"), \
 174         PARA_ERROR(SENDER_CMD, "command not supported by this sender"), \
 175         PARA_ERROR(SENDMSG, "sendmsg() failed"), \
 176         PARA_ERROR(SERVER_CMD_FAILURE, "command failed"), \
 177         PARA_ERROR(SERVER_CMD_SUCCESS, "command terminated successfully"), \
 178         PARA_ERROR(SERVER_CRASH, "para_server crashed -- can not live without it"), \
 179         PARA_ERROR(SEXP_BUILD, "could not build S-expression"), \
 180         PARA_ERROR(SEXP_DECRYPT, "could not decrypt S-expression"), \
 181         PARA_ERROR(SEXP_ENCRYPT, "could not encrypt S-expression"), \
 182         PARA_ERROR(SEXP_FIND, "could not find sublist in S-expression"), \
 183         PARA_ERROR(SHORT_WRITE, "unexpected short write"), \
 184         PARA_ERROR(SIZE_PREFIX, "bad size prefix"), \
 185         PARA_ERROR(SPX_COMMENT, "invalid speex comment"), \
 186         PARA_ERROR(SPX_CTL_BAD_RQ, "speex_decoder_ctl: invalid request"), \
 187         PARA_ERROR(SPX_CTL_INVAL, "speex_decoder_ctl: invalid argument"), \
 188         PARA_ERROR(SPX_DECODE_OVERFLOW, "speex decoding overflow"), \
 189         PARA_ERROR(SPX_DECODER_INIT, "speex decoder initialization failed"), \
 190         PARA_ERROR(SPX_DECODE, "speex decoding error"), \
 191         PARA_ERROR(SPX_EOS, "speex: end of stream"), \
 192         PARA_ERROR(SPX_HEADER, "can not read speex header"), \
 193         PARA_ERROR(SPX_HEADER_MODE, "invalid speex mode in header"), \
 194         PARA_ERROR(SPX_VERSION, "incompatible speex bit stream version"), \
 195         PARA_ERROR(SSH_KEY_HEADER, "ssh key header not found"), \
 196         PARA_ERROR(SSH_PARSE, "could not parse ssh public key"), \
 197         PARA_ERROR(STAT_ITEM_PARSE, "failed to parse status item"), \
 198         PARA_ERROR(STATUS_TIMEOUT, "status item timeout"), \
 199         PARA_ERROR(STREAM_PACKETIN, "ogg stream packet-in error"), \
 200         PARA_ERROR(STREAM_PACKETOUT, "ogg stream packet-out error"), \
 201         PARA_ERROR(STREAM_PAGEIN, "ogg stream page-in error"), \
 202         PARA_ERROR(STREAM_PAGEOUT, "ogg stream page-out error"), \
 203         PARA_ERROR(STRFTIME, "strftime() failed"), \
 204         PARA_ERROR(SYNC_COMPLETE, "all buddies in sync"), \
 205         PARA_ERROR(SYNC_LISTEN_FD, "no fd to listen on"), \
 206         PARA_ERROR(SYNC_PAGEOUT, "ogg sync page-out error (no ogg file?)"), \
 207         PARA_ERROR(TARGET_EXISTS, "requested target is already present"),\
 208         PARA_ERROR(TARGET_NOT_FOUND, "requested target not found"), \
 209         PARA_ERROR(TASK_STARTED, "task started"), \
 210         PARA_ERROR(DEADLY_SIGNAL, "termination request by signal"), \
 211         PARA_ERROR(TOO_MANY_CLIENTS, "maximal number of stat clients exceeded"), \
 212         PARA_ERROR(UCRED_PERM, "permission denied"), \
 213         PARA_ERROR(UDP_OVERRUN, "output buffer overrun"), \
 214         PARA_ERROR(UNKNOWN_STAT_ITEM, "status item not recognized"), \
 215         PARA_ERROR(UNSUPPORTED_AUDIO_FORMAT, "given audio format not supported"), \
 216         PARA_ERROR(UNSUPPORTED_FILTER, "given filter not supported"), \
 217         PARA_ERROR(USERLIST, "failed to open user list file"), \
 218         PARA_ERROR(VLC, "invalid vlc code"), \
 219         PARA_ERROR(VORBIS_COMMENTHEADER, "could not create vorbis comment header"), \
 220         PARA_ERROR(VORBIS, "vorbis synthesis header-in error (not vorbis?)"), \
 221         PARA_ERROR(WAV_BAD_FC, "invalid filter configuration"), \
 222         PARA_ERROR(WAV_SUCCESS, "successfully wrote wav header"), \
 223         PARA_ERROR(WMA_BAD_PARAMS, "invalid WMA parameters"), \
 224         PARA_ERROR(WMA_BAD_SUPERFRAME, "invalid superframe"), \
 225         PARA_ERROR(WMA_BLOCK_SIZE, "invalid block size"), \
 226         PARA_ERROR(WMA_NO_GUID, "audio stream guid not found"), \
 227         PARA_ERROR(WMA_OUTPUT_SPACE, "insufficient output space"), \
 228
 229 /**
 230  * This is temporarily defined to expand to its first argument (prefixed by
 231  * 'E_') and gets later redefined to expand to the error text only
 232  */
 233 #define PARA_ERROR(err, msg) E_ ## err
 234 /**
 235  * Numeric error codes.
 236  *
 237  * Public functions which can fail return the negated value of one of the
 238  * constants defined here to indicate the cause of the error.
 239  *
 240  * \sa \ref para_strerror().
 241  */
 242 enum para_error_codes {PARA_ERRORS};
 243 #undef PARA_ERROR
 244 #define PARA_ERROR(err, msg) msg
 245 /** All .c files need the declararation of the array of error strings. */
 246 extern const char * const para_errlist[];
 247 /** Exactly one .c file per executable must define the array. */
 248 #define DEFINE_PARA_ERRLIST const char * const para_errlist[] = {PARA_ERRORS}
 249 /** \endcond para_error */
 250
 251 /**
 252  * This bit indicates whether a number is considered a system error number
 253  * If yes, the system errno is just the result of clearing this bit from
 254  * the given number.
 255  */
 256 #define SYSTEM_ERROR_BIT 30
 257
 258 /** Like SYSTEM_ERROR_BIT, but for errors from the osl library. */
 259 #define OSL_ERROR_BIT 29
 260
 261 /** Like SYSTEM_ERROR_BIT, but for errors from the lopsub library. */
 262 #define LLS_ERROR_BIT 28
 263
 264 /** Check whether the system error bit is set. */
 265 #define IS_SYSTEM_ERROR(num) (!!((num) & (1 << SYSTEM_ERROR_BIT)))
 266
 267 /** Check whether the osl error bit is set. */
 268 #define IS_OSL_ERROR(num) (!!((num) & (1 << OSL_ERROR_BIT)))
 269
 270 /** Check whether the lopsub error bit is set. */
 271 #define IS_LLS_ERROR(num) (!!((num) & (1 << LLS_ERROR_BIT)))
 272
 273 /** Set the system error bit for the given number. */
 274 #define ERRNO_TO_PARA_ERROR(num) ((num) | (1 << SYSTEM_ERROR_BIT))
 275
 276 /** Set the osl error bit for the given number. */
 277 #define OSL_ERRNO_TO_PARA_ERROR(num) ((num) | (1 << OSL_ERROR_BIT))
 278
 279 /** Set the lopsub error bit for the error code. */
 280 #define LLS_ERRNO_TO_PARA_ERROR(num) ((num) | (1 << LLS_ERROR_BIT))
 281
 282 static const char *weak_osl_strerror(int) __attribute__ ((weakref("osl_strerror")));
 283 static const char *weak_lls_strerror(int) __attribute__ ((weakref("lls_strerror")));
 284 /**
 285  * Paraslash's version of strerror(3).
 286  *
 287  * \param num The error number.
 288  *
 289  * \return The error text of \a num.
 290  */
 291 _static_inline_ const char *para_strerror(int num)
 292 {
 293         unsigned idx = num & ~((1U << OSL_ERROR_BIT) | (1U << LLS_ERROR_BIT)
 294                 | (1U << SYSTEM_ERROR_BIT));
 295         assert(num > 0);
 296         if (IS_OSL_ERROR(num)) {
 297                 assert(weak_osl_strerror);
 298                 return weak_osl_strerror(idx);
 299         }
 300         if (IS_LLS_ERROR(num)) {
 301                 assert(weak_lls_strerror);
 302                 return weak_lls_strerror(idx);
 303         }
 304         if (IS_SYSTEM_ERROR(num))
 305                 return strerror(idx);
 306         return para_errlist[idx];
 307 }
 308
 309 /**
 310  * Wrapper for osl library calls.
 311  *
 312  * \param ret The return value of an osl library function.
 313  *
 314  * This should be used for all calls to osl functions that return an osl error
 315  * code. It changes the return value appropriately so that it can be used for
 316  * printing the correct error message with para_strerror().
 317  *
 318  * \return \a ret if \a ret >= 0, a paraslash error code otherwise.
 319  */
 320 _static_inline_ int osl(int ret)
 321 {
 322         if (ret >= 0)
 323                 return ret;
 324         return -OSL_ERRNO_TO_PARA_ERROR(-ret);
 325 }
 326
 327 /**
 328  * Wrapper for lopsub library calls.
 329  *
 330  * \param ret See \ref osl().
 331  * \return See \ref osl().
 332  */
 333 _static_inline_ int lls(int ret)
 334 {
 335         if (ret >= 0)
 336                 return ret;
 337         return -LLS_ERRNO_TO_PARA_ERROR(-ret);
 338 }