1

#ifndef SHARED_LOG_H

     2

#define SHARED_LOG_H

     3

     4

#include <stdarg.h>

     5

     6

/**

     7

 * Log level definitions

     8

 *

     9

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

    10

 */

    11

enum log_level {

    12

    LOG_DEBUG,

    13

    LOG_INFO,

    14

    LOG_WARN,

    15

    LOG_ERROR,

    16

    LOG_FATAL,

    17

};

    18

    19

/**

    20

 * List of log_level values as strings, NULL-terminated

    21

 */

    22

extern const char *log_level_names[];

    23

    24

/**

    25

 * The default log level

    26

 */

    27

#define LOG_LEVEL_DEFAULT LOG_INFO

    28

    29

/**

    30

 * Maximum length of a log message, including terminating NUL

    31

 */

    32

#define LOG_MSG_MAX 1024

    33

    34

/**

    35

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

    36

 */

    37

void set_log_level (enum log_level level);

    38

/**

    39

 * Internal logging func, meant for using custom level tags. This performs the filtering of log levels.

    40

 *

    41

 * Format the full output line, and pass it to the log_output_func. The line will be of the form:

    42

 *  "[<tag>] <func> : <user_fmt> [ <log_fmt> ]"

    43

 */

    44

void log_output_tag (enum log_level level, const char *tag, const char *func, const char *user_fmt, va_list user_fmtargs, const char *log_fmt, ...)

    45

    __attribute__ ((format (printf, 6, 7)));

    46

    47

/**

    48

 * va_list version of log_output_tag

    49

 */

    50

void log_output_tag_va (enum log_level level, const char *tag, const char *func, const char *user_fmt, va_list user_fmtargs, const char *log_fmt, va_list log_fmtargs);

    51

    52

/**

    53

 * Log a message with the given level

    54

 */

    55

#define log_msg(level, ...) _log_msg(level, __func__, __VA_ARGS__)

    56

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

    57

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

    58

    59

/**

    60

 * Log a message with the given level with the given format and varargs

    61

 */

    62

#define log_msg_va2(level, fmt1, vargs1, fmt2, vargs2) _log_msg_va(level, __func__, fmt1, vargs1, fmt2, vargs2)

    63

void _log_msg_va2 (enum log_level level, const char *func, const char *fmt1, va_list fmtargs1, const char *fmt2, va_list fmtargs2);

    64

    65

    66

/**

    67

 * Shorthand for log_msg

    68

 */

    69

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

    70

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

    71

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

    72

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

    73

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

    74

    75

/**

    76

 * Log using errno.

    77

 */

    78

#define log_errno(...) _log_errno(LOG_ERROR, __func__, __VA_ARGS__)

    79

#define log_warn_errno(...) _log_errno(LOG_WARN, __func__, __VA_ARGS__)

    80

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

    81

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

    82

    83

/**

    84

 * Log with an [EXIT] tag at given level, and then exit with given exit code

    85

 */

    86

#define log_exit(level, exit_code, ...) _log_exit(level, exit_code, __func__, __VA_ARGS__)

    87

void _log_exit (enum log_level level, int exit_code, const char *func, const char *format, ...)

    88

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

    89

    __attribute__ ((noreturn));

    90

    91

// for abort()

    92

#include <stdlib.h>

    93

    94

/**

    95

 * log_fatal + exit failure

    96

 */

    97

#define FATAL(...) do { log_fatal(__VA_ARGS__); abort(); } while (0)

    98

    99

/**

   100

 * log_perr + exit failure

   101

 */

   102

#define FATAL_ERRNO(...) do { _log_errno(LOG_FATAL, __func__, __VA_ARGS__); abort(); } while (0)

   103

   104

/**

   105

 * Exit with given code, also logging a message at LOG_... with an [EXIT] tag

   106

 */

   107

#define EXIT_INFO(exit_code, ...)  log_exit(LOG_INFO,  exit_code, __VA_ARGS__)

   108

#define EXIT_WARN(exit_code, ...)  log_exit(LOG_WARN,  exit_code, __VA_ARGS__)

   109

#define EXIT_ERROR(exit_code, ...) log_exit(LOG_ERROR, exit_code, __VA_ARGS__)

   110

#define EXIT_FATAL(exit_code, ...) log_exit(LOG_FATAL, exit_code, __VA_ARGS__)

   111

   112

#endif /* LOG_H */