error.h

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