54116e7e1cb9ea5d3e3368b0041f603283557954
[olsrd.git] / src / olsr_cfg.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Andreas T√łnnesen(andreto@olsr.org)
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without 
7  * modification, are permitted provided that the following conditions 
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright 
11  *   notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright 
13  *   notice, this list of conditions and the following disclaimer in 
14  *   the documentation and/or other materials provided with the 
15  *   distribution.
16  * * Neither the name of olsr.org, olsrd nor the names of its 
17  *   contributors may be used to endorse or promote products derived 
18  *   from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * Visit http://www.olsr.org for more information.
34  *
35  * If you find this software useful feel free to make a donation
36  * to the project. For more information see the website or contact
37  * the copyright holders.
38  *
39  * $Id: olsr_cfg.h,v 1.16 2004/11/21 11:28:56 kattemat Exp $
40  */
41
42
43 #ifndef _OLSRD_CFGPARSER_H
44 #define _OLSRD_CFGPARSER_H
45
46 #include "olsr_protocol.h"
47
48 /* Default valuse not declared in olsr_protocol.h */
49 #define DEF_POLLRATE        0.05
50 #define DEF_WILL_AUTO       OLSR_TRUE
51 #define DEF_ALLOW_NO_INTS   OLSR_TRUE
52 #define DEF_TOS             16
53 #define DEF_DEBUGLVL        1
54 #define DEF_IPC_CONNECTIONS 0
55 #define DEF_USE_HYST        OLSR_TRUE
56 #define DEF_LQ_LEVEL        0
57 #define DEF_LQ_WSIZE        10
58 #define DEF_CLEAR_SCREEN    OLSR_FALSE
59
60 /* Bounds */
61
62 #define MIN_INTERVAL        0.01
63
64 #define MAX_POLLRATE        10.0
65 #define MIN_POLLRATE        0.01
66 #define MAX_DEBUGLVL        9
67 #define MIN_DEBUGLVL        0
68 #define MAX_TOS             16
69 #define MIN_TOS             0
70 #define MAX_WILLINGNESS     7
71 #define MIN_WILLINGNESS     1
72 #define MAX_MPR_COVERAGE    20
73 #define MIN_MPR_COVERAGE    1
74 #define MAX_TC_REDUNDANCY   2
75 #define MIN_TC_REDUNDANCY   0
76 #define MAX_HYST_PARAM      1.0
77 #define MIN_HYST_PARAM      0.0
78 #define MAX_LQ_LEVEL        2
79 #define MIN_LQ_LEVEL        0
80 #define MAX_LQ_WSIZE        128
81 #define MIN_LQ_WSIZE        3
82
83 #ifndef IPV6_ADDR_SITELOCAL
84 #define IPV6_ADDR_SITELOCAL    0x0040U
85 #endif
86
87
88 #ifdef MAKELIB
89
90 struct interface 
91 {
92   int foo;
93 };
94
95 #else 
96
97 #ifdef MAKEBIN
98
99 struct interface 
100 {
101   int foo;
102 };
103
104 #else
105
106 /* Part of olsrd */
107
108 #include "interfaces.h"
109
110 #endif
111
112 #endif
113
114 struct olsr_msg_params
115 {
116   float                    emission_interval;
117   float                    validity_time;
118 };
119
120 struct if_config_options
121 {
122   union olsr_ip_addr       ipv4_broadcast;
123   int                      ipv6_addrtype;
124   union olsr_ip_addr       ipv6_multi_site;
125   union olsr_ip_addr       ipv6_multi_glbl;
126   struct olsr_msg_params   hello_params;
127   struct olsr_msg_params   tc_params;
128   struct olsr_msg_params   mid_params;
129   struct olsr_msg_params   hna_params;
130 };
131
132
133
134 struct olsr_if
135 {
136   char                     *name;
137   char                     *config;
138   int                      index;
139   olsr_bool                configured;
140   struct interface         *interf;
141   struct if_config_options *cnf;
142   struct olsr_if           *next;
143 };
144
145 struct hna4_entry
146 {
147   union olsr_ip_addr       net;
148   union olsr_ip_addr       netmask;
149   struct hna4_entry        *next;
150 };
151
152 struct hna6_entry
153 {
154   union olsr_ip_addr       net;
155   olsr_u16_t               prefix_len;
156   struct hna6_entry        *next;
157 };
158
159 struct hyst_param
160 {
161   float                    scaling;
162   float                    thr_high;
163   float                    thr_low;
164 };
165
166 struct plugin_param
167 {
168   char                     *key;
169   char                     *value;
170   struct plugin_param      *next;
171 };
172
173 struct plugin_entry
174 {
175   char                     *name;
176   struct plugin_param      *params;
177   struct plugin_entry      *next;
178 };
179
180 struct ipc_host
181 {
182   union olsr_ip_addr       host;
183   struct ipc_host          *next;
184 };
185
186 struct ipc_net
187 {
188   union olsr_ip_addr       net;
189   union olsr_ip_addr       mask;
190   struct ipc_net           *next;
191 };
192
193 /*
194  * The config struct
195  */
196
197 struct olsrd_config
198 {
199   int                      debug_level;
200   int                      ip_version;
201   olsr_bool                allow_no_interfaces;
202   olsr_u16_t               tos;
203   olsr_bool                willingness_auto;
204   olsr_u8_t                willingness;
205   int                      ipc_connections;
206   olsr_bool                open_ipc;
207   olsr_bool                use_hysteresis;
208   struct hyst_param        hysteresis_param;
209   float                    pollrate;
210   olsr_u8_t                tc_redundancy;
211   olsr_u8_t                mpr_coverage;
212   olsr_bool                clear_screen;
213   olsr_u8_t                lq_level;
214   olsr_u32_t               lq_wsize;
215   struct plugin_entry      *plugins;
216   struct hna4_entry        *hna4_entries;
217   struct hna6_entry        *hna6_entries;
218   struct ipc_host          *ipc_hosts;
219   struct ipc_net           *ipc_nets;
220   struct olsr_if           *interfaces;
221   olsr_u16_t               ifcnt;
222 };
223
224 #if defined __cplusplus
225 extern "C" {
226 #endif
227
228 /*
229  * Interface to parser
230  */
231
232 struct olsrd_config *
233 olsrd_parse_cnf(const char *);
234
235 int
236 olsrd_sanity_check_cnf(struct olsrd_config *);
237
238 void
239 olsrd_free_cnf(struct olsrd_config *);
240
241 void
242 olsrd_print_cnf(struct olsrd_config *);
243
244 int
245 olsrd_write_cnf(struct olsrd_config *, const char *);
246
247 struct if_config_options *
248 get_default_if_config(void);
249
250 struct olsrd_config *
251 olsrd_get_default_cnf(void);
252
253 void *
254 olsrd_cnf_malloc(unsigned int);
255
256 void
257 olsrd_cnf_free(void *);
258
259 #if defined __cplusplus
260 }
261 #endif
262
263 #endif