More cleanup work of the timer API
[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 /* prototype for timer callback */
50 typedef void (*timer_cb_func) (void *);
51
52 /*
53  * This struct defines a class of timers which have the same
54  * type (periodic/non-periodic) and callback.
55  */
56 struct olsr_timer_info {
57   /* node of timerinfo list */
58   struct list_entity node;
59
60   /* name of this timer class */
61   const char *name;
62
63   /* callback function */
64   timer_cb_func callback;
65
66   /* true if this is a class of periodic timers */
67   bool periodic;
68
69   /* Stats, resource usage */
70   uint32_t usage;
71
72   /* Stats, resource churn */
73   uint32_t changes;
74 };
75
76
77 /*
78  * Our timer implementation is a based on individual timers arranged in
79  * a double linked list hanging of hash containers called a timer wheel slot.
80  * For every timer a olsr_timer_entry is created and attached to the timer wheel slot.
81  * When the timer fires, the timer_cb function is called with the
82  * context pointer.
83  */
84 struct olsr_timer_entry {
85   /* Wheel membership */
86   struct list_entity _node;
87
88   /* backpointer to timer info */
89   struct olsr_timer_info *info;
90
91   /* timeperiod between two timer events for periodical timers */
92   uint64_t period;
93
94   /* the jitter expressed in percent */
95   uint8_t jitter_pct;
96
97   /* context pointer */
98   void *cb_context;
99
100   /* cache random() result for performance reasons */
101   unsigned int _random;
102
103   /* absolute timestamp when timer will fire */
104   uint64_t _clock;
105
106 };
107
108 /* Timers */
109 EXPORT extern struct list_entity timerinfo_list;
110 #define OLSR_FOR_ALL_TIMERS(ti, iterator) list_for_each_element_safe(&timerinfo_list, ti, node, iterator)
111
112 EXPORT void olsr_timer_init(void);
113 EXPORT void olsr_timer_cleanup(void);
114 EXPORT void olsr_timer_walk(void);
115
116 EXPORT void olsr_timer_add(struct olsr_timer_info *ti);
117 EXPORT void olsr_timer_remove(struct olsr_timer_info *);
118
119 EXPORT void olsr_timer_set(struct olsr_timer_entry *timer, uint64_t rel_time);
120 EXPORT void olsr_timer_start(struct olsr_timer_entry *timer, uint64_t rel_time);
121 EXPORT void olsr_timer_stop(struct olsr_timer_entry *);
122
123 EXPORT uint64_t olsr_timer_getNextEvent(void);
124
125 #endif /* OLSR_TIMER_H_ */