Fix DEBUG_THREADS when lock is acquired in __constructor__
[asterisk/asterisk.git] / main / timing.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2008 - 2009, Digium, Inc.
5  *
6  * Kevin P. Fleming <kpfleming@digium.com>
7  * Russell Bryant <russell@digium.com>
8  *
9  * See http://www.asterisk.org for more information about
10  * the Asterisk project. Please do not directly contact
11  * any of the maintainers of this project for assistance;
12  * the project provides a web site, mailing lists and IRC
13  * channels for your use.
14  *
15  * This program is free software, distributed under the terms of
16  * the GNU General Public License Version 2. See the LICENSE file
17  * at the top of the source tree.
18  */
19
20 /*! \file
21  *
22  * \brief Timing source management
23  *
24  * \author Kevin P. Fleming <kpfleming@digium.com>
25  * \author Russell Bryant <russell@digium.com>
26  */
27
28 /*** MODULEINFO
29         <support_level>core</support_level>
30  ***/
31
32 #include "asterisk.h"
33
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
35
36 #include "asterisk/_private.h"
37
38 #include "asterisk/timing.h"
39 #include "asterisk/lock.h"
40 #include "asterisk/cli.h"
41 #include "asterisk/utils.h"
42 #include "asterisk/time.h"
43 #include "asterisk/heap.h"
44 #include "asterisk/module.h"
45 #include "asterisk/poll-compat.h"
46
47 struct timing_holder {
48         /*! Do _not_ move this from the beginning of the struct. */
49         ssize_t __heap_index;
50         struct ast_module *mod;
51         struct ast_timing_interface *iface;
52 };
53
54 static struct ast_heap *timing_interfaces;
55
56 struct ast_timer {
57         int fd;
58         struct timing_holder *holder;
59 };
60
61 static int timing_holder_cmp(void *_h1, void *_h2)
62 {
63         struct timing_holder *h1 = _h1;
64         struct timing_holder *h2 = _h2;
65
66         if (h1->iface->priority > h2->iface->priority) {
67                 return 1;
68         } else if (h1->iface->priority == h2->iface->priority) {
69                 return 0;
70         } else {
71                 return -1;
72         }
73 }
74
75 void *_ast_register_timing_interface(struct ast_timing_interface *funcs,
76                                      struct ast_module *mod)
77 {
78         struct timing_holder *h;
79
80         if (!funcs->timer_open ||
81             !funcs->timer_close ||
82             !funcs->timer_set_rate ||
83             !funcs->timer_ack ||
84             !funcs->timer_get_event ||
85             !funcs->timer_get_max_rate ||
86             !funcs->timer_enable_continuous ||
87             !funcs->timer_disable_continuous) {
88                 return NULL;
89         }
90
91         if (!(h = ast_calloc(1, sizeof(*h)))) {
92                 return NULL;
93         }
94
95         h->iface = funcs;
96         h->mod = mod;
97
98         ast_heap_wrlock(timing_interfaces);
99         ast_heap_push(timing_interfaces, h);
100         ast_heap_unlock(timing_interfaces);
101
102         return h;
103 }
104
105 int ast_unregister_timing_interface(void *handle)
106 {
107         struct timing_holder *h = handle;
108         int res = -1;
109
110         ast_heap_wrlock(timing_interfaces);
111         h = ast_heap_remove(timing_interfaces, h);
112         ast_heap_unlock(timing_interfaces);
113
114         if (h) {
115                 ast_free(h);
116                 h = NULL;
117                 res = 0;
118         }
119
120         return res;
121 }
122
123 struct ast_timer *ast_timer_open(void)
124 {
125         int fd = -1;
126         struct timing_holder *h;
127         struct ast_timer *t = NULL;
128
129         ast_heap_rdlock(timing_interfaces);
130
131         if ((h = ast_heap_peek(timing_interfaces, 1))) {
132                 fd = h->iface->timer_open();
133                 ast_module_ref(h->mod);
134         }
135
136         if (fd != -1) {
137                 if (!(t = ast_calloc(1, sizeof(*t)))) {
138                         h->iface->timer_close(fd);
139                 } else {
140                         t->fd = fd;
141                         t->holder = h;
142                 }
143         }
144
145         ast_heap_unlock(timing_interfaces);
146
147         return t;
148 }
149
150 void ast_timer_close(struct ast_timer *handle)
151 {
152         handle->holder->iface->timer_close(handle->fd);
153         handle->fd = -1;
154         ast_module_unref(handle->holder->mod);
155         ast_free(handle);
156 }
157
158 int ast_timer_fd(const struct ast_timer *handle)
159 {
160         return handle->fd;
161 }
162
163 int ast_timer_set_rate(const struct ast_timer *handle, unsigned int rate)
164 {
165         int res = -1;
166
167         res = handle->holder->iface->timer_set_rate(handle->fd, rate);
168
169         return res;
170 }
171
172 int ast_timer_ack(const struct ast_timer *handle, unsigned int quantity)
173 {
174         int res = -1;
175
176         res = handle->holder->iface->timer_ack(handle->fd, quantity);
177
178         return res;
179 }
180
181 int ast_timer_enable_continuous(const struct ast_timer *handle)
182 {
183         int res = -1;
184
185         res = handle->holder->iface->timer_enable_continuous(handle->fd);
186
187         return res;
188 }
189
190 int ast_timer_disable_continuous(const struct ast_timer *handle)
191 {
192         int res = -1;
193
194         res = handle->holder->iface->timer_disable_continuous(handle->fd);
195
196         return res;
197 }
198
199 enum ast_timer_event ast_timer_get_event(const struct ast_timer *handle)
200 {
201         enum ast_timer_event res = -1;
202
203         res = handle->holder->iface->timer_get_event(handle->fd);
204
205         return res;
206 }
207
208 unsigned int ast_timer_get_max_rate(const struct ast_timer *handle)
209 {
210         unsigned int res = 0;
211
212         res = handle->holder->iface->timer_get_max_rate(handle->fd);
213
214         return res;
215 }
216
217 const char *ast_timer_get_name(const struct ast_timer *handle)
218 {
219         return handle->holder->iface->name;
220 }
221
222 static char *timing_test(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
223 {
224         struct ast_timer *timer;
225         int count = 0;
226         struct timeval start, end;
227         unsigned int test_rate = 50;
228
229         switch (cmd) {
230         case CLI_INIT:
231                 e->command = "timing test";
232                 e->usage = "Usage: timing test <rate>\n"
233                            "   Test a timer with a specified rate, 50/sec by default.\n"
234                            "";
235                 return NULL;
236         case CLI_GENERATE:
237                 return NULL;
238         }
239
240         if (a->argc != 2 && a->argc != 3) {
241                 return CLI_SHOWUSAGE;
242         }
243
244         if (a->argc == 3) {
245                 unsigned int rate;
246                 if (sscanf(a->argv[2], "%30u", &rate) == 1) {
247                         test_rate = rate;
248                 } else {
249                         ast_cli(a->fd, "Invalid rate '%s', using default of %u\n", a->argv[2], test_rate);
250                 }
251         }
252
253         ast_cli(a->fd, "Attempting to test a timer with %u ticks per second.\n", test_rate);
254
255         if (!(timer = ast_timer_open())) {
256                 ast_cli(a->fd, "Failed to open timing fd\n");
257                 return CLI_FAILURE;
258         }
259
260         ast_cli(a->fd, "Using the '%s' timing module for this test.\n", timer->holder->iface->name);
261
262         start = ast_tvnow();
263
264         ast_timer_set_rate(timer, test_rate);
265
266         while (ast_tvdiff_ms((end = ast_tvnow()), start) < 1000) {
267                 int res;
268                 struct pollfd pfd = {
269                         .fd = ast_timer_fd(timer),
270                         .events = POLLIN | POLLPRI,
271                 };
272
273                 res = ast_poll(&pfd, 1, 100);
274
275                 if (res == 1) {
276                         count++;
277                         if (ast_timer_ack(timer, 1) < 0) {
278                                 ast_cli(a->fd, "Timer failed to acknowledge.\n");
279                                 ast_timer_close(timer);
280                                 return CLI_FAILURE;
281                         }
282                 } else if (!res) {
283                         ast_cli(a->fd, "poll() timed out!  This is bad.\n");
284                 } else if (errno != EAGAIN && errno != EINTR) {
285                         ast_cli(a->fd, "poll() returned error: %s\n", strerror(errno));
286                 }
287         }
288
289         ast_timer_close(timer);
290         timer = NULL;
291
292         ast_cli(a->fd, "It has been %" PRIi64 " milliseconds, and we got %d timer ticks\n",
293                 ast_tvdiff_ms(end, start), count);
294
295         return CLI_SUCCESS;
296 }
297
298 static struct ast_cli_entry cli_timing[] = {
299         AST_CLI_DEFINE(timing_test, "Run a timing test"),
300 };
301
302 static void timing_shutdown(void)
303 {
304         ast_cli_unregister_multiple(cli_timing, ARRAY_LEN(cli_timing));
305
306         ast_heap_destroy(timing_interfaces);
307         timing_interfaces = NULL;
308 }
309
310 int ast_timing_init(void)
311 {
312         if (!(timing_interfaces = ast_heap_create(2, timing_holder_cmp, 0))) {
313                 return -1;
314         }
315
316         ast_register_atexit(timing_shutdown);
317
318         return ast_cli_register_multiple(cli_timing, ARRAY_LEN(cli_timing));
319 }