Fix some timer state corruption.
[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 = 0;
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         if (!our_timer->is_continuous) {
150                 res = timerfd_settime(handle, 0, &our_timer->saved_timer, NULL);
151         }
152
153         ao2_ref(our_timer, -1);
154
155         return res;
156 }
157
158 static void timerfd_timer_ack(int handle, unsigned int quantity)
159 {
160         uint64_t expirations;
161         int read_result = 0;
162
163         do {
164                 read_result = read(handle, &expirations, sizeof(expirations));
165                 if (read_result == -1) {
166                         if (errno == EINTR) {
167                                 continue;
168                         } else {
169                                 ast_log(LOG_ERROR, "Read error: %s\n", strerror(errno));
170                                 break;
171                         }
172                 }
173         } while (read_result != sizeof(expirations));
174
175         if (expirations != quantity) {
176                 ast_debug(2, "Expected to acknowledge %u ticks but got %llu instead\n", quantity, (unsigned long long) expirations);
177         }
178 }
179
180 static int timerfd_timer_enable_continuous(int handle)
181 {
182         int res;
183         struct itimerspec continuous_timer = {
184                 .it_value.tv_nsec = 1L,
185         };
186         struct timerfd_timer *our_timer, find_helper = {
187                 .handle = handle,
188         };
189
190         if (!(our_timer = ao2_find(timerfd_timers, &find_helper, OBJ_POINTER))) {
191                 ast_log(LOG_ERROR, "Couldn't find timer with handle %d\n", handle);
192                 return -1;
193         }
194
195         if (our_timer->is_continuous) {
196                 /*It's already in continous mode, no need to do
197                  * anything further
198                  */
199                 ao2_ref(our_timer, -1);
200                 return 0;
201         }
202
203         res = timerfd_settime(handle, 0, &continuous_timer, &our_timer->saved_timer);
204         our_timer->is_continuous = 1;
205         ao2_ref(our_timer, -1);
206         return res;
207 }
208
209 static int timerfd_timer_disable_continuous(int handle)
210 {
211         int res;
212         struct timerfd_timer *our_timer, find_helper = {
213                 .handle = handle,
214         };
215
216         if (!(our_timer = ao2_find(timerfd_timers, &find_helper, OBJ_POINTER))) {
217                 ast_log(LOG_ERROR, "Couldn't find timer with handle %d\n", handle);
218                 return -1;
219         }
220
221         if(!our_timer->is_continuous) {
222                 /* No reason to do anything if we're not
223                  * in continuous mode
224                  */
225                 ao2_ref(our_timer, -1);
226                 return 0;
227         }
228
229         res = timerfd_settime(handle, 0, &our_timer->saved_timer, NULL);
230         our_timer->is_continuous = 0;
231         memset(&our_timer->saved_timer, 0, sizeof(our_timer->saved_timer));
232         ao2_ref(our_timer, -1);
233         return res;
234 }
235
236 static enum ast_timer_event timerfd_timer_get_event(int handle)
237 {
238         enum ast_timer_event res;
239         struct timerfd_timer *our_timer, find_helper = {
240                 .handle = handle,
241         };
242
243         if (!(our_timer = ao2_find(timerfd_timers, &find_helper, OBJ_POINTER))) {
244                 ast_log(LOG_ERROR, "Couldn't find timer with handle %d\n", handle);
245                 return -1;
246         }
247
248         if (our_timer->is_continuous) {
249                 res = AST_TIMING_EVENT_CONTINUOUS;
250         } else {
251                 res = AST_TIMING_EVENT_EXPIRED;
252         }
253
254         ao2_ref(our_timer, -1);
255         return res;
256 }
257
258 static unsigned int timerfd_timer_get_max_rate(int handle)
259 {
260         return TIMERFD_MAX_RATE;
261 }
262
263 static int load_module(void)
264 {
265         if (!(timerfd_timers = ao2_container_alloc(TIMERFD_TIMER_BUCKETS, timerfd_timer_hash, timerfd_timer_cmp))) {
266                 return AST_MODULE_LOAD_DECLINE;
267         }
268
269         if (!(timing_funcs_handle = ast_register_timing_interface(&timerfd_timing))) {
270                 ao2_ref(timerfd_timers, -1);
271                 return AST_MODULE_LOAD_DECLINE;
272         }
273
274         return AST_MODULE_LOAD_SUCCESS;
275 }
276
277 static int unload_module(void)
278 {
279         int res;
280
281         if (!(res = ast_unregister_timing_interface(timing_funcs_handle))) {
282                 ao2_ref(timerfd_timers, -1);
283                 timerfd_timers = NULL;
284         }
285
286         return res;
287 }
288
289 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Timerfd Timing Interface");