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