res_timing_kqueue.c File Reference

kqueue timing interface More...

#include "asterisk.h"
#include <sys/types.h>
#include <sys/event.h>
#include <sys/time.h>
#include "asterisk/module.h"
#include "asterisk/astobj2.h"
#include "asterisk/timing.h"
#include "asterisk/logger.h"
#include "asterisk/utils.h"
#include "asterisk/time.h"
#include "asterisk/test.h"
#include "asterisk/poll-compat.h"

Include dependency graph for res_timing_kqueue.c:

Go to the source code of this file.

Data Structures
struct	kqueue_timer

Macros
#define	CONTINUOUS_EVFILT_TYPE   EVFILT_READ

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
struct ast_module *	AST_MODULE_SELF_SYM (void)
static intptr_t	kqueue_scale_period (unsigned int period_ns, int *units)
static int	kqueue_timer_ack (void *data, unsigned int quantity)
static void	kqueue_timer_close (void *data)
static int	kqueue_timer_disable_continuous (void *data)
static int	kqueue_timer_disable_continuous_event (struct kqueue_timer *timer)
static int	kqueue_timer_enable_continuous (void *data)
static int	kqueue_timer_enable_continuous_event (struct kqueue_timer *timer)
static int	kqueue_timer_fd (void *data)
static void	kqueue_timer_fini_continuous_event (struct kqueue_timer *timer)
static enum ast_timer_event	kqueue_timer_get_event (void *data)
static unsigned int	kqueue_timer_get_max_rate (void *data)
static int	kqueue_timer_init_continuous_event (struct kqueue_timer *timer)
static void *	kqueue_timer_open (void)
static int	kqueue_timer_set_rate (void *data, unsigned int rate)
static int	load_module (void)
	Load the module.
static void	timer_destroy (void *obj)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "KQueue Timing Interface" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_EXTENDED, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_CHANNEL_DEPEND, }
static const struct ast_module_info *	ast_module_info = &__mod_info
static struct ast_timing_interface	kqueue_timing
static void *	timing_funcs_handle

Detailed Description

kqueue timing interface

Author

Tilghman Lesher

<tlesher AT digium DOT com> 

Definition in file res_timing_kqueue.c.

Macro Definition Documentation

CONTINUOUS_EVFILT_TYPE

#define CONTINUOUS_EVFILT_TYPE   EVFILT_READ

Definition at line 117 of file res_timing_kqueue.c.

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 508 of file res_timing_kqueue.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 508 of file res_timing_kqueue.c.

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 508 of file res_timing_kqueue.c.

kqueue_scale_period()

static intptr_t kqueue_scale_period ( unsigned int  period_ns, int *  units  )

static

Definition at line 205 of file res_timing_kqueue.c.

{
    uint64_t period = period_ns;
    *units = 0;
#ifdef NOTE_NSECONDS
    if (period < INTPTR_MAX) {
        *units = NOTE_NSECONDS;
    } else {
#ifdef NOTE_USECONDS
        period /= 1000;
        if (period < INTPTR_MAX) {
            *units = NOTE_USECONDS;
        } else {
            period /= 1000;
#ifdef NOTE_MSECONDS
            *units = NOTE_MSECONDS;
#endif  /* NOTE_MSECONDS */
        }
#else   /* NOTE_USECONDS */
        period /= 1000000;
#ifdef NOTE_MSECONDS
        *units = NOTE_MSECONDS;
#endif  /* NOTE_MSECONDS */
#endif  /* NOTE_USECONDS */
    }
#else   /* NOTE_NSECONDS */
    period /= 1000000;
#endif
    if (period > INTPTR_MAX) {
        period = INTPTR_MAX;
    }
    return period;
}

References kqueue_timer::period.

Referenced by kqueue_timer_set_rate().

kqueue_timer_ack()

static int kqueue_timer_ack ( void *  data, unsigned int  quantity  )

static

Definition at line 279 of file res_timing_kqueue.c.

{
    static struct timespec ts_nowait = { 0, 0 };
    struct kqueue_timer *timer = data;
    struct kevent kev[2];
    int i, retval;
 
    ao2_lock(timer);
 
    retval = kevent(timer->handle, NULL, 0, kev, 2, &ts_nowait);
    if (retval == -1) {
        ast_log(LOG_ERROR, "[%d]: Error sampling kqueue: %s\n",
            timer->handle, strerror(errno));
        ao2_unlock(timer);
        return -1;
    }
 
    for (i = 0; i < retval; i++) {
        switch (kev[i].filter) {
        case EVFILT_TIMER:
            if (kev[i].data > quantity) {
                ast_log(LOG_ERROR, "[%d]: Missed %ju\n",
                    timer->handle,
                    (uintmax_t)kev[i].data - quantity);
            }
            break;
        case CONTINUOUS_EVFILT_TYPE:
            if (!timer->is_continuous) {
                ast_log(LOG_ERROR,
                    "[%d]: Spurious user event\n",
                    timer->handle);
            }
            break;
        default:
            ast_log(LOG_ERROR, "[%d]: Spurious kevent type %d.\n",
                timer->handle, kev[i].filter);
        }
    }
 
    ao2_unlock(timer);
 
    return 0;
}

References ao2_lock, ao2_unlock, ast_log, CONTINUOUS_EVFILT_TYPE, ast_timer::data, errno, filter(), LOG_ERROR, NULL, and timer.

kqueue_timer_close()

static void kqueue_timer_close ( void *  data )

static

Definition at line 193 of file res_timing_kqueue.c.

{
    struct kqueue_timer *timer = data;
 
    ast_debug(5, "[%d]: Timer Close\n", timer->handle);
    ao2_ref(timer, -1);
}

References ao2_ref, ast_debug, and timer.

kqueue_timer_disable_continuous()

static int kqueue_timer_disable_continuous ( void *  data )

static

Definition at line 346 of file res_timing_kqueue.c.

{
    struct kqueue_timer *timer = data;
    int retval;
 
    ao2_lock(timer);
 
    if (timer->is_continuous) {
        ast_debug(5, "[%d]: Disable Continuous\n", timer->handle);
        retval = kqueue_timer_disable_continuous_event(timer);
        if (retval == -1) {
            ast_log(LOG_ERROR,
                "[%d]: Error clearing continuous event: %s\n",
                timer->handle, strerror(errno));
        }
        timer->is_continuous = 0;
    }
 
    ao2_unlock(timer);
 
    return 0;
}

References ao2_lock, ao2_unlock, ast_debug, ast_log, errno, kqueue_timer_disable_continuous_event(), LOG_ERROR, and timer.

kqueue_timer_disable_continuous_event()

static int kqueue_timer_disable_continuous_event ( struct kqueue_timer *  timer )

static

Definition at line 148 of file res_timing_kqueue.c.

{
    struct kevent kev;
 
    EV_SET(&kev, timer->continuous_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL);
    return kevent(timer->handle, &kev, 1, NULL, 0, NULL);
}

References NULL, and timer.

Referenced by kqueue_timer_disable_continuous().

kqueue_timer_enable_continuous()

static int kqueue_timer_enable_continuous ( void *  data )

static

Definition at line 323 of file res_timing_kqueue.c.

{
    struct kqueue_timer *timer = data;
    int retval;
 
    ao2_lock(timer);
 
    if (!timer->is_continuous) {
        ast_debug(5, "[%d]: Enable Continuous\n", timer->handle);
        retval = kqueue_timer_enable_continuous_event(timer);
        if (retval == -1) {
            ast_log(LOG_ERROR,
                "[%d]: Error signaling continuous event: %s\n",
                timer->handle, strerror(errno));
        }
        timer->is_continuous = 1;
    }
 
    ao2_unlock(timer);
 
    return 0;
}

References ao2_lock, ao2_unlock, ast_debug, ast_log, errno, kqueue_timer_enable_continuous_event(), LOG_ERROR, and timer.

kqueue_timer_enable_continuous_event()

static int kqueue_timer_enable_continuous_event ( struct kqueue_timer *  timer )

static

Definition at line 139 of file res_timing_kqueue.c.

{
    struct kevent kev;
 
    EV_SET(&kev, timer->continuous_fd, EVFILT_READ, EV_ADD | EV_ENABLE,
        0, 0, NULL);
    return kevent(timer->handle, &kev, 1, NULL, 0, NULL);
}

References NULL, and timer.

Referenced by kqueue_timer_enable_continuous().

kqueue_timer_fd()

static int kqueue_timer_fd ( void *  data )

static

Definition at line 388 of file res_timing_kqueue.c.

{
    struct kqueue_timer *timer = data;
 
    return timer->handle;
}

References timer.

kqueue_timer_fini_continuous_event()

static void kqueue_timer_fini_continuous_event ( struct kqueue_timer *  timer )

static

Definition at line 132 of file res_timing_kqueue.c.

{
    if (timer->continuous_fd_valid) {
        close(timer->continuous_fd);
    }
}

References timer.

Referenced by timer_destroy().

kqueue_timer_get_event()

static enum ast_timer_event kqueue_timer_get_event ( void *  data )

static

Definition at line 369 of file res_timing_kqueue.c.

{
    struct kqueue_timer *timer = data;
    enum ast_timer_event res;
 
    if (timer->is_continuous) {
        res = AST_TIMING_EVENT_CONTINUOUS;
    } else {
        res = AST_TIMING_EVENT_EXPIRED;
    }
 
    return res;
}

References AST_TIMING_EVENT_CONTINUOUS, AST_TIMING_EVENT_EXPIRED, and timer.

kqueue_timer_get_max_rate()

static unsigned int kqueue_timer_get_max_rate ( void *  data )

static

Definition at line 383 of file res_timing_kqueue.c.

{
    return INTPTR_MAX > UINT_MAX ? UINT_MAX : INTPTR_MAX;
}

kqueue_timer_init_continuous_event()

static int kqueue_timer_init_continuous_event ( struct kqueue_timer *  timer )

static

Definition at line 118 of file res_timing_kqueue.c.

{
    int pipefds[2];
    int retval;
 
    retval = pipe(pipefds);
    if (retval == 0) {
        timer->continuous_fd = pipefds[0];
        timer->continuous_fd_valid = 1;
        close(pipefds[1]);
    }
    return retval;
}

References timer.

Referenced by kqueue_timer_open().

kqueue_timer_open()

static void * kqueue_timer_open ( void  )

static

Definition at line 167 of file res_timing_kqueue.c.

{
    struct kqueue_timer *timer;
 
    if (!(timer = ao2_alloc(sizeof(*timer), timer_destroy))) {
        ast_log(LOG_ERROR, "Alloc failed for kqueue_timer structure\n");
        return NULL;
    }
 
    if ((timer->handle = kqueue()) < 0) {
        ast_log(LOG_ERROR, "Failed to create kqueue fd: %s\n",
            strerror(errno));
        ao2_ref(timer, -1);
        return NULL;
    }
 
    if (kqueue_timer_init_continuous_event(timer) != 0) {
        ast_log(LOG_ERROR, "Failed to create continuous event: %s\n",
            strerror(errno));
        ao2_ref(timer, -1);
        return NULL;
    }
    ast_debug(5, "[%d]: Create timer\n", timer->handle);
    return timer;
}

References ao2_alloc, ao2_ref, ast_debug, ast_log, errno, kqueue_timer_init_continuous_event(), LOG_ERROR, NULL, timer, and timer_destroy().

kqueue_timer_set_rate()

static int kqueue_timer_set_rate ( void *  data, unsigned int  rate  )

static

Definition at line 239 of file res_timing_kqueue.c.

{
    struct kevent kev;
    struct kqueue_timer *timer = data;
    uint64_t period_ns;
    int flags;
    int units;
    int retval;
 
    ao2_lock(timer);
 
    if (rate == 0) {
        if (timer->period == 0) {
            ao2_unlock(timer);
            return (0);
        }
        flags = EV_DELETE;
        timer->period = 0;
        units = 0;
    } else  {
        flags = EV_ADD | EV_ENABLE;
        period_ns = (uint64_t)1000000000 / rate;
        timer->period = kqueue_scale_period(period_ns, &units);
    }
    ast_debug(5, "[%d]: Set rate %u:%ju\n",
        timer->handle, units, (uintmax_t)timer->period);
    EV_SET(&kev, timer->handle, EVFILT_TIMER, flags, units,
        timer->period, NULL);
    retval = kevent(timer->handle, &kev, 1, NULL, 0, NULL);
 
    if (retval == -1) {
        ast_log(LOG_ERROR, "[%d]: Error queing timer: %s\n",
            timer->handle, strerror(errno));
    }
 
    ao2_unlock(timer);
 
    return 0;
}

References ao2_lock, ao2_unlock, ast_debug, ast_log, errno, kqueue_scale_period(), LOG_ERROR, NULL, and timer.

load_module()

static int load_module ( void  )

static

Load the module.

Module loading including tests for configuration or dependencies. This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE, or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails tests return AST_MODULE_LOAD_FAILURE. If the module can not load the configuration file or other non-critical problem return AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.

Definition at line 486 of file res_timing_kqueue.c.

{
    if (!(timing_funcs_handle = ast_register_timing_interface(&kqueue_timing))) {
        return AST_MODULE_LOAD_DECLINE;
    }
 
    AST_TEST_REGISTER(test_kqueue_timing);
    return AST_MODULE_LOAD_SUCCESS;
}

References AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, ast_register_timing_interface, AST_TEST_REGISTER, kqueue_timing, and timing_funcs_handle.

timer_destroy()

static void timer_destroy ( void *  obj )

static

Definition at line 157 of file res_timing_kqueue.c.

{
    struct kqueue_timer *timer = obj;
    ast_debug(5, "[%d]: Timer Destroy\n", timer->handle);
    kqueue_timer_fini_continuous_event(timer);
    if (timer->handle > -1) {
        close(timer->handle);
    }
}

References ast_debug, kqueue_timer_fini_continuous_event(), and timer.

Referenced by kqueue_timer_open().

unload_module()

static int unload_module ( void  )

static

Definition at line 496 of file res_timing_kqueue.c.

{
    AST_TEST_UNREGISTER(test_kqueue_timing);
 
    return ast_unregister_timing_interface(timing_funcs_handle);
}

References AST_TEST_UNREGISTER, ast_unregister_timing_interface(), and timing_funcs_handle.

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "KQueue Timing Interface" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_EXTENDED, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_CHANNEL_DEPEND, }

static

Definition at line 508 of file res_timing_kqueue.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 508 of file res_timing_kqueue.c.

kqueue_timing

struct ast_timing_interface kqueue_timing

static

Definition at line 61 of file res_timing_kqueue.c.

                                                   {
    .name = "kqueue",
    .priority = 150,
    .timer_open = kqueue_timer_open,
    .timer_close = kqueue_timer_close,
    .timer_set_rate = kqueue_timer_set_rate,
    .timer_ack = kqueue_timer_ack,
    .timer_enable_continuous = kqueue_timer_enable_continuous,
    .timer_disable_continuous = kqueue_timer_disable_continuous,
    .timer_get_event = kqueue_timer_get_event,
    .timer_get_max_rate = kqueue_timer_get_max_rate,
    .timer_fd = kqueue_timer_fd,
};

Referenced by load_module().

timing_funcs_handle

void* timing_funcs_handle

static

Definition at line 49 of file res_timing_kqueue.c.

Referenced by load_module(), and unload_module().