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