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