25ffe5635b17adf8e3480077bd44db4a0f395fd7
[oonf.git] / src / core / olsr_timer.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2011, 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 #ifndef OLSR_TIMER_H_
43 #define OLSR_TIMER_H_
44
45 #include "common/common_types.h"
46 #include "common/list.h"
47 #include "common/avl.h"
48
49 #define TIMER_WHEEL_SLOTS 1024
50 #define TIMER_WHEEL_MASK (TIMER_WHEEL_SLOTS - 1)
51
52 /* prototype for timer callback */
53 typedef void (*timer_cb_func) (void *);
54
55 /*
56  * This struct defines a class of timers which have the same
57  * type (periodic/non-periodic) and callback.
58  */
59 struct olsr_timer_info {
60   /* node of timerinfo list */
61   struct list_entity node;
62
63   /* name of this timer class */
64   char *name;
65
66   /* callback function */
67   timer_cb_func callback;
68
69   /* true if this is a class of periodic timers */
70   bool periodic;
71
72   /* Stats, resource usage */
73   uint32_t usage;
74
75   /* Stats, resource churn */
76   uint32_t changes;
77 };
78
79
80 /*
81  * Our timer implementation is a based on individual timers arranged in
82  * a double linked list hanging of hash containers called a timer wheel slot.
83  * For every timer a olsr_timer_entry is created and attached to the timer wheel slot.
84  * When the timer fires, the timer_cb function is called with the
85  * context pointer.
86  */
87 struct olsr_timer_entry {
88   /* Wheel membership */
89   struct list_entity timer_list;
90
91   /* backpointer to timer info */
92   struct olsr_timer_info *timer_info;
93
94   /* when timer shall fire (absolute internal timerstamp) */
95   uint32_t timer_clock;
96
97   /* timeperiod between two timer events for periodical timers */
98   uint32_t timer_period;
99
100   /* the jitter expressed in percent */
101   uint8_t timer_jitter_pct;
102
103   /* true if timer is running at the moment */
104   bool timer_running;
105
106   /* true if timer is in callback at the moment */
107   bool timer_in_callback;
108
109   /* cache random() result for performance reasons */
110   unsigned int timer_random;
111
112   /* context pointer */
113   void *timer_cb_context;
114 };
115
116 /* Timers */
117 EXPORT extern struct list_entity timerinfo_list;
118 #define OLSR_FOR_ALL_TIMERS(ti, iterator) list_for_each_element_safe(&timerinfo_list, ti, node, iterator)
119
120 EXPORT int olsr_timer_init(void) __attribute__((warn_unused_result));
121 EXPORT void olsr_timer_cleanup(void);
122 EXPORT void olsr_timer_walk(void);
123
124 EXPORT struct olsr_timer_info *olsr_timer_add(
125     const char *name, timer_cb_func callback, bool periodic) __attribute__((warn_unused_result));
126 EXPORT void olsr_timer_remove(struct olsr_timer_info *);
127
128 EXPORT void olsr_timer_set(struct olsr_timer_entry **, uint32_t, uint8_t,
129     void *, struct olsr_timer_info *);
130 EXPORT struct olsr_timer_entry *olsr_timer_start(uint32_t, uint8_t,
131     void *, struct olsr_timer_info *);
132 EXPORT void olsr_timer_change(struct olsr_timer_entry *, uint32_t, uint8_t);
133 EXPORT void olsr_timer_stop(struct olsr_timer_entry *);
134
135 #endif /* OLSR_TIMER_H_ */