fc6e84ee433523a4a0d1e3e546333c40891b0384
[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
90 /* Bounds */
91
92 #define MIN_INTERVAL        0.01
93
94 #define MAX_POLLRATE        1.0
95 #define MIN_POLLRATE        0.01
96 #define MAX_NICCHGPOLLRT    100.0
97 #define MIN_NICCHGPOLLRT    1.0
98 #define MAX_DEBUGLVL        9
99 #define MIN_DEBUGLVL        0
100 #define MAX_TOS             16
101 #define MIN_TOS             0
102 #define MAX_WILLINGNESS     7
103 #define MIN_WILLINGNESS     0
104 #define MAX_MPR_COVERAGE    20
105 #define MIN_MPR_COVERAGE    1
106 #define MAX_TC_REDUNDANCY   2
107 #define MIN_TC_REDUNDANCY   0
108 #define MAX_HYST_PARAM      1.0
109 #define MIN_HYST_PARAM      0.0
110 #define MAX_LQ_LEVEL        2
111 #define MIN_LQ_LEVEL        0
112 #define MAX_LQ_AGING        1.0
113 #define MIN_LQ_AGING        0.01
114
115 /* Option values */
116 #define CFG_FIBM_FLAT          "flat"
117 #define CFG_FIBM_CORRECT       "correct"
118 #define CFG_FIBM_APPROX        "approx"
119
120 #ifndef IPV6_ADDR_SITELOCAL
121 #define IPV6_ADDR_SITELOCAL    0x0040U
122 #endif
123
124 #include "interfaces.h"
125
126 struct olsr_msg_params {
127   float emission_interval;
128   float validity_time;
129 };
130
131 struct olsr_lq_mult {
132   union olsr_ip_addr addr;
133   uint32_t value;
134   struct olsr_lq_mult *next;
135 };
136
137 struct olsr_if_weight {
138   int value;
139   bool fixed;
140 };
141
142 struct if_config_options {
143   union olsr_ip_addr ipv4_multicast;
144   union olsr_ip_addr ipv6_multicast;
145
146   union olsr_ip_addr ipv4_src;
147   struct olsr_ip_prefix ipv6_src;
148
149   int mode;
150
151   struct olsr_if_weight weight;
152   struct olsr_msg_params hello_params;
153   struct olsr_msg_params tc_params;
154   struct olsr_msg_params mid_params;
155   struct olsr_msg_params hna_params;
156   struct olsr_lq_mult *lq_mult;
157   bool autodetect_chg;
158 };
159
160 struct olsr_if {
161   char *name;
162   bool configured;
163   bool host_emul;
164   union olsr_ip_addr hemu_ip;
165   struct interface *interf;
166   struct if_config_options *cnf, *cnfi;
167   struct olsr_if *next;
168 };
169
170 struct ip_prefix_list {
171   struct olsr_ip_prefix net;
172   struct ip_prefix_list *next;
173 };
174
175 struct hyst_param {
176   float scaling;
177   float thr_high;
178   float thr_low;
179 };
180
181 struct plugin_param {
182   char *key;
183   char *value;
184   struct plugin_param *next;
185 };
186
187 struct plugin_entry {
188   char *name;
189   struct plugin_param *params;
190   struct plugin_entry *next;
191 };
192
193 typedef enum {
194   FIBM_FLAT,
195   FIBM_CORRECT,
196   FIBM_APPROX
197 } olsr_fib_metric_options;
198
199 /*
200  * The config struct
201  */
202
203 struct olsrd_config {
204   uint16_t olsrport;
205   int debug_level;
206   bool no_fork;
207   bool host_emul;
208   int ip_version;
209   bool allow_no_interfaces;
210   uint16_t tos;
211   uint8_t rtproto;
212   uint8_t rttable;
213   uint8_t rttable_default;
214   uint8_t willingness;
215   bool willingness_auto;
216   int ipc_connections;
217   bool use_hysteresis;
218   olsr_fib_metric_options fib_metric;
219   struct hyst_param hysteresis_param;
220   struct plugin_entry *plugins;
221   struct ip_prefix_list *hna_entries;
222   struct ip_prefix_list *ipc_nets;
223   struct if_config_options *interface_defaults;
224   struct olsr_if *interfaces;
225   float pollrate;
226   float nic_chgs_pollrate;
227   bool clear_screen;
228   uint8_t tc_redundancy;
229   uint8_t mpr_coverage;
230   uint8_t lq_level;
231   uint8_t lq_fish;
232   float lq_dinter;
233   float lq_aging;
234   char *lq_algorithm;
235   uint8_t lq_dlimit;
236
237   float min_tc_vtime;
238   /* Stuff set by olsrd */
239   uint8_t maxplen;                     /* maximum prefix len */
240   size_t ipsize;                       /* Size of address */
241   bool del_gws;                        /* Delete InternetGWs at startup */
242   union olsr_ip_addr main_addr;        /* Main address of this node */
243   float will_int;
244   float max_jitter;
245   int exit_value;                      /* Global return value for process termination */
246   float max_tc_vtime;
247
248   char *lock_file;
249
250   int ioctl_s;                         /* Socket used for ioctl calls */
251 #if LINUX_POLICY_ROUTING
252   int rtnl_s;                          /* Socket used for rtnetlink messages */
253 #endif
254
255 #if defined __FreeBSD__ || defined __FreeBSD_kernel__ || defined __MacOSX__ || defined __NetBSD__ || defined __OpenBSD__
256   int rts;                             /* Socket used for route changes on BSDs */
257 #endif
258   float lq_nat_thresh;
259 };
260
261 #if defined __cplusplus
262 extern "C" {
263 #endif
264
265 /*
266  * List functions
267  */
268
269   void ip_prefix_list_add(struct ip_prefix_list **, const union olsr_ip_addr *, uint8_t);
270
271   int ip_prefix_list_remove(struct ip_prefix_list **, const union olsr_ip_addr *, uint8_t);
272
273   struct ip_prefix_list *ip_prefix_list_find(struct ip_prefix_list *, const union olsr_ip_addr *net, uint8_t prefix_len);
274
275 /*
276  * Interface to parser
277  */
278
279   int olsrd_parse_cnf(const char *);
280
281   int olsrd_sanity_check_cnf(struct olsrd_config *);
282
283   void olsrd_free_cnf(struct olsrd_config *);
284
285   void olsrd_print_cnf(struct olsrd_config *);
286
287   int olsrd_write_cnf(struct olsrd_config *, const char *);
288
289   int olsrd_write_cnf_buf(struct olsrd_config *, char *, uint32_t);
290
291   struct if_config_options *get_default_if_config(void);
292
293   struct olsrd_config *olsrd_get_default_cnf(void);
294
295 #if defined WIN32
296   void win32_stdio_hack(unsigned int);
297
298   void *win32_olsrd_malloc(size_t size);
299
300   void win32_olsrd_free(void *ptr);
301 #endif
302
303 #if defined __cplusplus
304 }
305 #endif
306 #endif
307
308 /*
309  * Local Variables:
310  * c-basic-offset: 2
311  * indent-tabs-mode: nil
312  * End:
313  */