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