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