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