2dff42a07582020e4dbf2dbd6fe4ede9c8015d0b
[olsrd.git] / src / scheduler.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Andreas T√łnnesen(andreto@olsr.org)
4  * Timer rewrite (c) 2008, Hannes Gredler (hannes@gredler.at)
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
43 #include "defs.h"
44 #include "scheduler.h"
45 #include "log.h"
46 #include "tc_set.h"
47 #include "link_set.h"
48 #include "duplicate_set.h"
49 #include "mpr_selector_set.h"
50 #include "mid_set.h"
51 #include "mpr.h"
52 #include "olsr.h"
53 #include "build_msg.h"
54 #include "net_olsr.h"
55 #include "socket_parser.h"
56 #include "lq_route.h"
57 #include "link_set.h"
58 #include "olsr_cookie.h"
59
60 /* Timer data, global. Externed in defs.h */
61 clock_t now_times;  /* current idea of times(2) reported uptime */
62
63 /* Hashed root of all timers */
64 struct list_node timer_wheel[TIMER_WHEEL_SLOTS];
65 clock_t timer_last_run; /* remember the last timeslot walk */
66 struct list_node *timer_walk_list_node = NULL; /* used for timeslot walk */
67
68 /* Pool of timers to avoid malloc() churn */
69 struct list_node free_timer_list;
70
71 /* Statistics */
72 unsigned int timers_running;
73
74
75 /**
76  * Sleep until the next scheduling interval.
77  *
78  * @param scheduler loop runtime in clock ticks.
79  * @return nada
80  */
81 static void
82 olsr_scheduler_sleep(clock_t scheduler_runtime)
83 {
84   struct timespec remainder_spec, sleeptime_spec;
85   struct timeval sleeptime_val, time_used, next_interval;
86   olsr_u32_t next_interval_usec;
87   clock_t milliseconds_used;
88
89   /* Calculate next planned scheduler invocation */
90   next_interval_usec = olsr_cnf->pollrate * USEC_PER_SEC;
91   next_interval.tv_sec = next_interval_usec / USEC_PER_SEC;
92   next_interval.tv_usec = next_interval_usec % USEC_PER_SEC;
93
94   /* Determine used runtime */
95   milliseconds_used = scheduler_runtime * olsr_cnf->system_tick_divider;
96   time_used.tv_sec = milliseconds_used / MSEC_PER_SEC;
97   time_used.tv_usec = (milliseconds_used % MSEC_PER_SEC) * USEC_PER_MSEC;
98
99   if (timercmp(&time_used, &next_interval, <)) {
100     timersub(&next_interval, &time_used, &sleeptime_val);
101           
102     sleeptime_spec.tv_sec = sleeptime_val.tv_sec;
103     sleeptime_spec.tv_nsec = sleeptime_val.tv_usec * NSEC_PER_USEC;
104           
105     while (nanosleep(&sleeptime_spec, &remainder_spec) < 0)
106       sleeptime_spec = remainder_spec;
107   }
108 }
109
110 /**
111  * Main scheduler event loop. Polls at every
112  * sched_poll_interval and calls all functions
113  * that are timed out or that are triggered.
114  * Also calls the olsr_process_changes()
115  * function at every poll.
116  *
117  * @return nada
118  */
119 void
120 olsr_scheduler(void)
121 {
122   struct tms tms_buf;   /* Buffer for times(2) calls. */
123   struct interface *ifn;
124
125   OLSR_PRINTF(1, "Scheduler started - polling every %0.2f seconds\n", olsr_cnf->pollrate);
126   OLSR_PRINTF(3, "Max jitter is %f\n\n", olsr_cnf->max_jitter);
127
128   /* Main scheduler loop */
129   for (;;) {
130  
131     /*
132      * Update the global timestamp. We are using a non-wallclock timer here
133      * to avoid any undesired side effects if the system clock changes.
134      */
135     now_times = times(&tms_buf);
136
137     /* Read incoming data */
138     olsr_poll_sockets();
139
140     /* Process timers (before packet generation) */      
141     olsr_walk_timers(&timer_last_run);
142
143     /* Update */      
144     olsr_process_changes();
145
146     /* Check for changes in topology */
147     if (link_changes) {
148       OLSR_PRINTF(3, "ANSN UPDATED %d\n\n", get_local_ansn());
149       increase_local_ansn();
150       link_changes = OLSR_FALSE;
151     }
152
153     /* looping trough interfaces and emmitting pending data */
154     for (ifn = ifnet; ifn ; ifn = ifn->int_next) { 
155       if (net_output_pending(ifn) && TIMED_OUT(ifn->fwdtimer)) {
156         net_output(ifn);
157       }
158     }
159
160     /* We are done, sleep until the next scheduling interval. */
161     olsr_scheduler_sleep(times(&tms_buf) - now_times);
162
163 #if defined WIN32
164     /* The Ctrl-C signal handler thread asks us to exit */
165     if (olsr_win32_end_request) {
166       break;
167     }
168 #endif      
169   }
170
171 #if defined WIN32
172   /* Tell the Ctrl-C signal handler thread that we have exited */
173   olsr_win32_end_flag = TRUE;
174
175   /*
176    * The Ctrl-C signal handler thread will exit the process
177    * and hence also kill us.
178    */
179   while (1) {
180     Sleep(1000); /* milliseconds */
181   }
182 #endif
183 }
184
185
186 /**
187  * Decrement a relative timer by a random number range.
188  *
189  * @param the relative timer expressed in units of milliseconds.
190  * @param the jitter in percent
191  * @param cached result of random() at system init.
192  * @return the absolute timer in system clock tick units
193  */
194 static clock_t 
195 olsr_jitter(unsigned int rel_time, olsr_u8_t jitter_pct, unsigned int random)
196 {
197   unsigned int jitter_time, factorial;
198
199   /*
200    * No jitter or, jitter larger than 99% does not make sense.
201    * Also protect against overflows resulting from > 25 bit timers.
202    */
203   if (jitter_pct == 0 || jitter_pct > 99 || rel_time > (1 << 24)) {
204     return GET_TIMESTAMP(rel_time);
205   }
206
207   /*
208    * Play some tricks to avoid overflows with integer arithmetic.
209    */
210   jitter_time = (jitter_pct * rel_time) / 100;
211   factorial = random / (RAND_MAX / jitter_time);
212   jitter_time = (jitter_time * factorial) / (RAND_MAX / jitter_time);
213
214 #if 0
215   OLSR_PRINTF(3, "TIMER: jitter %u%% rel_time %u%% to %u\n",
216               rel_time, jitter_pct, rel_time - jitter_time);
217 #endif
218
219   return GET_TIMESTAMP(rel_time - jitter_time);
220 }
221
222
223 /**
224  * Allocate a timer_entry.
225  * Do this first by checking if something is available in the free_timer_pool
226  * If not then allocate a big chunk of memory and thread its elements up
227  * to the free_timer_list.
228  */
229 static struct timer_entry *
230 olsr_get_timer(void)
231 {
232   void *timer_block;
233   struct timer_entry *timer;
234   struct list_node *timer_list_node;
235   unsigned int timer_index;
236
237   /*
238    * If there is at least one timer in the pool then remove the first
239    * element from the pool and recycle it.
240    */
241   if (!list_is_empty(&free_timer_list)) {
242     timer_list_node = free_timer_list.next;
243     
244     /* carve it out of the pool, do not memset overwrite timer->timer_random */
245     list_remove(timer_list_node);
246     timer = list2timer(timer_list_node);
247
248     return timer;
249   }
250
251   /*
252    * Nothing in the pool, allocate a new chunk.
253    */
254   timer_block = olsr_malloc(sizeof(struct timer_entry) * OLSR_TIMER_MEMORY_CHUNK,
255                             "timer chunk");
256   memset(timer_block, 0, sizeof(struct timer_entry) * OLSR_TIMER_MEMORY_CHUNK); 
257
258 #if 0
259   OLSR_PRINTF(3, "TIMER: alloc %u bytes chunk at %p\n",
260               sizeof(struct timer_entry) * OLSR_TIMER_MEMORY_CHUNK,
261               timer_block);
262 #endif
263
264   /*
265    * Slice the chunk up and put the future timer_entries in the free timer pool.
266    */
267   timer = timer_block;
268   for (timer_index = 0; timer_index < OLSR_TIMER_MEMORY_CHUNK; timer_index++) {
269
270     /* Insert new timers at the tail of the free_timer list */
271     list_add_before(&free_timer_list, &timer->timer_list);
272
273     /* 
274      * For performance reasons (read: frequent timer changes),
275      * precompute a random number once per timer and reuse later.
276      * The random number only gets recomputed if a periodical timer fires,
277      * such that a different jitter is applied for future firing.
278      */
279     timer->timer_random = random();
280
281     timer++;
282   }
283
284   /*
285    * There are now timers in the pool, recurse once.
286    */
287   return olsr_get_timer();
288 }
289
290
291 /**
292  * Init datastructures for maintaining timers.
293  */
294 void
295 olsr_init_timers(void)
296 {
297   struct list_node *timer_head_node;
298   int index;
299
300   OLSR_PRINTF(5, "TIMER: init timers\n");
301
302   memset(timer_wheel, 0 , sizeof(timer_wheel));
303
304   timer_head_node = timer_wheel;
305   for (index = 0; index < TIMER_WHEEL_SLOTS; index++) {
306     list_head_init(timer_head_node);
307     timer_head_node++;
308   }
309
310   /*
311    * Reset the last timer run.
312    */
313   timer_last_run = now_times;
314
315   /* Timer memory pooling */
316   list_head_init(&free_timer_list);
317   timers_running = 0;
318 }
319
320
321 /**
322  * Walk through the timer list and check if any timer is ready to fire.
323  * Callback the provided function with the context pointer.
324  */
325 void
326 olsr_walk_timers(clock_t *last_run)
327 {
328   static struct timer_entry *timer;
329   struct list_node *timer_head_node;
330   unsigned int timers_walked, timers_fired;
331   unsigned int total_timers_walked, total_timers_fired;
332   unsigned int wheel_slot_walks = 0;
333
334   /*
335    * Check the required wheel slots since the last time a timer walk was invoked,
336    * or check *all* the wheel slots, whatever is less work.
337    * The latter is meant as a safety belt if the scheduler falls behind.
338    */
339   total_timers_walked = total_timers_fired = timers_walked = timers_fired = 0;
340   while ((*last_run <= now_times) && (wheel_slot_walks < TIMER_WHEEL_SLOTS)) {
341
342     /* keep some statistics */
343     total_timers_walked += timers_walked;
344     total_timers_fired += timers_fired;
345     timers_walked = 0;
346     timers_fired = 0;
347
348     /* Get the hash slot for this clocktick */
349     timer_head_node = &timer_wheel[*last_run & TIMER_WHEEL_MASK];
350
351     /* Walk all entries hanging off this hash bucket */
352     for (timer_walk_list_node = timer_head_node->next;
353          timer_walk_list_node != timer_head_node; /* circular list */
354          timer_walk_list_node = timer_walk_list_node->next) {
355
356       timer = list2timer(timer_walk_list_node);
357
358       timers_walked++;
359
360       /* Ready to fire ? */
361       if (TIMED_OUT(timer->timer_clock)) {
362
363         OLSR_PRINTF(3, "TIMER: fire %s timer %p, ctx %p, "
364                     "at clocktick %u\n",
365                     olsr_cookie_name(timer->timer_cookie),
366                     timer, timer->timer_cb_context,
367                     (unsigned int)(*last_run));
368
369         /* This timer is expired, call into the provided callback function */
370         timer->timer_cb(timer->timer_cb_context);
371
372         if (timer->timer_period) {
373
374           /*
375            * Don't restart the periodic timer if the callback function has
376            * stopped the timer.
377            */
378           if (timer->timer_flags & OLSR_TIMER_RUNNING) {
379
380             /* For periodical timers, rehash the random number and restart */
381             timer->timer_random = random();
382             olsr_change_timer(timer, timer->timer_period,
383                               timer->timer_jitter_pct,
384                               OLSR_TIMER_PERIODIC);
385           }
386
387         } else {
388
389           /*
390            * Don't stop the singleshot timer if the callback function has
391            * stopped the timer.
392            */
393           if (timer->timer_flags & OLSR_TIMER_RUNNING) {
394
395             /* Singleshot timers are stopped and returned to the pool */
396             olsr_stop_timer(timer);
397           }
398         }
399
400         timers_fired++;
401       }
402     }
403
404     /* Increment the time slot and wheel slot walk iteration */
405     (*last_run)++;
406     wheel_slot_walks++;
407
408     /*
409      * Mark the timer walk context unused.
410      */
411     timer_walk_list_node = NULL;
412   }
413
414 #ifdef DEBUG
415   OLSR_PRINTF(3, "TIMER: processed %4u/%u clockwheel slots, "
416               "timers walked %4u/%u, timers fired %u\n",
417               wheel_slot_walks, TIMER_WHEEL_SLOTS,
418               total_timers_walked, timers_running, total_timers_fired);
419 #endif
420
421 }
422
423 /**
424  * Returns the difference between gmt and local time in seconds.
425  * Use gmtime() and localtime() to keep things simple.
426  * 
427  * taken and slightly modified from www.tcpdump.org.
428  */
429 static int
430 olsr_get_timezone(void)
431 {
432 #define OLSR_TIMEZONE_UNINITIALIZED -1
433
434   static int time_diff = OLSR_TIMEZONE_UNINITIALIZED;
435   int dir;
436   struct tm *gmt, *loc;
437   struct tm sgmt;
438   time_t t;
439
440   if (time_diff != OLSR_TIMEZONE_UNINITIALIZED) {
441     return time_diff;
442   }
443
444   t = time(NULL);
445   gmt = &sgmt;
446   *gmt = *gmtime(&t);
447   loc = localtime(&t);
448
449   time_diff = (loc->tm_hour - gmt->tm_hour) * 60 * 60
450     + (loc->tm_min - gmt->tm_min) * 60;
451
452   /*
453    * If the year or julian day is different, we span 00:00 GMT
454    * and must add or subtract a day. Check the year first to
455    * avoid problems when the julian day wraps.
456    */
457   dir = loc->tm_year - gmt->tm_year;
458   if (!dir) {
459     dir = loc->tm_yday - gmt->tm_yday;
460   }
461
462   time_diff += dir * 24 * 60 * 60;
463
464   return (time_diff);
465 }
466
467 /**
468  * Format an absolute wallclock system time string.
469  * May be called upto 4 times in a single printf() statement.
470  * Displays microsecond resolution.
471  *
472  * @return buffer to a formatted system time string.
473  */
474 const char*
475 olsr_wallclock_string(void)
476 {
477   static char buf[4][sizeof("00:00:00.000000")];
478   static int idx = 0;
479   char *ret;
480   struct timeval now;
481   int sec, usec;
482
483   ret = buf[idx];
484   idx = (idx+1) & 3;
485
486   gettimeofday(&now, NULL);
487
488   sec = (int)now.tv_sec + olsr_get_timezone();
489   usec = (int)now.tv_usec;
490
491   snprintf(ret, sizeof(buf), "%02u:%02u:%02u.%06u",
492            (sec % 86400) / 3600, (sec % 3600) / 60, sec % 60, usec);
493
494   return ret;
495 }
496
497
498 /**
499  * Format an relative non-wallclock system time string.
500  * May be called upto 4 times in a single printf() statement.
501  * Displays millisecond resolution.
502  *
503  * @param absolute time expressed in clockticks
504  * @return buffer to a formatted system time string.
505  */
506 const char*
507 olsr_clock_string(clock_t clock)
508 {
509   static char buf[4][sizeof("00:00:00.000")];
510   static int idx = 0;
511   char *ret;
512   unsigned int sec, msec;
513
514   ret = buf[idx];
515   idx = (idx+1) & 3;
516
517   /* On most systems a clocktick is a 10ms quantity. */
518   msec = olsr_cnf->system_tick_divider * (unsigned int)(clock - now_times);
519   sec = msec / MSEC_PER_SEC;
520
521   snprintf(ret, sizeof(buf)/4, "%02u:%02u:%02u.%03u",
522            sec / 3600, (sec % 3600) / 60, (sec % 60), (msec % MSEC_PER_SEC));
523
524   return ret;
525 }
526
527
528 /**
529  * Start a new timer.
530  *
531  * @param relative time expressed in milliseconds
532  * @param jitter expressed in percent
533  * @param timer callback function
534  * @param context for the callback function
535  * @return a pointer to the created entry
536  */
537 struct timer_entry *
538 olsr_start_timer(unsigned int rel_time, olsr_u8_t jitter_pct,
539                  olsr_bool periodical, void (*timer_cb_function)(void *),
540                  void *context, olsr_cookie_t cookie)
541 {
542   struct timer_entry *timer;
543
544   timer = olsr_get_timer();
545
546   /* Fill entry */
547   timer->timer_clock = olsr_jitter(rel_time, jitter_pct, timer->timer_random);
548   timer->timer_cb = timer_cb_function;
549   timer->timer_cb_context = context;
550   timer->timer_jitter_pct = jitter_pct;
551   timer->timer_flags = OLSR_TIMER_RUNNING;
552
553   /* The cookie is used for debugging to traceback the originator */
554   timer->timer_cookie = cookie;
555   olsr_cookie_usage_incr(cookie);
556
557   /* Singleshot or periodical timer ? */
558   if (periodical) {
559     timer->timer_period = rel_time;
560   } else {
561     timer->timer_period = 0;
562   }
563
564   /*
565    * Now insert in the respective timer_wheel slot.
566    */
567   list_add_before(&timer_wheel[timer->timer_clock & TIMER_WHEEL_MASK],
568                   &timer->timer_list);
569   timers_running++;
570
571 #ifdef DEBUG
572   OLSR_PRINTF(3, "TIMER: start %s timer %p firing in %s, ctx %p\n",
573               olsr_cookie_name(timer->timer_cookie),
574               timer, olsr_clock_string(timer->timer_clock), context);
575 #endif
576
577   return timer;
578 }
579
580 /*
581  * Check if there is a timer walk in progress and advance the
582  * walking context if so. Keep in mind we are about to delete
583  * the timer from a list and this will destroy the walking context.
584  */
585
586 static inline void
587 olsr_update_timer_walk_ctx(struct timer_entry *timer)
588 {
589   if (timer_walk_list_node == &timer->timer_list) {
590     timer_walk_list_node = timer_walk_list_node->next;
591   }
592 }
593
594
595 /**
596  * Delete a timer.
597  *
598  * @param the timer_entry that shall be removed
599  * @return nada
600  */
601 void
602 olsr_stop_timer(struct timer_entry *timer)
603 {
604
605   /* sanity check */
606   if (!timer) {
607     return;
608   }
609
610 #ifdef DEBUG
611   OLSR_PRINTF(3, "TIMER: stop %s timer %p firing in %s, ctx %p\n",
612               olsr_cookie_name(timer->timer_cookie),
613               timer, olsr_clock_string(timer->timer_clock),
614               timer->timer_cb_context);
615 #endif
616
617   olsr_update_timer_walk_ctx(timer);
618
619   /*
620    * Carve out of the existing wheel_slot and return to the pool
621    * rather than freeing for later reycling.
622    */
623   list_remove(&timer->timer_list);
624   list_add_before(&free_timer_list, &timer->timer_list);
625   timer->timer_flags &= ~OLSR_TIMER_RUNNING;
626   olsr_cookie_usage_decr(timer->timer_cookie);
627   timers_running--;
628 }
629
630
631 /**
632  * Change a timer_entry.
633  *
634  * @param timer_entry to be changed.
635  * @param new relative time expressed in units of milliseconds.
636  * @param new jitter expressed in percent.
637  * @return nada
638  */
639 void
640 olsr_change_timer(struct timer_entry *timer, unsigned int rel_time,
641                   olsr_u8_t jitter_pct, olsr_bool periodical)
642 {
643
644   /* Sanity check. */
645   if (!timer) {
646     return;
647   }
648
649   /* Singleshot or periodical timer ? */
650   if (periodical) {
651     timer->timer_period = rel_time;
652   } else {
653     timer->timer_period = 0;
654   }
655
656   timer->timer_clock = olsr_jitter(rel_time, jitter_pct, timer->timer_random);
657   timer->timer_jitter_pct = jitter_pct;
658
659   olsr_update_timer_walk_ctx(timer);
660
661   /*
662    * Changes are easy: Remove timer from the exisiting timer_wheel slot
663    * and reinsert into the new slot.
664    */
665   list_remove(&timer->timer_list);
666   list_add_before(&timer_wheel[timer->timer_clock & TIMER_WHEEL_MASK],
667                   &timer->timer_list);
668
669 #ifdef DEBUG
670   OLSR_PRINTF(3, "TIMER: change %s timer %p, firing to %s, ctx %p\n",
671               olsr_cookie_name(timer->timer_cookie), timer,
672               olsr_clock_string(timer->timer_clock),
673               timer->timer_cb_context);
674 #endif
675 }
676
677
678 /*
679  * This is the one stop shop for all sort of timer manipulation.
680  * Depending on the paseed in parameters a new timer is started,
681  * or an existing timer is started or an existing timer is
682  * terminated.
683  */
684 void
685 olsr_set_timer(struct timer_entry **timer_ptr, unsigned int rel_time,
686                olsr_u8_t jitter_pct, olsr_bool periodical,
687                void (*timer_cb_function)(void *), void *context,
688                olsr_cookie_t cookie)
689 {
690
691   if (!*timer_ptr) {
692
693     /* No timer running, kick it. */
694     *timer_ptr = olsr_start_timer(rel_time, jitter_pct, periodical,
695                                   timer_cb_function, context, cookie);
696   } else {
697
698     if (!rel_time) {
699
700       /* No good future time provided, kill it.*/
701       olsr_stop_timer(*timer_ptr);
702       *timer_ptr = NULL;
703     } else {
704
705       /* Time is ok and timer is running, change it !*/
706       olsr_change_timer(*timer_ptr, rel_time, jitter_pct, periodical);
707     }
708   }
709 }
710
711 /*
712  * Local Variables:
713  * c-basic-offset: 2
714  * End:
715  */