test_sched.c File Reference

ast_sched performance test module More...

#include "asterisk.h"
#include <inttypes.h>
#include "asterisk/module.h"
#include "asterisk/utils.h"
#include "asterisk/sched.h"
#include "asterisk/test.h"
#include "asterisk/cli.h"
#include "asterisk/astobj2.h"

Include dependency graph for test_sched.c:

Go to the source code of this file.

Data Structures
struct	test_obj

Macros
#define	DELAYED_SAME_EXPIRE   300 /* ms */

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
struct ast_module *	AST_MODULE_SELF_SYM (void)
	AST_TEST_DEFINE (sched_test_freebird)
	AST_TEST_DEFINE (sched_test_order)
static char *	handle_cli_sched_bench (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static int	load_module (void)
static int	lockingcb (const void *data)
static int	sched_cb (const void *data)
static int	sched_order_1_cb (const void *data)
static int	sched_order_2_cb (const void *data)
static int	sched_order_3_cb (const void *data)
static int	sched_order_4_cb (const void *data)
static int	sched_order_5_cb (const void *data)
static int	sched_order_6_cb (const void *data)
static int	sched_order_7_cb (const void *data)
static int	sched_order_8_cb (const void *data)
static void	sched_order_check (struct ast_test *test, int order)
static void	test_obj_cleanup (void *data)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "ast_sched performance test module" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }
static const struct ast_module_info *	ast_module_info = &__mod_info
static struct ast_cli_entry	cli_sched []
static int	order_check
static int	order_check_failed

Detailed Description

ast_sched performance test module

Author

Russell Bryant russe.nosp@m.ll@d.nosp@m.igium.nosp@m..com

Definition in file test_sched.c.

Macro Definition Documentation

DELAYED_SAME_EXPIRE

#define DELAYED_SAME_EXPIRE   300 /* ms */

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 486 of file test_sched.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 486 of file test_sched.c.

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 486 of file test_sched.c.

AST_TEST_DEFINE() [1/2]

AST_TEST_DEFINE

(

sched_test_freebird

)

Definition at line 376 of file test_sched.c.

{
    struct test_obj * obj;
    struct ast_sched_context * con;
    enum ast_test_result_state res = AST_TEST_FAIL;
    int refs;
 
    switch (cmd) {
    case TEST_INIT:
        info->name = "sched_test_freebird";
        info->category = "/main/sched/";
        info->summary = "Test deadlock avoidance and double-unref";
        info->description =
            "This tests a call to AST_SCHED_DEL_UNREF on a running event.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        res = AST_TEST_PASS;
        break;
    }
 
    obj = ao2_alloc(sizeof(struct test_obj), test_obj_cleanup);
    if (!obj) {
        ast_test_status_update(test,
                "ao2_alloc() did not return an object\n");
        return AST_TEST_FAIL;
    }
 
    obj->scheduledCBstarted = 0;
 
    con = ast_sched_context_create();
    if (!con) {
        ast_test_status_update(test,
                "ast_sched_context_create() did not return a context\n");
        ao2_cleanup(obj);
        return AST_TEST_FAIL;
    }
 
    if (ast_sched_start_thread(con)) {
        ast_test_status_update(test, "Failed to start test thread\n");
        ao2_cleanup(obj);
        ast_sched_context_destroy(con);
        return AST_TEST_FAIL;
    }
 
    /* This double reference is to ensure that the object isn't destroyed prematurely
     * in a case where it is unreffed an additional time.
     */
    ao2_ref(obj, +2);
    if ((obj->id = ast_sched_add(con, 0, lockingcb, obj)) == -1) {
        ast_test_status_update(test, "Failed to add scheduler entry\n");
        ao2_ref(obj, -3);
        ast_sched_context_destroy(con);
        return AST_TEST_FAIL;
    }
 
    ast_mutex_lock(&obj->lock);
    while(obj->scheduledCBstarted == 0) {
        /* Wait for the scheduled thread to indicate that it has started so we can
         * then call the AST_SCHED_DEL_UNREF macro
         */
        ast_cond_wait(&obj->cond,&obj->lock);
    }
    ast_mutex_unlock(&obj->lock);
 
    ast_test_status_update(test, "Received signal, calling Scedule and UNREF\n");
    ast_test_status_update(test, "ID: %d\n", obj->id);
    AST_SCHED_DEL_UNREF(con, obj->id, ao2_ref(obj, -1));
 
    refs = ao2_ref(obj, 0);
 
    switch(refs){
        case 2:
            ast_test_status_update(test, "Correct number of references '2'\n");
            break;
        default:
            ast_test_status_update(test, "Incorrect number of references '%d'\n",
                refs);
            res = AST_TEST_FAIL;
            break;
    }
 
    /* Based on success or failure, the refcount could change
     */
    while(ao2_ref(obj, -1) > 1);
 
    ast_sched_context_destroy(con);
 
    return res;
}

References ao2_alloc, ao2_cleanup, ao2_ref, ast_cond_wait, ast_mutex_lock, ast_mutex_unlock, ast_sched_add(), ast_sched_context_create(), ast_sched_context_destroy(), AST_SCHED_DEL_UNREF, ast_sched_start_thread(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, ast_test_status_update, test_obj::cond, test_obj::id, sip_to_pjsip::info(), test_obj::lock, lockingcb(), test_obj::scheduledCBstarted, TEST_EXECUTE, TEST_INIT, and test_obj_cleanup().

AST_TEST_DEFINE() [2/2]

AST_TEST_DEFINE

(

sched_test_order

)

Definition at line 108 of file test_sched.c.

{
    struct ast_sched_context *con;
    enum ast_test_result_state res = AST_TEST_FAIL;
    int id1, id2, id3, wait;
 
    switch (cmd) {
    case TEST_INIT:
        info->name = "sched_test_order";
        info->category = "/main/sched/";
        info->summary = "Test ordering of events in the scheduler API";
        info->description =
            "This test ensures that events are properly ordered by the "
            "time they are scheduled to execute in the scheduler API.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    if (!(con = ast_sched_context_create())) {
        ast_test_status_update(test,
                "Test failed - could not create scheduler context\n");
        return AST_TEST_FAIL;
    }
 
    /* Add 3 scheduler entries, and then remove them, ensuring that the result
     * of ast_sched_wait() looks appropriate at each step along the way. */
 
    if ((wait = ast_sched_wait(con)) != -1) {
        ast_test_status_update(test,
                "ast_sched_wait() should have returned -1, returned '%d'\n",
                wait);
        goto return_cleanup;
    }
 
    if ((id1 = ast_sched_add(con, 100000, sched_cb, NULL)) == -1) {
        ast_test_status_update(test, "Failed to add scheduler entry\n");
        goto return_cleanup;
    }
 
    if ((wait = ast_sched_wait(con)) > 100000) {
        ast_test_status_update(test,
                "ast_sched_wait() should have returned <= 100000, returned '%d'\n",
                wait);
        goto return_cleanup;
    }
 
    if ((id2 = ast_sched_add(con, 10000, sched_cb, NULL)) == -1) {
        ast_test_status_update(test, "Failed to add scheduler entry\n");
        goto return_cleanup;
    }
 
    if ((wait = ast_sched_wait(con)) > 10000) {
        ast_test_status_update(test,
                "ast_sched_wait() should have returned <= 10000, returned '%d'\n",
                wait);
        goto return_cleanup;
    }
 
    if ((id3 = ast_sched_add(con, 1000, sched_cb, NULL)) == -1) {
        ast_test_status_update(test, "Failed to add scheduler entry\n");
        goto return_cleanup;
    }
 
    if ((wait = ast_sched_wait(con)) > 1000) {
        ast_test_status_update(test,
                "ast_sched_wait() should have returned <= 1000, returned '%d'\n",
                wait);
        goto return_cleanup;
    }
 
    if (ast_sched_del(con, id3) == -1) {
        ast_test_status_update(test, "Failed to remove scheduler entry\n");
        goto return_cleanup;
    }
 
    if ((wait = ast_sched_wait(con)) <= 1000) {
        ast_test_status_update(test,
                "ast_sched_wait() should have returned > 1000, returned '%d'\n",
                wait);
        goto return_cleanup;
    }
 
    if (ast_sched_del(con, id2) == -1) {
        ast_test_status_update(test, "Failed to remove scheduler entry\n");
        goto return_cleanup;
    }
 
    if ((wait = ast_sched_wait(con)) <= 10000) {
        ast_test_status_update(test,
                "ast_sched_wait() should have returned > 10000, returned '%d'\n",
                wait);
        goto return_cleanup;
    }
 
    if (ast_sched_del(con, id1) == -1) {
        ast_test_status_update(test, "Failed to remove scheduler entry\n");
        goto return_cleanup;
    }
 
    if ((wait = ast_sched_wait(con)) != -1) {
        ast_test_status_update(test,
                "ast_sched_wait() should have returned -1, returned '%d'\n",
                wait);
        goto return_cleanup;
    }
 
    /*
     * Schedule immediate and delayed entries to check the order
     * that they get executed.  They must get executed at the
     * time they expire in the order they were added.
     */
#define DELAYED_SAME_EXPIRE     300 /* ms */
    ast_test_validate_cleanup(test, -1 < ast_sched_add(con, DELAYED_SAME_EXPIRE, sched_order_1_cb, test), res, return_cleanup);
    ast_test_validate_cleanup(test, -1 < ast_sched_add(con, 0, sched_order_1_cb, test), res, return_cleanup);
    ast_test_validate_cleanup(test, -1 < ast_sched_add(con, DELAYED_SAME_EXPIRE, sched_order_2_cb, test), res, return_cleanup);
    ast_test_validate_cleanup(test, -1 < ast_sched_add(con, 0, sched_order_2_cb, test), res, return_cleanup);
    ast_test_validate_cleanup(test, -1 < ast_sched_add(con, DELAYED_SAME_EXPIRE, sched_order_3_cb, test), res, return_cleanup);
    ast_test_validate_cleanup(test, -1 < ast_sched_add(con, 0, sched_order_3_cb, test), res, return_cleanup);
    ast_test_validate_cleanup(test, -1 < ast_sched_add(con, DELAYED_SAME_EXPIRE, sched_order_4_cb, test), res, return_cleanup);
    ast_test_validate_cleanup(test, -1 < ast_sched_add(con, 0, sched_order_4_cb, test), res, return_cleanup);
    ast_test_validate_cleanup(test, -1 < ast_sched_add(con, DELAYED_SAME_EXPIRE, sched_order_5_cb, test), res, return_cleanup);
    ast_test_validate_cleanup(test, -1 < ast_sched_add(con, 0, sched_order_5_cb, test), res, return_cleanup);
    ast_test_validate_cleanup(test, -1 < ast_sched_add(con, DELAYED_SAME_EXPIRE, sched_order_6_cb, test), res, return_cleanup);
    ast_test_validate_cleanup(test, -1 < ast_sched_add(con, 0, sched_order_6_cb, test), res, return_cleanup);
    ast_test_validate_cleanup(test, -1 < ast_sched_add(con, DELAYED_SAME_EXPIRE, sched_order_7_cb, test), res, return_cleanup);
    ast_test_validate_cleanup(test, -1 < ast_sched_add(con, 0, sched_order_7_cb, test), res, return_cleanup);
    ast_test_validate_cleanup(test, -1 < ast_sched_add(con, DELAYED_SAME_EXPIRE, sched_order_8_cb, test), res, return_cleanup);
 
    /* Check order of scheduled immediate entries. */
    order_check = 0;
    order_check_failed = 0;
    usleep(50 * 1000);/* Ensure that all the immediate entries are ready to expire */
    ast_test_validate_cleanup(test, 7 == ast_sched_runq(con), res, return_cleanup);
    ast_test_validate_cleanup(test, !order_check_failed, res, return_cleanup);
 
    /* Check order of scheduled entries expiring at the same time. */
    order_check = 0;
    order_check_failed = 0;
    usleep((DELAYED_SAME_EXPIRE + 50) * 1000);/* Ensure that all the delayed entries are ready to expire */
    ast_test_validate_cleanup(test, 8 == ast_sched_runq(con), res, return_cleanup);
    ast_test_validate_cleanup(test, !order_check_failed, res, return_cleanup);
 
    if ((wait = ast_sched_wait(con)) != -1) {
        ast_test_status_update(test,
                "ast_sched_wait() should have returned -1, returned '%d'\n",
                wait);
        goto return_cleanup;
    }
 
    res = AST_TEST_PASS;
 
return_cleanup:
    ast_sched_context_destroy(con);
 
    return res;
}

References ast_sched_add(), ast_sched_context_create(), ast_sched_context_destroy(), ast_sched_del(), ast_sched_runq(), ast_sched_wait(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, ast_test_status_update, DELAYED_SAME_EXPIRE, sip_to_pjsip::info(), NULL, order_check, order_check_failed, sched_cb(), sched_order_1_cb(), sched_order_2_cb(), sched_order_3_cb(), sched_order_4_cb(), sched_order_5_cb(), sched_order_6_cb(), sched_order_7_cb(), sched_order_8_cb(), TEST_EXECUTE, and TEST_INIT.

handle_cli_sched_bench()

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

static

Definition at line 266 of file test_sched.c.

{
    struct ast_sched_context *con;
    struct timeval start;
    unsigned int num, i;
    int *sched_ids = NULL;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "sched benchmark";
        e->usage = ""
            "Usage: sched benchmark <num>\n"
            "";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    if (a->argc != e->args + 1) {
        return CLI_SHOWUSAGE;
    }
 
    if (sscanf(a->argv[e->args], "%u", &num) != 1) {
        return CLI_SHOWUSAGE;
    }
 
    if (!(con = ast_sched_context_create())) {
        ast_cli(a->fd, "Test failed - could not create scheduler context\n");
        return CLI_FAILURE;
    }
 
    if (!(sched_ids = ast_malloc(sizeof(*sched_ids) * num))) {
        ast_cli(a->fd, "Test failed - memory allocation failure\n");
        goto return_cleanup;
    }
 
    ast_cli(a->fd, "Testing ast_sched_add() performance - timing how long it takes "
            "to add %u entries at random time intervals from 0 to 60 seconds\n", num);
 
    start = ast_tvnow();
 
    for (i = 0; i < num; i++) {
        long when = labs(ast_random()) % 60000;
        if ((sched_ids[i] = ast_sched_add(con, when, sched_cb, NULL)) == -1) {
            ast_cli(a->fd, "Test failed - sched_add returned -1\n");
            goto return_cleanup;
        }
    }
 
    ast_cli(a->fd, "Test complete - %" PRIi64 " us\n", ast_tvdiff_us(ast_tvnow(), start));
 
    ast_cli(a->fd, "Testing ast_sched_del() performance - timing how long it takes "
            "to delete %u entries with random time intervals from 0 to 60 seconds\n", num);
 
    start = ast_tvnow();
 
    for (i = 0; i < num; i++) {
        if (ast_sched_del(con, sched_ids[i]) == -1) {
            ast_cli(a->fd, "Test failed - sched_del returned -1\n");
            goto return_cleanup;
        }
    }
 
    ast_cli(a->fd, "Test complete - %" PRIi64 " us\n", ast_tvdiff_us(ast_tvnow(), start));
 
return_cleanup:
    ast_sched_context_destroy(con);
    if (sched_ids) {
        ast_free(sched_ids);
    }
 
    return CLI_SUCCESS;
}

References a, ast_cli_entry::args, ast_cli(), ast_free, ast_malloc, ast_random(), ast_sched_add(), ast_sched_context_create(), ast_sched_context_destroy(), ast_sched_del(), ast_tvdiff_us(), ast_tvnow(), CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, NULL, sched_cb(), and ast_cli_entry::usage.

load_module()

static int load_module ( void  )

static

Definition at line 478 of file test_sched.c.

{
    AST_TEST_REGISTER(sched_test_order);
    AST_TEST_REGISTER(sched_test_freebird);
    ast_cli_register_multiple(cli_sched, ARRAY_LEN(cli_sched));
    return AST_MODULE_LOAD_SUCCESS;
}

References ARRAY_LEN, ast_cli_register_multiple, AST_MODULE_LOAD_SUCCESS, AST_TEST_REGISTER, and cli_sched.

lockingcb()

static int lockingcb ( const void *  data )

static

Definition at line 354 of file test_sched.c.

{
    struct test_obj *obj = (struct test_obj *)data;
    struct timespec delay = {3,0};
 
    ast_mutex_lock(&obj->lock);
 
    obj->scheduledCBstarted = 1;
    ast_cond_signal(&obj->cond);
 
    ast_mutex_unlock(&obj->lock);
 
    ao2_ref(obj, -1);
    while (nanosleep(&delay, &delay));
    /* sleep to force this scheduled event to remain running long
     * enough for the scheduling thread to unlock and call
     * AST_SCHED_DEL_UNREF
     */
 
    return 0;
}

References ao2_ref, ast_cond_signal, ast_mutex_lock, ast_mutex_unlock, test_obj::cond, test_obj::lock, and test_obj::scheduledCBstarted.

Referenced by AST_TEST_DEFINE().

sched_cb()

static int sched_cb ( const void *  data )

static

Definition at line 42 of file test_sched.c.

{
    return 0;
}

Referenced by AST_TEST_DEFINE(), and handle_cli_sched_bench().

sched_order_1_cb()

static int sched_order_1_cb ( const void *  data )

static

Definition at line 60 of file test_sched.c.

{
    sched_order_check((void *) data, 1);
    return 0;
}

References sched_order_check().

Referenced by AST_TEST_DEFINE().

sched_order_2_cb()

static int sched_order_2_cb ( const void *  data )

static

Definition at line 66 of file test_sched.c.

{
    sched_order_check((void *) data, 2);
    return 0;
}

References sched_order_check().

Referenced by AST_TEST_DEFINE().

sched_order_3_cb()

static int sched_order_3_cb ( const void *  data )

static

Definition at line 72 of file test_sched.c.

{
    sched_order_check((void *) data, 3);
    return 0;
}

References sched_order_check().

Referenced by AST_TEST_DEFINE().

sched_order_4_cb()

static int sched_order_4_cb ( const void *  data )

static

Definition at line 78 of file test_sched.c.

{
    sched_order_check((void *) data, 4);
    return 0;
}

References sched_order_check().

Referenced by AST_TEST_DEFINE().

sched_order_5_cb()

static int sched_order_5_cb ( const void *  data )

static

Definition at line 84 of file test_sched.c.

{
    sched_order_check((void *) data, 5);
    return 0;
}

References sched_order_check().

Referenced by AST_TEST_DEFINE().

sched_order_6_cb()

static int sched_order_6_cb ( const void *  data )

static

Definition at line 90 of file test_sched.c.

{
    sched_order_check((void *) data, 6);
    return 0;
}

References sched_order_check().

Referenced by AST_TEST_DEFINE().

sched_order_7_cb()

static int sched_order_7_cb ( const void *  data )

static

Definition at line 96 of file test_sched.c.

{
    sched_order_check((void *) data, 7);
    return 0;
}

References sched_order_check().

Referenced by AST_TEST_DEFINE().

sched_order_8_cb()

static int sched_order_8_cb ( const void *  data )

static

Definition at line 102 of file test_sched.c.

{
    sched_order_check((void *) data, 8);
    return 0;
}

References sched_order_check().

Referenced by AST_TEST_DEFINE().

sched_order_check()

static void sched_order_check ( struct ast_test *  test, int  order  )

static

Definition at line 50 of file test_sched.c.

{
    ++order_check;
    if (order_check != order) {
        ast_test_status_update(test, "Unexpected execution order: expected:%d got:%d\n",
            order, order_check);
        order_check_failed = 1;
    }
}

References ast_test_status_update, order, order_check, and order_check_failed.

Referenced by sched_order_1_cb(), sched_order_2_cb(), sched_order_3_cb(), sched_order_4_cb(), sched_order_5_cb(), sched_order_6_cb(), sched_order_7_cb(), and sched_order_8_cb().

test_obj_cleanup()

static void test_obj_cleanup ( void *  data )

static

Definition at line 347 of file test_sched.c.

{
    struct test_obj *obj = data;
    ast_mutex_destroy(&obj->lock);
    ast_cond_destroy(&obj->cond);
}

References ast_cond_destroy, ast_mutex_destroy, test_obj::cond, and test_obj::lock.

Referenced by AST_TEST_DEFINE().

unload_module()

static int unload_module ( void  )

static

Definition at line 470 of file test_sched.c.

{
    AST_TEST_UNREGISTER(sched_test_order);
    AST_TEST_UNREGISTER(sched_test_freebird);
    ast_cli_unregister_multiple(cli_sched, ARRAY_LEN(cli_sched));
    return 0;
}

References ARRAY_LEN, ast_cli_unregister_multiple(), AST_TEST_UNREGISTER, and cli_sched.

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "ast_sched performance test module" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }

static

Definition at line 486 of file test_sched.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 486 of file test_sched.c.

cli_sched

struct ast_cli_entry cli_sched[]

static

Initial value:

= {
    { .handler =  handle_cli_sched_bench , .summary =  "Benchmark ast_sched add/del performance" ,},
}

Definition at line 466 of file test_sched.c.

Referenced by load_module(), and unload_module().

order_check

int order_check

static

Definition at line 47 of file test_sched.c.

Referenced by AST_TEST_DEFINE(), and sched_order_check().

order_check_failed

int order_check_failed

static

Definition at line 48 of file test_sched.c.

Referenced by AST_TEST_DEFINE(), and sched_order_check().