summaryrefslogtreecommitdiff
path: root/res/res_pjproject.c
blob: 7a71280540fef71982c3343e2bad29709a729f6e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
/*
 * 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 PJSIP logging to Asterisk logging.
 * \author David M. Lee, II <dlee@digium.com>
 *
 * PJSIP logging doesn't exactly match Asterisk logging, but mapping the two is
 * not too bad. PJSIP log levels are identified by a single int. Limits are
 * not specified by PJSIP, 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_pjsip.so
 */

/*** MODULEINFO
	<depend>pjproject</depend>
	<support_level>core</support_level>
 ***/

#include "asterisk.h"

ASTERISK_FILE_VERSION(__FILE__, "$Revision$")

#include <pjsip.h>
#include <pj/log.h>

#include "asterisk/logger.h"
#include "asterisk/module.h"
#include "asterisk/cli.h"

static pj_log_func *log_cb_orig;
static unsigned decor_orig;

/*! Protection from other CLI instances. */
AST_MUTEX_DEFINE_STATIC(show_buildopts_lock);

struct pjsip_show_buildopts {
	pthread_t thread;
	int fd;
};

static struct pjsip_show_buildopts show_buildopts = {
	.thread = AST_PTHREADT_NULL,
	.fd = -1,
};

static void log_cb(int level, const char *data, int len)
{
	int ast_level;
	/* PJSIP doesn't provide much in the way of source info */
	const char * log_source = "pjsip";
	int log_line = 0;
	const char *log_func = "<?>";
	int mod_level;

	if (show_buildopts.fd != -1 && show_buildopts.thread == pthread_self()) {
		/*
		 * We are handling the CLI command dumping the
		 * PJPROJECT compile time config option settings.
		 */
		ast_cli(show_buildopts.fd, "%s\n", data);
		return;
	}

	/* Lower number indicates higher importance */
	switch (level) {
	case 0: /* level zero indicates fatal error, according to docs */
	case 1: /* 1 seems to be used for errors */
		ast_level = __LOG_ERROR;
		break;
	case 2: /* 2 seems to be used for warnings and errors */
		ast_level = __LOG_WARNING;
		break;
	default:
		ast_level = __LOG_DEBUG;

		/* For levels 3 and up, obey the debug level for res_pjsip */
		mod_level = ast_opt_dbg_module ?
			ast_debug_get_by_module("res_pjsip") : 0;
		if (option_debug < level && mod_level < level) {
			return;
		}
		break;
	}

	/* PJSIP 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 char *handle_pjsip_show_buildopts(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
	switch(cmd) {
	case CLI_INIT:
		e->command = "pjsip show buildopts";
		e->usage =
			"Usage: pjsip show buildopts\n"
			"       Show the compile time config of pjproject that res_pjsip is\n"
			"       running against.\n";
		return NULL;
	case CLI_GENERATE:
		return NULL;
	}

	ast_cli(a->fd, "PJPROJECT compile time config currently running against:\n");

	/* Protect from other CLI instances trying to do this at the same time. */
	ast_mutex_lock(&show_buildopts_lock);

	show_buildopts.thread = pthread_self();
	show_buildopts.fd = a->fd;
	pj_dump_config();
	show_buildopts.fd = -1;
	show_buildopts.thread = AST_PTHREADT_NULL;

	ast_mutex_unlock(&show_buildopts_lock);

	return CLI_SUCCESS;
}

static struct ast_cli_entry pjsip_cli[] = {
	AST_CLI_DEFINE(handle_pjsip_show_buildopts, "Show the compiled config of pjproject in use"),
};

static int load_module(void)
{
	pj_init();

	decor_orig = pj_log_get_decor();
	log_cb_orig = pj_log_get_log_func();

	ast_debug(3, "Forwarding PJSIP logger to Asterisk logger\n");
	/* SENDER prepends the source to the log message. This could be a
	 * filename, object reference, or simply a string
	 *
	 * INDENT is assumed to be on by most log statements in PJSIP itself.
	 */
	pj_log_set_decor(PJ_LOG_HAS_SENDER | PJ_LOG_HAS_INDENT);
	pj_log_set_log_func(log_cb);

	ast_cli_register_multiple(pjsip_cli, ARRAY_LEN(pjsip_cli));

	return AST_MODULE_LOAD_SUCCESS;
}

static int unload_module(void)
{
	ast_cli_unregister_multiple(pjsip_cli, ARRAY_LEN(pjsip_cli));

	pj_log_set_log_func(log_cb_orig);
	pj_log_set_decor(decor_orig);

	pj_shutdown();

	return 0;
}

/* While we don't really export global symbols, we want to load before other
 * modules that do */
AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "PJSIP Log Forwarder",
	.support_level = AST_MODULE_SUPPORT_CORE,
	.load = load_module,
	.unload = unload_module,
	.load_pri = AST_MODPRI_CHANNEL_DEPEND - 6,
	);