baaae780de8421e82b18ff3574d84debfe659b7d
[olsrd.git] / src / olsr_cfg.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004, Andreas Tonnesen(andreto@olsr.org)
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 #ifndef _OLSRD_CFGPARSER_H
43 #define _OLSRD_CFGPARSER_H
44
45 #include "olsr_types.h"
46
47 /*set to 1 to collect all startup sleep into one sleep (just as long as the longest sleep) useful if many errors on many interfaces*/
48 #define OLSR_COLLECT_STARTUP_SLEEP 1
49
50 /* set to 1 to enable a second rtnetlink socket 
51  * used for listening and reating on interface change events
52  * (requires LINUX_POLICY_ROUTING to be enabled aswell) */
53 #define LINUX_RTNETLINK_LISTEN 1
54
55 #define TESTLIB_PATH 0
56 #define SYSLOG_NUMBERING 0
57 #define SOURCE_IP_ROUTES 0
58
59 #ifndef LINUX_POLICY_ROUTING
60 #if defined linux
61 #  define LINUX_POLICY_ROUTING 1
62 #else
63 #  define LINUX_POLICY_ROUTING 0
64 #endif
65 #endif
66
67 /* Default values not declared in olsr_protocol.h */
68 #define DEF_POLLRATE        0.05
69 #define DEF_NICCHGPOLLRT    2.5
70 #define DEF_WILL_AUTO       false
71 #define DEF_WILLINGNESS     3
72 #define DEF_ALLOW_NO_INTS   true
73 #define DEF_TOS             16
74 #define DEF_DEBUGLVL        1
75 #define DEF_IPC_CONNECTIONS 0
76 #define DEF_USE_HYST        false
77 #define DEF_FIB_METRIC      FIBM_FLAT
78 #define DEF_LQ_LEVEL        2
79 #define DEF_LQ_FISH         1
80 #define DEF_LQ_DIJK_LIMIT   255
81 #define DEF_LQ_DIJK_INTER   0.0
82 #define DEF_LQ_NAT_THRESH   0.5
83 #define DEF_LQ_AGING        0.1
84 #define DEF_CLEAR_SCREEN    true
85 #define DEF_OLSRPORT        698
86 #define DEF_RTPROTO         0 /* 0 means OS-specific default */
87 #define DEF_RTTABLE         254
88 #define DEF_MIN_TC_VTIME    0.0
89 #define DEF_NIIT            "auto"
90 #define DEF_NIIT_IF         "niit4to6"
91
92 /* Bounds */
93
94 #define MIN_INTERVAL        0.01
95
96 #define MAX_POLLRATE        1.0
97 #define MIN_POLLRATE        0.01
98 #define MAX_NICCHGPOLLRT    100.0
99 #define MIN_NICCHGPOLLRT    1.0
100 #define MAX_DEBUGLVL        9
101 #define MIN_DEBUGLVL        0
102 #define MAX_TOS             16
103 #define MIN_TOS             0
104 #define MAX_WILLINGNESS     7
105 #define MIN_WILLINGNESS     0
106 #define MAX_MPR_COVERAGE    20
107 #define MIN_MPR_COVERAGE    1
108 #define MAX_TC_REDUNDANCY   2
109 #define MIN_TC_REDUNDANCY   0
110 #define MAX_HYST_PARAM      1.0
111 #define MIN_HYST_PARAM      0.0
112 #define MAX_LQ_LEVEL        2
113 #define MIN_LQ_LEVEL        0
114 #define MAX_LQ_AGING        1.0
115 #define MIN_LQ_AGING        0.01
116
117 /* Option values */
118 #define CFG_FIBM_FLAT          "flat"
119 #define CFG_FIBM_CORRECT       "correct"
120 #define CFG_FIBM_APPROX        "approx"
121
122 #ifndef IPV6_ADDR_SITELOCAL
123 #define IPV6_ADDR_SITELOCAL    0x0040U
124 #endif
125
126 #include "interfaces.h"
127
128 struct olsr_msg_params {
129   float emission_interval;
130   float validity_time;
131 };
132
133 struct olsr_lq_mult {
134   union olsr_ip_addr addr;
135   uint32_t value;
136   struct olsr_lq_mult *next;
137 };
138
139 struct olsr_if_weight {
140   int value;
141   bool fixed;
142 };
143
144 struct if_config_options {
145   union olsr_ip_addr ipv4_multicast;
146   union olsr_ip_addr ipv6_multicast;
147
148   union olsr_ip_addr ipv4_src;
149   struct olsr_ip_prefix ipv6_src;
150
151   int mode;
152
153   struct olsr_if_weight weight;
154   struct olsr_msg_params hello_params;
155   struct olsr_msg_params tc_params;
156   struct olsr_msg_params mid_params;
157   struct olsr_msg_params hna_params;
158   struct olsr_lq_mult *lq_mult;
159   int orig_lq_mult_cnt;
160   bool autodetect_chg;
161 };
162
163 struct olsr_if {
164   char *name;
165   bool configured;
166   bool host_emul;
167   union olsr_ip_addr hemu_ip;
168   struct interface *interf;
169   struct if_config_options *cnf, *cnfi;
170   struct olsr_if *next;
171 };
172
173 struct ip_prefix_list {
174   struct olsr_ip_prefix net;
175   struct ip_prefix_list *next;
176 };
177
178 struct hyst_param {
179   float scaling;
180   float thr_high;
181   float thr_low;
182 };
183
184 struct plugin_param {
185   char *key;
186   char *value;
187   struct plugin_param *next;
188 };
189
190 struct plugin_entry {
191   char *name;
192   struct plugin_param *params;
193   struct plugin_entry *next;
194 };
195
196 typedef enum {
197   FIBM_FLAT,
198   FIBM_CORRECT,
199   FIBM_APPROX
200 } olsr_fib_metric_options;
201
202 /*
203  * The config struct
204  */
205
206 struct olsrd_config {
207   uint16_t olsrport;
208   int debug_level;
209   bool no_fork;
210   bool host_emul;
211   int ip_version;
212   bool allow_no_interfaces;
213   uint16_t tos;
214   uint8_t rtproto;
215   uint8_t rttable;
216   uint8_t rttable_default;
217   uint8_t willingness;
218   bool willingness_auto;
219   int ipc_connections;
220   bool use_hysteresis;
221   olsr_fib_metric_options fib_metric;
222   struct hyst_param hysteresis_param;
223   struct plugin_entry *plugins;
224   struct ip_prefix_list *hna_entries;
225   struct ip_prefix_list *ipc_nets;
226   struct if_config_options *interface_defaults;
227   struct olsr_if *interfaces;
228   float pollrate;
229   float nic_chgs_pollrate;
230   bool clear_screen;
231   uint8_t tc_redundancy;
232   uint8_t mpr_coverage;
233   uint8_t lq_level;
234   uint8_t lq_fish;
235   float lq_dinter;
236   float lq_aging;
237   char *lq_algorithm;
238   uint8_t lq_dlimit;
239
240   float min_tc_vtime;
241   /* Stuff set by olsrd */
242   uint8_t maxplen;                     /* maximum prefix len */
243   size_t ipsize;                       /* Size of address */
244   bool del_gws;                        /* Delete InternetGWs at startup */
245   union olsr_ip_addr main_addr;        /* Main address of this node */
246   float will_int;
247   float max_jitter;
248   int exit_value;                      /* Global return value for process termination */
249   float max_tc_vtime;
250
251   char *lock_file;
252
253   char *niit_if;
254   int niit_if_index;
255
256   int ioctl_s;                         /* Socket used for ioctl calls */
257 #if LINUX_POLICY_ROUTING
258   int rtnl_s;                          /* Socket used for rtnetlink messages */
259 #endif
260
261 #if defined __FreeBSD__ || defined __FreeBSD_kernel__ || defined __MacOSX__ || defined __NetBSD__ || defined __OpenBSD__
262   int rts;                             /* Socket used for route changes on BSDs */
263 #endif
264   float lq_nat_thresh;
265 };
266
267 #if defined __cplusplus
268 extern "C" {
269 #endif
270
271 /*
272  * List functions
273  */
274
275   void ip_prefix_list_add(struct ip_prefix_list **, const union olsr_ip_addr *, uint8_t);
276
277   int ip_prefix_list_remove(struct ip_prefix_list **, const union olsr_ip_addr *, uint8_t);
278
279   struct ip_prefix_list *ip_prefix_list_find(struct ip_prefix_list *, const union olsr_ip_addr *net, uint8_t prefix_len);
280
281 /*
282  * Interface to parser
283  */
284
285   int olsrd_parse_cnf(const char *);
286
287   int olsrd_sanity_check_cnf(struct olsrd_config *);
288
289   void olsrd_free_cnf(struct olsrd_config *);
290
291   void olsrd_print_cnf(struct olsrd_config *);
292
293   int olsrd_write_cnf(struct olsrd_config *, const char *);
294
295   int olsrd_write_cnf_buf(struct olsrd_config *, char *, uint32_t);
296
297   struct if_config_options *get_default_if_config(void);
298
299   struct olsrd_config *olsrd_get_default_cnf(void);
300
301 #if defined WIN32
302   void win32_stdio_hack(unsigned int);
303
304   void *win32_olsrd_malloc(size_t size);
305
306   void win32_olsrd_free(void *ptr);
307 #endif
308
309 #if defined __cplusplus
310 }
311 #endif
312 #endif
313
314 /*
315  * Local Variables:
316  * c-basic-offset: 2
317  * indent-tabs-mode: nil
318  * End:
319  */