080d8d4814426f8e565264d70a0f47d5b96b7fc1
[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 #define TESTLIB_PATH 0
51 #define SYSLOG_NUMBERING 0
52
53 /* Default values not declared in olsr_protocol.h */
54 #define DEF_POLLRATE         0.05
55 #define DEF_NICCHGPOLLRT     2.5
56 #define DEF_WILL_AUTO        false
57 #define DEF_WILLINGNESS      3
58 #define DEF_ALLOW_NO_INTS    true
59 #define DEF_TOS              16
60 #define DEF_DEBUGLVL         1
61 #define DEF_IPC_CONNECTIONS  0
62 #define DEF_USE_HYST         false
63 #define DEF_FIB_METRIC       FIBM_FLAT
64 #define DEF_LQ_LEVEL         2
65 #define DEF_LQ_FISH          1
66 #define DEF_LQ_DIJK_LIMIT    255
67 #define DEF_LQ_DIJK_INTER    0.0
68 #define DEF_LQ_NAT_THRESH    1.0
69 #define DEF_LQ_AGING         0.05
70 #define DEF_CLEAR_SCREEN     true
71 #define DEF_OLSRPORT         698
72 #define DEF_RTPOLICY         true
73 #define DEF_RTPROTO          0 /* 0 means OS-specific default */
74 #define DEF_RTTABLE          254
75 #define DEF_RTTABLE_DEFAULT  112
76 #define DEF_RTTABLE_TUNNEL   113
77 #define DEF_RTTABLE          254
78 #define DEF_MIN_TC_VTIME     0.0
79 #define DEF_USE_NIIT         true
80 #define DEF_SMART_GW         false
81 #define DEF_GW_ALLOW_NAT     true
82 #define DEF_GW_TYPE          GW_UPLINK_IPV46
83 #define DEF_GW_UPLINK_NAT    true
84 #define DEF_UPLINK_SPEED     128
85 #define DEF_DOWNLINK_SPEED   1024
86 #define DEF_USE_SRCIP_ROUTES false;
87
88 /* Bounds */
89
90 #define MIN_INTERVAL         0.01
91
92 #define MAX_POLLRATE         1.0
93 #define MIN_POLLRATE         0.01
94 #define MAX_NICCHGPOLLRT     100.0
95 #define MIN_NICCHGPOLLRT     1.0
96 #define MAX_DEBUGLVL         9
97 #define MIN_DEBUGLVL         0
98 #define MAX_TOS              16
99 #define MIN_TOS              0
100 #define MAX_WILLINGNESS      7
101 #define MIN_WILLINGNESS      0
102 #define MAX_MPR_COVERAGE     20
103 #define MIN_MPR_COVERAGE     1
104 #define MAX_TC_REDUNDANCY    2
105 #define MIN_TC_REDUNDANCY    0
106 #define MAX_HYST_PARAM       1.0
107 #define MIN_HYST_PARAM       0.0
108 #define MAX_LQ_LEVEL         2
109 #define MIN_LQ_LEVEL         0
110 #define MAX_LQ_AGING         1.0
111 #define MIN_LQ_AGING         0.01
112
113 #define MIN_SMARTGW_SPEED    1
114 #define MAX_SMARTGW_SPEED    320000000
115
116 /* Option values */
117 #define CFG_FIBM_FLAT          "flat"
118 #define CFG_FIBM_CORRECT       "correct"
119 #define CFG_FIBM_APPROX        "approx"
120
121 #ifndef IPV6_ADDR_SITELOCAL
122 #define IPV6_ADDR_SITELOCAL    0x0040U
123 #endif
124
125 #include "interfaces.h"
126
127 enum smart_gw_uplinktype {
128   GW_UPLINK_NONE,
129   GW_UPLINK_IPV4,
130   GW_UPLINK_IPV6,
131   GW_UPLINK_IPV46,
132   GW_UPLINK_CNT,
133 };
134
135 struct olsr_msg_params {
136   float emission_interval;
137   float validity_time;
138 };
139
140 struct olsr_lq_mult {
141   union olsr_ip_addr addr;
142   uint32_t value;
143   struct olsr_lq_mult *next;
144 };
145
146 struct olsr_if_weight {
147   int value;
148   bool fixed;
149 };
150
151 struct if_config_options {
152   union olsr_ip_addr ipv4_multicast;
153   union olsr_ip_addr ipv6_multicast;
154
155   union olsr_ip_addr ipv4_src;
156   struct olsr_ip_prefix ipv6_src;
157
158   int mode;
159
160   struct olsr_if_weight weight;
161   struct olsr_msg_params hello_params;
162   struct olsr_msg_params tc_params;
163   struct olsr_msg_params mid_params;
164   struct olsr_msg_params hna_params;
165   struct olsr_lq_mult *lq_mult;
166   int orig_lq_mult_cnt;
167   bool autodetect_chg;
168 };
169
170 struct olsr_if {
171   char *name;
172   bool configured;
173   bool host_emul;
174   union olsr_ip_addr hemu_ip;
175   struct interface *interf;
176   struct if_config_options *cnf, *cnfi;
177   struct olsr_if *next;
178 };
179
180 struct ip_prefix_list {
181   struct olsr_ip_prefix net;
182   struct ip_prefix_list *next;
183 };
184
185 struct hyst_param {
186   float scaling;
187   float thr_high;
188   float thr_low;
189 };
190
191 struct plugin_param {
192   char *key;
193   char *value;
194   struct plugin_param *next;
195 };
196
197 struct plugin_entry {
198   char *name;
199   struct plugin_param *params;
200   struct plugin_entry *next;
201 };
202
203 typedef enum {
204   FIBM_FLAT,
205   FIBM_CORRECT,
206   FIBM_APPROX
207 } olsr_fib_metric_options;
208
209 /*
210  * The config struct
211  */
212
213 struct olsrd_config {
214   uint16_t olsrport;
215   int debug_level;
216   bool no_fork;
217   bool host_emul;
218   int ip_version;
219   bool allow_no_interfaces;
220   uint16_t tos;
221   bool rt_policy;
222   uint8_t rt_proto;
223   uint8_t rt_table, rt_table_default, rt_table_tunnel;
224   uint16_t rt_table_pri, rt_table_tunnel_pri;
225   uint16_t rt_table_defaultolsr_pri, rt_table_default_pri;
226   uint8_t willingness;
227   bool willingness_auto;
228   int ipc_connections;
229   bool use_hysteresis;
230   olsr_fib_metric_options fib_metric;
231   struct hyst_param hysteresis_param;
232   struct plugin_entry *plugins;
233   struct ip_prefix_list *hna_entries;
234   struct ip_prefix_list *ipc_nets;
235   struct if_config_options *interface_defaults;
236   struct olsr_if *interfaces;
237   float pollrate;
238   float nic_chgs_pollrate;
239   bool clear_screen;
240   uint8_t tc_redundancy;
241   uint8_t mpr_coverage;
242   uint8_t lq_level;
243   uint8_t lq_fish;
244   float lq_dinter;
245   float lq_aging;
246   char *lq_algorithm;
247   uint8_t lq_dlimit;
248
249   float min_tc_vtime;
250
251   char *lock_file;
252   bool use_niit;
253
254   bool smart_gw_active, smart_gw_allow_nat, smart_gw_uplink_nat;
255   enum smart_gw_uplinktype smart_gw_type;
256   uint32_t smart_gw_uplink, smart_gw_downlink;
257   struct olsr_ip_prefix smart_gw_prefix;
258
259   /* Main address of this node */
260   union olsr_ip_addr main_addr;
261   bool use_src_ip_routes;
262
263   /* Stuff set by olsrd */
264   uint8_t maxplen;                     /* maximum prefix len */
265   size_t ipsize;                       /* Size of address */
266   bool del_gws;                        /* Delete InternetGWs at startup */
267   float will_int;
268   float max_jitter;
269   int exit_value;                      /* Global return value for process termination */
270   float max_tc_vtime;
271
272   int niit4to6_if_index, niit6to4_if_index;
273
274   /*many potential parameters or helper variables for smartgateway*/
275   bool has_ipv4_gateway, has_ipv6_gateway;
276
277   int ioctl_s;                         /* Socket used for ioctl calls */
278 #ifdef LINUX_NETLINK_ROUTING
279   int rtnl_s;                          /* Socket used for rtnetlink messages */
280   int rt_monitor_socket;
281 #endif
282
283 #if defined __FreeBSD__ || defined __FreeBSD_kernel__ || defined __MacOSX__ || defined __NetBSD__ || defined __OpenBSD__
284   int rts;                             /* Socket used for route changes on BSDs */
285 #endif
286   float lq_nat_thresh;
287 };
288
289 #if defined __cplusplus
290 extern "C" {
291 #endif
292
293   extern const char *GW_UPLINK_TXT[];
294
295 /*
296  * List functions
297  */
298
299   void ip_prefix_list_add(struct ip_prefix_list **, const union olsr_ip_addr *, uint8_t);
300
301   int ip_prefix_list_remove(struct ip_prefix_list **, const union olsr_ip_addr *, uint8_t);
302
303   struct ip_prefix_list *ip_prefix_list_find(struct ip_prefix_list *, const union olsr_ip_addr *net, uint8_t prefix_len);
304
305 /*
306  * Interface to parser
307  */
308
309   int olsrd_parse_cnf(const char *);
310
311   int olsrd_sanity_check_cnf(struct olsrd_config *);
312
313   void olsrd_free_cnf(struct olsrd_config *);
314
315   void olsrd_print_cnf(struct olsrd_config *);
316
317   int olsrd_write_cnf(struct olsrd_config *, const char *);
318
319   int olsrd_write_cnf_buf(struct olsrd_config *, char *, uint32_t);
320
321   struct if_config_options *get_default_if_config(void);
322
323   struct olsrd_config *olsrd_get_default_cnf(void);
324
325 #if defined WIN32
326   void win32_stdio_hack(unsigned int);
327
328   void *win32_olsrd_malloc(size_t size);
329
330   void win32_olsrd_free(void *ptr);
331 #endif
332
333 #if defined __cplusplus
334 }
335 #endif
336 #endif
337
338 /*
339  * Local Variables:
340  * c-basic-offset: 2
341  * indent-tabs-mode: nil
342  * End:
343  */