astobj2_container.c File Reference

Functions implementing astobj2 objects. More...

#include "asterisk.h"
#include "asterisk/_private.h"
#include "asterisk/astobj2.h"
#include "astobj2_private.h"
#include "astobj2_container_private.h"
#include "asterisk/cli.h"

Include dependency graph for astobj2_container.c:

Go to the source code of this file.

Functions
void *	__ao2_callback (struct ao2_container *c, enum search_flags flags, ao2_callback_fn *cb_fn, void *arg, const char *tag, const char *file, int line, const char *func)
void *	__ao2_callback_data (struct ao2_container *c, enum search_flags flags, ao2_callback_data_fn *cb_fn, void *arg, void *data, const char *tag, const char *file, int line, const char *func)
struct ao2_container *	__ao2_container_clone (struct ao2_container *orig, enum search_flags flags, const char *tag, const char *file, int line, const char *func)
void *	__ao2_find (struct ao2_container *c, const void *arg, enum search_flags flags, const char *tag, const char *file, int line, const char *func)
void *	__ao2_iterator_next (struct ao2_iterator *iter, const char *tag, const char *file, int line, const char *func)
int	__ao2_link (struct ao2_container *self, void *obj_new, int flags, const char *tag, const char *file, int line, const char *func)
void *	__ao2_unlink (struct ao2_container *c, void *user_data, int flags, const char *tag, const char *file, int line, const char *func)
void *	__ao2_weakproxy_find (struct ao2_container *c, const void *arg, enum search_flags flags, const char *tag, const char *file, int line, const char *func)
int	__container_unlink_node_debug (struct ao2_container_node *node, uint32_t flags, const char *tag, const char *file, int line, const char *func)
int	ao2_container_check (struct ao2_container *self, enum search_flags flags)
	Perform an integrity check on the specified container. More...
int	ao2_container_count (struct ao2_container *c)
	Returns the number of elements in a container. More...
void	ao2_container_dump (struct ao2_container *self, enum search_flags flags, const char *name, void *where, ao2_prnt_fn *prnt, ao2_prnt_obj_fn *prnt_obj)
	Display contents of the specified container. More...
int	ao2_container_dup (struct ao2_container *dest, struct ao2_container *src, enum search_flags flags)
	Copy all object references in the src container into the dest container. More...
int	ao2_container_dup_weakproxy_objs (struct ao2_container *dest, struct ao2_container *src, enum search_flags flags)
	Copy object references associated with src container weakproxies into the dest container. More...
int	ao2_container_register (const char *name, struct ao2_container *self, ao2_prnt_obj_fn *prnt_obj)
	Register a container for CLI stats and integrity check. More...
void	ao2_container_stats (struct ao2_container *self, enum search_flags flags, const char *name, void *where, ao2_prnt_fn *prnt)
	Display statistics of the specified container. More...
void	ao2_container_unregister (const char *name)
	Unregister a container for CLI stats and integrity check. More...
void	ao2_iterator_cleanup (struct ao2_iterator *iter)
int	ao2_iterator_count (struct ao2_iterator *iter)
	Get a count of the iterated container objects. More...
void	ao2_iterator_destroy (struct ao2_iterator *iter)
	Destroy a container iterator. More...
struct ao2_iterator	ao2_iterator_init (struct ao2_container *c, int flags)
	Create an iterator for a container. More...
void	ao2_iterator_restart (struct ao2_iterator *iter)
	Restart an iteration. More...
int	ao2_match_by_addr (void *user_data, void *arg, int flags)
	another convenience function is a callback that matches on address More...
static int	cb_true (void *user_data, void *arg, int flags)
	special callback that matches all More...
static int	cb_true_data (void *user_data, void *arg, void *data, int flags)
	similar to cb_true, but is an ao2_callback_data_fn instead More...
void	container_destruct (void *_c)
int	container_init (void)
static int	dup_obj_cb (void *obj, void *arg, int flags)
static int	dup_weakproxy_cb (void *proxy, void *arg, int flags)
	Copy obj associated with a weakproxy into the arg container. More...
static void *	internal_ao2_traverse (struct ao2_container *self, enum search_flags flags, void *cb_fn, void *arg, void *data, enum ao2_callback_type type, const char *tag, const char *file, int line, const char *func)

Detailed Description

Functions implementing astobj2 objects.

Author

Richard Mudgett rmudg.nosp@m.ett@.nosp@m.digiu.nosp@m.m.co.nosp@m.m

Definition in file astobj2_container.c.

Function Documentation

__ao2_callback()

void * __ao2_callback	(	struct ao2_container *	c,
		enum search_flags	flags,
		ao2_callback_fn *	cb_fn,
		void *	arg,
		const char *	tag,
		const char *	file,
		int	line,
		const char *	func
	)

Definition at line 410 of file astobj2_container.c.

{
    return internal_ao2_traverse(c, flags, cb_fn, arg, NULL, AO2_CALLBACK_DEFAULT, tag, file, line, func);
}

References AO2_CALLBACK_DEFAULT, c, make_ari_stubs::file, ao2_iterator::flags, internal_ao2_traverse(), and NULL.

Referenced by __ao2_find(), and __ao2_unlink().

__ao2_callback_data()

void * __ao2_callback_data	(	struct ao2_container *	c,
		enum search_flags	flags,
		ao2_callback_data_fn *	cb_fn,
		void *	arg,
		void *	data,
		const char *	tag,
		const char *	file,
		int	line,
		const char *	func
	)

Definition at line 417 of file astobj2_container.c.

{
    return internal_ao2_traverse(c, flags, cb_fn, arg, data, AO2_CALLBACK_WITH_DATA, tag, file, line, func);
}

References AO2_CALLBACK_WITH_DATA, c, make_ari_stubs::file, ao2_iterator::flags, and internal_ao2_traverse().

__ao2_container_clone()

struct ao2_container * __ao2_container_clone	(	struct ao2_container *	orig,
		enum search_flags	flags,
		const char *	tag,
		const char *	file,
		int	line,
		const char *	func
	)

Definition at line 753 of file astobj2_container.c.

{
    struct ao2_container *clone;
    int failed;
 
    /* Create the clone container with the same properties as the original. */
    if (!__is_ao2_object(orig, file, line, func)) {
        return NULL;
    }
 
    if (!orig->v_table || !orig->v_table->alloc_empty_clone) {
        /* Sanity checks. */
        __ast_assert_failed(0, "invalid container v_table", file, line, func);
        return NULL;
    }
 
    clone = orig->v_table->alloc_empty_clone(orig, tag, file, line, func);
    if (!clone) {
        return NULL;
    }
 
    /* This test is correct.  clone must be locked before calling
     * ao2_container_dup when the OBJ_NOLOCK flag is set, otherwise
     * we could have errors in __adjust_lock. */
    if (flags & OBJ_NOLOCK) {
        ao2_wrlock(clone);
    }
    failed = ao2_container_dup(clone, orig, flags);
    if (flags & OBJ_NOLOCK) {
        ao2_unlock(clone);
    }
    if (failed) {
        /* Object copy into the clone container failed. */
        __ao2_ref(clone, -1, tag ?: "Clone creation failed", file, line, func);
        clone = NULL;
    }
    return clone;
}

References __ao2_ref(), __ast_assert_failed(), __is_ao2_object, ao2_container_methods::alloc_empty_clone, ao2_container_dup(), ao2_unlock, ao2_wrlock, make_ari_stubs::file, NULL, OBJ_NOLOCK, and ao2_container::v_table.

__ao2_find()

void * __ao2_find	(	struct ao2_container *	c,
		const void *	arg,
		enum search_flags	flags,
		const char *	tag,
		const char *	file,
		int	line,
		const char *	func
	)

the find function just invokes the default callback with some reasonable flags.

Definition at line 427 of file astobj2_container.c.

{
    void *arged = (void *) arg;/* Done to avoid compiler const warning */
 
    if (!c) {
        /* Sanity checks. */
        ast_assert(0);
        return NULL;
    }
    return __ao2_callback(c, flags, c->cmp_fn, arged, tag, file, line, func);
}

References __ao2_callback(), ast_assert, c, make_ari_stubs::file, ao2_iterator::flags, and NULL.

Referenced by __ast_format_cache_get(), and _get_mohbyname().

__ao2_iterator_next()

void * __ao2_iterator_next	(	struct ao2_iterator *	iter,
		const char *	tag,
		const char *	file,
		int	line,
		const char *	func
	)

Definition at line 556 of file astobj2_container.c.

{
    enum ao2_lock_req orig_lock;
    struct ao2_container_node *node;
    void *ret;
 
    if (!__is_ao2_object(iter->c, file, line, func)) {
        return NULL;
    }
 
    if (!iter->c->v_table || !iter->c->v_table->iterator_next) {
        /* Sanity checks. */
        __ast_assert_failed(0, "invalid iterator container v_table", file, line, func);
        return NULL;
    }
 
    if (iter->complete) {
        /* Don't return any more objects. */
        return NULL;
    }
 
    if (iter->flags & AO2_ITERATOR_DONTLOCK) {
        if (iter->flags & AO2_ITERATOR_UNLINK) {
            orig_lock = __adjust_lock(iter->c, AO2_LOCK_REQ_WRLOCK, 1);
        } else {
            orig_lock = __adjust_lock(iter->c, AO2_LOCK_REQ_RDLOCK, 1);
        }
    } else {
        orig_lock = AO2_LOCK_REQ_MUTEX;
        if (iter->flags & AO2_ITERATOR_UNLINK) {
            ao2_wrlock(iter->c);
        } else {
            ao2_rdlock(iter->c);
        }
    }
 
    node = iter->c->v_table->iterator_next(iter->c, iter->last_node, iter->flags);
    if (node) {
        ret = node->obj;
 
        if (iter->flags & AO2_ITERATOR_UNLINK) {
            /* Transfer the object ref from the container to the returned object. */
            __container_unlink_node_debug(node, AO2_UNLINK_NODE_DEC_COUNT, tag, file, line, func);
 
            /* Transfer the container's node ref to the iterator. */
        } else {
            /* Bump ref of returned object */
            __ao2_ref(ret, +1, tag ?: "Next iterator object.", file, line, func);
 
            /* Bump the container's node ref for the iterator. */
            ao2_ref(node, +1);
        }
    } else {
        /* The iteration has completed. */
        iter->complete = 1;
        ret = NULL;
    }
 
    /* Replace the iterator's node */
    if (iter->last_node) {
        ao2_ref(iter->last_node, -1);
    }
    iter->last_node = node;
 
    if (iter->flags & AO2_ITERATOR_DONTLOCK) {
        __adjust_lock(iter->c, orig_lock, 0);
    } else {
        ao2_unlock(iter->c);
    }
 
    return ret;
}

References __adjust_lock(), __ao2_ref(), __ast_assert_failed(), __container_unlink_node_debug(), __is_ao2_object, AO2_ITERATOR_DONTLOCK, AO2_ITERATOR_UNLINK, AO2_LOCK_REQ_MUTEX, AO2_LOCK_REQ_RDLOCK, AO2_LOCK_REQ_WRLOCK, ao2_rdlock, ao2_ref, AO2_UNLINK_NODE_DEC_COUNT, ao2_unlock, ao2_wrlock, ao2_iterator::c, ao2_iterator::complete, make_ari_stubs::file, ao2_iterator::flags, ao2_container_methods::iterator_next, ao2_iterator::last_node, NULL, and ao2_container::v_table.

__ao2_link()

int __ao2_link	(	struct ao2_container *	self,
		void *	obj_new,
		int	flags,
		const char *	tag,
		const char *	file,
		int	line,
		const char *	func
	)

Definition at line 94 of file astobj2_container.c.

{
    int res;
    enum ao2_lock_req orig_lock;
    struct ao2_container_node *node;
 
    if (!__is_ao2_object(obj_new, file, line, func)
        || !__is_ao2_object(self, file, line, func)) {
        return 0;
    }
 
    if (!self->v_table || !self->v_table->new_node || !self->v_table->insert) {
        /* Sanity checks. */
        __ast_assert_failed(0, "invalid container v_table", file, line, func);
        return 0;
    }
 
    if (flags & OBJ_NOLOCK) {
        orig_lock = __adjust_lock(self, AO2_LOCK_REQ_WRLOCK, 1);
    } else {
        ao2_wrlock(self);
        orig_lock = AO2_LOCK_REQ_MUTEX;
    }
 
    res = 0;
    node = self->v_table->new_node(self, obj_new, tag, file, line, func);
    if (node) {
#if defined(AO2_DEBUG)
        if (ao2_container_check(self, OBJ_NOLOCK)) {
            ast_log(LOG_ERROR, "Container integrity failed before insert.\n");
        }
#endif  /* defined(AO2_DEBUG) */
 
        /* Insert the new node. */
        switch (self->v_table->insert(self, node)) {
        case AO2_CONTAINER_INSERT_NODE_INSERTED:
            node->is_linked = 1;
            ast_atomic_fetchadd_int(&self->elements, 1);
#if defined(AO2_DEBUG)
            AO2_DEVMODE_STAT(++self->nodes);
            if (self->v_table->link_stat) {
                self->v_table->link_stat(self, node);
            }
#endif  /* defined(AO2_DEBUG) */
            /* Fall through */
        case AO2_CONTAINER_INSERT_NODE_OBJ_REPLACED:
#if defined(AO2_DEBUG)
            if (ao2_container_check(self, OBJ_NOLOCK)) {
                ast_log(LOG_ERROR, "Container integrity failed after insert or replace.\n");
            }
#endif  /* defined(AO2_DEBUG) */
            res = 1;
            break;
        case AO2_CONTAINER_INSERT_NODE_REJECTED:
            ao2_ref(node, -1);
            break;
        }
    }
 
    if (flags & OBJ_NOLOCK) {
        __adjust_lock(self, orig_lock, 0);
    } else {
        ao2_unlock(self);
    }
 
    return res;
}

References __adjust_lock(), __ast_assert_failed(), __is_ao2_object, ao2_container_check(), AO2_CONTAINER_INSERT_NODE_INSERTED, AO2_CONTAINER_INSERT_NODE_OBJ_REPLACED, AO2_CONTAINER_INSERT_NODE_REJECTED, AO2_DEVMODE_STAT, AO2_LOCK_REQ_MUTEX, AO2_LOCK_REQ_WRLOCK, ao2_ref, ao2_unlock, ao2_wrlock, ast_atomic_fetchadd_int(), ast_log, ao2_container::elements, make_ari_stubs::file, ao2_container_methods::insert, LOG_ERROR, ao2_container_methods::new_node, OBJ_NOLOCK, and ao2_container::v_table.

Referenced by internal_ao2_traverse().

__ao2_unlink()

void * __ao2_unlink	(	struct ao2_container *	c,
		void *	user_data,
		int	flags,
		const char *	tag,
		const char *	file,
		int	line,
		const char *	func
	)

Definition at line 175 of file astobj2_container.c.

{
    if (!__is_ao2_object(user_data, file, line, func)) {
        /* Sanity checks. */
        return NULL;
    }
 
    flags &= ~OBJ_SEARCH_MASK;
    flags |= (OBJ_UNLINK | OBJ_SEARCH_OBJECT | OBJ_NODATA);
    __ao2_callback(c, flags, ao2_match_by_addr, user_data, tag, file, line, func);
 
    return NULL;
}

References __ao2_callback(), __is_ao2_object, ao2_match_by_addr(), c, make_ari_stubs::file, NULL, OBJ_NODATA, OBJ_SEARCH_OBJECT, and OBJ_UNLINK.

__ao2_weakproxy_find()

void * __ao2_weakproxy_find	(	struct ao2_container *	c,
		const void *	arg,
		enum search_flags	flags,
		const char *	tag,
		const char *	file,
		int	line,
		const char *	func
	)

Definition at line 440 of file astobj2_container.c.

{
    void *proxy;
    void *obj = NULL;
    enum ao2_lock_req orig_lock;
 
    ast_assert(!!c);
    ast_assert(flags & OBJ_SEARCH_MASK);
    ast_assert(!(flags & ~(OBJ_SEARCH_MASK | OBJ_NOLOCK)));
 
    if (flags & OBJ_NOLOCK) {
        orig_lock = __adjust_lock(c, AO2_LOCK_REQ_RDLOCK, 1);
    } else {
        orig_lock = AO2_LOCK_REQ_RDLOCK;
        ao2_rdlock(c);
    }
 
    while ((proxy = ao2_find(c, arg, flags | OBJ_NOLOCK))) {
        obj = __ao2_weakproxy_get_object(proxy, 0, tag ?: __PRETTY_FUNCTION__, file, line, func);
 
        if (obj) {
            ao2_ref(proxy, -1);
            break;
        }
 
        /* Upgrade to a write lock */
        __adjust_lock(c, AO2_LOCK_REQ_WRLOCK, 1);
        ao2_unlink_flags(c, proxy, OBJ_NOLOCK);
        ao2_ref(proxy, -1);
    }
 
    if (flags & OBJ_NOLOCK) {
        /* We'll keep any upgraded lock */
        __adjust_lock(c, orig_lock, 1);
    } else {
        ao2_unlock(c);
    }
 
    return obj;
}

References __adjust_lock(), __ao2_weakproxy_get_object(), ao2_find, AO2_LOCK_REQ_RDLOCK, AO2_LOCK_REQ_WRLOCK, ao2_rdlock, ao2_ref, ao2_unlink_flags, ao2_unlock, ast_assert, c, make_ari_stubs::file, ao2_iterator::flags, NULL, OBJ_NOLOCK, and OBJ_SEARCH_MASK.

Referenced by __ast_named_lock_get(), and __ast_sorcery_open().

__container_unlink_node_debug()

int __container_unlink_node_debug	(	struct ao2_container_node *	node,
		uint32_t	flags,
		const char *	tag,
		const char *	file,
		int	line,
		const char *	func
	)

Definition at line 39 of file astobj2_container.c.

{
    struct ao2_container *container = node->my_container;
 
    if (container == NULL && (flags & AO2_UNLINK_NODE_DEC_COUNT)) {
        return 0;
    }
 
    if ((flags & AO2_UNLINK_NODE_UNLINK_OBJECT)
        && !(flags & AO2_UNLINK_NODE_NOUNREF_OBJECT)) {
        __ao2_ref(node->obj, -1, tag ?: "Remove obj from container", file, line, func);
    }
 
    node->obj = NULL;
 
    if (flags & AO2_UNLINK_NODE_DEC_COUNT) {
        ast_atomic_fetchadd_int(&container->elements, -1);
#if defined(AO2_DEBUG)
        {
            int empty = container->nodes - container->elements;
 
            if (container->max_empty_nodes < empty) {
                container->max_empty_nodes = empty;
            }
            if (container->v_table->unlink_stat) {
                container->v_table->unlink_stat(container, node);
            }
        }
#endif  /* defined(AO2_DEBUG) */
    }
 
    if (flags & AO2_UNLINK_NODE_UNREF_NODE) {
        /* Remove node from container */
        ao2_ref(node, -1);
    }
 
    return 1;
}

References __ao2_ref(), ao2_ref, AO2_UNLINK_NODE_DEC_COUNT, AO2_UNLINK_NODE_NOUNREF_OBJECT, AO2_UNLINK_NODE_UNLINK_OBJECT, AO2_UNLINK_NODE_UNREF_NODE, ast_atomic_fetchadd_int(), container, ao2_container::elements, make_ari_stubs::file, NULL, and ao2_container::v_table.

Referenced by __ao2_iterator_next(), and internal_ao2_traverse().

ao2_container_check()

int ao2_container_check	(	struct ao2_container *	self,
		enum search_flags	flags
	)

Perform an integrity check on the specified container.

Since

12.0.0

Parameters

self	Container to check integrity.
flags	OBJ_NOLOCK if a lock is already held on the container.

Return values

0	on success.
-1	on error.

Definition at line 856 of file astobj2_container.c.

{
    int res = 0;
 
    if (!is_ao2_object(self) || !self->v_table) {
        /* Sanity checks. */
        ast_assert(0);
        return -1;
    }
#if defined(AO2_DEBUG)
    if (!self->v_table->integrity) {
        /* No integrity check available.  Assume container is ok. */
        return 0;
    }
 
    if (!(flags & OBJ_NOLOCK)) {
        ao2_rdlock(self);
    }
    res = self->v_table->integrity(self);
    if (!(flags & OBJ_NOLOCK)) {
        ao2_unlock(self);
    }
#endif  /* defined(AO2_DEBUG) */
    return res;
}

References ao2_rdlock, ao2_unlock, ast_assert, is_ao2_object, OBJ_NOLOCK, and ao2_container::v_table.

Referenced by __ao2_link(), AST_TEST_DEFINE(), astobj2_test_1_helper(), hash_ao2_node_destructor(), insert_test_duplicates(), insert_test_vector(), rb_ao2_node_destructor(), and test_container_clone().

ao2_container_count()

int ao2_container_count

(

struct ao2_container *

c

)

Returns the number of elements in a container.

return the number of elements in the container

Definition at line 34 of file astobj2_container.c.

{
    return ast_atomic_fetchadd_int(&c->elements, 0);
}

References ast_atomic_fetchadd_int(), and c.

Referenced by action_confbridgekick(), action_confbridgelist(), action_confbridgelistrooms(), action_confbridgesetsinglevideosrc(), action_confbridgestartrecord(), action_confbridgestoprecord(), action_lock_unlock_helper(), action_mute_unmute_helper(), ami_show_aors(), ami_show_auths(), ami_show_contacts(), ami_show_endpoints(), ami_show_resource_lists(), ao2_iterator_count(), app_is_finished(), ari_show(), ast_active_channels(), ast_ari_applications_list(), ast_bridge_transfer_attended(), ast_bridge_transfer_blind(), ast_cdr_generic_unregister(), ast_endpoint_snapshot_create(), ast_get_chan_applicationmap(), ast_get_namedgroups(), ast_merge_contexts_and_delete(), ast_namedgroups_intersect(), ast_sip_cli_traverse_objects(), ast_sip_initialize_system(), ast_sip_location_retrieve_first_aor_contact_filtered(), ast_sorcery_create(), ast_sorcery_delete(), ast_sorcery_retrieve_by_fields(), ast_sorcery_retrieve_by_prefix(), ast_sorcery_retrieve_by_regex(), ast_sorcery_update(), ast_srtp_unprotect(), AST_TEST_DEFINE(), ast_tone_zone_count(), astobj2_test_1_helper(), auth_observer(), bridges_scrape_cb(), calc_metric(), cc_cli_output_status(), cel_pre_apply_config(), channels_scrape_cb(), check_events(), check_expiration_thread(), cleanup(), cleanup_module(), cli_display_parking_lot(), cli_eprofile_show_all(), cli_fax_show_sessions(), cli_profile_show_all(), cli_show_modules(), cli_show_monitors(), cli_show_tasks(), cli_tn_show_all(), client_config_show_all(), common_identify(), control_command_count(), control_wait(), cpg_confchg_cb(), create_sound_blob(), create_unsolicited_mwi_subscriptions(), device_state_cb(), dial_state_process_bridge_enter(), do_timing(), endelm(), endpoints_scrape_cb(), exten_state_pub_data_alloc(), find_contact(), format_ami_aor_handler(), get_device_state_causing_channels(), global_loaded_observer(), grow(), handle_cli_sound_show(), handle_feature_show(), handle_manager_show_events(), handle_registrations(), handle_show_hint(), handle_show_hints(), insert_test_vector(), ip_identify_apply(), load_common(), locals_show(), member_add_to_queue(), memory_cache_full_update(), memory_cache_populate(), mid_test_sync(), mwi_subscription_established(), native_bridge_is_capable(), native_rtp_bridge_compatible_check(), object_type_loaded_observer(), one_protocol(), parking_lot_remove_if_unused(), pjsip_acf_dial_contacts_read(), presence_state_cb(), print_queue(), process_config(), pthread_timer_open(), publisher_start(), queue_exec(), queue_function_mem_read(), queued_set_size(), queued_task_pushed(), send_unsolicited_mwi_notify(), should_send_event(), shrink(), single_state_process_bridge_enter(), sip_options_apply_aor_configuration(), sip_options_contact_add_task(), sip_options_contact_delete_task(), sip_options_unused_endpoint_state_compositor(), sla_in_use(), smdi_load(), sorcery_memory_cache_create(), sorcery_memory_cache_dump(), sorcery_memory_cache_populate(), sorcery_memory_cache_retrieve_multiple(), sorcery_memory_cache_retrieve_prefix(), sorcery_memory_cache_retrieve_regex(), sorcery_memory_cache_show(), sorcery_object_load(), stale_cache_update(), stasis_app_set_global_debug(), stasis_app_to_cli(), system_create_resolver_and_set_nameservers(), test_ao2_iteration(), test_cel_peer_strings_match(), test_container_clone(), test_sub(), threadpool_send_state_changed(), tps_shutdown(), try_calling(), unload_module(), and xmpp_show_clients().

ao2_container_dump()

void ao2_container_dump	(	struct ao2_container *	self,
		enum search_flags	flags,
		const char *	name,
		void *	where,
		ao2_prnt_fn *	prnt,
		ao2_prnt_obj_fn *	prnt_obj
	)

Display contents of the specified container.

Since

12.0.0

Parameters

self	Container to dump.
flags	OBJ_NOLOCK if a lock is already held on the container.
name	Container name. (NULL if anonymous)
where	User data needed by prnt to determine where to put output.
prnt	Print output callback function to use.
prnt_obj	Callback function to print the given object's key. (NULL if not available)

Definition at line 792 of file astobj2_container.c.

{
    if (!is_ao2_object(self) || !self->v_table) {
        prnt(where, "Invalid container\n");
        ast_assert(0);
        return;
    }
 
    if (!(flags & OBJ_NOLOCK)) {
        ao2_rdlock(self);
    }
    if (name) {
        prnt(where, "Container name: %s\n", name);
    }
#if defined(AO2_DEBUG)
    if (self->v_table->dump) {
        self->v_table->dump(self, where, prnt, prnt_obj);
    } else
#endif  /* defined(AO2_DEBUG) */
    {
        prnt(where, "Container dump not available.\n");
    }
    if (!(flags & OBJ_NOLOCK)) {
        ao2_unlock(self);
    }
}

References ao2_rdlock, ao2_unlock, ast_assert, is_ao2_object, name, OBJ_NOLOCK, and ao2_container::v_table.

Referenced by astobj2_test_1_helper(), and test_traversal_sorted().

ao2_container_dup()

int ao2_container_dup	(	struct ao2_container *	dest,
		struct ao2_container *	src,
		enum search_flags	flags
	)

Copy all object references in the src container into the dest container.

Since

11.0

Parameters

dest	Container to copy src object references into.
src	Container to copy all object references from.
flags	OBJ_NOLOCK if a lock is already held on both containers. Otherwise, the src container is locked first.

Precondition

The dest container must be empty. If the duplication fails, the dest container will be returned empty.

Note

This can potentially be expensive because a malloc is needed for every object in the src container.

Return values

0	on success.
-1	on error.

Definition at line 673 of file astobj2_container.c.

{
    void *obj;
    int res = 0;
 
    if (!(flags & OBJ_NOLOCK)) {
        ao2_rdlock(src);
        ao2_wrlock(dest);
    }
    obj = ao2_callback(src, OBJ_NOLOCK, dup_obj_cb, dest);
    if (obj) {
        /* Failed to put this obj into the dest container. */
        ao2_t_ref(obj, -1, "Failed to put this object into the dest container.");
 
        /* Remove all items from the dest container. */
        ao2_callback(dest, OBJ_NOLOCK | OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL,
            NULL);
        res = -1;
    }
    if (!(flags & OBJ_NOLOCK)) {
        ao2_unlock(dest);
        ao2_unlock(src);
    }
 
    return res;
}

References ao2_callback, ao2_rdlock, ao2_t_ref, ao2_unlock, ao2_wrlock, dup_obj_cb(), NULL, OBJ_MULTIPLE, OBJ_NODATA, OBJ_NOLOCK, and OBJ_UNLINK.

Referenced by __ao2_container_clone(), __queues_show(), cli_aor_get_container(), cli_endpoint_get_container(), cli_get_container(), cli_show_monitors(), cli_show_tasks(), cli_unid_get_container(), geoloc_config_list_locations(), geoloc_config_list_profiles(), geoloc_config_show_profiles(), handle_cli_sounds_show(), sip_options_apply_aor_configuration(), stasis_show_topics(), tps_report_taskprocessor_list(), and tps_shutdown().

ao2_container_dup_weakproxy_objs()

int ao2_container_dup_weakproxy_objs	(	struct ao2_container *	dest,
		struct ao2_container *	src,
		enum search_flags	flags
	)

Copy object references associated with src container weakproxies into the dest container.

Parameters

dest	Container to copy src strong object references into.
src	Container to copy all weak object references from.
flags	OBJ_NOLOCK if a lock is already held on both containers. Otherwise, the src container is locked first.

Precondition

The dest container must be empty. If the duplication fails, the dest container will be returned empty.

Note

This can potentially be expensive because a malloc is needed for every object in the src container.

Every object inside the container is locked by ao2_weakproxy_get_object. Any weakproxy in src with no associated object is ignored.

Return values

0	on success.
-1	on error.

Definition at line 726 of file astobj2_container.c.

{
    void *obj;
    int res = 0;
 
    if (!(flags & OBJ_NOLOCK)) {
        ao2_rdlock(src);
        ao2_wrlock(dest);
    }
    obj = ao2_callback(src, OBJ_NOLOCK, dup_weakproxy_cb, dest);
    if (obj) {
        /* Failed to put this obj into the dest container. */
        ao2_t_ref(obj, -1, "Failed to put this object into the dest container.");
 
        /* Remove all items from the dest container. */
        ao2_callback(dest, OBJ_NOLOCK | OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL,
            NULL);
        res = -1;
    }
    if (!(flags & OBJ_NOLOCK)) {
        ao2_unlock(dest);
        ao2_unlock(src);
    }
 
    return res;
}

References ao2_callback, ao2_rdlock, ao2_t_ref, ao2_unlock, ao2_wrlock, dup_weakproxy_cb(), NULL, OBJ_MULTIPLE, OBJ_NODATA, OBJ_NOLOCK, and OBJ_UNLINK.

Referenced by AST_TEST_DEFINE().

ao2_container_register()

int ao2_container_register	(	const char *	name,
		struct ao2_container *	self,
		ao2_prnt_obj_fn *	prnt_obj
	)

Register a container for CLI stats and integrity check.

Since

12.0.0

Parameters

name	Name to register the container under.
self	Container to register.
prnt_obj	Callback function to print the given object's key. (NULL if not available)

Return values

0	on success.
-1	on error.

Definition at line 958 of file astobj2_container.c.

{
    int res = 0;
#if defined(AO2_DEBUG)
    struct ao2_reg_container *reg;
 
    reg = ao2_t_alloc_options(sizeof(*reg) + strlen(name), ao2_reg_destructor,
        AO2_ALLOC_OPT_LOCK_NOLOCK, "Container registration object.");
    if (!reg) {
        return -1;
    }
 
    /* Fill in registered entry */
    ao2_t_ref(self, +1, "Registering container.");
    reg->registered = self;
    reg->prnt_obj = prnt_obj;
    strcpy(reg->name, name);/* safe */
 
    if (!ao2_t_link(reg_containers, reg, "Save registration object.")) {
        res = -1;
    }
 
    ao2_t_ref(reg, -1, "Done registering container.");
#endif  /* defined(AO2_DEBUG) */
    return res;
}

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_t_alloc_options, ao2_t_link, ao2_t_ref, and name.

Referenced by ast_bridging_init(), ast_channels_init(), ast_pbx_init(), load_module(), stasis_caching_topic_create(), stasis_state_manager_create(), and stasis_topic_pool_create().

ao2_container_stats()

void ao2_container_stats	(	struct ao2_container *	self,
		enum search_flags	flags,
		const char *	name,
		void *	where,
		ao2_prnt_fn *	prnt
	)

Display statistics of the specified container.

Since

12.0.0

Parameters

self	Container to display statistics.
flags	OBJ_NOLOCK if a lock is already held on the container.
name	Container name. (NULL if anonymous)
where	User data needed by prnt to determine where to put output.
prnt	Print output callback function to use.

Definition at line 819 of file astobj2_container.c.

{
    if (!is_ao2_object(self) || !self->v_table) {
        prnt(where, "Invalid container\n");
        ast_assert(0);
        return;
    }
 
    if (!(flags & OBJ_NOLOCK)) {
        ao2_rdlock(self);
    }
    if (name) {
        prnt(where, "Container name: %s\n", name);
    }
    prnt(where, "Number of objects: %d\n", self->elements);
#if defined(AO2_DEBUG)
    prnt(where, "Number of nodes: %d\n", self->nodes);
    prnt(where, "Number of empty nodes: %d\n", self->nodes - self->elements);
    /*
     * XXX
     * If the max_empty_nodes count gets out of single digits you
     * likely have a code path where ao2_iterator_destroy() is not
     * called.
     *
     * Empty nodes do not harm the container but they do make
     * container operations less efficient.
     */
    prnt(where, "Maximum empty nodes: %d\n", self->max_empty_nodes);
    if (self->v_table->stats) {
        self->v_table->stats(self, where, prnt);
    }
#endif  /* defined(AO2_DEBUG) */
    if (!(flags & OBJ_NOLOCK)) {
        ao2_unlock(self);
    }
}

References ao2_rdlock, ao2_unlock, ast_assert, ao2_container::elements, is_ao2_object, name, OBJ_NOLOCK, and ao2_container::v_table.

Referenced by astobj2_test_1_helper(), and test_traversal_sorted().

ao2_container_unregister()

void ao2_container_unregister

(

const char *

name

)

Unregister a container for CLI stats and integrity check.

Since

12.0.0

Parameters

name	Name the container is registered under.

Definition at line 985 of file astobj2_container.c.

{
#if defined(AO2_DEBUG)
    ao2_t_find(reg_containers, name, OBJ_UNLINK | OBJ_NODATA | OBJ_SEARCH_KEY,
        "Unregister container");
#endif  /* defined(AO2_DEBUG) */
}

References ao2_t_find, name, OBJ_NODATA, OBJ_SEARCH_KEY, and OBJ_UNLINK.

Referenced by bridge_cleanup(), cdr_engine_shutdown(), channels_shutdown(), load_module(), pbx_shutdown(), stasis_caching_topic_dtor(), state_manager_dtor(), topic_pool_dtor(), and unload_module().

ao2_iterator_cleanup()

void ao2_iterator_cleanup

(

struct ao2_iterator *

iter

)

Definition at line 549 of file astobj2_container.c.

{
    if (iter) {
        ao2_iterator_destroy(iter);
    }
}

References ao2_iterator_destroy().

Referenced by AST_TEST_DEFINE(), and stasis_app_set_global_debug().

ao2_iterator_count()

int ao2_iterator_count

(

struct ao2_iterator *

iter

)

Get a count of the iterated container objects.

Parameters

iter	the iterator to query

Returns

The number of objects in the iterated container

Definition at line 630 of file astobj2_container.c.

{
    return ao2_container_count(iter->c);
}

References ao2_container_count(), and ao2_iterator::c.

ao2_iterator_destroy()

void ao2_iterator_destroy

(

struct ao2_iterator *

iter

)

Destroy a container iterator.

Parameters

iter	the iterator to destroy

This function will release the container reference held by the iterator and any other resources it may be holding.

Definition at line 534 of file astobj2_container.c.

{
    /* Release any last container node reference. */
    ao2_iterator_restart(iter);
 
    /* Release the iterated container reference. */
    ao2_t_ref(iter->c, -1, "Unref iterator in ao2_iterator_destroy");
    iter->c = NULL;
 
    /* Free the malloced iterator. */
    if (iter->flags & AO2_ITERATOR_MALLOCD) {
        ast_free(iter);
    }
}

References AO2_ITERATOR_MALLOCD, ao2_iterator_restart(), ao2_t_ref, ast_free, ao2_iterator::c, ao2_iterator::flags, and NULL.

Referenced by __iax2_show_peers(), __manager_event_sessions_va(), __queues_show(), __test_cel_generate_peer_str(), aco_set_defaults(), action_agents(), action_confbridgelistrooms(), action_coreshowchannelmap(), action_coreshowchannels(), action_devicestatelist(), action_extensionstatelist(), action_meetmelist(), action_presencestatelist(), add_ice_to_stream(), aeap_tab_complete_name(), agent_show_requested(), agents_post_apply_config(), agents_sweep(), alias_show(), ami_show_registration_contact_statuses(), ao2_iterator_cleanup(), app_to_json(), ari_show_apps(), ast_add_hint(), ast_ari_bridges_list(), ast_ari_channels_list(), ast_ari_endpoints_list(), ast_ari_endpoints_list_by_tech(), ast_ari_recordings_list_stored(), ast_bridge_channel_kick(), ast_bucket_file_json(), ast_bucket_json(), ast_cdr_setvar(), ast_channel_iterator_destroy(), ast_complete_channels(), ast_endpoint_snapshot_create(), ast_format_cache_get_by_codec(), ast_merge_contexts_and_delete(), ast_msg_var_iterator_destroy(), ast_multi_channel_blob_get_channels(), ast_pickup_find_by_group(), ast_print_namedgroups(), ast_refer_var_iterator_destroy(), ast_sip_destroy_scheduler(), ast_sip_for_each_contact(), ast_sorcery_objectset_create2(), ast_sorcery_objectset_json_create(), ast_srtp_unprotect(), AST_TEST_DEFINE(), ast_var_indications(), ast_var_indications_table(), astman_verify_session_readpermissions(), astman_verify_session_writepermissions(), astobj2_test_1_helper(), auth_observer(), authenticate(), authenticate_reply(), bridge_app_subscribed_involved(), bridge_channel_event_join_leave(), bridge_channel_moving(), bridge_channel_talking(), bridges_scrape_cb(), build_cli_notify(), calendar_query_exec(), cel_generate_peer_str(), channels_scrape_cb(), check_access(), check_events(), clear_queue(), clear_stats(), cli_complete_endpoint(), cli_complete_notify(), cli_complete_registration(), cli_complete_show(), cli_complete_uri(), cli_console_active(), cli_display_named_acl_list(), cli_fax_show_sessions(), cli_list_devices(), cli_show_channels(), cli_show_modules(), cli_show_monitors(), cli_show_tasks(), cli_tps_reset_stats_all(), compare_weight(), complete_bridge_profile_name(), complete_confbridge_name(), complete_config_module(), complete_core_id(), complete_core_show_hint(), complete_country(), complete_iax2_peers(), complete_iax2_unregister(), complete_menu_name(), complete_mohclass_realtime(), complete_queue(), complete_queue_remove_member(), complete_show_sorcery_object(), complete_user_profile_name(), complete_userno(), conf_queue_dtmf(), config_hook_exec(), config_object_tab_complete_name(), configure_parking_extensions(), container_to_json_array(), control_dispatch_all(), control_flush_queue(), control_prestart_dispatch_all(), coreshowchannelmap_add_connected_channels(), destroy_pvts(), device_state_cb(), device_state_notify_callbacks(), dial_state_process_bridge_enter(), dialgroup_read(), disable_marked_lots(), dump_queue_members(), endpoints_scrape_cb(), event_session_shutdown(), exten_state_publisher_state_cb(), extension_state_cb(), fax_session_tab_complete(), find_contact(), find_queue_by_name_rt(), find_ringing_channel(), find_session(), find_session_by_nonce(), free_members(), generate_or_link_lots_to_configs(), geoloc_config_list_locations(), geoloc_config_list_profiles(), geoloc_config_show_profiles(), get_device_state_causing_channels(), get_member_status(), get_transferee(), get_udp_transport(), get_write_timeout(), handle_bridge_pairings(), handle_bridge_show_all(), handle_chanlist(), handle_cli_confbridge_list(), handle_cli_confbridge_show_bridge_profiles(), handle_cli_confbridge_show_menus(), handle_cli_confbridge_show_user_profiles(), handle_cli_iax2_show_callno_limits(), handle_cli_iax2_show_users(), handle_cli_indication_show(), handle_cli_moh_show_classes(), handle_cli_moh_show_files(), handle_cli_moh_unregister_class(), handle_cli_odbc_show(), handle_cli_sound_show(), handle_cli_status(), handle_export_primitives(), handle_kickmanconn(), handle_manager_show_event(), handle_manager_show_events(), handle_show_calendar(), handle_show_calendars(), handle_show_hint(), handle_show_hints(), handle_show_named_acl_cmd(), handle_showmanconn(), handle_skel_show_games(), handle_skel_show_levels(), handle_voicemail_show_aliases(), has_mwi_subscription(), iax2_getpeername(), iax2_getpeertrunk(), interface_exists(), ip_identify_apply(), is_longest_waiting_caller(), jingle_add_google_candidates_to_transport(), jingle_add_ice_udp_candidates_to_transport(), jingle_request(), keepalive_transport_thread(), kill_duplicate_offers(), load_users(), local_devicestate(), locals_show(), manager_fax_sessions(), manager_iax2_show_peer_list(), manager_parking_status_all_lots(), manager_parking_status_single_lot(), manager_queues_status(), manager_queues_summary(), mark_lots_as_disabled(), media_cache_handle_show_item(), meetme_menu_admin_extended(), meetme_show_cmd(), moh_rescan_files(), msg_func_write(), mwi_contact_deleted(), mwi_initial_events(), mwi_mailbox_delete_all(), mwi_mailbox_get(), mwi_subscription_mailboxes_str(), num_available_members(), parking_lot_get_space(), pjsip_acf_dial_contacts_read(), pjsip_aor_function_read(), poke_all_peers(), pp_each_user_helper(), presence_state_cb(), presence_state_notify_callbacks(), print_queue(), prune_peers(), prune_users(), purge_sessions(), queue_function_mem_read(), queue_function_qac_dep(), queue_function_queuememberlist(), queue_mwi_event(), qupd_exec(), reload(), reload_single_queue(), remove_all_configured_parking_lot_extensions(), remove_pending_parking_lot_extensions(), rt_handle_member_record(), set_member_paused(), set_member_value(), set_transfer_variables_all(), show_codecs(), single_state_process_bridge_enter(), sip_options_apply_aor_configuration(), sip_options_cleanup_task(), sip_options_endpoint_unlink_aor_feeders(), sip_options_get_endpoint_state_compositor_state(), sip_outbound_publish_synchronize(), sla_calc_station_delays(), sla_change_trunk_state(), sla_queue_event_conf(), sla_show_stations(), sla_show_trunks(), sorcery_memory_cache_complete_name(), sorcery_memory_cache_complete_object_name(), stasis_app_mailboxes_to_json(), stasis_app_to_cli(), stasis_show_topics(), stop_streams(), system_create_resolver_and_set_nameservers(), test_ao2_callback_traversal(), test_ao2_iteration(), test_container_clone(), test_expected_duplicates(), topic_complete_name(), tps_report_taskprocessor_list(), tps_taskprocessor_tab_complete(), transport_state_do_reg_callbacks(), try_calling(), unbound_config_preapply(), update_queue(), update_realtime_members(), xmpp_pubsub_create_affiliations(), xmpp_show_buddies(), and xmpp_show_clients().

ao2_iterator_init()

struct ao2_iterator ao2_iterator_init	(	struct ao2_container *	c,
		int	flags
	)

Create an iterator for a container.

initialize an iterator so we start from the first object

Definition at line 485 of file astobj2_container.c.

{
    struct ao2_iterator a = {
        .c = c,
        .flags = flags
    };
 
    ao2_t_ref(c, +1, "Init iterator with container.");
 
    return a;
}

References a, ao2_t_ref, c, and ao2_iterator::flags.

Referenced by __iax2_show_peers(), __manager_event_sessions_va(), __queues_show(), __test_cel_generate_peer_str(), aco_set_defaults(), action_agents(), action_confbridgelistrooms(), action_coreshowchannelmap(), action_coreshowchannels(), action_devicestatelist(), action_extensionstatelist(), action_meetmelist(), action_presencestatelist(), add_ice_to_stream(), aeap_tab_complete_name(), agent_show_requested(), agents_post_apply_config(), alias_show(), ami_show_registration_contact_statuses(), app_to_json(), ari_show_apps(), ast_add_hint(), ast_ari_bridges_list(), ast_ari_channels_list(), ast_ari_endpoints_list(), ast_ari_endpoints_list_by_tech(), ast_ari_recordings_list_stored(), ast_bridge_channel_kick(), ast_bucket_file_json(), ast_bucket_json(), ast_channel_iterator_all_new(), ast_complete_channels(), ast_endpoint_snapshot_create(), ast_format_cache_get_by_codec(), ast_merge_contexts_and_delete(), ast_msg_var_iterator_init(), ast_pickup_find_by_group(), ast_print_namedgroups(), ast_refer_var_iterator_init(), ast_sip_destroy_scheduler(), ast_sip_for_each_contact(), ast_sorcery_objectset_create2(), ast_sorcery_objectset_json_create(), ast_srtp_unprotect(), AST_TEST_DEFINE(), ast_tone_zone_iterator_init(), astman_verify_session_readpermissions(), astman_verify_session_writepermissions(), astobj2_test_1_helper(), auth_observer(), authenticate(), authenticate_reply(), bridge_app_subscribed_involved(), bridge_channel_event_join_leave(), bridge_channel_moving(), bridge_channel_talking(), bridges_scrape_cb(), build_cli_notify(), calendar_query_exec(), cel_generate_peer_str(), channels_scrape_cb(), check_access(), check_events(), clear_queue(), clear_stats(), cli_complete_endpoint(), cli_complete_notify(), cli_complete_registration(), cli_complete_show(), cli_complete_uri(), cli_console_active(), cli_display_named_acl_list(), cli_fax_show_sessions(), cli_list_devices(), cli_show_channels(), cli_show_modules(), cli_show_monitors(), cli_show_tasks(), cli_tps_reset_stats_all(), compare_weight(), complete_bridge_profile_name(), complete_confbridge_name(), complete_config_module(), complete_core_id(), complete_core_show_hint(), complete_country(), complete_iax2_peers(), complete_iax2_unregister(), complete_menu_name(), complete_mohclass_realtime(), complete_queue(), complete_queue_remove_member(), complete_show_sorcery_object(), complete_user_profile_name(), complete_userno(), conf_queue_dtmf(), config_hook_exec(), config_object_tab_complete_name(), configure_parking_extensions(), container_to_json_array(), control_dispatch_all(), control_flush_queue(), control_prestart_dispatch_all(), coreshowchannelmap_add_connected_channels(), destroy_pvts(), device_state_cb(), device_state_notify_callbacks(), dial_state_process_bridge_enter(), dialgroup_read(), disable_marked_lots(), dump_queue_members(), endpoints_scrape_cb(), event_session_shutdown(), exten_state_publisher_state_cb(), extension_state_cb(), fax_session_tab_complete(), find_contact(), find_queue_by_name_rt(), find_ringing_channel(), find_session(), find_session_by_nonce(), free_members(), generate_or_link_lots_to_configs(), geoloc_config_list_locations(), geoloc_config_list_profiles(), geoloc_config_show_profiles(), get_device_state_causing_channels(), get_member_status(), get_transferee(), get_udp_transport(), get_write_timeout(), handle_bridge_pairings(), handle_bridge_show_all(), handle_chanlist(), handle_cli_confbridge_list(), handle_cli_confbridge_show_bridge_profiles(), handle_cli_confbridge_show_menus(), handle_cli_confbridge_show_user_profiles(), handle_cli_iax2_show_callno_limits(), handle_cli_iax2_show_users(), handle_cli_moh_show_classes(), handle_cli_moh_show_files(), handle_cli_moh_unregister_class(), handle_cli_odbc_show(), handle_cli_sound_show(), handle_cli_status(), handle_export_primitives(), handle_kickmanconn(), handle_manager_show_event(), handle_show_calendar(), handle_show_calendars(), handle_show_hint(), handle_show_hints(), handle_show_named_acl_cmd(), handle_showmanconn(), handle_skel_show_games(), handle_skel_show_levels(), handle_voicemail_show_aliases(), iax2_getpeername(), iax2_getpeertrunk(), interface_exists(), internal_ao2_traverse(), ip_identify_apply(), is_longest_waiting_caller(), jingle_add_google_candidates_to_transport(), jingle_add_ice_udp_candidates_to_transport(), jingle_request(), keepalive_transport_thread(), load_users(), local_devicestate(), locals_show(), manager_fax_sessions(), manager_iax2_show_peer_list(), manager_parking_status_all_lots(), manager_parking_status_single_lot(), manager_queues_status(), manager_queues_summary(), mark_lots_as_disabled(), media_cache_handle_show_item(), meetme_menu_admin_extended(), meetme_show_cmd(), moh_rescan_files(), msg_func_write(), mwi_initial_events(), mwi_mailbox_delete_all(), mwi_mailbox_get(), mwi_subscription_mailboxes_str(), num_available_members(), parking_lot_get_space(), pjsip_acf_dial_contacts_read(), pjsip_aor_function_read(), poke_all_peers(), pp_each_user_helper(), presence_state_notify_callbacks(), print_queue(), prune_peers(), prune_users(), purge_sessions(), queue_function_mem_read(), queue_function_qac_dep(), queue_function_queuememberlist(), qupd_exec(), reload(), reload_single_queue(), remove_all_configured_parking_lot_extensions(), remove_pending_parking_lot_extensions(), rt_handle_member_record(), set_member_paused(), set_member_value(), set_transfer_variables_all(), show_codecs(), single_state_process_bridge_enter(), sip_options_apply_aor_configuration(), sip_options_cleanup_task(), sip_options_endpoint_unlink_aor_feeders(), sip_options_get_endpoint_state_compositor_state(), sip_outbound_publish_synchronize(), sla_calc_station_delays(), sla_change_trunk_state(), sla_queue_event_conf(), sla_show_stations(), sla_show_trunks(), sorcery_memory_cache_complete_name(), sorcery_memory_cache_complete_object_name(), stasis_app_mailboxes_to_json(), stasis_app_set_global_debug(), stasis_show_topics(), stop_streams(), system_create_resolver_and_set_nameservers(), test_ao2_iteration(), test_container_clone(), topic_complete_name(), tps_report_taskprocessor_list(), tps_shutdown(), tps_taskprocessor_tab_complete(), try_calling(), unbound_config_preapply(), update_queue(), update_realtime_members(), xmpp_pubsub_create_affiliations(), xmpp_show_buddies(), and xmpp_show_clients().

ao2_iterator_restart()

void ao2_iterator_restart

(

struct ao2_iterator *

iter

)

Restart an iteration.

Parameters

iter	the iterator to restart

Note

A restart is not going to have any effect if the iterator was created with the AO2_ITERATOR_UNLINK flag. Any previous objects returned were removed from the container.

Definition at line 497 of file astobj2_container.c.

{
    if (!is_ao2_object(iter->c)) {
        /* Sanity check. */
        return;
    }
 
    /* Release the last container node reference if we have one. */
    if (iter->last_node) {
        enum ao2_lock_req orig_lock;
 
        /*
         * Do a read lock in case the container node unref does not
         * destroy the node.  If the container node is destroyed then
         * the lock will be upgraded to a write lock.
         */
        if (iter->flags & AO2_ITERATOR_DONTLOCK) {
            orig_lock = __adjust_lock(iter->c, AO2_LOCK_REQ_RDLOCK, 1);
        } else {
            orig_lock = AO2_LOCK_REQ_MUTEX;
            ao2_rdlock(iter->c);
        }
 
        ao2_ref(iter->last_node, -1);
        iter->last_node = NULL;
 
        if (iter->flags & AO2_ITERATOR_DONTLOCK) {
            __adjust_lock(iter->c, orig_lock, 0);
        } else {
            ao2_unlock(iter->c);
        }
    }
 
    /* The iteration is no longer complete. */
    iter->complete = 0;
}

References __adjust_lock(), AO2_ITERATOR_DONTLOCK, AO2_LOCK_REQ_MUTEX, AO2_LOCK_REQ_RDLOCK, ao2_rdlock, ao2_ref, ao2_unlock, ao2_iterator::c, ao2_iterator::complete, ao2_iterator::flags, is_ao2_object, ao2_iterator::last_node, and NULL.

Referenced by ao2_iterator_destroy().

ao2_match_by_addr()

int ao2_match_by_addr	(	void *	user_data,
		void *	arg,
		int	flags
	)

another convenience function is a callback that matches on address

A common ao2_callback is one that matches by address.

Definition at line 166 of file astobj2_container.c.

{
    return (user_data == arg) ? (CMP_MATCH | CMP_STOP) : 0;
}

References CMP_MATCH, and CMP_STOP.

Referenced by __ao2_unlink(), load_module(), and test_container_clone().

cb_true()

static int cb_true ( void *  user_data, void *  arg, int  flags  )

static

special callback that matches all

Definition at line 193 of file astobj2_container.c.

{
    return CMP_MATCH;
}

References CMP_MATCH.

Referenced by internal_ao2_traverse().

cb_true_data()

static int cb_true_data ( void *  user_data, void *  arg, void *  data, int  flags  )

static

similar to cb_true, but is an ao2_callback_data_fn instead

Definition at line 201 of file astobj2_container.c.

{
    return CMP_MATCH;
}

References CMP_MATCH.

Referenced by internal_ao2_traverse().

container_destruct()

void container_destruct

(

void *

_c

)

Definition at line 635 of file astobj2_container.c.

{
    struct ao2_container *c = _c;
 
    /* Unlink any stored objects in the container. */
    c->destroying = 1;
    ao2_t_callback(c, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL,
        "container_destruct called");
 
    /* Perform any extra container cleanup. */
    if (c->v_table && c->v_table->destroy) {
        c->v_table->destroy(c);
    }
 
#if defined(AO2_DEBUG)
    ast_atomic_fetchadd_int(&ao2.total_containers, -1);
#endif
}

References ao2_t_callback, ast_atomic_fetchadd_int(), c, NULL, OBJ_MULTIPLE, OBJ_NODATA, and OBJ_UNLINK.

Referenced by __ao2_container_alloc_hash(), and __ao2_container_alloc_rbtree().

container_init()

int container_init

(

void

)

Definition at line 1181 of file astobj2_container.c.

{
#if defined(AO2_DEBUG)
    reg_containers = ao2_t_container_alloc_list(AO2_ALLOC_OPT_LOCK_RWLOCK,
        AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE, ao2_reg_sort_cb, NULL,
        "Container registration container.");
    if (!reg_containers) {
        return -1;
    }
 
    ast_cli_register_multiple(cli_astobj2, ARRAY_LEN(cli_astobj2));
    ast_register_cleanup(container_cleanup);
#endif  /* defined(AO2_DEBUG) */
 
    return 0;
}

References AO2_ALLOC_OPT_LOCK_RWLOCK, AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE, ao2_t_container_alloc_list, ARRAY_LEN, ast_cli_register_multiple, ast_register_cleanup(), and NULL.

Referenced by astobj2_init().

dup_obj_cb()

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

static

Definition at line 666 of file astobj2_container.c.

{
    struct ao2_container *dest = arg;
 
    return ao2_link_flags(dest, obj, OBJ_NOLOCK) ? 0 : (CMP_MATCH | CMP_STOP);
}

References ao2_link_flags, CMP_MATCH, CMP_STOP, and OBJ_NOLOCK.

Referenced by ao2_container_dup().

dup_weakproxy_cb()

static int dup_weakproxy_cb ( void *  proxy, void *  arg, int  flags  )

static

Copy obj associated with a weakproxy into the arg container.

Parameters

proxy	pointer to the weakproxy.
arg	callback argument from ao2_callback()
flags	flags from ao2_callback()

Return values

0	on success.
CMP_STOP|CMP_MATCH	on error.

Definition at line 710 of file astobj2_container.c.

{
    void *obj = ao2_weakproxy_get_object(proxy, 0);
    struct ao2_container *dest = arg;
    int ret;
 
    if (!obj) {
        return 0;
    }
 
    ret = ao2_link_flags(dest, obj, OBJ_NOLOCK) ? 0 : (CMP_MATCH | CMP_STOP);
    ao2_ref(obj, -1);
 
    return ret;
}

References ao2_link_flags, ao2_ref, ao2_weakproxy_get_object, CMP_MATCH, CMP_STOP, and OBJ_NOLOCK.

Referenced by ao2_container_dup_weakproxy_objs().

internal_ao2_traverse()

static void * internal_ao2_traverse ( struct ao2_container *  self, enum search_flags  flags, void *  cb_fn, void *  arg, void *  data, enum ao2_callback_type  type, const char *  tag, const char *  file, int  line, const char *  func  )

static

Definition at line 230 of file astobj2_container.c.

{
    void *ret;
    ao2_callback_fn *cb_default = NULL;
    ao2_callback_data_fn *cb_withdata = NULL;
    struct ao2_container_node *node;
    void *traversal_state;
 
    enum ao2_lock_req orig_lock;
    struct ao2_container *multi_container = NULL;
    struct ao2_iterator *multi_iterator = NULL;
 
    if (!__is_ao2_object(self, file, line, func)) {
        return NULL;
    }
 
    if (!self->v_table
        || !self->v_table->traverse_first || !self->v_table->traverse_next) {
        /* Sanity checks. */
        __ast_assert_failed(0, "invalid container v_table", file, line, func);
        return NULL;
    }
 
    /*
     * This logic is used so we can support OBJ_MULTIPLE with OBJ_NODATA
     * turned off.  This if statement checks for the special condition
     * where multiple items may need to be returned.
     */
    if ((flags & (OBJ_MULTIPLE | OBJ_NODATA)) == OBJ_MULTIPLE) {
        /* we need to return an ao2_iterator with the results,
         * as there could be more than one. the iterator will
         * hold the only reference to a container that has all the
         * matching objects linked into it, so when the iterator
         * is destroyed, the container will be automatically
         * destroyed as well.
         */
        multi_container = ao2_t_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0, NULL,
            NULL, "OBJ_MULTIPLE return container creation");
        if (!multi_container) {
            return NULL;
        }
        if (!(multi_iterator = ast_calloc(1, sizeof(*multi_iterator)))) {
            ao2_t_ref(multi_container, -1, "OBJ_MULTIPLE interator creation failed.");
            return NULL;
        }
    }
 
    if (!cb_fn) {
        /* Match everything if no callback match function provided. */
        if (type == AO2_CALLBACK_WITH_DATA) {
            cb_withdata = cb_true_data;
        } else {
            cb_default = cb_true;
        }
    } else {
        /*
         * We do this here to avoid the per object casting penalty (even
         * though that is probably optimized away anyway).
         */
        if (type == AO2_CALLBACK_WITH_DATA) {
            cb_withdata = cb_fn;
        } else {
            cb_default = cb_fn;
        }
    }
 
    /* avoid modifications to the content */
    if (flags & OBJ_NOLOCK) {
        if (flags & OBJ_UNLINK) {
            orig_lock = __adjust_lock(self, AO2_LOCK_REQ_WRLOCK, 1);
        } else {
            orig_lock = __adjust_lock(self, AO2_LOCK_REQ_RDLOCK, 1);
        }
    } else {
        orig_lock = AO2_LOCK_REQ_MUTEX;
        if (flags & OBJ_UNLINK) {
            ao2_wrlock(self);
        } else {
            ao2_rdlock(self);
        }
    }
 
    /* Create a buffer for the traversal state. */
    traversal_state = alloca(AO2_TRAVERSAL_STATE_SIZE);
 
    ret = NULL;
    for (node = self->v_table->traverse_first(self, flags, arg, traversal_state);
        node;
        node = self->v_table->traverse_next(self, traversal_state, node)) {
        int match;
 
        /* Visit the current node. */
        match = (CMP_MATCH | CMP_STOP);
        if (type == AO2_CALLBACK_WITH_DATA) {
            match &= cb_withdata(node->obj, arg, data, flags);
        } else {
            match &= cb_default(node->obj, arg, flags);
        }
        if (match == 0) {
            /* no match, no stop, continue */
            continue;
        }
        if (match == CMP_STOP) {
            /* no match but stop, we are done */
            break;
        }
 
        /*
         * CMP_MATCH is set here
         *
         * we found the object, performing operations according to flags
         */
        if (node->obj) {
            /* The object is still in the container. */
            if (!(flags & OBJ_NODATA)) {
                /*
                 * We are returning the object, record the value.  It is
                 * important to handle this case before the unlink.
                 */
                if (multi_container) {
                    /*
                     * Link the object into the container that will hold the
                     * results.
                     */
                    __ao2_link(multi_container, node->obj, flags, tag, file, line, func);
                } else {
                    ret = node->obj;
                    /* Returning a single object. */
                    if (!(flags & OBJ_UNLINK)) {
                        /*
                         * Bump the ref count since we are not going to unlink and
                         * transfer the container's object ref to the returned object.
                         */
                        __ao2_ref(ret, 1, tag ?: "Traversal found object", file, line, func);
                    }
                }
            }
 
            if (flags & OBJ_UNLINK) {
                int ulflag = AO2_UNLINK_NODE_UNREF_NODE | AO2_UNLINK_NODE_DEC_COUNT;
                if (multi_container || (flags & OBJ_NODATA)) {
                    ulflag |= AO2_UNLINK_NODE_UNLINK_OBJECT;
                }
                __container_unlink_node_debug(node, ulflag, tag, file, line, func);
            }
        }
 
        if ((match & CMP_STOP) || !(flags & OBJ_MULTIPLE)) {
            /* We found our only (or last) match, so we are done */
            break;
        }
    }
    if (self->v_table->traverse_cleanup) {
        self->v_table->traverse_cleanup(traversal_state);
    }
    if (node) {
        /* Unref the node from self->v_table->traverse_first/traverse_next() */
        ao2_ref(node, -1);
    }
 
    if (flags & OBJ_NOLOCK) {
        __adjust_lock(self, orig_lock, 0);
    } else {
        ao2_unlock(self);
    }
 
    /* if multi_container was created, we are returning multiple objects */
    if (multi_container) {
        *multi_iterator = ao2_iterator_init(multi_container,
            AO2_ITERATOR_UNLINK | AO2_ITERATOR_MALLOCD);
        ao2_t_ref(multi_container, -1,
            "OBJ_MULTIPLE for multiple objects traversal complete.");
        return multi_iterator;
    } else {
        return ret;
    }
}

References __adjust_lock(), __ao2_link(), __ao2_ref(), __ast_assert_failed(), __container_unlink_node_debug(), __is_ao2_object, AO2_ALLOC_OPT_LOCK_NOLOCK, AO2_CALLBACK_WITH_DATA, ao2_iterator_init(), AO2_ITERATOR_MALLOCD, AO2_ITERATOR_UNLINK, AO2_LOCK_REQ_MUTEX, AO2_LOCK_REQ_RDLOCK, AO2_LOCK_REQ_WRLOCK, ao2_rdlock, ao2_ref, ao2_t_container_alloc_list, ao2_t_ref, AO2_TRAVERSAL_STATE_SIZE, AO2_UNLINK_NODE_DEC_COUNT, AO2_UNLINK_NODE_UNLINK_OBJECT, AO2_UNLINK_NODE_UNREF_NODE, ao2_unlock, ao2_wrlock, ast_calloc, cb_true(), cb_true_data(), CMP_MATCH, CMP_STOP, make_ari_stubs::file, ao2_iterator::flags, match(), NULL, OBJ_MULTIPLE, OBJ_NODATA, OBJ_NOLOCK, OBJ_UNLINK, ao2_container_methods::traverse_cleanup, ao2_container_methods::traverse_first, ao2_container_methods::traverse_next, type, and ao2_container::v_table.

Referenced by __ao2_callback(), and __ao2_callback_data().