bugfix delete_kernel_routes win32
[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 "scheduler.h"
43 #include "log.h"
44 #include "link_set.h"
45 #include "olsr.h"
46 #include "olsr_cookie.h"
47 #include "net_os.h"
48 #include "mpr_selector_set.h"
49
50 #include <sys/times.h>
51
52 #include <unistd.h>
53 #include <assert.h>
54
55 #ifdef WIN32
56 #define close(x) closesocket(x)
57 #endif
58
59 /* Timer data, global. Externed in scheduler.h */
60 uint32_t now_times;                    /* relative time compared to startup (in milliseconds */
61 struct timeval first_tv;               /* timevalue during startup */
62 struct timeval last_tv;                /* timevalue used for last olsr_times() calculation */
63
64 /* Hashed root of all timers */
65 static struct list_node timer_wheel[TIMER_WHEEL_SLOTS];
66 static uint32_t timer_last_run;        /* remember the last timeslot walk */
67
68 /* Memory cookie for the block based memory manager */
69 static struct olsr_cookie_info *timer_mem_cookie = NULL;
70
71 /* Head of all OLSR used sockets */
72 static struct list_node socket_head = { &socket_head, &socket_head };
73
74 /* Prototypes */
75 static void walk_timers(uint32_t *);
76 static void poll_sockets(void);
77 static uint32_t calc_jitter(unsigned int rel_time, uint8_t jitter_pct, unsigned int random_val);
78
79 /*
80  * A wrapper around times(2). Note, that this function has some
81  * portability problems, so do not rely on absolute values returned.
82  * Under Linux, uclibc and libc directly call the sys_times() located
83  * in kernel/sys.c and will only return an error if the tms_buf is
84  * not writeable.
85  */
86 static uint32_t
87 olsr_times(void)
88 {
89   struct timeval tv;
90   uint32_t t;
91
92   if (gettimeofday(&tv, NULL) != 0) {
93     olsr_exit("OS clock is not working, have to shut down OLSR", 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_PRINTF(1, "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 /**
166  * Add a socket and handler to the socketset
167  * beeing used in the main select(2) loop
168  * in listen_loop
169  *
170  *@param fd the socket
171  *@param pf the processing function
172  */
173 void
174 add_olsr_socket(int fd, socket_handler_func pf_pr, socket_handler_func pf_imm, void *data, unsigned int flags)
175 {
176   struct olsr_socket_entry *new_entry;
177
178   if (fd < 0 || (pf_pr == NULL && pf_imm == NULL)) {
179     OLSR_PRINTF(1, "Bogus socket entry - not registering...");
180     return;
181   }
182   OLSR_PRINTF(3, "Adding OLSR socket entry %d\n", fd);
183
184   new_entry = olsr_malloc(sizeof(*new_entry), "Socket entry");
185
186   new_entry->fd = fd;
187   new_entry->process_immediate = pf_imm;
188   new_entry->process_pollrate = pf_pr;
189   new_entry->data = data;
190   new_entry->flags = flags;
191
192   /* Queue */
193   list_node_init(&new_entry->socket_node);
194   list_add_before(&socket_head, &new_entry->socket_node);
195 }
196
197 /**
198  * Remove a socket and handler to the socketset
199  * beeing used in the main select(2) loop
200  * in listen_loop
201  *
202  *@param fd the socket
203  *@param pf the processing function
204  */
205 int
206 remove_olsr_socket(int fd, socket_handler_func pf_pr, socket_handler_func pf_imm)
207 {
208   struct olsr_socket_entry *entry;
209
210   if (fd < 0 || (pf_pr == NULL && pf_imm == NULL)) {
211     OLSR_PRINTF(1, "Bogus socket entry - not processing...");
212     return 0;
213   }
214   OLSR_PRINTF(3, "Removing OLSR socket entry %d\n", fd);
215
216   OLSR_FOR_ALL_SOCKETS(entry) {
217     if (entry->fd == fd && entry->process_immediate == pf_imm && entry->process_pollrate == pf_pr) {
218       /* just mark this node as "deleted", it will be cleared later at the end of handle_fds() */
219       entry->process_immediate = NULL;
220       entry->process_pollrate = NULL;
221       entry->flags = 0;
222       return 1;
223     }
224   }
225   OLSR_FOR_ALL_SOCKETS_END(entry);
226   return 0;
227 }
228
229 void
230 enable_olsr_socket(int fd, socket_handler_func pf_pr, socket_handler_func pf_imm, unsigned int flags)
231 {
232   struct olsr_socket_entry *entry;
233
234   OLSR_FOR_ALL_SOCKETS(entry) {
235     if (entry->fd == fd && entry->process_immediate == pf_imm && entry->process_pollrate == pf_pr) {
236       entry->flags |= flags;
237     }
238   }
239   OLSR_FOR_ALL_SOCKETS_END(entry);
240 }
241
242 void
243 disable_olsr_socket(int fd, socket_handler_func pf_pr, socket_handler_func pf_imm, unsigned int flags)
244 {
245   struct olsr_socket_entry *entry;
246
247   OLSR_FOR_ALL_SOCKETS(entry) {
248     if (entry->fd == fd && entry->process_immediate == pf_imm && entry->process_pollrate == pf_pr) {
249       entry->flags &= ~flags;
250     }
251   }
252   OLSR_FOR_ALL_SOCKETS_END(entry);
253 }
254
255 /**
256  * Close and free all sockets.
257  */
258 void
259 olsr_flush_sockets(void)
260 {
261   struct olsr_socket_entry *entry;
262
263   OLSR_FOR_ALL_SOCKETS(entry) {
264     close(entry->fd);
265     list_remove(&entry->socket_node);
266     free(entry);
267   } OLSR_FOR_ALL_SOCKETS_END(entry);
268 }
269
270 static void
271 poll_sockets(void)
272 {
273   int n;
274   struct olsr_socket_entry *entry;
275   fd_set ibits, obits;
276   struct timeval tvp = { 0, 0 };
277   int hfd = 0, fdsets = 0;
278
279   /* If there are no registered sockets we
280    * do not call select(2)
281    */
282   if (list_is_empty(&socket_head)) {
283     return;
284   }
285
286   FD_ZERO(&ibits);
287   FD_ZERO(&obits);
288
289   /* Adding file-descriptors to FD set */
290   OLSR_FOR_ALL_SOCKETS(entry) {
291     if (entry->process_pollrate == NULL) {
292       continue;
293     }
294     if ((entry->flags & SP_PR_READ) != 0) {
295       fdsets |= SP_PR_READ;
296       FD_SET((unsigned int)entry->fd, &ibits);  /* And we cast here since we get a warning on Win32 */
297     }
298     if ((entry->flags & SP_PR_WRITE) != 0) {
299       fdsets |= SP_PR_WRITE;
300       FD_SET((unsigned int)entry->fd, &obits);  /* And we cast here since we get a warning on Win32 */
301     }
302     if ((entry->flags & (SP_PR_READ | SP_PR_WRITE)) != 0 && entry->fd >= hfd) {
303       hfd = entry->fd + 1;
304     }
305   }
306   OLSR_FOR_ALL_SOCKETS_END(entry);
307
308   /* Running select on the FD set */
309   do {
310     n = olsr_select(hfd, fdsets & SP_PR_READ ? &ibits : NULL, fdsets & SP_PR_WRITE ? &obits : NULL, NULL, &tvp);
311   } while (n == -1 && errno == EINTR);
312
313   if (n == 0) {
314     return;
315   }
316   if (n == -1) {                /* Did something go wrong? */
317     OLSR_PRINTF(1, "select error: %s", strerror(errno));
318     return;
319   }
320
321   /* Update time since this is much used by the parsing functions */
322   now_times = olsr_times();
323   OLSR_FOR_ALL_SOCKETS(entry) {
324     int flags;
325     if (entry->process_pollrate == NULL) {
326       continue;
327     }
328     flags = 0;
329     if (FD_ISSET(entry->fd, &ibits)) {
330       flags |= SP_PR_READ;
331     }
332     if (FD_ISSET(entry->fd, &obits)) {
333       flags |= SP_PR_WRITE;
334     }
335     if (flags != 0) {
336       entry->process_pollrate(entry->fd, entry->data, flags);
337     }
338   }
339   OLSR_FOR_ALL_SOCKETS_END(entry);
340 }
341
342 static void
343 handle_fds(uint32_t next_interval)
344 {
345   struct olsr_socket_entry *entry;
346   struct timeval tvp;
347   int32_t remaining;
348
349   /* calculate the first timeout */
350   now_times = olsr_times();
351
352   remaining = TIME_DUE(next_interval);
353   if (remaining <= 0) {
354     /* we are already over the interval */
355     if (list_is_empty(&socket_head)) {
356       /* If there are no registered sockets we do not call select(2) */
357       return;
358     }
359     tvp.tv_sec = 0;
360     tvp.tv_usec = 0;
361   } else {
362     /* we need an absolute time - milliseconds */
363     tvp.tv_sec = remaining / MSEC_PER_SEC;
364     tvp.tv_usec = (remaining % MSEC_PER_SEC) * USEC_PER_MSEC;
365   }
366
367   /* do at least one select */
368   for (;;) {
369     fd_set ibits, obits;
370     int n, hfd = 0, fdsets = 0;
371     FD_ZERO(&ibits);
372     FD_ZERO(&obits);
373
374     /* Adding file-descriptors to FD set */
375     OLSR_FOR_ALL_SOCKETS(entry) {
376       if (entry->process_immediate == NULL) {
377         continue;
378       }
379       if ((entry->flags & SP_IMM_READ) != 0) {
380         fdsets |= SP_IMM_READ;
381         FD_SET((unsigned int)entry->fd, &ibits);        /* And we cast here since we get a warning on Win32 */
382       }
383       if ((entry->flags & SP_IMM_WRITE) != 0) {
384         fdsets |= SP_IMM_WRITE;
385         FD_SET((unsigned int)entry->fd, &obits);        /* And we cast here since we get a warning on Win32 */
386       }
387       if ((entry->flags & (SP_IMM_READ | SP_IMM_WRITE)) != 0 && entry->fd >= hfd) {
388         hfd = entry->fd + 1;
389       }
390     }
391     OLSR_FOR_ALL_SOCKETS_END(entry);
392
393     if (hfd == 0 && (long)remaining <= 0) {
394       /* we are over the interval and we have no fd's. Skip the select() etc. */
395       break;
396     }
397
398     do {
399       n = olsr_select(hfd, fdsets & SP_IMM_READ ? &ibits : NULL, fdsets & SP_IMM_WRITE ? &obits : NULL, NULL, &tvp);
400     } while (n == -1 && errno == EINTR);
401
402     if (n == 0) {               /* timeout! */
403       break;
404     }
405     if (n == -1) {              /* Did something go wrong? */
406       OLSR_PRINTF(1, "select error: %s", strerror(errno));
407       break;
408     }
409
410     /* Update time since this is much used by the parsing functions */
411     now_times = olsr_times();
412     OLSR_FOR_ALL_SOCKETS(entry) {
413       int flags;
414       if (entry->process_immediate == NULL) {
415         continue;
416       }
417       flags = 0;
418       if (FD_ISSET(entry->fd, &ibits)) {
419         flags |= SP_IMM_READ;
420       }
421       if (FD_ISSET(entry->fd, &obits)) {
422         flags |= SP_IMM_WRITE;
423       }
424       if (flags != 0) {
425         entry->process_immediate(entry->fd, entry->data, flags);
426       }
427     }
428     OLSR_FOR_ALL_SOCKETS_END(entry);
429
430     /* calculate the next timeout */
431     remaining = TIME_DUE(next_interval);
432     if (remaining <= 0) {
433       /* we are already over the interval */
434       break;
435     }
436     /* we need an absolute time - milliseconds */
437     tvp.tv_sec = remaining / MSEC_PER_SEC;
438     tvp.tv_usec = (remaining % MSEC_PER_SEC) * USEC_PER_MSEC;
439   }
440
441   OLSR_FOR_ALL_SOCKETS(entry) {
442     if (entry->process_immediate == NULL && entry->process_pollrate == NULL) {
443       /* clean up socket handler */
444       list_remove(&entry->socket_node);
445       free(entry);
446     }
447   } OLSR_FOR_ALL_SOCKETS_END(entry);
448 }
449
450 /**
451  * Main scheduler event loop. Polls at every
452  * sched_poll_interval and calls all functions
453  * that are timed out or that are triggered.
454  * Also calls the olsr_process_changes()
455  * function at every poll.
456  *
457  * @return nada
458  */
459 void __attribute__ ((noreturn))
460 olsr_scheduler(void)
461 {
462   OLSR_PRINTF(1, "Scheduler started - polling every %f ms\n", olsr_cnf->pollrate);
463
464   /* Main scheduler loop */
465   while (true) {
466     uint32_t next_interval;
467
468     /*
469      * Update the global timestamp. We are using a non-wallclock timer here
470      * to avoid any undesired side effects if the system clock changes.
471      */
472     now_times = olsr_times();
473     next_interval = GET_TIMESTAMP(olsr_cnf->pollrate * 1000);
474
475     /* Read incoming data */
476     poll_sockets();
477
478     /* Process timers */
479     walk_timers(&timer_last_run);
480
481     /* Update */
482     olsr_process_changes();
483
484     /* Check for changes in topology */
485     if (link_changes) {
486       increase_local_ansn();
487       OLSR_PRINTF(3, "ANSN UPDATED %d\n\n", get_local_ansn());
488       link_changes = false;
489     }
490
491     /* Read incoming data and handle it immediiately */
492     handle_fds(next_interval);
493
494 #ifdef WIN32
495     if (olsr_win32_end_request) {
496       olsr_win32_end_flag = true;
497     }
498 #endif
499   }
500 }
501
502 /**
503  * Decrement a relative timer by a random number range.
504  *
505  * @param the relative timer expressed in units of milliseconds.
506  * @param the jitter in percent
507  * @param cached result of random() at system init.
508  * @return the absolute timer in system clock tick units
509  */
510 static uint32_t
511 calc_jitter(unsigned int rel_time, uint8_t jitter_pct, unsigned int random_val)
512 {
513   unsigned int jitter_time;
514
515   /*
516    * No jitter or, jitter larger than 99% does not make sense.
517    * Also protect against overflows resulting from > 25 bit timers.
518    */
519   if (jitter_pct == 0 || jitter_pct > 99 || rel_time > (1 << 24)) {
520     return GET_TIMESTAMP(rel_time);
521   }
522
523   /*
524    * Play some tricks to avoid overflows with integer arithmetic.
525    */
526   jitter_time = (jitter_pct * rel_time) / 100;
527   jitter_time = random_val / (1 + RAND_MAX / (jitter_time + 1));
528
529   OLSR_PRINTF(3, "TIMER: jitter %u%% rel_time %ums to %ums\n", jitter_pct, rel_time, rel_time - jitter_time);
530
531   return GET_TIMESTAMP(rel_time - jitter_time);
532 }
533
534 /**
535  * Init datastructures for maintaining timers.
536  */
537 void
538 olsr_init_timers(void)
539 {
540   int idx;
541
542   OLSR_PRINTF(3, "Initializing scheduler.\n");
543
544   /* Grab initial timestamp */
545   if (gettimeofday(&first_tv, NULL)) {
546     olsr_exit("OS clock is not working, have to shut down OLSR", 1);
547   }
548   last_tv = first_tv;
549   now_times = olsr_times();
550
551   for (idx = 0; idx < TIMER_WHEEL_SLOTS; idx++) {
552     list_head_init(&timer_wheel[idx]);
553   }
554
555   /*
556    * Reset the last timer run.
557    */
558   timer_last_run = now_times;
559
560   /* Allocate a cookie for the block based memeory manager. */
561   timer_mem_cookie = olsr_alloc_cookie("timer_entry", OLSR_COOKIE_TYPE_MEMORY);
562   olsr_cookie_set_memory_size(timer_mem_cookie, sizeof(struct timer_entry));
563 }
564
565 /**
566  * Walk through the timer list and check if any timer is ready to fire.
567  * Callback the provided function with the context pointer.
568  */
569 static void
570 walk_timers(uint32_t * last_run)
571 {
572   unsigned int total_timers_walked = 0, total_timers_fired = 0;
573   unsigned int wheel_slot_walks = 0;
574
575   /*
576    * Check the required wheel slots since the last time a timer walk was invoked,
577    * or check *all* the wheel slots, whatever is less work.
578    * The latter is meant as a safety belt if the scheduler falls behind.
579    */
580   while ((*last_run <= now_times) && (wheel_slot_walks < TIMER_WHEEL_SLOTS)) {
581     struct list_node tmp_head_node;
582     /* keep some statistics */
583     unsigned int timers_walked = 0, timers_fired = 0;
584
585     /* Get the hash slot for this clocktick */
586     struct list_node *const timer_head_node = &timer_wheel[*last_run & TIMER_WHEEL_MASK];
587
588     /* Walk all entries hanging off this hash bucket. We treat this basically as a stack
589      * so that we always know if and where the next element is.
590      */
591     list_head_init(&tmp_head_node);
592     while (!list_is_empty(timer_head_node)) {
593       /* the top element */
594       struct list_node *const timer_node = timer_head_node->next;
595       struct timer_entry *const timer = list2timer(timer_node);
596
597       /*
598        * Dequeue and insert to a temporary list.
599        * We do this to avoid loosing our walking context when
600        * multiple timers fire.
601        */
602       list_remove(timer_node);
603       list_add_after(&tmp_head_node, timer_node);
604       timers_walked++;
605
606       /* Ready to fire ? */
607       if (TIMED_OUT(timer->timer_clock)) {
608
609         OLSR_PRINTF(7, "TIMER: fire %s timer %p, ctx %p, "
610                    "at clocktick %u (%s)\n",
611                    timer->timer_cookie->ci_name,
612                    timer, timer->timer_cb_context, (unsigned int)*last_run, olsr_wallclock_string());
613
614         /* This timer is expired, call into the provided callback function */
615         timer->timer_cb(timer->timer_cb_context);
616
617         /* Only act on actually running timers */
618         if (timer->timer_flags & OLSR_TIMER_RUNNING) {
619           /*
620            * Don't restart the periodic timer if the callback function has
621            * stopped the timer.
622            */
623           if (timer->timer_period) {
624             /* For periodical timers, rehash the random number and restart */
625             timer->timer_random = random();
626             olsr_change_timer(timer, timer->timer_period, timer->timer_jitter_pct, OLSR_TIMER_PERIODIC);
627           } else {
628             /* Singleshot timers are stopped */
629             olsr_stop_timer(timer);
630           }
631         }
632
633         timers_fired++;
634       }
635     }
636
637     /*
638      * Now merge the temporary list back to the old bucket.
639      */
640     list_merge(timer_head_node, &tmp_head_node);
641
642     /* keep some statistics */
643     total_timers_walked += timers_walked;
644     total_timers_fired += timers_fired;
645
646     /* Increment the time slot and wheel slot walk iteration */
647     (*last_run)++;
648     wheel_slot_walks++;
649   }
650
651   OLSR_PRINTF(7, "TIMER: processed %4u/%d clockwheel slots, "
652              "timers walked %4u/%u, timers fired %u\n",
653              wheel_slot_walks, TIMER_WHEEL_SLOTS, total_timers_walked, timer_mem_cookie->ci_usage, total_timers_fired);
654
655   /*
656    * If the scheduler has slipped and we have walked all wheel slots,
657    * reset the last timer run.
658    */
659   *last_run = now_times;
660 }
661
662 /**
663  * Stop and delete all timers.
664  */
665 void
666 olsr_flush_timers(void)
667 {
668   struct list_node *timer_head_node;
669   unsigned int wheel_slot = 0;
670
671   for (wheel_slot = 0; wheel_slot < TIMER_WHEEL_SLOTS; wheel_slot++) {
672     timer_head_node = &timer_wheel[wheel_slot & TIMER_WHEEL_MASK];
673
674     /* Kill all entries hanging off this hash bucket. */
675     while (!list_is_empty(timer_head_node)) {
676       olsr_stop_timer(list2timer(timer_head_node->next));
677     }
678   }
679 }
680
681 /**
682  * Returns the difference between gmt and local time in seconds.
683  * Use gmtime() and localtime() to keep things simple.
684  *
685  * taken and slightly modified from www.tcpdump.org.
686  */
687 static int
688 olsr_get_timezone(void)
689 {
690 #define OLSR_TIMEZONE_UNINITIALIZED -1
691   static int time_diff = OLSR_TIMEZONE_UNINITIALIZED;
692   if (time_diff == OLSR_TIMEZONE_UNINITIALIZED) {
693     int dir;
694     const time_t t = time(NULL);
695     const struct tm gmt = *gmtime(&t);
696     const struct tm *loc = localtime(&t);
697
698     time_diff = (loc->tm_hour - gmt.tm_hour) * 60 * 60 + (loc->tm_min - gmt.tm_min) * 60;
699
700     /*
701      * If the year or julian day is different, we span 00:00 GMT
702      * and must add or subtract a day. Check the year first to
703      * avoid problems when the julian day wraps.
704      */
705     dir = loc->tm_year - gmt.tm_year;
706     if (!dir) {
707       dir = loc->tm_yday - gmt.tm_yday;
708     }
709
710     time_diff += dir * 24 * 60 * 60;
711   }
712   return time_diff;
713 }
714
715 /**
716  * Format an absolute wallclock system time string.
717  * May be called upto 4 times in a single printf() statement.
718  * Displays microsecond resolution.
719  *
720  * @return buffer to a formatted system time string.
721  */
722 const char *
723 olsr_wallclock_string(void)
724 {
725   static char buf[sizeof("00:00:00.000000")];
726   struct timeval now;
727   int sec, usec;
728
729   gettimeofday(&now, NULL);
730
731   sec = (int)now.tv_sec + olsr_get_timezone();
732   usec = (int)now.tv_usec;
733
734   snprintf(buf, sizeof(buf), "%02d:%02d:%02d.%06d", (sec % 86400) / 3600, (sec % 3600) / 60, sec % 60, usec);
735
736   return buf;
737 }
738
739 /**
740  * Format an relative non-wallclock system time string.
741  * May be called upto 4 times in a single printf() statement.
742  * Displays millisecond resolution.
743  *
744  * @param absolute time expressed in clockticks
745  * @return buffer to a formatted system time string.
746  */
747 const char *
748 olsr_clock_string(uint32_t clk)
749 {
750   static char buf[sizeof("00:00:00.000")];
751
752   /* On most systems a clocktick is a 10ms quantity. */
753   unsigned int msec = clk % 1000;
754   unsigned int sec = clk / 1000;
755
756   snprintf(buf, sizeof(buf), "%02u:%02u:%02u.%03u", sec / 3600, (sec % 3600) / 60, (sec % 60), (msec % MSEC_PER_SEC));
757
758   return buf;
759 }
760
761 /**
762  * Start a new timer.
763  *
764  * @param relative time expressed in milliseconds
765  * @param jitter expressed in percent
766  * @param timer callback function
767  * @param context for the callback function
768  * @return a pointer to the created entry
769  */
770 struct timer_entry *
771 olsr_start_timer(unsigned int rel_time,
772                  uint8_t jitter_pct, bool periodical, timer_cb_func cb_func, void *context, struct olsr_cookie_info *ci)
773 {
774   struct timer_entry *timer;
775
776   if (ci == NULL) {
777     ci = def_timer_ci;
778   }
779   assert(cb_func);
780
781   timer = olsr_cookie_malloc(timer_mem_cookie);
782
783   /*
784    * Compute random numbers only once.
785    */
786   if (!timer->timer_random) {
787     timer->timer_random = random();
788   }
789
790   /* Fill entry */
791   timer->timer_clock = calc_jitter(rel_time, jitter_pct, timer->timer_random);
792   timer->timer_cb = cb_func;
793   timer->timer_cb_context = context;
794   timer->timer_jitter_pct = jitter_pct;
795   timer->timer_flags = OLSR_TIMER_RUNNING;
796
797   /* The cookie is used for debugging to traceback the originator */
798   timer->timer_cookie = ci;
799   olsr_cookie_usage_incr(ci->ci_id);
800
801   /* Singleshot or periodical timer ? */
802   timer->timer_period = periodical ? rel_time : 0;
803
804   /*
805    * Now insert in the respective timer_wheel slot.
806    */
807   list_add_before(&timer_wheel[timer->timer_clock & TIMER_WHEEL_MASK], &timer->timer_list);
808
809   OLSR_PRINTF(7, "TIMER: start %s timer %p firing in %s, ctx %p\n",
810              ci->ci_name, timer, olsr_clock_string(timer->timer_clock), context);
811
812   return timer;
813 }
814
815 /**
816  * Delete a timer.
817  *
818  * @param the timer_entry that shall be removed
819  * @return nada
820  */
821 void
822 olsr_stop_timer(struct timer_entry *timer)
823 {
824   /* It's okay to get a NULL here */
825   if (!timer) {
826     return;
827   }
828
829   assert(timer->timer_cookie);     /* we want timer cookies everywhere */
830
831   OLSR_PRINTF(7, "TIMER: stop %s timer %p, ctx %p\n",
832              timer->timer_cookie->ci_name, timer, timer->timer_cb_context);
833
834
835   /*
836    * Carve out of the existing wheel_slot and free.
837    */
838   list_remove(&timer->timer_list);
839   timer->timer_flags &= ~OLSR_TIMER_RUNNING;
840   olsr_cookie_usage_decr(timer->timer_cookie->ci_id);
841
842   olsr_cookie_free(timer_mem_cookie, timer);
843 }
844
845 /**
846  * Change a timer_entry.
847  *
848  * @param timer_entry to be changed.
849  * @param new relative time expressed in units of milliseconds.
850  * @param new jitter expressed in percent.
851  * @return nada
852  */
853 void
854 olsr_change_timer(struct timer_entry *timer, unsigned int rel_time, uint8_t jitter_pct, bool periodical)
855 {
856   /* Sanity check. */
857   if (!timer) {
858     return;
859   }
860
861   assert(timer->timer_cookie);     /* we want timer cookies everywhere */
862
863   /* Singleshot or periodical timer ? */
864   timer->timer_period = periodical ? rel_time : 0;
865
866   timer->timer_clock = calc_jitter(rel_time, jitter_pct, timer->timer_random);
867   timer->timer_jitter_pct = jitter_pct;
868
869   /*
870    * Changes are easy: Remove timer from the exisiting timer_wheel slot
871    * and reinsert into the new slot.
872    */
873   list_remove(&timer->timer_list);
874   list_add_before(&timer_wheel[timer->timer_clock & TIMER_WHEEL_MASK], &timer->timer_list);
875
876   OLSR_PRINTF(7, "TIMER: change %s timer %p, firing to %s, ctx %p\n",
877              timer->timer_cookie->ci_name, timer, olsr_clock_string(timer->timer_clock), timer->timer_cb_context);
878 }
879
880 /*
881  * This is the one stop shop for all sort of timer manipulation.
882  * Depending on the paseed in parameters a new timer is started,
883  * or an existing timer is started or an existing timer is
884  * terminated.
885  */
886 void
887 olsr_set_timer(struct timer_entry **timer_ptr,
888                unsigned int rel_time,
889                uint8_t jitter_pct, bool periodical, timer_cb_func cb_func, void *context, struct olsr_cookie_info *cookie)
890 {
891   if (cookie) {
892     cookie = def_timer_ci;
893   }
894
895   if (rel_time == 0) {
896     /* No good future time provided, kill it. */
897     olsr_stop_timer(*timer_ptr);
898     *timer_ptr = NULL;
899   }
900   else if ((*timer_ptr) == NULL) {
901     /* No timer running, kick it. */
902     *timer_ptr = olsr_start_timer(rel_time, jitter_pct, periodical, cb_func, context, cookie);
903   }
904   else {
905     olsr_change_timer(*timer_ptr, rel_time, jitter_pct, periodical);
906   }
907 }
908
909 /*
910  * Local Variables:
911  * c-basic-offset: 2
912  * indent-tabs-mode: nil
913  * End:
914  */