libosmocore 1.7.0
Osmocom core library
logging.h
Go to the documentation of this file.
1#pragma once
2
7#include <stdio.h>
8#include <stdint.h>
9#include <stdarg.h>
10#include <stdbool.h>
11#include <osmocom/core/defs.h>
13
14extern struct log_info *osmo_log_info;
15
16#ifndef DEBUG
17#define DEBUG
18#endif
19
20#ifdef LIBOSMOCORE_NO_LOGGING
21#undef DEBUG
22#endif
23
24#ifdef DEBUG
30#define DEBUGP(ss, fmt, args...) LOGP(ss, LOGL_DEBUG, fmt, ##args)
31#define DEBUGPC(ss, fmt, args...) LOGPC(ss, LOGL_DEBUG, fmt, ##args)
32#else
33#define DEBUGP(xss, fmt, args...)
34#define DEBUGPC(ss, fmt, args...)
35#endif
36
37
38void osmo_vlogp(int subsys, int level, const char *file, int line,
39 int cont, const char *format, va_list ap);
40
41void logp(int subsys, const char *file, int line, int cont, const char *format, ...) OSMO_DEPRECATED("Use DEBUGP* macros instead");
42
49#define LOGP(ss, level, fmt, args...) \
50 LOGPSRC(ss, level, NULL, 0, fmt, ## args)
51
58#ifndef LIBOSMOCORE_NO_LOGGING
59#define LOGPC(ss, level, fmt, args...) \
60 do { \
61 if (!osmo_log_info) { \
62 logp_stub(__FILE__, __LINE__, 1, fmt, ##args); \
63 break; \
64 } \
65 if (log_check_level(ss, level)) \
66 logp2(ss, level, __FILE__, __LINE__, 1, fmt, ##args); \
67 } while(0)
68#else
69#define LOGPC(ss, level, fmt, args...)
70#endif
71
84#define LOGPSRC(ss, level, caller_file, caller_line, fmt, args...) \
85 LOGPSRCC(ss, level, caller_file, caller_line, 0, fmt, ##args)
86
100#ifndef LIBOSMOCORE_NO_LOGGING
101#define LOGPSRCC(ss, level, caller_file, caller_line, cont, fmt, args...) \
102 do { \
103 if (!osmo_log_info) { \
104 if (caller_file) \
105 logp_stub(caller_file, caller_line, cont, fmt, ##args); \
106 else \
107 logp_stub(__FILE__, __LINE__, cont, fmt, ##args); \
108 break; \
109 } \
110 if (log_check_level(ss, level)) {\
111 if (caller_file) \
112 logp2(ss, level, caller_file, caller_line, cont, fmt, ##args); \
113 else \
114 logp2(ss, level, __FILE__, __LINE__, cont, fmt, ##args); \
115 }\
116 } while(0)
117#else
118#define LOGPSRCC(ss, level, caller_file, caller_line, cont, fmt, args...)
119#endif
120
122#define LOGL_DEBUG 1
123#define LOGL_INFO 3
124#define LOGL_NOTICE 5
125#define LOGL_ERROR 7
126#define LOGL_FATAL 8
128/* logging subsystems defined by the library itself */
129#define DLGLOBAL -1
130#define DLLAPD -2
131#define DLINP -3
132#define DLMUX -4
133#define DLMI -5
134#define DLMIB -6
135#define DLSMS -7
136#define DLCTRL -8
137#define DLGTP -9
138#define DLSTATS -10
139#define DLGSUP -11
140#define DLOAP -12
141#define DLSS7 -13
142#define DLSCCP -14
143#define DLSUA -15
144#define DLM3UA -16
145#define DLMGCP -17
146#define DLJIBUF -18
147#define DLRSPRO -19
148#define DLNS -20
149#define DLBSSGP -21
150#define DLNSDATA -22
151#define DLNSSIGNAL -23
152#define DLIUUP -24
153#define DLPFCP -25
154#define OSMO_NUM_DLIB 25
156/* Colors that can be used in log_info_cat.color */
157#define OSMO_LOGCOLOR_NORMAL NULL
158#define OSMO_LOGCOLOR_RED "\033[1;31m"
159#define OSMO_LOGCOLOR_GREEN "\033[1;32m"
160#define OSMO_LOGCOLOR_YELLOW "\033[1;33m"
161#define OSMO_LOGCOLOR_BLUE "\033[1;34m"
162#define OSMO_LOGCOLOR_PURPLE "\033[1;35m"
163#define OSMO_LOGCOLOR_CYAN "\033[1;36m"
164#define OSMO_LOGCOLOR_DARKRED "\033[31m"
165#define OSMO_LOGCOLOR_DARKGREEN "\033[32m"
166#define OSMO_LOGCOLOR_DARKYELLOW "\033[33m"
167#define OSMO_LOGCOLOR_DARKBLUE "\033[34m"
168#define OSMO_LOGCOLOR_DARKPURPLE "\033[35m"
169#define OSMO_LOGCOLOR_DARKCYAN "\033[36m"
170#define OSMO_LOGCOLOR_DARKGREY "\033[1;30m"
171#define OSMO_LOGCOLOR_GREY "\033[37m"
172#define OSMO_LOGCOLOR_BRIGHTWHITE "\033[1;37m"
173#define OSMO_LOGCOLOR_END "\033[0;m"
174
177 uint8_t loglevel;
178 uint8_t enabled;
179};
180
183 const char *name;
184 const char *color;
185 const char *description;
186 uint8_t loglevel;
187 uint8_t enabled;
188};
189
201
215
217#define LOG_MAX_CTX _LOG_CTX_COUNT
219#define LOG_MAX_FILTERS _LOG_FLT_COUNT
220
223 void *ctx[LOG_MAX_CTX+1];
224};
225
227#define LOG_FILTER_ALL (1<<LOG_FLT_ALL)
229#define GPRS_CTX_NSVC LOG_CTX_GB_NSVC
231#define GPRS_CTX_BVC LOG_CTX_GB_BVC
235struct log_target;
236
238typedef int log_filter(const struct log_context *ctx,
239 struct log_target *target);
240
241struct log_info;
242struct vty;
243struct gsmtap_inst;
244
245typedef void log_print_filters(struct vty *vty,
246 const struct log_info *info,
247 const struct log_target *tgt);
248
249typedef void log_save_filters(struct vty *vty,
250 const struct log_info *info,
251 const struct log_target *tgt);
252
254struct log_info {
255 /* filter callback function */
257
259 const struct log_info_cat *cat;
261 unsigned int num_cat;
263 unsigned int num_cat_user;
264
269};
270
280};
281
287};
288
293};
294
303
306
308 uint8_t loglevel;
310 unsigned int use_color:1;
312 unsigned int print_timestamp:1;
314 unsigned int print_tid:1;
316 unsigned int print_filename:1;
318 unsigned int print_category:1;
320 unsigned int print_ext_timestamp:1;
321
324
325 union {
326 struct {
327 /* direct, blocking output via stdio */
328 FILE *out;
329 const char *fname;
330 /* indirect output via write_queue and osmo_select_main() */
333
334 struct {
338
339 struct {
340 void *vty;
342
343 struct {
344 void *rb;
346
347 struct {
349 const char *ident;
350 const char *hostname;
352
353 struct {
354 bool raw;
356 };
357
364 void (*output) (struct log_target *target, unsigned int level,
365 const char *string);
366
379 void (*raw_output)(struct log_target *target, int subsys,
380 unsigned int level, const char *file, int line,
381 int cont, const char *format, va_list ap);
382
383 /* Should the log level be printed? */
385 /* Should we print the subsys in hex like '<000b>'? */
387 /* Should we print the source file and line, and in which way? */
389 /* Where on a log line to put the source file info. */
391};
392
393/* use the above macros */
394void logp2(int subsys, unsigned int level, const char *file,
395 int line, int cont, const char *format, ...)
396 __attribute__ ((format (printf, 6, 7)));
397void logp_stub(const char *file, int line, int cont, const char *format, ...);
398int log_init(const struct log_info *inf, void *talloc_ctx);
400void log_fini(void);
401int log_check_level(int subsys, unsigned int level);
402
403/* context management */
404void log_reset_context(void);
405int log_set_context(uint8_t ctx, void *value);
406
407/* filter on the targets */
408void log_set_all_filter(struct log_target *target, int);
409
410void log_set_use_color(struct log_target *target, int);
411void log_set_print_extended_timestamp(struct log_target *target, int);
412void log_set_print_timestamp(struct log_target *target, int);
413void log_set_print_tid(struct log_target *target, int);
414void log_set_print_filename(struct log_target *target, int) OSMO_DEPRECATED("Use log_set_print_filename2() instead");
415void log_set_print_filename2(struct log_target *target, enum log_filename_type lft);
416void log_set_print_filename_pos(struct log_target *target, enum log_filename_pos pos);
417void log_set_print_category(struct log_target *target, int);
418void log_set_print_category_hex(struct log_target *target, int);
419void log_set_print_level(struct log_target *target, int);
420void log_set_log_level(struct log_target *target, int log_level);
421void log_parse_category_mask(struct log_target *target, const char* mask);
422const char* log_category_name(int subsys);
424const char *log_level_str(unsigned int lvl) OSMO_DEPRECATED_OUTSIDE_LIBOSMOCORE;
425int log_parse_category(const char *category);
426void log_set_category_filter(struct log_target *target, int category,
427 int enable, int level);
428
429/* management of the targets */
430struct log_target *log_target_create(void);
431void log_target_destroy(struct log_target *target);
433struct log_target *log_target_create_file(const char *fname);
434struct log_target *log_target_create_syslog(const char *ident, int option,
435 int facility);
436struct log_target *log_target_create_gsmtap(const char *host, uint16_t port,
437 const char *ident,
438 bool ofd_wq_mode,
439 bool add_sink);
441void log_target_systemd_set_raw(struct log_target *target, bool raw);
442int log_target_file_reopen(struct log_target *tgt);
445int log_targets_reopen(void);
446
447void log_add_target(struct log_target *target);
448void log_del_target(struct log_target *target);
449
450struct log_target *log_target_find(enum log_target_type type, const char *fname);
451
452void log_enable_multithread(void);
453
454void log_tgt_mutex_lock_impl(void);
456#define LOG_MTX_DEBUG 0
457#if LOG_MTX_DEBUG
458 #include <pthread.h>
459 #define log_tgt_mutex_lock() do { fprintf(stderr, "[%lu] %s:%d [%s] lock\n", pthread_self(), __FILE__, __LINE__, __func__); log_tgt_mutex_lock_impl(); } while (0)
460 #define log_tgt_mutex_unlock() do { fprintf(stderr, "[%lu] %s:%d [%s] unlock\n", pthread_self(), __FILE__, __LINE__, __func__); log_tgt_mutex_unlock_impl(); } while (0)
461#else
462 #define log_tgt_mutex_lock() log_tgt_mutex_lock_impl()
463 #define log_tgt_mutex_unlock() log_tgt_mutex_unlock_impl()
464#endif
465
General definitions that are meant to be included from header files.
enum osmo_sub_auth_type type
write Write running configuration to or terminal n Write configuration to the file(same as write file)\n") ALIAS(config_write_file
log_filter_index
Indexes to indicate objects that should be logged.
Definition: logging.h:205
struct log_target * log_target_create_stderr(void)
Create the STDERR log target.
Definition: logging.c:1074
log_ctx_index
Indexes to indicate the object currently acted upon.
Definition: logging.h:192
int log_target_file_switch_to_wqueue(struct log_target *tgt)
switch from blocking + buffered file output to non-blocking write-queue based output.
Definition: logging.c:1174
struct log_target * log_target_create_file(const char *fname)
Create a new file-based log target using non-blocking write_queue.
Definition: logging.c:1231
void log_tgt_mutex_unlock_impl(void)
Release the osmo_log_tgt_mutex.
Definition: logging.c:133
log_target_type
Type of logging target.
Definition: logging.h:272
void log_set_print_category(struct log_target *target, int)
Enable or disable printing of the category name.
Definition: logging.c:913
void log_tgt_mutex_lock_impl(void)
Acquire the osmo_log_tgt_mutex.
Definition: logging.c:117
void log_set_use_color(struct log_target *target, int)
Enable or disable the use of colored output.
Definition: logging.c:834
int log_target_file_reopen(struct log_target *tgt)
close and re-open a log file (for log file rotation)
Definition: logging.c:1357
void log_set_print_tid(struct log_target *target, int)
Enable or disable printing of timestamps while logging.
Definition: logging.c:865
int log_initialized(void)
void log_set_print_category_hex(struct log_target *target, int)
Enable or disable printing of the category number in hex ('<000b>').
Definition: logging.c:922
int log_parse_level(const char *lvl) OSMO_DEPRECATED_OUTSIDE_LIBOSMOCORE
Parse a human-readable log level into a numeric value.
Definition: logging.c:331
void log_set_print_level(struct log_target *target, int)
Enable or disable printing of the log level name.
Definition: logging.c:933
void log_set_all_filter(struct log_target *target, int)
Enable the LOG_FLT_ALL log filter.
Definition: logging.c:822
void log_parse_category_mask(struct log_target *target, const char *mask)
parse the log category mask
Definition: logging.c:372
int log_set_context(uint8_t ctx, void *value)
Set the logging context.
Definition: logging.c:804
struct log_target * log_target_create_gsmtap(const char *host, uint16_t port, const char *ident, bool ofd_wq_mode, bool add_sink)
Create a new logging target for GSMTAP logging.
Definition: logging_gsmtap.c:130
void log_set_print_filename_pos(struct log_target *target, enum log_filename_pos pos)
Set the position where on a log line the source file info should be logged.
Definition: logging.c:902
void log_print_filters(struct vty *vty, const struct log_info *info, const struct log_target *tgt)
Definition: logging.h:245
void osmo_vlogp(int subsys, int level, const char *file, int line, int cont, const char *format, va_list ap)
vararg version of logging function
Definition: logging.c:696
void log_set_log_level(struct log_target *target, int log_level)
Set the global log level for a given log target.
Definition: logging.c:942
void log_save_filters(struct vty *vty, const struct log_info *info, const struct log_target *tgt)
Definition: logging.h:249
#define LOG_MAX_FILTERS
Maximum number of logging filters.
Definition: logging.h:219
void log_target_destroy(struct log_target *target)
Unregister, close and delete a log target.
Definition: logging.c:1307
log_filename_pos
Where on a log line source file and line should be logged.
Definition: logging.h:290
int log_check_level(int subsys, unsigned int level)
Check whether a log entry will be generated.
Definition: logging.c:1500
const char * log_level_str(unsigned int lvl) OSMO_DEPRECATED_OUTSIDE_LIBOSMOCORE
convert a numeric log level into human-readable string
Definition: logging.c:340
const char * log_category_name(int subsys)
Definition: logging.c:445
struct log_info * osmo_log_info
Definition: logging.c:87
void log_set_print_filename2(struct log_target *target, enum log_filename_type lft)
Enable or disable printing of the filename while logging.
Definition: logging.c:891
struct log_target * log_target_create_systemd(bool raw)
Create a new logging target for systemd journal logging.
Definition: logging_systemd.c:86
int log_filter(const struct log_context *ctx, struct log_target *target)
Log filter function.
Definition: logging.h:238
struct log_target * log_target_create(void)
Create a new log target skeleton.
Definition: logging.c:1032
void log_set_print_extended_timestamp(struct log_target *target, int)
Enable or disable printing of extended timestamps while logging.
Definition: logging.c:856
void log_set_category_filter(struct log_target *target, int category, int enable, int level)
Set a category filter on a given log target.
Definition: logging.c:953
log_filename_type
Whether/how to log the source filename (and line number).
Definition: logging.h:283
void logp(int subsys, const char *file, int line, int cont, const char *format,...) OSMO_DEPRECATED("Use DEBUGP* macros instead")
logging function used by DEBUGP() macro
Definition: logging.c:731
void log_fini(void)
Definition: logging.c:1481
#define DEBUGP(ss, fmt, args...)
Log a debug message through the Osmocom logging framework.
Definition: logging.h:30
#define LOG_MAX_CTX
Maximum number of logging contexts.
Definition: logging.h:217
int log_init(const struct log_info *inf, void *talloc_ctx)
Initialize the Osmocom logging core.
Definition: logging.c:1422
void void logp_stub(const char *file, int line, int cont, const char *format,...)
Definition: logging.c:761
int log_parse_category(const char *category)
parse a human-readable log category into numeric form
Definition: logging.c:349
struct log_target * log_target_find(enum log_target_type type, const char *fname)
Find a registered log target.
Definition: logging.c:1282
void log_enable_multithread(void)
Enable multithread support (mutex) in libosmocore logging system.
Definition: logging.c:107
int log_target_file_switch_to_stream(struct log_target *tgt)
switch from non-blocking/write-queue to blocking + buffered stream output
Definition: logging.c:1123
int log_targets_reopen(void)
close and re-open all log files (for log file rotation)
Definition: logging.c:1392
void log_set_print_filename(struct log_target *target, int) OSMO_DEPRECATED("Use log_set_print_filename2() instead")
Use log_set_print_filename2() instead.
Definition: logging.c:879
void logp2(int subsys, unsigned int level, const char *file, int line, int cont, const char *format,...) __attribute__((format(printf
logging function used by LOGP() macro
Definition: logging.c:748
void log_set_print_timestamp(struct log_target *target, int)
Enable or disable printing of timestamps while logging.
Definition: logging.c:843
struct log_target * log_target_create_syslog(const char *ident, int option, int facility)
Create a new logging target for syslog logging.
Definition: logging_syslog.c:69
void log_add_target(struct log_target *target)
Register a new log target with the logging core.
Definition: logging.c:774
void log_del_target(struct log_target *target)
Unregister a log target from the logging core.
Definition: logging.c:782
void log_reset_context(void)
Reset (clear) the logging context.
Definition: logging.c:788
void log_target_systemd_set_raw(struct log_target *target, bool raw)
Change meta information handling of an existing logging target.
Definition: logging_systemd.c:105
@ LOG_FLT_VLR_SUBSCR
Definition: logging.h:210
@ _LOG_FLT_COUNT
Definition: logging.h:213
@ LOG_FLT_ALL
Definition: logging.h:206
@ LOG_FLT_GB_NSE
Definition: logging.h:212
@ LOG_FLT_BSC_SUBSCR
Definition: logging.h:209
@ LOG_FLT_GB_NSVC
Definition: logging.h:207
@ LOG_FLT_L1_SAPI
Definition: logging.h:211
@ LOG_FLT_GB_BVC
Definition: logging.h:208
@ LOG_CTX_GB_NSE
Definition: logging.h:198
@ LOG_CTX_BSC_SUBSCR
Definition: logging.h:195
@ LOG_CTX_GB_BVC
Definition: logging.h:194
@ _LOG_CTX_COUNT
Definition: logging.h:199
@ LOG_CTX_L1_SAPI
Definition: logging.h:197
@ LOG_CTX_GB_NSVC
Definition: logging.h:193
@ LOG_CTX_VLR_SUBSCR
Definition: logging.h:196
@ LOG_TGT_TYPE_VTY
VTY logging.
Definition: logging.h:273
@ LOG_TGT_TYPE_FILE
text file logging
Definition: logging.h:275
@ LOG_TGT_TYPE_SYSLOG
syslog based logging
Definition: logging.h:274
@ LOG_TGT_TYPE_STRRB
osmo_strrb-backed logging
Definition: logging.h:277
@ LOG_TGT_TYPE_STDERR
stderr logging
Definition: logging.h:276
@ LOG_TGT_TYPE_GSMTAP
GSMTAP network logging.
Definition: logging.h:278
@ LOG_TGT_TYPE_SYSTEMD
systemd journal logging
Definition: logging.h:279
@ LOG_FILENAME_POS_LINE_END
Definition: logging.h:292
@ LOG_FILENAME_POS_HEADER_END
Definition: logging.h:291
@ LOG_FILENAME_BASENAME
Definition: logging.h:286
@ LOG_FILENAME_NONE
Definition: logging.h:284
@ LOG_FILENAME_PATH
Definition: logging.h:285
#define OSMO_DEPRECATED_OUTSIDE_LIBOSMOCORE
Definition: defs.h:48
#define OSMO_DEPRECATED(text)
Set the deprecated attribute with a message.
Definition: defs.h:41
struct gsm48_classmark3 __attribute__
Definition: log2.h:61
char subsys[16]
logging sub-system
Definition: gsmtap.h:9
uint8_t level
logging level
Definition: gsmtap.h:6
Simple doubly linked list implementation.
one gsmtap instance
Definition: gsmtap_util.h:27
(double) linked list header structure
Definition: linuxlist.h:46
Configuration of single log category / sub-system.
Definition: logging.h:176
uint8_t enabled
is logging enabled?
Definition: logging.h:178
uint8_t loglevel
configured log-level
Definition: logging.h:177
Log context information, passed to filter.
Definition: logging.h:222
void * ctx[LOG_MAX_CTX+1]
Definition: logging.h:223
Information regarding one logging category.
Definition: logging.h:182
uint8_t enabled
is this category enabled or not
Definition: logging.h:187
const char * name
name of category
Definition: logging.h:183
const char * description
description text
Definition: logging.h:185
const char * color
color string for cateyory
Definition: logging.h:184
uint8_t loglevel
currently selected log-level
Definition: logging.h:186
Logging configuration, passed to log_init.
Definition: logging.h:254
unsigned int num_cat
total number of categories
Definition: logging.h:261
log_print_filters * print_fn
filter saving function
Definition: logging.h:268
log_save_filters * save_fn
filter saving function
Definition: logging.h:266
log_filter * filter_fn
Definition: logging.h:256
const struct log_info_cat * cat
per-category information
Definition: logging.h:259
unsigned int num_cat_user
total number of user categories (not library)
Definition: logging.h:263
structure representing a logging target
Definition: logging.h:296
bool print_category_hex
Definition: logging.h:386
int priority
Definition: logging.h:335
unsigned int print_timestamp
should log messages be prefixed with a timestamp?
Definition: logging.h:312
void * vty
Definition: logging.h:340
struct log_target::@8::@15 sd_journal
struct log_target::@8::@14 tgt_gsmtap
struct log_category * categories
logging categories
Definition: logging.h:305
struct log_target::@8::@10 tgt_file
unsigned int print_tid
should log messages be prefixed with the logger Thread ID?
Definition: logging.h:314
struct llist_head entry
linked list
Definition: logging.h:297
int filter_map
Internal data for filtering.
Definition: logging.h:300
void * filter_data[LOG_MAX_FILTERS+1]
Internal data for filtering.
Definition: logging.h:302
struct osmo_wqueue * wqueue
Definition: logging.h:331
enum log_filename_type print_filename2
Definition: logging.h:388
void(* raw_output)(struct log_target *target, int subsys, unsigned int level, const char *file, int line, int cont, const char *format, va_list ap)
alternative call-back function to which the logging framework passes the unfortmatted input arguments...
Definition: logging.h:379
int facility
Definition: logging.h:336
enum log_filename_pos print_filename_pos
Definition: logging.h:390
unsigned int print_filename
DEPRECATED: use print_filename2 instead.
Definition: logging.h:316
struct gsmtap_inst * gsmtap_inst
Definition: logging.h:348
unsigned int use_color
should color be used when printing log messages?
Definition: logging.h:310
struct log_target::@8::@12 tgt_vty
struct log_target::@8::@13 tgt_rb
unsigned int print_ext_timestamp
should log messages be prefixed with an extended timestamp?
Definition: logging.h:320
void * rb
Definition: logging.h:344
bool raw
Definition: logging.h:354
const char * fname
Definition: logging.h:329
unsigned int print_category
should log messages be prefixed with a category name?
Definition: logging.h:318
enum log_target_type type
the type of this log taget
Definition: logging.h:323
struct log_target::@8::@11 tgt_syslog
FILE * out
Definition: logging.h:328
bool print_level
Definition: logging.h:384
const char * hostname
Definition: logging.h:350
const char * ident
Definition: logging.h:349
void(* output)(struct log_target *target, unsigned int level, const char *string)
call-back function to be called when the logging framework wants to log a fully formatted string
Definition: logging.h:364
uint8_t loglevel
global log level
Definition: logging.h:308
write queue instance
Definition: write_queue.h:30