Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 1 | #ifndef _OSMOCORE_LOGGING_H |
| 2 | #define _OSMOCORE_LOGGING_H |
| 3 | |
| 4 | #include <stdio.h> |
| 5 | #include <stdint.h> |
Pablo Neira Ayuso | 8341934 | 2011-03-22 16:36:13 +0100 | [diff] [blame] | 6 | #include <osmocom/core/linuxlist.h> |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 7 | |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 8 | #define LOG_MAX_CTX 8 |
| 9 | #define LOG_MAX_FILTERS 8 |
| 10 | |
| 11 | #define DEBUG |
| 12 | |
| 13 | #ifdef DEBUG |
| 14 | #define DEBUGP(ss, fmt, args...) logp(ss, __FILE__, __LINE__, 0, fmt, ## args) |
| 15 | #define DEBUGPC(ss, fmt, args...) logp(ss, __FILE__, __LINE__, 1, fmt, ## args) |
| 16 | #else |
| 17 | #define DEBUGP(xss, fmt, args...) |
| 18 | #define DEBUGPC(ss, fmt, args...) |
| 19 | #endif |
| 20 | |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 21 | |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame^] | 22 | 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] | 23 | |
| 24 | /* new logging interface */ |
| 25 | #define LOGP(ss, level, fmt, args...) \ |
| 26 | logp2(ss, level, __FILE__, __LINE__, 0, fmt, ##args) |
| 27 | #define LOGPC(ss, level, fmt, args...) \ |
| 28 | logp2(ss, level, __FILE__, __LINE__, 1, fmt, ##args) |
| 29 | |
| 30 | /* different levels */ |
| 31 | #define LOGL_DEBUG 1 /* debugging information */ |
| 32 | #define LOGL_INFO 3 |
| 33 | #define LOGL_NOTICE 5 /* abnormal/unexpected condition */ |
| 34 | #define LOGL_ERROR 7 /* error condition, requires user action */ |
| 35 | #define LOGL_FATAL 8 /* fatal, program aborted */ |
| 36 | |
| 37 | #define LOG_FILTER_ALL 0x0001 |
| 38 | |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame^] | 39 | /* logging levels defined by the library itself */ |
| 40 | #define DLGLOBAL -1 |
| 41 | #define OSMO_NUM_DLIB 1 |
| 42 | |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 43 | struct log_category { |
| 44 | uint8_t loglevel; |
| 45 | uint8_t enabled; |
| 46 | }; |
| 47 | |
| 48 | struct log_info_cat { |
| 49 | const char *name; |
| 50 | const char *color; |
| 51 | const char *description; |
| 52 | uint8_t loglevel; |
| 53 | uint8_t enabled; |
| 54 | }; |
| 55 | |
| 56 | /* log context information, passed to filter */ |
| 57 | struct log_context { |
| 58 | void *ctx[LOG_MAX_CTX+1]; |
| 59 | }; |
| 60 | |
| 61 | struct log_target; |
| 62 | |
| 63 | typedef int log_filter(const struct log_context *ctx, |
| 64 | struct log_target *target); |
| 65 | |
| 66 | struct log_info { |
| 67 | /* filter callback function */ |
| 68 | log_filter *filter_fn; |
| 69 | |
| 70 | /* per-category information */ |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame^] | 71 | struct log_info_cat *cat; |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 72 | unsigned int num_cat; |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame^] | 73 | unsigned int num_cat_user; |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 74 | }; |
| 75 | |
Harald Welte | 2822296 | 2011-02-18 20:37:04 +0100 | [diff] [blame] | 76 | enum log_target_type { |
| 77 | LOG_TGT_TYPE_VTY, |
| 78 | LOG_TGT_TYPE_SYSLOG, |
| 79 | LOG_TGT_TYPE_FILE, |
| 80 | LOG_TGT_TYPE_STDERR, |
| 81 | }; |
| 82 | |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 83 | struct log_target { |
| 84 | struct llist_head entry; |
| 85 | |
| 86 | int filter_map; |
| 87 | void *filter_data[LOG_MAX_FILTERS+1]; |
| 88 | |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame^] | 89 | struct log_category *categories; |
| 90 | |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 91 | uint8_t loglevel; |
| 92 | int use_color:1; |
| 93 | int print_timestamp:1; |
| 94 | |
Harald Welte | 2822296 | 2011-02-18 20:37:04 +0100 | [diff] [blame] | 95 | enum log_target_type type; |
| 96 | |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 97 | union { |
| 98 | struct { |
| 99 | FILE *out; |
Harald Welte | 72d0c53 | 2010-08-25 19:24:00 +0200 | [diff] [blame] | 100 | const char *fname; |
Harald Welte | 0083cd3 | 2010-08-25 14:55:44 +0200 | [diff] [blame] | 101 | } tgt_file; |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 102 | |
| 103 | struct { |
| 104 | int priority; |
Harald Welte | 2822296 | 2011-02-18 20:37:04 +0100 | [diff] [blame] | 105 | int facility; |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 106 | } tgt_syslog; |
| 107 | |
| 108 | struct { |
| 109 | void *vty; |
| 110 | } tgt_vty; |
| 111 | }; |
| 112 | |
Harald Welte | 76e72ab | 2011-02-17 15:52:39 +0100 | [diff] [blame] | 113 | void (*output) (struct log_target *target, unsigned int level, |
| 114 | const char *string); |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 115 | }; |
| 116 | |
| 117 | /* use the above macros */ |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame^] | 118 | void logp2(int subsys, unsigned int level, char *file, |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 119 | int line, int cont, const char *format, ...) |
| 120 | __attribute__ ((format (printf, 6, 7))); |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame^] | 121 | int log_init(const struct log_info *inf, void *talloc_ctx); |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 122 | |
| 123 | /* context management */ |
| 124 | void log_reset_context(void); |
| 125 | int log_set_context(uint8_t ctx, void *value); |
| 126 | |
| 127 | /* filter on the targets */ |
| 128 | void log_set_all_filter(struct log_target *target, int); |
| 129 | |
| 130 | void log_set_use_color(struct log_target *target, int); |
| 131 | void log_set_print_timestamp(struct log_target *target, int); |
| 132 | void log_set_log_level(struct log_target *target, int log_level); |
| 133 | void log_parse_category_mask(struct log_target *target, const char* mask); |
| 134 | int log_parse_level(const char *lvl); |
Harald Welte | 9ac2225 | 2010-05-11 11:19:40 +0200 | [diff] [blame] | 135 | const char *log_level_str(unsigned int lvl); |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 136 | int log_parse_category(const char *category); |
| 137 | void log_set_category_filter(struct log_target *target, int category, |
| 138 | int enable, int level); |
| 139 | |
| 140 | /* management of the targets */ |
| 141 | struct log_target *log_target_create(void); |
Harald Welte | 72d0c53 | 2010-08-25 19:24:00 +0200 | [diff] [blame] | 142 | void log_target_destroy(struct log_target *target); |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 143 | struct log_target *log_target_create_stderr(void); |
Harald Welte | 72d0c53 | 2010-08-25 19:24:00 +0200 | [diff] [blame] | 144 | struct log_target *log_target_create_file(const char *fname); |
Harald Welte | 46cfd77 | 2011-02-17 15:56:56 +0100 | [diff] [blame] | 145 | struct log_target *log_target_create_syslog(const char *ident, int option, |
| 146 | int facility); |
Harald Welte | 72d0c53 | 2010-08-25 19:24:00 +0200 | [diff] [blame] | 147 | int log_target_file_reopen(struct log_target *tgt); |
| 148 | |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 149 | void log_add_target(struct log_target *target); |
| 150 | void log_del_target(struct log_target *target); |
| 151 | |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 152 | /* Generate command string for VTY use */ |
| 153 | const char *log_vty_command_string(const struct log_info *info); |
| 154 | const char *log_vty_command_description(const struct log_info *info); |
Harald Welte | 7638af9 | 2010-05-11 16:39:22 +0200 | [diff] [blame] | 155 | |
Harald Welte | 2822296 | 2011-02-18 20:37:04 +0100 | [diff] [blame] | 156 | struct log_target *log_target_find(int type, const char *fname); |
| 157 | extern struct llist_head osmo_log_target_list; |
| 158 | |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 159 | #endif /* _OSMOCORE_LOGGING_H */ |