libosmocore  0.10.2
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 
15 #define LOG_MAX_CTX 8
16 
17 #define LOG_MAX_FILTERS 8
18 
19 #define DEBUG
20 
21 #ifdef DEBUG
22 
27 #define DEBUGP(ss, fmt, args...) LOGP(ss, LOGL_DEBUG, fmt, ##args)
28 #define DEBUGPC(ss, fmt, args...) LOGPC(ss, LOGL_DEBUG, fmt, ##args)
29 #else
30 #define DEBUGP(xss, fmt, args...)
31 #define DEBUGPC(ss, fmt, args...)
32 #endif
33 
34 
35 void osmo_vlogp(int subsys, int level, const char *file, int line,
36  int cont, const char *format, va_list ap);
37 
38 void logp(int subsys, const char *file, int line, int cont, const char *format, ...) OSMO_DEPRECATED("Use DEBUGP* macros instead");
39 
46 #define LOGP(ss, level, fmt, args...) \
47  LOGPSRC(ss, level, NULL, 0, fmt, ## args)
48 
55 #define LOGPC(ss, level, fmt, args...) \
56  do { \
57  if (log_check_level(ss, level)) \
58  logp2(ss, level, __BASE_FILE__, __LINE__, 1, fmt, ##args); \
59  } while(0)
60 
73 #define LOGPSRC(ss, level, caller_file, caller_line, fmt, args...) \
74  do { \
75  if (log_check_level(ss, level)) {\
76  if (caller_file) \
77  logp2(ss, level, caller_file, caller_line, 0, fmt, ##args); \
78  else \
79  logp2(ss, level, __BASE_FILE__, __LINE__, 0, fmt, ##args); \
80  }\
81  } while(0)
82 
84 #define LOGL_DEBUG 1
85 #define LOGL_INFO 3
86 #define LOGL_NOTICE 5
87 #define LOGL_ERROR 7
88 #define LOGL_FATAL 8
90 /* logging levels defined by the library itself */
91 #define DLGLOBAL -1
92 #define DLLAPD -2
93 #define DLINP -3
94 #define DLMUX -4
95 #define DLMI -5
96 #define DLMIB -6
97 #define DLSMS -7
98 #define DLCTRL -8
99 #define DLGTP -9
100 #define DLSTATS -10
101 #define DLGSUP -11
102 #define DLOAP -12
103 #define DLSS7 -13
104 #define DLSCCP -14
105 #define DLSUA -15
106 #define DLM3UA -16
107 #define DLMGCP -17
108 #define OSMO_NUM_DLIB 17
111 struct log_category {
112  uint8_t loglevel;
113  uint8_t enabled;
114 };
115 
117 struct log_info_cat {
118  const char *name;
119  const char *color;
120  const char *description;
121  uint8_t loglevel;
122  uint8_t enabled;
123 };
124 
126 struct log_context {
127  void *ctx[LOG_MAX_CTX+1];
128 };
129 
138 };
139 
150 };
151 
153 #define LOG_FILTER_ALL (1<<LOG_FLT_ALL)
154 
155 #define GPRS_CTX_NSVC LOG_CTX_GB_NSVC
156 
157 #define GPRS_CTX_BVC LOG_CTX_GB_BVC
158 
161 struct log_target;
162 
164 typedef int log_filter(const struct log_context *ctx,
165  struct log_target *target);
166 
167 struct log_info;
168 struct vty;
169 struct gsmtap_inst;
170 
171 typedef void log_print_filters(struct vty *vty,
172  const struct log_info *info,
173  const struct log_target *tgt);
174 
175 typedef void log_save_filters(struct vty *vty,
176  const struct log_info *info,
177  const struct log_target *tgt);
178 
180 struct log_info {
181  /* filter callback function */
183 
185  const struct log_info_cat *cat;
187  unsigned int num_cat;
189  unsigned int num_cat_user;
190 
195 };
196 
205 };
206 
208 struct log_target {
209  struct llist_head entry;
214  void *filter_data[LOG_MAX_FILTERS+1];
215 
218 
220  uint8_t loglevel;
222  unsigned int use_color:1;
224  unsigned int print_timestamp:1;
226  unsigned int print_filename:1;
228  unsigned int print_category:1;
230  unsigned int print_ext_timestamp:1;
231 
234 
235  union {
236  struct {
237  FILE *out;
238  const char *fname;
239  } tgt_file;
240 
241  struct {
242  int priority;
243  int facility;
244  } tgt_syslog;
245 
246  struct {
247  void *vty;
248  } tgt_vty;
249 
250  struct {
251  void *rb;
252  } tgt_rb;
253 
254  struct {
256  const char *ident;
257  const char *hostname;
258  } tgt_gsmtap;
259  };
260 
267  void (*output) (struct log_target *target, unsigned int level,
268  const char *string);
269 
282  void (*raw_output)(struct log_target *target, int subsys,
283  unsigned int level, const char *file, int line,
284  int cont, const char *format, va_list ap);
285 };
286 
287 /* use the above macros */
288 void logp2(int subsys, unsigned int level, const char *file,
289  int line, int cont, const char *format, ...)
290  __attribute__ ((format (printf, 6, 7)));
291 int log_init(const struct log_info *inf, void *talloc_ctx);
292 void log_fini(void);
293 int log_check_level(int subsys, unsigned int level);
294 
295 /* context management */
296 void log_reset_context(void);
297 int log_set_context(uint8_t ctx, void *value);
298 
299 /* filter on the targets */
300 void log_set_all_filter(struct log_target *target, int);
301 
302 void log_set_use_color(struct log_target *target, int);
303 void log_set_print_extended_timestamp(struct log_target *target, int);
304 void log_set_print_timestamp(struct log_target *target, int);
305 void log_set_print_filename(struct log_target *target, int);
306 void log_set_print_category(struct log_target *target, int);
307 void log_set_log_level(struct log_target *target, int log_level);
308 void log_parse_category_mask(struct log_target *target, const char* mask);
309 const char* log_category_name(int subsys);
311 const char *log_level_str(unsigned int lvl) OSMO_DEPRECATED_OUTSIDE_LIBOSMOCORE;
312 int log_parse_category(const char *category);
313 void log_set_category_filter(struct log_target *target, int category,
314  int enable, int level);
315 
316 /* management of the targets */
317 struct log_target *log_target_create(void);
318 void log_target_destroy(struct log_target *target);
320 struct log_target *log_target_create_file(const char *fname);
321 struct log_target *log_target_create_syslog(const char *ident, int option,
322  int facility);
323 struct log_target *log_target_create_gsmtap(const char *host, uint16_t port,
324  const char *ident,
325  bool ofd_wq_mode,
326  bool add_sink);
327 int log_target_file_reopen(struct log_target *tgt);
328 int log_targets_reopen(void);
329 
330 void log_add_target(struct log_target *target);
331 void log_del_target(struct log_target *target);
332 
333 /* Generate command string for VTY use */
334 const char *log_vty_command_string() OSMO_DEPRECATED_OUTSIDE_LIBOSMOCORE;
335 const char *log_vty_command_description() OSMO_DEPRECATED_OUTSIDE_LIBOSMOCORE;
336 
337 struct log_target *log_target_find(int type, const char *fname);
338 extern struct llist_head osmo_log_target_list;
339 
Information regarding one logging category.
Definition: logging.h:117
int filter_map
Internal data for filtering.
Definition: logging.h:212
int log_parse_level(const char *lvl) OSMO_DEPRECATED_OUTSIDE_LIBOSMOCORE
Parse a human-readable log level into a numeric value.
Definition: logging.c:202
#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:220
const char * name
name of category
Definition: logging.h:118
VTY logging.
Definition: logging.h:199
log_save_filters * save_fn
filter saving function
Definition: logging.h:192
Definition: logging.h:149
void * rb
Definition: logging.h:251
char subsys[16]
logging sub-system
Definition: gsmtap.h:120
void log_set_print_timestamp(struct log_target *target, int)
Enable or disable printing of timestamps while logging.
Definition: logging.c:571
const char * fname
Definition: logging.h:238
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:473
void log_set_print_filename(struct log_target *target, int)
Enable or disable printing of the filename while logging.
Definition: logging.c:593
Configuration of single log category / sub-system.
Definition: logging.h:111
void log_set_print_extended_timestamp(struct log_target *target, int)
Enable or disable printing of extended timestamps while logging.
Definition: logging.c:584
log_ctx_index
Indexes to indicate the object currently acted upon.
Definition: logging.h:132
struct rb_root __attribute__
Definition: conv_acc_generic.c:138
Definition: logging.h:134
#define OSMO_DEPRECATED_OUTSIDE_LIBOSMOCORE
Definition: defs.h:47
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:107
Definition: logging.h:146
uint8_t enabled
is this category enabled or not
Definition: logging.h:122
log_filter_index
Indexes to indicate objects that should be logged.
Definition: logging.h:143
Definition: logging.h:144
int log_set_context(uint8_t ctx, void *value)
Set the logging context.
Definition: logging.c:532
syslog based logging
Definition: logging.h:200
const char * ident
Definition: logging.h:256
const char * log_vty_command_string() OSMO_DEPRECATED_OUTSIDE_LIBOSMOCORE
Generates the logging command string for VTY.
Definition: logging.c:821
Definition: logging.h:147
General definitions that are meant to be included from header files.
log_target_type
Type of logging target.
Definition: logging.h:198
void log_target_destroy(struct log_target *target)
Unregister, close and delete a log target.
Definition: logging.c:757
#define DEBUGP(ss, fmt, args...)
Log a debug message through the Osmocom logging framework.
Definition: logging.h:27
void * vty
Definition: logging.h:247
#define LOG_MAX_FILTERS
Maximum number of logging filters.
Definition: logging.h:17
struct llist_head osmo_log_target_list
struct log_target * log_target_find(int type, const char *fname)
Find a registered log target.
Definition: logging.c:739
one gsmtap instance
Definition: gsmtap_util.h:23
uint8_t enabled
is logging enabled?
Definition: logging.h:113
int facility
Definition: logging.h:243
uint8_t level
logging level
Definition: gsmtap.h:117
unsigned int print_category
should log messages be prefixed with a category name?
Definition: logging.h:228
void log_add_target(struct log_target *target)
Register a new log target with the logging core.
Definition: logging.c:502
int log_filter(const struct log_context *ctx, struct log_target *target)
Log filter function.
Definition: logging.h:164
osmo_strrb-backed logging
Definition: logging.h:203
Definition: logging.h:148
int priority
Definition: logging.h:242
text file logging
Definition: logging.h:201
const char * log_vty_command_description() OSMO_DEPRECATED_OUTSIDE_LIBOSMOCORE
Generates the logging command description for VTY.
Definition: logging.c:901
void log_del_target(struct log_target *target)
Unregister a log target from the logging core.
Definition: logging.c:510
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:282
FILE * out
Definition: logging.h:237
void log_set_all_filter(struct log_target *target, int)
Enable the LOG_FLT_ALL log filter.
Definition: logging.c:550
stderr logging
Definition: logging.h:202
void log_save_filters(struct vty *vty, const struct log_info *info, const struct log_target *tgt)
Definition: logging.h:175
struct gsmtap_inst * gsmtap_inst
Definition: logging.h:255
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:171
unsigned int print_filename
should log messages be prefixed with a filename?
Definition: logging.h:226
(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:562
const char * color
color string for cateyory
Definition: logging.h:119
Definition: logging.h:145
void log_set_print_category(struct log_target *target, int)
Enable or disable printing of the category name.
Definition: logging.c:604
log_filter * filter_fn
Definition: logging.h:182
Definition: logging.h:135
int log_target_file_reopen(struct log_target *tgt)
close and re-open a log file (for log file rotation)
Definition: logging.c:783
Definition: logging.h:136
void int log_init(const struct log_info *inf, void *talloc_ctx)
Initialize the Osmocom logging core.
Definition: logging.c:965
struct log_target * log_target_create_stderr(void)
Create the STDERR log target.
Definition: logging.c:689
const char * log_level_str(unsigned int lvl) OSMO_DEPRECATED_OUTSIDE_LIBOSMOCORE
convert a numeric log level into human-readable string
Definition: logging.c:211
struct log_category * categories
logging categories
Definition: logging.h:217
uint8_t loglevel
global log level
Definition: logging.h:220
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:624
GSMTAP network logging.
Definition: logging.h:204
void log_fini(void)
Definition: logging.c:1010
int log_check_level(int subsys, unsigned int level)
Check whether a log entry will be generated.
Definition: logging.c:1025
uint8_t loglevel
configured log-level
Definition: logging.h:112
Definition: logging.h:137
struct log_target * log_target_create_file(const char *fname)
Create a new file-based log target.
Definition: logging.c:713
Logging configuration, passed to log_init.
Definition: logging.h:180
uint8_t type
see GSMTAP_TYPE_*
Definition: gsmtap.h:113
void log_parse_category_mask(struct log_target *target, const char *mask)
parse the log category mask
Definition: logging.c:243
unsigned int print_timestamp
should log messages be prefixed with a timestamp?
Definition: logging.h:224
Definition: logging.h:133
log_print_filters * print_fn
filter saving function
Definition: logging.h:194
unsigned int num_cat_user
total number of user categories (not library)
Definition: logging.h:189
const char * log_category_name(int subsys)
Definition: logging.c:299
Log context information, passed to filter.
Definition: logging.h:126
const struct log_info_cat * cat
per-category information
Definition: logging.h:185
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:71
unsigned int use_color
should color be used when printing log messages?
Definition: logging.h:222
unsigned int print_ext_timestamp
should log messages be prefixed with an extended timestamp?
Definition: logging.h:230
struct log_target * log_target_create(void)
Create a new log target skeleton.
Definition: logging.c:649
const char * hostname
Definition: logging.h:257
structure representing a logging target
Definition: logging.h:208
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:442
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:613
void log_reset_context(void)
Reset (clear) the logging context.
Definition: logging.c:516
#define LOG_MAX_CTX
Maximum number of logging contexts.
Definition: logging.h:15
uint8_t loglevel
currently selected log-level
Definition: logging.h:121
unsigned int num_cat
total number of categories
Definition: logging.h:187
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:490
int log_targets_reopen(void)
close and re-open all log files (for log file rotation)
Definition: logging.c:798
const char * description
description text
Definition: logging.h:120