General cleanups in header files
[olsrd.git] / src / olsr.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Andreas T√łnnesen(andreto@olsr.org)
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without 
7  * modification, are permitted provided that the following conditions 
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright 
11  *   notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright 
13  *   notice, this list of conditions and the following disclaimer in 
14  *   the documentation and/or other materials provided with the 
15  *   distribution.
16  * * Neither the name of olsr.org, olsrd nor the names of its 
17  *   contributors may be used to endorse or promote products derived 
18  *   from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * Visit http://www.olsr.org for more information.
34  *
35  * If you find this software useful feel free to make a donation
36  * to the project. For more information see the website or contact
37  * the copyright holders.
38  *
39  * $Id: olsr.h,v 1.19 2005/02/20 18:52:18 kattemat Exp $
40  */
41
42
43 #ifndef _OLSR_FUNCTIONS
44 #define _OLSR_FUNCTIONS
45
46 #include "olsr_protocol.h"
47 #include "interfaces.h"
48
49 #include <sys/time.h>
50
51 olsr_bool changes_topology;
52 olsr_bool changes_neighborhood;
53 olsr_bool changes_hna;
54
55 float will_int; /* Willingness update interval */
56
57 /* Provides a timestamp s1 milliseconds in the future
58    according to system ticks returned by times(2) */
59 #define GET_TIMESTAMP(s1) \
60         now_times + ((s1) / system_tick_divider)
61
62 #define TIMED_OUT(s1) \
63         ((int)((s1) - now_times) < 0)
64
65
66 /*
67  * Queueing macros
68  */
69
70 /* First "argument" is NOT a pointer! */
71
72 #define QUEUE_ELEM(pre, new) \
73         pre.next->prev = new; \
74         new->next = pre.next; \
75         new->prev = &pre; \
76         pre.next = new
77
78 #define DEQUEUE_ELEM(elem) \
79         elem->prev->next = elem->next; \
80         elem->next->prev = elem->prev
81
82
83 void
84 register_pcf(int (*)(int, int, int));
85
86 void
87 olsr_process_changes(void);
88
89 void
90 init_msg_seqno(void);
91
92 inline olsr_u16_t
93 get_msg_seqno(void);
94
95 int
96 olsr_forward_message(union olsr_message *, 
97                      union olsr_ip_addr *, 
98                      olsr_u16_t, 
99                      struct interface *, 
100                      union olsr_ip_addr *);
101
102 void
103 set_buffer_timer(struct interface *);
104
105 void
106 olsr_init_tables(void);
107
108 void
109 olsr_init_willingness(void);
110
111 void
112 olsr_update_willingness(void *);
113
114 olsr_u8_t
115 olsr_calculate_willingness(void);
116
117 void
118 olsr_exit(const char *, int);
119
120 void *
121 olsr_malloc(size_t, const char *);
122
123 inline int
124 olsr_printf(int, char *, ...);
125
126 #endif