ASTERISK_REGISTER_FILE no longer has any purpose so this commit removes all traces of it. Previously exported symbols removed: * __ast_register_file * __ast_unregister_file * ast_complete_source_filename This also removes the mtx_prof static variable that was declared when MTX_PROFILE was enabled. This variable was only used in lock.c so it is now initialized in that file only. ASTERISK-26480 #close Change-Id: I1074af07d71f9e159c48ef36631aa432c86f9966
454 lines
13 KiB
C
454 lines
13 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 2013, Digium, Inc.
|
|
*
|
|
* David M. Lee, II <dlee@digium.com>
|
|
*
|
|
* See http://www.asterisk.org for more information about
|
|
* the Asterisk project. Please do not directly contact
|
|
* any of the maintainers of this project for assistance;
|
|
* the project provides a web site, mailing lists and IRC
|
|
* channels for your use.
|
|
*
|
|
* This program is free software, distributed under the terms of
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
* at the top of the source tree.
|
|
*/
|
|
|
|
/*! \file
|
|
*
|
|
* \brief Bridge PJPROJECT logging to Asterisk logging.
|
|
* \author David M. Lee, II <dlee@digium.com>
|
|
*
|
|
* PJPROJECT logging doesn't exactly match Asterisk logging, but mapping the two is
|
|
* not too bad. PJPROJECT log levels are identified by a single int. Limits are
|
|
* not specified by PJPROJECT, but their implementation used 1 through 6.
|
|
*
|
|
* The mapping is as follows:
|
|
* - 0: LOG_ERROR
|
|
* - 1: LOG_ERROR
|
|
* - 2: LOG_WARNING
|
|
* - 3 and above: equivalent to ast_debug(level, ...) for res_pjproject.so
|
|
*/
|
|
|
|
/*** MODULEINFO
|
|
<depend>pjproject</depend>
|
|
<support_level>core</support_level>
|
|
***/
|
|
|
|
/*** DOCUMENTATION
|
|
<configInfo name="res_pjproject" language="en_US">
|
|
<synopsis>pjproject common configuration</synopsis>
|
|
<configFile name="pjproject.conf">
|
|
<configObject name="log_mappings">
|
|
<synopsis>PJPROJECT to Asterisk Log Level Mapping</synopsis>
|
|
<description><para>Warnings and errors in the pjproject libraries are generally handled
|
|
by Asterisk. In many cases, Asterisk wouldn't even consider them to
|
|
be warnings or errors so the messages emitted by pjproject directly
|
|
are either superfluous or misleading. The 'log_mappings'
|
|
object allows mapping the pjproject levels to Asterisk levels, or nothing.
|
|
</para>
|
|
<note><para>The id of this object, as well as its type, must be
|
|
'log_mappings' or it won't be found.</para></note>
|
|
</description>
|
|
<configOption name="type">
|
|
<synopsis>Must be of type 'log_mappings'.</synopsis>
|
|
</configOption>
|
|
<configOption name="asterisk_error" default="0,1">
|
|
<synopsis>A comma separated list of pjproject log levels to map to Asterisk LOG_ERROR.</synopsis>
|
|
</configOption>
|
|
<configOption name="asterisk_warning" default="2">
|
|
<synopsis>A comma separated list of pjproject log levels to map to Asterisk LOG_WARNING.</synopsis>
|
|
</configOption>
|
|
<configOption name="asterisk_notice" default="">
|
|
<synopsis>A comma separated list of pjproject log levels to map to Asterisk LOG_NOTICE.</synopsis>
|
|
</configOption>
|
|
<configOption name="asterisk_debug" default="3,4,5">
|
|
<synopsis>A comma separated list of pjproject log levels to map to Asterisk LOG_DEBUG.</synopsis>
|
|
</configOption>
|
|
<configOption name="asterisk_verbose" default="">
|
|
<synopsis>A comma separated list of pjproject log levels to map to Asterisk LOG_VERBOSE.</synopsis>
|
|
</configOption>
|
|
</configObject>
|
|
</configFile>
|
|
</configInfo>
|
|
***/
|
|
|
|
#include "asterisk.h"
|
|
|
|
#include <stdarg.h>
|
|
#include <pjlib.h>
|
|
#include <pjsip.h>
|
|
#include <pj/log.h>
|
|
|
|
#include "asterisk/logger.h"
|
|
#include "asterisk/module.h"
|
|
#include "asterisk/cli.h"
|
|
#include "asterisk/res_pjproject.h"
|
|
#include "asterisk/vector.h"
|
|
#include "asterisk/sorcery.h"
|
|
|
|
static struct ast_sorcery *pjproject_sorcery;
|
|
static pj_log_func *log_cb_orig;
|
|
static unsigned decor_orig;
|
|
|
|
static AST_VECTOR(buildopts, char *) buildopts;
|
|
|
|
/*! Protection from other log intercept instances. There can be only one at a time. */
|
|
AST_MUTEX_DEFINE_STATIC(pjproject_log_intercept_lock);
|
|
|
|
struct pjproject_log_intercept_data {
|
|
pthread_t thread;
|
|
int fd;
|
|
};
|
|
|
|
static struct pjproject_log_intercept_data pjproject_log_intercept = {
|
|
.thread = AST_PTHREADT_NULL,
|
|
.fd = -1,
|
|
};
|
|
|
|
struct log_mappings {
|
|
/*! Sorcery object details */
|
|
SORCERY_OBJECT(details);
|
|
/*! These are all comma-separated lists of pjproject log levels */
|
|
AST_DECLARE_STRING_FIELDS(
|
|
/*! pjproject log levels mapped to Asterisk ERROR */
|
|
AST_STRING_FIELD(asterisk_error);
|
|
/*! pjproject log levels mapped to Asterisk WARNING */
|
|
AST_STRING_FIELD(asterisk_warning);
|
|
/*! pjproject log levels mapped to Asterisk NOTICE */
|
|
AST_STRING_FIELD(asterisk_notice);
|
|
/*! pjproject log levels mapped to Asterisk VERBOSE */
|
|
AST_STRING_FIELD(asterisk_verbose);
|
|
/*! pjproject log levels mapped to Asterisk DEBUG */
|
|
AST_STRING_FIELD(asterisk_debug);
|
|
);
|
|
};
|
|
|
|
static struct log_mappings *default_log_mappings;
|
|
|
|
static struct log_mappings *get_log_mappings(void)
|
|
{
|
|
struct log_mappings *mappings;
|
|
|
|
mappings = ast_sorcery_retrieve_by_id(pjproject_sorcery, "log_mappings", "log_mappings");
|
|
if (!mappings) {
|
|
return ao2_bump(default_log_mappings);
|
|
}
|
|
|
|
return mappings;
|
|
}
|
|
|
|
#define __LOG_SUPPRESS -1
|
|
|
|
static int get_log_level(int pj_level)
|
|
{
|
|
RAII_VAR(struct log_mappings *, mappings, get_log_mappings(), ao2_cleanup);
|
|
unsigned char l;
|
|
|
|
if (!mappings) {
|
|
return __LOG_ERROR;
|
|
}
|
|
|
|
l = '0' + fmin(pj_level, 9);
|
|
|
|
if (strchr(mappings->asterisk_error, l)) {
|
|
return __LOG_ERROR;
|
|
} else if (strchr(mappings->asterisk_warning, l)) {
|
|
return __LOG_WARNING;
|
|
} else if (strchr(mappings->asterisk_notice, l)) {
|
|
return __LOG_NOTICE;
|
|
} else if (strchr(mappings->asterisk_verbose, l)) {
|
|
return __LOG_VERBOSE;
|
|
} else if (strchr(mappings->asterisk_debug, l)) {
|
|
return __LOG_DEBUG;
|
|
}
|
|
|
|
return __LOG_SUPPRESS;
|
|
}
|
|
|
|
static void log_forwarder(int level, const char *data, int len)
|
|
{
|
|
int ast_level;
|
|
/* PJPROJECT doesn't provide much in the way of source info */
|
|
const char * log_source = "pjproject";
|
|
int log_line = 0;
|
|
const char *log_func = "<?>";
|
|
|
|
if (pjproject_log_intercept.fd != -1
|
|
&& pjproject_log_intercept.thread == pthread_self()) {
|
|
/*
|
|
* We are handling a CLI command intercepting PJPROJECT
|
|
* log output.
|
|
*/
|
|
ast_cli(pjproject_log_intercept.fd, "%s\n", data);
|
|
return;
|
|
}
|
|
|
|
ast_level = get_log_level(level);
|
|
|
|
if (ast_level == __LOG_SUPPRESS) {
|
|
return;
|
|
}
|
|
|
|
if (ast_level == __LOG_DEBUG) {
|
|
/* Obey the debug level for res_pjproject */
|
|
if (!DEBUG_ATLEAST(level)) {
|
|
return;
|
|
}
|
|
}
|
|
|
|
/* PJPROJECT uses indention to indicate function call depth. We'll prepend
|
|
* log statements with a tab so they'll have a better shot at lining
|
|
* up */
|
|
ast_log(ast_level, log_source, log_line, log_func, "\t%s\n", data);
|
|
}
|
|
|
|
static void capture_buildopts_cb(int level, const char *data, int len)
|
|
{
|
|
if (strstr(data, "Teluu") || strstr(data, "Dumping")) {
|
|
return;
|
|
}
|
|
|
|
AST_VECTOR_ADD_SORTED(&buildopts, ast_strdup(ast_skip_blanks(data)), strcmp);
|
|
}
|
|
|
|
#pragma GCC diagnostic ignored "-Wformat-nonliteral"
|
|
int ast_pjproject_get_buildopt(char *option, char *format_string, ...)
|
|
{
|
|
int res = 0;
|
|
char *format_temp;
|
|
int i;
|
|
|
|
format_temp = ast_alloca(strlen(option) + strlen(" : ") + strlen(format_string) + 1);
|
|
sprintf(format_temp, "%s : %s", option, format_string);
|
|
|
|
for (i = 0; i < AST_VECTOR_SIZE(&buildopts); i++) {
|
|
va_list arg_ptr;
|
|
va_start(arg_ptr, format_string);
|
|
res = vsscanf(AST_VECTOR_GET(&buildopts, i), format_temp, arg_ptr);
|
|
va_end(arg_ptr);
|
|
if (res) {
|
|
break;
|
|
}
|
|
}
|
|
|
|
return res;
|
|
}
|
|
#pragma GCC diagnostic warning "-Wformat-nonliteral"
|
|
|
|
void ast_pjproject_log_intercept_begin(int fd)
|
|
{
|
|
/* Protect from other CLI instances trying to do this at the same time. */
|
|
ast_mutex_lock(&pjproject_log_intercept_lock);
|
|
|
|
pjproject_log_intercept.thread = pthread_self();
|
|
pjproject_log_intercept.fd = fd;
|
|
}
|
|
|
|
void ast_pjproject_log_intercept_end(void)
|
|
{
|
|
pjproject_log_intercept.fd = -1;
|
|
pjproject_log_intercept.thread = AST_PTHREADT_NULL;
|
|
|
|
ast_mutex_unlock(&pjproject_log_intercept_lock);
|
|
}
|
|
|
|
void ast_pjproject_ref(void)
|
|
{
|
|
ast_module_ref(ast_module_info->self);
|
|
}
|
|
|
|
void ast_pjproject_unref(void)
|
|
{
|
|
ast_module_unref(ast_module_info->self);
|
|
}
|
|
|
|
static char *handle_pjproject_show_buildopts(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
|
|
{
|
|
int i;
|
|
|
|
switch (cmd) {
|
|
case CLI_INIT:
|
|
e->command = "pjproject show buildopts";
|
|
e->usage =
|
|
"Usage: pjproject show buildopts\n"
|
|
" Show the compile time config of the pjproject that Asterisk is\n"
|
|
" running against.\n";
|
|
return NULL;
|
|
case CLI_GENERATE:
|
|
return NULL;
|
|
}
|
|
|
|
ast_cli(a->fd, "PJPROJECT compile time config currently running against:\n");
|
|
|
|
for (i = 0; i < AST_VECTOR_SIZE(&buildopts); i++) {
|
|
ast_cli(a->fd, "%s\n", AST_VECTOR_GET(&buildopts, i));
|
|
}
|
|
|
|
return CLI_SUCCESS;
|
|
}
|
|
|
|
static void mapping_destroy(void *object)
|
|
{
|
|
struct log_mappings *mappings = object;
|
|
|
|
ast_string_field_free_memory(mappings);
|
|
}
|
|
|
|
static void *mapping_alloc(const char *name)
|
|
{
|
|
struct log_mappings *mappings = ast_sorcery_generic_alloc(sizeof(*mappings), mapping_destroy);
|
|
if (!mappings) {
|
|
return NULL;
|
|
}
|
|
ast_string_field_init(mappings, 128);
|
|
|
|
return mappings;
|
|
}
|
|
|
|
static char *handle_pjproject_show_log_mappings(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
|
|
{
|
|
struct ast_variable *objset;
|
|
struct ast_variable *i;
|
|
struct log_mappings *mappings;
|
|
|
|
switch (cmd) {
|
|
case CLI_INIT:
|
|
e->command = "pjproject show log mappings";
|
|
e->usage =
|
|
"Usage: pjproject show log mappings\n"
|
|
" Show pjproject to Asterisk log mappings\n";
|
|
return NULL;
|
|
case CLI_GENERATE:
|
|
return NULL;
|
|
}
|
|
|
|
ast_cli(a->fd, "PJPROJECT to Asterisk log mappings:\n");
|
|
ast_cli(a->fd, "Asterisk Level : PJPROJECT log levels\n");
|
|
|
|
mappings = get_log_mappings();
|
|
if (!mappings) {
|
|
ast_log(LOG_ERROR, "Unable to retrieve pjproject log_mappings\n");
|
|
return CLI_SUCCESS;
|
|
}
|
|
|
|
objset = ast_sorcery_objectset_create(pjproject_sorcery, mappings);
|
|
if (!objset) {
|
|
ao2_ref(mappings, -1);
|
|
return CLI_SUCCESS;
|
|
}
|
|
|
|
for (i = objset; i; i = i->next) {
|
|
ast_cli(a->fd, "%-16s : %s\n", i->name, i->value);
|
|
}
|
|
ast_variables_destroy(objset);
|
|
|
|
ao2_ref(mappings, -1);
|
|
return CLI_SUCCESS;
|
|
}
|
|
|
|
static struct ast_cli_entry pjproject_cli[] = {
|
|
AST_CLI_DEFINE(handle_pjproject_show_buildopts, "Show the compiled config of the pjproject in use"),
|
|
AST_CLI_DEFINE(handle_pjproject_show_log_mappings, "Show pjproject to Asterisk log mappings"),
|
|
};
|
|
|
|
static int load_module(void)
|
|
{
|
|
ast_debug(3, "Starting PJPROJECT logging to Asterisk logger\n");
|
|
|
|
if (!(pjproject_sorcery = ast_sorcery_open())) {
|
|
ast_log(LOG_ERROR, "Failed to open SIP sorcery failed to open\n");
|
|
return AST_MODULE_LOAD_DECLINE;
|
|
}
|
|
|
|
ast_sorcery_apply_default(pjproject_sorcery, "log_mappings", "config", "pjproject.conf,criteria=type=log_mappings");
|
|
if (ast_sorcery_object_register(pjproject_sorcery, "log_mappings", mapping_alloc, NULL, NULL)) {
|
|
ast_log(LOG_WARNING, "Failed to register pjproject log_mappings object with sorcery\n");
|
|
ast_sorcery_unref(pjproject_sorcery);
|
|
pjproject_sorcery = NULL;
|
|
return AST_MODULE_LOAD_DECLINE;
|
|
}
|
|
|
|
ast_sorcery_object_field_register(pjproject_sorcery, "log_mappings", "type", "", OPT_NOOP_T, 0, 0);
|
|
ast_sorcery_object_field_register(pjproject_sorcery, "log_mappings", "asterisk_debug", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct log_mappings, asterisk_debug));
|
|
ast_sorcery_object_field_register(pjproject_sorcery, "log_mappings", "asterisk_error", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct log_mappings, asterisk_error));
|
|
ast_sorcery_object_field_register(pjproject_sorcery, "log_mappings", "asterisk_warning", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct log_mappings, asterisk_warning));
|
|
ast_sorcery_object_field_register(pjproject_sorcery, "log_mappings", "asterisk_notice", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct log_mappings, asterisk_notice));
|
|
ast_sorcery_object_field_register(pjproject_sorcery, "log_mappings", "asterisk_verbose", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct log_mappings, asterisk_verbose));
|
|
|
|
default_log_mappings = ast_sorcery_alloc(pjproject_sorcery, "log_mappings", "log_mappings");
|
|
if (!default_log_mappings) {
|
|
ast_log(LOG_ERROR, "Unable to allocate memory for pjproject log_mappings\n");
|
|
return AST_MODULE_LOAD_DECLINE;
|
|
}
|
|
ast_string_field_set(default_log_mappings, asterisk_error, "0,1");
|
|
ast_string_field_set(default_log_mappings, asterisk_warning, "2");
|
|
ast_string_field_set(default_log_mappings, asterisk_debug, "3,4,5");
|
|
|
|
ast_sorcery_load(pjproject_sorcery);
|
|
|
|
pj_init();
|
|
|
|
decor_orig = pj_log_get_decor();
|
|
log_cb_orig = pj_log_get_log_func();
|
|
|
|
if (AST_VECTOR_INIT(&buildopts, 64)) {
|
|
return AST_MODULE_LOAD_DECLINE;
|
|
}
|
|
|
|
/*
|
|
* On startup, we want to capture the dump once and store it.
|
|
*/
|
|
pj_log_set_log_func(capture_buildopts_cb);
|
|
pj_log_set_decor(0);
|
|
pj_dump_config();
|
|
pj_log_set_decor(PJ_LOG_HAS_SENDER | PJ_LOG_HAS_INDENT);
|
|
pj_log_set_log_func(log_forwarder);
|
|
|
|
ast_cli_register_multiple(pjproject_cli, ARRAY_LEN(pjproject_cli));
|
|
|
|
return AST_MODULE_LOAD_SUCCESS;
|
|
}
|
|
|
|
#define NOT_EQUALS(a, b) (a != b)
|
|
|
|
static int unload_module(void)
|
|
{
|
|
ast_cli_unregister_multiple(pjproject_cli, ARRAY_LEN(pjproject_cli));
|
|
pj_log_set_log_func(log_cb_orig);
|
|
pj_log_set_decor(decor_orig);
|
|
|
|
AST_VECTOR_REMOVE_CMP_UNORDERED(&buildopts, NULL, NOT_EQUALS, ast_free);
|
|
AST_VECTOR_FREE(&buildopts);
|
|
|
|
ast_debug(3, "Stopped PJPROJECT logging to Asterisk logger\n");
|
|
|
|
pj_shutdown();
|
|
|
|
ao2_cleanup(default_log_mappings);
|
|
default_log_mappings = NULL;
|
|
|
|
ast_sorcery_unref(pjproject_sorcery);
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int reload_module(void)
|
|
{
|
|
if (pjproject_sorcery) {
|
|
ast_sorcery_reload(pjproject_sorcery);
|
|
}
|
|
|
|
return AST_MODULE_LOAD_SUCCESS;
|
|
}
|
|
|
|
AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "PJPROJECT Log and Utility Support",
|
|
.support_level = AST_MODULE_SUPPORT_CORE,
|
|
.load = load_module,
|
|
.unload = unload_module,
|
|
.reload = reload_module,
|
|
.load_pri = AST_MODPRI_CHANNEL_DEPEND - 6,
|
|
);
|