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