fix a few more XML documentation problems
[asterisk/asterisk.git] / res / res_timing_timerfd.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2008, Digium, Inc.
5  *
6  * Mark Michelson <mmichelson@digium.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 Mark Michelson <mmichelson@digium.com>
22  *
23  * \brief timerfd timing interface
24  */
25
26 /*** MODULEINFO
27         <depend>timerfd</depend>
28         <conflict>res_timing_pthread</conflict>
29         <conflict>res_timing_dahdi</conflict>
30  ***/
31
32 #include "asterisk.h"
33
34 #include <sys/timerfd.h>
35
36 #include "asterisk/module.h"
37 #include "asterisk/astobj2.h"
38 #include "asterisk/timing.h"
39 #include "asterisk/logger.h"
40 #include "asterisk/utils.h"
41 #include "asterisk/time.h"
42
43 static void *timing_funcs_handle;
44
45 static int timerfd_timer_open(void);
46 static void timerfd_timer_close(int handle);
47 static int timerfd_timer_set_rate(int handle, unsigned int rate);
48 static void timerfd_timer_ack(int handle, unsigned int quantity);
49 static int timerfd_timer_enable_continuous(int handle);
50 static int timerfd_timer_disable_continuous(int handle);
51 static enum ast_timing_event timerfd_timer_get_event(int handle);
52 static unsigned int timerfd_timer_get_max_rate(int handle);
53
54 static struct ast_timing_functions timerfd_timing_functions = {
55         .timer_open = timerfd_timer_open,
56         .timer_close = timerfd_timer_close,
57         .timer_set_rate = timerfd_timer_set_rate,
58         .timer_ack = timerfd_timer_ack,
59         .timer_enable_continuous = timerfd_timer_enable_continuous,
60         .timer_disable_continuous = timerfd_timer_disable_continuous,
61         .timer_get_event = timerfd_timer_get_event,
62         .timer_get_max_rate = timerfd_timer_get_max_rate,
63 };
64
65 static struct ao2_container *timerfd_timers;
66
67 #define TIMERFD_TIMER_BUCKETS 563
68 #define TIMERFD_MAX_RATE 1000
69
70 struct timerfd_timer {
71         int handle;
72         struct itimerspec saved_timer;
73         unsigned int is_continuous:1;
74 };
75
76 static int timerfd_timer_hash(const void *obj, const int flags)
77 {
78         const struct timerfd_timer *timer = obj;
79
80         return timer->handle;
81 }
82
83 static int timerfd_timer_cmp(void *obj, void *args, int flags)
84 {
85         struct timerfd_timer *timer1 = obj, *timer2 = args;
86         return timer1->handle == timer2->handle ? CMP_MATCH | CMP_STOP : 0;
87 }
88
89 static void timer_destroy(void *obj)
90 {
91         struct timerfd_timer *timer = obj;
92         close(timer->handle);
93 }
94
95 static int timerfd_timer_open(void)
96 {
97         struct timerfd_timer *timer;
98         int handle;
99
100         if (!(timer = ao2_alloc(sizeof(*timer), timer_destroy))) {
101                 ast_log(LOG_ERROR, "Could not allocate memory for timerfd_timer structure\n");
102                 return -1;
103         }
104         if ((handle = timerfd_create(CLOCK_MONOTONIC, 0)) < 0) {
105                 ast_log(LOG_ERROR, "Failed to create timerfd timer: %s\n", strerror(errno));
106                 ao2_ref(timer, -1);
107                 return -1;
108         }
109
110         timer->handle = handle;
111         ao2_link(timerfd_timers, timer);
112         /* Get rid of the reference from the allocation */
113         ao2_ref(timer, -1);
114         return handle;
115 }
116
117 static void timerfd_timer_close(int handle)
118 {
119         struct timerfd_timer *our_timer, find_helper = {
120                 .handle = handle,
121         };
122
123         if (!(our_timer = ao2_find(timerfd_timers, &find_helper, OBJ_POINTER))) {
124                 ast_log(LOG_ERROR, "Couldn't find timer with handle %d\n", handle);
125                 return;
126         }
127
128         ao2_unlink(timerfd_timers, our_timer);
129         ao2_ref(our_timer, -1);
130 }
131
132 static int timerfd_timer_set_rate(int handle, unsigned int rate)
133 {
134         struct timerfd_timer *our_timer, find_helper = {
135                 .handle = handle,
136         };
137
138         if (!(our_timer = ao2_find(timerfd_timers, &find_helper, OBJ_POINTER))) {
139                 ast_log(LOG_ERROR, "Couldn't find timer with handle %d\n", handle);
140                 return -1;
141         }
142
143         our_timer->saved_timer.it_value.tv_sec = 0;
144         our_timer->saved_timer.it_value.tv_nsec = rate ? (long) (1000000000 / rate) : 0L;
145         our_timer->saved_timer.it_interval.tv_sec = our_timer->saved_timer.it_value.tv_sec;
146         our_timer->saved_timer.it_interval.tv_nsec = our_timer->saved_timer.it_value.tv_nsec;
147
148         return timerfd_settime(handle, 0, &our_timer->saved_timer, NULL);
149 }
150
151 static void timerfd_timer_ack(int handle, unsigned int quantity)
152 {
153         uint64_t expirations;
154         int read_result = 0;
155
156         do {
157                 read_result = read(handle, &expirations, sizeof(expirations));
158                 if (read_result == -1) {
159                         if (errno == EINTR) {
160                                 continue;
161                         } else {
162                                 ast_log(LOG_ERROR, "Read error: %s\n", strerror(errno));
163                                 break;
164                         }
165                 }
166         } while (read_result != sizeof(expirations));
167
168         if (expirations != quantity) {
169                 ast_debug(2, "Expected to acknowledge %u ticks but got %llu instead\n", quantity, (unsigned long long) expirations);
170         }
171 }
172
173 static int timerfd_timer_enable_continuous(int handle)
174 {
175         int res;
176         struct itimerspec continuous_timer = {
177                 .it_value.tv_nsec = 1L,
178         };
179         struct timerfd_timer *our_timer, find_helper = {
180                 .handle = handle,
181         };
182
183         if (!(our_timer = ao2_find(timerfd_timers, &find_helper, OBJ_POINTER))) {
184                 ast_log(LOG_ERROR, "Couldn't find timer with handle %d\n", handle);
185                 return -1;
186         }
187
188         if (our_timer->is_continuous) {
189                 /*It's already in continous mode, no need to do
190                  * anything further
191                  */
192                 ao2_ref(our_timer, -1);
193                 return 0;
194         }
195
196         res = timerfd_settime(handle, 0, &continuous_timer, &our_timer->saved_timer);
197         our_timer->is_continuous = 1;
198         ao2_ref(our_timer, -1);
199         return res;
200 }
201
202 static int timerfd_timer_disable_continuous(int handle)
203 {
204         int res;
205         struct timerfd_timer *our_timer, find_helper = {
206                 .handle = handle,
207         };
208
209         if (!(our_timer = ao2_find(timerfd_timers, &find_helper, OBJ_POINTER))) {
210                 ast_log(LOG_ERROR, "Couldn't find timer with handle %d\n", handle);
211                 return -1;
212         }
213
214         if(!our_timer->is_continuous) {
215                 /* No reason to do anything if we're not
216                  * in continuous mode
217                  */
218                 ao2_ref(our_timer, -1);
219                 return 0;
220         }
221
222         res = timerfd_settime(handle, 0, &our_timer->saved_timer, NULL);
223         our_timer->is_continuous = 0;
224         memset(&our_timer->saved_timer, 0, sizeof(our_timer->saved_timer));
225         ao2_ref(our_timer, -1);
226         return res;
227 }
228
229 static enum ast_timing_event timerfd_timer_get_event(int handle)
230 {
231         enum ast_timing_event res;
232         struct timerfd_timer *our_timer, find_helper = {
233                 .handle = handle,
234         };
235
236         if (!(our_timer = ao2_find(timerfd_timers, &find_helper, OBJ_POINTER))) {
237                 ast_log(LOG_ERROR, "Couldn't find timer with handle %d\n", handle);
238                 return -1;
239         }
240
241         if (our_timer->is_continuous) {
242                 res = AST_TIMING_EVENT_CONTINUOUS;
243         } else {
244                 res = AST_TIMING_EVENT_EXPIRED;
245         }
246
247         ao2_ref(our_timer, -1);
248         return res;
249 }
250
251 static unsigned int timerfd_timer_get_max_rate(int handle)
252 {
253         return TIMERFD_MAX_RATE;
254 }
255
256 static int load_module(void)
257 {
258         if (!(timerfd_timers = ao2_container_alloc(TIMERFD_TIMER_BUCKETS, timerfd_timer_hash, timerfd_timer_cmp))) {
259                 return AST_MODULE_LOAD_DECLINE;
260         }
261
262         if (!(timing_funcs_handle = ast_install_timing_functions(&timerfd_timing_functions))) {
263                 ao2_ref(timerfd_timers, -1);
264                 return AST_MODULE_LOAD_DECLINE;
265         }
266
267         return AST_MODULE_LOAD_SUCCESS;
268 }
269
270 static int unload_module(void)
271 {
272         /* ast_uninstall_timing_functions(timing_funcs_handle); */
273
274         /* This module can not currently be unloaded.  No use count handling is being done. */
275
276         return -1;
277 }
278
279 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Timerfd Timing Interface");