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