9688758f9cea68494112327171da42d41d81d4dd
[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  ***/
29
30 #include "asterisk.h"
31
32 #include <sys/timerfd.h>
33
34 #include "asterisk/module.h"
35 #include "asterisk/astobj2.h"
36 #include "asterisk/timing.h"
37 #include "asterisk/logger.h"
38 #include "asterisk/utils.h"
39 #include "asterisk/time.h"
40
41 static void *timing_funcs_handle;
42
43 static int timerfd_timer_open(void);
44 static void timerfd_timer_close(int handle);
45 static int timerfd_timer_set_rate(int handle, unsigned int rate);
46 static void timerfd_timer_ack(int handle, unsigned int quantity);
47 static int timerfd_timer_enable_continuous(int handle);
48 static int timerfd_timer_disable_continuous(int handle);
49 static enum ast_timer_event timerfd_timer_get_event(int handle);
50 static unsigned int timerfd_timer_get_max_rate(int handle);
51
52 static struct ast_timing_interface timerfd_timing = {
53         .name = "timerfd",
54         .priority = 200,
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         int res;
138
139         if (!(our_timer = ao2_find(timerfd_timers, &find_helper, OBJ_POINTER))) {
140                 ast_log(LOG_ERROR, "Couldn't find timer with handle %d\n", handle);
141                 return -1;
142         }
143
144         our_timer->saved_timer.it_value.tv_sec = 0;
145         our_timer->saved_timer.it_value.tv_nsec = rate ? (long) (1000000000 / rate) : 0L;
146         our_timer->saved_timer.it_interval.tv_sec = our_timer->saved_timer.it_value.tv_sec;
147         our_timer->saved_timer.it_interval.tv_nsec = our_timer->saved_timer.it_value.tv_nsec;
148
149         res = timerfd_settime(handle, 0, &our_timer->saved_timer, NULL);
150
151         ao2_ref(our_timer, -1);
152
153         return res;
154 }
155
156 static void timerfd_timer_ack(int handle, unsigned int quantity)
157 {
158         uint64_t expirations;
159         int read_result = 0;
160
161         do {
162                 read_result = read(handle, &expirations, sizeof(expirations));
163                 if (read_result == -1) {
164                         if (errno == EINTR) {
165                                 continue;
166                         } else {
167                                 ast_log(LOG_ERROR, "Read error: %s\n", strerror(errno));
168                                 break;
169                         }
170                 }
171         } while (read_result != sizeof(expirations));
172
173         if (expirations != quantity) {
174                 ast_debug(2, "Expected to acknowledge %u ticks but got %llu instead\n", quantity, (unsigned long long) expirations);
175         }
176 }
177
178 static int timerfd_timer_enable_continuous(int handle)
179 {
180         int res;
181         struct itimerspec continuous_timer = {
182                 .it_value.tv_nsec = 1L,
183         };
184         struct timerfd_timer *our_timer, find_helper = {
185                 .handle = handle,
186         };
187
188         if (!(our_timer = ao2_find(timerfd_timers, &find_helper, OBJ_POINTER))) {
189                 ast_log(LOG_ERROR, "Couldn't find timer with handle %d\n", handle);
190                 return -1;
191         }
192
193         if (our_timer->is_continuous) {
194                 /*It's already in continous mode, no need to do
195                  * anything further
196                  */
197                 ao2_ref(our_timer, -1);
198                 return 0;
199         }
200
201         res = timerfd_settime(handle, 0, &continuous_timer, &our_timer->saved_timer);
202         our_timer->is_continuous = 1;
203         ao2_ref(our_timer, -1);
204         return res;
205 }
206
207 static int timerfd_timer_disable_continuous(int handle)
208 {
209         int res;
210         struct timerfd_timer *our_timer, find_helper = {
211                 .handle = handle,
212         };
213
214         if (!(our_timer = ao2_find(timerfd_timers, &find_helper, OBJ_POINTER))) {
215                 ast_log(LOG_ERROR, "Couldn't find timer with handle %d\n", handle);
216                 return -1;
217         }
218
219         if(!our_timer->is_continuous) {
220                 /* No reason to do anything if we're not
221                  * in continuous mode
222                  */
223                 ao2_ref(our_timer, -1);
224                 return 0;
225         }
226
227         res = timerfd_settime(handle, 0, &our_timer->saved_timer, NULL);
228         our_timer->is_continuous = 0;
229         memset(&our_timer->saved_timer, 0, sizeof(our_timer->saved_timer));
230         ao2_ref(our_timer, -1);
231         return res;
232 }
233
234 static enum ast_timer_event timerfd_timer_get_event(int handle)
235 {
236         enum ast_timer_event res;
237         struct timerfd_timer *our_timer, find_helper = {
238                 .handle = handle,
239         };
240
241         if (!(our_timer = ao2_find(timerfd_timers, &find_helper, OBJ_POINTER))) {
242                 ast_log(LOG_ERROR, "Couldn't find timer with handle %d\n", handle);
243                 return -1;
244         }
245
246         if (our_timer->is_continuous) {
247                 res = AST_TIMING_EVENT_CONTINUOUS;
248         } else {
249                 res = AST_TIMING_EVENT_EXPIRED;
250         }
251
252         ao2_ref(our_timer, -1);
253         return res;
254 }
255
256 static unsigned int timerfd_timer_get_max_rate(int handle)
257 {
258         return TIMERFD_MAX_RATE;
259 }
260
261 static int load_module(void)
262 {
263         if (!(timerfd_timers = ao2_container_alloc(TIMERFD_TIMER_BUCKETS, timerfd_timer_hash, timerfd_timer_cmp))) {
264                 return AST_MODULE_LOAD_DECLINE;
265         }
266
267         if (!(timing_funcs_handle = ast_register_timing_interface(&timerfd_timing))) {
268                 ao2_ref(timerfd_timers, -1);
269                 return AST_MODULE_LOAD_DECLINE;
270         }
271
272         return AST_MODULE_LOAD_SUCCESS;
273 }
274
275 static int unload_module(void)
276 {
277         int res;
278
279         if (!(res = ast_unregister_timing_interface(timing_funcs_handle))) {
280                 ao2_ref(timerfd_timers, -1);
281                 timerfd_timers = NULL;
282         }
283
284         return res;
285 }
286
287 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Timerfd Timing Interface");