Namespace cleanup of scheduler, remove "polling" sockets
[olsrd.git] / src / scheduler.h
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
43 #ifndef _OLSR_SCHEDULER
44 #define _OLSR_SCHEDULER
45
46 #include "olsr_time.h"
47 #include "common/list.h"
48 #include "common/avl.h"
49
50 #include "olsr_types.h"
51
52 #include <time.h>
53
54 #define TIMER_WHEEL_SLOTS 1024
55 #define TIMER_WHEEL_MASK (TIMER_WHEEL_SLOTS - 1)
56
57 /* prototype for timer callback */
58 typedef void (*timer_cb_func) (void *);
59
60 /*
61  * This struct defines a class of timers which have the same
62  * type (periodic/non-periodic) and callback.
63  */
64 struct olsr_timer_info {
65   /* node of timerinfo tree */
66   struct avl_node node;
67
68   /* name of this timer class */
69   char *name;
70
71   /* callback function */
72   timer_cb_func callback;
73
74   /* true if this is a class of periodic timers */
75   bool periodic;
76
77   /* Stats, resource usage */
78   uint32_t usage;
79
80   /* Stats, resource churn */
81   uint32_t changes;
82 };
83
84
85 /*
86  * Our timer implementation is a based on individual timers arranged in
87  * a double linked list hanging of hash containers called a timer wheel slot.
88  * For every timer a olsr_timer_entry is created and attached to the timer wheel slot.
89  * When the timer fires, the timer_cb function is called with the
90  * context pointer.
91  */
92 struct olsr_timer_entry {
93   /* Wheel membership */
94   struct list_entity timer_list;
95
96   /* backpointer to timer info */
97   struct olsr_timer_info *timer_info;
98
99   /* when timer shall fire (absolute internal timerstamp) */
100   uint32_t timer_clock;
101
102   /* timeperiod between two timer events for periodical timers */
103   uint32_t timer_period;
104
105   /* the jitter expressed in percent */
106   uint8_t timer_jitter_pct;
107
108   /* true if timer is running at the moment */
109   bool timer_running;
110
111   /* true if timer is in callback at the moment */
112   bool timer_in_callback;
113
114   /* cache random() result for performance reasons */
115   unsigned int timer_random;
116
117   /* context pointer */
118   void *timer_cb_context;
119 };
120
121 /* Timers */
122 extern struct avl_tree EXPORT(timerinfo_tree);
123 #define OLSR_FOR_ALL_TIMERS(ti, iterator) avl_for_each_element_safe(&timerinfo_tree, ti, node, iterator)
124
125 void olsr_init_timers(void);
126 void olsr_flush_timers(void);
127
128 uint32_t EXPORT(olsr_timer_getAbsolute) (uint32_t relative);
129 int32_t EXPORT(olsr_timer_getRelative) (uint32_t absolute);
130 bool EXPORT(olsr_timer_isTimedOut) (uint32_t s);
131
132 /**
133  * Calculates the current time in the internal OLSR representation
134  * @return current time
135  */
136 static inline uint32_t olsr_timer_getNow(void) {
137   return olsr_timer_getAbsolute(0);
138 }
139
140 void EXPORT(olsr_timer_set) (struct olsr_timer_entry **, uint32_t, uint8_t,
141     void *, struct olsr_timer_info *);
142 struct olsr_timer_entry *EXPORT(olsr_timer_start) (uint32_t, uint8_t,
143     void *, struct olsr_timer_info *);
144 void EXPORT(olsr_timer_change)(struct olsr_timer_entry *, uint32_t, uint8_t);
145 void EXPORT(olsr_timer_stop) (struct olsr_timer_entry *);
146
147 struct olsr_timer_info *EXPORT(olsr_timer_add)(const char *name, timer_cb_func callback, bool periodic);
148
149 /* Printing timestamps */
150 const char *EXPORT(olsr_timer_getClockString)(uint32_t);
151 const char *EXPORT(olsr_timer_getWallclockString)(void);
152
153 /* Main scheduler loop */
154 void olsr_scheduler(void);
155
156 /* flags for socket handler */
157 static const unsigned int OLSR_SOCKET_READ = 0x04;
158 static const unsigned int OLSR_SOCKETPOLL_WRITE = 0x08;
159
160 /* prototype for socket handler */
161 typedef void (*socket_handler_func) (int fd, void *data, unsigned int flags);
162
163 /* This struct represents a single registered socket handler */
164 struct olsr_socket_entry {
165   /* list of socket handlers */
166   struct list_entity socket_node;
167
168   /* file descriptor of the socket */
169   int fd;
170
171   /* socket handler */
172   socket_handler_func process_immediate;
173
174   /* custom data pointer for sockets */
175   void *data;
176
177   /* flags (OLSR_SOCKET_READ and OLSR_SOCKET_WRITE) */
178   unsigned int flags;
179 };
180
181 /* deletion safe macro for socket list traversal */
182 extern struct list_entity EXPORT(socket_head);
183 #define OLSR_FOR_ALL_SOCKETS(socket, iterator) list_for_each_element_safe(&socket_head, socket, socket_node, iterator)
184
185 void olsr_socket_cleanup(void);
186
187 void EXPORT(olsr_socket_add) (int fd, socket_handler_func pf_imm, void *data, unsigned int flags);
188 int EXPORT(olsr_socket_remove) (int fd, socket_handler_func pf_imm);
189
190 void EXPORT(olsr_socket_enable) (int fd, socket_handler_func pf_imm, unsigned int flags);
191 void EXPORT(olsr_socket_disable) (int fd, socket_handler_func pf_imm, unsigned int flags);
192
193 #endif
194
195 /*
196  * Local Variables:
197  * c-basic-offset: 2
198  * indent-tabs-mode: nil
199  * End:
200  */