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