libosmocore  1.5.1
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>
12 #include <osmocom/core/linuxlist.h>
13 
14 #ifndef DEBUG
15 #define DEBUG
16 #endif
17 
18 #ifdef DEBUG
19 
24 #define DEBUGP(ss, fmt, args...) LOGP(ss, LOGL_DEBUG, fmt, ##args)
25 #define DEBUGPC(ss, fmt, args...) LOGPC(ss, LOGL_DEBUG, fmt, ##args)
26 #else
27 #define DEBUGP(xss, fmt, args...)
28 #define DEBUGPC(ss, fmt, args...)
29 #endif
30 
31 
32 void osmo_vlogp(int subsys, int level, const char *file, int line,
33  int cont, const char *format, va_list ap);
34 
35 void logp(int subsys, const char *file, int line, int cont, const char *format, ...) OSMO_DEPRECATED("Use DEBUGP* macros instead");
36 
43 #define LOGP(ss, level, fmt, args...) \
44  LOGPSRC(ss, level, NULL, 0, fmt, ## args)
45 
52 #define LOGPC(ss, level, fmt, args...) \
53  do { \
54  if (log_check_level(ss, level)) \
55  logp2(ss, level, __FILE__, __LINE__, 1, fmt, ##args); \
56  } while(0)
57 
70 #define LOGPSRC(ss, level, caller_file, caller_line, fmt, args...) \
71  LOGPSRCC(ss, level, caller_file, caller_line, 0, fmt, ##args)
72 
86 #define LOGPSRCC(ss, level, caller_file, caller_line, cont, fmt, args...) \
87  do { \
88  if (log_check_level(ss, level)) {\
89  if (caller_file) \
90  logp2(ss, level, caller_file, caller_line, cont, fmt, ##args); \
91  else \
92  logp2(ss, level, __FILE__, __LINE__, cont, fmt, ##args); \
93  }\
94  } while(0)
95 
97 #define LOGL_DEBUG 1
98 #define LOGL_INFO 3
99 #define LOGL_NOTICE 5
100 #define LOGL_ERROR 7
101 #define LOGL_FATAL 8
103 /* logging subsystems defined by the library itself */
104 #define DLGLOBAL -1
105 #define DLLAPD -2
106 #define DLINP -3
107 #define DLMUX -4
108 #define DLMI -5
109 #define DLMIB -6
110 #define DLSMS -7
111 #define DLCTRL -8
112 #define DLGTP -9
113 #define DLSTATS -10
114 #define DLGSUP -11
115 #define DLOAP -12
116 #define DLSS7 -13
117 #define DLSCCP -14
118 #define DLSUA -15
119 #define DLM3UA -16
120 #define DLMGCP -17
121 #define DLJIBUF -18
122 #define DLRSPRO -19
123 #define DLNS -20
124 #define DLBSSGP -21
125 #define OSMO_NUM_DLIB 21
127 /* Colors that can be used in log_info_cat.color */
128 #define OSMO_LOGCOLOR_NORMAL NULL
129 #define OSMO_LOGCOLOR_RED "\033[1;31m"
130 #define OSMO_LOGCOLOR_GREEN "\033[1;32m"
131 #define OSMO_LOGCOLOR_YELLOW "\033[1;33m"
132 #define OSMO_LOGCOLOR_BLUE "\033[1;34m"
133 #define OSMO_LOGCOLOR_PURPLE "\033[1;35m"
134 #define OSMO_LOGCOLOR_CYAN "\033[1;36m"
135 #define OSMO_LOGCOLOR_DARKRED "\033[31m"
136 #define OSMO_LOGCOLOR_DARKGREEN "\033[32m"
137 #define OSMO_LOGCOLOR_DARKYELLOW "\033[33m"
138 #define OSMO_LOGCOLOR_DARKBLUE "\033[34m"
139 #define OSMO_LOGCOLOR_DARKPURPLE "\033[35m"
140 #define OSMO_LOGCOLOR_DARKCYAN "\033[36m"
141 #define OSMO_LOGCOLOR_DARKGREY "\033[1;30m"
142 #define OSMO_LOGCOLOR_GREY "\033[37m"
143 #define OSMO_LOGCOLOR_BRIGHTWHITE "\033[1;37m"
144 #define OSMO_LOGCOLOR_END "\033[0;m"
145 
147 struct log_category {
148  uint8_t loglevel;
149  uint8_t enabled;
150 };
151 
153 struct log_info_cat {
154  const char *name;
155  const char *color;
156  const char *description;
157  uint8_t loglevel;
158  uint8_t enabled;
159 };
160 
171 };
172 
185 };
186 
188 #define LOG_MAX_CTX _LOG_CTX_COUNT
189 
190 #define LOG_MAX_FILTERS _LOG_FLT_COUNT
191 
193 struct log_context {
194  void *ctx[LOG_MAX_CTX+1];
195 };
196 
198 #define LOG_FILTER_ALL (1<<LOG_FLT_ALL)
199 
200 #define GPRS_CTX_NSVC LOG_CTX_GB_NSVC
201 
202 #define GPRS_CTX_BVC LOG_CTX_GB_BVC
203 
206 struct log_target;
207 
209 typedef int log_filter(const struct log_context *ctx,
210  struct log_target *target);
211 
212 struct log_info;
213 struct vty;
214 struct gsmtap_inst;
215 
216 typedef void log_print_filters(struct vty *vty,
217  const struct log_info *info,
218  const struct log_target *tgt);
219 
220 typedef void log_save_filters(struct vty *vty,
221  const struct log_info *info,
222  const struct log_target *tgt);
223 
225 struct log_info {
226  /* filter callback function */
228 
230  const struct log_info_cat *cat;
232  unsigned int num_cat;
234  unsigned int num_cat_user;
235 
240 };
241 
251 };
252 
258 };
259 
264 };
265 
267 struct log_target {
268  struct llist_head entry;
273  void *filter_data[LOG_MAX_FILTERS+1];
274 
277 
279  uint8_t loglevel;
281  unsigned int use_color:1;
283  unsigned int print_timestamp:1;
285  unsigned int print_tid:1;
287  unsigned int print_filename:1;
289  unsigned int print_category:1;
291  unsigned int print_ext_timestamp:1;
292 
295 
296  union {
297  struct {
298  FILE *out;
299  const char *fname;
300  } tgt_file;
301 
302  struct {
303  int priority;
304  int facility;
305  } tgt_syslog;
306 
307  struct {
308  void *vty;
309  } tgt_vty;
310 
311  struct {
312  void *rb;
313  } tgt_rb;
314 
315  struct {
317  const char *ident;
318  const char *hostname;
319  } tgt_gsmtap;
320 
321  struct {
322  bool raw;
323  } sd_journal;
324  };
325 
332  void (*output) (struct log_target *target, unsigned int level,
333  const char *string);
334 
347  void (*raw_output)(struct log_target *target, int subsys,
348  unsigned int level, const char *file, int line,
349  int cont, const char *format, va_list ap);
350 
351  /* Should the log level be printed? */
353  /* Should we print the subsys in hex like '<000b>'? */
355  /* Should we print the source file and line, and in which way? */
357  /* Where on a log line to put the source file info. */
359 };
360 
361 /* use the above macros */
362 void logp2(int subsys, unsigned int level, const char *file,
363  int line, int cont, const char *format, ...)
364  __attribute__ ((format (printf, 6, 7)));
365 int log_init(const struct log_info *inf, void *talloc_ctx);
366 void log_fini(void);
367 int log_check_level(int subsys, unsigned int level);
368 
369 /* context management */
370 void log_reset_context(void);
371 int log_set_context(uint8_t ctx, void *value);
372 
373 /* filter on the targets */
374 void log_set_all_filter(struct log_target *target, int);
375 
376 void log_set_use_color(struct log_target *target, int);
377 void log_set_print_extended_timestamp(struct log_target *target, int);
378 void log_set_print_timestamp(struct log_target *target, int);
379 void log_set_print_tid(struct log_target *target, int);
380 void log_set_print_filename(struct log_target *target, int) OSMO_DEPRECATED("Use log_set_print_filename2() instead");
381 void log_set_print_filename2(struct log_target *target, enum log_filename_type lft);
382 void log_set_print_filename_pos(struct log_target *target, enum log_filename_pos pos);
383 void log_set_print_category(struct log_target *target, int);
384 void log_set_print_category_hex(struct log_target *target, int);
385 void log_set_print_level(struct log_target *target, int);
386 void log_set_log_level(struct log_target *target, int log_level);
387 void log_parse_category_mask(struct log_target *target, const char* mask);
388 const char* log_category_name(int subsys);
390 const char *log_level_str(unsigned int lvl) OSMO_DEPRECATED_OUTSIDE_LIBOSMOCORE;
391 int log_parse_category(const char *category);
392 void log_set_category_filter(struct log_target *target, int category,
393  int enable, int level);
394 
395 /* management of the targets */
396 struct log_target *log_target_create(void);
397 void log_target_destroy(struct log_target *target);
399 struct log_target *log_target_create_file(const char *fname);
400 struct log_target *log_target_create_syslog(const char *ident, int option,
401  int facility);
402 struct log_target *log_target_create_gsmtap(const char *host, uint16_t port,
403  const char *ident,
404  bool ofd_wq_mode,
405  bool add_sink);
407 void log_target_systemd_set_raw(struct log_target *target, bool raw);
408 int log_target_file_reopen(struct log_target *tgt);
409 int log_targets_reopen(void);
410 
411 void log_add_target(struct log_target *target);
412 void log_del_target(struct log_target *target);
413 
414 struct log_target *log_target_find(int type, const char *fname);
415 
416 void log_enable_multithread(void);
417 
418 void log_tgt_mutex_lock_impl(void);
419 void log_tgt_mutex_unlock_impl(void);
420 #define LOG_MTX_DEBUG 0
421 #if LOG_MTX_DEBUG
422  #include <pthread.h>
423  #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)
424  #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)
425 #else
426  #define log_tgt_mutex_lock() log_tgt_mutex_lock_impl()
427  #define log_tgt_mutex_unlock() log_tgt_mutex_unlock_impl()
428 #endif
429 
void log_set_print_category_hex(struct log_target *target, int)
Enable or disable printing of the category number in hex (&#39;<000b>&#39;).
Definition: logging.c:853
Definition: logging.h:262
Information regarding one logging category.
Definition: logging.h:153
int filter_map
Internal data for filtering.
Definition: logging.h:271
int log_parse_level(const char *lvl) OSMO_DEPRECATED_OUTSIDE_LIBOSMOCORE
Parse a human-readable log level into a numeric value.
Definition: logging.c:301
#define OSMO_DEPRECATED(text)
Set the deprecated attribute with a message.
Definition: defs.h:41
int log_parse_category(const char *category)
parse a human-readable log category into numeric form
Definition: logging.c:319
const char * name
name of category
Definition: logging.h:154
VTY logging.
Definition: logging.h:244
struct gsm48_classmark3 __attribute__
fls64 - find last set bit in a 64-bit word : the word to search
Definition: log2.h:61
log_save_filters * save_fn
filter saving function
Definition: logging.h:237
Definition: logging.h:184
log_filename_type
Whether/how to log the source filename (and line number).
Definition: logging.h:254
void log_set_print_tid(struct log_target *target, int)
Enable or disable printing of timestamps while logging.
Definition: logging.c:796
bool print_level
Definition: logging.h:352
void * rb
Definition: logging.h:312
char subsys[16]
logging sub-system
Definition: gsmtap.h:129
void log_set_print_timestamp(struct log_target *target, int)
Enable or disable printing of timestamps while logging.
Definition: logging.c:774
const char * fname
Definition: logging.h:299
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:674
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:810
Configuration of single log category / sub-system.
Definition: logging.h:147
void log_set_print_extended_timestamp(struct log_target *target, int)
Enable or disable printing of extended timestamps while logging.
Definition: logging.c:787
log_ctx_index
Indexes to indicate the object currently acted upon.
Definition: logging.h:163
Definition: logging.h:165
#define OSMO_DEPRECATED_OUTSIDE_LIBOSMOCORE
Definition: defs.h:48
Definition: logging.h:256
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:134
Definition: logging.h:179
uint8_t enabled
is this category enabled or not
Definition: logging.h:158
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:822
log_filter_index
Indexes to indicate objects that should be logged.
Definition: logging.h:176
Definition: logging.h:177
int log_set_context(uint8_t ctx, void *value)
Set the logging context.
Definition: logging.c:735
syslog based logging
Definition: logging.h:245
const char * ident
Definition: logging.h:317
Definition: logging.h:168
Definition: logging.h:169
Definition: logging.h:180
General definitions that are meant to be included from header files.
bool raw
Definition: logging.h:322
log_target_type
Type of logging target.
Definition: logging.h:243
void log_target_destroy(struct log_target *target)
Unregister, close and delete a log target.
Definition: logging.c:1029
#define DEBUGP(ss, fmt, args...)
Log a debug message through the Osmocom logging framework.
Definition: logging.h:24
void * vty
Definition: logging.h:308
#define LOG_MAX_FILTERS
Maximum number of logging filters.
Definition: logging.h:190
write Write running configuration to or terminal n Write configuration to the file(same as write file)\n") ALIAS(config_write_file
struct log_target * log_target_find(int type, const char *fname)
Find a registered log target.
Definition: logging.c:1004
one gsmtap instance
Definition: gsmtap_util.h:27
uint8_t enabled
is logging enabled?
Definition: logging.h:149
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:109
enum log_filename_type print_filename2
Definition: logging.h:356
int facility
Definition: logging.h:304
uint8_t level
logging level
Definition: gsmtap.h:126
unsigned int print_category
should log messages be prefixed with a category name?
Definition: logging.h:289
void log_add_target(struct log_target *target)
Register a new log target with the logging core.
Definition: logging.c:705
int log_filter(const struct log_context *ctx, struct log_target *target)
Log filter function.
Definition: logging.h:209
osmo_strrb-backed logging
Definition: logging.h:248
Definition: logging.h:181
int priority
Definition: logging.h:303
void log_enable_multithread(void)
Enable multithread support (mutex) in libosmocore logging system.
Definition: logging.c:101
text file logging
Definition: logging.h:246
Definition: logging.h:255
bool print_category_hex
Definition: logging.h:354
void log_del_target(struct log_target *target)
Unregister a log target from the logging core.
Definition: logging.c:713
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:347
FILE * out
Definition: logging.h:298
enum log_filename_pos print_filename_pos
Definition: logging.h:358
Definition: logging.h:183
void log_set_all_filter(struct log_target *target, int)
Enable the LOG_FLT_ALL log filter.
Definition: logging.c:753
stderr logging
Definition: logging.h:247
void log_save_filters(struct vty *vty, const struct log_info *info, const struct log_target *tgt)
Definition: logging.h:220
unsigned int print_tid
should log messages be prefixed with the logger Thread ID?
Definition: logging.h:285
struct gsmtap_inst * gsmtap_inst
Definition: logging.h:316
Simple doubly linked list implementation.
void log_print_filters(struct vty *vty, const struct log_info *info, const struct log_target *tgt)
Definition: logging.h:216
unsigned int print_filename
DEPRECATED: use print_filename2 instead.
Definition: logging.h:287
(double) linked list header structure
Definition: linuxlist.h:46
void log_set_use_color(struct log_target *target, int)
Enable or disable the use of colored output.
Definition: logging.c:765
const char * color
color string for cateyory
Definition: logging.h:155
struct log_target * log_target_create_systemd(bool raw)
Create a new logging target for systemd journal logging.
Definition: logging_systemd.c:90
Definition: logging.h:178
void log_set_print_category(struct log_target *target, int)
Enable or disable printing of the category name.
Definition: logging.c:844
log_filter * filter_fn
Definition: logging.h:227
Definition: logging.h:166
int log_target_file_reopen(struct log_target *tgt)
close and re-open a log file (for log file rotation)
Definition: logging.c:1060
Definition: logging.h:167
void int log_init(const struct log_info *inf, void *talloc_ctx)
Initialize the Osmocom logging core.
Definition: logging.c:1105
struct log_target * log_target_create_stderr(void)
Create the STDERR log target.
Definition: logging.c:951
const char * log_level_str(unsigned int lvl) OSMO_DEPRECATED_OUTSIDE_LIBOSMOCORE
convert a numeric log level into human-readable string
Definition: logging.c:310
struct log_category * categories
logging categories
Definition: logging.h:276
uint8_t loglevel
global log level
Definition: logging.h:279
void log_tgt_mutex_lock_impl(void)
Acquire the osmo_log_tgt_mutex.
Definition: logging.c:111
Definition: logging.h:257
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:884
void log_tgt_mutex_unlock_impl(void)
Release the osmo_log_tgt_mutex.
Definition: logging.c:127
GSMTAP network logging.
Definition: logging.h:249
void log_fini(void)
Definition: logging.c:1164
int log_check_level(int subsys, unsigned int level)
Check whether a log entry will be generated.
Definition: logging.c:1183
uint8_t loglevel
configured log-level
Definition: logging.h:148
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:833
Definition: logging.h:182
Definition: logging.h:170
struct log_target * log_target_create_file(const char *fname)
Create a new file-based log target.
Definition: logging.c:975
log_filename_pos
Where on a log line source file and line should be logged.
Definition: logging.h:261
Logging configuration, passed to log_init.
Definition: logging.h:225
uint8_t type
see GSMTAP_TYPE_*
Definition: gsmtap.h:122
void log_parse_category_mask(struct log_target *target, const char *mask)
parse the log category mask
Definition: logging.c:342
unsigned int print_timestamp
should log messages be prefixed with a timestamp?
Definition: logging.h:283
Definition: logging.h:164
log_print_filters * print_fn
filter saving function
Definition: logging.h:239
unsigned int num_cat_user
total number of user categories (not library)
Definition: logging.h:234
const char * log_category_name(int subsys)
Definition: logging.c:415
Log context information, passed to filter.
Definition: logging.h:193
const struct log_info_cat * cat
per-category information
Definition: logging.h:230
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:73
unsigned int use_color
should color be used when printing log messages?
Definition: logging.h:281
unsigned int print_ext_timestamp
should log messages be prefixed with an extended timestamp?
Definition: logging.h:291
struct log_target * log_target_create(void)
Create a new log target skeleton.
Definition: logging.c:909
void log_set_print_level(struct log_target *target, int)
Enable or disable printing of the log level name.
Definition: logging.c:864
const char * hostname
Definition: logging.h:318
structure representing a logging target
Definition: logging.h:267
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:639
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:873
void log_reset_context(void)
Reset (clear) the logging context.
Definition: logging.c:719
#define LOG_MAX_CTX
Maximum number of logging contexts.
Definition: logging.h:188
systemd journal logging
Definition: logging.h:250
uint8_t loglevel
currently selected log-level
Definition: logging.h:157
unsigned int num_cat
total number of categories
Definition: logging.h:232
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:691
int log_targets_reopen(void)
close and re-open all log files (for log file rotation)
Definition: logging.c:1075
Definition: logging.h:263
const char * description
description text
Definition: logging.h:156