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