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