blob: c6774f5700762504b6ba3f60f7d2a075458a375c [file] [log] [blame]
Neels Hofmeyr17518fe2017-06-20 04:35:06 +02001/*! \file logging.c
2 * Debugging/Logging support code. */
3/*
4 * (C) 2008-2010 by Harald Welte <laforge@gnumonks.org>
Harald Welte4a2bb9e2010-03-26 09:33:40 +08005 * (C) 2008 by Holger Hans Peter Freyther <zecke@selfish.org>
6 * All Rights Reserved
7 *
Harald Weltee08da972017-11-13 01:00:26 +09008 * SPDX-License-Identifier: GPL-2.0+
9 *
Harald Welte4a2bb9e2010-03-26 09:33:40 +080010 * 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 *
Harald Welte4a2bb9e2010-03-26 09:33:40 +080020 */
21
Harald Weltef01b2382017-10-16 13:55:34 +020022/*! \addtogroup logging
Harald Welte18fc4652011-08-17 14:14:17 +020023 * @{
Neels Hofmeyr87e45502017-06-20 00:17:59 +020024 * libosmocore Logging sub-system
Neels Hofmeyr17518fe2017-06-20 04:35:06 +020025 *
26 * \file logging.c */
Harald Welte18fc4652011-08-17 14:14:17 +020027
Pau Espin Pedrol88955fb2023-01-18 18:54:00 +010028#include "config.h"
Harald Welte01fd5cb2010-03-26 23:51:31 +080029
Harald Welte4a2bb9e2010-03-26 09:33:40 +080030#include <stdarg.h>
31#include <stdlib.h>
32#include <stdio.h>
33#include <string.h>
Harald Welteb72867f2020-09-26 21:45:16 +020034#include <unistd.h>
Harald Welte01fd5cb2010-03-26 23:51:31 +080035
36#ifdef HAVE_STRINGS_H
Harald Welte4a2bb9e2010-03-26 09:33:40 +080037#include <strings.h>
Harald Welte01fd5cb2010-03-26 23:51:31 +080038#endif
Vadim Yanitskiy04f42712020-09-09 04:47:25 +070039
40#ifdef HAVE_SYSLOG_H
41#include <syslog.h>
42#endif
43
Harald Welte433005c2020-09-26 11:51:32 +020044#ifdef HAVE_SYSTEMTAP
45/* include the generated probes header and put markers in code */
46#include "probes.h"
47#define TRACE(probe) probe
48#define TRACE_ENABLED(probe) probe ## _ENABLED()
49#else
50/* Wrap the probe to allow it to be removed when no systemtap available */
51#define TRACE(probe)
52#define TRACE_ENABLED(probe) (0)
53#endif /* HAVE_SYSTEMTAP */
54
Harald Welte4a2bb9e2010-03-26 09:33:40 +080055#include <time.h>
Jacob Erlbeckb61b2ca2015-03-17 10:21:15 +010056#include <sys/time.h>
Harald Welteb72867f2020-09-26 21:45:16 +020057#include <sys/types.h>
58#include <sys/stat.h>
59#include <fcntl.h>
Harald Welte4a2bb9e2010-03-26 09:33:40 +080060#include <errno.h>
Pau Espin Pedrold12f6982019-09-17 18:38:58 +020061#include <pthread.h>
Harald Welte4a2bb9e2010-03-26 09:33:40 +080062
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010063#include <osmocom/core/talloc.h>
64#include <osmocom/core/utils.h>
65#include <osmocom/core/logging.h>
Neels Hofmeyr8e2f7e82016-09-22 03:58:13 +020066#include <osmocom/core/timer.h>
Pau Espin Pedrol662d10d2021-02-18 18:19:23 +010067#include <osmocom/core/thread.h>
Harald Welteb72867f2020-09-26 21:45:16 +020068#include <osmocom/core/select.h>
69#include <osmocom/core/write_queue.h>
Vadim Yanitskiy2f4186a2021-12-29 21:58:19 +060070#include <osmocom/core/gsmtap_util.h>
Harald Welte4a2bb9e2010-03-26 09:33:40 +080071
Pablo Neira Ayuso04139f12011-03-09 13:05:08 +010072#include <osmocom/vty/logging.h> /* for LOGGING_STR. */
73
Harald Weltea8b1b212020-09-27 17:21:07 +020074/* maximum length of the log string of a single log event (typically line) */
75#define MAX_LOG_SIZE 4096
76
Harald Welteb72867f2020-09-26 21:45:16 +020077/* maximum number of log statements we queue in file/stderr target write queue */
Harald Weltea0b57d02020-09-27 17:15:10 +020078#define LOG_WQUEUE_LEN 156
Harald Welteb72867f2020-09-26 21:45:16 +020079
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +010080osmo_static_assert(_LOG_CTX_COUNT <= ARRAY_SIZE(((struct log_context*)NULL)->ctx),
Neels Hofmeyr812ba6d2017-02-17 16:35:27 +010081 enum_logging_ctx_items_fit_in_struct_log_context);
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +010082osmo_static_assert(_LOG_FLT_COUNT <= ARRAY_SIZE(((struct log_target*)NULL)->filter_data),
Neels Hofmeyr812ba6d2017-02-17 16:35:27 +010083 enum_logging_filters_fit_in_log_target_filter_data);
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +010084osmo_static_assert(_LOG_FLT_COUNT <= 8*sizeof(((struct log_target*)NULL)->filter_map),
Neels Hofmeyr812ba6d2017-02-17 16:35:27 +010085 enum_logging_filters_fit_in_log_target_filter_map);
86
Harald Welteb43bc042011-06-27 10:29:17 +020087struct log_info *osmo_log_info;
Harald Welte4a2bb9e2010-03-26 09:33:40 +080088
Harald Welte3ae27582010-03-26 21:24:24 +080089static struct log_context log_context;
Neels Hofmeyrba0762d2018-09-10 13:56:03 +020090void *tall_log_ctx = NULL;
Harald Welte28222962011-02-18 20:37:04 +010091LLIST_HEAD(osmo_log_target_list);
Harald Welte4a2bb9e2010-03-26 09:33:40 +080092
Pau Espin Pedrol662d10d2021-02-18 18:19:23 +010093static __thread long int logging_tid;
94
Pau Espin Pedrold12f6982019-09-17 18:38:58 +020095#if (!EMBEDDED)
96/*! This mutex must be held while using osmo_log_target_list or any of its
97 log_targets in a multithread program. Prevents race conditions between threads
98 like producing unordered timestamps or VTY deleting a target while another
99 thread is writing to it */
100static pthread_mutex_t osmo_log_tgt_mutex;
101static bool osmo_log_tgt_mutex_on = false;
102
103/*! Enable multithread support (mutex) in libosmocore logging system.
104 * Must be called by processes willing to use logging subsystem from several
105 * threads. Once enabled, it's not possible to disable it again.
106 */
107void log_enable_multithread(void) {
108 if (osmo_log_tgt_mutex_on)
109 return;
110 pthread_mutex_init(&osmo_log_tgt_mutex, NULL);
111 osmo_log_tgt_mutex_on = true;
112}
113
114/*! Acquire the osmo_log_tgt_mutex. Don't use this function directly, always use
115 * macro log_tgt_mutex_lock() instead.
116 */
117void log_tgt_mutex_lock_impl(void) {
118 /* These lines are useful to debug scenarios where there's only 1 thread
119 and a double lock appears, for instance during startup and some
120 unlock() missing somewhere:
121 if (osmo_log_tgt_mutex_on && pthread_mutex_trylock(&osmo_log_tgt_mutex) != 0)
122 osmo_panic("acquiring already locked mutex!\n");
123 return;
124 */
125
126 if (osmo_log_tgt_mutex_on)
127 pthread_mutex_lock(&osmo_log_tgt_mutex);
128}
129
130/*! Release the osmo_log_tgt_mutex. Don't use this function directly, always use
131 * macro log_tgt_mutex_unlock() instead.
132 */
133void log_tgt_mutex_unlock_impl(void) {
134 if (osmo_log_tgt_mutex_on)
135 pthread_mutex_unlock(&osmo_log_tgt_mutex);
136}
137
138#else /* if (!EMBEDDED) */
139#pragma message ("logging multithread support disabled in embedded build")
140void log_enable_multithread(void) {}
141void log_tgt_mutex_lock_impl(void) {}
142void log_tgt_mutex_unlock_impl(void) {}
143#endif /* if (!EMBEDDED) */
144
Neels Hofmeyr098038a2018-09-11 23:49:13 +0200145const struct value_string loglevel_strs[] = {
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800146 { LOGL_DEBUG, "DEBUG" },
147 { LOGL_INFO, "INFO" },
148 { LOGL_NOTICE, "NOTICE" },
149 { LOGL_ERROR, "ERROR" },
150 { LOGL_FATAL, "FATAL" },
151 { 0, NULL },
152};
153
Harald Welte4c0e1a12020-12-07 22:03:09 +0100154/* 256 color palette see https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit */
Harald Welteb43bc042011-06-27 10:29:17 +0200155#define INT2IDX(x) (-1*(x)-1)
156static const struct log_info_cat internal_cat[OSMO_NUM_DLIB] = {
157 [INT2IDX(DLGLOBAL)] = { /* -1 becomes 0 */
158 .name = "DLGLOBAL",
159 .description = "Library-internal global log family",
160 .loglevel = LOGL_NOTICE,
161 .enabled = 1,
162 },
root8a996b42011-09-26 11:22:21 +0200163 [INT2IDX(DLLAPD)] = { /* -2 becomes 1 */
164 .name = "DLLAPD",
165 .description = "LAPD in libosmogsm",
Harald Welte1f0b8c22011-06-27 10:51:37 +0200166 .loglevel = LOGL_NOTICE,
167 .enabled = 1,
Pau Espin Pedrol1573add2021-10-14 18:13:48 +0200168 .color = "\033[38;5;12m",
Harald Welte1f0b8c22011-06-27 10:51:37 +0200169 },
Harald Welte892e6212011-07-19 14:31:44 +0200170 [INT2IDX(DLINP)] = {
Harald Welte087e1132011-07-29 11:43:39 +0200171 .name = "DLINP",
Pablo Neira Ayuso199f3772011-07-07 19:46:38 +0200172 .description = "A-bis Intput Subsystem",
173 .loglevel = LOGL_NOTICE,
174 .enabled = 1,
Harald Welte4c0e1a12020-12-07 22:03:09 +0100175 .color = "\033[38;5;23m",
Pablo Neira Ayuso199f3772011-07-07 19:46:38 +0200176 },
Harald Welte892e6212011-07-19 14:31:44 +0200177 [INT2IDX(DLMUX)] = {
Harald Welte087e1132011-07-29 11:43:39 +0200178 .name = "DLMUX",
Pablo Neira Ayuso199f3772011-07-07 19:46:38 +0200179 .description = "A-bis B-Subchannel TRAU Frame Multiplex",
180 .loglevel = LOGL_NOTICE,
181 .enabled = 1,
Harald Welte4c0e1a12020-12-07 22:03:09 +0100182 .color = "\033[38;5;25m",
Pablo Neira Ayuso199f3772011-07-07 19:46:38 +0200183 },
Harald Welte892e6212011-07-19 14:31:44 +0200184 [INT2IDX(DLMI)] = {
Harald Welte087e1132011-07-29 11:43:39 +0200185 .name = "DLMI",
Pablo Neira Ayuso199f3772011-07-07 19:46:38 +0200186 .description = "A-bis Input Driver for Signalling",
187 .enabled = 0, .loglevel = LOGL_NOTICE,
Harald Welte4c0e1a12020-12-07 22:03:09 +0100188 .color = "\033[38;5;27m",
Pablo Neira Ayuso199f3772011-07-07 19:46:38 +0200189 },
Harald Welte892e6212011-07-19 14:31:44 +0200190 [INT2IDX(DLMIB)] = {
Harald Welte087e1132011-07-29 11:43:39 +0200191 .name = "DLMIB",
Pablo Neira Ayuso199f3772011-07-07 19:46:38 +0200192 .description = "A-bis Input Driver for B-Channels (voice)",
193 .enabled = 0, .loglevel = LOGL_NOTICE,
Harald Welte4c0e1a12020-12-07 22:03:09 +0100194 .color = "\033[38;5;29m",
Pablo Neira Ayuso199f3772011-07-07 19:46:38 +0200195 },
Andreas Eversbergc626da92011-10-28 03:53:50 +0200196 [INT2IDX(DLSMS)] = {
197 .name = "DLSMS",
198 .description = "Layer3 Short Message Service (SMS)",
199 .enabled = 1, .loglevel = LOGL_NOTICE,
Harald Welte4c0e1a12020-12-07 22:03:09 +0100200 .color = "\033[38;5;31m",
Andreas Eversbergc626da92011-10-28 03:53:50 +0200201 },
Harald Welte7fd0c832014-08-20 19:58:13 +0200202 [INT2IDX(DLCTRL)] = {
203 .name = "DLCTRL",
204 .description = "Control Interface",
205 .enabled = 1, .loglevel = LOGL_NOTICE,
Harald Welte4c0e1a12020-12-07 22:03:09 +0100206 .color = "\033[38;5;33m",
Harald Welte7fd0c832014-08-20 19:58:13 +0200207 },
Holger Hans Peter Freythera5dc19d2014-12-04 14:35:21 +0100208 [INT2IDX(DLGTP)] = {
209 .name = "DLGTP",
210 .description = "GPRS GTP library",
211 .enabled = 1, .loglevel = LOGL_NOTICE,
Harald Welte4c0e1a12020-12-07 22:03:09 +0100212 .color = "\033[38;5;35m",
Holger Hans Peter Freythera5dc19d2014-12-04 14:35:21 +0100213 },
Jacob Erlbeck79125ec2015-11-02 15:17:50 +0100214 [INT2IDX(DLSTATS)] = {
215 .name = "DLSTATS",
216 .description = "Statistics messages and logging",
217 .enabled = 1, .loglevel = LOGL_NOTICE,
Harald Welte4c0e1a12020-12-07 22:03:09 +0100218 .color = "\033[38;5;37m",
Jacob Erlbeck79125ec2015-11-02 15:17:50 +0100219 },
Neels Hofmeyr9795cf12016-12-10 17:01:06 +0100220 [INT2IDX(DLGSUP)] = {
221 .name = "DLGSUP",
222 .description = "Generic Subscriber Update Protocol",
223 .enabled = 1, .loglevel = LOGL_NOTICE,
Harald Welte4c0e1a12020-12-07 22:03:09 +0100224 .color = "\033[38;5;39m",
Neels Hofmeyr9795cf12016-12-10 17:01:06 +0100225 },
Harald Weltec0f00072016-04-27 18:32:35 +0200226 [INT2IDX(DLOAP)] = {
227 .name = "DLOAP",
228 .description = "Osmocom Authentication Protocol",
229 .enabled = 1, .loglevel = LOGL_NOTICE,
Harald Welte4c0e1a12020-12-07 22:03:09 +0100230 .color = "\033[38;5;41m",
Harald Weltec0f00072016-04-27 18:32:35 +0200231 },
Harald Welte059c4042017-04-03 22:20:49 +0200232 [INT2IDX(DLSS7)] = {
233 .name = "DLSS7",
234 .description = "libosmo-sigtran Signalling System 7",
235 .enabled = 1, .loglevel = LOGL_NOTICE,
Harald Welte4c0e1a12020-12-07 22:03:09 +0100236 .color = "\033[38;5;43m",
Harald Welte059c4042017-04-03 22:20:49 +0200237 },
238 [INT2IDX(DLSCCP)] = {
239 .name = "DLSCCP",
240 .description = "libosmo-sigtran SCCP Implementation",
241 .enabled = 1, .loglevel = LOGL_NOTICE,
Harald Welte4c0e1a12020-12-07 22:03:09 +0100242 .color = "\033[38;5;45m",
Harald Welte059c4042017-04-03 22:20:49 +0200243 },
244 [INT2IDX(DLSUA)] = {
245 .name = "DLSUA",
246 .description = "libosmo-sigtran SCCP User Adaptation",
247 .enabled = 1, .loglevel = LOGL_NOTICE,
Harald Welte4c0e1a12020-12-07 22:03:09 +0100248 .color = "\033[38;5;47m",
Harald Welte059c4042017-04-03 22:20:49 +0200249 },
250 [INT2IDX(DLM3UA)] = {
251 .name = "DLM3UA",
252 .description = "libosmo-sigtran MTP3 User Adaptation",
253 .enabled = 1, .loglevel = LOGL_NOTICE,
Harald Welte4c0e1a12020-12-07 22:03:09 +0100254 .color = "\033[38;5;49m",
Harald Welte059c4042017-04-03 22:20:49 +0200255 },
Neels Hofmeyra7ccf612017-07-11 18:43:09 +0200256 [INT2IDX(DLMGCP)] = {
257 .name = "DLMGCP",
258 .description = "libosmo-mgcp Media Gateway Control Protocol",
259 .enabled = 1, .loglevel = LOGL_NOTICE,
Harald Welte4c0e1a12020-12-07 22:03:09 +0100260 .color = "\033[38;5;51m",
Neels Hofmeyra7ccf612017-07-11 18:43:09 +0200261 },
Pau Espin Pedrol8fd85572018-02-27 19:43:10 +0100262 [INT2IDX(DLJIBUF)] = {
263 .name = "DLJIBUF",
264 .description = "libosmo-netif Jitter Buffer",
265 .enabled = 1, .loglevel = LOGL_NOTICE,
Harald Welte4c0e1a12020-12-07 22:03:09 +0100266 .color = "\033[38;5;53m",
Pau Espin Pedrol8fd85572018-02-27 19:43:10 +0100267 },
Max450f5ac2019-02-14 19:12:03 +0100268 [INT2IDX(DLRSPRO)] = {
269 .name = "DLRSPRO",
270 .description = "Remote SIM protocol",
271 .enabled = 1, .loglevel = LOGL_NOTICE,
Harald Welte4c0e1a12020-12-07 22:03:09 +0100272 .color = "\033[38;5;55m",
Max450f5ac2019-02-14 19:12:03 +0100273 },
Alexander Couzens6a161492020-07-12 13:45:50 +0200274 [INT2IDX(DLNS)] = {
275 .name = "DLNS",
276 .description = "GPRS NS layer",
277 .enabled = 1, .loglevel = LOGL_NOTICE,
Harald Welte4c0e1a12020-12-07 22:03:09 +0100278 .color = "\033[38;5;57m",
Alexander Couzens6a161492020-07-12 13:45:50 +0200279 },
Harald Weltefde19ed2020-12-07 21:43:51 +0100280 [INT2IDX(DLBSSGP)] = {
281 .name = "DLBSSGP",
282 .description = "GPRS BSSGP layer",
283 .enabled = 1, .loglevel = LOGL_NOTICE,
Harald Welte4c0e1a12020-12-07 22:03:09 +0100284 .color = "\033[38;5;59m",
Harald Weltefde19ed2020-12-07 21:43:51 +0100285 },
Alexander Couzens6cf65d92021-01-18 17:55:35 +0100286 [INT2IDX(DLNSDATA)] = {
287 .name = "DLNSDATA",
288 .description = "GPRS NS layer data PDU",
289 .enabled = 1, .loglevel = LOGL_NOTICE,
290 .color = "\033[38;5;61m",
291 },
292 [INT2IDX(DLNSSIGNAL)] = {
293 .name = "DLNSSIGNAL",
294 .description = "GPRS NS layer signal PDU",
295 .enabled = 1, .loglevel = LOGL_NOTICE,
296 .color = "\033[38;5;63m",
297 },
Harald Welte9fe1f9f2018-11-29 13:47:39 +0100298 [INT2IDX(DLIUUP)] = {
299 .name = "DLIUUP",
300 .description = "Iu UP layer",
301 .enabled = 1, .loglevel = LOGL_NOTICE,
302 .color = "\033[38;5;65m",
303 },
Neels Hofmeyr13fa00e2021-11-26 11:02:47 +0100304 [INT2IDX(DLPFCP)] = {
305 .name = "DLPFCP",
306 .description = "libosmo-pfcp Packet Forwarding Control Protocol",
307 .enabled = 1, .loglevel = LOGL_NOTICE,
308 .color = "\033[38;5;51m",
309 },
Vadim Yanitskiy8137d9a2022-08-03 05:35:04 +0700310 [INT2IDX(DLCSN1)] = {
311 .name = "DLCSN1",
312 .description = "libosmo-csn1 Concrete Syntax Notation 1 codec",
313 .enabled = 1, .loglevel = LOGL_NOTICE,
314 .color = "\033[38;5;11m",
315 },
Harald Welte8857f3b2022-11-18 13:54:44 +0100316 [INT2IDX(DLIO)] = {
317 .name = "DLIO",
318 .description = "libosmocore IO Subsystem",
319 .enabled = 1, .loglevel = LOGL_NOTICE,
320 .color = "\033[38;5;67m",
321 },
Harald Welteb43bc042011-06-27 10:29:17 +0200322};
323
Neels Hofmeyrba0762d2018-09-10 13:56:03 +0200324void assert_loginfo(const char *src)
Harald Welte18a7d812017-03-16 23:54:55 +0100325{
326 if (!osmo_log_info) {
327 fprintf(stderr, "ERROR: osmo_log_info == NULL! "
Max68bf16a2018-01-10 17:00:43 +0100328 "You must call log_init() before using logging in %s()!\n", src);
Harald Welte18a7d812017-03-16 23:54:55 +0100329 OSMO_ASSERT(osmo_log_info);
330 }
331}
332
Harald Welteb43bc042011-06-27 10:29:17 +0200333/* special magic for negative (library-internal) log subsystem numbers */
334static int subsys_lib2index(int subsys)
335{
336 return (subsys * -1) + (osmo_log_info->num_cat_user-1);
337}
338
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200339/*! Parse a human-readable log level into a numeric value
Vadim Yanitskiy73e66b32019-03-25 21:24:20 +0700340 * \param[in] lvl zero-terminated string containing log level name
Harald Welte2d2e2cc2016-04-25 12:11:20 +0200341 * \returns numeric log level
342 */
Harald Welte3ae27582010-03-26 21:24:24 +0800343int log_parse_level(const char *lvl)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800344{
345 return get_string_value(loglevel_strs, lvl);
346}
347
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200348/*! convert a numeric log level into human-readable string
Vadim Yanitskiy73e66b32019-03-25 21:24:20 +0700349 * \param[in] lvl numeric log level
Harald Welte2d2e2cc2016-04-25 12:11:20 +0200350 * \returns zero-terminated string (log level name)
351 */
Harald Welte9ac22252010-05-11 11:19:40 +0200352const char *log_level_str(unsigned int lvl)
353{
354 return get_value_string(loglevel_strs, lvl);
355}
356
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200357/*! parse a human-readable log category into numeric form
Harald Welte18fc4652011-08-17 14:14:17 +0200358 * \param[in] category human-readable log category name
359 * \returns numeric category value, or -EINVAL otherwise
360 */
Harald Welte3ae27582010-03-26 21:24:24 +0800361int log_parse_category(const char *category)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800362{
363 int i;
364
Max68bf16a2018-01-10 17:00:43 +0100365 assert_loginfo(__func__);
Harald Welte18a7d812017-03-16 23:54:55 +0100366
Harald Welte4ebdf742010-05-19 19:54:00 +0200367 for (i = 0; i < osmo_log_info->num_cat; ++i) {
Harald Welteb43bc042011-06-27 10:29:17 +0200368 if (osmo_log_info->cat[i].name == NULL)
369 continue;
Harald Welte4ebdf742010-05-19 19:54:00 +0200370 if (!strcasecmp(osmo_log_info->cat[i].name+1, category))
Harald Weltefaadfe22010-03-26 21:05:43 +0800371 return i;
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800372 }
373
374 return -EINVAL;
375}
376
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200377/*! parse the log category mask
Harald Welte18fc4652011-08-17 14:14:17 +0200378 * \param[in] target log target to be configured
379 * \param[in] _mask log category mask string
380 *
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800381 * The format can be this: category1:category2:category3
382 * or category1,2:category2,3:...
383 */
Harald Welte3ae27582010-03-26 21:24:24 +0800384void log_parse_category_mask(struct log_target* target, const char *_mask)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800385{
386 int i = 0;
387 char *mask = strdup(_mask);
388 char *category_token = NULL;
389
Max68bf16a2018-01-10 17:00:43 +0100390 assert_loginfo(__func__);
Harald Welte18a7d812017-03-16 23:54:55 +0100391
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800392 /* Disable everything to enable it afterwards */
Harald Welteb43bc042011-06-27 10:29:17 +0200393 for (i = 0; i < osmo_log_info->num_cat; ++i)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800394 target->categories[i].enabled = 0;
395
396 category_token = strtok(mask, ":");
Neels Hofmeyrda1b20c2016-04-14 15:12:16 +0200397 OSMO_ASSERT(category_token);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800398 do {
Harald Welte4ebdf742010-05-19 19:54:00 +0200399 for (i = 0; i < osmo_log_info->num_cat; ++i) {
Nico Golde0262d3f2012-09-21 17:44:58 +0200400 size_t length, cat_length;
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800401 char* colon = strstr(category_token, ",");
Nico Golde0262d3f2012-09-21 17:44:58 +0200402
403 if (!osmo_log_info->cat[i].name)
404 continue;
405
406 length = strlen(category_token);
407 cat_length = strlen(osmo_log_info->cat[i].name);
Pablo Neira Ayuso300e78d2011-08-11 13:24:18 +0200408
409 /* Use longest length not to match subocurrences. */
410 if (cat_length > length)
411 length = cat_length;
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800412
413 if (colon)
414 length = colon - category_token;
415
Harald Welte4ebdf742010-05-19 19:54:00 +0200416 if (strncasecmp(osmo_log_info->cat[i].name,
417 category_token, length) == 0) {
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800418 int level = 0;
419
420 if (colon)
421 level = atoi(colon+1);
422
Harald Weltefaadfe22010-03-26 21:05:43 +0800423 target->categories[i].enabled = 1;
424 target->categories[i].loglevel = level;
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800425 }
426 }
427 } while ((category_token = strtok(NULL, ":")));
428
429 free(mask);
430}
431
432static const char* color(int subsys)
433{
Harald Welte4ebdf742010-05-19 19:54:00 +0200434 if (subsys < osmo_log_info->num_cat)
435 return osmo_log_info->cat[subsys].color;
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800436
Harald Welted788f662010-03-26 09:45:03 +0800437 return NULL;
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800438}
439
Neels Hofmeyrf3fa3692018-01-16 02:56:01 +0100440static const struct value_string level_colors[] = {
Neels Hofmeyrf2644ae2019-11-20 04:00:29 +0100441 { LOGL_DEBUG, OSMO_LOGCOLOR_BLUE },
442 { LOGL_INFO, OSMO_LOGCOLOR_GREEN },
443 { LOGL_NOTICE, OSMO_LOGCOLOR_YELLOW },
444 { LOGL_ERROR, OSMO_LOGCOLOR_RED },
445 { LOGL_FATAL, OSMO_LOGCOLOR_RED },
Neels Hofmeyrf3fa3692018-01-16 02:56:01 +0100446 { 0, NULL }
447};
448
449static const char *level_color(int level)
450{
451 const char *c = get_value_string_or_null(level_colors, level);
452 if (!c)
453 return get_value_string(level_colors, LOGL_FATAL);
454 return c;
455}
456
Harald Welteaa00f992016-12-02 15:30:02 +0100457const char* log_category_name(int subsys)
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100458{
459 if (subsys < osmo_log_info->num_cat)
460 return osmo_log_info->cat[subsys].name;
461
462 return NULL;
463}
464
Neels Hofmeyr0e2a9432018-01-16 02:49:48 +0100465static const char *const_basename(const char *path)
466{
467 const char *bn = strrchr(path, '/');
468 if (!bn || !bn[1])
469 return path;
470 return bn + 1;
471}
472
Harald Weltea0b57d02020-09-27 17:15:10 +0200473/*! main output formatting function for log lines.
474 * \param[out] buf caller-allocated output buffer for the generated string
475 * \param[in] buf_len number of bytes available in buf
476 * \param[in] target log target for which the string is to be formatted
477 * \param[in] subsys Log sub-system number
478 * \param[in] level Log level
479 * \param[in] file name of source code file generating the log
480 * \param[in] line line source code line number within 'file' generating the log
481 * \param[in] cont is this a continuation (true) or not (false)
482 * \param[in] format format string
483 * \param[in] ap variable argument list for format
484 * \returns number of bytes written to out */
485static int _output_buf(char *buf, int buf_len, struct log_target *target, unsigned int subsys,
486 unsigned int level, const char *file, int line, int cont,
487 const char *format, va_list ap)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800488{
Harald Weltea0b57d02020-09-27 17:15:10 +0200489 int ret, len = 0, offset = 0, rem = buf_len;
Neels Hofmeyrf3fa3692018-01-16 02:56:01 +0100490 const char *c_subsys = NULL;
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800491
492 /* are we using color */
493 if (target->use_color) {
Neels Hofmeyrf3fa3692018-01-16 02:56:01 +0100494 c_subsys = color(subsys);
495 if (c_subsys) {
Neels Hofmeyr5e518b52018-01-17 13:20:02 +0100496 ret = snprintf(buf + offset, rem, "%s", c_subsys);
Pablo Neira Ayuso7503fb82011-05-03 22:32:43 +0200497 if (ret < 0)
498 goto err;
499 OSMO_SNPRINTF_RET(ret, rem, offset, len);
Harald Welted788f662010-03-26 09:45:03 +0800500 }
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800501 }
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800502 if (!cont) {
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100503 if (target->print_ext_timestamp) {
Harald Welte14c4c492018-06-28 08:28:52 +0200504#ifdef HAVE_LOCALTIME_R
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100505 struct tm tm;
Jacob Erlbeckb61b2ca2015-03-17 10:21:15 +0100506 struct timeval tv;
Neels Hofmeyr8e2f7e82016-09-22 03:58:13 +0200507 osmo_gettimeofday(&tv, NULL);
Jacob Erlbeckb61b2ca2015-03-17 10:21:15 +0100508 localtime_r(&tv.tv_sec, &tm);
509 ret = snprintf(buf + offset, rem, "%04d%02d%02d%02d%02d%02d%03d ",
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100510 tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday,
Jacob Erlbeckb61b2ca2015-03-17 10:21:15 +0100511 tm.tm_hour, tm.tm_min, tm.tm_sec,
512 (int)(tv.tv_usec / 1000));
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100513 if (ret < 0)
514 goto err;
515 OSMO_SNPRINTF_RET(ret, rem, offset, len);
Harald Welte14c4c492018-06-28 08:28:52 +0200516#endif
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100517 } else if (target->print_timestamp) {
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800518 time_t tm;
Pau Espin Pedrol3aef2382019-06-12 18:50:29 +0200519 if ((tm = time(NULL)) == (time_t) -1)
520 goto err;
Pau Espin Pedrolcc794e92019-06-12 16:22:53 +0200521 /* Get human-readable representation of time.
522 man ctime: we need at least 26 bytes in buf */
523 if (rem < 26 || !ctime_r(&tm, buf + offset))
Pablo Neira Ayuso7503fb82011-05-03 22:32:43 +0200524 goto err;
Pau Espin Pedrolcc794e92019-06-12 16:22:53 +0200525 ret = strlen(buf + offset);
526 if (ret <= 0)
527 goto err;
528 /* Get rid of useless final '\n' added by ctime_r. We want a space instead. */
529 buf[offset + ret - 1] = ' ';
Pablo Neira Ayuso7503fb82011-05-03 22:32:43 +0200530 OSMO_SNPRINTF_RET(ret, rem, offset, len);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800531 }
Pau Espin Pedrol662d10d2021-02-18 18:19:23 +0100532 if (target->print_tid) {
533 if (logging_tid == 0)
534 logging_tid = (long int)osmo_gettid();
535 ret = snprintf(buf + offset, rem, "%ld ", logging_tid);
536 if (ret < 0)
537 goto err;
538 OSMO_SNPRINTF_RET(ret, rem, offset, len);
539 }
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100540 if (target->print_category) {
Neels Hofmeyre6534722018-01-16 03:02:06 +0100541 ret = snprintf(buf + offset, rem, "%s%s%s%s ",
542 target->use_color ? level_color(level) : "",
543 log_category_name(subsys),
Neels Hofmeyrf2644ae2019-11-20 04:00:29 +0100544 target->use_color ? OSMO_LOGCOLOR_END : "",
Neels Hofmeyre6534722018-01-16 03:02:06 +0100545 c_subsys ? c_subsys : "");
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100546 if (ret < 0)
547 goto err;
548 OSMO_SNPRINTF_RET(ret, rem, offset, len);
549 }
Neels Hofmeyr886e5482018-01-16 01:49:37 +0100550 if (target->print_level) {
Neels Hofmeyrf3fa3692018-01-16 02:56:01 +0100551 ret = snprintf(buf + offset, rem, "%s%s%s%s ",
552 target->use_color ? level_color(level) : "",
553 log_level_str(level),
Neels Hofmeyrf2644ae2019-11-20 04:00:29 +0100554 target->use_color ? OSMO_LOGCOLOR_END : "",
Neels Hofmeyrf3fa3692018-01-16 02:56:01 +0100555 c_subsys ? c_subsys : "");
Neels Hofmeyr886e5482018-01-16 01:49:37 +0100556 if (ret < 0)
557 goto err;
558 OSMO_SNPRINTF_RET(ret, rem, offset, len);
559 }
Neels Hofmeyrbd7bd392018-01-16 01:52:29 +0100560 if (target->print_category_hex) {
561 ret = snprintf(buf + offset, rem, "<%4.4x> ", subsys);
Holger Hans Peter Freytherdb153362012-09-11 11:24:51 +0200562 if (ret < 0)
563 goto err;
564 OSMO_SNPRINTF_RET(ret, rem, offset, len);
565 }
Neels Hofmeyr77ae45d2018-08-27 20:32:36 +0200566
567 if (target->print_filename_pos == LOG_FILENAME_POS_HEADER_END) {
568 switch (target->print_filename2) {
569 case LOG_FILENAME_NONE:
570 break;
571 case LOG_FILENAME_PATH:
572 ret = snprintf(buf + offset, rem, "%s:%d ", file, line);
573 if (ret < 0)
574 goto err;
575 OSMO_SNPRINTF_RET(ret, rem, offset, len);
576 break;
577 case LOG_FILENAME_BASENAME:
578 ret = snprintf(buf + offset, rem, "%s:%d ", const_basename(file), line);
579 if (ret < 0)
580 goto err;
581 OSMO_SNPRINTF_RET(ret, rem, offset, len);
582 break;
583 }
Neels Hofmeyrbd7bd392018-01-16 01:52:29 +0100584 }
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800585 }
Pablo Neira Ayuso7503fb82011-05-03 22:32:43 +0200586 ret = vsnprintf(buf + offset, rem, format, ap);
587 if (ret < 0)
588 goto err;
589 OSMO_SNPRINTF_RET(ret, rem, offset, len);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800590
Neels Hofmeyr77ae45d2018-08-27 20:32:36 +0200591 /* For LOG_FILENAME_POS_LAST, print the source file info only when the caller ended the log
592 * message in '\n'. If so, nip the last '\n' away, insert the source file info and re-append an
593 * '\n'. All this to allow LOGP("start..."); LOGPC("...end\n") constructs. */
594 if (target->print_filename_pos == LOG_FILENAME_POS_LINE_END
Vadim Yanitskiye56f1b62022-01-29 19:37:39 +0600595 && offset > 0 && buf[offset - 1] == '\n') {
Neels Hofmeyr77ae45d2018-08-27 20:32:36 +0200596 switch (target->print_filename2) {
597 case LOG_FILENAME_NONE:
598 break;
599 case LOG_FILENAME_PATH:
Vadim Yanitskiye56f1b62022-01-29 19:37:39 +0600600 offset--;
Vadim Yanitskiy83f423b2022-01-29 20:34:45 +0600601 len--;
Neels Hofmeyr77ae45d2018-08-27 20:32:36 +0200602 ret = snprintf(buf + offset, rem, " (%s:%d)\n", file, line);
603 if (ret < 0)
604 goto err;
605 OSMO_SNPRINTF_RET(ret, rem, offset, len);
606 break;
607 case LOG_FILENAME_BASENAME:
Vadim Yanitskiye56f1b62022-01-29 19:37:39 +0600608 offset--;
Vadim Yanitskiy83f423b2022-01-29 20:34:45 +0600609 len--;
Neels Hofmeyr77ae45d2018-08-27 20:32:36 +0200610 ret = snprintf(buf + offset, rem, " (%s:%d)\n", const_basename(file), line);
611 if (ret < 0)
612 goto err;
613 OSMO_SNPRINTF_RET(ret, rem, offset, len);
614 break;
615 }
616 }
617
Pau Espin Pedrol6407c822020-07-20 16:41:44 +0200618 if (target->use_color && c_subsys) {
Neels Hofmeyrf2644ae2019-11-20 04:00:29 +0100619 ret = snprintf(buf + offset, rem, OSMO_LOGCOLOR_END);
Neels Hofmeyrc4759882018-01-16 02:10:48 +0100620 if (ret < 0)
621 goto err;
622 OSMO_SNPRINTF_RET(ret, rem, offset, len);
623 }
Pablo Neira Ayuso7503fb82011-05-03 22:32:43 +0200624err:
Pau Espin Pedrolbeaf2a22022-01-04 13:36:18 +0100625 len = OSMO_MIN(buf_len - 1, len);
626 buf[len] = '\0';
Harald Weltea0b57d02020-09-27 17:15:10 +0200627 return len;
628}
629
630/* Format the log line for given target; use a stack buffer and call target->output */
631static void _output(struct log_target *target, unsigned int subsys,
632 unsigned int level, const char *file, int line, int cont,
633 const char *format, va_list ap)
634{
635 char buf[MAX_LOG_SIZE];
636 int rc;
637
638 rc = _output_buf(buf, sizeof(buf), target, subsys, level, file, line, cont, format, ap);
639 if (rc > 0)
640 target->output(target, level, buf);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800641}
642
Neels Hofmeyr42240de2016-12-12 15:13:56 +0100643/* Catch internal logging category indexes as well as out-of-bounds indexes.
644 * For internal categories, the ID is negative starting with -1; and internal
645 * logging categories are added behind the user categories. For out-of-bounds
646 * indexes, return the index of DLGLOBAL. The returned category index is
647 * guaranteed to exist in osmo_log_info, otherwise the program would abort,
648 * which should never happen unless even the DLGLOBAL category is missing. */
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +0100649static inline int map_subsys(int subsys)
650{
Neels Hofmeyr74802262016-12-12 16:00:24 +0100651 /* Note: comparing signed and unsigned integers */
652
653 if (subsys > 0 && ((unsigned int)subsys) >= osmo_log_info->num_cat_user)
654 subsys = DLGLOBAL;
655
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +0100656 if (subsys < 0)
657 subsys = subsys_lib2index(subsys);
658
Neels Hofmeyrca135742016-12-12 14:18:54 +0100659 if (subsys < 0 || subsys >= osmo_log_info->num_cat)
Neels Hofmeyr42240de2016-12-12 15:13:56 +0100660 subsys = subsys_lib2index(DLGLOBAL);
661
Neels Hofmeyrca135742016-12-12 14:18:54 +0100662 OSMO_ASSERT(!(subsys < 0 || subsys >= osmo_log_info->num_cat));
663
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +0100664 return subsys;
665}
666
Maxc65c5b42017-03-15 13:20:23 +0100667static inline bool should_log_to_target(struct log_target *tar, int subsys,
668 int level)
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +0100669{
670 struct log_category *category;
671
672 category = &tar->categories[subsys];
673
674 /* subsystem is not supposed to be logged */
675 if (!category->enabled)
Maxc65c5b42017-03-15 13:20:23 +0100676 return false;
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +0100677
678 /* Check the global log level */
679 if (tar->loglevel != 0 && level < tar->loglevel)
Maxc65c5b42017-03-15 13:20:23 +0100680 return false;
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +0100681
682 /* Check the category log level */
683 if (tar->loglevel == 0 && category->loglevel != 0 &&
684 level < category->loglevel)
Maxc65c5b42017-03-15 13:20:23 +0100685 return false;
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +0100686
Holger Hans Peter Freyther79599ac2016-01-15 16:49:06 +0100687 /* Apply filters here... if that becomes messy we will
688 * need to put filters in a list and each filter will
689 * say stop, continue, output */
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100690 if ((tar->filter_map & (1 << LOG_FLT_ALL)) != 0)
Maxc65c5b42017-03-15 13:20:23 +0100691 return true;
Holger Hans Peter Freyther79599ac2016-01-15 16:49:06 +0100692
693 if (osmo_log_info->filter_fn)
694 return osmo_log_info->filter_fn(&log_context, tar);
695
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +0100696 /* TODO: Check the filter/selector too? */
Maxc65c5b42017-03-15 13:20:23 +0100697 return true;
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +0100698}
699
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200700/*! vararg version of logging function
Harald Welte2d2e2cc2016-04-25 12:11:20 +0200701 * \param[in] subsys Logging sub-system
702 * \param[in] level Log level
703 * \param[in] file name of source code file
704 * \param[in] cont continuation (1) or new line (0)
705 * \param[in] format format string
706 * \param[in] ap vararg-list containing format string arguments
707 */
Holger Hans Peter Freytherfb4bfc22012-07-12 09:26:25 +0200708void osmo_vlogp(int subsys, int level, const char *file, int line,
Harald Welte36c5a3e2011-08-27 14:33:19 +0200709 int cont, const char *format, va_list ap)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800710{
Harald Welte3ae27582010-03-26 21:24:24 +0800711 struct log_target *tar;
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800712
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +0100713 subsys = map_subsys(subsys);
Harald Welteb43bc042011-06-27 10:29:17 +0200714
Pau Espin Pedrold12f6982019-09-17 18:38:58 +0200715 log_tgt_mutex_lock();
716
Harald Welte28222962011-02-18 20:37:04 +0100717 llist_for_each_entry(tar, &osmo_log_target_list, entry) {
Pablo Neira Ayusodd93bf42011-05-19 01:40:43 +0200718 va_list bp;
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800719
Maxc65c5b42017-03-15 13:20:23 +0100720 if (!should_log_to_target(tar, subsys, level))
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800721 continue;
722
Pablo Neira Ayusodd93bf42011-05-19 01:40:43 +0200723 /* According to the manpage, vsnprintf leaves the value of ap
724 * in undefined state. Since _output uses vsnprintf and it may
725 * be called several times, we have to pass a copy of ap. */
726 va_copy(bp, ap);
Harald Welted7c0a372016-12-02 13:52:59 +0100727 if (tar->raw_output)
728 tar->raw_output(tar, subsys, level, file, line, cont, format, bp);
729 else
730 _output(tar, subsys, level, file, line, cont, format, bp);
Pablo Neira Ayusodd93bf42011-05-19 01:40:43 +0200731 va_end(bp);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800732 }
Pau Espin Pedrold12f6982019-09-17 18:38:58 +0200733
734 log_tgt_mutex_unlock();
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800735}
736
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200737/*! logging function used by DEBUGP() macro
Harald Welte2d2e2cc2016-04-25 12:11:20 +0200738 * \param[in] subsys Logging sub-system
739 * \param[in] file name of source code file
740 * \param[in] cont continuation (1) or new line (0)
741 * \param[in] format format string
742 */
Holger Hans Peter Freytherfb4bfc22012-07-12 09:26:25 +0200743void logp(int subsys, const char *file, int line, int cont,
Harald Welte3ae27582010-03-26 21:24:24 +0800744 const char *format, ...)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800745{
746 va_list ap;
747
748 va_start(ap, format);
Harald Welte36c5a3e2011-08-27 14:33:19 +0200749 osmo_vlogp(subsys, LOGL_DEBUG, file, line, cont, format, ap);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800750 va_end(ap);
751}
752
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200753/*! logging function used by LOGP() macro
Harald Welte2d2e2cc2016-04-25 12:11:20 +0200754 * \param[in] subsys Logging sub-system
755 * \param[in] level Log level
756 * \param[in] file name of source code file
757 * \param[in] cont continuation (1) or new line (0)
758 * \param[in] format format string
759 */
Holger Hans Peter Freytherfb4bfc22012-07-12 09:26:25 +0200760void logp2(int subsys, unsigned int level, const char *file, int line, int cont, const char *format, ...)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800761{
762 va_list ap;
763
Harald Welte433005c2020-09-26 11:51:32 +0200764 TRACE(LIBOSMOCORE_LOG_START());
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800765 va_start(ap, format);
Harald Welte36c5a3e2011-08-27 14:33:19 +0200766 osmo_vlogp(subsys, level, file, line, cont, format, ap);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800767 va_end(ap);
Harald Welte433005c2020-09-26 11:51:32 +0200768 TRACE(LIBOSMOCORE_LOG_DONE());
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800769}
770
Philipp Maier4c44d462022-01-19 11:43:05 +0100771/* This logging function is used as a fallback when the logging framework is
772 * not is not properly initialized. */
773void logp_stub(const char *file, int line, int cont, const char *format, ...)
774{
775 va_list ap;
776 if (!cont)
777 fprintf(stderr, "%s:%d ", file, line);
778 va_start(ap, format);
779 vfprintf(stderr, format, ap);
780 va_end(ap);
781}
782
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200783/*! Register a new log target with the logging core
Harald Welte18fc4652011-08-17 14:14:17 +0200784 * \param[in] target Log target to be registered
785 */
Harald Welte3ae27582010-03-26 21:24:24 +0800786void log_add_target(struct log_target *target)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800787{
Harald Welte28222962011-02-18 20:37:04 +0100788 llist_add_tail(&target->entry, &osmo_log_target_list);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800789}
790
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200791/*! Unregister a log target from the logging core
Harald Welte18fc4652011-08-17 14:14:17 +0200792 * \param[in] target Log target to be unregistered
793 */
Harald Welte3ae27582010-03-26 21:24:24 +0800794void log_del_target(struct log_target *target)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800795{
796 llist_del(&target->entry);
797}
798
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200799/*! Reset (clear) the logging context */
Harald Welte3ae27582010-03-26 21:24:24 +0800800void log_reset_context(void)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800801{
Harald Welte3ae27582010-03-26 21:24:24 +0800802 memset(&log_context, 0, sizeof(log_context));
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800803}
804
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200805/*! Set the logging context
Harald Welte18fc4652011-08-17 14:14:17 +0200806 * \param[in] ctx_nr logging context number
807 * \param[in] value value to which the context is to be set
Harald Welte2d2e2cc2016-04-25 12:11:20 +0200808 * \returns 0 in case of success; negative otherwise
Harald Welte18fc4652011-08-17 14:14:17 +0200809 *
810 * A logging context is something like the subscriber identity to which
811 * the currently processed message relates, or the BTS through which it
812 * was received. As soon as this data is known, it can be set using
813 * this function. The main use of context information is for logging
814 * filters.
815 */
Harald Welte3ae27582010-03-26 21:24:24 +0800816int log_set_context(uint8_t ctx_nr, void *value)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800817{
Harald Welte3ae27582010-03-26 21:24:24 +0800818 if (ctx_nr > LOG_MAX_CTX)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800819 return -EINVAL;
820
Harald Welte3ae27582010-03-26 21:24:24 +0800821 log_context.ctx[ctx_nr] = value;
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800822
823 return 0;
824}
825
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200826/*! Enable the \ref LOG_FLT_ALL log filter
Harald Welte18fc4652011-08-17 14:14:17 +0200827 * \param[in] target Log target to be affected
828 * \param[in] all enable (1) or disable (0) the ALL filter
829 *
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100830 * When the \ref LOG_FLT_ALL filter is enabled, all log messages will be
Neels Hofmeyr812ba6d2017-02-17 16:35:27 +0100831 * printed. It acts as a wildcard. Setting it to \a 1 means there is no
832 * filtering.
Harald Welte18fc4652011-08-17 14:14:17 +0200833 */
Harald Welte3ae27582010-03-26 21:24:24 +0800834void log_set_all_filter(struct log_target *target, int all)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800835{
836 if (all)
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100837 target->filter_map |= (1 << LOG_FLT_ALL);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800838 else
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100839 target->filter_map &= ~(1 << LOG_FLT_ALL);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800840}
841
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200842/*! Enable or disable the use of colored output
Harald Welte18fc4652011-08-17 14:14:17 +0200843 * \param[in] target Log target to be affected
844 * \param[in] use_color Use color (1) or don't use color (0)
845 */
Harald Welte3ae27582010-03-26 21:24:24 +0800846void log_set_use_color(struct log_target *target, int use_color)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800847{
848 target->use_color = use_color;
849}
850
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200851/*! Enable or disable printing of timestamps while logging
Harald Welte18fc4652011-08-17 14:14:17 +0200852 * \param[in] target Log target to be affected
853 * \param[in] print_timestamp Enable (1) or disable (0) timestamps
854 */
Harald Welte3ae27582010-03-26 21:24:24 +0800855void log_set_print_timestamp(struct log_target *target, int print_timestamp)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800856{
857 target->print_timestamp = print_timestamp;
858}
859
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200860/*! Enable or disable printing of extended timestamps while logging
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100861 * \param[in] target Log target to be affected
862 * \param[in] print_timestamp Enable (1) or disable (0) timestamps
863 *
864 * When both timestamp and extended timestamp is enabled then only
865 * the extended timestamp will be used. The format of the timestamp
866 * is YYYYMMDDhhmmssnnn.
867 */
868void log_set_print_extended_timestamp(struct log_target *target, int print_timestamp)
869{
870 target->print_ext_timestamp = print_timestamp;
871}
872
Pau Espin Pedrol662d10d2021-02-18 18:19:23 +0100873/*! Enable or disable printing of timestamps while logging
874 * \param[in] target Log target to be affected
875 * \param[in] print_tid Enable (1) or disable (0) Thread ID logging
876 */
877void log_set_print_tid(struct log_target *target, int print_tid)
878{
879 target->print_tid = print_tid;
880}
881
Neels Hofmeyrbd7bd392018-01-16 01:52:29 +0100882/*! Use log_set_print_filename2() instead.
883 * Call log_set_print_filename2() with LOG_FILENAME_PATH or LOG_FILENAME_NONE, *as well as* call
884 * log_set_print_category_hex() with the argument passed to this function. This is to mirror legacy
885 * behavior, which combined the category in hex with the filename. For example, if the category-hex
886 * output were no longer affected by log_set_print_filename(), many unit tests (in libosmocore as well as
887 * dependent projects) would fail since they expect the category to disappear along with the filename.
Holger Hans Peter Freytherdb153362012-09-11 11:24:51 +0200888 * \param[in] target Log target to be affected
889 * \param[in] print_filename Enable (1) or disable (0) filenames
890 */
891void log_set_print_filename(struct log_target *target, int print_filename)
892{
Neels Hofmeyrbd7bd392018-01-16 01:52:29 +0100893 log_set_print_filename2(target, print_filename ? LOG_FILENAME_PATH : LOG_FILENAME_NONE);
894 log_set_print_category_hex(target, print_filename);
895}
896
897/*! Enable or disable printing of the filename while logging.
898 * \param[in] target Log target to be affected.
Vadim Yanitskiy73e66b32019-03-25 21:24:20 +0700899 * \param[in] lft An LOG_FILENAME_* enum value.
Neels Hofmeyrbd7bd392018-01-16 01:52:29 +0100900 * LOG_FILENAME_NONE omits the source file and line information from logs.
901 * LOG_FILENAME_PATH prints the entire source file path as passed to LOGP macros.
902 */
903void log_set_print_filename2(struct log_target *target, enum log_filename_type lft)
904{
905 target->print_filename2 = lft;
Holger Hans Peter Freytherdb153362012-09-11 11:24:51 +0200906}
907
Neels Hofmeyr77ae45d2018-08-27 20:32:36 +0200908/*! Set the position where on a log line the source file info should be logged.
909 * \param[in] target Log target to be affected.
910 * \param[in] pos A LOG_FILENAME_POS_* enum value.
911 * LOG_FILENAME_POS_DEFAULT logs just before the caller supplied log message.
912 * LOG_FILENAME_POS_LAST logs only at the end of a log line, where the caller issued an '\n' to end the
913 */
914void log_set_print_filename_pos(struct log_target *target, enum log_filename_pos pos)
915{
916 target->print_filename_pos = pos;
917}
918
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200919/*! Enable or disable printing of the category name
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100920 * \param[in] target Log target to be affected
Vadim Yanitskiy73e66b32019-03-25 21:24:20 +0700921 * \param[in] print_category Enable (1) or disable (0) filenames
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100922 *
923 * Print the category/subsys name in front of every log message.
924 */
925void log_set_print_category(struct log_target *target, int print_category)
926{
927 target->print_category = print_category;
928}
929
Neels Hofmeyrbd7bd392018-01-16 01:52:29 +0100930/*! Enable or disable printing of the category number in hex ('<000b>').
931 * \param[in] target Log target to be affected.
932 * \param[in] print_category_hex Enable (1) or disable (0) hex category.
933 */
934void log_set_print_category_hex(struct log_target *target, int print_category_hex)
935{
936 target->print_category_hex = print_category_hex;
937}
938
Neels Hofmeyr886e5482018-01-16 01:49:37 +0100939/*! Enable or disable printing of the log level name.
940 * \param[in] target Log target to be affected
Vadim Yanitskiy73e66b32019-03-25 21:24:20 +0700941 * \param[in] print_level Enable (1) or disable (0) log level name
Neels Hofmeyr886e5482018-01-16 01:49:37 +0100942 *
943 * Print the log level name in front of every log message.
944 */
945void log_set_print_level(struct log_target *target, int print_level)
946{
947 target->print_level = (bool)print_level;
948}
949
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200950/*! Set the global log level for a given log target
Harald Welte18fc4652011-08-17 14:14:17 +0200951 * \param[in] target Log target to be affected
952 * \param[in] log_level New global log level
953 */
Harald Welte3ae27582010-03-26 21:24:24 +0800954void log_set_log_level(struct log_target *target, int log_level)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800955{
956 target->loglevel = log_level;
957}
958
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200959/*! Set a category filter on a given log target
Harald Weltede6e4982012-12-06 21:25:27 +0100960 * \param[in] target Log target to be affected
961 * \param[in] category Log category to be affected
962 * \param[in] enable whether to enable or disable the filter
963 * \param[in] level Log level of the filter
964 */
Harald Welte3ae27582010-03-26 21:24:24 +0800965void log_set_category_filter(struct log_target *target, int category,
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800966 int enable, int level)
967{
Neels Hofmeyr886d6fd2016-12-12 13:49:03 +0100968 if (!target)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800969 return;
Neels Hofmeyr886d6fd2016-12-12 13:49:03 +0100970 category = map_subsys(category);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800971 target->categories[category].enabled = !!enable;
972 target->categories[category].loglevel = level;
973}
974
Harald Welte44c0f632017-01-15 17:58:29 +0100975#if (!EMBEDDED)
Harald Welte78d73672020-09-29 11:32:35 +0200976/* write-queue tells us we should write another msgb (log line) to the output fd */
977static int _file_wq_write_cb(struct osmo_fd *ofd, struct msgb *msg)
978{
979 int rc;
980
981 rc = write(ofd->fd, msgb_data(msg), msgb_length(msg));
982 if (rc < 0)
983 return rc;
984 if (rc != msgb_length(msg)) {
985 /* pull the number of bytes we have already written */
986 msgb_pull(msg, rc);
987 /* ask write_queue to re-insert the msgb at the head of the queue */
988 return -EAGAIN;
989 }
990 return 0;
991}
992
993/* output via buffered, blocking stdio streams */
Harald Welteb72867f2020-09-26 21:45:16 +0200994static void _file_output_stream(struct log_target *target, unsigned int level,
995 const char *log)
996{
997 OSMO_ASSERT(target->tgt_file.out);
998 fputs(log, target->tgt_file.out);
999 fflush(target->tgt_file.out);
1000}
1001
1002/* output via non-blocking write_queue, doing internal buffering */
Harald Weltea0b57d02020-09-27 17:15:10 +02001003static void _file_raw_output(struct log_target *target, int subsys, unsigned int level, const char *file,
1004 int line, int cont, const char *format, va_list ap)
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001005{
Harald Welteb72867f2020-09-26 21:45:16 +02001006 struct msgb *msg;
Harald Weltea0b57d02020-09-27 17:15:10 +02001007 int rc;
Harald Welteb72867f2020-09-26 21:45:16 +02001008
1009 OSMO_ASSERT(target->tgt_file.wqueue);
Harald Weltea0b57d02020-09-27 17:15:10 +02001010 msg = msgb_alloc_c(target->tgt_file.wqueue, MAX_LOG_SIZE, "log_file_msg");
Harald Welteb72867f2020-09-26 21:45:16 +02001011 if (!msg)
1012 return;
1013
1014 /* we simply enqueue the log message to a write queue here, to avoid any blocking
1015 * writes on the output file. The write queue will tell us once the file is writable
1016 * and call _file_wq_write_cb() */
Harald Weltea0b57d02020-09-27 17:15:10 +02001017 rc = _output_buf((char *)msgb_data(msg), msgb_tailroom(msg), target, subsys, level, file, line, cont, format, ap);
1018 msgb_put(msg, rc);
Harald Welte78d73672020-09-29 11:32:35 +02001019
1020 /* attempt a synchronous, non-blocking write, if the write queue is empty */
1021 if (target->tgt_file.wqueue->current_length == 0) {
1022 rc = _file_wq_write_cb(&target->tgt_file.wqueue->bfd, msg);
1023 if (rc == 0) {
1024 /* the write was complete, we can exit early */
1025 msgb_free(msg);
1026 return;
1027 }
1028 }
1029 /* if we reach here, either we already had elements in the write_queue, or the synchronous write
1030 * failed: enqueue the message to the write_queue (backlog) */
Harald Welte9a9627e2021-11-25 13:38:19 +01001031 if (osmo_wqueue_enqueue_quiet(target->tgt_file.wqueue, msg) < 0) {
1032 msgb_free(msg);
1033 /* TODO: increment some counter so we can see that messages were dropped */
1034 }
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001035}
Harald Welte44c0f632017-01-15 17:58:29 +01001036#endif
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001037
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001038/*! Create a new log target skeleton
Harald Welte2d2e2cc2016-04-25 12:11:20 +02001039 * \returns dynamically-allocated log target
1040 * This funcition allocates a \ref log_target and initializes it
1041 * with some default values. The newly created target is not
1042 * registered yet.
1043 */
Harald Welte3ae27582010-03-26 21:24:24 +08001044struct log_target *log_target_create(void)
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001045{
Harald Welte3ae27582010-03-26 21:24:24 +08001046 struct log_target *target;
Harald Weltecc6313c2010-03-26 22:04:03 +08001047 unsigned int i;
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001048
Max68bf16a2018-01-10 17:00:43 +01001049 assert_loginfo(__func__);
Harald Welte18a7d812017-03-16 23:54:55 +01001050
Harald Welte3ae27582010-03-26 21:24:24 +08001051 target = talloc_zero(tall_log_ctx, struct log_target);
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001052 if (!target)
1053 return NULL;
1054
Pau Espin Pedrol9d4a36e2018-07-26 11:55:33 +02001055 target->categories = talloc_zero_array(target,
Harald Welteb43bc042011-06-27 10:29:17 +02001056 struct log_category,
1057 osmo_log_info->num_cat);
1058 if (!target->categories) {
1059 talloc_free(target);
1060 return NULL;
1061 }
1062
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001063 INIT_LLIST_HEAD(&target->entry);
Harald Weltecc6313c2010-03-26 22:04:03 +08001064
1065 /* initialize the per-category enabled/loglevel from defaults */
Harald Welte4ebdf742010-05-19 19:54:00 +02001066 for (i = 0; i < osmo_log_info->num_cat; i++) {
Harald Weltecc6313c2010-03-26 22:04:03 +08001067 struct log_category *cat = &target->categories[i];
Harald Welte4ebdf742010-05-19 19:54:00 +02001068 cat->enabled = osmo_log_info->cat[i].enabled;
1069 cat->loglevel = osmo_log_info->cat[i].loglevel;
Harald Weltecc6313c2010-03-26 22:04:03 +08001070 }
1071
1072 /* global settings */
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001073 target->use_color = 1;
1074 target->print_timestamp = 0;
Pau Espin Pedrol662d10d2021-02-18 18:19:23 +01001075 target->print_tid = 0;
Neels Hofmeyrbd7bd392018-01-16 01:52:29 +01001076 target->print_filename2 = LOG_FILENAME_PATH;
1077 target->print_category_hex = true;
Harald Weltecc6313c2010-03-26 22:04:03 +08001078
1079 /* global log level */
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001080 target->loglevel = 0;
1081 return target;
1082}
1083
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001084/*! Create the STDERR log target
Harald Welte2d2e2cc2016-04-25 12:11:20 +02001085 * \returns dynamically-allocated \ref log_target for STDERR */
Harald Welte3ae27582010-03-26 21:24:24 +08001086struct log_target *log_target_create_stderr(void)
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001087{
Harald Weltea3b844c2010-03-27 00:04:40 +08001088/* since C89/C99 says stderr is a macro, we can safely do this! */
Harald Welteb93ce5a2017-05-15 10:58:15 +02001089#if !EMBEDDED && defined(stderr)
Harald Welte3ae27582010-03-26 21:24:24 +08001090 struct log_target *target;
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001091
Harald Welte3ae27582010-03-26 21:24:24 +08001092 target = log_target_create();
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001093 if (!target)
1094 return NULL;
1095
Harald Welte28222962011-02-18 20:37:04 +01001096 target->type = LOG_TGT_TYPE_STDERR;
Harald Welte0083cd32010-08-25 14:55:44 +02001097 target->tgt_file.out = stderr;
Harald Welteb72867f2020-09-26 21:45:16 +02001098 target->output = _file_output_stream;
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001099 return target;
Harald Weltea3b844c2010-03-27 00:04:40 +08001100#else
1101 return NULL;
1102#endif /* stderr */
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001103}
1104
Harald Welte44c0f632017-01-15 17:58:29 +01001105#if (!EMBEDDED)
Harald Welteb72867f2020-09-26 21:45:16 +02001106/*! Create a new file-based log target using buffered, blocking stream output
Harald Welte18fc4652011-08-17 14:14:17 +02001107 * \param[in] fname File name of the new log file
1108 * \returns Log target in case of success, NULL otherwise
1109 */
Harald Welteb72867f2020-09-26 21:45:16 +02001110struct log_target *log_target_create_file_stream(const char *fname)
Harald Welte3086c392010-08-25 19:10:50 +02001111{
1112 struct log_target *target;
1113
1114 target = log_target_create();
1115 if (!target)
1116 return NULL;
1117
Harald Welte28222962011-02-18 20:37:04 +01001118 target->type = LOG_TGT_TYPE_FILE;
Harald Welte3086c392010-08-25 19:10:50 +02001119 target->tgt_file.out = fopen(fname, "a");
Vadim Yanitskiyb89114b2020-09-09 04:51:04 +07001120 if (!target->tgt_file.out) {
1121 log_target_destroy(target);
Harald Welte3086c392010-08-25 19:10:50 +02001122 return NULL;
Vadim Yanitskiyb89114b2020-09-09 04:51:04 +07001123 }
Harald Welteb72867f2020-09-26 21:45:16 +02001124 target->output = _file_output_stream;
1125 target->tgt_file.fname = talloc_strdup(target, fname);
Harald Welte3086c392010-08-25 19:10:50 +02001126
Harald Welteb72867f2020-09-26 21:45:16 +02001127 return target;
1128}
1129
1130/*! switch from non-blocking/write-queue to blocking + buffered stream output
1131 * \param[in] target log target which we should switch
Pau Espin Pedrol843a84c2021-11-03 17:31:47 +01001132 * \return 0 on success; 1 if already switched before; negative on error
1133 * Must be called with mutex osmo_log_tgt_mutex held, see log_tgt_mutex_lock.
1134 */
Harald Welteb72867f2020-09-26 21:45:16 +02001135int log_target_file_switch_to_stream(struct log_target *target)
1136{
1137 struct osmo_wqueue *wq;
Harald Welteb72867f2020-09-26 21:45:16 +02001138
1139 if (!target)
1140 return -ENODEV;
1141
Harald Welteb72867f2020-09-26 21:45:16 +02001142 if (target->tgt_file.out) {
1143 /* target has already been switched over */
1144 return 1;
1145 }
1146
Harald Welteb72867f2020-09-26 21:45:16 +02001147 wq = target->tgt_file.wqueue;
1148 OSMO_ASSERT(wq);
1149
1150 /* re-open output as stream */
1151 if (target->type == LOG_TGT_TYPE_STDERR)
1152 target->tgt_file.out = stderr;
1153 else
1154 target->tgt_file.out = fopen(target->tgt_file.fname, "a");
1155 if (!target->tgt_file.out) {
Harald Welteb72867f2020-09-26 21:45:16 +02001156 return -EIO;
1157 }
1158
1159 /* synchronously write anything left in the queue */
1160 while (!llist_empty(&wq->msg_queue)) {
1161 struct msgb *msg = msgb_dequeue(&wq->msg_queue);
1162 fwrite(msgb_data(msg), msgb_length(msg), 1, target->tgt_file.out);
1163 msgb_free(msg);
1164 }
1165
1166 /* now that everything succeeded, we can finally close the old output fd */
1167 if (target->type == LOG_TGT_TYPE_FILE) {
1168 osmo_fd_unregister(&wq->bfd);
1169 close(wq->bfd.fd);
Pau Espin Pedrolfc376502023-03-14 14:32:46 +01001170 wq->bfd.fd = -1;
Harald Welteb72867f2020-09-26 21:45:16 +02001171 }
1172
1173 /* release the queue itself */
1174 talloc_free(wq);
1175 target->tgt_file.wqueue = NULL;
1176 target->output = _file_output_stream;
1177 target->raw_output = NULL;
1178
1179 return 0;
1180}
1181
1182/*! switch from blocking + buffered file output to non-blocking write-queue based output.
1183 * \param[in] target log target which we should switch
Pau Espin Pedrol843a84c2021-11-03 17:31:47 +01001184 * \return 0 on success; 1 if already switched before; negative on error
1185 * Must be called with mutex osmo_log_tgt_mutex held, see log_tgt_mutex_lock.
1186 */
Harald Welteb72867f2020-09-26 21:45:16 +02001187int log_target_file_switch_to_wqueue(struct log_target *target)
1188{
1189 struct osmo_wqueue *wq;
Harald Welteb72867f2020-09-26 21:45:16 +02001190 int rc;
1191
1192 if (!target)
1193 return -ENODEV;
1194
Harald Welteb72867f2020-09-26 21:45:16 +02001195 if (!target->tgt_file.out) {
1196 /* target has already been switched over */
1197 return 1;
1198 }
1199
Harald Welteb72867f2020-09-26 21:45:16 +02001200 /* we create a ~640kB sized talloc pool within the write-queue to ensure individual
1201 * log lines (stored as msgbs) will not put result in malloc() calls, and also to
1202 * reduce the OOM probability within logging, as the pool is already allocated */
1203 wq = talloc_pooled_object(target, struct osmo_wqueue, LOG_WQUEUE_LEN,
Harald Weltea0b57d02020-09-27 17:15:10 +02001204 LOG_WQUEUE_LEN*(sizeof(struct msgb)+MAX_LOG_SIZE));
Harald Welteb72867f2020-09-26 21:45:16 +02001205 if (!wq)
1206 return -ENOMEM;
1207 osmo_wqueue_init(wq, LOG_WQUEUE_LEN);
1208
1209 fflush(target->tgt_file.out);
1210 if (target->type == LOG_TGT_TYPE_FILE) {
1211 rc = open(target->tgt_file.fname, O_WRONLY|O_APPEND|O_CREAT|O_NONBLOCK, 0660);
1212 if (rc < 0) {
Harald Welteb72867f2020-09-26 21:45:16 +02001213 talloc_free(wq);
1214 return -errno;
1215 }
1216 } else {
1217 rc = STDERR_FILENO;
1218 }
1219 wq->bfd.fd = rc;
1220 wq->bfd.when = OSMO_FD_WRITE;
1221 wq->write_cb = _file_wq_write_cb;
1222
1223 rc = osmo_fd_register(&wq->bfd);
1224 if (rc < 0) {
1225 talloc_free(wq);
1226 return -EIO;
1227 }
1228 target->tgt_file.wqueue = wq;
Harald Weltea0b57d02020-09-27 17:15:10 +02001229 target->raw_output = _file_raw_output;
1230 target->output = NULL;
Harald Welte3086c392010-08-25 19:10:50 +02001231
Harald Welteb72867f2020-09-26 21:45:16 +02001232 /* now that everything succeeded, we can finally close the old output stream */
1233 if (target->type == LOG_TGT_TYPE_FILE)
1234 fclose(target->tgt_file.out);
1235 target->tgt_file.out = NULL;
1236
1237 return 0;
1238}
1239
1240/*! Create a new file-based log target using non-blocking write_queue
1241 * \param[in] fname File name of the new log file
1242 * \returns Log target in case of success, NULL otherwise
1243 */
1244struct log_target *log_target_create_file(const char *fname)
1245{
1246 struct log_target *target;
1247 struct osmo_wqueue *wq;
1248 int rc;
1249
1250 target = log_target_create();
1251 if (!target)
1252 return NULL;
1253
1254 target->type = LOG_TGT_TYPE_FILE;
1255 /* we create a ~640kB sized talloc pool within the write-queue to ensure individual
1256 * log lines (stored as msgbs) will not put result in malloc() calls, and also to
1257 * reduce the OOM probability within logging, as the pool is already allocated */
1258 wq = talloc_pooled_object(target, struct osmo_wqueue, LOG_WQUEUE_LEN,
Harald Weltea0b57d02020-09-27 17:15:10 +02001259 LOG_WQUEUE_LEN*(sizeof(struct msgb)+MAX_LOG_SIZE));
Harald Welteb72867f2020-09-26 21:45:16 +02001260 if (!wq) {
1261 log_target_destroy(target);
1262 return NULL;
1263 }
1264 osmo_wqueue_init(wq, LOG_WQUEUE_LEN);
1265 wq->bfd.fd = open(fname, O_WRONLY|O_APPEND|O_CREAT|O_NONBLOCK, 0660);
1266 if (wq->bfd.fd < 0) {
1267 talloc_free(wq);
1268 log_target_destroy(target);
1269 return NULL;
1270 }
1271 wq->bfd.when = OSMO_FD_WRITE;
1272 wq->write_cb = _file_wq_write_cb;
1273
1274 rc = osmo_fd_register(&wq->bfd);
1275 if (rc < 0) {
1276 talloc_free(wq);
1277 log_target_destroy(target);
1278 return NULL;
1279 }
1280
1281 target->tgt_file.wqueue = wq;
Harald Weltea0b57d02020-09-27 17:15:10 +02001282 target->raw_output = _file_raw_output;
Harald Welte3086c392010-08-25 19:10:50 +02001283 target->tgt_file.fname = talloc_strdup(target, fname);
1284
1285 return target;
1286}
Harald Welte44c0f632017-01-15 17:58:29 +01001287#endif
Harald Welte3086c392010-08-25 19:10:50 +02001288
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001289/*! Find a registered log target
Harald Welte18fc4652011-08-17 14:14:17 +02001290 * \param[in] type Log target type
1291 * \param[in] fname File name
1292 * \returns Log target (if found), NULL otherwise
Pau Espin Pedrold12f6982019-09-17 18:38:58 +02001293 * Must be called with mutex osmo_log_tgt_mutex held, see log_tgt_mutex_lock.
Harald Welte18fc4652011-08-17 14:14:17 +02001294 */
Harald Weltee6fb8902022-01-09 12:00:03 +01001295struct log_target *log_target_find(enum log_target_type type, const char *fname)
Harald Welte28222962011-02-18 20:37:04 +01001296{
1297 struct log_target *tgt;
1298
1299 llist_for_each_entry(tgt, &osmo_log_target_list, entry) {
1300 if (tgt->type != type)
1301 continue;
Maxc90f40a2018-01-11 10:52:28 +01001302 switch (tgt->type) {
1303 case LOG_TGT_TYPE_FILE:
Harald Welte28222962011-02-18 20:37:04 +01001304 if (!strcmp(fname, tgt->tgt_file.fname))
1305 return tgt;
Maxc90f40a2018-01-11 10:52:28 +01001306 break;
1307 case LOG_TGT_TYPE_GSMTAP:
1308 if (!strcmp(fname, tgt->tgt_gsmtap.hostname))
1309 return tgt;
1310 break;
1311 default:
Harald Welte28222962011-02-18 20:37:04 +01001312 return tgt;
Maxc90f40a2018-01-11 10:52:28 +01001313 }
Harald Welte28222962011-02-18 20:37:04 +01001314 }
1315 return NULL;
1316}
1317
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001318/*! Unregister, close and delete a log target
Vadim Yanitskiy73e66b32019-03-25 21:24:20 +07001319 * \param[in] target log target to unregister, close and delete */
Harald Welte3086c392010-08-25 19:10:50 +02001320void log_target_destroy(struct log_target *target)
1321{
Harald Welte3086c392010-08-25 19:10:50 +02001322 /* just in case, to make sure we don't have any references */
1323 log_del_target(target);
1324
Harald Welte44c0f632017-01-15 17:58:29 +01001325#if (!EMBEDDED)
Harald Welteb72867f2020-09-26 21:45:16 +02001326 struct osmo_wqueue *wq;
Vadim Yanitskiy744236b2020-09-09 04:42:22 +07001327 switch (target->type) {
1328 case LOG_TGT_TYPE_FILE:
Harald Welteb72867f2020-09-26 21:45:16 +02001329 case LOG_TGT_TYPE_STDERR:
1330 if (target->tgt_file.out) {
1331 if (target->type == LOG_TGT_TYPE_FILE)
1332 fclose(target->tgt_file.out);
1333 target->tgt_file.out = NULL;
1334 }
1335 wq = target->tgt_file.wqueue;
1336 if (wq) {
1337 if (wq->bfd.fd >= 0) {
Pau Espin Pedrolfc376502023-03-14 14:32:46 +01001338 osmo_fd_unregister(&wq->bfd);
Harald Welteb72867f2020-09-26 21:45:16 +02001339 if (target->type == LOG_TGT_TYPE_FILE)
1340 close(wq->bfd.fd);
1341 wq->bfd.fd = -1;
1342 }
Harald Welteb72867f2020-09-26 21:45:16 +02001343 osmo_wqueue_clear(wq);
1344 talloc_free(wq);
1345 target->tgt_file.wqueue = NULL;
1346 }
1347 talloc_free((void *)target->tgt_file.fname);
1348 target->tgt_file.fname = NULL;
Vadim Yanitskiy744236b2020-09-09 04:42:22 +07001349 break;
Vadim Yanitskiy2f4186a2021-12-29 21:58:19 +06001350 case LOG_TGT_TYPE_GSMTAP:
1351 gsmtap_source_free(target->tgt_gsmtap.gsmtap_inst);
1352 break;
Vadim Yanitskiy04f42712020-09-09 04:47:25 +07001353#ifdef HAVE_SYSLOG_H
1354 case LOG_TGT_TYPE_SYSLOG:
1355 closelog();
1356 break;
1357#endif /* HAVE_SYSLOG_H */
Vadim Yanitskiy744236b2020-09-09 04:42:22 +07001358 default:
1359 /* make GCC happy */
1360 break;
Harald Welte3086c392010-08-25 19:10:50 +02001361 }
Harald Welte44c0f632017-01-15 17:58:29 +01001362#endif
Harald Welte3086c392010-08-25 19:10:50 +02001363
1364 talloc_free(target);
1365}
1366
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001367/*! close and re-open a log file (for log file rotation)
Harald Welte2d2e2cc2016-04-25 12:11:20 +02001368 * \param[in] target log target to re-open
1369 * \returns 0 in case of success; negative otherwise */
Harald Welte3086c392010-08-25 19:10:50 +02001370int log_target_file_reopen(struct log_target *target)
1371{
Harald Welteb72867f2020-09-26 21:45:16 +02001372 struct osmo_wqueue *wq;
1373 int rc;
Harald Welte3086c392010-08-25 19:10:50 +02001374
Harald Welteb72867f2020-09-26 21:45:16 +02001375 OSMO_ASSERT(target->type == LOG_TGT_TYPE_FILE || target->type == LOG_TGT_TYPE_STDERR);
1376 OSMO_ASSERT(target->tgt_file.out || target->tgt_file.wqueue);
Harald Welte3086c392010-08-25 19:10:50 +02001377
Harald Welteb72867f2020-09-26 21:45:16 +02001378 if (target->tgt_file.out) {
1379 fclose(target->tgt_file.out);
1380 target->tgt_file.out = fopen(target->tgt_file.fname, "a");
1381 if (!target->tgt_file.out)
1382 return -errno;
1383 } else {
1384 wq = target->tgt_file.wqueue;
Harald Welteb72867f2020-09-26 21:45:16 +02001385 if (wq->bfd.fd >= 0) {
Pau Espin Pedrolfc376502023-03-14 14:32:46 +01001386 osmo_fd_unregister(&wq->bfd);
Harald Welteb72867f2020-09-26 21:45:16 +02001387 close(wq->bfd.fd);
1388 wq->bfd.fd = -1;
1389 }
1390
1391 rc = open(target->tgt_file.fname, O_WRONLY|O_APPEND|O_CREAT|O_NONBLOCK, 0660);
1392 if (rc < 0)
1393 return -errno;
1394 wq->bfd.fd = rc;
1395 rc = osmo_fd_register(&wq->bfd);
1396 if (rc < 0)
1397 return rc;
1398 }
Harald Welte3086c392010-08-25 19:10:50 +02001399
1400 return 0;
1401}
1402
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001403/*! close and re-open all log files (for log file rotation)
Harald Welte2d2e2cc2016-04-25 12:11:20 +02001404 * \returns 0 in case of success; negative otherwise */
Harald Welte4de854d2013-03-18 19:01:40 +01001405int log_targets_reopen(void)
1406{
1407 struct log_target *tar;
1408 int rc = 0;
1409
Pau Espin Pedrold12f6982019-09-17 18:38:58 +02001410 log_tgt_mutex_lock();
1411
Harald Welte4de854d2013-03-18 19:01:40 +01001412 llist_for_each_entry(tar, &osmo_log_target_list, entry) {
1413 switch (tar->type) {
1414 case LOG_TGT_TYPE_FILE:
1415 if (log_target_file_reopen(tar) < 0)
1416 rc = -1;
1417 break;
1418 default:
1419 break;
1420 }
1421 }
1422
Pau Espin Pedrold12f6982019-09-17 18:38:58 +02001423 log_tgt_mutex_unlock();
1424
Harald Welte4de854d2013-03-18 19:01:40 +01001425 return rc;
1426}
1427
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001428/*! Initialize the Osmocom logging core
Max72dfd432018-12-04 11:24:18 +01001429 * \param[in] inf Information regarding logging categories, could be NULL
Vadim Yanitskiy73e66b32019-03-25 21:24:20 +07001430 * \param[in] ctx talloc context for logging allocations
Harald Welte18fc4652011-08-17 14:14:17 +02001431 * \returns 0 in case of success, negative in case of error
Max72dfd432018-12-04 11:24:18 +01001432 *
1433 * If inf is NULL then only library-internal categories are initialized.
Harald Welte18fc4652011-08-17 14:14:17 +02001434 */
Harald Welteb43bc042011-06-27 10:29:17 +02001435int log_init(const struct log_info *inf, void *ctx)
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001436{
Harald Welteb43bc042011-06-27 10:29:17 +02001437 int i;
Philipp Maierdcad1c52020-03-25 11:25:59 +01001438 struct log_info_cat *cat_ptr;
Harald Welteb43bc042011-06-27 10:29:17 +02001439
Philipp Maierdc02c062020-05-12 17:51:25 +02001440 /* Ensure that log_init is not called multiple times */
1441 OSMO_ASSERT(tall_log_ctx == NULL)
1442
Harald Welteb43bc042011-06-27 10:29:17 +02001443 tall_log_ctx = talloc_named_const(ctx, 1, "logging");
1444 if (!tall_log_ctx)
1445 return -ENOMEM;
1446
1447 osmo_log_info = talloc_zero(tall_log_ctx, struct log_info);
1448 if (!osmo_log_info)
1449 return -ENOMEM;
1450
Max72dfd432018-12-04 11:24:18 +01001451 osmo_log_info->num_cat = ARRAY_SIZE(internal_cat);
1452
1453 if (inf) {
1454 osmo_log_info->filter_fn = inf->filter_fn;
1455 osmo_log_info->num_cat_user = inf->num_cat;
1456 osmo_log_info->num_cat += inf->num_cat;
1457 }
Harald Welteb43bc042011-06-27 10:29:17 +02001458
Philipp Maierdcad1c52020-03-25 11:25:59 +01001459 cat_ptr = talloc_zero_array(osmo_log_info, struct log_info_cat,
1460 osmo_log_info->num_cat);
1461 if (!cat_ptr) {
Harald Welteb43bc042011-06-27 10:29:17 +02001462 talloc_free(osmo_log_info);
1463 osmo_log_info = NULL;
1464 return -ENOMEM;
1465 }
1466
Philipp Maierdcad1c52020-03-25 11:25:59 +01001467 /* copy over the user part and sanitize loglevel */
1468 if (inf) {
Max72dfd432018-12-04 11:24:18 +01001469 for (i = 0; i < inf->num_cat; i++) {
Philipp Maierdcad1c52020-03-25 11:25:59 +01001470 memcpy(&cat_ptr[i], &inf->cat[i],
1471 sizeof(struct log_info_cat));
1472
1473 /* Make sure that the loglevel is set to NOTICE in case
1474 * no loglevel has been preset. */
1475 if (!cat_ptr[i].loglevel) {
1476 cat_ptr[i].loglevel = LOGL_NOTICE;
1477 }
Max72dfd432018-12-04 11:24:18 +01001478 }
Harald Welteb43bc042011-06-27 10:29:17 +02001479 }
1480
1481 /* copy over the library part */
Harald Welte9fe16522011-06-27 14:00:03 +02001482 for (i = 0; i < ARRAY_SIZE(internal_cat); i++) {
Harald Weltece9fec32011-06-27 14:19:16 +02001483 unsigned int cn = osmo_log_info->num_cat_user + i;
Philipp Maierdcad1c52020-03-25 11:25:59 +01001484 memcpy(&cat_ptr[cn], &internal_cat[i], sizeof(struct log_info_cat));
Harald Welte9fe16522011-06-27 14:00:03 +02001485 }
1486
Philipp Maierdcad1c52020-03-25 11:25:59 +01001487 osmo_log_info->cat = cat_ptr;
1488
Harald Welte9fe16522011-06-27 14:00:03 +02001489 return 0;
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001490}
Harald Welte18fc4652011-08-17 14:14:17 +02001491
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001492/* De-initialize the Osmocom logging core
Harald Welte69e6c3c2016-04-20 10:41:27 +02001493 * This function destroys all targets and releases associated memory */
1494void log_fini(void)
1495{
1496 struct log_target *tar, *tar2;
1497
Pau Espin Pedrold12f6982019-09-17 18:38:58 +02001498 log_tgt_mutex_lock();
1499
Harald Welte69e6c3c2016-04-20 10:41:27 +02001500 llist_for_each_entry_safe(tar, tar2, &osmo_log_target_list, entry)
1501 log_target_destroy(tar);
1502
1503 talloc_free(osmo_log_info);
1504 osmo_log_info = NULL;
1505 talloc_free(tall_log_ctx);
1506 tall_log_ctx = NULL;
Pau Espin Pedrold12f6982019-09-17 18:38:58 +02001507
1508 log_tgt_mutex_unlock();
Harald Welte69e6c3c2016-04-20 10:41:27 +02001509}
1510
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001511/*! Check whether a log entry will be generated.
Jacob Erlbeckde6dd722015-11-17 11:52:24 +01001512 * \returns != 0 if a log entry might get generated by at least one target */
1513int log_check_level(int subsys, unsigned int level)
1514{
1515 struct log_target *tar;
1516
Max68bf16a2018-01-10 17:00:43 +01001517 assert_loginfo(__func__);
Harald Welte18a7d812017-03-16 23:54:55 +01001518
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +01001519 subsys = map_subsys(subsys);
Jacob Erlbeckde6dd722015-11-17 11:52:24 +01001520
1521 /* TODO: The following could/should be cached (update on config) */
1522
Pau Espin Pedrold12f6982019-09-17 18:38:58 +02001523 log_tgt_mutex_lock();
1524
Jacob Erlbeckde6dd722015-11-17 11:52:24 +01001525 llist_for_each_entry(tar, &osmo_log_target_list, entry) {
Maxc65c5b42017-03-15 13:20:23 +01001526 if (!should_log_to_target(tar, subsys, level))
Jacob Erlbeckde6dd722015-11-17 11:52:24 +01001527 continue;
1528
1529 /* This might get logged (ignoring filters) */
Pau Espin Pedrold12f6982019-09-17 18:38:58 +02001530 log_tgt_mutex_unlock();
Jacob Erlbeckde6dd722015-11-17 11:52:24 +01001531 return 1;
1532 }
1533
1534 /* We are sure, that this will not be logged. */
Pau Espin Pedrold12f6982019-09-17 18:38:58 +02001535 log_tgt_mutex_unlock();
Jacob Erlbeckde6dd722015-11-17 11:52:24 +01001536 return 0;
1537}
1538
Sylvain Munautdca7d2c2012-04-18 21:53:23 +02001539/*! @} */