1

#ifndef LOG_H

     2

#define LOG_H

     3

     4

/** @file log.h

     5

 *

     6

 * Local logging functions

     7

 */

     8

#include "error.h"

     9

    10

/**

    11

 * Log level definitions

    12

 *

    13

 * XXX: these names conflict with <syslog.h>

    14

 */

    15

enum log_level {

    16

    LOG_DEBUG,

    17

    LOG_INFO,

    18

    LOG_WARN,

    19

    LOG_ERROR,

    20

    LOG_FATAL,

    21

};

    22

    23

/**

    24

 * List of log_level values as strings, NULL-terminated

    25

 */

    26

extern const char *log_level_names[];

    27

    28

/**

    29

 * The default log level

    30

 */

    31

#define LOG_LEVEL_DEFAULT LOG_INFO

    32

    33

/**

    34

 * Maximum length of a log message, including terminating NUL

    35

 */

    36

#define LOG_MSG_MAX 1024

    37

    38

/**

    39

 * Log output function, for displaying a line of text, without any trailing newline.

    40

 */

    41

typedef void (*log_output_func) (const char *line, void *arg);

    42

    43

/**

    44

 * Set the current log level to filter out messages below the given level

    45

 */

    46

void set_log_level (enum log_level level);

    47

    48

/**

    49

 * Set the current log output function, replacing any default or previous value.

    50

 *

    51

 * Pass in func as NULL to revert to the default handler.

    52

 */

    53

void log_set_func (log_output_func func, void *arg);

    54

    55

/**

    56

 * Log a message with the given level

    57

 */

    58

void log_msg (enum log_level level, const char *func, const char *format, ...)

    59

    __attribute__ ((format (printf, 3, 4)));

    60

    61

/**

    62

 * Shorthand for log_msg

    63

 */

    64

#define log_debug(...) log_msg(LOG_DEBUG, __func__, __VA_ARGS__)

    65

#define log_info(...)  log_msg(LOG_INFO,  __func__, __VA_ARGS__)

    66

#define log_warn(...)  log_msg(LOG_WARN,  __func__, __VA_ARGS__)

    67

#define log_error(...) log_msg(LOG_ERROR, __func__, __VA_ARGS__)

    68

#define log_fatal(...) log_msg(LOG_FATAL, __func__, __VA_ARGS__)

    69

    70

/**

    71

 * Log a message with the given level, appending the formatted error code name

    72

 */

    73

void _log_err_code (enum log_level level, err_t err, const char *func, const char *format, ...)

    74

    __attribute__ ((format (printf, 4, 5)));

    75

    76

/**

    77

 * Log a message with the given level, appending the formatted error message

    78

 */

    79

void _log_err (enum log_level level, const error_t *err, const char *func, const char *format, ...)

    80

    __attribute__ ((format (printf, 4, 5)));

    81

    82

/**

    83

 * Log using errno.

    84

 */

    85

void _log_perr (enum log_level level, const char *func, const char *format, ...)

    86

    __attribute__ ((format (printf, 3, 4)));

    87

    88

/**

    89

 * Shorthand for _log_*

    90

 *

    91

 * XXX: kill log_err_info, add log_err_code

    92

 */

    93

#define log_err(err_code, ...) _log_err_code(LOG_ERROR, err_code, __func__, __VA_ARGS__)

    94

#define log_err_info(err_info, ...) _log_err(LOG_ERROR, err_info, __func__, __VA_ARGS__)

    95

#define log_perr(...) _log_perr(LOG_ERROR, __func__, __VA_ARGS__)

    96

    97

#define log_warn_err_code(err_code, ...) _log_err_code(LOG_WARN, err_code, __func__, __VA_ARGS__)

    98

#define log_warn_err(err_info, ...) _log_err(LOG_WARN, err_info, __func__, __VA_ARGS__)

    99

   100

/**

   101

 * log_fatal + exit failure

   102

 */

   104

   105

/**

   106

 * log_err + exit failure

   107

 */

   109

   110

/**

   111

 * log_err_info + exit failure

   112

 */

   114

   115

/**

   116

 * log_perr + exit failure

   117

 */

   119

   120

#endif /* LOG_H */