6624b832d17a7ef63b42be04055dd0a09912be5e
[olsrd.git] / src / olsr_cfg_gen.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2009, the olsr.org team - see HISTORY file
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 #include "olsr_cfg_gen.h"
43 #include "olsr_protocol.h"
44 #include "ipcalc.h"
45 #include "olsr_ip_prefix_list.h"
46
47 #include <errno.h>
48
49 static INLINE void
50 append_float(struct autobuf *abuf, const char *name, float val, float deflt, bool first)
51 {
52   if (val != deflt) {
53     abuf_appendf(abuf, "    %s\t%0.2f\n", name, val);
54   } else if (first) {
55     abuf_appendf(abuf, "    #%s\t%0.2f\n", name, val);
56   }
57 }
58
59 void
60 olsr_write_cnf_buf(struct autobuf *abuf, struct olsr_config *cnf, bool write_more_comments)
61 {
62   char ipv6_buf[INET6_ADDRSTRLEN];     /* buffer for IPv6 inet_ntop */
63   const char *s;
64
65   abuf_appendf(abuf, "#\n" "# Generated config file for %s\n" "#\n\n", olsrd_version);
66
67   /* IP version */
68   abuf_appendf(abuf, "# IP version to use (4 or 6)\n" "IpVersion\t%d\n\n", cnf->ip_version == AF_INET ? 4 : 6);
69
70   /* FIB Metric */
71   abuf_appendf(abuf, "# FIBMetric (\"%s\", \"%s\", or \"%s\")\n"
72                "FIBMetric\t\"%s\"\n\n",
73                CFG_FIBM_FLAT, CFG_FIBM_CORRECT, CFG_FIBM_APPROX,
74                FIBM_FLAT == cnf->fib_metric ? CFG_FIBM_FLAT : FIBM_CORRECT == cnf->fib_metric ? CFG_FIBM_CORRECT : CFG_FIBM_APPROX);
75
76   /* HNA IPv4/IPv6 */
77   abuf_appendf(abuf, "# HNA IPv%d routes\n"
78                "# syntax: netaddr/prefix\n" "Hna%d {\n", cnf->ip_version == AF_INET ? 4 : 6, cnf->ip_version == AF_INET ? 4 : 6);
79   if (!list_is_empty(&cnf->hna_entries)) {
80     struct ip_prefix_entry *h;
81
82     OLSR_FOR_ALL_IPPREFIX_ENTRIES(&cnf->hna_entries, h) {
83       struct ipprefix_str strbuf;
84       abuf_appendf(abuf, "    %s\n", ip_prefix_to_string(cnf->ip_version, &strbuf, &h->net));
85     } OLSR_FOR_ALL_IPPREFIX_ENTRIES_END()
86   }
87   abuf_appendf(abuf, "}\n\n");
88
89   /* No interfaces */
90   abuf_appendf(abuf, "# Should olsrd keep on running even if there are\n"
91                "# no interfaces available? This is a good idea\n"
92                "# for a PCMCIA/USB hotswap environment.\n"
93                "# \"yes\" OR \"no\"\n" "AllowNoInt\t%s\n\n", cnf->allow_no_interfaces ? "yes" : "no");
94
95   /* TOS */
96   abuf_appendf(abuf, "# TOS(type of service) to use. Default is 16\n" "TosValue\t%d\n\n", cnf->tos);
97
98   /* RtProto */
99   abuf_appendf(abuf, "# Routing proto flag to use. Operating system default is 0\n" "RtProto\t\t%d\n\n", cnf->rtproto);
100
101   /* RtTable */
102   abuf_appendf(abuf, "# Policy Routing Table to use. Default is 254\n" "RtTable\t\t%d\n\n", cnf->rttable);
103
104   /* RtTableDefault */
105   abuf_appendf(abuf,
106                "# Policy Routing Table to use for the default Route. Default is 0 (Take the same table as specified by RtTable)\n"
107                "RtTableDefault\t\t%d\n\n", cnf->rttable_default);
108
109   /* Willingness */
110   abuf_appendf(abuf, "# The fixed willingness to use(0-7)\n"
111                "# If not set willingness will be calculated\n"
112                "# dynammically based on battery/power status\n"
113                "%sWillingness\t%d\n\n", cnf->willingness_auto ? "#" : "", cnf->willingness_auto ? 4 : cnf->willingness);
114
115   if (list_is_empty(&cnf->ipc_nets.accept)) {
116     struct ip_prefix_entry *ie;
117     OLSR_FOR_ALL_IPPREFIX_ENTRIES(&cnf->ipc_nets.accept, ie) {
118       if (ie->net.prefix_len == 8 * cnf->ipsize) {
119         struct ipaddr_str strbuf;
120         abuf_appendf(abuf, "    Host\t\t%s\n", ip_to_string(cnf->ip_version, &strbuf, &ie->net.prefix));
121       } else {
122         struct ipprefix_str strbuf;
123         abuf_appendf(abuf, "    Net\t\t\t%s\n", ip_prefix_to_string(cnf->ip_version, &strbuf, &ie->net));
124       }
125     } OLSR_FOR_ALL_IPPREFIX_ENTRIES_END()
126   }
127
128   abuf_appendf(abuf, "}\n");
129
130   /* Pollrate */
131   abuf_appendf(abuf, "# Polling rate in seconds(float).\n"
132                "# Auto uses default value 0.05 sec\n" "Pollrate\t%0.2f\n", conv_pollrate_to_secs(cnf->pollrate));
133
134   /* NIC Changes Pollrate */
135   abuf_appendf(abuf, "# Interval to poll network interfaces for configuration\n"
136                "# changes. Defaults to 2.5 seconds\n" "NicChgsPollInt\t%0.2f\n", cnf->nic_chgs_pollrate);
137
138   /* TC redundancy */
139   abuf_appendf(abuf, "# TC redundancy\n"
140                "# Specifies how much neighbor info should\n"
141                "# be sent in TC messages\n"
142                "# Possible values are:\n"
143                "# 0 - only send MPR selectors\n"
144                "# 1 - send MPR selectors and MPRs\n"
145                "# 2 - send all neighbors\n" "# defaults to 0\n" "TcRedundancy\t%d\n\n", cnf->tc_redundancy);
146
147   /* MPR coverage */
148   abuf_appendf(abuf, "# MPR coverage\n"
149                "# Specifies how many MPRs a node should\n"
150                "# try select to reach every 2 hop neighbor\n"
151                "# Can be set to any integer >0\n" "# defaults to 1\n" "MprCoverage\t%d\n\n", cnf->mpr_coverage);
152
153   abuf_appendf(abuf, "# Fish Eye algorithm\n"
154                "# 0 = do not use fish eye\n" "# 1 = use fish eye\n" "LinkQualityFishEye\t%d\n\n", cnf->lq_fish);
155
156   abuf_appendf(abuf, "# NAT threshold\n" "NatThreshold\t%f\n\n", cnf->lq_nat_thresh);
157
158   abuf_appendf(abuf, "# Clear screen when printing debug output?\n" "ClearScreen\t%s\n\n", cnf->clear_screen ? "yes" : "no");
159
160   /* Plugins */
161   abuf_appendf(abuf, "# Olsrd plugins to load\n"
162                "# This must be the absolute path to the file\n"
163                "# or the loader will use the following scheme:\n"
164                "# - Try the paths in the LD_LIBRARY_PATH \n"
165                "#   environment variable.\n"
166                "# - The list of libraries cached in /etc/ld.so.cache\n" "# - /lib, followed by /usr/lib\n\n");
167   if (cnf->plugins) {
168     struct plugin_entry *pe;
169     for (pe = cnf->plugins; pe != NULL; pe = pe->next) {
170       struct plugin_param *pp;
171       abuf_appendf(abuf, "LoadPlugin \"%s\" {\n", pe->name);
172       for (pp = pe->params; pp != NULL; pp = pp->next) {
173         abuf_appendf(abuf, "    PlParam \"%s\"\t\"%s\"\n", pp->key, pp->value);
174       }
175       abuf_appendf(abuf, "}\n");
176     }
177   }
178   abuf_appendf(abuf, "\n");
179
180   /* Interfaces */
181   abuf_appendf(abuf, "# Interfaces\n"
182                "# Multiple interfaces with the same configuration\n"
183                "# can shar the same config block. Just list the\n" "# interfaces(e.g. Interface \"eth0\" \"eth2\"\n");
184   /* Interfaces */
185   if (cnf->if_configs) {
186     struct olsr_if_config *in;
187     bool first;
188     for (in = cnf->if_configs, first = write_more_comments; in != NULL; in = in->next, first = false) {
189       abuf_appendf(abuf, "Interface \"%s\" {\n", in->name);
190
191       if (first) {
192         abuf_appendf(abuf, "    # IPv4 broadcast address to use. The\n"
193                      "    # one usefull example would be 255.255.255.255\n"
194                      "    # If not defined the broadcastaddress\n" "    # every card is configured with is used\n\n");
195       }
196
197       if (in->cnf->ipv4_broadcast.v4.s_addr) {
198         abuf_appendf(abuf, "    Ip4Broadcast\t%s\n", inet_ntoa(in->cnf->ipv4_broadcast.v4));
199       } else if (first) {
200         abuf_appendf(abuf, "    #Ip4Broadcast\t255.255.255.255\n");
201       }
202
203       if (first) {
204         abuf_appendf(abuf, "\n    # IPv6 address type to use.\n"
205                      "    # Must be 'auto', 'site-local', 'unique-local' or 'global'\n\n");
206       }
207       if (in->cnf->ipv6_addrtype == OLSR_IP6T_SITELOCAL)
208         s = CFG_IP6T_SITELOCAL;
209       else if (in->cnf->ipv6_addrtype == OLSR_IP6T_UNIQUELOCAL)
210         s = CFG_IP6T_UNIQUELOCAL;
211       else if (in->cnf->ipv6_addrtype == OLSR_IP6T_GLOBAL)
212         s = CFG_IP6T_GLOBAL;
213       else
214         s = CFG_IP6T_AUTO;
215       abuf_appendf(abuf, "    Ip6AddrType\t%s\n\n", s);
216
217       if (first) {
218         abuf_appendf(abuf, "\n"
219                      "    # IPv6 multicast address to use when\n"
220                      "    # using site-local addresses.\n" "    # If not defined, ff05::15 is used\n");
221       }
222       abuf_appendf(abuf, "    Ip6MulticastSite\t%s\n",
223                    inet_ntop(AF_INET6, &in->cnf->ipv6_multi_site.v6, ipv6_buf, sizeof(ipv6_buf)));
224       if (first) {
225         abuf_appendf(abuf, "\n    # IPv6 multicast address to use when\n"
226                      "    # using global addresses\n" "    # If not defined, ff0e::1 is used\n");
227       }
228       abuf_appendf(abuf, "    Ip6MulticastGlobal\t%s\n",
229                    inet_ntop(AF_INET6, &in->cnf->ipv6_multi_glbl.v6, ipv6_buf, sizeof(ipv6_buf)));
230       if (first) {
231         abuf_appendf(abuf, "\n");
232       }
233       abuf_appendf(abuf, "    # Olsrd can autodetect changes in\n"
234                    "    # interface configurations. Enabled by default\n"
235                    "    # turn off to save CPU.\n" "    AutoDetectChanges: %s\n\n", in->cnf->autodetect_chg ? "yes" : "no");
236
237       if (first) {
238         abuf_appendf(abuf, "    # Emission and validity intervals.\n"
239                      "    # If not defined, RFC proposed values will\n" "    # in most cases be used.\n");
240       }
241       append_float(abuf, "HelloInterval", in->cnf->hello_params.emission_interval, HELLO_INTERVAL, first);
242       append_float(abuf, "HelloValidityTime", in->cnf->hello_params.validity_time, NEIGHB_HOLD_TIME, first);
243       append_float(abuf, "TcInterval", in->cnf->tc_params.emission_interval, TC_INTERVAL, first);
244       append_float(abuf, "TcValidityTime", in->cnf->tc_params.validity_time, TOP_HOLD_TIME, first);
245       append_float(abuf, "MidValidityTime", in->cnf->mid_params.validity_time, MID_HOLD_TIME, first);
246       append_float(abuf, "HnaInterval", in->cnf->hna_params.emission_interval, HNA_INTERVAL, first);
247       append_float(abuf, "HnaValidityTime", in->cnf->hna_params.validity_time, HNA_HOLD_TIME, first);
248       if (in->cnf->lq_mult == NULL) {
249         if (first) {
250           abuf_appendf(abuf, "    #LinkQualityMult\tdefault 1.0\n");
251         }
252       } else {
253         struct olsr_lq_mult *mult;
254         for (mult = in->cnf->lq_mult; mult != NULL; mult = mult->next) {
255           abuf_appendf(abuf, "    LinkQualityMult\t%s %0.2f\n",
256                        inet_ntop(cnf->ip_version, &mult->addr, ipv6_buf, sizeof(ipv6_buf)), (float)mult->value / 65536.0);
257         }
258       }
259
260       if (first) {
261         abuf_appendf(abuf, "    # When multiple links exist between hosts\n"
262                      "    # the weight of interface is used to determine\n"
263                      "    # the link to use. Normally the weight is\n"
264                      "    # automatically calculated by olsrd based\n"
265                      "    # on the characteristics of the interface,\n"
266                      "    # but here you can specify a fixed value.\n"
267                      "    # Olsrd will choose links with the lowest value.\n"
268                      "    # Note:\n"
269                      "    # Interface weight is used only when LinkQualityLevel is 0.\n"
270                      "    # For any other value of LinkQualityLevel, the interface ETX\n" "    # value is used instead.\n\n");
271       }
272       if (in->cnf->weight.fixed) {
273         abuf_appendf(abuf, "    Weight\t %d\n", in->cnf->weight.value);
274       } else if (first) {
275         abuf_appendf(abuf, "    #Weight\t 0\n");
276       }
277
278       abuf_appendf(abuf, "}\n\n");
279     }
280   }
281 }
282
283 /*
284  * Local Variables:
285  * c-basic-offset: 2
286  * indent-tabs-mode: nil
287  * End:
288  */