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