38d2d68064719f6c4ed9ece14a793045c6475aed
[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.18 2005/02/02 20:37:53 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 /**
52  * Process changes functions
53  */
54
55 struct pcf
56 {
57   int (*function)(int, int, int);
58   struct pcf *next;
59 };
60
61 struct pcf *pcf_list;
62
63
64 olsr_bool changes_topology;
65 olsr_bool changes_neighborhood;
66 olsr_bool changes_hna;
67
68 olsr_u16_t message_seqno;
69
70 /* Provides a timestamp s1 milliseconds in the future
71    according to system ticks returned by times(2) */
72 #define GET_TIMESTAMP(s1) \
73         now_times + ((s1) / system_tick_divider)
74
75 #define TIMED_OUT(s1) \
76         ((int)((s1) - now_times) < 0)
77
78
79 /*
80  * Queueing macros
81  */
82
83 /* First "argument" is NOT a pointer! */
84
85 #define QUEUE_ELEM(pre, new) \
86         pre.next->prev = new; \
87         new->next = pre.next; \
88         new->prev = &pre; \
89         pre.next = new
90
91 #define DEQUEUE_ELEM(elem) \
92         elem->prev->next = elem->next; \
93         elem->next->prev = elem->prev
94
95
96 void
97 register_pcf(int (*)(int, int, int));
98
99 void
100 olsr_process_changes(void);
101
102 void
103 init_msg_seqno(void);
104
105 inline olsr_u16_t
106 get_msg_seqno(void);
107
108 int
109 olsr_forward_message(union olsr_message *, 
110                      union olsr_ip_addr *, 
111                      olsr_u16_t, 
112                      struct interface *, 
113                      union olsr_ip_addr *);
114
115 void
116 set_buffer_timer(struct interface *);
117
118 void
119 olsr_init_tables(void);
120
121 void
122 olsr_init_willingness(void);
123
124 void
125 olsr_update_willingness(void *);
126
127 olsr_u8_t
128 olsr_calculate_willingness(void);
129
130 void
131 olsr_exit(const char *, int);
132
133 void *
134 olsr_malloc(size_t, const char *);
135
136 inline int
137 olsr_printf(int, char *, ...);
138
139 #endif