mirror of https://github.com/sipwise/kamailio.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
426 lines
13 KiB
426 lines
13 KiB
/*
|
|
* Copyright (C) 2001-2003 FhG Fokus
|
|
*
|
|
* This file is part of Kamailio, a free SIP server.
|
|
*
|
|
* Kamailio is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version
|
|
*
|
|
* Kamailio is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
* @brief Kamailio core :: debug printing
|
|
* @ingroup core
|
|
* Module: @ref core
|
|
*/
|
|
|
|
#ifndef dprint_h
|
|
#define dprint_h
|
|
|
|
#include <assert.h>
|
|
#include <syslog.h>
|
|
#include <stdio.h> /* stderr, fprintf() */
|
|
|
|
#include "compiler_opt.h"
|
|
#include "cfg_core.h"
|
|
|
|
|
|
/** if defined the function name will also be logged. */
|
|
#ifdef NO_LOG_FUNC_NAME
|
|
# undef LOG_FUNC_NAME
|
|
#else
|
|
/* by default log the function name */
|
|
# define LOG_FUNC_NAME
|
|
#endif /* NO_LOG_FUNC_NAME */
|
|
|
|
/* C >= 99 has __func__, older gcc versions have __FUNCTION__ */
|
|
#if __STDC_VERSION__ < 199901L
|
|
# if __GNUC__ >= 2
|
|
# define _FUNC_NAME_ __FUNCTION__
|
|
# else
|
|
# define _FUNC_NAME_ ""
|
|
# undef LOG_FUNC_NAME
|
|
# endif
|
|
#else
|
|
# define _FUNC_NAME_ __func__
|
|
#endif
|
|
|
|
#ifdef NO_DEBUG
|
|
# ifdef MOD_NAME
|
|
# define LOC_INFO MOD_NAME ": "
|
|
# define LOG_MNAME MOD_NAME
|
|
# else
|
|
# define LOC_INFO "<core>: "
|
|
# define LOG_MNAME "core"
|
|
# endif
|
|
#else
|
|
# define XCT2STR(i) #i
|
|
# define CT2STR(l) XCT2STR(l)
|
|
#
|
|
# ifdef MOD_NAME
|
|
# define LOC_INFO MOD_NAME " [" __FILE__ ":" CT2STR(__LINE__) "]: "
|
|
# define LOG_MNAME MOD_NAME
|
|
# else
|
|
# define LOC_INFO "<core> [" __FILE__ ":" CT2STR(__LINE__) "]: "
|
|
# define LOG_MNAME "core"
|
|
# endif
|
|
#
|
|
# ifdef NO_LOG
|
|
# undef NO_LOG
|
|
# endif
|
|
#endif /* NO_DEBUG */
|
|
|
|
#define LOG_MNAME_LEN (sizeof(LOG_MNAME)-1)
|
|
|
|
/*
|
|
* Log levels
|
|
*/
|
|
#define L_NPRL -6 /* (L_MIN-1) to skip printing level prefix */
|
|
#define L_MIN -5
|
|
#define L_ALERT -5
|
|
#define L_BUG -4
|
|
#define L_CRIT2 -3 /* like L_CRIT, but adds prefix */
|
|
#define L_CRIT -2 /* no prefix added */
|
|
#define L_ERR -1
|
|
#define L_WARN 0
|
|
#define L_NOTICE 1
|
|
#define L_INFO 2
|
|
#define L_DBG 3
|
|
#define L_MAX 3
|
|
#define L_OFFSET 42 /* needs to be added and then substracted
|
|
because L_WARN may be confused with NULL pointer
|
|
(e.g. fixup_dbg_sip_msg) */
|
|
|
|
/** @brief This is the facility value used to indicate that the caller of the macro
|
|
* did not override the facility. Value 0 (the defaul) is LOG_KERN on Linux
|
|
*/
|
|
#define DEFAULT_FACILITY 0
|
|
|
|
#define LOG_LEVEL2NAME(level) (log_level_info[(level) - (L_ALERT)].name)
|
|
#define LOG2SYSLOG_LEVEL(level) \
|
|
(log_level_info[(level) - (L_ALERT)].syslog_level)
|
|
|
|
|
|
/** @brief my_pid(), process_no are from pt.h but we cannot \#include it here
|
|
because of circular dependencies */
|
|
extern int process_no;
|
|
extern int my_pid(void);
|
|
|
|
/** @brief non-zero if logging to stderr instead to the syslog */
|
|
extern int log_stderr;
|
|
|
|
extern int log_color;
|
|
extern char *log_prefix_fmt;
|
|
extern str *log_prefix_val;
|
|
extern char *_km_log_engine_type;
|
|
extern char *_km_log_engine_data;
|
|
|
|
typedef void (*km_log_f)(int, const char *, ...);
|
|
extern km_log_f _km_log_func;
|
|
|
|
void km_log_func_set(km_log_f f);
|
|
|
|
/** @brief maps log levels to their string name and corresponding syslog level */
|
|
|
|
struct log_level_info {
|
|
char *name;
|
|
int syslog_level;
|
|
};
|
|
|
|
/** @brief per process debug level handling */
|
|
int get_debug_level(char *mname, int mnlen);
|
|
int get_debug_facility(char *mname, int mnlen);
|
|
void set_local_debug_level(int level);
|
|
void set_local_debug_facility(int facility);
|
|
void reset_local_debug_level(void);
|
|
void reset_local_debug_facility(void);
|
|
typedef int (*get_module_debug_level_f)(char *mname, int mnlen, int *mlevel);
|
|
typedef int (*get_module_debug_facility_f)(char *mname, int mnlen, int *mfacility);
|
|
void set_module_debug_level_cb(get_module_debug_level_f f);
|
|
void set_module_debug_facility_cb(get_module_debug_facility_f f);
|
|
|
|
#define is_printable(level) (get_debug_level(LOG_MNAME, LOG_MNAME_LEN)>=(level))
|
|
extern struct log_level_info log_level_info[];
|
|
extern char *log_name;
|
|
|
|
#ifndef NO_SIG_DEBUG
|
|
/** @brief protection against "simultaneous" printing from signal handlers */
|
|
extern volatile int dprint_crit;
|
|
#endif
|
|
|
|
int str2facility(char *s);
|
|
char* facility2str(int fl, int *len);
|
|
|
|
int log_facility_fixup(void *handle, str *gname, str *name, void **val);
|
|
|
|
void dprint_color(int level);
|
|
void dprint_color_reset(void);
|
|
void dprint_color_update(int level, char f, char b);
|
|
void dprint_init_colors(void);
|
|
void dprint_term_color(char f, char b, str *obuf);
|
|
|
|
void log_prefix_init(void);
|
|
|
|
/** @brief
|
|
* General logging macros
|
|
*
|
|
* LOG_(level, prefix, fmt, ...) prints "printf"-formatted log message to
|
|
* stderr (if `log_stderr' is non-zero) or to syslog. Note that `fmt' must
|
|
* be constant. `prefix' is added to the beginning of the message.
|
|
*
|
|
* LOG(level, fmt, ...) is same as LOG_() with LOC_INFO prefix.
|
|
*/
|
|
#ifdef NO_LOG
|
|
|
|
# ifdef __SUNPRO_C
|
|
# define LOG__(facility, level, lname, prefix, ...)
|
|
# define LOG_(facility, level, prefix, ...)
|
|
# define LOG(level, fmt, ...)
|
|
# define LOG_FC(facility, level, ...)
|
|
# define LOG_LN(level, lname, ...)
|
|
# else
|
|
# define LOG__(facility, level, lname, prefix, fmt, args...)
|
|
# define LOG_(facility, level, prefix, fmt, args...)
|
|
# define LOG(level, fmt, args...)
|
|
# define LOG_FC(facility, level, fmt, args...)
|
|
# define LOG_LN(level, lname, fmt, args...)
|
|
# endif
|
|
|
|
#else
|
|
|
|
# ifdef NO_SIG_DEBUG
|
|
# define DPRINT_NON_CRIT (1)
|
|
# define DPRINT_CRIT_ENTER
|
|
# define DPRINT_CRIT_EXIT
|
|
# else
|
|
# define DPRINT_NON_CRIT (dprint_crit==0)
|
|
# define DPRINT_CRIT_ENTER (dprint_crit++)
|
|
# define DPRINT_CRIT_EXIT (dprint_crit--)
|
|
# endif
|
|
|
|
# ifdef __SUNPRO_C
|
|
# define LOG__(facility, level, lname, prefix, fmt, ...) \
|
|
do { \
|
|
if (get_debug_level(LOG_MNAME, LOG_MNAME_LEN) >= (level) && \
|
|
DPRINT_NON_CRIT) { \
|
|
int __llevel; \
|
|
__llevel = ((level)<L_ALERT)?L_ALERT:(((level)>L_DBG)?L_DBG:level); \
|
|
DPRINT_CRIT_ENTER; \
|
|
if (unlikely(log_stderr)) { \
|
|
if (unlikely(log_color)) dprint_color(__llevel); \
|
|
if(unlikely(log_prefix_val)) { \
|
|
fprintf(stderr, "%.*s%2d(%d) %s: %s" fmt, \
|
|
log_prefix_val->len, log_prefix_val->s, \
|
|
process_no, my_pid(), \
|
|
(lname)?(lname):LOG_LEVEL2NAME(__llevel), \
|
|
(prefix) , __VA_ARGS__);\
|
|
} else { \
|
|
fprintf(stderr, "%2d(%d) %s: %s" fmt, \
|
|
process_no, my_pid(), \
|
|
(lname)?(lname):LOG_LEVEL2NAME(__llevel), \
|
|
(prefix) , __VA_ARGS__);\
|
|
} \
|
|
if (unlikely(log_color)) dprint_color_reset(); \
|
|
} else { \
|
|
if(unlikely(log_prefix_val)) { \
|
|
_km_log_func(LOG2SYSLOG_LEVEL(__llevel) |\
|
|
(((facility) != DEFAULT_FACILITY) ? \
|
|
(facility) : \
|
|
get_debug_facility(LOG_MNAME, LOG_MNAME_LEN)), \
|
|
"%.*s%s: %s" fmt,\
|
|
log_prefix_val->len, log_prefix_val->s, \
|
|
(lname)?(lname):LOG_LEVEL2NAME(__llevel),\
|
|
(prefix) , __VA_ARGS__); \
|
|
} else { \
|
|
_km_log_func(LOG2SYSLOG_LEVEL(__llevel) |\
|
|
(((facility) != DEFAULT_FACILITY) ? \
|
|
(facility) : \
|
|
get_debug_facility(LOG_MNAME, LOG_MNAME_LEN)), \
|
|
"%s: %s" fmt,\
|
|
(lname)?(lname):LOG_LEVEL2NAME(__llevel),\
|
|
(prefix) , __VA_ARGS__); \
|
|
} \
|
|
} \
|
|
DPRINT_CRIT_EXIT; \
|
|
} \
|
|
} while(0)
|
|
|
|
# define LOG_(facility, level, ...) \
|
|
LOG__(facility, level, NULL, __VA_ARGS__, NULL)
|
|
|
|
# ifdef LOG_FUNC_NAME
|
|
# define LOG(level, ...) \
|
|
_LOG(level, __VA_ARGS__, NULL)
|
|
# define _LOG(level, fmt, ...) \
|
|
LOG_(DEFAULT_FACILITY, (level), LOC_INFO, "%s(): " fmt,\
|
|
_FUNC_NAME_, __VA_ARGS__)
|
|
|
|
# define LOG_FC(facility, level, ...) \
|
|
_LOG_FC(facility, level, __VA_ARGS__, NULL)
|
|
# define _LOG_FC(facility, level, fmt, ...) \
|
|
LOG_((facility), (level), LOC_INFO, "%s(): " fmt , _FUNC_NAME_, __VA_ARGS__)
|
|
|
|
# define LOG_LN(level, lname, ...) \
|
|
_LOG_LN(level, lname, __VA_ARGS__, NULL)
|
|
# define _LOG_LN(level, lname, fmt, ...) \
|
|
LOG__(DEFAULT_FACILITY, (level), (lname), LOC_INFO, "%s(): " fmt,\
|
|
_FUNC_NAME_, __VA_ARGS__)
|
|
|
|
# else /* LOG_FUNC_NAME */
|
|
# define LOG(level, ...) \
|
|
LOG_(DEFAULT_FACILITY, (level), LOC_INFO, __VA_ARGS__, NULL)
|
|
# define LOG_FC(facility, level, ...) \
|
|
LOG_((facility), (level), LOC_INFO, __VA_ARGS__, NULL)
|
|
# define LOG_LN(level, lname, ...) \
|
|
LOG__(DEFAULT_FACILITY, (level), (lname), LOC_INFO, __VA_ARGS__, NULL)
|
|
|
|
# endif /* LOG_FUNC_NAME */
|
|
|
|
# else /* ! __SUNPRO_C */
|
|
# define LOG__(facility, level, lname, prefix, fmt, args...) \
|
|
do { \
|
|
if (get_debug_level(LOG_MNAME, LOG_MNAME_LEN) >= (level) && \
|
|
DPRINT_NON_CRIT) { \
|
|
int __llevel; \
|
|
__llevel = ((level)<L_ALERT)?L_ALERT:(((level)>L_DBG)?L_DBG:level); \
|
|
DPRINT_CRIT_ENTER; \
|
|
if (unlikely(log_stderr)) { \
|
|
if (unlikely(log_color)) dprint_color(__llevel); \
|
|
if(unlikely(log_prefix_val)) { \
|
|
fprintf(stderr, "%.*s%2d(%d) %s: %s" fmt, \
|
|
log_prefix_val->len, log_prefix_val->s, \
|
|
process_no, my_pid(), \
|
|
(lname)?(lname):LOG_LEVEL2NAME(__llevel), \
|
|
(prefix) , ## args);\
|
|
} else { \
|
|
fprintf(stderr, "%2d(%d) %s: %s" fmt, \
|
|
process_no, my_pid(), \
|
|
(lname)?(lname):LOG_LEVEL2NAME(__llevel), \
|
|
(prefix) , ## args);\
|
|
} \
|
|
if (unlikely(log_color)) dprint_color_reset(); \
|
|
} else { \
|
|
if(unlikely(log_prefix_val)) { \
|
|
_km_log_func(LOG2SYSLOG_LEVEL(__llevel) |\
|
|
(((facility) != DEFAULT_FACILITY) ? \
|
|
(facility) : \
|
|
get_debug_facility(LOG_MNAME, LOG_MNAME_LEN)), \
|
|
"%.*s%s: %s" fmt,\
|
|
log_prefix_val->len, log_prefix_val->s, \
|
|
(lname)?(lname):LOG_LEVEL2NAME(__llevel),\
|
|
(prefix) , ## args); \
|
|
} else { \
|
|
_km_log_func(LOG2SYSLOG_LEVEL(__llevel) |\
|
|
(((facility) != DEFAULT_FACILITY) ? \
|
|
(facility) : \
|
|
get_debug_facility(LOG_MNAME, LOG_MNAME_LEN)), \
|
|
"%s: %s" fmt,\
|
|
(lname)?(lname):LOG_LEVEL2NAME(__llevel),\
|
|
(prefix) , ## args); \
|
|
} \
|
|
} \
|
|
DPRINT_CRIT_EXIT; \
|
|
} \
|
|
} while(0)
|
|
|
|
# define LOG_(facility, level, prefix, fmt, args...) \
|
|
LOG__(facility, level, NULL, prefix, fmt, ## args)
|
|
|
|
# ifdef LOG_FUNC_NAME
|
|
# define LOG(level, fmt, args...) \
|
|
LOG_(DEFAULT_FACILITY, (level), LOC_INFO, "%s(): " fmt ,\
|
|
_FUNC_NAME_, ## args)
|
|
|
|
# define LOG_FC(facility, level, fmt, args...) \
|
|
LOG_((facility), (level), LOC_INFO, "%s(): " fmt , _FUNC_NAME_, ## args)
|
|
|
|
# define LOG_LN(level, lname, fmt, args...) \
|
|
LOG__(DEFAULT_FACILITY, (level), (lname), LOC_INFO, "%s(): " fmt ,\
|
|
_FUNC_NAME_, ## args)
|
|
|
|
# else /* LOG_FUNC_NAME */
|
|
# define LOG(level, fmt, args...) \
|
|
LOG_(DEFAULT_FACILITY, (level), LOC_INFO, fmt , ## args)
|
|
# define LOG_FC(facility, level, fmt, args...) \
|
|
LOG_((facility), (level), LOC_INFO, fmt , ## args)
|
|
# define LOG_LN(level, lname, fmt, args...) \
|
|
LOG__(DEFAULT_FACILITY, (level), (lname), LOC_INFO, fmt , ## args)
|
|
|
|
# endif /* LOG_FUNC_NAME */
|
|
# endif /* __SUNPRO_C */
|
|
#endif /* NO_LOG */
|
|
|
|
|
|
/** @name SimpleLog
|
|
* Simplier, prefered logging macros for constant log level
|
|
*/
|
|
/*@ { */
|
|
#ifdef __SUNPRO_C
|
|
# define NPRL(...) LOG(L_NPRL, __VA_ARGS__)
|
|
# define ALERT(...) LOG(L_ALERT, __VA_ARGS__)
|
|
# define BUG(...) LOG(L_BUG, __VA_ARGS__)
|
|
# define ERR(...) LOG(L_ERR, __VA_ARGS__)
|
|
# define WARN(...) LOG(L_WARN, __VA_ARGS__)
|
|
# define NOTICE(...) LOG(L_NOTICE, __VA_ARGS__)
|
|
# define INFO(...) LOG(L_INFO, __VA_ARGS__)
|
|
# define CRIT(...) LOG(L_CRIT2, __VA_ARGS__)
|
|
|
|
# ifdef NO_DEBUG
|
|
# define DBG(...)
|
|
# else
|
|
# define DBG(...) LOG(L_DBG, __VA_ARGS__)
|
|
# endif
|
|
/*@ } */
|
|
|
|
/* obsolete, do not use */
|
|
# define DEBUG(...) DBG(__VA_ARGS__)
|
|
|
|
#else /* ! __SUNPRO_C */
|
|
# define NPRL(fmt, args...) LOG(L_NPRL, fmt , ## args)
|
|
# define ALERT(fmt, args...) LOG(L_ALERT, fmt , ## args)
|
|
# define BUG(fmt, args...) LOG(L_BUG, fmt , ## args)
|
|
# define ERR(fmt, args...) LOG(L_ERR, fmt , ## args)
|
|
# define WARN(fmt, args...) LOG(L_WARN, fmt , ## args)
|
|
# define NOTICE(fmt, args...) LOG(L_NOTICE, fmt , ## args)
|
|
# define INFO(fmt, args...) LOG(L_INFO, fmt , ## args)
|
|
# define CRIT(fmt, args...) LOG(L_CRIT2, fmt , ## args)
|
|
|
|
# ifdef NO_DEBUG
|
|
# define DBG(fmt, args...)
|
|
# else
|
|
# define DBG(fmt, args...) LOG(L_DBG, fmt , ## args)
|
|
# endif
|
|
|
|
/* obsolete, do not use */
|
|
# define DEBUG(fmt, args...) DBG(fmt , ## args)
|
|
|
|
#endif /* __SUNPRO_C */
|
|
|
|
|
|
/* kamailio/openser compatibility */
|
|
|
|
#define LM_GEN1 LOG
|
|
#define LM_GEN2 LOG_FC
|
|
#define LM_NPRL NPRL
|
|
#define LM_ALERT ALERT
|
|
#define LM_CRIT CRIT
|
|
#define LM_BUG BUG
|
|
#define LM_ERR ERR
|
|
#define LM_WARN WARN
|
|
#define LM_NOTICE NOTICE
|
|
#define LM_INFO INFO
|
|
#define LM_DBG DEBUG
|
|
|
|
#endif /* !dprint_h */
|