error.h

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