Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 1 | #ifndef _OSMOCORE_LOGGING_H |
| 2 | #define _OSMOCORE_LOGGING_H |
| 3 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 4 | /*! \defgroup logging Osmocom logging framework |
| 5 | * @{ |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 6 | */ |
| 7 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 8 | /*! \file logging.h */ |
| 9 | |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 10 | #include <stdio.h> |
| 11 | #include <stdint.h> |
Pablo Neira Ayuso | 8341934 | 2011-03-22 16:36:13 +0100 | [diff] [blame] | 12 | #include <osmocom/core/linuxlist.h> |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 13 | |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 14 | /*! \brief Maximum number of logging contexts */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 15 | #define LOG_MAX_CTX 8 |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 16 | /*! \brief Maximum number of logging filters */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 17 | #define LOG_MAX_FILTERS 8 |
| 18 | |
| 19 | #define DEBUG |
| 20 | |
| 21 | #ifdef DEBUG |
| 22 | #define DEBUGP(ss, fmt, args...) logp(ss, __FILE__, __LINE__, 0, fmt, ## args) |
| 23 | #define DEBUGPC(ss, fmt, args...) logp(ss, __FILE__, __LINE__, 1, fmt, ## args) |
| 24 | #else |
| 25 | #define DEBUGP(xss, fmt, args...) |
| 26 | #define DEBUGPC(ss, fmt, args...) |
| 27 | #endif |
| 28 | |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 29 | |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 30 | void logp(int subsys, char *file, int line, int cont, const char *format, ...) __attribute__ ((format (printf, 5, 6))); |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 31 | |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 32 | /*! \brief Log a new message through the Osmocom logging framework |
| 33 | * \param[in] ss logging subsystem (e.g. \ref DLGLOBAL) |
| 34 | * \param[in] level logging level (e.g. \ref LOGL_NOTICE) |
| 35 | * \param[in] fmt format string |
| 36 | * \param[in] args variable argument list |
| 37 | */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 38 | #define LOGP(ss, level, fmt, args...) \ |
| 39 | logp2(ss, level, __FILE__, __LINE__, 0, fmt, ##args) |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 40 | |
| 41 | /*! \brief Continue a log message through the Osmocom logging framework |
| 42 | * \param[in] ss logging subsystem (e.g. \ref DLGLOBAL) |
| 43 | * \param[in] level logging level (e.g. \ref LOGL_NOTICE) |
| 44 | * \param[in] fmt format string |
| 45 | * \param[in] args variable argument list |
| 46 | */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 47 | #define LOGPC(ss, level, fmt, args...) \ |
| 48 | logp2(ss, level, __FILE__, __LINE__, 1, fmt, ##args) |
| 49 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 50 | /*! \brief different log levels */ |
| 51 | #define LOGL_DEBUG 1 /*!< \brief debugging information */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 52 | #define LOGL_INFO 3 |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 53 | #define LOGL_NOTICE 5 /*!< \brief abnormal/unexpected condition */ |
| 54 | #define LOGL_ERROR 7 /*!< \brief error condition, requires user action */ |
| 55 | #define LOGL_FATAL 8 /*!< \brief fatal, program aborted */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 56 | |
| 57 | #define LOG_FILTER_ALL 0x0001 |
| 58 | |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 59 | /* logging levels defined by the library itself */ |
| 60 | #define DLGLOBAL -1 |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 61 | #define DLLAPDM -2 |
Harald Welte | 892e621 | 2011-07-19 14:31:44 +0200 | [diff] [blame] | 62 | #define DLINP -3 |
| 63 | #define DLMUX -4 |
| 64 | #define DLMI -5 |
| 65 | #define DLMIB -6 |
Harald Welte | 2af4359 | 2011-07-29 15:12:41 +0200 | [diff] [blame] | 66 | #define OSMO_NUM_DLIB 6 |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 67 | |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 68 | struct log_category { |
| 69 | uint8_t loglevel; |
| 70 | uint8_t enabled; |
| 71 | }; |
| 72 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 73 | /*! \brief Information regarding one logging category */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 74 | struct log_info_cat { |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 75 | const char *name; /*!< name of category */ |
| 76 | const char *color; /*!< color string for cateyory */ |
| 77 | const char *description; /*!< description text */ |
| 78 | uint8_t loglevel; /*!< currently selected log-level */ |
| 79 | uint8_t enabled; /*!< is this category enabled or not */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 80 | }; |
| 81 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 82 | /*! \brief Log context information, passed to filter */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 83 | struct log_context { |
| 84 | void *ctx[LOG_MAX_CTX+1]; |
| 85 | }; |
| 86 | |
| 87 | struct log_target; |
| 88 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 89 | /*! \brief Log filter function */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 90 | typedef int log_filter(const struct log_context *ctx, |
| 91 | struct log_target *target); |
| 92 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 93 | /*! \brief Logging configuration, passed to \ref log_init */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 94 | struct log_info { |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 95 | /* \brief filter callback function */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 96 | log_filter *filter_fn; |
| 97 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 98 | /*! \brief per-category information */ |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 99 | struct log_info_cat *cat; |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 100 | /*! \brief total number of categories */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 101 | unsigned int num_cat; |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 102 | /*! \brief total number of user categories (not library) */ |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 103 | unsigned int num_cat_user; |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 104 | }; |
| 105 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 106 | /*! \brief Type of logging target */ |
Harald Welte | 2822296 | 2011-02-18 20:37:04 +0100 | [diff] [blame] | 107 | enum log_target_type { |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 108 | LOG_TGT_TYPE_VTY, /*!< \brief VTY logging */ |
| 109 | LOG_TGT_TYPE_SYSLOG, /*!< \brief syslog based logging */ |
| 110 | LOG_TGT_TYPE_FILE, /*!< \brief text file logging */ |
| 111 | LOG_TGT_TYPE_STDERR, /*!< \brief stderr logging */ |
Harald Welte | 2822296 | 2011-02-18 20:37:04 +0100 | [diff] [blame] | 112 | }; |
| 113 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 114 | /*! \brief structure representing a logging target */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 115 | struct log_target { |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 116 | struct llist_head entry; /*!< \brief linked list */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 117 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 118 | /*! \brief Internal data for filtering */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 119 | int filter_map; |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 120 | /*! \brief Internal data for filtering */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 121 | void *filter_data[LOG_MAX_FILTERS+1]; |
| 122 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 123 | /*! \brief logging categories */ |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 124 | struct log_category *categories; |
| 125 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 126 | /*! \brief global log level */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 127 | uint8_t loglevel; |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 128 | /*! \brief should color be used when printing log messages? */ |
Harald Welte | 87dbca1 | 2011-07-16 11:57:53 +0200 | [diff] [blame] | 129 | unsigned int use_color:1; |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 130 | /*! \brief should log messages be prefixed with a timestamp? */ |
Harald Welte | 87dbca1 | 2011-07-16 11:57:53 +0200 | [diff] [blame] | 131 | unsigned int print_timestamp:1; |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 132 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 133 | /*! \brief the type of this log taget */ |
Harald Welte | 2822296 | 2011-02-18 20:37:04 +0100 | [diff] [blame] | 134 | enum log_target_type type; |
| 135 | |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 136 | union { |
| 137 | struct { |
| 138 | FILE *out; |
Harald Welte | 72d0c53 | 2010-08-25 19:24:00 +0200 | [diff] [blame] | 139 | const char *fname; |
Harald Welte | 0083cd3 | 2010-08-25 14:55:44 +0200 | [diff] [blame] | 140 | } tgt_file; |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 141 | |
| 142 | struct { |
| 143 | int priority; |
Harald Welte | 2822296 | 2011-02-18 20:37:04 +0100 | [diff] [blame] | 144 | int facility; |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 145 | } tgt_syslog; |
| 146 | |
| 147 | struct { |
| 148 | void *vty; |
| 149 | } tgt_vty; |
| 150 | }; |
| 151 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 152 | /*! \brief call-back function to be called when the logging framework |
| 153 | * wants to log somethnig. |
| 154 | * \param[[in] target logging target |
| 155 | * \param[in] level log level of currnet message |
| 156 | * \param[in] string the string that is to be written to the log |
| 157 | */ |
Harald Welte | 76e72ab | 2011-02-17 15:52:39 +0100 | [diff] [blame] | 158 | void (*output) (struct log_target *target, unsigned int level, |
| 159 | const char *string); |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 160 | }; |
| 161 | |
| 162 | /* use the above macros */ |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 163 | void logp2(int subsys, unsigned int level, char *file, |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 164 | int line, int cont, const char *format, ...) |
| 165 | __attribute__ ((format (printf, 6, 7))); |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 166 | int log_init(const struct log_info *inf, void *talloc_ctx); |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 167 | |
| 168 | /* context management */ |
| 169 | void log_reset_context(void); |
| 170 | int log_set_context(uint8_t ctx, void *value); |
| 171 | |
| 172 | /* filter on the targets */ |
| 173 | void log_set_all_filter(struct log_target *target, int); |
| 174 | |
| 175 | void log_set_use_color(struct log_target *target, int); |
| 176 | void log_set_print_timestamp(struct log_target *target, int); |
| 177 | void log_set_log_level(struct log_target *target, int log_level); |
| 178 | void log_parse_category_mask(struct log_target *target, const char* mask); |
| 179 | int log_parse_level(const char *lvl); |
Harald Welte | 9ac2225 | 2010-05-11 11:19:40 +0200 | [diff] [blame] | 180 | const char *log_level_str(unsigned int lvl); |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 181 | int log_parse_category(const char *category); |
| 182 | void log_set_category_filter(struct log_target *target, int category, |
| 183 | int enable, int level); |
| 184 | |
| 185 | /* management of the targets */ |
| 186 | struct log_target *log_target_create(void); |
Harald Welte | 72d0c53 | 2010-08-25 19:24:00 +0200 | [diff] [blame] | 187 | void log_target_destroy(struct log_target *target); |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 188 | struct log_target *log_target_create_stderr(void); |
Harald Welte | 72d0c53 | 2010-08-25 19:24:00 +0200 | [diff] [blame] | 189 | struct log_target *log_target_create_file(const char *fname); |
Harald Welte | 46cfd77 | 2011-02-17 15:56:56 +0100 | [diff] [blame] | 190 | struct log_target *log_target_create_syslog(const char *ident, int option, |
| 191 | int facility); |
Harald Welte | 72d0c53 | 2010-08-25 19:24:00 +0200 | [diff] [blame] | 192 | int log_target_file_reopen(struct log_target *tgt); |
| 193 | |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 194 | void log_add_target(struct log_target *target); |
| 195 | void log_del_target(struct log_target *target); |
| 196 | |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 197 | /* Generate command string for VTY use */ |
| 198 | const char *log_vty_command_string(const struct log_info *info); |
| 199 | const char *log_vty_command_description(const struct log_info *info); |
Harald Welte | 7638af9 | 2010-05-11 16:39:22 +0200 | [diff] [blame] | 200 | |
Harald Welte | 2822296 | 2011-02-18 20:37:04 +0100 | [diff] [blame] | 201 | struct log_target *log_target_find(int type, const char *fname); |
| 202 | extern struct llist_head osmo_log_target_list; |
| 203 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 204 | /*! }@ */ |
| 205 | |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 206 | #endif /* _OSMOCORE_LOGGING_H */ |