Timing source management. More...
#include "asterisk.h"
#include "asterisk/_private.h"
#include "asterisk/timing.h"
#include "asterisk/lock.h"
#include "asterisk/cli.h"
#include "asterisk/utils.h"
#include "asterisk/time.h"
#include "asterisk/heap.h"
#include "asterisk/module.h"
#include "asterisk/poll-compat.h"
Go to the source code of this file.
Data Structures | |
struct | ast_timer |
struct | timing_holder |
Functions | |
void * | _ast_register_timing_interface (struct ast_timing_interface *funcs, struct ast_module *mod) |
int | ast_timer_ack (const struct ast_timer *handle, unsigned int quantity) |
Acknowledge a timer event. | |
void | ast_timer_close (struct ast_timer *handle) |
Close an opened timing handle. | |
int | ast_timer_disable_continuous (const struct ast_timer *handle) |
Disable continuous mode. | |
int | ast_timer_enable_continuous (const struct ast_timer *handle) |
Enable continuous mode. | |
int | ast_timer_fd (const struct ast_timer *handle) |
Get a poll()-able file descriptor for a timer. | |
enum ast_timer_event | ast_timer_get_event (const struct ast_timer *handle) |
Retrieve timing event. | |
unsigned int | ast_timer_get_max_rate (const struct ast_timer *handle) |
Get maximum rate supported for a timer. | |
const char * | ast_timer_get_name (const struct ast_timer *handle) |
Get name of timer in use. | |
struct ast_timer * | ast_timer_open (void) |
Open a timer. | |
int | ast_timer_set_rate (const struct ast_timer *handle, unsigned int rate) |
Set the timing tick rate. | |
int | ast_timing_init (void) |
int | ast_unregister_timing_interface (void *handle) |
Unregister a previously registered timing interface. | |
static int | timing_holder_cmp (void *_h1, void *_h2) |
static void | timing_shutdown (void) |
static char * | timing_test (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a) |
Variables | |
static struct ast_cli_entry | cli_timing [] |
static struct ast_heap * | timing_interfaces |
Timing source management.
Definition in file timing.c.
void* _ast_register_timing_interface | ( | struct ast_timing_interface * | funcs, | |
struct ast_module * | mod | |||
) |
Definition at line 75 of file timing.c.
References ast_calloc, ast_heap_push(), ast_heap_unlock, ast_heap_wrlock, timing_holder::iface, timing_holder::mod, ast_timing_interface::timer_ack, ast_timing_interface::timer_close, ast_timing_interface::timer_disable_continuous, ast_timing_interface::timer_enable_continuous, ast_timing_interface::timer_get_event, ast_timing_interface::timer_get_max_rate, ast_timing_interface::timer_open, and ast_timing_interface::timer_set_rate.
00077 { 00078 struct timing_holder *h; 00079 00080 if (!funcs->timer_open || 00081 !funcs->timer_close || 00082 !funcs->timer_set_rate || 00083 !funcs->timer_ack || 00084 !funcs->timer_get_event || 00085 !funcs->timer_get_max_rate || 00086 !funcs->timer_enable_continuous || 00087 !funcs->timer_disable_continuous) { 00088 return NULL; 00089 } 00090 00091 if (!(h = ast_calloc(1, sizeof(*h)))) { 00092 return NULL; 00093 } 00094 00095 h->iface = funcs; 00096 h->mod = mod; 00097 00098 ast_heap_wrlock(timing_interfaces); 00099 ast_heap_push(timing_interfaces, h); 00100 ast_heap_unlock(timing_interfaces); 00101 00102 return h; 00103 }
int ast_timer_ack | ( | const struct ast_timer * | handle, | |
unsigned int | quantity | |||
) |
Acknowledge a timer event.
handle | timer handle returned from timer_open() | |
quantity | number of timer events to acknowledge |
-1 | failure, with errno set | |
0 | success |
Definition at line 172 of file timing.c.
References ast_timer::fd, ast_timer::holder, timing_holder::iface, and ast_timing_interface::timer_ack.
Referenced by __ast_read(), monmp3thread(), softmix_bridge_thread(), spandsp_fax_read(), timing_read(), and timing_test().
void ast_timer_close | ( | struct ast_timer * | handle | ) |
Close an opened timing handle.
handle | timer handle returned from timer_open() |
Definition at line 150 of file timing.c.
References ast_free, ast_module_unref(), ast_timer::fd, ast_timer::holder, timing_holder::iface, timing_holder::mod, and ast_timing_interface::timer_close.
Referenced by __unload_module(), ast_channel_destructor(), init_app_class(), load_module(), local_ast_moh_start(), moh_class_destructor(), session_destroy(), softmix_bridge_destroy(), and timing_test().
00151 { 00152 handle->holder->iface->timer_close(handle->fd); 00153 handle->fd = -1; 00154 ast_module_unref(handle->holder->mod); 00155 ast_free(handle); 00156 }
int ast_timer_disable_continuous | ( | const struct ast_timer * | handle | ) |
Disable continuous mode.
handle | timer handle returned from timer_close() |
-1 | failure, with errno set | |
0 | success |
Definition at line 190 of file timing.c.
References ast_timer::fd, ast_timer::holder, timing_holder::iface, and ast_timing_interface::timer_disable_continuous.
Referenced by __ast_read().
00191 { 00192 int res = -1; 00193 00194 res = handle->holder->iface->timer_disable_continuous(handle->fd); 00195 00196 return res; 00197 }
int ast_timer_enable_continuous | ( | const struct ast_timer * | handle | ) |
Enable continuous mode.
handle | timer handle returned from timer_open() |
Continuous mode causes poll() on the timer's fd to immediately return always until continuous mode is disabled.
-1 | failure, with errno set | |
0 | success |
Definition at line 181 of file timing.c.
References ast_timer::fd, ast_timer::holder, timing_holder::iface, and ast_timing_interface::timer_enable_continuous.
Referenced by __ast_queue_frame().
00182 { 00183 int res = -1; 00184 00185 res = handle->holder->iface->timer_enable_continuous(handle->fd); 00186 00187 return res; 00188 }
int ast_timer_fd | ( | const struct ast_timer * | handle | ) |
Get a poll()-able file descriptor for a timer.
handle | timer handle returned from timer_open() |
Definition at line 158 of file timing.c.
References ast_timer::fd.
Referenced by __ast_channel_alloc_ap(), monmp3thread(), network_thread(), softmix_bridge_thread(), spandsp_fax_new(), and timing_test().
00159 { 00160 return handle->fd; 00161 }
enum ast_timer_event ast_timer_get_event | ( | const struct ast_timer * | handle | ) |
Retrieve timing event.
handle | timer handle returned by timer_open() |
After poll() indicates that there is input on the timer's fd, this will be called to find out what triggered it.
Definition at line 199 of file timing.c.
References ast_timer::fd, ast_timer::holder, timing_holder::iface, and ast_timing_interface::timer_get_event.
Referenced by __ast_read().
00200 { 00201 enum ast_timer_event res = -1; 00202 00203 res = handle->holder->iface->timer_get_event(handle->fd); 00204 00205 return res; 00206 }
unsigned int ast_timer_get_max_rate | ( | const struct ast_timer * | handle | ) |
Get maximum rate supported for a timer.
handle | timer handle returned by timer_open() |
Definition at line 208 of file timing.c.
References ast_timer::fd, ast_timer::holder, timing_holder::iface, and ast_timing_interface::timer_get_max_rate.
Referenced by ast_settimeout_full().
00209 { 00210 unsigned int res = 0; 00211 00212 res = handle->holder->iface->timer_get_max_rate(handle->fd); 00213 00214 return res; 00215 }
const char* ast_timer_get_name | ( | const struct ast_timer * | handle | ) |
Get name of timer in use.
handle | timer handle returned by timer_open() |
Definition at line 217 of file timing.c.
References ast_timer::holder, timing_holder::iface, and ast_timing_interface::name.
Referenced by __ast_channel_alloc_ap().
struct ast_timer* ast_timer_open | ( | void | ) | [read] |
Open a timer.
NULL | on error, with errno set | |
non-NULL | timer handle on success |
Definition at line 123 of file timing.c.
References ast_calloc, ast_heap_peek(), ast_heap_rdlock, ast_heap_unlock, ast_module_ref(), ast_timer::fd, ast_timer::holder, timing_holder::iface, timing_holder::mod, ast_timing_interface::timer_close, and ast_timing_interface::timer_open.
Referenced by __ast_channel_alloc_ap(), init_app_class(), load_module(), local_ast_moh_start(), softmix_bridge_create(), spandsp_fax_new(), and timing_test().
00124 { 00125 int fd = -1; 00126 struct timing_holder *h; 00127 struct ast_timer *t = NULL; 00128 00129 ast_heap_rdlock(timing_interfaces); 00130 00131 if ((h = ast_heap_peek(timing_interfaces, 1))) { 00132 fd = h->iface->timer_open(); 00133 ast_module_ref(h->mod); 00134 } 00135 00136 if (fd != -1) { 00137 if (!(t = ast_calloc(1, sizeof(*t)))) { 00138 h->iface->timer_close(fd); 00139 } else { 00140 t->fd = fd; 00141 t->holder = h; 00142 } 00143 } 00144 00145 ast_heap_unlock(timing_interfaces); 00146 00147 return t; 00148 }
int ast_timer_set_rate | ( | const struct ast_timer * | handle, | |
unsigned int | rate | |||
) |
Set the timing tick rate.
handle | timer handle returned from timer_open() | |
rate | ticks per second, 0 turns the ticks off if needed |
Use this function if you want the timer to show input at a certain rate. The other alternative use of a timer is the continuous mode.
-1 | error, with errno set | |
0 | success |
Definition at line 163 of file timing.c.
References ast_timer::fd, ast_timer::holder, timing_holder::iface, and ast_timing_interface::timer_set_rate.
Referenced by __ast_read(), ast_settimeout_full(), init_app_class(), load_module(), local_ast_moh_start(), set_config(), softmix_bridge_thread(), spandsp_fax_start(), and timing_test().
00164 { 00165 int res = -1; 00166 00167 res = handle->holder->iface->timer_set_rate(handle->fd, rate); 00168 00169 return res; 00170 }
int ast_timing_init | ( | void | ) |
Provided by timing.c
Definition at line 310 of file timing.c.
References ARRAY_LEN, ast_cli_register_multiple(), ast_heap_create(), ast_register_atexit(), timing_holder_cmp(), and timing_shutdown().
Referenced by main().
00311 { 00312 if (!(timing_interfaces = ast_heap_create(2, timing_holder_cmp, 0))) { 00313 return -1; 00314 } 00315 00316 ast_register_atexit(timing_shutdown); 00317 00318 return ast_cli_register_multiple(cli_timing, ARRAY_LEN(cli_timing)); 00319 }
int ast_unregister_timing_interface | ( | void * | handle | ) |
Unregister a previously registered timing interface.
handle | The handle returned from a prior successful call to ast_register_timing_interface(). |
0 | success | |
non-zero | failure |
Definition at line 105 of file timing.c.
References ast_free, ast_heap_remove(), ast_heap_unlock, and ast_heap_wrlock.
Referenced by unload_module().
00106 { 00107 struct timing_holder *h = handle; 00108 int res = -1; 00109 00110 ast_heap_wrlock(timing_interfaces); 00111 h = ast_heap_remove(timing_interfaces, h); 00112 ast_heap_unlock(timing_interfaces); 00113 00114 if (h) { 00115 ast_free(h); 00116 h = NULL; 00117 res = 0; 00118 } 00119 00120 return res; 00121 }
static int timing_holder_cmp | ( | void * | _h1, | |
void * | _h2 | |||
) | [static] |
Definition at line 61 of file timing.c.
References timing_holder::iface, and ast_timing_interface::priority.
Referenced by ast_timing_init().
00062 { 00063 struct timing_holder *h1 = _h1; 00064 struct timing_holder *h2 = _h2; 00065 00066 if (h1->iface->priority > h2->iface->priority) { 00067 return 1; 00068 } else if (h1->iface->priority == h2->iface->priority) { 00069 return 0; 00070 } else { 00071 return -1; 00072 } 00073 }
static void timing_shutdown | ( | void | ) | [static] |
Definition at line 302 of file timing.c.
References ARRAY_LEN, ast_cli_unregister_multiple(), and ast_heap_destroy().
Referenced by ast_timing_init().
00303 { 00304 ast_cli_unregister_multiple(cli_timing, ARRAY_LEN(cli_timing)); 00305 00306 ast_heap_destroy(timing_interfaces); 00307 timing_interfaces = NULL; 00308 }
static char* timing_test | ( | struct ast_cli_entry * | e, | |
int | cmd, | |||
struct ast_cli_args * | a | |||
) | [static] |
Definition at line 222 of file timing.c.
References ast_cli_args::argc, ast_cli_args::argv, ast_cli(), ast_poll, ast_timer_ack(), ast_timer_close(), ast_timer_fd(), ast_timer_open(), ast_timer_set_rate(), ast_tvdiff_ms(), ast_tvnow(), CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, errno, ast_cli_args::fd, ast_timer::holder, timing_holder::iface, ast_timing_interface::name, timer, and ast_cli_entry::usage.
00223 { 00224 struct ast_timer *timer; 00225 int count = 0; 00226 struct timeval start, end; 00227 unsigned int test_rate = 50; 00228 00229 switch (cmd) { 00230 case CLI_INIT: 00231 e->command = "timing test"; 00232 e->usage = "Usage: timing test <rate>\n" 00233 " Test a timer with a specified rate, 50/sec by default.\n" 00234 ""; 00235 return NULL; 00236 case CLI_GENERATE: 00237 return NULL; 00238 } 00239 00240 if (a->argc != 2 && a->argc != 3) { 00241 return CLI_SHOWUSAGE; 00242 } 00243 00244 if (a->argc == 3) { 00245 unsigned int rate; 00246 if (sscanf(a->argv[2], "%30u", &rate) == 1) { 00247 test_rate = rate; 00248 } else { 00249 ast_cli(a->fd, "Invalid rate '%s', using default of %u\n", a->argv[2], test_rate); 00250 } 00251 } 00252 00253 ast_cli(a->fd, "Attempting to test a timer with %u ticks per second.\n", test_rate); 00254 00255 if (!(timer = ast_timer_open())) { 00256 ast_cli(a->fd, "Failed to open timing fd\n"); 00257 return CLI_FAILURE; 00258 } 00259 00260 ast_cli(a->fd, "Using the '%s' timing module for this test.\n", timer->holder->iface->name); 00261 00262 start = ast_tvnow(); 00263 00264 ast_timer_set_rate(timer, test_rate); 00265 00266 while (ast_tvdiff_ms((end = ast_tvnow()), start) < 1000) { 00267 int res; 00268 struct pollfd pfd = { 00269 .fd = ast_timer_fd(timer), 00270 .events = POLLIN | POLLPRI, 00271 }; 00272 00273 res = ast_poll(&pfd, 1, 100); 00274 00275 if (res == 1) { 00276 count++; 00277 if (ast_timer_ack(timer, 1) < 0) { 00278 ast_cli(a->fd, "Timer failed to acknowledge.\n"); 00279 ast_timer_close(timer); 00280 return CLI_FAILURE; 00281 } 00282 } else if (!res) { 00283 ast_cli(a->fd, "poll() timed out! This is bad.\n"); 00284 } else if (errno != EAGAIN && errno != EINTR) { 00285 ast_cli(a->fd, "poll() returned error: %s\n", strerror(errno)); 00286 } 00287 } 00288 00289 ast_timer_close(timer); 00290 timer = NULL; 00291 00292 ast_cli(a->fd, "It has been %" PRIi64 " milliseconds, and we got %d timer ticks\n", 00293 ast_tvdiff_ms(end, start), count); 00294 00295 return CLI_SUCCESS; 00296 }
struct ast_cli_entry cli_timing[] [static] |
{ AST_CLI_DEFINE(timing_test, "Run a timing test"), }
struct ast_heap* timing_interfaces [static] |