Merged revisions 142354 via svnmerge from
[asterisk/asterisk.git] / main / sched.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@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 /*! \file
20  *
21  * \brief Scheduler Routines (from cheops-NG)
22  *
23  * \author Mark Spencer <markster@digium.com>
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #ifdef DEBUG_SCHEDULER
31 #define DEBUG(a) do { \
32         if (option_debug) \
33                 DEBUG_M(a) \
34         } while (0)
35 #else
36 #define DEBUG(a) 
37 #endif
38
39 #include <sys/time.h>
40
41 #include "asterisk/sched.h"
42 #include "asterisk/channel.h"
43 #include "asterisk/lock.h"
44 #include "asterisk/utils.h"
45 #include "asterisk/linkedlists.h"
46 #include "asterisk/dlinkedlists.h"
47 #include "asterisk/hashtab.h"
48
49 struct sched {
50         AST_DLLIST_ENTRY(sched) list;
51         int id;                       /*!< ID number of event */
52         struct timeval when;          /*!< Absolute time event should take place */
53         int resched;                  /*!< When to reschedule */
54         int variable;                 /*!< Use return value from callback to reschedule */
55         const void *data;             /*!< Data */
56         ast_sched_cb callback;        /*!< Callback */
57 };
58
59 struct sched_context {
60         ast_mutex_t lock;
61         unsigned int eventcnt;                  /*!< Number of events processed */
62         unsigned int schedcnt;                  /*!< Number of outstanding schedule events */
63         unsigned int highwater;                                 /*!< highest count so far */
64         AST_DLLIST_HEAD_NOLOCK(, sched) schedq;   /*!< Schedule entry and main queue */
65         struct ast_hashtab *schedq_ht;             /*!< hash table for fast searching */
66
67 #ifdef SCHED_MAX_CACHE
68         AST_LIST_HEAD_NOLOCK(, sched) schedc;   /*!< Cache of unused schedule structures and how many */
69         unsigned int schedccnt;
70 #endif
71 };
72
73
74 /* hash routines for sched */
75
76 static int sched_cmp(const void *a, const void *b)
77 {
78         const struct sched *as = a;
79         const struct sched *bs = b;
80         return as->id != bs->id; /* return 0 on a match like strcmp would */
81 }
82
83 static unsigned int sched_hash(const void *obj)
84 {
85         const struct sched *s = obj;
86         unsigned int h = s->id;
87         return h;
88 }
89
90 struct sched_context *sched_context_create(void)
91 {
92         struct sched_context *tmp;
93
94         if (!(tmp = ast_calloc(1, sizeof(*tmp))))
95                 return NULL;
96
97         ast_mutex_init(&tmp->lock);
98         tmp->eventcnt = 1;
99         
100         tmp->schedq_ht = ast_hashtab_create(23, sched_cmp, ast_hashtab_resize_java, ast_hashtab_newsize_java, sched_hash, 1);
101         
102         return tmp;
103 }
104
105 void sched_context_destroy(struct sched_context *con)
106 {
107         struct sched *s;
108
109         ast_mutex_lock(&con->lock);
110
111 #ifdef SCHED_MAX_CACHE
112         /* Eliminate the cache */
113         while ((s = AST_LIST_REMOVE_HEAD(&con->schedc, list)))
114                 ast_free(s);
115 #endif
116
117         /* And the queue */
118         while ((s = AST_DLLIST_REMOVE_HEAD(&con->schedq, list)))
119                 ast_free(s);
120
121         ast_hashtab_destroy(con->schedq_ht, NULL);
122         con->schedq_ht = NULL;
123         
124         /* And the context */
125         ast_mutex_unlock(&con->lock);
126         ast_mutex_destroy(&con->lock);
127         ast_free(con);
128 }
129
130 static struct sched *sched_alloc(struct sched_context *con)
131 {
132         struct sched *tmp;
133
134         /*
135          * We keep a small cache of schedule entries
136          * to minimize the number of necessary malloc()'s
137          */
138 #ifdef SCHED_MAX_CACHE
139         if ((tmp = AST_LIST_REMOVE_HEAD(&con->schedc, list)))
140                 con->schedccnt--;
141         else
142 #endif
143                 tmp = ast_calloc(1, sizeof(*tmp));
144
145         return tmp;
146 }
147
148 static void sched_release(struct sched_context *con, struct sched *tmp)
149 {
150         /*
151          * Add to the cache, or just free() if we
152          * already have too many cache entries
153          */
154
155 #ifdef SCHED_MAX_CACHE   
156         if (con->schedccnt < SCHED_MAX_CACHE) {
157                 AST_LIST_INSERT_HEAD(&con->schedc, tmp, list);
158                 con->schedccnt++;
159         } else
160 #endif
161                 ast_free(tmp);
162 }
163
164 /*! \brief
165  * Return the number of milliseconds 
166  * until the next scheduled event
167  */
168 int ast_sched_wait(struct sched_context *con)
169 {
170         int ms;
171
172         DEBUG(ast_debug(1, "ast_sched_wait()\n"));
173
174         ast_mutex_lock(&con->lock);
175         if (AST_DLLIST_EMPTY(&con->schedq)) {
176                 ms = -1;
177         } else {
178                 ms = ast_tvdiff_ms(AST_DLLIST_FIRST(&con->schedq)->when, ast_tvnow());
179                 if (ms < 0)
180                         ms = 0;
181         }
182         ast_mutex_unlock(&con->lock);
183
184         return ms;
185 }
186
187
188 /*! \brief
189  * Take a sched structure and put it in the
190  * queue, such that the soonest event is
191  * first in the list. 
192  */
193 static void schedule(struct sched_context *con, struct sched *s)
194 {
195         struct sched *cur = NULL;
196         int ret;
197         int df = 0;
198         int de = 0;
199         struct sched *first = AST_DLLIST_FIRST(&con->schedq);
200         struct sched *last = AST_DLLIST_LAST(&con->schedq);
201
202         if (first)
203                 df = ast_tvdiff_us(s->when, first->when);
204         if (last)
205                 de = ast_tvdiff_us(s->when, last->when);
206
207         if (df < 0)
208                 df = -df;
209         if (de < 0)
210                 de = -de;
211
212         if (df < de) {
213                 AST_DLLIST_TRAVERSE(&con->schedq, cur, list) {
214                         if (ast_tvcmp(s->when, cur->when) == -1) {
215                                 AST_DLLIST_INSERT_BEFORE(&con->schedq, cur, s, list);
216                                 break;
217                         }
218                 }
219                 if (!cur) {
220                         AST_DLLIST_INSERT_TAIL(&con->schedq, s, list);
221                 }
222         } else {
223                 AST_DLLIST_TRAVERSE_BACKWARDS(&con->schedq, cur, list) {
224                         if (ast_tvcmp(s->when, cur->when) == 1) {
225                                 AST_DLLIST_INSERT_AFTER(&con->schedq, cur, s, list);
226                                 break;
227                         }
228                 }
229                 if (!cur) {
230                         AST_DLLIST_INSERT_HEAD(&con->schedq, s, list);
231                 }
232         }
233
234         ret = ast_hashtab_insert_safe(con->schedq_ht, s);
235         if (!ret)
236                 ast_log(LOG_WARNING,"Schedule Queue entry %d is already in table!\n",s->id);
237
238         con->schedcnt++;
239
240         if (con->schedcnt > con->highwater)
241                 con->highwater = con->schedcnt;
242 }
243
244 /*! \brief
245  * given the last event *tv and the offset in milliseconds 'when',
246  * computes the next value,
247  */
248 static int sched_settime(struct timeval *t, int when)
249 {
250         struct timeval now = ast_tvnow();
251
252         /*ast_debug(1, "TV -> %lu,%lu\n", tv->tv_sec, tv->tv_usec);*/
253         if (ast_tvzero(*t))     /* not supplied, default to now */
254                 *t = now;
255         *t = ast_tvadd(*t, ast_samp2tv(when, 1000));
256         if (ast_tvcmp(*t, now) < 0) {
257                 *t = now;
258         }
259         return 0;
260 }
261
262 int ast_sched_replace_variable(int old_id, struct sched_context *con, int when, ast_sched_cb callback, const void *data, int variable)
263 {
264         /* 0 means the schedule item is new; do not delete */
265         if (old_id > 0) {
266                 AST_SCHED_DEL(con, old_id);
267         }
268         return ast_sched_add_variable(con, when, callback, data, variable);
269 }
270
271 /*! \brief
272  * Schedule callback(data) to happen when ms into the future
273  */
274 int ast_sched_add_variable(struct sched_context *con, int when, ast_sched_cb callback, const void *data, int variable)
275 {
276         struct sched *tmp;
277         int res = -1;
278
279         DEBUG(ast_debug(1, "ast_sched_add()\n"));
280
281         ast_mutex_lock(&con->lock);
282         if ((tmp = sched_alloc(con))) {
283                 tmp->id = con->eventcnt++;
284                 tmp->callback = callback;
285                 tmp->data = data;
286                 tmp->resched = when;
287                 tmp->variable = variable;
288                 tmp->when = ast_tv(0, 0);
289                 if (sched_settime(&tmp->when, when)) {
290                         sched_release(con, tmp);
291                 } else {
292                         schedule(con, tmp);
293                         res = tmp->id;
294                 }
295         }
296 #ifdef DUMP_SCHEDULER
297         /* Dump contents of the context while we have the lock so nothing gets screwed up by accident. */
298         if (option_debug)
299                 ast_sched_dump(con);
300 #endif
301         ast_mutex_unlock(&con->lock);
302
303         return res;
304 }
305
306 int ast_sched_replace(int old_id, struct sched_context *con, int when, ast_sched_cb callback, const void *data)
307 {
308         if (old_id > -1) {
309                 AST_SCHED_DEL(con, old_id);
310         }
311         return ast_sched_add(con, when, callback, data);
312 }
313
314 int ast_sched_add(struct sched_context *con, int when, ast_sched_cb callback, const void *data)
315 {
316         return ast_sched_add_variable(con, when, callback, data, 0);
317 }
318
319 const void *ast_sched_find_data(struct sched_context *con, int id)
320 {
321         struct sched tmp,*res;
322         tmp.id = id;
323         res = ast_hashtab_lookup(con->schedq_ht, &tmp);
324         if (res)
325                 return res->data;
326         return NULL;
327 }
328         
329 /*! \brief
330  * Delete the schedule entry with number
331  * "id".  It's nearly impossible that there
332  * would be two or more in the list with that
333  * id.
334  */
335 #ifndef AST_DEVMODE
336 int ast_sched_del(struct sched_context *con, int id)
337 #else
338 int _ast_sched_del(struct sched_context *con, int id, const char *file, int line, const char *function)
339 #endif
340 {
341         struct sched *s, tmp;
342
343         DEBUG(ast_debug(1, "ast_sched_del(%d)\n", id));
344         
345         ast_mutex_lock(&con->lock);
346
347         /* OK, this is the heart of the sched performance upgrade.
348            If we have 4700 peers, we can have 4700+ entries in the
349            schedq list. searching this would take time. So, I add a 
350            hashtab to the context to keep track of each entry, by id.
351            I also leave the linked list alone, almost, --  I implement
352        a doubly-linked list instead, because it would do little good
353            to look up the id in a hashtab, and then have to run thru 
354            a couple thousand entries to remove it from the schedq list! */
355         tmp.id = id;
356         s = ast_hashtab_lookup(con->schedq_ht, &tmp);
357         if (s) {
358                 struct sched *x = AST_DLLIST_REMOVE(&con->schedq, s, list);
359                 
360                 if (!x)
361                         ast_log(LOG_WARNING,"sched entry %d not in the schedq list?\n", s->id);
362
363                 if (!ast_hashtab_remove_this_object(con->schedq_ht, s))
364                         ast_log(LOG_WARNING,"Found sched entry %d, then couldn't remove it?\n", s->id);
365                 con->schedcnt--;
366                 sched_release(con, s);
367         }
368         
369 #ifdef DUMP_SCHEDULER
370         /* Dump contents of the context while we have the lock so nothing gets screwed up by accident. */
371         if (option_debug)
372                 ast_sched_dump(con);
373 #endif
374         ast_mutex_unlock(&con->lock);
375
376         if (!s) {
377                 ast_debug(1, "Attempted to delete nonexistent schedule entry %d!\n", id);
378 #ifndef AST_DEVMODE
379                 ast_assert(s != NULL);
380 #else
381                 _ast_assert(0, "s != NULL", file, line, function);
382 #endif
383                 return -1;
384         }
385         
386         return 0;
387 }
388
389
390 char *ast_sched_report(struct sched_context *con, char *buf, int bufsiz, struct ast_cb_names *cbnames)
391 {
392         int *countlist,i;
393         struct sched *cur;
394         char buf2[1200];
395         ast_sched_cb xxx = NULL;
396         
397         buf[0] = 0;
398         sprintf(buf, " Highwater = %d\n schedcnt = %d\n", con->highwater, con->schedcnt);
399         countlist = ast_calloc(sizeof(int),cbnames->numassocs+1);
400         
401         AST_DLLIST_TRAVERSE(&con->schedq, cur, list) {
402                 /* match the callback to the cblist */
403                 for (i=0;i<cbnames->numassocs;i++) {
404                         if (cur->callback == cbnames->cblist[i])
405                                 break;
406                 }
407                 if (i < cbnames->numassocs)
408                         countlist[i]++;
409                 else {
410                         xxx = cur->callback;
411                         countlist[cbnames->numassocs]++;
412                 }
413         }
414         for (i=0;i<cbnames->numassocs;i++) {
415                 sprintf(buf2,"    %s : %d\n", cbnames->list[i], countlist[i]);
416                 strcat(buf, buf2);
417         }
418         sprintf(buf2,"   <unknown:%p> : %d\n", xxx, countlist[cbnames->numassocs]);
419         strcat( buf, buf2);
420         return buf;
421 }
422
423
424         
425 /*! \brief Dump the contents of the scheduler to LOG_DEBUG */
426 void ast_sched_dump(const struct sched_context *con)
427 {
428         struct sched *q;
429         struct timeval when = ast_tvnow();
430 #ifdef SCHED_MAX_CACHE
431         ast_debug(1, "Asterisk Schedule Dump (%d in Q, %d Total, %d Cache, %d high-water)\n", con->schedcnt, con->eventcnt - 1, con->schedccnt, con->highwater);
432 #else
433         ast_debug(1, "Asterisk Schedule Dump (%d in Q, %d Total, %d high-water)\n", con->schedcnt, con->eventcnt - 1, con->highwater);
434 #endif
435
436         ast_debug(1, "=============================================================\n");
437         ast_debug(1, "|ID    Callback          Data              Time  (sec:ms)   |\n");
438         ast_debug(1, "+-----+-----------------+-----------------+-----------------+\n");
439         AST_DLLIST_TRAVERSE(&con->schedq, q, list) {
440                 struct timeval delta = ast_tvsub(q->when, when);
441
442                 ast_debug(1, "|%.4d | %-15p | %-15p | %.6ld : %.6ld |\n", 
443                         q->id,
444                         q->callback,
445                         q->data,
446                         (long)delta.tv_sec,
447                         (long int)delta.tv_usec);
448         }
449         ast_debug(1, "=============================================================\n");
450         
451 }
452
453 /*! \brief
454  * Launch all events which need to be run at this time.
455  */
456 int ast_sched_runq(struct sched_context *con)
457 {
458         struct sched *current;
459         struct timeval when;
460         int numevents;
461         int res;
462
463         DEBUG(ast_debug(1, "ast_sched_runq()\n"));
464                 
465         ast_mutex_lock(&con->lock);
466
467         for (numevents = 0; !AST_DLLIST_EMPTY(&con->schedq); numevents++) {
468                 /* schedule all events which are going to expire within 1ms.
469                  * We only care about millisecond accuracy anyway, so this will
470                  * help us get more than one event at one time if they are very
471                  * close together.
472                  */
473                 when = ast_tvadd(ast_tvnow(), ast_tv(0, 1000));
474                 if (ast_tvcmp(AST_DLLIST_FIRST(&con->schedq)->when, when) != -1)
475                         break;
476                 
477                 current = AST_DLLIST_REMOVE_HEAD(&con->schedq, list);
478                 if (!ast_hashtab_remove_this_object(con->schedq_ht, current))
479                         ast_log(LOG_ERROR,"Sched entry %d was in the schedq list but not in the hashtab???\n", current->id);
480
481                 con->schedcnt--;
482
483                 /*
484                  * At this point, the schedule queue is still intact.  We
485                  * have removed the first event and the rest is still there,
486                  * so it's permissible for the callback to add new events, but
487                  * trying to delete itself won't work because it isn't in
488                  * the schedule queue.  If that's what it wants to do, it 
489                  * should return 0.
490                  */
491                         
492                 ast_mutex_unlock(&con->lock);
493                 res = current->callback(current->data);
494                 ast_mutex_lock(&con->lock);
495                         
496                 if (res) {
497                         /*
498                          * If they return non-zero, we should schedule them to be
499                          * run again.
500                          */
501                         if (sched_settime(&current->when, current->variable? res : current->resched)) {
502                                 sched_release(con, current);
503                         } else
504                                 schedule(con, current);
505                 } else {
506                         /* No longer needed, so release it */
507                         sched_release(con, current);
508                 }
509         }
510
511         ast_mutex_unlock(&con->lock);
512         
513         return numevents;
514 }
515
516 long ast_sched_when(struct sched_context *con,int id)
517 {
518         struct sched *s, tmp;
519         long secs = -1;
520         DEBUG(ast_debug(1, "ast_sched_when()\n"));
521
522         ast_mutex_lock(&con->lock);
523         
524         /* these next 2 lines replace a lookup loop */
525         tmp.id = id;
526         s = ast_hashtab_lookup(con->schedq_ht, &tmp);
527         
528         if (s) {
529                 struct timeval now = ast_tvnow();
530                 secs = s->when.tv_sec - now.tv_sec;
531         }
532         ast_mutex_unlock(&con->lock);
533         
534         return secs;
535 }