1

#ifndef ERROR_H

     2

#define ERROR_H

     3

     4

/*

     5

 * Error-handling functions

     6

 */

     7

#include <errno.h>

     8

     9

/*

    10

 * Type used for error codes is an explicitly *unsigned* int, meaning that error codes themselves are positive.

    11

 * Negative error codes also exist in some places, and they are just a negative err_t.

    12

 */

    13

typedef unsigned int err_t;

    14

    15

/*

    16

 * List of defined error codes, organized mostly by function name

    17

 */

    18

enum error_code {

    19

    /* Core functions */

    20

    ERR_CALLOC                  = 0x000100,

    21

    22

    /* Network resolver errors */

    23

    ERR_GETADDRINFO             = 0x000200,

    24

    ERR_GETADDRINFO_EMPTY       = 0x000201,     /* No valid results */

    25

    26

    /* Low-level network errors */

    27

    ERR_SOCKET                  = 0x000301,

    28

    ERR_CONNECT                 = 0x000302,

    29

    30

    /* Low-level IO errors */

    31

    ERR_READ                    = 0x000401,

    32

    ERR_WRITE                   = 0x000402,

    33

    34

    /* GnuTLS errors */

    35

    ERR_GNUTLS_CERT_ALLOC_CRED  = 0x010101,

    36

    ERR_GNUTLS_GLOBAL_INIT      = 0x010102,

    41

};

    42

    43

/*

    44

 * An error code and associated extra infos

    45

 */

    46

struct error_info {

    47

    /* The base error code */

    48

    err_t code;

    49

    50

    /* Additional detail info, usually some third-part error code */

    51

    unsigned int extra;

    52

};

    53

    54

/** No error, evaulates as logical false */

    55

#define SUCCESS (0)

    56

    57

/* Evaulates to error_info.code as lvalue */

    58

#define ERROR_CODE(err_info_ptr) ((err_info_ptr)->code)

    59

    60

/* Evaulates to error_info.extra as lvalue */

    61

#define ERROR_EXTRA(err_info_ptr) ((err_info_ptr)->extra)

    62

    63

/* Set error_info.code to SUCCESS, evaulates as zero */

    64

#define RESET_ERROR(err_info_ptr) ((err_info_ptr)->code = SUCCESS)

    65

    66

/* Compare error_info.code != 0 */

    67

#define IS_ERROR(err_info_ptr) (!!(err_info_ptr)->code)

    68

    69

/* Set error_info.code, but leave err_extra as-is. Evaluates to err_code */

    70

#define SET_ERROR(err_info_ptr, err_code) ((err_info_ptr)->code = (err_code))

    71

    72

/* Set error_info.code/extra. XXX: should evaluate to err_code */

    73

#define _SET_ERROR_EXTRA(err_info_ptr, err_code, err_extra) (err_info_ptr)->code = (err_code); (err_info_ptr)->extra = (err_extra)

    74

#define SET_ERROR_EXTRA(err_info_ptr, err_code, err_extra) do { _SET_ERROR_EXTRA(err_info_ptr, err_code, err_extra); } while (0)

    75

    77

#define _SET_ERROR_ERRNO(err_info_ptr, err_code) _SET_ERROR_EXTRA(err_info_ptr, err_code, errno);

    78

#define SET_ERROR_ERRNO(err_info_ptr, err_code) SET_ERROR_EXTRA(err_info_ptr, err_code, errno);

    79

    85

#define RETURN_SET_ERROR_EXTRA(err_info_ptr, err_code, err_extra) do { _SET_ERROR_EXTRA(err_info_ptr, err_code, err_extra); return (err_code); } while (0)

    86

#define RETURN_SET_ERROR_ERRNO(err_info_ptr, err_code) do { _SET_ERROR_ERRNO(err_info_ptr, err_code); return (err_code); } while (0)

    87

    92

#endif