security_events: Fix error caused by DTD validation error
[asterisk/asterisk.git] / res / res_timing_kqueue.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2010, Digium, Inc.
5  *
6  * Tilghman Lesher <tlesher AT digium DOT com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20  * \file
21  * \author Tilghman Lesher \verbatim <tlesher AT digium DOT com> \endverbatim
22  *
23  * \brief kqueue timing interface
24  *
25  * \ingroup resource
26  */
27
28 /*** MODULEINFO
29         <depend>kqueue</depend>
30         <conflict>launchd</conflict>
31         <support_level>extended</support_level>
32  ***/
33
34 #include "asterisk.h"
35
36 #include <sys/types.h>
37 #include <sys/event.h>
38 #include <sys/time.h>
39
40 #include "asterisk/module.h"
41 #include "asterisk/astobj2.h"
42 #include "asterisk/timing.h"
43 #include "asterisk/logger.h"
44 #include "asterisk/utils.h"
45 #include "asterisk/time.h"
46 #include "asterisk/test.h"
47 #include "asterisk/poll-compat.h"       /* for ast_poll() */
48
49 static void *timing_funcs_handle;
50
51 static int kqueue_timer_open(void);
52 static void kqueue_timer_close(int handle);
53 static int kqueue_timer_set_rate(int handle, unsigned int rate);
54 static int kqueue_timer_ack(int handle, unsigned int quantity);
55 static int kqueue_timer_enable_continuous(int handle);
56 static int kqueue_timer_disable_continuous(int handle);
57 static enum ast_timer_event kqueue_timer_get_event(int handle);
58 static unsigned int kqueue_timer_get_max_rate(int handle);
59
60 static struct ast_timing_interface kqueue_timing = {
61         .name = "kqueue",
62         .priority = 150,
63         .timer_open = kqueue_timer_open,
64         .timer_close = kqueue_timer_close,
65         .timer_set_rate = kqueue_timer_set_rate,
66         .timer_ack = kqueue_timer_ack,
67         .timer_enable_continuous = kqueue_timer_enable_continuous,
68         .timer_disable_continuous = kqueue_timer_disable_continuous,
69         .timer_get_event = kqueue_timer_get_event,
70         .timer_get_max_rate = kqueue_timer_get_max_rate,
71 };
72
73 static struct ao2_container *kqueue_timers;
74
75 struct kqueue_timer {
76         int handle;
77         uint64_t nsecs;
78         uint64_t unacked;
79         unsigned int is_continuous:1;
80 };
81
82 static int kqueue_timer_hash(const void *obj, const int flags)
83 {
84         const struct kqueue_timer *timer = obj;
85
86         return timer->handle;
87 }
88
89 static int kqueue_timer_cmp(void *obj, void *args, int flags)
90 {
91         struct kqueue_timer *timer1 = obj, *timer2 = args;
92         return timer1->handle == timer2->handle ? CMP_MATCH | CMP_STOP : 0;
93 }
94
95 static void timer_destroy(void *obj)
96 {
97         struct kqueue_timer *timer = obj;
98         close(timer->handle);
99 }
100
101 #define lookup_timer(a) _lookup_timer(a, __FILE__, __LINE__, __PRETTY_FUNCTION__)
102 static struct kqueue_timer *_lookup_timer(int handle, const char *file, int line, const char *func)
103 {
104         struct kqueue_timer *our_timer, find_helper = {
105                 .handle = handle,
106         };
107
108         if (!(our_timer = ao2_find(kqueue_timers, &find_helper, OBJ_POINTER))) {
109                 ast_log(__LOG_ERROR, file, line, func, "Couldn't find timer with handle %d\n", handle);
110                 /* API says we set errno */
111                 errno = ESRCH;
112                 return NULL;
113         }
114         return our_timer;
115 }
116
117 static int kqueue_timer_open(void)
118 {
119         struct kqueue_timer *timer;
120         int handle;
121
122         if (!(timer = ao2_alloc(sizeof(*timer), timer_destroy))) {
123                 ast_log(LOG_ERROR, "Could not allocate memory for kqueue_timer structure\n");
124                 return -1;
125         }
126         if ((handle = kqueue()) < 0) {
127                 ast_log(LOG_ERROR, "Failed to create kqueue timer: %s\n", strerror(errno));
128                 ao2_ref(timer, -1);
129                 return -1;
130         }
131
132         timer->handle = handle;
133         ao2_link(kqueue_timers, timer);
134         /* Get rid of the reference from the allocation */
135         ao2_ref(timer, -1);
136         return handle;
137 }
138
139 static void kqueue_timer_close(int handle)
140 {
141         struct kqueue_timer *our_timer;
142
143         if (!(our_timer = lookup_timer(handle))) {
144                 return;
145         }
146
147         ao2_unlink(kqueue_timers, our_timer);
148         ao2_ref(our_timer, -1);
149 }
150
151 static void kqueue_set_nsecs(struct kqueue_timer *our_timer, uint64_t nsecs)
152 {
153         struct timespec nowait = { 0, 1 };
154 #ifdef HAVE_KEVENT64
155         struct kevent64_s kev;
156
157         EV_SET64(&kev, our_timer->handle, EVFILT_TIMER, EV_ADD | EV_ENABLE, NOTE_NSECONDS,
158                 nsecs, 0, 0, 0);
159         kevent64(our_timer->handle, &kev, 1, NULL, 0, 0, &nowait);
160 #else
161         struct kevent kev;
162
163         EV_SET(&kev, our_timer->handle, EVFILT_TIMER, EV_ADD | EV_ENABLE,
164 #ifdef NOTE_NSECONDS
165                 nsecs <= 0xFFffFFff ? NOTE_NSECONDS :
166 #endif
167 #ifdef NOTE_USECONDS
168                 NOTE_USECONDS
169 #else /* Milliseconds, if no constants are defined */
170                 0
171 #endif
172                 ,
173 #ifdef NOTE_NSECONDS
174                 nsecs <= 0xFFffFFff ? nsecs :
175 #endif
176 #ifdef NOTE_USECONDS
177         nsecs / 1000
178 #else /* Milliseconds, if nothing else is defined */
179         nsecs / 1000000
180 #endif
181         , NULL);
182         kevent(our_timer->handle, &kev, 1, NULL, 0, &nowait);
183 #endif
184 }
185
186 static int kqueue_timer_set_rate(int handle, unsigned int rate)
187 {
188         struct kqueue_timer *our_timer;
189
190         if (!(our_timer = lookup_timer(handle))) {
191                 return -1;
192         }
193
194         kqueue_set_nsecs(our_timer, (our_timer->nsecs = rate ? (long) (1000000000 / rate) : 0L));
195         ao2_ref(our_timer, -1);
196
197         return 0;
198 }
199
200 static int kqueue_timer_ack(int handle, unsigned int quantity)
201 {
202         struct kqueue_timer *our_timer;
203
204         if (!(our_timer = lookup_timer(handle))) {
205                 return -1;
206         }
207
208         if (our_timer->unacked < quantity) {
209                 ast_debug(1, "Acking more events than have expired?!!\n");
210                 our_timer->unacked = 0;
211                 ao2_ref(our_timer, -1);
212                 return -1;
213         } else {
214                 our_timer->unacked -= quantity;
215         }
216
217         ao2_ref(our_timer, -1);
218         return 0;
219 }
220
221 static int kqueue_timer_enable_continuous(int handle)
222 {
223         struct kqueue_timer *our_timer;
224
225         if (!(our_timer = lookup_timer(handle))) {
226                 return -1;
227         }
228
229         kqueue_set_nsecs(our_timer, 1);
230         our_timer->is_continuous = 1;
231         our_timer->unacked = 0;
232         ao2_ref(our_timer, -1);
233         return 0;
234 }
235
236 static int kqueue_timer_disable_continuous(int handle)
237 {
238         struct kqueue_timer *our_timer;
239
240         if (!(our_timer = lookup_timer(handle))) {
241                 return -1;
242         }
243
244         kqueue_set_nsecs(our_timer, our_timer->nsecs);
245         our_timer->is_continuous = 0;
246         our_timer->unacked = 0;
247         ao2_ref(our_timer, -1);
248         return 0;
249 }
250
251 static enum ast_timer_event kqueue_timer_get_event(int handle)
252 {
253         enum ast_timer_event res = -1;
254         struct kqueue_timer *our_timer;
255         struct timespec sixty_seconds = { 60, 0 };
256         struct kevent kev;
257
258         if (!(our_timer = lookup_timer(handle))) {
259                 return -1;
260         }
261
262         /* If we have non-ACKed events, just return immediately */
263         if (our_timer->unacked == 0) {
264                 if (kevent(handle, NULL, 0, &kev, 1, &sixty_seconds) > 0) {
265                         our_timer->unacked += kev.data;
266                 }
267         }
268
269         if (our_timer->unacked > 0) {
270                 res = our_timer->is_continuous ? AST_TIMING_EVENT_CONTINUOUS : AST_TIMING_EVENT_EXPIRED;
271         }
272
273         ao2_ref(our_timer, -1);
274         return res;
275 }
276
277 static unsigned int kqueue_timer_get_max_rate(int handle)
278 {
279         /* Actually, the max rate is 2^64-1 seconds, but that's not representable in a 32-bit integer. */
280         return UINT_MAX;
281 }
282
283 #ifdef TEST_FRAMEWORK
284 AST_TEST_DEFINE(test_kqueue_timing)
285 {
286         int res = AST_TEST_PASS, handle, i;
287         uint64_t diff;
288         struct pollfd pfd = { 0, POLLIN, 0 };
289         struct kqueue_timer *kt;
290         struct timeval start;
291
292         switch (cmd) {
293         case TEST_INIT:
294                 info->name = "test_kqueue_timing";
295                 info->category = "/res/res_timing_kqueue/";
296                 info->summary = "Test KQueue timing interface";
297                 info->description = "Verify that the KQueue timing interface correctly generates timing events";
298                 return AST_TEST_NOT_RUN;
299         case TEST_EXECUTE:
300                 break;
301         }
302
303         if (!(handle = kqueue_timer_open())) {
304                 ast_test_status_update(test, "Cannot open timer!\n");
305                 return AST_TEST_FAIL;
306         }
307
308         do {
309                 pfd.fd = handle;
310                 if (kqueue_timer_set_rate(handle, 1000)) {
311                         ast_test_status_update(test, "Cannot set timer rate to 1000/s\n");
312                         res = AST_TEST_FAIL;
313                         break;
314                 }
315                 if (ast_poll(&pfd, 1, 1000) < 1) {
316                         ast_test_status_update(test, "Polling on a kqueue doesn't work\n");
317                         res = AST_TEST_FAIL;
318                         break;
319                 }
320                 if (pfd.revents != POLLIN) {
321                         ast_test_status_update(test, "poll() should have returned POLLIN, but instead returned %hd\n", pfd.revents);
322                         res = AST_TEST_FAIL;
323                         break;
324                 }
325                 if (!(kt = lookup_timer(handle))) {
326                         ast_test_status_update(test, "Could not find timer structure in container?!!\n");
327                         res = AST_TEST_FAIL;
328                         break;
329                 }
330                 if (kqueue_timer_get_event(handle) <= 0) {
331                         ast_test_status_update(test, "No events generated after a poll returned successfully?!!\n");
332                         res = AST_TEST_FAIL;
333                         break;
334                 }
335 #if 0
336                 if (kt->unacked == 0) {
337                         ast_test_status_update(test, "Unacked events is 0, but there should be at least 1.\n");
338                         res = AST_TEST_FAIL;
339                         break;
340                 }
341 #endif
342                 kqueue_timer_enable_continuous(handle);
343                 start = ast_tvnow();
344                 for (i = 0; i < 100; i++) {
345                         if (ast_poll(&pfd, 1, 1000) < 1) {
346                                 ast_test_status_update(test, "Polling on a kqueue doesn't work\n");
347                                 res = AST_TEST_FAIL;
348                                 break;
349                         }
350                         if (kqueue_timer_get_event(handle) <= 0) {
351                                 ast_test_status_update(test, "No events generated in continuous mode after 1 microsecond?!!\n");
352                                 res = AST_TEST_FAIL;
353                                 break;
354                         }
355                 }
356                 diff = ast_tvdiff_us(ast_tvnow(), start);
357                 ast_test_status_update(test, "diff is %llu\n", diff);
358                 /*
359                 if (abs(diff - kt->unacked) == 0) {
360                         ast_test_status_update(test, "Unacked events should be around 1000, not %llu\n", kt->unacked);
361                         res = AST_TEST_FAIL;
362                 }
363                 */
364         } while (0);
365         kqueue_timer_close(handle);
366         return res;
367 }
368 #endif
369
370 /*!
371  * \brief Load the module
372  *
373  * Module loading including tests for configuration or dependencies.
374  * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
375  * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
376  * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the 
377  * configuration file or other non-critical problem return 
378  * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
379  */
380 static int load_module(void)
381 {
382         if (!(kqueue_timers = ao2_container_alloc(563, kqueue_timer_hash, kqueue_timer_cmp))) {
383                 return AST_MODULE_LOAD_DECLINE;
384         }
385
386         if (!(timing_funcs_handle = ast_register_timing_interface(&kqueue_timing))) {
387                 ao2_ref(kqueue_timers, -1);
388                 return AST_MODULE_LOAD_DECLINE;
389         }
390
391         AST_TEST_REGISTER(test_kqueue_timing);
392         return AST_MODULE_LOAD_SUCCESS;
393 }
394
395 static int unload_module(void)
396 {
397         int res;
398
399         AST_TEST_UNREGISTER(test_kqueue_timing);
400         if (!(res = ast_unregister_timing_interface(timing_funcs_handle))) {
401                 ao2_ref(kqueue_timers, -1);
402                 kqueue_timers = NULL;
403         }
404
405         return res;
406 }
407
408 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "KQueue Timing Interface",
409                 .load = load_module,
410                 .unload = unload_module,
411                 .load_pri = AST_MODPRI_CHANNEL_DEPEND,
412                 );