error.h

   1 /*
   2  * Copyright (C) 2006-2011 Andre Noll <maan@systemlinux.org>
   3  *
   4  * Licensed under the GPL v2. For licencing details see COPYING.
   5  */
   6
   7 /** \file error.h List of error messages for all subsystems. */
   8
   9 /** \cond errors */
  10
  11 /* List of all subsystems that use paraslash's error facility. */
  12 DEFINE_ERRLIST_OBJECT_ENUM;
  13
  14 /* these do not need error handling (yet) */
  15 #define SERVER_ERRORS
  16 #define TIME_ERRORS
  17 #define CLOSE_ON_FORK_ERRORS
  18 #define DAEMON_ERRORS
  19 #define GUI_ERRORS
  20 #define RINGBUFFER_ERRORS
  21 #define SCORE_ERRORS
  22 #define RBTREE_ERRORS
  23 #define RECV_ERRORS
  24 #define IPC_ERRORS
  25 #define DCCP_SEND_ERRORS
  26 #define HTTP_SEND_ERRORS
  27 #define GGO_ERRORS
  28 #define COLOR_ERRORS
  29 #define SIGNAL_ERRORS
  30 #define FADE_ERRORS
  31 #define SERVER_COMMAND_LIST_ERRORS
  32 #define AFS_COMMAND_LIST_ERRORS
  33 #define AUDIOD_COMMAND_LIST_ERRORS
  34 #define STDOUT_ERRORS
  35 #define FILE_WRITE_ERRORS
  36 #define STDIN_ERRORS
  37 #define WRITE_ERRORS
  38
  39 extern const char **para_errlist[];
  40
  41 #define OGG_AFH_COMMON_ERRORS \
  42         PARA_ERROR(STREAM_PACKETOUT, "ogg stream packet-out error (first packet)"), \
  43         PARA_ERROR(SYNC_PAGEOUT, "ogg sync page-out error (no ogg file?)"), \
  44         PARA_ERROR(STREAM_PAGEIN, "ogg stream page-in error (first page)"), \
  45         PARA_ERROR(OGG_SYNC, "internal ogg storage overflow"), \
  46         PARA_ERROR(OGG_EMPTY, "no ogg pages found"), \
  47
  48
  49 #define SPX_AFH_ERRORS \
  50         PARA_ERROR(SPX_COMMENT, "invalid speex comment"), \
  51
  52
  53 #define SPX_COMMON_ERRORS \
  54         PARA_ERROR(SPX_HEADER, "can not read speex header"), \
  55         PARA_ERROR(SPX_HEADER_MODE, "invalid speex mode in header"), \
  56         PARA_ERROR(SPX_VERSION, "incompatible speex bit stream version"), \
  57         PARA_ERROR(SPX_DECODER_INIT, "speex decoder initialization failed"), \
  58         PARA_ERROR(SPX_CTL_BAD_RQ, "speex_decoder_ctl: invalid request"), \
  59         PARA_ERROR(SPX_CTL_INVAL, "speex_decoder_ctl: invalid argument"), \
  60
  61 #define SPXDEC_FILTER_ERRORS \
  62         PARA_ERROR(SPX_DECODE, "speex decoding error"), \
  63         PARA_ERROR(SPX_DECODE_OVERFLOW, "speex decoding overflow"), \
  64         PARA_ERROR(SPX_EOS, "speex: end of stream"), \
  65
  66 #define BUFFER_TREE_ERRORS \
  67         PARA_ERROR(BTR_EOF, "buffer tree: end of file"), \
  68         PARA_ERROR(BTR_NO_CHILD, "btr node has no children"), \
  69         PARA_ERROR(BTR_NAVAIL, "btr node: value currently unavailable"), \
  70
  71
  72 #define BITSTREAM_ERRORS \
  73         PARA_ERROR(VLC, "invalid vlc code"), \
  74
  75
  76 #define WMA_AFH_ERRORS \
  77         PARA_ERROR(NO_WMA, "asf/wma format not recognized"), \
  78
  79
  80 #define WMA_COMMON_ERRORS \
  81         PARA_ERROR(WMA_NO_GUID, "audio stream guid not found"), \
  82
  83
  84 #define WMADEC_FILTER_ERRORS \
  85         PARA_ERROR(WMA_BAD_PARAMS, "invalid WMA parameters"), \
  86         PARA_ERROR(WMA_OUTPUT_SPACE, "insufficient output space"), \
  87         PARA_ERROR(WMA_BAD_SUPERFRAME, "invalid superframe"), \
  88         PARA_ERROR(WMA_BLOCK_SIZE, "invalid block size"), \
  89         PARA_ERROR(INCOHERENT_BLOCK_LEN, "incoherent block length"), \
  90         PARA_ERROR(WMADEC_EOF, "wmadec: end of file"), \
  91
  92
  93 #define IMDCT_ERRORS \
  94         PARA_ERROR(FFT_BAD_PARAMS, "invalid params for fft"), \
  95
  96
  97 #define PREBUFFER_FILTER_ERRORS \
  98         PARA_ERROR(PREBUFFER_SYNTAX, "syntax error in prebuffer filter config"), \
  99         PARA_ERROR(PREBUFFER_SUCCESS, "prebuffering complete"), \
 100
 101
 102 #define OSS_WRITE_ERRORS \
 103         PARA_ERROR(BAD_SAMPLE_FORMAT, "sample format not supported"), \
 104         PARA_ERROR(BAD_CHANNEL_COUNT, "channel count not supported"), \
 105         PARA_ERROR(BAD_SAMPLERATE, "sample rate not supported"), \
 106
 107
 108 #define AO_WRITE_ERRORS \
 109         PARA_ERROR(AO_DEFAULT_DRIVER, "ao: no usable output device"), \
 110         PARA_ERROR(AO_BAD_DRIVER, "ao: invalid driver"), \
 111         PARA_ERROR(AO_BAD_OPTION, "ao option is not of type key:value"), \
 112         PARA_ERROR(AO_APPEND_OPTION, "ao append option: memory allocation failure"), \
 113         PARA_ERROR(AO_OPEN_LIVE, "ao: could not open audio device"), \
 114         PARA_ERROR(AO_FILE_NOT_SUPP, "ao: file io drivers not supported"), \
 115         PARA_ERROR(AO_PLAY, "ao_play() failed"), \
 116         PARA_ERROR(AO_BAD_SAMPLE_FORMAT, "ao: unsigned sample formats not supported"), \
 117         PARA_ERROR(AO_PTHREAD, "pthread error"), \
 118
 119
 120 #define COMPRESS_FILTER_ERRORS \
 121         PARA_ERROR(COMPRESS_SYNTAX, "syntax error in compress filter config"), \
 122         PARA_ERROR(COMPRESS_EOF, "compress: end of file"), \
 123
 124
 125 #define WAV_FILTER_ERRORS \
 126         PARA_ERROR(WAV_BAD_FC, "invalid filter configuration"), \
 127         PARA_ERROR(WAV_EOF, "wav filter: end of file"), \
 128         PARA_ERROR(WAV_SUCCESS, "successfully wrote wav header"), \
 129
 130
 131 #define FEC_ERRORS \
 132         PARA_ERROR(FEC_BAD_IDX, "invalid index vector"), \
 133         PARA_ERROR(FEC_SINGULAR, "unexpected singular matrix"), \
 134         PARA_ERROR(FEC_PIVOT, "pivot column not found"), \
 135         PARA_ERROR(FEC_PARMS, "invalid fec parameters"), \
 136
 137
 138 #define FECDEC_FILTER_ERRORS \
 139         PARA_ERROR(BAD_FEC_HEADER, "invalid fec header"), \
 140         PARA_ERROR(BAD_SLICE_SIZE, "slice size zero or too large"), \
 141         PARA_ERROR(BAD_SLICE_NUM, "invalid slice number"), \
 142         PARA_ERROR(FECDEC_OVERRUN, "fecdec output buffer overrun"), \
 143         PARA_ERROR(FECDEC_EOF, "received eof packet"), \
 144
 145
 146 #define AMP_FILTER_ERRORS \
 147         PARA_ERROR(AMP_SYNTAX, "syntax error in amp filter config"), \
 148         PARA_ERROR(AMP_ZERO_AMP, "no amplification necessary"), \
 149         PARA_ERROR(AMP_EOF, "amp: end of file"), \
 150
 151
 152 #define SEND_COMMON_ERRORS \
 153         PARA_ERROR(MAX_CLIENTS, "maximal number of clients exceeded"), \
 154
 155
 156 #define CLIENT_ERRORS \
 157         PARA_ERROR(TASK_STARTED, "task started"), \
 158
 159
 160 #define AFH_ERRORS \
 161         PARA_ERROR(AFH_SYNTAX, "afh syntax error"), \
 162         PARA_ERROR(AFH_SHORT_WRITE, "afh short write"), \
 163
 164
 165 #define AFH_COMMON_ERRORS \
 166         PARA_ERROR(AUDIO_FORMAT, "audio format not recognized"), \
 167
 168
 169 #define ACL_ERRORS \
 170         PARA_ERROR(ACL_PERM, "access denied by acl"), \
 171
 172
 173 #define AFS_ERRORS \
 174         PARA_ERROR(BAD_TABLE_NAME, "invalid table"), \
 175         PARA_ERROR(AFS_SYNTAX, "afs syntax error"), \
 176         PARA_ERROR(AFS_SIGNAL, "afs caught deadly signal"), \
 177         PARA_ERROR(AFS_SOCKET, "afs socket not writable"), \
 178
 179
 180 #define MOOD_ERRORS \
 181         PARA_ERROR(NO_MOOD, "no mood available"), \
 182         PARA_ERROR(DUMMY_ROW, "attempted to access blob dummy object"), \
 183
 184
 185 #define MM_ERRORS \
 186         PARA_ERROR(MOOD_SYNTAX, "mood syntax error"), \
 187
 188
 189 #define ATTRIBUTE_ERRORS \
 190         PARA_ERROR(ATTR_SYNTAX, "attribute syntax error"), \
 191         PARA_ERROR(NO_ATTRIBUTES, "no attributes defined yet"), \
 192         PARA_ERROR(ATT_TABLE_FULL, "no more space left in attribute table"), \
 193
 194
 195 #define BLOB_ERRORS \
 196         PARA_ERROR(BLOB_SYNTAX, "blob syntax error"), \
 197         PARA_ERROR(INPUT_TOO_LARGE, "input too large for stdin command"), \
 198
 199
 200 #define PLAYLIST_ERRORS \
 201         PARA_ERROR(PLAYLIST_LOADED, ""), /* not really an error */ \
 202         PARA_ERROR(PATH_FOUND, ""), /* not really an error */ \
 203         PARA_ERROR(PLAYLIST_EMPTY, "attempted to load empty playlist"), \
 204
 205
 206 #define AFT_ERRORS \
 207         PARA_ERROR(BAD_AFSI, "invaiid afs info"), \
 208         PARA_ERROR(LOCALTIME, "localtime() failed"), \
 209         PARA_ERROR(STRFTIME, "strftime() failed"), \
 210         PARA_ERROR(BAD_PATH, "invalid path"), \
 211         PARA_ERROR(BAD_SORT, "invalid sorting method"), \
 212         PARA_ERROR(FNMATCH, "fnmatch error"), \
 213         PARA_ERROR(NO_AFHI, "audio format handler info required"), \
 214         PARA_ERROR(AFT_SYNTAX, "audio file table syntax error"), \
 215         PARA_ERROR(HASH_MISMATCH, "hash mismatch, consider re-add"), \
 216
 217
 218 #define USER_LIST_ERRORS \
 219         PARA_ERROR(USERLIST, "failed to open user list file"), \
 220
 221
 222 #define OSX_WRITE_ERRORS \
 223         PARA_ERROR(STREAM_FORMAT, "could not set stream format"), \
 224         PARA_ERROR(ADD_CALLBACK, "can not add callback"), \
 225         PARA_ERROR(OPEN_COMP, "OpenAComponent() error"), \
 226         PARA_ERROR(UNIT_INIT, "AudioUnitInitialize() error"), \
 227         PARA_ERROR(UNIT_START, "AudioUnitStart() error"), \
 228         PARA_ERROR(DEFAULT_COMP, "can not find default audio output component"), \
 229
 230
 231 #define AUDIOC_ERRORS \
 232         PARA_ERROR(AUDIOC_SYNTAX, "audioc syntax error"), \
 233
 234
 235 #define CLIENT_COMMON_ERRORS \
 236         PARA_ERROR(CLIENT_SYNTAX, "syntax error"), \
 237         PARA_ERROR(NO_CONFIG, "config file not found"), \
 238         PARA_ERROR(BAD_CONFIG, "syntax error in config file"), \
 239         PARA_ERROR(CLIENT_AUTH, "authentication failed"), \
 240         PARA_ERROR(SERVER_EOF, "connection closed by para_server"), \
 241
 242
 243 #define SCHED_ERRORS \
 244         PARA_ERROR(NOT_INITIALIZED, "scheduler not yet initialized"), \
 245         PARA_ERROR(SCHED_SHUTDOWN, "scheduler was shut down"), \
 246
 247
 248 #define NET_ERRORS \
 249         PARA_ERROR(NAME_TOO_LONG, "name too long for struct sockaddr_un"), \
 250         PARA_ERROR(ADDRESS_LOOKUP, "can not resolve requested address"),\
 251         PARA_ERROR(CHMOD, "failed to set socket mode"), \
 252         PARA_ERROR(SENDMSG, "sendmsg() failed"), \
 253         PARA_ERROR(RECVMSG, "recvmsg() failed"), \
 254         PARA_ERROR(SCM_CREDENTIALS, "did not receive SCM credentials"), \
 255         PARA_ERROR(MAKESOCK, "makesock error"), \
 256
 257
 258 #define UDP_RECV_ERRORS \
 259         PARA_ERROR(UDP_SYNTAX, "udp_recv syntax error"), \
 260         PARA_ERROR(UDP_OVERRUN, "output buffer overrun"), \
 261
 262
 263 #define UDP_SEND_ERRORS \
 264         PARA_ERROR(TARGET_EXISTS, "requested target is already present"),\
 265         PARA_ERROR(TARGET_NOT_FOUND, "requested target not found")
 266
 267
 268 #define HTTP_RECV_ERRORS \
 269         PARA_ERROR(HTTP_RECV_OVERRUN, "http_recv: output buffer overrun"), \
 270
 271
 272 #define RECV_COMMON_ERRORS \
 273         PARA_ERROR(RECV_SYNTAX, "recv syntax error"), \
 274         PARA_ERROR(RECV_EOF, "end of file"), \
 275
 276
 277 #define AUDIOD_ERRORS \
 278         PARA_ERROR(NO_MORE_SLOTS, "no more empty slots"), \
 279         PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
 280         PARA_ERROR(UNSUPPORTED_AUDIO_FORMAT, "given audio format not supported"), \
 281         PARA_ERROR(NOT_PLAYING, "not playing"), \
 282         PARA_ERROR(AUDIOD_OFF, "audiod switched off"), \
 283         PARA_ERROR(STATUS_TIMEOUT, "timeout reading server status"), \
 284
 285
 286 #define AUDIOD_COMMAND_ERRORS \
 287         PARA_ERROR(CLIENT_WRITE, "client write error"), \
 288         PARA_ERROR(UCRED_PERM, "permission denied"), \
 289         PARA_ERROR(INVALID_AUDIOD_CMD, "invalid command"), \
 290         PARA_ERROR(TOO_MANY_CLIENTS, "maximal number of stat clients exceeded"), \
 291         PARA_ERROR(UNKNOWN_STAT_ITEM, "status item not recognized"), \
 292
 293
 294 #define FILTER_COMMON_ERRORS \
 295         PARA_ERROR(BAD_FILTER_OPTIONS, "invalid filter option given"), \
 296         PARA_ERROR(UNSUPPORTED_FILTER, "given filter not supported"), \
 297
 298
 299 #define STAT_ERRORS \
 300         PARA_ERROR(STAT_ITEM_PARSE, "failed to parse status item"), \
 301
 302
 303 #define OGGDEC_FILTER_ERRORS \
 304         PARA_ERROR(OGGDEC_READ, "read from media returned an error"), \
 305         PARA_ERROR(OGGDEC_NOTVORBIS, "bitstream is not vorbis data"), \
 306         PARA_ERROR(OGGDEC_VERSION, "vorbis version mismatch"), \
 307         PARA_ERROR(OGGDEC_BADHEADER, "invalid vorbis bitstream header"), \
 308         PARA_ERROR(OGGDEC_FAULT, "bug or heap/stack corruption"), \
 309         PARA_ERROR(OGGDEC_BADLINK, "invalid stream section or requested link corrupt"), \
 310
 311
 312 #define GRAB_CLIENT_ERRORS \
 313         PARA_ERROR(GC_WRITE, "grab client write error"), \
 314         PARA_ERROR(GC_SYNTAX, "grab client syntax error"), \
 315
 316
 317 #define MP3DEC_FILTER_ERRORS \
 318         PARA_ERROR(MAD_FRAME_DECODE, "mad frame decode error"), \
 319         PARA_ERROR(MP3DEC_SYNTAX, "syntax error in mp3dec config"), \
 320         PARA_ERROR(MP3DEC_EOF, "mp3dec: end of file"), \
 321         PARA_ERROR(MP3DEC_CORRUPT, "too many corrupt frames"), \
 322
 323
 324 #define FILTER_ERRORS \
 325         PARA_ERROR(NO_FILTERS, "at least one filter must be given"), \
 326         PARA_ERROR(FILTER_SYNTAX, "syntax error"), \
 327
 328
 329 #define STRING_ERRORS \
 330         PARA_ERROR(ATOI_OVERFLOW, "value too large"), \
 331         PARA_ERROR(STRTOLL, "unknown strtoll error"), \
 332         PARA_ERROR(ATOI_NO_DIGITS, "no digits found in string"), \
 333         PARA_ERROR(ATOI_JUNK_AT_END, "further characters after number"), \
 334         PARA_ERROR(SIZE_PREFIX, "bad size prefix"), \
 335         PARA_ERROR(REGEX, "regular expression error") \
 336
 337
 338 #define EXEC_ERRORS \
 339         PARA_ERROR(DUP_PIPE, "exec error: can not create pipe"), \
 340
 341
 342 #define MP3_AFH_ERRORS \
 343         PARA_ERROR(FRAME, "invalid mp3 frame"), \
 344         PARA_ERROR(FRAME_LENGTH, "invalid frame length"), \
 345         PARA_ERROR(MP3_INFO, "could not read mp3 info"), \
 346         PARA_ERROR(HEADER_FREQ, "invalid header frequency"), \
 347         PARA_ERROR(HEADER_BITRATE, "invalid header bitrate"), \
 348
 349
 350 #define AAC_AFH_ERRORS \
 351         PARA_ERROR(STSZ, "did not find stcz atom"), \
 352         PARA_ERROR(MP4ASC, "audio spec config error"), \
 353         PARA_ERROR(AAC_AFH_INIT, "failed to init aac decoder"), \
 354
 355
 356 #define AAC_COMMON_ERRORS \
 357         PARA_ERROR(ESDS, "did not find esds atom"), \
 358         PARA_ERROR(STCO, "did not find stco atom"), \
 359
 360
 361 #define OGG_AFH_ERRORS \
 362         PARA_ERROR(VORBIS, "vorbis synthesis header-in error (not vorbis?)"), \
 363         PARA_ERROR(OGG_PACKET_IN, "ogg_stream_packetin() failed"), \
 364         PARA_ERROR(OGG_STREAM_FLUSH, "ogg_stream_flush() failed"), \
 365
 366
 367 #define VSS_ERRORS \
 368         PARA_ERROR(NOFD, "did not receive open fd from afs"), \
 369         PARA_ERROR(BAD_CT, "invalid chunk table or bad FEC configuration"), \
 370         PARA_ERROR(AFS_SHORT_READ, "short read from afs socket"), \
 371
 372
 373 #define CRYPT_COMMON_ERRORS \
 374         PARA_ERROR(SSH_KEY_HEADER, "ssh key header not found"), \
 375         PARA_ERROR(BASE64, "failed to base64-decode ssh public key"), \
 376         PARA_ERROR(KEY_PERM, "unprotected private key"), \
 377
 378
 379 #define CRYPT_ERRORS \
 380         PARA_ERROR(PRIVATE_KEY, "can not read private key"), \
 381         PARA_ERROR(PUBLIC_KEY, "can not read public key"), \
 382         PARA_ERROR(RSA, "RSA error"), \
 383         PARA_ERROR(ENCRYPT, "encrypt error"), \
 384         PARA_ERROR(DECRYPT, "decrypt error"), \
 385         PARA_ERROR(BLINDING, "failed to activate key blinding"), \
 386         PARA_ERROR(BIGNUM, "bignum error"), \
 387
 388 #define GCRYPT_ERRORS \
 389         PARA_ERROR(MPI_SCAN, "could not scan multi-precision integer"), \
 390         PARA_ERROR(MPI_PRINT, "could not convert multi-precision integer"), \
 391         PARA_ERROR(SEXP_FIND, "could not find sublist in S-expression"), \
 392         PARA_ERROR(SEXP_BUILD, "could not build S-expression"), \
 393         PARA_ERROR(SEXP_ENCRYPT, "could not encrypt S-expression"), \
 394         PARA_ERROR(SEXP_DECRYPT, "could not decrypt S-expression"), \
 395         PARA_ERROR(MD_OPEN, "could not open message digest object"), \
 396         PARA_ERROR(CIPHER_OPEN, "could not create stream cipher handle"), \
 397         PARA_ERROR(BAD_PRIVATE_KEY, "invalid private key"), \
 398         PARA_ERROR(KEY_MARKER, "invalid/missing key header or footer"), \
 399         PARA_ERROR(ASN1_PARSE, "could not parse ASN.1 key"), \
 400         PARA_ERROR(SSH_PARSE, "could not parse ssh public key"), \
 401         PARA_ERROR(OEAP, "error during oeap (un)padding"), \
 402
 403
 404 #define COMMAND_ERRORS \
 405         PARA_ERROR(COMMAND_SYNTAX, "syntax error in command"), \
 406         PARA_ERROR(AUTH_REQUEST, "did not receive auth request"), \
 407         PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
 408         PARA_ERROR(BAD_CMD, "invalid command"), \
 409         PARA_ERROR(PERM, "permission denied"), \
 410         PARA_ERROR(LOCK, "lock error"), \
 411         PARA_ERROR(SENDER_CMD, "command not supported by this sender"), \
 412         PARA_ERROR(SERVER_CRASH, "para_server crashed -- can not live without it"), \
 413         PARA_ERROR(BAD_USER, "auth request for invalid user"), \
 414         PARA_ERROR(BAD_AUTH, "authentication failure"), \
 415
 416
 417 #define DCCP_RECV_ERRORS \
 418         PARA_ERROR(DCCP_OVERRUN, "dccp output buffer buffer overrun"), \
 419
 420
 421 #define FD_ERRORS \
 422         PARA_ERROR(FGETS, "fgets error"), \
 423         PARA_ERROR(EOF, "end of file"), \
 424         PARA_ERROR(READ_PATTERN, "did not read expected pattern"), \
 425
 426
 427 #define ALSA_WRITE_ERRORS \
 428         PARA_ERROR(ALSA, "alsa error"), \
 429
 430
 431 #define WRITE_COMMON_ERRORS \
 432         PARA_ERROR(WRITE_COMMON_EOF, "end of file"), \
 433
 434
 435 #define AACDEC_FILTER_ERRORS \
 436         PARA_ERROR(AACDEC_INIT, "failed to init aac decoder"), \
 437         PARA_ERROR(AAC_DECODE, "aac decode error"), \
 438
 439
 440 #define CHUNK_QUEUE_ERRORS \
 441         PARA_ERROR(QUEUE, "packet queue overrun"), \
 442
 443
 444 /** \endcond errors */
 445
 446 /**
 447  * The subsystem shift.
 448  *
 449  * 255 error codes ought to be enough for every subsystem. Use the higher bits
 450  * of the return value to encode the subsystem number.
 451  */
 452 #define SS_SHIFT 8
 453
 454 /**
 455  * Compute the subsystem offset.
 456  *
 457  * It is given by x * 2**8 where \a x is the subsystem number.
 458  */
 459 #define SS_OFFSET(ss) (SS_ ## ss << SS_SHIFT)
 460
 461 /**
 462  * Make the enum of all errors of one subsystem.
 463  *
 464  * As zero should not be an error, we define a dummy enum entry with value
 465  * 2**ss. That lets the real errors start at 2**ss + 1.
 466  */
 467 #define SS_ENUM(ss) enum {\
 468         E_ ## ss ## _DUMMY = SS_OFFSET(ss), \
 469         ss ## _ERRORS}
 470
 471 /**
 472  * Determine the subsystem number from the error number.
 473  *
 474  * Easy, it's just \a num / 2**8.
 475  */
 476 #define ERRNUM_TO_SS(num) ((num) >> SS_SHIFT)
 477
 478 /**
 479  * Determine the index of an error number.
 480  *
 481  * Also easy: It's the lower 8 bits of num.
 482  */
 483 #define ERRNUM_TO_INDEX(num) (((1 << SS_SHIFT) - 1) & (num))
 484
 485 /**
 486  * This bit indicates whether a number is considered a system error number
 487  * If yes, the system errno is just the result of clearing this bit from
 488  * the given number.
 489  */
 490 #define SYSTEM_ERROR_BIT 30
 491
 492 /**
 493  * Like the SYSTEM_ERROR_BIT, but indicates an error from the osl library.
 494  */
 495 #define OSL_ERROR_BIT 29
 496
 497 /** Check whether the system error bit is set. */
 498 #define IS_SYSTEM_ERROR(num) (!!((num) & (1 << SYSTEM_ERROR_BIT)))
 499
 500 /** Check whether the osl error bit is set. */
 501 #define IS_OSL_ERROR(num) (!!((num) & (1 << OSL_ERROR_BIT)))
 502
 503 /** Set the system error bit for the given number. */
 504 #define ERRNO_TO_PARA_ERROR(num) ((num) | (1 << SYSTEM_ERROR_BIT))
 505
 506 /** Set the osl error bit for the given number. */
 507 #define OSL_ERRNO_TO_PARA_ERROR(num) ((num) | (1 << OSL_ERROR_BIT))
 508
 509 /** Check whether a given number is a system error number.
 510  *
 511  * \param num The value to be checked.
 512  * \param _errno The system error number.
 513  *
 514  * \return True if \a num is paraslash's representation of the system
 515  * error identified by \a _errno.
 516  */
 517 _static_inline_ int is_errno(int num, int _errno)
 518 {
 519         assert(num > 0 && _errno > 0);
 520         return ERRNO_TO_PARA_ERROR(_errno) == num;
 521 }
 522
 523 /**
 524  * Paraslash's version of strerror(3).
 525  *
 526  * \param num The error number.
 527  *
 528  * \return The error text of \a num.
 529  */
 530 _static_inline_ const char *para_strerror(int num)
 531 {
 532         assert(num > 0);
 533 #ifdef _OSL_H
 534         if (IS_OSL_ERROR(num))
 535                 return osl_strerror(num & ((1 << OSL_ERROR_BIT) - 1));
 536 #endif
 537         if (IS_SYSTEM_ERROR(num))
 538                 return strerror(num & ((1 << SYSTEM_ERROR_BIT) - 1));
 539         return para_errlist[ERRNUM_TO_SS(num)][ERRNUM_TO_INDEX(num)];
 540 }
 541
 542 /**
 543  * Wrapper for osl library calls.
 544  *
 545  * \param ret The return value of an osl library function.
 546  *
 547  * This should be used for all calls to osl functions that return an osl error
 548  * code. It changes the return value appropriately so that it can be used for
 549  * printing the correct error message vi para_strerror().
 550  *
 551  * \return \a ret if \a ret >= 0, a paraslash error code otherwise.
 552  */
 553 _static_inline_ int osl(int ret)
 554 {
 555         if (ret >= 0)
 556                 return ret;
 557         return -OSL_ERRNO_TO_PARA_ERROR(-ret);
 558 }
 559
 560 /**
 561  * Define the error list for one subsystem.
 562  #
 563  * The first entry (index 0) is always the name of the subsystem
 564  * Used by macros in config.h (generated by configure).
 565  */
 566 #define DEFINE_ERRLIST(ss) const char * ss ## _ERRLIST[] = {#ss, ss ## _ERRORS}
 567
 568 /**
 569  * Activate errors for one subsystem.
 570  *
 571  * Each executable needs only the error lists of those subsystems it is
 572  * actually linked with. We always reserve space for NUM_SS char pointers,
 573  * but only init those of the needed subsystems. This macro is used by macros
 574  * in config.h (generated by configure).
 575  */
 576 #define PARA_ERRLIST(ss) [SS_ ## ss] = ss ## _ERRLIST
 577
 578 /**
 579  * This is temporarily defined to expand to its first argument (prefixed by
 580  * 'E_') and gets later redefined to expand to the error text only
 581  */
 582 #define PARA_ERROR(err, msg) E_ ## err
 583 #include "error2.h"
 584 #undef PARA_ERROR
 585 /* Rest of the world only sees the error text. */
 586 #define PARA_ERROR(err, msg) msg