887b913fb58e7e807765d6ed1499a7c201229f40
[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
48 /* set to 1 to collect all startup sleep into one sleep
49  * (just as long as the longest sleep)
50  * useful if many errors on many interfaces */
51 #define OLSR_COLLECT_STARTUP_SLEEP 1
52
53 #define TESTLIB_PATH 0
54 #define SYSLOG_NUMBERING 0
55
56 /* Default values not declared in olsr_protocol.h */
57 #define DEF_IP_VERSION       AF_INET
58 #define DEF_POLLRATE         0.05
59 #define DEF_NICCHGPOLLRT     2.5
60 #define DEF_WILL_AUTO        false
61 #define DEF_WILLINGNESS      3
62 #define DEF_ALLOW_NO_INTS    true
63 #define DEF_TOS              16
64 #define DEF_DEBUGLVL         1
65 #define DEF_IPC_CONNECTIONS  0
66 #define DEF_USE_HYST         false
67 #define DEF_FIB_METRIC       FIBM_FLAT
68 #define DEF_LQ_LEVEL         2
69 #define DEF_LQ_ALGORITHM     "etx_ff"
70 #define DEF_LQ_FISH          1
71 #define DEF_LQ_NAT_THRESH    1.0
72 #define DEF_LQ_AGING         0.05
73 #define DEF_CLEAR_SCREEN     true
74 #define DEF_OLSRPORT         698
75 #define DEF_RTPOLICY         true
76 #define DEF_RTPROTO          0 /* 0 means OS-specific default */
77 #define DEF_RTTABLE          254
78 #define DEF_RTTABLE_DEFAULT  112
79 #define DEF_RTTABLE_TUNNEL   113
80 #define DEF_MIN_TC_VTIME     0.0
81 #define DEF_USE_NIIT         true
82 #define DEF_SMART_GW         false
83 #define DEF_GW_ALLOW_NAT     true
84 #define DEF_GW_TYPE          GW_UPLINK_IPV46
85 #define DEF_GW_UPLINK_NAT    true
86 #define DEF_UPLINK_SPEED     128
87 #define DEF_DOWNLINK_SPEED   1024
88 #define DEF_USE_SRCIP_ROUTES false
89
90 #define DEF_IF_MODE          IF_MODE_MESH
91
92 /* Bounds */
93
94 #define MIN_INTERVAL         0.01
95
96 #define MAX_POLLRATE         1.0
97 #define MIN_POLLRATE         0.01
98 #define MAX_NICCHGPOLLRT     100.0
99 #define MIN_NICCHGPOLLRT     1.0
100 #define MAX_DEBUGLVL         9
101 #define MIN_DEBUGLVL         0
102 #define MAX_TOS              16
103 #define MIN_TOS              0
104 #define MAX_WILLINGNESS      7
105 #define MIN_WILLINGNESS      0
106 #define MAX_MPR_COVERAGE     20
107 #define MIN_MPR_COVERAGE     1
108 #define MAX_TC_REDUNDANCY    2
109 #define MIN_TC_REDUNDANCY    0
110 #define MAX_HYST_PARAM       1.0
111 #define MIN_HYST_PARAM       0.0
112 #define MAX_LQ_LEVEL         2
113 #define MIN_LQ_LEVEL         0
114 #define MAX_LQ_AGING         1.0
115 #define MIN_LQ_AGING         0.01
116
117 #define MIN_SMARTGW_SPEED    1
118 #define MAX_SMARTGW_SPEED    320000000
119
120 #ifndef IPV6_ADDR_SITELOCAL
121 #define IPV6_ADDR_SITELOCAL    0x0040U
122 #endif
123
124 #include "interfaces.h"
125
126 enum smart_gw_uplinktype {
127   GW_UPLINK_NONE,
128   GW_UPLINK_IPV4,
129   GW_UPLINK_IPV6,
130   GW_UPLINK_IPV46,
131   GW_UPLINK_CNT,
132 };
133
134
135 typedef enum {
136   FIBM_FLAT,
137   FIBM_CORRECT,
138   FIBM_APPROX,
139   FIBM_CNT
140 } olsr_fib_metric_options;
141
142 enum olsr_if_mode {
143   IF_MODE_MESH,
144   IF_MODE_ETHER,
145   IF_MODE_CNT
146 };
147
148
149 struct olsr_msg_params {
150   float emission_interval;
151   float validity_time;
152 };
153
154 struct olsr_lq_mult {
155   union olsr_ip_addr addr;
156   uint32_t value;
157   struct olsr_lq_mult *next;
158 };
159
160 struct olsr_if_weight {
161   int value;
162   bool fixed;
163 };
164
165 struct if_config_options {
166   union olsr_ip_addr ipv4_multicast;
167   union olsr_ip_addr ipv6_multicast;
168
169   union olsr_ip_addr ipv4_src;
170   struct olsr_ip_prefix ipv6_src;
171
172   int mode;
173
174   struct olsr_if_weight weight;
175   struct olsr_msg_params hello_params;
176   struct olsr_msg_params tc_params;
177   struct olsr_msg_params mid_params;
178   struct olsr_msg_params hna_params;
179   struct olsr_lq_mult *lq_mult;
180   int orig_lq_mult_cnt;
181   bool autodetect_chg;
182 };
183
184 struct olsr_if {
185   char *name;
186   bool configured;
187   bool host_emul;
188   union olsr_ip_addr hemu_ip;
189   struct interface *interf;
190   struct if_config_options *cnf, *cnfi;
191   struct olsr_if *next;
192 };
193
194 struct ip_prefix_list {
195   struct olsr_ip_prefix net;
196   struct ip_prefix_list *next;
197 };
198
199 struct hyst_param {
200   float scaling;
201   float thr_high;
202   float thr_low;
203 };
204
205 struct plugin_param {
206   char *key;
207   char *value;
208   struct plugin_param *next;
209 };
210
211 struct plugin_entry {
212   char *name;
213   struct plugin_param *params;
214   struct plugin_entry *next;
215 };
216
217 /*
218  * The config struct
219  */
220
221 struct olsrd_config {
222   uint16_t olsrport;
223   int debug_level;
224   bool no_fork;
225   bool host_emul;
226   int ip_version;
227   bool allow_no_interfaces;
228   uint16_t tos;
229   uint8_t rt_proto;
230   uint8_t rt_table, rt_table_default, rt_table_tunnel;
231   uint16_t rt_table_pri, rt_table_tunnel_pri;
232   uint16_t rt_table_defaultolsr_pri, rt_table_default_pri;
233   uint8_t willingness;
234   bool willingness_auto;
235   int ipc_connections;
236   bool use_hysteresis;
237   olsr_fib_metric_options fib_metric;
238   struct hyst_param hysteresis_param;
239   struct plugin_entry *plugins;
240   struct ip_prefix_list *hna_entries;
241   struct ip_prefix_list *ipc_nets;
242   struct if_config_options *interface_defaults;
243   struct olsr_if *interfaces;
244   float pollrate;
245   float nic_chgs_pollrate;
246   bool clear_screen;
247   uint8_t tc_redundancy;
248   uint8_t mpr_coverage;
249   uint8_t lq_level;
250   uint8_t lq_fish;
251   float lq_aging;
252   char *lq_algorithm;
253
254   float min_tc_vtime;
255
256   char *lock_file;
257   bool use_niit;
258
259   bool smart_gw_active, smart_gw_allow_nat, smart_gw_uplink_nat;
260   enum smart_gw_uplinktype smart_gw_type;
261   uint32_t smart_gw_uplink, smart_gw_downlink;
262   struct olsr_ip_prefix smart_gw_prefix;
263
264   /* Main address of this node */
265   union olsr_ip_addr main_addr, unicast_src_ip;
266   bool use_src_ip_routes;
267
268   /* Stuff set by olsrd */
269   uint8_t maxplen;                     /* maximum prefix len */
270   size_t ipsize;                       /* Size of address */
271   bool del_gws;                        /* Delete InternetGWs at startup */
272   float will_int;
273   float max_jitter;
274   int exit_value;                      /* Global return value for process termination */
275   float max_tc_vtime;
276
277   int niit4to6_if_index, niit6to4_if_index;
278
279   /*many potential parameters or helper variables for smartgateway*/
280   bool has_ipv4_gateway, has_ipv6_gateway;
281
282   int ioctl_s;                         /* Socket used for ioctl calls */
283 #ifdef LINUX_NETLINK_ROUTING
284   int rtnl_s;                          /* Socket used for rtnetlink messages */
285   int rt_monitor_socket;
286 #endif
287
288 #if defined __FreeBSD__ || defined __FreeBSD_kernel__ || defined __MacOSX__ || defined __NetBSD__ || defined __OpenBSD__
289   int rts;                             /* Socket used for route changes on BSDs */
290 #endif
291   float lq_nat_thresh;
292 };
293
294 #if defined __cplusplus
295 extern "C" {
296 #endif
297
298   extern const char *GW_UPLINK_TXT[];
299   extern const char *FIB_METRIC_TXT[];
300   extern const char *OLSR_IF_MODE[];
301
302 /*
303  * List functions
304  */
305
306   void ip_prefix_list_add(struct ip_prefix_list **, const union olsr_ip_addr *, uint8_t);
307
308   int ip_prefix_list_remove(struct ip_prefix_list **, const union olsr_ip_addr *, uint8_t);
309
310   struct ip_prefix_list *ip_prefix_list_find(struct ip_prefix_list *, const union olsr_ip_addr *net, uint8_t prefix_len);
311
312 /*
313  * Interface to parser
314  */
315
316   int olsrd_parse_cnf(const char *);
317
318   int olsrd_sanity_check_cnf(struct olsrd_config *);
319
320   void olsrd_free_cnf(struct olsrd_config *);
321
322   void olsrd_print_cnf(struct olsrd_config *);
323
324   void olsrd_write_cnf_autobuf(struct autobuf *out, struct olsrd_config *cnf);
325
326   int olsrd_write_cnf(struct olsrd_config *, const char *);
327
328   struct if_config_options *get_default_if_config(void);
329
330   struct olsrd_config *olsrd_get_default_cnf(void);
331
332 #if defined WIN32
333   void win32_stdio_hack(unsigned int);
334
335   void *win32_olsrd_malloc(size_t size);
336
337   void win32_olsrd_free(void *ptr);
338 #endif
339
340 #if defined __cplusplus
341 }
342 #endif
343 #endif
344
345 /*
346  * Local Variables:
347  * c-basic-offset: 2
348  * indent-tabs-mode: nil
349  * End:
350  */