move avl and list library into src/common
[olsrd.git] / src / scheduler.h
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 #ifndef _OLSR_SCHEDULER
44 #define _OLSR_SCHEDULER
45
46 #include "common/list.h"
47
48 #define TIMER_WHEEL_SLOTS 256
49 #define TIMER_WHEEL_MASK (TIMER_WHEEL_SLOTS - 1)
50
51 /* Some defs for juggling with timers */
52 #define MSEC_PER_SEC 1000
53 #define USEC_PER_SEC 1000000
54 #define NSEC_PER_USEC 1000
55 #define USEC_PER_MSEC 1000
56
57 /*
58  * Our timer implementation is a based on individual timers arranged in
59  * a double linked list hanging of hash containers called a timer wheel slot.
60  * For every timer a timer_entry is created and attached to the timer wheel slot.
61  * When the timer fires, the timer_cb function is called with the
62  * context pointer.
63  * The implementation supports periodic and oneshot timers.
64  * For a periodic timer the timer_period field is set to non zero,
65  * which causes the timer to run forever until manually stopped.
66  */
67 struct timer_entry
68 {
69   struct list_node timer_list; /* memory pooling, or wheel membership */
70   clock_t timer_clock; /* when timer shall fire (absolute time)*/
71   unsigned int timer_period; /* set for periodical timers (relative time) */
72   olsr_cookie_t timer_cookie; /* used for diag stuff */
73   olsr_u8_t timer_jitter_pct; /* the jitter expressed in percent */
74   olsr_u8_t timer_flags; /* misc flags */
75   unsigned int timer_random; /* cache random() result for performance reasons */
76   void (*timer_cb)(void *); /* callback function */
77   void *timer_cb_context; /* context pointer */
78 };
79
80 /* inline to recast from timer_list back to timer_entry */
81 LISTNODE2STRUCT(list2timer, struct timer_entry, timer_list);
82
83 #define OLSR_TIMER_ONESHOT    0 /* One shot timer */
84 #define OLSR_TIMER_PERIODIC   1 /* Periodic timer */
85
86 /* Timer flags */
87 #define OLSR_TIMER_RUNNING  ( 1 << 0) /* this timer is running */
88
89 /* Memory pooling */
90 #define OLSR_TIMER_MEMORY_CHUNK 100 /* timers per chunk */
91
92 /* Timers */
93 void olsr_init_timers(void);
94 void olsr_walk_timers(clock_t *);
95 void olsr_set_timer(struct timer_entry **, unsigned int, olsr_u8_t, olsr_bool,
96                     void (*)(void *), void *, olsr_cookie_t);
97 struct timer_entry *olsr_start_timer(unsigned int, olsr_u8_t, olsr_bool,
98                                      void (*)(void *), void *, olsr_cookie_t);
99 void olsr_change_timer(struct timer_entry *, unsigned int, olsr_u8_t, olsr_bool);
100 void olsr_stop_timer(struct timer_entry *);
101
102 /* Printing timestamps */
103 const char* olsr_clock_string(clock_t);
104 const char* olsr_wallclock_string(void);
105
106 /* Main scheduler loop */
107 void olsr_scheduler(void) __attribute__((noreturn));
108
109 #endif
110
111 /*
112  * Local Variables:
113  * c-basic-offset: 2
114  * End:
115  */