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