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