566165f38b13d5cc61ca35112d18feb7a95568c4
[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 <unistd.h>
43 #include <assert.h>
44 #include <stdlib.h>
45
46 #include "common/avl.h"
47 #include "common/avl_olsr_comp.h"
48 #include "scheduler.h"
49 #include "link_set.h"
50 #include "olsr.h"
51 #include "olsr_memcookie.h"
52 #include "os_net.h"
53 #include "os_time.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_memcookie_info *timer_mem_cookie = NULL;
68 static struct olsr_memcookie_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 (os_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_memcookie_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, *iterator;
222
223   if (fd < 0 || (pf_pr == NULL && pf_imm == NULL)) {
224     OLSR_WARN(LOG_SCHEDULER, "Bogus socket entry - not processing...");
225     return 0;
226   }
227   OLSR_DEBUG(LOG_SCHEDULER, "Removing OLSR socket entry %d\n", fd);
228
229   OLSR_FOR_ALL_SOCKETS(entry, iterator) {
230     if (entry->fd == fd && entry->process_immediate == pf_imm && entry->process_pollrate == pf_pr) {
231       /* just mark this node as "deleted", it will be cleared later at the end of handle_fds() */
232       entry->process_immediate = NULL;
233       entry->process_pollrate = NULL;
234       entry->flags = 0;      return 1;
235     }
236   }
237   return 0;
238 }
239
240 void
241 enable_olsr_socket(int fd, socket_handler_func pf_pr, socket_handler_func pf_imm, unsigned int flags)
242 {
243   struct olsr_socket_entry *entry, *iterator;
244
245   OLSR_FOR_ALL_SOCKETS(entry, iterator) {
246     if (entry->fd == fd && entry->process_immediate == pf_imm && entry->process_pollrate == pf_pr) {
247       entry->flags |= flags;
248     }
249   }
250 }
251
252 void
253 disable_olsr_socket(int fd, socket_handler_func pf_pr, socket_handler_func pf_imm, unsigned int flags)
254 {
255   struct olsr_socket_entry *entry, *iterator;
256
257   OLSR_FOR_ALL_SOCKETS(entry, iterator) {
258     if (entry->fd == fd && entry->process_immediate == pf_imm && entry->process_pollrate == pf_pr) {
259       entry->flags &= ~flags;
260     }
261   }
262 }
263
264 /**
265  * Close and free all sockets.
266  */
267 void
268 olsr_flush_sockets(void)
269 {
270   struct olsr_socket_entry *entry, *iterator;
271
272   OLSR_FOR_ALL_SOCKETS(entry, iterator) {
273     os_close(entry->fd);
274     list_remove(&entry->socket_node);
275     free(entry);
276   }
277 }
278
279 static void
280 poll_sockets(void)
281 {
282   int n;
283   struct olsr_socket_entry *entry, *iterator;
284   fd_set ibits, obits;
285   struct timeval tvp = { 0, 0 };
286   int hfd = 0, fdsets = 0;
287
288   /* If there are no registered sockets we
289    * do not call select(2)
290    */
291   if (list_is_empty(&socket_head)) {
292     return;
293   }
294
295   FD_ZERO(&ibits);
296   FD_ZERO(&obits);
297
298   /* Adding file-descriptors to FD set */
299   OLSR_FOR_ALL_SOCKETS(entry, iterator) {
300     if (entry->process_pollrate == NULL) {
301       continue;
302     }
303     if ((entry->flags & SP_PR_READ) != 0) {
304       fdsets |= SP_PR_READ;
305       FD_SET((unsigned int)entry->fd, &ibits);  /* And we cast here since we get a warning on Win32 */
306     }
307     if ((entry->flags & SP_PR_WRITE) != 0) {
308       fdsets |= SP_PR_WRITE;
309       FD_SET((unsigned int)entry->fd, &obits);  /* And we cast here since we get a warning on Win32 */
310     }
311     if ((entry->flags & (SP_PR_READ | SP_PR_WRITE)) != 0 && entry->fd >= hfd) {
312       hfd = entry->fd + 1;
313     }
314   }
315
316   /* Running select on the FD set */
317   do {
318     n = os_select(hfd, fdsets & SP_PR_READ ? &ibits : NULL, fdsets & SP_PR_WRITE ? &obits : NULL, NULL, &tvp);
319   } while (n == -1 && errno == EINTR);
320
321   if (n == 0) {
322     return;
323   }
324   if (n == -1) {                /* Did something go wrong? */
325     OLSR_WARN(LOG_SCHEDULER, "select error: %s", strerror(errno));
326     return;
327   }
328
329   /* Update time since this is much used by the parsing functions */
330   now_times = olsr_times();
331   OLSR_FOR_ALL_SOCKETS(entry, iterator) {
332     int flags;
333     if (entry->process_pollrate == NULL) {
334       continue;
335     }
336     flags = 0;
337     if (FD_ISSET(entry->fd, &ibits)) {
338       flags |= SP_PR_READ;
339     }
340     if (FD_ISSET(entry->fd, &obits)) {
341       flags |= SP_PR_WRITE;
342     }
343
344     if (flags) {
345       OLSR_DEBUG(LOG_SCHEDULER, "Event from socket %d (%d)", entry->fd, flags);
346     }
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, *iterator;
358   struct timeval tvp;
359   int32_t remaining;
360
361   /* calculate the first timeout */
362   now_times = olsr_times();
363
364   remaining = TIME_DUE(next_interval);
365   if (remaining <= 0) {
366     /* we are already over the interval */
367     if (list_is_empty(&socket_head)) {
368       /* If there are no registered sockets we do not call select(2) */
369       return;
370     }
371     tvp.tv_sec = 0;
372     tvp.tv_usec = 0;
373   } else {
374     /* we need an absolute time - milliseconds */
375     tvp.tv_sec = remaining / MSEC_PER_SEC;
376     tvp.tv_usec = (remaining % MSEC_PER_SEC) * USEC_PER_MSEC;
377   }
378
379   /* do at least one select */
380   for (;;) {
381     fd_set ibits, obits;
382     int n, hfd = 0, fdsets = 0;
383     FD_ZERO(&ibits);
384     FD_ZERO(&obits);
385
386     /* Adding file-descriptors to FD set */
387     OLSR_FOR_ALL_SOCKETS(entry, iterator) {
388       if (entry->process_immediate == NULL) {
389         continue;
390       }
391       if ((entry->flags & SP_IMM_READ) != 0) {
392         fdsets |= SP_IMM_READ;
393         FD_SET((unsigned int)entry->fd, &ibits);        /* And we cast here since we get a warning on Win32 */
394       }
395       if ((entry->flags & SP_IMM_WRITE) != 0) {
396         fdsets |= SP_IMM_WRITE;
397         FD_SET((unsigned int)entry->fd, &obits);        /* And we cast here since we get a warning on Win32 */
398       }
399       if ((entry->flags & (SP_IMM_READ | SP_IMM_WRITE)) != 0 && entry->fd >= hfd) {
400         hfd = entry->fd + 1;
401       }
402     }
403
404     if (hfd == 0 && (long)remaining <= 0) {
405       /* we are over the interval and we have no fd's. Skip the select() etc. */
406       return;
407     }
408
409     do {
410       n = os_select(hfd, fdsets & SP_IMM_READ ? &ibits : NULL, fdsets & SP_IMM_WRITE ? &obits : NULL, NULL, &tvp);
411     } while (n == -1 && errno == EINTR);
412
413     if (n == 0) {               /* timeout! */
414       break;
415     }
416     if (n == -1) {              /* Did something go wrong? */
417       OLSR_WARN(LOG_SCHEDULER, "select error: %s", strerror(errno));
418       break;
419     }
420
421     /* Update time since this is much used by the parsing functions */
422     now_times = olsr_times();
423     OLSR_FOR_ALL_SOCKETS(entry, iterator) {
424       int flags;
425       if (entry->process_immediate == NULL) {
426         continue;
427       }
428       flags = 0;
429       if (FD_ISSET(entry->fd, &ibits)) {
430         flags |= SP_IMM_READ;
431       }
432       if (FD_ISSET(entry->fd, &obits)) {
433         flags |= SP_IMM_WRITE;
434       }
435       if (flags != 0) {
436         entry->process_immediate(entry->fd, entry->data, flags);
437       }
438     }
439
440     /* calculate the next timeout */
441     remaining = TIME_DUE(next_interval);
442     if (remaining <= 0) {
443       /* we are already over the interval */
444       break;
445     }
446     /* we need an absolute time - milliseconds */
447     tvp.tv_sec = remaining / MSEC_PER_SEC;
448     tvp.tv_usec = (remaining % MSEC_PER_SEC) * USEC_PER_MSEC;
449   }
450
451   OLSR_FOR_ALL_SOCKETS(entry, iterator) {
452     if (entry->process_immediate == NULL && entry->process_pollrate == NULL) {
453       /* clean up socket handler */
454       list_remove(&entry->socket_node);
455       free(entry);
456     }
457   }
458 }
459
460 /**
461  * Main scheduler event loop. Polls at every
462  * sched_poll_interval and calls all functions
463  * that are timed out or that are triggered.
464  * Also calls the olsr_process_changes()
465  * function at every poll.
466  *
467  * @return nada
468  */
469 void
470 olsr_scheduler(void)
471 {
472   OLSR_INFO(LOG_SCHEDULER, "Scheduler started - polling every %u ms\n", olsr_cnf->pollrate);
473
474   /* Main scheduler loop */
475   while (app_state == STATE_RUNNING) {
476     uint32_t next_interval;
477
478     /*
479      * Update the global timestamp. We are using a non-wallclock timer here
480      * to avoid any undesired side effects if the system clock changes.
481      */
482     now_times = olsr_times();
483     next_interval = GET_TIMESTAMP(olsr_cnf->pollrate);
484
485     /* Read incoming data */
486     poll_sockets();
487
488     /* Process timers */
489     walk_timers(&timer_last_run);
490
491     /* Update */
492     olsr_process_changes();
493
494     /* Check for changes in topology */
495     if (link_changes) {
496       increase_local_ansn_number();
497       OLSR_DEBUG(LOG_SCHEDULER, "ANSN UPDATED %d\n\n", get_local_ansn_number());
498       link_changes = false;
499     }
500
501     /* Read incoming data and handle it immediiately */
502     handle_fds(next_interval);
503   }
504 }
505
506 /**
507  * Decrement a relative timer by a random number range.
508  *
509  * @param the relative timer expressed in units of milliseconds.
510  * @param the jitter in percent
511  * @param cached result of random() at system init.
512  * @return the absolute timer in system clock tick units
513  */
514 static uint32_t
515 calc_jitter(unsigned int rel_time, uint8_t jitter_pct, unsigned int random_val)
516 {
517   unsigned int jitter_time;
518
519   /*
520    * No jitter or, jitter larger than 99% does not make sense.
521    * Also protect against overflows resulting from > 25 bit timers.
522    */
523   if (jitter_pct == 0 || jitter_pct > 99 || rel_time > (1 << 24)) {
524     return GET_TIMESTAMP(rel_time);
525   }
526
527   /*
528    * Play some tricks to avoid overflows with integer arithmetic.
529    */
530   jitter_time = (jitter_pct * rel_time) / 100;
531   jitter_time = random_val / (1 + RAND_MAX / (jitter_time + 1));
532
533   OLSR_DEBUG(LOG_TIMER, "TIMER: jitter %u%% rel_time %ums to %ums\n", jitter_pct, rel_time, rel_time - jitter_time);
534
535   return GET_TIMESTAMP(rel_time - jitter_time);
536 }
537
538 /**
539  * Init datastructures for maintaining timers.
540  */
541 void
542 olsr_init_timers(void)
543 {
544   int idx;
545
546   OLSR_INFO(LOG_SCHEDULER, "Initializing scheduler.\n");
547
548   /* Grab initial timestamp */
549   if (os_gettimeofday(&first_tv, NULL)) {
550     OLSR_ERROR(LOG_TIMER, "OS clock is not working, have to shut down OLSR (%s)\n", strerror(errno));
551     olsr_exit(1);
552   }
553   last_tv = first_tv;
554   now_times = olsr_times();
555
556   /* init lists */
557   list_init_head(&socket_head);
558   for (idx = 0; idx < TIMER_WHEEL_SLOTS; idx++) {
559     list_init_head(&timer_wheel[idx]);
560   }
561
562   /*
563    * Reset the last timer run.
564    */
565   timer_last_run = now_times;
566
567   /* Allocate a cookie for the block based memory manager. */
568   timer_mem_cookie = olsr_memcookie_add("timer_entry", sizeof(struct timer_entry));
569
570   avl_init(&timerinfo_tree, avl_comp_strcasecmp, false, NULL);
571   timerinfo_cookie = olsr_memcookie_add("timerinfo", sizeof(struct olsr_timer_info));
572 }
573
574 /**
575  * Walk through the timer list and check if any timer is ready to fire.
576  * Callback the provided function with the context pointer.
577  */
578 static void
579 walk_timers(uint32_t * last_run)
580 {
581   unsigned int total_timers_walked = 0, total_timers_fired = 0;
582   unsigned int wheel_slot_walks = 0;
583
584   /*
585    * Check the required wheel slots since the last time a timer walk was invoked,
586    * or check *all* the wheel slots, whatever is less work.
587    * The latter is meant as a safety belt if the scheduler falls behind.
588    */
589   while ((*last_run <= now_times) && (wheel_slot_walks < TIMER_WHEEL_SLOTS)) {
590     struct list_entity tmp_head_node;
591     /* keep some statistics */
592     unsigned int timers_walked = 0, timers_fired = 0;
593
594     /* Get the hash slot for this clocktick */
595     struct list_entity *timer_head_node;
596
597     timer_head_node = &timer_wheel[*last_run & TIMER_WHEEL_MASK];
598
599     /* Walk all entries hanging off this hash bucket. We treat this basically as a stack
600      * so that we always know if and where the next element is.
601      */
602     list_init_head(&tmp_head_node);
603     while (!list_is_empty(timer_head_node)) {
604       /* the top element */
605       struct timer_entry *timer;
606
607       timer = list_first_element(timer_head_node, timer, timer_list);
608
609       /*
610        * Dequeue and insert to a temporary list.
611        * We do this to avoid loosing our walking context when
612        * multiple timers fire.
613        */
614       list_remove(&timer->timer_list);
615       list_add_after(&tmp_head_node, &timer->timer_list);
616       timers_walked++;
617
618       /* Ready to fire ? */
619       if (TIMED_OUT(timer->timer_clock)) {
620         OLSR_DEBUG(LOG_TIMER, "TIMER: fire %s timer %p, ctx %p, "
621                    "at clocktick %u (%s)\n",
622                    timer->timer_info->name,
623                    timer, timer->timer_cb_context, (unsigned int)*last_run, olsr_wallclock_string());
624
625         /* This timer is expired, call into the provided callback function */
626         timer->timer_in_callback = true;
627         timer->timer_info->callback(timer->timer_cb_context);
628         timer->timer_in_callback = false;
629         timer->timer_info->changes++;
630
631         /* Only act on actually running timers */
632         if (timer->timer_running) {
633           /*
634            * Don't restart the periodic timer if the callback function has
635            * stopped the timer.
636            */
637           if (timer->timer_period) {
638             /* For periodical timers, rehash the random number and restart */
639             timer->timer_random = random();
640             olsr_change_timer(timer, timer->timer_period, timer->timer_jitter_pct);
641           } else {
642             /* Singleshot timers are stopped */
643             olsr_stop_timer(timer);
644           }
645         }
646         else {
647           /* free memory */
648           olsr_memcookie_free(timer_mem_cookie, timer);
649         }
650
651         timers_fired++;
652       }
653     }
654
655     /*
656      * Now merge the temporary list back to the old bucket.
657      */
658     list_merge(timer_head_node, &tmp_head_node);
659
660     /* keep some statistics */
661     total_timers_walked += timers_walked;
662     total_timers_fired += timers_fired;
663
664     /* Increment the time slot and wheel slot walk iteration */
665     (*last_run)++;
666     wheel_slot_walks++;
667   }
668
669   OLSR_DEBUG(LOG_TIMER, "TIMER: processed %4u/%d clockwheel slots, "
670              "timers walked %4u/%u, timers fired %u\n",
671              wheel_slot_walks, TIMER_WHEEL_SLOTS, total_timers_walked, timer_mem_cookie->ci_usage, total_timers_fired);
672
673   /*
674    * If the scheduler has slipped and we have walked all wheel slots,
675    * reset the last timer run.
676    */
677   *last_run = now_times;
678 }
679
680 /**
681  * Stop and delete all timers.
682  */
683 void
684 olsr_flush_timers(void)
685 {
686   struct olsr_timer_info *ti, *iterator;
687
688   struct list_entity *timer_head_node;
689   unsigned int wheel_slot = 0;
690
691   for (wheel_slot = 0; wheel_slot < TIMER_WHEEL_SLOTS; wheel_slot++) {
692     timer_head_node = &timer_wheel[wheel_slot & TIMER_WHEEL_MASK];
693
694     /* Kill all entries hanging off this hash bucket. */
695     while (!list_is_empty(timer_head_node)) {
696       struct timer_entry *timer;
697
698       timer = list_first_element(timer_head_node, timer, timer_list);
699       olsr_stop_timer(timer);
700     }
701   }
702
703   /* free all timerinfos */
704   OLSR_FOR_ALL_TIMERS(ti, iterator) {
705     avl_delete(&timerinfo_tree, &ti->node);
706     free(ti->name);
707     olsr_memcookie_free(timerinfo_cookie, ti);
708   }
709
710   /* release memory cookie for timers */
711   olsr_memcookie_remove(timerinfo_cookie);
712 }
713
714 /**
715  * Returns the difference between gmt and local time in seconds.
716  * Use gmtime() and localtime() to keep things simple.
717  *
718  * taken and slightly modified from www.tcpdump.org.
719  */
720 static int
721 olsr_get_timezone(void)
722 {
723 #define OLSR_TIMEZONE_UNINITIALIZED -1
724   static int time_diff = OLSR_TIMEZONE_UNINITIALIZED;
725   if (time_diff == OLSR_TIMEZONE_UNINITIALIZED) {
726     int dir;
727     const time_t t = time(NULL);
728     const struct tm gmt = *gmtime(&t);
729     const struct tm *loc = localtime(&t);
730
731     time_diff = (loc->tm_hour - gmt.tm_hour) * 60 * 60 + (loc->tm_min - gmt.tm_min) * 60;
732
733     /*
734      * If the year or julian day is different, we span 00:00 GMT
735      * and must add or subtract a day. Check the year first to
736      * avoid problems when the julian day wraps.
737      */
738     dir = loc->tm_year - gmt.tm_year;
739     if (!dir) {
740       dir = loc->tm_yday - gmt.tm_yday;
741     }
742
743     time_diff += dir * 24 * 60 * 60;
744   }
745   return time_diff;
746 }
747
748 /**
749  * Format an absolute wallclock system time string.
750  * May be called upto 4 times in a single printf() statement.
751  * Displays microsecond resolution.
752  *
753  * @return buffer to a formatted system time string.
754  */
755 const char *
756 olsr_wallclock_string(void)
757 {
758   static char buf[sizeof("00:00:00.000000")];
759   struct timeval now;
760   int sec, usec;
761
762   os_gettimeofday(&now, NULL);
763
764   sec = (int)now.tv_sec + olsr_get_timezone();
765   usec = (int)now.tv_usec;
766
767   snprintf(buf, sizeof(buf), "%02d:%02d:%02d.%06d", (sec % 86400) / 3600, (sec % 3600) / 60, sec % 60, usec);
768
769   return buf;
770 }
771
772 /**
773  * Format an relative non-wallclock system time string.
774  * May be called upto 4 times in a single printf() statement.
775  * Displays millisecond resolution.
776  *
777  * @param absolute time expressed in clockticks
778  * @return buffer to a formatted system time string.
779  */
780 const char *
781 olsr_clock_string(uint32_t clk)
782 {
783   static char buf[sizeof("00:00:00.000")];
784
785   /* On most systems a clocktick is a 10ms quantity. */
786   unsigned int msec = clk % 1000;
787   unsigned int sec = clk / 1000;
788
789   snprintf(buf, sizeof(buf), "%02u:%02u:%02u.%03u", sec / 3600, (sec % 3600) / 60, (sec % 60), (msec % MSEC_PER_SEC));
790
791   return buf;
792 }
793
794 /**
795  * Start a new timer.
796  *
797  * @param relative time expressed in milliseconds
798  * @param jitter expressed in percent
799  * @param timer callback function
800  * @param context for the callback function
801  * @return a pointer to the created entry
802  */
803 struct timer_entry *
804 olsr_start_timer(unsigned int rel_time,
805                  uint8_t jitter_pct, void *context, struct olsr_timer_info *ti)
806 {
807   struct timer_entry *timer;
808
809   assert(ti != 0);          /* we want timer cookies everywhere */
810   assert(rel_time);
811   assert(jitter_pct <= 100);
812
813   timer = olsr_memcookie_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_TIMER, "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 #include "valgrind/valgrind.h"
847
848 /**
849  * Delete a timer.
850  *
851  * @param the timer_entry that shall be removed
852  * @return nada
853  */
854 void
855 olsr_stop_timer(struct timer_entry *timer)
856 {
857   /* It's okay to get a NULL here */
858   if (timer == NULL) {
859     return;
860   }
861
862   assert(timer->timer_info);     /* we want timer cookies everywhere */
863   assert(timer->timer_list.next != NULL && timer->timer_list.prev != NULL);
864
865   OLSR_DEBUG(LOG_TIMER, "TIMER: stop %s timer %p, ctx %p\n",
866              timer->timer_info->name, timer, timer->timer_cb_context);
867
868
869   /*
870    * Carve out of the existing wheel_slot and free.
871    */
872   list_remove(&timer->timer_list);
873   timer->timer_running = false;
874   timer->timer_info->usage--;
875   timer->timer_info->changes++;
876
877   if (!timer->timer_in_callback) {
878     olsr_memcookie_free(timer_mem_cookie, timer);
879   }
880 }
881
882 /**
883  * Change a timer_entry.
884  *
885  * @param timer_entry to be changed.
886  * @param new relative time expressed in units of milliseconds.
887  * @param new jitter expressed in percent.
888  * @return nada
889  */
890 void
891 olsr_change_timer(struct timer_entry *timer, unsigned int rel_time, uint8_t jitter_pct)
892 {
893   /* Sanity check. */
894   if (!timer) {
895     return;
896   }
897
898   assert(timer->timer_info);     /* we want timer cookies everywhere */
899
900   /* Singleshot or periodical timer ? */
901   timer->timer_period = timer->timer_info->periodic ? rel_time : 0;
902
903   timer->timer_clock = calc_jitter(rel_time, jitter_pct, timer->timer_random);
904   timer->timer_jitter_pct = jitter_pct;
905
906   /*
907    * Changes are easy: Remove timer from the exisiting timer_wheel slot
908    * and reinsert into the new slot.
909    */
910   list_remove(&timer->timer_list);
911   list_add_before(&timer_wheel[timer->timer_clock & TIMER_WHEEL_MASK], &timer->timer_list);
912
913   OLSR_DEBUG(LOG_TIMER, "TIMER: change %s timer %p, firing to %s, ctx %p\n",
914              timer->timer_info->name, timer,
915              olsr_clock_string(timer->timer_clock), timer->timer_cb_context);
916 }
917
918 /*
919  * This is the one stop shop for all sort of timer manipulation.
920  * Depending on the paseed in parameters a new timer is started,
921  * or an existing timer is started or an existing timer is
922  * terminated.
923  */
924 void
925 olsr_set_timer(struct timer_entry **timer_ptr,
926                unsigned int rel_time,
927                uint8_t jitter_pct, void *context, struct olsr_timer_info *ti)
928 {
929   assert(ti);          /* we want timer cookies everywhere */
930   if (rel_time == 0) {
931     /* No good future time provided, kill it. */
932     olsr_stop_timer(*timer_ptr);
933     *timer_ptr = NULL;
934   }
935   else if ((*timer_ptr) == NULL) {
936     /* No timer running, kick it. */
937     *timer_ptr = olsr_start_timer(rel_time, jitter_pct, context, ti);
938   }
939   else {
940     olsr_change_timer(*timer_ptr, rel_time, jitter_pct);
941   }
942 }
943
944 /*
945  * Local Variables:
946  * c-basic-offset: 2
947  * indent-tabs-mode: nil
948  * End:
949  */