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