Various headerfile inclusion cleanups
[olsrd.git] / src / defs.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: defs.h,v 1.40 2005/02/27 18:39:43 kattemat Exp $
40  */
41
42 #ifndef OLSR_PLUGIN
43
44 #ifndef _OLSR_DEFS
45 #define _OLSR_DEFS
46
47 /* Common includes */
48 #include <sys/time.h>
49 #include <sys/times.h>
50 #include <sys/socket.h>
51 #include <netinet/in.h>
52 #include <stdio.h>
53 #include <stdlib.h>
54 #include <string.h>
55 #include <unistd.h>
56 #include <errno.h>
57 #include <time.h>
58
59 #include "olsr_protocol.h"
60 #include "net.h" /* IPaddr -> string conversions is used by everyone */
61 #include "olsr_cfg.h"
62
63 #define VERSION "0.4.9-pre"
64 #define SOFTWARE_VERSION "olsr.org - " VERSION
65 #define OLSRD_VERSION_DATE "       *** " SOFTWARE_VERSION " (" __DATE__ ") ***\n"
66
67 #define OLSRD_CONF_FILE_NAME "olsrd.conf"
68 #define OLSRD_GLOBAL_CONF_FILE "/etc/" OLSRD_CONF_FILE_NAME
69
70 #define HOPCNT_MAX              16      /* maximum hops number */
71 #define MAXMESSAGESIZE          1500    /* max broadcast size */
72 #define UDP_IP_HDRSIZE          28
73 #define MAX_IFS                 16
74
75 /* Debug helper macro */
76 #ifdef DEBUG
77 #define olsr_debug(lvl,format,args...) \
78    OLSR_PRINTF(lvl, "%s (%s:%d): ", __func__, __FILE__, __LINE__); \
79    OLSR_PRINTF(lvl, format, ##args);
80 #endif
81
82 FILE *debug_handle;
83
84 #ifdef NODEBUG
85 #define OLSR_PRINTF(lvl, format, args...) \
86    { }
87 #else
88 #define OLSR_PRINTF(lvl, format, args...) \
89    { \
90      if((olsr_cnf->debug_level >= lvl) && debug_handle) \
91         fprintf(debug_handle, format, ##args); \
92    }
93 #endif
94
95 /* Provides a timestamp s1 milliseconds in the future
96    according to system ticks returned by times(2) */
97 #define GET_TIMESTAMP(s1) \
98         now_times + ((s1) / system_tick_divider)
99
100 #define TIMED_OUT(s1) \
101         ((int)((s1) - now_times) < 0)
102
103
104 /*
105  * Queueing macros
106  */
107
108 /* First "argument" is NOT a pointer! */
109
110 #define QUEUE_ELEM(pre, new) \
111         pre.next->prev = new; \
112         new->next = pre.next; \
113         new->prev = &pre; \
114         pre.next = new
115
116 #define DEQUEUE_ELEM(elem) \
117         elem->prev->next = elem->next; \
118         elem->next->prev = elem->prev
119
120
121 /*
122  * Global olsrd configuragtion
123  */
124
125 struct olsrd_config *olsr_cnf;
126
127 /* Global tick resolution */
128 olsr_u16_t system_tick_divider;
129
130 int exit_value; /* Global return value for process termination */
131
132
133 /* Timer data */
134 clock_t now_times;              /* current idea of times(2) reported uptime */
135 struct timeval now;             /* current idea of time */
136 struct tm *nowtm;               /* current idea of time (in tm) */
137
138 olsr_bool disp_pack_in;         /* display incoming packet content? */
139 olsr_bool disp_pack_out;        /* display outgoing packet content? */
140
141 olsr_bool del_gws;
142
143 /*
144  * Timer values
145  */
146
147 extern float will_int;
148 extern float dup_hold_time;
149 extern float max_jitter;
150
151 size_t ipsize;
152
153 /* Main address of this node */
154 union olsr_ip_addr main_addr;
155
156 /* OLSR UPD port */
157 int olsr_udp_port;
158
159 /* The socket used for all ioctls */
160 int ioctl_s;
161
162 /* routing socket */
163 #if defined __FreeBSD__ || defined __MacOSX__ || defined __NetBSD__
164 int rts;
165 #endif
166
167 float max_tc_vtime;
168
169 clock_t fwdtimer[MAX_IFS];      /* forwarding timer */
170
171 int minsize;
172
173 olsr_bool changes;                /* is set if changes occur in MPRS set */ 
174
175 /* TC empty message sending */
176 extern clock_t send_empty_tc;
177
178 /*
179  *IPC functions
180  *These are moved to a plugin soon
181  * soon... duh!
182  */
183
184 int
185 ipc_init(void);
186
187 int
188 ipc_input(int);
189
190 int
191 shutdown_ipc(void);
192
193 int
194 ipc_output(struct olsr *);
195
196 int
197 ipc_send_net_info(void);
198
199 int
200 ipc_route_send_rtentry(union olsr_ip_addr*, union olsr_ip_addr *, int, int, char *);
201
202
203
204 #endif
205 #endif