pjsip_transport_events.c File Reference

Manages the global transport event notification callbacks. More...

#include "asterisk.h"
#include "asterisk/res_pjsip.h"
#include "asterisk/res_pjsip_cli.h"
#include "include/res_pjsip_private.h"
#include "asterisk/linkedlists.h"
#include "asterisk/vector.h"

Include dependency graph for pjsip_transport_events.c:

Go to the source code of this file.

Data Structures
struct	callback_data
struct	transport_monitor
	Structure for transport to be monitored. More...
struct	transport_monitor_notifier

Macros
#define	ACTIVE_TRANSPORTS_BUCKETS   127
	Number of buckets for monitored active transports. More...

Functions
static	AO2_GLOBAL_OBJ_STATIC (active_transports)
	Global container of active reliable transports. More...
	AO2_STRING_FIELD_CMP_FN (transport_monitor, key)
	Comparison function for struct transport_monitor. More...
	AO2_STRING_FIELD_HASH_FN (transport_monitor, key)
	Hashing function for struct transport_monitor. More...
	AO2_STRING_FIELD_SORT_FN (transport_monitor, key)
	Sort function for struct transport_monitor. More...
void	ast_sip_destroy_transport_events (void)
int	ast_sip_initialize_transport_events (void)
enum ast_transport_monitor_reg	ast_sip_transport_monitor_register (pjsip_transport *transport, ast_transport_monitor_shutdown_cb cb, void *ao2_data)
	Register a reliable transport shutdown monitor callback. More...
enum ast_transport_monitor_reg	ast_sip_transport_monitor_register_key (const char *transport_key, ast_transport_monitor_shutdown_cb cb, void *ao2_data)
	Register a reliable transport shutdown monitor callback. More...
enum ast_transport_monitor_reg	ast_sip_transport_monitor_register_replace (pjsip_transport *transport, ast_transport_monitor_shutdown_cb cb, void *ao2_data, ast_transport_monitor_data_matcher matches)
	Register a reliable transport shutdown monitor callback replacing any duplicate. More...
enum ast_transport_monitor_reg	ast_sip_transport_monitor_register_replace_key (const char *transport_key, ast_transport_monitor_shutdown_cb cb, void *ao2_data, ast_transport_monitor_data_matcher matches)
	Register a reliable transport shutdown monitor callback replacing any duplicate. More...
void	ast_sip_transport_monitor_unregister (pjsip_transport *transport, ast_transport_monitor_shutdown_cb cb, void *data, ast_transport_monitor_data_matcher matches)
	Unregister a reliable transport shutdown monitor. More...
void	ast_sip_transport_monitor_unregister_all (ast_transport_monitor_shutdown_cb cb, void *data, ast_transport_monitor_data_matcher matches)
	Unregister a transport shutdown monitor from all reliable transports. More...
void	ast_sip_transport_monitor_unregister_key (const char *transport_key, ast_transport_monitor_shutdown_cb cb, void *data, ast_transport_monitor_data_matcher matches)
	Unregister a reliable transport shutdown monitor. More...
void	ast_sip_transport_state_register (struct ast_sip_tpmgr_state_callback *element)
	Register a transport state notification callback element. More...
void	ast_sip_transport_state_unregister (struct ast_sip_tpmgr_state_callback *element)
	Unregister a transport state notification callback element. More...
static char *	cli_show_monitors (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static int	ptr_matcher (void *a, void *b)
static void	transport_monitor_dtor (void *vdoomed)
static int	transport_monitor_unregister_cb (void *obj, void *arg, int flags)
static const char *	transport_state2str (pjsip_transport_state state)
static void	transport_state_callback (pjsip_transport *transport, pjsip_transport_state state, const pjsip_transport_state_info *info)
	Callback invoked when transport state changes occur. More...
static void	transport_state_do_reg_callbacks (struct ao2_container *transports, pjsip_transport *transport)
static int	transport_tls_verify (const pjsip_transport *transport, const pjsip_tls_state_info *state_info)
static int	verify_cert_name (const pj_str_t *local, const pj_str_t *remote)
static int	verify_cert_names (const pj_str_t *host, const pj_ssl_cert_info *remote)
static void	verify_log_result (int log_level, const pjsip_transport *transport, pj_uint32_t verify_status)

Variables
static struct ast_cli_entry	cli_commands []
static pjsip_tp_state_callback	tpmgr_state_callback
	Existing transport events callback that we need to invoke. More...
struct {
struct ast_sip_tpmgr_state_callback *   first
struct ast_sip_tpmgr_state_callback *   last
ast_rwlock_t   lock
}	transport_state_list

Detailed Description

Manages the global transport event notification callbacks.

Author

Richard Mudgett rmudg.nosp@m.ett@.nosp@m.digiu.nosp@m.m.co.nosp@m.m See Also:

• CREDITS

Definition in file pjsip_transport_events.c.

Macro Definition Documentation

ACTIVE_TRANSPORTS_BUCKETS

#define ACTIVE_TRANSPORTS_BUCKETS   127

Number of buckets for monitored active transports.

Definition at line 41 of file pjsip_transport_events.c.

Function Documentation

AO2_GLOBAL_OBJ_STATIC()

static AO2_GLOBAL_OBJ_STATIC ( active_transports  )

static

Global container of active reliable transports.

AO2_STRING_FIELD_CMP_FN()

AO2_STRING_FIELD_CMP_FN	(	transport_monitor	,
		key
	)

Comparison function for struct transport_monitor.

AO2_STRING_FIELD_HASH_FN()

AO2_STRING_FIELD_HASH_FN	(	transport_monitor	,
		key
	)

Hashing function for struct transport_monitor.

AO2_STRING_FIELD_SORT_FN()

AO2_STRING_FIELD_SORT_FN	(	transport_monitor	,
		key
	)

Sort function for struct transport_monitor.

ast_sip_destroy_transport_events()

void ast_sip_destroy_transport_events

(

void

)

Definition at line 683 of file pjsip_transport_events.c.

{
    pjsip_tpmgr *tpmgr;
 
    ast_cli_unregister_multiple(cli_commands, ARRAY_LEN(cli_commands));
 
    tpmgr = pjsip_endpt_get_tpmgr(ast_sip_get_pjsip_endpoint());
    if (tpmgr) {
        pjsip_tpmgr_set_state_cb(tpmgr, tpmgr_state_callback);
    }
 
    ao2_global_obj_release(active_transports);
}

References ao2_global_obj_release, ARRAY_LEN, ast_cli_unregister_multiple(), ast_sip_get_pjsip_endpoint(), cli_commands, and tpmgr_state_callback.

Referenced by unload_pjsip().

ast_sip_initialize_transport_events()

int ast_sip_initialize_transport_events

(

void

)

Definition at line 697 of file pjsip_transport_events.c.

{
    pjsip_tpmgr *tpmgr;
    struct ao2_container *transports;
 
    tpmgr = pjsip_endpt_get_tpmgr(ast_sip_get_pjsip_endpoint());
    if (!tpmgr) {
        return -1;
    }
 
    transports = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_MUTEX, 0,
        ACTIVE_TRANSPORTS_BUCKETS, transport_monitor_hash_fn, transport_monitor_sort_fn,
        transport_monitor_cmp_fn);
    if (!transports) {
        return -1;
    }
    ao2_global_obj_replace_unref(active_transports, transports);
    ao2_ref(transports, -1);
 
    tpmgr_state_callback = pjsip_tpmgr_get_state_cb(tpmgr);
    pjsip_tpmgr_set_state_cb(tpmgr, &transport_state_callback);
 
    ast_cli_register_multiple(cli_commands, ARRAY_LEN(cli_commands));
 
 
    return 0;
}

References ACTIVE_TRANSPORTS_BUCKETS, AO2_ALLOC_OPT_LOCK_MUTEX, ao2_container_alloc_hash, ao2_global_obj_replace_unref, ao2_ref, ARRAY_LEN, ast_cli_register_multiple, ast_sip_get_pjsip_endpoint(), cli_commands, tpmgr_state_callback, and transport_state_callback().

Referenced by load_module().

ast_sip_transport_monitor_register()

enum ast_transport_monitor_reg ast_sip_transport_monitor_register	(	pjsip_transport *	transport,
		ast_transport_monitor_shutdown_cb	cb,
		void *	ao2_data
	)

Register a reliable transport shutdown monitor callback.

Deprecated:

Replaced with ast_sip_transport_monitor_register_key().

Since

13.20.0

Parameters

transport	Transport to monitor for shutdown.
cb	Who to call when transport is shutdown.
ao2_data	Data to pass with the callback.

Note

The data object passed will have its reference count automatically incremented by this call and automatically decremented after the callback runs or when the callback is unregistered.

There is no checking for duplicate registrations.

Returns

enum ast_transport_monitor_reg

Definition at line 478 of file pjsip_transport_events.c.

{
    char key[IP6ADDR_COLON_PORT_BUFLEN];
    AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR(transport, key);
 
    return ast_sip_transport_monitor_register_replace_key(key, cb, ao2_data, NULL);
}

References AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR, ast_sip_transport_monitor_register_replace_key(), callback_data::cb, IP6ADDR_COLON_PORT_BUFLEN, and NULL.

ast_sip_transport_monitor_register_key()

enum ast_transport_monitor_reg ast_sip_transport_monitor_register_key	(	const char *	transport_key,
		ast_transport_monitor_shutdown_cb	cb,
		void *	ao2_data
	)

Register a reliable transport shutdown monitor callback.

Parameters

transport_key	Key for the transport to monitor for shutdown. Create the key with AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR.
cb	Who to call when transport is shutdown.
ao2_data	Data to pass with the callback.

Note

The data object passed will have its reference count automatically incremented by this call and automatically decremented after the callback runs or when the callback is unregistered.

There is no checking for duplicate registrations.

Returns

enum ast_transport_monitor_reg

Definition at line 487 of file pjsip_transport_events.c.

{
    return ast_sip_transport_monitor_register_replace_key(transport_key, cb, ao2_data, NULL);
}

References ast_sip_transport_monitor_register_replace_key(), callback_data::cb, and NULL.

Referenced by subscription_persistence_update().

ast_sip_transport_monitor_register_replace()

enum ast_transport_monitor_reg ast_sip_transport_monitor_register_replace	(	pjsip_transport *	transport,
		ast_transport_monitor_shutdown_cb	cb,
		void *	ao2_data,
		ast_transport_monitor_data_matcher	matches
	)

Register a reliable transport shutdown monitor callback replacing any duplicate.

Deprecated:

Replaced with ast_sip_transport_monitor_register_replace_key().

Since

13.26.0

16.3.0

Parameters

transport	Transport to monitor for shutdown.
cb	Who to call when transport is shutdown.
ao2_data	Data to pass with the callback.
matches	Matcher function that returns true if data matches a previously registered data object

Note

The data object passed will have its reference count automatically incremented by this call and automatically decremented after the callback runs or when the callback is unregistered.

This function checks for duplicates, and overwrites/replaces the old monitor with the given one.

Returns

enum ast_transport_monitor_reg

Definition at line 493 of file pjsip_transport_events.c.

{
    char key[IP6ADDR_COLON_PORT_BUFLEN];
 
    AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR(transport, key);
    return ast_sip_transport_monitor_register_replace_key(key, cb, ao2_data, NULL);
}

References AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR, ast_sip_transport_monitor_register_replace_key(), callback_data::cb, IP6ADDR_COLON_PORT_BUFLEN, and NULL.

ast_sip_transport_monitor_register_replace_key()

enum ast_transport_monitor_reg ast_sip_transport_monitor_register_replace_key	(	const char *	transport_key,
		ast_transport_monitor_shutdown_cb	cb,
		void *	ao2_data,
		ast_transport_monitor_data_matcher	matches
	)

Register a reliable transport shutdown monitor callback replacing any duplicate.

Parameters

transport_key	Key for the transport to monitor for shutdown. Create the key with AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR.
cb	Who to call when transport is shutdown.
ao2_data	Data to pass with the callback.
matches	Matcher function that returns true if data matches a previously registered data object

Note

The data object passed will have its reference count automatically incremented by this call and automatically decremented after the callback runs or when the callback is unregistered.

This function checks for duplicates, and overwrites/replaces the old monitor with the given one.

Returns

enum ast_transport_monitor_reg

Definition at line 502 of file pjsip_transport_events.c.

{
    struct ao2_container *transports;
    struct transport_monitor *monitored;
    enum ast_transport_monitor_reg res = AST_TRANSPORT_MONITOR_REG_NOT_FOUND;
 
    ast_assert(transport_key != NULL && cb != NULL);
 
    transports = ao2_global_obj_ref(active_transports);
    if (!transports) {
        return res;
    }
 
    ao2_lock(transports);
    monitored = ao2_find(transports, transport_key, OBJ_SEARCH_KEY | OBJ_NOLOCK);
    if (monitored) {
        struct transport_monitor_notifier new_monitor;
        struct callback_data cb_data = {
            .cb = cb,
            .data = ao2_data,
            .matches = matches ?: ptr_matcher,
        };
 
        transport_monitor_unregister_cb(monitored, &cb_data, 0);
 
        /* Add new monitor to vector */
        new_monitor.cb = cb;
        new_monitor.data = ao2_bump(ao2_data);
        if (AST_VECTOR_APPEND(&monitored->monitors, new_monitor)) {
            ao2_cleanup(ao2_data);
            res = AST_TRANSPORT_MONITOR_REG_FAILED;
            ast_debug(3, "Transport %s(%s) RefCnt: %ld : Monitor registration failed %p(%p)\n",
                monitored->key, monitored->transport_obj_name,
                pj_atomic_get(monitored->transport->ref_cnt), cb, ao2_data);
        } else {
            res = AST_TRANSPORT_MONITOR_REG_SUCCESS;
            ast_debug(3, "Transport %s(%s,%s) RefCnt: %ld : Registered monitor %p(%p)\n",
                monitored->key, monitored->transport_obj_name,
                monitored->transport->type_name,
                pj_atomic_get(monitored->transport->ref_cnt), cb, ao2_data);
        }
 
        ao2_ref(monitored, -1);
    }
    ao2_unlock(transports);
    ao2_ref(transports, -1);
    return res;
}

References ao2_bump, ao2_cleanup, ao2_find, ao2_global_obj_ref, ao2_lock, ao2_ref, ao2_unlock, ast_assert, ast_debug, AST_TRANSPORT_MONITOR_REG_FAILED, AST_TRANSPORT_MONITOR_REG_NOT_FOUND, AST_TRANSPORT_MONITOR_REG_SUCCESS, AST_VECTOR_APPEND, transport_monitor_notifier::cb, callback_data::cb, transport_monitor_notifier::data, transport_monitor::key, callback_data::matches, transport_monitor::monitors, NULL, OBJ_NOLOCK, OBJ_SEARCH_KEY, ptr_matcher(), transport_monitor::transport, transport_monitor_unregister_cb(), and transport_monitor::transport_obj_name.

Referenced by ast_sip_transport_monitor_register(), ast_sip_transport_monitor_register_key(), ast_sip_transport_monitor_register_replace(), and registration_transport_monitor_setup().

ast_sip_transport_monitor_unregister()

void ast_sip_transport_monitor_unregister	(	pjsip_transport *	transport,
		ast_transport_monitor_shutdown_cb	cb,
		void *	data,
		ast_transport_monitor_data_matcher	matches
	)

Unregister a reliable transport shutdown monitor.

Deprecated:

Replaced with ast_sip_transport_monitor_unregister_key().

Since

13.20.0

Parameters

transport	Transport to monitor for shutdown.
cb	The callback that was used for the original register.
data	Data to pass to the matcher. May be NULL and does NOT need to be an ao2 object. If NULL, all monitors with the provided callback are unregistered.
matches	Matcher function that returns true if data matches the previously registered data object. If NULL, a simple pointer comparison is done.

Note

The data object passed into the original register will have its reference count automatically decremented.

Definition at line 441 of file pjsip_transport_events.c.

{
    char key[IP6ADDR_COLON_PORT_BUFLEN];
    AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR(transport, key);
    ast_sip_transport_monitor_unregister_key(key, cb, data, matches);
}

References AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR, ast_sip_transport_monitor_unregister_key(), callback_data::cb, callback_data::data, IP6ADDR_COLON_PORT_BUFLEN, and callback_data::matches.

Referenced by registrar_contact_delete().

ast_sip_transport_monitor_unregister_all()

void ast_sip_transport_monitor_unregister_all	(	ast_transport_monitor_shutdown_cb	cb,
		void *	data,
		ast_transport_monitor_data_matcher	matches
	)

Unregister a transport shutdown monitor from all reliable transports.

Since

13.20.0

Parameters

cb	The callback that was used for the original register.
data	Data to pass to the matcher. May be NULL and does NOT need to be an ao2 object. If NULL, all monitors with the provided callback are unregistered.
matches	Matcher function that returns true if ao2_data matches the previously registered data object. If NULL, a simple pointer comparison is done.

Note

The data object passed into the original register will have its reference count automatically decremented.

Definition at line 421 of file pjsip_transport_events.c.

{
    struct ao2_container *transports;
    struct callback_data cb_data = {
        .cb = cb,
        .data = data,
        .matches = matches ?: ptr_matcher,
    };
 
    ast_assert(cb != NULL);
 
    transports = ao2_global_obj_ref(active_transports);
    if (!transports) {
        return;
    }
    ao2_callback(transports, OBJ_MULTIPLE | OBJ_NODATA, transport_monitor_unregister_cb, &cb_data);
    ao2_ref(transports, -1);
}

References ao2_callback, ao2_global_obj_ref, ao2_ref, ast_assert, callback_data::cb, callback_data::data, callback_data::matches, NULL, OBJ_MULTIPLE, OBJ_NODATA, ptr_matcher(), and transport_monitor_unregister_cb().

Referenced by registrar_contact_delete(), and unload_module().

ast_sip_transport_monitor_unregister_key()

void ast_sip_transport_monitor_unregister_key	(	const char *	transport_key,
		ast_transport_monitor_shutdown_cb	cb,
		void *	data,
		ast_transport_monitor_data_matcher	matches
	)

Unregister a reliable transport shutdown monitor.

Parameters

transport_key	Key for the transport to monitor for shutdown. Create the key with AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR.
cb	The callback that was used for the original register.
data	Data to pass to the matcher. May be NULL and does NOT need to be an ao2 object. If NULL, all monitors with the provided callback are unregistered.
matches	Matcher function that returns true if data matches the previously registered data object. If NULL, a simple pointer comparison is done.

Note

The data object passed into the original register will have its reference count automatically decremented.

Definition at line 449 of file pjsip_transport_events.c.

{
    struct ao2_container *transports;
    struct transport_monitor *monitored;
 
    ast_assert(transport_key != NULL && cb != NULL);
 
    transports = ao2_global_obj_ref(active_transports);
    if (!transports) {
        return;
    }
 
    ao2_lock(transports);
    monitored = ao2_find(transports, transport_key, OBJ_SEARCH_KEY | OBJ_NOLOCK);
    if (monitored) {
        struct callback_data cb_data = {
            .cb = cb,
            .data = data,
            .matches = matches ?: ptr_matcher,
        };
 
        transport_monitor_unregister_cb(monitored, &cb_data, 0);
        ao2_ref(monitored, -1);
    }
    ao2_unlock(transports);
    ao2_ref(transports, -1);
}

References ao2_find, ao2_global_obj_ref, ao2_lock, ao2_ref, ao2_unlock, ast_assert, callback_data::cb, callback_data::data, callback_data::matches, NULL, OBJ_NOLOCK, OBJ_SEARCH_KEY, ptr_matcher(), and transport_monitor_unregister_cb().

Referenced by ast_sip_transport_monitor_unregister(), handle_registration_response(), and subscription_persistence_remove().

ast_sip_transport_state_register()

void ast_sip_transport_state_register

(

struct ast_sip_tpmgr_state_callback *

element

)

Register a transport state notification callback element.

Since

13.18.0

Parameters

element

What we are registering.

Definition at line 559 of file pjsip_transport_events.c.

{
    struct ast_sip_tpmgr_state_callback *tpmgr_notifier;
 
    AST_RWLIST_WRLOCK(&transport_state_list);
    AST_LIST_TRAVERSE(&transport_state_list, tpmgr_notifier, node) {
        if (element == tpmgr_notifier) {
            /* Already registered. */
            AST_RWLIST_UNLOCK(&transport_state_list);
            return;
        }
    }
    AST_LIST_INSERT_HEAD(&transport_state_list, element, node);
    AST_RWLIST_UNLOCK(&transport_state_list);
}

References AST_LIST_INSERT_HEAD, AST_LIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, and transport_state_list.

Referenced by ast_sip_initialize_transport_management().

ast_sip_transport_state_unregister()

void ast_sip_transport_state_unregister

(

struct ast_sip_tpmgr_state_callback *

element

)

Unregister a transport state notification callback element.

Since

13.18.0

Parameters

element

What we are unregistering.

Definition at line 552 of file pjsip_transport_events.c.

{
    AST_RWLIST_WRLOCK(&transport_state_list);
    AST_LIST_REMOVE(&transport_state_list, element, node);
    AST_RWLIST_UNLOCK(&transport_state_list);
}

References AST_LIST_REMOVE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, and transport_state_list.

Referenced by ast_sip_destroy_transport_management().

cli_show_monitors()

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

static

Definition at line 575 of file pjsip_transport_events.c.

{
    char *cli_rc = CLI_FAILURE;
    int rc = 0;
    int using_regex = 0;
    regex_t regex = { 0, };
    int container_count;
    struct ao2_iterator iter;
    struct ao2_container *sorted_monitors = NULL;
    struct ao2_container *transports;
    struct transport_monitor *monitored;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "pjsip show transport-monitors";
        e->usage = "Usage: pjsip show transport-monitors [ like <pattern> ]\n"
                    "      Show pjsip transport monitors\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    if (a->argc != 3 && a->argc != 5) {
        return CLI_SHOWUSAGE;
    }
 
    if (a->argc == 5) {
        int regrc;
        if (strcasecmp(a->argv[3], "like")) {
            return CLI_SHOWUSAGE;
        }
        regrc = regcomp(&regex, a->argv[4], REG_EXTENDED | REG_ICASE | REG_NOSUB);
        if (regrc) {
            char err[256];
            regerror(regrc, &regex, err, 256);
            ast_cli(a->fd, "PJSIP Transport Monitor: Error: %s\n", err);
            return CLI_FAILURE;
        }
        using_regex = 1;
    }
 
    /* Get a sorted snapshot of the scheduled tasks */
    sorted_monitors = ao2_container_alloc_rbtree(AO2_ALLOC_OPT_LOCK_NOLOCK, 0,
        transport_monitor_sort_fn, NULL);
    if (!sorted_monitors) {
        ast_cli(a->fd, "PJSIP Transport Monitor: Unable to allocate temporary container\n");
        goto error;
    }
 
    transports = ao2_global_obj_ref(active_transports);
    if (!transports) {
        ast_cli(a->fd, "PJSIP Transport Monitor: Unable to get transports\n");
        goto error;
    }
 
    ao2_lock(transports);
    rc = ao2_container_dup(sorted_monitors, transports, 0);
    ao2_unlock(transports);
    ao2_ref(transports, -1);
    if (rc != 0) {
        ast_cli(a->fd, "PJSIP Transport Monitors: Unable to sort temporary container\n");
        goto error;
    }
    container_count = ao2_container_count(sorted_monitors);
 
    ast_cli(a->fd, "PJSIP Transport Monitors:\n\n");
 
    ast_cli(a->fd,
        "<Remote Host...................................> <State.....> <Direction> <RefCnt> <Monitors> <ObjName............>\n");
 
    iter = ao2_iterator_init(sorted_monitors, AO2_ITERATOR_UNLINK);
    for (; (monitored = ao2_iterator_next(&iter)); ao2_ref(monitored, -1)) {
        char *state;
 
        if (using_regex && regexec(&regex, monitored->key, 0, NULL, 0) == REG_NOMATCH) {
            continue;
        }
 
        if (monitored->transport->is_destroying) {
            state = "DESTROYING";
        } else if (monitored->transport->is_shutdown) {
            state = "SHUTDOWN";
        } else {
            state = "ACTIVE";
        }
 
        ast_cli(a->fd, " %-46.46s   %-10s   %-9s   %6ld   %8zu   %s\n",
            monitored->key, state,
            monitored->transport->dir == PJSIP_TP_DIR_OUTGOING ? "Outgoing" : "Incoming",
            pj_atomic_get(monitored->transport->ref_cnt),
            AST_VECTOR_SIZE(&monitored->monitors), monitored->transport->obj_name);
    }
    ao2_iterator_destroy(&iter);
    ast_cli(a->fd, "\nTotal Transport Monitors: %d\n\n", container_count);
    cli_rc = CLI_SUCCESS;
error:
    if (using_regex) {
        regfree(&regex);
    }
    ao2_cleanup(sorted_monitors);
 
    return cli_rc;
}

References a, AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_cleanup, ao2_container_alloc_rbtree, ao2_container_count(), ao2_container_dup(), ao2_global_obj_ref, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, AO2_ITERATOR_UNLINK, ao2_lock, ao2_ref, ao2_unlock, ast_cli(), AST_VECTOR_SIZE, CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, error(), transport_monitor::key, transport_monitor::monitors, NULL, regex(), state, transport_monitor::transport, and ast_cli_entry::usage.

ptr_matcher()

static int ptr_matcher ( void *  a, void *  b  )

static

Definition at line 416 of file pjsip_transport_events.c.

{
    return a == b;
}

References a, and b.

Referenced by ast_sip_transport_monitor_register_replace_key(), ast_sip_transport_monitor_unregister_all(), and ast_sip_transport_monitor_unregister_key().

transport_monitor_dtor()

static void transport_monitor_dtor ( void *  vdoomed )

static

Definition at line 112 of file pjsip_transport_events.c.

{
    struct transport_monitor *monitored = vdoomed;
    int idx;
 
    for (idx = AST_VECTOR_SIZE(&monitored->monitors); idx--;) {
        struct transport_monitor_notifier *notifier;
 
        notifier = AST_VECTOR_GET_ADDR(&monitored->monitors, idx);
        ao2_cleanup(notifier->data);
    }
    AST_VECTOR_FREE(&monitored->monitors);
    ast_debug(3, "Transport %s(%s,%s) RefCnt: %ld : state:MONITOR_DESTROYED\n",
        monitored->key, monitored->transport->obj_name,
        monitored->transport->type_name,pj_atomic_get(monitored->transport->ref_cnt));
    ast_free(monitored->transport_obj_name);
    pjsip_transport_dec_ref(monitored->transport);
}

References ao2_cleanup, ast_debug, ast_free, AST_VECTOR_FREE, AST_VECTOR_GET_ADDR, AST_VECTOR_SIZE, transport_monitor_notifier::data, transport_monitor::key, transport_monitor::monitors, transport_monitor::transport, and transport_monitor::transport_obj_name.

Referenced by transport_state_callback().

transport_monitor_unregister_cb()

static int transport_monitor_unregister_cb ( void *  obj, void *  arg, int  flags  )

static

Definition at line 393 of file pjsip_transport_events.c.

{
    struct transport_monitor *monitored = obj;
    struct callback_data *cb_data = arg;
    int idx;
 
    for (idx = AST_VECTOR_SIZE(&monitored->monitors); idx--;) {
        struct transport_monitor_notifier *notifier;
 
        notifier = AST_VECTOR_GET_ADDR(&monitored->monitors, idx);
        if (notifier->cb == cb_data->cb && (!cb_data->data
            || cb_data->matches(cb_data->data, notifier->data))) {
            ao2_cleanup(notifier->data);
            AST_VECTOR_REMOVE_UNORDERED(&monitored->monitors, idx);
            ast_debug(3, "Transport %s(%s,%s) RefCnt: %ld : Unregistered monitor %p(%p)\n",
                monitored->key, monitored->transport_obj_name,
                monitored->transport->type_name,
                pj_atomic_get(monitored->transport->ref_cnt), notifier->cb, notifier->data);
        }
    }
    return 0;
}

References ao2_cleanup, ast_debug, AST_VECTOR_GET_ADDR, AST_VECTOR_REMOVE_UNORDERED, AST_VECTOR_SIZE, transport_monitor_notifier::cb, callback_data::cb, transport_monitor_notifier::data, callback_data::data, transport_monitor::key, callback_data::matches, transport_monitor::monitors, transport_monitor::transport, and transport_monitor::transport_obj_name.

Referenced by ast_sip_transport_monitor_register_replace_key(), ast_sip_transport_monitor_unregister_all(), and ast_sip_transport_monitor_unregister_key().

transport_state2str()

static const char * transport_state2str ( pjsip_transport_state  state )

static

Definition at line 83 of file pjsip_transport_events.c.

{
    const char *name;
 
    switch (state) {
    case PJSIP_TP_STATE_CONNECTED:
        name = "CONNECTED";
        break;
    case PJSIP_TP_STATE_DISCONNECTED:
        name = "DISCONNECTED";
        break;
    case PJSIP_TP_STATE_SHUTDOWN:
        name = "SHUTDOWN";
        break;
    case PJSIP_TP_STATE_DESTROY:
        name = "DESTROY";
        break;
    default:
        /*
         * We have to have a default case because the enum is
         * defined by a third-party library.
         */
        ast_assert(0);
        name = "<unknown>";
        break;
    }
    return name;
}

References ast_assert, and name.

Referenced by transport_state_callback().

transport_state_callback()

static void transport_state_callback ( pjsip_transport *  transport, pjsip_transport_state  state, const pjsip_transport_state_info *  info  )

static

Callback invoked when transport state changes occur.

Definition at line 293 of file pjsip_transport_events.c.

{
    struct ao2_container *transports;
    char transport_remote_ipaddr_port[IP6ADDR_COLON_PORT_BUFLEN];
 
    /* We only care about monitoring reliable transports */
    if (PJSIP_TRANSPORT_IS_RELIABLE(transport)
        && (transports = ao2_global_obj_ref(active_transports))) {
        struct transport_monitor *monitored;
        AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR(transport, transport_remote_ipaddr_port);
 
        ast_debug(3, "Transport %s(%s,%s): RefCnt: %ld state:%s\n",
            transport_remote_ipaddr_port, transport->obj_name, transport->type_name,
            pj_atomic_get(transport->ref_cnt), transport_state2str(state));
        switch (state) {
        case PJSIP_TP_STATE_CONNECTED:
            if (PJSIP_TRANSPORT_IS_SECURE(transport) &&
                !transport_tls_verify(transport, info->ext_info)) {
                pjsip_transport_shutdown(transport);
                return;
            }
 
            monitored = ao2_alloc_options(sizeof(*monitored),
                transport_monitor_dtor, AO2_ALLOC_OPT_LOCK_NOLOCK);
            if (!monitored) {
                break;
            }
            monitored->transport = transport;
            ast_copy_string(monitored->key, transport_remote_ipaddr_port, sizeof(monitored->key));
            monitored->transport_obj_name = ast_strdup(transport->obj_name);
 
            if (AST_VECTOR_INIT(&monitored->monitors, 5)) {
                ao2_ref(monitored, -1);
                break;
            }
            pjsip_transport_add_ref(monitored->transport);
            ast_debug(3, "Transport %s(%s,%s): RefCnt: %ld state:MONITOR_CREATED\n",
                monitored->key, monitored->transport_obj_name,
                monitored->transport->type_name,
                pj_atomic_get(monitored->transport->ref_cnt));
 
            ao2_link(transports, monitored);
            ao2_ref(monitored, -1);
            break;
        case PJSIP_TP_STATE_DISCONNECTED:
            if (!transport->is_shutdown) {
                pjsip_transport_shutdown(transport);
            }
            transport_state_do_reg_callbacks(transports, transport);
            break;
        case PJSIP_TP_STATE_SHUTDOWN:
            /*
             * Set shutdown flag early so we can force a new transport to be
             * created if a monitor callback needs to reestablish a link.
             * PJPROJECT sets the flag after this routine returns even though
             * it has already called the transport's shutdown routine.
             */
            transport->is_shutdown = PJ_TRUE;
 
            transport_state_do_reg_callbacks(transports, transport);
            break;
        case PJSIP_TP_STATE_DESTROY:
            transport_state_do_reg_callbacks(transports, transport);
            break;
        default:
            /*
             * We have to have a default case because the enum is
             * defined by a third-party library.
             */
            ast_assert(0);
            break;
        }
 
        ao2_ref(transports, -1);
    }
 
    /* Loop over other transport state callbacks registered with us. */
    if (!AST_LIST_EMPTY(&transport_state_list)) {
        struct ast_sip_tpmgr_state_callback *tpmgr_notifier;
 
        AST_RWLIST_RDLOCK(&transport_state_list);
        AST_LIST_TRAVERSE(&transport_state_list, tpmgr_notifier, node) {
            tpmgr_notifier->cb(transport, state, info);
        }
        AST_RWLIST_UNLOCK(&transport_state_list);
    }
 
    /* Forward to the old state callback if present */
    if (tpmgr_state_callback) {
        tpmgr_state_callback(transport, state, info);
    }
}

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_alloc_options, ao2_global_obj_ref, ao2_link, ao2_ref, ast_assert, ast_copy_string(), ast_debug, AST_LIST_EMPTY, AST_LIST_TRAVERSE, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR, ast_strdup, AST_VECTOR_INIT, ast_sip_tpmgr_state_callback::cb, sip_to_pjsip::info(), IP6ADDR_COLON_PORT_BUFLEN, transport_monitor::key, transport_monitor::monitors, tpmgr_state_callback, transport_monitor::transport, transport_monitor_dtor(), transport_monitor::transport_obj_name, transport_state2str(), transport_state_do_reg_callbacks(), transport_state_list, and transport_tls_verify().

Referenced by ast_sip_initialize_transport_events().

transport_state_do_reg_callbacks()

static void transport_state_do_reg_callbacks ( struct ao2_container *  transports, pjsip_transport *  transport  )

static

Definition at line 139 of file pjsip_transport_events.c.

{
    struct ao2_iterator *monitor_iter;
    struct transport_monitor *monitored;
    char key[IP6ADDR_COLON_PORT_BUFLEN];
    int idx;
 
    AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR(transport, key);
 
    monitor_iter = ao2_find(transports, key, OBJ_SEARCH_KEY | OBJ_MULTIPLE);
    while ((monitored = ao2_iterator_next(monitor_iter))) {
        if (monitored->transport == transport) {
            ao2_unlink(transports, monitored);
            for (idx = AST_VECTOR_SIZE(&monitored->monitors); idx--;) {
                struct transport_monitor_notifier *notifier;
 
                notifier = AST_VECTOR_GET_ADDR(&monitored->monitors, idx);
                ast_debug(3, "Transport %s(%s,%s) RefCnt: %ld : running callback %p(%p)\n",
                        monitored->key, monitored->transport->obj_name,
                        monitored->transport->type_name,
                        pj_atomic_get(monitored->transport->ref_cnt), notifier->cb, notifier->data);
                notifier->cb(notifier->data);
            }
        } else {
            ast_debug(3, "Transport %s(%s,%s) RefCnt: %ld : ignored not matching %s\n",
                    monitored->key, monitored->transport->obj_name,
                    monitored->transport->type_name,
                    pj_atomic_get(monitored->transport->ref_cnt), transport->obj_name);
        }
        ao2_ref(monitored, -1);
    }
    ao2_iterator_destroy(monitor_iter);
}

References ao2_find, ao2_iterator_destroy(), ao2_iterator_next, ao2_ref, ao2_unlink, ast_debug, AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR, AST_VECTOR_GET_ADDR, AST_VECTOR_SIZE, transport_monitor_notifier::cb, transport_monitor_notifier::data, IP6ADDR_COLON_PORT_BUFLEN, transport_monitor::key, transport_monitor::monitors, OBJ_MULTIPLE, OBJ_SEARCH_KEY, and transport_monitor::transport.

Referenced by transport_state_callback().

transport_tls_verify()

static int transport_tls_verify ( const pjsip_transport *  transport, const pjsip_tls_state_info *  state_info  )

static

Definition at line 243 of file pjsip_transport_events.c.

{
    pj_uint32_t verify_status;
    const struct ast_sip_transport_state *state;
 
    if (transport->dir == PJSIP_TP_DIR_INCOMING) {
        return 1;
    }
 
    /* transport_id should always be in factory info (see config_transport) */
    ast_assert(!ast_strlen_zero(transport->factory->info));
 
    state = ast_sip_get_transport_state(transport->factory->info);
    if (!state) {
        /*
         * There should always be an associated state, but if for some
         * reason there is not then fail verification
         */
        ast_log(LOG_ERROR, "Transport state not found for '%s'\n", transport->factory->info);
        return 0;
    }
 
    verify_status = state_info->ssl_sock_info->verify_status;
 
    /*
     * By this point pjsip has already completed its verification process. If
     * there was a name matching error it could be because they disallow wildcards.
     * If this transport has been configured to allow wildcards then we'll need
     * to re-check the name(s) for such.
     */
    if (state->allow_wildcard_certs &&
            (verify_status & PJ_SSL_CERT_EIDENTITY_NOT_MATCH)) {
        if (verify_cert_names(&transport->remote_name.host,
            state_info->ssl_sock_info->remote_cert_info)) {
            /* A name matched a wildcard, so clear the error */
            verify_status &= ~PJ_SSL_CERT_EIDENTITY_NOT_MATCH;
        }
    }
 
    if (state->verify_server && verify_status != PJ_SSL_CERT_ESUCCESS) {
        verify_log_result(__LOG_ERROR, transport, verify_status);
        return 0;
    }
 
    verify_log_result(__LOG_NOTICE, transport, verify_status);
    return 1;
}

References __LOG_ERROR, __LOG_NOTICE, ast_assert, ast_log, ast_sip_get_transport_state(), ast_strlen_zero(), LOG_ERROR, state, ast_sip_transport_state::transport, verify_cert_names(), and verify_log_result().

Referenced by transport_state_callback().

verify_cert_name()

static int verify_cert_name ( const pj_str_t *  local, const pj_str_t *  remote  )

static

Definition at line 197 of file pjsip_transport_events.c.

{
    const char *p;
    pj_ssize_t size;
 
    ast_debug(3, "Verify certificate name: local = %.*s, remote = %.*s\n",
        (unsigned int)pj_strlen(local), pj_strbuf(local),
        (unsigned int)pj_strlen(remote), pj_strbuf(remote));
 
    if (!pj_stricmp(remote, local)) {
        return 1;
    }
 
    if (pj_strnicmp2(remote, "*.", 2)) {
        return 0;
    }
 
    p = pj_strchr(local, '.');
    if (!p) {
        return 0;
    }
 
    size = pj_strbuf(local) + pj_strlen(local) - ++p;
 
    return size == pj_strlen(remote) - 2 ?
        !pj_memcmp(pj_strbuf(remote) + 2,  p, size) : 0;
}

References ast_debug.

Referenced by verify_cert_names().

verify_cert_names()

static int verify_cert_names ( const pj_str_t *  host, const pj_ssl_cert_info *  remote  )

static

Definition at line 225 of file pjsip_transport_events.c.

{
    unsigned int i;
 
    for (i = 0; i < remote->subj_alt_name.cnt; ++i) {
        /*
         * DNS is the only type we're matching wildcards against,
         * so only recheck those.
         */
        if (remote->subj_alt_name.entry[i].type == PJ_SSL_CERT_NAME_DNS
            && verify_cert_name(host, &remote->subj_alt_name.entry[i].name)) {
            return 1;
        }
    }
 
    return verify_cert_name(host, &remote->subject.cn);
}

References verify_cert_name().

Referenced by transport_tls_verify().

verify_log_result()

static void verify_log_result ( int  log_level, const pjsip_transport *  transport, pj_uint32_t  verify_status  )

static

Definition at line 173 of file pjsip_transport_events.c.

{
    char transport_remote_ipaddr_port[IP6ADDR_COLON_PORT_BUFLEN];
    const char *status[32];
    unsigned int count;
    unsigned int i;
 
    count = ARRAY_LEN(status);
 
    if (pj_ssl_cert_get_verify_status_strings(verify_status, status, &count) != PJ_SUCCESS) {
        ast_log(LOG_ERROR, "Error retrieving certificate verification result(s)\n");
        return;
    }
 
    AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR(transport, transport_remote_ipaddr_port);
    for (i = 0; i < count; ++i) {
        ast_log(log_level, _A_, "Transport '%s' to remote '%.*s' - %s - %s\n", transport->factory->info,
            (int)pj_strlen(&transport->remote_name.host), pj_strbuf(&transport->remote_name.host),
            transport_remote_ipaddr_port,
            status[i]);
    }
}

References _A_, ARRAY_LEN, ast_log, AST_SIP_MAKE_REMOTE_IPADDR_PORT_STR, IP6ADDR_COLON_PORT_BUFLEN, LOG_ERROR, log_level, and status.

Referenced by transport_tls_verify().

Variable Documentation

cli_commands

struct ast_cli_entry cli_commands[]

static

Initial value:

= {
    { .handler =  cli_show_monitors , .summary =  "Show pjsip transport monitors" ,},
}

Definition at line 679 of file pjsip_transport_events.c.

Referenced by ast_sip_destroy_transport_events(), and ast_sip_initialize_transport_events().

first

struct ast_sip_tpmgr_state_callback* first

Definition at line 72 of file pjsip_transport_events.c.

last

struct ast_sip_tpmgr_state_callback* last

Definition at line 72 of file pjsip_transport_events.c.

lock

ast_rwlock_t lock

Definition at line 72 of file pjsip_transport_events.c.

tpmgr_state_callback

pjsip_tp_state_callback tpmgr_state_callback

static

Existing transport events callback that we need to invoke.

Definition at line 69 of file pjsip_transport_events.c.

Referenced by ast_sip_destroy_transport_events(), ast_sip_initialize_transport_events(), and transport_state_callback().

struct { ... } transport_state_list

List of registered transport state callbacks.

Referenced by ast_sip_transport_state_register(), ast_sip_transport_state_unregister(), and transport_state_callback().