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