Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 1 | /* Debugging/Logging support code */ |
| 2 | |
| 3 | /* (C) 2008-2010 by Harald Welte <laforge@gnumonks.org> |
| 4 | * (C) 2008 by Holger Hans Peter Freyther <zecke@selfish.org> |
| 5 | * All Rights Reserved |
| 6 | * |
| 7 | * This program is free software; you can redistribute it and/or modify |
| 8 | * it under the terms of the GNU General Public License as published by |
| 9 | * the Free Software Foundation; either version 2 of the License, or |
| 10 | * (at your option) any later version. |
| 11 | * |
| 12 | * This program is distributed in the hope that it will be useful, |
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | * GNU General Public License for more details. |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License along |
| 18 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 19 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | */ |
| 22 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 23 | /* \addtogroup logging |
| 24 | * @{ |
| 25 | */ |
| 26 | |
| 27 | /* \file logging.c */ |
| 28 | |
Harald Welte | 01fd5cb | 2010-03-26 23:51:31 +0800 | [diff] [blame] | 29 | #include "../config.h" |
| 30 | |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 31 | #include <stdarg.h> |
| 32 | #include <stdlib.h> |
| 33 | #include <stdio.h> |
| 34 | #include <string.h> |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 35 | #include <ctype.h> |
Harald Welte | 01fd5cb | 2010-03-26 23:51:31 +0800 | [diff] [blame] | 36 | |
| 37 | #ifdef HAVE_STRINGS_H |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 38 | #include <strings.h> |
Harald Welte | 01fd5cb | 2010-03-26 23:51:31 +0800 | [diff] [blame] | 39 | #endif |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 40 | #include <time.h> |
Jacob Erlbeck | b61b2ca | 2015-03-17 10:21:15 +0100 | [diff] [blame] | 41 | #include <sys/time.h> |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 42 | #include <errno.h> |
| 43 | |
Pablo Neira Ayuso | 8341934 | 2011-03-22 16:36:13 +0100 | [diff] [blame] | 44 | #include <osmocom/core/talloc.h> |
| 45 | #include <osmocom/core/utils.h> |
| 46 | #include <osmocom/core/logging.h> |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 47 | |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 48 | #include <osmocom/vty/logging.h> /* for LOGGING_STR. */ |
| 49 | |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 50 | struct log_info *osmo_log_info; |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 51 | |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 52 | static struct log_context log_context; |
| 53 | static void *tall_log_ctx = NULL; |
Harald Welte | 2822296 | 2011-02-18 20:37:04 +0100 | [diff] [blame] | 54 | LLIST_HEAD(osmo_log_target_list); |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 55 | |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 56 | #define LOGLEVEL_DEFS 6 /* Number of loglevels.*/ |
| 57 | |
| 58 | static const struct value_string loglevel_strs[LOGLEVEL_DEFS+1] = { |
Harald Welte | 9b18670 | 2013-03-19 09:55:28 +0100 | [diff] [blame] | 59 | { 0, "EVERYTHING" }, |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 60 | { LOGL_DEBUG, "DEBUG" }, |
| 61 | { LOGL_INFO, "INFO" }, |
| 62 | { LOGL_NOTICE, "NOTICE" }, |
| 63 | { LOGL_ERROR, "ERROR" }, |
| 64 | { LOGL_FATAL, "FATAL" }, |
| 65 | { 0, NULL }, |
| 66 | }; |
| 67 | |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 68 | #define INT2IDX(x) (-1*(x)-1) |
| 69 | static const struct log_info_cat internal_cat[OSMO_NUM_DLIB] = { |
| 70 | [INT2IDX(DLGLOBAL)] = { /* -1 becomes 0 */ |
| 71 | .name = "DLGLOBAL", |
| 72 | .description = "Library-internal global log family", |
| 73 | .loglevel = LOGL_NOTICE, |
| 74 | .enabled = 1, |
| 75 | }, |
root | 8a996b4 | 2011-09-26 11:22:21 +0200 | [diff] [blame] | 76 | [INT2IDX(DLLAPD)] = { /* -2 becomes 1 */ |
| 77 | .name = "DLLAPD", |
| 78 | .description = "LAPD in libosmogsm", |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 79 | .loglevel = LOGL_NOTICE, |
| 80 | .enabled = 1, |
| 81 | }, |
Harald Welte | 892e621 | 2011-07-19 14:31:44 +0200 | [diff] [blame] | 82 | [INT2IDX(DLINP)] = { |
Harald Welte | 087e113 | 2011-07-29 11:43:39 +0200 | [diff] [blame] | 83 | .name = "DLINP", |
Pablo Neira Ayuso | 199f377 | 2011-07-07 19:46:38 +0200 | [diff] [blame] | 84 | .description = "A-bis Intput Subsystem", |
| 85 | .loglevel = LOGL_NOTICE, |
| 86 | .enabled = 1, |
| 87 | }, |
Harald Welte | 892e621 | 2011-07-19 14:31:44 +0200 | [diff] [blame] | 88 | [INT2IDX(DLMUX)] = { |
Harald Welte | 087e113 | 2011-07-29 11:43:39 +0200 | [diff] [blame] | 89 | .name = "DLMUX", |
Pablo Neira Ayuso | 199f377 | 2011-07-07 19:46:38 +0200 | [diff] [blame] | 90 | .description = "A-bis B-Subchannel TRAU Frame Multiplex", |
| 91 | .loglevel = LOGL_NOTICE, |
| 92 | .enabled = 1, |
| 93 | }, |
Harald Welte | 892e621 | 2011-07-19 14:31:44 +0200 | [diff] [blame] | 94 | [INT2IDX(DLMI)] = { |
Harald Welte | 087e113 | 2011-07-29 11:43:39 +0200 | [diff] [blame] | 95 | .name = "DLMI", |
Pablo Neira Ayuso | 199f377 | 2011-07-07 19:46:38 +0200 | [diff] [blame] | 96 | .description = "A-bis Input Driver for Signalling", |
| 97 | .enabled = 0, .loglevel = LOGL_NOTICE, |
| 98 | }, |
Harald Welte | 892e621 | 2011-07-19 14:31:44 +0200 | [diff] [blame] | 99 | [INT2IDX(DLMIB)] = { |
Harald Welte | 087e113 | 2011-07-29 11:43:39 +0200 | [diff] [blame] | 100 | .name = "DLMIB", |
Pablo Neira Ayuso | 199f377 | 2011-07-07 19:46:38 +0200 | [diff] [blame] | 101 | .description = "A-bis Input Driver for B-Channels (voice)", |
| 102 | .enabled = 0, .loglevel = LOGL_NOTICE, |
| 103 | }, |
Andreas Eversberg | c626da9 | 2011-10-28 03:53:50 +0200 | [diff] [blame] | 104 | [INT2IDX(DLSMS)] = { |
| 105 | .name = "DLSMS", |
| 106 | .description = "Layer3 Short Message Service (SMS)", |
| 107 | .enabled = 1, .loglevel = LOGL_NOTICE, |
| 108 | .color = "\033[1;38m", |
| 109 | }, |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 110 | [INT2IDX(DLCTRL)] = { |
| 111 | .name = "DLCTRL", |
| 112 | .description = "Control Interface", |
| 113 | .enabled = 1, .loglevel = LOGL_NOTICE, |
| 114 | }, |
Holger Hans Peter Freyther | a5dc19d | 2014-12-04 14:35:21 +0100 | [diff] [blame] | 115 | [INT2IDX(DLGTP)] = { |
| 116 | .name = "DLGTP", |
| 117 | .description = "GPRS GTP library", |
| 118 | .enabled = 1, .loglevel = LOGL_NOTICE, |
| 119 | }, |
Jacob Erlbeck | 79125ec | 2015-11-02 15:17:50 +0100 | [diff] [blame] | 120 | [INT2IDX(DLSTATS)] = { |
| 121 | .name = "DLSTATS", |
| 122 | .description = "Statistics messages and logging", |
| 123 | .enabled = 1, .loglevel = LOGL_NOTICE, |
| 124 | }, |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 125 | }; |
| 126 | |
Harald Welte | de6e498 | 2012-12-06 21:25:27 +0100 | [diff] [blame] | 127 | /*! \brief descriptive string for each log level */ |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 128 | /* You have to keep this in sync with the structure loglevel_strs. */ |
| 129 | const char *loglevel_descriptions[LOGLEVEL_DEFS+1] = { |
Holger Hans Peter Freyther | 6ec6bd9 | 2014-12-28 18:27:38 +0100 | [diff] [blame] | 130 | "Don't use. It doesn't log anything", |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 131 | "Log debug messages and higher levels", |
| 132 | "Log informational messages and higher levels", |
| 133 | "Log noticable messages and higher levels", |
| 134 | "Log error messages and higher levels", |
| 135 | "Log only fatal messages", |
| 136 | NULL, |
| 137 | }; |
| 138 | |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 139 | /* special magic for negative (library-internal) log subsystem numbers */ |
| 140 | static int subsys_lib2index(int subsys) |
| 141 | { |
| 142 | return (subsys * -1) + (osmo_log_info->num_cat_user-1); |
| 143 | } |
| 144 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 145 | /*! \brief Parse a human-readable log level into a numeric value */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 146 | int log_parse_level(const char *lvl) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 147 | { |
| 148 | return get_string_value(loglevel_strs, lvl); |
| 149 | } |
| 150 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 151 | /*! \brief convert a numeric log level into human-readable string */ |
Harald Welte | 9ac2225 | 2010-05-11 11:19:40 +0200 | [diff] [blame] | 152 | const char *log_level_str(unsigned int lvl) |
| 153 | { |
| 154 | return get_value_string(loglevel_strs, lvl); |
| 155 | } |
| 156 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 157 | /*! \brief parse a human-readable log category into numeric form |
| 158 | * \param[in] category human-readable log category name |
| 159 | * \returns numeric category value, or -EINVAL otherwise |
| 160 | */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 161 | int log_parse_category(const char *category) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 162 | { |
| 163 | int i; |
| 164 | |
Harald Welte | 4ebdf74 | 2010-05-19 19:54:00 +0200 | [diff] [blame] | 165 | for (i = 0; i < osmo_log_info->num_cat; ++i) { |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 166 | if (osmo_log_info->cat[i].name == NULL) |
| 167 | continue; |
Harald Welte | 4ebdf74 | 2010-05-19 19:54:00 +0200 | [diff] [blame] | 168 | if (!strcasecmp(osmo_log_info->cat[i].name+1, category)) |
Harald Welte | faadfe2 | 2010-03-26 21:05:43 +0800 | [diff] [blame] | 169 | return i; |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 170 | } |
| 171 | |
| 172 | return -EINVAL; |
| 173 | } |
| 174 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 175 | /*! \brief parse the log category mask |
| 176 | * \param[in] target log target to be configured |
| 177 | * \param[in] _mask log category mask string |
| 178 | * |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 179 | * The format can be this: category1:category2:category3 |
| 180 | * or category1,2:category2,3:... |
| 181 | */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 182 | void log_parse_category_mask(struct log_target* target, const char *_mask) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 183 | { |
| 184 | int i = 0; |
| 185 | char *mask = strdup(_mask); |
| 186 | char *category_token = NULL; |
| 187 | |
| 188 | /* Disable everything to enable it afterwards */ |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 189 | for (i = 0; i < osmo_log_info->num_cat; ++i) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 190 | target->categories[i].enabled = 0; |
| 191 | |
| 192 | category_token = strtok(mask, ":"); |
Neels Hofmeyr | da1b20c | 2016-04-14 15:12:16 +0200 | [diff] [blame] | 193 | OSMO_ASSERT(category_token); |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 194 | do { |
Harald Welte | 4ebdf74 | 2010-05-19 19:54:00 +0200 | [diff] [blame] | 195 | for (i = 0; i < osmo_log_info->num_cat; ++i) { |
Nico Golde | 0262d3f | 2012-09-21 17:44:58 +0200 | [diff] [blame] | 196 | size_t length, cat_length; |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 197 | char* colon = strstr(category_token, ","); |
Nico Golde | 0262d3f | 2012-09-21 17:44:58 +0200 | [diff] [blame] | 198 | |
| 199 | if (!osmo_log_info->cat[i].name) |
| 200 | continue; |
| 201 | |
| 202 | length = strlen(category_token); |
| 203 | cat_length = strlen(osmo_log_info->cat[i].name); |
Pablo Neira Ayuso | 300e78d | 2011-08-11 13:24:18 +0200 | [diff] [blame] | 204 | |
| 205 | /* Use longest length not to match subocurrences. */ |
| 206 | if (cat_length > length) |
| 207 | length = cat_length; |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 208 | |
| 209 | if (colon) |
| 210 | length = colon - category_token; |
| 211 | |
Harald Welte | 4ebdf74 | 2010-05-19 19:54:00 +0200 | [diff] [blame] | 212 | if (strncasecmp(osmo_log_info->cat[i].name, |
| 213 | category_token, length) == 0) { |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 214 | int level = 0; |
| 215 | |
| 216 | if (colon) |
| 217 | level = atoi(colon+1); |
| 218 | |
Harald Welte | faadfe2 | 2010-03-26 21:05:43 +0800 | [diff] [blame] | 219 | target->categories[i].enabled = 1; |
| 220 | target->categories[i].loglevel = level; |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 221 | } |
| 222 | } |
| 223 | } while ((category_token = strtok(NULL, ":"))); |
| 224 | |
| 225 | free(mask); |
| 226 | } |
| 227 | |
| 228 | static const char* color(int subsys) |
| 229 | { |
Harald Welte | 4ebdf74 | 2010-05-19 19:54:00 +0200 | [diff] [blame] | 230 | if (subsys < osmo_log_info->num_cat) |
| 231 | return osmo_log_info->cat[subsys].color; |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 232 | |
Harald Welte | d788f66 | 2010-03-26 09:45:03 +0800 | [diff] [blame] | 233 | return NULL; |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 234 | } |
| 235 | |
Holger Hans Peter Freyther | 2d6ad13 | 2014-12-05 09:35:30 +0100 | [diff] [blame] | 236 | static const char* category_name(int subsys) |
| 237 | { |
| 238 | if (subsys < osmo_log_info->num_cat) |
| 239 | return osmo_log_info->cat[subsys].name; |
| 240 | |
| 241 | return NULL; |
| 242 | } |
| 243 | |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 244 | static void _output(struct log_target *target, unsigned int subsys, |
Holger Hans Peter Freyther | fb4bfc2 | 2012-07-12 09:26:25 +0200 | [diff] [blame] | 245 | unsigned int level, const char *file, int line, int cont, |
Harald Welte | 76e72ab | 2011-02-17 15:52:39 +0100 | [diff] [blame] | 246 | const char *format, va_list ap) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 247 | { |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 248 | char buf[4096]; |
Pablo Neira Ayuso | 7503fb8 | 2011-05-03 22:32:43 +0200 | [diff] [blame] | 249 | int ret, len = 0, offset = 0, rem = sizeof(buf); |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 250 | |
| 251 | /* are we using color */ |
| 252 | if (target->use_color) { |
Harald Welte | d788f66 | 2010-03-26 09:45:03 +0800 | [diff] [blame] | 253 | const char *c = color(subsys); |
| 254 | if (c) { |
Holger Hans Peter Freyther | 5f91a40 | 2014-12-05 10:29:45 +0100 | [diff] [blame] | 255 | ret = snprintf(buf + offset, rem, "%s", c); |
Pablo Neira Ayuso | 7503fb8 | 2011-05-03 22:32:43 +0200 | [diff] [blame] | 256 | if (ret < 0) |
| 257 | goto err; |
| 258 | OSMO_SNPRINTF_RET(ret, rem, offset, len); |
Harald Welte | d788f66 | 2010-03-26 09:45:03 +0800 | [diff] [blame] | 259 | } |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 260 | } |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 261 | if (!cont) { |
Holger Hans Peter Freyther | 2d6ad13 | 2014-12-05 09:35:30 +0100 | [diff] [blame] | 262 | if (target->print_ext_timestamp) { |
| 263 | struct tm tm; |
Jacob Erlbeck | b61b2ca | 2015-03-17 10:21:15 +0100 | [diff] [blame] | 264 | struct timeval tv; |
| 265 | gettimeofday(&tv, NULL); |
| 266 | localtime_r(&tv.tv_sec, &tm); |
| 267 | ret = snprintf(buf + offset, rem, "%04d%02d%02d%02d%02d%02d%03d ", |
Holger Hans Peter Freyther | 2d6ad13 | 2014-12-05 09:35:30 +0100 | [diff] [blame] | 268 | tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, |
Jacob Erlbeck | b61b2ca | 2015-03-17 10:21:15 +0100 | [diff] [blame] | 269 | tm.tm_hour, tm.tm_min, tm.tm_sec, |
| 270 | (int)(tv.tv_usec / 1000)); |
Holger Hans Peter Freyther | 2d6ad13 | 2014-12-05 09:35:30 +0100 | [diff] [blame] | 271 | if (ret < 0) |
| 272 | goto err; |
| 273 | OSMO_SNPRINTF_RET(ret, rem, offset, len); |
| 274 | } else if (target->print_timestamp) { |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 275 | char *timestr; |
| 276 | time_t tm; |
| 277 | tm = time(NULL); |
| 278 | timestr = ctime(&tm); |
| 279 | timestr[strlen(timestr)-1] = '\0'; |
Pablo Neira Ayuso | 7503fb8 | 2011-05-03 22:32:43 +0200 | [diff] [blame] | 280 | ret = snprintf(buf + offset, rem, "%s ", timestr); |
| 281 | if (ret < 0) |
| 282 | goto err; |
| 283 | OSMO_SNPRINTF_RET(ret, rem, offset, len); |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 284 | } |
Holger Hans Peter Freyther | 2d6ad13 | 2014-12-05 09:35:30 +0100 | [diff] [blame] | 285 | if (target->print_category) { |
| 286 | ret = snprintf(buf + offset, rem, "%s ", category_name(subsys)); |
| 287 | if (ret < 0) |
| 288 | goto err; |
| 289 | OSMO_SNPRINTF_RET(ret, rem, offset, len); |
| 290 | } |
Holger Hans Peter Freyther | db15336 | 2012-09-11 11:24:51 +0200 | [diff] [blame] | 291 | if (target->print_filename) { |
| 292 | ret = snprintf(buf + offset, rem, "<%4.4x> %s:%d ", |
| 293 | subsys, file, line); |
| 294 | if (ret < 0) |
| 295 | goto err; |
| 296 | OSMO_SNPRINTF_RET(ret, rem, offset, len); |
| 297 | } |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 298 | } |
Pablo Neira Ayuso | 7503fb8 | 2011-05-03 22:32:43 +0200 | [diff] [blame] | 299 | ret = vsnprintf(buf + offset, rem, format, ap); |
| 300 | if (ret < 0) |
| 301 | goto err; |
| 302 | OSMO_SNPRINTF_RET(ret, rem, offset, len); |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 303 | |
Pablo Neira Ayuso | 7503fb8 | 2011-05-03 22:32:43 +0200 | [diff] [blame] | 304 | ret = snprintf(buf + offset, rem, "%s", |
| 305 | target->use_color ? "\033[0;m" : ""); |
| 306 | if (ret < 0) |
| 307 | goto err; |
| 308 | OSMO_SNPRINTF_RET(ret, rem, offset, len); |
| 309 | err: |
| 310 | buf[sizeof(buf)-1] = '\0'; |
| 311 | target->output(target, level, buf); |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 312 | } |
| 313 | |
Holger Hans Peter Freyther | e0dc6a1 | 2015-12-21 14:45:16 +0100 | [diff] [blame] | 314 | static inline int map_subsys(int subsys) |
| 315 | { |
| 316 | if (subsys < 0) |
| 317 | subsys = subsys_lib2index(subsys); |
| 318 | |
| 319 | if (subsys > osmo_log_info->num_cat) |
| 320 | subsys = DLGLOBAL; |
| 321 | return subsys; |
| 322 | } |
| 323 | |
| 324 | static inline int check_log_to_target(struct log_target *tar, int subsys, int level) |
| 325 | { |
| 326 | struct log_category *category; |
| 327 | |
| 328 | category = &tar->categories[subsys]; |
| 329 | |
| 330 | /* subsystem is not supposed to be logged */ |
| 331 | if (!category->enabled) |
| 332 | return 0; |
| 333 | |
| 334 | /* Check the global log level */ |
| 335 | if (tar->loglevel != 0 && level < tar->loglevel) |
| 336 | return 0; |
| 337 | |
| 338 | /* Check the category log level */ |
| 339 | if (tar->loglevel == 0 && category->loglevel != 0 && |
| 340 | level < category->loglevel) |
| 341 | return 0; |
| 342 | |
Holger Hans Peter Freyther | 79599ac | 2016-01-15 16:49:06 +0100 | [diff] [blame] | 343 | /* Apply filters here... if that becomes messy we will |
| 344 | * need to put filters in a list and each filter will |
| 345 | * say stop, continue, output */ |
| 346 | if ((tar->filter_map & LOG_FILTER_ALL) != 0) |
| 347 | return 1; |
| 348 | |
| 349 | if (osmo_log_info->filter_fn) |
| 350 | return osmo_log_info->filter_fn(&log_context, tar); |
| 351 | |
Holger Hans Peter Freyther | e0dc6a1 | 2015-12-21 14:45:16 +0100 | [diff] [blame] | 352 | /* TODO: Check the filter/selector too? */ |
| 353 | return 1; |
| 354 | } |
| 355 | |
Harald Welte | 36c5a3e | 2011-08-27 14:33:19 +0200 | [diff] [blame] | 356 | /*! \brief vararg version of logging function */ |
Holger Hans Peter Freyther | fb4bfc2 | 2012-07-12 09:26:25 +0200 | [diff] [blame] | 357 | void osmo_vlogp(int subsys, int level, const char *file, int line, |
Harald Welte | 36c5a3e | 2011-08-27 14:33:19 +0200 | [diff] [blame] | 358 | int cont, const char *format, va_list ap) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 359 | { |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 360 | struct log_target *tar; |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 361 | |
Holger Hans Peter Freyther | e0dc6a1 | 2015-12-21 14:45:16 +0100 | [diff] [blame] | 362 | subsys = map_subsys(subsys); |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 363 | |
Harald Welte | 2822296 | 2011-02-18 20:37:04 +0100 | [diff] [blame] | 364 | llist_for_each_entry(tar, &osmo_log_target_list, entry) { |
Pablo Neira Ayuso | dd93bf4 | 2011-05-19 01:40:43 +0200 | [diff] [blame] | 365 | va_list bp; |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 366 | |
Holger Hans Peter Freyther | e0dc6a1 | 2015-12-21 14:45:16 +0100 | [diff] [blame] | 367 | if (!check_log_to_target(tar, subsys, level)) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 368 | continue; |
| 369 | |
Pablo Neira Ayuso | dd93bf4 | 2011-05-19 01:40:43 +0200 | [diff] [blame] | 370 | /* According to the manpage, vsnprintf leaves the value of ap |
| 371 | * in undefined state. Since _output uses vsnprintf and it may |
| 372 | * be called several times, we have to pass a copy of ap. */ |
| 373 | va_copy(bp, ap); |
Harald Welte | da127cb | 2011-07-02 21:51:32 +0200 | [diff] [blame] | 374 | _output(tar, subsys, level, file, line, cont, format, bp); |
Pablo Neira Ayuso | dd93bf4 | 2011-05-19 01:40:43 +0200 | [diff] [blame] | 375 | va_end(bp); |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 376 | } |
| 377 | } |
| 378 | |
Harald Welte | de6e498 | 2012-12-06 21:25:27 +0100 | [diff] [blame] | 379 | /*! \brief logging function used by DEBUGP() macro */ |
Holger Hans Peter Freyther | fb4bfc2 | 2012-07-12 09:26:25 +0200 | [diff] [blame] | 380 | void logp(int subsys, const char *file, int line, int cont, |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 381 | const char *format, ...) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 382 | { |
| 383 | va_list ap; |
| 384 | |
| 385 | va_start(ap, format); |
Harald Welte | 36c5a3e | 2011-08-27 14:33:19 +0200 | [diff] [blame] | 386 | osmo_vlogp(subsys, LOGL_DEBUG, file, line, cont, format, ap); |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 387 | va_end(ap); |
| 388 | } |
| 389 | |
Harald Welte | de6e498 | 2012-12-06 21:25:27 +0100 | [diff] [blame] | 390 | /*! \brief logging function used by LOGP() macro */ |
Holger Hans Peter Freyther | fb4bfc2 | 2012-07-12 09:26:25 +0200 | [diff] [blame] | 391 | void logp2(int subsys, unsigned int level, const char *file, int line, int cont, const char *format, ...) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 392 | { |
| 393 | va_list ap; |
| 394 | |
| 395 | va_start(ap, format); |
Harald Welte | 36c5a3e | 2011-08-27 14:33:19 +0200 | [diff] [blame] | 396 | osmo_vlogp(subsys, level, file, line, cont, format, ap); |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 397 | va_end(ap); |
| 398 | } |
| 399 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 400 | /*! \brief Register a new log target with the logging core |
| 401 | * \param[in] target Log target to be registered |
| 402 | */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 403 | void log_add_target(struct log_target *target) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 404 | { |
Harald Welte | 2822296 | 2011-02-18 20:37:04 +0100 | [diff] [blame] | 405 | llist_add_tail(&target->entry, &osmo_log_target_list); |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 406 | } |
| 407 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 408 | /*! \brief Unregister a log target from the logging core |
| 409 | * \param[in] target Log target to be unregistered |
| 410 | */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 411 | void log_del_target(struct log_target *target) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 412 | { |
| 413 | llist_del(&target->entry); |
| 414 | } |
| 415 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 416 | /*! \brief Reset (clear) the logging context */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 417 | void log_reset_context(void) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 418 | { |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 419 | memset(&log_context, 0, sizeof(log_context)); |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 420 | } |
| 421 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 422 | /*! \brief Set the logging context |
| 423 | * \param[in] ctx_nr logging context number |
| 424 | * \param[in] value value to which the context is to be set |
| 425 | * |
| 426 | * A logging context is something like the subscriber identity to which |
| 427 | * the currently processed message relates, or the BTS through which it |
| 428 | * was received. As soon as this data is known, it can be set using |
| 429 | * this function. The main use of context information is for logging |
| 430 | * filters. |
| 431 | */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 432 | int log_set_context(uint8_t ctx_nr, void *value) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 433 | { |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 434 | if (ctx_nr > LOG_MAX_CTX) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 435 | return -EINVAL; |
| 436 | |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 437 | log_context.ctx[ctx_nr] = value; |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 438 | |
| 439 | return 0; |
| 440 | } |
| 441 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 442 | /*! \brief Enable the \ref LOG_FILTER_ALL log filter |
| 443 | * \param[in] target Log target to be affected |
| 444 | * \param[in] all enable (1) or disable (0) the ALL filter |
| 445 | * |
| 446 | * When the \ref LOG_FILTER_ALL filter is enabled, all log messages will |
| 447 | * be printed. It acts as a wildcard. Setting it to \a 1 means there |
| 448 | * is no filtering. |
| 449 | */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 450 | void log_set_all_filter(struct log_target *target, int all) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 451 | { |
| 452 | if (all) |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 453 | target->filter_map |= LOG_FILTER_ALL; |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 454 | else |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 455 | target->filter_map &= ~LOG_FILTER_ALL; |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 456 | } |
| 457 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 458 | /*! \brief Enable or disable the use of colored output |
| 459 | * \param[in] target Log target to be affected |
| 460 | * \param[in] use_color Use color (1) or don't use color (0) |
| 461 | */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 462 | void log_set_use_color(struct log_target *target, int use_color) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 463 | { |
| 464 | target->use_color = use_color; |
| 465 | } |
| 466 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 467 | /*! \brief Enable or disable printing of timestamps while logging |
| 468 | * \param[in] target Log target to be affected |
| 469 | * \param[in] print_timestamp Enable (1) or disable (0) timestamps |
| 470 | */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 471 | void log_set_print_timestamp(struct log_target *target, int print_timestamp) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 472 | { |
| 473 | target->print_timestamp = print_timestamp; |
| 474 | } |
| 475 | |
Holger Hans Peter Freyther | 2d6ad13 | 2014-12-05 09:35:30 +0100 | [diff] [blame] | 476 | /*! \brief Enable or disable printing of extended timestamps while logging |
| 477 | * \param[in] target Log target to be affected |
| 478 | * \param[in] print_timestamp Enable (1) or disable (0) timestamps |
| 479 | * |
| 480 | * When both timestamp and extended timestamp is enabled then only |
| 481 | * the extended timestamp will be used. The format of the timestamp |
| 482 | * is YYYYMMDDhhmmssnnn. |
| 483 | */ |
| 484 | void log_set_print_extended_timestamp(struct log_target *target, int print_timestamp) |
| 485 | { |
| 486 | target->print_ext_timestamp = print_timestamp; |
| 487 | } |
| 488 | |
Holger Hans Peter Freyther | db15336 | 2012-09-11 11:24:51 +0200 | [diff] [blame] | 489 | /*! \brief Enable or disable printing of the filename while logging |
| 490 | * \param[in] target Log target to be affected |
| 491 | * \param[in] print_filename Enable (1) or disable (0) filenames |
| 492 | */ |
| 493 | void log_set_print_filename(struct log_target *target, int print_filename) |
| 494 | { |
| 495 | target->print_filename = print_filename; |
| 496 | } |
| 497 | |
Holger Hans Peter Freyther | 2d6ad13 | 2014-12-05 09:35:30 +0100 | [diff] [blame] | 498 | /*! \brief Enable or disable printing of the category name |
| 499 | * \param[in] target Log target to be affected |
| 500 | * \param[in] print_catname Enable (1) or disable (0) filenames |
| 501 | * |
| 502 | * Print the category/subsys name in front of every log message. |
| 503 | */ |
| 504 | void log_set_print_category(struct log_target *target, int print_category) |
| 505 | { |
| 506 | target->print_category = print_category; |
| 507 | } |
| 508 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 509 | /*! \brief Set the global log level for a given log target |
| 510 | * \param[in] target Log target to be affected |
| 511 | * \param[in] log_level New global log level |
| 512 | */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 513 | void log_set_log_level(struct log_target *target, int log_level) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 514 | { |
| 515 | target->loglevel = log_level; |
| 516 | } |
| 517 | |
Harald Welte | de6e498 | 2012-12-06 21:25:27 +0100 | [diff] [blame] | 518 | /*! \brief Set a category filter on a given log target |
| 519 | * \param[in] target Log target to be affected |
| 520 | * \param[in] category Log category to be affected |
| 521 | * \param[in] enable whether to enable or disable the filter |
| 522 | * \param[in] level Log level of the filter |
| 523 | */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 524 | void log_set_category_filter(struct log_target *target, int category, |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 525 | int enable, int level) |
| 526 | { |
Harald Welte | 4ebdf74 | 2010-05-19 19:54:00 +0200 | [diff] [blame] | 527 | if (category >= osmo_log_info->num_cat) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 528 | return; |
| 529 | target->categories[category].enabled = !!enable; |
| 530 | target->categories[category].loglevel = level; |
| 531 | } |
| 532 | |
Harald Welte | 76e72ab | 2011-02-17 15:52:39 +0100 | [diff] [blame] | 533 | static void _file_output(struct log_target *target, unsigned int level, |
| 534 | const char *log) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 535 | { |
Harald Welte | 0083cd3 | 2010-08-25 14:55:44 +0200 | [diff] [blame] | 536 | fprintf(target->tgt_file.out, "%s", log); |
| 537 | fflush(target->tgt_file.out); |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 538 | } |
| 539 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 540 | /*! \brief Create a new log target skeleton */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 541 | struct log_target *log_target_create(void) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 542 | { |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 543 | struct log_target *target; |
Harald Welte | cc6313c | 2010-03-26 22:04:03 +0800 | [diff] [blame] | 544 | unsigned int i; |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 545 | |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 546 | target = talloc_zero(tall_log_ctx, struct log_target); |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 547 | if (!target) |
| 548 | return NULL; |
| 549 | |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 550 | target->categories = talloc_zero_array(target, |
| 551 | struct log_category, |
| 552 | osmo_log_info->num_cat); |
| 553 | if (!target->categories) { |
| 554 | talloc_free(target); |
| 555 | return NULL; |
| 556 | } |
| 557 | |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 558 | INIT_LLIST_HEAD(&target->entry); |
Harald Welte | cc6313c | 2010-03-26 22:04:03 +0800 | [diff] [blame] | 559 | |
| 560 | /* initialize the per-category enabled/loglevel from defaults */ |
Harald Welte | 4ebdf74 | 2010-05-19 19:54:00 +0200 | [diff] [blame] | 561 | for (i = 0; i < osmo_log_info->num_cat; i++) { |
Harald Welte | cc6313c | 2010-03-26 22:04:03 +0800 | [diff] [blame] | 562 | struct log_category *cat = &target->categories[i]; |
Harald Welte | 4ebdf74 | 2010-05-19 19:54:00 +0200 | [diff] [blame] | 563 | cat->enabled = osmo_log_info->cat[i].enabled; |
| 564 | cat->loglevel = osmo_log_info->cat[i].loglevel; |
Harald Welte | cc6313c | 2010-03-26 22:04:03 +0800 | [diff] [blame] | 565 | } |
| 566 | |
| 567 | /* global settings */ |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 568 | target->use_color = 1; |
| 569 | target->print_timestamp = 0; |
Holger Hans Peter Freyther | db15336 | 2012-09-11 11:24:51 +0200 | [diff] [blame] | 570 | target->print_filename = 1; |
Harald Welte | cc6313c | 2010-03-26 22:04:03 +0800 | [diff] [blame] | 571 | |
| 572 | /* global log level */ |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 573 | target->loglevel = 0; |
| 574 | return target; |
| 575 | } |
| 576 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 577 | /*! \brief Create the STDERR log target */ |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 578 | struct log_target *log_target_create_stderr(void) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 579 | { |
Harald Welte | a3b844c | 2010-03-27 00:04:40 +0800 | [diff] [blame] | 580 | /* since C89/C99 says stderr is a macro, we can safely do this! */ |
| 581 | #ifdef stderr |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 582 | struct log_target *target; |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 583 | |
Harald Welte | 3ae2758 | 2010-03-26 21:24:24 +0800 | [diff] [blame] | 584 | target = log_target_create(); |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 585 | if (!target) |
| 586 | return NULL; |
| 587 | |
Harald Welte | 2822296 | 2011-02-18 20:37:04 +0100 | [diff] [blame] | 588 | target->type = LOG_TGT_TYPE_STDERR; |
Harald Welte | 0083cd3 | 2010-08-25 14:55:44 +0200 | [diff] [blame] | 589 | target->tgt_file.out = stderr; |
| 590 | target->output = _file_output; |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 591 | return target; |
Harald Welte | a3b844c | 2010-03-27 00:04:40 +0800 | [diff] [blame] | 592 | #else |
| 593 | return NULL; |
| 594 | #endif /* stderr */ |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 595 | } |
| 596 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 597 | /*! \brief Create a new file-based log target |
| 598 | * \param[in] fname File name of the new log file |
| 599 | * \returns Log target in case of success, NULL otherwise |
| 600 | */ |
Harald Welte | 3086c39 | 2010-08-25 19:10:50 +0200 | [diff] [blame] | 601 | struct log_target *log_target_create_file(const char *fname) |
| 602 | { |
| 603 | struct log_target *target; |
| 604 | |
| 605 | target = log_target_create(); |
| 606 | if (!target) |
| 607 | return NULL; |
| 608 | |
Harald Welte | 2822296 | 2011-02-18 20:37:04 +0100 | [diff] [blame] | 609 | target->type = LOG_TGT_TYPE_FILE; |
Harald Welte | 3086c39 | 2010-08-25 19:10:50 +0200 | [diff] [blame] | 610 | target->tgt_file.out = fopen(fname, "a"); |
| 611 | if (!target->tgt_file.out) |
| 612 | return NULL; |
| 613 | |
| 614 | target->output = _file_output; |
| 615 | |
| 616 | target->tgt_file.fname = talloc_strdup(target, fname); |
| 617 | |
| 618 | return target; |
| 619 | } |
| 620 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 621 | /*! \brief Find a registered log target |
| 622 | * \param[in] type Log target type |
| 623 | * \param[in] fname File name |
| 624 | * \returns Log target (if found), NULL otherwise |
| 625 | */ |
Harald Welte | 2822296 | 2011-02-18 20:37:04 +0100 | [diff] [blame] | 626 | struct log_target *log_target_find(int type, const char *fname) |
| 627 | { |
| 628 | struct log_target *tgt; |
| 629 | |
| 630 | llist_for_each_entry(tgt, &osmo_log_target_list, entry) { |
| 631 | if (tgt->type != type) |
| 632 | continue; |
| 633 | if (tgt->type == LOG_TGT_TYPE_FILE) { |
| 634 | if (!strcmp(fname, tgt->tgt_file.fname)) |
| 635 | return tgt; |
| 636 | } else |
| 637 | return tgt; |
| 638 | } |
| 639 | return NULL; |
| 640 | } |
| 641 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 642 | /*! \brief Unregister, close and delete a log target */ |
Harald Welte | 3086c39 | 2010-08-25 19:10:50 +0200 | [diff] [blame] | 643 | void log_target_destroy(struct log_target *target) |
| 644 | { |
| 645 | |
| 646 | /* just in case, to make sure we don't have any references */ |
| 647 | log_del_target(target); |
| 648 | |
| 649 | if (target->output == &_file_output) { |
Sylvain Munaut | af5ee34 | 2010-09-17 14:38:17 +0200 | [diff] [blame] | 650 | /* since C89/C99 says stderr is a macro, we can safely do this! */ |
| 651 | #ifdef stderr |
Harald Welte | 3086c39 | 2010-08-25 19:10:50 +0200 | [diff] [blame] | 652 | /* don't close stderr */ |
Sylvain Munaut | af5ee34 | 2010-09-17 14:38:17 +0200 | [diff] [blame] | 653 | if (target->tgt_file.out != stderr) |
| 654 | #endif |
| 655 | { |
Harald Welte | 3086c39 | 2010-08-25 19:10:50 +0200 | [diff] [blame] | 656 | fclose(target->tgt_file.out); |
| 657 | target->tgt_file.out = NULL; |
| 658 | } |
| 659 | } |
| 660 | |
| 661 | talloc_free(target); |
| 662 | } |
| 663 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 664 | /*! \brief close and re-open a log file (for log file rotation) */ |
Harald Welte | 3086c39 | 2010-08-25 19:10:50 +0200 | [diff] [blame] | 665 | int log_target_file_reopen(struct log_target *target) |
| 666 | { |
| 667 | fclose(target->tgt_file.out); |
| 668 | |
| 669 | target->tgt_file.out = fopen(target->tgt_file.fname, "a"); |
| 670 | if (!target->tgt_file.out) |
| 671 | return -errno; |
| 672 | |
| 673 | /* we assume target->output already to be set */ |
| 674 | |
| 675 | return 0; |
| 676 | } |
| 677 | |
Harald Welte | 4de854d | 2013-03-18 19:01:40 +0100 | [diff] [blame] | 678 | /*! \brief close and re-open a log file (for log file rotation) */ |
| 679 | int log_targets_reopen(void) |
| 680 | { |
| 681 | struct log_target *tar; |
| 682 | int rc = 0; |
| 683 | |
| 684 | llist_for_each_entry(tar, &osmo_log_target_list, entry) { |
| 685 | switch (tar->type) { |
| 686 | case LOG_TGT_TYPE_FILE: |
| 687 | if (log_target_file_reopen(tar) < 0) |
| 688 | rc = -1; |
| 689 | break; |
| 690 | default: |
| 691 | break; |
| 692 | } |
| 693 | } |
| 694 | |
| 695 | return rc; |
| 696 | } |
| 697 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 698 | /*! \brief Generates the logging command string for VTY |
| 699 | * \param[in] unused_info Deprecated parameter, no longer used! |
| 700 | */ |
Harald Welte | ce9fec3 | 2011-06-27 14:19:16 +0200 | [diff] [blame] | 701 | const char *log_vty_command_string(const struct log_info *unused_info) |
Harald Welte | 7638af9 | 2010-05-11 16:39:22 +0200 | [diff] [blame] | 702 | { |
Harald Welte | ce9fec3 | 2011-06-27 14:19:16 +0200 | [diff] [blame] | 703 | struct log_info *info = osmo_log_info; |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 704 | int len = 0, offset = 0, ret, i, rem; |
| 705 | int size = strlen("logging level () ()") + 1; |
Harald Welte | 7638af9 | 2010-05-11 16:39:22 +0200 | [diff] [blame] | 706 | char *str; |
| 707 | |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 708 | for (i = 0; i < info->num_cat; i++) { |
| 709 | if (info->cat[i].name == NULL) |
| 710 | continue; |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 711 | size += strlen(info->cat[i].name) + 1; |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 712 | } |
Harald Welte | 7638af9 | 2010-05-11 16:39:22 +0200 | [diff] [blame] | 713 | |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 714 | for (i = 0; i < LOGLEVEL_DEFS; i++) |
| 715 | size += strlen(loglevel_strs[i].str) + 1; |
| 716 | |
| 717 | rem = size; |
Pablo Neira Ayuso | f1fae4d | 2011-05-03 22:32:42 +0200 | [diff] [blame] | 718 | str = talloc_zero_size(tall_log_ctx, size); |
Harald Welte | 7638af9 | 2010-05-11 16:39:22 +0200 | [diff] [blame] | 719 | if (!str) |
| 720 | return NULL; |
| 721 | |
Holger Hans Peter Freyther | 952a18e | 2011-03-29 17:03:56 +0200 | [diff] [blame] | 722 | ret = snprintf(str + offset, rem, "logging level (all|"); |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 723 | if (ret < 0) |
| 724 | goto err; |
Pablo Neira Ayuso | 3abad6a | 2011-03-28 19:24:22 +0200 | [diff] [blame] | 725 | OSMO_SNPRINTF_RET(ret, rem, offset, len); |
Harald Welte | 7638af9 | 2010-05-11 16:39:22 +0200 | [diff] [blame] | 726 | |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 727 | for (i = 0; i < info->num_cat; i++) { |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 728 | if (info->cat[i].name) { |
| 729 | int j, name_len = strlen(info->cat[i].name)+1; |
| 730 | char name[name_len]; |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 731 | |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 732 | for (j = 0; j < name_len; j++) |
| 733 | name[j] = tolower(info->cat[i].name[j]); |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 734 | |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 735 | name[name_len-1] = '\0'; |
| 736 | ret = snprintf(str + offset, rem, "%s|", name+1); |
| 737 | if (ret < 0) |
| 738 | goto err; |
| 739 | OSMO_SNPRINTF_RET(ret, rem, offset, len); |
| 740 | } |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 741 | } |
| 742 | offset--; /* to remove the trailing | */ |
| 743 | rem++; |
| 744 | |
| 745 | ret = snprintf(str + offset, rem, ") ("); |
| 746 | if (ret < 0) |
| 747 | goto err; |
Pablo Neira Ayuso | 3abad6a | 2011-03-28 19:24:22 +0200 | [diff] [blame] | 748 | OSMO_SNPRINTF_RET(ret, rem, offset, len); |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 749 | |
| 750 | for (i = 0; i < LOGLEVEL_DEFS; i++) { |
| 751 | int j, loglevel_str_len = strlen(loglevel_strs[i].str)+1; |
| 752 | char loglevel_str[loglevel_str_len]; |
| 753 | |
| 754 | for (j = 0; j < loglevel_str_len; j++) |
| 755 | loglevel_str[j] = tolower(loglevel_strs[i].str[j]); |
| 756 | |
| 757 | loglevel_str[loglevel_str_len-1] = '\0'; |
| 758 | ret = snprintf(str + offset, rem, "%s|", loglevel_str); |
| 759 | if (ret < 0) |
| 760 | goto err; |
Pablo Neira Ayuso | 3abad6a | 2011-03-28 19:24:22 +0200 | [diff] [blame] | 761 | OSMO_SNPRINTF_RET(ret, rem, offset, len); |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 762 | } |
| 763 | offset--; /* to remove the trailing | */ |
| 764 | rem++; |
| 765 | |
| 766 | ret = snprintf(str + offset, rem, ")"); |
| 767 | if (ret < 0) |
| 768 | goto err; |
Pablo Neira Ayuso | 3abad6a | 2011-03-28 19:24:22 +0200 | [diff] [blame] | 769 | OSMO_SNPRINTF_RET(ret, rem, offset, len); |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 770 | err: |
Pablo Neira Ayuso | 534ba81 | 2011-05-03 22:32:48 +0200 | [diff] [blame] | 771 | str[size-1] = '\0'; |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 772 | return str; |
| 773 | } |
| 774 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 775 | /*! \brief Generates the logging command description for VTY |
| 776 | * \param[in] unused_info Deprecated parameter, no longer used! |
| 777 | */ |
Harald Welte | ce9fec3 | 2011-06-27 14:19:16 +0200 | [diff] [blame] | 778 | const char *log_vty_command_description(const struct log_info *unused_info) |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 779 | { |
Harald Welte | ce9fec3 | 2011-06-27 14:19:16 +0200 | [diff] [blame] | 780 | struct log_info *info = osmo_log_info; |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 781 | char *str; |
| 782 | int i, ret, len = 0, offset = 0, rem; |
| 783 | unsigned int size = |
| 784 | strlen(LOGGING_STR |
| 785 | "Set the log level for a specified category\n") + 1; |
| 786 | |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 787 | for (i = 0; i < info->num_cat; i++) { |
| 788 | if (info->cat[i].name == NULL) |
| 789 | continue; |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 790 | size += strlen(info->cat[i].description) + 1; |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 791 | } |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 792 | |
| 793 | for (i = 0; i < LOGLEVEL_DEFS; i++) |
| 794 | size += strlen(loglevel_descriptions[i]) + 1; |
| 795 | |
Pablo Neira Ayuso | d6b5195 | 2011-05-03 22:32:32 +0200 | [diff] [blame] | 796 | size += strlen("Global setting for all subsystems") + 1; |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 797 | rem = size; |
Pablo Neira Ayuso | f1fae4d | 2011-05-03 22:32:42 +0200 | [diff] [blame] | 798 | str = talloc_zero_size(tall_log_ctx, size); |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 799 | if (!str) |
| 800 | return NULL; |
| 801 | |
| 802 | ret = snprintf(str + offset, rem, LOGGING_STR |
| 803 | "Set the log level for a specified category\n"); |
| 804 | if (ret < 0) |
| 805 | goto err; |
Pablo Neira Ayuso | 3abad6a | 2011-03-28 19:24:22 +0200 | [diff] [blame] | 806 | OSMO_SNPRINTF_RET(ret, rem, offset, len); |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 807 | |
Pablo Neira Ayuso | d6b5195 | 2011-05-03 22:32:32 +0200 | [diff] [blame] | 808 | ret = snprintf(str + offset, rem, |
| 809 | "Global setting for all subsystems\n"); |
| 810 | if (ret < 0) |
| 811 | goto err; |
| 812 | OSMO_SNPRINTF_RET(ret, rem, offset, len); |
| 813 | |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 814 | for (i = 0; i < info->num_cat; i++) { |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 815 | if (info->cat[i].name == NULL) |
| 816 | continue; |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 817 | ret = snprintf(str + offset, rem, "%s\n", |
| 818 | info->cat[i].description); |
| 819 | if (ret < 0) |
| 820 | goto err; |
Pablo Neira Ayuso | 3abad6a | 2011-03-28 19:24:22 +0200 | [diff] [blame] | 821 | OSMO_SNPRINTF_RET(ret, rem, offset, len); |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 822 | } |
| 823 | for (i = 0; i < LOGLEVEL_DEFS; i++) { |
| 824 | ret = snprintf(str + offset, rem, "%s\n", |
| 825 | loglevel_descriptions[i]); |
| 826 | if (ret < 0) |
| 827 | goto err; |
Pablo Neira Ayuso | 3abad6a | 2011-03-28 19:24:22 +0200 | [diff] [blame] | 828 | OSMO_SNPRINTF_RET(ret, rem, offset, len); |
Pablo Neira Ayuso | 04139f1 | 2011-03-09 13:05:08 +0100 | [diff] [blame] | 829 | } |
| 830 | err: |
Pablo Neira Ayuso | 534ba81 | 2011-05-03 22:32:48 +0200 | [diff] [blame] | 831 | str[size-1] = '\0'; |
Harald Welte | 7638af9 | 2010-05-11 16:39:22 +0200 | [diff] [blame] | 832 | return str; |
| 833 | } |
| 834 | |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 835 | /*! \brief Initialize the Osmocom logging core |
| 836 | * \param[in] inf Information regarding logging categories |
| 837 | * \param[in] ctx \ref talloc context for logging allocations |
| 838 | * \returns 0 in case of success, negative in case of error |
| 839 | */ |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 840 | int log_init(const struct log_info *inf, void *ctx) |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 841 | { |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 842 | int i; |
| 843 | |
| 844 | tall_log_ctx = talloc_named_const(ctx, 1, "logging"); |
| 845 | if (!tall_log_ctx) |
| 846 | return -ENOMEM; |
| 847 | |
| 848 | osmo_log_info = talloc_zero(tall_log_ctx, struct log_info); |
| 849 | if (!osmo_log_info) |
| 850 | return -ENOMEM; |
| 851 | |
Holger Hans Peter Freyther | b7d0f46 | 2013-12-29 19:38:01 +0100 | [diff] [blame] | 852 | osmo_log_info->filter_fn = inf->filter_fn; |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 853 | osmo_log_info->num_cat_user = inf->num_cat; |
| 854 | /* total number = number of user cat + library cat */ |
Harald Welte | ce9fec3 | 2011-06-27 14:19:16 +0200 | [diff] [blame] | 855 | osmo_log_info->num_cat = inf->num_cat + ARRAY_SIZE(internal_cat); |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 856 | |
| 857 | osmo_log_info->cat = talloc_zero_array(osmo_log_info, |
| 858 | struct log_info_cat, |
| 859 | osmo_log_info->num_cat); |
| 860 | if (!osmo_log_info->cat) { |
| 861 | talloc_free(osmo_log_info); |
| 862 | osmo_log_info = NULL; |
| 863 | return -ENOMEM; |
| 864 | } |
| 865 | |
| 866 | /* copy over the user part */ |
| 867 | for (i = 0; i < inf->num_cat; i++) { |
Holger Hans Peter Freyther | 06f6455 | 2012-09-11 10:31:29 +0200 | [diff] [blame] | 868 | memcpy((struct log_info_cat *) &osmo_log_info->cat[i], |
| 869 | &inf->cat[i], |
Harald Welte | b43bc04 | 2011-06-27 10:29:17 +0200 | [diff] [blame] | 870 | sizeof(struct log_info_cat)); |
| 871 | } |
| 872 | |
| 873 | /* copy over the library part */ |
Harald Welte | 9fe1652 | 2011-06-27 14:00:03 +0200 | [diff] [blame] | 874 | for (i = 0; i < ARRAY_SIZE(internal_cat); i++) { |
Harald Welte | ce9fec3 | 2011-06-27 14:19:16 +0200 | [diff] [blame] | 875 | unsigned int cn = osmo_log_info->num_cat_user + i; |
Holger Hans Peter Freyther | 06f6455 | 2012-09-11 10:31:29 +0200 | [diff] [blame] | 876 | memcpy((struct log_info_cat *) &osmo_log_info->cat[cn], |
Harald Welte | 9fe1652 | 2011-06-27 14:00:03 +0200 | [diff] [blame] | 877 | &internal_cat[i], sizeof(struct log_info_cat)); |
| 878 | } |
| 879 | |
| 880 | return 0; |
Harald Welte | 4a2bb9e | 2010-03-26 09:33:40 +0800 | [diff] [blame] | 881 | } |
Harald Welte | 18fc465 | 2011-08-17 14:14:17 +0200 | [diff] [blame] | 882 | |
Jacob Erlbeck | de6dd72 | 2015-11-17 11:52:24 +0100 | [diff] [blame] | 883 | /*! \brief Check whether a log entry will be generated. |
| 884 | * \returns != 0 if a log entry might get generated by at least one target */ |
| 885 | int log_check_level(int subsys, unsigned int level) |
| 886 | { |
| 887 | struct log_target *tar; |
| 888 | |
Holger Hans Peter Freyther | e0dc6a1 | 2015-12-21 14:45:16 +0100 | [diff] [blame] | 889 | subsys = map_subsys(subsys); |
Jacob Erlbeck | de6dd72 | 2015-11-17 11:52:24 +0100 | [diff] [blame] | 890 | |
| 891 | /* TODO: The following could/should be cached (update on config) */ |
| 892 | |
| 893 | llist_for_each_entry(tar, &osmo_log_target_list, entry) { |
Holger Hans Peter Freyther | e0dc6a1 | 2015-12-21 14:45:16 +0100 | [diff] [blame] | 894 | if (!check_log_to_target(tar, subsys, level)) |
Jacob Erlbeck | de6dd72 | 2015-11-17 11:52:24 +0100 | [diff] [blame] | 895 | continue; |
| 896 | |
| 897 | /* This might get logged (ignoring filters) */ |
| 898 | return 1; |
| 899 | } |
| 900 | |
| 901 | /* We are sure, that this will not be logged. */ |
| 902 | return 0; |
| 903 | } |
| 904 | |
Sylvain Munaut | dca7d2c | 2012-04-18 21:53:23 +0200 | [diff] [blame] | 905 | /*! @} */ |