blob: 0caec28316ad85b3fdae7177f84991cf4a110160 [file] [log] [blame]
Harald Welte4a2bb9e2010-03-26 09:33:40 +08001#ifndef _OSMOCORE_DEBUG_H
2#define _OSMOCORE_DEBUG_H
3
4#include <stdio.h>
5#include <stdint.h>
6#include <osmocore/linuxlist.h>
7
8#define DEBUG_MAX_CATEGORY 32
9#define DEBUG_MAX_CTX 8
10#define DEBUG_MAX_FILTERS 8
11
12#define DEBUG
13
14#ifdef DEBUG
15#define DEBUGP(ss, fmt, args...) debugp(ss, __FILE__, __LINE__, 0, fmt, ## args)
16#define DEBUGPC(ss, fmt, args...) debugp(ss, __FILE__, __LINE__, 1, fmt, ## args)
17#else
18#define DEBUGP(xss, fmt, args...)
19#define DEBUGPC(ss, fmt, args...)
20#endif
21
22#define static_assert(exp, name) typedef int dummy##name [(exp) ? 1 : -1];
23
24char *hexdump(const unsigned char *buf, int len);
25void debugp(unsigned int subsys, char *file, int line, int cont, const char *format, ...) __attribute__ ((format (printf, 5, 6)));
26
27/* new logging interface */
28#define LOGP(ss, level, fmt, args...) \
29 debugp2(ss, level, __FILE__, __LINE__, 0, fmt, ##args)
30#define LOGPC(ss, level, fmt, args...) \
31 debugp2(ss, level, __FILE__, __LINE__, 1, fmt, ##args)
32
33/* different levels */
34#define LOGL_DEBUG 1 /* debugging information */
35#define LOGL_INFO 3
36#define LOGL_NOTICE 5 /* abnormal/unexpected condition */
37#define LOGL_ERROR 7 /* error condition, requires user action */
38#define LOGL_FATAL 8 /* fatal, program aborted */
39
40#define DEBUG_FILTER_ALL 0x0001
41
42struct debug_category {
43 uint8_t loglevel;
44 uint8_t enabled;
45};
46
47struct debug_info_cat {
48 const char *name;
49 const char *color;
50 const char *description;
Harald Welte4a2bb9e2010-03-26 09:33:40 +080051 uint8_t loglevel;
52 uint8_t enabled;
53};
54
55/* debug context information, passed to filter */
56struct debug_context {
57 void *ctx[DEBUG_MAX_CTX+1];
58};
59
60struct debug_target;
61
62typedef int debug_filter(const struct debug_context *ctx,
63 struct debug_target *target);
64
65struct debug_info {
66 /* filter callback function */
67 debug_filter *filter_fn;
68
69 /* per-category information */
70 const struct debug_info_cat *cat;
71 unsigned int num_cat;
72};
73
74struct debug_target {
75 struct llist_head entry;
76
77 int filter_map;
78 void *filter_data[DEBUG_MAX_FILTERS+1];
79
80 struct debug_category categories[DEBUG_MAX_CATEGORY+1];
81 uint8_t loglevel;
82 int use_color:1;
83 int print_timestamp:1;
84
85 union {
86 struct {
87 FILE *out;
88 } tgt_stdout;
89
90 struct {
91 int priority;
92 } tgt_syslog;
93
94 struct {
95 void *vty;
96 } tgt_vty;
97 };
98
99 void (*output) (struct debug_target *target, const char *string);
100};
101
102/* use the above macros */
103void debugp2(unsigned int subsys, unsigned int level, char *file,
104 int line, int cont, const char *format, ...)
105 __attribute__ ((format (printf, 6, 7)));
106void debug_init(const struct debug_info *cat);
107
108/* context management */
109void debug_reset_context(void);
110int debug_set_context(uint8_t ctx, void *value);
111
112/* filter on the targets */
113void debug_set_all_filter(struct debug_target *target, int);
114
115void debug_set_use_color(struct debug_target *target, int);
116void debug_set_print_timestamp(struct debug_target *target, int);
117void debug_set_log_level(struct debug_target *target, int log_level);
118void debug_parse_category_mask(struct debug_target *target, const char* mask);
119int debug_parse_level(const char *lvl);
120int debug_parse_category(const char *category);
121void debug_set_category_filter(struct debug_target *target, int category,
122 int enable, int level);
123
124/* management of the targets */
125struct debug_target *debug_target_create(void);
126struct debug_target *debug_target_create_stderr(void);
127void debug_add_target(struct debug_target *target);
128void debug_del_target(struct debug_target *target);
129
130#endif /* _OSMOCORE_DEBUG_H */