blob: ce42e4c91763c0df634078f51e55aa95dcb34ea3 [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
Harald Welte01fd5cb2010-03-26 23:51:31 +080028#include "../config.h"
29
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 Welteb43bc042011-06-27 10:29:17 +0200316};
317
Neels Hofmeyrba0762d2018-09-10 13:56:03 +0200318void assert_loginfo(const char *src)
Harald Welte18a7d812017-03-16 23:54:55 +0100319{
320 if (!osmo_log_info) {
321 fprintf(stderr, "ERROR: osmo_log_info == NULL! "
Max68bf16a2018-01-10 17:00:43 +0100322 "You must call log_init() before using logging in %s()!\n", src);
Harald Welte18a7d812017-03-16 23:54:55 +0100323 OSMO_ASSERT(osmo_log_info);
324 }
325}
326
Harald Welteb43bc042011-06-27 10:29:17 +0200327/* special magic for negative (library-internal) log subsystem numbers */
328static int subsys_lib2index(int subsys)
329{
330 return (subsys * -1) + (osmo_log_info->num_cat_user-1);
331}
332
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200333/*! Parse a human-readable log level into a numeric value
Vadim Yanitskiy73e66b32019-03-25 21:24:20 +0700334 * \param[in] lvl zero-terminated string containing log level name
Harald Welte2d2e2cc2016-04-25 12:11:20 +0200335 * \returns numeric log level
336 */
Harald Welte3ae27582010-03-26 21:24:24 +0800337int log_parse_level(const char *lvl)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800338{
339 return get_string_value(loglevel_strs, lvl);
340}
341
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200342/*! convert a numeric log level into human-readable string
Vadim Yanitskiy73e66b32019-03-25 21:24:20 +0700343 * \param[in] lvl numeric log level
Harald Welte2d2e2cc2016-04-25 12:11:20 +0200344 * \returns zero-terminated string (log level name)
345 */
Harald Welte9ac22252010-05-11 11:19:40 +0200346const char *log_level_str(unsigned int lvl)
347{
348 return get_value_string(loglevel_strs, lvl);
349}
350
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200351/*! parse a human-readable log category into numeric form
Harald Welte18fc4652011-08-17 14:14:17 +0200352 * \param[in] category human-readable log category name
353 * \returns numeric category value, or -EINVAL otherwise
354 */
Harald Welte3ae27582010-03-26 21:24:24 +0800355int log_parse_category(const char *category)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800356{
357 int i;
358
Max68bf16a2018-01-10 17:00:43 +0100359 assert_loginfo(__func__);
Harald Welte18a7d812017-03-16 23:54:55 +0100360
Harald Welte4ebdf742010-05-19 19:54:00 +0200361 for (i = 0; i < osmo_log_info->num_cat; ++i) {
Harald Welteb43bc042011-06-27 10:29:17 +0200362 if (osmo_log_info->cat[i].name == NULL)
363 continue;
Harald Welte4ebdf742010-05-19 19:54:00 +0200364 if (!strcasecmp(osmo_log_info->cat[i].name+1, category))
Harald Weltefaadfe22010-03-26 21:05:43 +0800365 return i;
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800366 }
367
368 return -EINVAL;
369}
370
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200371/*! parse the log category mask
Harald Welte18fc4652011-08-17 14:14:17 +0200372 * \param[in] target log target to be configured
373 * \param[in] _mask log category mask string
374 *
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800375 * The format can be this: category1:category2:category3
376 * or category1,2:category2,3:...
377 */
Harald Welte3ae27582010-03-26 21:24:24 +0800378void log_parse_category_mask(struct log_target* target, const char *_mask)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800379{
380 int i = 0;
381 char *mask = strdup(_mask);
382 char *category_token = NULL;
383
Max68bf16a2018-01-10 17:00:43 +0100384 assert_loginfo(__func__);
Harald Welte18a7d812017-03-16 23:54:55 +0100385
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800386 /* Disable everything to enable it afterwards */
Harald Welteb43bc042011-06-27 10:29:17 +0200387 for (i = 0; i < osmo_log_info->num_cat; ++i)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800388 target->categories[i].enabled = 0;
389
390 category_token = strtok(mask, ":");
Neels Hofmeyrda1b20c2016-04-14 15:12:16 +0200391 OSMO_ASSERT(category_token);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800392 do {
Harald Welte4ebdf742010-05-19 19:54:00 +0200393 for (i = 0; i < osmo_log_info->num_cat; ++i) {
Nico Golde0262d3f2012-09-21 17:44:58 +0200394 size_t length, cat_length;
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800395 char* colon = strstr(category_token, ",");
Nico Golde0262d3f2012-09-21 17:44:58 +0200396
397 if (!osmo_log_info->cat[i].name)
398 continue;
399
400 length = strlen(category_token);
401 cat_length = strlen(osmo_log_info->cat[i].name);
Pablo Neira Ayuso300e78d2011-08-11 13:24:18 +0200402
403 /* Use longest length not to match subocurrences. */
404 if (cat_length > length)
405 length = cat_length;
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800406
407 if (colon)
408 length = colon - category_token;
409
Harald Welte4ebdf742010-05-19 19:54:00 +0200410 if (strncasecmp(osmo_log_info->cat[i].name,
411 category_token, length) == 0) {
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800412 int level = 0;
413
414 if (colon)
415 level = atoi(colon+1);
416
Harald Weltefaadfe22010-03-26 21:05:43 +0800417 target->categories[i].enabled = 1;
418 target->categories[i].loglevel = level;
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800419 }
420 }
421 } while ((category_token = strtok(NULL, ":")));
422
423 free(mask);
424}
425
426static const char* color(int subsys)
427{
Harald Welte4ebdf742010-05-19 19:54:00 +0200428 if (subsys < osmo_log_info->num_cat)
429 return osmo_log_info->cat[subsys].color;
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800430
Harald Welted788f662010-03-26 09:45:03 +0800431 return NULL;
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800432}
433
Neels Hofmeyrf3fa3692018-01-16 02:56:01 +0100434static const struct value_string level_colors[] = {
Neels Hofmeyrf2644ae2019-11-20 04:00:29 +0100435 { LOGL_DEBUG, OSMO_LOGCOLOR_BLUE },
436 { LOGL_INFO, OSMO_LOGCOLOR_GREEN },
437 { LOGL_NOTICE, OSMO_LOGCOLOR_YELLOW },
438 { LOGL_ERROR, OSMO_LOGCOLOR_RED },
439 { LOGL_FATAL, OSMO_LOGCOLOR_RED },
Neels Hofmeyrf3fa3692018-01-16 02:56:01 +0100440 { 0, NULL }
441};
442
443static const char *level_color(int level)
444{
445 const char *c = get_value_string_or_null(level_colors, level);
446 if (!c)
447 return get_value_string(level_colors, LOGL_FATAL);
448 return c;
449}
450
Harald Welteaa00f992016-12-02 15:30:02 +0100451const char* log_category_name(int subsys)
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100452{
453 if (subsys < osmo_log_info->num_cat)
454 return osmo_log_info->cat[subsys].name;
455
456 return NULL;
457}
458
Neels Hofmeyr0e2a9432018-01-16 02:49:48 +0100459static const char *const_basename(const char *path)
460{
461 const char *bn = strrchr(path, '/');
462 if (!bn || !bn[1])
463 return path;
464 return bn + 1;
465}
466
Harald Weltea0b57d02020-09-27 17:15:10 +0200467/*! main output formatting function for log lines.
468 * \param[out] buf caller-allocated output buffer for the generated string
469 * \param[in] buf_len number of bytes available in buf
470 * \param[in] target log target for which the string is to be formatted
471 * \param[in] subsys Log sub-system number
472 * \param[in] level Log level
473 * \param[in] file name of source code file generating the log
474 * \param[in] line line source code line number within 'file' generating the log
475 * \param[in] cont is this a continuation (true) or not (false)
476 * \param[in] format format string
477 * \param[in] ap variable argument list for format
478 * \returns number of bytes written to out */
479static int _output_buf(char *buf, int buf_len, struct log_target *target, unsigned int subsys,
480 unsigned int level, const char *file, int line, int cont,
481 const char *format, va_list ap)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800482{
Harald Weltea0b57d02020-09-27 17:15:10 +0200483 int ret, len = 0, offset = 0, rem = buf_len;
Neels Hofmeyrf3fa3692018-01-16 02:56:01 +0100484 const char *c_subsys = NULL;
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800485
486 /* are we using color */
487 if (target->use_color) {
Neels Hofmeyrf3fa3692018-01-16 02:56:01 +0100488 c_subsys = color(subsys);
489 if (c_subsys) {
Neels Hofmeyr5e518b52018-01-17 13:20:02 +0100490 ret = snprintf(buf + offset, rem, "%s", c_subsys);
Pablo Neira Ayuso7503fb82011-05-03 22:32:43 +0200491 if (ret < 0)
492 goto err;
493 OSMO_SNPRINTF_RET(ret, rem, offset, len);
Harald Welted788f662010-03-26 09:45:03 +0800494 }
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800495 }
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800496 if (!cont) {
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100497 if (target->print_ext_timestamp) {
Harald Welte14c4c492018-06-28 08:28:52 +0200498#ifdef HAVE_LOCALTIME_R
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100499 struct tm tm;
Jacob Erlbeckb61b2ca2015-03-17 10:21:15 +0100500 struct timeval tv;
Neels Hofmeyr8e2f7e82016-09-22 03:58:13 +0200501 osmo_gettimeofday(&tv, NULL);
Jacob Erlbeckb61b2ca2015-03-17 10:21:15 +0100502 localtime_r(&tv.tv_sec, &tm);
503 ret = snprintf(buf + offset, rem, "%04d%02d%02d%02d%02d%02d%03d ",
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100504 tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday,
Jacob Erlbeckb61b2ca2015-03-17 10:21:15 +0100505 tm.tm_hour, tm.tm_min, tm.tm_sec,
506 (int)(tv.tv_usec / 1000));
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100507 if (ret < 0)
508 goto err;
509 OSMO_SNPRINTF_RET(ret, rem, offset, len);
Harald Welte14c4c492018-06-28 08:28:52 +0200510#endif
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100511 } else if (target->print_timestamp) {
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800512 time_t tm;
Pau Espin Pedrol3aef2382019-06-12 18:50:29 +0200513 if ((tm = time(NULL)) == (time_t) -1)
514 goto err;
Pau Espin Pedrolcc794e92019-06-12 16:22:53 +0200515 /* Get human-readable representation of time.
516 man ctime: we need at least 26 bytes in buf */
517 if (rem < 26 || !ctime_r(&tm, buf + offset))
Pablo Neira Ayuso7503fb82011-05-03 22:32:43 +0200518 goto err;
Pau Espin Pedrolcc794e92019-06-12 16:22:53 +0200519 ret = strlen(buf + offset);
520 if (ret <= 0)
521 goto err;
522 /* Get rid of useless final '\n' added by ctime_r. We want a space instead. */
523 buf[offset + ret - 1] = ' ';
Pablo Neira Ayuso7503fb82011-05-03 22:32:43 +0200524 OSMO_SNPRINTF_RET(ret, rem, offset, len);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800525 }
Pau Espin Pedrol662d10d2021-02-18 18:19:23 +0100526 if (target->print_tid) {
527 if (logging_tid == 0)
528 logging_tid = (long int)osmo_gettid();
529 ret = snprintf(buf + offset, rem, "%ld ", logging_tid);
530 if (ret < 0)
531 goto err;
532 OSMO_SNPRINTF_RET(ret, rem, offset, len);
533 }
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100534 if (target->print_category) {
Neels Hofmeyre6534722018-01-16 03:02:06 +0100535 ret = snprintf(buf + offset, rem, "%s%s%s%s ",
536 target->use_color ? level_color(level) : "",
537 log_category_name(subsys),
Neels Hofmeyrf2644ae2019-11-20 04:00:29 +0100538 target->use_color ? OSMO_LOGCOLOR_END : "",
Neels Hofmeyre6534722018-01-16 03:02:06 +0100539 c_subsys ? c_subsys : "");
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100540 if (ret < 0)
541 goto err;
542 OSMO_SNPRINTF_RET(ret, rem, offset, len);
543 }
Neels Hofmeyr886e5482018-01-16 01:49:37 +0100544 if (target->print_level) {
Neels Hofmeyrf3fa3692018-01-16 02:56:01 +0100545 ret = snprintf(buf + offset, rem, "%s%s%s%s ",
546 target->use_color ? level_color(level) : "",
547 log_level_str(level),
Neels Hofmeyrf2644ae2019-11-20 04:00:29 +0100548 target->use_color ? OSMO_LOGCOLOR_END : "",
Neels Hofmeyrf3fa3692018-01-16 02:56:01 +0100549 c_subsys ? c_subsys : "");
Neels Hofmeyr886e5482018-01-16 01:49:37 +0100550 if (ret < 0)
551 goto err;
552 OSMO_SNPRINTF_RET(ret, rem, offset, len);
553 }
Neels Hofmeyrbd7bd392018-01-16 01:52:29 +0100554 if (target->print_category_hex) {
555 ret = snprintf(buf + offset, rem, "<%4.4x> ", subsys);
Holger Hans Peter Freytherdb153362012-09-11 11:24:51 +0200556 if (ret < 0)
557 goto err;
558 OSMO_SNPRINTF_RET(ret, rem, offset, len);
559 }
Neels Hofmeyr77ae45d2018-08-27 20:32:36 +0200560
561 if (target->print_filename_pos == LOG_FILENAME_POS_HEADER_END) {
562 switch (target->print_filename2) {
563 case LOG_FILENAME_NONE:
564 break;
565 case LOG_FILENAME_PATH:
566 ret = snprintf(buf + offset, rem, "%s:%d ", file, line);
567 if (ret < 0)
568 goto err;
569 OSMO_SNPRINTF_RET(ret, rem, offset, len);
570 break;
571 case LOG_FILENAME_BASENAME:
572 ret = snprintf(buf + offset, rem, "%s:%d ", const_basename(file), line);
573 if (ret < 0)
574 goto err;
575 OSMO_SNPRINTF_RET(ret, rem, offset, len);
576 break;
577 }
Neels Hofmeyrbd7bd392018-01-16 01:52:29 +0100578 }
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800579 }
Pablo Neira Ayuso7503fb82011-05-03 22:32:43 +0200580 ret = vsnprintf(buf + offset, rem, format, ap);
581 if (ret < 0)
582 goto err;
583 OSMO_SNPRINTF_RET(ret, rem, offset, len);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800584
Neels Hofmeyr77ae45d2018-08-27 20:32:36 +0200585 /* For LOG_FILENAME_POS_LAST, print the source file info only when the caller ended the log
586 * message in '\n'. If so, nip the last '\n' away, insert the source file info and re-append an
587 * '\n'. All this to allow LOGP("start..."); LOGPC("...end\n") constructs. */
588 if (target->print_filename_pos == LOG_FILENAME_POS_LINE_END
Vadim Yanitskiye56f1b62022-01-29 19:37:39 +0600589 && offset > 0 && buf[offset - 1] == '\n') {
Neels Hofmeyr77ae45d2018-08-27 20:32:36 +0200590 switch (target->print_filename2) {
591 case LOG_FILENAME_NONE:
592 break;
593 case LOG_FILENAME_PATH:
Vadim Yanitskiye56f1b62022-01-29 19:37:39 +0600594 offset--;
Vadim Yanitskiy83f423b2022-01-29 20:34:45 +0600595 len--;
Neels Hofmeyr77ae45d2018-08-27 20:32:36 +0200596 ret = snprintf(buf + offset, rem, " (%s:%d)\n", file, line);
597 if (ret < 0)
598 goto err;
599 OSMO_SNPRINTF_RET(ret, rem, offset, len);
600 break;
601 case LOG_FILENAME_BASENAME:
Vadim Yanitskiye56f1b62022-01-29 19:37:39 +0600602 offset--;
Vadim Yanitskiy83f423b2022-01-29 20:34:45 +0600603 len--;
Neels Hofmeyr77ae45d2018-08-27 20:32:36 +0200604 ret = snprintf(buf + offset, rem, " (%s:%d)\n", const_basename(file), line);
605 if (ret < 0)
606 goto err;
607 OSMO_SNPRINTF_RET(ret, rem, offset, len);
608 break;
609 }
610 }
611
Pau Espin Pedrol6407c822020-07-20 16:41:44 +0200612 if (target->use_color && c_subsys) {
Neels Hofmeyrf2644ae2019-11-20 04:00:29 +0100613 ret = snprintf(buf + offset, rem, OSMO_LOGCOLOR_END);
Neels Hofmeyrc4759882018-01-16 02:10:48 +0100614 if (ret < 0)
615 goto err;
616 OSMO_SNPRINTF_RET(ret, rem, offset, len);
617 }
Pablo Neira Ayuso7503fb82011-05-03 22:32:43 +0200618err:
Pau Espin Pedrolbeaf2a22022-01-04 13:36:18 +0100619 len = OSMO_MIN(buf_len - 1, len);
620 buf[len] = '\0';
Harald Weltea0b57d02020-09-27 17:15:10 +0200621 return len;
622}
623
624/* Format the log line for given target; use a stack buffer and call target->output */
625static void _output(struct log_target *target, unsigned int subsys,
626 unsigned int level, const char *file, int line, int cont,
627 const char *format, va_list ap)
628{
629 char buf[MAX_LOG_SIZE];
630 int rc;
631
632 rc = _output_buf(buf, sizeof(buf), target, subsys, level, file, line, cont, format, ap);
633 if (rc > 0)
634 target->output(target, level, buf);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800635}
636
Neels Hofmeyr42240de2016-12-12 15:13:56 +0100637/* Catch internal logging category indexes as well as out-of-bounds indexes.
638 * For internal categories, the ID is negative starting with -1; and internal
639 * logging categories are added behind the user categories. For out-of-bounds
640 * indexes, return the index of DLGLOBAL. The returned category index is
641 * guaranteed to exist in osmo_log_info, otherwise the program would abort,
642 * which should never happen unless even the DLGLOBAL category is missing. */
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +0100643static inline int map_subsys(int subsys)
644{
Neels Hofmeyr74802262016-12-12 16:00:24 +0100645 /* Note: comparing signed and unsigned integers */
646
647 if (subsys > 0 && ((unsigned int)subsys) >= osmo_log_info->num_cat_user)
648 subsys = DLGLOBAL;
649
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +0100650 if (subsys < 0)
651 subsys = subsys_lib2index(subsys);
652
Neels Hofmeyrca135742016-12-12 14:18:54 +0100653 if (subsys < 0 || subsys >= osmo_log_info->num_cat)
Neels Hofmeyr42240de2016-12-12 15:13:56 +0100654 subsys = subsys_lib2index(DLGLOBAL);
655
Neels Hofmeyrca135742016-12-12 14:18:54 +0100656 OSMO_ASSERT(!(subsys < 0 || subsys >= osmo_log_info->num_cat));
657
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +0100658 return subsys;
659}
660
Maxc65c5b42017-03-15 13:20:23 +0100661static inline bool should_log_to_target(struct log_target *tar, int subsys,
662 int level)
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +0100663{
664 struct log_category *category;
665
666 category = &tar->categories[subsys];
667
668 /* subsystem is not supposed to be logged */
669 if (!category->enabled)
Maxc65c5b42017-03-15 13:20:23 +0100670 return false;
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +0100671
672 /* Check the global log level */
673 if (tar->loglevel != 0 && level < tar->loglevel)
Maxc65c5b42017-03-15 13:20:23 +0100674 return false;
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +0100675
676 /* Check the category log level */
677 if (tar->loglevel == 0 && category->loglevel != 0 &&
678 level < category->loglevel)
Maxc65c5b42017-03-15 13:20:23 +0100679 return false;
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +0100680
Holger Hans Peter Freyther79599ac2016-01-15 16:49:06 +0100681 /* Apply filters here... if that becomes messy we will
682 * need to put filters in a list and each filter will
683 * say stop, continue, output */
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100684 if ((tar->filter_map & (1 << LOG_FLT_ALL)) != 0)
Maxc65c5b42017-03-15 13:20:23 +0100685 return true;
Holger Hans Peter Freyther79599ac2016-01-15 16:49:06 +0100686
687 if (osmo_log_info->filter_fn)
688 return osmo_log_info->filter_fn(&log_context, tar);
689
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +0100690 /* TODO: Check the filter/selector too? */
Maxc65c5b42017-03-15 13:20:23 +0100691 return true;
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +0100692}
693
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200694/*! vararg version of logging function
Harald Welte2d2e2cc2016-04-25 12:11:20 +0200695 * \param[in] subsys Logging sub-system
696 * \param[in] level Log level
697 * \param[in] file name of source code file
698 * \param[in] cont continuation (1) or new line (0)
699 * \param[in] format format string
700 * \param[in] ap vararg-list containing format string arguments
701 */
Holger Hans Peter Freytherfb4bfc22012-07-12 09:26:25 +0200702void osmo_vlogp(int subsys, int level, const char *file, int line,
Harald Welte36c5a3e2011-08-27 14:33:19 +0200703 int cont, const char *format, va_list ap)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800704{
Harald Welte3ae27582010-03-26 21:24:24 +0800705 struct log_target *tar;
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800706
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +0100707 subsys = map_subsys(subsys);
Harald Welteb43bc042011-06-27 10:29:17 +0200708
Pau Espin Pedrold12f6982019-09-17 18:38:58 +0200709 log_tgt_mutex_lock();
710
Harald Welte28222962011-02-18 20:37:04 +0100711 llist_for_each_entry(tar, &osmo_log_target_list, entry) {
Pablo Neira Ayusodd93bf42011-05-19 01:40:43 +0200712 va_list bp;
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800713
Maxc65c5b42017-03-15 13:20:23 +0100714 if (!should_log_to_target(tar, subsys, level))
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800715 continue;
716
Pablo Neira Ayusodd93bf42011-05-19 01:40:43 +0200717 /* According to the manpage, vsnprintf leaves the value of ap
718 * in undefined state. Since _output uses vsnprintf and it may
719 * be called several times, we have to pass a copy of ap. */
720 va_copy(bp, ap);
Harald Welted7c0a372016-12-02 13:52:59 +0100721 if (tar->raw_output)
722 tar->raw_output(tar, subsys, level, file, line, cont, format, bp);
723 else
724 _output(tar, subsys, level, file, line, cont, format, bp);
Pablo Neira Ayusodd93bf42011-05-19 01:40:43 +0200725 va_end(bp);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800726 }
Pau Espin Pedrold12f6982019-09-17 18:38:58 +0200727
728 log_tgt_mutex_unlock();
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800729}
730
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200731/*! logging function used by DEBUGP() macro
Harald Welte2d2e2cc2016-04-25 12:11:20 +0200732 * \param[in] subsys Logging sub-system
733 * \param[in] file name of source code file
734 * \param[in] cont continuation (1) or new line (0)
735 * \param[in] format format string
736 */
Holger Hans Peter Freytherfb4bfc22012-07-12 09:26:25 +0200737void logp(int subsys, const char *file, int line, int cont,
Harald Welte3ae27582010-03-26 21:24:24 +0800738 const char *format, ...)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800739{
740 va_list ap;
741
742 va_start(ap, format);
Harald Welte36c5a3e2011-08-27 14:33:19 +0200743 osmo_vlogp(subsys, LOGL_DEBUG, file, line, cont, format, ap);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800744 va_end(ap);
745}
746
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200747/*! logging function used by LOGP() macro
Harald Welte2d2e2cc2016-04-25 12:11:20 +0200748 * \param[in] subsys Logging sub-system
749 * \param[in] level Log level
750 * \param[in] file name of source code file
751 * \param[in] cont continuation (1) or new line (0)
752 * \param[in] format format string
753 */
Holger Hans Peter Freytherfb4bfc22012-07-12 09:26:25 +0200754void logp2(int subsys, unsigned int level, const char *file, int line, int cont, const char *format, ...)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800755{
756 va_list ap;
757
Harald Welte433005c2020-09-26 11:51:32 +0200758 TRACE(LIBOSMOCORE_LOG_START());
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800759 va_start(ap, format);
Harald Welte36c5a3e2011-08-27 14:33:19 +0200760 osmo_vlogp(subsys, level, file, line, cont, format, ap);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800761 va_end(ap);
Harald Welte433005c2020-09-26 11:51:32 +0200762 TRACE(LIBOSMOCORE_LOG_DONE());
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800763}
764
Philipp Maier4c44d462022-01-19 11:43:05 +0100765/* This logging function is used as a fallback when the logging framework is
766 * not is not properly initialized. */
767void logp_stub(const char *file, int line, int cont, const char *format, ...)
768{
769 va_list ap;
770 if (!cont)
771 fprintf(stderr, "%s:%d ", file, line);
772 va_start(ap, format);
773 vfprintf(stderr, format, ap);
774 va_end(ap);
775}
776
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200777/*! Register a new log target with the logging core
Harald Welte18fc4652011-08-17 14:14:17 +0200778 * \param[in] target Log target to be registered
779 */
Harald Welte3ae27582010-03-26 21:24:24 +0800780void log_add_target(struct log_target *target)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800781{
Harald Welte28222962011-02-18 20:37:04 +0100782 llist_add_tail(&target->entry, &osmo_log_target_list);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800783}
784
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200785/*! Unregister a log target from the logging core
Harald Welte18fc4652011-08-17 14:14:17 +0200786 * \param[in] target Log target to be unregistered
787 */
Harald Welte3ae27582010-03-26 21:24:24 +0800788void log_del_target(struct log_target *target)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800789{
790 llist_del(&target->entry);
791}
792
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200793/*! Reset (clear) the logging context */
Harald Welte3ae27582010-03-26 21:24:24 +0800794void log_reset_context(void)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800795{
Harald Welte3ae27582010-03-26 21:24:24 +0800796 memset(&log_context, 0, sizeof(log_context));
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800797}
798
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200799/*! Set the logging context
Harald Welte18fc4652011-08-17 14:14:17 +0200800 * \param[in] ctx_nr logging context number
801 * \param[in] value value to which the context is to be set
Harald Welte2d2e2cc2016-04-25 12:11:20 +0200802 * \returns 0 in case of success; negative otherwise
Harald Welte18fc4652011-08-17 14:14:17 +0200803 *
804 * A logging context is something like the subscriber identity to which
805 * the currently processed message relates, or the BTS through which it
806 * was received. As soon as this data is known, it can be set using
807 * this function. The main use of context information is for logging
808 * filters.
809 */
Harald Welte3ae27582010-03-26 21:24:24 +0800810int log_set_context(uint8_t ctx_nr, void *value)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800811{
Harald Welte3ae27582010-03-26 21:24:24 +0800812 if (ctx_nr > LOG_MAX_CTX)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800813 return -EINVAL;
814
Harald Welte3ae27582010-03-26 21:24:24 +0800815 log_context.ctx[ctx_nr] = value;
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800816
817 return 0;
818}
819
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200820/*! Enable the \ref LOG_FLT_ALL log filter
Harald Welte18fc4652011-08-17 14:14:17 +0200821 * \param[in] target Log target to be affected
822 * \param[in] all enable (1) or disable (0) the ALL filter
823 *
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100824 * When the \ref LOG_FLT_ALL filter is enabled, all log messages will be
Neels Hofmeyr812ba6d2017-02-17 16:35:27 +0100825 * printed. It acts as a wildcard. Setting it to \a 1 means there is no
826 * filtering.
Harald Welte18fc4652011-08-17 14:14:17 +0200827 */
Harald Welte3ae27582010-03-26 21:24:24 +0800828void log_set_all_filter(struct log_target *target, int all)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800829{
830 if (all)
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100831 target->filter_map |= (1 << LOG_FLT_ALL);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800832 else
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100833 target->filter_map &= ~(1 << LOG_FLT_ALL);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800834}
835
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200836/*! Enable or disable the use of colored output
Harald Welte18fc4652011-08-17 14:14:17 +0200837 * \param[in] target Log target to be affected
838 * \param[in] use_color Use color (1) or don't use color (0)
839 */
Harald Welte3ae27582010-03-26 21:24:24 +0800840void log_set_use_color(struct log_target *target, int use_color)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800841{
842 target->use_color = use_color;
843}
844
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200845/*! Enable or disable printing of timestamps while logging
Harald Welte18fc4652011-08-17 14:14:17 +0200846 * \param[in] target Log target to be affected
847 * \param[in] print_timestamp Enable (1) or disable (0) timestamps
848 */
Harald Welte3ae27582010-03-26 21:24:24 +0800849void log_set_print_timestamp(struct log_target *target, int print_timestamp)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800850{
851 target->print_timestamp = print_timestamp;
852}
853
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200854/*! Enable or disable printing of extended timestamps while logging
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100855 * \param[in] target Log target to be affected
856 * \param[in] print_timestamp Enable (1) or disable (0) timestamps
857 *
858 * When both timestamp and extended timestamp is enabled then only
859 * the extended timestamp will be used. The format of the timestamp
860 * is YYYYMMDDhhmmssnnn.
861 */
862void log_set_print_extended_timestamp(struct log_target *target, int print_timestamp)
863{
864 target->print_ext_timestamp = print_timestamp;
865}
866
Pau Espin Pedrol662d10d2021-02-18 18:19:23 +0100867/*! Enable or disable printing of timestamps while logging
868 * \param[in] target Log target to be affected
869 * \param[in] print_tid Enable (1) or disable (0) Thread ID logging
870 */
871void log_set_print_tid(struct log_target *target, int print_tid)
872{
873 target->print_tid = print_tid;
874}
875
Neels Hofmeyrbd7bd392018-01-16 01:52:29 +0100876/*! Use log_set_print_filename2() instead.
877 * Call log_set_print_filename2() with LOG_FILENAME_PATH or LOG_FILENAME_NONE, *as well as* call
878 * log_set_print_category_hex() with the argument passed to this function. This is to mirror legacy
879 * behavior, which combined the category in hex with the filename. For example, if the category-hex
880 * output were no longer affected by log_set_print_filename(), many unit tests (in libosmocore as well as
881 * dependent projects) would fail since they expect the category to disappear along with the filename.
Holger Hans Peter Freytherdb153362012-09-11 11:24:51 +0200882 * \param[in] target Log target to be affected
883 * \param[in] print_filename Enable (1) or disable (0) filenames
884 */
885void log_set_print_filename(struct log_target *target, int print_filename)
886{
Neels Hofmeyrbd7bd392018-01-16 01:52:29 +0100887 log_set_print_filename2(target, print_filename ? LOG_FILENAME_PATH : LOG_FILENAME_NONE);
888 log_set_print_category_hex(target, print_filename);
889}
890
891/*! Enable or disable printing of the filename while logging.
892 * \param[in] target Log target to be affected.
Vadim Yanitskiy73e66b32019-03-25 21:24:20 +0700893 * \param[in] lft An LOG_FILENAME_* enum value.
Neels Hofmeyrbd7bd392018-01-16 01:52:29 +0100894 * LOG_FILENAME_NONE omits the source file and line information from logs.
895 * LOG_FILENAME_PATH prints the entire source file path as passed to LOGP macros.
896 */
897void log_set_print_filename2(struct log_target *target, enum log_filename_type lft)
898{
899 target->print_filename2 = lft;
Holger Hans Peter Freytherdb153362012-09-11 11:24:51 +0200900}
901
Neels Hofmeyr77ae45d2018-08-27 20:32:36 +0200902/*! Set the position where on a log line the source file info should be logged.
903 * \param[in] target Log target to be affected.
904 * \param[in] pos A LOG_FILENAME_POS_* enum value.
905 * LOG_FILENAME_POS_DEFAULT logs just before the caller supplied log message.
906 * LOG_FILENAME_POS_LAST logs only at the end of a log line, where the caller issued an '\n' to end the
907 */
908void log_set_print_filename_pos(struct log_target *target, enum log_filename_pos pos)
909{
910 target->print_filename_pos = pos;
911}
912
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200913/*! Enable or disable printing of the category name
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100914 * \param[in] target Log target to be affected
Vadim Yanitskiy73e66b32019-03-25 21:24:20 +0700915 * \param[in] print_category Enable (1) or disable (0) filenames
Holger Hans Peter Freyther2d6ad132014-12-05 09:35:30 +0100916 *
917 * Print the category/subsys name in front of every log message.
918 */
919void log_set_print_category(struct log_target *target, int print_category)
920{
921 target->print_category = print_category;
922}
923
Neels Hofmeyrbd7bd392018-01-16 01:52:29 +0100924/*! Enable or disable printing of the category number in hex ('<000b>').
925 * \param[in] target Log target to be affected.
926 * \param[in] print_category_hex Enable (1) or disable (0) hex category.
927 */
928void log_set_print_category_hex(struct log_target *target, int print_category_hex)
929{
930 target->print_category_hex = print_category_hex;
931}
932
Neels Hofmeyr886e5482018-01-16 01:49:37 +0100933/*! Enable or disable printing of the log level name.
934 * \param[in] target Log target to be affected
Vadim Yanitskiy73e66b32019-03-25 21:24:20 +0700935 * \param[in] print_level Enable (1) or disable (0) log level name
Neels Hofmeyr886e5482018-01-16 01:49:37 +0100936 *
937 * Print the log level name in front of every log message.
938 */
939void log_set_print_level(struct log_target *target, int print_level)
940{
941 target->print_level = (bool)print_level;
942}
943
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200944/*! Set the global log level for a given log target
Harald Welte18fc4652011-08-17 14:14:17 +0200945 * \param[in] target Log target to be affected
946 * \param[in] log_level New global log level
947 */
Harald Welte3ae27582010-03-26 21:24:24 +0800948void log_set_log_level(struct log_target *target, int log_level)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800949{
950 target->loglevel = log_level;
951}
952
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200953/*! Set a category filter on a given log target
Harald Weltede6e4982012-12-06 21:25:27 +0100954 * \param[in] target Log target to be affected
955 * \param[in] category Log category to be affected
956 * \param[in] enable whether to enable or disable the filter
957 * \param[in] level Log level of the filter
958 */
Harald Welte3ae27582010-03-26 21:24:24 +0800959void log_set_category_filter(struct log_target *target, int category,
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800960 int enable, int level)
961{
Neels Hofmeyr886d6fd2016-12-12 13:49:03 +0100962 if (!target)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800963 return;
Neels Hofmeyr886d6fd2016-12-12 13:49:03 +0100964 category = map_subsys(category);
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800965 target->categories[category].enabled = !!enable;
966 target->categories[category].loglevel = level;
967}
968
Harald Welte44c0f632017-01-15 17:58:29 +0100969#if (!EMBEDDED)
Harald Welte78d73672020-09-29 11:32:35 +0200970/* write-queue tells us we should write another msgb (log line) to the output fd */
971static int _file_wq_write_cb(struct osmo_fd *ofd, struct msgb *msg)
972{
973 int rc;
974
975 rc = write(ofd->fd, msgb_data(msg), msgb_length(msg));
976 if (rc < 0)
977 return rc;
978 if (rc != msgb_length(msg)) {
979 /* pull the number of bytes we have already written */
980 msgb_pull(msg, rc);
981 /* ask write_queue to re-insert the msgb at the head of the queue */
982 return -EAGAIN;
983 }
984 return 0;
985}
986
987/* output via buffered, blocking stdio streams */
Harald Welteb72867f2020-09-26 21:45:16 +0200988static void _file_output_stream(struct log_target *target, unsigned int level,
989 const char *log)
990{
991 OSMO_ASSERT(target->tgt_file.out);
992 fputs(log, target->tgt_file.out);
993 fflush(target->tgt_file.out);
994}
995
996/* output via non-blocking write_queue, doing internal buffering */
Harald Weltea0b57d02020-09-27 17:15:10 +0200997static void _file_raw_output(struct log_target *target, int subsys, unsigned int level, const char *file,
998 int line, int cont, const char *format, va_list ap)
Harald Welte4a2bb9e2010-03-26 09:33:40 +0800999{
Harald Welteb72867f2020-09-26 21:45:16 +02001000 struct msgb *msg;
Harald Weltea0b57d02020-09-27 17:15:10 +02001001 int rc;
Harald Welteb72867f2020-09-26 21:45:16 +02001002
1003 OSMO_ASSERT(target->tgt_file.wqueue);
Harald Weltea0b57d02020-09-27 17:15:10 +02001004 msg = msgb_alloc_c(target->tgt_file.wqueue, MAX_LOG_SIZE, "log_file_msg");
Harald Welteb72867f2020-09-26 21:45:16 +02001005 if (!msg)
1006 return;
1007
1008 /* we simply enqueue the log message to a write queue here, to avoid any blocking
1009 * writes on the output file. The write queue will tell us once the file is writable
1010 * and call _file_wq_write_cb() */
Harald Weltea0b57d02020-09-27 17:15:10 +02001011 rc = _output_buf((char *)msgb_data(msg), msgb_tailroom(msg), target, subsys, level, file, line, cont, format, ap);
1012 msgb_put(msg, rc);
Harald Welte78d73672020-09-29 11:32:35 +02001013
1014 /* attempt a synchronous, non-blocking write, if the write queue is empty */
1015 if (target->tgt_file.wqueue->current_length == 0) {
1016 rc = _file_wq_write_cb(&target->tgt_file.wqueue->bfd, msg);
1017 if (rc == 0) {
1018 /* the write was complete, we can exit early */
1019 msgb_free(msg);
1020 return;
1021 }
1022 }
1023 /* if we reach here, either we already had elements in the write_queue, or the synchronous write
1024 * failed: enqueue the message to the write_queue (backlog) */
Harald Welte9a9627e2021-11-25 13:38:19 +01001025 if (osmo_wqueue_enqueue_quiet(target->tgt_file.wqueue, msg) < 0) {
1026 msgb_free(msg);
1027 /* TODO: increment some counter so we can see that messages were dropped */
1028 }
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001029}
Harald Welte44c0f632017-01-15 17:58:29 +01001030#endif
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001031
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001032/*! Create a new log target skeleton
Harald Welte2d2e2cc2016-04-25 12:11:20 +02001033 * \returns dynamically-allocated log target
1034 * This funcition allocates a \ref log_target and initializes it
1035 * with some default values. The newly created target is not
1036 * registered yet.
1037 */
Harald Welte3ae27582010-03-26 21:24:24 +08001038struct log_target *log_target_create(void)
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001039{
Harald Welte3ae27582010-03-26 21:24:24 +08001040 struct log_target *target;
Harald Weltecc6313c2010-03-26 22:04:03 +08001041 unsigned int i;
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001042
Max68bf16a2018-01-10 17:00:43 +01001043 assert_loginfo(__func__);
Harald Welte18a7d812017-03-16 23:54:55 +01001044
Harald Welte3ae27582010-03-26 21:24:24 +08001045 target = talloc_zero(tall_log_ctx, struct log_target);
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001046 if (!target)
1047 return NULL;
1048
Pau Espin Pedrol9d4a36e2018-07-26 11:55:33 +02001049 target->categories = talloc_zero_array(target,
Harald Welteb43bc042011-06-27 10:29:17 +02001050 struct log_category,
1051 osmo_log_info->num_cat);
1052 if (!target->categories) {
1053 talloc_free(target);
1054 return NULL;
1055 }
1056
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001057 INIT_LLIST_HEAD(&target->entry);
Harald Weltecc6313c2010-03-26 22:04:03 +08001058
1059 /* initialize the per-category enabled/loglevel from defaults */
Harald Welte4ebdf742010-05-19 19:54:00 +02001060 for (i = 0; i < osmo_log_info->num_cat; i++) {
Harald Weltecc6313c2010-03-26 22:04:03 +08001061 struct log_category *cat = &target->categories[i];
Harald Welte4ebdf742010-05-19 19:54:00 +02001062 cat->enabled = osmo_log_info->cat[i].enabled;
1063 cat->loglevel = osmo_log_info->cat[i].loglevel;
Harald Weltecc6313c2010-03-26 22:04:03 +08001064 }
1065
1066 /* global settings */
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001067 target->use_color = 1;
1068 target->print_timestamp = 0;
Pau Espin Pedrol662d10d2021-02-18 18:19:23 +01001069 target->print_tid = 0;
Neels Hofmeyrbd7bd392018-01-16 01:52:29 +01001070 target->print_filename2 = LOG_FILENAME_PATH;
1071 target->print_category_hex = true;
Harald Weltecc6313c2010-03-26 22:04:03 +08001072
1073 /* global log level */
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001074 target->loglevel = 0;
1075 return target;
1076}
1077
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001078/*! Create the STDERR log target
Harald Welte2d2e2cc2016-04-25 12:11:20 +02001079 * \returns dynamically-allocated \ref log_target for STDERR */
Harald Welte3ae27582010-03-26 21:24:24 +08001080struct log_target *log_target_create_stderr(void)
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001081{
Harald Weltea3b844c2010-03-27 00:04:40 +08001082/* since C89/C99 says stderr is a macro, we can safely do this! */
Harald Welteb93ce5a2017-05-15 10:58:15 +02001083#if !EMBEDDED && defined(stderr)
Harald Welte3ae27582010-03-26 21:24:24 +08001084 struct log_target *target;
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001085
Harald Welte3ae27582010-03-26 21:24:24 +08001086 target = log_target_create();
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001087 if (!target)
1088 return NULL;
1089
Harald Welte28222962011-02-18 20:37:04 +01001090 target->type = LOG_TGT_TYPE_STDERR;
Harald Welte0083cd32010-08-25 14:55:44 +02001091 target->tgt_file.out = stderr;
Harald Welteb72867f2020-09-26 21:45:16 +02001092 target->output = _file_output_stream;
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001093 return target;
Harald Weltea3b844c2010-03-27 00:04:40 +08001094#else
1095 return NULL;
1096#endif /* stderr */
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001097}
1098
Harald Welte44c0f632017-01-15 17:58:29 +01001099#if (!EMBEDDED)
Harald Welteb72867f2020-09-26 21:45:16 +02001100/*! Create a new file-based log target using buffered, blocking stream output
Harald Welte18fc4652011-08-17 14:14:17 +02001101 * \param[in] fname File name of the new log file
1102 * \returns Log target in case of success, NULL otherwise
1103 */
Harald Welteb72867f2020-09-26 21:45:16 +02001104struct log_target *log_target_create_file_stream(const char *fname)
Harald Welte3086c392010-08-25 19:10:50 +02001105{
1106 struct log_target *target;
1107
1108 target = log_target_create();
1109 if (!target)
1110 return NULL;
1111
Harald Welte28222962011-02-18 20:37:04 +01001112 target->type = LOG_TGT_TYPE_FILE;
Harald Welte3086c392010-08-25 19:10:50 +02001113 target->tgt_file.out = fopen(fname, "a");
Vadim Yanitskiyb89114b2020-09-09 04:51:04 +07001114 if (!target->tgt_file.out) {
1115 log_target_destroy(target);
Harald Welte3086c392010-08-25 19:10:50 +02001116 return NULL;
Vadim Yanitskiyb89114b2020-09-09 04:51:04 +07001117 }
Harald Welteb72867f2020-09-26 21:45:16 +02001118 target->output = _file_output_stream;
1119 target->tgt_file.fname = talloc_strdup(target, fname);
Harald Welte3086c392010-08-25 19:10:50 +02001120
Harald Welteb72867f2020-09-26 21:45:16 +02001121 return target;
1122}
1123
1124/*! switch from non-blocking/write-queue to blocking + buffered stream output
1125 * \param[in] target log target which we should switch
Pau Espin Pedrol843a84c2021-11-03 17:31:47 +01001126 * \return 0 on success; 1 if already switched before; negative on error
1127 * Must be called with mutex osmo_log_tgt_mutex held, see log_tgt_mutex_lock.
1128 */
Harald Welteb72867f2020-09-26 21:45:16 +02001129int log_target_file_switch_to_stream(struct log_target *target)
1130{
1131 struct osmo_wqueue *wq;
Harald Welteb72867f2020-09-26 21:45:16 +02001132
1133 if (!target)
1134 return -ENODEV;
1135
Harald Welteb72867f2020-09-26 21:45:16 +02001136 if (target->tgt_file.out) {
1137 /* target has already been switched over */
1138 return 1;
1139 }
1140
Harald Welteb72867f2020-09-26 21:45:16 +02001141 wq = target->tgt_file.wqueue;
1142 OSMO_ASSERT(wq);
1143
1144 /* re-open output as stream */
1145 if (target->type == LOG_TGT_TYPE_STDERR)
1146 target->tgt_file.out = stderr;
1147 else
1148 target->tgt_file.out = fopen(target->tgt_file.fname, "a");
1149 if (!target->tgt_file.out) {
Harald Welteb72867f2020-09-26 21:45:16 +02001150 return -EIO;
1151 }
1152
1153 /* synchronously write anything left in the queue */
1154 while (!llist_empty(&wq->msg_queue)) {
1155 struct msgb *msg = msgb_dequeue(&wq->msg_queue);
1156 fwrite(msgb_data(msg), msgb_length(msg), 1, target->tgt_file.out);
1157 msgb_free(msg);
1158 }
1159
1160 /* now that everything succeeded, we can finally close the old output fd */
1161 if (target->type == LOG_TGT_TYPE_FILE) {
1162 osmo_fd_unregister(&wq->bfd);
1163 close(wq->bfd.fd);
1164 }
1165
1166 /* release the queue itself */
1167 talloc_free(wq);
1168 target->tgt_file.wqueue = NULL;
1169 target->output = _file_output_stream;
1170 target->raw_output = NULL;
1171
1172 return 0;
1173}
1174
1175/*! switch from blocking + buffered file output to non-blocking write-queue based output.
1176 * \param[in] target log target which we should switch
Pau Espin Pedrol843a84c2021-11-03 17:31:47 +01001177 * \return 0 on success; 1 if already switched before; negative on error
1178 * Must be called with mutex osmo_log_tgt_mutex held, see log_tgt_mutex_lock.
1179 */
Harald Welteb72867f2020-09-26 21:45:16 +02001180int log_target_file_switch_to_wqueue(struct log_target *target)
1181{
1182 struct osmo_wqueue *wq;
Harald Welteb72867f2020-09-26 21:45:16 +02001183 int rc;
1184
1185 if (!target)
1186 return -ENODEV;
1187
Harald Welteb72867f2020-09-26 21:45:16 +02001188 if (!target->tgt_file.out) {
1189 /* target has already been switched over */
1190 return 1;
1191 }
1192
Harald Welteb72867f2020-09-26 21:45:16 +02001193 /* we create a ~640kB sized talloc pool within the write-queue to ensure individual
1194 * log lines (stored as msgbs) will not put result in malloc() calls, and also to
1195 * reduce the OOM probability within logging, as the pool is already allocated */
1196 wq = talloc_pooled_object(target, struct osmo_wqueue, LOG_WQUEUE_LEN,
Harald Weltea0b57d02020-09-27 17:15:10 +02001197 LOG_WQUEUE_LEN*(sizeof(struct msgb)+MAX_LOG_SIZE));
Harald Welteb72867f2020-09-26 21:45:16 +02001198 if (!wq)
1199 return -ENOMEM;
1200 osmo_wqueue_init(wq, LOG_WQUEUE_LEN);
1201
1202 fflush(target->tgt_file.out);
1203 if (target->type == LOG_TGT_TYPE_FILE) {
1204 rc = open(target->tgt_file.fname, O_WRONLY|O_APPEND|O_CREAT|O_NONBLOCK, 0660);
1205 if (rc < 0) {
Harald Welteb72867f2020-09-26 21:45:16 +02001206 talloc_free(wq);
1207 return -errno;
1208 }
1209 } else {
1210 rc = STDERR_FILENO;
1211 }
1212 wq->bfd.fd = rc;
1213 wq->bfd.when = OSMO_FD_WRITE;
1214 wq->write_cb = _file_wq_write_cb;
1215
1216 rc = osmo_fd_register(&wq->bfd);
1217 if (rc < 0) {
1218 talloc_free(wq);
1219 return -EIO;
1220 }
1221 target->tgt_file.wqueue = wq;
Harald Weltea0b57d02020-09-27 17:15:10 +02001222 target->raw_output = _file_raw_output;
1223 target->output = NULL;
Harald Welte3086c392010-08-25 19:10:50 +02001224
Harald Welteb72867f2020-09-26 21:45:16 +02001225 /* now that everything succeeded, we can finally close the old output stream */
1226 if (target->type == LOG_TGT_TYPE_FILE)
1227 fclose(target->tgt_file.out);
1228 target->tgt_file.out = NULL;
1229
1230 return 0;
1231}
1232
1233/*! Create a new file-based log target using non-blocking write_queue
1234 * \param[in] fname File name of the new log file
1235 * \returns Log target in case of success, NULL otherwise
1236 */
1237struct log_target *log_target_create_file(const char *fname)
1238{
1239 struct log_target *target;
1240 struct osmo_wqueue *wq;
1241 int rc;
1242
1243 target = log_target_create();
1244 if (!target)
1245 return NULL;
1246
1247 target->type = LOG_TGT_TYPE_FILE;
1248 /* we create a ~640kB sized talloc pool within the write-queue to ensure individual
1249 * log lines (stored as msgbs) will not put result in malloc() calls, and also to
1250 * reduce the OOM probability within logging, as the pool is already allocated */
1251 wq = talloc_pooled_object(target, struct osmo_wqueue, LOG_WQUEUE_LEN,
Harald Weltea0b57d02020-09-27 17:15:10 +02001252 LOG_WQUEUE_LEN*(sizeof(struct msgb)+MAX_LOG_SIZE));
Harald Welteb72867f2020-09-26 21:45:16 +02001253 if (!wq) {
1254 log_target_destroy(target);
1255 return NULL;
1256 }
1257 osmo_wqueue_init(wq, LOG_WQUEUE_LEN);
1258 wq->bfd.fd = open(fname, O_WRONLY|O_APPEND|O_CREAT|O_NONBLOCK, 0660);
1259 if (wq->bfd.fd < 0) {
1260 talloc_free(wq);
1261 log_target_destroy(target);
1262 return NULL;
1263 }
1264 wq->bfd.when = OSMO_FD_WRITE;
1265 wq->write_cb = _file_wq_write_cb;
1266
1267 rc = osmo_fd_register(&wq->bfd);
1268 if (rc < 0) {
1269 talloc_free(wq);
1270 log_target_destroy(target);
1271 return NULL;
1272 }
1273
1274 target->tgt_file.wqueue = wq;
Harald Weltea0b57d02020-09-27 17:15:10 +02001275 target->raw_output = _file_raw_output;
Harald Welte3086c392010-08-25 19:10:50 +02001276 target->tgt_file.fname = talloc_strdup(target, fname);
1277
1278 return target;
1279}
Harald Welte44c0f632017-01-15 17:58:29 +01001280#endif
Harald Welte3086c392010-08-25 19:10:50 +02001281
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001282/*! Find a registered log target
Harald Welte18fc4652011-08-17 14:14:17 +02001283 * \param[in] type Log target type
1284 * \param[in] fname File name
1285 * \returns Log target (if found), NULL otherwise
Pau Espin Pedrold12f6982019-09-17 18:38:58 +02001286 * Must be called with mutex osmo_log_tgt_mutex held, see log_tgt_mutex_lock.
Harald Welte18fc4652011-08-17 14:14:17 +02001287 */
Harald Weltee6fb8902022-01-09 12:00:03 +01001288struct log_target *log_target_find(enum log_target_type type, const char *fname)
Harald Welte28222962011-02-18 20:37:04 +01001289{
1290 struct log_target *tgt;
1291
1292 llist_for_each_entry(tgt, &osmo_log_target_list, entry) {
1293 if (tgt->type != type)
1294 continue;
Maxc90f40a2018-01-11 10:52:28 +01001295 switch (tgt->type) {
1296 case LOG_TGT_TYPE_FILE:
Harald Welte28222962011-02-18 20:37:04 +01001297 if (!strcmp(fname, tgt->tgt_file.fname))
1298 return tgt;
Maxc90f40a2018-01-11 10:52:28 +01001299 break;
1300 case LOG_TGT_TYPE_GSMTAP:
1301 if (!strcmp(fname, tgt->tgt_gsmtap.hostname))
1302 return tgt;
1303 break;
1304 default:
Harald Welte28222962011-02-18 20:37:04 +01001305 return tgt;
Maxc90f40a2018-01-11 10:52:28 +01001306 }
Harald Welte28222962011-02-18 20:37:04 +01001307 }
1308 return NULL;
1309}
1310
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001311/*! Unregister, close and delete a log target
Vadim Yanitskiy73e66b32019-03-25 21:24:20 +07001312 * \param[in] target log target to unregister, close and delete */
Harald Welte3086c392010-08-25 19:10:50 +02001313void log_target_destroy(struct log_target *target)
1314{
Harald Welte3086c392010-08-25 19:10:50 +02001315 /* just in case, to make sure we don't have any references */
1316 log_del_target(target);
1317
Harald Welte44c0f632017-01-15 17:58:29 +01001318#if (!EMBEDDED)
Harald Welteb72867f2020-09-26 21:45:16 +02001319 struct osmo_wqueue *wq;
Vadim Yanitskiy744236b2020-09-09 04:42:22 +07001320 switch (target->type) {
1321 case LOG_TGT_TYPE_FILE:
Harald Welteb72867f2020-09-26 21:45:16 +02001322 case LOG_TGT_TYPE_STDERR:
1323 if (target->tgt_file.out) {
1324 if (target->type == LOG_TGT_TYPE_FILE)
1325 fclose(target->tgt_file.out);
1326 target->tgt_file.out = NULL;
1327 }
1328 wq = target->tgt_file.wqueue;
1329 if (wq) {
1330 if (wq->bfd.fd >= 0) {
1331 if (target->type == LOG_TGT_TYPE_FILE)
1332 close(wq->bfd.fd);
1333 wq->bfd.fd = -1;
1334 }
1335 osmo_fd_unregister(&wq->bfd);
1336 osmo_wqueue_clear(wq);
1337 talloc_free(wq);
1338 target->tgt_file.wqueue = NULL;
1339 }
1340 talloc_free((void *)target->tgt_file.fname);
1341 target->tgt_file.fname = NULL;
Vadim Yanitskiy744236b2020-09-09 04:42:22 +07001342 break;
Vadim Yanitskiy2f4186a2021-12-29 21:58:19 +06001343 case LOG_TGT_TYPE_GSMTAP:
1344 gsmtap_source_free(target->tgt_gsmtap.gsmtap_inst);
1345 break;
Vadim Yanitskiy04f42712020-09-09 04:47:25 +07001346#ifdef HAVE_SYSLOG_H
1347 case LOG_TGT_TYPE_SYSLOG:
1348 closelog();
1349 break;
1350#endif /* HAVE_SYSLOG_H */
Vadim Yanitskiy744236b2020-09-09 04:42:22 +07001351 default:
1352 /* make GCC happy */
1353 break;
Harald Welte3086c392010-08-25 19:10:50 +02001354 }
Harald Welte44c0f632017-01-15 17:58:29 +01001355#endif
Harald Welte3086c392010-08-25 19:10:50 +02001356
1357 talloc_free(target);
1358}
1359
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001360/*! close and re-open a log file (for log file rotation)
Harald Welte2d2e2cc2016-04-25 12:11:20 +02001361 * \param[in] target log target to re-open
1362 * \returns 0 in case of success; negative otherwise */
Harald Welte3086c392010-08-25 19:10:50 +02001363int log_target_file_reopen(struct log_target *target)
1364{
Harald Welteb72867f2020-09-26 21:45:16 +02001365 struct osmo_wqueue *wq;
1366 int rc;
Harald Welte3086c392010-08-25 19:10:50 +02001367
Harald Welteb72867f2020-09-26 21:45:16 +02001368 OSMO_ASSERT(target->type == LOG_TGT_TYPE_FILE || target->type == LOG_TGT_TYPE_STDERR);
1369 OSMO_ASSERT(target->tgt_file.out || target->tgt_file.wqueue);
Harald Welte3086c392010-08-25 19:10:50 +02001370
Harald Welteb72867f2020-09-26 21:45:16 +02001371 if (target->tgt_file.out) {
1372 fclose(target->tgt_file.out);
1373 target->tgt_file.out = fopen(target->tgt_file.fname, "a");
1374 if (!target->tgt_file.out)
1375 return -errno;
1376 } else {
1377 wq = target->tgt_file.wqueue;
1378 osmo_fd_unregister(&wq->bfd);
1379 if (wq->bfd.fd >= 0) {
1380 close(wq->bfd.fd);
1381 wq->bfd.fd = -1;
1382 }
1383
1384 rc = open(target->tgt_file.fname, O_WRONLY|O_APPEND|O_CREAT|O_NONBLOCK, 0660);
1385 if (rc < 0)
1386 return -errno;
1387 wq->bfd.fd = rc;
1388 rc = osmo_fd_register(&wq->bfd);
1389 if (rc < 0)
1390 return rc;
1391 }
Harald Welte3086c392010-08-25 19:10:50 +02001392
1393 return 0;
1394}
1395
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001396/*! close and re-open all log files (for log file rotation)
Harald Welte2d2e2cc2016-04-25 12:11:20 +02001397 * \returns 0 in case of success; negative otherwise */
Harald Welte4de854d2013-03-18 19:01:40 +01001398int log_targets_reopen(void)
1399{
1400 struct log_target *tar;
1401 int rc = 0;
1402
Pau Espin Pedrold12f6982019-09-17 18:38:58 +02001403 log_tgt_mutex_lock();
1404
Harald Welte4de854d2013-03-18 19:01:40 +01001405 llist_for_each_entry(tar, &osmo_log_target_list, entry) {
1406 switch (tar->type) {
1407 case LOG_TGT_TYPE_FILE:
1408 if (log_target_file_reopen(tar) < 0)
1409 rc = -1;
1410 break;
1411 default:
1412 break;
1413 }
1414 }
1415
Pau Espin Pedrold12f6982019-09-17 18:38:58 +02001416 log_tgt_mutex_unlock();
1417
Harald Welte4de854d2013-03-18 19:01:40 +01001418 return rc;
1419}
1420
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001421/*! Initialize the Osmocom logging core
Max72dfd432018-12-04 11:24:18 +01001422 * \param[in] inf Information regarding logging categories, could be NULL
Vadim Yanitskiy73e66b32019-03-25 21:24:20 +07001423 * \param[in] ctx talloc context for logging allocations
Harald Welte18fc4652011-08-17 14:14:17 +02001424 * \returns 0 in case of success, negative in case of error
Max72dfd432018-12-04 11:24:18 +01001425 *
1426 * If inf is NULL then only library-internal categories are initialized.
Harald Welte18fc4652011-08-17 14:14:17 +02001427 */
Harald Welteb43bc042011-06-27 10:29:17 +02001428int log_init(const struct log_info *inf, void *ctx)
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001429{
Harald Welteb43bc042011-06-27 10:29:17 +02001430 int i;
Philipp Maierdcad1c52020-03-25 11:25:59 +01001431 struct log_info_cat *cat_ptr;
Harald Welteb43bc042011-06-27 10:29:17 +02001432
Philipp Maierdc02c062020-05-12 17:51:25 +02001433 /* Ensure that log_init is not called multiple times */
1434 OSMO_ASSERT(tall_log_ctx == NULL)
1435
Harald Welteb43bc042011-06-27 10:29:17 +02001436 tall_log_ctx = talloc_named_const(ctx, 1, "logging");
1437 if (!tall_log_ctx)
1438 return -ENOMEM;
1439
1440 osmo_log_info = talloc_zero(tall_log_ctx, struct log_info);
1441 if (!osmo_log_info)
1442 return -ENOMEM;
1443
Max72dfd432018-12-04 11:24:18 +01001444 osmo_log_info->num_cat = ARRAY_SIZE(internal_cat);
1445
1446 if (inf) {
1447 osmo_log_info->filter_fn = inf->filter_fn;
1448 osmo_log_info->num_cat_user = inf->num_cat;
1449 osmo_log_info->num_cat += inf->num_cat;
1450 }
Harald Welteb43bc042011-06-27 10:29:17 +02001451
Philipp Maierdcad1c52020-03-25 11:25:59 +01001452 cat_ptr = talloc_zero_array(osmo_log_info, struct log_info_cat,
1453 osmo_log_info->num_cat);
1454 if (!cat_ptr) {
Harald Welteb43bc042011-06-27 10:29:17 +02001455 talloc_free(osmo_log_info);
1456 osmo_log_info = NULL;
1457 return -ENOMEM;
1458 }
1459
Philipp Maierdcad1c52020-03-25 11:25:59 +01001460 /* copy over the user part and sanitize loglevel */
1461 if (inf) {
Max72dfd432018-12-04 11:24:18 +01001462 for (i = 0; i < inf->num_cat; i++) {
Philipp Maierdcad1c52020-03-25 11:25:59 +01001463 memcpy(&cat_ptr[i], &inf->cat[i],
1464 sizeof(struct log_info_cat));
1465
1466 /* Make sure that the loglevel is set to NOTICE in case
1467 * no loglevel has been preset. */
1468 if (!cat_ptr[i].loglevel) {
1469 cat_ptr[i].loglevel = LOGL_NOTICE;
1470 }
Max72dfd432018-12-04 11:24:18 +01001471 }
Harald Welteb43bc042011-06-27 10:29:17 +02001472 }
1473
1474 /* copy over the library part */
Harald Welte9fe16522011-06-27 14:00:03 +02001475 for (i = 0; i < ARRAY_SIZE(internal_cat); i++) {
Harald Weltece9fec32011-06-27 14:19:16 +02001476 unsigned int cn = osmo_log_info->num_cat_user + i;
Philipp Maierdcad1c52020-03-25 11:25:59 +01001477 memcpy(&cat_ptr[cn], &internal_cat[i], sizeof(struct log_info_cat));
Harald Welte9fe16522011-06-27 14:00:03 +02001478 }
1479
Philipp Maierdcad1c52020-03-25 11:25:59 +01001480 osmo_log_info->cat = cat_ptr;
1481
Harald Welte9fe16522011-06-27 14:00:03 +02001482 return 0;
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001483}
Harald Welte18fc4652011-08-17 14:14:17 +02001484
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001485/* De-initialize the Osmocom logging core
Harald Welte69e6c3c2016-04-20 10:41:27 +02001486 * This function destroys all targets and releases associated memory */
1487void log_fini(void)
1488{
1489 struct log_target *tar, *tar2;
1490
Pau Espin Pedrold12f6982019-09-17 18:38:58 +02001491 log_tgt_mutex_lock();
1492
Harald Welte69e6c3c2016-04-20 10:41:27 +02001493 llist_for_each_entry_safe(tar, tar2, &osmo_log_target_list, entry)
1494 log_target_destroy(tar);
1495
1496 talloc_free(osmo_log_info);
1497 osmo_log_info = NULL;
1498 talloc_free(tall_log_ctx);
1499 tall_log_ctx = NULL;
Pau Espin Pedrold12f6982019-09-17 18:38:58 +02001500
1501 log_tgt_mutex_unlock();
Harald Welte69e6c3c2016-04-20 10:41:27 +02001502}
1503
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001504/*! Check whether a log entry will be generated.
Jacob Erlbeckde6dd722015-11-17 11:52:24 +01001505 * \returns != 0 if a log entry might get generated by at least one target */
1506int log_check_level(int subsys, unsigned int level)
1507{
1508 struct log_target *tar;
1509
Max68bf16a2018-01-10 17:00:43 +01001510 assert_loginfo(__func__);
Harald Welte18a7d812017-03-16 23:54:55 +01001511
Holger Hans Peter Freythere0dc6a12015-12-21 14:45:16 +01001512 subsys = map_subsys(subsys);
Jacob Erlbeckde6dd722015-11-17 11:52:24 +01001513
1514 /* TODO: The following could/should be cached (update on config) */
1515
Pau Espin Pedrold12f6982019-09-17 18:38:58 +02001516 log_tgt_mutex_lock();
1517
Jacob Erlbeckde6dd722015-11-17 11:52:24 +01001518 llist_for_each_entry(tar, &osmo_log_target_list, entry) {
Maxc65c5b42017-03-15 13:20:23 +01001519 if (!should_log_to_target(tar, subsys, level))
Jacob Erlbeckde6dd722015-11-17 11:52:24 +01001520 continue;
1521
1522 /* This might get logged (ignoring filters) */
Pau Espin Pedrold12f6982019-09-17 18:38:58 +02001523 log_tgt_mutex_unlock();
Jacob Erlbeckde6dd722015-11-17 11:52:24 +01001524 return 1;
1525 }
1526
1527 /* We are sure, that this will not be logged. */
Pau Espin Pedrold12f6982019-09-17 18:38:58 +02001528 log_tgt_mutex_unlock();
Jacob Erlbeckde6dd722015-11-17 11:52:24 +01001529 return 0;
1530}
1531
Sylvain Munautdca7d2c2012-04-18 21:53:23 +02001532/*! @} */