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