move log/debug codebase to libosmocore
The logging/debugging code is generic enough to move it into libosmocore
while keeping OpenBSC specific definitions in openbsc itself.
This commit uses the logging support present in libosmocore-0.1.2,
you will have to update your library to this version.
diff --git a/openbsc/src/debug.c b/openbsc/src/debug.c
index 8f7a1c3..5355bf4 100644
--- a/openbsc/src/debug.c
+++ b/openbsc/src/debug.c
@@ -1,5 +1,6 @@
-/* Debugging/Logging support code */
-/* (C) 2008 by Harald Welte <laforge@gnumonks.org>
+/* OpenBSC Debugging/Logging support code */
+
+/* (C) 2008-2010 by Harald Welte <laforge@gnumonks.org>
* (C) 2008 by Holger Hans Peter Freyther <zecke@selfish.org>
* All Rights Reserved
*
@@ -27,401 +28,160 @@
#include <time.h>
#include <errno.h>
-#include <openbsc/debug.h>
#include <osmocore/talloc.h>
#include <osmocore/utils.h>
+#include <osmocore/logging.h>
#include <openbsc/gsm_data.h>
#include <openbsc/gsm_subscriber.h>
+#include <openbsc/debug.h>
/* default categories */
-static struct debug_category default_categories[Debug_LastEntry] = {
- [DRLL] = { .enabled = 1, .loglevel = LOGL_NOTICE },
- [DCC] = { .enabled = 1, .loglevel = LOGL_NOTICE },
- [DNM] = { .enabled = 1, .loglevel = LOGL_NOTICE },
- [DRR] = { .enabled = 1, .loglevel = LOGL_NOTICE },
- [DRSL] = { .enabled = 1, .loglevel = LOGL_NOTICE },
- [DMM] = { .enabled = 1, .loglevel = LOGL_INFO },
- [DMNCC] = { .enabled = 1, .loglevel = LOGL_NOTICE },
- [DSMS] = { .enabled = 1, .loglevel = LOGL_NOTICE },
- [DPAG] = { .enabled = 1, .loglevel = LOGL_NOTICE },
- [DMEAS] = { .enabled = 0, .loglevel = LOGL_NOTICE },
- [DMI] = { .enabled = 0, .loglevel = LOGL_NOTICE },
- [DMIB] = { .enabled = 0, .loglevel = LOGL_NOTICE },
- [DMUX] = { .enabled = 1, .loglevel = LOGL_NOTICE },
- [DINP] = { .enabled = 1, .loglevel = LOGL_NOTICE },
- [DSCCP] = { .enabled = 1, .loglevel = LOGL_NOTICE },
- [DMSC] = { .enabled = 1, .loglevel = LOGL_NOTICE },
- [DMGCP] = { .enabled = 1, .loglevel = LOGL_NOTICE },
- [DHO] = { .enabled = 1, .loglevel = LOGL_NOTICE },
- [DDB] = { .enabled = 1, .loglevel = LOGL_NOTICE },
- [DREF] = { .enabled = 0, .loglevel = LOGL_NOTICE },
+static const struct log_info_cat default_categories[] = {
+ [DRLL] = {
+ .name = "DRLL",
+ .description = "Radio Link Layer",
+ .color = "\033[1;31m",
+ .enabled = 1, .loglevel = LOGL_NOTICE,
+ },
+ [DCC] = {
+ .name = "DCC",
+ .description = "Call Control",
+ .color = "\033[1;32m",
+ .enabled = 1, .loglevel = LOGL_NOTICE,
+ },
+ [DMM] = {
+ .name = "DMM",
+ .description = "Mobility Management",
+ .color = "\033[1;33m",
+ .enabled = 1, .loglevel = LOGL_NOTICE,
+ },
+ [DRR] = {
+ .name = "DRR",
+ .description = "Radio Resource",
+ .color = "\033[1;34m",
+ .enabled = 1, .loglevel = LOGL_NOTICE,
+ },
+ [DRSL] = {
+ .name = "DRSL",
+ .description = "Radio Siganlling Link",
+ .color = "\033[1;35m",
+ .enabled = 1, .loglevel = LOGL_NOTICE,
+ },
+ [DNM] = {
+ .name = "DNM",
+ .description = "Network Management (OML)",
+ .color = "\033[1;36m",
+ .enabled = 1, .loglevel = LOGL_INFO,
+ },
+ [DMNCC] = {
+ .name = "DMNCC",
+ .description = "BSC<->MSC interface",
+ .color = "\033[1;39m",
+ .enabled = 1, .loglevel = LOGL_NOTICE,
+ },
+ [DSMS] = {
+ .name = "DSMS",
+ .description = "Short Message Service",
+ .color = "\033[1;37m",
+ .enabled = 1, .loglevel = LOGL_NOTICE,
+ },
+ [DPAG] = {
+ .name = "DPAG",
+ .description = "Paging",
+ .color = "\033[1;38m",
+ .enabled = 1, .loglevel = LOGL_NOTICE,
+ },
+ [DMEAS] = {
+ .name = "DMEAS",
+ .description = "Measurement Processing",
+ .enabled = 0, .loglevel = LOGL_NOTICE,
+ },
+ [DMI] = {
+ .name = "DMI",
+ .description = "mISDN Input Driver",
+ .enabled = 0, .loglevel = LOGL_NOTICE,
+ },
+ [DMIB] = {
+ .name = "DMIB",
+ .description = "mISDN B-Channels",
+ .enabled = 0, .loglevel = LOGL_NOTICE,
+ },
+ [DMUX] = {
+ .name = "DMUX",
+ .description = "TRAU Frame Multiplex",
+ .enabled = 1, .loglevel = LOGL_NOTICE,
+ },
+ [DINP] = {
+ .name = "DINP",
+ .description = "Input Driver",
+ .enabled = 1, .loglevel = LOGL_NOTICE,
+ },
+ [DSCCP] = {
+ .name = "DSCCP",
+ .description = "SCCP Protocol",
+ .enabled = 1, .loglevel = LOGL_NOTICE,
+ },
+ [DMSC] = {
+ .name = "DMSC",
+ .description = "Mobile Switching Center",
+ .enabled = 1, .loglevel = LOGL_NOTICE,
+ },
+ [DMGCP] = {
+ .name = "DMGCP",
+ .description = "Media Gateway Control Protocol",
+ .enabled = 1, .loglevel = LOGL_NOTICE,
+ },
+ [DHO] = {
+ .name = "DHO",
+ .description = "Hand-Over",
+ .enabled = 1, .loglevel = LOGL_NOTICE,
+ },
+ [DDB] = {
+ .name = "DDB",
+ .description = "Database",
+ .enabled = 1, .loglevel = LOGL_NOTICE,
+ },
+ [DREF] = {
+ .name = "DREF",
+ .description = "Reference Counting",
+ .enabled = 0, .loglevel = LOGL_NOTICE,
+ },
};
-struct debug_info {
- const char *name;
- const char *color;
- const char *description;
- int number;
- int position;
+enum log_ctxt {
+ CTX_SUBSCRIBER,
};
-struct debug_context {
- struct gsm_lchan *lchan;
- struct gsm_subscriber *subscr;
- struct gsm_bts *bts;
+enum log_filter {
+ FLT_IMSI,
};
-static struct debug_context debug_context;
-static void *tall_dbg_ctx = NULL;
-static LLIST_HEAD(target_list);
+static int filter_fn(const struct log_context *ctx,
+ struct log_target *tar)
+{
+ struct gsm_subscriber *subscr = ctx->ctx[CTX_SUBSCRIBER];
-#define DEBUG_CATEGORY(NUMBER, NAME, COLOR, DESCRIPTION) \
- { .name = NAME, .color = COLOR, .description = DESCRIPTION, .number = NUMBER },
+ if ((tar->filter_map & (1 << FLT_IMSI)) != 0
+ && subscr && strcmp(subscr->imsi, tar->filter_data[FLT_IMSI]) == 0)
+ return 1;
-static const struct debug_info debug_info[] = {
- DEBUG_CATEGORY(DRLL, "DRLL", "\033[1;31m", "")
- DEBUG_CATEGORY(DCC, "DCC", "\033[1;32m", "")
- DEBUG_CATEGORY(DMM, "DMM", "\033[1;33m", "")
- DEBUG_CATEGORY(DRR, "DRR", "\033[1;34m", "")
- DEBUG_CATEGORY(DRSL, "DRSL", "\033[1;35m", "")
- DEBUG_CATEGORY(DNM, "DNM", "\033[1;36m", "")
- DEBUG_CATEGORY(DSMS, "DSMS", "\033[1;37m", "")
- DEBUG_CATEGORY(DPAG, "DPAG", "\033[1;38m", "")
- DEBUG_CATEGORY(DMNCC, "DMNCC","\033[1;39m", "")
- DEBUG_CATEGORY(DINP, "DINP", "", "")
- DEBUG_CATEGORY(DMI, "DMI", "", "")
- DEBUG_CATEGORY(DMIB, "DMIB", "", "")
- DEBUG_CATEGORY(DMUX, "DMUX", "", "")
- DEBUG_CATEGORY(DMEAS, "DMEAS", "", "")
- DEBUG_CATEGORY(DSCCP, "DSCCP", "", "")
- DEBUG_CATEGORY(DMSC, "DMSC", "", "")
- DEBUG_CATEGORY(DMGCP, "DMGCP", "", "")
- DEBUG_CATEGORY(DHO, "DHO", "", "")
- DEBUG_CATEGORY(DDB, "DDB", "", "")
- DEBUG_CATEGORY(DREF, "DREF", "", "")
+ return 0;
+}
+
+const struct log_info log_info = {
+ .filter_fn = filter_fn,
+ .cat = default_categories,
+ .num_cat = ARRAY_SIZE(default_categories),
};
-static const struct value_string loglevel_strs[] = {
- { 0, "EVERYTHING" },
- { 1, "DEBUG" },
- { 3, "INFO" },
- { 5, "NOTICE" },
- { 7, "ERROR" },
- { 8, "FATAL" },
- { 0, NULL },
-};
-
-int debug_parse_level(const char *lvl)
-{
- return get_string_value(loglevel_strs, lvl);
-}
-
-int debug_parse_category(const char *category)
-{
- int i;
-
- for (i = 0; i < ARRAY_SIZE(debug_info); ++i) {
- if (!strcasecmp(debug_info[i].name+1, category))
- return debug_info[i].number;
- }
-
- return -EINVAL;
-}
-
-/*
- * Parse the category mask.
- * The format can be this: category1:category2:category3
- * or category1,2:category2,3:...
- */
-void debug_parse_category_mask(struct debug_target* target, const char *_mask)
-{
- int i = 0;
- char *mask = strdup(_mask);
- char *category_token = NULL;
-
- /* Disable everything to enable it afterwards */
- for (i = 0; i < ARRAY_SIZE(target->categories); ++i)
- target->categories[i].enabled = 0;
-
- category_token = strtok(mask, ":");
- do {
- for (i = 0; i < ARRAY_SIZE(debug_info); ++i) {
- char* colon = strstr(category_token, ",");
- int length = strlen(category_token);
-
- if (colon)
- length = colon - category_token;
-
- if (strncasecmp(debug_info[i].name, category_token, length) == 0) {
- int number = debug_info[i].number;
- int level = 0;
-
- if (colon)
- level = atoi(colon+1);
-
- target->categories[number].enabled = 1;
- target->categories[number].loglevel = level;
- }
- }
- } while ((category_token = strtok(NULL, ":")));
-
- free(mask);
-}
-
-static const char* color(int subsys)
-{
- int i = 0;
-
- for (i = 0; i < ARRAY_SIZE(debug_info); ++i) {
- if (debug_info[i].number == subsys)
- return debug_info[i].color;
- }
-
- return "";
-}
-
-static void _output(struct debug_target *target, unsigned int subsys, char *file, int line,
- int cont, const char *format, va_list ap)
-{
- char col[30];
- char sub[30];
- char tim[30];
- char buf[4096];
- char final[4096];
-
- /* prepare the data */
- col[0] = '\0';
- sub[0] = '\0';
- tim[0] = '\0';
- buf[0] = '\0';
-
- /* are we using color */
- if (target->use_color) {
- snprintf(col, sizeof(col), "%s", color(subsys));
- col[sizeof(col)-1] = '\0';
- }
- vsnprintf(buf, sizeof(buf), format, ap);
- buf[sizeof(buf)-1] = '\0';
-
- if (!cont) {
- if (target->print_timestamp) {
- char *timestr;
- time_t tm;
- tm = time(NULL);
- timestr = ctime(&tm);
- timestr[strlen(timestr)-1] = '\0';
- snprintf(tim, sizeof(tim), "%s ", timestr);
- tim[sizeof(tim)-1] = '\0';
- }
- snprintf(sub, sizeof(sub), "<%4.4x> %s:%d ", subsys, file, line);
- sub[sizeof(sub)-1] = '\0';
- }
-
- snprintf(final, sizeof(final), "%s%s%s%s\033[0;m", col, tim, sub, buf);
- final[sizeof(final)-1] = '\0';
- target->output(target, final);
-}
-
-
-static void _debugp(unsigned int subsys, int level, char *file, int line,
- int cont, const char *format, va_list ap)
-{
- struct debug_target *tar;
-
- llist_for_each_entry(tar, &target_list, entry) {
- struct debug_category *category;
- int output = 0;
-
- category = &tar->categories[subsys];
- /* subsystem is not supposed to be debugged */
- if (!category->enabled)
- continue;
-
- /* Check the global log level */
- if (tar->loglevel != 0 && level < tar->loglevel)
- continue;
-
- /* Check the category log level */
- if (tar->loglevel == 0 && category->loglevel != 0 && level < category->loglevel)
- continue;
-
- /*
- * Apply filters here... if that becomes messy we will need to put
- * filters in a list and each filter will say stop, continue, output
- */
- if ((tar->filter_map & DEBUG_FILTER_ALL) != 0) {
- output = 1;
- } else if ((tar->filter_map & DEBUG_FILTER_IMSI) != 0
- && debug_context.subscr && strcmp(debug_context.subscr->imsi, tar->imsi_filter) == 0) {
- output = 1;
- }
-
- if (output) {
- /* FIXME: copying the va_list is an ugly workaround against a bug
- * hidden somewhere in _output. If we do not copy here, the first
- * call to _output() will corrupt the va_list contents, and any
- * further _output() calls with the same va_list will segfault */
- va_list bp;
- va_copy(bp, ap);
- _output(tar, subsys, file, line, cont, format, bp);
- va_end(bp);
- }
- }
-}
-
-void debugp(unsigned int subsys, char *file, int line, int cont, const char *format, ...)
-{
- va_list ap;
-
- va_start(ap, format);
- _debugp(subsys, LOGL_DEBUG, file, line, cont, format, ap);
- va_end(ap);
-}
-
-void debugp2(unsigned int subsys, unsigned int level, char *file, int line, int cont, const char *format, ...)
-{
- va_list ap;
-
- va_start(ap, format);
- _debugp(subsys, level, file, line, cont, format, ap);
- va_end(ap);
-}
-
-static char hexd_buff[4096];
-
-char *hexdump(const unsigned char *buf, int len)
-{
- int i;
- char *cur = hexd_buff;
-
- hexd_buff[0] = 0;
- for (i = 0; i < len; i++) {
- int len_remain = sizeof(hexd_buff) - (cur - hexd_buff);
- int rc = snprintf(cur, len_remain, "%02x ", buf[i]);
- if (rc <= 0)
- break;
- cur += rc;
- }
- hexd_buff[sizeof(hexd_buff)-1] = 0;
- return hexd_buff;
-}
-
-
-
-void debug_add_target(struct debug_target *target)
-{
- llist_add_tail(&target->entry, &target_list);
-}
-
-void debug_del_target(struct debug_target *target)
-{
- llist_del(&target->entry);
-}
-
-void debug_reset_context(void)
-{
- memset(&debug_context, 0, sizeof(debug_context));
-}
-
-/* currently we are not reffing these */
-void debug_set_context(int ctx, void *value)
-{
- switch (ctx) {
- case BSC_CTX_LCHAN:
- debug_context.lchan = (struct gsm_lchan *) value;
- break;
- case BSC_CTX_SUBSCR:
- debug_context.subscr = (struct gsm_subscriber *) value;
- break;
- case BSC_CTX_BTS:
- debug_context.bts = (struct gsm_bts *) value;
- break;
- case BSC_CTX_SCCP:
- break;
- default:
- break;
- }
-}
-
-void debug_set_imsi_filter(struct debug_target *target, const char *imsi)
+void log_set_imsi_filter(struct log_target *target, const char *imsi)
{
if (imsi) {
- target->filter_map |= DEBUG_FILTER_IMSI;
- target->imsi_filter = talloc_strdup(target, imsi);
- } else if (target->imsi_filter) {
- target->filter_map &= ~DEBUG_FILTER_IMSI;
- talloc_free(target->imsi_filter);
- target->imsi_filter = NULL;
+ target->filter_map |= (1 << FLT_IMSI);
+ target->filter_data[FLT_IMSI] = talloc_strdup(target, imsi);
+ } else if (target->filter_data[FLT_IMSI]) {
+ target->filter_map &= ~(1 << FLT_IMSI);
+ talloc_free(target->filter_data[FLT_IMSI]);
+ target->filter_data[FLT_IMSI] = NULL;
}
}
-
-void debug_set_all_filter(struct debug_target *target, int all)
-{
- if (all)
- target->filter_map |= DEBUG_FILTER_ALL;
- else
- target->filter_map &= ~DEBUG_FILTER_ALL;
-}
-
-void debug_set_use_color(struct debug_target *target, int use_color)
-{
- target->use_color = use_color;
-}
-
-void debug_set_print_timestamp(struct debug_target *target, int print_timestamp)
-{
- target->print_timestamp = print_timestamp;
-}
-
-void debug_set_log_level(struct debug_target *target, int log_level)
-{
- target->loglevel = log_level;
-}
-
-void debug_set_category_filter(struct debug_target *target, int category, int enable, int level)
-{
- if (category >= Debug_LastEntry)
- return;
- target->categories[category].enabled = !!enable;
- target->categories[category].loglevel = level;
-}
-
-static void _stderr_output(struct debug_target *target, const char *log)
-{
- fprintf(target->tgt_stdout.out, "%s", log);
- fflush(target->tgt_stdout.out);
-}
-
-struct debug_target *debug_target_create(void)
-{
- struct debug_target *target;
-
- target = talloc_zero(tall_dbg_ctx, struct debug_target);
- if (!target)
- return NULL;
-
- INIT_LLIST_HEAD(&target->entry);
- memcpy(target->categories, default_categories, sizeof(default_categories));
- target->use_color = 1;
- target->print_timestamp = 0;
- target->loglevel = 0;
- return target;
-}
-
-struct debug_target *debug_target_create_stderr(void)
-{
- struct debug_target *target;
-
- target = debug_target_create();
- if (!target)
- return NULL;
-
- target->tgt_stdout.out = stderr;
- target->output = _stderr_output;
- return target;
-}
-
-void debug_init(void)
-{
- tall_dbg_ctx = talloc_named_const(NULL, 1, "debug");
-}