* also change the default in the code
[olsrd.git] / src / olsr_cfg.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_cfg.h,v 1.32 2007/09/06 12:08:28 bernd67 Exp $
40  */
41
42
43 #ifndef _OLSRD_CFGPARSER_H
44 #define _OLSRD_CFGPARSER_H
45
46 #include "olsr_types.h"
47
48 /* Default values not declared in olsr_protocol.h */
49 #define DEF_POLLRATE        0.05
50 #define DEF_NICCHGPOLLRT    2.5
51 #define DEF_WILL_AUTO       OLSR_TRUE
52 #define DEF_ALLOW_NO_INTS   OLSR_TRUE
53 #define DEF_TOS             16
54 #define DEF_DEBUGLVL        1
55 #define DEF_IPC_CONNECTIONS 0
56 #define DEF_USE_HYST        OLSR_FALSE
57 #define DEF_LQ_LEVEL        2
58 #define DEF_LQ_FISH         0
59 #define DEF_LQ_DIJK_LIMIT   255
60 #define DEF_LQ_DIJK_INTER   0.0
61 #define DEF_LQ_WSIZE        12
62 #define DEF_CLEAR_SCREEN    OLSR_FALSE
63
64 /* Bounds */
65
66 #define MIN_INTERVAL        0.01
67
68 #define MAX_POLLRATE        10.0
69 #define MIN_POLLRATE        0.01
70 #define MAX_NICCHGPOLLRT    100.0
71 #define MIN_NICCHGPOLLRT    1.0
72 #define MAX_DEBUGLVL        9
73 #define MIN_DEBUGLVL        0
74 #define MAX_TOS             16
75 #define MIN_TOS             0
76 #define MAX_WILLINGNESS     7
77 #define MIN_WILLINGNESS     0
78 #define MAX_MPR_COVERAGE    20
79 #define MIN_MPR_COVERAGE    1
80 #define MAX_TC_REDUNDANCY   2
81 #define MIN_TC_REDUNDANCY   0
82 #define MAX_HYST_PARAM      1.0
83 #define MIN_HYST_PARAM      0.0
84 #define MAX_LQ_LEVEL        2
85 #define MIN_LQ_LEVEL        0
86 #define MAX_LQ_WSIZE        128
87 #define MIN_LQ_WSIZE        3
88
89 #ifndef IPV6_ADDR_SITELOCAL
90 #define IPV6_ADDR_SITELOCAL    0x0040U
91 #endif
92
93 #include "interfaces.h"
94
95 struct olsr_msg_params
96 {
97   float                    emission_interval;
98   float                    validity_time;
99 };
100
101 struct olsr_lq_mult
102 {
103   union olsr_ip_addr addr;
104   float val;
105   struct olsr_lq_mult *next;
106 };
107
108 struct olsr_if_weight
109 {
110   int        value;
111   olsr_bool  fixed;
112 };
113
114 struct if_config_options
115 {
116   union olsr_ip_addr       ipv4_broadcast;
117   int                      ipv6_addrtype;
118   union olsr_ip_addr       ipv6_multi_site;
119   union olsr_ip_addr       ipv6_multi_glbl;
120   struct olsr_if_weight    weight;
121   struct olsr_msg_params   hello_params;
122   struct olsr_msg_params   tc_params;
123   struct olsr_msg_params   mid_params;
124   struct olsr_msg_params   hna_params;
125   struct olsr_lq_mult      *lq_mult;
126   olsr_bool                autodetect_chg;
127 };
128
129
130
131 struct olsr_if
132 {
133   char                     *name;
134   char                     *config;
135   olsr_bool                configured;
136   olsr_bool                host_emul;
137   union olsr_ip_addr       hemu_ip;
138   struct interface         *interf;
139   struct if_config_options *cnf;
140   struct olsr_if           *next;
141 };
142
143 struct hna4_entry
144 {
145   union olsr_ip_addr       net;
146   union olsr_ip_addr       netmask;
147   struct hna4_entry        *next;
148 };
149
150 struct hna6_entry
151 {
152   union olsr_ip_addr       net;
153   olsr_u16_t               prefix_len;
154   struct hna6_entry        *next;
155 };
156
157 struct hyst_param
158 {
159   float                    scaling;
160   float                    thr_high;
161   float                    thr_low;
162 };
163
164 struct plugin_param
165 {
166   char                     *key;
167   char                     *value;
168   struct plugin_param      *next;
169 };
170
171 struct plugin_entry
172 {
173   char                     *name;
174   struct plugin_param      *params;
175   struct plugin_entry      *next;
176 };
177
178 struct ipc_host
179 {
180   union olsr_ip_addr       host;
181   struct ipc_host          *next;
182 };
183
184 struct ipc_net
185 {
186   union olsr_ip_addr       net;
187   union olsr_ip_addr       mask;
188   struct ipc_net           *next;
189 };
190
191 /*
192  * The config struct
193  */
194
195 struct olsrd_config
196 {
197   int                      debug_level;
198   olsr_bool                no_fork;
199   olsr_bool                host_emul;
200   int                      ip_version;
201   olsr_bool                allow_no_interfaces;
202   olsr_u16_t               tos;
203   olsr_bool                willingness_auto;
204   olsr_u8_t                willingness;
205   int                      ipc_connections;
206   olsr_bool                open_ipc;
207   olsr_bool                use_hysteresis;
208   struct hyst_param        hysteresis_param;
209   float                    pollrate;
210   float                    nic_chgs_pollrate;
211   olsr_u8_t                tc_redundancy;
212   olsr_u8_t                mpr_coverage;
213   olsr_bool                clear_screen;
214   olsr_u8_t                lq_level;
215   olsr_u32_t               lq_wsize;
216   olsr_u8_t                lq_fish;
217   olsr_u8_t                lq_dlimit;
218   float                    lq_dinter;
219   struct plugin_entry      *plugins;
220   struct hna4_entry        *hna4_entries;
221   struct hna6_entry        *hna6_entries;
222   struct ipc_host          *ipc_hosts;
223   struct ipc_net           *ipc_nets;
224   struct olsr_if           *interfaces;
225
226   /* Stuff set by olsrd */
227   size_t                   ipsize;               /* Size of address */
228   olsr_u16_t               system_tick_divider;  /* Tick resolution */
229   olsr_bool                del_gws;              /* Delete InternetGWs at startup */
230   union olsr_ip_addr       main_addr;            /* Main address of this node */
231   float                    will_int;
232   float                    max_jitter;
233   int                      exit_value; /* Global return value for process termination */
234   float                    max_tc_vtime;
235
236   int                      ioctl_s;              /* Socket used for ioctl calls */
237   int                      rts;                  /* Socket used for route changes on BSDs */
238 };
239
240 #if defined __cplusplus
241 extern "C" {
242 #endif
243
244 /*
245  * Interface to parser
246  */
247
248 struct olsrd_config *
249 olsrd_parse_cnf(const char *);
250
251 int
252 olsrd_sanity_check_cnf(struct olsrd_config *);
253
254 void
255 olsrd_free_cnf(struct olsrd_config *);
256
257 void
258 olsrd_print_cnf(struct olsrd_config *);
259
260 int
261 olsrd_write_cnf(struct olsrd_config *, const char *);
262
263 int
264 olsrd_write_cnf_buf(struct olsrd_config *, char *, olsr_u32_t);
265
266 struct if_config_options *
267 get_default_if_config(void);
268
269 struct olsrd_config *
270 olsrd_get_default_cnf(void);
271
272 void *
273 olsrd_cnf_malloc(unsigned int);
274
275 void
276 olsrd_cnf_free(void *);
277
278 #if defined __cplusplus
279 }
280 #endif
281
282 #endif