mirror of https://github.com/asterisk/asterisk
This implements "weak" references. The weakproxy object is a real ao2 with normal reference counting of its own. When a weakproxy is pointed to a normal object they hold references to each other. The normal object is automatically freed when a single reference remains (the weakproxy). The weakproxy also supports subscriptions that will notify callbacks when it does not point to any real object. ASTERISK-24936 #close Reported by: Corey Farrell Change-Id: Ib9f73c02262488d314d9d9d62f58165b9ec43c67changes/56/56/2
parent
a573b77f78
commit
cb6bf3094e
@ -0,0 +1,259 @@
|
||||
/*
|
||||
* Asterisk -- An open source telephony toolkit.
|
||||
*
|
||||
* Copyright (C) 2015, CFWare, LLC
|
||||
*
|
||||
* Corey Farrell <git@cfware.com>
|
||||
*
|
||||
* See http://www.asterisk.org for more information about
|
||||
* the Asterisk project. Please do not directly contact
|
||||
* any of the maintainers of this project for assistance;
|
||||
* the project provides a web site, mailing lists and IRC
|
||||
* channels for your use.
|
||||
*
|
||||
* This program is free software, distributed under the terms of
|
||||
* the GNU General Public License Version 2. See the LICENSE file
|
||||
* at the top of the source tree.
|
||||
*/
|
||||
|
||||
/*!
|
||||
* \file
|
||||
* \brief astobj2 weakproxy test module
|
||||
*
|
||||
* \author Corey Farrell <git@cfware.com>
|
||||
*/
|
||||
|
||||
/*** MODULEINFO
|
||||
<depend>TEST_FRAMEWORK</depend>
|
||||
<support_level>core</support_level>
|
||||
***/
|
||||
|
||||
#include "asterisk.h"
|
||||
|
||||
ASTERISK_FILE_VERSION(__FILE__, "$Revision: 419175 $")
|
||||
|
||||
#include "asterisk/utils.h"
|
||||
#include "asterisk/module.h"
|
||||
#include "asterisk/test.h"
|
||||
#include "asterisk/astobj2.h"
|
||||
|
||||
static int destructor_called;
|
||||
static int weakproxydestroyed;
|
||||
|
||||
static void test_obj_destructor(void *obj)
|
||||
{
|
||||
destructor_called++;
|
||||
}
|
||||
|
||||
static void weakproxy_destructor(void *obj)
|
||||
{
|
||||
weakproxydestroyed++;
|
||||
}
|
||||
|
||||
static void test_obj_destroy_notify(void *obj, void *data)
|
||||
{
|
||||
int *i = data;
|
||||
|
||||
++*i;
|
||||
}
|
||||
|
||||
struct my_weakproxy {
|
||||
AO2_WEAKPROXY();
|
||||
int f1;
|
||||
};
|
||||
|
||||
AST_TEST_DEFINE(astobj2_weak1)
|
||||
{
|
||||
void *obj1 = NULL;
|
||||
void *obj2 = NULL;
|
||||
void *obj3 = NULL;
|
||||
void *strong1 = NULL;
|
||||
struct my_weakproxy *weakref1 = NULL;
|
||||
struct my_weakproxy *weakref2 = NULL;
|
||||
int notify0_called = 0;
|
||||
int notify1_called = 0;
|
||||
int notify2_called = 0;
|
||||
int notify3_called = 0;
|
||||
|
||||
switch (cmd) {
|
||||
case TEST_INIT:
|
||||
info->name = "astobj2_weak1";
|
||||
info->category = "/main/astobj2/";
|
||||
info->summary = "Test ao2 weak objects";
|
||||
info->description = "Test ao2 weak objects.";
|
||||
return AST_TEST_NOT_RUN;
|
||||
case TEST_EXECUTE:
|
||||
break;
|
||||
}
|
||||
|
||||
destructor_called = weakproxydestroyed = 0;
|
||||
obj1 = ao2_t_alloc(0, test_obj_destructor, "obj1");
|
||||
if (!obj1) {
|
||||
return AST_TEST_FAIL;
|
||||
}
|
||||
|
||||
weakref1 = ao2_t_weakproxy_alloc(sizeof(*weakref1), weakproxy_destructor, "weakref1");
|
||||
if (!weakref1) {
|
||||
ast_test_status_update(test, "Failed to allocate weakref1.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
weakref1->f1 = 5315;
|
||||
|
||||
if (ao2_weakproxy_subscribe(weakref1, test_obj_destroy_notify, ¬ify0_called, 0)) {
|
||||
ast_test_status_update(test, "Failed to subscribe to weakref1.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
if (!notify0_called) {
|
||||
ast_test_status_update(test, "Subscribe failed to immediately run callback for empty weakproxy.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
|
||||
if (ao2_t_weakproxy_set_object(weakref1, obj1, 0, "set weakref1 to obj1")) {
|
||||
ast_test_status_update(test, "Failed to set obj1 on weakref1.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
|
||||
if (ao2_weakproxy_subscribe(weakref1, test_obj_destroy_notify, ¬ify1_called, 0)) {
|
||||
ast_test_status_update(test, "Failed to add a subscription to weakref1.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
|
||||
weakref2 = ao2_t_get_weakproxy(obj1, "get weakref2 from obj1");
|
||||
if (weakref1 != weakref2) {
|
||||
ast_test_status_update(test, "weakref1 != weakref2.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
|
||||
if (ao2_weakproxy_subscribe(weakref2, test_obj_destroy_notify, ¬ify2_called, 0)) {
|
||||
ast_test_status_update(test, "Failed to add a subscription to weakref2.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
|
||||
if (ao2_weakproxy_subscribe(weakref2, test_obj_destroy_notify, ¬ify2_called, 0)) {
|
||||
ast_test_status_update(test, "Failed to add a duplicate subscription to weakref2.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
|
||||
if (ao2_weakproxy_subscribe(weakref2, test_obj_destroy_notify, ¬ify2_called, 0)) {
|
||||
ast_test_status_update(test, "Failed to add a second duplicate subscription to weakref2.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
|
||||
if (ao2_weakproxy_unsubscribe(weakref2, test_obj_destroy_notify, ¬ify2_called, 0) != 1) {
|
||||
ast_test_status_update(test, "Failed to remove a subscription to weakref2.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
|
||||
ao2_t_cleanup(weakref1, "weakref1");
|
||||
ao2_t_cleanup(weakref2, "weakref2");
|
||||
|
||||
weakref2 = ao2_t_get_weakproxy(obj1, "get weakref2 from obj1");
|
||||
if (weakref1 != weakref2) {
|
||||
weakref1 = NULL;
|
||||
ast_test_status_update(test, "weakref1 != weakref2.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
weakref1 = NULL;
|
||||
|
||||
obj2 = ao2_t_alloc(0, NULL, "obj2");
|
||||
if (obj2) {
|
||||
int ret = ao2_t_weakproxy_set_object(weakref2, obj2, 0, "set weakref2 to obj2");
|
||||
|
||||
ao2_ref(obj2, -1);
|
||||
if (!ret) {
|
||||
ast_test_status_update(test, "Set obj2 to weakref2 when it already had an object.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
}
|
||||
|
||||
if (ao2_weakproxy_subscribe(weakref2, test_obj_destroy_notify, ¬ify3_called, 0)) {
|
||||
ast_test_status_update(test, "Failed to add a subscription to weakref2.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
|
||||
if (ao2_weakproxy_subscribe(weakref2, test_obj_destroy_notify, ¬ify3_called, 0)) {
|
||||
ast_test_status_update(test, "Failed to add a duplicate subscription to weakref2.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
|
||||
if (ao2_weakproxy_unsubscribe(weakref2, test_obj_destroy_notify, ¬ify3_called, OBJ_MULTIPLE) != 2) {
|
||||
ast_test_status_update(test, "Failed to remove the correct number of subscriptions to weakref2.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
|
||||
if (destructor_called || notify1_called || notify2_called || notify3_called) {
|
||||
ast_test_status_update(test, "Destructor or notifications called early.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
|
||||
strong1 = ao2_t_weakproxy_get_object(weakref2, 0, "get strong1 from weakref2");
|
||||
ao2_t_cleanup(strong1, "strong1");
|
||||
|
||||
if (obj1 != strong1) {
|
||||
ast_test_status_update(test, "obj1 != strong1.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
|
||||
if (destructor_called || notify1_called || notify2_called || notify3_called) {
|
||||
ast_test_status_update(test, "Destructor or notification called early.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
|
||||
ao2_t_ref(obj1, -1, "obj1");
|
||||
obj1 = NULL;
|
||||
|
||||
if (destructor_called != 1 || notify1_called != 1 || notify2_called != 2 || notify3_called != 0) {
|
||||
ast_test_status_update(test, "Destructor or notification not called the expected number of times.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
|
||||
if (ao2_t_weakproxy_get_object(weakref2, 0, "impossible get of weakref2") != NULL) {
|
||||
ast_test_status_update(test, "Get object on weakref2 worked when it shouldn't\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
|
||||
obj3 = ao2_t_alloc(0, test_obj_destructor, "obj3");
|
||||
if (!obj3) {
|
||||
ast_test_status_update(test, "Failed to allocate obj3.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
|
||||
if (ao2_t_weakproxy_set_object(weakref2, obj3, 0, "set weakref2 to obj3")) {
|
||||
ast_test_status_update(test, "Failed to set obj3 to weakref2.\n");
|
||||
goto fail_cleanup;
|
||||
}
|
||||
|
||||
ao2_ref(obj3, -1);
|
||||
ao2_t_ref(weakref2, -1, "weakref2");
|
||||
|
||||
if (!weakproxydestroyed) {
|
||||
ast_test_status_update(test, "Destructor never called for weakproxy, likely a leak.\n");
|
||||
return AST_TEST_FAIL;
|
||||
}
|
||||
|
||||
return AST_TEST_PASS;
|
||||
|
||||
fail_cleanup:
|
||||
ao2_cleanup(obj1);
|
||||
ao2_cleanup(obj3);
|
||||
ao2_cleanup(weakref1);
|
||||
ao2_cleanup(weakref2);
|
||||
|
||||
return AST_TEST_FAIL;
|
||||
}
|
||||
|
||||
static int unload_module(void)
|
||||
{
|
||||
AST_TEST_UNREGISTER(astobj2_weak1);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
static int load_module(void)
|
||||
{
|
||||
AST_TEST_REGISTER(astobj2_weak1);
|
||||
|
||||
return AST_MODULE_LOAD_SUCCESS;
|
||||
}
|
||||
|
||||
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "ASTOBJ2 Weak Reference Unit Tests");
|
Loading…
Reference in new issue