34d583c8a3fb6c5af225b293c21c9a1ca0899e8a
[olsrd.git] / src / olsr_cfg.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon (olsrd)
3  *
4  * (c) by the OLSR project
5  *
6  * See our Git repository to find out who worked on this file
7  * and thus is a copyright holder on it.
8  *
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  *
15  * * Redistributions of source code must retain the above copyright
16  *   notice, this list of conditions and the following disclaimer.
17  * * Redistributions in binary form must reproduce the above copyright
18  *   notice, this list of conditions and the following disclaimer in
19  *   the documentation and/or other materials provided with the
20  *   distribution.
21  * * Neither the name of olsr.org, olsrd nor the names of its
22  *   contributors may be used to endorse or promote products derived
23  *   from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  *
38  * Visit http://www.olsr.org for more information.
39  *
40  * If you find this software useful feel free to make a donation
41  * to the project. For more information see the website or contact
42  * the copyright holders.
43  *
44  */
45
46 #ifndef _OLSRD_CFGPARSER_H
47 #define _OLSRD_CFGPARSER_H
48
49 #include "compiler.h"
50 #include "defs.h"
51 #include "olsr_types.h"
52 #include "common/autobuf.h"
53 #ifdef HTTPINFO_PUD
54 #include "pud/src/receiver.h"
55 #endif /* HTTPINFO_PUD */
56
57 /* set to 1 to collect all startup sleep into one sleep
58  * (just as long as the longest sleep)
59  * useful if many errors on many interfaces */
60 #define OLSR_COLLECT_STARTUP_SLEEP 1
61
62 #define TESTLIB_PATH 0
63 #define SYSLOG_NUMBERING 0
64
65 /* Default values not declared in olsr_protocol.h */
66 #define DEF_IP_VERSION       AF_INET
67 #define DEF_POLLRATE         0.05
68 #define DEF_NICCHGPOLLRT     2.5
69 #define DEF_WILL_AUTO        false
70 #define DEF_WILLINGNESS      3
71 #define DEF_ALLOW_NO_INTS    true
72 #define DEF_TOS              192
73 #define DEF_DEBUGLVL         1
74 #define DEF_IPC_CONNECTIONS  0
75 #define DEF_USE_HYST         false
76 #define DEF_FIB_METRIC       FIBM_FLAT
77 #define DEF_FIB_METRIC_DEFAULT            2
78 #define DEF_LQ_LEVEL         2
79 #define DEF_LQ_ALGORITHM     "etx_ff"
80 #define DEF_LQ_FISH          1
81 #define DEF_LQ_NAT_THRESH    1.0
82 #define DEF_LQ_AGING         0.05
83 #define DEF_CLEAR_SCREEN     true
84 #define DEF_OLSRPORT         698
85 #define DEF_RTPROTO          0 /* 0 means OS-specific default */
86 #define DEF_RT_NONE          -1
87 #define DEF_RT_AUTO          0
88
89 #define DEF_RT_TABLE_NR                   254
90 #define DEF_RT_TABLE_DEFAULT_NR           254
91 #define DEF_RT_TABLE_TUNNEL_NR            254
92
93 #define DEF_SGW_RT_TABLE_NR               254
94 #define DEF_SGW_RT_TABLE_DEFAULT_NR       223
95 #define DEF_SGW_RT_TABLE_TUNNEL_NR        224
96
97 #define DEF_RT_TABLE_PRI                  DEF_RT_NONE
98 #define DEF_RT_TABLE_DEFAULTOLSR_PRI      DEF_RT_NONE
99 #define DEF_RT_TABLE_TUNNEL_PRI           DEF_RT_NONE
100 #define DEF_RT_TABLE_DEFAULT_PRI          DEF_RT_NONE
101
102 #define DEF_SGW_RT_TABLE_PRI                    DEF_RT_NONE
103 #define DEF_SGW_RT_TABLE_PRI_BASE               32766
104 #define DEF_SGW_RT_TABLE_DEFAULTOLSR_PRI_ADDER  10
105 #define DEF_SGW_RT_TABLE_TUNNEL_PRI_ADDER       10
106 #define DEF_SGW_RT_TABLE_DEFAULT_PRI_ADDER      10
107
108 #define DEF_MIN_TC_VTIME     0.0
109 #define DEF_USE_NIIT         true
110 #define DEF_SMART_GW         false
111 #define DEF_SMART_GW_ALWAYS_REMOVE_SERVER_TUNNEL  false
112 #define DEF_GW_USE_COUNT     1
113 #define DEF_GW_TAKEDOWN_PERCENTAGE 25
114 #define DEF_GW_EGRESS_FILE    "/var/run/olsrd-sgw-egress.conf"
115 #define DEF_GW_EGRESS_FILE_PERIOD 5000
116 #define DEF_GW_OFFSET_TABLES 90
117 #define DEF_GW_OFFSET_RULES  0
118 #define DEF_GW_PERIOD        10*1000
119 #define DEF_GW_STABLE_COUNT  6
120 #define DEF_GW_ALLOW_NAT     true
121 #define DEF_GW_THRESH        0
122 #define DEF_GW_WEIGHT_EXITLINK_UP   1
123 #define DEF_GW_WEIGHT_EXITLINK_DOWN 1
124 #define DEF_GW_WEIGHT_ETX           1
125 #define DEF_GW_DIVIDER_ETX          0
126 #define DEF_GW_MAX_COST_MAX_ETX     2560
127 #define DEF_GW_TYPE          GW_UPLINK_IPV46
128 #define DEF_GW_UPLINK_NAT    true
129 #define DEF_UPLINK_SPEED     128
130 #define DEF_DOWNLINK_SPEED   1024
131 #define DEF_USE_SRCIP_ROUTES false
132
133 #define DEF_IF_MODE          IF_MODE_MESH
134
135 /* Bounds */
136
137 #define MIN_INTERVAL         0.01
138
139 #define MAX_POLLRATE         1.0
140 #define MIN_POLLRATE         0.01
141 #define MAX_NICCHGPOLLRT     100.0
142 #define MIN_NICCHGPOLLRT     1.0
143 #define MAX_DEBUGLVL         9
144 #define MIN_DEBUGLVL         0
145 #define MAX_TOS              252
146 #define MIN_TOS              0
147 #define MAX_WILLINGNESS      7
148 #define MIN_WILLINGNESS      0
149 #define MAX_MPR_COVERAGE     20
150 #define MIN_MPR_COVERAGE     1
151 #define MAX_TC_REDUNDANCY    2
152 #define MIN_TC_REDUNDANCY    0
153 #define MAX_HYST_PARAM       1.0
154 #define MIN_HYST_PARAM       0.0
155 #define MAX_LQ_LEVEL         2
156 #define MIN_LQ_LEVEL         0
157 #define MAX_LQ_AGING         1.0
158 #define MIN_LQ_AGING         0.01
159
160 #define MIN_SMARTGW_USE_COUNT_MIN  1
161 #define MAX_SMARTGW_USE_COUNT_MAX  64
162
163 #define MIN_SMARTGW_EGRESS_FILE_PERIOD 1000
164
165 #define MAX_SMARTGW_EGRESS_INTERFACE_COUNT_MAX 32
166
167 #define MIN_SMARTGW_PERIOD   1*1000
168 #define MAX_SMARTGW_PERIOD   320000*1000
169
170 #define MIN_SMARTGW_STABLE   1
171 #define MAX_SMARTGW_STABLE   254
172
173 #define MIN_SMARTGW_THRES    10
174 #define MAX_SMARTGW_THRES    100
175
176 #define MIN_SMARTGW_SPEED    1
177 #define MAX_SMARTGW_SPEED    320000000
178
179 #ifndef IPV6_ADDR_SITELOCAL
180 #define IPV6_ADDR_SITELOCAL    0x0040U
181 #endif /* IPV6_ADDR_SITELOCAL */
182
183 #include "interfaces.h"
184
185 enum smart_gw_uplinktype {
186   GW_UPLINK_NONE,
187   GW_UPLINK_IPV4,
188   GW_UPLINK_IPV6,
189   GW_UPLINK_IPV46,
190   GW_UPLINK_CNT,
191 };
192
193
194 typedef enum {
195   FIBM_FLAT,
196   FIBM_CORRECT,
197   FIBM_APPROX,
198   FIBM_CNT
199 } olsr_fib_metric_options;
200
201 enum olsr_if_mode {
202   IF_MODE_MESH,
203   IF_MODE_ETHER,
204   IF_MODE_CNT
205 };
206
207
208 struct olsr_msg_params {
209   float emission_interval;
210   float validity_time;
211 };
212
213 struct olsr_lq_mult {
214   union olsr_ip_addr addr;
215   uint32_t value;
216   struct olsr_lq_mult *next;
217 };
218
219 struct olsr_if_weight {
220   int value;
221   bool fixed;
222 };
223
224 struct if_config_options {
225   union olsr_ip_addr ipv4_multicast;
226   union olsr_ip_addr ipv6_multicast;
227
228   union olsr_ip_addr ipv4_src;
229   struct olsr_ip_prefix ipv6_src;
230
231   int mode;
232
233   struct olsr_if_weight weight;
234   struct olsr_msg_params hello_params;
235   struct olsr_msg_params tc_params;
236   struct olsr_msg_params mid_params;
237   struct olsr_msg_params hna_params;
238   struct olsr_lq_mult *lq_mult;
239   int orig_lq_mult_cnt;
240   bool autodetect_chg;
241 };
242
243 struct olsr_if {
244   char *name;
245   bool configured;
246   bool host_emul;
247   union olsr_ip_addr hemu_ip;
248   struct interface_olsr *interf;
249   struct if_config_options *cnf, *cnfi;
250   struct olsr_if *next;
251 };
252
253 struct ip_prefix_list {
254   struct olsr_ip_prefix net;
255   struct ip_prefix_list *next;
256 };
257
258 struct hyst_param {
259   float scaling;
260   float thr_high;
261   float thr_low;
262 };
263
264 struct plugin_param {
265   char *key;
266   char *value;
267   struct plugin_param *next;
268 };
269
270 struct plugin_entry {
271   char *name;
272   struct plugin_param *params;
273   struct plugin_entry *next;
274 };
275
276 /*
277  * The config struct
278  */
279
280 struct olsrd_config {
281   char * configuration_file;
282   uint16_t olsrport;
283   int debug_level;
284   bool no_fork;
285   char * pidfile;
286   bool host_emul;
287   int ip_version;
288   bool allow_no_interfaces;
289   uint8_t tos;
290   uint8_t rt_proto;
291   uint8_t rt_table;
292   uint8_t rt_table_default;
293   uint8_t rt_table_tunnel;
294   int32_t rt_table_pri;
295   int32_t rt_table_tunnel_pri;
296   int32_t rt_table_defaultolsr_pri;
297   int32_t rt_table_default_pri;
298   uint8_t willingness;
299   bool willingness_auto;
300   int ipc_connections;
301   bool use_hysteresis;
302   olsr_fib_metric_options fib_metric;
303   int fib_metric_default;
304   struct hyst_param hysteresis_param;
305   struct plugin_entry *plugins;
306   struct ip_prefix_list *hna_entries;
307   struct ip_prefix_list *ipc_nets;
308   struct if_config_options *interface_defaults;
309   struct olsr_if *interfaces;
310   float pollrate;
311   float nic_chgs_pollrate;
312   bool clear_screen;
313   uint8_t tc_redundancy;
314   uint8_t mpr_coverage;
315   uint8_t lq_level;
316   uint8_t lq_fish;
317   float lq_aging;
318   char *lq_algorithm;
319
320   float min_tc_vtime;
321
322   bool set_ip_forward;
323
324   char *lock_file;
325   bool use_niit;
326
327   bool smart_gw_active;
328   bool smart_gw_always_remove_server_tunnel;
329   bool smart_gw_allow_nat;
330   bool smart_gw_uplink_nat;
331   uint8_t smart_gw_use_count;
332   uint8_t smart_gw_takedown_percentage;
333   char *smart_gw_instance_id;
334   char *smart_gw_policyrouting_script;
335   struct sgw_egress_if * smart_gw_egress_interfaces;
336   uint8_t smart_gw_egress_interfaces_count;
337   char *smart_gw_egress_file;
338   uint32_t smart_gw_egress_file_period;
339   char *smart_gw_status_file;
340   uint32_t smart_gw_offset_tables;
341   uint32_t smart_gw_offset_rules;
342   uint32_t smart_gw_period;
343   uint8_t smart_gw_stablecount;
344   uint8_t smart_gw_thresh;
345   uint8_t smart_gw_weight_exitlink_up;
346   uint8_t smart_gw_weight_exitlink_down;
347   uint8_t smart_gw_weight_etx;
348   uint32_t smart_gw_divider_etx;
349   uint32_t smart_gw_path_max_cost_etx_max;
350   enum smart_gw_uplinktype smart_gw_type;
351   uint32_t smart_gw_uplink;
352   uint32_t smart_gw_downlink;
353   bool smart_gateway_bandwidth_zero;
354   struct olsr_ip_prefix smart_gw_prefix;
355
356   /* Main address of this node */
357   union olsr_ip_addr main_addr;
358   union olsr_ip_addr unicast_src_ip;
359   bool use_src_ip_routes;
360
361   /* Stuff set by olsrd */
362   uint8_t maxplen;                     /* maximum prefix len */
363   size_t ipsize;                       /* Size of address */
364   bool del_gws;                        /* Delete InternetGWs at startup */
365   float will_int;
366   float max_jitter;
367   int exit_value;                      /* Global return value for process termination */
368   float max_tc_vtime;
369
370   int niit4to6_if_index;
371   int niit6to4_if_index;
372
373   /*many potential parameters or helper variables for smartgateway*/
374   bool has_ipv4_gateway;
375   bool has_ipv6_gateway;
376
377   int ioctl_s;                         /* Socket used for ioctl calls */
378 #ifdef __linux__
379   int rtnl_s;                          /* Socket used for rtnetlink messages */
380   int rt_monitor_socket;
381 #endif /* __linux__ */
382
383 #if defined __FreeBSD__ || defined __FreeBSD_kernel__ || defined __APPLE__ || defined __NetBSD__ || defined __OpenBSD__
384   int rts;                             /* Socket used for route changes on BSDs */
385 #endif /* defined __FreeBSD__ || defined __FreeBSD_kernel__ || defined __APPLE__ || defined __NetBSD__ || defined __OpenBSD__ */
386   float lq_nat_thresh;
387
388 #ifdef HTTPINFO_PUD
389   TransmitGpsInformation * pud_position;
390 #endif /* HTTPINFO_PUD */
391 };
392
393 #if defined __cplusplus
394 extern "C" {
395 #endif /* defined __cplusplus */
396
397   extern const char *GW_UPLINK_TXT[];
398   extern const char *FIB_METRIC_TXT[];
399   extern const char *OLSR_IF_MODE[];
400
401 /*
402  * List functions
403  */
404
405   /**
406    * Count the number of olsr interfaces
407    *
408    * @return the number of olsr interfaces
409    */
410   static INLINE unsigned int getNrOfOlsrInterfaces(struct olsrd_config * cfg) {
411     struct olsr_if * ifn;
412     unsigned int i = 0;
413
414       for (ifn = cfg->interfaces; ifn; ifn = ifn->next, i++) {}
415       return i;
416   }
417
418
419   void ip_prefix_list_add(struct ip_prefix_list **, const union olsr_ip_addr *, uint8_t);
420
421   int ip_prefix_list_remove(struct ip_prefix_list **, const union olsr_ip_addr *, uint8_t);
422
423   struct ip_prefix_list *ip_prefix_list_find(struct ip_prefix_list *, const union olsr_ip_addr *net, uint8_t prefix_len);
424
425 /*
426  * Interface to parser
427  */
428
429   int olsrd_parse_cnf(const char *);
430
431   int olsrd_sanity_check_cnf(struct olsrd_config *);
432
433   void olsrd_free_cnf(struct olsrd_config **);
434
435   void olsrd_print_cnf(struct olsrd_config *);
436
437   void olsrd_cfgfile_init(void);
438
439   void olsrd_cfgfile_cleanup(void);
440
441   void olsrd_write_cnf_autobuf(struct autobuf *out, struct olsrd_config *cnf);
442
443   void olsrd_write_cnf_autobuf_uncached(struct autobuf *out, struct olsrd_config *cnf);
444
445   int olsrd_write_cnf(struct olsrd_config *, const char *);
446
447   struct if_config_options *get_default_if_config(void);
448
449   struct olsrd_config *olsrd_get_default_cnf(char * configuration_file);
450
451 #if defined _WIN32
452   void win32_stdio_hack(unsigned int);
453
454   void *win32_olsrd_malloc(size_t size);
455
456   void win32_olsrd_free(void *ptr);
457 #endif /* defined _WIN32 */
458
459   /*
460    * Smart-Gateway uplink/downlink accessors
461    */
462
463   static INLINE void set_smart_gateway_bandwidth_zero(struct olsrd_config *cnf) {
464     cnf->smart_gateway_bandwidth_zero = !cnf->smart_gw_uplink || !cnf->smart_gw_downlink;
465   }
466
467   static INLINE void smartgw_set_uplink(struct olsrd_config *cnf, uint32_t uplink) {
468     cnf->smart_gw_uplink = uplink;
469     set_smart_gateway_bandwidth_zero(cnf);
470   }
471
472   static INLINE void smartgw_set_downlink(struct olsrd_config *cnf, uint32_t downlink) {
473     cnf->smart_gw_downlink = downlink;
474     set_smart_gateway_bandwidth_zero(cnf);
475   }
476
477   static INLINE bool smartgw_is_zero_bandwidth(struct olsrd_config *cnf) {
478     return cnf->smart_gateway_bandwidth_zero;
479   }
480
481 #if defined __cplusplus
482 }
483 #endif /* defined __cplusplus */
484 #endif /* _OLSRD_CFGPARSER_H */
485
486 /*
487  * Local Variables:
488  * c-basic-offset: 2
489  * indent-tabs-mode: nil
490  * End:
491  */