Bridge PJPROJECT logging to Asterisk logging. More...

#include "asterisk.h"
#include <stdarg.h>
#include <pjlib.h>
#include <pjsip.h>
#include <pj/log.h>
#include "asterisk/options.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"
#include "asterisk/test.h"
#include "asterisk/netsock2.h"

Include dependency graph for res_pjproject.c:

Go to the source code of this file.

Data Structures
struct	buildopts

struct	log_mappings

struct	max_pjproject_log_level_check

struct	pjproject_log_intercept_data

Macros
#define	__LOG_SUPPRESS -1

#define	NOT_EQUALS(a, b) (a != b)

Functions
static void	__reg_module (void)

static void	__unreg_module (void)

struct ast_module *	AST_MODULE_SELF_SYM (void)

void	ast_pjproject_caching_pool_destroy (pj_caching_pool *cp)
	Destroy caching pool factory and all cached pools.

void	ast_pjproject_caching_pool_init (pj_caching_pool cp, const pj_pool_factory_policy policy, pj_size_t max_capacity)
	Initialize the caching pool factory.

int	ast_pjproject_get_buildopt (char option, char format_string,...)
	Retrieve a pjproject build option.

void	ast_pjproject_log_intercept_begin (int fd)
	Begin PJPROJECT log interception for CLI output.

void	ast_pjproject_log_intercept_end (void)
	End PJPROJECT log interception for CLI output.

int	ast_sockaddr_from_pj_sockaddr (struct ast_sockaddr addr, const pj_sockaddr pjaddr)
	Fill an ast_sockaddr from a pj_sockaddr.

int	ast_sockaddr_pj_sockaddr_cmp (const struct ast_sockaddr addr, const pj_sockaddr pjaddr)
	Compare an ast_sockaddr to a pj_sockaddr.

int	ast_sockaddr_to_pj_sockaddr (const struct ast_sockaddr addr, pj_sockaddr pjaddr)
	Fill a pj_sockaddr from an ast_sockaddr.

static void	capture_buildopts_cb (int level, const char *data, int len)

static int	get_log_level (int pj_level)

static struct log_mappings *	get_log_mappings (void)

static char *	handle_pjproject_set_log_level (struct ast_cli_entry e, int cmd, struct ast_cli_args a)

static char *	handle_pjproject_show_buildopts (struct ast_cli_entry e, int cmd, struct ast_cli_args a)

static char *	handle_pjproject_show_log_level (struct ast_cli_entry e, int cmd, struct ast_cli_args a)

static char *	handle_pjproject_show_log_mappings (struct ast_cli_entry e, int cmd, struct ast_cli_args a)

static int	load_module (void)

static void	log_forwarder (int level, const char *data, int len)

static void *	mapping_alloc (const char *name)

static void	mapping_destroy (void *object)

static int	reload_module (void)

static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS \| AST_MODFLAG_LOAD_ORDER , .description = "PJPROJECT Log and Utility Support" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .reload = reload_module, .load_pri = AST_MODPRI_CHANNEL_DEPEND - 6, .requires = "res_sorcery_config", }

static const struct ast_module_info *	ast_module_info = &__mod_info

static struct buildopts	buildopts

static unsigned	decor_orig

static struct log_mappings *	default_log_mappings

static pj_log_func *	log_cb_orig

static struct ast_cli_entry	pjproject_cli []

static struct pjproject_log_intercept_data	pjproject_log_intercept

static ast_mutex_t	pjproject_log_intercept_lock = AST_MUTEX_INIT_VALUE

static struct ast_sorcery *	pjproject_sorcery

Detailed Description

Bridge PJPROJECT logging to Asterisk logging.

Author: David M. Lee, II dlee@.nosp@m.digi.nosp@m.um.co.nosp@m.m

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: equivalent to ast_debug(level, ...) for res_pjproject.so
4: equivalent to ast_debug(level, ...) for res_pjproject.so
5: equivalent to ast_trace(level, ...) for res_pjproject.so
6: equivalent to ast_trace(level, ...) for res_pjproject.so

Definition in file res_pjproject.c.

Macro Definition Documentation

◆ __LOG_SUPPRESS

#define __LOG_SUPPRESS -1

Definition at line 201 of file res_pjproject.c.

◆ NOT_EQUALS

#define NOT_EQUALS	(	a,
		b
	)	(a != b)

Definition at line 817 of file res_pjproject.c.

Function Documentation

◆ __reg_module()

static void __reg_module ( void )

static

Definition at line 859 of file res_pjproject.c.

◆ __unreg_module()

static void __unreg_module ( void )

static

Definition at line 859 of file res_pjproject.c.

◆ AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM ( void )

Definition at line 859 of file res_pjproject.c.

◆ ast_pjproject_caching_pool_destroy()

void ast_pjproject_caching_pool_destroy ( pj_caching_pool * cp )

Destroy caching pool factory and all cached pools.

Since: 13.21.0

Parameters

cp	Caching pool factory to destroy

Definition at line 529 of file res_pjproject.c.

{
    pj_caching_pool_destroy(cp);
}

Referenced by unload_module(), and unload_pjsip().

◆ ast_pjproject_caching_pool_init()

void ast_pjproject_caching_pool_init	(	pj_caching_pool *	cp,
		const pj_pool_factory_policy *	policy,
		pj_size_t	max_capacity
	)

Initialize the caching pool factory.

Since: 13.21.0

Parameters

cp	Caching pool factory to initialize
policy	Pool factory policy
max_capacity	Total capacity to be retained in the cache. Zero disables caching.

Definition at line 522 of file res_pjproject.c.

{
    /* Passing a max_capacity of zero disables caching pools */
    pj_caching_pool_init(cp, policy, ast_option_pjproject_cache_pools ? max_capacity : 0);
}

References ast_option_pjproject_cache_pools.

Referenced by load_module(), load_module(), and load_pjsip().

◆ ast_pjproject_get_buildopt()

int ast_pjproject_get_buildopt	(	char *	option,
		char *	format_string,
			...
	)

Retrieve a pjproject build option.

Parameters

option	The build option requested
format_string	A scanf-style format string to parse the option value into
...	Pointers to variables to receive the values parsed

Return values

The	number of values parsed

Since: 13.8.0

Note: The option requested must be from those returned by pj_dump_config() which can be displayed with the 'pjsip show buildopts' CLI command.

Sample Usage:

int max_hostname;
 
ast_sip_get_pjproject_buildopt("PJ_MAX_HOSTNAME", "%d", &max_hostname);

Definition at line 281 of file res_pjproject.c.

{
    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;
}

References ast_alloca, AST_VECTOR_GET, and AST_VECTOR_SIZE.

Referenced by ast_sip_initialize_sorcery_location(), load_module(), and load_module().

◆ ast_pjproject_log_intercept_begin()

void ast_pjproject_log_intercept_begin ( int fd )

Begin PJPROJECT log interception for CLI output.

Since: 13.8.0

Parameters

fd	CLI file descriptior to send intercepted output.

Note: ast_pjproject_log_intercept_begin() and ast_pjproject_log_intercept_end() must always be called in pairs.

Definition at line 304 of file res_pjproject.c.

{
    /* 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;
}

References ast_mutex_lock, pjproject_log_intercept_data::fd, pjproject_log_intercept, pjproject_log_intercept_lock, and pjproject_log_intercept_data::thread.

Referenced by do_cli_dump_endpt().

◆ ast_pjproject_log_intercept_end()

void ast_pjproject_log_intercept_end ( void )

End PJPROJECT log interception for CLI output.

Since: 13.8.0

Note: ast_pjproject_log_intercept_begin() and ast_pjproject_log_intercept_end() must always be called in pairs.

Definition at line 313 of file res_pjproject.c.

{
    pjproject_log_intercept.fd = -1;
    pjproject_log_intercept.thread = AST_PTHREADT_NULL;
 
    ast_mutex_unlock(&pjproject_log_intercept_lock);
}

References ast_mutex_unlock, AST_PTHREADT_NULL, pjproject_log_intercept_data::fd, pjproject_log_intercept, pjproject_log_intercept_lock, and pjproject_log_intercept_data::thread.

Referenced by do_cli_dump_endpt().

◆ ast_sockaddr_from_pj_sockaddr()

int ast_sockaddr_from_pj_sockaddr	(	struct ast_sockaddr *	addr,
		const pj_sockaddr *	pjaddr
	)

Fill an ast_sockaddr from a pj_sockaddr.

Since: 13.24.0

Parameters

addr	The target address to receive the copied address
pjaddr	The source address to copy

Return values

0	Success
-1	Failure

Definition at line 559 of file res_pjproject.c.

{
    if (pjaddr->addr.sa_family == pj_AF_INET()) {
        struct sockaddr_in *sin = (struct sockaddr_in *) &addr->ss;
#if defined(HAVE_STRUCT_SOCKADDR_IN_SIN_LEN)
        sin->sin_len = sizeof(struct sockaddr_in);
#endif
        sin->sin_family = AF_INET;
#if defined(HAVE_PJPROJECT_BUNDLED) && !defined(HAVE_PJPROJECT_BUNDLED_OOT)
        sin->sin_addr = pjaddr->ipv4.sin_addr;
#else
        sin->sin_addr.s_addr = pjaddr->ipv4.sin_addr.s_addr;
#endif
        sin->sin_port   = pjaddr->ipv4.sin_port;
        memset(sin->sin_zero, 0, sizeof(sin->sin_zero));
        addr->len = sizeof(struct sockaddr_in);
    } else if (pjaddr->addr.sa_family == pj_AF_INET6()) {
        struct sockaddr_in6 *sin = (struct sockaddr_in6 *) &addr->ss;
#if defined(HAVE_STRUCT_SOCKADDR_IN6_SIN6_LEN)
        sin->sin6_len = sizeof(struct sockaddr_in6);
#endif
        sin->sin6_family   = AF_INET6;
        sin->sin6_port     = pjaddr->ipv6.sin6_port;
        sin->sin6_flowinfo = pjaddr->ipv6.sin6_flowinfo;
        sin->sin6_scope_id = pjaddr->ipv6.sin6_scope_id;
        memcpy(&sin->sin6_addr, &pjaddr->ipv6.sin6_addr, sizeof(sin->sin6_addr));
        addr->len = sizeof(struct sockaddr_in6);
    } else {
        memset(addr, 0, sizeof(*addr));
        return -1;
    }
    return 0;
}

References ast_sockaddr::len, and ast_sockaddr::ss.

Referenced by ast_sockaddr_pj_sockaddr_cmp().

◆ ast_sockaddr_pj_sockaddr_cmp()

int ast_sockaddr_pj_sockaddr_cmp	(	const struct ast_sockaddr *	addr,
		const pj_sockaddr *	pjaddr
	)

Compare an ast_sockaddr to a pj_sockaddr.

Parameters

addr	pointer to ast_sockaddr structure
pjaddr	pointer to pj_sockaddr structure

Return values

-1	addr is lexicographically smaller than pjaddr
0	addr is equal to pjaddr
1	pjaddr is lexicographically smaller than addr

Definition at line 593 of file res_pjproject.c.

{
    struct ast_sockaddr temp_pjaddr;
    int rc = 0;
 
    rc = ast_sockaddr_from_pj_sockaddr(&temp_pjaddr, pjaddr);
    if (rc != 0) {
        return -1;
    }
 
    rc = ast_sockaddr_cmp(addr, &temp_pjaddr);
    if (DEBUG_ATLEAST(4)) {
        char *a_str = ast_strdupa(ast_sockaddr_stringify(addr));
        char *pj_str = ast_strdupa(ast_sockaddr_stringify(&temp_pjaddr));
        ast_debug(4, "Comparing %s -> %s  rc: %d\n", a_str, pj_str, rc);
    }
 
    return rc;
}

References ast_debug, ast_sockaddr_cmp(), ast_sockaddr_from_pj_sockaddr(), ast_sockaddr_stringify(), ast_strdupa, and DEBUG_ATLEAST.

Referenced by __rtp_recvfrom().

◆ ast_sockaddr_to_pj_sockaddr()

int ast_sockaddr_to_pj_sockaddr	(	const struct ast_sockaddr *	addr,
		pj_sockaddr *	pjaddr
	)

Fill a pj_sockaddr from an ast_sockaddr.

Since: 13.24.0

Parameters

addr	The source address to copy
pjaddr	The target address to receive the copied address

Return values

0	Success
-1	Failure

Definition at line 534 of file res_pjproject.c.

{
    if (addr->ss.ss_family == AF_INET) {
        struct sockaddr_in *sin = (struct sockaddr_in *) &addr->ss;
        pjaddr->ipv4.sin_family = pj_AF_INET();
#if defined(HAVE_PJPROJECT_BUNDLED) && !defined(HAVE_PJPROJECT_BUNDLED_OOT)
        pjaddr->ipv4.sin_addr = sin->sin_addr;
#else
        pjaddr->ipv4.sin_addr.s_addr = sin->sin_addr.s_addr;
#endif
        pjaddr->ipv4.sin_port   = sin->sin_port;
    } else if (addr->ss.ss_family == AF_INET6) {
        struct sockaddr_in6 *sin = (struct sockaddr_in6 *) &addr->ss;
        pjaddr->ipv6.sin6_family   = pj_AF_INET6();
        pjaddr->ipv6.sin6_port     = sin->sin6_port;
        pjaddr->ipv6.sin6_flowinfo = sin->sin6_flowinfo;
        pjaddr->ipv6.sin6_scope_id = sin->sin6_scope_id;
        memcpy(&pjaddr->ipv6.sin6_addr, &sin->sin6_addr, sizeof(pjaddr->ipv6.sin6_addr));
    } else {
        memset(pjaddr, 0, sizeof(*pjaddr));
        return -1;
    }
    return 0;
}

References ast_sockaddr::ss.

◆ capture_buildopts_cb()

static void capture_buildopts_cb	(	int	level,
		const char *	data,
		int	len
	)

static

Definition at line 266 of file res_pjproject.c.

{
    char *dup;
 
    if (strstr(data, "Teluu") || strstr(data, "Dumping")) {
        return;
    }
 
    dup = ast_strdup(ast_skip_blanks(data));
    if (dup && AST_VECTOR_ADD_SORTED(&buildopts, dup, strcmp)) {
        ast_free(dup);
    }
}

References ast_free, ast_skip_blanks(), ast_strdup, and AST_VECTOR_ADD_SORTED.

Referenced by load_module().

◆ get_log_level()

static int get_log_level ( int pj_level )

static

Definition at line 203 of file res_pjproject.c.

{
    int mapped_level;
    unsigned char l;
    struct log_mappings *mappings;
 
    mappings = get_log_mappings();
    if (!mappings) {
        return __LOG_ERROR;
    }
 
    l = '0' + fmin(pj_level, 9);
 
    if (strchr(mappings->asterisk_error, l)) {
        mapped_level = __LOG_ERROR;
    } else if (strchr(mappings->asterisk_warning, l)) {
        mapped_level = __LOG_WARNING;
    } else if (strchr(mappings->asterisk_notice, l)) {
        mapped_level = __LOG_NOTICE;
    } else if (strchr(mappings->asterisk_verbose, l)) {
        mapped_level = __LOG_VERBOSE;
    } else if (strchr(mappings->asterisk_debug, l)) {
        mapped_level = __LOG_DEBUG;
    } else if (strchr(mappings->asterisk_trace, l)) {
        mapped_level = __LOG_TRACE;
    } else {
        mapped_level = __LOG_SUPPRESS;
    }
 
    ao2_ref(mappings, -1);
    return mapped_level;
}

References __LOG_DEBUG, __LOG_ERROR, __LOG_NOTICE, __LOG_SUPPRESS, __LOG_TRACE, __LOG_VERBOSE, __LOG_WARNING, ao2_ref, and get_log_mappings().

Referenced by log_forwarder().

◆ get_log_mappings()

static struct log_mappings * get_log_mappings ( void )

static

Definition at line 189 of file res_pjproject.c.

{
    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;
}

References ao2_bump, ast_sorcery_retrieve_by_id(), default_log_mappings, and pjproject_sorcery.

Referenced by get_log_level(), and handle_pjproject_show_log_mappings().

◆ handle_pjproject_set_log_level()

static char * handle_pjproject_set_log_level	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)

static

Definition at line 433 of file res_pjproject.c.

{
    int level_new;
    int level_old;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "pjproject set log level {default|0|1|2|3|4|5|6}";
        e->usage =
            "Usage: pjproject set log level {default|<level>}\n"
            "\n"
            "       Set the maximum active pjproject logging level.\n"
            "       See pjproject.conf.sample for additional information\n"
            "       about the various levels pjproject uses.\n"
            "       Note: setting this level at 4 or above may result in\n"
            "       raw packet logging.\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    if (a->argc != 5) {
        return CLI_SHOWUSAGE;
    }
 
    if (!strcasecmp(a->argv[4], "default")) {
        level_new = DEFAULT_PJ_LOG_MAX_LEVEL;
    } else {
        if (sscanf(a->argv[4], "%30d", &level_new) != 1
            || level_new < 0 || MAX_PJ_LOG_MAX_LEVEL < level_new) {
            return CLI_SHOWUSAGE;
        }
    }
 
    /* Update pjproject logging level */
    if (ast_pjproject_max_log_level < level_new) {
        level_new = ast_pjproject_max_log_level;
        ast_cli(a->fd,
            "Asterisk built or linked with pjproject PJ_LOG_MAX_LEVEL=%d.\n"
            "Lowering request to the max supported level.\n",
            ast_pjproject_max_log_level);
    }
    level_old = ast_option_pjproject_log_level;
    if (level_old == level_new) {
        ast_cli(a->fd, "pjproject log level is still %d.\n", level_old);
    } else {
        ast_cli(a->fd, "pjproject log level was %d and is now %d.\n",
            level_old, level_new);
        ast_option_pjproject_log_level = level_new;
        pj_log_set_level(level_new);
    }
 
    return CLI_SUCCESS;
}

References a, ast_cli(), ast_option_pjproject_log_level, ast_pjproject_max_log_level, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, DEFAULT_PJ_LOG_MAX_LEVEL, MAX_PJ_LOG_MAX_LEVEL, NULL, and ast_cli_entry::usage.

◆ handle_pjproject_show_buildopts()

static char * handle_pjproject_show_buildopts	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)

static

Definition at line 321 of file res_pjproject.c.

{
    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));
    }
 
#ifdef HAVE_PJSIP_AUTH_NEW_DIGESTS
    {
        struct ast_str *buf = ast_str_alloca(256);
        for (i = PJSIP_AUTH_ALGORITHM_NOT_SET + 1; i < PJSIP_AUTH_ALGORITHM_COUNT; i++) {
            const pjsip_auth_algorithm *algorithm = pjsip_auth_get_algorithm_by_type(i);
            if (!ast_strlen_zero(algorithm->openssl_name)) {
                if (pjsip_auth_is_algorithm_supported(i)) {
                    ast_str_append(&buf, 0, "%.*s/%s, ", (int)algorithm->iana_name.slen,
                        algorithm->iana_name.ptr, algorithm->openssl_name);
                }
            }
        }
        /* Trim off the trailing ", " */
        ast_str_truncate(buf, -2);
        ast_cli(a->fd, "Supported Digest Algorithms (IANA name/OpenSSL name): %s\n", ast_str_buffer(buf));
    }
#else
    ast_cli(a->fd, "Supported Digest Algorithms (IANA name/OpenSSL name): MD5/MD5\n");
#endif
 
    return CLI_SUCCESS;
}

References a, ast_cli(), ast_str_alloca, ast_str_append(), ast_str_buffer(), ast_str_truncate(), ast_strlen_zero(), AST_VECTOR_GET, AST_VECTOR_SIZE, buf, CLI_GENERATE, CLI_INIT, CLI_SUCCESS, ast_cli_entry::command, pjsip_auth_algorithm::iana_name, NULL, pjsip_auth_algorithm::openssl_name, PJSIP_AUTH_ALGORITHM_COUNT, PJSIP_AUTH_ALGORITHM_NOT_SET, and ast_cli_entry::usage.

◆ handle_pjproject_show_log_level()

static char * handle_pjproject_show_log_level	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)

static

Definition at line 488 of file res_pjproject.c.

{
    switch (cmd) {
    case CLI_INIT:
        e->command = "pjproject show log level";
        e->usage =
            "Usage: pjproject show log level\n"
            "\n"
            "       Show the current maximum active pjproject logging level.\n"
            "       See pjproject.conf.sample for additional information\n"
            "       about the various levels pjproject uses.\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    if (a->argc != 4) {
        return CLI_SHOWUSAGE;
    }
 
    ast_cli(a->fd, "pjproject log level is %d.%s\n",
        ast_option_pjproject_log_level,
        ast_option_pjproject_log_level == DEFAULT_PJ_LOG_MAX_LEVEL ? " (default)" : "");
 
    return CLI_SUCCESS;
}

References a, ast_cli(), ast_option_pjproject_log_level, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, DEFAULT_PJ_LOG_MAX_LEVEL, NULL, and ast_cli_entry::usage.

◆ handle_pjproject_show_log_mappings()

static char * handle_pjproject_show_log_mappings	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)

static

Definition at line 384 of file res_pjproject.c.

{
    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;
}

References a, ao2_ref, ast_cli(), ast_log, ast_sorcery_objectset_create, ast_variables_destroy(), CLI_GENERATE, CLI_INIT, CLI_SUCCESS, ast_cli_entry::command, get_log_mappings(), LOG_ERROR, ast_variable::name, ast_variable::next, NULL, pjproject_sorcery, ast_cli_entry::usage, and ast_variable::value.

◆ load_module()

static int load_module ( void )

static

Definition at line 740 of file res_pjproject.c.

{
    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));
    ast_sorcery_object_field_register(pjproject_sorcery, "log_mappings", "asterisk_trace", "",  OPT_STRINGFIELD_T, 0, STRFLDSET(struct log_mappings, asterisk_trace));
 
    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");
    ast_string_field_set(default_log_mappings, asterisk_trace, "5,6");
 
    ast_sorcery_load(pjproject_sorcery);
 
    AST_PJPROJECT_INIT_LOG_LEVEL();
    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_log_set_level(MAX_PJ_LOG_MAX_LEVEL);/* Set level to guarantee the dump output. */
    pj_dump_config();
    pj_log_set_decor(PJ_LOG_HAS_SENDER | PJ_LOG_HAS_INDENT);
    pj_log_set_log_func(log_forwarder);
    if (ast_pjproject_max_log_level < ast_option_pjproject_log_level) {
        ast_log(LOG_WARNING,
            "Asterisk built or linked with pjproject PJ_LOG_MAX_LEVEL=%d which is too low for startup level: %d.\n",
            ast_pjproject_max_log_level, ast_option_pjproject_log_level);
        ast_option_pjproject_log_level = ast_pjproject_max_log_level;
    }
    pj_log_set_level(ast_option_pjproject_log_level);
    if (!AST_VECTOR_SIZE(&buildopts)) {
        ast_log(LOG_NOTICE,
            "Asterisk built or linked with pjproject PJ_LOG_MAX_LEVEL=%d which is too low to get buildopts.\n",
            ast_pjproject_max_log_level);
    }
 
    ast_cli_register_multiple(pjproject_cli, ARRAY_LEN(pjproject_cli));
 
    AST_TEST_REGISTER(ast_sockaddr_to_pj_sockaddr_test);
    AST_TEST_REGISTER(ast_sockaddr_from_pj_sockaddr_test);
 
    return AST_MODULE_LOAD_SUCCESS;
}

References ARRAY_LEN, ast_cli_register_multiple, ast_debug, ast_log, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, ast_option_pjproject_log_level, AST_PJPROJECT_INIT_LOG_LEVEL, ast_pjproject_max_log_level, ast_sorcery_alloc(), ast_sorcery_apply_default, ast_sorcery_load(), ast_sorcery_object_field_register, ast_sorcery_object_register, ast_sorcery_open, ast_sorcery_unref, ast_string_field_set, AST_TEST_REGISTER, AST_VECTOR_INIT, AST_VECTOR_SIZE, capture_buildopts_cb(), decor_orig, default_log_mappings, log_cb_orig, LOG_ERROR, log_forwarder(), LOG_NOTICE, LOG_WARNING, mapping_alloc(), MAX_PJ_LOG_MAX_LEVEL, NULL, OPT_NOOP_T, OPT_STRINGFIELD_T, pjproject_cli, pjproject_sorcery, and STRFLDSET.

◆ log_forwarder()

static void log_forwarder	(	int	level,
		const char *	data,
		int	len
	)

static

Definition at line 236 of file res_pjproject.c.

{
    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;
    }
 
    /* 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);
}

References __LOG_SUPPRESS, ast_cli(), ast_log, pjproject_log_intercept_data::fd, get_log_level(), pjproject_log_intercept, and pjproject_log_intercept_data::thread.

Referenced by load_module().

◆ mapping_alloc()

static void * mapping_alloc ( const char * name )

static

Definition at line 373 of file res_pjproject.c.

{
    struct log_mappings *mappings = ast_sorcery_generic_alloc(sizeof(*mappings), mapping_destroy);
    if (!mappings) {
        return NULL;
    }
    ast_string_field_init(mappings, 128);
 
    return mappings;
}

References ast_sorcery_generic_alloc(), ast_string_field_init, mapping_destroy(), and NULL.

Referenced by load_module().

◆ mapping_destroy()

static void mapping_destroy ( void * object )

static

Definition at line 366 of file res_pjproject.c.

{
    struct log_mappings *mappings = object;
 
    ast_string_field_free_memory(mappings);
}

References ast_string_field_free_memory.

Referenced by mapping_alloc().

◆ reload_module()

static int reload_module ( void )

static

Definition at line 843 of file res_pjproject.c.

{
    if (pjproject_sorcery) {
        ast_sorcery_reload(pjproject_sorcery);
    }
 
    return AST_MODULE_LOAD_SUCCESS;
}

References AST_MODULE_LOAD_SUCCESS, ast_sorcery_reload(), and pjproject_sorcery.

◆ unload_module()

static int unload_module ( void )

static

Definition at line 819 of file res_pjproject.c.

{
    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_CALLBACK_VOID(&buildopts, 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);
 
    AST_TEST_UNREGISTER(ast_sockaddr_to_pj_sockaddr_test);
    AST_TEST_UNREGISTER(ast_sockaddr_from_pj_sockaddr_test);
 
    return 0;
}

References ao2_cleanup, ARRAY_LEN, ast_cli_unregister_multiple(), ast_debug, ast_free, ast_sorcery_unref, AST_TEST_UNREGISTER, AST_VECTOR_CALLBACK_VOID, AST_VECTOR_FREE, decor_orig, default_log_mappings, log_cb_orig, NULL, pjproject_cli, and pjproject_sorcery.

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER , .description = "PJPROJECT Log and Utility Support" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .reload = reload_module, .load_pri = AST_MODPRI_CHANNEL_DEPEND - 6, .requires = "res_sorcery_config", }

static

Definition at line 859 of file res_pjproject.c.

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 859 of file res_pjproject.c.

◆ buildopts

struct buildopts buildopts

static

◆ decor_orig

unsigned decor_orig

static

Definition at line 150 of file res_pjproject.c.

Referenced by load_module(), and unload_module().

◆ default_log_mappings

struct log_mappings* default_log_mappings

static

Definition at line 187 of file res_pjproject.c.

Referenced by get_log_mappings(), load_module(), and unload_module().

◆ log_cb_orig

pj_log_func* log_cb_orig

static

Definition at line 149 of file res_pjproject.c.

Referenced by load_module(), and unload_module().

◆ pjproject_cli

struct ast_cli_entry pjproject_cli[]

static

Definition at line 515 of file res_pjproject.c.

                                              {
    AST_CLI_DEFINE(handle_pjproject_set_log_level, "Set the maximum active pjproject logging level"),
    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"),
    AST_CLI_DEFINE(handle_pjproject_show_log_level, "Show the maximum active pjproject logging level"),
};

Referenced by load_module(), and unload_module().

◆ pjproject_log_intercept

struct pjproject_log_intercept_data pjproject_log_intercept

static

Initial value:

= {
    .thread = AST_PTHREADT_NULL,
    .fd = -1,
}

Definition at line 162 of file res_pjproject.c.

                                                                     {
    .thread = AST_PTHREADT_NULL,
    .fd = -1,
};

Referenced by ast_pjproject_log_intercept_begin(), ast_pjproject_log_intercept_end(), and log_forwarder().

◆ pjproject_log_intercept_lock

ast_mutex_t pjproject_log_intercept_lock = AST_MUTEX_INIT_VALUE

static

Protection from other log intercept instances. There can be only one at a time.

Definition at line 155 of file res_pjproject.c.

Referenced by ast_pjproject_log_intercept_begin(), and ast_pjproject_log_intercept_end().

◆ pjproject_sorcery

struct ast_sorcery* pjproject_sorcery

static

Definition at line 148 of file res_pjproject.c.

Referenced by get_log_mappings(), handle_pjproject_show_log_mappings(), load_module(), reload_module(), and unload_module().

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ __LOG_SUPPRESS

◆ NOT_EQUALS

Function Documentation

◆ __reg_module()

◆ __unreg_module()

◆ AST_MODULE_SELF_SYM()

◆ ast_pjproject_caching_pool_destroy()

◆ ast_pjproject_caching_pool_init()

◆ ast_pjproject_get_buildopt()

◆ ast_pjproject_log_intercept_begin()

◆ ast_pjproject_log_intercept_end()

◆ ast_sockaddr_from_pj_sockaddr()

◆ ast_sockaddr_pj_sockaddr_cmp()

◆ ast_sockaddr_to_pj_sockaddr()

◆ capture_buildopts_cb()

◆ get_log_level()

◆ get_log_mappings()

◆ handle_pjproject_set_log_level()

◆ handle_pjproject_show_buildopts()

◆ handle_pjproject_show_log_level()

◆ handle_pjproject_show_log_mappings()

◆ load_module()

◆ log_forwarder()

◆ mapping_alloc()

◆ mapping_destroy()

◆ reload_module()

◆ unload_module()

Variable Documentation

◆ __mod_info

◆ ast_module_info

◆ buildopts

◆ decor_orig

◆ default_log_mappings

◆ log_cb_orig

◆ pjproject_cli

◆ pjproject_log_intercept

◆ pjproject_log_intercept_lock

◆ pjproject_sorcery