@cfg_get.<group_name>.<var_name> is documented
[sip-router] / local_timer.c
1 /*
2  * $Id$
3  *
4  * Copyright (C) 2007 iptelorg GmbH
5  *
6  * This file is part of ser, a free SIP server.
7  *
8  * ser is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version
12  *
13  * For a license to use the ser software under conditions
14  * other than those described here, or to purchase support for this
15  * software, please contact iptel.org by e-mail at the following addresses:
16  *    info@iptel.org
17  *
18  * ser is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License 
24  * along with this program; if not, write to the Free Software 
25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26  */
27 /* local, per process timer routines
28  * WARNING: this should be used only within the same process, the timers
29  *  are not multi-process safe or multi-thread safe
30  *  (there are no locks)
31  *
32  * History:
33  * --------
34  *  2006-02-03  created by andrei
35  */
36
37
38 #include "timer.h"
39 #include "timer_funcs.h"
40 #include "dprint.h"
41 #include "tcp_conn.h"
42 #include "mem/mem.h"
43 #include "compiler_opt.h"
44
45 #include "local_timer.h"
46
47
48
49 /* init a local_timer handle
50  * returns 0 on success, -1 on error */
51 int init_local_timer(struct local_timer *t, ticks_t crt_ticks)
52 {
53         int r;
54         
55         /* initial values */
56         memset(t, 0, sizeof(*t));
57         t->prev_ticks=crt_ticks;
58         /* init timer structures */
59         for (r=0; r<H0_ENTRIES; r++)
60                 _timer_init_list(&t->timer_lst.h0[r]);
61         for (r=0; r<H1_ENTRIES; r++)
62                 _timer_init_list(&t->timer_lst.h1[r]);
63         for (r=0; r<H2_ENTRIES; r++)
64                 _timer_init_list(&t->timer_lst.h2[r]);
65         _timer_init_list(&t->timer_lst.expired);
66         DBG("init_local_timer: timer_list between %p and %p\n",
67                         &t->timer_lst.h0[0], &t->timer_lst.h2[H2_ENTRIES]);
68         return 0;
69 }
70
71
72
73 void destroy_local_timer(struct local_timer* lt)
74 {
75 }
76
77
78
79 /* generic add timer entry to the timer lists function (see _timer_add)
80  * tl->expire must be set previously, delta is the difference in ticks
81  * from current time to the timer desired expire (should be tl->expire-*tick)
82  * If you don't know delta, you probably want to call _timer_add instead.
83  */
84 static inline int _local_timer_dist_tl(struct local_timer* h, 
85                                                                                 struct timer_ln* tl, ticks_t delta)
86 {
87         if (likely(delta<H0_ENTRIES)){
88                 if (unlikely(delta==0)){
89                         LOG(L_WARN, "WARNING: local_timer: add_timeout: 0 expire timer"
90                                                 " added\n");
91                         _timer_add_list(&h->timer_lst.expired, tl);
92                 }else{
93                         _timer_add_list( &h->timer_lst.h0[tl->expire & H0_MASK], tl);
94                 }
95         }else if (likely(delta<(H0_ENTRIES*H1_ENTRIES))){
96                 _timer_add_list(&h->timer_lst.h1[(tl->expire & H1_H0_MASK)>>H0_BITS],
97                                                         tl);
98         }else{
99                 _timer_add_list(&h->timer_lst.h2[tl->expire>>(H1_BITS+H0_BITS)], tl);
100         }
101         return 0;
102 }
103
104
105
106 static inline void local_timer_redist(struct local_timer* l,
107                                                                                 ticks_t t, struct timer_head *h)
108 {
109         struct timer_ln* tl;
110         struct timer_ln* tmp;
111         
112         timer_foreach_safe(tl, tmp, h){
113                 _local_timer_dist_tl(l, tl, tl->expire-t);
114         }
115         /* clear the current list */
116         _timer_init_list(h);
117 }
118
119
120
121 /* local timer add function (no lock, not multithread or multiprocess safe,
122  * designed for local process use only)
123  * t = current ticks
124  * tl must be filled (the intial_timeout and flags must be set)
125  * returns -1 on error, 0 on success */
126 static inline int _local_timer_add(struct local_timer *h, ticks_t t,
127                                                                         struct timer_ln* tl)
128 {
129         ticks_t delta;
130         
131         delta=tl->initial_timeout;
132         tl->expire=t+delta;
133         return _local_timer_dist_tl(h, tl, delta);
134 }
135
136
137
138 /* "public", safe timer add functions (local process use only)
139  * adds a timer at delta ticks from the current time
140  * returns -1 on error, 0 on success
141  * WARNING: to re-add a deleted or expired timer you must call
142  *          timer_reinit(tl) prior to timer_add
143  *          The default behaviour allows timer_add to add a timer only if it
144  *          has never been added before.*/
145 int local_timer_add(struct local_timer* h, struct timer_ln* tl, ticks_t delta,
146                                                 ticks_t crt_ticks)
147 {
148         int ret;
149         
150         if (unlikely(tl->flags & F_TIMER_ACTIVE)){
151                 DBG("timer_add called on an active timer %p (%p, %p),"
152                                         " flags %x\n", tl, tl->next, tl->prev, tl->flags);
153                 ret=-1; /* refusing to add active or non-reinit. timer */
154                 goto error;
155         }
156         tl->initial_timeout=delta;
157         if (unlikely((tl->next!=0) || (tl->prev!=0))){
158                 LOG(L_CRIT, "BUG: tcp_timer_add: called with linked timer:"
159                                 " %p (%p, %p)\n", tl, tl->next, tl->prev);
160                 ret=-1;
161                 goto error;
162         }
163         tl->flags|=F_TIMER_ACTIVE;
164         ret=_local_timer_add(h, crt_ticks, tl);
165 error:
166         return ret;
167 }
168
169
170
171 /* safe timer delete
172  * deletes tl and inits the list pointer to 0
173  * WARNING: to be able to reuse a deleted timer you must call
174  *          timer_reinit(tl) on it
175  * 
176  */
177 void local_timer_del(struct local_timer* h, struct timer_ln* tl)
178 {
179         /* quick exit if timer inactive */
180         if (unlikely(!(tl->flags & F_TIMER_ACTIVE))){
181                 DBG("timer_del called on an inactive timer %p (%p, %p),"
182                                         " flags %x\n", tl, tl->next, tl->prev, tl->flags);
183                 return;
184         }
185         if (likely((tl->next!=0)&&(tl->prev!=0))){
186                 _timer_rm_list(tl); /* detach */
187                 tl->next=tl->prev=0;
188         }else{
189                 DBG("timer_del: (f) timer %p (%p, %p) flags %x "
190                         "already detached\n",
191                         tl, tl->next, tl->prev, tl->flags);
192         }
193 }
194
195
196
197 /* called from timer_handle*/
198 inline static void local_timer_list_expire(struct local_timer* l, 
199                                                                                         ticks_t t, struct timer_head* h)
200 {
201         struct timer_ln * tl;
202         ticks_t ret;
203         
204         /*DBG("timer_list_expire @ ticks = %lu, list =%p\n",
205                         (unsigned long) *ticks, h);
206         */
207         while(h->next!=(struct timer_ln*)h){
208                 tl=h->next;
209                 _timer_rm_list(tl); /* detach */
210                         tl->next=tl->prev=0; /* debugging */
211                                 /*FIXME: process tcpconn */
212                                 ret=tl->f(t, tl, tl->data);
213                                 if (ret!=0){
214                                         /* not one-shot, re-add it */
215                                         if (ret!=(ticks_t)-1) /* ! periodic */
216                                                 tl->initial_timeout=ret;
217                                         _local_timer_add(l, t, tl);
218                                 }
219         }
220 }
221
222
223
224 /* run all the handler that expire at t ticks */
225 static inline void local_timer_expire(struct local_timer* h, ticks_t t)
226 {
227         /* trust the compiler for optimizing */
228         if (unlikely((t & H0_MASK)==0)){              /*r1*/
229                 if (unlikely((t & H1_H0_MASK)==0)){        /*r2*/
230                         local_timer_redist(h, t, &h->timer_lst.h2[t>>(H0_BITS+H1_BITS)]);
231                 }
232                 
233                 local_timer_redist(h, t, &h->timer_lst.h1[(t & H1_H0_MASK)>>H0_BITS]);
234                                                                                                                         /*r2 >> H0*/
235         }
236         /* run handler immediately, no need to move it to the expired list
237          * (since no locks are used) */
238         local_timer_list_expire(h, t, &h->timer_lst.h0[t & H0_MASK]);
239 }
240
241
242
243 /* "main" local timer routine, should be called with a proper ticks value
244  * WARNING: it should never be called twice for the same ticks value
245  * (it could cause too fast expires for long timers), ticks must be also
246  *  always increasing */
247 void local_timer_run(struct local_timer* lt, ticks_t saved_ticks)
248 {
249         
250                 /* protect against time running backwards */
251                 if (unlikely(lt->prev_ticks>=saved_ticks)){
252                         LOG(L_CRIT, "BUG: local_timer: backwards or still time\n");
253                         /* try to continue */
254                         lt->prev_ticks=saved_ticks-1;
255                         return;
256                 }
257                 /* go through all the "missed" ticks, taking a possible overflow
258                  * into account */
259                 for (lt->prev_ticks=lt->prev_ticks+1; lt->prev_ticks!=saved_ticks; 
260                                                                                                                         lt->prev_ticks++)
261                         local_timer_expire(lt, lt->prev_ticks);
262                 local_timer_expire(lt, lt->prev_ticks); /* do it for saved_ticks too */
263         local_timer_list_expire(lt, saved_ticks, &lt->timer_lst.expired);
264         /* WARNING: add_timer(...,0) must go directly to expired list, since
265          * otherwise there is a race between timer running and adding it
266          * (it could expire it H0_ENTRIES ticks later instead of 'now')*/
267 }
268