dadbbbc5b832226d41a6c896f7c001441115b504
[olsrd.git] / src / scheduler.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2009, the olsr.org team - see HISTORY file
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 #include <sys/times.h>
43 #include <unistd.h>
44 #include <assert.h>
45 #include <stdlib.h>
46
47 #include "common/avl.h"
48 #include "common/avl_olsr_comp.h"
49 #include "scheduler.h"
50 #include "link_set.h"
51 #include "olsr.h"
52 #include "olsr_cookie.h"
53 #include "os_net.h"
54 #include "olsr_logging.h"
55
56 /* Timer data, global. Externed in scheduler.h */
57 uint32_t now_times;                    /* relative time compared to startup (in milliseconds */
58 struct timeval first_tv;               /* timevalue during startup */
59 struct timeval last_tv;                /* timevalue used for last olsr_times() calculation */
60
61 /* Hashed root of all timers */
62 static struct list_entity timer_wheel[TIMER_WHEEL_SLOTS];
63 static uint32_t timer_last_run;        /* remember the last timeslot walk */
64
65 /* Memory cookie for the timer manager */
66 struct avl_tree timerinfo_tree;
67 static struct olsr_cookie_info *timer_mem_cookie = NULL;
68 static struct olsr_cookie_info *timerinfo_cookie = NULL;
69
70 /* Head of all OLSR used sockets */
71 static struct list_entity socket_head;
72
73 /* Prototypes */
74 static void walk_timers(uint32_t *);
75 static void poll_sockets(void);
76 static uint32_t calc_jitter(unsigned int rel_time, uint8_t jitter_pct, unsigned int random_val);
77
78 /*
79  * A wrapper around times(2). Note, that this function has some
80  * portability problems, so do not rely on absolute values returned.
81  * Under Linux, uclibc and libc directly call the sys_times() located
82  * in kernel/sys.c and will only return an error if the tms_buf is
83  * not writeable.
84  */
85 static uint32_t
86 olsr_times(void)
87 {
88   struct timeval tv;
89   uint32_t t;
90
91   if (gettimeofday(&tv, NULL) != 0) {
92     OLSR_ERROR(LOG_SCHEDULER, "OS clock is not working, have to shut down OLSR (%s)\n", strerror(errno));
93     olsr_exit(1);
94   }
95
96   /* test if time jumped backward or more than 60 seconds forward */
97   if (tv.tv_sec < last_tv.tv_sec || (tv.tv_sec == last_tv.tv_sec && tv.tv_usec < last_tv.tv_usec)
98       || tv.tv_sec - last_tv.tv_sec > 60) {
99     OLSR_WARN(LOG_SCHEDULER, "Time jump (%d.%06d to %d.%06d)\n",
100               (int32_t) (last_tv.tv_sec), (int32_t) (last_tv.tv_usec), (int32_t) (tv.tv_sec), (int32_t) (tv.tv_usec));
101
102     t = (last_tv.tv_sec - first_tv.tv_sec) * 1000 + (last_tv.tv_usec - first_tv.tv_usec) / 1000;
103     t++;                        /* advance time by one millisecond */
104
105     first_tv = tv;
106     first_tv.tv_sec -= (t / 1000);
107     first_tv.tv_usec -= ((t % 1000) * 1000);
108
109     if (first_tv.tv_usec < 0) {
110       first_tv.tv_sec--;
111       first_tv.tv_usec += 1000000;
112     }
113     last_tv = tv;
114     return t;
115   }
116   last_tv = tv;
117   return (tv.tv_sec - first_tv.tv_sec) * 1000 + (tv.tv_usec - first_tv.tv_usec) / 1000;
118 }
119
120 /**
121  * Returns a timestamp s seconds in the future
122  */
123 uint32_t
124 olsr_getTimestamp(uint32_t s)
125 {
126   return now_times + s;
127 }
128
129 /**
130  * Returns the number of milliseconds until the timestamp will happen
131  */
132
133 int32_t
134 olsr_getTimeDue(uint32_t s)
135 {
136   uint32_t diff;
137   if (s > now_times) {
138     diff = s - now_times;
139
140     /* overflow ? */
141     if (diff > (1u << 31)) {
142       return -(int32_t) (0xffffffff - diff);
143     }
144     return (int32_t) (diff);
145   }
146
147   diff = now_times - s;
148   /* overflow ? */
149   if (diff > (1u << 31)) {
150     return (int32_t) (0xffffffff - diff);
151   }
152   return -(int32_t) (diff);
153 }
154
155 bool
156 olsr_isTimedOut(uint32_t s)
157 {
158   if (s > now_times) {
159     return s - now_times > (1u << 31);
160   }
161
162   return now_times - s <= (1u << 31);
163 }
164
165 struct olsr_timer_info *
166 olsr_alloc_timerinfo(const char *name, timer_cb_func callback, bool periodic) {
167   struct olsr_timer_info *ti;
168
169   ti = olsr_cookie_malloc(timerinfo_cookie);
170   ti->name = strdup(name);
171   ti->node.key = ti->name;
172   ti->callback = callback;
173   ti->periodic = periodic;
174
175   avl_insert(&timerinfo_tree, &ti->node);
176   return ti;
177 }
178
179 /**
180  * Add a socket and handler to the socketset
181  * beeing used in the main select(2) loop
182  * in listen_loop
183  *
184  *@param fd the socket
185  *@param pf the processing function
186  */
187 void
188 add_olsr_socket(int fd, socket_handler_func pf_pr, socket_handler_func pf_imm, void *data, unsigned int flags)
189 {
190   struct olsr_socket_entry *new_entry;
191
192   if (fd < 0 || (pf_pr == NULL && pf_imm == NULL)) {
193     OLSR_WARN(LOG_SCHEDULER, "Bogus socket entry - not registering...");
194     return;
195   }
196   OLSR_DEBUG(LOG_SCHEDULER, "Adding OLSR socket entry %d\n", fd);
197
198   new_entry = olsr_malloc(sizeof(*new_entry), "Socket entry");
199
200   new_entry->fd = fd;
201   new_entry->process_immediate = pf_imm;
202   new_entry->process_pollrate = pf_pr;
203   new_entry->data = data;
204   new_entry->flags = flags;
205
206   /* Queue */
207   list_add_before(&socket_head, &new_entry->socket_node);
208 }
209
210 /**
211  * Remove a socket and handler to the socketset
212  * beeing used in the main select(2) loop
213  * in listen_loop
214  *
215  *@param fd the socket
216  *@param pf the processing function
217  */
218 int
219 remove_olsr_socket(int fd, socket_handler_func pf_pr, socket_handler_func pf_imm)
220 {
221   struct olsr_socket_entry *entry;
222   struct list_iterator iterator;
223
224   if (fd < 0 || (pf_pr == NULL && pf_imm == NULL)) {
225     OLSR_WARN(LOG_SCHEDULER, "Bogus socket entry - not processing...");
226     return 0;
227   }
228   OLSR_DEBUG(LOG_SCHEDULER, "Removing OLSR socket entry %d\n", fd);
229
230   OLSR_FOR_ALL_SOCKETS(entry, iterator) {
231     if (entry->fd == fd && entry->process_immediate == pf_imm && entry->process_pollrate == pf_pr) {
232       /* just mark this node as "deleted", it will be cleared later at the end of handle_fds() */
233       entry->process_immediate = NULL;
234       entry->process_pollrate = NULL;
235       entry->flags = 0;      return 1;
236     }
237   }
238   return 0;
239 }
240
241 void
242 enable_olsr_socket(int fd, socket_handler_func pf_pr, socket_handler_func pf_imm, unsigned int flags)
243 {
244   struct olsr_socket_entry *entry;
245   struct list_iterator iterator;
246
247   OLSR_FOR_ALL_SOCKETS(entry, iterator) {
248     if (entry->fd == fd && entry->process_immediate == pf_imm && entry->process_pollrate == pf_pr) {
249       entry->flags |= flags;
250     }
251   }
252 }
253
254 void
255 disable_olsr_socket(int fd, socket_handler_func pf_pr, socket_handler_func pf_imm, unsigned int flags)
256 {
257   struct olsr_socket_entry *entry;
258   struct list_iterator iterator;
259
260   OLSR_FOR_ALL_SOCKETS(entry, iterator) {
261     if (entry->fd == fd && entry->process_immediate == pf_imm && entry->process_pollrate == pf_pr) {
262       entry->flags &= ~flags;
263     }
264   }
265 }
266
267 /**
268  * Close and free all sockets.
269  */
270 void
271 olsr_flush_sockets(void)
272 {
273   struct olsr_socket_entry *entry;
274   struct list_iterator iterator;
275
276   OLSR_FOR_ALL_SOCKETS(entry, iterator) {
277     CLOSESOCKET(entry->fd);
278     list_remove(&entry->socket_node);
279     free(entry);
280   }
281 }
282
283 static void
284 poll_sockets(void)
285 {
286   int n;
287   struct olsr_socket_entry *entry;
288   struct list_iterator iterator;
289   fd_set ibits, obits;
290   struct timeval tvp = { 0, 0 };
291   int hfd = 0, fdsets = 0;
292
293   /* If there are no registered sockets we
294    * do not call select(2)
295    */
296   if (list_is_empty(&socket_head)) {
297     return;
298   }
299
300   FD_ZERO(&ibits);
301   FD_ZERO(&obits);
302
303   /* Adding file-descriptors to FD set */
304   OLSR_FOR_ALL_SOCKETS(entry, iterator) {
305     if (entry->process_pollrate == NULL) {
306       continue;
307     }
308     if ((entry->flags & SP_PR_READ) != 0) {
309       fdsets |= SP_PR_READ;
310       FD_SET((unsigned int)entry->fd, &ibits);  /* And we cast here since we get a warning on Win32 */
311     }
312     if ((entry->flags & SP_PR_WRITE) != 0) {
313       fdsets |= SP_PR_WRITE;
314       FD_SET((unsigned int)entry->fd, &obits);  /* And we cast here since we get a warning on Win32 */
315     }
316     if ((entry->flags & (SP_PR_READ | SP_PR_WRITE)) != 0 && entry->fd >= hfd) {
317       hfd = entry->fd + 1;
318     }
319   }
320
321   /* Running select on the FD set */
322   do {
323     n = olsr_select(hfd, fdsets & SP_PR_READ ? &ibits : NULL, fdsets & SP_PR_WRITE ? &obits : NULL, NULL, &tvp);
324   } while (n == -1 && errno == EINTR);
325
326   if (n == 0) {
327     return;
328   }
329   if (n == -1) {                /* Did something go wrong? */
330     OLSR_WARN(LOG_SCHEDULER, "select error: %s", strerror(errno));
331     return;
332   }
333
334   /* Update time since this is much used by the parsing functions */
335   now_times = olsr_times();
336   OLSR_FOR_ALL_SOCKETS(entry, iterator) {
337     int flags;
338     if (entry->process_pollrate == NULL) {
339       continue;
340     }
341     flags = 0;
342     if (FD_ISSET(entry->fd, &ibits)) {
343       flags |= SP_PR_READ;
344     }
345     if (FD_ISSET(entry->fd, &obits)) {
346       flags |= SP_PR_WRITE;
347     }
348     if (flags != 0) {
349       entry->process_pollrate(entry->fd, entry->data, flags);
350     }
351   }
352 }
353
354 static void
355 handle_fds(uint32_t next_interval)
356 {
357   struct olsr_socket_entry *entry;
358   struct list_iterator iterator;
359   struct timeval tvp;
360   int32_t remaining;
361
362   /* calculate the first timeout */
363   now_times = olsr_times();
364
365   remaining = TIME_DUE(next_interval);
366   if (remaining <= 0) {
367     /* we are already over the interval */
368     if (list_is_empty(&socket_head)) {
369       /* If there are no registered sockets we do not call select(2) */
370       return;
371     }
372     tvp.tv_sec = 0;
373     tvp.tv_usec = 0;
374   } else {
375     /* we need an absolute time - milliseconds */
376     tvp.tv_sec = remaining / MSEC_PER_SEC;
377     tvp.tv_usec = (remaining % MSEC_PER_SEC) * USEC_PER_MSEC;
378   }
379
380   /* do at least one select */
381   for (;;) {
382     fd_set ibits, obits;
383     int n, hfd = 0, fdsets = 0;
384     FD_ZERO(&ibits);
385     FD_ZERO(&obits);
386
387     /* Adding file-descriptors to FD set */
388     OLSR_FOR_ALL_SOCKETS(entry, iterator) {
389       if (entry->process_immediate == NULL) {
390         continue;
391       }
392       if ((entry->flags & SP_IMM_READ) != 0) {
393         fdsets |= SP_IMM_READ;
394         FD_SET((unsigned int)entry->fd, &ibits);        /* And we cast here since we get a warning on Win32 */
395       }
396       if ((entry->flags & SP_IMM_WRITE) != 0) {
397         fdsets |= SP_IMM_WRITE;
398         FD_SET((unsigned int)entry->fd, &obits);        /* And we cast here since we get a warning on Win32 */
399       }
400       if ((entry->flags & (SP_IMM_READ | SP_IMM_WRITE)) != 0 && entry->fd >= hfd) {
401         hfd = entry->fd + 1;
402       }
403     }
404
405     if (hfd == 0 && (long)remaining <= 0) {
406       /* we are over the interval and we have no fd's. Skip the select() etc. */
407       return;
408     }
409
410     do {
411       n = olsr_select(hfd, fdsets & SP_IMM_READ ? &ibits : NULL, fdsets & SP_IMM_WRITE ? &obits : NULL, NULL, &tvp);
412     } while (n == -1 && errno == EINTR);
413
414     if (n == 0) {               /* timeout! */
415       break;
416     }
417     if (n == -1) {              /* Did something go wrong? */
418       OLSR_WARN(LOG_SCHEDULER, "select error: %s", strerror(errno));
419       break;
420     }
421
422     /* Update time since this is much used by the parsing functions */
423     now_times = olsr_times();
424     OLSR_FOR_ALL_SOCKETS(entry, iterator) {
425       int flags;
426       if (entry->process_immediate == NULL) {
427         continue;
428       }
429       flags = 0;
430       if (FD_ISSET(entry->fd, &ibits)) {
431         flags |= SP_IMM_READ;
432       }
433       if (FD_ISSET(entry->fd, &obits)) {
434         flags |= SP_IMM_WRITE;
435       }
436       if (flags != 0) {
437         entry->process_immediate(entry->fd, entry->data, flags);
438       }
439     }
440
441     /* calculate the next timeout */
442     remaining = TIME_DUE(next_interval);
443     if (remaining <= 0) {
444       /* we are already over the interval */
445       break;
446     }
447     /* we need an absolute time - milliseconds */
448     tvp.tv_sec = remaining / MSEC_PER_SEC;
449     tvp.tv_usec = (remaining % MSEC_PER_SEC) * USEC_PER_MSEC;
450   }
451
452   OLSR_FOR_ALL_SOCKETS(entry, iterator) {
453     if (entry->process_immediate == NULL && entry->process_pollrate == NULL) {
454       /* clean up socket handler */
455       list_remove(&entry->socket_node);
456       free(entry);
457     }
458   }
459 }
460
461 /**
462  * Main scheduler event loop. Polls at every
463  * sched_poll_interval and calls all functions
464  * that are timed out or that are triggered.
465  * Also calls the olsr_process_changes()
466  * function at every poll.
467  *
468  * @return nada
469  */
470 void
471 olsr_scheduler(void)
472 {
473   OLSR_INFO(LOG_SCHEDULER, "Scheduler started - polling every %u ms\n", olsr_cnf->pollrate);
474
475   /* Main scheduler loop */
476   while (app_state == STATE_RUNNING) {
477     uint32_t next_interval;
478
479     /*
480      * Update the global timestamp. We are using a non-wallclock timer here
481      * to avoid any undesired side effects if the system clock changes.
482      */
483     now_times = olsr_times();
484     next_interval = GET_TIMESTAMP(olsr_cnf->pollrate);
485
486     /* Read incoming data */
487     poll_sockets();
488
489     /* Process timers */
490     walk_timers(&timer_last_run);
491
492     /* Update */
493     olsr_process_changes();
494
495     /* Check for changes in topology */
496     if (link_changes) {
497       increase_local_ansn_number();
498       OLSR_DEBUG(LOG_SCHEDULER, "ANSN UPDATED %d\n\n", get_local_ansn_number());
499       link_changes = false;
500     }
501
502     /* Read incoming data and handle it immediiately */
503     handle_fds(next_interval);
504   }
505 }
506
507 /**
508  * Decrement a relative timer by a random number range.
509  *
510  * @param the relative timer expressed in units of milliseconds.
511  * @param the jitter in percent
512  * @param cached result of random() at system init.
513  * @return the absolute timer in system clock tick units
514  */
515 static uint32_t
516 calc_jitter(unsigned int rel_time, uint8_t jitter_pct, unsigned int random_val)
517 {
518   unsigned int jitter_time;
519
520   /*
521    * No jitter or, jitter larger than 99% does not make sense.
522    * Also protect against overflows resulting from > 25 bit timers.
523    */
524   if (jitter_pct == 0 || jitter_pct > 99 || rel_time > (1 << 24)) {
525     return GET_TIMESTAMP(rel_time);
526   }
527
528   /*
529    * Play some tricks to avoid overflows with integer arithmetic.
530    */
531   jitter_time = (jitter_pct * rel_time) / 100;
532   jitter_time = random_val / (1 + RAND_MAX / (jitter_time + 1));
533
534   OLSR_DEBUG(LOG_SCHEDULER, "TIMER: jitter %u%% rel_time %ums to %ums\n", jitter_pct, rel_time, rel_time - jitter_time);
535
536   return GET_TIMESTAMP(rel_time - jitter_time);
537 }
538
539 /**
540  * Init datastructures for maintaining timers.
541  */
542 void
543 olsr_init_timers(void)
544 {
545   int idx;
546
547   OLSR_INFO(LOG_SCHEDULER, "Initializing scheduler.\n");
548
549   /* Grab initial timestamp */
550   if (gettimeofday(&first_tv, NULL)) {
551     OLSR_ERROR(LOG_SCHEDULER, "OS clock is not working, have to shut down OLSR (%s)\n", strerror(errno));
552     olsr_exit(1);
553   }
554   last_tv = first_tv;
555   now_times = olsr_times();
556
557   /* init lists */
558   list_init_head(&socket_head);
559   for (idx = 0; idx < TIMER_WHEEL_SLOTS; idx++) {
560     list_init_head(&timer_wheel[idx]);
561   }
562
563   /*
564    * Reset the last timer run.
565    */
566   timer_last_run = now_times;
567
568   /* Allocate a cookie for the block based memory manager. */
569   timer_mem_cookie = olsr_create_memcookie("timer_entry", sizeof(struct timer_entry));
570
571   avl_init(&timerinfo_tree, avl_comp_strcasecmp, false, NULL);
572   timerinfo_cookie = olsr_create_memcookie("timerinfo", sizeof(struct olsr_timer_info));
573 }
574
575 /**
576  * Walk through the timer list and check if any timer is ready to fire.
577  * Callback the provided function with the context pointer.
578  */
579 static void
580 walk_timers(uint32_t * last_run)
581 {
582   unsigned int total_timers_walked = 0, total_timers_fired = 0;
583   unsigned int wheel_slot_walks = 0;
584
585   /*
586    * Check the required wheel slots since the last time a timer walk was invoked,
587    * or check *all* the wheel slots, whatever is less work.
588    * The latter is meant as a safety belt if the scheduler falls behind.
589    */
590   while ((*last_run <= now_times) && (wheel_slot_walks < TIMER_WHEEL_SLOTS)) {
591     struct list_entity tmp_head_node;
592     /* keep some statistics */
593     unsigned int timers_walked = 0, timers_fired = 0;
594
595     /* Get the hash slot for this clocktick */
596     struct list_entity *timer_head_node;
597
598     timer_head_node = &timer_wheel[*last_run & TIMER_WHEEL_MASK];
599
600     /* Walk all entries hanging off this hash bucket. We treat this basically as a stack
601      * so that we always know if and where the next element is.
602      */
603     list_init_head(&tmp_head_node);
604     while (!list_is_empty(timer_head_node)) {
605       /* the top element */
606       struct timer_entry *timer;
607
608       timer = list_first_element(timer_head_node, timer, timer_list);
609
610       /*
611        * Dequeue and insert to a temporary list.
612        * We do this to avoid loosing our walking context when
613        * multiple timers fire.
614        */
615       list_remove(&timer->timer_list);
616       list_add_after(&tmp_head_node, &timer->timer_list);
617       timers_walked++;
618
619       /* Ready to fire ? */
620       if (TIMED_OUT(timer->timer_clock)) {
621         OLSR_DEBUG(LOG_SCHEDULER, "TIMER: fire %s timer %p, ctx %p, "
622                    "at clocktick %u (%s)\n",
623                    timer->timer_info->name,
624                    timer, timer->timer_cb_context, (unsigned int)*last_run, olsr_wallclock_string());
625
626         /* This timer is expired, call into the provided callback function */
627         timer->timer_in_callback = true;
628         timer->timer_info->callback(timer->timer_cb_context);
629         timer->timer_in_callback = false;
630         timer->timer_info->changes++;
631
632         /* Only act on actually running timers */
633         if (timer->timer_running) {
634           /*
635            * Don't restart the periodic timer if the callback function has
636            * stopped the timer.
637            */
638           if (timer->timer_period) {
639             /* For periodical timers, rehash the random number and restart */
640             timer->timer_random = random();
641             olsr_change_timer(timer, timer->timer_period, timer->timer_jitter_pct);
642           } else {
643             /* Singleshot timers are stopped */
644             olsr_stop_timer(timer);
645           }
646         }
647         else {
648           /* free memory */
649           olsr_cookie_free(timer_mem_cookie, timer);
650         }
651
652         timers_fired++;
653       }
654     }
655
656     /*
657      * Now merge the temporary list back to the old bucket.
658      */
659     list_merge(timer_head_node, &tmp_head_node);
660
661     /* keep some statistics */
662     total_timers_walked += timers_walked;
663     total_timers_fired += timers_fired;
664
665     /* Increment the time slot and wheel slot walk iteration */
666     (*last_run)++;
667     wheel_slot_walks++;
668   }
669
670   OLSR_DEBUG(LOG_SCHEDULER, "TIMER: processed %4u/%d clockwheel slots, "
671              "timers walked %4u/%u, timers fired %u\n",
672              wheel_slot_walks, TIMER_WHEEL_SLOTS, total_timers_walked, timer_mem_cookie->ci_usage, total_timers_fired);
673
674   /*
675    * If the scheduler has slipped and we have walked all wheel slots,
676    * reset the last timer run.
677    */
678   *last_run = now_times;
679 }
680
681 /**
682  * Stop and delete all timers.
683  */
684 void
685 olsr_flush_timers(void)
686 {
687   struct olsr_timer_info *ti;
688   struct list_iterator iterator;
689
690   struct list_entity *timer_head_node;
691   unsigned int wheel_slot = 0;
692
693   for (wheel_slot = 0; wheel_slot < TIMER_WHEEL_SLOTS; wheel_slot++) {
694     timer_head_node = &timer_wheel[wheel_slot & TIMER_WHEEL_MASK];
695
696     /* Kill all entries hanging off this hash bucket. */
697     while (!list_is_empty(timer_head_node)) {
698       struct timer_entry *timer;
699
700       timer = list_first_element(timer_head_node, timer, timer_list);
701       olsr_stop_timer(timer);
702     }
703   }
704
705   /* free all timerinfos */
706   OLSR_FOR_ALL_TIMERS(ti, iterator) {
707     avl_delete(&timerinfo_tree, &ti->node);
708     free(ti->name);
709     olsr_cookie_free(timerinfo_cookie, ti);
710   }
711
712   /* release memory cookie for timers */
713   olsr_cleanup_memcookie(timerinfo_cookie);
714 }
715
716 /**
717  * Returns the difference between gmt and local time in seconds.
718  * Use gmtime() and localtime() to keep things simple.
719  *
720  * taken and slightly modified from www.tcpdump.org.
721  */
722 static int
723 olsr_get_timezone(void)
724 {
725 #define OLSR_TIMEZONE_UNINITIALIZED -1
726   static int time_diff = OLSR_TIMEZONE_UNINITIALIZED;
727   if (time_diff == OLSR_TIMEZONE_UNINITIALIZED) {
728     int dir;
729     const time_t t = time(NULL);
730     const struct tm gmt = *gmtime(&t);
731     const struct tm *loc = localtime(&t);
732
733     time_diff = (loc->tm_hour - gmt.tm_hour) * 60 * 60 + (loc->tm_min - gmt.tm_min) * 60;
734
735     /*
736      * If the year or julian day is different, we span 00:00 GMT
737      * and must add or subtract a day. Check the year first to
738      * avoid problems when the julian day wraps.
739      */
740     dir = loc->tm_year - gmt.tm_year;
741     if (!dir) {
742       dir = loc->tm_yday - gmt.tm_yday;
743     }
744
745     time_diff += dir * 24 * 60 * 60;
746   }
747   return time_diff;
748 }
749
750 /**
751  * Format an absolute wallclock system time string.
752  * May be called upto 4 times in a single printf() statement.
753  * Displays microsecond resolution.
754  *
755  * @return buffer to a formatted system time string.
756  */
757 const char *
758 olsr_wallclock_string(void)
759 {
760   static char buf[sizeof("00:00:00.000000")];
761   struct timeval now;
762   int sec, usec;
763
764   gettimeofday(&now, NULL);
765
766   sec = (int)now.tv_sec + olsr_get_timezone();
767   usec = (int)now.tv_usec;
768
769   snprintf(buf, sizeof(buf), "%02d:%02d:%02d.%06d", (sec % 86400) / 3600, (sec % 3600) / 60, sec % 60, usec);
770
771   return buf;
772 }
773
774 /**
775  * Format an relative non-wallclock system time string.
776  * May be called upto 4 times in a single printf() statement.
777  * Displays millisecond resolution.
778  *
779  * @param absolute time expressed in clockticks
780  * @return buffer to a formatted system time string.
781  */
782 const char *
783 olsr_clock_string(uint32_t clk)
784 {
785   static char buf[sizeof("00:00:00.000")];
786
787   /* On most systems a clocktick is a 10ms quantity. */
788   unsigned int msec = clk % 1000;
789   unsigned int sec = clk / 1000;
790
791   snprintf(buf, sizeof(buf), "%02u:%02u:%02u.%03u", sec / 3600, (sec % 3600) / 60, (sec % 60), (msec % MSEC_PER_SEC));
792
793   return buf;
794 }
795
796 /**
797  * Start a new timer.
798  *
799  * @param relative time expressed in milliseconds
800  * @param jitter expressed in percent
801  * @param timer callback function
802  * @param context for the callback function
803  * @return a pointer to the created entry
804  */
805 struct timer_entry *
806 olsr_start_timer(unsigned int rel_time,
807                  uint8_t jitter_pct, void *context, struct olsr_timer_info *ti)
808 {
809   struct timer_entry *timer;
810
811   assert(ti != 0);          /* we want timer cookies everywhere */
812
813   timer = olsr_cookie_malloc(timer_mem_cookie);
814
815   /*
816    * Compute random numbers only once.
817    */
818   if (!timer->timer_random) {
819     timer->timer_random = random();
820   }
821
822   /* Fill entry */
823   timer->timer_clock = calc_jitter(rel_time, jitter_pct, timer->timer_random);
824   timer->timer_cb_context = context;
825   timer->timer_jitter_pct = jitter_pct;
826   timer->timer_running = true;
827
828   /* The cookie is used for debugging to traceback the originator */
829   timer->timer_info = ti;
830   ti->usage++;
831   ti->changes++;
832
833   /* Singleshot or periodical timer ? */
834   timer->timer_period = ti->periodic ? rel_time : 0;
835
836   /*
837    * Now insert in the respective timer_wheel slot.
838    */
839   list_add_before(&timer_wheel[timer->timer_clock & TIMER_WHEEL_MASK], &timer->timer_list);
840
841   OLSR_DEBUG(LOG_SCHEDULER, "TIMER: start %s timer %p firing in %s, ctx %p\n",
842              ti->name, timer, olsr_clock_string(timer->timer_clock), context);
843
844   return timer;
845 }
846
847 /**
848  * Delete a timer.
849  *
850  * @param the timer_entry that shall be removed
851  * @return nada
852  */
853 void
854 olsr_stop_timer(struct timer_entry *timer)
855 {
856   /* It's okay to get a NULL here */
857   if (timer == NULL) {
858     return;
859   }
860
861   assert(timer->timer_info);     /* we want timer cookies everywhere */
862   assert(timer->timer_list.next != NULL && timer->timer_list.prev != NULL);
863
864   OLSR_DEBUG(LOG_SCHEDULER, "TIMER: stop %s timer %p, ctx %p\n",
865              timer->timer_info->name, timer, timer->timer_cb_context);
866
867
868   /*
869    * Carve out of the existing wheel_slot and free.
870    */
871   list_remove(&timer->timer_list);
872   timer->timer_running = false;
873   timer->timer_info->usage--;
874   timer->timer_info->changes++;
875
876   if (!timer->timer_in_callback) {
877     olsr_cookie_free(timer_mem_cookie, timer);
878   }
879 }
880
881 /**
882  * Change a timer_entry.
883  *
884  * @param timer_entry to be changed.
885  * @param new relative time expressed in units of milliseconds.
886  * @param new jitter expressed in percent.
887  * @return nada
888  */
889 void
890 olsr_change_timer(struct timer_entry *timer, unsigned int rel_time, uint8_t jitter_pct)
891 {
892   /* Sanity check. */
893   if (!timer) {
894     return;
895   }
896
897   assert(timer->timer_info);     /* we want timer cookies everywhere */
898
899   /* Singleshot or periodical timer ? */
900   timer->timer_period = timer->timer_info->periodic ? rel_time : 0;
901
902   timer->timer_clock = calc_jitter(rel_time, jitter_pct, timer->timer_random);
903   timer->timer_jitter_pct = jitter_pct;
904
905   /*
906    * Changes are easy: Remove timer from the exisiting timer_wheel slot
907    * and reinsert into the new slot.
908    */
909   list_remove(&timer->timer_list);
910   list_add_before(&timer_wheel[timer->timer_clock & TIMER_WHEEL_MASK], &timer->timer_list);
911
912   OLSR_DEBUG(LOG_SCHEDULER, "TIMER: change %s timer %p, firing to %s, ctx %p\n",
913              timer->timer_info->name, timer,
914              olsr_clock_string(timer->timer_clock), timer->timer_cb_context);
915 }
916
917 /*
918  * This is the one stop shop for all sort of timer manipulation.
919  * Depending on the paseed in parameters a new timer is started,
920  * or an existing timer is started or an existing timer is
921  * terminated.
922  */
923 void
924 olsr_set_timer(struct timer_entry **timer_ptr,
925                unsigned int rel_time,
926                uint8_t jitter_pct, void *context, struct olsr_timer_info *ti)
927 {
928   assert(ti);          /* we want timer cookies everywhere */
929   if (rel_time == 0) {
930     /* No good future time provided, kill it. */
931     olsr_stop_timer(*timer_ptr);
932     *timer_ptr = NULL;
933   }
934   else if ((*timer_ptr) == NULL) {
935     /* No timer running, kick it. */
936     *timer_ptr = olsr_start_timer(rel_time, jitter_pct, context, ti);
937   }
938   else {
939     olsr_change_timer(*timer_ptr, rel_time, jitter_pct);
940   }
941 }
942
943 /*
944  * Local Variables:
945  * c-basic-offset: 2
946  * indent-tabs-mode: nil
947  * End:
948  */